honeybee_plus.hbzone module¶
-
class
honeybee_plus.hbzone.
HBZone
(name=None, origin=(0, 0, 0), geometry_rules=None, building_program=None, zone_program=None, is_conditioned=True)[source]¶ Bases:
honeybee_plus.hbobject.HBObject
Honeybee base class.
- Parameters
name – Unique name for this zone.
origin – Zone origin point (default: 0, 0, 0)
geometry_rules – EnergyPlus geometry_rules. (default: “LowerLeftCorner”; “CounterClockWise”; “Absolute”)
building_program – HBZone building program.
zone_program – Specific program for this zone from the available building programs.
is_conditioned – A boolean that indicates if the zone is conditioned. (default: True)
-
property
ceilings
¶ Get ceilings surfaces.
-
property
children_surfaces
¶ Get list of children Surfaces for this zone.
-
property
floors
¶ Get floor surfaces.
-
classmethod
from_ep_string
(ep_string, geometry_rules=None, building_program=None, zone_program=None, is_conditioned=True)[source]¶ Init Honeybee zone from an ep_string.
- Parameters
ep_string – The full ep_string for an EnergyPlus Zone.
-
property
geometry
¶ Return zone geometry for visualization.
-
property
geometry_rules
¶ Get and set global geometry rules for this zone.
-
property
isHBZone
¶ Return True if a HBZone.
-
property
is_relative_system
¶ Return True if coordinate system is relative.
To find the absolute coordinate values in a relative system you should add surface coordinates to zone origin.
-
property
name
¶ Zone name
-
property
origin
¶ origin of the zone.
-
property
profile
¶ Return zone profile for visualization.
-
property
radiance_materials
¶ Get list of Radiance materials for zone including fenestration.
-
property
surfaces
¶ Get list of HBSurfaces for this zone.
-
to_rad_file
()[source]¶ Return a RadFile like object.
Use this method to get easy access to radiance geometries and materials for this zone. For a full definition as a string use to_rad_string method.
-
to_rad_string
(mode=1, include_materials=False, flipped=False, blacked=False)[source]¶ Get full radiance file as a string.
- Parameters
mode – An integer 0-2 (Default: 1) 0 - Do not include children surfaces. 1 - Include children surfaces. 2 - Only children surfaces.
include_materials – Set to False if you only want the geometry definition (default:True).
flipped – Flip the surface geometry.
blacked – If True materials will all be set to plastic 0 0 0 0 0.
-
property
walls
¶ Get wall surfaces.
-
write_rad_file
(file_path, mode=1, include_materials=False, flipped=False, blacked=False)[source]¶ Write Radiance definition for this surface to a file.
- Parameters
filepath – Full filepath (e.g c:/ladybug/geo.rad).
mode – An integer 0-2 (Default: 1) 0 - Do not include children surfaces. 1 - Include children surfaces. 2 - Only children surfaces.
include_materials – Set to False if you only want the geometry definition (default:True).
flipped – Flip the surface geometry.
blacked – If True materials will all be set to plastic 0 0 0 0 0.