dragonfly_uwg.simulation.vegetation module

class dragonfly_uwg.simulation.vegetation.VegetationParameter(vegetation_albedo=0.25, start_month=Autocalculate, end_month=Autocalculate, tree_latent_fraction=0.7, grass_latent_fraction=0.5)[source]

Bases: object

Represents the behavior of vegetation within an urban area.

Parameters:

  • vegetation_albedo – A number between 0 and 1 that represents the ratio of reflected radiation from vegetated surfaces to incident radiation upon them. (Default: 0.25)

  • start_month – An integer from 1 to 12 that represents the month at which vegetation evapostranspiration begins (leaves come out). If Autocalculate, the month will be automatically determined by analyzing the epw to see which months have an average monthly temperature above 10C. (Default: autocalculate).

  • end_month – An integer from 1 to 12 that represents the month at which vegetation evapostranspiration ends (leaves fall off). If Autocalculate, the month will be automatically determined by analyzing the epw to see which months have an average monthly temperature above 10C. (Default: autocalculate).

  • tree_latent_fraction – A number between 0 and 1 that represents the the fraction of absorbed solar energy by trees that is given off as latent heat (evapotranspiration). Currently, this does not affect the moisture balance in the uwg but it will affect the temperature. (Default: 0.7).

  • grass_latent_fraction – A number between 0 and 1 that represents the the fraction of absorbed solar energy by grass that is given off as latent heat (evapotranspiration). Currently, this does not affect the moisture balance in the uwg but it will affect the temperature. (Default: 0.5).

ToString()[source]

Overwrite .NET ToString method.

duplicate()[source]

Get a copy of this object.

classmethod from_dict(data)[source]

Create a VegetationParameter object from a dictionary

Parameters:

data – A dictionary representation of an VegetationParameter object in the format below.

{
'type': 'VegetationParameter',
'vegetation_albedo': 0.3,  # float between 0 and 1
'start_month': 5,  # int between 1 and 12
'end_month': 10,  # int between 1 and 12
'tree_latent_fraction': 0.75, # float between 0 and 1
'grass_latent_fraction': 0.45  # float between 0 and 1
}
to_dict()[source]

Get VegetationParameter dictionary.

property end_month

Get or set an integer (or Autocalculate) for the vegetation end month.

property grass_latent_fraction

Get or set a number for the grass latent fraction.

property start_month

Get or set an integer (or Autocalculate) for the vegetation start month.

property tree_latent_fraction

Get or set a number for the tree latent fraction.

property vegetation_albedo

Get or set a fractional number for the vegetation albedo.