MaterialPropertyLib::Linear Class Reference

Detailed Description

The linear property class. This property calculates the linear relationship. The current implementation accepts only the double datatype defined in PropertyDataType.

Definition at line 32 of file Linear.h.

#include <Linear.h>

Inheritance diagram for MaterialPropertyLib::Linear:

Collaboration diagram for MaterialPropertyLib::Linear:

Public Member Functions
	Linear (std::string name, PropertyDataType const &property_reference_value, std::vector< IndependentVariable > const &vs)
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
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
std::vector< IndependentVariable > const	independent_variables_

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

Linear()

MaterialPropertyLib::Linear::Linear	(	std::string	name,
		PropertyDataType const &	property_reference_value,
		std::vector< IndependentVariable > const &	vs )

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 70 of file Linear.cpp.

    : independent_variables_(vs)
{
    name_ = std::move(name);
    value_ = property_reference_value;
}

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

Member Function Documentation

d2Value()

PropertyDataType MaterialPropertyLib::Linear::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 142 of file Linear.cpp.

{
    return decltype(value_){};
}

References d2Value(), and MaterialPropertyLib::Property::value_.

Referenced by d2Value().

dValue()

PropertyDataType MaterialPropertyLib::Linear::dValue ( VariableArray const & variable_array, Variable const variable, ParameterLib::SpatialPosition const & pos, double const t, 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 103 of file Linear.cpp.

{
    auto const independent_variable = std::find_if(
        independent_variables_.begin(),
        independent_variables_.end(),
        [&variable](auto const& iv) -> bool
        {
            if (auto const* var_ptr = std::get_if<Variable>(&iv.type))
            {
                return *var_ptr == variable;
            }
            return false;
        });
 
    auto const zero = decltype(value_){};
    if (independent_variable == independent_variables_.end())
    {
        return zero;
    }
 
    auto const& iv = *independent_variable;
 
    double const x = iv.valueUnclamped(variable_array, pos, t);
 
    if (iv.min && x < *iv.min)
    {
        return zero;
    }
    if (iv.max && x > *iv.max)
    {
        return zero;
    }
 
    return std::get<double>(value_) * std::get<double>(iv.slope);
}

References independent_variables_.

value()

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

overridevirtual

This method computes the value of a property depending linearly on the value of the given primary variable.

Reimplemented from MaterialPropertyLib::Property.

Definition at line 79 of file Linear.cpp.

{
    auto calculate_linearized_ratio =
        [&variable_array, pos, t](double const initial_linearized_ratio,
                                  auto const& iv)
    {
        double const x = iv.valueClamped(variable_array, pos, t);
 
        return initial_linearized_ratio +
               std::get<double>(iv.slope) *
                   (x - std::get<double>(iv.reference_condition));
    };
 
    double const linearized_ratio_to_reference_value =
        std::accumulate(independent_variables_.begin(),
                        independent_variables_.end(),
                        1.0,
                        calculate_linearized_ratio);
 
    return std::get<double>(value_) * linearized_ratio_to_reference_value;
}

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

Member Data Documentation

independent_variables_

std::vector<IndependentVariable> const MaterialPropertyLib::Linear::independent_variables_

private

Definition at line 66 of file Linear.h.

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

---

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

• Linear.h
• Linear.cpp