Object flow output (Water Overlay): Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{ | {{overlay keys|<onlyinclude> | ||
| | {{overlay keys|type=row|group=Water Overlay | ||
|key=OBJECT_FLOW_OUTPUT | |||
|unit=m3 | |unit=m3 | ||
|description=An [[Attribute array|array]] of values, each value indicating the amount of water which has flowed through this construction during each timeframe. | |description=An [[Attribute array|array]] of values, each value indicating the amount of water which has flowed through this construction during each timeframe. | ||
|defaultvalue= | |defaultvalue=None | ||
|icon= | |icon= | ||
}} | }}</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 completes the value is updated automatically. | This attribute is automatically created for all relevant hydraulic structures in a project when a [[Water Overlay|water calculation]] is performed. When the calculation completes the value is updated automatically. | ||
| Line 12: | Line 13: | ||
Invalid water objects have an Object flow output attribute value of {{no data attribute}} for easy exporting/debugging. | Invalid water objects have an Object flow output attribute value of {{no data attribute}} for easy exporting/debugging. | ||
{{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. | * 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. | * 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. | ||
* 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. | * 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]] | |||
}} | |||
{{WaterOverlay hydraulic structure nav}} | {{WaterOverlay hydraulic structure nav}} | ||
Revision as of 13:36, 2 October 2020
| 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 construction 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 completes the value is updated automatically.
For point-based constructions, 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 constructions, positive or negative indicates the net direction the water has flowed.
Invalid water objects have an Object flow output attribute value of NO_DATA: (~ -3.4+e38) for easy exporting/debugging.
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.
- 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
- Group
- Inlet