Result type (Watershed Overlay): Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
(Created page with "The Watershed Module of a Watershed Overlay performs watershed calculations and can, apart from the watershed areas, also generate a set of intermediate types of resul...")
 
No edit summary
Line 1: Line 1:
The [[Watershed Module]] of a [[Watershed Overlay]] performs watershed calculations and can, apart from the watershed areas, also generate a set of intermediate types of results. These can be used to gain more insight in the calculated watershed areas.
The [[Watershed Module]] of a [[Watershed Overlay]] performs complex calculations and multiple types of results can be provided.
==Unique results==
Each result type represents an aspect of the calculated watershed simulation, and is accompanied by its own [[Grid Overlay legend|legend]]. As can be seen in the list below, many result types are supported. The watershed module can record more than one result type. However, since not all result types can be stored at the same time, only the selected ones are recorded. These results will be stored in individual overlays.  


===Multiple result child overlays===
There is always one general Watershed Overlay. The configuration for the calculation is only defined in this overlay, which makes it easier to verify and configure the used simulation parameters. Result child overlays can be added to this Watershed Overlay to store additional result types. The advantage of using result child overlays are that for any given watershed overlay, the calculation of the overlay only occurs once, rather than multiple times equal to the amount of desired result types.  
Each overlay can only display a single result type. When using a water overlay, it is often desirable to output multiple types of overlay, relevant to a project's use case.  
To support this usecase, it is possible to add result child overlays to a water overlay. These can then store and display different results coming forth from the same water overlay calculation. The advantages of using result child overlays are that for any given water overlay, the calculation of the overlay only occurs once, rather than multiple times equal to the amount of desired result types. Additionally, the configuration for the calculation is only defined in a single overlay, which makes it easier to verify and configure the used simulation parameters.


It is currently only possible to add result child overlays via the [[Water Overlay Wizard|configuration wizard]], in the step regarding output overlays.
It is currently only possible to add result child overlays via the [[Watershed Overlay Wizard|configuration wizard]], in the step regarding output overlays.
 
Naturally, the results can be [[Results (Watershed Overlay)#Overlay_visualization|seen visually]]. They can also be [[Results (Watershed Overlay)#Inspecting_results|inspected]] in more detail, and also [[Results_(Water_Overlay)#Storing results|exported]].
 
==Changing a result type==
When the result type of the Watershed Overlay or any of its children, is changed, the legend is updated automatically. However, the data for this new result type must still be calculated. This may result in the visual output of the overlay changing, because the unchanged data is displayed with a new legend. When changing the result types, it is recommended to force a recalculation of the overlay before [[Results (Watershed Overlay)|inspecting the results]].


==List of Result Types==
==List of Result Types==
Line 14: Line 19:
! Display mode
! Display mode
! Description
! Description
! [[File:Overlay_rainfall.png|Rainfall overlay]]
! [[File:Overlay_flooding.png|Flooding overlay]]
! [[File:Overlay_groundwater.png|Groundwater overlay]]
|-
|-
|[[File:overlay_icon_water_base_types.png|25px|center]]
|[[File:overlay_icon_watershed_base_types.png|25px|center]]
|[[Base_types_result_type_(Water_Overlay)|BASE_TYPES]]
|[[Base_types_result_type_(Watershed_Overlay)|BASE_TYPES]]
|nominal value
|nominal value
|{{inlink|Start_resulttype|Start}}
|{{inlink|Start_resulttype|Start}}
|Categorization of the individual cells based on how they are processed by the water model, displaying which cells are considered to be specific features.
|Categorization of the individual cells based on how they are processed by the watershed model, displaying which cells are considered to be specific features.
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|-
|-
|[[File:overlay_icon_water_debug_uv.png|25px|center]]
|[[File:overlay_icon_watershed_watershed_areas.png|25px|center]]
|[[Debug_uv_result_type_(Water_Overlay)|DEBUG_UV]]
|[[Watersheds_result_type_(Watersheds_Overlay)|WATERSHED_AREAS]]
|m<sup>3</sup>s<sup>-2</sup>
|Integer
|[[#Last_resulttype|Last]]
|[[#Last_resulttype|Last]]
|The wave part of each flux component in the [[Surface flow formula (Water Overlay)|2D Saint-Venant system]].
|The integer ID of the calculated watershed. NO_DATA if no watershed area was calculated for that partical cell.
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|-
|[[File:overlay_icon_water_evaporated.png|25px|center]]
|[[Evaporated_result_type_(Water_Overlay)|EVAPORATED]]
|m (mm)&sup1;
|{{inlink|Total_resulttype|Total}}
|The amount of water that has evaporated. The value is the sum of the quantities evaporated from the surface and the underground.
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|-
|[[File:overlay_icon_water_gpu_overview.png|25px|center]]
|[[Gpu_overview_result_type_(Water_Overlay)|GPU_OVERVIEW]]
|nominal value
|{{inlink|Maximum_resulttype|Maximum}}
|Shows which GPU cluster calculated which part of the overlay.
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|-
|[[File:overlay_icon_water_ground_last_storage.png|25px|center]]
|[[Ground_last_storage_result_type_(Water_Overlay)|GROUND_LAST_STORAGE]]
|m (mm)&sup1;
|{{inlink|Last_resulttype|Last}}
|The (effective) amount of water in the underground unsaturated zone.
|style="text-align:center;"|
|style="text-align:center;"|
|style="text-align:center;"|'''X'''
|-
|[[File:overlay_icon_water_ground_last_value.png|25px|center]]
|[[Ground_last_value_result_type_(Water_Overlay)|GROUND_LAST_VALUE]]
|m (mm)&sup1;
|{{inlink|Last_resulttype|Last}}
|The distance between the terrain surface and the groundwater level.
|style="text-align:center;"|
|style="text-align:center;"|
|style="text-align:center;"|'''X'''
|-
|[[File:overlay_icon_water_ground_max_storage.png|25px|center]]
|[[Ground_max_storage_result_type_(Water_Overlay)|GROUND_MAX_STORAGE]]
|m (mm)&sup1;
|{{inlink|Maximum_resulttype|Maximum}}
|The (effective) amount of water in the underground unsaturated zone.
|style="text-align:center;"|
|style="text-align:center;"|
|style="text-align:center;"|'''X'''
|-
|[[File:overlay_icon_water_ground_max_value.png|25px|center]]
|[[Ground_max_value_result_type_(Water_Overlay)|GROUND_MAX_VALUE]]
|m (mm)&sup1;
|{{inlink|Maximum_resulttype|Maximum}}
|The distance between the terrain surface and the groundwater level.
|style="text-align:center;"|
|style="text-align:center;"|
|style="text-align:center;"|'''X'''
|-
|[[File:overlay_icon_water_ground_watertable.png|25px|center]]
|[[Ground_watertable_result_type_(Water_Overlay)|GROUND WATERTABLE]]
|{{mdatum}}
|{{inlink|Last_resulttype|Last}}
|The groundwater level, relative to [[datum]].
|style="text-align:center;"|
|style="text-align:center;"|
|style="text-align:center;"|'''X'''
|-
|[[File:overlay_icon_water_impacted_buildings.png|25px|center]]
|[[Impacted_buildings_result_type_(Water_Overlay)|IMPACTED_BUILDINGS]]
|nominal value
|{{inlink|Maximum_resulttype|Maximum}}
|Constructions impacted by excess water, with the definition of "impacted" as defined by [[Impact_flood_threshold_m_(Water Overlay)|IMPACT_FLOOD_THRESHOLD_M]].
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|-
|[[File:overlay_icon_water_sewer_last_value.png|25px|center]]
|[[Sewer_last_value_result_type_(Water_Overlay)|SEWER_LAST_VALUE]]
|m (mm)&sup1;
|{{inlink|Last_resulttype|Last}}
|The amount of water stored in the sewer.
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|-
|[[File:overlay_icon_water_sewer_max_value.png|25px|center]]
|[[Sewer_max_value_result_type_(Water_Overlay)|SEWER_MAX_VALUE]]
|m (mm)&sup1;
|{{inlink|Maximum_resulttype|Maximum}}
|The amount of water stored in the sewer.
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|-
|[[File:overlay_icon_water_substance_a.png|25px|center]]
|[[Substance_a_result_type_(Water_Overlay)|SUBSTANCE_A]]
|x/m²
|{{inlink|Last_resulttype|Last}}
|The amount of [[Substance ABCD (Water Overlay)|substance A]] present. The value is the sum of the quantities on the surface, and in the underground.
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|-
|[[File:overlay_icon_water_substance_b.png|25px|center]]
|[[Substance_b_result_type_(Water_Overlay)|SUBSTANCE_B]]
|x/m²
|{{inlink|Last_resulttype|Last}}
|The amount of [[Substance ABCD (Water Overlay)|substance B]] present. The value is the sum of the quantities on the surface, and in the underground.
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|-
|[[File:overlay_icon_water_substance_c.png|25px|center]]
|[[Substance_c_result_type_(Water_Overlay)|SUBSTANCE_C]]
|x/m²
|{{inlink|Last_resulttype|Last}}
|The amount of [[Substance ABCD (Water Overlay)|substance C]] present. The value is the sum of the quantities on the surface, and in the underground.
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|-
|[[File:overlay_icon_water_substance_d.png|25px|center]]
|[[Substance_d_result_type_(Water_Overlay)|SUBSTANCE_D]]
|x/m²
|{{inlink|Last_resulttype|Last}}
|The amount of [[Substance ABCD (Water Overlay)|substance D]] present. The value is the sum of the quantities on the surface, and in the underground.
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|-
|[[File:Difference_overlay_icoon.jpg|25px|center]]
|[[Surface_difference_result_type_(Water_Overlay)|SURFACE_DIFFERENCE]]
|m (mm)&sup1;
|{{inlink|Last_resulttype|Last}}
|The difference between the original water level and the water level of the last timeframe.
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|-
|[[File:overlay_icon_water_surface_direction.png|25px|center]]
|[[Surface_direction_result_type_(Water_Overlay)|SURFACE_DIRECTION]]
|{{geoangle}}
|{{inlink|Last_resulttype|Last}}
|The direction in which water is flowing across the surface.
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|-
|[[File:overlay_icon_water_surface_duration.png|25px|center]]
|[[Surface_duration_result_type_(Water_Overlay)|SURFACE_DURATION]]
|s (min)&sup1;
|{{inlink|Total_resulttype|Total}}
|The amount of time the water depth on the surface exceeds [[Show duration flood level m (Water Overlay)|SHOW_DURATION_FLOOD_LEVEL_M]].
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|-
|[[File:overlay_icon_water_surface_elevation.png|25px|center]]
|[[Surface_elevation_result_type_(Water_Overlay)|SURFACE_ELEVATION]]
|{{mdatum}}
|{{inlink|Start_resulttype|Start}}
|The rasterized version of the [[terrain height (Water Overlay)|terrain height]] for use in the water overlay's calculations.
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|-
|[[File:overlay_icon_water_surface_flow.png|25px|center]]
|[[Surface_flow_result_type_(Water_Overlay)|SURFACE_FLOW]]
|m&sup3;/m&sup2;
|{{inlink|Last_resulttype|Last}}
|The amount of water which has flowed through a given location.
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|-
|[[File:overlay_icon_water_surface_last_speed.png|25px|center]]
|[[Surface_last_speed_result_type_(Water_Overlay)|SURFACE_LAST_SPEED]]
|m/s
|{{inlink|Last_resulttype|Last}}
|The (horizontal) speed of water flow.
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|-
|[[File:overlay_icon_water_surface_last_value.png|25px|center]]
|[[Surface_last_value_result_type_(Water_Overlay)|SURFACE_LAST_VALUE]]
|m (mm)&sup1;
|{{inlink|Last_resulttype|Last}}
|The amount of water on the surface.
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|-
|[[File:overlay_icon_water_surface_max_speed.png|25px|center]]
|[[Surface_max_speed_result_type_(Water_Overlay)|SURFACE_MAX_SPEED]]
|m/s
|{{inlink|Maximum_resulttype|Maximum}}
|The (horizontal) speed of water flow.
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|-
|[[File:overlay_icon_water_surface_max_value.png|25px|center]]
|[[Surface_max_value_result_type_(Water_Overlay)|SURFACE_MAX_VALUE]]
|m (mm)&sup1;
|{{inlink|Maximum_resulttype|Maximum}}
|The amount of water on the surface.
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|-
|[[File:overlay_icon_water_water_stress.png|25px|center]]
|[[Waterstress_result_type_(Water_Overlay)|WATER_STRESS]]
|m (mm)&sup1;
|{{inlink|Maximum_resulttype|Maximum}}
|The amount of water on the surface, similar to [[Surface_max_value_result_type_(Water_Overlay)|SURFACE_MAX_VALUE]]. However, for [[terrain water (Water Overlay)|water terrains]], the water height must rise by at least [[Allowed water increase m (Water Overlay)|ALLOWED_WATER_INCREASE_M]]. Otherwise, the reported value in those locations is 0.
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|style="text-align:center;"|'''X'''
|}
|}


{{Unit_disclaimer_(Water_Overlay)}}
{{Unit_disclaimer_(Watershed_Overlay)}}


Result types can differ in the kind of data they display, the layer (surface or underground) of which they display that information, and how that data is recorded. Different result types can monitor data in the following ways:
Result types can differ in the kind of data they display, the layer (surface or underground) of which they display that information, and how that data is recorded. Different result types can monitor data in the following ways:
Line 265: Line 45:
# the simulation has to run in full multiple times, causing a severe increase in calculation time.
# the simulation has to run in full multiple times, causing a severe increase in calculation time.
# when changes to the overlay's configuration have to be made those changes need to be made to all water overlays.
# when changes to the overlay's configuration have to be made those changes need to be made to all water overlays.
* Result child overlays do not recalculate if either they or their parent is set to [[Grid Overlay#Active|inactive]].
* Result child overlays are not (re)calculated if either they or their parent is set to [[Grid Overlay#Active|inactive]].
* If a calculation overlay is removed, all result child overlays of that overlay are removed as well. Separate overlays set as child overlays (such as [[input overlay]]s) of the overlay will not be removed.
* If a calculation overlay is removed, all result child overlays of that overlay are removed as well. Separate overlays set as child overlays (such as [[input overlay]]s) of the overlay will not be removed.


Line 272: Line 52:


==See also==
==See also==
*[[Results_(Water_Overlay)|Water overlay results]].
*[[Results_(Watershed_Overlay)|Watershed overlay results]].


{{Template:WaterOverlay_result_nav}}
{{Template:WatershedOverlay_result_nav}}
[[Category:Water Module]]
[[Category:Watershed Module]]

Revision as of 15:11, 20 May 2020

The Watershed Module of a Watershed Overlay performs complex calculations and multiple types of results can be provided.

Unique results

Each result type represents an aspect of the calculated watershed simulation, and is accompanied by its own legend. As can be seen in the list below, many result types are supported. The watershed module can record more than one result type. However, since not all result types can be stored at the same time, only the selected ones are recorded. These results will be stored in individual overlays.

There is always one general Watershed Overlay. The configuration for the calculation is only defined in this overlay, which makes it easier to verify and configure the used simulation parameters. Result child overlays can be added to this Watershed Overlay to store additional result types. The advantage of using result child overlays are that for any given watershed overlay, the calculation of the overlay only occurs once, rather than multiple times equal to the amount of desired result types.

It is currently only possible to add result child overlays via the configuration wizard, in the step regarding output overlays.

Naturally, the results can be seen visually. They can also be inspected in more detail, and also exported.

Changing a result type

When the result type of the Watershed Overlay or any of its children, is changed, the legend is updated automatically. However, the data for this new result type must still be calculated. This may result in the visual output of the overlay changing, because the unchanged data is displayed with a new legend. When changing the result types, it is recommended to force a recalculation of the overlay before inspecting the results.

List of Result Types

Icon Result type Unit Display mode Description
Overlay icon watershed base types.png
BASE_TYPES nominal value Start Categorization of the individual cells based on how they are processed by the watershed model, displaying which cells are considered to be specific features.
Overlay icon watershed watershed areas.png
WATERSHED_AREAS Integer Last The integer ID of the calculated watershed. NO_DATA if no watershed area was calculated for that partical cell.

Template:Unit disclaimer (Watershed Overlay)

Result types can differ in the kind of data they display, the layer (surface or underground) of which they display that information, and how that data is recorded. Different result types can monitor data in the following ways:

  • Start: The data is determined at the start of the simulation and does not change afterwards.
  • Last: The data is the latest value determined at the timestep the data is recorded. The values can increase and decrease between different timesteps. This mode is primarily used for monitoring progression.
  • Maximum: The data is the highest value determined up until the timestep the data is recorded. The values can only increase or stay the same, but will never decrease. This mode is primarily used to gain insight into impact; the most severe situation any point had to endure.
  • Total: The result of a running tally, counting the relevant data up until the timestep the data is recorded. The value can only increase or stay the same, but will never decrease. This mode is primarily used to gain insight into quantities rather than duration.

Notes

  • Although it is possible to duplicate the overlay, and set the copy of the overlay to a different result type, we strongly advice to use child overlays instead. Downsides of the duplication approach are:
  1. the simulation has to run in full multiple times, causing a severe increase in calculation time.
  2. when changes to the overlay's configuration have to be made those changes need to be made to all water overlays.
  • Result child overlays are not (re)calculated if either they or their parent is set to inactive.
  • If a calculation overlay is removed, all result child overlays of that overlay are removed as well. Separate overlays set as child overlays (such as input overlays) of the overlay will not be removed.

How-to's

See also