openstudio-standards 0.2.14 → 0.2.15.pre.rc1

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

@@ -1,9 +1,9 @@
 class Standard
   # @!group AirTerminalSingleDuctParallelPIUReheat
 
-  # Sets the fan power of a PIU fan based on the W/cfm
-  # specified in the standard.
+  # Sets the fan power of a PIU fan based on the W/cfm specified in the standard.
   #
+  # @param air_terminal_single_duct_parallel_piu_reheat [OpenStudio::Model::AirTerminalSingleDuctParallelPIUReheat] air terminal object
   # @return [Bool] returns true if successful, false if not
   def air_terminal_single_duct_parallel_piu_reheat_apply_prm_baseline_fan_power(air_terminal_single_duct_parallel_piu_reheat)
     OpenStudio.logFree(OpenStudio::Debug, 'openstudio.standards.AirTerminalSingleDuctParallelPIUReheat', "Setting PIU fan power for #{air_terminal_single_duct_parallel_piu_reheat.name}.")
@@ -32,7 +32,7 @@ class Standard
     max_sec_flow_rate_cfm = OpenStudio.convert(max_sec_flow_rate_m3_per_s, 'm^3/s', 'ft^3/min').get
 
     # Set the minimum flow fraction
-    # TODO Also compare to min OA requirement
+    # @todo Also compare to min OA requirement
     air_terminal_single_duct_parallel_piu_reheat.setMinimumPrimaryAirFlowFraction(min_flow_frac)
 
     # Get the fan

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

@@ -1,16 +1,16 @@
 class Standard
   # @!group AirTerminalSingleDuctVAVReheat
 
-  # Set the minimum damper position based on OA
-  # rate of the space and the template.
+  # Set the minimum damper position based on OA rate of the space and the template.
   # Zones with low OA per area get lower initial guesses.
-  # Final position will be adjusted upward
-  # as necessary by Standards.AirLoopHVAC.adjust_minimum_vav_damper_positions
+  # Final position will be adjusted upward as necessary by Standards.AirLoopHVAC.adjust_minimum_vav_damper_positions
+  #
+  # @param air_terminal_single_duct_vav_reheat [OpenStudio::Model::AirTerminalSingleDuctVAVReheat] the air terminal object
   # @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.
+  #   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,
-  # which impacts the minimum damper position requirement.
+  #   which impacts the minimum damper position requirement.
   # @return [Bool] 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)
@@ -33,34 +33,39 @@ class Standard
   # Specifies the minimum damper position for VAV dampers.
   # Defaults to 30%
   #
+  # @param air_terminal_single_duct_vav_reheat [OpenStudio::Model::AirTerminalSingleDuctVAVReheat] the air terminal object
   # @param has_ddc [Bool] whether or not there is DDC control of the VAV terminal in question
+  # @return [Double] minimum damper position
   def air_terminal_single_duct_vav_reheat_minimum_damper_position(air_terminal_single_duct_vav_reheat, has_ddc = false)
     min_damper_position = 0.3
     return min_damper_position
   end
 
-  # Sets the capacity of the reheat coil based on the minimum flow fraction,
-  # and the maximum flow rate.
+  # Sets the capacity of the reheat coil based on the minimum flow fraction, and the maximum flow rate.
+  #
+  # @param air_terminal_single_duct_vav_reheat [OpenStudio::Model::AirTerminalSingleDuctVAVReheat] the air terminal object
+  # @return [Bool] returns true if successful, false if not
   def air_terminal_single_duct_vav_reheat_set_heating_cap(air_terminal_single_duct_vav_reheat)
     flow_rate_fraction = 0.0
     if air_terminal_single_duct_vav_reheat.constantMinimumAirFlowFraction.is_initialized
       flow_rate_fraction = air_terminal_single_duct_vav_reheat.constantMinimumAirFlowFraction.get
     end
-    if air_terminal_single_duct_vav_reheat.reheatCoil.to_CoilHeatingWater.is_initialized
-      reheat_coil = air_terminal_single_duct_vav_reheat.reheatCoil.to_CoilHeatingWater.get
-      if reheat_coil.autosizedRatedCapacity.to_f < 1.0e-6
-        cap = 1.2 * 1000.0 * flow_rate_fraction * air_terminal_single_duct_vav_reheat.autosizedMaximumAirFlowRate.to_f * (18.0 - 13.0)
-        reheat_coil.setPerformanceInputMethod('NominalCapacity')
-        reheat_coil.setRatedCapacity(cap)
-        air_terminal_single_duct_vav_reheat.setMaximumReheatAirTemperature(18.0)
-      end
+    return false unless air_terminal_single_duct_vav_reheat.reheatCoil.to_CoilHeatingWater.is_initialized
+
+    reheat_coil = air_terminal_single_duct_vav_reheat.reheatCoil.to_CoilHeatingWater.get
+    if reheat_coil.autosizedRatedCapacity.to_f < 1.0e-6
+      cap = 1.2 * 1000.0 * flow_rate_fraction * air_terminal_single_duct_vav_reheat.autosizedMaximumAirFlowRate.to_f * (18.0 - 13.0)
+      reheat_coil.setPerformanceInputMethod('NominalCapacity')
+      reheat_coil.setRatedCapacity(cap)
+      air_terminal_single_duct_vav_reheat.setMaximumReheatAirTemperature(18.0)
     end
+    return true
   end
 
-  # Determines whether the terminal has a NaturalGas,
-  # Electricity, or HotWater reheat coil.
-  # @return [String] reheat type.  One of NaturalGas,
-  # Electricity, or HotWater.
+  # Determines whether the terminal has a NaturalGas, Electricity, or HotWater reheat coil.
+  #
+  # @param air_terminal_single_duct_vav_reheat [OpenStudio::Model::AirTerminalSingleDuctVAVReheat] the air terminal object
+  # @return [String] reheat type. One of NaturalGas, Electricity, or HotWater.
   def air_terminal_single_duct_vav_reheat_reheat_type(air_terminal_single_duct_vav_reheat)
     type = nil
 

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

@@ -3,6 +3,7 @@ class Standard
 
   # 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
@@ -35,6 +36,7 @@ class Standard
 
   # Find capacity in W
   #
+  # @param boiler_hot_water [OpenStudio::Model::BoilerHotWater] hot water boiler object
   # @return [Double] capacity in W
   def boiler_hot_water_find_capacity(boiler_hot_water)
     capacity_w = nil
@@ -53,6 +55,7 @@ class Standard
 
   # Finds lookup object in standards and return minimum thermal efficiency
   #
+  # @param boiler_hot_water [OpenStudio::Model::BoilerHotWater] hot water boiler object
   # @return [Double] minimum thermal efficiency
   def boiler_hot_water_standard_minimum_thermal_efficiency(boiler_hot_water, rename = false)
     # Get the boiler properties
@@ -108,8 +111,8 @@ class Standard
 
   # Applies the standard efficiency ratings and typical performance curves to this object.
   #
-  # @param boiler_hot_water [OpenStudio::Model::BoilerHotWater] the object to modify
-  # @return [Bool] true if successful, false if not
+  # @param boiler_hot_water [OpenStudio::Model::BoilerHotWater] hot water boiler object
+  # @return [Bool] returns true if successful, false if not
   def boiler_hot_water_apply_efficiency_and_curves(boiler_hot_water)
     successfully_set_all_properties = false
 

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

@@ -1,13 +1,11 @@
 class Standard
   # @!group BuildingStory
 
-  # Checks all spaces on this story that are part of the total
-  # floor area to see if they have the same multiplier.
-  # If they do, assume that the multipliers are being used
-  # as a floor multiplier.
+  # Checks all spaces on this story that are part of the total floor area to see if they have the same multiplier.
+  # If they do, assume that the multipliers are being used as a floor multiplier.
   #
-  # @return [Integer] return the floor multiplier for this story,
-  # returning 1 if no floor multiplier.
+  # @param building_story [OpenStudio::Model::BuildingStory] building story object
+  # @return [Integer] return the floor multiplier for this story, returning 1 if no floor multiplier.
   def building_story_floor_multiplier(building_story)
     floor_multiplier = 1
 
@@ -40,10 +38,10 @@ class Standard
   end
 
   # Gets the minimum z-value of the story.
-  # This is considered to be the minimum z value
-  # of any vertex of any surface of any space on the
-  # story, with the exception of plenum spaces.
+  # This is considered to be the minimum z value of any vertex of any surface of any space on the story,
+  # with the exception of plenum spaces.
   #
+  # @param building_story [OpenStudio::Model::BuildingStory] building story object
   # @return [Double] the minimum z-value, in m
   def building_story_minimum_z_value(building_story)
     z_heights = []

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

@@ -3,6 +3,7 @@ class Standard
 
   # 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 = {}
@@ -18,7 +19,7 @@ class Standard
 
     search_criteria['cooling_type'] = cooling_type
 
-    # TODO: Standards replace this with a mechanism to store this
+    # @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
@@ -53,6 +54,7 @@ class Standard
 
   # Finds capacity in W
   #
+  # @param chiller_electric_eir [OpenStudio::Model::ChillerElectricEIR] chiller object
   # @return [Double] capacity in W to be used for find object
   def chiller_electric_eir_find_capacity(chiller_electric_eir)
     if chiller_electric_eir.referenceCapacity.is_initialized
@@ -69,6 +71,7 @@ class Standard
 
   # Finds lookup object in standards and return full load efficiency
   #
+  # @param chiller_electric_eir [OpenStudio::Model::ChillerElectricEIR] chiller object
   # @return [Double] full load efficiency (COP)
   def chiller_electric_eir_standard_minimum_full_load_efficiency(chiller_electric_eir)
     # Get the chiller properties
@@ -93,7 +96,10 @@ class Standard
 
   # Applies the standard efficiency ratings and typical performance curves to this object.
   #
-  # @return [Bool] true if successful, false if not
+  # @param chiller_electric_eir [OpenStudio::Model::ChillerElectricEIR] chiller object
+  # @param clg_tower_objs [Array] cooling towers, currently unused
+  # @return [Bool] returns true if successful, false if not
+  # @todo remove clg_tower_objs parameter if unused
   def chiller_electric_eir_apply_efficiency_and_curves(chiller_electric_eir, clg_tower_objs)
     chillers = standards_data['chillers']
 

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

@@ -3,7 +3,9 @@ class Standard
 
   # Applies the standard efficiency ratings and typical performance curves to this object.
   #
-  # @return [Bool] true if successful, false if not
+  # @param coil_cooling_dx_multi_speed [OpenStudio::Model::CoilCoolingDXMultiSpeed] coil cooling dx multi speed object
+  # @param sql_db_vars_map [Hash] hash map
+  # @return [Hash] hash of coil objects
   def coil_cooling_dx_multi_speed_apply_efficiency_and_curves(coil_cooling_dx_multi_speed, sql_db_vars_map)
     successfully_set_all_properties = true
 
@@ -14,7 +16,7 @@ class Standard
     cooling_type = coil_cooling_dx_multi_speed.condenserType
     search_criteria['cooling_type'] = cooling_type
 
-    # TODO: Standards - add split system vs single package to model
+    # @todo Standards - add split system vs single package to model
     # For now, assume single package as default
     sub_category = 'Single Package'
 
@@ -33,7 +35,7 @@ class Standard
           elsif htg_coil.to_CoilHeatingGasMultiStage.is_initialized
             heating_type = 'All Other'
           end
-          # TODO: Add other unitary systems
+          # @todo Add other unitary systems
         end
       elsif coil_cooling_dx_multi_speed.containingZoneHVACComponent.is_initialized
         containing_comp = coil_cooling_dx_multi_speed.containingZoneHVACComponent.get
@@ -45,7 +47,7 @@ class Standard
           elsif htg_coil.to_CoilHeatingWater.is_initialized || htg_coil.to_CoilHeatingGas.is_initialized || htg_col.to_CoilHeatingGasMultiStage
             heating_type = 'All Other'
           end
-          # TODO: Add other zone hvac systems
+          # @todo Add other zone hvac systems
         end
       end
     end
@@ -217,6 +219,7 @@ class Standard
 
   # Finds capacity in W
   #
+  # @param coil_cooling_dx_multi_speed [OpenStudio::Model::CoilCoolingDXMultiSpeed] coil cooling dx multi speed object
   # @return [Double] capacity in W to be used for find object
   def coil_cooling_dx_multi_speed_find_capacity(coil_cooling_dx_multi_speed)
     capacity_w = nil
@@ -242,8 +245,9 @@ class Standard
 
   # Finds lookup object in standards and return efficiency
   #
-  # @param rename [Bool] if true, object will be renamed to include capacity and efficiency level
-  # @return [Double] full load efficiency (COP)
+  # @param coil_cooling_dx_multi_speed [OpenStudio::Model::CoilCoolingDXMultiSpeed] coil cooling dx multi speed object
+  # @return [Array] array of full load efficiency (COP), new object name
+  # @todo align the method arguments and return types
   def coil_cooling_dx_multi_speed_standard_minimum_cop(coil_cooling_dx_multi_speed)
     search_criteria = coil_dx_find_search_criteria(coil_cooling_dx_multi_speed)
     cooling_type = search_criteria['cooling_type']

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

@@ -5,6 +5,7 @@ class Standard
 
   # Finds capacity in W
   #
+  # @param coil_cooling_dx_single_speed [OpenStudio::Model::CoilCoolingDXSingleSpeed] coil cooling dx single speed object
   # @return [Double] capacity in W to be used for find object
   def coil_cooling_dx_single_speed_find_capacity(coil_cooling_dx_single_speed)
     capacity_w = nil
@@ -39,6 +40,7 @@ class Standard
 
   # Finds lookup object in standards and return efficiency
   #
+  # @param coil_cooling_dx_single_speed [OpenStudio::Model::CoilCoolingDXSingleSpeed] coil cooling dx single speed object
   # @param rename [Bool] 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, rename = false)
@@ -167,7 +169,9 @@ class Standard
 
   # Applies the standard efficiency ratings and typical performance curves to this object.
   #
-  # @return [Bool] true if successful, false if not
+  # @param coil_cooling_dx_single_speed [OpenStudio::Model::CoilCoolingDXSingleSpeed] coil cooling dx single speed object
+  # @param sql_db_vars_map [Hash] hash map
+  # @return [Hash] hash of coil objects
   def coil_cooling_dx_single_speed_apply_efficiency_and_curves(coil_cooling_dx_single_speed, sql_db_vars_map)
     successfully_set_all_properties = true
 

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

@@ -5,6 +5,7 @@ class Standard
 
   # Finds capacity in W
   #
+  # @param coil_cooling_dx_two_speed [OpenStudio::Model::CoilCoolingDXTwoSpeed] coil cooling dx two speed object
   # @return [Double] capacity in W to be used for find object
   def coil_cooling_dx_two_speed_find_capacity(coil_cooling_dx_two_speed)
     capacity_w = nil
@@ -22,6 +23,8 @@ class Standard
 
   # Finds lookup object in standards and return efficiency
   #
+  # @param coil_cooling_dx_two_speed [OpenStudio::Model::CoilCoolingDXTwoSpeed] coil cooling dx two speed object
+  # @param rename [Bool] 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, rename = false)
     search_criteria = coil_dx_find_search_criteria(coil_cooling_dx_two_speed)
@@ -98,7 +101,9 @@ class Standard
 
   # Applies the standard efficiency ratings and typical performance curves to this object.
   #
-  # @return [Bool] true if successful, false if not
+  # @param coil_cooling_dx_two_speed [OpenStudio::Model::CoilCoolingDXTwoSpeed] coil cooling dx two speed object
+  # @param sql_db_vars_map [Hash] hash map
+  # @return [Hash] hash of coil objects
   def coil_cooling_dx_two_speed_apply_efficiency_and_curves(coil_cooling_dx_two_speed, sql_db_vars_map)
     successfully_set_all_properties = true
 

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

@@ -3,6 +3,7 @@ class Standard
 
   # Finds capacity in W
   #
+  # @param coil_cooling_water_to_air_heat_pump [OpenStudio::Model::CoilCoolingWaterToAirHeatPumpEquationFit] coil cooling object
   # @return [Double] capacity in W to be used for find object
   def coil_cooling_water_to_air_heat_pump_find_capacity(coil_cooling_water_to_air_heat_pump)
     capacity_w = nil
@@ -20,17 +21,32 @@ class Standard
 
   # Finds lookup object in standards and return efficiency
   #
+  # @param coil_cooling_water_to_air_heat_pump [OpenStudio::Model::CoilCoolingWaterToAirHeatPumpEquationFit] coil cooling object
   # @param rename [Bool] if true, object will be renamed to include capacity and efficiency level
   # @return [Double] full load efficiency (COP)
-  def coil_cooling_water_to_air_heat_pump_standard_minimum_cop(coil_cooling_water_to_air_heat_pump, rename = false)
+  def coil_cooling_water_to_air_heat_pump_standard_minimum_cop(coil_cooling_water_to_air_heat_pump, rename = false, computer_room_air_conditioner = false)
     search_criteria = {}
     search_criteria['template'] = template
+    if computer_room_air_conditioner
+      search_criteria['cooling_type'] = 'WaterCooled'
+      search_criteria['heating_type'] = 'All Other'
+      search_criteria['subcategory'] = 'CRAC'
+      cooling_type = search_criteria['cooling_type']
+      heating_type = search_criteria['heating_type']
+      sub_category = search_criteria['subcategory']
+    end
     capacity_w = coil_cooling_water_to_air_heat_pump_find_capacity(coil_cooling_water_to_air_heat_pump)
     capacity_btu_per_hr = OpenStudio.convert(capacity_w, 'W', 'Btu/hr').get
     capacity_kbtu_per_hr = OpenStudio.convert(capacity_w, 'W', 'kBtu/hr').get
+    return nil unless capacity_kbtu_per_hr > 0.0
 
     # Look up the efficiency characteristics
-    coil_props = model_find_object(standards_data['water_source_heat_pumps'], search_criteria, capacity_btu_per_hr, Date.today)
+    if computer_room_air_conditioner
+      equipment_type = 'unitary_acs'
+    else
+      equipment_type = 'water_source_heat_pumps'
+    end
+    coil_props = model_find_object(standards_data[equipment_type], search_criteria, capacity_btu_per_hr, Date.today)
 
     # Check to make sure properties were found
     if coil_props.nil?
@@ -50,6 +66,29 @@ class Standard
       OpenStudio.logFree(OpenStudio::Info, 'openstudio.standards.CoilCoolingWaterToAirHeatPumpEquationFit', "For #{template}: #{coil_cooling_water_to_air_heat_pump.name}: Capacity = #{capacity_kbtu_per_hr.round}kBtu/hr; EER = #{min_eer}")
     end
 
+    # If specified as SCOP (water-cooled Computer Room Air Conditioned (CRAC))
+    if computer_room_air_conditioner
+      crac_minimum_scop = coil_props['minimum_scop']
+      unless crac_minimum_scop.nil?
+        # cop = scop / sensible heat ratio
+        # sensible heat ratio = sensible cool capacity / total cool capacity
+        if coil_cooling_water_to_air_heat_pump.ratedSensibleCoolingCapacity.is_initialized
+          crac_sensible_cool = coil_cooling_water_to_air_heat_pump.ratedSensibleCoolingCapacity.get
+          crac_total_cool = coil_cooling_water_to_air_heat_pump.ratedTotalCoolingCapacity.get
+          crac_sensible_cool_ratio = crac_sensible_cool / crac_total_cool
+        elsif coil_cooling_water_to_air_heat_pump.autosizedRatedSensibleCoolingCapacity.is_initialized
+          crac_sensible_cool = coil_cooling_water_to_air_heat_pump.autosizedRatedSensibleCoolingCapacity.get
+          crac_total_cool = coil_cooling_water_to_air_heat_pump.autosizedRatedTotalCoolingCapacity.get
+          crac_sensible_heat_ratio = crac_sensible_cool / crac_total_cool
+        else
+          OpenStudio.logFree(OpenStudio::Error, 'openstudio.standards.CoilCoolingWaterToAirHeatPumpEquationFit', 'Failed to get autosized sensible cool capacity')
+        end
+        cop = crac_minimum_scop / crac_sensible_heat_ratio
+        cop = cop.round(2)
+        OpenStudio.logFree(OpenStudio::Info, 'openstudio.standards.CoilCoolingWaterToAirHeatPumpEquationFit', "For #{coil_cooling_water_to_air_heat_pump.name}: #{cooling_type} #{heating_type} #{sub_category} Capacity = #{capacity_kbtu_per_hr.round}kBtu/hr; SCOP = #{crac_minimum_scop}")
+      end
+    end
+
     # Rename
     if rename
       coil_cooling_water_to_air_heat_pump.setName(new_comp_name)
@@ -60,7 +99,9 @@ class Standard
 
   # Applies the standard efficiency ratings and typical performance curves to this object.
   #
-  # @return [Bool] true if successful, false if not
+  # @param coil_cooling_water_to_air_heat_pump [OpenStudio::Model::CoilCoolingWaterToAirHeatPumpEquationFit] coil cooling object
+  # @param sql_db_vars_map [Hash] hash map
+  # @return [Hash] hash of coil objects
   def coil_cooling_water_to_air_heat_pump_apply_efficiency_and_curves(coil_cooling_water_to_air_heat_pump, sql_db_vars_map)
     successfully_set_all_properties = true
 
@@ -80,7 +121,7 @@ class Standard
       return sql_db_vars_map
     end
 
-    # TODO: Add methods to set coefficients, and add coefficients to data spreadsheet
+    # @todo Add methods to set coefficients, and add coefficients to data spreadsheet
     # using OS defaults for now
     # tot_cool_cap_coeff1 = coil_props['tot_cool_cap_coeff1']
     # if tot_cool_cap_coeff1

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

@@ -7,6 +7,8 @@ module CoilDX
   # Finds the subcategory.  Possible choices are:
   # Single Package, Split System, PTAC, or PTHP
   #
+  # @param coil_dx [OpenStudio::Model::StraightComponent] coil cooling object, allowable types:
+  #   CoilCoolingDXSingleSpeed, CoilCoolingDXTwoSpeed, CoilCoolingDXMultiSpeed
   # @return [String] the coil_dx_subcategory(coil_dx)
   # @todo Add add split system vs single package to model object
   def coil_dx_subcategory(coil_dx)
@@ -35,7 +37,7 @@ module CoilDX
         elsif containing_comp.to_ZoneHVACPackagedTerminalHeatPump.is_initialized
           sub_category = 'PTHP'
         end
-        # TODO: Add other zone hvac systems
+        # @todo Add other zone hvac systems
       end
     end
 
@@ -43,7 +45,10 @@ module CoilDX
   end
 
   # Determine if it is a heat pump
-  # @return [Bool] true if it is a heat pump, false if not
+  #
+  # @param coil_dx [OpenStudio::Model::StraightComponent] coil cooling object, allowable types:
+  #   CoilCoolingDXSingleSpeed, CoilCoolingDXTwoSpeed, CoilCoolingDXMultiSpeed
+  # @return [Bool] returns true if it is a heat pump, false if not
   def coil_dx_heat_pump?(coil_dx)
     heat_pump = false
 
@@ -62,7 +67,7 @@ module CoilDX
         if containing_comp.to_ZoneHVACPackagedTerminalHeatPump.is_initialized
           heat_pump = true
         end
-        # TODO: Add other zone hvac systems
+        # @todo Add other zone hvac systems
       end
     else
       if !coil_dx.airLoopHVAC.get.supplyComponents('OS:Coil:Heating:DX:SingleSpeed'.to_IddObjectType).empty? ||
@@ -74,8 +79,11 @@ module CoilDX
     return heat_pump
   end
 
-  # Determine the heating type.  Possible choices are:
-  # Electric Resistance or None, All Other
+  # Determine the heating type.
+  # Possible choices are: Electric Resistance or None, All Other
+  #
+  # @param coil_dx [OpenStudio::Model::StraightComponent] coil cooling object, allowable types:
+  #   CoilCoolingDXSingleSpeed, CoilCoolingDXTwoSpeed, CoilCoolingDXMultiSpeed
   # @return [String] the heating type
   def coil_dx_heating_type(coil_dx)
     htg_type = nil
@@ -99,7 +107,7 @@ module CoilDX
             htg_type = 'All Other'
           end
         end
-        # TODO: Add other unitary systems
+        # @todo Add other unitary systems
       elsif coil_dx.containingZoneHVACComponent.is_initialized
         containing_comp = coil_dx.containingZoneHVACComponent.get
         # PTAC
@@ -114,7 +122,7 @@ module CoilDX
         elsif containing_comp.to_ZoneHVACPackagedTerminalHeatPump.is_initialized
           htg_type = 'Electric Resistance or None'
         end
-        # TODO: Add other zone hvac systems
+        # @todo Add other zone hvac systems
       end
     end
 
@@ -149,6 +157,8 @@ module CoilDX
 
   # Finds the search criteria
   #
+  # @param coil_dx [OpenStudio::Model::StraightComponent] coil cooling object, allowable types:
+  #   CoilCoolingDXSingleSpeed, CoilCoolingDXTwoSpeed, CoilCoolingDXMultiSpeed
   # @return [hash] has for search criteria to be used for find object
   def coil_dx_find_search_criteria(coil_dx)
     search_criteria = {}
@@ -184,7 +194,7 @@ module CoilDX
             if containing_comp.to_AirLoopHVACUnitaryHeatPumpAirToAir.is_initialized
               search_criteria['heating_type'] = nil
             end
-            # TODO: Add other unitary systems
+            # @todo Add other unitary systems
           end
         end
       end

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

@@ -3,7 +3,8 @@ class Standard
 
   # Applies the standard efficiency ratings and typical performance curves to this object.
   #
-  # @return [Bool] true if successful, false if not
+  # @param coil_heating_dx_multi_speed [OpenStudio::Model::CoilHeatingDXMultiSpeed] coil heating dx multi speed object
+  # @return [Bool] returns true if successful, false if not
   def coil_heating_dx_multi_speed_apply_efficiency_and_curves(coil_heating_dx_multi_speed, sql_db_vars_map)
     successfully_set_all_properties = true
 
@@ -27,11 +28,11 @@ class Standard
                                  'All Other'
                                end
         end
-        # TODO: Add other unitary systems
+        # @todo Add other unitary systems
       end
     end
 
-    # TODO: Standards - add split system vs single package to model
+    # @todo Standards - add split system vs single package to model
     # For now, assume single package
     subcategory = 'Single Package'
     search_criteria['subcategory'] = subcategory
@@ -178,10 +179,11 @@ class Standard
     end
 
     # Set the efficiency values
-    unless cop.nil?
-      htg_stages.each do |istage|
-        istage.setGrossRatedHeatingCOP(cop)
-      end
+    return false if cop.nil?
+
+    htg_stages.each do |istage|
+      istage.setGrossRatedHeatingCOP(cop)
     end
+    return true
   end
 end

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

@@ -3,9 +3,9 @@ class Standard
 
   include CoilDX
 
-  # Finds capacity in W.  This is the cooling capacity of the
-  # paired DX cooling coil.
+  # Finds capacity in W.  This is the cooling capacity of the paired DX cooling coil.
   #
+  # @param coil_heating_dx_single_speed [OpenStudio::Model::CoilHeatingDXSingleSpeed] coil heating dx single speed object
   # @return [Double] capacity in W to be used for find object
   def coil_heating_dx_single_speed_find_capacity(coil_heating_dx_single_speed)
     capacity_w = nil
@@ -25,7 +25,7 @@ class Standard
             clg_coil = unitary.coolingCoil.get
           end
         end
-        # TODO: Add other unitary systems
+        # @todo Add other unitary systems
       elsif coil_heating_dx_single_speed.containingZoneHVACComponent.is_initialized
         containing_comp = coil_heating_dx_single_speed.containingZoneHVACComponent.get
         # PTHP
@@ -102,6 +102,8 @@ class Standard
 
   # Finds lookup object in standards and return efficiency
   #
+  # @param coil_heating_dx_single_speed [OpenStudio::Model::CoilHeatingDXSingleSpeed] coil heating dx single speed object
+  # @param rename [Bool] 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, rename = false)
     # find ac properties
@@ -175,7 +177,9 @@ class Standard
 
   # Applies the standard efficiency ratings and typical performance curves to this object.
   #
-  # @return [Bool] true if successful, false if not
+  # @param coil_heating_dx_single_speed [OpenStudio::Model::CoilHeatingDXSingleSpeed] coil heating dx single speed object
+  # @param sql_db_vars_map [Hash] hash map
+  # @return [Hash] hash of coil objects
   def coil_heating_dx_single_speed_apply_efficiency_and_curves(coil_heating_dx_single_speed, sql_db_vars_map)
     successfully_set_all_properties = true