Link

class Link(model, linkid)

Link Methods.

Parameters:

• model (object) – Open Model Instance

• linkid (str) – Link ID

Examples:

>>> from pyswmm import Simulation, Links
>>>
>>> with Simulation('tests/data/model_weir_setting.inp') as sim:
...     c1c2 = Links(sim)["C1:C2"]
...     print(c1c2.flow)
...     for step in sim:
...         print(c1c2.flow)
0.0

Methods

is_conduit	Check if link is a Conduit Type.
is_orifice	Check if link is a Orifice Type.
is_outlet	Check if link is a Outlet Type.
is_pump	Check if link is a Pump Type.
is_weir	Check if link is a Weir Type.

Attributes

average_head_loss	Get/set Average Conduit Loss.
connections	Get link upstream and downstream node IDs.
current_setting	Get Link current setting.
depth	Get Link Results for Depth.
ds_xsection_area	Get Link Results for Downstream X-section Flow Area.
flow	Get Link Results for Flow.
flow_limit	Get/set link flow limit.
froude	Get Link Results for Froude.
initial_flow	Get/set Link Initial Flow.
inlet_head_loss	Get/set Inlet Head Loss.
inlet_node	Get link inlet node ID.
inlet_offset	Get/set Upstream Offset Depth.
linkid	Get Link ID.
outlet_head_loss	Get/set Outlet Head Loss.
outlet_node	Get link outlet node ID.
outlet_offset	Get/set Downstream Offset Depth.
pollut_quality	Get Current Water Quality Values for a Link.
reactor_quality	Get Current Water Quality Values for the mixed reactor inside a Link.
seepage_rate	Get/set Conduit Seepage Loss.
target_setting	Get/set Link Target Setting.
total_loading	Get Total Pollutant Loading Values for a Link.
ups_xsection_area	Get Link Results for Upstream X-section Flow Area.
volume	Get Link Results for Volume.