Public Types | Public Member Functions | List of all members
Opm::ReservoirCouplingSlave< Scalar > Class Template Reference

#include <ReservoirCouplingSlave.hpp>

Public Types

using MessageTag = ReservoirCoupling::MessageTag
 
using Potentials = ReservoirCoupling::Potentials< Scalar >
 
using SlaveGroupInjectionData = ReservoirCoupling::SlaveGroupInjectionData< Scalar >
 
using SlaveGroupProductionData = ReservoirCoupling::SlaveGroupProductionData< Scalar >
 
using InjectionGroupTarget = ReservoirCoupling::InjectionGroupTarget< Scalar >
 
using MasterProductionLimits = typename ReservoirCoupling::MasterProductionLimits< Scalar >
 
using ProductionGroupConstraints = ReservoirCoupling::ProductionGroupConstraints< Scalar >
 

Public Member Functions

 ReservoirCouplingSlave (const Parallel::Communication &comm, const Schedule &schedule, const SimulatorTimer &timer)
 
bool activated () const
 
void clearDeferredLogger ()
 
const Parallel::Communication & getComm () const
 
MPI_Comm getMasterComm () const
 
const std::string & getSlaveName () const
 
const std::map< std::string, std::string > & getSlaveToMasterGroupNameMap () const
 
bool hasMasterInjectionTarget (const std::string &gname, const Phase phase) const
 Check if a master-imposed injection target exists for a group and phase. More...
 
bool hasMasterProductionLimits (const std::string &gname) const
 Check if master-imposed per-rate-type production limits exist for a group. More...
 
bool hasMasterProductionTarget (const std::string &gname) const
 Check if a master-imposed production target exists for a group. More...
 
void initTimeStepping ()
 
bool isFirstSubstepOfSyncTimestep () const
 
bool isSlaveGroup (const std::string &group_name) const
 
ReservoirCoupling::Logger & logger ()
 
ReservoirCoupling::Logger & logger () const
 
std::pair< Scalar, Group::InjectionCMode > masterInjectionTarget (const std::string &gname, const Phase phase) const
 Get the master-imposed injection target and control mode for a group and phase. More...
 
const MasterProductionLimits & masterProductionLimits (const std::string &gname) const
 Get the master-imposed per-rate-type production limits for a group. More...
 
std::pair< Scalar, Group::ProductionCMode > masterProductionTarget (const std::string &gname) const
 Get the master-imposed production target and control mode for a group. More...
 
void maybeActivate (int report_step)
 
std::size_t numSlaveGroups () const
 
double receiveNextTimeStepFromMaster ()
 
std::pair< std::size_t, std::size_t > receiveNumGroupConstraintsFromMaster () const
 
void receiveInjectionGroupTargetsFromMaster (std::size_t num_targets)
 Receive injection group targets from master and store them locally. More...
 
void receiveProductionGroupConstraintsFromMaster (std::size_t num_targets)
 Receive production group constraints from master and store them locally. More...
 
void sendAndReceiveInitialData ()
 
void sendInjectionDataToMaster (const std::vector< SlaveGroupInjectionData > &injection_data) const
 
void sendNextReportDateToMasterProcess () const
 
void sendProductionDataToMaster (const std::vector< SlaveGroupProductionData > &production_data) const
 
void setDeferredLogger (DeferredLogger *deferred_logger)
 
void setFirstSubstepOfSyncTimestep (bool value)
 
const std::string & slaveGroupIdxToGroupName (std::size_t group_idx) const
 
bool terminated () const
 
bool maybeReceiveTerminateSignalFromMaster ()
 Blocking receive for terminate/continue signal from master. More...
 
void receiveTerminateAndDisconnect ()
 Receive terminate signal from master and disconnect the intercommunicator. More...
 

Member Typedef Documentation

◆ InjectionGroupTarget

template<class Scalar >
using Opm::ReservoirCouplingSlave< Scalar >::InjectionGroupTarget = ReservoirCoupling::InjectionGroupTarget<Scalar>

◆ MasterProductionLimits

template<class Scalar >
using Opm::ReservoirCouplingSlave< Scalar >::MasterProductionLimits = typename ReservoirCoupling::MasterProductionLimits<Scalar>

◆ MessageTag

template<class Scalar >
using Opm::ReservoirCouplingSlave< Scalar >::MessageTag = ReservoirCoupling::MessageTag

◆ Potentials

template<class Scalar >
using Opm::ReservoirCouplingSlave< Scalar >::Potentials = ReservoirCoupling::Potentials<Scalar>

◆ ProductionGroupConstraints

template<class Scalar >
using Opm::ReservoirCouplingSlave< Scalar >::ProductionGroupConstraints = ReservoirCoupling::ProductionGroupConstraints<Scalar>

◆ SlaveGroupInjectionData

template<class Scalar >
using Opm::ReservoirCouplingSlave< Scalar >::SlaveGroupInjectionData = ReservoirCoupling::SlaveGroupInjectionData<Scalar>

◆ SlaveGroupProductionData

template<class Scalar >
using Opm::ReservoirCouplingSlave< Scalar >::SlaveGroupProductionData = ReservoirCoupling::SlaveGroupProductionData<Scalar>

Constructor & Destructor Documentation

◆ ReservoirCouplingSlave()

template<class Scalar >
Opm::ReservoirCouplingSlave< Scalar >::ReservoirCouplingSlave ( const Parallel::Communication &  comm,
const Schedule &  schedule,
const SimulatorTimer &  timer 
)

Member Function Documentation

◆ activated()

template<class Scalar >
bool Opm::ReservoirCouplingSlave< Scalar >::activated ( ) const
inline

◆ clearDeferredLogger()

template<class Scalar >
void Opm::ReservoirCouplingSlave< Scalar >::clearDeferredLogger ( )
inline

References Opm::ReservoirCoupling::Logger::clearDeferredLogger().

◆ getComm()

template<class Scalar >
const Parallel::Communication & Opm::ReservoirCouplingSlave< Scalar >::getComm ( ) const
inline

◆ getMasterComm()

template<class Scalar >
MPI_Comm Opm::ReservoirCouplingSlave< Scalar >::getMasterComm ( ) const
inline

◆ getSlaveName()

template<class Scalar >
const std::string & Opm::ReservoirCouplingSlave< Scalar >::getSlaveName ( ) const
inline

◆ getSlaveToMasterGroupNameMap()

template<class Scalar >
const std::map< std::string, std::string > & Opm::ReservoirCouplingSlave< Scalar >::getSlaveToMasterGroupNameMap ( ) const
inline

◆ hasMasterInjectionTarget()

template<class Scalar >
bool Opm::ReservoirCouplingSlave< Scalar >::hasMasterInjectionTarget ( const std::string &  gname,
const Phase  phase 
) const

Check if a master-imposed injection target exists for a group and phase.

Delegates to ReservoirCouplingSlaveReportStep

◆ hasMasterProductionLimits()

template<class Scalar >
bool Opm::ReservoirCouplingSlave< Scalar >::hasMasterProductionLimits ( const std::string &  gname) const

Check if master-imposed per-rate-type production limits exist for a group.

Delegates to ReservoirCouplingSlaveReportStep

◆ hasMasterProductionTarget()

template<class Scalar >
bool Opm::ReservoirCouplingSlave< Scalar >::hasMasterProductionTarget ( const std::string &  gname) const

Check if a master-imposed production target exists for a group.

Delegates to ReservoirCouplingSlaveReportStep

◆ initTimeStepping()

template<class Scalar >
void Opm::ReservoirCouplingSlave< Scalar >::initTimeStepping ( )

◆ isFirstSubstepOfSyncTimestep()

template<class Scalar >
bool Opm::ReservoirCouplingSlave< Scalar >::isFirstSubstepOfSyncTimestep ( ) const

◆ isSlaveGroup()

template<class Scalar >
bool Opm::ReservoirCouplingSlave< Scalar >::isSlaveGroup ( const std::string &  group_name) const

◆ logger() [1/2]

template<class Scalar >
ReservoirCoupling::Logger & Opm::ReservoirCouplingSlave< Scalar >::logger ( )
inline

◆ logger() [2/2]

template<class Scalar >
ReservoirCoupling::Logger & Opm::ReservoirCouplingSlave< Scalar >::logger ( ) const
inline

◆ masterInjectionTarget()

template<class Scalar >
std::pair< Scalar, Group::InjectionCMode > Opm::ReservoirCouplingSlave< Scalar >::masterInjectionTarget ( const std::string &  gname,
const Phase  phase 
) const

Get the master-imposed injection target and control mode for a group and phase.

Delegates to ReservoirCouplingSlaveReportStep

◆ masterProductionLimits()

template<class Scalar >
const MasterProductionLimits & Opm::ReservoirCouplingSlave< Scalar >::masterProductionLimits ( const std::string &  gname) const

Get the master-imposed per-rate-type production limits for a group.

Delegates to ReservoirCouplingSlaveReportStep

◆ masterProductionTarget()

template<class Scalar >
std::pair< Scalar, Group::ProductionCMode > Opm::ReservoirCouplingSlave< Scalar >::masterProductionTarget ( const std::string &  gname) const

Get the master-imposed production target and control mode for a group.

Delegates to ReservoirCouplingSlaveReportStep

◆ maybeActivate()

template<class Scalar >
void Opm::ReservoirCouplingSlave< Scalar >::maybeActivate ( int  report_step)

◆ maybeReceiveTerminateSignalFromMaster()

template<class Scalar >
bool Opm::ReservoirCouplingSlave< Scalar >::maybeReceiveTerminateSignalFromMaster ( )

Blocking receive for terminate/continue signal from master.

This method is called at the start of each timestep iteration in the slave's substep loop. Master sends 0 (continue) or 1 (terminate) at each iteration. If terminate signal (value != 0) is received, disconnects the intercommunicator, sets the terminated flag, and returns true.

Returns
true if terminate signal received and disconnect completed, false to continue.

◆ numSlaveGroups()

template<class Scalar >
std::size_t Opm::ReservoirCouplingSlave< Scalar >::numSlaveGroups ( ) const
inline

◆ receiveInjectionGroupTargetsFromMaster()

template<class Scalar >
void Opm::ReservoirCouplingSlave< Scalar >::receiveInjectionGroupTargetsFromMaster ( std::size_t  num_targets)

Receive injection group targets from master and store them locally.

Delegates to ReservoirCouplingSlaveReportStep

◆ receiveNextTimeStepFromMaster()

template<class Scalar >
double Opm::ReservoirCouplingSlave< Scalar >::receiveNextTimeStepFromMaster ( )

◆ receiveNumGroupConstraintsFromMaster()

template<class Scalar >
std::pair< std::size_t, std::size_t > Opm::ReservoirCouplingSlave< Scalar >::receiveNumGroupConstraintsFromMaster ( ) const

◆ receiveProductionGroupConstraintsFromMaster()

template<class Scalar >
void Opm::ReservoirCouplingSlave< Scalar >::receiveProductionGroupConstraintsFromMaster ( std::size_t  num_targets)

Receive production group constraints from master and store them locally.

Delegates to ReservoirCouplingSlaveReportStep

◆ receiveTerminateAndDisconnect()

template<class Scalar >
void Opm::ReservoirCouplingSlave< Scalar >::receiveTerminateAndDisconnect ( )

Receive terminate signal from master and disconnect the intercommunicator.

This method must be called at the end of the simulation to cleanly shut down the MPI intercommunicator created when the slave was spawned. It performs two steps:

  1. Receives a terminate signal from master (only on rank 0, then broadcast)
  2. Disconnects the intercommunicator (collective operation)

Both master and slaves must call their respective disconnect methods for MPI_Comm_disconnect() to complete - it is a collective operation.

◆ sendAndReceiveInitialData()

template<class Scalar >
void Opm::ReservoirCouplingSlave< Scalar >::sendAndReceiveInitialData ( )

◆ sendInjectionDataToMaster()

template<class Scalar >
void Opm::ReservoirCouplingSlave< Scalar >::sendInjectionDataToMaster ( const std::vector< SlaveGroupInjectionData > &  injection_data) const

◆ sendNextReportDateToMasterProcess()

template<class Scalar >
void Opm::ReservoirCouplingSlave< Scalar >::sendNextReportDateToMasterProcess ( ) const

◆ sendProductionDataToMaster()

template<class Scalar >
void Opm::ReservoirCouplingSlave< Scalar >::sendProductionDataToMaster ( const std::vector< SlaveGroupProductionData > &  production_data) const

◆ setDeferredLogger()

template<class Scalar >
void Opm::ReservoirCouplingSlave< Scalar >::setDeferredLogger ( DeferredLogger *  deferred_logger)
inline

References Opm::ReservoirCoupling::Logger::setDeferredLogger().

◆ setFirstSubstepOfSyncTimestep()

template<class Scalar >
void Opm::ReservoirCouplingSlave< Scalar >::setFirstSubstepOfSyncTimestep ( bool  value)

◆ slaveGroupIdxToGroupName()

template<class Scalar >
const std::string & Opm::ReservoirCouplingSlave< Scalar >::slaveGroupIdxToGroupName ( std::size_t  group_idx) const
inline

◆ terminated()

template<class Scalar >
bool Opm::ReservoirCouplingSlave< Scalar >::terminated ( ) const
inline
The documentation for this class was generated from the following file: