Opm::ExplicitArraysFluidState Class Reference

This is a fluid state which translates global arrays and translates them to a subset of the fluid state API. More...

#include <ExplicitArraysFluidState.hpp>

Public Types
enum	{ numPhases = BlackoilPhases::MaxNumPhases }
typedef double	Scalar

Public Member Functions
	ExplicitArraysFluidState (const PhaseUsage &phaseUsage)
void	setIndex (unsigned arrayIdx)
	Sets the currently used array index. More...
void	setSaturationArray (const double *saturations)
	Set the array containing the phase saturations. More...
Scalar	saturation (int phaseIdx) const
	Returns the saturation of a phase for the current cell index. More...

Detailed Description

This is a fluid state which translates global arrays and translates them to a subset of the fluid state API.

This class is similar to Opm::BlackoilStateToFluidState.

Member Typedef Documentation

typedef double Opm::ExplicitArraysFluidState::Scalar

Member Enumeration Documentation

anonymous enum

Enumerator
numPhases

Constructor & Destructor Documentation

Opm::ExplicitArraysFluidState::ExplicitArraysFluidState ( const PhaseUsage &  phaseUsage )

inlineexplicit

Member Function Documentation

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

inline

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

void Opm::ExplicitArraysFluidState::setIndex ( unsigned  arrayIdx )

inline

Sets the currently used array index.

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

References Opm::BlackoilPhases::MaxNumPhases, Opm::PhaseUsage::num_phases, Opm::PhaseUsage::phase_pos, and Opm::PhaseUsage::phase_used.

void Opm::ExplicitArraysFluidState::setSaturationArray ( const double *  saturations )

inline

Set the array containing the phase saturations.

This array is supposed to be of size numPhases*size and is not allowed to be deleted while the ExplicitArraysFluidState object is alive. This class assumes that the saturations of all phase saturations for a point are consequtive, i.e., in the array the saturations cycle fastest.

---

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

• ExplicitArraysFluidState.hpp