MaterialPropertyLib::BishopsSaturationCutoff Class Reference

Detailed Description

Bishop's effective stress model using saturation cutoff. The effective stress is 1 as long as the saturation does not fall below the saturation cutoff value.

Definition at line 18 of file BishopsSaturationCutoff.h.

#include <BishopsSaturationCutoff.h>

Inheritance diagram for MaterialPropertyLib::BishopsSaturationCutoff:

Collaboration diagram for MaterialPropertyLib::BishopsSaturationCutoff:

Public Member Functions
	BishopsSaturationCutoff (std::string name, double const cutoff_value)
void	checkScale () const override
PropertyDataType	value (VariableArray const &variable_array, ParameterLib::SpatialPosition const &, double const, double const) const override
PropertyDataType	dValue (VariableArray const &variable_array, Variable const variable, ParameterLib::SpatialPosition const &, double const, double const) 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_max_

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

BishopsSaturationCutoff()

MaterialPropertyLib::BishopsSaturationCutoff::BishopsSaturationCutoff	(	std::string	name,
		double const	cutoff_value )

Definition at line 14 of file BishopsSaturationCutoff.cpp.

    : S_L_max_(cutoff_value)
{
    name_ = std::move(name);
}

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

Member Function Documentation

checkScale()

void MaterialPropertyLib::BishopsSaturationCutoff::checkScale ( ) const

overridevirtual

Reimplemented from MaterialPropertyLib::Property.

Definition at line 21 of file BishopsSaturationCutoff.cpp.

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

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

dValue()

PropertyDataType MaterialPropertyLib::BishopsSaturationCutoff::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 41 of file BishopsSaturationCutoff.cpp.

{
    if (variable != Variable::liquid_saturation)
    {
        OGS_FATAL(
            "BishopsSaturationCutoff::dValue is implemented for derivatives "
            "with respect to liquid saturation only.");
    }
 
    return 0.;
}

References MaterialPropertyLib::liquid_saturation, and OGS_FATAL.

value()

PropertyDataType MaterialPropertyLib::BishopsSaturationCutoff::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 31 of file BishopsSaturationCutoff.cpp.

{
    auto const S_L = variable_array.liquid_saturation;
 
    return S_L < S_L_max_ ? 0. : 1.;
}

References MaterialPropertyLib::VariableArray::liquid_saturation, and S_L_max_.

Member Data Documentation

S_L_max_

double const MaterialPropertyLib::BishopsSaturationCutoff::S_L_max_

private

Definition at line 36 of file BishopsSaturationCutoff.h.

Referenced by value().

---

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

• MaterialLib/MPL/Properties/BishopsSaturationCutoff.h
• MaterialLib/MPL/Properties/BishopsSaturationCutoff.cpp