Water Overlay: Difference between revisions

From Tygron Preview Support Wiki
Jump to navigation Jump to search
 
Line 1: Line 1:
{{learned|what the Water Overlays are|how to configure the Water Overlays}}
A Water Overlay is a [[Grid Overlay|grid overlay]] for which results are calculated by the [[Water Module]]. The [[Water_Module_Basics|Basic theory of the Water Module]] in the {{software}} is an implementation of a 2D grid based shallow water model based on the 2D Saint Venant equations. The module is further enhanced with infiltration, evaporation, groundwater flow and hydraulic structures. Depending on the use case, the simulated period can be set to few seconds and up to a few months. The [[Water_Module_Theory|theory]] section describes in detail how calculations are performed.
__NOTOC__
To perform the calculations, the project area is divided into a [[Grid overlay|grid of cells]]. Each cell has a specific quantity of water and specific hydrological parameters based on the data in the project. The total time which should be simulated is divided into discrete [[Timestep formula (Water Overlay)|timesteps]]. Per timestep, each cell communicates with its adjacent cells to exchange water, based on its water level, surface height, current flow direction and other factors. Accuracy and reliability is obtained by dividing the project area and simulation time into sufficiently small cells and steps, at the cost of more computation time.


==What are the Water Overlays==
The final results of the calculation can be inspected, as well as intermediate snapshots of the hydrological situation during the simulation, known as [[Timeframes (Water Overlay)|timeframes]].
With the Water Overlays the following overlays are meant:
* [[Rainfall_(Overlay)|Rainfall Overlay]]
* [[Flooding_(Overlay)|Flooding Overlay]]
* [[Groundwater_(Overlay)|Groundwater Overlay]]


Each of these overlays have some common configuration steps which will be described on this page.
==Variants==
 
A Water Module will be initialized by adding one of the following Overlays to a project. Each variant has a number of parameters tuned to best fit specific use-cases. This means that each of these overlays is based on the same theory and calculation method, however they are customized to conveniently provide insight in different aspects of the Water Module.  
==Tips on creating a new project when working with the Water Overlays==
When creating a new project in the [[Wizard|new project wizard]], take into account the [[Terrain_height#Terrain_height_in_the_Tygron_Platform|Advanced options]]. In this menu for example the [[GEO_Data|AHN3]] dataset can be selected, which, if available for your project area, provides the most recent heightdata available as Open Data. Also, the [[GEO_Data|IMWA]] dataset is already checked, this means that if available in your project area, Water Level areas and/or Culverts are already imported.
 
==Configuration Wizard==
Each of the Water Overlays has a configuration wizard which helps the user with configuring the overlay.
The Configuration Wizard can be found in the General tab of the overlay. <br> <br>
[[File:Config_wizard.JPG|900px]] <br><br>
For the [[Flooding_(Overlay)|Flooding Overlay]] the wizard has an extra step, the [[Rainfall_(Overlay)|Rainfall]] and [[Groundwater_(Overlay)|Groundwater Overlay]] wizard are basically the same.
The settings in the wizard can always be changed after finishing the wizard by opening the wizard again and changing a value and recalculating the overlay.
<br>'''Step 1'''
In the first step the simulation time is set, based on either a rainfall or without a rainfall. Also the evaporation reference factor (over time) can be set.
 
<br>'''Step 2'''
In the second step the elements of the water system can be imported. In some sub-steps the there are four options: to do nothing and proceed, to import the data with the [[Geo_Data_Wizard|Geo data wizard]], or when you already have the data imported to select it based on an attribute of the data or to let the {{software}} automatically generate some data.
The following elements can be imported:
* the breach areas (only for the [[Flooding_(Overlay)|Flooding overlay]])
* water level areas; when automatically generating data one water level area covering the whole project area is created. The water level can be adjusted afterwards.
* ground water data
* sewer areas; can also be automatically generated based on the urbanization of the project area
* inundated areas; these are areas that are already inundated at the start of the flooding
* constructions; for the constructions keep in mind that when the data is point data, it has to overlap two water level areas. Therefore make sure the point data is on the border of two water level areas
** Weirs
** Culverts
** Pumps
** Sewer overflows; if chosen to automatically generate the sewer areas, the sewer overflows can also be automatically generated
<br>'''Step 3'''
Adjust, if needed, the hydrological coefficents used for the calculations for the [[Terrain#Surface|surface terrain]], the [[Terrain#Underground|underground terrain]] and the [[Functions#Function_values|function values]] (for example the amount of water storage for a certain type of building).
<br>'''Step 4'''
The water system can be made visable with panels and a network visualization.
<br>'''Step 5'''
In step 5 you have to choose the result types (the different results which can be exported) you want to see after the calculation is done. Some overlays require a threshold value. Read below for the different result types to choose from and the threshold values. One of the overlays can be selected as the first overlay, which then will be visible as the parent Overlay. You can always adjust the result types you want to see later and calculate the Overlay again.
Also you can set the number of timeframes in the slider. The timeframes are the intermediate results of the calculation and are not the same as the timesteps. Each timeframe contains numerous timesteps, based on the grid cell size and the speed of the flooding (see for more information the [[Flooding_(Overlay)#Flooding_Model|Courant number]]). The more timeframes you choose, the more insight you will get into the calculation. Each of the timeframe results can be exported.
<br>'''Step 6'''
In the last step, some additional result types can be chosen to be visualized. Thes overlays contain input data that is used for the calculation, for example the manning value.
 
==Hydrological constructions==
The water system can be enhanced with a number of hydrological [[construction]]s. These are constructions which form direct connections between exact locations in water bodies, allowing water to flow from one point to another according to the parameters and rules of the constructions used.
 
===Culvert===
Culverts are effectively tunnels or pipes directly connecting two bodies of water, and allow water to flow in either direction. Culverts can also be used to model tunnels on land, creating a hole which water can flow through when it is flowing over land.
{| class="wikitable"
! Attribute
! Unit
! Description
! Default
|-
|CULVERT_WIDTH
|m
|The diameter of the culvert.
|1
|-
|CULVERT_HEIGHT
|mNAP
|The height of the culvert. (When set to -100000, the culvert's endpoints are at the height of the terrain in that location.)
|0
|-
|CULVERT_N
|manning value
|The manning value of the culvert's material, which influences the flow speed.
|0,014
|}
 
Currently, culverts are always assumed to have a spherical diameter.
 
===Weir===
Weirs are effectively small dams in the water, and allow water to flow from a water body with a higher water level to a lower water level.
{| class="wikitable"
! Attribute
! Unit
! Description
! Default
|-
|WEIR_HEIGHT
|mNAP
|The height of the weir.
|n/a
|-
|WEIR_WIDTH
|m
|The width of the weir.
|5
|-
|WEIR_COEFFICIENT
|coefficient
|The flow coefficient related to the shape of the weir
|1,1
|}
 
===Pump===
Pumps are constructions which move water against its natural flow. It moves water from the water body with the lower water level to a higher water level.
{| class="wikitable"
! Attribute
! Unit
! Description
! Default
|-
|PUMP_SPEED
|m3/s
|The speed at which water is pumped from the lower water level to the higher water level.
|n/a
|}
 
===Sewer overflow===
Sewer overflows are points where water is moved from the sewer area to the above-ground water system.
{| class="wikitable"
! Attribute
! Unit
! Description
! Default
|-
|SEWER_OVERFLOW
|mNAP
|The height of the crest of the sewer overflow. The water level in the sewer must exceed this height before it flows out into the above-ground water system.
|n/a
|-
|SEWER_OVERFLOW_SPEED
|m3/s
|The speed at which water is pumped from the lower water level to the higher water level.
|10
|}
 
==Result types==
Each Water Overlay is a [[grid overlay]] showing results on the surface (flooding), sub-surface (groundwater), open water and sewer system. The following results are produced:
{| class="wikitable"
{| class="wikitable"
! Result type
|[[File:Overlay_rainfall.png]]
! Unit
|[[Rainfall_(Overlay)|Rainfall Overlay]]
! Description
|provides insight into the water stress and impact caused by (excessive) rainfall
|-
|BASE_TYPES
|nominal value
|Division of gridcells in water, land, water level areas, sewer areas that are connected to the sewer, breach areas and hydrological constructions
|-f
|CHLORIDE
|
|''Description will be added when available''
|-
|DIRECTION
|Degrees
|The direction of the flooding
|-
|EVAPORATED
|m (mm)&sup1;
|The amount of water that is evaporated
|-
|GPU OVERVIEW
|nominal value
|Shows which GPU cluster calculated which part of the overlay
|-
|IMPACTED_BUILDINGS
|nominal value
|Constructions impacted by flood: the value from the function value indicator is assigned to a building if the water depth at a grid-cell surrounding the building exceeds the overlay attribute value IMPACT_FLOOD_TRESHOLD_M
|-
|LAST SPEED
|m/s
|The speed of the flooding at the last calculated timestep
|-
|MAX SPEED
|m/s
|The maximum speed of the flooding of all the calculated timesteps
|-
|NITROGEN
|
|''Description will be added when available''
|-
|PHOSPHORUS
|
|''Description will be added when available''
|-
|SEWER_LAST_VALUE
|m (mm)&sup1;
|The amount of water in the sewer storage at the last calculated timestep
|-
|SEWER_MAX_VALUE
|m (mm)&sup1;
|The maximum amount of water in the sewer storage of all the calculated timesteps
|-
|SURFACE_DURATION
|s (min)&sup1;
|The amount of time the water depth in a cell exceeds the value set in the overlay attribute value SHOW_DURATION_FLOOD_LEVEL_M
|-
|SURFACE_FLOW
|m3/m2
|Total volume of water passed a grid-cell, scaled by the cell surface (grid cell-size^2)
|-
|SURFACE_LAST_VALUE
|m (mm)&sup1;
|The water depth at the last calculated timestep
|-
|SURFACE_MAX_VALUE
|m (mm)&sup1;
|The maximum water depth of all the calculated timesteps
|-
|UNDERGROUND_FLOW
|m&sup3;/m&sup2;
|Total infiltration amount from the surface to groundwater
|-
|UNDERGROUND_LAST_STORAGE
|
|''Description will be added when available''
|-
|UNDERGROUND_LAST_VALUE
|m (mm)&sup1;
|The amount by which the groundwater table has risen above the initial groundwater level at the last calculated timestep
|-
|UNDERGROUND_MAX_STORAGE
|
|''Description will be added when available''
|-
|UNDERGROUND_MAX_VALUE
|m (mm)&sup1;
|The maximum amount by which the groundwater table has risen above the initial groundwater of all the calculated timesteps
|-
|-
|UNDERGROUND WATERTABLE
|[[File:Overlay_flooding.png]]
|
|[[Flooding_(Overlay)|Flooding Overlay]]
|''Description will be added when available''
|provides insight into water stress and impact caused by breaches in levees or other sources causing excessive water inflow
|-
|-
|WATER_STRESS
||[[File:Overlay_groundwater.png]]
|m (mm)&sup1;
|[[Groundwater_(Overlay)|Groundwater Overlay]]
|The maximum water depth of all the calculated timesteps (almost the same as the SURFACE_MAX_VALUE, but if the terrain type is water only a water depth is shown if the depth exceeds the overlay attribute value ALLOWED_WATER_INCREASE_M)
|provides insight into long-term processes of water flow both on the surface and underground
 
|}
|}
<!--==Input Data and Settings==
The calculations performed by the Water Overlay are influenced by many kinds of geographical information present in the project area. For any given location, [[terrain]], [[construction]]s and other features can influence either the initial state of the simulation or how water flows in a given area.


&sup1; the units between () are as displayed in the 3D client. If exported to GeoTiff the SI-convention is used: meters (m) and seconds (s).
Furthermore, the Water Overlay features a number of overall settings which can be configured for the hydrological calculations and its results. These settings do not have a geographical or temporal element to them, and are fixed values relevant for the simulation as a whole.
 
==General Tab==
[[File:General_tab.JPG|250px|right|The geberal tab of the Water Overlays.]]
The General Tab can be found at the panel on the right side, when selecting a Water Overlay. In this tab several settings can be adjusted.
 
===Calculation Preference===
Here you can manipulate the computation time step by choosing between the option SPEED, AVERAGE and ACCURACY. The computational timesteps will be set according to the Courant criterion:
 
Δt  = Δx /u<sub>max</sub>
 
where:
* Δt = computational timestep
* Δx = grid cell size
* u<sub>max</sub> = max velocity, assumed 2.5 (SPEED), 5 (AVERAGE) and 10 (ACCURACY) m3/s respectively
 
===Grid cell size===
The {{software}} computes flow equations over a rectangular cartesian grid, the grid cell size can be set by clicking on Change Grid.
After the grid cell size is changed, the Overlay is immediately being recalculated.
Note: if you choose a smaller grid cell size, both the amount of time steps (see Calculation Preference) and amount of computational cells increase.
 
===Refresh Grid===
By Refreshing the grid, the Overlay is recalculated. This may take some time, depending on the grid cell size, the size of your project and the calcualtion preference.
Below some use cases when to use Refresh Grid:
* when you have changed a setting in the Configuration Wizard, but not clicked on the Finish button of the wizard.
* when you change the Result type or calculcation preference in the General tab
* when you change the legend in the Legend tab
* when you change the keys in the Keys tab
* when you change the attrbutes of the Overlay in the Attributes tab
 
===Export Grid File===
You can export the current result type as either a GeoTiff (binary file/bitmap image can be opened in a GIS or in an image viewer) or ASCII (text file, can also be opened in a GIS but is also readable in a text editor) file.
Also, it is possible to export the difference result type of the current and maquette situation.


===Save Overlay result===
;[[Hydrologic_features_(Water_Overlay)|Hydrological features]]
With this option you can create a duplicate inactive copy of the current overlay. This is noticeable in the Overlays panel on the left side of the screen. The duplicated overlay will have (inactive copy) behind the overlay name and is greyed out. This copy is not being recalculated when changing settings in the original duplicated overlay. When checking the checkbox: active in simulation, the copy becomes active again and can be recalculated. Also the overlay name is again in black and not grayed out anymore.
:The water system can be enhanced with a number of hydrological features, which can be loaded in as [[area]]s. These hydrological features form special properties or modifications on the hydrological system. See [[Hydrologic_features_(Water_Overlay)|Hydological features]] for a list of supported features.
;[[Hydraulic structures (Water Overlay)|Hydraulic structures]]
:See [[Hydraulic structures (Water Overlay)|Hydraulic structures]] for the list of supported structures.
;[[Additional_hydrological_attributes_of_buildings_(Water Overlay)|Hydrological attributes of buildings]]
:Besides the [[building]]s which directly influence the hydrologic model as a [[Hydraulic structures (Water Overlay)|hydraulic structure]], each building may also have attributes which can contribute to the hydrological model in some way. These attributes are stored and used on a grid cell level. This is different from the hydraulic structure attributes, which are stored and used on an object level. For a full list, see [[Additional_hydrological_attributes_of_buildings_(Water Overlay)|Additional hydrological attributes of buildings]].
;[[Terrain_attributes_(Water_Overlay)| Hydrological attributes of terrain]]
:[[Terrain]]s in a project have a number of hydrological attributes which can influence the flow of water in a project. Because there is always both surface and underground terrain defined for the entirety of the project area, all cells are affected by all attributes of terrains, unless a building is present with overwriting values. For a full list, see [[Terrain_attributes_(Water_Overlay)| Terrain attributes for the water overlay]].
;[[Model_attributes_(Water_Overlay)|Model settings]]
:For a full list, see: [[Model_attributes_(Water_Overlay)|Water Model attributes]]


===Show Water Balance===
==Troubleshoot, warnings and recommendations==
The Water Balance panel shows the in- and outflow of water in m3. The Water Balance panel is also visible when clicking on the Debug info (see below).
When the Water Overlay is used and calculations take place, there are some problems or points of attention the calculation can run into. Where possible, the Water Overlay will show appropriate warnings when running into any issues.
The water balance is made up of the following components (depending on what is in the project):
See [[Warning_and_recommendations_(Water_Overlay)|Troubleshoot, warnings and recommendations]];
* Land surface: amount of water on the land surface after simulation (m3)
-->
* Water surface: amount of water stored on water cells after simulation (m3)
* Building storage: amount of water stored in building storage (m3)
* Sewer storage: amount of water stored in sewers after simulation (m3)
* Underground storage: amount of water stored in the sub-soil after simulation (m3)
* Evaporated: amount of water evaporated after simulation (m3)
* Outlet: amount of water extracted from the model during the simulation via outlets of water areas or sewer pumps (m3).


===Warnings===
==Results==
When the grid cell size is too large in combination with the project size, a warning pops up. This means that calculated results are not accurate. The solution to this is to reduce the grid cell size.
With a Water Overlay, a user can generate multiple [[Results_(Water_Overlay)|results]] for a single water simulation. For further information about these outcomes, see also [[Results_(Water_Overlay)|results]] and [[Result type (Water Overlay)|result types]].


===Debug Info===
==How-to's==
The debug info contains the following information:
* [[How to add and remove an Overlay]]
* Rain: the amount of rainfall (mm) in the duration of the rainfall event (hours)
* [[How to manually configure a Water Overlay|Configure a Water Overlay]]
* Total Simulation: the simulation period (hours)
* [[How to edit an overlay legend|Edit an overlay legend]]
* Cells: The dimensions of the simulation: the amount of computational cells and the amount of time steps (cycles)
* [[How to add Subsidence (Water Overlay)|Combine with Subsidence Overlay]]
* Water areas:
* [[Water Model Limits]] (some basic rules)
* Weir flow: the amount of water flown over weirs during simulation (m3)
* Sewer overflow: the amount of water flown over sewer overflows during simulation (m3)
* GPU time: the computation time on GPU (seconds)
* Volume: total volume of the in- and outflow of water in the model.
If you click on the Debug Info the Water Balance panel pops up.


==Keys tab==
===Features and components===
The tab Keys refers to the settings for the water system (areas and constructions) that are adjusted by following the configuration wizard in the General tab. It is therefore generally not needed to change the keys in this tab, as most of the keys are adjusted via the configuration wizard. However, below an explanation of the Keys for areas and buildings.
* [[Hydrological features (Water Overlay)|Hydrological features]]
* [[Hydraulic structures (Water Overlay)|Hydraulic structures]]
* [[How to_manually_configure_a_Water_Overlay|Manual configuration Options]]
* [[Simulation data (Water Overlay)|Simulation data]]


{| class="wikitable"
===Attributes===
! Attribute
* [[Model attributes (Water Overlay)|Water Module Attributes]]
! Unit
* [[Hydrological attributes of buildings (Water Overlay)|Hydrological Attributes of Buildings]]
! Description
* [[Hydrological attributes of terrains (Water Overlay)|Hydrological Attributes of Terrains]]
|-
|Water Level
|m + datum
|initial water level, relative to datum, for all water cells in a water area
|-
|Outlet
|m3/s
|water abstraction for all water cells in a water area
|-
|Outlet level
|m + datum
|initial water level, relative to datum, for all water cells in an outlet area (breach for example)
|-
|Outlet capacity
|m3
|maximum amount of water that can be used for the outlet
|-
|Sewer Storage
|m         
|available storage in sewers at the start of simulation in a sewer area
|-
|Sewer Pump Speed
|m3/s
|sewer water abstraction for all cells in a sewer area
|}
 
Keys referring to constructions (building attributes)
{| class="wikitable"
! Attribute
! Unit
! Description
|-
|Weir Height
|m + datum
|weir crest level
|-
|Weir Output
|m3/s
|The amount of water that flows through a weir/culvert
|-
|Weir Coefficient
|
|linear weir coefficient for accounting discharge & contraction losses
|-
|Culvert Speed
|m3/s
|the discharge capacity of a culvert
|-
|Pump Speed
|m3/s
|the capacity of a pump
|-
|Sewer Overflow Height
|m + datum
|the height of a crest of a sewer overflow
|-
|Sewer Overflow Speed
|m3/s
|the discharge capacity of a sewer overflow
|-
|Chloride
|x/m2
|Amount* of chloride which is created per second, per m² of construction with this attribute.
|-
|Nitrogen
|x/m2
|Amount* of nitrogen which is created per second, per m² of construction with this attribute.
|-
|Phosphorus
|x/m2
|Amount* of phosphorus which is created per second, per m² of construction with this attribute.
|-
|}
<nowiki>*</nowiki> The unit of the substances is left incomplete, as the project creator is free to set their own unit for quantities of substances.


==Attributes tab==
{{WaterOverlay output nav}}
This tab shows the attributes of result types that can be adjusted. These attributes can also be adjusted in the configuration wizard in step 5 in the General tab. It is therefore generally not needed to change the attributes here. However, below an overview of the Overlay Attributes.
{{Overlay nav}}


{| class="wikitable"
[[Category:Water Module]][[Category:Overlays with result types]]
! Attribute
! Unit
! Description
|-
|ALLOWED_WATER_INCREASE_M
|m
|increment by which the water level on a water cell is allowed to increase before the depth is shown in the WATER_STRESS result type
|-
|AVG_SURFACE_WATER
|
|''Description wil be added''
|-
|DESIGN_FLOOD_ELEVATION_M
|m
|''Description wil be added''
|-
|GROUND_BOTTOM_DISTANCE_M
|m
|''Description wil be added''
|-
|GROUND_WATER
|
|''Description wil be added''
|-
|IMPACT_FLOOD_THRESHOLD_M
|m
|maximum waterdepth on a cell which touches the building where after the building is assumed impacted, visualized in the IMPACTED_BUILDINGS result type
|-
|MAX_SPEED_MS
|
|Maximum speed at which water is allowed to flow. As the maximum speed is set higher, the time per step of the calculation is reduced, increasing total time for the calculation to complete.
|-
|MIN_SLOPE
|
|slope whereunder the pressure slope is assumed 0
|-
|SEWER_OVERFLOW_THRESHOLD
|
|fraction of storage whereafter sewer overflows take place
|-
|SHOW_DURATION_FLOOD_LEVEL_M
|m
|threshold value of the amount of water on a grid cell that is used for the SURFACE_DURATION result type
|-
|SUPERGRID
|
|''Description wil be added''
|-
|SURFACE_WATER_EVAPORATION_FACTOR
|
|''Description wil be added''
|-
|TIMEFRAMES
|
|the number of intermediate (overlay) results you would like to see of the calculation. A timeframe is not the same as a timestep. A timeframe is an intermediate (overlay) result and can contain already a number of timesteps. The number of timesteps is based on the grid cell size and the speed of the flooding (see for more information the [[Flooding_(Overlay)#Flooding_Model|Courant number]]).
|}

Latest revision as of 13:40, 17 January 2023

A Water Overlay is a grid overlay for which results are calculated by the Water Module. The Basic theory of the Water Module in the Tygron Platform is an implementation of a 2D grid based shallow water model based on the 2D Saint Venant equations. The module is further enhanced with infiltration, evaporation, groundwater flow and hydraulic structures. Depending on the use case, the simulated period can be set to few seconds and up to a few months. The theory section describes in detail how calculations are performed.

To perform the calculations, the project area is divided into a grid of cells. Each cell has a specific quantity of water and specific hydrological parameters based on the data in the project. The total time which should be simulated is divided into discrete timesteps. Per timestep, each cell communicates with its adjacent cells to exchange water, based on its water level, surface height, current flow direction and other factors. Accuracy and reliability is obtained by dividing the project area and simulation time into sufficiently small cells and steps, at the cost of more computation time.

The final results of the calculation can be inspected, as well as intermediate snapshots of the hydrological situation during the simulation, known as timeframes.

Variants

A Water Module will be initialized by adding one of the following Overlays to a project. Each variant has a number of parameters tuned to best fit specific use-cases. This means that each of these overlays is based on the same theory and calculation method, however they are customized to conveniently provide insight in different aspects of the Water Module.

Overlay rainfall.png Rainfall Overlay provides insight into the water stress and impact caused by (excessive) rainfall
Overlay flooding.png Flooding Overlay provides insight into water stress and impact caused by breaches in levees or other sources causing excessive water inflow
Overlay groundwater.png Groundwater Overlay provides insight into long-term processes of water flow both on the surface and underground

Results

With a Water Overlay, a user can generate multiple results for a single water simulation. For further information about these outcomes, see also results and result types.

How-to's

Features and components

Attributes