TUFLOW SWMM Tutorial M02: Difference between revisions
Content deleted Content added
| (57 intermediate revisions by 4 users not shown) | |||
Line 1:
= 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 <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
= Project Initialization =
==QGIS==
QGIS Version 3.34 or newer, and QGIS TUFLOW Plugin 3.
Define the Coordinate Reference System (CRS), also called ‘Projection’, for the QGIS workspace:
<ol>
Line 16:
<br>
{{Video|name=Animation_TS1_Initialization_01a.mp4|width=1235}}<br>
==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>▼
<li>Open the 'Configure TUFLOW Project' tool by selecting Plugins > TUFLOW > Editing > Configure / Create TUFLOW Project.▼
<li>To set the location of the TUFLOW folder, click 'Browse...' and navigate to the '''TUFLOW_SWMM_Module_02'''. Click 'Select Folder'. ▼
<li>To set the location of the TUFLOW single precision executable file, click 'Browse...' and navigate to the '''exe\2023-03-AD''' 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>▼
</ol>▼
<br>▼
==TUFLOW Model==
Line 41 ⟶ 25:
[[File: Tuflow_plugin_load_tcf_layers.png]]<br>
<br>
<li>
<li>In the Load Layers window, select:
* Ordering Options: Alphabetical
Line 49 ⟶ 33:
</ol>
<br>
Style the TUFLOW layers. Suggested styling steps were provided in <u>[[TUFLOW_SWMM_Tutorial_M01#
<br>
▲===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>
▲<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-
▲<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>
[[File: TS2_Configure_Project_01a.png]]<br>
▲</ol>
▲<br>
=== Increment TUFLOW GeoPackage File ===
<ol>
Line 62 ⟶ 63:
:*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
:*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'.
<li>Click 'OK'.
<li>The GeoPackage database, '''TS02_001.gpkg''' will now be in the '''TUFLOW_SWMM_Module_02\TUFLOW\model\gis''' folder.
</ol>▼
<br><br>
{{Video|name=
<br>
▲</ol>
===Save QGIS Project Workspace===
<ol>
<li>Go to Project > Save As.
Line 80 ⟶ 81:
<br>
=
==Create SWMM GeoPackage Spatial Database==
We will create a new SWMM GeoPackage database for our pipe network feature entries:
<ol>
<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 '<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 ‘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 '''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
<li>Click 'Run'.
<li>Once
<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>
<br>
{{Video|name=
<br>
Line 107:
== 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.
Line 113:
<br>
To populate the GeoPackage database created in the previous section:
<ol>
<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>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>Select 'Edit' from the top QGIS tab and 'Copy Features' from the drop down menu.
Line 125:
<li>Toggle the editing off to save the edits.
<br><br>
{{Video|name=
<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>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.
Line 131:
<li>Remove '''Urban_Development.gpkg'''.
<br><br>
{{Video|name=
<li>Inspect the attribute information within the respective layers to familiarize yourself with the data.
<br><br>
{{Video|name=
</ol>
Line 167:
<li>Turn off editing
<br><br>
{{Video|name=
<br>
</ol>
Line 193:
:*Sback: 2
:*nBack: 0.016
For a summary of the attributes associated with the '''Links--Streets'''
<li>Turn off editing to save the edits.
<br><br>
{{Video|name=
<br>
</ol>
Line 208:
<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>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: '''sw02_001 >> Nodes--Junctions''' and '''sw02_001 >> Nodes--Outfalls'''.
<li>Select 'Modify All Features'.
<li>Once the tool has finished, click 'Close'.
Line 215:
<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:'''
<br><br>
{{Video|name=
<br>
</ol>
Line 226:
<ol>
<li>In the QGIS Layers Panel, select (left click) '''Links--Conduits''' and toggle on editing.
<li>In the Processing Toolbox,
<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.
:*Input inlet usage
:*
:*Culvert or pipe network outlet - Exit loss: 1.0
:*Pipe Network (manholes and pit inlets):
:::*Entrance loss: 0.2
:::*Exit loss: 0.4
<li>Select 'Modify All Features'.
<li>After the tool processing has finished, click 'Close'.
Line 238 ⟶ 239:
<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=
<br>
</ol>
Line 253 ⟶ 254:
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>
<li>In the QGIS Layers Panel, select (left click) '''Links--Conduits'''
<li>Use the 'Select Features' tool to select the most downstream object in '''Links--Conduits'''.
<li>In the Processing Toolbox, go to
:*Input Conduits Layer: '''Links--Conduits'''
:*Tick on 'Selected features only'
Line 265 ⟶ 266:
<ol>
::<li>Click the ... and select 'Save to GeoPackage'.
::<li>Navigate to the '''TUFLOW\model\
::<li>A dialog will open. In the layer name box, write '''2d_bc_SWMM_Pipe_Network_Connections_001_L'''.
::<li>Click 'OK'.
Line 272 ⟶ 273:
<li>Once the tool is finished, click 'Close'.
<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=
<br>
</ol>
Line 281 ⟶ 282:
<ol>
<li>In the QGIS Layers
<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 '<u>[[QGIS_SWMM_Junctions_Set_Attributes |Junctions - Set attributes ]]</u>' 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):
:*Nodes connected to 2D without Inlets
:::*None - leave defaults
:*Nodes without 2D Connection (Surcharge Depth): 50▼
:*Nodes
:::*Maximum depth (Ymax) option: 'Use global option'
:::*Ysur: 0 (ignored because ponding > 0.0)
:::*Area of Ponding (Apond): 5
:::*Surcharge Depth: 50
:::*Area of Ponding (Apond): 0.0
<li>Select 'Modify All Features'.
Line 297 ⟶ 305:
<li>Turn off editing to save the edits.
<li>View the attributes associated within '''Nodes--Junctions''' to verify the data processing has been completed correctly. <br>
For a summary of the attributes associated with the '''
<br><br>
{{Video|name=
<br>
</ol>
Line 314 ⟶ 322:
<ol>
<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>
'''Note:''' This tool can also be activated from the Processing Toolbox.
<li>By default, 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. ▼
<li>Click 'Run'.
<li>Once the tool is finished, click 'Close'.
▲<li>
<br><br>
{{Video|name=
<br>
</ol>
Line 349 ⟶ 358:
Copy the following TUFLOW geometry inputs to GeoPackage '''TS02_001.gpkg''':
<ol>
<li>Right click anywhere in the QGIS
<li>Within the QGIS Browser
<li>In the 'Project Home' directory, navigate to the '''TUFLOW_SWMM_Module_02\Tutorial_Data''' folder.
<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'''
:*'''2d_mat_TS02_Dev_Lots_001_R'''
Line 358 ⟶ 367:
:*'''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=
<br>
</ol>
Line 370 ⟶ 378:
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>
<li>Open '''TS01_5m_001.tcf''' in a Text Editor (Notepad++ is
<li>Using the 'Open File' function in Notepad++:
:*Open '''M02_001.tgc,''' and save the file as '''TS02_001.tgc''' in the '''TUFLOW\model''' folder.
Line 380 ⟶ 388:
===TUFLOW Control File (TCF)===
<ol>
<li>Open '''TS02_001.tcf'''
<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>
Line 392 ⟶ 399:
<li> Save the TCF.
<br><br>
{{Video|name=
<br>
</ol>
Line 420 ⟶ 427:
<li>Save the TBC.
<br><br>
{{Video|name=
<br>
</ol>
Line 440 ⟶ 447:
<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>
<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-
<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>
<li>
<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><br>
{{Video|name=
</ol>
= Check Files and Results Output=
Line 459 ⟶ 464:
= 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
* For further training opportunities see <u>[https://tuflow.com/training/training-course-catalogue/ TUFLOW Training Catalogue]</u> and/or contact <u>[mailto:training@tuflow.com training@tuflow.com]</u>.
▲<br>
=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>
| |||