TUFLOW Check Files: Difference between revisions
Content deleted Content added
Steph.dufour (talk | contribs) No edit summary |
|||
| (50 intermediate revisions by 6 users not shown) | |||
Line 1:
<br>▼
<br>▼
=Introduction=
If the <font color="blue"><tt>Write Check Files </tt></font> <font color="red"><tt>==</tt></font> command is included in the .tcf (2D check files) and/or .ecf (1D check files) will be output from TUFLOW. These are a series of output files in both GIS (MapInfo or Shapefile format) and tabular data in .csv format. These check files contain information on the data processed by TUFLOW, for example the _zpt_check file contains the final elevation at each zpt in the model.
Line 25 ⟶ 21:
Depending on the size of the model, the check files may contain a large amount of data, for example the _grd_check file may contain thousands or millions of cells. As a modeller you probably won't inspect each cell to ensure that the data is value, however you may want to view this for the entire model. Thematic mapping or styling the input layers can be used in your GIS software to do this.
Some tips are given below for a range of GIS platforms, however, the functionality is likely to be available in almost all GIS platforms:<br>
* [[MapInfo_Style_Check_Files | MapInfo style check files]]
=Check File Types=
The check files are separated into 2D and 1D check files. The output location for these is controlled by commands in the .tcf and .ecf as described above. Not all check file types will be output for all models, if a model has no 2D Z Shape (2d_zsh) format topography modifiers then the _zsh_zpt check file type will not be output by TUFLOW. A list of the check file types is provided below. For more information on each of these please click on the page link.<br>
Line 33 ⟶ 28:
==2D Check Files==
The table below contains a complete list of the 2D check files. Note that for linked 2D/1D or 2D/2D models these check files are outlined in the sections below.
{|
!
! width=75% style="background-color:#005581; font-weight:bold; color:white;"
|-
!colspan="2" | Tabular Check Files
| [[Check_Files_2d_bc_tables | _2d_bc_tables_check.csv]]|| Tabular data as read from the boundary condition database via any 2d_bc layers and after any adjustments (eg. time shift). Provides traceability to original data source. '''Note: the boundary values do not include the effects of any 2d_bc attributes such as f.'''▼
|-
▲| [[Check_Files_2d_bc_tables | _2d_bc_tables_check
| [[Check_Files_2d_bcc_check | _bcc_check.mif<br>_bcc_check_R.shp<br>]]|| GIS files providing trace back information and uses cells, rather than point/line objects to show 2D BCs.▼
|-
!colspan="2" | Raster Check Files
| [[Check_Files_2d_DEM_M | _DEM_M.flt<br>_DEM_M.asc]]|| A DEM of the final material ID values, similar to the DEM_Z check grid described below. The .tcf command Grid Format can be used output this check file in ASCII format rather than the default FLT format.▼
|-
▲|
| [[Check_Files_2d_DEM_Z | _DEM_Z.flt<br>_DEM_Z.asc]]|| A DEM of the final ground/bathymetry elevations, including those from any 1D WLL mesh. The file is given a DEM_Z extension, and can be readily opened by most GIS and other GUIs. The default size of the grid cells is half the smallest 2D cell size. This can be changed using the <font color="blue"><tt>Grid Output Cell Size </tt></font> <font color="red"><tt>==</tt></font> command. To exclude writing this file, include “DEM_Z” in the Write Check Files EXCLUDE list. The <font color="blue"><tt>Grid Format </tt></font> <font color="red"><tt>==</tt></font> command can be used to control the format of the file. <br>▼
The DEM_M and DEM_Z check grids are written if the model start up is forced to only process the .tgc file. To do this, don’t specify or comment out, the BC Control File command.▼
|-
▲|
| [[Check_Files_2d_dom | _dom_check.mif<br>_dom_check_R.shp]]|| Contains a rectangle for each 2D domain showing the location, orientation and size of the domain. Within this domain, cells can be turned on or off, outside this domain no 2D calculations can be performed.▼
▲The DEM_M and DEM_Z check grids are written if the model start up is forced to only process the .tgc file. To do this, don’t specify or comment out, the <font color="blue"><tt> BC Control File </tt></font> command.
|-
|[[Check_Files_2d_DEM_Zmin | _DEM_Zmin]]|| A DEM based on the minimum SGS elevations. This file is only produced when running a model with SGS. The .tcf command <font color="blue"><tt>Grid Format </tt></font> can be used output this check file in ASCII (ASC) or binary (FLT) format rather than the default GeoTIFF (TIF) format.
| [[Check_Files_2d_fc | _fc_check.mif<br>_fc_check_R.shp]]|| GIS layer of the final arrangement of flow constrictions (FC). The flow constrictions are written as individual square cells of the same shape as the grid cells, even if the FC was specified using points or lines/polylines.▼
|-
|[[Check_Files_2d_DEM_Z_HR | _DEM_Z_HR]]|| A DEM based on the SGS elevations. This file is only produced when running a model with SGS and high resolution outputs. The .tcf command <font color="blue"><tt>Grid Format </tt></font> can be used output this check file in ASCII (ASC) or binary (FLT) format rather than the default GeoTIFF (TIF) format.
| [[Check_Files_2d_fcsh_uvpt | _fcsh_uvpt_check.mif<br>_fcsh_uvpt_check_P.shp]]|| Contains information on adjustments to the ZU/ZV cell sides as modified by <font color="blue"><tt>Read GIS FC Shape </tt></font> <font color="red"><tt>==</tt></font> commands.▼
|-
! colspan="2" | Vector Check Files
| [[Check_Files_2d_glo | _glo_check.mif<br>_glo_check_P.shp]]|| GIS layer of any gauge level output (GLO) locations.▼
|-
|[[Check_Files_2d_ad_check | _ad_check]]|| Contains information on initial conditions when using the advection-dispersion module.
| [[Check_Files_2d_grd | _grd_check.mif<br>_grd_check_R.shp]]|| GIS layer of the final 2D grid. Represents the final grid including modifications from the .tgc file, boundary specifications and flow constrictions. Note that the Material and bed resistance (eg. Mannings_n) attributes do not include any modifications due to flow constrictions as these are applied directly to the cell mid-sides (rather than the cell centre). To view these use the _uvpt_check.mif/.shp file.<br>▼
|-
|[[Check_Files_2d_bg_uvpt_check | _bg_uvpt_check]]|| Contains information on adjustments to the ZU/ZV cell sides as modified by <font color="blue"><tt>Read GIS BG Shape</tt></font> <font color="red"><tt> ==</tt></font> command.
|-
▲| [[Check_Files_2d_bcc_check | _bcc_check
|-
▲| [[Check_Files_2d_dom | _dom_check
|-
▲| [[Check_Files_2d_fc | _fc_check
|-
▲| [[Check_Files_2d_fcsh_uvpt | _fcsh_uvpt_check
|-
▲| [[Check_Files_2d_glo | _glo_check
|-
▲| [[Check_Files_2d_grd | _grd_check
Can also be written at different stages within a .tgc file (see <font color="blue"><tt>Write GIS Grid </tt></font> <font color="red"><tt>==</tt></font> command). The file contains all modifications to the 2D grid at the point in the .tgc file that it is written. <br>
Note that a number of additional attributes are appended to the_grd_check layer when some features of TUFLOW have been used.
|-
| [[Check_Files_2d_input_layers | _input_layers
|-
| [[Check_Files_2d_lfcsh_uvpt | _lfcsh_uvpt_check
|-
| [[Check_Files_2d_LP | _lp_check
|-
| [[Check_Files_2d_PO | _po_check
|-
| [[Check_Files_2d_sac | _sac_check
|-
| [[Check_Files_2d_sh_obj | _sh_obj_check
|-
| [[Check_Files_2d_uvpt | _uvpt_check
|-
| [[Check_Files_2d_vzsh | _vzsh_check
|-
| [[Check_Files_2d_zln_zpt | _zln_zpt_check
|-
| [[Check_Files_2d_zpt | _zpt_check
Can also be written at different stages within a .tgc file (see the <font color="blue"><tt>Write GIS Zpts</tt></font> command). The file contains all modifications to the 2D Zpts at the point in the .tgc file that it is written. This allows checking of the elevations at different stages of building the topography.
|-
| [[Check_Files_2d_zsh_zpt | _zsh_zpt_check
|}
==1D Check Files==
The table below contains a complete list of 1D check files.<br>
{|
! style="background-color:#005581; font-weight:bold; color:white;" | Filename prefix / suffix
! style="background-color:#005581; font-weight:bold; color:white;" width=75% | Brief Description
|-
!colspan="2" | Tabular Check Files
|-
|
|-
|
|-
|
▲| [[Check_Files_1d_bc_tables | _1d_bc_tables_check.csv]]|| Contains the tabular boundary data for the 1D section of the model.
|-
|[[Check_Files_Str_Grp | _Str_Grp_All<br>_Str_Grp_Multi]]|| .csv file containing information on the structure groups.
▲| [[ Check_Files_1d_pit_inlet_tables |_pit_inlet_tables_check.csv]]|| Similar to the _1d_bc_tables_check.csv. It contains tabular data as read from the pit inlet database.
|-
! colspan="2" | Vector Check Files
▲| [[Check_Files_1d_ta_tables | 1d_ta_tables_check.csv]]|| Tabular data as read from tables via the 1d_tab layers for cross-section, storage and other data. Provides full traceability to original data source and additional information such as hydraulic properties determined from a cross-section profile. Flood Modeller XZ processed, and MIKE 11 processed cross-section data included. Refer also to the _xsl_check layer.
|-
| [[Check_Files_1d_bc_check |
|-
| [[Check_Files_1d_hydroprop | _hydroprop_check
|-
| [[Check_Files_1d_inverts | _inverts_check
|-
| [[Check_Files_1d_IWL | _iwl_check
|-
| [[Check_Files_1d_mhc | _mhc_check
|-
| [[Check_Files_1d_nwk_C | _nwk_C_check
Any generated pit channels are shown as a small channel flowing from north to south into the pit node. The upstream pit channel node that is generated is also shown. The length of the pit channel is controlled by <font color="blue"><tt>Pit Channel Offset </tt></font> <font color="red"><tt>==</tt></font> command.
|-
| [[Check_Files_1d_nwk_N | _nwk_N_check
|-
| [[ Check_Files_1d_pit_A |_pit_A_check]]|| GIS layer of the 1D pit details.
| [[Check_Files_1d_WLLo | _WLLo_check.mif<br>_WLLo_check_L.shp<br>_xWLLo_check.mif<br>_xWLLo_check_L.shp]]|| GIS layer of all the WLL objects read. The attributes provide information on which nodes that area associated with, etc. <br>▼
|-
▲| [[Check_Files_1d_WLLo | _WLLo_check
The _WLLo_check layers are written for ESTRY 1D domains, whereas the _xWLLo_check layers are written for external 1D domains, such as Flood Modeller or XP-SWMM.
|-
| [[Check_Files_1d_WLLp | _WLLp_check
The _WLLp_check layers are written for ESTRY 1D domains, whereas the _xWLLp_check layers are written for external 1D domains, such as Flood Modeller or XP-SWMM.
|-
| [[Check_Files_1d_xsl | _xsl_check
|-
| [[Check_Files_1d_x1d_chans | _x1d_chans_check
|-
| [[Check_Files_1d_x1d_nodes | _x1d_nodes_check
|}
==2D / 1D Check Files==
The following check files will only be produced if a linked 1D / 2D model is created.
{|
! style="background-color:#005581; font-weight:bold; color:white;" | Filename prefix / suffix
! style="background-color:#005581; font-weight:bold; color:white;" width=75%| Brief Description
|-
!colspan="2" | Tabular Check Files
| [[Check_Files_1d_to_2d_bc | _1d_to_2d_check.mif<br>_1d_to_2d_check_R.shp]]|| Displays the 2D cells connected to 1D nodes via 2D HX and 2D SX 2d_bc objects. For the .mif/.mid format cells connected to the same node are given the same colour to allow for easy visualisation of whether the right connections have been made. Additional information is supplied through the attributes.<br>▼
In the .mif layer, all SX cells connected to the same 1D node are grouped together as one object, and the Lowest_ZC_2D value is the lowest 2D cell ZC value of all the cells connected to the 1D node. For the .shp layer, it’s not possible to group the cells as one object, so each cell is separate, and therefore, when clicking on the SX cells, note that the value is still the lowest ZC of all 2D cells, not of the individual cell. For 2D HX links, the value is the ZC value of the individual cell.▼
|-
| [[
|-
!colspan="2" | Vector Check Files
|-
▲| [[Check_Files_1d_to_2d_bc | _1d_to_2d_check
▲In the
|-
| [[Check_Files_1d_to_2d_gw | _1d_to_2d_gw_check]]|| Displays the 2D cells connected to 1D nodes via SX boundaries representing groundwater connections (as defined in the 2d_bc layer using the "GW" flag).
|}
==2D / 2D Check Files==
The following check files will only be produced if a multiple 2D Domain (linked 2D / 2D model) is created.
{|
! style="background-color:#005581; font-weight:bold; color:white;" | Filename prefix / suffix
! style="background-color:#005581; font-weight:bold; color:white;" width=75%| Brief Description
|-
!colspan="2" | Vector Check Files
| [[Check_Files_2d_to_2d_bc | _2d_to_2d_check.mif<br>_2d_to_2d_check_R.shp]]|| Displays the 2D cells used to link two 2D domains together via a 2d_bc type “2D” boundary. Similar to the _1d_to_2d_check layer, the cells connected to the same hidden 1D node are given the same colour when using the .mif/.mid format. Use the command <font color="blue"><tt>Reveal 1D Nodes</tt></font> <font color="red"><tt>==</tt></font> <tt>ON</tt> command in the .tcf to view the locations of the hidden 1D nodes. ▼
|-
▲| [[Check_Files_2d_to_2d_bc | _2d_to_2d_check
|}
= Common Questions Answered (FAQ)=
== My cross sections have various Manning's ''n'', but only one value is reported in 1d_ta_tables_check.csv. Is it applied correctly? ==
When the Manning’s ''n'' values differ throughout the cross section (N flag is specified), these are used to proportionally adjust the width of the cross section to an effective width and calculate the whole cross section as it has only one Manning’s ''n''. In the processed hydraulic properties part of the 1d_ta_tables_check.csv, the width is different to the effective width and the header of the last column K (conveyance) only shows a single Manning’s ''n'' value. The .eof file and nwk_C_check file will report one Manning's ''n'' and n_nf_cd value, the one that was used for the calculation of the effective width - bed elevation Manning's ''n''.<br>
Note: When an N flag is specified in XZ cross section, the n_nf_cd value in 1d_nwk layer becomes a Manning's ''n'' multiplier. It is usually set to 1 and could be used for calibration purposes.<br>
▲<br>
▲<br>
{{Tips Navigation
|uplink=[[ TUFLOW_Modelling_Guidance | Back to TUFLOW Modelling Guidance]]
}}
| |||