# Source code for honeybee.room

```
# coding: utf-8
"""Honeybee Room."""
from __future__ import division
from ._basewithshade import _BaseWithShade
from .typing import float_in_range, int_in_range, valid_string, clean_string, \
invalid_dict_error
from .properties import RoomProperties
from .face import Face
from .facetype import AirBoundary, get_type_from_normal, Wall, Floor, RoofCeiling
from .boundarycondition import get_bc_from_position, Outdoors, Ground, Surface, \
boundary_conditions
from honeybee.orientation import angles_from_num_orient, orient_index
import honeybee.writer.room as writer
from ladybug_geometry.geometry2d.pointvector import Vector2D
from ladybug_geometry.geometry3d.pointvector import Vector3D, Point3D
from ladybug_geometry.geometry3d.ray import Ray3D
from ladybug_geometry.geometry3d.plane import Plane
from ladybug_geometry.geometry3d.mesh import Mesh3D
from ladybug_geometry.geometry3d.polyface import Polyface3D
import math
[docs]class Room(_BaseWithShade):
"""A volume enclosed by faces, representing a single room or space.
Note that, if zero is input for tolerance and angle_tolerance, no checks
will be performed to determine whether the room is a closed volume
and no attempt will be made to flip faces in the event that they are not
facing outward from the room volume. As such, an input tolerance of 0
is intended for workflows where the solidity of the room volume has been
evaluated elsewhere.
Args:
identifier: Text string for a unique Room ID. Must be < 100 characters and
not contain any spaces or special characters.
faces: A list or tuple of honeybee Face objects that together form the
closed volume of a room.
tolerance: The maximum difference between x, y, and z values
at which vertices of adjacent faces are considered equivalent. This is
used in determining whether the faces form a closed volume. Default
is 0, which makes no attempt to evaluate whether the Room volume
is closed.
angle_tolerance: The max angle difference in degrees that vertices are
allowed to differ from one another in order to consider them colinear.
Default is 0, which makes no attempt to evaluate whether the Room
volume is closed.
Properties:
* identifier
* display_name
* faces
* multiplier
* story
* exclude_floor_area
* indoor_furniture
* indoor_shades
* outdoor_shades
* geometry
* center
* min
* max
* volume
* floor_area
* exposed_area
* exterior_wall_area
* exterior_aperture_area
* exterior_wall_aperture_area
* exterior_skylight_aperture_area
* average_floor_height
* user_data
"""
__slots__ = ('_geometry', '_faces', '_multiplier', '_story', '_exclude_floor_area')
def __init__(self, identifier, faces, tolerance=0, angle_tolerance=0):
"""Initialize Room."""
_BaseWithShade.__init__(self, identifier) # process the identifier
# process the zone volume geometry
if not isinstance(faces, tuple):
faces = tuple(faces)
for face in faces:
assert isinstance(face, Face), \
'Expected honeybee Face. Got {}'.format(type(face))
face._parent = self
if tolerance == 0:
self._faces = faces
self._geometry = None # calculated later from faces or added by classmethods
else:
# try to get a closed volume between the faces
room_polyface = Polyface3D.from_faces(
tuple(face.geometry for face in faces), tolerance)
if not room_polyface.is_solid and angle_tolerance != 0:
ang_tol = math.radians(angle_tolerance)
room_polyface = room_polyface.merge_overlapping_edges(tolerance, ang_tol)
# replace honeybee face geometry with versions that are facing outwards
if room_polyface.is_solid:
for i, correct_face3d in enumerate(room_polyface.faces):
face = faces[i]
norm_init = face._geometry.normal
face._geometry = correct_face3d
if face.has_sub_faces: # flip sub-faces to align with parent Face
if norm_init.angle(face._geometry.normal) > (math.pi / 2):
for ap in face._apertures:
ap._geometry = ap._geometry.flip()
for dr in face._doors:
dr._geometry = dr._geometry.flip()
self._faces = faces
self._geometry = room_polyface
self._multiplier = 1 # default value that can be overridden later
self._story = None # default value that can be overridden later
self._exclude_floor_area = False # default value that can be overridden later
self._properties = RoomProperties(self) # properties for extensions
[docs] @classmethod
def from_dict(cls, data, tolerance=0, angle_tolerance=0):
"""Initialize an Room from a dictionary.
Args:
data: A dictionary representation of a Room object.
tolerance: The maximum difference between x, y, and z values
at which vertices of adjacent faces are considered equivalent. This is
used in determining whether the faces form a closed volume. Default
is 0, which makes no attempt to evaluate whether the Room volume
is closed.
angle_tolerance: The max angle difference in degrees that vertices are
allowed to differ from one another in order to consider them colinear.
Default is 0, which makes no attempt to evaluate whether the Room
volume is closed.
"""
try:
# check the type of dictionary
assert data['type'] == 'Room', 'Expected Room dictionary. ' \
'Got {}.'.format(data['type'])
# create the room object and assing properties
faces = []
for f_dict in data['faces']:
try:
faces.append(Face.from_dict(f_dict))
except Exception as e:
invalid_dict_error(f_dict, e)
room = cls(data['identifier'], faces, tolerance, angle_tolerance)
if 'display_name' in data and data['display_name'] is not None:
room.display_name = data['display_name']
if 'user_data' in data and data['user_data'] is not None:
room.user_data = data['user_data']
if 'multiplier' in data and data['multiplier'] is not None:
room.multiplier = data['multiplier']
if 'story' in data and data['story'] is not None:
room.story = data['story']
if 'exclude_floor_area' in data and data['exclude_floor_area'] is not None:
room.exclude_floor_area = data['exclude_floor_area']
room._recover_shades_from_dict(data)
if data['properties']['type'] == 'RoomProperties':
room.properties._load_extension_attr_from_dict(data['properties'])
return room
except Exception as e:
cls._from_dict_error_message(data, e)
[docs] @classmethod
def from_polyface3d(cls, identifier, polyface, roof_angle=60, floor_angle=130,
ground_depth=0):
"""Initialize a Room from a ladybug_geometry Polyface3D object.
Args:
identifier: Text string for a unique Room ID. Must be < 100 characters and
not contain any spaces or special characters.
polyface: A ladybug_geometry Polyface3D object representing the closed
volume of a room. The Polyface3D.is_solid property can be used to
determine whether the polyface is a closed solid before input here.
roof_angle: A number between 0 and 90 to set the angle from the horizontal
plane below which faces will be considered roofs instead of
walls. 90 indicates that all vertical faces are roofs and 0
indicates that all horizontal faces are walls. (Default: 60,
recommended by the ASHRAE 90.1 standard).
floor_angle: A number between 90 and 180 to set the angle from the horizontal
plane above which faces will be considered floors instead of
walls. 180 indicates that all vertical faces are floors and 0
indicates that all horizontal faces are walls. (Default: 130,
recommended by the ASHRAE 90.1 standard).
ground_depth: The Z value above which faces are considered Outdoors
instead of Ground. Faces will have a Ground boundary condition if
all of their vertices lie at or below this value. Default: 0.
"""
assert isinstance(polyface, Polyface3D), \
'Expected ladybug_geometry Polyface3D. Got {}'.format(type(polyface))
faces = []
for i, face in enumerate(polyface.faces):
faces.append(Face('{}..Face{}'.format(identifier, i), face,
get_type_from_normal(face.normal, roof_angle, floor_angle),
get_bc_from_position(face.boundary, ground_depth)))
room = cls(identifier, faces)
room._geometry = polyface
return room
[docs] @classmethod
def from_box(cls, identifier, width=3.0, depth=6.0, height=3.2,
orientation_angle=0, origin=Point3D(0, 0, 0)):
"""Initialize a Room from parameters describing a box.
The resulting faces of the room will always be ordered as follows:
(Bottom, Front, Right, Back, Left, Top) where the front is facing the
cardinal direction of the orientation_angle.
Args:
identifier: Text string for a unique Room ID. Must be < 100 characters and
not contain any spaces or special characters.
width: Number for the width of the box (in the X direction). Default: 3.0.
depth: Number for the depth of the box (in the Y direction). Default: 6.0.
height: Number for the height of the box (in the Z direction). Default: 3.2.
orientation_angle: A number between 0 and 360 for the clockwise
orientation of the box in degrees.
(0 = North, 90 = East, 180 = South, 270 = West)
origin: A ladybug_geometry Point3D for the origin of the room.
"""
# create a box Polyface3D
x_axis = Vector3D(1, 0, 0)
if orientation_angle != 0:
angle = -1 * math.radians(
float_in_range(orientation_angle, 0, 360, 'orientation_angle'))
x_axis = x_axis.rotate_xy(angle)
base_plane = Plane(Vector3D(0, 0, 1), origin, x_axis)
polyface = Polyface3D.from_box(width, depth, height, base_plane)
# create the honeybee Faces
directions = ('Bottom', 'Front', 'Right', 'Back', 'Left', 'Top')
faces = []
for face, dir in zip(polyface.faces, directions):
faces.append(Face('{}_{}'.format(identifier, dir), face,
get_type_from_normal(face.normal),
get_bc_from_position(face.boundary)))
room = cls(identifier, faces)
room._geometry = polyface
return room
@property
def faces(self):
"""Get a tuple of all honeybee Faces making up this room volume."""
return self._faces
@property
def multiplier(self):
"""Get or set an integer noting how many times this Room is repeated.
Multipliers are used to speed up the calculation when similar Rooms are
repeated more than once. Essentially, a given simulation with the
Room is run once and then the result is multiplied by the multiplier.
This means that the "repetition" isn't in a particular direction (it's
essentially in the exact same location) and this comes with some
inaccuracy. However, this error might not be too large if the Rooms
are similar enough and it can often be worth it since it can greatly
speed up the calculation.
"""
return self._multiplier
@multiplier.setter
def multiplier(self, value):
self._multiplier = int_in_range(value, 1, input_name='room multiplier')
@property
def story(self):
"""Get or set text for the story identifier to which this Room belongs.
Rooms sharing the same story identifier are considered part of the same
story in a Model. Note that the story identifier has no character
restrictions much like display_name.
"""
return self._story
@story.setter
def story(self, value):
if value is not None:
try:
self._story = str(value)
except UnicodeEncodeError: # Python 2 machine lacking the character set
self._story = value # keep it as unicode
else:
self._story = value
@property
def exclude_floor_area(self):
"""Get or set a boolean for whether the floor area contributes to the Model.
Note that this will not affect the floor_area property of this Room but
it will ensure the Room's floor area is excluded from any calculations
when the Room is part of a Model.
"""
return self._exclude_floor_area
@exclude_floor_area.setter
def exclude_floor_area(self, value):
self._exclude_floor_area = bool(value)
@property
def indoor_furniture(self):
"""Array of all indoor furniture Shade objects assigned to this Room.
Note that this property is identical to the indoor_shades property but
it is provided here under an alternate name to make it clear that indoor
furniture objects should be added here to the Room.
"""
return tuple(self._indoor_shades)
@property
def geometry(self):
"""Get a ladybug_geometry Polyface3D object representing the room."""
if self._geometry is None:
self._geometry = Polyface3D.from_faces(
tuple(face.geometry for face in self._faces), 0) # use 0 tolerance
return self._geometry
@property
def center(self):
"""Get a ladybug_geometry Point3D for the center of the room.
Note that this is the center of the bounding box around the room Polyface
geometry and not the volume centroid. Also note that shades assigned to
this room are not included in this center calculation.
"""
return self.geometry.center
@property
def min(self):
"""Get a Point3D for the minimum of the bounding box around the object.
This includes any shades assigned to this object or its children.
"""
all_geo = self._outdoor_shades + self._indoor_shades
all_geo.extend(self._faces)
return self._calculate_min(all_geo)
@property
def max(self):
"""Get a Point3D for the maximum of the bounding box around the object.
This includes any shades assigned to this object or its children.
"""
all_geo = self._outdoor_shades + self._indoor_shades
all_geo.extend(self._faces)
return self._calculate_max(all_geo)
@property
def volume(self):
"""Get the volume of the room.
Note that, if this room faces do not form a closed solid the value of this
property will not be accurate.
"""
return self.geometry.volume
@property
def floor_area(self):
"""Get the combined area of all room floor faces."""
return sum([face.area for face in self._faces if isinstance(face.type, Floor)])
@property
def exposed_area(self):
"""Get the combined area of all room faces with outdoor boundary conditions.
Useful for estimating infiltration, often expressed as a flow per
unit exposed envelope area.
"""
return sum([face.area for face in self._faces if
isinstance(face.boundary_condition, Outdoors)])
@property
def exterior_wall_area(self):
"""Get the combined area of all exterior walls on the room.
This is NOT the area of the wall's punched_geometry and it includes BOTH
the area of opaque and transparent parts of the walls.
"""
wall_areas = 0
for f in self._faces:
if isinstance(f.boundary_condition, Outdoors) and isinstance(f.type, Wall):
wall_areas += f.area
return wall_areas
@property
def exterior_roof_area(self):
"""Get the combined area of all exterior roofs on the room.
This is NOT the area of the roof's punched_geometry and it includes BOTH
the area of opaque and transparent parts of the roofs.
"""
wall_areas = 0
for f in self._faces:
if isinstance(f.boundary_condition, Outdoors) and \
isinstance(f.type, RoofCeiling):
wall_areas += f.area
return wall_areas
@property
def exterior_aperture_area(self):
"""Get the combined area of all exterior apertures on the room."""
ap_areas = 0
for face in self._faces:
if isinstance(face.boundary_condition, Outdoors) and \
len(face._apertures) > 0:
ap_areas += sum(ap.area for ap in face._apertures)
return ap_areas
@property
def exterior_wall_aperture_area(self):
"""Get the combined area of all apertures on exterior walls of the room."""
ap_areas = 0
for face in self._faces:
if isinstance(face.boundary_condition, Outdoors) and \
isinstance(face.type, Wall) and len(face._apertures) > 0:
ap_areas += sum(ap.area for ap in face._apertures)
return ap_areas
@property
def exterior_skylight_aperture_area(self):
"""Get the combined area of all apertures on exterior roofs of the room."""
ap_areas = 0
for face in self._faces:
if isinstance(face.boundary_condition, Outdoors) and \
isinstance(face.type, RoofCeiling) and len(face._apertures) > 0:
ap_areas += sum(ap.area for ap in face._apertures)
return ap_areas
@property
def average_floor_height(self):
"""Get the height of the room floor averaged over all floor faces in the room.
The resulting value is weighted by the area of each of the floor faces.
Will be the minimum Z value of the Room volume if the room possesses no floors.
"""
heights = 0
areas = 0
for face in self._faces:
if isinstance(face.type, Floor):
heights += face.center.z * face.area
areas += face.area
return heights / areas if areas != 0 else self.geometry.min.z
@property
def has_parent(self):
"""Always False as Rooms cannot have parents."""
return False
[docs] def average_orientation(self, north_vector=Vector2D(0, 1)):
"""Get a number between 0 and 360 for the average orientation of exposed walls.
0 = North, 90 = East, 180 = South, 270 = West. Will be None if the zone has
no exterior walls. Resulting value is weighted by the area of each of the
wall faces.
Args:
north_vector: A ladybug_geometry Vector2D for the north direction.
Default is the Y-axis (0, 1).
"""
orientations = 0
areas = 0
for face in self._faces:
if isinstance(face.type, Wall) and \
isinstance(face.boundary_condition, Outdoors):
orientations += face.horizontal_orientation(north_vector) * face.area
areas += face.area
return orientations / areas if areas != 0 else None
[docs] def add_prefix(self, prefix):
"""Change the identifier of this object and all child objects by inserting a prefix.
This is particularly useful in workflows where you duplicate and edit
a starting object and then want to combine it with the original object
into one Model (like making a model of repeated rooms) since all objects
within a Model must have unique identifiers.
Args:
prefix: Text that will be inserted at the start of this object's
(and child objects') identifier and display_name. It is recommended
that this prefix be short to avoid maxing out the 100 allowable
characters for honeybee identifiers.
"""
self._identifier = clean_string('{}_{}'.format(prefix, self.identifier))
self.display_name = '{}_{}'.format(prefix, self.display_name)
self.properties.add_prefix(prefix)
for face in self._faces:
face.add_prefix(prefix)
self._add_prefix_shades(prefix)
[docs] def remove_indoor_furniture(self):
"""Remove all indoor furniture assigned to this Room.
Note that this method is identical to the remove_indoor_shade method but
it is provided here under an alternate name to make it clear that indoor
furniture objects should be added here to the Room.
"""
self.remove_indoor_shades()
[docs] def add_indoor_furniture(self, shade):
"""Add a Shade object representing furniture to the Room.
Note that this method is identical to the add_indoor_shade method but
it is provided here under an alternate name to make it clear that indoor
furniture objects should be added here to the Room.
Args:
shade: A Shade object to add to the indoors of this Room, representing
furniture, desks, partitions, etc.
"""
self.add_indoor_shade(shade)
[docs] def generate_grid(self, x_dim, y_dim=None, offset=1.0):
"""Get a list of gridded Mesh3D objects offset from the floors of this room.
Note that the x_dim and y_dim refer to dimensions within the XY coordinate
system of the floor faces's planes. So rotating the planes of the floor faces
will result in rotated grid cells.
Will be None if the Room has no floor faces.
Args:
x_dim: The x dimension of the grid cells as a number.
y_dim: The y dimension of the grid cells as a number. Default is None,
which will assume the same cell dimension for y as is set for x.
offset: A number for how far to offset the grid from the base face.
Default is 1.0, which will not offset the grid to be 1 unit above
the floor.
Usage:
.. code-block:: python
room = Room.from_box(3.0, 6.0, 3.2, 180)
floor_mesh = room.generate_grid(0.5, 0.5, 1)
test_points = floor_mesh.face_centroids
"""
floor_grids = []
for face in self._faces:
if isinstance(face.type, Floor):
floor_grids.append(face.geometry.mesh_grid(x_dim, y_dim, offset, True))
if len(floor_grids) == 1:
return floor_grids[0]
elif len(floor_grids) > 1:
return Mesh3D.join_meshes(floor_grids)
return None
[docs] def wall_apertures_by_ratio(self, ratio, tolerance=0.01):
"""Add apertures to all exterior walls given a ratio of aperture to face area.
Note this method removes any existing apertures and doors on the Room's walls.
This method attempts to generate as few apertures as necessary to meet the ratio.
Args:
ratio: A number between 0 and 1 (but not perfectly equal to 1)
for the desired ratio between aperture area and face area.
tolerance: The maximum difference between point values for them to be
considered a part of a rectangle. This is used in the event that
this face is concave and an attempt to subdivide the face into a
rectangle is made. It does not affect the ability to produce apertures
for convex Faces. Default: 0.01, suitable for objects in meters.
Usage:
.. code-block:: python
room = Room.from_box(3.0, 6.0, 3.2, 180)
room.wall_apertures_by_ratio(0.4)
"""
for face in self._faces:
if isinstance(face.boundary_condition, Outdoors) and \
isinstance(face.type, Wall):
face.apertures_by_ratio(ratio, tolerance)
[docs] def skylight_apertures_by_ratio(self, ratio, tolerance=0.01):
"""Add apertures to all exterior roofs given a ratio of aperture to face area.
Note this method removes any existing apertures and overhead doors on the
Room's roofs. This method attempts to generate as few apertures as
necessary to meet the ratio.
Args:
ratio: A number between 0 and 1 (but not perfectly equal to 1)
for the desired ratio between aperture area and face area.
tolerance: The maximum difference between point values for them to be
considered a part of a rectangle. This is used in the event that
this face is concave and an attempt to subdivide the face into a
rectangle is made. It does not affect the ability to produce apertures
for convex Faces. Default: 0.01, suitable for objects in meters.
Usage:
.. code-block:: python
room = Room.from_box(3.0, 6.0, 3.2, 180)
room.skylight_apertures_by_ratio(0.05)
"""
for face in self._faces:
if isinstance(face.boundary_condition, Outdoors) and \
isinstance(face.type, RoofCeiling):
face.apertures_by_ratio(ratio, tolerance)
[docs] def ground_by_custom_surface(self, ground_geometry, tolerance=0.01,
angle_tolerance=1.0):
"""Set ground boundary conditions using an array of Face3D for the ground.
Room faces that are coplanar with the ground surface or lie completely below it
will get a Ground boundary condition while those above will get an Outdoors
boundary condition. Existing Faces with an indoor boundary condition will
be unaffected.
Args:
ground_geometry: An array of ladybug_geometry Face3D that together
represent the ground surface.
tolerance: The minimum difference between the coordinate values of two
vertices at which they can be considered equivalent. (Default: 0.01,
suitable for objects in meters).
angle_tolerance: The max angle in degrees that the plane normals can
differ from one another in order for them to be considered
coplanar. (Default: 1).
"""
select_faces = self.faces_by_guide_surface(
ground_geometry, Vector3D(0, 0, -1), tolerance, angle_tolerance)
for face in select_faces:
if face.can_be_ground and \
isinstance(face.boundary_condition, (Outdoors, Ground)):
face.boundary_condition = boundary_conditions.ground
[docs] def faces_by_guide_surface(self, surface_geometry, directional_vector=None,
tolerance=0.01, angle_tolerance=1.0):
"""Get the Faces of the Room that are touching and coplanar with a given surface.
This is useful in workflows were one would like to set the properties
of a group of Faces using a guide surface, like setting a series of faces
along a given stretch of a parti wall to be adiabatic.
Args:
surface_geometry: An array of ladybug_geometry Face3D that together
represent the guide surface.
directional_vector: An optional Vector3D to select the room Faces that
lie on a certain side of the surface_geometry. For example, using
(0, 0, -1) will include all Faces that lie below the surface_geometry
in the resulting selection.
tolerance: The minimum difference between the coordinate values of two
vertices at which they can be considered equivalent. (Default: 0.01,
suitable for objects in meters).
angle_tolerance: The max angle in degrees that the plane normals can
differ from one another in order for them to be considered
coplanar. (Default: 1).
"""
selected_faces, ang_tol = [], math.radians(angle_tolerance)
if directional_vector is None: # only check for co-planarity
for face in self.faces:
for srf_geo in surface_geometry:
pl1, pl2 = face.geometry.plane, srf_geo.plane
if pl1.is_coplanar_tolerance(pl2, tolerance, ang_tol):
pt_on_face = face.geometry._point_on_face(tolerance * 2)
if srf_geo.is_point_on_face(pt_on_face, tolerance):
selected_faces.append(face)
break
else: # first check to see if the Face is on the correct side of the surface
rev_vector = directional_vector.reverse()
for face in self.faces:
ray = Ray3D(face.center, rev_vector)
for srf_geo in surface_geometry:
if srf_geo.intersect_line_ray(ray):
selected_faces.append(face)
break
pl1, pl2 = face.geometry.plane, srf_geo.plane
if pl1.is_coplanar_tolerance(pl2, tolerance, ang_tol):
pt_on_face = face.geometry._point_on_face(tolerance * 2)
if srf_geo.is_point_on_face(pt_on_face, tolerance):
selected_faces.append(face)
break
return selected_faces
[docs] def move(self, moving_vec):
"""Move this Room along a vector.
Args:
moving_vec: A ladybug_geometry Vector3D with the direction and distance
to move the room.
"""
for face in self._faces:
face.move(moving_vec)
self.move_shades(moving_vec)
self.properties.move(moving_vec)
if self._geometry is not None:
self._geometry = self.geometry.move(moving_vec)
[docs] def rotate(self, axis, angle, origin):
"""Rotate this Room by a certain angle around an axis and origin.
Args:
axis: A ladybug_geometry Vector3D axis representing the axis of rotation.
angle: An angle for rotation in degrees.
origin: A ladybug_geometry Point3D for the origin around which the
object will be rotated.
"""
for face in self._faces:
face.rotate(axis, angle, origin)
self.rotate_shades(axis, angle, origin)
self.properties.rotate(axis, angle, origin)
if self._geometry is not None:
self._geometry = self.geometry.rotate(axis, math.radians(angle), origin)
[docs] def rotate_xy(self, angle, origin):
"""Rotate this Room counterclockwise in the world XY plane by a certain angle.
Args:
angle: An angle in degrees.
origin: A ladybug_geometry Point3D for the origin around which the
object will be rotated.
"""
for face in self._faces:
face.rotate_xy(angle, origin)
self.rotate_xy_shades(angle, origin)
self.properties.rotate_xy(angle, origin)
if self._geometry is not None:
self._geometry = self.geometry.rotate_xy(math.radians(angle), origin)
[docs] def reflect(self, plane):
"""Reflect this Room across a plane.
Args:
plane: A ladybug_geometry Plane across which the object will
be reflected.
"""
for face in self._faces:
face.reflect(plane)
self.reflect_shades(plane)
self.properties.reflect(plane)
if self._geometry is not None:
self._geometry = self.geometry.reflect(plane.n, plane.o)
[docs] def scale(self, factor, origin=None):
"""Scale this Room by a factor from an origin point.
Args:
factor: A number representing how much the object should be scaled.
origin: A ladybug_geometry Point3D representing the origin from which
to scale. If None, it will be scaled from the World origin (0, 0, 0).
"""
for face in self._faces:
face.scale(factor, origin)
self.scale_shades(factor, origin)
self.properties.scale(factor, origin)
if self._geometry is not None:
self._geometry = self.geometry.scale(factor, origin)
[docs] def remove_colinear_vertices_envelope(self, tolerance=0.01, delete_degenerate=False):
"""Remove colinear and duplicate vertices from this object's Faces and Sub-faces.
Note that this does not affect any assigned Shades.
Args:
tolerance: The minimum distance between a vertex and the boundary segments
at which point the vertex is considered colinear. Default: 0.01,
suitable for objects in meters.
delete_degenerate: Boolean to note whether degenerate Faces, Apertures and
Doors (objects that evaluate to less than 3 vertices at the tolerance)
should be deleted from the Room instead of raising a ValueError.
(Default: False).
"""
if delete_degenerate:
new_faces = list(self._faces)
for i, face in enumerate(new_faces):
try:
face.remove_colinear_vertices(tolerance)
face.remove_degenerate_sub_faces(tolerance)
except ValueError: # degenerate face found!
new_faces.pop(i)
self._faces = tuple(new_faces)
else:
try:
for face in self._faces:
face.remove_colinear_vertices(tolerance)
for ap in face._apertures:
ap.remove_colinear_vertices(tolerance)
for dr in face._doors:
dr.remove_colinear_vertices(tolerance)
except ValueError as e:
raise ValueError(
'Room "{}" contains invalid geometry.\n {}'.format(
self.full_id, str(e).replace('\n', '\n ')))
if self._geometry is not None:
self._geometry = Polyface3D.from_faces(
tuple(face.geometry for face in self._faces), tolerance)
[docs] def check_solid(self, tolerance=0.01, angle_tolerance=1, raise_exception=True,
detailed=False):
"""Check whether the Room is a closed solid to within the input tolerances.
Args:
tolerance: tolerance: The maximum difference between x, y, and z values
at which face vertices are considered equivalent. Default: 0.01,
suitable for objects in meters.
angle_tolerance: The max angle difference in degrees that vertices are
allowed to differ from one another in order to consider them colinear.
Default: 1 degree.
raise_exception: Boolean to note whether a ValueError should be raised
if the room geometry does not form a closed solid.
detailed: Boolean for whether the returned object is a detailed list of
dicts with error info or a string with a message. (Default: False).
Returns:
A string with the message or a list with a dictionary if detailed is True.
"""
if self._geometry is not None and self.geometry.is_solid:
return [] if detailed else ''
face_geometries = tuple(face.geometry for face in self._faces)
self._geometry = Polyface3D.from_faces(face_geometries, tolerance)
if self.geometry.is_solid:
return [] if detailed else ''
ang_tol = math.radians(angle_tolerance)
self._geometry = self.geometry.merge_overlapping_edges(tolerance, ang_tol)
if self.geometry.is_solid:
return [] if detailed else ''
msg = 'Room "{}" is not closed to within {} tolerance and {} angle ' \
'tolerance.\n {} naked edges found\n {} non-manifold edges found'.format(
self.full_id, tolerance, angle_tolerance,
len(self._geometry.naked_edges), len(self._geometry.non_manifold_edges))
return self._validation_message(
msg, raise_exception, detailed, '000106',
error_type='Non-Solid Room Geometry')
[docs] def check_sub_faces_valid(self, tolerance=0.01, angle_tolerance=1,
raise_exception=True, detailed=False):
"""Check that room's sub-faces are co-planar with faces and in the face boundary.
Note this does not check the planarity of the sub-faces themselves, whether
they self-intersect, or whether they have a non-zero area.
Args:
tolerance: The minimum difference between the coordinate values of two
vertices at which they can be considered equivalent. Default: 0.01,
suitable for objects in meters.
angle_tolerance: The max angle in degrees that the plane normals can
differ from one another in order for them to be considered coplanar.
Default: 1 degree.
raise_exception: Boolean to note whether a ValueError should be raised
if an sub-face is not valid. (Default: True).
detailed: Boolean for whether the returned object is a detailed list of
dicts with error info or a string with a message. (Default: False).
Returns:
A string with the message or a list with a dictionary if detailed is True.
"""
detailed = False if raise_exception else detailed
msgs = []
for f in self._faces:
msg = f.check_sub_faces_valid(tolerance, angle_tolerance, False, detailed)
if detailed:
msgs.extend(msg)
elif msg != '':
msgs.append(msg)
if len(msgs) == 0:
return [] if detailed else ''
elif detailed:
return msgs
full_msg = 'Room "{}" contains invalid sub-faces (Apertures and Doors).' \
'\n {}'.format(self.full_id, '\n '.join(msgs))
if raise_exception and len(msgs) != 0:
raise ValueError(full_msg)
return full_msg
[docs] def check_sub_faces_overlapping(self, raise_exception=True, detailed=False):
"""Check that this Face's sub-faces do not overlap with one another.
Args:
raise_exception: Boolean to note whether a ValueError should be raised
if a sub-faces overlap with one another. (Default: True).
detailed: Boolean for whether the returned object is a detailed list of
dicts with error info or a string with a message. (Default: False).
Returns:
A string with the message or a list with a dictionary if detailed is True.
"""
detailed = False if raise_exception else detailed
msgs = []
for f in self._faces:
msg = f.check_sub_faces_overlapping(False, detailed)
if detailed:
msgs.extend(msg)
elif msg != '':
msgs.append(msg)
if len(msgs) == 0:
return [] if detailed else ''
elif detailed:
return msgs
full_msg = 'Room "{}" contains overlapping sub-faces.' \
'\n {}'.format(self.full_id, '\n '.join(msgs))
if raise_exception and len(msgs) != 0:
raise ValueError(full_msg)
return full_msg
[docs] def check_planar(self, tolerance=0.01, raise_exception=True, detailed=False):
"""Check that all of the Room's geometry components are planar.
This includes all of the Room's Faces, Apertures, Doors and Shades.
Args:
tolerance: The minimum distance between a given vertex and a the
object's plane at which the vertex is said to lie in the plane.
Default: 0.01, suitable for objects in meters.
raise_exception: Boolean to note whether an ValueError should be
raised if a vertex does not lie within the object's plane.
detailed: Boolean for whether the returned object is a detailed list of
dicts with error info or a string with a message. (Default: False).
Returns:
A string with the message or a list with a dictionary if detailed is True.
"""
detailed = False if raise_exception else detailed
msgs = [self._check_planar_shades(tolerance, detailed)]
for face in self._faces:
msgs.append(face.check_planar(tolerance, False, detailed))
msgs.append(face._check_planar_shades(tolerance, detailed))
for ap in face._apertures:
msgs.append(ap.check_planar(tolerance, False, detailed))
msgs.append(ap._check_planar_shades(tolerance, detailed))
for dr in face._doors:
msgs.append(dr.check_planar(tolerance, False, detailed))
msgs.append(dr._check_planar_shades(tolerance, detailed))
full_msgs = [msg for msg in msgs if msg]
if len(full_msgs) == 0:
return [] if detailed else ''
elif detailed:
return [m for megs in full_msgs for m in megs]
full_msg = 'Room "{}" contains non-planar geometry.' \
'\n {}'.format(self.full_id, '\n '.join(full_msgs))
if raise_exception and len(full_msgs) != 0:
raise ValueError(full_msg)
return full_msg
[docs] def check_self_intersecting(self, tolerance=0.01, raise_exception=True,
detailed=False):
"""Check that no edges of the Room's geometry components self-intersect.
This includes all of the Room's Faces, Apertures, Doors and Shades.
Args:
tolerance: The minimum difference between the coordinate values of two
vertices at which they can be considered equivalent. Default: 0.01,
suitable for objects in meters.
raise_exception: If True, a ValueError will be raised if an object
intersects with itself (like a bowtie). (Default: True).
detailed: Boolean for whether the returned object is a detailed list of
dicts with error info or a string with a message. (Default: False).
Returns:
A string with the message or a list with a dictionary if detailed is True.
"""
detailed = False if raise_exception else detailed
msgs = [self._check_self_intersecting_shades(tolerance, detailed)]
for face in self._faces:
msgs.append(face.check_self_intersecting(tolerance, False, detailed))
msgs.append(face._check_self_intersecting_shades(tolerance, detailed))
for ap in face._apertures:
msgs.append(ap.check_self_intersecting(tolerance, False, detailed))
msgs.append(ap._check_self_intersecting_shades(tolerance, detailed))
for dr in face._doors:
msgs.append(dr.check_self_intersecting(tolerance, False, detailed))
msgs.append(dr._check_self_intersecting_shades(tolerance, detailed))
full_msgs = [msg for msg in msgs if msg]
if len(full_msgs) == 0:
return [] if detailed else ''
elif detailed:
return [m for megs in full_msgs for m in megs]
full_msg = 'Room "{}" contains self-intersecting geometry.' \
'\n {}'.format(self.full_id, '\n '.join(full_msgs))
if raise_exception and len(full_msgs) != 0:
raise ValueError(full_msg)
return full_msg
[docs] def check_non_zero(self, tolerance=0.0001, raise_exception=True, detailed=False):
"""Check that the Room's geometry components are above a "zero" area tolerance.
This includes all of the Room's Faces, Apertures, Doors and Shades.
Args:
tolerance: The minimum acceptable area of the object. Default is 0.0001,
which is equal to 1 cm2 when model units are meters. This is just
above the smallest size that OpenStudio will accept.
raise_exception: If True, a ValueError will be raised if the object
area is below the tolerance. (Default: True).
detailed: Boolean for whether the returned object is a detailed list of
dicts with error info or a string with a message. (Default: False).
Returns:
A string with the message or a list with a dictionary if detailed is True.
"""
detailed = False if raise_exception else detailed
msgs = [self._check_non_zero_shades(tolerance, detailed)]
for face in self._faces:
msgs.append(face.check_non_zero(tolerance, False, detailed))
msgs.append(face._check_non_zero_shades(tolerance, detailed))
for ap in face._apertures:
msgs.append(ap.check_non_zero(tolerance, False, detailed))
msgs.append(ap._check_non_zero_shades(tolerance, detailed))
for dr in face._doors:
msgs.append(dr.check_non_zero(tolerance, False, detailed))
msgs.append(dr._check_non_zero_shades(tolerance, detailed))
full_msgs = [msg for msg in msgs if msg]
if len(full_msgs) == 0:
return [] if detailed else ''
elif detailed:
return [m for megs in full_msgs for m in megs]
full_msg = 'Room "{}" contains zero area geometry.' \
'\n {}'.format(self.full_id, '\n '.join(full_msgs))
if raise_exception and len(full_msgs) != 0:
raise ValueError(full_msg)
return full_msg
[docs] @staticmethod
def solve_adjacency(rooms, tolerance=0.01):
"""Solve for adjacencies between a list of rooms.
Note that this method will mutate the input rooms by setting Surface
boundary conditions for any adjacent objects. However, it does NOT overwrite
existing Surface boundary conditions and only adds new ones if faces are
found to be adjacent with equivalent areas.
Args:
rooms: A list of rooms for which adjacencies will be solved.
tolerance: The minimum difference between the coordinate values of two
faces at which they can be considered centered adjacent. Default: 0.01,
suitable for objects in meters.
Returns:
A dictionary of information about the objects that had their adjacency set.
The dictionary has the following keys.
- adjacent_faces - A list of tuples with each tuple containing 2 objects
for Faces paired in the process of solving adjacency. This data can
be used to assign custom properties to the new adjacent Faces (like
making all adjacencies an AirBoundary face type or assigning custom
materials/constructions).
- adjacent_apertures - A list of tuples with each tuple containing 2
objects for Apertures paired in the process of solving adjacency.
- adjacent_doors - A list of tuples with each tuple containing 2 objects
for Doors paired in the process of solving adjacency.
"""
# lists of adjacencies to track
adj_info = {'adjacent_faces': [], 'adjacent_apertures': [],
'adjacent_doors': []}
# solve all adjacencies between rooms
for i, room_1 in enumerate(rooms):
try:
for room_2 in rooms[i + 1:]:
if not Polyface3D.overlapping_bounding_boxes(
room_1.geometry, room_2.geometry, tolerance):
continue # no overlap in bounding box; adjacency impossible
for face_1 in room_1._faces:
for face_2 in room_2._faces:
if not isinstance(face_2.boundary_condition, Surface):
if face_1.geometry.is_centered_adjacent(
face_2.geometry, tolerance):
face_info = face_1.set_adjacency(face_2)
adj_info['adjacent_faces'].append((face_1, face_2))
adj_info['adjacent_apertures'].extend(
face_info['adjacent_apertures'])
adj_info['adjacent_doors'].extend(
face_info['adjacent_doors'])
break
except IndexError:
pass # we have reached the end of the list of zones
return adj_info
[docs] @staticmethod
def find_adjacency(rooms, tolerance=0.01):
"""Get a list with all adjacent pairs of Faces between input rooms.
Note that this method does not change any boundary conditions of the input
rooms or mutate them in any way. It's purely a geometric analysis of the
faces between rooms.
Args:
rooms: A list of rooms for which adjacencies will be solved.
tolerance: The minimum difference between the coordinate values of two
faces at which they can be considered centered adjacent. Default: 0.01,
suitable for objects in meters.
Returns:
A list of tuples with each tuple containing 2 objects for Faces that
are adjacent to one another.
"""
adj_faces = [] # lists of adjacencies to track
for i, room_1 in enumerate(rooms):
try:
for room_2 in rooms[i + 1:]:
if not Polyface3D.overlapping_bounding_boxes(
room_1.geometry, room_2.geometry, tolerance):
continue # no overlap in bounding box; adjacency impossible
for face_1 in room_1._faces:
for face_2 in room_2._faces:
if face_1.geometry.is_centered_adjacent(
face_2.geometry, tolerance):
adj_faces.append((face_1, face_2))
break
except IndexError:
pass # we have reached the end of the list of zones
return adj_faces
[docs] @staticmethod
def group_by_adjacency(rooms):
"""Group Rooms together that are connected by adjacencies.
This is useful for separating rooms in the case where a Model contains
multiple buildings or sections that are separated by adiabatic or
outdoor boundary conditions.
Args:
rooms: A list of rooms to be grouped by their adjacency.
Returns:
A list of list with each sub-list containing rooms that share adjacencies.
"""
return Room._adjacency_grouping(rooms, Room._find_adjacent_rooms)
[docs] @staticmethod
def group_by_air_boundary_adjacency(rooms):
"""Group Rooms together that share air boundaries.
This is useful for understanding the radiant enclosures that will exist
when a model is exported to EnergyPlus.
Args:
rooms: A list of rooms to be grouped by their air boundary adjacency.
Returns:
A list of list with each sub-list containing rooms that share adjacent
air boundaries. If a Room has no air boundaries it will the the only
item within its sub-list.
"""
return Room._adjacency_grouping(rooms, Room._find_adjacent_air_boundary_rooms)
[docs] @staticmethod
def group_by_orientation(rooms, group_count=None, north_vector=Vector2D(0, 1)):
"""Group Rooms with the same average outdoor wall orientation.
Args:
rooms: A list of honeybee rooms to be grouped by orientation.
group_count: An optional positive integer to set the number of orientation
groups to use. For example, setting this to 4 will result in rooms
being grouped by four orientations (North, East, South, West). If None,
the maximum number of unique groups will be used.
north_vector: A ladybug_geometry Vector2D for the north direction.
Default is the Y-axis (0, 1).
Returns:
A tuple with three items.
- grouped_rooms - A list of lists of honeybee rooms with each sub-list
representing a different orientation.
- core_rooms - A list of honeybee rooms with no identifiable orientation.
- orientations - A list of numbers between 0 and 360 with one orientation
for each branch of the output grouped_rooms. This will be a list of
angle ranges if a value is input for group_count.
"""
# loop through each of the rooms and get the orientation
orient_dict = {}
core_rooms = []
for room in rooms:
ori = room.average_orientation(north_vector)
if ori is None:
core_rooms.append(room)
else:
try:
orient_dict[ori].append(room)
except KeyError:
orient_dict[ori] = []
orient_dict[ori].append(room)
# sort the rooms by orientation values
room_mtx = sorted(orient_dict.items(), key=lambda d: float(d[0]))
orientations = [r_tup[0] for r_tup in room_mtx]
grouped_rooms = [r_tup[1] for r_tup in room_mtx]
# group orientations if there is an input group_count
if group_count is not None:
angs = angles_from_num_orient(group_count)
p_rooms = [[] for i in range(group_count)]
for ori, rm in zip(orientations, grouped_rooms):
or_ind = orient_index(ori, angs)
p_rooms[or_ind].extend(rm)
orientations = ['{} - {}'.format(int(angs[i - 1]), int(angs[i]))
for i in range(group_count)]
grouped_rooms = p_rooms
return grouped_rooms, core_rooms, orientations
[docs] @staticmethod
def group_by_floor_height(rooms, min_difference=0.01):
"""Group Rooms according to their average floor height.
Args:
rooms: A list of honeybee rooms to be grouped by floor height.
min_difference: An float value to denote the minimum difference
in floor heights that is considered meaningful. This can be used
to ensure rooms like those representing stair landings are grouped
with those below them. Default: 0.01, which means that virtually
any minor difference in floor heights will result in a new group.
This assumption is suitable for models in meters.
Returns:
A tuple with two items.
- grouped_rooms - A list of lists of honeybee rooms with each sub-list
representing a different floor height.
- floor_heights - A list of floor heights with one floor height for each
sub-list of the output grouped_rooms.
"""
# loop through each of the rooms and get the floor height
flrhgt_dict = {}
for room in rooms:
flrhgt = room.average_floor_height
try: # assume there is already a story with the room's floor height
flrhgt_dict[flrhgt].append(room)
except KeyError: # this is the first room with this floor height
flrhgt_dict[flrhgt] = []
flrhgt_dict[flrhgt].append(room)
# sort the rooms by floor heights
room_mtx = sorted(flrhgt_dict.items(), key=lambda d: float(d[0]))
flr_hgts = [r_tup[0] for r_tup in room_mtx]
rooms = [r_tup[1] for r_tup in room_mtx]
# group floor heights if they differ by less than the min_difference
floor_heights = [flr_hgts[0]]
grouped_rooms = [rooms[0]]
for flrh, rm in zip(flr_hgts[1:], rooms[1:]):
if flrh - floor_heights[-1] < min_difference:
grouped_rooms[-1].extend(rm)
else:
grouped_rooms.append(rm)
floor_heights.append(flrh)
return grouped_rooms, floor_heights
[docs] @staticmethod
def stories_by_floor_height(rooms, min_difference=2.0):
"""Assign story properties to a set of Rooms using their floor heights.
Stories will be named with a standard convention ('Floor1', 'Floor2', etc.).
Note that this method will only assign stories to Rooms that do not have
a story identifier already assigned to them.
Args:
rooms: A list of rooms for which story properties will be automatically
assigned.
min_difference: An float value to denote the minimum difference
in floor heights that is considered meaningful. This can be used
to ensure rooms like those representing stair landings are grouped
with those below them. Default: 2.0, which means that any difference
in floor heights less than 2.0 will be considered a part of the
same story. This assumption is suitable for models in meters.
Returns:
A list of the unique story names that were assigned to the input rooms.
"""
# group the rooms by floor height
new_rooms, _ = Room.group_by_floor_height(rooms, min_difference)
# assign the story property to each of the groups
story_names = []
for i, room_list in enumerate(new_rooms):
story_name = 'Floor{}'.format(i + 1)
story_names.append(story_name)
for room in room_list:
if room.story is not None:
continue # preserve any existing user-assigned story values
room.story = story_name
return story_names
@property
def to(self):
"""Room writer object.
Use this method to access Writer class to write the room in other formats.
Usage:
.. code-block:: python
room.to.idf(room) -> idf string.
room.to.radiance(room) -> Radiance string.
"""
return writer
[docs] def to_dict(self, abridged=False, included_prop=None, include_plane=True):
"""Return Room as a dictionary.
Args:
abridged: Boolean to note whether the extension properties of the
object (ie. construction sets) should be included in detail
(False) or just referenced by identifier (True). Default: False.
included_prop: List of properties to filter keys that must be included in
output dictionary. For example ['energy'] will include 'energy' key if
available in properties to_dict. By default all the keys will be
included. To exclude all the keys from extensions use an empty list.
include_plane: Boolean to note wether the planes of the Face3Ds should be
included in the output. This can preserve the orientation of the
X/Y axes of the planes but is not required and can be removed to
keep the dictionary smaller. (Default: True).
"""
base = {'type': 'Room'}
base['identifier'] = self.identifier
base['display_name'] = self.display_name
base['properties'] = self.properties.to_dict(abridged, included_prop)
base['faces'] = [f.to_dict(abridged, included_prop, include_plane)
for f in self._faces]
self._add_shades_to_dict(base, abridged, included_prop, include_plane)
if self.multiplier != 1:
base['multiplier'] = self.multiplier
if self.story is not None:
base['story'] = self.story
if self.exclude_floor_area:
base['exclude_floor_area'] = self.exclude_floor_area
if self.user_data is not None:
base['user_data'] = self.user_data
return base
@staticmethod
def _adjacency_grouping(rooms, adj_finding_function):
"""Group Rooms together according to an adjacency finding function.
Args:
rooms: A list of rooms to be grouped by their adjacency.
adj_finding_function: A function that denotes which rooms are adjacent
to another.
Returns:
A list of list with each sub-list containing rooms that share adjacencies.
"""
# create a room lookup table and duplicate the list of rooms
room_lookup = {rm.identifier: rm for rm in rooms}
all_rooms = list(rooms)
adj_network = []
# loop through the rooms and find air boundary adjacencies
for room in all_rooms:
adj_ids = adj_finding_function(room)
if len(adj_ids) == 0: # a room that is its own solar enclosure
adj_network.append([room])
else: # there are other adjacent rooms to find
local_network = [room]
local_ids, first_id = set(adj_ids), room.identifier
while len(adj_ids) != 0:
# add the current rooms to the local network
adj_objs = [room_lookup[rm_id] for rm_id in adj_ids]
local_network.extend(adj_objs)
adj_ids = [] # reset the list of new adjacencies
# find any rooms that are adjacent to the adjacent rooms
for obj in adj_objs:
all_new_ids = adj_finding_function(obj)
new_ids = [rid for rid in all_new_ids
if rid not in local_ids and rid != first_id]
for rm_id in new_ids:
local_ids.add(rm_id)
adj_ids.extend(new_ids)
# after the local network is understood, clean up duplicated rooms
adj_network.append(local_network)
i_to_remove = [i for i, room_obj in enumerate(all_rooms)
if room_obj.identifier in local_ids]
for i in reversed(i_to_remove):
all_rooms.pop(i)
return adj_network
@staticmethod
def _find_adjacent_rooms(room):
"""Find the identifiers of all rooms with adjacency to a room."""
adj_rooms = []
for face in room._faces:
if isinstance(face.boundary_condition, Surface):
adj_rooms.append(face.boundary_condition.boundary_condition_objects[-1])
return adj_rooms
@staticmethod
def _find_adjacent_air_boundary_rooms(room):
"""Find the identifiers of all rooms with air boundary adjacency to a room."""
adj_rooms = []
for face in room._faces:
if isinstance(face.type, AirBoundary) and \
isinstance(face.boundary_condition, Surface):
adj_rooms.append(face.boundary_condition.boundary_condition_objects[-1])
return adj_rooms
def __copy__(self):
new_r = Room(self.identifier, tuple(face.duplicate() for face in self._faces))
new_r._display_name = self.display_name
new_r._user_data = None if self.user_data is None else self.user_data.copy()
new_r._multiplier = self.multiplier
new_r._story = self.story
new_r._exclude_floor_area = self.exclude_floor_area
self._duplicate_child_shades(new_r)
new_r._geometry = self._geometry
new_r._properties._duplicate_extension_attr(self._properties)
return new_r
def __len__(self):
return len(self._faces)
def __getitem__(self, key):
return self._faces[key]
def __iter__(self):
return iter(self._faces)
def __repr__(self):
return 'Room: %s' % self.display_name
```