openstudio-standards 0.2.14 → 0.2.15.pre.rc1

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

@@ -5,17 +5,19 @@ class Standard
 
   # Modify the fan curve coefficients to reflect a specific type of control.
   #
+  # @param fan_variable_volume [OpenStudio::Model::FanVariableVolume] variable volume fan object
   # @param control_type [String] valid choices are:
-  # Multi Zone VAV with discharge dampers,
-  # Multi Zone VAV with VSD and SP Setpoint Reset,
-  # Multi Zone VAV with AF or BI Riding Curve,
-  # Multi Zone VAV with AF or BI with Inlet Vanes,
-  # Multi Zone VAV with FC Riding Curve,
-  # Multi Zone VAV with FC with Inlet Vanes,
-  # Multi Zone VAV with Vane-axial with Variable Pitch Blades,
-  # Multi Zone VAV with VSD and Fixed SP Setpoint,
-  # Multi Zone VAV with VSD and Static Pressure Reset,
-  # Single Zone VAV Fan
+  #   Multi Zone VAV with discharge dampers,
+  #   Multi Zone VAV with VSD and SP Setpoint Reset,
+  #   Multi Zone VAV with AF or BI Riding Curve,
+  #   Multi Zone VAV with AF or BI with Inlet Vanes,
+  #   Multi Zone VAV with FC Riding Curve,
+  #   Multi Zone VAV with FC with Inlet Vanes,
+  #   Multi Zone VAV with Vane-axial with Variable Pitch Blades,
+  #   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
   def fan_variable_volume_set_control_type(fan_variable_volume, control_type)
     # Determine the coefficients
     coeff_a = nil
@@ -105,11 +107,13 @@ class Standard
 
     # Append the control type to the fan name
     # self.setName("#{self.name} #{control_type}")
+    return true
   end
 
-  # Determines whether there is a requirement to have a
-  # VSD or some other method to reduce fan power
-  # at low part load ratios.
+  # 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
   def fan_variable_volume_part_load_fan_power_limitation?(fan_variable_volume)
     part_load_control_required = false
 
@@ -159,7 +163,7 @@ class 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
@@ -168,7 +172,7 @@ class 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
@@ -176,8 +180,10 @@ class Standard
   end
 
   # Determine if the cooling system is DX, CHW, evaporative, or a mixture.
+  #
+  # @param fan_variable_volume [OpenStudio::Model::FanVariableVolume] variable volume fan object
   # @return [String] the cooling system type.  Possible options are:
-  # dx, chw, evaporative, mixed, unknown.
+  #   dx, chw, evaporative, mixed, unknown.
   def fan_variable_volume_cooling_system_type(fan_variable_volume)
     clg_sys_type = 'unknown'
 

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] true if successful, false if not
+  # @return [Bool] 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
@@ -45,7 +45,7 @@ class Standard
     # Closed cooling towers are fluidcooler objects.
     search_criteria['equipment_type'] = equipment_type
 
-    # TODO: Standards replace this with a mechanism to store this
+    # @todo Standards replace this with a mechanism to store this
     # data in the fluid cooler object itself.
     # For now, retrieve the fan type from the name
     name = fluid_cooler.name.get

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

@@ -3,11 +3,11 @@ class Standard
 
   include Pump
 
-  # Set the pump curve coefficients based
-  # on the specified control type.
+  # Set the pump curve coefficients based on the specified control type.
   #
-  # @param control_type [String] valid choices
-  # are Riding Curve, VSD No Reset, VSD DP Reset
+  # @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
   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

@@ -1,33 +1,91 @@
 class Standard
   # @!group HeatExchangerSensLat
 
-  # Sets the minimum effectiveness of the heat exchanger per
-  # the standard.
-  def heat_exchanger_air_to_air_sensible_and_latent_apply_efficiency(heat_exchanger_air_to_air_sensible_and_latent)
+  # 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
+  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
-    min_effct = heat_exchanger_air_to_air_sensible_and_latent_minimum_efficiency(heat_exchanger_air_to_air_sensible_and_latent)
+    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)
 
-    heat_exchanger_air_to_air_sensible_and_latent.setSensibleEffectivenessat100HeatingAirFlow(min_effct)
-    heat_exchanger_air_to_air_sensible_and_latent.setLatentEffectivenessat100HeatingAirFlow(min_effct)
-    heat_exchanger_air_to_air_sensible_and_latent.setSensibleEffectivenessat75HeatingAirFlow(min_effct)
-    heat_exchanger_air_to_air_sensible_and_latent.setLatentEffectivenessat75HeatingAirFlow(min_effct)
-    heat_exchanger_air_to_air_sensible_and_latent.setSensibleEffectivenessat100CoolingAirFlow(min_effct)
-    heat_exchanger_air_to_air_sensible_and_latent.setLatentEffectivenessat100CoolingAirFlow(min_effct)
-    heat_exchanger_air_to_air_sensible_and_latent.setSensibleEffectivenessat75CoolingAirFlow(min_effct)
-    heat_exchanger_air_to_air_sensible_and_latent.setLatentEffectivenessat75CoolingAirFlow(min_effct)
+    heat_exchanger_air_to_air_sensible_and_latent.setSensibleEffectivenessat100HeatingAirFlow(full_htg_sens_eff)
+    heat_exchanger_air_to_air_sensible_and_latent.setLatentEffectivenessat100HeatingAirFlow(full_htg_lat_eff)
+    heat_exchanger_air_to_air_sensible_and_latent.setSensibleEffectivenessat75HeatingAirFlow(part_htg_sens_eff)
+    heat_exchanger_air_to_air_sensible_and_latent.setLatentEffectivenessat75HeatingAirFlow(part_htg_lat_eff)
+    heat_exchanger_air_to_air_sensible_and_latent.setSensibleEffectivenessat100CoolingAirFlow(full_cool_sens_eff)
+    heat_exchanger_air_to_air_sensible_and_latent.setLatentEffectivenessat100CoolingAirFlow(full_cool_lat_eff)
+    heat_exchanger_air_to_air_sensible_and_latent.setSensibleEffectivenessat75CoolingAirFlow(part_cool_sens_eff)
+    heat_exchanger_air_to_air_sensible_and_latent.setLatentEffectivenessat75CoolingAirFlow(part_cool_lat_eff)
 
-    OpenStudio.logFree(OpenStudio::Info, 'openstudio.standards.HeatExchangerSensLat', "For #{heat_exchanger_air_to_air_sensible_and_latent.name}: Set sensible and latent effectiveness to #{(min_effct * 100).round}%.")
+    OpenStudio.logFree(OpenStudio::Info, 'openstudio.standards.HeatExchangerSensLat', "For #{heat_exchanger_air_to_air_sensible_and_latent.name}: Set sensible and latent effectiveness.")
 
     return true
   end
 
-  # Defines the minimum sensible and latent effectiveness of
-  # the heat exchanger.  Assumed to apply to sensible and latent
-  # effectiveness at all flow rates.
+  # Defines the minimum sensible and latent effectiveness of the heat exchanger.
+  # Assumed to apply to sensible and latent effectiveness at all flow rates.
   #
   # @param heat_exchanger_air_to_air_sensible_and_latent [OpenStudio::Model::HeatExchangerAirToAirSensibleAndLatent] the heat exchanger
-  def heat_exchanger_air_to_air_sensible_and_latent_minimum_efficiency(heat_exchanger_air_to_air_sensible_and_latent)
-    min_effct = 0.5
-    return min_effct
+  def heat_exchanger_air_to_air_sensible_and_latent_minimum_effectiveness(heat_exchanger_air_to_air_sensible_and_latent)
+    full_htg_sens_eff = 0.5
+    full_htg_lat_eff = 0.5
+    part_htg_sens_eff = 0.5
+    part_htg_lat_eff = 0.5
+    full_cool_sens_eff = 0.5
+    full_cool_lat_eff = 0.5
+    part_cool_sens_eff = 0.5
+    part_cool_lat_eff = 0.5
+
+    return 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
+  end
+
+  # Adjust ERR from design conditions to ERR for typical conditions.
+  # This is only applies to the 2B and 3B climate zones. In these
+  # 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 climate_zone [String] climate zone
+  # @return [float] 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
+    elsif climate_zone.include? '3B'
+      enthalpy_recovery_ratio /= 0.62 / 0.55
+    end
+
+    return enthalpy_recovery_ratio
+  end
+
+  # Calculate a heat exchanger's effectiveness for a specific ERR and design conditions.
+  # Regressions were determined based available manufacturer data.
+  #
+  # @param enthalpy_recovery_ratio [float] Enthalpy Recovery Ratio (ERR)
+  # @param design_conditions [String] design_conditions for effectiveness calculation, either 'cooling' or 'heating'
+  # @return [Array] heating and cooling heat exchanger effectiveness at 100% and 75% nominal airflow
+  def heat_exchanger_air_to_air_sensible_and_latent_enthalpy_recovery_ratio_to_effectiveness(enthalpy_recovery_ratio, design_conditions)
+    case design_conditions
+      when 'cooling'
+        full_htg_sens_eff = (20.707 * enthalpy_recovery_ratio**2 + 41.354 * enthalpy_recovery_ratio + 40.755) / 100
+        full_htg_lat_eff = (127.45 * enthalpy_recovery_ratio - 18.625) / 100
+        part_htg_sens_eff = (-0.1214 * enthalpy_recovery_ratio + 1.111) * full_htg_sens_eff
+        part_htg_lat_eff = (-0.3405 * enthalpy_recovery_ratio + 1.2732) * full_htg_lat_eff
+        full_cool_sens_eff = (70.689 * enthalpy_recovery_ratio + 30.789) / 100
+        full_cool_lat_eff = (48.054 * enthalpy_recovery_ratio**2 + 83.082 * enthalpy_recovery_ratio - 12.881) / 100
+        part_cool_sens_eff = (-0.1214 * enthalpy_recovery_ratio + 1.111) * full_cool_sens_eff
+        part_cool_lat_eff = (-0.3982 * enthalpy_recovery_ratio  + 1.3151) * full_cool_lat_eff
+      when 'heating'
+        full_htg_sens_eff = enthalpy_recovery_ratio
+        full_htg_lat_eff = 0.0
+        part_htg_sens_eff = (-0.1214 * enthalpy_recovery_ratio + 1.111) * full_htg_sens_eff
+        part_htg_lat_eff = 0.0
+        full_cool_sens_eff = enthalpy_recovery_ratio * (70.689 * enthalpy_recovery_ratio + 30.789) / (20.707 * enthalpy_recovery_ratio**2 + 41.354 * enthalpy_recovery_ratio + 40.755)
+        full_cool_lat_eff = 0.0
+        part_cool_sens_eff = (-0.1214 * enthalpy_recovery_ratio + 1.111) * full_cool_sens_eff
+        part_cool_lat_eff = 0.0
+    end
+
+    return 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
   end
 end