honeybee-openstudio 2.3.0 → 2.5.1

data/lib/from_honeybee/hvac/ideal_air.rb

@@ -100,7 +100,7 @@ module FromHoneybee
       end
 
       # assign limits to the system's heating capacity
-      if @hash[:heating_limit] == {'type': 'NoLimit'}
+      if @hash[:heating_limit] == {:type => 'NoLimit'}
         os_ideal_air.setHeatingLimit('NoLimit')
       else
         os_ideal_air.setHeatingLimit('LimitCapacity')
@@ -112,7 +112,7 @@ module FromHoneybee
       end
 
       # assign limits to the system's cooling capacity
-      if @hash[:cooling_limit] == {'type': 'NoLimit'}
+      if @hash[:cooling_limit] == {:type => 'NoLimit'}
         os_ideal_air.setCoolingLimit('NoLimit')
       else
         os_ideal_air.setCoolingLimit('LimitFlowRateAndCapacity')

data/lib/from_honeybee/hvac/template.rb

@@ -0,0 +1,201 @@
+# *******************************************************************************
+# 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 'openstudio-standards'
+require_relative 'Model.hvac'
+
+require 'from_honeybee/extension'
+require 'from_honeybee/model_object'
+
+module FromHoneybee
+  class TemplateHVAC < ModelObject
+    attr_reader :errors, :warnings
+
+    @@all_air_types = ['VAV', 'PVAV', 'PSZ', 'PTAC', 'ForcedAirFurnace']
+    @@doas_types = ['FCUwithDOAS', 'WSHPwithDOAS', 'VRFwithDOAS']
+    @@heat_cool_types = ['FCU', 'WSHP', 'VRF', 'Baseboard',  'EvaporativeCooler',
+                         'Residential', 'WindowAC', 'GasUnitHeater']
+    @@types = @@all_air_types + @@doas_types + @@heat_cool_types
+
+    def initialize(hash = {})
+      super(hash)
+    end
+
+    def self.types
+      # array of all supported template HVAC systems
+      @@types
+    end
+
+    def self.all_air_types
+      # array of the All Air HVAC types
+      @@all_air_types
+    end
+
+    def self.doas_types
+      # array of the DOAS HVAC types
+      @@doas_types
+    end
+
+    def self.heat_cool_types
+      # array of the system types providing heating and cooling only
+      @@heat_cool_types
+    end
+  
+    def defaults(system_type)
+      @@schema[:components][:schemas][system_type.to_sym][:properties]
+    end
+
+    def to_openstudio(openstudio_model, room_ids)
+      # 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
+
+      # TODO: consider adding the ability to decentralize the plant by changing loop names
+      #os_hvac.each do |hvac_loop|
+      #  loop_name = hvac_loop.name
+      #  unless loop_name.empty?
+      #    hvac_loop.setName(@hash[:identifier] + ' - ' + loop_name.get)
+      #  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
+
+      os_hvac
+    end
+
+    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 #FromHoneybee

data/lib/from_honeybee/model.rb

@@ -46,6 +46,7 @@ require 'from_honeybee/geometry/room'
 
 # import the HVAC objects
 require 'from_honeybee/hvac/ideal_air'
+require 'from_honeybee/hvac/template'
 
 # import the construction objects
 require 'from_honeybee/construction/opaque'
@@ -497,13 +498,14 @@ module FromHoneybee
 
     def create_hvacs
       if @hash[:properties][:energy][:hvacs]
+        $air_loop_count = 0  # track the total number of air loops in the model
         # gather all of the hashes of the HVACs
         hvac_hashes = Hash.new
         @hash[:properties][:energy][:hvacs].each do |hvac|
           hvac_hashes[hvac[:identifier]] = hvac
           hvac_hashes[hvac[:identifier]]['rooms'] = []
         end
-        # loop through the rooms and trach which are assigned to each HVAC
+        # loop through the rooms and track which are assigned to each HVAC
         if @hash[:rooms]
           @hash[:rooms].each do |room|
             if room[:properties][:energy][:hvac]
@@ -514,8 +516,7 @@ module FromHoneybee
 
         hvac_hashes.each_value do |hvac|
           system_type = hvac[:type]
-          case system_type
-          when 'IdealAirSystemAbridged'
+          if system_type == 'IdealAirSystemAbridged'
             ideal_air_system = IdealAirSystemAbridged.new(hvac)
             os_ideal_air_system = ideal_air_system.to_openstudio(@openstudio_model)
             hvac['rooms'].each do |room_id|
@@ -525,6 +526,9 @@ module FromHoneybee
                 os_ideal_air_system.addToThermalZone(os_thermal_zone)
               end
             end
+          elsif TemplateHVAC.types.include?(system_type)
+            template_system = TemplateHVAC.new(hvac)
+            os_template_system = template_system.to_openstudio(@openstudio_model, hvac['rooms'])
           end
         end
       end

data/lib/from_honeybee/schedule/type_limit.rb

@@ -59,11 +59,11 @@ module FromHoneybee
       os_type_limit = OpenStudio::Model::ScheduleTypeLimits.new(openstudio_model)
       os_type_limit.setName(@hash[:identifier])
 
-      if @hash[:lower_limit] != nil and @hash[:lower_limit] != {'type': 'NoLimit'}
+      if @hash[:lower_limit] != nil and @hash[:lower_limit] != {:type => 'NoLimit'}
         os_type_limit.setLowerLimitValue(@hash[:lower_limit])
       end
 
-      if @hash[:upper_limit] != nil and @hash[:upper_limit] != {'type': 'NoLimit'}
+      if @hash[:upper_limit] != nil and @hash[:upper_limit] != {:type => 'NoLimit'}
         os_type_limit.setUpperLimitValue(@hash[:upper_limit])
       end
 

data/lib/from_honeybee/ventcool/opening.rb

@@ -0,0 +1,160 @@
+# *******************************************************************************
+# 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 VentilationOpening < ModelObject
+    attr_reader :errors, :warnings
+
+    def initialize(hash = {})
+      super(hash)
+    end
+
+    def defaults
+      @@schema[:components][:schemas][:VentilationOpening][:properties]
+    end
+
+    def defaults_control
+        @@schema[:components][:schemas][:VentilationControlAbridged][:properties]
+      end
+
+    def to_openstudio(openstudio_model, parent, vent_control_hash)
+      # create wind and stack object and set identifier
+      os_opening = OpenStudio::Model::ZoneVentilationWindandStackOpenArea.new(openstudio_model)
+      os_opening.setName(parent.name.get + '_Opening')
+
+      # assign the opening area
+      if @hash[:fraction_area_operable]
+        os_opening.setOpeningArea(@hash[:fraction_area_operable]  * parent.netArea)
+      else
+        os_opening.setOpeningArea(
+          defaults[:fraction_area_operable][:default] * parent.netArea)
+      end
+
+      # assign the height
+      if @hash[:fraction_height_operable]
+        os_opening.	setHeightDifference(
+          @hash[:fraction_height_operable]  * compute_height(parent))
+      else
+        os_opening.	setHeightDifference(
+          defaults[:fraction_height_operable][:default] * compute_height(parent))
+      end
+
+      # assign the azimuth
+      az_degrees = parent.azimuth * 180 / Math::PI
+      os_opening.setEffectiveAngle(az_degrees.round())
+
+      # assign the discharge coefficient
+      if @hash[:discharge_coefficient]
+        os_opening.setDischargeCoefficientforOpening(@hash[:discharge_coefficient])
+      else
+        os_opening.setDischargeCoefficientforOpening(
+          defaults[:discharge_coefficient][:default])
+      end
+
+      # assign the wind pressure coefficient
+      if @hash[:wind_cross_vent]
+        os_opening.autocalculateOpeningEffectiveness()
+      else
+        os_opening.setOpeningEffectiveness(0)
+      end
+
+      # set all of the ventilation control properties
+      if vent_control_hash
+        # assign min_indoor_temperature
+        if vent_control_hash[:min_indoor_temperature]
+          os_opening.setMinimumIndoorTemperature(vent_control_hash[:min_indoor_temperature])
+        else
+          os_opening.setMinimumIndoorTemperature(
+            defaults_control[:min_indoor_temperature][:default])
+        end
+        # assign max_indoor_temperature
+        if vent_control_hash[:max_indoor_temperature]
+          os_opening.setMaximumIndoorTemperature(vent_control_hash[:max_indoor_temperature])
+        else
+          os_opening.setMaximumIndoorTemperature(
+            defaults_control[:max_indoor_temperature][:default])
+        end
+        # assign min_outdoor_temperature
+        if vent_control_hash[:min_outdoor_temperature]
+          os_opening.setMinimumOutdoorTemperature(vent_control_hash[:min_outdoor_temperature])
+        else
+          os_opening.setMinimumOutdoorTemperature(
+            defaults_control[:min_outdoor_temperature][:default])
+        end
+        # assign max_outdoor_temperature
+        if vent_control_hash[:max_outdoor_temperature]
+          os_opening.setMaximumOutdoorTemperature(vent_control_hash[:max_outdoor_temperature])
+        else
+          os_opening.setMaximumOutdoorTemperature(
+            defaults_control[:max_outdoor_temperature][:default])
+        end
+        # assign delta_temperature
+        if vent_control_hash[:delta_temperature]
+          os_opening.setDeltaTemperature(vent_control_hash[:delta_temperature])
+        else
+          os_opening.setDeltaTemperature(
+            defaults_control[:delta_temperature][:default])
+        end
+        # assign schedule if it exists
+        if vent_control_hash[:schedule]
+          vent_sch = openstudio_model.getScheduleByName(vent_control_hash[:schedule])
+          unless vent_sch.empty?
+            vent_sch_object = vent_sch.get
+            os_opening.setOpeningAreaFractionSchedule(vent_sch_object)
+          end
+        end
+      end
+
+      os_opening
+    end
+
+    def compute_height(surface)
+      # derive the height (difference in z values) of a surface
+      verts = surface.vertices
+      min_pt = verts[0].z
+      max_pt = verts[0].z
+      verts.each do |v|
+        if v.z < min_pt
+          min_pt = v.z
+        elsif v.z > max_pt
+          max_pt = v.z
+        end
+      end
+      max_pt - min_pt
+    end
+
+  end #VentilationOpening
+end #FromHoneybee
+  

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: honeybee-openstudio
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.5.1
 platform: ruby
 authors:
 - Tanushree Charan
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-30 00:00:00.000000000 Z
+date: 2020-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -149,6 +149,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".coveralls.yml"
+- ".github/workflows/emit-release-event.yaml"
 - ".gitignore"
 - ".releaserc.json"
 - ".travis.yml"
@@ -180,7 +181,9 @@ files:
 - lib/from_honeybee/geometry/face.rb
 - lib/from_honeybee/geometry/room.rb
 - lib/from_honeybee/geometry/shade.rb
+- lib/from_honeybee/hvac/Model.hvac.rb
 - lib/from_honeybee/hvac/ideal_air.rb
+- lib/from_honeybee/hvac/template.rb
 - lib/from_honeybee/load/electric_equipment.rb
 - lib/from_honeybee/load/gas_equipment.rb
 - lib/from_honeybee/load/infiltration.rb
@@ -207,6 +210,7 @@ files:
 - lib/from_honeybee/simulation/designday.rb
 - lib/from_honeybee/simulation/extension.rb
 - lib/from_honeybee/simulation/parameter.rb
+- lib/from_honeybee/ventcool/opening.rb
 - lib/measures/.gitkeep
 - lib/measures/from_honeybee_model/LICENSE.md
 - lib/measures/from_honeybee_model/README.md