openstudio-extension 0.1.0 → 0.1.1

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

@@ -0,0 +1,139 @@
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) 2008-2019, Alliance for Sustainable Energy, LLC.
+# All rights reserved.
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# (1) Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# (2) Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# (3) Neither the name of the copyright holder nor the names of any contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission from the respective party.
+#
+# (4) Other than as required in clauses (1) and (2), distributions in any form
+# of modifications or other derivative works may not use the "OpenStudio"
+# trademark, "OS", "os", or any other confusingly similar designation without
+# specific prior written permission from Alliance for Sustainable Energy, LLC.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE
+# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
+# THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+# OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# *******************************************************************************
+
+module OsLib_QAQC
+  # include any general notes about QAQC method here
+
+  # checks the number of unmet hours in the model
+  def check_mech_sys_type(category, target_standard, name_only = false)
+    # summary of the check
+    check_elems = OpenStudio::AttributeVector.new
+    check_elems << OpenStudio::Attribute.new('name', 'Mechanical System Type')
+    check_elems << OpenStudio::Attribute.new('category', category)
+
+    # add ASHRAE to display of target standard if includes with 90.1
+    if target_standard.include?('90.1 2013')
+      check_elems << OpenStudio::Attribute.new('description', 'Check against ASHRAE 90.1 2013 Tables G3.1.1 A-B. Infers the baseline system type based on the equipment serving the zone and their heating/cooling fuels. Only does a high-level inference; does not look for the presence/absence of required controls, etc.')
+    else
+      check_elems << OpenStudio::Attribute.new('description', 'Check against ASHRAE 90.1. Infers the baseline system type based on the equipment serving the zone and their heating/cooling fuels. Only does a high-level inference; does not look for the presence/absence of required controls, etc.')
+    end
+
+    # stop here if only name is requested this is used to populate display name for arguments
+    if name_only == true
+      results = []
+      check_elems.each do |elem|
+        results << elem.valueAsString
+      end
+      return results
+    end
+
+    # Versions of OpenStudio greater than 2.4.0 use a modified version of
+    # openstudio-standards with different method calls.  These methods
+    # require a "Standard" object instead of the standard being passed into method calls.
+    # This Standard object is used throughout the QAQC check.
+    if OpenStudio::VersionString.new(OpenStudio.openStudioVersion) < OpenStudio::VersionString.new('2.4.3')
+      use_old_gem_code = true
+    else
+      use_old_gem_code = false
+      std = Standard.build(target_standard)
+    end
+
+    begin
+      # Get the actual system type for all zones in the model
+      act_zone_to_sys_type = {}
+      @model.getThermalZones.each do |zone|
+        if use_old_gem_code
+          act_zone_to_sys_type[zone] = zone.infer_system_type
+        else
+          act_zone_to_sys_type[zone] = std.thermal_zone_infer_system_type(zone)
+        end
+      end
+
+      # Get the baseline system type for all zones in the model
+      if use_old_gem_code
+        climate_zone = @model.get_building_climate_zone_and_building_type['climate_zone']
+      else
+        climate_zone = std.model_get_building_climate_zone_and_building_type(@model)['climate_zone']
+      end
+
+      if use_old_gem_code
+        req_zone_to_sys_type = @model.get_baseline_system_type_by_zone(target_standard, climate_zone)
+      else
+        req_zone_to_sys_type = std.model_get_baseline_system_type_by_zone(@model, climate_zone)
+      end
+
+      # Compare the actual to the correct
+      @model.getThermalZones.each do |zone|
+        # TODO: - skip if plenum
+        is_plenum = false
+        zone.spaces.each do |space|
+          if use_old_gem_code
+            if space.plenum?
+              is_plenum = true
+            end
+          else
+            if std.space_plenum?(space)
+              is_plenum = true
+            end
+          end
+        end
+        next if is_plenum
+
+        req_sys_type = req_zone_to_sys_type[zone]
+        act_sys_type = act_zone_to_sys_type[zone]
+
+        if act_sys_type == req_sys_type
+          puts "#{zone.name} system type = #{act_sys_type}"
+        else
+          if req_sys_type == '' then req_sys_type = 'Unknown' end
+          puts "#{zone.name} baseline system type is incorrect. Supposed to be #{req_sys_type}, but was #{act_sys_type} instead."
+          check_elems << OpenStudio::Attribute.new('flag', "#{zone.name} baseline system type is incorrect. Supposed to be #{req_sys_type}, but was #{act_sys_type} instead.")
+        end
+      end
+    rescue StandardError => e
+      # brief description of ruby error
+      check_elems << OpenStudio::Attribute.new('flag', "Error prevented QAQC check from running (#{e}).")
+
+      # backtrace of ruby error for diagnostic use
+      if @error_backtrace then check_elems << OpenStudio::Attribute.new('flag', e.backtrace.join("\n").to_s) end
+    end
+
+    # add check_elms to new attribute
+    check_elem = OpenStudio::Attribute.new('check', check_elems)
+
+    return check_elem
+    # note: registerWarning and registerValue will be added for checks downstream using os_lib_reporting_qaqc.rb
+  end
+end

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

@@ -0,0 +1,451 @@
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) 2008-2019, Alliance for Sustainable Energy, LLC.
+# All rights reserved.
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# (1) Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# (2) Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# (3) Neither the name of the copyright holder nor the names of any contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission from the respective party.
+#
+# (4) Other than as required in clauses (1) and (2), distributions in any form
+# of modifications or other derivative works may not use the "OpenStudio"
+# trademark, "OS", "os", or any other confusingly similar designation without
+# specific prior written permission from Alliance for Sustainable Energy, LLC.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE
+# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
+# THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+# OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# *******************************************************************************
+
+module OsLib_QAQC
+  # Bin the hourly part load ratios into 10% bins
+  def bin_part_loads_by_ten_pcts(hrly_plrs)
+    bins = Array.new(10, 0)
+    op_hrs = 0.0
+    hrly_plrs.each do |plr|
+      op_hrs += 1.0 if plr > 0
+      if plr <= 0.1 # add below-zero % PLRs to final bin
+        bins[0] += 1
+      elsif plr > 0.1 && plr <= 0.2
+        bins[1] += 1
+      elsif plr > 0.2 && plr <= 0.3
+        bins[2] += 1
+      elsif plr > 0.3 && plr <= 0.4
+        bins[3] += 1
+      elsif plr > 0.4 && plr <= 0.5
+        bins[4] += 1
+      elsif plr > 0.5 && plr <= 0.6
+        bins[5] += 1
+      elsif plr > 0.6 && plr <= 0.7
+        bins[6] += 1
+      elsif plr > 0.7 && plr <= 0.8
+        bins[7] += 1
+      elsif plr > 0.8 && plr <= 0.9
+        bins[8] += 1
+      elsif plr > 0.9 # add over-100% PLRs to final bin
+        bins[9] += 1
+      end
+    end
+
+    # Convert bins from hour counts to % of operating hours.
+    bins.each_with_index do |bin, i|
+      bins[i] = bins[i] / op_hrs
+    end
+
+    return bins
+  end
+
+  # Check primary heating and cooling equipment part load ratios
+  # to find equipment that is significantly oversized or undersized.
+  def check_part_loads(category, target_standard, max_pct_delta = 0.1, name_only = false)
+    # summary of the check
+    check_elems = OpenStudio::AttributeVector.new
+    check_elems << OpenStudio::Attribute.new('name', 'Part Load')
+    check_elems << OpenStudio::Attribute.new('category', category)
+    check_elems << OpenStudio::Attribute.new('description', 'Check that equipment operates at reasonable part load ranges.')
+
+    # stop here if only name is requested this is used to populate display name for arguments
+    if name_only == true
+      results = []
+      check_elems.each do |elem|
+        results << elem.valueAsString
+      end
+      return results
+    end
+
+    std = Standard.build(target_standard)
+
+    begin
+      # Establish limits for % of operating hrs expected above 90% part load
+      expected_pct_hrs_above_90 = 0.1
+
+      # get the weather file run period (as opposed to design day run period)
+      ann_env_pd = nil
+      @sql.availableEnvPeriods.each do |env_pd|
+        env_type = @sql.environmentType(env_pd)
+        if env_type.is_initialized
+          if env_type.get == OpenStudio::EnvironmentType.new('WeatherRunPeriod')
+            ann_env_pd = env_pd
+            break
+          end
+        end
+      end
+
+      # only try to get the annual timeseries if an annual simulation was run
+      if ann_env_pd.nil?
+        check_elems << OpenStudio::Attribute.new('flag', 'Cannot find the annual simulation run period, cannot check equipment part load ratios.')
+        return check_elem
+      end
+
+      # Boilers
+      @model.getBoilerHotWaters.each do |equip|
+        # Get the timeseries part load ratio data
+        key_value =  equip.name.get.to_s.upcase # must be in all caps.
+        time_step = 'Hourly'
+        variable_name = 'Boiler Part Load Ratio'
+        ts = @sql.timeSeries(ann_env_pd, time_step, variable_name, key_value)
+        if ts.empty?
+          check_elems << OpenStudio::Attribute.new('flag', "#{variable_name} Timeseries not found for #{key_value}.")
+          next
+        end
+
+        # Convert to array
+        ts = ts.get.values
+        plrs = []
+        for i in 0..(ts.size - 1)
+          plrs << ts[i]
+        end
+
+        # Bin part load ratios
+        pct_hrs_above_90 = bin_part_loads_by_ten_pcts(plrs)[9]
+
+        # Check top-end part load ratio bins
+        if ((pct_hrs_above_90 - expected_pct_hrs_above_90) / pct_hrs_above_90).abs > max_pct_delta
+          check_elems << OpenStudio::Attribute.new('flag', "For #{equip.name}, the actual hrs above 90% part load of #{(pct_hrs_above_90 * 100).round(2)}% is more than #{(max_pct_delta * 100.0).round(2)}% different from the expected #{(expected_pct_hrs_above_90 * 100).round(2)}% of hrs above 90% part load.  This could indicate significantly oversized or undersized equipment.")
+        end
+      end
+
+      # Chillers
+      @model.getChillerElectricEIRs.each do |equip|
+        # Get the timeseries part load ratio data
+        key_value =  equip.name.get.to_s.upcase # must be in all caps.
+        time_step = 'Hourly'
+        variable_name = 'Chiller Part Load Ratio'
+        ts = @sql.timeSeries(ann_env_pd, time_step, variable_name, key_value)
+        if ts.empty?
+          check_elems << OpenStudio::Attribute.new('flag', "#{variable_name} Timeseries not found for #{key_value}.")
+          next
+        end
+
+        # Convert to array
+        ts = ts.get.values
+        plrs = []
+        for i in 0..(ts.size - 1)
+          plrs << ts[i]
+        end
+
+        # Bin part load ratios
+        pct_hrs_above_90 = bin_part_loads_by_ten_pcts(plrs)[9]
+
+        # Check top-end part load ratio bins
+        if ((pct_hrs_above_90 - expected_pct_hrs_above_90) / pct_hrs_above_90).abs > max_pct_delta
+          check_elems << OpenStudio::Attribute.new('flag', "For #{equip.name}, the actual hrs above 90% part load of #{(pct_hrs_above_90 * 100).round(2)}% is more than #{(max_pct_delta * 100.0).round(2)}% different from the expected #{(expected_pct_hrs_above_90 * 100).round(2)}% of hrs above 90% part load.  This could indicate significantly oversized or undersized equipment.")
+        end
+      end
+
+      # Cooling Towers (Single Speed)
+      @model.getCoolingTowerSingleSpeeds.each do |equip|
+        # Get the design fan power
+        if equip.fanPoweratDesignAirFlowRate.is_initialized
+          dsn_pwr = equip.fanPoweratDesignAirFlowRate.get
+        elsif equip.autosizedFanPoweratDesignAirFlowRate.is_initialized
+          dsn_pwr = equip.autosizedFanPoweratDesignAirFlowRate.get
+        else
+          check_elems << OpenStudio::Attribute.new('flag', "Could not determine peak power for #{equip.name}, cannot check part load ratios.")
+          next
+        end
+
+        # Get the timeseries fan power
+        key_value = equip.name.get.to_s.upcase # must be in all caps.
+        time_step = 'Hourly'
+        variable_name = 'Cooling Tower Fan Electric Power'
+        ts = @sql.timeSeries(ann_env_pd, time_step, variable_name, key_value)
+        if ts.empty?
+          check_elems << OpenStudio::Attribute.new('flag', "#{variable_name} Timeseries not found for #{key_value}.")
+          next
+        end
+
+        # Convert to array
+        ts = ts.get.values
+        plrs = []
+        for i in 0..(ts.size - 1)
+          plrs << ts[i] / dsn_pwr.to_f
+        end
+
+        # Bin part load ratios
+        pct_hrs_above_90 = bin_part_loads_by_ten_pcts(plrs)[9]
+
+        # Check top-end part load ratio bins
+        if ((pct_hrs_above_90 - expected_pct_hrs_above_90) / pct_hrs_above_90).abs > max_pct_delta
+          check_elems << OpenStudio::Attribute.new('flag', "For #{equip.name}, the actual hrs above 90% part load of #{(pct_hrs_above_90 * 100).round(2)}% is more than #{(max_pct_delta * 100.0).round(2)}% different from the expected #{(expected_pct_hrs_above_90 * 100).round(2)}% of hrs above 90% part load.  This could indicate significantly oversized or undersized equipment.")
+        end
+      end
+
+      # Cooling Towers (Two Speed)
+      @model.getCoolingTowerTwoSpeeds.each do |equip|
+        # Get the design fan power
+        if equip.highFanSpeedFanPower.is_initialized
+          dsn_pwr = equip.highFanSpeedFanPower.get
+        elsif equip.autosizedHighFanSpeedFanPower.is_initialized
+          dsn_pwr = equip.autosizedHighFanSpeedFanPower.get
+        else
+          check_elems << OpenStudio::Attribute.new('flag', "Could not determine peak power for #{equip.name}, cannot check part load ratios.")
+          next
+        end
+
+        # Get the timeseries fan power
+        key_value = equip.name.get.to_s.upcase # must be in all caps.
+        time_step = 'Hourly'
+        variable_name = 'Cooling Tower Fan Electric Power'
+        ts = @sql.timeSeries(ann_env_pd, time_step, variable_name, key_value)
+        if ts.empty?
+          check_elems << OpenStudio::Attribute.new('flag', "#{variable_name} Timeseries not found for #{key_value}.")
+          next
+        end
+
+        # Convert to array
+        ts = ts.get.values
+        plrs = []
+        for i in 0..(ts.size - 1)
+          plrs << ts[i] / dsn_pwr.to_f
+        end
+
+        # Bin part load ratios
+        pct_hrs_above_90 = bin_part_loads_by_ten_pcts(plrs)[9]
+
+        # Check top-end part load ratio bins
+        if ((pct_hrs_above_90 - expected_pct_hrs_above_90) / pct_hrs_above_90).abs > max_pct_delta
+          check_elems << OpenStudio::Attribute.new('flag', "For #{equip.name}, the actual hrs above 90% part load of #{(pct_hrs_above_90 * 100).round(2)}% is more than #{(max_pct_delta * 100.0).round(2)}% different from the expected #{(expected_pct_hrs_above_90 * 100).round(2)}% of hrs above 90% part load.  This could indicate significantly oversized or undersized equipment.")
+        end
+      end
+
+      # Cooling Towers (Variable Speed)
+      @model.getCoolingTowerVariableSpeeds.each do |equip|
+        # Get the design fan power
+        if equip.designFanPower.is_initialized
+          dsn_pwr = equip.designFanPower.get
+        elsif equip.autosizedDesignFanPower.is_initialized
+          dsn_pwr = equip.autosizedDesignFanPower.get
+        else
+          check_elems << OpenStudio::Attribute.new('flag', "Could not determine peak power for #{equip.name}, cannot check part load ratios.")
+          next
+        end
+
+        # Get the timeseries fan power
+        key_value = equip.name.get.to_s.upcase # must be in all caps.
+        time_step = 'Hourly'
+        variable_name = 'Cooling Tower Fan Electric Power'
+        ts = @sql.timeSeries(ann_env_pd, time_step, variable_name, key_value)
+        if ts.empty?
+          check_elems << OpenStudio::Attribute.new('flag', "#{variable_name} Timeseries not found for #{key_value}.")
+          next
+        end
+
+        # Convert to array
+        ts = ts.get.values
+        plrs = []
+        for i in 0..(ts.size - 1)
+          plrs << ts[i] / dsn_pwr.to_f
+        end
+
+        # Bin part load ratios
+        pct_hrs_above_90 = bin_part_loads_by_ten_pcts(plrs)[9]
+
+        # Check top-end part load ratio bins
+        if ((pct_hrs_above_90 - expected_pct_hrs_above_90) / pct_hrs_above_90).abs > max_pct_delta
+          check_elems << OpenStudio::Attribute.new('flag', "For #{equip.name}, the actual hrs above 90% part load of #{(pct_hrs_above_90 * 100).round(2)}% is more than #{(max_pct_delta * 100.0).round(2)}% different from the expected #{(expected_pct_hrs_above_90 * 100).round(2)}% of hrs above 90% part load.  This could indicate significantly oversized or undersized equipment.")
+        end
+      end
+
+      # DX Cooling Coils (Single Speed)
+      @model.getCoilCoolingDXSingleSpeeds.each do |equip|
+        # Get the design coil capacity
+        if equip.ratedTotalCoolingCapacity.is_initialized
+          dsn_pwr = equip.ratedTotalCoolingCapacity.get
+        elsif equip.autosizedRatedTotalCoolingCapacity.is_initialized
+          dsn_pwr = equip.autosizedRatedTotalCoolingCapacity.get
+        else
+          check_elems << OpenStudio::Attribute.new('flag', "Could not determine capacity for #{equip.name}, cannot check part load ratios.")
+          next
+        end
+
+        # Get the timeseries coil capacity
+        key_value = equip.name.get.to_s.upcase # must be in all caps.
+        time_step = 'Hourly'
+        variable_name = 'Cooling Coil Total Cooling Rate'
+        ts = @sql.timeSeries(ann_env_pd, time_step, variable_name, key_value)
+        if ts.empty?
+          check_elems << OpenStudio::Attribute.new('flag', "#{variable_name} Timeseries not found for #{key_value}.")
+          next
+        end
+
+        # Convert to array
+        ts = ts.get.values
+        plrs = []
+        for i in 0..(ts.size - 1)
+          plrs << ts[i] / dsn_pwr.to_f
+        end
+
+        # Bin part load ratios
+        pct_hrs_above_90 = bin_part_loads_by_ten_pcts(plrs)[9]
+
+        # Check top-end part load ratio bins
+        if ((pct_hrs_above_90 - expected_pct_hrs_above_90) / pct_hrs_above_90).abs > max_pct_delta
+          check_elems << OpenStudio::Attribute.new('flag', "For #{equip.name}, the actual hrs above 90% part load of #{(pct_hrs_above_90 * 100).round(2)}% is more than #{(max_pct_delta * 100.0).round(2)}% different from the expected #{(expected_pct_hrs_above_90 * 100).round(2)}% of hrs above 90% part load.  This could indicate significantly oversized or undersized equipment.")
+        end
+      end
+
+      # DX Cooling Coils (Two Speed)
+      @model.getCoilCoolingDXTwoSpeeds.each do |equip|
+        # Get the design coil capacity
+        if equip.ratedHighSpeedTotalCoolingCapacity.is_initialized
+          dsn_pwr = equip.ratedHighSpeedTotalCoolingCapacity.get
+        elsif equip.autosizedRatedHighSpeedTotalCoolingCapacity.is_initialized
+          dsn_pwr = equip.autosizedRatedHighSpeedTotalCoolingCapacity.get
+        else
+          check_elems << OpenStudio::Attribute.new('flag', "Could not determine capacity for #{equip.name}, cannot check part load ratios.")
+          next
+        end
+
+        # Get the timeseries coil capacity
+        key_value = equip.name.get.to_s.upcase # must be in all caps.
+        time_step = 'Hourly'
+        variable_name = 'Cooling Coil Total Cooling Rate'
+        ts = @sql.timeSeries(ann_env_pd, time_step, variable_name, key_value)
+        if ts.empty?
+          check_elems << OpenStudio::Attribute.new('flag', "#{variable_name} Timeseries not found for #{key_value}.")
+          next
+        end
+
+        # Convert to array
+        ts = ts.get.values
+        plrs = []
+        for i in 0..(ts.size - 1)
+          plrs << ts[i] / dsn_pwr.to_f
+        end
+
+        # Bin part load ratios
+        pct_hrs_above_90 = bin_part_loads_by_ten_pcts(plrs)[9]
+
+        # Check top-end part load ratio bins
+        if ((pct_hrs_above_90 - expected_pct_hrs_above_90) / pct_hrs_above_90).abs > max_pct_delta
+          check_elems << OpenStudio::Attribute.new('flag', "For #{equip.name}, the actual hrs above 90% part load of #{(pct_hrs_above_90 * 100).round(2)}% is more than #{(max_pct_delta * 100.0).round(2)}% different from the expected #{(expected_pct_hrs_above_90 * 100).round(2)}% of hrs above 90% part load.  This could indicate significantly oversized or undersized equipment.")
+        end
+      end
+
+      # DX Cooling Coils (Variable Speed)
+      @model.getCoilCoolingDXVariableSpeeds.each do |equip|
+        # Get the design coil capacity
+        if equip.grossRatedTotalCoolingCapacityAtSelectedNominalSpeedLevel.is_initialized
+          dsn_pwr = equip.grossRatedTotalCoolingCapacityAtSelectedNominalSpeedLevel.get
+        elsif equip.autosizedGrossRatedTotalCoolingCapacityAtSelectedNominalSpeedLevel.is_initialized
+          dsn_pwr = equip.autosizedGrossRatedTotalCoolingCapacityAtSelectedNominalSpeedLevel.get
+        else
+          check_elems << OpenStudio::Attribute.new('flag', "Could not determine capacity for #{equip.name}, cannot check part load ratios.")
+          next
+        end
+
+        # Get the timeseries coil capacity
+        key_value = equip.name.get.to_s.upcase # must be in all caps.
+        time_step = 'Hourly'
+        variable_name = 'Cooling Coil Total Cooling Rate'
+        ts = @sql.timeSeries(ann_env_pd, time_step, variable_name, key_value)
+        if ts.empty?
+          check_elems << OpenStudio::Attribute.new('flag', "#{variable_name} Timeseries not found for #{key_value}.")
+          next
+        end
+
+        # Convert to array
+        ts = ts.get.values
+        plrs = []
+        for i in 0..(ts.size - 1)
+          plrs << ts[i] / dsn_pwr.to_f
+        end
+
+        # Bin part load ratios
+        pct_hrs_above_90 = bin_part_loads_by_ten_pcts(plrs)[9]
+
+        # Check top-end part load ratio bins
+        if ((pct_hrs_above_90 - expected_pct_hrs_above_90) / pct_hrs_above_90).abs > max_pct_delta
+          check_elems << OpenStudio::Attribute.new('flag', "For #{equip.name}, the actual hrs above 90% part load of #{(pct_hrs_above_90 * 100).round(2)}% is more than #{(max_pct_delta * 100.0).round(2)}% different from the expected #{(expected_pct_hrs_above_90 * 100).round(2)}% of hrs above 90% part load.  This could indicate significantly oversized or undersized equipment.")
+        end
+      end
+
+      # Gas Heating Coils
+      @model.getCoilHeatingGass.each do |equip|
+        # Get the design coil capacity
+        if equip.nominalCapacity.is_initialized
+          dsn_pwr = equip.nominalCapacity.get
+        elsif equip.autosizedNominalCapacity.is_initialized
+          dsn_pwr = equip.autosizedNominalCapacity.get
+        else
+          check_elems << OpenStudio::Attribute.new('flag', "Could not determine capacity for #{equip.name}, cannot check part load ratios.")
+          next
+        end
+
+        # Get the timeseries coil capacity
+        key_value = equip.name.get.to_s.upcase # must be in all caps.
+        time_step = 'Hourly'
+        variable_name = 'Heating Coil Air Heating Rate'
+        ts = @sql.timeSeries(ann_env_pd, time_step, variable_name, key_value)
+        if ts.empty?
+          check_elems << OpenStudio::Attribute.new('flag', "#{variable_name} Timeseries not found for #{key_value}.")
+          next
+        end
+
+        # Convert to array
+        ts = ts.get.values
+        plrs = []
+        for i in 0..(ts.size - 1)
+          plrs << ts[i] / dsn_pwr.to_f
+        end
+
+        # Bin part load ratios
+        pct_hrs_above_90 = bin_part_loads_by_ten_pcts(plrs)[9]
+
+        # Check top-end part load ratio bins
+        if ((pct_hrs_above_90 - expected_pct_hrs_above_90) / pct_hrs_above_90).abs > max_pct_delta
+          check_elems << OpenStudio::Attribute.new('flag', "For #{equip.name}, the actual hrs above 90% part load of #{(pct_hrs_above_90 * 100).round(2)}% is more than #{(max_pct_delta * 100.0).round(2)}% different from the expected #{(expected_pct_hrs_above_90 * 100).round(2)}% of hrs above 90% part load.  This could indicate significantly oversized or undersized equipment.")
+        end
+      end
+    rescue StandardError => e
+      # brief description of ruby error
+      check_elems << OpenStudio::Attribute.new('flag', "Error prevented QAQC check from running (#{e}).")
+
+      # backtrace of ruby error for diagnostic use
+      if @error_backtrace then check_elems << OpenStudio::Attribute.new('flag', e.backtrace.join("\n").to_s) end
+    end
+
+    # add check_elms to new attribute
+    check_elem = OpenStudio::Attribute.new('check', check_elems)
+
+    return check_elem
+    # note: registerWarning and registerValue will be added for checks downstream using os_lib_reporting_qaqc.rb
+  end
+end