Detailed Description

A generalized power law for the relative permeability

Definition:

\[ k_{\text{rel}} = \text{multiplier} {S_{\text{eff}}}^{\text{exponent}}\]

where \(S_{\text{eff}}\) is the effective saturation of liquid phase.

This class handles the wetting (liquid) phase portion of this relative permeability property.

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

Definition at line 35 of file RelPermGeneralizedPower.h.

#include <RelPermGeneralizedPower.h>

Inheritance diagram for MaterialPropertyLib::RelPermGeneralizedPower:

[legend]

Collaboration diagram for MaterialPropertyLib::RelPermGeneralizedPower:

[legend]

Public Member Functions
	RelPermGeneralizedPower (std::string name, const double residual_liquid_saturation, const double residual_gas_saturation, const double min_relative_permeability, const double a, const double lambda)

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
const double	residual_liquid_saturation_

const double	residual_gas_saturation_

const double	min_relative_permeability_

const double	a_

const double	lambda_

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

◆ RelPermGeneralizedPower()

MaterialPropertyLib::RelPermGeneralizedPower::RelPermGeneralizedPower	(	std::string	name,
		const double	residual_liquid_saturation,
		const double	residual_gas_saturation,
		const double	min_relative_permeability,
		const double	a,
		const double	lambda )

Definition at line 19 of file RelPermGeneralizedPower.cpp.

    : residual_liquid_saturation_(residual_liquid_saturation),
      residual_gas_saturation_(residual_gas_saturation),
      min_relative_permeability_(min_relative_permeability),
      a_(a),
      lambda_(lambda)
{
    name_ = std::move(name);
}

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

Member Function Documentation

◆ checkScale()

void MaterialPropertyLib::RelPermGeneralizedPower::checkScale ( ) const

inlineoverridevirtual

Reimplemented from MaterialPropertyLib::Property.

Definition at line 52 of file RelPermGeneralizedPower.h.

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

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

◆ dValue()

PropertyDataType MaterialPropertyLib::RelPermGeneralizedPower::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 67 of file RelPermGeneralizedPower.cpp.

{
    if (variable != Variable::liquid_saturation)
    {
        OGS_FATAL(
            "RelPermGeneralizedPower::dValue is implemented for "
            "derivatives with respect to liquid saturation only.");
    }
 
    const double S_L = variable_array.liquid_saturation;
 
    auto const S_L_res = residual_liquid_saturation_;
    auto const S_L_max = 1. - residual_gas_saturation_;
    auto const S_e = (S_L - S_L_res) / (S_L_max - S_L_res);
 
    if ((S_e < 0.) || (S_e > 1.))
    {
        return 0.;
    }
 
    auto const dS_e_dS_L = 1. / (S_L_max - S_L_res);
 
    auto const dk_rel_dS_e = lambda_ * a_ * std::pow(S_e, lambda_ - 1);
    return dk_rel_dS_e * dS_e_dS_L;
}

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

◆ value()

PropertyDataType MaterialPropertyLib::RelPermGeneralizedPower::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 RelPermGeneralizedPower.cpp.

{
    const double S_L = variable_array.liquid_saturation;
 
    if (std::isnan(S_L))
    {
        OGS_FATAL(
            "In RelPermGeneralizedPower::value, the liquid saturation is "
            "NaN.");
    }
 
    auto const S_L_res = residual_liquid_saturation_;
    auto const S_L_max = 1. - residual_gas_saturation_;
 
    auto const S_e = (S_L - S_L_res) / (S_L_max - S_L_res);
 
    if (S_e >= 1.0)
    {
        // fully saturated medium
        return a_;
    }
    if (S_e <= 0.0)
    {
        // dry medium
        return min_relative_permeability_;
    }
 
    return a_ * std::pow(S_e, lambda_);
}

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

Member Data Documentation

◆ a_

const double MaterialPropertyLib::RelPermGeneralizedPower::a_

private

Definition at line 41 of file RelPermGeneralizedPower.h.

Referenced by dValue(), and value().

◆ lambda_

const double MaterialPropertyLib::RelPermGeneralizedPower::lambda_

private

Definition at line 42 of file RelPermGeneralizedPower.h.

Referenced by dValue(), and value().

◆ min_relative_permeability_

const double MaterialPropertyLib::RelPermGeneralizedPower::min_relative_permeability_

private

Definition at line 40 of file RelPermGeneralizedPower.h.

Referenced by value().

◆ residual_gas_saturation_

const double MaterialPropertyLib::RelPermGeneralizedPower::residual_gas_saturation_

private

Definition at line 39 of file RelPermGeneralizedPower.h.

Referenced by dValue(), and value().

◆ residual_liquid_saturation_

const double MaterialPropertyLib::RelPermGeneralizedPower::residual_liquid_saturation_

private

Definition at line 38 of file RelPermGeneralizedPower.h.

Referenced by dValue(), and value().

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

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

Detailed Description

Public Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ RelPermGeneralizedPower()

Member Function Documentation

◆ checkScale()

◆ dValue()

◆ value()

Member Data Documentation

◆ a_

◆ lambda_

◆ min_relative_permeability_

◆ residual_gas_saturation_

◆ residual_liquid_saturation_