Class: SetGasBurnerEfficiency

Inherits:

OpenStudio::Measure::ModelMeasure

• Object
• OpenStudio::Measure::ModelMeasure
• SetGasBurnerEfficiency

Defined in:

lib/measures/SetGasBurnerEfficiency/measure.rb

Overview

start the measure

Instance Method Summary

• #arguments(model) ⇒ Object

  define the arguments that the user will input.

• #get_total_costs_for_objects(objects) ⇒ Object

  helper that loops through lifecycle costs getting total costs under “Construction” or “Salvage” category and add to counter if occurs during year 0.

• #name ⇒ Object

  define the name that a user will see, this method may be deprecated as the display name in PAT comes from the name field in measure.xml.

• #neat_numbers(number, roundto = 2) ⇒ Object

  short def to make numbers pretty (converts 4125001.25641 to 4,125,001.26 or 4,125,001).

• #run(model, runner, user_arguments) ⇒ Object

  define what happens when the measure is eff.

Instance Method Details

#arguments(model) ⇒ Object

define the arguments that the user will input

# File 'lib/measures/SetGasBurnerEfficiency/measure.rb', line 15

def arguments(model)
  args = OpenStudio::Measure::OSArgumentVector.new

  # populate choice argument for constructions that are applied to surfaces in the model
  air_loop_handles = OpenStudio::StringVector.new
  air_loop_display_names = OpenStudio::StringVector.new

  # putting space types and names into hash
  air_loop_args = model.getAirLoopHVACs
  air_loop_args_hash = {}
  air_loop_args.each do |air_loop_arg|
    air_loop_args_hash[air_loop_arg.name.to_s] = air_loop_arg
  end

  # looping through sorted hash of air loops
  air_loop_args_hash.sort.map do |key, value|
    show_loop = false
    components = value.supplyComponents
    components.each do |component|
      if !component.to_CoilCoolingDXTwoSpeed.is_initialized # instead of if not component.to_CoilCoolingDXTwoSpeed.empty?
        show_loop = true
      end
    end
    if show_loop == true
      air_loop_handles << value.handle.to_s
      air_loop_display_names << key
    end
  end

  # add building to string vector with air loops
  building = model.getBuilding
  air_loop_handles << building.handle.to_s
  air_loop_display_names << '*All Air Loops*'

  # make an argument for air loops
  object = OpenStudio::Measure::OSArgument.makeChoiceArgument('object', air_loop_handles, air_loop_display_names, true)
  object.setDisplayName('Choose an Air Loop with a two speed DX Cooling Unit to Alter.')
  object.setDefaultValue('*All Air Loops*') # if no air loop is chosen this will run on all air loops
  args << object

  # make an argument to add new space true/false
  eff = OpenStudio::Measure::OSArgument.makeDoubleArgument('eff', true)
  eff.setDisplayName('Burner Efficiency (fractional)')
  eff.setDefaultValue(0.95)
  args << eff

  # bool argument to remove existing costs
  remove_costs = OpenStudio::Measure::OSArgument.makeBoolArgument('remove_costs', true)
  remove_costs.setDisplayName('Remove Baseline Costs From Effected Cooling Coil DX Two Speed Units?')
  remove_costs.setDefaultValue(true)
  args << remove_costs

  # make an argument for material and installation cost
  material_cost = OpenStudio::Measure::OSArgument.makeDoubleArgument('material_cost', true)
  material_cost.setDisplayName('Material and Installation Costs per Cooling Coil DX Two Speed Unit ($).')
  material_cost.setDefaultValue(0.0)
  args << material_cost

  # make an argument for demolition cost
  demolition_cost = OpenStudio::Measure::OSArgument.makeDoubleArgument('demolition_cost', true)
  demolition_cost.setDisplayName('Demolition Costs per Cooling Coil DX Two Speed Unit ($).')
  demolition_cost.setDefaultValue(0.0)
  args << demolition_cost

  # make an argument for duration in years until costs start
  years_until_costs_start = OpenStudio::Measure::OSArgument.makeIntegerArgument('years_until_costs_start', true)
  years_until_costs_start.setDisplayName('Years Until Costs Start (whole years).')
  years_until_costs_start.setDefaultValue(0)
  args << years_until_costs_start

  # make an argument to determine if demolition costs should be included in initial construction
  demo_cost_initial_const = OpenStudio::Measure::OSArgument.makeBoolArgument('demo_cost_initial_const', true)
  demo_cost_initial_const.setDisplayName('Demolition Costs Occur During Initial Construction?')
  demo_cost_initial_const.setDefaultValue(false)
  args << demo_cost_initial_const

  # make an argument for expected life
  expected_life = OpenStudio::Measure::OSArgument.makeIntegerArgument('expected_life', true)
  expected_life.setDisplayName('Expected Life (whole years).')
  expected_life.setDefaultValue(20)
  args << expected_life

  # make an argument for o&m cost
  om_cost = OpenStudio::Measure::OSArgument.makeDoubleArgument('om_cost', true)
  om_cost.setDisplayName('O & M Costs per Cooling Coil DX Two Speed Unit ($).')
  om_cost.setDefaultValue(0.0)
  args << om_cost

  # make an argument for o&m frequency
  om_frequency = OpenStudio::Measure::OSArgument.makeIntegerArgument('om_frequency', true)
  om_frequency.setDisplayName('O & M Frequency (whole years).')
  om_frequency.setDefaultValue(1)
  args << om_frequency

  return args
end

#get_total_costs_for_objects(objects) ⇒ Object

helper that loops through lifecycle costs getting total costs under “Construction” or “Salvage” category and add to counter if occurs during year 0

# File 'lib/measures/SetGasBurnerEfficiency/measure.rb', line 208

def get_total_costs_for_objects(objects)
  counter = 0
  objects.each do |object|
    object_LCCs = object.lifeCycleCosts
    object_LCCs.each do |object_LCC|
      if (object_LCC.category == 'Construction') || (object_LCC.category == 'Salvage')
        if object_LCC.yearsFromStart == 0
          counter += object_LCC.totalCost
        end
      end
    end
  end
  return counter
end

#name ⇒ Object

define the name that a user will see, this method may be deprecated as the display name in PAT comes from the name field in measure.xml

# File 'lib/measures/SetGasBurnerEfficiency/measure.rb', line 10

def name
  return 'Set Gas Burner Efficiency'
end

#neat_numbers(number, roundto = 2) ⇒ Object

short def to make numbers pretty (converts 4125001.25641 to 4,125,001.26 or 4,125,001). The definition be called through this measure

# File 'lib/measures/SetGasBurnerEfficiency/measure.rb', line 197

def neat_numbers(number, roundto = 2) # round to 0 or 2)
  if roundto == 2
    number = format '%.2f', number
  else
    number = number.round
  end
  # regex to add commas
  number.to_s.reverse.gsub(/([0-9]{3}(?=([0-9])))/, '\\1,').reverse
end

#run(model, runner, user_arguments) ⇒ Object

define what happens when the measure is eff

# File 'lib/measures/SetGasBurnerEfficiency/measure.rb', line 113

def run(model, runner, user_arguments)
  super(model, runner, user_arguments)

  # use the built-in error checking
  if !runner.validateUserArguments(arguments(model), user_arguments)
    return false
  end

  # assign the user inputs to variables
  object = runner.getOptionalWorkspaceObjectChoiceValue('object', user_arguments, model) # model is passed in because of argument type
  eff = runner.getDoubleArgumentValue('eff', user_arguments)
  remove_costs = runner.getBoolArgumentValue('remove_costs', user_arguments)
  material_cost = runner.getDoubleArgumentValue('material_cost', user_arguments)
  demolition_cost = runner.getDoubleArgumentValue('demolition_cost', user_arguments)
  years_until_costs_start = runner.getIntegerArgumentValue('years_until_costs_start', user_arguments)
  demo_cost_initial_const = runner.getBoolArgumentValue('demo_cost_initial_const', user_arguments)
  expected_life = runner.getIntegerArgumentValue('expected_life', user_arguments)
  om_cost = runner.getDoubleArgumentValue('om_cost', user_arguments)
  om_frequency = runner.getIntegerArgumentValue('om_frequency', user_arguments)

  # check the air_loop for reasonableness
  apply_to_all_air_loops = false
  air_loop = nil
  if object.empty?
    handle = runner.getStringArgumentValue('air_loop', user_arguments)
    if handle.empty?
      runner.registerError('No air loop was chosen.')
    else
      runner.registerError("The selected air_loop with handle '#{handle}' was not found in the model. It may have been removed by another measure.")
    end
    return false
  else
    if !object.get.to_AirLoopHVAC.empty?
      air_loop = object.get.to_AirLoopHVAC.get
    elsif !object.get.to_Building.empty?
      apply_to_all_air_loops = true
    else
      runner.registerError('Script Error - argument not showing up as air loop.')
      return false
    end
  end

  # check the user_name for reasonableness
  if eff <= 0
    runner.registerError('Please enter a positive value no greater tan 1 for burner efficiency.')
    return false
  end
  if eff > 1
    runner.registerError('Please enter a positive value no greater tan 1 for burner efficiency.')
    return false
  end
  if eff > 0.99
    runner.registerWarning("The requested burner efficiency of #{eff} seems unusually high")
  end

  # set flags to use later
  costs_requested = false

  # set values to use later
  yr0_capital_totalCosts_baseline = 0
  yr0_capital_totalCosts_proposed = 0

  # If demo_cost_initial_const is true then will be applied once in the lifecycle. Future replacements use the demo cost of the new construction.
  demo_costs_of_baseline_objects = 0

  # check costs for reasonableness
  if material_cost.abs + demolition_cost.abs + om_cost.abs == 0
    runner.registerInfo('No costs were requested for Coil Cooling DX Two Speed units.')
  else
    costs_requested = true
  end

  # check lifecycle arguments for reasonableness
  if (years_until_costs_start < 0) && (years_until_costs_start > expected_life)
    runner.registerError('Years until costs start should be a non-negative integer less than Expected Life.')
  end
  if (expected_life < 1) && (expected_life > 100)
    runner.registerError('Choose an integer greater than 0 and less than or equal to 100 for Expected Life.')
  end
  if om_frequency < 1
    runner.registerError('Choose an integer greater than 0 for O & M Frequency.')
  end

  # short def to make numbers pretty (converts 4125001.25641 to 4,125,001.26 or 4,125,001). The definition be called through this measure
  def neat_numbers(number, roundto = 2) # round to 0 or 2)
    if roundto == 2
      number = format '%.2f', number
    else
      number = number.round
    end
    # regex to add commas
    number.to_s.reverse.gsub(/([0-9]{3}(?=([0-9])))/, '\\1,').reverse
  end

  # helper that loops through lifecycle costs getting total costs under "Construction" or "Salvage" category and add to counter if occurs during year 0
  def get_total_costs_for_objects(objects)
    counter = 0
    objects.each do |object|
      object_LCCs = object.lifeCycleCosts
      object_LCCs.each do |object_LCC|
        if (object_LCC.category == 'Construction') || (object_LCC.category == 'Salvage')
          if object_LCC.yearsFromStart == 0
            counter += object_LCC.totalCost
          end
        end
      end
    end
    return counter
  end

  # get air loops for measure
  if apply_to_all_air_loops
    air_loops = model.getAirLoopHVACs
  else
    air_loops = []
    air_loops << air_loop # only run on a single space type
  end

  # get eff values
  initial_eff_values = []

  # loop through air loops
  air_loops.each do |air_loop|
    supply_components = air_loop.supplyComponents

    # find two speed dx units on loop
    supply_components.each do |supply_component|
      hVACComponent = supply_component.to_CoilHeatingGas
      if !hVACComponent.empty?
        hVACComponent = hVACComponent.get

        # change and report high speed eff
        initial_eff = hVACComponent.gasBurnerEfficiency
        initial_eff_values << initial_eff
        runner.registerInfo("Changing the burner efficiency from #{initial_eff} to #{eff} for gas heating units '#{hVACComponent.name}' on air loop '#{air_loop.name}'")
        hVACComponent.setGasBurnerEfficiency(eff)

        # get initial year 0 cost
        yr0_capital_totalCosts_baseline += get_total_costs_for_objects([hVACComponent])

        # demo value of baseline costs associated with unit
        demo_LCCs = hVACComponent.lifeCycleCosts
        demo_LCCs.each do |demo_LCC|
          if demo_LCC.category == 'Salvage'
            demo_costs_of_baseline_objects += demo_LCC.totalCost
          end
        end

        # remove all old costs to mimic replacement of component vs. an upgrade
        if !hVACComponent.lifeCycleCosts.empty? && (remove_costs == true)
          runner.registerInfo("Removing existing lifecycle cost objects associated with #{hVACComponent.name}")
          removed_costs = hVACComponent.removeLifeCycleCosts
          costs_removed = true
        end

        # add new costs
        if costs_requested == true

          # adding new cost items
          lcc_mat = OpenStudio::Model::LifeCycleCost.createLifeCycleCost("LCC_Mat - #{hVACComponent.name}", hVACComponent, material_cost, 'CostPerEach', 'Construction', expected_life, years_until_costs_start)
          # cost for if demo_initial_Construction == true is added at the end of the measure
          lcc_demo = OpenStudio::Model::LifeCycleCost.createLifeCycleCost("LCC_Demo - #{hVACComponent.name}", hVACComponent, demolition_cost, 'CostPerEach', 'Salvage', expected_life, years_until_costs_start + expected_life)
          lcc_om = OpenStudio::Model::LifeCycleCost.createLifeCycleCost("LCC_OM - #{hVACComponent.name}", hVACComponent, om_cost, 'CostPerEach', 'Maintenance', om_frequency, 0)

          # get final year 0 cost
          yr0_capital_totalCosts_proposed += get_total_costs_for_objects([hVACComponent])

        end

      end
    end
  end

  # add one time demo cost of removed object
  if demo_cost_initial_const == true
    building = model.getBuilding
    lcc_baseline_demo = OpenStudio::Model::LifeCycleCost.createLifeCycleCost('LCC_baseline_demo', building, demo_costs_of_baseline_objects, 'CostPerEach', 'Salvage', 0, years_until_costs_start).get # using 0 for repeat period since one time cost.
    runner.registerInfo("Adding one time cost of $#{neat_numbers(lcc_baseline_demo.totalCost, 0)} related to demolition of baseline objects.")

    # if demo occurs on year 0 then add to initial capital cost counter
    if lcc_baseline_demo.yearsFromStart == 0
      yr0_capital_totalCosts_proposed += lcc_baseline_demo.totalCost
    end
  end

  # reporting initial condition of model
  runner.registerInitialCondition("The starting efficiency values in affected loop(s) range from #{initial_eff_values.min} to #{initial_eff_values.max}. Initial year 0 capital costs for affected Coil Heating Gas units is $#{neat_numbers(yr0_capital_totalCosts_baseline, 0)}.")

  if initial_eff_values.empty?
    runner.registerAsNotApplicable('The affected loop(s) does not contain any Coil Heating Gas units, the model will not be altered.')
    return true
  end

  # reporting final condition of model
  runner.registerFinalCondition("#{initial_eff_values.size} Coil Heating Gas units had their Rated COP values set to #{eff}. Final year 0 capital costs for affected Coil Heating Gas units is $#{neat_numbers(yr0_capital_totalCosts_proposed, 0)}.")

  return true
end