Public Member Functions
	WgrupconWrapper (Opm::DeckKeywordConstPtr keyword)
	A wrapper class to provide convenient access to the data of the 'WGRUPCON' keyword. More...

int	numGroups () const
	Return the number of well groups to which this keyword applies. More...

std::string	groupName (int groupIdx) const
	Return the human-readable name of a well group with a given index. More...

bool	isUnconstraint (int groupIdx) const
	Return whether the group is available for higher level groups to control. More...

double	guideRate (int groupIdx) const
	Return the guide rate for the group. More...

std::string	controlPhase (int groupIdx) const
	Return the type of a well group. More...

double	guideRateScalingFactor (int groupIdx) const
	Return the scaling factor for the guide rate of a group. More...

Constructor & Destructor Documentation

Opm::WgrupconWrapper::WgrupconWrapper ( Opm::DeckKeywordConstPtr keyword )

inline

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

Member Function Documentation

std::string Opm::WgrupconWrapper::controlPhase ( int groupIdx ) const

inline

Return the type of a well group.

This is one of:

std::string Opm::WgrupconWrapper::groupName ( int groupIdx ) const

inline

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

double Opm::WgrupconWrapper::guideRate ( int groupIdx ) const

inline

Return the guide rate for the group.

double Opm::WgrupconWrapper::guideRateScalingFactor ( int groupIdx ) const

inline

Return the scaling factor for the guide rate of a group.

bool Opm::WgrupconWrapper::isUnconstraint ( int groupIdx ) const

inline

Return whether the group is available for higher level groups to control.

int Opm::WgrupconWrapper::numGroups ( ) const

inline

Return the number of well groups to which this keyword applies.

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