View source for TUFLOW SWMM Tutorial M01

= Introduction =
In this module, three culverts are added to represent flow through embankments that block the main flow paths. 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>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>
'''Module 3 builds from the model created in <u>[[Tutorial_M02 | TUFLOW Module 2]]</u>. The completed Module 2 model is provided in the TUFLOW_SWMM_Module_01\TUFLOW folder.''' <br>
<br>

= GIS Inputs =
Create, import and view input data:
:*<u>[[Tutorial_M03_GIS_Inputs_QGIS_GPKG | QGIS - GPKG]]</u>
<br>

= Simulation Control Files = 
=== TUFLOW Boundary Control File (TBC) ===
To diferentiate 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>
<u>'''QGIS - GPKG'''</u><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>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 and add the following line in the 'Model Inputs' section:  <br>
<font color="blue"><tt>ESTRY Control File </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt> ..\model\M03_001.ecf </tt></font> <font color="green"><tt>  ! Reference the ESTRY (1D) Control File</tt></font> <br>
<li>Make the following reference updates:  <br>
<u>'''QGIS - SHP'''</u><br>
<font color="blue"><tt>BC Control File </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>..\model\M03_001.tbc</tt></font> <font color="green"><tt>  ! Reference the TUFLOW Boundary Conditions Control File</tt></font> <br>
<li><u>'''QGIS - GPKG'''</u><br>
<font color="blue"><tt>Spatial Database </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt> ..\model\gis\M03_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\M03_001.tbc</tt></font> <font color="green"><tt>  ! Reference the TUFLOW Boundary Conditions Control File</tt></font> <br>
<li>Save the TCF.
</ol>
<br>

= Running the Simulation =
<ol>
<li>Save a copy of '''_run_M02_HPC.bat''' as '''_run_M03_HPC.bat''' in the '''Module_03\TUFLOW\runs''' folder.
<li>Update the batch file to reference the '''M03_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-AA\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>M03_5m_001.tcf </tt></font> <br>

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

= 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 | QGIS - SHP]]</u>
:*<u>[[Tutorial_M03_Check_Files_QGIS_GPKG | QGIS - GPKG]]</u>
<br>

= 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=[[Tutorial_Introduction| Back to Tutorial Introduction Main Page]]
}}