Inlet (Water Overlay)

Inlets are hydraulic structures that can pump water in to the hydrological model, or out of, in which case they function as Outlets. 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 building, but can optionally be an area-based building.

Icon	Key	Unit	Range	Description	Default value
	INLET_Q	m3/sec	-3.4028235E38 to 3.4028235E38	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	0 to 1	When true the Inlet is spread across the entire building surface.	0
	INLET_CAPACITY	m3	0 to 3.4028235E38	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	-10000 to 10000	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	-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
	UNDERGROUND	boolean	0 to 1	When true the Inlet is connected to the groundwater.	false

Outlet

A negative INLET_Q changes the Inlet to an Outlet. It is advised to configure the Outlet as an area to ensure enough grid cells are available to extract water.

Notes

• Most Inlet attributes function 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.
• The lower and upper thresholds define the 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.
• Unlike a Pump, which has two internal endpoints (or areas), an Inlet connects one internal endpoint to a conceptual external area with its own size and water level.

How-to's

• How to correct inlets on land
• How to use outlets to remove water on the edges of your project
• How to correct multiple buildings on the same location

See also

• Inlet formula (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