honeybee_plus.hbfensurface module

class honeybee_plus.hbfensurface.HBFenSurface(name, sorted_points=None, is_name_set_by_user=False, rad_properties=None, ep_properties=None, states=None)[source]

Bases: honeybee_plus._hbanalysissurface.HBAnalysisSurface

Honeybee fenestration surface.

Parameters

  • name – A unique string for surface name

  • sorted_points – A list of 3 points or more as tuple or list with three items (x, y, z). Points should be sorted. This class won’t sort the points. If surfaces has multiple subsurfaces you can pass lists of point lists to this function (e.g. ((0, 0, 0), (10, 0, 0), (0, 10, 0))).

  • is_name_set_by_user – If you want the name to be changed by honeybee any case set is_name_set_by_user to True. Default is set to False which let Honeybee to rename the surface in cases like creating a newHBZone.

  • rad_properties – Radiance properties for this surface. If empty default RADProperties will be assigned to surface by Honeybee.

  • ep_properties – EnergyPlus properties for this surface. If empty default ep_properties will be assigned to surface by Honeybee.

Usage:

from honeybee_plus.hbsurface import HBSurface from honeybee_plus.hbfensurface import HBFenSurface

# create a surface pts = [(0, 0, 0), (10, 0, 0), (0, 0, 10)] hbsrf = HBSurface(“001”, pts, surface_type=None, is_name_set_by_user=True)

glzpts = [(1, 0, 1), (8, 0, 1), (1, 0, 8)] glzsrf = HBFenSurface(“glz_001”, glzpts)

# add fenestration surface to hb surface hbsrf.add_fenestration_surface(glzsrf)

# get full definiion of the surface including the fenestration print(hbsrf.to_rad_string(include_materials=True))

# save the definiion to a .rad file hbsrf.write_rad_file(r”c:/ladybug/triangle.rad”, include_materials=True)

classmethod from_ep_string(ep_string)[source]

Init Honeybee fenestration surface from an ep_string.

Parameters

ep_string – The full ep_string for an EnergyPlus fenestration.

classmethod from_geometry(name, geometry, is_name_set_by_user=False, rad_properties=None, ep_properties=None, states=None, group=False)[source]

Create a honeybee fenestration surface from Grasshopper geometry.

property geometry

Return geometry.

property isHBFenSurface

Return True for HBFenSurface.

property is_child_surface

Return True if Honeybee surface is Fenestration Surface.

property is_created_from_geometry

Return True if the surface is created from a geometry not points.

property parent

Return parent surface for this fenestration surface.

property profile

Get profile curve of this surface.