Cumulative mass balance totals for runoff and routing. More...

#include <SimulationContext.hpp>

Collaboration diagram for openswmm::SimulationContext::MassBalance:

Public Member Functions
void	resize_quality (int n_pollutants)

void	reset ()

double	runoff_error () const
	Runoff continuity error (fraction).

double	routing_error () const
	Routing continuity error (fraction).

double	gw_error () const
	Groundwater continuity error (fraction). Gap #72.

Public Attributes
double	runoff_rainfall = 0.0
	Total rainfall volume (ft3)

double	runoff_runon = 0.0
	Outfall-routed runon volume (ft3), legacy RUNOFF_RUNON.

double	runoff_evap = 0.0
	Total evaporation volume (ft3)

double	runoff_infil = 0.0
	Total infiltration volume (ft3)

double	runoff_runoff = 0.0
	Total surface runoff volume (ft3)

double	runoff_lid_drain = 0.0
	LID drain-to-node outflow (ft3), legacy RUNOFF_DRAINS / VlidDrain.

double	runoff_snowremov = 0.0
	Total snow removal volume (ft3)

double	runoff_init_store = 0.0
	Initial surface storage (ft3)

double	runoff_final_store = 0.0

double	runoff_init_snow = 0.0

double	runoff_final_snow = 0.0

double	routing_dry_weather = 0.0

double	routing_wet_weather = 0.0

double	routing_gw_inflow = 0.0

double	routing_rdii = 0.0

double	routing_external = 0.0

double	routing_flooding = 0.0

double	routing_coupling_out = 0.0

double	routing_outflow = 0.0

double	routing_evap_loss = 0.0

double	routing_seep_loss = 0.0

double	routing_init_storage = 0.0

double	routing_final_storage = 0.0

double	routing_forcing_inflow = 0.0
	Cumulative user-forced lateral inflow (ft3)

std::vector< double >	routing_forcing_qual_inflow
	Per-pollutant cumulative user-forced quality mass.

double	gw_infil = 0.0
	Cumulative infiltration to GW (ft)

double	gw_upper_evap = 0.0
	Cumulative upper zone evaporation (ft)

double	gw_lower_evap = 0.0
	Cumulative lower zone evaporation (ft)

double	gw_lower_perc = 0.0
	Cumulative deep percolation (ft)

double	gw_lateral_flow = 0.0
	Cumulative lateral GW flow (ft)

double	gw_init_storage = 0.0
	Initial GW storage (ft)

double	gw_final_storage = 0.0

double	gw_infil_2d_recharge = 0.0

double	step_flooding = 0.0

double	step_outflow = 0.0

double	step_dw_inflow = 0.0

double	step_gw_inflow = 0.0

double	step_rdii_inflow = 0.0

double	step_ext_inflow = 0.0

std::vector< double >	qual_init_buildup
	Initial buildup mass.

std::vector< double >	qual_final_buildup
	Final buildup mass.

std::vector< double >	qual_surface_buildup
	Accumulated buildup during sim.

std::vector< double >	qual_wet_deposition
	Wet deposition mass.

std::vector< double >	qual_sweeping
	Mass removed by sweeping.

std::vector< double >	qual_bmp_removal
	BMP treatment removal.

std::vector< double >	qual_infil_loss
	Mass lost to infiltration.

std::vector< double >	qual_runoff_load
	Mass load in surface runoff.

std::vector< double >	qual_routing_wet
	Wet weather quality inflow to routing.

std::vector< double >	qual_routing_outflow
	Quality mass leaving at outfalls.

std::vector< double >	qual_routing_flood
	Quality mass lost to flooding.

std::vector< double >	qual_routing_init
	Initial stored quality mass.

std::vector< double >	qual_routing_final
	Final stored quality mass.

std::vector< double >	qual_routing_reacted
	Quality mass lost to decay.

std::vector< double >	qual_routing_ii_in
	RDII quality mass inflow.

std::vector< double >	qual_routing_dw_in
	Dry weather quality mass inflow.

std::vector< double >	qual_routing_gw_in
	Groundwater quality mass inflow.

std::vector< double >	qual_routing_ex_in
	External (interface file) quality mass inflow.

std::vector< double >	qual_routing_seep
	Quality mass lost to seepage.

std::vector< double >	qual_routing_evap
	Quality mass lost to evaporation.

Detailed Description

Cumulative mass balance totals for runoff and routing.

Updated every timestep by the runoff and routing modules. Stored as contiguous doubles for batch accumulation. All volumes in ft3, all flows integrated to volumes.

See also: Legacy: RunoffTotals, RoutingTotals in massbal.c

Member Function Documentation

◆ gw_error()

double openswmm::SimulationContext::MassBalance::gw_error ( ) const

inline

Groundwater continuity error (fraction). Gap #72.

◆ reset()

void openswmm::SimulationContext::MassBalance::reset ( )

inline

◆ resize_quality()

void openswmm::SimulationContext::MassBalance::resize_quality ( int n_pollutants )

inline

Here is the call graph for this function:

◆ routing_error()

double openswmm::SimulationContext::MassBalance::routing_error ( ) const

inline

Routing continuity error (fraction).

Here is the caller graph for this function:

◆ runoff_error()

double openswmm::SimulationContext::MassBalance::runoff_error ( ) const

inline

Runoff continuity error (fraction).

Here is the caller graph for this function:

Member Data Documentation

◆ gw_final_storage

double openswmm::SimulationContext::MassBalance::gw_final_storage = 0.0

Final GW storage (ft)

◆ gw_infil

double openswmm::SimulationContext::MassBalance::gw_infil = 0.0

Cumulative infiltration to GW (ft)

◆ gw_infil_2d_recharge

double openswmm::SimulationContext::MassBalance::gw_infil_2d_recharge = 0.0

U3 (track I-b, 2026-09-07): the part of the groundwater's infiltration input that arrived from the 2D surface ([2D_OPTIONS] INFIL_DESTINATION SUBCATCH_AQUIFER), ft³ — the same unit as gw_infil (rate × area × dt). Already inside it: the recharge is added to each subcatchment's infiltration rate before GWSolver::execute books it, so this is a diagnostic split, not a second inflow.

◆ gw_init_storage

double openswmm::SimulationContext::MassBalance::gw_init_storage = 0.0

Initial GW storage (ft)

◆ gw_lateral_flow

double openswmm::SimulationContext::MassBalance::gw_lateral_flow = 0.0

Cumulative lateral GW flow (ft)

◆ gw_lower_evap

double openswmm::SimulationContext::MassBalance::gw_lower_evap = 0.0

Cumulative lower zone evaporation (ft)

◆ gw_lower_perc

double openswmm::SimulationContext::MassBalance::gw_lower_perc = 0.0

Cumulative deep percolation (ft)

◆ gw_upper_evap

double openswmm::SimulationContext::MassBalance::gw_upper_evap = 0.0

Cumulative upper zone evaporation (ft)

◆ qual_bmp_removal

std::vector<double> openswmm::SimulationContext::MassBalance::qual_bmp_removal

BMP treatment removal.

◆ qual_final_buildup

std::vector<double> openswmm::SimulationContext::MassBalance::qual_final_buildup

Final buildup mass.

◆ qual_infil_loss

std::vector<double> openswmm::SimulationContext::MassBalance::qual_infil_loss

Mass lost to infiltration.

◆ qual_init_buildup

std::vector<double> openswmm::SimulationContext::MassBalance::qual_init_buildup

Initial buildup mass.

◆ qual_routing_dw_in

std::vector<double> openswmm::SimulationContext::MassBalance::qual_routing_dw_in

Dry weather quality mass inflow.

◆ qual_routing_evap

std::vector<double> openswmm::SimulationContext::MassBalance::qual_routing_evap

Quality mass lost to evaporation.

◆ qual_routing_ex_in

std::vector<double> openswmm::SimulationContext::MassBalance::qual_routing_ex_in

External (interface file) quality mass inflow.

◆ qual_routing_final

std::vector<double> openswmm::SimulationContext::MassBalance::qual_routing_final

Final stored quality mass.

◆ qual_routing_flood

std::vector<double> openswmm::SimulationContext::MassBalance::qual_routing_flood

Quality mass lost to flooding.

◆ qual_routing_gw_in

std::vector<double> openswmm::SimulationContext::MassBalance::qual_routing_gw_in

Groundwater quality mass inflow.

◆ qual_routing_ii_in

std::vector<double> openswmm::SimulationContext::MassBalance::qual_routing_ii_in

RDII quality mass inflow.

◆ qual_routing_init

std::vector<double> openswmm::SimulationContext::MassBalance::qual_routing_init

Initial stored quality mass.

◆ qual_routing_outflow

std::vector<double> openswmm::SimulationContext::MassBalance::qual_routing_outflow

Quality mass leaving at outfalls.

◆ qual_routing_reacted

std::vector<double> openswmm::SimulationContext::MassBalance::qual_routing_reacted

Quality mass lost to decay.

◆ qual_routing_seep

std::vector<double> openswmm::SimulationContext::MassBalance::qual_routing_seep

Quality mass lost to seepage.

◆ qual_routing_wet

std::vector<double> openswmm::SimulationContext::MassBalance::qual_routing_wet

Wet weather quality inflow to routing.

◆ qual_runoff_load

std::vector<double> openswmm::SimulationContext::MassBalance::qual_runoff_load

Mass load in surface runoff.

◆ qual_surface_buildup

std::vector<double> openswmm::SimulationContext::MassBalance::qual_surface_buildup

Accumulated buildup during sim.

◆ qual_sweeping

std::vector<double> openswmm::SimulationContext::MassBalance::qual_sweeping

Mass removed by sweeping.

◆ qual_wet_deposition

std::vector<double> openswmm::SimulationContext::MassBalance::qual_wet_deposition

Wet deposition mass.

◆ routing_coupling_out

double openswmm::SimulationContext::MassBalance::routing_coupling_out = 0.0

C2 (2026-09-07): cumulative water the 1D→2D coupling spill removed from coupled nodes (ft³). It used to be folded into routing_flooding, which reported a coupling TRANSFER under "Flooding Loss" — the water did not flood, it went to the 2D surface, where MassBalance2D::coupling_1d_to_2d_in books it arriving. Both ledgers are individually right; only the 1D report row was misleading, and a modeller reading it saw flooding they did not have.

It remains an OUTFLOW of the 1D system, so routing_error() counts it exactly as before — this change moves a number between report rows, it does not move water.

[2D_OPTIONS] COUPLING_IN_FLOODING YES restores the old grouping for run-to-run comparison against previous versions.

◆ routing_dry_weather

double openswmm::SimulationContext::MassBalance::routing_dry_weather = 0.0

◆ routing_evap_loss

double openswmm::SimulationContext::MassBalance::routing_evap_loss = 0.0

◆ routing_external

double openswmm::SimulationContext::MassBalance::routing_external = 0.0

◆ routing_final_storage

double openswmm::SimulationContext::MassBalance::routing_final_storage = 0.0

◆ routing_flooding

double openswmm::SimulationContext::MassBalance::routing_flooding = 0.0

◆ routing_forcing_inflow

double openswmm::SimulationContext::MassBalance::routing_forcing_inflow = 0.0

Cumulative user-forced lateral inflow (ft3)

◆ routing_forcing_qual_inflow

std::vector<double> openswmm::SimulationContext::MassBalance::routing_forcing_qual_inflow

Per-pollutant cumulative user-forced quality mass.

◆ routing_gw_inflow

double openswmm::SimulationContext::MassBalance::routing_gw_inflow = 0.0

◆ routing_init_storage

double openswmm::SimulationContext::MassBalance::routing_init_storage = 0.0

◆ routing_outflow

double openswmm::SimulationContext::MassBalance::routing_outflow = 0.0

◆ routing_rdii

double openswmm::SimulationContext::MassBalance::routing_rdii = 0.0

◆ routing_seep_loss

double openswmm::SimulationContext::MassBalance::routing_seep_loss = 0.0

◆ routing_wet_weather

double openswmm::SimulationContext::MassBalance::routing_wet_weather = 0.0

◆ runoff_evap

double openswmm::SimulationContext::MassBalance::runoff_evap = 0.0

Total evaporation volume (ft3)

◆ runoff_final_snow

double openswmm::SimulationContext::MassBalance::runoff_final_snow = 0.0

The same quantity at the end of the run (ft3). Legacy RunoffTotals.finalSnowCover.

These two, and runoff_snowremov, were the whole of F8. The ledger had no snow terms at all, so on any deck with a [SNOWPACKS] section the starting pack was unaccounted INPUT and the surviving pack unaccounted OUTPUT, and the printed continuity percentage was not a meaningful number. Measured on the snow parity deck: -8.193 % before, +1.419 % after.

◆ runoff_final_store

double openswmm::SimulationContext::MassBalance::runoff_final_store = 0.0

Final surface storage (ft3)

◆ runoff_infil

double openswmm::SimulationContext::MassBalance::runoff_infil = 0.0

Total infiltration volume (ft3)

◆ runoff_init_snow

double openswmm::SimulationContext::MassBalance::runoff_init_snow = 0.0

Snow water equivalent PLUS free water held in every pack at the start of the run (ft3). Legacy RunoffTotals.initSnowCover, summed from snow_getSnowCover (snow.c:587).

◆ runoff_init_store

double openswmm::SimulationContext::MassBalance::runoff_init_store = 0.0

Initial surface storage (ft3)

◆ runoff_lid_drain

double openswmm::SimulationContext::MassBalance::runoff_lid_drain = 0.0

LID drain-to-node outflow (ft3), legacy RUNOFF_DRAINS / VlidDrain.

◆ runoff_rainfall

double openswmm::SimulationContext::MassBalance::runoff_rainfall = 0.0

Total rainfall volume (ft3)

◆ runoff_runoff

double openswmm::SimulationContext::MassBalance::runoff_runoff = 0.0

Total surface runoff volume (ft3)

◆ runoff_runon

double openswmm::SimulationContext::MassBalance::runoff_runon = 0.0

Outfall-routed runon volume (ft3), legacy RUNOFF_RUNON.

◆ runoff_snowremov

double openswmm::SimulationContext::MassBalance::runoff_snowremov = 0.0

Total snow removal volume (ft3)

◆ step_dw_inflow

double openswmm::SimulationContext::MassBalance::step_dw_inflow = 0.0

◆ step_ext_inflow

double openswmm::SimulationContext::MassBalance::step_ext_inflow = 0.0

◆ step_flooding

double openswmm::SimulationContext::MassBalance::step_flooding = 0.0

◆ step_gw_inflow

double openswmm::SimulationContext::MassBalance::step_gw_inflow = 0.0

◆ step_outflow

double openswmm::SimulationContext::MassBalance::step_outflow = 0.0

◆ step_rdii_inflow

double openswmm::SimulationContext::MassBalance::step_rdii_inflow = 0.0

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

/home/runner/work/openswmm.engine/openswmm.engine/src/engine/core/SimulationContext.hpp

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ gw_error()

◆ reset()

◆ resize_quality()

◆ routing_error()

◆ runoff_error()

Member Data Documentation

◆ gw_final_storage

◆ gw_infil

◆ gw_infil_2d_recharge

◆ gw_init_storage

◆ gw_lateral_flow

◆ gw_lower_evap

◆ gw_lower_perc

◆ gw_upper_evap

◆ qual_bmp_removal

◆ qual_final_buildup

◆ qual_infil_loss

◆ qual_init_buildup

◆ qual_routing_dw_in

◆ qual_routing_evap

◆ qual_routing_ex_in

◆ qual_routing_final

◆ qual_routing_flood

◆ qual_routing_gw_in

◆ qual_routing_ii_in

◆ qual_routing_init

◆ qual_routing_outflow

◆ qual_routing_reacted

◆ qual_routing_seep

◆ qual_routing_wet

◆ qual_runoff_load

◆ qual_surface_buildup

◆ qual_sweeping

◆ qual_wet_deposition

◆ routing_coupling_out

◆ routing_dry_weather

◆ routing_evap_loss

◆ routing_external

◆ routing_final_storage

◆ routing_flooding

◆ routing_forcing_inflow

◆ routing_forcing_qual_inflow

◆ routing_gw_inflow

◆ routing_init_storage

◆ routing_outflow

◆ routing_rdii

◆ routing_seep_loss

◆ routing_wet_weather

◆ runoff_evap

◆ runoff_final_snow

◆ runoff_final_store

◆ runoff_infil

◆ runoff_init_snow

◆ runoff_init_store

◆ runoff_lid_drain

◆ runoff_rainfall

◆ runoff_runoff

◆ runoff_runon

◆ runoff_snowremov

◆ step_dw_inflow

◆ step_ext_inflow

◆ step_flooding

◆ step_gw_inflow

◆ step_outflow

◆ step_rdii_inflow