Pump.target_setting

property Pump.target_setting

Get/set Link Target Setting.

If Simulation is not running this method will raise a warning and return 0.

Returns:

Parameter Value

Return type:

float

Examples:

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

Setting the Value

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