View source for TUFLOW SWMM Tutorial M02

= 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. <br> TUFLOW SWMM Tutorial Module 2 builds from the model created in <u>[[TUFLOW_SWMM_Tutorial_M01|TUFLOW SWMM Tutorial Module 1]]</u>. The completed TUFLOW SWMM Module 1 model is provided in the '''''TUFLOW_SWMM_Module_02\TUFLOW''''' folder of the download dataset as the starting point for this tutorial. If you are not already familiar with TUFLOW SWMM linking, we recommend first completing Module 1 before this tutorial. <br>

= QGIS Project Initialization =
QGIS Version 3.34 or newer, and QGIS TUFLOW Plugin 3.9.0.49 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> 
<li>Open QGIS.
<li>Go to Project > Properties… 
<li>In the CRS tab, type ‘WGS 84 / UTM Zone 60S’.
<li>Select the matching projection in the 'Predefined Coordinate Reference Systems' section.
<li>Click ‘Apply’ and ‘OK’.
<li>Ensure that the projection is set correctly by viewing the bottom right hand corner of the workspace. It should read ‘EPSG:32760’.
</ol>
<br>
{{Video|name=Animation_TS1_Initialization_01a.mp4|width=1235}}<br>

Load in the project GIS layers:
<ol>
<li>Click on the ‘Load TUFLOW Layers from TCF’ symbol from the TUFLOW Plugin toolbar.
<br>
[[File: Tuflow_plugin_load_tcf_layers.png]]<br>
<br>
<li>In File Explorer, navigate to the '''TUFLOW_SWMM_Module_02\TUFLOW\runs''' folder and select '''TS01_5m_001.tcf'''.
<li>In the Load Layers window, select:
* Ordering Options: Alphabetical
* Grouping Options: Group by control file
* Raster Load Options: Load Normally 
<li>Click ‘Open’ and ‘OK’.
</ol>
<br>
Style the TUFLOW layers. Suggested styling steps were provided in <u>[[TUFLOW_SWMM_Tutorial_M01#QGIS_Project_Initialization|TUFLOW SWMM Tutorial M01]]</u>. They have not been duplicated here.<br>
<br>
Save the QGIS Workspace:
<ol>
<li>Go to Project > Save As.
<li>Navigate to the '''TUFLOW_SWMM_Module_02''' folder and type '''SWMM_M02''' as the filename with the extension .qgz.
</ol>
<br>

= SWMM Inputs =
==Create SWMM GeoPackage Spatial Database== 
In QGIS, create a SWMM GeoPackage Database for the new pipe network features:
<ol> 
<li>Go to '''Processing > Toolbox''' from the top dropdown menu options to open the Processing Toolbox Panel.
<li>Go to '''TUFLOW > SWMM''' in the processing tool list and select 'GeoPackage - Create'. 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: 
:**'''Project--Title''', '''Project--Report.'''
:**'''Nodes--Junctions''', '''Nodes--Outfalls.''' 
:**'''Links--Conduits, Links--Streets.'''
:**'''Inlets--Inlets.'''
::'''Note:''' In Module 1 we also included '''Project--Options''' in the GeoPackage file. '''Project--Options''' is not required this time as this Tutorial 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 (TSCF) will be used.
:*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'''.
<li>Click 'Run'.
<li>Once to tool has finished, click ‘Close’.
<li>In 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 panel, 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. 
<br><br>
{{Video|name=Animation_TS2_SWMM_Inputs_01c.mp4|width=1235}}
</ol>
<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: 
:*'''Pipes''': defines the underground pipe network location, type and geometry.
:*'''Junctions''': defines the pipe network inlets.
:*'''Outfalls''': defines the pipe network outlet.

<br>
To populate the GeoPackage created in the previous section:
<ol>
<li>In Windows 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 panel, right click on the '''Pipes''' layer and select 'Zoom to Layer'.
<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>Select the '''Links--Conduits''' layer in the Layers panel by left clicking on it once. 
<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_02b.mp4|width=1235}}<br>
<li>Similarly, copy the objects from '''Junctions''' into '''Nodes--Junctions'''. Junctions are considered inlets, and should be defined at the upstream end of culverts.
<li>Also copy the objects from '''Outfalls''' into '''Nodes--Outfalls'''. Outfalls are treated as outlets, and are required at the downstream end of culverts.
<li>Toggle off editing to save the edits.
<li>Remove '''Urban_Development.gpkg'''
<br><br>
{{Video|name=Animation_TS2_SWMM_Inputs_03a.mp4|width=1235}}<br>
<li>Inspect the attribute information within the respective layers to familiarize yourself with the data.
<br><br>
{{Video|name=Animation_TS2_SWMM_Inputs_04a.mp4|width=1235}}<br>
</ol>

== GIS Data Updates ==
The provided GIS data requires numerous updates, prior to our model simulation. We have built these updates into this tutorial to demonstrate some of the available TUFLOW SWMM model built processing tools. 

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 Inlet, Elevation, Slope, Placement type (on-grade or on-sag). To reduce data entry requirements for this tutorial, a complete Inlet Usage Layer has been provided, '''swmm_iu_TS02_001'''.<br>   

<ol>
<li>Navigate to the '''TUFLOW_SWMM_Module_02\Tutorial_Data''' folder and save a copy of '''swmm_iu_TS02_001''' in the '''TUFLOW_SWMM_Module_02\TUFLOW\model\swmm''' folder.<br>
<li>Navigate to the '''TUFLOW\model\swmm''' folder. Drag and drop '''swmm_iu_TS02_001''' into the QGIS workspace.
</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 layer is documented in   <u>[https://docs.tuflow.com/classic-hpc/release/2023-03-AD/SWMM-TUFLOW-1.html#tab:tab-SWMMinletusage TUFLOW 2023-03-AD Release Notes (Table 4.1)]</u> 

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 panel, 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''):
:*Name: Combo1
:*Type: COMBINATION
:*Grate_Length: 1.5
:*Grate_Width: 0.5
:*Grate_Type: P_BAR-50
:*Curb_Length: 1.5
:*Curb_Height: 0.2
:*Curb_Throat: VERTICAL
For a summary of the attributes associated with the Inlets--Inlets Layer, refer to <u>[https://docs.tuflow.com/classic-hpc/release/2023-03-AD/SWMM-Input-Detailed-1.html#tab:tab-SWMM-Input-Inlets TUFLOW 2023-03-AD Release Notes (Table A.16)]</u> and the <u>[https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume2_Hydaulics_P100S9AS.pdf SWMM Reference Manual - Volume 2 (Hydraulics)]</u>.

<li>Turn off editing and save the information.
<br><br>
{{Video|name=Animation_TS2_SWMM_Inputs_05a.mp4|width=1235}}
<br>
</ol>

===Update Streets Details===

Street cross-section information is needed for SWMM on-grade inlet flow calculations. A single street cross-section type named 'Xsec1', is referenced in '''swmm_iu_TS02_001''' (the Inlet Usage Layer) using the 'StreetXSEC' field. <br>
We will now define this street cross-section type and its attributes. 

<ol>
<li>In the QGIS Layers panel, 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:
:*Name: Xsec1
:*Tcrown: 10
:*Hcurb: 0.2
:*Sx: 4
:*nRoad: 0.014
:*a: 0
:*W: 0
:*Sides: 1
:*Tback: 5
:*Sback: 4
:*nBack: 0.016
For a summary of the attributes associated with the Links--Streets Layer, refer to <u>[https://docs.tuflow.com/classic-hpc/release/2023-03-AD/SWMM-Input-Detailed-1.html#tab:tab-SWMM-Input-Streets TUFLOW 2023-03-AD Release Notes (Table A.24)]</u> and the <u>[https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume2_Hydaulics_P100S9AS.pdf SWMM Reference Manual - Volume 2 (Hydraulics)]</u>.
<li>Turn off editing to save the edits.
<br><br>
{{Video|name=Animation_TS2_SWMM_Inputs_06a.mp4|width=1235}}
<br>
</ol>

===Update Conduit Details===
====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 'Conduits - Assign node fields' tool from the Processing Toolbox.
<ol>
<li>In the QGIS Layers panel, 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 'Conduits - Assign Node Fields'. This opens the dialog shown below.
<li>Tick on the SWMM Node Layers: '''Nodes--Junctions''' and '''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:''' If you wish to only update selected objects during a future modeling project, instead of the entire '''Link--Conduits''' dataset, select the target objects first using the Feature by Area tool. The 'Conduits - Assign node fields' tool will provide an option to 'Modify Selected Features', instead of 'Modify All Features.'
<br><br>
{{Video|name=Animation_TS2_SWMM_Inputs_07a.mp4|width=1235}}
<br>
</ol>

====Update Losses====

Update the loss attributes in the '''Links--Conduits''' layer. These values will be entered automatically using the 'Conduits - Assign losses' tool from the Processing Toolbox. 
<ol>
<li>In the QGIS Layers panel, 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 'Conduits - Assign losses'. This opens the dialog shown below.
:*Input inlet usage features: '''swmm_iu_TS02_001'''.
:*Entrance loss furthest upstream channels: 0.5
:*Entrance loss for channels not furthest upstream: 0.2
:*Exit loss furthest downstream channels: 1.0
:*Exit loss for channels not furthest downstream: 0.4
<li>Select 'Modify All Features'.
<li>After the tool processing 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 'losses_Kentry', 'losses_Kexit' and 'losses_Kavg' attribute information is now configured.
<br><br>
{{Video|name=Animation_TS2_SWMM_Inputs_08a.mp4|width=1235}}
<br>
</ol>

===1D/2D Linking===
The 1D SWMM / 2D TUFLOW linkage locations to connect the pipe network inlets to the surface have been already automatically defined in the SWMM Inlet Usage Layer, '''swmm_iu_TS02_001''', using the 'Conn1D_2D' attribute.
<br>
<ol>
<br>
[[File:swmm_iu_TS02_001_attribute_table_Conn1D2D.png]]
<br>
</ol>
<br>
To complete the pipe network, 1D/2D linkage is needed at the outlet of the pipe network. The 'BC - Create channel endpoint 1D/2D connections' tool will be used to automate this process.
<ol>
<li>In the QGIS Layers panel, select (left click) '''Links--Conduits''' and toggle on editing.
<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 'BC - Create channel endpoint 1D/2D connections'. This opens the dialog shown below.
:*Input Conduits Layer: '''Links--Conduits'''
:*Tick on 'Selected features only'
:*Offset Distance: 2
:*Length of BC lines: 10
:*Tick on 'Set 2D cell elevation to 1D culvert invert at 1D/2D connection cells if needed'.
:*Output Layer:
<ol>
::<li>Click the ... and select 'Save to GeoPackage'.
::<li>Navigate to the '''TUFLOW\model\swmm''' folder and select '''sw02_001.gpkg'''. Click 'Save'. 
::<li>A dialog will open. In the Layer name box, write '''2d_bc_SWMM_Pipe_Network_Connections_001_L'''.
::<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 Layers panel. 
<li>Turn off editing to save the edits.
<br><br>
{{Video|name=Animation_TS2_SWMM_Inputs_09b.mp4|width=1235}}
<br>
<li>In the QGIS Layers panel, select (left click) '''2d_bc_SWMM_Pipe_Network_Connections_001_L''' and toggle on editing.
<li>The 'BC - Create channel endpoint 1D/2D connections' tool has created 1D connections at the upstream and downstream end of the selected pipe. We can delete the connections from the upstream end of the pipe (two CN and one HX lines), as all pipe network inlets are defined in '''swmm_iu_TS02_001'''
<li>Use the 'Select Features' tool to select the connections on the upstream end of the pipe.
<li>In the QGIS Layers panel, right click '''2d_bc_SWMM_Pipe_Network_Connections_001_L''' and select 'Open Attribute Table'.
<li>The selected connections will be highlighted in blue. Click 'Delete Selected Features'.
<li>Turn off editing to save the edits.
<br><br>
{{Video|name=Animation_TS2_SWMM_Inputs_10a.mp4|width=1235}}
<br>
</ol>

===Update SWMM Junction Details===

<ol>
<li>In the QGIS Layers panel, 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 'Junctions - Set attributes' 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'''
:*Nodes connected to 2D with Inlets (Ysur): 0
:*Nodes connected to 2D with Inlets (Area of ponding): 5
:*Nodes connected to 2D without Inlets (Ysur): 0
:*Nodes connected to 2D without Inlets (Apond): 50
:*Nodes without 2D Connection (Surcharge Depth): 50
:*Nodes without 2D Connection (Area of ponding): 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 Inlets--Inlets 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_11a.mp4|width=1235}}
<br>
</ol>

==SWMM Options==
The model we are building will use two SWMM INP files.
*'''sw01_001.inp''' was already created in TUFLOW SWMM Tutorial Module 1. It contained details defining the three culverts under the roads in the model. It also contained the associated 1D SWMM / 2D TUFLOW connection layer objects and the '''Project--Options''' necessary to execute the SWMM simulation. '''sw01_001.inp''' has been included in the base model we are using for Module 2. No changes will be made to it.
* We will create a new INP file for the SWMM pipe network inputs (covered in the next section). As SWMM Options are already included in '''sw01_001.inp''', they are not needed in this second (new) INP file. As such, no new SWMM Option commands are necessary for this tutorial.
'''Note:''' 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.
<br><br>

== Export SWMM INP File ==
We will now create a new INP file for the SWMM pipe network inputs. To do this, we need to convert '''sw02_001.gpkg''' into a SWMM INP file.

<ol>
<li>In the Processing Toolbox, go to TUFLOW > SWMM and select 'GeoPackage - Write to SWMM inp'. This opens the dialog shown below.
:*GeoPackage Input File: Navigate to the '''TUFLOW\model\swmm''' folder and select '''sw02_001.gpkg'''.<br>
<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'.
<br><br>
{{Video|name=Animation_TS2_SWMM_Inputs_12b.mp4|width=1235}}
<br>
</ol>

== TUFLOW Boundary Updates ==
We will be using TUFLOW's 2D direct rainfall (also known as rain on grid) functionality for the catchment inflow boundary condition approach to demonstrate flows into the pipe network inlets. There is a wide range of direct rainfall options built into TUFLOW, including:
*'''Globally uniform rainfall:''' This method applies temporally varied rainfall uniformly (spatially) over the entire model. 
*'''Spatially varying rainfall:''' This method applies temporally varied rainfall with spatial variation defined using polygon delineation, grid raster files or inbuilt TUFLOW TIN triangulation routines.<br>
<br>
The focus of this tutorial is not to demonstrate the available direct rainfall options. As such, we will be using the simplest approach, globally uniform rainfall. It does not require any GIS updates to implement the boundary condition change. Updates will be limited to the Boundary Condition Database reference and Control File syntax updates. Both are addressed in the next section. If you are interested in learning about the available direct rainfall options, please refer to <u>[[Tutorial_M06 |TUFLOW Tutorial Module 6]]</u>.
<br>
<ol>
<li>Copy '''rainfall_stations.csv''' from the '''TUFLOW_SWMM_Module_02\Tutorial_Data''' folder to the '''TUFLOW_SWMM_Module_02\TUFLOW\bc_dbase''' folder.
<li>Copy '''bc_dbase_TS02_001.csv''' from the '''TUFLOW_SWMM_Module_02\Tutorial_Data''' folder to the '''TUFLOW_SWMM_Module_02\TUFLOW\bc_dbase''' folder.
</ol>
<br>
It is common to use depth varying manning's roughness when using direct rainfall. A Materials File using depth varying inputs has been provided. 
<ol>
<li>Copy '''materials_TS02_001.csv''' from the '''TUFLOW_SWMM_Module_02\Tutorial_Data''' folder to the '''TUFLOW_SWMM_Module_02\TUFLOW\model''' folder.
<br><br>
{{Video|name=Animation_TS2_TUFLOW_Boundary_01a.mp4|width=1235}}
<br>
</ol>

== TUFLOW Geometry Update  ==
We will update TUFLOW's 2D elevation and landuse to represent changes associated with the urban development.

First, we will establish the TUFLOW GeoPackage database for these updates.
<ol>
<li>Navigate to the '''TUFLOW\model\gis''' folder. Save a copy of '''M02_001.gpkg''' as '''TS02_001.gpkg'''.
</ol>

We will now copy new TUFLOW geometry inputs to the new GeoPackage database:
<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 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'''
:*'''2d_ztin_TS02_Dev_001_L'''
:*'''2d_ztin_TS02_Dev_001_P'''
:*'''2d_ztin_TS02_Dev_001_R'''
Hold Ctrl in on the keyboard 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_01b.mp4|width=1235}}
<br>
</ol>

= Simulation Control Files =
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 recommended). 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.
:*Open '''TS01_001.tbc,'''  and save the file as '''TS02_001.tbc''' in the '''TUFLOW\model''' folder.
:*Open '''TS01_001.tscf,'''  and save the file as '''TS02_001.tscf''' in the '''TUFLOW\model''' folder.
<br>
</ol>

===TUFLOW Control File (TCF)===
<ol>
<li>Open '''TS02_001.tcf'''.
<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\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>
<font color="blue"><tt>BC Control File </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>..\model\TS02_001.tbc</tt></font> <font color="green"><tt>  ! Reference the TUFLOW Boundary Condition Control File</tt></font><br>
<font color="blue"><tt>BC Database </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>..\bc_dbase\bc_dbase_TS02_001.csv</tt></font> <font color="green"><tt>  ! Reference the Boundary Condition Database</tt></font><br>
<font color="blue"><tt>Read Materials File </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>..\model\materials_TS02_001.csv</tt></font> <font color="green"><tt>  ! Reference the Materials Definition File</tt></font><br>
<font color="blue"><tt>SWMM Control File </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt> ..\model\TS02_001.tscf </tt></font> <font color="green"><tt>  ! Reference the SWMM (1D) Control File</tt></font> <br>
<li>Add the following line in the '<font color="green"><tt>Output Settings</tt></font>' section: <br>
<font color="blue"><tt>Map Cutoff Depth </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt> 0.05 </tt></font> <font color="green"><tt>! Sets map cutoff depth of 0.05 meters</tt></font> <br>
<li> Save the TCF.
<br><br>
{{Video|name=Animation_TS2_Sim_Control_01b.mp4|width=1235}}
<br>
</ol>

=== TUFLOW Geometry Control File (TGC) ===
<ol>
<li>Open '''TS02_001.tgc'''. If using Notepad++, right click the file reference in '''TS02_5m_001.tcf''' and select 'Open File'.
<li>Add the following command to the the '<font color="green"><tt>Topography</tt></font>' section below the below the existing '<font color="blue"><tt>Read GIS Z Shape</tt></font>' command:<br>
<font color="blue"><tt>Create TIN Zpts </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>2d_ztin_TS02_Dev_001_R | 2d_ztin_TS02_Dev_001_L | 2d_ztin_TS02_Dev_001_P</tt></font> <font color="green"><tt>  ! Urban Development Topography TIN</tt></font> <br>
<li>Add the following lines in the '<font color="green"><tt>Materials</tt></font>' section, below the existing material commands : <br> 
<font color="blue"><tt>Read GIS Mat </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>2d_mat_TS02_Dev_Lots_001_R</tt></font><font color="green"><tt>    ! Urban Development Landuse 1</tt></font> <br>
<font color="blue"><tt>Read GIS Mat </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>2d_mat_TS02_Dev_Buildings_001_R</tt></font> <font color="green"><tt> ! Urban Development Landuse 2</tt></font> <br>
<li>Save the TGC.
<br><br>
{{Video|name=Animation_TS2_Sim_Control_02b.mp4|width=1235}}
<br>
</ol>

=== TUFLOW Boundary Control File (TBC) ===
<ol>
<li>Open '''TS02_001.tbc'''. If using Notepad++, right click the file reference in '''TS02_5m_001.tcf''' and select 'Open File'.
<li> Comment out the 'Read GIS SA' command by placing '!' before the command: <br>
<font color="green"><tt>! Read GIS SA == 2d_sa_M01_001_R</tt></font><br>
<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>== </tt></font> <font color="black"><tt>swmm\sw02_001.gpkg >></tt></font> <font color="black"><tt>2d_bc_SWMM_Pipe_Network_Connections_001_L</tt></font> <font color="green"><tt>  ! Links the 1D Pipe Network Outlets to the 2D domain</tt></font> <br>
<li>Save the TBC.
<br><br>
{{Video|name=Animation_TS2_Sim_Control_03b.mp4|width=1235}}
<br>
</ol>

=== TUFLOW SWMM Control File (TSCF) ===
<ol>
<li>Open '''TS02_001.tscf'''. If using Notepad++, right click the file reference in '''TS02_5m_001.tcf''' and select 'Open File'.
<li>Add the following command lines after '<font color="blue"><tt>Read SWMM </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>swmm\sw01_001.inp</tt></font>':   <br>
<font color="blue"><tt>Read SWMM </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>swmm\sw02_001.inp</tt></font> <font color="green"><tt>  ! 1D SWMM Pipe Network 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>swmm\swmm_iu_TS02_001.gpkg >> swmm_iu_TS02_001</tt></font> <font color="green"><tt>  ! 1D SWMM Pipe Network Inlet Usage Layer</tt></font> <br>
<li>Save the TSCF.
<br><br>
{{Video|name=Animation_TS2_Sim_Control_04b.mp4|width=1235}}
<br>
</ol>

= Running the Simulation =
<ol>
<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-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>TS02_5m_001.tcf </tt></font> 

<li>Double click the batch file in Windows Explorer to run the simulation. 
<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_01b.mp4|width=1235}}<br>
</ol>
<br>

= Check Files and Results Output=
Complete the steps outlined in following links to review check files and simulation results from the TUFLOW SWMM model simulation:

<u>[[TUFLOW_SWMM_Tutorial_M02_Check_QGIS | TUFLOW SWMM Tutorial 02 Check Files]]</u> <br>
<u>[[TUFLOW_SWMM_Tutorial_M02_Results_QGIS | TUFLOW SWMM Tutorial 02 Results]]</u> <br>

= Conclusion =
:*1D EPA SWMM pipe network features and 2D direct rainfall (rain on grid) hydrology have been added to the tutorial model.
<br>
{{Tips Navigation
|uplink=[[TUFLOW_SWMM_Tutorial_Introduction#Tutorial_Modules| Back to TUFLOW SWMM Tutorial Introduction Main Page]]
}}