Adds (getter) 'roofs' (tested)

Author: brgix

src/osut/osut.py

@@ -3015,9 +3015,8 @@ def width(pts=None) -> float:
     if len(pts) < 2: return 0
 
     xs = [pt.x() for pt in pts]
-    dx = max(xs) - min(xs)
 
-    return dx
+    return max(xs) - min(xs)
 
 
 def height(pts=None) -> float:
@@ -5088,6 +5087,71 @@ def realignedFace(pts=None, force=False) -> dict:
     return out
 
 
+def alignedWidth(pts=None, force=False) -> float:
+    """Returns 'width' of a set of OpenStudio 3D points, once re/aligned.
+
+    Args:
+        pts (openstudio.Point3dVector):
+            A set of OpenStudio 3D points.
+        force (bool):
+            Whether to force rotation for aligned (yet narrow) boxes.
+
+    Returns:
+        float: Width along X-axis, once re/aligned.
+        0.0: If invalid inputs (see logs).
+
+    """
+    mth = "osut.alignedWidth"
+    pts = osut.poly(pts, False, True, True, True)
+    if len(pts) < 2: return 0
+
+    try:
+        force = bool(force)
+    except:
+        oslg.log(CN.DBG, "Ignoring force input (%s)" % mth)
+        force = False
+
+    pts = osut.realignedFace(pts, force)["set"]
+    if len(pts) < 2: return 0
+
+    xs = [pt.x() for pt in pts]
+
+    return max(xs) - min(xs)
+
+
+def alignedHeight(pts=None, force=False) -> float:
+    """Returns 'height' of a set of OpenStudio 3D points, once re/aligned.
+
+    Args:
+        pts (openstudio.Point3dVector):
+            A set of OpenStudio 3D points.
+        force (bool):
+            Whether to force rotation for aligned (yet narrow) boxes.
+
+    Returns:
+        float: Height along Y-axis, once re/aligned.
+        0.0: If invalid inputs (see logs).
+
+    """
+
+    mth = "osut.alignedHeight"
+    pts = osut.poly(pts, False, True, True, True)
+    if len(pts) < 2: return 0
+
+    try:
+        force = bool(force)
+    except:
+        oslg.log(CN.DBG, "Ignoring force input (%s)" % mth)
+        force = False
+
+    pts = osut.realignedFace(pts, force)["set"]
+    if len(pts) < 2: return 0
+
+    ys = [pt.y() for pt in pts]
+
+    return max(ys) - min(ys)
+
+
 def facets(spaces=[], boundary="all", type="all", sides=[]) -> list:
     """Returns an array of OpenStudio space surfaces or subsurfaces that match
     criteria, e.g. exterior, north-east facing walls in hotel "lobby". Note
@@ -5304,3 +5368,74 @@ def genSlab(pltz=[], z=0):
         slb = vtx
 
     return slb
+
+
+def roofs(spaces = []) -> list:
+    """Returns outdoor-facing, space-related roof surfaces. These include
+    outdoor-facing roofs of each space per se, as well as any outdoor-facing
+    roof surface of unoccupied spaces immediately above (e.g. plenums, attics)
+    overlapping any of the ceiling surfaces of each space. It does not include
+    surfaces labelled as 'RoofCeiling', which do not comply with ASHRAE 90.1 or
+    NECB tilt criteria - see 'isRoof'.
+
+    Args:
+        spaces (list):
+            Set of openstudio.model.Space instances.
+
+    Returns:
+        list of openstudio.model.Surface instances: roofs (may be empty).
+
+    """
+    mth    = "osut.getRoofs"
+    up     = openstudio.Point3d(0,0,1) - openstudio.Point3d(0,0,0)
+    roofs  = []
+    if isinstance(spaces, openstudio.model.Space): spaces = [spaces]
+
+    try:
+        spaces = list(spaces)
+    except:
+        spaces = []
+
+    spaces = [s for s in spaces if isinstance(s, openstudio.model.Space)]
+
+    # Space-specific outdoor-facing roof surfaces.
+    roofs = facets(spaces, "Outdoors", "RoofCeiling")
+    roofs = [roof for roof in roofs if isRoof(roof)]
+
+    for space in spaces:
+        # When unoccupied spaces are involved (e.g. plenums, attics), the
+        # target space may not share the same local transformation as the
+        # space(s) above. Fetching site transformation.
+        t0 = transforms(space)
+        if not t0["t"]: continue
+
+        t0 = t0["t"]
+
+        for ceiling in facets(space, "Surface", "RoofCeiling"):
+            cv0 = t0 * ceiling.vertices()
+
+            floor = ceiling.adjacentSurface()
+            if not floor: continue
+
+            other = floor.get().space()
+            if not other: continue
+
+            other = other.get()
+            if other.partofTotalFloorArea(): continue
+
+            ti = transforms(other)
+            if not ti["t"]: continue
+
+            ti = ti["t"]
+
+            # @todo: recursive call for stacked spaces as atria (AirBoundaries).
+            for ruf in facets(other, "Outdoors", "RoofCeiling"):
+                if not isRoof(ruf): continue
+
+                rvi = ti * ruf.vertices()
+                cst = cast(cv0, rvi, up)
+                if not overlapping(cst, rvi, False): continue
+
+                if ruf not in roofs: roofs.append(ruf)
+
+    return roofs

tests/test_osut.py

@@ -3851,7 +3851,97 @@ def test27_polygon_attributes(self):
 
     # def test31_convexity(self):
 
-    # def test32_outdoor_roofs(self):
+    def test32_outdoor_roofs(self):
+        o = osut.oslg
+        self.assertEqual(o.status(), 0)
+        self.assertEqual(o.reset(INF), INF)
+        self.assertEqual(o.level(), INF)
+        self.assertEqual(o.status(), 0)
+
+        translator = openstudio.osversion.VersionTranslator()
+
+        path  = openstudio.path("./tests/files/osms/in/5ZoneNoHVAC.osm")
+        model = translator.loadModel(path)
+        self.assertTrue(model)
+        model = model.get()
+
+        spaces = {}
+        roofs  = {}
+
+        for space in model.getSpaces():
+            for s in space.surfaces():
+                if s.surfaceType().lower() != "roofceiling": continue
+                if s.outsideBoundaryCondition().lower() != "outdoors": continue
+
+                self.assertFalse(space.nameString() in spaces)
+                spaces[space.nameString()] = s.nameString()
+
+        self.assertEqual(len(spaces), 5)
+
+        # for key, value in spaces.items(): print(key, value)
+        # "Story 1 East Perimeter Space"  "Surface 18"
+        # "Story 1 North Perimeter Space" "Surface 12"
+        # "Story 1 Core Space"            "Surface 30"
+        # "Story 1 South Perimeter Space" "Surface 24"
+        # "Story 1 West Perimeter Space"  "Surface 6"
+
+        for space in model.getSpaces():
+            rufs = osut.roofs(space)
+            self.assertEqual(len(rufs), 1)
+            ruf = rufs[0]
+            self.assertTrue(isinstance(ruf, openstudio.model.Surface))
+            roofs[space.nameString()] = ruf.nameString()
+
+        self.assertEqual(len(roofs), len(spaces))
+
+        for id, surface in spaces.items():
+            self.assertTrue(id in roofs.keys())
+            self.assertEqual(roofs[id], surface)
+
+        del(model)
+
+        # --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- #
+        # CASE 2: None of the occupied spaces have outdoor-facing roofs, yet
+        # plenum above has 4 outdoor-facing roofs (each matches a space ceiling).
+        path  = openstudio.path("./tests/files/osms/out/seb2.osm")
+        model = translator.loadModel(path)
+        self.assertTrue(model)
+        model = model.get()
+
+        occupied = []
+        spaces   = {}
+        roofs    = {}
+
+        for space in model.getSpaces():
+            if not space.partofTotalFloorArea(): continue
+
+            occupied.append(space.nameString())
+
+            for s in space.surfaces():
+                if s.surfaceType().lower() != "roofceiling": continue
+                if s.outsideBoundaryCondition().lower() != "outdoors": continue
+
+                self.assertFalse(space.nameString() in spaces)
+                spaces[space.nameString()] = s.nameString()
+
+        self.assertEqual(len(occupied), 4)
+        self.assertFalse(spaces)
+
+        for space in model.getSpaces():
+            if not space.partofTotalFloorArea(): continue
+
+            rufs = osut.roofs(space)
+            self.assertEqual(len(rufs), 1)
+            ruf = rufs[0]
+            self.assertTrue(isinstance(ruf, openstudio.model.Surface))
+            roofs[space.nameString()] = ruf.nameString()
+
+        self.assertEqual(len(roofs), 4)
+        self.assertEqual(o.status(), 0)
+
+        for occ in occupied:
+            self.assertTrue(occ in roofs.keys())
+            self.assertTrue("plenum" in roofs[occ].lower())
 
     # def test33_leader_line_anchors_inserts(self):
 
@@ -3864,7 +3954,6 @@ def test35_facet_retrieval(self):
         self.assertEqual(o.level(), DBG)
         self.assertEqual(o.status(), 0)
 
-        version = int("".join(openstudio.openStudioVersion().split(".")))
         translator = openstudio.osversion.VersionTranslator()
 
         path   = openstudio.path("./tests/files/osms/out/seb2.osm")