Introduction
Document Updates and Important Notices
Summary
Licensing
1
Overview
1.1
2023-03 Release
2
2D Domain Construction
2.1
Quadtree Updates (HPC Only)
2.1.1
Support for Multiple GPU
2.1.2
Support for Multiple Nesting GIS Layers
2.1.3
Support “Trigger 1D” for Variable Z Shape
2.2
Sub-Grid Sampling (SGS) Changes
2.2.1
SGS Default Changes
2.2.2
SGS Approach
2.2.3
Setting SGS Sampling Frequency
2.2.4
SGS Materials
2.2.5
High Resolution Interpolation Approach
2.2.6
High Resolution Thin Breaklines
2.2.7
Parallel Processing for SGS initialisation
2.2.8
XF Files for SGS Method C
2.2.9
Enhancement for SGS Parameterisation
2.2.10
Enhancement of Water Level Interpolation at BC Cells with Steep Bed Slope
2.3
Infiltration and Sub-Surface Flows
2.3.1
Overview
2.3.2
Soils File
2.3.3
TGC Commands
2.3.4
Boundaries
2.3.5
Groundwater Map Outputs
2.3.6
Groundwater Plot Outputs
2.3.7
Groundwater and Advection Dispersion
2.3.8
Groundwater Blend Threshold
2.3.9
Initial Moisture and Green-Ampt Infiltration
2.3.10
Improvements in Reading Soil File (.tsoilf)
2.3.11
Bug Fix for Infiltration and Advection Dispersion
2.4
Modelling Bridge Structure in 2D
2.4.1
CFD Benchmarking Study
2.4.2
New Input Layer for Modelling Bridge Structure in 2D
2.4.3
Automatic Generation of Superstructure FLC
2.4.4
Grouped Structure Output
2.5
Advection Dispersion
2.5.1
HPC Support for Multiple Constituents Per Simulation
2.5.2
HPC Support for Constituent Settling and Decay
2.5.3
Layered Interflow - Advection Dispersion TGC Commands
2.6
Non-Newtonian Mixing
2.7
Minor Enhancements and Bug Fixes
2.7.1
Fix to Memory Efficient Quadtree Meshing Algorithm
2.7.2
Duplicate Material IDs
2.7.3
Duplicate Soil IDs
2.7.4
Check Added for Valid Non-Newtonian Coefficients
2.8
2023-03-AB Minor Enhancements and Bug Fixes
2.8.1
Bug Fix to HR Breakline Adjustment with Output Zone
2.8.2
Read GIS / GRID Soil Layer Accepts Multiple Layer Numbers
2.8.3
Un-Deprecated GWD and GWL Commands
2.8.4
Bug Fix HPC GWQ PO Units
2.8.5
Bug Fix for Ground Water Outputs
2.8.6
Bug Fix for Infiltration Outputs in Classic
2.8.7
Bug Fix for HPC Breakline Memory Release
2.8.8
Infiltration When No Soil Capacity and Infinite Depth Soil
2.9
2023-03-AC Minor Enhancements and Bug Fixes
2.9.1
Bug Fix to Default SGS Elevation
2.9.2
Bug Fix to Quadtree Clip Region
2.9.3
Bug Fix to Read TIN Command in HPC Model
2.9.4
Bug Fix Quadtree 2d_zsh Snapped to Code
2.9.5
Bug Fix for “Blockage Return Period” Command
2.9.6
Bug Fix for Long Breaklines in Quadtree
2.10
2023-03-AD Minor Enhancements and Bug Fixes
2.10.1
Bug Fix HPC Initial Tracer Concentration
2.10.2
Bug Fix for Auto Generated Bridge FLC with ‘Bridge_width’
2.10.3
Bug Fix for Longitudinal Profile Output (LP) in Quadtree Models
2.10.4
Bug Fix for Invalid 2d_code Values
2.10.5
Bug Fix for Large SX/HX BC Connections in Quadtree
3
1D Solver - ESTRY
3.1
Arch Bridge
3.1.1
Arch Bridge Editor
3.1.2
Bug Fix with Modelling Multiple Arch Bridges
3.1.3
Arch Bridge Error Message Number Assignment
3.1.4
Arch Bridge Warning Message for Low Blockage
3.2
Ability to Model Time Lag in Virtual Pipes
3.3
Enhancement to Adverse Slope Culvert
3.4
Improvement to Structure Flow Level Options
3.5
Automatically Generated 1D HQ Boundaries
3.6
New 1D (ESTRY) Output Variables
3.7
Minor Enhancements and Bug Fixes for 2023-03-AA
3.7.1
Unused Manning’s n Value Set to Zero in nwk_C Check File and .eof
3.7.2
Fixes to Write Check Files [Exclude | Include | None | ALL] == [OFF]
3.7.3
Pit_A Check File Incorrectly Reporting Width
3.7.4
Pit_A Check File Increased Type Attribute Length
3.7.5
Incorrect ‘B’ Type Bridge Form Loss Reported in the .eof
3.7.6
Pump Inverts Reported in the .eof
3.7.7
1D Pump Point Objects Now Produce ERROR 1438
3.7.8
Pump Curves No Longer Trigger ERROR 1092 and ERROR 1093
3.7.9
ERROR 2056 Incorrectly Triggering
3.7.10
WARNING 2039 Counts All Ignored SX Pit Connections
3.7.11
1D Operable Structures Linked to 2D Water Level (H2D) Updating on Map Update Interval
3.7.12
Linking 1D Operable Structures to 2D PO Points not Functional as Described
3.7.13
Bug Fix to Invert Levels used in PF Channel Flow Calculation
3.7.14
ERROR 1261 Incorrectly Triggering for 1D PF/DF Channels
3.7.15
Enhancement and Bug Fix for PF/DF Channel Check Files
3.7.16
Setting Initial State of 1D DF Channel
3.7.17
WARNING Message for Using Zero Pump Capacity
3.7.18
Enhancement Reducing Memory Usage for Operational Channels
3.7.19
WARNING/ERROR Message for Using Wrong GIS Type in 1d_nwk
3.7.20
ERROR Message for Using Bridge Flow == Method A in Structure Routines == 2013 (Default)
3.7.21
Bug Fix for ERROR 1025
3.7.22
Bug Fix for WARNING 2073
3.8
2023-03-AB Minor Enhancements and Bug Fixes
3.8.1
Operational Channel Memory Allocation Error
3.8.2
Operational Channels Handle Multiple AND or OR Statements on Same Line
3.8.3
Bug Fix for Virtual Pipe Model Not Writing Output
3.8.4
Bug Fix for WLL Should Not Be Here
3.9
2023-03-AC Minor Enhancements and Bug Fixes
3.9.1
Bug Fix to VPO Connected to 1D Channel
3.9.2
Bug Fix to Water Level Lines (WLL) when Virtual Pipes are Used
3.10
2023-03-AD Minor Enhancements and Bug Fixes
3.10.1
Bug Fix to Water Level Lines (WLL) when Snapped to Nodes
3.10.2
Bug Fix to Prevent Freeze When Channel is Connected to Same Node Upstream and Downstream
3.10.3
Bug Fix to Models with 1D Node Names Alphanumerically After “ZZ000”
3.10.4
Reduced Screen Output for 1D Initialisation
3.10.5
Bug Fix for Pits with Large Search Distances Connecting to the Wrong 1D Node
3.10.6
Eliminated Warning 1100 at Manhole Nodes
4
1D Solver - SWMM
4.1
Overview
4.2
SWMM-TUFLOW Commands
4.2.1
TUFLOW Control File Commands (TCF)
4.2.2
TUFLOW SWMM Control File Commands (TSCF)
4.3
SWMM Input Files
5
2D Solvers - Classic/HPC
5.1
Overview
5.2
2D HPC Weir Flow Approach
5.3
Support for Record Gauge Data in HPC
5.4
Support for Automatic Initial Water Level in Quadtree
5.5
Support for Long Profiles in HPC
5.6
Increase in Maximum CPU Threads
5.7
Minor Enhancements and Bug Fixes
5.7.1
Limiting Manning’s n for Wu Turbulence Calculation
5.7.2
TIN Clip Layers in Quadtree
5.7.3
Change to Treatment of non-Polygon Objects in Geometry Trim Layers
5.7.4
WARNING 3522 Message Text Updated
5.7.5
New Thick Breakline Face Selection for Quadtree Model
5.7.6
Support Read GIS Zpts Polygon Shape in SGS Method C
5.7.7
Support Read GRID Zpts ADD Option for SGS Method C
5.7.8
Read RowCol Zpts and Read GIS Zpts With Point Layer Now Produce ERROR 3517 in SGS or Quadtree Models
5.7.9
Error for TGC Command Read Grid IWL used in .tcf
5.8
2023-03-AB Minor Enhancements and Bug Fixes
5.8.1
Running Simulations at the Exact Same Time Causes XF File “End Of File” Error
5.8.2
Bug Fix for “Should Not Be Here [tE” with HPC and Restart Files
5.8.3
Bug Fix for “Should not Be Here [tE” at End of Simulation
5.8.4
Bug Fix for Forward Slash in Check File Path
5.8.5
Bug Fix for Stability Issue with Thick Breaklines
5.8.6
Bug Fix for Small HPC models on CPU with a Large Number of Threads
5.8.7
Bug Fix with SGS Calculation
5.8.8
Bug Fix with Fixed Form Loss Coefficients in Quadtree
5.8.9
Update to CHECK 3505 SGS TIN for Quadtree Model
5.8.10
Bug Fix 2d_lfcsh Layers in Quadtree Snapped to Code
5.9
2023-03-AD Minor Enhancements and Bug Fixes
5.9.1
Bug Fix - HPC Crashing During Initialisation with Exactly 256 Unique Material IDs
5.9.2
Bug Fix with Process All Grids Command
5.9.3
Bug Fix with Memory Allocation for Reading Grids with SGS
5.9.4
Bug Fix for Cell Width Factor in HPC
5.9.5
Extra Information in XF Filenames
5.9.6
Bug Fix for Wide Lines
5.9.7
Enhancement for HPC and Quadtree Restart Files
5.9.8
Quadtree - Removes One Parent Polygon Requirement (Fast Method)
5.9.9
Bug Fix for No Time Series Output in run_stats.txt
5.9.10
Enhancement Automatic Recreation of Invalid XF Files
5.9.11
Changes to Reported Timestep Efficiency
5.9.12
Fix to Initial Groundwater Map Output Results with “GT” Boundaries
6
Boundaries and Links
6.1
Support for DSS File Format
6.2
SX Momentum
6.3
Structure Loss Adjustment for SX Connected 1D Structures
6.4
Quadtree Parallel Inertia on HT / HX Boundaries
6.5
HPC Support for Boundary Spline Interpolation
6.6
Default HPC Boundary Approach
6.7
QT 2d_bc Point Boundaries No Longer Supported in Classic/HPC
6.8
HQ 2d_bc Point Boundaries No Longer Supported in Classic/HPC/Quadtree
6.9
Support for Holland Cyclone/Hurricane in HPC/Quadtree
6.10
Minor Enhancements and Bug Fixes
6.10.1
Should Not Be Here When Reading TS1 File
6.10.2
Duplicate SA Boundary Names
6.10.3
CSV Inputs Containing Multiple Blocks
6.10.4
BC Zero Flow End Fixed in Quadtree
6.10.5
BC Zero Flow CHECK Message
6.10.6
Automatic Initial Water Level When Interpolated
6.10.7
SX Region with Z Flag in Quadtree Model
6.10.8
Small SX Region Selects At Least One Cell in Quadtree Model
6.10.9
Check for Correct Attribute for SA RF Boundaries
6.10.10
Bug Fix for XF files when Time Column has Zero Rows of Data
6.11
2023-03-AB Minor Enhancements and Bug Fixes
6.11.1
Quadtree HQ Total Boundary - Should Not Be Here
6.11.2
Better Handling of Null Objects in 2d_sa Layer
6.12
2023-03-AC Minor Enhancements and Bug Fixes
6.12.1
Fixes Issue with NetCDF Rainfall with Times Greater Than 1,000 Hours
6.12.2
Fixes Issue with Rainfall Control File with Greater than 1,000 Output Times
6.13
2023-03-AD Minor Enhancements and Bug Fixes
6.13.1
Bug Fix for 2D HQ Boundaries Selecting Only One Cell
6.13.2
Bug Fix for Quadtree Automatic SX Connections Where “Conn_No” is Set to -1
6.13.3
Bug Fix for SA Check Files
6.13.4
Bug Fix for Very Large Models with SX Connections
6.13.5
Bug Fix for Gridded Rainfall in HPC
6.13.6
Support for Global Wind Boundary in Quadtree
7
GIS Formats
7.1
GeoPackage Format
7.1.1
GeoPackage Projection
7.1.2
GeoPackage Vector
7.1.3
GeoPackage Conversion Check
7.1.4
GeoPackage Raster
7.2
GeoTIFF Format
7.3
NetCDF Grid
7.4
2023-03-AB Minor Enhancements and Bug Fixes
7.4.1
Spatial Database Command Now Works in Quadtree Control File
7.4.2
Read GRID Location Now Works for New Raster Formats
7.4.3
Compression Now Allows for Size Increase
7.4.4
Increase Primary Key Column Name Length
7.4.5
Retry Loop for Locked GPKG Databases
7.4.6
GPKG XF File Naming
7.4.7
Bug Fix “Reached maximum concurrent SQLite statements”
7.4.8
Bug Fix “ERROR 0636 – Issue stepping through SQLite query”
7.4.9
GPKG Multi-Part Polygons
7.4.10
ERROR 0305 Triggering When There is No GPKG Projection
7.5
2023-03-AC Minor Enhancements and Bug Fixes
7.5.1
GPKG XF File Creation Causing “ERROR 0645”
7.5.2
Bug Fix For GPKG When “fid” Was Not the Same as “rowid”
7.5.3
Exit TUFLOW if an ERROR Occurs Reading GPKG
7.5.4
Bug Fix GPKG Reading 1d_pit
7.5.5
GeoTIFF Now Supports “SPARSE_OK=TRUE” GDAL Creation Option
7.6
2023-03-AD Minor Enhancements and Bug Fixes
7.6.1
Bug Fix - Crash While Reading GeoTIFF Inputs
7.6.2
Raster Cell Shape Check
7.6.3
GeoTIFF Coordinate Reference System Check
7.6.4
GPKG Projection Accepts String Input
7.6.5
Bug Fix - Spatial Database == [path/to/gpkg] When Used in a Read File Within The TCF
7.6.6
Bug Fix - Spatial Database == OFF When Used in a Read File
7.6.7
GPKG Fully Implemented in Package Model Functionality
7.6.8
GPKG Reading - Change in Default Journal Mode
7.6.9
Support for User SQL When GPKG Databases are Opened
7.6.10
GPKG Improved Error Messaging if Polygon/Polyline Vertex Count Exceeds TUFLOW Limit
7.6.11
Bug Fix - GeoTIFF Grids Being Cutoff
7.6.12
Bug Fix - GPKG XF Files Not Updating
7.6.13
Enhances Handling of Line Breaks in Attributes
8
Outputs and Check Files
8.1
Additional Options for Record Gauge Data Outputs
8.2
Time of Max Water Level Switch
8.3
Time of Max Velocity Off by Default
8.4
File Access Timeout
8.4.1
Bug Fix for Final SGS Elevation XF File Access
8.5
Additional Check Grid Formats
8.6
High Resolution Map Output Includes Additional File Formats
8.6.1
Viewing HRNC in TUFLOW Viewer
8.6.2
High Resolution Map Output Includes 1D WLL Elevations
8.7
New Map Output Data Types
8.7.1
HPC Control Numbers
8.7.2
New Hazard Output – Auckland Council Hazard NZ
8.8
Changes to Simulation Computational and Clock Times
8.8.1
Changes to Simulation Log Files for 2023-03-AB
8.9
Support Added for 2d_glo in HPC and Quadtree
8.10
Support For “H_” Po Lines Removed
8.11
Minor Enhancements and Bug Fixes
8.11.1
Checks for Valid Geometries for Plot Outputs
8.11.2
HPC dt.csv Interval Can Now Be Set
8.11.3
Bug Fix for Map Output Zones Using Different Map Output Intervals
8.11.4
SGS Sample Distance Reporting in TLF
8.11.5
Limit Number of WARNING 2550 Messages
8.11.6
2D_WRF Empty File
8.11.7
High Resolution Grid Outputs Not Created with Map Output Zones
8.11.8
Time Output Cutoff
Logging Fix
8.11.9
Mass Error Reporting During Simulation Showing Asterisks
8.11.10
Snapping Settings Added to .qgs File
8.11.11
Duplicate Messages in the messages_P GIS File
8.11.12
Quadtree zsh_zpt_check Points in Non-Refined Areas
8.11.13
Bug Fix for SGS Model Outputs When Cell Averaged Depth Option is Used
8.11.14
Fixes an Issue with Viscosity Output Written as Zero
8.11.15
HPC Control Number Map Output
8.11.16
_zsh_zpt Check File for SGS Models
8.11.17
Extra Checks on File Format Specific Map Output Commands
8.11.18
Changes to Processing of Map Output Data Types Command
8.11.19
Layered Flow Constriction Check File Now Includes Method
8.11.20
HPC Error Codes Are Now Reported in .tlf and Message Layers
8.12
2023-03-AB Minor Enhancements and Bug Fixes
8.12.1
Fix for Quadtree High Resolution Outputs and WLL
8.12.2
Reduced Log File when Processing Quadtree Polygons
8.12.3
Bug Fix for Integer (Hazard) Grid Outputs
8.12.4
Consistent Reporting Location Dry Output
8.12.5
Bug Fix MIF PLOT output
8.12.6
Scientific Notation for PO Outputs
8.12.7
Scientific Notation for ASC Outputs
8.12.8
Bug Fix Geometry Type Groundwater Flow Output in TPC
8.12.9
Bug Fix Groundwater Vector Grid Outputs
8.12.10
Bug Fix Velocity GIS Map Output
8.12.11
Extra Precision in Quadtree uvpt Check File for Form Loss
8.12.12
TMO Output Changes for HPC Model with SGS
8.12.13
Duplicated HR Output Message in Log File
8.12.14
Updated Links to TUFLOW Wiki
8.12.15
Warning 3551 now Check 3551
8.12.16
Check 0008 now ERROR 0008
8.12.17
Check 2099 now Reported to Log and Console
8.12.18
Bug Fix for Warning 4020
8.12.19
Buffered File Write for .2dm
8.13
2023-03-AC Minor Enhancements and Bug Fixes
8.13.1
Fix to TMax Output in Output Zone
8.13.2
Enhancement to Plot Output Memory Allocation
8.13.3
Bug Fix to SGS High-Res Output below Sea Surface Level
8.13.4
Quadtree PO Header Rows Swapped
8.14
2023-03-AD Minor Enhancements and Bug Fixes
8.14.1
Bug Fix for PO Online and GPKG
8.14.2
Bug Fix and Enhancement for NetCDF Grid Projections
8.14.3
Bug Fix for Reporting Location RLL_Qmx.csv and RLR_Volmx.csv Outputs
8.14.4
Removes -99999 From Reporting Location Flow Time Series Output
8.14.5
Error Produced for Duplicate PO Labels for Same Output Type
8.14.6
Plot Output Type ‘Vv’ No Longer Triggers ‘V_’ Output
8.14.7
New Plot Output Types Supported in HPC and Quadtree
8.14.8
Plot Output WARNING 2476 No Longer Triggered Erroneously
8.14.9
Bug Fix For Sink-Source (SS) Plot Output Type in Quadtree
8.14.10
Bug Fix for “GRID” Output Format Not Outputting for GeoTIFFs
8.14.11
Bug Fix for “WRR” Output Crashing With “Should not be here”
8.14.12
Bug Fix for High Resolution Grid Outputs with Energy Type
8.14.13
Loading Results in TUFLOW Viewer While TUFLOW is Running
8.14.14
Spurious Column Removed from PO.csv in Quadtree
8.14.15
Bug Fix for Initial Water Level Polygon Missing From QGIS Workspace
8.14.16
Bug Fix for 2d_bc_tables_check.csv from Quadtree Containing Garbled Text
8.14.17
Re-label SA Boundary Time Column in the 2d_bc_tables_check.csv in Quadtree
8.14.18
ERROR 0710 Now has Wiki Link
8.14.19
Plot Output Sink/Source Type in HPC Now Correctly Reports Net Flow
8.14.20
Bug Fix for Water Level Output with Thin Breakline
8.14.21
Bug Fix for Maximum High Resolution Output
8.14.22
Bug Fix for Reporting Location with Restart File
8.14.23
Bug Fix PO Points With Invalid “Q” Output Crash
8.14.24
Bug Fix NetCDF Raster Time Issues
8.14.25
Bug Fix Grid Ouputs For Map Output Zones
8.14.26
Bug Fix for Mass Balance Output Interval
8.14.27
Bug Fix for Bed Shear Stress Temporal Output
8.14.28
Second Option now Included in NetCDF Output Time Unit Command
8.14.29
Enhancement to Ignore Time Series Output Interval if not Used
8.14.30
Bug Fix for Quadtree Maximum Output
8.14.31
Bug Fix For Misaligned Columns in the TUFLOW Simulation Log
8.14.32
Bug Fix For TMO Outputs in Quadtree
8.14.33
Bug Fix For Maximum Energy Output in HPC
9
Minor Enhancements and Bug Fixes
9.1
2023-03-AA Minor Enhancements and Bug Fixes
9.1.1
Geo-Referenced Messages
9.1.2
Error Message When No Start or End Time is Specified
9.1.3
Warning When 1D_IWL is Used in TCF or TGC
9.1.4
Fixes Issue with Return Characters in GIS Attributes
9.1.5
Package Model Functionality Copies Matrix Blockage Files
9.1.6
TCF now Closed at End of Model Initialisation
9.2
2023-03-AB Minor Enhancements and Bug Fixes
9.2.1
Ability to Set Hardware via Command Line Argument
9.2.2
Bug Fix for External 1D Engines
9.2.3
File Path Length Errors
9.2.4
Enhancement to Processing of Tabs
9.3
2023-03-AD Minor Enhancements and Bug Fixes
9.3.1
TUFLOW HPC Crashing While Writing Outputs Mid-Simulation with Reporting Locations
9.3.2
Bug Fix Using Local Coordinate Reference System with Shape Files
9.3.3
Bug Fix Writing ERROR 2551
9.3.4
Speed Up of Package Model Routine
10
Licencing and Installing
10.1
Support for Flood Modeller Cloud Licences
11
Backward Compatibility
11.1
Backward Compatibility to the 2020-10 Release
Appendix
A
SWMM Input Files Descriptions
References
TUFLOW Classic/HPC New Release Notes
TUFLOW Classic/HPC New Release Notes
Release Build 2023-03-AD
Updated on 18 Sep 2024
