Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Opm::FluidStateExplicitEnthalpyModule< Scalar, numPhases, Implementation > Class Template Reference

Module for the modular fluid state which stores the enthalpies explicitly. More...

#include <FluidStateEnthalpyModules.hpp>

Inheritance diagram for Opm::FluidStateExplicitEnthalpyModule< Scalar, numPhases, Implementation >:
Inheritance graph

Public Member Functions

 FluidStateExplicitEnthalpyModule ()
 
const Scalar & enthalpy (unsigned phaseIdx) const
 The specific enthalpy of a fluid phase [J/kg]. More...
 
Scalar internalEnergy (unsigned phaseIdx) const
 The specific internal energy of a fluid phase [J/kg]. More...
 
void setEnthalpy (unsigned phaseIdx, const Scalar &value)
 Set the specific enthalpy of a phase [J/kg]. More...
 
template<class FluidState >
void assign (const FluidState &fs)
 Retrieve all parameters from an arbitrary fluid state. More...
 
void checkDefined () const
 Make sure that all attributes are defined. More...
 

Protected Member Functions

const Implementation & asImp_ () const
 

Protected Attributes

Scalar enthalpy_ [numPhases]
 

Detailed Description

template<class Scalar, unsigned numPhases, class Implementation>
class Opm::FluidStateExplicitEnthalpyModule< Scalar, numPhases, Implementation >

Module for the modular fluid state which stores the enthalpies explicitly.

Constructor & Destructor Documentation

◆ FluidStateExplicitEnthalpyModule()

template<class Scalar , unsigned numPhases, class Implementation >
Opm::FluidStateExplicitEnthalpyModule< Scalar, numPhases, Implementation >::FluidStateExplicitEnthalpyModule ( )
inline

References Opm::FluidStateExplicitEnthalpyModule< Scalar, numPhases, Implementation >::enthalpy_, and Opm::Valgrind::SetUndefined().

Member Function Documentation

◆ asImp_()

template<class Scalar , unsigned numPhases, class Implementation >
const Implementation & Opm::FluidStateExplicitEnthalpyModule< Scalar, numPhases, Implementation >::asImp_ ( ) const
inlineprotected

Referenced by Opm::FluidStateExplicitEnthalpyModule< Scalar, numPhases, Implementation >::internalEnergy().

◆ assign()

template<class Scalar , unsigned numPhases, class Implementation >
template<class FluidState >
void Opm::FluidStateExplicitEnthalpyModule< Scalar, numPhases, Implementation >::assign ( const FluidState &  fs)
inline

Retrieve all parameters from an arbitrary fluid state.

References Opm::FluidStateExplicitEnthalpyModule< Scalar, numPhases, Implementation >::enthalpy_.

◆ checkDefined()

template<class Scalar , unsigned numPhases, class Implementation >
void Opm::FluidStateExplicitEnthalpyModule< Scalar, numPhases, Implementation >::checkDefined ( ) const
inline

Make sure that all attributes are defined.

This method does not do anything if the program is not run under valgrind. If it is, then valgrind will print an error message if some attributes of the object have not been properly defined.

References Opm::Valgrind::CheckDefined(), and Opm::FluidStateExplicitEnthalpyModule< Scalar, numPhases, Implementation >::enthalpy_.

◆ enthalpy()

template<class Scalar , unsigned numPhases, class Implementation >
const Scalar & Opm::FluidStateExplicitEnthalpyModule< Scalar, numPhases, Implementation >::enthalpy ( unsigned  phaseIdx) const
inline

The specific enthalpy of a fluid phase [J/kg].

References Opm::FluidStateExplicitEnthalpyModule< Scalar, numPhases, Implementation >::enthalpy_.

◆ internalEnergy()

template<class Scalar , unsigned numPhases, class Implementation >
Scalar Opm::FluidStateExplicitEnthalpyModule< Scalar, numPhases, Implementation >::internalEnergy ( unsigned  phaseIdx) const
inline

The specific internal energy of a fluid phase [J/kg].

References Opm::FluidStateExplicitEnthalpyModule< Scalar, numPhases, Implementation >::asImp_(), and Opm::FluidStateExplicitEnthalpyModule< Scalar, numPhases, Implementation >::enthalpy_.

◆ setEnthalpy()

template<class Scalar , unsigned numPhases, class Implementation >
void Opm::FluidStateExplicitEnthalpyModule< Scalar, numPhases, Implementation >::setEnthalpy ( unsigned  phaseIdx,
const Scalar &  value 
)
inline

Set the specific enthalpy of a phase [J/kg].

References Opm::FluidStateExplicitEnthalpyModule< Scalar, numPhases, Implementation >::enthalpy_.

Member Data Documentation

◆ enthalpy_

template<class Scalar , unsigned numPhases, class Implementation >
Scalar Opm::FluidStateExplicitEnthalpyModule< Scalar, numPhases, Implementation >::enthalpy_[numPhases]
protected

Referenced by Opm::FluidStateExplicitEnthalpyModule< Scalar, numPhases, Implementation >::assign(), Opm::FluidStateExplicitEnthalpyModule< Scalar, numPhases, Implementation >::checkDefined(), Opm::FluidStateExplicitEnthalpyModule< Scalar, numPhases, Implementation >::enthalpy(), Opm::FluidStateExplicitEnthalpyModule< Scalar, numPhases, Implementation >::FluidStateExplicitEnthalpyModule(), Opm::FluidStateExplicitEnthalpyModule< Scalar, numPhases, Implementation >::internalEnergy(), and Opm::FluidStateExplicitEnthalpyModule< Scalar, numPhases, Implementation >::setEnthalpy().

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