openswmm::InletUsageStore Struct Reference

#include <InfraData.hpp>

Collaboration diagram for openswmm::InletUsageStore:

Public Member Functions
int	count () const
int	add_row (int link_idx, int node_host_idx, int design_idx, int capture_node_idx)
	Append a defaulted row; returns its index.
void	erase_row (int idx)
int	find_by_link (int link_idx) const
	Row index of the usage hosted by conduit link_idx, or -1.
int	find_by_node_host (int node_idx) const
	Row index of the usage hosted by inlet-junction node node_idx, or -1.
void	resize_stats (int n)

Public Attributes
std::vector< int >	link_index
	Host conduit link index (-1 for an inlet junction)
std::vector< int >	node_host
	Host inlet-junction node index (-1 for a conduit usage)
std::vector< int >	design_index
	Index into InletStore.
std::vector< int >	node_index
	Capture (receiving / underdrain) node index.
std::vector< int >	num_inlets
	Number of inlets per side.
std::vector< int >	placement
	0=auto, 1=on_grade, 2=on_sag
std::vector< double >	clog_factor
	1.0 - pctClogged/100
std::vector< double >	flow_limit
	Max capture flow per inlet (user flow units), 0=unlimited.
std::vector< double >	local_depress
	Local gutter depression (user length units)
std::vector< double >	local_width
	Local depression width (user length units)
std::vector< int >	street_index
std::vector< std::string >	pending_design_name
std::vector< std::string >	pending_capture_name
std::vector< double >	stat_capture_vol
	Total captured volume (ft³)
std::vector< double >	stat_bypass_vol
	Total bypassed volume (ft³)
std::vector< double >	stat_backflow_vol
	Total backflow volume (ft³)
std::vector< double >	stat_peak_flow
	Peak captured flow (cfs)

Detailed Description

One row per inlet placement. Two host kinds share the store:

• conduit-attribute usage ([INLET_USAGE]): link_index >= 0, node_host == -1
• inlet junction ([INLET_JUNCTIONS]): link_index == -1, node_host >= 0 flow_limit / local_depress / local_width are kept in USER units (as read); InletSolver converts at init.

Member Function Documentation

add_row()

int openswmm::InletUsageStore::add_row ( int link_idx, int node_host_idx, int design_idx, int capture_node_idx )

inline

Append a defaulted row; returns its index.

Here is the call graph for this function:

Here is the caller graph for this function:

count()

int openswmm::InletUsageStore::count ( ) const

inline

Here is the caller graph for this function:

erase_row()

void openswmm::InletUsageStore::erase_row ( int idx )

inline

Here is the caller graph for this function:

find_by_link()

int openswmm::InletUsageStore::find_by_link ( int link_idx ) const

inline

Row index of the usage hosted by conduit link_idx, or -1.

Here is the call graph for this function:

find_by_node_host()

int openswmm::InletUsageStore::find_by_node_host ( int node_idx ) const

inline

Row index of the usage hosted by inlet-junction node node_idx, or -1.

Here is the call graph for this function:

Here is the caller graph for this function:

resize_stats()

void openswmm::InletUsageStore::resize_stats ( int n )

inline

Here is the caller graph for this function:

Member Data Documentation

clog_factor

std::vector<double> openswmm::InletUsageStore::clog_factor

1.0 - pctClogged/100

design_index

std::vector<int> openswmm::InletUsageStore::design_index

Index into InletStore.

flow_limit

std::vector<double> openswmm::InletUsageStore::flow_limit

Max capture flow per inlet (user flow units), 0=unlimited.

link_index

std::vector<int> openswmm::InletUsageStore::link_index

Host conduit link index (-1 for an inlet junction)

local_depress

std::vector<double> openswmm::InletUsageStore::local_depress

Local gutter depression (user length units)

local_width

std::vector<double> openswmm::InletUsageStore::local_width

Local depression width (user length units)

node_host

std::vector<int> openswmm::InletUsageStore::node_host

Host inlet-junction node index (-1 for a conduit usage)

node_index

std::vector<int> openswmm::InletUsageStore::node_index

Capture (receiving / underdrain) node index.

num_inlets

std::vector<int> openswmm::InletUsageStore::num_inlets

Number of inlets per side.

pending_capture_name

std::vector<std::string> openswmm::InletUsageStore::pending_capture_name

pending_design_name

std::vector<std::string> openswmm::InletUsageStore::pending_design_name

Design / capture-node names of an [INLET_JUNCTIONS] row, kept until PostParseResolver turns them into design_index / node_index. Empty on a row whose references were already resolved at parse time.

placement

std::vector<int> openswmm::InletUsageStore::placement

0=auto, 1=on_grade, 2=on_sag

stat_backflow_vol

std::vector<double> openswmm::InletUsageStore::stat_backflow_vol

Total backflow volume (ft³)

stat_bypass_vol

std::vector<double> openswmm::InletUsageStore::stat_bypass_vol

Total bypassed volume (ft³)

stat_capture_vol

std::vector<double> openswmm::InletUsageStore::stat_capture_vol

Total captured volume (ft³)

stat_peak_flow

std::vector<double> openswmm::InletUsageStore::stat_peak_flow

Peak captured flow (cfs)

street_index

std::vector<int> openswmm::InletUsageStore::street_index

Index into StreetStore, resolved by PostParseResolver (-1 if host xsect is not STREET)

---

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

• /home/runner/work/openswmm.engine/openswmm.engine/src/engine/data/InfraData.hpp