Public Types | Public Member Functions | Public Attributes | List of all members
Opm::GasLiftSingleWellGeneric< Scalar >::LimitedRates Struct Reference

#include <GasLiftSingleWellGeneric.hpp>

Inheritance diagram for Opm::GasLiftSingleWellGeneric< Scalar >::LimitedRates:
Inheritance graph

Public Types

enum class  LimitType { well , group , none }
 

Public Member Functions

 LimitedRates (Scalar oil_, Scalar gas_, Scalar water_, bool oil_is_limited_, bool gas_is_limited_, bool water_is_limited_, bool bhp_is_limited_, std::optional< Rate > oil_limiting_target_, std ::optional< Rate > water_limiting_target_)
 
 LimitedRates (const BasicRates &rates, bool oil_is_limited_, bool gas_is_limited_, bool water_is_limited_)
 
bool limited () const
 
Scalar operator[] (Rate rate_type) const
 

Public Attributes

LimitType limit_type
 
bool oil_is_limited
 
bool gas_is_limited
 
bool water_is_limited
 
std::optional< Rate > oil_limiting_target
 
std::optional< Rate > water_limiting_target
 
Scalar oil
 
Scalar gas
 
Scalar water
 
bool bhp_is_limited
 

Member Enumeration Documentation

◆ LimitType

template<class Scalar >
enum class Opm::GasLiftSingleWellGeneric::LimitedRates::LimitType
strong
Enumerator
well 
group 
none 

Constructor & Destructor Documentation

◆ LimitedRates() [1/2]

template<class Scalar >
Opm::GasLiftSingleWellGeneric< Scalar >::LimitedRates::LimitedRates ( Scalar  oil_,
Scalar  gas_,
Scalar  water_,
bool  oil_is_limited_,
bool  gas_is_limited_,
bool  water_is_limited_,
bool  bhp_is_limited_,
std::optional< Rate >  oil_limiting_target_,
std ::optional< Rate >  water_limiting_target_ 
)
inline

◆ LimitedRates() [2/2]

template<class Scalar >
Opm::GasLiftSingleWellGeneric< Scalar >::LimitedRates::LimitedRates ( const BasicRates &  rates,
bool  oil_is_limited_,
bool  gas_is_limited_,
bool  water_is_limited_ 
)
inline

Member Function Documentation

◆ limited()

template<class Scalar >
bool Opm::GasLiftSingleWellGeneric< Scalar >::LimitedRates::limited ( ) const
inline

References Opm::GasLiftSingleWellGeneric< Scalar >::LimitedRates::gas_is_limited, Opm::GasLiftSingleWellGeneric< Scalar >::LimitedRates::oil_is_limited, and Opm::GasLiftSingleWellGeneric< Scalar >::LimitedRates::water_is_limited.

◆ operator[]()

template<class Scalar >
Scalar Opm::GasLiftSingleWellGeneric< Scalar >::BasicRates::operator[] ( Rate  rate_type) const
inlineinherited

References Opm::GasLiftSingleWellGeneric< Scalar >::BasicRates::gas, Opm::RegionAttributeHelpers::PhaseUsed::gas(), Opm::GasLiftSingleWellGeneric< Scalar >::BasicRates::oil, Opm::RegionAttributeHelpers::PhaseUsed::oil(), Opm::GasLiftSingleWellGeneric< Scalar >::BasicRates::water, and Opm::RegionAttributeHelpers::PhaseUsed::water().

Member Data Documentation

◆ bhp_is_limited

template<class Scalar >
bool Opm::GasLiftSingleWellGeneric< Scalar >::BasicRates::bhp_is_limited
inherited

Referenced by Opm::GasLiftSingleWellGeneric< Scalar >::BasicRates::operator=().

◆ gas

template<class Scalar >
Scalar Opm::GasLiftSingleWellGeneric< Scalar >::BasicRates::gas
inherited

Referenced by Opm::GasLiftSingleWellGeneric< Scalar >::BasicRates::operator=(), and Opm::GasLiftSingleWellGeneric< Scalar >::BasicRates::operator[]().

◆ gas_is_limited

template<class Scalar >
bool Opm::GasLiftSingleWellGeneric< Scalar >::LimitedRates::gas_is_limited

Referenced by Opm::GasLiftSingleWellGeneric< Scalar >::LimitedRates::limited().

◆ limit_type

template<class Scalar >
LimitType Opm::GasLiftSingleWellGeneric< Scalar >::LimitedRates::limit_type

◆ oil

template<class Scalar >
Scalar Opm::GasLiftSingleWellGeneric< Scalar >::BasicRates::oil
inherited

Referenced by Opm::GasLiftSingleWellGeneric< Scalar >::BasicRates::operator=(), and Opm::GasLiftSingleWellGeneric< Scalar >::BasicRates::operator[]().

◆ oil_is_limited

template<class Scalar >
bool Opm::GasLiftSingleWellGeneric< Scalar >::LimitedRates::oil_is_limited

Referenced by Opm::GasLiftSingleWellGeneric< Scalar >::LimitedRates::limited().

◆ oil_limiting_target

template<class Scalar >
std::optional<Rate> Opm::GasLiftSingleWellGeneric< Scalar >::LimitedRates::oil_limiting_target

◆ water

template<class Scalar >
Scalar Opm::GasLiftSingleWellGeneric< Scalar >::BasicRates::water
inherited

Referenced by Opm::GasLiftSingleWellGeneric< Scalar >::BasicRates::operator=(), and Opm::GasLiftSingleWellGeneric< Scalar >::BasicRates::operator[]().

◆ water_is_limited

template<class Scalar >
bool Opm::GasLiftSingleWellGeneric< Scalar >::LimitedRates::water_is_limited

Referenced by Opm::GasLiftSingleWellGeneric< Scalar >::LimitedRates::limited().

◆ water_limiting_target

template<class Scalar >
std::optional<Rate> Opm::GasLiftSingleWellGeneric< Scalar >::LimitedRates::water_limiting_target
The documentation for this struct was generated from the following file: