Opm::GconprodWrapper Class Reference

#include <GconprodWrapper.hpp>

Public Member Functions
	GconprodWrapper (Opm::DeckKeywordConstPtr keyword)
	A wrapper class to provide convenient access to the data of the 'GCONPROD' keyword. More...
int	numGroups () const
	Return the number of prodction well groups. More...
std::string	groupName (int wellGroupIdx) const
	Return the human-readable name of the well group with a given index. More...
std::string	controlMode (int wellGroupIdx) const
	Return the what should be controlled for a given well. More...
double	surfaceOilTargetRate (int wellGroupIdx) const
	Return the target for the volumetric surface oil rate of a well group. More...
double	surfaceWaterTargetRate (int wellGroupIdx) const
	Return the target for the volumetric surface water rate of a well group. More...
double	surfaceGasTargetRate (int wellGroupIdx) const
	Return the target for the volumetric surface gas rate of a well group. More...
double	surfaceLiquidTargetRate (int wellGroupIdx) const
	Return the target for the volumetric surface liquid rate of a well group. More...
std::string	oilExceedanceReaction (int wellGroupIdx) const
	Return the procedure which is taken if the target rates are exceeded. More...
bool	isUnconstraint (int wellGroupIdx) const
	Returns whether a group is unconstraint so that it be used to hit the target of a higher-level group. More...
double	productionShareTarget (int wellGroupIdx) const
	The target for the group's share of the next higher-level group's total production rate. More...
std::string	productionShareType (int wellGroupIdx) const
	The kind of control which the next higher-level group wants. More...
std::string	waterExceedanceReaction (int wellGroupIdx) const
	Return the procedure which is taken if the water target rate is exceeded. More...
std::string	gasExceedanceReaction (int wellGroupIdx) const
	Return the procedure which is taken if the gas target rate is exceeded. More...
std::string	liquidExceedanceReaction (int wellGroupIdx) const
	Return the procedure which is taken if the liquid target rate is exceeded. More...
double	reservoirTargetRate (int wellGroupIdx) const
	Return target rate of all fluids at reservoir conditions. More...
double	reservoirBalanceTarget (int wellGroupIdx) const
	Return balancing fraction of fluids produced at reservoir conditions. More...
double	wetGasTargetRate (int wellGroupIdx) const
	Return target rate for wet-gas. More...
double	caloricTargetRate (int wellGroupIdx) const
	Return caloric target rate. More...
double	surfaceGasBalanceTarget (int wellGroupIdx) const
	Return balancing fraction of gas at surface conditions. More...
double	surfaceWaterBalanceTarget (int wellGroupIdx) const
	Return balancing fraction of water at surface conditions. More...
int	lcomIndex (int wellGroupIdx) const
	Return index of the linearly combined rate specified using the LCOM keyword. More...
std::string	lcomExceedanceReaction (int wellGroupIdx) const
	Return the procedure which is taken if the linearly combined rate is exceeded. More...

Constructor & Destructor Documentation

Opm::GconprodWrapper::GconprodWrapper ( Opm::DeckKeywordConstPtr  keyword )

inline

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

Member Function Documentation

double Opm::GconprodWrapper::caloricTargetRate ( int  wellGroupIdx ) const

inline

Return caloric target rate.

std::string Opm::GconprodWrapper::controlMode ( int  wellGroupIdx ) const

inline

Return the what should be controlled for a given well.

This is one of:

• NONE
• ORAT
• WRAT
• GRAT
• LRAT
• CRAT
• RESV
• PRBL
• WGRA
• CVAL
• PBGS
• PBWS
• FLD

std::string Opm::GconprodWrapper::gasExceedanceReaction ( int  wellGroupIdx ) const

inline

Return the procedure which is taken if the gas target rate is exceeded.

std::string Opm::GconprodWrapper::groupName ( int  wellGroupIdx ) const

inline

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

bool Opm::GconprodWrapper::isUnconstraint ( int  wellGroupIdx ) const

inline

Returns whether a group is unconstraint so that it be used to hit the target of a higher-level group.

std::string Opm::GconprodWrapper::lcomExceedanceReaction ( int  wellGroupIdx ) const

inline

Return the procedure which is taken if the linearly combined rate is exceeded.

int Opm::GconprodWrapper::lcomIndex ( int  wellGroupIdx ) const

inline

Return index of the linearly combined rate specified using the LCOM keyword.

std::string Opm::GconprodWrapper::liquidExceedanceReaction ( int  wellGroupIdx ) const

inline

Return the procedure which is taken if the liquid target rate is exceeded.

int Opm::GconprodWrapper::numGroups ( ) const

inline

Return the number of prodction well groups.

std::string Opm::GconprodWrapper::oilExceedanceReaction ( int  wellGroupIdx ) const

inline

Return the procedure which is taken if the target rates are exceeded.

This is one of:

• NONE
• CON
• +CON
• WELL
• PLUG
• RATE

double Opm::GconprodWrapper::productionShareTarget ( int  wellGroupIdx ) const

inline

The target for the group's share of the next higher-level group's total production rate.

std::string Opm::GconprodWrapper::productionShareType ( int  wellGroupIdx ) const

inline

The kind of control which the next higher-level group wants.

This is one of:

• OIL
• WAT
• GAS
• LIQ
• COMB
• RES
• WGA
• CVAL
• INJV
• POTN
• FORM
• ' '

double Opm::GconprodWrapper::reservoirBalanceTarget ( int  wellGroupIdx ) const

inline

Return balancing fraction of fluids produced at reservoir conditions.

double Opm::GconprodWrapper::reservoirTargetRate ( int  wellGroupIdx ) const

inline

Return target rate of all fluids at reservoir conditions.

double Opm::GconprodWrapper::surfaceGasBalanceTarget ( int  wellGroupIdx ) const

inline

Return balancing fraction of gas at surface conditions.

double Opm::GconprodWrapper::surfaceGasTargetRate ( int  wellGroupIdx ) const

inline

Return the target for the volumetric surface gas rate of a well group.

If the control mode does not use the volumetric gas surface rate, this is the upper limit.

double Opm::GconprodWrapper::surfaceLiquidTargetRate ( int  wellGroupIdx ) const

inline

Return the target for the volumetric surface liquid rate of a well group.

If the control mode does not use the volumetric liquid surface rate, this is the upper limit.

double Opm::GconprodWrapper::surfaceOilTargetRate ( int  wellGroupIdx ) const

inline

Return the target for the volumetric surface oil rate of a well group.

If the control mode does not use the volumetric oil surface rate, this is the upper limit.

double Opm::GconprodWrapper::surfaceWaterBalanceTarget ( int  wellGroupIdx ) const

inline

Return balancing fraction of water at surface conditions.

double Opm::GconprodWrapper::surfaceWaterTargetRate ( int  wellGroupIdx ) const

inline

Return the target for the volumetric surface water rate of a well group.

If the control mode does not use the volumetric water surface rate, this is the upper limit.

std::string Opm::GconprodWrapper::waterExceedanceReaction ( int  wellGroupIdx ) const

inline

Return the procedure which is taken if the water target rate is exceeded.

double Opm::GconprodWrapper::wetGasTargetRate ( int  wellGroupIdx ) const

inline

Return target rate for wet-gas.

---

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

• GconprodWrapper.hpp