Detailed Description

Density function for ideal gases.

This property must be either a phase or a component property, it computes the density of an ideal gas as function of phase pressure and temperature.

Definition at line 29 of file IdealGasLaw.h.

#include <IdealGasLaw.h>

Inheritance diagram for MaterialPropertyLib::IdealGasLaw:

[legend]

Collaboration diagram for MaterialPropertyLib::IdealGasLaw:

[legend]

Public Member Functions
	IdealGasLaw (std::string name)

void	checkScale () const override

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 variable1, Variable const variable2, ParameterLib::SpatialPosition const &, double const, double const) 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

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

◆ IdealGasLaw()

MaterialPropertyLib::IdealGasLaw::IdealGasLaw ( std::string name )

explicit

Definition at line 21 of file IdealGasLaw.cpp.

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

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

Member Function Documentation

◆ checkScale()

void MaterialPropertyLib::IdealGasLaw::checkScale ( ) const

inlineoverridevirtual

Reimplemented from MaterialPropertyLib::Property.

Definition at line 34 of file IdealGasLaw.h.

    {
        if (!(std::holds_alternative<Phase*>(scale_) ||
              std::holds_alternative<Component*>(scale_)))
        {
            OGS_FATAL(
                "The property 'IdealGasLaw' is implemented on the "
                "'phase' and 'component' scales only.");
        }
    }

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

◆ d2Value()

PropertyDataType MaterialPropertyLib::IdealGasLaw::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 72 of file IdealGasLaw.cpp.

{
    const double gas_constant = MaterialLib::PhysicalConstant::IdealGasConstant;
    const double pressure = variable_array.gas_phase_pressure;
    const double temperature = variable_array.temperature;
    const double molar_mass = variable_array.molar_mass;
    // todo: add molar mass derivatives
 
    if ((variable1 == Variable::gas_phase_pressure) &&
        (variable2 == Variable::gas_phase_pressure))
    {
        // d2rho_dp2
        // extend to take pressure-dependent molar mass into account
        return 0.;
    }
    if ((variable1 == Variable::temperature) &&
        (variable2 == Variable::temperature))
    {
        // d2rho_dT2
        // extend to take temperature-dependent molar mass into account
        return 2. * molar_mass * pressure / gas_constant / temperature /
               temperature / temperature;
    }
    if (((variable1 == Variable::gas_phase_pressure) &&
         (variable2 == Variable::temperature)) ||
        ((variable1 == Variable::temperature) &&
         (variable2 == Variable::gas_phase_pressure)))
    {
        // d2rho_dpdT or d2rho_dTdp
        // extend to take pressure-temperature-dependent molar mass into account
        return -molar_mass / gas_constant / temperature / temperature;
    }
 
    OGS_FATAL(
        "IdealGasLaw::d2Value is implemented for derivatives with respect to "
        "phase pressure and temperature only.");
 
    return 0.;
}

References MaterialPropertyLib::gas_phase_pressure, MaterialPropertyLib::VariableArray::gas_phase_pressure, MaterialLib::PhysicalConstant::IdealGasConstant, MaterialPropertyLib::molar_mass, MaterialPropertyLib::VariableArray::molar_mass, OGS_FATAL, MaterialPropertyLib::temperature, and MaterialPropertyLib::VariableArray::temperature.

◆ dValue()

PropertyDataType MaterialPropertyLib::IdealGasLaw::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 41 of file IdealGasLaw.cpp.

{
    const double gas_constant = MaterialLib::PhysicalConstant::IdealGasConstant;
    const double pressure = variable_array.gas_phase_pressure;
    const double temperature = variable_array.temperature;
    const double molar_mass = variable_array.molar_mass;
    // todo: add molar mass derivatives
 
    if (variable == Variable::temperature)
    {
        // extend to take temperature-dependent molar mass into account
        return -pressure * molar_mass / gas_constant / temperature /
               temperature;
    }
 
    if (variable == Variable::gas_phase_pressure)
    {
        // extend to take pressure-dependent molar mass into account
        return molar_mass / gas_constant / temperature;
    }
 
    OGS_FATAL(
        "IdealGasLaw::dValue is implemented for derivatives with respect to "
        "phase pressure or temperature only.");
 
    return 0.;
}

References MaterialPropertyLib::gas_phase_pressure, MaterialPropertyLib::VariableArray::gas_phase_pressure, MaterialLib::PhysicalConstant::IdealGasConstant, MaterialPropertyLib::molar_mass, MaterialPropertyLib::VariableArray::molar_mass, OGS_FATAL, MaterialPropertyLib::temperature, and MaterialPropertyLib::VariableArray::temperature.

◆ value()

PropertyDataType MaterialPropertyLib::IdealGasLaw::value	(	VariableArray const &	variable_array,
		ParameterLib::SpatialPosition const &	,
		double const	,
		double const	) const

overridevirtual

Those methods override the base class implementations and actually compute and set the property values_ and dValues_.

Reimplemented from MaterialPropertyLib::Property.

Definition at line 26 of file IdealGasLaw.cpp.

{
    const double gas_constant = MaterialLib::PhysicalConstant::IdealGasConstant;
    const double pressure = variable_array.gas_phase_pressure;
    const double temperature = variable_array.temperature;
    const double molar_mass = variable_array.molar_mass;
 
    const double density = pressure * molar_mass / gas_constant / temperature;
 
    return density;
}

References MaterialPropertyLib::density, MaterialPropertyLib::VariableArray::gas_phase_pressure, MaterialLib::PhysicalConstant::IdealGasConstant, MaterialPropertyLib::molar_mass, MaterialPropertyLib::VariableArray::molar_mass, MaterialPropertyLib::temperature, and MaterialPropertyLib::VariableArray::temperature.

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

MaterialLib/MPL/Properties/IdealGasLaw.h
MaterialLib/MPL/Properties/IdealGasLaw.cpp

Detailed Description

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ IdealGasLaw()

Member Function Documentation

◆ checkScale()

◆ d2Value()

◆ dValue()

◆ value()