Detailed Description

Van Genuchten 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 25 of file RelPermVanGenuchten.h.

#include <RelPermVanGenuchten.h>

Inheritance diagram for MaterialPropertyLib::RelPermVanGenuchten:

[legend]

Collaboration diagram for MaterialPropertyLib::RelPermVanGenuchten:

[legend]

Public Member Functions
	RelPermVanGenuchten (std::string name, double const residual_liquid_saturation, double const residual_gas_saturation, double const min_relative_permeability_liquid, double const exponent)

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 >
T	initialValue (ParameterLib::SpatialPosition const &pos, double const t) const

template<typename T >
T	value () const

template<typename T >
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 >
T	value (VariableArray const &variable_array, ParameterLib::SpatialPosition const &pos, double const t, double const dt) const

template<typename T >
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 >
T	dValue (VariableArray const &variable_array, Variable const variable, ParameterLib::SpatialPosition const &pos, double const t, double const dt) const

template<typename T >
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
double const	S_L_res_

double const	S_L_max_

double const	k_rel_min_

double const	m_

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

◆ RelPermVanGenuchten()

MaterialPropertyLib::RelPermVanGenuchten::RelPermVanGenuchten	(	std::string	name,
		double const	residual_liquid_saturation,
		double const	residual_gas_saturation,
		double const	min_relative_permeability_liquid,
		double const	exponent )

Definition at line 20 of file RelPermVanGenuchten.cpp.

    : S_L_res_(residual_liquid_saturation),
      S_L_max_(1. - residual_gas_saturation),
      k_rel_min_(min_relative_permeability_liquid),
      m_(exponent)
{
    name_ = std::move(name);
 
    if (!(m_ > 0 && m_ < 1))
    {
        OGS_FATAL(
            "The exponent value m = {:g} of van Genuchten relative "
            "permeability model, is out of its range of (0, 1)",
            m_);
    }
}

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

Member Function Documentation

◆ checkScale()

void MaterialPropertyLib::RelPermVanGenuchten::checkScale ( ) const

inlineoverridevirtual

Reimplemented from MaterialPropertyLib::Property.

Definition at line 40 of file RelPermVanGenuchten.h.

    {
        if (!std::holds_alternative<Medium*>(scale_))
        {
            OGS_FATAL(
                "The property 'RelativePermeabilityVanGenuchten' is "
                "implemented on the 'media' scale only.");
        }
    }

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

◆ dValue()

PropertyDataType MaterialPropertyLib::RelPermVanGenuchten::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 56 of file RelPermVanGenuchten.cpp.

{
    if (variable != Variable::liquid_saturation)
    {
        OGS_FATAL(
            "RelativePermeabilityVanGenuchten::dValue is implemented for "
            "derivatives with respect to liquid saturation only.");
    }
 
    double const S_L =
        std::clamp(variable_array.liquid_saturation, S_L_res_, S_L_max_);
 
    double const S_eff = (S_L - S_L_res_) / (S_L_max_ - S_L_res_);
    if (S_eff <= 0)  // prevent division by zero
    {
        return 0.;
    }
 
    if (S_eff >= 1)  // prevent taking root of zero
    {
        return 0.;
    }
 
    double const S_eff_to_1_over_m = std::pow(S_eff, 1. / m_);
    double const v = 1. - std::pow(1. - S_eff_to_1_over_m, m_);
    double const sqrt_S_eff = std::sqrt(S_eff);
    double const k_rel = sqrt_S_eff * v * v;
 
    if (k_rel < k_rel_min_)
    {
        return 0.;
    }
 
    return (0.5 * v * v / sqrt_S_eff +
            2. * sqrt_S_eff * v * std::pow(1. - S_eff_to_1_over_m, m_ - 1.) *
                S_eff_to_1_over_m / S_eff) /
           (S_L_max_ - S_L_res_);
}

References k_rel_min_, MaterialPropertyLib::liquid_saturation, MaterialPropertyLib::VariableArray::liquid_saturation, m_, OGS_FATAL, S_L_max_, and S_L_res_.

◆ value()

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

overridevirtual

Those methods override the base class implementations and actually compute and set the property values_ and dValues_.

Reimplemented from MaterialPropertyLib::Property.

Definition at line 42 of file RelPermVanGenuchten.cpp.

{
    double const S_L =
        std::clamp(variable_array.liquid_saturation, S_L_res_, S_L_max_);
 
    double const S_eff = (S_L - S_L_res_) / (S_L_max_ - S_L_res_);
    double const v = 1. - std::pow(1. - std::pow(S_eff, 1. / m_), m_);
    double const k_rel = std::sqrt(S_eff) * v * v;
    return std::max(k_rel_min_, k_rel);
}

References k_rel_min_, MaterialPropertyLib::VariableArray::liquid_saturation, m_, S_L_max_, and S_L_res_.

Member Data Documentation

◆ k_rel_min_

double const MaterialPropertyLib::RelPermVanGenuchten::k_rel_min_

private

Definition at line 30 of file RelPermVanGenuchten.h.

Referenced by dValue(), and value().

◆ m_

double const MaterialPropertyLib::RelPermVanGenuchten::m_

private

Definition at line 31 of file RelPermVanGenuchten.h.

Referenced by RelPermVanGenuchten(), dValue(), and value().

◆ S_L_max_

double const MaterialPropertyLib::RelPermVanGenuchten::S_L_max_

private

Definition at line 29 of file RelPermVanGenuchten.h.

Referenced by dValue(), and value().

◆ S_L_res_

double const MaterialPropertyLib::RelPermVanGenuchten::S_L_res_

private

Definition at line 28 of file RelPermVanGenuchten.h.

Referenced by dValue(), and value().

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

MaterialLib/MPL/Properties/RelativePermeability/RelPermVanGenuchten.h
MaterialLib/MPL/Properties/RelativePermeability/RelPermVanGenuchten.cpp

Detailed Description

Public Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ RelPermVanGenuchten()

Member Function Documentation

◆ checkScale()

◆ dValue()

◆ value()

Member Data Documentation

◆ k_rel_min_

◆ m_

◆ S_L_max_

◆ S_L_res_