openswmm::divider Namespace Reference

Enumerations
enum class	DividerMethod : int {   CUTOFF = 0 ,   OVERFLOW_DIV = 1 ,   TABULAR = 2 ,   WEIR = 3 }

Functions
double	getOutflow (SimulationContext &ctx, int node_idx, int link_idx)
	Flow sent from a divider node into one of its outflow links.

Enumeration Type Documentation

DividerMethod

enum class openswmm::divider::DividerMethod : int

strong

Enumerator
CUTOFF
OVERFLOW_DIV	Renamed to avoid macOS math.h OVERFLOW macro.
TABULAR
WEIR

Function Documentation

getOutflow()

double openswmm::divider::getOutflow	(	SimulationContext &	ctx,
		int	node_idx,
		int	link_idx )

Flow sent from a divider node into one of its outflow links.

Legacy-faithful divider_getOutflow (node.c:1237-1312): the diversion link receives the diverted portion of the node's inflow + overflow per the divider method; any other outflow link receives the undiverted remainder. Requires links be routed in topological order so the non-diversion link is evaluated before the diversion link (OVERFLOW dividers read the node's accumulated outflow).

Parameters

ctx	Simulation context.
node_idx	Divider node index.
link_idx	Outflow link being evaluated.

Returns

Flow rate into the link (internal flow units).

Here is the call graph for this function:

Here is the caller graph for this function: