honeybee-openstudio 1.8.1

data/lib/from_honeybee/material/window_blind.rb

@@ -0,0 +1,238 @@
+# *******************************************************************************
+# 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 'from_honeybee/model_object'
+
+require 'openstudio'
+
+module FromHoneybee
+  class EnergyWindowMaterialBlind < ModelObject
+    attr_reader :errors, :warnings
+
+    def initialize(hash = {})
+      super(hash)
+    end
+
+    def defaults
+      @@schema[:components][:schemas][:EnergyWindowMaterialBlind][:properties]
+    end
+
+    def find_existing_openstudio_object(openstudio_model)
+      object = openstudio_model.getBlindByName(@hash[:identifier])
+      return object.get if object.is_initialized
+      nil
+    end
+
+    def to_openstudio(openstudio_model)
+      # create blind OpenStudio object
+      os_blind = OpenStudio::Model::Blind.new(openstudio_model)
+      os_blind.setName(@hash[:identifier])
+      
+      # assign slat orientation
+      if @hash[:slat_orientation]
+        os_blind.setSlatOrientation(@hash[:slat_orientation])
+      else
+        os_blind.setSlatOrientation(defaults[:slat_orientation][:default])
+      end
+
+      # assign slat width
+      if @hash[:slat_width]
+        os_blind.setSlatWidth(@hash[:slat_width])
+      else
+        os_blind.setSlatWidth(defaults[:slat_width][:default])
+      end
+      
+      # assign slat separation if it exists
+      if @hash[:slat_separation]
+        os_blind.setSlatSeparation(@hash[:slat_separation])
+      else
+        os_blind.setSlatSeparation(defaults[:slat_separation][:default])
+      end
+      
+      # assign slat thickness if it exists
+      if @hash[:slat_thickness]
+        os_blind.setSlatThickness(@hash[:slat_thickness])
+      else
+        os_blind.setSlatThickness(defaults[:slat_thickness][:default])
+      end
+
+      # assign slat angle if it exists
+      if @hash[:slat_angle]
+        os_blind.setSlatAngle(@hash[:slat_angle])
+      else
+        os_blind.setSlatAngle(defaults[:slat_angle][:default])
+      end
+      
+      # assign slat conductivity if it exists
+      if @hash[:slat_conductivity]
+        os_blind.setSlatConductivity(@hash[:slat_conductivity])
+      else
+        os_blind.setSlatConductivity(defaults[:slat_conductivity][:default])
+      end
+      
+      # assign beam solar transmittance if it exists
+      if @hash[:beam_solar_transmittance]
+        os_blind.setSlatBeamSolarTransmittance(@hash[:beam_solar_transmittance])
+      else
+        os_blind.setSlatBeamSolarTransmittance(defaults[:beam_solar_transmittance][:default])
+      end
+      
+      # assign beam solar reflectance front if it exists
+      if @hash[:beam_solar_reflectance]
+        os_blind.setFrontSideSlatBeamSolarReflectance(@hash[:beam_solar_reflectance])
+      else
+        os_blind.setFrontSideSlatBeamSolarReflectance(
+          defaults[:beam_solar_reflectance][:default])
+      end
+      
+      # assign beam solar reflectance back
+      if @hash[:beam_solar_reflectance_back]
+        os_blind.setBackSideSlatBeamSolarReflectance(@hash[:beam_solar_reflectance_back])
+      else
+        os_blind.setBackSideSlatBeamSolarReflectance(
+          defaults[:beam_solar_reflectance_back][:default])
+      end
+      
+      # assign diffuse solar transmittance
+      if @hash[:diffuse_solar_transmittance]
+        os_blind.setSlatDiffuseSolarTransmittance(@hash[:diffuse_solar_transmittance])
+      else
+        os_blind.setSlatDiffuseSolarTransmittance(
+          defaults[:diffuse_solar_transmittance][:default])
+      end
+      
+      # assign front diffuse solar reflectance
+      if @hash[:diffuse_solar_reflectance]
+        os_blind.setFrontSideSlatDiffuseSolarReflectance(@hash[:diffuse_solar_reflectance])
+      else
+        os_blind.setFrontSideSlatDiffuseSolarReflectance(
+          defaults[:diffuse_solar_reflectance][:default])
+      end
+
+      # assign back diffuse solar reflectance
+      if @hash[:diffuse_solar_reflectance_back]
+        os_blind.setBackSideSlatDiffuseSolarReflectance(@hash[:diffuse_solar_reflectance_back])
+      else
+        os_blind.setBackSideSlatDiffuseSolarReflectance(
+          defaults[:diffuse_solar_reflectance_back][:default])
+      end
+      
+      # assign front diffuse visible transmittance
+      if @hash[:diffuse_visible_transmittance]
+        os_blind.setSlatDiffuseVisibleTransmittance(@hash[:diffuse_visible_transmittance])
+      else
+        os_blind.setSlatDiffuseVisibleTransmittance(
+          defaults[:diffuse_visible_transmittance][:default])
+      end
+      
+      # assign front diffuse visible reflectance
+      if @hash[:diffuse_visible_reflectance]
+        os_blind.setFrontSideSlatDiffuseVisibleReflectance(@hash[:diffuse_visible_reflectance])
+      else
+        os_blind.setFrontSideSlatDiffuseVisibleReflectance(
+          defaults[:diffuse_visible_reflectance][:default])
+      end
+      
+      # assign back diffuse visible reflectance
+      if @hash[:diffuse_visible_reflectance_back]
+        os_blind.setBackSideSlatDiffuseVisibleReflectance(@hash[:diffuse_visible_reflectance_back])
+      else
+        os_blind.setBackSideSlatDiffuseVisibleReflectance(
+          defaults[:diffuse_visible_reflectance_back][:default])
+      end
+      
+      # assign infrared transmittance
+      if @hash[:infrared_transmittance]
+        os_blind.setSlatInfraredHemisphericalTransmittance(@hash[:infrared_transmittance])
+      else
+        os_blind.setSlatInfraredHemisphericalTransmittance(
+          defaults[:infrared_transmittance][:default])
+      end
+      
+      # assign front side emissivity
+      if @hash[:emissivity]
+        os_blind.setFrontSideSlatInfraredHemisphericalEmissivity(@hash[:emissivity])
+      else
+        os_blind.setFrontSideSlatInfraredHemisphericalEmissivity(
+          defaults[:emissivity][:default])
+      end
+      
+      # assign back side emissivity
+      if @hash[:emissivity_back]
+        os_blind.setBackSideSlatInfraredHemisphericalEmissivity(@hash[:emissivity_back])
+      else
+        os_blind.setBackSideSlatInfraredHemisphericalEmissivity(
+          defaults[:emissivity_back][:default])
+      end
+      
+      # assign distance to glass
+      if @hash[:distance_to_glass]
+        os_blind.setBlindtoGlassDistance(@hash[:distance_to_glass])
+      else
+        os_blind.setBlindtoGlassDistance(defaults[:distance_to_glass][:default])
+      end
+      
+      # assign top opening multiplier
+      if @hash[:top_opening_multiplier]
+        os_blind.setBlindTopOpeningMultiplier(@hash[:top_opening_multiplier])
+      else
+        os_blind.setBlindTopOpeningMultiplier(
+          defaults[:top_opening_multiplier][:default])
+      end
+      
+      # assign bottom opening multiplier
+      if @hash[:bottom_opening_multiplier]
+        os_blind.setBlindBottomOpeningMultiplier(@hash[:bottom_opening_multiplier])
+      else
+        os_blind.setBlindBottomOpeningMultiplier(
+          defaults[:bottom_opening_multiplier][:default])
+      end
+      
+      # assign left opening multiplier
+      if @hash[:left_opening_multiplier]
+        os_blind.setBlindLeftSideOpeningMultiplier(@hash[:left_opening_multiplier])
+      else
+        os_blind.setBlindLeftSideOpeningMultiplier(
+          defaults[:left_opening_multiplier][:default])
+      end
+      
+      # assign right opening multiplier
+      if @hash[:right_opening_multiplier]
+        os_blind.setBlindRightSideOpeningMultiplier(@hash[:right_opening_multiplier])
+      else
+        os_blind.setBlindRightSideOpeningMultiplier(
+          defaults[:right_opening_multiplier][:default])
+      end
+
+      os_blind
+    end
+  end # EnergyWindowMaterialBlind
+end # FromHoneybee

data/lib/from_honeybee/material/window_gas.rb

@@ -0,0 +1,76 @@
+# *******************************************************************************
+# 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 'from_honeybee/model_object'
+
+require 'openstudio'
+
+module FromHoneybee
+  class EnergyWindowMaterialGas < ModelObject
+    attr_reader :errors, :warnings
+
+    def initialize(hash = {})
+      super(hash)
+    end
+
+    def defaults
+      @@schema[:components][:schemas][:EnergyWindowMaterialGas][:properties]
+    end
+
+    def find_existing_openstudio_object(openstudio_model)
+      object = openstudio_model.getGasByName(@hash[:identifier])
+      return object.get if object.is_initialized
+      nil
+    end
+
+    def to_openstudio(openstudio_model)
+      # create window gas OpenStudio object
+      os_window_gas = OpenStudio::Model::Gas.new(openstudio_model)
+      os_window_gas.setName(@hash[:identifier])
+
+      # assign thickness
+      if @hash[:thickness]
+        os_window_gas.setThickness(@hash[:thickness])
+      else
+        os_window_gas.setThickness(defaults[:thickness][:default])
+      end
+
+      # assign gas type
+      if @hash[:gas_type]
+        os_window_gas.setGasType(@hash[:gas_type])
+      else
+        os_window_gas.setGasType(defaults[:gas_type][:default])
+      end
+      
+      os_window_gas
+    end
+  end # EnergyWindowMaterialGas
+end # FromHoneybee

data/lib/from_honeybee/material/window_gas_custom.rb

@@ -0,0 +1,118 @@
+# *******************************************************************************
+# 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 'from_honeybee/model_object'
+
+require 'openstudio'
+
+module FromHoneybee
+  class EnergyWindowMaterialGasCustom < ModelObject
+    attr_reader :errors, :warnings
+
+    def initialize(hash = {})
+      super(hash)
+
+    end
+
+    def defaults
+      @@schema[:components][:schemas][:EnergyWindowMaterialGasCustom][:properties]
+    end
+
+    def find_existing_openstudio_object(openstudio_model)
+      object = openstudio_model.getGasByName(@hash[:identifier])
+      return object.get if object.is_initialized
+      nil
+    end
+
+    def to_openstudio(openstudio_model)
+      # create window gas openstudio object
+      os_gas_custom = OpenStudio::Model::Gas.new(openstudio_model)
+      os_gas_custom.setName(@hash[:identifier])
+      os_gas_custom.setGasType('Custom')
+      os_gas_custom.setConductivityCoefficientA(@hash[:conductivity_coeff_a])
+      os_gas_custom.setViscosityCoefficientA(@hash[:viscosity_coeff_a])
+      os_gas_custom.setSpecificHeatCoefficientA(@hash[:specific_heat_coeff_a])
+      os_gas_custom.setSpecificHeatRatio(@hash[:specific_heat_ratio])
+      os_gas_custom.setMolecularWeight(@hash[:molecular_weight])
+
+      # assign thickness
+      if @hash[:thickness]
+        os_gas_custom.setThickness(@hash[:thickness])
+      else
+        os_gas_custom.setThickness(defaults[:thickness][:default])
+      end
+
+      # assign conductivity coefficient b
+      if @hash[:conductivity_coeff_b]
+        os_gas_custom.setConductivityCoefficientB(@hash[:conductivity_coeff_b])
+      else
+        os_gas_custom.setConductivityCoefficientB(defaults[:conductivity_coeff_b][:default])
+      end
+      
+      # assign conductivity coeffient c
+      if @hash[:conductivity_coeff_c]
+        os_gas_custom.setConductivityCoefficientC(@hash[:conductivity_coeff_c])
+      else
+        os_gas_custom.setConductivityCoefficientC(defaults[:conductivity_coeff_c][:default])
+      end
+      
+      # assign viscosity coefficient b
+      if @hash[:viscosity_coeff_b]
+        os_gas_custom.setViscosityCoefficientB(@hash[:viscosity_coeff_b])
+      else
+        os_gas_custom.setViscosityCoefficientB(defaults[:viscosity_coeff_b][:default])
+      end
+      
+      # assign viscosity coefficient c
+      if @hash[:viscosity_coeff_c]
+        os_gas_custom.setViscosityCoefficientC(@hash[:viscosity_coeff_c])
+      else
+        os_gas_custom.setViscosityCoefficientC(defaults[:viscosity_coeff_c][:default])
+      end
+
+      # assign specific heat coefficient b
+      if @hash[:specific_heat_coeff_b]
+        os_gas_custom.setSpecificHeatCoefficientB(@hash[:specific_heat_coeff_b])
+      else
+        os_gas_custom.setSpecificHeatCoefficientB(defaults[:specific_heat_coeff_b][:default])
+      end
+
+      # assign specific heat coefficient c
+      if @hash[:specific_heat_coeff_c]
+        os_gas_custom.setSpecificHeatCoefficientC(@hash[:specific_heat_coeff_c])
+      else
+        os_gas_custom.setSpecificHeatCoefficientC(defaults[:specific_heat_coeff_c][:default])
+      end
+
+      os_gas_custom
+    end
+  end # EnergyWindowMaterialGasCustom
+end # FromHoneybee

data/lib/from_honeybee/material/window_gas_mixture.rb

@@ -0,0 +1,79 @@
+# *******************************************************************************
+# 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 'from_honeybee/model_object'
+
+require 'openstudio'
+
+module FromHoneybee
+  class EnergyWindowMaterialGasMixture < ModelObject
+    attr_reader :erros, :warnings
+
+    def initialize(hash = {})
+      super(hash)
+    end
+
+    def defaults
+      @@schema[:components][:schemas][:EnergyWindowMaterialGasMixture][:properties]
+    end
+
+    def find_existing_openstudio_object(openstudio_model)
+      object = openstudio_model.getGasMixtureByName(@hash[:identifier])
+      return object.get if object.is_initialized
+      nil
+    end
+
+    def to_openstudio(openstudio_model)
+      # create the gas mixture
+      os_gas_mixture = OpenStudio::Model::GasMixture.new(openstudio_model)
+      os_gas_mixture.setName(@hash[:identifier])
+
+      # set the thickness
+      if @hash[:thickness]
+        os_gas_mixture.setThickness(@hash[:thickness])
+      else
+        os_gas_mixture.setThickness(defaults[:thickness][:default])
+      end
+      
+      # set the gas types
+      @hash[:gas_types].each_index do |i|
+        os_gas_mixture.setGasType(i, @hash[:gas_types][i])
+      end
+      
+      # set the gas fractions
+      @hash[:gas_fractions].each_index do |i|
+        os_gas_mixture.setGasFraction(i, @hash[:gas_fractions][i])
+      end
+
+      os_gas_mixture
+    end
+  end # EnergyWindowMaterialGasMixture
+end # FromHoneybee