Tutorial Module04 Archive - Revision history

Anne.Kolega: /* ESTRY Control File (ECF) */ e.g.

2026-04-01T22:21:34Z

ESTRY Control File (ECF): e.g.

← Older revision		Revision as of 08:21, 2 April 2026
Line 157:		Line 157:
	'''SMS''' users do not need to modify the control files manually because the control cards/files are automatically generated by SMS while exporting TUFLOW files. Follow ''[[Tute_M04_SMS_Simulation_Setup_Archive\|these steps to Setup the Simulation]]''.<br>		'''SMS''' users do not need to modify the control files manually because the control cards/files are automatically generated by SMS while exporting TUFLOW files. Follow ''[[Tute_M04_SMS_Simulation_Setup_Archive\|these steps to Setup the Simulation]]''.<br>

	For all other model development platforms (eg. ArcGIS, QGIS, MapInfo etc.)<br>		For all other model development platforms (e.g. ArcGIS, QGIS, MapInfo etc.)<br>
	<ol>		<ol>
	<li>Navigate to the '''M04_1d_001.ecf''' tab or open this file.</li>		<li>Navigate to the '''M04_1d_001.ecf''' tab or open this file.</li>
Line 232:		Line 232:
	==Boundary Database (bc_dbase)==		==Boundary Database (bc_dbase)==
	The revised boundary data has been provided for this tutorial. This includes the stage-discharge boundary for the weir at the downstream end of the model. <br>		The revised boundary data has been provided for this tutorial. This includes the stage-discharge boundary for the weir at the downstream end of the model. <br>
	Copy the '''bc_dbase_M04.csv''' and '''Weir_HQ.csv''' for the '''Module_Data\Module_4''' into the '''TUFLOW\bc_dbase\''' folder.~~</li>~~		Copy the '''bc_dbase_M04.csv''' and '''Weir_HQ.csv''' for the '''Module_Data\Module_4''' into the '''TUFLOW\bc_dbase\''' folder.

	=Run the Simulation=		=Run the Simulation=

Abrar.Alttahir: /* 1D Cross-Sections */

2025-09-29T03:22:21Z

1D Cross-Sections

← Older revision		Revision as of 13:22, 29 September 2025
Line 29:		Line 29:
	As with Modules 2 and 3 the GIS inputs are demonstrated in ArcGIS, MapInfo, SMS and QGIS. At each stage please select your GIS package for instructions.		As with Modules 2 and 3 the GIS inputs are demonstrated in ArcGIS, MapInfo, SMS and QGIS. At each stage please select your GIS package for instructions.
	==1D Cross-Sections==		==1D Cross-Sections==
	A 1D model requires cross-sections for processing of the channel geometry. There are a number of different formats for cross-sections to be input to TUFLOW. In this module we will be using an offset-elevation approach (XZ). This is a typical format for inputting cross-sections however, other options include height-width (HW) and MIKE11 format inputs. These are not covered in this tutorial, however the general process is very similar. To save time, the locations and XZ profiles for the 1D cross sections are provided. The XZ profiles were automatically extracted from the DEM triangulation using the 12D software (www.12d.com) with the aid of the TUFLOW utility ~~12da_to_from_mif~~.exe using the -xs option (see [[~~12da_to_from_mif~~ \| ~~12da_to_from_mif~~ wiki page]]). The SMS TUFLOW interface has a similar and easier process, noting that a licence for the SMS TUFLOW interface is required to save the cross-sections. It is more common for this information to come from surveyed cross-sections. If the survey has been provided as x-y-z points, or a a GIS layer of points, the xs_Generator utility can be used to create the cross-sections in a TUFLOW format. The xs_Generator utility is described in the [[XsGenerator \|XsGenerator wiki page]].<br>		A 1D model requires cross-sections for processing of the channel geometry. There are a number of different formats for cross-sections to be input to TUFLOW. In this module we will be using an offset-elevation approach (XZ). This is a typical format for inputting cross-sections however, other options include height-width (HW) and MIKE11 format inputs. These are not covered in this tutorial, however the general process is very similar. To save time, the locations and XZ profiles for the 1D cross sections are provided. The XZ profiles were automatically extracted from the DEM triangulation using the 12D software (www.12d.com) with the aid of the TUFLOW utility 12da_to_from_GIS.exe using the -xs option (see [[12da_to_from_GIS \| 12da_to_from_GIS wiki page]]). The SMS TUFLOW interface has a similar and easier process, noting that a licence for the SMS TUFLOW interface is required to save the cross-sections. It is more common for this information to come from surveyed cross-sections. If the survey has been provided as x-y-z points, or a a GIS layer of points, the xs_Generator utility can be used to create the cross-sections in a TUFLOW format. The xs_Generator utility is described in the [[XsGenerator \|XsGenerator wiki page]].<br>
	<br>		<br>
	For each cross-section there is an individual comma separated variable (.csv) file. The 1d_xs layer contains a link to the source .csv file at every cross-section location. <br>		For each cross-section there is an individual comma separated variable (.csv) file. The 1d_xs layer contains a link to the source .csv file at every cross-section location. <br>

Pavlina Monhartova at 06:05, 18 April 2025

2025-04-18T06:05:44Z

← Older revision		Revision as of 16:05, 18 April 2025
Line 288:		Line 288:
	*[[TUFLOW_Message_2060 \| Error 2060 - Could not find a CN connection snapped to the end of HX line]]		*[[TUFLOW_Message_2060 \| Error 2060 - Could not find a CN connection snapped to the end of HX line]]
	*[[TUFLOW_Message_2024 \| Error 2024 - Could not find a 1D node snapped to CN line.]]		*[[TUFLOW_Message_2024 \| Error 2024 - Could not find a 1D node snapped to CN line.]]
	*[[~~Only_TUFLOW_DOS_Window_Archive~~ \| Why does the TUFLOW console window open, though the TCF isn’t read and the simulation doesn’t execute?]]		*[[Only_TUFLOW_Console_Window_Archive \| Why does the TUFLOW console window open, though the TCF isn’t read and the simulation doesn’t execute?]]

	= Advanced - HPC Solver (Optional) =		= Advanced - HPC Solver (Optional) =

Pavlina Monhartova at 04:44, 17 April 2025

2025-04-17T04:44:07Z

Emilie Nielsen: /* Troubleshooting */

2025-02-20T06:30:38Z

Troubleshooting

← Older revision		Revision as of 16:30, 20 February 2025
Line 281:		Line 281:
	If the TUFLOW simulation fails to start TUFLOW will output the error in a number of locations. Firstly, check the Console Window or the TUFLOW Log File (.tlf) (located in the '''TUFLOW\runs\log\''' folder with the name '''M04_5m_001.tlf'''). This file can be opened in a text editor and the error is generally located at the end of the file. You can however search for "Error" if you can not see the error. In most cases there is also a spatial location for the error message (if the error reported in the log file is prefixed by XY:). To check the location of the geographic errors, open the '''M04_5m_001_messages.mif''' or '''M04_5m_001_messages_P.shp''' file in your GIS package.<br>		If the TUFLOW simulation fails to start TUFLOW will output the error in a number of locations. Firstly, check the Console Window or the TUFLOW Log File (.tlf) (located in the '''TUFLOW\runs\log\''' folder with the name '''M04_5m_001.tlf'''). This file can be opened in a text editor and the error is generally located at the end of the file. You can however search for "Error" if you can not see the error. In most cases there is also a spatial location for the error message (if the error reported in the log file is prefixed by XY:). To check the location of the geographic errors, open the '''M04_5m_001_messages.mif''' or '''M04_5m_001_messages_P.shp''' file in your GIS package.<br>
	<br>		<br>
	This section contains links to some possible problems that may occur when progressing through the fourth tutorial module. If you experience an issue that is not detailed, please email support@tuflow.com ~~or add and describe the problem on the <u>[[Talk%3ATutorial_Module04_Archive \| discussion page~~.]~~]</u>~~<br>		This section contains links to some possible problems that may occur when progressing through the fourth tutorial module. If you experience an issue that is not detailed, please email [mailto:support@tuflow.com support@tuflow.com].<br>

	*[[Save_Date_Error_Archive\|Save date of .tab file is later than .mif or .mid]]		*[[Save_Date_Error_Archive\|Save date of .tab file is later than .mif or .mid]]

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

2024-10-10T01:35:23Z

Advanced - HPC Solver (Optional)

← Older revision		Revision as of 11:35, 10 October 2024
Line 291:		Line 291:

	= 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).		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).

Emilie Nielsen at 00:32, 23 September 2024

2024-09-23T00:32:05Z

← Older revision		Revision as of 10:32, 23 September 2024
Line 50:		Line 50:

	==1D Channels==		==1D Channels==
	Now that we have looked at the cross section data, we must add 1D channels for the 1D network. In TUFLOW, cross sections can either be located at the ends of each channel reach, or at some point along the reach. The way that TUFLOW uses the cross-section depends upon the location, for example a "centre" cross-section has a higher priority than "end" sections if both "End" and "Centre" sections are defined. For more information on the 1D topography, ~~you~~ ~~are encouraged~~ to ~~read~~ ~~Section 4~~.~~6 of the 2010~~ TUFLOW ~~manual~~.<br>		Now that we have looked at the cross section data, we must add 1D channels for the 1D network. In TUFLOW, cross sections can either be located at the ends of each channel reach, or at some point along the reach. The way that TUFLOW uses the cross-section depends upon the location, for example a "centre" cross-section has a higher priority than "end" sections if both "End" and "Centre" sections are defined. For more information on the 1D topography, please refer to the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u>.<br>
	<br>		<br>
	For this tutorial, we will locate most of the cross-sections at the ends of channels. There are a number of locations where a "centre" section will be used. The final channel will be a weir type channel; this represents a weir with a known stage-discharge curve. In later modules we will also use "centre" cross sections for the modelling of structures.<br>		For this tutorial, we will locate most of the cross-sections at the ends of channels. There are a number of locations where a "centre" section will be used. The final channel will be a weir type channel; this represents a weir with a known stage-discharge curve. In later modules we will also use "centre" cross sections for the modelling of structures.<br>
Line 63:		Line 63:

	==1D/2D Links==		==1D/2D Links==
	In this section we define lines where there is flow exchange between the 1D and 2D components of the model. At first it may seem slightly complicated, but it is actually very logical and the method allows the user to change the 2D cell size and orientation at a later stage without having to change the 1D/2D linking. Before we begin creating the link we will spend a bit of time describing how the link works. More details on the 1D/2D link can be found in ~~Section~~ 4.10.~~5 of the 2010~~ TUFLOW ~~manual~~.<br>		In this section we define lines where there is flow exchange between the 1D and 2D components of the model. At first it may seem slightly complicated, but it is actually very logical and the method allows the user to change the 2D cell size and orientation at a later stage without having to change the 1D/2D linking. Before we begin creating the link we will spend a bit of time describing how the link works. More details on the 1D/2D link can be found in the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u>.<br>
	<br>		<br>
	'''Description of linking concept'''<br>		'''Description of linking concept'''<br>
Line 258:		Line 258:
	[[File:Tute M04 results no 1d 02.jpg\|500px]]		[[File:Tute M04 results no 1d 02.jpg\|500px]]
	<br><br>		<br><br>
	If you look at the 1D results (by importing the time series (_TS.mif or _TS_P.shp from the 1D results folder, or opening the M04_5m_001_1d_Q.csv) the 1D channels are conveying flow. In order to get map output for the 1D we need to use Water Level Line (WLL) inputs. The underlying water level from the 1D model is displayed across this line and as such it should be digitised perpendicular to flow. The theory behind water level lines and their use is detailed in the ~~Water Level Lines section of the~~ TUFLOW Manual. <br>		If you look at the 1D results (by importing the time series (_TS.mif or _TS_P.shp from the 1D results folder, or opening the M04_5m_001_1d_Q.csv) the 1D channels are conveying flow. In order to get map output for the 1D we need to use Water Level Line (WLL) inputs. The underlying water level from the 1D model is displayed across this line and as such it should be digitised perpendicular to flow. The theory behind water level lines and their use is detailed in the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u>. <br>

	<li> For the purpose of this tutorial the 1D_WLL GIS inputs have been provided for you.<br>		<li> For the purpose of this tutorial the 1D_WLL GIS inputs have been provided for you.<br>

Emilie Nielsen at 03:12, 5 April 2024

2024-04-05T03:12:33Z

← Older revision		Revision as of 13:12, 5 April 2024
Line 235:		Line 235:

	=Run the Simulation=		=Run the Simulation=
	Using your preferred method for starting TUFLOW, run the recently created '''M04_5m_001.tcf'''. Please refer to [[Tutorial_Module01_Archive#~~Running_TUFLOW~~ \| ~~module~~ 1]] for a detailed description of the various methods for running a TUFLOW simulation.<br>		Using your preferred method for starting TUFLOW, run the recently created '''M04_5m_001.tcf'''. Please refer to <u>[[Tutorial_Module01_Archive#Run_Simulation \| Module 1]]</u> for a detailed description of the various methods for running a TUFLOW simulation.<br>
	If the model fails to start correctly please refer to the <u>[[Tutorial_Module04_Archive#Troubleshooting \|troubleshooting section]]</u> at the end of this page.<br>		If the model fails to start correctly please refer to the <u>[[Tutorial_Module04_Archive#Troubleshooting \|troubleshooting section]]</u> at the end of this page.<br>

Emilie Nielsen at 03:11, 5 April 2024

2024-04-05T03:11:27Z

← Older revision		Revision as of 13:11, 5 April 2024
Line 1:		Line 1:
	<ol>		<ol>
	=Introduction=		=Introduction=
	As discussed in Module 1 [[Tutorial_Module01_Archive#Reviewing_Model_Performance \| (discussion here)]], the main creek channel is not very well represented using the 5m 2D cell size. In parts, the creek is only 5-10m wide and the 5m cell size could be considered too coarse to accurately represent the creek topography. Refer to the below figure.<br>		As discussed in Module 1 (<u>[[Tutorial_Module01_Archive#Reviewing_Model_Performance \|discussion here]]</u>), the main creek channel is not very well represented using the 5m 2D cell size. In parts, the creek is only 5-10m wide and the 5m cell size could be considered too coarse to accurately represent the creek topography. Refer to the below figure.<br>
	[[file:Poor_2d_rep.png\|400px]]<br>		[[file:Poor_2d_rep.png\|400px]]<br>
	Using a cell size that is coarse relative to the width of the creek channel may reduce the accuracy of the computed conveyance in the channel and introduce a source of mass error to the model. There are two options for improving the representation of the creek channel:<br>		Using a cell size that is coarse relative to the width of the creek channel may reduce the accuracy of the computed conveyance in the channel and introduce a source of mass error to the model. There are two options for improving the representation of the creek channel:<br>
	* decrease the width of the 2D cells; and/or		* decrease the width of the 2D cells; and/or
	* model the channel as a 1D network, dynamically linked to the 2D domain (the floodplain).		* model the channel as a 1D network, dynamically linked to the 2D domain (the floodplain).
	In the optional section of module 1 (<u>[[Tutorial_Module01_Archive#Advanced_-_Model_Resolution_.28Optional.29 \| located here]]</u>), we looked at reducing the cell size to get a better representation of the channel. In this module we will adopt the second approach of modelling the creek as 1D elements.<br>		In the optional section of module 1 (<u>[[Tutorial_Module01_Archive#Advanced_-_Model_Resolution_.28Optional.29 \|located here]]</u>), we looked at reducing the cell size to get a better representation of the channel. In this module we will adopt the second approach of modelling the creek as 1D elements.<br>
	Setting up a 1D/2D model where the 1D channel cuts through the 2D domain is probably the most time-consuming type of a TUFLOW model to setup. However, the reduction in simulation time can be beneficial and make this a good approach. For this module, most of the time consuming data entry tasks have been undertaken, so you can progress through the module in a relatively short period of time. However, throughout the tutorial we will provide guidance on making this process as efficient as possible should you have to start from scratch.<br>		Setting up a 1D/2D model where the 1D channel cuts through the 2D domain is probably the most time-consuming type of a TUFLOW model to setup. However, the reduction in simulation time can be beneficial and make this a good approach. For this module, most of the time consuming data entry tasks have been undertaken, so you can progress through the module in a relatively short period of time. However, throughout the tutorial we will provide guidance on making this process as efficient as possible should you have to start from scratch.<br>

Emilie Nielsen at 03:10, 5 April 2024

2024-04-05T03:10:46Z

← Older revision		Revision as of 13:10, 5 April 2024
Line 6:		Line 6:
	* decrease the width of the 2D cells; and/or		* decrease the width of the 2D cells; and/or
	* model the channel as a 1D network, dynamically linked to the 2D domain (the floodplain).		* model the channel as a 1D network, dynamically linked to the 2D domain (the floodplain).
	In the optional section of module 1 [[Tutorial_Module01_Archive#Advanced_.28Optional.29 \| (located here)]], we looked at reducing the cell size to get a better representation of the channel. In this module we will adopt the second approach of modelling the creek as 1D elements.<br>		In the optional section of module 1 (<u>[[Tutorial_Module01_Archive#Advanced_-_Model_Resolution_.28Optional.29 \| located here]]</u>), we looked at reducing the cell size to get a better representation of the channel. In this module we will adopt the second approach of modelling the creek as 1D elements.<br>
	Setting up a 1D/2D model where the 1D channel cuts through the 2D domain is probably the most time-consuming type of a TUFLOW model to setup. However, the reduction in simulation time can be beneficial and make this a good approach. For this module, most of the time consuming data entry tasks have been undertaken, so you can progress through the module in a relatively short period of time. However, throughout the tutorial we will provide guidance on making this process as efficient as possible should you have to start from scratch.<br>		Setting up a 1D/2D model where the 1D channel cuts through the 2D domain is probably the most time-consuming type of a TUFLOW model to setup. However, the reduction in simulation time can be beneficial and make this a good approach. For this module, most of the time consuming data entry tasks have been undertaken, so you can progress through the module in a relatively short period of time. However, throughout the tutorial we will provide guidance on making this process as efficient as possible should you have to start from scratch.<br>

← Older revision		Revision as of 14:44, 17 April 2025
Line 149:		Line 149:
	<li>After this command in the .tcf, add the following command to link the new 1D control file:</li>		<li>After this command in the .tcf, add the following command to link the new 1D control file:</li>
	<font color="blue"><tt>ESTRY Control File </tt></font> <font color="red"><tt>== </tt></font> <tt>..\model\M04_1d_001.ecf</tt><br>		<font color="blue"><tt>ESTRY Control File </tt></font> <font color="red"><tt>== </tt></font> <tt>..\model\M04_1d_001.ecf</tt><br>
	<li>Depending on the speed of your computer, you may have noticed in the previous three modules that when TUFLOW is running, it is hard to read the TUFLOW console output because it updates too quickly. We can reduce the frequency of output to the ~~DOS~~ ~~screen~~ and also the TUFLOW Log File (.tlf). Include the following command at the end of the .tcf with the other output commands:<br>		<li>Depending on the speed of your computer, you may have noticed in the previous three modules that when TUFLOW is running, it is hard to read the TUFLOW console output because it updates too quickly. We can reduce the frequency of output to the console window and also the TUFLOW Log File (.tlf). Include the following command at the end of the .tcf with the other output commands:<br>
	<font color="blue"><tt>Screen/Log Display Interval </tt></font> <font color="red"><tt>== </tt></font> <tt>40</tt><br>		<font color="blue"><tt>Screen/Log Display Interval </tt></font> <font color="red"><tt>== </tt></font> <tt>40</tt><br>
	TUFLOW will write the output every 40 timesteps. For the 1.5 second timestep this means we will get output every 60 seconds of simulation time.<br>		TUFLOW will write the output every 40 timesteps. For the 1.5 second timestep this means we will get output every 60 seconds of simulation time.<br>
Line 288:		Line 288:
	*[[TUFLOW_Message_2060 \| Error 2060 - Could not find a CN connection snapped to the end of HX line]]		*[[TUFLOW_Message_2060 \| Error 2060 - Could not find a CN connection snapped to the end of HX line]]
	*[[TUFLOW_Message_2024 \| Error 2024 - Could not find a 1D node snapped to CN line.]]		*[[TUFLOW_Message_2024 \| Error 2024 - Could not find a 1D node snapped to CN line.]]
	*[[Only_TUFLOW_DOS_Window_Archive \| Why does the TUFLOW ~~DOS~~ ~~Window~~ open, though the TCF isn’t read and the simulation doesn’t execute?]]		*[[Only_TUFLOW_DOS_Window_Archive \| Why does the TUFLOW console window open, though the TCF isn’t read and the simulation doesn’t execute?]]

	= Advanced - HPC Solver (Optional) =		= Advanced - HPC Solver (Optional) =
Line 309:		Line 309:
	==Results==		==Results==
	Using the methods described above in the <u>[[Tutorial_Module01_Archive#Viewing_Results \| Viewing Results]]</u> section of Module 1.		Using the methods described above in the <u>[[Tutorial_Module01_Archive#Viewing_Results \| Viewing Results]]</u> section of Module 1.
	* 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 to the TUFLOW Classic simulation?		Do the logs and results appear different to the TUFLOW Classic simulation?