Inlet (Water Overlay)
Revision as of 09:33, 26 April 2021 by Frank@tygron.nl (talk | contribs)
Inlets are points where water is either added to or removed from the hydrological model. It will add or remove water at a defined maximum rate, with optional thresholds for the amount of water to add or remove.
An inlet is by default a point-based construction, but can optionally be an area-based construction.
Icon | Key | Unit | Range | Description | Default value |
---|---|---|---|---|---|
INLET_Q | m3/sec | The maximum amount of water flowing into the model through this Inlet. A negative value means the building functions as an outlet, and water is removed from the hydrological model. | 0 | ||
INLET_AREA | boolean | When true the Inlet is spread across the entire building surface. | 0 | ||
INLET_CAPACITY | m3 | The maximum amount of water which can flow in or out through this Building. Water flowing back in the other direction replenishes the capacity. | 0 | ||
LOWER_THRESHOLD | m + datum | If a lower threshold is set, water will only flow into the model through this inlet until the water level at the point of this Inlet is equal to or greater than the threshold. If the threshold is not set, the amount of water flowing in is not limited in this fashion. | None | ||
UPPER_THRESHOLD | m + datum | If an upper threshold is set, water will only flow out of the model through this inlet until the water level at the point of this Inlet is equal to or less than the threshold. If the threshold is not set, the amount of water flowing out is not limited in this fashion. | None | ||
UNDERGROUND | boolean | When true the Inlet is connected to the groundwater. | false |
Notes
- Each Inlet attribute functions as a limit to the flow. If multiple are defined, the flow is limited by the strongest limit. If neither an INLET_Q or any threshold is defined, there will be no flow.
- A negative INLET_Q changes the Inlet to an Outlet.
- The lower and upper thresholds can be seen as a the lowest and highest of "range" of valid water levels. If the actual water level does not fall in the specified range, the inlet will allow water to flow in or out (depending on the configuration) to correct the water level.