Inlet q (Water Overlay): Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(3 intermediate revisions by the same user not shown)
Line 11: Line 11:
{{article end
{{article end
|notes=
|notes=
* Each calculation step is characterized by an amount of time that elapses. Based on the set flow rate, it is then calculated how much water is added in that time step.
* The amount of water added (or removed) per timestep is calculated based on the elapsed time and the obtained flow rate.
* A value of 0 means the potential amount of water flow is unlimited per timestep, and that water can flow both in and out based on the configured [[inlet lower threshold (Water Overlay)|lower]] and [[inlet upper threshold (Water Overlay)|upper threshold]]s, if they are configured.
* A value of 0 means the potential amount of water flow is unlimited per timestep, and that water can flow both in and out based on the configured [[inlet lower threshold (Water Overlay)|lower]] and [[inlet upper threshold (Water Overlay)|upper threshold]]s, if they are configured.
* It is possible to vary the INLET_Q over time, by providing a file with times and flow rates. The resulting data is stored in INLET_Q as an [[attribute array]].
* It is possible to vary the INLET_Q over time, by providing a file with times and flow rates. The resulting data is stored in INLET_Q as an [[attribute array]].
* When using a dynamic INLET_Q, the adjustments in flow rate are immediate when the corresponding simulation time is reached.
* When using a dynamic INLET_Q, the adjustments in flow rate are immediate when the corresponding simulation time is reached.
* When using a dynamic INLET_Q, a maximum of {{array max|pairs}} can be defined.
* When using a dynamic INLET_Q, a maximum of {{array max|pairs}} can be defined.
|seealso=
* This attribute can be defined as [[time sequence (Water Overlay)|values over time]], using an array of values defining {{time sequence start}}. This allows users to more dynamically define the maximum throughput and operational direction of the {{Inlet}}.
|howtos=
|api=*[[Api session event editor overlay set key value]]
*[[Api session event editor building set attribute]]
*[[Api session event editor functionoverride set attribute]]
}}
}}
This attribute can be defined as [[time sequence (Water Overlay)|values over time]], using an array of values defining {{time sequence start}}. This allows users to more dynamically define the maximum throughput and operational direction of the {{Inlet}}.


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

Latest revision as of 14:32, 13 July 2026

Notes

  • The amount of water added (or removed) per timestep is calculated based on the elapsed time and the obtained flow rate.
  • A value of 0 means the potential amount of water flow is unlimited per timestep, and that water can flow both in and out based on the configured lower and upper thresholds, if they are configured.
  • It is possible to vary the INLET_Q over time, by providing a file with times and flow rates. The resulting data is stored in INLET_Q as an attribute array.
  • When using a dynamic INLET_Q, the adjustments in flow rate are immediate when the corresponding simulation time is reached.
  • When using a dynamic INLET_Q, a maximum of 10.000 values (5.000 pairs) can be defined.
  • This attribute can be defined as values over time, using an array of values defining start-time. This allows users to more dynamically define the maximum throughput and operational direction of the Inlet.

API Endpoints