Link

module wntr.network.base

class Link

Bases: object

Base class for links.

For details about the different subclasses, see one of the following: Pipe, Pump, and Valve

Constructor

This is an abstract class and should not be instantiated directly.

Parameters:

• wn (WaterNetworkModel) – WaterNetworkModel object

• link_name (string) – Name of the link

• start_node_name (string) – Name of the start node

• end_node_name (string) – Name of the end node

Attributes

name	The link name (read-only)
link_type	the link type (read only)
start_node	The start node object.
start_node_name	The name of the start node (read only)
end_node	The end node object.
end_node_name	The name of the end node (read only)
initial_status	The initial status (Opened, Closed, Active) of the Link
initial_setting	The initial setting for the link (if Active)
initial_quality	a dict of species and quality if multispecies is active
tag	A tag or label for this link
vertices	A list of interior vertex points for network links, in the direction of start node to end node.

Read-only simulation results

The following attributes are read-only. The values are the final calculated value from a simulation.

flow	(read-only) current simulated flow through the link
headloss	(read-only) current simulated headloss
quality	(read-only) current simulated average link quality
status	(abstract) current status of the link
setting	(read-only) current simulated setting of the link

---

__init__(wn, link_name, start_node_name, end_node_name)

to_dict()

Dictionary representation of the link

to_ref()

property end_node

The end node object.

Type:

Node

property end_node_name

The name of the end node (read only)

Type:

str

property flow

(read-only) current simulated flow through the link

Type:

float

property headloss

(read-only) current simulated headloss

Type:

float

property initial_quality

a dict of species and quality if multispecies is active

Type:

float or dict

property initial_setting

The initial setting for the link (if Active)

Type:

float

property initial_status

The initial status (Opened, Closed, Active) of the Link

Type:

LinkStatus

property link_type

the link type (read only)

Type:

str

property name

The link name (read-only)

Type:

str

property quality

(read-only) current simulated average link quality

Type:

float

property setting

(read-only) current simulated setting of the link

Type:

float

property start_node

The start node object.

Type:

Node

property start_node_name

The name of the start node (read only)

Type:

str

abstract property status

(abstract) current status of the link

Type:

LinkStatus

property tag

A tag or label for this link

Type:

str

property velocity

(read-only) current simulated velocity through the link

Type:

float

property vertices

A list of interior vertex points for network links, in the direction of start node to end node.

The vertices should be listed as a list of (x,y) tuples/lists when setting.