Opm::WconprodWrapper Class Reference

#include <WconprodWrapper.hpp>

Public Member Functions

 WconprodWrapper (Opm::DeckKeywordConstPtr keyword)
 A wrapper class to provide convenient access to the data of the 'WCONPROD' keyword. More...
 
int numWells () const
 Return the number of injection wells. More...
 
std::string wellName (int wellIdx) const
 Return the human-readable name of the well with a given index. More...
 
std::string wellStatus (int wellIdx) const
 Return the connection type of a well. More...
 
std::string controlMode (int wellIdx) const
 Return the control mode of a well. More...
 
double oilTargetRate (int wellIdx) const
 The upper limit of the surface oil rate. More...
 
double waterTargetRate (int wellIdx) const
 The upper limit of the surface water rate. More...
 
double gasTargetRate (int wellIdx) const
 The upper limit of the surface gas rate. More...
 
double liquidTargetRate (int wellIdx) const
 The upper rate limit of the liquids at the surface. More...
 
double reservoirTargetRate (int wellIdx) const
 The upper limit of the fluid volumes at the reservoir. More...
 
double bottomHoleTargetPressure (int wellIdx) const
 The lower limit of the bottom hole pressure. More...
 
double topHoleTargetPressure (int wellIdx) const
 The lower limit of the top hole pressure. More...
 
int vfpTableIndex (int wellIdx) const
 The index of the well's VFP table. More...
 
double artificialLiftQuantity (int wellIdx) const
 The artificial lift quantity of the well. More...
 
double wetGasTargetRate (int wellIdx) const
 The upper limit of the produced wet gas. More...
 
double molarTargetRate (int wellIdx) const
 The upper limit of the produced molar rate. More...
 
double steamTargetRate (int wellIdx) const
 The upper limit for the rate of the produced steam. More...
 
double pressureOffset (int wellIdx) const
 The pressure offset used for saturation pressure control. More...
 
double temperatureOffset (int wellIdx) const
 The temperature offset used for saturation temperature control. More...
 
double caloricTargetRate (int wellIdx) const
 The upper limit of the caloric rate. More...
 
int lincomIndex (int wellIdx) const
 The index of the linearly combined rate specified by the LINCOM keyword. More...
 
double nglTargetRate (int wellIdx) const
 The upper limit of the NGL rate. More...
 

Constructor & Destructor Documentation

Opm::WconprodWrapper::WconprodWrapper ( Opm::DeckKeywordConstPtr  keyword)
inline

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

Member Function Documentation

double Opm::WconprodWrapper::artificialLiftQuantity ( int  wellIdx) const
inline

The artificial lift quantity of the well.

double Opm::WconprodWrapper::bottomHoleTargetPressure ( int  wellIdx) const
inline

The lower limit of the bottom hole pressure.

double Opm::WconprodWrapper::caloricTargetRate ( int  wellIdx) const
inline

The upper limit of the caloric rate.

std::string Opm::WconprodWrapper::controlMode ( int  wellIdx) const
inline

Return the control mode of a well.

This is one of:

  • ORAT (surface oil rate)
  • WRAT (surface water rate)
  • GRAT (surface gas rate)
  • LRAT (surface liquid rate)
  • CRAT (linear combination of the surface rates)
  • RESV (reservoir fluid volume rate)
  • BHP (bottom-hole pressure)
  • THP (top-hole pressure)
  • WGRA (wet-gas rate)
  • TMRA (total molar rate)
  • STRA (steam volume rate)
  • SATP (water saturation pressure)
  • SATT (water temperature)
  • CVAL (caloric rate)
  • NGL (NGL rate, WTF?)
  • GRUP (group of the well controls the regime)
  • ' ' (undefined, default)
double Opm::WconprodWrapper::gasTargetRate ( int  wellIdx) const
inline

The upper limit of the surface gas rate.

int Opm::WconprodWrapper::lincomIndex ( int  wellIdx) const
inline

The index of the linearly combined rate specified by the LINCOM keyword.

double Opm::WconprodWrapper::liquidTargetRate ( int  wellIdx) const
inline

The upper rate limit of the liquids at the surface.

double Opm::WconprodWrapper::molarTargetRate ( int  wellIdx) const
inline

The upper limit of the produced molar rate.

double Opm::WconprodWrapper::nglTargetRate ( int  wellIdx) const
inline

The upper limit of the NGL rate.

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

Return the number of injection wells.

double Opm::WconprodWrapper::oilTargetRate ( int  wellIdx) const
inline

The upper limit of the surface oil rate.

double Opm::WconprodWrapper::pressureOffset ( int  wellIdx) const
inline

The pressure offset used for saturation pressure control.

double Opm::WconprodWrapper::reservoirTargetRate ( int  wellIdx) const
inline

The upper limit of the fluid volumes at the reservoir.

double Opm::WconprodWrapper::steamTargetRate ( int  wellIdx) const
inline

The upper limit for the rate of the produced steam.

double Opm::WconprodWrapper::temperatureOffset ( int  wellIdx) const
inline

The temperature offset used for saturation temperature control.

double Opm::WconprodWrapper::topHoleTargetPressure ( int  wellIdx) const
inline

The lower limit of the top hole pressure.

int Opm::WconprodWrapper::vfpTableIndex ( int  wellIdx) const
inline

The index of the well's VFP table.

double Opm::WconprodWrapper::waterTargetRate ( int  wellIdx) const
inline

The upper limit of the surface water rate.

std::string Opm::WconprodWrapper::wellName ( int  wellIdx) const
inline

Return the human-readable name of the well with a given index.

std::string Opm::WconprodWrapper::wellStatus ( int  wellIdx) const
inline

Return the connection type of a well.

This is one of:

  • OPEN
  • STOP
  • SHUT
  • AUTO
double Opm::WconprodWrapper::wetGasTargetRate ( int  wellIdx) const
inline

The upper limit of the produced wet gas.


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