Manages master-side reservoir coupling operations for a single report step. More...

#include <ReservoirCouplingMasterReportStep.hpp>

Public Types
using	MessageTag = ReservoirCoupling::MessageTag
using	Potentials = ReservoirCoupling::Potentials<Scalar>
using	SlaveGroupProductionData = ReservoirCoupling::SlaveGroupProductionData<Scalar>
using	SlaveGroupInjectionData = ReservoirCoupling::SlaveGroupInjectionData<Scalar>
using	InjectionGroupTarget = ReservoirCoupling::InjectionGroupTarget<Scalar>
using	ProductionGroupConstraints = ReservoirCoupling::ProductionGroupConstraints<Scalar>

Public Member Functions
	ReservoirCouplingMasterReportStep (ReservoirCouplingMaster< Scalar > &master)
	Construct a report step manager for the master process.
const Parallel::Communication &	comm () const
	Get the MPI communicator for master-slave communication.
const std::vector< std::string > &	getMasterGroupNamesForSlave (std::size_t slave_idx) const
	Get the names of master groups associated with a specific slave.
const std::map< std::string, std::string > &	getMasterGroupToSlaveNameMap () const
	Get the mapping from master group names to slave names.
std::size_t	getMasterGroupCanonicalIdx (const std::string &slave_name, const std::string &master_group_name) const
	Get the canonical index for a master group.
MPI_Comm	getSlaveComm (int index) const
	Get the MPI communicator for a specific slave process.
Scalar	getMasterGroupInjectionSurfaceRate (const std::string &group_name, ReservoirCoupling::Phase phase) const
	Get the injection surface rate for a master group.
Scalar	getMasterGroupInjectionReservoirRate (const std::string &group_name, ReservoirCoupling::Phase phase) const
	Get the injection reservoir rate for a master group.
Scalar	getMasterGroupProductionSurfaceRate (const std::string &group_name, ReservoirCoupling::Phase phase) const
	Get the production surface rate for a master group.
Scalar	getMasterGroupNetworkProductionSurfaceRate (const std::string &group_name, ReservoirCoupling::Phase phase) const
	Get the network production surface rate for a master group.
Scalar	getMasterGroupProductionReservoirRate (const std::string &group_name, ReservoirCoupling::Phase phase) const
	Get the production reservoir rate for a master group.
const Potentials &	getSlaveGroupPotentials (const std::string &master_group_name) const
	Get the production potentials for a slave group.
bool	isFirstSubstepOfSyncTimestep () const
	Check if this is the first substep within a "sync" timestep.
bool	needsSlaveDataReceive () const
	Check if the master needs to receive slave data at the next timeStepSucceeded() call.
void	setNeedsSlaveDataReceive (bool value)
	Set/clear the flag for pending slave data receive.
std::size_t	numSlaveGroups (unsigned int index) const
	Get the number of slave groups for a specific slave process.
std::size_t	numSlaves () const
	Get the total number of active slave processes.
ReservoirCoupling::Logger &	logger () const
	Get the logger for reservoir coupling operations.
void	receiveInjectionDataFromSlaves ()
	Receive injection data from all active slave processes.
void	receiveProductionDataFromSlaves ()
	Receive production data from all active slave processes.
const Schedule &	schedule () const
	Get the simulation schedule.
void	sendInjectionTargetsToSlave (std::size_t slave_idx, const std::vector< InjectionGroupTarget > &injection_targets) const
void	sendNumGroupConstraintsToSlave (std::size_t slave_idx, std::size_t num_injection_targets, std::size_t num_production_constraints) const
void	sendProductionConstraintsToSlave (std::size_t slave_idx, const std::vector< ProductionGroupConstraints > &production_constraints) const
void	setFirstSubstepOfSyncTimestep (bool value)
	Set whether this is the first substep within a "sync" timestep.
void	setReportStepIdx (int report_step_idx)
	Set the current report step index.
bool	slaveIsActivated (int index) const
	Check if a specific slave process has been activated.
const std::string &	slaveName (int index) const
	Get the name of a specific slave process.

Detailed Description

template<class Scalar>
class Opm::ReservoirCouplingMasterReportStep< Scalar >

Manages master-side reservoir coupling operations for a single report step.

This class encapsulates the master process's communication and coordination with slave processes during a single report step in reservoir coupling simulations. It handles:

Receiving production and injection data from slave processes via MPI
Sending group control information and constraints to slaves
Managing slave group potentials and production/injection data
Coordinating the exchange of information between master and slave groups

The class serves as a helper to ReservoirCouplingMaster, separating the report-step-specific logic from the overall coupling lifecycle management. This separation improves code organization and makes the coupling logic easier to understand and maintain.

Template Parameters

Scalar Floating-point type for rate and potential values (typically double or float)

Note: This class holds references to the parent ReservoirCouplingMaster object and should only be used within the scope of that object's lifetime

See also: ReservoirCouplingMaster

Constructor & Destructor Documentation

◆ ReservoirCouplingMasterReportStep()

template<class Scalar>

Opm::ReservoirCouplingMasterReportStep< Scalar >::ReservoirCouplingMasterReportStep ( ReservoirCouplingMaster< Scalar > & master )

Construct a report step manager for the master process.

Parameters

master Reference to the parent ReservoirCouplingMaster object

Member Function Documentation

◆ comm()

template<class Scalar>

const Parallel::Communication & Opm::ReservoirCouplingMasterReportStep< Scalar >::comm ( ) const

inline

Get the MPI communicator for master-slave communication.

Returns: Reference to the parallel communication object

◆ getMasterGroupCanonicalIdx()

template<class Scalar>

std::size_t Opm::ReservoirCouplingMasterReportStep< Scalar >::getMasterGroupCanonicalIdx	(	const std::string &	slave_name,
		const std::string &	master_group_name ) const

Get the canonical index for a master group.

Parameters

slave_name	Name of the slave process
master_group_name	Name of the master group

Returns: Canonical index for the specified master group in the context of the slave

◆ getMasterGroupInjectionReservoirRate()

template<class Scalar>

Scalar Opm::ReservoirCouplingMasterReportStep< Scalar >::getMasterGroupInjectionReservoirRate	(	const std::string &	group_name,
		ReservoirCoupling::Phase	phase ) const

Get the injection reservoir rate for a master group.

Parameters

group_name	Name of the master group
phase	ReservoirCoupling::Phase enum (Oil, Gas, or Water)

Returns: Injection reservoir rate for the specified phase

◆ getMasterGroupInjectionSurfaceRate()

template<class Scalar>

Scalar Opm::ReservoirCouplingMasterReportStep< Scalar >::getMasterGroupInjectionSurfaceRate	(	const std::string &	group_name,
		ReservoirCoupling::Phase	phase ) const

Get the injection surface rate for a master group.

Parameters

group_name	Name of the master group
phase	ReservoirCoupling::Phase enum (Oil, Gas, or Water)

Returns: Injection surface rate for the specified phase

◆ getMasterGroupNamesForSlave()

template<class Scalar>

const std::vector< std::string > & Opm::ReservoirCouplingMasterReportStep< Scalar >::getMasterGroupNamesForSlave ( std::size_t slave_idx ) const

inline

Get the names of master groups associated with a specific slave.

Parameters

slave_idx Index of the slave process

Returns: Vector of master group names that this slave is connected to

◆ getMasterGroupNetworkProductionSurfaceRate()

template<class Scalar>

Scalar Opm::ReservoirCouplingMasterReportStep< Scalar >::getMasterGroupNetworkProductionSurfaceRate	(	const std::string &	group_name,
		ReservoirCoupling::Phase	phase ) const

Get the network production surface rate for a master group.

This returns the production rate computed with network=true, meaning efficiency factors are 1.0 for groups/wells where GEFAC/WEFAC item 3 = "NO". This is used for network leaf node rate calculations.

Parameters

group_name	Name of the master group
phase	ReservoirCoupling::Phase enum (Oil, Gas, or Water)

Returns: Network production surface rate for the specified phase

◆ getMasterGroupProductionReservoirRate()

template<class Scalar>

Scalar Opm::ReservoirCouplingMasterReportStep< Scalar >::getMasterGroupProductionReservoirRate	(	const std::string &	group_name,
		ReservoirCoupling::Phase	phase ) const

Get the production reservoir rate for a master group.

This returns the production rate at reservoir conditions, computed using the slave's PVT properties. This is needed when the master's parent group has RESV control mode, so the conversion uses slave's formation volume factors rather than master's.

Parameters

group_name	Name of the master group
phase	ReservoirCoupling::Phase enum (Oil, Gas, or Water)

Returns: Production reservoir rate for the specified phase

◆ getMasterGroupProductionSurfaceRate()

template<class Scalar>

Scalar Opm::ReservoirCouplingMasterReportStep< Scalar >::getMasterGroupProductionSurfaceRate	(	const std::string &	group_name,
		ReservoirCoupling::Phase	phase ) const

Get the production surface rate for a master group.

Parameters

group_name	Name of the master group
phase	ReservoirCoupling::Phase enum (Oil, Gas, or Water)

Returns: Production surface rate for the specified phase

◆ getMasterGroupToSlaveNameMap()

template<class Scalar>

const std::map< std::string, std::string > & Opm::ReservoirCouplingMasterReportStep< Scalar >::getMasterGroupToSlaveNameMap ( ) const

inline

Get the mapping from master group names to slave names.

Returns: Map from master group name to the corresponding slave name

◆ getSlaveComm()

template<class Scalar>

MPI_Comm Opm::ReservoirCouplingMasterReportStep< Scalar >::getSlaveComm ( int index ) const

inline

Get the MPI communicator for a specific slave process.

Parameters

index Index of the slave process

Returns: MPI communicator handle for communication with the specified slave

◆ getSlaveGroupPotentials()

template<class Scalar>

const ReservoirCoupling::Potentials< Scalar > & Opm::ReservoirCouplingMasterReportStep< Scalar >::getSlaveGroupPotentials ( const std::string & master_group_name ) const

Get the production potentials for a slave group.

Parameters

master_group_name Name of the master group

Returns: Reference to the potentials data for the specified group

◆ isFirstSubstepOfSyncTimestep()

template<class Scalar>

bool Opm::ReservoirCouplingMasterReportStep< Scalar >::isFirstSubstepOfSyncTimestep ( ) const

inline

Check if this is the first substep within a "sync" timestep.

This flag is used to control reservoir coupling synchronization. Master-slave data exchange should only happen at the start of each "sync" timestep, not on internal substeps or at retries after convergence chops.

Returns: true if this is the first substep of a "sync" timestep, false if not

◆ logger()

template<class Scalar>

ReservoirCoupling::Logger & Opm::ReservoirCouplingMasterReportStep< Scalar >::logger ( ) const

inline

Get the logger for reservoir coupling operations.

Returns: Reference to the logger object for this coupling session

◆ needsSlaveDataReceive()

template<class Scalar>

bool Opm::ReservoirCouplingMasterReportStep< Scalar >::needsSlaveDataReceive ( ) const

inline

Check if the master needs to receive slave data at the next timeStepSucceeded() call.

The slave data is needed for correct summary output.

◆ numSlaveGroups()

template<class Scalar>

std::size_t Opm::ReservoirCouplingMasterReportStep< Scalar >::numSlaveGroups ( unsigned int index ) const

inline

Get the number of slave groups for a specific slave process.

Parameters

index Index of the slave process

Returns: Number of groups managed by the specified slave

◆ numSlaves()

template<class Scalar>

std::size_t Opm::ReservoirCouplingMasterReportStep< Scalar >::numSlaves ( ) const

inline

Get the total number of active slave processes.

Returns: Number of slaves that have been started

◆ receiveInjectionDataFromSlaves()

template<class Scalar>

void Opm::ReservoirCouplingMasterReportStep< Scalar >::receiveInjectionDataFromSlaves ( )

Receive injection data from all active slave processes.

This method receives injection rates and related data from each slave process via MPI communication. The data is organized by slave groups and stored in slave_group_injection_data_ for use in group control calculations.

Note: This is a blocking operation that waits for all slaves to send data; Must be called after slaves have computed and sent their injection data

◆ receiveProductionDataFromSlaves()

template<class Scalar>

void Opm::ReservoirCouplingMasterReportStep< Scalar >::receiveProductionDataFromSlaves ( )

Receive production data from all active slave processes.

This method receives production rates, potentials, and related data from each slave process via MPI communication. The data is organized by slave groups and stored in slave_group_production_data_ for use in group control calculations.

Note: This is a blocking operation that waits for all slaves to send data; Must be called after slaves have computed and sent their production data

◆ schedule()

template<class Scalar>

const Schedule & Opm::ReservoirCouplingMasterReportStep< Scalar >::schedule ( ) const

inline

Get the simulation schedule.

Returns: Reference to the Schedule object containing well and group definitions

◆ setFirstSubstepOfSyncTimestep()

template<class Scalar>

void Opm::ReservoirCouplingMasterReportStep< Scalar >::setFirstSubstepOfSyncTimestep ( bool value )

inline

Set whether this is the first substep within a "sync" timestep.

Parameters

value true at start of sync timestep, false after first runSubStep_() call

◆ setReportStepIdx()

template<class Scalar>

void Opm::ReservoirCouplingMasterReportStep< Scalar >::setReportStepIdx ( int report_step_idx )

Set the current report step index.

Parameters

report_step_idx The report step index to set

This updates the internal state to track which report step is currently being processed.

◆ slaveIsActivated()

template<class Scalar>

bool Opm::ReservoirCouplingMasterReportStep< Scalar >::slaveIsActivated ( int index ) const

inline

Check if a specific slave process has been activated.

Parameters

index Index of the slave process

Returns: true if the slave is activated, false otherwise

◆ slaveName()

template<class Scalar>

const std::string & Opm::ReservoirCouplingMasterReportStep< Scalar >::slaveName ( int index ) const

inline

Get the name of a specific slave process.

Parameters

index Index of the slave process

Returns: Reference to the name string for the specified slave

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

opm/simulators/flow/rescoup/ReservoirCouplingMasterReportStep.hpp
opm/simulators/flow/rescoup/ReservoirCouplingMasterReportStep.cpp

Public Types

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ReservoirCouplingMasterReportStep()

Member Function Documentation

◆ comm()

◆ getMasterGroupCanonicalIdx()

◆ getMasterGroupInjectionReservoirRate()

◆ getMasterGroupInjectionSurfaceRate()

◆ getMasterGroupNamesForSlave()

◆ getMasterGroupNetworkProductionSurfaceRate()

◆ getMasterGroupProductionReservoirRate()

◆ getMasterGroupProductionSurfaceRate()

◆ getMasterGroupToSlaveNameMap()

◆ getSlaveComm()

◆ getSlaveGroupPotentials()

◆ isFirstSubstepOfSyncTimestep()

◆ logger()

◆ needsSlaveDataReceive()

◆ numSlaveGroups()

◆ numSlaves()

◆ receiveInjectionDataFromSlaves()

◆ receiveProductionDataFromSlaves()

◆ schedule()

◆ setFirstSubstepOfSyncTimestep()

◆ setReportStepIdx()

◆ slaveIsActivated()

◆ slaveName()