openstudio-standards 0.8.3 → 0.8.5.rc1

data/lib/openstudio-standards/hvac/components/modify.rb

@@ -1,42 +0,0 @@
-module OpenstudioStandards
-  # The HVAC module provides methods create, modify, and get information about HVAC systems in the model
-  module HVAC
-    # @!group Component:Modify
-    # Methods to modify HVAC Component objects
-
-    # Applies historical default or user-input effectiveness values to a HeatExchangerAirToAirSensibleAndLatent object
-    #
-    # @param hx [<OpenStudio::Model::HeatExchangerAirToAirSensibleAndLatent>] OpenStudio HX object to update
-    # @param defaults [Boolean] flag to apply historical default curves
-    # @param values [Hash{String=>Hash{Float=>Float}}] user-input effectiveness values, where keys are one of
-    #   'Sensible Heating', 'Latent Heating, 'Sensible Cooling', 'Latent Cooling'
-    #   and value is a hash of { flow decimal fraction => effectivess decimal fraction }, e.g. { 0.75 => 0.81, 1.0 => 0.76 }
-    # @return [<OpenStudio::Model::HeatExchangerAirToAirSensibleAndLatent>] modified OpenStudio HX object
-    def self.heat_exchanger_air_to_air_set_effectiveness_values(hx, defaults: false, values: nil)
-      if defaults
-        hx.assignHistoricalEffectivenessCurves
-        if values.nil?
-          return hx
-        end
-      elsif values.nil?
-        OpenStudio.logFree(OpenStudio::Warn, 'openstudio.model.Hvac', "#{__method__} called with defaults=false and no values provided. #{hx.name.get} will not be modified")
-        return hx
-      end
-
-      values.each do |type, values_hash|
-        # ensure values_hash has one value at 100% flow
-        unless values_hash.key?(1.0)
-          OpenStudio.logFree(OpenStudio::Error, 'openstudio.model.Hvac', "Effectiveness Values for #{type} do not include 100% flow effectivenss. Cannot set effectiveness curves")
-          return false
-        end
-
-        lookup_table = OpenstudioStandards::HVAC.create_hx_effectiveness_table(hx, type, values_hash)
-        type_a = type.split
-        hx.send("set#{type_a[0]}Effectivenessat100#{type_a[1]}AirFlow", values_hash[1.0])
-        hx.send("set#{type_a[0]}Effectivenessof#{type_a[1]}AirFlowCurve", lookup_table)
-      end
-
-      return hx
-    end
-  end
-end

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

@@ -1,438 +0,0 @@
-class Standard
-  # @!group AirConditionerVariableRefrigerantFlow
-
-  # 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
-  # @param cooling_cop [Double] rated cooling coefficient of performance
-  # @param heating_cop [Double] rated heating coefficient of performance
-  # @param heat_recovery [Boolean] does the unit have heat recovery
-  # @param defrost_strategy [String] type of defrost strategy. options are ReverseCycle or Resistive
-  # @param condenser_type [String] type of condenser
-  #   options are AirCooled (default), WaterCooled, and EvaporativelyCooled.
-  #   if WaterCooled, the user most include a condenser_loop
-  # @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,
-                                                       type: nil,
-                                                       cooling_cop: 4.287,
-                                                       heating_cop: 4.147,
-                                                       heat_recovery: true,
-                                                       defrost_strategy: 'Resistive',
-                                                       condenser_type: 'AirCooled',
-                                                       condenser_loop: nil,
-                                                       master_zone: nil,
-                                                       priority_control_type: 'LoadPriority')
-
-    vrf_outdoor_unit = OpenStudio::Model::AirConditionerVariableRefrigerantFlow.new(model)
-
-    # set name
-    if name.nil?
-      vrf_outdoor_unit.setName('VRF System')
-    else
-      vrf_outdoor_unit.setName(name)
-    end
-
-    # set availability schedule
-    if schedule.nil?
-      # default always on
-      availability_schedule = model.alwaysOnDiscreteSchedule
-    elsif schedule.instance_of?(String)
-      availability_schedule = model_add_schedule(model, schedule)
-
-      if availability_schedule.nil? && schedule == 'alwaysOffDiscreteSchedule'
-        availability_schedule = model.alwaysOffDiscreteSchedule
-      elsif availability_schedule.nil?
-        availability_schedule = model.alwaysOnDiscreteSchedule
-      end
-    elsif !schedule.to_Schedule.empty?
-      availability_schedule = schedule
-    else
-      availability_schedule = model.alwaysOnDiscreteSchedule
-    end
-    vrf_outdoor_unit.setAvailabilitySchedule(availability_schedule)
-
-    # set cops
-    if model.version < OpenStudio::VersionString.new('2.9.0')
-      vrf_outdoor_unit.setRatedCoolingCOP(cooling_cop)
-    else
-      vrf_outdoor_unit.setGrossRatedCoolingCOP(cooling_cop)
-    end
-    vrf_outdoor_unit.setRatedHeatingCOP(heating_cop)
-
-    # heat recovery
-    if heat_recovery
-      vrf_outdoor_unit.setHeatPumpWasteHeatRecovery(true)
-    else
-      vrf_outdoor_unit.setHeatPumpWasteHeatRecovery(false)
-    end
-
-    # defrost strategy
-    vrf_outdoor_unit.setDefrostStrategy(defrost_strategy)
-
-    # defaults
-    vrf_outdoor_unit.setMinimumOutdoorTemperatureinCoolingMode(-15.0)
-    vrf_outdoor_unit.setMaximumOutdoorTemperatureinCoolingMode(50.0)
-    vrf_outdoor_unit.setMinimumOutdoorTemperatureinHeatingMode(-25.0)
-    vrf_outdoor_unit.setMaximumOutdoorTemperatureinHeatingMode(16.1)
-    vrf_outdoor_unit.setMinimumOutdoorTemperatureinHeatRecoveryMode(-10.0)
-    vrf_outdoor_unit.setMaximumOutdoorTemperatureinHeatRecoveryMode(27.2)
-    vrf_outdoor_unit.setEquivalentPipingLengthusedforPipingCorrectionFactorinCoolingMode(30.48)
-    vrf_outdoor_unit.setEquivalentPipingLengthusedforPipingCorrectionFactorinHeatingMode(30.48)
-    vrf_outdoor_unit.setVerticalHeightusedforPipingCorrectionFactor(10.668)
-
-    # condenser type
-    if condenser_type == 'WaterCooled'
-      vrf_outdoor_unit.setString(56, condenser_type)
-      # require condenser_loop
-      unless condenser_loop
-        OpenStudio.logFree(OpenStudio::Error, 'openstudio.Model.Model', 'Must specify condenser_loop for vrf_outdoor_unit if WaterCooled')
-      end
-      condenser_loop.addDemandBranchForComponent(vrf_outdoor_unit)
-    elsif condenser_type == 'EvaporativelyCooled'
-      vrf_outdoor_unit.setString(56, condenser_type)
-    end
-
-    # set master zone
-    unless master_zone.to_ThermalZone.empty?
-      vrf_outdoor_unit.setZoneforMasterThermostatLocation(master_zone)
-      vrf_outdoor_unit.setMasterThermostatPriorityControlType(priority_control_type)
-    end
-
-    vrf_cool_cap_f_of_low_temp = nil
-    vrf_cool_cap_ratio_boundary = nil
-    vrf_cool_cap_f_of_high_temp = nil
-    vrf_cool_eir_f_of_low_temp = nil
-    vrf_cool_eir_ratio_boundary = nil
-    vrf_cool_eir_f_of_high_temp = nil
-    vrf_cooling_eir_low_plr = nil
-    vrf_cooling_eir_high_plr = nil
-    vrf_cooling_comb_ratio = nil
-    vrf_cooling_cplffplr = nil
-    vrf_heat_cap_f_of_low_temp = nil
-    vrf_heat_cap_ratio_boundary = nil
-    vrf_heat_cap_f_of_high_temp = nil
-    vrf_heat_eir_f_of_low_temp = nil
-    vrf_heat_eir_boundary = nil
-    vrf_heat_eir_f_of_high_temp = nil
-    vrf_heating_eir_low_plr = nil
-    vrf_heating_eir_hi_plr = nil
-    vrf_heating_comb_ratio = nil
-    vrf_heating_cplffplr = nil
-    vrf_defrost_eir_f_of_temp = nil
-
-    # curve sets
-    if type == 'OS default'
-
-      # use OS default curves
-
-    else # default curve set
-
-      # based on DAIKINREYQ 120 on BCL
-
-      # Cooling Capacity Ratio Modifier Function of Low Temperature Curve
-      vrf_cool_cap_f_of_low_temp = OpenStudio::Model::CurveBiquadratic.new(model)
-      vrf_cool_cap_f_of_low_temp.setName('vrf_cool_cap_f_of_low_temp')
-      vrf_cool_cap_f_of_low_temp.setCoefficient1Constant(-1.69653019339465)
-      vrf_cool_cap_f_of_low_temp.setCoefficient2x(0.207248180531939)
-      vrf_cool_cap_f_of_low_temp.setCoefficient3xPOW2(-0.00343146229659024)
-      vrf_cool_cap_f_of_low_temp.setCoefficient4y(0.016381597419714)
-      vrf_cool_cap_f_of_low_temp.setCoefficient5yPOW2(-6.7387172629965e-05)
-      vrf_cool_cap_f_of_low_temp.setCoefficient6xTIMESY(-0.000849848402870241)
-      vrf_cool_cap_f_of_low_temp.setMinimumValueofx(13.9)
-      vrf_cool_cap_f_of_low_temp.setMaximumValueofx(23.9)
-      vrf_cool_cap_f_of_low_temp.setMinimumValueofy(-5.0)
-      vrf_cool_cap_f_of_low_temp.setMaximumValueofy(43.3)
-      vrf_cool_cap_f_of_low_temp.setMinimumCurveOutput(0.59)
-      vrf_cool_cap_f_of_low_temp.setMaximumCurveOutput(1.33)
-
-      # Cooling Capacity Ratio Boundary Curve
-      vrf_cool_cap_ratio_boundary = OpenStudio::Model::CurveCubic.new(model)
-      vrf_cool_cap_ratio_boundary.setName('vrf_cool_cap_ratio_boundary')
-      vrf_cool_cap_ratio_boundary.setCoefficient1Constant(25.73)
-      vrf_cool_cap_ratio_boundary.setCoefficient2x(-0.03150043)
-      vrf_cool_cap_ratio_boundary.setCoefficient3xPOW2(-0.01416595)
-      vrf_cool_cap_ratio_boundary.setCoefficient4xPOW3(0.0)
-      vrf_cool_cap_ratio_boundary.setMinimumValueofx(11.0)
-      vrf_cool_cap_ratio_boundary.setMaximumValueofx(30.0)
-
-      # Cooling Capacity Ratio Modifier Function of High Temperature Curve
-      vrf_cool_cap_f_of_high_temp = OpenStudio::Model::CurveBiquadratic.new(model)
-      vrf_cool_cap_f_of_high_temp.setName('vrf_cool_cap_f_of_high_temp')
-      vrf_cool_cap_f_of_high_temp.setCoefficient1Constant(0.6867358)
-      vrf_cool_cap_f_of_high_temp.setCoefficient2x(0.0207631)
-      vrf_cool_cap_f_of_high_temp.setCoefficient3xPOW2(0.0005447)
-      vrf_cool_cap_f_of_high_temp.setCoefficient4y(-0.0016218)
-      vrf_cool_cap_f_of_high_temp.setCoefficient5yPOW2(-4.259e-07)
-      vrf_cool_cap_f_of_high_temp.setCoefficient6xTIMESY(-0.0003392)
-      vrf_cool_cap_f_of_high_temp.setMinimumValueofx(15.0)
-      vrf_cool_cap_f_of_high_temp.setMaximumValueofx(24.0)
-      vrf_cool_cap_f_of_high_temp.setMinimumValueofy(16.0)
-      vrf_cool_cap_f_of_high_temp.setMaximumValueofy(43.0)
-
-      # Cooling Energy Input Ratio Modifier Function of Low Temperature Curve
-      vrf_cool_eir_f_of_low_temp = OpenStudio::Model::CurveBiquadratic.new(model)
-      vrf_cool_eir_f_of_low_temp.setName('vrf_cool_eir_f_of_low_temp')
-      vrf_cool_eir_f_of_low_temp.setCoefficient1Constant(-1.61908214818635)
-      vrf_cool_eir_f_of_low_temp.setCoefficient2x(0.185964818731756)
-      vrf_cool_eir_f_of_low_temp.setCoefficient3xPOW2(-0.00389610393381592)
-      vrf_cool_eir_f_of_low_temp.setCoefficient4y(-0.00901995326324613)
-      vrf_cool_eir_f_of_low_temp.setCoefficient5yPOW2(0.00030340007815629)
-      vrf_cool_eir_f_of_low_temp.setCoefficient6xTIMESY(0.000476048529099348)
-      vrf_cool_eir_f_of_low_temp.setMinimumValueofx(13.9)
-      vrf_cool_eir_f_of_low_temp.setMaximumValueofx(23.9)
-      vrf_cool_eir_f_of_low_temp.setMinimumValueofy(-5.0)
-      vrf_cool_eir_f_of_low_temp.setMaximumValueofy(43.3)
-      vrf_cool_eir_f_of_low_temp.setMinimumCurveOutput(0.27)
-      vrf_cool_eir_f_of_low_temp.setMaximumCurveOutput(1.15)
-
-      # Cooling Energy Input Ratio Boundary Curve
-      vrf_cool_eir_ratio_boundary = OpenStudio::Model::CurveCubic.new(model)
-      vrf_cool_eir_ratio_boundary.setName('vrf_cool_eir_ratio_boundary')
-      vrf_cool_eir_ratio_boundary.setCoefficient1Constant(25.73473775)
-      vrf_cool_eir_ratio_boundary.setCoefficient2x(-0.03150043)
-      vrf_cool_eir_ratio_boundary.setCoefficient3xPOW2(-0.01416595)
-      vrf_cool_eir_ratio_boundary.setCoefficient4xPOW3(0.0)
-      vrf_cool_eir_ratio_boundary.setMinimumValueofx(15.0)
-      vrf_cool_eir_ratio_boundary.setMaximumValueofx(24.0)
-
-      # Cooling Energy Input Ratio Modifier Function of High Temperature Curve
-      vrf_cool_eir_f_of_high_temp = OpenStudio::Model::CurveBiquadratic.new(model)
-      vrf_cool_eir_f_of_high_temp.setName('vrf_cool_eir_f_of_high_temp')
-      vrf_cool_eir_f_of_high_temp.setCoefficient1Constant(-1.4395110176)
-      vrf_cool_eir_f_of_high_temp.setCoefficient2x(0.1619850459)
-      vrf_cool_eir_f_of_high_temp.setCoefficient3xPOW2(-0.0034911781)
-      vrf_cool_eir_f_of_high_temp.setCoefficient4y(0.0269442645)
-      vrf_cool_eir_f_of_high_temp.setCoefficient5yPOW2(0.0001346163)
-      vrf_cool_eir_f_of_high_temp.setCoefficient6xTIMESY(-0.0006714941)
-      vrf_cool_eir_f_of_high_temp.setMinimumValueofx(15.0)
-      vrf_cool_eir_f_of_high_temp.setMaximumValueofx(23.9)
-      vrf_cool_eir_f_of_high_temp.setMinimumValueofy(16.8)
-      vrf_cool_eir_f_of_high_temp.setMaximumValueofy(43.3)
-
-      # Cooling Energy Input Ratio Modifier Function of Low Part-Load Ratio Curve
-      vrf_cooling_eir_low_plr = OpenStudio::Model::CurveCubic.new(model)
-      vrf_cooling_eir_low_plr.setName('vrf_cool_eir_f_of_low_temp')
-      vrf_cooling_eir_low_plr.setCoefficient1Constant(0.0734992169827752)
-      vrf_cooling_eir_low_plr.setCoefficient2x(0.334783365234032)
-      vrf_cooling_eir_low_plr.setCoefficient3xPOW2(0.591613015486343)
-      vrf_cooling_eir_low_plr.setCoefficient4xPOW3(0.0)
-      vrf_cooling_eir_low_plr.setMinimumValueofx(0.25)
-      vrf_cooling_eir_low_plr.setMaximumValueofx(1.0)
-      vrf_cooling_eir_low_plr.setMinimumCurveOutput(0.0)
-      vrf_cooling_eir_low_plr.setMaximumCurveOutput(1.0)
-
-      # Cooling Energy Input Ratio Modifier Function of High Part-Load Ratio Curve
-      vrf_cooling_eir_high_plr = OpenStudio::Model::CurveCubic.new(model)
-      vrf_cooling_eir_high_plr.setName('vrf_cooling_eir_high_plr')
-      vrf_cooling_eir_high_plr.setCoefficient1Constant(1.0)
-      vrf_cooling_eir_high_plr.setCoefficient2x(0.0)
-      vrf_cooling_eir_high_plr.setCoefficient3xPOW2(0.0)
-      vrf_cooling_eir_high_plr.setCoefficient4xPOW3(0.0)
-      vrf_cooling_eir_high_plr.setMinimumValueofx(1.0)
-      vrf_cooling_eir_high_plr.setMaximumValueofx(1.5)
-
-      # Cooling Combination Ratio Correction Factor Curve
-      vrf_cooling_comb_ratio = OpenStudio::Model::CurveCubic.new(model)
-      vrf_cooling_comb_ratio.setName('vrf_cooling_comb_ratio')
-      vrf_cooling_comb_ratio.setCoefficient1Constant(0.24034)
-      vrf_cooling_comb_ratio.setCoefficient2x(-0.21873)
-      vrf_cooling_comb_ratio.setCoefficient3xPOW2(1.97941)
-      vrf_cooling_comb_ratio.setCoefficient4xPOW3(-1.02636)
-      vrf_cooling_comb_ratio.setMinimumValueofx(0.5)
-      vrf_cooling_comb_ratio.setMaximumValueofx(2.0)
-      vrf_cooling_comb_ratio.setMinimumCurveOutput(0.5)
-      vrf_cooling_comb_ratio.setMaximumCurveOutput(1.056)
-
-      # Cooling Part-Load Fraction Correlation Curve
-      vrf_cooling_cplffplr = OpenStudio::Model::CurveCubic.new(model)
-      vrf_cooling_cplffplr.setName('vrf_cooling_cplffplr')
-      vrf_cooling_cplffplr.setCoefficient1Constant(0.85)
-      vrf_cooling_cplffplr.setCoefficient2x(0.15)
-      vrf_cooling_cplffplr.setCoefficient3xPOW2(0.0)
-      vrf_cooling_cplffplr.setCoefficient4xPOW3(0.0)
-      vrf_cooling_cplffplr.setMinimumValueofx(1.0)
-      vrf_cooling_cplffplr.setMaximumValueofx(1.0)
-
-      # Heating Capacity Ratio Modifier Function of Low Temperature Curve Name
-      vrf_heat_cap_f_of_low_temp = OpenStudio::Model::CurveBiquadratic.new(model)
-      vrf_heat_cap_f_of_low_temp.setName('vrf_heat_cap_f_of_low_temp')
-      vrf_heat_cap_f_of_low_temp.setCoefficient1Constant(0.983220174655636)
-      vrf_heat_cap_f_of_low_temp.setCoefficient2x(0.0157167577703294)
-      vrf_heat_cap_f_of_low_temp.setCoefficient3xPOW2(-0.000835032422884084)
-      vrf_heat_cap_f_of_low_temp.setCoefficient4y(0.0522939264581759)
-      vrf_heat_cap_f_of_low_temp.setCoefficient5yPOW2(-0.000531556035364549)
-      vrf_heat_cap_f_of_low_temp.setCoefficient6xTIMESY(-0.00190605953116024)
-      vrf_heat_cap_f_of_low_temp.setMinimumValueofx(16.1)
-      vrf_heat_cap_f_of_low_temp.setMaximumValueofx(23.9)
-      vrf_heat_cap_f_of_low_temp.setMinimumValueofy(-25.0)
-      vrf_heat_cap_f_of_low_temp.setMaximumValueofy(13.3)
-      vrf_heat_cap_f_of_low_temp.setMinimumCurveOutput(0.515151515151515)
-      vrf_heat_cap_f_of_low_temp.setMaximumCurveOutput(1.2)
-
-      # Heating Capacity Ratio Boundary Curve Name
-      vrf_heat_cap_ratio_boundary = OpenStudio::Model::CurveCubic.new(model)
-      vrf_heat_cap_ratio_boundary.setName('vrf_heat_cap_ratio_boundary')
-      vrf_heat_cap_ratio_boundary.setCoefficient1Constant(58.577)
-      vrf_heat_cap_ratio_boundary.setCoefficient2x(-3.0255)
-      vrf_heat_cap_ratio_boundary.setCoefficient3xPOW2(0.0193)
-      vrf_heat_cap_ratio_boundary.setCoefficient4xPOW3(0.0)
-      vrf_heat_cap_ratio_boundary.setMinimumValueofx(15)
-      vrf_heat_cap_ratio_boundary.setMaximumValueofx(23.9)
-
-      # Heating Capacity Ratio Modifier Function of High Temperature Curve Name
-      vrf_heat_cap_f_of_high_temp = OpenStudio::Model::CurveBiquadratic.new(model)
-      vrf_heat_cap_f_of_high_temp.setName('vrf_heat_cap_f_of_high_temp')
-      vrf_heat_cap_f_of_high_temp.setCoefficient1Constant(2.5859872368)
-      vrf_heat_cap_f_of_high_temp.setCoefficient2x(-0.0953227101)
-      vrf_heat_cap_f_of_high_temp.setCoefficient3xPOW2(0.0009553288)
-      vrf_heat_cap_f_of_high_temp.setCoefficient4y(0.0)
-      vrf_heat_cap_f_of_high_temp.setCoefficient5yPOW2(0.0)
-      vrf_heat_cap_f_of_high_temp.setCoefficient6xTIMESY(0.0)
-      vrf_heat_cap_f_of_high_temp.setMinimumValueofx(21.1)
-      vrf_heat_cap_f_of_high_temp.setMaximumValueofx(27.2)
-      vrf_heat_cap_f_of_high_temp.setMinimumValueofy(-944)
-      vrf_heat_cap_f_of_high_temp.setMaximumValueofy(15)
-
-      # Heating Energy Input Ratio Modifier Function of Low Temperature Curve Name
-      vrf_heat_eir_f_of_low_temp = OpenStudio::Model::CurveBiquadratic.new(model)
-      vrf_heat_eir_f_of_low_temp.setName('vrf_heat_eir_f_of_low_temp')
-      vrf_heat_eir_f_of_low_temp.setCoefficient1Constant(0.756830029796909)
-      vrf_heat_eir_f_of_low_temp.setCoefficient2x(0.0457499799042671)
-      vrf_heat_eir_f_of_low_temp.setCoefficient3xPOW2(-0.00136357240431388)
-      vrf_heat_eir_f_of_low_temp.setCoefficient4y(0.0554884599902023)
-      vrf_heat_eir_f_of_low_temp.setCoefficient5yPOW2(-0.00120700875497686)
-      vrf_heat_eir_f_of_low_temp.setCoefficient6xTIMESY(-0.00303329271420931)
-      vrf_heat_eir_f_of_low_temp.setMinimumValueofx(16.1)
-      vrf_heat_eir_f_of_low_temp.setMaximumValueofx(23.9)
-      vrf_heat_eir_f_of_low_temp.setMinimumValueofy(-25.0)
-      vrf_heat_eir_f_of_low_temp.setMaximumValueofy(13.3)
-      vrf_heat_eir_f_of_low_temp.setMinimumCurveOutput(0.7)
-      vrf_heat_eir_f_of_low_temp.setMaximumCurveOutput(1.184)
-
-      # Heating Energy Input Ratio Boundary Curve Name
-      vrf_heat_eir_boundary = OpenStudio::Model::CurveCubic.new(model)
-      vrf_heat_eir_boundary.setName('vrf_heat_eir_boundary')
-      vrf_heat_eir_boundary.setCoefficient1Constant(58.577)
-      vrf_heat_eir_boundary.setCoefficient2x(-3.0255)
-      vrf_heat_eir_boundary.setCoefficient3xPOW2(0.0193)
-      vrf_heat_eir_boundary.setCoefficient4xPOW3(0.0)
-      vrf_heat_eir_boundary.setMinimumValueofx(15.0)
-      vrf_heat_eir_boundary.setMaximumValueofx(23.9)
-
-      # Heating Energy Input Ratio Modifier Function of High Temperature Curve Name
-      vrf_heat_eir_f_of_high_temp = OpenStudio::Model::CurveBiquadratic.new(model)
-      vrf_heat_eir_f_of_high_temp.setName('vrf_heat_eir_f_of_high_temp')
-      vrf_heat_eir_f_of_high_temp.setCoefficient1Constant(1.3885703646)
-      vrf_heat_eir_f_of_high_temp.setCoefficient2x(-0.0229771462)
-      vrf_heat_eir_f_of_high_temp.setCoefficient3xPOW2(0.000537274)
-      vrf_heat_eir_f_of_high_temp.setCoefficient4y(-0.0273936962)
-      vrf_heat_eir_f_of_high_temp.setCoefficient5yPOW2(0.0004030426)
-      vrf_heat_eir_f_of_high_temp.setCoefficient6xTIMESY(-5.9786e-05)
-      vrf_heat_eir_f_of_high_temp.setMinimumValueofx(21.1)
-      vrf_heat_eir_f_of_high_temp.setMaximumValueofx(27.2)
-      vrf_heat_eir_f_of_high_temp.setMinimumValueofy(0.0)
-      vrf_heat_eir_f_of_high_temp.setMaximumValueofy(1.0)
-
-      # Heating Performance Curve Outdoor Temperature Type
-      vrf_outdoor_unit.setHeatingPerformanceCurveOutdoorTemperatureType('WetBulbTemperature')
-
-      # Heating Energy Input Ratio Modifier Function of Low Part-Load Ratio Curve Name
-      vrf_heating_eir_low_plr = OpenStudio::Model::CurveCubic.new(model)
-      vrf_heating_eir_low_plr.setName('vrf_heating_eir_low_plr')
-      vrf_heating_eir_low_plr.setCoefficient1Constant(0.0724906507105475)
-      vrf_heating_eir_low_plr.setCoefficient2x(0.658189977561701)
-      vrf_heating_eir_low_plr.setCoefficient3xPOW2(0.269259536275246)
-      vrf_heating_eir_low_plr.setCoefficient4xPOW3(0.0)
-      vrf_heating_eir_low_plr.setMinimumValueofx(0.25)
-      vrf_heating_eir_low_plr.setMaximumValueofx(1.0)
-      vrf_heating_eir_low_plr.setMinimumCurveOutput(0.0)
-      vrf_heating_eir_low_plr.setMaximumCurveOutput(1.0)
-
-      # Heating Energy Input Ratio Modifier Function of High Part-Load Ratio Curve Name
-      vrf_heating_eir_hi_plr = OpenStudio::Model::CurveCubic.new(model)
-      vrf_heating_eir_hi_plr.setName('vrf_heating_eir_hi_plr')
-      vrf_heating_eir_hi_plr.setCoefficient1Constant(1.0)
-      vrf_heating_eir_hi_plr.setCoefficient2x(0.0)
-      vrf_heating_eir_hi_plr.setCoefficient3xPOW2(0.0)
-      vrf_heating_eir_hi_plr.setCoefficient4xPOW3(0.0)
-      vrf_heating_eir_hi_plr.setMinimumValueofx(1.0)
-      vrf_heating_eir_hi_plr.setMaximumValueofx(1.5)
-
-      # Heating Combination Ratio Correction Factor Curve Name
-      vrf_heating_comb_ratio = OpenStudio::Model::CurveCubic.new(model)
-      vrf_heating_comb_ratio.setName('vrf_heating_comb_ratio')
-      vrf_heating_comb_ratio.setCoefficient1Constant(0.62115)
-      vrf_heating_comb_ratio.setCoefficient2x(-1.55798)
-      vrf_heating_comb_ratio.setCoefficient3xPOW2(3.36817)
-      vrf_heating_comb_ratio.setCoefficient4xPOW3(-1.4224)
-      vrf_heating_comb_ratio.setMinimumValueofx(0.5)
-      vrf_heating_comb_ratio.setMaximumValueofx(2.0)
-      vrf_heating_comb_ratio.setMinimumCurveOutput(0.5)
-      vrf_heating_comb_ratio.setMaximumCurveOutput(1.155)
-
-      # Heating Part-Load Fraction Correlation Curve Name
-      vrf_heating_cplffplr = OpenStudio::Model::CurveCubic.new(model)
-      vrf_heating_cplffplr.setName('vrf_heating_cplffplr')
-      vrf_heating_cplffplr.setCoefficient1Constant(0.85)
-      vrf_heating_cplffplr.setCoefficient2x(0.15)
-      vrf_heating_cplffplr.setCoefficient3xPOW2(0.0)
-      vrf_heating_cplffplr.setCoefficient4xPOW3(0.0)
-      vrf_heating_cplffplr.setMinimumValueofx(1.0)
-      vrf_heating_cplffplr.setMaximumValueofx(1.0)
-
-      # Defrost Energy Input Ratio Modifier Function of Temperature Curve
-      vrf_defrost_eir_f_of_temp = OpenStudio::Model::CurveBiquadratic.new(model)
-      vrf_defrost_eir_f_of_temp.setName('vrf_defrost_eir_f_of_temp')
-      vrf_defrost_eir_f_of_temp.setCoefficient1Constant(-1.61908214818635)
-      vrf_defrost_eir_f_of_temp.setCoefficient2x(0.185964818731756)
-      vrf_defrost_eir_f_of_temp.setCoefficient3xPOW2(-0.00389610393381592)
-      vrf_defrost_eir_f_of_temp.setCoefficient4y(-0.00901995326324613)
-      vrf_defrost_eir_f_of_temp.setCoefficient5yPOW2(0.00030340007815629)
-      vrf_defrost_eir_f_of_temp.setCoefficient6xTIMESY(0.000476048529099348)
-      vrf_defrost_eir_f_of_temp.setMinimumValueofx(13.9)
-      vrf_defrost_eir_f_of_temp.setMaximumValueofx(23.9)
-      vrf_defrost_eir_f_of_temp.setMinimumValueofy(-5.0)
-      vrf_defrost_eir_f_of_temp.setMaximumValueofy(50.0)
-      vrf_defrost_eir_f_of_temp.setMinimumCurveOutput(0.27)
-      vrf_defrost_eir_f_of_temp.setMaximumCurveOutput(1.155)
-
-      # set defrost control
-      vrf_outdoor_unit.setDefrostStrategy('ReverseCycle')
-      vrf_outdoor_unit.setDefrostControl('OnDemand')
-
-    end
-
-    vrf_outdoor_unit.setCoolingCapacityRatioModifierFunctionofLowTemperatureCurve(vrf_cool_cap_f_of_low_temp) unless vrf_cool_cap_f_of_low_temp.nil?
-    vrf_outdoor_unit.setCoolingCapacityRatioBoundaryCurve(vrf_cool_cap_ratio_boundary) unless vrf_cool_cap_ratio_boundary.nil?
-    vrf_outdoor_unit.setCoolingCapacityRatioModifierFunctionofHighTemperatureCurve(vrf_cool_cap_f_of_high_temp) unless vrf_cool_cap_f_of_high_temp.nil?
-    vrf_outdoor_unit.setCoolingEnergyInputRatioModifierFunctionofLowTemperatureCurve(vrf_cool_eir_f_of_low_temp) unless vrf_cool_eir_f_of_low_temp.nil?
-    vrf_outdoor_unit.setCoolingEnergyInputRatioBoundaryCurve(vrf_cool_eir_ratio_boundary) unless vrf_cool_eir_ratio_boundary.nil?
-    vrf_outdoor_unit.setCoolingEnergyInputRatioModifierFunctionofHighTemperatureCurve(vrf_cool_eir_f_of_high_temp) unless vrf_cool_eir_f_of_high_temp.nil?
-    vrf_outdoor_unit.setCoolingEnergyInputRatioModifierFunctionofLowPartLoadRatioCurve(vrf_cooling_eir_low_plr) unless vrf_cooling_eir_low_plr.nil?
-    vrf_outdoor_unit.setCoolingEnergyInputRatioModifierFunctionofHighPartLoadRatioCurve(vrf_cooling_eir_high_plr) unless vrf_cooling_eir_high_plr.nil?
-    vrf_outdoor_unit.setCoolingCombinationRatioCorrectionFactorCurve(vrf_cooling_comb_ratio) unless vrf_cooling_comb_ratio.nil?
-    vrf_outdoor_unit.setCoolingPartLoadFractionCorrelationCurve(vrf_cooling_cplffplr) unless vrf_cooling_cplffplr.nil?
-    vrf_outdoor_unit.setHeatingCapacityRatioModifierFunctionofLowTemperatureCurve(vrf_heat_cap_f_of_low_temp) unless vrf_heat_cap_f_of_low_temp.nil?
-    vrf_outdoor_unit.setHeatingCapacityRatioBoundaryCurve(vrf_heat_cap_ratio_boundary) unless vrf_heat_cap_ratio_boundary.nil?
-    vrf_outdoor_unit.setHeatingCapacityRatioModifierFunctionofHighTemperatureCurve(vrf_heat_cap_f_of_high_temp) unless vrf_heat_cap_f_of_high_temp.nil?
-    vrf_outdoor_unit.setHeatingEnergyInputRatioModifierFunctionofLowTemperatureCurve(vrf_heat_eir_f_of_low_temp) unless vrf_heat_eir_f_of_low_temp.nil?
-    vrf_outdoor_unit.setHeatingEnergyInputRatioBoundaryCurve(vrf_heat_eir_boundary) unless vrf_heat_eir_boundary.nil?
-    vrf_outdoor_unit.setHeatingEnergyInputRatioModifierFunctionofHighTemperatureCurve(vrf_heat_eir_f_of_high_temp) unless vrf_heat_eir_f_of_high_temp.nil?
-    vrf_outdoor_unit.setHeatingEnergyInputRatioModifierFunctionofLowPartLoadRatioCurve(vrf_heating_eir_low_plr) unless vrf_heating_eir_low_plr.nil?
-    vrf_outdoor_unit.setHeatingEnergyInputRatioModifierFunctionofHighPartLoadRatioCurve(vrf_heating_eir_hi_plr) unless vrf_heating_eir_hi_plr.nil?
-    vrf_outdoor_unit.setHeatingCombinationRatioCorrectionFactorCurve(vrf_heating_comb_ratio) unless vrf_heating_comb_ratio.nil?
-    vrf_outdoor_unit.setHeatingPartLoadFractionCorrelationCurve(vrf_heating_cplffplr) unless vrf_heating_cplffplr.nil?
-    vrf_outdoor_unit.setDefrostEnergyInputRatioModifierFunctionofTemperatureCurve(vrf_defrost_eir_f_of_temp) unless vrf_defrost_eir_f_of_temp.nil?
-
-    return vrf_outdoor_unit
-  end
-end

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

@@ -1,123 +0,0 @@
-class Standard
-  # @!group Boiler Hot Water
-
-  # 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
-  # @param draft_type [String] Boiler type Condensing, MechanicalNoncondensing, Natural (default)
-  # @param nominal_thermal_efficiency [Double] boiler nominal thermal efficiency
-  # @param eff_curve_temp_eval_var [String] LeavingBoiler or EnteringBoiler temperature for the boiler efficiency curve
-  # @param flow_mode [String] boiler flow mode
-  # @param lvg_temp_dsgn_f [Double] boiler leaving design temperature in degrees Fahrenheit
-  #   note that this field is deprecated in OS versions 3.0+
-  # @param out_temp_lmt_f [Double] boiler outlet temperature limit in degrees Fahrenheit
-  # @param min_plr [Double] boiler minimum part load ratio
-  # @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',
-                              fuel_type: 'NaturalGas',
-                              draft_type: 'Natural',
-                              nominal_thermal_efficiency: 0.80,
-                              eff_curve_temp_eval_var: 'LeavingBoiler',
-                              flow_mode: 'LeavingSetpointModulated',
-                              lvg_temp_dsgn_f: 180.0, # 82.22 degrees Celsius
-                              out_temp_lmt_f: 203.0, # 95.0 degrees Celsius
-                              min_plr: 0.0,
-                              max_plr: 1.2,
-                              opt_plr: 1.0,
-                              sizing_factor: nil)
-
-    # create the boiler
-    boiler = OpenStudio::Model::BoilerHotWater.new(model)
-    if name.nil?
-      if hot_water_loop.nil?
-        boiler.setName('Boiler')
-      else
-        boiler.setName("#{hot_water_loop.name} Boiler")
-      end
-    else
-      boiler.setName(name)
-    end
-
-    if fuel_type.nil? || fuel_type == 'Gas'
-      boiler.setFuelType('NaturalGas')
-    elsif fuel_type == 'Propane' || fuel_type == 'PropaneGas'
-      boiler.setFuelType('Propane')
-    else
-      boiler.setFuelType(fuel_type)
-    end
-
-    if nominal_thermal_efficiency.nil?
-      boiler.setNominalThermalEfficiency(0.8)
-    else
-      boiler.setNominalThermalEfficiency(nominal_thermal_efficiency)
-    end
-
-    if eff_curve_temp_eval_var.nil?
-      boiler.setEfficiencyCurveTemperatureEvaluationVariable('LeavingBoiler')
-    else
-      boiler.setEfficiencyCurveTemperatureEvaluationVariable(eff_curve_temp_eval_var)
-    end
-
-    if flow_mode.nil?
-      boiler.setBoilerFlowMode('LeavingSetpointModulated')
-    else
-      boiler.setBoilerFlowMode(flow_mode)
-    end
-
-    if model.version < OpenStudio::VersionString.new('3.0.0')
-      if lvg_temp_dsgn_f.nil?
-        boiler.setDesignWaterOutletTemperature(OpenStudio.convert(180.0, 'F', 'C').get)
-      else
-        boiler.setDesignWaterOutletTemperature(OpenStudio.convert(lvg_temp_dsgn_f, 'F', 'C').get)
-      end
-    end
-
-    if out_temp_lmt_f.nil?
-      boiler.setWaterOutletUpperTemperatureLimit(OpenStudio.convert(203.0, 'F', 'C').get)
-    else
-      boiler.setWaterOutletUpperTemperatureLimit(OpenStudio.convert(out_temp_lmt_f, 'F', 'C').get)
-    end
-
-    # logic to set different defaults for condensing boilers if not specified
-    if draft_type == 'Condensing'
-      if model.version < OpenStudio::VersionString.new('3.0.0') && lvg_temp_dsgn_f.nil?
-        # default to 120 degrees Fahrenheit (48.49 degrees Celsius)
-        boiler.setDesignWaterOutletTemperature(OpenStudio.convert(120.0, 'F', 'C').get)
-      end
-      boiler.setNominalThermalEfficiency(0.96) if nominal_thermal_efficiency.nil?
-    end
-
-    if min_plr.nil?
-      boiler.setMinimumPartLoadRatio(0.0)
-    else
-      boiler.setMinimumPartLoadRatio(min_plr)
-    end
-
-    if max_plr.nil?
-      boiler.setMaximumPartLoadRatio(1.2)
-    else
-      boiler.setMaximumPartLoadRatio(max_plr)
-    end
-
-    if opt_plr.nil?
-      boiler.setOptimumPartLoadRatio(1.0)
-    else
-      boiler.setOptimumPartLoadRatio(opt_plr)
-    end
-
-    boiler.setSizingFactor(sizing_factor) unless sizing_factor.nil?
-
-    # add to supply side of hot water loop if specified
-    hot_water_loop.addSupplyBranchForComponent(boiler) unless hot_water_loop.nil?
-
-    return boiler
-  end
-end