Inlet upper threshold (Water Overlay)

Icon	Key	Unit	Range	Description	Default value
	UPPER_THRESHOLD	m + datum	-10000 to 10000	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

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 target water level this outlet maintains.

Notes

• The INLET_Q should be 0 or negative. Otherwise, the Inlet is not configured to let water flow out.
• When using a dynamic UPPER_THRESHOLD, a maximum of 10.000 values (5.000 pairs) can be defined.

See also

• Inlet lower threshold
• Lower threshold key

API Endpoints

• Api session event editor overlay set key value
• Api session event editor building set attribute
• Api session event editor functionoverride set attribute

---

Water Module

Water Module

Tutorials

Overview

Theory

Benchmarks

Group

Hydraulic structures

Inlet

Inlet q • Inlet area • Inlet capacity •  Lower threshold •  Upper threshold • Inlet underground

Pump

Pump q •  Lower threshold •  Upper threshold • Pump angle • Pump capacity • Pump area

Culvert

Culvert diameter • Culvert rectangular height • Culvert threshold • Culvert n

Weir

Weir height • Weir width • Weir angle • Weir coefficient • Weir n • Weir target level

Sewer overflow

Sewer overflow • Sewer overflow speed

Drainage

Drainage q • Drainage datum • Drainage active • Drainage overflow threshold

Output

Object flow output • Object height output • Object datum output a • Object datum output b • Object water area output • Object width output • Weir dam output

Related

Building attributes • Hydrological features •  Terrain attributes • Model attributes • Results • Simulation data