openswmm::gpkg::SimulationContext::InletDiag Struct Reference

Per-inlet-usage performance block for the .rpt street tables. More...

#include <SimulationContext.hpp>

Collaboration diagram for openswmm::gpkg::SimulationContext::InletDiag:

Public Member Functions
int	count () const
	Count inlet diagnostic rows from the host-node column.
void	resize (int n)
	Replace all inlet diagnostic columns with default rows.
void	clear ()
	Erase every inlet diagnostic column.

Public Attributes
std::vector< int >	host_node
	inlet-junction node (−1 = conduit host)
std::vector< int >	up_link
	approach conduit (−1 = none)
std::vector< uint8_t >	is_sag
	resolved placement: 1 = ON_SAG
std::vector< int >	num_inlets
std::vector< int >	flow_periods
std::vector< int >	capture_periods
std::vector< int >	backflow_periods
std::vector< double >	peak_flow
	peak approach flow (cfs)
std::vector< double >	peak_flow_capture
	capture efficiency at peak flow (%)
std::vector< double >	avg_flow_capture
	Σ capture efficiency over capture periods.
std::vector< double >	bypass_freq

Detailed Description

Per-inlet-usage performance block for the .rpt street tables.

Row i corresponds to inlet_usages row i. Populated by inlet::InletSolver::gatherStats() before the summary is written; these are the legacy TInletStats counters (inlet.c:78-87) that the Street Flow Summary reports and that InletUsageStore (a persistent .inp store) deliberately does not carry.

Member Function Documentation

clear()

void openswmm::SimulationContext::InletDiag::clear ( )

inline

Erase every inlet diagnostic column.

Retains vector capacities and invalidates row references; inlet-usage definitions remain unchanged.

count()

int openswmm::SimulationContext::InletDiag::count ( ) const

inline

Count inlet diagnostic rows from the host-node column.

Returns

host_node.size() converted to int; other columns are not checked.

resize()

void openswmm::SimulationContext::InletDiag::resize ( int n )

inline

Replace all inlet diagnostic columns with default rows.

Sets host/upstream indices to -1, inlet count to one, placement/counters/statistics to zero. Does not preserve old data or resolve topology; allocation can fail between column assignments.

Parameters

[in]

n

Nonnegative inlet-usage count; no guard before conversion to size_t.

Member Data Documentation

avg_flow_capture

std::vector<double> openswmm::SimulationContext::InletDiag::avg_flow_capture

Σ capture efficiency over capture periods.

backflow_periods

std::vector<int> openswmm::SimulationContext::InletDiag::backflow_periods

periods with backflow

bypass_freq

std::vector<double> openswmm::SimulationContext::InletDiag::bypass_freq

capture periods that also bypassed

capture_periods

std::vector<int> openswmm::SimulationContext::InletDiag::capture_periods

periods with captured flow

flow_periods

std::vector<int> openswmm::SimulationContext::InletDiag::flow_periods

periods with approach flow

host_node

std::vector<int> openswmm::SimulationContext::InletDiag::host_node

inlet-junction node (−1 = conduit host)

is_sag

std::vector<uint8_t> openswmm::SimulationContext::InletDiag::is_sag

resolved placement: 1 = ON_SAG

num_inlets

std::vector<int> openswmm::SimulationContext::InletDiag::num_inlets

peak_flow

std::vector<double> openswmm::SimulationContext::InletDiag::peak_flow

peak approach flow (cfs)

peak_flow_capture

std::vector<double> openswmm::SimulationContext::InletDiag::peak_flow_capture

capture efficiency at peak flow (%)

up_link

std::vector<int> openswmm::SimulationContext::InletDiag::up_link

approach conduit (−1 = none)

---

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

• /home/runner/work/openswmm.engine/openswmm.engine/src/engine/core/SimulationContext.hpp