#include <Group.hpp>

Classes
struct	GroupInjectionProperties

struct	GroupProductionProperties

struct	InjectionControls

struct	ProductionControls

Public Types
enum class	GroupType : unsigned { NONE = 0 , PRODUCTION = 1 , INJECTION = 2 , MIXED = 3 }

enum class	ExceedAction { NONE = 0 , CON = 1 , CON_PLUS = 2 , WELL = 3 , PLUG = 4 , RATE = 5 }

enum class	InjectionCMode : int { NONE = 0 , RATE = 1 , RESV = 2 , REIN = 4 , VREP = 8 , FLD = 16 , SALE = 32 }

enum class	ProductionCMode : int { NONE = 0 , ORAT = 1 , WRAT = 2 , GRAT = 4 , LRAT = 8 , CRAT = 16 , RESV = 32 , PRBL = 64 , FLD = 128 }

enum class	GuideRateTarget { OIL = 0 , WAT = 1 , GAS = 2 , LIQ = 3 , RES = 4 , COMB = 5 , WGA = 6 , CVAL = 7 , INJV = 8 , POTN = 9 , FORM = 10 , NO_GUIDE_RATE = 11 }

Public Member Functions
	Group ()

	Group (const std::string &group_name, std::size_t insert_index_arg, std::size_t init_step_arg, double udq_undefined_arg, const UnitSystem &unit_system)

bool	defined (std::size_t timeStep) const

std::size_t	insert_index () const

const std::string &	name () const

int	getGroupNetVFPTable () const

bool	updateNetVFPTable (int vfp_arg)

bool	update_gefac (double gefac, bool transfer_gefac)

const std::string &	parent () const

std::optional< std::string >	control_group () const

std::optional< std::string >	flow_group () const

bool	updateParent (const std::string &parent)

bool	updateInjection (const GroupInjectionProperties &injection)

bool	updateProduction (const GroupProductionProperties &production)

bool	isProductionGroup () const

bool	isInjectionGroup () const

void	setProductionGroup ()

void	setInjectionGroup ()

double	getGroupEfficiencyFactor () const

bool	getTransferGroupEfficiencyFactor () const

std::size_t	numWells () const

bool	addGroup (const std::string &group_name)

bool	hasGroup (const std::string &group_name) const

void	delGroup (const std::string &group_name)

bool	addWell (const std::string &well_name)

bool	hasWell (const std::string &well_name) const

void	delWell (const std::string &well_name)

const std::vector< std::string > &	wells () const

const std::vector< std::string > &	groups () const

bool	wellgroup () const

ProductionControls	productionControls (const SummaryState &st) const

InjectionControls	injectionControls (Phase phase, const SummaryState &st) const

bool	hasInjectionControl (Phase phase) const

const GroupProductionProperties &	productionProperties () const

const std::map< Phase, GroupInjectionProperties > &	injectionProperties () const

const GroupType &	getGroupType () const

ProductionCMode	production_cmode () const

InjectionCMode	injection_cmode () const

Phase	injection_phase () const

bool	has_control (ProductionCMode control) const

bool	has_control (InjectionCMode control) const

bool	productionGroupControlAvailable () const

bool	injectionGroupControlAvailable (const Phase phase) const

bool	operator== (const Group &data) const

const Phase &	topup_phase () const

bool	has_topup_phase () const

template<class Serializer >
void	serializeOp (Serializer &serializer)

Static Public Member Functions
static const std::string	ExceedAction2String (ExceedAction enumValue)

static ExceedAction	ExceedActionFromString (const std::string &stringValue)

static const std::string	InjectionCMode2String (InjectionCMode enumValue)

static InjectionCMode	InjectionCModeFromString (const std::string &stringValue)

static const std::string	ProductionCMode2String (ProductionCMode enumValue)

static ProductionCMode	ProductionCModeFromString (const std::string &stringValue)

static GuideRateTarget	GuideRateTargetFromString (const std::string &stringValue)

static Group	serializeObject ()

Member Enumeration Documentation

◆ ExceedAction

enum class Opm::Group::ExceedAction

strong

Enumerator
NONE
CON
CON_PLUS
WELL
PLUG
RATE

◆ GroupType

enum class Opm::Group::GroupType : unsigned

strong

Enumerator
NONE
PRODUCTION
INJECTION
MIXED

◆ GuideRateTarget

enum class Opm::Group::GuideRateTarget

strong

Enumerator
OIL
WAT
GAS
LIQ
RES
COMB
WGA
CVAL
INJV
POTN
FORM
NO_GUIDE_RATE

◆ InjectionCMode

enum class Opm::Group::InjectionCMode : int

strong

Enumerator
NONE
RATE
RESV
REIN
VREP
FLD
SALE

◆ ProductionCMode

enum class Opm::Group::ProductionCMode : int

strong

Enumerator
NONE
ORAT
WRAT
GRAT
LRAT
CRAT
RESV
PRBL
FLD

Constructor & Destructor Documentation

◆ Group() [1/2]

Opm::Group::Group ( )

◆ Group() [2/2]

Opm::Group::Group	(	const std::string &	group_name,
		std::size_t	insert_index_arg,
		std::size_t	init_step_arg,
		double	udq_undefined_arg,
		const UnitSystem &	unit_system
	)

Member Function Documentation

◆ addGroup()

bool Opm::Group::addGroup ( const std::string & group_name )

◆ addWell()

bool Opm::Group::addWell ( const std::string & well_name )

◆ control_group()

std::optional< std::string > Opm::Group::control_group ( ) const

◆ defined()

bool Opm::Group::defined ( std::size_t timeStep ) const

◆ delGroup()

void Opm::Group::delGroup ( const std::string & group_name )

◆ delWell()

void Opm::Group::delWell ( const std::string & well_name )

◆ ExceedAction2String()

static const std::string Opm::Group::ExceedAction2String ( ExceedAction enumValue )

static

◆ ExceedActionFromString()

static ExceedAction Opm::Group::ExceedActionFromString ( const std::string & stringValue )

static

◆ flow_group()

std::optional< std::string > Opm::Group::flow_group ( ) const

◆ getGroupEfficiencyFactor()

double Opm::Group::getGroupEfficiencyFactor ( ) const

◆ getGroupNetVFPTable()

int Opm::Group::getGroupNetVFPTable ( ) const

◆ getGroupType()

const GroupType & Opm::Group::getGroupType ( ) const

◆ getTransferGroupEfficiencyFactor()

bool Opm::Group::getTransferGroupEfficiencyFactor ( ) const

◆ groups()

const std::vector< std::string > & Opm::Group::groups ( ) const

◆ GuideRateTargetFromString()

static GuideRateTarget Opm::Group::GuideRateTargetFromString ( const std::string & stringValue )

static

◆ has_control() [1/2]

bool Opm::Group::has_control ( InjectionCMode control ) const

◆ has_control() [2/2]

bool Opm::Group::has_control ( ProductionCMode control ) const

◆ has_topup_phase()

bool Opm::Group::has_topup_phase ( ) const

◆ hasGroup()

bool Opm::Group::hasGroup ( const std::string & group_name ) const

◆ hasInjectionControl()

bool Opm::Group::hasInjectionControl ( Phase phase ) const

◆ hasWell()

bool Opm::Group::hasWell ( const std::string & well_name ) const

◆ injection_cmode()

InjectionCMode Opm::Group::injection_cmode ( ) const

◆ injection_phase()

Phase Opm::Group::injection_phase ( ) const

◆ InjectionCMode2String()

static const std::string Opm::Group::InjectionCMode2String ( InjectionCMode enumValue )

static

◆ InjectionCModeFromString()

static InjectionCMode Opm::Group::InjectionCModeFromString ( const std::string & stringValue )

static

◆ injectionControls()

InjectionControls Opm::Group::injectionControls	(	Phase	phase,
		const SummaryState &	st
	)		const

◆ injectionGroupControlAvailable()

bool Opm::Group::injectionGroupControlAvailable ( const Phase phase ) const

◆ injectionProperties()

const std::map< Phase, GroupInjectionProperties > & Opm::Group::injectionProperties ( ) const

◆ insert_index()

std::size_t Opm::Group::insert_index ( ) const

◆ isInjectionGroup()

bool Opm::Group::isInjectionGroup ( ) const

◆ isProductionGroup()

bool Opm::Group::isProductionGroup ( ) const

◆ name()

const std::string & Opm::Group::name ( ) const

◆ numWells()

std::size_t Opm::Group::numWells ( ) const

◆ operator==()

bool Opm::Group::operator== ( const Group & data ) const

◆ parent()

const std::string & Opm::Group::parent ( ) const

◆ production_cmode()

ProductionCMode Opm::Group::production_cmode ( ) const

◆ ProductionCMode2String()

static const std::string Opm::Group::ProductionCMode2String ( ProductionCMode enumValue )

static

◆ ProductionCModeFromString()

static ProductionCMode Opm::Group::ProductionCModeFromString ( const std::string & stringValue )

static

◆ productionControls()

ProductionControls Opm::Group::productionControls ( const SummaryState & st ) const

◆ productionGroupControlAvailable()

bool Opm::Group::productionGroupControlAvailable ( ) const

◆ productionProperties()

const GroupProductionProperties & Opm::Group::productionProperties ( ) const

◆ serializeObject()

static Group Opm::Group::serializeObject ( )

static

◆ serializeOp()

template<class Serializer >

void Opm::Group::serializeOp ( Serializer & serializer )

inline

References Opm::Group::GroupProductionProperties::serializeOp(), Opm::IOrderSet< T >::serializeOp(), and Opm::UnitSystem::serializeOp().

◆ setInjectionGroup()

void Opm::Group::setInjectionGroup ( )

◆ setProductionGroup()

void Opm::Group::setProductionGroup ( )

◆ topup_phase()

const Phase & Opm::Group::topup_phase ( ) const

◆ update_gefac()

bool Opm::Group::update_gefac	(	double	gefac,
		bool	transfer_gefac
	)

◆ updateInjection()

bool Opm::Group::updateInjection ( const GroupInjectionProperties & injection )

◆ updateNetVFPTable()

bool Opm::Group::updateNetVFPTable ( int vfp_arg )

◆ updateParent()

bool Opm::Group::updateParent ( const std::string & parent )

◆ updateProduction()

bool Opm::Group::updateProduction ( const GroupProductionProperties & production )

◆ wellgroup()

bool Opm::Group::wellgroup ( ) const

◆ wells()

const std::vector< std::string > & Opm::Group::wells ( ) const

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

parser/eclipse/EclipseState/Schedule/Group/group.hpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Member Enumeration Documentation

◆ ExceedAction

◆ GroupType

◆ GuideRateTarget

◆ InjectionCMode

◆ ProductionCMode

Constructor & Destructor Documentation

◆ Group() [1/2]

◆ Group() [2/2]

Member Function Documentation

◆ addGroup()

◆ addWell()

◆ control_group()

◆ defined()

◆ delGroup()

◆ delWell()

◆ ExceedAction2String()

◆ ExceedActionFromString()

◆ flow_group()

◆ getGroupEfficiencyFactor()

◆ getGroupNetVFPTable()

◆ getGroupType()

◆ getTransferGroupEfficiencyFactor()

◆ groups()

◆ GuideRateTargetFromString()

◆ has_control() [1/2]

◆ has_control() [2/2]

◆ has_topup_phase()

◆ hasGroup()

◆ hasInjectionControl()

◆ hasWell()

◆ injection_cmode()

◆ injection_phase()

◆ InjectionCMode2String()

◆ InjectionCModeFromString()

◆ injectionControls()

◆ injectionGroupControlAvailable()

◆ injectionProperties()

◆ insert_index()

◆ isInjectionGroup()

◆ isProductionGroup()

◆ name()

◆ numWells()

◆ operator==()

◆ parent()

◆ production_cmode()

◆ ProductionCMode2String()

◆ ProductionCModeFromString()

◆ productionControls()

◆ productionGroupControlAvailable()

◆ productionProperties()

◆ serializeObject()

◆ serializeOp()

◆ setInjectionGroup()

◆ setProductionGroup()

◆ topup_phase()

◆ update_gefac()

◆ updateInjection()

◆ updateNetVFPTable()

◆ updateParent()

◆ updateProduction()

◆ wellgroup()

◆ wells()