Tutorial M03: Difference between revisions
| (6 intermediate revisions by 3 users not shown) | |||
| Line 14: | Line 14: | ||
= GIS Inputs = |
= GIS Inputs = |
||
Create, import and view input data: |
Create, import and view input data: |
||
:*<u>[[Tutorial_M03_GIS_Inputs_QGIS | QGIS]]</u> |
:*<u>[[Tutorial_M03_GIS_Inputs_QGIS | QGIS - SHP]]</u> |
||
:*<u>[[Tutorial_M03_GIS_Inputs_QGIS_GPKG | QGIS - GPKG]]</u> |
|||
<br> |
<br> |
||
| Line 22: | Line 23: | ||
<li>Save a copy of the '''M01_001.tbc''' as '''M03_001.tbc''' in the '''Module_03\TUFLOW\model''' folder. |
<li>Save a copy of the '''M01_001.tbc''' as '''M03_001.tbc''' in the '''Module_03\TUFLOW\model''' folder. |
||
<li>Open the '''M03_001.tbc''' in a text editor and add the additional lines: <br> |
<li>Open the '''M03_001.tbc''' in a text editor and add the additional lines: <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_M03_culverts_001_P.shp</tt></font> <font color="green"><tt> ! Links the 1D culverts to the 2D domain</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_M03_culverts_001_P.shp</tt></font> <font color="green"><tt> ! Links the 1D culverts to the 2D domain</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_M03_culverts_001_R.shp | gis\2d_bc_M03_culverts_001_L.shp</tt></font> <font color="green"><tt> ! Links the 1D culverts to the 2D domain</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_M03_culverts_001_R.shp | gis\2d_bc_M03_culverts_001_L.shp</tt></font> <font color="green"><tt> ! Links the 1D culverts to the 2D domain</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_M03_culverts_001_P</tt></font> <font color="green"><tt> ! Links the 1D culverts to the 2D domain</tt></font> <br> |
|||
<font color="blue"><tt>Read GIS BC </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>2d_bc_M03_culverts_001_R | 2d_bc_M03_culverts_001_L</tt></font> <font color="green"><tt> ! Links the 1D culverts to the 2D domain</tt></font> <br> |
|||
<li>Save the TBC. |
<li>Save the TBC. |
||
</ol> |
</ol> |
||
| Line 33: | Line 38: | ||
<li>Create a new text file '''M03_001.ecf''' and save it in the '''Module_03\TUFLOW\model''' folder. |
<li>Create a new text file '''M03_001.ecf''' and save it in the '''Module_03\TUFLOW\model''' folder. |
||
<li>Add the following command lines: <br> |
<li>Add the following command lines: <br> |
||
<u>'''QGIS - SHP'''</u><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="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="blue"><tt>Read GIS Network </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt> |
<font color="blue"><tt>Read GIS Network </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>gis\1d_nwk_M03_culverts_001_L.shp</tt></font> <font color="green"><tt> ! Defines culverts</tt></font> |
||
<br> |
|||
<u>'''QGIS - GPKG'''</u><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="blue"><tt>Read GIS Network </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>1d_nwk_M03_culverts_001_L</tt></font> <font color="green"><tt> ! Defines culverts</tt></font> |
|||
<li>Save the ECF. <br> |
|||
</ol> |
</ol> |
||
| Line 42: | Line 53: | ||
<li>Open the '''M03_5m_001.tcf''' in a text editor and add the following line in the 'Model Inputs' section: <br> |
<li>Open the '''M03_5m_001.tcf''' in a text editor and add the following line 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\M03_001.ecf </tt></font> <font color="green"><tt> ! Reference the ESTRY (1D) Control File</tt></font> <br> |
<font color="blue"><tt>ESTRY Control File </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt> ..\model\M03_001.ecf </tt></font> <font color="green"><tt> ! Reference the ESTRY (1D) Control File</tt></font> <br> |
||
<li> |
<li>Make the following reference updates: <br> |
||
<u>'''QGIS - SHP'''</u><br> |
|||
<font color="blue"><tt>BC Control File </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>..\model\M03_001.tbc</tt></font> <font color="green"><tt> ! Reference the TUFLOW Boundary Conditions Control File</tt></font> <br> |
|||
<li><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\M03_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\M03_001.tbc</tt></font> <font color="green"><tt> ! Reference the TUFLOW Boundary Conditions 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\M03_001.tbc</tt></font> <font color="green"><tt> ! Reference the TUFLOW Boundary Conditions Control File</tt></font> <br> |
||
<li>Save the TCF. |
<li>Save the TCF. |
||
| Line 52: | Line 67: | ||
<li>Save a copy of '''_run_M02_HPC.bat''' as '''_run_M03_HPC.bat''' in the '''Module_03\TUFLOW\runs''' folder. |
<li>Save a copy of '''_run_M02_HPC.bat''' as '''_run_M03_HPC.bat''' in the '''Module_03\TUFLOW\runs''' folder. |
||
<li>Update the batch file to reference the '''M03_5m_001.tcf''' :<br> |
<li>Update the batch file to reference the '''M03_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\ |
<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\2025.1.0\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="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>M03_5m_001.tcf </tt></font> <br> |
<font color="orange"><tt>%run% </tt></font> <font color="black"><tt>M03_5m_001.tcf </tt></font> <br> |
||
| Line 67: | Line 82: | ||
= Check Files = |
= Check Files = |
||
While the model is running, review the added features are specified correctly: |
While the model is running, review the added features are specified correctly: |
||
:*<u>[[Tutorial_M03_Check_Files_QGIS | QGIS]]</u> |
:*<u>[[Tutorial_M03_Check_Files_QGIS | QGIS - SHP]]</u> |
||
:*<u>[[Tutorial_M03_Check_Files_QGIS_GPKG | QGIS - GPKG]]</u> |
|||
<br> |
<br> |
||
| Line 79: | Line 95: | ||
:*Check files were used to review the application of the boundary links. |
:*Check files were used to review the application of the boundary links. |
||
:*Results through the 1D network structures were assessed to validate the 1D stability. |
:*Results through the 1D network structures were assessed to validate the 1D stability. |
||
:*For further training opportunities see <u>[https://tuflow.com/training/training-course-catalogue/ TUFLOW Training Catalogue]</u> and/or contact <u>[mailto:training@tuflow.com training@tuflow.com]</u>. <br> |
|||
:*Alternatively, see the <u>[[TUFLOW_Example_Models#Example_Model_Catalogue | TUFLOW Example Models]]</u> to explore the full list of TUFLOW features. |
|||
<br> |
<br> |
||
{{Tips Navigation |
{{Tips Navigation |
||
Latest revision as of 16:16, 6 October 2025
Introduction
In this module, three culverts are added to better represent flow through embankments that fall on main flow paths.
The GIS layers are:
- ECF layers:
- 1d_nwk: A layer used to define culverts in 1D.
- TBC layers:
- 2d_bc: A layer defining the locations of 1D/2D links.
Module 3 builds from the model created in Module 2. The completed Module 2 model is provided in the Module_03\TUFLOW folder.
GIS Inputs
Create, import and view input data:
Simulation Control Files
TUFLOW Boundary Control File (TBC)
- Save a copy of the M01_001.tbc as M03_001.tbc in the Module_03\TUFLOW\model folder.
- Open the M03_001.tbc in a text editor and add the additional lines:
QGIS - SHP
Read GIS BC == gis\2d_bc_M03_culverts_001_P.shp ! Links the 1D culverts to the 2D domain
Read GIS BC == gis\2d_bc_M03_culverts_001_R.shp | gis\2d_bc_M03_culverts_001_L.shp ! Links the 1D culverts to the 2D domain
QGIS - GPKG
Read GIS BC == 2d_bc_M03_culverts_001_P ! Links the 1D culverts to the 2D domain
Read GIS BC == 2d_bc_M03_culverts_001_R | 2d_bc_M03_culverts_001_L ! Links the 1D culverts to the 2D domain
- Save the TBC.
The region and line 2d_bc files are read by the same command separated by a vertical line similar to 2d_zsh files that require more than one vector type. This is important as the SX region file is connected by a CN line within the 2d_bc line layer. By reading both of these layers on the same command line enables them to be linked.
ESTRY Control File (ECF)
A new control file, the ESTRY Control File (ECF), is introduced. ESTRY is TUFLOW’s 1D hydraulic solver and includes all of the 1D files and commands.
- Create a new text file M03_001.ecf and save it in the Module_03\TUFLOW\model folder.
- Add the following command lines:
QGIS - SHP
Timestep == 0.5 ! Specifies a 1D computational timestep as 0.5 seconds
Read GIS Network == gis\1d_nwk_M03_culverts_001_L.shp ! Defines culverts
QGIS - GPKG
Timestep == 0.5 ! Specifies a 1D computational timestep as 0.5 seconds
Read GIS Network == 1d_nwk_M03_culverts_001_L ! Defines culverts - Save the ECF.
TUFLOW Control File (TCF)
- Save a copy of the M02_5m_001.tcf as M03_5m_001.tcf in the Module_03\TUFLOW\runs folder.
- Open the M03_5m_001.tcf in a text editor and add the following line in the 'Model Inputs' section:
ESTRY Control File == ..\model\M03_001.ecf ! Reference the ESTRY (1D) Control File
- Make the following reference updates:
QGIS - SHP
BC Control File == ..\model\M03_001.tbc ! Reference the TUFLOW Boundary Conditions Control File
- QGIS - GPKG
Spatial Database == ..\model\gis\M03_001.gpkg ! Specify the location of the GeoPackage Spatial Database
BC Control File == ..\model\M03_001.tbc ! Reference the TUFLOW Boundary Conditions Control File
- Save the TCF.
Running the Simulation
- Save a copy of _run_M02_HPC.bat as _run_M03_HPC.bat in the Module_03\TUFLOW\runs folder.
- Update the batch file to reference the M03_5m_001.tcf :
set exe="..\..\..\exe\2025.1.0\TUFLOW_iSP_w64.exe"
set run=start "TUFLOW" /wait %exe% -b
%run% M03_5m_001.tcf
- Double click the batch file in file explorer to run the simulation.
Troubleshooting
See tips on common mistakes and troubleshooting steps if the model doesn't run:
Check Files
While the model is running, review the added features are specified correctly:
Results
When the model is finished, review the results:
Conclusion
- Culverts were added to the model. Three different SX boundary applications were used to transfer flow through road embankments.
- Check files were used to review the application of the boundary links.
- Results through the 1D network structures were assessed to validate the 1D stability.
- For further training opportunities see TUFLOW Training Catalogue and/or contact training@tuflow.com.
- Alternatively, see the TUFLOW Example Models to explore the full list of TUFLOW features.
- Culverts were added to the model. Three different SX boundary applications were used to transfer flow through road embankments.
| Up |
|---|