openstudio-standards 0.4.0 → 0.5.0

data/lib/openstudio-standards/hvac/setpoint_managers/information.rb

@@ -0,0 +1,91 @@
+# Method to apply a typical CBECS HVAC system to thermal zones
+module OpenstudioStandards
+  module HVAC
+    # @!group Setpoint Managers:Information
+
+    # Get the min and max setpoint values for a setpoint manager
+    #
+    # @param spm [<OpenStudio::Model::SetpointManager>] OpenStudio SetpointManager object
+    # @return [Hash] returns as hash with 'min_temp' and 'max_temp' in degrees Fahrenheit
+    def self.setpoint_manager_min_max_temperature(spm)
+      # use @standard to not build each time
+      std = Standard.build('90.1-2013') # unused; just to access methods
+      # Determine the min and max design temperatures
+      loop_op_min_f = nil
+      loop_op_max_f = nil
+      obj_type = spm.iddObjectType.valueName.to_s
+      case obj_type
+      when 'OS_SetpointManager_Scheduled'
+        sch = spm.to_SetpointManagerScheduled.get.schedule
+        if sch.to_ScheduleRuleset.is_initialized
+          min_c = std.schedule_ruleset_annual_min_max_value(sch.to_ScheduleRuleset.get)['min']
+          max_c = std.schedule_ruleset_annual_min_max_value(sch.to_ScheduleRuleset.get)['max']
+        elsif sch.to_ScheduleConstant.is_initialized
+          min_c = std.schedule_constant_annual_min_max_value(sch.to_ScheduleConstant.get)['min']
+          max_c = std.schedule_constant_annual_min_max_value(sch.to_ScheduleConstant.get)['max']
+        else
+          OpenStudio.logFree(OpenStudio::Error, 'openstudio.model.Model', "Could not find min and max values for #{obj_type} Setpoint Manager.")
+        end
+        loop_op_min_f = OpenStudio.convert(min_c, 'C', 'F').get
+        loop_op_max_f = OpenStudio.convert(max_c, 'C', 'F').get
+      when 'OS_SetpointManager_SingleZone_Reheat'
+        spm = spm.to_SetpointManagerSingleZoneReheat.get
+        loop_op_min_f = OpenStudio.convert(spm.minimumSupplyAirTemperature, 'C', 'F').get
+        loop_op_max_f = OpenStudio.convert(spm.maximumSupplyAirTemperature, 'C', 'F').get
+      when 'OS_SetpointManager_Warmest'
+        spm = spm.to_SetpointManagerWarmest.get
+        loop_op_min_f = OpenStudio.convert(spm.minimumSetpointTemperature, 'C', 'F').get
+        loop_op_max_f = OpenStudio.convert(spm.maximumSetpointTemperature, 'C', 'F').get
+      when 'OS_SetpointManager_WarmestTemperatureFlow'
+        spm = spm.to_SetpointManagerWarmestTemperatureFlow.get
+        loop_op_min_f = OpenStudio.convert(spm.minimumSetpointTemperature, 'C', 'F').get
+        loop_op_max_f = OpenStudio.convert(spm.maximumSetpointTemperature, 'C', 'F').get
+      when 'OS_SetpointManager_Scheduled_DualSetpoint'
+        spm = spm.to_SetpointManagerScheduledDualSetpoint.get
+        # Lowest setpoint is minimum of low schedule
+        low_sch = spm.lowSetpointSchedule
+        unless low_sch.empty?
+          low_sch = low_sch.get
+          min_c = nil
+          if low_sch.to_ScheduleRuleset.is_initialized
+            min_c = std.schedule_ruleset_annual_min_max_value(low_sch.to_ScheduleRuleset.get)['min']
+          elsif low_sch.to_ScheduleConstant.is_initialized
+            min_c = std.schedule_constant_annual_min_max_value(low_sch.to_ScheduleConstant.get)['min']
+          else
+            OpenStudio.logFree(OpenStudio::Error, 'openstudio.model.Model', "Could not find min and max values for #{obj_type} Setpoint Manager.")
+          end
+          loop_op_min_f = OpenStudio.convert(min_c, 'C', 'F').get unless min_c.nil?
+        end
+
+        # highest setpoint it maximum of high schedule
+        high_sch = spm.highSetpointSchedule
+        unless high_sch.empty?
+          high_sch = high_sch.get
+          max_c = nil
+          if high_sch.to_ScheduleRuleset.is_initialized
+            max_c = std.schedule_ruleset_annual_min_max_value(high_sch.to_ScheduleRuleset.get)['max']
+          elsif high_sch.to_ScheduleConstant.is_initialized
+            max_c = std.schedule_constant_annual_min_max_value(high_sch.to_ScheduleConstant.get)['max']
+          else
+            OpenStudio.logFree(OpenStudio::Error, 'openstudio.model.Model', "Could not find min and max values for #{obj_type} Setpoint Manager.")
+          end
+          loop_op_max_f = OpenStudio.convert(max_c, 'C', 'F').get unless max_c.nil?
+        end
+      when 'OS_SetpointManager_OutdoorAirReset'
+        spm = spm.to_SetpointManagerOutdoorAirReset.get
+        temp_1_f = OpenStudio.convert(spm.setpointatOutdoorHighTemperature, 'C', 'F').get
+        temp_2_f = OpenStudio.convert(spm.setpointatOutdoorLowTemperature, 'C', 'F').get
+        loop_op_min_f = [temp_1_f, temp_2_f].min
+        loop_op_max_f = [temp_1_f, temp_2_f].max
+      when 'OS_SetpointManager_FollowOutdoorAirTemperature'
+        spm = spm.to_SetpointManagerFollowOutdoorAirTemperature.get
+        loop_op_min_f = OpenStudio.convert(spm.minimumSetpointTemperature, 'C', 'F').get
+        loop_op_max_f = OpenStudio.convert(spm.maximumSetpointTemperature, 'C', 'F').get
+      else
+        OpenStudio.logFree(OpenStudio::Error, 'openstudio.model.Model', "Could not find min and max values for #{obj_type} Setpoint Manager.")
+      end
+
+      return { 'min_temp' => loop_op_min_f, 'max_temp' => loop_op_max_f }
+    end
+  end
+end

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2004/ashrae_90_1_2004.AirTerminalSingleDuctVAVReheat.rb

@@ -6,7 +6,7 @@ class ASHRAE9012004 < ASHRAE901
   #
   # @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
+  # @return [Boolean] 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 = 0.3
 

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2007/ashrae_90_1_2007.AirTerminalSingleDuctVAVReheat.rb

@@ -6,7 +6,7 @@ class ASHRAE9012007 < ASHRAE901
   #
   # @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
+  # @return [Boolean] 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 = 0.3
 

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2010/ashrae_90_1_2010.AirTerminalSingleDuctVAVReheat.rb

@@ -6,7 +6,7 @@ class ASHRAE9012010 < ASHRAE901
   #
   # @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
+  # @return [Boolean] 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 = case air_terminal_single_duct_vav_reheat_reheat_type(air_terminal_single_duct_vav_reheat)
                           when 'HotWater'

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2010/ashrae_90_1_2010.Model.rb

@@ -3,7 +3,7 @@ class ASHRAE9012010 < ASHRAE901
 
   # Determine the prototypical economizer type for the model.
   #
-  # @param model [OpenStudio::Model::Model] the model
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
   # @return [String] the economizer type.  Possible values are:
   # 'NoEconomizer'

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2013/ashrae_90_1_2013.AirTerminalSingleDuctVAVReheat.rb

@@ -6,7 +6,7 @@ class ASHRAE9012013 < ASHRAE901
   #
   # @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
+  # @return [Boolean] 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 = case air_terminal_single_duct_vav_reheat_reheat_type(air_terminal_single_duct_vav_reheat)
                           when 'HotWater'

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2013/ashrae_90_1_2013.Model.rb

@@ -38,7 +38,7 @@ class ASHRAE9012013 < ASHRAE901
   #
   # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def model_fenestration_orientation(model, climate_zone)
     # Building rotation to meet the same code requirement for
     # 90.1-2010 are kept
@@ -181,7 +181,7 @@ class ASHRAE9012013 < ASHRAE901
   # @note code_sections [90.1-2013_6.5.7.1.2]
   #
   # @param model [OpenStudio::Model::Model] OpenStudio model object
-  # @return [Bool] returns true if transfer air is required, false if not
+  # @return [Boolean] returns true if transfer air is required, false if not
   def model_transfer_air_required?(model)
     # @todo It actually is for kitchen but not implemented yet
     return false

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2013/ashrae_90_1_2013.hvac_systems.rb

@@ -4,7 +4,7 @@ class ASHRAE9012013 < ASHRAE901
   # Determine which type of fan the cooling tower will have.
   # Variable Speed Fan for ASHRAE 90.1-2013.
   #
-  # @param model [OpenStudio::Model::Model] the model
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @return [String] the fan type: TwoSpeed Fan, Variable Speed Fan
   def model_cw_loop_cooling_tower_fan_type(model)
     fan_type = 'Variable Speed Fan'

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2016/ashrae_90_1_2016.AirTerminalSingleDuctVAVReheat.rb

@@ -6,7 +6,7 @@ class ASHRAE9012016 < ASHRAE901
   #
   # @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
+  # @return [Boolean] 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 = case air_terminal_single_duct_vav_reheat_reheat_type(air_terminal_single_duct_vav_reheat)
                           when 'HotWater'

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2016/ashrae_90_1_2016.Model.rb

@@ -1,44 +1,12 @@
 class ASHRAE9012016 < ASHRAE901
   # @!group Model
 
-  # Determine the prototypical economizer type for the model.
-  #
-  # @param model [OpenStudio::Model::Model] OpenStudio model object
-  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
-  # @return [String] the economizer type.  Possible values are:
-  #   'NoEconomizer'
-  #   'FixedDryBulb'
-  #   'FixedEnthalpy'
-  #   'DifferentialDryBulb'
-  #   'DifferentialEnthalpy'
-  #   'FixedDewPointAndDryBulb'
-  #   'ElectronicEnthalpy'
-  #   'DifferentialDryBulbAndEnthalpy'
-  def model_economizer_type(model, climate_zone)
-    economizer_type = case climate_zone
-                      when 'ASHRAE 169-2006-0A',
-                          'ASHRAE 169-2006-1A',
-                          'ASHRAE 169-2006-2A',
-                          'ASHRAE 169-2006-3A',
-                          'ASHRAE 169-2006-4A',
-                          'ASHRAE 169-2013-0A',
-                          'ASHRAE 169-2013-1A',
-                          'ASHRAE 169-2013-2A',
-                          'ASHRAE 169-2013-3A',
-                          'ASHRAE 169-2013-4A'
-                        'DifferentialEnthalpy'
-                      else
-                        'DifferentialDryBulb'
-                      end
-    return economizer_type
-  end
-
   # Adjust model to comply with fenestration orientation requirements
   # @note code_sections [90.1-2013_5.5.4.5]
   #
   # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
-  # @return [Bool] Returns true if successful, false otherwise
+  # @return [Boolean] Returns true if successful, false otherwise
   def model_fenestration_orientation(model, climate_zone)
     # Building rotation to meet the same code requirement for
     # 90.1-2010 are kept
@@ -232,7 +200,7 @@ class ASHRAE9012016 < ASHRAE901
   # @note code_sections [90.1-2016_6.5.7.1]
   #
   # @param model [OpenStudio::Model::Model] OpenStudio model object
-  # @return [Bool] returns true if transfer air is required, false if not
+  # @return [Boolean] returns true if transfer air is required, false if not
   def model_transfer_air_required?(model)
     return true
   end
@@ -263,7 +231,7 @@ class ASHRAE9012016 < ASHRAE901
   # @author Xuechen (Jerry) Lei, PNNL
   #
   # @param model [OpenStudio::Model::Model] OpenStudio Model
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def model_add_lights_shutoff(model)
     zones = model.getThermalZones
     num_zones = 0
@@ -299,7 +267,7 @@ class ASHRAE9012016 < ASHRAE901
       end
 
       # guard clause to skip space with no lights
-      next if space_lights.empty? 
+      next if space_lights.empty?
 
       # if lights are defined at the space type level, clone each lights object and make it individual to the space
       new_space_lights = []

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2016/ashrae_90_1_2016.hvac_systems.rb

@@ -4,7 +4,7 @@ class ASHRAE9012016 < ASHRAE901
   # Determine which type of fan the cooling tower will have.
   # Variable Speed Fan for ASHRAE 90.1-2016.
   #
-  # @param model [OpenStudio::Model::Model] the model
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @return [String] the fan type: TwoSpeed Fan, Variable Speed Fan
   def model_cw_loop_cooling_tower_fan_type(model)
     fan_type = 'Variable Speed Fan'

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2019/ashrae_90_1_2019.AirTerminalSingleDuctVAVReheat.rb

@@ -6,7 +6,7 @@ class ASHRAE9012019 < ASHRAE901
   #
   # @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
+  # @return [Boolean] 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 = case air_terminal_single_duct_vav_reheat_reheat_type(air_terminal_single_duct_vav_reheat)
                           when 'HotWater'

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2019/ashrae_90_1_2019.Model.rb

@@ -1,44 +1,12 @@
 class ASHRAE9012019 < ASHRAE901
   # @!group Model
 
-  # Determine the prototypical economizer type for the model.
-  #
-  # @param model [OpenStudio::Model::Model] OpenStudio model object
-  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
-  # @return [String] the economizer type.  Possible values are:
-  #   'NoEconomizer'
-  #   'FixedDryBulb'
-  #   'FixedEnthalpy'
-  #   'DifferentialDryBulb'
-  #   'DifferentialEnthalpy'
-  #   'FixedDewPointAndDryBulb'
-  #   'ElectronicEnthalpy'
-  #   'DifferentialDryBulbAndEnthalpy'
-  def model_economizer_type(model, climate_zone)
-    economizer_type = case climate_zone
-                      when 'ASHRAE 169-2006-0A',
-                          'ASHRAE 169-2006-1A',
-                          'ASHRAE 169-2006-2A',
-                          'ASHRAE 169-2006-3A',
-                          'ASHRAE 169-2006-4A',
-                          'ASHRAE 169-2013-0A',
-                          'ASHRAE 169-2013-1A',
-                          'ASHRAE 169-2013-2A',
-                          'ASHRAE 169-2013-3A',
-                          'ASHRAE 169-2013-4A'
-                        'DifferentialEnthalpy'
-                      else
-                        'DifferentialDryBulb'
-                      end
-    return economizer_type
-  end
-
   # Adjust model to comply with fenestration orientation requirements
   # @note code_sections [90.1-2013_5.5.4.5]
   #
   # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
-  # @return [Bool] Returns true if successful, false otherwise
+  # @return [Boolean] Returns true if successful, false otherwise
   def model_fenestration_orientation(model, climate_zone)
     # Building rotation to meet the same code requirement for
     # 90.1-2010 are kept
@@ -232,7 +200,7 @@ class ASHRAE9012019 < ASHRAE901
   # @note code_sections [90.1-2019_6.5.7.1]
   #
   # @param model [OpenStudio::Model::Model] OpenStudio model object
-  # @return [Bool] returns true if transfer air is required, false if not
+  # @return [Boolean] returns true if transfer air is required, false if not
   def model_transfer_air_required?(model)
     return true
   end
@@ -263,7 +231,7 @@ class ASHRAE9012019 < ASHRAE901
   # @author Xuechen (Jerry) Lei, PNNL
   #
   # @param model [OpenStudio::Model::Model] OpenStudio Model
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def model_add_lights_shutoff(model)
     zones = model.getThermalZones
     num_zones = 0
@@ -299,7 +267,7 @@ class ASHRAE9012019 < ASHRAE901
       end
 
       # guard clause to skip space with no lights
-      next if space_lights.empty? 
+      next if space_lights.empty?
 
       # if lights are defined at the space type level, clone each lights object and make it individual to the space
       new_space_lights = []

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2019/ashrae_90_1_2019.Space.rb

@@ -3,7 +3,7 @@ class ASHRAE9012019 < ASHRAE901
 
   # Determine if a space should be modeled with an occupancy standby mode
   #
-  # @param space [OpenStudio::model::Space] OpenStudio Space object
+  # @param space [OpenStudio::Model::Space] OpenStudio Space object
   # @return [Boolean] true if occupancy standby mode is to be modeled, false otherwise
   def space_occupancy_standby_mode_required?(space)
     # Get space type
@@ -35,8 +35,8 @@ class ASHRAE9012019 < ASHRAE901
 
   # Modify thermostat schedule to account for a thermostat setback/up
   #
-  # @param thermostat [OpenStudio::model::ThermostatSetpointDualSetpoint] OpenStudio ThermostatSetpointDualSetpoint object
-  # @return [Boolean] true if success
+  # @param thermostat [OpenStudio::Model::ThermostatSetpointDualSetpoint] OpenStudio ThermostatSetpointDualSetpoint object
+  # @return [Boolean] returns true if successful, false if not
   def space_occupancy_standby_mode(thermostat)
     htg_sch = thermostat.getHeatingSchedule.get
     clg_sch = thermostat.getCoolingSchedule.get

data/lib/openstudio-standards/prototypes/ashrae_90_1/ashrae_90_1_2019/ashrae_90_1_2019.hvac_systems.rb

@@ -4,7 +4,7 @@ class ASHRAE9012019 < ASHRAE901
   # Determine which type of fan the cooling tower will have.
   # Variable Speed Fan for ASHRAE 90.1-2019.
   #
-  # @param model [OpenStudio::Model::Model] the model
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @return [String] the fan type: TwoSpeed Fan, Variable Speed Fan
   def model_cw_loop_cooling_tower_fan_type(model)
     fan_type = 'Variable Speed Fan'

data/lib/openstudio-standards/prototypes/ashrae_90_1/doe_ref_1980_2004/doe_ref_1980_2004.AirTerminalSingleDuctVAVReheat.rb

@@ -6,7 +6,7 @@ class DOERef1980to2004 < ASHRAE901
   #
   # @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
+  # @return [Boolean] 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)
     # Set the minimum flow fraction
     min_damper_position = 0.3

data/lib/openstudio-standards/prototypes/ashrae_90_1/doe_ref_1980_2004/doe_ref_1980_2004.Model.elevators.rb

@@ -78,7 +78,7 @@ class DOERef1980to2004 < ASHRAE901
   #
   # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param elevator_type [String] valid choices are Traction, Hydraulic
-  # @param building_type [string] the building type
+  # @param building_type [String] the building type
   # @return [Double] elevator lift power in watts
   def model_elevator_lift_power(model, elevator_type, building_type)
     lift_pwr_w = 0

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

@@ -6,7 +6,7 @@ class DOERefPre1980 < ASHRAE901
   #
   # @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
+  # @return [Boolean] 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)
     # Set the minimum flow fraction
     min_damper_position = 0.3

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

@@ -6,7 +6,7 @@ class DOERefPre1980 < ASHRAE901
   # @todo Refactor: remove inconsistency in logic; all coils should be lower efficiency
   #
   # @param coil_heating_gas [OpenStudio::Model::CoilHeatingGas] a gas heating coil
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def coil_heating_gas_apply_prototype_efficiency(coil_heating_gas)
     # Only modify coils in PSZ-AC units
     name_patterns = ['PSZ-AC Gas Htg Coil',

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

@@ -78,7 +78,7 @@ class DOERefPre1980 < ASHRAE901
   #
   # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param elevator_type [String] valid choices are Traction, Hydraulic
-  # @param building_type [string] the building type
+  # @param building_type [String] the building type
   # @return [Double] elevator lift power in watts
   def model_elevator_lift_power(model, elevator_type, building_type)
     lift_pwr_w = 0

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

@@ -6,7 +6,7 @@ class NRELZNEReady2017 < ASHRAE901
   #
   # @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
+  # @return [Boolean] 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 = case air_terminal_single_duct_vav_reheat_reheat_type(air_terminal_single_duct_vav_reheat)
                           when 'HotWater'

data/lib/openstudio-standards/prototypes/ashrae_90_1/ze_aedg_multifamily/ze_aedg_multifamily.AirTerminalSingleDuctVAVReheat.rb

@@ -6,7 +6,7 @@ class ZEAEDGMultifamily < ASHRAE901
   #
   # @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
+  # @return [Boolean] 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 = case air_terminal_single_duct_vav_reheat_reheat_type(air_terminal_single_duct_vav_reheat)
                           when 'HotWater'

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

@@ -4,10 +4,10 @@ module College
   # hvac adjustments specific to the prototype model
   #
   # @param model [OpenStudio::Model::Model] OpenStudio model object
-  # @param building_type [string] the building type
+  # @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
+  # @return [Boolean] 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')
 
@@ -37,7 +37,7 @@ module College
   #
   # @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
+  # @return [Boolean] returns true if successful, false if not
   def add_door_infiltration(climate_zone, model)
     return false if template == 'DOE Ref 1980-2004' || template == 'DOE Ref Pre-1980'
 
@@ -82,10 +82,10 @@ module College
   # swh adjustments specific to the prototype model
   #
   # @param model [OpenStudio::Model::Model] OpenStudio model object
-  # @param building_type [string] the building type
+  # @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
+  # @return [Boolean] returns true if successful, false if not
   def model_custom_swh_tweaks(model, building_type, climate_zone, prototype_input)
     return true
   end
@@ -93,10 +93,10 @@ module College
   # geometry adjustments specific to the prototype model
   #
   # @param model [OpenStudio::Model::Model] OpenStudio model object
-  # @param building_type [string] the building type
+  # @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
+  # @return [Boolean] returns true if successful, false if not
   def model_custom_geometry_tweaks(model, building_type, climate_zone, prototype_input)
     return true
   end

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

@@ -4,10 +4,10 @@ module Courthouse
   # hvac adjustments specific to the prototype model
   #
   # @param model [OpenStudio::Model::Model] OpenStudio model object
-  # @param building_type [string] the building type
+  # @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
+  # @return [Boolean] 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')
 
@@ -37,7 +37,7 @@ module Courthouse
   #
   # @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
+  # @return [Boolean] 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')
     return false if template == 'DOE Ref 1980-2004' || template == 'DOE Ref Pre-1980'
@@ -67,7 +67,7 @@ module Courthouse
   # update water heater loss coefficient
   #
   # @param model [OpenStudio::Model::Model] OpenStudio model object
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def update_waterheater_loss_coefficient(model)
     case template
     when '90.1-2004', '90.1-2007', '90.1-2010', '90.1-2013', 'NECB 2011'
@@ -82,10 +82,10 @@ module Courthouse
   # swh adjustments specific to the prototype model
   #
   # @param model [OpenStudio::Model::Model] OpenStudio model object
-  # @param building_type [string] the building type
+  # @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
+  # @return [Boolean] returns true if successful, false if not
   def model_custom_swh_tweaks(model, building_type, climate_zone, prototype_input)
     update_waterheater_loss_coefficient(model)
 
@@ -95,10 +95,10 @@ module Courthouse
   # geometry adjustments specific to the prototype model
   #
   # @param model [OpenStudio::Model::Model] OpenStudio model object
-  # @param building_type [string] the building type
+  # @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
+  # @return [Boolean] returns true if successful, false if not
   def model_custom_geometry_tweaks(model, building_type, climate_zone, prototype_input)
     return true
   end