openstudio-standards 0.2.14 → 0.2.15.pre.rc1

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

@@ -1,12 +1,95 @@
 class Standard
   # @!group CoilHeatingGas
 
-  # Applies the standard efficiency ratings and typical performance curves to this object.
+  # Applies the standard efficiency ratings to CoilHeatingGas.
   #
-  # @return [Bool] true if successful, false if not
+  # @param coil_heating_gas [OpenStudio::Model::CoilHeatingGas] coil heating gas object
+  # @return [Bool] returns true if successful, false if not
   def coil_heating_gas_apply_efficiency_and_curves(coil_heating_gas)
-    successfully_set_all_properties = true
+    successfully_set_all_properties = false
+    # Initialize search criteria
+    search_criteria = {}
+    search_criteria['template'] = template
+
+    # Get the capacity, but return false if not available
+    capacity_w = coil_heating_gas_find_capacity(coil_heating_gas)
+
+    # Return false if the coil does not have a heating capacity associated with it. Cannot apply the standard if without
+    # it.
+    return successfully_set_all_properties if capacity_w == false
+
+    # Convert capacity to Btu/hr
+    capacity_btu_per_hr = OpenStudio.convert(capacity_w, 'W', 'Btu/hr').get
+    capacity_kbtu_per_hr = OpenStudio.convert(capacity_w, 'W', 'kBtu/hr').get
+
+    # Get the boiler properties, if it exists for this template
+    return false unless standards_data.include?('furnaces')
+
+    furnace_props = model_find_object(standards_data['furnaces'], search_criteria, capacity_btu_per_hr)
+    unless furnace_props
+      OpenStudio.logFree(OpenStudio::Warn, 'openstudio.standards.CoilHeatingGas', "For #{coil_heating_gas.name}, cannot find furnace properties with search criteria #{search_criteria}, cannot apply efficiency standard.")
+      successfully_set_all_properties = false
+      return successfully_set_all_properties
+    end
+
+    # Get the minimum efficiency standards
+    thermal_eff = nil
+
+    # If specified as thermal efficiency, this takes precedent
+    if !furnace_props['minimum_thermal_efficiency'].nil?
+      thermal_eff = furnace_props['minimum_thermal_efficiency']
+      new_comp_name = "#{coil_heating_gas.name} #{capacity_kbtu_per_hr.round}kBtu/hr #{thermal_eff} Thermal Eff"
+      OpenStudio.logFree(OpenStudio::Info, 'openstudio.standards.CoilHeatingGas', "For #{template}: #{coil_heating_gas.name}: = #{capacity_kbtu_per_hr.round}kBtu/hr; Thermal Efficiency = #{thermal_eff}")
+
+    else # If not thermal efficiency, check other parameters
+
+      # If specified as AFUE
+      unless furnace_props['minimum_annual_fuel_utilization_efficiency'].nil?
+        min_afue = furnace_props['minimum_annual_fuel_utilization_efficiency']
+        thermal_eff = afue_to_thermal_eff(min_afue)
+        new_comp_name = "#{coil_heating_gas.name} #{capacity_kbtu_per_hr.round}kBtu/hr #{min_afue} AFUE"
+        OpenStudio.logFree(OpenStudio::Info, 'openstudio.standards.CoilHeatingGas', "For #{template}: #{coil_heating_gas.name}: = #{capacity_kbtu_per_hr.round}kBtu/hr; AFUE = #{min_afue}")
+      end
+
+      # If specified as combustion efficiency
+      unless furnace_props['minimum_combustion_efficiency'].nil?
+        min_comb_eff = furnace_props['minimum_combustion_efficiency']
+        thermal_eff = combustion_eff_to_thermal_eff(min_comb_eff)
+        new_comp_name = "#{coil_heating_gas.name} #{capacity_kbtu_per_hr.round}kBtu/hr #{min_comb_eff} Combustion Eff"
+        OpenStudio.logFree(OpenStudio::Info, 'openstudio.standards.CoilHeatingGas', "For #{template}: #{coil_heating_gas.name}: = #{capacity_kbtu_per_hr.round}kBtu/hr; Combustion Efficiency = #{min_comb_eff}")
+      end
+
+    end
+
+    # Set the efficiency values
+    unless thermal_eff.nil?
+
+      # Set the name
+      coil_heating_gas.setName(new_comp_name)
+      coil_heating_gas.setGasBurnerEfficiency(thermal_eff)
+      successfully_set_all_properties = true
+    end
 
     return successfully_set_all_properties
   end
+
+  # Retrieves the capacity of an OpenStudio::Model::CoilHeatingGas in watts
+  #
+  # @param coil_heating_gas [OpenStudio::Model::CoilHeatingGas] the gas heating coil
+  # @return [Double, false] a double representing the capacity of the CoilHeatingGas object in watts. If unsuccessful in
+  #   determining the capacity, this function returns false.
+  def coil_heating_gas_find_capacity(coil_heating_gas)
+    capacity_w = nil
+    if coil_heating_gas.nominalCapacity.is_initialized
+      capacity_w = coil_heating_gas.nominalCapacity.get
+    elsif coil_heating_gas.autosizedNominalCapacity.is_initialized
+      capacity_w = coil_heating_gas.autosizedNominalCapacity.get
+    else
+      OpenStudio.logFree(OpenStudio::Warn, 'openstudio.standards.CoilHeatingGas', "For #{coil_heating_gas.name} capacity is not available, cannot apply efficiency standard.")
+      successfully_set_all_properties = false
+      return successfully_set_all_properties
+    end
+
+    return capacity_w
+  end
 end

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

@@ -3,6 +3,7 @@ class Standard
 
   # find search criteria
   #
+  # @param coil_heating_gas_multi_stage [OpenStudio::Model::CoilHeatingGasMultiStage] coil heating gas multi stage object
   # @return [Hash] used for model_find_object(model)
   def coil_heating_gas_multi_stage_find_search_criteria(coil_heating_gas_multi_stage)
     # Define the criteria to find the coil heating gas multi-stage properties
@@ -17,8 +18,9 @@ class Standard
 
   # Applies the standard efficiency ratings and typical performance curves to this object.
   #
-  # @return [Bool] true if successful, false if not
-  def coil_heating_gas_multi_stage_apply_efficiency_and_curves(coil_heating_gas_multi_stage, standards)
+  # @param coil_heating_gas_multi_stage [OpenStudio::Model::CoilHeatingGasMultiStage] coil heating gas multi stage object
+  # @return [Bool] 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
 
     # Get the coil capacity
@@ -46,6 +48,7 @@ class Standard
 
   # Finds capacity in W
   #
+  # @param coil_heating_gas_multi_stage [OpenStudio::Model::CoilHeatingGasMultiStage] coil heating gas multi stage object
   # @return [Double] capacity in W to be used for find object
   def coil_heating_gas_multi_stage_find_capacity(coil_heating_gas_multi_stage)
     capacity_w = nil

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

@@ -4,6 +4,7 @@ class Standard
   # Finds capacity in W.
   # This is the cooling capacity of the paired cooling coil.
   #
+  # @param coil_heating_water_to_air_heat_pump [OpenStudio::Model::CoilHeatingWaterToAirHeatPumpEquationFit] coil heating object
   # @return [Double] capacity in W to be used for find object
   def coil_heating_water_to_air_heat_pump_find_capacity(coil_heating_water_to_air_heat_pump)
     capacity_w = nil
@@ -86,6 +87,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
   # @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)
@@ -125,7 +127,9 @@ class Standard
 
   # Applies the standard efficiency ratings and typical performance curves to this object.
   #
-  # @return [Bool] true if successful, false if not
+  # @param coil_heating_water_to_air_heat_pump [OpenStudio::Model::CoilHeatingWaterToAirHeatPumpEquationFit] coil heating object
+  # @param sql_db_vars_map [Hash] hash map
+  # @return [Hash] hash of coil objects
   def coil_heating_water_to_air_heat_pump_apply_efficiency_and_curves(coil_heating_water_to_air_heat_pump, sql_db_vars_map)
     successfully_set_all_properties = true
 
@@ -145,7 +149,7 @@ class Standard
       return sql_db_vars_map
     end
 
-    # TODO: Add methods to set coefficients, and add coefficients to data spreadsheet
+    # @todo Add methods to set coefficients, and add coefficients to data spreadsheet
     # using OS defaults for now
     # heat_cap_coeff1 = coil_props['heat_cap_coeff1']
     # if heat_cap_coeff1

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

@@ -1,9 +1,9 @@
 class Standard
   # @!group Construction
 
-  # Sets the U-value of a construction to a specified value
-  # by modifying the thickness of the insulation layer.
+  # Sets the U-value of a construction to a specified value by modifying the thickness of the insulation layer.
   #
+  # @param construction [OpenStudio::Model::Construction] construction object
   # @param target_u_value_ip [Double] U-Value (Btu/ft^2*hr*R)
   # @param insulation_layer_name [String] The name of the insulation layer in this construction
   # @param intended_surface_type [String]
@@ -118,9 +118,9 @@ class Standard
     return true
   end
 
-  # Sets the U-value of a construction to a specified value
-  # by modifying the thickness of the insulation layer.
+  # Sets the U-value of a construction to a specified value by modifying the thickness of the insulation layer.
   #
+  # @param construction [OpenStudio::Model::Construction] construction object
   # @param target_u_value_ip [Double] U-Value (Btu/ft^2*hr*R)
   # @param intended_surface_type [String]
   #   Valid choices:  'AtticFloor', 'AtticWall', 'AtticRoof', 'DemisingFloor', 'InteriorFloor', 'InteriorCeiling',
@@ -209,9 +209,9 @@ class Standard
     return true
   end
 
-  # Sets the U-value of a construction to a specified value
-  # by modifying the thickness of the insulation layer.
+  # Sets the U-value of a construction to a specified value by modifying the thickness of the insulation layer.
   #
+  # @param construction [OpenStudio::Model::Construction] construction object
   # @param target_shgc [Double] Solar Heat Gain Coefficient
   # @return [Bool] returns true if successful, false if not
   def construction_set_glazing_shgc(construction, target_shgc)
@@ -236,7 +236,9 @@ class Standard
 
   # Determines if the construction is a simple glazing construction,
   # as indicated by having a single layer of type SimpleGlazing.
-  # @return [Bool] returns true if it is a simple glazing, false if not.
+  #
+  # @param construction [OpenStudio::Model::Construction] construction object
+  # @return [Bool] 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
@@ -257,6 +259,7 @@ class Standard
   # the insulation layer according to the values from 90.1-2004
   # Table A6.3 Assembly F-Factors for Slab-on-Grade Floors.
   #
+  # @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
@@ -279,6 +282,7 @@ class Standard
   # the insulation layer according to the values from 90.1-2004
   # Table A4.2 Assembly C-Factors for Below-Grade walls.
   #
+  # @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
@@ -298,6 +302,8 @@ class Standard
 
   # Get the SHGC as calculated by EnergyPlus.
   # Only applies to fenestration constructions.
+  #
+  # @param construction [OpenStudio::Model::Construction] construction object
   # @return [Double] the SHGC as a decimal.
   def construction_calculated_solar_heat_gain_coefficient(construction)
     construction_name = construction.name.get.to_s
@@ -348,6 +354,8 @@ class Standard
 
   # Get the VT as calculated by EnergyPlus.
   # Only applies to fenestration constructions.
+  #
+  # @param construction [OpenStudio::Model::Construction] construction object
   # @return [Double] the visible transmittance as a decimal.
   def construction_calculated_visible_transmittance(construction)
     construction_name = construction.name.get.to_s
@@ -398,6 +406,8 @@ class Standard
 
   # Get the U-Factor as calculated by EnergyPlus.
   # Only applies to fenestration constructions.
+  #
+  # @param construction [OpenStudio::Model::Construction] construction object
   # @return [Double] the U-Factor in W/m^2*K.
   def construction_calculated_u_factor(construction)
     construction_name = construction.name.get.to_s
@@ -446,39 +456,48 @@ class Standard
     return u_factor_w_per_m2_k
   end
 
+  # find and get the insulation layer for a construction
+  #
+  # @param construction [OpenStudio::Model::Construction] construction object
+  # @return [OpenStudio::Model::Material] insulation layer
   def find_and_set_insulation_layer(construction)
     # skip if already has an insulation layer set.
-    if construction.insulation.empty?
-      # find insulation layer
-      min_conductance = 100.0
-      # loop through Layers
-      construction.layers.each do |layer|
-        # try casting the layer to an OpaqueMaterial.
-        material = nil
-        material = layer.to_OpaqueMaterial.get unless layer.to_OpaqueMaterial.empty?
-        material = layer.to_FenestrationMaterial.get unless layer.to_FenestrationMaterial.empty?
-        # check if the cast was successful, then find the insulation layer.
-        unless material.nil?
-
-          if BTAP::Resources::Envelope::Materials.get_conductance(material) < min_conductance
-            # Keep track of the highest thermal resistance value.
-            min_conductance = BTAP::Resources::Envelope::Materials.get_conductance(material)
-            return_material = material
-            unless material.to_OpaqueMaterial.empty?
-              construction.setInsulation(material)
-            end
+    return construction.insulation.get unless construction.insulation.empty?
+
+    # find insulation layer
+    min_conductance = 100.0
+    # loop through Layers
+    construction.layers.each do |layer|
+      # try casting the layer to an OpaqueMaterial.
+      material = nil
+      material = layer.to_OpaqueMaterial.get unless layer.to_OpaqueMaterial.empty?
+      material = layer.to_FenestrationMaterial.get unless layer.to_FenestrationMaterial.empty?
+      # check if the cast was successful, then find the insulation layer.
+      unless material.nil?
+
+        if BTAP::Resources::Envelope::Materials.get_conductance(material) < min_conductance
+          # Keep track of the highest thermal resistance value.
+          min_conductance = BTAP::Resources::Envelope::Materials.get_conductance(material)
+          return_material = material
+          unless material.to_OpaqueMaterial.empty?
+            construction.setInsulation(material)
           end
         end
       end
-      if construction.insulation.empty? && construction.isOpaque
-        raise
-        OpenStudio.logFree(OpenStudio::Error, 'openstudio.standards.Construction', "This construction has no insulation layer specified. Construction #{construction.name.get} insulation layer could not be set!. This occurs when a insulation layer is duplicated in the construction.")
-      end
-    else
-      return construction.insulation.get
     end
+    if construction.insulation.empty? && construction.isOpaque
+      raise
+      OpenStudio.logFree(OpenStudio::Error, 'openstudio.standards.Construction', "This construction has no insulation layer specified. Construction #{construction.name.get} insulation layer could not be set!. This occurs when a insulation layer is duplicated in the construction.")
+    end
+    return construction.insulation.get
   end
 
+  # change construction properties based on an a set of values
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param values [Hash] has of values
+  # @param is_percentage [Bool] toggle is percentage
+  # @return [Hash] json information
   def change_construction_properties_in_model(model, values, is_percentage = false)
     puts JSON.pretty_generate(values)
     # copy orginal model for reporting.
@@ -532,6 +551,15 @@ class Standard
     return info
   end
 
+  # apply changes to a surface construction
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param surface [OpenStudio::Model::Surface] surface object
+  # @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
   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?
@@ -634,13 +662,15 @@ class Standard
       new_construction = new_construction.get
     end
     surface.setConstruction(new_construction)
+    return true
   end
 
   # This will create a deep copy of the construction
   # @author Phylroy A. Lopez <plopez@nrcan.gc.ca>
-  # @param model [OpenStudio::Model::Model]
-  # @param construction <String>
-  # @return [String] new_construction
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param construction [OpenStudio::Model::Construction] construction object
+  # @return [OpenStudio::Model::Construction] new construction object
   def construction_deep_copy(model, construction)
     construction = BTAP::Common.validate_array(model, construction, 'Construction').first
     new_construction = construction.clone.to_Construction.get
@@ -657,6 +687,7 @@ class Standard
   # Sets the T-vis of a simple glazing construction to a specified value
   # by modifying the thickness of the insulation layer.
   #
+  # @param construction [OpenStudio::Model::Construction] construction object
   # @param target_tvis [Double] Visible Transmittance
   # @return [Bool] returns true if successful, false if not
   def construction_set_glazing_tvis(construction, target_tvis)

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

@@ -16,7 +16,9 @@ module CoolingTower
   # rate will not (and should not)
   # exactly equal the minimum tower performance.
   #
-  # @return [Bool] true if successful, false if not
+  # @param cooling_tower [OpenStudio::Model::StraightComponent] cooling tower object, allowable types:
+  #   CoolingTowerSingleSpeed, CoolingTowerTwoSpeed, and CoolingTowerVariableSpeed
+  # @return [Bool] 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
@@ -42,7 +44,7 @@ module CoolingTower
     # Closed cooling towers are the fluidcooler objects.
     search_criteria['equipment_type'] = 'Open Cooling Tower'
 
-    # TODO: Standards replace this with a mechanism to store this
+    # @todo Standards replace this with a mechanism to store this
     # data in the cooling tower object itself.
     # For now, retrieve the fan type from the name
     name = cooling_tower.name.get
@@ -135,12 +137,10 @@ module CoolingTower
     return true
   end
 
-  # Above this point, centrifugal fan cooling towers must meet the limits
-  # of propeller or axial cooling towers instead.
+  # Above this point, centrifugal fan cooling towers must meet the limits of propeller or axial cooling towers instead.
   #
-  # @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 = nil

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

@@ -5,10 +5,10 @@ class Standard
 
   # Applies the standard efficiency ratings and typical performance curves to this object.
   #
-  # @return [Bool] true if successful, false if not
+  # @param cooling_tower_single_speed [OpenStudio::Model::CoolingTowerSingleSpeed] single speed cooling tower
+  # @return [Bool] 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
   end
 end

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

@@ -5,7 +5,8 @@ class Standard
 
   # Applies the standard efficiency ratings and typical performance curves to this object.
   #
-  # @return [Bool] true if successful, false if not
+  # @param cooling_tower_two_speed [OpenStudio::Model::CoolingTowerTwoSpeed] two speed cooling tower
+  # @return [Bool] 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

@@ -5,7 +5,8 @@ class Standard
 
   # Applies the standard efficiency ratings and typical performance curves to this object.
   #
-  # @return [Bool] true if successful, false if not
+  # @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)
     return true

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

@@ -3,8 +3,12 @@
 module Fan
   # @!group Fan
 
-  # Applies the minimum motor efficiency for this fan
-  # based on the motor's brake horsepower.
+  # Applies the minimum motor efficiency for this fan based on the motor's brake horsepower.
+  #
+  # @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
   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)
@@ -32,8 +36,10 @@ module Fan
   # Adjust the fan pressure rise to hit the target fan power (W).
   # Keep the fan impeller and motor efficiencies static.
   #
-  # @param target_fan_power [Double] the target fan power in W
-  # @return [Bool] true if successful, false if not
+  # @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
   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
@@ -67,11 +73,12 @@ module Fan
     return true
   end
 
-  # Determines the fan power (W) based on
-  # flow rate, pressure rise, and total fan efficiency(impeller eff * motor eff)
+  # Determines the fan power (W) based on flow rate,
+  # pressure rise, and total fan efficiency(impeller eff * motor eff)
   #
-  # @return [Double] fan power
-  #   @units Watts (W)
+  # @param fan [OpenStudio::Model::StraightComponent] fan object, allowable types:
+  #   FanConstantVolume, FanOnOff, FanVariableVolume, and FanZoneExhaust
+  # @return [Double] fan power in watts
   def fan_fanpower(fan)
     # Get design supply air flow rate (whether autosized or hard-sized)
     dsn_air_flow_m3_per_s = if fan.to_FanZoneExhaust.empty?
@@ -104,11 +111,11 @@ module Fan
     return fan_power_w
   end
 
-  # Determines the brake horsepower of the fan
-  # based on fan power and fan motor efficiency.
+  # Determines the brake horsepower of the fan based on fan power and fan motor efficiency.
   #
+  # @param fan [OpenStudio::Model::StraightComponent] fan object, allowable types:
+  #   FanConstantVolume, FanOnOff, FanVariableVolume, and FanZoneExhaust
   # @return [Double] brake horsepower
-  #   @units horsepower (hp)
   def fan_brake_horsepower(fan)
     # Get the fan motor efficiency
     existing_motor_eff = 0.7
@@ -125,11 +132,11 @@ module Fan
     return fan_bhp
   end
 
-  # Determines the horsepower of the fan
-  # motor, including motor efficiency and
-  # fan impeller efficiency.
+  # Determines the horsepower of the fan motor, including motor efficiency and fan impeller efficiency.
   #
-  # @return [Double] horsepower
+  # @param fan [OpenStudio::Model::StraightComponent] fan object, allowable types:
+  #   FanConstantVolume, FanOnOff, FanVariableVolume, and FanZoneExhaust
+  # @return [Double] motor horsepower
   def fan_motor_horsepower(fan)
     # Get the fan power
     fan_power_w = fan_fanpower(fan)
@@ -143,7 +150,10 @@ module Fan
   # Changes the fan motor efficiency and also the fan total efficiency
   # at the same time, preserving the impeller efficiency.
   #
+  # @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
   def fan_change_motor_efficiency(fan, motor_eff)
     # Calculate the existing impeller efficiency
     existing_motor_eff = 0.7
@@ -163,12 +173,16 @@ module Fan
       fan.setFanEfficiency(new_total_eff)
       fan.setMotorEfficiency(motor_eff)
     end
+    return true
   end
 
   # Changes the fan impeller efficiency and also the fan total efficiency
   # at the same time, preserving the motor efficiency.
   #
+  # @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
   def fan_change_impeller_efficiency(fan, impeller_eff)
     # Get the existing motor efficiency
     existing_motor_eff = 0.7
@@ -181,21 +195,23 @@ module Fan
 
     # Set the revised motor and total fan efficiencies
     fan.setFanEfficiency(new_total_eff)
+    return true
   end
 
-  # Determines the baseline fan impeller efficiency
-  # based on the specified fan type.
+  # Determines the baseline fan impeller efficiency based on the specified fan type.
   #
+  # @param fan [OpenStudio::Model::StraightComponent] fan object, allowable types:
+  #   FanConstantVolume, FanOnOff, FanVariableVolume, and FanZoneExhaust
   # @return [Double] impeller efficiency (0.0 to 1.0)
   # @todo Add fan type to data model and modify this method
   def fan_baseline_impeller_efficiency(fan)
     # Assume that the fan efficiency is 65% for normal fans
     # and 55% for small fans (like exhaust fans).
-    # TODO add fan type to fan data model
+    # @todo add fan type to fan data model
     # and infer impeller efficiency from that?
     # or do we always assume a certain type of
     # fan impeller for the baseline system?
-    # TODO check COMNET and T24 ACM and PNNL 90.1 doc
+    # @todo check COMNET and T24 ACM and PNNL 90.1 doc
     fan_impeller_eff = 0.65
 
     if fan_small_fan?(fan)
@@ -205,15 +221,16 @@ module Fan
     return fan_impeller_eff
   end
 
-  # Determines the minimum fan 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.
+  # Determines the minimum fan 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 fan [OpenStudio::Model::StraightComponent] fan object, allowable types:
+  #   FanConstantVolume, FanOnOff, FanVariableVolume, and FanZoneExhaust
   # @param motor_bhp [Double] motor brake horsepower (hp)
   # @return [Array<Double>] minimum motor efficiency (0.0 to 1.0), nominal horsepower
   def fan_standard_minimum_motor_efficiency_and_size(fan, motor_bhp)
@@ -275,10 +292,11 @@ module Fan
     return [fan_motor_eff, nominal_hp]
   end
 
-  # Zone exhaust fans, fan coil unit fans,
-  # and powered VAV terminal fans all count
-  # as small fans and get different impeller efficiencies
-  # and motor efficiencies than other fans
+  # Zone exhaust fans, fan coil unit fans, and powered VAV terminal fans all count
+  # as small fans and get different impeller efficiencies and motor efficiencies than other fans
+  #
+  # @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
   def fan_small_fan?(fan)
     is_small = false
@@ -315,11 +333,11 @@ module Fan
     return is_small
   end
 
-  # Find the actual rated fan power per flow (W/CFM)
-  # by querying the sql file
+  # Find the actual rated fan power per flow (W/CFM) by querying the sql file
   #
-  # @return [Double] rated power consumption per flow
-  #   @units Watts per CFM (W*min/ft^3)
+  # @param fan [OpenStudio::Model::StraightComponent] fan object, allowable types:
+  #   FanConstantVolume, FanOnOff, FanVariableVolume, and FanZoneExhaust
+  # @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')