Object flow output (Water Overlay): Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
Godelief@tygron.com (talk | contribs)
No edit summary
mNo edit summary
Line 6: Line 6:
|icon=
|icon=
}}
}}
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.
For [[Point-based construction (Water Overlay)|point-based construction]]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. For [[Line-based construction (Water Overlay)|line-based construction]]s, positive or negative indicates the net direction the water has flowed.
==Notes==
==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.
* 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.
* 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 [[Timeframes_(Water_Overlay)|timeframe]] and represents 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.
* 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.
* When the value of the attribute is negative, it means the amount of water flows in the other direction.


==How-to's==
==How-to's==
* [[How to find the Object flow output attribute related to a specific Overlay]]
* [[How to find the Object flow output attribute related to a specific Overlay]]
{{WaterOverlay hydraulic structure nav}}
{{WaterOverlay hydraulic structure nav}}

Revision as of 10:40, 25 May 2020

Template:Overlay attribute


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.

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 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 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