Opm::IncompPropertiesSinglePhase Class Reference

#include <IncompPropertiesSinglePhase.hpp>

Inheritance diagram for Opm::IncompPropertiesSinglePhase:
Inheritance graph

Public Member Functions

 IncompPropertiesSinglePhase (Opm::DeckConstPtr deck, Opm::EclipseStateConstPtr eclState, const UnstructuredGrid &grid)
 
virtual ~IncompPropertiesSinglePhase ()
 Destructor. More...
 
virtual int numDimensions () const
 
virtual int numCells () const
 
virtual const double * porosity () const
 
virtual const double * permeability () const
 
virtual int numPhases () const
 
virtual const double * viscosity () const
 
virtual const double * density () const
 
virtual const double * surfaceDensity () const
 
virtual void relperm (const int n, const double *s, const int *cells, double *kr, double *dkrds) const
 
virtual void capPress (const int n, const double *s, const int *cells, double *pc, double *dpcds) const
 
virtual void satRange (const int n, const int *cells, double *smin, double *smax) const
 

Detailed Description

Concrete class implementing the incompressible property interface for a simplified single-phase setting, reading all data and properties from eclipse deck input. The oil phase properties are used where applicable and available.

Supports variable number of spatial dimensions, called D. Supports a single phase only. In general, when arguments call for n values of some vector or matrix property, such as saturation, they shall always be ordered cellwise: [s^1_0 s^2_0 s^3_0 s^1_1 s^2_2 ... ] in which s^i_j denotes saturation of phase i in cell j.

Constructor & Destructor Documentation

Opm::IncompPropertiesSinglePhase::IncompPropertiesSinglePhase ( Opm::DeckConstPtr  deck,
Opm::EclipseStateConstPtr  eclState,
const UnstructuredGrid grid 
)

Initialize from deck and grid.

Parameters
deckDeck input parser
eclStateThe EclipseState (processed deck) produced by the opm-parser code
gridGrid to which property object applies, needed for the mapping from cell indices (typically from a processed grid) to logical cartesian indices consistent with the deck.
virtual Opm::IncompPropertiesSinglePhase::~IncompPropertiesSinglePhase ( )
virtual

Destructor.

Member Function Documentation

virtual void Opm::IncompPropertiesSinglePhase::capPress ( const int  n,
const double *  s,
const int *  cells,
double *  pc,
double *  dpcds 
) const
virtual

Capillary pressure. Always returns zero.

Parameters
[in]nNumber of data points.
[in]sArray of n saturation values.
[in]cellsArray of n cell indices to be associated with the s values.
[out]pcArray of n capillary pressure values, array must be valid before calling.
[out]dpcdsIf non-null: array of n derivative values, array must be valid before calling.

Implements Opm::IncompPropertiesInterface.

virtual const double* Opm::IncompPropertiesSinglePhase::density ( ) const
virtual

Densities of fluid at reservoir conditions.

Returns
Array of P (= 1) density values.

Implements Opm::IncompPropertiesInterface.

virtual int Opm::IncompPropertiesSinglePhase::numCells ( ) const
virtual
Returns
N, the number of cells.

Implements Opm::IncompPropertiesInterface.

virtual int Opm::IncompPropertiesSinglePhase::numDimensions ( ) const
virtual
Returns
D, the number of spatial dimensions.

Implements Opm::IncompPropertiesInterface.

virtual int Opm::IncompPropertiesSinglePhase::numPhases ( ) const
virtual
Returns
P, the number of phases (= 1).

Implements Opm::IncompPropertiesInterface.

virtual const double* Opm::IncompPropertiesSinglePhase::permeability ( ) const
virtual
Returns
Array of ND^2 permeability values. The D^2 permeability values for a cell are organized as a matrix, which is symmetric (so ordering does not matter).

Implements Opm::IncompPropertiesInterface.

virtual const double* Opm::IncompPropertiesSinglePhase::porosity ( ) const
virtual
Returns
Array of N porosity values.

Implements Opm::IncompPropertiesInterface.

virtual void Opm::IncompPropertiesSinglePhase::relperm ( const int  n,
const double *  s,
const int *  cells,
double *  kr,
double *  dkrds 
) const
virtual

Relative permeability. Always returns 1 (and 0 for derivatives).

Parameters
[in]nNumber of data points.
[in]sArray of n saturation values.
[in]cellsArray of n cell indices to be associated with the s values.
[out]krArray of n relperm values, array must be valid before calling.
[out]dkrdsIf non-null: array of n relperm derivative values, array must be valid before calling.

Implements Opm::IncompPropertiesInterface.

virtual void Opm::IncompPropertiesSinglePhase::satRange ( const int  n,
const int *  cells,
double *  smin,
double *  smax 
) const
virtual

Obtain the range of allowable saturation values. Saturation range is just the point 1 for this class

Parameters
[in]nNumber of data points.
[in]cellsArray of n cell indices.
[out]sminArray of n minimum s values, array must be valid before calling.
[out]smaxArray of n maximum s values, array must be valid before calling.

Implements Opm::IncompPropertiesInterface.

virtual const double* Opm::IncompPropertiesSinglePhase::surfaceDensity ( ) const
virtual

Densities of fluid phases at surface conditions.

Returns
Array of P (= 1) density values.

Implements Opm::IncompPropertiesInterface.

virtual const double* Opm::IncompPropertiesSinglePhase::viscosity ( ) const
virtual
Returns
Array of P (= 1) viscosity values.

Implements Opm::IncompPropertiesInterface.


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