OGS
RelPermUdellNonwettingPhase.cpp
Go to the documentation of this file.
1
// SPDX-FileCopyrightText: Copyright (c) OpenGeoSys Community (opengeosys.org)
2
// SPDX-License-Identifier: BSD-3-Clause
3
4
#include "
RelPermUdellNonwettingPhase.h
"
5
6
#include <algorithm>
7
#include <cmath>
8
9
#include "
MaterialLib/MPL/Medium.h
"
10
11
namespace
MaterialPropertyLib
12
{
13
RelPermUdellNonwettingPhase::RelPermUdellNonwettingPhase
(
14
std::string
name
,
15
const
double
residual_liquid_saturation
,
16
const
double
residual_gas_saturation
,
17
const
double
min_relative_permeability)
18
:
residual_liquid_saturation_
(
residual_liquid_saturation
),
19
residual_gas_saturation_
(
residual_gas_saturation
),
20
min_relative_permeability_
(min_relative_permeability)
21
{
22
name_
= std::move(
name
);
23
}
24
25
PropertyDataType
RelPermUdellNonwettingPhase::value
(
26
VariableArray
const
& variable_array,
27
ParameterLib::SpatialPosition
const
&
/*pos*/
,
double
const
/*t*/
,
28
double
const
/*dt*/
)
const
29
{
30
const
double
S_L = variable_array.
liquid_saturation
;
31
32
if
(std::isnan(S_L))
33
{
34
OGS_FATAL
(
35
"In RelPermUdellNonwettingPhase::value, the liquid saturation is "
36
"NaN."
);
37
}
38
39
auto
const
S_L_res =
residual_liquid_saturation_
;
40
auto
const
S_L_max = 1. -
residual_gas_saturation_
;
41
42
auto
const
S_e = (S_L - S_L_res) / (S_L_max - S_L_res);
43
44
if
(S_e >= 1.0)
45
{
46
// fully saturated medium
47
return
min_relative_permeability_
;
48
}
49
if
(S_e <= 0.0)
50
{
51
// dry medium
52
return
1.0;
53
}
54
55
auto
const
S_e_g = (1. - S_e);
56
57
return
std::max(
min_relative_permeability_
, S_e_g * S_e_g * S_e_g);
58
}
59
PropertyDataType
RelPermUdellNonwettingPhase::dValue
(
60
VariableArray
const
& variable_array,
Variable
const
variable,
61
ParameterLib::SpatialPosition
const
&
/*pos*/
,
double
const
/*t*/
,
62
double
const
/*dt*/
)
const
63
{
64
if
(variable !=
Variable::liquid_saturation
)
65
{
66
OGS_FATAL
(
67
"RelPermUdellNonwettingPhase::dValue is implemented for "
68
"derivatives with respect to liquid saturation only."
);
69
}
70
71
const
double
S_L = variable_array.
liquid_saturation
;
72
73
auto
const
S_L_res =
residual_liquid_saturation_
;
74
auto
const
S_L_max = 1. -
residual_gas_saturation_
;
75
auto
const
S_e = (S_L - S_L_res) / (S_L_max - S_L_res);
76
77
if
((S_e < 0.) || (S_e > 1.))
78
{
79
return
0.;
80
}
81
82
auto
const
dS_e_dS_L = 1. / (S_L_max - S_L_res);
83
84
auto
const
dk_rel_GR_dS_e = -3. * (1. - S_e) * (1. - S_e);
85
return
dk_rel_GR_dS_e * dS_e_dS_L;
86
}
87
88
}
// namespace MaterialPropertyLib
OGS_FATAL
#define OGS_FATAL(...)
Definition
Error.h:19
Medium.h
RelPermUdellNonwettingPhase.h
MaterialPropertyLib::Property::value
virtual PropertyDataType value() const
Definition
MaterialLib/MPL/Property.cpp:67
MaterialPropertyLib::Property::name_
std::string name_
Definition
MaterialLib/MPL/Property.h:283
MaterialPropertyLib::RelPermUdellNonwettingPhase::dValue
PropertyDataType dValue(VariableArray const &variable_array, Variable const variable, ParameterLib::SpatialPosition const &pos, double const t, double const dt) const override
Definition
RelPermUdellNonwettingPhase.cpp:59
MaterialPropertyLib::RelPermUdellNonwettingPhase::RelPermUdellNonwettingPhase
RelPermUdellNonwettingPhase(std::string name, const double residual_liquid_saturation, const double residual_gas_saturation, const double min_relative_permeability)
Definition
RelPermUdellNonwettingPhase.cpp:13
MaterialPropertyLib::RelPermUdellNonwettingPhase::residual_gas_saturation_
const double residual_gas_saturation_
Definition
RelPermUdellNonwettingPhase.h:37
MaterialPropertyLib::RelPermUdellNonwettingPhase::residual_liquid_saturation_
const double residual_liquid_saturation_
Definition
RelPermUdellNonwettingPhase.h:36
MaterialPropertyLib::RelPermUdellNonwettingPhase::min_relative_permeability_
const double min_relative_permeability_
Definition
RelPermUdellNonwettingPhase.h:38
MaterialPropertyLib::VariableArray
Definition
VariableType.h:94
MaterialPropertyLib::VariableArray::liquid_saturation
double liquid_saturation
Definition
VariableType.h:178
ParameterLib::SpatialPosition
Definition
SpatialPosition.h:21
MaterialPropertyLib
Definition
ChemicalSolverInterface.h:98
MaterialPropertyLib::Variable
Variable
Definition
VariableType.h:21
MaterialPropertyLib::Variable::liquid_saturation
@ liquid_saturation
Definition
VariableType.h:34
MaterialPropertyLib::name
@ name
Definition
PropertyType.h:57
MaterialPropertyLib::residual_liquid_saturation
@ residual_liquid_saturation
Definition
PropertyType.h:72
MaterialPropertyLib::residual_gas_saturation
@ residual_gas_saturation
Definition
PropertyType.h:71
MaterialPropertyLib::PropertyDataType
std::variant< double, Eigen::Matrix< double, 2, 1 >, Eigen::Matrix< double, 3, 1 >, Eigen::Matrix< double, 2, 2 >, Eigen::Matrix< double, 3, 3 >, Eigen::Matrix< double, 4, 1 >, Eigen::Matrix< double, 6, 1 >, Eigen::MatrixXd > PropertyDataType
Definition
MaterialLib/MPL/Property.h:24
MaterialLib
MPL
Properties
RelativePermeability
RelPermUdellNonwettingPhase.cpp
Generated by
1.14.0