Overview
This section describes how to use the TUFLOW FV User Manual and how its chapters and appendices are intended to be read.
Model construction in TUFLOW FV follows a structured workflow. Readers should begin with the Architecture chapter, which introduces the organisational concepts used throughout the manual and explains the relationship between the model construction chapters and the supporting appendices. Subsequent model construction chapters describe the configuration of a specific simulation type. The recommended workflow is to start with Model Construction: 2D HD Simulation and then extend to additional simulation capabilities as required.
Within each model construction chapter, components are documented using a consistent structure. For each component, the documentation identifies whether it is required, conditionally required, or optional, describes its purpose, and outlines supported configuration approaches. Example syntax blocks are provided and may be copied directly into a TUFLOW FV control file.
How to use this manual
Instructions are provided below on how to use this manual, including manual structure, aspects of navigation and searching. These instructions are not provided elsewhere.
Searching
This entire manual’s content can be searched by using the search box at the top of the table of contents pane (i.e. screen top left to the right of the TUFLOW logo). This search box can be toggled on and off by clicking the search icon (magnifying glass) at the top left of any page.
The table of contents is dynamically filtered in response to entering text in the search box, and clicking on any remaining table of contents entry will navigate directly to the searched text. Searched text will be highlighted within a page for easy identification, and multiple instances within one page can be navigated through by using the up and down arrow keys. Clearing the search box will restore the table of contents.
Tables
Where appropriate, tables are searchable via use of the search box, which is located at the top right of any search enabled table. Not all tables are searchable. When text is entered into the search box, table rows are dynamically filtered to only show those that contain the search text. This allows on-the-fly condensing of large tables so that only relevant content is presented.
Tables can be sorted alphabetically (or reverse alphabetically) with respect to any column by clicking (and re-clicking) column headers. Where appropriate, the number of rows displayed is selectable via the Show entries drop down. Undisplayed rows can be accessed by clicking Previous or Next or by using the numbered navigation boxes, all of which are located at the bottom of each table. Colour coding is often used for distinguishing different tabulated data types.
Networks
Interactive networks are used to assist in describing simulation architecture. Networks comprise nodes and connecting lines. Nodes are coloured and labelled circles. These nodes represent items within architectural levels and are coloured as
Single click anywhere on a network to activate interaction. A clicked network will show as being boxed in blue when activated. Once activated:
- Single click or hover over a node to highlight its nearest neighbours. Single clicking anywhere off the network will deselect these. The intention is that this allows users to quickly identify related processes and computed variables
- Use the Select by id drop down menu to select a particular node of interest. Its nearest neighbours will also be automatically selected
- Single click, hold and drag a node to move it if it covers other text or links. All nodes are able to be moved by hand in this way
- Single click, hold and drag white space anywhere within the activated network area to drag the entire network
- Use the mouse wheel to zoom in and out of the network
- Double click on any node within an exploded group to implode the group back to its original state
- Click the Reinitialize clustering button at the bottom of a network that uses clustering to return an exploded network to its original position, zoom and unexploded state. Not all networks use clustering so this button may not always be present
Networks are deactivated when anywhere outside its blue box is clicked.
Commands
Where specific commands are described, they appear in highlighted text and often as a clickable link to the corresponding command description in Appendix A. The following is an example of a TUFLOW FV command.
Example TUFLOW FV command blocks
Example TUFLOW FV command file syntax snippets are provided using highlighted text in scrollable code blocks. These blocks can be directly copied into a text editor when building a model control file. Syntax highlighted in blue are TUFLOW FV commands and black syntax are argument values read by the command. Green syntax preceded by the ! character indicates a comment. Comments to the right of each command summarise each argument value. If multiple arguments are required, comments are separated using a comma delimiter. Where relevant, default values are enclosed by curly braces {}. If multiple options are available for a given argument they are separated by the | character.
Two example syntax blocks are provided below.
About this manual
This document is the User Manual for the TUFLOW FV hydrodynamic computational engine. From the 2026.0.0 TUFLOW release, new features and changes between TUFLOW versions are provided centrally in the TUFLOW FV Changelog. Prior to this, detailed release documentation was published in individual Release Note documents. Changelogs and Release Notes are available from TUFLOW Downloads.
