My Project
Loading...
Searching...
No Matches
EclHysteresisConfig.hpp
Go to the documentation of this file.
1// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
2// vi: set et ts=4 sw=4 sts=4:
3/*
4 This file is part of the Open Porous Media project (OPM).
5
6 OPM is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 2 of the License, or
9 (at your option) any later version.
10
11 OPM is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with OPM. If not, see <http://www.gnu.org/licenses/>.
18
19 Consult the COPYING file in the top-level source directory of this
20 module for the precise wording of the license and the list of
21 copyright holders.
22*/
27#ifndef OPM_ECL_HYSTERESIS_CONFIG_HPP
28#define OPM_ECL_HYSTERESIS_CONFIG_HPP
29
30namespace Opm {
31
32#if HAVE_ECL_INPUT
33class Runspec;
34#endif
35
42{
43public:
47 void setEnableHysteresis(bool yesno)
48 { enableHysteresis_ = yesno; }
49
53 bool enableHysteresis() const
54 { return enableHysteresis_; }
55
62 void setPcHysteresisModel(int value)
63 { pcHysteresisModel_ = value; }
64
72 { return pcHysteresisModel_; }
73
74 bool enablePCHysteresis() const
75 { return enableHysteresis() && pcHysteresisModel_ >= 0; }
76
90 void setKrHysteresisModel(int value)
91 { krHysteresisModel_ = value; }
92
93 bool enableWettingHysteresis() const
94 { return enableHysteresis() && krHysteresisModel_ >= 4; }
95
96 bool enableNonWettingHysteresis() const
97 { return enableHysteresis() && krHysteresisModel_ >= 0; }
98
107 { return krHysteresisModel_; }
108
114 double modParamTrapped() const
115 { return modParamTrapped_; }
116
122 double curvatureCapPrs() const
123 { return curvatureCapPrs_; }
124
129 { return enableWagHyst_; }
130
131#if HAVE_ECL_INPUT
137 void initFromState(const Runspec& runspec);
138#endif
139
140private:
141 // enable hysteresis at all
142 bool enableHysteresis_{false};
143
144 // the capillary pressure and the relperm hysteresis models to be used
145 int pcHysteresisModel_{-1};
146 int krHysteresisModel_{-1};
147 double modParamTrapped_{};
148 double curvatureCapPrs_{};
149
150 // WAG hysteresis
151 bool enableWagHyst_{false};
152};
153
154} // namespace Opm
155
156#endif
Specifies the configuration used by the ECL kr/pC hysteresis code.
Definition EclHysteresisConfig.hpp:42
int pcHysteresisModel() const
Return the type of the hysteresis model which is used for capillary pressure.
Definition EclHysteresisConfig.hpp:71
void setPcHysteresisModel(int value)
Set the type of the hysteresis model which is used for capillary pressure.
Definition EclHysteresisConfig.hpp:62
int krHysteresisModel() const
Return the type of the hysteresis model which is used for relative permeability.
Definition EclHysteresisConfig.hpp:106
double curvatureCapPrs() const
Curvature parameter used for capillary pressure hysteresis.
Definition EclHysteresisConfig.hpp:122
void setKrHysteresisModel(int value)
Set the type of the hysteresis model which is used for relative permeability.
Definition EclHysteresisConfig.hpp:90
bool enableWagHysteresis() const
Returns whether hysteresis is enabled.
Definition EclHysteresisConfig.hpp:128
void setEnableHysteresis(bool yesno)
Specify whether hysteresis is enabled or not.
Definition EclHysteresisConfig.hpp:47
bool enableHysteresis() const
Returns whether hysteresis is enabled.
Definition EclHysteresisConfig.hpp:53
double modParamTrapped() const
Regularisation parameter used for Killough model.
Definition EclHysteresisConfig.hpp:114
Definition Runspec.hpp:480
This class implements a small container which holds the transmissibility mulitpliers for all the face...
Definition Exceptions.hpp:30