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 =
<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 search for "SWMM" in the Processing Toolbox panel.
<li>From the SWMM tools, select GeoPackage-Create. 
<li>Within the GeoPackage-Create pop-up, the following options are available in the Parameters tab : '''CRS for GeoPackage''', '''Initial SWMM Sections''' and '''GPKG file name to create'''.
* For '''CRS for GeoPackage''', pick up: Project CRS: EPSG:32760 - WGS 84/UTM zone 60S<br>
* For choosing the '''Initial SWMM Sections''', click on the '''...''' button. Then tick the following options and hit OK:<br>
**'''Title'''
**'''Options'''
**'''Nodes-Junctions'''
**'''Nodes-Outfall'''
**'''Links-Conduits'''
**'''Streets'''
**'''Inlets'''
**'''Reports'''
* For the '''GPKG file name to create''', click on the '''...''' button. Two options are available: Save to a Temporary File and Save to. Choose the second one. Direct to swmm folder and in the File name box provide '''swmm_M01_001''' name. Save as GeoPackage type.<br>
<li> Now hit Run and when the following message: 'GeoPackage - Create' finished appears into the log tab, click close. A file called '''swmm_M01_001''' with the relevant SWMM Sections and TUFLOW attributes is created. The TUFLOW-SWMM plugin automatically saves the file in the Module_01\TUFLOW\model\swmm folder. To open it in the QGIS Layers panel, open the '''swmm folder''', find the '''swmm_M01_001''' layer and drag and drop it in QGIS. A new Window is open. Right click on Select All and then on Add Layers.<br>
</ol> 
<br>

The attribute tables of the Inlets of swmm_M01_001.gpkg file is provided in a common GeoPackage:
<ol>
<li>Load in the starting_swmm_data.gpkg from the Module_01\Tutorial_Data folder by dragging and dropping the .gpkg into QGIS. On the Window dialogue choose Select All and then Add layers.The objects in the starting_swmm_data.gpkg is not in the TUFLOW file format and needs to be copied into the '''Nodes-Junctions''', '''Nodes-Outfall''' and '''Links-Conduits''' layers of swmm_M01_001.gpkg file to have the correct attributes.<br>
<li>For the swmm_M01_001 - '''Nodes-Junctions''', make layer editable by right clicking the layer and selecting 'Toggle Editing'.<br>
<li>Select the '''Nodes-Junctions''' layer from starting_swmm_data.gpkg file by left clicking on it once in the Layers panel and use the 'Select Features' tool to highlight it.<br>
<li>Select 'Edit' from the top QGIS tab and 'Copy Features' from the drop down menu.<br>
<li>Select the '''Nodes-Junctions''' of the swmm_M01_001.gpkg file in Layers panel by left clicking on it once. Select 'Edit' from the top QGIS tab and click 'Paste Features' from the drop down menu.
<li> Save and Toggle off Editing by right clicking the layer and selecting 'Toggle Editing'. <br>
<li>Repeat the above steps for the '''Nodes-Outfall''' and '''Links-Conduits''' layers of '''swmm_M01_001. gpkg''' file. <br>
</ol>
<br>

The Inlets of swmm_M01_001.gpkg file needs '''Streets''' information as well:
<ol>
<li>For the '''Streets''' layer of the '''swmm_M01_001.gpkg''' file, make the layer editable by right clicking the layer and selecting 'Toggle Editing'.<br>
<li>Again select  the '''Streets''' layer of the '''swmm_M01_001.gpkg''' file and open attribute table by right clicking.<br> 
<li>On the new opened Window, click the 'Toggle Editing' and the 'Add feature' icons. This allows the users to provide the table with attribute values.<br>
<li>Now, select the '''Streets''' layer of the starting_swmm_data.gpkg file. Right click the layer and select 'Open Attributes'.<br>
<li>Manually, copy the attribute table values from the '''Streets''' layer of the starting_swmm_data.gpkg into the attribute table of the '''Streets''' layer of the swmm_M01_001.gpkg file. The resulting table should be as follows:<br>
*'''Name:'''   Xsec1
*'''Tcrown:''' 10
*'''Hcurb:'''  0.2
*'''Sx:'''     0.4
*'''nRoad:'''  0.016
*'''a:'''      0
*'''W:'''      0
*'''Sides:'''  1
*'''Tback:'''  5
*'''Sback:'''  8
*'''nBack:'''  0.016
<li>When the process is complete, save, right click on the 'Toggle Editing' icon and exit. <br> 
<li>Remove the starting_swmm_data.gpkg file from the Layers panel.<br> 
</ol>
<br>

===Set Options===
<ol>
<li> Select the '''Options''' layer of the '''swmm_M01_001.gpkg''' file. By right clicking select 'Open Attribute Table'. Click the 'Toggle Editing' icon.<br>
<li> Change the following options into: <br>
*'''Start Date''': 1/1/2020 (Use US formatting)
*'''Report step''': 00:05:00
<li>Save, click again the 'Toggle Editing' icon and close.<br>
</ol>

= 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]]
}}