TUFLOW Check Files: Difference between revisions

Content deleted Content added
No edit summary
Line 31:
{| class="wikitable" width="75%"
 
! 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" style="background-color:#005581; font-weight:bold; color:white;"| 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.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_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" style="background-color:#005581; font-weight:bold; color:white;"| Raster Check Files
| [[Check_Files_2d_bg_uvpt_check | _bg_uvpt_check.mif<br>_bg_uvpt_check.shp]]|| 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_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.
|-
! colspan="2" style="background-color:#005581; font-weight:bold; color:white;" | Vector Check Files
| [[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.
|-
| [[Check_Files_2d_bg_uvpt_check | _bg_uvpt_check.mif<br>_bg_uvpt_check.shp]]|| 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_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_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.
| [[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.
|-
| [[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.
| [[Check_Files_2d_glo | _glo_check.mif<br>_glo_check_P.shp]]|| GIS layer of any gauge level output (GLO) locations.
|-
| [[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_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 [[Check_Files_2d_uvpt|_uvpt_check.mif/.shp file]].<br>
|-
| [[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.
|-
| [[Check_Files_2d_glo | _glo_check.mif<br>_glo_check_P.shp]]|| GIS layer of any gauge level output (GLO) locations.
|-
| [[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 [[Check_Files_2d_uvpt|_uvpt_check.mif/.shp file]].<br>
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.mif]]|| GIS layer containing full filepaths to all input layers used to compile the model.
|-
| [[Check_Files_2d_lfcsh_uvpt | _lfcsh_uvpt_check.mif<br>_lfcsh_uvpt_check_P.shp]]|| Contains information on adjustments to the ZU/ZV cell sides as modified by <font color="blue"><tt>Read GIS Layered FC Shape</tt></font> <font color="red"><tt>==</tt></font> commands.
|-
| [[Check_Files_2d_LP | _lp_check.mif<br>_lp_check_L.shp]]|| GIS layer of any 2D longitudinal profile(s).
|-
| [[Check_Files_2d_PO | _po_check.mif<br>_po_check_P.shp<br>_po_check_L.shp]]|| GIS layer of any 2D plot output location(s). The layer shows points and lines occurring from the cell centres, rather than their exact locations in the original file(s). For the shapefile the points and lines are output in separate files.
|-
| [[Check_Files_2d_sac | _sac_check.mif<br>_sac_check_R.shp]]|| GIS layer of the lowest cell selected for <font color="blue"><tt>Read GIS SA</tt></font> inputs, and cells selected if using <font color="blue"><tt>Read GIS SA PITS</tt></font>.
|-
| [[Check_Files_2d_sh_obj | _sh_obj_check.mif<br>_sh_obj_check_R.shp]]|| Contains objects such as buffer polygons used for wide lines, triangles generated for TINs within polygons, and regions and polylines for thick and thin lines to illustrate areas that have been modified by Create TIN Zpts (if the WRITE TIN option is specified), Read GIS Z Shape, Read GIS Variable Z Shape, Read GIS FC Shape and Read GIS Layered FC Shape commands.
|-
| [[Check_Files_2d_uvpt | _uvpt_check.mif<br>_uvpt_check_P.shp]]|| GIS layer containing the initial velocities, roughness value, FLC, WrF, FC lid depth and FC BD factor at the U and V points. For materials that vary Manning’s n with depth, the Manning_n attribute contains the Manning’s n value at the higher depth.
|-
| [[Check_Files_2d_vzsh | _vzsh_check.mif<br>_vzsh_check_P.shp<br>_vzsh_check_L.shp]]|| Contains information on Zpts that have been modified by <font color="blue"><tt>Read GIS Variable Z Shape </tt></font> <font color="red"><tt>==</tt></font> commands.
|-
| [[Check_Files_2d_zln_zpt | _zln_zpt_check.mif<br>_zln_zpt_check_P.shp]]|| GIS layer containing Zpts that have been modified by <font color="blue"><tt>Read GIS Z Line </tt></font> <font color="red"><tt>==</tt></font> commands, the type of Z Line and the Z Line filename. This feature is very useful for checking which Zpts that the Z Lines have modified. '''Note: It does not include any GULLY lines.'''<br>
When written in .mif/.mid format, the points are given different symbology according to whether they have been raised or lowered (up or down triangles) or remain unchanged (a cross).
|-
| [[Check_Files_2d_zpt | _zpt_check.mif<br>_zpt_check_P.shp]]|| GIS layer of the final 2D Zpts. Represents the final Zpts including all modifications from the .tgc file, and any flow constrictions in the .tcf file.<br>
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.mif<br>_zsh_zpt_check_P.shp]]|| Contains Zpts that have been modified by <font color="blue"><tt>Read GIS Z Shape </tt></font> <font color="red"><tt>==</tt></font> commands. When written in .mif/.mid format, the points are given different symbology according to whether they have been raised or lowered (up or down triangles) or remain unchanged (a cross).
|}
 
Line 86 ⟶ 92:
{| class="wikitable" width="75%"
 
! 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" style="background-color:#005581; font-weight:bold; color:white;"| Tabular Check Files
| [[Check_Files_1d_bc_check | _1d_bc_check.mif<br>_1d_bc_check_P.shp]]|| GIS .mif/.mid or .shp files of the final 1D boundary conditions (BC). If no boundary conditions were specified, empty .mif/.mid or .shp files are written that can be used to set up a new layer.
|-
| [[Check_Files_1d_bc_tables | _1d_bc_tables_check.csv]]|| Contains the tabular boundary data for the 1D section of the model.
|-
| [[Check_Files_1d_pit_inlet_tables |_1d_pit_inlet_tables_check.csv]]|| Similar to the _1d_bc_tables_check.csv. It contains tabular data as read from the pit inlet database.
|-
| [[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 [[Check_Files_1d_xsl | _xsl_check]] layer.
|-
| [[Check_Files_Str_Grp | _Str_Grp_All.csv<br>_Str_Grp_Multi.csv]]|| .csv file containing information on the structure groups.
| [[Check_Files_1d_hydroprop | _hydroprop_check.mif<br>_hydroprop_check_L.shp]]|| Contains the hydraulic properties at the top of the hydraulic properties tables as attributes of the 1D channels. Other information such as the primary Manning’s n is also provided. Very useful for carrying out quality control checks on the 1D channels.
|-
! colspan="2" style="background-color:#005581; font-weight:bold; color:white;" | Vector Check Files
| [[Check_Files_1d_inverts | _inverts_check.mif<br>_inverts_check_P.shp]]|| Contains the inverts of the 1D nodes and at the ends of the 1D channels. Very useful for checking for smooth transitions from one channel to another and with the nodes.
|-
| [[Check_Files_1d_bc_check | _1d_bc_check.mif<br>_1d_bc_check_P.shp]]|| GIS .mif/.mid or .shp fileslayer of the final 1D boundary conditions (BC). If no boundary conditions were specified, empty .mif/.mid or .shp files are written that can be used to set up a new layer.
| [[Check_Files_1d_IWL | _iwl_check.mif<br>_iwl_check_P.shp]]|| GIS .mif/.mid or .shp files of the initial water levels at the 1D model nodes.
|-
| [[Check_Files_1d_hydroprop | _hydroprop_check.mif<br>_hydroprop_check_L.shp]]|| Contains the hydraulic properties at the top of the hydraulic properties tables as attributes of the 1D channels. Other information such as the primary Manning’s n is also provided. Very useful for carrying out quality control checks on the 1D channels.
| [[Check_Files_1d_mhc | _mhc_check.mif<br>_mhc_check_P.shp]]|| GIS layer of manholes including any automatically created manholes.
|-
| [[Check_Files_1d_nwk_CCheck_Files_1d_inverts | _nwk_C_check.mif_inverts_check<br>_nwk_C_check_L.shp_inverts_check_P]]|| GISContains .mif/.mid or .shpthe filesinverts of the final 1D modelnodes network.and at Thisthe checkends layer containsof the 1D channels. ofVery theuseful 1Dfor domainchecking only.for Thesmooth _nwk_N_checktransitions layerfrom containsone channel to another and with the nodes.<br>
|-
| [[Check_Files_1d_IWL | _iwl_check.mif<br>_iwl_check_P.shp]]|| GIS .mif/.mid or .shp fileslayer of the initial water levels at the 1D model nodes.
|-
| [[Check_Files_1d_mhc | _mhc_check.mif<br>_mhc_check_P.shp]]|| GIS layer of manholes including any automatically created manholes.
|-
| [[Check_Files_1d_nwk_C | _nwk_C_check<br>_nwk_C_check_L]]|| GIS layer of the final 1D model network. This check layer contains the channels of the 1D domain only. The _nwk_N_check layer contains the nodes.<br>
The layers lines are coloured based on the channel type (available for the .mid/.mif format only).<br>
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.mif<br>_nwk_N_check_P.shp]]|| GIS .mif/.mid or .shp fileslayer of the final 1D model network. This check layer contains the nodes of the 1D domain only. The _nwk_C_check layer contains the channels.<br>
The node symbology is displayed as a red circle for nodes connected to two or more channels, a larger magenta circle for nodes connected to one channel and a large yellow square for nodes not connected to a channel (available for the .mid/.mif format only). '''This is very useful for checking for channel ends or nodes that are not snapped.'''<br>
The top and bottom elevations of the NA table at nodes is now shown using the Upstream_Invert and Downstream_Invert attributes.
|-
| [[ Check_Files_1d_pit_A |_pit_A_check.mif<br>_pit_A_check_P.shp]]|| GIS layer of the 1D pit details.
|-
| [[Check_Files_Str_Grp | _Str_Grp_All.csv<br>_Str_Grp_Multi.csv]]|| .csv file containing information on the structure groups.
|-
| [[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>
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.mif<br>_WLLp_check_P.shp<br>_xWLLp_check.mif<br>_xWLLp_check_P.shp]]|| GIS layer of where the points were generated along the WLLs. These points can then be used for <font color="blue"><tt>Read GIS WLL Points</tt></font> <font color="red"><tt>==</tt></font> command.<br>
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.mif<br>_xsl_check_L.shp]]|| GIS layer containing tabular data as read from 1d_xs input layers. Contains the XS ID and other useful information on the cross-section properties, etc. Refer also to [[Check_Files_1d_ta_tables | _ta_tables_check.csv]].
|-
| [[Check_Files_1d_x1d_chans | _x1d_chans_check.mif<br>_x1d_chans_check_L.shp]]|| GIS layer containing the location of 1D channels from an external 1D domain.
|-
| [[Check_Files_1d_x1d_nodes | _x1d_nodes_check.mif<br>_x1d_nodes_check_P.shp]]|| GIS layer containing the location of 1D nodes from an external 1D domain.
|}
 
Line 134 ⟶ 144:
{| class="wikitable" width="75%"
 
! 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" style="background-color:#005581; font-weight:bold; color:white;"| 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 including SX boundaries from 1D features. 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, each cell is separate, 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.
|-
| [[Check_Files_x1D_to_2D.csv | _x1D_H_to_2D.csv<br>_x1D_H_from_2D.csv<br>_2D_Q_to_x1D.csv<br>_2D_Q_from_x1D.csv]]|| Contains the water levels sent to the 2D domain and the flows returned from the 2D to/from an external 1D scheme such as Flood Modeller or XP-SWMM. These files are only written when using the .tcf command <font color="blue"><tt>Write X1D Check Files</tt></font> <font color="red"><tt>==</tt></font> <tt>ON</tt>.<br>
|-
!colspan="2" style="background-color:#005581; font-weight:bold; color:white;"| Vector 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 including SX boundaries from 1D features. 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_1d_to_2d_check 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_1d_to_2d_check_R layer, it’s not possible to group the cells as one object, each cell is separate, 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.
|}
 
Line 147 ⟶ 161:
{| class="wikitable" width="75%"
 
! 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" style="background-color:#005581; font-weight:bold; color:white;"| 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 [[Check_Files_1d_to_2d_bc|_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.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 [[Check_Files_1d_to_2d_bc|_1d_to_2d_check layer]] 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.
|}
 
= 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? ==