OPM - Reference Documentation for opm-autodiff

#include <GasLiftCommon.hpp>

Inheritance diagram for Opm::GasLiftCommon< Scalar, IndexTraits >:

Inheritance graph

Public Member Functions
virtual	~GasLiftCommon ()=default

Protected Types
enum class	MessageType { INFO , WARNING }

Protected Member Functions
	GasLiftCommon (WellState< Scalar, IndexTraits > &well_state, const GroupState< Scalar > &group_state, DeferredLogger &deferred_logger, const Parallel::Communication &comm, bool glift_debug)

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, IndexTraits > &	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<typename Scalar , typename IndexTraits >

enum class Opm::GasLiftCommon::MessageType

strongprotected

Enumerator
INFO
WARNING

Constructor & Destructor Documentation

◆ ~GasLiftCommon()

template<typename Scalar , typename IndexTraits >

virtual Opm::GasLiftCommon< Scalar, IndexTraits >::~GasLiftCommon ( )

virtualdefault

◆ GasLiftCommon()

template<typename Scalar , typename IndexTraits >

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

protected

Member Function Documentation

◆ displayDebugMessage_()

template<typename Scalar , typename IndexTraits >

virtual void Opm::GasLiftCommon< Scalar, IndexTraits >::displayDebugMessage_ ( const std::string & msg ) const

protectedpure virtual

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

◆ displayDebugMessageOnRank0_()

template<typename Scalar , typename IndexTraits >

void Opm::GasLiftCommon< Scalar, IndexTraits >::displayDebugMessageOnRank0_ ( const std::string & msg ) const

protected

◆ logMessage_()

template<typename Scalar , typename IndexTraits >

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

protected

Member Data Documentation

◆ comm_

template<typename Scalar , typename IndexTraits >

const Parallel::Communication& Opm::GasLiftCommon< Scalar, IndexTraits >::comm_

protected

◆ debug

template<typename Scalar , typename IndexTraits >

bool Opm::GasLiftCommon< Scalar, IndexTraits >::debug

protected

◆ debug_output_only_on_rank0

template<typename Scalar , typename IndexTraits >

bool Opm::GasLiftCommon< Scalar, IndexTraits >::debug_output_only_on_rank0 = false

protected

◆ deferred_logger_

template<typename Scalar , typename IndexTraits >

DeferredLogger& Opm::GasLiftCommon< Scalar, IndexTraits >::deferred_logger_

protected

◆ group_state_

template<typename Scalar , typename IndexTraits >

const GroupState<Scalar>& Opm::GasLiftCommon< Scalar, IndexTraits >::group_state_

protected

◆ well_state_

template<typename Scalar , typename IndexTraits >

WellState<Scalar, IndexTraits>& Opm::GasLiftCommon< Scalar, IndexTraits >::well_state_

protected

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

GasLiftCommon.hpp