Tutorial M10: Difference between revisions
Content deleted Content added
No edit summary |
|||
Line 30:
== GIS Inputs ==
Create, import and view input data:
:*<u>[[Tutorial_M10_001_GIS_Inputs_QGIS | QGIS - SHP]]</u>
:*<u>[[Tutorial_M10_001_GIS_Inputs_QGIS_GPKG | QGIS - GPKG]]</u>
== Simulation Control Files ==
Line 37 ⟶ 38:
<li>Save a copy of '''M02_001.tgc''' as '''M10_001.tgc''' in the '''Module_10\TUFLOW\model''' folder. <br>
<li>Open the '''M10_001.tgc''' in a text editor.
<li>Include the following commands after the '<font color="blue"><tt>Read GIS Z Shape
<u>'''QGIS - SHP'''</u><br>
<font color="blue"><tt>Read GIS Z Shape </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>gis\2d_zsh_M10_damwall_001_L.shp </tt></font><font color="green"><tt> ! Creates dam embankment</tt></font><br>
<font color="blue"><tt>Read GIS Variable Z Shape </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>gis\2d_vzsh_M10_dambreak_001_R.shp </tt></font><font color="green"><tt> ! Creates dam break</tt></font> <br>
<u>'''QGIS - GPKG'''</u><br>
<font color="blue"><tt>Read GIS
<font color="blue"><tt>Read GIS Variable Z Shape </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>2d_vzsh_M10_dambreak_001_R </tt></font><font color="green"><tt> ! Creates dam break</tt></font>
<li>Save the TGC.
</ol>
Line 48 ⟶ 53:
<li>Open the '''M10_001.tbc''' in a text editor.
<li>Update the reference to the 2D boundaries:<br>
<u>'''QGIS - SHP'''</u><br>
<font color="blue"><tt>Read GIS BC </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>gis\2d_bc_M10_001_L.shp </tt></font></tt></font> <font color="green"><tt> ! Reads in 2D boundaries</tt></font><br>
<u>'''QGIS - GPKG'''</u><br>
<font color="blue"><tt>Read GIS BC </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>2d_bc_M10_001_L </tt></font></tt></font> <font color="green"><tt> ! Reads in 2D boundaries</tt></font><br>
<li>Include a reference to the new 2D source area boundary:<br>
<u>'''QGIS - SHP'''</u><br>
<font color="blue"><tt>Read GIS SA </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>gis\2d_sa_M10_inflow_001_R.shp </tt></font> <font color="green"><tt> ! Reads in 2D source area boundaries</tt></font> <br>
<u>'''QGIS - GPKG'''</u><br>
<font color="blue"><tt>Read GIS SA </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>2d_sa_M10_inflow_001_R </tt></font> <font color="green"><tt> ! Reads in 2D source area boundaries</tt></font> <br>
<li>Save the TBC.
</ol>
Line 57 ⟶ 69:
<ol>
<li>Save a copy of '''M02_5m_001.tcf''' as '''M10_5m_001.tcf''' in the '''Module_10\TUFLOW\runs''' folder.
<li>Open the '''M10_5m_001.tcf''' in a text editor and
<u>'''QGIS - SHP'''</u><br>
<font color="blue"><tt>Geometry Control File </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>..\model\M10_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\M10_001.tbc </tt></font> <font color="green"><tt> ! Reference the TUFLOW Boundary Conditions Control File</tt></font> <br>
<u>'''QGIS - GPKG'''</u><br>
<font color="blue"><tt>Spatial Database </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt> ..\model\gis\M10_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\M10_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\M10_001.tbc </tt></font> <font color="green"><tt> ! Reference the TUFLOW Boundary Conditions Control File</tt></font> <br>
<li>An Initial Water Level command is required. Include the following command after the 'Model Inputs' section: <br>
<u>'''QGIS - SHP'''</u><br>
<font color="green"><tt>! INITIAL WATER LEVEL</tt></font><br>
<font color="blue"><tt>Read GIS IWL </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>..\model\gis\2d_iwl_M10_001_R.shp </tt></font> <font color="green"><tt> ! Reads in initial water level</tt></font> <br>
<u>'''QGIS - GPKG'''</u><br>
<font color="green"><tt>! INITIAL WATER LEVEL</tt></font><br>
<font color="
<li>Add bathymetry (ZH) as additional Map Output Data Type:<br>
<font color="blue"><tt>Map Output Data Types </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt> h V d dt ZH </tt></font> <font color="green"><tt> ! Outputs water levels, velocities, depths, minimum timestep, bathymetry</tt></font> <br>
Line 85 ⟶ 105:
== Check Files ==
While the model is running, review the added features are specified correctly:
:*<u>[[Tutorial_M10_001_Check_Files_QGIS | QGIS - SHP]]</u>
:*<u>[[Tutorial_M10_001_Check_Files_QGIS_GPKG | QGIS - GPKG]]</u>
== Results==
Line 98 ⟶ 119:
== GIS Inputs ==
Create, import and view input data:
:*<u>[[Tutorial_M10_002_GIS_Inputs_QGIS | QGIS - SHP]]</u>
:*<u>[[Tutorial_M10_002_GIS_Inputs_QGIS_GPKG | QGIS - GPKG]]</u>
== Simulation Control Files ==
Line 106 ⟶ 128:
<li>Open the '''M10_002.tgc''' in a text editor.
<li>Update the reference to the Variable Z Shape:<br>
<u>'''QGIS - SHP'''</u><br>
▲<font color="blue"><tt>Read GIS Variable Z Shape </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>gis\2d_vzsh_M10_dambreak_002_R.shp | gis\2d_vzsh_M10_dambreak_002_P.shp </tt></font><font color="green"><tt> ! Creates dam break</tt></font>
<font color="blue"><tt>Read GIS Variable Z Shape </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>gis\2d_vzsh_M10_dambreak_002_R.shp | gis\2d_vzsh_M10_dambreak_002_P.shp </tt></font><font color="green"><tt> ! Creates dam break</tt></font> <br>
<u>'''QGIS - GPKG'''</u><br>
<font color="blue"><tt>Read GIS Variable Z Shape </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>2d_vzsh_M10_dambreak_002_R | 2d_vzsh_M10_dambreak_002_P </tt></font><font color="green"><tt> ! Creates dam break</tt></font> <br>
<li>Save the TGC.
</ol>
Line 113 ⟶ 138:
<ol>
<li>Save a copy of '''M10_5m_001.tcf''' as '''M10_5m_002.tcf''' in the '''Module_10\TUFLOW\runs''' folder.
<li>Open the '''M10_5m_002.tcf''' in a text editor and
<u>'''QGIS - SHP'''</u><br>
<font color="blue"><tt>Geometry Control File </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>..\model\M10_002.tgc </tt></font> <font color="green"><tt> ! Reference the TUFLOW Geometry Control File</tt></font> <br>
<u>'''QGIS - GPKG'''</u><br>
<font color="blue"><tt>Spatial Database </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt> ..\model\gis\M10_002.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\M10_002.tgc </tt></font> <font color="green"><tt> ! Reference the TUFLOW Geometry Control File</tt></font> <br>
<li>Save the TCF.
Line 134 ⟶ 163:
== Check Files ==
While the model is running, review the added features are specified correctly:
:*<u>[[Tutorial_M10_002_Check_Files_QGIS | QGIS - SHP]]</u>
:*<u>[[Tutorial_M10_002_Check_Files_QGIS_GPKG | QGIS - GPKG]]</u>
== Results==
Line 158 ⟶ 188:
== GIS Inputs ==
Create, import and view input data:
:*<u>[[Tutorial_M10_003_GIS_Inputs_QGIS | QGIS - SHP]]</u>
:*<u>[[Tutorial_M10_003_GIS_Inputs_QGIS_GPKG | QGIS - GPKG]]</u>
== Simulation Control Files ==
Line 182 ⟶ 213:
<li>Create a new text file '''M10_003.ecf''' in the '''Module_10\TUFLOW\model''' folder.
<li>Add the following command lines: <br>
<u>'''QGIS - SHP'''</u><br>
<font color="green"><tt>! 1D TIME CONTROL</tt></font><br>
<font color="blue"><tt>Timestep</tt></font> <font color="red"><tt> == </tt></font> <font color="black"><tt>0.5 </tt></font> <font color="green"><tt>! Specifies a 1D computational timestep as 0.5 seconds</tt></font><br>
Line 193 ⟶ 225:
<font color="green"><tt>! 1D DAMBREAK</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_M10_dambreak_003_L.shp</tt></font> <font color="green"><tt>! Defines 1D dambreak</tt></font><br>
<u>'''QGIS - GPKG'''</u><br>
<font color="green"><tt>! 1D TIME CONTROL</tt></font><br>
<font color="blue"><tt>Timestep</tt></font> <font color="red"><tt> == </tt></font> <font color="black"><tt>0.5 </tt></font> <font color="green"><tt>! Specifies a 1D computational timestep as 0.5 seconds</tt></font><br>
<font color="green"><tt>! MODEL INPUTS</tt></font><br>
<font color="blue"><tt>Read Operating Controls File </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt> ..\model\M10_003.toc</tt></font> <font color="green"><tt>! Reference the TUFLOW Operations Control File</tt></font><br>
<font color="green"><tt>! 1D PIPING FAILURE</tt></font><br>
<font color="blue"><tt>Read GIS Network </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>1d_nwk_M10_piping_003_L</tt></font> <font color="green"><tt>! Defines 1D piping failure</tt></font><br>
<font color="green"><tt>! 1D DAMBREAK</tt></font><br>
<font color="blue"><tt>Read GIS Network </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>1d_nwk_M10_dambreak_003_L</tt></font> <font color="green"><tt>! Defines 1D dambreak</tt></font><br>
<li>Save the ECF. <br>
Line 202 ⟶ 247:
<li>Open the '''M10_003.tgc''' in a text editor.
<li>Comment out or delete the reference to the Variable Z Shape, the dam failure is controlled within the ECF and TOC files:<br>
<u>'''QGIS - SHP'''</u><br>
<font color="green"><tt>! Read GIS Variable Z Shape == gis\2d_vzsh_M10_dambreak_001_R.shp </tt></font> <br>
<u>'''QGIS - GPKG'''</u><br>
<font color="green"><tt>! Read GIS Variable Z Shape ==
<li>Save the TGC.
</ol>
Line 211 ⟶ 259:
<li>Open the '''M10_003.tbc''' in a text editor.
<li>Include a reference to the new 1D/2D boundary:<br>
<u>'''QGIS - SHP'''</u><br>
<font color="green"><tt> ! INTERNAL 1D/2D BOUNDARIES </tt></font><br>
<font color="blue"><tt>Read GIS BC </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>gis\2d_bc_M10_piping_dambreak_003_L.shp </tt></font> <font color="green"><tt> ! Links the 1D piping and dambreak to the 2D domain</tt></font> <br>
<u>'''QGIS - GPKG'''</u><br>
<font color="green"><tt> ! INTERNAL 1D/2D BOUNDARIES </tt></font><br>
<font color="blue"><tt>Read GIS BC </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>2d_bc_M10_piping_dambreak_003_L </tt></font> <font color="green"><tt> ! Links the 1D piping and dambreak to the 2D domain</tt></font> <br>
<li>Save the TBC.
</ol>
Line 222 ⟶ 274:
<li>Include a reference of the ECF in the 'Model Inputs' section: <br>
<font color="blue"><tt>ESTRY Control File </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>..\model\M10_003.ecf </tt></font> <font color="green"><tt> ! Reference the ESTRY (1D) Control File File</tt></font> <br>
<li>
<u>'''QGIS - SHP'''</u><br>
<font color="blue"><tt>Geometry Control File </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>..\model\M10_003.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\M10_003.tbc </tt></font> <font color="green"><tt> ! Reference the TUFLOW Boundary Conditions Control File</tt></font> <br>
<u>'''QGIS - GPKG'''</u><br>
<font color="blue"><tt>Spatial Database </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>..\model\gis\M10_003.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\M10_003.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\M10_003.tbc </tt></font> <font color="green"><tt> ! Reference the TUFLOW Boundary Conditions Control File</tt></font> <br>
<li>Save the TCF.
Line 241 ⟶ 297:
== Troubleshooting ==
See tips on common mistakes and troubleshooting steps if the model doesn't run:
:*<u>[[Tutorial_Troubleshooting_QGIS | QGIS ]]</u>
== Check Files ==
While the model is running, review the added features are specified correctly:
:*<u>[[Tutorial_M10_003_Check_Files_QGIS | QGIS - SHP]]</u>
:*<u>[[Tutorial_M10_003_Check_Files_QGIS_GPKG | QGIS - GPKG]]</u>
Review the 1D output file:
<ol>
Line 275 ⟶ 332:
== GIS Inputs ==
Create, import and view input data:
:*<u>[[Tutorial_M10_004_GIS_Inputs_QGIS | QGIS - SHP]]</u>
:*<u>[[Tutorial_M10_004_GIS_Inputs_QGIS_GPKG | QGIS - GPKG]]</u>
== Simulation Control Files ==
Line 283 ⟶ 341:
<li>Open the '''M10_004.tgc''' in a text editor.
<li>Comment out or delete the reference to the Variable Z Shape:<br>
<u>'''QGIS - SHP'''</u><br>
▲<font color="green"><tt>! Read GIS Variable Z Shape == gis\2d_vzsh_M10_dambreak_001_R.shp </tt></font>
<font color="green"><tt>! Read GIS Variable Z Shape == gis\2d_vzsh_M10_dambreak_001_R.shp </tt></font> <br>
<u>'''QGIS - GPKG'''</u><br>
<font color="green"><tt>! Read GIS Variable Z Shape == 2d_vzsh_M10_dambreak_001_R </tt></font> <br>
<li>Save the TGC.
</ol>
Line 292 ⟶ 353:
<li>Open the '''M10_004.tbc''' in a text editor.
<li>Comment out or delete the reference to the upstream 2d_sa inflow and internal 2d_sa inflows representing the four flows on the internal catchments, the module is simulating flow from the dam break only:<br>
<u>'''QGIS – SHP'''</u><br>
<font color="green"><tt>! Read GIS SA == gis\2d_sa_M01_001_R.shp </tt></font><br>
<font color="green"><tt>! Read GIS SA == gis\2d_sa_M10_inflow_001_R.shp </tt></font><br>
<u>'''QGIS – GPKG'''</u><br>
<font color="green"><tt>! Read GIS SA == 2d_sa_M01_001_R </tt></font><br>
<font color="green"><tt>! Read GIS SA == 2d_sa_M10_inflow_001_R </tt></font><br>
<li>Include a reference to the new 2D source area boundary representing the flow from the dam break:<br>
<u>'''QGIS – SHP'''</u><br>
<font color="blue"><tt>Read GIS SA </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>gis\2d_sa_M10_dambreak_004_R.shp </tt></font> <font color="green"><tt> ! Reads in 2D source area boundaries</tt></font> <br>
<u>'''QGIS – GPKG'''</u><br>
<font color="blue"><tt>Read GIS SA </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>2d_sa_M10_dambreak_004_R </tt></font> <font color="green"><tt> ! Reads in 2D source area boundaries</tt></font> <br>
<li>Save the TBC.
</ol>
Line 317 ⟶ 385:
<ol>
<li>Save a copy of '''M10_5m_001.tcf''' as '''M10_5m_004.tcf''' in the '''Module_10\TUFLOW\runs''' folder.
<li>Open the '''M10_5m_004.tcf''' in a text editor
<u>'''QGIS – SHP'''</u><br>
<font color="blue"><tt>Geometry Control File </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>..\model\M10_004.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\M10_004.tbc </tt></font> <font color="green"><tt> ! Reference the TUFLOW Boundary Conditions 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_M10_004.csv </tt></font> <font color="green"><tt> ! Reference the Boundary Conditions Database</tt></font> <br>
<u>'''QGIS – GPKG'''</u><br>
<font color="blue"><tt>Spatial Database </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>..\model\gis\M10_004.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\M10_004.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\M10_004.tbc </tt></font> <font color="green"><tt> ! Reference the TUFLOW Boundary Conditions 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_M10_004.csv </tt></font> <font color="green"><tt> ! Reference the Boundary Conditions Database</tt></font> <br>
<li>A Timestep Maximum command is required in some dam break models to ensure the timestep does not get too large during periods where cells are dry (causing the model to become unstable). Include the command in the 'Time Control' section: <br>
<font color="blue"><tt>Timestep Maximum </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>2</tt></font> <font color="green"><tt> ! Specifies a maximum timestep of 2 seconds</tt></font> <br>
<li>Comment out or delete the reference to the Initial Water Level:<br>
<u>'''QGIS – SHP'''</u><br>
▲<font color="green"><tt>! Read GIS IWL == ..\model\gis\2d_iwl_M10_001_R.shp ! Reads in initial water level </tt></font>
<font color="green"><tt>! Read GIS IWL == ..\model\gis\2d_iwl_M10_001_R.shp ! Reads in initial water level </tt></font> <br>
<u>'''QGIS – GPKG'''</u><br>
<font color="green"><tt>! Read GIS IWL == 2d_iwl_M10_001_R ! Reads in initial water level </tt></font>
<li>Save the TCF.
</ol>
Line 347 ⟶ 421:
== Check Files ==
While the model is running, review the added features are specified correctly:
:*<u>[[Tutorial_M10_004_Check_Files_QGIS | QGIS - SHP]]</u>
:*<u>[[Tutorial_M10_004_Check_Files_QGIS_GPKG | QGIS - GPKG]]</u>
== Results==
| |||