Inlet underground (Water Overlay)

Icon	Key	Unit	Range	Description	Default value
	UNDERGROUND	boolean	0 to 1	When true the Inlet is connected to the groundwater.	false

Notes

• The Inlet thresholds also work below the surface.
• The water storage fraction is changed to the calculated average water storage for the grid cells where the underground Inlet is located.

See also

• Inlet (Water Overlay)
• Inlet lower threshold (Water Overlay)
• Inlet upper threshold (Water Overlay)

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