View source for TUFLOW SWMM Tutorial M01

= Introduction =
In this module, three culverts are added to represent flow through embankments that block the main creek flow path. EPA SWMM is used as the solution scheme for the 1D culvert flow calculations, dynamically linked with the TUFLOW HPC 2D solution scheme. <br>

The GIS layers are:<br>
:*TSCF (TUFLOW SWMM Control File) layers:
<ol><ol><li>SWMM.inp: A text file containing a record of the SWMM culvert inputs and also SWMM simulation parameters. </ol></ol>
<ol><ol><li>1d_SWMM_Inlet: A layer used to define culvert inlet nodes. </ol></ol>
:*TBC layers:
<ol><ol><li> 2d_bc: A layer defining the locations of 1D/2D links.<br>

</ol></ol>
'''TUFLOW SWMM Module 1 builds from the model created in <u>[[Tutorial_M02 | TUFLOW Module 2]]</u> (in the TUFLOW Only tutorial dataset). The completed Module 2 model is provided in the TUFLOW_SWMM_Module_01\TUFLOW folder as the starting point for this tutorial''' <br>
<br>

= SWMM Inputs and 1D/2D Linking=
==Create SWMM GeoPackage Spatial Database== 
<ol> 
<li>Create a new folder in the '''TUFLOW_SWMM_Module_01\TUFLOW\model''' folder called '''swmm'''. This is the location where all SWMM inputs will be saved.<li>Open QGIS and slect the Processing >> Toolbox to open the Processing Toolbox panel.
<li>From the TUFLOW >> SWMM processing tool list, select GeoPackage-Create. 
<li>Within the GeoPackage-Create options, set the following:
*'''CRS for GeoPackage''' = Project CRS: EPSG:32760 - WGS 84/UTM zone 60S
*'''Initial SWMM Sections''', click on the '''...''' button, then select: '''''Title,''' '''Options,''' '''Nodes-Junctions,''' '''Nodes-Outfalls,''' '''Links-Conduits,''' '''Streets,''' '''Inlets,''' '''Report'''''
*'''GPKG file name to create''', click on the '''...''' button, select '''Save to File...'''. Navigate to the newly created swmm folder and set the SWMM GeoPackage Spatial Database name to '''TS01_001.gpkg'''
* Select '''Run'''. After the processing task is complete, select '''Close'''.  

<li>Open the new SWMM GeoPackage Spatial Database in QGIS by dragging and dropping '''swmm\TS01_001.gpkg''' from Windows Explorer into QGIS. When prompted by QGIS select "Add Layers" to open all vectors within the GeoPackage database. By default, all items in the available list should have been selected.<br>
</li></ol> 
'''<< Add video of above steps>>'''

== GIS Data Entry ==
Navigate to the '''TUFLOW_SWMM_Module_01\Tutorial_Data''' folder in Windows Explorer. Drag and drop '''SWMM_Culverts.gpkg''' into QGIS to open the file. SWMM_Culverts.gpkg includes three Layers, Links-Conduits, Nodes-Junctions and Nodes-Outfall. Links-Conduits defines the culvert location, type and geometry. Nodes-Junction define the upstream culverts inverts. Nodes-Outfall define the downstream culvert inverts.

Complete the following steps: 

# Copy the objects from '''Links-Conduits SWMM_Culverts.gpkg''' into '''Links-Conduits TS01_001.gpkg.''' Steps to Copy/Paste are as follows:
#* Left click '''Links-Conduits SWMM_Culverts.gpkg''' in the QGIS Layers Panel.
#* Use the select the Feature by Area tool to select all items included in '''Links-Conduits SWMM_Culverts.gpkg'''
#* Select Edit >> Copy Features
#* Left click '''Links-Conduits TS01_001.gpkg''' in the QGIS Layers Panel.
#* Select Toggle Editing to enable changes to be made to the Layer.
#* Select Edit >> Paste Features

'''<< Add video for Copy Paste>'''

# Copy the objects from '''Nodes-Junction SWMM_Culverts.gpkg''' into '''Nodes-Junction TS01_001.gpkg.''' Junctions are considered inlets, and should be defined at the upstream end of culverts.
# Copy the objects from '''Nodes-Outfall SWMM_Culverts.gpkg''' into '''Nodes-Outfall TS01_001.gpkg.''' Outfalls are treated as outlets, and are required at the downstream end of culverts.
# Close '''SWMM_Culverts.gpkg''' 
# Inspect the attribute information within the respective layers to familiarize yourself with the data.

'''<< Add video for viewing attribute data>>'''

== GIS Data Updates ==
=== Update Conduit Details ===
We will update the ''From Node'' and ''To Node'' attribute information in '''Links-Conduits TS01_001.gpkg'''. The information is extracted from '''Nodes-Junction''' and '''Nodes-Outfall''' automatically using the ''Conduits - Assign Node Fields'' tool from the Processing Toolbox.

# Select (Left mouse click) '''Links-Conduits TS01_001.gpkg''' in the QGIS Layers panel and Toggle Editing on. 
# From the Processing Toolbox, select "''Editing in place"''. This allows the editing of an existing Layer, instead of the creatin of a new Layer
# Select the '''''Conduits - Assign Node Fields''''' tool.
# Select '''Nodes-Junction''' and '''Nodes-Outfall''' in the SWMM Node Layers field.
# Select Modify All Features.
# Close the ''Conduits - Assign Node Fields'' tool.

View the attributes associated with Links-Conduits TS01_001.gpkg. The ''From Node'' and ''To Node'' attribute information is now configured correctly.

=== Create 1D/2D Connections===
<ol>
<li>Select (Left mouse click) '''Links-Conduits''' in the QGIS Layers panel.
<li>Use the select the Feature by Area tool to select all culvert objects in '''Links-Conduits'''.

<li>In the search box of the Processing Toolbox panel, type SWMM.

<li>From the SWMM list, choose the '''BC - Create channel endpoint 1D/2D connections'''. 

<li>Select the following options:
<li>'''Input Conduits Layer''' = Links Conduits

<li>'''Offset distance''' = 2

<li>'''Length of BC lines''' = 10

<li>'''Output Layer'''= Select: Save to GeoPackage. Choose M06_5m_003.gpkg in the Module_01\TUFLOW\model\gis folder and click Save. A Layer Name Window will open. Provide the following name: '''2d_bc_SWMM_Connections_001_L''' <br>

<li>Now, you can check and modify the boundary lines as needed to cover the channels as per the example below:<br>
</ol>
<br>
[VIDEO]

=== Other ===
'''Rusty - Do I need to include the Steet input if I'm not using no grade or sag inlets'''

also where does someone get the template file for the ext_inlets_P?  Does AD beta produce it?

==SWMM Options==
<ol>
<li> Select the '''Options''' Layer in '''TS01_001.gpkg''' file. 
<li> Select Toggle Editing to enable changes to be made to the Layer.

<li>Right click the Layer in the Layers Panel and select 'Open Attribute Table'.</li><li> Update the following option: 
*'''Start Date''': 01/01/2020 (USA Date Format: MM/DD/YYY)
*'''Report step''': 00:05:00
<li>Save and Toggle Editing off.  
</ol>


'''<< Add video of above steps>>'''
==1D/2D Linking==

= Simulation Control Files = 
=== TUFLOW Boundary Control File (TBC) ===
To differentiate the TUFLOW SWMM tutorials from the TUFLOW/ESTRY tutorials, TS will be used as the new file prefix in this series of tutorials. 
<ol>
<li>Save a copy of the '''M01_001.tbc''' as '''TS01_001.tbc''' in the '''TUFLOW_SWMM_Module_01\TUFLOW\model''' folder.
<li>Open '''TS01_001.tbc''' in a text editor and add the additional lines: <br>
<font color="blue"><tt>Read GIS BC </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>2d_bc_SWMM_Connections_001_L</tt></font> <font color="green"><tt>  ! Links the 1D culverts to the 2D domain</tt></font> <br>
<li>Save the TBC.
</ol>

=== TUFLOW SWMM Control File (TSCF) ===
A new control file, the TUFLOW SWMM Control File (TSCF), is introduced. SWMM is a 1D hydraulic solver. All 1D SWMM files and commands are referenced in the TUFLOW SWMM Control File.<br>
<ol>
<li>Create a new text file '''TS01_001.tscf''' and save it in the '''TUFLOW_SWMM_Module_01\TUFLOW\model''' folder.
<li>Add the following command lines: <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> <font color="green"><tt>  ! 1D SWMM input file</tt></font> <br>
<font color="blue"><tt>Spatial Database </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>..\swmm\TS01_001.gpkg</tt></font> <font color="green"><tt>  ! Location of the SWMM GeoPackage Spatial Database</tt></font> <br>
<font color="blue"><tt>Read GIS SWMM Inlet Usage </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>1d_SWMM_Inlet</tt></font> <font color="green"><tt>  ! Something??</tt></font>
<li>Save the TSCF. <br>
</ol>

=== TUFLOW Control File (TCF) ===
<ol>
<li>Save a copy of the '''M02_5m_001.tcf''' as '''M03_5m_001.tcf''' in the '''Module_03\TUFLOW\runs''' folder. 
<li>Open the '''M03_5m_001.tcf''' in a text editor:<br>
Add the following line in the 'Model Inputs' section:  <br>
<font color="blue"><tt>SWMM Control File </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt> ..\model\TS01_001.tscf </tt></font> <font color="green"><tt>  ! Reference the SWMM (1D) Control File</tt></font> <br>
Add the following line in the 'Output Settings' section: <br>
<font color="blue"><tt>NetCDF Output Start Date </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>2020-01-01 00:00 </tt></font> <font color="green"><tt>! Sets the output units for the NetCDF time variable</tt></font> <br>
<li>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\TS01_001.gpkg </tt></font> <font color="green"><tt>! Specify the location of the GeoPackage Spatial Database</tt></font> <br>
<font color="blue"><tt>BC Control File </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>..\model\TS01_001.tbc</tt></font> <font color="green"><tt>  ! Reference the TUFLOW Boundary Conditions Control File</tt></font> <br>
<li>Save the TCF.
</ol>

= Running the Simulation =
<ol>
<li>Save a copy of '''_run_M02_HPC.bat''' as '''_run_TS01_HPC.bat''' in the '''TUFLOW_SWMM_Module_01\TUFLOW\runs''' folder.
<li>Update the batch file to reference the '''TS01_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>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>TS01_5m_001.tcf </tt></font> 

<li>Double click the batch file in Windows file explorer to run the simulation. 
</ol>

= Troubleshooting = 
See tips on common mistakes and troubleshooting steps if the model doesn't run:
:*<u>[[Tutorial_Troubleshooting_QGIS | QGIS]]</u>
<br>

= Check Files = 
While the model is running, review the added features are specified correctly:
:*<u>[[Tutorial_M03_Check_Files_QGIS_GPKG | QGIS - GPKG]]</u>

= Results =
When the model is finished, review the results:
:*<u>[[Tutorial_M03_Results_QGIS | QGIS]]</u>
<br>

= Conclusion =
:*Culverts were added to the model. Three different SX boundary applications were used to transfer flow through road embankments.<br>
:*Check files were used to review the application of the boundary links. 
:*Results through the 1D network structures were assessed to validate the 1D stability.
<br>
{{Tips Navigation
|uplink=[[TUFLOW_SWMM_Tutorial_Introduction| Back to TUFLOW SWMM Tutorial Introduction Main Page]]
}}