Difference between revisions of "TUFLOW CATCH Tutorial M04 Draft"

From Tuflow
Jump to navigation Jump to search
 
(11 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
<font color="red"><font size=18>Page Under Construction</font></font>
 
<font color="red"><font size=18>Page Under Construction</font></font>
 
= Introduction =
 
= Introduction =
In this module, a TUFLOW CATCH interventions model is developed. <br>
+
In this module, a TUFLOW CATCH integrated model with interventions is developed. <br>
  
 
TUFLOW CATCH Tutorial Module 4 is built from the model created in <u>[[TUFLOW_CATCH_Tutorial_M03 | TUFLOW CATCH Module 3]]</u>. The completed TUFLOW CATCH Module 03 is provided in the '''TUFLOW_CATCH_Module_04\Modelling''' folder of the download dataset as the starting point for this tutorial.  
 
TUFLOW CATCH Tutorial Module 4 is built from the model created in <u>[[TUFLOW_CATCH_Tutorial_M03 | TUFLOW CATCH Module 3]]</u>. The completed TUFLOW CATCH Module 03 is provided in the '''TUFLOW_CATCH_Module_04\Modelling''' folder of the download dataset as the starting point for this tutorial.  
Line 8: Line 8:
 
= GIS Inputs =
 
= GIS Inputs =
 
Create, import and view input data:
 
Create, import and view input data:
:*<u>[[TUFLOW_CATCH_Tutorial_M04_GIS_Inputs_QGIS | QGIS GIS Inputs]]</u>
+
:*<u>[[TUFLOW_CATCH_Tutorial_M04_GIS_Inputs_QGIS | TC04 - GIS Inputs]]</u>
 +
 
 +
= Treatment Tables =
 +
Treatment tables can be used in TUFLOW CATCH integrated models with interventions. Treatment tables are one of the mass removal methods offered by TUFLOW CATCH. A treatment table is a two dimensional array that defines the proportion of pollutant mass removed from the incoming water based on:
 +
* Incoming pollutant concentration: The concentration of a given pollutant entering the treatment device.
 +
:''Note:'' The concentration units depend on the pollutant. Refer to the <font color=orange>specific section of the catch manual</font> for details on unit conventions.
 +
* Flow rate: The volume of water passing through the treatment device (m^3/s)
 +
Treatment tables allow users to vary pollutant removal efficiency. Recognising that some intervention devices perform better when pollutants enter at higher concentrations and lower flow rates, rather than at lower concentrations with higher flow rates. <font color=red> last sentence could be worded better/included more seamlessly</font> For more information about treatment tables and their properties, please refer to the <font color=orange>specific section of the catch manual</font>.
 +
 
 +
For this tutorial, treatment tables for E. coli and clay have been provided:
 +
<ol>
 +
<li>In Windows File Explorer, navigate to the '''TUFLOW_CATCH_Module_04\Tutorial_Data''' folder. Copy the '''TC04_ecoli_treatment_001.csv''' and '''TC04_clay_treatment_001.csv''' and paste them in the '''TUFLOW_CATCH_Module_04\Modelling\TUFLOW\bc_dbase''' folder.
 +
<li>Open the '''TC04_ecoli_treatment_001.csv'''. The first row defines the incoming concentration (cfu/100mL), and the first column defines the incoming flow rate (m^3/s). The other values are the removal factors, which define the proportion of pollutant removed for a given concentration and flow rate. For example, for an incoming concentration of 100000 cfu/100mL and a incoming flow rate of 5 m^3/s, the removal factor is 0.15. The concentration and flow ranges were determined from the outputs of the previous tutorial model (<u>[[TUFLOW_CATCH_Tutorial_Module_03 | TUFLOW CATCH Tutorial 3]]</u>). <br>
 +
<br>
 +
[[File: image of ecoli treatment table]]<br>
 +
<br>
 +
<li>Open the '''TC04_clay_treatment_001.csv'''. This file follows the same structure as the E. coli treatment table, however the incoming concentrations are in mg/L instead of cfu/100mL. <br>
 +
<br>
 +
[[File: image of the clay treatment table]]<br>
 +
<br>
 +
</ol>
  
 
= Simulation Control Files =
 
= Simulation Control Files =
Line 14: Line 34:
  
 
== TUFLOW CATCH Control File (TCC) ==
 
== TUFLOW CATCH Control File (TCC) ==
intro...<br>
 
The TUFLOW CATCH QGIS plugin has created a .tcc template file populated with .... Including adding the exe file paths.
 
 
=== Global Settings ===
 
=== Global Settings ===
Applied to the whole simulation. <font color=red> more info</font>
+
For this tutorial, leave all commands as is. This section of the .tcc was populated in <u>[[TUFLOW_CATCH_Tutorial_M01 | TUFLOW CATCH Tutorial 1]]</u>.
<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> <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> <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> <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> <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> <font color=green>  ! Writes CSV output every 0.01 days</font></tt><br>
 
</ol>
 
  
 
=== Catchment Hydraulic Model ===
 
=== Catchment Hydraulic Model ===
Hydraulic model specific commands - similar to TUFLOW tcf
+
For this tutorial, leave all commands as is. This section of the .tcc was populated in <u>[[TUFLOW_CATCH_Tutorial_M03 | TUFLOW CATCH Tutorial 3]]</u>.
 +
 
 +
=== Pollutant Export Model ===
 +
This block contains commands that control the pollutant export (and other constituent) simulation. For this tutorial, the pollutant export model block must be updated to include interventions.
 
<ol>
 
<ol>
<li> Set the catchment hydraulic model:<br>
+
<li> Save a copy of '''TC03_001.tcc''' as '''TC04_001.tcc''' in the '''TUFLOW_CATCH_Module_04\Modelling\TUFLOWCatch\runs''' folder. Open '''TC04_001.tcc''' in a text editor.
<tt><font color=blue>Catchment Hydraulic Model</font><font color=red> == </font>HPC </font> <font color=green></font></tt>
+
<li> In the 'Interventions' section, update the following command to reference the interventions (2d_im) layer created earlier in this tutorial. <br>
<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>Read GIS Intervention</font><font color=red> == </font>..\..\TUFLOW\model\gis\2d_im_TC04_001_L.shp </font> <font color=green> ! GIS layer defining interventions</font></tt><br>
<tt><font color=blue>Zero Date</font><font color=red> == </font>01/01/2021 10:00 </font> <font color=green>  ! Specifies the simulation start time in TUFLOW FV ISODATE format</font></tt><br>
+
 
<li> In the 'GIS' section, update the following commands: <br>
+
<li>In the 'Mass Removal Properties' section, add the following device block. This block defines the default (or spatially uniform) mass removal methods ?for all pollutants? for all devices. Including it is considered best practice, as it ensures that all devices have their mass export properties specified. For more information on the mass removal parameters, please refer to the <font color=orange>section of the catch manual</font>.<br>
<tt><font color=blue>GIS Format</font><font color=red> == </font>SHP </font> <font color=green>  ! Specify SHP as the output format</font></tt><br>
+
<tt><font color=blue>Device</font><font color=red> == </font>ALL <font color=green>  ! Default parameters for all devices</font></tt><br>
<tt><font color=blue>TIF Projection</font><font color=red> == </font>..\..\TUFLOW\model\grid\DEM.tif </font> <font color=green>  ! Sets the GIS projection for the output grid files</font></tt><br>
+
:<tt>SED_CLAY, <font color=blue>Method </font><font color=red>==</font> Eqn, <font color=blue>Eqn </font><font color=red>==</font> Constant, <font color=blue>Coefficients </font><font color=red>==</font> 1.0</tt><br>
<font color=red>SHP Projection? caused errors I think</font>
+
:<tt>WQ_PATH_ECOLI_ALIVE_CFU_100ML, <font color=blue>Method </font><font color=red>==</font> Eqn, <font color=blue>Eqn </font><font color=red>==</font> Constant, <font color=blue>Coefficients </font><font color=red>==</font> 1.0</tt><br>
<li> In the 'Solver' section, set the timestep maximum and time format:<br>
+
:<tt>WQ_PATH_ECOLI_DEAD_CFU_100ML, <font color=blue>Method </font><font color=red>==</font> Eqn, <font color=blue>Eqn </font><font color=red>==</font> Constant, <font color=blue>Coefficients </font><font color=red>==</font> 1.0</tt><br>
<tt><font color=blue>Timestep Maximum</font><font color=red> == </font>2.5 </font> <font color=green> ! Specifies a maximum timestep (seconds)</font></tt><br>
+
<tt><font color=blue>End Device</font></tt><br>
<tt><font color=blue>Time Format</font><font color=red> == </font>TUFLOWFV </font> <font color=green> ! Specifies the time format of output results</font></tt><br>
+
<tt><font color=blue>Device</font><font color=red> == </font>trench1, trench2 <font color=green>  ! ?</font></tt><br>
<li>
+
:<tt>SED_CLAY, <font color=blue>Method </font><font color=red>==</font> Eqn, <font color=blue>Eqn </font><font color=red>==</font> Constant, <font color=blue>Coefficients </font><font color=red>==</font> 0.4</tt><br>
 +
:<tt>WQ_PATH_ECOLI_ALIVE_CFU_100ML, <font color=blue>Method </font><font color=red>==</font> Eqn, <font color=blue>Eqn </font><font color=red>==</font> Constant, <font color=blue>Coefficients </font><font color=red>==</font> 0.9</tt><br>
 +
:<tt>WQ_PATH_ECOLI_DEAD_CFU_100ML, <font color=blue>Method </font><font color=red>==</font> Eqn, <font color=blue>Eqn </font><font color=red>==</font> Constant, <font color=blue>Coefficients </font><font color=red>==</font> 0.9</tt><br>
 +
<tt><font color=blue>End Device</font></tt><br>
 +
<tt><font color=blue>Device</font><font color=red> == </font>retentionBasin <font color=green>  ! ?</font></tt><br>
 +
:<tt>SED_CLAY, <font color=blue>Method </font><font color=red>==</font> Eqn, <font color=blue>Eqn </font><font color=red>==</font> Constant, <font color=blue>Coefficients </font><font color=red>==</font> 0.8</tt><br>
 +
:<tt>WQ_PATH_ECOLI_ALIVE_CFU_100ML, <font color=blue>Method </font><font color=red>==</font> Table, <font color=blue>Path </font><font color=red>==</font> ..\..\TUFLOW\bc_dbase\TC04_ecoli_treatment_001.csv</tt><br>
 +
:<tt>WQ_PATH_ECOLI_DEAD_CFU_100ML, <font color=blue>Method </font><font color=red>==</font> Table, <font color=blue>Path </font><font color=red>==</font> ..\..\TUFLOW\bc_dbase\TC04_ecoli_treatment_001.csv</tt><br>
 +
<tt><font color=blue>End Device</font></tt><br>
 +
<tt><font color=blue>Device</font><font color=red> == </font>bufferStrip1, bufferStrip2<font color=green>  ! ?</font></tt><br>
 +
:<tt>SED_CLAY, <font color=blue>Method </font><font color=red>==</font> Table, <font color=blue>Path </font><font color=red>==</font> ..\..\TUFLOW\bc_dbase\TC04_clay_treatment_001.csv</tt><br>
 +
:<tt>WQ_PATH_ECOLI_ALIVE_CFU_100ML, <font color=blue>Method </font><font color=red>==</font> Eqn, <font color=blue>Eqn </font><font color=red>==</font> Constant, <font color=blue>Coefficients </font><font color=red>==</font> 0.4</tt><br>
 +
:<tt>WQ_PATH_ECOLI_DEAD_CFU_100ML, <font color=blue>Method </font><font color=red>==</font> Eqn, <font color=blue>Eqn </font><font color=red>==</font> Constant, <font color=blue>Coefficients </font><font color=red>==</font> 0.7</tt><br>
 +
<tt><font color=blue>End Device</font></tt><br>
 
</ol>
 
</ol>
 
=== Pollutant Export Model ===
 
  
 
=== Receiving Model ===
 
=== Receiving Model ===
For this tutorial, leave all commands as is. This section of the .tcc will be discussed in the next tutorial.
+
For this tutorial, leave all commands as is. This section of the .tcc was populated in <u>[[TUFLOW_CATCH_Tutorial_M03 | TUFLOW CATCH Tutorial 3]]</u>.
  
 
= Running the Simulation =
 
= Running the Simulation =
 
+
<ol>
 +
<li>In Windows File Explorer, navigate to the '''TUFLOWCatch\runs''' folder. Save a copy of '''_run_TC03_CATCH.bat''' as '''_run_TC04_CATCH.bat''' <font color=red>maybe change name??</font> and open the file in a text editor.
 +
<li>Update the batch file to reference the '''TC04_001.tcc''':<br>
 +
<tt><font color=blue>set </font>exe<font color=red>=</font>"..\..\..\..\exe\TUFLOWCATCH\2025.0.1\TUFLOWCATCH.exe"</tt><br>
 +
<tt><font color=orange>%exe%</font> TC04_001.tcc</font></tt>
 +
<li>Double click the batch file in file explorer to run the simulation. <br>
 +
</ol>
 +
<br>
  
 
= Troubleshooting =
 
= Troubleshooting =
Line 62: Line 91:
 
Complete the steps outlined in the following links to review check files and simulation results from the TUFLOW CATCH pollutant export model simulation:
 
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_M04_Check_Files_QGIS | TUFLOW CATCH Tutorial 04 Check Files]]</u><br>
+
:*<u>[[TUFLOW_CATCH_Tutorial_M04_Check_Files_QGIS | TC04 - Check Files]]</u><br>
<u>[[TUFLOW_CATCH_Tutorial_M04_Results_QGIS | TUFLOW CATCH Tutorial 04 Results]]</u><br>
+
:*<u>[[TUFLOW_CATCH_Tutorial_M04_Results_QGIS | TC04 - Results]]</u><br>
  
 
= Conclusion =
 
= Conclusion =

Latest revision as of 15:39, 3 April 2025

Page Under Construction

Introduction

In this module, a TUFLOW CATCH integrated model with interventions is developed.

TUFLOW CATCH Tutorial Module 4 is built from the model created in TUFLOW CATCH Module 3. The completed TUFLOW CATCH Module 03 is provided in the TUFLOW_CATCH_Module_04\Modelling folder of the download dataset as the starting point for this tutorial. If you are not already familiar with TUFLOW CATCH, we recommend completing TUFLOW CATCH Module 1, TUFLOW CATCH Module 2 and TUFLOW CATCH Module 3 prior to starting this tutorial.

GIS Inputs

Create, import and view input data:

Treatment Tables

Treatment tables can be used in TUFLOW CATCH integrated models with interventions. Treatment tables are one of the mass removal methods offered by TUFLOW CATCH. A treatment table is a two dimensional array that defines the proportion of pollutant mass removed from the incoming water based on:

  • Incoming pollutant concentration: The concentration of a given pollutant entering the treatment device.
Note: The concentration units depend on the pollutant. Refer to the specific section of the catch manual for details on unit conventions.
  • Flow rate: The volume of water passing through the treatment device (m^3/s)

Treatment tables allow users to vary pollutant removal efficiency. Recognising that some intervention devices perform better when pollutants enter at higher concentrations and lower flow rates, rather than at lower concentrations with higher flow rates. last sentence could be worded better/included more seamlessly For more information about treatment tables and their properties, please refer to the specific section of the catch manual.

For this tutorial, treatment tables for E. coli and clay have been provided:

  1. In Windows File Explorer, navigate to the TUFLOW_CATCH_Module_04\Tutorial_Data folder. Copy the TC04_ecoli_treatment_001.csv and TC04_clay_treatment_001.csv and paste them in the TUFLOW_CATCH_Module_04\Modelling\TUFLOW\bc_dbase folder.
  2. Open the TC04_ecoli_treatment_001.csv. The first row defines the incoming concentration (cfu/100mL), and the first column defines the incoming flow rate (m^3/s). The other values are the removal factors, which define the proportion of pollutant removed for a given concentration and flow rate. For example, for an incoming concentration of 100000 cfu/100mL and a incoming flow rate of 5 m^3/s, the removal factor is 0.15. The concentration and flow ranges were determined from the outputs of the previous tutorial model ( TUFLOW CATCH Tutorial 3).

    File:Image of ecoli treatment table

  3. Open the TC04_clay_treatment_001.csv. This file follows the same structure as the E. coli treatment table, however the incoming concentrations are in mg/L instead of cfu/100mL.

    File:Image of the clay treatment table

Simulation Control Files

The following steps will require use of a text editor. The tutorial demonstration uses Notepad++. For its configuration information refer to Notepad++ Tips.

TUFLOW CATCH Control File (TCC)

Global Settings

For this tutorial, leave all commands as is. This section of the .tcc was populated in TUFLOW CATCH Tutorial 1.

Catchment Hydraulic Model

For this tutorial, leave all commands as is. This section of the .tcc was populated in TUFLOW CATCH Tutorial 3.

Pollutant Export Model

This block contains commands that control the pollutant export (and other constituent) simulation. For this tutorial, the pollutant export model block must be updated to include interventions.

  1. Save a copy of TC03_001.tcc as TC04_001.tcc in the TUFLOW_CATCH_Module_04\Modelling\TUFLOWCatch\runs folder. Open TC04_001.tcc in a text editor.
  2. In the 'Interventions' section, update the following command to reference the interventions (2d_im) layer created earlier in this tutorial.
    Read GIS Intervention == ..\..\TUFLOW\model\gis\2d_im_TC04_001_L.shp ! GIS layer defining interventions
  3. In the 'Mass Removal Properties' section, add the following device block. This block defines the default (or spatially uniform) mass removal methods ?for all pollutants? for all devices. Including it is considered best practice, as it ensures that all devices have their mass export properties specified. For more information on the mass removal parameters, please refer to the section of the catch manual.
    Device == ALL ! Default parameters for all devices
    SED_CLAY, Method == Eqn, Eqn == Constant, Coefficients == 1.0
    WQ_PATH_ECOLI_ALIVE_CFU_100ML, Method == Eqn, Eqn == Constant, Coefficients == 1.0
    WQ_PATH_ECOLI_DEAD_CFU_100ML, Method == Eqn, Eqn == Constant, Coefficients == 1.0
    End Device
    Device == trench1, trench2 ! ?
    SED_CLAY, Method == Eqn, Eqn == Constant, Coefficients == 0.4
    WQ_PATH_ECOLI_ALIVE_CFU_100ML, Method == Eqn, Eqn == Constant, Coefficients == 0.9
    WQ_PATH_ECOLI_DEAD_CFU_100ML, Method == Eqn, Eqn == Constant, Coefficients == 0.9
    End Device
    Device == retentionBasin ! ?
    SED_CLAY, Method == Eqn, Eqn == Constant, Coefficients == 0.8
    WQ_PATH_ECOLI_ALIVE_CFU_100ML, Method == Table, Path == ..\..\TUFLOW\bc_dbase\TC04_ecoli_treatment_001.csv
    WQ_PATH_ECOLI_DEAD_CFU_100ML, Method == Table, Path == ..\..\TUFLOW\bc_dbase\TC04_ecoli_treatment_001.csv
    End Device
    Device == bufferStrip1, bufferStrip2 ! ?
    SED_CLAY, Method == Table, Path == ..\..\TUFLOW\bc_dbase\TC04_clay_treatment_001.csv
    WQ_PATH_ECOLI_ALIVE_CFU_100ML, Method == Eqn, Eqn == Constant, Coefficients == 0.4
    WQ_PATH_ECOLI_DEAD_CFU_100ML, Method == Eqn, Eqn == Constant, Coefficients == 0.7
    End Device

Receiving Model

For this tutorial, leave all commands as is. This section of the .tcc was populated in TUFLOW CATCH Tutorial 3.

Running the Simulation

  1. In Windows File Explorer, navigate to the TUFLOWCatch\runs folder. Save a copy of _run_TC03_CATCH.bat as _run_TC04_CATCH.bat maybe change name?? and open the file in a text editor.
  2. Update the batch file to reference the TC04_001.tcc:
    set exe="..\..\..\..\exe\TUFLOWCATCH\2025.0.1\TUFLOWCATCH.exe"
    %exe% TC04_001.tcc
  3. 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 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:

Conclusion