Opm::FluidStateNullSaturationModule< Scalar > Class Template Reference

Module for the modular fluid state which does not the saturations but throws std::logic_error instead. More...

#include <FluidStateSaturationModules.hpp>

Public Member Functions

 FluidStateNullSaturationModule ()
 
const Scalar & saturation (unsigned) const
 The saturation of a fluid phase [-]. More...
 
template<class FluidState >
void assign (const FluidState &)
 Retrieve all parameters from an arbitrary fluid state. More...
 
void checkDefined () const
 Make sure that all attributes are defined. More...
 

Detailed Description

template<class Scalar>
class Opm::FluidStateNullSaturationModule< Scalar >

Module for the modular fluid state which does not the saturations but throws std::logic_error instead.

Constructor & Destructor Documentation

◆ FluidStateNullSaturationModule()

template<class Scalar >
Opm::FluidStateNullSaturationModule< Scalar >::FluidStateNullSaturationModule ( )
inline

Member Function Documentation

◆ assign()

template<class Scalar >
template<class FluidState >
void Opm::FluidStateNullSaturationModule< Scalar >::assign ( const FluidState &  )
inline

Retrieve all parameters from an arbitrary fluid state.

◆ checkDefined()

template<class Scalar >
void Opm::FluidStateNullSaturationModule< Scalar >::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.

◆ saturation()

template<class Scalar >
const Scalar & Opm::FluidStateNullSaturationModule< Scalar >::saturation ( unsigned  ) const
inline

The saturation of a fluid phase [-].


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