Detailed Description

Relative permeability function of the wetting phase proposed by Brooks&Corey.

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

Definition at line 23 of file RelPermBrooksCorey.h.

#include <RelPermBrooksCorey.h>

Inheritance diagram for MaterialPropertyLib::RelPermBrooksCorey:

[legend]

Collaboration diagram for MaterialPropertyLib::RelPermBrooksCorey:

[legend]

Public Member Functions
	RelPermBrooksCorey (std::string name, const double, const double, const double, const double)
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	exponent_

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

◆ RelPermBrooksCorey()

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

Definition at line 13 of file RelPermBrooksCorey.cpp.

    : residual_liquid_saturation_(residual_liquid_saturation),
      residual_gas_saturation_(residual_gas_saturation),
      min_relative_permeability_(min_relative_permeability),
      exponent_(exponent)
{
    name_ = std::move(name);
 
    if (exponent_ <= 0.)
    {
        OGS_FATAL(
            "RelPermBrooksCorey: exponent 'lambda' must be positive, but {} "
            "was given.",
            exponent_);
    }
    if (residual_liquid_saturation_ < 0.)
    {
        OGS_FATAL(
            "RelPermBrooksCorey: residual_liquid_saturation must be "
            "non-negative, but {} was given.",
            residual_liquid_saturation_);
    }
    if (residual_gas_saturation_ < 0.)
    {
        OGS_FATAL(
            "RelPermBrooksCorey: residual_gas_saturation must be non-negative, "
            "but {} was given.",
            residual_gas_saturation_);
    }
    if (residual_liquid_saturation_ + residual_gas_saturation_ >= 1.)
    {
        OGS_FATAL(
            "RelPermBrooksCorey: residual_liquid_saturation ({}) + "
            "residual_gas_saturation ({}) must be less than 1 so that the "
            "effective saturation range is positive.",
            residual_liquid_saturation_, residual_gas_saturation_);
    }
    if (min_relative_permeability_ < 0. || min_relative_permeability_ > 1.)
    {
        OGS_FATAL(
            "RelPermBrooksCorey: min_relative_permeability must be in [0, 1], "
            "but {} was given.",
            min_relative_permeability_);
    }
};

References exponent_, min_relative_permeability_, MaterialPropertyLib::name, MaterialPropertyLib::Property::name_, OGS_FATAL, MaterialPropertyLib::residual_gas_saturation, residual_gas_saturation_, MaterialPropertyLib::residual_liquid_saturation, and residual_liquid_saturation_.

Member Function Documentation

◆ checkScale()

void MaterialPropertyLib::RelPermBrooksCorey::checkScale ( ) const

inlineoverridevirtual

Reimplemented from MaterialPropertyLib::Property.

Definition at line 39 of file RelPermBrooksCorey.h.

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

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

◆ dValue()

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

here, an extra computation of saturation is forced, guaranteeing a correct value. In order to speed up the computing time, saturation could be inserted into the primary variable array after it is computed in the FEM assembly.

Reimplemented from MaterialPropertyLib::Property.

Definition at line 102 of file RelPermBrooksCorey.cpp.

{
    if (variable != Variable::liquid_saturation)
    {
        OGS_FATAL(
            "RelPermBrooksCorey::dValue is implemented for derivatives with "
            "respect to liquid saturation only.");
    }
    auto const s_L = std::visit(
        [&variable_array, &pos, t, dt](auto&& scale) -> double
        {
            return scale->property(PropertyType::saturation)
                .template value<double>(variable_array, pos, t, dt);
        },
        scale_);
 
    auto const s_L_res = residual_liquid_saturation_;
    auto const s_L_max = 1. - residual_gas_saturation_;
    auto const lambda = exponent_;
 
    auto const s_eff = (s_L - s_L_res) / (s_L_max - s_L_res);
    // Consistency with value(): at s_eff == 1 the value is clamped to the
    // constant 1.0 (and saturation models clamping S_L at s_L_max put whole
    // regions exactly on this point), so the derivative there is zero.
    if ((s_eff < 0.) || (s_eff >= 1.))
    {
        return 0.;
    }
 
    // Consistency with value(): where the min_relative_permeability clamp is
    // active (dry range), the relative permeability is constant and its
    // derivative is zero.
    auto const k_rel_LR = std::pow(s_eff, (2. + 3. * lambda) / lambda);
    if (k_rel_LR <= min_relative_permeability_)
    {
        return 0.;
    }
 
    auto const d_se_d_sL = 1. / (s_L_max - s_L_res);
    auto const dk_rel_LRdse =
        (3 * lambda + 2.) / lambda * std::pow(s_eff, 2. / lambda + 2.);
 
    return dk_rel_LRdse * d_se_d_sL;
}

References exponent_, MaterialPropertyLib::liquid_saturation, min_relative_permeability_, OGS_FATAL, residual_gas_saturation_, residual_liquid_saturation_, MaterialPropertyLib::saturation, MaterialPropertyLib::Property::scale_, and MaterialPropertyLib::Property::value().

◆ value()

PropertyDataType MaterialPropertyLib::RelPermBrooksCorey::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_.

here, an extra computation of saturation is forced, guaranteeing a correct value. In order to speed up the computing time, saturation could be inserted into the primary variable array after it is computed in the FEM assembly.

Reimplemented from MaterialPropertyLib::Property.

Definition at line 63 of file RelPermBrooksCorey.cpp.

{
    auto const s_L = std::visit(
        [&variable_array, &pos, t, dt](auto&& scale) -> double
        {
            return scale->property(PropertyType::saturation)
                .template value<double>(variable_array, pos, t, dt);
        },
        scale_);
 
    auto const s_L_res = residual_liquid_saturation_;
    auto const s_L_max = 1. - residual_gas_saturation_;
 
    auto const lambda = exponent_;
 
    auto const s_eff = (s_L - s_L_res) / (s_L_max - s_L_res);
 
    if (s_eff >= 1.0)
    {
        // fully saturated medium
        return 1.0;
    }
    if (s_eff <= 0.0)
    {
        // dry medium
        return min_relative_permeability_;
    }
 
    auto const k_rel_LR = std::pow(s_eff, (2. + 3. * lambda) / lambda);
 
    return std::max(k_rel_LR, min_relative_permeability_);
}

References exponent_, min_relative_permeability_, residual_gas_saturation_, residual_liquid_saturation_, MaterialPropertyLib::saturation, MaterialPropertyLib::Property::scale_, and MaterialPropertyLib::Property::value().

Member Data Documentation

◆ exponent_

const double MaterialPropertyLib::RelPermBrooksCorey::exponent_

private

Definition at line 29 of file RelPermBrooksCorey.h.

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

◆ min_relative_permeability_

const double MaterialPropertyLib::RelPermBrooksCorey::min_relative_permeability_

private

Definition at line 28 of file RelPermBrooksCorey.h.

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

◆ residual_gas_saturation_

const double MaterialPropertyLib::RelPermBrooksCorey::residual_gas_saturation_

private

Definition at line 27 of file RelPermBrooksCorey.h.

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

◆ residual_liquid_saturation_

const double MaterialPropertyLib::RelPermBrooksCorey::residual_liquid_saturation_

private

Definition at line 26 of file RelPermBrooksCorey.h.

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

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

Detailed Description

Public Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ RelPermBrooksCorey()

Member Function Documentation

◆ checkScale()

◆ dValue()

◆ value()

Member Data Documentation

◆ exponent_

◆ min_relative_permeability_

◆ residual_gas_saturation_

◆ residual_liquid_saturation_