honeybee_plus.surfaceproperties module¶

Surface Properties.

A class that contains both radiance and energyplus properties which can be applied to a surface or a list of honeybee surfaces.

class honeybee_plus.surfaceproperties.SurfaceProperties(surface_type=None, rad_properties=None, ep_properties=None)[source]¶

Bases: object

Surface data for a single state.

This class is useful to define several states for one or a group of HBSurfaces. Each state can has a different material and add additional geometry to the scene. You can add the states to each HBSurface using HBSurface.addState.

surface_type¶: A honeybee surface type (Default: surfacetype.Wall).

rad_properties¶: Radiance properties for this surface. If empty default RADProperties will be assigned based on surface type once assigned to a surface.

ep_properties¶: EnergyPlus properties for this surface. If empty default ep_properties will be assigned based on surface type once assigned to a surface.

ToString()[source]¶: Overwrite .NET ToString method.

isSurfaceProperties()[source]¶: Return True for states.

rad_material_from_type()[source]¶: Get default radiance material for the surface type.

property radiance_properties¶: Get and set Radiance properties.

property surface_type¶: Get and set Surface Type.

class honeybee_plus.surfaceproperties.SurfaceState(name, surface_properties=None, surfaces=None)[source]¶

Bases: object

A HBSurface State.

A state includes surface data for a single state which includes SurfaceProperties and optional additional HBSurfaces.

This class is useful to define several states for one or a group of HBSurfaces. Each state can have different material and add additional geometry to the scene. You can add the states to a HBSurface using HBSurface.addState.

Both Attributes are optional but at least one of them should be provided to make the state meaningful.

name¶: Name as a string.

surface_properties¶: An instance of SurfaceProperties (Default: None).

surfaces¶: A list of HBSurfaces to be added to the scene. For multi-phase daylight simulation hb_surfaces can only be located outside the room (Default: None).

ToString()[source]¶: Overwrite .NET ToString method.

property isSurfaceState¶: Return True if a SurfaceState.

property name¶: The name of this state.

property radiance_black_material¶: Get Radiance black material from SurfaceProperties.

property radiance_material¶: Get Radiance material from SurfaceProperties.

radiance_materials(blacked=False, to_rad_string=False)[source]¶: Get the full list of materials for surfaces.

property radiance_properties¶: Get Radiance material from SurfaceProperties.

property surface_properties¶: SurfaceProperties for this state.

property surfaces¶

to_rad_string(mode=1, include_materials=False, flipped=False, blacked=False)[source]¶

Get surfaces as a RadFile. Use str(to_rad_string) to get the full str.

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.