• Overview
    • How to use this Manual
      • Navigation
      • Searching
      • Commands
    • About this Manual
    • Glossary and Notation
  • Contents
    • List of Figures
    • List of Tables
  • 1 Introduction
    • 1.1 TUFLOW Products
      • 1.1.1 TUFLOW Classic – 2D Semi-Implicit Solver
      • 1.1.2 TUFLOW HPC – 2D GPU Accelerated Solver
      • 1.1.3 TUFLOW 1D (ESTRY) – 1D Solver
      • 1.1.4 EPA SWMM – 1D Solver
      • 1.1.5 Add-on Modules
        • 1.1.5.1 Advection Dispersion (AD) Module
        • 1.1.5.2 TUFLOW CATCH Module
        • 1.1.5.3 GPU Hardware (GPU) Module
        • 1.1.5.4 Quadtree or Multiple 2D Domain (M2D) Module
    • 1.2 TUFLOW Webinars
    • 1.3 Modelling Environment
    • 1.4 Limitations and Recommendations
  • 2 Getting Started
    • 2.1 How to Build Your First Model
      • 2.1.1 Tutorial Models
      • 2.1.2 Example Models
      • 2.1.3 Demonstration Models
      • 2.1.4 Licence Free Demo Mode
      • 2.1.5 eLearning Modules
      • 2.1.6 Instructor Led TUFLOW Training Courses
    • 2.2 The TUFLOW Modelling Concept
      • 2.2.1 Notepad++
      • 2.2.2 QGIS / TUFLOW Viewer
    • 2.3 Installing and Running TUFLOW
      • 2.3.1 TUFLOW Downloads and Installation
      • 2.3.2 TUFLOW Licencing
        • 2.3.2.1 3rd Party Software Libraries
      • 2.3.3 Performing Simulations
    • 2.4 Folders, File Types and File Naming
      • 2.4.1 Folder Structure
      • 2.4.2 File Types
      • 2.4.3 Naming Conventions
    • 2.5 Tips and Tricks
  • 3 Hydraulic Modelling Fundamentals
    • 3.1 Introduction
    • 3.2 Schematisation
      • 3.2.1 General Guidance
      • 3.2.2 Model Dimensions: 1D, 2D or 3D?
        • 3.2.2.1 One Dimensional (1D)
        • 3.2.2.2 Two Dimensional (2D)
        • 3.2.2.3 Three Dimensional (3D)
      • 3.2.3 Coupled 1D-2D
      • 3.2.4 Quadtree Grid
    • 3.3 Model Resolution (Discretisation)
      • 3.3.1 1D Networks
      • 3.3.2 2D Cell Sizes
      • 3.3.3 Sub-Grid Sampling (SGS)
        • 3.3.3.1 Benefits of SGS
      • 3.3.4 Cell Size Results Convergence
    • 3.4 Solution Accuracy
      • 3.4.1 Fluid Flow Physical Terms
        • 3.4.1.1 1D Continuity Equation
        • 3.4.1.2 1D Momentum Equation
        • 3.4.1.3 2D Continuity Equation
        • 3.4.1.4 2D Momentum Equation
      • 3.4.2 Forms of the Equations
        • 3.4.2.1 Diffusive Wave Equation
        • 3.4.2.2 Kinematic Wave Equation
      • 3.4.3 Numerical Accuracy
    • 3.5 Timestep
      • 3.5.1 Fixed versus Adaptive Timestepping
      • 3.5.2 TUFLOW 1D (ESTRY) and EPA SWMM
      • 3.5.3 TUFLOW Classic 2D
      • 3.5.4 TUFLOW HPC 2D
        • 3.5.4.1 Timestep Efficiency Output
    • 3.6 Simulation Times
  • 4 Control Files and Input Layers
    • 4.1 Introduction
    • 4.2 Control Files
      • 4.2.1 Rules and Notation
      • 4.2.2 File Paths
      • 4.2.3 Units
      • 4.2.4 TCF
      • 4.2.5 ECF
      • 4.2.6 TBC
      • 4.2.7 TGC
      • 4.2.8 QCF
      • 4.2.9 TEF
      • 4.2.10 TOC
      • 4.2.11 TRFC
      • 4.2.12 TESF
      • 4.2.13 ADCF
      • 4.2.14 TSCF
      • 4.2.15 Read File
      • 4.2.16 Override Files
    • 4.3 Databases
    • 4.4 Input Layers
      • 4.4.1 Input Formats
      • 4.4.2 GIS Commands
        • 4.4.2.1 GIS Attribute Interpretation
        • 4.4.2.2 GIS Object Interpretation
      • 4.4.3 GeoPackage Commands
        • 4.4.3.1 GPKG Input Commands
        • 4.4.3.2 GPKG Output Commands
      • 4.4.4 Grid Commands
      • 4.4.5 TIN Commands
      • 4.4.6 RowCol Commands (Legacy)
    • 4.5 Layering Data
    • 4.6 XF Files
  • 5 1D Network Domains - ESTRY
    • 5.1 Introduction
    • 5.2 Schematisation
    • 5.3 Solution Scheme
    • 5.4 1d_nwk Attributes
    • 5.5 Channels Overview
    • 5.6 Open Channels
      • 5.6.1 Inertial Channels
      • 5.6.2 Non-Inertial Channels
    • 5.7 Cross-Sections
      • 5.7.1 Type “XZ” Optional Flags
        • 5.7.1.1 Relative Resistance
      • 5.7.2 Type “HW” Optional Flags
        • 5.7.2.1 Flow Area (A)
        • 5.7.2.2 Wetted Perimeter (P)
        • 5.7.2.3 Manning’s n Values (N)
        • 5.7.2.4 Manning’s n Values (F)
      • 5.7.3 Parallel Channel Analysis
      • 5.7.4 Effective Area versus Total Area
      • 5.7.5 Mid Cross-Sections
      • 5.7.6 End Cross-Sections
      • 5.7.7 Interpolated Cross-Section Protocols
    • 5.8 Structures
      • 5.8.1 Culverts and Pipes
        • 5.8.1.1 Blockage Matrix
        • 5.8.1.2 Limitations
      • 5.8.2 Bridges
        • 5.8.2.1 Bridges Overview
        • 5.8.2.2 Bridge Cross-Section and Loss Tables
        • 5.8.2.3 B Bridge Losses Approach
        • 5.8.2.4 BB Bridge Losses Approach
      • 5.8.3 Arch Bridge
        • 5.8.3.1 Arch Bridge Editor
        • 5.8.3.2 Arch Minimum Blockage
      • 5.8.4 Weirs
        • 5.8.4.1 Weirs Overview
        • 5.8.4.2 Original Weirs (W)
        • 5.8.4.3 Advanced Weirs (WB, WC, WD, WO, WR, WT, WV, WW)
        • 5.8.4.4 Advanced Weir Submergence Curves
        • 5.8.4.5 Automatically Created Weirs
        • 5.8.4.6 VW Channels (Variable Geometry Weir)
      • 5.8.5 Spillways (SP)
      • 5.8.6 Sluice Gates (SG)
      • 5.8.7 Adjustment of Contraction and Expansion Losses
    • 5.9 Special Channels
      • 5.9.1 M Channels (User Defined Flow Matrix)
      • 5.9.2 Q Channels (Upstream Depth-Discharge Relationship)
      • 5.9.3 X Connectors
      • 5.9.4 Legacy Channels
      • 5.9.5 1d_nwk Attributes (M, P, Q, SG, SP Channels)
    • 5.10 Operational Channels
      • 5.10.1 .toc File Commands and Logic
        • 5.10.1.1 Define Control Command
        • 5.10.1.2 User Defined Variables
        • 5.10.1.3 Logic Rules
        • 5.10.1.4 Incremental Operators
      • 5.10.2 Pumps (P and PO)
      • 5.10.3 QO Channels
      • 5.10.4 Gated Drowned Rectangular Culverts (RO)
      • 5.10.5 Sluice Gates (SG and SGO)
      • 5.10.6 Spillways with Gates (SPO)
      • 5.10.7 Weirs (WBO, WCO, WDO, WOO, WRO, WTO)
      • 5.10.8 Piping and Dam Failure
        • 5.10.8.1 Piping Failure (PF)
        • 5.10.8.2 Dam Failure (DF)
    • 5.11 Pipe Networks
      • 5.11.1 Pipes
      • 5.11.2 Pits
        • 5.11.2.1 1d_nwk Pits
        • 5.11.2.2 1d_pit Pits
        • 5.11.2.3 Connecting Pits and Nodes to 2D Domains
      • 5.11.3 Pit Inlet and Depth/Stage vs Discharge Databases
        • 5.11.3.1 Road Crossfall Options
      • 5.11.4 Manholes
        • 5.11.4.1 Automatically Assigned Manholes
        • 5.11.4.2 Manually Assigned Manholes (1d_mh Layer)
        • 5.11.4.3 Digitising Culverts Connected to Manholes
        • 5.11.4.4 Engelund Manhole Loss Approach
        • 5.11.4.5 Fixed Manhole Loss Approach
        • 5.11.4.6 Discussion on Approaches to Modelling Pipe Junction Losses
    • 5.12 Virtual Pipes
    • 5.13 Nodes
      • 5.13.1 Automatically Defined Nodes
        • 5.13.1.1 Storage Calculated Automatically from Channel Widths
        • 5.13.1.2 Additional Storage Added from Len_or_ANA Attribute
      • 5.13.2 Manually Defined Nodes
        • 5.13.2.1 Storage Nodes (User Defined NA Tables)
        • 5.13.2.2 Using Nodes to Define Channel Inverts
        • 5.13.2.3 Automatically Connecting Nodes to 2D domains
      • 5.13.3 Storage Above Top of Channels
  • 6 1D Network Domains - EPA SWMM
    • 6.1 Introduction
      • 6.1.1 TUFLOW-SWMM Capabilities
      • 6.1.2 Additional SWMM User Resources
    • 6.2 Model Setup
      • 6.2.1 SWMM Model
      • 6.2.2 TUFLOW-SWMM Model Simulation
      • 6.2.3 Linking SWMM to TUFLOW 2D and ESTRY
      • 6.2.4 SWMM Simulation Option Settings
      • 6.2.5 Using the TUFLOW BC Database in SWMM
    • 6.3 SWMM GIS Tools
      • 6.3.1 GeoPackage File Format
        • 6.3.1.1 GeoPackage File Table Overview
        • 6.3.1.2 GeoPackage Options Table
    • 6.4 SWMM Outputs
    • 6.5 SWMM Inclusion in TUFLOW
      • 6.5.1 SWMM Library Version
      • 6.5.2 Embedded SWMM Code in TUFLOW
  • 7 2D Domains
    • 7.1 Introduction
    • 7.2 Solvers
      • 7.2.1 TUFLOW HPC 2D Solver
      • 7.2.2 TUFLOW Classic 2D Solver
      • 7.2.3 Cell Schematisation
        • 7.2.3.1 Computational Points
      • 7.2.4 Turbulence
        • 7.2.4.1 Dry Wall Treatment
    • 7.3 Common Functionality
      • 7.3.1 Defining the Domain
      • 7.3.2 Active / Inactive Cells
      • 7.3.3 Data Layering
      • 7.3.4 Sampling of Data Sets
        • 7.3.4.1 Traditional Sampling Approach
      • 7.3.5 Elevations
        • 7.3.5.1 Direct Reading of DEM Grids
        • 7.3.5.2 Z Shape Layers (2d_zsh)
        • 7.3.5.3 Variable Z Shape Layer (2d_vzsh)
        • 7.3.5.4 3D TIN Layers (2d_ztin)
        • 7.3.5.5 3D Breakline Layers (2d_zln)
        • 7.3.5.6 Zpt Layers (2d_zpt)
        • 7.3.5.7 Using Multiple Layers and Points Layers
      • 7.3.6 Land Use (Materials)
        • 7.3.6.1 Bed Resistance
        • 7.3.6.2 Log Law Depth Varying Bed Resistance
        • 7.3.6.3 Materials File
        • 7.3.6.4 Rainfall Losses
      • 7.3.7 Infiltration
        • 7.3.7.1 Infiltration Layer
        • 7.3.7.2 Soils File (.tsoilf)
      • 7.3.8 Hydraulic Structures
        • 7.3.8.1 Introduction
        • 7.3.8.2 2D Bridge Structures (2d_bg)
        • 7.3.8.3 Layered Flow Constrictions (2d_lfcsh Layers)
      • 7.3.9 Cell Modification
        • 7.3.9.1 Storage Reduction (2d_srf)
        • 7.3.9.2 Cell Width Factor (CWF)
        • 7.3.9.3 Form Loss Coefficient (FLC)
        • 7.3.9.4 Modify Conveyance
      • 7.3.10 Modelling Urban Areas
        • 7.3.10.1 Buildings
        • 7.3.10.2 Roads
        • 7.3.10.3 Fences and Walls
    • 7.4 TUFLOW HPC Specific
      • 7.4.1 Quadtree
        • 7.4.1.1 Quadtree .tcf Commands
        • 7.4.1.2 Quadtree Control File (.qcf) – Mandatory Commands
        • 7.4.1.3 Quadtree Control File (.qcf) – Optional Commands
        • 7.4.1.4 Defining Grid Refinement Polygons
      • 7.4.2 HPC Turbulence
        • 7.4.2.1 Overview
        • 7.4.2.2 Constant Eddy Viscosity
        • 7.4.2.3 Smagorinsky Approach
        • 7.4.2.4 Wu Approach
      • 7.4.3 Sub-Grid Sampling (SGS)
        • 7.4.3.1 SGS Methodology and Commands
        • 7.4.3.2 SGS Output Options
      • 7.4.4 2D Upstream Controlled Flow (Weirs and Supercritical Flow)
      • 7.4.5 Infiltration and Groundwater Flow
        • 7.4.5.1 Infiltration
        • 7.4.5.2 Groundwater Flow
        • 7.4.5.3 HPC Soils File (.tsoilf)
      • 7.4.6 Non-Newtonian Flow
        • 7.4.6.1 Implementation
        • 7.4.6.2 Non-Newtonian Mixing
      • 7.4.7 Unsupported Features in TUFLOW HPC
    • 7.5 TUFLOW Classic Specific
      • 7.5.1 Classic Turbulence
        • 7.5.1.1 Constant
        • 7.5.1.2 Smagorinsky
      • 7.5.2 2D Upstream Controlled Flow (Weirs and Supercritical Flow)
      • 7.5.3 Land Use (Materials)
      • 7.5.4 Multiple 2D Domain
      • 7.5.5 Coriolis Term
      • 7.5.6 Legacy Structures
        • 7.5.6.1 2D Flow Constrictions (2d_fcsh and 2d_fc)
        • 7.5.6.2 Applying Form (Energy) Loss in 2D FC and FCSH Layers
      • 7.5.7 Unsupported Features in TUFLOW Classic
  • 8 Boundaries and Initial Conditions
    • 8.1 Introduction
    • 8.2 Recommended BC Arrangements
    • 8.3 Solver Specific Considerations
      • 8.3.1 Classic Specific Boundaries / Options
      • 8.3.2 HPC Specific Boundaries / Options
        • 8.3.2.1 HPC Energy Options for 2D HT, HQ and QT Boundaries
        • 8.3.2.2 HPC HQ Boundary Approach
        • 8.3.2.3 HPC HQ Boundary Stability
        • 8.3.2.4 HPC Additional Boundary Options
        • 8.3.2.5 Quadtree BC Parallel Inertia Approach
    • 8.4 1D Boundaries (1d_bc Layers)
    • 8.5 2D Boundaries (2d_bc, 2d_sa and 2d_rf Layers)
      • 8.5.1 Boundary Conditions (2d_bc)
        • 8.5.1.1 Sloping Water Level Boundaries
        • 8.5.1.2 Groundwater Boundaries
      • 8.5.2 Source Area Boundaries
        • 8.5.2.1 Source Area Options (2d_sa)
        • 8.5.2.2 Rainfall Option (2d_sa_rf)
        • 8.5.2.3 Trigger Option (2d_sa_tr)
        • 8.5.2.4 Flow Feature (2d_sa_po)
        • 8.5.2.5 Overlapping 2d_sa regions
      • 8.5.3 Rainfall Boundaries
        • 8.5.3.1 Rainfall Overview
        • 8.5.3.2 Considerations for Rainfall Modelling
        • 8.5.3.3 Global Rainfall
        • 8.5.3.4 Rainfall Polygons (2d_rf)
        • 8.5.3.5 Gridded Rainfall
        • 8.5.3.6 Rainfall Control File (.trfc file)
    • 8.6 Boundary Condition (BC) Database
      • 8.6.1 BC Database Example
      • 8.6.2 BC Event Name Command
      • 8.6.3 TUFLOW Boundary Generators
      • 8.6.4 Delft FEWS Boundaries
      • 8.6.5 HEC-DSS Boundaries
    • 8.7 Cyclones / Hurricanes / Typhoons
    • 8.8 External Stress Boundaries
    • 8.9 Initial Conditions
      • 8.9.1 Initial Water Levels (IWL)
        • 8.9.1.1 1D Domains
        • 8.9.1.2 2D Domains
        • 8.9.1.3 Automatic Initial Water Level
      • 8.9.2 Initial Groundwater Levels
      • 8.9.3 Restart Files
  • 9 Advection Dispersion
    • 9.1 Overview
    • 9.2 2D Domains
      • 9.2.1 2D Depth Averaged Equation of Motion
      • 9.2.2 Solution Method (TUFLOW Classic)
      • 9.2.3 Solution Method (TUFLOW HPC)
      • 9.2.4 Local Constituent Transformation
      • 9.2.5 Groundwater
      • 9.2.6 Limitations
    • 9.3 1D Domains
      • 9.3.1 1D Cross-Sectional Averaged Equation of Motion
      • 9.3.2 1D Solution Method (ESTRY)
      • 9.3.3 Limitations
    • 9.4 The Modelling Process
      • 9.4.1 Data Input Requirements
      • 9.4.2 Calibration and Sensitivity
      • 9.4.3 Model Resolution
      • 9.4.4 Computational Timestep
      • 9.4.5 Example AD Models
    • 9.5 Data Input
      • 9.5.1 Simulation Control File
        • 9.5.1.1 TUFLOW AD Control File (.adcf File)
        • 9.5.1.2 GIS Input File Types and Naming Conventions
      • 9.5.2 1D Geometries
      • 9.5.3 Specification of Constituent Properties
      • 9.5.4 Boundary Conditions
        • 9.5.4.1 Boundary Condition (BC) Database
        • 9.5.4.2 BC Database Example
      • 9.5.5 Initial Conditions
      • 9.5.6 Groundwater Initial Conditions
      • 9.5.7 Minimum Dispersion Coefficient
    • 9.6 Data Output
      • 9.6.1 TUFLOW AD Log Files
        • 9.6.1.1 Simulation Log File
        • 9.6.1.2 CFL Log File
        • 9.6.1.3 Mass Log File
      • 9.6.2 Check Files
      • 9.6.3 Result Files
  • 10 Combining Domains and Solvers
    • 10.1 Introduction
    • 10.2 1D and 2D Domain Linking Theory
      • 10.2.1 HX 2D Head Boundary
      • 10.2.2 SX 2D Flow Boundary
    • 10.3 TUFLOW 1D (ESTRY) to TUFLOW 2D Linking
      • 10.3.1 1D Open Channel and 2D Domain Linking
      • 10.3.2 1D Structures Embedded within 2D Domains
      • 10.3.3 1D Pipe Network Pits linked to 2D Domains
      • 10.3.4 Virtual Pits linked to 2D Domains
    • 10.4 SWMM to TUFLOW Linking
      • 10.4.1 1D Culvert Connections to 2D Domains
      • 10.4.2 1D Pipe Network Connections to 2D Domains
      • 10.4.3 SWMM to TUFLOW 1D (ESTRY) Linking
    • 10.5 Flood Modeller to TUFLOW Linking
      • 10.5.1 Flood Modeller 1D to TUFLOW 2D Linking
      • 10.5.2 Flood Modeller 1D to TUFLOW 1D (ESTRY) Linking
    • 10.6 12D-DDA to TUFLOW Linking
    • 10.7 Multiple 2D Domains
      • 10.7.1 Classic’s M2D Feature versus HPC Quadtree
      • 10.7.2 TUFLOW Classic’s Multiple 2D Domains
  • 11 Outputs
    • 11.1 Output Location
    • 11.2 Map Outputs
      • 11.2.1 Output Time Controls
      • 11.2.2 Map Output Formats
        • 11.2.2.1 Mesh Based Formats
        • 11.2.2.2 Grid Based Formats
        • 11.2.2.3 High-Resolution Grids
        • 11.2.2.4 Combined Format
        • 11.2.2.5 GIS Based Format
      • 11.2.3 Map Output Data Types
        • 11.2.3.1 Hazard Data Types
      • 11.2.4 1D Map Outputs
        • 11.2.4.1 Water Level Lines
        • 11.2.4.2 Water Level Line Points
        • 11.2.4.3 Adding Triangles into the 1d_WLL Layer
      • 11.2.5 Output Zones
      • 11.2.6 Gauge Level Output
    • 11.3 Time-Series Outputs
      • 11.3.1 1D Time-Series Output
      • 11.3.2 2D Time-Series Output
        • 11.3.2.1 Plot Output
        • 11.3.2.2 Long Profile Output
      • 11.3.3 Reporting Locations
      • 11.3.4 Structure Output
    • 11.4 Specialised Outputs
      • 11.4.1 Receptors
      • 11.4.2 Evacuation Routes
    • 11.5 Check and Log Files
    • 11.6 Output Control Commands
  • 12 Hardware and Operating System
    • 12.1 Introduction
    • 12.2 Operating Systems
    • 12.3 TUFLOW Classic
    • 12.4 TUFLOW HPC (Including Quadtree)
      • 12.4.1 TUFLOW HPC Solver on CPU
      • 12.4.2 TUFLOW HPC Solver on GPU
      • 12.4.3 Types of GPU
      • 12.4.4 Utilising Multiple GPUs for One Model
      • 12.4.5 Running Multiple Models on a Single GPU
      • 12.4.6 Differences in results between CPU and GPU
      • 12.4.7 RAM
    • 12.5 Proxies for CPU and GPU performance
    • 12.6 Virtualisation
    • 12.7 Cloud Compute
    • 12.8 Commands
  • 13 Managing and Starting Simulations
    • 13.1 Introduction
    • 13.2 File Naming
    • 13.3 Simulation Management
      • 13.3.1 Events
      • 13.3.2 Scenarios
      • 13.3.3 Variables
    • 13.4 TUFLOW Executable Download
      • 13.4.1 Overview and Where to Install
      • 13.4.2 Single and Double Precision
        • 13.4.2.1 TUFLOW Classic
        • 13.4.2.2 TUFLOW HPC
      • 13.4.3 Customising TUFLOW using TUFLOW_USER_DEFINED.dll
    • 13.5 Running Simulations
      • 13.5.1 Dongle Types and Setup
        • 13.5.1.1 Protocols for Accessing Dongles
        • 13.5.1.2 TUFLOW_Licence_Settings.lcf File
        • 13.5.1.3 Dongle Failure during a Simulation
      • 13.5.2 Starting a Simulation
        • 13.5.2.1 Batch File Example and Run Options (Switches)
        • 13.5.2.2 Copy/Package Model from Batch Files
        • 13.5.2.3 Advanced Batch Files
      • 13.5.3 Running TUFLOW HPC
        • 13.5.3.1 TUFLOW HPC and GPU Module Commands
        • 13.5.3.2 Compatible Graphics Cards
        • 13.5.3.3 Updating NVIDIA Drivers
        • 13.5.3.4 NVLink – Multi-GPU Performance (HPC Only)
        • 13.5.3.5 Troubleshooting
      • 13.5.4 Running TUFLOW 1D Only Simulations
    • 13.6 Using TUFLOW with Flood Modeller, SWMM, XP-SWMM, 12D or from SMS
      • 13.6.1 Using TUFLOW with EPA SWMM
      • 13.6.2 Using TUFLOW with Flood Modeller
      • 13.6.3 Using TUFLOW with 12D
      • 13.6.4 Using TUFLOW with XP-SWMM
      • 13.6.5 Using TUFLOW with SMS
    • 13.7 Optimising Startup and Run Times
      • 13.7.1 Improved pre-processing of 1D Model Inputs
      • 13.7.2 Parallel Processing for SGS initialisation
      • 13.7.3 Optimising Multi-GPU Performance (HPC Only)
      • 13.7.4 Auto Terminate (Simulation End) Options
    • 13.8 Reproducibility of Results
      • 13.8.1 TUFLOW Classic (CPU only)
      • 13.8.2 TUFLOW HPC (incl. Quadtree) on CPU
      • 13.8.3 TUFLOW HPC (incl. Quadtree) on GPU
      • 13.8.4 TUFLOW HPC (incl. Quadtree) on multiple GPUs / CPU threads
  • 14 Checks and Log Files
    • 14.1 Introduction
    • 14.2 Console (DOS) Window Display
      • 14.2.1 TUFLOW Classic
      • 14.2.2 TUFLOW HPC
      • 14.2.3 The Console (DOS) Window Does Not Appear
      • 14.2.4 Unexpected Simulation Pause (DOS Quick Edit Mode)
      • 14.2.5 Stopping the Console Window
      • 14.2.6 Customisation of Console Window
      • 14.2.7 TUFLOW Windows ERROR LEVEL Reporting
    • 14.3 Message Boxes
    • 14.4 Simulations .log
      • 14.4.1 Local .log File
      • 14.4.2 Global .log File
    • 14.5 Simulation Log Files
      • 14.5.1 TLF
        • 14.5.1.1 HPC TLF and DT
      • 14.5.2 TSF
      • 14.5.3 Start Stats
      • 14.5.4 Run Stats
      • 14.5.5 Messages
      • 14.5.6 GIS Workspaces
    • 14.6 1D Output File
    • 14.7 Check Files
    • 14.8 Mass Balance Output
      • 14.8.1 Mass Balance Definitions
      • 14.8.2 TUFLOW 1D Mass Balance
      • 14.8.3 TUFLOW Classic Mass Balance
      • 14.8.4 TUFLOW HPC Mass Balance
  • 15 Viewing Outputs
    • 15.1 Introduction
    • 15.2 Folder Structure
    • 15.3 1D Output
      • 15.3.1 TUFLOW Plot Control file (TPC)
      • 15.3.2 Maximum and Minimum Output
      • 15.3.3 ccA GIS Layer
      • 15.3.4 _TS GIS Layer
      • 15.3.5 1D Water Level Lines (WLL)
    • 15.4 2D Output
      • 15.4.1 Mesh Output
      • 15.4.2 Raster Output
      • 15.4.3 Plot Output
    • 15.5 Post Processing
    • 15.6 Impact Mapping
    • 15.7 Animations
  • 16 Quality Control and Troubleshooting
    • 16.1 Introduction
    • 16.2 Model Health
      • 16.2.1 TUFLOW Classic
        • 16.2.1.1 Timestep
      • 16.2.2 TUFLOW HPC
        • 16.2.2.1 Timestep
      • 16.2.3 Healthy Model Indicators
    • 16.3 Troubleshooting
      • 16.3.1 General Comments
      • 16.3.2 Instability Identification
        • 16.3.2.1 1D (ESTRY) Domains
        • 16.3.2.2 TUFLOW Classic
        • 16.3.2.3 TUFLOW HPC
        • 16.3.2.4 1D/2D Links
        • 16.3.2.5 Other General Troubleshooting Recommendations
    • 16.4 QA Check List and Simulation Logging
    • 16.5 Models Exceeding Hardware RAM
      • 16.5.1 Computer RAM
      • 16.5.2 TUFLOW Version
      • 16.5.3 Model Design
      • 16.5.4 Memory Usage Reporting
      • 16.5.5 Temporary Memory Usage
      • 16.5.6 TUFLOW HPC GPU Module and RAM requirements
    • 16.6 Past Release Version Backward Compatibility
  • 17 Utilities
    • 17.1 Introduction
    • 17.2 GIS Based Utilities
      • 17.2.1 QGIS TUFLOW Plugin
      • 17.2.2 ArcGIS Pro Toolbar
      • 17.2.3 ArcMap Toolbox
      • 17.2.4 MiTools
    • 17.3 Console Utilities
      • 17.3.1 Pre and Post Processing
      • 17.3.2 Convert to TUFLOW
      • 17.3.3 Textfile Syntax Highlighting
      • 17.3.4 PyTUFLOW
      • 17.3.5 Excel Macros
  • 18 Default Changes
    • 18.1 2025.0 Release
    • 18.2 2023-03 Release
    • 18.3 2020-10 Release
    • 18.4 2020-01 Release
    • 18.5 2018-03 Release
    • 18.6 2017-09 Release
    • 18.7 2016-03 Release
    • 18.8 2013-12 Release
    • 18.9 2012-05 Release
    • 18.10 2011-09 Release
    • 18.11 2010-10 Release
    • 18.12 2009-07 Release
    • 18.13 2008-08 Release
    • 18.14 2007-07 Release
    • 18.15 2006-06 Release
    • 18.16 Pre 2006-06 Release
  • Appendix
  • A TCF Commands
  • B ECF Commands
  • C TGC Commands
  • D TBC Commands
  • E TOC Commands
  • F TRFC Commands
  • G TESF Commands
  • H QCF Commands
  • I TSCF Commands
  • J ADCF Commands
  • K TEF Commands
  • L SWMM GeoPackage Format
    • L.1 SWMM GeoPackage Layer List
    • L.2 SWMM GeoPackage Layer Descriptions
  • References

TUFLOW Classic/HPC User Manual Release Candidate 2025.1

TUFLOW Classic/HPC User Manual Release Candidate 2025.1

RELEASE CANDIDATE

This is an interim manual that accompanies the TUFLOW Classic/HPC 2025.1.0-rc.1 release candidate. The information contained within this interim version may vary from the subsequent final version.

Updated on 17 Apr 2025

www.tuflow.com
TUFLOW Wiki
TUFLOW Tutorial Module Models
support@tuflow.com

How to Use This Manual
List of Figures
List of Tables
Changelog

.tcf Commands
.ecf Commands
.tgc Commands
.tbc Commands