MaterialPropertyLib::Exponential Class Reference

Detailed Description

An exponential property.

This property calculates the exponential relationship \( \alpha(\beta) = \alpha_{\mathrm{offset}} + \alpha_{\mathrm{ref}} \cdot \exp \left(m (\beta - \beta_{\mathrm{ref}})\right)\), where:

• \(\alpha_{\mathrm{ref}}\) is a reference value, for instance reference viscosity,
• \(\alpha_{\mathrm{offset}}\) is additive offset in units of the property,
• \(m\) is a dimensionless exponent,
• \(\beta_{\mathrm{ref}}\) is a reference condition value of independent variable, for instance reference temperature.

The current implementation accepts only the scalar independent variables.

Definition at line 41 of file Exponential.h.

#include <Exponential.h>

Inheritance diagram for MaterialPropertyLib::Exponential:

Collaboration diagram for MaterialPropertyLib::Exponential:

Public Member Functions
	Exponential (std::string name, double const offset, PropertyDataType const &property_reference_value, ExponentData const &v)
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 &, double const, double const) const override
PropertyDataType	d2Value (VariableArray const &variable_array, Variable const pv1, Variable const pv2, 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 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
ExponentData const	exponent_data_
double const	offset_
	additive offset in units of the property.

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

Exponential()

MaterialPropertyLib::Exponential::Exponential	(	std::string	name,
		double const	offset,
		PropertyDataType const &	property_reference_value,
		ExponentData const &	v )

This constructor accepts single values of double data type defined in the PropertyDataType definition and sets the protected attribute value_ of the base class Property to that value.

Definition at line 17 of file Exponential.cpp.

    : exponent_data_(v), offset_(offset)
{
    name_ = std::move(name);
    auto const f = std::get<double>(exponent_data_.factor);
    auto const v0 = std::get<double>(exponent_data_.reference_condition);
    value_ = std::get<double>(property_reference_value) * std::exp(-f * v0);
}

References exponent_data_, MaterialPropertyLib::name, MaterialPropertyLib::Property::name_, offset_, and MaterialPropertyLib::Property::value_.

Member Function Documentation

d2Value()

PropertyDataType MaterialPropertyLib::Exponential::d2Value ( VariableArray const & variable_array, Variable const pv1, Variable const pv2, ParameterLib::SpatialPosition const & , double const , double const  ) const

overridevirtual

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

Reimplemented from MaterialPropertyLib::Property.

Definition at line 87 of file Exponential.cpp.

{
    Variable const* const independent_variable =
        std::get_if<Variable>(&exponent_data_.type);
    if (independent_variable == nullptr)
    {
        return 0.;
    }
    if (*independent_variable != pv1 && *independent_variable != pv2)
    {
        return 0.;
    }
 
    auto const f = std::get<double>(exponent_data_.factor);
    auto const v = std::get<double>(variable_array[*independent_variable]);
 
    return std::get<double>(value_) * f * f * std::exp(f * v);
}

References exponent_data_, and MaterialPropertyLib::Property::value_.

dValue()

PropertyDataType MaterialPropertyLib::Exponential::dValue ( VariableArray const & variable_array, Variable const variable, ParameterLib::SpatialPosition const & , double const , double const  ) const

overridevirtual

This method will compute the derivative of a property with respect to the given primary variable.

Reimplemented from MaterialPropertyLib::Property.

Definition at line 65 of file Exponential.cpp.

{
    Variable const* const independent_variable =
        std::get_if<Variable>(&exponent_data_.type);
    if (independent_variable == nullptr)
    {
        return 0.;
    }
    if (*independent_variable != variable)
    {
        return 0.;
    }
 
    auto const f = std::get<double>(exponent_data_.factor);
    auto const v = std::get<double>(variable_array[*independent_variable]);
 
    return std::get<double>(value_) * f * std::exp(f * v);
}

References exponent_data_, and MaterialPropertyLib::Property::value_.

value()

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

overridevirtual

This method computes the value of a property \(\alpha\) depending exponentially on the value of the given primary variable \(\beta\).

Reimplemented from MaterialPropertyLib::Property.

Definition at line 29 of file Exponential.cpp.

{
    double v = 0.0;
    if (Variable const* const variable =
            std::get_if<Variable>(&exponent_data_.type))
    {
        v = std::get<double>(variable_array[*variable]);
    }
    else if (auto* str_ptr = std::get_if<std::string>(&exponent_data_.type))
    {
        if (*str_ptr == "t")
            v = t;
        else if (*str_ptr == "x")
            v = pos.getCoordinates().value()[0];
        else if (*str_ptr == "y")
            v = pos.getCoordinates().value()[1];
        else if (*str_ptr == "z")
            v = pos.getCoordinates().value()[2];
        else
            OGS_FATAL(
                "Unknown independent_variable {:s} for exponential property.",
                *str_ptr)
    }
    else
    {
        OGS_FATAL(
            "Could not convert independent_variable neither to a Variable nor "
            "to a std::string.");
    }
    auto const f = std::get<double>(exponent_data_.factor);
 
    return offset_ + std::get<double>(value_) * std::exp(f * v);
}

References exponent_data_, ParameterLib::SpatialPosition::getCoordinates(), offset_, OGS_FATAL, and MaterialPropertyLib::Property::value_.

Member Data Documentation

exponent_data_

ExponentData const MaterialPropertyLib::Exponential::exponent_data_

private

Definition at line 72 of file Exponential.h.

Referenced by Exponential(), d2Value(), dValue(), and value().

offset_

double const MaterialPropertyLib::Exponential::offset_

private

additive offset in units of the property.

Definition at line 73 of file Exponential.h.

Referenced by Exponential(), and value().

---

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

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