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.
 
Scalar temperature (int phaseIdx) const
 Returns the temperature [K] of a phase for the current cell index.
 

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.

Constructor & Destructor Documentation

◆ BlackoilStateToFluidState()

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.

Member Function Documentation

◆ setCurrentCellIndex()

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.


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