honeybee_radiance.dynamic.multiphase module¶
Functions for auto-assigning aperture groups for multiphase studies.
- honeybee_radiance.dynamic.multiphase.aperture_view_factor(project_folder, apertures, size=0.2, ambient_division=1000, receiver='rflux_sky.sky', octree='scene.oct', calc_folder='aperture_grouping')[source]¶
Calculates the view factor for each aperture by sensor points.
- honeybee_radiance.dynamic.multiphase.aperture_view_factor_postprocess(mtx_file, ap_dict, room_apertures, room_based=True)[source]¶
- honeybee_radiance.dynamic.multiphase.automatic_aperture_grouping(model, octree=None, rflux_sky=None, size=0.2, threshold=0.001, ambient_division=1000, room_based=True, view_factor_or_orientation=True, vertical_tolerance=None, states=None, working_folder=None)[source]¶
Automatically calculate aperture groups for exterior apertures.
This function calculates view factor from apertures to sky patches (rfluxmtx). Each aperture is represented by a sensor grid, and the view factor for the whole aperture is the average of the grid. The apertures are grouped based on the threshold.
- Parameters:
model – A Honeybee Model object to which aperture groups will be assigned.
octree – Optional path to octree file to be used for view factor calculation. If None, the octree will be created from the model.
rflux_sky – Optional path to an rflux sky file. If None, the rflux sky file will be auto-created.
size – Aperture grid size. A lower number will give a finer grid and more accurate results but the calculation time will increase. (Default: 0.2).
threshold – A number that determines if two apertures/aperture groups can be clustered. A lower number is more accurate but will also increase the number of aperture groups. (Default: 0.001).
ambient_division – Number of ambient divisions (-ad) for view factor calculation in rfluxmtx. Increasing the number will give more accurate results but also increase the calculation time. (Default: 1000).
room_based – Boolean to note whether the apertures should be grouped on a room basis. If grouped on a room basis apertures from different room cannot be in the same group. (Default: False).
view_factor_or_orientation – Boolean to note whether the apertures should be grouped by calculating view factors for the apertures to a discretized sky (True) or simply by the normal orientation of the apertures (False). (Default: False).
vertical_tolerance – A float value for vertical tolerance between two apertures. If the vertical distance between two apertures is larger than this tolerance the apertures cannot be grouped. If None, the vertical grouping will be skipped. (Default: None).
states – An optional list of Honeybee State objects to be applied to all the generated groups. These states should be ordered based on how they will be switched on. The first state is the default state and, typically, higher states are more shaded. If the objects in the group have no states, the modifiers already assigned the apertures will be used for all states.
working_folder – Path to a folder into which the files be written. If None, the files will be written into a folder called aperture_groups within the default simulation folder.
- Returns:
A Model with Aperture groups automatically assigned.
- honeybee_radiance.dynamic.multiphase.cluster_orientation(room_apertures, apertures, room_based=True, vertical_tolerance=None)[source]¶