Tuflow

TUFLOW SWMM Tutorial M01: Difference between revisions

Browse history interactively
← Older edit
Content deleted Content added
VisualWikitext
No edit summary
 
(289 intermediate revisions by 4 users not shown)
Line 2:
In this module, three culverts are added to represent flow through three separate road embankments. EPA SWMM is used as the solution scheme for the 1D culvert flow calculations, dynamically linked with the TUFLOW HPC 2D solution scheme. <br>
 
TUFLOW SWMM Tutorial Module 1 builds from the model created in <u>[[Tutorial_M02 |TUFLOW Tutorial Module 2]]</u> (in the TUFLOW Only tutorial dataset). The completed TUFLOW Module 2 model is provided in the '''''TUFLOW_SWMM_Module_01\TUFLOW''''' folder of the download dataset as the starting point for this tutorial. If you are not already familiar with TUFLOW, we recommend first completing Module 1 and 2 of the <u>[[Tutorial_Introduction | "TUFLOW Only" Tutorials]]</u> to establish an understanding of 2D modellingmodeling, before progressing to learning how to link 1D EPA SWMM to 2D TUFLOW. <br>
 
= QGIS Project Initialization =
Three steps are required for the 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>
<ol>
Define the Coordinate Reference System (CRS), also called ‘Projection’, for the QGIS workspace:
<li> Setting the QGIS Project Coordinate Reference System (CRS).
<li> Configuring the QGIS TUFLOW Plugin.
<li> Establishing the new TUFLOW model GeoPackage file that will include new GIS inputs associated with this model update.
</ol>
 
== QGIS ==
QGIS Version 3.34 or newer, and QGIS TUFLOW Plugin 3.11 or newer are required to access the SWMM Processing Tools described in the following sections. For installation, see <u>[https://wiki.tuflow.com/TUFLOW_QGIS_Plugin Installation of TUFLOW Plugin]</u>.<br>
Firstly, define the Coordinate Reference System (CRS), also called ‘Projection’, for the QGIS workspace:
<ol>
<li>Open QGIS.
Line 16 ⟶ 24:
</ol>
<br>
{{Video|name=Animation_assign_projection_001Animation_TS1_Initialization_01a.mp4|width=1235}}<br>
 
==TUFLOW Model==
Load in the project GIS layers:
===Load and Style TUFLOW Model Files===
Load and Style the GIS layers from the TUFLOW model:
<ol>
<li>Click on the ‘Load TUFLOW Layers from TCF’ symbol from the TUFLOW Plugin toolbar.
Line 24 ⟶ 34:
[[File: Tuflow_plugin_load_tcf_layers.png]]<br>
<br>
<li>In File Explorer, navigateNavigate to the '''TUFLOW_SWMM_Module_01\TUFLOW\runs''' folder and select '''M02_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 ashowever preferredyou desire. Common steps to do this are:
<ol>
<li>Click on the ‘Apply TUFLOW Styles to Open Layers’ symbol from the TUFLOW Plugin toolbar.
<br>
[[File:tuflow_plugin_styles_open_layers.png]]<br>
<br>
<li>Change the symbology of the DEM:
*Right click on the '''DEM''' file in the QGIS Layers panelPanel and select 'Properties'.
*From the Symbology tab, under 'Band Rendering' select the following options:
:*Render type: Singleband pseudocolor
Line 45 ⟶ 59:
*Click 'Apply' and 'OK'.
<br>
{{Video|name=Animation_TS1_Initialization_03d.mp4|width=1235}}<br>
<li>Create a hillshade of the DEM:
*Right click on the '''DEM''' file in the QGIS Layers panelPanel and select 'Duplicate Layer'.
*Right click on the '''DEM_copy''' and select 'Rename Layer'. Rename the layer to '''DEM_Hillshade'''.
*Right click on the '''DEM_Hillshade''' file and select 'Properties'.
*From the Symbology tab, under 'Band Rendering' select the following options:
:*Render type: Hillshade
:*Z Factor: 3
*From the Transparency tab, set the Global Opacity to 35%.
*Click 'Apply' and 'OK'.
<br>
{{Video|name=Animation_TS1_Initialization_04b.mp4|width=1235}}<br>
</ol>
 
===TUFLOW Plugin===
= SWMM Inputs and 1D/2D Linking=
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_01''' 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-AF''' 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: TS1_Configure_Project_01a.png]]<br>
</ol>
<br>
 
=== Increment Model GeoPackage File ===
We will now save a copy of '''M02_001.gpkg''' with a new name, '''TS01_001.gpkg'''. This project initialization step is recommended so prior model versions from a project are not broken as a result of changes being made to GIS inputs.
 
<ol>
<li>In the QGIS Layers Panel, 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>
[[File:tuflow_plugin_increment_layer.png]]<br>
<br>
:*Source Layer: Automatically set to the selected layer, '''2d_bc_M01_001_L'''.
:*Output Database: Click 'Browse...'. This will automatically open to the '''TUFLOW\model\gis''' folder. Set the new output database name to '''TS01_001.gpkg''' and click 'Save'.
:*Output Layer Name: This will automatically increment to '''2d_bc_M01_00''2''_L'''. Change the name back to '''2d_bc_M01_00''1''_L'''.
:*Delete the pre-filled 'Incremented Layer' entry in the table. We do not wish to modify the version number associated with the 2d_bc file. This current exercise will not change the version number of any of the GIS layer inputs, it is simply establishing a copy of the existing GeoPackage where future edits will be saved to.
:*Select 'Remove Source Layer from Workspace'.
:*Select 'Increment Layer and Preserve Database'.
<li>Click 'OK'.
<li>The GeoPackage database, '''TS01_001.gpkg''' will now be in the '''TUFLOW_SWMM_Module_01\TUFLOW\model\gis''' folder. <br>
<br>
{{Video|name=Animation_TS1_Initialization_05c.mp4|width=1235}}
<br>
</ol>
 
===Save QGIS Project Workspace===
<ol>
<li>Go to Project > Save As.
<li>Navigate to the '''TUFLOW_SWMM_Module_01''' folder and type '''SWMM_M01''' as the filename with the extension .qgz.
</ol>
<br>
 
= GIS Inputs =
==Create SWMM GeoPackage Spatial Database==
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.<br>
Line 65 ⟶ 123:
In QGIS, create the SWMM GeoPackage Database:
<ol>
<li>Go to Processing > Toolbox from the top dropdropdown menu options to open the Processing Toolbox panel.
<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: '''Title''',(if '''Options''',not '''Nodes--Junctions''',already '''Nodes--Outfalls''', '''Links--Conduits''', '''Streets''', '''Inlets''' andticked): '''Report'''.
::*'''Project--Title''', '''Project--Options''', '''Project --Report.'''
:*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 '''TS01_001.gpkg'''.
::*'''Nodes--Junctions''', '''Nodes--Outfalls.''', '''Nodes--Storage.'''
::*'''Links--Conduits, Links--Streets'''.
:*To define the ‘GPKG filename to create’: Click …, select ‘Save to File’. Navigate to the '''TUFLOW\model\swmm''' folder and save the GeoPackage database as '''sw01_001.gpkg'''.
 
 
<li>Click ‘Run’.
<li>Once tothe tool has finished, click ‘Close’.
<li>In Windows File Explorer, navigate to the '''TUFLOW\model\swmm''' folder and drag and drop '''TS01_001sw01_001.gpkg''' into QGIS.
<li>When prompted by QGIS, selectunder '''Links--Conduits''Options', tick on '''Nodes--Junctions''Add layers to group', then select 'Add Layers''Nodes--Outfalls''' andto open all vectors within '''Optionssw01_001.gpkg'''. (holdBy Ctrldefault, toall selectitems multiplein layers).the available list should Clickhave ‘Addbeen Layers’selected.
<li>In the QGIS Layers Panel, move '''sw01_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_create_TS01_002Animation_TS1_SWMM_Inputs_01g.mp4|width=12351236}}
<br>
<br>
Line 82 ⟶ 146:
== GIS Data Entry ==
 
A GeoPackage database called '''SWMM_Culverts.gpkg''' is provided in the '''TUFLOW_SWMM_Module_01\Tutorial_Data''' folder. It contains three layers:
:*'''Conduits:''' defines the culvert location, type and geometry.
:*'''Junctions:''' defines the upstream culverts inverts.
:*'''Outfalls:''' defines the downstream culvert inverts.
:*'''Storage_nodes:''' defines the upstream culvert inverts.
<br>
To populate the GeoPackage database created in the previous section:
<ol>
<li>In Windows File Explorer, navigate to the '''TUFLOW_SWMM_Module_01\Tutorial_Data''' folder. Drag and drop the '''SWMM_Culverts.gpkg''' into QGIS. and select the following layers (hold Ctrl to select multiple):
<li>When prompted by QGIS, under 'Options', tick on 'Add layers to group'. By default, all items in the GeoPackage database will be selected. Click 'Add Layers'.
*'''Conduits'''
<li>In the QGIS Layers Panel, right click on the '''SWMM_Culverts >> Conduits''' layer and select 'Zoom to Layer(s)'.
*'''Junctions'''
*'''Outfalls'''
<li>In the QGIS Layers Panel, right click on the '''Conduits''' layer and select 'Zoom to Layer'.
<li>Use the 'Select Features' tool to highlight all items included in '''Conduits'''.
<li>Select 'Edit' from the top QGIS tab and 'Copy Features' from the drop down manumenu.
<li>SelectIn the QGIS Layers Panel, select (left click) the '''sw01_001.gpkg >> 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 [[imageFile:jkatoggle_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_copy_conduit_001Animation_TS1_SWMM_Inputs_02f.mp4|width=12351236}}
<br>
<li>CopySimilarly, copy the objects from '''JunctionsStorage_nodes''' into '''Nodes--JunctionsStorage'''. Junctions are considered inlets, and shouldstorage benodes definedare allowed at the upstream end of culverts. Storage nodes are preferred for culverts receiving 2D flows not through a storm drain inlet.
<li>CopyAlso 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 and save the edits.
<li>Close '''SWMM_Culverts.gpkg'''
<li>Remove '''SWMM_Culverts.gpkg'''.
<br><br>
{{Video|name=Animation_copy_junctions_outfalls_001Animation_TS1_SWMM_Inputs_03f.mp4|width=12351236}}
<br>
<li>Inspect the attribute information within the respective layers to familiarize yourself with the data.
<br><br>
{{Video|name=Animation_attribute_info_001Animation_TS1_SWMM_Inputs_04f.mp4|width=12351236}}
</ol>
<br>
 
== GIS Data Updates ==
The provided GIS data requires numerous updates, priorbefore proceeding to oura model simulation. We have intentionally built these updates into this tutorial to demonstrate some of the available TUFLOW SWMM model builtbuild processing tools. The following updates are being made to objects and layers within '''sw01_001.gpkg'''.
 
The following updates are being made to Objects and Layers within '''TS01_001.gpkg'''
===Update Conduit Details===
==== Node Details ====
Step 1 involves updating the ''From Node'' and ''To Node'' attribute information in '''Links-Conduits'''. This information 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--Junction''' and '''Nodes--Outfall''' automatically using the '''Conduits - Assign Node Fields''' tool from the Processing Toolbox.
Stage 1 of building the 1D SWMM network involves updating the 'From Node' and 'To Node' attribute information in '''Links--Conduits'''. This information defines the Link/Node connections. <br>
 
The information we will be adding to '''Links--Conduits''' is extracted from '''Nodes--Storage''' and '''Nodes--Outfalls''' automatically using the '<u>[[QGIS_SWMM_Conduits_Assign_Node_Fields |Conduits - Assign node fields]]</u>' tool from the Processing Toolbox.
# Select (Left mouse click) '''Links--Conduits''' in the QGIS Layers panel and Toggle Editing on.
<ol>
# From the Processing Toolbox, select '''Editing in place'''. This allows the editing of an existing Layer, instead of the creation of a new Layer.
<li>In the QGIS Layers Panel, select (left click) '''Links--Conduits''' and toggle on editing.
# Select the '''Conduits - Assign Node Fields''' processing tool.
<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.
# Select '''Nodes--Junction''' and '''Nodes--Outfall''' in the SWMM Node Layers field.
<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.
# Select '''Modify All Features'''.
:*SWMM Node Layers: Tick on '''sw01_001 >> Nodes--Storage''' and '''sw01_001 >> Nodes--Outfalls'''. Click 'OK'.
# Close the '''Conduits - Assign Node Fields''' processing tool.
<li>Select 'Modify All Features'.
# 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.
<li>Once the tool has finished, click 'Close'.
Tip: If you wish to only update select objects during a future modelling 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.''
<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>
<br>
'''Tip 1:''' If you wish to only update a selection of objects, instead of selecting the entire '''Links--Conduits''' dataset, select the target objects first using the 'Select Features' 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>
'''Tip 2:''' Unique Node ID's are required for the SWMM network to function error free. If you are following this workflow for a project model build, please ensure the '''Nodes--Storage''' and '''Nodes--Outfalls''' object ID information is unique. If duplicate ID values are assigned to multiple objects, consider using the '<u>[[QGIS_SWMM_Integrity_Make_Object_Names_Unique |Integrity - Make object names unique ]]</u>' TUFLOW SWMM processing tool to ensure all ID values are unique before using '<u>[[QGIS_SWMM_Conduits_Assign_Node_Fields |Conduits - Assign node fields]]</u>'.
<br><br>
{{Video|name=Animation_update_conduit_001Animation_TS1_SWMM_Inputs_05g.mp4|width=12351236}}
<br>
 
===Update Losses===
 
</ol>
Step 2, update the loss attributes in the '''Links-Conduits''' Layer. These values will be entered manually in this example using default values. Variation to the default values can be used in project models to reflect site specific information if desired.
 
====Update Losses====
# Select (Left mouse click) '''Links--Conduits''' in the QGIS Layers panel and Toggle Editing on.
Stage 2 involves updating the loss attributes in the '''Links--Conduits''' layer. In this example, default loss values are used and will be entered manually. These loss values can be adjusted in your project models to reflect site specific information if desired.
# Right mouse click '''Links--Conduits''' in the QGIS Layers panel and select Open Attribute Table.
<ol>
# Set:
<li>In the QGIS Layers Panel, select (left click) '''Links--Conduits''' and toggle on editing.
#* losses_Kentry = 0.5
<li>Right click '''Links--Conduits''' and select 'Open Attribute Table'.
#* losses_kexit = 1.0
<li>For each conduit, update the following fields:
#* losses_Kavg = 0.0
:*losses_Kentry: 0.5
# Save '''Links--Conduits'''
:*losses_Kexit: 1.0
:*losses_Kavg: 0.0
The video below demonstrates how to do this one entry at a time, or via the bulk attribute update options in QGIS.
<li>Turn off editing to save the edits.
<br><br>
{{Video|name=Animation_TS1_SWMM_Inputs_06f.mp4|width=1236}}
</ol>
<br>
 
Since all the 1D SWMM inputs in this model are embankment culverts that all use the same loss parameters, it's not necessary to specify different loss attributes. The <u>[[TUFLOW_SWMM_Tutorial_M02 | TUFLOW SWMM Module 2]]</u> will demonstrate an urban pipe network added to the model, with different loss attributes required for the road culverts and underground storm pipe network links. To simplify this step, Module 2 uses the '<u>[[QGIS_SWMM_Conduits_Assign_Node_Fields |Conduits - Assign node fields]]</u>' processing tool.
<br>
{{Video|name=Animation_update_losses_001.mp4|width=1235}}
<br>
 
An urban pipe network is added to the model in TUFLOW SWMM Module 2. In that situation, different loss attributes are required for the road culverts and underground stormwater pipe network links. To simplify the loss attibute update step in that situation, we will be introducing the '''Conduits - Assign Node Fields''' processing tool. It is however, not necessary for this Module 1 tutorial because all the 1D SWMM inputs are embankment culverts.
 
=== Create 1D/2D Connections===
The following instructions introduce a new tool that automates the creation of 1D/2D connections. ForDue 1Dto the limitations of SWMM boundary conditions, HX lines are required fromfor the upstream end of the culvert (rather than SX), and SX connections are used at the downstream end of the culvert.<br>
<ol>
<li>SelectIn (Leftthe mouseQGIS Layers Panel, select (left click) '''Links--Conduits''' in the QGIS Layers panel.
<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. <br>
<li>Use the select the Feature by Area tool to select all culvert objects in '''Links-Conduits'''.
'''Note:''' Ensure the 'Edit Features In-Place' tool has been turned off.
 
:*Input Conduits Layer: '''Links--Conduits'''
<li>In the search box of the '''Processing Toolbox''' panel, type '''SWMM'''.
:*Create connections at: 'Both ends'.
 
:*Offset Distance: 2
<li>From the SWMM list, choose the '''BC - Create channel endpoint 1D/2D connections'''.
:*Length of BC lines: 10
 
:*Tick on 'Set 2D cell elevation to 1D culvert invert at 1D/2D connection cells if needed'.
<li>Select the following options:
:*Output Layer:
*'''Input Conduits Layer''' = Links Conduits
<ol>
*'''Offset distance''' = 2
::<li>Click the ... and select 'Save to GeoPackage'.
*'''Length of BC lines''' = 10
::<li>Navigate to the '''TUFLOW\model\gis''' folder and select '''TS01_001.gpkg'''. Click Save.
*'''Output Layer'''= Select: '''Save to GeoPackage'''. Choose '''TS01_001.gpkg''' in the '''model\swmm''' folder and click Save. A Layer Name Window will open. Provide the following name: '''2d_bc_SWMM_Connections_001_L'''.<br></ol>
::<li>A dialog will open. In the Layer name field, write '''2d_bc_SWMM_Culvert_Connections_001_L'''.
::<li>Click 'OK'.
</ol>
<li>Click 'Run'.
<li>Once the tool is finished, click 'Close'.
<li>The '''2d_bc_SWMM_Culvert_Connections_001_L''' appears in the QGIS Layers Panel. Select 'Apply TUFLOW Styles to Current Layer'.
<br><br>
{{Video|name=Animation_TS1_SWMM_Inputs_07f.mp4|width=1236}}
</ol>
<br>
'''Note:''' The positions of the HX and SX connections may not be in the optimum location or extent using the generalized automated tool. As such, it is recommended to check the output from this processing step. In this module, the 1D/2D connections associated with '''2d_bc_SWMM_Culvert_Connections_001_L''' are checked in <u>[[TUFLOW SWMM Tutorial M01 Check QGIS|TUFLOW SWMM Tutorial 01 Check Files]]</u>.
<br>
{{Video|name=Animation_1D2D_connections_001.mp4|width=1235}}
<br>
 
===Update JunctionStorage Node Details===
The attributes of the storage nodes need to be modified to represent the storage of the connected HX cells since these cells do not represent storage themselves. The area associated with the storage nodes should be similar to the areas of the HX cells. To set the area, we will use a "PYRAMIDAL" shape with the SWMM side slope (run/rise) (Z) set to 0 to represent vertical walls. As the cell size is 5m, and the length of each polyline is 10m, the length (L) will be set to 10m and the width (W) to 5m. These sizes will be modified later when we change the boundary conditions.
 
<ol>
# Select (Left mouse click) '''Node--Junctions''' in the QGIS Layers panel and Toggle Editing on.
#<li> FromIn the ProcessingQGIS ToolboxLayers Panel, select (left click) '''Editing in placeNodes--Storage'''. Thisand allowstoggle theon editing of an existing Layer, instead of the creation of a new Layer.
<li> Right click '''Nodes--Storage''' and select 'Open Attribute Table'.
# Select the '''Junctions - Set attributes''' processing tool. Select the following:
<li> Set the following attributes:
#* '''Input bc connections layer''' = 2d_bc_SWMM_Connections_001_L
:* YMax: 50.0 (this is a value greater than the expected water level. It is required to allow water to fill node)
#* '''Nodes connected to 2D without Inlets (Ysur )''' = 0
:* TYPE: 'PYRAMIDAL'
#* '''Nodes connected to 2D without Inlets (Apond )''' = 50
:* L: 10
# Select '''Modify All Features.'''
:* W: 5
# Close the '''Junctions - Set attributes''' processing tool.
:* Z: 0.0
# View the attributes associated within '''Node--Junctions''' to verify the data processing has been completed correctly.
<li> Turn off editing to save the edits.
 
 
<br>
{{Video|name=Animation_update_junctions_001.mp4|width=1235}}
<br><br>
{{Video|name=Animation_TS1_SWMM_Inputs_08g.mp4|width=1236}}
<br>
</ol>
 
==SWMM Options==
<ol>
<li> SelectIn the QGIS Layers Panel, select (left click) '''Project--Options''' Layerand intoggle '''TS01_001.gpkg'''on fileediting.
<li>Right click '''Project--Options''' and select 'Open Attribute Table'.
<li> Select Toggle Editing to enable changes to be made to the Layer.
<li>Update the following options:
 
*'''START_DATE''': 2020-01-01 (Date Format: YYYY-MM-DD)
<li>Right click the '''Options''' layer in the Layers Panel and select '''Open Attribute Table'''.</li><li> Update the following option:
*'''REPORT_STEP''': 00:01:00
*'''Start Date''': 01/01/2020 (USA Date Format: MM/DD/YYY)
<li>Turn off editing to save the edits.
*'''Report step''': 00:05:00
<li>Save and Toggle Editing off.
</ol>
 
{{Video|name=Animation_update_options_001Animation_TS1_SWMM_Inputs_09f.mp4|width=12351236}}
<br>Save the QGIS Project Workspace:
<br><br>
 
# Go to Project > Save. This will update '''SWMM_M01.qgz''', which was created previously in the folder '''TUFLOW_SWMM_Module_01'''.<br>
 
== Export SWMM INP File ==
SWMM doesis not able to read the '''TS01_001sw01_001.gpkg''' database directly, astherefore, anwe inputneed GISto file.convert SWMMthe requiresGeoPackage file to a SWMM INP file format.
 
<ol>
<li>RightIn the QGIS Layers Panel, right click '''Links--Conduits''' in(or theany QGISof Layersthe panel,SWMM layers) and select '''''TUFLOW' >> 'SWMM - Export inp file'''''.
<li>This will open the '<u>[[QGIS_SWMM_GeoPackage_Write_to_SWMM_inp |GeoPackage - Write to SWMM inp]]</u>' processing tool, prepopulated with the filename of the layer's GeoPackage. <br>
<li>Select '''TS01_001.gpkg''' as the GeoPackage Input File.
'''Note:''' This tool can also be activated from the Processing Toolbox.
<li>Set the SWMM output filename to '''TS01_001.inp''' in the '''''TUFLOW/model/swmm''''' folder.
<li>Click 'Run'.
<li>Select "Run", then "Close" after the processing is complete.
<li>Once the tool is finished, click 'Close'.
<li>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 '''sw01_001.inp''' to the '''TUFLOW\model\swmm''' folder.
<br><br>
{{Video|name=Animation_TS1_SWMM_Inputs_10e.mp4|width=1236}}
</ol><br>
 
= Simulation Control Files =
The following steps will require use of a text editor. The tutorial demonstration uses Notepad++. For its configuration information refer to <u>[[NotepadPlusPlus_Tips | Notepad++ Tips]]</u>. <br>
 
To differentiate the TUFLOW SWMM tutorials from the TUFLOW/ESTRY tutorials, 'TS' is used as the file prefix in this series of tutorials. 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. <br>
 
Set up the simulation control files:
<ol>
<li>In Windows File Explorer, navigate to the '''TUFLOW_SWMM_Module_01\TUFLOW\runs''' folder and open '''M02_5m_001.tcf''' in a Text Editor (Notepad++ is recommended).
<li>Save the file as '''TS01_5m_001.tcf''' in the '''TUFLOW_SWMM_Module_01\TUFLOW\runs''' folder.
<li>Open '''M01_001.tbc''' using the 'Open File' function in Notepad++. Save the file as '''TS01_001.tbc''' in the '''TUFLOW_SWMM_Module_01\TUFLOW\model''' folder.
<li>Create a new blank text file called '''TS01_001.tscf''' and save it in the '''TUFLOW_SWMM_Module_01\TUFLOW\model''' folder.
<br><br>
{{Video|name=Animation_TS1_Sim_Control_00a.mp4|width=1235}}<br>
</ol>
 
=== TUFLOW Control File (TCF) ===
<ol>
<li>Open '''TS01_5m_001.tcf''' in a Text Editor (Notepad++ is recommended) and 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>
<li>Add the following line in the '<font color="green"><tt>Model Inputs</tt></font>' 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>
<li>Add the following line in the '<font color="green"><tt>Output Settings</tt></font>' 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>
<li>Save the TCF.
<br><br>
{{Video|name=Animation_TS1_Sim_Control_01c.mp4|width=1235}}<br>
</ol>
<br>
{{Video|name=Animation_create_inp_001.mp4|width=1235}}
 
= 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>SaveFrom '''M01_001TS01_001.tbctcf''', asright click '''TS01_001.tbc''' inand theselect 'Open File'. This opens '''TUFLOW_SWMM_Module_01\TUFLOW\model''TS01_001.tbc''' folderinto a new tab in Notepad ++.
<li>Add the following command line after '<font color="blue"><tt>Read GIS SA </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>2d_sa_M01_001_R</tt></font>': <br>
<li>Open '''TS01_001.tbc''' in a text editor and add the additional lines: <br>
<font color="blue"><tt>SpatialRead GIS BC Database</tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>swmm\TS01_001.gpkg2d_bc_SWMM_Culvert_Connections_001_L</tt></font> <brfont color="green"><tt> ! Links 1D SWMM culverts to the 2D TUFLOW domain</tt></font>
<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.
<br><br>
{{Video|name=Animation_TS1_Sim_Control_02c.mp4|width=1235}}<br>
</ol>
<font color="red">'''<< Add video >>'''</font>
 
=== TUFLOW SWMM Control File (TSCF) ===
A new control file, the TUFLOW SWMM Control File (TSCF), is introduced.used SWMMto iscontrol athe 1DSWMM hydraulicinput solverdata. All 1D SWMM files and commands are referenced in the TUFLOW SWMM Control File.<br>
<ol>
<li>CreateFrom a'''TS01_001.tcf''', newright text file calledclick '''TS01_001.tscf''', savedand inselect the'Open File'. This opens ''''TUFLOW_SWMM_Module_01\TUFLOW\model''TS01_001.tscf''' folderinto a new tab in Notepad ++.
<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_001sw01_001.inp</tt></font> <font color="green"><tt> ! 1D SWMM culvert input file</tt></font> <br>
<li>Save the TSCF. <br>
<br><br>
{{Video|name=Animation_TS1_Sim_Control_03c.mp4|width=1235}}<br>
</ol>
<br>
<font color="red">'''<< Add video >>'''</font>
 
=== TUFLOW Control File (TCF) ===
<ol>
<li>Save a copy of the '''M02_5m_001.tcf''' as '''TS01_5m_001.tcf''' in the '''''TUFLOW_SWMM_Module_01\TUFLOW\runs''''' folder.
<li>Open the '''TS01_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 update: <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>
<font color="red">'''<< Add video >>'''</font>
 
= 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-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>TS01_5m_001.tcf </tt></font>
 
<li>Double clickSave the batch file and double click it in Windows fileFile explorerExplorer to run the simulation.
</ol>
<font color="red">'''<< Add video >>'''</font>
<br>
If the model simulation doesn't run:
If your model simulation did not run. Here is a link to some comon <u>[[Tutorial_Troubleshooting_QGIS | Tutorial Trouble Shooting]]</u> advice.
<ol>
<li> Check in the screen output or the tlf file near the end for "For SWMM Model Errors see:". This indicates that there is something wrong with the SWMM inputs. Reviewing that file will provide feedback on what is wrong.
<li> Review this link for common <u>[[TUFLOW_SWMM_Troubleshooting | TUFLOW SWMM Troubleshooting]]</u> advice.
</ol>
<br><br>
{{Video|name=Animation_TS1_Run_Sim_01d.mp4|width=1236}}<br>
</ol>
 
= Check Files and Results Output=
Complete the steps outlinesoutlined in the following linklinks to review check files and simulation results from the TUFLOW SWMM model simulation:
 
<u>[[TUFLOW_SWMM_Tutorial_M01_Check_QGIS | TUFLOW SWMM Tutorial 01 Check Files]]</u> <br>
<u>[[TUFLOW_SWMM_Tutorial_M01_Results_QGIS | TUFLOW SWMM Tutorial 01 Results]] </u><br>
 
= Conclusion =
:*EPA SWMM Culvertsculverts were added to convey water through the structures under the three roads in the tutorial model.
:*Check files were used to review the applicationinclusion of the1D SWMM culverts to a 2D boundaryTUFLOW linksmodel.
:*Results through the 1D network structuresculverts were assessed.
<br>
 
=Other TUFLOW SWMM Tutorials=
*<u>[[TUFLOW_SWMM_Tutorial_M01 | TUFLOW SWMM Module 1]]</u> - 1D SWMM Culverts
*<u>[[TUFLOW_SWMM_Tutorial_M02 | TUFLOW SWMM Module 2]]</u> - 1D SWMM Pipe Network / 2D TUFLOW Direct Rainfall Hydrology
*<u>[[TUFLOW_SWMM_Tutorial_M03 | TUFLOW SWMM Module 3]]</u> - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology
*<u>[[TUFLOW_SWMM_Tutorial_M04 | TUFLOW SWMM Module 4]]</u> - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology: Executing multiple different event simulations from a single model control file.
*<u>[[XPSWMM_to_TUFLOW-SWMM | XPSWMM to TUFLOW SWMM]]</u> - How to convert an XPSWMM model to TUFLOW SWMM.
 
{{Tips Navigation
|uplink=[[TUFLOW_SWMM_Tutorial_Introduction#Tutorial_Modules| BackReturn to TUFLOW SWMM Tutorial Introduction Main Page]]
}}
Retrieved from "https://wiki.tuflow.com/TUFLOW_SWMM_Tutorial_M01"