A.2 FVC Commands
Atmospheric Stability Model == {0} | 1
Status: Conditional
Model Construction: Section 7.8
Required Dependent Command(s): Wind Stress Model
Related Command(s): Wind Stress Model, Include Heat, Bulk Latent Heat Coefficient, Bulk Sensible Heat Coefficient
Enables or disables the consideration of atmospheric stability when using the Kondo implementation of Wind Stress Model, Bulk Latent Heat Coefficient and Bulk Sensible Heat Coefficient.
Ignored when other wind stress model implementations are selected.
Atmospheric Update dt == <atmos_dt>
Status: Optional
Model Construction: Section 7.7
Related Command(s): Include Heat, Include Temperature
Sets the update timestep for atmospheric heat exchange calculations.
atmos_dt
Default: 900.
Units: seconds (s)
Auto Terminate == {0} | 1, <x_coord>, <y_coord>, <water_level>
Status: Optional
Model Construction: Section 11.4
Automatically stops a simulation when a specific water level condition is met.
x_coord
y_coord
water_level
Autoweir == {0} | 1
Status: Optional
Selects the autoweir formulation for automatically generated weir behaviour.
The globally assigned Autoweir feature instructs TUFLOW FV to identify all cell faces in the model domain that are elevated above the adjacent cell’s centroid elevations. These cell faces are then assigned a weir flow condition. Autoweirs are assigned TUFLOW FV’s default weir properties and this cannot be altered. The autoweir formulation should only be used where high resolution topographic data is available and the model grid is sufficiently refined to capture the topographic features of interest. It is not recommended to use the autoweir formulation with coarse grids or low resolution topographic data.
Bathy Database == <bathy_database_file_path>
Status: Conditional - Required if Bed Adjust == bathy_database
Model Construction: Section 5.17.10.3
Required Dependent Command(s): Structure, Bed Adjust, Control
Defines the CSV filepath to a DEM lookup table used to interpolate bathymetry values.
Supported for zone structure connection types only. Example syntax and csv file formats are provided via the model construction link below.
BC == <bc_definition>
Status: Required
Model Construction: Section 5.16, Section 7.11, Section 8.8, Section 9.5
Required Dependent Command(s): End BC
Begins a boundary condition block and links a boundary type with its location and input data.
Typically at least one boundary condition will be required for a TUFLOW FV simulation and often a number of different boundary condition types will be applied. Each boundary condition type is defined using a boundary condition (BC) block. The BC and End BC commands indicate the beginning and end of a boundary condition block.
Different boundary_type options require different numbers and types of arguments. These are outlined in the boundary condition sections of the simulation class construction chapters. Generally:
- BC == boundary_type for the simplest BC types that require no location or input data specification (ZG, RS, RNS etc.)
- BC == boundary_type, data_filepath for BC types that require input data but not location specification. Globally assigned boundary conditions are an example (PRECIP, QC etc.)
- BC == boundary_type, location_id for BC types that require location specification but not input data. An automatic downstream water level boundary (QN) is an example
- BC == boundary_type, location_id, data_filepath for BC types that require both location specification and input data (most boundary conditions)
Refer to the BC Block sections of each model construction chapter for boundary type specific argument requirements and refer to the boundary condition model implementation sections for example syntax and further explanation of different boundary condition types.
BC Default == <bc_default_1, bc_default_2, …, bc_default_n>
Status: Optional
Model Construction: Section 5.16.2.4, Section 7.11.2.4
Required Dependent Command(s): BC
Related Command(s): BC Scale, BC Offset, BC Header
Sets fallback value(s) when a BC Header cannot be located in the input file, or if missing data is within an input file. Arguments are a comma delimited list of values that correspond to the expected number of variables for the simulation.
Can be used to apply a constant boundary value.
BC Default Update dt == <bc_default_update_dt>
Status: Optional
Model Construction: Section 5.16.2.4.4
Related Command(s): BC Update dt
Sets the global update timestep for boundary conditions. This is the frequency at which boundary data are refreshed or interpolated during the simulation.
The default of 0.0 s means that boundary default values are updated at every simulation timestep. This can be overridden on a per boundary condition basis using the BC Update dt command. This command sits globally outside of BC blocks and applies to all boundary conditions that use the BC Default values. For long simulations with slowly varying boundary conditions, setting this to a value greater than 0.0 can reduce model run times by reducing the frequency of boundary data updates.
bc_default_update_dt
Default: 0.0
Units: seconds (s)
BC Event Source == <bc_event_text>, <bc_event_name>
Status: Conditional - Required if using model events functionality
Model Construction: Section 11.3.3
Required Dependent Command(s): Define Event
Related Command(s): Event File, Model Events, If Event, Else If Event
Assigns dynamic text replacement for user defined text in .fvc files and is used in conjunction with event simulation management commands.
Allows alternative boundary conditions, include files or model parameters to be modified using a single .fvc file. Will dynamically replace ~bc_event_text~ with the value of bc_event_name in the .fvc file.
Can be used with any simulation class but it is not supported within the sediment, water quality or particle tracking control files.
BC Header == <bc_header_1, bc_header_2, …, bc_header_n>
Status: Required
Model Construction: Section 5.16.2.4, Section 7.11.2.4
Required Dependent Command(s): BC
Related Command(s): BC Scale, BC Offset, BC Default
Maps input file columns or variables to the boundary variables required by the selected boundary type.
The number of headers depends on the selected BC type. The expected default header names depend on the simulated quantities for that boundary.
The command should immediately follow BC.
It applies to CSV column names or NetCDF variable names.
BC Nodestrings == <ns_id_1, ns_id_2, …, ns_id_n>
Status: Conditional - Required when using the OBC_GRID boundary type
Model Construction: Section 7.11.2.3, Section 7.11.7.1
Required Dependent Command(s): BC
Defines the nodestring IDs to interpolate boundary conditions onto for the OBC_GRID boundary type. This allows different boundary conditions to be applied to different nodestrings along the same boundary.
BC Offset == <bc_offset_1, bc_offset_2, …, bc_offset_n>
Status: Optional
Model Construction: Section 5.16.2.4, Section 7.11.2.4
Required Dependent Command(s): BC
Related Command(s): BC Header, BC Scale, BC Default
Applies additive offsets to boundary data values after any scaling is applied.
Applied after any scaling is applied to the boundary data values. Can be used to apply a constant offset to boundary values, for example to adjust a tidal boundary condition up or down by a constant value.
The default offset is 0.0.
BC Reference Time == <bc_reference_time>
Status: Optional
Model Construction: Section 5.16.2.4.4
Required Dependent Command(s): BC
Related Command(s): Time Format, Reference Time
Sets the reference date and time used with relative boundary time units such as hours or days.
Defaults to 0.0 if Time Format == HOURS or DD/MM/YYYY HH:MM:SS if Time Format == ISODATE.
If not specified, the BC Reference Time is assumed to be consistent with the Reference Time.
Applicable to CSV and NetCDF input files.
BC Scale == <bc_scale_1, bc_scale_2, …, bc_scale_n>
Status: Optional
Model Construction: Section 5.16.2.4.2
Required Dependent Command(s): BC
Related Command(s): BC Header, BC Offset, BC Default
Applies multiplicative scale factors to boundary data values read from the input file.
Applied to boundary data values after they are read from the input file and before any offsets are applied. Can be used to apply a constant scale factor to boundary values, for example to adjust an inflow boundary by 10% by applying a scale factor of 1.1.
The default scale factor is 1.0.
BC Time Units == {HOURS} | {ISODATE} | DAYS | MINUTES | SECONDS
Status: Optional
Model Construction: Section 5.16.2.4.4
Required Dependent Command(s): BC
Related Command(s): BC Reference Time, Reference Time
Boundary condition block command that specifies the time units used by the boundary input data when time is not provided as full dates.
Defaults to {HOURS} if Time Format == HOURS or {ISODATE} if Time Format == ISODATE.
The time values entered into the boundary condition time field will be in BC Time Units relative to the BC Reference Time.
BC Update dt == <bc_update_dt>
Status: Optional
Model Construction: Section 5.16.2.4.4
Required Dependent Command(s): BC
Related Command(s): BC Default Update dt
Boundary condition block command that sets how often boundary data are refreshed or interpolated during the simulation. Overrides the global BC Default Update dt command on a per boundary condition basis.
bc_update_dt
Default: 0.0
Units: seconds (s)
The default of 0.0 s means that boundary data are updated at every simulation timestep. For long simulations with slowly varying boundary conditions, setting this to a value greater than 0.0 can reduce model run times by reducing the frequency of boundary data updates.
Bed Adjust == ZB_adjust | DZB_adjust | <bathy_database_file_path>
Status: Optional
Model Construction: Section 5.17.10
Required Dependent Command(s): Structure
Related Command(s): Control, Control Parameter, Bathy Database
Structure block command that defines the bathymetric modification model for variable bathymetry structures. Supported bed adjustment model options are:
- ZB_adjust: Adjustable bed elevations for a series of cells with a specified crest level
- DZB_adjust: Adjustable bed elevations for a series of cells with a specified crest level dz above existing bed levels
- bathy_database: A lookup table of digital elevation models (DEMs) that are used to adjust bed elevations
Used in conjunction with a control specification to modify bed elevations during the simulation. Supported for zone structure connection types.
Bed Elevation Limits == <zb_min>, <zb_max>
Status: Optional
Model Construction: Section 5.14.2.1
Required Dependent Command(s): Material
Related Command(s): Global Bed Elevation Limits
Material block command that assigns material specific lower and upper limits to local bed elevation values. Overrides the global bed elevation limits assigned by the Global Bed Elevation Limits command.
zb_min
zb_max
| Parameter | Default | Description | Units |
|---|---|---|---|
| zb_min | Global value | Lower elevation limit. | mRL or ftRL |
| zb_max | Global value | Upper elevation limit. | mRL or ftRL |
Bedload Transport == {0} | 1
Status: Optional
Model Construction: Section 8.8.2.3
Required Dependent Command(s): BC
Related Command(s): Sediment Control File, Include Sediment
Boundary condition block command that allows bedload fluxes to pass through open polyline (nodestring) boundaries as a zero gradient bedload flux boundary. Used in conjunction with the TUFLOW FV Sediment Transport Module.
The alias Bed Load Transport is also supported.
Blockage File == <blockage_file_path>
Status: Optional
Model Construction: Section 5.17.5.1
Required Dependent Command(s): Structure, Energy Loss Function, Form Loss Coefficient
Related Command(s): Width File
Structure block command that defines a blockage profile to reduce effective flow width for bridges or flow constrictions.
The blockage file is a comma separated variable file with a relationship of flow fraction and depth. Example syntax and file formats are provided via the model construction link.
Bottom Drag Model == {Manning} | ks
Status: Required
Model Construction: Section 5.9, Section 8.4
Required Dependent Command(s): Bottom Roughness
Related Command(s): Global Bottom Roughness
Sets the bed resistance model to:
- {Manning}: The Manning equation (default)
- ks: Log-law velocity profile
The values assigned to Bottom Roughness depend on the selected bed resistance model. The Manning implementation requires a Manning’s ‘n’ coefficient, while the ks implementation requires a Nikuradse roughness length. This is further explained in the Bottom Roughness command entry.
Bottom Roughness
Status: Optional
Model Construction: Section 5.14.2.1
Required Dependent Command(s): Bottom Drag Model, Material
Related Command(s): Global Bottom Roughness, Include Sediment, Sediment Control File
Navigation row for this command. Argument syntax depends on the selected implementation of Bottom Drag Model. Refer to the implementation specific sections immediately below.
Bottom Roughness == <C_man>
Status: Optional
Model Construction: Section 5.14.2.1
Required Dependent Command(s): Material, Bottom Drag Model
Related Command(s): Global Bottom Roughness
Material block command that sets the Manning’s ‘n’ bed roughness coefficient for a given material ID when Bottom Drag Model == Manning.
C_man
Default: Global value
Units: Manning’s ‘n’
Bottom Roughness == <C_ks>
Status: Optional
Model Construction: Section 5.14.2.1
Required Dependent Command(s): Material, Bottom Drag Model
Related Command(s): Global Bottom Roughness, Include Sediment, Sediment Control File
Set the Nikuradse bed roughness length for a given material ID when Bottom Drag Model == ks.
If using the ks Bottom Drag Model, it can be optionally coupled with the Sediment Transport Module to allow bed roughness to vary with sediment characteristics. See the Sediment Transport Module documentation for more details. Global value is assigned by the Global Bottom Roughness command and can be overridden on a per material basis using this command.
C_ks
Default: Global value
Units : m or ft
Boundary Gridmap == {0} | 1
Status: Conditional - Required when using OBC_GRID boundary type
Model Construction: Section 7.11.2.2.1, Section 7.11.7
Required Dependent Command(s): Grid Definition File
Grid Definition block that controls whether interpolation weightings are calculated from the grid onto boundary nodestrings.
Bulk Latent Heat Coefficient == <C_cln>
Status: Optional
Model Construction: Section 7.7.5.2
Related Command(s): Include Heat, Include Temperature, Latent Heat Model
Alters the neutral conditions bulk latent heat coefficient when using the Constant Bulk Aerodynamic Latent Heat Transfer Coefficient model.
The default coefficient is a well established value that would require considerable justification to alter.
C_cln
Default: 0.0013
Units: NA
Bulk Momentum Transfer Coefficient == <C_cdn>
Status: Optional
Model Construction: Section 5.11.2
Required Dependent Command(s): Wind Stress Model
Specifies the constant bulk momentum transfer coefficient when using the Constant Wind Stress Model.
C_cdn
Default: 0.0013
Units: NA
Bulk Sensible Heat Coefficient == <C_csn>
Status: Optional
Model Construction: Section 7.7.6.1
Related Command(s): Include Heat, Include Temperature
Alters the neutral conditions bulk sensible heat coefficient when using the Constant Sensible Heat model.
The default coefficient is a well established value that would require considerable justification to alter.
C_csn
Default: 0.0013
Units: NA
Cell 3D Depth == <d_cell3d>
Status: Optional
Model Construction: Section 6.6.2
Related Command(s): Vertical Mesh Type
Sets the depth threshold below which 3D momentum calculations are disabled while mass flux calculations are maintained. Useful for model stability in shallow water depths.
Use this threshold to suppress 3D momentum calculations in very shallow water while retaining mass flux calculations.
d_cell3d
Default: 0.1
Units: meters (m)
Cell Elevation File == <cell_elevation_file_path>, <xy_type>
Status: Optional
Model Construction: Section 5.13.3.7
Related Command(s): Read GIS Z Line, Read GRID Zpts, Read TIN Zpts, Set Zpts
Updates cell centre elevations using preprocessed inputs. Can be used to update all model cell elevations or a subset. This command is provided for legacy models or when optimising model initialisation times. The required header names and expected formats depend on the selected xy_type. See the xy_type parameter below for further explanation.
cell_elevation_file_path
Default: No default
xy_type
Default: Cell_ID
The required header names and expected formats depend on the selected xy_type. Supported xy_type options include:
- {Cell_ID}: Requires an ID column that matches the TUFLOW FV assigned cell IDs and a Z column with the updated elevation values. This is the most efficient option because it is a direct cell mapping and requires no spatial interpolation.
- Coordinate: Requires X, Y and Z columns. This option is more flexible because it does not require a direct cell mapping, but it is less efficient than the Cell_ID option.
Cell Elevation Polygon File
Status: Legacy
Related Command(s): Read GIS Z Line
Cell Elevation Polyline File
Status: Legacy
Related Command(s): Read GIS Z Line
Cell Gridmap == 0 | {1}
Status: Optional
Model Construction: Section 5.16.2.2.5
Required Dependent Command(s): Grid Definition File
Related Command(s): Boundary Gridmap
Grid definition block command that controls whether interpolation weightings are calculated from the grid onto model cells.
May be more efficient to set as 0 if the intent of the boundary is to only supply data to the boundary nodestrings via Boundary Gridmap and not to the interior cells.
Cell Size == <cell_x>, <cell_y>
Status: Conditional - Required if using a structured mesh
Model Construction: Section 5.12.4
Required Dependent Command(s): Grid Origin, Grid Size
Related Command(s): Grid Rotation
Sets the x and y cell resolution when using regular mesh specification.
cell_x
X cell resolution in units of meters for Cartesian metric models, feet for Cartesian US Customary models or decimal degrees for Spherical models.
cell_y
Y cell resolution in units of meters for Cartesian metric models, feet for Cartesian US Customary models or decimal degrees for Spherical models.
Cell Water Quality Depth == <d_cellwq>
Status: Optional
Model Construction: Section 9.3
Related Command(s): Water Quality Model, Water Quality Control File
Sets the minimum water depth at which water quality calculations are undertaken. Water quality calculations are not undertaken in columns (i.e. 2D cells) where the depth is less than the threshold value.
Also accepted as Cell WQ depth.
d_cellwq
Default: 0.02
Units: meters (m)
Cell Wet/Dry Depths == <h_dry>, <h_wet>
Status: Optional
Model Construction: Section 5.8
Sets the cell dry and wetting depths used to switch off momentum and mass calculations in regions of shallow flow.
Used to control wetting and drying behaviour in shallow regions of the model domain.
h_dry
h_wet
CFL == <cfl_number>
Status: Optional
Model Construction: Section 5.7, Section 6.3
Related Command(s): Timestep Limits, CFL Internal, CFL External
Assigns the global maximum Courant-Friedrichs-Lewy (CFL) computational stability condition.
cfl_number
Default: 1.0
The default value is 1.0, which is the theoretical stability limit. In practice this value is commonly lowered to provide additional stability for models that exhibit large gradients in flow, density or constituent concentrations such as the assessment of Tsunami, dam break or lakes with strong vertical stratification.
CFL External == <cfl_external_number>
Status: Optional
Model Construction: Section 5.7, Section 6.3
Related Command(s): CFL, CFL Internal, Timestep Limits
Overrides the global maximum Courant-Friedrichs-Lewy (CFL) condition for external free surface calculations.
cfl_external_number
Default: 1.0
CFL Internal == <cfl_internal_number>
Status: Optional
Model Construction: Section 5.7, Section 6.3
Related Command(s): Timestep Limits, CFL, CFL External
Overrides the global maximum Courant-Friedrichs-Lewy (CFL) condition for internal advective flux calculations.
cfl_internal_number
Default: 1.0
Constant Timestep == <timestep>
Status: Optional
Related Command(s): CFL, CFL Internal, CFL External, Timestep Limits
Specifies a constant simulation timestep instead of using the variable CFL controlled timestep.
If this command is not entered then a variable timestep is applied according to the CFL stability criterion. Due to explicit variable time stepping a constant timestep is not typically recommended unless there is a specific reason to use one. Using this option overrides CFL, CFL Internal, CFL External and Timestep Limits controls.
timestep
Default: No default
Units: seconds (s)
Control == Trigger | Timeseries | Sample | Sample Rule | Target Rule
Status: Conditional - Required if using operational control hydraulic structures or variable bathymetry structures
Model Construction: Section 5.17.11.4, Section 7.12.4.3
Required Dependent Command(s): End Control
Related Command(s): Control File, Control Parameter, Control Update dt
Structure block command that begins a control sub-block used to define operational logic or variable bathymetry behaviour. Supported control types are:
- Trigger: Control parameter is adjusted when a specified trigger condition is met
- Timeseries: Control parameter is adjusted according to a user defined timeseries
- Sample: Control parameter is adjusted based on sampling another variable at a specified location
- Sample Rule: Control parameter is adjusted based on sampling another variable at a specified location according to user defined rules
- Target Rule: Control parameter is adjusted according to user defined rules that do not require sampling another variable
For comparative explanation of the different control types, refer to the operational control and variable bathymetry sections of the model construction chapters.
For example models that you can run with a license to test operational control structure configurations see the TUFLOW FV Hydraulic Structures Example Model.
Control File == <control_file_path>
Status: Conditional - Required if using operational control hydraulic structures or variable bathymetry structures
Model Construction: Section 5.17.11.5, Section 7.12.4.3
Required Dependent Command(s): Control, Control Parameter
Related Command(s): Control Header
Control block command that sets the CSV filepath to the structure control file. This file defines how the control parameter varies during the simulation.
Used for Trigger, Timeseries, Sample Rule and Target Rule control types. Not used for Sample control type.
Control Header == <header_name>
Status: Optional
Model Construction: Section 5.17.11.5, Section 7.12.4.3
Required Dependent Command(s): Control, Control File
Related Command(s): Control Parameter
Specifies the column header used by a structure control definition. Overrides the default header name (which is the same wording as the control parameter) for the control parameter column in the control file. This is useful when using a single control file with multiple control definitions that require different column names for the control parameter.
Control Parameter == Fraction_Open | Min_Flow | Weir_Crest | Weir_dz | Zb | dZb | Bathy_Control
Status: Conditional - Required if using operational control hydraulic structures or variable bathymetry structures
Model Construction: Section 5.17.11.1, Section 7.12.4.1
Required Dependent Command(s): Control
Related Command(s): Control File
Control block command that sets the control parameter used by the active control type. Supported control_parameter values are:
- Fraction_Open
- Min_Flow
- Weir_Crest
- Weir_dz
- Zb
- dZb
- Bathy_Control
Used within a Control block to define the parameter that will be adjusted by the selected control logic.
Control Update dt == <update_dt>
Status: Optional
Model Construction: Section 5.17.11.5, Section 7.12.4.3
Required Dependent Command(s): Control
Control block command that sets the interval to call the control update function.
If not specified, or if set to 0.0, the control logic is evaluated every model timestep.
update_dt
Default: 0.0
Units: seconds (s)
Culvert File == <culvert_file_path>
Status: Conditional - Required when using the Culvert flux function.
Model Construction: Section 5.17.4
Required Dependent Command(s): Flux Function, Structure
Related Command(s): Culvert Parameters, Culvert Invert Check
Structure block command that specifies a CSV file containing the properties for one or more culvert structures.
Reads a CSV file containing the properties for a list of culverts. The file contains a header row followed by one row per culvert definition. The required culvert file entries are described in Table B.12.
Culvert Invert Check == {ERROR} | WARNING
Status: Optional
Model Construction: Section 5.17.4
Controls the behaviour of the culvert invert validation check. If a 1D culvert invert is specified below the minimum ground elevation of the connected nodestring or zone TUFLOW FV outputs an error by default. Setting the command to WARNING changes the message from an error to a warning. The message is written to the .log file and to the GIS messages layer in the log directory when GIS integration is enabled. This message highlights locations where the 1D/2D connection may require improvement or where mesh elevations at the culvert inlet or outlet may need adjustment to reflect surveyed invert levels.
Set to WARNING to downgrade the default error to a warning when a culvert invert falls below the connected ground elevation.
Culvert Parameters == <hd_crit>, <reserved>, <reserved>, <entry_exit_loss_adjust> | 1, <total_energy_head_switch> | 1
Status: Optional
Model Construction: Section 5.17.4
Related Command(s): Flux Function, Culvert File
Sets optional culvert parameters including critical headwater behaviour and culvert energy loss options.
hd_crit
reserved
reserved
entry_exit_loss_adjust
total_energy_head_switch
| Parameter | Default | Description | Units | Science |
|---|---|---|---|---|
| hd_crit | 99999. | Critical depth factor for culvert flow regimes | m or ft | Section B.12.1.2.1 |
| reserved | NA | Reserved | NA | |
| reserved | NA | Reserved | NA | |
| entry_exit_loss_adjust | 0 | Entry and exit loss adjustment (0 = disabled, 1 = enabled) | NA | Section B.12.1.2.2 |
| total_energy_head_switch | 0 | Total energy head calculation switch (0 = disabled, 1 = enabled) | NA | Section B.12.1.2.3 |
Decay Rate == <trace_Kd>
Status: Conditional - Required for the decay tracer model implementation
Model Construction: Section 7.4.4
Required Dependent Command(s): NTracer, Tracer
Related Command(s): Settling Velocity, Water Age, Evapo-Concentrate
Tracer block command that specifies first order decay rate for tracers in the active tracer block.
trace_Kd
Default: 0.0
Units: g/day
Define Event == <event_name>
Status: Conditional - Required when using event simulation management logic
Model Construction: Section 11.3.3
Required Dependent Command(s): End Define
Related Command(s): Event File, BC Event Source, Model Events
Begins an event definition block used for simulation management logic.
Used with the event simulation management commands to apply conditional logic or text substitution based on the active event.
Demo Model == {OFF} | ON
Status: Optional
Related Command(s): Tutorial Model
Alias of Tutorial Model. See Tutorial Model for full documentation.
Density Air == <rho_air>
Status: Optional
Specifies the air density used in atmospheric heat calculations.
rho_air
Default: 1.2
Units: kg/m\(^3\)
This reference value should not generally be modified. It is a default reference value used to calculate wind stress and atmospheric heat exchange source terms. It is overridden by model implementation specific values when using the Tropical Cyclone boundary condition. It is internally calculated when the Kondo Wind Stress Model is specified.
Destratification Unit == Bubbler | Compressor
Status: Conditional - Required for supported bubble plume structures
Model Construction: Section 7.12.3
Required Dependent Command(s): Structure, Properties
Selects the destratification unit type used for supported bubble plume structures.
Supported for zone structures only.
Device ID == <gpu_device_id>
Status: Optional
Model Construction: Section 5.4.4
Required Dependent Command(s): Hardware
Sets the default NVIDIA GPU Device ID to run a simulation on.
Can be used to select the GPU Device ID if multiple GPU Devices exist. gpu_device_id may be overwritten at runtime via command line argument switches: -cpu, -gpu and -pu.
Disable Hydros == {0} | 1
Status: Optional
Required Dependent Command(s): Particle Tracking Control File
Optional command used in combination with the Particle Tracking Module. Setting to 1 will switch off the hydrodynamic calculations in TUFLOW FV.
Rather than obtain advective forcings from TUFLOW FV’s internal hydrodynamic scheme, gridded boundary conditions are used to provide the water level, depth and velocity information, and if required wind and wave inputs to the Particle Tracking Module. Disabling the hydrodynamics has a couple of key advantages:
- PT Module simulations can be completed rapidly as they are not needing to wait for hydrodynamic calculations to be computed
- The PT Module can be driven by a number of global circulation or ocean forecast models, for example HYCOM, BRAN, FVCOM
Disable Water Quality Model == {0} | 1
Status: Optional
Related Command(s): Water Quality Model
Disables water quality calculations and can be used as a diagnostic switch for TUFLOW or external water quality models.
If set to 1, water quality calculations are disabled. This applies to both the TUFLOW FV water quality module and external water quality model couplings.
Display Depth == <display_depth>
Status: Optional
Suppresses result output where local water depth is below the specified display depth threshold.
This affects result display and output only. It does not alter the hydraulic calculations and should not be confused with the wetting and drying controls. Typically used with direct rainfall models to threshold out the display of results in areas of very shallow water that are not of interest. This can help to improve the clarity of visual outputs.
display_depth
Display dt == <log_update_interval>
Status: Optional
Related Command(s): Screen/Log Display Interval
Alias of Screen/Log Display Interval. This name is provided for user convenience. Both Display dt and Screen/Log Display Interval refer to the same functionality.
Echo Geometry == {0} | 1
Status: Optional
Related Command(s): Echo Geometry CSV, Echo Geometry NetCDF
Controls whether geometry check outputs are written to the log directory.
When enabled (1), the geometry outputs can include mesh details, cell elevations and materials, externally updated cell elevations, nodestring locations and output locations. This command outputs both CSV and NetCDF formats. Use Echo Geometry CSV or Echo Geometry NetCDF to control the output formats more specifically.
Echo Geometry CSV == {0} | 1
Status: Optional
Related Command(s): Echo Geometry, Echo Geometry NetCDF
Controls whether geometry check CSV files are written to the log directory.
When enabled (1), CSV geometry outputs can include mesh details, cell elevations and materials, externally updated cell elevations, nodestring locations and output locations.
Echo Geometry NetCDF == {0} | 1
Status: Optional
Related Command(s): Echo Geometry, Echo Geometry CSV
Controls whether the NetCDF geometry check file is written to the log directory.
When enabled (1), a *_geo.nc file is written containing geometry information for cells, faces and nodes.
Else
Status: Optional
Required Dependent Command(s): If Scenario, If Event
Related Command(s): Else If Scenario, Else If Event, Pause
Separates conditional logic branches within an event or scenario condition block.
Else If Event == <event_name>
Status: Optional
Model Construction: Section 11.3.3
Required Dependent Command(s): If Event
Related Command(s): Else, Pause
Adds an alternative conditional branch within an event based simulation management block.
Used after an If Event or another Else If Event statement to test additional event names.
Else If Scenario == <scenario_name>
Status: Optional
Model Construction: Section 11.3.4
Required Dependent Command(s): If Scenario
Related Command(s): Else, Pause
Adds an alternative conditional branch within a scenario based simulation management block.
Used after an If Scenario or another Else If Scenario statement to test additional scenario names.
End BC
Status: Required
Model Construction: Section 5.16.2.3, Section 6.9.2.3, Section 7.11.2.3, Section 8.8.2.3, Section 9.5.2.3
Required Dependent Command(s): BC
Closes a boundary condition block.
End Control
Status: Conditional - Required if using operational control hydraulic structures or variable bathymetry structures
Model Construction: Section 5.17.11.4, Section 7.12.4.3
Required Dependent Command(s): Control
Related Command(s): Structure
Closes a control sub-block used to define operational logic or variable bathymetry behaviour within a structure block.
End Define
Status: Conditional - Required if using event simulation management logic
Model Construction: Section 11.3.3
Required Dependent Command(s): Define Event
Related Command(s): Event File, Model Events, If Event
Closes an event definition block used for simulation management logic.
End Grid
Status: Conditional - Required if using either Grid Definition or Grid Definition File
Model Construction: Section 5.16.2.2.5
Required Dependent Command(s): Grid Definition, Grid Definition File
Closes a grid definition block.
End If
Status: Conditional - Required if using event simulation management logic or nested scenario definitions
Model Construction: Section 11.3.3, Section 11.3.4
Required Dependent Command(s): If Event, If Scenario
Related Command(s): Else If Event, Else If Scenario, Else, Pause
Closes an If Event or If Scenario block used for simulation management logic or nested scenario definitions.
End Material
Status: Required - Required to close a material block
Model Construction: Section 5.14, Section 6.7, Section 7.9
Required Dependent Command(s): Material
Closes a material block.
End Output
Status: Required - Required to close an output block
Model Construction: Section 5.18.2.3, Section 6.11.2.2, Section 7.13.2.1, Section 8.10.2.1, Section 9.7.2.2
Required Dependent Command(s): Output
Closes a model output block.
End Structure
Status: Conditional - Required if using hydraulic structures
Model Construction: Section 5.17.2.3, Section 7.12
Required Dependent Command(s): Structure
Closes a hydraulic structure block.
End Time == <simulation_end_time>
Status: Required
Model Construction: Section 5.6
Related Command(s): Start Time, Time Format
Specifies the end time for the simulation in the selected Time Format.
simulation_end_time
The format of simulation_end_time depends on the selected Time Format:
- For Time Format == Hours, units are in decimal hours.
- For Time Format == ISODate, inputs are in date form dd/mm/yyyy HH:MM:SS (or some truncation thereof)
End Tracer
Status: Conditional - Required if using tracer blocks
Model Construction: Section 7.4
Required Dependent Command(s): Tracer
Related Command(s): NTracer, Settling Velocity, Decay Rate, Water Age, Evapo-Concentrate
Closes a tracer block used to define tracer properties and behaviour.
Energy Loss File == <energy_loss_file_path>
Status: Conditional - Required if using the table Energy Loss Function
Model Construction: Section 5.17.5.2
Required Dependent Command(s): Structure, Energy Loss Function
File specifying the head loss relationship for the table energy loss function.
The file is a CSV that defines the relationship between discharge and head loss for the table based energy loss formulation. It should not be used in combination with blockage or width files, otherwise double counting of energy losses may occur. It is typically used to represent head loss through a structure such as a bridge where the head loss relationship is known from field measurements or detailed CFD modelling. See the model construction chapter on hydraulic structures for more details and example file format.
Energy Loss Function == {None} | Coefficient | Table
Status: Conditional - Required when representing a bridge or other structure with sub grid scale energy losses
Model Construction: Section 5.17.5
Required Dependent Command(s): Structure, Form Loss Coefficient, Energy Loss File
Configures energy loss structures such as bridges. Required when representing head loss within a structure block.
Options include:
- {None}: No energy loss (default)
- Coefficient: Uses Form Loss Coefficient command
- Table: Uses Energy Loss File command to define the head loss relationship
Evapo-Concentrate == 0 | {1}
Status: Optional
Model Construction: Section 7.4
Required Dependent Command(s): NTracer, Tracer
Tracer block command to control whether tracer concentration increases due to evaporation.
When enabled (1), as water evaporates from the surface, the mass of tracer in the cell is conserved, resulting in an increase in tracer concentration. This can be used to simulate the concentration of salts or other constituents as water evaporates.
Event File == <event_file_path>
Status: Optional
Model Construction: Section 11.3.3
Related Command(s): Define Event, BC Event Source, Model Events
An extension of the .fvc file used to house event definitions for simulation management. This allows event definitions to be stored in a separate file to the main simulation control file, which can help with organisation and clarity when using a large number of events for complex simulation management logic.
Should be specified as the last command in the .fvc file.
Exact Timestep == {0} | 1
Status: Optional
Required Dependent Command(s): Output
Outputs the result at the exact computational timestep.
Set to 1 to write results at the exact computational timestep rather than the nearest available output time.
External Turbulence Model Directory == <directory_path>
Status: Legacy
Required Dependent Command(s): Vertical Mixing Model
Final Output == <final_output_time>
Status: Optional
Model Construction: Section 5.18.2.3
Required Dependent Command(s): Output
Related Command(s): Start Output, Suffix, Output Interval, Time Format
Output block command to define the final output time of the model output. If not specified, uses the model End Time.
The time value must be consistent with the selected simulation Time Format. Useful for debugging or developing high temporal resolution outputs for a specific period of interest within a longer simulation. Can be used in combination with the Start Output command to define a specific output window within the overall simulation period.
Flux File == <flux_file_path>
Status: Conditional - Required when using the Matrix or Timeseries Flux Function implementations
Model Construction: Section 5.17.6, Section 5.17.8
Required Dependent Command(s): Structure, Flux Function
Related Command(s): NLSWE Limit
Specifies the hQh flux matrix or flow timeseries file used when the Matrix or Timeseries flux function is selected.
Reads the file defining either a timeseries or an hQh relationship, depending on the selected Flux Function implementation. Detailed descriptions of the required file structure for each implementation are provided in the referenced 2D HD construction section.
Flux Function == {NLSWE} | Weir | Weir_dz | Culvert | Porous | Matrix | Timeseries | Wall
Status: Conditional
Model Construction: Section 5.17.2.1
Required Dependent Command(s): Structure
Related Command(s): Properties, Flux File, Culvert File, Culvert Parameters, Name, Control
Modifies the flow condition using the following structure flux function types:
- {NLSWE}: No structure (default)
- Weir: Weir structure with RL weir crest elevation
- Weir_dz: Weir structure with bed offset weir crest elevation
- Culvert: Culvert structure
- Porous: Permeable barrier
- Matrix: User defined flow hQh relationship
- Timeseries: User defined flow timeseries or pump
- Wall: No flow
Detailed descriptions of each flux function type and the required and optional commands associated with each are provided in the linked model construction chapter on hydraulic structures.
Form Loss Coefficient == <C_flc>
Status: Conditional - Required when using the coefficient Energy Loss Function
Model Construction: Section 5.17.5
Required Dependent Command(s): Energy Loss Function
Related Command(s): Width File, Blockage File
Represents sub grid scale energy losses as a function of velocity head.
Commonly used to model bridge or flow obstructions. Can be optionally used in combination with either Width File or Blockage File.
C_flc
Default: 0.0
Units: NA
g == <gravitational_acceleration>
Status: Optional
Specifies gravitational acceleration for the selected unit system.
gravitational_acceleration
Default: 9.81 (m/s\(^2\)) or 32.174 (ft/s\(^2\))
Units : m/s\(^2\) or ft/s\(^2\)
Would not typically be modified from the default.
Geometry 2D == <mesh_file_path>
Status: Conditional - Required if using an unstructured mesh
Model Construction: Section 5.12.3
Reads the mesh topology from a .2dm unstructured mesh file. This mesh may contain triangles, quadrilaterals or a combination of these geometries. The mesh can optionally contain spatially varying bathymetric and material data.
Only one Geometry 2D command and mesh can be used per simulation. If multiple are specified, the latter command takes precedence.
GIS Format == {MIF} | SHP
Status: Required
Model Construction: Section 5.3
Related Command(s): SHP Projection, MI Projection
Sets the format of all output GIS files.
Typically set to SHP to align with the TUFLOW Plugin workflow.
Note that the format of an input layer is solely controlled by the file extension (i.e. .mif for the MIF format and .shp for the SHP format).
GIS Projection Check == {ERROR} | WARNING
Status: Optional
Model Construction: Section 5.3
Required Dependent Command(s): GIS Format
Related Command(s): SHP Projection, MI Projection
Sets the error behavior when comparing input GIS layer projections with the model projection set by SHP Projection or MI Projection:
- {ERROR}: Will stop the simulation and report an error (default)
- WARNING: Will report a message to the GIS messages check file, but not stop simulation
During model start-up, checks are completed by comparing each input GIS .shp layer projection with that specified by the SHP Projection or MI Projection command. If they are not equivalent, ERROR 0305 - Projection of .shp file is different to that specified by the SHP Projection == command. will result. This error typically occurs if trying to read a layer with a different coordinate system. However, if mixing layers created by differing GIS packages, slight differences in the text string format can result in ERROR 0305 being reported despite there being no material difference in the projection string. In such cases, this command can be used to adjust the error reporting behaviour.
Global Bed Elevation Limits == <zb_min>, <zb_max>
Status: Optional
Model Construction: Section 5.13.3.8
Related Command(s): Bed Elevation Limits
Sets a spatially constant lower limit (zb_min) and upper limit (zb_max) to the model bathymetry. Model elevations below zb_min will be set to zb_min, and likewise model elevations above zb_max will be set to zb_max.
This command is executed after all other bathymetry commands, and will overwrite any preceeding bathymetry below or above the zb_min or zb_max values. Can also be applied to specific material types using Bed Elevation Limits.
zb_min
zb_max
Global Bottom Roughness
Status: Required
Required Dependent Command(s): Bottom Drag Model
Related Command(s): Bottom Roughness
Navigation row for this command. Argument syntax depends on the selected implementation of Bottom Drag Model. Use the applicable implementation entry below.
Global Bottom Roughness == <Manning’s_n_coefficient>
Status: Conditional - Required if Bottom Drag Model == Manning
Model Construction: Section 5.9.3
Required Dependent Command(s): Bottom Drag Model
Related Command(s): Bottom Roughness
Set the global Manning’s ‘n’ bed roughness coefficient.
Manning’s “n” coefficient
Default: No default
Units: Manning’s ‘n’
Global Bottom Roughness == <ks_roughness>
Status: Conditional - Required if Bottom Drag Model == ks
Model Construction: Section 5.9.4
Required Dependent Command(s): Bottom Drag Model
Related Command(s): Bottom Roughness
Set the global Nikuradse bed roughness length.
Can be overridden locally by Material specific values.
ks roughness
Global Horizontal Eddy Viscosity
Status: Conditional - Required when using the Constant, Smagorinsky or Wu Momentum Mixing Model implementations
Required Dependent Command(s): Momentum Mixing Model
Related Command(s): Global Horizontal Eddy Viscosity Limits, Horizontal Eddy Viscosity
Navigation row for this command. Argument syntax depends on the selected Momentum Mixing Model implementation.
This command is used by the Constant, Smagorinsky and Wu Momentum Mixing Model implementations. It is not required when Momentum Mixing Model == None.
Can be locally overridden by Material specific values.
Global Horizontal Eddy Viscosity == <K_eddy_viscosity>
Status: Conditional - Required when Momentum Mixing Model == Constant
Model Construction: Section 5.10.4
Required Dependent Command(s): Momentum Mixing Model
Sets the global value of horizontal eddy viscosity when Momentum Mixing Model == Constant.
K_eddy_viscosity
Default: 0.0
Units: m\(^2\)/s
Horizontal eddy viscosity value (Constant momentum mixing model).
Global Horizontal Eddy Viscosity == <C_smagorinsky>
Status: Conditional - Required when Momentum Mixing Model == Smagorinsky
Model Construction: Section 5.10.5
Required Dependent Command(s): Momentum Mixing Model
Sets the global value of the Smagorinsky eddy viscosity coefficient when Momentum Mixing Model == Smagorinsky.
C_smagorinsky
Default: 0.0
Units: NA
Smagorinsky eddy viscosity coefficient (Smagorinsky momentum mixing model).
Global Horizontal Eddy Viscosity == <C_wu>
Status: Conditional - Required when Momentum Mixing Model == Wu
Model Construction: Section 5.10.6
Required Dependent Command(s): Momentum Mixing Model
Sets the global value of the Wu eddy viscosity coefficient when Momentum Mixing Model == Wu.
C_wu
Default: 0.0
Units: NA
Horizontal eddy viscosity coefficient (Wu momentum mixing model).
Global Horizontal Eddy Viscosity Limits == <K_nu_min>, <K_nu_max>
Status: Conditional - Required when using the Smagorinsky or Wu Momentum Mixing Model implementations
Model Construction: Section 5.10.2
Required Dependent Command(s): Momentum Mixing Model, Global Horizontal Eddy Viscosity
Related Command(s): Horizontal Eddy Viscosity Limits
Applies global minimum and maximum limits to computed horizontal eddy viscosity.
Can be used with the Smagorinsky and Wu Momentum Mixing Model implementations to apply global limits to the computed horizontal eddy viscosity. It is not used when Momentum Mixing Model == Constant.
K_nu_min
K_nu_max
| Parameter | Default | Description |
|---|---|---|
| K_nu_min | 0.0 | Minimum limit on horizontal eddy viscosity. |
| K_nu_max | 99999. | Maximum limit on horizontal eddy viscosity. |
Global Horizontal Scalar Diffusivity == <K_d>
Status: Conditional - Required when using the Constant, Smagorinsky or Elder Scalar Mixing Model implementations
Model Construction: Section 7.5
Required Dependent Command(s): Scalar Mixing Model
Related Command(s): Global Horizontal Scalar Diffusivity Limits, Horizontal Scalar Diffusivity
Navigation row for this command. Argument syntax depends on the selected Scalar Mixing Model implementation.
This command is used by the Constant, Smagorinsky and Elder Scalar Mixing Model implementations. It is not required when Scalar Mixing Model == None or Scalar Mixing Model == Warmup.
Can be locally overridden by Material specific values.
Global Horizontal Scalar Diffusivity == <K_d>
Status: Conditional - Required when Scalar Mixing Model == Constant
Model Construction: Section 7.5.4
Required Dependent Command(s): Scalar Mixing Model
Sets a global value of horizontal scalar diffusivity when Scalar Mixing Model == Constant.
K_d
Default: 0.0
Units: m\(^2\)/s
Horizontal scalar diffusivity (constant scalar mixing model).
Global Horizontal Scalar Diffusivity == <C_smagorinsky>
Status: Conditional - Required when Scalar Mixing Model == Smagorinsky
Model Construction: Section 7.5.6
Required Dependent Command(s): Scalar Mixing Model
Sets the global value of the Smagorinsky scalar diffusivity coefficient.
C_smagorinsky
Default: 0.0
Units: NA
Smagorinsky horizontal scalar diffusivity coefficient.
Global Horizontal Scalar Diffusivity == <C_elder_longitudinal>, <C_elder_transverse>
Status: Conditional - Required when Scalar Mixing Model == Elder
Model Construction: Section 7.5.5
Required Dependent Command(s): Scalar Mixing Model
Sets the global longitudinal and transverse Elder scalar diffusivity coefficients.
C_elder_longitudinal
C_elder_transverse
| Parameter | Default | Description | Units |
|---|---|---|---|
| C_elder_longitudinal | 0.0 | Elder longitudinal scalar diffusivity coefficient. | NA |
| C_elder_transverse | 0.0 | Elder transverse scalar diffusivity coefficient. | NA |
Global Horizontal Scalar Diffusivity Limits == <K_d_min>, <K_d_max>
Status: Optional
Model Construction: Section 7.5.2
Required Dependent Command(s): Scalar Mixing Model, Global Horizontal Scalar Diffusivity
Related Command(s): Horizontal Scalar Diffusivity Limits
Applies global minimum and maximum limits to computed scalar diffusivity.
Used with Smagorinsky and Elder scalar mixing model implementations that compute horizontal scalar diffusivity from the selected model coefficients or settings. Can be overridden locally by Material specific values. Not used if Scalar Mixing Model == None or Scalar Mixing Model == Warmup.
K_d_min
K_d_max
| Parameter | Default | Description | Units |
|---|---|---|---|
| K_d_min | 0.0 | Minimum limit on scalar diffusivity. | m\(^2\)/s |
| K_d_max | 99999. | Maximum limit on scalar diffusivity. | m\(^2\)/s |
Global Minimum Vertical EPS == <minimum_eps>
Status: Optional
Model Construction: Section 6.5.5, Section 6.5.6
A user specified minimum limit on the calculated turbulent dissipation rate.
minimum_eps
Default: 1E-14
Units: m\(^2\)/s\(^3\)
Global Minimum Vertical TKE == <minimum_tke>
Status: Optional
Model Construction: Section 6.5.5, Section 6.5.6
Required Dependent Command(s): Vertical Mixing Model
Related Command(s): Global Minimum Vertical EPS
A user specified minimum limit on the calculated turbulent kinetic energy when using the K-Epsilon or K-Omega vertical mixing models.
minimum_tke
Default: 1E-10
Units: m\(^2\)/s\(^2\)
Global Temporal Extrapolation Check == {ERROR} | WARNING
Status: Optional
Model Construction: Section 5.16.2.4.4
Related Command(s): Temporal Extrapolation Check
Sets the global behaviour when boundary input data are extrapolated beyond their available time range.
Used to control how the model responds when boundary input data are requested outside their available time range. Can be applied on a BC block basis using Temporal Extrapolation Check. If extrapolation occurs and Global Temporal Extrapolation Check == {ERROR}, the model will stop and report an error. If Global Temporal Extrapolation Check == {WARNING}, the model will continue to run and a message will be written to the log file.
Global Vertical Eddy Viscosity Limits == <viscosity_min>, <viscosity_max>
Status: Optional
Model Construction: Section 6.5
Required Dependent Command(s): Vertical Mixing Model
Related Command(s): Vertical Eddy Viscosity Limits
Sets a minimum and maximum limit on computed eddy viscosity.
Used with Parametric, K-Epsilon, K-Omega or External vertical mixing models. It is not used when the vertical mixing model is Constant. Can be overridden locally by Material specific values.
viscosity_min
viscosity_max
| Parameter | Default | Description | Units |
|---|---|---|---|
| viscosity_min | 0.0 | Minimum eddy viscosity limit. | m\(^2\)/s |
| viscosity_max | 99999. | Maximum eddy viscosity limit. | m\(^2\)/s |
Global Vertical Scalar Diffusivity Limits == <diffusivity_min>, <diffusivity_max>
Status: Optional
Model Construction: Section 6.5
Applies global minimum and maximum limits to computed vertical scalar diffusivity for Parametric or External vertical mixing models.
Used with Parametric or External vertical mixing models. It is not used when the vertical mixing model is Constant.
diffusivity_min
diffusivity_max
| Parameter | Default | Description | Units |
|---|---|---|---|
| diffusivity_min | 0.0 | Minimum vertical scalar diffusivity limit. | m\(^2\)/s |
| diffusivity_max | 99999. | Maximum vertical scalar diffusivity limit. | m\(^2\)/s |
Grid Definition == <grid_id>
Status: Conditional - Required when using gridded boundary condition input (Grid Definition File is a supported alternative)
Model Construction: Section 5.16.2.2.5
Required Dependent Command(s): Grid Definition Label, End Grid
Related Command(s): Grid Definition File
Opens a grid definition block for user defined grid coordinates used by gridded boundary condition inputs.
Used to define grid coordinates for gridded boundary inputs such as wind or atmospheric forcing. Not supported if the boundary condition grid requires a z dimension.
Grid Definition File == <grid_definition_file_path>
Status: Conditional - Required when using gridded boundary condition inputs (Grid Definition is a supported alternative)
Model Construction: Section 5.16.2.2.5, Section 6.9.2.2.1
Required Dependent Command(s): Grid Definition Variables, Grid Definition Label
Related Command(s): Grid Definition
Opens a grid definition file block and specifies the NetCDF file containing grid coordinates for gridded boundary conditions.
Commands nested within this block can define the grid label, coordinate variable names, vertical coordinate type and grid mapping options.
Grid Definition Label == <grid_name>
Status: Conditional - Required if using Grid Definition or Grid Definition File
Model Construction: Section 5.16.2.2.5
Required Dependent Command(s): Grid Definition File, Grid Definition
Grid definition block command that assigns a name to the grid definition so it can be referenced by multiple boundary conditions later.
Grid Definition Variables == <x_variable_name>, <y_variable_name>, <z_variable_name>
Status: Conditional - Required when using gridded boundary condition inputs with user defined grid coordinates specified in a NetCDF file
Model Construction: Section 5.16.2.2.5, Section 6.9.2.2.1
Required Dependent Command(s): Grid Definition File
If using the Grid Definition File option, this command specifies which variables should be read from the NetCDF to create the grid.
Typically uses Easting and Northing or Longitude and Latitude variable names from the NetCDF grid definition file. The z_variable_name is only required if the grid definition file contains vertical coordinate information and the boundary condition requires a z dimension (e.g. a 3D QC_GRID boundary condition). If z_variable_name is not specified the boundary will be applied as a depth averaged condition.
Grid Origin == <origin_x>, <origin_y>
Status: Conditional - Required if using a structured mesh
Model Construction: Section 5.12.4
Required Dependent Command(s): Cell Size, Grid Size
Related Command(s): Grid Rotation, Spherical, Units
Sets the x and y grid origin when using regular mesh specification.
In meters for Cartesian metric models, feet for Cartesian US Customary models or decimal degrees for Spherical models.
origin_x
X grid origin.
origin_y
Y grid origin.
Grid Rotation == <rotation_angle>
Status: Optional
Model Construction: Section 5.12.4
Required Dependent Command(s): Grid Origin, Cell Size, Grid Size
Sets the grid rotation when using regular mesh specification.
Units are in degrees anticlockwise from East. See the model construction chapter link below for instructive figures on angle convention and example syntax.
rotation_angle
Default: 0.0
Units: degrees
Grid Size == <size_x>, <size_y>
Status: Conditional - Required if using a structured mesh
Model Construction: Section 5.12.4
Required Dependent Command(s): Grid Origin, Cell Size
Related Command(s): Grid Rotation, Spherical, Units
Sets the x and y extent of the mesh when using regular mesh specification.
This is the absolute extent of the grid, not the number of cells. For example a grid with 10 cells at 100 m cell size would have a size_x of 1000 m, not 10. Units are a function of the selected coordinate reference frame. In meters for Cartesian metric models, feet for Cartesian US Customary models or decimal degrees for Spherical models.
size_x
X extent of the mesh.
size_y
Y extent of the mesh.
Gridmap Compression == {0} | 1
Status: Optional
Model Construction: Section 5.18.2.3
Required Dependent Command(s): Grid Definition, Grid Definition File
Use the grid extent as a mask to reduce the calculation footprint of boundary updates.
For example, if the computational mesh contains 40,000 cells and the boundary grid extent is coincident with 1,000 of the cells, only process the 1,000 cells when reading and updating model boundary data.
Hardware == {CPU} | GPU
Status: Optional
Model Construction: Section 5.4
Related Command(s): Device ID
Sets the model default to compute the simulation using CPU (Central Processing Unit) or GPU (Graphical Processing Unit acceleration).
This may be overwritten at runtime via command line argument switches: -cpu, -gpu and -pu. Running on GPU requires a supported NVIDIA graphics card and access to TUFLOW FV’s GPU Module.
Horizontal AlphaR == <depth_factor>, <velocity_factor>, <scalar_factor>
Status: Optional
Model Construction: Section 5.5.4
Required Dependent Command(s): Spatial Order
Related Command(s): Horizontal Gradient Limiter
Sets a reduction factor to scale between first and second order horizontal spatial reconstructions for depth, velocity and scalar model variable fields.
This may be implemented to solve for depth/water level and velocity in 1st order whilst solving plume/constituents in 2nd order as they may exhibit high spatial gradients (or vice-versa). Set factors to 1.0 for full 2nd order reconstruction, or 0.0 for full 1st order reconstruction. Values between 0 and 1 will blend between the two orders of reconstruction. Ignored if using first order spatial reconstruction Spatial Order == 1,1.
depth_factor
velocity_factor
scalar_factor
| Parameter | Default | Description |
|---|---|---|
| depth_factor | 1.0 | Reduction factor to scale between first and second order horizontal spatial reconstructions for depth. |
| velocity_factor | 1.0 | Reduction factor to scale between first and second order horizontal spatial reconstructions for velocity. |
| scalar_factor | 1.0 | Reduction factor to scale between first and second order horizontal spatial reconstructions for scalar model variable fields. |
Horizontal Eddy Viscosity
Status: Optional
Model Construction: Section 5.14.2.1
Required Dependent Command(s): Material, Momentum Mixing Model
Related Command(s): Global Horizontal Eddy Viscosity, Global Horizontal Eddy Viscosity Limits, Horizontal Eddy Viscosity Limits
Navigation row for this command. Argument syntax depends on the selected Momentum Mixing Model implementation.
This command applies material specific overrides to the global horizontal eddy viscosity settings. It is used by supported active implementations only and is not used when Momentum Mixing Model == None.
Horizontal Eddy Viscosity == <K_nu>
Status: Optional
Model Construction: Section 5.14.2.1
Required Dependent Command(s): Material
Assigns a material specific constant horizontal eddy viscosity value. Overrides the global horizontal eddy viscosity value.
K_nu
Default: No default
Units: m\(^2\)/s
Horizontal Eddy Viscosity == <C_smagorinsky>
Status: Optional
Model Construction: Section 5.14.2.1
Required Dependent Command(s): Material
Assigns a material specific Smagorinsky horizontal eddy viscosity coefficient. Overrides the global horizontal eddy viscosity coefficient.
C_smagorinsky
Default: No default
Units: NA
Horizontal Eddy Viscosity == <C_wu>
Status: Optional
Model Construction: Section 5.14.2.1
Required Dependent Command(s): Material
Assigns a material specific Wu horizontal eddy viscosity coefficient. Overrides the global horizontal eddy viscosity coefficient.
C_wu
Default: No default
Units: NA
Horizontal Eddy Viscosity Limits == <K_mu_min>, <K_mu_max>
Status: Optional
Model Construction: Section 5.14.2.1
Required Dependent Command(s): Material
Related Command(s): Horizontal Eddy Viscosity, Global Horizontal Eddy Viscosity Limits
Assigns material specific minimum and maximum limits on horizontal eddy viscosity, overriding the corresponding global values.
Used within a Material block to apply local minimum and maximum limits to computed horizontal eddy viscosity. Global value placeholders refer to the values set by the Global Horizontal Eddy Viscosity Limits command.
K_mu_min
K_mu_max
| Parameter | Default | Description |
|---|---|---|
| K_mu_min | Global value | Minimum limit on horizontal eddy viscosity. |
| K_mu_max | Global value | Maximum limit on horizontal eddy viscosity. |
Horizontal Gradient Limiter == {LCD} | MLG
Status: Optional
Model Construction: Section 5.5.4
Required Dependent Command(s): Spatial Order
Related Command(s): Horizontal AlphaR
Sets the Total Variation Diminishing (TVD) limiting scheme for second order horizontal spatial reconstruction:
- {LCD}: Limited Central Difference (default)
- MLG: Maximum Limited Gradient
Ignored if using first order spatial reconstruction Spatial Order == 1, 1.
Horizontal Scalar Diffusivity
Status: Optional
Model Construction: Section 7.9.2
Required Dependent Command(s): Scalar Mixing Model, Material
Related Command(s): Global Horizontal Scalar Diffusivity, Global Horizontal Scalar Diffusivity Limits, Horizontal Scalar Diffusivity Limits
Navigation row for this command. Argument syntax depends on the selected Scalar Mixing Model implementation.
This command applies material specific overrides to the global horizontal scalar diffusivity settings. It is used by supported active implementations only and is not used when Scalar Mixing Model == None or Scalar Mixing Model == Warmup.
Horizontal Scalar Diffusivity == <K_d>
Status: Optional
Model Construction: Section 7.9.2
Required Dependent Command(s): Material
Assigns a material specific constant horizontal scalar diffusivity value. Overrides the global horizontal scalar diffusivity value. The global value placeholder refers to the value set by the Global Horizontal Scalar Diffusivity command.
K_d
Default: Global value
Units: m\(^2\)/s
Horizontal scalar diffusivity value.
Horizontal Scalar Diffusivity == <C_smagorinsky>
Status: Optional
Model Construction: Section 7.9.2
Required Dependent Command(s): Material
Assigns a material specific Smagorinsky horizontal scalar diffusivity coefficient. Overrides the global horizontal scalar diffusivity coefficient. Global value placeholder refers to the value set by the Global Horizontal Scalar Diffusivity command.
C_smagorinsky
Default: Global value
Smagorinsky horizontal scalar diffusivity coefficient.
Horizontal Scalar Diffusivity == <C_elder_longitudinal>, <C_elder_transverse>
Status: Optional
Model Construction: Section 7.9.2
Required Dependent Command(s): Material
Assigns material specific longitudinal and transverse Elder scalar diffusivity coefficients. Overrides the global scalar diffusivity coefficients. Global value placeholders refer to the values set by the Global Horizontal Scalar Diffusivity command.
C_elder_longitudinal
C_elder_transverse
| Parameter | Default | Description |
|---|---|---|
| C_elder_longitudinal | Global value | Elder longitudinal scalar diffusivity coefficient. |
| C_elder_transverse | Global value | Elder transverse scalar diffusivity coefficient. |
Horizontal Scalar Diffusivity Limits == <K_d_min>, <K_d_max>
Status: Optional
Model Construction: Section 7.9.2
Required Dependent Command(s): Material
Related Command(s): Horizontal Scalar Diffusivity, Global Horizontal Scalar Diffusivity Limits
Assigns material specific horizontal scalar diffusivity limits, overriding the corresponding global values.
Used within a Material block to apply local minimum and maximum limits to computed horizontal scalar diffusivity. Global value placeholders refer to the values set by the Global Horizontal Scalar Diffusivity Limits command.
K_d_min
K_d_max
| Parameter | Default | Description | Units |
|---|---|---|---|
| K_d_min | Global value | Minimum limit for horizontal scalar diffusivity. | m\(^2\)/s |
| K_d_max | Global value | Maximum limit for horizontal scalar diffusivity. | m\(^2\)/s |
If Event == <event_name>
Status: Optional
Model Construction: Section 11.3.3
Required Dependent Command(s): End If
Related Command(s): Define Event, Else If Event, Else, Pause
Enables use of conditional programming statement using event names.
If Scenario == <scenario_name/s>
Status: Conditional - Required if using scenario based conditional programming
Model Construction: Section 11.3.4
Required Dependent Command(s): End If
Related Command(s): Else If Scenario, Else, Pause
Controls which commands are to be applied depending on the scenario or combination of scenarios specified by the user.
Inactive == {0} | 1
Status: Legacy
Required Dependent Command(s): Material
Include == <include_file_path>
Status: Optional
Model Construction: Section 4.2.6
Related Command(s): Read File
Reads commands from an include file as if they were listed directly in the simulation control file. Commonly used to group like commands together for improved control file navigation and structure.
Can be used in any part of the main simulation control file (.fvc) body, but not within blocks such as Material, If Event, If Scenario, BC, Structure and others. Commands contained in the include file will be read as if they are listed in the .fvc file at the location they are read.
The file extension for the include file can be .fvc or .txt, or any other extension as desired. The include file should be located in the same directory as the main simulation control file, or the file path should be specified. Provides the same functionality as the Read File command.
Include Bed Friction == 0 | {1}
Status: Optional
Controls whether bed friction is included in the momentum equations. Used for analysis purposes to isolate the effects of bed friction on the modelled system, or to simulate an idealised fluid with no bed friction. Not recommended to modify for general use.
Include Coriolis == 0 | {1}
Status: Optional
Controls whether Coriolis forcing is included in the momentum equations. Used for analysis purposes to isolate the effects of Coriolis forcing on the modelled system, or to simulate an idealised fluid with no Coriolis forcing. Not recommended to modify for general use.
Include Heat == {0} | 1
Status: Conditional - Required for water quality simulation, otherwise optional
Model Construction: Section 7.7
Required Dependent Command(s): Include Temperature
Related Command(s): Shortwave Radiation Model, Longwave Radiation Model, Latent Heat Model, Wind Stress Model, Bulk Latent Heat Coefficient, Bulk Sensible Heat Coefficient, Atmospheric Stability Model
Enables atmospheric heat exchange budget in temperature simulations.
Include Salinity == <active_switch>, <density_switch>
Status: Conditional - Required for water quality modelling, otherwise optional
Model Construction: Section 7.2
Activates salinity simulation and optionally density coupling using active and baroclinic flags.
active_switch
density_switch
| Parameter | Default | Description |
|---|---|---|
| active_switch | 0 | Enable (1) or disable (0) salinity simulation. |
| density_switch | 0 | Enable (1) or disable (0) density coupling with salinity. |
Include Sediment == <active_switch>, <density_switch>
Status: Optional
Model Construction: Section 8.2
Required Dependent Command(s): Sediment Control File
Activates sediment simulation and optionally density coupling using active and baroclinic flags. If sediment is included a Sediment Control File is also required to be specified.
active_switch
density_switch
| Parameter | Default | Description |
|---|---|---|
| active_switch | 0 | Enable (1) or disable (0) sediment simulation. |
| density_switch | 0 | Enable (1) or disable (0) density coupling with sediment. |
Include Stokes Drift == <active_switch> | <density_switch>
Status: Optional
Model Construction: Section 5.16.7
Related Command(s): Stokes Transport Factor, Wave Parameters, Surfzone Undertow Factor
Controls whether Stokes mass transport is included in the momentum and mass equations when spectral wave boundary conditions are applied.
Calculated for depths in deepwater and surfzone; if cells are between these depths the mass transport is interpolated between the deepwater and surfzone mass transport. Can be used in combination with the Surfzone Undertow Factor command to help with cross shore transport.
Include Temperature == <active_switch>, <density_switch>
Status: Conditional - Required for water quality modelling and atmospheric heat exchange, otherwise optional
Model Construction: Section 7.3
Related Command(s): Include Heat
Activates temperature simulation and optionally density coupling using active and baroclinic flags.
If the active_switch is set to 1 and density_switch is set to 0 then temperature effectively is modelled as a passive tracer.
active_switch
density_switch
| Parameter | Default | Description |
|---|---|---|
| active_switch | 0 | Enable (1) or disable (0) temperature simulation. |
| density_switch | 0 | Enable (1) or disable (0) density coupling with temperature. |
Include Wind == 0 | {1}
Status: Optional
Related Command(s): Wind Stress Model
Controls whether wind stress terms are included in the momentum and mass transport equations. Only relevant if wind is a specified input using the BC command. Used for analysis purposes to isolate the effects of wind forcing on the modelled system, or to simulate an idealised fluid with no wind forcing. Not recommended to modify for general use.
Includes MSLP == 0 | {1}
Status: Optional
Model Construction: Section 5.16.3
BC block command that allows the user to specify whether a water level boundary condition (WL or OBC variants) input data already includes an inverse barometer offset.
Set to zero to have TUFLOW FV apply the inverse barometer correction to the boundary condition based on the local MSLP difference from the Reference MSLP.
Set to 1 (default) if the boundary condition input data already includes the inverse barometer correction. This is a BC block level command and can be set independently for each water level boundary condition.
Initial Condition 2D == <initial_condition_2d_file_path>
Status: Optional
Model Construction: Section 7.10.4.1, Section 8.7.4.1, Section 9.4.4.1
Used to specify spatially varying depth averaged initial water level, velocity and scalar fields. Can be used to apply initial conditions to all 2D model cells or a subset.
For example file format and syntax examples refer to the linked model construction sections.
This file will override previously defined initial conditions for the 2D cells selected by the initial condition file.
Initial Condition 3D == <initial_condition_3d_file_path>
Status: Optional
Model Construction: Section 6.8.3, Section 7.10.4.2, Section 8.7.4.2, Section 9.4.4.2
Used to specify spatially varying initial water level, 3D velocity and 3D scalar fields. Can be used to apply initial conditions to all 3D model cells or a subset.
For example file format and syntax examples refer to the linked model construction sections.
This file overrides previously defined initial conditions for the 3D cells selected by the initial condition file.
Typically it’s more common to generate 3D initial conditions from a restart file and warmup simulation period. This reduces the likelihood of spurious model behaviour due to imbalances in the initial conditions. However, this command can be used to apply 3D initial conditions directly if desired.
Initial Condition OGCM
Status: Optional
Model Construction: Section 7.10.5
Required Dependent Command(s): BC, Boundary Gridmap, Grid Definition File
Uses OBC_GRID boundary data to assign initial water level, velocity, salinity and temperature fields.
Commonly used with ocean model inputs such as HYCOM to initialise water level, currents, salinity and temperature. Typically the initial water level is not an absolute elevation but a mean sea level anomaly that is added to a pre-existing astronomical tidal boundary condition.
Initial Condition Quiescent
Status: Optional
Model Construction: Section 7.10.5
Related Command(s): Initial Condition OGCM
Sets the initial u and v velocity fields to zero when used in combination with the Initial Condition OGCM command.
Used with Initial Condition OGCM to start from quiescent velocity while still reading water level and constituent fields from the OGCM source. Can be used to reduce the likihood of shocks being introduced into the model at startup due to imbalances between the initial water level and velocity fields.
Initial Salinity == <salinity>
Status: Optional
Model Construction: Section 7.10.3.1
Sets a spatially constant initial salinity across the model domain.
salinity
Default: 0.0
Units: psu
Initial Scalar Profile == <initial_scalar_profile_file_path>
Status: Optional
Model Construction: Section 7.10.3.2
Used to assign spatially constant but depth varying 3D initial condition profiles.
Example file format and syntax can be found in the linked model construction sections.
Initial Sediment Concentration == <sed_1, sed_2, …, sed_n>
Status: Optional
Model Construction: Section 8.7.3.1
Related Command(s): Include Sediment, Sediment Control File
Sets a spatially constant suspended sediment concentration for each simulated sediment fraction. This value is also constant for all water depths.
sed_<n>
Default: 0.0
Units: g/m\(^3\)
Suspended sediment concentration for simulated sediment fraction <n>.
Initial Temperature == <temperature>
Status: Optional
Model Construction: Section 7.10.3.1
Sets a spatially constant initial water temperature for all water depths.
temperature
Default: 0.0
Units: degrees Celsius
Initial Tracer Concentration == <tracer_1, tracer_2, …, tracer_n>
Status: Optional
Model Construction: Section 7.10.3.1
Related Command(s): NTracer
Sets a spatially constant tracer concentration for each simulated tracer. This value is also constant for all water depths.
tracer_<n>
Default: 0.0
Tracer concentration for simulated tracer <n>.
Initial Water Level == <water_level>
Status: Optional
Model Construction: Section 5.15.3
Sets the initial, quiescent water level to a global user specified value.
water_level
Initial WQ Concentration == <wq_1, wq_2, …, wq_n>
Status: Optional
Model Construction: Section 9.4.3.1
Sets spatially constant initial concentrations for each simulated water quality constituent.
The number of required arguments depends on the number of water quality constituents being simulated. Refer to linked model construction sections for further information.
The alias Initial Water Quality Concentration is also supported.
wq_<n>
Default: 0.0
Initial concentration for simulated water quality constituent <n>.
Internal Wave Mixing Model == {OFF} | ON
Status: Optional
Model Construction: Section 6.5.7.3
Required Dependent Command(s): Vertical Mixing Model
Related Command(s): Internal Wave Mixing Model Parameters
Selects the internal wave mixing formulation used to represent mixing below the thermocline or halocline.
Optionally extends the K-Epsilon and K-Omega Vertical Mixing Model.
Internal Wave Mixing Model Parameters == <klimiw>, <Ricr>, <nu_tshear>, <nu_tR>, <nu_hR>
Status: Optional
Model Construction: Section 6.5.7.3
Required Dependent Command(s): Internal Wave Mixing Model
Sets the input parameters for the Internal Wave Mixing Model.
Use this command to define the coefficients for the selected internal wave mixing formulation. Parameter meaning depends on the internal wave mixing model in use.
klimiw
Ricr
nu_tshear
nu_tR
nu_hR
| Parameter | Default | Description | Units | Science |
|---|---|---|---|---|
| klimiw | 1.0e-6 | The threshold below which turbulance extinction will occur if the turbulent kinetic energy drops below this value. | m\(^2\)/s\(^2\) | Section B.10.1.6 |
| Ricr | 0.7 | Critical Richardson number. | NA | Section B.10.1.6 |
| nu_tshear | 5.0e-3 | Viscosity due to shear instability. | m\(^2\)/s | Section B.10.1.6 |
| nu_tR | 1.0e-4 | Viscosity due to internal waves. | m\(^2\)/s | Section B.10.1.6 |
| nu_hR | 5.0e-5 | Diffusivity of heat due to internal waves. | m\(^2\)/s | Section B.10.1.6 |
Kinematic Viscosity == <V_nu_water>
Status: Optional
Specifies the background water kinematic viscosity.
This value is used as a lower limit in the parametric vertical eddy viscosity and is also used in various formulae within the Sediment Transport and Particle Tracking Modules.
V_nu_water
Default: 1.05e-6
Units: m\(^2\)/s
Latent Heat Model == {1} | 2
Status: Optional
Model Construction: Section 7.7.5
Required Dependent Command(s): Include Heat
Related Command(s): Bulk Latent Heat Coefficient, Vapour Pressure Salinity Parameters, Atmospheric Stability Model, Wind Stress Model
Selects the vapour pressure and specific humidity model.
{1}uses the Magnus-Tetens formulation and requires air temperature and relative humidity inputs.2uses modified Lowe and Reed equations and requires air temperature and cloud cover inputs.
The TUFLOW FV Get Atmos tool can be used to generate the required meteorological input files for Latent Heat Model == {1}.
Latitude == <latitude>
Status: Conditional - Required if Spherical == 0
Model Construction: Section 5.3
Required Dependent Command(s): Spherical
Related Command(s): Units, SHP Projection, MI Projection
Sets the latitude for Coriolis calculations when a cartesian coordinate system is used.
Negative values for the southern hemisphere and positive values for the northern hemisphere. Not required if using a spherical coordinate system Spherical == {1}, as the latitude is inferred from the spatial location of each cell.
If spatially varying Coriolis forcing is required it is recommended to use the spherical (metric units) coordinate reference frame.
latitude
Default: 0.0
Units: degrees
Layer Face File == <layer_face_file_path>
Status: Conditional - Required for the 3D simulation class
Model Construction: Section 6.6
Required Dependent Command(s): Vertical Mesh Type
Related Command(s): Surface Sigma Layers
Specifies the CSV file containing the vertical face distribution used by the selected vertical mesh type.
The file format is a function of the selected Vertical Mesh Type. Refer to the linked model construction sections for example file formats and syntax.
Log Dir == <log_directory_path>
Status: Optional
Model Construction: Section 5.18.2.2
Sets the model log directory.
This command specifies the directory for TUFLOW FV simulation log file (.log) output. A log file is automatically generated for each simulation, the contents of which are the same as that displayed in the simulation window. The log filename has the same prefix as the simulation control file.
If not specified, the log file is written either beside the simulation control file or to the runs\log sub-directory if that folder exists.
CFL diagnostic files, geometry diagnostics and restart files are also written to the specified log directory.
Longwave Radiation Albedo == <lw_albedo>
Status: Optional
Model Construction: Section 7.7.4
Sets the local longwave radiation albedo (reflectivity).
lw_albedo
Default: 0.03
Units: Dimensionless
Longwave Radiation Model == 1 | {2} | 3 | 4 | 5
Status: Optional
Model Construction: Section 7.7.4
Required Dependent Command(s): Include Heat
Related Command(s): Shortwave Radiation Model, Latent Heat Model
Selects the longwave radiation heat transfer implementation:
1Net. Uses net downward longwave radiation and accounts for incident and emitted longwave radiation at the water surface. Requires net downward longwave radiation.{2}Incident Direct. Uses specified incident longwave radiation with albedo reflection and emitted longwave radiation from the water surface based on the Stefan-Boltzmann law. Requires incident downward longwave radiation.3Incident TVA. Calculates incident longwave radiation from air temperature and cloud cover using the TVA (1972) approach. Requires cloud cover and air temperature.4Incident Zillman. Calculates incident longwave radiation using a latitudinal cloud correction and computes emitted longwave radiation using the air water temperature difference following Zillman (1972). Requires cloud cover and air temperature.5Incident Chapra. Calculates incident longwave radiation from air temperature and vapour pressure following Chapra (2008). Requires air temperature and relative humidity.
Material == <material_id_1, material_id_2, …, material_id_n>
Status: Required
Model Construction: Section 5.14, Section 6.7, Section 7.9
Required Dependent Command(s): End Material
Related Command(s): Bottom Roughness, Horizontal Eddy Viscosity, Horizontal Scalar Diffusivity, Horizontal Eddy Viscosity Limits, Horizontal Scalar Diffusivity Limits, Vertical Eddy Viscosity Limits, Vertical Scalar Diffusivity Limits, Bed Elevation Limits, Spatial Reconstruction, Shortwave Radiation Extinction Coefficients
Instantiates a material block for a given material ID.
Defines a Material block used to assign local properties to one or more material IDs. See the model construction section links for example syntax and file formats for the commands that can be used within a Material block.
Max Open Width == <maximum_open_width>
Status: Conditional - Required for some structures using the Linked Zones connection type when the maximum effective flow width cannot be inferred from other structure inputs
Model Construction: Section 5.17.2.3
Required Dependent Command(s): Structure
Related Command(s): Zone Inlet/Outlet Orientation
Used for structures with the Linked Zones connection type when flux limiting requires a maximum effective flow width. Not required for culverts where width is calculated from structure geometry or defined by other structure specific inputs.
Not required for culverts.
maximum_open_width
Max Opening Increment == <maximum_opening_increment>
Status: Optional
Model Construction: Section 5.17.11.4
Required Dependent Command(s): Structure
Related Command(s): Control
Scale factor that multiplies the control value change over a control update timestep. Reduces the maximum change in control value over a control update timestep to improve numerical stability when simulating rapidly changing structure operations.
Not used for the trigger control type.
maximum_opening_increment
Default: No default
Must be a number between 0.01 and 1.0.
MI Projection == <projection_file_or_coordsys>
Status: Conditional - Required if reading Mapinfo .mif file layers or if using GIS Format == MIF
Model Construction: Section 5.3
Required Dependent Command(s): GIS Format
Related Command(s): SHP Projection, Spherical, Units
Defines a Mapinfo Interchange Format (MIF) projection string or .mif file that sets the geographical coordinate system for all input and output Mapinfo .mif GIS layers.
Sets the geographic projection for all GIS input and output in MID/MIF format. If this command is omitted, TUFLOW FV searches for a file “Header.mif” in each folder it opens GIS files and extracts the projection from this file. The “Header.mif” file can be any GIS layer in the correct projection exported in MID/MIF format. If no “Header.mif” file is found, non-earth coordinates are assumed.
Alternatively, a projection line extracted from a .mif file may be entered, although specifying a .mif file is the recommended approach.
Example:
MI Projection == ..\model\mi\Model_Projection.mif
MI Projection == CoordSys Earth Projection 8, 13, "m", 153, 0, 0.9996, 500000, 10000000 Bounds (-7745874.38492, 1999.40969607) (8745874.38492, 19998000.5903)All MID/MIF GIS layers read by TUFLOW FV must use this projection.
Minimum Bottom Layer Thickness == <min_bottom_layer_thickness>
Status: Optional
Model Construction: Section 6.6.2
Related Command(s): Vertical Mesh Type
Sets a minimum allowable bottom layer thickness to improve numerical robustness in shallow bottom cells. Not applicable to the sigma vertical mesh type.
During model preprocessing, if the thickness of the bottom 3D layer is less than the specified value, the bottom layer is merged with the layer above it to create a thicker bottom layer.
The alias Min Bottom Layer Thickness is also supported.
min_bottom_layer_thickness
Default: 1.e-6
Units: meters (m)
Mode Split == 0 | {1}
Status: Optional
Related Command(s): CFL, Timestep Limits
Controls whether the mode splitting approach is enabled for 2D simulations. Not applicable for 3D simulations.
Can be disabled (0) to improve runtime efficiencies for 2D simulations where the internal and external timestep are similarly restrictive.
Model Events == <event_name_1> | <event_name_2> | … | <event_name_9>
Status: Optional
Model Construction: Section 11.3.3
Required Dependent Command(s): Define Event
Related Command(s): Event File, BC Event Source
Used to set the default event(s).
In practice these defaults are typically overridden at runtime using the -e1, -e2, …, -e9 command line argument to specify which events are active for a given simulation run.
Up to nine events can be specified for a given simulation.
Model events are separated using the | character.
Model Scenarios == <scenario_name_1> | <scenario_name_2> | … | <scenario_name_n>
Status: Optional
Model Construction: Section 11.3.4
Related Command(s): If Scenario, Set Variable <VARIABLE_NAME>
Used to set the default scenario(s).
In practice these defaults are typically overridden at runtime using the -s1, -s2, …, -s9 command line argument to specify which scenarios are active for a given simulation run.
Up to nine scenarios can be specified for a given simulation.
Model scenarios are separated using the | character.
Momentum Mixing Model == {None} | Constant | Smagorinsky | Wu
Status: Required - An alternative to the default None model should be specified for general use
Model Construction: Section 5.10
Required Dependent Command(s): Global Horizontal Eddy Viscosity
Related Command(s): Global Horizontal Eddy Viscosity Limits
Selects the horizontal eddy viscosity mixing model.
- {None}: No supporting commands are required (default)
- Constant: Uses a user specified constant horizontal eddy viscosity
- Smagorinsky: Uses the Smagorinsky horizontal eddy viscosity model
- Wu: Uses the Wu horizontal eddy viscosity model
The Global Horizontal Eddy Viscosity command is used in combination with this command to specify the constant horizontal eddy viscosity value or coefficient.
Name == <structure_name>
Status: Optional
Model Construction: Section 5.17.2.3
Required Dependent Command(s): Structure
Structure block command that assigns a name to the structure for identification in CSV outputs and log files.
If not specified, the structure will be assigned a default name based on the structure type and an incremental number, for example Structure_1, Structure_2, etc.
NLSWE Limit == 0 | {1}
Status: Conditional - Required when modelling a pump with Flux Function == Timeseries
Model Construction: Section 5.17.6.1.1
Required Dependent Command(s): Structure
Disables structure flux limit checks.
Set to 0 to disable the non linear shallow water equation flux limiter.
Nodestring Polyline File
Status: Legacy
Related Command(s): Read GIS Nodestring
NTracer == <tracer_count>
Status: Required
Model Construction: Section 7.4
Related Command(s): Tracer, Decay Rate, Settling Velocity, Water Age, Evapo-Concentrate
Specifies the number of tracers to be simulated.
tracer_count
Default: 0
Up to 100 tracers can be specified.
Output == <output_type>
Status: Required
Model Construction: Section 5.18.2.3, Section 6.11.2.2, Section 7.13.2.1, Section 8.10.2.1, Section 9.7.2.2
Required Dependent Command(s): End Output
Related Command(s): Output Interval, Output Parameters, Output Statistics, Output Statistics dt, Output Dir, End Output
Defines the beginning of the output block and the result output format. Each output block configures one result output type or file format and is closed using End Output.
Available output_type options include:
NetCDF,XMDF,DatvMesh output formats for spatial results written across the full model mesh.PointsCSV timeseries at defined point locations.ProfileCSV timeseries through the water column at defined profile locations.FluxCSV timeseries of net flow across nodestrings or monitoring polylines.StructfluxCSV timeseries of flow through hydraulic structures.MassbalanceCSV balance diagnostics for simulated quantities.MassCSV output of global water volume, mass and related diagnostics.TransportHydrodynamic transport forcing output for reuse in other simulations.
Example syntax and file formats for the various output types can be found in the linked model construction sections.
Output CFL Stats == 0 | {1}
Status: Optional
Model Construction: Section 5.18.11.3
Related Command(s): Log Dir
Controls whether internal and external CFL diagnostic CSV files are written to the log directory.
Set to 0 to disable output of internal and external CFL diagnostic CSV files to the log directory. These files contain the CFL number for each computational cell at each model timestep and can be used to identify where and when CFL conditions are most restrictive in the model. The internal CFL diagnostic file is named “CFL_internal.csv” and the external CFL diagnostic file is named “CFL_external.csv”.
Output Compression == 0 | {1}
Status: Optional
Model Construction: Section 5.18.2.3
Required Dependent Command(s): Output
Output block command to enable or disable file compression for NetCDF output format used for mesh, transport and profile output implementations.
Reduces NetCDF file size by typically 20-30% when enabled. This does affect run times and can result in a performance penalty of between 5-10% depending on the specific application and computing resources. If runtime performance is critical, it is recommended to experiment with this setting. Compression is not available for XMDF or Datv output formats.
Output Dir == <output_directory_path>
Status: Required - The default (.fvc directory) should be overridden for general use
Model Construction: Section 5.18.2.2
Defines the directory where model results are saved.
By default model output is written to the same location as the simulation control file (.fvc) however this is typically not desired and it is recommended to specify an output directory using this command.
Output Folder is an alias for this command and is also supported.
Output Interval == <output_interval>
Status: Required - The default (0.0) should be overridden for general use
Model Construction: Section 5.18.2.3
Required Dependent Command(s): BC
BC block command that defines the simulation time interval at which results are saved. If not specified, results are output at the model computational timestep.
By default, results are output at the model computational timestep which for many applications will not be desired and will lead to extremely large output files. It is typically more appropriate to specify an output interval of 10min (600s) or 30min (1800s) for hydrodynamic outputs, although the optimal output interval will depend on the specific application and the desired temporal resolution of results.
If the model result output interval is less than the model timestep an error will be reported and the model execution ceased.
output_interval
Default: 0.0
Units: seconds (s)
Output Parameters == <parameter_1, parameter_2, …, parameter_n>
Status: Conditional - Required for points, profiles and mesh model output implementations
Model Construction: Section 5.18.2.3.1, Section 6.11.2.2.1, Section 7.13.2.1.1, Section 8.10.2.1.1, Section 9.7.2.2.1, Section 10.6.2.2.1
Required Dependent Command(s): Output
Related Command(s): Output Interval
BC command that selects the model output parameters to be included in the output files.
A wide range of output parameters are available for selection. For example: water level, velocity, vertical velocity, salinity, temperature, sediment concentration, tracer concentration, water quality constituent concentration, etc. Refer to the linked model construction sections for tabulated output parameter options with descriptions and units.
The default for <parameter_1> is H.
Output Points File
Status: Legacy
Related Command(s): Read GIS PO
Output Statistics == min | max | min, max
Status: Optional
Model Construction: Section 5.18.3.1
Required Dependent Command(s): BC, Output Statistics dt
Output block command to track minimum or maximum map output parameters on a user specified Output Statistics dt.
This feature is available with Datv, XMDF and NetCDF output types.
Either min, max or both min and max can be specified via a comma separated list.
Will track all output parameters specified by the Output Parameters command for the specified output block.
Output Statistics dt == <update_interval>
Status: Optional
Model Construction: Section 5.18.3.1
Required Dependent Command(s): BC, Output Statistics
Sets the interval to track map output statistics.
update_interval
Default: 0.0
Units: seconds (s)
The default of 0.0 uses the model computational timestep.
Particle Tracking Control File == <particle_tracking_control_file_path>
Status: Conditional - Required if using the particle tracking simulation class
Model Construction: Section 10.2
Specifies the particle tracking control file used to configure the particle tracking simulation.
Pause == <pause_message>
Status: Optional
Model Construction: Section 11.3.3, Section 11.3.4
Required Dependent Command(s): If Scenario, If Event
Related Command(s): Else If Scenario, Else If Event, Else
Scenario or event block command that causes the model to pause with a user specified message.
The Pause command is typically used as a catch point if an unexpected scenario or event is specified during a simulation.
Polygon File == <polygon_file_path>
Status: Legacy
Related Command(s): Read GIS Zone
Properties
Status: Conditional - Required for hydraulic structure implementations and some destratification unit implementations to define the applicable properties for the selected implementation.
Navigation row for this command. Argument syntax depends on the selected implementation. Use the applicable implementation entry below:
- Weir. Required when Flux Function == Weir.
- Weir_dz. Required when Flux Function == Weir_dz.
- Porous. Required when Flux Function == Porous.
- Bubbler. Required when Destratification Unit == Bubbler.
- Compressor. Required when Destratification Unit == Compressor.
Properties == <Z>, <F>, <N>, <alpha>, <b1>, <Lr>, <Gamma>
Status: Conditional - Required if Destratification Unit == Bubbler
Model Construction: Section 7.12.3.1
Required Dependent Command(s): Destratification Unit
Structure block command that sets the properties for the bubble plume, bubbler destratification unit option. The parameter definitions are listed in the table below.
Use this implementation for bubbler destratification units. For a full description of the arguments refer to linked model construction sections below and hydraulics structure science documentation.
Z
F
N
alpha
b1
Lr
Gamma
| Parameter | Default | Description | Units |
|---|---|---|---|
| Z | No default | Pipe Elevation | mRL |
| F | No default | Airflow at diffuser head | m\(^3\)/s/plume |
| N | No default | Number of plumes | |
| alpha | No default | Calculation coefficient (recommended 0.0833) | |
| b1 | No default | Calculation coefficient (recommended 4.7) | |
| Lr | No default | Calculation coefficient (recommended 0.1) | |
| Gamma | No default | Detrainment coefficient (recommended 0.95) |
Properties == <Z>, <F>, <N>, <alpha>, <b1>, <Lr>, <Gamma>
Status: Conditional - Required if Destratification Unit == Compressor
Model Construction: Section 7.12.3.2
Required Dependent Command(s): Structure, Destratification Unit
Structure block command that sets the properties for the bubble plume, compressor destratification unit option. The parameter definitions are listed in the table below.
Use this implementation for compressor destratification units. For a full description of the arguments refer to linked model construction sections below and hydraulics structure science documentation.
Z
F
N
alpha
b1
Lr
Gamma
| Parameter | Default | Description | Units |
|---|---|---|---|
| Z | No default | Pipe Elevation | mRL |
| F | No default | Airflow at atmospheric pressure | m\(^3\)/s/plume |
| N | No default | Number of plumes | |
| alpha | No default | Calculation coefficient (recommended 0.0833) | |
| b1 | No default | Calculation coefficient (recommended 4.7) | |
| Lr | No default | Calculation coefficient (recommended 0.1) | |
| Gamma | No default | Detrainment coefficient (recommended 0.95) |
Properties == <K>, <flowpath_length>, <B_user>
Status: Conditional - Required if Flux Function == Porous
Model Construction: Section 5.17.7.1
Required Dependent Command(s): Structure, Flux Function
Related Command(s): Properties, Flux Function
Structure block command that sets the hydraulic properties for the porous structure. The parameter definitions are listed in the table below.
Use this implementation to define porous structure resistance and effective flowpath geometry. The structure width override is not supported for single nodestring structure connection types.
K
flowpath_length
B_user
| Parameter | Default | Description | Units |
|---|---|---|---|
| K | No default | Hydraulic conductivity | m/s |
| flowpath_length | No default | Effective flowpath length through the porous structure | m |
| B_user | Nodestring width or Max Open Width | User defined structure cross sectional width | m |
Properties == <H>, <C>, <Ex>, <a>, <b>, <Csf_min>, <B_user>
Status: Conditional - Required if Flux Function == Weir
Model Construction: Section 5.17.3.1
Required Dependent Command(s): Structure, Flux Function
Structure block command that sets the hydraulic properties for the weir structure. The parameter definitions listed in the table below.
This implementation uses an absolute crest elevation for the weir. For full description of the weir implementation and arguments refer to linked model construction sections below and hydraulics structure science documentation.
The optional user defined weir width B_user argument can be used to override the default width calculated from the structure geometry. This can be useful for representing flow through a partially open gate, for example. It is not available if using the single nodestring structure connection type is used Structure == Nodestring, nodestring_id. The default B_user is the average nodestring length if using Linked Nodestrings or Max Open Width if using the Linked Zones connection type.
H
C
Ex
a
b
Csf_min
B_user
Properties == <dz>, <C>, <Ex>, <a>, <b>, <Csf_min>
Status: Conditional - Required if Flux Function == Weir_dz
Model Construction: Section 5.17.3.2
Required Dependent Command(s): Structure, Flux Function
Related Command(s): Flux Function
Structure block command that sets the hydraulic properties for the weir structure. The parameter definitions are listed in the table below.
This implementation uses a crest elevation offset above the existing bed elevation. For a full description of the arguments, refer to the linked model construction sections below and the hydraulic structure science documentation.
The user defined width override is not available for this weir implementation.
dz
C
Ex
a
b
Csf_min
Read File == <read_file_path>
Status: Optional
Related Command(s): Include
Alias for Include.
Read GIS Mat == <gis_materials_file_path>
Status: Optional
Model Construction: Section 5.14.4
Related Command(s): GIS Format, Set Mat, Material, Write Check Files
Spatially vary cell materials using a GIS layer of polygons.
Reads a 2d_mat polygon layer in shp or mif format and assigns material IDs to cells within each polygon. Multiple Read GIS Mat commands can be used. If polygons overlap the material ID from the last layer read is applied in the overlap area.
Attribute(s):
- Material: The material ID to be assigned to cells within the polygon.
Read GIS Nodestring == <gis_nodestring_file_path>
Status: Conditional - Required for nodestring boundary condition types, nodestring and linked nodestring hydraulic structure types and for user-specified flux output reporting
Model Construction: Section 5.17.2.2.1
Related Command(s): GIS Format, Write Check Files, BC, Structure, Output
Defines the location of model nodestrings.
Reads a 2d_ns polyline layer in shp or mif format and defines model nodestring locations. Line direction is important for sign convention and for some connection types. Multiple Read GIS Nodestring commands can be used to read multiple layers.
Attribute(s):
- ID: The nodestring name or ID. This is used to link the nodestring to boundary conditions, structures and output reporting. This ID must be independent or an error will occur.
- Flags: Setting to BD will enforce the nodestring algorithm to follow the edge of the model mesh, treating the nodestring as an open boundary condition.
Nodestrings may overlap if being used for flux reporting. They may not overlap if being used as open boundary or hydraulic structure connections.
Read GIS PO == <gis_plot_output_layer_file_path>
Status: Conditional - Required for points model output
Model Construction: Section 5.18.4, Section 6.11.4
Required Dependent Command(s): Output
Related Command(s): GIS Format, Write Check Files
Output block command to define the GIS layer containing the output point locations for points model output.
Reads a 3d_po point layer in shp or mif format and defines the locations used by points output. The layer includes point naming attributes and optional vertical averaging overrides for 3D applications.
Attribute(s):
- Type: Reserved for future use (Not used)
- Label: Name of the point
- Comment: Optional comment for the point
- Vert_min: 3D Vertical averaging override. Not applicable to the 2D HD simulation class.
- Vert_max: 3D Vertical averaging override. Not applicable to the 2D HD simulation class.
Read GIS SA == <gis_sa_file_path>
Status: Conditional - Required for point, profile or polygon boundary conditions
Model Construction: Section 5.16.2.2.2, Section 5.16.2.2.3
Related Command(s): GIS Format, Write Check Files, BC
Required to define the location of boundary cells. Point geometry is required for single cell boundary types, polygon geometry for polygon (_POLY) boundary types.
Reads a 2d_sa layer in shp or mif format and defines boundary condition locations. Use point geometry for single cell boundary types and polygon geometry for polygon boundary types.
Attribute(s):
- Name: The name or ID of the boundary condition. This is used to link the GIS features to boundary conditions defined in the model.
Read GIS Z Line == <gis_zline_file_path>
Status: Optional
Model Construction: Section 5.13.3.5
Related Command(s): GIS Format, Write Check Files, Cell Elevation File, Read GRID Zpts, Read TIN Zpts, Set Zpts, Snap Tolerance
Reads GIS files containing polylines and points that are treated as breaklines in the model’s bathymetry.
Reads a 2d_zln line and point layer in shp or mif format and updates bathymetry as a 3D breakline(s). A single polyline layer is required followed by one or more point layers. These are associated using the | syntax. If points are snapped to the polyline vertices the breakline can vary in height along its length and elevations are interpolated between snapped points. If no points are snapped to the line the breakline is treated as horizontal using the line Elevation value. Up to nine point layers can be specified on one command line.
Attribute(s):
- Elevation: The polyline or point elevation (mRL or ftRL).
Read GIS Zone == <gis_zone_file_path>
Status: Conditional - Required for Zone and Linked Zone hydraulic structure connections
Model Construction: Section 5.17.2.2.3, Section 5.17.2.2.4
Required Dependent Command(s): Structure
Related Command(s): GIS Format, Write Check Files, Structure, Read GIS Nodestring
Reads zone polygons used to define linked zone and zone hydraulic structure connections.
Reads a 2d_zn polygon layer in shp or mif format and defines the spatial extents used by linked zone and zone hydraulic structure connections. Each polygon is identified by name and linked to the relevant structure connection definition. For linked zones use separate upstream and downstream polygons. For zone connections use a single polygon.
Attribute(s):
- Name: The zone name or ID used to link the polygon to the hydraulic structure definition.
Read GRID Zpts == <dem_file_path>
Status: Optional
Model Construction: Section 5.13.3.3
Related Command(s): Cell Elevation File, Read GIS Z Line, Read TIN Zpts, Set Zpts
Updates cell centre elevations via a Digital Elevation Model (DEM) file.
Supports ESRI ArcGrid (.asc) or binary float (.flt) formats.
Read TIN Zpts == <tin_file_path>
Status: Optional
Model Construction: Section 5.13.3.4
Related Command(s): Cell Elevation File, Read GIS Z Line, Read GRID Zpts, Set Zpts
Updates selected cell centre elevations via a Triangulated Irregular Network (TIN) file.
Supports Aquaveo SMS TIN (.tin) format.
Reference Density == <rho_water>
Status: Optional
Sets the reference water density used in baroclinic pressure calculations.
rho_water
Default: 1000.0
Units: kg/m\(^3\)
Should not be changed from the default value for typical applications. For baroclinic simulations, where density may vary locally based on salinity, temperature or suspended sediment concentration, this value is used as the baseline from which density gradients are calculated. Numerical accuracy of baroclinic simulations can be marginally improved by setting this value close to a typical value expected in the model, for example 1027 kg/m\(^3\) for ocean simulations. For non-baroclinic simulations this command will globally set the density used in various source term and sediment transport formulae.
Reference MSLP == <ref_mslp>
Status: Optional
Related Command(s): Includes MSLP
Sets the reference mean sea level pressure value.
ref_mslp
Default: 1013.25
Units: hPa
This value is used in the atmosphere module when a mean sea level pressure boundary condition has not been explicitly specified. The global MSLP value is used in various atmosphere module heat exchange routines. Used for inverse barometer correction with Includes MSLP.
Reference Salinity == <ref_salinity>
Status: Optional
Sets the model reference salinity for baroclinic simulations.
ref_salinity
Default: 0.0
Units: psu
Numerical accuracy of baroclinic terms in NLSWE can be marginally improved by setting this value close to a typical value expected in the model, for example 35.0 psu for ocean simulations. For non-baroclinic simulations this command will globally set the salinity. It may also be used to globally initialise salinity in the absence of other relevant initial conditions.
Reference Temperature == <ref_temperature>
Status: Optional
Sets the model reference temperature for baroclinic simulations.
ref_temperature
Default: 20.0
Units: Degrees Celsius
Numerical accuracy of baroclinic terms can be marginally improved by setting this value close to a typical value expected in the model. For non-baroclinic simulations this command will globally set the temperature. It may also be used to globally initialise temperature in the absence of other relevant initial conditions.
Reference Time == <reference_time>
Status: Optional
Model Construction: Section 5.6
Related Command(s): Time Format, BC Reference Time
Sets the simulation reference time used for time based inputs and outputs. This is the time datum used for all time based inputs and outputs including boundary condition time series, structure operation time series and output timestamps.
Sets the time datum used for time based inputs and outputs. When Time Format is HOURS the default reference time is 0. When Time Format is ISODATE the default reference time is 01/01/1990 00:00:00.
Response Parameters == <tr_pos>, <tr_neg>
Status: Optional
Model Construction: Section 5.17.11.5.3, Section 5.17.11.5.6
Required Dependent Command(s): Control, Sample Parameter
Related Command(s): Control Header, Control File, Control Parameter
Adjusts the response rate of the control structure as a function of positively or negatively trending sample parameter value.
For use with the Timeseries or Sample_Rule control types. Typically used in conjunction with the Control Parameter == Bathy_Control and Bed Adjust == Bathy_Database.
tr_pos
tr_neg
| Parameter | Default | Description | Units |
|---|---|---|---|
| tr_pos | 0.001 | Response rate for positive trending parameter values. | hours |
| tr_neg | 0.001 | Response rate for negative trending parameter values. | hours |
Restart File == <restart_file_path>
Status: Optional
Model Construction: Section 5.15.5, Section 7.10.6, Section 8.7.5, Section 9.4.5
Related Command(s): Use Restart File Time, Write Restart dt
Used to initialise salinity, temperature, suspended sediment, tracer and wq constituent fields from a prior simulation.
Unless Use Restart File Time is specified, the simulation start time is set from the timestamp stored in the restart file.
Restart is also supported as an alias.
Restart Overwrite == 0 | {1}
Status: Optional
Model Construction: Section 5.18.10
Required Dependent Command(s): Write Restart dt
Related Command(s): Restart File, Write Restart dt, Use Restart File Time
Controls whether each new restart write overwrites the previous restart file or creates a separate file.
Set to 1 (default) to overwrite the same restart file at each write interval. Set to 0 to write a new restart file at each restart output time.
Sample dt == <sample_interval>
Status: Conditional - Required for trigger, sample, sample_rule and target_rule control types
Model Construction: Section 5.17.11.4
Required Dependent Command(s): Control
Related Command(s): Sample Point, Sample Nodestring, Sample Parameter
Control block command that sets the frequency in hours for sampling the sample parameter from the model.
Used for the trigger, sample, sample_rule and target_rule control types.
sample_interval
Default: No default
Units: hours
Sample Nodestring == <nodestring_name>
Status: Conditional - Optionally used for trigger, sample, sample_rule and target_rule control types. If not used Sample Point is required
Model Construction: Section 5.17.11.4
Required Dependent Command(s): Control, Sample Parameter
Related Command(s): Sample Point, Sample dt
Control block command that defines the nodestring location used to sample the Sample Parameter.
Sample Parameter == <parameter_name>
Status: Conditional - Required for trigger, sample, sample_rule and target_rule control types
Model Construction: Section 5.17.11.4
Required Dependent Command(s): Control
Related Command(s): Sample Point, Sample Nodestring, Sample dt
Defines the model parameter sampled for structure control.
Used with trigger, sample, sample_rule and target_rule control types.
Supported Sample Parameters are as follows:
- Sample Nodestring: FLOW
- Sample Point: WL, V, SAL, TEMP, SED_1, …, SED_N, TR_1, …, TR_N, WQ_1, …, WQ_N, DOSAT
Sample Point == <point_x>, <point_y>
Status: Conditional - Optionally used for trigger, sample, sample_rule and target_rule control types. If not used Sample Nodestring is required
Model Construction: Section 5.17.11.4
Required Dependent Command(s): Control, Sample Parameter
Related Command(s): Sample Nodestring, Sample dt
Control block command that defines the point location used to sample the Sample Parameter.
This feature does not have GIS integration and requires manual entry of point coordinates.
point_x
point_y
Scalar Mixing Model == {None} | Constant | Smagorinsky | Elder | Warmup
Status: Required - Required for AD simulation class
Model Construction: Section 7.5
Required Dependent Command(s): Global Horizontal Scalar Diffusivity
Related Command(s): Global Horizontal Scalar Diffusivity Limits, Horizontal Scalar Diffusivity
Selects the horizontal scalar mixing model implementation.
Related commands depend on the selected scalar mixing implementation. If Scalar Mixing Model == {None} or Scalar Mixing Model == Warmup is selected no supporting scalar diffusivity commands are required.
For Scalar Mixing Model == Constant, Scalar Mixing Model == Elder and Scalar Mixing Model == Smagorinsky refer to the Global Horizontal Scalar Diffusivity navigation row and the associated implementation entries.
Screen/Log Display Interval == <log_update_interval>
Status: Optional
Model Construction: Section 5.18.11.2
Related Command(s): Log Dir
The simulation time (model time) interval for displaying timestep information to the log file and terminal window.
Sets the interval for reporting timestep information to the screen and log output during a simulation.
Display dt is also supported as an alias.
log_update_interval
Default: 300.
Units: s
Second Order Vertical Mixing Model == {OFF} | Algebraic
Status: Optional
Model Construction: Section 6.5.7.1
Required Dependent Command(s): Vertical Mixing Model
Related Command(s): Second Order Vertical Mixing Model Parameter Group
Selects the second order vertical turbulence closure used for vertical momentum and scalar mixing.
See the vertical mixing model science documentation (Section B.10.1.4) for details on the available second order vertical mixing model options.
Second Order Vertical Mixing Model Parameter Group == GL78 | MY86 | KC94 | LDOR96 | CHCD01A | CHCD01B | CCH02
Status: Optional
Model Construction: Section 6.5.7.1
Required Dependent Command(s): Second Order Vertical Mixing Model
Selects the parameter group used by the second order vertical turbulence closure.
See the vertical mixing model science documentation (Section B.10.1.4) for details on the available second order vertical mixing model parameter group options. This command is only relevant if a Second Order Vertical Mixing Model is selected.
Sed Default == <sed_default_1, sed_default_2, …, sed_default_n>
Status: Optional
Model Construction: Section 8.8.2.4.1
Required Dependent Command(s): BC
Related Command(s): Sed Header, Sed Scale, Sed Offset
Sets fallback suspended sediment boundary values when specified suspended sediment headers are not found.
Sets fallback suspended sediment values to use when expected sediment headers are not found in the boundary input data file.
sed_default_<n>
Default: 0.0
Fallback suspended sendiment value for sediment <n>
Sed Header == <sediment_header_1, sediment_header_2, …, sediment_header_n>
Status: Conditional - Required for the sediment transport simulation class
Model Construction: Section 8.8.2.4.1
Required Dependent Command(s): BC
Related Command(s): Sed Default, Sed Scale, Sed Offset
Maps suspended sediment input headers in the boundary data file to simulated suspended sediment fields.
Maps suspended sediment fields in the boundary input file to the sediment classes used in the simulation. The number of headers should match the number of simulated sediment classes.
Sed Offset == <sediment_offset_1, sediment_offset_2, …, sediment_offset_n>
Status: Optional
Model Construction: Section 8.8.2.4.1
Required Dependent Command(s): BC
Related Command(s): Sed Header, Sed Scale, Sed Default
Applies additive offsets to suspended sediment boundary inputs.
Offsets are applied after BC Scale factors and to the scaled sediment boundary inputs.
sediment_offset_<n>
Default: 0.0
Additive offset for suspended sediment <n>.
Sed Scale == <sediment_scale_1, sediment_scale_2, …, sediment_scale_n>
Status: Optional
Model Construction: Section 8.8.2.4.1
Required Dependent Command(s): BC
Related Command(s): Sed Header, Sed Offset, Sed Default
Applies multiplicative scale factors to suspended sediment boundary inputs before any offsets are applied.
sediment_scale_<n>
Default: 1.0
Multiplicative scale factor for suspended sediment <n>.
Sediment Control File == <sediment_control_file_path>.fvsed
Status: Conditional - Required for the sediment transport simulation class
Model Construction: Section 8.3
Required Dependent Command(s): Include Sediment
Specifies the sediment control file used to configure the sediment simulation.
Specifies the sediment control file used to configure the sediment transport simulation.
The configuration of commands within the sediment control file is outside the scope of this manual. Please refer to the Sediment Transport and Particle Tracking User Manual for details on the available commands and configuration options.
Set Mat == <material_id>
Status: Optional
Model Construction: Section 5.14.3
Related Command(s): Material, Read GIS Mat
Sets all material in the domain to a single user specified value.
Sets all cells in the domain to the specified material ID. The value should correspond to a defined Material block or other supported material assignment workflow.
Typically used to set the default material type which is subsequently overridden by more spatially specific material assignment via the Read GIS Mat command.
The default <material_id> is 0.
Set Variable <VARIABLE_NAME> == <variable_value>
Status: Optional
Model Construction: Section 11.3.5
Related Command(s): BC Event Source, Model Events
Assigns a user specified value (variable_value) to a variable (VARIABLE_NAME) for dynamic substitution in other commands.
Defines a named variable that can be reused for dynamic substitution in other commands or included files. Refer to examples within the linked simulation management chapter for usage guidance.
Set Zpts == <elevation_value>
Status: Optional
Model Construction: Section 5.13.3.2
Related Command(s): Read GRID Zpts, Read TIN Zpts, Read GIS Z Line, Cell Elevation File
Sets all elevations in the domain to a user specified value.
Sets all cell elevations in the domain to the specified value. This is typically used for simple test models or as a base elevation before applying other bathymetry updates.
elevation_value
Settling Velocity == <settling_velocity>
Status: Conditional - Required for the settling tracer model implementation
Model Construction: Section 7.4.5
Required Dependent Command(s): NTracer, Tracer
Related Command(s): Decay Rate, Evapo-Concentrate, Water Age
Specifies settling velocity for tracers in the active tracer block.
settling_velocity
Default: 0.0
Units: m/s
Shortwave Radiation Albedo == <sw_albedo>
Status: Optional
Model Construction: Section 7.7.3
Related Command(s): Shortwave Radiation Model
Sets the local shortwave radiation albedo (reflectivity).
Sets the shortwave radiation albedo used to represent reflected incoming shortwave radiation at the water surface.
sw_albedo
Default: 0.08
Units: Dimensionless
Shortwave Radiation Bed Absorption == <sed_absorption_fraction>, <bottom_layer_absorption_fraction>
Status: Optional
Model Construction: Section 7.7.3
Related Command(s): Shortwave Radiation Model
Sets the proportion of shortwave radiation that is absorbed by the sediment and water column.
The default values specify that 45% of the shortwave radiation heat is absorbed into the sediment and 45% is radiated into the water column (this implies that 10% is reflected off the bed). This reflected shortwave radiation is absorbed in the water column as it reflects back towards the surface. Anything remaining will then leave the water column back into the atmosphere.
sed_absorption_fraction
bottom_layer_absorption_fraction
| Parameter | Default | Description |
|---|---|---|
| sed_absorption_fraction | 0.45 | Must be a value between 0.0 and 1.0. |
| bottom_layer_absorption_fraction | 0.45 | Must be a value between 0.0 and 1.0. |
Shortwave Radiation Extinction Coefficients == <nir_eta>, <par_eta>, <uva_eta>, <uvb_eta>
Status: Optional
Model Construction: Section 7.7.3
Related Command(s): Shortwave Radiation Fractions, Shortwave Radiation Model
Sets the extinction coefficient for each shortwave radiation fraction (PAR, UVA, UVB and NIR).
nir_eta
par_eta
uva_eta
uvb_eta
| Parameter | Default | Description | Units |
|---|---|---|---|
| nir_eta | 1.0 | Extinction coefficient of near-infrared (NIR) in short wave radiation. | 1/m |
| par_eta | 0.25 | Extinction coefficient of photosynthetically active radiation (PAR) in short wave radiation. | 1/m |
| uva_eta | 1.0 | Extinction coefficient of ultraviolet A (UVA) in short wave radiation. | 1/m |
| uvb_eta | 2.5 | Extinction coefficient of ultraviolet B (UVB) in short wave radiation. | 1/m |
Shortwave Radiation Fractions == <nir_fraction>, <par_fraction>, <uva_fraction>, <uvb_fraction>
Status: Optional
Model Construction: Section 7.7.3
Related Command(s): Shortwave Radiation Model
Sets the fraction of total incoming shortwave radiation into Near Infrared (NIR), Photosynthetically Active Radiation (PAR), Ultraviolet A (UVA) and Ultraviolet B (UVB) in that order.
Sets how total incoming shortwave radiation is partitioned into the NIR, PAR, UVA and UVB bands. The fractions should sum to 1.0.
nir_fraction
par_fraction
uva_fraction
uvb_fraction
| Parameter | Default | Description |
|---|---|---|
| nir_fraction | 0.43 | The fraction of total incoming shortwave radiation into Near Infrared (NIR). The value must be between 0.0 and 1.0. |
| par_fraction | 0.52 | The fraction of total incoming shortwave radiation into Photosynthetically Active Radiation (PAR). The value must be between 0.0 and 1.0. |
| uva_fraction | 0.048 | The fraction of total incoming shortwave radiation into Ultraviolet A (UVA). The value must be between 0.0 and 1.0. |
| uvb_fraction | 0.002 | The fraction of total incoming shortwave radiation into Ultraviolet B (UVB). The value must be between 0.0 and 1.0. |
Shortwave Radiation Model == {1} | 2
Status: Optional
Model Construction: Section 7.7.3
Required Dependent Command(s): Include Heat, Include Temperature
Related Command(s): Shortwave Radiation Extinction Coefficients, Shortwave Radiation Fractions, Shortwave Radiation Albedo, Shortwave Radiation Bed Absorption, Shortwave Radiation Sediment Extinction Coefficients
Selects the shortwave radiation implementation.
{1}(default): Incident short wave radiation estimated according to Jacquet (1983). Requires downward short wave radiation input. Positive is downwards.2: Incident short wave radiation under clear sky estimated according to Zillman (1972) with cloud cover correction factor given by Reed (1977). Requires air temperature, relative humidity (%) and optionally cloud cover inputs (fraction 0.0-1.0), where 0.0 is no cloud and 1.0 is full cloud. If cloud is not specified a clear sky with no cloud correction is assumed.
Shortwave Radiation Sediment Extinction Coefficients == <nir_coefficient>, <par_coefficient>, <uva_coefficient>, <uvb_coefficient>
Status: Optional
Model Construction: Section 8.5.3
Related Command(s): Shortwave Radiation Extinction Coefficients, Shortwave Radiation Model
Sets sediment dependent extinction modifiers for the NIR, PAR, UVA and UVB shortwave radiation bands, in that order
nir_coefficient
par_coefficient
uva_coefficient
uvb_coefficient
| Parameter | Default | Description |
|---|---|---|
| nir_coefficient | 0.0 | Sediment dependent extinction modifier for the Near Infrared (NIR) shortwave radiation band. |
| par_coefficient | 0.0 | Sediment dependent extinction modifier for the Photosynthetically Active Radiation (PAR) shortwave radiation band. |
| uva_coefficient | 0.0 | Sediment dependent extinction modifier for the Ultraviolet A (UVA) shortwave radiation band. |
| uvb_coefficient | 0.0 | Sediment dependent extinction modifier for the Ultraviolet B (UVB) shortwave radiation band. |
SHP Projection == <projection_file_or_prj>
Status: Conditional - Required if reading ESRI shape file layers or if GIS Format == SHP
Model Construction: Section 5.3
Required Dependent Command(s): GIS Format
Related Command(s): MI Projection
Defines an ESRI shapefile projection string or .shp file that sets the geographical coordinate system for all input and output ESRI .shp GIS layers.
Sets the shapefile projection used for input checking and output GIS layers in ESRI .shp format. If a model uses both .shp and .mif layers, specify both SHP Projection and MI Projection.
Example using a .prj file:
SHP Projection == ..\model\shp\Projection.prjExample using a PROJ string:
SHP Projection == PROJCS[“WGS_1984_UTM_Zone_60S”,GEOGCS[“GCS_WGS_1984”,DATUM[“D_WGS_1984”,SPHEROID[“WGS_1984”,6378137,298.257223563]],PRIMEM[“Greenwich”,0],UNIT[“Degree”,0.017453292519943295]],PROJECTION[“Transverse_Mercator”],PARAMETER[“latitude_of_origin”,0],PARAMETER[“central_meridian”,177],PARAMETER[“scale_factor”,0.9996],PARAMETER[“false_easting”,500000],PARAMETER[“false_northing”,10000000],UNIT[“Meter”,1]]
Snap Tolerance == <tolerance>
Status: Optional
Model Construction: Section 5.13.3.5
Related Command(s): Read GIS Z Line, Units
Sets the snapping tolerance used when associating specified GIS lines with points.
Used to adjust the snapping tolerance applied when pairing Read GIS Z Line polylines with associated point layers.
tolerance
Default: 0.001 (m or ft) or 1.0E-06 (decimal degrees)
Units : meters (m), feet (ft) or decimal degrees
Spatial Order == <horizontal_order>, <vertical_order>
Status: Optional
Model Construction: Section 5.5, Section 6.2
Related Command(s): Horizontal Gradient Limiter, Horizontal AlphaR, Vertical Gradient Limiter, Vertical Alpha R, Spatial Reconstruction
Sets the spatial reconstruction to first or second order.
Specifies the spatial order of accuracy of the solution schemes used in the simulation:
1= first order scheme2= second order scheme
The first-order schemes assume a piecewise constant value of the modelled variables in each cell, whereas the second-order schemes perform a linear reconstruction.
Higher order spatial schemes will produce more accurate results in the vicinity of sharp gradients; however, they will be more prone to developing instabilities and are more computationally expensive.
Generally, initial model development should be undertaken using low-order schemes, with higher-order spatial schemes tested during the latter stages of development. If a significant difference is observed between low-order and high-order results then the high-order solution is probably necessary, or alternatively further mesh refinement is required.
Second order spatial accuracy will typically be required in the vertical direction when trying to resolve sharp stratification.
See also the Horizontal Gradient Limiter and Vertical Gradient Limiter commands, which may be used to specify the Total Variation Diminishing (TVD) limiting schemes employed during the higher-order reconstructions.
When running in second order the Horizontal AlphaR and Vertical AlphaR horizontal and vertical gradient reduction factor commands may be of use for regions of high spatial gradients or to assist with improving model stability.
horizontal_order
vertical_order
| Parameter | Default | Description |
|---|---|---|
| horizontal_order | 1 | Horizontal spatial order: 1 or 2 |
| vertical_order | 1 | Vertical spatial order: 1 or 2 |
Spatial Reconstruction == 0 | {1}
Status: Optional
Model Construction: Section 5.14.2.1, Section 6.7.2.1
Required Dependent Command(s): Material
Related Command(s): Spatial Order, Material
Material block command used to revert an area to first order calculations where the model is otherwise a second order model. If a first order model is being used then this flag will have no effect.
Options:
0= False (i.e. no higher order reconstruction){1}(default) = True (i.e. higher order reconstruction)
Specific Heat Air == <specific_heat_air>
Status: Optional
Related Command(s): Include Heat, Wind Stress Model
Specifies the specific heat capacity of air.
Used to calculate atmospheric heat exchange source terms. The specific heat capacity value will be calculated internally when the Wind Stress Model Kondo option is specified.
specific_heat_air
Default: 1005.0
Units: J/kg/Degree C
Specific Heat Water == <specific_heat_water>
Status: Optional
Related Command(s): Include Heat, Wind Stress Model
Specifies the specific heat capacity of water.
Used to calculate atmospheric heat exchange source terms. The specific heat capacity value will be calculated internally when the Wind Stress Model Kondo option is specified.
specific_heat_water
Default: 4181.3
Units: J/kg/Degree C
Spherical == {0} | 1
Status: Optional
Model Construction: Section 5.3
Related Command(s): Units, Latitude
Defines the computational coordinate system as Cartesian or Spherical.
{0}(default) = Cartesian where geometry inputs and horizontal coordinates are in metres or feet {{< var units >}} depending on the selected units.1= Spherical where geometry inputs and horizontal coordinates are in decimal degrees.
For Cartesian models (Spherical == {0}) a representative latitude should be set using the Latitude command. If Coriolis forcing is likely to be important, Spherical coordinates are recommended.
Stability Limits == <water_level_max>, <velocity_max>
Status: Optional
Set a user specified maximum water level and maximum velocity which may indicate an unstable model. The simulation will stop if these limits are exceeded.
water_level_max
velocity_max
Start Control State == <start_value>
Status: Optional
Model Construction: Section 5.17.11.4
Required Dependent Command(s): Control
Related Command(s): Control Parameter, Response Parameters
Control block command that sets the initial value of the control parameter. For example to set a gate to closed or open at the start of the simulation. The default <start_value> is 1.
Not used for the Control == Trigger control type. Not used for the Control == Timeseries control type unless the Response Parameters command is used in combination with Timeseries.
Start Output == <start_output_time>
Status: Optional
Model Construction: Section 5.18.2.3
Required Dependent Command(s): Output
Related Command(s): Output, Start Time, Final Output
Output block command that defines the start time of the model output. If not specified, uses the model Start Time.
Useful for isolating specific time periods of interest in the model output for example to output high frequency results during a storm event but not for the entire simulation.
start_output_time
Units: decimal hours or dd/mm/yyyy HH:MM:SS
Start time of the model output.
The input format must be consistent with the selected Time Format. For Time Format == Hours the value is specified in decimal hours. For Time Format == ISODATE the value is specified as dd/mm/yyyy HH:MM:SS.
Start Time == <simulation_start_time>
Status: Required
Model Construction: Section 5.6
Required Dependent Command(s): Time Format
Related Command(s): Reference Time
Specifies the start time for the simulation in the selected Time Format.
simulation_start_time
Units: decimal hours or dd/mm/yyyy HH:MM:SS
Start time of the simulation.
For Time Format == Hours the value is specified in decimal hours. For Time Format == ISODATE the value is specified as dd/mm/yyyy HH:MM:SS.
Stokes Transport Factor == <stokes_scale_1, stokes_scale_2, …, stokes_scale_n>
Status: Optional
Model Construction: Section 5.16.7.2
Required Dependent Command(s): Include Stokes Drift
Related Command(s): Wave Parameters
Sets scalar specific factors used to scale Stokes drift transport.
Provide one scalar specific multiplier for each simulated scalar constituent (salinity, temperature, tracers, suspended sediment and water quality constituents). Values greater than 1 increase Stokes drift transport for that constituent, values between 0 and 1 reduce it, and negative values reverse the transport direction.
For example:
Stokes Transport Factor == 1., -1., 0.2, -0.2, 1.5The first scalar has a value of 1. This scalar’s mass transport will have Stokes drift applied as calculated by TUFLOW FV without modification.
The second scalar has a value of -1. This scalar’s mass transport will have Stokes drift applied as calculated by TUFLOW FV but with the direction reversed.
The third scalar with a value of 0.2 will have its Stokes drift reduced to 20% of that calculated.
The fourth scalar with a value of -0.2 will have its Stokes drift transport reduced to 20% of that calculated and with the direction reversed.
The fifth scalar has a value of 1.5. This scalar’s mass transport will have Stokes drift applied as calculated by TUFLOW FV but with the direction reversed but increased by 50%.
stokes_scale_<n>
Default: 1.0
Scalar multiplier for simulated scalar constituent <n>.
Structure == <structure_definition>
Status: Conditional - Required if including any hydraulic structures or variable bathymetry
Model Construction: Section 5.17, Section 7.12
Required Dependent Command(s): End Structure
Related Command(s): Flux Function, Energy Loss Function, Destratification Unit, Bed Adjust, Control
Begins the structure block and defines the connection type linking the structure to the 2D or 3D domain.
For detailed structure_definition examples and descriptions, see the model construction chapter hydraulic structures section(s). The required arguments depend on the selected structure type. It may optionally be configured with operational control.
Structure Logging == {0} | 1
Status: Optional
Model Construction: Section 5.17.11.7
Related Command(s): Control
Controls whether a structural log file recording operational behaviour is written.
Setting this to 1 will write a structural log file (.slf) that contains the operational behaviour of included structures through time.
Sub-Type == {1} | 2 | 3 | 4 | 5 | 6
Status: Optional
Model Construction: Section 5.16.2.3
Required Dependent Command(s): BC
BC block command that modifies the numerical implementation of the boundary condition. The available options depend on the selected boundary condition type. Refer to the relevant boundary condition sections for details. A summary of available options is provided below.
Boundary type options:
Q {1} | 2 | 3 | 4
{1}= Applied as a flux and distributed across a nodestring by cell width. Momentum is applied implicitly through the resulting velocity field2= Applied as a source term and distributed across a nodestring by cell width3= Applied as a flux and distributed across a nodestring by cell width and depth (W×H\(^1.5\)). Momentum is applied implicitly through the resulting velocity field4= Applied as a source term and distributed across a nodestring by cell width and depth (W×H\(^1.5\))
Notes for Q boundary type:
- The net flow matches the input specification. For Sub-Type 1 or 3 in 3D simulations, inflow may not be uniform through the water column and local flow reversal may occur. Sub-Type 2 or 4 is recommended for 3D models.
- Sub-Type 2 and 4 treat the boundary as a reflective wall with a distributed internal source.
- For overland flow with wetting and drying or highly non-uniform cross sections, Sub-Type 3 is recommended for 2D models and Sub-Type 4 for 3D models
QN {1} | 2
{1}= Default solver method2= Legacy QN boundary flux calculation method. Use only to reproduce legacy simulations
OBC, OBC_CURT, OBC_GRID {1} | 2 | 3 | 4 | 5 | 6
{1}= Water level is specified. The model calculates the boundary velocity so that flow can exit the domain naturally2= Reserved3= Velocity is specified. The model calculates the corresponding water level at the boundary. Not recommended in regions of wetting and drying4= Legacy overspecified boundary. Sub-Type 6 should be used unless reproducing legacy simulations5= Water levels are applied as an increment to an existing boundary condition. The change in water level is added to the current boundary state. Commonly used to add tidal variations to non-tidal water levels or currents6= Water level and velocity are specified. The velocity is adjusted using internal model conditions through a barotropic Flather relaxation, where differences between external and internal water levels allow waves to pass through the boundary with reduced reflection. Typically used when forcing from an ocean circulation model such as HYCOM
WL, WLS, WL_CURT {1} | 2 | 3 | 4 | 5 | 6
{1}= Water level is specified. The model calculates the boundary velocity so that flow can exit the domain naturally2= Not supported3= Not supported4= Not supported5= Water levels are applied as an increment to an existing boundary condition. Commonly used to add tidal variations, for example to an OBC_GRID boundary6= Not supported
QG, QC, QC_POLY, QCM, QC_GRID {1} | 2
{1}= When outflow is specified (Q<0), scalar flux is determined from the interior model concentration2= When outflow is specified (Q<0), scalar flux is taken from the BC file
PRECIP, PRECIP_GRID 1 | 2
1= Applied to all cells as a source term2= Applied to wet cells only as a source term
Suffix == <output_suffix>
Status: Optional
Model Construction: Section 5.18.2.3
Required Dependent Command(s): Output
Enables multiple results of the same output format to be saved from the same simulation. Appends the suffix onto the result file name to ensure each result file name is unique.
Surface Sigma Layers == <layer_count>
Status: Optional
Model Construction: Section 6.6
Required Dependent Command(s): Vertical Mesh Type
Related Command(s): Vertical Mesh Type, Layer Face File
Sets the number of surface sigma layers for the Z vertical mesh type. The default is 1.
Used with the Vertical Mesh Type == Z to create uniformly distributed sigma layers between the highest always wet Z layer and the free surface.
Surfzone Undertow Factor == <undertow_scale_factor>
Status: Optional
Model Construction: Section 5.16.7.2
Required Dependent Command(s): Include Stokes Drift
Related Command(s): Stokes Transport Factor
Scales the onshore Stokes transport in the surfzone. Increasing the factor increases the compensating offshore undertow required for mass conservation.
undertow_scale_factor
Default: 1.0
Values greater than 1.0 increase the compensating offshore undertow and values less than 1.0 reduce offshore transport.
Target File == <target_file_path>
Status: Conditional - Required with the Control == Target_Rule control type
Model Construction: Section 5.17.11.5.8
Required Dependent Command(s): Control
Related Command(s): Control File, Control Parameter
Control block command that sets a timeseries of the desired value of the sample parameter at the sample point or sample nodestring.
For further information on target file commands and setup, refer to the linked model construction chapter control section.
Temporal Extrapolation Check == WARNING | {ERROR}
Status: Optional
Model Construction: Section 5.16.2.4.4
Required Dependent Command(s): BC
Related Command(s): Global Temporal Extrapolation Check
BC block command that sets the behaviour when boundary input data are extrapolated beyond their available time range.
Used to control how the model responds when boundary input data are requested outside their available time range for a specific BC block. This command overrides the global setting for that boundary condition only. If Temporal Extrapolation Check == ERROR, the model will stop and report an error. If Temporal Extrapolation Check == WARNING, the model will continue to run and a message will be written to the log file.
Time Format == {Hours} | ISODATE
Status: Optional
Model Construction: Section 5.6
Required Dependent Command(s): Start Time, End Time
Related Command(s): Reference Time
Specifies the simulation time format.
{Hours}(default): Time in decimal hours.ISODATE: Date and time in the formdd/mm/yyyy HH:MM:SS.
Subsequent simulation time commands and simulation inputs must be in the specified time format. Simulation outputs will be in the specified time format.
Timestep Limits == <timestep_min>, <timestep_max>
Status: Required
Model Construction: Section 5.7
Related Command(s): CFL
Sets the limiting values for the lower and upper computational timestep.
The value of timestep_max should typically be set to ten times the value of timestep_min.
timestep_min
timestep_max
| Parameter | Description | Units |
|---|---|---|
| timestep_min | Limiting value for the lower computational timestep. | seconds (s) |
| timestep_max | Limiting value for the upper computational timestep. This should typically be set to ten times the value of timestep_min. | seconds (s) |
Trace Default == <tracer_1_default, tracer_2_default, …, tracer_n_default>
Status: Optional
Model Construction: Section 7.11.2.4.2
Required Dependent Command(s): BC
Related Command(s): Trace Header, Trace Scale, Trace Offset
BC block command that sets fallback tracer boundary values when specified tracer headers are not found.
A.2.0.1 tracer_<n>_default
Fallback tracer value for tracer <n>.
Trace Header == <tracer_header_1, tracer_header_2, …, tracer_header_n>
Status: Conditional - Required if modelling tracers
Model Construction: Section 7.11.2.4.2
Required Dependent Command(s): BC, NTracer
Related Command(s): Trace Default, Trace Scale, Trace Offset
Maps tracer input headers in the boundary data file to simulated tracer fields. Not required if no tracers are modelled.
The number of headers should match the number of active tracers set by NTracer.
Trace Offset == <tracer_offset_1, tracer_offset_2, …, tracer_offset_n>
Status: Optional
Model Construction: Section 7.11.2.4.2
Required Dependent Command(s): BC
Related Command(s): Trace Header, Trace Scale, Trace Default
BC block command that applies additive offsets to tracer boundary inputs after any scaling by Trace Scale is applied.
tracer_offset_<n>
Default: 0.0
Additive offset for tracer <n>.
Trace Scale == <tracer_scale_1, tracer_scale_2, …, tracer_scale_n>
Status: Optional
Model Construction: Section 7.11.2.4.2
Required Dependent Command(s): BC
Related Command(s): Trace Header, Trace Offset, Trace Default
Applies multiplicative scale factors to tracer boundary inputs before any offsets are applied via Trace Offset.
tracer_scale_<n>
Default: 1.0
Multiplicative scale factor for tracer <n>.
Tracer == <tracer_id_1, tracer_id_2, …, tracer_id_n>
Status: Conditional - Required for the decay, settling or water age implementations or when disabling evapo-concentration
Model Construction: Section 7.4
Required Dependent Command(s): End Tracer
Related Command(s): NTracer, Settling Velocity, Decay Rate, Water Age
Starts a tracer block for the specified tracer ID(s).
Not required for conservative tracers with default behaviour.
Transport Mode Depth == <depth>
Status: Optional
Model Construction: Section 7.11.10
Related Command(s): BC, Output
Sets the threshold water depth below which transport calculations are disabled in shallow cells.
Can be used to suppress transport calculations in shallow water where wetting and drying may otherwise cause instability in transport style boundaries.
depth
Default: 0.1
Units: m
Trigger Reset == <trigger_reset_value>
Status: Optional
Model Construction: Section 5.17.11.5.1
Required Dependent Command(s): Control, Sample Parameter, Sample Point, Trigger Value
After a trigger event occurs, if the control parameter equals the trigger_reset_value then the trigger condition will be reset allowing the trigger to reoccur if the trigger value is exceeded again later in the simulation. If not specified, the trigger will only occur once.
Trigger Value == <trigger_value>
Status: Conditional - Required if Control == Trigger
Model Construction: Section 5.17.11.5.1
Required Dependent Command(s): Control, Sample Parameter, Sample Point
Related Command(s): Trigger Reset
The value of the sample parameter that once exceeded will trigger the structure to commence.
Turbulence Update dt == <update_interval>
Status: Optional
Model Construction: Section 6.5
Sets the update timestep for the K-Epsilon, K-Omega and External vertical mixing models.
Specifies how often the vertical turbulence mixing eddy viscosity and scalar diffusivity equations are updated. If not specified, turbulence terms are updated every timestep.
update_interval
Default: 0.0
Units: s
Tutorial Model == {OFF} | ON
Status: Optional
Allows TUFLOW FV tutorial models to be run without a licence.
Set to ON to allow simulation of supported tutorial models without a TUFLOW licence.
Demo Model is also supported.
See Section 3.1.1 for a list of tutorial models.
Units == {Metric} | US Customary | Imperial | English
Status: Optional
Model Construction: Section 5.3
Related Command(s): Spherical
Sets all simulation input, model parameter and output units to:
{Metric}(default): SI units.US Customary: US Customary units.Imperial: Alias for US Customary units.English: Alias for US Customary units.
US Customary, Imperial and English are equivalent.
US Customary units are available for use with 2D HD Simulation Class Cartesian models only. If the model is likely to be extended to a more advanced simulation class (any of 3D HD, AD, ST, WQ or PT) it is recommended to use Metric units during initial model setup.
Update Dt == <update_interval>
Status: Optional
Model Construction: Section 5.17.2.3
Structure block command that sets how often hydraulic structure calculations are updated during the simulation.
If not specified, hydraulic structure calculations are updated every timestep.
update_interval
Default: 0.0
Units: seconds (s)
Use Restart File Time == 0 | {1}
Status: Optional
Model Construction: Section 5.18.10
Related Command(s): Restart File, Start Time
Switch to choose whether to use the timestamp written to the restart file (.rst) or to use the simulation Start Time.
Set to {1} (default) to use the timestamp stored in the restart file.
Set to 0 to use the Start Time even when a restart file is read.
Vapour Pressure Salinity Parameters == <a>, <b>, <c>
Status: Optional
Model Construction: Section 7.7.5.1
Required Dependent Command(s): Include Heat
Related Command(s): Include Salinity
Command to apply a vapour pressure (and therefore evaporation) correction for hyper saline conditions.
Applies a vapour pressure correction for hyper saline conditions in supported evaporation and humidity calculations.
See Equation B.89 (for Magnus-Tetens Latent Heat Model) or Equation B.79 (for Lowe and Reed Latent Heat Model) for the equation where these parameters are applied.
a
b
c
| Parameter | Default | Description |
|---|---|---|
| a | 4.61e-4 | Salinity equation coefficient 1. |
| b | 6.51e-7 | Salinity equation coefficient 2. |
| c | 0.7 | Salinity equation coefficient 3. |
Vertical Alpha R == <alphaV>, <alphaS>
Status: Optional
Model Construction: Section 6.2.4
Required Dependent Command(s): Spatial Order
Related Command(s): Spatial Order, Vertical Gradient Limiter
Sets a reduction factor to scale between first and second order vertical spatial reconstructions for vertical velocity and scalar variable fields. Not used for first order vertical spatial construction.
Set to 0.0 to use first order reconstruction and 1.0 to use second order reconstruction. Values between 0.0 and 1.0 will blend between first and second order reconstructions, which may be useful for improving model stability in regions of high vertical gradients away from the study region of interest.
alphaV
Default: 1.0
alphaS
Default: 1.0
Vertical Averaging == {Depth-All} | Depth-Range | Height-Range | Elevation-Range | Sigma-Range | Layer-Range-Top | Layer-Range-Bot, <range_1>, <range_2>
Status: Optional
Model Construction: Section 6.11.3
Required Dependent Command(s): Output
Defines the vertical coordinate type and range over which 3D results are averaged to produce point or 2D mesh outputs.
Averaging Type
Default: Depth-All
Units: NA
Vertical coordinate system for averaging:
- {Depth-All}: Averaged over the entire depth
- Depth-Range: Averaged over the vertical distance between two specified depths measured positive down from the water surface
- Height-Range: Averaged over the vertical distance between two specified heights measured positive up from the bed
- Elevation-Range: Averaged over the vertical distance between two specified absolute elevations measured positive up from the model datum
- Sigma-Range: Averaged over the vertical distance between two specified proportions of the water depth measured positive up from the bed (0.0) to the water surface (1.0)
- Layer-Range-Top: Averaged over the vertical distance spanned by two specified layers inclusive. Layer 1 is the top layer and layer number increases positive down. If the same layer is specified only that layer is output.
- Layer-Range-Bot: Averaged over the vertical distance spanned by two specified layers inclusive. Layer 1 is the bottom layer and layer number increases positive up. If the same layer is specified only that layer is output.
range_1
Default: 0.0
Units: varies by averaging type
First range value. Depending on selected averaging type, it is: depth, height, elevation, sigma proportion, or layer number.
range_2
Default: 99999.
Units: varies by averaging type
Second range value. Depending on selected averaging type, it is: depth, height, elevation, sigma proportion, or layer number.
Vertical Coordinate Type
Status: Optional
Model Construction: Section 6.9.3.1, Section 6.10.3.1
Navigation row for this command. Argument syntax depends on the selected implementation.
Vertical Coordinate Type == Elevation | {Depth} | Sigma | Height
Status: Optional
Model Construction: Section 6.9.3.1
Boundary condition implementation.
Specifies the vertical coordinate system used to interpret a 3D boundary distribution profile.
If not specified, the boundary condition is distributed evenly over the water column.
Vertical Coordinate Type == {Elevation} | Depth | Sigma | Height
Status: Optional
Model Construction: Section 6.10.3.1
Structure implementation.
Specifies the vertical coordinate system used to connect a structure to the 3D layer structure of the model domain.
If not specified, the structure flow is distributed evenly over the water column.
Vertical Distribution File == <vertical_distribution_file_path>
Status: Optional
Model Construction: Section 6.9.3.1, Section 6.10.3.1
Provides the vertical weighting profile used to distribute a 3D boundary condition or hydraulic structure flow over the water column.
The file contains vertical coordinate values and associated weighting factors, which are normalised during application. For examples of the required format of the vertical distribution file, refer to the model construction chapter boundary conditions and hydraulic structures sections listed below.
Vertical Eddy Viscosity Limits == <viscosity_min>, <viscosity_max>
Status: Optional
Model Construction: Section 6.7.2.1
Required Dependent Command(s): Material
Material block command that assigns material specific minimum and maximum limits on computed vertical eddy viscosity.
The Global value is set by the Global Vertical Eddy Viscosity Limits command. This command allows material specific limits to be set that override the global limits for cells with the specified material ID.
viscosity_min
viscosity_max
| Parameter | Default | Description | Units |
|---|---|---|---|
| viscosity_min | Global value | Minimum eddy viscosity limit. | m\(^2\)/s |
| viscosity_max | Global value | Maximum eddy viscosity limit. | m\(^2\)/s |
Vertical Gradient Limiter == {MC} | MINMOD | SUPERBEE
Status: Optional
Model Construction: Section 6.2.4
Sets the Total Variation Diminishing (TVD) limiting scheme for 2nd order vertical spatial integration scheme. Not used for first order vertical spatial construction.
Refer to Section B.4.2 for further information on the available options.
Vertical Mesh Type == {Sigma} | Z
Status: Conditional - Required for the 3D HD simulation class
Model Construction: Section 6.6
Required Dependent Command(s): Layer Face File
Related Command(s): Surface Sigma Layers
Selects the vertical discretisation method for the 3D mesh.
Supported vertical mesh type options are:
{Sigma}(default): Uses sigma coordinate layers that follow the bed and occupy the full water column.Z: Uses fixed elevation z layers across the model domain. By default one Surface Sigma Layer resides between the top z layer and the water surface. This can be modified to include more surface sigma layers using the Surface Sigma Layers command.
Vertical Mixing Length Scale Limiter == <Cgalp>
Status: Optional
Model Construction: Section 6.5.7.2
Required Dependent Command(s): Vertical Mixing Model
Related Command(s): Vertical Mixing Model, Second Order Vertical Mixing Model, Internal Wave Mixing Model
Applies the Galperin turbulent length scale limiter for the K-Epsilon and K-Omega vertical mixing models.
Cgalp
Default: 0.53
Used to optionally extend the K-Epsilon or K-Omega vertical mixing model under stratified conditions. The default 0.53 value follows the standard Galperin formulation.
Vertical Mixing Model == {Constant} | Parametric | KEpsilon | KOmega | External
Status: Conditional - Required for 3D HD simulations
Model Construction: Section 6.5
Required Dependent Command(s): Vertical Mixing Parameters
Related Command(s): Second Order Vertical Mixing Model, Vertical Mixing Length Scale Limiter, Internal Wave Mixing Model, Global Vertical Eddy Viscosity Limits, Global Vertical Scalar Diffusivity Limits
Selects the vertical mixing model used to calculate vertical eddy viscosity and scalar diffusivity.
See Section B.10 for further information on the available options.
The specification of the Vertical Mixing Parameters command is dependent on the selected vertical mixing model.
Vertical Mixing Parameters
Status: Conditional - Required if Vertical Mixing Model == Constant as no default parameters are available for this model. Optional for other models as default parameters are provided for all other models
Required Dependent Command(s): Vertical Mixing Model
Related Command(s): Global Vertical Eddy Viscosity Limits, Global Vertical Scalar Diffusivity Limits
Navigation row for this command. Argument syntax depends on the selected implementation.
Use the argument form that matches the selected Vertical Mixing Model.
Vertical Mixing Parameters == <vertical_mixing_value>
Status: Conditional - Required if Vertical Mixing Model == Constant as no default parameters are available for this model.
Required Dependent Command(s): Vertical Mixing Model
Related Command(s): Global Vertical Eddy Viscosity Limits, Global Vertical Scalar Diffusivity Limits
Sets the constant vertical mixing value for the Vertical Mixing Model == Constant implementation.
vertical_mixing_value
| Parameter | Default | Description | Units |
|---|---|---|---|
| vertical_mixing_value | 0.0 | Constant vertical mixing value | m\(^2\)/s |
Vertical Mixing Parameters == <coefficient_a>, <coefficient_b>
Status: Optional
Required Dependent Command(s): Vertical Mixing Model
Related Command(s): Global Vertical Eddy Viscosity Limits, Global Vertical Scalar Diffusivity Limits
Sets the required parameter values for the Vertical Mixing Model == Parametric implementation.
Refer to Section B.10.1.1 for further description of the following parameters.
coefficient_a
coefficient_b
| Parameter | Default | Description |
|---|---|---|
| coefficient_a | 0.41 | Parametric vertical mixing model coefficient 1 (\(c_{1}\)). |
| coefficient_b | 0.41 | Parametric vertical mixing model coefficient 2 (\(c_{2}\)). |
Vertical Mixing Parameters == <c1_eps>, <c2_eps>, <c_mu>, <sigma_k>, <sigma_eps>, <c3_eps_plus>, <c3_eps_minus>
Status: Optional
Required Dependent Command(s): Vertical Mixing Model
Related Command(s): Global Vertical Eddy Viscosity Limits, Global Vertical Scalar Diffusivity Limits
Sets the required parameter values for the Vertical Mixing Model == KEpsilon implementation.
Refer to Section B.10.1.2 for further description of the following parameters.
c1_eps
c2_eps
c_mu
sigma_k
sigma_eps
c3_eps_plus
c3_eps_minus
| Parameter | Default | Description |
|---|---|---|
| c1_eps | 1.44 | K-Epsilon vertical mixing model coefficient, \(C_{1\epsilon}\). |
| c2_eps | 1.92 | K-Epsilon vertical mixing model coefficient, \(C_{2\epsilon}\). |
| c_mu | 0.09 | K-Epsilon vertical mixing model coefficient, \(C_{\mu}\). |
| sigma_k | 1.0 | K-Epsilon vertical mixing model coefficient, \(\sigma_{k}\). |
| sigma_eps | 1.3 | K-Epsilon vertical mixing model coefficient, \(\sigma_{\epsilon}\). |
| c3_eps_plus | 1.0 | K-Epsilon vertical mixing model coefficient, \(C_{3\epsilon +}\). |
| c3_eps_minus | 0.0 | K-Epsilon vertical mixing model coefficient, \(C_{3\epsilon -}\). |
Vertical Mixing Parameters == <alpha>, <beta>, <c_mu>, <sigma_k>, <sigma_omega>, <c3_omega_plus>, <c3_omega_minus>
Status: Optional
Required Dependent Command(s): Vertical Mixing Model
Related Command(s): Global Vertical Eddy Viscosity Limits, Global Vertical Scalar Diffusivity Limits
Sets the required parameter values for the Vertical Mixing Model == KOmega implementation.
Refer to Section B.10.1.3 for further description of the following parameters.
alpha
beta
c_mu
sigma_k
sigma_omega
c3_omega_plus
c3_omega_minus
| Parameter | Default | Description |
|---|---|---|
| alpha | 5/9 (approx. 0.55555) | K-Omega vertical mixing model coefficient, \(\alpha\). |
| beta | 3/40 (approx. 0.075) | K-Omega vertical mixing model coefficient, \(\beta\). |
| c_mu | 0.09 | K-Omega vertical mixing model coefficient, \(C_{\mu}\). |
| sigma_k | 2.0 | K-Omega vertical mixing model coefficient, \(\sigma_{k}\). |
| sigma_omega | 2.0 | K-Omega vertical mixing model coefficient, \(\sigma_{\omega}\). |
| c3_omega_plus | 0.0 | K-Omega vertical mixing model coefficient, \(C_{3\omega +}\). |
| c3_omega_minus | -0.637117 | K-Omega vertical mixing model coefficient, \(C_{3\omega -}\). |
Vertical Mixing Parameters == <eddy_viscosity_scale_factor>, <scalar_diffusivity_scale_factor>
Status: Optional
Required Dependent Command(s): Vertical Mixing Model
Related Command(s): Global Vertical Eddy Viscosity Limits, Global Vertical Scalar Diffusivity Limits
Sets the eddy viscosity and scalar diffusivity scale factors for the Vertical Mixing Model == External implementation.
eddy_viscosity_scale_factor
scalar_diffusivity_scale_factor
| Parameter | Default | Description |
|---|---|---|
| eddy_viscosity_scale_factor | 1.0 | Eddy viscosity scale factor. |
| scalar_diffusivity_scale_factor | 1.0 | Scalar diffusivity scale factor. |
Vertical Scalar Diffusivity Limits == <k_diff_min>, <k_diff_max>
Status: Optional
Model Construction: Section 7.9
Required Dependent Command(s): Material
Related Command(s): Vertical Mixing Model, Global Vertical Scalar Diffusivity Limits
Material block command that assigns material specific minimum and maximum limits on vertical scalar diffusivity, overriding corresponding global values.
Global values are set using the Global Vertical Scalar Diffusivity Limits command.
k_diff_min
k_diff_max
| Parameter | Default | Description | Units |
|---|---|---|---|
| k_diff_min | Global value | Minimum limit on vertical scalar diffusivity. | m\(^2\)/s |
| k_diff_max | Global value | Maximum limit on vertical scalar diffusivity. | m\(^2\)/s |
Water Age == {0} | 1
Status: Optional
Model Construction: Section 7.4.6
Required Dependent Command(s): Tracer
Related Command(s): NTracer, Tracer, Settling Velocity, Decay Rate
Tracer block command that enables water age source term accumulation for tracers in the active tracer block.
Set to 1 within a tracer block to enable water age accumulation for that tracer. Water age is commonly used to estimate residence or flushing time.
Water Emissivity == <water_em>
Status: Optional
Related Command(s): Include Heat
Reference water emissivity.
water_em
Default: 0.96
Units: Dimensionless
Water Quality Control File == <water_quality_control_file_path>.fvwq
Status: Conditional - Required for the water quality simulation class
Model Construction: Section 9.3
Required Dependent Command(s): Water Quality Model
Related Command(s): Water Quality Model Directory
Specifies the water quality control file used to configure the water quality simulations.
Specifies the TUFLOW FV water quality control file, typically using the .fvwq extension. Use Water Quality Model Directory to define a common base directory when the control file is stored outside the simulation folder.
Water Quality Model == {None} | TUFLOW | External
Status: Conditional - Required for the water quality simulation class
Model Construction: Section 9.2
Related Command(s): Water Quality Control File, Water Quality Model Directory, Water Quality Update dt
Activates water quality simulations using either the TUFLOW FV Water Quality Module or a user compiled external water quality model.
If the external option is selected, Water Quality Update dt controls the external model timestep.
Water Quality Model Directory == <water_quality_model_directory_path>
Status: Optional
Model Construction: Section 9.3
Required Dependent Command(s): Water Quality Control File
Related Command(s): Water Quality Model
Specifies an optional directory path that is concatenated with the Water Quality Control File path.
Water Quality Update dt == <update_interval>
Status: Optional
Model Construction: Section 9.3
Related Command(s): Water Quality Model, Water Quality Control File
Sets the timestep used for external water quality model calculations.
Only used when Water Quality Model is set to External. The setting is ignored when Water Quality Model is set to TUFLOW because the TUFLOW FV Water Quality Module timestep is defined within the water quality control file.
update_interval
Default: 900.0
Units: seconds (s)
Wave Depth Correction == 0 | {1}
Status: Optional
Model Construction: Section 5.16.7
Required Dependent Command(s): BC
Controls whether bottom orbital velocity from wave inputs is depth corrected when wave and hydrodynamic depths differ.
Applicable if the DEPTH variable is applied using an uncoupled WAVE BC type; or, if running in coupled mode via the WAVE_COUPLED BC type.
If set to 1, compare the model depths in the wave model and TUFLOW FV model. Where TUFLOW FV is deeper, translate the bottom orbital velocity (UBOT) down to the greater depth using:
\(Ubot = Ubot \times depth\_corr\)
Where:
- \(depth\_corr = COSH(MIN(k/h \times (h-d), 10.))\)
- \(h\) = water depth in TUFLOW FV
- \(d\) = water depth in Wave model
- \(k\) is the dimensionless wavenumber
If set to 0, no depth correction is applied.
Wave Parameters == <wave_gamma>, <wave_depth_limit>
Status: Optional
Model Construction: Section 5.16.7
Related Command(s): BC, Cell Wet/Dry Depths
Sets the wave gamma limit and the depth threshold below which wave stresses are switched off.
wave_gamma
wave_depth_limit
| Parameter | Default | Description | Units |
|---|---|---|---|
| wave_gamma | 0.35 | Maximum ratio of wave height to depth. Typically 0.35 - 0.8. | Dimensionless |
| wave_depth_limit | h_wet (model wetting depth) | Wave stresses are switched off at cells below this depth. If not specified the default is to use the model wetting depth as set by Cell Wet/Dry Depths. | meters (m) |
Width File == <width_file_path>
Status: Optional
Model Construction: Section 5.17.5.1
Required Dependent Command(s): Flux Function
Related Command(s): Flux Function, Structure, Form Loss Coefficient
Structure block command that defines a variable effective flow width for bridges or flow constrictions.
Specifies a CSV file defining effective flow width as a function of elevation, commonly used for bridge or constriction modelling. See the linked model construction sections for further details and example file format.
Wind Stress Model == {Wu} | Constant | Kondo
Status: Optional - Optional for model simulations not using atmospheric heat exchange. Conditional for the AD simulation class if using the Kondo wind stress implementation in conjunction with Atmospheric Stability Model
Model Construction: Section 5.11, Section 7.8
Related Command(s): Wind Stress Parameters, Bulk Momentum Transfer Coefficient, Atmospheric Stability Model
Selects the wind stress parameterisation.
Related commands depend on the selected wind stress implementation. For Wu and Kondo, refer to the Wind Stress Parameters navigation row and the associated implementation entries.
For Constant, use Bulk Momentum Transfer Coefficient.
Wind Stress Parameters
Status: Optional
Navigation row for this command. Argument syntax depends on the selected Wind Stress Model.
Wind Stress Parameters == <Wa>, <Ca>, <Wb>, <Cb>
Status: Optional
Model Construction: Section 5.11.3
Required Dependent Command(s): Wind Stress Model
Sets the wind stress parameters Wa, Ca, Wb and Cb for the Wind Stress Model == Wu implementation. These parameters are used to define the piecewise linear wind speed dependent transfer coefficient.
Refer to Section B.9.1 for further description of the following parameters.
Wa
Ca
Wb
Cb
| Parameter | Default | Description | Units |
|---|---|---|---|
| Wa | 0.0 | Wind speed threshold 1, \(W_{a}\). | m/s |
| Ca | 0.8e-03 | Bulk momentum transfer coefficient 1, \(C_{a}\). | Dimensionless |
| Wb | 50.0 | Wind speed threshold 2, \(W_{b}\). | m/s |
| Cb | 4.05e-03 | Bulk momentum transfer coefficient 2, \(C_{b}\). | Dimensionless |
Wind Stress Parameters == <scale_factor>
Status: Optional
Model Construction: Section 5.11.5
Required Dependent Command(s): Wind Stress Model
Sets the Kondo wind stress scale factor for the Wind Stress Model == Kondo implementation. This factor is applied to the internally calculated transfer coefficient.
Refer to Section B.9.3 for further description of the following parameter.
scale_factor
| Parameter | Default | Description |
|---|---|---|
| scale_factor | 1.0 | Scale factor, \(\alpha\). |
WQ Default == <wq_default_1, wq_default_2, …, wq_default_n>
Status: Optional
Model Construction: Section 9.5.2.4.1
Required Dependent Command(s): BC, Water Quality Model
Related Command(s): WQ Header, WQ Scale, WQ Offset
Sets fallback WQ constituent boundary values when specified WQ constituent headers are not found.
The number of arguments varies depending on the suite of water quality constituents. Refer to the linked model construction section(s) for further details.
wq_default_<n>
Default: 0.0
Fallback WQ constituent boundary value for constituent <n>.
WQ Header == <wq_header_1, wq_header_2, …, wq_header_n>
Status: Conditional - Required for water quality boundary conditions that reference constituent headers in a boundary data file
Model Construction: Section 9.5.2.4.1
Required Dependent Command(s): BC, Water Quality Model
Related Command(s): WQ Default, WQ Scale, WQ Offset
Maps WQ constituent input headers in the boundary data file to simulated WQ constituent fields.
The number of arguments varies depending on the suite of water quality constituents. Refer to the linked model construction section(s) for further details.
WQ Offset == <wq_offset_1, wq_offset_2, …, wq_offset_n>
Status: Optional
Model Construction: Section 9.5.2.4.1
Required Dependent Command(s): BC, Water Quality Model
Related Command(s): WQ Header, WQ Scale, WQ Default
Applies additive offsets to WQ constituent boundary inputs after any scaling by WQ Scale is applied.
The number of arguments varies depending on the suite of water quality constituents. Refer to the linked model construction section(s) for further details.
wq_offset_<n>
Default: 0.0
Offset value for WQ constituent <n>.
WQ Scale == <wq_scale_1, wq_scale_2, …, wq_scale_n>
Status: Optional
Model Construction: Section 9.5.2.4.1
Required Dependent Command(s): BC
Related Command(s): WQ Header, WQ Offset, WQ Default
Applies multiplicative scale factors to water quality constituent boundary inputs before any offsets by WQ Offset are applied. The number of arguments varies depending on the suite of water quality constituents. Refer to the linked model construction section(s) for further details.
wq_scale_<n>
Default: 1.0
Multiplicative scale factor for WQ constituent <n>.
Write Check Files == <check_files_directory_path>
Status: Optional
Model Construction: Section 5.18.11.1
Related Command(s): Output Dir, GIS Format
Writes model GIS check files to the specified directory.
Writes GIS and CSV check outputs used to review model setup, input interpretation and derived geometry during initialisation.
Write Empty GIS Files == <empty_gis_directory_path>
Status: Required - Only needs to be run once during model initialisation. After the empty files are written, this command can be commented out in subsequent runs
Model Construction: Section 5.2
Required Dependent Command(s): GIS Format
Related Command(s): SHP Projection, MI Projection
Creates empty GIS template files in either .mid/.mif or .shp format. Each layer is produced with the required attribute definitions pre-defined, but contains no geographic objects.
Empty GIS layers are prefixed and given the suffix _empty. GIS files are saved to the specified folder, which must already exist.
After writing the templates TUFLOW FV stops, so this command is usually run once during initial setup and then removed or commented out.
Write GIS Messages == 0 | {1}
Status: Optional
Related Command(s): Log Dir
Set to 1 (default) to enable GIS message output, or 0 to disable. When enabled, TUFLOW FV creates a GIS point layer named <run_name>_messages_P.shp in the log directory, with each point containing message ID, text and message registy URL attributes.
Write Restart At Time == <restart_ur_time>
Status: Optional
Model Construction: Section 5.18.10
Related Command(s): Log Dir, Time Format, Restart File, Write Restart dt, Restart Overwrite
Writes a user requested restart file (_UR.rst) at the first model timestep at or after the requested time.
This command enables creation of restart snapshots at a specific time without relying on regular periodic output intervals. Output filenames include a _UR suffix (UR for User Requested). Only one specific target time per run is supported. The command can be used in combination with Write Restart dt.
restart_ur_time
Default: No default
Units: HOURS (decimal hours) or ISODATE (string in DD/MM/YYYY HH:MM:SS format)
Restart write time specified in either HOURS or ISODATE format. Examples: 0.5 (hours) or 01/05/2011 00:15:00 (isodate dd/mm/yyyy HH:MM:SS).
Write Restart dt == <update_interval>
Status: Optional
Model Construction: Section 5.18.10
Required Dependent Command(s): Log Dir
Related Command(s): Restart File, Restart Overwrite, Use Restart File Time, Write Restart At Time
Writes a restart file (.rst) to the log directory location at the time interval specified.
Writes restart files at the specified interval so a later simulation can resume from saved model state. The large default value writes a restart file at the end of the simulation only. A restart file will be written for all TUFLOW FV simulations.
update_interval
Default: 9.99E+009
Units: hours
Zone Inlet/Outlet Orientation == <inlet_orientation>, <outlet_orientation>
Status: Conditional - Required for structures using the Linked Zones connection type
Model Construction: Section 5.17.2.3
Required Dependent Command(s): Structure
Defines upstream and downstream orientation for flux limiting calculations.
Orientation is defined in degrees anticlockwise from the positive x-axis. For example, for a structure aligned with flow from east to west, both the inlet and outlet orientation would be 180 degrees.
inlet_orientation
outlet_orientation
| Parameter | Description | Units |
|---|---|---|
| inlet_orientation | Inlet orientation in degrees anticlockwise from the positive x-axis. | Degrees |
| outlet_orientation | Outlet orientation in degrees anticlockwise from the positive x-axis. | Degrees |
