View source for EPA SWMM to TUFLOW

= Introduction =
TUFLOW has supported 1D/2D dynamic coupling since its initial 2D solver development in 1989. Traditionally, 1D linking and associated modeling has been applied using the TUFLOW 1D (ESTRY) solver. New in the 2023-03-AD Release, TUFLOW's 1D linking and solver options have been expanded to support the EPA Storm Water Management Model (referred to herein as SWMM). 

As a result of the 1D SWMM inclusion within TUFLOW, modellers working with SWMM files now have a variety of options available:
<ol>
<li> Use SWMM, coupled directly to TUFLOW.
<li> Conversion of SWMM 1D geometry to a TUFLOW compatible format for use by the TUFLOW 1D (ESTRY) solver.
</ol>

= SWMM inclusion in TUFLOW (2023-03-AD or newer)=
If you wish to model SWMM coupled dynamically to TUFLOW 2D, please refer to the <u>[[TUFLOW_SWMM_Tutorial_Introduction | TUFLOW SWMM Tutorials]]</u> and <u>[https://docs.tuflow.com/classic-hpc/release/2023-03-AE/SWMM-TUFLOW-1.html Chapter 4 of the 2023-03 Release Notes]</u>. Step by step model build examples are provided for the following topics:
* <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.

=Conversion of SWMM to TUFLOW 1D (ESTRY)=
As an alternative to direct coupling of SWMM with TUFLOW, a free utility tool is also available to assist with the conversion of SWMM inp files into a TUFLOW compatible format for simulation using TUFLOW 1D (ESTRY). The SWMM_to_TUFLOW utility is available for download from the <u>[https://www.tuflow.com/Tuflow%20Utilities.aspx TUFLOW website]</u>.<br>

The SWMM_to_TUFLOW utility automates the conversion of SWMM 1D model geometry for culverts, pipes and open channels into a TUFLOW 1D (ESTRY) compatible GIS and tabular format.<br>

'' Note: TUFLOW 1D does not include an inbuilt hydrology engine. As such, SWMM hydrology and boundary condition information is not processed by this utility. If SWMM hydrology or boundary condition information is important for your model build, please use direct coupling of SWMM with TUFLOW.''

== SWMM_to_TUFLOW Utility Execution ==
The following steps outline how to use the SWMM to TUFLOW utility.
<ol>
<li> Save the swmm_to_gis_w64.exe to the same folder as the SWMM file (.inp).
<li> The utility requires GIS projection information to correctly translate the spatial information contained within the SWMM file (.inp) to either MapInfo *mif/*mid or ESRI/QGIS *.shp format. This is done by including a Projection file in the working directory. Create one of the following files, saved to the same folder location as the SWMM file (.inp).
<ol>
* *mif format input requirement:   Projection.mif
* *shp format input requirement:   Projection.prj
</ol>
The following error message will be produced if projection information is not provided:
 ERROR - A Header.prj or Projection.prj file does not exist in folder
<li> Create a batch file (*.bat) in the same folder as the SWMM file (.inp). Depending on the GIS output format you desire, use either of the following syntax in the batch file:
<ol>
* *mif/*mid format output desired: swmm_to_GIS.exe -mif SWMM.inp
* *shp format output desired: swmm_to_GIS.exe -shp SWMM.inp
</ol>
<li> Double left mouse click the created batch file from Windows Explorer to execute the utility.
<li> If the utility does not execute cleanly for the entire dataset a Warning or Check message will be written to the console window and the processing will be paused. Press "enter" to continue, and when the utility is complete, open the result files to manually inspect and address the feature that triggered the warning / check pause. 
</ol>

== Utility Output ==
Depending on the features included in the SWMM file (.inp) the utility may create the following TUFLOW 1D input files:

{| align="center" class="wikitable"

! style="background-color:#005581; font-weight:bold; color:white;"| Utility Output
! style="background-color:#005581; font-weight:bold; color:white;"| MapInfo (mif/mid)
! style="background-color:#005581; font-weight:bold; color:white;"| ESRI / QGIS (shp)
|-
|1D Invert Information|| 1d_nwk_...junctions.mif / mid || 1d_nwk_...junctions_P.shp
|-
|1D Geometry Details (link type and size)|| 1d_nwk_...inp.mif / mid || 1d_nwk_...inp_L.shp
|-
| 1D Open Channel Cross-section Locations || XS Folder <br> 1d_xs_...transects.mif || XS Folder <br> 1d_xs_...transects_L.shp
|-
| 1D Irregular Culvert Cross-section Locations || XS Folder <br> 1d_hw_...inp.shp || XS Folder <br> 1d_hw_...inp_L.shp
|-
| 1D Open Channel Cross-section Data 
| colspan="2" | .csv files contained within the XS Folder
|-
| 1D Irregular Culvert Cross-section Data 
| colspan="2" | .csv files contained within the XS Folder
|}

Example TUFLOW 1D Commands associated with the output files are:

<font color="blue"><tt>Read GIS Network </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>gis\1d_nwk_Example.inp_junctions_P.shp </tt></font> <font color="green"><tt>  ! 1D invert information</tt></font><br>
<font color="blue"><tt>Read GIS Network </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>gis\1d_nwk_Example.inp_L.shp </tt></font> <font color="green"><tt>  ! 1D geometry details (link type and size)</tt></font><br>
<font color="blue"><tt>Read GIS Table Links </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt> xs\1d_xs_Example.inp_transects_L.shp </tt></font> <font color="green"><tt>  ! 1D cross-section location and csv data cross references </tt></font><br>
<font color="blue"><tt>Read GIS Table Links </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt> xs\1d_hw_Example.inp_transects_L.shp </tt></font> <font color="green"><tt>  ! 1D irregular culvert cross-section location and csv data cross references </tt></font><br>

[[File:SWMM_to_TUFLOW_Example.png | 1000px]]

== Limitations ==
* SWMM open channel geometry may include both the channel and adjacent floodplain within the cross-section information. If the intention is to link the 1D to TUFLOW 2D, with 2D representing the floodplain, manual update of the cross-section information to limit the extent of the open channel section will be needed. The cross-section extent is displayed spatially in the GIS cross-section output. Edit the associated csv out file to modify the cross-section properties used in the modelling.   
* SWMM includes a larger range of inbuilt culvert geometry types than TUFLOW 1D. TUFLOW 1D primarily supports Circular (C) and Rectangular (R) as hardcoded culvert / pipe geometries. All others SWMM culvert types are converted to TUFLOW 1D Irregular (I) culverts, with an associated Height vs Width 1D cross-section to define the culvert geometry.
* SWMM includes a variety of inbuilt pipe network inlet geometries. This information is not processed by the utility. It is the modellers responsibility to manually create depth / flow relationship information for the pit inlet database if using TUFLOW 1D. If you wish to use the inbuilt SWMM pipe network inlet geometries directly, please use direct coupling of SWMM with TUFLOW. Refer to <u>[[TUFLOW_SWMM_Tutorial_Introduction | TUFLOW SWMM Tutorial Module 2 and 3]]</u>
* TUFLOW 1D does not include an inbuilt hydrology engine. As such, SWMM hydrology and boundary condition information is not processed by this utility. If SWMM hydrology or boundary condition information is important for your model build, please use direct coupling of SWMM with TUFLOW.''