Opm::GconinjeWrapper Class Reference

#include <GconinjeWrapper.hpp>

Public Member Functions

 GconinjeWrapper (Opm::DeckKeywordConstPtr keyword)
 A wrapper class to provide convenient access to the data of the 'GCONINJE' keyword. More...
 
int numGroups () const
 Return the number of injection 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 groupType (int wellGroupIdx) const
 Return the injector type of a well group. More...
 
std::string controlMode (int wellGroupIdx) const
 Return the what should be controlled for a given well. More...
 
double rawSurfaceTargetRate (int wellGroupIdx) const
 Return the target for the volumetric surface rate of a well group. More...
 
double rawReservoirTargetRate (int wellGroupIdx) const
 Return the target for the volumetric reservoir rate of a well group. More...
 
double reinjectTargetRatio (int wellGroupIdx) const
 The target fraction for reinjection. More...
 
double voidageReplacementFractionTarget (int wellGroupIdx) const
 The target fraction of the voidage replacement fraction. 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 injectionShareTarget (int wellGroupIdx) const
 The target for the group's share of the next higher-level group's total injection rate. More...
 
std::string injectionShareType (int wellGroupIdx) const
 The kind of control which the next higher-level group wants. More...
 
std::string reinjectGroupName (int wellGroupIdx) const
 The name of the production group which should be partially reinjected. More...
 
std::string voidageGroupName (int wellGroupIdx) const
 The name of the group to which the voidage replacement volume fraction applies and which's production rates should be used. More...
 
double wetGasTargetRate (int wellGroupIdx) const
 The target rate for wet gas injection. More...
 

Constructor & Destructor Documentation

Opm::GconinjeWrapper::GconinjeWrapper ( Opm::DeckKeywordConstPtr  keyword)
inline

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

Member Function Documentation

std::string Opm::GconinjeWrapper::controlMode ( int  wellGroupIdx) const
inline

Return the what should be controlled for a given well.

This is one of:

  • NONE: The individual wells specify how they are controlled
  • RATE: Control for the surface volume rate of the fluid
  • RESV: Control for the reservoir volume rate of the fluid
  • REIN: Injection rate is production rate times a re-injection ratio
  • VREP: Control the total surface injection rate of all wells
  • WGRA: Control for the wet-gas injection rate
  • FLD: Higher level groups specify this group's control
std::string Opm::GconinjeWrapper::groupName ( int  wellGroupIdx) const
inline

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

std::string Opm::GconinjeWrapper::groupType ( int  wellGroupIdx) const
inline

Return the injector type of a well group.

This is one of:

  • OIL
  • WATER
  • GAS
double Opm::GconinjeWrapper::injectionShareTarget ( int  wellGroupIdx) const
inline

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

std::string Opm::GconinjeWrapper::injectionShareType ( int  wellGroupIdx) const
inline

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

This is one of:

  • RATE
  • RESV
  • VOID
  • NETV
  • ' '
bool Opm::GconinjeWrapper::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.

int Opm::GconinjeWrapper::numGroups ( ) const
inline

Return the number of injection well groups.

double Opm::GconinjeWrapper::rawReservoirTargetRate ( int  wellGroupIdx) const
inline

Return the target for the volumetric reservoir rate of a well group.

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

double Opm::GconinjeWrapper::rawSurfaceTargetRate ( int  wellGroupIdx) const
inline

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

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

std::string Opm::GconinjeWrapper::reinjectGroupName ( int  wellGroupIdx) const
inline

The name of the production group which should be partially reinjected.

double Opm::GconinjeWrapper::reinjectTargetRatio ( int  wellGroupIdx) const
inline

The target fraction for reinjection.

std::string Opm::GconinjeWrapper::voidageGroupName ( int  wellGroupIdx) const
inline

The name of the group to which the voidage replacement volume fraction applies and which's production rates should be used.

double Opm::GconinjeWrapper::voidageReplacementFractionTarget ( int  wellGroupIdx) const
inline

The target fraction of the voidage replacement fraction.

double Opm::GconinjeWrapper::wetGasTargetRate ( int  wellGroupIdx) const
inline

The target rate for wet gas injection.


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