TUFLOW Example Models
Revision as of 14:15, 30 December 2022 by Pavlina Monhartova (talk | contribs) (→Example Model Catalogue)
Introduction
These example models have been developed to demonstrate the most common TUFLOW model design features and applications. This dataset is useful for experienced modellers wishing to further develop their skills via demonstration examples. Although the models are based on the TUFLOW tutorial model dataset, new users are encouraged to familiarise themselves with TUFLOW through the Tutorial Model Introduction before using this dataset. Unlike the tutorials, this dataset does not include step-by-step instructions / documentation. Users of this dataset are expected to have a basic knowledge TUFLOW, and have suitable skills to open the model files by referencing the TUFLOW Control File (TCF) referenced in the feature catalogue list below.
Example Model Data
The model data is available for download from https://downloads.tuflow.com/TUFLOW/Wiki_Example_Models/Example_Model_Dataset_2020-10-AC.zip
The dataset only includes model input files. The models can be run to create simulation check and result files. Batch files (*.bat) for each of the example feature categories has been provided within the "runs" folder of the TUFLOW project.
If you are unfamiliar with using batch files, additional information explaining how to use them to execute multiple simulations is available here: Run TUFLOW From a Batch-file.
Example Model Catalogue
Below is a complete list of the example models. This dataset uses TUFLOW HPC as the computational engine. If you are searching for TUFLOW Classic example models, please refer to the TUFLOW Classic Example Model Archive.
Click on the following shortcuts to skip directly to the targeted major feature category in the table below:
- Project Initiation
- Model Units
- Solver Options
- Output Options
- Boundary Condition Options (Inflows, Outflows, Losses)
- Topography Features (Static Updates, Dynamic Updates, Sub-Grid Sampling)
- Structures (Bridges, Weirs, Culverts, Operational Controls)
- Multiple Domain Model Design (2D/2D, 1D open channel / 2D floodplain, 1D pipe network / 2D floodplain)
- Bulk Simulation Management
- Advection Dispersion
| Example Model Catalogue | |||
|---|---|---|---|
| Model Category | Description | Model Name | |
| Project Initiation | Write empty files | Create_Empties.tcf | |
| Model Units | Basic 2D model (SI units - m) | EG00_001.tcf | |
| Basic 2D model (US units - ft) | EG00_002.tcf | ||
| Solver Options | TUFLOW Classic | Refer to TUFLOW Classic Example Model Archive | |
| TUFLOW HPC - Sub-Grid Sampled (SGS) topography enabled | EG01_002.tcf | ||
| TUFLOW HPC - Sub-Grid Sampled (SGS) topography disabled | EG01_003.tcf | ||
| TUFLOW HPC - Multiple GPU cards | EG01_004.tcf | ||
| TUFLOW HPC - Non-Newtonian flow | EG01_005.tcf | ||
| TUFLOW HPC - Quadtree | See Section EG13 | ||
| ESTRY | See Section EG11, EG12, EG15 | ||
| Output Options | 2D xmdf (binary time series) and grid (maximums) output | EG02_001.tcf | |
| Time and duration of inundation (Time Output Cut-off = Depth) | EG02_002.tcf | ||
| Time and duration of inundation (Time Output Cut-off = VxD) | EG02_003.tcf | ||
| Time and duration of inundation (Time Output Cut-off = Hazard) | EG02_004.tcf | ||
| Gauge level map output interval control (2d_glo) | TUFLOW Classic Only. Future TUFLOW HPC release | ||
| 2D SGS high resolution grid output | EG02_006.tcf | ||
| 2D SGS high resolution grid output with manual specification of output resolution | EG02_007.tcf | ||
| Output Zone (2d_oz) | EG02_008.tcf | ||
| Write Restart File(See EG06_004.tcf for Read Restart File) | EG02_009.tcf | ||
| 2D plot output (2d_po point, line and region) | EG02_010.tcf | ||
| 2D structure outputs | EG02_011.tcf | ||
| 2D long Profile | TUFLOW Classic Only. Future TUFLOW HPC release | ||
| 1D/2D reporting locations | EG02_013.tcf | ||
| Translating gauge data information to catchment receptors | TUFLOW Classic Only. Future TUFLOW HPC release | ||
| Evacuation route inundation reporting (2d_zshr) (Route Cut Off Type = Depth) | EG02_015.tcf | ||
| Evacuation route inundation reporting (2d_zshr) (Route Cut Off Type = Velocity) | EG02_016.tcf | ||
| Evacuation route inundation reporting (2d_zshr) (Route Cut Off Type = VxD) | EG02_017.tcf | ||
| Evacuation route inundation reporting (2d_zshr) (Route Cut Off Type = Hazard) | EG02_018.tcf | ||
| Boundary Condition Options | Inflows | 2D flow (m^3/s) vs time upstream inflow (2d_bc, QT) | EG03_001.tcf |
| 2D head (m) vs time upstream inflow (2d_bc, HT) | EG03_002.tcf | ||
| Internal catchment inflow (m^3/s)(2d_sa) | EG03_003.tcf | ||
| Internal catchment inflow (m^3/s) with streamlines (2d_sa) | EG03_004.tcf | ||
| Internal catchment rainfall (mm) (2D_sa_rf) | EG03_005.tcf | ||
| Direct rainfall (mm) (2D Global Rainfall) | EG03_006.tcf | ||
| Direct rainfall (mm) (2D_rf) | EG03_007.tcf | ||
| Direct rainfall (mm) (Rainfall Control File - IDW) | EG03_008.tcf | ||
| Direct rainfall (mm) (Rainfall Control File - TIN) | EG03_009.tcf | ||
| Direct rainfall (mm) (Rainfall Control File - Poly) | EG03_010.tcf | ||
| Direct rainfall (mm) (time varying gridded rainfall) - netcdf format | EG03_011.tcf | ||
| Direct rainfall (mm) (time varying gridded rainfall) - flt format | EG03_012.tcf | ||
| 1D flow (m^3/s) vs time upstream inflow (1d_bc, QT) | EG14_001.tcf | ||
| 1D flow (m^3/s) vs time internal inflow (1d_bc, QT) | EG14_002.tcf | ||
| Outflows | 2D Stage discharge downstream boundary (2d_bc, HQ) | EG04_001.tcf | |
| 2D Stage time downstream boundary (2d_bc, HT) | EG04_002.tcf | ||
| 1D Stage discharge downstream boundary (1d_bc, HQ) | EG04_003.tcf | ||
| 1D Stage time downstream boundary (1d_bc, HT) | EG04_004.tcf | ||
| Loss Options | Rainfall excess loss approach - IL/CL (Global loss applied via the TBC file) | EG05_001.tcf | |
| Rainfall excess loss approach - IL/CL (applied via the materials file) | EG05_002.tcf | ||
| Infiltration loss approach - IL/CL | EG05_003.tcf | ||
| Infiltration loss approach - IL/CL, porosity | EG05_004.tcf | ||
| Infiltration loss approach - IL/CL, porosity, initial moisture | EG05_005.tcf | ||
| Infiltration loss approach - Green Ampt (USDA soil type) | EG05_006.tcf | ||
| Infiltration loss approach - Green Ampt (USDA soil type), initial moisture | EG05_007.tcf | ||
| Infiltration loss approach - Green Ampt (USDA soil type), initial moisture, ponding | EG05_008.tcf | ||
| Infiltration loss approach - Green Ampt (User specified soil properties) | EG05_009.tcf | ||
| Infiltration loss approach - Green Ampt (User specified soil properties), initial moisture | EG05_010.tcf | ||
| Infiltration loss approach - Green Ampt (User specified soil properties), initial moisture, ponding | EG05_011.tcf | ||
| Infiltration loss approach - Horton | EG05_012.tcf | ||
| Infiltration loss approach - Horton, porosity | EG05_013.tcf | ||
| Infiltration loss approach - Horton, porosity, initial moisture | EG05_014.tcf | ||
| Other | Spatially varied initial water level commands (2d_iwl) | EG06_001.tcf | |
| Spatially varied initial water level commands (Grid 2d_iwl) | EG06_002.tcf | ||
| 2D pump (2d_bc, SH) | EG06_003.tcf | ||
| Read Restart File (See EG02_009.tcf for Write Restart File) | EG06_004.tcf | ||
| Groundwater | Future release | ||
| Dynamic Topography Options (Dam / Levee Failure) | See Section EG08 | ||
| Topography Features | Static Topography Updates | Cell resolution change | EG07_001.tcf |
| Thin breakline topography update (2d_zsh_L, 2d_zsh_P) | EG07_002.tcf | ||
| Thick breakline topography update (2d_zsh_L, 2d_zsh_P) | EG07_003.tcf | ||
| Gully (Min) breakline topography update (2d_zsh_L, 2d_zsh_P) | EG07_004.tcf | ||
| Ridge (Max) breakline topography update (2d_zsh_L, 2d_zsh_P) | EG07_005.tcf | ||
| Region update - Absolute value change, No merge (2d_zsh_R) | EG07_006.tcf | ||
| Region update - Relative value change, No merge (2d_zsh_R) | EG07_007.tcf | ||
| Region update - Absolute value change, Partial merge (2d_zsh_R, 2d_zsh_P) | EG07_008.tcf | ||
| Region update - Feature removal (2d_zsh_R) | EG07_009.tcf | ||
| Advanced topography update - TIN (2d_zsh_R, 2d_zsh_P) | EG07_010.tcf | ||
| Advanced topography update - TIN (2d_zsh_R, 2d_zsh_L, 2d_zsh_P) | EG07_011.tcf | ||
| Depth varying Manning's n | EG07_012.tcf | ||
| Dynamic Topography Options (Dam / Levee Failure) | 2D embankment failure - Time trigger, linear evolution | EG08_001.tcf | |
| 2D embankment failure - Time trigger, non-linear evolution | EG08_002.tcf | ||
| 2D embankment failure - Water level trigger, linear evolution | EG08_003.tcf | ||
| 2D embankment failure - Water level trigger, non-linear evolution | EG08_004.tcf | ||
| 2D embankment failure - Water level difference trigger, linear evolution | EG08_005.tcf | ||
| 2D embankment failure - Water level difference trigger, non-linear evolution | EG08_006.tcf | ||
| 2D flood barrier reinstatement - Time trigger | EG08_007.tcf | ||
| 2D flood barrier reinstatement - Water level trigger | EG08_008.tcf | ||
| 2D flood barrier reinstatement - Water level difference trigger | EG08_009.tcf | ||
| 1D piping failure transitioning to 1D dam failure - Time trigger | EG08_010.tcf | ||
| 1D dam failure - Time trigger | EG08_011.tcf | ||
| 1D piping failure transitioning to 1D dam failure - Water level trigger | EG08_012.tcf | ||
| 1D dam failure - Water level trigger | EG08_013.tcf | ||
| Sub Grid Sampling | Breakline detection tool | EG09_001.tcf | |
| 2D SGS high resolution grid output | EG09_002.tcf | ||
| 2D SGS high resolution grid output with manual specification of output resolution | EG09_003.tcf | ||
| Structures | 2D Bridges and Weirs | Bridge (2d_fc) | Refer to TUFLOW Classic Example Model Archive |
| Bridge (2d_fcsh) | Refer to TUFLOW Classic Example Model Archive | ||
| Bridge - horizontal deck (2d_lfcsh) | EG10_003.tcf | ||
| Bridge - variable deck form geometry (2d_lfcsh) | EG10_004.tcf | ||
| Bridge - horizontal deck (2d_bg) (use 2022 beta release) | EG10_005.tcf | ||
| 2D weir coefficient change (global specification) | EG10_006.tcf | ||
| 2D weir coefficient change (location specific update) | EG10_007.tcf | ||
| 1D Culverts, Bridges, Weirs | 1D culverts - Circular and Box type. SX point, line and region 1D/2D examples | EG11_001.tcf | |
| 1D culverts - Irregular shape (e.g. Arch) | EG11_002.tcf | ||
| 1D culverts - Unidirectional structures (flapgate) (1d_nwk) | EG11_003.tcf | ||
| 1D culverts - ARR2016 blockage matrix (1d_nwk) | EG11_~e1~_~e2~_004.tcf | ||
| 1D M channel - User defined flow matrix (1d_nwk) | EG11_005.tcf | ||
| 1D Q channel - Upstream Depth-Discharge Relationship (1d_nwk) | EG11_006.tcf | ||
| Bridge (1d_nwk) | EG11_007.tcf | ||
| Weir (1d_nwk) | EG11_008.tcf | ||
| 1D Operating Structures | Pump (1d_nwk) - time trigger | EG12_001.tcf | |
| Pump - 1D water level trigger (1d_nwk) | EG12_002.tcf | ||
| Pump - 2D water level trigger (1d_nwk) | EG12_003.tcf | ||
| Pump - Depth above structure invert trigger (1d_nwk) | EG12_004.tcf | ||
| Q flow matrix - Operation based on water level trigger (1d_nwk) | EG12_005.tcf | ||
| Q flow matrix - Operation based on water level trigger and time delay (1d_nwk) | EG12_006.tcf | ||
| Sluice gate - Time trigger (simulation time) (1d_nwk) | EG12_007.tcf | ||
| Sluice gate - Water level trigger(1d_nwk) | EG12_008.tcf | ||
| Gated spillway - Time trigger (Day) (1d_nwk) | EG12_009.tcf | ||
| Gated spillway - Water level trigger (1d_nwk) | EG12_010.tcf | ||
| Coordinated operation (multiple interating structures) - Pump and Gated Spillway | EG12_011.tcf | ||
| Multiple Domain Model Design | 2D/2D Modelling | TUFLOW HPC - Quadtree | EG13_001.tcf |
| TUFLOW HPC - Quadtree sample frequency | EG13_002.tcf | ||
| TUFLOW HPC - Quadtree: Memory efficient pre-processing | EG13_003.tcf | ||
| TUFLOW Classic - M2D | Refer to TUFLOW Classic Example Model Archive | ||
| 1D Open Channel / 2D Floodplain Modelling | 1D river (1d_nwk), 2D floodplain | EG14_001.tcf | |
| 1D Pipe Network / 2D Floodplain Modelling | 1D pipe network (1d_nwk), 2D floodplain, 2d sa inflow to 1D pits | EG15_001.tcf | |
| 1D pipe network (1d_nwk), 2D floodplain, 2d rf direct rainfall | EG15_002.tcf | ||
| 1D pipe network (1d_nwk), 2D / 2D floodplain quadtree | EG15_003.tcf | ||
| 1D pipe network (1d_nwk), manually specified manholes (1d_mh), 2D floodplain | EG15_004.tcf | ||
| 1D pipe network (1d_nwk), non-default (fixed) manhole loss method, 2D floodplain | EG15_005.tcf | ||
| 1D pipe network (1d_nwk), localised manually specified manhole losses, 2D floodplain | EG15_006.tcf | ||
| 1D virtual pipes, 2D floodplain | EG15_007.tcf | ||
| 1D virtual pipes connected to 1D pipe network (trunk drainage line), 2D floodplain | EG15_008.tcf | ||
| Bulk Simulation Management | Scenario / Event Management | Scenario (single) | EG16_~s1~_001.tcf |
| Scenario (multiple) | EG16_~s1~_~s2~_002.tcf | ||
| Set Variable | EG16_~s1~_~s2~_003.tcf | ||
| Event (single) | EG16_~e1~_004.tcf | ||
| Event (multiple) | EG16_~e1~_~e2~_005.tcf | ||
| Scenario (multiple), Event (multiple), Set Variable | EG16_~s1~_~s2~_~e1~_~e2~_006.tcf | ||
| Other | Advection Dispersion | Advection Dispersion | EG17_001.tcf |
Archive Dataset
Historic example model datasets can be accessed via the following link: TUFLOW Classic Example Model Archive.
| Up |
|---|
 Back to Wiki Main Page
|