RES to RES: Difference between revisions

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

 

==Min==

'''Input Switch: -min'''<br>

<u>Description</u><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>

 

==Difference==

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>

<u>Examples</u><br>

 

==Duration==

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>

 

==Keep==

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>

 

==Range==

<u>Description</u><br>

Extracts all timestep between start time and end time (inclusive) into a separate results file.<br>

 

==Remove==

<u>Description</u><br>

Creates a new output file and removes the output time from this.<br>

 

==Trim Values==

<u>Description</u><br>

Creates a new output file which has any values above <value> set to <value>. If the input is a vector data, the vector magnitude is used to trim the value (direction is unchanged).<br>

 

==Times==

<u>Description</u><br>

Creates a text file which contains the output times in the .dat or xmdf file. If no output filename is specified with the -out option the output file will be called "times.txt". For xmdf files see also the -xnfo option below.<br>

 

==XMDF Information==

<u>Description</u><br>

Creates a text file which contains a list of the datasets contained within the .xmdf file. The number of output times and the output times are also exported to the text file.<br>

 

==Vector Angle==

<u>Description</u><br>

Outputs the vector direction in degrees relative to north (North = 0°, East = 90°, South = 180°/-180°, West = -90°).<br>

 

==Concatenate==

<u>Description</u><br>

Concatenates (joins) two or more results files into one. Each results file must be from the same 1D/2D mesh.<br>

 

==Convert==

Converts between .dat and .xmdf format results. Not to be confused with -con (concatenate option described above)!<br>

<u>Examples</u><br>

 

==Time of Increase==

'''Input Switch: -toi<cutoff>'''<br>

Calculates the time taken for the results to increase by the cutoff. For example if a value of 0.2 is used for a depth grid, the output result contains the time required for the depth to increase by 0.2m. If there are depth values greater than 0.2 initially (due to initial water level conditions), the output is the time for the depth to increase by 0.2m. For dry areas it is the time for the depth to reach 0.2m.<br>

 

==Ensight (beta)==

* 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>

 

=General Options=

When working with the .xmdf outputs from TUFLOW, there are some additional input switches are available. This is because the .xmdf file uses a folder structure and multiple output parameters are stored in the same .xmdf file. When converting you can control which dataset is converted using the switches below. These switches are not valid for .dat files as these contain a single parameter for each file. E.g. the _d.dat contains only depth information.<br>

In the xmdf file, the data is stored in the following structure:<br>

 

The xmdf specific switches are outlined in the table below:<br>

! width=80% | Description

|-

|-

|-

|-

|"-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.

|-

|"-path<path name>"||Converts a dataset based on the path in the .xmdf file. For example, <tt>-path"Maximums/ZAEM1"</tt> would convert the dataset Maximum ZAEM1 dataset. This can be a full path in the .xmdf file or a partial match. E.g.:<br>

|}

 

==XMDF Dataset Example==

[[File: xmdf_dataset_example.png]]<br>

<br>

|uplink=[[TUFLOW_Utilities | Back to TUFLOW Utilities]]

}}