osut 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ea46a9a2d17127040f1933761a1142361b39f90043de32109d82e19af28c69a
-  data.tar.gz: 392f9d8d844048aeb8d1473cd5c2774f1284eb6c7dbcc33f8c0788d4e284f65e
+  metadata.gz: d67484d6fd3ebaad383a6c13e74bbb1e18f0aafe0f256e82b75143e8f4111b72
+  data.tar.gz: 35fb870a56b7cc8822606033e1193bc879c3accbc0075dfb60474f00ae29d0cf
 SHA512:
-  metadata.gz: abd0cff011de389aa65724873db058be5ff6a1637e0f12795083c252f17bb3b7a415684095db541b2b8d77a66bb63303ea33d9e161ac69500b2c0124e4023106
-  data.tar.gz: 1127c3e2e5e6f9976cebd2ff9538f01cb2f90185972f220ffb156f9c88ff98cd45b1dc2a057721b66fc76c08875981d9df84cfc2469daa5fc42d64fa84c2cf03
+  metadata.gz: c98c740e66d3b860b094c45b7c8fb61d650f185b2a26cee2e994bc086a81be9356a88f78852c5a06fff40ed0e147c402f49ab09d5c9b92faa3003ff99f81372a
+  data.tar.gz: bac75a7581ff73142d09652d20993feff817e692fc59ef2cd99391bb7dd8b93e7c2e48892828b5667ed22f1c1a1b0b41dae6f3eb8631b395139ef511cfdf0e82

data/.github/workflows/pull_request.yml

@@ -70,7 +70,7 @@ jobs:
         docker exec -t test bundle update
         docker exec -t test bundle exec rake
         docker kill test
-  test_380x:
+  test_390x:
     runs-on: ubuntu-22.04
     steps:
     - name: Check out repository
@@ -79,14 +79,14 @@ jobs:
       run: |
         echo $(pwd)
         echo $(ls)
-        docker pull nrel/openstudio:3.8.0
-        docker run --name test --rm -d -t -v $(pwd):/work -w /work nrel/openstudio:3.8.0
+        docker pull nrel/openstudio:3.9.0
+        docker run --name test --rm -d -t -v $(pwd):/work -w /work nrel/openstudio:3.9.0
         docker exec -t test pwd
         docker exec -t test ls
         docker exec -t test bundle update
         docker exec -t test bundle exec rake
         docker kill test
-  test_390x:
+  test_310x:
     runs-on: ubuntu-22.04
     steps:
     - name: Check out repository
@@ -95,14 +95,14 @@ jobs:
       run: |
         echo $(pwd)
         echo $(ls)
-        docker pull nrel/openstudio:3.9.0
-        docker run --name test --rm -d -t -v $(pwd):/work -w /work nrel/openstudio:3.9.0
+        docker pull nrel/openstudio:3.10.0
+        docker run --name test --rm -d -t -v $(pwd):/work -w /work nrel/openstudio:3.10.0
         docker exec -t test pwd
         docker exec -t test ls
         docker exec -t test bundle update
         docker exec -t test bundle exec rake
         docker kill test
-  test_3100x:
+  test_311x:
     runs-on: ubuntu-22.04
     steps:
     - name: Check out repository
@@ -111,8 +111,8 @@ jobs:
       run: |
         echo $(pwd)
         echo $(ls)
-        docker pull nrel/openstudio:3.10.0
-        docker run --name test --rm -d -t -v $(pwd):/work -w /work nrel/openstudio:3.10.0
+        docker pull nrel/openstudio:3.11.0
+        docker run --name test --rm -d -t -v $(pwd):/work -w /work nrel/openstudio:3.11.0
         docker exec -t test pwd
         docker exec -t test ls
         docker exec -t test bundle update

data/lib/osut/utils.rb

@@ -106,26 +106,28 @@ module OSut
   # default inside + outside air film resistances (m2.K/W)
   @@film = {
       shading: 0.000, # NA
-    partition: 0.150, # uninsulated wood- or steel-framed wall
-         wall: 0.150, # un/insulated wall
-         roof: 0.140, # un/insulated roof
-        floor: 0.190, # un/insulated (exposed) floor
-     basement: 0.120, # un/insulated basement wall
-         slab: 0.160, # un/insulated basement slab or slab-on-grade
+      ceiling: 0.266, # interzone floor/ceiling
+    partition: 0.239, # interzone wall partition
+         wall: 0.150, # exposed wall
+         roof: 0.135, # exposed roof
+        floor: 0.192, # exposed floor
+     basement: 0.120, # basement wall
+         slab: 0.162, # basement slab or slab-on-grade
          door: 0.150, # standard, 45mm insulated steel (opaque) door
        window: 0.150, # vertical fenestration, e.g. glazed doors, windows
-     skylight: 0.140  # e.g. domed 4' x 4' skylight
+     skylight: 0.135  # e.g. domed 4' x 4' skylight
   }.freeze
 
   # default (~1980s) envelope Uo (W/m2•K), based on surface type
   @@uo = {
       shading: nil,   # N/A
+      ceiling: nil,   # N/A
     partition: nil,   # N/A
          wall: 0.384, # rated R14.8 hr•ft2F/Btu
          roof: 0.327, # rated R17.6 hr•ft2F/Btu
         floor: 0.317, # rated R17.9 hr•ft2F/Btu (exposed floor)
-     basement: nil,
-         slab: nil,
+     basement: nil,   # N/A
+         slab: nil,   # N/A
          door: 1.800, # insulated, unglazed steel door (single layer)
        window: 2.800, # e.g. patio doors (simple glazing)
      skylight: 3.500  # all skylight technologies
@@ -197,6 +199,61 @@ module OSut
   @@mats[:door     ][:rho] =  600.000
   @@mats[:door     ][:cp ] = 1000.000
 
+  ##
+  # Returns surface air film resistance(s). Surface tilt-dependent values are
+  # returned if a valid surface tilt [0, PI] is provided. Otherwise, generic
+  # tilt-independent air film resistances are returned instead.
+  #
+  # @param [:to_sym] surface type, e.g. :roof, :wall, :partition, :ceiling
+  # @param [Numeric] surface tilt (in rad), optional
+  #
+  # @return [Float] surface air film resistance(s)
+  # @return [0.0] if invalid input (see logs)
+  def filmResistances(type = :wall, tilt = 2 * Math::PI)
+    mth = "OSut::#{__callee__}"
+
+    unless tilt.is_a?(Numeric)
+      return mismatch("tilt", tilt, Float, mth, DBG, 0.0)
+    end
+
+    unless type.respond_to?(:to_sym)
+      return mismatch("type", type, Symbol, mth, DBG, 0.0)
+    end
+
+    type = type.to_s.downcase.to_sym
+
+    unless @@film.key?(type)
+      return invalid("type", mth, 1, DBG, 0.0)
+    end
+
+    # Generic, tilt-independent values.
+    r = @@film[type]
+    return r if type == :shading
+
+    # Valid tilt?
+    if tilt.between?(0, Math::PI)
+      r = OpenStudio::Model::PlanarSurface.stillAirFilmResistance(tilt)
+      return r if type == :basement || type == :slab
+
+      if type == :ceiling || type == :partition
+        # Interzone. Fetch reciprocal tilt, e.g. if tilt == 0°, tiltx = 180°
+        tiltx = tilt + Math::PI
+
+        # Assuming tilt is contrained [0°, 180°] - constrain tiltx [0° 180°]:
+        #   e.g. tiltx == 210° if tilt ==  30°, so convert tiltx to 150°
+        #   e.g. tiltx == 330° if tilt == 150°, so convert tiltx to  30°
+        #   e.g. tiltx == 275° if tilt ==  95°, so convert tiltx to  85°
+        tiltx = Math::PI - tilt if tiltx > Math::PI
+
+        r += OpenStudio::Model::PlanarSurface.stillAirFilmResistance(tiltx)
+      else
+        r += 0.03 # "MOVINGAIR_15MPH"
+      end
+    end
+
+    r
+  end
+
   ##
   # Validates if every material in a layered construction is standard & opaque.
   #
@@ -470,7 +527,7 @@ module OSut
   ##
   # Resets a construction's Uo factor by adjusting its insulating layer
   # thermal conductivity, then if needed its thickness (or its RSi value if
-  # massless). Unless material uniquness is requested, a matching material is
+  # massless). Unless material uniqueness is requested, a matching material is
   # recovered instead of instantiating a new one. The latter is renamed
   # according to its adjusted conductivity/thickness (or RSi value).
   #
@@ -600,10 +657,6 @@ module OSut
     return mismatch("model", model, cl1, mth) unless model.is_a?(cl1)
     return mismatch("specs", specs, cl2, mth) unless specs.is_a?(cl2)
 
-    specs[:id] = "" unless specs.key?(:id)
-    id = trim(specs[:id])
-    id = "OSut:CON:#{specs[:type]}" if id.empty?
-
     if specs.key?(:type)
       unless @@uo.keys.include?(specs[:type])
         return invalid("surface type", mth, 2, ERR)
@@ -612,6 +665,10 @@ module OSut
       specs[:type] = :wall
     end
 
+    specs[:id] = "" unless specs.key?(:id)
+    id = trim(specs[:id])
+    id = "OSut:CON:#{specs[:type]}" if id.empty?
+
     specs[:uo] = @@uo[ specs[:type] ] unless specs.key?(:uo) # can be nil
     u = specs[:uo]
 
@@ -652,6 +709,35 @@ module OSut
       a[:compo][:mat] = @@mats[mt]
       a[:compo][:d  ] = d
       a[:compo][:id ] = "OSut:#{mt}:#{format('%03d', d*1000)[-3..-1]}"
+    when :ceiling
+      unless specs[:clad] == :none
+        mt = :concrete
+        mt = :material  if specs[:clad] == :light
+        d  = 0.015
+        d  = 0.100      if specs[:clad] == :medium
+        d  = 0.200      if specs[:clad] == :heavy
+        a[:clad][:mat] = @@mats[mt]
+        a[:clad][:d  ] = d
+        a[:clad][:id ] = "OSut:#{mt}:#{format('%03d', d*1000)[-3..-1]}"
+      end
+
+      mt = :mineral
+      mt = :polyiso   if specs[:frame] == :medium
+      mt = :cellulose if specs[:frame] == :heavy
+      mt = :material  unless u
+      d  = 0.100
+      d  = 0.015      unless u
+      a[:compo][:mat] = @@mats[mt]
+      a[:compo][:d  ] = d
+      a[:compo][:id ] = "OSut:#{mt}:#{format('%03d', d*1000)[-3..-1]}"
+
+      unless specs[:finish] == :none
+        mt = :material
+        d  = 0.015
+        a[:finish][:mat] = @@mats[mt]
+        a[:finish][:d  ] = d
+        a[:finish][:id ] = "OSut:#{mt}:#{format('%03d', d*1000)[-3..-1]}"
+      end
     when :partition
       unless specs[:clad] == :none
         d  = 0.015
@@ -4825,7 +4911,7 @@ module OSut
       end
     end
 
-    res = realignedFace(polyg.to_a.reverse)
+    res = realignedFace(polyg.to_a.reverse, true)
     return 0 if res[:box].nil?
 
     # A bounded box's 'height', at its narrowest, is its 'width'.
@@ -4904,7 +4990,7 @@ module OSut
       # to 'genAnchors'), it inherits key :out - a Hash holding (among others) a
       # 'realigned' set of points (by default a 'realigned' :box). The latter is
       # typically generated from an outdoor-facing roof (e.g. when called from
-      # 'lights'). Subsequent calls to 'genAnchors' may send (as first
+      # 'addSkylights'). Subsequent calls to 'genAnchors' may send (as first
       # argument) a corresponding ceiling tile below (also from 'addSkylights').
       # Roof vs ceiling may neither share alignment transformation nor space
       # site transformation identities. All subsequent calls to 'genAnchors'

data/lib/osut/version.rb

@@ -29,5 +29,5 @@
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 module OSut
-  VERSION = "0.8.1".freeze
+  VERSION = "0.9.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: osut
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Denis Bourgeois
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-01-03 00:00:00.000000000 Z
+date: 2026-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oslg
@@ -90,7 +90,7 @@ licenses:
 - BSD-3-Clause
 metadata:
   homepage_uri: https://github.com/rd2/osut
-  source_code_uri: https://github.com/rd2/osut/tree/v0.8.1
+  source_code_uri: https://github.com/rd2/osut/tree/v0.9.0
   bug_tracker_uri: https://github.com/rd2/osut/issues
 post_install_message:
 rdoc_options: []