TUFLOW Empty Files

From Tuflow
Jump to navigation Jump to search

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 Read GIS Z Shape == command requires the following data fields:
TUFLOW Empty File ZShape Format.PNG

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

TUFLOW Control file (TCF)

Template (empty) GIS File Compatible TUFLOW Commands File / Command Function
2d_fc_empty Read GIS FC == File used for 2D flow constrictions, representing additional losses associated with bridges or box culverts. This command has been superseded with the TGC commands:
Read GIS FC Shape
Read GIS Layered FC Shape. The template file and command only remain for the purpose of version backward compatibility.
2d_glo_empty Read GIS GLO == 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 Read GIS IWL == 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 Read GIS LP ==
2d_oz_empty Read GIS Output Zone ==
2d_po_empty Read GIS PO ==
0d_rl_empty Read GIS Reporting Location ==
Note: Template shapefiles will also include a suffix describing the object type:

_L = Lines features
_P = Point features
_R = Region features

ESTRY Control file (ECF)

Template (empty) GIS File Compatible TUFLOW Commands File / Command Function
1d_bc_empty Read GIS BC ==
1d_iwl_empty Read GIS IWL ==
1d_mh_empty Read GIS Manhole ==
1d_nd_empty Read GIS Node ==
1d_nwk_empty Read GIS Network ==
1d_nwke_empty Read GIS Network ==
1d_pit_empty Read GIS Pits ==
1d_tab_empty Read GIS Table Links ==
1d_WLL_empty Read GIS WLL ==
Note: Template shapefiles will also include a suffix describing the object type:

_L = Lines features
_P = Point features
_R = Region features

TUFLOW Geometry Control file (*.tgc)

Template (empty) GIS File Compatible TUFLOW Commands File / Command Function
2d_bc_empty Read GIS Code BC ==
Read GIS Z HX Line ==
2d_code_empty Read GIS Code ==
Read GIS Code INVERT ==
2d_fcsh_empty Read GIS FC Shape ==
2d_gw_empty Read GIS GWL ==
Read GIS GWD ==
2d_iwl_empty Read GIS IWL ==
2d_Ifcsh_empty Read GIS Layered FC Shape ==
2d_lfcsh_empty_pts Read GIS Layered FC Shape ==
2d_loc_empty Read GIS Location ==
2d_mat_empty Read GIS MAT ==
2d_soil_empty Read GIS Soil ==
2d_vzsh_empty Read GIS Variable Z Shape ==
2d_z_empty Read GIS Z Line ==
2d_zsh_empty Read GIS Z Shape ==
2d_zshr_empty Read GIS Z Shape Route ==
Note: Template shapefiles will also include a suffix describing the object type:

_L = Lines features
_P = Point features
_R = Region features

TUFLOW Boundary Control file (*.tbc)

Template (empty) GIS File Compatible TUFLOW Commands File / Command Function
2d_bc_empty Read GIS BC ==
2d_rf_empty Read GIS RF ==
2d_sa_empty Read GIS SA ==
Read GIS Streams ==
2d_sa_rf_empty Read GIS SA RF ==
Note: Template shapefiles will also include a suffix describing the object type:

_L = Lines features
_P = Point features
_R = Region features