Central, reentrant simulation context. More...

#include <SimulationContext.hpp>

Collaboration diagram for openswmm::SimulationContext:

Classes
struct	MassBalance
	Cumulative mass balance totals for runoff and routing. More...

struct	RoutingStepStats

Public Member Functions
void	reset ()
	Fully reset the context to a CREATED state.

void	save_state () noexcept
	Snapshot current state into old-step arrays before solving.

void	reset_state () noexcept
	Reset all state variables to initial conditions (cold start).

void	allocate_objects ()
	Allocate all object arrays after input parsing is complete.

int	n_nodes () const noexcept
	Number of nodes.

int	n_links () const noexcept
	Number of links.

int	n_subcatches () const noexcept
	Number of subcatchments.

int	n_gages () const noexcept
	Number of rain gages.

int	n_pollutants () const noexcept
	Number of pollutants.

int	n_landuses () const noexcept

int	n_tables () const noexcept
	Number of tables (time series + curves).

Public Attributes
EngineState	state = EngineState::CREATED
	Current lifecycle state of the engine.

SimulationOptions	options
	Parsed simulation options (from [OPTIONS] section).

double	current_time = 0.0
	Current simulation time (decimal days from start_date).

double	current_date = 0.0
	Absolute current date/time (decimal days, Julian date).

double	dt_output_remaining = 0.0
	Time remaining until the next output boundary (seconds).

double	dt_controls_remaining = 0.0
	Time remaining until the next control rule event (seconds).

NodeData	nodes
	All node state and properties.

LinkData	links
	All link state and properties.

SubcatchData	subcatches
	All subcatchment state and properties.

GageData	gages
	All rain gage state and properties.

PollutantData	pollutants
	Pollutant definitions and per-object quality state.

TableData	tables
	All time series and rating curves.

NameIndex	node_names
	Node name → node index.

NameIndex	link_names
	Link name → link index.

NameIndex	subcatch_names
	Subcatchment name → subcatchment index.

NameIndex	gage_names
	Rain gage name → gage index.

NameIndex	pollutant_names
	Pollutant name → pollutant index.

NameIndex	table_names
	Time series / curve name → table index.

NameIndex	landuse_names

LanduseData	landuses

BuildupData	buildup

WashoffData	washoff

TreatmentData	treatment

ExtInflowData	ext_inflows

DwfData	dwf_inflows

RDIIAssignData	rdii_assigns

PatternData	patterns

TransectStore	transects

StreetStore	streets

InletStore	inlets

InletUsageStore	inlet_usages

ControlRuleStore	control_rules

SnowpackStore	snowpacks

NameIndex	snowpack_names

AquiferStore	aquifers

NameIndex	aquifer_names

LidControlStore	lid_controls

NameIndex	lid_names

LidUsageStore	lid_usage

SpatialFrame	spatial
	Coordinate reference system and georeferenced coordinates.

UserFlags	user_flags
	User-defined flags from [USER_FLAGS] section.

ForcingData	forcing
	Per-element runtime forcing state (lateral inflows, head boundaries, rainfall, evap, link settings, quality mass fluxes).

std::vector< PluginSpec >	plugin_specs
	Plugin library specs parsed from [PLUGINS].

int	error_code = 0
	Most recent error code (0 = no error).

int	warning_code = 0
	Most recent warning code (0 = no warning).

std::string	error_message
	Human-readable message for the last error/warning.

struct openswmm::SimulationContext::MassBalance	mass_balance

struct openswmm::SimulationContext::RoutingStepStats	routing_stats

std::string	inp_file_path
	Path to the input .inp file (empty if not opened from a file).

Detailed Description

Central, reentrant simulation context.

Owns all simulation data. Passed by (non-const) reference to every solver function. One context per concurrent simulation.

Member Function Documentation

◆ allocate_objects()

void openswmm::SimulationContext::allocate_objects ( )

inline

Allocate all object arrays after input parsing is complete.

Called by InputReader after all [JUNCTIONS], [CONDUITS], etc. sections have been parsed and the final object counts are known. Resizes SoA arrays and pollutant quality matrices.

Note: Name indices must already be populated (resize() uses node_names.size(), etc. to determine array length).