openstudio-standards 0.2.14 → 0.2.15.pre.rc1

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

@@ -1,6 +1,14 @@
 Standard.class_eval do
   # @!group Model
 
+  # creates an openstudio standards version of PNNL/DOE prototype buildings
+  #
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
+  # @param epw_file []
+  # @param sizing_run_dir [String]
+  # @param debug
+  # @param measure_model
+  # @return
   def model_create_prototype_model(climate_zone, epw_file, sizing_run_dir = Dir.pwd, debug = false, measure_model = nil)
     building_type = @instvarbuilding_type
     raise 'no building_type!' if @instvarbuilding_type.nil?
@@ -14,10 +22,6 @@ Standard.class_eval do
         OpenStudio.logFree(OpenStudio::Error, 'Not available', "DOE Reference models for #{@instvarbuilding_type} at   are not available, the measure is disabled for this specific type.")
         return false
       end
-    when 'College'
-      # delete this case statement once the College model is complete
-      OpenStudio.logFree(OpenStudio::Error, 'Not available', 'While this release includes data for colleges, this only an early draft and should not be used for anything other that early testing or work to improve the college prototype.')
-      return false
     end
     # optionally  determine the climate zone from the epw and stat files.
     if climate_zone == 'NECB HDD Method'
@@ -27,7 +31,7 @@ Standard.class_eval do
       epw_file = ''
     end
     model = load_geometry_osm(@geometry_file)
-    model_custom_geometry_tweaks(building_type, climate_zone, @prototype_input, model)
+    model_custom_geometry_tweaks(model, building_type, climate_zone, @prototype_input)
     model.getThermostatSetpointDualSetpoints(&:remove)
     model.getBuilding.setName(self.class.to_s)
     # save new basefile to new geometry folder as class name.
@@ -39,13 +43,13 @@ Standard.class_eval do
     model_modify_surface_convection_algorithm(model)
     model_create_thermal_zones(model, @space_multiplier_map)
     model_add_design_days_and_weather_file(model, climate_zone, epw_file)
-    model_add_hvac(model, @instvarbuilding_type, climate_zone, @prototype_input, epw_file)
+    model_add_hvac(model, @instvarbuilding_type, climate_zone, @prototype_input)
     model_add_constructions(model, @instvarbuilding_type, climate_zone)
     model_fenestration_orientation(model, climate_zone)
-    model_custom_hvac_tweaks(building_type, climate_zone, @prototype_input, model)
+    model_custom_hvac_tweaks(model, building_type, climate_zone, @prototype_input)
     model_add_transfer_air(model)
     model_add_internal_mass(model, @instvarbuilding_type)
-    model_add_swh(model, @instvarbuilding_type, climate_zone, @prototype_input, epw_file)
+    model_add_swh(model, @instvarbuilding_type, @prototype_input)
     model_add_exterior_lights(model, @instvarbuilding_type, climate_zone, @prototype_input)
     model_add_occupancy_sensors(model, @instvarbuilding_type, climate_zone)
     model_add_daylight_savings(model)
@@ -81,9 +85,9 @@ Standard.class_eval do
     model_temp_fix_ems_references(model)
     # Add daylighting controls per standard
     # only four zones in large hotel have daylighting controls
-    # todo: YXC to merge to the main function
+    # @todo YXC to merge to the main function
     model_add_daylighting_controls(model)
-    model_custom_daylighting_tweaks(building_type, climate_zone, @prototype_input, model)
+    model_custom_daylighting_tweaks(model, building_type, climate_zone, @prototype_input)
     model_update_exhaust_fan_efficiency(model)
     model_update_fan_efficiency(model)
     # rename air loop and plant loop nodes for readability
@@ -94,17 +98,19 @@ Standard.class_eval do
     # Add output variables for debugging
     model_request_timeseries_outputs(model) if debug
     # If measure model is passed, then replace measure model with new model created here.
-    if measure_model.nil?
-      return model
-    else
-      model_replace_model(measure_model, model)
-      return measure_model
-    end
+    return model if measure_model.nil?
+
+    model_replace_model(measure_model, model)
+    return measure_model
   end
 
   # Replaces the contents of 'model_to_replace' with the contents of 'new_model.'
   # This method can be used when the memory location of model_to_replace needs
   # to be preserved, for example, when a measure is passed.
+  #
+  # @param model_to_replace [OpenStudio::Model::Model] OpenStudio model object
+  # @param new_model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [OpenStudio::Model::Model] OpenStudio model object
   def model_replace_model(model_to_replace, new_model, runner = nil)
     # remove existing objects from model
     handles = OpenStudio::UUIDVector.new
@@ -116,12 +122,14 @@ Standard.class_eval do
     # put contents of new_model into model_to_replace
     model_to_replace.addObjects(new_model.toIdfFile.objects)
     BTAP.runner_register('Info', "Model name is now #{model_to_replace.building.get.name}.", runner)
+    return model_to_replace
   end
 
   # Replaces all objects in the current model
   # with the objects in the .osm.  Typically used to
   # load a model as a starting point.
   #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param rel_path_to_osm [String] the path to an .osm file, relative to this file
   # @return [Bool] returns true if successful, false if not
   def model_replace_model_from_osm(model, rel_path_to_osm)
@@ -341,8 +349,9 @@ Standard.class_eval do
   # individual space type, this construction set will be created and applied
   # to this space type, overriding the whole-building construction set.
   #
-  # @param building_type [String] the type of building
-  # @param climate_zone [String] the name of the climate zone the building is in
+  # @param model[OpenStudio::Model::Model] OpenStudio Model
+  # @param building_type [String] the building type
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
   # @return [Bool] returns true if successful, false if not
   def model_add_constructions(model, building_type, climate_zone)
     OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', 'Started applying constructions')
@@ -350,8 +359,8 @@ Standard.class_eval do
 
     # The constructions lookup table uses a slightly different list of building types.
     @lookup_building_type = model_get_lookup_name(building_type)
-    # TODO: this is a workaround.  Need to synchronize the building type names
-    # across different parts of the code, including splitting of Office types
+    # @todo this is a workaround.  Need to synchronize the building type names
+    #   across different parts of the code, including splitting of Office types
     case building_type
       when 'SmallOffice', 'MediumOffice', 'LargeOffice', 'SmallOfficeDetailed', 'MediumOfficeDetailed', 'LargeOfficeDetailed'
         new_lookup_building_type = building_type
@@ -526,9 +535,10 @@ Standard.class_eval do
 
   # Creates and sets below grade wall constructions for 90.1 prototype building models. These utilize
   # CFactorUndergroundWallConstruction and require some additional parameters when compared to Construction
+  #
   # @param model[OpenStudio::Model::Model] OpenStudio Model
   # @param climate_zone [string] climate zone as described for prototype models. C-Factor is based on this parameter
-  # @param building_type [string] the type of building
+  # @param building_type [string] the building type
   # @return [void]
   def model_set_below_grade_wall_constructions(model, building_type, climate_zone)
     # Find ground contact wall building category
@@ -603,8 +613,9 @@ Standard.class_eval do
 
   # Searches a model for spaces adjacent to ground. If the slab's perimeter is adjacent to ground, the length is
   # calculated. Used for F-Factor floors that require additional parameters.
+  #
   # @param model [OpenStudio Model] OpenStudio model being modified
-  # @param building_type [string] the type of building
+  # @param building_type [string] the building type
   # @param climate_zone [string] climate zone as described for prototype models. F-Factor is based on this parameter
   def model_set_floor_constructions(model, building_type, climate_zone)
     # Find ground contact wall building category
@@ -631,8 +642,8 @@ Standard.class_eval do
       next if area == 0 # skip floors not adjacent to ground
 
       # Record combination of perimeter and area. Each unique combination requires a FFactorGroundFloorConstruction.
-      # NOTE: periods '.' were causing issues and were therefore removed. Caused E+ error with duplicate names despite
-      #       being different.
+      # @note periods '.' were causing issues and were therefore removed.
+      #   Caused E+ error with duplicate names despite being different.
       f_floor_const_name = "Foundation F #{f_factor_si.round(2)} Perim #{perimeter.round(2)} Area #{area.round(2)}".gsub('.', '')
 
       # Check if the floor construction has been constructed already. If so, look it up in the model
@@ -657,7 +668,7 @@ Standard.class_eval do
   end
 
   # This function returns the space's ground perimeter and area. Assumes only one floor per space!
-  # @param space[OpenStudio::Model::Space]
+  # @param space [OpenStudio::Model::Space] space object
   # @return [Numeric, Numeric]
   def model_get_f_floor_geometry(space)
     perimeter = 0
@@ -696,7 +707,7 @@ Standard.class_eval do
 
   # This function returns the length of intersection between a wall and floor sharing space. Primarily used for
   # FFactorGroundFloorConstruction exposed perimeter calculations.
-  # NOTE: this calculation has a few assumptions:
+  # @note this calculation has a few assumptions:
   # - Floors are flat. This means they have a constant z-axis value.
   # - If a wall shares an edge with a floor, it's assumed that edge intersects with only this floor.
   # - The wall and floor share a common space. This space is assumed to only have one floor!
@@ -769,7 +780,8 @@ Standard.class_eval do
 
   # Adds internal mass objects and constructions based on the building type
   #
-  # @param building_type [String] the type of building
+  # @param model[OpenStudio::Model::Model] OpenStudio Model
+  # @param building_type [String] the building type
   # @return [Bool] returns true if successful, false if not
   def model_add_internal_mass(model, building_type)
     # Assign a material to all internal mass objects
@@ -845,6 +857,7 @@ Standard.class_eval do
     model.getThermalZones.each(&:remove)
 
     # Create a thermal zone for each space in the self
+    thermostat_to_offset = []
     model.getSpaces.sort.each do |space|
       zone = OpenStudio::Model::ThermalZone.new(model)
       zone.setName("#{space.name} ZN")
@@ -871,18 +884,28 @@ Standard.class_eval do
           ideal_loads.addToThermalZone(zone)
         end
       end
+
+      # Modify thermostat schedules if space
+      # has standby mode occupancy requirements
+      if space_occupancy_standby_mode_required?(space)
+        next if thermostat_to_offset.include?(thermostat_clone.name)
+
+        space_occupancy_standby_mode(thermostat_clone)
+        thermostat_to_offset << thermostat_name
+      end
     end
+
     OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', 'Finished creating thermal zones')
- end
+  end
 
   # Loop through thermal zones and model_run(model)  thermal_zone.add_exhaust
   # If kitchen_makeup is "None" then exhaust will be modeled in every kitchen zone without makeup air
   # If kitchen_makeup is "Adjacent" then exhaust will be modeled in every kitchen zone. Makeup air will be provided when there as an adjacent dining,cafe, or cafeteria zone of the same building type.
   # If kitchen_makeup is "Largest Zone" then exhaust will only be modeled in the largest kitchen zone, but the flow rate will be based on the kitchen area for all zones. Makeup air will be modeled in the largest dining,cafe, or cafeteria zone of the same building type.
   #
-  # @param kitchen_makeup [String] Valid choices are
+  # @param kitchen_makeup [String] Valid choices are None, Largest Zone, Adjacent
   # @return [Hash] Hash of newly made exhaust fan objects along with secondary exhaust and zone mixing objects
-  def model_add_exhaust(model, kitchen_makeup = 'Adjacent') # kitchen_makeup options are (None, Largest Zone, Adjacent)
+  def model_add_exhaust(model, kitchen_makeup = 'Adjacent')
     zone_exhaust_fans = {}
 
     # apply use specified kitchen_makup logic
@@ -938,7 +961,7 @@ Standard.class_eval do
           # populate floor area
           space_type_hash[space_type][:effective_floor_area] += space.floorArea * space.multiplier
 
-          # TODO: - populate adjacent zones (need to add methods to space and zone for this)
+          # @todo populate adjacent zones (need to add methods to space and zone for this)
           if kitchen_makeup == 'Adjacent'
             space_type_hash[space_type][:adjacent_zones] << nil
           end
@@ -1053,7 +1076,7 @@ Standard.class_eval do
                 if zones_by_standards.key?(makeup_source) && zones_by_standards[makeup_source].key?(adjacent_zone)
                   first_adjacent_makeup_source = adjacent_zone
 
-                  # TODO: - add in extra arguments for makeup air
+                  # @todo add in extra arguments for makeup air
                   exhaust_makeup_inputs = {}
                   exhaust_makeup_inputs[makeup_target] = {} # for now only one makeup target per zone, but method could have multiple
                   exhaust_makeup_inputs[makeup_target][:source_zone] = first_adjacent_makeup_source
@@ -1098,10 +1121,10 @@ Standard.class_eval do
   end
 
   # Add guestroom vacancy controls
+  # @note code_sections [90.1-2016_6.4.3.3.5]
   #
-  # @code_sections [90.1-2016_6.4.3.3.5]
   # @param model [OpenStudio::Model::Model] OpenStudio model object
-  # @param building_type [String] Building type
+  # @param building_type [String] the building type
   # @return [Boolean] Returns true if successful, false otherwise
   def model_add_guestroom_vacancy_controls(model, building_type)
     # Guestrooms are currently only included in the small and large hotel prototypes
@@ -1174,7 +1197,7 @@ Standard.class_eval do
 
       # Get zone equipment fan
       # Currently prototypes with guestrooms use PTAC and 4PFC
-      # TODO: Implement additional system type (zonal and air loop-based)
+      # @todo Implement additional system type (zonal and air loop-based)
       thermal_zone.equipment.sort.each do |zone_equipment|
         if zone_equipment.to_ZoneHVACPackagedTerminalAirConditioner.is_initialized
           equipment = zone_equipment.to_ZoneHVACPackagedTerminalAirConditioner.get
@@ -1192,7 +1215,7 @@ Standard.class_eval do
                 equipment.supplyAirFan.to_FanVariableVolume.get
               elsif equipment.supplyAirFan.to_FanOnOff.is_initialized
                 equipment.supplyAirFan.to_FanOnOff.get
-        end
+              end
         fan.setAvailabilitySchedule(model_add_schedule(model, 'GuestroomVacantFanSchedule'))
       end
 
@@ -1227,6 +1250,195 @@ Standard.class_eval do
     end
   end
 
+  # Add guestroom ventilation availability schedules based on the thermostat heating setpoint schedules (to infer setback)
+  # Call to this method needs to be place before purge hour implementation of zone ventilation (if any)
+  #
+  # @code_sections [90.1-2019_6.4.3.3.5.2]
+  # @author Xuechen (Jerry) Lei, PNNL
+  # @param model [OpenStudio::Model::Model] OpenStudio Model
+  # @param building_type [String] Building type
+  def model_add_guestroom_vent_sch(model, building_type)
+    return true unless (template == '90.1-2016') || (template == '90.1-2019')
+
+    # Guestrooms are currently only included in the small and large hotel prototypes
+    return true unless (building_type == 'LargeHotel') || (building_type == 'SmallHotel')
+
+    OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', 'Started Adding Guestroom Ventilation Schedules')
+
+    # Define guestroom occupied maps
+    # List of all spaces that represent vacant rooms
+    guestroom_occupied_map = {
+      'LargeHotel' => [
+        'Room_1_Flr_3',
+        'Room_1_Flr_6',
+        'Room_2_Flr_3',
+        'Room_2_Flr_6',
+        'Room_3_Mult9_Flr_6',
+        'Room_4_Mult19_Flr_3',
+        'Room_5_Flr_3',
+        'Room_6_Flr_3'
+      ],
+      'SmallHotel' => [
+        'GuestRoom103',
+        'GuestRoom104',
+        'GuestRoom105',
+        'GuestRoom202_205',
+        'GuestRoom206_208',
+        'GuestRoom209_212',
+        'GuestRoom213',
+        'GuestRoom214',
+        'GuestRoom219',
+        'GuestRoom220_223',
+        'GuestRoom224',
+        'GuestRoom306_308',
+        'GuestRoom309_312',
+        'GuestRoom314',
+        'GuestRoom315_318',
+        'GuestRoom320_323',
+        'GuestRoom401',
+        'GuestRoom409_412',
+        'GuestRoom415_418',
+        'GuestRoom419',
+        'GuestRoom420_423',
+        'GuestRoom424'
+      ]
+    }
+
+    # Extract thermostat schedule as the base for ventilation schedule
+    if building_type == 'LargeHotel'
+      # thermostat_name = 'LargeHotel GuestRoom Thermostat'
+      air_terminals = model.getAirTerminalSingleDuctConstantVolumeNoReheats.sort
+    elsif building_type == 'SmallHotel'
+      # thermostat_name = 'SmallHotel GuestRoom4Occ Thermostat'
+      air_terminals = model.getZoneHVACPackagedTerminalAirConditioners.sort
+    end
+
+    guestroom_htg_schrst, guestroom_clg_schrst = get_occ_guestroom_setpoint_schedules(model)
+
+    # intentionally no check so if anything is wrong, this will break
+    guestroom_htg_sch = guestroom_htg_schrst.to_ScheduleRuleset.get.defaultDaySchedule
+    guestroom_clg_sch = guestroom_clg_schrst.to_ScheduleRuleset.get.defaultDaySchedule
+
+    if guestroom_htg_sch.times != guestroom_clg_sch.times
+      OpenStudio.logFree(OpenStudio::Warn, 'openstudio.model.Model', "#{building_type} Guestroom heating and cooling schedule has different setback times, will use htg for generating the ventilation binary schedule")
+    end
+
+    # Build ventilation binary schedule
+    htg_sch_values = guestroom_htg_sch.values
+    htg_sch_times = guestroom_htg_sch.times
+
+    vent_schrst = OpenStudio::Model::ScheduleRuleset.new(model)
+    vent_schrst.setName("#{building_type}_GuestRoom_Vent_Ctrl_Sch")
+    # add design day values (1)
+    vent_winterdesignday_sch = OpenStudio::Model::ScheduleDay.new(model)
+    vent_winterdesignday_sch.setName("#{building_type}_GuestRoom_Vent_Ctrl_Sch Winter Design Day")
+    model_add_vals_to_sch(model, vent_winterdesignday_sch, 'Constant', [1])
+    vent_schrst.setSummerDesignDaySchedule(vent_winterdesignday_sch)
+    vent_summerdesignday_sch = OpenStudio::Model::ScheduleDay.new(model)
+    vent_summerdesignday_sch.setName("#{building_type}_GuestRoom_Vent_Ctrl_Sch Summer Design Day")
+    model_add_vals_to_sch(model, vent_summerdesignday_sch, 'Constant', [1])
+    vent_schrst.setWinterDesignDaySchedule(vent_summerdesignday_sch)
+
+    # add default ventilation schedule
+    vent_day_sch = vent_schrst.defaultDaySchedule
+    vent_day_sch.setName("#{building_type}_GuestRoom_Vent_Ctrl_Sch Default")
+    vent_day_binary_values = []
+    off_value = htg_sch_values.min
+    htg_sch_values.each do |value|
+      vent_day_binary_values << if value > off_value
+                                  1.0
+                                else
+                                  0.0
+                                end
+    end
+    vent_day_binary_values.each_with_index do |binary_value, i|
+      vent_day_sch.addValue(htg_sch_times[i], binary_value)
+    end
+
+    # link vent schedule to guest room air terminals
+    modified_zones = []
+    air_terminals.each do |airterminal|
+      zone_name = airterminal.name.to_s.strip.split[0]
+      if guestroom_occupied_map[building_type].include? zone_name
+        if building_type == 'LargeHotel'
+          airterminal.setAvailabilitySchedule(vent_schrst)
+        elsif building_type == 'SmallHotel'
+          airterminal.setSupplyAirFanOperatingModeSchedule(vent_schrst)
+        end
+        modified_zones << zone_name
+      end
+    end
+  end
+
+  # Reduce thermostat temperature setpoint delay (when switching from occupied to unoccupied ) by 10 mins
+  #
+  # @code_sections [90.1-2019_6.4.3.3.5.1]
+  # @author Xuechen (Jerry) Lei, PNNL
+  # @param model [OpenStudio::Model::Model] OpenStudio Model
+  # @param building_type [String] Building type
+  def model_reduce_setback_sch_delay(model, building_type)
+    # Guestrooms are currently only included in the small and large hotel prototypes
+    return true unless (building_type == 'LargeHotel') || (building_type == 'SmallHotel')
+
+    # Guestrooms setback schedule delay modifications are only added to 2019
+    return true unless template == '90.1-2019'
+
+    heating_schrst, cooling_schrst = get_occ_guestroom_setpoint_schedules(model)
+    heating_default_day_sch = heating_schrst.defaultDaySchedule
+    schedule_reduce_reset_delay_10min(heating_default_day_sch, heating_default_day_sch.values.min)
+    cooling_default_day_sch = cooling_schrst.defaultDaySchedule
+    schedule_reduce_reset_delay_10min(cooling_default_day_sch, cooling_default_day_sch.values.max)
+  end
+
+  # Helper method for model_add_guestroom_vent_sch and model_reduce_setback_sch_delay
+  # @author Xuechen (Jerry) Lei, PNNL
+  #
+  def get_occ_guestroom_setpoint_schedules(model)
+    thermostats = model.getThermostatSetpointDualSetpoints.sort
+    thermostats.each do |thermostat|
+      next unless thermostat.name.to_s.include? 'GuestRoom'
+
+      heating_schrst = thermostat.heatingSetpointTemperatureSchedule.get.to_ScheduleRuleset.get
+      cooling_schrst = thermostat.coolingSetpointTemperatureSchedule.get.to_ScheduleRuleset.get
+      next unless heating_schrst.name.to_s.include? 'Occ'
+      next unless cooling_schrst.name.to_s.include? 'Occ'
+
+      return heating_schrst, cooling_schrst
+    end
+    return false
+  end
+
+  # Helper method for model_reduce_setback_sch_delay
+  # @author Xuechen (Jerry) Lei, PNNL
+  #
+  def schedule_reduce_reset_delay_10min(sch, off_value)
+    sch_values = sch.values
+    sch_times = sch.times
+    ten_mins = OpenStudio::Time.new(0, 0, 10, 0)
+    new_times = []
+    (0..(sch_values.length - 2)).each do |i|
+      current_time = sch_times[i]
+      current_value = sch_values[i]
+      next_value = sch_values[i + 1]
+      if ((current_value - off_value).abs >= 0.01) && ((next_value - off_value).abs < 0.01) # reduce occupied (current) time by 10 min if next value is off_value
+        new_times << (current_time - ten_mins)
+      else
+        new_times << current_time
+      end
+    end
+    new_times << sch_times[-1]
+
+    # remove old values
+    sch_times.each do |old_time|
+      sch.removeValue(old_time)
+    end
+
+    # add new time
+    (0..(new_times.length - 1)).each do |i|
+      sch.addValue(new_times[i], sch_values[i])
+    end
+  end
+
   # Adds occupancy sensors to certain space types per
   # the PNNL documentation.
   #
@@ -1240,7 +1452,7 @@ Standard.class_eval do
     # currently modeled using different schedules
     # hence this code double counts savings from
     # sensors.
-    # TODO: Move occupancy sensor modeling from
+    # @todo Move occupancy sensor modeling from
     # schedule to code.
     case template
       when 'DOE Ref Pre-1980', 'DOE Ref 1980-2004', '90.1-2004', '90.1-2007', '90.1-2010', '90.1-2013', '90.1-2016', '90.1-2019'
@@ -1340,9 +1552,9 @@ Standard.class_eval do
   #   into lookup table and implement that way instead of hard-coding as
   #   inputs in the spreadsheet.
   def model_add_exterior_lights(model, building_type, climate_zone, prototype_input)
-    # TODO: Standards - translate w/linear foot of facade, door, parking, etc
-    # into lookup table and implement that way instead of hard-coding as
-    # inputs in the spreadsheet.
+    # @todo Standards - translate w/linear foot of facade, door, parking, etc
+    #   into lookup table and implement that way instead of hard-coding as
+    #   inputs in the spreadsheet.
     OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', 'Started adding exterior lights')
 
     # Occupancy Sensing Exterior Lights
@@ -1431,7 +1643,7 @@ Standard.class_eval do
     # modify the infiltration coefficients
     case template
       when 'DOE Ref Pre-1980', 'DOE Ref 1980-2004'
-        # TODO: make this consistent with newer prototypes
+        # @todo make this consistent with newer prototypes
         const_coeff = 1.0
         temp_coeff = 0.0
         velo_coeff = 0.0
@@ -1565,8 +1777,7 @@ Standard.class_eval do
     # Add Economizers
     apply_economizers(climate_zone, model)
 
-    # TODO: What is the logic behind hard-sizing
-    # hot water coil convergence tolerances?
+    # @todo What is the logic behind hard-sizing hot water coil convergence tolerances?
     model.getControllerWaterCoils.sort.each { |obj| controller_water_coil_set_convergence_limits(obj) }
 
     # Adjust defrost curve limits for coil heating dx single speed
@@ -1583,10 +1794,78 @@ Standard.class_eval do
   #
   # @param model [OpenStudio::Model::Model] the model
   def model_apply_prototype_hvac_efficiency_adjustments(model)
+    building_data = model_get_building_climate_zone_and_building_type(model)
+    building_type = building_data['building_type']
+    climate_zone = building_data['climate_zone']
+
     # ERVs
-    # Applies the DOE Prototype Building assumption that ERVs use
-    # enthalpy wheels and therefore exceed the minimum effectiveness specified by 90.1
-    model.getHeatExchangerAirToAirSensibleAndLatents.each { |obj| heat_exchanger_air_to_air_sensible_and_latent_apply_prototype_efficiency(obj) }
+    if building_type == 'MidriseApartment' || building_type == 'HighriseApartment'
+      # Use standalone ERV in dwelling units to provide OA
+      # Loads are met by mechanical cooling and the heating system with a cycling fan
+      model.getAirLoopHVACs.each do |air_loop_hvac|
+        # Find out if air loop has an ERV (i.e. if heat recovery is required)
+        has_erv = false
+        has_erv = true if air_loop_hvac_energy_recovery?(air_loop_hvac)
+
+        serves_res_spc = false
+
+        air_loop_hvac.thermalZones.each do |zone|
+          next unless thermal_zone_residential?(zone)
+
+          oa_cfm_per_ft2 = 0.0578940512546562
+          oa_m3_per_m2 = OpenStudio.convert(OpenStudio.convert(oa_cfm_per_ft2, 'cfm', 'm^3/s').get, '1/ft^2', '1/m^2').get
+          model_add_residential_erv(model, zone, climate_zone, has_erv, oa_m3_per_m2)
+
+          # Shut-off air loop level OA intake
+          oa_controller = air_loop_hvac.airLoopHVACOutdoorAirSystem.get.getControllerOutdoorAir
+          oa_controller.setMinimumOutdoorAirSchedule(model.alwaysOffDiscreteSchedule)
+
+          serves_res_spc = true
+        end
+
+        if has_erv & serves_res_spc
+          # Remove air loop ERV
+          air_loop_hvac_remove_erv(air_loop_hvac)
+        elsif has_erv
+          # Apply regular adjustment if the ERV doesn't serve a residential space
+          oa_sys = nil
+          if air_loop_hvac.airLoopHVACOutdoorAirSystem.is_initialized
+            oa_sys = air_loop_hvac.airLoopHVACOutdoorAirSystem.get
+          else
+            OpenStudio.logFree(OpenStudio::Info, 'openstudio.standards.AirLoopHVAC', "For #{air_loop_hvac.name}, ERV cannot be removed because the system has no OA intake.")
+            return false
+          end
+
+          # Get the existing ERV or create an ERV and add it to the OA system
+          oa_sys.oaComponents.each do |oa_comp|
+            if oa_comp.to_HeatExchangerAirToAirSensibleAndLatent.is_initialized
+              erv = oa_comp.to_HeatExchangerAirToAirSensibleAndLatent.get
+              heat_exchanger_air_to_air_sensible_and_latent_apply_prototype_efficiency(erv)
+            end
+          end
+        end
+      end
+    else
+      # Applies the DOE Prototype Building assumption that ERVs use
+      # enthalpy wheels and therefore exceed the minimum effectiveness specified by 90.1
+      model.getHeatExchangerAirToAirSensibleAndLatents.each { |obj| heat_exchanger_air_to_air_sensible_and_latent_apply_prototype_efficiency(obj) }
+    end
+
+    # Update COP for large office CRAC
+    # Applies the DOE Prototype Building Model (Large Office only)
+    if @instvarbuilding_type == 'LargeOffice'
+      model.getCoilCoolingWaterToAirHeatPumpEquationFits.sort.each do |coil_cooling_water_to_air_heat_pump|
+        if coil_cooling_water_to_air_heat_pump.name.get.downcase.include?('datacenter')
+          cop = coil_cooling_water_to_air_heat_pump_standard_minimum_cop(coil_cooling_water_to_air_heat_pump, rename = false, computer_room_air_conditioner = true)
+          if cop.nil?
+            OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', "COP for #{coil_cooling_water_to_air_heat_pump.name} is not changed")
+          else
+            coil_cooling_water_to_air_heat_pump.setRatedCoolingCoefficientofPerformance(cop)
+          end
+        end
+      end
+    end
+
     return true
   end
 
@@ -2198,7 +2477,7 @@ Standard.class_eval do
   # Defaults to the pre-90.1-2010 assumption of DifferentialDryBulb.
   #
   # @param model [OpenStudio::Model::Model] the model
-  # @param climate_zone [String] the climate zone
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
   # @return [String] the economizer type.  Possible values are:
   # 'NoEconomizer'
   # 'FixedDryBulb'
@@ -2230,7 +2509,7 @@ Standard.class_eval do
         # that exception c to 90.1-2004/7 Section 6.5.1 applies.
         if template == '90.1-2004' || template == '90.1-2007'
           economizer_required = false
-                  end
+        end
         # This exception exist through 90.1-2019, for hospitals
         # see Section 6.5.1 exception 4
         if @instvarbuilding_type == 'Hospital' &&
@@ -2299,17 +2578,18 @@ Standard.class_eval do
   end
 
   # Implement occupancy based lighting level threshold (0.02 W/sqft). This is only for ASHRAE 90.1 2016 onwards.
-  #
-  # @code_sections [90.1-2016_9.4.1.1.h/i]
+  # @note code_sections [90.1-2016_9.4.1.1.h/i]
   # @author Xuechen (Jerry) Lei, PNNL
-  # @param model [OpenStudio::Model::Model] OpenStudio Model
   #
+  # @param model [OpenStudio::Model::Model] OpenStudio Model
+  # @return [Bool] returns true if successful, false if not
   def model_add_lights_shutoff(model)
     return false
   end
 
   # Get building door information to update infiltration
   #
+  # @param model [OpenStudio::Model::Model] OpenStudio Model
   # return [Hash] Door infiltration information
   def get_building_door_info(model)
     get_building_door_info = {}
@@ -2351,8 +2631,8 @@ Standard.class_eval do
 
   # Add door infiltration
   #
-  # @param [OpenStudio:Model::Model] OpenStudio model object
-  # @climate_zone [String] Climate zone
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
   # @return [Boolean] Returns true if successful, false otherwise or not applicable
   def model_add_door_infiltration(model, climate_zone)
     # Get door parameters for the building model
@@ -2456,16 +2736,16 @@ Standard.class_eval do
       end
     end
 
-    if wwr
-      return window_area / wall_area
-    else
-      window_area
-    end
+    return window_area / wall_area if wwr
+
+    # else
+    return window_area
   end
 
   # Adjust model to comply with fenestration orientation
   #
-  # @param [OpenStudio::Model::Model] OpenStudio model object
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
   # @return [Boolean] Returns true if successful, false otherwise
   def model_fenestration_orientation(model, climate_zone)
     return true
@@ -2546,4 +2826,94 @@ Standard.class_eval do
 
     return true
   end
+
+  # Offset values of a schedule
+  # Main usage is for modeling occupancy standby mode
+  # where the thermostat schedule in these mode are
+  # required to setup/back their thermostat setpoints
+  #
+  # @param time_offset_hash [Hash] Hash providing time (key) and schedule value offset (values)
+  # @param schedule [OpenStudio::model::ScheduleRuleset] OpenStudio schedule object
+  # @return [OpenStudio::model::ScheduleRuleset] Modified OpenStudio schedule object
+  def model_offset_schedule_value(schedule, time_offset_hash)
+    offset_sch = schedule.clone(schedule.model).to_ScheduleRuleset.get
+
+    # Get day schedule
+    day_schedules = []
+    default_day_schedule = offset_sch.defaultDaySchedule
+    day_schedules << default_day_schedule
+    offset_sch.scheduleRules.each do |rule|
+      day_schedules << rule.daySchedule
+    end
+
+    # Offset schedule values
+    day_schedules.each do |day_schedule|
+      (0..23).each do |hr|
+        next if !time_offset_hash.key?(hr.to_s)
+
+        t = OpenStudio::Time.new(0, hr, 0, 0)
+
+        # Get schedule value
+        value = day_schedule.getValue(t)
+
+        # Offset schedule value
+        day_schedule.addValue(t, value)
+        t_p_1 = OpenStudio::Time.new(0, hr + 1, 0, 0)
+        day_schedule.addValue(t_p_1, value + time_offset_hash[hr.to_s])
+      end
+    end
+
+    offset_sch.setName("#{schedule.name} - offset")
+    return offset_sch
+  end
+
+  # Set/change values of a schedule
+  # Main usage is for modeling occupancy standby mode
+  # where the thermostat schedule in these mode are
+  # required to setup/back their thermostat setpoints
+  #
+  # @param time_offset_hash [Hash] Hash providing time (key) and schedule value offset (values)
+  # @param schedule [OpenStudio::model::ScheduleRuleset] OpenStudio schedule object
+  # @return [OpenStudio::model::ScheduleRuleset] Modified OpenStudio schedule object
+  def model_set_schedule_value(schedule, time_value_hash)
+    return nil unless schedule.to_ScheduleRuleset.is_initialized
+
+    new_sch = schedule.clone(schedule.model).to_ScheduleRuleset.get
+
+    # Get day schedule
+    day_schedules = []
+    default_day_schedule = new_sch.defaultDaySchedule
+    day_schedules << default_day_schedule
+    new_sch.scheduleRules.each do |rule|
+      day_schedules << rule.daySchedule
+    end
+
+    # Set schedule values
+    day_schedules.each do |day_schedule|
+      (0..23).each do |hr|
+        next if !time_value_hash.key?(hr.to_s)
+
+        t = OpenStudio::Time.new(0, hr, 0, 0)
+
+        # Get schedule value
+        value = day_schedule.getValue(t)
+
+        # Set schedule value
+        day_schedule.addValue(t, value)
+        t_p_1 = OpenStudio::Time.new(0, hr + 1, 0, 0)
+        day_schedule.addValue(t_p_1, time_value_hash[hr.to_s])
+      end
+    end
+
+    new_sch.setName("#{schedule.name} - adjusted")
+    return new_sch
+  end
+
+  # Modify thermostat schedule to account for a thermostat setback/up
+  #
+  # @param thermostat [OpenStudio::model::ThermostatSetpointDualSetpoint] OpenStudio ThermostatSetpointDualSetpoint object
+  # @return [Boolean] true if success
+  def space_occupancy_standby_mode(thermostat)
+    return false
+  end
 end