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

From Tygron Preview Support Wiki
Jump to navigation Jump to search
Newer edit →
Created page with "{{overlay keys|<onlyinclude> {{overlay keys|type=row|group=Water Overlay |key=OBJECT_WATER_AREA_OUTPUT |unit=item ID |description=An array of item IDs, one per Water level area (Water Overlay), related to a specific hydraulic structure or hydrologic feature. |defaultvalue=None |icon= |range=-{{max surface}} to {{max surface}} }}</onlyinclude>}} All Hydraulic_..."
 
No edit summary
Line 3: Line 3:
|key=OBJECT_WATER_AREA_OUTPUT
|key=OBJECT_WATER_AREA_OUTPUT
|unit=[[item]] ID
|unit=[[item]] ID
|description=An [[Attribute array|array]] of [[item]] IDs, one per [[Water level area (Water Overlay)]], related to a specific [[Hydraulic structure (Water Overlay)|hydraulic structure]] or [[Hydrologic feature (Water Overlay)|hydrologic feature]].
|description=An [[Attribute array|array]] of [[item]] IDs, one per [[Water level area (Water Overlay)]], related to a specific [[Hydraulic structures (Water Overlay)|hydraulic structure]] or [[Hydrologic features (Water Overlay)|hydrologic feature]].
|defaultvalue=None
|defaultvalue=None
|icon=
|icon=

Revision as of 15:23, 14 November 2025

Icon Key Unit Range Description Default value
OBJECT_WATER_AREA_OUTPUT item ID -10000 to 10000 An array of item IDs, one per Water level area (Water Overlay), related to a specific hydraulic structure or hydrologic feature. None

All hydraulic structures have an OBJECT_DATUM_OUTPUT_A attribute.

A weir showing the datum heights at that timeframe, obtained from the values of the OBJECT_DATUM_OUTPUT_A and OBJECT_DATUM_OUTPUT_B key stored in that weir.

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.
  • 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.
  • This attribute is also visible when zoomed in on a hydraulic structure. The water levels on either side of the structure can be seen at each timeframe when a Water Overlay is selected.

How-to's

See also

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 • Simulation data
Retrieved from "https://previewsupport.tygron.com/w/index.php?title=Object_water_area_output_(Water_Overlay)&oldid=63955"