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 specific GIS file formats associated with specific TUFLOW commands. For example, the '''1d_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:<br>
[[File: TUFLOW_Empty_File_ZShape_Format.PNG]]<br>

Because of the file format requirement, the first task in any modelling project is to write template (empty) GIS files (as demonstrated in [[Tutorial_Module01#Project_Initialisation|Tutorial Module 1]]). 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>

==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_fc_empty''' ||   <font color="blue"><tt>Read GIS FC</tt></font> <font color="red"><tt>==</tt></font>  || File 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>  || This file is 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>  || This file 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 containing 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 containing one or more polygons that define the regions to be output. this model inputs are used with the command <font color="blue"><tt>Model Output Zones</tt></font>.
|-
| '''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.
|-
| '''0d_rl_empty''' || <font color="blue"><tt>Read GIS Reporting Location</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 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>  || 
|-
| '''1d_iwl_empty''' ||  <font color="blue"><tt>Read GIS IWL </tt></font> <font color="red"><tt>==</tt></font>  || 
|-
| '''1d_mh_empty''' ||  <font color="blue"><tt>Read GIS Manhole </tt></font> <font color="red"><tt>==</tt></font>  || 
|-
| '''1d_nd_empty''' ||  <font color="blue"><tt>Read GIS Node </tt></font> <font color="red"><tt>==</tt></font> || 
|-
| '''1d_nwk_empty''' ||  <font color="blue"><tt>Read GIS Network </tt></font> <font color="red"><tt>==</tt></font>  || 
|-
| '''1d_nwke_empty''' ||   <font color="blue"><tt>Read GIS Network </tt></font> <font color="red"><tt>==</tt></font>  || 
|-
| '''1d_pit_empty''' ||   <font color="blue"><tt>Read GIS Pits </tt></font> <font color="red"><tt>==</tt></font>  || 
|-
| '''1d_tab_empty''' ||   <font color="blue"><tt>Read GIS Table Links </tt></font> <font color="red"><tt>==</tt></font>  || 
|-
| '''1d_WLL_empty''' || <font color="blue"><tt>Read GIS WLL </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 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
|-
| rowspan=2|'''2d_bc_empty''' ||  <font color="blue"><tt>Read GIS Code BC</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>  || 
|-
| rowspan=2|'''2d_code_empty''' ||  <font color="blue"><tt>Read GIS Code</tt></font> <font color="red"><tt>==</tt></font>  || 
|-
| <font color="blue"><tt>Read GIS Code INVERT</tt></font> <font color="red"><tt>==</tt></font> || 
|-
| '''2d_fcsh_empty''' ||  <font color="blue"><tt>Read GIS FC Shape</tt></font> <font color="red"><tt>==</tt></font> || 
|-
| rowspan=2|'''2d_gw_empty''' || <font color="blue"><tt>Read GIS GWL</tt></font> <font color="red"><tt>==</tt></font> || 
|-
| <font color="blue"><tt>Read GIS GWD</tt></font> <font color="red"><tt>==</tt></font> || 
|-
| '''2d_iwl_empty''' || <font color="blue"><tt>Read GIS IWL</tt></font> <font color="red"><tt>==</tt></font> || 
|-
| '''2d_Ifcsh_empty''' || <font color="blue"><tt>Read GIS Layered FC Shape</tt></font> <font color="red"><tt>==</tt></font> || 
|-
| '''2d_lfcsh_empty_pts''' || <font color="blue"><tt>Read GIS Layered FC Shape</tt></font> <font color="red"><tt>==</tt></font> || 
|-
| '''2d_loc_empty''' || <font color="blue"><tt>Read GIS Location</tt></font> <font color="red"><tt>==</tt></font> || 
|-
| '''2d_mat_empty''' || <font color="blue"><tt>Read GIS MAT</tt></font> <font color="red"><tt>==</tt></font>|| 
|-
| '''2d_soil_empty''' || <font color="blue"><tt>Read GIS Soil</tt></font> <font color="red"><tt>==</tt></font> || 
|-
| '''2d_vzsh_empty''' || <font color="blue"><tt>Read GIS Variable Z Shape</tt></font> <font color="red"><tt>==</tt></font> || 
|-
| '''2d_z_empty''' || <font color="blue"><tt>Read GIS Z Line</tt></font> <font color="red"><tt>==</tt></font> || 
|-
| '''2d_zsh_empty''' || <font color="blue"><tt>Read GIS Z Shape</tt></font> <font color="red"><tt>==</tt></font> || 
|-
| '''2d_zshr_empty''' || <font color="blue"><tt>Read GIS Z Shape Route</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 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> || 
|-
| '''2d_rf_empty''' || <font color="blue"><tt>Read GIS RF</tt></font> <font color="red"><tt>==</tt></font> || 
|-
| rowspan=2| '''2d_sa_empty''' || <font color="blue"><tt>Read GIS SA</tt></font> <font color="red"><tt>==</tt></font> || 
|-
| <font color="blue"><tt>Read GIS Streams</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> || 
|-
| 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 features'' <br>
|-
|}