openswmm::twoD::CouplingPoint Struct Reference

Descriptor for a single coupling point between 2D and 1D. More...

#include <NodeCoupling.hpp>

Collaboration diagram for openswmm::twoD::CouplingPoint:

Public Attributes
int	cell_idx
	Triangle index in the 2D mesh.
int	vertex_idx
	Vertex index (-1 if triangle-centroid coupling)
int	node_idx
	SWMM node index.
double	cd
	Discharge coefficient.
double	area
	Effective exchange area (m²)
bool	is_outfall
	True if the SWMM node is an outfall.
bool	has_flap_gate
bool	area_authored = true
bool	cd_authored = true
int8_t	law = 0
exchange::Geometry	geo
	WEIR_ORIFICE structure (SI, 2D frame)
exchange::Coefficients	coef
double	chamber_area = 0.0
bool	equalize = false
	COUPLING_EQUALIZE resolved for this point.
int	head_begin = 0
int	head_end = 0
double	spread = 0.0
double	tw_relax = 0.0

Detailed Description

Descriptor for a single coupling point between 2D and 1D.

Member Data Documentation

area

double openswmm::twoD::CouplingPoint::area

Effective exchange area (m²)

area_authored

bool openswmm::twoD::CouplingPoint::area_authored = true

True when the input authored an explicit AREA token for this point; false = defaulted. COUPLING_AREA AUTO (clamp(1.25 × largest connected conduit area, 0.05, 2.0) m²) replaces the area of every junction point either way — mapper-written default tokens look authored.

cd

double openswmm::twoD::CouplingPoint::cd

Discharge coefficient.

cd_authored

bool openswmm::twoD::CouplingPoint::cd_authored = true

True when the input authored this point's CD; false = the router substitutes [2D_OPTIONS] COUPLING_CD.

cell_idx

int openswmm::twoD::CouplingPoint::cell_idx

Triangle index in the 2D mesh.

chamber_area

double openswmm::twoD::CouplingPoint::chamber_area = 0.0

Chamber plan area above the rim (m²): [2D_NODE_COUPLING] CHAMBER_AREA, else the structure's open area (the map-row area under ORIFICE). The pond area under COUPLING_POND_MODE CHAMBER, the floor under TRACKING.

coef

exchange::Coefficients openswmm::twoD::CouplingPoint::coef

WEIR_ORIFICE coefficients

equalize

bool openswmm::twoD::CouplingPoint::equalize = false

COUPLING_EQUALIZE resolved for this point.

geo

exchange::Geometry openswmm::twoD::CouplingPoint::geo

WEIR_ORIFICE structure (SI, 2D frame)

has_flap_gate

bool openswmm::twoD::CouplingPoint::has_flap_gate

True if outfall has a flap gate

head_begin

int openswmm::twoD::CouplingPoint::head_begin = 0

Head-sampling cells [head_begin, head_end) in the router's shared list (SurfaceStateData::coupling_head_cells): the wet-depth-weighted η over them drives the exchange. Empty = the coupling cell's own head.

head_end

int openswmm::twoD::CouplingPoint::head_end = 0

is_outfall

bool openswmm::twoD::CouplingPoint::is_outfall

True if the SWMM node is an outfall.

law

int8_t openswmm::twoD::CouplingPoint::law = 0

Exchange law resolved for this point (CouplingLaw2D: 0 ORIFICE — the legacy path on cd/area — or 1 WEIR_ORIFICE on geo/coef).

node_idx

int openswmm::twoD::CouplingPoint::node_idx

SWMM node index.

spread

double openswmm::twoD::CouplingPoint::spread = 0.0

Outfalls ([2D_NODE_COUPLING] OUTFALL row): SPREAD radius (m; 0 = the point's own cells) over which a discharge is delivered, and TAILWATER_RELAX time (s; 0 = the tailwater follows the surface).

tw_relax

double openswmm::twoD::CouplingPoint::tw_relax = 0.0

vertex_idx

int openswmm::twoD::CouplingPoint::vertex_idx

Vertex index (-1 if triangle-centroid coupling)

---

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

• /home/runner/work/openswmm.engine/openswmm.engine/src/engine/2d/coupling/NodeCoupling.hpp