Tutorial Module01 Archive - Revision history

Anne.Kolega: /* Set GIS Projection and Create Empty (Template) GIS Files */ i.e.

2026-04-02T02:01:16Z

Set GIS Projection and Create Empty (Template) GIS Files: i.e.

← Older revision		Revision as of 12:01, 2 April 2026
Line 68:		Line 68:

	=== Set GIS Projection and Create Empty (Template) GIS Files ===		=== Set GIS Projection and Create Empty (Template) GIS Files ===
	The first step when creating a TUFLOW model always requires the user to define the GIS projection (ie. the geographic coordinate system to be used for the TUFLOW model) and also write template GIS files for future model inputs.<br>		The first step when creating a TUFLOW model always requires the user to define the GIS projection (i.e. the geographic coordinate system to be used for the TUFLOW model) and also write template GIS files for future model inputs.<br>
	''Note: All model inputs will need to use a common projection.''		''Note: All model inputs will need to use a common projection.''

Anne.Kolega: /* Set Model Controls */ e.g.

2026-04-01T22:13:40Z

Set Model Controls: e.g.

Anne.Kolega: /* Define the Materials (Surface Roughness) */ e.g.

2026-04-01T22:13:03Z

Define the Materials (Surface Roughness): e.g.

← Older revision		Revision as of 08:13, 2 April 2026
Line 217:		Line 217:
	<br>		<br>
	=== Define the Materials (Surface Roughness) ===		=== Define the Materials (Surface Roughness) ===
	Surface roughness or bed resistance values (eg. Manning’s n) are assigned to Materials values. The '''Module_Data\Module_01\''' folder already contains the materials table that we’ll use. We will review these in a GIS package, please select one of:		Surface roughness or bed resistance values (e.g. Manning’s n) are assigned to Materials values. The '''Module_Data\Module_01\''' folder already contains the materials table that we’ll use. We will review these in a GIS package, please select one of:

	* <u>[[Tute_M01_Materials_MI_Archive\|Mapinfo]]</u>		* <u>[[Tute_M01_Materials_MI_Archive\|Mapinfo]]</u>

Pavlina Monhartova at 06:04, 18 April 2025

2025-04-18T06:04:22Z

← Older revision		Revision as of 16:04, 18 April 2025
Line 511:		Line 511:
	*<u>[[Save_Date_Error_Archive\|Save date of .tab file is later than .mif or .mid]]</u><br>		*<u>[[Save_Date_Error_Archive\|Save date of .tab file is later than .mif or .mid]]</u><br>
	*<u>[[Tutorial_Troubleshoot_2014\|ERROR 2014 - No active cells within SA inflow polygon]]</u>		*<u>[[Tutorial_Troubleshoot_2014\|ERROR 2014 - No active cells within SA inflow polygon]]</u>
	*<u>[[~~Only_TUFLOW_DOS_Window_Archive~~ \| Why does the TUFLOW console window open, though the TCF isn’t read and the simulation doesn’t execute?]]</u>		*<u>[[Only_TUFLOW_Console_Window_Archive \| Why does the TUFLOW console window open, though the TCF isn’t read and the simulation doesn’t execute?]]</u>

	== Advanced - Model Resolution (Optional) ==		== Advanced - Model Resolution (Optional) ==

Pavlina Monhartova at 04:42, 17 April 2025

2025-04-17T04:42:37Z

Emilie Nielsen: /* Troubleshooting for GPU Simulation */

2025-02-20T06:32:12Z

Troubleshooting for GPU Simulation

← Older revision		Revision as of 16:32, 20 February 2025
Line 601:		Line 601:
	</ol>		</ol>
	<br>		<br>
	If you experience an issue that is not detailed above please send an email to support@tuflow.com<br>		If you experience an issue that is not detailed above please send an email to [mailto:support@tuflow.com support@tuflow.com]<br>

Emilie Nielsen: /* Troubleshooting */

2025-02-20T06:32:02Z

Troubleshooting

← Older revision		Revision as of 16:32, 20 February 2025
Line 507:		Line 507:

	==Troubleshooting==		==Troubleshooting==
	This section contains links to some common issues that may occur when progressing through the first module of the TUFLOW tutorial model. If you experience an issue that is not detailed on here please either send an email to support@tuflow.com.<br>		This section contains links to some common issues that may occur when progressing through the first module of the TUFLOW tutorial model. If you experience an issue that is not detailed on here please either send an email to [mailto:support@tuflow.com support@tuflow.com].<br>

	*<u>[[Save_Date_Error_Archive\|Save date of .tab file is later than .mif or .mid]]</u><br>		*<u>[[Save_Date_Error_Archive\|Save date of .tab file is later than .mif or .mid]]</u><br>

Pavlina Monhartova at 01:50, 22 January 2025

2025-01-22T01:50:44Z

← Older revision		Revision as of 11:50, 22 January 2025
Line 463:		Line 463:

	=== TUFLOW Messages Layers ===		=== TUFLOW Messages Layers ===
	TUFLOW writes a number of messages, in increasing order of severity these are: Check --> Warning --> Error. Each of the messages generated by TUFLOW has a four digit ID code. A description of each of these messages is given in the message database section of this wiki: <u>[[~~TUFLOW_Message_How_To~~ \| (TUFLOW Messages Database)]]</u>.		TUFLOW writes a number of messages, in increasing order of severity these are: Check --> Warning --> Error. Each of the messages generated by TUFLOW has a four digit ID code. A description of each of these messages is given in the message database section of this wiki: <u>[[TUFLOW_Messages \| (TUFLOW Messages Database)]]</u>.
	When a numerical model such as TUFLOW struggles to converge to a solution, spurious results such as negative depths can be generated. When this occurs TUFLOW creates a warning and writes this to the _messages.csv file and also to a GIS file. This can be opened in excel, or your GIS package.		When a numerical model such as TUFLOW struggles to converge to a solution, spurious results such as negative depths can be generated. When this occurs TUFLOW creates a warning and writes this to the _messages.csv file and also to a GIS file. This can be opened in excel, or your GIS package.
	<ol>		<ol>

Abigail.lillo: /* Advanced - HPC Solver (Optional) */

2024-10-10T01:23:20Z

Advanced - HPC Solver (Optional)

← Older revision		Revision as of 11:23, 10 October 2024
Line 559:		Line 559:

	== Advanced - HPC Solver (Optional) ==		== Advanced - HPC Solver (Optional) ==
	This section will introduce how to run the model TUFLOW’s HPC (Heavily Parallelised Compute) solver, and how to fix some common issues that may occur when trying to run a simulation using Graphics Processing Unit (GPU) hardware.		This section will introduce how to run the model TUFLOW’s HPC (Heavily Parallelised Compute) solver, and how to fix some common issues that may occur when trying to run a simulation using Graphics Processing Unit (GPU) hardware. Please see [[HPC_Features_Archive \| HPC Features Archive]] for more information on TUFLOW HPC features supported in the 2017 release.

	TUFLOW HPC can run between 10 and 100 times faster than TUFLOW Classic using NVidia Graphics Processing Units (GPU)(depending on the model configuration and hardware performance). <br><br>		TUFLOW HPC can run between 10 and 100 times faster than TUFLOW Classic using NVidia Graphics Processing Units (GPU)(depending on the model configuration and hardware performance). <br><br>

Emilie Nielsen at 00:35, 23 September 2024

2024-09-23T00:35:42Z

← Older revision		Revision as of 08:13, 2 April 2026
Line 334:		Line 334:
	== TUFLOW Simulation Control File (TCF) Updates ==		== TUFLOW Simulation Control File (TCF) Updates ==
	=== Set Model Controls ===		=== Set Model Controls ===
	This is the last step before running the simulation. Once this step has been completed, most of the ~~ground work~~ has been completed. Subsequent modules build upon this base.		This is the last step before running the simulation. Once this step has been completed, most of the groundwork has been completed. Subsequent modules build upon this base.

	<ol>		<ol>
Line 342:		Line 342:
	:<font color="blue"><tt>End Time </tt></font> <font color="red"><tt>==</tt></font><tt> 3</tt><font color="green"><tt> ! End Simulation a 3 hours</tt></font><br>		:<font color="blue"><tt>End Time </tt></font> <font color="red"><tt>==</tt></font><tt> 3</tt><font color="green"><tt> ! End Simulation a 3 hours</tt></font><br>
	:<font color="blue"><tt>Timestep </tt></font> <font color="red"><tt>==</tt></font><tt> 1.5</tt><font color="green"><tt> ! Use a 2D timestep of 1.5 seconds</tt></font><br>		:<font color="blue"><tt>Timestep </tt></font> <font color="red"><tt>==</tt></font><tt> 1.5</tt><font color="green"><tt> ! Use a 2D timestep of 1.5 seconds</tt></font><br>
	:<font color="blue"><tt>Log Folder </tt></font> <font color="red"><tt>==</tt></font><tt> Log</tt><font color="green"><tt> ! Redirects log output (eg. .tlf and _messages GIS layers to the folder "log"</tt></font>		:<font color="blue"><tt>Log Folder </tt></font> <font color="red"><tt>==</tt></font><tt> Log</tt><font color="green"><tt> ! Redirects log output (e.g. .tlf and _messages GIS layers to the folder "log"</tt></font>
	:<font color="blue"><tt>Output Folder </tt></font> <font color="red"><tt>==</tt></font><tt> ..\results\M01\2d\</tt><font color="green"><tt> ! Redirects results files to TUFLOW\Results\M01\2d\</tt></font>		:<font color="blue"><tt>Output Folder </tt></font> <font color="red"><tt>==</tt></font><tt> ..\results\M01\2d\</tt><font color="green"><tt> ! Redirects results files to TUFLOW\Results\M01\2d\</tt></font>
	:<font color="blue"><tt>Write Check Files </tt></font> <font color="red"><tt>==</tt></font><tt> ..\check\2d\</tt><font color="green"><tt> ! Specifies check files to be witten to TUFLOW\check\2d\</tt></font>		:<font color="blue"><tt>Write Check Files </tt></font> <font color="red"><tt>==</tt></font><tt> ..\check\2d\</tt><font color="green"><tt> ! Specifies check files to be witten to TUFLOW\check\2d\</tt></font>
Line 351:		Line 351:
	You do <u>not</u> need to add the comments, following the exclamation marks. These commands are generally self explanatory. However, for this tutorial model they are included. To clarify the purpose of each line.<br>		You do <u>not</u> need to add the comments, following the exclamation marks. These commands are generally self explanatory. However, for this tutorial model they are included. To clarify the purpose of each line.<br>
	The final command "Map Output Format" controls the output file format, this is discussed further in the results viewing section below.<br>		The final command "Map Output Format" controls the output file format, this is discussed further in the results viewing section below.<br>
	The TUFLOW simulation is now ready to be run for the first time.		The TUFLOW simulation is now ready to be run for the first time.
	</ol>		</ol>

← Older revision		Revision as of 14:42, 17 April 2025
Line 120:		Line 120:
	<br>		<br>
	<li> Start TUFLOW from a batch file using the TCF file we have created ('''M01_5m_001.tcf'''). Follow the steps outlined in, <u>[[Run TUFLOW From a Batch-file \| Running TUFLOW from a Batch-file]]</u> to create the batch file.		<li> Start TUFLOW from a batch file using the TCF file we have created ('''M01_5m_001.tcf'''). Follow the steps outlined in, <u>[[Run TUFLOW From a Batch-file \| Running TUFLOW from a Batch-file]]</u> to create the batch file.
	<li> Double click the created batch file (.bat) from Windows Explorer to execute the simulation. A console ~~(DOS)~~ window should appear as shown below:<br>		<li> Double click the created batch file (.bat) from Windows Explorer to execute the simulation. A console window should appear as shown below:<br>
	[[File:Tute M01 DOS Empties.png\|frame\|none]]		[[File:Tute M01 DOS Empties.png\|frame\|none]]
	<br>		<br>
Line 409:		Line 409:

	=== TUFLOW Log file ===		=== TUFLOW Log file ===
	The first place to look is at the final output in the ~~DOS~~ window. If you missed this, for example if the model was run in batch mode this information is contained in the TUFLOW Log File (.tlf). Earlier on we add the following command to the TCF:<br>		The first place to look is at the final output in the console window. If you missed this, for example if the model was run in batch mode this information is contained in the TUFLOW Log File (.tlf). Earlier on we add the following command to the TCF:<br>
	<font color="blue"><tt>Log Folder </tt></font> <font color="red"><tt>==</tt></font> <tt>Log</tt><br>		<font color="blue"><tt>Log Folder </tt></font> <font color="red"><tt>==</tt></font> <tt>Log</tt><br>

Line 511:		Line 511:
	*<u>[[Save_Date_Error_Archive\|Save date of .tab file is later than .mif or .mid]]</u><br>		*<u>[[Save_Date_Error_Archive\|Save date of .tab file is later than .mif or .mid]]</u><br>
	*<u>[[Tutorial_Troubleshoot_2014\|ERROR 2014 - No active cells within SA inflow polygon]]</u>		*<u>[[Tutorial_Troubleshoot_2014\|ERROR 2014 - No active cells within SA inflow polygon]]</u>
	*<u>[[Only_TUFLOW_DOS_Window_Archive \| Why does the TUFLOW ~~DOS~~ ~~Window~~ open, though the TCF isn’t read and the simulation doesn’t execute?]]</u>		*<u>[[Only_TUFLOW_DOS_Window_Archive \| Why does the TUFLOW console window open, though the TCF isn’t read and the simulation doesn’t execute?]]</u>

	== Advanced - Model Resolution (Optional) ==		== Advanced - Model Resolution (Optional) ==
Line 582:		Line 582:
	===Results===		===Results===
	Using the methods described above in the <u>[[Tutorial_Module01_Archive#Viewing_Results \| Viewing Results]]</u> section.		Using the methods described above in the <u>[[Tutorial_Module01_Archive#Viewing_Results \| Viewing Results]]</u> section.
	* Check the simulation logs in the ~~DOS~~ window, .tlf and .hpc.tlf log files.		* Check the simulation logs in the console window, .tlf and .hpc.tlf log files.
	* View the results in your preferred package.		* View the results in your preferred package.
	Do the logs and results appear different? Did the simulation run faster using the GPU hardware? For more information about computer hardware and simulation speed, please refer to the <u>[[Hardware_Benchmarking \| Hardware Benchmarking Page]]</u>.		Do the logs and results appear different? Did the simulation run faster using the GPU hardware? For more information about computer hardware and simulation speed, please refer to the <u>[[Hardware_Benchmarking \| Hardware Benchmarking Page]]</u>.

← Older revision		Revision as of 10:35, 23 September 2024
Line 31:		Line 31:

	<ol>		<ol>
	<li>Set up the model directory and sub-directories as recommended in the list below (for a more detailed description please ~~see~~ ~~the Folders and Filepath Section of~~ the <u>[https://~~www~~.tuflow.com/~~Tuflow%20Documentation.aspx%7CTUFLOW~~ ~~User~~ Manual])</u>. Alternatively, you can copy the TUFLOW folder and all sub-folders from the TUFLOW Folders Template folder in the supplied files to a local drive on your computer.<br>		<li>Set up the model directory and sub-directories as recommended in the list below (for a more detailed description, please refer to the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u>). Alternatively, you can copy the TUFLOW folder and all sub-folders from the TUFLOW Folders Template folder in the supplied files to a local drive on your computer.<br>
	''* If using SMS, the folder structure listed above is automatically created before running the model using the "Export TUFLOW files" command (see <u>[[Run TUFLOW from within SMS\|Run TUFLOW from within SMS]]</u>).		''* If using SMS, the folder structure listed above is automatically created before running the model using the "Export TUFLOW files" command (see <u>[[Run TUFLOW from within SMS\|Run TUFLOW from within SMS]]</u>).
	<br>		<br>
Line 108:		Line 108:

	=== Run TUFLOW to Create Empty (Template) GIS Files===		=== Run TUFLOW to Create Empty (Template) GIS Files===
	We now need to run TUFLOW using the TUFLOW Control File (TCF). There are a number of ways TUFLOW can be setup to run. In each case the TUFLOW executable is started with the TCF as the input. For more information on running TUFLOW please refer to ~~the ''Managing and Starting Simulations'' section of~~ the <u>[https://~~www~~.tuflow.com/~~Tuflow%20Documentation.aspx%7CTUFLOW~~ ~~User~~ Manual]</u>. The most common ways are outlined below. We will be using a batch file for this tutorial, however any of the methods below will work.		We now need to run TUFLOW using the TUFLOW Control File (TCF). There are a number of ways TUFLOW can be setup to run. In each case the TUFLOW executable is started with the TCF as the input. For more information on running TUFLOW please refer to the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u>. The most common ways are outlined below. We will be using a batch file for this tutorial, however any of the methods below will work.

	<ol>		<ol>
Line 169:		Line 169:
	=== Define Elevations ===		=== Define Elevations ===
	In the previous section, the extent and dimensions of the 2D domain were defined. We now need to assign elevations at each 2D cell centre, mid-side and corner. These points are known as Zpts.<br>		In the previous section, the extent and dimensions of the 2D domain were defined. We now need to assign elevations at each 2D cell centre, mid-side and corner. These points are known as Zpts.<br>
	Knowledge of 2D domain geometry is fundamental to understanding how TUFLOW works. A brief description on the computational function of each of the Zpts in a TUFLOW cell is given in the <u>[[Zpt_Description \| Zpt Description]]</u> page. ~~It is also highly recommended to read the ''2D Model domain Schematisation'' Section of the~~ ~~<u>[https://www.tuflow.com/Tuflow%20Documentation.aspx%7CTUFLOW User Manual]</u>.~~<br>		Knowledge of 2D domain geometry is fundamental to understanding how TUFLOW works. A brief description on the computational function of each of the Zpts in a TUFLOW cell is given in the <u>[[Zpt_Description \| Zpt Description]]</u> page. <br>
	<br>		<br>
	There are two methods to assign the elevations to the Zpts. The first is to directly input the elevation model into TUFLOW as either a TIN or gridded DEM dataset. TUFLOW will assign the elevations from the elevation dataset to Zpts within the DEM / TIN. This offers the following benefits:<br>		There are two methods to assign the elevations to the Zpts. The first is to directly input the elevation model into TUFLOW as either a TIN or gridded DEM dataset. TUFLOW will assign the elevations from the elevation dataset to Zpts within the DEM / TIN. This offers the following benefits:<br>
Line 554:		Line 554:
	The model performs better with a smaller cell size, as the 5m resolution is a bit too coarse for representing the narrow in-bank flowpath in a 2D manner. In Module 3 we will overcome this issue by modelling the creek using a 1D model, which will be dynamically linked with the 2D model.<br>		The model performs better with a smaller cell size, as the 5m resolution is a bit too coarse for representing the narrow in-bank flowpath in a 2D manner. In Module 3 we will overcome this issue by modelling the creek using a 1D model, which will be dynamically linked with the 2D model.<br>
	<br>		<br>
	It is worth noting the increase in runtime, by halving the cell size by a factor of 2, we have four times as many cells (each 5m x 5m cell is now four 2.5m x 2.5m cells), we also needed to reduce the timestep, as the Courant number is directly related to cell size (refer to the TUFLOW ~~manual~~) this would normally be reduced by a factor 2 as well. This translates to an approximate increase in runtime of 8 (four times the number of cells and half the timestep). Choosing an appropriate cell size that allows representation of the hydraulics whilst resulting in realistic run times is an important part of the modelling process. With some planning you should be able to avoid a model that requires excessive run times!<br>		It is worth noting the increase in runtime, by halving the cell size by a factor of 2, we have four times as many cells (each 5m x 5m cell is now four 2.5m x 2.5m cells), we also needed to reduce the timestep, as the Courant number is directly related to cell size (refer to the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u>) this would normally be reduced by a factor 2 as well. This translates to an approximate increase in runtime of 8 (four times the number of cells and half the timestep). Choosing an appropriate cell size that allows representation of the hydraulics whilst resulting in realistic run times is an important part of the modelling process. With some planning you should be able to avoid a model that requires excessive run times!<br>
	<br>		<br>
	The following Wiki page gives some guidance on <u>[[Estimating_Runtimes \| estimating model runtimes]]</u> based on the model area and cell size.		The following Wiki page gives some guidance on <u>[[Estimating_Runtimes \| estimating model runtimes]]</u> based on the model area and cell size.