Object flow output (Water Overlay): Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
46,429 edits
No edit summary
No edit summary
 
(33 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Overlay attribute
{{overlay keys|<onlyinclude>
|attribute=[[Object flow output (Water Overlay)|OBJECT_FLOW_OUTPUT]]
{{overlay keys|type=row|group=Water Overlay
|key=OBJECT_FLOW_OUTPUT
|unit=m3
|unit=m3
|description=The total amount of water which has flowed through this construction during the simulation performed by the [[Water Overlay]].
|description=An [[Attribute array|array]] of values, each value indicating the amount of water which has flowed through this Building during each timeframe.
|defaultvalue=0
|defaultvalue=None
|icon=
|icon=
|range=-{{Floatmaxvalue}} to {{floatmaxvalue}}
}}</onlyinclude>}}
This attribute is automatically created for all relevant hydraulic structures in a project when a [[Water Overlay|water calculation]] is performed. When the calculation is complete, the attribute is updated automatically.
For [[Point-based building (Water Overlay)|point-based building]]s, a positive value means a net amount of water was added to the surface. A negative value means a net amount of water was removed from the surface. <br>
For [[Line-based building (Water Overlay)|line-based building]]s, positive or negative indicates the net direction the water has flowed.
All [[Hydraulic_structures_(Water_Overlay)|hydraulic structures]] have an OBJECT_FLOW_OUTPUT attribute.
Also a [[Breach_(Water_Overlay)|breach area]] and a [[Sewer_area_(Water_Overlay)|Sewer area]] have this attribute.
{{article end
|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.
* To prevent conflicts between multiple Water Overlays, the Overlay ID is appended to the attribute name by default.
* Invalid water objects have an Object flow output attribute value of {{no data attribute}} for easy exporting/debugging.
* The value is stored per [[Timeframes (Water Overlay)|timeframe]] and represents the amount of water transported in m³ for the period of that timeframe. Therefore the total object flow during the entire simulation can be computed as the sum of the individual values per timeframe.
|howtos=
* [[How to find the Object flow output attribute related to a specific Overlay]]
* [[How to inspect object output attributes of an overlay using the measurement tool]]
* [[How to export an Object output attribute as measurement]]
|seealso=
*[[Weir height test case (Water Module)|Weir flow test case]]
|api=*[[Api session event editor overlay set key value]]
}}
}}
==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.
* Upon completion of the calculation, the value is updated automatically by the Water Overlay.
* Each [[Water Overlay]] will create this attribute with a specific number appended to it, to prevent the results of multiple Water Overlays storing their results in the same attribute by default.
* The value is stored per [[Timeframe]] and represent the amount of water transported in m3 for the period of that timeframe. The total object flow is therefore calculated as the sum of the timeframe values.


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

Latest revision as of 14:46, 15 July 2026

Icon Key Unit Range Description Default value
OBJECT_FLOW_OUTPUT m3 -3.4028235E38 to 3.4028235E38 An array of values, each value indicating the amount of water which has flowed through this Building during each timeframe. None

This attribute is automatically created for all relevant hydraulic structures in a project when a water calculation is performed. When the calculation is complete, the attribute is updated automatically.

For point-based buildings, a positive value means a net amount of water was added to the surface. A negative value means a net amount of water was removed from the surface.
For line-based buildings, positive or negative indicates the net direction the water has flowed.

All hydraulic structures have an OBJECT_FLOW_OUTPUT attribute. Also a breach area and a Sewer area have this attribute.

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.
  • To prevent conflicts between multiple Water Overlays, the Overlay ID is appended to the attribute name by default.
  • Invalid water objects have an Object flow output attribute value of NO_DATA: (~ -3.4+e38) for easy exporting/debugging.
  • The value is stored per timeframe and represents the amount of water transported in m³ for the period of that timeframe. Therefore the total object flow during the entire simulation can be computed as the sum of the individual values per timeframe.

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_flow_output_(Water_Overlay)&oldid=92358"