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

#include <FluidStateSaturationModules.hpp>

Inheritance diagram for Opm::FluidStateExplicitSaturationModule< Scalar, numPhases, Implementation >:

Public Member Functions
	FluidStateExplicitSaturationModule ()

const Scalar &	saturation (unsigned phaseIdx) const
	The saturation of a fluid phase [-]. More...

void	setSaturation (unsigned phaseIdx, const Scalar &value)
	Set the saturation 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	saturation_ [numPhases]

Detailed Description

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

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

Constructor & Destructor Documentation

◆ FluidStateExplicitSaturationModule()

template<class Scalar , unsigned numPhases, class Implementation >

Opm::FluidStateExplicitSaturationModule< Scalar, numPhases, Implementation >::FluidStateExplicitSaturationModule ( )

inline

References Opm::FluidStateExplicitSaturationModule< Scalar, numPhases, Implementation >::saturation_, and Opm::Valgrind::SetUndefined().

Member Function Documentation

◆ assign()

template<class Scalar , unsigned numPhases, class Implementation >

template<class FluidState >

void Opm::FluidStateExplicitSaturationModule< Scalar, numPhases, Implementation >::assign ( const FluidState & fs )

inline

Retrieve all parameters from an arbitrary fluid state.

References Opm::FluidStateExplicitSaturationModule< Scalar, numPhases, Implementation >::saturation_.

◆ checkDefined()

template<class Scalar , unsigned numPhases, class Implementation >

void Opm::FluidStateExplicitSaturationModule< 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::FluidStateExplicitSaturationModule< Scalar, numPhases, Implementation >::saturation_.