honeybee-openstudio 0

data/lib/to_openstudio/material/window_gas_custom.rb

@@ -0,0 +1,108 @@
+# *******************************************************************************
+# 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/material/window_gas_custom'
+
+require 'to_openstudio/model_object'
+
+module Honeybee
+  class EnergyWindowMaterialGasCustom
+
+    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 # Honeybee

data/lib/to_openstudio/material/window_gas_mixture.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/material/window_gas_mixture'
+
+require 'to_openstudio/model_object'
+
+module Honeybee
+  class EnergyWindowMaterialGasMixture
+
+    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 # Honeybee

data/lib/to_openstudio/material/window_glazing.rb

@@ -0,0 +1,157 @@
+# *******************************************************************************
+# 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/material/window_glazing'
+
+require 'to_openstudio/model_object'
+
+module Honeybee
+  class EnergyWindowMaterialGlazing
+
+    def find_existing_openstudio_object(openstudio_model)
+      object = openstudio_model.getStandardGlazingByName(@hash[:identifier])
+      return object.get if object.is_initialized
+      nil
+    end
+
+    def to_openstudio(openstudio_model)
+      # create openstudio standard glazing object and set identifier
+      os_glazing = OpenStudio::Model::StandardGlazing.new(openstudio_model)
+      os_glazing.setName(@hash[:identifier])
+
+      # assign thickness
+      if @hash[:thickness]
+        os_glazing.setThickness(@hash[:thickness])
+      else
+        os_glazing.setThickness(defaults[:thickness][:default])
+      end
+
+      # assign solar transmittance
+      if @hash[:solar_transmittance]
+        os_glazing.setSolarTransmittanceatNormalIncidence(@hash[:solar_transmittance])
+      else
+        os_glazing.setSolarTransmittanceatNormalIncidence(
+          defaults[:solar_transmittance][:default])
+      end
+
+      # assign front solar reflectance
+      if @hash[:solar_reflectance]
+        os_glazing.setFrontSideSolarReflectanceatNormalIncidence(@hash[:solar_reflectance])
+      else
+        os_glazing.setFrontSideSolarReflectanceatNormalIncidence(
+          defaults[:solar_reflectance][:default])
+      end
+
+      # assign back solar reflectance
+      if @hash[:solar_reflectance_back]
+        os_glazing.setBackSideSolarReflectanceatNormalIncidence(@hash[:solar_reflectance_back])
+      else
+        os_glazing.setBackSideSolarReflectanceatNormalIncidence(
+          defaults[:solar_reflectance_back][:default])
+      end
+
+      # assign visible transmittance at normal incidence
+      if @hash[:visible_transmittance]
+        os_glazing.setVisibleTransmittanceatNormalIncidence(@hash[:visible_transmittance])
+      else
+        os_glazing.setVisibleTransmittanceatNormalIncidence(
+          defaults[:visible_transmittance][:default])
+      end
+
+      # assign front side visible reflectance
+      if @hash[:visible_reflectance]
+        os_glazing.setFrontSideVisibleReflectanceatNormalIncidence(@hash[:visible_reflectance])
+      else
+        os_glazing.setFrontSideVisibleReflectanceatNormalIncidence(
+          defaults[:visible_reflectance][:default])
+      end
+
+      # assign back side visible reflectance
+      if @hash[:visible_reflectance_back]
+        os_glazing.setBackSideVisibleReflectanceatNormalIncidence(@hash[:visible_reflectance_back])
+      else
+        os_glazing.setBackSideVisibleReflectanceatNormalIncidence(
+          defaults[:visible_reflectance_back][:default])
+      end
+
+      # assign infrared transmittance
+      if @hash[:infrared_transmittance]
+        os_glazing.setInfraredTransmittanceatNormalIncidence(@hash[:infrared_transmittance])
+      else
+        os_glazing.setInfraredTransmittanceatNormalIncidence(
+          defaults[:infrared_transmittance][:default])
+      end
+
+      # assign front side emissivity
+      if @hash[:emissivity]
+        os_glazing.setFrontSideInfraredHemisphericalEmissivity(@hash[:emissivity])
+      else
+        os_glazing.setFrontSideInfraredHemisphericalEmissivity(
+          defaults[:emissivity][:default])
+      end
+
+      # assign back side emissivity
+      if @hash[:emissivity_back]
+        os_glazing.setBackSideInfraredHemisphericalEmissivity(@hash[:emissivity_back])
+      else
+        os_glazing.setBackSideInfraredHemisphericalEmissivity(
+          defaults[:emissivity_back][:default])
+      end
+
+      # assign conductivity
+      if @hash[:conductivity]
+        os_glazing.setThermalConductivity(@hash[:conductivity])
+      else
+        os_glazing.setThermalConductivity(
+          defaults[:conductivity_glass][:default])
+      end
+
+      # assign dirt correction
+      if @hash[:dirt_correction]
+        os_glazing.setDirtCorrectionFactorforSolarandVisibleTransmittance(@hash[:dirt_correction])
+      else
+        os_glazing.setDirtCorrectionFactorforSolarandVisibleTransmittance(
+          defaults[:dirt_correction][:default])
+      end
+
+      # assign solar diffusing
+      if @hash[:solar_diffusing] == false
+        os_glazing.setSolarDiffusing(false)
+      elsif @hash[:solar_diffusing] == true
+        os_glazing.setSolarDiffusing(true)
+      else
+        os_glazing.setSolarDiffusing(defaults[:solar_diffusing][:default])
+      end
+
+      os_glazing
+    end
+  end # EnergyWindowMaterialGlazing
+end # Honeybee

data/lib/to_openstudio/material/window_shade.rb

@@ -0,0 +1,151 @@
+# *******************************************************************************
+# 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/material/window_shade'
+
+require 'to_openstudio/model_object'
+
+module Honeybee
+  class EnergyWindowMaterialShade
+
+    def find_existing_openstudio_object(openstudio_model)
+      object = openstudio_model.getShadeByName(@hash[:identifier])
+      return object.get if object.is_initialized
+      nil
+    end
+
+    def to_openstudio(openstudio_model)
+      # create openstudio shade object
+      os_shade_mat = OpenStudio::Model::Shade.new(openstudio_model)
+      os_shade_mat.setName(@hash[:identifier])
+
+      # assign solar transmittance
+      if @hash[:solar_transmittance]
+        os_shade_mat.setSolarTransmittance(@hash[:solar_transmittance])
+      else
+        os_shade_mat.setSolarTransmittance(defaults[:solar_transmittance][:default])
+      end
+
+      # assign solar reflectance
+      if @hash[:solar_reflectance]
+        os_shade_mat.setSolarReflectance(@hash[:solar_reflectance])
+      else
+        os_shade_mat.setSolarReflectance(defaults[:solar_reflectance][:default])
+      end
+
+      # assign visible transmittance
+      if @hash[:visible_transmittance]
+        os_shade_mat.setVisibleTransmittance(@hash[:visible_transmittance])
+      else
+        os_shade_mat.setVisibleTransmittance(defaults[:visible_transmittance][:default])
+      end
+
+      # assign visible reflectance
+      if @hash[:visible_reflectance]
+        os_shade_mat.setVisibleReflectance(@hash[:visible_reflectance])
+      else
+        os_shade_mat.setVisibleReflectance(defaults[:visible_reflectance][:default])
+      end
+
+      # assign emissivity
+      if @hash[:emissivity]
+        os_shade_mat.setThermalHemisphericalEmissivity(@hash[:emissivity])
+      else
+        os_shade_mat.setThermalHemisphericalEmissivity(defaults[:emissivity][:default])
+      end
+
+      # assign infrared transmittance
+      if @hash[:infrared_transmittance]
+        os_shade_mat.setThermalTransmittance(@hash[:infrared_transmittance])
+      else
+        os_shade_mat.setThermalTransmittance(defaults[:infrared_transmittance][:default])
+      end
+
+      # assign thickness
+      if @hash[:thickness]
+        os_shade_mat.setThickness(@hash[:thickness])
+      else
+        os_shade_mat.setThickness(defaults[:thickness][:default])
+      end
+
+      # assign conductivity
+      if @hash[:conductivity]
+        os_shade_mat.setConductivity(@hash[:conductivity])
+      else
+        os_shade_mat.setConductivity(defaults[:conductivity][:default])
+      end
+
+      # assign distance to glass
+      if @hash[:distance_to_glass]
+        os_shade_mat.setShadetoGlassDistance(@hash[:distance_to_glass])
+      else
+        os_shade_mat.setShadetoGlassDistance(defaults[:distance_to_glass][:default])
+      end
+
+      # assign top opening multiplier
+      if @hash[:top_opening_multiplier]
+        os_shade_mat.setTopOpeningMultiplier(@hash[:top_opening_multiplier])
+      else
+        os_shade_mat.setTopOpeningMultiplier(defaults[:top_opening_multiplier][:default])
+      end
+
+      # assign bottom opening multiplier
+      if @hash[:bottom_opening_multiplier]
+        os_shade_mat.setBottomOpeningMultiplier(@hash[:bottom_opening_multiplier])
+      else
+        os_shade_mat.setBottomOpeningMultiplier(defaults[:bottom_opening_multiplier][:default])
+      end
+
+      # assign left opening multiplier
+      if @hash[:left_opening_multiplier]
+        os_shade_mat.setLeftSideOpeningMultiplier(@hash[:left_opening_multiplier])
+      else
+        os_shade_mat.setLeftSideOpeningMultiplier(defaults[:left_opening_multiplier][:default])
+      end
+
+      # assign right opening muliplier
+      if @hash[:right_opening_multiplier]
+        os_shade_mat.setRightSideOpeningMultiplier(@hash[:right_opening_multiplier])
+      else
+        os_shade_mat.setRightSideOpeningMultiplier(defaults[:right_opening_multiplier][:default])
+      end
+
+      # assign airflow permeability
+      if @hash[:airflow_permeability]
+        os_shade_mat.setAirflowPermeability(@hash[:airflow_permeability])
+      else
+        os_shade_mat.setAirflowPermeability(defaults[:airflow_permeability][:default])
+      end
+
+      os_shade_mat
+    end
+  end # EnergyWindowMaterialShade
+end # Honeybee