openstudio-standards 0.4.0 → 0.5.0.rc1

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

@@ -4,7 +4,7 @@ class Standard
   # Sets the fan power of a PIU fan based on the W/cfm specified in the standard.
   #
   # @param air_terminal_single_duct_parallel_piu_reheat [OpenStudio::Model::AirTerminalSingleDuctParallelPIUReheat] air terminal object
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def air_terminal_single_duct_parallel_piu_reheat_apply_prm_baseline_fan_power(air_terminal_single_duct_parallel_piu_reheat)
     OpenStudio.logFree(OpenStudio::Debug, 'openstudio.standards.AirTerminalSingleDuctParallelPIUReheat', "Setting PIU fan power for #{air_terminal_single_duct_parallel_piu_reheat.name}.")
 
@@ -72,7 +72,7 @@ class Standard
   # means that the secondary fan will be on when the primary air
   # flow is at the minimum flow fraction.
   #
-  # @return [Float] returns nil or a float representing the fraction
+  # @return [Double] returns nil or a float representing the fraction
   def air_terminal_single_duct_parallel_piu_reheat_fan_on_flow_fraction
     return nil
   end
@@ -90,7 +90,7 @@ class Standard
   #
   # @param air_terminal_single_duct_parallel_piu_reheat [OpenStudio::Model::AirTerminalSingleDuctParallelPIUReheat] the air terminal object
   # @param zone_min_oa [Double] the zone outdoor air flow rate, in m^3/s.
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def air_terminal_single_duct_parallel_piu_reheat_apply_minimum_primary_airflow_fraction(air_terminal_single_duct_parallel_piu_reheat, zone_min_oa = nil)
     # Minimum primary air flow
     min_primary_airflow_frac = air_terminal_single_duct_parallel_reheat_piu_minimum_primary_airflow_fraction(air_terminal_single_duct_parallel_piu_reheat)

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

@@ -9,9 +9,9 @@ class Standard
   # @param zone_min_oa [Double] the zone outdoor air flow rate, in m^3/s.
   #   If supplied, this will be set as a minimum limit in addition to the minimum
   #   damper position.  EnergyPlus will use the larger of the two values during sizing.
-  # @param has_ddc [Bool] whether or not there is DDC control of the VAV terminal,
+  # @param has_ddc [Boolean] whether or not there is DDC control of the VAV terminal,
   #   which impacts the minimum damper position requirement.
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   # @todo remove exception where older vintages don't have minimum positions adjusted.
   def air_terminal_single_duct_vav_reheat_apply_minimum_damper_position(air_terminal_single_duct_vav_reheat, zone_min_oa = nil, has_ddc = true)
     # Minimum damper position
@@ -34,7 +34,7 @@ class Standard
   # Defaults to 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
+  # @param has_ddc [Boolean] 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 = 0.3
@@ -44,7 +44,7 @@ class Standard
   # Sets the capacity of the reheat coil based on the minimum flow fraction, and the maximum flow rate.
   #
   # @param air_terminal_single_duct_vav_reheat [OpenStudio::Model::AirTerminalSingleDuctVAVReheat] the air terminal object
-  # @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_set_heating_cap(air_terminal_single_duct_vav_reheat)
     flow_rate_fraction = 0.0
     if air_terminal_single_duct_vav_reheat.constantMinimumAirFlowFraction.is_initialized

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

@@ -74,6 +74,7 @@ class Standard
   # Finds lookup object in standards and return minimum thermal efficiency
   #
   # @param boiler_hot_water [OpenStudio::Model::BoilerHotWater] hot water boiler object
+  # @param rename [Boolean] if true, rename the boiler to include the new capacity and efficiency
   # @return [Double] minimum thermal efficiency
   def boiler_hot_water_standard_minimum_thermal_efficiency(boiler_hot_water, rename = false)
     # Get the boiler properties
@@ -130,7 +131,7 @@ class Standard
   # Applies the standard efficiency ratings and typical performance curves to this object.
   #
   # @param boiler_hot_water [OpenStudio::Model::BoilerHotWater] hot water boiler object
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def boiler_hot_water_apply_efficiency_and_curves(boiler_hot_water)
     successfully_set_all_properties = false
 

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

@@ -4,7 +4,7 @@ class Standard
   # Finds the search criteria
   #
   # @param chiller_electric_eir [OpenStudio::Model::ChillerElectricEIR] chiller object
-  # @return [hash] has for search criteria to be used for find object
+  # @return [Hash] has for search criteria to be used for find object
   def chiller_electric_eir_find_search_criteria(chiller_electric_eir)
     search_criteria = {}
     search_criteria['template'] = template
@@ -36,14 +36,20 @@ class Standard
         condenser_type = 'WithCondenser' if absorption_type.nil?
       end
     elsif cooling_type == 'WaterCooled'
-      if name.include?('Reciprocating')
-        compressor_type = 'Reciprocating'
-      elsif name.include?('Rotary Screw')
-        compressor_type = 'Rotary Screw'
-      elsif name.include?('Scroll')
-        compressor_type = 'Scroll'
-      elsif name.include?('Centrifugal')
-        compressor_type = 'Centrifugal'
+      # use the chiller additional properties compressor type if defined
+      if chiller_electric_eir.additionalProperties.hasFeature('compressor_type')
+        compressor_type = chiller_electric_eir.additionalProperties.getFeatureAsString('compressor_type').get
+      else
+        # try to lookup by chiller name
+        if name.include?('Reciprocating')
+          compressor_type = 'Reciprocating'
+        elsif name.include?('Rotary Screw')
+          compressor_type = 'Rotary Screw'
+        elsif name.include?('Scroll')
+          compressor_type = 'Scroll'
+        elsif name.include?('Centrifugal')
+          compressor_type = 'Centrifugal'
+        end
       end
     end
     unless condenser_type.nil?
@@ -102,7 +108,7 @@ class Standard
   #
   # @param chiller_electric_eir [OpenStudio::Model::ChillerElectricEIR] chiller object
   # @param clg_tower_objs [Array] cooling towers, currently unused
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   # @todo remove clg_tower_objs parameter if unused
   def chiller_electric_eir_apply_efficiency_and_curves(chiller_electric_eir, clg_tower_objs)
     chillers = standards_data['chillers']

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

@@ -6,7 +6,7 @@ class Standard
   # Finds capacity in W
   #
   # @param coil_cooling_dx_single_speed [OpenStudio::Model::CoilCoolingDXSingleSpeed] coil cooling dx single speed object
-  # @param necb_ref_hp [Bool] for compatability with NECB ruleset only.
+  # @param necb_ref_hp [Boolean] for compatability with NECB ruleset only.
   # @return [Double] capacity in W to be used for find object
   def coil_cooling_dx_single_speed_find_capacity(coil_cooling_dx_single_speed, necb_ref_hp = false)
     capacity_w = nil
@@ -42,8 +42,8 @@ class Standard
   # Finds lookup object in standards and return efficiency
   #
   # @param coil_cooling_dx_single_speed [OpenStudio::Model::CoilCoolingDXSingleSpeed] coil cooling dx single speed object
-  # @param rename [Bool] if true, object will be renamed to include capacity and efficiency level
-  # @param necb_ref_hp [Bool] for compatability with NECB ruleset only.
+  # @param rename [Boolean] if true, object will be renamed to include capacity and efficiency level
+  # @param necb_ref_hp [Boolean] for compatability with NECB ruleset only.
   # @return [Double] full load efficiency (COP)
   def coil_cooling_dx_single_speed_standard_minimum_cop(coil_cooling_dx_single_speed, rename = false, necb_ref_hp = false)
     search_criteria = coil_dx_find_search_criteria(coil_cooling_dx_single_speed, necb_ref_hp)
@@ -173,7 +173,7 @@ class Standard
   #
   # @param coil_cooling_dx_single_speed [OpenStudio::Model::CoilCoolingDXSingleSpeed] coil cooling dx single speed object
   # @param sql_db_vars_map [Hash] hash map
-  # @param necb_ref_hp [Bool] for compatability with NECB ruleset only.
+  # @param necb_ref_hp [Boolean] for compatability with NECB ruleset only.
   # @return [Hash] hash of coil objects
   def coil_cooling_dx_single_speed_apply_efficiency_and_curves(coil_cooling_dx_single_speed, sql_db_vars_map, necb_ref_hp = false)
     successfully_set_all_properties = true

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

@@ -24,7 +24,7 @@ class Standard
   # Finds lookup object in standards and return efficiency
   #
   # @param coil_cooling_dx_two_speed [OpenStudio::Model::CoilCoolingDXTwoSpeed] coil cooling dx two speed object
-  # @param rename [Bool] if true, object will be renamed to include capacity and efficiency level
+  # @param rename [Boolean] if true, object will be renamed to include capacity and efficiency level
   # @return [Double] full load efficiency (COP)
   def coil_cooling_dx_two_speed_standard_minimum_cop(coil_cooling_dx_two_speed, rename = false)
     search_criteria = coil_dx_find_search_criteria(coil_cooling_dx_two_speed)

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

@@ -22,7 +22,7 @@ class Standard
   # Finds lookup object in standards and return efficiency
   #
   # @param coil_cooling_water_to_air_heat_pump [OpenStudio::Model::CoilCoolingWaterToAirHeatPumpEquationFit] coil cooling object
-  # @param rename [Bool] if true, object will be renamed to include capacity and efficiency level
+  # @param rename [Boolean] if true, object will be renamed to include capacity and efficiency level
   # @return [Double] full load efficiency (COP)
   def coil_cooling_water_to_air_heat_pump_standard_minimum_cop(coil_cooling_water_to_air_heat_pump, rename = false, computer_room_air_conditioner = false)
     search_criteria = {}

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

@@ -48,7 +48,7 @@ module CoilDX
   #
   # @param coil_dx [OpenStudio::Model::StraightComponent] coil cooling object, allowable types:
   #   CoilCoolingDXSingleSpeed, CoilCoolingDXTwoSpeed, CoilCoolingDXMultiSpeed
-  # @return [Bool] returns true if it is a heat pump, false if not
+  # @return [Boolean] returns true if it is a heat pump, false if not
   def coil_dx_heat_pump?(coil_dx)
     heat_pump = false
 
@@ -84,7 +84,7 @@ module CoilDX
   #
   # @param coil_dx [OpenStudio::Model::StraightComponent] coil cooling object, allowable types:
   #   CoilCoolingDXSingleSpeed, CoilCoolingDXTwoSpeed, CoilCoolingDXMultiSpeed
-  # @param necb_ref_hp [Bool] for compatability with NECB ruleset only.
+  # @param necb_ref_hp [Boolean] for compatability with NECB ruleset only.
   # @return [String] the heating type
   def coil_dx_heating_type(coil_dx, necb_ref_hp = false)
     htg_type = nil
@@ -160,8 +160,8 @@ module CoilDX
   #
   # @param coil_dx [OpenStudio::Model::StraightComponent] coil cooling object, allowable types:
   #   CoilCoolingDXSingleSpeed, CoilCoolingDXTwoSpeed, CoilCoolingDXMultiSpeed
-  # @param necb_ref_hp [Bool] for compatability with NECB ruleset only.
-  # @return [hash] has for search criteria to be used for find object
+  # @param necb_ref_hp [Boolean] for compatability with NECB ruleset only.
+  # @return [Hash] has for search criteria to be used for find object
   def coil_dx_find_search_criteria(coil_dx, necb_ref_hp = false)
     search_criteria = {}
     search_criteria['template'] = template

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

@@ -4,7 +4,7 @@ class Standard
   # Applies the standard efficiency ratings and typical performance curves to this object.
   #
   # @param coil_heating_dx_multi_speed [OpenStudio::Model::CoilHeatingDXMultiSpeed] coil heating dx multi speed object
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def coil_heating_dx_multi_speed_apply_efficiency_and_curves(coil_heating_dx_multi_speed, sql_db_vars_map)
     successfully_set_all_properties = true
 

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

@@ -6,7 +6,7 @@ class Standard
   # Finds capacity in W.  This is the cooling capacity of the paired DX cooling coil.
   #
   # @param coil_heating_dx_single_speed [OpenStudio::Model::CoilHeatingDXSingleSpeed] coil heating dx single speed object
-  # @param necb_ref_hp [Bool] for compatability with NECB ruleset only.
+  # @param necb_ref_hp [Boolean] for compatability with NECB ruleset only.
   # @return [Double] capacity in W to be used for find object
   def coil_heating_dx_single_speed_find_capacity(coil_heating_dx_single_speed, necb_ref_hp = false)
     capacity_w = nil
@@ -104,8 +104,8 @@ class Standard
   # Finds lookup object in standards and return efficiency
   #
   # @param coil_heating_dx_single_speed [OpenStudio::Model::CoilHeatingDXSingleSpeed] coil heating dx single speed object
-  # @param rename [Bool] if true, object will be renamed to include capacity and efficiency level
-  # @param necb_ref_hp [Bool] for compatability with NECB ruleset only.
+  # @param rename [Boolean] if true, object will be renamed to include capacity and efficiency level
+  # @param necb_ref_hp [Boolean] for compatability with NECB ruleset only.
   # @return [Double] full load efficiency (COP)
   def coil_heating_dx_single_speed_standard_minimum_cop(coil_heating_dx_single_speed, rename = false, necb_ref_hp = false)
     # find ac properties
@@ -129,7 +129,7 @@ class Standard
     end
 
     # If PTHP, use equations
-    if sub_category == 'PTHP'
+    if sub_category == 'PTHP' && !ac_props['pthp_cop_coefficient_1'].nil? && !ac_props['pthp_cop_coefficient_2'].nil?
       pthp_cop_coeff_1 = ac_props['pthp_cop_coefficient_1']
       pthp_cop_coeff_2 = ac_props['pthp_cop_coefficient_2']
       # TABLE 6.8.1D
@@ -181,7 +181,7 @@ class Standard
   #
   # @param coil_heating_dx_single_speed [OpenStudio::Model::CoilHeatingDXSingleSpeed] coil heating dx single speed object
   # @param sql_db_vars_map [Hash] hash map
-  # @param necb_ref_hp [Bool] for compatability with NECB ruleset only.
+  # @param necb_ref_hp [Boolean] for compatability with NECB ruleset only.
   # @return [Hash] hash of coil objects
   def coil_heating_dx_single_speed_apply_efficiency_and_curves(coil_heating_dx_single_speed, sql_db_vars_map, necb_ref_hp = false)
     successfully_set_all_properties = true

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

@@ -4,7 +4,7 @@ class Standard
   # Applies the standard efficiency ratings to CoilHeatingGas.
   #
   # @param coil_heating_gas [OpenStudio::Model::CoilHeatingGas] coil heating gas object
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def coil_heating_gas_apply_efficiency_and_curves(coil_heating_gas)
     successfully_set_all_properties = false
     # Initialize search criteria

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

@@ -19,7 +19,7 @@ class Standard
   # Applies the standard efficiency ratings and typical performance curves to this object.
   #
   # @param coil_heating_gas_multi_stage [OpenStudio::Model::CoilHeatingGasMultiStage] coil heating gas multi stage object
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def coil_heating_gas_multi_stage_apply_efficiency_and_curves(coil_heating_gas_multi_stage)
     successfully_set_all_properties = true
 

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

@@ -88,7 +88,7 @@ class Standard
   # Finds lookup object in standards and return efficiency
   #
   # @param coil_heating_water_to_air_heat_pump [OpenStudio::Model::CoilHeatingWaterToAirHeatPumpEquationFit] coil heating object
-  # @param rename [Bool] if true, object will be renamed to include capacity and efficiency level
+  # @param rename [Boolean] if true, object will be renamed to include capacity and efficiency level
   # @return [Double] full load efficiency (COP)
   def coil_heating_water_to_air_heat_pump_standard_minimum_cop(coil_heating_water_to_air_heat_pump, rename = false)
     search_criteria = {}

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

@@ -12,11 +12,11 @@ class Standard
   #   'ExteriorRoof', 'Skylight', 'TubularDaylightDome', 'TubularDaylightDiffuser', 'ExteriorFloor',
   #   'ExteriorWall', 'ExteriorWindow', 'ExteriorDoor', 'GlassDoor', 'OverheadDoor', 'GroundContactFloor',
   #   'GroundContactWall', 'GroundContactRoof'
-  # @param target_includes_int_film_coefficients [Bool] if true, subtracts off standard film interior coefficients from your
+  # @param target_includes_int_film_coefficients [Boolean] if true, subtracts off standard film interior coefficients from your
   #   target_u_value before modifying insulation thickness.  Film values from 90.1-2010 A9.4.1 Air Films
-  # @param target_includes_ext_film_coefficients [Bool] if true, subtracts off standard exterior film coefficients from your
+  # @param target_includes_ext_film_coefficients [Boolean] if true, subtracts off standard exterior film coefficients from your
   #   target_u_value before modifying insulation thickness.  Film values from 90.1-2010 A9.4.1 Air Films
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   # @todo Put in Phlyroy's logic for inferring the insulation layer of a construction
   def construction_set_u_value(construction, target_u_value_ip, insulation_layer_name = nil, intended_surface_type = 'ExteriorWall', target_includes_int_film_coefficients, target_includes_ext_film_coefficients)
     OpenStudio.logFree(OpenStudio::Debug, 'openstudio.standards.Construction', "Setting U-Value for #{construction.name}.")
@@ -134,11 +134,11 @@ class Standard
   #   'ExteriorRoof', 'Skylight', 'TubularDaylightDome', 'TubularDaylightDiffuser', 'ExteriorFloor',
   #   'ExteriorWall', 'ExteriorWindow', 'ExteriorDoor', 'GlassDoor', 'OverheadDoor', 'GroundContactFloor',
   #   'GroundContactWall', 'GroundContactRoof'
-  # @param target_includes_int_film_coefficients [Bool] if true, subtracts off standard film interior coefficients from your
+  # @param target_includes_int_film_coefficients [Boolean] if true, subtracts off standard film interior coefficients from your
   #   target_u_value before modifying insulation thickness.  Film values from 90.1-2010 A9.4.1 Air Films
-  # @param target_includes_ext_film_coefficients [Bool] if true, subtracts off standard exterior film coefficients from your
+  # @param target_includes_ext_film_coefficients [Boolean] if true, subtracts off standard exterior film coefficients from your
   #   target_u_value before modifying insulation thickness.  Film values from 90.1-2010 A9.4.1 Air Films
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def construction_set_glazing_u_value(construction, target_u_value_ip, intended_surface_type = 'ExteriorWall', target_includes_int_film_coefficients, target_includes_ext_film_coefficients)
     OpenStudio.logFree(OpenStudio::Debug, 'openstudio.standards.Construction', "Setting U-Value for #{construction.name}.")
 
@@ -219,7 +219,7 @@ class Standard
   #
   # @param construction [OpenStudio::Model::Construction] construction object
   # @param target_shgc [Double] Solar Heat Gain Coefficient
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def construction_set_glazing_shgc(construction, target_shgc)
     OpenStudio.logFree(OpenStudio::Debug, 'openstudio.standards.Construction', "Setting SHGC for #{construction.name}.")
 
@@ -244,7 +244,7 @@ class Standard
   # as indicated by having a single layer of type SimpleGlazing.
   #
   # @param construction [OpenStudio::Model::Construction] construction object
-  # @return [Bool] returns true if it is a simple glazing, false if not
+  # @return [Boolean] returns true if it is a simple glazing, false if not
   def construction_simple_glazing?(construction)
     # Not simple if more than 1 layer
     if construction.layers.length > 1
@@ -269,7 +269,7 @@ class Standard
   # @param construction [OpenStudio::Model::Construction] construction object
   # @param target_f_factor_ip [Double] F-Factor
   # @param insulation_layer_name [String] The name of the insulation layer in this construction
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def construction_set_slab_f_factor(construction, target_f_factor_ip, insulation_layer_name = nil)
     # Regression from table A6.3 unheated, fully insulated slab
     r_value_ip = 1.0248 * target_f_factor_ip**-2.186
@@ -289,7 +289,7 @@ class Standard
   # @param construction [OpenStudio::Model::FFactorGroundFloorConstruction] OpenStudio F-factor construction object
   # @param target_f_factor_ip [Float] Targeted F-Factor in IP units
   # @param surface [OpenStudio::Model::Surface] OpenStudio surface object
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def construction_set_surface_slab_f_factor(construction, target_f_factor_ip, surface)
     # Get space associated with surface
     space = surface.space.get
@@ -325,7 +325,7 @@ class Standard
   # @param construction [OpenStudio::Model::Construction] construction object
   # @param target_c_factor_ip [Double] C-Factor
   # @param insulation_layer_name [String] The name of the insulation layer in this construction
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def construction_set_underground_wall_c_factor(construction, target_c_factor_ip, insulation_layer_name = nil)
     # Regression from table A4.2 continuous exterior insulation
     r_value_ip = 0.775 * target_c_factor_ip**-1.067
@@ -345,7 +345,7 @@ class Standard
   # @param construction [OpenStudio::Model::CFactorUndergroundWallConstruction] OpenStudio C-factor construction object
   # @param target_c_factor_ip [Float] Targeted C-Factor in IP units
   # @param surface [OpenStudio::Model::Surface] OpenStudio surface object
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def construction_set_surface_underground_wall_c_factor(construction, target_c_factor_ip, surface)
     # Get space associated with surface
     space = surface.space.get
@@ -529,8 +529,7 @@ class Standard
   # Calculate the fenestration U-Factor base on the glass, frame,
   # and divider performance and area calculated by EnergyPlus.
   #
-  # @param [OpenStudio:Model:Construction] OpenStudio Construction object
-  #
+  # @param construction [OpenStudio:Model:Construction] OpenStudio Construction object
   # @return [Double] the U-Factor in W/m^2*K
   def construction_calculated_fenestration_u_factor_w_frame(construction)
     construction_name = construction.name.get.to_s
@@ -684,7 +683,7 @@ class Standard
   #
   # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param values [Hash] has of values
-  # @param is_percentage [Bool] toggle is percentage
+  # @param is_percentage [Boolean] toggle is percentage
   # @return [Hash] json information
   def change_construction_properties_in_model(model, values, is_percentage = false)
     # puts JSON.pretty_generate(values)
@@ -746,8 +745,8 @@ class Standard
   # @param conductance [Double] conductance value in SI
   # @param shgc [Double] solar heat gain coefficient value, unitless
   # @param tvis [Double] visible transmittance
-  # @param is_percentage [Bool] toggle is percentage
-  # @return [Bool] returns true if successful, false if not
+  # @param is_percentage [Boolean] toggle is percentage
+  # @return [Boolean] returns true if successful, false if not
   def apply_changes_to_surface_construction(model, surface, conductance = nil, shgc = nil, tvis = nil, is_percentage = false)
     # If user has no changes...do nothing and return true.
     return true if conductance.nil? && shgc.nil? && tvis.nil?
@@ -877,7 +876,7 @@ class Standard
   #
   # @param construction [OpenStudio::Model::Construction] construction object
   # @param target_tvis [Double] Visible Transmittance
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def construction_set_glazing_tvis(construction, target_tvis)
     if target_tvis >= 1.0
       OpenStudio.logFree(OpenStudio::Error, 'openstudio.standards.Construction', "Can only set the Tvis can only be set to less than 1.0. #{target_tvis} is greater than 1.0")

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

@@ -18,7 +18,7 @@ module CoolingTower
   #
   # @param cooling_tower [OpenStudio::Model::StraightComponent] cooling tower object, allowable types:
   #   CoolingTowerSingleSpeed, CoolingTowerTwoSpeed, and CoolingTowerVariableSpeed
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def cooling_tower_apply_minimum_power_per_flow(cooling_tower)
     # Get the design water flow rate
     design_water_flow_m3_per_s = nil
@@ -51,11 +51,11 @@ module CoolingTower
     fan_type = nil
     if name.include?('Centrifugal')
       fan_type = 'Centrifugal'
-    elsif name.include?('Propeller or Axial')
+    elsif name.include?('Propeller') || name.include?('Axial')
       fan_type = 'Propeller or Axial'
-    end
-    unless fan_type.nil?
-      search_criteria['fan_type'] = fan_type
+    else
+      fan_type = 'Propeller or Axial'
+      OpenStudio.logFree(OpenStudio::Info, 'openstudio.standards.CoolingTower', "#{cooling_tower.name} fan type is not discernible from the name. Defaulting to Propeller or Axial.")
     end
 
     # Limit on Centrifugal Fan
@@ -65,13 +65,13 @@ module CoolingTower
       if gpm_limit
         if design_water_flow_gpm >= gpm_limit
           fan_type = 'Propeller or Axial'
-          search_criteria['fan_type'] = fan_type
           OpenStudio.logFree(OpenStudio::Info, 'openstudio.standards.CoolingTower', "For #{cooling_tower.name}, the design flow rate of #{design_water_flow_gpm.round} gpm is higher than the limit of #{gpm_limit.round} gpm for open centrifugal towers.  This tower must meet the minimum performance of #{fan_type} instead.")
         end
       end
     end
 
     # Get the cooling tower properties
+    search_criteria['fan_type'] = fan_type
     ct_props = model_find_object(heat_rejection, search_criteria)
     unless ct_props
       OpenStudio.logFree(OpenStudio::Warn, 'openstudio.standards.CoolingTower', "For #{cooling_tower.name}, cannot find heat rejection properties, cannot apply standard efficiencies or curves.")

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

@@ -6,7 +6,7 @@ class Standard
   # Applies the standard efficiency ratings and typical performance curves to this object.
   #
   # @param cooling_tower_single_speed [OpenStudio::Model::CoolingTowerSingleSpeed] single speed cooling tower
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def cooling_tower_single_speed_apply_efficiency_and_curves(cooling_tower_single_speed)
     cooling_tower_apply_minimum_power_per_flow(cooling_tower_single_speed)
     return true

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

@@ -6,7 +6,7 @@ class Standard
   # Applies the standard efficiency ratings and typical performance curves to this object.
   #
   # @param cooling_tower_two_speed [OpenStudio::Model::CoolingTowerTwoSpeed] two speed cooling tower
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def cooling_tower_two_speed_apply_efficiency_and_curves(cooling_tower_two_speed)
     cooling_tower_apply_minimum_power_per_flow(cooling_tower_two_speed)
 

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

@@ -6,7 +6,7 @@ class Standard
   # Applies the standard efficiency ratings and typical performance curves to this object.
   #
   # @param cooling_tower_variable_speed [OpenStudio::Model::CoolingTowerVariableSpeed] variable speed cooling tower
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] 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)
     return true

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

@@ -8,7 +8,7 @@ module Fan
   # @param fan [OpenStudio::Model::StraightComponent] fan object, allowable types:
   #   FanConstantVolume, FanOnOff, FanVariableVolume, and FanZoneExhaust
   # @param allowed_bhp [Double] allowable brake horsepower
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def fan_apply_standard_minimum_motor_efficiency(fan, allowed_bhp)
     # Find the motor efficiency
     motor_eff, nominal_hp = fan_standard_minimum_motor_efficiency_and_size(fan, allowed_bhp)
@@ -39,7 +39,7 @@ module Fan
   # @param fan [OpenStudio::Model::StraightComponent] fan object, allowable types:
   #   FanConstantVolume, FanOnOff, FanVariableVolume, and FanZoneExhaust
   # @param target_fan_power [Double] the target fan power in watts
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def fan_adjust_pressure_rise_to_meet_fan_power(fan, target_fan_power)
     # Get design supply air flow rate (whether autosized or hard-sized)
     dsn_air_flow_m3_per_s = 0
@@ -161,7 +161,7 @@ module Fan
   # @param fan [OpenStudio::Model::StraightComponent] fan object, allowable types:
   #   FanConstantVolume, FanOnOff, FanVariableVolume, and FanZoneExhaust
   # @param motor_eff [Double] motor efficiency (0.0 to 1.0)
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def fan_change_motor_efficiency(fan, motor_eff)
     # Calculate the existing impeller efficiency
     existing_motor_eff = 0.7
@@ -190,7 +190,7 @@ module Fan
   # @param fan [OpenStudio::Model::StraightComponent] fan object, allowable types:
   #   FanConstantVolume, FanOnOff, FanVariableVolume, and FanZoneExhaust
   # @param impeller_eff [Double] impeller efficiency (0.0 to 1.0)
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def fan_change_impeller_efficiency(fan, impeller_eff)
     # Get the existing motor efficiency
     existing_motor_eff = 0.7
@@ -305,7 +305,7 @@ module Fan
   #
   # @param fan [OpenStudio::Model::StraightComponent] fan object, allowable types:
   #   FanConstantVolume, FanOnOff, FanVariableVolume, and FanZoneExhaust
-  # @return [Bool] returns true if it is a small fan, false if not
+  # @return [Boolean] returns true if it is a small fan, false if not
   def fan_small_fan?(fan)
     is_small = false
 
@@ -348,13 +348,7 @@ module Fan
   # @return [Double] rated power consumption per flow in watters per cfm, W*min/ft^3
   def fan_rated_w_per_cfm(fan)
     # Get design power (whether autosized or hard-sized)
-    rated_power_w = fan.model.getAutosizedValueFromEquipmentSummary(fan, 'Fans', 'Rated Electric Power', 'W')
-    if rated_power_w.is_initialized
-      rated_power_w = rated_power_w.get
-    else
-      rated_power_w = fan_fanpower(fan)
-      OpenStudio.logFree(OpenStudio::Warn, 'openstudio.standards.Fan', "For #{fan.name}, could not find rated fan power from Equipment Summary. Will calculate it based on current pressure rise and total fan efficiency")
-    end
+    rated_power_w = fan_fanpower(fan)
 
     if fan.maximumFlowRate.is_initialized
       max_m3_per_s = fan.ratedFlowRate.get

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

@@ -17,7 +17,7 @@ class Standard
   #   Multi Zone VAV with VSD and Fixed SP Setpoint,
   #   Multi Zone VAV with VSD and Static Pressure Reset,
   #   Single Zone VAV Fan
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def fan_variable_volume_set_control_type(fan_variable_volume, control_type)
     # Determine the coefficients
     coeff_a = nil
@@ -113,7 +113,7 @@ class Standard
   # Determines whether there is a requirement to have a VSD or some other method to reduce fan power at low part load ratios.
   #
   # @param fan_variable_volume [OpenStudio::Model::FanVariableVolume] variable volume fan object
-  # @return [Bool] returns true if required, false if not
+  # @return [Boolean] returns true if required, false if not
   def fan_variable_volume_part_load_fan_power_limitation?(fan_variable_volume)
     part_load_control_required = false
 

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

@@ -21,7 +21,7 @@ class Standard
   # @param equipment_type [String] heat rejection equipment type enumeration used for lookup query,
   #   options are 'Closed Cooling Tower', modeled as an EvaporativeFluidCooler,
   #   or 'Dry Cooler', modeled as a FluidCooler
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def fluid_cooler_apply_minimum_power_per_flow(fluid_cooler, equipment_type: 'Closed Cooling Tower')
     # Get the design water flow rate
     if fluid_cooler.designWaterFlowRate.is_initialized

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

@@ -7,7 +7,7 @@ class Standard
   #
   # @param headered_pumps_variable_speed [OpenStudio::Model::HeaderedPumpsVariableSpeed] headered variable speed pumps object
   # @param control_type [String] valid choices are Riding Curve, VSD No Reset, VSD DP Reset
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def headered_pumps_variable_speed_set_control_type(headered_pumps_variable_speed, control_type)
     # Determine the coefficients
     coeff_a = nil

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

@@ -4,7 +4,7 @@ class Standard
   # Sets the minimum effectiveness of the heat exchanger per the standard.
   #
   # @param heat_exchanger_air_to_air_sensible_and_latent [OpenStudio::Model::HeatExchangerAirToAirSensibleAndLatent] the heat exchanger
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def heat_exchanger_air_to_air_sensible_and_latent_apply_effectiveness(heat_exchanger_air_to_air_sensible_and_latent)
     # Assumed to be sensible and latent at all flow
     full_htg_sens_eff, full_htg_lat_eff, part_htg_sens_eff, part_htg_lat_eff, full_cool_sens_eff, full_cool_lat_eff, part_cool_sens_eff, part_cool_lat_eff = heat_exchanger_air_to_air_sensible_and_latent_minimum_effectiveness(heat_exchanger_air_to_air_sensible_and_latent)
@@ -46,9 +46,9 @@ class Standard
   # climate zones a 50% ERR at typical condition leads a ERR > 50%,
   # the ERR is thus scaled down.
   #
-  # @param enthalpy_recovery_ratio [float] Enthalpy Recovery Ratio (ERR)
+  # @param enthalpy_recovery_ratio [Double] Enthalpy Recovery Ratio (ERR)
   # @param climate_zone [String] climate zone
-  # @return [float] adjusted ERR
+  # @return [Double] adjusted ERR
   def enthalpy_recovery_ratio_design_to_typical_adjustment(enthalpy_recovery_ratio, climate_zone)
     if climate_zone.include? '2B'
       enthalpy_recovery_ratio /= 0.65 / 0.55