IPump Properties

Acceleration time

Set the constant flow rate

Calculated Discharge derivative with UpStreamWaterLevel. Upstream is relative to the direction of chainage. Unit: [m^2/s]

Calculated Discharge derivative with DownStreamWaterLevel. Downstream is relative to the direction of chainage. Unit: [m^2/s]

Deceleration time

Calculated Discharge Unit: [m^3/s]

Must be set to true to activate (external) control of discharge (through a PID control or similar).

If pump is controlled through ControlMoudle, this will set this automatically (during Prepare)

Can not be combined with StartStopLevelControlActive

Downstream water level.Downstream refers to the direction of chainge. The water level is set by use of SetWaterLevels Unit: [m]

The discharge (and discharge derivatives) are scaled by the flow factor.

QH relation for QdeltaH and QH pumps, (dH, Q) or (H, Q) pairs. The XYTable ensures that dH (or H) is always increasing.

For QdeltaH, a positive dH is the height that water must be RAISED across the pump.

When DischargeControlActive is set (e.g. PID controlled pump) this HQ relation is the maximum pump capacity. Set to null if no maximum capacity.

QH relation for QH and QdeltaH pumps Minimum discharge allowed for a discharge controlled pump (e.g. PID). Set to null to disable.

Name of the structure.

Used to get a consistent description of the structure. The ID comes in user units. Used e.g. when reporting errors, warnings and hints.

Flag to control if the structure is implicit or explicit. If the structure is explicit (Implicit == false) then the derivatives of the discharge are always zero. Default value: true

Invert level down stream The invert level is the level where water starts flowing in to the structure from the downstream side. It does not necessarily flow through the structure.

Invert level up stream. The invert level is the level where water starts flowing in to the structure from the upstream side. It does not necessarily flow through the structure.

A side structure is connected to a reservoir downstream (chainage direction).

True if the pump supports variable speed operation (must be true for PID controlled pumps). Default value: false

Length of the structure. Unit: [m]

Location of structure.

Maximum stop level used if an external control is active. If an external control is active, then MinStopLevel and MaxStopLevel must be set.

Minimum stop level used if an external control is active. If an external control is active, then MinStopLevel and MaxStopLevel must be set.

Minimum time the pump should stay off if it stops pumping. This is only applicable when StartStopLevelControlActive. Default value is 0 seconds.

Minimum time the pump should stay on if it starts pumping. This is only applicable when StartStopLevelControlActive. Default value is 0 seconds.

Offset on water level

Offset to use when looking up the minimum discharge for the pump. Only used when a PID control is attached to the pump.

Set the level of the outlet/reservoir

For side structures (StructureType == SideStructure) and flow direction is upstream (negative Q), then the downstream level is equal to this reservoir level. If Q is positive, then OutletLevel is used as the downstream end.

Default value is MinValue, effectively disabling the use of the OutletLevel

Type of pump

Same as OutletLevel

The getter is used to get a list of errors. OBSOLETE

Bank side that side-structure is located on

If side structure contains reservoir, and has the Coordinate set, this is not used (and should be set to Undefined).

Reservoir at end of side structure. Null if not side structure, or no reservoir is defined

The water level at which the pump is activated

Must be set to true to activate external control of start and stop levels (through a PID control or similar).

If pump is controlled through ControlModule, this will set this automatically (during Prepare)

Can not be combined with DischargeControlActive

The water level at which the pump is de-activated

Type of structure

TopoID used when structure is searching for neighboring cross sections in the reach.

Structure type, unique for each type of structure.

Upstream water level. Upstream refers to the direction of chainage. The water level is set by use of SetWaterLevels Unit: [m]

If true, then the maximum alloved discharge is taken from the MaxPumpDischargeUpstream and MaxPumpDischargeUpstream are use to directly set the maximum discharge. Default false.

If true, then suppresion factors from the PumpSuppressionFactorUpstream and PumpSuppressionFactorDownstream delegates are used to limit the available discharge of the pump. Default false.