openstudio-extension 0.2.6 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a83259f47fe24c36e89ee7fd01cd1f776949e5a5a4e48777315e3d6ac188d2c
-  data.tar.gz: 404ebaab857a00a4ecb3ccc2a09c2b4e22a436c34a170f0d9bfd834264f2c0c9
+  metadata.gz: 26988c39ed89e37921a6a42330ad8e499571fca8c7fe3c11b626ad7e01fef336
+  data.tar.gz: 94e01bc35378f6a13f6415084c013b5a8667892f1b0924095f5a12e1cbed2d8f
 SHA512:
-  metadata.gz: a69ed15632f76aaba2506a1d7f14be462599ef31943c821e21b69d25daeac7735729629bda207b5d7c501db777e9796a70d6f4746264a2ed201239d94a514c8b
-  data.tar.gz: f36b878200be79b9b73b0dabaa84656a227dd0bc66908518e66b22a6742ae5d3a0d06f79ea1be7e9edd198889aa3f7e4f7b723fdeb0b11d1c96d4137069e673e
+  metadata.gz: 2d309ada8c6984ef040af1b2b0ace8562bfdddcf12d0f790564d977bdbbd19c2a3191e439de9aba640c053145061b5c99daad6ed028404bd05d31c07bbad14b5
+  data.tar.gz: 77458bd7a6789412d6881a376418b08c694522b1b4e767df0e5a539d0e5ad95aa134b27a101bf29edd0a17b841f46eaf2e4d44c1ec7d109a90c0a33cbb2d50bd

data/CHANGELOG.md

@@ -1,10 +1,11 @@
 # OpenStudio Extension Gem
 
-## Version 0.2.6
+## Version 0.3.0
 
-- Check that `failed.job` doesn't exist and `finished.job` does exist.
+* remove the os_lib_reporting.rb helpers. This file is only used for OS reporting measure and should not be shared with other users.
+* Upgrade dependency to openstudio-workflow gem to `~> 2.1.0`
+* This version works only with EnergyPlus 9.4 since it depends on OpenStudio workflow `~> 2.1.0`
 
-- Fixed [#98](https://github.com/NREL/openstudio-extension-gem/issues/98)
 ## Version 0.2.5
 
 * Support runner options for bundle_install_path and gemfile_path

data/lib/openstudio/extension.rb

@@ -91,6 +91,7 @@ module OpenStudio
 
         result << obj
       end
+
       return result.uniq
     end
 
@@ -105,7 +106,7 @@ module OpenStudio
         result << dir if dir
       rescue StandardError
       end
-      return result.uniq
+      return result.uniq.sort
     end
 
     ##
@@ -119,7 +120,7 @@ module OpenStudio
         result << dir if dir
       rescue StandardError
       end
-      return result.uniq
+      return result.uniq.sort
     end
 
     ##

data/lib/openstudio/extension/core/os_lib_geometry.rb

@@ -765,7 +765,7 @@ module OsLib_Geometry
     story_hash.each_with_index do |(story_name, story_data), index|
       # make new story unless story at requested height already exists.
       story = nil
-      model.getBuildingStorys.each do |ext_story|
+      model.getBuildingStorys.sort.each do |ext_story|
         if (ext_story.nominalZCoordinate.to_f - story_data[:space_origin_z].to_f).abs < 0.01
           story = ext_story
         end
@@ -1133,11 +1133,11 @@ module OsLib_Geometry
   # todo - also odd with multi-height spaces
   def self.calculate_perimeter(model)
     perimeter = 0
-    model.getSpaces.each do |space|
+    model.getSpaces.sort.each do |space|
       # counter to use later
       edge_hash = {}
       edge_counter = 0
-      space.surfaces.each do |surface|
+      space.surfaces.sort.each do |surface|
         # get vertices
         vertex_hash = {}
         vertex_counter = 0

data/lib/openstudio/extension/core/os_lib_hvac.rb

@@ -117,7 +117,7 @@ module OsLib_HVAC
     zonesUnconditioned = []
 
     # get thermal zones
-    zones = model.getThermalZones
+    zones = model.getThermalZones.sort
     zones.each do |zone|
       # assign appropriate zones to zonesPlenum or zonesUnconditioned (those that don't have thermostats or zone HVAC equipment)
       # if not conditioned then add to zonesPlenum or zonesUnconditioned
@@ -177,9 +177,9 @@ module OsLib_HVAC
 
   def self.reportConditions(model, runner, condition,extra_string = '')
 
-    airloops = model.getAirLoopHVACs
-    plantLoops = model.getPlantLoops
-    zones = model.getThermalZones
+    airloops = model.getAirLoopHVACs.sort
+    plantLoops = model.getPlantLoops.sort
+    zones = model.getThermalZones.sort
 
     # count up zone equipment (not counting zone exhaust fans)
     zoneHasEquip = false
@@ -205,9 +205,9 @@ module OsLib_HVAC
   end
 
   def self.removeEquipment(model, runner)
-    airloops = model.getAirLoopHVACs
-    plantLoops = model.getPlantLoops
-    zones = model.getThermalZones
+    airloops = model.getAirLoopHVACs.sort
+    plantLoops = model.getPlantLoops.sort
+    zones = model.getThermalZones.sort
 
     # remove all airloops
     airloops.each(&:remove)
@@ -244,7 +244,7 @@ module OsLib_HVAC
     require "#{File.dirname(__FILE__)}/os_lib_schedules"
 
     schedulesHVAC = {}
-    airloops = model.getAirLoopHVACs
+    airloops = model.getAirLoopHVACs.sort
 
     # find airloop with most primary spaces
     max_primary_spaces = 0
@@ -628,7 +628,7 @@ module OsLib_HVAC
 
     # check for water-cooled chillers
     waterCooledChiller = false
-    model.getChillerElectricEIRs.each do |chiller|
+    model.getChillerElectricEIRs.sort.each do |chiller|
       next if waterCooledChiller == true
       if chiller.condenserType == 'WaterCooled'
         waterCooledChiller = true
@@ -678,7 +678,7 @@ module OsLib_HVAC
       pipe_supply_outlet.addToNode(condenser_loop.supplyOutletNode)
       setpoint_manager_follow_oa.addToNode(condenser_loop.supplyOutletNode)
       # demand side components
-      model.getChillerElectricEIRs.each do |chiller|
+      model.getChillerElectricEIRs.sort.each do |chiller|
         if chiller.condenserType == 'WaterCooled' # works only if chillers not already connected to condenser loop(s)
           condenser_loop.addDemandBranchForComponent(chiller)
         end
@@ -771,7 +771,7 @@ module OsLib_HVAC
     primary_airloops = []
     # create primary airloop for each story
     assignedThermalZones = []
-    model.getBuildingStorys.each do |building_story|
+    model.getBuildingStorys.sort.each do |building_story|
       # ML stories need to be reordered from the ground up
       thermalZonesToAdd = []
       building_story.spaces.each do |space|
@@ -1069,7 +1069,7 @@ module OsLib_HVAC
   def self.createSecondaryAirLoops(model, runner, options)
     secondary_airloops = []
     # create secondary airloop for each secondary zone
-    model.getThermalZones.each do |zone|
+    model.getThermalZones.sort.each do |zone|
       if options['zonesSecondary'].include? zone
         # create secondary airloop
         airloop_secondary = OpenStudio::Model::AirLoopHVAC.new(model)
@@ -1314,7 +1314,7 @@ module OsLib_HVAC
   end
 
   def self.createPrimaryZoneEquipment(model, runner, options)
-    model.getThermalZones.each do |zone|
+    model.getThermalZones.sort.each do |zone|
       if options['zonesPrimary'].include? zone
         if options['zoneHVAC'] == 'FanCoil'
           # create fan coil
@@ -1521,7 +1521,7 @@ module OsLib_HVAC
   def self.get_or_add_hot_water_loop(model)
     # How water loop
     hw_loop = nil
-    model.getLoops.each do |loop|
+    model.getLoops.sort.each do |loop|
       if loop.name.to_s == 'Hot Water Loop' # sizingPlant has loopType method to do this better
         hw_loop = loop.to_PlantLoop.get
       end
@@ -1580,7 +1580,7 @@ module OsLib_HVAC
     # Chilled Water Plant
     # todo - add in logic here that if existing chw_loop is air cooled, replace it with this one.
     chw_loop = nil
-    model.getLoops.each do |loop|
+    model.getLoops.sort.each do |loop|
       if loop.name.to_s == 'Chilled Water Loop'
         chw_loop = loop.to_PlantLoop.get
       end
@@ -1658,7 +1658,7 @@ module OsLib_HVAC
 
     # Condenser System
     cw_loop = nil
-    model.getLoops.each do |loop|
+    model.getLoops.sort.each do |loop|
       if loop.name.to_s == 'Condenser Water Loop'
         cw_loop = loop.to_PlantLoop.get
       end
@@ -1702,7 +1702,7 @@ module OsLib_HVAC
   def self.get_or_add_air_cooled_chiller_loop(model)
     # Chilled Water Plant
     chw_loop = nil
-    model.getLoops.each do |loop|
+    model.getLoops.sort.each do |loop|
       if loop.name.to_s == 'Chilled Water Loop'
         chw_loop = loop.to_PlantLoop.get
       end

data/lib/openstudio/extension/core/os_lib_model_generation.rb

@@ -909,6 +909,7 @@ module OsLib_ModelGeneration
     stories_flat = []
     stories_flat_counter = 0
     bar_hash[:stories].each_with_index do |(k, v), i|
+      #runner.registerInfo("STORY: k: #{k}, v: #{v}, index: #{i}")
       # k is invalid in some cases, old story object that has been removed, should be from low to high including basement
       # skip if source story insn't included in building area
       if v[:story_included_in_building_area].nil? || (v[:story_included_in_building_area] == true)
@@ -1049,7 +1050,7 @@ module OsLib_ModelGeneration
     # only intersect if make_mid_story_surfaces_adiabatic false
     if diagnostic_intersect
 
-      model.getPlanarSurfaces.each do |surface|
+      model.getPlanarSurfaces.sort.each do |surface|
         array = []
         vertices = surface.vertices
         fixed = false
@@ -1075,7 +1076,7 @@ module OsLib_ModelGeneration
       end
 
       # remove collinear points in a surface
-      model.getPlanarSurfaces.each do |surface|
+      model.getPlanarSurfaces.sort.each do |surface|
         new_vertices = OpenStudio.removeCollinear(surface.vertices)
         starting_count = surface.vertices.size
         final_count = new_vertices.size
@@ -1086,7 +1087,7 @@ module OsLib_ModelGeneration
       end
 
       # remove duplicate surfaces in a space (should be done after remove duplicate and collinear points)
-      model.getSpaces.each do |space|
+      model.getSpaces.sort.each do |space|
 
         # secondary array to compare against
         surfaces_b = space.surfaces.sort
@@ -1130,7 +1131,7 @@ module OsLib_ModelGeneration
         end
         runner.registerInfo('Intersecting and matching surfaces in model, this will create additional geometry.')
       else #elsif bar_hash[:double_loaded_corridor] # only intersect spaces in each story, not between wtory
-        model.getBuilding.buildingStories.each do |story|
+        model.getBuilding.buildingStories.sort.each do |story|
           # intersect and surface match two pair by pair
           spaces_b = story.spaces.sort
           # looping through vector of each space
@@ -1161,7 +1162,7 @@ module OsLib_ModelGeneration
           runner.registerInfo('Intersecting and matching surfaces in model, this will create additional geometry.')
         end
       else #elsif bar_hash[:double_loaded_corridor] # only intersect spaces in each story, not between wtory
-        model.getBuilding.buildingStories.each do |story|
+        model.getBuilding.buildingStories.sort.each do |story|
           story_spaces = OpenStudio::Model::SpaceVector.new
           story.spaces.sort.each do |space|
             story_spaces << space
@@ -1177,11 +1178,11 @@ module OsLib_ModelGeneration
     # set boundary conditions if not already set when geometry was created
     # todo - update this to use space original z value vs. story name
     if bar_hash[:num_stories_below_grade] > 0
-      model.getBuildingStorys.each do |story|
+      model.getBuildingStorys.sort.each do |story|
         next if !story.name.to_s.include?('Story B')
-        story.spaces.each do |space|
+        story.spaces.sort.each do |space|
           next if not new_spaces.include?(space)
-          space.surfaces.each do |surface|
+          space.surfaces.sort.each do |surface|
             next if surface.surfaceType != 'Wall'
             next if surface.outsideBoundaryCondition != 'Outdoors'
             surface.setOutsideBoundaryCondition('Ground')
@@ -1646,10 +1647,7 @@ module OsLib_ModelGeneration
           end
         end
       end
-
     end
-
-
   end
 
   # bar_from_building_type_ratios
@@ -2379,7 +2377,7 @@ module OsLib_ModelGeneration
     if args['party_wall_fraction'] > 0
       actual_ext_wall_area = model.getBuilding.exteriorWallArea
       actual_party_wall_area = 0.0
-      model.getSurfaces.each do |surface|
+      model.getSurfaces.sort.each do |surface|
         next if surface.outsideBoundaryCondition != 'Adiabatic'
         next if surface.surfaceType != 'Wall'
         actual_party_wall_area += surface.grossArea * surface.space.get.multiplier
@@ -2390,7 +2388,7 @@ module OsLib_ModelGeneration
     end
 
     # check ns/ew aspect ratio (harder to check when party walls are added)
-    wall_and_window_by_orientation = OsLib_Geometry.getExteriorWindowAndWllAreaByOrientation(model,model.getSpaces)
+    wall_and_window_by_orientation = OsLib_Geometry.getExteriorWindowAndWllAreaByOrientation(model,model.getSpaces.sort)
     wall_ns = (wall_and_window_by_orientation['northWall'] + wall_and_window_by_orientation['southWall'])
     wall_ew = wall_and_window_by_orientation['eastWall'] + wall_and_window_by_orientation['westWall']
     wall_ns_ip = OpenStudio.convert(wall_ns,'m^2','ft^2').get
@@ -2613,7 +2611,7 @@ module OsLib_ModelGeneration
 
       # remove internal loads
       if args['remove_objects']
-        model.getSpaceLoads.each do |instance|
+        model.getSpaceLoads.sort.each do |instance|
           next if instance.name.to_s.include?('Elevator') # most prototype building types model exterior elevators with name Elevator
           next if instance.to_InternalMass.is_initialized
           next if instance.to_WaterUseEquipment.is_initialized
@@ -2623,7 +2621,7 @@ module OsLib_ModelGeneration
         model.getDefaultScheduleSets.each(&:remove)
       end
 
-      model.getSpaceTypes.each do |space_type|
+      model.getSpaceTypes.sort.each do |space_type|
         # Don't add infiltration here; will be added later in the script
         test = standard.space_type_apply_internal_loads(space_type, true, true, true, true, true, false)
         if test == false
@@ -2642,7 +2640,7 @@ module OsLib_ModelGeneration
 
       # warn if spaces in model without space type
       spaces_without_space_types = []
-      model.getSpaces.each do |space|
+      model.getSpaces.sort.each do |space|
         next if space.spaceType.is_initialized
         spaces_without_space_types << space
       end
@@ -2653,7 +2651,7 @@ module OsLib_ModelGeneration
 
     # identify primary building type (used for construction, and ideally HVAC as well)
     building_types = {}
-    model.getSpaceTypes.each do |space_type|
+    model.getSpaceTypes.sort.each do |space_type|
       # populate hash of building types
       if space_type.standardsBuildingType.is_initialized
         bldg_type = space_type.standardsBuildingType.get
@@ -2697,7 +2695,7 @@ module OsLib_ModelGeneration
       end
 
       # address any adiabatic surfaces that don't have hard assigned constructions
-      model.getSurfaces.each do |surface|
+      model.getSurfaces.sort.each do |surface|
         next if surface.outsideBoundaryCondition != 'Adiabatic'
         next if surface.construction.is_initialized
         surface.setAdjacentSurface(surface)
@@ -2721,11 +2719,11 @@ module OsLib_ModelGeneration
     if args['add_elevators']
 
       # remove elevators as spaceLoads or exteriorLights
-      model.getSpaceLoads.each do |instance|
+      model.getSpaceLoads.sort.each do |instance|
         next if !instance.name.to_s.include?('Elevator') # most prototype building types model exterior elevators with name Elevator
         instance.remove
       end
-      model.getExteriorLightss.each do |ext_light|
+      model.getExteriorLightss.sort.each do |ext_light|
         next if !ext_light.name.to_s.include?('Fuel equipment') # some prototype building types model exterior elevators by this name
         ext_light.remove
       end
@@ -2746,7 +2744,7 @@ module OsLib_ModelGeneration
     if args['add_exterior_lights']
 
       if args['remove_objects']
-        model.getExteriorLightss.each do |ext_light|
+        model.getExteriorLightss.sort.each do |ext_light|
           next if ext_light.name.to_s.include?('Fuel equipment') # some prototype building types model exterior elevators by this name
           ext_light.remove
         end
@@ -2864,7 +2862,7 @@ module OsLib_ModelGeneration
     if args['add_internal_mass']
 
       if args['remove_objects']
-        model.getSpaceLoads.each do |instance|
+        model.getSpaceLoads.sort.each do |instance|
           next unless instance.to_InternalMass.is_initialized
           instance.remove
         end
@@ -2887,7 +2885,7 @@ module OsLib_ModelGeneration
         model.getThermostatSetpointDualSetpoints.each(&:remove)
       end
 
-      model.getSpaceTypes.each do |space_type|
+      model.getSpaceTypes.sort.each do |space_type|
         # create thermostat schedules
         # skip un-recognized space types
         next if standard.space_type_get_standards_data(space_type).empty?
@@ -2895,12 +2893,12 @@ module OsLib_ModelGeneration
         standard.space_type_apply_internal_load_schedules(space_type, false, false, false, false, false, false, true)
 
         # identify thermal thermostat and apply to zones (apply_internal_load_schedules names )
-        model.getThermostatSetpointDualSetpoints.each do |thermostat|
+        model.getThermostatSetpointDualSetpoints.sort.each do |thermostat|
           next if thermostat.name.to_s != "#{space_type.name} Thermostat"
           next if !thermostat.coolingSetpointTemperatureSchedule.is_initialized
           next if !thermostat.heatingSetpointTemperatureSchedule.is_initialized
           runner.registerInfo("Assigning #{thermostat.name} to thermal zones with #{space_type.name} assigned.")
-          space_type.spaces.each do |space|
+          space_type.spaces.sort.each do |space|
             next if !space.thermalZone.is_initialized
             space.thermalZone.get.setThermostatSetpointDualSetpoint(thermostat)
           end
@@ -3074,6 +3072,20 @@ module OsLib_ModelGeneration
       end
     end
 
+    # add internal mass
+    if args['add_internal_mass']
+
+      if args['remove_objects']
+        model.getSpaceLoads.sort.each do |instance|
+          next unless instance.to_InternalMass.is_initialized
+          instance.remove
+        end
+      end
+
+      # add internal mass to conditioned spaces; needs to happen after thermostats are applied
+      standard.model_add_internal_mass(model, primary_bldg_type)
+    end
+
     # set unmet hours tolerance
     unmet_hrs_tol_r = args['unmet_hours_tolerance']
     unmet_hrs_tol_k = OpenStudio.convert(unmet_hrs_tol_r, 'R', 'K').get
@@ -3117,8 +3129,8 @@ module OsLib_ModelGeneration
     set_building_defaults = runner.getBoolArgumentValue('set_building_defaults', user_arguments)
 
     # reporting initial condition of model
-    starting_spaceTypes = model.getSpaceTypes
-    starting_constructionSets = model.getDefaultConstructionSets
+    starting_spaceTypes = model.getSpaceTypes.sort
+    starting_constructionSets = model.getDefaultConstructionSets.sort
     runner.registerInitialCondition("The building started with #{starting_spaceTypes.size} space types and #{starting_constructionSets.size} construction sets.")
 
     # lookup space types for specified building type (false indicates not to use whole building type only)
@@ -3155,7 +3167,7 @@ module OsLib_ModelGeneration
     if create_space_types
 
       # array of starting space types
-      space_types_starting = model.getSpaceTypes
+      space_types_starting = model.getSpaceTypes.sort
 
       # create stub space types
       space_type_hash.each do |space_type_name, hash|
@@ -3268,11 +3280,10 @@ module OsLib_ModelGeneration
     end
 
     # reporting final condition of model
-    finishing_spaceTypes = model.getSpaceTypes
-    finishing_constructionSets = model.getDefaultConstructionSets
+    finishing_spaceTypes = model.getSpaceTypes.sort
+    finishing_constructionSets = model.getDefaultConstructionSets.sort
     runner.registerFinalCondition("The building finished with #{finishing_spaceTypes.size} space types and #{finishing_constructionSets.size} construction sets.")
 
     return true
   end
-
 end

data/lib/openstudio/extension/core/os_lib_model_simplification.rb

@@ -148,7 +148,7 @@ module OsLib_ModelSimplification
     # loop through building type hash to create multiple blends
     space_type_hash.each do |collection_name, space_types|
       if collection_name == 'Building'
-        space_array = model.getSpaces # use all space types, not just space types passed in
+        space_array = model.getSpaces.sort # use all space types, not just space types passed in
       else
         space_array = []
         space_types.each do |space_type|
@@ -229,7 +229,7 @@ module OsLib_ModelSimplification
       if collection_name == 'Building'
         # count area of spaces that have no space type
         no_space_type_area_counter = 0
-        model.getSpaces.each do |space|
+        model.getSpaces.sort.each do |space|
           if space.spaceType.empty?
             next if !space.partofTotalFloorArea
             no_space_type_area_counter += space.floorArea * space.multiplier
@@ -400,7 +400,7 @@ module OsLib_ModelSimplification
       end
     end
 
-    return model.getSpaceTypes
+    return model.getSpaceTypes.sort
   end
 
   # blend internal loads used when working from existing model
@@ -788,10 +788,10 @@ module OsLib_ModelSimplification
   def sort_building_stories_and_get_min_multiplier(model)
     sorted_building_stories = {}
     # loop through stories
-    model.getBuildingStorys.each do |story|
+    model.getBuildingStorys.sort.each do |story|
       story_min_z = nil
       # loop through spaces in story.
-      story.spaces.each do |space|
+      story.spaces.sort.each do |space|
         space_z_min = OsLib_Geometry.getSurfaceZValues(space.surfaces.to_a).min + space.zOrigin
         if story_min_z.nil? || (story_min_z > space_z_min)
           story_min_z = space_z_min
@@ -829,8 +829,8 @@ module OsLib_ModelSimplification
 
     # get bounding_box
     bounding_box = OpenStudio::BoundingBox.new
-    model.getSpaces.each do |space|
-      space.surfaces.each do |spaceSurface|
+    model.getSpaces.sort.each do |space|
+      space.surfaces.sort.each do |spaceSurface|
         bounding_box.addPoints(space.transformation * spaceSurface.vertices)
       end
     end
@@ -844,7 +844,7 @@ module OsLib_ModelSimplification
     envelope_data_hash[:building_max_xyz] = [max_x, max_y, max_z]
 
     # add orientation specific wwr
-    ext_surfaces_hash = OsLib_Geometry.getExteriorWindowAndWllAreaByOrientation(model, model.getSpaces.to_a)
+    ext_surfaces_hash = OsLib_Geometry.getExteriorWindowAndWllAreaByOrientation(model, model.getSpaces.sort.to_a)
     envelope_data_hash[:building_wwr_n] = ext_surfaces_hash['northWindow'] / ext_surfaces_hash['northWall']
     envelope_data_hash[:building_wwr_s] = ext_surfaces_hash['southWindow'] / ext_surfaces_hash['southWall']
     envelope_data_hash[:building_wwr_e] = ext_surfaces_hash['eastWindow'] / ext_surfaces_hash['eastWall']
@@ -1038,7 +1038,7 @@ module OsLib_ModelSimplification
     envelope_data_hash[:building_overhang_proj_factor_w] = building_overhang_area_w / ext_surfaces_hash['westWindow']
 
     # warn for spaces that are not on a story (in future could infer stories for these)
-    model.getSpaces.each do |space|
+    model.getSpaces.sort.each do |space|
       if !space.buildingStory.is_initialized
         runner.registerWarning("#{space.name} is not on a building story, may have unexpected results.")
       end