honeybee-openstudio 2.6.2 → 2.6.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58a653751b8089a138bf8801ec4b364cc80ac8b32ea2a92e07baa138b3a800e5
-  data.tar.gz: fbc8b5a03386731492f61feb8728e45a8658002f6a92ff785b2714d6f24ce9ea
+  metadata.gz: 0b0da04a58221bdf1cd64089755dadb753e9c45feb2966a983a7aa9574dea77a
+  data.tar.gz: ef763660f47e53e7336f0b48cbaf99b89c924dbee72bef048977485d483db49e
 SHA512:
-  metadata.gz: 95f905265f9aa6c3765dc39cff0e0654b058f66d7e75070b80c52ffeb27c708e7859a9ced7290c6aa2dcbaa6af4df50afd4047a5c54e2fdf723a012e60c9b600
-  data.tar.gz: 85621370e9d5a0e3a4f120cbde34fc1187791d2c8fb4283d3cfca9272894e1ae2fac73feb03eabd300db282b2e33193acff242625b95fb83e8afa06d155ced32
+  metadata.gz: 862f2c7fa88498e78141a6293797e39e96f9b25d2e10ef8231c0899530917373774f4c4c26bfe674a7f9accc6d2e639dd0c3baab25bd543029b4740034a8ad75
+  data.tar.gz: 15bb34106c90a0f72f3e05fa5075636f2e4e28839b8a1820695087c3c2c1707e3aad9c6c2825f630f5db8e18753f8780484af2fa5005ce50a46ab67224aae114

data/honeybee-openstudio.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'honeybee-openstudio'
-  spec.version       = '2.6.2'
+  spec.version       = '2.6.7'
   spec.authors       = ['Tanushree Charan', 'Dan Macumber', 'Chris Mackey', 'Mostapha Sadeghipour Roudsari']
   spec.email         = ['tanushree.charan@nrel.gov', 'chris@ladybug.tools']
 

data/lib/files/urbanopt_Gemfile

@@ -21,4 +21,4 @@ else
 end
 
 # include the honeybee-openstudio-gem
-gem 'honeybee-openstudio', '2.5.3'
+gem 'honeybee-openstudio', '2.6.4'

data/lib/from_honeybee/construction/air.rb

@@ -55,7 +55,12 @@ module FromHoneybee
       os_construction = OpenStudio::Model::ConstructionAirBoundary.new(openstudio_model)
       os_construction.setName(@hash[:identifier])
       os_construction.setSolarAndDaylightingMethod('GroupedZones')
-      os_construction.setRadiantExchangeMethod('GroupedZones')
+      # REMOVE: Remove the use of IRTSurface once the AFN works with GroupedZone air walls
+      if !$use_simple_vent  # we're using the AFN!
+        os_construction.setRadiantExchangeMethod('IRTSurface')
+      else
+        os_construction.setRadiantExchangeMethod('GroupedZones')
+      end
       os_construction.setAirExchangeMethod('None')
 
       os_construction

data/lib/from_honeybee/geometry/room.rb

@@ -54,6 +54,7 @@ module FromHoneybee
     def initialize(hash = {})
       super(hash)
       raise "Incorrect model type '#{@type}'" unless @type == 'Room'
+      @unique_space_type = nil
     end
 
     def defaults
@@ -66,6 +67,33 @@ module FromHoneybee
       nil 
     end
 
+    def get_unique_space_type(openstudio_model, os_space)
+      # get a space type that is unique to the room
+      if @unique_space_type.nil?
+        space_type = os_space.spaceType
+        unless space_type.empty?
+          # copy the space type that is already assigned to the room
+          space_type_object = space_type.get
+          space_type_mod_obj = space_type_object.clone(openstudio_model)
+          new_space_type = space_type_mod_obj.to_SpaceType.get
+        else
+          # create a new space type as there is currently none assigned to the room
+          new_space_type = OpenStudio::Model::SpaceType.new(openstudio_model)
+        end
+        # give the space type a new unique name and assign it to the room
+        st_name = space_type_object.name
+        unless space_type.empty?
+          st_name = st_name.get
+        else
+          st_name = 'CustomSpaceType'
+        end
+        new_space_type.setName(st_name + '_' + @hash[:identifier])
+        os_space.setSpaceType(new_space_type)
+        @unique_space_type = new_space_type
+      end
+      @unique_space_type
+    end
+
     def to_openstudio(openstudio_model)
       # create the space and thermal zone
       os_space = OpenStudio::Model::Space.new(openstudio_model)
@@ -213,88 +241,75 @@ module FromHoneybee
         @hash[:outdoor_shades].each do |outdoor_shade|
           add_shade_to_group(openstudio_model, os_shd_group, outdoor_shade)
         end
-      end
+      end 
 
       #check whether there are any load objects on the room overriding the programtype
       if @hash[:properties][:energy][:people]
-        people = openstudio_model.getPeopleByName(@hash[:properties][:energy][:people][:identifier])
-        unless people.empty?
-          people_object = people.get
-          people_object.setSpace(os_space)
-        else
-          people_space = PeopleAbridged.new(@hash[:properties][:energy][:people])
-          os_people_space = people_space.to_openstudio(openstudio_model)
-          os_people_space.setSpace(os_space)
+        unique_program = get_unique_space_type(openstudio_model, os_space)
+        unique_program_ppl = unique_program.people
+        unless unique_program_ppl.empty?  # remove the previous load definition
+          unique_program_ppl[0].remove()
         end
+        custom_people = PeopleAbridged.new(@hash[:properties][:energy][:people])
+        os_custom_people = custom_people.to_openstudio(openstudio_model)
+        os_custom_people.setSpaceType(unique_program)  # assign the new load definition
       end
 
       # assign lighting if it exists
       if @hash[:properties][:energy][:lighting]
-        lighting = openstudio_model.getLightsByName(@hash[:properties][:energy][:lighting][:identifier])
-        unless lighting.empty?
-          lighting_object = lighting.get
-          lighting_object.setSpace(os_space)
-        else
-          lighting_space = LightingAbridged.new(@hash[:properties][:energy][:lighting])
-          os_lighting_space = lighting_space.to_openstudio(openstudio_model)
-          os_lighting_space.setSpace(os_space)
+        unique_program = get_unique_space_type(openstudio_model, os_space)
+        unique_program_lght = unique_program.lights
+        unless unique_program_lght.empty?  # remove the previous load definition
+          unique_program_lght[0].remove()
         end
+        custom_lighting = LightingAbridged.new(@hash[:properties][:energy][:lighting])
+        os_custom_lighting = custom_lighting.to_openstudio(openstudio_model)
+        os_custom_lighting.setSpaceType(unique_program)  # assign the new load definition
       end
 
       # assign electric equipment if it exists
       if @hash[:properties][:energy][:electric_equipment]
-        electric_equipment = openstudio_model.getElectricEquipmentByName(
-          @hash[:properties][:energy][:electric_equipment][:identifier])
-        unless electric_equipment.empty?
-          electric_equipment_object = electric_equipment.get
-          electric_equipment_object.setSpace(os_space)
-        else
-          electric_equipment_space = ElectricEquipmentAbridged.new(@hash[:properties][:energy][:electric_equipment])
-          os_electric_equipment_space = electric_equipment_space.to_openstudio(openstudio_model)
-          os_electric_equipment_space.setSpace(os_space)
+        unique_program = get_unique_space_type(openstudio_model, os_space)
+        unique_program_ele = unique_program.electricEquipment
+        unless unique_program_ele.empty?  # remove the previous load definition
+          unique_program_ele[0].remove()
         end
+        custom_electric_equipment = ElectricEquipmentAbridged.new(@hash[:properties][:energy][:electric_equipment])
+        os_custom_electric_equipment = custom_electric_equipment.to_openstudio(openstudio_model)
+        os_custom_electric_equipment.setSpaceType(unique_program)  # assign the new load definition
       end
-      
+
       # assign gas equipment if it exists
       if @hash[:properties][:energy][:gas_equipment]
-        gas_equipment = openstudio_model.getGasEquipmentByName(
-          @hash[:properties][:energy][:gas_equipment][:identifier])
-        unless gas_equipment.empty?
-          gas_equipment_object = gas_equipment.get
-          gas_equipment_object.setSpace(os_space)
-        else
-          gas_equipment_space = GasEquipmentAbridged.new(@hash[:properties][:energy][:gas_equipment])
-          os_gas_equipment_space = gas_equipment_space.to_openstudio(openstudio_model)
-          os_gas_equipment_space.setSpace(os_space)
+        unique_program = get_unique_space_type(openstudio_model, os_space)
+        unique_program_gas = unique_program.gasEquipment
+        unless unique_program_gas.empty?  # remove the previous load definition
+          unique_program_gas[0].remove()
         end
+        custom_gas_equipment = GasEquipmentAbridged.new(@hash[:properties][:energy][:gas_equipment])
+        os_custom_gas_equipment = custom_gas_equipment.to_openstudio(openstudio_model)
+        os_custom_gas_equipment.setSpaceType(unique_program)  # assign the new load definition
       end
 
       # assign infiltration if it exists
       if @hash[:properties][:energy][:infiltration] && $use_simple_vent  # only use infiltration with simple ventilation
-        infiltration = openstudio_model.getSpaceInfiltrationDesignFlowRateByName(
-          @hash[:properties][:energy][:infiltration][:identifier])
-        unless infiltration.empty?
-          infiltration_object = infiltration.get
-          infiltration_object.setSpace(os_space)
-        else
-          infiltration_space = InfiltrationAbridged.new(@hash[:properties][:energy][:infiltration])
-          os_infiltration_space = infiltration_space.to_openstudio(openstudio_model)
-          os_infiltration_space.setSpace(os_space) 
+        unique_program = get_unique_space_type(openstudio_model, os_space)
+        unique_program_inf = unique_program.spaceInfiltrationDesignFlowRates
+        unless unique_program_inf.empty?  # remove the previous load definition
+          unique_program_inf[0].remove()
         end
+        custom_infiltration = InfiltrationAbridged.new(@hash[:properties][:energy][:infiltration])
+        os_custom_infiltration = custom_infiltration.to_openstudio(openstudio_model)
+        os_custom_infiltration.setSpaceType(unique_program)  # assign the new load definition
       end
-        
+
       # assign ventilation if it exists
       if @hash[:properties][:energy][:ventilation] 
-        ventilation = openstudio_model.getDesignSpecificationOutdoorAirByName(
-          @hash[:properties][:energy][:ventilation][:identifier])
-        unless ventilation.empty?
-          ventilation_object = ventilation.get
-          ventilation_object.setSpace(os_space)
-        else
-          ventilation_space = VentilationAbridged.new(@hash[:properties][:energy][:ventilation])
-          os_ventilation_space = ventilation_space.to_openstudio(openstudio_model)
-          os_space.setDesignSpecificationOutdoorAir(os_ventilation_space)
-        end
+        unique_program = get_unique_space_type(openstudio_model, os_space)
+        unique_program.resetDesignSpecificationOutdoorAir()
+        custom_ventilation = VentilationAbridged.new(@hash[:properties][:energy][:ventilation])
+        os_custom_ventilation = custom_ventilation.to_openstudio(openstudio_model)
+        unique_program.setDesignSpecificationOutdoorAir(os_custom_ventilation)
       end
 
       # assign setpoint if it exists

data/lib/from_honeybee/model.rb

@@ -533,12 +533,14 @@ module FromHoneybee
           system_type = hvac[:type]
           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|
+              os_ideal_air = ideal_air_system.to_openstudio(@openstudio_model)
+              # enforce a strict naming system for each zone so results can be matched
+              os_ideal_air.setName(room_id + ' Ideal Loads Air System')
               zone_get = @openstudio_model.getThermalZoneByName(room_id)
               unless zone_get.empty?
                 os_thermal_zone = zone_get.get
-                os_ideal_air_system.addToThermalZone(os_thermal_zone)
+                os_ideal_air.addToThermalZone(os_thermal_zone)
               end
             end
           elsif TemplateHVAC.types.include?(system_type)

data/lib/from_honeybee/schedule/ruleset.rb

@@ -138,7 +138,7 @@ module FromHoneybee
           openstudio_schedule_rule.setApplyFriday(rule[:apply_friday])
           openstudio_schedule_rule.setApplySaturday(rule[:apply_saturday])
           year_description = openstudio_model.getYearDescription
-          start_date = year_description.makeDate(rule[:start_date][0], rule[:start_date][1])         
+          start_date = year_description.makeDate(rule[:start_date][0], rule[:start_date][1])
           end_date = year_description.makeDate(rule[:end_date][0], rule[:end_date][1])
           openstudio_schedule_rule.setStartDate(start_date)
           openstudio_schedule_rule.setEndDate(end_date)

data/lib/from_honeybee/simulation/parameter.rb

@@ -288,7 +288,18 @@ module FromHoneybee
             @hash[:run_period][:daylight_saving_time][:end_date][1])
         end
 
-        # TODO: set the holidays once they are available in OpenStudio SDK
+        # Set the holidays
+        if @hash[:run_period][:holidays]
+          @hash[:run_period][:holidays].each do |hol|
+            begin
+              os_hol = OpenStudio::Model::RunPeriodControlSpecialDays.new(
+                OpenStudio::MonthOfYear.new(hol[0]), hol[1], @openstudio_model)
+              os_hol.setDuration(1)
+              os_hol.setSpecialDayType('Holiday')
+            rescue NoMethodError  # REMOVE: Once the upgrade to OpenStudio 3.0 is official
+            end
+          end
+        end
       end
 
       # set the simulation timestep

data/lib/from_honeybee/ventcool/control.rb

@@ -98,6 +98,20 @@ module FromHoneybee
       @@sensor_count = @@sensor_count + 1
       in_air_temp.setName(in_sensor_name)
 
+      # set up a schedule sensor if there's a schedule specified
+      if @hash[:schedule]
+        vent_sch = openstudio_model.getScheduleByName(@hash[:schedule])
+        unless vent_sch.empty?  # schedule not specified
+          sch_var = OpenStudio::Model::OutputVariable.new('Schedule Value', openstudio_model)
+          sch_var.setReportingFrequency('Timestep')
+          sch_var.setKeyValue(@hash[:schedule])
+          sch_sens = OpenStudio::Model::EnergyManagementSystemSensor.new(openstudio_model, sch_var)
+          sch_sensor_name = replace_ems_special_characters(os_zone_name) + '_Sensor' + @@sensor_count.to_s
+          @@sensor_count = @@sensor_count + 1
+          sch_sens.setName(sch_sensor_name)
+        end
+      end
+
       # create the actuators for each of the operaable windows
       actuator_names = []
       vent_opening_surfaces.each do |vent_srf|
@@ -140,6 +154,10 @@ module FromHoneybee
       if delta_in_out && delta_in_out != defaults[:delta_temperature][:default]
         logic_statements << '((' + in_sensor_name + ' - Outdoor_Sensor) > ' + delta_in_out.to_s + ')'
       end
+      # check the schedule for ventilation
+      if sch_sensor_name
+        logic_statements << '(' + sch_sensor_name + ' > 0)'
+      end
       # create the complete logic statement for opening windows
       if logic_statements.empty?
         complete_logic = 'IF (Outdoor_Sensor < 100)'  # no logic has been provided; always open windows

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: honeybee-openstudio
 version: !ruby/object:Gem::Version
-  version: 2.6.2
+  version: 2.6.7
 platform: ruby
 authors:
 - Tanushree Charan
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-02 00:00:00.000000000 Z
+date: 2020-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler