Opm::GasLiftCommon Class Reference

#include <GasLiftCommon.hpp>

Inheritance diagram for Opm::GasLiftCommon:

Public Member Functions
virtual	~GasLiftCommon ()=default

Protected Types
enum class	MessageType { INFO , WARNING }

Protected Member Functions
	GasLiftCommon (WellState< double > &well_state, const GroupState< double > &group_state, DeferredLogger &deferred_logger, const Parallel::Communication &comm, bool 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< double > &	well_state_
const GroupState< double > &	group_state_
DeferredLogger &	deferred_logger_
const Parallel::Communication &	comm_
bool	debug
bool	debug_output_only_on_rank0 = false

Member Enumeration Documentation

MessageType

enum class Opm::GasLiftCommon::MessageType

strongprotected

Enumerator
INFO
WARNING

Constructor & Destructor Documentation

~GasLiftCommon()

virtual Opm::GasLiftCommon::~GasLiftCommon ( )

virtualdefault

GasLiftCommon()

Opm::GasLiftCommon::GasLiftCommon ( WellState< double > &  well_state, const GroupState< double > &  group_state, DeferredLogger &  deferred_logger, const Parallel::Communication &  comm, bool  debug  )

protected

Member Function Documentation

debugUpdateGlobalCounter_()

int Opm::GasLiftCommon::debugUpdateGlobalCounter_ ( ) const

protected

displayDebugMessage_()

virtual void Opm::GasLiftCommon::displayDebugMessage_ ( const std::string &  msg ) const

protectedpure virtual

Implemented in Opm::GasLiftGroupInfo, Opm::GasLiftSingleWellGeneric, and Opm::GasLiftStage2.

displayDebugMessageOnRank0_()

void Opm::GasLiftCommon::displayDebugMessageOnRank0_ ( const std::string &  msg ) const

protected

logMessage_()

void Opm::GasLiftCommon::logMessage_ ( const std::string &  prefix, const std::string &  msg, MessageType  msg_type = MessageType::INFO  ) const

protected

Member Data Documentation

comm_

const Parallel::Communication& Opm::GasLiftCommon::comm_

protected

debug

bool Opm::GasLiftCommon::debug

protected

debug_output_only_on_rank0

bool Opm::GasLiftCommon::debug_output_only_on_rank0 = false

protected

deferred_logger_

DeferredLogger& Opm::GasLiftCommon::deferred_logger_

protected

group_state_

const GroupState<double>& Opm::GasLiftCommon::group_state_

protected

well_state_

WellState<double>& Opm::GasLiftCommon::well_state_

protected

Referenced by Opm::GasLiftSingleWell< TypeTag >::GasLiftSingleWell().

---

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

• GasLiftCommon.hpp