Merge pull request #324 from NREL/os_v3

Update to OpenStudio v3.0.0

Author: shorowit

.circleci/config.yml

@@ -2,7 +2,7 @@ version: 2
 jobs:
   build:
     docker:
-      - image: nrel/openstudio:2.9.1
+      - image: nrel/openstudio:3.0.0
     steps:
       - checkout
       - run: 

.rubocop.yml

@@ -1,2 +1,16 @@
 Layout/EndOfLine:
-  Enabled: false
+  Enabled: false
+Metrics/LineLength:
+  AutoCorrect: false
+  Enabled: false
+Layout/RescueEnsureAlignment:
+  AutoCorrect: true
+Style/FrozenStringLiteralComment:
+  AutoCorrect: true
+# Enable the cops below when rubocop is upgraded
+#Style/HashEachMethods:
+#  Enabled: true
+#Style/HashTransformKeys:
+#  Enabled: true
+#Style/HashTransformValues:
+#  Enabled: true

Gemfile

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 source 'http://rubygems.org'
 
-gem 'nokogiri', '~> 1.6', '<= 1.6.8.1'
+gem 'nokogiri', '~> 1.10'
+gem 'oga'
 gem 'rake'
 gem 'minitest', '~> 5.9'
 gem 'ci_reporter_minitest', '~> 1.0.0'

Gemfile.lock

@@ -2,6 +2,7 @@ GEM
   remote: http://rubygems.org/
   specs:
     ansi (1.5.0)
+    ast (2.4.0)
     builder (3.2.3)
     ci_reporter (2.0.0)
       builder (>= 2.1.2)
@@ -14,7 +15,7 @@ GEM
       url
     docile (1.3.2)
     json (2.2.0)
-    mini_portile2 (2.1.0)
+    mini_portile2 (2.4.0)
     minitest (5.11.3)
     minitest-ci (3.4.0)
       minitest (>= 5.0.6)
@@ -23,9 +24,17 @@ GEM
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    nokogiri (1.6.8.1-x64-mingw32)
-      mini_portile2 (~> 2.1.0)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    nokogiri (1.10.9-x64-mingw32)
+      mini_portile2 (~> 2.4.0)
+    oga (3.2)
+      ast
+      ruby-ll (~> 2.1)
     rake (13.0.1)
+    ruby-ll (2.1.2)
+      ansi
+      ast
     ruby-progressbar (1.10.1)
     simplecov (0.17.0)
       docile (~> 1.1)
@@ -35,6 +44,7 @@ GEM
     url (0.3.2)
 
 PLATFORMS
+  ruby
   x64-mingw32
 
 DEPENDENCIES
@@ -43,9 +53,10 @@ DEPENDENCIES
   minitest (~> 5.9)
   minitest-ci
   minitest-reporters
-  nokogiri (~> 1.6, <= 1.6.8.1)
+  nokogiri (~> 1.10)
+  oga
   rake
   simplecov
 
 BUNDLED WITH
-   1.17.1
+   2.1.4

HPXMLtoOpenStudio/measure.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # see the URL below for information on how to write OpenStudio measures
 # http://nrel.github.io/OpenStudio-user-documentation/reference/measure_writing_guide/
 
@@ -81,7 +83,7 @@ def run(model, runner, user_arguments)
     tear_down_model(model, runner)
 
     # Check for correct versions of OS
-    os_version = '2.9.1'
+    os_version = '3.0.0'
     if OpenStudio.openStudioVersion != os_version
       fail "OpenStudio version #{os_version} is required."
     end
@@ -98,6 +100,7 @@ def run(model, runner, user_arguments)
     unless File.exist?(hpxml_path) && hpxml_path.downcase.end_with?('.xml')
       fail "'#{hpxml_path}' does not exist or is not an .xml file."
     end
+
     unless (Pathname.new weather_dir).absolute?
       weather_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', weather_dir))
     end
@@ -147,7 +150,7 @@ def validate_hpxml(runner, hpxml_path, hpxml)
     is_valid = true
 
     # Validate input HPXML against schema
-    XMLHelper.validate(hpxml.doc.to_s, File.join(schemas_dir, 'HPXML.xsd'), runner).each do |error|
+    XMLHelper.validate(hpxml.doc.to_xml, File.join(schemas_dir, 'HPXML.xsd'), runner).each do |error|
       runner.registerError("#{hpxml_path}: #{error}")
       is_valid = false
     end
@@ -420,17 +423,20 @@ def self.set_defaults_and_globals(runner)
     @hpxml.cooling_systems.each do |cooling_system|
       next unless cooling_system.cooling_system_type == HPXML::HVACTypeCentralAirConditioner
       next unless cooling_system.compressor_type.nil?
+
       cooling_system.compressor_type = HVAC.get_default_compressor_type(cooling_system.cooling_efficiency_seer)
     end
     @hpxml.heat_pumps.each do |heat_pump|
       next unless heat_pump.heat_pump_type == HPXML::HVACTypeHeatPumpAirToAir
       next unless heat_pump.compressor_type.nil?
+
       heat_pump.compressor_type = HVAC.get_default_compressor_type(heat_pump.cooling_efficiency_seer)
     end
 
     # Default AC/HP sensible heat ratio
     @hpxml.cooling_systems.each do |cooling_system|
       next unless cooling_system.cooling_shr.nil?
+
       if cooling_system.cooling_system_type == HPXML::HVACTypeCentralAirConditioner
         if cooling_system.compressor_type == HPXML::HVACCompressorTypeSingleStage
           cooling_system.cooling_shr = 0.73
@@ -445,6 +451,7 @@ def self.set_defaults_and_globals(runner)
     end
     @hpxml.heat_pumps.each do |heat_pump|
       next unless heat_pump.cooling_shr.nil?
+
       if heat_pump.heat_pump_type == HPXML::HVACTypeHeatPumpAirToAir
         if heat_pump.compressor_type == HPXML::HVACCompressorTypeSingleStage
           heat_pump.cooling_shr = 0.73
@@ -730,7 +737,7 @@ def self.set_defaults_and_globals(runner)
     if @debug && (not @output_dir.nil?)
       # Write updated HPXML object to file
       hpxml_defaults_path = File.join(@output_dir, 'in.xml')
-      XMLHelper.write_file(@hpxml.to_rexml, hpxml_defaults_path)
+      XMLHelper.write_file(@hpxml.to_oga, hpxml_defaults_path)
       runner.registerInfo("Wrote file: #{hpxml_defaults_path}")
     end
   end
@@ -743,7 +750,7 @@ def self.add_simulation_params(model)
     tstep.setNumberOfTimestepsPerHour(60 / @hpxml.header.timestep)
 
     shad = model.getShadowCalculation
-    shad.setCalculationFrequency(20)
+    shad.setShadingCalculationUpdateFrequency(20)
     shad.setMaximumFiguresInShadowOverlapCalculations(200)
 
     outsurf = model.getOutsideSurfaceConvectionAlgorithm
@@ -1682,6 +1689,7 @@ def self.add_foundation_walls_slabs(runner, model, spaces)
       found_foundation_wall = false
       @hpxml.foundation_walls.each do |foundation_wall|
         next if foundation_wall.net_area < 0.1 # skip modeling net surface area for surfaces comprised entirely of subsurface area
+
         found_foundation_wall = true if slab.interior_adjacent_to == foundation_wall.interior_adjacent_to
       end
       next if found_foundation_wall
@@ -2392,7 +2400,7 @@ def self.add_hot_water_and_appliances(runner, model, weather, spaces)
           capacity_kbtuh = water_heating_system.heating_capacity / 1000.0
 
           Waterheater.apply_tank(model, space, fuel, capacity_kbtuh, tank_vol,
-                                 ef, re, setpoint_temp, ec_adj, @nbeds, @dhw_map,
+                                 ef, re, setpoint_temp, ec_adj, @dhw_map,
                                  sys_id, desuperheater_clg_coil, jacket_r, solar_fraction)
 
         elsif wh_type == HPXML::WaterHeaterTypeTankless
@@ -2408,7 +2416,7 @@ def self.add_hot_water_and_appliances(runner, model, weather, spaces)
           tank_vol = water_heating_system.tank_volume
 
           Waterheater.apply_heatpump(model, runner, space, weather, setpoint_temp, tank_vol, ef, ec_adj,
-                                     @nbeds, @dhw_map, sys_id, jacket_r, solar_fraction)
+                                     @dhw_map, sys_id, desuperheater_clg_coil, jacket_r, solar_fraction)
 
         elsif (wh_type == HPXML::WaterHeaterTypeCombiStorage) || (wh_type == HPXML::WaterHeaterTypeCombiTankless)
 
@@ -2419,7 +2427,7 @@ def self.add_hot_water_and_appliances(runner, model, weather, spaces)
           boiler_fuel_type = water_heating_system.related_hvac_system.heating_system_fuel
           boiler, plant_loop = get_boiler_and_plant_loop(@hvac_map, water_heating_system.related_hvac_idref, sys_id)
 
-          Waterheater.apply_combi(model, runner, space, vol, setpoint_temp, ec_adj, @nbeds,
+          Waterheater.apply_combi(model, runner, space, vol, setpoint_temp, ec_adj,
                                   boiler, plant_loop, boiler_fuel_type, boiler_afue, @dhw_map,
                                   sys_id, wh_type, jacket_r, standby_loss, solar_fraction)
 
@@ -3443,6 +3451,10 @@ def self.add_component_loads_output(runner, model)
                          skylights: [],
                          internal_mass: [] }
 
+    # Output diagnostics needed for some output variables used below
+    output_diagnostics = model.getOutputDiagnostics
+    output_diagnostics.addKey('DisplayAdvancedReportVariables')
+
     model.getSurfaces.sort.each_with_index do |s, idx|
       next unless s.space.get.thermalZone.get.name.to_s == @living_zone.name.to_s
 
@@ -3460,17 +3472,20 @@ def self.add_component_loads_output(runner, model)
         fail "Unexpected subsurface for component loads: '#{ss.name}'." if key.nil?
 
         if (surface_type == 'Window') || (surface_type == 'Skylight')
-          vars = { 'Surface Window Net Heat Transfer Energy' => 'ss_net',
-                   'Surface Inside Face Internal Gains Radiation Heat Gain Energy' => 'ss_ig',
+          vars = { 'Surface Window Transmitted Solar Radiation Energy' => 'ss_trans_in',
+                   'Surface Window Shortwave from Zone Back Out Window Heat Transfer Rate' => 'ss_back_out',
                    'Surface Window Total Glazing Layers Absorbed Shortwave Radiation Rate' => 'ss_sw_abs',
                    'Surface Window Total Glazing Layers Absorbed Solar Radiation Energy' => 'ss_sol_abs',
-                   'Surface Inside Face Initial Transmitted Diffuse Transmitted Out Window Solar Radiation Rate' => 'ss_sol_out' }
+                   'Surface Inside Face Initial Transmitted Diffuse Transmitted Out Window Solar Radiation Rate' => 'ss_trans_out',
+                   'Surface Inside Face Convection Heat Gain Energy' => 'ss_conv',
+                   'Surface Inside Face Internal Gains Radiation Heat Gain Energy' => 'ss_ig',
+                   'Surface Inside Face Net Surface Thermal Radiation Heat Gain Energy' => 'ss_surf' }
         else
-          vars = { 'Surface Inside Face Convection Heat Gain Energy' => 'ss_conv',
+          vars = { 'Surface Inside Face Solar Radiation Heat Gain Energy' => 'ss_sol',
+                   'Surface Inside Face Lights Radiation Heat Gain Energy' => 'ss_lgt',
+                   'Surface Inside Face Convection Heat Gain Energy' => 'ss_conv',
                    'Surface Inside Face Internal Gains Radiation Heat Gain Energy' => 'ss_ig',
-                   'Surface Inside Face Net Surface Thermal Radiation Heat Gain Energy' => 'ss_surf',
-                   'Surface Inside Face Solar Radiation Heat Gain Energy' => 'ss_sol',
-                   'Surface Inside Face Lights Radiation Heat Gain Energy' => 'ss_lgt' }
+                   'Surface Inside Face Net Surface Thermal Radiation Heat Gain Energy' => 'ss_surf' }
         end
 
         surfaces_sensors[key] << []
@@ -3786,9 +3801,10 @@ def self.add_component_loads_output(runner, model)
       surface_sensors.each do |sensors|
         s = "Set hr_#{k} = hr_#{k}"
         sensors.each do |sensor|
-          if sensor.name.to_s.start_with?('ss_net') || sensor.name.to_s.start_with?('ss_sol_abs')
+          # remove ss_net if switch
+          if sensor.name.to_s.start_with?('ss_net', 'ss_sol_abs', 'ss_trans_in')
             s += " - #{sensor.name}"
-          elsif sensor.name.to_s.start_with?('ss_sw_abs') || sensor.name.to_s.start_with?('ss_sol_out')
+          elsif sensor.name.to_s.start_with?('ss_sw_abs', 'ss_trans_out', 'ss_back_out')
             s += " + #{sensor.name} * ZoneTimestep * 3600"
           else
             s += " + #{sensor.name}"