11.6 Output Control Commands
A wide range and variety of commands allow the user to configure TUFLOW output to be different to the default settings. Table 11.16 lists these commands in different categories followed by a brief description.
| Requirement | Command | Description | Category |
|---|---|---|---|
| Mandatory | GPKG Projection, SHP Projection, or MI Projection | Define the projection for the output of GIS layers. Not all projection commands are mandatory, i.e. only specify projection settings for the formats required. Commands are: GPKG Projection, MI Projection, SHP Projection, GIS Projection Check, SHP Projection Check Method, TIF Projection. | GIS |
| Mandatory | Map Output Format | Specify one or more map output formats to be written. | Map |
| Mandatory | Map Output Interval | Mandatory command that controls the frequency of map output. Alternatively, set this value to zero to only output maximums. | Map |
| Mandatory | Time Series Output Interval | Mandatory command that controls the frequency of time-series output. | Time-Series |
| Recommended | Write Check Files | Customise which check files/layers to output. | Check |
| Recommended | Log Folder | Customise the location for the .tlf and other files. | File Management |
| Recommended | Output Folder | Customise the parent folder for the 2D based output files. If the command is place in the .ecf or 1D Domain controls the folder for the 1D based output files. | File Management |
| Recommended | GIS Format | Controls the format for output GIS layers. | GIS |
| Recommended | Map Output Data Types | Controls the map data types to be output. Default is just water level and velocity, but there are many more! | Map |
| Optional | Pit Channel Offset | Change the default distance that a pit and its results are displayed relative to the 1D node the pit flows into. | Check |
| Optional | Write X1D Check Files | Set to ON to output additional check files for linked external 1D schemes. | Check |
| Optional | Mass Balance Output | Switch mass balance tracking and outputting on or off. | Console |
| Optional | Mass Balance Output Interval | Set the time interval for outputting mass balance information. | Console |
| Optional | Screen/Log Display Interval | Controls how often information is displayed and written to the .tlf file whilst a simulation is underway. | Console |
| Optional | Output Drive | Override the drive letter for all output files. | File Management |
| Optional | Output Files | Control which output files are to be written. | File Management |
| Optional | Simulations Log Folder | Customise the location for logging simulations. | File Management |
| Optional | Write Empty GIS Files | Output empty GIS layers. Very useful command when setting up a new model. | File Management |
| Optional | Write Restart File at Time | Controls how and when restart files are output. | File Management |
| Optional | Write Restart File Interval | Sets the interval at which to write a restart file. | File Management |
| Optional | Write Restart File Version | Controls the version of the restart file feature to output. | File Management |
| Optional | Write Restart Filename | Controls the approach on whether to keep overwriting or give a unique name for each restart file. | File Management |
| Optional | XF Files | Global setting on whether or not to use and output XF files. | File Management |
| Optional | XF Files Include in Filename | Set a unique text to be included in XF filenames. | File Management |
| Optional | Read GIS Objects | Add gauge levels and other information to GIS receptor layer(s). | GIS |
| Optional | Write GIS Domain | Output a GIS layer of the 2D domains processed thus far in the .tgc file. | GIS |
| Optional | Write GIS Zpts | Output a GIS layer of the current 2D Zpts elevations at that point in the .tgc file. | GIS |
| Optional | Spatial Database Output | Sets how the outputs are written when using GeoPackages. The grouped (default) option will group outputs by folder location. For example all check file outputs will be contained within one database. | GIS |
| Optional | Grid Format | Controls the format for output GIS grid layers. | Grid |
| Optional | Grid Output Cell Size | Sets the cell size of output grids, including check grids. This can be different to the 2D cell size(s). | Grid |
| Optional | Grid Output Origin | Change how the grid output origin is determined. | Grid |
| Optional | Write GIS Grid | Output a GIS layer of the current active 2D cells and their attributes at that point in the .tgc file. | Grid |
| Optional |
UK Hazard Debris Factor UK Hazard Formula UK Hazard Land Use |
Change the default settings on how the UK flood hazard output is calculated. | Hazard |
| Optional | ZP Hazard Cutoff Depth | Change the cutoff depth for outputting People Hazard categories (ZPA, ZPC and ZPI). | Hazard |
| Optional | BSS Cutoff Depth | Change the default cutoff depth setting for bed shear stress output. | Map |
| Optional | End Map Output | Change the end time for map output to be different to the simulation end time. Useful for output zones where a shorter output period is required. | Map |
| Optional | Map Cutoff Depth | Change the default cutoff depth for setting whether a 2D cell is wet or dry in the map output. Useful for direct rainfall modelling. Only used for map output, ie. it does not affect the hydraulic computations like Cell Wet/Dry Depth does. | Map |
| Optional | Map Output Entire Model | Switch on or off the map output for the entire model. Useful if using output zones and map output for the whole model is not needed. | Map |
| Optional | Maximum Velocity Cutoff Depth | Change the default depth that the approach to tracking maximum velocities is changed. | Map |
| Optional | Read GIS GLO | Change from regular time-based map output to map output produced at different water levels at a gauge. GLO stands for Gauge Level Output. | Map |
| Optional |
Read GIS WLL Points Read GIS X1D WLL Points |
Change the ground elevations and materials at WLL points along WLLs. | Map |
| Optional | Read GIS X1D WLL | Include the results from 1D elements in the map output using WLLs. | Map |
| Optional | Start Map Output | Change the start of map output to be different to the simulation start time. | Map |
| Optional | Time Output Cutoff | Add time of exceedance and time of duration for one or more depth or hazard values to the map output data set. | Map |
| Optional | Meshparts | Adds flags to the .2dm file for use by some map output viewers such as SMS to control the display of different parts of a model. | Other |
| Optional | Reveal 1D Nodes | Add the hidden 1D nodes used in 2D/2D links to the 1D output. | Other |
| Optional | Set Route Cut Off Type | Controls the parameter to use when determining whether a route is closed. For example, depth or hazard. | Other |
| Optional | Set Route Cut Off Values | Define one or more values for route closure categories. | Other |
| Optional | CSV Time | Change the units of the time column. | Time-Series |
| Optional | Excel Start Date | Start the time column at a specific date for use in Excel. | Time-Series |
| Optional | Order Output | Controls whether 1D nodes and channels are output in alphanumeric order or in the order they are processed during input. | Time-Series |
| Optional | Read GIS LP | Set up 2D longitudinal profile output. | Time-Series |
| Optional | Read GIS PO | Set up 2D time-series output locations. | Time-Series |
| Optional | Read GIS Reporting Location | Set up combined 1D and 2D time-series output locations. | Time-Series |
| Optional | Start Time Series Output | Change the start of time-series output to be different to the simulation start time. | Time-Series |
| Optional | Write PO Online | Write time-series output at each time map output is written (rather than just at the end of the simulation). | Time-Series |
| Optional | Maximums and Minimums | Change the default setting on whether to track maximums and/or minimums. | Tracking Max/Min |
| Optional | Maximums and Minimums Only for Grids | Controls whether grid based map output is only written out as maximums, ie. switch on or off the grid temporal map output. | Tracking Max/Min |
| Optional | Maximums and Minimums Time Series | Controls whether to track maximums for time-series outputs. | Tracking Max/Min |
| Advanced | Display Water Level | Display a water level on the console window whilst running. | Console |
| Advanced | Force File IO Display | Show file opening information to the console window. | Console |
| Advanced | Verbose | Controls how much information is displayed and written to the .tlf file. | Console |
| Advanced | Read File | Insert a file into a control file. | File Management |
| Advanced | Set Variable | Define user variables for use within the control files. Useful for setting output folder names based on a scenario. | File Management |
| Advanced | TSF Update Interval | Change when and how often the .tsf file is to be updated. | File Management |
| Advanced | Calibration Points GIS File | Add the maximum water levels to a GIS layer of calibration or gauge points. | GIS |
| Advanced | Map Output Corner Interpolation | Apply different approaches to interpolating results to 2D cell corners. Primarily provided for backward compatibility for legacy models. | Map |
| Advanced | WLLp Interpolate Bed | Change how the bed level along a WLL is assigned. | Map |
| Advanced |
Define Output Zone … End Define |
Set up a definition block of commands for an output zone. | Output Zones |
| Advanced | Model Output Zones | Controls which output zones are output. | Output Zones |
| Advanced | Read GIS Output Zone | Defines the region for the output zone. | Output Zones |
