Hydraulic structures (Water Overlay): Difference between revisions
Jump to navigation
Jump to search
(→Notes) |
No edit summary |
||
| (13 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
The water system can be enhanced with a number of hydraulic structures. These are [[ | 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 | In general, for ease of use, hydraulic structures are by default imported as underground Buildings. | ||
{{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.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}} | |||
{{Overlay features|type=row|overlay=Water|name=Drainage |icon=Waterwizard_icon_drainage.png |category=Hydraulic structure |ftype=Line |key=DRAINAGE_Q}} | |||
}} | |||
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}}. | ||
==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 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. | |||
; {{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. | |||
; {{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. | |||
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== | ||
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 [[key]] of the [[Water Overlay]]. Keys indicate which attribute of | 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 | 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== | ||
*Only one hydraulic structure can be assigned to a particular grid cell. | 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. | |||
{{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. | |||
*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 | *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]] | ||
Latest revision as of 11:36, 5 October 2022
The water system can be enhanced with a number of hydraulic structures. These are Buildings 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 Buildings.
| Icon | Name | Category | Type | Identification Key |
|---|---|---|---|---|
 |
Inlet | Hydraulic structure | Point | INLET_Q |
 |
Pump | Hydraulic structure | Line | PUMP_Q |
 |
Culvert | Hydraulic structure | Line | CULVERT_DIAMETER |
 |
Sewer overflow | Hydraulic structure | Point | SEWER_OVERFLOW |
 |
Weir | Hydraulic structure | Line | WEIR_HEIGHT |
 |
Drainage | Hydraulic structure | Line | DRAINAGE_Q |
In order to get more familiar with the different hydraulic structures in the Water Overlay check out Quadrant 3 of the Water Module Testbed. This Testbed is available to you as a project in the Tygron Platform.
Types
Hydraulic structures can be either line-based or point-based:
- Line-based buildings
- 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.
- Point-based buildings
- 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.
- Area-based buildings
- 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 Tygron Platform to resolve it to a simple line or center point.
Identification
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 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 user-provided geodata.
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, 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 levels at either side of a specific Building is stored in an attribute in that Building. By default, this attribute is 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.
Notes
- Only one hydraulic structure can be assigned to a particular grid cell. When the model attribute OBJECT_CORRECTION is active, hydraulic structures can be automatically moved to adjacent grid cells.
- The 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.
- Group
- Inlet