openswmm::lid Namespace Reference

Classes
struct	LIDGroupSoA
class	LIDSolver

Enumerations
enum class	LIDType : int {   BIO_CELL = 0 ,   RAIN_GARDEN = 1 ,   GREEN_ROOF = 2 ,   INFIL_TRENCH = 3 ,   PERM_PAVEMENT = 4 ,   RAIN_BARREL = 5 ,   VEG_SWALE = 6 ,   ROOF_DISCON = 7 }

Functions
double	completedUnitStorage (const LIDGroupSoA &g, int unit)
	Measure one completed-source unit using its physical layer geometry.
bool	hasNativeBottom (LIDType type, double storage_thickness, double storage_ksat)
	Classify whether an enumerated LID has an infiltrating native-soil bottom.
bool	hasNativeBottom (const std::string &type, double thickness, double ksat)
	Classify native-soil contact from an exact authored type code.

Variables
constexpr int	SURF = 0
constexpr int	SOIL = 1
constexpr int	STOR = 2
constexpr int	PAVE = 3
constexpr int	N_LAYERS = 4

Enumeration Type Documentation

LIDType

enum class openswmm::lid::LIDType : int

strong

Enumerator
BIO_CELL
RAIN_GARDEN
GREEN_ROOF
INFIL_TRENCH
PERM_PAVEMENT
RAIN_BARREL
VEG_SWALE
ROOF_DISCON

Function Documentation

completedUnitStorage()

double openswmm::lid::completedUnitStorage	(	const LIDGroupSoA &	g,
		int	unit )

Measure one completed-source unit using its physical layer geometry.

For a swale, a positive valid surface height is required by the minimum-bottom-width correction. This differs from the planar arithmetic used by storedVolume().

Parameters

[in]	g	Initialized group with all arrays covering unit; internal ft and ft2 units.
[in]	unit	Unit index in [0, g.count); bounds are unchecked.

Returns

Stored water volume in ft3. Swales use the trapezoidal cross section and aggregate footprint; other types sum void-weighted layer stores.

hasNativeBottom() [1/2]

bool openswmm::lid::hasNativeBottom ( const std::string & type, double thickness, double ksat )

inline

Classify native-soil contact from an exact authored type code.

Parameters

[in]	type	Case-sensitive code: VS, BC, RG, IT or PP can qualify; unknown codes return false.
[in]	thickness	Storage thickness; any consistent length unit, tested against zero.
[in]	ksat	Storage exfiltration conductivity, tested against zero.

Returns

True for VS, or for BC/RG/IT/PP when thickness <= 0 or ksat > 0.

hasNativeBottom() [2/2]

bool openswmm::lid::hasNativeBottom ( LIDType type, double storage_thickness, double storage_ksat )

inline

Classify whether an enumerated LID has an infiltrating native-soil bottom.

Parameters

[in]	type	LID type; swales always qualify, and BC/RG/IT/PP qualify under the storage test.
[in]	storage_thickness	Storage-layer thickness; only its sign matters, in any consistent length unit.
[in]	storage_ksat	Storage exfiltration conductivity; only its sign matters.

Returns

True for a swale or an eligible type with absent storage (thickness <= 0) or positive storage conductivity; false for other types.

Here is the caller graph for this function:

Variable Documentation

N_LAYERS

int openswmm::lid::N_LAYERS = 4

constexpr

PAVE

int openswmm::lid::PAVE = 3

constexpr

SOIL

int openswmm::lid::SOIL = 1

constexpr

STOR

int openswmm::lid::STOR = 2

constexpr

SURF

int openswmm::lid::SURF = 0

constexpr