Object water area output (Water Overlay): Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Maxim@tygron.com (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
6,137 edits
No edit summary
No edit summary
 
(6 intermediate revisions by 2 users not shown)
Line 2: Line 2:
{{overlay keys|type=row|group=Water Overlay
{{overlay keys|type=row|group=Water Overlay
|key=OBJECT_WATER_AREA_OUTPUT
|key=OBJECT_WATER_AREA_OUTPUT
|unit=[[item]] ID
|unit=[[item]] ID, m2, m
|description=An [[Attribute array|array]] of [[Water level area (Water Overlay)]] IDs, connected to a specific [[Hydraulic structures (Water Overlay)|hydraulic structure]] or [[Hydrologic features (Water Overlay)|hydrologic feature]].
|description=An [[Attribute array|array]] of [[Water level area (Water Overlay)]] IDs, connected to a specific [[Hydraulic structures (Water Overlay)|hydraulic structure]] or [[Hydrologic features (Water Overlay)|hydrologic feature]].
|defaultvalue=None
|defaultvalue=None
Line 8: Line 8:
|range=0 to {{integermaxvalue}}
|range=0 to {{integermaxvalue}}
}}</onlyinclude>}}
}}</onlyinclude>}}
All [[Hydraulic_structures_(Water_Overlay)|hydraulic structures]] have an OBJECT_DATUM_OUTPUT_A attribute.
[[File:Weir_schematic.PNG|200px|thumb|left|A weir showing the datum heights at that timeframe, obtained from the values of the OBJECT_DATUM_OUTPUT_A and OBJECT_DATUM_OUTPUT_B [[Overlay key|key]] stored in that weir.]]


{{article end
{{article end
|notes=
|notes=
* This attribute does not need to be created when configuring the project. This attribute is created automatically by the [[Water Overlay]] when a calculation is performed. When the calculation is complete, the attribute is updated automatically.
* The array contains [[Water level area (Water Overlay)]] IDs, followed by the area (m2) and elevation of the connecting elements.
* Each [[Water Overlay]] will create this attribute with the [[ID]] of an Overlay appended to it, to prevent the results of multiple Water Overlays storing their results in the same attribute by default.
* The array is defined as: [id1, id2, area1, area2, elevation1, elevation2].
* This attribute is also visible when zoomed in on a [[Hydraulic_structures_(Water_Overlay)|hydraulic structure]]. The [[Water_level_(Water_Overlay)|water level]]s on either side of the structure can be seen at each timeframe when a [[Water Overlay]] is selected.
* For sewer overflows and breaches an additional ID is added: [id1, id2, id3, area1, area2, area3, elevation1, elevation2, elevation3].
|howtos=
|howtos=
* [[How to inspect object output attributes of an overlay using the measurement tool]]
* [[How to inspect object output attributes of an overlay using the measurement tool]]
* [[How to export an Object output attribute as measurement]]
* [[How to export an Object output attribute as measurement]]
|seealso=
|seealso=
* [[Hydraulic_structures_(Water_Overlay)|Hydraulic structures]]
* [[Hydraulic structures (Water Overlay)|Hydraulic structures]]
* [[Hydrologic features (Water Overlay)|Hydrologic features]]
* [[Water_level_(Water_Overlay)|Water level]]
* [[Water_level_(Water_Overlay)|Water level]]
* [[Weir height test case (Water Module)|Weir flow test case]]
* [[Weir height test case (Water Module)|Weir flow test case]]
|api=*[[Api session event editor overlay set key value]]
*[[Api session event editor building set attribute]]
}}
}}


{{WaterOverlay hydraulic structure nav}}
{{WaterOverlay hydraulic structure nav}}
{{WaterOverlay output nav}}
{{WaterOverlay output nav}}

Latest revision as of 11:00, 15 July 2026

Icon Key Unit Range Description Default value
OBJECT_WATER_AREA_OUTPUT item ID, m2, m 0 to 2147483647 An array of Water level area (Water Overlay) IDs, connected to a specific hydraulic structure or hydrologic feature. None

Notes

  • The array contains Water level area (Water Overlay) IDs, followed by the area (m2) and elevation of the connecting elements.
  • The array is defined as: [id1, id2, area1, area2, elevation1, elevation2].
  • For sewer overflows and breaches an additional ID is added: [id1, id2, id3, area1, area2, area3, elevation1, elevation2, elevation3].

How-to's

See also

API Endpoints

Water Module
Water Module
Tutorials
Overview
Theory
Benchmarks
Group
Inlet
Inlet q • Inlet area • Inlet capacity •  Lower threshold •  Upper threshold • Inlet underground
Pump
Pump q •  Lower threshold •  Upper threshold • Pump angle • Pump capacity • Pump area
Culvert
Culvert diameter • Culvert rectangular height • Culvert threshold • Culvert n
Weir
Weir height • Weir width • Weir angle • Weir coefficient • Weir n • Weir target level
Sewer overflow
Sewer overflow • Sewer overflow speed
Drainage
Drainage q • Drainage datum • Drainage active • Drainage overflow threshold
Output
Object flow output • Object height output • Object datum output a • Object datum output b • Object water area output • Object width output • Weir dam output
Related
Building attributes • Hydrological features •  Terrain attributes • Model attributes • Results • Simulation data
Water Module
Water Module
Tutorials
Overview
Theory
Benchmarks
Group
Output keys
Object flow output • Object height output • Object datum output a • Object datum output b • Object width output
Output other
Result type • Water balance • System visualization • Weather visualization • Debug info
Related
Building attributes • Hydraulic structures • Hydrological features •  Terrain attributes • Model attributes • Prequels • Simulation data
Retrieved from "https://support.tygron.com/w/index.php?title=Object_water_area_output_(Water_Overlay)&oldid=91880"