Pump (Water Overlay)

Pumps are Buildings which can move water against its natural flow. Specifically, a pump with a positive pump speed will pump water from the entry point with a lower water level to the entry point with a higher water level. If no (differing) water levels are defined, the surface height is used instead.

The pump's direction does not change during the simulation.

A pump is a line-based building.

Key	Unit	Range	Description	Default value
PUMP_Q	m3/s		The speed at which water is pumped from the lower end-point to the higher end-point.	n/a
LOWER_THRESHOLD	m + datum		The threshold of the lower end-point of the pump. Water flows from the lower end-point to the higher end-point until the water level at the lower end-point has reached the threshold. If not selected, the Lower Threshold will be ignored as a mechanic.	None
UPPER_THRESHOLD	m + datum		The threshold of the higher end-point of the pump. Water flows from the lower end-point to the higher end-point until the water level at the higher end-point has reached the threshold. If not selected, the Upper Threshold will be ignored as a mechanic.	None
PUMP_ANGLE	geo angle (0-360°)	-1.7976931348623157E308 to 1.7976931348623157E308	The top down orientation angle of the pump.	0
INLET_CAPACITY	m3		The maximum amount of water which can flow in or out through this Pump. Water flowing back in the other direction replenishes the capacity.	0
PUMP_AREA	boolean		When true the Pump is spread across the entire building surface.	0

Notes

A negative value for the PUMP_Q attribute is also allowed, in which case water can be pumped in the reverse direction. Sometimes referred to as draining.
If a pump is placed in a waterway, and the waterway is not otherwise interrupted, water will be able to flow past the pump via the waterway itself. It is recommended to make sure that the waterway is obstructed by an increase in the terrain height in such a way that the only way water can flow from the one end of the pump to the other is via the pump.
A Pump is different from an Inlet in that a pump has two endpoints (or areas) within the project areas, whereas an Inlet has an end point (or area) within the project area and an endpoint (or area) outside the project area; a conceptual external area with a size and a water level.