openstudio-standards 0.2.14 → 0.2.15.pre.rc1

data/lib/openstudio-standards/prototypes/common/objects/Prototype.AirConditionerVariableRefrigerantFlow.rb

@@ -3,6 +3,8 @@ class Standard
 
   # Prototype AirConditionerVariableRefrigerantFlow object
   # Enters in default curves for coil by type of coil
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param name [String] the name of the system, or nil in which case it will be defaulted
   # @param schedule [String] name of the availability schedule, or [<OpenStudio::Model::Schedule>] Schedule object, or nil in which case default to always on
   # @param type [String] the type of unit to reference for the correct curve set
@@ -16,6 +18,7 @@ class Standard
   # @param master_zone [<OpenStudio::Model::ThermalZone>] master control zone to switch between heating and cooling
   # @param priority_control_type [String] type of master thermostat priority control type
   #   options are LoadPriority, ZonePriority, ThermostatOffsetPriority, MasterThermostatPriority
+  # @return [OpenStudio::Model::AirConditionerVariableRefrigerantFlow] the vrf unit
   def create_air_conditioner_variable_refrigerant_flow(model,
                                                        name: 'VRF System',
                                                        schedule: nil,

data/lib/openstudio-standards/prototypes/common/objects/Prototype.AirTerminalSingleDuctVAVReheat.rb

@@ -5,7 +5,8 @@ class Standard
   # 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 = 0.3

data/lib/openstudio-standards/prototypes/common/objects/Prototype.BoilerHotWater.rb

@@ -3,6 +3,7 @@ class Standard
 
   # Prototype BoilerHotWater object
   #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param hot_water_loop [<OpenStudio::Model::PlantLoop>] a hot water loop served by the boiler
   # @param name [String] the name of the boiler, or nil in which case it will be defaulted
   # @param fuel_type [String] type of fuel serving the boiler
@@ -17,6 +18,7 @@ class Standard
   # @param max_plr [Double] boiler maximum part load ratio
   # @param opt_plr [Double] boiler optimum part load ratio
   # @param sizing_factor [Double] boiler oversizing factor
+  # @return [OpenStudio::Model::BoilerHotWater] the boiler object
   def create_boiler_hot_water(model,
                               hot_water_loop: nil,
                               name: 'Boiler',

data/lib/openstudio-standards/prototypes/common/objects/Prototype.CentralAirSourceHeatPump.rb

@@ -3,9 +3,11 @@ class Standard
 
   # Prototype CentralAirSourceHeatPump object using PlantComponentUserDefined
   #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param hot_water_loop [<OpenStudio::Model::PlantLoop>] a hot water loop served by the central air source heat pump
   # @param name [String] the name of the central air source heat pump, or nil in which case it will be defaulted
   # @param cop [Double] air source heat pump rated cop
+  # @return [OpenStudio::Model::PlantComponentUserDefined] a plant component representing the air source heat pump
   # @todo update curve to better calculate based on the rated cop
   # @todo refactor to use the new EnergyPlus central air source heat pump object when it becomes available
   #   set hot_water_loop to an optional keyword argument, and add input keyword arguments for other characteristics

data/lib/openstudio-standards/prototypes/common/objects/Prototype.CoilCoolingDXSingleSpeed.rb

@@ -3,11 +3,14 @@ class Standard
 
   # Prototype CoilCoolingDXSingleSpeed object
   # Enters in default curves for coil by type of coil
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param air_loop_node [<OpenStudio::Model::Node>] the coil will be placed on this node of the air loop
   # @param name [String] the name of the system, or nil in which case it will be defaulted
   # @param schedule [String] name of the availability schedule, or [<OpenStudio::Model::Schedule>] Schedule object, or nil in which case default to always on
   # @param type [String] the type of single speed DX coil to reference the correct curve set
   # @param cop [Double] rated cooling coefficient of performance
+  # @return [OpenStudio::Model::CoilCoolingDXTwoSpeed] the DX cooling coil
   def create_coil_cooling_dx_single_speed(model,
                                           air_loop_node: nil,
                                           name: '1spd DX Clg Coil',
@@ -157,7 +160,7 @@ class Standard
     when 'Window AC'
       # Performance curves
       # From Frigidaire 10.7 EER unit in Winkler et. al. Lab Testing of Window ACs (2013)
-      # NOTE: These coefficients are in SI UNITS
+      # @note These coefficients are in SI UNITS
       cool_cap_ft_coeffs_si = [0.6405, 0.01568, 0.0004531, 0.001615, -0.0001825, 0.00006614]
       cool_eir_ft_coeffs_si = [2.287, -0.1732, 0.004745, 0.01662, 0.000484, -0.001306]
       cool_cap_fflow_coeffs = [0.887, 0.1128, 0]

data/lib/openstudio-standards/prototypes/common/objects/Prototype.CoilCoolingDXTwoSpeed.rb

@@ -3,10 +3,13 @@ class Standard
 
   # Prototype CoilCoolingDXTwoSpeed object
   # Enters in default curves for coil by type of coil
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param air_loop_node [<OpenStudio::Model::Node>] the coil will be placed on this node of the air loop
   # @param name [String] the name of the system, or nil in which case it will be defaulted
   # @param schedule [String] name of the availability schedule, or [<OpenStudio::Model::Schedule>] Schedule object, or nil in which case default to always on
   # @param type [String] the type of two speed DX coil to reference the correct curve set
+  # @return [OpenStudio::Model::CoilCoolingDXTwoSpeed] the DX cooling coil
   def create_coil_cooling_dx_two_speed(model,
                                        air_loop_node: nil,
                                        name: '2spd DX Clg Coil',

data/lib/openstudio-standards/prototypes/common/objects/Prototype.CoilCoolingWater.rb

@@ -2,6 +2,8 @@ class Standard
   # @!group CoilCoolingWater
 
   # Prototype CoilCoolingWater object
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param chilled_water_loop [<OpenStudio::Model::PlantLoop>] the coil will be placed on the demand side of this plant loop
   # @param air_loop_node [<OpenStudio::Model::Node>] the coil will be placed on this node of the air loop
   # @param name [String] the name of the coil, or nil in which case it will be defaulted
@@ -9,6 +11,7 @@ class Standard
   # @param design_inlet_water_temperature [Double] design inlet water temperature in degrees Celsius, default is nil
   # @param design_inlet_air_temperature [Double] design inlet air temperature in degrees Celsius, default is nil
   # @param design_outlet_air_temperature [Double] design outlet air temperature in degrees Celsius, default is nil
+  # @return [OpenStudio::Model::CoilCoolingWater] the cooling coil
   def create_coil_cooling_water(model,
                                 chilled_water_loop,
                                 air_loop_node: nil,
@@ -65,7 +68,7 @@ class Standard
     clg_coil.setHeatExchangerConfiguration('CrossFlow')
 
     # coil controller properties
-    # NOTE: These inputs will get overwritten if addToNode or addDemandBranchForComponent is called on the htg_coil object after this
+    # @note These inputs will get overwritten if addToNode or addDemandBranchForComponent is called on the htg_coil object after this
     clg_coil_controller = clg_coil.controllerWaterCoil.get
     clg_coil_controller.setName("#{clg_coil.name} Controller")
     clg_coil_controller.setAction('Reverse')

data/lib/openstudio-standards/prototypes/common/objects/Prototype.CoilCoolingWaterToAirHeatPumpEquationFit.rb

@@ -3,11 +3,14 @@ class Standard
 
   # Prototype CoilCoolingWaterToAirHeatPumpEquationFit object
   # Enters in default curves for coil by type of coil
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param plant_loop [<OpenStudio::Model::PlantLoop>] the coil will be placed on the demand side of this plant loop
   # @param air_loop_node [<OpenStudio::Model::Node>] the coil will be placed on this node of the air loop
   # @param name [String] the name of the system, or nil in which case it will be defaulted
   # @param type [String] the type of coil to reference the correct curve set
   # @param cop [Double] rated cooling coefficient of performance
+  # @return [OpenStudio::Model::CoilCoolingWaterToAirHeatPumpEquationFit] the cooling coil
   def create_coil_cooling_water_to_air_heat_pump_equation_fit(model,
                                                               plant_loop,
                                                               air_loop_node: nil,

data/lib/openstudio-standards/prototypes/common/objects/Prototype.CoilHeatingDXSingleSpeed.rb

@@ -3,12 +3,15 @@ class Standard
 
   # Prototype CoilHeatingDXSingleSpeed object
   # Enters in default curves for coil by type of coil
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param air_loop_node [<OpenStudio::Model::Node>] the coil will be placed on this node of the air loop
   # @param name [String] the name of the system, or nil in which case it will be defaulted
   # @param schedule [String] name of the availability schedule, or [<OpenStudio::Model::Schedule>] Schedule object, or nil in which case default to always on
   # @param type [String] the type of single speed DX coil to reference the correct curve set
   # @param cop [Double] rated heating coefficient of performance
   # @param defrost_strategy [String] type of defrost strategy. options are reverse-cycle or resistive
+  # @return [OpenStudio::Model::CoilHeatingDXSingleSpeed] the DX heating coil
   def create_coil_heating_dx_single_speed(model,
                                           air_loop_node: nil,
                                           name: '1spd DX Htg Coil',
@@ -194,6 +197,10 @@ class Standard
     return htg_coil
   end
 
+  # sets defrost curve limits
+  #
+  # @param htg_coil [OpenStudio::Model::CoilHeatingDXSingleSpeed] a DX heating coil
+  # @return [Bool] returns true if successful, false if not
   def coil_heating_dx_single_speed_apply_defrost_eir_curve_limits(htg_coil)
     return false unless htg_coil.defrostEnergyInputRatioFunctionofTemperatureCurve.is_initialized
 
@@ -202,5 +209,7 @@ class Standard
     def_eir_f_of_temp.setMaximumValueofx(23.88889)
     def_eir_f_of_temp.setMinimumValueofy(21.11111)
     def_eir_f_of_temp.setMaximumValueofy(46.11111)
+
+    return true
   end
 end

data/lib/openstudio-standards/prototypes/common/objects/Prototype.CoilHeatingElectric.rb

@@ -2,11 +2,14 @@ class Standard
   # @!group CoilHeatingElectric
 
   # Prototype CoilHeatingElectric object
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param air_loop_node [<OpenStudio::Model::Node>] the coil will be placed on this node of the air loop
   # @param name [String] the name of the system, or nil in which case it will be defaulted
   # @param schedule [String] name of the availability schedule, or [<OpenStudio::Model::Schedule>] Schedule object, or nil in which case default to always on
   # @param nominal_capacity [Double] rated nominal capacity
   # @param efficiency [Double] rated heating efficiency
+  # @return [OpenStudio::Model::CoilHeatingElectric] the electric heating coil
   def create_coil_heating_electric(model,
                                    air_loop_node: nil,
                                    name: 'Electric Htg Coil',

data/lib/openstudio-standards/prototypes/common/objects/Prototype.CoilHeatingGas.rb

@@ -2,11 +2,14 @@ class Standard
   # @!group CoilHeatingGas
 
   # Prototype CoilHeatingGas object
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param air_loop_node [<OpenStudio::Model::Node>] the coil will be placed on this node of the air loop
   # @param name [String] the name of the system, or nil in which case it will be defaulted
   # @param schedule [String] name of the availability schedule, or [<OpenStudio::Model::Schedule>] Schedule object, or nil in which case default to always on
   # @param nominal_capacity [Double] rated nominal capacity
   # @param efficiency [Double] rated heating efficiency
+  # @return [OpenStudio::Model::CoilHeatingGas] the gas heating coil
   def create_coil_heating_gas(model,
                               air_loop_node: nil,
                               name: 'Gas Htg Coil',
@@ -54,11 +57,13 @@ class Standard
     return htg_coil
   end
 
-  # Updates the efficiency of some gas heating coils
-  # per the prototype assumptions.  Defaults to
-  # making no changes.
+  # Updates the efficiency of some gas heating coils per the prototype assumptions.
+  # Defaults to making no changes.
+  #
+  # @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)
-    # Do nothing
+    # do nothing
     return true
   end
 end

data/lib/openstudio-standards/prototypes/common/objects/Prototype.CoilHeatingWater.rb

@@ -2,6 +2,8 @@ class Standard
   # @!group CoilHeatingWater
 
   # Prototype CoilHeatingWater object
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param hot_water_loop [<OpenStudio::Model::PlantLoop>] the coil will be placed on the demand side of this plant loop
   # @param air_loop_node [<OpenStudio::Model::Node>] the coil will be placed on this node of the air loop
   # @param name [String] the name of the coil, or nil in which case it will be defaulted
@@ -11,6 +13,7 @@ class Standard
   # @param rated_inlet_air_temperature [Double] rated inlet air temperature in degrees Celsius, default is 16.6 (62F)
   # @param rated_outlet_air_temperature [Double] rated outlet air temperature in degrees Celsius, default is 32.2 (90F)
   # @param controller_convergence_tolerance [Double] controller convergence tolerance
+  # @return [OpenStudio::Model::CoilHeatingWater] the heating coil
   def create_coil_heating_water(model,
                                 hot_water_loop,
                                 air_loop_node: nil,
@@ -83,7 +86,7 @@ class Standard
     end
 
     # coil controller properties
-    # NOTE: These inputs will get overwritten if addToNode or addDemandBranchForComponent is called on the htg_coil object after this
+    # @note These inputs will get overwritten if addToNode or addDemandBranchForComponent is called on the htg_coil object after this
     htg_coil_controller = htg_coil.controllerWaterCoil.get
     htg_coil_controller.setName("#{htg_coil.name} Controller")
     htg_coil_controller.setMinimumActuatedFlow(0.0)

data/lib/openstudio-standards/prototypes/common/objects/Prototype.CoilHeatingWaterToAirHeatPumpEquationFit.rb

@@ -3,11 +3,14 @@ class Standard
 
   # Prototype CoilHeatingWaterToAirHeatPumpEquationFit object
   # Enters in default curves for coil by type of coil
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param plant_loop [<OpenStudio::Model::PlantLoop>] the coil will be placed on the demand side of this plant loop
   # @param air_loop_node [<OpenStudio::Model::Node>] the coil will be placed on this node of the air loop
   # @param name [String] the name of the system, or nil in which case it will be defaulted
   # @param type [String] the type of coil to reference the correct curve set
   # @param cop [Double] rated heating coefficient of performance
+  # @return [OpenStudio::Model::CoilHeatingWaterToAirHeatPumpEquationFit] the heating coil
   def create_coil_heating_water_to_air_heat_pump_equation_fit(model,
                                                               plant_loop,
                                                               air_loop_node: nil,

data/lib/openstudio-standards/prototypes/common/objects/Prototype.ControllerWaterCoil.rb

@@ -3,9 +3,9 @@ class Standard
 
   # Sets the convergence tolerance to 0.0001 deltaC for all hot water coils.
   #
+  # @param controller_water_coil [OpenStudio::Model::ControllerWaterCoil] controller water coil object
   # @return [Bool] returns true if successful, false if not
-  # @ TODO: Figure out what the reason for this is,
-  #   because it seems like a workaround for an E+ bug that was probably addressed long ago.
+  # @todo Figure out what the reason for this is, because it seems like a workaround for an E+ bug that was probably addressed long ago.
   def controller_water_coil_set_convergence_limits(controller_water_coil)
     controller_action = controller_water_coil.action
     if controller_action.is_initialized

data/lib/openstudio-standards/prototypes/common/objects/Prototype.CoolingTower.rb

@@ -4,7 +4,8 @@ class Standard
   # Apply approach temperature sizing criteria to a condenser water loop
   #
   # @param condenser_loop [<OpenStudio::Model::PlantLoop>] a condenser loop served by a cooling tower
-  # @param design_wet_bulb_c [Double] the outdoor design wetbulb conditions in degrees C
+  # @param design_wet_bulb_c [Double] the outdoor design wetbulb conditions in degrees Celsius
+  # @return [Bool] returns true if successful, false if not
   def prototype_apply_condenser_water_temperatures(condenser_loop,
                                                    design_wet_bulb_c: nil)
     sizing_plant = condenser_loop.sizingPlant
@@ -99,6 +100,8 @@ class Standard
     cw_t_stpt_manager.setMaximumSetpointTemperature(leaving_cw_t_c)
     cw_t_stpt_manager.setMinimumSetpointTemperature(float_down_to_c)
     cw_t_stpt_manager.setOffsetTemperatureDifference(approach_k)
+
+    return true
   end
 
   # Determine the performance rating method specified design condenser water temperature, approach, and range

data/lib/openstudio-standards/prototypes/common/objects/Prototype.Fan.rb

@@ -7,7 +7,9 @@ module PrototypeFan
   # model assumptions for fan impeller efficiency,
   # motor type, and a 10% safety factor on brake horsepower.
   #
-  # @return [Bool] true if successful, false if not
+  # @param fan [OpenStudio::Model::StraightComponent] fan object of type:
+  #   FanConstantVolume, FanOnOff, FanVariableVolume, and FanZoneExhaust
+  # @return [Bool] returns true if successful, false if not
   def prototype_fan_apply_prototype_fan_efficiency(fan)
     # Do not modify dummy exhaust fans
     return true unless !fan.name.to_s.downcase.include? 'dummy'
@@ -35,7 +37,8 @@ module PrototypeFan
 
     # Calculate the Brake Horsepower
     brake_hp = (pressure_rise_in_h2o * maximum_flow_rate_cfm) / (fan_impeller_eff * 6356)
-    allowed_hp = brake_hp * 1.1 # Per PNNL document #TODO add reference
+    allowed_hp = brake_hp * 1.1 # Per PNNL document
+    # @todo add reference
     if allowed_hp > 0.1
       allowed_hp = allowed_hp.round(2) + 0.0001
     elsif allowed_hp < 0.01
@@ -70,6 +73,15 @@ module PrototypeFan
     return true
   end
 
+  # fan class method to apply fan variables
+  #
+  # @param fan [OpenStudio::Model::StraightComponent] fan object of type:
+  #   FanConstantVolume, FanOnOff, FanVariableVolume, and FanZoneExhaust
+  # @param fan_name [String] fan name
+  # @param fan_efficiency [Double] fan efficiency
+  # @param pressure_rise [Double] fan pressure rise in Pa
+  # @param end_use_subcategory [String] end use subcategory name
+  # @return [OpenStudio::Model::StraightComponent] fan object
   def self.apply_base_fan_variables(fan,
                                     fan_name: nil,
                                     fan_efficiency: nil,
@@ -82,6 +94,8 @@ module PrototypeFan
     return fan
   end
 
+  # @param fan_efficiency [Double] fan efficiency
+  # @param pressure_rise [Double] fan pressure rise in Pa
   def get_fan_from_standards(standards_name: nil,
                              type: nil,
                              fan_efficiency: nil,
@@ -115,6 +129,13 @@ module PrototypeFan
     model_find_object(@standards_data['fans'], search_criteria)
   end
 
+  # create a fan with properties for a fan name in the standards data
+  #
+  # @param fan_name [String] fan name
+  # @param fan_efficiency [Double] fan efficiency
+  # @param pressure_rise [Double] fan pressure rise in Pa
+  # @param end_use_subcategory [String] end use subcategory name
+  # @return [OpenStudio::Model::StraightComponent] fan object
   def create_fan_by_name(model,
                          standards_name,
                          fan_name: nil,

data/lib/openstudio-standards/prototypes/common/objects/Prototype.FanConstantVolume.rb

@@ -5,6 +5,9 @@ class Standard
   # Sets the fan pressure rise based on the Prototype buildings inputs
   # which are governed by the flow rate coming through the fan
   # and whether the fan lives inside a unit heater, PTAC, etc.
+  #
+  # @param fan_constant_volume [OpenStudio::Model::FanConstantVolume] constant volume fan object
+  # @return [Bool] returns true if successful, false if not
   def fan_constant_volume_apply_prototype_fan_pressure_rise(fan_constant_volume)
     # Don't modify unit heater fans
     return true if fan_constant_volume.name.to_s.include?('UnitHeater Fan')
@@ -53,10 +56,11 @@ class Standard
     return true
   end
 
-  # 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
@@ -84,6 +88,16 @@ class Standard
     return pressure_rise_in_h2o
   end
 
+  # creates a constant volume fan
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param fan_name [String] fan name
+  # @param fan_efficiency [Double] fan efficiency
+  # @param pressure_rise [Double] fan pressure rise in Pa
+  # @param motor_efficiency [Double] fan motor efficiency
+  # @param motor_in_airstream_fraction [Double] fraction of motor heat in airstream
+  # @param end_use_subcategory [String] end use subcategory name
+  # @return [OpenStudio::Model::FanConstantVolume] constant volume fan object
   def create_fan_constant_volume(model,
                                  fan_name: nil,
                                  fan_efficiency: nil,
@@ -102,6 +116,17 @@ class Standard
     return fan
   end
 
+  # creates a constant volume fan from a json
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param fan_json [Hash] hash of fan properties
+  # @param fan_name [String] fan name
+  # @param fan_efficiency [Double] fan efficiency
+  # @param pressure_rise [Double] fan pressure rise in Pa
+  # @param motor_efficiency [Double] fan motor efficiency
+  # @param motor_in_airstream_fraction [Double] fraction of motor heat in airstream
+  # @param end_use_subcategory [String] end use subcategory name
+  # @return [OpenStudio::Model::FanConstantVolume] constant volume fan object
   def create_fan_constant_volume_from_json(model,
                                            fan_json,
                                            fan_name: nil,

data/lib/openstudio-standards/prototypes/common/objects/Prototype.FanOnOff.rb

@@ -6,6 +6,9 @@ class Standard
   # Sets the fan pressure rise based on the Prototype buildings inputs
   # which are governed by the flow rate coming through the fan
   # and whether the fan lives inside a unit heater, PTAC, etc.
+  #
+  # @param fan_on_off [OpenStudio::Model::FanOnOff] on off fan object
+  # @return [Bool] returns true if successful, false if not
   def fan_on_off_apply_prototype_fan_pressure_rise(fan_on_off)
     # Get the max flow rate from the fan.
     maximum_flow_rate_m3_per_s = nil
@@ -58,11 +61,11 @@ class Standard
     return true
   end
 
-  # 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
@@ -90,6 +93,16 @@ class Standard
     return pressure_rise_in_h2o
   end
 
+  # creates an on off fan
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param fan_name [String] fan name
+  # @param fan_efficiency [Double] fan efficiency
+  # @param pressure_rise [Double] fan pressure rise in Pa
+  # @param motor_efficiency [Double] fan motor efficiency
+  # @param motor_in_airstream_fraction [Double] fraction of motor heat in airstream
+  # @param end_use_subcategory [String] end use subcategory name
+  # @return [OpenStudio::Model::FanOnOff] on off fan object
   def create_fan_on_off(model,
                         fan_name: nil,
                         fan_efficiency: nil,
@@ -108,6 +121,17 @@ class Standard
     return fan
   end
 
+  # creates a on off fan from a json
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param fan_json [Hash] hash of fan properties
+  # @param fan_name [String] fan name
+  # @param fan_efficiency [Double] fan efficiency
+  # @param pressure_rise [Double] fan pressure rise in Pa
+  # @param motor_efficiency [Double] fan motor efficiency
+  # @param motor_in_airstream_fraction [Double] fraction of motor heat in airstream
+  # @param end_use_subcategory [String] end use subcategory name
+  # @return [OpenStudio::Model::FanOnOff] on off fan object
   def create_fan_on_off_from_json(model,
                                   fan_json,
                                   fan_name: nil,

data/lib/openstudio-standards/prototypes/common/objects/Prototype.FanVariableVolume.rb

@@ -6,6 +6,9 @@ class Standard
   # Sets the fan pressure rise based on the Prototype buildings inputs
   # which are governed by the flow rate coming through the fan
   # and whether the fan lives inside a unit heater, PTAC, etc.
+  #
+  # @param fan_variable_volume [OpenStudio::Model::FanVariableVolume] variable volume fan object
+  # @return [Bool] returns true if successful, false if not
   def fan_variable_volume_apply_prototype_fan_pressure_rise(fan_variable_volume)
     # Get the max flow rate from the fan.
     maximum_flow_rate_m3_per_s = nil
@@ -51,10 +54,11 @@ class Standard
     return true
   end
 
-  # 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
@@ -82,6 +86,23 @@ class Standard
     return pressure_rise_in_h2o
   end
 
+  # creates a variable volume fan
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param fan_name [String] fan name
+  # @param fan_efficiency [Double] fan efficiency
+  # @param pressure_rise [Double] fan pressure rise in Pa
+  # @param motor_efficiency [Double] fan motor efficiency
+  # @param motor_in_airstream_fraction [Double] fraction of motor heat in airstream
+  # @param fan_power_minimum_flow_rate_input_method [String] options are Fraction, FixedFlowRate
+  # @param fan_power_minimum_flow_rate_fraction [Double] minimum flow rate fraction
+  # @param end_use_subcategory [String] end use subcategory name
+  # @param fan_power_coefficient_1 [Double] fan power coefficient 1
+  # @param fan_power_coefficient_2 [Double] fan power coefficient 2
+  # @param fan_power_coefficient_3 [Double] fan power coefficient 3
+  # @param fan_power_coefficient_4 [Double] fan power coefficient 4
+  # @param fan_power_coefficient_5 [Double] fan power coefficient 5
+  # @return [OpenStudio::Model::FanVariableVolume] variable volume fan object
   def create_fan_variable_volume(model,
                                  fan_name: nil,
                                  fan_efficiency: nil,
@@ -114,6 +135,24 @@ class Standard
     return fan
   end
 
+  # creates a variable volume fan from a json
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param fan_json [Hash] hash of fan properties
+  # @param fan_name [String] fan name
+  # @param fan_efficiency [Double] fan efficiency
+  # @param pressure_rise [Double] fan pressure rise in Pa
+  # @param motor_efficiency [Double] fan motor efficiency
+  # @param motor_in_airstream_fraction [Double] fraction of motor heat in airstream
+  # @param fan_power_minimum_flow_rate_input_method [String] options are Fraction, FixedFlowRate
+  # @param fan_power_minimum_flow_rate_fraction [Double] minimum flow rate fraction
+  # @param end_use_subcategory [String] end use subcategory name
+  # @param fan_power_coefficient_1 [Double] fan power coefficient 1
+  # @param fan_power_coefficient_2 [Double] fan power coefficient 2
+  # @param fan_power_coefficient_3 [Double] fan power coefficient 3
+  # @param fan_power_coefficient_4 [Double] fan power coefficient 4
+  # @param fan_power_coefficient_5 [Double] fan power coefficient 5
+  # @return [OpenStudio::Model::FanVariableVolume] variable volume fan object
   def create_fan_variable_volume_from_json(model,
                                            fan_json,
                                            fan_name: nil,

data/lib/openstudio-standards/prototypes/common/objects/Prototype.FanZoneExhaust.rb

@@ -4,6 +4,9 @@ class Standard
   include PrototypeFan
 
   # Sets the fan pressure rise based on the Prototype buildings inputs
+  #
+  # @param fan_zone_exhaust [OpenStudio::Model::FanZoneExhaust] the exhaust fan
+  # @return [Bool] returns true if successful, false if not
   def fan_zone_exhaust_apply_prototype_fan_pressure_rise(fan_zone_exhaust)
     # Do not modify dummy exhaust fans
     return true if fan_zone_exhaust.name.to_s.downcase.include? 'dummy'
@@ -21,6 +24,16 @@ class Standard
     return true
   end
 
+  # creates a FanZoneExhaust from a json
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param fan_json [Hash] hash of fan properties
+  # @param fan_name [String] fan name
+  # @param fan_efficiency [Double] fan efficiency
+  # @param pressure_rise [Double] fan pressure rise in Pa
+  # @param system_availability_manager_coupling_mode [String] coupling mode, options are Coupled, Decoupled
+  # @param end_use_subcategory [String] end use subcategory name
+  # @return [OpenStudio::Model::FanZoneExhaust] the exhaust fan
   def create_fan_zone_exhaust_from_json(model,
                                         fan_json,
                                         fan_name: nil,
@@ -47,6 +60,15 @@ class Standard
     return fan
   end
 
+  # creates a FanZoneExhaust
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param fan_name [String] fan name
+  # @param fan_efficiency [Double] fan efficiency
+  # @param pressure_rise [Double] fan pressure rise in Pa
+  # @param system_availability_manager_coupling_mode [String] coupling mode, options are Coupled, Decoupled
+  # @param end_use_subcategory [String] end use subcategory name
+  # @return [OpenStudio::Model::FanZoneExhaust] the exhaust fan
   def create_fan_zone_exhaust(model,
                               fan_name: nil,
                               fan_efficiency: nil,