Opm::BlackoilStateToFluidState Class Reference

This is an light weight "impedance adaption" class with a well defined API for saturation and PVT functions. More...

#include <BlackoilStateToFluidState.hpp>

Public Types
enum	{ numPhases = 3 }
enum	{ numComponents = 3 }
typedef double	Scalar

Public Member Functions
	BlackoilStateToFluidState (const BlackoilState &blackoilState)
	Create a BlackoilState to Fluid state wrapper object. More...
void	setCurrentCellIndex (unsigned cellIdx)
	Sets the index of the currently used cell. More...
Scalar	saturation (int phaseIdx) const
	Returns the saturation of a phase for the current cell index. More...
Scalar	temperature (int phaseIdx) const
	Returns the temperature [K] of a phase for the current cell index. More...

Detailed Description

This is an light weight "impedance adaption" class with a well defined API for saturation and PVT functions.

It uses a stripped down version of opm-material's FluidState API and takes an Opm::BlackoilState plus a cell index.

Note that this class requires that is underlying BlackoilState must valid for at least as long as an object of BlackoilStateToFluidState is used.

Member Typedef Documentation

typedef double Opm::BlackoilStateToFluidState::Scalar

Member Enumeration Documentation

anonymous enum

Enumerator
numPhases

anonymous enum

Enumerator
numComponents

Constructor & Destructor Documentation

Opm::BlackoilStateToFluidState::BlackoilStateToFluidState ( const BlackoilState &  blackoilState )

inline

Create a BlackoilState to Fluid state wrapper object.

Note that this class requires that is underlying BlackoilState must valid for at least as long as an object of BlackoilStateToFluidState is used.

References numPhases, and Opm::SimulatorState::numPhases().

Member Function Documentation

Scalar Opm::BlackoilStateToFluidState::saturation ( int  phaseIdx ) const

inline

Returns the saturation of a phase for the current cell index.

References numPhases, and Opm::SimulatorState::saturation().

void Opm::BlackoilStateToFluidState::setCurrentCellIndex ( unsigned  cellIdx )

inline

Sets the index of the currently used cell.

After calling this, the values returned by the other methods are specific for this cell.

Scalar Opm::BlackoilStateToFluidState::temperature ( int  phaseIdx ) const

inline

Returns the temperature [K] of a phase for the current cell index.

References Opm::SimulatorState::temperature().

---

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

• BlackoilStateToFluidState.hpp