Contents
The Navigation Panel to the left of the page functions as a live interactive Table of Contents for the manual chapters and associated sections. A full outline of the manual chapters and sections, as well as separate lists of all figures and all tables within the manual, is provided below.
Outline
1.2.1 Flexible Mesh Finite Volume
1.2.2.1 Three Dimensional (3D) Module
1.2.2.2 Sediment Transport (ST) Module
1.2.2.3 Water Quality (WQ) Module
1.2.2.4 Particle Tracking (PT) Module
1.2.2.5 GPU Hardware (GPU) Module
2.2.1 Tier 1: Simulation Class
2.2.3 Tier 3: Model Implementations
3.1.4 Instructor Led TUFLOW Training Courses
3.2 The TUFLOW Modelling Concept
3.2.3 Aquaveo SMS Mesh Generator / TUFLOW FV Graphical User Interface
3.3 Installing and Running TUFLOW
3.3.1 TUFLOW FV Downloads and Installation
4 Folders, Control Files and Data Layers
4.3.2.1 GIS Vector Layer Commands
4.3.2.2 GIS Vector Layer Naming Conventions
4.3.2.3 GIS Vector Layer Attribute Interpretation
4.3.2.4 GIS Vector Layer Object Interpretation
4.3.2.5 GIS Raster Layer Commands
5 Model Construction: 2D HD Simulation Class
5.1.1 Using the Model Construction Chapters
5.1.2 Recommended Workflow for Model Construction
5.3 Coordinate Reference Frame
5.3.3 Cartesian (Metric Units)
5.3.4 Spherical (Metric Units)
5.3.5 Cartesian (US Customary Units)
5.13.3.1 Static Bathymetry Layering
5.13.3.3 Direct Reading Of DEM Grids
5.13.3.4 Direct Reading Of TINs
5.13.3.7 Preprocessed Cell Elevations
5.13.4 Time Varying Bathymetry
5.16.2.1 Step 1: Boundary Model Implementations
5.16.2.2 Step 2: Boundary Location Definition
5.16.2.3 Step 3: Boundary Condition Block
5.16.2.4 Input Data For Boundary Conditions
5.16.2.4.4 Temporal Handling Of Boundary Data
5.16.2.4.5 Boundary Default Values
5.16.6.3 W10_GRID, MSLP_GRID, PRECIP_GRID
5.16.9 Zero Gradient And Reflective
5.17.2.1 Step 1: Structure Types
5.17.2.2 Step 2: Structure Connection Types
5.17.2.3 Step 3: Structure Block
5.17.5.1 Form Loss Coefficient
5.17.6 User Defined Timeseries
5.17.6.1.1 Pumping Configuration
5.17.11.3 Selecting an Operational Configuration
5.17.11.4.2 Timeseries Commands
5.17.11.4.4 Sample Rule Commands
5.17.11.4.5 Target Rule Commands
5.17.11.5.2 Default Control File Format
5.17.11.5.4 Default Control File Format
5.17.11.5.7 Default Control File Format
5.17.11.5.9 Default Control File Format
5.17.11.6 Supported Operational Control Combinations
5.17.11.6.4 User-defined Flow Matrix
5.17.11.6.5 User-defined Flow Timeseries
5.17.11.6.7 Variable Bathymetry
5.17.11.7 Control Structure Review
5.18.2.1 Output Model Implementations
6 Model Construction: 3D HD Simulation Class
6.5.7 K-Epsilon and K-Omega Extension Options
6.5.7.3 Internal Wave Mixing Model
6.9.2.1 Boundary Model Implementations
6.9.2.2 Boundary Location Definition
6.9.2.3 Boundary Condition Block
6.9.3.2 Boundary Face Interaction
6.10.3 Structure Connection Types
6.10.3.1 Vertical Distribution
6.11.2.1 Output Model Implementations
7 Model Construction: AD Simulation Class
7.7.3 Shortwave Radiation Model
7.7.4 Longwave Radiation Model
7.7.5.1 Vapour Pressure and Specific Humidity
7.7.5.2 Bulk Aerodynamic Latent Heat Transfer Coefficient
7.7.5.3 Latent Heat of Vaporisation
7.7.6.1 Bulk Aerodynamic Sensible Heat Transfer Coefficient
7.10.5 Ocean General Circulation Model
7.11.2.1 Step 1: Boundary Model Implementations
7.11.2.2 Step 2: Boundary Location Definition
7.11.2.3 Step 3: Boundary Condition Block
7.11.2.4 Input Data For Boundary Conditions
7.11.2.4.1 BC Header, BC Scale, BC Offset and BC Default
7.11.2.4.2 Trace Header, Trace Scale, Trace Offset and Trace Default
7.11.4.1 Outflow Scalar Concentration Handling
7.11.6.8 Gridded Atmospheric Boundary Conditions
7.11.7 Ocean Circulation Model
7.12.4.4 Airflow_Compressor and Airflow_Bubbler Control Examples
8 Model Construction: ST Simulation Class
8.5.3 Shortwave Radiation Model
8.8.2.1 Boundary Model Implementations
8.8.2.2 Boundary Location Definition
8.8.2.3 Boundary Condition Block
8.8.2.4 Input Data For Boundary Conditions
8.8.2.4.1 Sed Header, Sed Scale, Sed Offset and Sed Default
9 Model Construction: WQ Simulation Class
9.3 Water Quality Configuration
9.5.2.1 Step 1: Boundary Model Implementations
9.5.2.2 Boundary Location Definition
9.5.2.3 Step 3: Boundary Condition Block
9.5.2.4 Input Data For Boundary Conditions
9.5.2.4.1 WQ Header, WQ Scale, WQ Offset and WQ Default
9.7.2.1 Output Model Implementations
10 Model Construction: PT Simulation Class
10.2 Particle Tracking Configuration
10.6.2.1 Output Model Implementations
11 Managing And Starting Simulations
11.3.3.4 Additional Functionality
11.3.3.4.2 Events as Variables
11.4 Auto Terminate (Simulation End) Options
Appendix
B.3 Scalar Conservation Equations
B.4.4.4 Flux Spatial Integration
B.4.5.4 General Usage Guidance
B.4.8.5 Mean Sea Level and Baroclinic Pressure Gradients
B.5.3.1 Vapour Pressures and Specific Humidities
B.5.3.2 Latent Heat of Vaporisation
B.6.1.2 Compatible Graphics Cards
B.6.1.3 Updating NVIDIA Drivers
B.7 Horizontal Momentum Mixing Model
B.8 Horizontal Scalar Mixing Model
B.10.1.6 Internal Wave Mixing Model
List of Figures
Figure 2.1 TUFLOW FV model architecture tiers
Figure 2.2 TUFLOW FV simulation class and model class instance
Figure 3.1 TUFLOW Modelling Concept
Figure 4.1 Example of a Simple FVC
Figure 4.2 Reduction of Control Files using Event Management
Figure 4.3 Example include file containing astronomical tide boundary conditions
Figure 5.1 Wetting And Drying Depths
Figure 5.2 Moreton Bay Unstructured Mesh (Constructed Using Aquaveo SMS)
Figure 5.3 Regular Mesh Rotation Convention
Figure 5.4 Example Regular Mesh - Cell IDs are presented at each cell centre
Figure 5.5 Bathymetry Layering For Proposed Port Design
Figure 5.6 Breakline Definition Using Combination Of Polyline And Point GIS Layers
Figure 5.7 Filling Of Spoil Ground Modelled Using GIS Polygon
Figure 5.8 Material ID Spatial Definition
Figure 5.9 Nodestring Defining Offshore Astronomical Tide Boundary Location
Figure 5.10 Read GIS SA Points
Figure 5.11 Read GIS SA Polygons
Figure 5.12 CFSR Wind Speed Grid Overlaid On TUFLOW FV Unstructured Mesh
Figure 5.13 Example Moving Boundary Condition
Figure 5.14 Example HQ Relationship
Figure 5.15 Digitising a Nodestring (Single)
Figure 5.16 Digitising Linked Nodestrings
Figure 5.17 Digitising a Zone (Single)
Figure 5.18 Digitising A Zone
Figure 5.19 Blockage File - Bridge_BLK_001.csv
Figure 5.20 Width File - Bridge_WID_001.csv
Figure 5.21 Structure Logging Timeseries From CC_001.slf
Figure 5.22 Depth Output With Overlaid Velocity Vectors
Figure 5.24 Point Output Locations
Figure 5.25 Point Output Timeseries From CC_001_POINTS.csv
Figure 5.26 Point Output Timeseries From CC_001_POINTS_MET.csv
Figure 5.27 Polyline Output Locations
Figure 5.28 Net Flow Timeseries From CC_001_FLUX.csv
Figure 5.29 Structure Flow Timeseries From CC_001_STRUCTFLUX.csv
Figure 6.1 Sigma Vertical Mesh
Figure 6.2 Z Vertical Mesh With Surface Sigma Layers
Figure 7.1 Atmospheric Heat Exchange Conceptual Diagram
Figure 11.1 Reduction of Control Files using Event Management
Figure B.1 Internal And External Model Timesteps
Figure B.2 Atmospheric Heat Exchange Conceptual Diagram
Figure B.3 Accessing NVIDIA Control Panel from the Desktop
Figure B.4 NVIDIA GPU Model
Figure B.5 Check the Website for your NVIDIA Card
Figure B.6 NVIDIA System Information
Figure B.7 Accessing Driver Updates from the NVIDIA Control Panel
Figure B.8 Weir Schematic
Figure B.9 Weir Submergence Curves using Villemonte Equation
Figure B.10 1D Outlet Control Culvert Flow Regimes
Figure B.11 1D Inlet Control Culvert Flow Regimes
Figure B.12 Culvert Schematic
Figure B.13 Culvert Approach, Structure and Departure Velocites
Figure B.14 Culvert File Example
Figure B.15 Porous Schematic
Figure B.16 Symbology used in Computational Method
Figure B.17 Governing Equations
Figure B.18 Detrainment logic
List of Tables
Table 2.1 TUFLOW FV simulation class instances
Table 2.2 TUFLOW FV simulation class dependencies
Table 2.3 TUFLOW FV simulation class instances and corresponding model class suites
Table 2.4 TUFLOW FV model classes and available model implementations
Table 3.1 Supporting Software Options
Table 3.2 TUFLOW Tips and Tricks
Table 4.1 Recommended Sub-Folder Structure
Table 4.2 Recommended Advanced Sub-Folder Structure
Table 4.3 List of Available Control Files
Table 4.4 Special Characters - Text Files
Table 4.5 Notation Used in Command Documentation - Text Files
Table 4.6 List of Most Commonly Used Input File Types
Table 4.7 GIS Input Data Layers and Recommended Prefixes - 2D Domain
Table 4.8 TUFLOW Interpretation of Supported GIS Objects
Table 4.9 TUFLOW Interpretation of Unsupported GIS Objects
Table 4.10 List of Most Commonly Used Output File Types
Table 5.1 Coordinate Reference Frame Model Implementations
Table 5.2 Coordinate Reference Frame Commands
Table 5.3 Metric and Equivalent US Customary Units
Table 5.4 Hardware Model Implementations
Table 5.5 Hardware Commands
Table 5.6 Horizontal Spatial Order Model Implementations
Table 5.7 Horizontal Spatial Order Commands
Table 5.8 Simulation Time Setting Model Implementations
Table 5.9 Simulation Time Setting Commands
Table 5.10 Computational Timestep Model Implementation
Table 5.11 Computational Timestep Commands
Table 5.12 Wetting and Drying Model Implementation
Table 5.13 Wetting and Drying Command
Table 5.14 Bottom Drag Implementations
Table 5.15 Bottom Drag Commands
Table 5.16 Horizontal Mixing Implementations
Table 5.17 Horizontal Mixing Commands
Table 5.18 Wind Stress Implementations
Table 5.19 Wind Stress Commands
Table 5.20 Computational Mesh Model Implementations
Table 5.21 Computational Mesh Commands
Table 5.22 Bathymetry Model Implementations
Table 5.23 Static Bathymetry Commands
Table 5.24 2D Z (2d_zln) Attribute Description
Table 5.25 Material Model Implementations
Table 5.26 Material Commands
Table 5.27 2D Mat (2d_mat_) Attribute Description
Table 5.28 Initial Condition Model Implementations
Table 5.29 Initial Condition Commands
Table 5.30 2D HD Boundary Condition Model Implementations
Table 5.31 Assigning Boundary Locations - 2D HD Simulation Class
Table 5.32 Empty 2d_ns Nodestring GIS Layer
Table 5.33 Empty 2d_sa boundary GIS Layer
Table 5.34 Grid Definition Block Commands
Table 5.35 Boundary Condition Commands
Table 5.36 Example Mapping Of BC Header Entries
Table 5.37 Water Level Boundaries
Table 5.38 Inflow/Outflow Boundaries
Table 5.39 Stage-Discharge Boundaries
Table 5.40 Atmospheric Boundaries
Table 5.41 Spectral Wave Boundaries
Table 5.42 Force Boundaries
Table 5.43 Zero Gradient and Reflective Boundaries
Table 5.44 Structure Types
Table 5.45 Structure Connection Types
Table 5.46 Structure Type and Connection Type Compatibility
Table 5.47 Empty 2d_ns Nodestring GIS Layer For Hydraulic Structure Connections
Table 5.48 Empty 2d_zn Zone GIS Layer For Hydraulic Structure Connections
Table 5.49 Structure Block Commands
Table 5.50 Weir Flux Function Types
Table 5.51 Culvert Flux Function
Table 5.52 Bridge Energy Loss Formulations
Table 5.53 User Defined Timeseries Flux Function
Table 5.54 Porous Flux Function
Table 5.55 User Defined Matrix Flux Function
Table 5.56 Wall Flux Function
Table 5.57 Variable Bathymetry Bed Adjustment Types
Table 5.58 Control Parameters
Table 5.59 Control Types
Table 5.60 Trigger Control Commands
Table 5.61 Timeseries Control Commands
Table 5.62 Sample Control Commands
Table 5.63 Sample Rule Control Commands
Table 5.64 Target Rule Control Commands
Table 5.65 Control Type Summary
Table 5.66 Supported Control Parameter and Control Type Combinations - Weir
Table 5.67 Supported Control Parameter and Control Type Combinations - Weir_dz
Table 5.68 Supported Control Parameter and Control Type Combinations - Culvert
Table 5.69 Supported Control Parameter and Control Type Combinations - User-defined Flow Matrix
Table 5.70 Supported Control Parameter and Control Type Combinations - User-defined Flow Timeseries
Table 5.71 Supported Control Parameter and Control Type Combinations - Porous Structure
Table 5.72 Supported Control Parameter and Control Type Combinations - Variable Bathymetry
Table 5.73 Output Model Implementations
Table 5.74 Output Directories
Table 5.75 Output Block Commands
Table 5.76 Output Parameters - 2D HD Simulation Class
Table 5.77 Recommended Mesh Output Formats
Table 5.78 3D PO (3d_po_) Attribute Description
Table 5.79 Flux Output Variables
Table 5.80 Flux Output Variables
Table 5.81 Mass Output Variables
Table 5.82 Restart Commands
Table 6.1 Vertical Spatial Order Model Implementations
Table 6.2 Vertical Spatial Order Commands
Table 6.3 Vertical Mixing Model Implementations
Table 6.4 Vertical Mixing Model Commands
Table 6.5 Vertical Computational Mesh Model Implementations
Table 6.6 Computational Mesh Commands
Table 6.7 Material Properties Commands
Table 6.8 Initial Condition Model Implementations
Table 6.9 Initial Condition Commands
Table 6.10 3D HD Boundary Condition Model Implementations
Table 6.11 Boundary Condition Commands
Table 6.12 Output Model Implementations
Table 6.13 Output Block Commands
Table 6.14 Output Parameters - 3D HD Simulation Class
Table 6.15 Mesh Output Format - 2D And 3D Compatiblity Matrix
Table 6.16 Depth Averaging Methods - 3D HD Simulation Class
Table 7.1 Salinity Implementations
Table 7.2 Salinity Commands
Table 7.3 Temperature Implementations
Table 7.4 Temperature Commands
Table 7.5 Tracer Implementations
Table 7.6 Tracer Commands
Table 7.7 Horizontal Mixing Implementations
Table 7.8 Horizontal Mixing Commands
Table 7.9 Atmospheric Heat Exchange Components
Table 7.10 Shortwave Radiation Implementations
Table 7.11 Shortwave Radiation Commands
Table 7.12 Longwave Radiation Implementations
Table 7.13 Longwave Radiation Commands
Table 7.14 Latent Heat Vapour Pressure And Specific Humidity Implementations
Table 7.15 Latent Heat Vapour Pressure And Specific Humidity Commands
Table 7.16 Latent Heat Bulk Aerodynamic Coefficient Implementations
Table 7.17 Latent Heat Bulk Aerodynamic Coefficient Commands
Table 7.18 Sensible Heat Implementations
Table 7.19 Sensible Heat Commands
Table 7.20 Material Properties Commands
Table 7.21 Initial Conditions Implementations
Table 7.22 Initial Conditions Commands
Table 7.23 Boundary Condition Model Class - Model Implementations
Table 7.24 Additional AD Simulation Class Grid Definition Block Command
Table 7.25 Additional AD Boundary Condition Block Commands
Table 7.26 Atmospheric Boundaries
Table 7.27 Ocean Circulation Boundary Conditions
Table 7.28 Mass Flux Boundaries
Table 7.29 Scalar Concentration Boundaries
Table 7.30 Structure Types
Table 7.31 Bubble Plume Types
Table 7.32 Bubble Plume Control Parameters
Table 7.33 Output Parameters - AD Simulation Class
Table 8.1 Sediment Implementations
Table 8.2 Sediment Commands
Table 8.3 Shortwave Radiation Commands
Table 8.4 Initial Conditions Implementations
Table 8.5 Initial Conditions Commands
Table 8.6 Boundary Condition Model Class - Model Implementations
Table 8.7 Additional ST Boundary Condition Block Commands
Table 8.8 Mass Flux Boundaries
Table 8.9 Scalar Concentration Boundaries
Table 8.10 Output Parameters - Sediment Simulation Class
Table 8.11 Multidimensional Output Parameters - Sediment Simulation Class
Table 9.1 Water Quality Implementations
Table 9.2 Water Quality Commands
Table 9.3 Initial Conditions Implementations
Table 9.4 Initial Conditions Commands
Table 9.5 Boundary Condition Model Class - Model Implementations
Table 9.6 Additional WQ Boundary Condition Block Commands
Table 9.7 Mass Flux Boundaries
Table 11.1 Event Commands
Table 11.2 Scenario Commands
Table 11.3 Variables Command
Table 11.4 Auto Terminate Command
Table A.1 TUFLOW FV Commands
Table B.1 Smagorinsky Momentum Mixing Model Terms
Table B.2 Wu Momentum Mixing Model Terms
Table B.3 Smagorinsky Scalar Mixing Model Terms
Table B.4 HD Mass Balance Headers
Table B.5 AD Mass Balance Headers
Table B.6 Sediment Mass Balance Headers
Table B.7 Default Attribute Values for the Weir Equation for Different Weir Flows
Table B.8 Weir Properties
Table B.9 1D Culvert Flow Regimes
Table B.10 Culvert File Inputs
Table B.11 Porous Structure Properties