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	MasterGroupNodePressure = ReservoirCoupling::MasterGroupNodePressure< Scalar >

using	ProductionGroupConstraints = ReservoirCoupling::ProductionGroupConstraints< Scalar >

Public Member Functions
	ReservoirCouplingMasterReportStep (ReservoirCouplingMaster< Scalar > &master)
	Construct a report step manager for the master process. More...

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

const std::vector< std::string > &	getMasterGroupNamesForSlave (std::size_t slave_idx) const
	Get the names of master groups associated with a specific slave. More...

const std::map< std::string, std::string > &	getMasterGroupToSlaveNameMap () const
	Get the mapping from master group names to slave names. More...

std::size_t	getMasterGroupCanonicalIdx (const std::string &slave_name, const std::string &master_group_name) const
	Get the canonical index for a master group. More...

MPI_Comm	getSlaveComm (int index) const
	Get the MPI communicator for a specific slave process. More...

Scalar	getMasterGroupInjectionSurfaceRate (const std::string &group_name, ReservoirCoupling::Phase phase) const
	Get the injection surface rate for a master group. More...

Scalar	getMasterGroupInjectionReservoirRate (const std::string &group_name, ReservoirCoupling::Phase phase) const
	Get the injection reservoir rate for a master group. More...

Scalar	getMasterGroupProductionSurfaceRate (const std::string &group_name, ReservoirCoupling::Phase phase) const
	Get the production surface rate for a master group. More...

Scalar	getMasterGroupNetworkProductionSurfaceRate (const std::string &group_name, ReservoirCoupling::Phase phase) const
	Get the network production surface rate for a master group. More...

Scalar	getMasterGroupProductionReservoirRate (const std::string &group_name, ReservoirCoupling::Phase phase) const
	Get the production reservoir rate for a master group. More...

int	getSlaveGroupNumGroupControlledInjectors (const std::string &master_group_name, ReservoirCoupling::Phase phase) const
	Get the number of a slave group's injectors under group control for a phase. More...

int	getSlaveGroupNumGroupControlledProducers (const std::string &master_group_name) const
	Get the number of a slave group's producers under group control. More...

const Potentials &	getSlaveGroupPotentials (const std::string &master_group_name) const
	Get the production potentials for a slave group. More...

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

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

void	setNeedsSlaveDataReceive (bool value)
	Set/clear the flag for pending slave data receive. More...

std::size_t	numSlaveGroups (unsigned int index) const
	Get the number of slave groups for a specific slave process. More...

std::size_t	numSlaves () const
	Get the total number of active slave processes. More...

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

void	receiveInjectionDataFromSlaves ()
	Receive injection data from all active slave processes. More...

void	receiveProductionDataFromSlaves ()
	Receive production data from all active slave processes. More...

const Schedule &	schedule () const
	Get the simulation schedule. More...

void	sendCoupledNetworkActiveStatusToSlave (std::size_t slave_idx, bool active) const
	Send a single boolean to a slave telling it whether the master will iterate the cross-rescoup network exchange this sync timestep. Rank-0-only on the master comm. More...

void	sendInjectionTargetsToSlave (std::size_t slave_idx, const std::vector< InjectionGroupTarget > &injection_targets) const

void	sendMasterGroupNodePressuresToSlave (std::size_t slave_idx, const std::vector< MasterGroupNodePressure > &pressures) const
	Send master-computed network-leaf node pressures to a slave. More...

void	sendNumGroupConstraintsToSlave (std::size_t slave_idx, std::size_t num_injection_targets, std::size_t num_production_constraints) const

void	sendNumMasterGroupNodePressuresToSlave (std::size_t slave_idx, std::size_t num_pressures, bool is_final) const
	Send the count of master-computed network-leaf node pressures that will follow, plus an `is_final` flag telling the slave whether the master will iterate again. Rank-0-only on the master comm. More...

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. More...

void	setReportStepIdx (int report_step_idx)
	Set the current report step index. More...

void	setSlaveGroupInjectionData (const std::string &slave_name, std::vector< SlaveGroupInjectionData > injection_data)
	Set the injection data of a slave's groups, as received from the slave. More...

void	setSlaveGroupProductionData (const std::string &slave_name, std::vector< SlaveGroupProductionData > production_data)
	Set the production data of a slave's groups, as received from the slave. More...

void	saveGroupFlowsAtStartOfSyncStep ()
	Remember the flow rates of the master groups as they stand now. More...

void	setSyncStepLength (Scalar length)
	Set the length of the sync step that is about to be taken. More...

void	updateFlowChangeTimeStepLimit ()
	Update the flow-change time step limit (GRUPMAST item 4, RCMASTS) More...

Scalar	flowChangeTimeStepLimit () const
	Upper limit for the next sync step length from GRUPMAST item 4 (in seconds) More...

std::tuple< std::string, Scalar, Scalar >	flowChangeLimitingGroup () const
	Description of the group that sets flowChangeTimeStepLimit() More...

data::ReservoirCouplingGroupRates	collectGroupRatesForSummary () const
	Collect production/injection rates for all master groups. More...

bool	slaveIsCoupled (int index) const
	Check if a specific slave process currently takes part in the coupling. More...

const std::string &	slaveName (int index) const
	Get the name of a specific slave process. More...

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

Member Typedef Documentation

◆ InjectionGroupTarget

template<class Scalar >

using Opm::ReservoirCouplingMasterReportStep< Scalar >::InjectionGroupTarget = ReservoirCoupling::InjectionGroupTarget<Scalar>

◆ MasterGroupNodePressure

template<class Scalar >

using Opm::ReservoirCouplingMasterReportStep< Scalar >::MasterGroupNodePressure = ReservoirCoupling::MasterGroupNodePressure<Scalar>

◆ MessageTag

template<class Scalar >

using Opm::ReservoirCouplingMasterReportStep< Scalar >::MessageTag = ReservoirCoupling::MessageTag

◆ Potentials

template<class Scalar >

using Opm::ReservoirCouplingMasterReportStep< Scalar >::Potentials = ReservoirCoupling::Potentials<Scalar>

◆ ProductionGroupConstraints

template<class Scalar >

using Opm::ReservoirCouplingMasterReportStep< Scalar >::ProductionGroupConstraints = ReservoirCoupling::ProductionGroupConstraints<Scalar>

◆ SlaveGroupInjectionData

template<class Scalar >

using Opm::ReservoirCouplingMasterReportStep< Scalar >::SlaveGroupInjectionData = ReservoirCoupling::SlaveGroupInjectionData<Scalar>

◆ SlaveGroupProductionData

template<class Scalar >

using Opm::ReservoirCouplingMasterReportStep< Scalar >::SlaveGroupProductionData = ReservoirCoupling::SlaveGroupProductionData<Scalar>

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

◆ collectGroupRatesForSummary()

template<class Scalar >

data::ReservoirCouplingGroupRates Opm::ReservoirCouplingMasterReportStep< Scalar >::collectGroupRatesForSummary ( ) const

Collect production/injection rates for all master groups.

Returns: ReservoirCouplingGroupRates struct with per-group rates.

◆ 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

◆ flowChangeLimitingGroup()

template<class Scalar >

std::tuple< std::string, Scalar, Scalar > Opm::ReservoirCouplingMasterReportStep< Scalar >::flowChangeLimitingGroup ( ) const

inline

Description of the group that sets flowChangeTimeStepLimit()

Returns: Group name, its largest fractional flow change and its limiting fraction

◆ flowChangeTimeStepLimit()

template<class Scalar >

Scalar Opm::ReservoirCouplingMasterReportStep< Scalar >::flowChangeTimeStepLimit ( ) const

inline

Upper limit for the next sync step length from GRUPMAST item 4 (in seconds)

Returns: Infinity if no group limits the flow change

◆ 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

◆ getSlaveGroupNumGroupControlledInjectors()

template<class Scalar >

int Opm::ReservoirCouplingMasterReportStep< Scalar >::getSlaveGroupNumGroupControlledInjectors	(	const std::string &	master_group_name,
		ReservoirCoupling::Phase	phase
	)		const

Get the number of a slave group's injectors under group control for a phase.

Parameters

master_group_name	Name of the master group
phase	Injection phase

Returns: Number of injectors following the group's target for the phase, as reported by the slave

Note: Used to exclude a master group whose injectors all run at their own limits from its parent's guide-rate distribution, see RescoupConstraintsCalculator::excludeAndRedistributeInjectionTargets_().

◆ getSlaveGroupNumGroupControlledProducers()

template<class Scalar >

int Opm::ReservoirCouplingMasterReportStep< Scalar >::getSlaveGroupNumGroupControlledProducers ( const std::string & master_group_name ) const

Get the number of a slave group's producers under group control.

Parameters

master_group_name Name of the master group

Returns: Number of producers following the group's target, as reported by the slave

Note: Used to exclude a master group whose producers all run at their own limits from its parent's guide-rate distribution, see RescoupConstraintsCalculator::excludeAndRedistributeProductionTargets_().

◆ getSlaveGroupPotentials()

template<class Scalar >

const Potentials & 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

◆ saveGroupFlowsAtStartOfSyncStep()

template<class Scalar >

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

Remember the flow rates of the master groups as they stand now.

Called just before the end-of-sync-step slave data is received. The rates then held are those of the last receive in the sync step: after the slaves' initial well solve and any network iterations. So well changes at the start of the step do not count as flow changes.

◆ 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

◆ sendCoupledNetworkActiveStatusToSlave()

template<class Scalar >

void Opm::ReservoirCouplingMasterReportStep< Scalar >::sendCoupledNetworkActiveStatusToSlave	(	std::size_t	slave_idx,
		bool	active
	)		const

Send a single boolean to a slave telling it whether the master will iterate the cross-rescoup network exchange this sync timestep. Rank-0-only on the master comm.

Parameters

slave_idx	Zero-based slave index.
active	True if the master will iterate (the slave should participate in per-iteration node-pressure receives in updateWellControlsAndNetworkIteration); false if the master will not iterate cross-rescoup this sync timestep.

◆ sendInjectionTargetsToSlave()

template<class Scalar >

void Opm::ReservoirCouplingMasterReportStep< Scalar >::sendInjectionTargetsToSlave	(	std::size_t	slave_idx,
		const std::vector< InjectionGroupTarget > &	injection_targets
	)		const

◆ sendMasterGroupNodePressuresToSlave()

template<class Scalar >

void Opm::ReservoirCouplingMasterReportStep< Scalar >::sendMasterGroupNodePressuresToSlave	(	std::size_t	slave_idx,
		const std::vector< MasterGroupNodePressure > &	pressures
	)		const

Send master-computed network-leaf node pressures to a slave.

Only emits entries for master groups that are leaf nodes in the master's extended network. Rank-0-only on the master comm.

◆ sendNumGroupConstraintsToSlave()

template<class Scalar >

void Opm::ReservoirCouplingMasterReportStep< Scalar >::sendNumGroupConstraintsToSlave	(	std::size_t	slave_idx,
		std::size_t	num_injection_targets,
		std::size_t	num_production_constraints
	)		const

◆ sendNumMasterGroupNodePressuresToSlave()

template<class Scalar >

void Opm::ReservoirCouplingMasterReportStep< Scalar >::sendNumMasterGroupNodePressuresToSlave	(	std::size_t	slave_idx,
		std::size_t	num_pressures,
		bool	is_final
	)		const

Send the count of master-computed network-leaf node pressures that will follow, plus an is_final flag telling the slave whether the master will iterate again. Rank-0-only on the master comm.

Parameters

slave_idx	Zero-based slave index.
num_pressures	Number of pressures that will follow.
is_final	True if this is the master's final pressure send for the current sync timestep; false if the master is iterating and expects to receive updated rates from the slave.

◆ sendProductionConstraintsToSlave()

template<class Scalar >

void Opm::ReservoirCouplingMasterReportStep< Scalar >::sendProductionConstraintsToSlave	(	std::size_t	slave_idx,
		const std::vector< ProductionGroupConstraints > &	production_constraints
	)		const

◆ 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

◆ setNeedsSlaveDataReceive()

template<class Scalar >

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

inline

Set/clear the flag for pending slave data receive.

◆ 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.

◆ setSlaveGroupInjectionData()

template<class Scalar >

void Opm::ReservoirCouplingMasterReportStep< Scalar >::setSlaveGroupInjectionData	(	const std::string &	slave_name,
		std::vector< SlaveGroupInjectionData >	injection_data
	)

inline

Set the injection data of a slave's groups, as received from the slave.

Used by unit tests, which have no slave process to receive the data from.

Parameters

slave_name	Name of the slave process
injection_data	One entry per slave group, in the canonical master group order

◆ setSlaveGroupProductionData()

template<class Scalar >

void Opm::ReservoirCouplingMasterReportStep< Scalar >::setSlaveGroupProductionData	(	const std::string &	slave_name,
		std::vector< SlaveGroupProductionData >	production_data
	)

inline

Set the production data of a slave's groups, as received from the slave.

Used by unit tests, which have no slave process to receive the data from.

Parameters

slave_name	Name of the slave process
production_data	One entry per slave group, in the canonical master group order

◆ setSyncStepLength()

template<class Scalar >

void Opm::ReservoirCouplingMasterReportStep< Scalar >::setSyncStepLength ( Scalar length )

inline

Set the length of the sync step that is about to be taken.

◆ slaveIsCoupled()

template<class Scalar >

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

inline

Check if a specific slave process currently takes part in the coupling.

True only for a slave that has activated and has not ended. A slave that is not coupled sends no data, and its groups contribute zero rates.

Parameters

index Index of the slave process

Returns: true if the slave is coupled, 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

◆ updateFlowChangeTimeStepLimit()

template<class Scalar >

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

Update the flow-change time step limit (GRUPMAST item 4, RCMASTS)

Compares the master group flow rates received at the end of the sync step with those saved by saveGroupFlowsAtStartOfSyncStep(). For each master group with a limiting fraction, the next sync step is limited to the step length times the limiting fraction divided by the largest fractional change of the group's reservoir production rate and phase injection rates, but never below the RCMASTS minimum, or the TUNING TSMINZ if RCMASTS is not given. The step just taken is not redone.

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

ReservoirCouplingMasterReportStep.hpp

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ InjectionGroupTarget

◆ MasterGroupNodePressure

◆ MessageTag

◆ Potentials

◆ ProductionGroupConstraints

◆ SlaveGroupInjectionData

◆ SlaveGroupProductionData

Constructor & Destructor Documentation

◆ ReservoirCouplingMasterReportStep()

Member Function Documentation

◆ collectGroupRatesForSummary()

◆ comm()

◆ flowChangeLimitingGroup()

◆ flowChangeTimeStepLimit()

◆ getMasterGroupCanonicalIdx()

◆ getMasterGroupInjectionReservoirRate()

◆ getMasterGroupInjectionSurfaceRate()

◆ getMasterGroupNamesForSlave()

◆ getMasterGroupNetworkProductionSurfaceRate()

◆ getMasterGroupProductionReservoirRate()

◆ getMasterGroupProductionSurfaceRate()

◆ getMasterGroupToSlaveNameMap()

◆ getSlaveComm()

◆ getSlaveGroupNumGroupControlledInjectors()

◆ getSlaveGroupNumGroupControlledProducers()

◆ getSlaveGroupPotentials()

◆ isFirstSubstepOfSyncTimestep()

◆ logger()

◆ needsSlaveDataReceive()

◆ numSlaveGroups()

◆ numSlaves()

◆ receiveInjectionDataFromSlaves()

◆ receiveProductionDataFromSlaves()

◆ saveGroupFlowsAtStartOfSyncStep()

◆ schedule()

◆ sendCoupledNetworkActiveStatusToSlave()

◆ sendInjectionTargetsToSlave()

◆ sendMasterGroupNodePressuresToSlave()

◆ sendNumGroupConstraintsToSlave()

◆ sendNumMasterGroupNodePressuresToSlave()

◆ sendProductionConstraintsToSlave()

◆ setFirstSubstepOfSyncTimestep()

◆ setNeedsSlaveDataReceive()

◆ setReportStepIdx()

◆ setSlaveGroupInjectionData()

◆ setSlaveGroupProductionData()

◆ setSyncStepLength()

◆ slaveIsCoupled()

◆ slaveName()

◆ updateFlowChangeTimeStepLimit()