openstudio-standards 0.2.14 → 0.2.15.pre.rc1

data/lib/openstudio-standards/prototypes/common/objects/Prototype.radiant_system_controls.rb

@@ -7,7 +7,7 @@ class Standard
   #   options are 'floor' and 'ceiling'
   # @param model_occ_hr_start [Double] Starting hour of building occupancy
   # @param model_occ_hr_end [Double] Ending hour of building occupancy
-  # @TODO model_occ_hr_start and model_occ_hr_end from zone occupancy schedules
+  # @todo model_occ_hr_start and model_occ_hr_end from zone occupancy schedules
   # @param proportional_gain [Double] Proportional gain constant (recommended 0.3 or less).
   # @param minimum_operation [Double] Minimum number of hours of operation for radiant system before it shuts off.
   # @param weekend_temperature_reset [Double] Weekend temperature reset for slab temperature setpoint in degree Celsius.

data/lib/openstudio-standards/prototypes/common/objects/Prototype.refrigeration.rb

@@ -3,13 +3,15 @@ class Standard
 
   # Adds a refrigerated case to the model.
   #
-  # @param thermal_zone [OpenStudio::Model::ThermalZone] the thermal zone where the
-  # case is located, and which will be impacted by the case's thermal load.
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param thermal_zone [OpenStudio::Model::ThermalZone] the thermal zone where the case is located,
+  #   and which will be impacted by the case's thermal load.
   # @param case_type [String] the case type/name. For valid choices
-  # This parameter is used also by the "Refrigeration System Lineup" tab.
-  # refer to the ""Refrigerated Cases" tab on the OpenStudio_Standards spreadsheet.
-  # @param size_category [String] size category of the building area. Valid choices
-  # are: "<35k ft2", "35k - 50k ft2", ">50k ft2"
+  #   refer to the ""Refrigerated Cases" tab on the OpenStudio_Standards spreadsheet.
+  #   This parameter is used also by the "Refrigeration System Lineup" tab.
+  # @param size_category [String] size category of the building area. Valid choices are:
+  #   "<35k ft2", "35k - 50k ft2", ">50k ft2"
+  # @return [OpenStudio::Model::RefrigerationCase] the refrigeration case
   def model_add_refrigeration_case(model, thermal_zone, case_type, size_category)
     # Get the case properties
     #
@@ -142,13 +144,17 @@ class Standard
     return ref_case
   end
 
-  # @param thermal_zone [OpenStudio::Model::ThermalZone] the thermal zone where the
-  # walkin is located, and which will be impacted by the walkin's thermal load.
-  # @param size_category [String] size category of the building area. Valid choices
-  # are: "<35k ft2", "35k - 50k ft2", ">50k ft2"
-  # @param walkin_type [String] the walkin type/name. For valid choices
-  # refer to the "Refrigerated Walkins" tab on the OpenStudio_Standards spreadsheet.
-  # This parameter is used also by the "Refrigeration System Lineup" tab.
+  # Adds a refrigerated walkin unit to the model
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param thermal_zone [OpenStudio::Model::ThermalZone] the thermal zone where the walkin is located,
+  #   and which will be impacted by the walkin's thermal load.
+  # @param size_category [String] size category of the building area. Valid choices are:
+  #   "<35k ft2", "35k - 50k ft2", ">50k ft2"
+  # @param walkin_type [String] the walkin type/name. For valid choices,
+  #   refer to the "Refrigerated Walkins" tab on the OpenStudio_Standards spreadsheet.
+  #   This parameter is used also by the "Refrigeration System Lineup" tab.
+  # @return [OpenStudio::Model::RefrigerationWalkIn] the walk in refrigerator
   def model_add_refrigeration_walkin(model, thermal_zone, size_category, walkin_type)
     # Get the walkin properties
     search_criteria = {
@@ -343,7 +349,10 @@ class Standard
     return ref_walkin
   end
 
-  # Adds a refrigeration compressor to the model.
+  # Adds a refrigeration compressor to the model
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [OpenStudio::Model::RefrigerationCompressor] the refrigeration compressor
   def model_add_refrigeration_compressor(model, compressor_name)
     # Get the compressor properties
     search_criteria = {
@@ -372,8 +381,9 @@ class Standard
   # Find the thermal zone that is best for adding refrigerated display cases into.
   # First, check for space types that typically have refrigeration.
   # Fall back to largest zone in the model if no typical space types are found.
-  #   # @param model [OpenStudio::Model::Model] the model
-  #   # @return [OpenStudio::Model::ThermalZone] returns a thermal zone if found, nil if not.
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [OpenStudio::Model::ThermalZone] returns a thermal zone if found, nil if not.
   def model_typical_display_case_zone(model)
     # Ideally, look for one of the space types
     # that would typically have refrigeration.
@@ -438,7 +448,8 @@ class Standard
   # Find the thermal zone that is best for adding refrigerated walkins into.
   # First, check for space types that typically have refrigeration.
   # Fall back to largest zone in the model if no typical space types are found.
-  # @param model [OpenStudio::Model::Model] the model
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @return [OpenStudio::Model::ThermalZone] returns a thermal zone if found, nil if not.
   def model_typical_walkin_zone(model)
     # Ideally, look for one of the space types
@@ -506,6 +517,10 @@ class Standard
   # compressors, and condensors.  For small stores, each case and walkin is served
   # by one compressor and one condenser.  For larger stores, all medium temp cases and walkins
   # are served by one multi-compressor rack, and all low temp cases and walkins another.
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param building_type [String] building type
+  # @return [Bool] returns true if successful, false if not
   def model_add_typical_refrigeration(model, building_type)
     # Define system category and scaling factor
     floor_area_ft2 = OpenStudio.convert(model.getBuilding.floorArea, 'm^2', 'ft^2').get
@@ -819,28 +834,28 @@ class Standard
     return true
   end
 
-  # Determine the latent case credit curve to use
-  # for walkins. Defaults to values after 90.1-2007.
-  # @todo Should probably use the model_add_refrigeration_walkin
-  # and lookups from the spreadsheet instead of hard-coded values.
+  # Determine the latent case credit curve to use for walkins. Defaults to values after 90.1-2007.
+  # @todo Should probably use the model_add_refrigeration_walkin and lookups from the spreadsheet instead of hard-coded values
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [Bool] returns true if successful, false if not
   def model_walkin_freezer_latent_case_credit_curve(model)
     latent_case_credit_curve_name = 'Single Shelf Horizontal Latent Energy Multiplier_After2004'
     return latent_case_credit_curve_name
   end
 
-  # Adds a full commercial refrigeration rack, as would be found in a supermarket,
-  # to the model.
+  # Adds a full commercial refrigeration rack to the model, as would be found in a supermarket
+  # @todo Move refrigeration compressors to spreadsheet
   #
-  # @param compressor_type [String] the system temperature range.  valid choices are:
-  # Low Temp, Med Temp
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param compressor_type [String] the system temperature range
+  #   valid choices are Low Temp, Med Temp
   # @param system_name [String] the name of the refrigeration system
-  # @param cases [Array<Hash>] an array of cases with keys:
-  # case_type and space_names.
+  # @param cases [Array<Hash>] an array of cases with keys: case_type and space_names
   # @param walkins [Array<Hashs>] an array of walkins with keys:
-  # walkin_type, space_names, and number_of_walkins
-  # @param thermal_zone [OpenStudio::Model::ThermalZone] the thermal zone where the
-  # refrigeration piping is located.
-  # @todo Move refrigeration compressors to spreadsheet
+  #   walkin_type, space_names, and number_of_walkins
+  # @param thermal_zone [OpenStudio::Model::ThermalZone] the thermal zone where the refrigeration piping is located
+  # @return [Bool] returns true if successful, false if not
   def model_add_refrigeration_system(model,
                                      compressor_type,
                                      system_name,

data/lib/openstudio-standards/prototypes/common/objects/Prototype.utilities.rb

@@ -2,6 +2,9 @@ class Standard
   # @!group utilities
 
   # load a model into OS & version translates, exiting and erroring if a problem is found
+  #
+  # @param model_path_string [String] file path to OpenStudio model file
+  # @return [OpenStudio::Model::Model] OpenStudio model object
   def safe_load_model(model_path_string)
     model_path = OpenStudio::Path.new(model_path_string)
     if OpenStudio.exists(model_path)
@@ -21,6 +24,9 @@ class Standard
   end
 
   # load a sql file, exiting and erroring if a problem is found
+  #
+  # @param sql_path_string [String] file path to sql file
+  # @return [OpenStudio::SqlFile] sql file associated with the model, boolean false if not found
   def safe_load_sql(sql_path_string)
     sql_path = OpenStudio::Path.new(sql_path_string)
     if OpenStudio.exists(sql_path)
@@ -32,6 +38,10 @@ class Standard
     return sql
   end
 
+  # Remove all resource objects in the model
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [OpenStudio::Model::Model] OpenStudio model object
   def strip_model(model)
     # remove all materials
     model.getMaterials.each(&:remove)
@@ -105,12 +115,18 @@ class Standard
   end
 
   # Remove all air loops in model
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [OpenStudio::Model::Model] OpenStudio model object
   def remove_air_loops(model)
     model.getAirLoopHVACs.each(&:remove)
     return model
   end
 
   # Remove plant loops in model except those used for service hot water
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [OpenStudio::Model::Model] OpenStudio model object
   def remove_plant_loops(model)
     plant_loops = model.getPlantLoops
     plant_loops.each do |plant_loop|
@@ -128,12 +144,18 @@ class Standard
   end
 
   # Remove all plant loops in model including those used for service hot water
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [OpenStudio::Model::Model] OpenStudio model object
   def remove_all_plant_loops(model)
     model.getPlantLoops.each(&:remove)
     return model
   end
 
   # Remove VRF units
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [OpenStudio::Model::Model] OpenStudio model object
   def remove_vrf(model)
     model.getAirConditionerVariableRefrigerantFlows.each(&:remove)
     model.getZoneHVACTerminalUnitVariableRefrigerantFlows.each(&:remove)
@@ -141,6 +163,9 @@ class Standard
   end
 
   # Remove zone equipment except for exhaust fans
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [OpenStudio::Model::Model] OpenStudio model object
   def remove_zone_equipment(model)
     model.getThermalZones.each do |zone|
       zone.equipment.each do |equipment|
@@ -155,6 +180,9 @@ class Standard
   end
 
   # Remove all zone equipment including exhaust fans
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [OpenStudio::Model::Model] OpenStudio model object
   def remove_all_zone_equipment(model)
     model.getThermalZones.each do |zone|
       zone.equipment.each(&:remove)
@@ -163,6 +191,9 @@ class Standard
   end
 
   # Remove unused performance curves
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [OpenStudio::Model::Model] OpenStudio model object
   def remove_unused_curves(model)
     model.getCurves.each do |curve|
       if curve.directUseCount == 0
@@ -173,7 +204,10 @@ class Standard
   end
 
   # Remove HVAC equipment except for service hot water loops and zone exhaust fans
-  def remove_HVAC(model)
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [OpenStudio::Model::Model] OpenStudio model object
+  def remove_hvac(model)
     remove_air_loops(model)
     remove_plant_loops(model)
     remove_vrf(model)
@@ -183,7 +217,10 @@ class Standard
   end
 
   # Remove all HVAC equipment including service hot water loops and zone exhaust fans
-  def remove_all_HVAC(model)
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [OpenStudio::Model::Model] OpenStudio model object
+  def remove_all_hvac(model)
     remove_air_loops(model)
     remove_all_plant_loops(model)
     remove_vrf(model)
@@ -252,8 +289,8 @@ class Standard
   # Convert from COP to SEER (with fan) for cooling coils
   # per the method specified in 90.1-2013 Appendix G
   #
-  # @param seer [Double] seasonal energy efficiency ratio (SEER)
-  # @return [Double] Coefficient of Performance (COP)
+  # @param cop [Double] Coefficient of Performance (COP)
+  # @return [Double] seasonal energy efficiency ratio (SEER)
   def cop_to_seer_cooling_with_fan(cop)
     eer = cop_to_eer(cop)
     delta = 1.1088**2 - 4.0 * 0.0182 * eer
@@ -406,21 +443,21 @@ class Standard
   # @param intial_pressure_pa [Double] pressure rise at which initial infiltration rate was determined in Pa
   # @param final_pressure_pa [Double] desired pressure rise to adjust infiltration rate to in Pa
   # @param infiltration_coefficient [Double] infiltration coeffiecient
+  # @return [Double] adjusted infiltration rate in m^3/s
   def adjust_infiltration_to_lower_pressure(initial_infiltration_rate_m3_per_s, intial_pressure_pa, final_pressure_pa, infiltration_coefficient = 0.65)
     adjusted_infiltration_rate_m3_per_s = initial_infiltration_rate_m3_per_s * (final_pressure_pa / intial_pressure_pa)**infiltration_coefficient
 
     return adjusted_infiltration_rate_m3_per_s
   end
 
-  # Convert the infiltration rate at a 75 Pa
-  # to an infiltration rate at the typical value for the prototype buildings
+  # Convert the infiltration rate at a 75 Pa to an infiltration rate at the typical value for the prototype buildings
   # per method described here:  http://www.pnl.gov/main/publications/external/technical_reports/PNNL-18898.pdf
   # Gowri K, DW Winiarski, and RE Jarnagin. 2009.
   # Infiltration modeling guidelines for commercial building energy analysis.
   # PNNL-18898, Pacific Northwest National Laboratory, Richland, WA.
   #
   # @param initial_infiltration_rate_m3_per_s [Double] initial infiltration rate in m^3/s
-  # @return [Double]
+  # @return [Double] adjusted infiltration rate in m^3/s
   def adjust_infiltration_to_prototype_building_conditions(initial_infiltration_rate_m3_per_s)
     # Details of these coefficients can be found in paper
     alpha = 0.22 # unitless - terrain adjustment factor
@@ -487,6 +524,7 @@ class Standard
   # @param max_y [Double] the maximum value of independent variable Y that will be used
   # @param min_out [Double] the minimum value of dependent variable Z
   # @param max_out [Double] the maximum value of dependent variable Z
+  # @return [OpenStudio::Model::CurveBiquadratic] a biquadratic curve
   def create_curve_biquadratic(model, coeffs, crv_name, min_x, max_x, min_y, max_y, min_out, max_out)
     curve = OpenStudio::Model::CurveBiquadratic.new(model)
     curve.setName(crv_name)
@@ -517,6 +555,7 @@ class Standard
   # @param max_y [Double] the maximum value of independent variable Y that will be used
   # @param min_out [Double] the minimum value of dependent variable Z
   # @param max_out [Double] the maximum value of dependent variable Z
+  # @return [OpenStudio::Model::CurveBicubic] a bicubic curve
   def create_curve_bicubic(model, coeffs, crv_name, min_x, max_x, min_y, max_y, min_out, max_out)
     curve = OpenStudio::Model::CurveBicubic.new(model)
     curve.setName(crv_name)
@@ -550,7 +589,8 @@ class Standard
   # @param min_out [Double] the minimum value of dependent variable Z
   # @param max_out [Double] the maximum value of dependent variable Z
   # @param is_dimensionless [Bool] if true, the X independent variable is considered unitless
-  # and the resulting output dependent variable is considered unitless
+  #   and the resulting output dependent variable is considered unitless
+  # @return [OpenStudio::Model::CurveQuadratic] a quadratic curve
   def create_curve_quadratic(model, coeffs, crv_name, min_x, max_x, min_out, max_out, is_dimensionless = false)
     curve = OpenStudio::Model::CurveQuadratic.new(model)
     curve.setName(crv_name)
@@ -578,6 +618,7 @@ class Standard
   # @param max_x [Double] the maximum value of independent variable X that will be used
   # @param min_out [Double] the minimum value of dependent variable Z
   # @param max_out [Double] the maximum value of dependent variable Z
+  # @return [OpenStudio::Model::CurveCubic] a cubic curve
   def create_curve_cubic(coeffs, crv_name, min_x, max_x, min_out, max_out)
     curve = OpenStudio::Model::CurveCubic.new(self)
     curve.setName(crv_name)
@@ -602,6 +643,7 @@ class Standard
   # @param max_x [Double] the maximum value of independent variable X that will be used
   # @param min_out [Double] the minimum value of dependent variable Z
   # @param max_out [Double] the maximum value of dependent variable Z
+  # @return [OpenStudio::Model::CurveExponent] an exponent curve
   def create_curve_exponent(coeffs, crv_name, min_x, max_x, min_out, max_out)
     curve = OpenStudio::Model::CurveExponent.new(self)
     curve.setName(crv_name)
@@ -617,6 +659,7 @@ class Standard
 
   # Gives the total R-value of the interior and exterior (if applicable)
   # film coefficients for a particular type of surface.
+  # @ref [References::ASHRAE9012010] A9.4.1 Air Films
   #
   # @param intended_surface_type [String]
   #   Valid choices:  'AtticFloor', 'AtticWall', 'AtticRoof', 'DemisingFloor', 'InteriorFloor', 'InteriorCeiling',
@@ -627,7 +670,6 @@ class Standard
   # @param int_film [Bool] if true, interior film coefficient will be included in result
   # @param ext_film [Bool] if true, exterior film coefficient will be included in result
   # @return [Double] Returns the R-Value of the film coefficients [m^2*K/W]
-  # @ref [References::ASHRAE9012010] A9.4.1 Air Films
   def film_coefficients_r_value(intended_surface_type, int_film, ext_film)
     # Return zero if both interior and exterior are false
     return 0.0 if !int_film && !ext_film
@@ -683,9 +725,11 @@ class Standard
 
   # Sets VAV reheat and VAV no reheat terminals on an air loop to control for outdoor air
   #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param air_loop [<OpenStudio::Model::AirLoopHVAC>] air loop to enable DCV on.
   #   Default is nil, which will apply to all air loops
-  def set_VAV_terminals_to_control_for_outdoor_air(model, air_loop: nil)
+  # @return [OpenStudio::Model::Model] OpenStudio model object
+  def model_set_vav_terminals_to_control_for_outdoor_air(model, air_loop: nil)
     vav_reheats = model.getAirTerminalSingleDuctVAVReheats
     vav_no_reheats = model.getAirTerminalSingleDuctVAVNoReheats
 
@@ -712,6 +756,9 @@ class Standard
   end
 
   # renames air loop nodes to readable values
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [OpenStudio::Model::Model] OpenStudio model object
   def rename_air_loop_nodes(model)
     # rename all hvac components on air loops
     model.getHVACComponents.sort.each do |component|
@@ -835,6 +882,9 @@ class Standard
   end
 
   # renames plant loop nodes to readable values
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [OpenStudio::Model::Model] OpenStudio model object
   def rename_plant_loop_nodes(model)
     # rename all hvac components on plant loops
     model.getHVACComponents.sort.each do |component|
@@ -914,6 +964,8 @@ class Standard
       plant_loop.supplyInletNode.setName("#{plant_loop_name} Supply Inlet Node")
       plant_loop.supplyOutletNode.setName("#{plant_loop_name} Supply Outlet Node")
     end
+
+    return model
   end
 
   def true?(obj)

data/lib/openstudio-standards/prototypes/common/prototype_metaprogramming.rb

@@ -122,9 +122,15 @@ end
   # Does nothing unless implmented by the specific standard
   def model_reset_or_room_vav_minimum_damper(prototype_input, model)
   end
-  # Does nothing unless implmented by the specific standard
+
+  # update exhuast fan efficiency
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [Bool] returns true if successful, false if not
   def model_update_exhaust_fan_efficiency(model)
+    return true
   end
+
   # Does nothing unless implmented by the specific standard
   def model_update_fan_efficiency(model)
   end
@@ -158,11 +164,14 @@ end
     return lookup_name
   end
 
-  # Makes changes to the daylighting sensors that are too
-  # specific to be coded generically.
+  # daylighting adjustments specific to the prototype model
   #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param building_type [string] the building type
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
+  # @param prototype_input [Hash] hash of prototype inputs
   # @return [Bool] returns true if successful, false if not
-  def model_custom_daylighting_tweaks(building_type, climate_zone, prototype_input, model)
+  def model_custom_daylighting_tweaks(model, building_type, climate_zone, prototype_input)
     return true
   end
 end
@@ -257,8 +266,12 @@ end
   def model_reset_or_room_vav_minimum_damper(prototype_input, model)
   end
 
-  # Does nothing unless implmented by the specific standard
+  # update exhuast fan efficiency
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [Bool] returns true if successful, false if not
   def model_update_exhaust_fan_efficiency(model)
+    return true
   end
 
   # Does nothing unless implmented by the specific standard
@@ -612,8 +625,12 @@ end
   def model_reset_or_room_vav_minimum_damper(prototype_input, model)
   end
 
-  # Does nothing unless implmented by the specific standard
+  # update exhuast fan efficiency
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [Bool] returns true if successful, false if not
   def model_update_exhaust_fan_efficiency(model)
+    return true
   end
 
   # Does nothing unless implmented by the specific standard
@@ -629,36 +646,47 @@ end
     return building_type
   end
 
-  # Makes changes to the HVAC systems that are too
-  # specific to be coded generically.
+  # hvac adjustments specific to the prototype model
   #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param building_type [string] the building type
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
+  # @param prototype_input [Hash] hash of prototype inputs
   # @return [Bool] returns true if successful, false if not
-  def model_custom_hvac_tweaks(building_type, climate_zone, prototype_input, model)
+  def model_custom_hvac_tweaks(model, building_type, climate_zone, prototype_input)
     return true
   end
 
-  # Makes changes to the SWH systems that are too
-  # specific to be coded generically.
+  # swh adjustments specific to the prototype model
   #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param building_type [string] the building type
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
+  # @param prototype_input [Hash] hash of prototype inputs
   # @return [Bool] returns true if successful, false if not
-  def model_custom_swh_tweaks(building_type, climate_zone, prototype_input, model)
+  def model_custom_swh_tweaks(model, building_type, climate_zone, prototype_input)
     return true
   end
 
-  # Makes changes to the geometry that are too
-  # specific to be coded generically.
+  # geometry adjustments specific to the prototype model
   #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param building_type [string] the building type
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
+  # @param prototype_input [Hash] hash of prototype inputs
   # @return [Bool] returns true if successful, false if not
-  def model_custom_geometry_tweaks(building_type, climate_zone, prototype_input, model)
-
+  def model_custom_geometry_tweaks(model, building_type, climate_zone, prototype_input)
     return true
   end
 
-  # Makes changes to the daylighting sensors that are too
-  # specific to be coded generically.
+  # daylighting adjustments specific to the prototype model
   #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param building_type [string] the building type
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
+  # @param prototype_input [Hash] hash of prototype inputs
   # @return [Bool] returns true if successful, false if not
-  def model_custom_daylighting_tweaks(building_type, climate_zone, prototype_input, model)
+  def model_custom_daylighting_tweaks(model, building_type, climate_zone, prototype_input)
     return true
   end
 end
@@ -769,8 +797,12 @@ end
   def model_reset_or_room_vav_minimum_damper(prototype_input, model)
   end
 
-  # Does nothing unless implmented by the specific standard
+  # update exhuast fan efficiency
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [Bool] returns true if successful, false if not
   def model_update_exhaust_fan_efficiency(model)
+    return true
   end
 
   # Does nothing unless implmented by the specific standard
@@ -803,36 +835,47 @@ end
     return lookup_name
   end
 
-  # Makes changes to the HVAC systems that are too
-  # specific to be coded generically.
+  # hvac adjustments specific to the prototype model
   #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param building_type [string] the building type
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
+  # @param prototype_input [Hash] hash of prototype inputs
   # @return [Bool] returns true if successful, false if not
-  def model_custom_hvac_tweaks(building_type, climate_zone, prototype_input, model)
+  def model_custom_hvac_tweaks(model, building_type, climate_zone, prototype_input)
     return true
   end
 
-  # Makes changes to the SWH systems that are too
-  # specific to be coded generically.
+  # swh adjustments specific to the prototype model
   #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param building_type [string] the building type
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
+  # @param prototype_input [Hash] hash of prototype inputs
   # @return [Bool] returns true if successful, false if not
-  def model_custom_swh_tweaks(building_type, climate_zone, prototype_input, model)
+  def model_custom_swh_tweaks(model, building_type, climate_zone, prototype_input)
     return true
   end
 
-  # Makes changes to the geometry that are too
-  # specific to be coded generically.
+  # geometry adjustments specific to the prototype model
   #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param building_type [string] the building type
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
+  # @param prototype_input [Hash] hash of prototype inputs
   # @return [Bool] returns true if successful, false if not
-  def model_custom_geometry_tweaks(building_type, climate_zone, prototype_input, model)
-
+  def model_custom_geometry_tweaks(model, building_type, climate_zone, prototype_input)
     return true
   end
 
-  # Makes changes to the daylighting sensors that are too
-  # specific to be coded generically.
+  # daylighting adjustments specific to the prototype model
   #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param building_type [string] the building type
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
+  # @param prototype_input [Hash] hash of prototype inputs
   # @return [Bool] returns true if successful, false if not
-  def model_custom_daylighting_tweaks(building_type, climate_zone, prototype_input, model)
+  def model_custom_daylighting_tweaks(model, building_type, climate_zone, prototype_input)
     return true
   end
 end

data/lib/openstudio-standards/prototypes/deer/deer.Model.rb

@@ -6,7 +6,7 @@ class DEER
   # only FixedDryBulb economizers are used.
   #
   # @param model [OpenStudio::Model::Model] the model
-  # @param climate_zone [String] the climate zone
+  # @param climate_zone [String] DEER climate zone
   # @return [String] the economizer type.  Possible values are:
   # 'NoEconomizer'
   # 'FixedDryBulb'