TUFLOW SWMM Tutorial M01

Introduction

In this module, three culverts are added to represent flow through embankments that block the main creek flow path. EPA SWMM is used as the solution scheme for the 1D culvert flow calculations, dynamically linked with the TUFLOW HPC 2D solution scheme.

The GIS layers are:

• TSCF (TUFLOW SWMM Control File) layers:

1. SWMM.inp: A text file containing a record of the SWMM culvert inputs and also SWMM simulation parameters.

1. 1d_SWMM_Inlet: A layer used to define culvert inlet nodes.

• TBC layers:

1. 2d_bc: A layer defining the locations of 1D/2D links.
   

TUFLOW SWMM Module 1 builds from the model created in TUFLOW Module 2 (in the TUFLOW Only tutorial dataset). The completed Module 2 model is provided in the TUFLOW_SWMM_Module_01\TUFLOW folder as the starting point for this tutorial

SWMM Inputs

1. Create a new folder in the TUFLOW_SWMM_Module_01\TUFLOW\model folder called swmm. This is the location where all SWMM inputs will be saved
2. Open QGIS and search for "SWMM" in the Processing Toolbox panel.
3. From the SWMM tools, select GeoPackage-Create.
4. Within the GeoPackage-Create pop-up, the following options are available in the Parameters tab : CRS for GeoPackage, Initial SWMM Sections and GPKG file name to create.
   • For CRS for GeoPackage, pick up: Project CRS: EPSG:32760 - WGS 84/UTM zone 60S
     
   • For choosing the Initial SWMM Sections, click on the ... button. Then tick the following options and hit OK:
     
     • Title
     • Options
     • Nodes-Junctions
     • Nodes-Outfall
     • Links-Conduits
     • Streets
     • Inlets
     • Reports
   • For the GPKG file name to create, click on the ... button. Two options are available: Save to a Temporary File and Save to. Choose the second one. Direct to swmm folder and in the File name box provide swmm_M01_001 name. Save as GeoPackage type.
     
5. Now hit Run and when the following message: 'GeoPackage - Create' finished appears into the log tab, click close. A file called swmm_M01_001 with the relevant SWMM Sections and TUFLOW attributes is created. The TUFLOW-SWMM plugin automatically saves the file in the Module_01\TUFLOW\model\swmm folder. To open it in the QGIS Layers panel, open the swmm folder, find the swmm_M01_001 layer and drag and drop it in QGIS. A new Window is open. Right click on Select All and then on Add Layers.
   

The attribute tables of the Inlets of swmm_M01_001.gpkg file is provided in a common GeoPackage:

1. Load in the starting_swmm_data.gpkg from the Module_01\Tutorial_Data folder by dragging and dropping the .gpkg into QGIS. On the Window dialogue choose Select All and then Add layers.The objects in the starting_swmm_data.gpkg is not in the TUFLOW file format and needs to be copied into the Nodes-Junctions, Nodes-Outfall and Links-Conduits layers of swmm_M01_001.gpkg file to have the correct attributes.
   
2. For the swmm_M01_001 - Nodes-Junctions, make layer editable by right clicking the layer and selecting 'Toggle Editing'.
   
3. Select the Nodes-Junctions layer from starting_swmm_data.gpkg file by left clicking on it once in the Layers panel and use the 'Select Features' tool to highlight it.
   
4. Select 'Edit' from the top QGIS tab and 'Copy Features' from the drop down menu.
   
5. Select the Nodes-Junctions of the swmm_M01_001.gpkg file in Layers panel by left clicking on it once. Select 'Edit' from the top QGIS tab and click 'Paste Features' from the drop down menu.
6. Save and Toggle off Editing by right clicking the layer and selecting 'Toggle Editing'.
   
7. Repeat the above steps for the Nodes-Outfall and Links-Conduits layers of swmm_M01_001. gpkg file.
   

The Inlets of swmm_M01_001.gpkg file needs Streets information as well:

1. For the Streets layer of the swmm_M01_001.gpkg file, make the layer editable by right clicking the layer and selecting 'Toggle Editing'.
   
2. Again select the Streets layer of the swmm_M01_001.gpkg file and open attribute table by right clicking.
   
3. On the new opened Window, click the 'Toggle Editing' and the 'Add feature' icons. This allows the users to provide the table with attribute values.
   
4. Now, select the Streets layer of the starting_swmm_data.gpkg file. Right click the layer and select 'Open Attributes'.
   
5. Manually, copy the attribute table values from the Streets layer of the starting_swmm_data.gpkg into the attribute table of the Streets layer of the swmm_M01_001.gpkg file. The resulting table should be as follows:
   
   • Name: Xsec1
   • Tcrown: 10
   • Hcurb: 0.2
   • Sx: 0.4
   • nRoad: 0.016
   • a: 0
   • W: 0
   • Sides: 1
   • Tback: 5
   • Sback: 8
   • nBack: 0.016
6. When the process is complete, save, right click on the 'Toggle Editing' icon and exit.
   
7. Remove the starting_swmm_data.gpkg file from the Layers panel.
   

Set Options

1. Select the Options layer of the swmm_M01_001.gpkg file. By right clicking select 'Open Attribute Table'. Click the 'Toggle Editing' icon.
   
2. Change the following options into:
   
   • Start Date: 1/1/2020 (Use US formatting)
   • Report step: 00:05:00
3. Save, click again the 'Toggle Editing' icon and close.
   

Simulation Control Files

TUFLOW Boundary Control File (TBC)

To differentiate the TUFLOW SWMM tutorials from the TUFLOW/ESTRY tutorials, TS will be used as the new file prefix in this series of tutorials.

1. Save a copy of the M01_001.tbc as TS01_001.tbc in the TUFLOW_SWMM_Module_01\TUFLOW\model folder.
2. Open TS01_001.tbc in a text editor and add the additional lines:
   Read GIS BC == 2d_bc_SWMM_Connections_001_L ! Links the 1D culverts to the 2D domain
   
3. Save the TBC.

TUFLOW SWMM Control File (TSCF)

A new control file, the TUFLOW SWMM Control File (TSCF), is introduced. SWMM is a 1D hydraulic solver. All 1D SWMM files and commands are referenced in the TUFLOW SWMM Control File.

1. Create a new text file TS01_001.tscf and save it in the TUFLOW_SWMM_Module_01\TUFLOW\model folder.
2. Add the following command lines:
   Read SWMM == ..\swmm\TS01_001.inp ! 1D SWMM input file
   Spatial Database == ..\swmm\TS01_001.gpkg ! Location of the SWMM GeoPackage Spatial Database
   Read GIS SWMM Inlet Usage == 1d_SWMM_Inlet ! Something??
3. Save the TSCF.
   

TUFLOW Control File (TCF)

1. Save a copy of the M02_5m_001.tcf as M03_5m_001.tcf in the Module_03\TUFLOW\runs folder.
2. Open the M03_5m_001.tcf in a text editor:
   Add the following line in the 'Model Inputs' section:
   SWMM Control File == ..\model\TS01_001.tscf ! Reference the SWMM (1D) Control File
   Add the following line in the 'Output Settings' section:
   NetCDF Output Start Date == 2020-01-01 00:00 ! Sets the output units for the NetCDF time variable
   
3. Make the following reference updates:
   Spatial Database == ..\model\gis\TS01_001.gpkg ! Specify the location of the GeoPackage Spatial Database
   BC Control File == ..\model\TS01_001.tbc ! Reference the TUFLOW Boundary Conditions Control File
   
4. Save the TCF.

Running the Simulation

1. Save a copy of _run_M02_HPC.bat as _run_TS01_HPC.bat in the TUFLOW_SWMM_Module_01\TUFLOW\runs folder.
2. Update the batch file to reference the TS01_5m_001.tcf :
   set exe="..\..\..\exe\2023-03-AD\TUFLOW_iSP_w64.exe"
   set run=start "TUFLOW" /wait %exe% -b
   %run% TS01_5m_001.tcf
3. Double click the batch file in Windows file explorer to run the simulation.

Troubleshooting

See tips on common mistakes and troubleshooting steps if the model doesn't run:

• QGIS

Check Files

While the model is running, review the added features are specified correctly:

• QGIS - GPKG

Results

When the model is finished, review the results:

• QGIS

Conclusion

• Culverts were added to the model. Three different SX boundary applications were used to transfer flow through road embankments.
  
• Check files were used to review the application of the boundary links.
• Results through the 1D network structures were assessed to validate the 1D stability.

Up
Back to TUFLOW SWMM Tutorial Introduction Main Page