openstudio-standards 0.4.0 → 0.5.0

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

@@ -10,7 +10,7 @@ class ASHRAE901PRM < Standard
   #
   # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
   # @param min_occ_pct [Double] the fractional value below which the system will be considered unoccupied.
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def air_loop_hvac_enable_unoccupied_fan_shutoff(air_loop_hvac, min_occ_pct = 0.05)
     if air_loop_hvac.additionalProperties.hasFeature('zone_group_type')
       zone_group_type = air_loop_hvac.additionalProperties.getFeatureAsString('zone_group_type').get
@@ -92,25 +92,14 @@ class ASHRAE901PRM < Standard
   end
 
   # Determine if the system is a multizone VAV system
-  #
-  # @return [Bool] Returns true if required, false if not.
+  # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
+  # @return [Boolean] Returns true if required, false if not.
   def air_loop_hvac_multizone_vav_system?(air_loop_hvac)
     return true if air_loop_hvac.name.to_s.include?('Sys5') || air_loop_hvac.name.to_s.include?('Sys6') || air_loop_hvac.name.to_s.include?('Sys7') || air_loop_hvac.name.to_s.include?('Sys8')
 
     return false
   end
 
-  # Determine if multizone vav optimization is required.
-  # Not required for stable baseline.
-  #
-  # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
-  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
-  # @return [Bool] returns true if required, false if not
-  def air_loop_hvac_multizone_vav_optimization_required?(air_loop_hvac, climate_zone)
-    multizone_opt_required = false
-    return multizone_opt_required
-  end
-
   # Determine whether the VAV damper control is single maximum or dual maximum control.
   # Defaults to Single Maximum for stable baseline.
   #
@@ -132,7 +121,7 @@ class ASHRAE901PRM < Standard
   #
   # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
   # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
-  # @return [Bool] returns true if required, false if not
+  # @return [Boolean] returns true if required, false if not
   def air_loop_hvac_integrated_economizer_required?(air_loop_hvac, climate_zone)
     return true
   end
@@ -165,7 +154,7 @@ class ASHRAE901PRM < Standard
   #
   # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
   # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
-  # @return [Bool] returns true if required, false if not
+  # @return [Boolean] returns true if required, false if not
   def air_loop_hvac_prm_baseline_economizer_required?(air_loop_hvac, climate_zone)
     economizer_required = false
     baseline_system_type = air_loop_hvac.additionalProperties.getFeatureAsString('baseline_system_type').get
@@ -204,7 +193,7 @@ class ASHRAE901PRM < Standard
   end
 
   # Set fan curve for stable baseline to be VSD with fixed static pressure setpoint
-  # @return [string] name of appropriate curve for this code version
+  # @return [String name of appropriate curve for this code version
   def air_loop_hvac_set_vsd_curve_type
     return 'Multi Zone VAV with VSD and Fixed SP Setpoint'
   end
@@ -213,7 +202,7 @@ class ASHRAE901PRM < Standard
   # PRM does not require optimum start - override it to false.
   #
   # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
-  # @return [Bool] returns true if required, false if not
+  # @return [Boolean] returns true if required, false if not
   def air_loop_hvac_optimum_start_required?(air_loop_hvac)
     return false
   end
@@ -229,7 +218,7 @@ class ASHRAE901PRM < Standard
   # Also adjusts the fan power and flow rates
   # of any parallel PIU terminals on the system.
   #
-  # return [Bool] true if successful, false if not.
+  # return [Boolean] true if successful, false if not.
   def air_loop_hvac_apply_prm_baseline_fan_power(air_loop_hvac)
     # Get system type associated with air loop
     system_type = air_loop_hvac.additionalProperties.getFeatureAsString('baseline_system_type').get
@@ -263,7 +252,12 @@ class ASHRAE901PRM < Standard
       # individual zone air flow
       air_loop_total_zone_design_airflow = 0
       air_loop_hvac.thermalZones.sort.each do |zone|
-        zone_air_flow = zone.designAirFlowRate.to_f
+        # error if zone design air flow rate is not available
+        if zone.model.version < OpenStudio::VersionString.new('3.6.0')
+          OpenStudio.logFree(OpenStudio::Error, 'openstudio.ashrae_90_1_prm.AirLoopHVAC', 'Required ThermalZone method .autosizedDesignAirFlowRate is not available in pre-OpenStudio 3.6.0 versions. Use a more recent version of OpenStudio.')
+        end
+
+        zone_air_flow = zone.autosizedDesignAirFlowRate.to_f
         air_loop_total_zone_design_airflow += zone_air_flow
         # Fractions variables are actually power at that point
         supply_fan_power_fraction += zone_air_flow * zone.additionalProperties.getFeatureAsDouble('supply_fan_w').get
@@ -415,6 +409,7 @@ class ASHRAE901PRM < Standard
   # Determine the allowable fan system brake horsepower
   # Per Section G3.1.2.9
   #
+  # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC]
   # @return [Double] allowable fan system brake horsepower
   #   units = horsepower
   def air_loop_hvac_allowable_system_brake_horsepower(air_loop_hvac)
@@ -554,7 +549,7 @@ class ASHRAE901PRM < Standard
   # Get the air loop HVAC design outdoor air flow rate by reading Standard 62.1 Summary from the sizing sql
   # @author Xuechen (Jerry) Lei, PNNL
   # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
-  # @return [Float] Design outdoor air flow rate (m^3/s)
+  # @return [Double] Design outdoor air flow rate (m^3/s)
   def get_airloop_hvac_design_oa_from_sql(air_loop_hvac)
     return false unless air_loop_hvac.airLoopHVACOutdoorAirSystem.is_initialized
 
@@ -570,9 +565,9 @@ class ASHRAE901PRM < Standard
   # Set the minimum VAV damper positions.
   #
   # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
-  # @param has_ddc [Bool] if true, will assume that there is DDC control of vav terminals.
+  # @param has_ddc [Boolean] if true, will assume that there is DDC control of vav terminals.
   #   If false, assumes otherwise.
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def air_loop_hvac_apply_minimum_vav_damper_positions(air_loop_hvac, has_ddc = true)
     air_loop_hvac.thermalZones.each do |zone|
       zone.equipment.each do |equip|
@@ -756,28 +751,27 @@ class ASHRAE901PRM < Standard
 
         # Exception 2 - System exhausting toxic fumes
         if thermal_zone.additionalProperties.hasFeature('exhaust_energy_recovery_exception_for_toxic_fumes_etc')
-          if thermal_zone.additionalProperties.getFeatureAsString('exhaust_energy_recovery_exception_for_toxic_fumes_etc').get == 'yes'
-            return nil
+          if thermal_zone.additionalProperties.getFeatureAsBoolean('exhaust_energy_recovery_exception_for_toxic_fumes_etc')
           end
         end
 
         # Exception 3 - Commercial kitchen hoods
         if thermal_zone.additionalProperties.hasFeature('exhaust_energy_recovery_exception_for_type1_kitchen_hoods')
-          if thermal_zone.additionalProperties.getFeatureAsString('exhaust_energy_recovery_exception_for_type1_kitchen_hoods').get == 'yes'
+          if thermal_zone.additionalProperties.getFeatureAsBoolean('exhaust_energy_recovery_exception_for_type1_kitchen_hoods')
             return nil
           end
         end
 
         # Exception 6 - Distributed exhaust
         if thermal_zone.additionalProperties.hasFeature('exhaust_energy_recovery_exception_for_type_distributed_exhaust')
-          if thermal_zone.additionalProperties.getFeatureAsString('exhaust_energy_recovery_exception_for_type_distributed_exhaust').get == 'yes'
+          if thermal_zone.additionalProperties.getFeatureAsBoolean('exhaust_energy_recovery_exception_for_type_distributed_exhaust')
             return nil
           end
         end
 
         # Exception 7 - Dehumidification
         if thermal_zone.additionalProperties.hasFeature('exhaust_energy_recovery_exception_for_dehumidifcation_with_series_cooling_recovery')
-          if thermal_zone.additionalProperties.getFeatureAsString('exhaust_energy_recovery_exception_for_dehumidifcation_with_series_cooling_recovery').get == 'yes'
+          if thermal_zone.additionalProperties.getFeatureAsBoolean('exhaust_energy_recovery_exception_for_dehumidifcation_with_series_cooling_recovery')
             return nil
           end
         end

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

@@ -3,7 +3,7 @@ class ASHRAE901PRM < Standard
 
   # Return the fan on flow fraction for a parallel PIU terminal
   #
-  # @return [Float] returns nil or a float representing the fraction
+  # @return [Double] returns nil or a float representing the fraction
   def air_terminal_single_duct_parallel_piu_reheat_fan_on_flow_fraction
     return 0.0 # will make the secondary fans run for heating loads
   end

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

@@ -9,9 +9,9 @@ class ASHRAE901PRM < Standard
   # @param zone_min_oa [Double] the zone outdoor air flow rate, in m^3/s.
   #   If supplied, this will be set as a minimum limit in addition to the minimum
   #   damper position.  EnergyPlus will use the larger of the two values during sizing.
-  # @param has_ddc [Bool] whether or not there is DDC control of the VAV terminal,
+  # @param has_ddc [Boolean] whether or not there is DDC control of the VAV terminal,
   #   which impacts the minimum damper position requirement.
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   # @todo remove exception where older vintages don't have minimum positions adjusted.
   def air_terminal_single_duct_vav_reheat_apply_minimum_damper_position(air_terminal_single_duct_vav_reheat, zone_min_oa = nil, has_ddc = true)
     # Minimum damper position

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

@@ -1,83 +1,10 @@
 class ASHRAE901PRM < Standard
   # @!group BoilerHotWater
 
-  # find search criteria
-  #
-  # @param boiler_hot_water [OpenStudio::Model::BoilerHotWater] hot water boiler object
-  # @return [Hash] used for standards_lookup_table(model)
-  def boiler_hot_water_find_search_criteria(boiler_hot_water)
-    # Define the criteria to find the boiler properties
-    # in the hvac standards data set.
-    search_criteria = {}
-    search_criteria['template'] = template
-
-    # Get fuel type
-    search_criteria['fuel_type'] = 'Gas'
-
-    # Get the fluid type
-    search_criteria['fluid_type'] = 'Hot Water'
-
-    return search_criteria
-  end
-
-  # Finds lookup object in standards and return minimum thermal efficiency
-  #
-  # @param boiler_hot_water [OpenStudio::Model::BoilerHotWater] hot water boiler object
-  # @param rename [Bool] returns true if successful, false if not
-  # @return [Double] minimum thermal efficiency
-  def boiler_hot_water_standard_minimum_thermal_efficiency(boiler_hot_water, rename = false)
-    # Get the boiler properties
-    search_criteria = boiler_hot_water_find_search_criteria(boiler_hot_water)
-    capacity_w = boiler_hot_water_find_capacity(boiler_hot_water)
-    capacity_btu_per_hr = OpenStudio.convert(capacity_w, 'W', 'Btu/hr').get
-    capacity_kbtu_per_hr = OpenStudio.convert(capacity_w, 'W', 'kBtu/hr').get
-
-    # Get the minimum efficiency standards
-    thermal_eff = nil
-
-    # Get the boiler properties
-    blr_props = model_find_object(standards_data['boilers'], search_criteria, capacity_btu_per_hr)
-    unless blr_props
-      OpenStudio.logFree(OpenStudio::Warn, 'openstudio.standards.BoilerHotWater', "For #{boiler_hot_water.name}, cannot find boiler properties, cannot apply efficiency standard.")
-      successfully_set_all_properties = false
-      return successfully_set_all_properties
-    end
-
-    # If specified as AFUE
-    unless blr_props['minimum_annual_fuel_utilization_efficiency'].nil?
-      min_afue = blr_props['minimum_annual_fuel_utilization_efficiency']
-      thermal_eff = afue_to_thermal_eff(min_afue)
-      new_comp_name = "#{boiler_hot_water.name} #{capacity_kbtu_per_hr.round}kBtu/hr #{min_afue} AFUE"
-      OpenStudio.logFree(OpenStudio::Info, 'openstudio.standards.BoilerHotWater', "For #{template}: #{boiler_hot_water.name}: Gas Hot Water Capacity = #{capacity_kbtu_per_hr.round}kBtu/hr; AFUE = #{min_afue}")
-    end
-
-    # If specified as thermal efficiency
-    unless blr_props['minimum_thermal_efficiency'].nil?
-      thermal_eff = blr_props['minimum_thermal_efficiency']
-      new_comp_name = "#{boiler_hot_water.name} #{capacity_kbtu_per_hr.round}kBtu/hr #{thermal_eff} Thermal Eff"
-      OpenStudio.logFree(OpenStudio::Info, 'openstudio.standards.BoilerHotWater', "For #{template}: #{boiler_hot_water.name}: Gas Hot Water Capacity = #{capacity_kbtu_per_hr.round}kBtu/hr; Thermal Efficiency = #{thermal_eff}")
-    end
-
-    # If specified as combustion efficiency
-    unless blr_props['minimum_combustion_efficiency'].nil?
-      min_comb_eff = blr_props['minimum_combustion_efficiency']
-      thermal_eff = combustion_eff_to_thermal_eff(min_comb_eff)
-      new_comp_name = "#{boiler_hot_water.name} #{capacity_kbtu_per_hr.round}kBtu/hr #{min_comb_eff} Combustion Eff"
-      OpenStudio.logFree(OpenStudio::Info, 'openstudio.standards.BoilerHotWater', "For #{template}: #{boiler_hot_water.name}: Gas Hot Water Capacity = #{capacity_kbtu_per_hr.round}kBtu/hr; Combustion Efficiency = #{min_comb_eff}")
-    end
-
-    # Rename
-    if rename
-      boiler_hot_water.setName(new_comp_name)
-    end
-
-    return thermal_eff
-  end
-
   # Applies the standard efficiency ratings to this object.
   #
   # @param boiler_hot_water [OpenStudio::Model::BoilerHotWater] hot water boiler object
-  # @return [Bool] true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def boiler_hot_water_apply_efficiency_and_curves(boiler_hot_water)
     # Get the minimum efficiency standards
     thermal_eff = boiler_hot_water_standard_minimum_thermal_efficiency(boiler_hot_water)

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

@@ -1,72 +1,20 @@
 class ASHRAE901PRM < Standard
   # @!group ChillerElectricEIR
 
-  # Finds the search criteria
-  #
-  # @param chiller_electric_eir [OpenStudio::Model::ChillerElectricEIR] chiller object
-  # @return [hash] has for search criteria to be used for find object
-  def chiller_electric_eir_find_search_criteria(chiller_electric_eir)
-    search_criteria = {}
-    search_criteria['template'] = template
-
-    # In AppG prm models, all scenarios are WaterCooled for cooling type.
-    cooling_type = 'WaterCooled'
-
-    search_criteria['cooling_type'] = cooling_type
-
-    # TODO: Standards replace this with a mechanism to store this
-    # data in the chiller object itself.
-    # For now, retrieve the condenser type from the name
-    name = chiller_electric_eir.name.get
-    condenser_type = nil
-    compressor_type = nil
-    if chiller_electric_eir.additionalProperties.hasFeature('compressor_type')
-      compressor_type = chiller_electric_eir.additionalProperties.getFeatureAsString('compressor_type').get
-    end
-    unless condenser_type.nil?
-      search_criteria['condenser_type'] = condenser_type
-    end
-    unless compressor_type.nil?
-      search_criteria['compressor_type'] = compressor_type
-    end
-
-    return search_criteria
-  end
-
-  # Finds lookup object in standards and return full load efficiency
+  # Applies the standard efficiency ratings to this object.
   #
   # @param chiller_electric_eir [OpenStudio::Model::ChillerElectricEIR] chiller object
-  # @return [Double] full load efficiency (COP), [Double] capacity in tons, [Double] kw/ton
-  def chiller_electric_eir_standard_minimum_full_load_efficiency(chiller_electric_eir)
-    # Get the chiller properties
-    search_criteria = chiller_electric_eir_find_search_criteria(chiller_electric_eir)
+  # @return [Boolean] returns true if successful, false if not
+  def chiller_electric_eir_apply_efficiency_and_curves(chiller_electric_eir)
+    # Get the chiller capacity
     capacity_w = chiller_electric_eir_find_capacity(chiller_electric_eir)
-    unless capacity_w
-      return nil
-    end
 
+    # Convert capacity to tons
     capacity_tons = OpenStudio.convert(capacity_w, 'W', 'ton').get
-    chlr_props = model_find_object(standards_data['chillers'], search_criteria, capacity_tons, Date.today)
-
-    if chlr_props.nil? || !chlr_props['minimum_full_load_efficiency']
-      OpenStudio.logFree(OpenStudio::Warn, 'openstudio.standards.ChillerElectricEIR', "For #{chiller_electric_eir.name}, cannot find minimum full load efficiency.")
-      return nil
-    else
-      # lookup the efficiency value
-      kw_per_ton = chlr_props['minimum_full_load_efficiency']
-      cop = kw_per_ton_to_cop(kw_per_ton)
-    end
 
-    return cop, capacity_tons, kw_per_ton
-  end
-
-  # Applies the standard efficiency ratings to this object.
-  #
-  # @param chiller_electric_eir [OpenStudio::Model::ChillerElectricEIR] chiller object
-  # @return [Bool] true if successful, false if not
-  def chiller_electric_eir_apply_efficiency_and_curves(chiller_electric_eir)
     # Set the efficiency value
-    cop, capacity_tons, kw_per_ton = chiller_electric_eir_standard_minimum_full_load_efficiency(chiller_electric_eir)
+    cop = chiller_electric_eir_standard_minimum_full_load_efficiency(chiller_electric_eir)
+    kw_per_ton = cop_to_kw_per_ton(cop)
     if cop.nil?
       OpenStudio.logFree(OpenStudio::Warn, 'openstudio.standards.ChillerElectricEIR', "For #{chiller_electric_eir.name}, cannot find minimum full load efficiency, will not be set.")
       successfully_set_all_properties = false

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

@@ -82,7 +82,7 @@ class ASHRAE901PRM < Standard
   #
   # @param coil_cooling_dx_single_speed [OpenStudio::Model::CoilCoolingDXSingleSpeed] coil cooling dx single speed object
   # @param sys_type [String] HVAC system type
-  # @param rename [Bool] if true, object will be renamed to include capacity and efficiency level
+  # @param rename [Boolean] if true, object will be renamed to include capacity and efficiency level
   # @return [Double] full load efficiency (COP)
   def coil_cooling_dx_single_speed_standard_minimum_cop(coil_cooling_dx_single_speed, sys_type, rename = false)
     # find properties

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

@@ -43,7 +43,7 @@ class ASHRAE901PRM < Standard
   #
   # @param coil_cooling_dx_two_speed [OpenStudio::Model::CoilCoolingDXTwoSpeed] coil cooling dx two speed object
   # @param sys_type [String] HVAC system type
-  # @param rename [Bool] if true, object will be renamed to include capacity and efficiency level
+  # @param rename [Boolean] if true, object will be renamed to include capacity and efficiency level
   # @return [Double] full load efficiency (COP)
   def coil_cooling_dx_two_speed_standard_minimum_cop(coil_cooling_dx_two_speed, sys_type, rename = false)
     # find properties

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

@@ -49,7 +49,7 @@ module ASHRAEPRMCoilDX
   # @param coil_dx [OpenStudio::Model::StraightComponent] coil cooling object
   # @param capacity [Double] capacity in btu/hr
   # @param sys_type [String] HVAC system type
-  # @return [hash] has for search criteria to be used for find object
+  # @return [Hash] has for search criteria to be used for find object
   def coil_dx_find_search_criteria(coil_dx, capacity, sys_type)
     search_criteria = {}
     search_criteria['template'] = template

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

@@ -137,7 +137,7 @@ class ASHRAE901PRM < Standard
   #
   # @param coil_heating_dx_single_speed [OpenStudio::Model::CoilHeatingDXSingleSpeed] coil heating dx single speed object
   # @param sys_type [String] HVAC system type
-  # @param rename [Bool] if true, object will be renamed to include capacity and efficiency level
+  # @param rename [Boolean] if true, object will be renamed to include capacity and efficiency level
   # @return [Double] full load efficiency (COP)
   def coil_heating_dx_single_speed_standard_minimum_cop(coil_heating_dx_single_speed, sys_type, rename = false)
     # find ac properties

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

@@ -23,31 +23,11 @@ class ASHRAE901PRM < Standard
     return search_criteria
   end
 
-  # find furnace capacity
-  #
-  # @param coil_heating_gas [OpenStudio::Model::CoilHeatingGas] coil heating gas object
-  # @return [Double] capacity in W to be used for find object
-  def coil_heating_gas_find_capacity(coil_heating_gas)
-    # Get the coil capacity
-    capacity_w = nil
-    if coil_heating_gas.nominalCapacity.is_initialized
-      capacity_w = coil_heating_gas.nominalCapacity.get
-    elsif coil_heating_gas.autosizedNominalCapacity.is_initialized
-      capacity_w = coil_heating_gas.autosizedNominalCapacity.get
-    else
-      OpenStudio.logFree(OpenStudio::Warn, 'openstudio.standards.CoilHeatingGas', "For #{coil_heating_gas.name} capacity is not available, cannot apply efficiency standard.")
-      successfully_set_all_properties = false
-      return successfully_set_all_properties
-    end
-
-    return capacity_w
-  end
-
   # Finds lookup object in standards and return minimum thermal efficiency
   #
   # @param coil_heating_gas [OpenStudio::Model::CoilHeatingGas] coil heating gas object
   # @param sys_type [String] HVAC system type
-  # @param rename [Bool] if true, object will be renamed to include capacity and efficiency level
+  # @param rename [Boolean] if true, object will be renamed to include capacity and efficiency level
   # @return [Double] minimum thermal efficiency
   def coil_heating_gas_standard_minimum_thermal_efficiency(coil_heating_gas, sys_type, rename = false)
     # Get the coil properties

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

@@ -0,0 +1,101 @@
+class ASHRAE901PRM2019 < ASHRAE901PRM
+  # @!group DesignSpecification:OutdoorAir
+  # Sets the rules on outdoor air specifications on spaces / spaceType
+
+  # Function applies user specified OA to the model
+  # @param model [OpenStudio::Model::Model] model object
+  # @return [Boolean] returns true if successful, false if not
+  def model_apply_userdata_outdoor_air(model)
+    # Step 1: Create a hash that maps design_spec_oa to a list of spaces
+    # Also create a map that maps each design_spec_oa name to design_spec_oa.
+    oa_spec_to_spaces = {}
+    oa_spec_hash = {}
+    model.getSpaces.each do |space|
+      oa_spec = space.designSpecificationOutdoorAir
+      if oa_spec.is_initialized
+        oa_spec = oa_spec.get
+        oa_spec_name = oa_spec.name.get
+        unless oa_spec_to_spaces.key?(oa_spec_name)
+          # init oa_spec_name associate zone name list.
+          oa_spec_to_spaces[oa_spec_name] = []
+        end
+        unless oa_spec_hash.key?(oa_spec_name)
+          # init the map of oa_spec_name to oa_spec object
+          oa_spec_hash[oa_spec_name] = oa_spec
+        end
+        oa_spec_to_spaces[oa_spec_name].push(space)
+      end
+    end
+
+    # Step 2: Loop the hash (oa_spec_name -> space_lists)
+    oa_spec_to_spaces.each do |oa_spec_name, space_list|
+      design_spec_oa = oa_spec_hash[oa_spec_name]
+      if design_spec_oa.additionalProperties.hasFeature('has_user_data')
+        outdoor_air_method = design_spec_oa.outdoorAirMethod
+
+        outdoor_airflow_per_person = get_additional_property_as_double(design_spec_oa, 'outdoor_airflow_per_person')
+        outdoor_airflow_per_floor_area = get_additional_property_as_double(design_spec_oa, 'outdoor_airflow_per_floor_area')
+        outdoor_air_flowrate = get_additional_property_as_double(design_spec_oa, 'outdoor_air_flowrate')
+        outdoor_air_flow_air_changes_per_hour = get_additional_property_as_double(design_spec_oa, 'outdoor_air_flow_air_changes_per_hour')
+
+        # Area SQL - TabularDataWithStrings -> InputVerificationResultsSummary -> Entire Facility -> Zone Summary -> Zone Name -> Area
+        total_modeled_area_oa = 0.0 # m2
+        total_user_area_oa = 0.0 # m2
+        total_modeled_people_oa = 0.0 # m3/s-person
+        total_user_people_oa = 0.0 # m3/s-person
+        total_modeled_airflow_oa = 0.0 # m3/s
+        total_user_airflow_oa = 0.0 # m3/s
+        total_modeled_ach_oa = 0.0 # ach
+        total_user_ach_oa = 0.0 # ach
+        space_list.each do |space|
+          floor_area = space.floorArea
+          volume = space.volume
+          number_people = space.numberOfPeople
+          total_modeled_area_oa += floor_area * design_spec_oa.outdoorAirFlowperFloorArea
+          total_user_area_oa += floor_area * outdoor_airflow_per_floor_area
+
+          total_modeled_people_oa += number_people * design_spec_oa.outdoorAirFlowperPerson
+          total_user_people_oa += number_people * outdoor_airflow_per_person
+
+          total_modeled_airflow_oa += design_spec_oa.outdoorAirFlowRate
+          total_user_airflow_oa += outdoor_air_flowrate
+          # convert to m3/s -> ach * volume / 3600
+          total_modeled_ach_oa += design_spec_oa.outdoorAirFlowAirChangesperHour * volume / 3600
+          total_user_ach_oa += outdoor_air_flow_air_changes_per_hour * volume / 3600
+        end
+
+        # calculate the amount of total outdoor air
+        if outdoor_air_method.casecmp('sum') == 0
+          total_modeled_airflow = total_modeled_area_oa + total_modeled_people_oa + total_modeled_airflow_oa + total_modeled_ach_oa
+          total_user_airflow = total_user_area_oa + total_user_people_oa + total_user_airflow_oa + total_user_ach_oa
+        elsif outdoor_air_method.casecmp('maximum') == 0
+          total_modeled_airflow = [total_modeled_area_oa, total_modeled_people_oa, total_modeled_airflow_oa, total_modeled_ach_oa].max
+          total_user_airflow = [total_user_area_oa, total_user_people_oa, total_user_airflow_oa, total_user_ach_oa].max
+        else
+          # No outdoor air method specified or match to the options available in OpenStudio
+          # Raise exception to flag the modeling error
+          error_msg = "DesignSpecification:OutdoorAir: #{design_spec_oa.name.get} is missing a method or the method is not one of the options {'Maximum', 'Sum'}."
+          OpenStudio.logFree(OpenStudio::Warn, 'prm.log', error_msg)
+          prm_raise(false,
+                    @sizing_run_dir,
+                    error_msg)
+        end
+
+        if total_modeled_airflow < total_user_airflow
+          # Do not modify the model outdoor air if the total user airflow is lower than total modeled airflow
+          OpenStudio.logFree(OpenStudio::Warn, 'prm.log', "The calculated total airflow for DesignSpecification:OutdoorAir is #{total_modeled_airflow} m3/s, which is smaller than the calculated user total airflow #{total_user_airflow} m3/s. Skip modifying the Outdoor Air.")
+        else
+          # set values.
+          design_spec_oa.setOutdoorAirFlowperFloorArea(outdoor_airflow_per_floor_area)
+          OpenStudio.logFree(OpenStudio::Info, 'prm.log', "Update DesignSpecification:OutdoorAir #{oa_spec_name} Outdoor Air Flow Per Floor Area to #{outdoor_airflow_per_floor_area} m3/s-m2.")
+          design_spec_oa.setOutdoorAirFlowperPerson(outdoor_airflow_per_person)
+          OpenStudio.logFree(OpenStudio::Info, 'prm.log', "Update DesignSpecification:OutdoorAir #{oa_spec_name} Outdoor Air Flow Per Person to #{outdoor_airflow_per_person} m3/s-person.")
+          design_spec_oa.setOutdoorAirFlowRate(outdoor_air_flowrate)
+          OpenStudio.logFree(OpenStudio::Info, 'prm.log', "Update DesignSpecification:OutdoorAir #{oa_spec_name} Outdoor Air Flow Rate to #{outdoor_air_flowrate} m3/s.")
+          design_spec_oa.setOutdoorAirFlowAirChangesperHour(outdoor_air_flow_air_changes_per_hour)
+          OpenStudio.logFree(OpenStudio::Info, 'prm.log', "Update DesignSpecification:OutdoorAir #{oa_spec_name} Outdoor Air ACH to #{outdoor_air_flow_air_changes_per_hour}.")
+        end
+      end
+    end
+  end
+end

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

@@ -2,4 +2,4 @@ class ASHRAE901PRM
   # @!group FanConstantVolume
 
   include ASHRAE901PRMFan
-  end
+end

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

@@ -2,4 +2,4 @@ class ASHRAE901PRM
   # @!group FanOnOff
 
   include ASHRAE901PRMFan
-  end
+end

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

@@ -6,7 +6,7 @@ class ASHRAE901PRM
   # Determines whether there is a requirement to have a VSD or some other method to reduce fan power at low part load ratios.
   # Required for all VAV fans for stable baseline
   # @param fan_variable_volume [OpenStudio::Model::FanVariableVolume] variable volume fan object
-  # @return [Bool] returns true if required, false if not
+  # @return [Boolean] returns true if required, false if not
   def fan_variable_volume_part_load_fan_power_limitation?(fan_variable_volume)
     part_load_control_required = true
     return part_load_control_required

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

@@ -48,7 +48,7 @@ class ASHRAE901PRM < Standard
   # Determine the required enthalpy recovery ratio (ERR)
   #
   # @param heat_exchanger_air_to_air_sensible_and_latent [OpenStudio::Model::HeatExchangerAirToAirSensibleAndLatent] OpenStudio heat exchanger object
-  # @return [Float] ERR
+  # @return [Double] enthalpy recovery ratio
   def heat_exchanger_air_to_air_sensible_and_latent_enthalpy_recovery_ratio(heat_exchanger_air_to_air_sensible_and_latent)
     return 0.5
   end