TUFLOW CATCH Tutorial M01 - Revision history

Emilie Nielsen: /* Running the Simulation */

2026-03-30T02:07:38Z

Running the Simulation

← Older revision		Revision as of 12:07, 30 March 2026
Line 264:		Line 264:
	<li>Save a copy of '''Demonstration.bat''' as '''_run_TC01_CATCH.bat''' and open the file in a text editor.		<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>		<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~~.1.0\TUFLOWCATCH.exe"</tt><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>		<tt><font color="orange">%exe%</font> TC01_001.tcc</tt>
	<li>Double click the batch file in file explorer to run the simulation.		<li>Double click the batch file in file explorer to run the simulation.

Emilie Nielsen: /* Simulation Control Files */

2026-03-30T01:28:07Z

Simulation Control Files

← Older revision		Revision as of 11:28, 30 March 2026
Line 97:		Line 97:
	<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>		<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>		<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.		<li> Save the TGC.
	</ol>		</ol>

Emilie Nielsen: /* TUFLOW CATCH Control File (TCC) */

2026-02-02T03:26:16Z

TUFLOW CATCH Control File (TCC)

← Older revision		Revision as of 13:26, 2 February 2026
Line 126:		Line 126:
	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:		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>		<ol>
	<li> Global ~~commands~~		<li> Global settings
	<li> Catchment Hydraulic Model (TUFLOW HPC) commands		<li> Catchment Hydraulic Model (TUFLOW HPC) commands
	<li> Catchment Pollutant Export Model		<li> Catchment Pollutant Export Model

Emilie Nielsen: /* Catchment Hydraulic Model (TUFLOW HPC) */

2026-01-29T04:24:01Z

Catchment Hydraulic Model (TUFLOW HPC)

← Older revision		Revision as of 14:24, 29 January 2026
Line 178:		Line 178:
	<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>		<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 ~~define~~ the soil ~~parameters:~~<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="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>		<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>

Emilie Nielsen: /* Catchment Hydraulic Model (TUFLOW HPC) */

2026-01-29T04:09:38Z

Catchment Hydraulic Model (TUFLOW HPC)

← Older revision		Revision as of 14:09, 29 January 2026
Line 180:		Line 180:
	<li> In the 'Soils' section, reference the soils file (.tsoilf), and define the soil parameters:<br>		<li> In the 'Soils' section, reference the soils file (.tsoilf), and define the soil parameters:<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="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="blue">Soil Negative Rainfall Approach</font><font color="red"> == </font>FACTOR <font color="green"> </font></tt><br>
	<tt><font color="blue">Soil Negative Rainfall Factor</font><font color="red"> == </font>0.2 <font color="green"> </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>		<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>

Emilie Nielsen: /* TUFLOW Boundary Condition Database (bc_dbase) */

2026-01-29T04:08:53Z

TUFLOW Boundary Condition Database (bc_dbase)

← Older revision		Revision as of 14:08, 29 January 2026
Line 53:		Line 53:

	= TUFLOW Boundary Condition Database (bc_dbase) =		= 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>.
⚫	~~Update~~ the ~~bc_dbase with a~~ reference to the timeseries temperature data:
	<ol>		<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>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.
Line 61:		Line 61:
	<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> 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 ~~add~~ the ~~reference~~ to the ~~timeseries~~ ~~temperature~~ ~~data~~ as ~~shown~~ ~~below:<br>~~		<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>		<br>
	[[File: ~~TC1_bc_dbase_01a~~.png]]<br>		[[File: TC1_bc_dbase_01b.png]]<br>
	<br>		<br>
	<li> Save the bc_dbase.		<li> Save the bc_dbase.

Pavlina Monhartova: /* Conclusion */

2025-10-23T06:07:55Z

Conclusion

← Older revision		Revision as of 16:07, 23 October 2025
Line 308:		Line 308:
	* Check files were used to review the transfer from the Catchment Hydraulic model (TUFLOW HPC) into the receiving polygon.		* 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.		* 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>		* 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>		<br>
	{{Tips Navigation		{{Tips Navigation

Pavlina Monhartova: /* Conclusion */

2025-10-23T06:06:40Z

Conclusion

← Older revision		Revision as of 16:06, 23 October 2025
Line 308:		Line 308:
	* Check files were used to review the transfer from the Catchment Hydraulic model (TUFLOW HPC) into the receiving polygon.		* 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.		* 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>		<br>
	{{Tips Navigation		{{Tips Navigation

Emilie Nielsen: /* Catchment Hydraulic Model (TUFLOW HPC) */

2025-07-02T23:24:34Z

Catchment Hydraulic Model (TUFLOW HPC)

← Older revision		Revision as of 09:24, 3 July 2025
Line 188:		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>		<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 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 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">Map Cutoff Depth</font><font color="red"> == </font>0.05 <font color="green"> ! Sets map cutoff depth (meters)</font></tt><br>

Emilie Nielsen: /* Reviewing Model Performance */

2025-07-02T23:23:00Z

Reviewing Model Performance

← Older revision		Revision as of 09:23, 3 July 2025
Line 280:		Line 280:
	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>		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>		* '''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_01a~~.png]]<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>		* '''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>		:[[File: TC1_catchlog_02a.png]]<br>
	* '''Run Status:''' At the end of the file, a message will confirm the simulation outcome.		* '''Run Status:''' At the end of the file, a message will confirm the simulation outcome.
	:* If successful, it will state 'Run Successful'<br>		:* If successful, it will state 'Run Successful'<br>
	::[[File: ~~TC1_catchlog_03a~~.png]]<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.		:* 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>		::'''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_04a~~.png]]<br>		::[[File: TC1_catchlog_04c.png]]<br>
	<br>

	===Other Log Files===		===Other Log Files===