openstudio-standards 0.2.14 → 0.2.15.pre.rc1

data/lib/openstudio-standards/standards/ashrae_90_1/ashrae_90_1_2010/data/ashrae_90_1_2010.unitary_acs.json

@@ -574,6 +574,75 @@
       "cool_eir_fflow": "CoolCLennoxStandard10Ton_TGA120S2B_EIRFFF",
       "cool_plf_fplr": "PSZ-AC_CoolCLennoxStandard10Ton_TGA120S2B_PLR",
       "notes": null
+    },
+    {
+      "template": "90.1-2010",
+      "cooling_type": "WaterCooled",
+      "heating_type": "All Other",
+      "subcategory": "CRAC",
+      "minimum_capacity": 0.0,
+      "maximum_capacity": 64999.0,
+      "start_date": "1919-09-09T00:00:00+00:00",
+      "end_date": "2999-09-09T00:00:00+00:00",
+      "minimum_seasonal_energy_efficiency_ratio": null,
+      "minimum_energy_efficiency_ratio": null,
+      "minimum_integrated_part_load_value": null,
+      "minimum_integrated_energy_efficiency_ratio": null,
+      "ptac_eer_coefficient_1": null,
+      "ptac_eer_coefficient_2": null,
+      "minimum_scop": 2.6,
+      "cool_cap_ft": "PSZ-Fine Storage DX Coil Cap-FT",
+      "cool_cap_fflow": "DX Coil Cap-FF",
+      "cool_eir_ft": "PSZ-AC DX Coil EIR-FT",
+      "cool_eir_fflow": "Split DX Coil EIR-FF",
+      "cool_plf_fplr": "HPACCOOLPLFFPLR",
+      "notes": "ASHRAE 90.1-2010 Table 6.8.1K. capacity here is sensible only. SCOP for water cooled downflow units"
+    },
+    {
+      "template": "90.1-2010",
+      "cooling_type": "WaterCooled",
+      "heating_type": "All Other",
+      "subcategory": "CRAC",
+      "minimum_capacity": 65000.0,
+      "maximum_capacity": 239999.0,
+      "start_date": "1919-09-09T00:00:00+00:00",
+      "end_date": "2999-09-09T00:00:00+00:00",
+      "minimum_seasonal_energy_efficiency_ratio": null,
+      "minimum_energy_efficiency_ratio": null,
+      "minimum_integrated_part_load_value": null,
+      "minimum_integrated_energy_efficiency_ratio": null,
+      "ptac_eer_coefficient_1": null,
+      "ptac_eer_coefficient_2": null,
+      "minimum_scop": 2.5,
+      "cool_cap_ft": "PSZ-Fine Storage DX Coil Cap-FT",
+      "cool_cap_fflow": "DX Coil Cap-FF",
+      "cool_eir_ft": "PSZ-AC DX Coil EIR-FT",
+      "cool_eir_fflow": "Split DX Coil EIR-FF",
+      "cool_plf_fplr": "HPACCOOLPLFFPLR",
+      "notes": "ASHRAE 90.1-2010 Table 6.8.1K. capacity here is sensible only. SCOP for water cooled downflow units"
+    },
+    {
+      "template": "90.1-2010",
+      "cooling_type": "WaterCooled",
+      "heating_type": "All Other",
+      "subcategory": "CRAC",
+      "minimum_capacity": 240000.0,
+      "maximum_capacity": 9999999.0,
+      "start_date": "1919-09-09T00:00:00+00:00",
+      "end_date": "2999-09-09T00:00:00+00:00",
+      "minimum_seasonal_energy_efficiency_ratio": null,
+      "minimum_energy_efficiency_ratio": null,
+      "minimum_integrated_part_load_value": null,
+      "minimum_integrated_energy_efficiency_ratio": null,
+      "ptac_eer_coefficient_1": null,
+      "ptac_eer_coefficient_2": null,
+      "minimum_scop": 2.4,
+      "cool_cap_ft": "PSZ-Fine Storage DX Coil Cap-FT",
+      "cool_cap_fflow": "DX Coil Cap-FF",
+      "cool_eir_ft": "PSZ-AC DX Coil EIR-FT",
+      "cool_eir_fflow": "Split DX Coil EIR-FF",
+      "cool_plf_fplr": "HPACCOOLPLFFPLR",
+      "notes": "ASHRAE 90.1-2010 Table 6.8.1K. capacity here is sensible only. SCOP for water cooled downflow units"
     }
   ]
 }

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

@@ -1,28 +1,10 @@
 class ASHRAE9012013 < ASHRAE901
   # @!group AirLoopHVAC
 
-  # Apply multizone vav outdoor air method and
-  # adjust multizone VAV damper positions
-  # to achieve a system minimum ventilation effectiveness
-  # of 0.6 per PNNL.  Hard-size the resulting min OA
-  # into the sizing:system object.
-  #
-  # return [Bool] returns true if successful, false if not
-  # @todo move building-type-specific code to Prototype classes
-  def air_loop_hvac_apply_multizone_vav_outdoor_air_sizing(air_loop_hvac)
-    # First time adjustment:
-    # Only applies to multi-zone vav systems
-    # exclusion: for Outpatient: (1) both AHU1 and AHU2 in 'DOE Ref Pre-1980' and 'DOE Ref 1980-2004'
-    # (2) AHU1 in 2004-2013
-    # TODO refactor: move building-type-specific code to Prototype classes
-    if air_loop_hvac_multizone_vav_system?(air_loop_hvac) && !(air_loop_hvac.name.to_s.include? 'Outpatient F1')
-      air_loop_hvac_adjust_minimum_vav_damper_positions(air_loop_hvac)
-    end
-
-    return true
-  end
-
   # Determine the limits for the type of economizer present on the AirLoopHVAC, if any.
+  #
+  # @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>] [drybulb_limit_f, enthalpy_limit_btu_per_lb, dewpoint_limit_f]
   def air_loop_hvac_economizer_limits(air_loop_hvac, climate_zone)
     drybulb_limit_f = nil
@@ -31,11 +13,9 @@ class ASHRAE9012013 < ASHRAE901
 
     # Get the OA system and OA controller
     oa_sys = air_loop_hvac.airLoopHVACOutdoorAirSystem
-    if oa_sys.is_initialized
-      oa_sys = oa_sys.get
-    else
-      return [nil, nil, nil] # No OA system
-    end
+    return [nil, nil, nil] unless oa_sys.is_initialized
+
+    oa_sys = oa_sys.get
     oa_control = oa_sys.getControllerOutdoorAir
     economizer_type = oa_control.getEconomizerControlType
     oa_control.resetEconomizerMinimumLimitDryBulbTemperature
@@ -67,12 +47,19 @@ class ASHRAE9012013 < ASHRAE901
 
   # Determine if the system economizer must be integrated or not.
   # All economizers must be integrated in 90.1-2013
+  #
+  # @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_integrated_economizer_required?(air_loop_hvac, climate_zone)
-    integrated_economizer_required = true
-    return integrated_economizer_required
+    return true
   end
 
-  # Determine the economizer type and limits for the the PRM Defaults to 90.1-2007 logic.
+  # Determine the economizer type and limits for the the PRM
+  # Defaults to 90.1-2007 logic.
+  #
+  # @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>] [economizer_type, drybulb_limit_f, enthalpy_limit_btu_per_lb, dewpoint_limit_f]
   def air_loop_hvac_prm_economizer_type_and_limits(air_loop_hvac, climate_zone)
     economizer_type = 'NoEconomizer'
@@ -134,9 +121,10 @@ class ASHRAE9012013 < ASHRAE901
   # Check the economizer type currently specified in the ControllerOutdoorAir object on this air loop
   # is acceptable per the standard.
   #
-  # @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 allowable, if the system has no economizer or no OA system.
-  # Returns false if the economizer type is not allowable.
+  #   Returns false if the economizer type is not allowable.
   def air_loop_hvac_economizer_type_allowable?(air_loop_hvac, climate_zone)
     # EnergyPlus economizer types
     # 'NoEconomizer'
@@ -150,11 +138,9 @@ class ASHRAE9012013 < ASHRAE901
 
     # Get the OA system and OA controller
     oa_sys = air_loop_hvac.airLoopHVACOutdoorAirSystem
-    if oa_sys.is_initialized
-      oa_sys = oa_sys.get
-    else
-      return true # No OA system
-    end
+    return true unless oa_sys.is_initialized
+
+    oa_sys = oa_sys.get
     oa_control = oa_sys.getControllerOutdoorAir
     economizer_type = oa_control.getEconomizerControlType
 
@@ -221,13 +207,12 @@ class ASHRAE9012013 < ASHRAE901
   end
 
   # Determine if multizone vav optimization is required.
+  # @note code_sections [90.1-2013_6.5.3.3]
   #
-  # @code_sections [90.1-2013_6.5.3.3]
-  # @param (see #economizer_required?)
-  # @return [Bool] Returns true if required, false if not.
-  # @todo Add exception logic for
-  #   systems with AIA healthcare ventilation requirements
-  #   dual duct systems
+  # @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
+  # @todo Add exception logic for systems with AIA healthcare ventilation requirements dual duct systems
   def air_loop_hvac_multizone_vav_optimization_required?(air_loop_hvac, climate_zone)
     multizone_opt_required = false
 
@@ -297,7 +282,7 @@ class ASHRAE9012013 < ASHRAE901
       return multizone_opt_required
     end
 
-    # TODO: Not required for dual-duct systems
+    # @todo Not required for dual-duct systems
     # if self.isDualDuct
     # OpenStudio::logFree(OpenStudio::Info, "openstudio.standards.AirLoopHVAC", "For #{controller_oa.name}: multizone optimization is not applicable because it is a dual duct system")
     # return multizone_opt_required
@@ -310,9 +295,9 @@ class ASHRAE9012013 < 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
@@ -321,7 +306,10 @@ class ASHRAE9012013 < ASHRAE901
   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]
+  #
+  # @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',
@@ -355,6 +343,8 @@ class ASHRAE9012013 < ASHRAE901
   # Determine the number of stages that should be used as controls for single zone DX systems.
   # 90.1-2013 depends on the cooling capacity of the system.
   #
+  # @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)
     min_clg_cap_btu_per_hr = 65_000
@@ -373,8 +363,9 @@ class ASHRAE9012013 < ASHRAE901
   # Determine if the system required supply air temperature (SAT) reset.
   # For 90.1-2013, SAT reset requirements are based on climate zone.
   #
-  # @param (see #economizer_required?)
-  # @return [Bool] Returns true if required, false if not.
+  # @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_supply_air_temperature_reset_required?(air_loop_hvac, climate_zone)
     is_sat_reset_required = false
 
@@ -436,8 +427,11 @@ class ASHRAE9012013 < ASHRAE901
 
   # Determine the airflow limits that govern whether or not an ERV is required.
   # Based on climate zone and % OA, plus the number of operating hours the system has.
-  # @return [Double] the flow rate above which an ERV is required.
-  # if nil, ERV is never required.
+  #
+  # @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)
     # Calculate the number of system operating hours
     # based on the availability schedule.

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

@@ -2,10 +2,11 @@ class ASHRAE9012013 < ASHRAE901
   # @!group AirTerminalSingleDuctVAVReheat
 
   # Specifies the minimum damper position for VAV dampers.
-  # For terminals with hot water heat and DDC, the minimum is 20%,
-  # otherwise the minimum is 30%.
+  # For terminals with hot water heat and DDC, the minimum is 20%, otherwise the minimum is 30%.
   #
+  # @param air_terminal_single_duct_vav_reheat [OpenStudio::Model::AirTerminalSingleDuctVAVReheat] the air terminal object
   # @param has_ddc [Bool] whether or not there is DDC control of the VAV terminal in question
+  # @return [Double] minimum damper position
   def air_terminal_single_duct_vav_reheat_minimum_damper_position(air_terminal_single_duct_vav_reheat, has_ddc = false)
     min_damper_position = nil
     case air_terminal_single_duct_vav_reheat_reheat_type(air_terminal_single_duct_vav_reheat)

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

@@ -3,17 +3,14 @@
 module ASHRAE9012013CoolingTower
   # @!group CoolingTower
 
-  # Above this point, centrifugal fan cooling towers must meet the limits
-  # of propeller or axial cooling towers instead.
-  # 90.1 6.5.5.3 Limit on Centrifugal Fan Open Circuit Cooling Towers.
-  # is 1,100 gallons per minute.
+  # Above this point, centrifugal fan cooling towers must meet the limits of propeller or axial cooling towers instead.
+  # @note code_sections 6.5.5.3 limit on centrifugal fan open=circuit cooling towers is 1,100 gallons per minute.
   #
-  # @param cooling_tower [OpenStudio::Model::CoolingTowerSingleSpeed,
-  # OpenStudio::Model::CoolingTowerTwoSpeed,
-  # OpenStudio::Model::CoolingTowerVariableSpeed] the cooling tower
+  # @param cooling_tower [OpenStudio::Model::StraightComponent] cooling tower object, allowable types:
+  #   CoolingTowerSingleSpeed, CoolingTowerTwoSpeed, CoolingTowerVariableSpeed
   # @return [Double] the limit, in gallons per minute.  Return nil for no limit.
   def cooling_tower_apply_minimum_power_per_flow_gpm_limit(cooling_tower)
-    gpm_limit = 1100
+    gpm_limit = 1100.0
     return gpm_limit
   end
 end

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

@@ -5,12 +5,11 @@ class ASHRAE9012013 < ASHRAE901
 
   # Apply the efficiency, plus Multicell heat rejection with VSD per 90.1-2013 6.5.2.2
   #
-  # @param cooling_tower_variable_speed [OpenStudio::Model::CoolingTowerVariableSpeed] the cooling tower
+  # @param cooling_tower_variable_speed [OpenStudio::Model::CoolingTowerVariableSpeed] variable speed cooling tower
+  # @return [Bool] returns true if successful, false if not
   def cooling_tower_variable_speed_apply_efficiency_and_curves(cooling_tower_variable_speed)
     cooling_tower_apply_minimum_power_per_flow(cooling_tower_variable_speed)
-
     cooling_tower_variable_speed.setCellControl('MaximalCell')
-
     return true
   end
 end

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

@@ -5,7 +5,7 @@ class ASHRAE9012013 < ASHRAE901
   # Per 90.1-2013, table 6.5.3.2.1: the fan motor size for chiller-water
   # and evaporative cooling is 0.25 hp as of 1/1/2014 instead of 5 hp
   #
-  # @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 = case fan_variable_volume_cooling_system_type(fan_variable_volume)
@@ -24,7 +24,7 @@ class ASHRAE9012013 < ASHRAE901
   # Per 90.1-2013, table 6.5.3.2.1: the cooling capacity threshold is 75000
   # instead of 110000 as of 1/1/2014
   #
-  # @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 = case fan_variable_volume_cooling_system_type(fan_variable_volume)

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

@@ -96,15 +96,17 @@ class ASHRAE9012013 < ASHRAE901
     return [req_top_ctrl, req_pri_ctrl, req_sec_ctrl]
   end
 
-  # Determine the fraction controlled by each sensor and which
-  # window each sensor should go near.
+  # Determine the fraction controlled by each sensor and which window each sensor should go near.
   #
-  # @param space [OpenStudio::Model::Space] the space with the daylighting
+  # @param space [OpenStudio::Model::Space] space object
+  # @param areas [Hash] a hash of daylighted areas
   # @param sorted_windows [Hash] a hash of windows, sorted by priority
   # @param sorted_skylights [Hash] a hash of skylights, sorted by priority
   # @param req_top_ctrl [Bool] if toplighting controls are required
   # @param req_pri_ctrl [Bool] if primary sidelighting controls are required
   # @param req_sec_ctrl [Bool] if secondary sidelighting controls are required
+  # @return [Array] array of 4 items
+  #   [sensor 1 fraction, sensor 2 fraction, sensor 1 window, sensor 2 window]
   def space_daylighting_fractions_and_windows(space,
                                               areas,
                                               sorted_windows,
@@ -160,7 +162,8 @@ class ASHRAE9012013 < ASHRAE901
           sensor_1_window = sorted_skylights[0]
         else
           # Sensor 1 controls toplighted area
-          sensor_1_frac = areas['toplighted_area'] / space_area_m2
+          num_sensors = 2
+          sensor_1_frac = areas['toplighted_area'] / space_area_m2 / num_sensors
           sensor_1_window = sorted_skylights[0]
           sensor_2_frac = sensor_1_frac
           sensor_2_window = sensor_1_window
@@ -178,7 +181,7 @@ class ASHRAE9012013 < ASHRAE901
     return [sensor_1_frac, sensor_2_frac, sensor_1_window, sensor_2_window]
   end
 
-  # Determine the base infiltration rate at 75 PA.
+  # Determine the base infiltration rate at 75 Pa.
   #
   # @return [Double] the baseline infiltration rate, in cfm/ft^2
   # defaults to no infiltration.

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

@@ -24,7 +24,8 @@ class ASHRAE9012013 < ASHRAE901
         case bldg_type
         when 'Retail', 'StripMall', 'SuperMarket'
           occ_type = 'retail'
-          # when 'SomeBuildingType' # TODO add publicassembly building types
+          # when 'SomeBuildingType'
+          # @todo add publicassembly building types
           # occ_type = 'publicassembly'
         end
       end

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

@@ -6,7 +6,7 @@ class ASHRAE9012013 < ASHRAE901
   # from the proposed building in some scenarios.
   #
   # @param building_type [String] the building type
-  # @return [Bool] returns true if successful, false if not.
+  # @return [Bool] returns true if successful, false if not
   def water_heater_mixed_apply_prm_baseline_fuel_type(water_heater_mixed, building_type)
     # Determine the building-type specific
     # fuel requirements from Table G3.1.1-2

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

@@ -5,6 +5,7 @@ class ASHRAE9012013 < ASHRAE901
   # Required for 90.1-2013 per 6.4.3.9.
   #
   # @ref [References::ASHRAE9012013] 6.4.3.9
+  # @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)
     # Ensure that the equipment is assigned to a thermal zone

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

@@ -10,6 +10,10 @@ class ASHRAE9012013 < 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_2013/comstock_ashrae_90_1_2013/comstock_ashrae_90_1_2013.rb

@@ -10,6 +10,10 @@ class ComStockASHRAE9012013 < ASHRAE9012013
     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