Tuflow

TUFLOW SWMM Tutorial M02: Difference between revisions

Browse history interactively
← Older editNewer edit →
Content deleted Content added
VisualWikitext
No edit summary
No edit summary
Line 4:
= Project Initialization =
==QGIS==
QGIS Version 3.34 or newer, and QGIS TUFLOW Plugin 3.9.0.11011 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:
<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>In the previous section, the CRS (Coordinate Reference System) for the QGIS Workspace was defined. As such, the projection inputs are set automatically.
<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-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>▼
[[File:SWMM_M02_configure_project.png]]<br>
</ol>▼
<br>▼
 
==TUFLOW Model==
Line 50 ⟶ 34:
<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>
 
▲===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-ADAF''' 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>
 
Line 56:
 
<ol>
<li>In the QGIS Layers panelPanel, 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>
Line 70:
<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_02bAnimation_TS2_Initialization_02c.mp4|width=12351236}}
<br>
</ol>
Line 88:
<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):
::*'''Project--Title''', '''Project--Report.'''
::*'''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 Tutorialtutorial 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>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 panelPanel, 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=Animation_TS2_SWMM_Inputs_01dAnimation_TS2_SWMM_Inputs_01e.mp4|width=12351236}}
 
<br>
Line 108 ⟶ 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 118 ⟶ 117:
<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 panelPanel, 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.
<li>In the QGIS Layers panelPanel, 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>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=Animation_TS2_SWMM_Inputs_02cAnimation_TS2_SWMM_Inputs_02d.mp4|width=12351236}}<br>
<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 132 ⟶ 131:
<li>Remove '''Urban_Development.gpkg'''.
<br><br>
{{Video|name=Animation_TS2_SWMM_Inputs_03bAnimation_TS2_SWMM_Inputs_03c.mp4|width=12351236}}<br>
<li>Inspect the attribute information within the respective layers to familiarize yourself with the data.
<br><br>
{{Video|name=Animation_TS2_SWMM_Inputs_04bAnimation_TS2_SWMM_Inputs_04c.mp4|width=12351236}}<br>
</ol>
 
Line 154 ⟶ 153:
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>
<li>In the QGIS Layers panelPanel, select (left click) '''Inlets--Inlets''' and toggle on editing.
<li>Right click '''Inlets--Inlets''' and select 'Open Attribute Table'.
<li>Click 'Add Feature'. Enter the following attributes (leave all other fields as ''NULL''):
Line 168 ⟶ 167:
 
 
<li>Turn off editing andto save the informationedits.
<br><br>
{{Video|name=Animation_TS2_SWMM_Inputs_05bAnimation_TS2_SWMM_Inputs_05c.mp4|width=12351236}}
<br>
</ol>
Line 180 ⟶ 179:
 
<ol>
<li>In the QGIS Layers panelPanel, select (left click) '''Links--Streets''' and toggle on editing.
<li>Right click '''Links--Streets''' and select 'Open Attribute Table'.
<li>Click 'Add Feature'. Enter the following attributes:
Line 198 ⟶ 197:
<li>Turn off editing to save the edits.
<br><br>
{{Video|name=Animation_TS2_SWMM_Inputs_06bAnimation_TS2_SWMM_Inputs_06c.mp4|width=12351236}}
<br>
</ol>
Line 207 ⟶ 206:
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 panelPanel, 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.
Line 216 ⟶ 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:''' IfIn a future modeling project, if you wish to only update selected objects during a future modeling project, insteadrather ofthan the entire '''Links--Conduits''' dataset, select the target objects first using the Feature'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_07bAnimation_TS2_SWMM_Inputs_07c.mp4|width=12351236}}
<br>
</ol>
Line 226 ⟶ 225:
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 panelPanel, select (left click) '''Links--Conduits''' and toggle on editing.
<li>In the Processing Toolbox, selectensure 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 ais newstill layerselected.
<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 layers: '''swmm_iu_TS02_001'''.
Line 240 ⟶ 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=Animation_TS2_SWMM_Inputs_08cAnimation_TS2_SWMM_Inputs_08d.mp4|width=12351236}}
<br>
</ol>
Line 255 ⟶ 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 panelPanel, 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 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.
Line 273 ⟶ 272:
<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 panelPanel.
<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_09dAnimation_TS2_SWMM_Inputs_09e.mp4|width=12351236}}
<br>
</ol>
Line 283 ⟶ 282:
 
<ol>
<li>In the QGIS Layers panelPanel, 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>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.
Line 292 ⟶ 291:
:::*Nodes receiving subcatchment flows option (if connected to 2D): 'Based on options selected below'.
:*Nodes connected to 2D without Inlets:
:::*None - leave defaults
:::*Ysur: 0
:::*Area of ponding: 50
:*Nodes connected to 2D with Inlets:
:::*Maximum depth (Ymax) option: 'Use global option'
:::*Ysur: 0 (ignored because ponding > 0.0)
:::*Area of ponding: 255
:*Nodes without 2D Connection:
:::*Surcharge Depth: 50
:::*Area of ponding: 10.0
 
<li>Select 'Modify All Features'.
Line 308 ⟶ 306:
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_10cAnimation_TS2_SWMM_Inputs_10d.mp4|width=12351236}}
<br>
</ol>
Line 323 ⟶ 321:
 
<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>InThis thewill Processingopen Toolbox, go to TUFLOW >> SWMM and selectthe '<u>[[QGIS_SWMM_GeoPackage_Write_to_SWMM_inp |GeoPackage - Write to SWMM inp]]</u>'. Thisprocessing tool, prepopulated openswith the dialogfilename shownof belowthe layer's GeoPackage. <br>
:*GeoPackage Input File: Navigate to the '''TUFLOW\model\swmm''' folder and select '''sw02_001.gpkg'''.<br>
'''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>By default, thisThis 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_11dAnimation_TS2_SWMM_Inputs_11e.mp4|width=12351236}}
<br>
</ol>
Line 361 ⟶ 360:
<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 367 ⟶ 366:
:*'''2d_ztin_TS02_Dev_001_P'''
:*'''2d_ztin_TS02_Dev_001_R'''
Hold Ctrl to select multiple layers at the same time.
</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_01eAnimation_TS2_TUFLOW_Geometry_01f.mp4|width=12351236}}
<br>
</ol>
Line 379 ⟶ 377:
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 recommendedused here). Save the file as '''TS02_5m_001.tcf''' in the '''TUFLOW_SWMM_Module_02\TUFLOW\runs''' folder.
<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 448 ⟶ 446:
<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-ADAF\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="orange"><tt>%run% </tt></font> <font color="black"><tt>TS02_5m_001.tcf </tt></font>
 
<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>
If the model simulation doesn't run, here is a link to some common <u>[[Tutorial_Troubleshooting_QGIS | Trouble Shooting]]</u> advice.
<br><br>
{{Video|name=Animation_TS2_Run_Sim_01bAnimation_TS2_Run_Sim_01c.mp4|width=12351236}}<br>
</ol>
== Troubleshooting ==
▲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>
 
= Check Files and Results Output=
Retrieved from "https://wiki.tuflow.com/TUFLOW_SWMM_Tutorial_M02"