Object datum output a (Water Overlay): Difference between revisions

From Tygron Preview Support Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(30 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{overlay keys|<onlyinclude>
{{overlay keys|<onlyinclude>
{{overlay keys|type=row|group=Water Overlay
{{overlay keys|type=row|group=Water Overlay
|key=OBJECT_DATUM_OUTPUT
|key=OBJECT_DATUM_OUTPUT_A
|unit={{mdatum}}
|unit={{mdatum}}
|description=An [[Attribute array|array]] of values, each value indicating the [[Water_level_(Water_Overlay)|water level]] at both sides of the [[Hydraulic_structures_(Water_Overlay)|hydraulic structures]] at each [[Timeframes (Water Overlay)|timeframe]].
|description=An [[Attribute array|array]] of values, one per [[Timeframes (Water Overlay)|timeframe]]. Each value indicates the [[Water_level_(Water_Overlay)|water level]] at one side of the [[Hydraulic_structures_(Water_Overlay)|hydraulic structures]], generally the entry.
|defaultvalue=None
|defaultvalue=None
|icon=
|icon=
|range=-{{max surface}} to {{max surface}}
}}</onlyinclude>}}
}}</onlyinclude>}}


All [[Hydraulic_structures_(Water_Overlay)|hydraulic structures]] have an OBJECT_DATUM_OUTPUT attribute.  
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
Line 14: Line 16:
* 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.
* 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.
* 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_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.
* 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.
|howtos=
|howtos=
* [[How to inspect object output attributes of an overlay using the measurement tool]]
* [[How to export an Object output attribute as measurement]]
|seealso=
|seealso=
* [[Hydraulic_structures_(Water_Overlay)|Hydraulic structures]]
* [[Water_level_(Water_Overlay)|Water level]]
* [[Weir height test case (Water Module)|Weir flow test case]]
}}
}}


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

Latest revision as of 08:53, 27 February 2024

Icon Key Unit Range Description Default value
OBJECT_DATUM_OUTPUT_A m + datum -10000 to 10000 An array of values, one per timeframe. Each value indicates the water level at one side of the hydraulic structures, generally the entry. 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
Benchmarks button.png
Introduction button.png
Water Module
Benchmarks button.png
Getting started button.png
Tutorials
Benchmarks button.png
Overview button.png
Overview
Benchmarks button.png
Theory button.png
Theory
Benchmarks button.png
Benchmarks button.png
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 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 width output
Related
Building attributes • Hydrological features •  Terrain attributes • Model attributes • Results • Simulation data
Water Module
Benchmarks button.png
Introduction button.png
Water Module
Benchmarks button.png
Getting started button.png
Tutorials
Benchmarks button.png
Overview button.png
Overview
Benchmarks button.png
Theory button.png
Theory
Benchmarks button.png
Benchmarks button.png
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_datum_output_a_(Water_Overlay)&oldid=59336"