lidgroups module

class pyswmm.lidgroups.LidGroup(model, subcatchmentid)[source]

Bases: object

flow_to_pervious

Get lid group total flow sent to pervious area

Returns:Parameter Value
Return type:double
new_drain_flow

Get lid group total drain flow in current period

Returns:Parameter Value
Return type:double
next()
old_drain_flow

Get lid group total drain flow in pervious period

Returns:Parameter Value
Return type:double
pervious_area

Get lid group amount of pervious area

Returns:Parameter Value
Return type:double
class pyswmm.lidgroups.LidGroups(model)[source]

Bases: object

LidGroups Iterator Methods.

Parameters:model (object) – Open Model Instance
next()
class pyswmm.lidgroups.LidUnit(model, subcatchmentid, lidid)[source]

Bases: object

Lid Unit Methods.

Parameters:
  • model (object) – Open Model Instance
  • subcatchmentid (str) – Subcatchment ID
  • lidid (str) – Lid unit ID

Lid Unit Parameters

Parameter Getter Setter Before Sim Setter During Sim
subcatchment enabled disabled disabled
lid_control enabled disabled disabled
unit_area enabled enabled disabled
full_width enabled enabled disabled
initial_saturation enabled enabled disabled
from_impervious enabled enabled disabled
from_pervious enabled enabled disabled
index enabled enabled disabled
number enabled enabled disabled
to_pervious enabled enabled disabled
drain_subcatchment enabled enabled enabled
drain_node enabled enabled enabled
drain_node

Get lid drain to node index Negative if no recieving node

Returns:Parameter Value
Return type:int
drain_subcatchment

Get lid drain to subcatchment index Negative if no recieving subcatchment

Returns:Parameter Value
Return type:int
dry_time

Get lid time since last rainfall (sec)

Returns:Parameter Value
Return type:double
evaporation

Get lid current evaporation rate

Returns:Parameter Value
Return type:double
from_impervious

Get lid fraction of impervious area runoff treated

Returns:Parameter Value
Return type:double
from_pervious

Get lid fraction of pervious area runoff treated

Returns:Parameter Value
Return type:double
full_width

Get lid unit full top width.

Returns:Parameter Value
Return type:double
index

Get lid control index

Returns:Parameter Value
Return type:int
initial_saturation

Get lid initial saturation of soil and storage layers.

Returns:Parameter Value
Return type:double
lid_control
native_infiltration

Get lid native infilration rate limit

Returns:Parameter Value
Return type:double
new_drain_flow

Get lid current drain flow

Returns:Parameter Value
Return type:double
number

Get lid number of replicate units

Returns:Parameter Value
Return type:int
old_drain_flow

Get lid pervious drain flow

Returns:Parameter Value
Return type:double
subcatchment
to_pervious
Get lid to pervious area (1 if outflow sent to pervious area)
(0 if not)
Returns:Parameter Value
Return type:int
unit_area

Get lid unit area.

Returns:Parameter Value
Return type:double