OpenSWMM Engine  6.0.0-alpha.4
Data-oriented, plugin-extensible SWMM Engine (6.0.0-alpha.4)
Loading...
Searching...
No Matches
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
 

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, eligible for the COUPLING_AREA AUTO derivation (clamp(1.25 × largest connected conduit area, 0.05, 2.0) m²).

◆ cd

double openswmm::twoD::CouplingPoint::cd

Discharge coefficient.

◆ cell_idx

int openswmm::twoD::CouplingPoint::cell_idx

Triangle index in the 2D mesh.

◆ has_flap_gate

bool openswmm::twoD::CouplingPoint::has_flap_gate

True if outfall has a flap gate

◆ is_outfall

bool openswmm::twoD::CouplingPoint::is_outfall

True if the SWMM node is an outfall.

◆ node_idx

int openswmm::twoD::CouplingPoint::node_idx

SWMM node index.

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