Detailed Description

This class is the base class for any material property of any scale (i.e. components, phases, media, ...). The single value of that Property can hold scalars, vectors, tensors, strings, etc.

Definition at line 50 of file Property.h.

#include <Property.h>

Public Member Functions
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	value (VariableArray const &variable_array, 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	dValue (VariableArray const &variable_array, 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

Protected Attributes
std::string	name_

PropertyDataType	value_
	The single value of a property.

PropertyDataType	dvalue_

std::variant< Medium , Phase , Component * >	scale_

Private Member Functions
virtual void	checkScale () const

std::string	description () const

Private Attributes
bool	property_used = false

Static Private Attributes
static constexpr std::array	property_data_type_names_
	Corresponds to the PropertyDataType.

Constructor & Destructor Documentation

◆ ~Property()

virtual MaterialPropertyLib::Property::~Property ( )

inlinevirtual

Definition at line 54 of file Property.h.

    {
        if (property_used)
        {
            DBUG("Property is used: '{:s}'", description());
        }
        else
        {
            WARN("Property is not used: '{:s}'", description());
        }
    }

References DBUG(), description(), property_used, and WARN().

Member Function Documentation

◆ checkScale()

virtual void MaterialPropertyLib::Property::checkScale ( ) const

inlineprivatevirtual

Definition at line 300 of file Property.h.

    {
        // Empty check for properties which can be defined on every scale,
        // medium, phase or component
    }

Referenced by setScale().

◆ d2Value() [1/2]

template<typename T >

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

inline

Definition at line 263 of file Property.h.

    {
        try
        {
#ifndef NDEBUG
            property_used = true;
#endif
            return std::get<T>(
                d2Value(variable_array, variable1, variable2, pos, t, dt));
        }
        catch (std::bad_variant_access const&)
        {
            OGS_FATAL(
                "The second derivative value of {:s} is not of the requested "
                "type '{:s}' but a {:s}.",
                description(),
                typeid(T).name(),
                property_data_type_names_[d2Value(variable_array, variable1,
                                                  variable2, pos, t, dt)
                                              .index()]);
        }
    }

References d2Value(), description(), MaterialPropertyLib::name, OGS_FATAL, property_data_type_names_, and property_used.

◆ d2Value() [2/2]

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

virtual

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.

Definition at line 131 of file Property.cpp.

{
#ifndef NDEBUG
    property_used = true;
#endif
    return 0.0;
}

References property_used.

Referenced by d2Value(), and MaterialPropertyLib::SpecificHeatCapacityWithLatentHeat::dValue().

◆ description()

std::string MaterialPropertyLib::Property::description ( ) const

private

Definition at line 151 of file Property.cpp.

{
    return "property '" + name_ + "' defined for " +
           std::visit(
               [](auto&& scale) -> std::string
               {
                   if (scale == nullptr)
                   {
                       return "unknown scale";
                   }
                   return scale->description();
               },
               scale_);
}

References name_, and scale_.

Referenced by ~Property(), d2Value(), dValue(), dValue(), initialValue(), value(), value(), and value().

◆ dValue() [1/4]

PropertyDataType MaterialPropertyLib::Property::dValue	(	VariableArray const &	variable_array,
		Variable const	variable,
		ParameterLib::SpatialPosition const &	pos,
		double const	t,
		double const	dt ) const

virtual

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.

Definition at line 119 of file Property.cpp.

{
#ifndef NDEBUG
    property_used = true;
#endif
    return dValue(variable_array, EmptyVariableArray, variable, pos, t, dt);
}

References dValue(), MaterialPropertyLib::EmptyVariableArray, and property_used.

◆ dValue() [2/4]

template<typename T >

T MaterialPropertyLib::Property::dValue	(	VariableArray const &	variable_array,
		Variable const	variable,
		ParameterLib::SpatialPosition const &	pos,
		double const	t,
		double const	dt ) const

inline

Definition at line 240 of file Property.h.

    {
        try
        {
#ifndef NDEBUG
            property_used = true;
#endif
            return std::get<T>(dValue(variable_array, variable, pos, t, dt));
        }
        catch (std::bad_variant_access const&)
        {
            OGS_FATAL(
                "The first derivative value of {:s} is not of the requested "
                "type '{:s}' but a {:s}.",
                description(),
                typeid(T).name(),
                property_data_type_names_
                    [dValue(variable_array, variable, pos, t, dt).index()]);
        }
    }

References description(), dValue(), MaterialPropertyLib::name, OGS_FATAL, property_data_type_names_, and property_used.

◆ dValue() [3/4]

PropertyDataType MaterialPropertyLib::Property::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

This virtual method will compute the property derivative value based on the variables that are passed as arguments and the variables from the previous time step.

Reimplemented in MaterialPropertyLib::Constant, and MaterialPropertyLib::SaturationDependentSwelling.

Definition at line 105 of file Property.cpp.

{
#ifndef NDEBUG
    property_used = true;
#endif
    return dvalue_;
}

References dvalue_, and property_used.

Referenced by dValue(), and dValue().

◆ dValue() [4/4]

template<typename T >

T MaterialPropertyLib::Property::dValue	(	VariableArray const &	variable_array,
		VariableArray const &	variable_array_prev,
		Variable const	variable,
		ParameterLib::SpatialPosition const &	pos,
		double const	t,
		double const	dt ) const

inline

Definition at line 215 of file Property.h.

    {
        try
        {
#ifndef NDEBUG
            property_used = true;
#endif
            return std::get<T>(dValue(variable_array, variable_array_prev,
                                      variable, pos, t, dt));
        }
        catch (std::bad_variant_access const&)
        {
            OGS_FATAL(
                "The first derivative value of {:s} is not of the requested "
                "type '{:s}' but a {:s}.",
                description(),
                typeid(T).name(),
                property_data_type_names_
                    [dValue(variable_array, variable, pos, t, dt).index()]);
        }
    }

References description(), dValue(), MaterialPropertyLib::name, OGS_FATAL, property_data_type_names_, and property_used.

◆ initialValue() [1/2]

PropertyDataType MaterialPropertyLib::Property::initialValue	(	ParameterLib::SpatialPosition const &	pos,
		double const	t ) const

virtual

Returns the initial (or reference) value of the property. The default implementation forwards to the value function.

Reimplemented in MaterialPropertyLib::PorosityFromMassBalance, and MaterialPropertyLib::TransportPorosityFromMassBalance.

Definition at line 69 of file Property.cpp.

{
    return value(EmptyVariableArray, pos, t,
                 std::numeric_limits<double>::quiet_NaN());
}

References MaterialPropertyLib::EmptyVariableArray, and value().

Referenced by initialValue().

◆ initialValue() [2/2]

template<typename T >

T MaterialPropertyLib::Property::initialValue	(	ParameterLib::SpatialPosition const &	pos,
		double const	t ) const

inline

Definition at line 125 of file Property.h.

    {
        try
        {
            return std::get<T>(initialValue(pos, t));
        }
        catch (std::bad_variant_access const&)
        {
            OGS_FATAL(
                "The initial value of {:s} does not hold requested type '{:s}' "
                "but a {:s}.",
                description(),
                typeid(T).name(),
                property_data_type_names_[initialValue(pos, t).index()]);
        }
    }

References description(), initialValue(), MaterialPropertyLib::name, OGS_FATAL, and property_data_type_names_.

◆ setProperties()

void MaterialPropertyLib::Property::setProperties ( std::vector< std::unique_ptr< Phase > > const & phases )

virtual

Default implementation:

This virtual method will collect the properties of the phases in order to access them from the medium property level.

Reimplemented in MaterialPropertyLib::SpecificHeatCapacityWithLatentHeat, and MaterialPropertyLib::VolumeFractionAverage.

Definition at line 145 of file Property.cpp.

{
    // empty
}

◆ setScale()

void MaterialPropertyLib::Property::setScale ( std::variant< Medium *, Phase *, Component * > scale )

inline

Definition at line 118 of file Property.h.

    {
        scale_ = scale;
        checkScale();
    };

References checkScale(), and scale_.

◆ value() [1/6]

PropertyDataType MaterialPropertyLib::Property::value ( ) const

virtual

This virtual method simply returns the private value_ attribute without changing it.

Definition at line 76 of file Property.cpp.

{
#ifndef NDEBUG
    property_used = true;
#endif
    return value_;
}

References property_used, and value_.

◆ value() [2/6]

template<typename T >

T MaterialPropertyLib::Property::value ( ) const

inline

Definition at line 144 of file Property.h.

    {
        try
        {
#ifndef NDEBUG
            property_used = true;
#endif
            return std::get<T>(value());
        }
        catch (std::bad_variant_access const&)
        {
            OGS_FATAL(
                "The value of {:s} does not hold requested type '{:s}' but a "
                "{:s}.",
                description(),
                typeid(T).name(),
                property_data_type_names_[value().index()]);
        }
    }

References description(), MaterialPropertyLib::name, OGS_FATAL, property_data_type_names_, property_used, and value().

◆ value() [3/6]

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

virtual

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.

Definition at line 95 of file Property.cpp.

{
#ifndef NDEBUG
    property_used = true;
#endif
    return value(variable_array, EmptyVariableArray, pos, t, dt);
}

References MaterialPropertyLib::EmptyVariableArray, property_used, and value().

◆ value() [4/6]

template<typename T >

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

inline

Definition at line 191 of file Property.h.

    {
        try
        {
#ifndef NDEBUG
            property_used = true;
#endif
            return std::get<T>(value(variable_array, pos, t, dt));
        }
        catch (std::bad_variant_access const&)
        {
            OGS_FATAL(
                "The value of {:s} is not of the requested type '{:s}' but a "
                "{:s}.",
                description(),
                typeid(T).name(),
                property_data_type_names_[value(variable_array, pos, t, dt)
                                              .index()]);
        }
    }

References description(), MaterialPropertyLib::name, OGS_FATAL, property_data_type_names_, property_used, and value().

◆ value() [5/6]

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

virtual

This virtual method will compute the property value based on the variables that are passed as arguments and the variables from the previous time step.

Reimplemented in MaterialPropertyLib::LinearSaturationSwellingStress, MaterialPropertyLib::Parameter, MaterialPropertyLib::PorosityFromMassBalance, MaterialPropertyLib::SaturationDependentSwelling, and MaterialPropertyLib::TransportPorosityFromMassBalance.

Definition at line 84 of file Property.cpp.

{
#ifndef NDEBUG
    property_used = true;
#endif
    return value_;
}

References property_used, and value_.

◆ value() [6/6]

template<typename T >

T MaterialPropertyLib::Property::value	(	VariableArray const &	variable_array,
		VariableArray const &	variable_array_prev,
		ParameterLib::SpatialPosition const &	pos,
		double const	t,
		double const	dt ) const

inline

Definition at line 165 of file Property.h.

    {
        try
        {
#ifndef NDEBUG
            property_used = true;
#endif
            return std::get<T>(
                value(variable_array, variable_array_prev, pos, t, dt));
        }
        catch (std::bad_variant_access const&)
        {
            OGS_FATAL(
                "The value of {:s} is not of the requested type '{:s}' but a "
                "{:s}.",
                description(),
                typeid(T).name(),
                property_data_type_names_[value(variable_array,
                                                variable_array_prev, pos, t, dt)
                                              .index()]);
        }
    }

References description(), MaterialPropertyLib::name, OGS_FATAL, property_data_type_names_, property_used, and value().

Member Data Documentation

◆ dvalue_

PropertyDataType MaterialPropertyLib::Property::dvalue_

protected

Definition at line 293 of file Property.h.

Referenced by MaterialPropertyLib::Constant::Constant(), and dValue().

◆ name_

std::string MaterialPropertyLib::Property::name_

protected

Definition at line 290 of file Property.h.

◆ property_data_type_names_

std::array MaterialPropertyLib::Property::property_data_type_names_

staticconstexprprivate

Initial value:

= {
        "scalar",           "2-vector",           "3-vector",
        "2x2-matrix",       "3x3-matrix",         "2D-Kelvin vector",
        "3D-Kelvin vector", "dynamic matrix type"}

Corresponds to the PropertyDataType.

Definition at line 312 of file Property.h.

                                                          {
        "scalar",           "2-vector",           "3-vector",
        "2x2-matrix",       "3x3-matrix",         "2D-Kelvin vector",
        "3D-Kelvin vector", "dynamic matrix type"};

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

◆ property_used

bool MaterialPropertyLib::Property::property_used = false

mutableprivate

Definition at line 307 of file Property.h.

Referenced by ~Property(), d2Value(), d2Value(), dValue(), dValue(), value(), value(), and value().

◆ scale_

std::variant<Medium*, Phase*, Component*> MaterialPropertyLib::Property::scale_

protected

Definition scale of the property. Can be one of medium, phase, or component in general. Set through setScale method which takes care of the correctness in special cases.

Definition at line 297 of file Property.h.

◆ value_

PropertyDataType MaterialPropertyLib::Property::value_

protected

The single value of a property.

Definition at line 292 of file Property.h.

Referenced by MaterialPropertyLib::Constant::Constant(), MaterialPropertyLib::Exponential::Exponential(), MaterialPropertyLib::Linear::Linear(), MaterialPropertyLib::Exponential::d2Value(), MaterialPropertyLib::Linear::d2Value(), MaterialPropertyLib::Exponential::dValue(), MaterialPropertyLib::Linear::dValue(), MaterialPropertyLib::Exponential::value(), MaterialPropertyLib::Linear::value(), value(), and value().

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

MaterialLib/MPL/Property.h
MaterialLib/MPL/Property.cpp

Detailed Description

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Constructor & Destructor Documentation

◆ ~Property()

Member Function Documentation

◆ checkScale()

◆ d2Value() [1/2]

◆ d2Value() [2/2]

◆ description()

◆ dValue() [1/4]

◆ dValue() [2/4]

◆ dValue() [3/4]

◆ dValue() [4/4]

◆ initialValue() [1/2]

◆ initialValue() [2/2]

◆ setProperties()

◆ setScale()

◆ value() [1/6]

◆ value() [2/6]

◆ value() [3/6]

◆ value() [4/6]

◆ value() [5/6]

◆ value() [6/6]

Member Data Documentation

◆ dvalue_

◆ name_

◆ property_data_type_names_

◆ property_used

◆ scale_

◆ value_