OpenSWMM Engine  6.0.0-alpha.4
Data-oriented, plugin-extensible SWMM Engine (6.0.0-alpha.4)
Loading...
Searching...
No Matches
Topics
Here is a list of all topics with brief descriptions:
[detail level 1234]
 ▼Climate File Constants, Enumerations, Shared Variables, and FunctionsClimate file constants, enumeration types, shared variables, and functions
 Climate Files Shared VariablesClimate files shared variables
 Climate Related Local FunctionsClimate related local functions
 Climate File Constants and EnumerationsClimate files local constants and enumeration types
 ▼SWMM Constants, Variables, and Local and API FunctionsConstants, variables, local, and API functions used in the SWMM model
 SWMM General ConstantsGeneral constants used in the SWMM model
 Units factor in Manning EquationUnits factor in Manning Equation
 Definition of Measureable Runoff, Flow, and DepthDefinition of measureable runoff, flow, and depth
 Minimum Flow, Depth, and Volume Used to Evaluate Steady State ConditionsMinimum flow, depth, and volume used to evaluate steady state conditions
 Minimum Flow Depth and Area for Dynamic Wave RoutingMinimum Flow Depth and Area for Dynamic Wave Routing
 Various Conversion FactorsVarious Conversion Factors
 Token Separator CharactersToken separator characters
 SWMM EnumerationsEnumerated constants used in the SWMM model
 SWMM Error ConstantsGeneral error constants used in the SWMM model
 ▼Controls File Constants, Enumerations, Structs, Shared Variables, and FunctionsControls file constants, enumerations, structs, shared variables, and functions
 Controls File EnumerationsControls enumeration types
 Controls File VariablesControls file variables and definitions
 Controls File StructuresControls structures
 Controls File FunctionsControls file local functions
 ▼Exfil File Constants, Enumerations, Structs, Shared Variables, and FunctionsExfile file constants, enumerations, structs, shared variables, and functions
 Exfil File StructuresExfil structures
 Exfil File FunctionsExfil file functions
 ▼SWMM Global Interfacing FunctionsSWMM global interfacing functions
 Global Project MethodsGlobal methods associated with a SWMM project
 Global Input Reader MethodsGlobal input reader methods
 Global Report Writer MethodsGlobal report writer methods
 Global Temperature/Evaporation MethodsGlobal temperature/evaporation methods
 Global Rainfall Processing MethodsGlobal rainfall processing methods
 Global Snowmelt Processing MethodsGlobal snowmelt processing methods
 Global Runoff Analyzer MethodsGlobal runoff analyzer methods
 Global Conveyance System Routing MethodsGlobal conveyance system routing methods
 Global Output File MethodsGlobal output file methods
 Global Groundwater MethodsGlobal groundwater methods
 Global RDII MethodsGlobal RDII methods
 Global Land Use MethodsGlobal RDII methods
 Global Flow/Quality Routing MethodsGlobal flow/quality routing methods
 Global Treatment MethodsGlobal treatment methods
 Global Mass Balance MethodsGlobal mass balance methods
 Global Simulation Statistics MethodsGlobal simulation statistics methods
 Global Raingage MethodsGlobal raingage methods
 Global Subcatchments MethodsGlobal subcatchment methods
 Global Surface Pollutant Buildup/Washoff MethodsGlobal surface pollutant buildup/washoff methods
 Global Conveyance System Node MethodsGlobal conveyance system node methods
 Global Conveyance System Inflow MethodsGlobal conveyance system inflow methods
 Global Control Rule MethodsGlobal control rules methods
 Global Utility MethodsGlobal utility methods
 Model editing and reference maintenanceAnalysis, 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 hydraulicsBackend-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 routingOne-dimensional network routing, hydraulic closures and timestep selection. Solver-specific helpers document their state mutation, numerical bounds and time/unit conventions
 GeoPackage model persistenceReading, writing and external-content resolution for GeoPackage-backed model input. Each operation states dataset ownership, error handling and publication behavior
 HDF5 model persistenceHDF5 input, model output and shared dataset helpers. Contracts distinguish owned versus borrowed handles, array layouts and I/O failure behavior
 Species, age and heat transportNative transport policy, conservative species kernels and physical transport components
 ▼OpenSWMM EngineModern engine implementation, data model and public interfaces
 Control rulesParse, evaluate and arbitrate simulation control conditions and actions
 Core Engine The core engine module, including lifecycle management, simulation options, and shared utilities.
 Engine data modelParallel storage, resolved model records and simulation state
 Hydrology and surface processesRainfall, runoff, infiltration, groundwater, snow and source delivery
 Engine inputInput dispatch, parsing, path resolution and format-specific readers
 Engine numerical utilitiesNumerical expression evaluation, root finding, ordinary differential equations and portable vector operations used by engine solvers
 Serialized output I/O
 Saved-result access
 Engine water qualityPollutant 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 executionKokkos 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