openstudio-standards 0.4.0 → 0.5.0.rc1

data/lib/openstudio-standards/standards/ashrae_90_1_prm/ashrae_90_1_prm.Surface.rb

@@ -2,20 +2,20 @@ class ASHRAE901PRM < Standard
   # Adjust the fenestration area to the values specified by the reduction value in a surface
   #
   # @param surface [OpenStudio::Model:Surface] openstudio surface object
-  # @param reduction [Float] ratio of adjustments
+  # @param reduction [Double] ratio of adjustments
   # @param model [OpenStudio::Model::Model] openstudio model
-  # @return [Bool] return true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def surface_adjust_fenestration_in_a_surface(surface, reduction, model)
     # do nothing for cases when reduction == 1.0
     if reduction < 1.0
-      surface.subSurfaces.sort.each do |ss|
+      surface.subSurfaces.each do |ss|
         next unless ss.subSurfaceType == 'FixedWindow' || ss.subSurfaceType == 'OperableWindow' || ss.subSurfaceType == 'GlassDoor'
 
         sub_surface_reduce_area_by_percent_by_shrinking_toward_centroid(ss, reduction)
       end
     elsif reduction > 1.0
       # case increase the window
-      surface_wwr = surface_get_wwr_of_a_surface(surface)
+      surface_wwr = surface_get_wwr(surface)
       if surface_wwr == 0.0
         # In this case, we are adding fenestration
         wwr_adjusted = reduction - 1.0
@@ -26,7 +26,7 @@ class ASHRAE901PRM < Standard
       end
       # Save doors to a temp list
       door_list = []
-      surface.subSurfaces.sort.each do |sub|
+      surface.subSurfaces.each do |sub|
         if sub.subSurfaceType == 'Door'
           door = {}
           door['name'] = sub.name.get
@@ -37,7 +37,7 @@ class ASHRAE901PRM < Standard
       end
       # remove all existing windows and set the window to wall ratio to the calculated new WWR
       # Remove all sub-surfaces including doors
-      surface.subSurfaces.sort.each(&:remove)
+      surface.subSurfaces.each(&:remove)
       # Apply default construction to the subsurface - the standard construction will be applied later.
       surface.setWindowToWallRatio(wwr_adjusted, 0.6, true)
       # add door back.

data/lib/openstudio-standards/standards/ashrae_90_1_prm/ashrae_90_1_prm.ThermalZone.rb

@@ -7,8 +7,14 @@ class ASHRAE901PRM < Standard
   # @param thermal_zone
   def thermal_zone_get_fan_power_limitations(thermal_zone, is_energy_recovery_required)
     fan_pwr_adjustment_in_wc = 0
+
+    # error if zone design air flow rate is not available
+    if thermal_zone.model.version < OpenStudio::VersionString.new('3.6.0')
+      OpenStudio.logFree(OpenStudio::Error, 'openstudio.ashrae_90_1_prm.ThermalZone', 'Required ThermalZone method .autosizedDesignAirFlowRate is not available in pre-OpenStudio 3.6.0 versions. Use a more recent version of OpenStudio.')
+    end
+
     # Get autosized zone design supply air flow rate
-    dsn_zone_air_flow_m3_per_s = thermal_zone.designAirFlowRate.to_f
+    dsn_zone_air_flow_m3_per_s = thermal_zone.autosizedDesignAirFlowRate.to_f
     dsn_zone_air_flow_cfm = OpenStudio.convert(dsn_zone_air_flow_m3_per_s, 'm^3/s', 'cfm').get
 
     # Retrieve credits from zone additional features
@@ -151,15 +157,21 @@ class ASHRAE901PRM < Standard
   end
 
   # Identify if zone has district energy for occ_and_fuel_type method
-  # @param themal_zone
-  # @return [string] with applicable DistrictHeating and/or DistrictCooling
-  def thermal_zone_get_zone_fuels_for_occ_and_fuel_type(zone)
+  # @param thermal_zone
+  # @return [String with applicable DistrictHeating and/or DistrictCooling
+  def thermal_zone_get_zone_fuels_for_occ_and_fuel_type(thermal_zone)
     zone_fuels = ''
-    htg_fuels = zone.heating_fuels
+
+    # error if HVACComponent heating fuels method is not available
+    if thermal_zone.model.version < OpenStudio::VersionString.new('3.6.0')
+      OpenStudio.logFree(OpenStudio::Error, 'openstudio.ashrae_90_1_prm.ThermalZone', 'Required HVACComponent methods .heatingFuelTypes and .coolingFuelTypes are not available in pre-OpenStudio 3.6.0 versions. Use a more recent version of OpenStudio.')
+    end
+
+    htg_fuels = thermal_zone.heatingFuelTypes.map(&:valueName)
     if htg_fuels.include?('DistrictHeating')
       zone_fuels = 'DistrictHeating'
     end
-    clg_fuels = zone.cooling_fuels
+    clg_fuels = thermal_zone.coolingFuelTypes.map(&:valueName)
     if clg_fuels.include?('DistrictCooling')
       zone_fuels += 'DistrictCooling'
     end

data/lib/openstudio-standards/standards/ashrae_90_1_prm/ashrae_90_1_prm.ZoneHVACComponent.rb

@@ -5,7 +5,7 @@ class ASHRAE901PRM < Standard
   # (Fan coils, Unit Heaters, PTACs, PTHPs, VRF Terminals, WSHPs, ERVs)
   # based on the W/cfm specified in the standard.
   #
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def zone_hvac_component_apply_prm_baseline_fan_power(zone_hvac_component)
     OpenStudio.logFree(OpenStudio::Debug, 'openstudio.ashrae_90_1_prm.ZoneHVACComponent', "Setting fan power for #{zone_hvac_component.name}.")
 

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

@@ -7,18 +7,47 @@ require 'csv'
 class ASHRAE901PRM < Standard
   def initialize
     load_standards_database
+    @sizing_run_dir = Dir.pwd
   end
 
   def load_standards_database(data_directories = [])
     super([__dir__] + data_directories)
   end
 
+  # Method to generate user data from a user model and save the csvs to the user_data_path
+  # This method can generate one user data csv based on the matching name or a full set of user data if
+  # leave it as nil
+  # @param user_model [OpenStudio::Model::Model] OpenStudio model object
+  # @param user_data_path [String] data path
+  # @param user_data_file [String] the name of the user data file.
+  def generate_userdata_to_csv(user_model, user_data_path, user_data_file = nil)
+    user_data_list = [UserDataCSVAirLoopHVAC.new(user_model, user_data_path),
+                      UserDataCSVBuilding.new(user_model, user_data_path),
+                      UserDataCSVSpace.new(user_model, user_data_path),
+                      UserDataCSVSpaceTypes.new(user_model, user_data_path),
+                      UserDataCSVAirLoopHVACDOAS.new(user_model, user_data_path),
+                      UserDataCSVExteriorLights.new(user_model, user_data_path),
+                      UserDataCSVThermalZone.new(user_model, user_data_path),
+                      UserDataCSVElectricEquipment.new(user_model, user_data_path),
+                      UserDataCSVOutdoorAir.new(user_model, user_data_path)]
+
+    if user_data_file.nil?
+      user_data_list.each(&:write_csv)
+    else
+      user_data_list.each do |user_data|
+        if user_data.file_name == user_data_file
+          user_data.write_csv
+        end
+      end
+    end
+  end
+
   # Convert user data csv files to json format and save to project folder
   # Method will create the json_folder in the project_path
   # @author Doug Maddox, PNNL
-  # @param user_data_folder [string] path to folder containing csv files
-  # @param project_folder [string] path to project folder
-  # @return [string] path to json files
+  # @param user_data_path [String path to folder containing csv files
+  # @param project_path [String path to project folder
+  # @return [String] path to json files
   def convert_userdata_csv_to_json(user_data_path, project_path)
     # Get list of possible files from lib\openstudio-standards\standards\ashrae_90_1_prm\userdata_csv
     stds_dir = __dir__
@@ -28,9 +57,12 @@ class ASHRAE901PRM < Standard
     Dir.glob(src_csv_dir).each do |csv_full_name|
       json_rows = []
       csv_file_name = File.basename(csv_full_name, File.extname(csv_full_name))
+      unless UserDataFiles.matched_any?(csv_file_name)
+        OpenStudio.logFree(OpenStudio::Error, 'prm.log', "user data file: #{csv_file_name} is not a valid file name. See the full list of acceptable file names in https://pnnl.github.io/BEM-for-PRM/user_guide/add_compliance_data/")
+      end
       json_objs[csv_file_name] = json_rows
     end
-    
+
     # Read all valid files in user_data_folder and load into json array
     unless user_data_path == ''
       user_data_validation_outcome = true
@@ -81,7 +113,7 @@ class ASHRAE901PRM < Standard
   # Load user data from project folder into standards database data structure
   # Each user data object type is a new item in the @standards_data hash
   # @author Doug Maddox, PNNL
-  # @param json_path [string] path to folder containing json files
+  # @param json_path [String path to folder containing json files
   def load_userdata_to_standards_database(json_path)
     files = Dir.glob("#{json_path}/*.json").select { |e| File.file? e }
     files.each do |file|
@@ -107,7 +139,7 @@ class ASHRAE901PRM < Standard
     row.each do |sub_array|
       new_array << sub_array.collect { |e| e ? e.strip : e }
     end
-    # TODO: Future expansion can added to here.
+    # @todo Future expansion can added to here.
     # Convert the 2d array to hash
     return new_array.to_h
   end
@@ -121,91 +153,308 @@ class ASHRAE901PRM < Standard
   def user_data_validation(object_name, user_data)
     # 1. Check user_spacetype and user_space LPD total % = 1.0
     case object_name
-    when 'userdata_space', 'userdata_spacetype'
+    when UserDataFiles::BUILDING
+      return check_userdata_building(object_name, user_data)
+    when UserDataFiles::SPACE, UserDataFiles::SPACETYPE
       return check_userdata_space_and_spacetype(object_name, user_data)
-    when 'user_electric_equipment'
+    when UserDataFiles::ELECTRIC_EQUIPMENT
       return check_userdata_electric_equipment(object_name, user_data)
+    when UserDataFiles::EXTERIOR_LIGHTS
+      return check_userdata_exterior_lighting(object_name, user_data)
+    when UserDataFiles::AIRLOOP_HVAC
+      return check_userdata_airloop_hvac(object_name, user_data)
+    when UserDataFiles::DESIGN_SPECIFICATION_OUTDOOR_AIR
+      return check_userdata_outdoor_air(object_name, user_data)
+    when UserDataFiles::AIRLOOP_HVAC_DOAS
+      return check_userdata_airloop_hvac_doas(object_name, user_data)
+    when UserDataFiles::THERMAL_ZONE
+      return check_userdata_thermal_zone(object_name, user_data)
     else
       return true
     end
   end
 
-  # Check for incorrect data in electric equipment user data
+  def check_userdata_building(object_name, user_data)
+    userdata_valid = true
+    user_data.each do |user_building|
+      name = prm_read_user_data(user_building, 'name')
+      unless name
+        OpenStudio.logFree(OpenStudio::Error, 'prm.log', "User data: #{object_name}: building name is missing or empty. Building user data has not validated.")
+        return false
+      end
+
+      building_type_for_hvac = prm_read_user_data(user_building, 'building_type_for_hvac')
+      unless building_type_for_hvac.nil? || UserDataHVACBldgType.matched_any?(building_type_for_hvac)
+        OpenStudio.logFree(OpenStudio::Error, 'prm.log', "Unknown building type #{building_type_for_hvac} for prescribed HVAC system type. For full list of the building type, see: https://pnnl.github.io/BEM-for-PRM/user_guide/prm_api_ref/baseline_generation_api/#--default_hvac_bldg_type")
+        userdata_valid = false
+      end
+
+      building_type_for_wwr = prm_read_user_data(user_building, 'building_type_for_wwr')
+      unless building_type_for_wwr.nil? || UserDataWWRBldgType.matched_any?(building_type_for_wwr)
+        OpenStudio.logFree(OpenStudio::Error, 'prm.log', "Unknown building type #{building_type_for_hvac} for prescribed window-to-wall ratio. For full list of the building type, see: https://pnnl.github.io/BEM-for-PRM/user_guide/prm_api_ref/baseline_generation_api/#--default_wwr_bldg_type")
+        userdata_valid = false
+      end
 
+      building_type_for_swh = prm_read_user_data(user_building, 'building_type_for_swh')
+      unless building_type_for_swh.nil? || UserDataSHWBldgType.matched_any?(building_type_for_swh)
+        OpenStudio.logFree(OpenStudio::Error, 'prm.log', "Unknown building type #{building_type_for_hvac} for prescribed service hot water system. For full list of the building type, see: https://pnnl.github.io/BEM-for-PRM/user_guide/prm_api_ref/baseline_generation_api/#--default_swh_bldg_type")
+        userdata_valid = false
+      end
+
+      is_exempt_from_rotations = prm_read_user_data(user_building, 'is_exempt_from_rotations')
+      unless is_exempt_from_rotations.nil? || UserDataBoolean.matched_any?(is_exempt_from_rotations)
+        OpenStudio.logFree(OpenStudio::Error, 'prm.log', "User data: #{object_name}, Building name #{name}, is_exempt_from_rotations shall be either True or False. Got #{is_exempt_from_rotations}.")
+        userdata_valid = false
+      end
+    end
+    return userdata_valid
+  end
+
+  def check_userdata_thermal_zone(object_name, user_data)
+    userdata_valid = true
+    user_data.each do |user_thermal_zone|
+      name = prm_read_user_data(user_thermal_zone, 'name')
+      unless name
+        OpenStudio.logFree(OpenStudio::Error, 'prm.log', "User data: #{object_name}: thermal zone name is missing or empty. Thermal zone user data has not validated.")
+        return false
+      end
+      has_health_safety_night_cycle_exception = prm_read_user_data(user_thermal_zone, 'has_health_safety_night_cycle_exception', UserDataBoolean::FALSE)
+      unless has_health_safety_night_cycle_exception.nil? || UserDataBoolean.matched_any?(has_health_safety_night_cycle_exception)
+        OpenStudio.logFree(OpenStudio::Error, 'prm.log', "User data: #{object_name}, Thermal zone name #{name}, has_health_safety_night_cycle_exception shall be either True or False. Got #{has_health_safety_night_cycle_exception}")
+        userdata_valid = false
+      end
+    end
+    return userdata_valid
+  end
+
+  # Check for incorrect data in [UserDataFiles::AIRLOOP_HVAC_DOAS]
   # @param object_name [String] name of user data csv file to check
   # @param user_data [Hash] hash of data from user data csv file
-
   # @return [Boolean] true if data is valid, false if error found
-  def check_userdata_electric_equipment(object_name, user_data)
+  def check_userdata_airloop_hvac_doas(object_name, user_data)
     userdata_valid = true
-    user_data.each do |electric_row|
-      if electric_row['motor_horsepower'].nil? || electric_row['motor_efficiency'].nil? || electric_row['motor_is_exempt'].nil?
-        unless electric_row['motor_horsepower'].nil? && electric_row['motor_efficiency'].nil? && electric_row['motor_is_exempt'].nil?
-          userdata_valid = false
-          OpenStudio.logFree(OpenStudio::Error, 'User Data Error', "User data: #{object_name}: One or more motor data are not available for electric equipment #{electric_row['name']}. motor_horsepower: #{electric_row['motor_horsepower']}; motor_efficiency: #{electric_row['motor_efficiency']}; motor_is_exempt: #{electric_row['motor_is_exempt']}")
+    user_data.each do |user_airloop|
+      name = prm_read_user_data(user_airloop, 'name')
+      unless name
+        OpenStudio.logFree(OpenStudio::Error, 'prm.log', "User data: #{object_name}: air loop name is missing or empty. Air loop user data has not validated.")
+        return false
+      end
+      # Fan power credits, exhaust air energy recovery
+      user_airloop.keys.each do |info_key|
+        # Fan power credits
+        if info_key.include?('has_fan_power_credit')
+          has_fan_power_credit = prm_read_user_data(user_airloop, info_key)
+          unless has_fan_power_credit.nil? || UserDataBoolean.matched_any?(has_fan_power_credit)
+            OpenStudio.logFree(OpenStudio::Error, 'prm.log', "User data: #{object_name}, Air Loop name #{name}, #{info_key} shall be either True or False. Got #{has_fan_power_credit}.")
+            userdata_valid = false
+          end
+        elsif info_key.include?('fan_power_credit')
+          fan_power_credit = prm_read_user_data(user_airloop, info_key)
+          unless fan_power_credit.nil? || Float(fan_power_credit, exception: false)
+            OpenStudio.logFree(OpenStudio::Error, 'prm.log', "User data: #{object_name}, Air Loop name #{name}, #{info_key} shall be a numeric value. Got #{fan_power_credit}.")
+            userdata_valid = false
+          end
         end
-      else
-        # check for data type
-        if electric_row['motor_horsepower'].to_f == 0.0
-          userdata_valid = false
-          OpenStudio.logFree(OpenStudio::Error, 'User Data Error', "User data: #{object_name}: Motor #{electric_row['name']}'s horsepower data is either 0.0 or unavailable. Check the inputs.")
+        # Exhaust air energy recovery
+        if info_key.include?('exhaust_energy_recovery_exception')
+          exhaust_energy_recovery_exception = prm_read_user_data(user_airloop, info_key)
+          unless exhaust_energy_recovery_exception.nil? || UserDataBoolean.matched_any?(exhaust_energy_recovery_exception)
+            OpenStudio.logFree(OpenStudio::Error, 'prm.log', "User data: #{object_name}, Air Loop name #{name}, #{info_key} shall be either True or False. Got #{has_fan_power_credit}.")
+            userdata_valid = false
+          end
         end
-        if electric_row['motor_efficiency'].to_f == 0.0
-          userdata_valid = false
-          OpenStudio.logFree(OpenStudio::Error, 'User Data Error', "User data: #{object_name}: Motor #{electric_row['name']}'s efficiency data is either 0.0 or unavailable. Check the inputs.")
+      end
+    end
+    return userdata_valid
+  end
+
+  # Check for incorrect data in [UserDataFiles::DESIGN_SPECIFICATION_OUTDOOR_AIR]
+  # @param object_name [String] name of user data csv file to check
+  # @param user_data [Hash] hash of data from user data csv file
+  # @return [Boolean] true if data is valid, false if error found
+  def check_userdata_outdoor_air(object_name, user_data)
+    userdata_valid = true
+    user_data.each do |user_oa|
+      name = prm_read_user_data(user_oa, 'name')
+      unless name
+        OpenStudio.logFree(OpenStudio::Error, 'prm.log', "User data: #{object_name}: air loop name is missing or empty. Air loop user data has not validated.")
+        return false
+      end
+
+      outdoor_airflow_per_person = prm_read_user_data(user_oa, 'outdoor_airflow_per_person')
+      unless outdoor_airflow_per_person.nil? || Float(outdoor_airflow_per_person, exception: false)
+        OpenStudio.logFree(OpenStudio::Error, 'prm.log', "User data: #{object_name}, Design outdoor air name #{name}, outdoor_airflow_per_person shall be a numeric value. Got #{outdoor_airflow_per_person}.")
+        userdata_valid = false
+      end
+
+      outdoor_airflow_per_floor_area = prm_read_user_data(user_oa, 'outdoor_airflow_per_floor_area')
+      unless outdoor_airflow_per_floor_area.nil? || Float(outdoor_airflow_per_floor_area, exception: false)
+        OpenStudio.logFree(OpenStudio::Error, 'prm.log', "User data: #{object_name}, Design outdoor air name #{name}, outdoor_airflow_per_floor_area shall be a numeric value. Got #{outdoor_airflow_per_floor_area}.")
+        userdata_valid = false
+      end
+
+      outdoor_air_flowrate = prm_read_user_data(user_oa, 'outdoor_air_flowrate')
+      unless outdoor_air_flowrate.nil? || Float(outdoor_air_flowrate, exception: false)
+        OpenStudio.logFree(OpenStudio::Error, 'prm.log', "User data: #{object_name}, Design outdoor air name #{name}, outdoor_air_flowrate shall be a numeric value. Got #{outdoor_air_flowrate}.")
+        userdata_valid = false
+      end
+
+      outdoor_air_flow_air_changes_per_hour = prm_read_user_data(user_oa, 'outdoor_air_flow_air_changes_per_hour')
+      unless outdoor_air_flow_air_changes_per_hour.nil? || Float(outdoor_air_flow_air_changes_per_hour, exception: false)
+        OpenStudio.logFree(OpenStudio::Error, 'prm.log', "User data: #{object_name}, Design outdoor air name #{name}, outdoor_air_flow_air_changes_per_hour shall be a numeric value. Got #{outdoor_air_flow_air_changes_per_hour}.")
+        userdata_valid = false
+      end
+    end
+    return userdata_valid
+  end
+
+  # Check for incorrect data in [UserDataFiles::AIRLOOP_HVAC]
+  # @param object_name [String] name of user data csv file to check
+  # @param user_data [Hash] hash of data from user data csv file
+  # @return [Boolean] true if data is valid, false if error found
+  def check_userdata_airloop_hvac(object_name, user_data)
+    userdata_valid = true
+    user_data.each do |user_airloop|
+      name = prm_read_user_data(user_airloop, 'name')
+      unless name
+        OpenStudio.logFree(OpenStudio::Error, 'prm.log', "User data: #{object_name}: air loop name is missing or empty. Air loop user data has not validated.")
+        return false
+      end
+      # gas phase air cleaning is system base - add proposed hvac system name to zones
+      economizer_exception_for_gas_phase_air_cleaning = prm_read_user_data(user_airloop, 'economizer_exception_for_gas_phase_air_cleaning', UserDataBoolean::FALSE)
+      unless economizer_exception_for_gas_phase_air_cleaning.nil? || UserDataBoolean.matched_any?(economizer_exception_for_gas_phase_air_cleaning)
+        OpenStudio.logFree(OpenStudio::Error, 'prm.log', "User data: #{object_name}, Air Loop name #{name}, economizer_exception_for_gas_phase_air_cleaning shall be either True or False. Got #{economizer_exception_for_gas_phase_air_cleaning}")
+        userdata_valid = false
+      end
+
+      economizer_exception_for_open_refrigerated_cases = prm_read_user_data(user_airloop, 'economizer_exception_for_open_refrigerated_cases', UserDataBoolean::FALSE)
+      unless economizer_exception_for_open_refrigerated_cases.nil? || UserDataBoolean.matched_any?(economizer_exception_for_open_refrigerated_cases)
+        OpenStudio.logFree(OpenStudio::Error, 'prm.log', "User data: #{object_name}, Air Loop name #{name}, economizer_exception_for_open_refrigerated_cases shall be either True or False. Got #{economizer_exception_for_open_refrigerated_cases}")
+        userdata_valid = false
+      end
+
+      # Fan power credits, exhaust air energy recovery
+      user_airloop.keys.each do |info_key|
+        # Fan power credits
+        if info_key.include?('has_fan_power_credit')
+          has_fan_power_credit = prm_read_user_data(user_airloop, info_key)
+          unless has_fan_power_credit.nil? || UserDataBoolean.matched_any?(has_fan_power_credit)
+            OpenStudio.logFree(OpenStudio::Error, 'prm.log', "User data: #{object_name}, Air Loop name #{name}, #{info_key} shall be either True or False. Got #{has_fan_power_credit}.")
+            userdata_valid = false
+          end
+        elsif info_key.include?('fan_power_credit')
+          fan_power_credit = prm_read_user_data(user_airloop, info_key)
+          unless fan_power_credit.nil? || Float(fan_power_credit, exception: false)
+            OpenStudio.logFree(OpenStudio::Error, 'prm.log', "User data: #{object_name}, Air Loop name #{name}, #{info_key} shall be a numeric value. Got #{fan_power_credit}.")
+            userdata_valid = false
+          end
+        end
+        # Exhaust air energy recovery
+        if info_key.include?('exhaust_energy_recovery_exception')
+          exhaust_energy_recovery_exception = prm_read_user_data(user_airloop, info_key)
+          unless exhaust_energy_recovery_exception.nil? || UserDataBoolean.matched_any?(exhaust_energy_recovery_exception)
+            OpenStudio.logFree(OpenStudio::Error, 'prm.log', "User data: #{object_name}, Air Loop name #{name}, #{info_key} shall be either True or False. Got #{has_fan_power_credit}.")
+            userdata_valid = false
+          end
         end
-        if electric_row['motor_is_exempt'].casecmp?('yes') || electric_row['motor_is_exempt'].casecmp?('no')
+      end
+    end
+    return userdata_valid
+  end
+
+  # Check for incorrect data in exterior lights user data
+
+  # @param object_name [String] name of user data csv file to check
+  # @param user_data [Hash] hash of data from user data csv file
+
+  # @return [Boolean] true if data is valid, false if error found
+  def check_userdata_exterior_lighting(object_name, user_data)
+    userdata_valid = true
+    user_data.each do |exterior_light|
+      name = prm_read_user_data(exterior_light, 'name')
+      unless name
+        OpenStudio.logFree(OpenStudio::Error, 'prm.log', "User data: #{object_name}: exterior light name is missing or empty. Exterior light user data has not validated.")
+        return false
+      end
+
+      num_cats = prm_read_user_data(exterior_light, 'num_ext_lights_subcats', '0').to_i
+      (1..num_cats).each do |icat|
+        cat_key = format('end_use_subcategory_%02d', icat)
+        subcat = prm_read_user_data(exterior_light, cat_key, nil)
+        unless subcat
+          OpenStudio.logFree(OpenStudio::Error, 'prm.log', "User data: #{object_name}, Exterior light: #{name}, #{cat_key} is either missing or empty.")
           userdata_valid = false
-          OpenStudio.logFree(OpenStudio::Error, 'User Data Error', "User data: #{object_name}: Motor #{electric_row['name']} is exempt data should be either Yes or No. But get data #{electric_row['motor_is_exempt']}")
         end
       end
+    end
+    return userdata_valid
+  end
+
+  # Check for incorrect data in electric equipment user data
+
+  # @param object_name [String] name of user data csv file to check
+  # @param user_data [Hash] hash of data from user data csv file
+
+  # @return [Boolean] true if data is valid, false if error found
+  def check_userdata_electric_equipment(object_name, user_data)
+    userdata_valid = true
+    user_data.each do |electric_row|
+      # check for data type
+      # unless fan_power_credit.nil? || Float(fan_power_credit, exception: false)
+      motor_horsepower = prm_read_user_data(electric_row, 'motor_horsepower')
+      unless motor_horsepower.nil? || Float(motor_horsepower, exception: false)
+        userdata_valid = false
+        OpenStudio.logFree(OpenStudio::Error, 'prm.log', "User data: #{object_name}: Motor #{electric_row['name']}'s horsepower data is either 0.0 or unavailable. Check the inputs.")
+      end
+      motor_efficiency = prm_read_user_data(electric_row, 'motor_efficiency')
+      unless motor_efficiency.nil? || Float(motor_efficiency, exception: false)
+        userdata_valid = false
+        OpenStudio.logFree(OpenStudio::Error, 'prm.log', "User data: #{object_name}: Motor #{electric_row['name']}'s efficiency data is either 0.0 or unavailable. Check the inputs.")
+      end
+      motor_is_exempt = prm_read_user_data(electric_row, 'motor_is_exempt')
+      unless motor_is_exempt.nil? || UserDataBoolean.matched_any?(motor_is_exempt)
+        userdata_valid = false
+        OpenStudio.logFree(OpenStudio::Error, 'prm.log', "User data: #{object_name}: Motor #{electric_row['name']} is exempt data should be either True or False. But get data #{electric_row['motor_is_exempt']}")
+      end
       # We may need to do the same for refrigeration and elevator?
       # Check elevator
-      if electric_row['elevator_weight_of_car'].nil? || electric_row['elevator_rated_load'].nil? || electric_row['elevator_counter_weight_of_car'].nil? || electric_row['elevator_speed_of_car'].nil? || electric_row['elevator_number_of_stories'].nil?
-        if electric_row['elevator_weight_of_car'].nil? && electric_row['elevator_rated_load'].nil? && electric_row['elevator_counter_weight_of_car'].nil? && electric_row['elevator_speed_of_car'].nil? && electric_row['elevator_number_of_stories'].nil?
-          userdata_valid = false
-          OpenStudio.logFree(OpenStudio::Error, 'User Data Error', "User data: #{object_name}: One or more elevator data is not available for electric equipment #{electric_row['name']}. elevator_weight_of_car: #{electric_row['elevator_weight_of_car']}; elevator_rated_load: #{electric_row['elevator_rated_load']}; elevator_counter_weight_of_car: #{electric_row['elevator_counter_weight_of_car']}; elevator_speed_of_car: #{electric_row['elevator_speed_of_car']}; elevator_number_of_stories: #{electric_row['elevator_number_of_stories']}")
-        end
-      else
-        # check for data type
-        if electric_row['elevator_weight_of_car'].to_f == 0.0
-          userdata_valid = false
-          OpenStudio.logFree(OpenStudio::Error, 'User Data Error', "User data: #{object_name}: Elevator #{electric_row['name']}'s weight of car data is either 0.0 or unavailable. Check the inputs.")
-        end
-        if electric_row['elevator_rated_load'].to_f == 0.0
-          userdata_valid = false
-          OpenStudio.logFree(OpenStudio::Error, 'User Data Error', "User data: #{object_name}: Elevator #{electric_row['name']}'s rated load data is either 0.0 or unavailable. Check the inputs.")
-        end
-        if electric_row['elevator_counter_weight_of_car'].to_f == 0.0
-          userdata_valid = false
-          OpenStudio.logFree(OpenStudio::Error, 'User Data Error', "User data: #{object_name}: Elevator #{electric_row['name']}'s counter weight of car data is either 0.0 or unavailable. Check the inputs.")
-        end
-        if electric_row['elevator_speed_of_car'].to_f == 0.0
-          userdata_valid = false
-          OpenStudio.logFree(OpenStudio::Error, 'User Data Error', "User data: #{object_name}: Elevator #{electric_row['name']}'s speed of car data is either 0.0 or unavailable. Check the inputs.")
-        end
-        if electric_row['elevator_number_of_stories'].to_i > 1
-          userdata_valid = false
-          OpenStudio.logFree(OpenStudio::Error, 'User Data Error', "User data: #{object_name}: Elevator #{electric_row['name']}'s serves number of stories data is either smaller or equal to 1 or unavailable. Check the inputs.")
-        end
+      elevator_weight_of_car = prm_read_user_data(electric_row, 'elevator_weight_of_car')
+      unless elevator_weight_of_car.nil? || Float(elevator_weight_of_car, exception: false)
+        userdata_valid = false
+        OpenStudio.logFree(OpenStudio::Error, 'prm.log', "User data: #{object_name}: Elevator #{electric_row['name']}'s weight of car data is either 0.0 or unavailable. Check the inputs.")
+      end
+      elevator_rated_load = prm_read_user_data(electric_row, 'elevator_rated_load')
+      unless elevator_rated_load.nil? || Float(elevator_rated_load, exception: false)
+        userdata_valid = false
+        OpenStudio.logFree(OpenStudio::Error, 'prm.log', "User data: #{object_name}: Elevator #{electric_row['name']}'s rated load data is either 0.0 or unavailable. Check the inputs.")
+      end
+      elevator_counter_weight_of_car = prm_read_user_data(electric_row, 'elevator_counter_weight_of_car')
+      unless elevator_counter_weight_of_car.nil? || Float(elevator_counter_weight_of_car, exception: false)
+        userdata_valid = false
+        OpenStudio.logFree(OpenStudio::Error, 'prm.log', "User data: #{object_name}: Elevator #{electric_row['name']}'s counter weight of car data is either 0.0 or unavailable. Check the inputs.")
+      end
+      elevator_speed_of_car = prm_read_user_data(electric_row, 'elevator_speed_of_car')
+      unless elevator_speed_of_car.nil? || Float(elevator_speed_of_car, exception: false)
+        userdata_valid = false
+        OpenStudio.logFree(OpenStudio::Error, 'prm.log', "User data: #{object_name}: Elevator #{electric_row['name']}'s speed of car data is either 0.0 or unavailable. Check the inputs.")
+      end
+      elevator_number_of_stories = prm_read_user_data(electric_row, 'elevator_number_of_stories')
+      unless elevator_number_of_stories.nil? || Integer(elevator_number_of_stories, exception: false)
+        userdata_valid = false
+        OpenStudio.logFree(OpenStudio::Error, 'prm.log', "User data: #{object_name}: Elevator #{electric_row['name']}'s serves number of stories data is either smaller or equal to 1 or unavailable. Check the inputs.")
       end
       # Check refrigeration
-      if electric_row['refrigeration_equipment_class'].nil? || electric_row['refrigeration_equipment_volume'].nil? || electric_row['refrigeration_equipment_total_display_area'].nil?
-        if electric_row['refrigeration_equipment_class'].nil? && electric_row['refrigeration_equipment_volume'].nil? && electric_row['refrigeration_equipment_total_display_area'].nil?
-          userdata_valid = false
-          OpenStudio.logFree(OpenStudio::Error, 'User Data Error', "User data: #{object_name}: One or more refrigeration data is not available for electric equipment #{electric_row['name']}. refrigeration_equipment_class: #{electric_row['refrigeration_equipment_class']}; refrigeration_equipment_volume: #{electric_row['refrigeration_equipment_volume']}; refrigeration_equipment_total_display_area: #{electric_row['refrigeration_equipment_total_display_area']}")
-        end
-      else
-        # Check data type
-        # The equipment class shall be verified at the implementation level
-        if electric_row['refrigeration_equipment_volume'].to_f == 0.0
-          userdata_valid = false
-          OpenStudio.logFree(OpenStudio::Error, 'User Data Error', "User data: #{object_name}: Refrigeration #{electric_row['name']}'s equipment volume data is either 0.0 or unavailable. Check the inputs.")
-        end
-        if electric_row['refrigeration_equipment_total_display_area'].to_f == 0.0
-          userdata_valid = false
-          OpenStudio.logFree(OpenStudio::Error, 'User Data Error', "User data: #{object_name}: Refrigeration #{electric_row['name']}'s total display area data is either 0.0 or unavailable. Check the inputs.")
-        end
+      # Check data type
+      # The equipment class shall be verified at the implementation level
+      refrigeration_equipment_volume = prm_read_user_data(electric_row, 'refrigeration_equipment_volume')
+      unless refrigeration_equipment_volume.nil? || Float(refrigeration_equipment_volume, exception: false)
+        userdata_valid = false
+        OpenStudio.logFree(OpenStudio::Error, 'prm.log', "User data: #{object_name}: Refrigeration #{electric_row['name']}'s equipment volume data is either 0.0 or unavailable. Check the inputs.")
+      end
+      refrigeration_equipment_total_display_area = prm_read_user_data(electric_row, 'refrigeration_equipment_total_display_area')
+      unless refrigeration_equipment_total_display_area.nil? || Float(refrigeration_equipment_total_display_area, exception: false)
+        userdata_valid = false
+        OpenStudio.logFree(OpenStudio::Error, 'prm.log', "User data: #{object_name}: Refrigeration #{electric_row['name']}'s total display area data is either 0.0 or unavailable. Check the inputs.")
       end
     end
     return userdata_valid
@@ -219,18 +468,23 @@ class ASHRAE901PRM < Standard
   # @return [Boolean] true if data is valid, false if error found
   def check_userdata_space_and_spacetype(object_name, user_data)
     userdata_valid = true
-    user_data.each do |lpd_row|
-      unless lpd_row['num_std_ltg_types'].to_i == 0
-        num_ltg_type = lpd_row['num_std_ltg_types'].to_i
+    user_data.each do |row|
+      building_type_for_wwr = prm_read_user_data(row, 'building_type_for_wwr')
+      unless building_type_for_wwr.nil? || UserDataWWRBldgType.matched_any?(building_type_for_wwr)
+        OpenStudio.logFree(OpenStudio::Error, 'prm.log', "Unknown building type #{building_type_for_wwr} for prescribed window to wall ratio. For full list of the building type, see: https://pnnl.github.io/BEM-for-PRM/user_guide/prm_api_ref/baseline_generation_api/#--default_wwr_bldg_type")
+        userdata_valid = false
+      end
+      unless prm_read_user_data(row, 'num_std_ltg_types', '0').to_i == 0
+        num_ltg_type = row['num_std_ltg_types'].to_i
         total_ltg_percent = 0.0
         std_ltg_index = 0
         while std_ltg_index < num_ltg_type
           frac_key = format('std_ltg_type_frac%02d', (std_ltg_index + 1))
-          total_ltg_percent += lpd_row[frac_key].to_f
+          total_ltg_percent += prm_read_user_data(row, frac_key, '0.0').to_f
           std_ltg_index += 1
         end
         if (total_ltg_percent - 1.0).abs > 0.01
-          OpenStudio.logFree(OpenStudio::Error, 'User Data Error', "User data #{object_name}: The fraction of user defined lighting types in Space/SpaceType: #{lpd_row['name']} does not add up to 1.0. The calculated fraction is #{total_ltg_percent}.")
+          OpenStudio.logFree(OpenStudio::Error, 'prm.log', "User data #{object_name}: The fraction of user defined lighting types in Space/SpaceType: #{row['name']} does not add up to 1.0. The calculated fraction is #{total_ltg_percent}.")
           userdata_valid = false
         end
       end