Opm::BlackoilPvtProperties Class Reference

#include <BlackoilPvtProperties.hpp>

Inheritance diagram for Opm::BlackoilPvtProperties:
Inheritance graph

Public Types

enum  PhaseIndex { Aqua = 0, Liquid = 1, Vapour = 2 }
 

Public Member Functions

 BlackoilPvtProperties ()
 Default constructor. More...
 
void init (Opm::DeckConstPtr deck, Opm::EclipseStateConstPtr eclipseState, int samples)
 
PhaseUsage phaseUsage () const
 
int numPhases () const
 Number of active phases. More...
 
const int * phaseUsed () const
 
const int * phasePosition () const
 
const double * surfaceDensities (int regionIdx=0) const
 
void mu (const int n, const int *pvtTableIdx, const double *p, const double *T, const double *z, double *output_mu) const
 Viscosity as a function of p, T and z. More...
 
void B (const int n, const int *pvtTableIdx, const double *p, const double *T, const double *z, double *output_B) const
 Formation volume factor as a function of p, T and z. More...
 
void dBdp (const int n, const int *pvtTableIdx, const double *p, const double *T, const double *z, double *output_B, double *output_dBdp) const
 Formation volume factor and p-derivative as functions of p, T and z. More...
 
void R (const int n, const int *pvtTableIdx, const double *p, const double *z, double *output_R) const
 Solution factor as a function of p and z. More...
 
void dRdp (const int n, const int *pvtTableIdx, const double *p, const double *z, double *output_R, double *output_dRdp) const
 Solution factor and p-derivative as functions of p and z. More...
 

Static Public Attributes

static const int MaxNumPhases = 3
 

Detailed Description

Class collecting the pvt properties for all active phases. For all the methods, the following apply:

  • p and z are expected to be of size n and n*num_phases, respectively.
  • pvtTableIdx specifies the PVT table to be used for each data point and is thus expected to be an array of size n
  • Output arrays shall be of size n*num_phases, and must be valid before calling the method. NOTE: The difference between this interface and the one defined by PvtInterface is that this collects all phases' properties, and therefore the output arrays are of size n*num_phases as opposed to size n in PvtInterface.

Member Enumeration Documentation

Enumerator
Aqua 
Liquid 
Vapour 

Constructor & Destructor Documentation

Opm::BlackoilPvtProperties::BlackoilPvtProperties ( )

Default constructor.

Member Function Documentation

void Opm::BlackoilPvtProperties::B ( const int  n,
const int *  pvtTableIdx,
const double *  p,
const double *  T,
const double *  z,
double *  output_B 
) const

Formation volume factor as a function of p, T and z.

void Opm::BlackoilPvtProperties::dBdp ( const int  n,
const int *  pvtTableIdx,
const double *  p,
const double *  T,
const double *  z,
double *  output_B,
double *  output_dBdp 
) const

Formation volume factor and p-derivative as functions of p, T and z.

void Opm::BlackoilPvtProperties::dRdp ( const int  n,
const int *  pvtTableIdx,
const double *  p,
const double *  z,
double *  output_R,
double *  output_dRdp 
) const

Solution factor and p-derivative as functions of p and z.

void Opm::BlackoilPvtProperties::init ( Opm::DeckConstPtr  deck,
Opm::EclipseStateConstPtr  eclipseState,
int  samples 
)

Initialize from deck.

Parameters
deckAn input deck from the opm-parser module.
void Opm::BlackoilPvtProperties::mu ( const int  n,
const int *  pvtTableIdx,
const double *  p,
const double *  T,
const double *  z,
double *  output_mu 
) const

Viscosity as a function of p, T and z.

int Opm::BlackoilPvtProperties::numPhases ( ) const

Number of active phases.

const int* Opm::BlackoilPvtProperties::phasePosition ( ) const

Positions of canonical phases in arrays of phase properties (saturations etc.).

Returns
Array of size MaxNumPhases
PhaseUsage Opm::BlackoilPvtProperties::phaseUsage ( ) const
Returns
Object describing the active phases.
const int* Opm::BlackoilPvtProperties::phaseUsed ( ) const

For each canonical phase, indicates if it is active or not (boolean usage of int).

Returns
Array of size MaxNumPhases
void Opm::BlackoilPvtProperties::R ( const int  n,
const int *  pvtTableIdx,
const double *  p,
const double *  z,
double *  output_R 
) const

Solution factor as a function of p and z.

const double* Opm::BlackoilPvtProperties::surfaceDensities ( int  regionIdx = 0) const

Densities of stock components at surface conditions.

Returns
Array of size numPhases().

Member Data Documentation


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