honeybee-openstudio 2.17.5 → 2.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4856942358fea802404323b2df581961230c29b0de01d1993742dc2e9c4aaec
-  data.tar.gz: 5749259754899e511dd53f3cb4427986abc78bfb6de7f6af023829db9056c630
+  metadata.gz: 033a258c4b365b57e5985771e4b9c78b565f43e042ef0fe5e37ee378458842f0
+  data.tar.gz: 35df9c37614ef5bb2846475cd79a29490835808e156d8a570aaa12352dcb5205
 SHA512:
-  metadata.gz: 573e2448b710a5591c2b2c648d96d6ee09b226a458b589d3a081f6ba1dd5a04cf42ac84f9e63b43bcfa77c09c54632b08d9c3391b14f502c447de9f18a1ffa72
-  data.tar.gz: 855685ea4d3387be760c97ca56a807bdd6a983be4a528a177784f52cbca182a5d5561eaed9c4ab0a3de71631ddf4633de79174d6bf421ef8c0094a531ca5a566
+  metadata.gz: 575891d5a88970749d0177c9463db77529cd37e1a118940f8dd68f0a77ee33bd6ade3fe291ec07d655dddb1b0342ef9dede96139b397759d3442a54008a5e3c3
+  data.tar.gz: faf995c65be826b73ca7140fd77a7f6c55f87e2150abbe48b0374063329fc9a6d8ba58ab04cb79f60e8fc2b6115aa1f96570e3c8de880dc07835f6f352958d0c

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.20.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

@@ -35,6 +35,7 @@ require 'honeybee'
 # extend the compound objects that house the other objects
 require 'from_openstudio/model'
 require 'from_openstudio/model_object'
+require 'from_openstudio/construction_set'
 
 # extend the geometry objects
 require 'from_openstudio/geometry/aperture'
@@ -43,6 +44,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/construction_set.rb

@@ -0,0 +1,141 @@
+# *******************************************************************************
+# 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_set'
+require 'from_openstudio/model_object'
+
+module Honeybee
+  class ConstructionSetAbridged < ModelObject
+
+    def self.from_construction_set(construction_set)
+        # create an empty hash
+        hash = {}
+        hash[:type] = 'ConstructionSetAbridged'
+        # set hash values from OpenStudio Object
+        hash[:identifier] = construction_set.nameString
+        hash[:wall_set] = {}
+        hash[:floor_set] = {}
+        hash[:aperture_set] = {}
+        hash[:door_set] = {}
+        hash[:roof_ceiling_set] = {}
+
+        # get interior surface constructions
+        unless construction_set.defaultInteriorSurfaceConstructions.empty?
+          int_surf_construction = construction_set.defaultInteriorSurfaceConstructions.get
+          # get interior wall construction
+          unless int_surf_construction.wallConstruction.empty?
+            int_wall_const = int_surf_construction.wallConstruction.get
+            hash[:wall_set][:interior_construction] = int_wall_const.nameString
+          end
+          # get interior floor construction
+          unless int_surf_construction.floorConstruction.empty?
+            int_floor_const = int_surf_construction.floorConstruction.get
+            hash[:floor_set][:interior_construction] = int_floor_const.nameString
+          end
+          # get interior roofceiling construction
+          unless int_surf_construction.roofCeilingConstruction.empty?
+            int_roof_const = int_surf_construction.roofCeilingConstruction.get
+            hash[:roof_ceiling_set][:interior_construction] = int_roof_const.nameString
+          end
+        end
+
+        # get interior subsurface constructions
+        unless construction_set.defaultInteriorSubSurfaceConstructions.empty?
+          int_subsurf_const = construction_set.defaultInteriorSubSurfaceConstructions.get
+          # TODO: check outdoor boundary condition for fixed window and operable window and assign to
+          # interior_construction for aperture
+          # get interior fixed window construction
+          unless int_subsurf_const.fixedWindowConstruction.empty?
+            int_wind_const = int_subsurf_const.fixedWindowConstruction.get
+            hash[:aperture_set][:window_construction] = int_wind_const.nameString
+          end
+          # get interior door construction
+          unless int_subsurf_const.doorConstruction.empty?
+            int_door_const = int_subsurf_const.doorConstruction.get
+            hash[:door_set][:interior_construction] = int_door_const.nameString
+          end
+          # get interior glass door construction
+          unless int_subsurf_const.glassDoorConstruction.empty?
+            int_glass_door_const = int_subsurf_const.glassDoorConstruction.get
+            hash[:door_set][:interior_glass_construction] = int_glass_door_const.nameString
+          end
+        end
+        
+        # get exterior surface constructions
+        unless construction_set.defaultExteriorSurfaceConstructions.empty?
+          ext_surf_const = construction_set.defaultExteriorSurfaceConstructions.get
+          # get exterior wall construction
+          unless ext_surf_const.wallConstruction.empty?
+            ext_wall_const = ext_surf_const.wallConstruction.get
+            hash[:wall_set][:exterior_construction] = ext_wall_const.nameString
+          end
+          # get exterior floor construction
+          unless ext_surf_const.floorConstruction.empty?
+            ext_floor_const = ext_surf_const.floorConstruction.get
+            hash[:floor_set][:exterior_construction] = ext_floor_const.nameString
+          end
+          # get exterior roofceiling construction
+          unless ext_surf_const.roofCeilingConstruction.empty?
+            ext_roof_const = ext_surf_const.roofCeilingConstruction.get
+            hash[:roof_ceiling_set][:exterior_construction] = ext_roof_const.nameString
+          end
+        end
+
+        # get exterior subsurface construction
+        unless construction_set.defaultExteriorSubSurfaceConstructions.empty?
+          ext_subsurf_const = construction_set.defaultExteriorSubSurfaceConstructions.get
+          # get exterior operable window construction
+          unless ext_subsurf_const.operableWindowConstruction.empty?
+            ext_wind_const = ext_subsurf_const.operableWindowConstruction.get
+            hash[:aperture_set][:operable_construction] = ext_wind_const.nameString
+          end
+          # get exterior skylight construction
+          unless ext_subsurf_const.skylightConstruction.empty?
+            ext_skylight_const = ext_subsurf_const.skylightConstruction.get
+            hash[:aperture_set][:skylight_construction] = ext_skylight_const.nameString
+          end
+          # get exterior door construction
+          unless ext_subsurf_const.doorConstruction.empty?
+            ext_door_const = ext_subsurf_const.doorConstruction.get
+            hash[:door_set][:exterior_construction] = ext_door_const.nameString
+          end
+          # get exterior overhead door construction
+          unless ext_subsurf_const.overheadDoorConstruction.empty?
+            ext_ovhd_door_const = ext_subsurf_const.overheadDoorConstruction.get
+            hash[:door_set][:overhead_construction] = ext_ovhd_door_const.nameString
+          end
+        end
+
+        hash
+
+    end
+  end # ConstructionSetAbridged
+end # Honeybee