openstudio-standards 0.2.14 → 0.2.15.pre.rc1

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

@@ -1,8 +1,14 @@
 # Custom changes for the SmallDataCenterHighITE prototype.
-# These are changes that are inconsistent with other prototype
-# building types.
+# These are changes that are inconsistent with other prototype building types.
 module SmallDataCenterHighITE
-  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 SmallDataCenterHighITE
   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,8 +70,13 @@ module SmallDataCenterHighITE
     end
     # remove normal electric equipment
     model.getElectricEquipments.each(&:remove)
+    return true
   end
 
+  # modify CRAC supply air setpoint manager
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [Bool] returns true if successful, false if not
   def modify_crac_sa_stpt_manager(model)
     supply_temp_sch = get_crac_supply_temp_sch(model)
     model.getSetpointManagerScheduleds.each do |stpt_manager|
@@ -71,8 +84,13 @@ module SmallDataCenterHighITE
 
       stpt_manager.setSchedule(supply_temp_sch)
     end
+    return true
   end
 
+  # get CRAC supply air temperature schedule
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [OpenStudio::Model::Schedule] supply temperature schedule object
   def get_crac_supply_temp_sch(model)
     supply_temp_diff_max = 0
     supply_temp_diff_sch = nil
@@ -110,15 +128,28 @@ module SmallDataCenterHighITE
                                                               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.SmallDataCenterLowITE.rb

@@ -1,8 +1,14 @@
 # Custom changes for the SmallDataCenterLowITE prototype.
-# These are changes that are inconsistent with other prototype
-# building types.
+# These are changes that are inconsistent with other prototype building types.
 module SmallDataCenterLowITE
-  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 SmallDataCenterLowITE
   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
@@ -56,14 +64,18 @@ module SmallDataCenterLowITE
             OpenStudio.logFree(OpenStudio::Info, 'openstudio.standards.SpaceType', "#{space_type.name} set Design Power Input Schedule to #{elec_equip_sch}.")
           end
           it_equipment.setCPULoadingSchedule(model.alwaysOnDiscreteSchedule)
-
         end
       end
     end
     # remove normal electric equipment
     model.getElectricEquipments.each(&:remove)
+    return true
   end
 
+  # modify CRAC supply air setpoint manager
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [Bool] returns true if successful, false if not
   def modify_crac_sa_stpt_manager(model)
     supply_temp_sch = get_crac_supply_temp_sch(model)
     model.getSetpointManagerScheduleds.each do |stpt_manager|
@@ -71,8 +83,13 @@ module SmallDataCenterLowITE
 
       stpt_manager.setSchedule(supply_temp_sch)
     end
+    return true
   end
 
+  # get CRAC supply air temperature schedule
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [OpenStudio::Model::Schedule] supply temperature schedule object
   def get_crac_supply_temp_sch(model)
     supply_temp_diff_max = 0
     supply_temp_diff_sch = nil
@@ -110,15 +127,28 @@ module SmallDataCenterLowITE
                                                               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.SmallHotel.rb

@@ -1,8 +1,14 @@
 # Custom changes for the SmallHotel prototype.
-# These are changes that are inconsistent with other prototype
-# building types.
+# These are changes that are inconsistent with other prototype building types.
 module SmallHotel
-  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 elevator for the elevator coreflr1  (the elevator lift already added via standard spreadsheet)
@@ -26,7 +32,8 @@ module SmallHotel
     end
 
     unless template == 'DOE Ref 1980-2004' || template == 'DOE Ref Pre-1980'
-      # hardsize corridor1. put in standards in the future  #TODO
+      # hardsize corridor1. put in standards in the future
+      # @todo
       model.getZoneHVACPackagedTerminalAirConditioners.sort.each do |ptac|
         zone = ptac.thermalZone.get
         if zone.spaces.include?(corridor_space)
@@ -51,10 +58,19 @@ module SmallHotel
     # Guestroom vacancy controls
     model_add_guestroom_vacancy_controls(model, 'SmallHotel')
 
+    # Guestroom temperature reset schedule delay reduction from 30 min to 20 min
+    model_reduce_setback_sch_delay(model, 'SmallHotel')
+
+    # Guestroom ventilation availability schedule setup
+    model_add_guestroom_vent_sch(model, 'SmallHotel')
+
     return true
   end
 
   # add this for elevator lights/fans (elevator lift is implemented through standard lookup)
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [Bool] returns true if successful, false if not
   def add_extra_equip_elevator_coreflr1(model)
     elevator_coreflr1 = model.getSpaceByName('ElevatorCoreFlr1').get
     elec_equip_def = OpenStudio::Model::ElectricEquipmentDefinition.new(model)
@@ -93,6 +109,10 @@ module SmallHotel
     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?('200gal')
@@ -101,18 +121,31 @@ module SmallHotel
         water_heater.setAmbientTemperatureThermalZone(model.getThermalZoneByName('LaundryRoomFlr1 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, 90.0)
-
     return true
   end
 end

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

@@ -1,10 +1,16 @@
 # Custom changes for the SmallOffice prototype.
-# These are changes that are inconsistent with other prototype
-# building types.
+# These are changes that are inconsistent with other prototype building types.
 module SmallOffice
-  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)
     # add extra infiltration for entry door
-    add_door_infiltration(template, climate_zone, model)
+    add_door_infiltration(climate_zone, model)
     OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', 'Added door infiltration')
 
     # add extra infiltration for attic
@@ -12,198 +18,106 @@ module SmallOffice
     OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', 'Added attic infiltration')
 
     # reset defrost time fraction
-    # TODO: set this to a reasonable defrost time fraction based on research and implement in Prototype.CoilHeatingDXSingleSpeed
+    # @todo set this to a reasonable defrost time fraction based on research and implement in Prototype.CoilHeatingDXSingleSpeed
     model.getCoilHeatingDXSingleSpeeds.each(&:resetDefrostTimePeriodFraction)
-
     return true
   end
 
-  def add_door_infiltration(template, climate_zone, model)
+  # add door infiltration
+  #
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [Bool] returns true if successful, false if not
+  def add_door_infiltration(climate_zone, model)
     # add extra infiltration for entry door in m3/s (there is no attic in 'DOE Ref Pre-1980')
-    unless template == 'DOE Ref 1980-2004' || template == 'DOE Ref Pre-1980'
-      entry_space = model.getSpaceByName('Perimeter_ZN_1').get
-      infiltration_entrydoor = OpenStudio::Model::SpaceInfiltrationDesignFlowRate.new(model)
-      infiltration_entrydoor.setName('entry door Infiltration')
-      infiltration_per_zone_entrydoor = 0
-      if template == '90.1-2004'
+    return false if template == 'DOE Ref 1980-2004' || template == 'DOE Ref Pre-1980'
+
+    entry_space = model.getSpaceByName('Perimeter_ZN_1').get
+    infiltration_entrydoor = OpenStudio::Model::SpaceInfiltrationDesignFlowRate.new(model)
+    infiltration_entrydoor.setName('entry door Infiltration')
+    infiltration_per_zone_entrydoor = 0
+    if template == '90.1-2004'
+      infiltration_per_zone_entrydoor = 0.129785425
+      infiltration_entrydoor.setSchedule(model_add_schedule(model, 'OfficeSmall INFIL_Door_Opening_SCH'))
+    elsif template == '90.1-2007' || template == '90.1-2010' || template == '90.1-2013' || template == '90.1-2016' || template == '90.1-2019'
+      case climate_zone
+      when 'ASHRAE 169-2006-0A',
+           'ASHRAE 169-2006-1A',
+           'ASHRAE 169-2006-0B',
+           'ASHRAE 169-2006-1B',
+           'ASHRAE 169-2006-2A',
+           'ASHRAE 169-2006-2B',
+           'ASHRAE 169-2013-0A',
+           'ASHRAE 169-2013-1A',
+           'ASHRAE 169-2013-0B',
+           'ASHRAE 169-2013-1B',
+           'ASHRAE 169-2013-2A',
+           'ASHRAE 169-2013-2B'
         infiltration_per_zone_entrydoor = 0.129785425
         infiltration_entrydoor.setSchedule(model_add_schedule(model, 'OfficeSmall INFIL_Door_Opening_SCH'))
-      elsif template == '90.1-2007' || template == '90.1-2010' || template == '90.1-2013' || template == '90.1-2016' || template == '90.1-2019'
-        case climate_zone
-        when 'ASHRAE 169-2006-0A',
-             'ASHRAE 169-2006-1A',
-             'ASHRAE 169-2006-0B',
-             'ASHRAE 169-2006-1B',
-             'ASHRAE 169-2006-2A',
-             'ASHRAE 169-2006-2B',
-             'ASHRAE 169-2013-0A',
-             'ASHRAE 169-2013-1A',
-             'ASHRAE 169-2013-0B',
-             'ASHRAE 169-2013-1B',
-             'ASHRAE 169-2013-2A',
-             'ASHRAE 169-2013-2B'
-          infiltration_per_zone_entrydoor = 0.129785425
-          infiltration_entrydoor.setSchedule(model_add_schedule(model, 'OfficeSmall INFIL_Door_Opening_SCH'))
-        else
-          infiltration_per_zone_entrydoor = 0.076455414
-          infiltration_entrydoor.setSchedule(model_add_schedule(model, 'OfficeSmall INFIL_Door_Opening_SCH_2013'))
-        end
+      else
+        infiltration_per_zone_entrydoor = 0.076455414
+        infiltration_entrydoor.setSchedule(model_add_schedule(model, 'OfficeSmall INFIL_Door_Opening_SCH_2013'))
       end
-      infiltration_entrydoor.setDesignFlowRate(infiltration_per_zone_entrydoor)
-      infiltration_entrydoor.setConstantTermCoefficient(1.0)
-      infiltration_entrydoor.setTemperatureTermCoefficient(0.0)
-      infiltration_entrydoor.setVelocityTermCoefficient(0.0)
-      infiltration_entrydoor.setVelocitySquaredTermCoefficient(0.0)
-      infiltration_entrydoor.setSpace(entry_space)
     end
+    infiltration_entrydoor.setDesignFlowRate(infiltration_per_zone_entrydoor)
+    infiltration_entrydoor.setConstantTermCoefficient(1.0)
+    infiltration_entrydoor.setTemperatureTermCoefficient(0.0)
+    infiltration_entrydoor.setVelocityTermCoefficient(0.0)
+    infiltration_entrydoor.setVelocitySquaredTermCoefficient(0.0)
+    infiltration_entrydoor.setSpace(entry_space)
+    return true
   end
 
+  # add attic infiltration
+  #
+  # @param template [String] the model template
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [Bool] returns true if successful, false if not
   def add_attic_infiltration(template, climate_zone, model)
     # add extra infiltration for attic in m3/s (there is no attic in 'DOE Ref Pre-1980')
-    unless template == 'DOE Ref 1980-2004' || template == 'DOE Ref Pre-1980'
-      entry_space = model.getSpaceByName('Attic').get
-      infiltration_attic = OpenStudio::Model::SpaceInfiltrationDesignFlowRate.new(model)
-      infiltration_attic.setName('attic Infiltration')
-      infiltration_per_zone_attic = 0.2001
-      infiltration_attic.setSchedule(model_add_schedule(model, 'Always On'))
-      infiltration_attic.setDesignFlowRate(infiltration_per_zone_attic)
-      infiltration_attic.setConstantTermCoefficient(1.0)
-      infiltration_attic.setTemperatureTermCoefficient(0.0)
-      infiltration_attic.setVelocityTermCoefficient(0.0)
-      infiltration_attic.setVelocitySquaredTermCoefficient(0.0)
-      infiltration_attic.setSpace(entry_space)
-    end
+    return false if template == 'DOE Ref 1980-2004' || template == 'DOE Ref Pre-1980'
+
+    entry_space = model.getSpaceByName('Attic').get
+    infiltration_attic = OpenStudio::Model::SpaceInfiltrationDesignFlowRate.new(model)
+    infiltration_attic.setName('attic Infiltration')
+    infiltration_per_zone_attic = 0.2001
+    infiltration_attic.setSchedule(model_add_schedule(model, 'Always On'))
+    infiltration_attic.setDesignFlowRate(infiltration_per_zone_attic)
+    infiltration_attic.setConstantTermCoefficient(1.0)
+    infiltration_attic.setTemperatureTermCoefficient(0.0)
+    infiltration_attic.setVelocityTermCoefficient(0.0)
+    infiltration_attic.setVelocitySquaredTermCoefficient(0.0)
+    infiltration_attic.setSpace(entry_space)
+    return true
   end
 
   def model_custom_daylighting_tweaks(building_type, climate_zone, prototype_input, model)
-    OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', 'Adjusting daylight sensor positions and fractions')
-
-    adjustments = [
-      { '90.1-2010' => { 'Perimeter_ZN_1' => { 'sensor_1_frac' => 0.02,
-                                               'sensor_2_frac' => 0.1,
-                                               'sensor_1_xyz' => [3.3236, 1.6002, 0.762],
-                                               'sensor_2_xyz' => [8.9611, 1.6002, 0.762] },
-                         'Perimeter_ZN_2' => { 'sensor_1_frac' => 0.06,
-                                               'sensor_2_frac' => 0.15,
-                                               'sensor_1_xyz' => [26.0898, 3.3236, 0.762],
-                                               'sensor_2_xyz' => [26.0898, 9.23, 0.762] },
-                         'Perimeter_ZN_3' => { 'sensor_1_frac' => 0.1,
-                                               'sensor_2_frac' => 0.02,
-                                               'sensor_1_xyz' => [13.8684, 16.8598, 0.762],
-                                               'sensor_2_xyz' => [24.3664, 16.8598, 0.762] },
-                         'Perimeter_ZN_4' => { 'sensor_1_frac' => 0.06,
-                                               'sensor_2_frac' => 0.15,
-                                               'sensor_1_xyz' => [1.6002, 15.1364, 0.762],
-                                               'sensor_2_xyz' => [1.6002, 9.2446, 0.762] } },
-        '90.1-2013' => { 'Perimeter_ZN_1' => { 'sensor_1_frac' => 0.2399,
-                                               'sensor_2_frac' => 0.0302,
-                                               'sensor_1_xyz' => [9.144, 1.6337, 0.762],
-                                               'sensor_2_xyz' => [9.144, 3.2675, 0.762] },
-                         'Perimeter_ZN_2' => { 'sensor_1_frac' => 0.2399,
-                                               'sensor_2_frac' => 0.0302,
-                                               'sensor_1_xyz' => [26.0898, 9.144, 0.762],
-                                               'sensor_2_xyz' => [24.4561, 9.144, 0.762] },
-                         'Perimeter_ZN_3' => { 'sensor_1_frac' => 0.2399,
-                                               'sensor_2_frac' => 0.0302,
-                                               'sensor_1_xyz' => [18.288, 16.825, 0.762],
-                                               'sensor_2_xyz' => [18.288, 15.1925, 0.762] },
-                         'Perimeter_ZN_4' => { 'sensor_1_frac' => 0.2399,
-                                               'sensor_2_frac' => 0.0302,
-                                               'sensor_1_xyz' => [1.6337, 9.144, 0.762],
-                                               'sensor_2_xyz' => [3.2675, 9.144, 0.762] } },
-        '90.1-2016' => { 'Perimeter_ZN_1' => { 'sensor_1_frac' => 0.2399,
-                                               'sensor_2_frac' => 0.0302,
-                                               'sensor_1_xyz' => [9.144, 1.6337, 0.762],
-                                               'sensor_2_xyz' => [9.144, 3.2675, 0.762] },
-                         'Perimeter_ZN_2' => { 'sensor_1_frac' => 0.2399,
-                                               'sensor_2_frac' => 0.0302,
-                                               'sensor_1_xyz' => [26.0898, 9.144, 0.762],
-                                               'sensor_2_xyz' => [24.4561, 9.144, 0.762] },
-                         'Perimeter_ZN_3' => { 'sensor_1_frac' => 0.2399,
-                                               'sensor_2_frac' => 0.0302,
-                                               'sensor_1_xyz' => [18.288, 16.825, 0.762],
-                                               'sensor_2_xyz' => [18.288, 15.1925, 0.762] },
-                         'Perimeter_ZN_4' => { 'sensor_1_frac' => 0.2399,
-                                               'sensor_2_frac' => 0.0302,
-                                               'sensor_1_xyz' => [1.6337, 9.144, 0.762],
-                                               'sensor_2_xyz' => [3.2675, 9.144, 0.762] } },
-        '90.1-2019' => { 'Perimeter_ZN_1' => { 'sensor_1_frac' => 0.2399,
-                                               'sensor_2_frac' => 0.0302,
-                                               'sensor_1_xyz' => [9.144, 1.6337, 0.762],
-                                               'sensor_2_xyz' => [9.144, 3.2675, 0.762] },
-                         'Perimeter_ZN_2' => { 'sensor_1_frac' => 0.2399,
-                                               'sensor_2_frac' => 0.0302,
-                                               'sensor_1_xyz' => [26.0898, 9.144, 0.762],
-                                               'sensor_2_xyz' => [24.4561, 9.144, 0.762] },
-                         'Perimeter_ZN_3' => { 'sensor_1_frac' => 0.2399,
-                                               'sensor_2_frac' => 0.0302,
-                                               'sensor_1_xyz' => [18.288, 16.825, 0.762],
-                                               'sensor_2_xyz' => [18.288, 15.1925, 0.762] },
-                         'Perimeter_ZN_4' => { 'sensor_1_frac' => 0.2399,
-                                               'sensor_2_frac' => 0.0302,
-                                               'sensor_1_xyz' => [1.6337, 9.144, 0.762],
-                                               'sensor_2_xyz' => [3.2675, 9.144, 0.762] } } }
-    ]
-
-    # Adjust daylight sensors in each space
-    model.getSpaces.each do |space|
-      if adjustments[0].keys.include?(template)
-        if adjustments[0][template].keys.include?(space.name.to_s)
-          adj = adjustments[0][template][space.name.to_s]
-          next if space.thermalZone.empty?
-
-          zone = space.thermalZone.get
-          next if space.spaceType.empty?
-
-          spc_type = space.spaceType.get
-          next if spc_type.standardsSpaceType.empty?
-
-          stds_spc_type = spc_type.standardsSpaceType.get
-          # Adjust the primary sensor
-          if adj['sensor_1_frac'] && zone.primaryDaylightingControl.is_initialized
-            OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', "For #{zone.name}: Adjusting primary daylight sensor to control #{adj['sensor_1_frac']} of the lighting.")
-            zone.setFractionofZoneControlledbyPrimaryDaylightingControl(adj['sensor_1_frac'])
-            pri_ctrl = zone.primaryDaylightingControl.get
-            if adj['sensor_1_xyz']
-              x = adj['sensor_1_xyz'][0]
-              y = adj['sensor_1_xyz'][1]
-              z = adj['sensor_1_xyz'][2]
-              OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', "For #{zone.name}: Adjusting primary daylight sensor position to [#{x}, #{y}, #{z}].")
-              pri_ctrl.setPositionXCoordinate(x)
-              pri_ctrl.setPositionYCoordinate(y)
-              pri_ctrl.setPositionZCoordinate(z)
-            end
-          end
-          # Adjust the secondary sensor
-          if adj['sensor_2_frac'] && zone.secondaryDaylightingControl.is_initialized
-            OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', "For #{zone.name}: Adjusting secondary daylight sensor to control #{adj['sensor_2_frac']} of the lighting.")
-            zone.setFractionofZoneControlledbySecondaryDaylightingControl(adj['sensor_2_frac'])
-            sec_ctrl = zone.secondaryDaylightingControl.get
-            if adj['sensor_2_xyz']
-              x = adj['sensor_2_xyz'][0]
-              y = adj['sensor_2_xyz'][1]
-              z = adj['sensor_2_xyz'][2]
-              OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', "For #{zone.name}: Adjusting secondary daylight sensor position to [#{x}, #{y}, #{z}].")
-              sec_ctrl.setPositionXCoordinate(x)
-              sec_ctrl.setPositionYCoordinate(y)
-              sec_ctrl.setPositionZCoordinate(z)
-            end
-          end
-        end
-      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)
     # Set original building North axis
     model_set_building_north_axis(model, 0.0)
-
     return true
   end
 end