Difference between revisions of "TUFLOW Empty Files"

From Tuflow
Jump to navigation Jump to search
Line 40: Line 40:
 
! style="background-color:#005581; font-weight:bold; color:white"| File / Command Function
 
! 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_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>  ||  
+
| '''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_mh_empty''' ||  <font color="blue"><tt>Read GIS Manhole </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>  || Used to define manhole locations and attributes.
 
|-
 
|-
| '''1d_nd_empty''' ||  <font color="blue"><tt>Read GIS Node </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> || 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>  ||  
+
| '''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_nwke_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>  || 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>  ||  
+
| '''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>  ||  
+
| '''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> ||  
+
| '''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. 
 
|-
 
|-
 
| colspan=3| ''Note: Template shapefiles will also include a suffix describing the object type:<br>  
 
| colspan=3| ''Note: Template shapefiles will also include a suffix describing the object type:<br>  

Revision as of 15:35, 9 January 2017

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 == 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 == 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 == 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 == This file contains details on the location of longitudinal profile outputs.
2d_oz_empty Read GIS Output Zone == This file contains one or more polygons defining the 2D regions to be output. This model input is used with the command Model Output Zones.
2d_po_empty Read GIS PO == 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 Read GIS Reporting Location == This file contains lines and points defining plot output (PO) locations for 1D and 2D result time series graphs in Excel.
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 == Used to define the location and type of 1D boundary condition input
1d_iwl_empty Read GIS IWL == Used to set the initial water level within a 1D channel or node at the start of a simulation .
1d_mh_empty Read GIS Manhole == Used to define manhole locations and attributes.
1d_nd_empty Read GIS Node == Used to define 1D node locations and attributes.
1d_nwk_empty Read GIS Network == Used to define channel and node locations and attributes. Common channel types include, open channels, culverts, bridges, weirs.
1d_nwke_empty Read GIS Network == 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 Read GIS Pits == Defines the location and attributes associated with virtual pipes for a GPU model.
1d_tab_empty Read GIS Table Links == 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 Read GIS WLL == Used to translate 1D results into 2D map output for viewing in SMS, WaterRide, Blue Kenu and GIS Software.
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


Return to Tutorial Module 1