openstudio-standards 0.2.14 → 0.2.15.pre.rc1

data/lib/openstudio-standards/standards/Standards.ZoneHVACComponent.rb

@@ -1,6 +1,9 @@
 class Standard
   # @!group ZoneHVACComponent
 
+  # default fan efficiency for small zone hvac fans, in watts per cfm
+  #
+  # @return [Double] fan efficiency in watts per cfm
   def zone_hvac_component_prm_baseline_fan_efficacy
     fan_efficacy_w_per_cfm = 0.3
     return fan_efficacy_w_per_cfm
@@ -10,6 +13,7 @@ class Standard
   # (Fan coils, Unit Heaters, PTACs, PTHPs, VRF Terminals, WSHPs, ERVs)
   # based on the W/cfm specified in the standard.
   #
+  # @param zone_hvac_component [OpenStudio::Model::ZoneHVACComponent] zone hvac component
   # @return [Bool] returns true if successful, false if not
   def zone_hvac_component_apply_prm_baseline_fan_power(zone_hvac_component)
     OpenStudio.logFree(OpenStudio::Debug, 'openstudio.standards.ZoneHVACComponent', "Setting fan power for #{zone_hvac_component.name}.")
@@ -83,12 +87,17 @@ class Standard
   end
 
   # Default occupancy fraction threshold for determining if the spaces served by the zone hvac are occupied
+  #
+  # @return [Double] unoccupied threshold
   def zone_hvac_unoccupied_threshold
     return 0.15
   end
 
   # If the supply air fan operating mode schedule is always off (to follow load),
   # and the zone requires ventilation, override it to follow the zone occupancy schedule
+  #
+  # @param zone_hvac_component [OpenStudio::Model::ZoneHVACComponent] zone hvac component
+  # @return [Bool] returns true if successful, false if not
   def zone_hvac_component_occupancy_ventilation_control(zone_hvac_component)
     ventilation = false
     # Zone HVAC operating schedule if providing ventilation
@@ -147,7 +156,7 @@ class Standard
     unless existing_sch.nil?
       if existing_sch.name.is_initialized
         OpenStudio.logFree(OpenStudio::Info, 'openstudio.Standards.ZoneHVACComponent', "#{zone_hvac_component.name} has ventilation, and schedule is set to always on; keeping always on schedule.")
-        return false if existing_sch.name.get.to_s.downcase.include? 'always on discrete'
+        return false if existing_sch.name.get.to_s.downcase.include?('always on discrete') || existing_sch.name.get.to_s.downcase.include?('guestroom_vent_ctrl_sch')
       end
     end
 
@@ -164,6 +173,7 @@ class Standard
 
   # Apply all standard required controls to the zone equipment
   #
+  # @param zone_hvac_component [OpenStudio::Model::ZoneHVACComponent] zone hvac component
   # @return [Bool] returns true if successful, false if not
   def zone_hvac_component_apply_standard_controls(zone_hvac_component)
     # Vestibule heating control
@@ -171,6 +181,35 @@ class Standard
       zone_hvac_component_apply_vestibule_heating_control(zone_hvac_component)
     end
 
+    # Convert to objects
+    zone_hvac_component = if zone_hvac_component.to_ZoneHVACFourPipeFanCoil.is_initialized
+                            zone_hvac_component.to_ZoneHVACFourPipeFanCoil.get
+                          elsif zone_hvac_component.to_ZoneHVACPackagedTerminalAirConditioner.is_initialized
+                            zone_hvac_component.to_ZoneHVACPackagedTerminalAirConditioner.get
+                          elsif zone_hvac_component.to_ZoneHVACPackagedTerminalHeatPump.is_initialized
+                            zone_hvac_component.to_ZoneHVACPackagedTerminalHeatPump.get
+                          end
+
+    # Do nothing for other types of zone HVAC equipment
+    if zone_hvac_component.nil?
+      return true
+    end
+
+    # Standby mode occupancy control
+    return true unless zone_hvac_component.thermalZone.empty?
+
+    thermal_zone = zone_hvac_component.thermalZone.get
+
+    standby_mode_spaces = []
+    thermal_zone.spaces.sort.each do |space|
+      if space_occupancy_standby_mode_required?(space)
+        standby_mode_spaces << space
+      end
+    end
+    if !standby_mode_spaces.empty?
+      zone_hvac_model_standby_mode_occupancy_control(zone_hvac_component)
+    end
+
     # zone ventilation occupancy control for systems with ventilation
     zone_hvac_component_occupancy_ventilation_control(zone_hvac_component)
 
@@ -180,14 +219,26 @@ class Standard
   # Determine if vestibule heating control is required.
   # Defaults to 90.1-2004 through 2010, not required.
   #
+  # @param zone_hvac_component [OpenStudio::Model::ZoneHVACComponent] zone hvac component
   # @return [Bool] returns true if successful, false if not
   def zone_hvac_component_vestibule_heating_control_required?(zone_hvac_component)
     vest_htg_control_required = false
     return vest_htg_control_required
   end
 
+  # Add occupant standby controls to zone equipment
+  # Currently, the controls consists of cycling the
+  # fan during the occupant standby mode hours
+  #
+  # @param zone_hvac_component OpenStudio zonal equipment object
+  # @retrun [Boolean] true if sucessful, false otherwise
+  def zone_hvac_model_standby_mode_occupancy_control(zone_hvac_component)
+    return true
+  end
+
   # Turns off vestibule heating below 45F
   #
+  # @param zone_hvac_component [OpenStudio::Model::ZoneHVACComponent] zone hvac component
   # @return [Bool] returns true if successful, false if not
   def zone_hvac_component_apply_vestibule_heating_control(zone_hvac_component)
     # Ensure that the equipment is assigned to a thermal zone

data/lib/openstudio-standards/standards/ashrae_90_1/ashrae_90_1.Standards.FanVariableVolume.rb

@@ -3,7 +3,7 @@ class ASHRAE901 < Standard
 
   # The threhold horsepower below which part load control is not required.
   #
-  # @param fan_variable_volume [OpenStudio::Model::FanVariableVolume] the fan
+  # @param fan_variable_volume [OpenStudio::Model::FanVariableVolume] variable volume fan object
   # @return [Double] the limit, in horsepower. Return nil for no limit by default.
   def fan_variable_volume_part_load_fan_power_limitation_hp_limit(fan_variable_volume)
     hp_limit = nil # No minimum limit
@@ -12,7 +12,7 @@ class ASHRAE901 < Standard
 
   # The threhold capacity below which part load control is not required.
   #
-  # @param fan_variable_volume [OpenStudio::Model::FanVariableVolume] the fan
+  # @param fan_variable_volume [OpenStudio::Model::FanVariableVolume] variable volume fan object
   # @return [Double] the limit, in Btu/hr. Return nil for no limit by default.
   def fan_variable_volume_part_load_fan_power_limitation_capacity_limit(fan_variable_volume)
     cap_limit_btu_per_hr = nil # No minimum limit

data/lib/openstudio-standards/standards/ashrae_90_1/ashrae_90_1.rb

@@ -7,6 +7,10 @@ class ASHRAE901 < Standard
     load_standards_database
   end
 
+  # Loads the openstudio standards dataset for this standard.
+  #
+  # @param data_directories [Array<String>] array of file paths that contain standards data
+  # @return [Hash] a hash of standards data
   def load_standards_database(data_directories = [])
     super([__dir__] + data_directories)
   end

data/lib/openstudio-standards/standards/ashrae_90_1/ashrae_90_1_2004/ashrae_90_1_2004.AirLoopHVAC.rb

@@ -3,7 +3,8 @@ class ASHRAE9012004 < ASHRAE901
 
   # Determine if an economizer is required per the PRM.
   #
-  # @param (see #economizer_required?)
+  # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
   # @return [Bool] returns true if required, false if not
   def air_loop_hvac_prm_baseline_economizer_required?(air_loop_hvac, climate_zone)
     economizer_required = false
@@ -92,9 +93,9 @@ class ASHRAE9012004 < ASHRAE901
   end
 
   # Determines the OA flow rates above which an economizer is required.
-  # Two separate rates, one for systems with an economizer and another
-  # for systems without.
-  # are zero for both types.
+  # Two separate rates, one for systems with an economizer and another for systems without.
+  #
+  # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
   # @return [Array<Double>] [min_oa_without_economizer_cfm, min_oa_with_economizer_cfm]
   def air_loop_hvac_demand_control_ventilation_limits(air_loop_hvac)
     min_oa_without_economizer_cfm = 3000
@@ -102,18 +103,21 @@ class ASHRAE9012004 < ASHRAE901
     return [min_oa_without_economizer_cfm, min_oa_with_economizer_cfm]
   end
 
-  # Determine whether the VAV damper control is single maximum or
-  # dual maximum control.  Single Maximum for 90.1-2004.
+  # Determine whether the VAV damper control is single maximum or dual maximum control.
+  # Single Maximum for 90.1-2004.
   #
+  # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
   # @return [String] the damper control type: Single Maximum, Dual Maximum
   def air_loop_hvac_vav_damper_action(air_loop_hvac)
     damper_action = 'Single Maximum'
     return damper_action
   end
 
-  # Determine the air flow and number of story limits
-  # for whether motorized OA damper is required.
-  # @return [Array<Double>] [minimum_oa_flow_cfm, maximum_stories]
+  # Determine the air flow and number of story limits for whether motorized OA damper is required.
+  #
+  # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
+  # @return [Array<Double>] [minimum_oa_flow_cfm, maximum_stories]. If both nil, never required
   def air_loop_hvac_motorized_oa_damper_limits(air_loop_hvac, climate_zone)
     case climate_zone
     when 'ASHRAE 169-2006-0A',
@@ -144,9 +148,11 @@ class ASHRAE9012004 < ASHRAE901
     return [minimum_oa_flow_cfm, maximum_stories]
   end
 
-  # Determine the number of stages that should be used as controls
-  # for single zone DX systems.  90.1-2004 requires 1 stage.
+  # Determine the number of stages that should be used as controls for single zone DX systems.
+  # 90.1-2004 requires 1 stage.
   #
+  # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
   # @return [Integer] the number of stages: 0, 1, 2
   def air_loop_hvac_single_zone_controls_num_stages(air_loop_hvac, climate_zone)
     num_stages = 1
@@ -156,21 +162,25 @@ class ASHRAE9012004 < ASHRAE901
   # Determines supply air temperature (SAT) temperature.
   # For 90.1-2007, 10 delta-F (R)
   #
-  # @return [Double] the SAT reset amount (R)
+  # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
+  # @return [Double] the SAT reset amount in degrees Rankine
   def air_loop_hvac_enable_supply_air_temperature_reset_delta(air_loop_hvac)
-    sat_reset_r = 10
+    sat_reset_r = 10.0
     return sat_reset_r
   end
 
-  # Determine the airflow limits that govern whether or not
-  # an ERV is required.  Based on climate zone and % OA.
-  # @return [Double] the flow rate above which an ERV is required.
-  # if nil, ERV is never required.
+  # Determine the airflow limits that govern whether or not an ERV is required.
+  # Based on climate zone and % OA.
+  #
+  # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
+  # @param pct_oa [Double] percentage of outdoor air
+  # @return [Double] the flow rate above which an ERV is required. if nil, ERV is never required.
   def air_loop_hvac_energy_recovery_ventilator_flow_limit(air_loop_hvac, climate_zone, pct_oa)
     erv_cfm = if pct_oa < 0.7
                 nil
               else
-                # @Todo: Add exceptions (eg: e. cooling systems in climate zones 3C, 4C, 5B, 5C, 6B, 7 and 8 | d. Heating systems in climate zones 1 to 3)
+                # @todo Add exceptions (eg: e. cooling systems in climate zones 3C, 4C, 5B, 5C, 6B, 7 and 8 | d. Heating systems in climate zones 1 to 3)
                 5000
               end
 

data/lib/openstudio-standards/standards/ashrae_90_1/ashrae_90_1_2004/ashrae_90_1_2004.FanVariableVolume.rb

@@ -4,7 +4,7 @@ class ASHRAE9012004 < ASHRAE901
   # The threhold horsepower below which part load control is not required.
   # 15 nameplate HP threshold is equivalent to motors with input powers of 9.9  HP per TSD
   #
-  # @param fan_variable_volume [OpenStudio::Model::FanVariableVolume] the fan
+  # @param fan_variable_volume [OpenStudio::Model::FanVariableVolume] variable volume fan object
   # @return [Double] the limit, in horsepower. Return nil for no limit by default.
   # @todo AddRef
   def fan_variable_volume_part_load_fan_power_limitation_hp_limit(fan_variable_volume)

data/lib/openstudio-standards/standards/ashrae_90_1/ashrae_90_1_2004/ashrae_90_1_2004.PlantLoop.rb

@@ -1,8 +1,10 @@
 class ASHRAE9012004 < ASHRAE901
   # @!group PlantLoop
 
-  # Set the primary and secondary pumping control types for the
-  # chilled water loop, as specified in Appendix G.
+  # Set the primary and secondary pumping control types for the chilled water loop, as specified in Appendix G.
+  #
+  # @param plant_loop [OpenStudio::Model::PlantLoop] chilled water loop
+  # @return [Bool] returns true if successful, false if not
   def plant_loop_apply_prm_baseline_chilled_water_pumping_type(plant_loop)
     # Determine the pumping type.
     minimum_area_ft2 = 120_000

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

@@ -10,6 +10,10 @@ class ASHRAE9012004 < ASHRAE901
     load_standards_database
   end
 
+  # Loads the openstudio standards dataset for this standard.
+  #
+  # @param data_directories [Array<String>] array of file paths that contain standards data
+  # @return [Hash] a hash of standards data
   def load_standards_database(data_directories = [])
     super([__dir__] + data_directories)
   end

data/lib/openstudio-standards/standards/ashrae_90_1/ashrae_90_1_2004/comstock_ashrae_90_1_2004/comstock_ashrae_90_1_2004.rb

@@ -10,6 +10,10 @@ class ComStockASHRAE9012004 < ASHRAE9012004
     load_standards_database
   end
 
+  # Loads the openstudio standards dataset for this standard.
+  #
+  # @param data_directories [Array<String>] array of file paths that contain standards data
+  # @return [Hash] a hash of standards data
   def load_standards_database(data_directories = [])
     super([__dir__] + data_directories)
   end