honeybee-openstudio 0

data/lib/to_openstudio.rb

@@ -0,0 +1,92 @@
+# *******************************************************************************
+# 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.
+# *******************************************************************************
+
+# import the honeybee objects which we will extend
+require 'honeybee'
+
+# extend the compound objects that house the other objects
+require 'to_openstudio/model'
+require 'to_openstudio/model_object'
+require 'to_openstudio/construction_set'
+require 'to_openstudio/program_type'
+
+# extend the geometry objects
+require 'to_openstudio/geometry/shade'
+require 'to_openstudio/geometry/door'
+require 'to_openstudio/geometry/aperture'
+require 'to_openstudio/geometry/face'
+require 'to_openstudio/geometry/room'
+
+# extend the HVAC objects
+require 'to_openstudio/hvac/ideal_air'
+require 'to_openstudio/hvac/template'
+
+# extend the construction objects
+require 'to_openstudio/construction/opaque'
+require 'to_openstudio/construction/window'
+require 'to_openstudio/construction/windowshade'
+require 'to_openstudio/construction/shade'
+require 'to_openstudio/construction/air'
+
+# extend the material objects
+require 'to_openstudio/material/opaque'
+require 'to_openstudio/material/opaque_no_mass'
+require 'to_openstudio/material/window_gas'
+require 'to_openstudio/material/window_gas_mixture'
+require 'to_openstudio/material/window_gas_custom'
+require 'to_openstudio/material/window_blind'
+require 'to_openstudio/material/window_glazing'
+require 'to_openstudio/material/window_shade'
+require 'to_openstudio/material/window_simpleglazsys'
+
+# extend the load objects
+require 'to_openstudio/load/people'
+require 'to_openstudio/load/lighting'
+require 'to_openstudio/load/electric_equipment'
+require 'to_openstudio/load/gas_equipment'
+require 'to_openstudio/load/infiltration'
+require 'to_openstudio/load/ventilation'
+require 'to_openstudio/load/setpoint_thermostat'
+require 'to_openstudio/load/setpoint_humidistat'
+
+# extend the schedule objects
+require 'to_openstudio/schedule/type_limit'
+require 'to_openstudio/schedule/fixed_interval'
+require 'to_openstudio/schedule/ruleset'
+
+# import the ventilation objects
+require 'to_openstudio/ventcool/control'
+require 'to_openstudio/ventcool/opening'
+require 'to_openstudio/ventcool/simulation'
+
+# extend the simulation objects
+require 'to_openstudio/simulation/design_day'
+require 'to_openstudio/simulation/parameter_model'

data/lib/to_openstudio/construction/air.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/air'
+
+require 'to_openstudio/model_object'
+
+module Honeybee
+  class AirBoundaryConstructionAbridged
+
+    def find_existing_openstudio_object(openstudio_model)
+      object = openstudio_model.getConstructionByName(@hash[:identifier])
+      return object.get if object.is_initialized
+      nil
+    end
+
+    def to_openstudio(openstudio_model)
+      os_construction = OpenStudio::Model::ConstructionAirBoundary.new(openstudio_model)
+      os_construction.setName(@hash[:identifier])
+      os_construction.setSolarAndDaylightingMethod('GroupedZones')
+      os_construction.setRadiantExchangeMethod('GroupedZones')
+      os_construction.setAirExchangeMethod('None')
+
+      os_construction
+    end
+
+  end #AirBoundaryConstructionAbridged
+end #Honeybee

data/lib/to_openstudio/construction/opaque.rb

@@ -0,0 +1,67 @@
+# *******************************************************************************
+# 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
+
+    def find_existing_openstudio_object(openstudio_model)
+      object = openstudio_model.getConstructionByName(@hash[:identifier])
+      return object.get if object.is_initialized
+      nil
+    end
+
+    def to_openstudio(openstudio_model)
+      # create construction and set identifier
+      os_construction = OpenStudio::Model::Construction.new(openstudio_model)
+      os_construction.setName(@hash[:identifier])
+
+      # create material vector
+      os_materials = OpenStudio::Model::MaterialVector.new
+      # loop through each layer and add to material vector
+      @hash[:layers].each do |layer|
+        material_identifier = layer
+        material = openstudio_model.getMaterialByName(material_identifier)
+        unless material.empty?
+          os_material = material.get
+          os_materials << os_material
+        end
+      end
+      os_construction.setLayers(os_materials)
+
+      os_construction
+    end
+
+  end #OpaqueConstructionAbridged
+end #Honeybee

data/lib/to_openstudio/construction/shade.rb

@@ -0,0 +1,99 @@
+# *******************************************************************************
+# 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 'to_openstudio/model_object'
+
+module Honeybee
+  class ShadeConstruction < ModelObject
+
+    def find_existing_openstudio_object(openstudio_model)
+      object = openstudio_model.getConstructionByName(@hash[:identifier])
+      return object.get if object.is_initialized
+      nil
+    end
+
+    def to_openstudio(openstudio_model)
+
+      os_construction = OpenStudio::Model::Construction.new(openstudio_model)
+      os_construction.setName(@hash[:identifier])
+      os_materials = OpenStudio::Model::MaterialVector.new
+
+      # create standard glazing if is specular is true
+      if @hash[:is_specular] == true
+        os_material = OpenStudio::Model::StandardGlazing.new(openstudio_model)
+
+        # assign solar reflectance
+        if @hash[:solar_reflectance]
+          os_material.setFrontSideSolarReflectanceatNormalIncidence(@hash[:solar_reflectance])
+        else
+          os_material.setFrontSideSolarReflectanceatNormalIncidence(defaults[:solar_reflectance][:default])
+        end
+
+        # assign visible reflectance
+        if @hash[:visible_reflectance]
+          os_material.setFrontSideVisibleReflectanceatNormalIncidence(@hash[:visible_reflectance])
+        else
+          os_material.setFrontSideVisibleReflectanceatNormalIncidence(defaults[:solar_reflectance][:default])
+        end
+
+      # create standard opaque material if is specular is false
+      else
+        os_material = OpenStudio::Model::StandardOpaqueMaterial.new(openstudio_model)
+
+        # assign solar reflectance
+        if @hash[:solar_reflectance]
+          os_material.setSolarReflectance(OpenStudio::OptionalDouble.new(@hash[:solar_reflectance]))
+        else
+          os_material.setSolarReflectance(OpenStudio::OptionalDouble.new(defaults[:visible_reflectance][:default]))
+        end
+
+        # assign visible reflectance
+        if @hash[:visible_reflectance]
+          os_material.setVisibleReflectance(OpenStudio::OptionalDouble.new(@hash[:visible_reflectance]))
+        else
+          os_material.setVisibleReflectance(OpenStudio::OptionalDouble.new(defaults[:solar_reflectance][:default]))
+        end
+
+        # assign specific heat
+        os_material.setSpecificHeat(100)  # bug in OpenStudio default Specific Heat is 0.1.
+      end
+
+      # add materials and set layers to construction
+      os_materials << os_material
+      os_construction.setLayers(os_materials)
+      os_construction
+
+    end
+
+  end #ShadeConstruction
+end #Honeybee

data/lib/to_openstudio/construction/window.rb

@@ -0,0 +1,70 @@
+# *******************************************************************************
+# 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 find_existing_openstudio_object(openstudio_model)
+      object = openstudio_model.getConstructionByName(@hash[:identifier])
+      return object.get if object.is_initialized
+      nil
+    end
+
+    def to_openstudio(openstudio_model)
+      # create construction and set identifier
+      os_construction = OpenStudio::Model::Construction.new(openstudio_model)
+      os_construction.setName(@hash[:identifier])
+
+      # create material vector
+      os_materials = OpenStudio::Model::MaterialVector.new
+      # loop through each layer and add to material vector
+      @hash[:layers].each do |layer|
+        material_identifier = layer
+        material = openstudio_model.getMaterialByName(material_identifier)
+        unless material.empty?
+          os_material = material.get
+          os_materials << os_material
+        end
+      end
+      os_construction.setLayers(os_materials)
+
+      os_construction
+    end
+
+  end #WindowConstructionAbridged
+end #Honeybee
+
+
+

data/lib/to_openstudio/construction/windowshade.rb

@@ -0,0 +1,196 @@
+# *******************************************************************************
+# 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/windowshade'
+
+require 'to_openstudio/model_object'
+
+module Honeybee
+  class WindowConstructionShadeAbridged
+
+    attr_reader :construction, :shade_construction, :shade_location, :shade_material, :control_type, :setpoint, :schedule
+
+    def find_existing_openstudio_object(openstudio_model)
+      object = openstudio_model.getConstructionByName(@hash[:identifier])
+      return object.get if object.is_initialized
+      nil
+    end
+
+    def to_openstudio(openstudio_model)
+      # write the shaded and unsaded versions of the construciton into the model
+      # reverse the shaded and unshaded identifiers so unshaded one is assigned to apertures
+      unshd_id = @hash[:identifier]
+      shd_id = @hash[:window_construction][:identifier]
+      @hash[:window_construction][:identifier] = unshd_id
+      @hash[:identifier] = shd_id
+
+      # create the unshaded construction
+      unshd_constr_obj = WindowConstructionAbridged.new(@hash[:window_construction])
+      @construction = unshd_constr_obj.to_openstudio(openstudio_model)
+
+      # create the shaded construction
+      @shade_construction = OpenStudio::Model::Construction.new(openstudio_model)
+      @shade_construction.setName(shd_id)
+
+      # create the layers of the unshaded construction into which we will insert the shade
+      os_materials = []
+      @hash[:window_construction][:layers].each do |layer|
+        material_identifier = layer
+        material = openstudio_model.getMaterialByName(material_identifier)
+        unless material.empty?
+          os_material = material.get
+          os_materials << os_material
+        end
+      end
+
+      # figure out where to insert the shade material and insert it
+      if @hash[:shade_location]
+        @shade_location = @hash[:shade_location]
+      else
+        @shade_location = defaults[:shade_location][:default]
+      end
+
+      # insert the shade material
+      shd_mat_name = openstudio_model.getMaterialByName(@hash[:shade_material])
+      unless shd_mat_name.empty?
+        @shade_material = shd_mat_name.get
+        obj_type = @shade_material.iddObject.name
+      end
+      unless @shade_material.nil?
+        if obj_type == 'OS:WindowMaterial:StandardGlazing'
+          if @shade_location == 'Interior'
+              os_materials[-1] = @shade_material
+          elsif @shade_location == 'Exterior' | os_materials.length < 2
+              os_materials[0] = @shade_material
+          else  # middle glass pane
+              os_materials[-3] = @shade_material
+          end
+        else
+          if @shade_location == 'Interior'
+              os_materials << @shade_material
+          elsif @shade_location == 'Exterior'
+              os_materials.unshift(@shade_material)
+          else  # between glass shade/blind
+            split_gap = split_gas_gap(openstudio_model, os_materials[-2], @shade_material)
+            os_materials[-2] = split_gap
+            os_materials.insert(-2, @shade_material)
+            os_materials.insert(-2, split_gap)
+          end
+        end
+      end
+
+      # assign the layers to the shaded construction
+      os_materials_vec = OpenStudio::Model::MaterialVector.new
+      os_materials.each do |mat|
+        os_materials_vec << mat
+      end
+      @shade_construction.setLayers(os_materials)
+
+      # set defaults for control type, setpoint, and schedule
+      if @hash[:control_type]
+        @control_type = @hash[:control_type]
+      else
+        @control_type = defaults[:control_type][:default]
+      end
+
+      if @hash[:setpoint]
+        @setpoint = @hash[:setpoint]
+      else
+        @setpoint = defaults[:setpoint][:default]
+      end
+
+      unless @hash[:schedule].nil?
+        schedule_ref = openstudio_model.getScheduleByName(@hash[:schedule])
+        unless schedule_ref.empty?
+            @schedule = schedule_ref.get
+            if @control_type == 'AlwaysOn'
+                @control_type = 'OnIfScheduleAllows'
+            end
+        end
+      end
+
+      @shade_construction
+    end
+
+    def to_openstudio_shading_control(openstudio_model)
+      # add a WindowShadingControl object to a model for a given aperture and room
+      os_shade_control = OpenStudio::Model::ShadingControl.new(@shade_construction)
+
+      # figure out the shading type
+      unless @shade_material.nil?
+        obj_type = @shade_material.iddObject.name
+      end
+      if obj_type == 'OS:WindowMaterial:StandardGlazing'
+        shd_type = 'SwitchableGlazing'
+      elsif obj_type == 'OS:WindowMaterial:Blind'
+        if @shade_location == 'Between'
+          shd_type = 'BetweenGlassBlind'
+        else
+          shd_type = @shade_location + 'Blind'
+        end
+      else
+        if @shade_location == 'Between'
+          shd_type = 'BetweenGlassShade'
+        else
+          shd_type = @shade_location + 'Shade'
+        end
+      end
+      os_shade_control.setShadingType(shd_type)
+
+      # set the shade control type and schedule
+      os_shade_control.setShadingControlType(@control_type)
+      unless @setpoint.nil?
+        os_shade_control.setSetpoint(@setpoint)
+      end
+      unless @schedule.nil?
+        os_shade_control.setSchedule(@schedule)
+      end
+
+      os_shade_control
+    end
+
+    def split_gas_gap(openstudio_model, original_gap, shade_material)
+        # split a gas gap material in two when it is interrupeted by a shade/blind
+        if shade_material.is_a? OpenStudio::Model::Blind
+          shd_thick = 0
+        else
+          shd_thick = shade_material.thickness
+        end
+        gap_thick = (original_gap.thickness - shd_thick) / 2
+        gap_obj = $gas_gap_hash[original_gap.name.get]
+        new_gap = gap_obj.to_openstudio(openstudio_model)
+        new_gap.setName(original_gap.name.get + gap_thick.to_s)
+        new_gap.setThickness(gap_thick)
+        new_gap
+    end
+
+  end #WindowConstructionShadeAbridged
+end #Honeybee