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

#include <ReservoirCouplingSlaveReportStep.hpp>

Public Types
using	InjectionGroupTarget = ReservoirCoupling::InjectionGroupTarget< Scalar >

using	ProductionGroupConstraints = ReservoirCoupling::ProductionGroupConstraints< Scalar >

using	MasterGroupNodePressure = ReservoirCoupling::MasterGroupNodePressure< Scalar >

using	MessageTag = ReservoirCoupling::MessageTag

using	MasterProductionLimits = ReservoirCoupling::MasterProductionLimits< Scalar >

using	SlaveGroupInjectionData = ReservoirCoupling::SlaveGroupInjectionData< Scalar >

using	SlaveGroupProductionData = ReservoirCoupling::SlaveGroupProductionData< Scalar >

Public Member Functions
	ReservoirCouplingSlaveReportStep (ReservoirCouplingSlave< Scalar > &slave)
	Construct a report step manager for the slave process. More...

const Parallel::Communication &	comm () const
	Get the MPI communicator for intra-slave communication. More...

MPI_Comm	getSlaveMasterComm () const
	Get the MPI communicator for slave-master communication. More...

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	hasMasterGroupNodePressure (const std::string &gname) const
	Check if a master-computed network-leaf node pressure exists for a master group. 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...

bool	isFirstSubstepOfSyncTimestep () const
	Check if this is the first substep within a "sync" timestep. More...

bool	isLastSubstepOfSyncTimestep () const
	Check if this is the last substep within a "sync" timestep. More...

ReservoirCoupling::Logger &	logger () const
	Get the logger for reservoir coupling operations. More...

Scalar	masterGroupNodePressure (const std::string &gname) const
	Get the master-computed network-leaf node pressure for a master group. More...

const std::map< std::string, Scalar > &	masterGroupNodePressures () const
	Get the full map of master-computed network-leaf node pressures. More...

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	receiveMasterGroupNodePressuresFromMaster (std::size_t num_pressures)
	Receive master-computed network-leaf node pressures from master and store them locally. More...

std::pair< std::size_t, bool >	receiveNumMasterGroupNodePressuresFromMaster ()
	Receive the master-group-node-pressures header from master. More...

void	receiveCoupledNetworkActiveStatusFromMaster ()
	Receive the master's single-bool flag for the current sync timestep and mirror it into `last_received_master_group_node_pressures_is_final_` (is_final = !active). More...

bool	lastReceivedMasterGroupNodePressuresIsFinal () const
	Whether the most recent master-group-node-pressures receive carried the `is_final` flag. More...

bool	connectedToMasterCoupledNetwork () const
	Whether this slave is connected to the master's cross-rescoup network this sync step (i.e. More...

std::pair< std::size_t, std::size_t >	receiveNumGroupConstraintsFromMaster () const
	Receive the number of injection and production constraints from master. More...

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	sendProductionDataToMaster (const std::vector< SlaveGroupProductionData > &production_data) const
	Send production data to the master process. More...

void	sendInjectionDataToMaster (const std::vector< SlaveGroupInjectionData > &injection_data) const
	Send injection data to the master process. More...

void	setFirstSubstepOfSyncTimestep (bool value)
	Set whether this is the first substep within a "sync" timestep. More...

void	setLastSubstepOfSyncTimestep (bool value)
	Set whether this is the last substep within a "sync" timestep. More...

void	markSlaveGroupsInSchedule (Schedule &schedule, int report_step_idx)
	Mark slave groups in the Schedule as production/injection groups. More...

const std::string &	slaveName () const
	Get the name of this slave process. More...

void	setMasterGroupNodePressure (const std::string &gname, const Scalar pressure)
	Store a master-computed network-leaf node pressure for a master group. More...

void	setMasterInjectionTarget (const std::string &gname, const Phase phase, const Scalar target, const Group::InjectionCMode cmode)
	Store a master-imposed injection target for a group and phase. More...

void	setMasterProductionLimits (const std::string &gname, const MasterProductionLimits &limits)
	Store master-imposed per-rate-type production limits for a group. More...

void	setMasterProductionTarget (const std::string &gname, const Scalar target, const Group::ProductionCMode cmode)
	Store a master-imposed production target for a group. More...

Detailed Description

template<class Scalar>
class Opm::ReservoirCouplingSlaveReportStep< Scalar >

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

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

Sending production data (rates, potentials) to the master process via MPI
Sending injection data (rates) to the master process via MPI
Coordinating data exchange between slave and master processes

The class serves as a helper to ReservoirCouplingSlave, separating the report-step-specific communication 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 a reference to the parent ReservoirCouplingSlave object and should only be used within the scope of that object's lifetime

See also: ReservoirCouplingSlave

Constructor & Destructor Documentation

◆ ReservoirCouplingSlaveReportStep()

template<class Scalar >

Opm::ReservoirCouplingSlaveReportStep< Scalar >::ReservoirCouplingSlaveReportStep ( ReservoirCouplingSlave< Scalar > & slave )

Construct a report step manager for the slave process.

Parameters

slave Reference to the parent ReservoirCouplingSlave object

Member Function Documentation

◆ comm()

template<class Scalar >

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

inline

Get the MPI communicator for intra-slave communication.

Returns: Reference to the parallel communication object

◆ connectedToMasterCoupledNetwork()

template<class Scalar >

bool Opm::ReservoirCouplingSlaveReportStep< Scalar >::connectedToMasterCoupledNetwork ( ) const

inline

Whether this slave is connected to the master's cross-rescoup network this sync step (i.e.

at least one of its master groups is a leaf node in the master network). Set by receiveCoupledNetworkActiveStatusFromMaster from the master's per-slave flag. Distinct from the per-iteration is_final flag: an unconnected slave never participates in the cross-rescoup exchange and balances only its own (local) network.

◆ getSlaveMasterComm()

template<class Scalar >

MPI_Comm Opm::ReservoirCouplingSlaveReportStep< Scalar >::getSlaveMasterComm ( ) const

inline

Get the MPI communicator for slave-master communication.

Returns: MPI communicator handle for communication with the master process

◆ hasMasterGroupNodePressure()

template<class Scalar >

bool Opm::ReservoirCouplingSlaveReportStep< Scalar >::hasMasterGroupNodePressure ( const std::string & gname ) const

Check if a master-computed network-leaf node pressure exists for a master group.

Parameters

gname Slave group name

Returns: true if the master sent a node pressure for this group

◆ hasMasterInjectionTarget()

template<class Scalar >

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

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

Parameters

gname	Slave group name
phase	Injection phase (e.g., Phase::WATER, Phase::GAS)

Returns: true if the master sent an injection target for this group/phase pair

◆ hasMasterProductionLimits()

template<class Scalar >

bool Opm::ReservoirCouplingSlaveReportStep< Scalar >::hasMasterProductionLimits ( const std::string & gname ) const

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

Parameters

gname Slave group name

Returns: true if the master sent per-rate-type limits for this group

◆ hasMasterProductionTarget()

template<class Scalar >

bool Opm::ReservoirCouplingSlaveReportStep< Scalar >::hasMasterProductionTarget ( const std::string & gname ) const

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

Parameters

gname Slave group name

Returns: true if the master sent a production target for this group

◆ isFirstSubstepOfSyncTimestep()

template<class Scalar >

bool Opm::ReservoirCouplingSlaveReportStep< 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

◆ isLastSubstepOfSyncTimestep()

template<class Scalar >

bool Opm::ReservoirCouplingSlaveReportStep< Scalar >::isLastSubstepOfSyncTimestep ( ) const

inline

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

This flag is used to control reservoir coupling synchronization of summary data sent from the slave to the master process. The slave should send production data to the master at the end of its "sync" timestep, while master is waiting for it in timeStepSucceeded() of the first substep of the sync step.

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

◆ lastReceivedMasterGroupNodePressuresIsFinal()

template<class Scalar >

bool Opm::ReservoirCouplingSlaveReportStep< Scalar >::lastReceivedMasterGroupNodePressuresIsFinal ( ) const

inline

Whether the most recent master-group-node-pressures receive carried the is_final flag.

Updated by every call to receiveNumMasterGroupNodePressuresFromMaster, and by receiveCoupledNetworkActiveStatusFromMaster at the start of each sync step.

See last_received_master_group_node_pressures_is_final_ variable for details.

◆ logger()

template<class Scalar >

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

inline

Get the logger for reservoir coupling operations.

Returns: Reference to the logger object for this coupling session

◆ markSlaveGroupsInSchedule()

template<class Scalar >

void Opm::ReservoirCouplingSlaveReportStep< Scalar >::markSlaveGroupsInSchedule	(	Schedule &	schedule,
		int	report_step_idx
	)

Mark slave groups in the Schedule as production/injection groups.

For slave groups that have received master production/injection targets, mark them so isProductionGroup()/isInjectionGroup() return true. This ensures the existing constraint enforcement mechanisms recognize them.

Parameters

schedule	Non-const reference to the Schedule
report_step_idx	0-based report step index

◆ masterGroupNodePressure()

template<class Scalar >

Scalar Opm::ReservoirCouplingSlaveReportStep< Scalar >::masterGroupNodePressure ( const std::string & gname ) const

Get the master-computed network-leaf node pressure for a master group.

Parameters

gname Slave group name

Returns: Node pressure (SI units, Pa)

Exceptions

std::out_of_range if no pressure exists for the given group

◆ masterGroupNodePressures()

template<class Scalar >

const std::map<std::string, Scalar>& Opm::ReservoirCouplingSlaveReportStep< Scalar >::masterGroupNodePressures ( ) const

inline

Get the full map of master-computed network-leaf node pressures.

Returns: Map keyed by slave group name; values are pressures in SI units (Pa)

◆ masterInjectionTarget()

template<class Scalar >

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

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

Parameters

gname	Slave group name
phase	Injection phase

Returns: Pair of (target rate, control mode)

Exceptions

std::out_of_range if no target exists for the given group/phase pair

◆ masterProductionLimits()

template<class Scalar >

const ReservoirCouplingSlaveReportStep< Scalar >::MasterProductionLimits & Opm::ReservoirCouplingSlaveReportStep< Scalar >::masterProductionLimits ( const std::string & gname ) const

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

Parameters

gname Slave group name

Returns: Reference to the limits struct (-1 = no limit for that rate type)

Exceptions

std::out_of_range if no limits exist for the given group

◆ masterProductionTarget()

template<class Scalar >

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

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

Parameters

gname Slave group name

Returns: Pair of (target rate, control mode)

Exceptions

std::out_of_range if no target exists for the given group

◆ receiveCoupledNetworkActiveStatusFromMaster()

template<class Scalar >

void Opm::ReservoirCouplingSlaveReportStep< Scalar >::receiveCoupledNetworkActiveStatusFromMaster ( )

Receive the master's single-bool flag for the current sync timestep and mirror it into last_received_master_group_node_pressures_is_final_ (is_final = !active).

The flag is queryable via lastReceivedMasterGroupNodePressuresIsFinal().

◆ receiveInjectionGroupTargetsFromMaster()

template<class Scalar >

void Opm::ReservoirCouplingSlaveReportStep< Scalar >::receiveInjectionGroupTargetsFromMaster ( std::size_t num_targets )

Receive injection group targets from master and store them locally.

Parameters

num_targets Number of injection targets to receive

◆ receiveMasterGroupNodePressuresFromMaster()

template<class Scalar >

void Opm::ReservoirCouplingSlaveReportStep< Scalar >::receiveMasterGroupNodePressuresFromMaster ( std::size_t num_pressures )

Receive master-computed network-leaf node pressures from master and store them locally.

Only emitted for master groups that are leaf nodes in the master's extended network.

Parameters

num_pressures Number of pressure entries to receive

◆ receiveNumGroupConstraintsFromMaster()

template<class Scalar >

std::pair< std::size_t, std::size_t > Opm::ReservoirCouplingSlaveReportStep< Scalar >::receiveNumGroupConstraintsFromMaster ( ) const

Receive the number of injection and production constraints from master.

Returns: Pair of (num_injection_targets, num_production_constraints)

◆ receiveNumMasterGroupNodePressuresFromMaster()

template<class Scalar >

std::pair< std::size_t, bool > Opm::ReservoirCouplingSlaveReportStep< Scalar >::receiveNumMasterGroupNodePressuresFromMaster ( )

Receive the master-group-node-pressures header from master.

Returns: (num_pressures, is_final). is_final tells the slave whether the master is done iterating for the current sync timestep.

◆ receiveProductionGroupConstraintsFromMaster()

template<class Scalar >

void Opm::ReservoirCouplingSlaveReportStep< Scalar >::receiveProductionGroupConstraintsFromMaster ( std::size_t num_targets )

Receive production group constraints from master and store them locally.

Parameters

num_targets Number of production constraints to receive

◆ sendInjectionDataToMaster()

template<class Scalar >

void Opm::ReservoirCouplingSlaveReportStep< Scalar >::sendInjectionDataToMaster ( const std::vector< SlaveGroupInjectionData > & injection_data ) const

Send injection data to the master process.

This method sends injection rates and related data for all slave groups to the master process via MPI communication. The data is used by the master for group control calculations and coordination.

Parameters

injection_data Vector of injection data for each slave group

Note: This is a blocking operation that waits for the master to receive the data; Must be called before the master attempts to receive injection data

◆ sendProductionDataToMaster()

template<class Scalar >

void Opm::ReservoirCouplingSlaveReportStep< Scalar >::sendProductionDataToMaster ( const std::vector< SlaveGroupProductionData > & production_data ) const

Send production data to the master process.

This method sends production rates, potentials, and related data for all slave groups to the master process via MPI communication. The data is used by the master for group control calculations and coordination.

Parameters

production_data Vector of production data for each slave group

Note: This is a blocking operation that waits for the master to receive the data; Must be called before the master attempts to receive production data

◆ setFirstSubstepOfSyncTimestep()

template<class Scalar >

void Opm::ReservoirCouplingSlaveReportStep< 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

◆ setLastSubstepOfSyncTimestep()

template<class Scalar >

void Opm::ReservoirCouplingSlaveReportStep< Scalar >::setLastSubstepOfSyncTimestep ( bool value )

inline

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

See isLastSubstepOfSyncTimestep() for details.

Parameters

value true if this is the last substep of a "sync" timestep, false if not

◆ setMasterGroupNodePressure()

template<class Scalar >

void Opm::ReservoirCouplingSlaveReportStep< Scalar >::setMasterGroupNodePressure	(	const std::string &	gname,
		const Scalar	pressure
	)

Store a master-computed network-leaf node pressure for a master group.

Parameters

gname	Slave group name
pressure	Node pressure (SI units, Pa)

◆ setMasterInjectionTarget()

template<class Scalar >

void Opm::ReservoirCouplingSlaveReportStep< Scalar >::setMasterInjectionTarget	(	const std::string &	gname,
		const Phase	phase,
		const Scalar	target,
		const Group::InjectionCMode	cmode
	)

Store a master-imposed injection target for a group and phase.

Parameters

gname	Slave group name
phase	Injection phase
target	Target injection rate
cmode	Injection control mode dictated by the master

◆ setMasterProductionLimits()

template<class Scalar >

void Opm::ReservoirCouplingSlaveReportStep< Scalar >::setMasterProductionLimits	(	const std::string &	gname,
		const MasterProductionLimits &	limits
	)

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

Parameters

gname	Slave group name
limits	Per-rate-type limits (-1 = no limit for that rate type)

◆ setMasterProductionTarget()

template<class Scalar >

void Opm::ReservoirCouplingSlaveReportStep< Scalar >::setMasterProductionTarget	(	const std::string &	gname,
		const Scalar	target,
		const Group::ProductionCMode	cmode
	)

Store a master-imposed production target for a group.

Parameters

gname	Slave group name
target	Target production rate
cmode	Production control mode dictated by the master

◆ slaveName()

template<class Scalar >

const std::string& Opm::ReservoirCouplingSlaveReportStep< Scalar >::slaveName ( ) const

inline

Get the name of this slave process.

Returns: Reference to the name string for this slave

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

opm/simulators/flow/rescoup/ReservoirCouplingSlave.hpp
opm/simulators/flow/rescoup/ReservoirCouplingSlaveReportStep.hpp
opm/simulators/flow/rescoup/ReservoirCouplingSlaveReportStep.cpp

Public Types

Public Member Functions

Detailed Description

template<class Scalar> class Opm::ReservoirCouplingSlaveReportStep< Scalar >

Constructor & Destructor Documentation

◆ ReservoirCouplingSlaveReportStep()

Member Function Documentation

◆ comm()

◆ connectedToMasterCoupledNetwork()

◆ getSlaveMasterComm()

◆ hasMasterGroupNodePressure()

◆ hasMasterInjectionTarget()

◆ hasMasterProductionLimits()

◆ hasMasterProductionTarget()

◆ isFirstSubstepOfSyncTimestep()

◆ isLastSubstepOfSyncTimestep()

◆ lastReceivedMasterGroupNodePressuresIsFinal()

◆ logger()

◆ markSlaveGroupsInSchedule()

◆ masterGroupNodePressure()

◆ masterGroupNodePressures()

◆ masterInjectionTarget()

◆ masterProductionLimits()

◆ masterProductionTarget()

◆ receiveCoupledNetworkActiveStatusFromMaster()

◆ receiveInjectionGroupTargetsFromMaster()

◆ receiveMasterGroupNodePressuresFromMaster()

◆ receiveNumGroupConstraintsFromMaster()

◆ receiveNumMasterGroupNodePressuresFromMaster()

◆ receiveProductionGroupConstraintsFromMaster()

◆ sendInjectionDataToMaster()

◆ sendProductionDataToMaster()

◆ setFirstSubstepOfSyncTimestep()

◆ setLastSubstepOfSyncTimestep()

◆ setMasterGroupNodePressure()

◆ setMasterInjectionTarget()

◆ setMasterProductionLimits()

◆ setMasterProductionTarget()

◆ slaveName()

template<class Scalar>
class Opm::ReservoirCouplingSlaveReportStep< Scalar >