Object flow output (Water Overlay)

Icon	Key	Unit	Range	Description	Default value
	OBJECT_FLOW_OUTPUT	m3		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.
• 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.
• 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

• 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 the Object flow output as measurement

See also

• Weir flow test case

Analysis of a pinching culvert (Dutch only)

---

Water Module

Water Module

Tutorials

Overview

Theory

Benchmarks

Group

Hydraulic structures

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