openstudio-standards 0.2.14 → 0.2.15.pre.rc1

data/lib/openstudio-standards/standards/ashrae_90_1/doe_ref_pre_1980/doe_ref_pre_1980.AirLoopHVAC.rb

@@ -1,27 +1,27 @@
 class DOERefPre1980 < ASHRAE901
   # @!group AirLoopHVAC
 
-  # Apply multizone vav outdoor air method and
-  # adjust multizone VAV damper positions.  Currently
-  # doesn't do anything for the DOE prototype buildings.
+  # Apply multizone vav outdoor air method and adjust multizone VAV damper positions.
+  # Currently doesn't do anything for the DOE prototype buildings.
   #
-  # @return [Bool] returns true if successful, false if not
+  # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
+  # return [Bool] returns true if successful, false if not
   # @todo enable damper position adjustment for legacy IDFS
   def air_loop_hvac_apply_multizone_vav_outdoor_air_sizing(air_loop_hvac)
-    # TODO: enable damper position adjustment for legacy IDFS
     OpenStudio.logFree(OpenStudio::Warn, 'openstudio.standards.AirLoopHVAC', 'Damper positions not modified for DOE Ref Pre-1980 or DOE Ref 1980-2004 vintages.')
     return true
   end
 
-  # Determine if static pressure reset is required for this
-  # system.  Not required by DOE Pre-1980.
+  # Determine if static pressure reset is required for this system.
+  # Not required by DOE Pre-1980.
   #
   # @todo Instead of requiring the input of whether a system
   #   has DDC control of VAV terminals or not, determine this
   #   from the system itself.  This may require additional information
   #   be added to the OpenStudio data model.
-  # @param has_ddc [Bool] whether or not the system has DDC control
-  # over VAV terminals.
+  #
+  # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
+  # @param has_ddc [Bool] whether or not the system has DDC control over VAV terminals.
   # return [Bool] returns true if static pressure reset is required, false if not
   def air_loop_hvac_static_pressure_reset_required?(air_loop_hvac, has_ddc)
     sp_reset_required = false
@@ -30,14 +30,18 @@ class DOERefPre1980 < ASHRAE901
 
   # Determines if optimum start control is required.
   # Not required by DOE Pre-1980.
+  #
+  # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
+  # @return [Bool] returns true if required, false if not
   def air_loop_hvac_optimum_start_required?(air_loop_hvac)
     opt_start_required = false
     return opt_start_required
   end
 
-  # Determine whether the VAV damper control is single maximum or
-  # dual maximum control.  Single Maximum for DOE Ref Pre-1980.
+  # Determine whether the VAV damper control is single maximum or dual maximum control.
+  # Single Maximum for DOE Ref Pre-1980.
   #
+  # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
   # @return [String] the damper control type: Single Maximum, Dual Maximum
   def air_loop_hvac_vav_damper_action(air_loop_hvac)
     damper_action = 'Single Maximum'

data/lib/openstudio-standards/standards/ashrae_90_1/doe_ref_pre_1980/doe_ref_pre_1980.Model.rb

@@ -7,7 +7,7 @@ class DOERefPre1980 < ASHRAE901
   # no changes are actually made to the model.
   #
   # base infiltration rates off of.
-  # @return [Bool] true if successful, false if not
+  # @return [Bool] returns true if successful, false if not
   # @todo This infiltration method is not used by the Reference
   # buildings, fix this inconsistency.
   def model_apply_infiltration_standard(model)

data/lib/openstudio-standards/standards/ashrae_90_1/doe_ref_pre_1980/doe_ref_pre_1980.PlantLoop.rb

@@ -3,6 +3,9 @@ class DOERefPre1980 < ASHRAE901
 
   # Determine if temperature reset is required.
   # Not required for the older DOE buildings.
+  #
+  # @param plant_loop [OpenStudio::Model::PlantLoop] plant loop
+  # @return [Bool] returns true if required, false if not
   def plant_loop_supply_water_temperature_reset_required?(plant_loop)
     reset_required = false
     return reset_required

data/lib/openstudio-standards/standards/ashrae_90_1/doe_ref_pre_1980/doe_ref_pre_1980.rb

@@ -10,6 +10,10 @@ class DOERefPre1980 < ASHRAE901
     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/ashrae_90_1/nrel_zne_ready_2017/data/nrel_zne_ready_2017.furnaces.json

@@ -0,0 +1,15 @@
+{
+  "furnaces": [
+    {
+      "template": "NREL ZNE Ready 2017",
+      "minimum_capacity": 0.0,
+      "maximum_capacity": 9999999999.0,
+      "start_date": "1919-09-09T00:00:00+00:00",
+      "end_date": "2999-09-09T00:00:00+00:00",
+      "minimum_annual_fuel_utilization_efficiency": null,
+      "minimum_thermal_efficiency": 0.94,
+      "minimum_combustion_efficiency": null,
+      "notes": "Assume condensing furnace"
+    }
+  ]
+}

data/lib/openstudio-standards/standards/ashrae_90_1/nrel_zne_ready_2017/nrel_zne_ready_2017.AirLoopHVAC.rb

@@ -1,8 +1,11 @@
 class NRELZNEReady2017 < ASHRAE901
   # @!group AirLoopHVAC
 
-  # Same as 90.1-2013
   # Determine the limits for the type of economizer present on the AirLoopHVAC, if any.
+  # @note Same as 90.1-2013
+  #
+  # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
   # @return [Array<Double>] [drybulb_limit_f, enthalpy_limit_btu_per_lb, dewpoint_limit_f]
   def air_loop_hvac_economizer_limits(air_loop_hvac, climate_zone)
     drybulb_limit_f = nil
@@ -11,11 +14,9 @@ class NRELZNEReady2017 < ASHRAE901
 
     # Get the OA system and OA controller
     oa_sys = air_loop_hvac.airLoopHVACOutdoorAirSystem
-    if oa_sys.is_initialized
-      oa_sys = oa_sys.get
-    else
-      return [nil, nil, nil] # No OA system
-    end
+    return [nil, nil, nil] unless oa_sys.is_initialized
+
+    oa_sys = oa_sys.get
     oa_control = oa_sys.getControllerOutdoorAir
     economizer_type = oa_control.getEconomizerControlType
     oa_control.resetEconomizerMinimumLimitDryBulbTemperature
@@ -75,21 +76,24 @@ class NRELZNEReady2017 < ASHRAE901
     return [drybulb_limit_f, enthalpy_limit_btu_per_lb, dewpoint_limit_f]
   end
 
-  # Same as 90.1-2013
   # Determine if the system economizer must be integrated or not.
-  # All economizers must be integrated in NREL ZNE Ready 2017
+  # @note same as 90.1-2013
+  # All economizers must be integrated in 90.1-2013
+  #
+  # @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_integrated_economizer_required?(air_loop_hvac, climate_zone)
-    integrated_economizer_required = true
-    return integrated_economizer_required
+    return true
   end
-
   # Same as 90.1-2013
   # Check the economizer type currently specified in the ControllerOutdoorAir object on this air loop
   # is acceptable per the standard.
   #
-  # @param (see #economizer_required?)
+  # @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 allowable, if the system has no economizer or no OA system.
-  # Returns false if the economizer type is not allowable.
+  #   Returns false if the economizer type is not allowable.
   def air_loop_hvac_economizer_type_allowable?(air_loop_hvac, climate_zone)
     # EnergyPlus economizer types
     # 'NoEconomizer'
@@ -103,11 +107,9 @@ class NRELZNEReady2017 < ASHRAE901
 
     # Get the OA system and OA controller
     oa_sys = air_loop_hvac.airLoopHVACOutdoorAirSystem
-    if oa_sys.is_initialized
-      oa_sys = oa_sys.get
-    else
-      return true # No OA system
-    end
+    return true unless oa_sys.is_initialized
+
+    oa_sys = oa_sys.get
     oa_control = oa_sys.getControllerOutdoorAir
     economizer_type = oa_control.getEconomizerControlType
 
@@ -173,14 +175,13 @@ class NRELZNEReady2017 < ASHRAE901
     return economizer_type_allowed
   end
 
-  # Same as 90.1-2013
   # Determine if multizone vav optimization is required.
+  # @note Same as 90.1-2013
   #
-  # @param (see #economizer_required?)
-  # @return [Bool] Returns true if required, false if not.
-  # @todo Add exception logic for
-  #   systems with AIA healthcare ventilation requirements
-  #   dual duct systems
+  # @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
+  # @todo Add exception logic for systems with AIA healthcare ventilation requirements dual duct systems
   def air_loop_hvac_multizone_vav_optimization_required?(air_loop_hvac, climate_zone)
     multizone_opt_required = false
 
@@ -249,7 +250,7 @@ class NRELZNEReady2017 < ASHRAE901
       return multizone_opt_required
     end
 
-    # TODO: Not required for dual-duct systems
+    # @todo Not required for dual-duct systems
     # if self.isDualDuct
     # OpenStudio::logFree(OpenStudio::Info, "openstudio.standards.AirLoopHVAC", "For #{controller_oa.name}: multizone optimization is not applicable because it is a dual duct system")
     # return multizone_opt_required
@@ -262,9 +263,9 @@ class NRELZNEReady2017 < ASHRAE901
   end
 
   # Determines the OA flow rates above which an economizer is required.
-  # Two separate rates, one for systems with an economizer and another
-  # for systems without.
-  # are zero for both types.
+  # Two separate rates, one for systems with an economizer and another for systems without.
+  #
+  # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
   # @return [Array<Double>] [min_oa_without_economizer_cfm, min_oa_with_economizer_cfm]
   def air_loop_hvac_demand_control_ventilation_limits(air_loop_hvac)
     min_oa_without_economizer_cfm = 1500.0 # half the 90.1-2013 requirement
@@ -274,14 +275,20 @@ class NRELZNEReady2017 < ASHRAE901
 
   # Determine if the standard has an exception for demand control ventilation when an energy recovery device is present.
   # DCV and an ERV may be used in conjunction.
+  #
+  # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
+  # @return [Bool] returns true if required, false if not
   def air_loop_hvac_dcv_required_when_erv(air_loop_hvac)
     dcv_required_when_erv_present = true
     return dcv_required_when_erv_present
   end
 
-  # Same as 90.1-2013
   # Determine the air flow and number of story limits for whether motorized OA damper is required.
-  # @return [Array<Double>] [minimum_oa_flow_cfm, maximum_stories]
+  # @note Same as 90.1-2013
+  #
+  # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
+  # @return [Array<Double>] [minimum_oa_flow_cfm, maximum_stories]. If both nil, never required
   def air_loop_hvac_motorized_oa_damper_limits(air_loop_hvac, climate_zone)
     case climate_zone
     when 'ASHRAE 169-2006-0A',
@@ -312,10 +319,12 @@ class NRELZNEReady2017 < ASHRAE901
     return [minimum_oa_flow_cfm, maximum_stories]
   end
 
-  # Same as 90.1-2013
   # Determine the number of stages that should be used as controls for single zone DX systems.
+  # @note Same as 90.1-2013
   # 90.1-2013 depends on the cooling capacity of the system.
   #
+  # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
   # @return [Integer] the number of stages: 0, 1, 2
   def air_loop_hvac_single_zone_controls_num_stages(air_loop_hvac, climate_zone)
     min_clg_cap_btu_per_hr = 65_000
@@ -331,12 +340,13 @@ class NRELZNEReady2017 < ASHRAE901
     return num_stages
   end
 
-  # Same as 90.1-2013
   # Determine if the system required supply air temperature (SAT) reset.
+  # @note Same as 90.1-2013
   # For 90.1-2013, SAT reset requirements are based on climate zone.
   #
-  # @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 = false
 
@@ -397,6 +407,7 @@ class NRELZNEReady2017 < ASHRAE901
   end
 
   # Default occupancy fraction threshold for determining if the spaces on the air loop are occupied
+  # @return [Double] threshold at which the air loop space are considered unoccupied
   def air_loop_hvac_unoccupied_threshold
     return 0.05
   end
@@ -404,7 +415,9 @@ class NRELZNEReady2017 < ASHRAE901
   # Same as Standards method but with no DCV exception
   # Check if ERV is required on this airloop.
   #
-  # @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_energy_recovery_ventilator_required?(air_loop_hvac, climate_zone)
     if air_loop_hvac.airLoopHVACOutdoorAirSystem.is_initialized
       oa_system = air_loop_hvac.airLoopHVACOutdoorAirSystem.get
@@ -460,11 +473,14 @@ class NRELZNEReady2017 < ASHRAE901
     return erv_required
   end
 
-  # Same as 90.1-2016
   # Determine the airflow limits that govern whether or not an ERV is required.
   # Based on climate zone and % OA, plus the number of operating hours the system has.
-  # @return [Double] the flow rate above which an ERV is required.
-  # if nil, ERV is never required.
+  # @note Same as 90.1-2016
+  #
+  # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
+  # @param pct_oa [Double] percentage of outdoor air
+  # @return [Double] the flow rate above which an ERV is required. if nil, ERV is never required.
   def air_loop_hvac_energy_recovery_ventilator_flow_limit(air_loop_hvac, climate_zone, pct_oa)
     # Calculate the number of system operating hours
     # based on the availability schedule.
@@ -729,9 +745,13 @@ class NRELZNEReady2017 < ASHRAE901
     return erv_cfm
   end
 
-  # Determine whether to apply an Energy Recovery Ventilator 'ERV' or a Heat Recovery Ventilator 'HRV' depending on the climate zone
+  # Determine whether to apply an Energy Recovery Ventilator 'ERV'
+  # or a Heat Recovery Ventilator 'HRV' depending on the climate zone
   # Defaults to ERV.
-  # @return [String] the ERV type
+  #
+  # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
+  # @return [String] the erv type
   def air_loop_hvac_energy_recovery_ventilator_type(air_loop_hvac, climate_zone)
     erv_type = 'ERV'
     return erv_type
@@ -739,7 +759,9 @@ class NRELZNEReady2017 < ASHRAE901
 
   # Determine whether to use a Plate-Frame or Rotary Wheel style ERV depending on air loop outdoor air flow rate
   # Defaults to Rotary.
-  # @return [String] the ERV type
+  #
+  # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
+  # @return [String] the erv type
   def air_loop_hvac_energy_recovery_ventilator_heat_exchanger_type(air_loop_hvac)
     # Get the OA system
     if air_loop_hvac.airLoopHVACOutdoorAirSystem.is_initialized
@@ -778,7 +800,7 @@ class NRELZNEReady2017 < ASHRAE901
   # @param erv [OpenStudio::Model::HeatExchangerAirToAirSensibleAndLatent] erv to apply efficiency values
   # @param erv_type [String] erv type ERV or HRV
   # @param heat_exchanger_type [String] heat exchanger type Rotary or Plate
-  # @return erv [OpenStudio::Model::HeatExchangerAirToAirSensibleAndLatent] erv to apply efficiency values
+  # @return [OpenStudio::Model::HeatExchangerAirToAirSensibleAndLatent] erv to apply efficiency values
   def air_loop_hvac_apply_energy_recovery_ventilator_efficiency(erv, erv_type: 'ERV', heat_exchanger_type: 'Rotary')
     if heat_exchanger_type == 'Plate'
       # based on Zehnder ComfoAir

data/lib/openstudio-standards/standards/ashrae_90_1/nrel_zne_ready_2017/nrel_zne_ready_2017.AirTerminalSingleDuctVAVReheat.rb

@@ -2,10 +2,11 @@ class NRELZNEReady2017 < ASHRAE901
   # @!group AirTerminalSingleDuctVAVReheat
 
   # Specifies the minimum damper position for VAV dampers.
-  # For terminals with hot water heat and DDC, the minimum is 20%,
-  # otherwise the minimum is 30%.
+  # For terminals with hot water heat and DDC, the minimum is 20%, otherwise the minimum is 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 = true)
     min_damper_position = nil
     case air_terminal_single_duct_vav_reheat_reheat_type(air_terminal_single_duct_vav_reheat)

data/lib/openstudio-standards/standards/ashrae_90_1/nrel_zne_ready_2017/nrel_zne_ready_2017.CoolingTower.rb

@@ -3,17 +3,14 @@
 module NRELZNEReady2017CoolingTower
   # @!group CoolingTower
 
-  # Above this point, centrifugal fan cooling towers must meet the limits
-  # of propeller or axial cooling towers instead.
-  # 90.1 6.5.5.3 Limit on Centrifugal Fan Open Circuit Cooling Towers.
-  # is 1,100 gallons per minute.
+  # Above this point, centrifugal fan cooling towers must meet the limits of propeller or axial cooling towers instead.
+  # @note code_sections 6.5.5.3 limit on centrifugal fan open=circuit cooling towers is 1,100 gallons per minute.
   #
-  # @param cooling_tower [OpenStudio::Model::CoolingTowerSingleSpeed,
-  # OpenStudio::Model::CoolingTowerTwoSpeed,
-  # OpenStudio::Model::CoolingTowerVariableSpeed] the cooling tower
+  # @param cooling_tower [OpenStudio::Model::StraightComponent] cooling tower object, allowable types:
+  #   CoolingTowerSingleSpeed, CoolingTowerTwoSpeed, CoolingTowerVariableSpeed
   # @return [Double] the limit, in gallons per minute.  Return nil for no limit.
   def cooling_tower_apply_minimum_power_per_flow_gpm_limit(cooling_tower)
-    gpm_limit = 1100
+    gpm_limit = 1100.0
     return gpm_limit
   end
 end

data/lib/openstudio-standards/standards/ashrae_90_1/nrel_zne_ready_2017/nrel_zne_ready_2017.CoolingTowerVariableSpeed.rb

@@ -5,12 +5,11 @@ class NRELZNEReady2017 < ASHRAE901
 
   # Apply the efficiency, plus Multicell heat rejection with VSD per 90.1-2013 6.5.2.2
   #
-  # @param cooling_tower_variable_speed [OpenStudio::Model::CoolingTowerVariableSpeed] the cooling tower
+  # @param cooling_tower_variable_speed [OpenStudio::Model::CoolingTowerVariableSpeed] variable speed cooling tower
+  # @return [Bool] returns true if successful, false if not
   def cooling_tower_variable_speed_apply_efficiency_and_curves(cooling_tower_variable_speed)
     cooling_tower_apply_minimum_power_per_flow(cooling_tower_variable_speed)
-
     cooling_tower_variable_speed.setCellControl('MaximalCell')
-
     return true
   end
 end

data/lib/openstudio-standards/standards/ashrae_90_1/nrel_zne_ready_2017/nrel_zne_ready_2017.FanVariableVolume.rb

@@ -5,7 +5,7 @@ class NRELZNEReady2017 < ASHRAE901
   # Per 90.1-2013, table 6.5.3.2.1: the fan motor size for chiller-water
   # and evaporative cooling is 0.25 hp as of 1/1/2014 instead of 5 hp
   #
-  # @param fan_variable_volume [OpenStudio::Model::FanVariableVolume] the fan
+  # @param fan_variable_volume [OpenStudio::Model::FanVariableVolume] variable volume fan object
   # @return [Double] the limit, in horsepower. Return nil for no limit by default.
   def fan_variable_volume_part_load_fan_power_limitation_hp_limit(fan_variable_volume)
     hp_limit = case fan_variable_volume_cooling_system_type(fan_variable_volume)
@@ -24,7 +24,7 @@ class NRELZNEReady2017 < ASHRAE901
   # Per 90.1-2013, table 6.5.3.2.1: the cooling capacity threshold is 75000
   # instead of 110000 as of 1/1/2014
   #
-  # @param fan_variable_volume [OpenStudio::Model::FanVariableVolume] the fan
+  # @param fan_variable_volume [OpenStudio::Model::FanVariableVolume] variable volume fan object
   # @return [Double] the limit, in Btu/hr. Return nil for no limit by default.
   def fan_variable_volume_part_load_fan_power_limitation_capacity_limit(fan_variable_volume)
     cap_limit_btu_per_hr = case fan_variable_volume_cooling_system_type(fan_variable_volume)

data/lib/openstudio-standards/standards/ashrae_90_1/nrel_zne_ready_2017/nrel_zne_ready_2017.HeatExchangerSensLat.rb

@@ -2,7 +2,7 @@ class NRELZNEReady2017 < ASHRAE901
   # @!group HeatExchangerSensLat
 
   # Sets the minimum effectiveness of the heat exchanger
-  def heat_exchanger_air_to_air_sensible_and_latent_apply_efficiency(heat_exchanger_air_to_air_sensible_and_latent)
+  def heat_exchanger_air_to_air_sensible_and_latent_apply_effectiveness(heat_exchanger_air_to_air_sensible_and_latent)
     # Assumed to be sensible and latent at all flow
     heat_exchanger_type = heat_exchanger_air_to_air_sensible_and_latent.heatExchangerType
 

data/lib/openstudio-standards/standards/ashrae_90_1/nrel_zne_ready_2017/nrel_zne_ready_2017.Model.rb

@@ -73,7 +73,7 @@ class NRELZNEReady2017 < ASHRAE901
     model.getEvaporativeFluidCoolerTwoSpeeds.sort.each { |obj| fluid_cooler_apply_minimum_power_per_flow(obj, equipment_type: 'Closed Cooling Tower') }
 
     # ERVs
-    model.getHeatExchangerAirToAirSensibleAndLatents.each { |obj| heat_exchanger_air_to_air_sensible_and_latent_apply_efficiency(obj) }
+    model.getHeatExchangerAirToAirSensibleAndLatents.each { |obj| heat_exchanger_air_to_air_sensible_and_latent_apply_effectiveness(obj) }
 
     # Gas Heaters
     model.getCoilHeatingGass.sort.each { |obj| coil_heating_gas_apply_efficiency_and_curves(obj) }

data/lib/openstudio-standards/standards/ashrae_90_1/nrel_zne_ready_2017/nrel_zne_ready_2017.PlantLoop.rb

@@ -1,7 +1,10 @@
 class NRELZNEReady2017 < ASHRAE901
   # @!group PlantLoop
 
-  # Applies the chilled water pumping controls to the loop
+  # Applies the chilled water pumping controls to the loop based on Appendix G.
+  #
+  # @param plant_loop [OpenStudio::Model::PlantLoop] chilled water loop
+  # @return [Bool] returns true if successful, false if not
   def plant_loop_apply_prm_baseline_chilled_water_pumping_type(plant_loop)
     pri_control_type = 'VSD DP Reset'
     sec_control_type = 'VSD DP Reset'

data/lib/openstudio-standards/standards/ashrae_90_1/nrel_zne_ready_2017/nrel_zne_ready_2017.Space.rb

@@ -73,15 +73,17 @@ class NRELZNEReady2017 < ASHRAE901
     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/ashrae_90_1/nrel_zne_ready_2017/nrel_zne_ready_2017.ZoneHVACComponent.rb

@@ -1,6 +1,9 @@
 class NRELZNEReady2017 < ASHRAE901
   # @!group ZoneHVACComponent
 
+  # default fan efficiency for small zone hvac fans, in watts per cfm
+  #
+  # @return [Double] fan efficiency in watts per cfm
   def zone_hvac_component_prm_baseline_fan_efficacy
     fan_efficacy_w_per_cfm = 0.65
     return fan_efficacy_w_per_cfm

data/lib/openstudio-standards/standards/ashrae_90_1/nrel_zne_ready_2017/nrel_zne_ready_2017.rb

@@ -10,6 +10,10 @@ class NRELZNEReady2017 < ASHRAE901
     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/ashrae_90_1/ze_aedg_multifamily/data/ze_aedg_multifamily.furnaces.json

@@ -0,0 +1,15 @@
+{
+  "furnaces": [
+    {
+      "template": "ZE AEDG Multifamily",
+      "minimum_capacity": 0.0,
+      "maximum_capacity": 9999999999.0,
+      "start_date": "1919-09-09T00:00:00+00:00",
+      "end_date": "2999-09-09T00:00:00+00:00",
+      "minimum_annual_fuel_utilization_efficiency": null,
+      "minimum_thermal_efficiency": 0.94,
+      "minimum_combustion_efficiency": null,
+      "notes": "Assume condensing furnace"
+    }
+  ]
+}