RES to RES - Revision history

Anne.Kolega: /* Difference */ i.e.

2026-04-02T01:52:57Z

Difference: i.e.

← Older revision		Revision as of 11:52, 2 April 2026
Line 37:		Line 37:
	A special wet/dry algorithm is used. If water level results are not specified (_h.dat or -typeH), the algorithm opens these files, as well as opens the .2dm file associated with the results files, and uses the water levels and ZH Zpt values (for 2D cells) and elevations at the WLL triangle corners to determine whether a node (corner of a mesh element) is wet or dry. This allows two special values to be output in the event that a node is dry in one results file and wet in the other or vice versa. A value of -99 is used to indicate that a node is dry in the first results file, but is flooded in the second results file, while +99 indicates that the node was wet in the first results file but is dry in the second results file. Specifying -nowetdry does not carry out a wet/dry check using the water level results.		A special wet/dry algorithm is used. If water level results are not specified (_h.dat or -typeH), the algorithm opens these files, as well as opens the .2dm file associated with the results files, and uses the water levels and ZH Zpt values (for 2D cells) and elevations at the WLL triangle corners to determine whether a node (corner of a mesh element) is wet or dry. This allows two special values to be output in the event that a node is dry in one results file and wet in the other or vice versa. A value of -99 is used to indicate that a node is dry in the first results file, but is flooded in the second results file, while +99 indicates that the node was wet in the first results file but is dry in the second results file. Specifying -nowetdry does not carry out a wet/dry check using the water level results.
	<br>		<br>
	The -t option can be used to carry out the difference at a particular time (rather than all times). The most common time is to take the difference at the flood peak, ie. specify -t99999.<br>		The -t option can be used to carry out the difference at a particular time (rather than all times). The most common time is to take the difference at the flood peak, i.e. specify -t99999.<br>
	<u>Examples</u><br>		<u>Examples</u><br>
	<ol>		<ol>

Pavlina Monhartova at 05:35, 18 April 2025

2025-04-18T05:35:16Z

← Older revision		Revision as of 15:35, 18 April 2025
Line 204:		Line 204:
	\|"-type<output type>"\|\| Converts the specified output type in an xmdf file. Output types should be specified as per the output type in the .tcf e.g. h (water level), v (velocity), q (unit flow) or d (depth). Output types other than h, v, q and d are not predefined with the -type switch and should be called with -v and/or -s switch.		\|"-type<output type>"\|\| Converts the specified output type in an xmdf file. Output types should be specified as per the output type in the .tcf e.g. h (water level), v (velocity), q (unit flow) or d (depth). Output types other than h, v, q and d are not predefined with the -type switch and should be called with -v and/or -s switch.
	\|-		\|-
	\|"-s<output id(integer)>"\|\| Converts the specified scalar dataset in an xmdf file. For example, <tt>-s1</tt> will convert the first scalar dataset. A list of the available datasets is listed within the ~~DOS~~ window when RES_to_RES is preprocessing results. Check <u>[[RES_to_RES#XMDF_Dataset_Example \| XMDF Dataset Example]]</u>. To keep the ~~DOS~~ window open write "pause" at the end of the processing batch file and remove -b switch.		\|"-s<output id(integer)>"\|\| Converts the specified scalar dataset in an xmdf file. For example, <tt>-s1</tt> will convert the first scalar dataset. A list of the available datasets is listed within the console window when RES_to_RES is preprocessing results. Check <u>[[RES_to_RES#XMDF_Dataset_Example \| XMDF Dataset Example]]</u>. To keep the console window open write "pause" at the end of the processing batch file and remove -b switch.
	\|-		\|-
	\|"-v<output id(integer)>"\|\| Converts the specified vector dataset in an xmdf file. For example, <tt>-v1</tt> will convert the first vector dataset. A list of the available datasets is listed within the ~~DOS~~ window when RES_to_RES is preprocessing results. Check <u>[[RES_to_RES#XMDF_Dataset_Example \| XMDF Dataset Example]]</u>. To keep the ~~DOS~~ window open write "pause" at the end of the processing batch file and remove -b switch.		\|"-v<output id(integer)>"\|\| Converts the specified vector dataset in an xmdf file. For example, <tt>-v1</tt> will convert the first vector dataset. A list of the available datasets is listed within the console window when RES_to_RES is preprocessing results. Check <u>[[RES_to_RES#XMDF_Dataset_Example \| XMDF Dataset Example]]</u>. To keep the console window open write "pause" at the end of the processing batch file and remove -b switch.
	\|-		\|-
	\|"-Folder<Folder Name>"\|\| Converts all datasets within a particular xmdf file. For example, <tt>-Folder"Maximums"</tt> will convert all datasets in the \Maximums\ folder.		\|"-Folder<Folder Name>"\|\| Converts all datasets within a particular xmdf file. For example, <tt>-Folder"Maximums"</tt> will convert all datasets in the \Maximums\ folder.
Line 216:		Line 216:

	==XMDF Dataset Example==		==XMDF Dataset Example==
	Display the datasets available within an XMDF file in a ~~DOS~~ window by starting any operation. <br>		Display the datasets available within an XMDF file in a console window by starting any operation. <br>
	To keep the ~~DOS~~ window open write "pause" at the end of the processing batch file and ensure -b switch is not included. <br>		To keep the console window open write "pause" at the end of the processing batch file and ensure -b switch is not included. <br>
	The list of available datasets will be displayed towards the start of the ~~DOS~~ window. <br><br>		The list of available datasets will be displayed towards the start of the console window. <br><br>

	<u>Examples</u><br>		<u>Examples</u><br>
	<tt>res_to_res.exe -xnfo results.xmdf<br>		<tt>res_to_res.exe -xnfo results.xmdf<br>
	pause</tt><br><br>		pause</tt><br><br>
	Displays the following ~~DOS~~ window: <br>		Displays the following console window: <br>
	[[File: xmdf_dataset_example.png]]<br>		[[File: xmdf_dataset_example.png]]<br>
	<br>		<br>

Emilie Nielsen: /* Ensight (beta) */

2025-02-20T06:30:08Z

Ensight (beta)

← Older revision		Revision as of 16:30, 20 February 2025
Line 173:		Line 173:
	* Ensight results as either per node or per element depending on the input file.		* Ensight results as either per node or per element depending on the input file.
	'''This conversion is in its beta stage of development. This utility can currently only process 2D results. 1D channel result are currently not supported.<br>		'''This conversion is in its beta stage of development. This utility can currently only process 2D results. 1D channel result are currently not supported.<br>
	Any feedback regarding this utility function is welcome and can be sent to support@tuflow.com.<br>		Any feedback regarding this utility function is welcome and can be sent to [mailto:support@tuflow.com support@tuflow.com].<br>
	<u>Example</u><br>		<u>Example</u><br>
	<ol>		<ol>

Emilie Nielsen: /* Operations */

2024-07-22T05:50:09Z

Operations

Show changes

Emilie Nielsen: /* Keep */

2024-07-22T05:40:26Z

Keep

← Older revision		Revision as of 15:40, 22 July 2024
Line 62:		Line 62:
	Can be used to extract a single timestep from a results file. This is useful to extract the maximums to a separate file making it easier to transfer electronically. To keep a range of output times see the -range option below.<br>		Can be used to extract a single timestep from a results file. This is useful to extract the maximums to a separate file making it easier to transfer electronically. To keep a range of output times see the -range option below.<br>
	<u>Examples</u><br>		<u>Examples</u><br>
			<ol>
⚫	~~<li>~~<tt>res_to_res.exe -~~k99999~~ -~~typeH~~ results.xmdf</tt~~></li~~>
	Creates a new results file containing just the maximum from the water level results.		<li>Creates a new results file containing just the maximum from the water level results.<br>
	~~<li>~~<tt>res_to_res.exe -~~k2.5~~ -~~typeV~~ results.xmdf</tt~~></li~~>		<tt>res_to_res.exe -k99999 -typeH results.xmdf</tt>
	Creates a new results file containing just velocity results for the 2.5 hour output.		<li>Creates a new results file containing just velocity results for the 2.5 hour output.<br>
		⚫	<tt>res_to_res.exe -k2.5 -typeV results.xmdf</tt>
			</ol>

	==Range==		==Range==

Emilie Nielsen: /* Duration */

2024-07-22T05:39:37Z

Duration

← Older revision		Revision as of 15:39, 22 July 2024
Line 51:		Line 51:
	Determines the duration in hours that the the results exceed the cut off value.<br>		Determines the duration in hours that the the results exceed the cut off value.<br>
	'''Note: ''' A preferable approach is to use the .tcf file command: <tt>Time Output Cutoff Depths == <cut off value or values></tt>. With this command specified TUFLOW tracks this on a timestep by timestep basis rather than post processing this at the map output interval.<br>		'''Note: ''' A preferable approach is to use the .tcf file command: <tt>Time Output Cutoff Depths == <cut off value or values></tt>. With this command specified TUFLOW tracks this on a timestep by timestep basis rather than post processing this at the map output interval.<br>
	<u>~~Examples~~</u><br>		<u>Example</u><br>
			<ol>
⚫	~~<li>~~<tt>res_to_res.exe -dur0.1 -typeD results.xmdf</tt~~></li~~>
	Extracts the duration in flooding above 0.1m deep.		<li>Extracts the duration in flooding above 0.1m deep.<br>
		⚫	<tt>res_to_res.exe -dur0.1 -typeD results.xmdf</tt>
			</ol>

	==Keep==		==Keep==

Emilie Nielsen: /* Difference */

2024-07-22T05:37:53Z

Difference

← Older revision		Revision as of 15:37, 22 July 2024
Line 39:		Line 39:
	The -t option can be used to carry out the difference at a particular time (rather than all times). The most common time is to take the difference at the flood peak, ie. specify -t99999.<br>		The -t option can be used to carry out the difference at a particular time (rather than all times). The most common time is to take the difference at the flood peak, ie. specify -t99999.<br>
	<u>Examples</u><br>		<u>Examples</u><br>
			<ol>
⚫	~~<li>~~<tt>res_to_res.exe -dif -typeH results_developed.xmdf results_existing.xmdf</tt~~></li~~>
	Extracts the difference in water level, the output is results_developed minus results_existing for all timesteps.		<li>Extracts the difference in water level, the output is results_developed minus results_existing for all timesteps.<br>
	~~<li>~~<tt>res_to_res.exe -dif -typeH ~~-t99999 -nowetdry~~ results_developed.xmdf results_existing.xmdf</tt~~></li~~>		<tt>res_to_res.exe -dif -typeH results_developed.xmdf results_existing.xmdf</tt>
	Extracts the difference in water level for the maximum water level and suppresses the wet/dry check described above.		<li>Extracts the difference in water level for the maximum water level and suppresses the wet/dry check described above.<br>
		⚫	<tt>res_to_res.exe -dif -typeH -t99999 -nowetdry results_developed.xmdf results_existing.xmdf</tt>
			</ol>

	==Duration==		==Duration==

Emilie Nielsen: /* Min */

2024-07-22T05:36:53Z

Min

← Older revision		Revision as of 15:36, 22 July 2024
Line 24:		Line 24:
	This can be used to extract the minimums from a number of input datasets. Any number of input files can be specified. If a minimum folder exists in an .xmdf file for the type specified, this dataset will be used.<br>		This can be used to extract the minimums from a number of input datasets. Any number of input files can be specified. If a minimum folder exists in an .xmdf file for the type specified, this dataset will be used.<br>
	<u>Examples</u><br>		<u>Examples</u><br>
			<ol>
⚫	~~<li>~~<tt>res_to_res.exe -min -typeH results_1.xmdf results_2.xmdf results_3.xmdf</tt~~></li~~>
	Extracts the minimum water level from the three xmdf files.		<li>Extracts the minimum water level from the three xmdf files.<br>
	~~<li>~~<tt>res_to_res.exe -min -typeH ~~-out Minimums.xmdf~~ results_1.xmdf results_2.xmdf results_3.xmdf</tt~~></li~~>		<tt>res_to_res.exe -min -typeH results_1.xmdf results_2.xmdf results_3.xmdf</tt>
	Extracts the minimum water level from the three xmdf files with output name "Minimums.xmdf".		<li>Extracts the minimum water level from the three xmdf files with output name "Minimums.xmdf".<br>
		⚫	<tt>res_to_res.exe -min -typeH -out Minimums.xmdf results_1.xmdf results_2.xmdf results_3.xmdf</tt>
			</ol>

	==Difference==		==Difference==

Emilie Nielsen: /* Max */

2024-07-22T05:35:52Z

Max

← Older revision		Revision as of 15:35, 22 July 2024
Line 10:		Line 10:
	This can be used to extract the maximum from a number of input datasets. Any number of input files can be specified. If a maximum folder exists in an .xmdf file for the type specified, this dataset will be used, for dat files use -t99999 to use the maximum data in the .dat file.<br>		This can be used to extract the maximum from a number of input datasets. Any number of input files can be specified. If a maximum folder exists in an .xmdf file for the type specified, this dataset will be used, for dat files use -t99999 to use the maximum data in the .dat file.<br>
	<u>Examples</u><br>		<u>Examples</u><br>
			<ol>
⚫	~~<li>~~<tt>res_to_res.exe -max -typeH ~~results_1.xmdf results_2.xmdf results_3~~.xmdf</tt~~></li~~>
	Extracts the maximum water level from the three .xmdf files.		<li>Extracts the maximum water level from the three .xmdf files.<br>
	~~<li>~~<tt>res_to_res.exe -max -typeH ~~results~~.xmdf</tt~~></li~~>		<tt>res_to_res.exe -max -typeH results_1.xmdf results_2.xmdf results_3.xmdf</tt>
	When maximums are tracked over all timesteps, extracts the maximum water level from the maximums output.		<li>When maximums are tracked over all timesteps, extracts the maximum water level from the maximums output.<br>
	~~<li>~~<tt>res_to_res.exe -max -typeH results.xmdf</tt~~></li~~>		<tt>res_to_res.exe -max -typeH results.xmdf</tt>
	When no maximums has been written directly, extracts the maximum water level of all available output times. Note this does not provide the true, tracked maximum over all timesteps.		<li>When no maximums has been written directly, extracts the maximum water level of all available output times. Note this does not provide the true, tracked maximum over all timesteps.<br>
		⚫	<tt>res_to_res.exe -max -typeH results.xmdf</tt>
			</ol>

	==Min==		==Min==

Emilie Nielsen at 05:31, 22 July 2024

2024-07-22T05:31:37Z

← Older revision		Revision as of 15:31, 22 July 2024
Line 1:		Line 1:
	<ol>
	=Introduction=		=Introduction=
	This utility performs a variety of operations on the TUFLOW 2D outputs. Valid formats are .xmdf (as of utility version 2012-10-AC) and .dat files. This page is split into two section, utility operations (e.g. maximum, difference etc.) and general options. The general options can be used regardless of operation being performed. The table of contents can be used to jump to a desired operation.		This utility performs a variety of operations on the TUFLOW 2D outputs. Valid formats are .xmdf (as of utility version 2012-10-AC) and .dat files. This page is split into two section, utility operations (e.g. maximum, difference etc.) and general options. The general options can be used regardless of operation being performed. The table of contents can be used to jump to a desired operation.
Line 201:		Line 200:
	\|uplink=[[TUFLOW_Utilities \| Back to TUFLOW Utilities]]		\|uplink=[[TUFLOW_Utilities \| Back to TUFLOW Utilities]]
	}}		}}

	</ol>