Detailed Description

Temperature dependent model for some volume or mass fraction

This property must be a medium property. It can be used for media with a phase change of the fluid in the pore space. Then, there is a temperature dependent (volume or mass) fraction for one of the two phases. The other one is immediately given by the remaining fraction. The fraction is computed based on a phase transition spread over a temperature interval following a sigmoid line:

\[ \frac{\phi}{1 + \exp(k(T - T_\mathrm{c}))} \]

Parameter \(k\) controlling the steepness of the phase change and \(T_\mathrm{c}\) as the characteristic temperature where the phase change is centered around (melting temperature) are forwarded to a sigmoid function.

Definition at line 38 of file TemperatureDependentFraction.h.

#include <TemperatureDependentFraction.h>

Inheritance diagram for MaterialPropertyLib::TemperatureDependentFraction:

[legend]

Collaboration diagram for MaterialPropertyLib::TemperatureDependentFraction:

[legend]

Public Member Functions
	TemperatureDependentFraction (std::string name, double const k, double const T_c)

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

PropertyDataType	d2Value (VariableArray const &variable_array, Variable const variable1, Variable const variable2, ParameterLib::SpatialPosition const &pos, double const t, double const dt) const override
	Default implementation: 2nd derivative of any constant property is zero.

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 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
SigmoidFunction	phase_change_shape_

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

◆ TemperatureDependentFraction()

MaterialPropertyLib::TemperatureDependentFraction::TemperatureDependentFraction	(	std::string	name,
		double const	k,
		double const	T_c )

Definition at line 18 of file TemperatureDependentFraction.cpp.

    : phase_change_shape_(k, T_c)
{
    name_ = std::move(name);
}

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

Member Function Documentation

◆ checkScale()

void MaterialPropertyLib::TemperatureDependentFraction::checkScale ( ) const

overridevirtual

Reimplemented from MaterialPropertyLib::Property.

Definition at line 26 of file TemperatureDependentFraction.cpp.

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

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

◆ d2Value()

PropertyDataType MaterialPropertyLib::TemperatureDependentFraction::d2Value	(	VariableArray const &	variable_array,
		Variable const	variable1,
		Variable const	variable2,
		ParameterLib::SpatialPosition const &	pos,
		double const	t,
		double const	dt ) const

overridevirtual

Default implementation: 2nd derivative of any constant property is zero.

This virtual method will compute the second derivative of a property with respect to the given variables pv1 and pv2.

Reimplemented from MaterialPropertyLib::Property.

Definition at line 73 of file TemperatureDependentFraction.cpp.

{
    (void)variable1;
    assert((variable1 == Variable::temperature) &&
           "TemperatureDependantFraction::d2value is implemented for "
           "derivatives with respect to temperature only.");
 
    (void)variable2;
    assert((variable2 == Variable::temperature) &&
           "TemperatureDependantFraction::d2value is implemented for "
           "derivatives with respect to temperature only.");
 
    auto const T = variable_array.temperature;
 
    auto const& medium = *std::get<Medium*>(scale_);
    auto const& porosity = medium[PropertyType::porosity];
 
    auto const phi =
        std::get<double>(porosity.value(variable_array, pos, t, dt));
 
    return phi * phase_change_shape_.d2Value(T);
}

References MaterialPropertyLib::SigmoidFunction::d2Value(), phase_change_shape_, MaterialPropertyLib::porosity, MaterialPropertyLib::Property::scale_, MaterialPropertyLib::temperature, and MaterialPropertyLib::VariableArray::temperature.

◆ dValue()

PropertyDataType MaterialPropertyLib::TemperatureDependentFraction::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 52 of file TemperatureDependentFraction.cpp.

{
    (void)variable;
    assert((variable == Variable::temperature) &&
           "TemperatureDependantFraction::dvalue is implemented for "
           "derivatives with respect to temperature only.");
 
    auto const T = variable_array.temperature;
 
    auto const& medium = *std::get<Medium*>(scale_);
    auto const& porosity = medium[PropertyType::porosity];
 
    auto const phi =
        std::get<double>(porosity.value(variable_array, pos, t, dt));
 
    return phi * phase_change_shape_.dValue(T);
}

References MaterialPropertyLib::SigmoidFunction::dValue(), phase_change_shape_, MaterialPropertyLib::porosity, MaterialPropertyLib::Property::scale_, MaterialPropertyLib::temperature, and MaterialPropertyLib::VariableArray::temperature.

◆ value()

PropertyDataType MaterialPropertyLib::TemperatureDependentFraction::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 36 of file TemperatureDependentFraction.cpp.

{
    auto const T = variable_array.temperature;
 
    auto const& medium = *std::get<Medium*>(scale_);
    auto const& porosity = medium[PropertyType::porosity];
 
    auto const phi =
        std::get<double>(porosity.value(variable_array, pos, t, dt));
 
    return phi * phase_change_shape_.value(T);
}