openswmm::inlet::InletSoA Struct Reference

#include <Inlet.hpp>

Collaboration diagram for openswmm::inlet::InletSoA:

Public Member Functions
void	resize (int n)

Public Attributes
int	count = 0
std::vector< int >	link_idx
	Host conduit link index (−1 for a node host)
std::vector< int >	host_node
	Host inlet-junction node (−1 for a conduit host)
std::vector< int >	node_idx
	Capture (receiving) node index.
std::vector< int >	bypass_node
	Node the uncaptured flow stays at.
std::vector< int >	up_link
	Approach conduit (node host: node2 == host)
std::vector< int >	up_link2
	Second inbound conduit at a sag node host (−1)
std::vector< uint8_t >	two_inbound
	1 when both attached conduits flow toward the host
std::vector< int >	inlet_type
std::vector< int >	grate_type
std::vector< double >	grate_length
	ft
std::vector< double >	grate_width
	ft
std::vector< double >	open_area
	GENERIC open-area fraction.
std::vector< double >	splash_veloc
	ft/s (GENERIC)
std::vector< double >	curb_length
	ft
std::vector< double >	curb_height
	ft
std::vector< int >	curb_throat
	0=HORIZONTAL 1=INCLINED 2=VERTICAL
std::vector< double >	slotted_length
	ft
std::vector< double >	slotted_width
	ft
std::vector< int >	curve_index
	CUSTOM: index into ctx.tables.
std::vector< int >	curve_kind
	CUSTOM: inlet::CurveKind.
std::vector< int >	num_inlets
std::vector< double >	clog_factor
std::vector< double >	flow_limit
	cfs per inlet (0 = unlimited)
std::vector< double >	local_depress
	ft
std::vector< double >	local_width
	ft
std::vector< int >	placement
	as authored (inlet::Placement)
std::vector< uint8_t >	is_sag
	resolved placement: 1 = ON_SAG
std::vector< double >	sx
	Cross slope (fraction)
std::vector< double >	gutter_depression
	ft
std::vector< double >	gutter_width
	ft
std::vector< double >	road_roughness
	Manning's n.
std::vector< double >	t_crown
	ft
std::vector< int >	n_sides
std::vector< double >	slope
	Host/approach conduit slope.
std::vector< double >	flow_factor
	Izzard f = (0.56/n)·√SL·Sx^1.67.
std::vector< double >	q_approach
	Approach flow seen this step (cfs)
std::vector< double >	flow_capture
	Captured flow rate (cfs)
std::vector< double >	backflow
	Backflow from the capture node (cfs)
std::vector< double >	backflow_ratio
	inlet backflow / capture-node overflow
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
std::vector< double >	stat_capture_vol
	ft³
std::vector< double >	stat_bypass_vol
	ft³
std::vector< double >	stat_backflow_vol
	ft³
std::vector< double >	stat_peak_flow
	Peak captured flow (cfs)

Member Function Documentation

resize()

void openswmm::inlet::InletSoA::resize

(

int

n

)

Member Data Documentation

avg_flow_capture

std::vector<double> openswmm::inlet::InletSoA::avg_flow_capture

Σ capture efficiency over capture periods.

backflow

std::vector<double> openswmm::inlet::InletSoA::backflow

Backflow from the capture node (cfs)

backflow_periods

std::vector<int> openswmm::inlet::InletSoA::backflow_periods

backflow_ratio

std::vector<double> openswmm::inlet::InletSoA::backflow_ratio

inlet backflow / capture-node overflow

bypass_freq

std::vector<double> openswmm::inlet::InletSoA::bypass_freq

capture periods that also bypassed

bypass_node

std::vector<int> openswmm::inlet::InletSoA::bypass_node

Node the uncaptured flow stays at.

capture_periods

std::vector<int> openswmm::inlet::InletSoA::capture_periods

clog_factor

std::vector<double> openswmm::inlet::InletSoA::clog_factor

count

int openswmm::inlet::InletSoA::count = 0

curb_height

std::vector<double> openswmm::inlet::InletSoA::curb_height

ft

curb_length

std::vector<double> openswmm::inlet::InletSoA::curb_length

ft

curb_throat

std::vector<int> openswmm::inlet::InletSoA::curb_throat

0=HORIZONTAL 1=INCLINED 2=VERTICAL

curve_index

std::vector<int> openswmm::inlet::InletSoA::curve_index

CUSTOM: index into ctx.tables.

curve_kind

std::vector<int> openswmm::inlet::InletSoA::curve_kind

CUSTOM: inlet::CurveKind.

flow_capture

std::vector<double> openswmm::inlet::InletSoA::flow_capture

Captured flow rate (cfs)

flow_factor

std::vector<double> openswmm::inlet::InletSoA::flow_factor

Izzard f = (0.56/n)·√SL·Sx^1.67.

flow_limit

std::vector<double> openswmm::inlet::InletSoA::flow_limit

cfs per inlet (0 = unlimited)

flow_periods

std::vector<int> openswmm::inlet::InletSoA::flow_periods

grate_length

std::vector<double> openswmm::inlet::InletSoA::grate_length

ft

grate_type

std::vector<int> openswmm::inlet::InletSoA::grate_type

grate_width

std::vector<double> openswmm::inlet::InletSoA::grate_width

ft

gutter_depression

std::vector<double> openswmm::inlet::InletSoA::gutter_depression

ft

gutter_width

std::vector<double> openswmm::inlet::InletSoA::gutter_width

ft

host_node

std::vector<int> openswmm::inlet::InletSoA::host_node

Host inlet-junction node (−1 for a conduit host)

inlet_type

std::vector<int> openswmm::inlet::InletSoA::inlet_type

is_sag

std::vector<uint8_t> openswmm::inlet::InletSoA::is_sag

resolved placement: 1 = ON_SAG

link_idx

std::vector<int> openswmm::inlet::InletSoA::link_idx

Host conduit link index (−1 for a node host)

local_depress

std::vector<double> openswmm::inlet::InletSoA::local_depress

ft

local_width

std::vector<double> openswmm::inlet::InletSoA::local_width

ft

n_sides

std::vector<int> openswmm::inlet::InletSoA::n_sides

node_idx

std::vector<int> openswmm::inlet::InletSoA::node_idx

Capture (receiving) node index.

num_inlets

std::vector<int> openswmm::inlet::InletSoA::num_inlets

open_area

std::vector<double> openswmm::inlet::InletSoA::open_area

GENERIC open-area fraction.

peak_flow

std::vector<double> openswmm::inlet::InletSoA::peak_flow

Peak approach flow (cfs)

peak_flow_capture

std::vector<double> openswmm::inlet::InletSoA::peak_flow_capture

Capture efficiency at peak flow (%)

placement

std::vector<int> openswmm::inlet::InletSoA::placement

as authored (inlet::Placement)

q_approach

std::vector<double> openswmm::inlet::InletSoA::q_approach

Approach flow seen this step (cfs)

road_roughness

std::vector<double> openswmm::inlet::InletSoA::road_roughness

Manning's n.

slope

std::vector<double> openswmm::inlet::InletSoA::slope

Host/approach conduit slope.

slotted_length

std::vector<double> openswmm::inlet::InletSoA::slotted_length

ft

slotted_width

std::vector<double> openswmm::inlet::InletSoA::slotted_width

ft

splash_veloc

std::vector<double> openswmm::inlet::InletSoA::splash_veloc

ft/s (GENERIC)

stat_backflow_vol

std::vector<double> openswmm::inlet::InletSoA::stat_backflow_vol

ft³

stat_bypass_vol

std::vector<double> openswmm::inlet::InletSoA::stat_bypass_vol

ft³

stat_capture_vol

std::vector<double> openswmm::inlet::InletSoA::stat_capture_vol

ft³

stat_peak_flow

std::vector<double> openswmm::inlet::InletSoA::stat_peak_flow

Peak captured flow (cfs)

sx

std::vector<double> openswmm::inlet::InletSoA::sx

Cross slope (fraction)

t_crown

std::vector<double> openswmm::inlet::InletSoA::t_crown

ft

two_inbound

std::vector<uint8_t> openswmm::inlet::InletSoA::two_inbound

1 when both attached conduits flow toward the host

up_link

std::vector<int> openswmm::inlet::InletSoA::up_link

Approach conduit (node host: node2 == host)

up_link2

std::vector<int> openswmm::inlet::InletSoA::up_link2

Second inbound conduit at a sag node host (−1)

---

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

• /home/runner/work/openswmm.engine/openswmm.engine/src/engine/hydraulics/Inlet.hpp
• /home/runner/work/openswmm.engine/openswmm.engine/src/engine/hydraulics/Inlet.cpp