Tuflow

TUFLOW CATCH Tutorial M01: Difference between revisions

Browse history interactively
← Older edit
Content deleted Content added
VisualWikitext
 
(20 intermediate revisions by the same user not shown)
Line 2:
In this module, a TUFLOW CATCH pollutant export model is developed. <br>
 
TUFLOW CATCH Tutorial Module 101 is built from the model created in <u>[[Tutorial_M06#Part_3_-_Rainfall_Control_File | TUFLOW Tutorial Module 6 - Part 3]]</u>. The completed TUFLOW Module 6 (part 3) is provided in the '''TUFLOW_CATCH_Module_01\Modelling\TUFLOW''' folder of the download dataset as the starting point for this tutorial. If unfamiliar with TUFLOW, it is recommended to complete Modules 1, 2, 3 and 6 of the <u>[[Tutorial_Introduction | TUFLOW Tutorials]]</u> to establish an understanding of 1D and 2D TUFLOW modelling, including direct rainfall models.
 
= Project Initialisation =
Line 102:
<ol>
<li>Save a copy of '''M06_003.tbc''' as '''TC01_001.tbc''' in the '''TUFLOW_CATCH_Module_01\Modelling\TUFLOW\model''' folder.
<li> Open the '''TC01_001.tbc''' in a text editor and updateremove or comment out the reference to the 2D boundaries: using a '<font color="green"><tt>!</tt></font>' symbol.<br>
<tt><font color=bluegreen>! Read GIS BC</font><font color=red> == </font>gis\2d_bc_TC01_001_L2d_bc_M01_001_L.shp <font color=green> ! Reads in downstream 2D boundary</font></tt><br>
<li> Add the additional lines to reference the 1D/2D culvert connections:<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>
Line 123:
 
== TUFLOW CATCH Control File (TCC) ==
A TUFLOW CATCH simulation is set up and executed by constructing a TUFLOW CATCH Control file (.tcc). TUFLOW Control file (.tcf) and TUFLOW FV Control file (.fvc) are not used. The TCC.tcc has four command blocks:
<ol>
<li> Global commands
Line 132:
All blocks must be included in the above order, but the later three can be switched on and off with a single command.
 
The TUFLOW CATCH plugin has created a TCC.tcc template file in the '''TUFLOWCATCH\runs''' folder, '''TC01_001.tcc'''. This file has been populated with all the commands needed to execute a TUFLOW CATCH simulation. In this section, the template commands will be populated/updated for this tutorial model.
 
=== Global Settings ===
Line 188:
<li> In the 'Output Map Configuration' section, update the following commands to set the map output formats, the map output interval, map cuttoff depth and to define the TIF output parameters. <br>
<tt><font color="blue">Map Output Format</font><font color="red"> == </font>XMDF TIF <font color="green"> ! Result file types</font></tt><br>
<tt><font color="blue">Map Output Data Types</font><font color="red"> == </font>catch h v d <font color="green"> ! Output data types</font></tt><br>
<tt><font color="blue">Map Output Interval</font><font color="red"> == </font>30 <font color="green"> ! Interval of output map data (seconds)</font></tt><br>
<tt><font color="blue">Map Cutoff Depth</font><font color="red"> == </font>0.05 <font color="green"> ! Sets map cutoff depth (meters)</font></tt><br>
Line 207 ⟶ 208:
<tt><font color="blue">Time-Series Temperature</font><font color="red"> == </font>temp <font color="green">! Specify temperature as a timeseries and the corresponding BC database name</font></tt><br>
 
<li>In the 'Pollutant Export Properties' section, add the material block '<tt>ALL</tt>' (<tt><font color="blue">Material </font><font color="red">==</font> ALL</tt>) from the page linked below. This code block defines the default (or spatially uniform) pollutant export properties for each pollutant. Once uniform conditions are set, progressive specifications of material by material pollutant behaviour can be set. These specifications override previous settings on a spatial basis. Including the default (<tt>ALL</tt>) material block is considered best practice, as it ensures that all pollutants have export properties defined across the entire TUFLOW HPC domain, otherwise an error will occur. For more information on the pollutant export parameters, refer to <u>[https://docs.tuflow.com/catch/manual/2025.0/SimulationConstruction-1.html#SCTCCPollExpPE-4 Section 4.5.3.3 of the TUFLOW CATCH Manual]</u>.
:*<u>[[TUFLOW_CATCH_Tutorial_M01_Pollutant_Export#Default_.28ALL.29 | Pollutant Export Properties: ALL]]</u><br>
 
Line 247 ⟶ 248:
 
 
<li> For this tutorial, leave all interventions commands as is. TheyThis section of the .tcc will be discussed in <u>[[TUFLOW_CATCH_Tutorial_M04TUFLOW_CATCH_Tutorial_M02 | TUFLOW CATCH Tutorial 402]]</u>.
<li> Save the TCC.tcc.
</ol>
 
===Receiving Model (TUFLOW FV)===
For this tutorial, leave all commands as is. This section of the TCC.tcc will be discussedpopulated in <u>[[TUFLOW_CATCH_Tutorial_M02TUFLOW_CATCH_Tutorial_M03 | TUFLOW CATCH Tutorial 203]]</u>.
 
=Running the Simulation=
Line 259 ⟶ 260:
<li>Save a copy of '''Demonstration.bat''' as '''_run_TC01_CATCH.bat''' and open the file in a text editor.
<li>Update the batch file to reference the TUFLOW CATCH executable:<br>
<tt><font color="blue">set </font>exe<font color="red">=</font>"..\..\..\..\exe\TUFLOWCATCH\2025.0.1.0\TUFLOWCATCH.exe"</tt><br>
<tt><font color="orange">%exe%</font> TC01_001.tcc</tt>
<li>Double click the batch file in file explorer to run the simulation.
</ol>
<br>
 
=Troubleshooting=
See tips on common mistakes and troubleshooting steps if the model doesn't run:
:*<u>[[Tutorial_Troubleshooting_QGIS | QGIS]]</u>
 
 
=Check Files and Results Output=
Line 274 ⟶ 273:
:*<u>[[TUFLOW_CATCH_Tutorial_M01_Check_Files_QGIS | TC01 - Check Files]]</u><br>
:*<u>[[TUFLOW_CATCH_Tutorial_M01_Results_QGIS | TC01 - Results]]</u><br>
 
=Reviewing Model Performance=
There are a number of useful outputs from TUFLOW CATCH for reviewing the model performance.
 
===TUFLOW CATCH Log File (.catchlog)===
The first file to review is the TUFLOW CATCH Log File (.catchlog). The <tt><font color=blue>Log Folder</font><font color=red> == </font>log</tt> command in the .tcc controls where the .catchlog is written. <br>
Navigate to the '''Modelling\TUFLOWCATCH\runs\log''' folder and open the '''TC01_001.catchlog''' file in a text editor. It contains a summary of the TUFLOW CATCH simulation. The following are the key points to review: <br>
* '''Global Settings:''' The commands from the 'Global Settings' section of the .tcc are echoed here. Review these to confirm that the correct settings have been applied.<br>
:[[File: TC1_catchlog_01b.png]]<br>
* '''Simulation Configuration:''' The .catchlog outlines which models have been used and what simulation configuration has been run. In this tutorial, the catchment hydraulic and pollutant export models have been applied, indicating a pollutant export configuration. <br>
:[[File: TC1_catchlog_02a.png]]<br>
* '''Run Status:''' At the end of the file, a message will confirm the simulation outcome.
:* If successful, it will state 'Run Successful'<br>
::[[File: TC1_catchlog_03b.png]]<br>
:* If an issue occurred, the simulation will stop and an error message will be reported. An example error is shown in the image below.
::'''Note:''' Each TUFLOW CATCH error message has a corresponding wiki page that provides further details about the error, and suggestions for how to fix the issue. Refer to <u>[[5xxx_TUFLOW_Messages | 5xxx Messages]]</u> for a list of all TUFLOW CATCH related error messages.<br>
::[[File: TC1_catchlog_04c.png]]<br>
 
===Other Log Files===
Once the .catchlog has been reviewed, it is recommended to check the TUFLOW Log File (.tlf) if the catchment hydraulic model has been specified and to check the TUFLOW FV Log File (.log) if the receiving model has been specified. These files contain TUFLOW and TUFLOW FV specific check, warning and error messages.
 
====TUFLOW Log File (.tlf)====
Since the catchment hydraulic model is specified in this tutorial, review the TUFLOW Log File. The <tt><font color=blue>Log Folder</font><font color=red> == </font>log</tt> command in the .tcc defines where the .tlf is written<br>
Navigate to the '''Modelling\TUFLOWCATCH\runs\log''' folder and open the '''TC01_001_catchment_hydraulic.tlf''' file in a text editor.
* Scroll down to the bottom to 'Simulation Summary'. This includes information about the computation time, messages, volume calculations and mass error.
* Review any check, warning or error messages.
* For more information on reviewing TUFLOW log outputs, refer to <u>[[HPC_Model_Review | HPC Model Review]]</u>.
 
====TUFLOW FV Log File (.log)====
The receiving model has not been specified in this tutorial, so no TUFLOW FV Log File (.log) has been created. The TUFLOW FV Log File will be reviewed in <u>[[TUFLOW_CATCH_Tutorial_M03#Reviewing_Model_Performance | TUFLOW CATCH Tutorial 03]]</u>.
 
=Conclusion=
Retrieved from "https://wiki.tuflow.com/TUFLOW_CATCH_Tutorial_M01"