honeybee.boundarycondition module

Boundary Condition for Face, Aperture, Door.

class honeybee.boundarycondition.Ground[source]

Bases: honeybee.boundarycondition._BoundaryCondition

Ground boundary condition.

Parameters

data – A dictionary representation of the boundary condition.

ToString()

Overwrite .NET ToString.

classmethod from_dict(data)[source]

Initialize Ground BoundaryCondition from a dictionary.

to_dict()

Get the boundary condition as a dictionary.

property name

Get the name of the boundary condition (ie. ‘Outdoors’, ‘Ground’).

property sun_exposure_idf

Get a text string for sun exposure, which is write-able into an IDF.

property view_factor

Get the view factor to the ground.

property wind_exposure_idf

Get a text string for wind exposure, which is write-able into an IDF.

class honeybee.boundarycondition.Outdoors(sun_exposure=True, wind_exposure=True, view_factor=Autocalculate)[source]

Bases: honeybee.boundarycondition._BoundaryCondition

Outdoor boundary condition.

Parameters
  • sun_exposure – A boolean noting whether the boundary is exposed to sun. Default: True.

  • wind_exposure – A boolean noting whether the boundary is exposed to wind. Default: True.

  • view_factor – A number between 0 and 1 for the view factor to the ground. This input can also be an Autocalculate object to signify that the view factor automatically calculated. Default: autocalculate.

ToString()

Overwrite .NET ToString.

classmethod from_dict(data)[source]

Initialize Outdoors BoundaryCondition from a dictionary.

Parameters

data – A dictionary representation of the boundary condition.

to_dict(full=False)[source]

Get the boundary condition as a dictionary.

Parameters

full – Set to True to get the full dictionary which includes energy simulation specific keys such as sun_exposure, wind_exposure and view_factor. (Default: False).

property name

Get the name of the boundary condition (ie. ‘Outdoors’, ‘Ground’).

property sun_exposure

Get a boolean noting whether the boundary is exposed to sun.

property sun_exposure_idf

Get a text string for sun exposure, which is write-able into an IDF.

property view_factor

Get the view factor to the ground as a number or ‘autocalculate’.

property wind_exposure

Get a boolean noting whether the boundary is exposed to wind.

property wind_exposure_idf

Get a text string for wind exposure, which is write-able into an IDF.

class honeybee.boundarycondition.Surface(boundary_condition_objects, sub_face=False)[source]

Bases: honeybee.boundarycondition._BoundaryCondition

Boundary condition when an object is adjacent to another object.

ToString()

Overwrite .NET ToString.

classmethod from_dict(data, sub_face=False)[source]

Initialize Surface BoundaryCondition from a dictionary.

Parameters
  • data – A dictionary representation of the boundary condition.

  • sub_face – Boolean to note whether this boundary condition is applied to a sub-face (an Aperture or a Door) instead of a Face. Default: False.

classmethod from_other_object(other_object, sub_face=False)[source]

Initialize Surface boundary condition from an adjacent other object.

Parameters
  • other_object – Another object (Face, Aperture, Door) of the same type that this boundary condition is assigned. This other_object will be set as the adjacent object in this boundary condition.

  • sub_face – Boolean to note whether this boundary condition is applied to a sub-face (an Aperture or a Door) instead of a Face. Default: False.

to_dict()[source]

Get the boundary condition as a dictionary.

Parameters

full – Set to True to get the full dictionary which includes energy simulation specific keys such as sun_exposure, wind_exposure and view_factor. Default: False.

property boundary_condition_object

Get the identifier of the object adjacent to this one.

property boundary_condition_objects

Get a tuple of up to 3 object identifiers that are adjacent to this one.

The first object is always the one that is immediately adjacent and is of the same object type (Face, Aperture, Door). When this boundary condition is applied to a Face, the second object in the tuple will be the parent Room of the adjacent object. When the boundary condition is applied to a sub-face (Door or Aperture), the second object will be the parent Face of the sub-face and the third object will be the parent Room of the adjacent sub-face.

property name

Get the name of the boundary condition (ie. ‘Outdoors’, ‘Ground’).

property sun_exposure_idf

Get a text string for sun exposure, which is write-able into an IDF.

property view_factor

Get the view factor to the ground.

property wind_exposure_idf

Get a text string for wind exposure, which is write-able into an IDF.

honeybee.boundarycondition.get_bc_from_position(positions, ground_depth=0)[source]

Return a boundary condition based on the relationship to a ground plane.

Positions that are entirely at or below the ground_depth will get a Ground boundary condition. If there are any positions above the ground_depth, an Outdoors boundary condition will be returned.

Parameters
  • positions – A list of ladybug_geometry Point3D objects representing the vertices of an object.

  • ground_depth – The Z value above which positions are considered Outdoors instead of Ground.

Returns

Face type instance.