![]() |
OpenSWMM Engine
6.0.0-alpha.4
Data-oriented, plugin-extensible SWMM Engine (6.0.0-alpha.4)
|
| ▼Climate File Constants, Enumerations, Shared Variables, and Functions | Climate file constants, enumeration types, shared variables, and functions |
| Climate Files Shared Variables | Climate files shared variables |
| Climate Related Local Functions | Climate related local functions |
| Climate File Constants and Enumerations | Climate files local constants and enumeration types |
| ▼SWMM Constants, Variables, and Local and API Functions | Constants, variables, local, and API functions used in the SWMM model |
| SWMM General Constants | General constants used in the SWMM model |
| Units factor in Manning Equation | Units factor in Manning Equation |
| Definition of Measureable Runoff, Flow, and Depth | Definition of measureable runoff, flow, and depth |
| Minimum Flow, Depth, and Volume Used to Evaluate Steady State Conditions | Minimum flow, depth, and volume used to evaluate steady state conditions |
| Minimum Flow Depth and Area for Dynamic Wave Routing | Minimum Flow Depth and Area for Dynamic Wave Routing |
| Various Conversion Factors | Various Conversion Factors |
| Token Separator Characters | Token separator characters |
| SWMM Enumerations | Enumerated constants used in the SWMM model |
| SWMM Error Constants | General error constants used in the SWMM model |
| ▼Controls File Constants, Enumerations, Structs, Shared Variables, and Functions | Controls file constants, enumerations, structs, shared variables, and functions |
| Controls File Enumerations | Controls enumeration types |
| Controls File Variables | Controls file variables and definitions |
| Controls File Structures | Controls structures |
| Controls File Functions | Controls file local functions |
| ▼Exfil File Constants, Enumerations, Structs, Shared Variables, and Functions | Exfile file constants, enumerations, structs, shared variables, and functions |
| Exfil File Structures | Exfil structures |
| Exfil File Functions | Exfil file functions |
| ▼SWMM Global Interfacing Functions | SWMM global interfacing functions |
| Global Project Methods | Global methods associated with a SWMM project |
| Global Input Reader Methods | Global input reader methods |
| Global Report Writer Methods | Global report writer methods |
| Global Temperature/Evaporation Methods | Global temperature/evaporation methods |
| Global Rainfall Processing Methods | Global rainfall processing methods |
| Global Snowmelt Processing Methods | Global snowmelt processing methods |
| Global Runoff Analyzer Methods | Global runoff analyzer methods |
| Global Conveyance System Routing Methods | Global conveyance system routing methods |
| Global Output File Methods | Global output file methods |
| Global Groundwater Methods | Global groundwater methods |
| Global RDII Methods | Global RDII methods |
| Global Land Use Methods | Global RDII methods |
| Global Flow/Quality Routing Methods | Global flow/quality routing methods |
| Global Treatment Methods | Global treatment methods |
| Global Mass Balance Methods | Global mass balance methods |
| Global Simulation Statistics Methods | Global simulation statistics methods |
| Global Raingage Methods | Global raingage methods |
| Global Subcatchments Methods | Global subcatchment methods |
| Global Surface Pollutant Buildup/Washoff Methods | Global surface pollutant buildup/washoff methods |
| Global Conveyance System Node Methods | Global conveyance system node methods |
| Global Conveyance System Inflow Methods | Global conveyance system inflow methods |
| Global Control Rule Methods | Global control rules methods |
| Global Utility Methods | Global utility methods |
| Model editing and reference maintenance | Analysis, conversion and deletion of authored model objects, including references and cascade impacts. C ABI entry points enforce editable lifecycle states; internal helpers document their mutation and ownership contracts |
| Finite-volume network hydraulics | Backend-neutral network solver interfaces, finite-volume kernels, options and mesh assembly. Individual APIs describe internal hydraulic units, caller-owned buffers and accepted-step publication |
| Network hydraulic routing | One-dimensional network routing, hydraulic closures and timestep selection. Solver-specific helpers document their state mutation, numerical bounds and time/unit conventions |
| GeoPackage model persistence | Reading, writing and external-content resolution for GeoPackage-backed model input. Each operation states dataset ownership, error handling and publication behavior |
| HDF5 model persistence | HDF5 input, model output and shared dataset helpers. Contracts distinguish owned versus borrowed handles, array layouts and I/O failure behavior |
| Species, age and heat transport | Native transport policy, conservative species kernels and physical transport components |
| ▼OpenSWMM Engine | Modern engine implementation, data model and public interfaces |
| Control rules | Parse, evaluate and arbitrate simulation control conditions and actions |
| Core Engine The core engine module, including lifecycle management, simulation options, and shared utilities. | |
| Engine data model | Parallel storage, resolved model records and simulation state |
| Hydrology and surface processes | Rainfall, runoff, infiltration, groundwater, snow and source delivery |
| Engine input | Input dispatch, parsing, path resolution and format-specific readers |
| Engine numerical utilities | Numerical expression evaluation, root finding, ordinary differential equations and portable vector operations used by engine solvers |
| Serialized output I/O | |
| Saved-result access | |
| Engine water quality | Pollutant and native species surface accumulation, runoff delivery, treatment, conservative routing and segment-based dispersion contracts |
| ▼New Engine C API | |
| ▼2D Surface Routing API | |
| Optional 2D GPU execution | Kokkos device state, surface execution, plugin ABI and host recharge operators |
| 2D Infiltration API | |
| Runtime Forcing API | |
| Hot Start File API | |
| ▼Plugin System | |
| ▼Plugin SDK Interfaces | |
| Input Plugin Interface | |
| Output Plugin Interface | |
| Report Plugin Interface | |
| State IO Plugin Interface |