honeybee-openstudio 2.6.4 → 2.6.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1be0c026cdf0c7be58cad578c6aaa5bed7138ed766e5a5e0b046b33f1afa8391
-  data.tar.gz: cd5e2acee1c4940ef49ba35c8c28638f558ca5ecfb7adce46e92fb2898fd7040
+  metadata.gz: e9807e9ab401382c3e1b8e98b86e5fe65c3efa5172ddd77103964f5bf69a7a8b
+  data.tar.gz: bec119606bedf177e4d6c77a80f6768fddd248545c73082d5808d0245724611c
 SHA512:
-  metadata.gz: 19af3740a7d87564bf410a558e4c04329df1d64e0f1ce5da8e11cd7108b3c811b51aa055f208bb8dd47e0e1dfad7f5186fcdfe20ecd77d0705a39fa899f19baf
-  data.tar.gz: 300f95099b8eb11c3a88b4172e262d24476de7fff4c2d509961e96a951ae7f13b8135ac203e1f5e442f06e110aca9ce142a2ba664666447327dd1aa1ae4b5b5c
+  metadata.gz: 3a68b8ffb0e9cbf31578366fde5120249016529862a1c984339b3946110c7a526de5375291d22e43f2fd565655dda0ddf1310eeec11d9d17b7c2000677e0214e
+  data.tar.gz: 8fddadbc9346bc173447a88a747dc4cd424966d4050a686be799fe52b64643977efe4d33b8e83269b395fc9b4233e9f08ff810a854b10c10b69e9281b0c9c982

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.4'
+  spec.version       = '2.6.9'
   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/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,34 @@ 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
+          # 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
+        else
+          # create a new space type as there is currently none assigned to the room
+          new_space_type = OpenStudio::Model::SpaceType.new(openstudio_model)
+          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 +242,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

@@ -180,6 +180,16 @@ module FromHoneybee
       $interior_afn_srf_hash = Hash.new  # track whether an adjacent surface is already in the AFN
 
       # create all of the non-geometric model elements
+      if log_report  # schedules are used by all other objects and come first
+        puts 'Translating Schedules'
+      end
+      if @hash[:properties][:energy][:schedule_type_limits]
+        create_schedule_type_limits(@hash[:properties][:energy][:schedule_type_limits])
+      end
+      if @hash[:properties][:energy][:schedules]
+        create_schedules(@hash[:properties][:energy][:schedules])
+      end
+
       if log_report
         puts 'Translating Materials'
       end
@@ -201,16 +211,6 @@ module FromHoneybee
         create_construction_sets(@hash[:properties][:energy][:construction_sets])
       end
 
-      if log_report
-        puts 'Translating Schedules'
-      end
-      if @hash[:properties][:energy][:schedule_type_limits]
-        create_schedule_type_limits(@hash[:properties][:energy][:schedule_type_limits])
-      end
-      if @hash[:properties][:energy][:schedules]
-        create_schedules(@hash[:properties][:energy][:schedules])
-      end
-
       if log_report
         puts 'Translating ProgramTypes'
       end

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.4
+  version: 2.6.9
 platform: ruby
 authors:
 - Tanushree Charan
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-10 00:00:00.000000000 Z
+date: 2020-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler