OGS
MaterialPropertyLib::GasPressureDependentPermeability< DisplacementDim > Class Template Referencefinal

Detailed Description

template<int DisplacementDim>
class MaterialPropertyLib::GasPressureDependentPermeability< DisplacementDim >

A gas pressure dependent intrinsic permeability model.

The model was proposed in [43] and it was further investigated in [44] .

The model takes the form of

\[\mathbf{k} = f(p_g)\, \mathbf{k}_0 = \left\{ \begin{array}{cc} (1+a_1 p_g) \mathbf{k}_0 & p_g \leq p_\text{thr} \\ (a_2 (p_g - p_\text{thr}) + 1 + a_1 p_\text{thr}) \mathbf{k}_0 & p_g > p_\text{thr} \end{array} \right.\]

where \(\mathbf{k}\) is the permeability, \(\mathbf{k}_0\) is the initial intrinsic permeability, \(p_g\) is the gas pressure, \(a_1\), \(a_2\) and \(p_\text{thr}\) are three parameters. The threshold pressure and gas pressure, \(p_g\) , \(p_\text{thr}\), are in Pascal, and the \(a_1\) and \(a_2\) are dimensionless, representing the values reported in [44], and permeabilities, \(\mathbf{k}\) and \(\mathbf{k}_0\) are in \(m^2\).

Definition at line 51 of file GasPressureDependentPermeability.h.

#include <GasPressureDependentPermeability.h>

Inheritance diagram for MaterialPropertyLib::GasPressureDependentPermeability< DisplacementDim >:
[legend]
Collaboration diagram for MaterialPropertyLib::GasPressureDependentPermeability< DisplacementDim >:
[legend]

Public Member Functions

 GasPressureDependentPermeability (std::string name, ParameterLib::Parameter< double > const &k0, double const a1, double const a2, double const pressure_threshold, double const minimum_permeability, double const maximum_permeability, ParameterLib::CoordinateSystem const *const local_coordinate_system)
 
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

ParameterLib::Parameter< double > const & k0_
 Initial intrinsic permeability.
 
double const a1_
 
double const a2_
 
double const pressure_threshold_
 
double const minimum_permeability_
 
double const maximum_permeability_
 
ParameterLib::CoordinateSystem const *const local_coordinate_system_
 

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

◆ GasPressureDependentPermeability()

template<int DisplacementDim>
MaterialPropertyLib::GasPressureDependentPermeability< DisplacementDim >::GasPressureDependentPermeability ( std::string name,
ParameterLib::Parameter< double > const & k0,
double const a1,
double const a2,
double const pressure_threshold,
double const minimum_permeability,
double const maximum_permeability,
ParameterLib::CoordinateSystem const *const local_coordinate_system )

Definition at line 26 of file GasPressureDependentPermeability.cpp.

32 : k0_(k0),
33 a1_(a1),
34 a2_(a2),
35 pressure_threshold_(pressure_threshold),
36 minimum_permeability_(minimum_permeability),
37 maximum_permeability_(maximum_permeability),
38 local_coordinate_system_(local_coordinate_system)
39{
40 name_ = std::move(name);
41}
ParameterLib::Parameter< double > const & k0_
Initial intrinsic permeability.
ParameterLib::CoordinateSystem const *const local_coordinate_system_

References MaterialPropertyLib::name, and MaterialPropertyLib::Property::name_.

Member Function Documentation

◆ checkScale()

template<int DisplacementDim>
void MaterialPropertyLib::GasPressureDependentPermeability< DisplacementDim >::checkScale ( ) const
overridevirtual

Reimplemented from MaterialPropertyLib::Property.

Definition at line 44 of file GasPressureDependentPermeability.cpp.

45{
46 if (!std::holds_alternative<Medium*>(scale_))
47 {
49 "The property 'GasPressureDependentPermeability' is implemented on "
50 "the 'medium' scale only.");
51 }
52}
#define OGS_FATAL(...)
Definition Error.h:26
std::variant< Medium *, Phase *, Component * > scale_
Definition Property.h:297

References OGS_FATAL.

◆ dValue()

template<int DisplacementDim>
PropertyDataType MaterialPropertyLib::GasPressureDependentPermeability< DisplacementDim >::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 99 of file GasPressureDependentPermeability.cpp.

103{
104 OGS_FATAL(
105 "The derivative of the intrinsic permeability of "
106 "GasPressureDependentPermeability"
107 "is not implemented.");
108}

References OGS_FATAL.

◆ value()

template<int DisplacementDim>
PropertyDataType MaterialPropertyLib::GasPressureDependentPermeability< DisplacementDim >::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 55 of file GasPressureDependentPermeability.cpp.

59{
60 double const gas_pressure = variable_array.gas_phase_pressure;
61
62 auto k_data = k0_(t, pos);
63
64 double const factor =
65 (gas_pressure <= pressure_threshold_)
66 ? (1.0 + a1_ * gas_pressure / 1.0e6)
67 : (a2_ * (gas_pressure - pressure_threshold_) / 1.0e6 + 1.0 +
68 a1_ * pressure_threshold_ / 1.0e6);
69
70 for (auto& k_i : k_data)
71 {
72 k_i = std::clamp(k_i * factor, minimum_permeability_,
74 }
75
76 // Local coordinate transformation is only applied for the case that the
77 // initial intrinsic permeability is given with orthotropic assumption.
78 if (local_coordinate_system_ && (k_data.size() == DisplacementDim))
79 {
80 Eigen::Matrix<double, DisplacementDim, DisplacementDim> const e =
81 local_coordinate_system_->transformation<DisplacementDim>(pos);
82 Eigen::Matrix<double, DisplacementDim, DisplacementDim> k =
83 Eigen::Matrix<double, DisplacementDim, DisplacementDim>::Zero();
84
85 for (int i = 0; i < DisplacementDim; ++i)
86 {
87 Eigen::Matrix<double, DisplacementDim, DisplacementDim> const
88 ei_otimes_ei = e.col(i) * e.col(i).transpose();
89
90 k += k_data[i] * ei_otimes_ei;
91 }
92 return k;
93 }
94
95 return fromVector(k_data);
96}
PropertyDataType fromVector(std::vector< double > const &values)
Definition Property.cpp:23
Eigen::Matrix< double, Dimension, Dimension > transformation(SpatialPosition const &pos) const

References MaterialPropertyLib::fromVector(), and MaterialPropertyLib::VariableArray::gas_phase_pressure.

Member Data Documentation

◆ a1_

template<int DisplacementDim>
double const MaterialPropertyLib::GasPressureDependentPermeability< DisplacementDim >::a1_
private

A factor taking into account the influence of the gas pressure on the permeability.

Definition at line 75 of file GasPressureDependentPermeability.h.

◆ a2_

template<int DisplacementDim>
double const MaterialPropertyLib::GasPressureDependentPermeability< DisplacementDim >::a2_
private

A factor taking into account the influence of the gas overpressure (difference of the gas pressure and the threshold pressure) on the permeability.

Definition at line 79 of file GasPressureDependentPermeability.h.

◆ k0_

template<int DisplacementDim>
ParameterLib::Parameter<double> const& MaterialPropertyLib::GasPressureDependentPermeability< DisplacementDim >::k0_
private

Initial intrinsic permeability.

Definition at line 72 of file GasPressureDependentPermeability.h.

◆ local_coordinate_system_

template<int DisplacementDim>
ParameterLib::CoordinateSystem const* const MaterialPropertyLib::GasPressureDependentPermeability< DisplacementDim >::local_coordinate_system_
private

Definition at line 85 of file GasPressureDependentPermeability.h.

◆ maximum_permeability_

template<int DisplacementDim>
double const MaterialPropertyLib::GasPressureDependentPermeability< DisplacementDim >::maximum_permeability_
private

Definition at line 84 of file GasPressureDependentPermeability.h.

◆ minimum_permeability_

template<int DisplacementDim>
double const MaterialPropertyLib::GasPressureDependentPermeability< DisplacementDim >::minimum_permeability_
private

Definition at line 83 of file GasPressureDependentPermeability.h.

◆ pressure_threshold_

template<int DisplacementDim>
double const MaterialPropertyLib::GasPressureDependentPermeability< DisplacementDim >::pressure_threshold_
private

The threshold pressure which defines the low and high gas pressure domain. Different permeability functions are defined for each domain.

Definition at line 82 of file GasPressureDependentPermeability.h.


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