Difference between revisions of "TUFLOW SWMM Tutorial M02"

From Tuflow
Jump to navigation Jump to search
 
(315 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
= Introduction =
 
= 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. <br>
+
This tutorial, Module 2 of the TUFLOW SWMM tutorial dataset will demonstrate how to model underground stormwater pipe networks using SWMM, linked to the TUFLOW HPC 2D solution scheme. Boundary condition inflows to the model are defined using TUFLOW's 2D direct rainfall (rain on grid) approach. TUFLOW SWMM Tutorial Module 2 builds from the model created in <u>[[TUFLOW_SWMM_Tutorial_M01|TUFLOW SWMM Tutorial Module 1]]</u>. 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 completing TUFLOW SWMM Module 1 prior to starting this tutorial. <br>
  
TUFLOW SWMM Tutorial Module 2 builds from the model created in <u>[[TUFLOW_SWMM_Tutorial_M01|TUFLOW SWMM Tutorial Module 1]]</u>. 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. <br>
+
= Project Initialization =
 
+
==QGIS==
= QGIS Project Initialization =
+
QGIS Version 3.34 or newer, and QGIS TUFLOW Plugin 3.11 or newer are required to access the SWMM Processing Tools described in the following sections. For installation, see <u>[https://wiki.tuflow.com/TUFLOW_QGIS_Plugin Installation of TUFLOW Plugin]</u>.<br>
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 <u>[https://wiki.tuflow.com/index.php?title=TUFLOW_QGIS_Plugin#Installation_of_Plugin Installation of TUFLOW Plugin]</u>.<br>
 
 
Define the Coordinate Reference System (CRS), also called ‘Projection’, for the QGIS workspace:
 
Define the Coordinate Reference System (CRS), also called ‘Projection’, for the QGIS workspace:
 
<ol>  
 
<ol>  
Line 18: Line 17:
 
{{Video|name=Animation_TS1_Initialization_01a.mp4|width=1235}}<br>
 
{{Video|name=Animation_TS1_Initialization_01a.mp4|width=1235}}<br>
  
 +
==TUFLOW Model==
 +
===Load and Style TUFLOW Model Files===
 
Load in the project GIS layers:
 
Load in the project GIS layers:
 
<ol>
 
<ol>
Line 24: Line 25:
 
[[File: Tuflow_plugin_load_tcf_layers.png]]<br>
 
[[File: Tuflow_plugin_load_tcf_layers.png]]<br>
 
<br>
 
<br>
<li>In File Explorer, navigate to the '''TUFLOW_SWMM_Module_02\TUFLOW\runs''' folder and select '''TS01_5m_001.tcf'''.
+
<li>Navigate to the '''TUFLOW_SWMM_Module_02\TUFLOW\runs''' folder and select '''TS01_5m_001.tcf'''.
 +
<li>In the Load Layers window, select:
 +
* Ordering Options: Alphabetical
 +
* Grouping Options: Group by control file
 +
* Raster Load Options: Load Normally
 
<li>Click ‘Open’ and ‘OK’.
 
<li>Click ‘Open’ and ‘OK’.
 
</ol>
 
</ol>
 +
<br>
 +
Style the TUFLOW layers. Suggested styling steps were provided in <u>[[TUFLOW_SWMM_Tutorial_M01#Project_Initialization|TUFLOW SWMM Tutorial M01]]</u>. They have not been duplicated here.<br>
 
<br>
 
<br>
  
Style the TUFLOW layers as preferred. Common steps to do this are:
+
===TUFLOW Plugin===
 +
Next we need to configure the QGIS TUFLOW Plugin settings to link with the project folder where we will build our model:<br>
 
<ol>
 
<ol>
<li>Click on the ‘Apply TUFLOW Styles to Open Layers’ symbol from the TUFLOW Plugin toolbar.
+
<li>Open the 'Configure TUFLOW Project' tool by selecting Plugins > TUFLOW > Editing > Configure / Create TUFLOW Project.
 +
<li>Set the CRS (Coordinate Reference System) by selecting one of the vector layers associated with the opened model using the drop menu list. For example, ''2d_bc_M01_001_L''.
 +
<li>To set the location of the TUFLOW folder, click 'Browse...' and navigate to the '''TUFLOW_SWMM_Module_02''' folder. Click 'Select Folder'.
 +
<li>To set the location of the TUFLOW single precision executable file, click 'Browse...' and navigate to the '''exe\2023-03-AF''' folder. Select '''TUFLOW_iSP_w64.exe''' and click 'Open'.
 +
<li>Select 'GPKG' as the GIS Format.
 +
<li>Select 'TUFLOW Classic / HPC' as the TUFLOW Engine.
 +
<li>Tick on 'Save Default Settings Globally'.
 +
<li>Click 'OK'.<br>
 
<br>
 
<br>
[[File:tuflow_plugin_styles_open_layers.png]]<br>
+
[[File: TS2_Configure_Project_01a.png]]<br>
 +
</ol>
 
<br>
 
<br>
<li>Change the symbology of the DEM:
+
 
*Right click on the '''DEM''' file in the Layers panel and select 'Properties'.
+
=== Increment TUFLOW GeoPackage File ===
*From the Symbology tab, under 'Band Rendering' select the following options:
+
We will now save a copy of '''TS01_001.gpkg''' with a new name, '''TS02_001.gpkg'''. This project initialization step is recommended so prior model versions from a project are not broken as a result of changes being made to GIS inputs.
:*Render type: Singleband pseudocolor
+
 
:*Color ramp: Spectral
+
<ol>
:*Color ramp: Invert Color Ramp
+
<li>In the QGIS Layers Panel, select (left click) '''2d_bc_M01_001_L'''.
:*Mode: Equal Interval
+
<li>Click on the 'Increment Selected Layer' symbol from the TUFLOW Plugin toolbar. This opens the dialog shown below.  
*From the Transparency tab, set the Global Opacity to 75%.
 
*Click 'Apply' and 'OK'.
 
 
<br>
 
<br>
{{Video|name=Animation_TS1_Initialization_02a.mp4|width=1235}}<br>
+
[[File:tuflow_plugin_increment_layer.png]]<br>
<li>Create a hillshade of the DEM:
+
<br>
*Right click on the '''DEM''' file in the Layers panel and select 'Duplicate Layer'.
+
:*Source Layer: Automatically set to the selected layer, '''2d_bc_M01_001_L'''.
*Right click on the '''DEM_copy''' and select 'Rename Layer'. Rename the layer to '''DEM_Hillshade'''.
+
:*Output Database: Click 'Browse...'. This will automatically open to the '''TUFLOW\model\gis''' folder. Set the new output database name to '''TS02_001.gpkg''' and click 'Save'.
*Right click on the '''DEM_Hillshade''' file and select 'Properties'.
+
:*Output Layer Name: This will automatically increment to '''2d_bc_M01_00''2''_L'''. Change the name back to '''2d_bc_M01_00''1''_L'''.
*From the Symbology tab, under 'Band Rendering' select the following options:
+
:*Delete the pre-filled 'Incremented Layer' entry in the table. We do not wish to modify the version number associated with the 2d_bc file. This current exercise will not change the version number of any of the GIS layer inputs, it is simply establishing a copy of the existing GeoPackage where future edits will be saved to.
:*Render type: Hillshade
+
:*Select 'Remove Source Layer from Workspace'.
:*Z Factor: 3
+
:*Select 'Increment Layer and Preserve Database'.
*From the Transparency tab, set the Global Opacity to 35%.
+
<li>Click 'OK'.
*Click 'Apply' and 'OK'.
+
<li>The GeoPackage database, '''TS02_001.gpkg''' will now be in the '''TUFLOW_SWMM_Module_02\TUFLOW\model\gis''' folder.
 +
<br><br>
 +
{{Video|name=Animation_TS2_Initialization_02c.mp4|width=1236}}
 
<br>
 
<br>
{{Video|name=Animation_TS1_Initialization_03a.mp4|width=1235}}<br>
 
 
</ol>
 
</ol>
  
= SWMM Inputs and 1D/2D Linking=
+
===Save QGIS Project Workspace===
 +
<ol>
 +
<li>Go to Project > Save As.
 +
<li>Navigate to the '''TUFLOW_SWMM_Module_02''' folder and type '''SWMM_M02''' as the filename with the extension .qgz.
 +
</ol>
 +
<br>
 +
 
 +
= GIS Inputs =
 
==Create SWMM GeoPackage Spatial Database==  
 
==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:
+
We will create a new SWMM GeoPackage database for our pipe network feature entries:
 
<ol>  
 
<ol>  
<li>Go to Processing > Toolbox from the top drop menu options to open the Processing Toolbox panel.
+
<li>Go to Processing > Toolbox from the top dropdown menu options to open the Processing Toolbox.
<li>Go to '''TUFLOW > SWMM''' in the processing tool list and select 'GeoPackage - Create'. This opens the dialog shown below.
+
<li>Go to TUFLOW >> SWMM in the processing tool list and select '<u>[[QGIS_SWMM_GeoPackage_Create |GeoPackage - Create]]</u>'. 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 ‘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''', '''Nodes--Junctions''', '''Nodes--Outfalls''', '''Links--Conduits''', '''Streets''', '''Inlets''' and '''Report'''.
+
:*To set the ‘Initial SWMM Sections’: Click the …, and tick on (if not already ticked):  
:*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'''.
+
::*'''Nodes--Junctions''', '''Nodes--Outfalls.'''  
 
+
::*'''Links--Conduits, Links--Streets.'''
 
+
::*'''Inlets--Inlets.'''
<li>Click ‘Run’.  
+
:*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 '''sw02_001.gpkg'''.
 +
::'''Note:''' In Module 1 we also included '''Nodes--Storage''', '''Project--Title''', '''Project--Options''', and '''Project--Report''' in the GeoPackage file. '''Project--Options''' is not required this time as this tutorial model will use two SWMM INP files. The file created during Module 1 (for the road culverts) and the INP is to be created from this GeoPackage (for the underground pipe network inputs). When TUFLOW processes SWMM inputs, it combines the multiple INP files into one before simulation. As such, the details from the Module 1 '''Project--Options''' input will be used in this tutorial. If '''Project--Options''' are included in multiple Geopackage/INP files, the entry that is referenced lowest in the TUFLOW SWMM Control file (TSCF) will be used. '''Nodes--Storage''' will not be used in this tutorial, as these are only needed to represent detention, or for nodes connected using HX boundaries.
 +
<li>Click 'Run'.
 
<li>Once the tool has finished, click ‘Close’.
 
<li>Once the tool has finished, click ‘Close’.
<li>In File Explorer, navigate to the '''TUFLOW\model\swmm''' folder and drag and drop '''TS02_001.gpkg''' into QGIS.  
+
<li>In Windows File Explorer, navigate to the '''TUFLOW\model\swmm''' folder and drag and drop '''sw02_001.gpkg''' into QGIS.
 +
<li>When prompted by QGIS, under 'Options', tick on 'Add layers to group', then select 'Add Layers' to open all vectors within '''sw02_001.gpkg'''. By default, all items in the available list should have been selected.
 +
<li>In the QGIS Layers Panel, move '''sw02_001.gpkg''' to the top of the list. This will ensure the data within this database file is displayed above all other layers in the project.  
 
</ol>
 
</ol>
<br><font color="red">'''<< Add video >>'''</font><br>
+
<br>
 +
{{Video|name=Animation_TS2_SWMM_Inputs_01e.mp4|width=1236}}
 +
 
 
<br>
 
<br>
  
 
== GIS Data Entry ==
 
== GIS Data Entry ==
  
A GeoPackage called '''Urban_Development.gpkg''' is provided in the '''TUFLOW_SWMM_Module_02\Tutorial_Data''' folder. It contains seven layers:  
+
A GeoPackage called '''Urban_Development.gpkg''' is provided in the '''TUFLOW_SWMM_Module_02\Tutorial_Data''' folder. It contains three SWMM input layers (and five other geometry input layers to be used later in the module):  
 
:*'''Pipes''': defines the underground pipe network location, type and geometry.
 
:*'''Pipes''': defines the underground pipe network location, type and geometry.
 
:*'''Junctions''': defines the pipe network inlets.
 
:*'''Junctions''': defines the pipe network inlets.
 
:*'''Outfalls''': defines the pipe network outlet.
 
:*'''Outfalls''': defines the pipe network outlet.
:*'''SWMM_IU_TS02_001''': swmm inlet usage layer. This defines the pipe network inlet details
 
:*'''2d_ztin_TS02_Development_001_R''': Topography update TIN region extent
 
:*'''2d_ztin_TS02_Development_001_L''': Topography update TIN lines
 
:*'''2d_ztin_TS02_Development_001_P''': Topography update TIN point elevations
 
  
 
<br>
 
<br>
To populate the GeoPackage created in the previous section:
+
To populate the GeoPackage database created in the previous section:
 
<ol>
 
<ol>
<li>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'.
+
<li>In Windows File Explorer, navigate to the '''TUFLOW_SWMM_Module_02\Tutorial_Data''' folder. Drag and drop the '''Urban_Development.gpkg''' into QGIS.  
<li>In the QGIS Layers Panel, right click on the '''Pipes''' layer and select 'Zoom to Layer'.
+
<li>When prompted by QGIS, under 'Options', tick on 'Add layers to group', then select '''Pipes''', '''Junctions''' and '''Outfalls''' (hold Ctrl to select multiple). Click 'Add Layers'.
 +
<li>In the QGIS Layers Panel, right click on the '''Pipes''' layer and select 'Zoom to Layer(s)'.
 
<li>Use the 'Select Features' tool to highlight all items included in '''Pipes'''.
 
<li>Use the 'Select Features' tool to highlight all items included in '''Pipes'''.
<li>Select 'Edit' from the top QGIS tab and 'Copy Features' from the drop down manu.  
+
<li>Select 'Edit' from the top QGIS tab and 'Copy Features' from the drop down menu.  
<li>Select the '''Links--Conduits''' layer in the Layers Panel by left clicking on it once.  
+
<li>In the QGIS Layers Panel, select (left click) the '''Links--Conduits''' layer.
 
<li>Make the '''Links--Conduits''' layer editable by clicking the 'Toggle Editing' symbol [[File:toggle_editing_icon.png|27x27px]].
 
<li>Make the '''Links--Conduits''' layer editable by clicking the 'Toggle Editing' symbol [[File:toggle_editing_icon.png|27x27px]].
 
<li>Select 'Edit' from the top QGIS tab and click 'Paste Features' from the drop down menu.
 
<li>Select 'Edit' from the top QGIS tab and click 'Paste Features' from the drop down menu.
<li>Toggle the editing off to save the edits.<br>
+
<li>Toggle the editing off to save the edits.
<br><font color="red">'''<< Add video >>'''</font><br>
+
<br><br>
<br>
+
{{Video|name=Animation_TS2_SWMM_Inputs_02d.mp4|width=1236}}<br>
<li>Copy the objects from '''Junctions''' into '''Nodes--Junctions'''. Junctions are considered inlets, and should be defined at the upstream end of culverts.
+
<li>Similarly, copy the objects from '''Junctions''' into '''Nodes--Junctions'''. Junctions are considered inlets, and should be defined at the upstream end of isolated culverts and all upstream ends of pipes within a network.
<li>Copy the objects from '''Outfalls''' into '''Nodes--Outfalls'''. Outfalls are treated as outlets, and are required at the downstream end of culverts.
+
<li>Also copy the objects from '''Outfalls''' into '''Nodes--Outfalls'''. Outfalls are treated as outlets, and are required at the downstream end of isolated culverts and the most downstream end of a pipe network.
<li> Close '''Urban_Development.gpkg'''
+
<li>Toggle off editing to save the edits.
<br><font color="red">'''<< Add video >>'''</font><br>
+
<li>Remove '''Urban_Development.gpkg'''.
<br>
+
<br><br>
<li>Inspect the attribute information within the respective layers to familiarize yourself with the data.<br>
+
{{Video|name=Animation_TS2_SWMM_Inputs_03c.mp4|width=1236}}<br>
<br><font color="red">'''<< Add video >>'''</font>
+
<li>Inspect the attribute information within the respective layers to familiarize yourself with the data.
<br>
+
<br><br>
 +
{{Video|name=Animation_TS2_SWMM_Inputs_04c.mp4|width=1236}}<br>
 
</ol>
 
</ol>
<br>
 
  
 
== GIS Data Updates ==
 
== 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 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'''  
+
The following updates are being made to objects and layers within '''sw02_001.gpkg'''.
 
===Update SWMM Inlet Usage Layer Details===
 
===Update SWMM Inlet Usage Layer Details===
An Inlet Usage Layer has been provided, '''swmm_iu_TS02_001'''. This Layer defines the physical location of inlets to the pipe network. It also defines some of the site specific geometry, such as Inlet, Elevation, Slope, Placement type (on-grade or on-sag). If you do not have a copy of this file available for your modelling during a project, you will need to create it using the empty template file available from '''model/gis/empty/swmm_iu_empty.gpkg''' , created during the initial Write Empty step of the model build process (refer to TUFLOW Tutorial Model 1).<br>   
+
An Inlet Usage Layer defines the physical location of inlets to the pipe network. It also defines some of the site specific geometry, such as inlet type, street cross-section reference, surface inlet elevation, placement type (on-sag and on-grade). To reduce data entry requirements for this tutorial, a complete Inlet Usage Layer has been provided, '''swmm_iu_TS02_001'''. It includes a variety of on-sag and on-grade inlets. On-sag inlets are used in locations where the inlet is located in an area of minimal longtudial slope. In this situation ponded surface water enters the pipe network. On-grade inlets are used where bypass flow is expected due to the inlet location being on a slope. For on-grade inlets, TUFLOW SWMM captures a percentage of the “approach flow” based on several factors including the total 2D approach flow, velocity and depth.<br>   
  
 
<ol>
 
<ol>
<li>Save a copy of '''swmm_iu_TS02_001''' from '''TUFLOW_SWMM_Module_02\Tutorial_Data''' to '''TUFLOW_SWMM_Module_02\TUFLOW\Model\swmm''' <br>
+
<li>Navigate to the '''TUFLOW_SWMM_Module_02\Tutorial_Data''' folder and save a copy of '''swmm_iu_TS02_001''' in the '''TUFLOW_SWMM_Module_02\TUFLOW\model\swmm''' folder.<br>
 +
<li>Navigate to the '''TUFLOW\model\swmm''' folder. Drag and drop '''swmm_iu_TS02_001''' into the QGIS workspace.
 
</ol>
 
</ol>
  
The "Inlet" Attribute in the Inlet Usage Layer is an ID reference to inlet geometry and associated information listed within the '''Inlets''' database included in '''TS02_001.gpkg'''. A single inlet type was referenced in the Inlet Usage Layer object attributes, "Combo1". We need to create the entry for "Combo1" in the '''Inlet''' Layer.  
+
When you progress from this tutorial to project modeling, you will need to create an Inlet Usage Layer yourself. The template file for this is available from '''model\gis\empty\swmm_iu_empty.gpkg'''. The file is created during the initial 'Write Empty' step of the model build process (refer to <u>[[Tutorial_M01#Project_Initialisation | TUFLOW Tutorial Model 1]]</u>). A summary of the attributes within the Inlet Usage Layer is documented in  <u>[https://docs.tuflow.com/classic-hpc/release/2023-03-AD/SWMM-TUFLOW-1.html#tab:tab-SWMMinletusage TUFLOW 2023-03-AD Release Notes (Table 4.1)]</u>
 +
 
 +
The 'Inlet' Attribute within '''swmm_iu_TS02_001''' is an ID reference to inlet geometry and associated information listed within '''sw02_001.gpkg''' >> '''Inlets--Inlets'''. A single inlet type, 'Combo1', was referenced in '''swmm_iu_TS02_001''' (the provided Inlet Usage Layer). In recognition of this, we need to create the entry for 'Combo1' in the '''Inlets--Inlets''' layer.  
 
<ol>
 
<ol>
<li>In the QGIS Layers Panel, select (left click) '''Inlet''' and toggle on editing.
+
<li>In the QGIS Layers Panel, select (left click) '''Inlets--Inlets''' and toggle on editing.
<li>Right click Inlet and Select '''Open Attribute Table'''.
+
<li>Right click '''Inlets--Inlets''' and select 'Open Attribute Table'.
<li>Click '''Add Feature''' before entering the following attributes:
+
<li>Click 'Add Feature'. Enter the following attributes (leave all other fields as ''NULL''):
*Name: Combo1
+
:*Name: Combo1
*Type: COMBINATION
+
:*Type: COMBINATION
*Grate_Length: 1.5
+
:*Grate_Length: 0.6
*Grate_Width: 0.5
+
:*Grate_Width: 0.3
*Grate_Type: P_BAR-50
+
:*Grate_Type: P_BAR-50
*Curb_Length: 1.5
+
:*Curb_Length: 0.9
*Curb_Height: 0.2
+
:*Curb_Height: 0.15
*Curb_Throat: VERTICAL
+
:*Curb_Throat: VERTICAL
<li>Toggle off editing and save the update
+
For a summary of the attributes associated with the '''Inlets--Inlets''' layer, refer to <u>[https://docs.tuflow.com/classic-hpc/release/2023-03-AD/SWMM-Input-Detailed-1.html#tab:tab-SWMM-Input-Inlets TUFLOW 2023-03-AD Release Notes (Table A.16)]</u> and the <u>[https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume2_Hydraulics_Addendum-20220210mas2wr.pdf  SWMM5 Reference Manual - Volume 2 (Hydraulics Addendum) ]</u>
 +
 
 +
 
 +
<li>Turn off editing to save the edits.
 +
<br><br>
 +
{{Video|name=Animation_TS2_SWMM_Inputs_05c.mp4|width=1236}}
 +
<br>
 
</ol>
 
</ol>
<br>
 
<font color="red">'''<< Add video >>'''</font>
 
  
 
===Update Streets Details===
 
===Update Streets Details===
  
Street information is needed for the on-grade inlet flow calculations.
+
Street cross-section information is needed for SWMM on-grade inlet flow calculations. A single street cross-section type named 'Xsec1', is referenced in '''swmm_iu_TS02_001''' (the Inlet Usage Layer) using the 'StreetXSEC' field. <br>
 +
We will now define this street cross-section type and its attributes.  
  
 
<ol>
 
<ol>
<li>In the QGIS Layers Panel, select (left click) '''Streets''' and toggle on editing.
+
<li>In the QGIS Layers Panel, select (left click) '''Links--Streets''' and toggle on editing.
<li>Right click Streets and Select '''Open Attribute Table'''.
+
<li>Right click '''Links--Streets''' and select 'Open Attribute Table'.
<li>Click '''Add Feature''' before enteringthe following attributes:
+
<li>Click 'Add Feature'. Enter the following attributes:
* Name: Xsec1
+
:*Name: Xsec1
*Hcurb: 0.2
+
:*Tcrown: 7
*Sx: 4
+
:*Hcurb: 0.2
*nRoad: 0.014
+
:*Sx: 4
*a:
+
:*nRoad: 0.014
*W:
+
:*a: 0
*Sides: 1
+
:*W: 0
*Tback: 5
+
:*Sides: 1
*Sback: 4
+
:*Tback: 5
*nBack: 0.016
+
:*Sback: 2
<li> Toggle off editing and save the update.
+
:*nBack: 0.016
</ol><br><font color="red">'''<< Add video >>'''</font>
+
For a summary of the attributes associated with the '''Links--Streets''' layer, refer to <u>[https://docs.tuflow.com/classic-hpc/release/2023-03-AD/SWMM-Input-Detailed-1.html#tab:tab-SWMM-Input-Streets TUFLOW 2023-03-AD Release Notes (Table A.24)]</u> and the <u>[https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume2_Hydaulics_P100S9AS.pdf SWMM Reference Manual - Volume 2 (Hydraulics)]</u>.
 +
 
 +
<li>Turn off editing to save the edits.
 +
<br><br>
 +
{{Video|name=Animation_TS2_SWMM_Inputs_06c.mp4|width=1236}}
 +
<br>
 +
</ol>
  
 
===Update Conduit Details===
 
===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.
+
====Node Details====
 +
 
 +
The 'From Node' and 'To Node' attribute information in '''Links---Conduits''' 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 '<u>[[QGIS_SWMM_Conduits_Assign_Node_Fields |Conduits - Assign node fields]]</u>' tool from the Processing Toolbox.
 
<ol>
 
<ol>
 
<li>In the QGIS Layers Panel, select (left click) '''Links--Conduits''' and toggle on editing.
 
<li>In the QGIS Layers Panel, select (left click) '''Links--Conduits''' and toggle on editing.
 
<li>In the Processing Toolbox, select the 'Edit Features In-Place' tool [[File:edit_features_in_place_icon.png]]. This allows the editing of an existing layer, instead of the creation of a new layer.
 
<li>In the Processing Toolbox, select the 'Edit Features In-Place' tool [[File:edit_features_in_place_icon.png]]. This allows the editing of an existing layer, instead of the creation of a new layer.
<li>Go to TUFLOW > SWMM in the processing tool list and select 'Conduits - Assign Node Fields'. This opens the dialog shown below.
+
<li>Go to TUFLOW >> SWMM in the processing tool list and select '<u>[[QGIS_SWMM_Conduits_Assign_Node_Fields |Conduits - Assign node fields]]</u>'. This opens the dialog shown below.
<li>Tick on the SWMM Node Layers: '''Nodes--Junctions''' and '''Nodes--Outfalls'''.
+
<li>Tick on the SWMM Node Layers: '''sw02_001 >> Nodes--Junctions''' and '''sw02_001 >> Nodes--Outfalls'''.
 
<li>Select 'Modify All Features'.
 
<li>Select 'Modify All Features'.
 
<li>Once the tool has finished, click 'Close'.
 
<li>Once the tool has finished, click 'Close'.
<li>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.<br>
+
<li>Turn off editing to save the edits.
<li> Toggle off editing and save the update.
+
<li>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. <br>
 +
For a broader understanding of the other attributes associated with the '''Links--Conduits''' layer, refer to <u>[https://docs.tuflow.com/classic-hpc/release/2023-03-AD/SWMM-Input-Detailed-1.html#tab:tab-SWMM-Input-Conduits TUFLOW 2023-03-AD Release Notes (Table A.19)]</u> and the <u>[https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume2_Hydaulics_P100S9AS.pdf SWMM Reference Manual - Volume 2 (Hydraulics)]</u>. <br>
 +
'''Tip:''' In a future modeling project, if you wish to only update selected objects, rather than the entire '''Links--Conduits''' dataset, select the target objects first using the 'Select Features by Area' tool. The '<u>[[QGIS_SWMM_Conduits_Assign_Node_Fields |Conduits - Assign node fields]]</u>' tool will provide an option to 'Modify Selected Features', instead of 'Modify All Features.'
 +
<br><br>
 +
{{Video|name=Animation_TS2_SWMM_Inputs_07c.mp4|width=1236}}
 +
<br>
 
</ol>
 
</ol>
'''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.''
 
<br>
 
<font color="red">'''<< Add video >>'''</font><br>
 
  
===Update Losses===
+
====Update Losses====
  
Step 2, update the loss attributes in the '''Links--Conduits''' Layer. These values will be entered automatically using the '''Conduits - Assign losses''' tool from the Processing Toolbox.  
+
Update the loss attributes in the '''Links--Conduits''' layer. These values will be entered automatically using the '<u>[[QGIS_SWMM_Conduits_Assign_Losses |Conduits - Assign losses]]</u>' tool from the Processing Toolbox.  
 
<ol>
 
<ol>
 
<li>In the QGIS Layers Panel, select (left click) '''Links--Conduits''' and toggle on editing.
 
<li>In the QGIS Layers Panel, select (left click) '''Links--Conduits''' and toggle on editing.
<li>In the Processing Toolbox, select the 'Edit Features In-Place' tool [[File:edit_features_in_place_icon.png]]. This allows the editing of an existing layer, instead of the creation of a new layer.
+
<li>In the Processing Toolbox, ensure the 'Edit Features In-Place' tool [[File:edit_features_in_place_icon.png]] is still selected.
<li>Go to TUFLOW > SWMM in the processing tool list and select 'Conduits - Assign losses'. This opens the dialog shown below.
+
<li>Go to TUFLOW >> SWMM in the processing tool list and select '<u>[[QGIS_SWMM_Conduits_Assign_Losses |Conduits - Assign losses]]</u>'. This opens the dialog shown below.
*Select the inlet usage layer: '''swmm_iu_TS02_001'''.
+
:*Input inlet usage layers: '''swmm_iu_TS02_001'''.
*Entrance loss furthest upstream = 0.5
+
:*Culvert opening - Entrance loss: 0.5
*Entrance loss for channels not furthest upstream = 0.2
+
:*Culvert or pipe network outlet - Exit loss: 1.0
*Exit loss furthest downstream = 1.0
+
:*Pipe Network (manholes and pit inlets):
*Exit loss for channels not furthest downstream = 0.4
+
:::*Entrance loss: 0.2
 +
:::*Exit loss: 0.4
 
<li>Select 'Modify All Features'.
 
<li>Select 'Modify All Features'.
 
<li>After the tool processing has finished, click 'Close'.
 
<li>After the tool processing has finished, click 'Close'.
 +
<li>Turn off editing to save the edits.
 +
<li>View the attributes associated within '''Links--Conduits''' to verify the data processing has been completed correctly. The 'losses_Kentry', 'losses_Kexit' and 'losses_Kavg' attribute information is now configured.
 +
<br><br>
 +
{{Video|name=Animation_TS2_SWMM_Inputs_08d.mp4|width=1236}}
 +
<br>
 
</ol>
 
</ol>
  
=== Create 1D/2D Connections===
+
===1D/2D Linking===
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.
+
The 1D SWMM / 2D TUFLOW linkage locations to connect the pipe network inlets to the surface have been already automatically defined in the SWMM Inlet Usage Layer, '''swmm_iu_TS02_001''', using the 'Conn1D_2D' attribute.
 +
<br>
 +
<ol>
 +
<br>
 +
[[File:swmm_iu_TS02_001_attribute_table_Conn1D2D.png]]
 +
<br>
 +
</ol>
 +
<br>
 +
To complete the pipe network, 1D/2D linkage is needed at the outlet of the pipe network. The '<u>[[QGIS_SWMM_BC_Create_Channel_Endpoint_1D/2D_Connections |BC - Create channel endpoint 1D/2D connections]]</u>' tool will be used to automate this process.
 
<ol>
 
<ol>
 
<li>In the QGIS Layers Panel, select (left click) '''Links--Conduits'''.
 
<li>In the QGIS Layers Panel, select (left click) '''Links--Conduits'''.
<li>In the Processing Toolbox, go to TUFLOW > SWMM and select 'BC - Create channel endpoint 1D/2D connections'. This opens the dialog shown below.
+
<li>Use the 'Select Features' tool to select the most downstream object in '''Links--Conduits'''.
 +
<li>In the Processing Toolbox, go to TUFLOW >> SWMM and select '<u>[[QGIS_SWMM_BC_Create_Channel_Endpoint_1D/2D_Connections |BC - Create channel endpoint 1D/2D connections]]</u>'. This opens the dialog shown below.
 
:*Input Conduits Layer: '''Links--Conduits'''
 
:*Input Conduits Layer: '''Links--Conduits'''
 +
:*Tick on 'Selected features only'
 +
:*Create connections at: 'Downstream end'
 
:*Offset Distance: 2
 
:*Offset Distance: 2
 
:*Length of BC lines: 10
 
:*Length of BC lines: 10
 +
:*Tick on 'Set 2D cell elevation to 1D culvert invert at 1D/2D connection cells if needed'.
 
:*Output Layer:
 
:*Output Layer:
 
<ol>
 
<ol>
 
::<li>Click the ... and select 'Save to GeoPackage'.
 
::<li>Click the ... and select 'Save to GeoPackage'.
::<li>Navigate to the '''TUFLOW\model\swmm''' folder and select '''TS02_001.gpkg'''. Click Save.  
+
::<li>Navigate to the '''TUFLOW\model\gis''' folder and select '''TS02_001.gpkg'''. Click 'Save'.  
::<li>A dialog will open. In the Layer Name box, write '''2d_bc_SWMM_Pipe_Network_Connections_001_L'''.
+
::<li>A dialog will open. In the layer name box, write '''2d_bc_SWMM_Pipe_Network_Connections_001_L'''.
 
::<li>Click 'OK'.
 
::<li>Click 'OK'.
 
</ol>
 
</ol>
 
 
 
<li>Click 'Run'.
 
<li>Click 'Run'.
 
<li>Once the tool is finished, click 'Close'.
 
<li>Once the tool is finished, click 'Close'.
<li>'''2d_bc_SWMM_Pipe_Network_Connections_001_L''' should appear in the Layers Panel.
+
<li>The '''2d_bc_SWMM_Pipe_Network_Connections_001_L''' appears in the QGIS Layers Panel.  
 +
<li>Click the 'Apply TUFLOW Styles to Current Layer' symbol from the TUFLOW Plugin toolbar to style the '''2d_bc_SWMM_Pipe_Network_Connections_001_L''' layer.
 +
<br><br>
 +
{{Video|name=Animation_TS2_SWMM_Inputs_09e.mp4|width=1236}}
 +
<br>
 
</ol>
 
</ol>
<br><font color="red">'''<< Add video >>'''</font><br>
 
  
===Update Junction Details===
+
===Update SWMM Junction Details===
  
 
<ol>
 
<ol>
 
<li>In the QGIS Layers Panel, select (left click) '''Nodes--Junctions''' and toggle on editing.
 
<li>In the QGIS Layers Panel, select (left click) '''Nodes--Junctions''' and toggle on editing.
 
<li>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.
 
<li>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.
<li>Go to TUFLOW > SWMM in the processing tool list and select '''Junctions - Set attributes''' processing tool. This opens the dialog shown below.
+
<li>Go to TUFLOW >> SWMM in the processing tool list and select '<u>[[QGIS_SWMM_Junctions_Set_Attributes |Junctions - Set attributes ]]</u>' processing tool. This opens the dialog shown below.
:*Input Inlet Usage Layers: '''SWMM_Inlet_Usage'''
+
:*Input Inlet Usage Layers: '''swmm_iu_TS02_001'''
:*Input BC Connection Layer: '''2d_bc_SWMM_Pipe_Network_Connections_001_L'''
+
:*Input BC Connection Layers: '''2d_bc_SWMM_Pipe_Network_Connections_001_L'''
:*Nodes connected to 2D with Inlets (Ysur): 0
+
:*General Options:
:*Nodes connected to 2D with Inlets (Area of ponding): 5
+
:::*Maximum Depth Option (Ymax): 'Set to 0.0'.
:*Nodes connected to 2D without Inlets (Ysur): 0
+
:::*Nodes receiving subcatchment flows option (if connected to 2D): 'Based on options selected below'.
:*Nodes connected to 2D without Inlets (Apond): 50
+
:*Nodes connected to 2D without Inlets:
:*Nodes without 2D Connection (Surcharge Depth): 50
+
:::*None - leave defaults
:*Nodes without 2D Connection (Area of ponding): 0
+
:*Nodes connected to 2D with Inlets:
 +
:::*Maximum depth (Ymax) option: 'Use global option'
 +
:::*Ysur: 0 (ignored because ponding > 0.0)
 +
:::*Area of Ponding (Apond): 5
 +
:*Nodes without 2D Connection:
 +
:::*Surcharge Depth: 50
 +
:::*Area of Ponding (Apond): 0.0
 +
 
  
 
<li>Select 'Modify All Features'.
 
<li>Select 'Modify All Features'.
 
<li>Once the tool has finished, click 'Close'.
 
<li>Once the tool has finished, click 'Close'.
<li>View the attributes associated within '''Nodes--Junctions''' to verify the data processing has been completed correctly.
+
<li>Turn off editing to save the edits.
<li>Toggle off editing and save the update.
+
<li>View the attributes associated within '''Nodes--Junctions''' to verify the data processing has been completed correctly. <br>
<br><br><font color="red">'''<< Add video >>'''</font><br>
+
For a summary of the attributes associated with the '''Nodes--Junctions''' layer, refer to <u>[https://docs.tuflow.com/classic-hpc/release/2023-03-AD/SWMM-Input-Detailed-1.html#tab:tab-SWMM-Input-Junctions TUFLOW 2023-03-AD Release Notes (Table A.30)]</u> and the <u>[https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume2_Hydaulics_P100S9AS.pdf SWMM Reference Manual - Volume 2 (Hydraulics)]</u>.
 +
<br><br>
 +
{{Video|name=Animation_TS2_SWMM_Inputs_10d.mp4|width=1236}}
 +
<br>
 
</ol>
 
</ol>
  
 
==SWMM Options==
 
==SWMM Options==
 
The model we are building will use two SWMM INP files.
 
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.  
+
*'''sw01_001.inp''' was already created in TUFLOW SWMM Tutorial Module 1. It contained details defining the three culverts under the roads in the model. It also contained the associated 1D SWMM / 2D TUFLOW connection layer objects and the '''Project--Options''' necessary to execute the SWMM simulation. '''sw01_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 for the SWMM pipe network inputs (covered in the next Section). Because SWMM Options are already inculded in '''TS01_001.inp''', they are not needed in this second (new) INP file. As such, no new SWMM Option commands are necessary for this tutorial.
+
* We will create a new INP file for the SWMM pipe network inputs (covered in the next section). As SWMM Options are already included in '''sw01_001.inp''', they are not needed in this second (new) INP file. As such, no new SWMM Option commands are necessary for this tutorial.
 +
'''Note:''' If '''Project--Options''' are included in multiple GeoPackage/INP files, the entry that is referenced lowest in the TUFLOW SWMM Control File (TSCF) will be used.
 +
<br><br>
  
''Note: if more than one INP file includes SWMM Option commands, the details included in the INP file referenced lower in SWMM Control File (TSCF) will take precedence.
+
== Export SWMM INP File ==
 +
We will now create a new INP file for the SWMM pipe network inputs. To do this, we need to convert '''sw02_001.gpkg''' into a SWMM INP file.
  
== Export SWMM INP File ==
 
We will now create a new INP file for the SWMM pipe network inputs. To do this, we need to convert '''TS02_001.gpkg''' into a SWMM INP file.
 
 
<ol>
 
<ol>
<li>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.  
+
<li>Right click on the '''Links--Conduits''' layer in the '''sw02_001''' group (or any other SWMM layer in the same GeoPackage) and select 'TUFLOW' > 'SWMM - Export inp file'.
<li>Select '''TS02_001.gpkg''' as the GeoPackage Input File.
+
<li>This will open the '<u>[[QGIS_SWMM_GeoPackage_Write_to_SWMM_inp |GeoPackage - Write to SWMM inp]]</u>' processing tool, prepopulated with the filename of the layer's GeoPackage. <br>
<li>Set the SWMM output filename to '''TS02_001.inp''' in the '''''TUFLOW_SWMM_Module_02/TUFLOW/model/swmm''''' folder.
+
'''Note:''' This tool can also be activated from the Processing Toolbox.  
<li>Select "Run", then "Close" after the processing is complete.
+
<li>Click 'Run'.
 +
<li>Once the tool is finished, click 'Close'.
 +
<li>This tool will save the SWMM inp file in the same folder location and with the same name as the GeoPackage input file. In this case, it will save '''sw02_001.inp''' to the '''TUFLOW\model\swmm''' folder.
 +
<br><br>
 +
{{Video|name=Animation_TS2_SWMM_Inputs_11e.mp4|width=1236}}
 +
<br>
 
</ol>
 
</ol>
<br><font color="red">'''<< Add video >>'''</font><br>
 
  
== TUFLOW Geometry Update ==
+
== TUFLOW Boundary Updates ==
We will update TUFLOW's 2D topography to include elevation changes associated with the urban development.
+
We will be using TUFLOW's 2D direct rainfall (also known as rain on grid) functionality for the catchment inflow boundary condition approach to demonstrate flows into the pipe network inlets. There is a wide range of direct rainfall options built into TUFLOW, including:
 +
*'''Globally uniform rainfall:''' This method applies temporally varied rainfall uniformly (spatially) over the entire model.
 +
*'''Spatially varying rainfall:''' This method applies temporally varied rainfall with spatial variation defined using polygon delineation, grid raster files or inbuilt TUFLOW TIN triangulation routines.<br>
 +
<br>
 +
The focus of this tutorial is not to demonstrate the available direct rainfall options. As such, we will be using the simplest approach, globally uniform rainfall. It does not require any GIS updates to implement the boundary condition change. Updates will be limited to the Boundary Condition Database reference and Control File syntax updates. Both are addressed in the next section. If you are interested in learning about the available direct rainfall options, please refer to <u>[[Tutorial_M06 |TUFLOW Tutorial Module 6]]</u>.
 +
<br>
 
<ol>
 
<ol>
<li>Navigate to the '''TUFLOW_SWMM_Module_02\TUFLOW\model\gis''' folder.  
+
<li>Copy '''rainfall_stations.csv''' from the '''TUFLOW_SWMM_Module_02\Tutorial_Data''' folder to the '''TUFLOW_SWMM_Module_02\TUFLOW\bc_dbase''' folder.
<li>Save a copy of '''M02_001.gpkg''' as '''TS02_001.gpkg'''.
+
<li>Copy '''bc_dbase_TS02_001.csv''' from the '''TUFLOW_SWMM_Module_02\Tutorial_Data''' folder to the '''TUFLOW_SWMM_Module_02\TUFLOW\bc_dbase''' folder.
<li>Within the QGIS Browser Panel, navigate to the '''TUFLOW_SWMM_Module_02\Tutorial_Data\Urban_Development.gpkg''' folder. Drag and drop the following layers into '''TS02_001.gpkg''' for us to use in our model:
+
</ol>
*'''2d_ztin_TS02_Development_001_R'''  
+
<br>
*'''2d_ztin_TS02_Development_001_L'''  
+
It is common to use depth varying manning's roughness when using direct rainfall. A Materials File using depth varying inputs has been provided.  
*'''2d_ztin_TS02_Development_001_P'''  
+
<ol>
 +
<li>Copy '''materials_TS02_001.csv''' from the '''TUFLOW_SWMM_Module_02\Tutorial_Data''' folder to the '''TUFLOW_SWMM_Module_02\TUFLOW\model''' folder.
 +
<br><br>
 +
{{Video|name=Animation_TS2_TUFLOW_Boundary_01a.mp4|width=1235}}
 +
<br>
 
</ol>
 
</ol>
  
<br><font color="red">'''<< Add video >>'''</font><br>
+
== TUFLOW Geometry Update  ==
 +
We will update TUFLOW's 2D elevation and landuse to represent changes associated with the urban development. The updates will be consolidated within '''TS02_001.gpkg'''.
  
 
+
Copy the following TUFLOW geometry inputs to GeoPackage '''TS02_001.gpkg''':
== TUFLOW Boundary Control File ==
+
<ol>
We will be using TUFLOW's 2D direct rainfall (also known as rain on grid) functionality for the catchment inflow boundary condition approach.
+
<li>Right click anywhere in the QGIS Toolbar Panel and tick on 'Browser Panel' from the 'Panels' options.
There are a wide range of direct rainfall options built into TUFLOW, including:
+
<li>Within the QGIS Browser Panel, there is a dropdown directory, 'Project Home'. This directory is a shortcut to the location where the QGIS workspace is saved. In this case, it is a shortcut to the '''TUFLOW_SWMM_Module_02''' folder.
* Globally uniform rainfall. This method applies temporally varied rainfall uniformly (spatially) over the entire model.
+
<li>In the 'Project Home' directory, navigate to the '''TUFLOW_SWMM_Module_02\Tutorial_Data''' folder.  
* Spatially varying rainfall. This method applies temporally varied rainfall with spatial variation defined using polygon delineation, grid raster files or inbuilt TUFLOW TIN triangulation routines.<br>
+
<li>Drag the following layers (hold Ctrl to select multiple) from the '''Urban_Development.gpkg''' and drop them into the '''TS02_001.gpkg''' contained within the '''TUFLOW_SWMM_Module_02\TUFLOW\model\gis''' folder:
 
+
:*'''2d_mat_TS02_Dev_Buildings_001_R'''
The focus of this tutorial is not demonstration of the available direct rainfall options. As such, we will be using the simplest approach, globally uniform rainfall. It does not require any GIS updates to implement. Changes will be limited to boundary condition database and Control File syntax. Both are addressed in the next section.<br>
+
:*'''2d_mat_TS02_Dev_Lots_001_R'''
 
+
:*'''2d_ztin_TS02_Dev_001_L'''
If you are interested in learning all the available options, please refer to [[Tutorial_M06 |TUFLOW Tutorial Module 6]].
+
:*'''2d_ztin_TS02_Dev_001_P'''
 +
:*'''2d_ztin_TS02_Dev_001_R'''
 +
</ol>
 +
'''Note:''' The focus of this tutorial is not to demonstrate 2D geometry updates. If you are interested in learning about the above '''2d_ztin''' and '''2d_mat''' changes, please refer to <u>[[Tutorial_M02 |TUFLOW Tutorial Module 2]]</u>.
 +
<br><br>
 +
<ol>
 +
{{Video|name=Animation_TS2_TUFLOW_Geometry_01f.mp4|width=1236}}
 +
<br>
 +
</ol>
  
 
= Simulation Control Files =
 
= 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.
 
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.
 
<ol>
 
<ol>
<li> Open '''TS01_5m_001.tcf''' from the '''''TUFLOW_SWMM_Module_02\TUFLOW\runs''''' folder in a Text Editor (Notepad++ is recommended).  
+
<li>Open '''TS01_5m_001.tcf''' in a Text Editor (Notepad++ is used here). Save the file as '''TS02_5m_001.tcf''' in the '''TUFLOW_SWMM_Module_02\TUFLOW\runs''' folder.  
<li> Save a copy of '''TS01_5m_001.tcf''' as '''TS02_5m_001.tcf'''.
+
<li>Using the 'Open File' function in Notepad++:  
<li> Open the following files using the Open File function in Notepad++:  
+
:*Open '''M02_001.tgc,'''  and save the file as '''TS02_001.tgc''' in the '''TUFLOW\model''' folder.
* Open '''TS01_001.tbc,'''  and save the file as '''TS02_001.tbc'''.
+
:*Open '''TS01_001.tbc,'''  and save the file as '''TS02_001.tbc''' in the '''TUFLOW\model''' folder.
* Open '''M02_001.tgc,'''  and save the file as '''TS02_001.tgc'''.
+
:*Open '''TS01_001.tscf,'''  and save the file as '''TS02_001.tscf''' in the '''TUFLOW\model''' folder.
* Open '''TS01_001.tscf,'''  and save the file as '''TS02_001.tscf'''.
+
<br>
<li>After creating the new control files, update the following references in '''TS02_5m_001.tcf''': <br>
+
</ol>
 +
 
 +
===TUFLOW Control File (TCF)===
 +
<ol>
 +
<li>Open '''TS02_001.tcf''' and make the following reference updates:<br>
 
<font color="blue"><tt>Spatial Database </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>..\model\gis\TS02_001.gpkg</tt></font> <font color="green"><tt>  ! Specify the location of the GeoPackage Spatial Database</tt></font><br>
 
<font color="blue"><tt>Spatial Database </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>..\model\gis\TS02_001.gpkg</tt></font> <font color="green"><tt>  ! Specify the location of the GeoPackage Spatial Database</tt></font><br>
 
<font color="blue"><tt>Geometry Control File</tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>..\model\TS02_001.tgc</tt></font> <font color="green"><tt>  ! Reference the TUFLOW Geometry Control File</tt></font><br>
 
<font color="blue"><tt>Geometry Control File</tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>..\model\TS02_001.tgc</tt></font> <font color="green"><tt>  ! Reference the TUFLOW Geometry Control File</tt></font><br>
<font color="blue"><tt>BC Control File </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>..\model\TS02_001.tbc</tt></font> <font color="green"><tt>  ! Reference the TUFLOW Boundary Conditions Control File</tt></font><br>
+
<font color="blue"><tt>BC Control File </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>..\model\TS02_001.tbc</tt></font> <font color="green"><tt>  ! Reference the TUFLOW Boundary Condition Control File</tt></font><br>
 +
<font color="blue"><tt>BC Database </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>..\bc_dbase\bc_dbase_TS02_001.csv</tt></font> <font color="green"><tt>  ! Reference the Boundary Condition Database</tt></font><br>
 +
<font color="blue"><tt>Read Materials File </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>..\model\materials_TS02_001.csv</tt></font> <font color="green"><tt>  ! Reference the Materials Definition File</tt></font><br>
 
<font color="blue"><tt>SWMM Control File </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt> ..\model\TS02_001.tscf </tt></font> <font color="green"><tt>  ! Reference the SWMM (1D) Control File</tt></font> <br>
 
<font color="blue"><tt>SWMM Control File </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt> ..\model\TS02_001.tscf </tt></font> <font color="green"><tt>  ! Reference the SWMM (1D) Control File</tt></font> <br>
<li> Save '''TS02_5m_001.tcf'''.
+
<li>Add the following line in the '<font color="green"><tt>Output Settings</tt></font>' section: <br>
 +
<font color="blue"><tt>Map Cutoff Depth </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt> 0.05 </tt></font> <font color="green"><tt>! Sets map cutoff depth of 0.05 meters</tt></font> <br>
 +
<li> Save the TCF.
 +
<br><br>
 +
{{Video|name=Animation_TS2_Sim_Control_01d.mp4|width=1235}}
 +
<br>
 +
</ol>
  
 +
=== TUFLOW Geometry Control File (TGC) ===
 +
<ol>
 +
<li>Open '''TS02_001.tgc'''. If using Notepad++, right click the file reference in '''TS02_5m_001.tcf''' and select 'Open File'.
 +
<li>Add the following command to the the '<font color="green"><tt>Topography</tt></font>' section below the below the existing '<font color="blue"><tt>Read GIS Z Shape</tt></font>' command:<br>
 +
<font color="blue"><tt>Create TIN Zpts </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>2d_ztin_TS02_Dev_001_R | 2d_ztin_TS02_Dev_001_L | 2d_ztin_TS02_Dev_001_P</tt></font> <font color="green"><tt>  ! Urban Development Topography TIN</tt></font> <br>
 +
<li>Add the following lines in the '<font color="green"><tt>Materials</tt></font>' section, below the existing material commands : <br>
 +
<font color="blue"><tt>Read GIS Mat </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>2d_mat_TS02_Dev_Lots_001_R</tt></font><font color="green"><tt>    ! Urban Development Landuse 1</tt></font> <br>
 +
<font color="blue"><tt>Read GIS Mat </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>2d_mat_TS02_Dev_Buildings_001_R</tt></font> <font color="green"><tt> ! Urban Development Landuse 2</tt></font> <br>
 +
<li>Save the TGC.
 +
<br><br>
 +
{{Video|name=Animation_TS2_Sim_Control_02b.mp4|width=1235}}
 +
<br>
 
</ol>
 
</ol>
  
 
=== TUFLOW Boundary Control File (TBC) ===
 
=== TUFLOW Boundary Control File (TBC) ===
 
<ol>
 
<ol>
<li>Open '''TS02_001.tbc'''. If using Notepad++, right click the file reference in '''TS02_5m_001.tcf''' and select '''Open File'''.
+
<li>Open '''TS02_001.tbc'''. If using Notepad++, right click the file reference in '''TS02_5m_001.tcf''' and select 'Open File'.
 
<li> Comment out the 'Read GIS SA' command by placing '!' before the command: <br>
 
<li> Comment out the 'Read GIS SA' command by placing '!' before the command: <br>
 
<font color="green"><tt>! Read GIS SA == 2d_sa_M01_001_R</tt></font><br>
 
<font color="green"><tt>! Read GIS SA == 2d_sa_M01_001_R</tt></font><br>
<li>Add the following new command lines:<br>
+
<li>Add the following additional command lines:<br>
 
<font color="blue"><tt>Global Rainfall BC </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>RF_FC04</tt></font><font color="green"><tt>  ! Reads in global rainfall</tt></font><br>
 
<font color="blue"><tt>Global Rainfall BC </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>RF_FC04</tt></font><font color="green"><tt>  ! Reads in global rainfall</tt></font><br>
<font color="blue"><tt>Spatial Database</tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>swmm\TS02_001.gpkg</tt></font><br>
+
<font color="blue"><tt>Read GIS BC </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>2d_bc_SWMM_Pipe_Network_Connections_001_L</tt></font> <font color="green"><tt>  ! Links the 1D Pipe Network Outlets to the 2D domain</tt></font> <br>
<font color="blue"><tt>Read GIS BC </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>2d_bc_SWMM_Pipe_Network_Connections_001_L</tt></font> <font color="green"><tt>  ! Links the 1D Pipe Network Outlets to the 2D domain</tt></font>
 
 
<li>Save the TBC.
 
<li>Save the TBC.
 +
<br><br>
 +
{{Video|name=Animation_TS2_Sim_Control_03d.mp4|width=1235}}
 +
<br>
 
</ol>
 
</ol>
<font color="red">'''<< Add video >>'''</font>
 
 
=== TUFLOW Geometry Control File (TGC) ===
 
<ol>
 
<li>Open '''TS02_001.tgc'''.
 
<li>Add the following additional command lines to '''TS02_001.tgc''': <br>
 
 
<font color="blue"><tt>Create TIN Zpts </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>2d_ztin_Development_001_R | 2d_ztin_Development_001_L | 2d_ztin_Development_001_P</tt></font> <font color="green"><tt>  ! Links the 1D Pipe Network Outlets to the 2D domain</tt></font> <br>
 
<font color="blue"><tt>Read GIS Mat </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>2d_mat_Development_001_R
 
<li>Save the TGC.
 
</ol>
 
<font color="red">'''<< Add video >>'''</font>
 
  
 
=== TUFLOW SWMM Control File (TSCF) ===
 
=== TUFLOW SWMM Control File (TSCF) ===
 
<ol>
 
<ol>
<li>Open '''TS02_001.tscf'''.
+
<li>Open '''TS02_001.tscf'''. If using Notepad++, right click the file reference in '''TS02_5m_001.tcf''' and select 'Open File'.
<li>Add the following command lines after  
+
<li>Add the following command lines after '<font color="blue"><tt>Read SWMM </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>swmm\sw01_001.inp</tt></font>':   <br>
<font color="blue"><tt>Read SWMM </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>swmm\TS01_001.inp</tt></font>  <br>
+
<font color="blue"><tt>Read SWMM </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>swmm\sw02_001.inp</tt></font> <font color="green"><tt>  ! 1D SWMM Pipe Network Input File</tt></font> <br>
<font color="blue"><tt>Read SWMM </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>swmm\TS02_001.inp</tt></font> <font color="green"><tt>  ! 1D SWMM Pipe Network Input File</tt></font><br>
+
<font color="blue"><tt>Read GIS SWMM Inlet Usage </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>swmm\swmm_iu_TS02_001.gpkg >> swmm_iu_TS02_001</tt></font> <font color="green"><tt>  ! 1D SWMM Pipe Network Inlet Usage Layer</tt></font> <br>
<font color="blue"><tt>Read GIS SWMM Inlet Usage </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>swmm\swmm_iu_TS02_001 >> swmm_iu_TS02_001</tt></font> <font color="green"><tt>  ! 1D SWMM Pipe Network Inlet Usage Layer</tt></font><br>
+
<li>Save the TSCF.
+
<br><br>
<li>Save the TSCF. <br>
+
{{Video|name=Animation_TS2_Sim_Control_04b.mp4|width=1235}}
 +
<br>
 
</ol>
 
</ol>
<font color="red">'''<< Add video >>'''</font>
 
  
 
= Running the Simulation =
 
= Running the Simulation =
 
<ol>
 
<ol>
<li>Save a copy of '''_run_M02_HPC.bat''' as '''_run_TS02_HPC.bat''' in the '''''TUFLOW_SWMM_Module_02\TUFLOW\runs''''' folder.
+
<li>Save a copy of '''_run_TS01_HPC.bat''' as '''_run_TS02_HPC.bat''' in the '''TUFLOW_SWMM_Module_02\TUFLOW\runs''' folder.
 
<li>Update the batch file to reference the '''TS02_5m_001.tcf''' :<br>
 
<li>Update the batch file to reference the '''TS02_5m_001.tcf''' :<br>
<font color="blue"><tt>'''set'''</tt></font> <font color="black"><tt>exe</tt></font><font color="red"><tt>=</tt></font><font color="black"><tt>"..\..\..\..\exe\2023-03-AD\TUFLOW_iSP_w64.exe"</tt></font><br>
+
<font color="blue"><tt>'''set'''</tt></font> <font color="black"><tt>exe</tt></font><font color="red"><tt>=</tt></font><font color="black"><tt>"..\..\..\exe\2023-03-AF\TUFLOW_iSP_w64.exe"</tt></font><br>
 
<font color="blue"><tt>'''set'''</tt></font> <font color="black"><tt>run</tt></font><font color="red"><tt>=</tt></font><font color="black"><tt>start "TUFLOW" /wait</tt></font> <font color="orange"><tt> %exe%</tt></font> <font color="black"><tt> -b</tt></font> <br>
 
<font color="blue"><tt>'''set'''</tt></font> <font color="black"><tt>run</tt></font><font color="red"><tt>=</tt></font><font color="black"><tt>start "TUFLOW" /wait</tt></font> <font color="orange"><tt> %exe%</tt></font> <font color="black"><tt> -b</tt></font> <br>
 
<font color="orange"><tt>%run% </tt></font> <font color="black"><tt>TS02_5m_001.tcf </tt></font>  
 
<font color="orange"><tt>%run% </tt></font> <font color="black"><tt>TS02_5m_001.tcf </tt></font>  
  
<li>Double click the batch file in Windows file explorer to run the simulation.  
+
<li>Save the batch file and double click it in Windows File Explorer to run the simulation.  
 +
<li>Did your TUFLOW SWMM model fail to run successfully? If so, here is a link to a troubleshooting guide: <u>[[TUFLOW_SWMM_Troubleshooting | TUFLOW SWMM Troubleshooting]]</u>.<br>
 +
<br><br>
 +
{{Video|name=Animation_TS2_Run_Sim_01c.mp4|width=1236}}<br>
 
</ol>
 
</ol>
<font color="red">'''<< Add video >>'''</font>
 
<br>
 
If your model simulation did not run. Here is a link to some comon <u>[[Tutorial_Troubleshooting_QGIS | Tutorial Trouble Shooting]]</u> advice.
 
  
 
= Check Files and Results Output=
 
= 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:
+
Complete the steps outlined in following links to review check files and simulation results from the TUFLOW SWMM model simulation:
  
[[TUFLOW_SWMM_Tutorial_M02_Check_QGIS | TUFLOW SWMM Tutorial 02 Check Files]] <br>
+
<u>[[TUFLOW_SWMM_Tutorial_M02_Check_QGIS | TUFLOW SWMM Tutorial 02 Check Files]]</u> <br>
[[TUFLOW_SWMM_Tutorial_M02_Results_QGIS | TUFLOW SWMM Tutorial 02 Results]] <br>
+
<u>[[TUFLOW_SWMM_Tutorial_M02_Results_QGIS | TUFLOW SWMM Tutorial 02 Results]]</u> <br>
  
 
= Conclusion =
 
= Conclusion =
:*EPA SWMM Culverts were added to convey water through the structures under the three roads in the tutorial model.
+
*1D EPA SWMM pipe network features and 2D direct rainfall (rain on grid) hydrology have been added to the tutorial model.
:*Check files were used to review the application of the boundary links.
+
* Check files were used to review the 1D SWMM pipe network model features.
:*Results through the 1D network structures were assessed.
+
* Simulation results in the 1D SWMM pipe network were viewed in time series and longsection plot format.
 +
 
 +
=Other TUFLOW SWMM Tutorials=
 +
*<u>[[TUFLOW_SWMM_Tutorial_M01 | TUFLOW SWMM Module 1]]</u>  - 1D SWMM Culverts
 +
*<u>[[TUFLOW_SWMM_Tutorial_M02 | TUFLOW SWMM Module 2]]</u>  - 1D SWMM Pipe Network / 2D TUFLOW Direct Rainfall Hydrology
 +
*<u>[[TUFLOW_SWMM_Tutorial_M03 | TUFLOW SWMM Module 3]]</u>  - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology
 +
*<u>[[TUFLOW_SWMM_Tutorial_M04 | TUFLOW SWMM Module 4]]</u>  - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology: Executing multiple different event simulations from a single model control file.
 +
*<u>[[XPSWMM_to_TUFLOW-SWMM | XPSWMM to TUFLOW SWMM]]</u>  - How to convert an XPSWMM model to TUFLOW SWMM.
 +
 
 
<br>
 
<br>
 
{{Tips Navigation
 
{{Tips Navigation
|uplink=[[TUFLOW_SWMM_Tutorial_Introduction| Back to TUFLOW SWMM Tutorial Introduction Main Page]]
+
|uplink=[[TUFLOW_SWMM_Tutorial_Introduction#Tutorial_Modules| Back to TUFLOW SWMM Tutorial Introduction Main Page]]
 
}}
 
}}

Latest revision as of 12:16, 19 July 2024

Introduction

This tutorial, Module 2 of the TUFLOW SWMM tutorial dataset will demonstrate how to model underground stormwater pipe networks using SWMM, linked to the TUFLOW HPC 2D solution scheme. Boundary condition inflows to the model are defined using TUFLOW's 2D direct rainfall (rain on grid) approach. 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 completing TUFLOW SWMM Module 1 prior to starting this tutorial.

Project Initialization

QGIS

QGIS Version 3.34 or newer, and QGIS TUFLOW Plugin 3.11 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’.



TUFLOW Model

Load and Style TUFLOW Model Files

Load in the project GIS layers:

  1. Click on the ‘Load TUFLOW Layers from TCF’ symbol from the TUFLOW Plugin toolbar.
    Tuflow plugin load tcf layers.png

  2. Navigate to the TUFLOW_SWMM_Module_02\TUFLOW\runs folder and select TS01_5m_001.tcf.
  3. In the Load Layers window, select:
    • Ordering Options: Alphabetical
    • Grouping Options: Group by control file
    • Raster Load Options: Load Normally
  4. Click ‘Open’ and ‘OK’.


Style the TUFLOW layers. Suggested styling steps were provided in TUFLOW SWMM Tutorial M01. They have not been duplicated here.

TUFLOW Plugin

Next we need to configure the QGIS TUFLOW Plugin settings to link with the project folder where we will build our model:

  1. Open the 'Configure TUFLOW Project' tool by selecting Plugins > TUFLOW > Editing > Configure / Create TUFLOW Project.
  2. Set the CRS (Coordinate Reference System) by selecting one of the vector layers associated with the opened model using the drop menu list. For example, 2d_bc_M01_001_L.
  3. To set the location of the TUFLOW folder, click 'Browse...' and navigate to the TUFLOW_SWMM_Module_02 folder. Click 'Select Folder'.
  4. To set the location of the TUFLOW single precision executable file, click 'Browse...' and navigate to the exe\2023-03-AF folder. Select TUFLOW_iSP_w64.exe and click 'Open'.
  5. Select 'GPKG' as the GIS Format.
  6. Select 'TUFLOW Classic / HPC' as the TUFLOW Engine.
  7. Tick on 'Save Default Settings Globally'.
  8. Click 'OK'.

    TS2 Configure Project 01a.png


Increment TUFLOW GeoPackage File

We will now save a copy of TS01_001.gpkg with a new name, TS02_001.gpkg. This project initialization step is recommended so prior model versions from a project are not broken as a result of changes being made to GIS inputs.

  1. In the QGIS Layers Panel, select (left click) 2d_bc_M01_001_L.
  2. Click on the 'Increment Selected Layer' symbol from the TUFLOW Plugin toolbar. This opens the dialog shown below.
    Tuflow plugin increment layer.png

    • Source Layer: Automatically set to the selected layer, 2d_bc_M01_001_L.
    • Output Database: Click 'Browse...'. This will automatically open to the TUFLOW\model\gis folder. Set the new output database name to TS02_001.gpkg and click 'Save'.
    • Output Layer Name: This will automatically increment to 2d_bc_M01_002_L. Change the name back to 2d_bc_M01_001_L.
    • Delete the pre-filled 'Incremented Layer' entry in the table. We do not wish to modify the version number associated with the 2d_bc file. This current exercise will not change the version number of any of the GIS layer inputs, it is simply establishing a copy of the existing GeoPackage where future edits will be saved to.
    • Select 'Remove Source Layer from Workspace'.
    • Select 'Increment Layer and Preserve Database'.
  3. Click 'OK'.
  4. The GeoPackage database, TS02_001.gpkg will now be in the TUFLOW_SWMM_Module_02\TUFLOW\model\gis folder.


Save QGIS Project Workspace

  1. Go to Project > Save As.
  2. Navigate to the TUFLOW_SWMM_Module_02 folder and type SWMM_M02 as the filename with the extension .qgz.


GIS Inputs

Create SWMM GeoPackage Spatial Database

We will create a new SWMM GeoPackage database for our pipe network feature entries:

  1. Go to Processing > Toolbox from the top dropdown menu options to open the Processing Toolbox.
  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 (if not already ticked):
    • Nodes--Junctions, Nodes--Outfalls.
    • Links--Conduits, Links--Streets.
    • Inlets--Inlets.
    • 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 sw02_001.gpkg.
    Note: In Module 1 we also included Nodes--Storage, Project--Title, Project--Options, and Project--Report in the GeoPackage file. Project--Options is not required this time as this tutorial model will use two SWMM INP files. The file created during Module 1 (for the road culverts) and the INP is to be created from this GeoPackage (for the underground pipe network inputs). When TUFLOW processes SWMM inputs, it combines the multiple INP files into one before simulation. As such, the details from the Module 1 Project--Options input will be used in this tutorial. If Project--Options are included in multiple Geopackage/INP files, the entry that is referenced lowest in the TUFLOW SWMM Control file (TSCF) will be used. Nodes--Storage will not be used in this tutorial, as these are only needed to represent detention, or for nodes connected using HX boundaries.
  3. Click 'Run'.
  4. Once the tool has finished, click ‘Close’.
  5. In Windows File Explorer, navigate to the TUFLOW\model\swmm folder and drag and drop sw02_001.gpkg into QGIS.
  6. When prompted by QGIS, under 'Options', tick on 'Add layers to group', then select 'Add Layers' to open all vectors within sw02_001.gpkg. By default, all items in the available list should have been selected.
  7. In the QGIS Layers Panel, move sw02_001.gpkg to the top of the list. This will ensure the data within this database file is displayed above all other layers in the project.



GIS Data Entry

A GeoPackage called Urban_Development.gpkg is provided in the TUFLOW_SWMM_Module_02\Tutorial_Data folder. It contains three SWMM input layers (and five other geometry input layers to be used later in the module):

  • Pipes: defines the underground pipe network location, type and geometry.
  • Junctions: defines the pipe network inlets.
  • Outfalls: defines the pipe network outlet.


To populate the GeoPackage database created in the previous section:

  1. In Windows File Explorer, navigate to the TUFLOW_SWMM_Module_02\Tutorial_Data folder. Drag and drop the Urban_Development.gpkg into QGIS.
  2. When prompted by QGIS, under 'Options', tick on 'Add layers to group', then select Pipes, Junctions and Outfalls (hold Ctrl to select multiple). Click 'Add Layers'.
  3. In the QGIS Layers Panel, right click on the Pipes layer and select 'Zoom to Layer(s)'.
  4. Use the 'Select Features' tool to highlight all items included in Pipes.
  5. Select 'Edit' from the top QGIS tab and 'Copy Features' from the drop down menu.
  6. In the QGIS Layers Panel, select (left click) the Links--Conduits layer.
  7. Make the Links--Conduits layer editable by clicking the 'Toggle Editing' symbol Toggle editing icon.png.
  8. Select 'Edit' from the top QGIS tab and click 'Paste Features' from the drop down menu.
  9. Toggle the editing off to save the edits.


  10. Similarly, copy the objects from Junctions into Nodes--Junctions. Junctions are considered inlets, and should be defined at the upstream end of isolated culverts and all upstream ends of pipes within a network.
  11. Also copy the objects from Outfalls into Nodes--Outfalls. Outfalls are treated as outlets, and are required at the downstream end of isolated culverts and the most downstream end of a pipe network.
  12. Toggle off editing to save the edits.
  13. Remove Urban_Development.gpkg.


  14. Inspect the attribute information within the respective layers to familiarize yourself with the data.


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 sw02_001.gpkg.

Update SWMM Inlet Usage Layer Details

An Inlet Usage Layer defines the physical location of inlets to the pipe network. It also defines some of the site specific geometry, such as inlet type, street cross-section reference, surface inlet elevation, placement type (on-sag and on-grade). To reduce data entry requirements for this tutorial, a complete Inlet Usage Layer has been provided, swmm_iu_TS02_001. It includes a variety of on-sag and on-grade inlets. On-sag inlets are used in locations where the inlet is located in an area of minimal longtudial slope. In this situation ponded surface water enters the pipe network. On-grade inlets are used where bypass flow is expected due to the inlet location being on a slope. For on-grade inlets, TUFLOW SWMM captures a percentage of the “approach flow” based on several factors including the total 2D approach flow, velocity and depth.

  1. Navigate to the TUFLOW_SWMM_Module_02\Tutorial_Data folder and save a copy of swmm_iu_TS02_001 in the TUFLOW_SWMM_Module_02\TUFLOW\model\swmm folder.
  2. Navigate to the TUFLOW\model\swmm folder. Drag and drop swmm_iu_TS02_001 into the QGIS workspace.

When you progress from this tutorial to project modeling, you will need to create an Inlet Usage Layer yourself. The template file for this is available from model\gis\empty\swmm_iu_empty.gpkg. The file is created during the initial 'Write Empty' step of the model build process (refer to TUFLOW Tutorial Model 1). A summary of the attributes within the Inlet Usage Layer is documented in TUFLOW 2023-03-AD Release Notes (Table 4.1)

The 'Inlet' Attribute within swmm_iu_TS02_001 is an ID reference to inlet geometry and associated information listed within sw02_001.gpkg >> Inlets--Inlets. A single inlet type, 'Combo1', was referenced in swmm_iu_TS02_001 (the provided Inlet Usage Layer). In recognition of this, we need to create the entry for 'Combo1' in the Inlets--Inlets layer.

  1. In the QGIS Layers Panel, select (left click) Inlets--Inlets and toggle on editing.
  2. Right click Inlets--Inlets and select 'Open Attribute Table'.
  3. Click 'Add Feature'. Enter the following attributes (leave all other fields as NULL):
    • Name: Combo1
    • Type: COMBINATION
    • Grate_Length: 0.6
    • Grate_Width: 0.3
    • Grate_Type: P_BAR-50
    • Curb_Length: 0.9
    • Curb_Height: 0.15
    • Curb_Throat: VERTICAL
    For a summary of the attributes associated with the Inlets--Inlets layer, refer to TUFLOW 2023-03-AD Release Notes (Table A.16) and the SWMM5 Reference Manual - Volume 2 (Hydraulics Addendum)
  4. Turn off editing to save the edits.


Update Streets Details

Street cross-section information is needed for SWMM on-grade inlet flow calculations. A single street cross-section type named 'Xsec1', is referenced in swmm_iu_TS02_001 (the Inlet Usage Layer) using the 'StreetXSEC' field.
We will now define this street cross-section type and its attributes.

  1. In the QGIS Layers Panel, select (left click) Links--Streets and toggle on editing.
  2. Right click Links--Streets and select 'Open Attribute Table'.
  3. Click 'Add Feature'. Enter the following attributes:
    • Name: Xsec1
    • Tcrown: 7
    • Hcurb: 0.2
    • Sx: 4
    • nRoad: 0.014
    • a: 0
    • W: 0
    • Sides: 1
    • Tback: 5
    • Sback: 2
    • nBack: 0.016
    For a summary of the attributes associated with the Links--Streets layer, refer to TUFLOW 2023-03-AD Release Notes (Table A.24) and the SWMM Reference Manual - Volume 2 (Hydraulics).
  4. Turn off editing to save the edits.


Update Conduit Details

Node Details

The 'From Node' and 'To Node' attribute information in Links---Conduits 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 Edit features in place icon.png. 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: sw02_001 >> Nodes--Junctions and sw02_001 >> Nodes--Outfalls.
  5. Select 'Modify All Features'.
  6. Once the tool has finished, click 'Close'.
  7. Turn off editing to save the edits.
  8. 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.
    For a broader understanding of the other attributes associated with the Links--Conduits layer, refer to TUFLOW 2023-03-AD Release Notes (Table A.19) and the SWMM Reference Manual - Volume 2 (Hydraulics).
    Tip: In a future modeling project, if you wish to only update selected objects, rather than the entire Links--Conduits dataset, select the target objects first using the 'Select Features by Area' tool. The 'Conduits - Assign node fields' tool will provide an option to 'Modify Selected Features', instead of 'Modify All Features.'


Update Losses

Update the loss attributes in the Links--Conduits layer. These values will be entered automatically using the 'Conduits - Assign losses' 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, ensure the 'Edit Features In-Place' tool Edit features in place icon.png is still selected.
  3. Go to TUFLOW >> SWMM in the processing tool list and select 'Conduits - Assign losses'. This opens the dialog shown below.
    • Input inlet usage layers: swmm_iu_TS02_001.
    • Culvert opening - Entrance loss: 0.5
    • Culvert or pipe network outlet - Exit loss: 1.0
    • Pipe Network (manholes and pit inlets):
    • Entrance loss: 0.2
    • Exit loss: 0.4
  4. Select 'Modify All Features'.
  5. After the tool processing has finished, click 'Close'.
  6. Turn off editing to save the edits.
  7. View the attributes associated within Links--Conduits to verify the data processing has been completed correctly. The 'losses_Kentry', 'losses_Kexit' and 'losses_Kavg' attribute information is now configured.


1D/2D Linking

The 1D SWMM / 2D TUFLOW linkage locations to connect the pipe network inlets to the surface have been already automatically defined in the SWMM Inlet Usage Layer, swmm_iu_TS02_001, using the 'Conn1D_2D' attribute.


    Swmm iu TS02 001 attribute table Conn1D2D.png


To complete the pipe network, 1D/2D linkage is needed at the outlet of the pipe network. The 'BC - Create channel endpoint 1D/2D connections' tool will be used to automate this process.

  1. In the QGIS Layers Panel, select (left click) Links--Conduits.
  2. Use the 'Select Features' tool to select the most downstream object in Links--Conduits.
  3. 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
    • Tick on 'Selected features only'
    • Create connections at: 'Downstream end'
    • Offset Distance: 2
    • Length of BC lines: 10
    • Tick on 'Set 2D cell elevation to 1D culvert invert at 1D/2D connection cells if needed'.
    • Output Layer:
    1. Click the ... and select 'Save to GeoPackage'.
    2. Navigate to the TUFLOW\model\gis folder and select TS02_001.gpkg. Click 'Save'.
    3. A dialog will open. In the layer name box, write 2d_bc_SWMM_Pipe_Network_Connections_001_L.
    4. Click 'OK'.
  4. Click 'Run'.
  5. Once the tool is finished, click 'Close'.
  6. The 2d_bc_SWMM_Pipe_Network_Connections_001_L appears in the QGIS Layers Panel.
  7. Click the 'Apply TUFLOW Styles to Current Layer' symbol from the TUFLOW Plugin toolbar to style the 2d_bc_SWMM_Pipe_Network_Connections_001_L layer.


Update SWMM 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 Inlet Usage Layers: swmm_iu_TS02_001
    • Input BC Connection Layers: 2d_bc_SWMM_Pipe_Network_Connections_001_L
    • General Options:
    • Maximum Depth Option (Ymax): 'Set to 0.0'.
    • Nodes receiving subcatchment flows option (if connected to 2D): 'Based on options selected below'.
    • Nodes connected to 2D without Inlets:
    • None - leave defaults
    • Nodes connected to 2D with Inlets:
    • Maximum depth (Ymax) option: 'Use global option'
    • Ysur: 0 (ignored because ponding > 0.0)
    • Area of Ponding (Apond): 5
    • Nodes without 2D Connection:
    • Surcharge Depth: 50
    • Area of Ponding (Apond): 0.0
  4. Select 'Modify All Features'.
  5. Once the tool has finished, click 'Close'.
  6. Turn off editing to save the edits.
  7. View the attributes associated within Nodes--Junctions to verify the data processing has been completed correctly.
    For a summary of the attributes associated with the Nodes--Junctions layer, refer to TUFLOW 2023-03-AD Release Notes (Table A.30) and the SWMM Reference Manual - Volume 2 (Hydraulics).


SWMM Options

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

  • sw01_001.inp was already created in TUFLOW SWMM Tutorial Module 1. It contained details defining the three culverts under the roads in the model. It also contained the associated 1D SWMM / 2D TUFLOW connection layer objects and the Project--Options necessary to execute the SWMM simulation. sw01_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 for the SWMM pipe network inputs (covered in the next section). As SWMM Options are already included in sw01_001.inp, they are not needed in this second (new) INP file. As such, no new SWMM Option commands are necessary for this tutorial.

Note: If Project--Options are included in multiple GeoPackage/INP files, the entry that is referenced lowest in the TUFLOW SWMM Control File (TSCF) will be used.

Export SWMM INP File

We will now create a new INP file for the SWMM pipe network inputs. To do this, we need to convert sw02_001.gpkg into a SWMM INP file.

  1. Right click on the Links--Conduits layer in the sw02_001 group (or any other SWMM layer in the same GeoPackage) and select 'TUFLOW' > 'SWMM - Export inp file'.
  2. This will open the 'GeoPackage - Write to SWMM inp' processing tool, prepopulated with the filename of the layer's GeoPackage.
    Note: This tool can also be activated from the Processing Toolbox.
  3. Click 'Run'.
  4. Once the tool is finished, click 'Close'.
  5. This tool will save the SWMM inp file in the same folder location and with the same name as the GeoPackage input file. In this case, it will save sw02_001.inp to the TUFLOW\model\swmm folder.


TUFLOW Boundary Updates

We will be using TUFLOW's 2D direct rainfall (also known as rain on grid) functionality for the catchment inflow boundary condition approach to demonstrate flows into the pipe network inlets. There is a wide range of direct rainfall options built into TUFLOW, including:

  • Globally uniform rainfall: This method applies temporally varied rainfall uniformly (spatially) over the entire model.
  • Spatially varying rainfall: This method applies temporally varied rainfall with spatial variation defined using polygon delineation, grid raster files or inbuilt TUFLOW TIN triangulation routines.


The focus of this tutorial is not to demonstrate the available direct rainfall options. As such, we will be using the simplest approach, globally uniform rainfall. It does not require any GIS updates to implement the boundary condition change. Updates will be limited to the Boundary Condition Database reference and Control File syntax updates. Both are addressed in the next section. If you are interested in learning about the available direct rainfall options, please refer to TUFLOW Tutorial Module 6.

  1. Copy rainfall_stations.csv from the TUFLOW_SWMM_Module_02\Tutorial_Data folder to the TUFLOW_SWMM_Module_02\TUFLOW\bc_dbase folder.
  2. Copy bc_dbase_TS02_001.csv from the TUFLOW_SWMM_Module_02\Tutorial_Data folder to the TUFLOW_SWMM_Module_02\TUFLOW\bc_dbase folder.


It is common to use depth varying manning's roughness when using direct rainfall. A Materials File using depth varying inputs has been provided.

  1. Copy materials_TS02_001.csv from the TUFLOW_SWMM_Module_02\Tutorial_Data folder to the TUFLOW_SWMM_Module_02\TUFLOW\model folder.


TUFLOW Geometry Update

We will update TUFLOW's 2D elevation and landuse to represent changes associated with the urban development. The updates will be consolidated within TS02_001.gpkg.

Copy the following TUFLOW geometry inputs to GeoPackage TS02_001.gpkg:

  1. Right click anywhere in the QGIS Toolbar Panel and tick on 'Browser Panel' from the 'Panels' options.
  2. Within the QGIS Browser Panel, there is a dropdown directory, 'Project Home'. This directory is a shortcut to the location where the QGIS workspace is saved. In this case, it is a shortcut to the TUFLOW_SWMM_Module_02 folder.
  3. In the 'Project Home' directory, navigate to the TUFLOW_SWMM_Module_02\Tutorial_Data folder.
  4. Drag the following layers (hold Ctrl to select multiple) from the Urban_Development.gpkg and drop them into the TS02_001.gpkg contained within the TUFLOW_SWMM_Module_02\TUFLOW\model\gis folder:
    • 2d_mat_TS02_Dev_Buildings_001_R
    • 2d_mat_TS02_Dev_Lots_001_R
    • 2d_ztin_TS02_Dev_001_L
    • 2d_ztin_TS02_Dev_001_P
    • 2d_ztin_TS02_Dev_001_R

Note: The focus of this tutorial is not to demonstrate 2D geometry updates. If you are interested in learning about the above 2d_ztin and 2d_mat changes, please refer to TUFLOW Tutorial Module 2.


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 in a Text Editor (Notepad++ is used here). Save the file as TS02_5m_001.tcf in the TUFLOW_SWMM_Module_02\TUFLOW\runs folder.
  2. Using the 'Open File' function in Notepad++:
    • Open M02_001.tgc, and save the file as TS02_001.tgc in the TUFLOW\model folder.
    • Open TS01_001.tbc, and save the file as TS02_001.tbc in the TUFLOW\model folder.
    • Open TS01_001.tscf, and save the file as TS02_001.tscf in the TUFLOW\model folder.

TUFLOW Control File (TCF)

  1. Open TS02_001.tcf and make the following reference updates:
    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 Condition Control File
    BC Database == ..\bc_dbase\bc_dbase_TS02_001.csv ! Reference the Boundary Condition Database
    Read Materials File == ..\model\materials_TS02_001.csv ! Reference the Materials Definition File
    SWMM Control File == ..\model\TS02_001.tscf ! Reference the SWMM (1D) Control File
  2. Add the following line in the 'Output Settings' section:
    Map Cutoff Depth == 0.05 ! Sets map cutoff depth of 0.05 meters
  3. Save the TCF.


TUFLOW Geometry Control File (TGC)

  1. Open TS02_001.tgc. If using Notepad++, right click the file reference in TS02_5m_001.tcf and select 'Open File'.
  2. Add the following command to the the 'Topography' section below the below the existing 'Read GIS Z Shape' command:
    Create TIN Zpts == 2d_ztin_TS02_Dev_001_R | 2d_ztin_TS02_Dev_001_L | 2d_ztin_TS02_Dev_001_P ! Urban Development Topography TIN
  3. Add the following lines in the 'Materials' section, below the existing material commands :
    Read GIS Mat == 2d_mat_TS02_Dev_Lots_001_R ! Urban Development Landuse 1
    Read GIS Mat == 2d_mat_TS02_Dev_Buildings_001_R  ! Urban Development Landuse 2
  4. Save the TGC.


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. Comment out the 'Read GIS SA' command by placing '!' before the command:
    ! Read GIS SA == 2d_sa_M01_001_R
  3. Add the following additional command lines:
    Global Rainfall BC == RF_FC04 ! Reads in global rainfall
    Read GIS BC == 2d_bc_SWMM_Pipe_Network_Connections_001_L ! Links the 1D Pipe Network Outlets to the 2D domain
  4. Save the TBC.


TUFLOW SWMM Control File (TSCF)

  1. Open TS02_001.tscf. 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 SWMM == swmm\sw01_001.inp':
    Read SWMM == swmm\sw02_001.inp ! 1D SWMM Pipe Network Input File
    Read GIS SWMM Inlet Usage == swmm\swmm_iu_TS02_001.gpkg >> swmm_iu_TS02_001 ! 1D SWMM Pipe Network Inlet Usage Layer
  3. Save the TSCF.


Running the Simulation

  1. Save a copy of _run_TS01_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-AF\TUFLOW_iSP_w64.exe"
    set run=start "TUFLOW" /wait %exe% -b
    %run% TS02_5m_001.tcf
  3. Save the batch file and double click it in Windows File Explorer to run the simulation.
  4. Did your TUFLOW SWMM model fail to run successfully? If so, here is a link to a troubleshooting guide: TUFLOW SWMM Troubleshooting.



Check Files and Results Output

Complete the steps outlined in following links 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

  • 1D EPA SWMM pipe network features and 2D direct rainfall (rain on grid) hydrology have been added to the tutorial model.
  • Check files were used to review the 1D SWMM pipe network model features.
  • Simulation results in the 1D SWMM pipe network were viewed in time series and longsection plot format.

Other TUFLOW SWMM Tutorials


Up
Go-up.png Back to TUFLOW SWMM Tutorial Introduction Main Page