Opm::GasLiftStage2< Scalar >::SurplusState Struct Reference

#include <GasLiftStage2.hpp>

Public Member Functions

 SurplusState (GasLiftStage2 &parent_, const Group &group_, Scalar oil_rate_, Scalar gas_rate_, Scalar water_rate_, Scalar alq_, Scalar min_eco_grad_, Scalar oil_target_, Scalar gas_target_, Scalar water_target_, Scalar liquid_target_, std::optional< Scalar > max_glift_, std::optional< Scalar > max_total_gas_)
 
void addOrRemoveALQincrement (GradMap &grad_map, const std::string &well_name, bool add)
 
bool checkALQlimit ()
 
bool checkEcoGradient (const std::string &well_name, Scalar eco_grad)
 
bool checkGasTarget (Scalar delta_gas)
 
bool checkLiquidTarget (Scalar delta_liquid)
 
bool checkOilTarget (Scalar delta_oil)
 
bool checkWaterTarget (Scalar delta_water)
 
std::array< Scalar, 4 > computeDelta (const std::string &name)
 
void updateRates (const std::array< Scalar, 4 > &delta)
 

Public Attributes

GasLiftStage2parent
 
const Group & group
 
Scalar oil_rate
 
Scalar gas_rate
 
Scalar water_rate
 
Scalar alq
 
const Scalar min_eco_grad
 
const Scalar oil_target
 
const Scalar gas_target
 
const Scalar water_target
 
const Scalar liquid_target
 
std::optional< Scalar > max_glift
 
std::optional< Scalar > max_total_gas
 
int it
 

Constructor & Destructor Documentation

◆ SurplusState()

template<class Scalar >
Opm::GasLiftStage2< Scalar >::SurplusState::SurplusState ( GasLiftStage2 parent_,
const Group &  group_,
Scalar  oil_rate_,
Scalar  gas_rate_,
Scalar  water_rate_,
Scalar  alq_,
Scalar  min_eco_grad_,
Scalar  oil_target_,
Scalar  gas_target_,
Scalar  water_target_,
Scalar  liquid_target_,
std::optional< Scalar >  max_glift_,
std::optional< Scalar >  max_total_gas_ 
)
inline

Member Function Documentation

◆ addOrRemoveALQincrement()

template<class Scalar >
void Opm::GasLiftStage2< Scalar >::SurplusState::addOrRemoveALQincrement ( GradMap &  grad_map,
const std::string &  well_name,
bool  add 
)

◆ checkALQlimit()

template<class Scalar >
bool Opm::GasLiftStage2< Scalar >::SurplusState::checkALQlimit ( )

◆ checkEcoGradient()

template<class Scalar >
bool Opm::GasLiftStage2< Scalar >::SurplusState::checkEcoGradient ( const std::string &  well_name,
Scalar  eco_grad 
)

◆ checkGasTarget()

template<class Scalar >
bool Opm::GasLiftStage2< Scalar >::SurplusState::checkGasTarget ( Scalar  delta_gas)

◆ checkLiquidTarget()

template<class Scalar >
bool Opm::GasLiftStage2< Scalar >::SurplusState::checkLiquidTarget ( Scalar  delta_liquid)

◆ checkOilTarget()

template<class Scalar >
bool Opm::GasLiftStage2< Scalar >::SurplusState::checkOilTarget ( Scalar  delta_oil)

◆ checkWaterTarget()

template<class Scalar >
bool Opm::GasLiftStage2< Scalar >::SurplusState::checkWaterTarget ( Scalar  delta_water)

◆ computeDelta()

template<class Scalar >
std::array< Scalar, 4 > Opm::GasLiftStage2< Scalar >::SurplusState::computeDelta ( const std::string &  name)

◆ updateRates()

template<class Scalar >
void Opm::GasLiftStage2< Scalar >::SurplusState::updateRates ( const std::array< Scalar, 4 > &  delta)

Member Data Documentation

◆ alq

template<class Scalar >
Scalar Opm::GasLiftStage2< Scalar >::SurplusState::alq

◆ gas_rate

template<class Scalar >
Scalar Opm::GasLiftStage2< Scalar >::SurplusState::gas_rate

◆ gas_target

template<class Scalar >
const Scalar Opm::GasLiftStage2< Scalar >::SurplusState::gas_target

◆ group

template<class Scalar >
const Group& Opm::GasLiftStage2< Scalar >::SurplusState::group

◆ it

template<class Scalar >
int Opm::GasLiftStage2< Scalar >::SurplusState::it

◆ liquid_target

template<class Scalar >
const Scalar Opm::GasLiftStage2< Scalar >::SurplusState::liquid_target

◆ max_glift

template<class Scalar >
std::optional<Scalar> Opm::GasLiftStage2< Scalar >::SurplusState::max_glift

◆ max_total_gas

template<class Scalar >
std::optional<Scalar> Opm::GasLiftStage2< Scalar >::SurplusState::max_total_gas

◆ min_eco_grad

template<class Scalar >
const Scalar Opm::GasLiftStage2< Scalar >::SurplusState::min_eco_grad

◆ oil_rate

template<class Scalar >
Scalar Opm::GasLiftStage2< Scalar >::SurplusState::oil_rate

◆ oil_target

template<class Scalar >
const Scalar Opm::GasLiftStage2< Scalar >::SurplusState::oil_target

◆ parent

template<class Scalar >
GasLiftStage2& Opm::GasLiftStage2< Scalar >::SurplusState::parent

◆ water_rate

template<class Scalar >
Scalar Opm::GasLiftStage2< Scalar >::SurplusState::water_rate

◆ water_target

template<class Scalar >
const Scalar Opm::GasLiftStage2< Scalar >::SurplusState::water_target

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