Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
Opm::GasLiftCommon< Scalar > Class Template Referenceabstract

#include <GasLiftCommon.hpp>

Inheritance diagram for Opm::GasLiftCommon< Scalar >:
Inheritance graph

Public Member Functions

virtual ~GasLiftCommon ()=default
 

Protected Types

enum class  MessageType { INFO , WARNING }
 

Protected Member Functions

 GasLiftCommon (WellState< Scalar > &well_state, const GroupState< Scalar > &group_state, DeferredLogger &deferred_logger, const Parallel::Communication &comm, bool glift_debug)
 
int debugUpdateGlobalCounter_ () const
 
virtual void displayDebugMessage_ (const std::string &msg) const =0
 
void displayDebugMessageOnRank0_ (const std::string &msg) const
 
void logMessage_ (const std::string &prefix, const std::string &msg, MessageType msg_type=MessageType::INFO) const
 

Protected Attributes

WellState< Scalar > & well_state_
 
const GroupState< Scalar > & group_state_
 
DeferredLogger & deferred_logger_
 
const Parallel::Communication & comm_
 
bool debug
 
bool debug_output_only_on_rank0 = false
 

Member Enumeration Documentation

◆ MessageType

template<class Scalar >
enum class Opm::GasLiftCommon::MessageType
strongprotected
Enumerator
INFO 
WARNING 

Constructor & Destructor Documentation

◆ ~GasLiftCommon()

template<class Scalar >
virtual Opm::GasLiftCommon< Scalar >::~GasLiftCommon ( )
virtualdefault

◆ GasLiftCommon()

template<class Scalar >
Opm::GasLiftCommon< Scalar >::GasLiftCommon ( WellState< Scalar > &  well_state,
const GroupState< Scalar > &  group_state,
DeferredLogger &  deferred_logger,
const Parallel::Communication &  comm,
bool  glift_debug 
)
protected

Member Function Documentation

◆ debugUpdateGlobalCounter_()

template<class Scalar >
int Opm::GasLiftCommon< Scalar >::debugUpdateGlobalCounter_ ( ) const
protected

◆ displayDebugMessage_()

template<class Scalar >
virtual void Opm::GasLiftCommon< Scalar >::displayDebugMessage_ ( const std::string &  msg) const
protectedpure virtual

Implemented in Opm::GasLiftGroupInfo< Scalar >, Opm::GasLiftGroupInfo< GetPropType< TypeTag, Properties::Scalar > >, Opm::GasLiftSingleWellGeneric< Scalar >, Opm::GasLiftSingleWellGeneric< GetPropType< TypeTag, Properties::Scalar > >, and Opm::GasLiftStage2< Scalar >.

◆ displayDebugMessageOnRank0_()

template<class Scalar >
void Opm::GasLiftCommon< Scalar >::displayDebugMessageOnRank0_ ( const std::string &  msg) const
protected

◆ logMessage_()

template<class Scalar >
void Opm::GasLiftCommon< Scalar >::logMessage_ ( const std::string &  prefix,
const std::string &  msg,
MessageType  msg_type = MessageType::INFO 
) const
protected

Member Data Documentation

◆ comm_

template<class Scalar >
const Parallel::Communication& Opm::GasLiftCommon< Scalar >::comm_
protected

◆ debug

template<class Scalar >
bool Opm::GasLiftCommon< Scalar >::debug
protected

◆ debug_output_only_on_rank0

template<class Scalar >
bool Opm::GasLiftCommon< Scalar >::debug_output_only_on_rank0 = false
protected

◆ deferred_logger_

template<class Scalar >
DeferredLogger& Opm::GasLiftCommon< Scalar >::deferred_logger_
protected

◆ group_state_

template<class Scalar >
const GroupState<Scalar>& Opm::GasLiftCommon< Scalar >::group_state_
protected

◆ well_state_

template<class Scalar >
WellState<Scalar>& Opm::GasLiftCommon< Scalar >::well_state_
protected
The documentation for this class was generated from the following file: