View source for TUFLOW CATCH Tutorial M01

= Introduction =
In this module, a TUFLOW CATCH pollutant export model is developed. <br>

TUFLOW CATCH Tutorial 01 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 =
TUFLOW CATCH models are separated into a series of folders which contain the input and output files. The recommended directory structure for TUFLOW CATCH models consists of a top-level folder, '''Modelling''', which contains three subfolders:
* '''TUFLOW''': Contains TUFLOW HPC input files.
* '''TUFLOWCATCH''': Contains the TUFLOW CATCH Control file, as well as all check, results and log files.
* '''TUFLOWFV''': Contains TUFLOW FV input files.
The third level subfolders are outlined below. For a more detailed description, refer to the <u>[https://docs.tuflow.com/catch/latest/ TUFLOW CATCH Manual]</u>. For more information on TUFLOW HPC or TUFLOW FV folder structures, refer to the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u> or the <u>[https://downloads.tuflow.com/TUFLOWFV/Releases/Latest/TUFLOW_FV_User_Manual.pdf TUFLOW FV Manual]</u>. <br>
<ol>
[[File:TC1_folder_structure_01a.png|left]]
{| class="wikitable"

! style="background-color:#005581; font-weight:bold; color:white;" | Folder
! style="background-color:#005581; font-weight:bold; color:white;" width=10%| Sub-Folder (s)
! style="background-color:#005581; font-weight:bold; color:white;" width=75%| Description
|-
|rowspan="3" style="text-align: center;"|TUFLOW
| bc_dbase<br>model|| Follows standard TUFLOW structure.
|-
| catch || Not used, but generated for internal use. It holds files that are produced during computation, but deleted when the simulation finishes successfully.
|-
| check<br>results<br>runs || Not used, but generated for internal use. <br>All TUFLOW check and results files are written to the '''TUFLOWCATCH\check''' folder and the '''TUFLOWCATCH\results''' folder respectively. <br>TUFLOW CATCH simulations are run from the .tcc file in the '''TUFLOWCATCH\runs''' folder.
|-
|rowspan="6" style="text-align: center;"|TUFLOWCATCH
| bc_dbase|| Contains the output boundary condition and time-series data.
|-
| check || Contains the GIS and other check files produced by TUFLOW CATCH, TUFLOW and TUFLOW FV to carry out quality control checks
|-
| model || Not used - generated for internal use.
|-
| results|| Contains the result files produced by TUFLOW CATCH, TUFLOW and TUFLOW FV.
|-
| runs|| Contains the .tcc simulation control file.
|-
| runs\log || Contains the log files (e.g. .catchlog, .tlf, .log, etc) and _messages.shp files produced by TUFLOW CATCH, TUFLOW and TUFLOW FV.
|-
|rowspan="2" style="text-align: center;"|TUFLOWFV
| bc_dbase<br>model<br>stm<br>wqm|| Follows standard TUFLOW FV structure.
|-
| check<br>results<br>runs || Not used, but generated for internal use. <br>All TUFLOW FV check and results files are written to the '''TUFLOWCATCH\check''' folder and the '''TUFLOWCATCH\results''' folder respectively. <br>TUFLOW CATCH simulations are run from the .tcc file in the '''TUFLOWCATCH\runs''' folder.
|}
</ol>

The TUFLOW CATCH folders can be set up manually, or automatically through the TUFLOW QGIS Plugin (recommended).
:*<u>[[TUFLOW_CATCH_Tutorial_M01_Project_Initialisation_QGIS | TUFLOW CATCH Project Initialisation]]</u>

= GIS Inputs =
Create, import and view input data:
:*<u>[[TUFLOW_CATCH_Tutorial_M01_GIS_Inputs_QGIS | TC01 - GIS Inputs]]</u>

= TUFLOW Boundary Condition Database (bc_dbase) =
Update the bc_dbase to remove the 2D boundaries and add a reference to the timeseries temperature data. Note that TUFLOW CATCH does not support 2D boundaries, however, 2d_sa GIS layers can be used to simulate non-hydrologic surface loads. For more information on 2d_sa inputs, refer to <u>[https://docs.tuflow.com/catch/manual/2025.2/ProcessDescriptionsSAs-2.html#ProcessDescriptionsSAs-2 Section 3.4 of the TUFLOW CATCH Manual]</u>.
<ol>
<li>In Windows File Explorer, navigate to the '''TUFLOW_CATCH_Module_01\Tutorial_Data''' folder. Copy the '''temperature.csv''' and paste it in the '''TUFLOW_CATCH_Module_01\Modelling\TUFLOW\bc_dbase''' folder. This file contains the timeseries temperature data. 
<li> Open the file. As this file will be read by TUFLOW CATCH, the first column must contain the date in ISODATE format (DD/MM/YYYY hh:mm:ss). It will also be read by TUFLOW HPC, and therefore must have a column specifying a time in hours from the beginning of the model. In this case, the 'TUFLOW_Time' column contains the time in hours. For example, 01/01/2021 10:00:00 corresponds to 0, 01/01/2021 11:00:00 to 1, and so on. <br>
<br>
[[File: TC1_temperature_csv_01a.png]]<br>
<br>
<li> In the '''TUFLOW\bc_dbase''' folder, save a copy of the '''bc_dbase_M06_001.csv''' as '''bc_dbase_TC01_001.csv'''.
<li> Open the file and remove the references to the 2D boundaries (FC01, FC02, FC04, FC05, FC06 and FC07). 
<li> Add the reference to the timeseries temperature data as shown below:<br>
<br>
[[File: TC1_bc_dbase_01b.png]]<br>
<br>
<li> Save the bc_dbase.
</ol>

= Materials =
Surface roughness or bed resistance values (e.g. Manning’s n) are assigned to material IDs. To simulate a more complex catchment area, more material IDs have been specified. 
<ol>
<li>In Windows File Explorer, navigate to the '''TUFLOW_CATCH_Module_01\Tutorial_Data''' folder. Copy the '''materials_TC01_001.csv''' and paste it in the '''TUFLOW_CATCH_Module_01\Modelling\TUFLOW\model''' folder. This file is a modified version of '''materials_M06_002.csv''' from <u>[[Tutorial_M06#Materials_2 | TUFLOW Tutorial Module 6]]</u>.
<li>Open the file. Roughness values (Manning's n) have been applied to the five new material IDs:<br>
<br>
[[File: TC1_materials_01b.png]]<br>
<br>
<li>These new material IDs have been assigned to allow different pollutant export properties to be specified to each material ID. This is discussed in the <u>[[#Pollutant_Export_Model | TUFLOW CATCH Control File]]</u> section. 
</ol>

= TUFLOW Soil File (.tsoilf) =
The soils (.tsoilf) file is similar to the materials file. A positive integer ID is assigned to each soil, then an infiltration method followed by the soil parameters. For this tutorial, there is only one soil type (ID 1) which is applied across the whole model. 
<ol>
<li>In Windows File Explorer, navigate to the '''TUFLOW_CATCH_Module_01\Tutorial_Data''' folder. Copy the '''TC01_soils_001.tsoilf''' and paste it in the '''TUFLOW_CATCH_Module_01\Modelling\TUFLOW\model''' folder.<br>
<li>Open the file. The Green-Ampt (GA) infiltration method has been used. For more information on infiltration methods, refer to the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u>.<br>
<br>
[[File: TC1_soils_file_01a.png]]<br>
<br>
</ol>

= Simulation Control Files =
The following steps will require use of a text editor. The tutorial demonstration uses Notepad++. For its configuration information refer to <u>[[NotepadPlusPlus_Tips | Notepad++ Tips]]</u>. <br>
=== TUFLOW Geometry Control File (TGC) ===
<ol>
<li> Save a copy of '''M02_001.tgc''' as '''TC01_001.tgc''' in the '''TUFLOW_CATCH_Module_01\Modelling\TUFLOW\model''' folder. 
<li> Open the '''TC01_001.tgc''' in a text editor and add the following line after the '<tt><font color=blue>Read GIS Mat</font></tt>' command to reference the new materials GIS layer.<br>
<tt><font color=blue>Read GIS Mat</font><font color=red> == </font>gis\2d_mat_TC01_001_R.shp  <font color=green>  ! Sets material values according to attributes in the GIS layer</font></tt><br>
<li> Add the following section to globally set the soil ID and the soil thickness:<br>
<tt><font color=green>! SOILS</font></tt><br>
<tt><font color=blue>Set Soil</font><font color=red> == </font>1  <font color=green>  ! Globally sets the soil ID to 1</font></tt><br>
<tt><font color=blue>Set Soil Thickness</font><font color=red> == </font>0.2  <font color=green>  ! Globally sets the soil thickness to 0.2m</font></tt><br>
<li> Save the TGC.
</ol>

=== TUFLOW Boundary Control File (TBC) ===
<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 remove or comment out the reference to the 2D boundaries using a '<font color="green"><tt>!</tt></font>' symbol.<br>
<tt><font color=green>! Read GIS BC == gis\2d_bc_M01_001_L.shp    ! 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>
<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>
<li>Save the TBC.
</ol>

=== TUFLOW ESTRY Control File (ECF) ===
<ol>
<li> Navigate to the '''TUFLOW_CATCH_Module_01\Modelling\TUFLOW\model''' folder, and open '''TC01_001.ecf''' in a text editor. This file was created using the TUFLOW CATCH plugin.
<li> In the '1D Time Control' section, ensure the following command has been specified to set the 1D computational timestep:<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 of 0.5 seconds</tt></font> <br>
<li> In the '1D Elements' section, add the following command to define the culverts:<br>
<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> 
<li> Add the following command line to define the Advection Dispersion (AD) approach. For more information on Advection Dispersion, please refer to the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u>.<br>
<tt><font color=blue>AD Approach</font><font color=red> == </font>METHOD A  <font color=green>  ! Sets the modelling approach for the Advection Dispersion through 1D channels</font></tt>
<li>Save the ECF.
</ol>

== 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 has four command blocks:
<ol>
<li> Global settings
<li> Catchment Hydraulic Model (TUFLOW HPC) commands
<li> Catchment Pollutant Export Model 
<li> Receiving Model (TUFLOW FV) commands
</ol>
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 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 ===
This section contains information that is applied equally to both TUFLOW HPC and TUFLOW FV.
<ol>
<li> Navigate to the '''TUFLOW_CATCH_Module_01\Modelling\TUFLOWCATCH\runs''' folder and open '''TC01_001.tcc''' into a text editor.
<li> In the 'Simulation Settings' section, update the time commands:<br>
<tt><font color=blue>Start Time</font><font color=red> == </font>01/01/2021 10:00:00  <font color=green>  ! Specifies the simulation start time</font></tt><br>
<tt><font color=blue>End Time</font><font color=red> == </font>01/01/2021 13:00:00  <font color=green>  ! Specifies the simulation end time</font></tt><br>
<li> In the 'Boundary Condition Configuration' section, update the BC and CSV output intervals:<br>
<tt><font color=blue>Catch BC Output Interval Nodestring</font><font color=red> == </font>300  <font color=green>  ! Outputs BC nodestring data every 300 seconds</font></tt><br>
<tt><font color=blue>Catch BC Output Interval Lateral</font><font color=red> == </font>300  <font color=green>  ! Outputs BC lateral data every 300 seconds</font></tt><br>
<tt><font color=blue>CSV Write Frequency Day</font><font color=red> == </font>0.01  <font color=green>  ! Writes CSV output every 0.01 days</font></tt><br>
</ol>

=== Catchment Hydraulic Model (TUFLOW HPC) ===
This block contains commands that construct the TUFLOW HPC simulation. These commands are almost entirely those that would be used in setting up a standalone TUFLOW HPC control file (.tcf), with a small number of additional commands that relate to TUFLOW CATCH. 
<ol>
<li> Set the catchment hydraulic model:<br>
<tt><font color=blue>Catchment Hydraulic Model</font><font color=red> == </font>HPC  <font color=green></font></tt>

<li> Set the zero date. TUFLOW HPC does not support ISODATE format, while TUFLOW FV requires it. This command ensures compatibility by setting the date in TUFLOW FV ISODATE format that corresponds to zero hours in TUFLOW HPC boundary condition files.<br>
<tt><font color=blue>Zero Date</font><font color=red> == </font>01/01/2021 10:00  <font color=green>  ! Specifies the simulation start time in TUFLOW FV ISODATE format</font></tt><br>

<li> In the 'GIS' section, remove or comment out the following command using a '<font color="green"><tt>!</tt></font>' symbol. The SHP projection has already been set in the <u>[[#Global_Settings |Global Settings]]</u> section.<br>
<tt><font color=green>! SHP Projection == ..\..\TUFLOW\model\gis\projection.shp</font></tt><br>

<li> In the 'GIS' section, set the projection for the output grid files: <br>
<tt><font color=blue>TIF Projection</font><font color=red> == </font>..\..\TUFLOW\model\grid\DEM.tif  <font color=green>  ! Sets the GIS projection for the output grid files</font></tt><br>

<li> In the 'Solver' section, set the timestep maximum and time format:<br>
<tt><font color=blue>Timestep Maximum</font><font color=red> == </font>2.5  <font color=green>  ! Specifies a maximum timestep (seconds)</font></tt><br>
<tt><font color=blue>Time Format</font><font color=red> == </font>TUFLOWFV  <font color=green>  ! Specifies the time format of output results</font></tt><br>

<li> In the 'SGS' section, set the sample target distance:<br>
<tt><font color=blue>SGS Sample Target Distance</font><font color=red> == </font>0.5  <font color=green>  ! Sets SGS Sample Target Distance (meters)</font></tt><br>

<li> In the 'Control Files' section, ensure all control files are referenced.<br>
<tt><font color=blue>Geometry Control File</font><font color=red> == </font>..\..\TUFLOW\model\TC01_001.tgc  <font color=green>  ! Reference the TUFLOW Geometry Control File</font></tt><br>
<tt><font color=blue>BC Control File</font><font color=red> == </font>..\..\TUFLOW\model\TC01_001.tbc  <font color=green>  ! Reference the TUFLOW Boundary Conditions Control File</font></tt><br>
<tt><font color=blue>BC Database</font><font color=red> == </font>..\..\TUFLOW\bc_dbase\bc_dbase_TC01_001.csv  <font color=green>  ! Reference the Boundary Conditions Database</font></tt><br>
<tt><font color="blue">Read Materials File</font><font color="red"> == </font>..\..\TUFLOW\model\materials_TC01_001.csv  <font color="green">  ! Reference the Materials Definition File</font></tt><br>
<tt><font color="blue">Rainfall Control File</font><font color="red"> == </font>..\..\TUFLOW\model\M06_point2grid_003.trfc  <font color="green">  ! Reference the TUFLOW Rainfall Control File</font></tt><br>
<tt><font color="blue">ESTRY Control File</font><font color="red"> == </font> ..\..\TUFLOW\model\TC01_001.ecf <font color="green">  ! Reference the ESTRY (1D) Control File</font></tt><br>

<li> In the 'Soils' section, reference the soils file (.tsoilf), and remove or comment out the 'soil negative rainfall approach' command using a '<font color="green"><tt>!</tt></font>' symbol.<br>
<tt><font color="blue">Read Soils File</font><font color="red"> == </font>..\..\TUFLOW\model\TC01_soils_001.tsoilf  <font color="green">  ! Reference the Soils File</font></tt><br>
<tt><font color=green>! Soil Negative Rainfall Approach == FACTOR</font></tt><br>

<li> In the 'Pollutant Configuration' section, reference the receiving polygon and set the pollutants. In this tutorial, salinity, temperature, dissolved oxygen (WQ_DISS_OXYGEN_MG_L), alive and dead ecoli (WQ_PATH_ECOLI_ALIVE/DEAD_CFU_100ML) and clay sediment (SED_CLAY) are simulated.<br>
<tt><font color="blue">Receiving Polygon</font><font color="red"> == </font>..\..\TUFLOW\model\gis\2d_rp_TC01_001_R.shp  <font color="green">  ! GIS layer defining the receiving polygon</font></tt><br>
<tt><font color="blue">Pollutant</font><font color="red"> == </font>Salinity, Temperature, WQ_DISS_OXYGEN_MG_L, WQ_PATH_ECOLI_ALIVE_CFU_100ML, WQ_PATH_ECOLI_DEAD_CFU_100ML, SED_CLAY  <font color="green">  ! Specify the pollutant names </font></tt><br>

<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>
<tt><font color="blue">TIF Map Output Interval</font><font color="red"> == </font>0  <font color="green">  ! Interval of output TIF map data (seconds)</font></tt><br>
<tt><font color="blue">TIF Map Output Data Types</font><font color="red"> == </font>h d dt  <font color="green">  ! TIF result file types</font></tt> <br>
</ol>

===Pollutant Export Model===
This block contains commands that control the pollutant export (and other constituent) simulation.
<ol>
<li> Set the pollutant export model:<br>
<tt><font color="blue">Catchment Pollutant Export Model</font><font color="red"> == </font>Mass Accumulation Release  <font color="green"></font></tt>

<li> In the 'Constant Concentrations' section, add the following commands. They set the pollutants 'Salinity' and 'WQ_DISS_OXYGEN_MG_L' (dissolved oxygen) to a constant concentration value that is applied equally to all boundaries and summary files where appropriate.<br>
<tt><font color="blue">Constant Salinity</font><font color="red"> == </font>0.0  <font color="green"> ! Specify the constant concentration of salinity</font></tt><br>
<tt><font color="blue">Constant WQ_DISS_OXYGEN_MG_L</font><font color="red"> == </font>8.0  <font color="green"> ! Specify the constant concentration of dissolved oxygen</font></tt><br>

<li> In the 'Time Series' section, add the following command. It sets the pollutant 'Temperature' to be a time-series input, and points to the name 'temp' in the bc_dbase.<br>
<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 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>


<li>To set the pollutant export properties for the different material IDs, blocks similar to the above (e.g. <tt><font color="blue">Material </font><font color="red">==</font> 4</tt>) can be used. The material IDs correspond to those defined in the '''2d_mat_TC01_001.shp''' and '''2d_mat_M01_001.shp''' GIS layers.<br>
<br>
To estimate E. coli export rates for each paddock, the area of each paddock was calculated. Based on this, appropriate animal populations were assigned. Using these values, the E. coli rates were calculated. For more information on pollutant export calculations, refer to <u>[https://docs.tuflow.com/catch/manual/2025.0/ProcessDescriptions-1.html#ProcessDescriptionsMats-3 Section 3.2.3 of the TUFLOW CATCH Manual]</u>.<br>
<br>
[[File: TC1_aerial_with_paddocks_01a.png|left]]
<br><br><br><br><br>
{| class="wikitable"

! style="background-color:#005581; font-weight:bold; color:white; padding: 10px" |Material ID
! style="background-color:#005581; font-weight:bold; color:white; padding: 10px" |Paddock Name
! style="background-color:#005581; font-weight:bold; color:white; padding: 10px" |Area (ha)
! style="background-color:#005581; font-weight:bold; color:white; padding: 10px" |Animals
|-
|6||paddockA||1.5|| 23 Sheep, 7 Lambs
|- 
|7||paddockB||0.3||2 Cows
|-
|8||paddockC||1.2||20 Sheep
|- 
|9||paddockD || 1||4 Cows, 2 Calves
|} 
<br>
<br><br><br><br><br><br>

<li> Set the pollutant export properties for material ID 1. This is the material ID for all areas within the model domain not covered by a material region. These pollutant export properties define the release and deposition of clay sediment. Sediment pollutants generally use the 'Shear1' method. For more information on 'Shear1', refer to <u>[https://docs.tuflow.com/catch/manual/2025.0/SimulationConstruction-1.html#SCTCCPollExpSS-5 Section 4.5.3.3.2 of the TUFLOW CATCH Manual]</u>.<br>
:*<u>[[TUFLOW_CATCH_Tutorial_M01_Pollutant_Export#Model_Area_.281.29 | Pollutant Export Properties: 1]]</u>


<li>Set the pollutant export properties for material ID 4 (waterholes, eddies, etc). These properties define settling (deposition velocity) of alive and dead E. coli to 2 meters per day (approx 25cm during the simulation).<br>
:*<u>[[TUFLOW_CATCH_Tutorial_M01_Pollutant_Export#Slow_Moving_Water_.284.29 | Pollutant Export Properties: 4]]</u>


<li>Set the pollutant export properties for material ID's 6 (paddockA), 7 (paddockB), 8 (paddockC) and 9 (paddockD). These properties define the accumulation (rate) and washoff of alive and dead E. coli for the animals on the paddock.<br>
:*<u>[[TUFLOW_CATCH_Tutorial_M01_Pollutant_Export#Paddocks_.286.2C_7.2C_8_and_9.29 | Pollutant Export Properties: 6, 7, 8, 9]]</u>


<li> For this tutorial, leave all interventions commands as is. This section of the .tcc will be discussed in <u>[[TUFLOW_CATCH_Tutorial_M02 |TUFLOW CATCH Tutorial 02]]</u>.
<li> Save the .tcc.
</ol>

===Receiving Model (TUFLOW FV)===
For this tutorial, leave all commands as is. This section of the .tcc will be populated in <u>[[TUFLOW_CATCH_Tutorial_M03 | TUFLOW CATCH Tutorial 03]]</u>.

=Running the Simulation=
<ol>
<li>In Windows File Explorer, navigate to the '''TUFLOWCATCH\runs''' folder. The TUFLOW CATCH plugin created a batch file (.bat) that references the .tcc called '''Demonstration.bat'''.
<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\2026.0.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>

=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=
Complete the steps outlined in the following links to review check files and simulation results from the TUFLOW CATCH pollutant export model simulation:
:*<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=
* A TUFLOW CATCH Pollutant Export model was created. A downstream receiving polygon was used to track pollutants in the receiving waters.
* Check files were used to review the transfer from the Catchment Hydraulic model (TUFLOW HPC) into the receiving polygon.
* TUFLOW CATCH time series results and TUFLOW map outputs were assessed to observe the pollutant behaviours.
* 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>
<br>
{{Tips Navigation
|uplink=[[TUFLOW_CATCH_Tutorial_Introduction| Back to Tutorial Introduction Main Page]]
}}