#include <UnitConversion.hpp>

Collaboration diagram for openswmm::ucf::DisplayUnits:

Public Member Functions
double	temperature (double tF) const
	Internal temperature (°F) → display (°F for US, °C for SI).

Static Public Member Functions
static DisplayUnits	from (const SimulationOptions &opts)
	Build from simulation options (selects unit system + flow units).

Public Attributes
int	unit_system = 0
	0 = US, 1 = SI

int	flow_units = 0
	FlowUnits enum value.

double	flow = 1.0
	cfs → display flow (Qcf)

double	length = 1.0
	ft → ft \| m

double	volume = 1.0
	ft³ → ft³ \| m³

double	rainfall = 1.0
	ft/s → in/hr \| mm/hr

double	raindepth = 1.0
	ft → in \| mm (also runoff-depth columns)

double	evaprate = 1.0
	ft/s → in/day \| mm/day

double	landarea = 1.0
	ft² → ac \| ha

double	mvol = 1.0
	ft³ → 10^6 gal \| 10^6 ltr

double	landvol = 1.0
	ft³ → acre-ft \| hectare-m

const char *	flow_word = "CFS"
	CFS \| CMS \| ...

const char *	length_word = "Feet"
	depth / HGL / surcharge column

const char *	depth_word = "in"
	rainfall / runoff depth (in \| mm)

const char *	vel_word = "ft/sec"
	link velocity (ft/sec \| m/sec)

const char *	mvol_word = "10^6 gal"
	10^6 gal \| 10^6 ltr

const char *	landvol_word = "acre-feet"
	acre-feet \| hectare-m

const char *	storage_vol_word = "1000 ft3"
	1000 ft3 \| 1000 m3

Member Function Documentation

◆ from()

DisplayUnits openswmm::ucf::DisplayUnits::from ( const SimulationOptions & opts )

static

Build from simulation options (selects unit system + flow units).

Here is the call graph for this function:

◆ temperature()

double openswmm::ucf::DisplayUnits::temperature ( double tF ) const

inline

Internal temperature (°F) → display (°F for US, °C for SI).

Member Data Documentation

◆ depth_word

const char* openswmm::ucf::DisplayUnits::depth_word = "in"

rainfall / runoff depth (in | mm)

◆ evaprate

double openswmm::ucf::DisplayUnits::evaprate = 1.0

ft/s → in/day | mm/day

◆ flow

double openswmm::ucf::DisplayUnits::flow = 1.0

cfs → display flow (Qcf)

◆ flow_units

int openswmm::ucf::DisplayUnits::flow_units = 0

FlowUnits enum value.

◆ flow_word

const char* openswmm::ucf::DisplayUnits::flow_word = "CFS"

CFS | CMS | ...

◆ landarea

double openswmm::ucf::DisplayUnits::landarea = 1.0

ft² → ac | ha

◆ landvol

double openswmm::ucf::DisplayUnits::landvol = 1.0

ft³ → acre-ft | hectare-m

◆ landvol_word

const char* openswmm::ucf::DisplayUnits::landvol_word = "acre-feet"

acre-feet | hectare-m

◆ length

double openswmm::ucf::DisplayUnits::length = 1.0

ft → ft | m

◆ length_word

const char* openswmm::ucf::DisplayUnits::length_word = "Feet"

depth / HGL / surcharge column

◆ mvol

double openswmm::ucf::DisplayUnits::mvol = 1.0

ft³ → 10^6 gal | 10^6 ltr

◆ mvol_word

const char* openswmm::ucf::DisplayUnits::mvol_word = "10^6 gal"

10^6 gal | 10^6 ltr

◆ raindepth

double openswmm::ucf::DisplayUnits::raindepth = 1.0

ft → in | mm (also runoff-depth columns)

◆ rainfall

double openswmm::ucf::DisplayUnits::rainfall = 1.0

ft/s → in/hr | mm/hr

◆ storage_vol_word

const char* openswmm::ucf::DisplayUnits::storage_vol_word = "1000 ft3"

1000 ft3 | 1000 m3

◆ unit_system

int openswmm::ucf::DisplayUnits::unit_system = 0

0 = US, 1 = SI

◆ vel_word

const char* openswmm::ucf::DisplayUnits::vel_word = "ft/sec"

link velocity (ft/sec | m/sec)

◆ volume

double openswmm::ucf::DisplayUnits::volume = 1.0

ft³ → ft³ | m³

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

/home/runner/work/openswmm.engine/openswmm.engine/src/engine/core/UnitConversion.hpp
/home/runner/work/openswmm.engine/openswmm.engine/src/engine/core/UnitConversion.cpp

Public Member Functions

Static Public Member Functions

Public Attributes