Opm::wellhelpers::WellSwitchingLogger Class Reference

Utility class to handle the log messages about well switching. More...

#include <WellSwitchingLogger.hpp>

Public Types

typedef Dune::CollectiveCommunication< typename Dune::MPIHelper::MPICommunicator > Communication
 The type of the collective communication used.
 

Public Member Functions

 WellSwitchingLogger (const Communication &cc=Dune::MPIHelper::getCollectiveCommunication())
 Constructor. More...
 
void wellSwitched (std::string name, WellControlType from, WellControlType to)
 Log that a well switched. More...
 
 ~WellSwitchingLogger ()
 Destructor send does the actual logging.
 

Detailed Description

Utility class to handle the log messages about well switching.

In parallel all the messages will be send to a root processor and logged there.

Constructor & Destructor Documentation

◆ WellSwitchingLogger()

Opm::wellhelpers::WellSwitchingLogger::WellSwitchingLogger ( const Communication cc = Dune::MPIHelper::getCollectiveCommunication())
inlineexplicit

Constructor.

Parameters
ccThe collective communication to use.

Member Function Documentation

◆ wellSwitched()

void Opm::wellhelpers::WellSwitchingLogger::wellSwitched ( std::string  name,
WellControlType  from,
WellControlType  to 
)
inline

Log that a well switched.

Parameters
nameThe name of the well.
fromThe control of the well before the switch.
toThe control of the well after the switch.

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