TUFLOW Viewer

TUFLOW Viewer

TUFLOW Viewer replaces Crayfish and TUPLOT as the TUFLOW result viewer for QGIS for version 3.6 onwards. It uses the Mesh Data Abstraction Library (MDAL) available in QGIS to display and interact with TUFLOW map output results, and the TUFLOW results python library (the same library used by TUPLOT in earlier versions of QGIS) for viewing TUFLOW time series results.

Loading Results

Option 1

File >> Load Results

Option 2

Right Click in Open Results >> Load Results

There are 3 options for loading in results:

1. Load Results --> This is done via a TCF, TLF, or FVC file and will load in all results (Map Outputs and Time Series)
2. Load Results - Map Outputs --> Select map output mesh results file (*.xmdf, *.dat, *.2dm, *.xmdf.sup, *.dat.sup)
3. Load Results - Time Series --> Select time series output results (*.tpc)

Changing Result Type

As simple as selecting a different result type in Result Type panel. You can only display one Scalar results and one Vector result at any given time.

File:ChangingResultType.gif

Showing Maximum

Option 1

Click the double up arrow next to the result type

Option 2

Right click the result type >> Check on Maximum

File:ToggleMax.gif

Showing Vectors

Select one of the Vector result types in the Result Types panel


File:ToggleVectors.gif

Styling Layer

Option 1

Right Click mesh layer in Layers Panel >> Properties... >> Navigate to the Contour Tab at the top >> Select Colour Ramp in drop down box >> Click Load >> Click OK

Option 2

Right Click result type in Result Type Panel >> Properties... >> Navigate to the Contour Tab at the top >> Select Colour Ramp in drop down box >> Click Load >> Click OK

File:ChangeStyles.gif

Saving Default Style

Saving a default style for a result type will mean that every time a result type of that name e.g 'Depth' is loaded, TUFLOW Viewer will automatically apply that style.

There are 2 options:

1. Save Colour Ramp --> This will save the particular colour ramp as default. This means the actual min / max values will be adjusted based on the results. This is useful for results such as Bed Elevation or Water Level where the ranges are usually different depending on the model's location
2. Save Colour Map --> This will save the exact values and associated colours used in the styling. This might be useful for results such as Depth or Velocity where a template can be applicable across different models

Right Click the result type >> Save Style As Default >> Colour Ramp

File:SavingDefaultStyles.gif

Plotting From Map Outputs

Time Series

You can plot one or multiple temporal map output results as a time series.

1. Choose which map outputs to plot --> click on the time series graph down arrow under Map Output Plotting >> Check on desired result types
2. Click off the menu
3. Click the time series graph again (not the down arrow)
4. Click somewhere on your results

File:MapOutputPlotting TS.gif

Cross Section

You can plot one or multiple map output results as a cross section for the current time step.

1. Choose which map outputs to plot --> click on the cross-section graph down arrow under Map Output Plotting >> Check on desired result types
2. Click off the menu
3. Click the cross-section graph again (not the down arrow)
4. Left click somewhere on your results to start the cross-section
5. Left click to add vertices to your cross-section polyline
6. Right click to finish

File:MapOutputPlotting CS.gif

Plotting Flow

You can post calculate flow from the map output results. Note that this approach should be used for approximation only. The preferred method is to use a PO line in TUFLOW.

1. Click on the Plot Flux button down arrow under Map Output Plotting
2. Left click somewhere on your results to start the flux line
3. Left click to add vertices to your flux line
4. Right click to finish

File:MapOutputPlotting Q.gif

Plotting From Time Series Outputs

If time series results are loaded in (e.g. 1D results) you can plot from the outputted types.

1. Select result type e.g Flow under the Time Series section in the Result Types
2. Use QGIS Select Tool and select one of the PLOT GIS features

File:TimeSeriesPlotting Q.gif

Using a Secondary Axis

If you are plotting multiple result types at once, you may want to plot one or more of the lines on a secondary axis. This can be done 2 ways:
Option 1

Click the Secondary Axis icon on the appropriate result type in the Result Types Panel

Option 2

Right Click on the appropriate result type in the Result Types Panel and check on Secondary Axis

File:ToggleSecondaryAxis.gif

Changing Plot Properties

Plot properties can be changed via
Option 1

TUFLOW Viewer Settings >> Customise

Option 2

Customise tool icon in the plot toolbar

Using this, properties such as the plot axis, item name in legend, and line / point styling can be modified.

File:PlotProperties 1.gif

File:PlotProperties 2.gif

File:PlotProperties 3.gif

File:PlotProperties 4.gif