openstudio-standards 0.2.14 → 0.2.15.pre.rc1

data/lib/openstudio-standards/prototypes/common/buildings/Prototype.Hospital.rb

@@ -1,8 +1,14 @@
 # Custom changes for the Hospital prototype.
-# These are changes that are inconsistent with other prototype
-# building types.
+# These are changes that are inconsistent with other prototype building types.
 module Hospital
-  def model_custom_hvac_tweaks(building_type, climate_zone, prototype_input, model)
+  # 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(model, building_type, climate_zone, prototype_input)
     OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', 'Started building type specific HVAC adjustments')
 
     # add transformer
@@ -125,6 +131,9 @@ module Hospital
   end
 
   # add extra equipment for kitchen
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [Bool] returns true if successful, false if not
   def add_extra_equip_kitchen(model)
     kitchen_space = model.getSpaceByName('Kitchen_Flr_5')
     kitchen_space = kitchen_space.get
@@ -141,12 +150,15 @@ module Hospital
         elec_equip_def2.setFractionLatent(0)
         elec_equip_def2.setFractionRadiant(0.25)
         elec_equip_def2.setFractionLost(0)
-        if template == '90.1-2013' || template == '90.1-2016' || template == '90.1-2019'
+        if template == '90.1-2013' || template == '90.1-2016'
           elec_equip_def1.setDesignLevel(915)
           elec_equip_def2.setDesignLevel(855)
+        elsif template == '90.1-2019'
+          elec_equip_def1.setDesignLevel(555)
+          elec_equip_def2.setDesignLevel(470)
         else
-          elec_equip_def1.setDesignLevel(915)
-          elec_equip_def2.setDesignLevel(855)
+          elec_equip_def1.setDesignLevel(1031.8)
+          elec_equip_def2.setDesignLevel(1277.5)
         end
         # Create the electric equipment instance and hook it up to the space type
         elec_equip1 = OpenStudio::Model::ElectricEquipment.new(elec_equip_def1)
@@ -158,8 +170,13 @@ module Hospital
         elec_equip1.setSchedule(model_add_schedule(model, 'Hospital ALWAYS_ON'))
         elec_equip2.setSchedule(model_add_schedule(model, 'Hospital ALWAYS_ON'))
     end
+    return true
   end
 
+  # update water heater ambient conditions
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [Bool] returns true if successful, false if not
   def update_waterheater_ambient_parameters(model)
     model.getWaterHeaterMixeds.sort.each do |water_heater|
       if water_heater.name.to_s.include?('300gal')
@@ -172,15 +189,26 @@ module Hospital
         water_heater.setAmbientTemperatureThermalZone(model.getThermalZoneByName('Kitchen_Flr_5 ZN').get)
       end
     end
+    return true
   end
 
+  # 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(model, building_type, climate_zone, prototype_input)
     update_waterheater_ambient_parameters(model)
 
     return true
   end
 
-  # add swh
+  # reset kitchen outdoor air
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [Bool] returns true if successful, false if not
   def reset_kitchen_oa(model)
     space_kitchen = model.getSpaceByName('Kitchen_Flr_5').get
     ventilation = space_kitchen.designSpecificationOutdoorAir.get
@@ -192,8 +220,13 @@ module Hospital
       when '90.1-2004', '90.1-2007', 'DOE Ref Pre-1980', 'DOE Ref 1980-2004'
         ventilation.setOutdoorAirFlowRate(3.776)
     end
+    return true
   end
 
+  # 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)
     case template
       when '90.1-2004', '90.1-2007', '90.1-2010', '90.1-2013', '90.1-2016', '90.1-2019'
@@ -207,8 +240,15 @@ module Hospital
           exhaust_fan.setPressureRise(125)
         end
     end
+    return true
   end
 
+  # add humidifier
+  #
+  # @param space_name [String] space name
+  # @param hot_water_loop [OpenStudio::Model::PlantLoop] hot water loop
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [Bool] returns true if successful, false if not
   def add_humidifier(space_name, hot_water_loop, model)
     space = model.getSpaceByName(space_name).get
     zone = space.thermalZone.get
@@ -249,17 +289,26 @@ module Hospital
         humidity_spm.setControlZone(zone)
       end
     end
+    return true
   end
 
+  # add daylighting controls
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [Bool] returns true if successful, false if not
   def model_add_daylighting_controls(model)
     space_names = ['Office1_Flr_5', 'Office3_Flr_5', 'Lobby_Records_Flr_1']
     space_names.each do |space_name|
       space = model.getSpaceByName(space_name).get
       space_add_daylighting_controls(space, false, false)
     end
+    return true
   end
 
   # For operating room 1&2 in 2010 and 2013, VAV minimum air flow is set by schedule
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [Bool] returns true if successful, false if not
   def model_adjust_vav_minimum_damper(model)
     model.getThermalZones.each do |zone|
       air_terminal = zone.airLoopHVACTerminal
@@ -292,8 +341,14 @@ module Hospital
         end
       end
     end
+    return true
   end
 
+  # reset room vav damper minimums
+  #
+  # @param prototype_input [Hash] hash of prototype inputs
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [Bool] returns true if successful, false if not
   def model_reset_or_room_vav_minimum_damper(prototype_input, model)
     case template
     when '90.1-2010', '90.1-2013', '90.1-2016', '90.1-2019'
@@ -308,11 +363,14 @@ module Hospital
           air_terminal.setMinimumAirFlowFractionSchedule(model_add_schedule(model, 'Hospital OR_MinSA_Sched'))
         end
       end
-    else
-      return true
     end
+    return true
   end
 
+  # certain air handlers do not have an economizer
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [Bool] returns true if successful, false if not
   def model_modify_oa_controller(model)
     model.getAirLoopHVACs.sort.each do |air_loop|
       oa_sys = air_loop.airLoopHVACOutdoorAirSystem.get
@@ -322,15 +380,30 @@ module Hospital
           oa_control.setEconomizerControlType('NoEconomizer')
       end
     end
+    return true
   end
 
-  def model_custom_geometry_tweaks(building_type, climate_zone, prototype_input, model)
+  # 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(model, building_type, climate_zone, prototype_input)
     # Set original building North axis
     model_set_building_north_axis(model, 0.0)
-
     return true
   end
 
+  # @!group AirTerminalSingleDuctVAVReheat
+  # Set the initial minimum damper position based on OA rate of the space and the template.
+  # Zones with low OA per area get lower initial guesses.
+  # Final position will be adjusted upward as necessary by Standards.AirLoopHVAC.apply_minimum_vav_damper_positions
+  #
+  # @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 = template == '90.1-2010' || template == '90.1-2013' || template == '90.1-2016' || template == '90.1-2019' ? 0.2 : 0.3
 
@@ -342,7 +415,7 @@ module Hospital
 
   # Type of SAT reset for this building type
   #
-  # @param air_loop_hvac [OpenStudio::model::AirLoopHVAC] Airloop
+  # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
   # @return [String] Returns type of SAT reset
   def air_loop_hvac_supply_air_temperature_reset_type(air_loop_hvac)
     return 'oa'

data/lib/openstudio-standards/prototypes/common/buildings/Prototype.Laboratory.rb

@@ -1,41 +1,27 @@
 # Custom changes for the Laboratory prototype.
-# These are changes that are inconsistent with other prototype
-# building types.
+# These are changes that are inconsistent with other prototype building types.
 module Laboratory
-  def model_custom_hvac_tweaks(building_type, climate_zone, prototype_input, model)
+  # 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(model, building_type, climate_zone, prototype_input)
     OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', 'Started building type specific adjustments')
 
-    reset_fume_hood_oa(model)
-    adjust_doas_sizing_system(model)
-    set_oa_control_for_lab_terminals(model)
-
-    # TODO
-    # # Add exhaust fan to fume hood zone
-    # search_criteria = ...
-    # fume_hood_space = model_find_object(standards_data['Space Types'], search_criteria)
-    # fume_hood_zone_volume = fume_hood_space.getVolume...
-    # flow_rate_fume_hood = fume_hood_zone_volume * fume_hood_space['Ventilation_Air_Changes...']
-    # model_add_exhaust_fan(model, thermal_zones, flow_rate=flow_rate_fume_hood,  flow_fraction_schedule_name='Lab_FumeHood_Sch')
-
-    OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', 'Finished building type specific adjustments')
-
-    return true
-  end
-
-  # For fume hood, the OA rate varies with the fume hood schedule
-  # So add "Proportional Control Minimum Outdoor Air Flow Rate Schedule"
-  # at the mean time, modify "Outdoor Air Method" to "ProportionalControlBasedOnDesignOARate" in Controller:MechanicalVentilation of the DOAS
-  def reset_fume_hood_oa(model)
-    fume_hood_spaces = []
+    # For fume hood, the OA rate varies with the fume hood schedule
+    # So add "Proportional Control Minimum Outdoor Air Flow Rate Schedule"
+    # at the mean time, modify "Outdoor Air Method" to "ProportionalControlBasedOnDesignOARate" in Controller:MechanicalVentilation of the DOAS
     model.getSpaces.each do |space|
       next unless space.name.get.to_s.include? 'fumehood'
 
       ventilation = space.designSpecificationOutdoorAir.get
       ventilation.setOutdoorAirFlowRateFractionSchedule(model_add_schedule(model, 'Lab_FumeHood_Sch'))
     end
-  end
 
-  def adjust_doas_sizing_system(model)
+    # adjust doas sizing
     model.getAirLoopHVACs.each do |air_loop|
       if air_loop.name.to_s.include? 'OA'
         # system sizing
@@ -43,18 +29,29 @@ module Laboratory
         sizing_system.setTypeofLoadtoSizeOn('Sensible')
       end
     end
-  end
 
-  def set_oa_control_for_lab_terminals(model)
+    # control lab air terminals for outdoor air
     model.getAirTerminalSingleDuctVAVReheats.sort.each do |air_terminal|
       air_terminal_name = air_terminal.name.get
       if air_terminal_name.include?('Lab')
         air_terminal.setControlForOutdoorAir(true)
       end
     end
+
+    # @todo add exhaust fan to fume hood zone
+    #   search_criteria = ...
+    #   fume_hood_space = model_find_object(standards_data['Space Types'], search_criteria)
+    #   fume_hood_zone_volume = fume_hood_space.getVolume...
+    #   flow_rate_fume_hood = fume_hood_zone_volume * fume_hood_space['Ventilation_Air_Changes...']
+    #   model_add_exhaust_fan(model, thermal_zones, flow_rate=flow_rate_fume_hood,  flow_fraction_schedule_name='Lab_FumeHood_Sch')
+    OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', 'Finished building type specific adjustments')
+    return true
   end
 
   # lab zones don't have economizer, the air flow rate is determined by the ventilation requirement
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [Bool] returns true if successful, false if not
   def model_modify_oa_controller(model)
     model.getAirLoopHVACs.sort.each do |air_loop|
       oa_sys = air_loop.airLoopHVACOutdoorAirSystem.get
@@ -63,13 +60,28 @@ module Laboratory
         oa_control.setEconomizerControlType('NoEconomizer')
       end
     end
+    return true
   end
 
+  # 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(model, building_type, climate_zone, prototype_input)
     return true
   end
 
-  def model_custom_geometry_tweaks(building_type, climate_zone, prototype_input, model)
+  # 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(model, building_type, climate_zone, prototype_input)
     return true
   end
 end

data/lib/openstudio-standards/prototypes/common/buildings/Prototype.LargeDataCenterHighITE.rb

@@ -1,8 +1,14 @@
 # Custom changes for the LargeDataCenterHighITE prototype.
-# These are changes that are inconsistent with other prototype
-# building types.
+# These are changes that are inconsistent with other prototype building types.
 module LargeDataCenterHighITE
-  def model_custom_hvac_tweaks(building_type, climate_zone, prototype_input, model)
+  # 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(model, building_type, climate_zone, prototype_input)
     OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', 'Started building type specific adjustments')
 
     # add IT equipment (ITE object) for data center building types
@@ -18,8 +24,10 @@ module LargeDataCenterHighITE
   end
 
   # add IT equipment (ITE object) for data center building types
-  # Normal electric equipment has been added in model_add_load prior to this
-  # will replace with ITE object here
+  # Normal electric equipment has been added in model_add_load prior to this will replace with ITE object here
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [Bool] returns true if successful, false if not
   def add_data_center_load(model)
     model.getSpaceTypes.each do |space_type|
       # Get the standards data
@@ -61,9 +69,10 @@ module LargeDataCenterHighITE
     end
     # remove normal electric equipment
     model.getElectricEquipments.each(&:remove)
+    return true
   end
 
-  # TODO: (maybe) for large data center, if sized AHU is too big, implement multiple AHUs to the same zone.
+  # @todo (maybe) for large data center, if sized AHU is too big, implement multiple AHUs to the same zone.
   # def update_crah_num(building_type,prototype_input,template,model,sizing_run_dir)
   #   # get the chilled water loop
   #   chilled_water_loop = nil
@@ -109,6 +118,10 @@ module LargeDataCenterHighITE
   #   end
   # end
 
+  # modify CRAH supply air setpoint manager
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [Bool] returns true if successful, false if not
   def modify_crah_sa_stpt_manager(model)
     supply_temp_sch = get_crah_supply_temp_sch(model)
     model.getSetpointManagerScheduleds.each do |stpt_manager|
@@ -116,8 +129,13 @@ module LargeDataCenterHighITE
 
       stpt_manager.setSchedule(supply_temp_sch)
     end
+    return true
   end
 
+  # get CRAH supply air temperature schedule
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [OpenStudio::Model::Schedule] supply temperature schedule object
   def get_crah_supply_temp_sch(model)
     supply_temp_diff_max = 0
     supply_temp_diff_sch = nil
@@ -156,15 +174,28 @@ module LargeDataCenterHighITE
                                                               name = 'AHU Supply Temp Sch updated')
       end
     end
-
     return supply_temp_sch
   end
 
+  # 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(model, building_type, climate_zone, prototype_input)
     return true
   end
 
-  def model_custom_geometry_tweaks(building_type, climate_zone, prototype_input, model)
+  # 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(model, building_type, climate_zone, prototype_input)
     return true
   end
 end

data/lib/openstudio-standards/prototypes/common/buildings/Prototype.LargeDataCenterLowITE.rb

@@ -1,8 +1,14 @@
 # Custom changes for the LargeDataCenterLowITE prototype.
-# These are changes that are inconsistent with other prototype
-# building types.
+# These are changes that are inconsistent with other prototype building types.
 module LargeDataCenterLowITE
-  def model_custom_hvac_tweaks(building_type, climate_zone, prototype_input, model)
+  # 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(model, building_type, climate_zone, prototype_input)
     OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', 'Started building type specific adjustments')
 
     # add IT equipment (ITE object) for data center building types
@@ -18,8 +24,10 @@ module LargeDataCenterLowITE
   end
 
   # add IT equipment (ITE object) for data center building types
-  # Normal electric equipment has been added in model_add_load prior to this
-  # will replace with ITE object here
+  # Normal electric equipment has been added in model_add_load prior to this will replace with ITE object here
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [Bool] returns true if successful, false if not
   def add_data_center_load(model)
     model.getSpaceTypes.each do |space_type|
       # Get the standards data
@@ -62,9 +70,10 @@ module LargeDataCenterLowITE
     end
     # remove normal electric equipment
     model.getElectricEquipments.each(&:remove)
+    return true
   end
 
-  # TODO: (maybe) for large data center, if sized AHU is too big, implement multiple AHUs to the same zone.
+  # @todo (maybe) for large data center, if sized AHU is too big, implement multiple AHUs to the same zone.
   # def update_crah_num(building_type,prototype_input,template,model,sizing_run_dir)
   #
   #   # get the chilled water loop
@@ -111,6 +120,10 @@ module LargeDataCenterLowITE
   #   end
   # end
 
+  # modify CRAH supply air setpoint manager
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [Bool] returns true if successful, false if not
   def modify_crah_sa_stpt_manager(model)
     supply_temp_sch = get_crah_supply_temp_sch(model)
     model.getSetpointManagerScheduleds.each do |stpt_manager|
@@ -118,8 +131,13 @@ module LargeDataCenterLowITE
 
       stpt_manager.setSchedule(supply_temp_sch)
     end
+    return true
   end
 
+  # get CRAH supply air temperature schedule
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [OpenStudio::Model::Schedule] supply temperature schedule object
   def get_crah_supply_temp_sch(model)
     supply_temp_diff_max = 0
     supply_temp_diff_sch = nil
@@ -157,15 +175,28 @@ module LargeDataCenterLowITE
                                                               name = 'AHU Supply Temp Sch updated')
       end
     end
-
     return supply_temp_sch
   end
 
+  # 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(model, building_type, climate_zone, prototype_input)
     return true
   end
 
-  def model_custom_geometry_tweaks(building_type, climate_zone, prototype_input, model)
+  # 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(model, building_type, climate_zone, prototype_input)
     return true
   end
 end

data/lib/openstudio-standards/prototypes/common/buildings/Prototype.LargeHotel.rb

@@ -1,8 +1,14 @@
 # Custom changes for the LargeHotel prototype.
-# These are changes that are inconsistent with other prototype
-# building types.
+# These are changes that are inconsistent with other prototype building types.
 module LargeHotel
-  def model_custom_hvac_tweaks(building_type, climate_zone, prototype_input, model)
+  # 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(model, building_type, climate_zone, prototype_input)
     OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', 'Started building type specific HVAC adjustments')
 
     # add transformer
@@ -129,12 +135,19 @@ module LargeHotel
     # Guestroom vacancy controls
     model_add_guestroom_vacancy_controls(model, 'LargeHotel')
 
+    # Guestroom temperature reset schedule delay reduction from 30 min to 20 min
+    model_reduce_setback_sch_delay(model, 'LargeHotel')
+
+    # Guestroom ventilation availability schedule setup
+    model_add_guestroom_vent_sch(model, 'LargeHotel')
+
     return true
   end
 
-  # add hvac
-
   # add extra equipment for kitchen
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [Bool] returns true if successful, false if not
   def add_extra_equip_kitchen(model)
     kitchen_space = model.getSpaceByName('Kitchen_Flr_6')
     kitchen_space = kitchen_space.get
@@ -151,12 +164,15 @@ module LargeHotel
         elec_equip_def2.setFractionLatent(0)
         elec_equip_def2.setFractionRadiant(0.25)
         elec_equip_def2.setFractionLost(0)
-        if template == '90.1-2013' || template == '90.1-2016' || template == '90.1-2019'
+        if template == '90.1-2013' || template == '90.1-2016'
           elec_equip_def1.setDesignLevel(457.7)
           elec_equip_def2.setDesignLevel(285)
+        elsif template == '90.1-2019'
+          elec_equip_def1.setDesignLevel(277.5)
+          elec_equip_def2.setDesignLevel(156.7)
         else
-          elec_equip_def1.setDesignLevel(457.7)
-          elec_equip_def2.setDesignLevel(285)
+          elec_equip_def1.setDesignLevel(515.917)
+          elec_equip_def2.setDesignLevel(425.8)
         end
         # Create the electric equipment instance and hook it up to the space type
         elec_equip1 = OpenStudio::Model::ElectricEquipment.new(elec_equip_def1)
@@ -170,17 +186,26 @@ module LargeHotel
       # elec_equip2.setSchedule(model.alwaysOnDiscreteSchedule)
       # elec_equip2.setSchedule(model.alwaysOffDiscreteSchedule)
     end
+    return true
   end
 
   # Add the daylighting controls for lobby, cafe, dinning and banquet
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [Bool] returns true if successful, false if not
   def model_add_daylighting_controls(model)
     space_names = ['Banquet_Flr_6', 'Dining_Flr_6', 'Cafe_Flr_1', 'Lobby_Flr_1']
     space_names.each do |space_name|
       space = model.getSpaceByName(space_name).get
       space_add_daylighting_controls(space, false, false)
     end
+    return true
   end
 
+  # update water heater ambient conditions
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [Bool] returns true if successful, false if not
   def update_waterheater_ambient_parameters(model)
     model.getWaterHeaterMixeds.sort.each do |water_heater|
       if water_heater.name.to_s.include?('300gal')
@@ -193,20 +218,42 @@ module LargeHotel
         water_heater.setAmbientTemperatureThermalZone(model.getThermalZoneByName('Kitchen_Flr_6 ZN').get)
       end
     end
+    return true
   end
 
+  # 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(model, building_type, climate_zone, prototype_input)
     update_waterheater_ambient_parameters(model)
     return true
   end
 
-  def model_custom_geometry_tweaks(building_type, climate_zone, prototype_input, model)
+  # 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(model, building_type, climate_zone, prototype_input)
     # Set original building North axis
     model_set_building_north_axis(model, 0.0)
-
     return true
   end
 
+  # @!group AirTerminalSingleDuctVAVReheat
+  # Set the initial minimum damper position based on OA rate of the space and the template.
+  # Zones with low OA per area get lower initial guesses.
+  # Final position will be adjusted upward as necessary by Standards.AirLoopHVAC.apply_minimum_vav_damper_positions
+  #
+  # @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 = template == '90.1-2010' || template == '90.1-2013' || template == '90.1-2016' || template == '90.1-2019' ? 0.2 : 0.3
 
@@ -218,15 +265,16 @@ module LargeHotel
 
   # Type of SAT reset for this building type
   #
-  # @param air_loop_hvac [OpenStudio::model::AirLoopHVAC] Airloop
+  # @param air_loop_hvac [OpenStudio::model::AirLoopHVAC] air loop
   # @return [String] Returns type of SAT reset
   def air_loop_hvac_supply_air_temperature_reset_type(air_loop_hvac)
     return 'oa'
   end
 
   # List transfer air target and source zones, and airflow (cfm)
-  #
   # code_sections [90.1-2019_6.5.7.1], [90.1-2016_6.5.7.1]
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @return [Hash] target zones (key) and source zones (value) and air flow (value)
   def model_transfer_air_target_and_source_zones(model)
     model_transfer_air_target_and_source_zones_hash = {