openstudio-standards 0.2.3 → 0.2.4

data/lib/openstudio-standards/prototypes/common/objects/Prototype.utilities.rb

@@ -843,8 +843,13 @@ class Standard
 
     # rename zone equipment list objects
     model.getZoneHVACEquipmentLists.each do |obj|
-      zone = obj.thermalZone
-      obj.setName("#{zone.name.to_s} Zone HVAC Equipment List")
+      begin
+        zone = obj.thermalZone
+        obj.setName("#{zone.name.to_s} Zone HVAC Equipment List")
+      rescue StandardError => e
+        OpenStudio.logFree(OpenStudio::Warn, "openstudio.model.Model", "Removing ZoneHVACEquipmentList #{obj.name}; missing thermal zone.")
+        obj.remove
+      end
     end
 
     return model

data/lib/openstudio-standards/standards/Standards.AirLoopHVAC.rb

@@ -840,7 +840,7 @@ class Standard
       'climate_zone' => climate_zone,
       'data_center' => is_dc
     }
-    econ_limits = model_find_object(standards_data['economizers'], search_criteria, nil)
+    econ_limits = model_find_object(standards_data['economizers'], search_criteria)
     if econ_limits.nil?
       OpenStudio.logFree(OpenStudio::Warn, 'openstudio.standards.AirLoopHVAC', "Cannot find economizer limits for #{template}, #{climate_zone}, assuming no economizer required.")
       return economizer_required

data/lib/openstudio-standards/standards/Standards.Model.rb

@@ -1183,7 +1183,11 @@ class Standard
   # @param array_of_zones [Array] an array of Hashes for each zone, with the keys 'zone',
   def model_eliminate_outlier_zones(model, array_of_zones, key_to_inspect, tolerance, field_name, units)
     # Sort the zones by the desired key
-    array_of_zones = array_of_zones.sort_by { |hsh| hsh[key_to_inspect] }
+    begin
+      array_of_zones = array_of_zones.sort_by {|hsh| hsh[key_to_inspect]}
+    rescue ArgumentError => e
+      OpenStudio.logFree(OpenStudio::Info, 'openstudio.standards.Model', "Unable to sort array_of_zones by #{key_to_inspect} due to #{e.message}, defaulting to order that was passed")
+    end
 
     # Calculate the area-weighted average
     total = 0.0
@@ -1560,50 +1564,23 @@ class Standard
   # @param search_criteria [Hash] hash of search criteria
   # @param capacity [Double] capacity of the object in question.  If capacity is supplied,
   #   the objects will only be returned if the specified capacity is between the minimum_capacity and maximum_capacity values.
+  # @param date [<OpenStudio::Date>] date of the object in question.  If date is supplied,
+  #   the objects will only be returned if the specified date is between the start_date and end_date.
+  # @param area [Double] area of the object in question.  If area is supplied,
+  #   the objects will only be returned if the specified area is between the minimum_area and maximum_area values.
+  # @param num_floors [Double] capacity of the object in question.  If num_floors is supplied,
+  #   the objects will only be returned if the specified num_floors is between the minimum_floors and maximum_floors values.
   # @return [Array] returns an array of hashes, one hash per object.  Array is empty if no results.
   # @example Find all the schedule rules that match the name
-  #   rules = model_find_objects(self, standards_data['schedules'], {'name'=>schedule_name})
-  #   if rules.size == 0
-  #     OpenStudio::logFree(OpenStudio::Warn, 'openstudio.standards.Model', "Cannot find data for schedule: #{schedule_name}, will not be created.")
-  #     return false #TODO change to return empty optional schedule:ruleset?
+  #   rules = model_find_objects(standards_data['schedules'], 'name' => schedule_name)
+  #   if rules.size.zero?
+  #     OpenStudio.logFree(OpenStudio::Error, 'openstudio.standards.Model', "Cannot find data for schedule: #{schedule_name}, will not be created.")
+  #     return false
   #   end
-  def model_find_objects(hash_of_objects, search_criteria, capacity = nil)
-    #    matching_objects = hash_of_objects.clone
-    #    #new
-    #    puts "searching"
-    #    puts search_criteria
-    #    raise ("hash of objects is nil or empty. #{hash_of_objects}") if hash_of_objects.nil? || hash_of_objects.empty? || matching_objects[0].nil?
-    #
-    #    search_criteria.each do |key,value|
-    #      puts "#{key}-#{value}"
-    #      puts matching_objects.size
-    #      #if size has already reduced to zero. Get out of loop.
-    #      break if matching_objects.size == 0
-    #      #if there are no keys that match, skip search... (This seems odd)
-    #      next unless  matching_objects[0].has_key?(key)
-    #      matching_objects.select!{ |k| k[key] == value }
-    #    end
-    #    if not capacity.nil?
-    #      puts "Capacity = #{capacity}"
-    #      capacity = capacity + (capacity * 0.01) if capacity == capacity.round
-    #      matching_objects.select!{|k| capacity.to_f > k['minimum_capacity'].to_f}
-    #      matching_objects.select!{|k| capacity.to_f <= k['maximum_capacity'].to_f}
-    #    end
-    #
-    #
-    #    # Check the number of matching objects found
-    #    if matching_objects.size == 0
-    #      OpenStudio::logFree(OpenStudio::Warn, 'openstudio.standards.Model', "Find objects search criteria returned no results. Search criteria: #{search_criteria}, capacity = #{capacity}.  Called from #{caller(0)[1]}.")
-    #
-    #    end
-    #    new_matching_objects =  matching_objects
-
-    # old
-    desired_object = nil
-    search_criteria_matching_objects = []
-    matching_objects = []
+  def model_find_objects(hash_of_objects, search_criteria, capacity = nil, date = nil, area = nil, num_floors = nil)
 
-    if hash_of_objects.is_a?(Hash) and hash_of_objects.key?('table')
+    matching_objects = []
+    if hash_of_objects.is_a?(Hash) && hash_of_objects.key?('table')
       hash_of_objects = hash_of_objects['table']
     end
 
@@ -1621,64 +1598,77 @@ class Standard
         end
       end
       # Skip objects that don't meet all search criteria
-      next if meets_all_search_criteria == false
+      next unless meets_all_search_criteria
       # If made it here, object matches all search criteria
-      search_criteria_matching_objects << object
+      matching_objects << object
     end
 
     # If capacity was specified, narrow down the matching objects
-    if capacity.nil?
-      matching_objects = search_criteria_matching_objects
-    else
+    unless capacity.nil?
+      # Skip objects that don't have fields for minimum_capacity and maximum_capacity
+      matching_objects = matching_objects.reject { |object| !object.key?('minimum_capacity') || !object.key?('maximum_capacity') }
+
+      # Skip objects that don't have values specified for minimum_capacity and maximum_capacity
+      matching_objects = matching_objects.reject { |object| object['minimum_capacity'].nil? || object['maximum_capacity'].nil? }
+
       # Round up if capacity is an integer
       if capacity == capacity.round
         capacity += (capacity * 0.01)
       end
-      search_criteria_matching_objects.each do |object|
-        # Skip objects that don't have fields for minimum_capacity and maximum_capacity
-        next if !object.key?('minimum_capacity') || !object.key?('maximum_capacity')
-        # Skip objects that don't have values specified for minimum_capacity and maximum_capacity
-        next if object['minimum_capacity'].nil? || object['maximum_capacity'].nil?
-        # Skip objects whose the minimum capacity is below the specified capacity
-        next if capacity.to_f <= object['minimum_capacity'].to_f
-        # Skip objects whose max
-        next if capacity.to_f > object['maximum_capacity'].to_f
-        # Found a matching object
-        matching_objects << object
-      end
-      # If no object was found, round the capacity down a little
-      # to avoid issues where the number fell between the limits
-      # in the json file.
-      if matching_objects.size.zero?
+      # Skip objects whose the minimum capacity is below or maximum capacity above the specified capacity
+      matching_capacity_objects = matching_objects.reject { |object| capacity.to_f <= object['minimum_capacity'].to_f || capacity.to_f > object['maximum_capacity'].to_f }
+
+      # If no object was found, round the capacity down in case the number fell between the limits in the json file.
+      if matching_capacity_objects.size.zero?
         capacity *= 0.99
-        search_criteria_matching_objects.each do |object|
-          # Skip objects that don't have fields for minimum_capacity and maximum_capacity
-          next if !object.key?('minimum_capacity') || !object.key?('maximum_capacity')
-          # Skip objects that don't have values specified for minimum_capacity and maximum_capacity
-          next if object['minimum_capacity'].nil? || object['maximum_capacity'].nil?
-          # Skip objects whose the minimum capacity is below the specified capacity
-          next if capacity <= object['minimum_capacity'].to_f
-          # Skip objects whose max
-          next if capacity > object['maximum_capacity'].to_f
-          # Found a matching object
-          matching_objects << object
-        end
+        # Skip objects whose minimum capacity is below or maximum capacity above the specified capacity
+        matching_objects = matching_objects.reject { |object| capacity.to_f <= object['minimum_capacity'].to_f || capacity.to_f > object['maximum_capacity'].to_f }
+      else
+        matching_objects = matching_capacity_objects
       end
     end
 
+    # If date was specified, narrow down the matching objects
+    unless date.nil?
+      # Skip objects that don't have fields for start_date and end_date
+      matching_objects = matching_objects.reject { |object| !object.key?('start_date') || !object.key?('end_date') }
+
+      # Skip objects whose start date is earlier than the specified date
+      matching_objects = matching_objects.reject { |object| date <= Date.parse(object['start_date']) }
+
+      # Skip objects whose end date is later than the specified date
+      matching_objects = matching_objects.reject { |object| date > Date.parse(object['end_date']) }
+    end
+
+    # If area was specified, narrow down the matching objects
+    unless area.nil?
+      # Skip objects that don't have fields for minimum_area and maximum_area
+      matching_objects = matching_objects.reject { |object| !object.key?('minimum_area') || !object.key?('maximum_area') }
+
+      # Skip objects that don't have values specified for minimum_area and maximum_area
+      matching_objects = matching_objects.reject { |object| object['minimum_area'].nil? || object['maximum_area'].nil? }
+
+      # Skip objects whose minimum area is below or maximum area is above area
+      matching_objects = matching_objects.reject { |object| area.to_f <= object['minimum_area'].to_f || area.to_f > object['maximum_area'].to_f }
+    end
+
+    # If area was specified, narrow down the matching objects
+    unless num_floors.nil?
+      # Skip objects that don't have fields for minimum_floors and maximum_floors
+      matching_objects = matching_objects.reject { |object| !object.key?('minimum_floors') || !object.key?('maximum_floors') }
+
+      # Skip objects that don't have values specified for minimum_floors and maximum_floors
+      matching_objects = matching_objects.reject { |object| object['minimum_floors'].nil? || object['maximum_floors'].nil? }
+
+      # Skip objects whose minimum floors is below or maximum floors is above num_floors
+      matching_objects = matching_objects.reject { |object| num_floors.to_f < object['minimum_floors'].to_f || num_floors.to_f > object['maximum_floors'].to_f }
+    end
+
     # Check the number of matching objects found
     if matching_objects.size.zero?
-      desired_object = nil
-      # OpenStudio::logFree(OpenStudio::Warn, 'openstudio.standards.Model', "Find objects search criteria returned no results. Search criteria: #{search_criteria}, capacity = #{capacity}.  Called from #{caller(0)[1]}.")
+      OpenStudio.logFree(OpenStudio::Debug, 'openstudio.standards.Model', "Find objects search criteria returned no results. Search criteria: #{search_criteria}. Called from #{caller(0)[1]}.")
     end
 
-    #    if new_matching_objects != matching_objects
-    #      puts "new..."
-    #      puts new_matching_objects
-    #      puts "is not.."
-    #      puts matching_objects
-    #      raise ("Hell")
-    #    end
     return matching_objects
   end
 
@@ -1688,8 +1678,13 @@ class Standard
   # @param hash_of_objects [Hash] hash of objects to search through
   # @param search_criteria [Hash] hash of search criteria
   # @param capacity [Double] capacity of the object in question.  If capacity is supplied,
-  #   the objects will only be returned if the specified capacity is between
-  #   the minimum_capacity and maximum_capacity values.
+  #   the objects will only be returned if the specified capacity is between the minimum_capacity and maximum_capacity values.
+  # @param date [<OpenStudio::Date>] date of the object in question.  If date is supplied,
+  #   the objects will only be returned if the specified date is between the start_date and end_date.
+  # @param area [Double] area of the object in question.  If area is supplied,
+  #   the objects will only be returned if the specified area is between the minimum_area and maximum_area values.
+  # @param num_floors [Double] capacity of the object in question.  If num_floors is supplied,
+  #   the objects will only be returned if the specified num_floors is between the minimum_floors and maximum_floors values.
   # @return [Hash] Return tbe first matching object hash if successful, nil if not.
   # @example Find the motor that meets these size criteria
   #   search_criteria = {
@@ -1697,96 +1692,15 @@ class Standard
   #   'number_of_poles' => 4.0,
   #   'type' => 'Enclosed',
   #   }
-  #   motor_properties = self.model.find_object(motors, search_criteria, 2.5)
-  def model_find_object(hash_of_objects, search_criteria, capacity = nil, date = nil)
-    #    new_matching_objects = model_find_objects(self, hash_of_objects, search_criteria, capacity)
-
-    if hash_of_objects.is_a?(Hash) and hash_of_objects.key?('table')
-      hash_of_objects = hash_of_objects['table']
-    end
-    desired_object = nil
-    search_criteria_matching_objects = []
-    matching_objects = []
-
-    # Compare each of the objects against the search criteria
-    hash_of_objects.each do |object|
-      meets_all_search_criteria = true
-      search_criteria.each do |key, value|
-        # Don't check non-existent search criteria
-        next unless object.key?(key)
-        # Stop as soon as one of the search criteria is not met
-        # 'Any' is a special key that matches anything
-        unless object[key] == value || object[key] == 'Any'
-          meets_all_search_criteria = false
-          break
-        end
-      end
-      # Skip objects that don't meet all search criteria
-      next unless meets_all_search_criteria
-      # If made it here, object matches all search criteria
-      search_criteria_matching_objects << object
-    end
-
-    # If capacity was specified, narrow down the matching objects
-    if capacity.nil?
-      matching_objects = search_criteria_matching_objects
-    else
-      # Round up if capacity is an integer
-      if capacity == capacity.round
-        capacity += (capacity * 0.01)
-      end
-      search_criteria_matching_objects.each do |object|
-        # Skip objects that don't have fields for minimum_capacity and maximum_capacity
-        next if !object.key?('minimum_capacity') || !object.key?('maximum_capacity')
-        # Skip objects that don't have values specified for minimum_capacity and maximum_capacity
-        next if object['minimum_capacity'].nil? || object['maximum_capacity'].nil?
-        # Skip objects whose the minimum capacity is below the specified capacity
-        next if capacity <= object['minimum_capacity'].to_f
-        # Skip objects whose max
-        next if capacity > object['maximum_capacity'].to_f
-        # Found a matching object
-        matching_objects << object
-      end
-      # If no object was found, round the capacity down a little
-      # to avoid issues where the number fell between the limits
-      # in the json file.
-      if matching_objects.size.zero?
-        capacity *= 0.99
-        search_criteria_matching_objects.each do |object|
-          # Skip objects that don't have fields for minimum_capacity and maximum_capacity
-          next if !object.key?('minimum_capacity') || !object.key?('maximum_capacity')
-          # Skip objects that don't have values specified for minimum_capacity and maximum_capacity
-          next if object['minimum_capacity'].nil? || object['maximum_capacity'].nil?
-          # Skip objects whose the minimum capacity is below the specified capacity
-          next if capacity <= object['minimum_capacity'].to_f
-          # Skip objects whose max
-          next if capacity > object['maximum_capacity'].to_f
-          # Found a matching object
-          matching_objects << object
-        end
-      end
-    end
+  #   motor_properties = self.model.find_object(motors, search_criteria, capacity: 2.5)
+  def model_find_object(hash_of_objects, search_criteria, capacity = nil, date = nil, area = nil, num_floors = nil)
 
-    # If date was specified, narrow down the matching objects
-    unless date.nil?
-      date_matching_objects = []
-      matching_objects.each do |object|
-        # Skip objects that don't have fields for minimum_capacity and maximum_capacity
-        next if !object.key?('start_date') || !object.key?('end_date')
-        # Skip objects whose the start date is earlier than the specified date
-        next if date <= Date.parse(object['start_date'])
-        # Skip objects whose end date is beyond the specified date
-        next if date > Date.parse(object['end_date'])
-        # Found a matching object
-        date_matching_objects << object
-      end
-      matching_objects = date_matching_objects
-    end
+    matching_objects = model_find_objects(hash_of_objects, search_criteria, capacity, date, area, num_floors)
 
     # Check the number of matching objects found
     if matching_objects.size.zero?
       desired_object = nil
-      # OpenStudio::logFree(OpenStudio::Warn, 'openstudio.standards.Model', "Find object search criteria returned no results. Search criteria: #{search_criteria}, capacity = #{capacity}.  Called from #{caller(0)[1]}")
+      OpenStudio.logFree(OpenStudio::Debug, 'openstudio.standards.Model', "Find object search criteria returned no results. Search criteria: #{search_criteria}. Called from #{caller(0)[1]}")
     elsif matching_objects.size == 1
       desired_object = matching_objects[0]
     else
@@ -2219,6 +2133,17 @@ class Standard
 
       end
 
+      # If the construction is fenestration,
+      # also set the frame type for use in future lookups
+      if construction.isFenestration
+        case standards_construction_type
+        when 'Metal framing (all other)'
+          standards_info.setFenestrationFrameType('Metal Framing')
+        when 'Nonmetal framing (all)'
+          standards_info.setFenestrationFrameType('Non-Metal Framing')
+        end
+      end
+
       # If the construction has a skylight framing material specified,
       # get the skylight frame material properties and add frame to
       # all skylights in the model.

data/lib/openstudio-standards/standards/Standards.Space.rb

@@ -96,7 +96,7 @@ class Standard
 
     # Make sure there is one floor surface
     if floor_surface.nil?
-      OpenStudio.logFree(OpenStudio::Warn, 'openstudio.model.Space', "Could not find a floor in space #{name.get}, cannot determine daylighted areas.")
+      OpenStudio.logFree(OpenStudio::Warn, 'openstudio.model.Space', "Could not find a floor in space #{space.name}, cannot determine daylighted areas.")
       return result
     end
 

data/lib/openstudio-standards/standards/ashrae_90_1/nrel_zne_ready_2017/nrel_zne_ready_2017.AirLoopHVAC.rb

@@ -38,7 +38,7 @@ class NRELZNEReady2017 < ASHRAE901
 
     # logic for multizone VAV Reheat systems
     if air_loop_hvac_multizone_vav_system?(air_loop_hvac) && air_loop_hvac_terminal_reheat?(air_loop_hvac)
-      OpenStudio.logFree(OpenStudio::Info, 'openstudio.standards.AirLoopHVAC', "Applying multizone VAV Reheat system controls.")
+      OpenStudio.logFree(OpenStudio::Info, 'openstudio.standards.AirLoopHVAC', 'Applying multizone VAV Reheat system controls.')
 
       # economizer controls
       air_loop_hvac_apply_economizer_limits(air_loop_hvac, climate_zone)
@@ -80,6 +80,27 @@ class NRELZNEReady2017 < ASHRAE901
       end
     end
 
+    # Unoccupied shutdown
+    if air_loop_hvac_unoccupied_fan_shutoff_required?(air_loop_hvac)
+      air_loop_hvac_enable_unoccupied_fan_shutoff(air_loop_hvac)
+    else
+      air_loop_hvac.setAvailabilitySchedule(air_loop_hvac.model.alwaysOnDiscreteSchedule)
+    end
+
+    # Motorized OA damper
+    if air_loop_hvac_motorized_oa_damper_required?(air_loop_hvac, climate_zone)
+      # Assume that the availability schedule has already been
+      # set to reflect occupancy and use this for the OA damper.
+      air_loop_hvac_add_motorized_oa_damper(air_loop_hvac, 0.15, air_loop_hvac.availabilitySchedule)
+    else
+      air_loop_hvac_remove_motorized_oa_damper(air_loop_hvac)
+    end
+
+    # Optimum Start
+    if air_loop_hvac_optimum_start_required?(air_loop_hvac)
+      air_loop_hvac_enable_optimum_start(air_loop_hvac)
+    end
+
   end
 
   # Determine whether or not this system is required to have an economizer.
@@ -419,4 +440,16 @@ class NRELZNEReady2017 < ASHRAE901
       return is_sat_reset_required
     end
   end
+
+  # Determine if a motorized OA damper is required
+  def air_loop_hvac_motorized_oa_damper_required?(air_loop_hvac, climate_zone)
+    motorized_oa_damper_required = true
+    return motorized_oa_damper_required
+  end
+
+  # Determines if optimum start control is required.
+  def air_loop_hvac_optimum_start_required?(air_loop_hvac)
+    opt_start_required = true
+    return opt_start_required
+  end
 end

data/lib/openstudio-standards/standards/standard.rb

@@ -106,6 +106,8 @@ class Standard
     standards_files << 'OpenStudio_Standards_refrigerated_cases.json'
     standards_files << 'OpenStudio_Standards_walkin_refrigeration.json'
     standards_files << 'OpenStudio_Standards_refrigeration_compressors.json'
+    standards_files << 'OpenStudio_Standards_hvac_inference.json'
+    standards_files << 'OpenStudio_Standards_size_category.json'
     #    standards_files << 'OpenStudio_Standards_unitary_hps.json'
     # Combine the data from the JSON files into a single hash
     top_dir = File.expand_path('../../..', File.dirname(__FILE__))

data/lib/openstudio-standards/version.rb

@@ -13,5 +13,5 @@ module OpenstudioStandards
     end
     return 'git-not-found-on-this-system'
   end
-  VERSION = '0.2.3'.freeze
+  VERSION = '0.2.4'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openstudio-standards
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Andrew Parker
@@ -21,7 +21,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-04 00:00:00.000000000 Z
+date: 2018-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
@@ -637,6 +637,7 @@ files:
 - data/standards/OpenStudio_Standards_heat_pumps.json
 - data/standards/OpenStudio_Standards_heat_pumps_heating.json
 - data/standards/OpenStudio_Standards_heat_rejection.json
+- data/standards/OpenStudio_Standards_hvac_inference.json
 - data/standards/OpenStudio_Standards_materials.json
 - data/standards/OpenStudio_Standards_motors.json
 - data/standards/OpenStudio_Standards_necb_climate_zones.json
@@ -648,6 +649,7 @@ files:
 - data/standards/OpenStudio_Standards_refrigerated_cases.json
 - data/standards/OpenStudio_Standards_refrigeration_compressors.json
 - data/standards/OpenStudio_Standards_schedules.json
+- data/standards/OpenStudio_Standards_size_category.json
 - data/standards/OpenStudio_Standards_space_types.json
 - data/standards/OpenStudio_Standards_standards.json
 - data/standards/OpenStudio_Standards_templates.json
@@ -1371,6 +1373,7 @@ files:
 - lib/openstudio-standards/prototypes/common/objects/Prototype.Model.rb
 - lib/openstudio-standards/prototypes/common/objects/Prototype.Model.swh.rb
 - lib/openstudio-standards/prototypes/common/objects/Prototype.ServiceWaterHeating.rb
+- lib/openstudio-standards/prototypes/common/objects/Prototype.SizingSystem.rb
 - lib/openstudio-standards/prototypes/common/objects/Prototype.hvac_systems.rb
 - lib/openstudio-standards/prototypes/common/objects/Prototype.refrigeration.rb
 - lib/openstudio-standards/prototypes/common/objects/Prototype.utilities.rb