Inlet area (Water Overlay)

Icon	Key	Unit	Range	Description	Default value
	INLET_AREA	boolean	0 to 1	When true the Inlet is spread across the entire building surface.	0

Notes

• Selecting this option is useful when the INLET_Q value is too large for a single cell.
• The area works best when applied as a narrow strip.
• An inlet area always has one associated datum height. The selected height is the highest of all cells belonging to this area.
  • On sloped terrain, this setting may prevent outlets from removing all water. See the image below. It is therefore advised to disable this option and use center point outlets to remove water at the edge of your project.

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