Storage.flooding

property Storage.flooding

Get Node Results for Flooding Rate.

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, Nodes
>>>
>>> with Simulation('tests/data/model_weir_setting.inp') as sim:
...     j1 = Nodes(sim)["J1"]
...     for step in sim:
...         print(j1.flooding)
0
0
0.01
0
0