Object flow output (Water Overlay)
Jump to navigation
Jump to search
| 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
- 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




