honeybee-openstudio 2.17.5 → 2.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4856942358fea802404323b2df581961230c29b0de01d1993742dc2e9c4aaec
-  data.tar.gz: 5749259754899e511dd53f3cb4427986abc78bfb6de7f6af023829db9056c630
+  metadata.gz: fe82ab879bf620ce30c665948e97a2b078e8b3c5899cbecea1ae0cc0b319c80e
+  data.tar.gz: c86bad1a3e7fe7a0c7e8ccbe2900774a561a46056dae0450ed2998d2e29213b4
 SHA512:
-  metadata.gz: 573e2448b710a5591c2b2c648d96d6ee09b226a458b589d3a081f6ba1dd5a04cf42ac84f9e63b43bcfa77c09c54632b08d9c3391b14f502c447de9f18a1ffa72
-  data.tar.gz: 855685ea4d3387be760c97ca56a807bdd6a983be4a528a177784f52cbca182a5d5561eaed9c4ab0a3de71631ddf4633de79174d6bf421ef8c0094a531ca5a566
+  metadata.gz: a86ca8992989da3f1f4a5642b55ece1c920e0378a82d8bf55e6362546375cc9fb66f1d0d4e69e74c3803678a77c168b87b733f58a2851b2eafebac0db4386190
+  data.tar.gz: 67740da44c34b3408f248a7be3d6a02fb1c9c76524dec2a7cf9fda9755ee923baa443f5f65b136c0d0fcb4d7ca956a8ffe9130715b1369f3413a7534ad34f88f

data/honeybee-openstudio.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'honeybee-openstudio'
-  spec.version       = '2.17.5'
+  spec.version       = '2.18.0'
   spec.authors       = ['Tanushree Charan', 'Dan Macumber', 'Chris Mackey', 'Mostapha Sadeghipour Roudsari']
   spec.email         = ['tanushree.charan@nrel.gov', 'chris@ladybug.tools']
 

data/lib/from_openstudio.rb

@@ -43,6 +43,22 @@ require 'from_openstudio/geometry/face'
 require 'from_openstudio/geometry/room'
 require 'from_openstudio/geometry/shade'
 
+# extend the construction objects
+require 'from_openstudio/construction/opaque'
+require 'from_openstudio/construction/window'
+require 'from_openstudio/construction/shade'
+require 'from_openstudio/construction/air'
+
+# import the material objects
+require 'from_openstudio/material/opaque'
+require 'from_openstudio/material/opaque_no_mass'
+require 'from_openstudio/material/window_gas'
+require 'from_openstudio/material/window_gas_mixture'
+require 'from_openstudio/material/window_gas_custom'
+require 'from_openstudio/material/window_blind'
+require 'from_openstudio/material/window_glazing'
+require 'from_openstudio/material/window_simpleglazsys'
+
 # extend the simulation objects
 require 'from_openstudio/simulation/design_day'
 require 'from_openstudio/simulation/parameter_model'

data/lib/from_openstudio/construction/air.rb

@@ -0,0 +1,55 @@
+# *******************************************************************************
+# Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable
+# Energy, LLC, Ladybug Tools LLC and other contributors. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# (1) Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# (2) Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# (3) Neither the name of the copyright holder nor the names of any contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission from the respective party.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE
+# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
+# THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+# OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# *******************************************************************************
+
+require 'honeybee/construction/air'
+require 'to_openstudio/model_object'
+
+module Honeybee
+  class AirBoundaryConstructionAbridged < ModelObject
+
+    def self.from_construction(construction)
+        # create an empty hash
+        hash = {}
+        hash[:type] = 'AirBoundaryConstructionAbridged'
+        # set hash values from OpenStudio Object
+        hash[:identifier] = construction.nameString
+        # check if boost optional object is empty
+        unless construction.simpleMixingSchedule.empty?
+          schedule = construction.simpleMixingSchedule.get
+          hash[:air_mixing_schedule] = schedule.nameString
+        end
+        #TODO: Add air_mixing_per_area
+
+        hash
+    end
+
+  end # AirBoundaryConstructionAbridged
+end # Honeybee

data/lib/from_openstudio/construction/opaque.rb

@@ -0,0 +1,56 @@
+# *******************************************************************************
+# Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable
+# Energy, LLC, Ladybug Tools LLC and other contributors. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# (1) Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# (2) Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# (3) Neither the name of the copyright holder nor the names of any contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission from the respective party.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE
+# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
+# THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+# OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# *******************************************************************************
+
+require 'honeybee/construction/opaque'
+require 'to_openstudio/model_object'
+
+module Honeybee
+  class OpaqueConstructionAbridged < ModelObject
+
+    def self.from_construction(construction)
+        # create an empty hash
+        hash = {}
+        hash[:type] = 'OpaqueConstructionAbridged'
+        # set hash values from OpenStudio Object
+        hash[:identifier] = construction.nameString
+        hash[:materials] = []
+        # get construction layers
+        layers = construction.layers
+        layers.each do |layer|
+          name = layer.nameString
+          hash[:materials] << name
+        end
+
+        hash
+    end
+
+  end # OpaqueConstructionAbridged
+end # Honeybee

data/lib/from_openstudio/construction/shade.rb

@@ -0,0 +1,82 @@
+# *******************************************************************************
+# Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable
+# Energy, LLC, Ladybug Tools LLC and other contributors. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# (1) Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# (2) Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# (3) Neither the name of the copyright holder nor the names of any contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission from the respective party.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE
+# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
+# THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+# OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# *******************************************************************************
+
+require 'honeybee/construction/shade'
+require 'from_openstudio/model_object'
+
+module Honeybee
+  class ShadeConstruction < ModelObject
+
+    def self.from_construction(construction)
+        # create an empty hash
+        hash = {}
+        hash[:type] = 'ShadeConstruction'
+        # set hash values from OpenStudio Object
+        hash[:identifier] = construction.nameString
+        # get outermost construction layers
+        layer = construction.layers[0]
+        if layer.to_StandardGlazing.is_initialized
+          layer = layer.to_StandardGlazing.get
+          hash[:is_specular] = true
+          # set reflectance properties from outermost layer
+          unless layer.frontSideSolarReflectanceatNormalIncidence.empty?
+            hash[:solar_reflectance] = layer.frontSideSolarReflectanceatNormalIncidence.get
+          end
+          unless layer.frontSideVisibleReflectanceatNormalIncidence.empty?
+            hash[:visible_reflectance] = layer.frontSideVisibleReflectanceatNormalIncidence.get
+          end
+        elsif layer.to_StandardOpaqueMaterial.is_initialized
+          layer = layer.to_StandardOpaqueMaterial.get
+          hash[:is_specular] = false
+          # set reflectance properties from outermost layer
+          unless layer.solarReflectance.empty?
+            hash[:solar_reflectance] = layer.solarReflectance.get
+          end
+          unless layer.visibleReflectance.empty?
+            hash[:visible_reflectance] = layer.visibleReflectance
+          end
+        elsif layer.to_MasslessOpaqueMaterial.is_initialized
+          layer = layer.to_MasslessOpaqueMaterial.get
+          hash[:is_specular] = false
+          # set reflectance properties from outermost layer
+          unless layer.solarAbsorptance.empty?
+            hash[:solar_reflectance] = 1 - layer.solarAbsorptance.get
+          end
+          unless layer.visibleAbsorptance.empty?
+            hash[:visible_reflectance] = 1 - layer.visibleAbsorptance.get
+          end
+        end
+
+        hash
+    end
+
+  end # ShadeConstruction
+end # Honeybee

data/lib/from_openstudio/construction/window.rb

@@ -0,0 +1,56 @@
+# *******************************************************************************
+# Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable
+# Energy, LLC, Ladybug Tools LLC and other contributors. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# (1) Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# (2) Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# (3) Neither the name of the copyright holder nor the names of any contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission from the respective party.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE
+# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
+# THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+# OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# *******************************************************************************
+
+require 'honeybee/construction/window'
+require 'to_openstudio/model_object'
+
+module Honeybee
+  class WindowConstructionAbridged
+
+    def self.from_construction(construction)
+        # create an empty hash
+        hash = {}
+        hash[:type] = 'WindowConstructionAbridged'
+        # set hash values from OpenStudio Object
+        hash[:identifier] = construction.nameString
+        hash[:materials] = []
+        # get construction layers
+        layers = construction.layers
+        layers.each do |layer|
+          name = layer.nameString
+          hash[:materials] << name
+        end
+
+        hash
+    end
+
+  end # WindowConstructionAbridged
+end # Honeybee

data/lib/from_openstudio/geometry/shade.rb

@@ -61,7 +61,13 @@ module Honeybee
 
       construction = shading_surface.construction
       if !construction.empty?
-        hash[:construction] = construction.get.nameString
+        const_name = construction.get.nameString
+        hash[:construction] = const_name
+        unless $shade_construction.has_key?(const_name)
+          const_obj = construction.get
+          const = const_obj.to_LayeredConstruction.get
+          $shade_construction[const_name] = const
+        end
       end
 
       transmittance_schedule = shading_surface.transmittanceSchedule

data/lib/from_openstudio/material/opaque_no_mass.rb

@@ -42,18 +42,23 @@ module Honeybee
         # set hash values from OpenStudio Object
         hash[:identifier] = material.nameString
         hash[:r_value] = material.thermalResistance
-        hash[:roughness] = material.roughness
-        # check if boost optional object is empty
-        unless material.thermalAbsorptance.empty?
-          hash[:thermal_absorptance] = material.thermalAbsorptance.get
-        end
-        # check if boost optional object is empty
-        unless material.solarAbsorptance.empty?
-          hash[:solar_absorptance] = material.solarAbsorptance.get
-        end
-        # check if boost optional object is empty
-        unless material.visibleAbsorptance.empty?
-          hash[:visible_absorptance] = material.visibleAbsorptance.get
+
+        if material.to_MasslessOpaqueMaterial.is_initialized
+          # Roughness is a required property for OS MasslessOpaqueMaterial but isn't a listed
+          # property for OS AirGap
+          hash[:roughness] = material.roughness
+          # check if boost optional object is empty
+          unless material.thermalAbsorptance.empty?
+            hash[:thermal_absorptance] = material.thermalAbsorptance.get
+          end
+          # check if boost optional object is empty
+          unless material.solarAbsorptance.empty?
+            hash[:solar_absorptance] = material.solarAbsorptance.get
+          end
+          # check if boost optional object is empty
+          unless material.visibleAbsorptance.empty?
+            hash[:visible_absorptance] = material.visibleAbsorptance.get
+          end
         end
 
         hash

data/lib/from_openstudio/model.rb

@@ -41,6 +41,10 @@ require 'from_openstudio/material/window_blind'
 require 'from_openstudio/material/window_gas'
 require 'from_openstudio/material/window_gas_custom'
 require 'from_openstudio/material/window_gas_mixture'
+require 'from_openstudio/construction/air'
+require 'from_openstudio/construction/opaque'
+require 'from_openstudio/construction/window'
+require 'from_openstudio/construction/shade'
 
 require 'openstudio'
 
@@ -57,6 +61,8 @@ module Honeybee
       hash[:tolerance] = 0.01
       hash[:angle_tolerance] = 1.0
 
+      # Hash for all shade constructions in the model
+      $shade_construction = {}
       hash[:properties] = properties_from_model(openstudio_model)
 
       rooms = rooms_from_model(openstudio_model)
@@ -65,6 +71,12 @@ module Honeybee
       orphaned_shades = orphaned_shades_from_model(openstudio_model)
       hash[:orphaned_shades] = orphaned_shades if !orphaned_shades.empty?
 
+      unless $shade_construction.empty?
+        shade_constructions_from_model($shade_construction).each do |shade_const|
+          hash[:properties][:energy][:constructions] << shade_const
+        end
+      end
+
       Model.new(hash)
     end
 
@@ -103,13 +115,17 @@ module Honeybee
     def self.properties_from_model(openstudio_model)
       hash = {}
       hash[:type] = 'ModelProperties'
+      hash[:energy] = energy_properties_from_model(openstudio_model)
       hash
     end
 
     def self.energy_properties_from_model(openstudio_model)
       hash = {}
       hash[:type] = 'ModelEnergyProperties'
-      hash[:energy] = energy_properties_from_model(openstudio_model)
+      hash[:constructions] = []
+      hash[:constructions] = constructions_from_model(openstudio_model)
+      hash[:materials] = materials_from_model(openstudio_model)
+      
       hash
     end
 
@@ -145,10 +161,17 @@ module Honeybee
       openstudio_model.getStandardOpaqueMaterials.each do |material|
         result << EnergyMaterial.from_material(material)
       end
-      # Create HB EnergyMaterialNoMass from OpenStudio Material
+
+      # Create HB EnergyMaterialNoMass from OpenStudio MasslessOpaque Materials
       openstudio_model.getMasslessOpaqueMaterials.each do |material|
         result << EnergyMaterialNoMass.from_material(material)
       end
+
+      # Create HB EnergyMaterialNoMass from OpenStudio AirGap materials
+      openstudio_model.getAirGaps.each do|material|
+        result << EnergyMaterialNoMass.from_material(material)
+      end
+
       # Create HB WindowMaterialSimpleGlazSys from OpenStudio Material
       openstudio_model.getSimpleGlazings.each do |material|
         result << EnergyWindowMaterialSimpleGlazSys.from_material(material)
@@ -178,5 +201,45 @@ module Honeybee
       result
     end
 
+    # Create HB Construction from OpenStudio Materials
+    def self.constructions_from_model(openstudio_model)
+      result = []
+
+      # Create HB AirConstruction from OpenStudio Construction
+      openstudio_model.getConstructionAirBoundarys.each do |construction|
+        result << AirBoundaryConstructionAbridged.from_construction(construction)
+      end
+
+      # Create HB WindowConstruction from OpenStudio Construction
+      openstudio_model.getConstructions.each do |construction|
+        window_construction = false
+        opaque_construction = false
+        material = construction.layers[0]
+        if material.to_StandardGlazing.is_initialized or material.to_SimpleGlazing.is_initialized
+          window_construction = true
+        elsif material.to_StandardOpaqueMaterial.is_initialized or material.to_MasslessOpaqueMaterial.is_initialized
+          opaque_construction = true
+        end
+        if window_construction == true
+          result << WindowConstructionAbridged.from_construction(construction)
+        end
+        if opaque_construction == true
+          result << OpaqueConstructionAbridged.from_construction(construction)
+        end
+      end
+
+      result
+    end
+
+    def self.shade_constructions_from_model(shade_constructions)
+      result = []
+
+        shade_constructions.each do |key, value|
+          result << ShadeConstruction.from_construction(value)
+        end
+
+      result
+    end
+
   end # Model
 end # Honeybee