System mass-balance totals for the optional 2D surface domain. More...

#include <SimulationContext.hpp>

Collaboration diagram for openswmm::SimulationContext::MassBalance2D:

Public Member Functions
double	error () const
	2D surface continuity error (fraction).

Public Attributes
double	init_storage = 0.0
	Initial surface storage (m³)

double	final_storage = 0.0
	Latest surface storage (m³)

double	rainfall_in = 0.0
	Cumulative rainfall volume (m³)

double	coupling_1d_to_2d_in = 0.0
	Cumulative 1D→2D spill into 2D (m³)

double	coupling_2d_to_1d_out = 0.0
	Cumulative 2D→1D drainage out (m³)

double	outfall_in = 0.0
	Cumulative 1D outfall discharge into 2D (m³)

double	outfall_out = 0.0
	Cumulative 2D→pipe withdrawal at submerged outfalls (m³)

double	boundary_in = 0.0
	Cumulative boundary inflow (m³)

double	boundary_out = 0.0
	Cumulative boundary outflow (m³)

double	evap_out = 0.0
	Cumulative evaporation loss (m³)

bool	active = false
	True if the 2D module ran.

Detailed Description

System mass-balance totals for the optional 2D surface domain.

Accumulated each executed 2D step by SurfaceRouter2D. Unlike the 1D MassBalance (ft³ for US flow units), all volumes here are in the 2D solver's SI internal units (m³). This is a SEPARATE balance from the 1D routing balance: the coupling terms are inflows/outflows of the 2D domain, signed oppositely to the 1D routing_external/routing_flooding terms.

Member Function Documentation

◆ error()

double openswmm::SimulationContext::MassBalance2D::error ( ) const

inline

2D surface continuity error (fraction).

Member Data Documentation

◆ active

bool openswmm::SimulationContext::MassBalance2D::active = false

True if the 2D module ran.

◆ boundary_in

double openswmm::SimulationContext::MassBalance2D::boundary_in = 0.0

Cumulative boundary inflow (m³)

◆ boundary_out

double openswmm::SimulationContext::MassBalance2D::boundary_out = 0.0

Cumulative boundary outflow (m³)

◆ coupling_1d_to_2d_in

double openswmm::SimulationContext::MassBalance2D::coupling_1d_to_2d_in = 0.0

Cumulative 1D→2D spill into 2D (m³)

◆ coupling_2d_to_1d_out

double openswmm::SimulationContext::MassBalance2D::coupling_2d_to_1d_out = 0.0

Cumulative 2D→1D drainage out (m³)

◆ evap_out

double openswmm::SimulationContext::MassBalance2D::evap_out = 0.0

Cumulative evaporation loss (m³)

◆ final_storage

double openswmm::SimulationContext::MassBalance2D::final_storage = 0.0

Latest surface storage (m³)

◆ init_storage

double openswmm::SimulationContext::MassBalance2D::init_storage = 0.0

Initial surface storage (m³)

◆ outfall_in

double openswmm::SimulationContext::MassBalance2D::outfall_in = 0.0

Cumulative 1D outfall discharge into 2D (m³)

◆ outfall_out

double openswmm::SimulationContext::MassBalance2D::outfall_out = 0.0

Cumulative 2D→pipe withdrawal at submerged outfalls (m³)

◆ rainfall_in

double openswmm::SimulationContext::MassBalance2D::rainfall_in = 0.0

Cumulative rainfall volume (m³)

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