Difference between revisions of "QGIS SWMM Convert XPSWMM GIS Inlet Layers to SWMM"

From Tuflow
Jump to navigation Jump to search
(Created page with "== Introduction == <br> == Usage == This tool, '''Convert - XPSWMM GIS inlet layers to SWMM''', can be found in the QGIS processing toolbox panel under 'TUFLOW > SWMM'. To o...")
 
 
(27 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
== Introduction ==
 
== Introduction ==
 +
This tool converts an XPSWMM GIS layer with 2D connectivity information for use with TUFLOW-SWMM. The tool operates on discharges computed from the equation: '''Q = coefficient * depth<sup>exponent</sup>'''.<br>
 +
This processing tool generates a GIS layer that can be used with the '<font color="blue"><tt>Read GIS SWMM Inlet Usage</tt></font>' command to link SWMM inlets to a TUFLOW 2D model.<br>
  
−
<br>
+
To export the GIS layer required from XPSWMM or the XPSWMM Viewer:
 +
<ol>
 +
<li>Right click on the nodes layer and choose 'Export to GIS'.
 +
<li>Expand the tree folders 'Hydraulics Node\HDR Node Data'.
 +
<li>Select 'Node 2D Inflow Capture Flag', 'Ground Elevation (Spill Crest)', '2D Inflow Capture Coefficient', and '2D Inflow Capture Exponent'.
 +
<li>In the 'Custom Name' column, double click 'Ground Elevation (Spill Crest)' and update the name to 'Ground Elevation'. The parentheses can cause issues with some GIS software.
 +
<li>Set the GIS filename. It is recommended to export to a MapInfo Interchange File (.mif).
 +
<li>Click 'Export'.
 +
</ol>
 +
 
 +
The inlets require a name for each combination of coefficient and exponent that must be added to the GIS layer.<br>
 +
Once the layer is set up, run the tool and select the parameters for the appropriate fields. The ground elevation should be used for the 'Inlet elevation field.' The CRS should match the TUFLOW-SWMM project.
 +
 
 +
'''Note:''' To convert an entire XPSWMM model to TUFLOW-SWMM, see <u>[[XPSWMM_to_TUFLOW-SWMM |XPSWMM to TUFLOW-SWMM]]</u>.
 +
<br><br>
  
 
== Usage ==
 
== Usage ==
−
This tool, '''Convert - XPSWMM GIS inlet layers to SWMM''', can be found in the QGIS processing toolbox panel under 'TUFLOW > SWMM'. To open the Processing Toolbox Panel, navigate to 'Processing' in the menubar and select 'Toolbox'.<br>
+
This tool, '''Convert - XPSWMM GIS inlet layers to SWMM''', can be found in the QGIS processing toolbox panel under TUFLOW >> SWMM. To open the Processing Toolbox panel, navigate to 'Processing' in the menubar and select 'Toolbox'.<br>
 
<br>
 
<br>
 
[[File:open_processing_toolbox.png]]<br>
 
[[File:open_processing_toolbox.png]]<br>
Line 11: Line 27:
 
=== Parameters ===
 
=== Parameters ===
 
<ol>
 
<ol>
−
<li>'''ESTRY Network Layers [optional]:''' Network layers to be converted and included in the SWMM inp file.  
+
<li>'''GIS layer with inlet information:''' XPSWMM GIS layer to be converted to TUFLOW-SWMM.  
−
<li>'''ESTRY Node Layers [optional]:''' Node layers to be converted and included in the SWMM inp file.  
+
<li>'''Inlet name field:''' Name of the XPSWMM GIS layer's field that contains the names of the attributes. For example, a node layer, the inlet name field could be 'NodeName'.
−
<li>'''ESTRY Pit Layers [optional]:''' Pit layers to be converted and included in the SWMM inp file.
+
<li>'''Inlet elevation field:''' Name of the XPSWMM GIS layer's field that contains the elevation data ('''GroundElevation''').
−
<li>'''ESTRY Table Link Layers [optional]:''' Table link layers to be converted and included in the SWMM inp file.  
+
<li>'''Inlet 2d capture flag (1=has 2d connection) field:''' Name of the XPSWMM GIS layer's field that determines whether the inlet is connected to the 2D domain ('''Node2DInflowCaptureFlag''').
−
<li>'''ESTRY Pit Inlet Database [optional]:''' This is required to convert the pit (inlet) curves for use with SWMM.
+
<li>'''Inlet discharge equation coefficient field:''' 'Coefficient' value from the equation above ('''2DInflowCaptureCoefficient''').  
−
<li>'''Reference cell size for inlet connections:''' The 1D/2D linking for SWMM is always based upon a width while ESTRY can specify (using a negative number) an exact number of cells to use when linking. The reference cell size is used to convert fixed number of linked cells from ESTRY to SWMM.
+
<li>'''Inlet discharge exponent field:''' 'Exponent' value from the equation above ('''2DInflowCaptureExponent''').  
−
<li>'''Network snap tolerance:''' This is the distance to search for nodes snapped to the endpoint of channels.
+
<li>'''Inlet connection width:''' The length used to assign the number of 2D cells associated with the 1D/2D connections.  
−
<li>'''Output CRS:''' The CRS used in the GeoPackage representation of the SWMM inp file.
+
<li>'''CRS:''' The CRS (Coordinate Reference System) for the TUFLOW-SWMM project. The tool will apply this CRS to the output files.
−
<li>'''Create options, and report tables:''' Whether or not the options and report tables should be generated. This should be yes for stand alone models. No can be used to generate files used for scenarios where these tables are provided in a separate file.
+
<li>'''SWMM inp file (for inlet definition and curves):''' Determines the location and filename of the output 'inlet definition and curves' data. This tool will save both a SWMM (.inp) and a GeoPackage (.gpkg) file to the specified output folder under the specified output name.
−
<li>'''Options table report step (hh:mm:ss):''' The SWMM report step to use if writing the options table.
+
<li>'''GeoPackage file for inlet usage (for inlet placement):''' Determines the location and filename of the output inlet usage data. The tool will save this data in a GeoPackage (.gpkg) file.
−
<li>'''Options table minimum surface area:''' This parameter can help stabilize a model.
 
−
<li>'''SWMM output filename:''' Determines the location and filename of the output SWMM inp file.
 
−
<li>'''SWMM inlet usage GeoPackage filename:''' Determines the location and filename of the output GeoPackage.
 
 
</ol>
 
</ol>
 
<br>
 
<br>
−
[[File:.png]]
+
[[File:Convert_XPSWMM_GIS_Inlet_Layers_to_SWMM_Dialog_a.png]]
 +
 
 +
== Example ==
 +
This video demonstrates how to convert an XPSWMM GIS inlet node layer to SWMM using the 'Convert - XPSWMM GIS inlet layers to SWMM' processing tool. In this example, the tool will produce an inlet usage GeoPackage file, an inlet curves GeoPackage file, and an inlet curves SWMM (.inp) file. <br>
 +
 
 +
When loading the XPSWMM GIS inlet layer into QGIS, you may receive a message stating that there is no transform available between the CRS of the input (.mif or .shp) file and the CRS of the QGIS workspace. Ignore this message and close the pop up. This issue will be resolved by the processing tool as it will set the CRS of the output converted files.
 
<br><br>
 
<br><br>
−
 
+
{{Video|name=Animation_Convert_XPSWMM_GIS_Inlet_Layers_to_SWMM_01a.mp4|width=1236}}
−
=== Example ===
 
−
{{Video|name=|width=1235}}
 
−
<br>
 
  
  

Latest revision as of 15:20, 1 March 2024

Introduction

This tool converts an XPSWMM GIS layer with 2D connectivity information for use with TUFLOW-SWMM. The tool operates on discharges computed from the equation: Q = coefficient * depthexponent.
This processing tool generates a GIS layer that can be used with the 'Read GIS SWMM Inlet Usage' command to link SWMM inlets to a TUFLOW 2D model.

To export the GIS layer required from XPSWMM or the XPSWMM Viewer:

  1. Right click on the nodes layer and choose 'Export to GIS'.
  2. Expand the tree folders 'Hydraulics Node\HDR Node Data'.
  3. Select 'Node 2D Inflow Capture Flag', 'Ground Elevation (Spill Crest)', '2D Inflow Capture Coefficient', and '2D Inflow Capture Exponent'.
  4. In the 'Custom Name' column, double click 'Ground Elevation (Spill Crest)' and update the name to 'Ground Elevation'. The parentheses can cause issues with some GIS software.
  5. Set the GIS filename. It is recommended to export to a MapInfo Interchange File (.mif).
  6. Click 'Export'.

The inlets require a name for each combination of coefficient and exponent that must be added to the GIS layer.
Once the layer is set up, run the tool and select the parameters for the appropriate fields. The ground elevation should be used for the 'Inlet elevation field.' The CRS should match the TUFLOW-SWMM project.

Note: To convert an entire XPSWMM model to TUFLOW-SWMM, see XPSWMM to TUFLOW-SWMM.

Usage

This tool, Convert - XPSWMM GIS inlet layers to SWMM, can be found in the QGIS processing toolbox panel under TUFLOW >> SWMM. To open the Processing Toolbox panel, navigate to 'Processing' in the menubar and select 'Toolbox'.

Open processing toolbox.png

Parameters

  1. GIS layer with inlet information: XPSWMM GIS layer to be converted to TUFLOW-SWMM.
  2. Inlet name field: Name of the XPSWMM GIS layer's field that contains the names of the attributes. For example, a node layer, the inlet name field could be 'NodeName'.
  3. Inlet elevation field: Name of the XPSWMM GIS layer's field that contains the elevation data (GroundElevation).
  4. Inlet 2d capture flag (1=has 2d connection) field: Name of the XPSWMM GIS layer's field that determines whether the inlet is connected to the 2D domain (Node2DInflowCaptureFlag).
  5. Inlet discharge equation coefficient field: 'Coefficient' value from the equation above (2DInflowCaptureCoefficient).
  6. Inlet discharge exponent field: 'Exponent' value from the equation above (2DInflowCaptureExponent).
  7. Inlet connection width: The length used to assign the number of 2D cells associated with the 1D/2D connections.
  8. CRS: The CRS (Coordinate Reference System) for the TUFLOW-SWMM project. The tool will apply this CRS to the output files.
  9. SWMM inp file (for inlet definition and curves): Determines the location and filename of the output 'inlet definition and curves' data. This tool will save both a SWMM (.inp) and a GeoPackage (.gpkg) file to the specified output folder under the specified output name.
  10. GeoPackage file for inlet usage (for inlet placement): Determines the location and filename of the output inlet usage data. The tool will save this data in a GeoPackage (.gpkg) file.


Convert XPSWMM GIS Inlet Layers to SWMM Dialog a.png

Example

This video demonstrates how to convert an XPSWMM GIS inlet node layer to SWMM using the 'Convert - XPSWMM GIS inlet layers to SWMM' processing tool. In this example, the tool will produce an inlet usage GeoPackage file, an inlet curves GeoPackage file, and an inlet curves SWMM (.inp) file.

When loading the XPSWMM GIS inlet layer into QGIS, you may receive a message stating that there is no transform available between the CRS of the input (.mif or .shp) file and the CRS of the QGIS workspace. Ignore this message and close the pop up. This issue will be resolved by the processing tool as it will set the CRS of the output converted files.


Up
Go-up.png Back to TUFLOW QGIS Plugin Main Page
Retrieved from "https://wiki.tuflow.com/w/index.php?title=QGIS_SWMM_Convert_XPSWMM_GIS_Inlet_Layers_to_SWMM&oldid=38873"