Opm::ReservoirCoupling Namespace Reference

Classes
struct	FlowChangeLimit
	Result of flowChangeTimeStepLimit() More...
struct	InjectionGroupTarget
struct	InjectionRates
class	Logger
struct	MasterGroupNodePressure
	Master-computed network-leaf node pressure for a single master group. More...
struct	MasterProductionLimits
	Per-rate-type production limits received from master hierarchy. A value of -1 means no limit defined in the hierarchy for that rate type. More...
struct	Potentials
struct	ProductionGroupConstraints
struct	ProductionRates
class	Proxy
	Thin proxy for reservoir coupling master/slave pointers. More...
class	ScopedLoggerGuard
	Guard for managing DeferredLogger lifecycle in ReservoirCoupling. More...
struct	Seconds
	Utility class for comparing double values representing epoch dates or elapsed time. More...
struct	SlaveGroupInjectionData
struct	SlaveGroupProductionData

Enumerations
enum class	MessageTag : int {   CoupledNetworkActiveStatus , InjectionGroupTargets , MasterGroupNames , MasterGroupNamesSize ,   MasterGroupNodePressures , MasterInitStatus , MasterStartOfReportStep , NumMasterGroupNodePressures ,   NumSlaveGroupConstraints , ProductionGroupConstraints , SlaveActivationDate , SlaveActivationHandshake ,   SlaveInjectionData , SlaveProcessTermination , SlaveName , SlaveNameSize ,   SlaveNextReportDate , SlaveNextTimeStep , SlaveProductionData , SlaveSimulationStartDate ,   SlaveStartOfReportStep , SlaveStatus }
enum class	Phase : std::size_t { Oil = 0 , Gas , Water , Count }
	Phase indices for reservoir coupling, we currently only support black-oil phases (oil, gas, and water). More...
enum class	RateKind {   InjectionSurface , InjectionReservoir , ProductionSurface , ProductionNetworkSurface ,   ProductionReservoir }
	Selects which kind of rate to retrieve from slave group data. More...

Functions
bool	isSlaveEndOfRunSentinel (double next_report_time_offset)
	Whether a next-report-date offset received from a slave is the end-of-run sentinel. More...
Phase	convertPhaseToReservoirCouplingPhase (::Opm::Phase phase)
::Opm::Phase	convertToOpmPhase (const Phase phase)
void	customErrorHandler_ (MPI_Comm *comm, int *err, const std::string &msg)
void	customErrorHandlerSlave_ (MPI_Comm *comm, int *err,...)
void	customErrorHandlerMaster_ (MPI_Comm *comm, int *err,...)
void	setErrhandler (MPI_Comm comm, bool is_master)
std::pair< std::vector< char >, std::size_t >	serializeStrings (const std::vector< std::string > &data)
std::string	formatDays (double seconds)
	Format seconds as a human-readable string showing both seconds and days. More...
template<class Scalar >
FlowChangeLimit< Scalar >	flowChangeTimeStepLimit (Scalar limiting_fraction, Scalar step_length, Scalar min_step, const std::vector< Scalar > &start_flows, const std::vector< Scalar > &end_flows)
	Limit the next sync step from the flow change of a master group (GRUPMAST item 4) More...

Variables
constexpr double	slave_end_of_run_sentinel = -1.0
	Sentinel sent by a slave on the MessageTag::SlaveNextReportDate channel to tell the master that the slave has reached the end of its own schedule and will not take any further report step. More...

Enumeration Type Documentation

MessageTag

enum class Opm::ReservoirCoupling::MessageTag : int

strong

Enumerator
CoupledNetworkActiveStatus
InjectionGroupTargets
MasterGroupNames
MasterGroupNamesSize
MasterGroupNodePressures
MasterInitStatus
MasterStartOfReportStep
NumMasterGroupNodePressures
NumSlaveGroupConstraints
ProductionGroupConstraints
SlaveActivationDate
SlaveActivationHandshake
SlaveInjectionData
SlaveProcessTermination
SlaveName
SlaveNameSize
SlaveNextReportDate
SlaveNextTimeStep
SlaveProductionData
SlaveSimulationStartDate
SlaveStartOfReportStep
SlaveStatus

Phase

enum class Opm::ReservoirCoupling::Phase : std::size_t

strong

Phase indices for reservoir coupling, we currently only support black-oil phases (oil, gas, and water).

Enumerator
Oil
Gas
Water
Count

RateKind

enum class Opm::ReservoirCoupling::RateKind

strong

Selects which kind of rate to retrieve from slave group data.

Replaces multiple bool parameters (res_rates, is_injection, network) with a single enum that names the 5 valid rate categories directly. Only these 5 combinations of the bools are meaningful; the enum prevents callers from constructing invalid states.

Enumerator
InjectionSurface
InjectionReservoir
ProductionSurface
ProductionNetworkSurface
ProductionReservoir

Function Documentation

convertPhaseToReservoirCouplingPhase()

Phase Opm::ReservoirCoupling::convertPhaseToReservoirCouplingPhase

(

::Opm::Phase

phase

)

convertToOpmPhase()

::Opm::Phase Opm::ReservoirCoupling::convertToOpmPhase

(

const Phase

phase

)

customErrorHandler_()

void Opm::ReservoirCoupling::customErrorHandler_	(	MPI_Comm *	comm,
		int *	err,
		const std::string &	msg
	)

customErrorHandlerMaster_()

void Opm::ReservoirCoupling::customErrorHandlerMaster_	(	MPI_Comm *	comm,
		int *	err,
			...
	)

customErrorHandlerSlave_()

void Opm::ReservoirCoupling::customErrorHandlerSlave_	(	MPI_Comm *	comm,
		int *	err,
			...
	)

flowChangeTimeStepLimit()

template<class Scalar >

FlowChangeLimit< Scalar > Opm::ReservoirCoupling::flowChangeTimeStepLimit	(	Scalar	limiting_fraction,
		Scalar	step_length,
		Scalar	min_step,
		const std::vector< Scalar > &	start_flows,
		const std::vector< Scalar > &	end_flows
	)

Limit the next sync step from the flow change of a master group (GRUPMAST item 4)

The limit is the step length times the limiting fraction divided by the largest fractional change of the flows between the start and the end of the step. It is rounded to whole seconds, see Seconds, and never below the minimum step.

Parameters

limiting_fraction	GRUPMAST item 4. The default value means no limit.
step_length	Length of the sync step taken
min_step	Smallest limit that is returned
start_flows	Flow rates at the start of the step
end_flows	Flow rates at the end of the step, in the same order as start_flows

formatDays()

std::string Opm::ReservoirCoupling::formatDays ( double  seconds )

inline

Format seconds as a human-readable string showing both seconds and days.

Parameters

seconds

The time value in seconds.

Returns

A string like "864000s (10.00 days)".

isSlaveEndOfRunSentinel()

bool Opm::ReservoirCoupling::isSlaveEndOfRunSentinel ( double  next_report_time_offset )

inline

Whether a next-report-date offset received from a slave is the end-of-run sentinel.

serializeStrings()

std::pair< std::vector< char >, std::size_t > Opm::ReservoirCoupling::serializeStrings

(

const std::vector< std::string > &

data

)

setErrhandler()

void Opm::ReservoirCoupling::setErrhandler	(	MPI_Comm	comm,
		bool	is_master
	)

Variable Documentation

slave_end_of_run_sentinel

constexpr double Opm::ReservoirCoupling::slave_end_of_run_sentinel = -1.0

inlineconstexpr

Sentinel sent by a slave on the MessageTag::SlaveNextReportDate channel to tell the master that the slave has reached the end of its own schedule and will not take any further report step.

A genuine next-report-date offset is measured from the slave's own simulation start and is therefore never negative, so a negative value is unambiguous. Reusing the next-report-date channel rather than adding a new message tag means the master learns about the ended slave at the point where it is already blocked waiting for that slave, which is what avoids a deadlock. See ReservoirCouplingSlave::notifyEndOfRunAndDisconnect() and ReservoirCouplingTimeStepper::receiveNextReportDateFromSlaves().