openstudio-standards 0.2.14 → 0.2.15.pre.rc1

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

@@ -3,17 +3,17 @@ class ASHRAE9012016 < ASHRAE901
 
   # Determine the prototypical economizer type for the model.
   #
-  # @param model [OpenStudio::Model::Model] the model
-  # @param climate_zone [String] the climate zone
+  # @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'
+  #   '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',
@@ -34,10 +34,11 @@ class ASHRAE9012016 < ASHRAE901
   end
 
   # Adjust model to comply with fenestration orientation requirements
+  # @note code_sections [90.1-2013_5.5.4.5]
   #
-  # @code_sections [90.1-2013_5.5.4.5]
-  # @param [OpenStudio::Model::Model] OpenStudio model object
-  # @return [Boolean] Returns true if successful, false otherwise
+  # @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
   def model_fenestration_orientation(model, climate_zone)
     # Building rotation to meet the same code requirement for
     # 90.1-2010 are kept
@@ -228,19 +229,19 @@ class ASHRAE9012016 < ASHRAE901
   end
 
   # Is transfer air required?
+  # @note code_sections [90.1-2016_6.5.7.1]
   #
-  # @code_sections [90.1-2016_6.5.7.1]
   # @param model [OpenStudio::Model::Model] OpenStudio model object
-  # @return [Boolean] true if transfer air is required, false otherwise
+  # @return [Bool] returns true if transfer air is required, false if not
   def model_transfer_air_required?(model)
     return true
   end
 
   # Metal coiling door code minimum infiltration rate at 75 Pa
+  # @note code_sections [90.1-2019_5.4.3.2]
   #
-  # @code_sections [90.1-2019_5.4.3.2]
-  # @param [String] Climate zone
-  # @return [Float] Minimum infiltration rate for metal coiling doors
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
+  # @return [Double] Minimum infiltration rate for metal coiling doors
   def model_door_infil_flow_rate_metal_coiling_cfm_ft2(climate_zone)
     case climate_zone
       when 'ASHRAE 169-2006-7A',
@@ -258,11 +259,11 @@ class ASHRAE9012016 < ASHRAE901
   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)
     zones = model.getThermalZones
     num_zones = 0
@@ -278,7 +279,7 @@ class ASHRAE9012016 < ASHRAE901
     business_sensor.setName('Business_Sensor')
     business_sensor_name = business_sensor.name.to_s
 
-    zones.each do |zone|
+    zones.sort.each do |zone|
       spaces = zone.spaces
       if spaces.length != 1
         puts 'warning, there are more than one spaces in the zone, need to confirm the implementation'

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

@@ -2,8 +2,8 @@ class ASHRAE9012016 < ASHRAE901
   # @!group Pump
 
   # Determine type of pump part load control type
+  # @note code_sections [90.1-2016_6.5.4.2]
   #
-  # @code_sections [90.1-2016_6.5.4.2]
   # @param pump [OpenStudio::Model::PumpVariableSpeed] OpenStudio pump object
   # @param plant_loop_type [String] Type of plant loop
   # @param pump_nominal_hp [Float] Pump nominal horsepower
@@ -76,7 +76,7 @@ class ASHRAE9012016 < ASHRAE901
                'ASHRAE 169-2013-1A'
             threshold = 150
           else
-            OpenStudio.logFree(OpenStudio::Warn, "Pump flow control requirement missing for heating water pumps in climate zone: #{climate_zone}.")
+            OpenStudio.logFree(OpenStudio::Warn, 'openstudio.ashrae_90_1_2016.PumpVariableSpeed', "Pump flow control requirement missing for heating water pumps in climate zone: #{climate_zone}.")
         end
       when 'Cooling'
         case climate_zone
@@ -128,17 +128,16 @@ class ASHRAE9012016 < ASHRAE901
                'ASHRAE 169-2013-8B'
             threshold = 10
           else
-            OpenStudio.logFree(OpenStudio::Warn, "Pump flow control requirement missing for chilled water pumps in climate zone: #{climate_zone}.")
+            OpenStudio.logFree(OpenStudio::Warn, 'openstudio.ashrae_90_1_2016.PumpVariableSpeed', "Pump flow control requirement missing for chilled water pumps in climate zone: #{climate_zone}.")
         end
       else
-        OpenStudio.logFree(OpenStudio::Warn, "No pump flow requirement for #{plant_loop_type} plant loops.")
+        OpenStudio.logFree(OpenStudio::Warn, 'openstudio.ashrae_90_1_2016.PumpVariableSpeed', "No pump flow requirement for #{plant_loop_type} plant loops.")
         return false
     end
 
-    if pump_nominal_hp * design_sizing_factor > threshold
-      return 'VSD DP Reset'
-    else
-      return 'Riding Curve'
-    end
-  end
+    return 'VSD DP Reset' if pump_nominal_hp * design_sizing_factor > threshold
+
+    # else
+    return 'Riding Curve'
   end
+end

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

@@ -1,8 +1,10 @@
 class ASHRAE9012016 < ASHRAE901
   # @!group hvac_systems
 
-  # Determine which type of fan the cooling tower
-  # will have.  Variable Speed Fan for ASHRAE 90.1-2016.
+  # 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
   # @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

@@ -4,7 +4,8 @@ class ASHRAE9012019 < ASHRAE901
   # Zones with low OA per area get lower initial guesses.
   # Final position will be adjusted upward as necessary by Standards.AirLoopHVAC.apply_minimum_vav_damper_positions
   #
-  # @param zone_oa_per_area [Double] the zone outdoor air per area, m^3/s
+  # @param air_terminal_single_duct_vav_reheat [OpenStudio::Model::AirTerminalSingleDuctVAVReheat] the air terminal object
+  # @param zone_oa_per_area [Double] the zone outdoor air per area in m^3/s*m^2
   # @return [Bool] returns true if successful, false if not
   def air_terminal_single_duct_vav_reheat_apply_initial_prototype_damper_position(air_terminal_single_duct_vav_reheat, zone_oa_per_area)
     min_damper_position = case air_terminal_single_duct_vav_reheat_reheat_type(air_terminal_single_duct_vav_reheat)

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

@@ -1,10 +1,11 @@
 class ASHRAE9012019 < ASHRAE901
   # @!group FanConstantVolume
 
-  # Determine the prototype fan pressure rise for a constant volume
-  # fan on an AirLoopHVAC based on the airflow of the system.
-  # @return [Double] the pressure rise (in H2O).  Defaults
-  # to the logic from ASHRAE 90.1-2004 prototypes.
+  # Determine the prototype fan pressure rise for a constant volume fan on an AirLoopHVAC based on system airflow.
+  # Defaults to the logic from ASHRAE 90.1-2004 prototypes.
+  #
+  # @param fan_constant_volume [OpenStudio::Model::FanConstantVolume] constant volume fan object
+  # @return [Double] pressure rise in inches H20
   def fan_constant_volume_airloop_fan_pressure_rise(fan_constant_volume)
     # Get the max flow rate from the fan.
     maximum_flow_rate_m3_per_s = nil

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

@@ -1,11 +1,11 @@
 class ASHRAE9012019 < ASHRAE901
   # @!group FanOnOff
 
-  # Determine the prototype fan pressure rise for an on off
-  # fan on an AirLoopHVAC or inside a unitary system
-  # based on the airflow of the system.
-  # @return [Double] the pressure rise (in H2O).  Defaults
-  # to the logic from ASHRAE 90.1-2004 prototypes.
+  # Determine the prototype fan pressure rise for an on off fan on an AirLoopHVAC or inside a unitary system based on system airflow.
+  # Defaults to the logic from ASHRAE 90.1-2004 prototypes.
+  #
+  # @param fan_on_off [OpenStudio::Model::FanOnOff] on off fan object
+  # @return [Double] pressure rise in inches H20
   def fan_on_off_airloop_or_unitary_fan_pressure_rise(fan_on_off)
     # Get the max flow rate from the fan.
     maximum_flow_rate_m3_per_s = nil

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

@@ -1,10 +1,11 @@
 class ASHRAE9012019 < ASHRAE901
   # @!group FanVariableVolume
 
-  # Determine the prototype fan pressure rise for a variable volume
-  # fan on an AirLoopHVAC based on the airflow of the system.
-  # @return [Double] the pressure rise (in H2O).  Defaults
-  # to the logic from ASHRAE 90.1-2004 prototypes.
+  # Determine the prototype fan pressure rise for a variable volume fan on an AirLoopHVAC based on system airflow.
+  # Defaults to the logic from ASHRAE 90.1-2004 prototypes.
+  #
+  # @param fan_variable_volume [OpenStudio::Model::FanVariableVolume] variable volume fan object
+  # @return [Double] pressure rise in inches H20
   def fan_variable_volume_airloop_fan_pressure_rise(fan_variable_volume)
     # Get the max flow rate from the fan.
     maximum_flow_rate_m3_per_s = nil

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

@@ -1,19 +1,23 @@
 class ASHRAE9012019 < ASHRAE901
   # @!group elevators
 
-  # Determines the percentage of the elevator cab
-  # lighting that is incandescent.  The remainder
-  # is assumed to be LED.  Defaults to 0% incandescent
-  # (100% LED), representing newer elevators.
+  # Determines the percentage of the elevator cab lighting that is incandescent.
+  # The remainder is assumed to be LED.
+  # Defaults to 0% incandescent (100% LED), representing newer elevators.
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [Double] incandescent lighting percentage
   def model_elevator_lighting_pct_incandescent(model)
     pct_incandescent = 0.0 # 100% LED
     return pct_incandescent
   end
 
   # Determines the power of the elevator ventilation fan.
-  # 90.1-2019 has a requirement
-  # for ventilation fan efficiency.
-  # @return [Double] the ventilaton fan power (W)
+  # 90.1-2019 has a requirement for ventilation fan efficiency.
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param vent_rate_cfm [Double] the ventilation rate in ft^3/min
+  # @return [Double] the ventilation fan power in watts
   def model_elevator_fan_pwr(model, vent_rate_cfm)
     vent_pwr_per_flow_w_per_cfm = 0.33
     vent_pwr_w = vent_pwr_per_flow_w_per_cfm * vent_rate_cfm

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

@@ -3,17 +3,17 @@ class ASHRAE9012019 < ASHRAE901
 
   # Determine the prototypical economizer type for the model.
   #
-  # @param model [OpenStudio::Model::Model] the model
-  # @param climate_zone [String] the climate zone
+  # @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'
+  #   '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',
@@ -34,10 +34,11 @@ class ASHRAE9012019 < ASHRAE901
   end
 
   # Adjust model to comply with fenestration orientation requirements
+  # @note code_sections [90.1-2013_5.5.4.5]
   #
-  # @code_sections [90.1-2013_5.5.4.5]
-  # @param [OpenStudio::Model::Model] OpenStudio model object
-  # @return [Boolean] Returns true if successful, false otherwise
+  # @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
   def model_fenestration_orientation(model, climate_zone)
     # Building rotation to meet the same code requirement for
     # 90.1-2010 are kept
@@ -228,19 +229,19 @@ class ASHRAE9012019 < ASHRAE901
   end
 
   # Is transfer air required?
+  # @note code_sections [90.1-2019_6.5.7.1]
   #
-  # @code_sections [90.1-2019_6.5.7.1]
   # @param model [OpenStudio::Model::Model] OpenStudio model object
-  # @return [Boolean] true if transfer air is required, false otherwise
+  # @return [Bool] returns true if transfer air is required, false if not
   def model_transfer_air_required?(model)
     return true
   end
 
   # Metal coiling door code minimum infiltration rate at 75 Pa
+  # @note code_sections [90.1-2019_5.4.3.2]
   #
-  # @code_sections [90.1-2019_5.4.3.2]
-  # @param [String] Climate zone
-  # @return [Float] Minimum infiltration rate for metal coiling doors
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
+  # @return [Double] Minimum infiltration rate for metal coiling doors
   def model_door_infil_flow_rate_metal_coiling_cfm_ft2(climate_zone)
     case climate_zone
       when 'ASHRAE 169-2006-7A',
@@ -258,11 +259,11 @@ class ASHRAE9012019 < ASHRAE901
   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)
     zones = model.getThermalZones
     num_zones = 0
@@ -278,7 +279,7 @@ class ASHRAE9012019 < ASHRAE901
     business_sensor.setName('Business_Sensor')
     business_sensor_name = business_sensor.name.to_s
 
-    zones.each do |zone|
+    zones.sort.each do |zone|
       spaces = zone.spaces
       if spaces.length != 1
         puts 'warning, there are more than one spaces in the zone, need to confirm the implementation'

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

@@ -0,0 +1,89 @@
+class ASHRAE9012019 < ASHRAE901
+  # @!group Pump
+
+  # Determines the minimum pump motor efficiency and nominal size
+  # for a given motor bhp.  This should be the total brake horsepower with
+  # any desired safety factor already included.  This method picks
+  # the next nominal motor catgory larger than the required brake
+  # horsepower, and the efficiency is based on that size.  For example,
+  # if the bhp = 6.3, the nominal size will be 7.5HP and the efficiency
+  # for 90.1-2010 will be 91.7% from Table 10.8B.  This method assumes
+  # 4-pole, 1800rpm totally-enclosed fan-cooled motors.
+  #
+  # @param motor_bhp [Double] motor brake horsepower (hp)
+  # @return [Array<Double>] minimum motor efficiency (0.0 to 1.0), nominal horsepower
+  def pump_standard_minimum_motor_efficiency_and_size(pump, motor_bhp)
+    motor_eff = 0.85
+    nominal_hp = motor_bhp
+
+    # Don't attempt to look up motor efficiency
+    # for zero-hp pumps (required for circulation-pump-free
+    # service water heating systems).
+    return [1.0, 0] if motor_bhp == 0.0
+
+    # Lookup the minimum motor efficiency
+    motors = standards_data['motors']
+
+    # Assuming all pump motors are 4-pole ODP
+    search_criteria = {
+      'template' => template,
+      'number_of_poles' => 4.0,
+      'type' => 'Enclosed'
+    }
+
+    motor_properties = model_find_object(motors, search_criteria, motor_bhp)
+    if motor_properties.nil?
+      OpenStudio.logFree(OpenStudio::Error, 'openstudio.standards.Pump', "For #{pump.name}, could not find motor properties using search criteria: #{search_criteria}, motor_bhp = #{motor_bhp} hp.")
+      return [motor_eff, nominal_hp]
+    end
+
+    motor_eff = motor_properties['nominal_full_load_efficiency']
+    nominal_hp = motor_properties['maximum_capacity'].to_f.round(1)
+    # Round to nearest whole HP for niceness
+    if nominal_hp >= 2
+      nominal_hp = nominal_hp.round
+    end
+
+    # Get the efficiency based on the nominal horsepower
+    # Add 0.01 hp to avoid search errors.
+    motor_properties = model_find_object(motors, search_criteria, nominal_hp + 0.01)
+    if motor_properties.nil?
+      OpenStudio.logFree(OpenStudio::Error, 'openstudio.standards.Fan', "For #{pump.name}, could not find nominal motor properties using search criteria: #{search_criteria}, motor_hp = #{nominal_hp} hp.")
+      return [motor_eff, nominal_hp]
+    end
+    motor_eff = motor_properties['nominal_full_load_efficiency']
+
+    # Get flow rate (whether autosized or hard-sized)
+    flow_m3_per_s = 0
+    flow_m3_per_s = if pump.to_PumpVariableSpeed.is_initialized || pump.to_PumpConstantSpeed.is_initialized
+                      if pump.autosizedRatedFlowRate.is_initialized
+                        pump.autosizedRatedFlowRate.get
+                      else
+                        pump.ratedFlowRate.get
+                      end
+                    elsif pump.to_HeaderedPumpsVariableSpeed.is_initialized || pump.to_HeaderedPumpsConstantSpeed.is_initialized
+                      if pump.autosizedTotalRatedFlowRate.is_initialized
+                        pump.autosizedTotalRatedFlowRate.get / pump.numberofPumpsinBank
+                      else
+                        pump.totalRatedFlowRate.get / pump.numberofPumpsinBank
+                      end
+                    end
+    flow_gpm = OpenStudio.convert(flow_m3_per_s, 'm^3/s', 'gal/min').get
+
+    # Adjustment for clean water pumps requirement:
+    # The adjustment is made based on results included
+    # in https://www.energy.gov/sites/prod/files/2015/12/f28/Pumps%20ECS%20Final%20Rule.pdf
+    # Table 1 summarizes final rule efficiency levels
+    # analyzed with corresponding C-values. With the
+    # rulemaking adopted TSL/EL2 from the report, it shows
+    # about 4.3% of average efficiency improvement, and after
+    # considering 25% of the market, about 1.1% of the
+    # final average efficiency improvement is estimated.
+    #
+    # The clean water pump requirement is only
+    # applied to pumps with a flow rate of at least 25 gpm
+    motor_eff *= 1.011 unless flow_gpm < 25.0
+
+    return [motor_eff, nominal_hp]
+  end
+end

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

@@ -2,8 +2,8 @@ class ASHRAE9012019 < ASHRAE901
   # @!group Pump
 
   # Determine type of pump part load control type
+  # @note code_sections [90.1-2019_6.5.4.2]
   #
-  # @code_sections [90.1-2019_6.5.4.2]
   # @param pump [OpenStudio::Model::PumpVariableSpeed] OpenStudio pump object
   # @param plant_loop_type [String] Type of plant loop
   # @param pump_nominal_hp [Float] Pump nominal horsepower
@@ -76,7 +76,7 @@ class ASHRAE9012019 < ASHRAE901
                'ASHRAE 169-2013-1A'
             threshold = 150
           else
-            OpenStudio.logFree(OpenStudio::Warn, "Pump flow control requirement missing for heating water pumps in climate zone: #{climate_zone}.")
+            OpenStudio.logFree(OpenStudio::Warn, 'openstudio.ashrae_90_1_2019.PumpVariableSpeed', "Pump flow control requirement missing for heating water pumps in climate zone: #{climate_zone}.")
         end
       when 'Cooling'
         case climate_zone
@@ -128,17 +128,16 @@ class ASHRAE9012019 < ASHRAE901
                'ASHRAE 169-2013-8B'
             threshold = 10
           else
-            OpenStudio.logFree(OpenStudio::Warn, "Pump flow control requirement missing for chilled water pumps in climate zone: #{climate_zone}.")
+            OpenStudio.logFree(OpenStudio::Warn, 'openstudio.ashrae_90_1_2019.PumpVariableSpeed', "Pump flow control requirement missing for chilled water pumps in climate zone: #{climate_zone}.")
         end
       else
-        OpenStudio.logFree(OpenStudio::Warn, "No pump flow requirement for #{plant_loop_type} plant loops.")
+        OpenStudio.logFree(OpenStudio::Warn, 'openstudio.ashrae_90_1_2019.PumpVariableSpeed', "No pump flow requirement for #{plant_loop_type} plant loops.")
         return false
     end
 
-    if pump_nominal_hp * design_sizing_factor > threshold
-      return 'VSD DP Reset'
-    else
-      return 'Riding Curve'
-    end
-  end
+    return 'VSD DP Reset' if pump_nominal_hp * design_sizing_factor > threshold
+
+    # else
+    return 'Riding Curve'
   end
+end

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

@@ -0,0 +1,76 @@
+class ASHRAE9012019 < ASHRAE901
+  # @!group Space
+
+  # Determine if a space should be modeled with an occupancy standby mode
+  #
+  # @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
+    return false if space.spaceType.empty?
+
+    space_type = space.spaceType.get
+
+    # Get standards space type
+    return false if space_type.standardsSpaceType.empty?
+
+    std_space_type = space_type.standardsSpaceType.get
+
+    # Space with standby mode are determined based
+    # on note H in Std 62.1 and their automatic partial
+    # of full off lighting control requirement in 90.1.
+    # In 90.1-2019/62.1-2016 this comes down to office
+    # spaces (enclosed =< 250 ft2) and conference/meeting
+    # and multipurpose rooms.
+    # Currently standards doesn't excatly use the 90.1
+    # space description so all spaces types that include
+    # office/meeting/conference are flagged as having
+    # occupant standby mode.
+    if std_space_type.downcase.include?('office') || std_space_type.downcase.include?('meeting') || std_space_type.downcase.include?('conference')
+      return true
+    end
+
+    return false
+  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)
+    htg_sch = thermostat.getHeatingSchedule.get
+    clg_sch = thermostat.getCoolingSchedule.get
+
+    # Setback heating schedule
+    # Setback is 1 deg. F per code requirement
+    # Time of the day is arbitrary lack of dynamic occupant modeling
+    setup = 1 # deg. F
+    htg_sch_mod = { '12' => -1 * OpenStudio.convert(setup, 'R', 'K').get }
+    htg_sch_name = "#{htg_sch.name} - occupant standby mode"
+    htg_sch_old = thermostat.model.getScheduleRulesetByName(htg_sch_name)
+    if htg_sch_old.empty?
+      htg_sch_offset = model_offset_schedule_value(htg_sch, htg_sch_mod)
+      htg_sch_offset.setName(htg_sch_name)
+      thermostat.setHeatingSchedule(htg_sch_offset)
+    else
+      thermostat.setHeatingSchedule(htg_sch_old.get)
+    end
+
+    # Setup cooling schedule
+    # Setup is 1 deg. F per code requirement
+    # Time of the day is arbitrary lack of dynamic occupant modeling
+    setback = 1 # deg. F
+    clg_sch_mod = { '12' => OpenStudio.convert(setback, 'R', 'K').get }
+    clg_sch_name = "#{clg_sch.name} - occupant standby mode"
+    clg_sch_old = thermostat.model.getScheduleRulesetByName(clg_sch_name)
+    if clg_sch_old.empty?
+      clg_sch_offset = model_offset_schedule_value(clg_sch, clg_sch_mod)
+      clg_sch_offset.setName(clg_sch_name)
+      thermostat.setCoolingSchedule(clg_sch_offset)
+    else
+      thermostat.setCoolingSchedule(clg_sch_old.get)
+    end
+
+    return true
+  end
+end

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

@@ -1,11 +1,31 @@
 class ASHRAE9012019 < ASHRAE901
   # @!group hvac_systems
 
-  # Determine which type of fan the cooling tower
-  # will have.  Variable Speed Fan for ASHRAE 90.1-2019.
+  # 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
   # @return [String] the fan type: TwoSpeed Fan, Variable Speed Fan
   def model_cw_loop_cooling_tower_fan_type(model)
     fan_type = 'Variable Speed Fan'
     return fan_type
   end
+
+  # Create an economizer maximum OA fraction schedule with
+  # For ASHRAE 90.1 2019, a maximum of 75% to reflect damper leakage per PNNL
+  #
+  # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] HVAC air loop object
+  # @param oa_control [OpenStudio::Model::ControllerOutdoorAir] Outdoor air controller object to have this maximum OA fraction schedule
+  # @param snc [String] System name
+  #
+  # @return [OpenStudio::Model::ScheduleRuleset] Generated maximum outdoor air fraction schedule for later use
+  def set_maximum_fraction_outdoor_air_schedule(air_loop_hvac, oa_control, snc)
+    max_oa_sch_name = "#{snc}maxOASch"
+    max_oa_sch = OpenStudio::Model::ScheduleRuleset.new(air_loop_hvac.model)
+    max_oa_sch.setName(max_oa_sch_name)
+    max_oa_sch.defaultDaySchedule.setName("#{max_oa_sch_name}Default")
+    max_oa_sch.defaultDaySchedule.addValue(OpenStudio::Time.new(0, 24, 0, 0), 0.75)
+    oa_control.setMaximumFractionofOutdoorAirSchedule(max_oa_sch)
+    max_oa_sch
+  end
 end

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

@@ -4,7 +4,8 @@ class DOERef1980to2004 < ASHRAE901
   # Zones with low OA per area get lower initial guesses.
   # Final position will be adjusted upward as necessary by Standards.AirLoopHVAC.apply_minimum_vav_damper_positions
   #
-  # @param zone_oa_per_area [Double] the zone outdoor air per area, m^3/s
+  # @param air_terminal_single_duct_vav_reheat [OpenStudio::Model::AirTerminalSingleDuctVAVReheat] the air terminal object
+  # @param zone_oa_per_area [Double] the zone outdoor air per area in m^3/s*m^2
   # @return [Bool] returns true if successful, false if not
   def air_terminal_single_duct_vav_reheat_apply_initial_prototype_damper_position(air_terminal_single_duct_vav_reheat, zone_oa_per_area)
     # Set the minimum flow fraction

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

@@ -3,18 +3,16 @@ class DOERef1980to2004 < ASHRAE901
 
   # Add an elevator the the specified space
   #
-  # @param space [OpenStudio::Model::Space] the space
-  # to assign the elevators to.
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param space [OpenStudio::Model::Space] the space to assign the elevators to.
   # @param number_of_elevators [Integer] the number of elevators
-  # @param elevator_type [String] valid choices are
-  # Traction, Hydraulic
+  # @param elevator_type [String] valid choices are Traction, Hydraulic
   # @param elevator_schedule [String] the name of the elevator schedule
   # @param elevator_fan_schedule [String] the name of the elevator fan schedule
   # @param elevator_lights_schedule [String] the name of the elevator lights schedule
   # @param building_type [String] the building type
   # @return [OpenStudio::Model::ElectricEquipment] the resulting elevator
-  # @todo Inconsistency.  Older vintages don't have lights or fans
-  # in elevators, which is not realistic.
+  # @todo Inconsistency.  Older vintages don't have lights or fans in elevators, which is not realistic.
   def model_add_elevator(model,
                          space,
                          number_of_elevators,
@@ -75,11 +73,13 @@ class DOERef1980to2004 < ASHRAE901
     return elevator_equipment
   end
 
-  # Determines the power required by an individual elevator
-  # of a given type.  Values used by the older vintages
-  # are slightly higher than those used by the DOE prototypes.
-  # @param elevator_type [String] valid choices are
-  # Traction, Hydraulic
+  # Determines the power required by an individual elevator of a given type.
+  # Values used by the older vintages are slightly higher than those used by the DOE prototypes.
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param elevator_type [String] valid choices are Traction, Hydraulic
+  # @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
     if elevator_type == 'Traction'

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

@@ -1,10 +1,11 @@
 class DOERef1980to2004 < ASHRAE901
   # @!group refrigeration
 
-  # Determine the latent case credit curve to use
-  # for walkins.
-  # @todo Should probably use the model_add_refrigeration_walkin
-  # and lookups from the spreadsheet instead of hard-coded values.
+  # Determine the latent case credit curve to use for walkins.
+  # @todo Should probably use the model_add_refrigeration_walkin and lookups from the spreadsheet instead of hard-coded values.
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [String] curve name
   def model_walkin_freezer_latent_case_credit_curve(model)
     latent_case_credit_curve_name = 'Single Shelf Horizontal Latent Energy Multiplier_Pre2004'
     return latent_case_credit_curve_name