lidlayers module

class pyswmm.lidlayers.Drain(model, lidcontrol)[source]

Bases: object

Layer Parameter Setter Before Sim Setter During Sim
Drain coefficient enabled enabled
Drain exponent enabled enabled
Drain offset enabled enabled
Drain delay enabled enabled
Drain open_head enabled enabled
Drain close_head enabled enabled
close_head

Get lid control drain layer head when drain closes (ft)

Returns:Parameter Value
Return type:double
coefficient

Get lid control drain layer underdrain flow coefficient

Returns:Parameter Value
Return type:double
delay

Get lid control drain layer rain barrel drain delay time (sec)

Returns:Parameter Value
Return type:double
exponent

Get lid control drain layer underdrain head exponent

Returns:Parameter Value
Return type:double
offset

Get lid control drain layer offset height of underdrain

Returns:Parameter Value
Return type:double
open_head

Get lid control drain layer head when drain opens (ft)

Returns:Parameter Value
Return type:double
class pyswmm.lidlayers.DrainMat(model, lidcontrol)[source]

Bases: object

Layer Parameter Setter Before Sim Setter During Sim
DrainMat thickness enabled disabled
DrainMat void_fraction enabled disabled
DrainMat roughness enabled enabled
DrainMat alpha enabled disabled
alpha

Get lid control drainmat layer slope/roughness term in Manning equation

Returns:Parameter Value
Return type:double
roughness

Get lid control drainmat layer Mannings n for green roof drainage mats

Returns:Parameter Value
Return type:double
thickness

Get lid control drainmat layer thickness

Returns:Parameter Value
Return type:double
void_fraction

Get lid control drainmat layer void volume / total volume

Returns:Parameter Value
Return type:double
class pyswmm.lidlayers.Pavement(model, lidcontrol)[source]

Bases: object

Layer Parameter Setter Before Sim Setter During Sim
Pavement thickness enabled disabled
Pavement void_fraction enabled disabled
Pavement impervious_fraction enabled disabled
Pavement k_saturated enabled disabled
Pavement clog_factor enabled enabled
Pavement regeneration enabled disabled
Pavement regeneration_degree enabled disabled
clog_factor

Get lid control pavement layer clogging factor

Returns:Parameter Value
Return type:double
impervious_fraction

Get lid control pavement layer impervious area fraction

Returns:Parameter Value
Return type:double
k_saturated

Get lid control pavement layer permeability

Returns:Parameter Value
Return type:double
regeneration

Get lid control pavement layer clogging regeneration interval (days)

Returns:Parameter Value
Return type:double
regeneration_degree

Get lid control pavement layer clogging regeneration degree

Returns:Parameter Value
Return type:double
thickness

Get lid control pavement layer thickness

Returns:Parameter Value
Return type:double
void_fraction

Get lid control pavement layer void volume / total volume

Returns:Parameter Value
Return type:double
class pyswmm.lidlayers.Soil(model, lidcontrol)[source]

Bases: object

Layer Parameter Setter Before Sim Setter During Sim
Soil thickness enabled disabled
Soil porosity enabled disabled
Soil field_capacity enabled disabled
Soil wilting_point enabled disabled
Soil k_saturated enabled disabled
Soil k_slope enabled disabled
Soil suction_head enabled disabled
field_capacity

Get lid control soil layer field capacity

Returns:Parameter Value
Return type:double
k_saturated

Get lid control soil layer saturated hydraulic conductivity

Returns:Parameter Value
Return type:double
k_slope

Get lid control soil layer slope of log(k) v. moisture content curve

Returns:Parameter Value
Return type:double
porosity

Get lid control soil layer void volume / total volume

Returns:Parameter Value
Return type:double
suction_head

Get lid control soil layer suction head at wetting front

Returns:Parameter Value
Return type:double
thickness

Get lid control soil layer thickness

Returns:Parameter Value
Return type:double
wilting_point

Get lid control soil layer wilting point

Returns:Parameter Value
Return type:double
class pyswmm.lidlayers.Storage(model, lidcontrol)[source]

Bases: object

Layer Parameter Setter Before Sim Setter During Sim
Storage thickness enabled disabled
Storage void_fraction enabled disabled
Storage k_saturated enabled disabled
Storage clog_factor enabled enabled
clog_factor

Get lid control storage layer clogging factor

Returns:Parameter Value
Return type:double
k_saturated

Get lid control storage layer saturated hydraulic conductivity

Returns:Parameter Value
Return type:double
thickness

Get lid control storage layer thickness

Returns:Parameter Value
Return type:double
void_fraction

Get lid control storage layer void volume / total volume

Returns:Parameter Value
Return type:double
class pyswmm.lidlayers.Surface(model, lidcontrol)[source]

Bases: object

Layer Parameter Setter Before Sim Setter During Sim
Surface thickness enabled disabled
Surface void_fraction enabled disabled
Surface roughness enabled enabled
Surface slope enabled disabled
Surface side_slope enabled disabled
Surface alpha enabled disabled
alpha

Get lid control surface layer swale side slope (run/rise)

Returns:Parameter Value
Return type:double
roughness

Get lid control surface layer surface Mannings n

Returns:Parameter Value
Return type:double
side_slope

Get lid control surface layer swale side slope (run/rise)

Returns:Parameter Value
Return type:double
slope

Get lid control surface layer land surface slope (fraction)

Returns:Parameter Value
Return type:double
thickness

Get lid control surface layer thickness

Returns:Parameter Value
Return type:double
void_fraction

Get lid control surface layer available fraction of storage volume

Returns:Parameter Value
Return type:double