TUFLOW CATCH Tutorial M03 Draft
Page Under Construction
Introduction
In this module, a TUFLOW CATCH integrated model is developed.
TUFLOW CATCH Tutorial Module 3 is built from the model created in TUFLOW CATCH Module 1. The completed TUFLOW CATCH Module 02 is provided in the TUFLOW_CATCH_Module_03\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 and TUFLOW CATCH Module 2 prior to starting this tutorial.
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.
Generate Template Files
This tutorial requires a Water Quality Control file (.fvwq) and a Sediment Transport Control file (.fvsed). Use the TUFLOW CATCH plugin to generate template files:
- In QGIS, go to Processing > Toolbox from the top drop down menu options to open the Processing Toolbox.
- Go to TUFLOW Catch in the processing tool list and select 'Create TUFLOW Catch Project'. This opens the dialog shown below:
- Project Name: TC03
- Project Folder: Click '...', and navigate to the TUFLOW_CATCH_Module_03\Modelling folder.
- Project CRS: Click the drop down menu and select 'Project CRS: EPSG:32760 - WGS 84 / UTM zone 60S’.
- TUFLOW HPC Executable: Click '...', and navigate to the exe\TUFLOW\2025.0.2 folder. Select TUFLOW_iSP_w64.exe.
- TUFLOW FV Executable: Click '...', and navigate to the exe\TUFLOWFV\2025.0.0 folder. Select TUFLOWFV.exe.
- Default GIS Format: Click the drop down menu and select 'SHP'.
- Tick on 'Setup Control File Templates'.
- Control File Templates: Click '...', and tick on: Water Quality Control file (.fvwq) and Sediment Control file (.fvsed). Ensure all other files are ticked off.
- Click 'Run'. Once the tool has finished click 'Close'.
File:Image of tool dialog
Water Quality Control File (FVWQ)
- Navigate to the Modelling\TUFLOWFV\wqm folder and open TC03_001.fvwq in a text editor.
- In the 'Simulation Controls' sections, update the following commands:
Simulation Class == DO ! Specify the simulation class to Dissolved Oxygen
WQ dt == 300 ! Interval for updating the water quality module
WQ Units == mgL ! Specify the units to be mgL
- In the 'Constituent Model Settings', add the following commands to do what? .
Oxygen Model == O2 ! ??
- Oxygen Min Max == 0.0, 12.0 ! ??
- Oxygen Benthic == 4.7, 1.08 ! ??
Pathogen Model == Free, Ecoli ! ??
- Alive Min Max == 0.0, 1e7 ! ??
- Mortality == 0.08, 2e-12, 6.1, 1.0, 1.11 ! ??
- Visible Inactivation == 0.082, 0.0067, 0.5 ! ??
- UVA Inactivation == 0.5, 0.0067, 0.5 ! ??
- UVB Inactivation == 1.0, 0.0067, 0.5 ! ??
- Settling == -0.03 ! ??
- Oxygen Min Max == 0.0, 12.0 ! ??
- In the 'Material Specifications' section, add the following material blocks to specify oxygen flux for each material ID.
Material == Default ! ??
- Oxygen Flux == -1400.0
Material == 1 ! ??
- Oxygen Flux == -1100.0
Material == 2 ! ??
- Oxygen Flux == -1200.0
Material == 3 ! ??
- Oxygen Flux == -1300.0
- Oxygen Flux == -1400.0
- Save the FVWQ.
Sediment Transport Control File (FVSED)
- Navigate to the Modelling\TUFLOWFV\stm folder and open TC03_001.fvsed in a text editor.
- Update the following command to match the output interval for the rest of the model (300secs or 5mins):
Update dt == 300 ! Interval for updating the sediment transport module
- In the 'Settings' section, update the following commands: more info ?
Erosion Depth Limits == 0.1, 0.5 ! Depth limits within which the erosion rate is scaled down (meters)
Deposition Depth Limits == 0.1, 0.5 ! Depth limits within which the deposition rate is scaled down (meters)
Bed Roughness Model == ks ! ??
Bed Roughness Parameters == 0.02, 0.02 ! ??
- In the 'Fractions' section, add in the following Fraction block to set the parameters for clay.
Fraction == Clay ! ??
- d50 == 0.0002 ! Specify the median grain size of the sediment fraction (meters)
- Particle Density == 2650.0 ! Specify the density of the particle group (kg/m^3)
- Settling Model == Constant ! ??
- Settling Parameters == 1e-05 ! ??
- Critical Stress Model == Constant ! ??
- Critical Stress Parameters == 0.15 ! Specify value that ?? must exceed to erode
- Erosion Model == Mehta ! ??
- Erosion Parameters == 0.01, 0.5, 1.0 ! ??
- Deposition Model == ws0 ! ??
- d50 == 0.0002 ! Specify the median grain size of the sediment fraction (meters)
- In the 'Materials' section, add the following material blocks to set the sediment transport properties for each material ID??.
Material == 1, 2 ! ??
- Nlayer == 1 ! Number of sediment bed layers?
- Layer == 1 ! Bed layer number?
- Dry Density == 800 ! Dry density of bed layer (kg/m^3)
- Initial Mass == 1500 ! Initial mass of each sediment fraction (kg/m^2)
- Dry Density == 800 ! Dry density of bed layer (kg/m^3)
- End Layer
Material == 3 ! ??
- Nlayer == 1 ! Number of sediment bed layers?
- Layer == 1 ! Bed layer number?
- Dry Density == 800 ! Dry density of bed layer (kg/m^3)
- Initial Mass == 3200 ! Initial mass of each sediment fraction (kg/m^2)
- Dry Density == 800 ! Dry density of bed layer (kg/m^3)
- End Layer
- Nlayer == 1 ! Number of sediment bed layers?
- Save the FVSED.
TUFLOW CATCH Control File (TCC)
intro...
The TUFLOW CATCH QGIS plugin has created a .tcc template file populated with .... Including adding the exe file paths.
Global Settings
Applied to the whole simulation. more info
- Navigate to the TUFLOW_CATCH_Module_01\Modelling\TUFLOWCatch\runs folder and open TC01_001.tcc into a text editor.
- In the 'Simulation Settings' section, update the time commands:
Start Time == 01/01/2021 10:00:00 ! Specifies the simulation start time
End Time == 01/01/2021 13:00:00 ! Specifies the simulation end time
- In the 'Boundary Condition Configuration' section, update the BC and CSV output intervals:
Catch BC Output Interval Nodestring == 300 ! Outputs BC nodestring data every 300 seconds
Catch BC Output Interval Lateral == 300 ! Outputs BC lateral data every 300 seconds
CSV Write Frequency Day == 0.01 ! Writes CSV output every 0.01 days
Catchment Hydraulic Model
Hydraulic model specific commands - similar to TUFLOW tcf
- Set the catchment hydraulic model:
Catchment Hydraulic Model == HPC - 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.
Zero Date == 01/01/2021 10:00 ! Specifies the simulation start time in TUFLOW FV ISODATE format
- In the 'GIS' section, update the following commands:
GIS Format == SHP ! Specify SHP as the output format
TIF Projection == ..\..\TUFLOW\model\grid\DEM.tif ! Sets the GIS projection for the output grid files
SHP Projection? caused errors I think - In the 'Solver' section, set the timestep maximum and time format:
Timestep Maximum == 2.5 ! Specifies a maximum timestep (seconds)
Time Format == TUFLOWFV ! Specifies the time format of output results
Pollutant Export Model
Receiving Model
For this tutorial, leave all commands as is. This section of the .tcc will be discussed in the next tutorial.
Running the Simulation
Troubleshooting
See tips on common mistakes and troubleshooting steps if the model doesn't run:
Results Output
Complete the steps outlined in the following links to review simulation results from the TUFLOW CATCH pollutant export model simulation:
TUFLOW CATCH Tutorial 03 Results