Opm::FluidStateEquilibriumTemperatureModule< Scalar, numPhases, Implementation > Class Template Reference

Module for the modular fluid state which stores the temperatures explicitly and assumes thermal equilibrium. More...

#include <FluidStateTemperatureModules.hpp>

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

Public Member Functions

 FluidStateEquilibriumTemperatureModule ()
 
Scalar temperature (unsigned) const
 The temperature of a fluid phase [-]. More...
 
void setTemperature (Scalar value)
 Set the temperature of a phase [-]. 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 Attributes

Scalar temperature_
 

Detailed Description

template<class Scalar, int numPhases, class Implementation>
class Opm::FluidStateEquilibriumTemperatureModule< Scalar, numPhases, Implementation >

Module for the modular fluid state which stores the temperatures explicitly and assumes thermal equilibrium.

Constructor & Destructor Documentation

template<class Scalar, int numPhases, class Implementation>
Opm::FluidStateEquilibriumTemperatureModule< Scalar, numPhases, Implementation >::FluidStateEquilibriumTemperatureModule ( )
inline

Member Function Documentation

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

Retrieve all parameters from an arbitrary fluid state.

template<class Scalar, int numPhases, class Implementation>
void Opm::FluidStateEquilibriumTemperatureModule< 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.

template<class Scalar, int numPhases, class Implementation>
void Opm::FluidStateEquilibriumTemperatureModule< Scalar, numPhases, Implementation >::setTemperature ( Scalar  value)
inline

Set the temperature of a phase [-].

template<class Scalar, int numPhases, class Implementation>
Scalar Opm::FluidStateEquilibriumTemperatureModule< Scalar, numPhases, Implementation >::temperature ( unsigned  ) const
inline

The temperature of a fluid phase [-].

Member Data Documentation


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