openstudio-standards 0.2.14 → 0.2.15.pre.rc1

data/lib/openstudio-standards/hvac_sizing/Siz.ZoneHVACTerminalUnitVariableRefrigerantFlow.rb

@@ -83,7 +83,7 @@ class OpenStudio::Model::ZoneHVACTerminalUnitVariableRefrigerantFlow
   end
   
   
-  # Todo: verify on a fully autosize model that these three are actually named this way in the SQL file
+  # @todo verify on a fully autosize model that these three are actually named this way in the SQL file
   
   # Outdoor Air Flow Rate During Cooling Operation
   def autosizedOutdoorAirFlowRateDuringCoolingOperation

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2004/ashrae_90_1_2004.AirTerminalSingleDuctVAVReheat.rb

@@ -4,7 +4,8 @@ class ASHRAE9012004 < ASHRAE901
   # Zones with low OA per area get lower initial guesses.
   # Final position will be adjusted upward as necessary by Standards.AirLoopHVAC.apply_minimum_vav_damper_positions
   #
-  # @param zone_oa_per_area [Double] the zone outdoor air per area, m^3/s
+  # @param air_terminal_single_duct_vav_reheat [OpenStudio::Model::AirTerminalSingleDuctVAVReheat] the air terminal object
+  # @param zone_oa_per_area [Double] the zone outdoor air per area in m^3/s*m^2
   # @return [Bool] returns true if successful, false if not
   def air_terminal_single_duct_vav_reheat_apply_initial_prototype_damper_position(air_terminal_single_duct_vav_reheat, zone_oa_per_area)
     min_damper_position = 0.3

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2004/ashrae_90_1_2004.PumpVariableSpeed.rb

@@ -2,8 +2,8 @@ class ASHRAE9012004 < ASHRAE901
   # @!group Pump
 
   # Determine type of pump part load control type
+  # @note code_sections [90.1-2004_6.5.4.1]
   #
-  # @code_sections [90.1-2004_6.5.4.1]
   # @param pump [OpenStudio::Model::PumpVariableSpeed] OpenStudio pump object
   # @param plant_loop_type [String] Type of plant loop
   # @param pump_nominal_hp [Float] Pump nominal horsepower
@@ -19,10 +19,9 @@ class ASHRAE9012004 < ASHRAE901
     # Get pump head in Pa
     pump_head_pa = pump.ratedPumpHead
 
-    if pump_nominal_hp * design_sizing_factor > threshold && pump_head_pa > 300_000 # 100 ft. of head
-      return 'VSD No Reset'
-    else
-      return 'Riding Curve'
-    end
-  end
+    return 'VSD No Reset' if pump_nominal_hp * design_sizing_factor > threshold && pump_head_pa > 300_000 # 100 ft. of head
+
+    # else
+    return 'Riding Curve'
   end
+end

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2007/ashrae_90_1_2007.AirTerminalSingleDuctVAVReheat.rb

@@ -4,7 +4,8 @@ class ASHRAE9012007 < ASHRAE901
   # Zones with low OA per area get lower initial guesses.
   # Final position will be adjusted upward as necessary by Standards.AirLoopHVAC.apply_minimum_vav_damper_positions
   #
-  # @param zone_oa_per_area [Double] the zone outdoor air per area, m^3/s
+  # @param air_terminal_single_duct_vav_reheat [OpenStudio::Model::AirTerminalSingleDuctVAVReheat] the air terminal object
+  # @param zone_oa_per_area [Double] the zone outdoor air per area in m^3/s*m^2
   # @return [Bool] returns true if successful, false if not
   def air_terminal_single_duct_vav_reheat_apply_initial_prototype_damper_position(air_terminal_single_duct_vav_reheat, zone_oa_per_area)
     min_damper_position = 0.3

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2007/ashrae_90_1_2007.FanConstantVolume.rb

@@ -1,10 +1,11 @@
 class ASHRAE9012007 < ASHRAE901
   # @!group FanConstantVolume
 
-  # Determine the prototype fan pressure rise for a constant volume
-  # fan on an AirLoopHVAC based on the airflow of the system.
-  # @return [Double] the pressure rise (in H2O).  Defaults
-  # to the logic from ASHRAE 90.1-2004 prototypes.
+  # Determine the prototype fan pressure rise for a constant volume fan on an AirLoopHVAC based on system airflow.
+  # Defaults to the logic from ASHRAE 90.1-2004 prototypes.
+  #
+  # @param fan_constant_volume [OpenStudio::Model::FanConstantVolume] constant volume fan object
+  # @return [Double] pressure rise in inches H20
   def fan_constant_volume_airloop_fan_pressure_rise(fan_constant_volume)
     # Get the max flow rate from the fan.
     maximum_flow_rate_m3_per_s = nil

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2007/ashrae_90_1_2007.FanOnOff.rb

@@ -1,11 +1,11 @@
 class ASHRAE9012007 < ASHRAE901
   # @!group FanOnOff
 
-  # Determine the prototype fan pressure rise for an on off
-  # fan on an AirLoopHVAC or inside a unitary system
-  # based on the airflow of the system.
-  # @return [Double] the pressure rise (in H2O).  Defaults
-  # to the logic from ASHRAE 90.1-2004 prototypes.
+  # Determine the prototype fan pressure rise for an on off fan on an AirLoopHVAC or inside a unitary system based on system airflow.
+  # Defaults to the logic from ASHRAE 90.1-2004 prototypes.
+  #
+  # @param fan_on_off [OpenStudio::Model::FanOnOff] on off fan object
+  # @return [Double] pressure rise in inches H20
   def fan_on_off_airloop_or_unitary_fan_pressure_rise(fan_on_off)
     # Get the max flow rate from the fan.
     maximum_flow_rate_m3_per_s = nil

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2007/ashrae_90_1_2007.FanVariableVolume.rb

@@ -1,10 +1,11 @@
 class ASHRAE9012007 < ASHRAE901
   # @!group FanVariableVolume
 
-  # Determine the prototype fan pressure rise for a variable volume
-  # fan on an AirLoopHVAC based on the airflow of the system.
-  # @return [Double] the pressure rise (in H2O).  Defaults
-  # to the logic from ASHRAE 90.1-2004 prototypes.
+  # Determine the prototype fan pressure rise for a variable volume fan on an AirLoopHVAC based on system airflow.
+  # Defaults to the logic from ASHRAE 90.1-2004 prototypes.
+  #
+  # @param fan_variable_volume [OpenStudio::Model::FanVariableVolume] variable volume fan object
+  # @return [Double] pressure rise in inches H20
   def fan_variable_volume_airloop_fan_pressure_rise(fan_variable_volume)
     # Get the max flow rate from the fan.
     maximum_flow_rate_m3_per_s = nil

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2007/ashrae_90_1_2007.PumpVariableSpeed.rb

@@ -2,8 +2,8 @@ class ASHRAE9012007 < ASHRAE901
   # @!group Pump
 
   # Determine type of pump part load control type
+  # @note code_sections [90.1-2007_6.5.4.1]
   #
-  # @code_sections [90.1-2007_6.5.4.1]
   # @param pump [OpenStudio::Model::PumpVariableSpeed] OpenStudio pump object
   # @param plant_loop_type [String] Type of plant loop
   # @param pump_nominal_hp [Float] Pump nominal horsepower
@@ -19,10 +19,9 @@ class ASHRAE9012007 < ASHRAE901
     # Get pump head in Pa
     pump_head_pa = pump.ratedPumpHead
 
-    if pump_nominal_hp * design_sizing_factor > threshold && pump_head_pa > 300_000 # 100 ft. of head
-      return 'VSD No Reset'
-    else
-      return 'Riding Curve'
-    end
-  end
+    return 'VSD No Reset' if pump_nominal_hp * design_sizing_factor > threshold && pump_head_pa > 300_000 # 100 ft. of head
+
+    # else
+    return 'Riding Curve'
   end
+end

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2010/ashrae_90_1_2010.AirTerminalSingleDuctVAVReheat.rb

@@ -4,7 +4,8 @@ class ASHRAE9012010 < ASHRAE901
   # Zones with low OA per area get lower initial guesses.
   # Final position will be adjusted upward as necessary by Standards.AirLoopHVAC.apply_minimum_vav_damper_positions
   #
-  # @param zone_oa_per_area [Double] the zone outdoor air per area, m^3/s
+  # @param air_terminal_single_duct_vav_reheat [OpenStudio::Model::AirTerminalSingleDuctVAVReheat] the air terminal object
+  # @param zone_oa_per_area [Double] the zone outdoor air per area in m^3/s*m^2
   # @return [Bool] returns true if successful, false if not
   def air_terminal_single_duct_vav_reheat_apply_initial_prototype_damper_position(air_terminal_single_duct_vav_reheat, zone_oa_per_area)
     min_damper_position = case air_terminal_single_duct_vav_reheat_reheat_type(air_terminal_single_duct_vav_reheat)

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2010/ashrae_90_1_2010.FanConstantVolume.rb

@@ -1,10 +1,11 @@
 class ASHRAE9012010 < ASHRAE901
   # @!group FanConstantVolume
 
-  # Determine the prototype fan pressure rise for a constant volume
-  # fan on an AirLoopHVAC based on the airflow of the system.
-  # @return [Double] the pressure rise (in H2O).  Defaults
-  # to the logic from ASHRAE 90.1-2004 prototypes.
+  # Determine the prototype fan pressure rise for a constant volume fan on an AirLoopHVAC based on system airflow.
+  # Defaults to the logic from ASHRAE 90.1-2004 prototypes.
+  #
+  # @param fan_constant_volume [OpenStudio::Model::FanConstantVolume] constant volume fan object
+  # @return [Double] pressure rise in inches H20
   def fan_constant_volume_airloop_fan_pressure_rise(fan_constant_volume)
     # Get the max flow rate from the fan.
     maximum_flow_rate_m3_per_s = nil

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2010/ashrae_90_1_2010.FanOnOff.rb

@@ -1,11 +1,11 @@
 class ASHRAE9012010 < ASHRAE901
   # @!group FanOnOff
 
-  # Determine the prototype fan pressure rise for an on off
-  # fan on an AirLoopHVAC or inside a unitary system
-  # based on the airflow of the system.
-  # @return [Double] the pressure rise (in H2O).  Defaults
-  # to the logic from ASHRAE 90.1-2004 prototypes.
+  # Determine the prototype fan pressure rise for an on off fan on an AirLoopHVAC or inside a unitary system based on system airflow.
+  # Defaults to the logic from ASHRAE 90.1-2004 prototypes.
+  #
+  # @param fan_on_off [OpenStudio::Model::FanOnOff] on off fan object
+  # @return [Double] pressure rise in inches H20
   def fan_on_off_airloop_or_unitary_fan_pressure_rise(fan_on_off)
     # Get the max flow rate from the fan.
     maximum_flow_rate_m3_per_s = nil

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2010/ashrae_90_1_2010.FanVariableVolume.rb

@@ -1,10 +1,11 @@
 class ASHRAE9012010 < ASHRAE901
   # @!group FanVariableVolume
 
-  # Determine the prototype fan pressure rise for a variable volume
-  # fan on an AirLoopHVAC based on the airflow of the system.
-  # @return [Double] the pressure rise (in H2O).  Defaults
-  # to the logic from ASHRAE 90.1-2004 prototypes.
+  # Determine the prototype fan pressure rise for a variable volume fan on an AirLoopHVAC based on system airflow.
+  # Defaults to the logic from ASHRAE 90.1-2004 prototypes.
+  #
+  # @param fan_variable_volume [OpenStudio::Model::FanVariableVolume] variable volume fan object
+  # @return [Double] pressure rise in inches H20
   def fan_variable_volume_airloop_fan_pressure_rise(fan_variable_volume)
     # Get the max flow rate from the fan.
     maximum_flow_rate_m3_per_s = nil

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2010/ashrae_90_1_2010.Model.elevators.rb

@@ -1,10 +1,12 @@
 class ASHRAE9012010 < ASHRAE901
   # @!group elevators
 
-  # Determines the percentage of the elevator cab
-  # lighting that is incandescent.  The remainder
-  # is assumed to be LED.  Defaults to 0% incandescent
-  # (100% LED), representing newer elevators.
+  # Determines the percentage of the elevator cab lighting that is incandescent.
+  # The remainder is assumed to be LED.
+  # Defaults to 0% incandescent (100% LED), representing newer elevators.
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [Double] incandescent lighting percentage
   def model_elevator_lighting_pct_incandescent(model)
     pct_incandescent = 0.0 # 100% LED
     return pct_incandescent

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2010/ashrae_90_1_2010.Model.rb

@@ -4,7 +4,7 @@ class ASHRAE9012010 < ASHRAE901
   # Determine the prototypical economizer type for the model.
   #
   # @param model [OpenStudio::Model::Model] the model
-  # @param climate_zone [String] the climate zone
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
   # @return [String] the economizer type.  Possible values are:
   # 'NoEconomizer'
   # 'FixedDryBulb'
@@ -34,9 +34,10 @@ class ASHRAE9012010 < ASHRAE901
   end
 
   # Adjust model to comply with fenestration orientation requirements
+  # @note code_sections [90.1-2010_5.5.4.5]
   #
-  # @code_sections [90.1-2010_5.5.4.5]
-  # @param [OpenStudio::Model::Model] OpenStudio model object
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
   # @return [Boolean] Returns true if successful, false otherwise
   def model_fenestration_orientation(model, climate_zone)
     wwr = false
@@ -51,10 +52,10 @@ class ASHRAE9012010 < ASHRAE901
         building_type = model.getBuilding.standardsBuildingType.get
 
         case building_type
-          # TODO: Implementatation for other building types not meeting the requirement
-          # The offices, schools, warehouse (exempted), large hotel, outpatient,
-          # retails, apartments should meet the requirement according to Section
-          # 5.2.1.7 in Thornton et al. 2011
+          # @todo Implementatation for other building types not meeting the requirement
+          #   The offices, schools, warehouse (exempted), large hotel, outpatient,
+          #   retails, apartments should meet the requirement according to Section
+          #   5.2.1.7 in Thornton et al. 2011
           when 'Hospital'
             # Rotate the building counter-clockwise
             model_set_building_north_axis(model, 270.0)
@@ -73,12 +74,12 @@ class ASHRAE9012010 < ASHRAE901
   end
 
   # Is transfer air required?
+  # @note code_sections [90.1-2010_6.5.7.1.2]
   #
-  # @code_sections [90.1-2010_6.5.7.1.2]
   # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @return [Boolean] true if transfer air is required, false otherwise
   def model_transfer_air_required?(model)
-    # TODO: It actually is for kitchen but not implemented yet
+    # @todo It actually is for kitchen but not implemented yet
     return false
   end
 end

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2010/ashrae_90_1_2010.PumpVariableSpeed.rb

@@ -2,8 +2,8 @@ class ASHRAE9012010 < ASHRAE901
   # @!group Pump
 
   # Determine type of pump part load control type
+  # @note code_sections [90.1-2010_6.5.4.1]
   #
-  # @code_sections [90.1-2010_6.5.4.1]
   # @param pump [OpenStudio::Model::PumpVariableSpeed] OpenStudio pump object
   # @param plant_loop_type [String] Type of plant loop
   # @param pump_nominal_hp [Float] Pump nominal horsepower
@@ -16,14 +16,12 @@ class ASHRAE9012010 < ASHRAE901
     # increase and ~10% flow increase.
     design_sizing_factor = 1.25
 
-    if plant_loop_type == 'Heating'
-      return 'Riding Curve'
-    else
-      if pump_nominal_hp * design_sizing_factor > threshold
-        return 'VSD DP Reset' # Requirement only applies to CHW pumps
-      else
-        return 'Riding Curve'
-      end
-    end
-  end
+    return 'Riding Curve' if plant_loop_type == 'Heating'
+
+    # Requirement only applies to CHW pumps
+    return 'VSD DP Reset' if pump_nominal_hp * design_sizing_factor > threshold
+
+    # else
+    return 'Riding Curve'
   end
+end

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2013/ashrae_90_1_2013.AirTerminalSingleDuctVAVReheat.rb

@@ -4,7 +4,8 @@ class ASHRAE9012013 < ASHRAE901
   # Zones with low OA per area get lower initial guesses.
   # Final position will be adjusted upward as necessary by Standards.AirLoopHVAC.apply_minimum_vav_damper_positions
   #
-  # @param zone_oa_per_area [Double] the zone outdoor air per area, m^3/s
+  # @param air_terminal_single_duct_vav_reheat [OpenStudio::Model::AirTerminalSingleDuctVAVReheat] the air terminal object
+  # @param zone_oa_per_area [Double] the zone outdoor air per area in m^3/s*m^2
   # @return [Bool] returns true if successful, false if not
   def air_terminal_single_duct_vav_reheat_apply_initial_prototype_damper_position(air_terminal_single_duct_vav_reheat, zone_oa_per_area)
     min_damper_position = case air_terminal_single_duct_vav_reheat_reheat_type(air_terminal_single_duct_vav_reheat)

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2013/ashrae_90_1_2013.FanConstantVolume.rb

@@ -1,10 +1,11 @@
 class ASHRAE9012013 < ASHRAE901
   # @!group FanConstantVolume
 
-  # Determine the prototype fan pressure rise for a constant volume
-  # fan on an AirLoopHVAC based on the airflow of the system.
-  # @return [Double] the pressure rise (in H2O).  Defaults
-  # to the logic from ASHRAE 90.1-2004 prototypes.
+  # Determine the prototype fan pressure rise for a constant volume fan on an AirLoopHVAC based on system airflow.
+  # Defaults to the logic from ASHRAE 90.1-2004 prototypes.
+  #
+  # @param fan_constant_volume [OpenStudio::Model::FanConstantVolume] constant volume fan object
+  # @return [Double] pressure rise in inches H20
   def fan_constant_volume_airloop_fan_pressure_rise(fan_constant_volume)
     # Get the max flow rate from the fan.
     maximum_flow_rate_m3_per_s = nil

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2013/ashrae_90_1_2013.FanOnOff.rb

@@ -1,11 +1,11 @@
 class ASHRAE9012013 < ASHRAE901
   # @!group FanOnOff
 
-  # Determine the prototype fan pressure rise for an on off
-  # fan on an AirLoopHVAC or inside a unitary system
-  # based on the airflow of the system.
-  # @return [Double] the pressure rise (in H2O).  Defaults
-  # to the logic from ASHRAE 90.1-2004 prototypes.
+  # Determine the prototype fan pressure rise for an on off fan on an AirLoopHVAC or inside a unitary system based on system airflow.
+  # Defaults to the logic from ASHRAE 90.1-2004 prototypes.
+  #
+  # @param fan_on_off [OpenStudio::Model::FanOnOff] on off fan object
+  # @return [Double] pressure rise in inches H20
   def fan_on_off_airloop_or_unitary_fan_pressure_rise(fan_on_off)
     # Get the max flow rate from the fan.
     maximum_flow_rate_m3_per_s = nil

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2013/ashrae_90_1_2013.FanVariableVolume.rb

@@ -1,10 +1,11 @@
 class ASHRAE9012013 < ASHRAE901
   # @!group FanVariableVolume
 
-  # Determine the prototype fan pressure rise for a variable volume
-  # fan on an AirLoopHVAC based on the airflow of the system.
-  # @return [Double] the pressure rise (in H2O).  Defaults
-  # to the logic from ASHRAE 90.1-2004 prototypes.
+  # Determine the prototype fan pressure rise for a variable volume fan on an AirLoopHVAC based on system airflow.
+  # Defaults to the logic from ASHRAE 90.1-2004 prototypes.
+  #
+  # @param fan_variable_volume [OpenStudio::Model::FanVariableVolume] variable volume fan object
+  # @return [Double] pressure rise in inches H20
   def fan_variable_volume_airloop_fan_pressure_rise(fan_variable_volume)
     # Get the max flow rate from the fan.
     maximum_flow_rate_m3_per_s = nil

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2013/ashrae_90_1_2013.Model.elevators.rb

@@ -1,19 +1,23 @@
 class ASHRAE9012013 < ASHRAE901
   # @!group elevators
 
-  # Determines the percentage of the elevator cab
-  # lighting that is incandescent.  The remainder
-  # is assumed to be LED.  Defaults to 0% incandescent
-  # (100% LED), representing newer elevators.
+  # Determines the percentage of the elevator cab lighting that is incandescent.
+  # The remainder is assumed to be LED.
+  # Defaults to 0% incandescent (100% LED), representing newer elevators.
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [Double] incandescent lighting percentage
   def model_elevator_lighting_pct_incandescent(model)
     pct_incandescent = 0.0 # 100% LED
     return pct_incandescent
   end
 
   # Determines the power of the elevator ventilation fan.
-  # 90.1-2013 has a requirement
-  # for ventilation fan efficiency.
-  # @return [Double] the ventilaton fan power (W)
+  # 90.1-2013 has a requirement for ventilation fan efficiency.
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param vent_rate_cfm [Double] the ventilation rate in ft^3/min
+  # @return [Double] the ventilation fan power in watts
   def model_elevator_fan_pwr(model, vent_rate_cfm)
     vent_pwr_per_flow_w_per_cfm = 0.33
     vent_pwr_w = vent_pwr_per_flow_w_per_cfm * vent_rate_cfm

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2013/ashrae_90_1_2013.Model.rb

@@ -3,17 +3,17 @@ class ASHRAE9012013 < ASHRAE901
 
   # Determine the prototypical economizer type for the model.
   #
-  # @param model [OpenStudio::Model::Model] the model
-  # @param climate_zone [String] the climate zone
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
   # @return [String] the economizer type.  Possible values are:
-  # 'NoEconomizer'
-  # 'FixedDryBulb'
-  # 'FixedEnthalpy'
-  # 'DifferentialDryBulb'
-  # 'DifferentialEnthalpy'
-  # 'FixedDewPointAndDryBulb'
-  # 'ElectronicEnthalpy'
-  # 'DifferentialDryBulbAndEnthalpy'
+  #   'NoEconomizer'
+  #   'FixedDryBulb'
+  #   'FixedEnthalpy'
+  #   'DifferentialDryBulb'
+  #   'DifferentialEnthalpy'
+  #   'FixedDewPointAndDryBulb'
+  #   'ElectronicEnthalpy'
+  #   'DifferentialDryBulbAndEnthalpy'
   def model_economizer_type(model, climate_zone)
     economizer_type = case climate_zone
                       when 'ASHRAE 169-2006-0A',
@@ -34,10 +34,11 @@ class ASHRAE9012013 < ASHRAE901
   end
 
   # Adjust model to comply with fenestration orientation requirements
+  # @note code_sections [90.1-2013_5.5.4.5]
   #
-  # @code_sections [90.1-2013_5.5.4.5]
-  # @param [OpenStudio::Model::Model] OpenStudio model object
-  # @return [Boolean] Returns true if successful, false otherwise
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
+  # @return [Bool] returns true if successful, false if not
   def model_fenestration_orientation(model, climate_zone)
     # Building rotation to meet the same code requirement for
     # 90.1-2010 are kept
@@ -177,12 +178,12 @@ class ASHRAE9012013 < ASHRAE901
   end
 
   # Is transfer air required?
+  # @note code_sections [90.1-2013_6.5.7.1.2]
   #
-  # @code_sections [90.1-2013_6.5.7.1.2]
   # @param model [OpenStudio::Model::Model] OpenStudio model object
-  # @return [Boolean] true if transfer air is required, false otherwise
+  # @return [Bool] returns true if transfer air is required, false if not
   def model_transfer_air_required?(model)
-    # TODO: It actually is for kitchen but not implemented yet
+    # @todo It actually is for kitchen but not implemented yet
     return false
   end
 end

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2013/ashrae_90_1_2013.PumpVariableSpeed.rb

@@ -2,8 +2,8 @@ class ASHRAE9012013 < ASHRAE901
   # @!group Pump
 
   # Determine type of pump part load control type
+  # @note code_sections [90.1-2013_6.5.4.2]
   #
-  # @code_sections [90.1-2013_6.5.4.2]
   # @param pump [OpenStudio::Model::PumpVariableSpeed] OpenStudio pump object
   # @param plant_loop_type [String] Type of plant loop
   # @param pump_nominal_hp [Float] Pump nominal horsepower
@@ -16,14 +16,12 @@ class ASHRAE9012013 < ASHRAE901
     # increase and ~10% flow increase.
     design_sizing_factor = 1.25
 
-    if plant_loop_type == 'Heating'
-      return 'Riding Curve'
-    else
-      if pump_nominal_hp * design_sizing_factor > threshold
-        return 'VSD DP Reset' # Requirement only applies to CHW pumps
-      else
-        return 'Riding Curve'
-      end
-    end
-  end
+    return 'Riding Curve' if plant_loop_type == 'Heating'
+
+    # Requirement only applies to CHW pumps
+    return 'VSD DP Reset' if pump_nominal_hp * design_sizing_factor > threshold
+
+    # else
+    return 'Riding Curve'
   end
+end

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2013/ashrae_90_1_2013.hvac_systems.rb

@@ -1,8 +1,10 @@
 class ASHRAE9012013 < ASHRAE901
   # @!group hvac_systems
 
-  # Determine which type of fan the cooling tower
-  # will have.  Variable Speed Fan for ASHRAE 90.1-2013.
+  # Determine which type of fan the cooling tower will have.
+  # Variable Speed Fan for ASHRAE 90.1-2013.
+  #
+  # @param model [OpenStudio::Model::Model] the model
   # @return [String] the fan type: TwoSpeed Fan, Variable Speed Fan
   def model_cw_loop_cooling_tower_fan_type(model)
     fan_type = 'Variable Speed Fan'

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2016/ashrae_90_1_2016.AirTerminalSingleDuctVAVReheat.rb

@@ -4,7 +4,8 @@ class ASHRAE9012016 < ASHRAE901
   # Zones with low OA per area get lower initial guesses.
   # Final position will be adjusted upward as necessary by Standards.AirLoopHVAC.apply_minimum_vav_damper_positions
   #
-  # @param zone_oa_per_area [Double] the zone outdoor air per area, m^3/s
+  # @param air_terminal_single_duct_vav_reheat [OpenStudio::Model::AirTerminalSingleDuctVAVReheat] the air terminal object
+  # @param zone_oa_per_area [Double] the zone outdoor air per area in m^3/s*m^2
   # @return [Bool] returns true if successful, false if not
   def air_terminal_single_duct_vav_reheat_apply_initial_prototype_damper_position(air_terminal_single_duct_vav_reheat, zone_oa_per_area)
     min_damper_position = case air_terminal_single_duct_vav_reheat_reheat_type(air_terminal_single_duct_vav_reheat)

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2016/ashrae_90_1_2016.FanConstantVolume.rb

@@ -1,10 +1,11 @@
 class ASHRAE9012016 < ASHRAE901
   # @!group FanConstantVolume
 
-  # Determine the prototype fan pressure rise for a constant volume
-  # fan on an AirLoopHVAC based on the airflow of the system.
-  # @return [Double] the pressure rise (in H2O).  Defaults
-  # to the logic from ASHRAE 90.1-2004 prototypes.
+  # Determine the prototype fan pressure rise for a constant volume fan on an AirLoopHVAC based on system airflow.
+  # Defaults to the logic from ASHRAE 90.1-2004 prototypes.
+  #
+  # @param fan_constant_volume [OpenStudio::Model::FanConstantVolume] constant volume fan object
+  # @return [Double] pressure rise in inches H20
   def fan_constant_volume_airloop_fan_pressure_rise(fan_constant_volume)
     # Get the max flow rate from the fan.
     maximum_flow_rate_m3_per_s = nil

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2016/ashrae_90_1_2016.FanOnOff.rb

@@ -1,11 +1,11 @@
 class ASHRAE9012016 < ASHRAE901
   # @!group FanOnOff
 
-  # Determine the prototype fan pressure rise for an on off
-  # fan on an AirLoopHVAC or inside a unitary system
-  # based on the airflow of the system.
-  # @return [Double] the pressure rise (in H2O).  Defaults
-  # to the logic from ASHRAE 90.1-2004 prototypes.
+  # Determine the prototype fan pressure rise for an on off fan on an AirLoopHVAC or inside a unitary system based on system airflow.
+  # Defaults to the logic from ASHRAE 90.1-2004 prototypes.
+  #
+  # @param fan_on_off [OpenStudio::Model::FanOnOff] on off fan object
+  # @return [Double] pressure rise in inches H20
   def fan_on_off_airloop_or_unitary_fan_pressure_rise(fan_on_off)
     # Get the max flow rate from the fan.
     maximum_flow_rate_m3_per_s = nil

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2016/ashrae_90_1_2016.FanVariableVolume.rb

@@ -1,10 +1,11 @@
 class ASHRAE9012016 < ASHRAE901
   # @!group FanVariableVolume
 
-  # Determine the prototype fan pressure rise for a variable volume
-  # fan on an AirLoopHVAC based on the airflow of the system.
-  # @return [Double] the pressure rise (in H2O).  Defaults
-  # to the logic from ASHRAE 90.1-2004 prototypes.
+  # Determine the prototype fan pressure rise for a variable volume fan on an AirLoopHVAC based on system airflow.
+  # Defaults to the logic from ASHRAE 90.1-2004 prototypes.
+  #
+  # @param fan_variable_volume [OpenStudio::Model::FanVariableVolume] variable volume fan object
+  # @return [Double] pressure rise in inches H20
   def fan_variable_volume_airloop_fan_pressure_rise(fan_variable_volume)
     # Get the max flow rate from the fan.
     maximum_flow_rate_m3_per_s = nil

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2016/ashrae_90_1_2016.Model.elevators.rb

@@ -1,19 +1,23 @@
 class ASHRAE9012016 < ASHRAE901
   # @!group elevators
 
-  # Determines the percentage of the elevator cab
-  # lighting that is incandescent.  The remainder
-  # is assumed to be LED.  Defaults to 0% incandescent
-  # (100% LED), representing newer elevators.
+  # Determines the percentage of the elevator cab lighting that is incandescent.
+  # The remainder is assumed to be LED.
+  # Defaults to 0% incandescent (100% LED), representing newer elevators.
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [Double] incandescent lighting percentage
   def model_elevator_lighting_pct_incandescent(model)
     pct_incandescent = 0.0 # 100% LED
     return pct_incandescent
   end
 
   # Determines the power of the elevator ventilation fan.
-  # 90.1-2016 has a requirement
-  # for ventilation fan efficiency.
-  # @return [Double] the ventilaton fan power (W)
+  # 90.1-2016 has a requirement for ventilation fan efficiency.
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param vent_rate_cfm [Double] the ventilation rate in ft^3/min
+  # @return [Double] the ventilation fan power in watts
   def model_elevator_fan_pwr(model, vent_rate_cfm)
     vent_pwr_per_flow_w_per_cfm = 0.33
     vent_pwr_w = vent_pwr_per_flow_w_per_cfm * vent_rate_cfm