Opm::EquilWrapper Class Reference

#include <EquilWrapper.hpp>

Public Member Functions

 EquilWrapper (Opm::DeckKeywordConstPtr keyword)
 A wrapper class to provide convenient access to the data of the 'EQUIL' keyword. More...
 
int numRegions () const
 Return the number of regions used for initialization. More...
 
double datumDepth (int regionIdx) const
 The reference depth. More...
 
double datumDepthPressure (int regionIdx) const
 The pressure at reference depth. More...
 
double waterOilContactDepth (int regionIdx) const
 The depth of the water-oil contact. More...
 
double waterOilContactCapillaryPressure (int regionIdx) const
 The capillary pressure at the water-oil contact. More...
 
double gasOilContactDepth (int regionIdx) const
 The depth of the gas-oil contact. More...
 
double gasOilContactCapillaryPressure (int regionIdx) const
 The capillary pressure at the gas-oil contact. More...
 
int liveOilInitProceedure (int regionIdx) const
 Integer number specifying the initialization proceedure for live oil. More...
 
int wetGasInitProceedure (int regionIdx) const
 Integer number specifying the initialization proceedure for wet gas. More...
 
int initializationTargetAccuracy (int regionIdx) const
 Integer number specifying the desired accuracy of the initialization. More...
 
int compositionalInitializationProceedure (int regionIdx) const
 Integer number specifying the type of the initialization. More...
 
bool useSaturationPressure (int regionIdx) const
 Use the saturation pressure at the of the gas for the gas-oil contact. More...
 

Constructor & Destructor Documentation

Opm::EquilWrapper::EquilWrapper ( Opm::DeckKeywordConstPtr  keyword)
inline

A wrapper class to provide convenient access to the data of the 'EQUIL' keyword.

Member Function Documentation

int Opm::EquilWrapper::compositionalInitializationProceedure ( int  regionIdx) const
inline

Integer number specifying the type of the initialization.

This is only relevant for fully-compositional models

double Opm::EquilWrapper::datumDepth ( int  regionIdx) const
inline

The reference depth.

double Opm::EquilWrapper::datumDepthPressure ( int  regionIdx) const
inline

The pressure at reference depth.

double Opm::EquilWrapper::gasOilContactCapillaryPressure ( int  regionIdx) const
inline

The capillary pressure at the gas-oil contact.

double Opm::EquilWrapper::gasOilContactDepth ( int  regionIdx) const
inline

The depth of the gas-oil contact.

int Opm::EquilWrapper::initializationTargetAccuracy ( int  regionIdx) const
inline

Integer number specifying the desired accuracy of the initialization.

int Opm::EquilWrapper::liveOilInitProceedure ( int  regionIdx) const
inline

Integer number specifying the initialization proceedure for live oil.

Much fun with eclipse...

int Opm::EquilWrapper::numRegions ( ) const
inline

Return the number of regions used for initialization.

bool Opm::EquilWrapper::useSaturationPressure ( int  regionIdx) const
inline

Use the saturation pressure at the of the gas for the gas-oil contact.

This is only relevant for fully-compositional models and if the initialization proceedure is either '2' or '3'.

double Opm::EquilWrapper::waterOilContactCapillaryPressure ( int  regionIdx) const
inline

The capillary pressure at the water-oil contact.

double Opm::EquilWrapper::waterOilContactDepth ( int  regionIdx) const
inline

The depth of the water-oil contact.

int Opm::EquilWrapper::wetGasInitProceedure ( int  regionIdx) const
inline

Integer number specifying the initialization proceedure for wet gas.


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