OGS
MaterialPropertyLib::RelPermUdellNonwettingPhase Class Referencefinal

Detailed Description

A simple relative permeability function proposed by Kent S Udell [38].

Definition:

\[ k_{\text{rel}}^{\alpha} =\left(S^{\text{eff}}_{\alpha}\right)^{3}\]

where

  • \(k_{\text{rel}}^{\alpha}\) is relative permeability of phase \(\alpha\)
  • \(S^{\text{eff}}_{\alpha}\) is the effective saturation of phase \(\alpha\)

This class handles the non-wetting (gas) phase portion of this relative permeability property, i,e with \(\alpha=g\) for the relative permeability function.

This property must be a medium property, it computes the permeability reduction due to saturation as function of capillary pressure.

Definition at line 42 of file RelPermUdellNonwettingPhase.h.

#include <RelPermUdellNonwettingPhase.h>

Inheritance diagram for MaterialPropertyLib::RelPermUdellNonwettingPhase:
[legend]
Collaboration diagram for MaterialPropertyLib::RelPermUdellNonwettingPhase:
[legend]

Public Member Functions

 RelPermUdellNonwettingPhase (std::string name, const double residual_liquid_saturation, const double residual_gas_saturation, const double min_relative_permeability)
 
void checkScale () const override
 
PropertyDataType value (VariableArray const &variable_array, ParameterLib::SpatialPosition const &pos, double const t, double const dt) const override
 
PropertyDataType dValue (VariableArray const &variable_array, Variable const variable, ParameterLib::SpatialPosition const &pos, double const t, double const dt) const override
 
- Public Member Functions inherited from MaterialPropertyLib::Property
virtual ~Property ()
 
virtual PropertyDataType initialValue (ParameterLib::SpatialPosition const &pos, double const t) const
 
virtual PropertyDataType value () const
 
virtual PropertyDataType value (VariableArray const &variable_array, VariableArray const &variable_array_prev, ParameterLib::SpatialPosition const &pos, double const t, double const dt) const
 
virtual PropertyDataType dValue (VariableArray const &variable_array, VariableArray const &variable_array_prev, Variable const variable, ParameterLib::SpatialPosition const &pos, double const t, double const dt) const
 
virtual PropertyDataType d2Value (VariableArray const &variable_array, Variable const variable1, Variable const variable2, ParameterLib::SpatialPosition const &pos, double const t, double const dt) const
 Default implementation: 2nd derivative of any constant property is zero.
 
virtual void setProperties (std::vector< std::unique_ptr< Phase > > const &phases)
 Default implementation:
 
void setScale (std::variant< Medium *, Phase *, Component * > scale)
 
template<typename T >
initialValue (ParameterLib::SpatialPosition const &pos, double const t) const
 
template<typename T >
value () const
 
template<typename T >
value (VariableArray const &variable_array, VariableArray const &variable_array_prev, ParameterLib::SpatialPosition const &pos, double const t, double const dt) const
 
template<typename T >
value (VariableArray const &variable_array, ParameterLib::SpatialPosition const &pos, double const t, double const dt) const
 
template<typename T >
dValue (VariableArray const &variable_array, VariableArray const &variable_array_prev, Variable const variable, ParameterLib::SpatialPosition const &pos, double const t, double const dt) const
 
template<typename T >
dValue (VariableArray const &variable_array, Variable const variable, ParameterLib::SpatialPosition const &pos, double const t, double const dt) const
 
template<typename T >
d2Value (VariableArray const &variable_array, Variable const &variable1, Variable const &variable2, ParameterLib::SpatialPosition const &pos, double const t, double const dt) const
 

Private Attributes

const double residual_liquid_saturation_
 
const double residual_gas_saturation_
 
const double min_relative_permeability_
 

Additional Inherited Members

- Protected Attributes inherited from MaterialPropertyLib::Property
std::string name_
 
PropertyDataType value_
 The single value of a property.
 
PropertyDataType dvalue_
 
std::variant< Medium *, Phase *, Component * > scale_
 

Constructor & Destructor Documentation

◆ RelPermUdellNonwettingPhase()

MaterialPropertyLib::RelPermUdellNonwettingPhase::RelPermUdellNonwettingPhase ( std::string name,
const double residual_liquid_saturation,
const double residual_gas_saturation,
const double min_relative_permeability )

Member Function Documentation

◆ checkScale()

void MaterialPropertyLib::RelPermUdellNonwettingPhase::checkScale ( ) const
inlineoverridevirtual

Reimplemented from MaterialPropertyLib::Property.

Definition at line 55 of file RelPermUdellNonwettingPhase.h.

56 {
57 if (!std::holds_alternative<Medium*>(scale_))
58 {
60 "The property 'RelativePermeabilityUdellNonwettingPhase' is "
61 "implemented on the 'media' scale only.");
62 }
63 }
#define OGS_FATAL(...)
Definition Error.h:26
std::variant< Medium *, Phase *, Component * > scale_
Definition Property.h:297

References OGS_FATAL, and MaterialPropertyLib::Property::scale_.

◆ dValue()

PropertyDataType MaterialPropertyLib::RelPermUdellNonwettingPhase::dValue ( VariableArray const & variable_array,
Variable const variable,
ParameterLib::SpatialPosition const & pos,
double const t,
double const dt ) const
overridevirtual

This virtual method will compute the property derivative value based on the variables that are passed as arguments with the default implementation using empty variables array for the previous time step.

The default implementation of this method only returns the property value derivative without altering it.

Reimplemented from MaterialPropertyLib::Property.

Definition at line 69 of file RelPermUdellNonwettingPhase.cpp.

73{
74 if (variable != Variable::liquid_saturation)
75 {
77 "RelPermUdellNonwettingPhase::dValue is implemented for "
78 "derivatives with respect to liquid saturation only.");
79 }
80
81 const double S_L = variable_array.liquid_saturation;
82
83 auto const S_L_res = residual_liquid_saturation_;
84 auto const S_L_max = 1. - residual_gas_saturation_;
85 auto const S_e = (S_L - S_L_res) / (S_L_max - S_L_res);
86
87 if ((S_e < 0.) || (S_e > 1.))
88 {
89 return 0.;
90 }
91
92 auto const dS_e_dS_L = 1. / (S_L_max - S_L_res);
93
94 auto const dk_rel_GR_dS_e = -3. * (1. - S_e) * (1. - S_e);
95 return dk_rel_GR_dS_e * dS_e_dS_L;
96}

References MaterialPropertyLib::liquid_saturation, MaterialPropertyLib::VariableArray::liquid_saturation, OGS_FATAL, residual_gas_saturation_, and residual_liquid_saturation_.

◆ value()

PropertyDataType MaterialPropertyLib::RelPermUdellNonwettingPhase::value ( VariableArray const & variable_array,
ParameterLib::SpatialPosition const & pos,
double const t,
double const dt ) const
overridevirtual

This virtual method will compute the property value based on the variables that are passed as arguments with the default implementation using empty variables array for the previous time step.

Reimplemented from MaterialPropertyLib::Property.

Definition at line 35 of file RelPermUdellNonwettingPhase.cpp.

39{
40 const double S_L = variable_array.liquid_saturation;
41
42 if (std::isnan(S_L))
43 {
45 "In RelPermUdellNonwettingPhase::value, the liquid saturation is "
46 "NaN.");
47 }
48
49 auto const S_L_res = residual_liquid_saturation_;
50 auto const S_L_max = 1. - residual_gas_saturation_;
51
52 auto const S_e = (S_L - S_L_res) / (S_L_max - S_L_res);
53
54 if (S_e >= 1.0)
55 {
56 // fully saturated medium
58 }
59 if (S_e <= 0.0)
60 {
61 // dry medium
62 return 1.0;
63 }
64
65 auto const S_e_g = (1. - S_e);
66
67 return std::max(min_relative_permeability_, S_e_g * S_e_g * S_e_g);
68}

References MaterialPropertyLib::VariableArray::liquid_saturation, min_relative_permeability_, OGS_FATAL, residual_gas_saturation_, and residual_liquid_saturation_.

Member Data Documentation

◆ min_relative_permeability_

const double MaterialPropertyLib::RelPermUdellNonwettingPhase::min_relative_permeability_
private

Definition at line 47 of file RelPermUdellNonwettingPhase.h.

Referenced by value().

◆ residual_gas_saturation_

const double MaterialPropertyLib::RelPermUdellNonwettingPhase::residual_gas_saturation_
private

Definition at line 46 of file RelPermUdellNonwettingPhase.h.

Referenced by dValue(), and value().

◆ residual_liquid_saturation_

const double MaterialPropertyLib::RelPermUdellNonwettingPhase::residual_liquid_saturation_
private

Definition at line 45 of file RelPermUdellNonwettingPhase.h.

Referenced by dValue(), and value().


The documentation for this class was generated from the following files: