Opm::GroupEconomicLimitsChecker< Scalar, IndexTraits > Class Template Reference

#include <GroupEconomicLimitsChecker.hpp>

Classes

struct  RatioDetails
 

Public Types

enum class  RatioViolation { NONE , WATER_CUT , GOR , WGR }
 

Public Member Functions

 GroupEconomicLimitsChecker (const BlackoilWellModelGeneric< Scalar, IndexTraits > &well_model, WellTestState &well_test_state, const Group &group, const double simulation_time, const int report_step_idx, DeferredLogger &deferred_logger)
 
void closeWells ()
 
bool minGasRate ()
 
bool minOilRate ()
 
std::optional< RatioDetailswaterCut ()
 
std::optional< RatioDetailsGOR ()
 
std::optional< RatioDetailsWGR ()
 
std::optional< RatioDetailsratioViolation ()
 
void doWorkOver (const RatioDetails &ratio_details)
 
bool endRun ()
 
int numProducersOpenInitially ()
 
int numProducersOpen ()
 
void activateEndRun ()
 
std::string message_separator (const char sep_char=' *', const size_t sep_length=110) const
 

Static Public Attributes

static constexpr int NUM_PHASES = 3
 

Member Enumeration Documentation

◆ RatioViolation

template<typename Scalar , typename IndexTraits >
enum class Opm::GroupEconomicLimitsChecker::RatioViolation
strong
Enumerator
NONE 
WATER_CUT 
GOR 
WGR 

Constructor & Destructor Documentation

◆ GroupEconomicLimitsChecker()

template<typename Scalar , typename IndexTraits >
Opm::GroupEconomicLimitsChecker< Scalar, IndexTraits >::GroupEconomicLimitsChecker ( const BlackoilWellModelGeneric< Scalar, IndexTraits > &  well_model,
WellTestState &  well_test_state,
const Group &  group,
const double  simulation_time,
const int  report_step_idx,
DeferredLogger deferred_logger 
)

Member Function Documentation

◆ activateEndRun()

template<typename Scalar , typename IndexTraits >
void Opm::GroupEconomicLimitsChecker< Scalar, IndexTraits >::activateEndRun ( )

◆ closeWells()

template<typename Scalar , typename IndexTraits >
void Opm::GroupEconomicLimitsChecker< Scalar, IndexTraits >::closeWells ( )

◆ doWorkOver()

template<typename Scalar , typename IndexTraits >
void Opm::GroupEconomicLimitsChecker< Scalar, IndexTraits >::doWorkOver ( const RatioDetails ratio_details)

◆ endRun()

template<typename Scalar , typename IndexTraits >
bool Opm::GroupEconomicLimitsChecker< Scalar, IndexTraits >::endRun ( )

◆ GOR()

template<typename Scalar , typename IndexTraits >
std::optional< RatioDetails > Opm::GroupEconomicLimitsChecker< Scalar, IndexTraits >::GOR ( )

◆ message_separator()

template<typename Scalar , typename IndexTraits >
std::string Opm::GroupEconomicLimitsChecker< Scalar, IndexTraits >::message_separator ( const char  sep_char = '*',
const size_t  sep_length = 110 
) const
inline

◆ minGasRate()

template<typename Scalar , typename IndexTraits >
bool Opm::GroupEconomicLimitsChecker< Scalar, IndexTraits >::minGasRate ( )

◆ minOilRate()

template<typename Scalar , typename IndexTraits >
bool Opm::GroupEconomicLimitsChecker< Scalar, IndexTraits >::minOilRate ( )

◆ numProducersOpen()

template<typename Scalar , typename IndexTraits >
int Opm::GroupEconomicLimitsChecker< Scalar, IndexTraits >::numProducersOpen ( )

◆ numProducersOpenInitially()

template<typename Scalar , typename IndexTraits >
int Opm::GroupEconomicLimitsChecker< Scalar, IndexTraits >::numProducersOpenInitially ( )

◆ ratioViolation()

template<typename Scalar , typename IndexTraits >
std::optional< RatioDetails > Opm::GroupEconomicLimitsChecker< Scalar, IndexTraits >::ratioViolation ( )

◆ waterCut()

template<typename Scalar , typename IndexTraits >
std::optional< RatioDetails > Opm::GroupEconomicLimitsChecker< Scalar, IndexTraits >::waterCut ( )

◆ WGR()

template<typename Scalar , typename IndexTraits >
std::optional< RatioDetails > Opm::GroupEconomicLimitsChecker< Scalar, IndexTraits >::WGR ( )

Member Data Documentation

◆ NUM_PHASES

template<typename Scalar , typename IndexTraits >
constexpr int Opm::GroupEconomicLimitsChecker< Scalar, IndexTraits >::NUM_PHASES = 3
staticconstexpr

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