Hydraulic structures (Water Overlay) - Revision history

Maxim@tygron.com at 11:36, 5 October 2022

2022-10-05T11:36:53Z

Godelief@tygron.com at 12:36, 10 May 2021

2021-05-10T12:36:25Z

← Older revision		Revision as of 12:36, 10 May 2021
Line 31:		Line 31:

	==Total flow==		==Total flow==
	When the calculation of the water overlay ~~completes~~, the total amount of water that has flowed through a specific construction is stored in an attribute in that construction. By default, this attribute is [[Object flow output (Water Overlay)\|OBJECT_FLOW_OUTPUT]], and the flow is expressed in m3. Since multiple water overlays can exist in the project simultaneously, the attribute name is appended with an underscore and the overlay [[ID]] such that each overlay (as they are added to the project) can write to a unique attribute.		When the calculation of the water overlay is completed, the total amount of water that has flowed through a specific construction is stored in an attribute in that construction. By default, this attribute is [[Object flow output (Water Overlay)\|OBJECT_FLOW_OUTPUT]], and the flow is expressed in m3. Since multiple water overlays can exist in the project simultaneously, the attribute name is appended with an underscore and the overlay [[ID]] such that each overlay (as they are added to the project) can write to a unique attribute.

			==Water level==
			When the calculation of the water overlay is completed, the [[Water_level_(Water_Overlay)\|water level]]s at either side of a specific construction is stored in an attribute in that construction.
			By default, this attribute is [[Object_datum_output_(Water_Overlay)\|OBJECT_DATUM_OUTPUT]]. Since multiple water overlays can exist in a project simultaneously, the attribute name is appended with an underscore and the overlay [[ID]] such that each overlay (as they are added to the project) can write to a unique attribute.

	{{article end		{{article end
	\|notes=		\|notes=

Rudolf@tygron.nl: /* Types */

2021-03-01T12:36:57Z

Types

← Older revision		Revision as of 12:36, 1 March 2021
Line 20:		Line 20:
	; {{linkappend\|post= (Water Overlay)\|Point-based construction}}s		; {{linkappend\|post= (Water Overlay)\|Point-based construction}}s
	: {{RequestImage\|description=A simple polygon shape (square), then the visualization of the calculation of the center-point, and finally the highlighting of the endpoint.}}Point-based constructions add or remove water in one or more computational layers, based on their formula's. The center-point of a point-based construction, the exact cell where the effect takes place, is the geometric center of the construction's polygon.		: {{RequestImage\|description=A simple polygon shape (square), then the visualization of the calculation of the center-point, and finally the highlighting of the endpoint.}}Point-based constructions add or remove water in one or more computational layers, based on their formula's. The center-point of a point-based construction, the exact cell where the effect takes place, is the geometric center of the construction's polygon.
	~~Note that the more complex the polygon is, the more difficult it is for the {{software}} to resolve it to a simple line or center point.~~
	; {{linkappend\|post= (Water Overlay)\|Area-based construction}}s		; {{linkappend\|post= (Water Overlay)\|Area-based construction}}s
	: {{RequestImage\|description=A simple polygon shape (rectangle). No further calculations.}} Area-based constructions add or remove water in one or more computation layers, based on their formula. In principle, all cells which the construction intersects are affected, though the exact effects may differ based on the presence of other features in those cells.		: {{RequestImage\|description=A simple polygon shape (rectangle). No further calculations.}} Area-based constructions add or remove water in one or more computation layers, based on their formula. In principle, all cells which the construction intersects are affected, though the exact effects may differ based on the presence of other features in those cells.

Rudolf@tygron.nl: /* Types */

2021-01-29T11:09:13Z

Types

← Older revision		Revision as of 11:09, 29 January 2021
Line 16:		Line 16:
	==Types==		==Types==
	Hydraulic structures can be either line-based or point-based:		Hydraulic structures can be either line-based or point-based:
	* [[Line-based_construction_(~~Water_Overlay~~)\|Line-based ~~constructions]]<br>~~{{RequestImage\|description=A simple polygon shape (rectangle), then the visualization of the skeleton lines, then the highlighting of the relevant endpoints.}}Line-based constructions form a direct connection between two exact cells, allowing water to flow from one point to another. The flow is dictated by the construction's formula. The endpoints of a line-based construction, the exact cells which are connected by the construction, are computed based on the orientation and size of their polygon. Essentially, the furthest ends of the polygon are used as end-points. Because the cells of either endpoint are considered adjacent, any calculated flow through line-based hydraulic structures is instantaneous.		; {{linkappend\|post= (Water Overlay)\|Line-based construction}}s
	* [[Point-based_construction_(~~Water_Overlay~~)\|Point-based ~~constructions]]<br>~~{{RequestImage\|description=A simple polygon shape (square), then the visualization of the calculation of the center-point, and finally the highlighting of the endpoint.}}Point-based constructions add or remove water in one or more computational layers, based on their formula's. The center-point of a point-based construction, the exact cell where the effect takes place, is the geometric center of the construction's polygon.		: {{RequestImage\|description=A simple polygon shape (rectangle), then the visualization of the skeleton lines, then the highlighting of the relevant endpoints.}}Line-based constructions form a direct connection between two exact cells, allowing water to flow from one point to another. The flow is dictated by the construction's formula. The endpoints of a line-based construction, the exact cells which are connected by the construction, are computed based on the orientation and size of their polygon. Essentially, the furthest ends of the polygon are used as end-points. Because the cells of either endpoint are considered adjacent, any calculated flow through line-based hydraulic structures is instantaneous.
			; {{linkappend\|post= (Water Overlay)\|Point-based construction}}s
			: {{RequestImage\|description=A simple polygon shape (square), then the visualization of the calculation of the center-point, and finally the highlighting of the endpoint.}}Point-based constructions add or remove water in one or more computational layers, based on their formula's. The center-point of a point-based construction, the exact cell where the effect takes place, is the geometric center of the construction's polygon.
			Note that the more complex the polygon is, the more difficult it is for the {{software}} to resolve it to a simple line or center point.
			; {{linkappend\|post= (Water Overlay)\|Area-based construction}}s
			: {{RequestImage\|description=A simple polygon shape (rectangle). No further calculations.}} Area-based constructions add or remove water in one or more computation layers, based on their formula. In principle, all cells which the construction intersects are affected, though the exact effects may differ based on the presence of other features in those cells.

	Note that the more complex the polygon is, the more difficult it is for the {{software}} to resolve it to a simple line or center point.		Note that the more complex the polygon is, the more difficult it is for the {{software}} to resolve it to a simple line or center point.

Frank@tygron.nl at 14:58, 7 December 2020

2020-12-07T14:58:16Z

← Older revision		Revision as of 14:58, 7 December 2020
Line 5:		Line 5:
	{{Overlay features\|suppresscategory=true\|allowselflinks=true\|		{{Overlay features\|suppresscategory=true\|allowselflinks=true\|
	{{Overlay features\|type=row\|overlay=Water\|name=Inlet \|icon=Waterwizard_icon_inlet.png \|category=Hydraulic structure \|ftype=Point \|key=INLET_Q}}		{{Overlay features\|type=row\|overlay=Water\|name=Inlet \|icon=Waterwizard_icon_inlet.png \|category=Hydraulic structure \|ftype=Point \|key=INLET_Q}}
	{{Overlay features\|type=row\|overlay=Water\|name=Pump \|icon=~~Waterwizard_icon_pump_q~~.png \|category=Hydraulic structure \|ftype=Line \|key=PUMP_Q}}		{{Overlay features\|type=row\|overlay=Water\|name=Pump \|icon=Waterwizard_icon_pump.png \|category=Hydraulic structure \|ftype=Line \|key=PUMP_Q}}
	{{Overlay features\|type=row\|overlay=Water\|name=Culvert \|icon=Waterwizard_icon_culvert.png \|category=Hydraulic structure \|ftype=Line \|key=CULVERT_DIAMETER}}		{{Overlay features\|type=row\|overlay=Water\|name=Culvert \|icon=Waterwizard_icon_culvert.png \|category=Hydraulic structure \|ftype=Line \|key=CULVERT_DIAMETER}}
	{{Overlay features\|type=row\|overlay=Water\|name=Sewer overflow \|icon=Waterwizard_icon_sewer_overflow.png \|category=Hydraulic structure \|ftype=Point \|key=SEWER_OVERFLOW}}		{{Overlay features\|type=row\|overlay=Water\|name=Sewer overflow \|icon=Waterwizard_icon_sewer_overflow.png \|category=Hydraulic structure \|ftype=Point \|key=SEWER_OVERFLOW}}

Frank@tygron.nl at 12:11, 4 December 2020

2020-12-04T12:11:25Z

← Older revision		Revision as of 12:11, 4 December 2020
Line 9:		Line 9:
	{{Overlay features\|type=row\|overlay=Water\|name=Sewer overflow \|icon=Waterwizard_icon_sewer_overflow.png \|category=Hydraulic structure \|ftype=Point \|key=SEWER_OVERFLOW}}		{{Overlay features\|type=row\|overlay=Water\|name=Sewer overflow \|icon=Waterwizard_icon_sewer_overflow.png \|category=Hydraulic structure \|ftype=Point \|key=SEWER_OVERFLOW}}
	{{Overlay features\|type=row\|overlay=Water\|name=Weir \|icon=Waterwizard_icon_weir.png \|category=Hydraulic structure \|ftype=Line \|key=WEIR_HEIGHT}}		{{Overlay features\|type=row\|overlay=Water\|name=Weir \|icon=Waterwizard_icon_weir.png \|category=Hydraulic structure \|ftype=Line \|key=WEIR_HEIGHT}}
			{{Overlay features\|type=row\|overlay=Water\|name=Drainage \|icon=Waterwizard_icon_drainage.png \|category=Hydraulic structure \|ftype=Line \|key=DRAINAGE_Q}}
	}}		}}

Rudolf@tygron.nl at 09:08, 29 October 2020

2020-10-29T09:08:57Z

← Older revision		Revision as of 09:08, 29 October 2020
Line 2:		Line 2:

	In general, for ease of use, hydraulic structures are by default imported as underground constructions.		In general, for ease of use, hydraulic structures are by default imported as underground constructions.
	~~<!--~~
	{{Overlay features\|suppresscategory=true\|allowselflinks=true\|		{{Overlay features\|suppresscategory=true\|allowselflinks=true\|
	{{Overlay features\|type=row\|overlay=Water\|name=Inlet \|icon=Waterwizard_icon_inlet.png \|category=Hydraulic structure \|ftype=Point \|key=INLET_Q}}		{{Overlay features\|type=row\|overlay=Water\|name=Inlet \|icon=Waterwizard_icon_inlet.png \|category=Hydraulic structure \|ftype=Point \|key=INLET_Q}}
Line 9:		Line 9:
	{{Overlay features\|type=row\|overlay=Water\|name=Sewer overflow \|icon=Waterwizard_icon_sewer_overflow.png \|category=Hydraulic structure \|ftype=Point \|key=SEWER_OVERFLOW}}		{{Overlay features\|type=row\|overlay=Water\|name=Sewer overflow \|icon=Waterwizard_icon_sewer_overflow.png \|category=Hydraulic structure \|ftype=Point \|key=SEWER_OVERFLOW}}
	{{Overlay features\|type=row\|overlay=Water\|name=Weir \|icon=Waterwizard_icon_weir.png \|category=Hydraulic structure \|ftype=Line \|key=WEIR_HEIGHT}}		{{Overlay features\|type=row\|overlay=Water\|name=Weir \|icon=Waterwizard_icon_weir.png \|category=Hydraulic structure \|ftype=Line \|key=WEIR_HEIGHT}}
	}~~}-->~~		}}
	~~{\| {{STDT\|overlay sortable}}~~
	\|-
	! style="width:50px" \| Icon !! style="width:150px; text-align:left;" \| Name !! style="width:200px; text-align:left;" \| Category !! style="width:80px; text-align:left;" \| Type !! style="width:450px; text-align:left;" \| Identification key
	~~{{WaterOverlay table row \|inlet\| [[Inlet (Water Overlay)\|Inlet]] \| Hydraulic structure \| Point \| [[Inlet_q_(Water_Overlay)\|INLET_Q]] }}~~
	~~{{WaterOverlay table row \|pump_q\| [[Pump (Water Overlay)\|Pump]] \| Hydraulic structure \| Line \| [[Pump_q_(Water_Overlay)\|PUMP_Q]]}}~~
	~~{{WaterOverlay table row \|culvert\| [[Culvert (Water Overlay)\|Culvert]] \| Hydraulic structure \| Line \| [[Culvert_diameter_(Water_Overlay)\|CULVERT_DIAMETER]]}}~~
	~~{{WaterOverlay table row \|sewer_overflow\| [[Sewer overflow (Water Overlay)\|Sewer overflow]] \| Hydraulic structure \| Point \| [[Sewer_overflow_attribute_(Water_Overlay)\|SEWER_OVERFLOW]]}}~~
	~~{{WaterOverlay table row \|weir\| [[Weir (Water Overlay)\|Weir]] \| Hydraulic structure \| Line \| [[Weir_height_(Water_Overlay)\|WEIR_HEIGHT]]}}~~
	\|}

	In order to get more familiar with the different hydraulic structures in the Water Overlay check out Quadrant 3 of the [[Testbed_water_module\|Water Module Testbed]]. This Testbed is available to you as a project in the {{software}}.		In order to get more familiar with the different hydraulic structures in the Water Overlay check out Quadrant 3 of the [[Testbed_water_module\|Water Module Testbed]]. This Testbed is available to you as a project in the {{software}}.

Rudolf@tygron.nl at 10:39, 8 October 2020

2020-10-08T10:39:48Z

← Older revision		Revision as of 10:39, 8 October 2020
Line 2:		Line 2:

	In general, for ease of use, hydraulic structures are by default imported as underground constructions.		In general, for ease of use, hydraulic structures are by default imported as underground constructions.
			<!--
			{{Overlay features\|suppresscategory=true\|allowselflinks=true\|
			{{Overlay features\|type=row\|overlay=Water\|name=Inlet \|icon=Waterwizard_icon_inlet.png \|category=Hydraulic structure \|ftype=Point \|key=INLET_Q}}
			{{Overlay features\|type=row\|overlay=Water\|name=Pump \|icon=Waterwizard_icon_pump_q.png \|category=Hydraulic structure \|ftype=Line \|key=PUMP_Q}}
			{{Overlay features\|type=row\|overlay=Water\|name=Culvert \|icon=Waterwizard_icon_culvert.png \|category=Hydraulic structure \|ftype=Line \|key=CULVERT_DIAMETER}}
			{{Overlay features\|type=row\|overlay=Water\|name=Sewer overflow \|icon=Waterwizard_icon_sewer_overflow.png \|category=Hydraulic structure \|ftype=Point \|key=SEWER_OVERFLOW}}
			{{Overlay features\|type=row\|overlay=Water\|name=Weir \|icon=Waterwizard_icon_weir.png \|category=Hydraulic structure \|ftype=Line \|key=WEIR_HEIGHT}}
			}}-->
	{\| {{STDT\|overlay sortable}}		{\| {{STDT\|overlay sortable}}
	\|-		\|-
Line 12:		Line 19:
	{{WaterOverlay table row \|weir\| [[Weir (Water Overlay)\|Weir]] \| Hydraulic structure \| Line \| [[Weir_height_(Water_Overlay)\|WEIR_HEIGHT]]}}		{{WaterOverlay table row \|weir\| [[Weir (Water Overlay)\|Weir]] \| Hydraulic structure \| Line \| [[Weir_height_(Water_Overlay)\|WEIR_HEIGHT]]}}
	\|}		\|}

	In order to get more familiar with the different hydraulic structures in the Water Overlay check out Quadrant 3 of the [[Testbed_water_module\|Water Module Testbed]]. This Testbed is available to you as a project in the {{software}}.		In order to get more familiar with the different hydraulic structures in the Water Overlay check out Quadrant 3 of the [[Testbed_water_module\|Water Module Testbed]]. This Testbed is available to you as a project in the {{software}}.

Rudolf@tygron.nl at 12:18, 2 October 2020

2020-10-02T12:18:59Z

← Older revision		Revision as of 12:18, 2 October 2020
Line 28:		Line 28:
	When the calculation of the water overlay completes, the total amount of water that has flowed through a specific construction is stored in an attribute in that construction. By default, this attribute is [[Object flow output (Water Overlay)\|OBJECT_FLOW_OUTPUT]], and the flow is expressed in m3. Since multiple water overlays can exist in the project simultaneously, the attribute name is appended with an underscore and the overlay [[ID]] such that each overlay (as they are added to the project) can write to a unique attribute.		When the calculation of the water overlay completes, the total amount of water that has flowed through a specific construction is stored in an attribute in that construction. By default, this attribute is [[Object flow output (Water Overlay)\|OBJECT_FLOW_OUTPUT]], and the flow is expressed in m3. Since multiple water overlays can exist in the project simultaneously, the attribute name is appended with an underscore and the overlay [[ID]] such that each overlay (as they are added to the project) can write to a unique attribute.

	~~==Notes=~~=		{{article end
			\|notes=
	*Only one hydraulic structure can be assigned to a particular grid cell. When the model attribute [[Object_correction_(Water_Overlay)\|OBJECT_CORRECTION]] is active, hydraulic structures can be automatically moved to adjacent grid cells.		*Only one hydraulic structure can be assigned to a particular grid cell. When the model attribute [[Object_correction_(Water_Overlay)\|OBJECT_CORRECTION]] is active, hydraulic structures can be automatically moved to adjacent grid cells.
	*The [[Base_types_result_type_(Water_Overlay)\|Base type]] result overlay visualizes which type of hydraulic structures are placed where.		*The [[Base_types_result_type_(Water_Overlay)\|Base type]] result overlay visualizes which type of hydraulic structures are placed where.
	*If a single construction has attributes related to multiple hydraulic structures, only one is selected. The selection order is: Weir, Sewer overflow, Inlet, Pump, Culvert.		*If a single construction has attributes related to multiple hydraulic structures, only one is selected. The selection order is: Weir, Sewer overflow, Inlet, Pump, Culvert.
			}}

	{{WaterOverlay hydraulic structure nav}}		{{WaterOverlay hydraulic structure nav}}
	[[Category:Water Module]]		[[Category:Water Module]]

Rudolf@tygron.nl at 11:51, 9 June 2020

2020-06-09T11:51:19Z

← Older revision		Revision as of 11:51, 9 June 2020
Line 26:		Line 26:

	==Total flow==		==Total flow==
	When the calculation of the water overlay completes, the total amount of water that has flowed through a specific construction is stored in an attribute in that construction. By default, this attribute is [[Object flow output (Water Overlay)\|OBJECT_FLOW_OUTPUT]], and the flow is expressed in m3. Since multiple water overlays can exist in the project simultaneously, the attribute name is appended with an underscore and the overlay ID such that each overlay (as they are added to the project) can write to a unique attribute.		When the calculation of the water overlay completes, the total amount of water that has flowed through a specific construction is stored in an attribute in that construction. By default, this attribute is [[Object flow output (Water Overlay)\|OBJECT_FLOW_OUTPUT]], and the flow is expressed in m3. Since multiple water overlays can exist in the project simultaneously, the attribute name is appended with an underscore and the overlay [[ID]] such that each overlay (as they are added to the project) can write to a unique attribute.

	==Notes==		==Notes==

← Older revision		Revision as of 12:36, 1 March 2021
Line 20:		Line 20:
	; {{linkappend\|post= (Water Overlay)\|Point-based construction}}s		; {{linkappend\|post= (Water Overlay)\|Point-based construction}}s
	: {{RequestImage\|description=A simple polygon shape (square), then the visualization of the calculation of the center-point, and finally the highlighting of the endpoint.}}Point-based constructions add or remove water in one or more computational layers, based on their formula's. The center-point of a point-based construction, the exact cell where the effect takes place, is the geometric center of the construction's polygon.		: {{RequestImage\|description=A simple polygon shape (square), then the visualization of the calculation of the center-point, and finally the highlighting of the endpoint.}}Point-based constructions add or remove water in one or more computational layers, based on their formula's. The center-point of a point-based construction, the exact cell where the effect takes place, is the geometric center of the construction's polygon.
	~~Note that the more complex the polygon is, the more difficult it is for the {{software}} to resolve it to a simple line or center point.~~
	; {{linkappend\|post= (Water Overlay)\|Area-based construction}}s		; {{linkappend\|post= (Water Overlay)\|Area-based construction}}s
	: {{RequestImage\|description=A simple polygon shape (rectangle). No further calculations.}} Area-based constructions add or remove water in one or more computation layers, based on their formula. In principle, all cells which the construction intersects are affected, though the exact effects may differ based on the presence of other features in those cells.		: {{RequestImage\|description=A simple polygon shape (rectangle). No further calculations.}} Area-based constructions add or remove water in one or more computation layers, based on their formula. In principle, all cells which the construction intersects are affected, though the exact effects may differ based on the presence of other features in those cells.

← Older revision		Revision as of 14:58, 7 December 2020
Line 5:		Line 5:
	{{Overlay features\|suppresscategory=true\|allowselflinks=true\|		{{Overlay features\|suppresscategory=true\|allowselflinks=true\|
	{{Overlay features\|type=row\|overlay=Water\|name=Inlet \|icon=Waterwizard_icon_inlet.png \|category=Hydraulic structure \|ftype=Point \|key=INLET_Q}}		{{Overlay features\|type=row\|overlay=Water\|name=Inlet \|icon=Waterwizard_icon_inlet.png \|category=Hydraulic structure \|ftype=Point \|key=INLET_Q}}
	{{Overlay features\|type=row\|overlay=Water\|name=Pump \|icon=~~Waterwizard_icon_pump_q~~.png \|category=Hydraulic structure \|ftype=Line \|key=PUMP_Q}}		{{Overlay features\|type=row\|overlay=Water\|name=Pump \|icon=Waterwizard_icon_pump.png \|category=Hydraulic structure \|ftype=Line \|key=PUMP_Q}}
	{{Overlay features\|type=row\|overlay=Water\|name=Culvert \|icon=Waterwizard_icon_culvert.png \|category=Hydraulic structure \|ftype=Line \|key=CULVERT_DIAMETER}}		{{Overlay features\|type=row\|overlay=Water\|name=Culvert \|icon=Waterwizard_icon_culvert.png \|category=Hydraulic structure \|ftype=Line \|key=CULVERT_DIAMETER}}
	{{Overlay features\|type=row\|overlay=Water\|name=Sewer overflow \|icon=Waterwizard_icon_sewer_overflow.png \|category=Hydraulic structure \|ftype=Point \|key=SEWER_OVERFLOW}}		{{Overlay features\|type=row\|overlay=Water\|name=Sewer overflow \|icon=Waterwizard_icon_sewer_overflow.png \|category=Hydraulic structure \|ftype=Point \|key=SEWER_OVERFLOW}}

← Older revision		Revision as of 09:08, 29 October 2020
Line 2:		Line 2:

	In general, for ease of use, hydraulic structures are by default imported as underground constructions.		In general, for ease of use, hydraulic structures are by default imported as underground constructions.
	~~<!--~~
	{{Overlay features\|suppresscategory=true\|allowselflinks=true\|		{{Overlay features\|suppresscategory=true\|allowselflinks=true\|
	{{Overlay features\|type=row\|overlay=Water\|name=Inlet \|icon=Waterwizard_icon_inlet.png \|category=Hydraulic structure \|ftype=Point \|key=INLET_Q}}		{{Overlay features\|type=row\|overlay=Water\|name=Inlet \|icon=Waterwizard_icon_inlet.png \|category=Hydraulic structure \|ftype=Point \|key=INLET_Q}}
Line 9:		Line 9:
	{{Overlay features\|type=row\|overlay=Water\|name=Sewer overflow \|icon=Waterwizard_icon_sewer_overflow.png \|category=Hydraulic structure \|ftype=Point \|key=SEWER_OVERFLOW}}		{{Overlay features\|type=row\|overlay=Water\|name=Sewer overflow \|icon=Waterwizard_icon_sewer_overflow.png \|category=Hydraulic structure \|ftype=Point \|key=SEWER_OVERFLOW}}
	{{Overlay features\|type=row\|overlay=Water\|name=Weir \|icon=Waterwizard_icon_weir.png \|category=Hydraulic structure \|ftype=Line \|key=WEIR_HEIGHT}}		{{Overlay features\|type=row\|overlay=Water\|name=Weir \|icon=Waterwizard_icon_weir.png \|category=Hydraulic structure \|ftype=Line \|key=WEIR_HEIGHT}}
	}~~}-->~~		}}
	~~{\| {{STDT\|overlay sortable}}~~
	\|-
	! style="width:50px" \| Icon !! style="width:150px; text-align:left;" \| Name !! style="width:200px; text-align:left;" \| Category !! style="width:80px; text-align:left;" \| Type !! style="width:450px; text-align:left;" \| Identification key
	~~{{WaterOverlay table row \|inlet\| [[Inlet (Water Overlay)\|Inlet]] \| Hydraulic structure \| Point \| [[Inlet_q_(Water_Overlay)\|INLET_Q]] }}~~
	~~{{WaterOverlay table row \|pump_q\| [[Pump (Water Overlay)\|Pump]] \| Hydraulic structure \| Line \| [[Pump_q_(Water_Overlay)\|PUMP_Q]]}}~~
	~~{{WaterOverlay table row \|culvert\| [[Culvert (Water Overlay)\|Culvert]] \| Hydraulic structure \| Line \| [[Culvert_diameter_(Water_Overlay)\|CULVERT_DIAMETER]]}}~~
	~~{{WaterOverlay table row \|sewer_overflow\| [[Sewer overflow (Water Overlay)\|Sewer overflow]] \| Hydraulic structure \| Point \| [[Sewer_overflow_attribute_(Water_Overlay)\|SEWER_OVERFLOW]]}}~~
	~~{{WaterOverlay table row \|weir\| [[Weir (Water Overlay)\|Weir]] \| Hydraulic structure \| Line \| [[Weir_height_(Water_Overlay)\|WEIR_HEIGHT]]}}~~
	\|}

	In order to get more familiar with the different hydraulic structures in the Water Overlay check out Quadrant 3 of the [[Testbed_water_module\|Water Module Testbed]]. This Testbed is available to you as a project in the {{software}}.		In order to get more familiar with the different hydraulic structures in the Water Overlay check out Quadrant 3 of the [[Testbed_water_module\|Water Module Testbed]]. This Testbed is available to you as a project in the {{software}}.

← Older revision		Revision as of 11:36, 5 October 2022
Line 1:		Line 1:
	The water system can be enhanced with a number of hydraulic structures. These are [[~~construction~~]]s which transport water to, from, and between specified cells, according to their flow model and given parameters. The behavior of these ~~constructions~~ can be adjusted by adjusting the related attributes.		The water system can be enhanced with a number of hydraulic structures. These are [[Building]]s which transport water to, from, and between specified cells, according to their flow model and given parameters. The behavior of these Buildings can be adjusted by adjusting the related attributes.

	In general, for ease of use, hydraulic structures are by default imported as underground ~~constructions~~.		In general, for ease of use, hydraulic structures are by default imported as underground Buildings.

	{{Overlay features\|suppresscategory=true\|allowselflinks=true\|		{{Overlay features\|suppresscategory=true\|allowselflinks=true\|
Line 16:		Line 16:
	==Types==		==Types==
	Hydraulic structures can be either line-based or point-based:		Hydraulic structures can be either line-based or point-based:
	; {{linkappend\|post= (Water Overlay)\|Line-based ~~construction~~}}s		; {{linkappend\|post= (Water Overlay)\|Line-based building}}s
	: {{RequestImage\|description=A simple polygon shape (rectangle), then the visualization of the skeleton lines, then the highlighting of the relevant endpoints.}}Line-based ~~constructions~~ form a direct connection between two exact cells, allowing water to flow from one point to another. The flow is dictated by the ~~construction~~'s formula. The endpoints of a line-based ~~construction~~, the exact cells which are connected by the ~~construction~~, are computed based on the orientation and size of their polygon. Essentially, the furthest ends of the polygon are used as end-points. Because the cells of either endpoint are considered adjacent, any calculated flow through line-based hydraulic structures is instantaneous.		: {{RequestImage\|description=A simple polygon shape (rectangle), then the visualization of the skeleton lines, then the highlighting of the relevant endpoints.}}Line-based buildings form a direct connection between two exact cells, allowing water to flow from one point to another. The flow is dictated by the Building's formula. The endpoints of a line-based Building, the exact cells which are connected by the Building, are computed based on the orientation and size of their polygon. Essentially, the furthest ends of the polygon are used as end-points. Because the cells of either endpoint are considered adjacent, any calculated flow through line-based hydraulic structures is instantaneous.
	; {{linkappend\|post= (Water Overlay)\|Point-based ~~construction~~}}s		; {{linkappend\|post= (Water Overlay)\|Point-based building}}s
	: {{RequestImage\|description=A simple polygon shape (square), then the visualization of the calculation of the center-point, and finally the highlighting of the endpoint.}}Point-based ~~constructions~~ add or remove water in one or more computational layers, based on their formula's. The center-point of a point-based ~~construction~~, the exact cell where the effect takes place, is the geometric center of the construction's polygon.		: {{RequestImage\|description=A simple polygon shape (square), then the visualization of the calculation of the center-point, and finally the highlighting of the endpoint.}}Point-based buildings add or remove water in one or more computational layers, based on their formula's. The center-point of a point-based building, the exact cell where the effect takes place, is the geometric center of the construction's polygon.
	; {{linkappend\|post= (Water Overlay)\|Area-based ~~construction~~}}s		; {{linkappend\|post= (Water Overlay)\|Area-based building}}s
	: {{RequestImage\|description=A simple polygon shape (rectangle). No further calculations.}} Area-based ~~constructions~~ add or remove water in one or more computation layers, based on their formula. In principle, all cells which the ~~construction~~ intersects are affected, though the exact effects may differ based on the presence of other features in those cells.		: {{RequestImage\|description=A simple polygon shape (rectangle). No further calculations.}} Area-based buildings add or remove water in one or more computation layers, based on their formula. In principle, all cells which the Building intersects are affected, though the exact effects may differ based on the presence of other features in those cells.

	Note that the more complex the polygon is, the more difficult it is for the {{software}} to resolve it to a simple line or center point.		Note that the more complex the polygon is, the more difficult it is for the {{software}} to resolve it to a simple line or center point.

	==Identification==		==Identification==
	~~Constructions~~ can be identified as a hydraulic structure when this ~~construction~~ has the identification attribute. This is the first attribute in the described table of attributes for each hydraulic structure. They are also listed in the table above.		Buildings can be identified as a hydraulic structure when this Building has the identification attribute. This is the first attribute in the described table of attributes for each hydraulic structure. They are also listed in the table above.

	The identification attribute (and all other attributes used by hydraulic structures) can be configured as a [[Overlay_Key\|key]] of the [[Water Overlay]]. Keys indicate which attribute of ~~constructions~~ or features is used to represent specific geographical input parameters for the calculation. This can be of use when setting up a project or [[template]] which makes use of [[Geo Data Wizard\|user-provided geodata]].		The identification attribute (and all other attributes used by hydraulic structures) can be configured as a [[Overlay_Key\|key]] of the [[Water Overlay]]. Keys indicate which attribute of Buildings or features is used to represent specific geographical input parameters for the calculation. This can be of use when setting up a project or [[template]] which makes use of [[Geo Data Wizard\|user-provided geodata]].

	==Total flow==		==Total flow==
	When the calculation of the water overlay is completed, the total amount of water that has flowed through a specific ~~construction~~ is stored in an attribute in that ~~construction~~. By default, this attribute is [[Object flow output (Water Overlay)\|OBJECT_FLOW_OUTPUT]], and the flow is expressed in m3. Since multiple water overlays can exist in the project simultaneously, the attribute name is appended with an underscore and the overlay [[ID]] such that each overlay (as they are added to the project) can write to a unique attribute.		When the calculation of the water overlay is completed, the total amount of water that has flowed through a specific Building is stored in an attribute in that Building. By default, this attribute is [[Object flow output (Water Overlay)\|OBJECT_FLOW_OUTPUT]], and the flow is expressed in m3. Since multiple water overlays can exist in the project simultaneously, the attribute name is appended with an underscore and the overlay [[ID]] such that each overlay (as they are added to the project) can write to a unique attribute.

	==Water level==		==Water level==
	When the calculation of the water overlay is completed, the [[Water_level_(Water_Overlay)\|water level]]s at either side of a specific ~~construction~~ is stored in an attribute in that ~~construction~~.		When the calculation of the water overlay is completed, the [[Water_level_(Water_Overlay)\|water level]]s at either side of a specific Building is stored in an attribute in that Building.
	By default, this attribute is [[Object_datum_output_(Water_Overlay)\|OBJECT_DATUM_OUTPUT]]. Since multiple water overlays can exist in a project simultaneously, the attribute name is appended with an underscore and the overlay [[ID]] such that each overlay (as they are added to the project) can write to a unique attribute.		By default, this attribute is [[Object_datum_output_(Water_Overlay)\|OBJECT_DATUM_OUTPUT]]. Since multiple water overlays can exist in a project simultaneously, the attribute name is appended with an underscore and the overlay [[ID]] such that each overlay (as they are added to the project) can write to a unique attribute.

Line 41:		Line 41:
	*Only one hydraulic structure can be assigned to a particular grid cell. When the model attribute [[Object_correction_(Water_Overlay)\|OBJECT_CORRECTION]] is active, hydraulic structures can be automatically moved to adjacent grid cells.		*Only one hydraulic structure can be assigned to a particular grid cell. When the model attribute [[Object_correction_(Water_Overlay)\|OBJECT_CORRECTION]] is active, hydraulic structures can be automatically moved to adjacent grid cells.
	*The [[Base_types_result_type_(Water_Overlay)\|Base type]] result overlay visualizes which type of hydraulic structures are placed where.		*The [[Base_types_result_type_(Water_Overlay)\|Base type]] result overlay visualizes which type of hydraulic structures are placed where.
	*If a single ~~construction~~ has attributes related to multiple hydraulic structures, only one is selected. The selection order is: Weir, Sewer overflow, Inlet, Pump, Culvert.		*If a single Building has attributes related to multiple hydraulic structures, only one is selected. The selection order is: Weir, Sewer overflow, Inlet, Pump, Culvert.
	}}		}}

	{{WaterOverlay hydraulic structure nav}}		{{WaterOverlay hydraulic structure nav}}
	[[Category:Water Module]]		[[Category:Water Module]]