MaterialPropertyLib::WaterSaturationTemperatureIAPWSIF97Region4 Struct Reference

Detailed Description

Water saturation temperature model based on the IAPWS Industrial Formulation 1997 IF97-Rev

Definition at line 15 of file WaterSaturationTemperatureIAPWSIF97Region4.h.

#include <WaterSaturationTemperatureIAPWSIF97Region4.h>

Inheritance diagram for MaterialPropertyLib::WaterSaturationTemperatureIAPWSIF97Region4:

Collaboration diagram for MaterialPropertyLib::WaterSaturationTemperatureIAPWSIF97Region4:

Public Member Functions
	WaterSaturationTemperatureIAPWSIF97Region4 (std::string name)
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
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

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

WaterSaturationTemperatureIAPWSIF97Region4()

MaterialPropertyLib::WaterSaturationTemperatureIAPWSIF97Region4::WaterSaturationTemperatureIAPWSIF97Region4 ( std::string name )

inlineexplicit

Definition at line 17 of file WaterSaturationTemperatureIAPWSIF97Region4.h.

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

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

Member Function Documentation

checkScale()

void MaterialPropertyLib::WaterSaturationTemperatureIAPWSIF97Region4::checkScale ( ) const

inlineoverridevirtual

Reimplemented from MaterialPropertyLib::Property.

Definition at line 21 of file WaterSaturationTemperatureIAPWSIF97Region4.h.

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

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

dValue()

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

overridevirtual

Returns

The derivative of water saturation temperature.

Reimplemented from MaterialPropertyLib::Property.

Definition at line 24 of file WaterSaturationTemperatureIAPWSIF97Region4.cpp.

{
    OGS_FATAL(
        "WaterSaturationTemperatureIAPWSIF97Region4::dValue is not "
        "implemented.");
}

References OGS_FATAL.

value()

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

overridevirtual

Returns

The water saturation temperature.

Reimplemented from MaterialPropertyLib::Property.

Definition at line 11 of file WaterSaturationTemperatureIAPWSIF97Region4.cpp.

{
    double const p = variable_array.liquid_phase_pressure;
 
    IAPWSIF97Region4::checkPressureInRange(
        p, "the water saturation temperature in region4");
 
    return IAPWSIF97Region4::waterSaturationTemperature(p);
}

References MaterialPropertyLib::IAPWSIF97Region4::checkPressureInRange(), MaterialPropertyLib::VariableArray::liquid_phase_pressure, and MaterialPropertyLib::IAPWSIF97Region4::waterSaturationTemperature().

---

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

• WaterSaturationTemperatureIAPWSIF97Region4.h
• WaterSaturationTemperatureIAPWSIF97Region4.cpp