tbd 3.0.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5922a435bc3f8d97b6aa78588346e59108b6455d27c72e0aeecdd792079f33f
-  data.tar.gz: 5f683e96a3f1c33e0bb782bbb545b713d9d55beaf2359d3983f9b4d010716ce0
+  metadata.gz: 3f5a7947fb5c2f96807c924dcb4350198119a9033b35cef4d113e35221b0e61f
+  data.tar.gz: caf6856e314609d3d13134c2bcc86a78292ea4deb1c8ab453e3ca386a5bf56e2
 SHA512:
-  metadata.gz: 7284058dc4ec681c102435484b8af994fd027ea666aa4ed760f0e178cfcef297de033454c0a2c7cd60c95f13b71308bdcc6c4fa0a846819ec92edaa46007af08
-  data.tar.gz: 78e74d0942d5ad735c9b696c5cdaa72b5ad8a92fbf34a3c8843e41dce41f1de0eddfda3b53ef8db08c3f9c87a73b92b3ad8bb89400a58283c1805d7d660d83f7
+  metadata.gz: 024b47e38db346d15524df93119a49c93c3a183c063d5635cd823ad21d8a2c6892680cc4b2f76b0299177a1479265650c6efc241d9037cb35043f1395ed312a8
+  data.tar.gz: da0b7e03bc5142adc8df613427838114377e5b406c36ab2b9ec506eaf72e972478490d45437018a2a94aeac45547ded1c70babfcec677420594c3dd3f776a867

data/.github/workflows/pull_request.yml

@@ -3,11 +3,11 @@ name: Pull Request CI
 on:
   pull_request:
     branches:
-      - master
+      - develop
 
 jobs:
   test_300x:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
     - name: Check out repository
       uses: actions/checkout@v2
@@ -23,7 +23,7 @@ jobs:
         docker exec -t test bundle exec rake
         docker kill test
   test_321x:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
     - name: Check out repository
       uses: actions/checkout@v2
@@ -39,7 +39,7 @@ jobs:
         docker exec -t test bundle exec rake
         docker kill test
   test_330x:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
     - name: Check out repository
       uses: actions/checkout@v2
@@ -55,7 +55,7 @@ jobs:
         docker exec -t test bundle exec rake
         docker kill test
   test_340x:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
     - name: Check out repository
       uses: actions/checkout@v2

data/json/tbd_seb_n2.json

@@ -1,7 +1,8 @@
 {
   "schema": "https://github.com/rd2/tbd/blob/master/tbd.schema.json",
   "description": "testing JSON surface KHI entries",
-  "psis": [{
+  "psis": [
+    {
       "id": "good",
       "parapet": 0.5,
       "party": 0.9
@@ -17,7 +18,8 @@
       "grade": 0.45
     }
   ],
-  "khis": [{
+  "khis": [
+    {
       "id": "column",
       "point": 0.5
     },
@@ -26,16 +28,19 @@
       "point": 0.5
     }
   ],
-  "surfaces": [{
-    "id": "Entryway  Wall 5",
-    "khis": [{
-        "id": "column",
-        "count": 3
-      },
-      {
-        "id": "support",
-        "count": 4
-      }
-    ]
-  }]
+  "surfaces": [
+    {
+      "id": "Entryway  Wall 5",
+      "khis": [
+        {
+          "id": "column",
+          "count": 3
+        },
+        {
+          "id": "support",
+          "count": 4
+        }
+      ]
+    }
+  ]
 }

data/lib/measures/tbd/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>tbd_measure</name>
   <uid>8890787b-8c25-4dc8-8641-b6be1b6c2357</uid>
-  <version_id>65ac80d9-ef1e-4c41-9a62-68e2e1e6c5db</version_id>
-  <version_modified>20220918T225251Z</version_modified>
+  <version_id>4501c26f-1cd4-45d8-8f0e-f1ea907c27df</version_id>
+  <version_modified>20221125T130635Z</version_modified>
   <xml_checksum>99772807</xml_checksum>
   <class_name>TBDMeasure</class_name>
   <display_name>Thermal Bridging and Derating - TBD</display_name>
@@ -432,12 +432,6 @@
       <usage_type>test</usage_type>
       <checksum>6ED9AF88</checksum>
     </file>
-    <file>
-      <filename>psi.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>resource</usage_type>
-      <checksum>655E8232</checksum>
-    </file>
     <file>
       <filename>README.md</filename>
       <filetype>md</filetype>
@@ -448,13 +442,19 @@
       <filename>geo.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>8A794826</checksum>
+      <checksum>D999D942</checksum>
+    </file>
+    <file>
+      <filename>psi.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>AFC8A549</checksum>
     </file>
     <file>
       <filename>ua.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>7873E62A</checksum>
+      <checksum>B39B3BB0</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/tbd/resources/geo.rb

@@ -84,20 +84,21 @@ module TBD
   # vertices and wire.
   #
   # @param model [Topolys::Model] a model
-  # @param pts [Array] a 1D array of 3D Topolys points (min 2x)
+  # @param pts [Array] a 1D array of 3D Topolys points (min 3x)
   #
   # @return [Hash] vx: 3D Topolys vertices Array; w: corresponding Topolys::Wire
   # @return [Hash] vx: nil; w: nil (if invalid input)
   def objects(model = nil, pts = [])
-    mth = "OSut::#{__callee__}"
+    mth = "TBD::#{__callee__}"
     cl  = Topolys::Model
     obj = { vx: nil, w: nil }
 
     return mismatch("model", model, cl, mth, DBG, obj)   unless model.is_a?(cl)
     return mismatch("points", pts, Array, mth, DBG, obj) unless pts.is_a?(Array)
 
-    log(DBG, "#{pts.size}? need +2 Topolys points (#{mth})") unless pts.size > 2
+    log(DBG, "#{pts.size}? need +3 Topolys points (#{mth})") unless pts.size > 2
     return obj                                               unless pts.size > 2
+
     obj[:vx] = model.get_vertices(pts)
     obj[:w ] = model.get_wire(obj[:vx])
 
@@ -109,14 +110,14 @@ module TBD
   # As a side effect, it will - if successful - also populate a Topolys 'model'
   # with Topolys vertices, wires, holes. In rare cases such as domes of tubular
   # daylighting devices (TDDs), kids may be 'unhinged', i.e. not on same 3D
-  # plane as 'dad(s)' - TBD corrects auch cases elsewhere.
+  # plane as 'dad(s)' - TBD corrects such cases elsewhere.
   #
   # @param model [Topolys::Model] a model
   # @param boys [Hash] a collection of TBD subsurfaces
   #
   # @return [Array] 3D Topolys wires of 'holes' (made by kids)
   def kids(model = nil, boys = {})
-    mth = "OSut::#{__callee__}"
+    mth = "TBD::#{__callee__}"
     cl  = Topolys::Model
     holes = []
 
@@ -146,7 +147,7 @@ module TBD
   #
   # @return [Array] 3D Topolys wires of 'holes' (made by kids)
   def dads(model = nil, pops = {})
-    mth   = "OSut::#{__callee__}"
+    mth   = "TBD::#{__callee__}"
     cl    = Topolys::Model
     holes = {}
 
@@ -183,7 +184,7 @@ module TBD
   # @return [Bool] true if successful
   # @return [Bool] false if invalid input
   def faces(s = {}, e = {})
-    mth = "OSut::#{__callee__}"
+    mth = "TBD::#{__callee__}"
 
     return mismatch("surfaces", s, Hash, mth, DBG, false)   unless s.is_a?(Hash)
     return mismatch("edges", e, Hash, mth, DBG, false)      unless e.is_a?(Hash)
@@ -211,6 +212,42 @@ module TBD
     true
   end
 
+  ##
+  # Validate whether an OpenStudio planar surface is safe for TBD to process.
+  #
+  # @param s [OpenStudio::Model::PlanarSurface] a surface
+  #
+  # @return [Bool] true if valid surface
+  def validate(s = nil)
+    mth = "TBD::#{__callee__}"
+    cl = OpenStudio::Model::PlanarSurface
+
+    return mismatch("surface", s, cl, mth, DBG, false)        unless s.is_a?(cl)
+
+    id   = s.nameString
+    size = s.vertices.size
+    last = size - 1
+
+    log(ERR, "#{id} #{size} vertices? need +3 (#{mth})")         unless size > 2
+    return false                                                 unless size > 2
+
+    [0, last].each do |i|
+      v1 = s.vertices[i]
+      v2 = s.vertices[i + 1]                                    unless i == last
+      v2 = s.vertices.first                                         if i == last
+      vector = v2 - v1
+      bad = vector.length < TOL
+
+      # As is, this comparison also catches collinear vertices (< 10mm apart)
+      # along an edge. Should avoid red-flagging such cases. TO DO.
+      log(ERR, "#{id}: < #{TOL}m (#{mth})")                               if bad
+      return false                                                        if bad
+    end
+
+    # Add as many extra tests as needed ...
+    true
+  end
+
   ##
   # Return site-specific (or true) Topolys normal vector of OpenStudio surface.
   #
@@ -250,6 +287,8 @@ module TBD
     return mismatch("model", model, cl1, mth)          unless model.is_a?(cl1)
     return mismatch("surface", surface, cl2, mth)      unless surface.is_a?(cl2)
 
+    return nil unless validate(surface)
+
     nom    = surface.nameString
     surf   = {}
     subs   = {}
@@ -307,6 +346,8 @@ module TBD
     surf[:gross      ] = surface.grossArea
 
     surface.subSurfaces.sort_by { |s| s.nameString }.each do |s|
+      next unless validate(s)
+
       id       = s.nameString
       valid    = s.vertices.size == 3 || s.vertices.size == 4
       log(ERR, "Skipping '#{id}': vertex # 3 or 4 (#{mth})")        unless valid
@@ -334,7 +375,7 @@ module TBD
       log(ERR, "Skipping '#{id}': missing construction (#{mth})")    if c.empty?
       next                                                           if c.empty?
       c = c.get.to_LayeredConstruction
-      log(ERR, "Skipping '#{id}': must be a #{cl3} (#{mth})")        if c.empty?
+      log(WRN, "Skipping '#{id}': subs limited to #{cl3} (#{mth})")  if c.empty?
       next                                                           if c.empty?
       c = c.get
 
@@ -630,7 +671,7 @@ module TBD
         end
 
         foundation = OpenStudio::Model::FoundationKiva.new(model)
-        foundation.setName("KIVA Foundation Floor '#{id}'")
+        foundation.setName("KIVA Foundation Floor #{id}")
 
         floor = model.getSurfaceByName(id)
         kiva  = false if floor.empty?

data/lib/measures/tbd/resources/psi.rb

@@ -205,7 +205,7 @@ module TBD
         rimjoist:      0.300, # *
         parapet:       0.325, # *
         fenestration:  0.200, # *
-        corner:        0.300, # ** "regular (BETBG)", adj. for ext. dimensions
+        corner:        0.300, # ** not explicitely stated
         balcony:       0.500, # *
         party:         0.450, # *
         grade:         0.450, # *
@@ -219,7 +219,7 @@ module TBD
         rimjoist:      0.850, # *
         parapet:       0.800, # *
         fenestration:  0.500, # *
-        corner:        0.850, # ** ... not stated
+        corner:        0.850, # ** not explicitely stated
         balcony:       1.000, # *
         party:         0.850, # *
         grade:         0.850, # *
@@ -569,16 +569,21 @@ module TBD
     return mismatch("argh", s, Hash, mth, DBG, ipt)      unless argh.is_a?(Hash)
     return hashkey("argh", argh, opt, mth, DBG, ipt)     unless argh.key?(opt)
 
-    argh[:io_path]     = nil unless argh.key?(:io_path)
+    argh[:io_path    ] = nil unless argh.key?(:io_path)
     argh[:schema_path] = nil unless argh.key?(:schema_path)
-    pth = argh[:io_path]
+
+    pth = argh[:io_path    ]
     sch = argh[:schema_path]
 
-    if pth
-      return empty("JSON file", mth, FTL, ipt) unless File.size?(pth)
-      io = File.read(pth)
-      io = JSON.parse(io, symbolize_names: true)
-      return mismatch("io", io, Hash, mth, FTL, ipt) unless io.is_a?(Hash)
+    if pth && (pth.is_a?(String) || pth.is_a?(Hash))
+      if pth.is_a?(Hash)
+        io = pth
+      else
+        return empty("JSON file", mth, FTL, ipt) unless File.size?(pth)
+        io = File.read(pth)
+        io = JSON.parse(io, symbolize_names: true)
+        return mismatch("io", io, Hash, mth, FTL, ipt) unless io.is_a?(Hash)
+      end
 
       # Schema validation is not yet supported in the OpenStudio Application.
       # We nonetheless recommend that users rely on the json-schema gem, or an
@@ -844,7 +849,7 @@ module TBD
       up   = ""
       up   = "uprated "                     if m.nameString.include?(" uprated")
       m    = m.clone(model).to_MasslessOpaqueMaterial.get
-             m.setName("'#{id}' #{up}m tbd")
+             m.setName("#{id} #{up}m tbd")
       de_r = 0.001                                           unless de_r > 0.001
       loss = (de_u - 1 / de_r) * s[:net]                     unless de_r > 0.001
              m.setThermalResistance(de_r)
@@ -855,7 +860,7 @@ module TBD
       up   = ""
       up   = "uprated "                     if m.nameString.include?(" uprated")
       m    = m.clone(model).to_StandardOpaqueMaterial.get
-             m.setName("'#{id}' #{up}m tbd")
+             m.setName("#{id} #{up}m tbd")
       k    = m.thermalConductivity
 
       if de_r > 0.001
@@ -1105,6 +1110,10 @@ module TBD
       horizontal = dz.abs < TOL
       vertical   = dx < TOL && dy < TOL
       edge_V     = terminal - origin
+
+      invalid("1x edge length < TOL", mth, 0, ERROR) if edge_V.magnitude < TOL
+      next                                           if edge_V.magnitude < TOL
+
       edge_plane = Topolys::Plane3D.new(origin, edge_V)
 
       if vertical
@@ -1120,71 +1129,77 @@ module TBD
         # Loop through each linked wire and determine farthest point from
         # edge while ensuring candidate point is not aligned with edge.
         t_model.wires.each do |wire|
-          if surface[:wire] == wire.id          # there should be a unique match
-            normal     = tbd[:surfaces][id][:n]   if tbd[:surfaces].key?(id)
-            normal     = holes[id].attributes[:n] if holes.key?(id)
-            normal     = shades[id][:n]           if shades.key?(id)
-            farthest   = Topolys::Point3D.new(origin.x, origin.y, origin.z)
-            farthest_V = farthest - origin           # zero magnitude, initially
-            inverted   = false
-            i_origin   = wire.points.index(origin)
-            i_terminal = wire.points.index(terminal)
-            i_last     = wire.points.size - 1
-
-            if i_terminal == 0
-              inverted = true unless i_origin == i_last
-            elsif i_origin == i_last
-              inverted = true unless i_terminal == 0
+          next unless surface[:wire] == wire.id       # should be a unique match
+          normal     = tbd[:surfaces][id][:n]   if tbd[:surfaces].key?(id)
+          normal     = holes[id].attributes[:n] if holes.key?(id)
+          normal     = shades[id][:n]           if shades.key?(id)
+          farthest   = Topolys::Point3D.new(origin.x, origin.y, origin.z)
+          farthest_V = farthest - origin             # zero magnitude, initially
+          inverted   = false
+          i_origin   = wire.points.index(origin)
+          i_terminal = wire.points.index(terminal)
+          i_last     = wire.points.size - 1
+
+          if i_terminal == 0
+            inverted = true unless i_origin == i_last
+          elsif i_origin == i_last
+            inverted = true unless i_terminal == 0
+          else
+            inverted = true unless i_terminal - i_origin == 1
+          end
+
+          wire.points.each do |point|
+            next if point == origin
+            next if point == terminal
+
+            point_on_plane    = edge_plane.project(point)
+            origin_point_V    = point_on_plane - origin
+            point_V_magnitude = origin_point_V.magnitude
+            next unless point_V_magnitude > TOL
+
+            # Generate a plane between origin, terminal & point. Only consider
+            # planes that share the same normal as wire.
+            if inverted
+              plane = Topolys::Plane3D.from_points(terminal, origin, point)
             else
-              inverted = true unless i_terminal - i_origin == 1
+              plane = Topolys::Plane3D.from_points(origin, terminal, point)
             end
 
-            wire.points.each do |point|
-              next if point == origin
-              next if point == terminal
-              point_on_plane = edge_plane.project(point)
-              origin_point_V = point_on_plane - origin
-              point_V_magnitude = origin_point_V.magnitude
-              next unless point_V_magnitude > TOL
-
-              # Generate a plane between origin, terminal & point. Only consider
-              # planes that share the same normal as wire.
-              if inverted
-                plane = Topolys::Plane3D.from_points(terminal, origin, point)
-              else
-                plane = Topolys::Plane3D.from_points(origin, terminal, point)
-              end
+            next unless (normal.x - plane.normal.x).abs < TOL &&
+                        (normal.y - plane.normal.y).abs < TOL &&
+                        (normal.z - plane.normal.z).abs < TOL
 
-              next unless (normal.x - plane.normal.x).abs < TOL &&
-                          (normal.y - plane.normal.y).abs < TOL &&
-                          (normal.z - plane.normal.z).abs < TOL
+            farther    = point_V_magnitude > farthest_V.magnitude
+            farthest   = point          if farther
+            farthest_V = origin_point_V if farther
+          end
 
-              farther    = point_V_magnitude > farthest_V.magnitude
-              farthest   = point          if farther
-              farthest_V = origin_point_V if farther
-            end
+          puts "ADDITION!!"                      if id == "ADDITION"
+          puts "#{reference_V} vs #{farthest_V}" if id == "ADDITION"
 
-            angle = reference_V.angle(farthest_V)
-            adjust = false              # adjust angle [180°, 360°] if necessary
+          angle = reference_V.angle(farthest_V)
+          invalid("#{id} polar angle", mth, 0, ERROR, 0) if angle.nil?
+          angle = 0                                      if angle.nil?
 
-            if vertical
+          adjust = false              # adjust angle [180°, 360°] if necessary
+
+          if vertical
+            adjust = true if east.dot(farthest_V) < -TOL
+          else
+            if north.dot(farthest_V).abs < TOL ||
+              (north.dot(farthest_V).abs - 1).abs < TOL
               adjust = true if east.dot(farthest_V) < -TOL
             else
-              if north.dot(farthest_V).abs < TOL ||
-                (north.dot(farthest_V).abs - 1).abs < TOL
-                adjust = true if east.dot(farthest_V) < -TOL
-              else
-                adjust = true if north.dot(farthest_V) < -TOL
-              end
+              adjust = true if north.dot(farthest_V) < -TOL
             end
-
-            angle = 2 * Math::PI - angle if adjust
-            angle -= 2 * Math::PI if (angle - 2 * Math::PI).abs < TOL
-            surface[:angle] = angle
-            farthest_V.normalize!
-            surface[:polar] = farthest_V
-            surface[:normal] = normal
           end
+
+          angle  = 2 * Math::PI - angle if adjust
+          angle -= 2 * Math::PI         if (angle - 2 * Math::PI).abs < TOL
+          surface[:angle ] = angle
+          farthest_V.normalize!
+          surface[:polar ] = farthest_V
+          surface[:normal] = normal
         end                           # end of edge-linked, surface-to-wire loop
       end                                      # end of edge-linked surface loop
 
@@ -1993,8 +2008,6 @@ module TBD
   #
   # @return [Bool] true if TBD Measure is successful
   def exit(runner = nil, argh = {})
-    mth  = "TBD::#{__callee__}"
-
     # Generated files target a design context ( >= WARN ) ... change TBD log
     # level for debugging purposes. By default, log status is set < DBG
     # while log level is set @INF.

data/lib/measures/tbd/resources/ua.rb

@@ -62,30 +62,33 @@ module TBD
     return zero("'#{id}': net area (m2)", mth, ERR, res)      unless area > TOL
 
     # First, calculate initial layer RSi to initially meet Ut target.
-    rt    = 1 / ut                      #                 target construction Rt
-    ro    = rsi(lc, film)               #                current construction Ro
-    new_r = lyr[:r] + (rt - ro)         #              new, un-derated layer RSi
-    new_u = 1 / new_r
+    rt     = 1 / ut                      #                target construction Rt
+    ro     = rsi(lc, film)               #               current construction Ro
+    new_r  = lyr[:r] + (rt - ro)         #             new, un-derated layer RSi
+    new_u  = 1 / new_r
 
     # Then, uprate (if possible) to counter expected thermal bridging effects.
-    u_psi = hloss / area                #                         from psi & khi
-    new_u = new_u - u_psi               # uprated layer USi to counter psi & khi
-    new_r = 1 / new_u                   # uprated layer RSi to counter psi & khi
+    u_psi  = hloss / area               #                         from psi & khi
+    new_u -= u_psi                      # uprated layer USi to counter psi & khi
+    new_r  = 1 / new_u                  # uprated layer RSi to counter psi & khi
 
     return zero("'#{id}': new Rsi", mth, ERR, res)          unless new_r > 0.001
-    loss  = 0.0                         # residual heatloss (not assigned) [W/K]
+
+    loss   = 0.0                        # residual heatloss (not assigned) [W/K]
 
     if lyr[:type] == :massless
       m     = lc.getLayer(lyr[:index]).to_MasslessOpaqueMaterial
       return  invalid("'#{id}' massless layer?", mth, 0)             if m.empty?
+
       m     = m.get.clone(model).to_MasslessOpaqueMaterial.get
               m.setName("#{id} uprated")
       new_r = 0.001                                         unless new_r > 0.001
       loss  = (new_u - 1 / new_r) * area                    unless new_r > 0.001
               m.setThermalResistance(new_r)
     else                                                     # type == :standard
-      m       = lc.getLayer(lyr[:index]).to_StandardOpaqueMaterial
+      m     = lc.getLayer(lyr[:index]).to_StandardOpaqueMaterial
       return  invalid("'#{id}' standard layer?", mth, 0)             if m.empty?
+
       m     = m.get.clone(model).to_StandardOpaqueMaterial.get
               m.setName("#{id} uprated")
       k     = m.thermalConductivity
@@ -108,10 +111,12 @@ module TBD
 
       ok = m.setThickness(d)
       return invalid("Can't uprate '#{id}': > 3m", mth, 0, ERR, res)   unless ok
+
       m.setThermalConductivity(k)                                          if ok
     end
 
     return invalid("", mth, 0, ERR, res) unless m
+
     lc.setLayer(lyr[:index], m)
     uo = 1 / rsi(lc, film)
 
@@ -174,7 +179,6 @@ module TBD
       area = 0
       film = 100000000000000
       lc   = nil
-      uo   = nil
       id   = ""
       all  = g[:op].downcase == "all wall constructions"  ||
              g[:op].downcase == "all roof constructions"  ||
@@ -188,6 +192,7 @@ module TBD
           next unless sss.outsideBoundaryCondition.downcase == "outdoors"
           next     if sss.construction.empty?
           next     if sss.construction.get.to_LayeredConstruction.empty?
+
           c         = sss.construction.get.to_LayeredConstruction.get
           i         = c.nameString
 
@@ -236,7 +241,7 @@ module TBD
       end
 
       if coll.empty?
-        log(ERR, "No construction to uprate - skipping (#{mth})")
+        log(ERR, "No #{label} construction to uprate - skipping (#{mth})")
         next
       elsif lc                    # valid layered construction - good to uprate!
         # Ensure lc is referenced by surface types == label.
@@ -948,7 +953,7 @@ module TBD
       model  = "* modèle : #{ua[:file]}"       if ua.key?(:file)  && lang == :fr
       model += " (v#{ua[:version]})"           if ua.key?(:version)
       report << model                      unless model.empty?
-      report << "* TBD : v3.0.2"
+      report << "* TBD : v3.1.0"
       report << "* date : #{ua[:date]}"
 
       if lang == :en

data/lib/tbd/geo.rb

@@ -84,20 +84,21 @@ module TBD
   # vertices and wire.
   #
   # @param model [Topolys::Model] a model
-  # @param pts [Array] a 1D array of 3D Topolys points (min 2x)
+  # @param pts [Array] a 1D array of 3D Topolys points (min 3x)
   #
   # @return [Hash] vx: 3D Topolys vertices Array; w: corresponding Topolys::Wire
   # @return [Hash] vx: nil; w: nil (if invalid input)
   def objects(model = nil, pts = [])
-    mth = "OSut::#{__callee__}"
+    mth = "TBD::#{__callee__}"
     cl  = Topolys::Model
     obj = { vx: nil, w: nil }
 
     return mismatch("model", model, cl, mth, DBG, obj)   unless model.is_a?(cl)
     return mismatch("points", pts, Array, mth, DBG, obj) unless pts.is_a?(Array)
 
-    log(DBG, "#{pts.size}? need +2 Topolys points (#{mth})") unless pts.size > 2
+    log(DBG, "#{pts.size}? need +3 Topolys points (#{mth})") unless pts.size > 2
     return obj                                               unless pts.size > 2
+
     obj[:vx] = model.get_vertices(pts)
     obj[:w ] = model.get_wire(obj[:vx])
 
@@ -109,14 +110,14 @@ module TBD
   # As a side effect, it will - if successful - also populate a Topolys 'model'
   # with Topolys vertices, wires, holes. In rare cases such as domes of tubular
   # daylighting devices (TDDs), kids may be 'unhinged', i.e. not on same 3D
-  # plane as 'dad(s)' - TBD corrects auch cases elsewhere.
+  # plane as 'dad(s)' - TBD corrects such cases elsewhere.
   #
   # @param model [Topolys::Model] a model
   # @param boys [Hash] a collection of TBD subsurfaces
   #
   # @return [Array] 3D Topolys wires of 'holes' (made by kids)
   def kids(model = nil, boys = {})
-    mth = "OSut::#{__callee__}"
+    mth = "TBD::#{__callee__}"
     cl  = Topolys::Model
     holes = []
 
@@ -146,7 +147,7 @@ module TBD
   #
   # @return [Array] 3D Topolys wires of 'holes' (made by kids)
   def dads(model = nil, pops = {})
-    mth   = "OSut::#{__callee__}"
+    mth   = "TBD::#{__callee__}"
     cl    = Topolys::Model
     holes = {}
 
@@ -183,7 +184,7 @@ module TBD
   # @return [Bool] true if successful
   # @return [Bool] false if invalid input
   def faces(s = {}, e = {})
-    mth = "OSut::#{__callee__}"
+    mth = "TBD::#{__callee__}"
 
     return mismatch("surfaces", s, Hash, mth, DBG, false)   unless s.is_a?(Hash)
     return mismatch("edges", e, Hash, mth, DBG, false)      unless e.is_a?(Hash)
@@ -211,6 +212,42 @@ module TBD
     true
   end
 
+  ##
+  # Validate whether an OpenStudio planar surface is safe for TBD to process.
+  #
+  # @param s [OpenStudio::Model::PlanarSurface] a surface
+  #
+  # @return [Bool] true if valid surface
+  def validate(s = nil)
+    mth = "TBD::#{__callee__}"
+    cl = OpenStudio::Model::PlanarSurface
+
+    return mismatch("surface", s, cl, mth, DBG, false)        unless s.is_a?(cl)
+
+    id   = s.nameString
+    size = s.vertices.size
+    last = size - 1
+
+    log(ERR, "#{id} #{size} vertices? need +3 (#{mth})")         unless size > 2
+    return false                                                 unless size > 2
+
+    [0, last].each do |i|
+      v1 = s.vertices[i]
+      v2 = s.vertices[i + 1]                                    unless i == last
+      v2 = s.vertices.first                                         if i == last
+      vector = v2 - v1
+      bad = vector.length < TOL
+
+      # As is, this comparison also catches collinear vertices (< 10mm apart)
+      # along an edge. Should avoid red-flagging such cases. TO DO.
+      log(ERR, "#{id}: < #{TOL}m (#{mth})")                               if bad
+      return false                                                        if bad
+    end
+
+    # Add as many extra tests as needed ...
+    true
+  end
+
   ##
   # Return site-specific (or true) Topolys normal vector of OpenStudio surface.
   #
@@ -250,6 +287,8 @@ module TBD
     return mismatch("model", model, cl1, mth)          unless model.is_a?(cl1)
     return mismatch("surface", surface, cl2, mth)      unless surface.is_a?(cl2)
 
+    return nil unless validate(surface)
+
     nom    = surface.nameString
     surf   = {}
     subs   = {}
@@ -307,6 +346,8 @@ module TBD
     surf[:gross      ] = surface.grossArea
 
     surface.subSurfaces.sort_by { |s| s.nameString }.each do |s|
+      next unless validate(s)
+
       id       = s.nameString
       valid    = s.vertices.size == 3 || s.vertices.size == 4
       log(ERR, "Skipping '#{id}': vertex # 3 or 4 (#{mth})")        unless valid
@@ -334,7 +375,7 @@ module TBD
       log(ERR, "Skipping '#{id}': missing construction (#{mth})")    if c.empty?
       next                                                           if c.empty?
       c = c.get.to_LayeredConstruction
-      log(ERR, "Skipping '#{id}': must be a #{cl3} (#{mth})")        if c.empty?
+      log(WRN, "Skipping '#{id}': subs limited to #{cl3} (#{mth})")  if c.empty?
       next                                                           if c.empty?
       c = c.get
 
@@ -630,7 +671,7 @@ module TBD
         end
 
         foundation = OpenStudio::Model::FoundationKiva.new(model)
-        foundation.setName("KIVA Foundation Floor '#{id}'")
+        foundation.setName("KIVA Foundation Floor #{id}")
 
         floor = model.getSurfaceByName(id)
         kiva  = false if floor.empty?

data/lib/tbd/psi.rb

@@ -205,7 +205,7 @@ module TBD
         rimjoist:      0.300, # *
         parapet:       0.325, # *
         fenestration:  0.200, # *
-        corner:        0.300, # ** "regular (BETBG)", adj. for ext. dimensions
+        corner:        0.300, # ** not explicitely stated
         balcony:       0.500, # *
         party:         0.450, # *
         grade:         0.450, # *
@@ -219,7 +219,7 @@ module TBD
         rimjoist:      0.850, # *
         parapet:       0.800, # *
         fenestration:  0.500, # *
-        corner:        0.850, # ** ... not stated
+        corner:        0.850, # ** not explicitely stated
         balcony:       1.000, # *
         party:         0.850, # *
         grade:         0.850, # *
@@ -569,16 +569,21 @@ module TBD
     return mismatch("argh", s, Hash, mth, DBG, ipt)      unless argh.is_a?(Hash)
     return hashkey("argh", argh, opt, mth, DBG, ipt)     unless argh.key?(opt)
 
-    argh[:io_path]     = nil unless argh.key?(:io_path)
+    argh[:io_path    ] = nil unless argh.key?(:io_path)
     argh[:schema_path] = nil unless argh.key?(:schema_path)
-    pth = argh[:io_path]
+
+    pth = argh[:io_path    ]
     sch = argh[:schema_path]
 
-    if pth
-      return empty("JSON file", mth, FTL, ipt) unless File.size?(pth)
-      io = File.read(pth)
-      io = JSON.parse(io, symbolize_names: true)
-      return mismatch("io", io, Hash, mth, FTL, ipt) unless io.is_a?(Hash)
+    if pth && (pth.is_a?(String) || pth.is_a?(Hash))
+      if pth.is_a?(Hash)
+        io = pth
+      else
+        return empty("JSON file", mth, FTL, ipt) unless File.size?(pth)
+        io = File.read(pth)
+        io = JSON.parse(io, symbolize_names: true)
+        return mismatch("io", io, Hash, mth, FTL, ipt) unless io.is_a?(Hash)
+      end
 
       # Schema validation is not yet supported in the OpenStudio Application.
       # We nonetheless recommend that users rely on the json-schema gem, or an
@@ -844,7 +849,7 @@ module TBD
       up   = ""
       up   = "uprated "                     if m.nameString.include?(" uprated")
       m    = m.clone(model).to_MasslessOpaqueMaterial.get
-             m.setName("'#{id}' #{up}m tbd")
+             m.setName("#{id} #{up}m tbd")
       de_r = 0.001                                           unless de_r > 0.001
       loss = (de_u - 1 / de_r) * s[:net]                     unless de_r > 0.001
              m.setThermalResistance(de_r)
@@ -855,7 +860,7 @@ module TBD
       up   = ""
       up   = "uprated "                     if m.nameString.include?(" uprated")
       m    = m.clone(model).to_StandardOpaqueMaterial.get
-             m.setName("'#{id}' #{up}m tbd")
+             m.setName("#{id} #{up}m tbd")
       k    = m.thermalConductivity
 
       if de_r > 0.001
@@ -1105,6 +1110,10 @@ module TBD
       horizontal = dz.abs < TOL
       vertical   = dx < TOL && dy < TOL
       edge_V     = terminal - origin
+
+      invalid("1x edge length < TOL", mth, 0, ERROR) if edge_V.magnitude < TOL
+      next                                           if edge_V.magnitude < TOL
+
       edge_plane = Topolys::Plane3D.new(origin, edge_V)
 
       if vertical
@@ -1120,71 +1129,77 @@ module TBD
         # Loop through each linked wire and determine farthest point from
         # edge while ensuring candidate point is not aligned with edge.
         t_model.wires.each do |wire|
-          if surface[:wire] == wire.id          # there should be a unique match
-            normal     = tbd[:surfaces][id][:n]   if tbd[:surfaces].key?(id)
-            normal     = holes[id].attributes[:n] if holes.key?(id)
-            normal     = shades[id][:n]           if shades.key?(id)
-            farthest   = Topolys::Point3D.new(origin.x, origin.y, origin.z)
-            farthest_V = farthest - origin           # zero magnitude, initially
-            inverted   = false
-            i_origin   = wire.points.index(origin)
-            i_terminal = wire.points.index(terminal)
-            i_last     = wire.points.size - 1
-
-            if i_terminal == 0
-              inverted = true unless i_origin == i_last
-            elsif i_origin == i_last
-              inverted = true unless i_terminal == 0
+          next unless surface[:wire] == wire.id       # should be a unique match
+          normal     = tbd[:surfaces][id][:n]   if tbd[:surfaces].key?(id)
+          normal     = holes[id].attributes[:n] if holes.key?(id)
+          normal     = shades[id][:n]           if shades.key?(id)
+          farthest   = Topolys::Point3D.new(origin.x, origin.y, origin.z)
+          farthest_V = farthest - origin             # zero magnitude, initially
+          inverted   = false
+          i_origin   = wire.points.index(origin)
+          i_terminal = wire.points.index(terminal)
+          i_last     = wire.points.size - 1
+
+          if i_terminal == 0
+            inverted = true unless i_origin == i_last
+          elsif i_origin == i_last
+            inverted = true unless i_terminal == 0
+          else
+            inverted = true unless i_terminal - i_origin == 1
+          end
+
+          wire.points.each do |point|
+            next if point == origin
+            next if point == terminal
+
+            point_on_plane    = edge_plane.project(point)
+            origin_point_V    = point_on_plane - origin
+            point_V_magnitude = origin_point_V.magnitude
+            next unless point_V_magnitude > TOL
+
+            # Generate a plane between origin, terminal & point. Only consider
+            # planes that share the same normal as wire.
+            if inverted
+              plane = Topolys::Plane3D.from_points(terminal, origin, point)
             else
-              inverted = true unless i_terminal - i_origin == 1
+              plane = Topolys::Plane3D.from_points(origin, terminal, point)
             end
 
-            wire.points.each do |point|
-              next if point == origin
-              next if point == terminal
-              point_on_plane = edge_plane.project(point)
-              origin_point_V = point_on_plane - origin
-              point_V_magnitude = origin_point_V.magnitude
-              next unless point_V_magnitude > TOL
-
-              # Generate a plane between origin, terminal & point. Only consider
-              # planes that share the same normal as wire.
-              if inverted
-                plane = Topolys::Plane3D.from_points(terminal, origin, point)
-              else
-                plane = Topolys::Plane3D.from_points(origin, terminal, point)
-              end
+            next unless (normal.x - plane.normal.x).abs < TOL &&
+                        (normal.y - plane.normal.y).abs < TOL &&
+                        (normal.z - plane.normal.z).abs < TOL
 
-              next unless (normal.x - plane.normal.x).abs < TOL &&
-                          (normal.y - plane.normal.y).abs < TOL &&
-                          (normal.z - plane.normal.z).abs < TOL
+            farther    = point_V_magnitude > farthest_V.magnitude
+            farthest   = point          if farther
+            farthest_V = origin_point_V if farther
+          end
 
-              farther    = point_V_magnitude > farthest_V.magnitude
-              farthest   = point          if farther
-              farthest_V = origin_point_V if farther
-            end
+          puts "ADDITION!!"                      if id == "ADDITION"
+          puts "#{reference_V} vs #{farthest_V}" if id == "ADDITION"
 
-            angle = reference_V.angle(farthest_V)
-            adjust = false              # adjust angle [180°, 360°] if necessary
+          angle = reference_V.angle(farthest_V)
+          invalid("#{id} polar angle", mth, 0, ERROR, 0) if angle.nil?
+          angle = 0                                      if angle.nil?
 
-            if vertical
+          adjust = false              # adjust angle [180°, 360°] if necessary
+
+          if vertical
+            adjust = true if east.dot(farthest_V) < -TOL
+          else
+            if north.dot(farthest_V).abs < TOL ||
+              (north.dot(farthest_V).abs - 1).abs < TOL
               adjust = true if east.dot(farthest_V) < -TOL
             else
-              if north.dot(farthest_V).abs < TOL ||
-                (north.dot(farthest_V).abs - 1).abs < TOL
-                adjust = true if east.dot(farthest_V) < -TOL
-              else
-                adjust = true if north.dot(farthest_V) < -TOL
-              end
+              adjust = true if north.dot(farthest_V) < -TOL
             end
-
-            angle = 2 * Math::PI - angle if adjust
-            angle -= 2 * Math::PI if (angle - 2 * Math::PI).abs < TOL
-            surface[:angle] = angle
-            farthest_V.normalize!
-            surface[:polar] = farthest_V
-            surface[:normal] = normal
           end
+
+          angle  = 2 * Math::PI - angle if adjust
+          angle -= 2 * Math::PI         if (angle - 2 * Math::PI).abs < TOL
+          surface[:angle ] = angle
+          farthest_V.normalize!
+          surface[:polar ] = farthest_V
+          surface[:normal] = normal
         end                           # end of edge-linked, surface-to-wire loop
       end                                      # end of edge-linked surface loop
 
@@ -1993,8 +2008,6 @@ module TBD
   #
   # @return [Bool] true if TBD Measure is successful
   def exit(runner = nil, argh = {})
-    mth  = "TBD::#{__callee__}"
-
     # Generated files target a design context ( >= WARN ) ... change TBD log
     # level for debugging purposes. By default, log status is set < DBG
     # while log level is set @INF.

data/lib/tbd/ua.rb

@@ -62,30 +62,33 @@ module TBD
     return zero("'#{id}': net area (m2)", mth, ERR, res)      unless area > TOL
 
     # First, calculate initial layer RSi to initially meet Ut target.
-    rt    = 1 / ut                      #                 target construction Rt
-    ro    = rsi(lc, film)               #                current construction Ro
-    new_r = lyr[:r] + (rt - ro)         #              new, un-derated layer RSi
-    new_u = 1 / new_r
+    rt     = 1 / ut                      #                target construction Rt
+    ro     = rsi(lc, film)               #               current construction Ro
+    new_r  = lyr[:r] + (rt - ro)         #             new, un-derated layer RSi
+    new_u  = 1 / new_r
 
     # Then, uprate (if possible) to counter expected thermal bridging effects.
-    u_psi = hloss / area                #                         from psi & khi
-    new_u = new_u - u_psi               # uprated layer USi to counter psi & khi
-    new_r = 1 / new_u                   # uprated layer RSi to counter psi & khi
+    u_psi  = hloss / area               #                         from psi & khi
+    new_u -= u_psi                      # uprated layer USi to counter psi & khi
+    new_r  = 1 / new_u                  # uprated layer RSi to counter psi & khi
 
     return zero("'#{id}': new Rsi", mth, ERR, res)          unless new_r > 0.001
-    loss  = 0.0                         # residual heatloss (not assigned) [W/K]
+
+    loss   = 0.0                        # residual heatloss (not assigned) [W/K]
 
     if lyr[:type] == :massless
       m     = lc.getLayer(lyr[:index]).to_MasslessOpaqueMaterial
       return  invalid("'#{id}' massless layer?", mth, 0)             if m.empty?
+
       m     = m.get.clone(model).to_MasslessOpaqueMaterial.get
               m.setName("#{id} uprated")
       new_r = 0.001                                         unless new_r > 0.001
       loss  = (new_u - 1 / new_r) * area                    unless new_r > 0.001
               m.setThermalResistance(new_r)
     else                                                     # type == :standard
-      m       = lc.getLayer(lyr[:index]).to_StandardOpaqueMaterial
+      m     = lc.getLayer(lyr[:index]).to_StandardOpaqueMaterial
       return  invalid("'#{id}' standard layer?", mth, 0)             if m.empty?
+
       m     = m.get.clone(model).to_StandardOpaqueMaterial.get
               m.setName("#{id} uprated")
       k     = m.thermalConductivity
@@ -108,10 +111,12 @@ module TBD
 
       ok = m.setThickness(d)
       return invalid("Can't uprate '#{id}': > 3m", mth, 0, ERR, res)   unless ok
+
       m.setThermalConductivity(k)                                          if ok
     end
 
     return invalid("", mth, 0, ERR, res) unless m
+
     lc.setLayer(lyr[:index], m)
     uo = 1 / rsi(lc, film)
 
@@ -174,7 +179,6 @@ module TBD
       area = 0
       film = 100000000000000
       lc   = nil
-      uo   = nil
       id   = ""
       all  = g[:op].downcase == "all wall constructions"  ||
              g[:op].downcase == "all roof constructions"  ||
@@ -188,6 +192,7 @@ module TBD
           next unless sss.outsideBoundaryCondition.downcase == "outdoors"
           next     if sss.construction.empty?
           next     if sss.construction.get.to_LayeredConstruction.empty?
+
           c         = sss.construction.get.to_LayeredConstruction.get
           i         = c.nameString
 
@@ -236,7 +241,7 @@ module TBD
       end
 
       if coll.empty?
-        log(ERR, "No construction to uprate - skipping (#{mth})")
+        log(ERR, "No #{label} construction to uprate - skipping (#{mth})")
         next
       elsif lc                    # valid layered construction - good to uprate!
         # Ensure lc is referenced by surface types == label.
@@ -948,7 +953,7 @@ module TBD
       model  = "* modèle : #{ua[:file]}"       if ua.key?(:file)  && lang == :fr
       model += " (v#{ua[:version]})"           if ua.key?(:version)
       report << model                      unless model.empty?
-      report << "* TBD : v3.0.2"
+      report << "* TBD : v3.1.0"
       report << "* date : #{ua[:date]}"
 
       if lang == :en

data/lib/tbd/version.rb

@@ -21,5 +21,5 @@
 # SOFTWARE.
 
 module TBD
-  VERSION = "3.0.2".freeze
+  VERSION = "3.1.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tbd
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.1.0
 platform: ruby
 authors:
 - Denis Bourgeois & Dan Macumber
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-19 00:00:00.000000000 Z
+date: 2022-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: topolys
@@ -124,13 +124,11 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
-- json/midrise.json
 - json/tbd_5ZoneNoHVAC.json
 - json/tbd_5ZoneNoHVAC_btap.json
 - json/tbd_seb_n2.json
 - json/tbd_seb_n4.json
 - json/tbd_warehouse10.json
-- json/tbd_warehouse5.json
 - lib/measures/tbd/LICENSE.md
 - lib/measures/tbd/README.md
 - lib/measures/tbd/README.md.erb
@@ -163,7 +161,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/rd2/tbd
-  source_code_uri: https://github.com/rd2/tbd/tree/v3.0.2
+  source_code_uri: https://github.com/rd2/tbd/tree/v3.1.0
   bug_tracker_uri: https://github.com/rd2/tbd/issues
 post_install_message:
 rdoc_options: []

data/json/midrise.json

@@ -1,64 +0,0 @@
-{
-  "schema": "https://github.com/rd2/tbd/blob/master/tbd.schema.json",
-  "description": "sorting out multiple story PSI sets (midrise)",
-  "psis": [{
-      "id": "compliant",
-      "rimjoist": 0.3,
-      "parapet": 0.325,
-      "fenestration": 0.35,
-      "corner": 0.45,
-      "balcony": 0.5,
-      "party": 0.5,
-      "grade": 0.45
-    },
-    {
-      "id": "Building Story 1",
-      "rimjoist": 0.501,
-      "parapet": 0.511,
-      "fenestration": 0.521,
-      "cornerconcave": 0.531,
-      "cornerconvex": 0.541,
-      "balcony": 0.551,
-      "party": 0.561,
-      "grade": 0.571
-    },
-    {
-      "id": "Building Story 2",
-      "rimjoist": 0.401,
-      "parapet": 0.411,
-      "fenestration": 0.421,
-      "cornerconcave": 0.431,
-      "cornerconvex": 0.441,
-      "balcony": 0.451,
-      "party": 0.461,
-      "grade": 0.471
-    },
-    {
-      "id": "Building Story 3",
-      "rimjoist": 0.301,
-      "parapet": 0.311,
-      "fenestration": 0.321,
-      "cornerconcave": 0.331,
-      "cornerconvex": 0.341,
-      "balcony": 0.351,
-      "party": 0.361,
-      "grade": 0.371
-    }
-  ],
-  "building": {
-    "psi": "compliant"
-  },
-  "stories": [{
-      "id": "Building Story 1",
-      "psi": "Building Story 1"
-    },
-    {
-      "id": "Building Story 2",
-      "psi": "Building Story 2"
-    },
-    {
-      "id": "Building Story 3",
-      "psi": "Building Story 3"
-    }
-  ]
-}

data/json/tbd_warehouse5.json

@@ -1,37 +0,0 @@
-{
-  "schema": "https://github.com/rd2/tbd/blob/master/tbd.schema.json",
-  "description": "test_warehouse.osm with spacetype PSI values",
-  "psis": [{
-      "id": "Warehouse Office",
-      "rimjoist": 0.300,
-      "parapet": 0.300,
-      "fenestration": 0.300,
-      "corner": 0.300,
-      "balcony": 0.300,
-      "party": 0.300,
-      "grade": 0.300
-    },
-    {
-      "id": "Warehouse Fine",
-      "rimjoist": 0.500,
-      "parapet": 0.500,
-      "fenestration": 0.500,
-      "corner": 0.500,
-      "balcony": 0.500,
-      "party": 0.500,
-      "grade": 0.500
-    }
-  ],
-  "building": {
-    "psi": "regular (BETBG)"
-  },
-  "spacetypes": [{
-      "id": "Warehouse Office",
-      "psi": "Warehouse Office"
-    },
-    {
-      "id": "Warehouse Fine",
-      "psi": "Warehouse Fine"
-    }
-  ]
-}