SWMM5 Collection System and Overland Flows Model Type¶
The following tabs in the 'Simulation Setup' editor are available for models of type ‘SWMM5 collection system and overland flows’ with 2D overland features active:
- General: Includes general parameters, such as definition of the simulation period, selection of simulation types, and free text description of the simulation setup.
- Catchments: Includes parameters specific for Runoff simulation. See more details on the Simulation Setup editor Catchments tab page
- HD: Includes parameters specific for HD network simulation.
- Dynamic Wave: For defining parameters specific for Dynamic Wave network flow routing computations.
- Reporting. Used for specifying catchment and network results (output) to be generated by the simulation.
- 2D Settings: For defining 2D overland model hydrodynamic computation parameters, and configuring 2D overland model outputs from the simulation.
Refer to the MIKE+ SWMM User Guide for more details on 'Simulation Setup' parameters related to regular runoff and 1D network simulations.
Figure: The SWMM Simulation Setup editor
The Identification group at the top and the scrollable grid table at the bottom of the editor are common across all tabs.
| Edit field | Description | Used or required by simulations | Field name in datastructure |
|---|---|---|---|
| ID | User-specified ID of simulation. ID will be reflected in the name of result files | Yes | MUID |
| Scenario | Dropdown menu for selecting ID of related Scenario for the simulation | Yes | ScenarioName |
Table: Edit fields in the Simulation Setup Identification group (Table mss_Project)
The following buttons are also located at the top of the editor with the Identification group:
- Insert: Inserts a new record in the Simulation Setup editor with a default unique MUID.
- Copy: Duplicates an existing (currently active) simulation setup record.
- Delete: Deletes a currently active simulation record.
- RUN: Triggers export of the current simulation job and execution of the simulation.
General¶
The following parameters are specified in the General tab page:
- Process Models: Define the process models to be included in the simulation. Note that some processes, such as Water Quality for 2D Overland and SWMM 2D Overland coupling, are as yet unavailable in MIKE+ 2022.
- Simulation Period: Period covered by the simulation.
- Description: Optional description for the simulation setup.
Figure: The SWMM Simulation Setup editor General tab
An overview of the editor fields and corresponding database attributes is provided in the table below.
| Edit field | Description | Used or required by simulations | Field name in datastructure |
|---|---|---|---|
| Rainfall Runoff | Surface runoff | Yes | UseRRNo |
| Rainfall Dependent I/I | Infiltration modelling | Yes | UseRDNo |
| Snowmelt | Snowmelt as part of surface runoff modelling | Yes | UseSMNo |
| Groundwater | Groundwater modelling | Yes | UseGWNo |
| Flow Routing (HD) | Network flow routing through conduits | Yes | UseFRNo |
| Water Quality | Water quality routing through conduits. Option unavailable for 2D overland or coupling with SWMM models in MIKE+ 2022 | Yes | UseWQNo |
| 2D Overland | 2D overland modelling | Yes | Enable_2DOverland |
| Coupling to MIKE 21 or MIKE 3 FM | Option for coupling SWMM model to external MIKE 21/MIKE3 FM setup | Yes | Enable_M21FM_Coupling |
| Start | Specifies start date and time for the simulation. | Yes | ComputationBegin |
| Duration | Displays the duration of the simulation in days, hours. minutes and seconds. Automatically adjusted based on Start and End time/date. May be edited, adjusting End date/time accordingly. | Yes | - |
| End | Specifies end date and time for the simulation. Adjusted automatically according to user's specification of duration. | Yes | ComputationEnd |
| Description | Free text description of the simulation setup | Optional | Description |
Table: Edit fields in the Simulation Setup General tab (Table mss_Project)
HD¶
The HD tab holds parameters related to SWMM hydrodynamic 1D network computations. The parameters are organized into the following groups:
- Routing Model Settings. Parameters related to method for routing flows through the network.
- Network Interface Files. Options for specifying the use or saving of Interface Files for the network HD simulation.
Figure: The SWMM Simulation Setup editor HD tab
| Edit field | Description | Used or required by simulations | Field name in datastructure |
|---|---|---|---|
| Routing Model | Choice of model to use for flow routing through the network: Steady Flow Kinematic Wave Dynamic Wave | Yes | RoutingModelNo |
| Routing Step | Flow routing time step | Yes | RoutingStep |
| Control Rule Step | Time step length used for evaluating control rules. A value of 0 means controls are evaluated every routing time step. | Yes If Controls are used | ControlRuleStep |
| Skip Steady Flow Periods | Option to make SWMM keep using the most recently computed conveyance system flows during identified steady flow periods instead of computing a new flow solution. Using this feature can help speed up simulation run times at the expense of accuracy. | Yes | SkipSteadyFlowPeriodNo |
| System Flow Tolerance | Threshold for percent difference between total system inflow and total system outflow used to identify steady flow periods | Yes If SkipSteadyFlowPeriodNo = 1 | SysFlowTolerance |
| Lateral Flow Tolerance | Threshold for percent differences between the current lateral inflow and that from the previous time step for all points in the conveyance system used to identify steady flow periods | Yes If SkipSteadyFlowPeriodNo = 1 | LatFlowTolerance |
| Allow Ponding | Option to allow excess water to collect atop nodes and re-enter the network when hydraulic capacity is regained. The size of the surface area for ponding is a parameter for the junction | Yes | AllowPondingNo |
| Minimum Conduit Slope | The minimum value allowed for a conduit's slope (%) | Yes | MinConduitSlope |
| Network Interface Files | |||
| Save Hotstart Data | Option to create a hotstart file from the simulation | No | HotstartFileSaveNo |
| Use Hotstart Data | Option to read information from an existing hotstart file | No | HotstartFileUseNo |
| Use Inflow Data | Option to read information from Inflow file | No | InflowFileUseNo |
| Save Outflow Data | Option to create Outflow interface file from the simulation | No | OutflowFileSaveNo |
| Use RDII Data | Option to read information from existing RDII interface file | No | RDIIFileUseNo |
| Use Runoff Data | Option to read information from existing Runoff interface file | No | RunoffFileUseNo |
Table: Edit fields in the Simulation Setup HD tab (Table mss_Project)
Dynamic Wave¶
Define parameters that control how the dynamic flow routing computations are made in the Dynamic Wave tab of the Simulation editor. These parameters are only relevant if the Routing Model is set to Dynamic Wave on the HD tab page of the editor.
Figure: The SWMM Simulation Setup editor Dynamic Wave tab
The table below summarizes the edit fields in the Dynamic Wave tab page. Please refer to the MIKE+ SWMM Modelling User Guide for more details on the various parameters related to regular 1D network simulations.
| Edit field | Description | Used or required by simulations | Field name in data structure |
|---|---|---|---|
| Inertial Terms | Indicates how the inertial terms in the St. Venant momentum equation will be handled: None Partial Full | Yes | InertialTermNo |
| Normal Flow Criterion | Basis used to determine when supercritical flow occurs in a conduit: Slope Froude Slope & Froude | Yes | NormalFlowCritNo |
| Force Main Equation | Equation for computing friction losses during pressurized flow for conduits that have a Circular Force Main cross section: Darcy-Weisbach Hazen-Williams | Yes | ForceMainEqNo |
| Surcharge Method | Method for handling surcharge conditions: Extran Slot | Yes | SurchargeMethodNo |
| Use Variable Time Steps Adjusted By | Option to use an internally computed variable time step at each routing time period. Define the adjustment factor in the input box beside the checkbox. | Yes | VarTSAdjustBy |
| Minimum Variable Time Step | The smallest time step allowed when variable time steps are used | Yes | MinVarTS |
| Time Step for Conduit Lengthening | Time step used to artificially lengthen conduits so that they meet the Courant stability criterion under full-flow conditions (i.e., the travel time of a wave will not be smaller than the specified conduit lengthening time step). As this value is decreased, fewer conduits will require lengthening. A value of 0 means that no conduits will be lengthened. | Yes | ConduitLenTS |
| Minimum Nodal Surface Area | Minimum surface area used at nodes when computing changes in water depth. If 0 is entered, then the default value of 12.566 ft 2 (i.e., the area of a 4-ft diameter manhole) is used | Yes | MinNodalSurfaceArea |
| Maximum Trials per Time Step | Maximum number of trials that SWMM uses at each time step to reach convergence when updating hydraulic heads at the conveyance system's nodes. The default value is 8. | Yes | MaxTrialPerTS |
| Head Convergence Tolerance | When the difference in computed head at each node between successive trials is below this value the flow solution for the current time step is assumed to have converged. The default tolerance is 0.005 ft (0.0015 m). | Yes | HeadConvergenceTolerance |
Table: Edit fields in the Dynamic Wave tab of the SWMM Simulation Setup editor (Table mss_Project)
Reporting¶
The Reporting tab presents options for saving detailed time series results in individual subcatchments, nodes, and links. The dialog organizes information into the following groups:
- Reporting Period: For defining the period over which reporting of simulation results is done.
- Summary Specification: For defining items to be included in a simulation summary.
- Subcatchments Detailed Report: Option for generating detailed results for all/selected catchments.
- Nodes Detailed Report: Option for generating detailed results for all/selected nodes.
- Links Detailed Report: Option for generating detailed results for all/selected links.
Figure: The SWMM Simulation Setup Reporting tab
The table below summarizes the edit fields in the Reporting tab page. Please refer to the MIKE+ SWMM Modelling User Guide for more details on the various parameters related to regular 1D network simulations.
| Edit field | Description | Used or required by simulations | Field name in data structure |
|---|---|---|---|
| Reporting Period | |||
| Report Time Step | Report saving time step (in Days and Hr:Min;Sec) | Yes | Report_Timestep |
| Report Start Time | Date and time of day when reporting of simulation results commence | Yes | Report_StartTime |
| Summary Specification | |||
| Input Summary | To include a summary of input data in the output report | No | ReportInputNo |
| Control Summary | To include a summary of the control data in the output report | No | ReportControlNo |
| Average Summary | To report the average of the results for all routing time steps in a reporting time step instead of the instantaneous results that occur at the end of the reporting time step | No | ReportAverageNo |
| Flow Statistics | Specifies whether or not summary flow statistics should be reported or not | No | FlowStatsNo |
| Control Actions | Specifies whether or not summary of control actions taken during simulation should be listed or not | No | ControlsNo |
| Continuity Check | Specifies whether or not summary of continuity checks should be reported or not | No | ContinuityNo |
| Subcatchments Detailed Report | |||
| All, None, or List of Subcatchment | Options for which catchments detailed results are generated | Yes | SubCatchmentsNo |
| List of Subcatchments | Specify a catchment selection list | Yes If SubCatchmentsNo = 2 | SubCatchmentsFileName |
| Nodes Detailed Report | |||
| All, None, or List of Nodes | Options for which nodes detailed results are generated | Yes | NodesNo |
| List of Nodes | A nodes selection list is expected | Yes If NodesNo = 2 | NodesFileName |
| Links Detailed Report | |||
| All, None, or List of Links | Options for which links detailed results are generated | Yes | LinksNo |
| List of Links | Define a links selection | Yes If LinksNo = 2 | LinksFileName |
Table: Edit fields in the Reporting tab (Table mss_Project)
2D Settings¶
The 2D Setting tab is where 2D overland model hydrodynamic computation parameters, and 2D overland model outputs are defined and configured.
- HD Adaptive Time Step Settings
- Output Folder Path
- Project Outputs.
These options and parameters are not offered for projects and simulations using ‘Coupling to MIKE 21 or MIKE 3 FM.’ Overland computation and result-saving configurations are defined in the corresponding coupled *.m21fm or *.m3fm file in these types of setups.
Figure: The SWMM Simulation Setup editor 2D Settings tab
| Edit field | Description | Used or required by simulations | Field name in datastructure |
|---|---|---|---|
| Minimum | Specifies a minimum time step for 2D overland model | Yes if including 2D overland | M2DHDDtMin |
| Maximum | Specifies a maximum time step for 2D overland model | Yes if including 2D overland | M2DHDDtMax |
| Max. CFL factor | Specifies the expected maximum CFL number in the simulation, to control the adaptive 2D overland time step | Yes if including 2D overland | M2DHDMaxCFL |
| Output Folder | |||
| Save Results in Default Folder/Save Results in this Folder [Output Folder radio buttons] | Toggles between Default folder and user-specified folder for output file location | Yes | M2DHDOutputNo |
| [Input box beside ‘Save Results in this Folder ‘option] | Contains the path for user-specified output destination folder | Yes if ‘Save Results in this Folder’ activated | M2DHDFolderPath |
Table: The Simulation Setup 2D Settings tab attributes (Table mss_Project)
A secondary grid displays a list of the output files selected for the simulation setup (figure below). The grid retrieves the information from the Result Files editor (Result Specifications| Result Files).
Figure: The Project Outputs secondary grid in the 2D Settings tab
The list of outputs is controlled by the user using functional buttons to the right of the grid.
The user selects output definitions to include from among those available in the project associated with the modules included in the simulation (and specified in the Result Files editor).
The list will include at least one "Default" result file definition containing the most usual results for the entire model domain. The list of result file definitions may be extended by user-specified output definitions.
An overview of the attributes of the Project Outputs secondary grid is shown in the table below.
| Edit field | Description | Used or required by simulations | Field name in datastructure |
|---|---|---|---|
| ID | MUID of the selected output file definition | Yes | OutputID |
| Type | Shows type and default contents of the output file (read only) | Yes | ContentsTypeNo |
| Format | Shows the file format (read only) | Yes | FormatNo |
| Save Every | Specifies results saving frequency | Yes | DtSave |
| [Column to the right of ‘Save Every’ column] | Specified unit for result saving frequency | Yes | DtSaveUnitNo |
| Default Save Period checkbox | Specify to save results for the entire simulation (check), or for user-specified period only (un-check) | Yes | DefaultSavePeriodNo |
| Start Saving | Defines start date and time for saving results | Yes if user-specified save period | SaveStartDate |
| End Saving | Defines end date and time for saving results | if user-specified save period | SaveEndDate |
Table: Overview of the Project Outputs secondary grid attributes (Table mss_ProjectOutput)
The following buttons are available for controlling the list of outputs in the Project Outputs secondary grid:
- Include: Opens a list of all relevant output definitions for the simulation and allows the user to choose those which are to be added to the list.
- Include All: Fills the list with all relevant pre-defined output definitions found in the database. Relevance is determined by the modules included in the simulation. If the list is not empty, it only adds those outputs which are not already in the list.
- Edit: Opens the Result Files editor with the current output in focus.
- Remove: Removes selected output(s) from the list.
- Use Default: This function resets the 'Start saving' and 'End saving' date and times for each result file, to match the start and end date of the simulation.