TUFLOW FV Example Models
| USEFUL LINKS | ||
| Wiki Links | Help | Downloads |
| TUFLOW FV Wiki Main Page | Products Support/Contact | TUFLOW FV Downloads |
| TUFLOW FV Tutorials | Requesting a Licence | Tutorial Module Data |
| TUFLOW Classic/HPC Wiki | TUFLOW FV Glossary | Manuals |
Introduction
The example models have been developed to demonstrate the most common TUFLOW FV model design features and applications. This dataset is useful for experienced modellers wishing to further develop their skills via demonstration examples. New users are encouraged to familiarise themselves with TUFLOW FV through the Tutorial 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 of TUFLOW FV, and have suitable skills to open the model files by referencing the TUFLOW FV Control File (FVC) referenced in the feature catalogue list below.
Example Model Data
The model data is available for download from https://downloads.tuflow.com/TUFLOWFV/Example_Models/TUFLOWFV_Example_Model_Dataset.zip
The dataset only includes model input files. The models can be run to create simulation check and result files. A batch file (*.bat) for each of the example feature categories has been provided within the "runs" folder of each TUFLOW FV project.
If you are unfamiliar with using batch files, additional information explaining how to use them to execute multiple simulations is available here: Running TUFLOW FV from a Batch File.
Example Model Catalogue
Below is a complete list of the example models.
Please note:
- The example flood model has the majority of TUFLOW FV 2D hydrodynamic features demonstrated. Features in the example flood model can be transferred to any TUFLOW FV model domain whether it be flooding, estuarine or coastal hydrodynamics.
- The coastal model examples include additional 2D hydrodynamic model features applicable to the coastal domain.
- The estuarine model contains 3D model setup examples.
Example Flood Model
This suite of examples is based on a small rural catchment. We start with the Base 2D Flood Model and progressively add alternative features that you can review. The Base 2D Flood Model contains the following key features and commands:
- GIS integration
- Hardware selection
- Model parameters
- Time period and time stepping
- Turbulence models
- Topography - Mesh, DEM, GIS Z Lines
- Material assignment
- Boundary locations (Nodestring and point Inflows)
- Hydraulic structure (Culverts and weirs)
- Output options
Click on the following shortcuts to skip directly to the targeted major feature category in the table below:
- Flood Model - Base 2D
- Flood Model - Simulation Configuration
- Flood Model - Turbulence
- Flood Model - Material Specified Options
- Flood Model - Boundary Conditions
- Flood Model - Restart File
- Flood Model - Outputs
- Flood Model - Hydraulic Structures
- Flood Model - Simulation Management
| Example Model Catalogue - Flood Models | ||
|---|---|---|
| Model Category | Description | Model Name |
| Base 2D | Base 2D Flood Model | FLD000_2D_001.fvc |
| Simulation Configuration | Second Order Spatial Scheme | FLD001_2D_001.fvc |
| Imperial Units | FLD001_2D_002.fvc | |
| Time Format ISODATE | FLD001_2D_003.fvc | |
| GPU Base 2D Flood Model | FLD001_2D_004.fvc | |
| CFL Criterion | FLD001_2D_005.fvc | |
| Turbulence | Horizontal Momentum Mixing Model Constant | FLD002_2D_001.fvc |
| Horizontal Momentum Mixing Model Wu | FLD002_2D_002.fvc | |
| Material Specified Options | Material Specifications - Eddy Viscosity | FLD003_2D_001.fvc |
| Material Specifications - Bed Elevation Limits | FLD003_2D_002.fvc | |
| Material Specifications - Spatial Reconstruction With Second Order | FLD003_2D_003.fvc | |
| Boundary Conditions | HQ | FLD004_2D_001.fvc |
| QC | FLD004_2D_002.fvc | |
| QG | FLD004_2D_003.fvc | |
| HQ and QN | FLD004_2D_004.fvc | |
| QN | FLD004_2D_005.fvc | |
| ZG | FLD004_2D_006.fvc | |
| BC SCALE | FLD004_2D_007.fvc | |
| BC OFFSET | FLD004_2D_008.fvc | |
| BC DEFAULT | FLD004_2D_009.fvc | |
| QC_POLY | FLD004_2D_010.fvc | |
| BC Reference Time - Positive Temporal Shift (Boundary Signal Arrives Later) | FLD004_2D_011.fvc | |
| BC Reference Time - Negative Temporal Shift (Boundary Signal Arrives Earlier) | FLD004_2D_012.fvc | |
| BC Reference Time - Positive Temporal Shift (Boundary Signal Arrives Later) (ISODATE) | FLD004_2D_013.fvc | |
| BC Reference Time - Negative Temporal Shift (Boundary Signal Arrives Earlier) (ISODATE) | FLD004_2D_014.fvc | |
| Restart File | Write Restart File | FLD005_2D_001.fvc |
| Read Restart File | FLD005_2D_002.fvc | |
| Read Restart File Ignore Restart Time Stamp | FLD005_2D_003.fvc | |
| Write Separate Restart File at the Write Restart dt (Don't Overwrite) | FLD005_2D_004.fvc | |
| Read Restart File at Specific Time From Previous Simulation | FLD005_2D_005.fvc | |
| Outputs | DATV | FLD006_2D_001.fvc |
| NetCDF | FLD006_2D_002.fvc | |
| NetCDF With Stats | FLD006_2D_003.fvc | |
| NetCDF With Stats and Output Compression | FLD006_2D_004.fvc | |
| Two NetCDF With Suffix | FLD006_2D_005.fvc | |
| Hydraulic Structures | Linked Nodestrings - Culvert | FLD007_2D_001.fvc |
| Single Nodestring Bridge (Energy Loss Coefficient and Blockage File) | FLD007_2D_002.fvc | |
| Single Nodestring Bridge (Energy Loss Coefficient and Width File) | FLD007_2D_003.fvc | |
| Linked Zones - Culvert | FLD007_2D_004.fvc | |
| Single Nodestring Bridge (Energy Loss File) | FLD007_2D_005.fvc | |
| Simulation Management | Single Scenario | FLD008_2D_~s1~_001.fvc |
| Multiple Scenarios | FLD008_2D_~s1~_~s2~_002.fvc | |
| Set Variables | FLD008_2D_~s1~_~s2~_003.fvc | |
| Single Event | FLD008_2D_~e1~_004.fvc | |
| Multiple Events | FLD008_2D_~e1~_~e2~_005.fvc | |
| Multiple Scenarios, Multiple Events | FLD008_2D_~s1~_~s2~_~e1~_~e2~_006.fvc | |
| Environment Variable Passing From Batch File | FLD008_2D_~s1~_007.fvc | |
Example Coastal Model
This suite of coastal examples is situated in the Gulf of Carpentaria, Australia. We start with the Base 2D Coastal Model and progressively add alternative features. The Base 2D Coastal Model contains the following key features and commands:
- Model parameters
- Time period and time stepping
- Turbulence models
- Topography - Mesh
- Output options
Click on the following shortcuts to skip directly to the targeted major feature category in the table below:
- Coastal Model - Base 2D
- Coastal Model - Simulation Configuration
- Coastal Model - 2D Geometry
- Coastal Model - Meteorological Inputs
- Coastal Model - Boundary Conditions
- Coastal Model - Materials
- Coastal Model - 2D Advection Dispersion
- Coastal Model - Restart File
| Example Model Catalogue - Coastal Models | ||
|---|---|---|
| Model Category | Description | Model Name |
| Base 2D | Base 2D Coastal Model | CST000_2D_001.fvc |
| Simulation Configuration | GPU Base 2D Coastal Model | CST001_2D_001.fvc |
| 2D Geometry | Read GRID Zpts | CST002_2D_001.fvc |
| Cell Elevation File - Coordinate | CST002_2D_002.fvc | |
| READ GIS Z Line - Line Only | CST002_2D_003.fvc | |
| READ GIS Z Line - Line With Points Snapped | CST002_2D_004.fvc | |
| READ GIS Z Line - Polygon | CST002_2D_005.fvc | |
| Meteorological Inputs | ERA5 Get Atmos Input - Wind and Pressure Only | CST003_2D_001.fvc |
| Boundary Conditions | QC | CST004_2D_001.fvc |
| QC_POLY | CST004_2D_002.fvc | |
| QG | CST004_2D_003.fvc | |
| ZG | CST004_2D_004.fvc | |
| BC Default | CST004_2D_005.fvc | |
| BC Offset | CST004_2D_006.fvc | |
| BC Scale | CST004_2D_007.fvc | |
| Write Transport File | CST004_2D_008.fvc | |
| Read Transport File | CST004_2D_009.fvc | |
| Wind - Wu Model With Single Holland Parametric Cyclone Model | CST004_2D_010.fvc | |
| Materials | Material Specifications - Bottom Drag Model ks | CST005_2D_001.fvc |
| Material Specifications - Include File | CST005_2D_002.fvc | |
| Material Specifications - Bed Elevation Limits | CST005_2D_003.fvc | |
| Material Specifications - Eddy Viscosity | CST005_2D_004.fvc | |
| Material Specifications - Bottom Drag Model Manning | CST005_2D_005.fvc | |
| 2D Advection Dispersion | Salinity | CST006_2D_001.fvc |
| Salinity With Density Coupling | CST006_2D_002.fvc | |
| Temperature | CST006_2D_003.fvc | |
| Temperature With Heat Module (Including Heat Meteorological Inputs) | CST006_2D_004.fvc | |
| Temperature With Heat Module and Density Coupling (Including Heat Meteorological Inputs) | CST006_2D_005.fvc | |
| Salinity and Temperature With Heat Module and Density Coupling (Including Heat Meteorological Inputs) | CST006_2D_006.fvc | |
| 1 Tracer - Point Inflow | CST006_2D_007.fvc | |
| 2 Tracers - Point Inflows | CST006_2D_008.fvc | |
| 1 Tracer With Decay | CST006_2D_009.fvc | |
| 1 Tracer With Settling | CST006_2D_010.fvc | |
| 1 Tracer - Flushing Analysis | CST006_2D_011.fvc | |
| 1 Tracer - Constant Scalar Mixing Model | CST006_2D_0012.fvc | |
| 1 Tracer - Smagorinsky Scalar Mixing Model | CST006_2D_013.fvc | |
| Restart File | Write Restart File | CST007_2D_001.fvc |
| Read Restart File | CST007_2D_002.fvc | |
| Read Restart File Ignore Restart File Time | CST007_2D_003.fvc | |
| Write Separate Restart File for Each Hour (Don't Overwrite) | CST007_2D_004.fvc | |
| Read Restart File at Specific Time From Previous Sim. | CST007_2D_005.fvc | |
Example Estuary Model
This suite of estuary examples is based on Tutorial Module 05. The 3D Estuary Model example suite primarily focuses on 3D boundary condition types, however the Base 3D model includes a range of features including:
- Hybrid z-sigma 3D geometry
- Temperature and salinity density coupled hydrodynamics
- Gridded meteorological boundary conditions from TUFLOW FV's GetAtmos tools
- 3D model outputs
Please note you will require the external turbulence libraries to run the 3D estuary model, for further instructions on setup please contact support@tuflow.com.
Click on the following shortcuts to skip directly to the targeted major feature category in the table below:
- Estuary Model - Base 3D
- Estuary Model - Simulation Configuration
- Estuary Model - Boundary Conditions
- Estuary Model - Simulation Management
| Example Model Catalogue - Estuary Models | ||
|---|---|---|
| Model Category | Description | Model Name |
| Base 3D | Base 3D Estuary Model | EST000_3D_001.fvc |
| Simulation Configuration | GPU Base 3D Estuary Model | EST001_3D_001.fvc |
| Boundary Conditions | QC (Vertical Distribution Types) | EST002_3D_001.fvc |
| QC (Extraction Types) | EST002_3D_002.fvc | |
| QC_POLY | EST002_3D_003.fvc | |
| QCM | EST002_3D_004.fvc | |
| FC | EST002_3D_005.fvc | |
| FC_POLY | EST002_3D_006.fvc | |
| FCM | EST002_3D_007.fvc | |
| FORCE | EST002_3D_008.fvc | |
| FORCE_POLY | EST002_3D_009.fvc | |
| FORCEM | EST002_3D_010.fvc | |
| CP | EST002_3D_011.fvc | |
| Read CP Model Restart File | EST002_3D_012.fvc | |
| Meteorological Inputs (.csv) | EST002_3D_013.fvc | |
| Simulation Management | Single Scenario | EST003_~s1~_001.fvc |
| Multiple Scenarios | EST003_~s1~_~s2~_002.fvc | |
| Multiple Scenarios, Single Event | EST003_~s1~_~s2~_~e1~_003.fvc | |
| External Turbulence | GOTM Vertical Mixing Model | EST004_3D_001.fvc |
Conclusion
We hope the example model dataset has been useful in helping you test and build your models. To complete more tutorials or learn more tips and tricks please return to the TUFLOW FV Wiki Mainpage.