Check Files 2d grd - Revision history

Emilie Nielsen at 05:43, 5 August 2025

2025-08-05T05:43:23Z

← Older revision		Revision as of 15:43, 5 August 2025
Line 1:		Line 1:
	== Introduction ==		== Introduction ==
	This page contains information on the _grd_check file. This file contains a region object for each active (cell code 1) or inactive (cell code -1) cell. A number of the output attributes are only written if certain model features are enabled. For example, the '''Soil_ID''' attribute is only included if any soil features are used in the model.<br>		This page contains information on the _grd_check file. This file contains a region object for each active (cell code 1) or inactive (cell code -1) cell. A number of the output attributes are only written if certain model features are enabled. For example, the '''Soil_ID''' attribute is only included if any soil features are used in the model.<br>

⚫	<br>
			There are variations in the output attributes for models using Sub-Grid Sampling (SGS) and/or Quadtree. These variations are noted below. <br>
	There are a number of attributes that are only output for TUFLOW GPU models. As the GPU model is a cell centred scheme, certain properties such as Manning's roughness and Form Loss are applied at the cell centre, whilst in TUFLOW these are applied at the cell side (refer to the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u> for a more detailed explanation). These GPU only attributes are noted in the table below.<br>

	== Attributes of grd_check ==		== Attributes of grd_check ==
Line 14:		Line 14:
	\| m\|\|Column number in the TUFLOW domain.		\| m\|\|Column number in the TUFLOW domain.
	\|-		\|-
	\| Code ~~(Classic/HPC only)~~\|\|The cell code status. This is 1 for active cells and -1 for null cells that are included in the mesh. Refer to the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u> for more information on the cell codes.		\| Code\|\|The cell code status. This is 1 for active cells and -1 for null cells that are included in the mesh. Refer to the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u> for more information on the cell codes.
	\|-		\|-
	\| Material\|\|The material ID.		\| Material\|\|The material ID.
Line 22:		Line 22:
	\| IWL\|\|The initial water level value. If the initial water level set in the model is below the cell elevation (ZC) or if no initial water level has been set, the cell elevation plus the model wet / dry depth is output. Note, this value is rounded to 3 decimal places.		\| IWL\|\|The initial water level value. If the initial water level set in the model is below the cell elevation (ZC) or if no initial water level has been set, the cell elevation plus the model wet / dry depth is output. Note, this value is rounded to 3 decimal places.
	\|-		\|-
	\| Domain_Index ~~(Classic/HPC only)~~\|\|The index of the model domain. This is the order with <tt><font color="blue">Start 2D Domain</font><font color="red"> == </font><Domain Name></tt> commands appears in the TCF control file. For a single domain model this will be 1.		\| Domain_Index\|\|The index of the model domain. This is the order with <tt><font color="blue">Start 2D Domain</font><font color="red"> == </font><Domain Name></tt> commands appears in the TCF control file. For a single domain model this will be 1.
	\|-		\|-
	\| SRF \|\|The Storage Reduction Factor for the cell.		\| SRF \|\|The Storage Reduction Factor for the cell.
Line 65:		Line 65:

	== Features ==		== Features ==
	This file is very useful to apply a style or thematic map to. ~~See~~ the ~~[[TUFLOW_Check_Files#Tips_for_Visualising_Check_Files\|~~ ~~Tips~~ for ~~visualising check~~ ~~files]]~~.~~<br>~~		This file is very useful to apply a style or thematic map to and it helps for visualising the final properties for large models.
	This allows a very easy way to visualise the final properties for large models.
	<br><br>		<br><br>
	A ~~grd_check~~ file styled by ~~the soil~~ ID is below ~~(in QGIS)~~.<br>		A _grd_check file styled by material ID is shown below.<br>
	<br>		<br>
	[[ File:~~Grd check SoilID1~~.~~JPG~~]]		[[File:2d_grd_check_01a.png]]<br>
	~~<br>~~<br>		<br>
			A _grd_check file for a Quadtree model is shown below. It has been styled with the default TUFLOW styling.<br>
	An example of a grid check file shaded by Material ID is below (in MapInfo).<br>
		⚫	<br>
			[[File:2d_grd_check_02a.png]]<br>
	<br>		<br>
	[[File:MI thematic map 04.jpg]]
	<br><br>


	{{Tips Navigation		{{Tips Navigation

Emilie Nielsen at 05:04, 5 August 2025

2025-08-05T05:04:26Z

← Older revision		Revision as of 15:04, 5 August 2025
Line 1:		Line 1:
	== Introduction ==		== Introduction ==
	This ~~pages~~ contains information on ~~the attributes of~~ the _grd_check file. This ~~GIS~~ contains a region object for each active (cell code 1) or ~~null~~ (cell code -1) cell. A number of the output attributes are only written if certain model features are enabled. For example, the '''Soil_ID''' attribute is only included if any soil features are used in the model.<br>		This page contains information on the _grd_check file. This file contains a region object for each active (cell code 1) or inactive (cell code -1) cell. A number of the output attributes are only written if certain model features are enabled. For example, the '''Soil_ID''' attribute is only included if any soil features are used in the model.<br>
	<br>		<br>
	There are a number of attributes that are only output for TUFLOW GPU models, as the GPU model is a cell centred scheme certain properties such as Manning's roughness and Form Loss are applied at the cell centre, whilst in TUFLOW these are applied at the cell side (refer to the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u> for a more detailed explanation). These GPU only attributes are noted in the table below.<br>		There are a number of attributes that are only output for TUFLOW GPU models. As the GPU model is a cell centred scheme, certain properties such as Manning's roughness and Form Loss are applied at the cell centre, whilst in TUFLOW these are applied at the cell side (refer to the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u> for a more detailed explanation). These GPU only attributes are noted in the table below.<br>

	== Attributes of grd_check ==		== Attributes of grd_check ==

Abigail.lillo: /* Attributes of grd_check */

2024-11-05T03:35:35Z

Attributes of grd_check

← Older revision		Revision as of 13:35, 5 November 2024
Line 14:		Line 14:
	\| m\|\|Column number in the TUFLOW domain.		\| m\|\|Column number in the TUFLOW domain.
	\|-		\|-
	\| Code\|\|The cell code status. This is 1 for active cells and -1 for null cells that are included in the mesh. Refer to the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u> for more information on the cell codes.		\| Code (Classic/HPC only)\|\|The cell code status. This is 1 for active cells and -1 for null cells that are included in the mesh. Refer to the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u> for more information on the cell codes.
	\|-		\|-
	\| Material\|\|The material ID.		\| Material\|\|The material ID.
Line 22:		Line 22:
	\| IWL\|\|The initial water level value. If the initial water level set in the model is below the cell elevation (ZC) or if no initial water level has been set, the cell elevation plus the model wet / dry depth is output. Note, this value is rounded to 3 decimal places.		\| IWL\|\|The initial water level value. If the initial water level set in the model is below the cell elevation (ZC) or if no initial water level has been set, the cell elevation plus the model wet / dry depth is output. Note, this value is rounded to 3 decimal places.
	\|-		\|-
	\| Domain_Index\|\|The index of the model domain. This is the order with <tt><font color="blue">Start 2D Domain</font><font color="red"> == </font><Domain Name></tt> commands appears in the TCF control file. For a single domain model this will be 1.		\| Domain_Index (Classic/HPC only)\|\|The index of the model domain. This is the order with <tt><font color="blue">Start 2D Domain</font><font color="red"> == </font><Domain Name></tt> commands appears in the TCF control file. For a single domain model this will be 1.
	\|-		\|-
	\| SRF \|\|The Storage Reduction Factor for the cell.		\| SRF \|\|The Storage Reduction Factor for the cell.

Emilie Nielsen: /* Attributes of grd_check */

2024-10-27T22:43:20Z

Attributes of grd_check

← Older revision		Revision as of 08:43, 28 October 2024
Line 51:		Line 51:


	=== Quadtree ~~specific~~ ~~attributes~~ ===		=== Quadtree Specific Attributes ===
	{\| align="center" class="wikitable" width="75%"		{\| align="center" class="wikitable" width="75%"
	! style="background-color:#005581; font-weight:bold; color:white;"\| Attribute Name		! style="background-color:#005581; font-weight:bold; color:white;"\| Attribute Name

Emilie Nielsen: /* Attributes of grd_check */

2024-10-21T05:05:48Z

Attributes of grd_check

← Older revision		Revision as of 15:05, 21 October 2024
Line 18:		Line 18:
	\| Material\|\|The material ID.		\| Material\|\|The material ID.
	\|-		\|-
	\| ZC ~~<br>(or [[#SGS_Specific_Attributes\|ZMin]])~~\|\|The elevation within the cell.		\| ZC\|\|The elevation within the cell.
	\|-		\|-
	\| IWL\|\|The initial water level value. If the initial water level set in the model is below the cell elevation (ZC) or if no initial water level has been set, the cell elevation plus the model wet / dry depth is output. Note, this value is rounded to 3 decimal places.		\| IWL\|\|The initial water level value. If the initial water level set in the model is below the cell elevation (ZC) or if no initial water level has been set, the cell elevation plus the model wet / dry depth is output. Note, this value is rounded to 3 decimal places.

Emilie Nielsen at 05:05, 21 October 2024

2024-10-21T05:05:16Z

← Older revision		Revision as of 15:05, 21 October 2024
Line 1:		Line 1:
	== Introduction ==		== Introduction ==
	This pages contains information on the attributes of the _grd_check file. This GIS contains a region object for each active (cell code 1) or null (cell code -1) cell. A number of the output attributes are only written if certain model features are enabled. For example, the '''~~SRF~~''' ~~(Storage Reduction Factor)~~ attribute is only included if any ~~SRF~~ ~~commands~~ are used in the model.<br>		This pages contains information on the attributes of the _grd_check file. This GIS contains a region object for each active (cell code 1) or null (cell code -1) cell. A number of the output attributes are only written if certain model features are enabled. For example, the '''Soil_ID''' attribute is only included if any soil features are used in the model.<br>
	<br>		<br>
	There are a number of attributes that are only output for TUFLOW GPU models, as the GPU model is a cell centred scheme certain properties such as Manning's roughness and Form Loss are applied at the cell centre, whilst in TUFLOW these are applied at the cell side (refer to the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u> for a more detailed explanation). These GPU only attributes are noted in the table below.<br>		There are a number of attributes that are only output for TUFLOW GPU models, as the GPU model is a cell centred scheme certain properties such as Manning's roughness and Form Loss are applied at the cell centre, whilst in TUFLOW these are applied at the cell side (refer to the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u> for a more detailed explanation). These GPU only attributes are noted in the table below.<br>

Emilie Nielsen at 05:04, 21 October 2024

2024-10-21T05:04:05Z

@@ Line 1: / Line 1: @@
-This pages contains information on the attributes of the _grd_check file.  This GIS contains a region object for each active (cell code 1) or null (cell code -1) cell.  A number of the output attributes are only written if certain model features are enabled.  For example, the '''GW_Z_L1''' (groundwater level) attribute is only included if soils are used in the model.<br>
+This pages contains information on the attributes of the _grd_check file.  This GIS contains a region object for each active (cell code 1) or null (cell code -1) cell.  A number of the output attributes are only written if certain model features are enabled.  For example, the '''SRF''' (Storage Reduction Factor) attribute is only included if any SRF commands are used in the model.<br>
 <br>
 There are a number of attributes that are only output for TUFLOW GPU models, as the GPU model is a cell centred scheme certain properties such as Manning's roughness and Form Loss are applied at the cell centre, whilst in TUFLOW these are applied at the cell side (refer to the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u> for a more detailed explanation).  These GPU only attributes are noted in the table below.<br>
-'''Attributes of grd_check'''<br>
+== Attributes of grd_check ==
 {| align="center" class="wikitable" width="75%"
 ! style="background-color:#005581; font-weight:bold; color:white;"| Attribute Name
@@ Line 16: / Line 18: @@
 | Material||The material ID.
 |-
-| ZC (ZMin if SGS is used)||The elevation within the cell. If SGS is used, minimum elevation within the cell.
+| ZC <br>(or [[#SGS_Specific_Attributes|ZMin]])||The elevation within the cell.
 |-
-| IWL||The initial water level value.  If the initial water level set in the model is below the cell elevation (ZC) or if no initial water level has been set, the cell elevation plus the model wet / dry depth is output. Note, this value is rounded to 3 decimal places.
+| IWL||The initial water level value. If the initial water level set in the model is below the cell elevation (ZC) or if no initial water level has been set, the cell elevation plus the model wet / dry depth is output. Note, this value is rounded to 3 decimal places.
 |-
 | Domain_Index||The index of the model domain.  This is the order with <tt><font color="blue">Start 2D Domain</font><font color="red"> == </font><Domain Name></tt> commands appears in the TCF control file.  For a single domain model this will be 1.
@@ Line 25: / Line 27: @@
 |-
 | Soil_ID (only if soil feature used)||The Soil ID for the cell.  This is only output if a <font color="blue"><tt>Set Soil</tt></font>, <font color="blue"><tt>Read GIS Soil</tt></font> or <font color="blue"><tt>Read GRID Soil</tt></font> command is specified for the simulation.
 |-
 | GW_Z_L1 (only if soils are used)||The groundwater level for each cell. This is equal to the elevation in the cell minus the soil thickness. If no soil thickness is specified (using the <tt><font color="blue">Set Soil Thickness</font></tt> TGC command), the attribute will be set to -99999. This attribute is only output if using soils, i.e. if the <font color="blue"><tt>Set Soil</tt></font>, <font color="blue"><tt>Read GIS Soil</tt></font> and/or <font color="blue"><tt>Read Grid Soil</tt></font> TGC command(s) have been used.
@@ Line 34: / Line 32: @@
 | IGW_Lvl_L1 (only if soils are used)||The initial groundwater level for each cell. This is equal to the elevation in the cell minus the initial groundwater depth. If no initial groundwater depth is specified (using the <tt><font color="blue">Set IGW Depth</font></tt> TGC command), the attribute will be set to the GW_Z_L1 value. This attribute is only output if using soils, i.e. if the <font color="blue"><tt>Set Soil</tt></font>, <font color="blue"><tt>Read GIS Soil</tt></font> and/or <font color="blue"><tt>Read Grid Soil</tt></font> TGC command(s) have been used.
 |}
 This file is very useful to apply a style or thematic map to.  See the [[TUFLOW_Check_Files#Tips_for_Visualising_Check_Files| Tips for visualising check files]].<br>
 This allows a very easy way to visualise the final properties for large models.

Emilie Nielsen at 23:35, 20 October 2024

2024-10-20T23:35:35Z

← Older revision		Revision as of 09:35, 21 October 2024
Line 1:		Line 1:
	This pages contains information on the attributes of the _grd_check file. This GIS contains a region object for each active (cell code 1) or null (cell code -1) cell. A number of the output attributes are only written if certain model features are enabled. For example, the '''~~SRF~~''' (~~Storage~~ ~~Reduction Factor~~) attribute is only included if ~~any SRF commands~~ are used in the model.<br>		This pages contains information on the attributes of the _grd_check file. This GIS contains a region object for each active (cell code 1) or null (cell code -1) cell. A number of the output attributes are only written if certain model features are enabled. For example, the '''GW_Z_L1''' (groundwater level) attribute is only included if soils are used in the model.<br>
	<br>		<br>
	There are a number of attributes that are only output for TUFLOW GPU models, as the GPU model is a cell centred scheme certain properties such as Manning's roughness and Form Loss are applied at the cell centre, whilst in TUFLOW these are applied at the cell side (refer to the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u> for a more detailed explanation). These GPU only attributes are noted in the table below.<br>		There are a number of attributes that are only output for TUFLOW GPU models, as the GPU model is a cell centred scheme certain properties such as Manning's roughness and Form Loss are applied at the cell centre, whilst in TUFLOW these are applied at the cell side (refer to the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u> for a more detailed explanation). These GPU only attributes are noted in the table below.<br>

Emilie Nielsen at 00:55, 7 October 2024

2024-10-07T00:55:46Z

← Older revision		Revision as of 10:55, 7 October 2024
Line 26:		Line 26:
	\| Soil_ID (only if soil feature used)\|\|The Soil ID for the cell. This is only output if a <font color="blue"><tt>Set Soil</tt></font>, <font color="blue"><tt>Read GIS Soil</tt></font> or <font color="blue"><tt>Read GRID Soil</tt></font> command is specified for the simulation.		\| Soil_ID (only if soil feature used)\|\|The Soil ID for the cell. This is only output if a <font color="blue"><tt>Set Soil</tt></font>, <font color="blue"><tt>Read GIS Soil</tt></font> or <font color="blue"><tt>Read GRID Soil</tt></font> command is specified for the simulation.
	\|-		\|-
	\| Z_Map_Cutoff (only if SGS is used)\|\|The map output cutoff elevation for each cell. This is equal to the minimum cell elevation plus the map cutoff depth (specified by the TCF command <tt><font color="blue">Map Cutoff Depth~~</font><font color="red"> ==~~ </font></tt>).		\| Z_Map_Cutoff (only if SGS is used)\|\|The map output cutoff elevation for each cell. This is equal to the minimum cell elevation plus the map cutoff depth (specified by the TCF command <tt><font color="blue">Map Cutoff Depth</font></tt>).
	\|-		\|-
	\| SGS_Delta (only if SGS is used)\|\|This attribute is output only if the <font color="blue"><tt>SGS Breakline Detection Delta</tt></font> TCF command has been used. The SGS breakline detection check processes each 2D cell to identify the minimum water surface elevation needed for a continuous wet connection through the cell traversing between left to right and between top to bottom. The maximum invert elevation of the left and right faces is subtracted from the left-right minimum water level and reports it as “uDelta”. Similarly, the top to bottom value is reported as “vDelta”. uDelta and vDelta represent the depth of water over the cell face inverts by which a natural ridge (break) line would block any flow. This attribute reports the maximum of uDelta and vDelta.		\| SGS_Delta (only if SGS is used)\|\|This attribute is output only if the <font color="blue"><tt>SGS Breakline Detection Delta</tt></font> TCF command has been used. The SGS breakline detection check processes each 2D cell to identify the minimum water surface elevation needed for a continuous wet connection through the cell traversing between left to right and between top to bottom. The maximum invert elevation of the left and right faces is subtracted from the left-right minimum water level and reports it as “uDelta”. Similarly, the top to bottom value is reported as “vDelta”. uDelta and vDelta represent the depth of water over the cell face inverts by which a natural ridge (break) line would block any flow. This attribute reports the maximum of uDelta and vDelta.
			\|-
			\| GW_Z_L1 (only if soils are used)\|\|The groundwater level for each cell. This is equal to the elevation in the cell minus the soil thickness. If no soil thickness is specified (using the <tt><font color="blue">Set Soil Thickness</font></tt> TGC command), the attribute will be set to -99999. This attribute is only output if using soils, i.e. if the <font color="blue"><tt>Set Soil</tt></font>, <font color="blue"><tt>Read GIS Soil</tt></font> and/or <font color="blue"><tt>Read Grid Soil</tt></font> TGC command(s) have been used.
			\|-
			\| IGW_Lvl_L1 (only if soils are used)\|\|The initial groundwater level for each cell. This is equal to the elevation in the cell minus the initial groundwater depth. If no initial groundwater depth is specified (using the <tt><font color="blue">Set IGW Depth</font></tt> TGC command), the attribute will be set to the GW_Z_L1 value. This attribute is only output if using soils, i.e. if the <font color="blue"><tt>Set Soil</tt></font>, <font color="blue"><tt>Read GIS Soil</tt></font> and/or <font color="blue"><tt>Read Grid Soil</tt></font> TGC command(s) have been used.
	\|}		\|}

Pavlina Monhartova at 10:03, 2 October 2024

2024-10-02T10:03:28Z

← Older revision		Revision as of 20:03, 2 October 2024
Line 22:		Line 22:
	\| Domain_Index\|\|The index of the model domain. This is the order with <tt><font color="blue">Start 2D Domain</font><font color="red"> == </font><Domain Name></tt> commands appears in the TCF control file. For a single domain model this will be 1.		\| Domain_Index\|\|The index of the model domain. This is the order with <tt><font color="blue">Start 2D Domain</font><font color="red"> == </font><Domain Name></tt> commands appears in the TCF control file. For a single domain model this will be 1.
	\|-		\|-
	\| SRF ~~(only if SRF feature used)~~\|\|The Storage Reduction Factor for the cell.		\| SRF \|\|The Storage Reduction Factor for the cell.
	\|-		\|-
	\| Soil_ID (only if soil feature used)\|\|The Soil ID for the cell. This is only output if a <font color="blue"><tt>Set Soil</tt></font>, <font color="blue"><tt>Read GIS Soil</tt></font> or <font color="blue"><tt>Read GRID Soil</tt></font> command is specified for the simulation.		\| Soil_ID (only if soil feature used)\|\|The Soil ID for the cell. This is only output if a <font color="blue"><tt>Set Soil</tt></font>, <font color="blue"><tt>Read GIS Soil</tt></font> or <font color="blue"><tt>Read GRID Soil</tt></font> command is specified for the simulation.