How to manually configure a Water Overlay - Revision history

Frank@tygron.nl at 13:37, 14 July 2026

2026-07-14T13:37:34Z

← Older revision		Revision as of 13:37, 14 July 2026
Line 89:		Line 89:
	*[[Water Overlay]]		*[[Water Overlay]]
	\|api=		\|api=
			*[[Api session event editor overlay add]]
			*[[Api session event editor overlay add result child]]
	*[[Api session event editor overlay set attribute]]		*[[Api session event editor overlay set attribute]]
	*[[Api session event editor overlay set key value]]		*[[Api session event editor overlay set key value]]

Frank@tygron.nl at 13:31, 14 July 2026

2026-07-14T13:31:57Z

← Older revision		Revision as of 13:31, 14 July 2026
Line 32:		Line 32:
	{{main\|section=section\|Subsidence data model\|Subsidence}}		{{main\|section=section\|Subsidence data model\|Subsidence}}
	{{Editor location\|overlay keys\|Include subsidence}}		{{Editor location\|overlay keys\|Include subsidence}}
	It's possible to connect the water overlay to a [[Subsidence (Overlay)\|subsidence overlay]], if one exists in the project. The result of the subsidence calculation, specifically the amount the terrain has lowered, ~~are~~ applied to the terrain height at the start of the water model's simulation. A connection to a subsidence overlay is optional. If no subsidence overlay is connected, the terrain height is not adjusted in this fashion.		It's possible to connect the water overlay to a [[Subsidence (Overlay)\|subsidence overlay]], if one exists in the project. The result of the subsidence calculation, specifically the amount the terrain has lowered, is applied to the terrain height at the start of the water model's simulation. A connection to a subsidence overlay is optional. If no subsidence overlay is connected, the terrain height is not adjusted in this fashion.

	The connection to a subsidence overlay can be made by changing the value selected in the "Subsidence" dropdown to the appropriate subsidence overlay.		The connection to a subsidence overlay can be made by changing the value selected in the "Subsidence" dropdown to the appropriate subsidence overlay.
Line 88:		Line 88:
	\|seealso=		\|seealso=
	*[[Water Overlay]]		*[[Water Overlay]]
			\|api=
			*[[Api session event editor overlay set attribute]]
			*[[Api session event editor overlay set key value]]
			*[[Api session event editor overlay set water weather]]
			*[[Api session event editor overlay remove water weather]].
	}}		}}

	[[Category:How-to's]]		[[Category:How-to's]]

Maxim@tygron.com at 07:17, 9 July 2026

2026-07-09T07:17:22Z

Frank@tygron.nl at 11:07, 8 July 2026

2026-07-08T11:07:36Z

Frank@tygron.nl at 15:36, 30 January 2024

2024-01-30T15:36:04Z

← Older revision		Revision as of 15:36, 30 January 2024
Line 85:		Line 85:
	Any of the attributes of the overlay can be changed on the "Attributes" tab, by changing the value in the input box for the attribute which is to be changed.		Any of the attributes of the overlay can be changed on the "Attributes" tab, by changing the value in the input box for the attribute which is to be changed.

	~~==More Information=~~=		{{article end
	{{Water ~~Module buttons~~}}		\|seealso=
			*[[Water Overlay]]
			}}

			[[Category:How-to's]]

Frank@tygron.nl at 12:40, 1 March 2023

2023-03-01T12:40:04Z

← Older revision		Revision as of 12:40, 1 March 2023
Line 1:		Line 1:
	When first added to the project, each variant of the [[Water Overlay\|water overlay]] will be created with a default configuration which will allow for an initial calculation to take place and results to display. For most use-cases, it is desirable to add additional data and tweak the settings and parameters of the overlay. This will improve the accuracy and relevancy of the overlay. It is possible to configure the parameters manually, or by using the [[Water Overlay Wizard\|configuration wizard]]. A few settings can only be changed manually. Besides the [[Data\|data]] of geographical features, which have their own means of loading in depending on their type, all manual configuration options are listed here.		When first added to the project, each variant of the [[Water Overlay\|water overlay]] will be created with a default configuration which will allow for an initial calculation to take place and results to display. For most use-cases, it is desirable to add additional data and tweak the settings and parameters of the overlay. This will improve the accuracy and relevancy of the overlay. It is possible to configure the parameters manually, or by using the [[Water Overlay Wizard\|configuration wizard]]. A few settings can only be changed manually. Besides the [[Geo Data\|data]] of geographical features, which have their own means of loading in depending on their type, all manual configuration options are listed here.

	====Grid cell size configuration====		====Grid cell size configuration====

Frank@tygron.nl at 12:21, 30 January 2023

2023-01-30T12:21:24Z

← Older revision		Revision as of 12:21, 30 January 2023
Line 1:		Line 1:
	~~===Introduction to Manual configuration===~~
	When first added to the project, each variant of the [[Water Overlay\|water overlay]] will be created with a default configuration which will allow for an initial calculation to take place and results to display. For most use-cases, it is desirable to add additional data and tweak the settings and parameters of the overlay. This will improve the accuracy and relevancy of the overlay. It is possible to configure the parameters manually, or by using the [[Water Overlay Wizard\|configuration wizard]]. A few settings can only be changed manually. Besides the [[Data\|data]] of geographical features, which have their own means of loading in depending on their type, all manual configuration options are listed here.		When first added to the project, each variant of the [[Water Overlay\|water overlay]] will be created with a default configuration which will allow for an initial calculation to take place and results to display. For most use-cases, it is desirable to add additional data and tweak the settings and parameters of the overlay. This will improve the accuracy and relevancy of the overlay. It is possible to configure the parameters manually, or by using the [[Water Overlay Wizard\|configuration wizard]]. A few settings can only be changed manually. Besides the [[Data\|data]] of geographical features, which have their own means of loading in depending on their type, all manual configuration options are listed here.

Line 75:		Line 74:

	=====Keys=====		=====Keys=====
	The water model makes use of data present in geographical features in the [[~~3D world~~]]. This data is used as input for the various calculations which together model the water flow. The water model recognizes what attributes of geographical features form the parameters required for the calculation through key definitions. Each key is the name of an attribute which the water model should use to determine a specific parameter.		The water model makes use of data present in geographical features in the [[project]]. This data is used as input for the various calculations which together model the water flow. The water model recognizes what attributes of geographical features form the parameters required for the calculation through key definitions. Each key is the name of an attribute which the water model should use to determine a specific parameter.

	Keys are set to default attribute names, which apply to {{inlink\|lcase=1\|Hydrological features}}, {{inlink\|lcase=1\|Hydrological buildings}}, and {{inlink\|lcase=1\|Hydrological properties of terrain}}. Keys can be changed so that imported data can be interpreted without renaming attributes, or to allow different configurations to come forth from the same dataset.		Keys are set to default attribute names, which apply to {{inlink\|lcase=1\|Hydrological features}}, {{inlink\|lcase=1\|Hydrological buildings}}, and {{inlink\|lcase=1\|Hydrological properties of terrain}}. Keys can be changed so that imported data can be interpreted without renaming attributes, or to allow different configurations to come forth from the same dataset.

Maxim@tygron.com at 15:17, 7 October 2022

2022-10-07T15:17:12Z

Frank@tygron.nl at 12:26, 17 January 2022

2022-01-17T12:26:41Z

← Older revision		Revision as of 12:26, 17 January 2022
Line 26:		Line 26:
	{{main\|section=section\|Ground water data model\|Ground water}}		{{main\|section=section\|Ground water data model\|Ground water}}
	{{Editor location\|overlay keys\|Include ground water tiff}}		{{Editor location\|overlay keys\|Include ground water tiff}}
	A ground water [[~~GeoTiff~~]] can be loaded in to prepopulate the underground with water in the form of a saturated zone. This is only a relevant configuration when the {{inlink\|lcase=1\|Underground model}} is active. A ground water ~~GeoTiff~~ is optional. If no ground water tiff is selected, the assumed ground water level is equal to the {{inlink\|WATER_LEVEL}} of the {{inlink\|lcase=1\|Water area}}.		A ground water [[GeoTIFF]] can be loaded in to prepopulate the underground with water in the form of a saturated zone. This is only a relevant configuration when the {{inlink\|lcase=1\|Underground model}} is active. A ground water GeoTIFF is optional. If no ground water tiff is selected, the assumed ground water level is equal to the {{inlink\|WATER_LEVEL}} of the {{inlink\|lcase=1\|Water area}}.

	The presence of a ground water ~~GeoTiff~~ can be toggled by checking or unchecking the "Include ground water tiff" checkbox. When checked, a number of ~~GeoTiffs~~ are available for ground water levels by default. Other ~~GeoTiffs~~ for groundwater levels can also be loaded in by clicking on "Select ~~GeoTiff~~".		The presence of a ground water GeoTIFF can be toggled by checking or unchecking the "Include ground water tiff" checkbox. When checked, a number of GeoTIFFs are available for ground water levels by default. Other GeoTIFFs for groundwater levels can also be loaded in by clicking on "Select GeoTIFF".

	====Subsidence configuration====		====Subsidence configuration====

Frank@tygron.nl: /* Ground water configuration */

2021-05-28T07:09:17Z

Ground water configuration

← Older revision		Revision as of 07:09, 28 May 2021
Line 26:		Line 26:
	{{main\|section=section\|Ground water data model\|Ground water}}		{{main\|section=section\|Ground water data model\|Ground water}}
	{{Editor location\|overlay keys\|Include ground water tiff}}		{{Editor location\|overlay keys\|Include ground water tiff}}
	A ground water [[GeoTiff]] can be loaded in to prepopulate the underground with water in the form of a saturated zone. This is only a relevant configuration when the {{inlink\|lcase=1\|Underground model}} is active. A ground water GeoTiff is optional. If no ground water tiff is selected, the assumed ground water level is equal to the {{inlink\|WATER_LEVEL}} of the {{inlink\|lcase=1\|Water ~~level~~ area}}.		A ground water [[GeoTiff]] can be loaded in to prepopulate the underground with water in the form of a saturated zone. This is only a relevant configuration when the {{inlink\|lcase=1\|Underground model}} is active. A ground water GeoTiff is optional. If no ground water tiff is selected, the assumed ground water level is equal to the {{inlink\|WATER_LEVEL}} of the {{inlink\|lcase=1\|Water area}}.

	The presence of a ground water GeoTiff can be toggled by checking or unchecking the "Include ground water tiff" checkbox. When checked, a number of GeoTiffs are available for ground water levels by default. Other GeoTiffs for groundwater levels can also be loaded in by clicking on "Select GeoTiff".		The presence of a ground water GeoTiff can be toggled by checking or unchecking the "Include ground water tiff" checkbox. When checked, a number of GeoTiffs are available for ground water levels by default. Other GeoTiffs for groundwater levels can also be loaded in by clicking on "Select GeoTiff".

← Older revision		Revision as of 07:17, 9 July 2026
Line 1:		Line 1:
	When first added to the project, each variant of the [[Water Overlay\|water overlay]] will be created with a default configuration which will allow for an initial calculation to take place and results to display. ~~For most use-cases, it is desirable to add additional~~ data and ~~tweak the~~ settings and parameters of the overlay. This will improve the accuracy and relevancy of the overlay. It is possible to configure the parameters manually, or by using the [[Water Overlay Wizard\|configuration wizard]]. A few settings can only be changed manually. Besides the [[Geo Data\|data]] of geographical features, which have their own means of loading in depending on their type, all manual configuration options are listed here.		When first added to the project, each variant of the [[Water Overlay\|water overlay]] will be created with a default configuration which will allow for an initial calculation to take place and results to display. Additional data can be added and settings and parameters of the overlay can be tweaked for specific use-cases. This will improve the accuracy and relevancy of the overlay. It is possible to configure the parameters manually, or by using the [[Water Overlay Wizard\|configuration wizard]]. A few settings can only be changed manually. Besides the [[Geo Data\|data]] of geographical features, which have their own means of loading in depending on their type, all manual configuration options are listed here.

	====Grid cell size configuration====		====Grid cell size configuration====
Line 53:		Line 53:
	{{main\|section=section\|Result type}}		{{main\|section=section\|Result type}}
	{{Editor location\|overlay general\|Result type}}		{{Editor location\|overlay general\|Result type}}
	The water model performs a complete simulation in which water flows through the project area. ~~For many~~ use-~~cases~~ only a specific type of output resulting from the simulation ~~is relevant~~. The result type of the water overlay indicates exactly what kind of data is recorded and outputted.		The water model performs a complete simulation in which water flows through the project area. Depending on the use-case, only a specific type of output resulting from the simulation may be required. The result type of the water overlay indicates exactly what kind of data is recorded and outputted.

	The result type can be changed by selecting the desired result type in the "Result type" dropdown.		The result type can be changed by selecting the desired result type in the "Result type" dropdown.
Line 62:		Line 62:
	{{main\|Grid overlay#Legend\|Grid overlay}}		{{main\|Grid overlay#Legend\|Grid overlay}}
	{{Editor location\|overlay legend}}		{{Editor location\|overlay legend}}
	Depending on the selected {{inlink\|lcase=1\|Result type\|}}, the output created by the water overlay ~~can or should be~~ interpreted in different ways. The raw data calculated is assigned colors based on the configured legend. Each result type has an assigned default legend which helps with interpreting the output. ~~The default~~ legends ~~will often be sufficient~~, but can be modified to fit specific meanings or result ranges.		Depending on the selected {{inlink\|lcase=1\|Result type\|}}, the output created by the water overlay is interpreted in different ways. The raw data calculated is assigned colors based on the configured legend. Each result type has an assigned default legend which helps with interpreting the output. Default legends are provided, but these can be modified to fit specific meanings or result ranges.

	The legend can be modified in the "Legend" tab by checking the "Has custom legend" checkbox. Entries for the legend can then be added, modified, and removed. Any changes in the legend are applied to the visualization immediately, without recalculation of the overlay's output values.		The legend can be modified in the "Legend" tab by checking the "Has custom legend" checkbox. Entries for the legend can then be added, modified, and removed. Any changes in the legend are applied to the visualization immediately, without recalculation of the overlay's output values.
Line 81:		Line 81:
	{{main\|section=section\|Attributes}}		{{main\|section=section\|Attributes}}
	{{Editor location\|overlay attributes}}		{{Editor location\|overlay attributes}}
	The water model's calculations make use of a number of centralized parameters, which are configured as [[attribute]]s of the overlay. Default parameters vary by water overlay variant to better suit specific calculation types. ~~The parameters~~ can be tweaked further to ~~better~~ fit specific use-cases, ~~but in general the defaults~~ are ~~appropriate for most calculations~~.		The water model's calculations make use of a number of centralized parameters, which are configured as [[attribute]]s of the overlay. Default parameters vary by water overlay variant to better suit specific calculation types. Parameters can be tweaked further to fit specific use-cases; otherwise, default values are used.

	Any of the attributes of the overlay can be changed on the "Attributes" tab, by changing the value in the input box for the attribute which is to be changed.		Any of the attributes of the overlay can be changed on the "Attributes" tab, by changing the value in the input box for the attribute which is to be changed.

← Older revision		Revision as of 11:07, 8 July 2026
Line 18:		Line 18:
	{{main\|section=section\|Weather}}		{{main\|section=section\|Weather}}
	{{Editor location\|overlay keys\|3="Edit", next to weather}}		{{Editor location\|overlay keys\|3="Edit", next to weather}}
	~~The weather configuration, which dictates the {{inlink\|Rain and~~ simulation ~~time\|~~duration ~~of the simulation~~, ~~the amount of rain}}~~ and ~~the {{inlink\|lcase=1\|Evaporation rate}}, is modeled as~~ a separate weather object ~~which is~~ connected to the water overlay. The weather object can be replaced with another, changing the main simulation and weather properties. The weather itself can be changed as well.		Weather configuration—including simulation duration, rainfall, and evaporation rate—is managed via a separate weather object connected to the water overlay. The weather object can be replaced with another, changing the main simulation and weather properties. The weather itself can be changed as well.

	~~By selecting~~ the weather object ~~and then switching to the~~ "Simulation" tab, ~~it's possible to change the settings of the~~ weather either ~~for~~ a simple linear setup or ~~with~~ a ~~more~~ complex sequence of values ~~for the duration of the simulation~~. The complex setup can be created by loading in a [[CSV (comma separated values)]] file. By switching to the attributes tab of the weather object, the same properties can be adjusted by directly modifying the attributes.		In the weather object's "Simulation" tab, you can configure weather using either a simple linear setup or a complex sequence of values. The complex setup can be created by loading in a [[CSV (comma separated values)]] file. By switching to the attributes tab of the weather object, the same properties can be adjusted by directly modifying the attributes.

	====Ground water configuration====		====Ground water configuration====
Line 39:		Line 39:
	{{main\|section=section\|System visualization\|System visualization}}		{{main\|section=section\|System visualization\|System visualization}}
	{{Editor location\|overlay general\|Show system visualization}}		{{Editor location\|overlay general\|Show system visualization}}
	The water overlay ~~performs a simulation in which much~~ detailed flow ~~takes place~~, ~~but in which a number of~~ features ~~perform special~~ functions ~~related to water flow~~. These features include the sewers and the {{inlink\|lcase=1\|Hydrological buildings}}. ~~The~~ flow ~~of these sections of the hydrological model~~ can be visualized as ~~an explicit~~ graph ~~overlayed~~ on the overlay.		The water overlay simulates detailed flow, with specific features performing specialized hydrological functions. These features include the sewers and the {{inlink\|lcase=1\|Hydrological buildings}}. This flow can be visualized as a graph overlaid on the water overlay.

	The system visualization can be toggled by checking or unchecking the "Show System Visualization" checkbox.		The system visualization can be toggled by checking or unchecking the "Show System Visualization" checkbox.
Line 46:		Line 46:
	{{main\|Grid overlay#Active\|Grid overlay}}		{{main\|Grid overlay#Active\|Grid overlay}}
	{{Editor location\|overlay general\|Active in simulation}}		{{Editor location\|overlay general\|Active in simulation}}
	Like all grid overlays, the water overlays can be configured to either an active or inactive state. This ~~is especially useful when the results of a calculation should be available for insight without the~~ computational overhead ~~of always recalculating the overlay~~ when changes ~~in the project take place~~.		Like all grid overlays, the water overlays can be configured to either an active or inactive state. This avoids unnecessary recalculations and computational overhead when viewing existing results during project changes.

	An overlay can be toggled between active and inactive by checking or unchecking the "Active in simulation" checkbox.		An overlay can be toggled between active and inactive by checking or unchecking the "Active in simulation" checkbox.
Line 69:		Line 69:
	{{main\|section=section\|Keys}}		{{main\|section=section\|Keys}}
	{{Editor location\|overlay keys}}		{{Editor location\|overlay keys}}
	The water model's calculations rely on a number of [[area]]s and [[building]]s for their input data. {{inlink\|Hydrological features}} and {{inlink\|lcase=1\|Hydrological buildings}} have special meanings in terms of policy or scenario. ~~To allow for both~~ compatibility with external data ~~as well as~~ parallel calculations for different ~~scenario's, it is possible to (re)define the exact attributes the overlay uses for those inputs~~. This would allow two instances of a water overlay to work with the same dataset but with different configurations for hydrological features or buildings.		The water model's calculations rely on a number of [[area]]s and [[building]]s for their input data. {{inlink\|Hydrological features}} and {{inlink\|lcase=1\|Hydrological buildings}} have special meanings in terms of policy or scenario. Attributes can be redefined to ensure compatibility with external data or to support parallel calculations for different scenarios. This would allow two instances of a water overlay to work with the same dataset but with different configurations for hydrological features or buildings.

	The exact attributes the overlay uses as input from hydrological features and buildings can be changed on the "Keys" tab, by using the relevant dropdown to change the attribute name to the desired attribute.		The exact attributes the overlay uses as input from hydrological features and buildings can be changed on the "Keys" tab, by using the relevant dropdown to change the attribute name to the desired attribute.
Line 81:		Line 81:
	{{main\|section=section\|Attributes}}		{{main\|section=section\|Attributes}}
	{{Editor location\|overlay attributes}}		{{Editor location\|overlay attributes}}
	The water model's calculations make use of a number of centralized parameters, which are configured as [[attribute]]s of the overlay. ~~Depending on the exact {{inlink\|lcase=1\|Variants}} of the~~ water overlay~~, some of the parameters will have different defaults~~ to better suit ~~the exact type of~~ calculation. The parameters can be tweaked further to better fit specific use-cases, but in general the defaults are appropriate for most calculations.		The water model's calculations make use of a number of centralized parameters, which are configured as [[attribute]]s of the overlay. Default parameters vary by water overlay variant to better suit specific calculation types. The parameters can be tweaked further to better fit specific use-cases, but in general the defaults are appropriate for most calculations.

	Any of the attributes of the overlay can be changed on the "Attributes" tab, by changing the value in the input box for the attribute which is to be changed.		Any of the attributes of the overlay can be changed on the "Attributes" tab, by changing the value in the input box for the attribute which is to be changed.

← Older revision		Revision as of 15:17, 7 October 2022
Line 40:		Line 40:
	{{main\|section=section\|System visualization\|System visualization}}		{{main\|section=section\|System visualization\|System visualization}}
	{{Editor location\|overlay general\|Show system visualization}}		{{Editor location\|overlay general\|Show system visualization}}
	The water overlay performs a simulation in which much detailed flow takes place, but in which a number of features perform special functions related to water flow. These features include the sewers and the {{inlink\|lcase=1\|Hydrological ~~constructions~~}}. The flow of these sections of the hydrological model can be visualized as an explicit graph overlayed on the overlay.		The water overlay performs a simulation in which much detailed flow takes place, but in which a number of features perform special functions related to water flow. These features include the sewers and the {{inlink\|lcase=1\|Hydrological buildings}}. The flow of these sections of the hydrological model can be visualized as an explicit graph overlayed on the overlay.

	The system visualization can be toggled by checking or unchecking the "Show System Visualization" checkbox.		The system visualization can be toggled by checking or unchecking the "Show System Visualization" checkbox.
Line 70:		Line 70:
	{{main\|section=section\|Keys}}		{{main\|section=section\|Keys}}
	{{Editor location\|overlay keys}}		{{Editor location\|overlay keys}}
	The water model's calculations rely on a number of [[area]]s and [[~~construction~~]]s for their input data. {{inlink\|Hydrological features}} and {{inlink\|lcase=1\|Hydrological ~~constructions~~}} have special meanings in terms of policy or scenario. To allow for both compatibility with external data as well as parallel calculations for different scenario's, it is possible to (re)define the exact attributes the overlay uses for those inputs. This would allow two instances of a water overlay to work with the same dataset but with different configurations for hydrological features or ~~constructions~~.		The water model's calculations rely on a number of [[area]]s and [[building]]s for their input data. {{inlink\|Hydrological features}} and {{inlink\|lcase=1\|Hydrological buildings}} have special meanings in terms of policy or scenario. To allow for both compatibility with external data as well as parallel calculations for different scenario's, it is possible to (re)define the exact attributes the overlay uses for those inputs. This would allow two instances of a water overlay to work with the same dataset but with different configurations for hydrological features or buildings.

	The exact attributes the overlay uses as input from hydrological features and ~~constructions~~ can be changed on the "Keys" tab, by using the relevant dropdown to change the attribute name to the desired attribute.		The exact attributes the overlay uses as input from hydrological features and buildings can be changed on the "Keys" tab, by using the relevant dropdown to change the attribute name to the desired attribute.

	=====Keys=====		=====Keys=====
	The water model makes use of data present in geographical features in the [[3D world]]. This data is used as input for the various calculations which together model the water flow. The water model recognizes what attributes of geographical features form the parameters required for the calculation through key definitions. Each key is the name of an attribute which the water model should use to determine a specific parameter.		The water model makes use of data present in geographical features in the [[3D world]]. This data is used as input for the various calculations which together model the water flow. The water model recognizes what attributes of geographical features form the parameters required for the calculation through key definitions. Each key is the name of an attribute which the water model should use to determine a specific parameter.

	Keys are set to default attribute names, which apply to {{inlink\|lcase=1\|Hydrological features}}, {{inlink\|lcase=1\|Hydrological ~~constructions~~}}, and {{inlink\|lcase=1\|Hydrological properties of terrain}}. Keys can be changed so that imported data can be interpreted without renaming attributes, or to allow different configurations to come forth from the same dataset.		Keys are set to default attribute names, which apply to {{inlink\|lcase=1\|Hydrological features}}, {{inlink\|lcase=1\|Hydrological buildings}}, and {{inlink\|lcase=1\|Hydrological properties of terrain}}. Keys can be changed so that imported data can be interpreted without renaming attributes, or to allow different configurations to come forth from the same dataset.

	====Attributes configuration====		====Attributes configuration====