openstudio-standards 0.2.14 → 0.2.15.pre.rc1

data/lib/openstudio-standards/prototypes/ashrae_90_1/doe_ref_pre_1980/doe_ref_pre_1980.AirTerminalSingleDuctVAVReheat.rb

@@ -4,7 +4,8 @@ class DOERefPre1980 < ASHRAE901
   # Zones with low OA per area get lower initial guesses.
   # Final position will be adjusted upward as necessary by Standards.AirLoopHVAC.apply_minimum_vav_damper_positions
   #
-  # @param zone_oa_per_area [Double] the zone outdoor air per area, m^3/s
+  # @param air_terminal_single_duct_vav_reheat [OpenStudio::Model::AirTerminalSingleDuctVAVReheat] the air terminal object
+  # @param zone_oa_per_area [Double] the zone outdoor air per area in m^3/s*m^2
   # @return [Bool] returns true if successful, false if not
   def air_terminal_single_duct_vav_reheat_apply_initial_prototype_damper_position(air_terminal_single_duct_vav_reheat, zone_oa_per_area)
     # Set the minimum flow fraction

data/lib/openstudio-standards/prototypes/ashrae_90_1/doe_ref_pre_1980/doe_ref_pre_1980.CoilHeatingGas.rb

@@ -1,11 +1,12 @@
 class DOERefPre1980 < ASHRAE901
   # @!group CoilHeatingGas
 
-  # Updates the efficiency of some gas heating coils
-  # per the prototype assumptions. Sets heating coils
-  # inside PSZ-AC systems to 78% efficiency per
-  # the older vintages.
+  # Updates the efficiency of some gas heating coils per the prototype assumptions.
+  # Sets heating coils inside PSZ-AC systems to 78% efficiency per the older vintages.
   # @todo Refactor: remove inconsistency in logic; all coils should be lower efficiency
+  #
+  # @param coil_heating_gas [OpenStudio::Model::CoilHeatingGas] a gas heating coil
+  # @return [Bool] returns true if successful, false if not
   def coil_heating_gas_apply_prototype_efficiency(coil_heating_gas)
     # Only modify coils in PSZ-AC units
     name_patterns = ['PSZ-AC Gas Htg Coil',

data/lib/openstudio-standards/prototypes/ashrae_90_1/doe_ref_pre_1980/doe_ref_pre_1980.Model.elevators.rb

@@ -3,18 +3,16 @@ class DOERefPre1980 < ASHRAE901
 
   # Add an elevator the the specified space
   #
-  # @param space [OpenStudio::Model::Space] the space
-  # to assign the elevators to.
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param space [OpenStudio::Model::Space] the space to assign the elevators to.
   # @param number_of_elevators [Integer] the number of elevators
-  # @param elevator_type [String] valid choices are
-  # Traction, Hydraulic
+  # @param elevator_type [String] valid choices are Traction, Hydraulic
   # @param elevator_schedule [String] the name of the elevator schedule
   # @param elevator_fan_schedule [String] the name of the elevator fan schedule
   # @param elevator_lights_schedule [String] the name of the elevator lights schedule
   # @param building_type [String] the building type
   # @return [OpenStudio::Model::ElectricEquipment] the resulting elevator
-  # @todo Inconsistency.  Older vintages don't have lights or fans
-  # in elevators, which is not realistic.
+  # @todo Inconsistency.  Older vintages don't have lights or fans in elevators, which is not realistic.
   def model_add_elevator(model,
                          space,
                          number_of_elevators,
@@ -75,11 +73,13 @@ class DOERefPre1980 < ASHRAE901
     return elevator_equipment
   end
 
-  # Determines the power required by an individual elevator
-  # of a given type.  Values used by the older vintages
-  # are slightly higher than those used by the DOE prototypes.
-  # @param elevator_type [String] valid choices are
-  # Traction, Hydraulic
+  # Determines the power required by an individual elevator of a given type.
+  # Values used by the older vintages are slightly higher than those used by the DOE prototypes.
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param elevator_type [String] valid choices are Traction, Hydraulic
+  # @param building_type [string] the building type
+  # @return [Double] elevator lift power in watts
   def model_elevator_lift_power(model, elevator_type, building_type)
     lift_pwr_w = 0
     if elevator_type == 'Traction'

data/lib/openstudio-standards/prototypes/ashrae_90_1/doe_ref_pre_1980/doe_ref_pre_1980.refrigeration.rb

@@ -1,10 +1,11 @@
 class DOERefPre1980 < ASHRAE901
   # @!group refrigeration
 
-  # Determine the latent case credit curve to use
-  # for walkins.
-  # @todo Should probably use the model_add_refrigeration_walkin
-  # and lookups from the spreadsheet instead of hard-coded values.
+  # Determine the latent case credit curve to use for walkins.
+  # @todo Should probably use the model_add_refrigeration_walkin and lookups from the spreadsheet instead of hard-coded values.
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [String] curve name
   def model_walkin_freezer_latent_case_credit_curve(model)
     latent_case_credit_curve_name = 'Single Shelf Horizontal Latent Energy Multiplier_Pre2004'
     return latent_case_credit_curve_name

data/lib/openstudio-standards/prototypes/ashrae_90_1/nrel_nze_ready_2017/nrel_zne_ready_2017.AirTerminalSingleDuctVAVReheat.rb

@@ -4,7 +4,8 @@ class NRELZNEReady2017 < ASHRAE901
   # Zones with low OA per area get lower initial guesses.
   # Final position will be adjusted upward as necessary by Standards.AirLoopHVAC.apply_minimum_vav_damper_positions
   #
-  # @param zone_oa_per_area [Double] the zone outdoor air per area, m^3/s
+  # @param air_terminal_single_duct_vav_reheat [OpenStudio::Model::AirTerminalSingleDuctVAVReheat] the air terminal object
+  # @param zone_oa_per_area [Double] the zone outdoor air per area in m^3/s*m^2
   # @return [Bool] returns true if successful, false if not
   def air_terminal_single_duct_vav_reheat_apply_initial_prototype_damper_position(air_terminal_single_duct_vav_reheat, zone_oa_per_area)
     min_damper_position = case air_terminal_single_duct_vav_reheat_reheat_type(air_terminal_single_duct_vav_reheat)

data/lib/openstudio-standards/prototypes/ashrae_90_1/nrel_nze_ready_2017/nrel_zne_ready_2017.FanConstantVolume.rb

@@ -1,10 +1,11 @@
 class NRELZNEReady2017 < ASHRAE901
   # @!group FanConstantVolume
 
-  # Determine the prototype fan pressure rise for a constant volume
-  # fan on an AirLoopHVAC based on the airflow of the system.
-  # @return [Double] the pressure rise (in H2O).  Defaults
-  # to the logic from ASHRAE 90.1-2004 prototypes.
+  # Determine the prototype fan pressure rise for a constant volume fan on an AirLoopHVAC based on system airflow.
+  # Defaults to the logic from ASHRAE 90.1-2004 prototypes.
+  #
+  # @param fan_constant_volume [OpenStudio::Model::FanConstantVolume] constant volume fan object
+  # @return [Double] pressure rise in inches H20
   def fan_constant_volume_airloop_fan_pressure_rise(fan_constant_volume)
     # Get the max flow rate from the fan.
     maximum_flow_rate_m3_per_s = nil

data/lib/openstudio-standards/prototypes/ashrae_90_1/nrel_nze_ready_2017/nrel_zne_ready_2017.FanOnOff.rb

@@ -1,11 +1,11 @@
 class NRELZNEReady2017 < ASHRAE901
   # @!group FanOnOff
 
-  # Determine the prototype fan pressure rise for an on off
-  # fan on an AirLoopHVAC or inside a unitary system
-  # based on the airflow of the system.
-  # @return [Double] the pressure rise (in H2O).  Defaults
-  # to the logic from ASHRAE 90.1-2004 prototypes.
+  # Determine the prototype fan pressure rise for an on off fan on an AirLoopHVAC or inside a unitary system based on system airflow.
+  # Defaults to the logic from ASHRAE 90.1-2004 prototypes.
+  #
+  # @param fan_on_off [OpenStudio::Model::FanOnOff] on off fan object
+  # @return [Double] pressure rise in inches H20
   def fan_on_off_airloop_or_unitary_fan_pressure_rise(fan_on_off)
     # Get the max flow rate from the fan.
     maximum_flow_rate_m3_per_s = nil

data/lib/openstudio-standards/prototypes/ashrae_90_1/nrel_nze_ready_2017/nrel_zne_ready_2017.FanVariableVolume.rb

@@ -1,10 +1,11 @@
 class NRELZNEReady2017 < ASHRAE901
   # @!group FanVariableVolume
 
-  # Determine the prototype fan pressure rise for a variable volume
-  # fan on an AirLoopHVAC based on the airflow of the system.
-  # @return [Double] the pressure rise (in H2O).  Defaults
-  # to the logic from ASHRAE 90.1-2004 prototypes.
+  # Determine the prototype fan pressure rise for a variable volume fan on an AirLoopHVAC based on system airflow.
+  # Defaults to the logic from ASHRAE 90.1-2004 prototypes.
+  #
+  # @param fan_variable_volume [OpenStudio::Model::FanVariableVolume] variable volume fan object
+  # @return [Double] pressure rise in inches H20
   def fan_variable_volume_airloop_fan_pressure_rise(fan_variable_volume)
     # Get the max flow rate from the fan.
     maximum_flow_rate_m3_per_s = nil

data/lib/openstudio-standards/prototypes/ashrae_90_1/nrel_nze_ready_2017/nrel_zne_ready_2017.HeatExchangerAirToAirSensibleAndLatent.rb

@@ -2,6 +2,8 @@ class NRELZNEReady2017 < ASHRAE901
   # @!group HeatExchangerAirToAirSensibleAndLatent
 
   # Default fan efficiency assumption for the prm added fan power
+  #
+  # @return [Double] default fan efficiency
   def heat_exchanger_air_to_air_sensible_and_latent_prototype_default_fan_efficiency
     default_fan_efficiency = 0.55
     return default_fan_efficiency

data/lib/openstudio-standards/prototypes/ashrae_90_1/nrel_nze_ready_2017/nrel_zne_ready_2017.Model.elevators.rb

@@ -1,19 +1,23 @@
 class NRELZNEReady2017 < ASHRAE901
   # @!group elevators
 
-  # Determines the percentage of the elevator cab
-  # lighting that is incandescent.  The remainder
-  # is assumed to be LED.  Defaults to 0% incandescent
-  # (100% LED), representing newer elevators.
+  # Determines the percentage of the elevator cab lighting that is incandescent.
+  # The remainder is assumed to be LED.
+  # Defaults to 0% incandescent (100% LED), representing newer elevators.
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [Double] incandescent lighting percentage
   def model_elevator_lighting_pct_incandescent(model)
     pct_incandescent = 0.0 # 100% LED
     return pct_incandescent
   end
 
   # Determines the power of the elevator ventilation fan.
-  # Same as 90.1-2013, which has a requirement
-  # for ventilation fan efficiency.
-  # @return [Double] the ventilaton fan power (W)
+  # Same as 90.1-2013, which has a requirement for ventilation fan efficiency.
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param vent_rate_cfm [Double] the ventilation rate in ft^3/min
+  # @return [Double] the ventilation fan power in watts
   def model_elevator_fan_pwr(model, vent_rate_cfm)
     vent_pwr_per_flow_w_per_cfm = 0.33
     vent_pwr_w = vent_pwr_per_flow_w_per_cfm * vent_rate_cfm

data/lib/openstudio-standards/prototypes/ashrae_90_1/nrel_nze_ready_2017/nrel_zne_ready_2017.Model.rb

@@ -3,17 +3,17 @@ class NRELZNEReady2017 < ASHRAE901
 
   # Determine the prototypical economizer type for the model.
   #
-  # @param model [OpenStudio::Model::Model] the model
-  # @param climate_zone [String] the climate zone
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
   # @return [String] the economizer type.  Possible values are:
-  # 'NoEconomizer'
-  # 'FixedDryBulb'
-  # 'FixedEnthalpy'
-  # 'DifferentialDryBulb'
-  # 'DifferentialEnthalpy'
-  # 'FixedDewPointAndDryBulb'
-  # 'ElectronicEnthalpy'
-  # 'DifferentialDryBulbAndEnthalpy'
+  #   'NoEconomizer'
+  #   'FixedDryBulb'
+  #   'FixedEnthalpy'
+  #   'DifferentialDryBulb'
+  #   'DifferentialEnthalpy'
+  #   'FixedDewPointAndDryBulb'
+  #   'ElectronicEnthalpy'
+  #   'DifferentialDryBulbAndEnthalpy'
   def model_economizer_type(model, climate_zone)
     economizer_type = case climate_zone
                       when 'ASHRAE 169-2006-0A',

data/lib/openstudio-standards/prototypes/ashrae_90_1/nrel_nze_ready_2017/nrel_zne_ready_2017.hvac_systems.rb

@@ -1,8 +1,10 @@
 class NRELZNEReady2017 < ASHRAE901
   # @!group hvac_systems
 
-  # Determine which type of fan the cooling tower
-  # will have.  Variable Speed Fan for NREL ZNE Ready 2017.
+  # Determine which type of fan the cooling tower will have.
+  # Variable Speed Fan for NREL ZNE Ready 2017.
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @return [String] the fan type: TwoSpeed Fan, Variable Speed Fan
   def model_cw_loop_cooling_tower_fan_type(model)
     fan_type = 'Variable Speed Fan'

data/lib/openstudio-standards/prototypes/ashrae_90_1/ze_aedg_multifamily/ze_aedg_multifamily.AirTerminalSingleDuctVAVReheat.rb

@@ -4,7 +4,8 @@ class ZEAEDGMultifamily < ASHRAE901
   # Zones with low OA per area get lower initial guesses.
   # Final position will be adjusted upward as necessary by Standards.AirLoopHVAC.apply_minimum_vav_damper_positions
   #
-  # @param zone_oa_per_area [Double] the zone outdoor air per area, m^3/s
+  # @param air_terminal_single_duct_vav_reheat [OpenStudio::Model::AirTerminalSingleDuctVAVReheat] the air terminal object
+  # @param zone_oa_per_area [Double] the zone outdoor air per area in m^3/s*m^2
   # @return [Bool] returns true if successful, false if not
   def air_terminal_single_duct_vav_reheat_apply_initial_prototype_damper_position(air_terminal_single_duct_vav_reheat, zone_oa_per_area)
     min_damper_position = case air_terminal_single_duct_vav_reheat_reheat_type(air_terminal_single_duct_vav_reheat)

data/lib/openstudio-standards/prototypes/ashrae_90_1/ze_aedg_multifamily/ze_aedg_multifamily.FanConstantVolume.rb

@@ -1,10 +1,11 @@
 class ZEAEDGMultifamily < ASHRAE901
   # @!group FanConstantVolume
 
-  # Determine the prototype fan pressure rise for a constant volume
-  # fan on an AirLoopHVAC based on the airflow of the system.
-  # @return [Double] the pressure rise (in H2O).  Defaults
-  # to the logic from ASHRAE 90.1-2004 prototypes.
+  # Determine the prototype fan pressure rise for a constant volume fan on an AirLoopHVAC based on system airflow.
+  # Defaults to the logic from ASHRAE 90.1-2004 prototypes.
+  #
+  # @param fan_constant_volume [OpenStudio::Model::FanConstantVolume] constant volume fan object
+  # @return [Double] pressure rise in inches H20
   def fan_constant_volume_airloop_fan_pressure_rise(fan_constant_volume)
     # Get the max flow rate from the fan.
     maximum_flow_rate_m3_per_s = nil

data/lib/openstudio-standards/prototypes/ashrae_90_1/ze_aedg_multifamily/ze_aedg_multifamily.FanOnOff.rb

@@ -1,11 +1,11 @@
 class ZEAEDGMultifamily < ASHRAE901
   # @!group FanOnOff
 
-  # Determine the prototype fan pressure rise for an on off
-  # fan on an AirLoopHVAC or inside a unitary system
-  # based on the airflow of the system.
-  # @return [Double] the pressure rise (in H2O).  Defaults
-  # to the logic from ASHRAE 90.1-2004 prototypes.
+  # Determine the prototype fan pressure rise for an on off fan on an AirLoopHVAC or inside a unitary system based on system airflow.
+  # Defaults to the logic from ASHRAE 90.1-2004 prototypes.
+  #
+  # @param fan_on_off [OpenStudio::Model::FanOnOff] on off fan object
+  # @return [Double] pressure rise in inches H20
   def fan_on_off_airloop_or_unitary_fan_pressure_rise(fan_on_off)
     # Get the max flow rate from the fan.
     maximum_flow_rate_m3_per_s = nil

data/lib/openstudio-standards/prototypes/ashrae_90_1/ze_aedg_multifamily/ze_aedg_multifamily.FanVariableVolume.rb

@@ -1,10 +1,11 @@
 class ZEAEDGMultifamily < ASHRAE901
   # @!group FanVariableVolume
 
-  # Determine the prototype fan pressure rise for a variable volume
-  # fan on an AirLoopHVAC based on the airflow of the system.
-  # @return [Double] the pressure rise (in H2O).  Defaults
-  # to the logic from ASHRAE 90.1-2004 prototypes.
+  # Determine the prototype fan pressure rise for a variable volume fan on an AirLoopHVAC based on system airflow.
+  # Defaults to the logic from ASHRAE 90.1-2004 prototypes.
+  #
+  # @param fan_variable_volume [OpenStudio::Model::FanVariableVolume] variable volume fan object
+  # @return [Double] pressure rise in inches H20
   def fan_variable_volume_airloop_fan_pressure_rise(fan_variable_volume)
     # Get the max flow rate from the fan.
     maximum_flow_rate_m3_per_s = nil

data/lib/openstudio-standards/prototypes/ashrae_90_1/ze_aedg_multifamily/ze_aedg_multifamily.HeatExchangerAirToAirSensibleAndLatent.rb

@@ -2,6 +2,8 @@ class ZEAEDGMultifamily < ASHRAE901
   # @!group HeatExchangerAirToAirSensibleAndLatent
 
   # Default fan efficiency assumption for the prm added fan power
+  #
+  # @return [Double] default fan efficiency
   def heat_exchanger_air_to_air_sensible_and_latent_prototype_default_fan_efficiency
     default_fan_efficiency = 0.55
     return default_fan_efficiency

data/lib/openstudio-standards/prototypes/ashrae_90_1/ze_aedg_multifamily/ze_aedg_multifamily.Model.elevators.rb

@@ -1,19 +1,23 @@
 class ZEAEDGMultifamily < ASHRAE901
   # @!group elevators
 
-  # Determines the percentage of the elevator cab
-  # lighting that is incandescent.  The remainder
-  # is assumed to be LED.  Defaults to 0% incandescent
-  # (100% LED), representing newer elevators.
+  # Determines the percentage of the elevator cab lighting that is incandescent.
+  # The remainder is assumed to be LED.
+  # Defaults to 0% incandescent (100% LED), representing newer elevators.
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [Double] incandescent lighting percentage
   def model_elevator_lighting_pct_incandescent(model)
     pct_incandescent = 0.0 # 100% LED
     return pct_incandescent
   end
 
   # Determines the power of the elevator ventilation fan.
-  # Same as 90.1-2013, which has a requirement
-  # for ventilation fan efficiency.
-  # @return [Double] the ventilaton fan power (W)
+  # Same as 90.1-2013, which has a requirement for ventilation fan efficiency.
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param vent_rate_cfm [Double] the ventilation rate in ft^3/min
+  # @return [Double] the ventilation fan power in watts
   def model_elevator_fan_pwr(model, vent_rate_cfm)
     vent_pwr_per_flow_w_per_cfm = 0.33
     vent_pwr_w = vent_pwr_per_flow_w_per_cfm * vent_rate_cfm

data/lib/openstudio-standards/prototypes/ashrae_90_1/ze_aedg_multifamily/ze_aedg_multifamily.Model.rb

@@ -3,17 +3,17 @@ class ZEAEDGMultifamily < ASHRAE901
 
   # Determine the prototypical economizer type for the model.
   #
-  # @param model [OpenStudio::Model::Model] the model
-  # @param climate_zone [String] the climate zone
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
   # @return [String] the economizer type.  Possible values are:
-  # 'NoEconomizer'
-  # 'FixedDryBulb'
-  # 'FixedEnthalpy'
-  # 'DifferentialDryBulb'
-  # 'DifferentialEnthalpy'
-  # 'FixedDewPointAndDryBulb'
-  # 'ElectronicEnthalpy'
-  # 'DifferentialDryBulbAndEnthalpy'
+  #   'NoEconomizer'
+  #   'FixedDryBulb'
+  #   'FixedEnthalpy'
+  #   'DifferentialDryBulb'
+  #   'DifferentialEnthalpy'
+  #   'FixedDewPointAndDryBulb'
+  #   'ElectronicEnthalpy'
+  #   'DifferentialDryBulbAndEnthalpy'
   def model_economizer_type(model, climate_zone)
     economizer_type = case climate_zone
                       when 'ASHRAE 169-2006-0A',

data/lib/openstudio-standards/prototypes/ashrae_90_1/ze_aedg_multifamily/ze_aedg_multifamily.hvac_systems.rb

@@ -1,8 +1,10 @@
 class ZEAEDGMultifamily < ASHRAE901
   # @!group hvac_systems
 
-  # Determine which type of fan the cooling tower
-  # will have.  Variable Speed Fan for NREL ZNE Ready 2017.
+  # Determine which type of fan the cooling tower will have.
+  # Variable Speed Fan for NREL ZNE Ready 2017.
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @return [String] the fan type: TwoSpeed Fan, Variable Speed Fan
   def model_cw_loop_cooling_tower_fan_type(model)
     fan_type = 'Variable Speed Fan'

data/lib/openstudio-standards/prototypes/cbes/cbes.Model.elevators.rb

@@ -3,18 +3,15 @@ class CBES < Standard
 
   # Add an elevator the the specified space
   #
-  # @param space [OpenStudio::Model::Space] the space
-  # to assign the elevators to.
+  # @param space [OpenStudio::Model::Space] the space to assign the elevators to.
   # @param number_of_elevators [Integer] the number of elevators
-  # @param elevator_type [String] valid choices are
-  # Traction, Hydraulic
+  # @param elevator_type [String] valid choices are Traction, Hydraulic
   # @param elevator_schedule [String] the name of the elevator schedule
   # @param elevator_fan_schedule [String] the name of the elevator fan schedule
   # @param elevator_lights_schedule [String] the name of the elevator lights schedule
   # @param building_type [String] the building type
   # @return [OpenStudio::Model::ElectricEquipment] the resulting elevator
-  # @todo Inconsistency.  Older vintages don't have lights or fans
-  # in elevators, which is not realistic.
+  # @todo Inconsistency.  Older vintages don't have lights or fans in elevators, which is not realistic.
   def model_add_elevator(model,
                          space,
                          number_of_elevators,

data/lib/openstudio-standards/prototypes/cbes/cbes.refrigeration.rb

@@ -1,10 +1,11 @@
 class CBES < Standard
   # @!group refrigeration
 
-  # Determine the latent case credit curve to use
-  # for walkins.
-  # @todo Should probably use the model_add_refrigeration_walkin
-  # and lookups from the spreadsheet instead of hard-coded values.
+  # Determine the latent case credit curve to use for walkins.
+  # @todo Should probably use the model_add_refrigeration_walkin and lookups from the spreadsheet instead of hard-coded values.
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [String] curve name
   def model_walkin_freezer_latent_case_credit_curve(model)
     latent_case_credit_curve_name = 'Single Shelf Horizontal Latent Energy Multiplier_Pre2004'
     return latent_case_credit_curve_name

data/lib/openstudio-standards/prototypes/cbes/cbes_t24_2008/cbes_t24_2008.FanConstantVolume.rb

@@ -1,9 +1,11 @@
 class CBEST242008 < CBES
   # @!group FanConstantVolume
 
-  # Determine the prototype fan pressure rise for a constant volume
-  # fan on an AirLoopHVAC based on the airflow of the system.
-  # @return [Double] the pressure rise (in H2O).
+  # Determine the prototype fan pressure rise for a constant volume fan on an AirLoopHVAC based on system airflow.
+  # Defaults to the logic from ASHRAE 90.1-2004 prototypes.
+  #
+  # @param fan_constant_volume [OpenStudio::Model::FanConstantVolume] constant volume fan object
+  # @return [Double] pressure rise in inches H20
   def fan_constant_volume_airloop_fan_pressure_rise(fan_constant_volume)
     # Get the max flow rate from the fan.
     maximum_flow_rate_m3_per_s = nil

data/lib/openstudio-standards/prototypes/cbes/cbes_t24_2008/cbes_t24_2008.FanOnOff.rb

@@ -1,10 +1,11 @@
 class CBEST242008 < CBES
   # @!group FanOnOff
 
-  # Determine the prototype fan pressure rise for an on off
-  # fan on an AirLoopHVAC or inside a unitary system
-  # based on the airflow of the system.
-  # @return [Double] the pressure rise (in H2O).
+  # Determine the prototype fan pressure rise for an on off fan on an AirLoopHVAC or inside a unitary system based on system airflow.
+  # Defaults to the logic from ASHRAE 90.1-2004 prototypes.
+  #
+  # @param fan_on_off [OpenStudio::Model::FanOnOff] on off fan object
+  # @return [Double] pressure rise in inches H20
   def fan_on_off_airloop_or_unitary_fan_pressure_rise(fan_on_off)
     # Get the max flow rate from the fan.
     maximum_flow_rate_m3_per_s = nil

data/lib/openstudio-standards/prototypes/cbes/cbes_t24_2008/cbes_t24_2008.FanVariableVolume.rb

@@ -1,9 +1,11 @@
 class CBEST242008 < CBES
   # @!group FanVariableVolume
 
-  # Determine the prototype fan pressure rise for a variable volume
-  # fan on an AirLoopHVAC based on the airflow of the system.
-  # @return [Double] the pressure rise (in H2O).
+  # Determine the prototype fan pressure rise for a variable volume fan on an AirLoopHVAC based on system airflow.
+  # Defaults to the logic from ASHRAE 90.1-2004 prototypes.
+  #
+  # @param fan_variable_volume [OpenStudio::Model::FanVariableVolume] variable volume fan object
+  # @return [Double] pressure rise in inches H20
   def fan_variable_volume_airloop_fan_pressure_rise(fan_variable_volume)
     # Get the max flow rate from the fan.
     maximum_flow_rate_m3_per_s = nil

data/lib/openstudio-standards/prototypes/common/buildings/Prototype.College.rb

@@ -1,47 +1,82 @@
 # Custom changes for the College prototype.
-# These are changes that are inconsistent with other prototype
-# building types.
+# These are changes that are inconsistent with other prototype building types.
 module College
-  def model_custom_hvac_tweaks(building_type, climate_zone, prototype_input, model)
+  # hvac adjustments specific to the prototype model
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param building_type [string] the building type
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
+  # @param prototype_input [Hash] hash of prototype inputs
+  # @return [Bool] returns true if successful, false if not
+  def model_custom_hvac_tweaks(model, building_type, climate_zone, prototype_input)
     return true
   end
 
-  def model_custom_internal_load_tweaks(building_type, climate_zone, prototype_input, model)
-    #   SpaceInfiltration "Peak: 0.2016 cfm/sf of above grade exterior wall surface area, adjusted by wind (when fans turn off)
-    # Off Peak: 25% of peak infiltration rate (when fans turn on)
-    # Additional infiltration through building entrance"
-    infil_schedule = model.getScheduleRulesetByName('College INFIL_SCH_PNNL')
-    model.getSpaceTypes.sort.each do |space_type|
-      infil_flow_rates = space_type.getSpaceInfiltrationDesignFlowRates
-      if infil_flow_rates.empty?
-        # create a new infiltration object for the spacetypes without any infiltration defined
-        infil_flow_rate = Openstudio::Model::SpaceInfiltrationDesignFlowRate.new(model)
-        infil_flow_rate.setSpaceInfiltrationDesignFlowRate(0.2016)
-        infil_flow_rate.setSchedule(infil_schedule)
-        infil_flow_rate.setSpaceType(space_type)
+  # add door infiltration
+  #
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [Bool] returns true if successful, false if not
+  def add_door_infiltration(climate_zone, model)
+    return false if template == 'DOE Ref 1980-2004' || template == 'DOE Ref Pre-1980'
+
+    entry_space = model.getSpaceByName('CB_ENTRANCE_LOBBY_F1').get
+    infiltration_entrydoor = OpenStudio::Model::SpaceInfiltrationDesignFlowRate.new(model)
+    infiltration_entrydoor.setName('entry door Infiltration')
+    infiltration_per_zone_entrydoor = 0
+    if template == '90.1-2004'
+      infiltration_per_zone_entrydoor = 7.678585
+      infiltration_entrydoor.setSchedule(model_add_schedule(model, 'College INFIL_Door_Opening_SCH'))
+    elsif template == '90.1-2007'
+      case climate_zone
+      when 'ASHRAE 169-2006-3A',
+        'ASHRAE 169-2006-3B',
+        'ASHRAE 169-2006-3C',
+        'ASHRAE 169-2006-4A',
+        'ASHRAE 169-2006-4B',
+        'ASHRAE 169-2006-4C'
+        infiltration_per_zone_entrydoor = 5.600600
+        infiltration_entrydoor.setSchedule(model_add_schedule(model, 'College INFIL_Door_Opening_SCH'))
+      else
+        infiltration_per_zone_entrydoor = 7.678585
+        infiltration_entrydoor.setSchedule(model_add_schedule(model, 'College INFIL_Door_Opening_SCH'))
+      end
+    elsif template == '90.1-2010' || template == '90.1-2013'
+      case climate_zone
+      when 'ASHRAE 169-2006-3A',
+        'ASHRAE 169-2006-3B',
+        'ASHRAE 169-2006-3C'
+        infiltration_per_zone_entrydoor = 5.600600
+        infiltration_entrydoor.setSchedule(model_add_schedule(model, 'College INFIL_Door_Opening_SCH'))
       else
-        infil_flow_rates.each do |rate|
-          rate.setSpaceInfiltrationDesignFlowRate(0.2016)
-          rate.setSchedule(infil_schedule)
-        end
+        infiltration_per_zone_entrydoor = 7.678585
+        infiltration_entrydoor.setSchedule(model_add_schedule(model, 'College INFIL_Door_Opening_SCH'))
       end
     end
-
-    building_entrance_lobby = model.getSpaceByName('CB_ Entrance Lobby_F0')
-    lobby_door_leakage_area = Openstudio::Model::SpaceInfiltrationEffectiveLeakageArea.new(model)
-    lobby_door_leakage_area.setEffectiveAirLeakageArea(5.0) # Need modification
-    lobby_door_leakage_area.setSpace(building_entrance_lobby)
-
-    # Plugload:Average power density (W/ft2) See under Zone Summary (MISSING)
-    # Schedule See under Schedules
-    # Zone Control Type: minimum supply air at 30% of the zone design peak supply air
+    infiltration_entrydoor.setDesignFlowRate(infiltration_per_zone_entrydoor)
+    infiltration_entrydoor.setSpace(entry_space)
+    return true
   end
 
+  # swh adjustments specific to the prototype model
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param building_type [string] the building type
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
+  # @param prototype_input [Hash] hash of prototype inputs
+  # @return [Bool] returns true if successful, false if not
   def model_custom_swh_tweaks(model, building_type, climate_zone, prototype_input)
     return true
   end
 
-  def model_custom_geometry_tweaks(building_type, climate_zone, prototype_input, model)
+  # geometry adjustments specific to the prototype model
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param building_type [string] the building type
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
+  # @param prototype_input [Hash] hash of prototype inputs
+  # @return [Bool] returns true if successful, false if not
+  def model_custom_geometry_tweaks(model, building_type, climate_zone, prototype_input)
     return true
   end
 end