Classes | Public Types | Public Member Functions | List of all members
Opm::GroupConstraintCalculator< Scalar, IndexTraits > Class Template Reference

#include <GroupConstraintCalculator.hpp>

Classes

struct  ConstraintInfo
 
class  GeneralCalculator
 
struct  InjectionConstraintInfo
 
struct  ProductionConstraintInfo
 
struct  ProductionConstraintResult
 
class  TopToBottomCalculator
 

Public Types

enum class  ConstraintType { Target , Limit }
 
using ControlMode = std::variant< std::monostate, Group::InjectionCMode, Group::ProductionCMode >
 
using FractionCalculator = GroupStateHelpers::FractionCalculator< Scalar, IndexTraits >
 
using InjectionTargetCalculator = GroupStateHelpers::InjectionTargetCalculator< Scalar, IndexTraits >
 
using TargetCalculator = GroupStateHelpers::TargetCalculator< Scalar, IndexTraits >
 
using GroupStateHelperType = GroupStateHelper< Scalar, IndexTraits >
 

Public Member Functions

 GroupConstraintCalculator (const BlackoilWellModelGeneric< Scalar, IndexTraits > &well_model, const GroupStateHelperType &group_state_helper)
 
DeferredLogger & deferredLogger ()
 
DeferredLogger & deferredLogger () const
 
int fipnum () const
 
std::optional< InjectionConstraintInfo > groupInjectionTarget (const Group &group, ReservoirCoupling::Phase injection_phase)
 
std::optional< ProductionConstraintInfo > groupProductionTarget (const Group &group)
 
std::optional< ProductionConstraintResult > groupProductionConstraints (const Group &group)
 
const GroupState< Scalar > & groupState () const
 
const GuideRate & guideRate () const
 
const PhaseUsageInfo< IndexTraits > & phaseUsage () const
 
int pvtreg () const
 
int reportStepIdx () const
 
const std::vector< Scalar > & resvCoeffsInj () const
 
const Schedule & schedule () const
 
const SummaryState & summaryState () const
 
const BlackoilWellModelGeneric< Scalar, IndexTraits > & wellModel () const
 
const WellState< Scalar, IndexTraits > & wellState () const
 
const GroupStateHelperType & groupStateHelper () const
 

Detailed Description

template<class Scalar, class IndexTraits>
class Opm::GroupConstraintCalculator< Scalar, IndexTraits >

Calculate group-level constraints for production and injection.

This class traverses the group hierarchy to determine effective control modes and constraints, applying guide-rate based distribution, sales limits (e.g., GCONSALE), efficiency factors, and RESV coefficients where applicable. It provides a uniform interface for both producers and injectors and consolidates common logic through nested helper classes.

Member Typedef Documentation

◆ ControlMode

template<class Scalar , class IndexTraits >
using Opm::GroupConstraintCalculator< Scalar, IndexTraits >::ControlMode = std::variant< std::monostate, Group::InjectionCMode, Group::ProductionCMode >

Union of control-mode types used by group constraint calculations. Holds Group::InjectionCMode for injection, Group::ProductionCMode for production; std::monostate denotes that no specific control applies.

◆ FractionCalculator

template<class Scalar , class IndexTraits >
using Opm::GroupConstraintCalculator< Scalar, IndexTraits >::FractionCalculator = GroupStateHelpers::FractionCalculator<Scalar, IndexTraits>

◆ GroupStateHelperType

template<class Scalar , class IndexTraits >
using Opm::GroupConstraintCalculator< Scalar, IndexTraits >::GroupStateHelperType = GroupStateHelper<Scalar, IndexTraits>

◆ InjectionTargetCalculator

template<class Scalar , class IndexTraits >
using Opm::GroupConstraintCalculator< Scalar, IndexTraits >::InjectionTargetCalculator = GroupStateHelpers::InjectionTargetCalculator<Scalar, IndexTraits>

◆ TargetCalculator

template<class Scalar , class IndexTraits >
using Opm::GroupConstraintCalculator< Scalar, IndexTraits >::TargetCalculator = GroupStateHelpers::TargetCalculator<Scalar, IndexTraits>

Member Enumeration Documentation

◆ ConstraintType

template<class Scalar , class IndexTraits >
enum class Opm::GroupConstraintCalculator::ConstraintType
strong

Type of constraint to calculate: target or limit.

Enumerator
Target 
Limit 

Constructor & Destructor Documentation

◆ GroupConstraintCalculator()

template<class Scalar , class IndexTraits >
Opm::GroupConstraintCalculator< Scalar, IndexTraits >::GroupConstraintCalculator ( const BlackoilWellModelGeneric< Scalar, IndexTraits > &  well_model,
const GroupStateHelperType &  group_state_helper 
)

Construct a calculator bound to one report step and simulator state.

Member Function Documentation

◆ deferredLogger() [1/2]

template<class Scalar , class IndexTraits >
DeferredLogger & Opm::GroupConstraintCalculator< Scalar, IndexTraits >::deferredLogger ( )
inline

References Opm::GroupStateHelper< Scalar, IndexTraits >::deferredLogger().

Referenced by Opm::GroupConstraintCalculator< Scalar, IndexTraits >::GeneralCalculator::deferredLogger().

◆ deferredLogger() [2/2]

template<class Scalar , class IndexTraits >
DeferredLogger & Opm::GroupConstraintCalculator< Scalar, IndexTraits >::deferredLogger ( ) const
inline

References Opm::GroupStateHelper< Scalar, IndexTraits >::deferredLogger().

◆ fipnum()

template<class Scalar , class IndexTraits >
int Opm::GroupConstraintCalculator< Scalar, IndexTraits >::fipnum ( ) const
inline

Referenced by Opm::GroupConstraintCalculator< Scalar, IndexTraits >::GeneralCalculator::fipnum().

◆ groupInjectionTarget()

template<class Scalar , class IndexTraits >
std::optional< InjectionConstraintInfo > Opm::GroupConstraintCalculator< Scalar, IndexTraits >::groupInjectionTarget ( const Group &  group,
ReservoirCoupling::Phase  injection_phase 
)

Compute injection target for group in the given injection phase.

◆ groupProductionConstraints()

template<class Scalar , class IndexTraits >
std::optional< ProductionConstraintResult > Opm::GroupConstraintCalculator< Scalar, IndexTraits >::groupProductionConstraints ( const Group &  group)

Compute per-rate-type production constraints for a group. Returns the active target plus effective limits for all rate types with defined limits in the group hierarchy.

◆ groupProductionTarget()

template<class Scalar , class IndexTraits >
std::optional< ProductionConstraintInfo > Opm::GroupConstraintCalculator< Scalar, IndexTraits >::groupProductionTarget ( const Group &  group)

Compute production target for group.

◆ groupState()

template<class Scalar , class IndexTraits >
const GroupState< Scalar > & Opm::GroupConstraintCalculator< Scalar, IndexTraits >::groupState ( ) const
inline

Referenced by Opm::GroupConstraintCalculator< Scalar, IndexTraits >::GeneralCalculator::groupState().

◆ groupStateHelper()

template<class Scalar , class IndexTraits >
const GroupStateHelperType & Opm::GroupConstraintCalculator< Scalar, IndexTraits >::groupStateHelper ( ) const
inline

Referenced by Opm::GroupConstraintCalculator< Scalar, IndexTraits >::GeneralCalculator::groupStateHelper().

◆ guideRate()

template<class Scalar , class IndexTraits >
const GuideRate & Opm::GroupConstraintCalculator< Scalar, IndexTraits >::guideRate ( ) const
inline

Referenced by Opm::GroupConstraintCalculator< Scalar, IndexTraits >::GeneralCalculator::guideRate().

◆ phaseUsage()

template<class Scalar , class IndexTraits >
const PhaseUsageInfo< IndexTraits > & Opm::GroupConstraintCalculator< Scalar, IndexTraits >::phaseUsage ( ) const
inline

Referenced by Opm::GroupConstraintCalculator< Scalar, IndexTraits >::GeneralCalculator::phaseUsage().

◆ pvtreg()

template<class Scalar , class IndexTraits >
int Opm::GroupConstraintCalculator< Scalar, IndexTraits >::pvtreg ( ) const
inline

Referenced by Opm::GroupConstraintCalculator< Scalar, IndexTraits >::GeneralCalculator::pvtreg().

◆ reportStepIdx()

template<class Scalar , class IndexTraits >
int Opm::GroupConstraintCalculator< Scalar, IndexTraits >::reportStepIdx ( ) const
inline

Referenced by Opm::GroupConstraintCalculator< Scalar, IndexTraits >::GeneralCalculator::reportStepIdx().

◆ resvCoeffsInj()

template<class Scalar , class IndexTraits >
const std::vector< Scalar > & Opm::GroupConstraintCalculator< Scalar, IndexTraits >::resvCoeffsInj ( ) const
inline

Referenced by Opm::GroupConstraintCalculator< Scalar, IndexTraits >::GeneralCalculator::resvCoeffsInj().

◆ schedule()

template<class Scalar , class IndexTraits >
const Schedule & Opm::GroupConstraintCalculator< Scalar, IndexTraits >::schedule ( ) const
inline

Referenced by Opm::GroupConstraintCalculator< Scalar, IndexTraits >::GeneralCalculator::schedule().

◆ summaryState()

template<class Scalar , class IndexTraits >
const SummaryState & Opm::GroupConstraintCalculator< Scalar, IndexTraits >::summaryState ( ) const
inline

Referenced by Opm::GroupConstraintCalculator< Scalar, IndexTraits >::GeneralCalculator::summaryState().

◆ wellModel()

template<class Scalar , class IndexTraits >
const BlackoilWellModelGeneric< Scalar, IndexTraits > & Opm::GroupConstraintCalculator< Scalar, IndexTraits >::wellModel ( ) const
inline

Referenced by Opm::GroupConstraintCalculator< Scalar, IndexTraits >::GeneralCalculator::wellModel().

◆ wellState()

template<class Scalar , class IndexTraits >
const WellState< Scalar, IndexTraits > & Opm::GroupConstraintCalculator< Scalar, IndexTraits >::wellState ( ) const
inline

Referenced by Opm::GroupConstraintCalculator< Scalar, IndexTraits >::GeneralCalculator::wellState().

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