View source for TUFLOW Empty Files

=Introduction=

The native non-Graphical User Interface (GUI) form of TUFLOW uses Geographic Information System (GIS) files for its spatial inputs. TUFLOW requires precise GIS file formats associated with specific TUFLOW commands. The required fields for each input type are listed in the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u>. For example, the '''2d_zsh_empty''' file associated with the <font color="blue"><tt>Read GIS Z Shape</tt></font> <font color="red"><tt>==</tt></font> command requires the following data fields and types in the order shown below:<br>

<center>[[File:2d zsh fields.png]]<br></center>
<br>
Because of this file format requirement, the first task in any modelling project is to write template (empty) GIS files in the specific model projection system (as demonstrated in <u>[[Tutorial_M01#Project_Initialisation|Tutorial Module 1]]</u>).<br> 

This page of the TUFLOW Wiki provides a reference list of the template (empty) GIS files, the associated TUFLOW command and a basic description of their function.<br>

Note: when using the shapefile format TUFLOW creates a dummy entry when creating empty files. Importing an empty layer into QGIS using the <u>[[QGIS_TUFLOW_Import_Empty | Import Empty]]</u> tool, will remove this dummy entry. Opening a template empty file directly in QGIS (without using the <u>[[QGIS_TUFLOW_Import_Empty | Import Empty]]</u> tool), the dummy entry will remain in the layer and garbled text shown in the attribute fields. 

==TUFLOW Control file (TCF)==
{| class="wikitable" width="75%"
! style="background-color:#005581; font-weight:bold; color:white;" width=20%| Template (empty) GIS File 
! style="background-color:#005581; font-weight:bold; color:white;" width=25%| Compatible TUFLOW Commands
! style="background-color:#005581; font-weight:bold; color:white"| File / Command Function
|-
| '''2d_at_empty''' ||   <font color="blue"><tt>Read GIS Auto Terminate</tt></font> <font color="red"><tt>==</tt></font>  || Used to define locations where auto terminate tracking is desired.
|-
| rowspan=2| '''2d_cyc_empty''' ||   <font color="blue"><tt>Read GIS Cyclone</tt></font> <font color="red"><tt>==</tt></font>  ||rowspan=2| Used to apply a cyclone or hurricane boundary within TUFLOW, capturing the effects of wind and pressure fields created by severe storms, which can affect flooding and inundation in coastal area.
|-
| <font color="blue"><tt>Read GIS Hurricane</tt></font> <font color="red"><tt>==</tt></font> 
|-
| '''2d_fc_empty''' ||   <font color="blue"><tt>Read GIS FC</tt></font> <font color="red"><tt>==</tt></font>  || Used for 2D flow constrictions, representing additional losses associated with bridges or box culverts. This command has been superseded with the TGC commands: <br> <font color="blue"><tt>Read GIS FC Shape</tt></font> <br> <font color="blue"><tt>Read GIS Layered FC Shape</tt></font>.<br> 
The template file and command only remain for the purpose of version backward compatibility.
|-
| '''2d_glo_empty''' ||  <font color="blue"><tt>Read GIS GLO</tt></font> <font color="red"><tt>==</tt></font>  || Used to define gauge level output (2d_glo) locations.  The GLO command controls map output based on the height of the water at a specified location within the model domain. 
|-
| '''2d_iwl_empty''' ||  <font color="blue"><tt>Read GIS IWL</tt></font> <font color="red"><tt>==</tt></font>  || Sets the initial water level in the model at the start of the simulation. The initial water level can vary spatially within the model. An equivalent initial Water level command also exists in the TGC.  
|-
| '''2d_lp_empty''' || <font color="blue"><tt>Read GIS LP</tt></font> <font color="red"><tt>==</tt></font>  || This file contains details on the location of longitudinal profile outputs. 
|-
| '''2d_oz_empty''' || <font color="blue"><tt>Read GIS Output Zone</tt></font> <font color="red"><tt>==</tt></font>   || This file contains one or more polygons defining the 2D regions to be output. This model input is used with the command <font color="blue"><tt>Model Output Zones</tt></font> and the <font color="blue"><tt>Define Output Zone</tt></font>/<font color="blue"><tt>End Define</tt></font> definition block.
|-
| '''2d_po_empty''' || <font color="blue"><tt>Read GIS PO</tt></font> <font color="red"><tt>==</tt></font>  || This file contains lines and points defining plot output (PO) locations for 2D result time series graphs in Excel. PO only extracts results from 2D portions of the model. 1D results are ignored.
|-
| '''0d_rl_empty''' || <font color="blue"><tt>Read GIS Reporting Location</tt></font> <font color="red"><tt>==</tt></font>  || This file contains lines and points defining Reporting Location(s) (RL) for 1D and 2D result time series graphs in Excel.
|-  
| rowspan=2| '''1d_wllp_empty''' ||   <font color="blue"><tt>Read GIS XP WLL Points</tt></font> <font color="red"><tt>==</tt></font>  ||rowspan=2| Used to define the elevations (usually from a DTM) and material values across the WLLs. This offers high quality viewing and mapping of the 1D domains.
|-
| <font color="blue"><tt>Read GIS X1D WLL Points</tt></font> <font color="red"><tt>==</tt></font> 
|-
| colspan=3| ''Note: Template shapefiles will also include a suffix describing the object type:<br> 
''_L = Lines features'' <br> 
''_P = Point features'' <br>
''_R = Region (polygon) features'' <br>
|-
|}

==ESTRY Control file (ECF)==
{| class="wikitable" width="75%"
! style="background-color:#005581; font-weight:bold; color:white;" width=20%| Template (empty) GIS File 
! style="background-color:#005581; font-weight:bold; color:white;" width=25%| Compatible TUFLOW Commands
! style="background-color:#005581; font-weight:bold; color:white"| File / Command Function
|-
| '''1d_bc_empty''' ||  <font color="blue"><tt>Read GIS BC </tt></font> <font color="red"><tt>==</tt></font>  || Used to define the location and type of 1D boundary condition input.
|-
| '''1d_iwl_empty''' ||  <font color="blue"><tt>Read GIS IWL </tt></font> <font color="red"><tt>==</tt></font>  || Used to set the initial water level within a 1D channel or node at the start of a simulation. 
|-
| '''1d_lc_empty''' || <font color="blue"><tt>Read GIS Table Links </tt></font> <font color="red"><tt>==</tt></font> || Used to provide links to tabular data of loss versus height coefficients at a structure. The LC stands for Loss Coefficients. 
|-
| '''1d_mh_empty''' ||  <font color="blue"><tt>Read GIS Manhole </tt></font> <font color="red"><tt>==</tt></font>  || Used to define manhole locations and attributes.
|-
| '''1d_na_empty''' ||  <font color="blue"><tt>Read GIS Node </tt></font> <font color="red"><tt>==</tt></font> || Used to set nodal surface areas. 
|-
| '''1d_nd_empty''' ||  <font color="blue"><tt>Read GIS Node </tt></font> <font color="red"><tt>==</tt></font> || Used to define 1D node locations and attributes. 
|-
| '''1d_nwk_empty''' ||  <font color="blue"><tt>Read GIS Network </tt></font> <font color="red"><tt>==</tt></font>  || Used to define channel and node locations and attributes. Common channel types include, open channels, culverts, bridges, weirs. 
|-
| '''1d_nwkb_empty''' ||   <font color="blue"><tt>Read GIS Network </tt></font> <font color="red"><tt>==</tt></font>  ||  Used to define channel and node locations and attributes. Common channel types include, open channels, culverts, bridges, weirs. The difference between the 1d_nwkb and standard 1d_nwk is that the pblockage attribute field accepts characters allowing the user to input matrix blockage.
|-
| '''1d_nwke_empty''' ||   <font color="blue"><tt>Read GIS Network </tt></font> <font color="red"><tt>==</tt></font>  ||  Used to define grouped structure locations and attributes. For example,  weirs representing overtopping of a bridge or culvert structure can be specified using a single GIS feature in the 1d_nwke file. By comparison, multiple line features would be required if the same input was defined in a 1d_nwk file. 
|-
| '''1d_pit_empty''' ||   <font color="blue"><tt>Read GIS Pits </tt></font> <font color="red"><tt>==</tt></font>  || Defines the location and attributes associated with virtual pipes for a GPU model.
|-
| '''1d_tab_empty''' ||   <font color="blue"><tt>Read GIS Table Links </tt></font> <font color="red"><tt>==</tt></font>  || Reads links to tabular inputs associated with cross-section profiles (1d_xs), nodal surface areas (1d_na) and bridge loss coefficients (1d_bg).  
|-
| '''1d_wll_empty''' || <font color="blue"><tt>Read GIS WLL </tt></font> <font color="red"><tt>==</tt></font> || Used to translate 1D results into 2D map output for viewing in SMS, WaterRide, Blue Kenu and GIS Software.  
|-
| '''1d_wllp_empty''' || <font color="blue"><tt>Read GIS WLL Points </tt></font> <font color="red"><tt>==</tt></font> || Used to define the elevations (usually from a DTM) and material values across the WLLs. This offers high quality viewing and mapping of the 1D domains.
|-
| '''1d_xs_empty''' || <font color="blue"><tt>Read GIS Table Links </tt></font> <font color="red"><tt>==</tt></font> || Used to set cross-section profiles and hydraulic properties.   
|-  
| colspan=3| ''Note: Template shapefiles will also include a suffix describing the object type:<br> 
''_L = Lines features'' <br> 
''_P = Point features'' <br>
''_R = Region (polygon) features'' <br>
|-
|}

==TUFLOW Geometry Control file (TGC)==
{| class="wikitable" width="75%"
! style="background-color:#005581; font-weight:bold; color:white;" width=20%| Template (empty) GIS File 
! style="background-color:#005581; font-weight:bold; color:white;" width=25%| Compatible TUFLOW Commands
! style="background-color:#005581; font-weight:bold; color:white"| File / Command Function
|-
| '''2d_ad_ic_empty''' || <font color="blue"><tt>Read GIS IGW Conc Layer N1,N2,...N Tracer M1,M2,...M</font><font color="red"> ==</tt></font> || Sets the spatial distribution (polygons) of the initial concentrations for a given tracer (M1,M2,..,M) in the TUFLOW AD module. This layer is read into the initial condition field of the AD Global Database (.csv) file.<br>
|-
| '''2d_ad_md_empty''' || <font color="blue"><tt>Read GIS IGW Conc Layer N1,N2,...N Tracer M1,M2,...M</font><font color="red"> ==</tt></font> || Sets the spatial distribution (polygons) of the minimum dispersion coefficients for a given tracer (M1,M2,...,M) in the TUFLOW AD module. This layer is read into the minimum dispersion field of the AD Global Database (.csv) file.<br>
|-
| rowspan=2|'''2d_bc_empty''' ||  <font color="blue"><tt>Read GIS Code BC</tt></font> <font color="red"><tt>==</tt></font> || Used to set the code status of a cell (active or inactive). <br>
''This is an alternative method to: "2d_code_empty / <font color="blue"><tt>Read GIS Code</tt></font> <font color="red"><tt>==</tt></font>".<br>'' 
''Note: "2d_bc_empty" '''<u>CANNOT</u>''' be used with <font color="blue"><tt>Read GIS Code</tt></font> <font color="red"><tt>==</tt></font>'' 
|-
| <font color="blue"><tt>Read GIS Z HX Line</tt></font> <font color="red"><tt>==</tt></font>  ||  Used in combination with 2d_bc (HX) layer from the TBC to set the cell elevations along HX lines at the interface between 1D channels nested with a 2D domain. 
|-
| '''2d_bg_empty''' || rowspan=2| <font color="blue"><tt>Read GIS BG Shape</tt></font> <font color="red"><tt>==</tt></font> || rowspan=2| Used for 2D flow constrictions to represent additional losses associated with bridges or box culverts. This input includes accounts for flow above and below the bridge obvert (soffit).
|-
| '''2d_bg_empty_pts''' 
|-.
|-
| rowspan=2|'''2d_code_empty''' ||  <font color="blue"><tt>Read GIS Code</tt></font> <font color="red"><tt>==</tt></font>  ||  Used to set the code status of a cell (1 = active or 0 = inactive). 
|-
| <font color="blue"><tt>Read GIS Code INVERT</tt></font> <font color="red"><tt>==</tt></font> || Used to set the code status of a cell (active or inactive). The inverse value defined by the <font color="blue"><tt>Read GIS Code</tt></font> <font color="red"><tt>==</tt></font> is applied. This feature is most commonly used during in multiple domain 2D2D models, as discussed in <u>[[TUFLOW_2D2D_BC_Advice|Multiple 2D Modelling Advice]]</u>.
|-
|'''2d_cwf_empty''' ||   <font color="blue"><tt>Read GIS CWF</tt></font> <font color="red"><tt>==</tt></font>  || Used to define location to reduced 2D cell flow width. 
|-
| '''2d_fcsh_empty''' ||  <font color="blue"><tt>Read GIS FC Shape</tt></font> <font color="red"><tt>==</tt></font> || Used for 2D flow constrictions to represent additional losses associated with bridges or box culverts. This input only account for flow below the bridge obvert (soffit).
|-
| '''2d_flc_empty''' ||  <font color="blue"><tt>Read GIS FLC </tt></font> <font color="red"><tt>==</tt></font> || Used to apply an additional energy loss at the 2D cell side. The form or energy loss can be applied as fixed values or on a form loss per unit length basis.
|-
| rowspan=2|'''2d_gw_empty''' || <font color="blue"><tt>Read GIS GWL</tt></font> <font color="red"><tt>==</tt></font> || rowspan=2| Ground water level inputs.
|-
| <font color="blue"><tt>Read GIS GWD</tt></font> <font color="red"><tt>==</tt></font> 
|-
| '''2d_hx_empty''' || <font color="blue"><tt>Read GIS Z Line</tt></font> <font color="red"><tt>==</tt></font> || Used to define the locations of 2D boundaries and 2D/1D dynamic links. For large models it may be wise to separate the boundary conditions from the 1D/2D links, in which case the 2d_bc prefix can be substituted with 2d_hx_ and 2d_sx_. Cell code values may also be defined in this layer.
|-
| '''2d_iwl_empty''' || <font color="blue"><tt>Read GIS IWL</tt></font> <font color="red"><tt>==</tt></font> || Sets the initial water level in the model at the start of the simulation. The initial water level can vary spatially within the model. An equivalent initial Water level command also exists in the TCF. 
|-
| '''2d_Ifcsh_empty''' || rowspan=2| <font color="blue"><tt>Read GIS Layered FC Shape</tt></font> <font color="red"><tt>==</tt></font> || rowspan=2| Used for 2D flow constrictions to represent additional losses associated with bridges or box culverts. This input includes accounts for flow above and below the bridge obvert (soffit).
|-
| '''2d_lfcsh_empty_pts''' 
|-.
| '''2d_loc_empty''' || <font color="blue"><tt>Read GIS Location</tt></font> <font color="red"><tt>==</tt></font> || Used to define the 2D mesh (grid) origin and orientation.
|-
| '''2d_mat_empty''' || <font color="blue"><tt>Read GIS MAT</tt></font> <font color="red"><tt>==</tt></font>|| Used to define 2D materials (land use) inputs.
|-
| '''2d_obj_empty''' || <font color="blue"><tt>Read GIS Objects</tt></font> <font color="red"><tt>==</tt></font>|| Used to represent receptors (such as properties or buildings). TUFLOW records the flood level and simulation time at one or more gauge(s) when receptors are first inundated above their trigger inundation levels (e.g. floor levels).
|-
| '''2d_rec_empty''' || <font color="blue"><tt>Read GIS Objects</tt></font> <font color="red"><tt>==</tt></font>|| Used to represent receptors (such as properties or buildings). TUFLOW records the flood level and simulation time at one or more gauge(s) when receptors are first inundated above their trigger inundation levels (e.g. floor levels).
|-
| '''2d_soil_empty''' || <font color="blue"><tt>Read GIS Soil</tt></font> <font color="red"><tt>==</tt></font> || Used to define 2D soil type inputs for infiltration parameterisation.
|-
| '''2d_sx_empty''' || <font color="blue"><tt>Read GIS Z Line</tt></font> <font color="red"><tt>==</tt></font> || Used to define the locations of 2D boundaries and 2D/1D dynamic links. For large models it may be wise to separate the boundary conditions from the 1D/2D links, in which case the 2d_bc prefix can be substituted with 2d_hx_ and 2d_sx_. Cell code values may also be defined in this layer.
|-
| '''2d_vzsh_empty''' || <font color="blue"><tt>Read GIS Variable Z Shape</tt></font> <font color="red"><tt>==</tt></font> || Used to define the final 3D shape of the Zpts at the completion of a breach, or other change in topographic shape, during a simulation.  
|-
| '''2d_wrf_empty''' || <font color="blue"><tt>Read GIS Wrf</tt></font> <font color="red"><tt>==</tt></font> || Used to adjust the weir factor locally, e.g. faces along a road embankment.
|-
| '''2d_z_empty''' || <font color="blue"><tt>Read GIS Z Line</tt></font> <font color="red"><tt>==</tt></font> || Used to update topography within a model. Polylines are treated as breaklines in the model’s topography (with the breakline height or elevation varying along its length).  This command has been superseded with the TGC commands: <br> <font color="blue"><tt>Read GIS GIS Z Shape</tt></font> <br> 
The template file and command only remain for the purpose of version backward compatibility.
|-
| '''2d_za_empty''' || <font color="blue"><tt>Read GIS Zpts</tt></font> <font color="red"><tt>==</tt></font> || Used to define areas (polygons) of elevations at a constant height. This file is typically created by renaming the 2d_z__empty file
|-
| '''2d_zlg_empty''' || <font color="blue"><tt>Read GIS Z Line</tt></font> <font color="red"><tt>==</tt></font> || Used to define the crest of ridges (e.g. levees, embankments) or thalweg of gullies (e.g. drains, creeks). Ridges and gullies cannot occur in the same layer so 2d_zlr_ is often used for ridges and 2d_zlg_ for gullies. These files are typically created by renaming the 2d_z__empty file.
|-
| '''2d_zln_empty''' || <font color="blue"><tt>Read GIS Z Line</tt></font> <font color="red"><tt>==</tt></font> || Used to define the crest of ridges (e.g. levees, embankments) or thalweg of gullies (e.g. drains, creeks). Ridges and gullies cannot occur in the same layer so 2d_zlr_ is often used for ridges and 2d_zlg_ for gullies. These files are typically created by renaming the 2d_z__empty file.
|-
| '''2d_zlr_empty''' || <font color="blue"><tt>Read GIS Z Line</tt></font> <font color="red"><tt>==</tt></font> || Used to define the crest of ridges (e.g. levees, embankments) or thalweg of gullies (e.g. drains, creeks). Ridges and gullies cannot occur in the same layer so 2d_zlr_ is often used for ridges and 2d_zlg_ for gullies. These files are typically created by renaming the 2d_z__empty file.
|-
| '''2d_zpt_empty''' || <font color="blue"><tt>Read GIS Zpts</tt></font> <font color="red"><tt>==</tt></font> || Used to define the elevations at the 2D cells mid-sides, corners and centres.
|-
| '''2d_zsh_empty''' || <font color="blue"><tt>Read GIS Z Shape</tt></font> <font color="red"><tt>==</tt></font> || Used to update topography within a model. Polylines are treated as breaklines in the model’s topography (with the breakline height or elevation varying along its length). Polygons and point features can be used to create TINs which are either independent of, or alternatively merge with the surrounding topography.
|-
| '''2d_zshr_empty''' || <font color="blue"><tt>Read GIS Z Shape Route</tt></font> <font color="red"><tt>==</tt></font> || Used to provide output on the degree of inundation along evacuation routes. This feature is useful during flood evacuation assessments. The model output includes details on warning time, flood hazard (e.g. depth and velocity) and duration that an evacuation route is isolated. 
|-
| '''2d_ztin_empty''' || <font color="blue"><tt>Read Grid Zpts</tt></font> <font color="red"><tt>==</tt></font> || Used to define 2D and 3D shapes for changing the elevations. Lines can be specified with a width (thickness), and polygons are used as the boundaries for creating TINs (triangulations).  
|-
| colspan=3| ''Note: Template shapefiles will also include a suffix describing the object type:<br> 
''_L = Lines features'' <br> 
''_P = Point features'' <br>
''_R = Region (polygon) features'' <br>
|-
|}

==TUFLOW Boundary Control file (TBC)==
{| class="wikitable" width="75%"
! style="background-color:#005581; font-weight:bold; color:white;" width=20%| Template (empty) GIS File 
! style="background-color:#005581; font-weight:bold; color:white;" width=25%| Compatible TUFLOW Commands
! style="background-color:#005581; font-weight:bold; color:white"| File / Command Function
|-
| '''2d_bc_empty''' || <font color="blue"><tt>Read GIS BC</tt></font> <font color="red"><tt>==</tt></font> || Used to define the location and attributes of 2D model boundary conditions. Including:
* External flow verse time boundaries
* External flow verse water level boundaries
* External water level verse time boundaries
* Internal 1D/2D connections
* Internal 2D/2D connections
|-
| '''2d_rf_empty''' || <font color="blue"><tt>Read GIS RF</tt></font> <font color="red"><tt>==</tt></font> || Used for ''"direct rainfall"'' modelling, also called ''"rainfall on grid"'' or ''"distributed hydrology"'' modelling.   
|-
| rowspan=2| '''2d_sa_empty''' || <font color="blue"><tt>Read GIS SA</tt></font> <font color="red"><tt>==</tt></font> || rowspan=2| Used to define the location of internal source area flow verse time boundaries.
|-
| <font color="blue"><tt>Read GIS Streams</tt></font> <font color="red"><tt>==</tt></font>
|-
| '''2d_sa_po_empty''' || <font color="blue"><tt>Read GIS SA PO</tt></font> <font color="red"><tt>==</tt></font> || Used to define areas (polygons) of seepage or infiltration that depend on varying water level or flow rate elsewhere in the model. This model input is used with the TCF command, <font color="blue"><tt>Read GIS PO</tt></font> <font color="red"><tt>==</tt></font>.
|-
| '''2d_sa_rf_empty''' || <font color="blue"><tt>Read GIS SA RF</tt></font> <font color="red"><tt>==</tt></font> ||Used to define the location of internal source area flow verse time boundaries. The model input is specified using rainfall hyetographs (mm versus hours) instead of flow hydrographs (flow verse time).
|-
| '''2d_sa_tr_empty''' || <font color="blue"><tt>Read GIS SA Trigger</tt></font> <font color="red"><tt>==</tt></font> ||  Used to define the polygons of sub-catchment areas for applying a source (flow) or rainfall directly onto 2D domains. 2d_sa_tr includes additional attributes required for the SA Trigger option.
|-
| '''2d_strm_empty''' || <font color="blue"><tt>Read GIS Streams</tt></font> <font color="red"><tt>==</tt></font> || Used to define streamlines that are used in conjunction with the '<font color="blue"><tt>Read GIS SA</tt></font>' or '<font color="blue"><tt>Read GIS SA Stream Only</tt></font>' commands.
|-
| colspan=3| ''Note: Template shapefiles will also include a suffix describing the object type:<br> 
''_L = Lines features'' <br> 
''_P = Point features'' <br>
''_R = Region (polygon) features'' <br>
|-
|}

==TUFLOW Quadtree Control File (QCF)==
{| class="wikitable" width="75%"
! style="background-color:#005581; font-weight:bold; color:white;" width=20%| Template (empty) GIS File 
! style="background-color:#005581; font-weight:bold; color:white;" width=25%| Compatible TUFLOW Commands
! style="background-color:#005581; font-weight:bold; color:white"| File / Command Function
|-
| '''2d_qnl_empty''' ||  <font color="blue"><tt>Read GIS Nesting </tt></font> <font color="red"><tt>==</tt></font>  || Used to define polygons of mesh refinement (different levels).
|-

| colspan=3| ''Note: Template shapefiles will also include a suffix describing the object type:<br> 
''_L = Lines features'' <br> 
''_P = Point features'' <br>
''_R = Region (polygon) features'' <br>
|-
|}

<br>
<br>
{{Tips Navigation
|uplink=[[ TUFLOW_Modelling_Guidance | Back to TUFLOW Modelling Guidance]]
}}