View source for XPSWMM to TUFLOW-SWMM Recommended Additional Conversion Steps

= Introduction =
While the bulk of the XPSWMM to TUFLOW SWMM model conversion is automated by the '<u>[[QGIS_SWMM_Convert_XPSWMM_Model_From_XPX|Convert - XPSWMM model from XPX]]</u>' processing tool, some required or recommended conventions must be implemented/updated manually. Therefore, it is highly recommended to complete the following additional conversion steps.<br>

For more targeted conversion guidance (i.e. for structures using non-typical shapes), please refer to the <u>[[XPSWMM_to_TUFLOW-SWMM_Troubleshooting |XPSWMM to TUFLOW SWMM Troubleshooting]]</u> page.

= Additional Steps =
It is recommended to make the following changes after running the '<u>[[QGIS_SWMM_Convert_XPSWMM_Model_From_XPX|Convert - XPSWMM model from XPX]]</u>' processing tool to follow TUFLOW-SWMM conventions for stability and accuracy:
* Storage nodes at HX connections
* Recommended junction attributes

== Convert HX Junctions to Storage Nodes ==
As TUFLOW HX cells do not have storage associated with them, this storage needs to be represented in the 1D domain. This can be achieved by using storage nodes at these locations. Storage nodes also improve model stability. 

To convert the junction nodes at HX boundaries to storage nodes:
<ol> 
<li> In QGIS, go to Processing > Toolbox from the top dropdown menu options to open the Processing Toolbox.
<li> Go to TUFLOW >> SWMM in the processing tool list and select '<u>[[QGIS_SWMM_Junctions_Convert_HX_Nodes_to_Storage |Junctions - Convert HX nodes to storage]]</u>'. This opens the dialog shown below:
:* Input Junction layers: Select the '''Nodes--Junctions''' layer from the swmm GeoPackage (e.g. '''1D2D_Urban_swmm_001 >> Nodes--Junctions''').
:* Input BC Connection Layers: Select the 2d_bc connections layer (e.g. '''1D2D_Urban_001.tbc >> 2d_bc_swmm_connections''').
:* Storage Shape: Pyramidal
:* Length (rectangular) / Major Axis (cylindrical/conical): This value should be set to the typical number of HX connected cells multiplied by the cell size (10 in the example dataset).
:* Width (rectangular) / Minor Axis (cylindrical/conical): This value should be set to the cell size (5 in the example dataset).
:* Inverse slope (run/rise): Inverse slope of the output storage nodes. For pyramidal storage nodes, this value should be set to 0.0 (0.0 in the example dataset).
:* Output Junctions Layer: Leave as default.
:* Output Storage Layer: Leave as default. 
<li> Click 'Run'. Once the tool has finished, click 'Close'.
<li> Two new layers, '''Output Storage Layer''' and '''Output Junctions Layer''', will appear in the QGIS Layers Panel. 
<br><br>
{{Video|name=Animation_XPtoTUFLOW_Additional_01b.mp4|width=1350}}
<br>
</ol>

To include the '''Output Storage Layer''' in the SWMM GeoPackage:
<ol>
<li> In the QGIS Layers Panel, right click on the '''Output Storage Layer''' and select 'Export >> Save Features As...'. This opens the dialog shown below:
:* Format: Prepopulated as 'GeoPackage'.
:* File name: Click '...' and navigate to the '''TUFLOW\model\swmm''' folder and select the SWMM GeoPackage (e.g. '''1D2D_Urban_swmm_001.gpkg''').
:* Layer Name: '''Nodes--Storage'''. It is important that this naming is correct, any other layer name will not be recognized by TUFLOW SWMM. 
:* CRS: Select the models' Coordinate Reference System (CRS). For the demonstration model, the CRS is 'EPSG:32760 - WGS 84 / UTM zone 60S'.
<li> Leave all other parameters as the default and ensure that '''Add saved file to map''' (at the bottom of the dialog) is ticked on. 
<li> Click 'OK'.
<li> In the QGIS Layers Panel, move the '''Nodes--Storage''' layer into the SWMM GeoPackage group.
<br><br>
{{Video|name=Animation_XPtoTUFLOW_Additional_02b.mp4|width=1350}}
<br>
</ol>

We need to remove the objects from the '''Nodes--Junctions''' layer that coincide with the new new storage nodes. This can be done manually or with the 'Vector Selection > Select within distance' processing tool. The following steps will outline the process of using the tool: 
<ol>
<li> In the QGIS Layers panel, select (left click) '''Nodes--Junctions''' and toggle on editing. 
<li> Use the 'Select Features' tool [[File: Select_features_icon.png|40px]] to select all nodes included in the '''Nodes--Junctions''' layer. When selected, this will change their color to bright yellow.
<li> In the Processing Toolbox, go to 'Vector Selection' and select 'Select within distance'. This opens the dialog shown below.
:* Select features from: '''Nodes--Junctions''' (this is prepopulated as '''Nodes--Junctions''' is the active dataset).
:* By comparing to the features from: Click the dropdown menu and select '''Nodes--Storage'''.
:* Where the features are within: '0.1 meters'
:* Modify current selection by: 'selecting within current selection'
<li> Click 'Run'. Once the tool is finished, click 'Close'.
<li> In the QGIS Layers panel, right click '''Nodes--Junctions''' and select 'Open Attribute Table'.
<li> In the attribute table, only some of the junction nodes will be selected. Select 'Delete selected features' [[File: delete_selected_features_icon.png]] to delete these nodes. Close the attribute table.
<li> Toggle editing off to save the edits to '''Nodes--Junctions'''. 
<li> Remove '''Output Storage Layer''' and '''Output Junctions Layer''' from the QGIS Layers Panel. 
<br><br>
{{Video|name=Animation_XPtoTUFLOW_Additional_03b.mp4|width=1350}}
<br>
</ol>

== Set Junction Attributes ==
This is typically the final step in the model conversion process, as the recommended attributes for a junction node vary depending on whether the node is associated with inlet usage connections, 1D/2D culvert connections, and SWMM hydrology sub-catchments. 

To update the SWMM '''Nodes--Junctions''' attributes, we will use the '<u>[[QGIS_SWMM_Junctions_Set_Attributes |Junctions - Set attributes ]]</u>' processing tool:
<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' [[File: edit_features_in_place_icon.png]] 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 the '<u>[[QGIS_SWMM_Junctions_Set_Attributes |Junctions - Set attributes ]]</u>' processing tool. This opens the dialog shown below.
:* Input Subcatchment layers: If available, select '''Hydrology--Subcatchments'''.
:* Input Inlet Usage Layers: If available, select the inlet usage layer (e.g. '''1D2D_Urban_swmm_001.tscf >> inlet_usage_001''').
:* Input BC Connection Layers: If available, select the 2d_bc connection layer (e.g. '''1D2D_Urban_001.tbc >> 2d_bc_swmm_connections''').
:* General Options: 
:::* Maximum Depth Option (Ymax): 'Set to 0.0'
:::* Nodes receiving subcatchment flows option (if connected to 2D): 'Based on options selected below'
:* Nodes connected to 2D without Inlets (through embankment culvert):
:::* Ysur: 0
:::* Area of ponding: This value should match the 2D cell area associated with 1D/2D culvert connections (100 in the example dataset).
:* Nodes connected to 2D with Inlets (underground pipe network):
:::* Maximum depth (Ymax) option: 'Use global option'
:::* Ysur: 0
:::* Area of ponding: This value should match the 2D cell area associated with the Inlet Usage connections (10 in the example model).
:* Nodes without 2D Connection (underground pipe network):
:::* Surcharge Depth: This value should be a value higher than any expected depth in the model (50 in the example model).
:::* Area of ponding: 0

<li>Select 'Modify All Features'. Once the tool has finished, click 'Close'.
<li>Turn off editing to save the edits.
<li>View the attributes within '''Nodes--Junctions''' to verify the data processing has been completed correctly. <br>
For a summary of the attributes associated with the '''Nodes--Junctions''' 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_XPtoTUFLOW_Additional_04b.mp4|width=1350}}
<br>
</ol>

== Export SWMM INP File == 
SWMM cannot directly read GeoPackage databases. As we have made changes to the SWMM GeoPackage database ('''1D2D_Urban_swmm_001.gpkg'''), we will need to reflect these changes in the SWMM INP file ('''1D2D_Urban_swmm_001.inp''') using the '<u>[[QGIS_SWMM_GeoPackage_Write_to_SWMM_inp |GeoPackage - Write to SWMM inp]]</u>' processing tool.
<ol>
<li> In the QGIS Layers panel, right click '''Nodes--Junctions''' (or any of the 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>
'''Note:''' This tool can also be activated from the Processing Toolbox. 
<li> Click 'Run'. 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 the example dataset, it will save '''1D2D_Urban_swmm_001.inp''' to the '''TUFLOW\model\swmm''' folder (replacing the INP created by the '<u>[[QGIS_SWMM_Convert_XPSWMM_Model_From_XPX|Convert - XPSWMM model from XPX]]</u>' tool).
<br><br>
{{Video|name=Animation_XPtoTUFLOW_Additional_05b.mp4|width=1350}}
<br>
</ol>


{{Tips Navigation
|uplink=[[XPSWMM_to_TUFLOW-SWMM| Back to XPSWMM to TUFLOW SWMM Conversion Page]]
}}