TUFLOW SWMM Tutorial M02: Difference between revisions
Content deleted Content added
Chris Huxley (talk | contribs) |
|||
| (115 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.
= 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 Model==
Line 28 ⟶ 25:
[[File: Tuflow_plugin_load_tcf_layers.png]]<br>
<br>
<li>
<li>In the Load Layers window, select:
* Ordering Options: Alphabetical
Line 36 ⟶ 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-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>
[[File: TS2_Configure_Project_01a.png]]<br>
</ol>
<br>
=== 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.
<ol>
<li>In the QGIS Layers Panel, select (left click) '''2d_bc_M01_001_L'''.
<li>Click on the 'Increment Selected Layer' symbol from the TUFLOW Plugin toolbar. This opens the dialog shown below.
<br>
[[File:tuflow_plugin_increment_layer.png]]<br>
<br>
:*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_00''2''_L'''. Change the name back to '''2d_bc_M01_00''1''_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'.
<li>Click '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>
</ol>
===Save QGIS Project Workspace===
<ol>
<li>Go to Project > Save As.
Line 63 ⟶ 81:
<br>
=
==Create SWMM GeoPackage Spatial Database==
<ol>
<li>Go to
<li>Go to
:*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
</ol>
<br>
{{Video|name=Animation_TS2_SWMM_Inputs_01e.mp4|width=1236}}
<br>
== 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 95 ⟶ 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
<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.
<li>
<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>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.
<li>Toggle off editing to save the edits.
<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 124 ⟶ 142:
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
<ol>
Line 131 ⟶ 149:
</ol>
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
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'''
<ol>
<li>In the QGIS Layers
<li>Right click '''Inlets--Inlets''' and select 'Open Attribute Table'.
<li>Click 'Add Feature'. Enter the following attributes (leave all other fields as ''NULL''):
:*Name: Combo1
:*Type: COMBINATION
:*Grate_Length:
:*Grate_Width: 0.
:*Grate_Type: P_BAR-50
:*Curb_Length:
:*Curb_Height: 0.
:*Curb_Throat: VERTICAL
For a summary of the attributes associated with the '''Inlets--Inlets'''
<li>Turn off editing to save the edits.
<br><br>
{{Video|name=
<br>
</ol>
Line 160 ⟶ 179:
<ol>
<li>In the QGIS Layers
<li>Right click '''Links--Streets''' and select 'Open Attribute Table'.
<li>Click 'Add Feature'. Enter the following attributes:
:*Name: Xsec1
:*Tcrown:
:*Hcurb: 0.2
:*Sx: 4
Line 172 ⟶ 191:
:*Sides: 1
:*Tback: 5
:*Sback:
:*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 184 ⟶ 204:
====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>
<li>In the QGIS Layers
<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
<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'.
<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 '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 <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=
<br>
</ol>
Line 202 ⟶ 223:
====Update Losses====
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>
<li>In the QGIS Layers
<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 217 ⟶ 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 230 ⟶ 252:
</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>
<li>In the QGIS Layers
<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'
:*Create connections at: 'Downstream end'
:*Offset Distance: 2
:*Length of BC lines: 10
Line 243 ⟶ 266:
<ol>
::<li>Click the ... and select 'Save to GeoPackage'.
::<li>Navigate to the '''TUFLOW\model\
::<li>A dialog will open. In the
::<li>Click 'OK'.
</ol>
<li>Click 'Run'.
<li>Once the tool is finished, click 'Close'.
<li>The '''2d_bc_SWMM_Pipe_Network_Connections_001_L''' appears in the QGIS Layers
<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 268 ⟶ 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
:::*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>Once the tool has finished, click 'Close'.
<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.
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=
<br>
</ol>
Line 299 ⟶ 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>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>
'''Note:''' This tool can also be activated from the Processing Toolbox.
<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=
<br>
</ol>
Line 330 ⟶ 354:
== 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''':
<ol>
<li>Right click anywhere in the QGIS Toolbar Panel and tick on 'Browser Panel' from the 'Panels' options.
<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.
<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 348 ⟶ 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 360 ⟶ 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 370 ⟶ 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 382 ⟶ 399:
<li> Save the TCF.
<br><br>
{{Video|name=
<br>
</ol>
Line 407 ⟶ 424:
<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>Read GIS BC </tt></font> <font color="red"><tt>==
<li>Save the TBC.
<br><br>
{{Video|name=
<br>
</ol>
Line 430 ⟶ 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>
{{Video|name=
</ol>
= Check Files and Results Output=
Line 449 ⟶ 464:
= Conclusion =
* 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 long section plot format.
* 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>
{{Tips Navigation
| |||