openstudio-standards 0.2.14 → 0.2.15.pre.rc1

data/lib/openstudio-standards/standards/deer/deer_2030/deer_2030.Space.rb

@@ -73,15 +73,17 @@ class DEER2030 < DEER
     return [req_top_ctrl, req_pri_ctrl, req_sec_ctrl]
   end
 
-  # Determine the fraction controlled by each sensor and which
-  # window each sensor should go near.
+  # Determine the fraction controlled by each sensor and which window each sensor should go near.
   #
-  # @param space [OpenStudio::Model::Space] the space with the daylighting
+  # @param space [OpenStudio::Model::Space] space object
+  # @param areas [Hash] a hash of daylighted areas
   # @param sorted_windows [Hash] a hash of windows, sorted by priority
   # @param sorted_skylights [Hash] a hash of skylights, sorted by priority
   # @param req_top_ctrl [Bool] if toplighting controls are required
   # @param req_pri_ctrl [Bool] if primary sidelighting controls are required
   # @param req_sec_ctrl [Bool] if secondary sidelighting controls are required
+  # @return [Array] array of 4 items
+  #   [sensor 1 fraction, sensor 2 fraction, sensor 1 window, sensor 2 window]
   def space_daylighting_fractions_and_windows(space,
                                               areas,
                                               sorted_windows,

data/lib/openstudio-standards/standards/deer/deer_2030/deer_2030.rb

@@ -9,6 +9,10 @@ class DEER2030 < DEER
     load_standards_database
   end
 
+  # Loads the openstudio standards dataset for this standard.
+  #
+  # @param data_directories [Array<String>] array of file paths that contain standards data
+  # @return [Hash] a hash of standards data
   def load_standards_database(data_directories = [])
     super([__dir__] + data_directories)
   end

data/lib/openstudio-standards/standards/deer/deer_2035/comstock_deer_2035/comstock_deer_2035.rb

@@ -9,6 +9,10 @@ class ComStockDEER2035 < DEER2035
     load_standards_database
   end
 
+  # Loads the openstudio standards dataset for this standard.
+  #
+  # @param data_directories [Array<String>] array of file paths that contain standards data
+  # @return [Hash] a hash of standards data
   def load_standards_database(data_directories = [])
     super([__dir__] + data_directories)
   end

data/lib/openstudio-standards/standards/deer/deer_2035/deer_2035.AirLoopHVAC.rb

@@ -4,8 +4,9 @@ class DEER2035 < DEER
   # Determine if the system required supply air temperature (SAT) reset.
   # Defaults to true for DEER 2035.
   #
-  # @param (see #economizer_required?)
-  # @return [Bool] Returns true if required, false if not.
+  # @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_supply_air_temperature_reset_required?(air_loop_hvac, climate_zone)
     is_sat_reset_required = true
     return is_sat_reset_required
@@ -13,17 +14,20 @@ class DEER2035 < DEER
 
   # Determine if a system's fans must shut off when not required.
   # Per ASHRAE 90.1 section 6.4.3.3, HVAC systems are required to have off-hour controls
-  # @return [Bool] true if required, false if not
+  #
+  # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
+  # @return [Bool] returns true if required, false if not
   def air_loop_hvac_unoccupied_fan_shutoff_required?(air_loop_hvac)
     shutoff_required = true
-
     return shutoff_required
   end
 
   # Determine if a motorized OA damper is required
   # Defaults to true for DEER 2035.
   #
-  # @return [Bool] Returns true if required, false if not.
+  # @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_motorized_oa_damper_required?(air_loop_hvac, climate_zone)
     motorized_oa_damper_required = true
     return motorized_oa_damper_required

data/lib/openstudio-standards/standards/deer/deer_2035/deer_2035.FanVariableVolume.rb

@@ -2,6 +2,9 @@ class DEER2035 < DEER
   # @!group FanVariableVolume
 
   # Determines whether there is a requirement to have a VSD or some other method to reduce fan power at low part load ratios.
+  #
+  # @param fan_variable_volume [OpenStudio::Model::FanVariableVolume] variable volume fan object
+  # @return [Bool] returns true if required, false if not
   def fan_variable_volume_part_load_fan_power_limitation?(fan_variable_volume)
     part_load_control_required = false
 

data/lib/openstudio-standards/standards/deer/deer_2035/deer_2035.Space.rb

@@ -73,15 +73,17 @@ class DEER2035 < DEER
     return [req_top_ctrl, req_pri_ctrl, req_sec_ctrl]
   end
 
-  # Determine the fraction controlled by each sensor and which
-  # window each sensor should go near.
+  # Determine the fraction controlled by each sensor and which window each sensor should go near.
   #
-  # @param space [OpenStudio::Model::Space] the space with the daylighting
+  # @param space [OpenStudio::Model::Space] space object
+  # @param areas [Hash] a hash of daylighted areas
   # @param sorted_windows [Hash] a hash of windows, sorted by priority
   # @param sorted_skylights [Hash] a hash of skylights, sorted by priority
   # @param req_top_ctrl [Bool] if toplighting controls are required
   # @param req_pri_ctrl [Bool] if primary sidelighting controls are required
   # @param req_sec_ctrl [Bool] if secondary sidelighting controls are required
+  # @return [Array] array of 4 items
+  #   [sensor 1 fraction, sensor 2 fraction, sensor 1 window, sensor 2 window]
   def space_daylighting_fractions_and_windows(space,
                                               areas,
                                               sorted_windows,

data/lib/openstudio-standards/standards/deer/deer_2035/deer_2035.rb

@@ -9,6 +9,10 @@ class DEER2035 < DEER
     load_standards_database
   end
 
+  # Loads the openstudio standards dataset for this standard.
+  #
+  # @param data_directories [Array<String>] array of file paths that contain standards data
+  # @return [Hash] a hash of standards data
   def load_standards_database(data_directories = [])
     super([__dir__] + data_directories)
   end

data/lib/openstudio-standards/standards/deer/deer_2040/comstock_deer_2040/comstock_deer_2040.rb

@@ -9,6 +9,10 @@ class ComStockDEER2040 < DEER2040
     load_standards_database
   end
 
+  # Loads the openstudio standards dataset for this standard.
+  #
+  # @param data_directories [Array<String>] array of file paths that contain standards data
+  # @return [Hash] a hash of standards data
   def load_standards_database(data_directories = [])
     super([__dir__] + data_directories)
   end

data/lib/openstudio-standards/standards/deer/deer_2040/deer_2040.AirLoopHVAC.rb

@@ -4,8 +4,9 @@ class DEER2040 < DEER
   # Determine if the system required supply air temperature (SAT) reset.
   # Defaults to true for DEER 2040.
   #
-  # @param (see #economizer_required?)
-  # @return [Bool] Returns true if required, false if not.
+  # @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_supply_air_temperature_reset_required?(air_loop_hvac, climate_zone)
     is_sat_reset_required = true
     return is_sat_reset_required
@@ -13,17 +14,20 @@ class DEER2040 < DEER
 
   # Determine if a system's fans must shut off when not required.
   # Per ASHRAE 90.1 section 6.4.3.3, HVAC systems are required to have off-hour controls
-  # @return [Bool] true if required, false if not
+  #
+  # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
+  # @return [Bool] returns true if required, false if not
   def air_loop_hvac_unoccupied_fan_shutoff_required?(air_loop_hvac)
     shutoff_required = true
-
     return shutoff_required
   end
 
   # Determine if a motorized OA damper is required
   # Defaults to true for DEER 2040.
   #
-  # @return [Bool] Returns true if required, false if not.
+  # @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_motorized_oa_damper_required?(air_loop_hvac, climate_zone)
     motorized_oa_damper_required = true
     return motorized_oa_damper_required

data/lib/openstudio-standards/standards/deer/deer_2040/deer_2040.FanVariableVolume.rb

@@ -2,6 +2,9 @@ class DEER2040 < DEER
   # @!group FanVariableVolume
 
   # Determines whether there is a requirement to have a VSD or some other method to reduce fan power at low part load ratios.
+  #
+  # @param fan_variable_volume [OpenStudio::Model::FanVariableVolume] variable volume fan object
+  # @return [Bool] returns true if required, false if not
   def fan_variable_volume_part_load_fan_power_limitation?(fan_variable_volume)
     part_load_control_required = false
 

data/lib/openstudio-standards/standards/deer/deer_2040/deer_2040.Space.rb

@@ -73,15 +73,17 @@ class DEER2040 < DEER
     return [req_top_ctrl, req_pri_ctrl, req_sec_ctrl]
   end
 
-  # Determine the fraction controlled by each sensor and which
-  # window each sensor should go near.
+  # Determine the fraction controlled by each sensor and which window each sensor should go near.
   #
-  # @param space [OpenStudio::Model::Space] the space with the daylighting
+  # @param space [OpenStudio::Model::Space] space object
+  # @param areas [Hash] a hash of daylighted areas
   # @param sorted_windows [Hash] a hash of windows, sorted by priority
   # @param sorted_skylights [Hash] a hash of skylights, sorted by priority
   # @param req_top_ctrl [Bool] if toplighting controls are required
   # @param req_pri_ctrl [Bool] if primary sidelighting controls are required
   # @param req_sec_ctrl [Bool] if secondary sidelighting controls are required
+  # @return [Array] array of 4 items
+  #   [sensor 1 fraction, sensor 2 fraction, sensor 1 window, sensor 2 window]
   def space_daylighting_fractions_and_windows(space,
                                               areas,
                                               sorted_windows,

data/lib/openstudio-standards/standards/deer/deer_2040/deer_2040.rb

@@ -9,6 +9,10 @@ class DEER2040 < DEER
     load_standards_database
   end
 
+  # Loads the openstudio standards dataset for this standard.
+  #
+  # @param data_directories [Array<String>] array of file paths that contain standards data
+  # @return [Hash] a hash of standards data
   def load_standards_database(data_directories = [])
     super([__dir__] + data_directories)
   end

data/lib/openstudio-standards/standards/deer/deer_2045/comstock_deer_2045/comstock_deer_2045.rb

@@ -9,6 +9,10 @@ class ComStockDEER2045 < DEER2045
     load_standards_database
   end
 
+  # Loads the openstudio standards dataset for this standard.
+  #
+  # @param data_directories [Array<String>] array of file paths that contain standards data
+  # @return [Hash] a hash of standards data
   def load_standards_database(data_directories = [])
     super([__dir__] + data_directories)
   end

data/lib/openstudio-standards/standards/deer/deer_2045/deer_2045.AirLoopHVAC.rb

@@ -4,8 +4,9 @@ class DEER2045 < DEER
   # Determine if the system required supply air temperature (SAT) reset.
   # Defaults to true for DEER 2045.
   #
-  # @param (see #economizer_required?)
-  # @return [Bool] Returns true if required, false if not.
+  # @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_supply_air_temperature_reset_required?(air_loop_hvac, climate_zone)
     is_sat_reset_required = true
     return is_sat_reset_required
@@ -13,17 +14,20 @@ class DEER2045 < DEER
 
   # Determine if a system's fans must shut off when not required.
   # Per ASHRAE 90.1 section 6.4.3.3, HVAC systems are required to have off-hour controls
-  # @return [Bool] true if required, false if not
+  #
+  # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
+  # @return [Bool] returns true if required, false if not
   def air_loop_hvac_unoccupied_fan_shutoff_required?(air_loop_hvac)
     shutoff_required = true
-
     return shutoff_required
   end
 
   # Determine if a motorized OA damper is required
   # Defaults to true for DEER 2045.
   #
-  # @return [Bool] Returns true if required, false if not.
+  # @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_motorized_oa_damper_required?(air_loop_hvac, climate_zone)
     motorized_oa_damper_required = true
     return motorized_oa_damper_required

data/lib/openstudio-standards/standards/deer/deer_2045/deer_2045.FanVariableVolume.rb

@@ -2,6 +2,9 @@ class DEER2045 < DEER
   # @!group FanVariableVolume
 
   # Determines whether there is a requirement to have a VSD or some other method to reduce fan power at low part load ratios.
+  #
+  # @param fan_variable_volume [OpenStudio::Model::FanVariableVolume] variable volume fan object
+  # @return [Bool] returns true if required, false if not
   def fan_variable_volume_part_load_fan_power_limitation?(fan_variable_volume)
     part_load_control_required = false
 

data/lib/openstudio-standards/standards/deer/deer_2045/deer_2045.Space.rb

@@ -73,15 +73,17 @@ class DEER2045 < DEER
     return [req_top_ctrl, req_pri_ctrl, req_sec_ctrl]
   end
 
-  # Determine the fraction controlled by each sensor and which
-  # window each sensor should go near.
+  # Determine the fraction controlled by each sensor and which window each sensor should go near.
   #
-  # @param space [OpenStudio::Model::Space] the space with the daylighting
+  # @param space [OpenStudio::Model::Space] space object
+  # @param areas [Hash] a hash of daylighted areas
   # @param sorted_windows [Hash] a hash of windows, sorted by priority
   # @param sorted_skylights [Hash] a hash of skylights, sorted by priority
   # @param req_top_ctrl [Bool] if toplighting controls are required
   # @param req_pri_ctrl [Bool] if primary sidelighting controls are required
   # @param req_sec_ctrl [Bool] if secondary sidelighting controls are required
+  # @return [Array] array of 4 items
+  #   [sensor 1 fraction, sensor 2 fraction, sensor 1 window, sensor 2 window]
   def space_daylighting_fractions_and_windows(space,
                                               areas,
                                               sorted_windows,

data/lib/openstudio-standards/standards/deer/deer_2045/deer_2045.rb

@@ -9,6 +9,10 @@ class DEER2045 < DEER
     load_standards_database
   end
 
+  # Loads the openstudio standards dataset for this standard.
+  #
+  # @param data_directories [Array<String>] array of file paths that contain standards data
+  # @return [Hash] a hash of standards data
   def load_standards_database(data_directories = [])
     super([__dir__] + data_directories)
   end

data/lib/openstudio-standards/standards/deer/deer_2050/comstock_deer_2050/comstock_deer_2050.rb

@@ -9,6 +9,10 @@ class ComStockDEER2050 < DEER2050
     load_standards_database
   end
 
+  # Loads the openstudio standards dataset for this standard.
+  #
+  # @param data_directories [Array<String>] array of file paths that contain standards data
+  # @return [Hash] a hash of standards data
   def load_standards_database(data_directories = [])
     super([__dir__] + data_directories)
   end

data/lib/openstudio-standards/standards/deer/deer_2050/deer_2050.AirLoopHVAC.rb

@@ -4,8 +4,9 @@ class DEER2050 < DEER
   # Determine if the system required supply air temperature (SAT) reset.
   # Defaults to true for DEER 2050.
   #
-  # @param (see #economizer_required?)
-  # @return [Bool] Returns true if required, false if not.
+  # @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_supply_air_temperature_reset_required?(air_loop_hvac, climate_zone)
     is_sat_reset_required = true
     return is_sat_reset_required
@@ -13,17 +14,20 @@ class DEER2050 < DEER
 
   # Determine if a system's fans must shut off when not required.
   # Per ASHRAE 90.1 section 6.4.3.3, HVAC systems are required to have off-hour controls
-  # @return [Bool] true if required, false if not
+  #
+  # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
+  # @return [Bool] returns true if required, false if not
   def air_loop_hvac_unoccupied_fan_shutoff_required?(air_loop_hvac)
     shutoff_required = true
-
     return shutoff_required
   end
 
   # Determine if a motorized OA damper is required
   # Defaults to true for DEER 2050.
   #
-  # @return [Bool] Returns true if required, false if not.
+  # @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_motorized_oa_damper_required?(air_loop_hvac, climate_zone)
     motorized_oa_damper_required = true
     return motorized_oa_damper_required

data/lib/openstudio-standards/standards/deer/deer_2050/deer_2050.FanVariableVolume.rb

@@ -2,6 +2,9 @@ class DEER2050 < DEER
   # @!group FanVariableVolume
 
   # Determines whether there is a requirement to have a VSD or some other method to reduce fan power at low part load ratios.
+  #
+  # @param fan_variable_volume [OpenStudio::Model::FanVariableVolume] variable volume fan object
+  # @return [Bool] returns true if required, false if not
   def fan_variable_volume_part_load_fan_power_limitation?(fan_variable_volume)
     part_load_control_required = false
 

data/lib/openstudio-standards/standards/deer/deer_2050/deer_2050.Space.rb

@@ -73,15 +73,17 @@ class DEER2050 < DEER
     return [req_top_ctrl, req_pri_ctrl, req_sec_ctrl]
   end
 
-  # Determine the fraction controlled by each sensor and which
-  # window each sensor should go near.
+  # Determine the fraction controlled by each sensor and which window each sensor should go near.
   #
-  # @param space [OpenStudio::Model::Space] the space with the daylighting
+  # @param space [OpenStudio::Model::Space] space object
+  # @param areas [Hash] a hash of daylighted areas
   # @param sorted_windows [Hash] a hash of windows, sorted by priority
   # @param sorted_skylights [Hash] a hash of skylights, sorted by priority
   # @param req_top_ctrl [Bool] if toplighting controls are required
   # @param req_pri_ctrl [Bool] if primary sidelighting controls are required
   # @param req_sec_ctrl [Bool] if secondary sidelighting controls are required
+  # @return [Array] array of 4 items
+  #   [sensor 1 fraction, sensor 2 fraction, sensor 1 window, sensor 2 window]
   def space_daylighting_fractions_and_windows(space,
                                               areas,
                                               sorted_windows,

data/lib/openstudio-standards/standards/deer/deer_2050/deer_2050.rb

@@ -9,6 +9,10 @@ class DEER2050 < DEER
     load_standards_database
   end
 
+  # Loads the openstudio standards dataset for this standard.
+  #
+  # @param data_directories [Array<String>] array of file paths that contain standards data
+  # @return [Hash] a hash of standards data
   def load_standards_database(data_directories = [])
     super([__dir__] + data_directories)
   end

data/lib/openstudio-standards/standards/deer/deer_2055/comstock_deer_2055/comstock_deer_2055.rb

@@ -9,6 +9,10 @@ class ComStockDEER2055 < DEER2055
     load_standards_database
   end
 
+  # Loads the openstudio standards dataset for this standard.
+  #
+  # @param data_directories [Array<String>] array of file paths that contain standards data
+  # @return [Hash] a hash of standards data
   def load_standards_database(data_directories = [])
     super([__dir__] + data_directories)
   end

data/lib/openstudio-standards/standards/deer/deer_2055/deer_2055.AirLoopHVAC.rb

@@ -4,8 +4,9 @@ class DEER2055 < DEER
   # Determine if the system required supply air temperature (SAT) reset.
   # Defaults to true for DEER 2055.
   #
-  # @param (see #economizer_required?)
-  # @return [Bool] Returns true if required, false if not.
+  # @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_supply_air_temperature_reset_required?(air_loop_hvac, climate_zone)
     is_sat_reset_required = true
     return is_sat_reset_required
@@ -13,17 +14,20 @@ class DEER2055 < DEER
 
   # Determine if a system's fans must shut off when not required.
   # Per ASHRAE 90.1 section 6.4.3.3, HVAC systems are required to have off-hour controls
-  # @return [Bool] true if required, false if not
+  #
+  # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
+  # @return [Bool] returns true if required, false if not
   def air_loop_hvac_unoccupied_fan_shutoff_required?(air_loop_hvac)
     shutoff_required = true
-
     return shutoff_required
   end
 
   # Determine if a motorized OA damper is required
   # Defaults to true for DEER 2055.
   #
-  # @return [Bool] Returns true if required, false if not.
+  # @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_motorized_oa_damper_required?(air_loop_hvac, climate_zone)
     motorized_oa_damper_required = true
     return motorized_oa_damper_required

data/lib/openstudio-standards/standards/deer/deer_2055/deer_2055.FanVariableVolume.rb

@@ -2,6 +2,9 @@ class DEER2055 < DEER
   # @!group FanVariableVolume
 
   # Determines whether there is a requirement to have a VSD or some other method to reduce fan power at low part load ratios.
+  #
+  # @param fan_variable_volume [OpenStudio::Model::FanVariableVolume] variable volume fan object
+  # @return [Bool] returns true if required, false if not
   def fan_variable_volume_part_load_fan_power_limitation?(fan_variable_volume)
     part_load_control_required = false
 

data/lib/openstudio-standards/standards/deer/deer_2055/deer_2055.Space.rb

@@ -73,15 +73,17 @@ class DEER2055 < DEER
     return [req_top_ctrl, req_pri_ctrl, req_sec_ctrl]
   end
 
-  # Determine the fraction controlled by each sensor and which
-  # window each sensor should go near.
+  # Determine the fraction controlled by each sensor and which window each sensor should go near.
   #
-  # @param space [OpenStudio::Model::Space] the space with the daylighting
+  # @param space [OpenStudio::Model::Space] space object
+  # @param areas [Hash] a hash of daylighted areas
   # @param sorted_windows [Hash] a hash of windows, sorted by priority
   # @param sorted_skylights [Hash] a hash of skylights, sorted by priority
   # @param req_top_ctrl [Bool] if toplighting controls are required
   # @param req_pri_ctrl [Bool] if primary sidelighting controls are required
   # @param req_sec_ctrl [Bool] if secondary sidelighting controls are required
+  # @return [Array] array of 4 items
+  #   [sensor 1 fraction, sensor 2 fraction, sensor 1 window, sensor 2 window]
   def space_daylighting_fractions_and_windows(space,
                                               areas,
                                               sorted_windows,

data/lib/openstudio-standards/standards/deer/deer_2055/deer_2055.rb

@@ -9,6 +9,10 @@ class DEER2055 < DEER
     load_standards_database
   end
 
+  # Loads the openstudio standards dataset for this standard.
+  #
+  # @param data_directories [Array<String>] array of file paths that contain standards data
+  # @return [Hash] a hash of standards data
   def load_standards_database(data_directories = [])
     super([__dir__] + data_directories)
   end

data/lib/openstudio-standards/standards/deer/deer_2060/comstock_deer_2060/comstock_deer_2060.rb

@@ -9,6 +9,10 @@ class ComStockDEER2060 < DEER2060
     load_standards_database
   end
 
+  # Loads the openstudio standards dataset for this standard.
+  #
+  # @param data_directories [Array<String>] array of file paths that contain standards data
+  # @return [Hash] a hash of standards data
   def load_standards_database(data_directories = [])
     super([__dir__] + data_directories)
   end

data/lib/openstudio-standards/standards/deer/deer_2060/deer_2060.AirLoopHVAC.rb

@@ -4,8 +4,9 @@ class DEER2060 < DEER
   # Determine if the system required supply air temperature (SAT) reset.
   # Defaults to true for DEER 2060.
   #
-  # @param (see #economizer_required?)
-  # @return [Bool] Returns true if required, false if not.
+  # @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_supply_air_temperature_reset_required?(air_loop_hvac, climate_zone)
     is_sat_reset_required = true
     return is_sat_reset_required
@@ -13,17 +14,20 @@ class DEER2060 < DEER
 
   # Determine if a system's fans must shut off when not required.
   # Per ASHRAE 90.1 section 6.4.3.3, HVAC systems are required to have off-hour controls
-  # @return [Bool] true if required, false if not
+  #
+  # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
+  # @return [Bool] returns true if required, false if not
   def air_loop_hvac_unoccupied_fan_shutoff_required?(air_loop_hvac)
     shutoff_required = true
-
     return shutoff_required
   end
 
   # Determine if a motorized OA damper is required
   # Defaults to true for DEER 2060.
   #
-  # @return [Bool] Returns true if required, false if not.
+  # @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_motorized_oa_damper_required?(air_loop_hvac, climate_zone)
     motorized_oa_damper_required = true
     return motorized_oa_damper_required

data/lib/openstudio-standards/standards/deer/deer_2060/deer_2060.FanVariableVolume.rb

@@ -2,6 +2,9 @@ class DEER2060 < DEER
   # @!group FanVariableVolume
 
   # Determines whether there is a requirement to have a VSD or some other method to reduce fan power at low part load ratios.
+  #
+  # @param fan_variable_volume [OpenStudio::Model::FanVariableVolume] variable volume fan object
+  # @return [Bool] returns true if required, false if not
   def fan_variable_volume_part_load_fan_power_limitation?(fan_variable_volume)
     part_load_control_required = false
 

data/lib/openstudio-standards/standards/deer/deer_2060/deer_2060.Space.rb

@@ -73,15 +73,17 @@ class DEER2060 < DEER
     return [req_top_ctrl, req_pri_ctrl, req_sec_ctrl]
   end
 
-  # Determine the fraction controlled by each sensor and which
-  # window each sensor should go near.
+  # Determine the fraction controlled by each sensor and which window each sensor should go near.
   #
-  # @param space [OpenStudio::Model::Space] the space with the daylighting
+  # @param space [OpenStudio::Model::Space] space object
+  # @param areas [Hash] a hash of daylighted areas
   # @param sorted_windows [Hash] a hash of windows, sorted by priority
   # @param sorted_skylights [Hash] a hash of skylights, sorted by priority
   # @param req_top_ctrl [Bool] if toplighting controls are required
   # @param req_pri_ctrl [Bool] if primary sidelighting controls are required
   # @param req_sec_ctrl [Bool] if secondary sidelighting controls are required
+  # @return [Array] array of 4 items
+  #   [sensor 1 fraction, sensor 2 fraction, sensor 1 window, sensor 2 window]
   def space_daylighting_fractions_and_windows(space,
                                               areas,
                                               sorted_windows,

data/lib/openstudio-standards/standards/deer/deer_2060/deer_2060.rb

@@ -9,6 +9,10 @@ class DEER2060 < DEER
     load_standards_database
   end
 
+  # Loads the openstudio standards dataset for this standard.
+  #
+  # @param data_directories [Array<String>] array of file paths that contain standards data
+  # @return [Hash] a hash of standards data
   def load_standards_database(data_directories = [])
     super([__dir__] + data_directories)
   end

data/lib/openstudio-standards/standards/deer/deer_2065/comstock_deer_2065/comstock_deer_2065.rb

@@ -9,6 +9,10 @@ class ComStockDEER2065 < DEER2065
     load_standards_database
   end
 
+  # Loads the openstudio standards dataset for this standard.
+  #
+  # @param data_directories [Array<String>] array of file paths that contain standards data
+  # @return [Hash] a hash of standards data
   def load_standards_database(data_directories = [])
     super([__dir__] + data_directories)
   end