Pumping Station Data Fields

Pumping station data fields can be edited on the Pumping Station Grid View or the Pump Station Property Sheet.

The following table describes all the data needed to define a Pumping Station.

Further information, including units details, about all the Network Object fields stored in the Master Database can be found in the data fields topics listed in the Network Data Fields topic.

Fields that are common to the majority of objects can be found in the Common Data Fields topic.

Information on Pump and Pump Curve specific data needed to define a Pump can be found in the Pump Curve topic.

The pages on the Property Sheet are listed below. When the network object has Control Data additional pages may be displayed on the property sheet. These pages are marked as follows:

- additional page displayed when control data is open

  1. Pipe Definition Page

  2. Pumping Station Parameters Page

  3. Pump Data Page

  4. Pump Control Page

  5. Pump Control Data Page

  6. UPC Script Page

  7. Transient Page - fields only enabled when InfoWorks TS (Transient System) licence is present

  8. Transient -Turbine Page - fields only enabled when InfoWorks TS (Transient System) licence is present
  9. WQ Turbidity Page

  10. BalanceNet / Cost Management Page - the page name and available constraints depend on the option selected in the BalanceNet page of the Options dialog.

  11. User Fields Page - see Common Data Fields topic for details of user fields

  12. Hyperlinks Page - see Common Data Fields topic for details of hyperlinks fields

  13. Control Notes Page

  14. Notes Page - see Common Data Fields topic for details of notes fields

The Grid column tells you if the data item is available for editing in the grid view.

Pumping Station Data

Database Table Name: wn_pst

Show Columns

Help Text

Visibility

Size, Type and Units

Database Names

Error Limits

Field Name

Help Text

Flag

Grid

Property Page

Size

Precision

Units

Database Field

Data Type

Default

Error Lower Limit

Error Upper Limit

Warning Lower Limit

Warning Upper Limit

From Node ID

Name of the From Node for this pipe. You can select the name from the dropdown list of existing nodes, or type the name of a node you have yet to add to the model.

From and To represent the typical direction of flow for the pipe. Flow will not always be in this direction.

YES

YES

1

30

0

 

us_node_id

Text

 

 

 

 

 

To Node ID

Name of the To Node for this pipe.

From and To represent the typical direction of flow for the pipe. Flow will not always be in this direction.

YES

YES

1

30

0

 

ds_node_id

Text

 

 

 

 

 

Suffix

A suffix added by InfoWorks to ensure that all link Ids are unique

YES

YES

NO

1

0

 

link_suffix

Text

 

 

 

 

 

Area Code

The Area Code parameter is used for closer spatial modelling of demand - each node is allocated to an area and demand can then be factored by area.

The factor is set using the Demand Scaling Editor.

YES

YES

1

30

0

 

area

Text

 

 

 

 

 

Asset ID

For reference only. Designed as a reference to an asset database, but could be used for anything.

YES

YES

1

30

0

 

asset_id

Text

 

 

 

 

 

Local Loss Coefficient

Local Headloss Coefficient used by the Darcy Weisbach roughness formula

YES

YES

1

 

4

 

local_loss

 

 

0

10000000000

 

 

Length

the length of the bypass pipe

YES

YES

1

 

2

L

length

 

 

0.1

99000

 

 

Diameter

Internal diameter of the pipe

YES

YES

1

 

1

PS

diameter

 

 

10

20000

 

 

Friction Type

The formula used for roughness calculations. Can be Darcy Weisbach, Hazen Williams, or Colebrook White. See Pipe Calculations for more information.

Database Value

Description

CW

Colebrook-White (Moody diagram)

HW

Hazen-Williams

DW

Darcy-Weisbach (constant f)

YES

YES

1

2

1

 

roughness_type

Text

 

 

 

 

 

CW - k

The value for the friction coefficient appropriate to the chosen roughness type. Follow the links above for more details

YES

YES

1

 

6

WN_K

k

 

 

0.001

200

 

 

DW - f

The value for the friction coefficient appropriate to the chosen roughness type. Follow the links above for more details

YES

YES

1

 

6

 

darcy_weissbach

 

 

0.002

0.09

 

 

HW - c

The value for the friction coefficient appropriate to the chosen roughness type. Follow the links above for more details

YES

YES

1

 

1

 

hazen_williams

 

 

20

5000

50

200

Material

Link material. For reference only.

YES

YES

1

10

0

 

material

Text

 

 

 

 

 

Year

Year of installation. For reference only.

YES

YES

1

 

0

 

year

Integer

 

 

 

 

 

WQ Bulk Coefficient

The bulk coefficient, kb, is a reaction rate parameter used to calculate the change in concentration of a substance as it reacts with material in the bulk flow. The bulk coefficient has a positive value if the concentration of the substance grows over time, and a negative value if the concentration decays over time.

Please Note

Source dependent bulk coefficient values may be specified at individual nodes which may override or scale the pipe Bulk Coefficient value when calculating reaction rates for water that entered the system at the node.

YES

YES

1

 

2

 

bulk_coeff

 

-0.5

-10

10

 

 

WQ Wall Coefficient

The wall coefficient, kw, is a reaction rate parameter used to calculate the change in concentration of a substance as it reacts with material along the pipe walls. The wall coefficient has a positive value if the concentration of the substance grows in time, and a negative value if the concentration decays in time.

YES

YES

1

 

2

 

wall_coeff

 

-0.3

-10

10

 

 

Criticality

The criticality grade of the link. This provides an indication of the significance of the effect on the network if the link fails.

This field may be updated from a Critical Link Analysis simulation.

YES

YES

1

 

0

 

criticality

Integer

 

 

 

 

 

Wave Celerity

Velocity of propagation of pressure waves caused by sudden increase or decrease in flow rate.

See Transients Advisor for more details.

YES

YES

1

 

 

V

wave_celerity

 

1400

 

 

 

 

Criticality Count

Number of items (Nodes, Properties, Customer Points or Connections) assessed as critical in the event of link failure.

This field may be updated from a Critical Link Analysis simulation.

YES

YES

1

 

0

 

criticality_count

Integer

 

 

 

 

 

Pressure Rating

Maximum design working pressure of link

YES

YES

1

 

 

WN_P

pressure_rating

 

 

 

 

 

 

System Type

For information. Type in a system type or select an option from the dropdown list:

Database Value

Description

Help Text

POTABLE

Potable

System used to transport water of a quality suitable for drinking.

RAW

Raw

System used to transport water used as a source supply for potable water before it has been treated.

RECYCLED

Recycled

System used to transport wastewater effluent that has been treated to provide a non-potable supply suitable for uses such as irrigation.

YES

YES

1

40

0

 

system_type

Text

 

 

 

 

 

Isolation Area

Area identifier used to identify groups of objects to be closed when carrying out a Critical Link Analysis.

YES

YES

1

30

0

 

isolation_area

Text

 

 

 

 

 

Power Consumption

Average consumption of electrical energy per unit volume of pumped water.

YES

YES

2

 

3

WN_ESC

power_consumption

 

 

0

3

 

 

Power Factor

Ratio of active to total electric power in the pumping station. Default is 1.

YES

YES

2

 

2

 

active_total_ratio

 

1.0

0

1

 

 

PST Duty Head

Overall (designed) duty head of the pumping station

YES

YES

2

 

1

HEAD

duty_head

Double

 

1

5000

 

 

Electric Mechanical Power Ratio

Ratio of total electric to mechanical power for the pumping station. A measure of efficiency. Should be > 1.1. Default is 1.25

YES

YES

2

 

2

 

electric_hydraulic_ratio

 

 

1

2

 

 

Tariff Name

Name of the Electricity Tariff used for the pumping station

YES

YES

2

30

0

 

electricity_tariff

Text

 

 

 

 

 

Voltage

HIGH (>1000v) or LOW

Database Value

Description

0

Low

1

High

YES

YES

2

 

0

 

voltage

Boolean

 

 

 

 

 

Bypass

Flag to indicate if there is a bypass pipe allowing flow in both directions when the pumping station is switched off.

The Bypass box on the Pumping Station Parameters Page may be checked to indicate that there is a bypass pipeline at the pumping station (see Figure below).

Booster Station with Bypass Pipeline

In normal operation, the check valve in the bypass is closed due to the head increase in the PST. When all the pumps are switched off this valve remains closed until the outlet pressure drops below the inlet pressure. It then releases some flow around the PST to feed downstream demand when the pumps are off. Such an arrangement is common in booster stations, but much less in main pumping stations, where negative heads are unlikely.

YES

YES

2

 

0

 

bypass

Boolean

 

 

 

 

 

CO2 Factor Regime

 Name of the Energy Factor CO2 Regime used for the pumping station

YES

YES

2

30

0

  

eghgf_regime

Text

          
Turbine

Check this option to model the pump station as a turbine.

(When modelling a pump station in turbine mode, Mode of Control (on the Pump Control Page) must be set to TURB)

 YES YES 2       turbine Boolean 0        

Pumps

This page displays a list of pump curves and a series of parameters for each pump.

The Pumping Station Operation dialog can be opened from this page by clicking the PST Operation button.

Database Table Name: wn_pst_pumps

Show Columns

Help Text

Size, Type and Units

Database Names

Error Limits

Position in Data Structure

Field Name

Help Text

Flag

Size

Units

Database Table

Database Field

Type

Default

Error Lower Limit

Error Upper Limit

Warning Lower Limit

Warning Upper Limit

1

Pump Curve ID

Name for the pump curve

NO

30

 

wn_pst_pumps

pump_curve_id

Text

 

 

 

 

 

2

Duty Flow

Pump duty flow as expected. May or may not be equal to rated discharge

NO

 

WN_Q

wn_pst_pumps

duty_flow

 

 

0.1

10000000

 

 

3

Local Loss Coefficient

Local energy loss coefficient due to throttling of this pump. (Default = 0)

NO

 

 

wn_pst_pumps

local_loss_coeff

 

 

0

10000000000

 

 

4

Maximum Speed

Initial (maximal) speed when running

NO

 

WN_AV

wn_pst_pumps

actual_speed

 

 

50

5000

 

 

5

Minimum Speed

Minimum rotational speed (for variable speed pumps only)

NO

 

WN_AV

wn_pst_pumps

minimal_speed

 

 

50

5000

 

 

6

No. Of Stages

Number of pump stages for multi-stage pumps only (Default = 1)

NO

 

 

wn_pst_pumps

no_of_stages

 

 

1

10

 

 

7

Cut Off Level

Low suction (off) level for this pump (Default = 0)

NO

 

Z

wn_pst_pumps

cut_off_level

Double

 

-999

9999

 

 

NO

YES

3

 

0

 

pumps

Array

 

 

 

 

 

Pumps Used

This field lists the pumps used in the pumping station. This list is only shown on the grid. Full details of the pumps can be found on the Pump Data grid on the pump property sheet. See below.

NO

YES

NO

255

0

 

pumps_used

Text

 

 

 

 

 

Bends

This field defines the geometry of the link. The underlying data consists of a series of (x,y) pairs defining the vertices of the link. Each link is made up of a series of straight lines between the defined (x,y) points.

This data is not displayed on the grid or property sheet.

Link vertices are included when you export link data to CSV files. There are two options available for exporting link vertices. These are selected on the Select CSV Export Options dialog using the Coordinate Arrays Format dropdown list. The options are:

  • Packed - The data is exported as a series of x,y pairs. {644362.99966,263102.99717,643599.42660,263312.948517}

  • Separately - the data is appended to the end of the row containing the link data. Each x and y value is in a separate (comma separated) field.

NO

YES

NO

 

0

XY

bends

Array

 

 

 

 

 

InfoNet Unique ID

The InfoNet Unique ID and InfoNet Network ID are unique identifiers associated with the corresponding object and network in an InfoNet database. When importing from InfoNet, these identifiers can be copied from the InfoNet database in order to maintain links between the two networks.

YES

YES

NO

 

0

 

asset_uid

GUID

 

 

 

 

 

InfoNet Network ID

See InfoNet Unique ID

NO

YES

NO

 

0

 

asset_network_uid

GUID

 

 

 

 

 

Pumping Station Control Data

Database Table Name: wn_ctl_pst

Show Columns

Help Text

Visibility

Size, Type and Units

Database Names

Error Limits

Field Name

Help Text

Flag

Grid

Property Page

Size

Precision

Units

Database Field

Data Type

Default

Error Lower Limit

Error Upper Limit

Warning Lower Limit

Warning Upper Limit

Mode Of Control

Available modes are:

Database Value

Help Text

AUTO

Pumps switched on/off according to variation of pressure in the control node or water level in the control reservoir.

FLOW

Discharge through the PST is a given function of time

PLAN

Pumps operate according to an accepted schedule covering the whole period of simulation.

PROF

Pumps operate in such a manner that water level in the control reservoir (or pressure in the control node) follows a given target profile.
TFLW Pumps operate in such a manner that flow in a control pipe follows a given target profile.
TURB

PST operates in turbine mode.

Turbine operate according to an accepted schedule covering the whole period of simulation.

YES

YES

4

4

0

 

mode

 Text

 

 

 

 

 

System Role

Available system roles are:

Database Value

Description

BOOSTER

Booster

RAW WATER

Raw Water

SOURCE

Source

UNKNOWN

Unknown

YES

YES

4

10

0

 

system_role

 Text

 

 

 

 

 

Control Node

Control point for AUTO and PROF Mode of control.

YES

YES

4

30

0

 

control_node

 Text

 

 

 

 

 
Control Pipe Control link for TFLW Mode of control YES YES 4 63 0   control_pipe Text          

Licensed Maximum Power Demand

Maximum licensed power on the pumping station site (not the maximum installed power)

YES

YES

4

 

1

WN_KVA

max_power

 

 

 

 

 

 

Override Node

Optional - name of OVERPRESSURE control node for FLW, PLAN and TFLW Mode of control

If the pressure/level at the Override node exceeds the Pressure Off value at any time, the pumping station will be stopped immediately, regardless of profile controls. The station will resume operation only when the pressure/level at the Override node falls below the Pressure On value.

YES

YES

4

30

0

 

override_node

 Text

 

 

 

 

 

Pressure On

Restart level of pressure or water level at Override Node.

YES

YES

4

 

2

WN_P

pressure_on

 

 

 

 

0

199

Pressure Off

Switch off level of pressure or water level at Override Node.

YES

YES

4

 

2

WN_P

pressure_off

 

 

 

 

0

199

Live Data Point ID

Name of the associated Live Data Point

YES

YES

4

100

0

 

live_data_point_id

 Text

 

 

 

 

 

Pipe Closed

The pipe is permanently closed if the box is checked

YES

YES

4

 

0

 

pipe_closed

 Boolean

 

 

 

 

 

Pumps

Grid displayed for AUTO, PROF and TFLW control modes.

List of pump initial values. The order of the pump control data corresponds with the order of the pumps specified on the Pump Data Page.

Database Table Name: wn_ctl_pst_pumps

Show Columns

Help Text

Size, Type and Units

Database Names

Error Limits

Position in Data Structure

Field Name

Help Text

Flag

Size

Units

Database Table

Database Field

Type

Default

Error Lower Limit

Error Upper Limit

Warning Lower Limit

Warning Upper Limit

1

Pump Initial Status

Status if pump at start of simulation.

Available Modes are:

Database Value

Description

Help Text

0

Not Available

Link closed

1

Standby

Initial status OFF

2

Active

Initial status ON

NO

 

 

wn_ctl_pst_pumps

pump_initial_status

Integer

 

0

2

 

 

2

On/Target Deviation On

This field is obsolete and is not displayed in the interface. This data is now entered in the Pump Specific Profile Grid.

The field is maintained for backwards compatibility with old CSV data files. If this value is set when the data is imported, InfoWorks will import appropriate values into the Pump Specific Profile Grid.

NO

 

Y

wn_ctl_pst_pumps

on

 

 

-999.5

 

 

 

3

Off/Target Deviation Off

This field is obsolete and is not displayed in the interface. This data is now entered in the Pump Specific Profile Grid.

NO

 

Y

wn_ctl_pst_pumps

off

 

 

-999.5

 

 

 

4

Initial Speed

Time related speed (required for Variable Speed pumps only)

NO

 

WN_AV

wn_ctl_pst_pumps

speed

 

 

50

5000

 

 

5

% Speed On

This field is obsolete and is not displayed in the interface. This data is now entered in the Pump Specific Profile Grid.

NO

 

 

wn_ctl_pst_pumps

speed_pc_on

 

 

 

 

 

 

6

% Speed Off

This field is obsolete and is not displayed in the interface. This data is now entered in the Pump Specific Profile Grid.

NO

 

 

wn_ctl_pst_pumps

speed_pc_off

 

 

 

 

 

 

NO

YES

5

 

0

 

pumps

 Array

 

 

 

 

 

Profiles

Pump station profiles grid.

Database Table Name: wn_ctl_pst_profiles

Show Columns

Help Text

Size, Type and Units

Database Names

Error Limits

Position in Data Structure

Field Name

Help Text

Flag

Size

Units

Database Table

Database Field

Type

Default

Error Lower Limit

Error Upper Limit

Warning Lower Limit

Warning Upper Limit

1

Date & Time

Date and time from which profile applies.

YES

 

 

wn_ctl_pst_profiles

date_time

 

 

 

 

 

 

2

Total Flow

Target flow until the next target is specified.

FLOW and TFLW mode.

NO

 

WN_Q

wn_ctl_pst_profiles

total_flow

 

 

0

5000000

 

 

3

Pump Status Flags

Status flag for each pump.

0 = OFF
1 = ON

For multiple pumps, the status flag is applied to each pump. For example, if there are three pumps and all pumps are to be ON, then the value in this field would be 111. If only the first pump is to be ON and the other two pumps are to be OFF, then the value would be 100. ON/ON/OFF would be 110, etc.

Exception: For all pumps to be off, the value must be 0, because you cannot enter 000.

PLAN and TURB mode.

NO

12

 

wn_ctl_pst_profiles

pump_status_flags

Text

 

 

 

 

 

4

Target Pressure Depth

The target pressure or depth for the pump to maintain at control node specified on Pump Control Page until the next target is specified.

PROF mode.

NO

 

Y

wn_ctl_pst_profiles

target_pressure_depth

 

 

0

199

 

 

5

Initial Speed

Time related speed (Required for variable speed pumps only).

PLAN and TURB mode.

NO

 

WN_AV

wn_ctl_pst_profiles

speed

 

 

50

5000

 

 

6

Pump Availability Flags

Availability flag for each pump.

0 = Unavailable
1 = Available

For multiple pumps, the availability flag is applied to each pump. For example, if there are three pumps and all pumps are available, then the value in this field would be 111. If only the first pump is available and the other two pumps are unavailable, then the value would be 100. Available/Available/Unavailable would be 110, etc.

Exception: If all pumps are unavailable, the value must be 0, because you cannot enter 000.

AUTO and PROF modes.

NO

12

 

wn_ctl_pst_profiles

pump_availability_flags

Text

 

 

 

 

 

NO

YES

5

 

0

 

profiles

 Array

 

 

 

 

 
Pump specific profile

Time varying profile for specific pumps. Applicable to AUTO, PROF and TFLW mode of control.

To display the time varying profile for a pump, click the left hand side of the pump row in the pumps grid.

Show Columns

Help Text

Size, Type and Units

Database Names

Error Limits

Position in Data Structure

Field Name

Help Text

Flag

Size

Units

Database Table

Database Field

Type

Default

Error Lower Limit

Error Upper Limit

Warning Lower Limit

Warning Upper Limit

1

 Selected Pump [No.]

The currently selected pump is displayed at the top of the grid.

To display the time varying profile for a pump, click the left hand side of the pump row in the pumps grid.

NO

 

 

wn_ctl_f_pst_pumps_profiles

pump_number

Integer

 

 

 

 

 

2

 Date & Time

Date and time from which profile applies.

If only one row is defined in the profile, it is not necessary to specify a date-time. The controls defined in the row will be applied throughout the simulation.

If multiple rows are defined, date-time must be specified for each row.

NO

 

 

wn_ctl_f_pst_pumps_profiles

date_time

Date/Time

 

    

 

 

3

 On/Target Deviation On

Applicable to AUTO and PROF pumps.

For AUTO pumps, this is the target level at which the pump is switched on.

For PROF pumps, this is the deviation from the target level at which the pump is switched on.

Pump will be switched on when pressure at control node is less than target level plus on deviation.

NO

 

 Y

wn_ctl_f_pst_pumps_profiles

on

Single

 

 -999.5  

 

 

4

 Off/Target Deviation Off

Applicable to AUTO and PROF pumps.

For AUTO pumps, this is the target level at which the pump is switched off.

For PROF pumps, this is the deviation from the target level at which the pump is switched off.

Pump will be switched off when pressure at control node is greater than target level plus off deviation.

NO

 

Y

wn_ctl_f_pst_pumps_profiles

off

 Single

 

 -999.5  

 

 

5

 % Speed On

Applicable to AUTO, PROF and TFLW pumps.

Reference pump speed, (expressed as a percentage of the reference pump's maximum speed), at which pump is switched on.

Pump will be switched on when the reference pump (taken as the first active variable speed pump in the pump station) reaches % speed on x maximum speed.

NO

 

 

wn_ctl_f_pst_pumps_profiles

speed_pc_on

 Single

 

    

 

 

6

 % Speed Off

Applicable to AUTO, PROF and TFLW pumps.

Reference pump speed, (expressed as a percentage of the reference pump's maximum speed), at which pump is switched off.

Pump will be switched off when the reference pump (taken as the first active variable speed pump in the pump station) reaches % speed off x maximum speed.

NO

 

 

wn_ctl_f_pst_pumps_profiles

speed_pc_off

Single

 

 

 

 

 
7 Target Deviation Flow On

Applicable to TFLW pumps.

The deviation from the target level at which the pump is switched on.

Pump will be switched on when flow at control pipe is less than target level plus on deviation.

 NO   WN_Q wn_ctl_f_pst_pumps_profiles flow_on Single   -5000000 5000000    
8 Target Deviation Flow Off

Applicable to TFLW pumps.

The deviation from the target level at which the pump is switched off.

Pump will be switched off when flow at control pipe is greater than target level plus off deviation.

 NO   WN_Q wn_ctl_f_pst_pumps_profiles flow_off Single   -5000000 5000000    
    5                    

Repeat Period

Profile period which will be repeated throughout simulation, if the Repeat Profile box is checked.

Database Value

Description

Help Text

0

1 day

Repeat Period

1

1 week

Repeat Period

2

2 weeks

Repeat Period

YES

YES

5

 

0

 

repeat_period

 Integer

0

 

 

 

 

Repeat Profile

Check the Repeat Profile box to repeat a profile (from 00:00 for the selected Repeat Period) for the duration of the simulation.

IMPORTANT

When using the Repeat Profile option; if the defined profile spans over the selected Repeat Period, the profile will not be repeated.

YES

YES

5

 

0

 

repeat_profile

 Boolean

1

 

 

 

 

Repeat Profile

Check the Repeat Profile box to repeat a profile (from 00:00 for the selected Repeat Period) for the duration of the simulation.

IMPORTANT

When using the Repeat Profile option; if the defined profile spans over the selected Repeat Period, the profile will not be repeated.

YES

YES

5

 

0

 

repeat_status

 Boolean

1

 

 

 

 

Repeat Period

Profile period which will be repeated throughout simulation, if the Repeat Profile box is checked.

Database Value

Description

Help Text

0

1 day

Repeat Period

1

1 week

Repeat Period

2

2 weeks

Repeat Period

YES

YES

5

 

0

 

repeat_status_period

 Integer

0

 

 

 

 

Linear Profile

This checkbox decides if values in the profile grid are interpolated.

  • checked - linear interpolation is carried out between values

  • unchecked - The value entered in the grid changes at each time point, and is maintained until the next time point is reached.

YES

YES

5

 

0

 

linear_profile

 Boolean

 

 

 

 

 

After Last Point

Database Value

Description

Help Text

0

Extend Forward

The last value in the profile grid is extended to the end of the simulation or repeat period.

1

Extrapolate Forward

Applies to Linear Profiles only: the last two values in the profile grid are used to extrapolate forward to the end of the simulation or repeat period.

(If Extrapolate Forward is selected for a non linear profile, the profile will be extended forward.)

YES

YES

5

 

0

 

after_profile

 Integer

 

 

 

 

 

Before First Point

Database Value

Description

Help Text

0

Extend Back

The first value in the profile grid is extended back to the start of the simulation (and repeat period for repeated profiles).

1

Extrapolate Back

Applies to Linear Profiles only: the first two values in the profile grid are used to extrapolate back to the start of the simulation (and repeat period for repeated profiles).

(If Extrapolate Back is selected for a non linear profile, the profile will be extended back.)

2

Zero/Unchanged

A value of zero or "off" is applied from the start of the simulation until the date / time of the first value in the profile grid (and from the start of the repeat period for repeated profiles).

YES

YES

5

 

0

 

before_profile

 Integer

 

 

 

 

 
Multiple VSP Regulation

When this option is checked the pump station will regulate using all identical and available variable speed pumps; pump speeds will vary together to achieve a target.

If this option is unchecked, the pump station will only use the first available variable speed pump to regulate. Other pumps in the pump station will be run at full speed.

Applicable to TFLW, AUTO and PROF Mode of Control pump stations with more than one variable speed pump.

 YES YES 5   0   multi_vsp_regulation Boolean 0        

Disable UPC

Check this box to disable both local and global UPC Scripts for the network object.

Any controls defined for the object other than UPC Scripts will be applied.

NO

YES

6

 

 

 

disable_upc

 Boolean

 

 

 

 

 

UPC Script

Local UPC Script describing the logical controls for the current network object.

NO

YES

6

 

 

 

upc_script

 Memo

 

 

 

 

 

Enable Surge

Check this option to enable Transient simulation fields.

Note: the Enable Surge field and Enable PID Regulation field cannot be checked at the same time.

YES

YES

7

 

 

 

iwts_enable_surge

 Boolean

0

 

 

 

 

Pump Event

Time-speed profile used to dictate speed of pump during transients simulation when Pump Change is set to SPEED.

Database Table Name: wn_ctl_pump_iwts_event

Show Columns

Help Text

Size, Type and Units

Database Names

Error Limits

Position in Data Structure

Field Name

Help Text

Flag

Size

Units

Database Table

Database Field

Type

Default

Error Lower Limit

Error Upper Limit

Warning Lower Limit

Warning Upper Limit

1

Time

The time at which the speed takes effect

NO

 

 

wn_ctl_pump_iwts_event

time

Double

0.0

 

 

 

 

2

Speed

The speed at the pst at this time

NO

 

 

wn_ctl_pump_iwts_event

speed

Double

0.0

 

 

 

 

NO

NO

7

 

 

 

iwts_event

 Array

 

 

 

 

 

Pump Change

Type of pump operational change to be applied during transient simulation:

Database Value

Description

Help Text

SPEED

Speed

The profile defined in the Pump Event grid will dictate speed of the pump during transients simulation.

TRIP

Trip

At Trip Time the pump will run down. Once the pump has lost power it may continue turning (turbining) or be forced to run backwards (reverse turbine).

A Four Quadrant Pump Curve describing pump performance in both normal and abnormal operating conditions is automatically selected for use from data specified on the Pump Curve Page.
RATCHET Ratchet

At Trip Time the pump will run down. A one-way bearing installed in the pump allows the pump to turbine but will not allow it to spin backwards.

A Four Quadrant Pump Curve describing pump performance in both normal and abnormal operating conditions is automatically selected for use from data specified on the Pump Curve Page.

YES

NO

7

10

 

 

iwts_pump_change

 Text

SPEED

 

 

 

 

Trip Time

Enabled when Pump Change field is set to TRIP or RATCHET.

Time from start of transient simulation at which pump loses power.

YES

NO

7

 

2

 

iwts_trip_time

 Single

1

 

 

 

 
Enable PID Regulation

Check this option to enable PID regulation fields.

Note: the Enable PID Regulation field and Enable Surge field cannot be checked at the same time.

 YES NO 7   0   iwtsEnableRegulation Boolean 0        
Regulator Type

Transient simulation field enabled when the Enable PID Regulation field is checked.

Type of regulator:

Database Value

Description

Help Text

0

Flow

 Pump station is modelled as flow regulating

1

Pressure

 Pump station is modelled as pressure regulating
YES NO 7 10 0   iwtsRegulatorType Text Flow        
Setting

Transient simulation field enabled when the Enable PID Regulation field is checked.

Target flow value when Regulator Type is set to Flow.

Target pressure value when Regulator Type is set to Pressure.

 YES NO 7   0   iwtsSetting Double 0        
Control Node

Transient simulation field enabled when the Enable PID Regulation field is checked and Regulator Type is set to Pressure.

Node where pressure is measured to control the pump station.

 YES NO 7 30 0   iwts_control_node Text          
Control Pipe

Transient simulation field enabled when the Enable PID Regulation field is checked and Regulator Type is set to Flow.

Pipe where flow is measured to control the pump station.

 YES NO 7 63 0   iwts_control_pipe Text          
Controller Gain

Transient simulation field enabled when the Enable PID Regulation field is checked.

The Velocity form of the PID equation is used to calculate the change in regulator setting from one sample time to the next.

 

Control input at time (t) is calculated as:

 

where:

Kc = Controller (Proportional) gain

Ti = Integral time

Td = Differential time

Ts = Sample time (specified in InfoWorks TS Options dialog)

e(t) = Error signal from control object
YES NO 7   3   iwts_controller_gain Single          
Integral Time

Transient simulation field enabled when the Enable PID Regulation field is checked.

Integral time used in the Velocity PID equation (see Controller Gain for details).

 YES NO 7   1 TS iwts_integral_time Single          
Differential Time

Transient simulation field enabled when the Enable PID Regulation field is checked.

Differential time used in the Velocity PID equation (see Controller Gain for details).

 YES NO 7   1 TS iwts_differential_time Single          

NRV Diameter

Diameter of series non-return valve

YES

NO

7

 

1

PS

nrv_diameter

 Single

0

 

 

 

 

NRV Loss Coefficient

Local headloss coefficient when the non-return valve is fully open

YES

NO

7

 

3

 

nrv_loss_coeff

 Single

0

 

 

 

 

NRV Response Time

The amount of time it takes for non-return valve to go from fully opened to fully closed

YES

NO

7

 

3

 

nrv_response_t

 Single

0

 

 

 

 

NRV Do Not Reopen

If this option is checked, the non-return valve will not open once it has closed

YES

NO

7

 

0

 

nrv_dont_reopen

 Boolean

0

 

 

 

 
Enable Surge (Turbine)

Check this option to enable Transient simulation fields for turbines.

 YES YES 8   0   iwts_enable_surge_turbine Boolean          
Rated Efficiency

Rated efficiency from manufacturer's curve

A Transient simulation field.

 YES YES 8   2 WN_OPEN iwts_rated_efficiency Long Integer   0 100    
Inertia

A measure of the turbine's resistance to change in momentum.

A Transient simulation field.

 YES YES 8   2 WN_INERTIA iwts_inertia Single          
Turbine Diameter

Internal diameter of turbine.

A Transient simulation field.

 YES YES 8   1 WN_P iwts_turbine_diameter Single   0      
Wicket Gate Initial Opening

Opening of wicket gate at start of simulation.

A Transient simulation field.

 YES YES 8   2 WN_OPEN iwts_wicket_gate_init_opening Long Integer 100 0 100    
Change Type

Type of turbine operational change to be applied during transient simulation:

Database Value

Description

Help Text

0

Speed

The profile defined in the Time/Speed grid will dictate speed of the turbine during transients simulation.

1

Trip

At Trip Time the turbine will run down.

A Four Quadrant Pump Curve describing pump performance in both normal and abnormal operating conditions is automatically selected for use.
YES YES 8   1   iwts_change_type Integer          
Trip Time

Enabled when Change Type field is set to TRIP.

Time from start of transient simulation at which pump loses power.

 YES YES 8   2   iwts_trip_time Single 1        
Time/Speed Grid

Time-speed profile used to dictate speed of pump during transients simulation.

Database Table Name: wn_ctl_pst_turbine_change

Show Columns

Help Text

Size, Type and Units

Database Names

Error Limits

Position in Data Structure

Field Name

Help Text

Flag

Size

Units

Database Table

Database Field

Type

Default

Error Lower Limit

Error Upper Limit

Warning Lower Limit

Warning Upper Limit

1

Speed

The speed at the pst

NO

 

WN_AV

wn_ctl_pst_turbine_change

iwts_speed

Double

 

 

 

 

 

2

Time

The time at which the speed takes effect

NO

 

TS

wn_ctl_pst_turbine_change

iwts_time

Double

 

 

 

 

 
NO NO 8   0   iwts_turbine_change Array          
Wicket Gate Change Time/Opening Grid

Time-opening profile used to dictate opening of wicket gate during transients simulation.

Database Table Name: wn_ctl_pst_wicket_gate_change

Show Columns

Help Text

Size, Type and Units

Database Names

Error Limits

Position in Data Structure

Field Name

Help Text

Flag

Size

Units

Database Table

Database Field

Type

Default

Error Lower Limit

Error Upper Limit

Warning Lower Limit

Warning Upper Limit

1

Opening

The opening of the wicket gate

NO

 

WN_OPEN

wn_ctl_pst_wicket_gate_change

time

Double

 

 

 

 

 

2

Time

The time at which the opening takes effect

NO

 

TS

wn_ctl_pst_wicket_gate_change

speed

Double

 

 

 

 

 
NO NO 8   0   iwts_wicket_gate_change Array          
Maximum Shear Strength

The maximum value for the corrosion layer shear strength on the pipe wall.

The maximum value for which the hydraulic shear strength will result in material being eroded from the pipe wall.

See Water Quality - Turbidity Analysis for further information.

 YES YES 9     WN_STRESS wq_max_shear_strength Double          
Initial Shear Strength

The initial value for the corrosion layer shear strength on the pipe wall.

The hydraulic shear strength must rise above this initial value to begin the erosion of material from the pipe wall.

See Water Quality - Turbidity Analysis for further information.

 YES YES 9     WN_STRESS wq_init_shear_strength Double          
Erosion Coefficient

Parameter used to calculate the quantity of material eroded from the pipe wall when the hydraulic shear stress exceeds the corrosion layer shear strength; the excess shear.

See Water Quality - Turbidity Analysis for further information.

 YES YES 9     WN_RATE wq_erosion_coefficient Double          
Erosion Exponent

The power to which the ratio of excess shear to maximum shear strength is raised when calculating the quantity of material released from the pipe wall.

A value of zero will be interpreted as meaning the erosion is independent of the excess shear.

See Water Quality - Turbidity Analysis for further information.

 YES YES 9       wq_erosion_exponent Double          
Release Coefficient

Parameter used to calculate the increase in turbidity as a result of material eroded from the pipe wall.

See Water Quality - Turbidity Analysis for further information.

 YES YES 9     WN_TURBLEN wq_release_coefficient Double          

Cost Management

Check the Cost Management box to carry out optimisation of the pumping schedule of the Pump Station when running a Cost Management Simulation (Only Pump Stations of Mode PROF or PLAN can be optimised) or a BalanceNet Simulation.

YES

YES

10

 

0

 

optimise

 Boolean

 

 

 

 

 

Max No. of Switches

A Cost Management Simulation constraint.

The target maximum number of times that pumps may be switched on / off during the simulation.

YES

YES

10

 

0

 

opt_max_switches

 Integer

8

 

 

 

 

Min Off Time

A BalanceNet Simulation and Cost Management Simulation constraint.

When a pump is switched off, the target minimum time for which the pump remains switched off.

YES

YES

10

 

0

 

opt_min_off_time

 Integer

30

 

 

 

 

Min On Time

A BalanceNet Simulation and Cost Management Simulation constraint.

When a pump is switched on, the target minimum time for which the pump remains switched on.

YES

YES

10

 

0

 

opt_min_on_time

 Integer

30

 

 

 

 
Max Off Time

A BalanceNet Simulation and Cost Management Simulation constraint.

When a pump is switched off, the target maximum time for which the pump can be switched off.

 YES YES 10     DUR opt_max_off_time Long Integer 0        
Time since last change

A BalanceNet Simulation and Cost Management Simulation constraint.

Time, at start of simulation, since previous state change (from on to off, or from off to on).

The optimiser will infer what the previous state was.

Can be used in conjunction with Min/Max On/Off Times.

 YES YES 10     DUR opt_InitState_Minutes Long Integer 0        

Switch On Cost

A BalanceNet Simulation constraint.

Cost of turning a pump on. This could represent genuine wear and tear. The cost of this operation is factored into the evaluation of schedules.

 YES YES 10   2 WN_COST opt_SwitchOnCost Double          

Initial Max Power

A BalanceNet Simulation constraint.

Initial maximum power (kVA) at the beginning of the simulation. This is used with maximum demand tariffs (see Maximum Power Demand Rates Pages of Electricity Tariffs), where the customer is charged for the maximum electric power used in a month.

 YES YES 10   1

WN_KVA

 opt_InitMaxPower Double          

Maximum Pumps

A BalanceNet Simulation constraint.

Maximum number of pumps that can be on at the same time in the pumping station.

Please refer to the BalanceNet Pump Grouping Wizard topic for details on pump combination rules.

Tip

This field is also available on the BalanceNet Pump Grouping Wizard.

YES YES 10    

 

opt_MaxPumps

 Integer

 

        

PST Run Order

A BalanceNet Simulation constraint.

Order in which pump stations must be switched on.

PST Run Orders do not need to be incremental. A PST Run Order of 0 means that there are no run order restrictions on the pumping station.

Please refer to the BalanceNet Pump Grouping Wizard topic for details on pump combination rules.

Tip

This field is also available on the BalanceNet Pump Grouping Wizard.

YES YES 10      

opt_RunOrder

 Integer          

PST Combination

A BalanceNet Simulation constraint.

Number indicating whether pumping stations are mutually exclusive. Pumping stations cannot be run together if they have different non-zero run combination numbers.

Combination Numbers within a group do not need to be incremental. A Run Combination Number of 0 means that there are no run combination restrictions on that pumping station.

Please refer to the BalanceNet Pump Grouping Wizard topic for details on pump combination rules.

Tip

This field is also available on the BalanceNet Pump Grouping Wizard.

YES YES 10       opt_RunCombination Integer          

BalanceNet Combinations Grid

BalanceNet Simulation constraints.

Database Table Name: wn_ctl_pst_pumps

Show Columns

Help Text

Size, Type and Units

Database Names

Error Limits

Position in Data Structure

Field Name

Help Text

Flag

Size

Units

Database Table

Database Field

Type

Default

Error Lower Limit

Error Upper Limit

Warning Lower Limit

Warning Upper Limit

1

Pump Run Order

Order in which pumps belonging to the same pumping station must be switched on.

Pump Run Orders do not need to be incremental. A Pump Run Order of 0 means that there are no run order restrictions on the pump.

NO

 

 

wn_ctl_pst_pumps

opt_runorder

Integer

 

 

 

 

 

2

Pump Combination

Number indicating whether pumps within the pumping station are mutually exclusive. Pumps within a pumping station cannot be run together if they have different non-zero run combination numbers.

Combination Numbers within a group do not need to be incremental. A Run Combination Number of 0 means that there are no run combination restrictions on that pump.

NO

 

 

wn_ctl_pst_pumps

opt_runcombination

 Integer

 

 

 

 

 
Tip

These fields are also available on the BalanceNet Pump Grouping Wizard. Please refer to the BalanceNet Pump Grouping Wizard topic for details on pump combination rules.

 NO NO 10       wn_ctl_pst_pumps

Array

          
Period (Max)

A Cost Management Simulation constraint.

Length of time over which Volume (Max) is considered.

 YES YES 10     DUR opt_MaxFlowVolumePeriod Long Integer 0        

Volume (Max)

A Cost Management Simulation constraint.

Target maximum volume of water to flow through the pump over the Period (Max) measured from Period Start (Max) and taking into account Initial Volume (Max).

 YES YES 10     WN_DVO opt_MaxFlowVolume Double 0.0        

Period Start (Max)

A Cost Management Simulation constraint.

Start Date / Time of the period for assessing whether Volume (Max) through the pump has been reached.

Used in conjunction with Initial Volume (Max) if the period start is before the start of the simulation.

 YES YES 10       opt_MaxVolStart_Dtime Date / Time 0.0        

Initial Volume (Max)

A Cost Management Simulation constraint.

Volume of water that has already passed through the pump at the start of the simulation.

Used in conjunction with Period Start (Max).

 YES YES 10   1 WN_DVO opt_MaxVolInit_litre Double 0.0        

Volume (Min)

A Cost Management Simulation constraint.

Target minimum volume of water to flow through the pump over the Period (Min) measured from Period Start (Min) and taking into account Initial Volume (Min).

 YES YES 10     WN_DVO opt_MinFlowVolume Double 0.0        

Period (Min)

A Cost Management Simulation constraint.

Length of time over which Volume (Min) is considered.

 YES YES 10     DUR opt_MinFlowVolumePeriod Long Integer 0        

Period Start (Min)

A Cost Management Simulation constraint.

Start Date / Time of the period for assessing whether Volume (Min) through the pump has been reached.

Used in conjunction with Initial Volume (Min) if the period start is before the start of the simulation.

 YES YES 10       opt_MinVolStart_Dtime Date / Time 0.0        

Initial Volume (Min)

A Cost Management Simulation constraint.

Volume of water that has already passed through the pump at the start of the simulation.

Used in conjunction with Period Start (Min).

 YES YES 10   1 WN_DVO opt_MinVolInit_litre Double 0.0        

Flow Volume Constraints

BalanceNet Simulation constraints.

Database Table Name: wn_ctl_balancenet_volume

Show Columns

Help Text

Size, Type and Units

Database Names

Error Limits

Position in Data Structure

Field Name

Help Text

Flag

Size

Units

Database Table

Database Field

Type

Default

Error Lower Limit

Error Upper Limit

Warning Lower Limit

Warning Upper Limit

1

 Name

Unique identifier for the constraint.

NO

30

 

wn_ctl_balancenet_volume

name

Text

 

 

 

 

 

2

Time Period

Length of time over which the constraint is considered.

Permitted values are:

  • Day
  • Week
  • Month
  • Year

NO

 

 

wn_ctl_balancenet_volume

time_period

Integer

 

    

 

 

3

Reset Time

Indicates when the constraint is reset (for example every day at 3am).

NO

 

wn_ctl_balancenet_volume

reset_time

Date / Time

 

    

 

 

4

Reset Weekday

Only applies when Time Period is set to Week

Day of the week when the constraint is reset.

NO

 

wn_ctl_balancenet_volume

reset_weekday

 Integer

 

    

 

 

5

Reset Day

Only applies to monthly and yearly constraints

Day of the month the constraint is reset.

NO

 

 

wn_ctl_balancenet_volume

reset_day

 Integer

 

    

 

 

6

Reset Month

Only applies to yearly constraints

Month in which the constraint is reset.

NO

 

 

wn_ctl_balancenet_volume

reset_month

 Integer

 

    

 

 

7

Initial Volume

Initial volume at the beginning of the BalanceNet simulation.

NO

 

WN_DVO

wn_ctl_balancenet_volume

initial_volume

Double

 

 

 

 

 
8

Min / Max

Indicates whether this is a minimum or maximum constraint.

 NO     wn_ctl_balancenet_volume min_max Integer          
9

Min / Max Volume

Minimum or maximum volume constraint.

 NO   WN_DVO wn_ctl_balancenet_volume min_max_volume Double          
NO NO 10      

wn_ctl_f_balancenet_volume

 Array          

Max Flow Rate

A BalanceNet Simulation and Cost Management Simulation constraint.

Upper instantaneous limit on flow.

 YES YES 10     WN_Q opt_MaxFlowInstant Double          

Min Flow Rate

A BalanceNet Simulation and Cost Management Simulation constraint.

Lower instantaneous limit on flow.

 YES YES 10     WN_Q opt_MinFlowInstant Double          

VSP Number of Steps

A BalanceNet Simulation constraint.

This parameter specifies the number of steps that BalanceNet can use for this pump station (accepted values are between 1 and 10). This applies to BalanceNet simulations with variable speed pumps.

During the BalanceNet optimisation the speed will be varied between the minimum and maximum speed for the pump using the number of steps specified, e.g. if the Maximum Speed is 1800 rpm, and the Minimum Speed is 1200 rpm and 4 steps are used, the used speeds will be 1200, 1400, 1600 and 1800 rpm.

 YES YES 10       opt_VSPNumSteps Integer     10    

Notes

You can keep freeform notes about any object in your network. The notes field can be up to 64,000 characters in size, or about 10 pages of printed text.

NO

YES

13

 

0

 

notes

 Memo

 

 

 

 

 

Has Local UPC

Read only field displayed in the grid view only.

If the Has Local UPC box is checked, the network objects has a Local UPC Script defined. The UPC Script can be viewed from the object property sheet.

NO

YES

NO

 

 

 

has_local_upc

 Boolean

 

 

 

 

 

PoW Unit Cost (from - to)

Cost per cubic metre, in user defined currency units, of transferring water between the From Node and To Node.

Prices can be negative to allow for exports or bulk water sale.

YES

YES

NO

 

2

WN_VCOST

usds_pow_cost

 

 

 

 

 

 

PoW Category (from - to)

The category into which this cost falls, for flow between the From Node and To Node.

Database Value

Description

Treatment

Treatment

Pumping

Pumping

Transport

Transport

Import

Import

Export

Export

Extraction

Extraction

Chlorination

Chlorination

Chem. Treatment

Chem. Treatment

Other

Other

YES

YES

NO

16

0

 

usds_pow_cat

 Text

 

 

 

 

 

PoW Unit Cost (to - from)

Cost per cubic metre, in user defined currency units, of transferring water between the To Node and From Node.

Prices can be negative to allow for exports or bulk water sale.

YES

YES

NO

 

2

WN_VCOST

dsus_pow_cost

 

 

 

 

 

 

PoW Category (to - from)

The category into which this cost falls, for flow between the To Node and From Node.

Database Value

Description

Treatment

Treatment

Pumping

Pumping

Transport

Transport

Import

Import

Export

Export

Extraction

Extraction

Chlorination

Chlorination

Chem. Treatment

Chem. Treatment

Other

Other

YES

YES

NO

16

0

 

dsus_pow_cat

 Text

 

 

 

 

 

From Node ID

Name of the From Node for this pipe. You can select the name from the dropdown list of existing nodes, or type the name of a node you have yet to add to the model.

From and To represent the typical direction of flow for the pipe. Flow will not always be in this direction.

YES

YES

1

30

0

 

us_node_id

 Text

 

 

 

 

 

To Node ID

Name of the To Node for this pipe.

From and To represent the typical direction of flow for the pipe. Flow will not always be in this direction.

YES

YES

1

30

0

 

ds_node_id

 Text

 

 

 

 

 

Suffix

A suffix added by InfoWorks to ensure that all link Ids are unique

YES

YES

NO

1

0

 

link_suffix

 Text

 

 

 

 

 

Asset ID

For reference only. Designed as a reference to an asset database, but could be used for anything.

YES

YES

1

30

 

 

asset_id

 Text

 

 

 

 

 

PoW

Read only field that indicates if Price of Water data has been entered on the property sheet

NO

YES

NO

 

0

 

pow_selected

 Boolean

 

 

 

 

 

Pumping Station Results

All results fields are displayed on the grid when opened while viewing a replay of a simulation, and on a special results page placed at the front of Property Sheets displayed while viewing a simulation replay.

For details of results fields for links, see the Link Results Data Fields topic.

Pumping Station Data fields related to live data

Closed

These fields are present in the Pump Station Live Control editor, which is accessible from the Fields tab of the Baseline.

Database Table Name- wn_ctl_f_pst_livec.

Field Name

Database

Name

Database Field

Description

Data Type

Size

Units

Start time

wn_ctl_f_pst_livec

start_time

  

Date / Time

  

DUR

End time

wn_ctl_f_pst_livec

end_time

  

Date / Time

  

DUR

Pump Status Flags

wn_ctl_f_pst_livec

pump_status_flags

  

Text

12

 

About pumping stations

Network data field information

Common data field information

Link results data fields