honeybee-openstudio 1.8.3 → 2.1.0

data/lib/from_honeybee/model.rb

@@ -50,6 +50,7 @@ require 'from_honeybee/hvac/ideal_air'
 # import the construction objects
 require 'from_honeybee/construction/opaque'
 require 'from_honeybee/construction/window'
+require 'from_honeybee/construction/windowshade'
 require 'from_honeybee/construction/shade'
 require 'from_honeybee/construction/air'
 
@@ -184,12 +185,23 @@ module FromHoneybee
       end
       create_program_types
 
-      # create all of the model geometry
       if log_report
         puts 'Translating Room Geometry'
       end
       create_rooms
 
+      unless $window_shade_hash.empty?
+        if log_report
+          puts 'Translating Window Shading Control'
+        end
+        create_shading_control
+      end
+
+      if log_report
+        puts 'Translating HVAC Systems'
+      end
+      create_hvacs
+
       if log_report
         puts 'Translating Context Shade Geometry'
       end
@@ -197,15 +209,11 @@ module FromHoneybee
       create_orphaned_faces
       create_orphaned_apertures
       create_orphaned_doors
-
-      # create the hvac systems
-      if log_report
-        puts 'Translating HVAC Systems'
-      end
-      create_hvacs
     end
 
     def create_materials
+      $gas_gap_hash = Hash.new  # hash to track gas gaps in case they are split by shades
+
       @hash[:properties][:energy][:materials].each do |material|
         material_type = material[:type]
 
@@ -216,8 +224,13 @@ module FromHoneybee
           material_object = EnergyMaterialNoMass.new(material)
         when 'EnergyWindowMaterialGas'
           material_object = EnergyWindowMaterialGas.new(material)
+          $gas_gap_hash[material[:identifier]] = material_object
+        when 'EnergyWindowMaterialGasMixture'
+          material_object = EnergyWindowMaterialGasMixture.new(material)
+          $gas_gap_hash[material[:identifier]] = material_object
         when 'EnergyWindowMaterialGasCustom'
           material_object = EnergyWindowMaterialGasCustom.new(material)
+          $gas_gap_hash[material[:identifier]] = material_object
         when 'EnergyWindowMaterialSimpleGlazSys'
           material_object = EnergyWindowMaterialSimpleGlazSys.new(material)
         when 'EnergyWindowMaterialBlind'
@@ -235,6 +248,7 @@ module FromHoneybee
 
     def create_constructions
       $air_boundary_hash = Hash.new  # hash to track any air boundary constructions
+      $window_shade_hash = Hash.new  # hash to track any window constructions with shade
 
       @hash[:properties][:energy][:constructions].each do |construction|
         identifier = construction[:identifier]
@@ -245,6 +259,9 @@ module FromHoneybee
           construction_object = OpaqueConstructionAbridged.new(construction)
         when 'WindowConstructionAbridged'
           construction_object = WindowConstructionAbridged.new(construction)
+        when 'WindowConstructionShadeAbridged'
+          construction_object = WindowConstructionShadeAbridged.new(construction)
+          $window_shade_hash[construction[:identifier]] = construction_object
         when 'ShadeConstruction'
           construction_object = ShadeConstruction.new(construction)
         when 'AirBoundaryConstructionAbridged'
@@ -344,7 +361,7 @@ module FromHoneybee
           end
         end
       
-        # Create mixing objects between Rooms
+        # create mixing objects between Rooms
         $air_mxing_array.each do |air_mix_props|
           zone_mixing = OpenStudio::Model::ZoneMixing.new(air_mix_props[0])
           zone_mixing.setDesignFlowRate(air_mix_props[1])
@@ -361,35 +378,25 @@ module FromHoneybee
         end
       end
     end
-          
-    
-    def create_orphaned_shades
-      if @hash[:orphaned_shades]
-        shading_surface_group = OpenStudio::Model::ShadingSurfaceGroup.new(@openstudio_model)
-        shading_surface_group.setShadingSurfaceType('Building')
-        @hash[:orphaned_shades].each do |shade|
-        shade_object = Shade.new(shade)
-        openstudio_shade = shade_object.to_openstudio(@openstudio_model)
-        openstudio_shade.setShadingSurfaceGroup(shading_surface_group)
-        end
-      end
-    end
 
-    def create_orphaned_faces
-      if @hash[:orphaned_faces]
-        raise "Orphaned Faces are not translatable to OpenStudio."
-      end
-    end
-
-    def create_orphaned_apertures
-      if @hash[:orphaned_apertures]
-        raise "Orphaned Apertures are not translatable to OpenStudio."
-      end
-    end
-    
-    def create_orphaned_doors
-      if @hash[:orphaned_doors]
-        raise "Orphaned Doors are not translatable to OpenStudio."
+    def create_shading_control
+      # assign any shading control objects to windows with shades
+      # this is run as a separate step once all logic about construction sets is in place
+      sub_faces = @openstudio_model.getSubSurfaces()
+      sub_faces.each do |sub_face|
+        constr_ref = sub_face.construction
+        unless constr_ref.empty?
+          constr = constr_ref.get
+          constr_name_ref = constr.name
+          unless constr_name_ref.empty?
+            constr_name = constr_name_ref.get
+            unless $window_shade_hash[constr_name].nil?
+              window_shd_constr = $window_shade_hash[constr_name]
+              os_shd_control = window_shd_constr.to_openstudio_shading_control(@openstudio_model)
+              sub_face.setShadingControl(os_shd_control)
+            end
+          end
+        end
       end
     end
 
@@ -428,6 +435,36 @@ module FromHoneybee
       end
     end 
 
+    def create_orphaned_shades
+      if @hash[:orphaned_shades]
+        shading_surface_group = OpenStudio::Model::ShadingSurfaceGroup.new(@openstudio_model)
+        shading_surface_group.setShadingSurfaceType('Building')
+        @hash[:orphaned_shades].each do |shade|
+        shade_object = Shade.new(shade)
+        openstudio_shade = shade_object.to_openstudio(@openstudio_model)
+        openstudio_shade.setShadingSurfaceGroup(shading_surface_group)
+        end
+      end
+    end
+
+    def create_orphaned_faces
+      if @hash[:orphaned_faces]
+        raise "Orphaned Faces are not translatable to OpenStudio."
+      end
+    end
+
+    def create_orphaned_apertures
+      if @hash[:orphaned_apertures]
+        raise "Orphaned Apertures are not translatable to OpenStudio."
+      end
+    end
+    
+    def create_orphaned_doors
+      if @hash[:orphaned_doors]
+        raise "Orphaned Doors are not translatable to OpenStudio."
+      end
+    end
+
     #TODO: create runlog for errors. 
     
   end # Model

data/lib/from_honeybee/schedule/ruleset.rb

@@ -58,10 +58,23 @@ module FromHoneybee
       os_sch_ruleset = OpenStudio::Model::ScheduleRuleset.new(openstudio_model)
       os_sch_ruleset.setName(@hash[:identifier])
 
+      # assign schedule type limit
+      sch_type_limit_obj = nil
+      if @hash[:schedule_type_limit]
+        schedule_type_limit = openstudio_model.getScheduleTypeLimitsByName(@hash[:schedule_type_limit])
+        unless schedule_type_limit.empty?
+          sch_type_limit_obj = schedule_type_limit.get
+          os_sch_ruleset.setScheduleTypeLimits(sch_type_limit_obj)
+        end
+      end
+
       # loop through day schedules and create openstudio schedule day object
       @hash[:day_schedules].each do |day_schedule|
         day_schedule_new = OpenStudio::Model::ScheduleDay.new(openstudio_model)
         day_schedule_new.setName(day_schedule[:identifier])
+        unless sch_type_limit_obj.nil?
+          day_schedule_new.setScheduleTypeLimits(sch_type_limit_obj)
+        end
         values_day_new = day_schedule[:values]
         times_day_new = day_schedule[:times]
         times_day_new.delete_at(0)  # Remove [0, 0] from array at index 0.
@@ -78,8 +91,8 @@ module FromHoneybee
         unless holiday_schedule.empty?
           holiday_schedule_object = holiday_schedule.get
           begin
-            os_sch_ruleset.setHolidaySchedule(holiday_schedule_object)  
-          rescue NoMethodError 
+            os_sch_ruleset.setHolidaySchedule(holiday_schedule_object)
+          rescue NoMethodError  # REMOVE: Once the upgrade to OpenStudio 3.0 is official
           end
         end
       end
@@ -112,15 +125,6 @@ module FromHoneybee
           os_sch_ruleset.defaultDaySchedule.addValue(times[i], values[i])
         end
       end
-      
-      # assign schedule type limit
-      if @hash[:schedule_type_limit]
-        schedule_type_limit = openstudio_model.getScheduleTypeLimitsByName(@hash[:schedule_type_limit])
-        unless schedule_type_limit.empty?
-          schedule_type_limit_object = schedule_type_limit.get
-          os_sch_ruleset.setScheduleTypeLimits(schedule_type_limit_object)
-        end
-      end
 
       # assign schedule rules
       if @hash[:schedule_rules]

data/lib/from_honeybee/simulation/parameter.rb

@@ -147,23 +147,62 @@ module FromHoneybee
 
       # set defaults for the Model's ShadowCalculation object
       os_shadow_calc = @openstudio_model.getShadowCalculation
-      os_shadow_calc.setCalculationFrequency(shdw_defaults[:calculation_frequency][:default])
-      os_shadow_calc.setMaximumFiguresInShadowOverlapCalculations(shdw_defaults[:maximum_figures][:default])
-      os_shadow_calc.setCalculationMethod(shdw_defaults[:calculation_method][:default])
+      begin
+        os_shadow_calc.setShadingCalculationMethod(
+          shdw_defaults[:calculation_method][:default])
+      rescue NoMethodError  # REMOVE: Once the upgrade to OpenStudio 3.0 is official
+        os_shadow_calc.setCalculationMethod(
+          shdw_defaults[:calculation_method][:default])
+      end
+      begin
+        os_shadow_calc.setShadingCalculationUpdateFrequencyMethod(
+          shdw_defaults[:calculation_update_method][:default])
+      rescue  # REMOVE: Once the upgrade to OpenStudio 3.0 is official
+      end
+      begin
+        os_shadow_calc.setShadingCalculationUpdateFrequency(
+          shdw_defaults[:calculation_frequency][:default])
+      rescue NoMethodError  # REMOVE: Once the upgrade to OpenStudio 3.0 is official
+        os_shadow_calc.setCalculationFrequency(
+          shdw_defaults[:calculation_frequency][:default])
+      end
+      os_shadow_calc.setMaximumFiguresInShadowOverlapCalculations(
+        shdw_defaults[:maximum_figures][:default])
 
       # override any ShadowCalculation defaults with lodaded JSON
       if @hash[:shadow_calculation]
+        if @hash[:shadow_calculation][:calculation_method]
+          begin
+            os_shadow_calc.setShadingCalculationMethod(
+              @hash[:shadow_calculation][:calculation_method])
+          rescue NoMethodError  # REMOVE: Once the upgrade to OpenStudio 3.0 is official
+            os_shadow_calc.setCalculationMethod(
+              @hash[:shadow_calculation][:calculation_method])
+          end
+        end
+        if @hash[:shadow_calculation][:calculation_update_method]
+          begin
+            os_shadow_calc.setShadingCalculationUpdateFrequencyMethod(
+              @hash[:shadow_calculation][:calculation_update_method])
+          rescue  # REMOVE: Once the upgrade to OpenStudio 3.0 is official
+          end
+        end
         if @hash[:shadow_calculation][:calculation_frequency]
-          os_shadow_calc.setCalculationFrequency(@hash[:shadow_calculation][:calculation_frequency])
+          begin
+            os_shadow_calc.setShadingCalculationUpdateFrequency(
+              @hash[:shadow_calculation][:calculation_frequency])
+          rescue NoMethodError  # REMOVE: Once the upgrade to OpenStudio 3.0 is official
+            os_shadow_calc.setCalculationFrequency(
+              @hash[:shadow_calculation][:calculation_frequency])
+          end
         end
         if @hash[:shadow_calculation][:maximum_figures]
-          os_shadow_calc.setMaximumFiguresInShadowOverlapCalculations(@hash[:shadow_calculation][:maximum_figures])
-        end
-        if @hash[:shadow_calculation][:calculation_method]
-          os_shadow_calc.setCalculationMethod(@hash[:shadow_calculation][:calculation_method])
+          os_shadow_calc.setMaximumFiguresInShadowOverlapCalculations(
+            @hash[:shadow_calculation][:maximum_figures])
         end
         if @hash[:shadow_calculation][:solar_distribution]
-          os_sim_control.setSolarDistribution(@hash[:shadow_calculation][:solar_distribution])
+          os_sim_control.setSolarDistribution(
+            @hash[:shadow_calculation][:solar_distribution])
         end
       end
       
@@ -203,13 +242,13 @@ module FromHoneybee
         end
         if @hash[:output][:summary_reports]
           begin
-            os_report = OpenStudio::Model::OutputTableSummaryReports.new(@openstudio_model)
-          rescue NameError
+            os_report = @openstudio_model.getOutputTableSummaryReports
+          rescue  # REMOVE: Once the upgrade to OpenStudio 3.0 is official
           end
           @hash[:output][:summary_reports].each do |report|
             begin
               os_report.addSummaryReport(report)
-            rescue NoMethodError
+            rescue NoMethodError  # REMOVE: Once the upgrade to OpenStudio 3.0 is official
             end
           end
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: honeybee-openstudio
 version: !ruby/object:Gem::Version
-  version: 1.8.3
+  version: 2.1.0
 platform: ruby
 authors:
 - Tanushree Charan
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-27 00:00:00.000000000 Z
+date: 2020-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -19,42 +19,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 12.3.1
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 12.3.1
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -103,28 +103,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: 0.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: 0.2.3
 - !ruby/object:Gem::Dependency
   name: openstudio-standards
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.7
+        version: 0.2.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.7
+        version: 0.2.11
 - !ruby/object:Gem::Dependency
   name: public_suffix
   requirement: !ruby/object:Gem::Requirement
@@ -171,6 +171,7 @@ files:
 - lib/from_honeybee/construction/opaque.rb
 - lib/from_honeybee/construction/shade.rb
 - lib/from_honeybee/construction/window.rb
+- lib/from_honeybee/construction/windowshade.rb
 - lib/from_honeybee/construction_set.rb
 - lib/from_honeybee/extension.rb
 - lib/from_honeybee/geometry/aperture.rb
@@ -234,8 +235,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Gem for translating between Honeybee JSON and OpenStudio Model.