openswmm::InletStore Struct Reference

#include <InfraData.hpp>

Collaboration diagram for openswmm::InletStore:

Public Member Functions
int	count () const
int	add_row (const std::string &name, const std::string &type)
	Append a fully defaulted row; returns its index.
void	erase_row (int idx)

Public Attributes
std::vector< std::string >	names
std::vector< std::string >	inlet_type
	GRATE/CURB/COMBO/SLOTTED/DROP_GRATE/DROP_CURB/CUSTOM.
std::vector< double >	length
	grate or slotted length
std::vector< double >	width
	grate or slotted width
std::vector< std::string >	grate_type
	P_BAR-50, P_BAR-50x100, P_BAR-30, CURVED_VANE, TILT_BAR-45, TILT_BAR-30, RETICULINE, GENERIC.
std::vector< double >	open_area
	GENERIC only: open-area fraction (0,1].
std::vector< double >	splash_veloc
	GENERIC only: splash-over velocity.
std::vector< double >	curb_length
	CURB/DROP_CURB/COMBO.
std::vector< double >	curb_height
	CURB/DROP_CURB/COMBO.
std::vector< int >	curb_throat
	0=HORIZONTAL 1=INCLINED 2=VERTICAL (legacy ThroatAngleWords order); default 2
std::vector< std::string >	curve_id
	CUSTOM: capture curve name.
std::vector< int >	curve_index
	CUSTOM: resolved curve index (-1 until PostParseResolver)
std::vector< int >	curve_kind
	CUSTOM: 0=unresolved, 1=DIVERSION (captured vs approach flow), 2=RATING (captured vs depth)
std::vector< std::string >	comments
	optional description (round-tripped as ';' comment)

Detailed Description

Inlet design store. All lengths/velocities are kept in USER (display) units exactly as read from the .inp (as StreetStore does); the runtime InletSolver converts to internal units at init.

Column usage by type (2026-09-05 schema, see plans/INLET_JUNCTION_IMPLEMENTATION_PLAN_2026-09-05.md §2.5): GRATE / DROP_GRATE : length, width, grate_type, open_area, splash_veloc SLOTTED : length, width CURB / DROP_CURB : curb_length, curb_height, curb_throat COMBO : grate columns + curb columns (legacy two-line form: a GRATE line and a CURB line sharing one name are merged into a single COMBO row by handle_inlets) CUSTOM : curve_id, curve_index, curve_kind

Member Function Documentation

add_row()

int openswmm::InletStore::add_row ( const std::string & name, const std::string & type )

inline

Append a fully defaulted row; returns its index.

Here is the call graph for this function:

Here is the caller graph for this function:

count()

int openswmm::InletStore::count ( ) const

inline

Here is the caller graph for this function:

erase_row()

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

inline

Here is the caller graph for this function:

Member Data Documentation

comments

std::vector<std::string> openswmm::InletStore::comments

optional description (round-tripped as ';' comment)

curb_height

std::vector<double> openswmm::InletStore::curb_height

CURB/DROP_CURB/COMBO.

curb_length

std::vector<double> openswmm::InletStore::curb_length

CURB/DROP_CURB/COMBO.

curb_throat

std::vector<int> openswmm::InletStore::curb_throat

0=HORIZONTAL 1=INCLINED 2=VERTICAL (legacy ThroatAngleWords order); default 2

curve_id

std::vector<std::string> openswmm::InletStore::curve_id

CUSTOM: capture curve name.

curve_index

std::vector<int> openswmm::InletStore::curve_index

CUSTOM: resolved curve index (-1 until PostParseResolver)

curve_kind

std::vector<int> openswmm::InletStore::curve_kind

CUSTOM: 0=unresolved, 1=DIVERSION (captured vs approach flow), 2=RATING (captured vs depth)

grate_type

std::vector<std::string> openswmm::InletStore::grate_type

P_BAR-50, P_BAR-50x100, P_BAR-30, CURVED_VANE, TILT_BAR-45, TILT_BAR-30, RETICULINE, GENERIC.

inlet_type

std::vector<std::string> openswmm::InletStore::inlet_type

GRATE/CURB/COMBO/SLOTTED/DROP_GRATE/DROP_CURB/CUSTOM.

length

std::vector<double> openswmm::InletStore::length

grate or slotted length

names

std::vector<std::string> openswmm::InletStore::names

open_area

std::vector<double> openswmm::InletStore::open_area

GENERIC only: open-area fraction (0,1].

splash_veloc

std::vector<double> openswmm::InletStore::splash_veloc

GENERIC only: splash-over velocity.

width

std::vector<double> openswmm::InletStore::width

grate or slotted width

---

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

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