Hydraulic structures (Water Overlay) - Revision history

Frank@tygron.nl at 13:59, 15 July 2026

2026-07-15T13:59:39Z

← Older revision		Revision as of 13:59, 15 July 2026
Line 45:		Line 45:
	\|api=*[[Api session event editor building set attribute]]		\|api=*[[Api session event editor building set attribute]]
	*[[Api session event editor building set attributes]]		*[[Api session event editor building set attributes]]
			*[[Api session event editor overlay set key value]]
	}}		}}

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

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

2026-07-13T14:05:54Z

← Older revision		Revision as of 14:05, 13 July 2026
Line 19:		Line 19:
	: {{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. Endpoints (the cells connected by the Building) are determined by the polygon's orientation and size, using its furthest ends. 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. Endpoints (the cells connected by the Building) are determined by the polygon's orientation and size, using its furthest ends. 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 building}}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 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.		: {{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 Building's polygon.
	; {{linkappend\|post= (Water Overlay)\|Area-based building}}s		; {{linkappend\|post= (Water Overlay)\|Area-based building}}s
	: {{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.		: {{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.

Frank@tygron.nl at 13:32, 8 July 2026

2026-07-08T13:32:26Z

← Older revision		Revision as of 13:32, 8 July 2026
Line 17:		Line 17:
	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 building}}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 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.		: {{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. Endpoints (the cells connected by the Building) are determined by the polygon's orientation and size, using its furthest ends. 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 building}}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 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.		: {{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.
Line 31:		Line 31:

	==Total flow==		==Total flow==
	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~~.		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. To support multiple simultaneous water overlays, the attribute name is appended with an underscore and the overlay [[ID]].

	==Water level==		==Water level==
Line 42:		Line 42:
	*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 Building has attributes related to multiple hydraulic structures, only one is selected. The selection order is: Weir, Sewer overflow, Inlet, Pump, Culvert, Drainage.		*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, Drainage.
	*~~It is currently not possible to~~ directly connect ~~one hydraulic structure to another; only through a connection with~~ the [[Surface model (Water Overlay)\|surface]] ~~and~~ [[Ground model (Water Overlay)\|ground]] models ~~at close-by or adjacent~~ cells.		*Hydraulic structures cannot be connected directly; they must connect via the [[Surface model (Water Overlay)\|surface]] or [[Ground model (Water Overlay)\|ground]] models in nearby cells.
	\|api=*[[Api session event editor building set attribute]]		\|api=*[[Api session event editor building set attribute]]
	*[[Api session event editor building set attributes]]		*[[Api session event editor building set attributes]]

Frank@tygron.nl at 13:42, 6 July 2026

2026-07-06T13:42:36Z

← Older revision		Revision as of 13:42, 6 July 2026
Line 1:		Line 1:
	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.		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 modified by adjusting the related attributes.

	In general, for ease of use, hydraulic structures are by default imported as underground Buildings.		In general, for ease of use, hydraulic structures are by default imported as underground Buildings.
Line 28:		Line 28:
	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.		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 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]].		The identification attribute (and all other attributes used by hydraulic structures) can be configured as a [[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==
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 Building 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, Drainage.
	*It is currently not possible to directly connect one hydraulic structure to another; only through a connection with the [[Surface model (Water Overlay)\|surface]] and [[Ground model (Water Overlay)\|ground]] models at close-by or adjacent cells.		*It is currently not possible to directly connect one hydraulic structure to another; only through a connection with the [[Surface model (Water Overlay)\|surface]] and [[Ground model (Water Overlay)\|ground]] models at close-by or adjacent cells.
			\|api=*[[Api session event editor building set attribute]]
			*[[Api session event editor building set attributes]]
	}}		}}

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

Frank@tygron.nl at 11:36, 11 May 2026

2026-05-11T11:36:41Z

← Older revision		Revision as of 11:36, 11 May 2026
Line 42:		Line 42:
	*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 Building 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.
	*It is currently not possible to directly connect one hydraulic structure to another; only through a connection with the [[Surface model (Water Overlay)\|surface]] and [[Ground model (Water Overlay)\|ground]] models.		*It is currently not possible to directly connect one hydraulic structure to another; only through a connection with the [[Surface model (Water Overlay)\|surface]] and [[Ground model (Water Overlay)\|ground]] models at close-by or adjacent cells.
	}}		}}

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

Frank@tygron.nl at 11:22, 11 May 2026

2026-05-11T11:22:02Z

← Older revision		Revision as of 11:22, 11 May 2026
Line 42:		Line 42:
	*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 Building 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.
	*It is currently not possible to directly connect one ~~Hydraulic Structure~~ to another; only through a connection with the [[Surface model (Water Overlay)\|surface]] and [[Ground model (Water Overlay)\|ground]] models.		*It is currently not possible to directly connect one hydraulic structure to another; only through a connection with the [[Surface model (Water Overlay)\|surface]] and [[Ground model (Water Overlay)\|ground]] models.
	}}		}}

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

Frank@tygron.nl: /* Water level */

2026-05-11T11:18:26Z

Water level

← Older revision		Revision as of 11:18, 11 May 2026
Line 42:		Line 42:
	*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 Building 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.
			*It is currently not possible to directly connect one Hydraulic Structure to another; only through a connection with the [[Surface model (Water Overlay)\|surface]] and [[Ground model (Water Overlay)\|ground]] models.
	}}		}}

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

Frank@tygron.nl at 11:16, 11 May 2026

2026-05-11T11:16:15Z

← Older revision		Revision as of 11:16, 11 May 2026
Line 35:		Line 35:
	==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 Building is stored in an attribute in that Building.		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, these attributes are [[Object_datum_output_a_(Water_Overlay)\|OBJECT_DATUM_OUTPUT_A]] and [[Object_datum_output_b_(Water_Overlay)\|OBJECT_DATUM_OUTPUT_B]]. 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

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=

← Older revision		Revision as of 14:05, 13 July 2026
Line 19:		Line 19:
	: {{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. Endpoints (the cells connected by the Building) are determined by the polygon's orientation and size, using its furthest ends. 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. Endpoints (the cells connected by the Building) are determined by the polygon's orientation and size, using its furthest ends. 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 building}}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 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.		: {{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 Building's polygon.
	; {{linkappend\|post= (Water Overlay)\|Area-based building}}s		; {{linkappend\|post= (Water Overlay)\|Area-based building}}s
	: {{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.		: {{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.

← 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]]