honeybee_energy.simulation.shadowcalculation module

Settings for the EnergyPlus Shadow Calculation.

class honeybee_energy.simulation.shadowcalculation.ShadowCalculation(solar_distribution='FullExteriorWithReflections', calculation_method='PolygonClipping', calculation_update_method='Periodic', calculation_frequency=30, maximum_figures=15000)[source]

Bases: object

Settings for the EnergyPlus Shadow Calculation.

Parameters

  • solar_distribution –

    Text desribing how EnergyPlus should treat beam solar radiation and reflectances from surfaces that strike the building surfaces. (Default: FullExteriorWithReflections). Choose from the following:

    • MinimalShadowing

    • FullExterior

    • FullInteriorAndExterior

    • FullExteriorWithReflections

    • FullInteriorAndExteriorWithReflections

  • calculation_method –

    Text noting whether CPU-based polygon clipping method or GPU-based pixel counting method should be used. For low numbers of shading surfaces (less than ~200), PolygonClipping requires less runtime than PixelCounting. However, PixelCounting runtime scales significantly better at higher numbers of shading surfaces. PixelCounting also has no limitations related to zone concavity when used with any “FullInterior” solar distribution options. (Default: PolygonClipping). Choose from the following:

    • PolygonClipping

    • PixelCounting

  • calculation_update_method –

    Text describing how often the solar and shading calculations are updated with respect to the flow of time in the simulation. (Default: Periodic). Choose from the following:

    • Periodic

    • Timestep

  • calculation_frequency – Integer for the number of days in each period for which a unique shadow calculation will be performed. This field is only used if the Periodic method is used in the previous field. (Default: 30).

  • maximum_figures – Integer for the number of figures used in shadow overlaps. (Default: 15000).

Properties:

  • solar_distribution

  • calculation_method

  • calculation_update_method

  • calculation_frequency

  • maximum_figures

ToString()[source]

Overwrite .NET ToString.

duplicate()[source]

Get a copy of this object.

classmethod from_dict(data)[source]

Create a ShadowCalculation object from a dictionary.

Parameters

data – A ShadowCalculation dictionary in following the format below.

{
"type": "ShadowCalculation",
"solar_distribution": 'FullInteriorAndExteriorWithReflections',
"calculation_method": 'PolygonClipping',
"calculation_update_method": 'Periodic',
"calculation_frequency": 30,
"maximum_figures": 15000
}
classmethod from_idf(idf_string, solar_distribution='FullExteriorWithReflections')[source]

Create a ShadowCalculation object from an EnergyPlus IDF text string.

Parameters

  • idf_string – A text string fully describing an EnergyPlus ShadowCalculation definition.

  • solar_distribution – Text desribing how EnergyPlus should treat beam solar radiation and reflectances from surfaces that strike the building surfaces.

to_dict()[source]

ShadowCalculation dictionary representation.

to_idf()[source]

Get an EnergyPlus string representation of the ShadowCalculation.

CALCULATION_METHODS = ('PolygonClipping', 'PixelCounting')
CALCULATION_UPDATE_METHODS = ('Periodic', 'Timestep')
SOLAR_DISTRIBUTIONS = ('MinimalShadowing', 'FullExterior', 'FullInteriorAndExterior', 'FullExteriorWithReflections', 'FullInteriorAndExteriorWithReflections')
property calculation_frequency

Get or set a integer for the number of days with unique shadow calculations.

property calculation_method

Get or set text for whether CPU-based or GPU-based methods should be used.

Choose from the options below:

  • PolygonClipping

  • PixelCounting

property calculation_update_method

Get or set text for how often the solar and shading calculations are updated.

Choose from the options below:

  • Periodic

  • Timestep

property maximum_figures

Get or set a integer for the number of figures used in shadow overlaps.

property solar_distribution

Get or set text for how solar reflectances from surfaces should be treated.

Choose from the options below:

  • MinimalShadowing

  • FullExterior

  • FullInteriorAndExterior

  • FullExteriorWithReflections

  • FullInteriorAndExteriorWithReflections