Opm::WellConstraints Class Reference

Class for computing well group constraints. More...

#include <WellConstraints.hpp>

Public Types

using RateConvFunc = std::function< void(const RegionId, const int, const std::vector< double > &, std::vector< double > &)>
 

Public Member Functions

 WellConstraints (const WellInterfaceGeneric &well)
 Constructor sets reference to well. More...
 
bool checkIndividualConstraints (SingleWellState< double > &ws, const SummaryState &summaryState, const RateConvFunc &calcReservoirVoidageRates, bool &thp_limit_violated_but_not_switched, DeferredLogger &deferred_logger, const std::optional< Well::InjectionControls > &inj_controls=std::nullopt, const std::optional< Well::ProductionControls > &prod_controls=std::nullopt) const
 

Detailed Description

Class for computing well group constraints.

Member Typedef Documentation

◆ RateConvFunc

using Opm::WellConstraints::RateConvFunc = std::function<void(const RegionId, const int, const std::vector<double>&, std::vector<double>&)>

Constructor & Destructor Documentation

◆ WellConstraints()

Opm::WellConstraints::WellConstraints ( const WellInterfaceGeneric well)
inline

Constructor sets reference to well.

Member Function Documentation

◆ checkIndividualConstraints()

bool Opm::WellConstraints::checkIndividualConstraints ( SingleWellState< double > &  ws,
const SummaryState &  summaryState,
const RateConvFunc calcReservoirVoidageRates,
bool &  thp_limit_violated_but_not_switched,
DeferredLogger deferred_logger,
const std::optional< Well::InjectionControls > &  inj_controls = std::nullopt,
const std::optional< Well::ProductionControls > &  prod_controls = std::nullopt 
) const

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