Valve Data Fields

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 pipe.

YES

YES

1

2

L

length

0.1

99000

Friction Type

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

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

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

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

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

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:

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

Diameter

Pipe diameter

YES

YES

2

1

PS

diameter

10

20000

Valve Diameter

Diameter of the valve when fully open

YES

YES

2

0

PS

valve_diameter

10

20000

Loss Coeff. (Open)

Local headloss coefficient when the valve is open. Minimum value 0.01

YES

YES

2

4

loss_when_open

0

10000

Valve Curve

Reference to built in curve, or user defined curve.

Please Note

Gate valves may be used as isolation valves (on/off control). However, it is recommended that in general gate valves are not used as control valves.

YES

YES

2

30

0

construction_type

Text

PLUG

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.

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

Live Data Point ID

Name of the associated Live Data Point

YES

YES

3

100

0

live_data_point_id

Text

Pipe Closed

The pipe is permanently closed if the box is checked

YES

YES

3

0

pipe_closed

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

3

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.

YES

YES

3

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

3

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.

YES

YES

3

16

0

dsus_pow_cat

Text

Pipe Status

You can set a time-varying profile for the pipe closed state in the grid. See Closed Pipes for more information

The data in this grid is only used if the Pipe Closed checkbox is un-checked.

Database Table Name: wn_ctl_pipe_status

YES

YES

4

status

Array

Repeat Period

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

YES

YES

4

0

repeat_status_period

Integer

0

Profiles

This grid contains time varying control parameters for the valve. Different columns are visible for different valve types.

See Mode ID help for more details on the control parameters required for each valve type.

Database Table Name: wn_ctl_valve_profiles

NO

YES

5

0

profiles

Array

Mode ID

Operation Mode for a valve. The choice is:

YES

YES

5

4

0

mode

Text

PRSV Priority Mode

Mode for PRSV

YES

YES

5

3

prsv_priority

Text

SUS

Opening

Constant percentage valve opening. THV

YES

YES

5

2

WN_OPEN

opening

0

100

Pressure

The constant target pressure. PRV and PSV

YES

YES

5

2

WN_P

pressure

0.1

200

Sustaining Pressure

The constant upstream target pressure. PRSV

YES

YES

5

2

WN_P

prsv_sustaining_p

0.1

200

Reducing Pressure

The constant downstream target pressure. PRSV

YES

YES

5

2

WN_P

prsv_reducing_p

0.1

200

Flow

Target flow to be kept constant throughout the simulation.

FRV only

YES

YES

5

2

WN_Q

flow

0

5000000

Initial Pressure

Initial pressure setting at the start of the simulation.

FMV only.

YES

YES

5

2

WN_P

initial_pressure

Single

0

Initial Flow

Initial flow setting at the start of the simulation.

PFV only.

YES

YES

5

2

WN_Q

initial_flow

Single

0

5000000

Initial Opening

Initial opening of the valve at the start of the simulation.

FCV, PCV, OCV only

If Regulation Type is set to On/Off for OCV valve Initial Opening should be set to 0 or 100%. (A value of >=0.001 will be considered to be 100% open)

YES

YES

5

2

WN_OPEN

initial_opening

0

100

Control Node

See the Mode ID help entry for more information on how the Control Node is used with different valve types

YES

YES

5

30

0

control_node

Text

Control Pipe

Pipe where flow is measured to control the valve.

FCV, FMV only

YES

YES

5

63

0

control_pipe

Text

Sustaining Control Node

Node at which upstream pressure is measured. Target node at which pressure is to be maintained when valve is in Sustaining mode.

PRSV only

YES

YES

5

30

0

prsv_sus_ctlnode

Text

Reducing Control Node

Node at which downstream pressure is measured. Target node at which pressure is to be maintained when valve is in Reducing mode.

PRSV only

YES

YES

5

30

0

prsv_red_ctlnode

Text

Pressure at control node at which valve is fully open (only used if time varying profile has not been specified)

OCV only

Pressure at control node at which valve is fully closed (only used if time varying profile has not been specified)

OCV only

Either continuous or on/off.

OCV only

Repeat Period

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

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

After Last Point

YES

YES

5

0

after_profile

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_status

Boolean

1

Before First Point

YES

YES

5

0

before_profile

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

0

Regulation Precision (%)

The valve regulation precision enables you to set a tolerance for solving valve status. For example if a PRV has a pressure setting of 20m and you specify a precision of 1%, the valve will solve to a value between 19.8–20.2m. A precision of 1% will be suitable in most cases. The Regulation Precision can be set to any value between 0.5% and 10%.

Achievement of the Regulation Precision is dependent on the Computational Accuracy. Once the flow balance set by the Computational Accuracy has been achieved the timestep is deemed to be solved, regardless of the valve regulation precision setting. Tightening the Computational Accuracy will assist with achieving the valve regulation precision required.

The option to enforce solving for both the computational accuracy and the regulation precision for valves by continuing the simulation beyond the computational accuracy solution up to a maximum of 99 iterations is available in the Simulation Options dialog on the Schedule Hydraulic Run View. If after the maximum number of iterations one or more valves have still not achieved a value within the specified precision, you will be informed via the run dialog.

YES

YES

5

3

regulation_precision

1

0

99.999

Cost Management

Enabled when the Show Cost Management fields option is selected in the BalanceNet page of the Options dialog.

Check the Cost Management box to carry out optimisation of the Valve Control profile when running a Cost Management Simulation.

(Only valves of Mode TCV can be optimised.)

YES

YES

5

0

optimise

Boolean

UPC Script

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

NO

YES

6

upc_script

Memo

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

Enable Surge

Check this option to enable Transient simulation fields for modelling valve using a user-defined Time/Valve opening profile.

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

YES

YES

7

iwts_enable_surge

Boolean

0

Valve Event

Transient simulation field enabled when the Enable Surge field is checked.

Time-Opening profile used to dictate valve opening during transients simulation.

Database Table Name: wn_ctl_valve_iwts_event

NO

NO

7

iwts_event

Array

Bypass

Transient simulation field enabled when the Enable Surge field is checked.

Check this option to model a bypass pipe for the control valve.

YES

NO

7

iwts_bypass

Boolean

0

Bypass Diameter

Transient simulation field enabled when the Enable Surge and the Bypass option is checked.

Internal diameter of the bypass pipe

YES

NO

7

2

PS

iwts_bypass_diameter

Single

0.0

Bypass Loss Coefficient

Transient simulation field enabled when the Enable Surge and the Bypass option is checked.

Local headloss coefficient of the bypass pipe

YES

NO

7

3

iwts_bypass_loss_coeff

Single

0.0

Series NRV

Transient simulation field enabled when the Enable Surge field is checked.

Check this option to model a non-return valve in series with the control valve

YES

NO

7

0

iwts_series_nrv

Boolean

0

NRV Do Not Reopen

Transient simulation field enabled when the Enable Surge and Series NRV option is checked.

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

YES

NO

7

0

iwts_nrv_dont_reopen

Boolean

0

NRV Response Time

Transient simulation field enabled when the Enable Surge and Series NRV option is checked.

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

YES

NO

7

1

iwts_nrv_response_time

Single

0.0

Check this option to enable Transient Simulation fields for modelling valve as a regulator.

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

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

Type of regulating valve:

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

Target flow value when Regulator Type is set to Flow.

Target pressure value when Regulator Type is set to Pressure.

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

Used to set the rate at which the valve opens/closes. The modulation of the valve is carried out by changing its resistance (headloss/flow2) by small increments equal to (surge timestep)/(valve response time).

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

Check this option to enable PID regulation fields.

Control Node

(Transient)

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

Node where pressure is measured to control the valve.

Control Pipe

(Transient)

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

Pipe where flow is measured to control the valve.

Transient simulation field enabled when the Use PID control field is checked.

The Velocity form of the PID equation is used to calculate the change in valve position 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

Transient simulation field enabled when the Use PID Control field is checked.

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

Transient simulation field enabled when the Use PID Control field is checked.

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

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.

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.

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.

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.

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.

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

11

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

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