honeybee-openstudio 0

data/lib/to_openstudio/hvac/ideal_air.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/hvac/ideal_air'
+
+require 'to_openstudio/model_object'
+
+module Honeybee
+  class IdealAirSystemAbridged
+
+    def to_openstudio(openstudio_model)
+      # create the ideal air system and set the identifier
+      os_ideal_air = OpenStudio::Model::ZoneHVACIdealLoadsAirSystem.new(openstudio_model)
+      os_ideal_air.setName(@hash[:identifier])
+
+      # assign the economizer type
+      if @hash[:economizer_type]
+        os_ideal_air.setOutdoorAirEconomizerType(@hash[:economizer_type])
+      else
+        os_ideal_air.setOutdoorAirEconomizerType(
+          defaults[:economizer_type][:default])
+      end
+
+      # set the sensible heat recovery
+      if @hash[:sensible_heat_recovery] != 0
+        os_ideal_air.setSensibleHeatRecoveryEffectiveness(@hash[:sensible_heat_recovery])
+        os_ideal_air.setHeatRecoveryType('Sensible')
+      else
+        os_ideal_air.setSensibleHeatRecoveryEffectiveness(
+          defaults[:sensible_heat_recovery][:default])
+      end
+
+      # set the latent heat recovery
+      if @hash[:latent_heat_recovery] != 0
+        os_ideal_air.setLatentHeatRecoveryEffectiveness(@hash[:latent_heat_recovery])
+        os_ideal_air.setHeatRecoveryType('Enthalpy')
+      else
+        os_ideal_air.setLatentHeatRecoveryEffectiveness(
+          defaults[:latent_heat_recovery][:default])
+      end
+
+      # assign the demand controlled ventilation
+      if @hash[:demand_controlled_ventilation]
+        os_ideal_air.setDemandControlledVentilationType('OccupancySchedule')
+      else
+        os_ideal_air.setDemandControlledVentilationType('None')
+      end
+
+      # set the maximum heating supply air temperature
+      if @hash[:heating_air_temperature]
+        os_ideal_air.setMaximumHeatingSupplyAirTemperature(@hash[:heating_air_temperature])
+      else
+        os_ideal_air.setMaximumHeatingSupplyAirTemperature(
+          defaults[:heating_air_temperature][:default])
+      end
+
+      # set the maximum cooling supply air temperature
+      if @hash[:cooling_air_temperature]
+        os_ideal_air.setMinimumCoolingSupplyAirTemperature(@hash[:cooling_air_temperature])
+      else
+        os_ideal_air.setMinimumCoolingSupplyAirTemperature(
+          defaults[:cooling_air_temperature][:default])
+      end
+
+      # assign limits to the system's heating capacity
+      if @hash[:heating_limit] == {:type => 'NoLimit'}
+        os_ideal_air.setHeatingLimit('NoLimit')
+      else
+        os_ideal_air.setHeatingLimit('LimitCapacity')
+        if @hash[:heating_limit].is_a? Numeric
+          os_ideal_air.setMaximumSensibleHeatingCapacity(@hash[:heating_limit])
+        else
+          os_ideal_air.autosizeMaximumSensibleHeatingCapacity()
+        end
+      end
+
+      # assign limits to the system's cooling capacity
+      if @hash[:cooling_limit] == {:type => 'NoLimit'}
+        os_ideal_air.setCoolingLimit('NoLimit')
+      else
+        os_ideal_air.setCoolingLimit('LimitFlowRateAndCapacity')
+        if @hash[:cooling_limit].is_a? Numeric
+          os_ideal_air.setMaximumTotalCoolingCapacity(@hash[:cooling_limit])
+          os_ideal_air.autosizeMaximumCoolingAirFlowRate()
+        else
+          os_ideal_air.autosizeMaximumTotalCoolingCapacity()
+          os_ideal_air.autosizeMaximumCoolingAirFlowRate()
+        end
+      end
+
+      # assign heating availability schedules
+      if @hash[:heating_availability]
+        schedule = openstudio_model.getScheduleByName(@hash[:heating_availability])
+        unless schedule.empty?
+          os_schedule = schedule.get
+          os_ideal_air.setHeatingAvailabilitySchedule(os_schedule)
+        end
+      end
+
+      # assign cooling availability schedules
+      if @hash[:cooling_availability]
+        schedule = openstudio_model.getScheduleByName(@hash[:cooling_availability])
+        unless schedule.empty?
+          os_schedule = schedule.get
+          os_ideal_air.setCoolingAvailabilitySchedule(os_schedule)
+        end
+      end
+
+      os_ideal_air
+    end
+
+  end #IdealAirSystemAbridged
+end #Honeybee

data/lib/to_openstudio/hvac/template.rb

@@ -0,0 +1,169 @@
+# *******************************************************************************
+# 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/hvac/template'
+
+require 'to_openstudio/model_object'
+
+module Honeybee
+  class TemplateHVAC
+
+    def to_openstudio(openstudio_model, room_ids)
+
+      # only load openstudio-standards when needed
+      require 'openstudio-standards'
+      require_relative 'Model.hvac'
+
+      # get the defaults for the specific system type
+      hvac_defaults = defaults(@hash[:type])
+
+      # make the standard applier
+      if @hash[:vintage]
+        standard = Standard.build(@hash[:vintage])
+      else
+        standard = Standard.build(hvac_defaults[:vintage][:default])
+      end
+
+      # get the default equipment type
+      if @hash[:equipment_type]
+        equipment_type = @hash[:equipment_type]
+      else
+        equipment_type = hvac_defaults[:equipment_type][:default]
+      end
+
+      # get all of the thermal zones from the Model using the room identifiers
+      zones = []
+      room_ids.each do |room_id|
+        zone_get = openstudio_model.getThermalZoneByName(room_id)
+        unless zone_get.empty?
+          os_thermal_zone = zone_get.get
+          zones << os_thermal_zone
+        end
+      end
+
+      # create the HVAC system and assign the display name to the air loop name if it exists
+      os_hvac = openstudio_model.add_cbecs_hvac_system(standard, equipment_type, zones)
+      os_air_loop = nil
+      air_loops = openstudio_model.getAirLoopHVACs
+      unless air_loops.length == $air_loop_count  # check if any new loops were added
+        $air_loop_count = air_loops.length
+        os_air_loop = air_loops[-1]
+        loop_name = os_air_loop.name
+        unless loop_name.empty?
+          if @hash[:display_name]
+            os_air_loop.setName(@hash[:display_name] + ' - ' + loop_name.get)
+          end
+        end
+      end
+
+      # assign the economizer type if there's an air loop and the economizer is specified
+      if @hash[:economizer_type] && @hash[:economizer_type] != 'Inferred' && os_air_loop
+        oasys = os_air_loop.airLoopHVACOutdoorAirSystem
+        unless oasys.empty?
+            os_oasys = oasys.get
+            oactrl = os_oasys.getControllerOutdoorAir
+            oactrl.setEconomizerControlType(@hash[:economizer_type])
+        end
+      end
+
+      # set the sensible heat recovery if there's an air loop and the heat recovery is specified
+      if @hash[:sensible_heat_recovery] && @hash[:sensible_heat_recovery] != {:type => 'Autosize'} && os_air_loop
+        erv = get_existing_erv(os_air_loop)
+        unless erv
+          erv = create_erv(openstudio_model, os_air_loop)
+        end
+        eff_at_max = @hash[:sensible_heat_recovery] * (0.76 / 0.81)  # taken from OpenStudio defaults
+        erv.setSensibleEffectivenessat100CoolingAirFlow(eff_at_max)
+        erv.setSensibleEffectivenessat100HeatingAirFlow(eff_at_max)
+        erv.setSensibleEffectivenessat75CoolingAirFlow(@hash[:sensible_heat_recovery])
+        erv.setSensibleEffectivenessat75HeatingAirFlow(@hash[:sensible_heat_recovery])
+      end
+
+      # set the latent heat recovery if there's an air loop and the heat recovery is specified
+      if @hash[:latent_heat_recovery] && @hash[:latent_heat_recovery] != {:type => 'Autosize'} && os_air_loop
+        erv = get_existing_erv(os_air_loop)
+        unless erv
+          erv = create_erv(openstudio_model, os_air_loop)
+        end
+        eff_at_max = @hash[:latent_heat_recovery] * (0.68 / 0.73)  # taken from OpenStudio defaults
+        erv.setLatentEffectivenessat100CoolingAirFlow(eff_at_max)
+        erv.setLatentEffectivenessat100HeatingAirFlow(eff_at_max)
+        erv.setLatentEffectivenessat75CoolingAirFlow(@hash[:latent_heat_recovery])
+        erv.setLatentEffectivenessat75HeatingAirFlow(@hash[:latent_heat_recovery])
+      end
+
+      # set all plants to non-coincident sizing to avoid simualtion control on design days
+      openstudio_model.getPlantLoops.each do |loop|
+        sizing = loop.sizingPlant
+        sizing.setSizingOption('NonCoincident')
+      end
+
+      os_hvac
+    end
+
+  private
+
+    def get_existing_erv(os_air_loop)
+      # get an existing heat ecovery unit from an air loop; will be nil if there is none
+      os_air_loop.oaComponents.each do |supply_component|
+        if not supply_component.to_HeatExchangerAirToAirSensibleAndLatent.empty?
+          erv = supply_component.to_HeatExchangerAirToAirSensibleAndLatent.get
+          return erv
+        end
+      end
+      nil
+    end
+
+    def create_erv(model, os_air_loop)
+      # create a heat recovery unit with default zero efficiencies
+      heat_ex = OpenStudio::Model::HeatExchangerAirToAirSensibleAndLatent.new(model)
+      heat_ex.setEconomizerLockout(false)
+      heat_ex.setName(@hash[:identifier] + '_Heat Recovery Unit')
+      heat_ex.setSensibleEffectivenessat100CoolingAirFlow(0)
+      heat_ex.setSensibleEffectivenessat100HeatingAirFlow(0)
+      heat_ex.setSensibleEffectivenessat75CoolingAirFlow(0)
+      heat_ex.setSensibleEffectivenessat75HeatingAirFlow(0)
+      heat_ex.setLatentEffectivenessat100CoolingAirFlow(0)
+      heat_ex.setLatentEffectivenessat100HeatingAirFlow(0)
+      heat_ex.setLatentEffectivenessat75CoolingAirFlow(0)
+      heat_ex.setLatentEffectivenessat75HeatingAirFlow(0)
+
+      # add the heat exchanger to the air loop
+      outdoor_node = os_air_loop.reliefAirNode
+      unless outdoor_node.empty?
+        os_outdoor_node = outdoor_node.get
+        heat_ex.addToNode(os_outdoor_node)
+      end
+      heat_ex
+    end
+
+  end #TemplateHVAC
+end #Honeybee

data/lib/to_openstudio/load/electric_equipment.rb

@@ -0,0 +1,87 @@
+# *******************************************************************************
+# 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/load/electric_equipment'
+
+require 'to_openstudio/model_object'
+
+module Honeybee
+  class ElectricEquipmentAbridged
+
+    def find_existing_openstudio_object(openstudio_model)
+      model_electric_equipment = openstudio_model.getElectricEquipmentDefinitionByName(@hash[:identifier])
+      return model_electric_equipment.get unless model_electric_equipment.empty?
+      nil
+    end
+
+    def to_openstudio(openstudio_model)
+      # create electrical equipment and set identifier
+      os_electric_equip_def = OpenStudio::Model::ElectricEquipmentDefinition.new(openstudio_model)
+      os_electric_equip = OpenStudio::Model::ElectricEquipment.new(os_electric_equip_def)
+      os_electric_equip_def.setName(@hash[:identifier])
+      os_electric_equip.setName(@hash[:identifier])
+
+      # assign watts per area
+      os_electric_equip_def.setWattsperSpaceFloorArea(@hash[:watts_per_area])
+
+      # assign schedule
+      electric_equipment_schedule = openstudio_model.getScheduleByName(@hash[:schedule])
+      unless electric_equipment_schedule.empty?
+        electric_equipment_schedule_object = electric_equipment_schedule.get
+        os_electric_equip.setSchedule(electric_equipment_schedule_object)
+      end
+
+      # assign radiant fraction if it exists
+      if @hash[:radiant_fraction]
+        os_electric_equip_def.setFractionRadiant(@hash[:radiant_fraction])
+      else
+        os_electric_equip_def.setFractionRadiant(defaults[:radiant_fraction][:default])
+      end
+
+      # assign latent fraction if it exists
+      if @hash[:latent_fraction]
+        os_electric_equip_def.setFractionLatent(@hash[:latent_fraction])
+      else
+        os_electric_equip_def.setFractionLatent(defaults[:latent_fraction][:default])
+      end
+
+      # assign lost fraction if it exists
+      if @hash[:lost_fraction]
+        os_electric_equip_def.setFractionLost(@hash[:lost_fraction])
+      else
+        os_electric_equip_def.setFractionLost(defaults[:lost_fraction][:default])
+      end
+
+      os_electric_equip
+    end
+
+  end #ElectricEquipmentAbridged
+end #Honeybee

data/lib/to_openstudio/load/gas_equipment.rb

@@ -0,0 +1,88 @@
+# *******************************************************************************
+# 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/load/gas_equipment'
+
+require 'to_openstudio/model_object'
+
+module Honeybee
+  class GasEquipmentAbridged
+
+    def find_existing_openstudio_object(openstudio_model)
+      model_gas_equipment = openstudio_model.getGasEquipmentDefinitionByName(@hash[:identifier])
+      return model_gas_equipment.get unless model_gas_equipment.empty?
+      nil
+    end
+
+    def to_openstudio(openstudio_model)
+
+      # create gas equipment and set identifier
+      os_gas_equip_def = OpenStudio::Model::GasEquipmentDefinition.new(openstudio_model)
+      os_gas_equip = OpenStudio::Model::GasEquipment.new(os_gas_equip_def)
+      os_gas_equip_def.setName(@hash[:identifier])
+      os_gas_equip.setName(@hash[:identifier])
+
+      # assign watts per space floor area
+      os_gas_equip_def.setWattsperSpaceFloorArea(@hash[:watts_per_area])
+
+      # assign schedule
+      gas_equipment_schedule = openstudio_model.getScheduleByName(@hash[:schedule])
+      unless gas_equipment_schedule.empty?
+        gas_equipment_schedule_object = gas_equipment_schedule.get
+        os_gas_equip.setSchedule(gas_equipment_schedule_object)
+      end
+
+      # assign radiant fraction if it exists
+      if @hash[:radiant_fraction]
+        os_gas_equip_def.setFractionRadiant(@hash[:radiant_fraction])
+      else
+        os_gas_equip_def.setFractionRadiant(defaults[:radiant_fraction][:default])
+      end
+
+      # assign latent fraction if it exists
+      if @hash[:latent_fraction]
+        os_gas_equip_def.setFractionLatent(@hash[:latent_fraction])
+      else
+        os_gas_equip_def.setFractionLatent(defaults[:latent_fraction][:default])
+      end
+
+      # assign lost fraction if it exists
+      if @hash[:lost_fraction]
+        os_gas_equip_def.setFractionLost(@hash[:lost_fraction])
+      else
+        os_gas_equip_def.setFractionLost(defaults[:lost_fraction][:default])
+      end
+
+      os_gas_equip
+    end
+
+  end #GasEquipmentAbridged
+end #Honeybee