Opm::WelspecsWrapper Class Reference

#include <WelspecsWrapper.hpp>

Public Member Functions

 WelspecsWrapper (Opm::DeckKeywordConstPtr keyword)
 A wrapper class to provide convenient access to the data of an individual well as exposed by the 'WELSPECS' keyword. More...
 
int numWells () const
 Return the number if wells covered by the WELSPECS keyword. More...
 
const std::string wellName (int wellIdx) const
 Return the name of the well. More...
 
const std::string groupName (int wellIdx) const
 Return the name of the group this well belongs to. More...
 
int coordinateI (int wellIdx) const
 Return east-west grid coordinate of the well. More...
 
int coordinateJ (int wellIdx) const
 Return north-south grid coordinate of the well. More...
 
double referenceDepth (int wellIdx) const
 Return reference depth to which the bottom hole pressure of the well applies. More...
 
const std::string preferredPhase (int wellIdx) const
 Return the preferred fluid phase of this well. More...
 
double drainageRadius (int wellIdx) const
 Return effective drainage radius of the well. More...
 
const std::string inflowEquation (int wellIdx) const
 Return the inflow equation to be used for the well. More...
 
bool isShut (int wellIdx) const
 Returns true if the well is closed for fluids. More...
 
bool allowCrossflow (int wellIdx) const
 Returns true if crossflow should be allowed. More...
 
int pressureTableNumber (int wellIdx) const
 Returns the pressure number to be used for the wellbore fluids. More...
 
const std::string hydrostaticCalculation (int wellIdx) const
 Indicates the type of the calculation to be used for hydrostatic pressure. More...
 
int inPlaceRegionNumber (int wellIdx) const
 Indicates the "fluid in place" region table number used to calculate volumetric rates at reservoir conditions. More...
 
const std::string wellModel (int wellIdx) const
 Indicates well model to be used. More...
 

Constructor & Destructor Documentation

Opm::WelspecsWrapper::WelspecsWrapper ( Opm::DeckKeywordConstPtr  keyword)
inline

A wrapper class to provide convenient access to the data of an individual well as exposed by the 'WELSPECS' keyword.

Member Function Documentation

bool Opm::WelspecsWrapper::allowCrossflow ( int  wellIdx) const
inline

Returns true if crossflow should be allowed.

int Opm::WelspecsWrapper::coordinateI ( int  wellIdx) const
inline

Return east-west grid coordinate of the well.

int Opm::WelspecsWrapper::coordinateJ ( int  wellIdx) const
inline

Return north-south grid coordinate of the well.

double Opm::WelspecsWrapper::drainageRadius ( int  wellIdx) const
inline

Return effective drainage radius of the well.

const std::string Opm::WelspecsWrapper::groupName ( int  wellIdx) const
inline

Return the name of the group this well belongs to.

const std::string Opm::WelspecsWrapper::hydrostaticCalculation ( int  wellIdx) const
inline

Indicates the type of the calculation to be used for hydrostatic pressure.

This is one of:

  • "SEG": segmented density calculation
  • "AVG": averaged density calculation
const std::string Opm::WelspecsWrapper::inflowEquation ( int  wellIdx) const
inline

Return the inflow equation to be used for the well.

This is one of "STD", "NO", "R-G", "YES", "P-P" or "GPP".

int Opm::WelspecsWrapper::inPlaceRegionNumber ( int  wellIdx) const
inline

Indicates the "fluid in place" region table number used to calculate volumetric rates at reservoir conditions.

bool Opm::WelspecsWrapper::isShut ( int  wellIdx) const
inline

Returns true if the well is closed for fluids.

int Opm::WelspecsWrapper::numWells ( ) const
inline

Return the number if wells covered by the WELSPECS keyword.

const std::string Opm::WelspecsWrapper::preferredPhase ( int  wellIdx) const
inline

Return the preferred fluid phase of this well.

(whatever this means.) This method returns a string that contains one of "OIL", "WATER", "GAS", or "LIQ".

int Opm::WelspecsWrapper::pressureTableNumber ( int  wellIdx) const
inline

Returns the pressure number to be used for the wellbore fluids.

double Opm::WelspecsWrapper::referenceDepth ( int  wellIdx) const
inline

Return reference depth to which the bottom hole pressure of the well applies.

const std::string Opm::WelspecsWrapper::wellModel ( int  wellIdx) const
inline

Indicates well model to be used.

This is one of:

  • "STD": The standard well model (Peaceman??)
  • "HMIW": High Mobility Injection Wells
const std::string Opm::WelspecsWrapper::wellName ( int  wellIdx) const
inline

Return the name of the well.


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