engine Directory Reference

Directory dependency graph for engine:

Files
	openswmm_2d.h
	Optional 2D surface routing module — C API.
	openswmm_callbacks.h
	Callback function typedefs for the OpenSWMM Engine C API.
	openswmm_checkpoint.h
	Public C API for creating, inspecting, and restoring simulation checkpoints.
	openswmm_climate.h
	OpenSWMM Engine — Climatology configuration C API.
	openswmm_controls.h
	OpenSWMM Engine — Control Rules C API.
	openswmm_coupling.h
	Public C API for runtime coupling prescriptions and exchanges.
	openswmm_datetime.h
	OpenSWMM Engine — SWMM DateTime conversion utilities (C API).
	openswmm_edit.h
	OpenSWMM Engine — Model editing C API (deletion and type conversion).
	openswmm_engine.h
	OpenSWMM Engine — primary transparent C API (master header).
	openswmm_engine_export.h
	Build-generated visibility and deprecation macros for the engine API.
	openswmm_forcing.h
	Runtime forcing API — inject fluxes with mass-balance tracking.
	openswmm_gages.h
	OpenSWMM Engine — Rain Gage C API.
	openswmm_geopackage.h
	OpenSWMM Engine — GeoPackage C API.
	openswmm_gw2d.h
	G-step 19 — the two-zone groundwater kernel's C API: authoring the [2D_AQUIFER*] rows, and reading the state and ledger while a run is in flight.
	openswmm_gw_transport.h
	U4 (2026-09-07) — C API for the [GW_*] subsurface-transport authoring sections.
	openswmm_heat.h
	Heat-transport configuration as an editable surface (phase H6a).
	openswmm_hotstart.h
	Hot start file management — transparent C API.
	openswmm_infil2d.h
	Per-cell infiltration for the 2D overland-flow mesh — C API.
	openswmm_inflows.h
	OpenSWMM Engine — Inflows (External, DWF, RDII) C API.
	openswmm_infrastructure.h
	OpenSWMM Engine — Infrastructure (Transects, Streets, Inlets, LIDs) C API.
	openswmm_initial_quality.h
	C API — [INITIAL_QUALITY] per-element initial concentrations (E-A4).
	openswmm_links.h
	OpenSWMM Engine — Link (conduit/pump/orifice/weir/outlet) C API.
	openswmm_massbalance.h
	OpenSWMM Engine — Mass Balance / Continuity C API.
	openswmm_model.h
	OpenSWMM Engine — Model building and options C API.
	openswmm_nodes.h
	OpenSWMM Engine — Node C API.
	openswmm_output.h
	OpenSWMM Engine — Output File Reader C API.
	openswmm_output2d.h
	Independent, read-only access to saved 2D HDF5 results.
	openswmm_pollutants.h
	OpenSWMM Engine — Pollutant / Water Quality C API.
	openswmm_process_components.h
	C API — [PROCESS_COMPONENTS] registrations (E-C3 subset of the transport IO plan §5): enumerate, find, register, remove.
	openswmm_quality.h
	OpenSWMM Engine — Water Quality (Landuse / Buildup / Washoff / Treatment) C API.
	openswmm_reactions.h
	C API — the reaction system ([REACTION_*] / .rxn) surface for GUI editors (E-C1: validation + discovery).
	openswmm_snow.h
	Public C API for snow packs, meteorology, and snow model configuration.
	openswmm_snow2d.h
	Public C API for mesh snow pack assignments and SI-unit overrides.
	openswmm_spatial.h
	OpenSWMM Engine — Spatial Frame C API.
	openswmm_sq2d.h
	S7 (2026-09-19) — C API for the 2D surface-quality rows ([2D_COVERAGES], [2D_LOADINGS], [2D_CURB_LENGTH]) and the cell buildup store.
	openswmm_statistics.h
	OpenSWMM Engine — Statistics Query C API.
	openswmm_subcatchments.h
	OpenSWMM Engine — Subcatchment C API.
	openswmm_surface_ownership.h
	Public C API for surface ownership assignments and validation.
	openswmm_tables.h
	OpenSWMM Engine — Tables (Time Series & Curves) and Patterns C API.
	openswmm_trace.h
	Offline flow tracing and travel time over reported hydraulic averages.All dimensional values in this API are SI (m, m3, m3/s, m/s, seconds). Handles are independent, own their inputs, and must be used by one thread at a time. Callbacks run on that thread. No editable model handle is retained. Times are frozen-average, passage-weighted estimates, not particle arrivals.
	openswmm_transport.h
	E6 — the ARD transport configuration surface ([TRANSPORT_OPTIONS], [TRANSPORT_BOUNDARIES], [TRANSPORT_SOURCES]).
	openswmm_water_age.h
	Water-age source-table CRUD (subplan X5 = water-age plan A6, the minimal GUI-facing subset; TRANSPORT_QUALITY_GUI_PLAN §6 prereq 5).
	openswmm_xsect.h
	OpenSWMM Engine — standalone cross-section geometry C API.