TUFLOW SWMM Tutorial M02

Introduction

In this module, stormwater inundation and underground pipe flows associated with an urban development are modelled. EPA SWMM is used as the solution scheme for the 1D pipe and culvert flow calculations, dynamically linked with the TUFLOW HPC 2D solution scheme.

TUFLOW SWMM Tutorial Module 2 builds from the model created in TUFLOW SWMM Tutorial Module 1. The completed TUFLOW SWMM Module 1 model is provided in the TUFLOW_SWMM_Module_02\TUFLOW folder of the download dataset as the starting point for this tutorial. If you are not already familiar with TUFLOW SWMM linking, we recommend first completing Module 1 before this tutorial.

QGIS Project Initialization

QGIS Version 3.34 or newer, and QGIS TUFLOW Plugin 3.9.0.49 or newer are required to access the SWMM Processing Tools described in the following sections. For installation, see Installation of TUFLOW Plugin.
Define the Coordinate Reference System (CRS), also called ‘Projection’, for the QGIS workspace:

1. Open QGIS.
2. Go to Project > Properties…
3. In the CRS tab, type ‘WGS 84 / UTM Zone 60S’.
4. Select the matching projection in the 'Predefined Coordinate Reference Systems' section.
5. Click ‘Apply’ and ‘OK’.
6. Ensure that the projection is set correctly by viewing the bottom right hand corner of the workspace. It should read ‘EPSG:32760’.

Load in the project GIS layers:

1. Click on the ‘Load TUFLOW Layers from TCF’ symbol from the TUFLOW Plugin toolbar.
   
   
   
2. In File Explorer, navigate to the TUFLOW_SWMM_Module_02\TUFLOW\runs folder and select TS01_5m_001.tcf.
3. Click ‘Open’ and ‘OK’.

Style the TUFLOW layers as preferred. Common steps to do this are:

1. Click on the ‘Apply TUFLOW Styles to Open Layers’ symbol from the TUFLOW Plugin toolbar.
   
   
   
2. Change the symbology of the DEM:
   • Right click on the DEM file in the Layers panel and select 'Properties'.
   • From the Symbology tab, under 'Band Rendering' select the following options:

   • Render type: Singleband pseudocolor
   • Color ramp: Spectral
   • Color ramp: Invert Color Ramp
   • Mode: Equal Interval

   • From the Transparency tab, set the Global Opacity to 75%.
   • Click 'Apply' and 'OK'.
   
   
   
   
3. Create a hillshade of the DEM:
   • Right click on the DEM file in the Layers panel and select 'Duplicate Layer'.
   • Right click on the DEM_copy and select 'Rename Layer'. Rename the layer to DEM_Hillshade.
   • Right click on the DEM_Hillshade file and select 'Properties'.
   • From the Symbology tab, under 'Band Rendering' select the following options:

   • Render type: Hillshade
   • Z Factor: 3

   • From the Transparency tab, set the Global Opacity to 35%.
   • Click 'Apply' and 'OK'.
   
   
   
   

SWMM Inputs and 1D/2D Linking

Create SWMM GeoPackage Spatial Database

In QGIS, create a SWMM GeoPackage database for the new pipe network features we'll be adding to the model:

1. Go to Processing > Toolbox from the top drop menu options to open the Processing Toolbox panel.
2. Go to TUFLOW > SWMM in the processing tool list and select 'GeoPackage - Create'. This opens the dialog shown below.

   • To set the ‘CRS for GeoPackage’: Click the drop down menu and select ‘Project CRS: EPSG:32760 - WGS 84 / UTM zone 60S’.
   • To set the ‘Initial SWMM Sections’: Click the …, and tick on: Title, Options, Nodes--Junctions, Nodes--Outfalls, Links--Conduits, Streets, Inlets and Report.
   • To define the ‘GPKG filename to create’: Click the …, select ‘Save to File’. Navigate to the TUFLOW\model\swmm folder and save the GeoPackage Database as TS02_001.gpkg.

3. Click ‘Run’.
4. Once the tool has finished, click ‘Close’.
5. In File Explorer, navigate to the TUFLOW\model\swmm folder and drag and drop TS02_001.gpkg into QGIS.

<< Add video >>

GIS Data Entry

A GeoPackage called Urban_Development.gpkg is provided in the TUFLOW_SWMM_Module_02\Tutorial_Data folder. It contains six layers:

• Pipes: defines the underground pipe network location, type and geometry.
• Junctions: defines the pipe network inlets.
• Outfalls: defines the pipe network outlet.
• 2d_ztin_TSWM_Dev_001_R: Topography update TIN region extent
• 2d_ztin_TSWM_Dev_001_L: Topography update TIN lines
• 2d_ztin_TSWM_Dev_001_P: Topography update TIN point elevations

To populate the GeoPackage created in the previous section:

1. In Windows Explorer, navigate to the TUFLOW_SWMM_Module_02\Tutorial_Data folder. Drag and drop the Urban_Development.gpkg into QGIS. By default, all items in the GeoPackage will be selected. Click 'Add Layers'.
2. In the QGIS Layers Panel, right click on the Pipes layer and select 'Zoom to Layer'.
3. Use the 'Select Features' tool to highlight all items included in Pipes.
4. Select 'Edit' from the top QGIS tab and 'Copy Features' from the drop down manu.
5. Select the Links--Conduits layer in the Layers Panel by left clicking on it once.
6. Make the Links--Conduits layer editable by clicking the 'Toggle Editing' symbol .
7. Select 'Edit' from the top QGIS tab and click 'Paste Features' from the drop down menu.
8. Toggle the editing off to save the edits.
   
   << Add video >>
   
   
9. Copy the objects from Junctions into Nodes--Junctions. Junctions are considered inlets, and should be defined at the upstream end of culverts.
10. Copy the objects from Outfalls into Nodes--Outfalls. Outfalls are treated as outlets, and are required at the downstream end of culverts.
11. Copy 2d_ztin_TSWM_Dev_001_R, 2d_ztin_TSWM_Dev_001_L and 2d_ztin_TSWM_Dev_001_P to XXXXXXX
12. Close Urban_Development.gpkg
    <video>>
    
    
13. Inspect the attribute information within the respective layers to familiarize yourself with the data.
    
    << Add video >>
    

GIS Data Updates

The provided GIS data requires numerous updates, prior to our model simulation. We have built these updates into this tutorial to demonstrate some of the available TUFLOW SWMM model built processing tools.

The following updates are being made to Objects and Layers within TS01_002.gpkg

Update Conduit Details

Step 1 involves updating the From Node and To Node attribute information in Links--Conduits. This information is necessary to "build" the 1D SWMM network. It defines the Link/Node connections. The information we will be adding to Links--Conduits is extracted from Nodes--Junctions and Nodes--Outfalls automatically using the Conduits - Assign Node Fields tool from the Processing Toolbox.

1. In the QGIS Layers Panel, select (left click) Links--Conduits and toggle on editing.
2. In the Processing Toolbox, select the 'Edit Features In-Place' tool . This allows the editing of an existing layer, instead of the creation of a new layer.
3. Go to TUFLOW > SWMM in the processing tool list and select 'Conduits - Assign Node Fields'. This opens the dialog shown below.
4. Tick on the SWMM Node Layers: Nodes--Junctions and Nodes--Outfalls.
5. Select 'Modify All Features'.
6. Once the tool has finished, click 'Close'.
7. View the attributes associated within Links--Conduits to verify the data processing has been completed correctly. The From Node and To Node attribute information is now configured correctly.
   Tip: If you wish to only update select objects during a future modelling project, instead of the entire Link--Conduits dataset, select the target objects first using the Feature by Area tool. The Conduits - Assign Node Fields tool will provide an option to Modify Selected Features, instead of Modify All Features.
   
   << Add video >>
   

Update Losses

Step 2, update the loss attributes in the Links--Conduits Layer. These values will be entered manually in this example using default values. Variation to the default values can be used in project models to reflect site specific information if desired.

1. In the QGIS Layers Panel, select (left click) Links--Conduits and toggle on editing.
2. Update using Processing Tool.
3. Turn off editing to save the edits.
   
   << Add video >>

Create 1D/2D Connections

The following instructions introduce a new tool that automates the creation of 1D/2D connections. For 1D SWMM, HX lines are required from the upstream end of the culvert, and SX connections are used at the downstream end of the culvert.

1. In the QGIS Layers Panel, select (left click) Links--Conduits.
2. In the Processing Toolbox, go to TUFLOW > SWMM and select 'BC - Create channel endpoint 1D/2D connections'. This opens the dialog shown below.

   • Input Conduits Layer: Links--Conduits
   • Offset Distance: 2
   • Length of BC lines: 10
   • Output Layer:

   Click the ... and select 'Save to GeoPackage'.

   Navigate to the TUFLOW\model\swmm folder and select TS01_001.gpkg. Click Save.

   A dialog will open. In the Layer Name box, write 2d_bc_SWMM_Connections_001_L.

   Click 'OK'.

3. Click 'Run'.
4. Once the tool is finished, click 'Close'.
5. The 2d_bc_SWMM_Connections_001_L appears in the Layers Panel.

<< Add video >>

Update Junction Details

1. In the QGIS Layers Panel, select (left click) Nodes--Junctions and toggle on editing.
2. In the Processing Toolbox, select the 'Edit Features In-Place' tool. This allows the editing of an existing layer, instead of the creation of a new layer.
3. Go to TUFLOW > SWMM in the processing tool list and select Junctions - Set attributes processing tool. This opens the dialog shown below.

   • Input BC Connection Layer: 2d_bc_SWMM_Connections_001_L
   • Nodes connected to 2D without Inlets (Ysur): 0
   • Nodes connected to 2D without Inlets (Apond): 50

4. Select 'Modify All Features'.
5. Once the tool has finished, click 'Close'.
6. View the attributes associated within Nodes--Junctions to verify the data processing has been completed correctly.
   
   << Add video >>
   

SWMM Options

The model we are building will use two SWMM INP files.

• TS01_001.inp was already created in TUFLOW SWMM Tutorial Module 1. It contained details defining the three embankment culverts under the roads crossing the dominant flow paths. It also contained the associated 1D SWMM / 2D TUFLOW connection Layer objects. TS01_001.inp has been included in the base model we are using for Module 2. No changes will be made to it. TS01_001.inp includes the Option commands necessary to execute a SWMM simulation.
• We will create a new INP file for the SWMM pipe network inputs. Because SWMM simulation options are already inculded in TS01_001.inp, they are not needed in the second (new) INP file. As such, no new SWMM Option commands are necessary for this tutorial.

Export SWMM INP File

The model we are building will use two SWMM INP files.

• TS01_001.inp was already created in TUFLOW SWMM Tutorial Module 1. It contained details defining the three embankment culverts under the roads crossing the dominant flow paths. It also contained the associated 1D SWMM / 2D TUFLOW connection Layer objects. TS01_001.inp has been included in the base model we are using for Module 2. No changes will be made to it.
• We will create a new INP file now for the SWMM pipe network inputs. To do this, we need to convert TS02_001.gpkg into a SWMM INP file.

1. In the QGIS Layer Panel, select TS02_001.gpkg and right click Links--Conduits. Select TUFLOW > 'SWMM - Export inp file'. This opens the dialog shown below.
2. Select TS02_001.gpkg as the GeoPackage Input File.
3. Set the SWMM output filename to TS02_001.inp in the TUFLOW_SWMM_Module_02/TUFLOW/model/swmm folder.
4. Select "Run", then "Close" after the processing is complete.

<< Add video >>

Simulation Control Files

To avoid the potential risk of overwriting existing control files accidentally, we will start by saving new control files where we will be making subsequent syntax updates during the following steps.

1. Open TS01_5m_001.tcf from the TUFLOW_SWMM_Module_02\TUFLOW\runs folder in a Text Editor (Notepad++ is recommended).
2. Save a copy of TS01_5m_001.tcf as TS02_5m_001.tcf.
3. Open the following files using the Open File function in Notepad++:
   • Open TS01_001.tbc, and save the file as TS02_001.tbc.
   • Open M02_001.tgc, and save the file as TS02_001.tgc.
   • Open TS01_001.tscf, and save the file as TS02_001.tscf.
4. After creating the new control files, update the following references in TS02_5m_001.tcf:
   Spatial Database == ..\model\gis\TS02_001.gpkg ! Specify the location of the GeoPackage Spatial Database
   Geometry Control File == ..\model\TS02_001.tgc ! Reference the TUFLOW Geometry Control File
   BC Control File == ..\model\TS02_001.tbc ! Reference the TUFLOW Boundary Conditions Control File
   SWMM Control File == ..\model\TS02_001.tscf ! Reference the SWMM (1D) Control File
   
5. Save TS02_5m_001.tcf.

TUFLOW Boundary Control File (TBC)

1. Open TS02_001.tbc. If using Notepad++, right click the file reference in TS02_5m_001.tcf and select Open File.
2. Add the following command lines after
   Read GIS BC == 2d_bc_SWMM_Culvert_Connections_001_P
   Spatial Database == swmm\TS02_001.gpkg
   Read GIS BC == 2d_bc_SWMM_Pipe_Network_Connections_001_P ! Links the 1D Pipe Network Inlets to the 2D domain
   Read GIS BC == 2d_bc_SWMM_Pipe_Network_Connections_001_L ! Links the 1D Pipe Network Outlets to the 2D domain
3. Save the TBC.

<< Add video >>

TUFLOW Geometry Control File (TGC)

1. Open TS02_001.tgc.
2. Add the following additional command lines to TS02_001.tgc:
   Create TIN Zpts == 2d_ztin_Development_001_R | 2d_ztin_Development_001_L | 2d_ztin_Development_001_P ! Links the 1D Pipe Network Outlets to the 2D domain
3. Save the TGC.

<< Add video >>

TUFLOW SWMM Control File (TSCF)

1. Open TS02_001.tscf.
2. Add the following command lines:
   Read SWMM == swmm\TS01_001.inp ! 1D SWMM Culvert input file
   Read SWMM == swmm\TS02_001.inp ! 1D SWMM Pipe Network input file
3. Save the TSCF.
   

<< Add video >>

Running the Simulation

1. Save a copy of _run_M02_HPC.bat as _run_TS02_HPC.bat in the TUFLOW_SWMM_Module_02\TUFLOW\runs folder.
2. Update the batch file to reference the TS02_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.

<< Add video >>
If your model simulation did not run. Here is a link to some comon Tutorial Trouble Shooting advice.

Check Files and Results Output

Complete the steps outlines in the following link to review check files and simulation results from the TUFLOW SWMM model simulation:

TUFLOW SWMM Tutorial 02 Check Files
TUFLOW SWMM Tutorial 02 Results

Conclusion

• EPA SWMM Culverts were added to convey water through the structures under the three roads in the tutorial model.
• Check files were used to review the application of the boundary links.
• Results through the 1D network structures were assessed.

Up
Back to TUFLOW SWMM Tutorial Introduction Main Page