#include <WellsGroup.hpp>

Inheritance diagram for Opm::WellsGroup:
Inheritance graph

Public Member Functions

 WellsGroup (const std::string &name, const ProductionSpecification &prod_spec, const InjectionSpecification &inj_spec, const PhaseUsage &phase_usage)
 
virtual WellsGroupInterfacefindGroup (const std::string &name_of_node)
 
void addChild (std::shared_ptr< WellsGroupInterface > child)
 
virtual bool conditionsMet (const std::vector< double > &well_bhp, const std::vector< double > &well_reservoirrates_phase, const std::vector< double > &well_surfacerates_phase, WellPhasesSummed &summed_phases)
 
virtual int numberOfLeafNodes ()
 
virtual std::pair< WellNode
*, double > 
getWorstOffending (const std::vector< double > &well_reservoirrates_phase, const std::vector< double > &well_surfacerates_phase, ProductionSpecification::ControlMode mode)
 
virtual void applyInjGroupControl (const InjectionSpecification::ControlMode control_mode, const double target, bool forced)
 
virtual void applyProdGroupControl (const ProductionSpecification::ControlMode control_mode, const double target, bool forced)
 
virtual void applyProdGroupControls ()
 
virtual void applyInjGroupControls ()
 
virtual double productionGuideRate (bool only_group)
 
virtual double injectionGuideRate (bool only_group)
 
virtual double getTotalProductionFlow (const std::vector< double > &phase_flows, const BlackoilPhases::PhaseIndex phase)
 
virtual void applyExplicitReinjectionControls (const std::vector< double > &well_reservoirrates_phase, const std::vector< double > &well_surfacerates_phase)
 
const std::string & name () const
 The unique identifier for the well or well group. More...
 
const ProductionSpecificationprodSpec () const
 Production specifications for the well or well group. More...
 
ProductionSpecificationprodSpec ()
 Production specifications for the well or well group. More...
 
const InjectionSpecificationinjSpec () const
 Injection specifications for the well or well group. More...
 
InjectionSpecificationinjSpec ()
 Injection specifications for the well or well group. More...
 
const PhaseUsagephaseUsage () const
 Phase usage information. More...
 
virtual bool isLeafNode () const
 
void setParent (WellsGroupInterface *parent)
 
const WellsGroupInterfacegetParent () const
 Gets the parent of the group, NULL if no parent. More...
 
double getTarget (ProductionSpecification::ControlMode mode)
 Gets the target rate for the given mode. More...
 
double getTarget (InjectionSpecification::ControlMode mode)
 Gets the target rate for the given mode. More...
 

Protected Member Functions

double rateByMode (const double *res_rates, const double *surf_rates, const ProductionSpecification::ControlMode mode)
 Calculates the correct rate for the given ProductionSpecification::ControlMode. More...
 
double rateByMode (const double *res_rates, const double *surf_rates, const InjectionSpecification::ControlMode mode)
 Calculates the correct rate for the given InjectionSpecification::ControlMode. More...
 

Protected Attributes

WellsGroupInterfaceparent_
 

Constructor & Destructor Documentation

Opm::WellsGroup::WellsGroup ( const std::string &  name,
const ProductionSpecification prod_spec,
const InjectionSpecification inj_spec,
const PhaseUsage phase_usage 
)

Member Function Documentation

void Opm::WellsGroup::addChild ( std::shared_ptr< WellsGroupInterface child)
virtual void Opm::WellsGroup::applyExplicitReinjectionControls ( const std::vector< double > &  well_reservoirrates_phase,
const std::vector< double > &  well_surfacerates_phase 
)
virtual

Applies explicit reinjection controls. This must be called at each timestep to be correct.

Parameters
[in]well_reservoirrates_phaseA vector containing reservoir rates by phase for each well. Is assumed to be ordered the same way as the related Wells-struct, with all phase rates of a single well adjacent in the array.
[in]well_surfacerates_phaseA vector containing surface rates by phase for each well. Is assumed to be ordered the same way as the related Wells-struct, with all phase rates of a single well adjacent in the array.

Implements Opm::WellsGroupInterface.

virtual void Opm::WellsGroup::applyInjGroupControl ( const InjectionSpecification::ControlMode  control_mode,
const double  target,
bool  forced 
)
virtual

Sets the current active control to the provided one for all injectors within the group. After this call, the combined rate (which rate depending on control_mode) of the group shall be equal to target.

Parameters
[in]forcedif true, all children will be set under group control, otherwise only children that are under group control will be changed.

Implements Opm::WellsGroupInterface.

virtual void Opm::WellsGroup::applyInjGroupControls ( )
virtual

Applies any injection group control relevant to all children nodes. If no group control is set, this is called recursively to the children.

Implements Opm::WellsGroupInterface.

virtual void Opm::WellsGroup::applyProdGroupControl ( const ProductionSpecification::ControlMode  control_mode,
const double  target,
bool  forced 
)
virtual

Sets the current active control to the provided one for all producers within the group. After this call, the combined rate (which rate depending on control_mode) of the group shall be equal to target.

Parameters
[in]forcedif true, all children will be set under group control, otherwise only children that are under group control will be changed.

Implements Opm::WellsGroupInterface.

virtual void Opm::WellsGroup::applyProdGroupControls ( )
virtual

Applies any production group control relevant to all children nodes. If no group control is set, this is called recursively to the children.

Implements Opm::WellsGroupInterface.

virtual bool Opm::WellsGroup::conditionsMet ( const std::vector< double > &  well_bhp,
const std::vector< double > &  well_reservoirrates_phase,
const std::vector< double > &  well_surfacerates_phase,
WellPhasesSummed summed_phases 
)
virtual

Checks if each condition is met, applies well controls where needed (that is, it either changes the active control of violating wells, or shuts down wells). Only one change is applied per invocation. Typical use will be

solve_pressure();
while(!group.conditionsMet(...)) {
solve_pressure();
}
Note
It's highly recommended to use the conditionsMet found in WellsManager.
Parameters
[in]well_bhpA vector containing the bhp for each well. Is assumed to be ordered the same way as the related Wells-struct.
[in]well_reservoirrates_phaseA vector containing reservoir rates by phase for each well. Is assumed to be ordered the same way as the related Wells-struct, with all phase rates of a single well adjacent in the array.
[in]well_surfacerates_phaseA vector containing surface rates by phase for each well. Is assumed to be ordered the same way as the related Wells-struct, with all phase rates of a single well adjacent in the array.
[out]summed_phasesWill at end of invocation contain the summed phase rates (rate ,etc.) for the group.
Returns
true if no violations were found, false otherwise (false also implies a change).

Implements Opm::WellsGroupInterface.

virtual WellsGroupInterface* Opm::WellsGroup::findGroup ( const std::string &  name_of_node)
virtual
Returns
the pointer to the WellsGroupInterface with the given name. NULL if the name is not found.a

Implements Opm::WellsGroupInterface.

const WellsGroupInterface* Opm::WellsGroupInterface::getParent ( ) const
inherited

Gets the parent of the group, NULL if no parent.

double Opm::WellsGroupInterface::getTarget ( ProductionSpecification::ControlMode  mode)
inherited

Gets the target rate for the given mode.

double Opm::WellsGroupInterface::getTarget ( InjectionSpecification::ControlMode  mode)
inherited

Gets the target rate for the given mode.

virtual double Opm::WellsGroup::getTotalProductionFlow ( const std::vector< double > &  phase_flows,
const BlackoilPhases::PhaseIndex  phase 
)
virtual

Gets the total production flow of the given phase.

Parameters
[in]phase_flowsA vector containing rates by phase for each well. Is assumed to be ordered the same way as the related Wells-struct, with all phase rates of a single well adjacent in the array.
[in]phaseThe phase for which to sum up.

Implements Opm::WellsGroupInterface.

virtual std::pair<WellNode*, double> Opm::WellsGroup::getWorstOffending ( const std::vector< double > &  well_reservoirrates_phase,
const std::vector< double > &  well_surfacerates_phase,
ProductionSpecification::ControlMode  mode 
)
virtual

Gets the worst offending well based on the input

Parameters
[in]well_reservoirrates_phaseA vector containing reservoir rates by phase for each well. Is assumed to be ordered the same way as the related Wells-struct, with all phase rates of a single well adjacent in the array.
[in]well_surfacerates_phaseA vector containing surface rates by phase for each well. Is assumed to be ordered the same way as the related Wells-struct, with all phase rates of a single well adjacent in the array.
[in]modeThe relevant control mode to find the maximum over.
Returns
first will be a pointer to the worst offending well, second will be the obtained value at that well.

Implements Opm::WellsGroupInterface.

virtual double Opm::WellsGroup::injectionGuideRate ( bool  only_group)
virtual

Calculates the injection guide rate for the group.

Parameters
[in]only_groupIf true, will only accumelate guide rates for wells under group control

Implements Opm::WellsGroupInterface.

const InjectionSpecification& Opm::WellsGroupInterface::injSpec ( ) const
inherited

Injection specifications for the well or well group.

InjectionSpecification& Opm::WellsGroupInterface::injSpec ( )
inherited

Injection specifications for the well or well group.

virtual bool Opm::WellsGroupInterface::isLeafNode ( ) const
virtualinherited
Returns
true if the object is a leaf node (WellNode), false otherwise.

Reimplemented in Opm::WellNode.

const std::string& Opm::WellsGroupInterface::name ( ) const
inherited

The unique identifier for the well or well group.

virtual int Opm::WellsGroup::numberOfLeafNodes ( )
virtual

Calculates the number of leaf nodes in the given group. A leaf node is defined to have one leaf node in its group.

Implements Opm::WellsGroupInterface.

const PhaseUsage& Opm::WellsGroupInterface::phaseUsage ( ) const
inherited

Phase usage information.

const ProductionSpecification& Opm::WellsGroupInterface::prodSpec ( ) const
inherited

Production specifications for the well or well group.

ProductionSpecification& Opm::WellsGroupInterface::prodSpec ( )
inherited

Production specifications for the well or well group.

virtual double Opm::WellsGroup::productionGuideRate ( bool  only_group)
virtual

Calculates the production guide rate for the group.

Parameters
[in]only_groupIf true, will only accumelate guide rates for wells under group control

Implements Opm::WellsGroupInterface.

double Opm::WellsGroupInterface::rateByMode ( const double *  res_rates,
const double *  surf_rates,
const ProductionSpecification::ControlMode  mode 
)
protectedinherited

Calculates the correct rate for the given ProductionSpecification::ControlMode.

double Opm::WellsGroupInterface::rateByMode ( const double *  res_rates,
const double *  surf_rates,
const InjectionSpecification::ControlMode  mode 
)
protectedinherited

Calculates the correct rate for the given InjectionSpecification::ControlMode.

void Opm::WellsGroupInterface::setParent ( WellsGroupInterface parent)
inherited

Sets the parent

Parameters
[in]parentthe pointer to the parent

Member Data Documentation

WellsGroupInterface* Opm::WellsGroupInterface::parent_
protectedinherited

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