Class: AddCostToSupplySideHVACComponentByAirLoop

Inherits:

OpenStudio::Measure::ModelMeasure

• Object
• OpenStudio::Measure::ModelMeasure
• AddCostToSupplySideHVACComponentByAirLoop

Defined in:

lib/measures/AddCostToSupplySideHVACComponentByAirLoop/measure.rb

Overview

start the measure

Instance Method Summary

• #arguments(model) ⇒ Object

  define the arguments that the user will input.

• #description ⇒ Object

  human readable description.

• #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.

• #modeler_description ⇒ Object

  human readable description of modeling approach.

• #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 run.

Instance Method Details

#arguments(model) ⇒ Object

define the arguments that the user will input

# File 'lib/measures/AddCostToSupplySideHVACComponentByAirLoop/measure.rb', line 31

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

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

  # make an argument for the electric tariff
  hvac_comp_type_chs = OpenStudio::StringVector.new
  hvac_comp_type_chs << 'CoilCoolingDXSingleSpeed'
  hvac_comp_type_chs << 'CoilCoolingDXTwoSpeed'
  hvac_comp_type_chs << 'CoilHeatingDXSingleSpeed'
  hvac_comp_type_chs << 'CoilHeatingElectric'
  hvac_comp_type_chs << 'CoilHeatingGas'
  hvac_comp_type_chs << 'CoilHeatingWaterBaseboard'
  hvac_comp_type_chs << 'FanConstantVolume'
  hvac_comp_type_chs << 'FanOnOff'
  hvac_comp_type_chs << 'FanVariableVolume'
  hvac_comp_type_chs << 'PumpConstantSpeed'
  hvac_comp_type_chs << 'PumpVariableSpeed'
  hvac_comp_type_chs << 'CoilCoolingWater'
  hvac_comp_type_chs << 'CoilHeatingWater'
  hvac_comp_type = OpenStudio::Measure::OSArgument.makeChoiceArgument('hvac_comp_type', hvac_comp_type_chs, true)
  hvac_comp_type.setDisplayName('Select an HVAC Air Loop Supply Side Component Type')
  args << hvac_comp_type

  # putting space types and names into hash
  loop_args = model.getAirLoopHVACs
  loop_args_hash = {}
  loop_args.each do |loop_arg|
    loop_args_hash[loop_arg.name.to_s] = loop_arg
  end

  # looping through sorted hash of air loops
  loop_args_hash.sort.map do |key, value|
    show_loop = false
    components = value.demandComponents
    components.each do |component|
      if component.to_CoilCoolingDXTwoSpeed.empty?
        show_loop = true
      end
    end
    if show_loop == true
      loop_handles << value.handle.to_s
      loop_display_names << key
    end
  end

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

  # make an argument for air loops
  object = OpenStudio::Measure::OSArgument.makeChoiceArgument('object', loop_handles, loop_display_names, true)
  object.setDisplayName('Choose an Air Loop to Add Costs to')
  object.setDefaultValue('**All Air Loops**') # if no air loop is chosen this will run on all air loops
  args << object

  # make an argument to remove existing costs
  remove_costs = OpenStudio::Measure::OSArgument.makeBoolArgument('remove_costs', true)
  remove_costs.setDisplayName('Remove Existing Costs')
  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 Component')
  material_cost.setUnits('$')
  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 Component')
  demolition_cost.setUnits('$')
  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')
  years_until_costs_start.setUnits('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 air loop
  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')
  expected_life.setUnits('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 Component')
  om_cost.setUnits('$')
  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')
  om_frequency.setUnits('whole years')
  om_frequency.setDefaultValue(1)
  args << om_frequency

  return args
end

#description ⇒ Object

human readable description

# File 'lib/measures/AddCostToSupplySideHVACComponentByAirLoop/measure.rb', line 21

def description
  return "This will add cost to HVAC components of a specified type in the selected air loop(s). It can run on all air loops or a single air loop. This measures only adds cost and doesn't alter equipment performance"
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/AddCostToSupplySideHVACComponentByAirLoop/measure.rb', line 224

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

#modeler_description ⇒ Object

human readable description of modeling approach

# File 'lib/measures/AddCostToSupplySideHVACComponentByAirLoop/measure.rb', line 26

def modeler_description
  return 'Currently this measure supports the following objects: CoilCoolingDXSingleSpeed, CoilCoolingDXTwoSpeed, CoilHeatingDXSingleSpeed, CoilHeatingElectric, CoilHeatingGas, CoilHeatingWaterBaseboard, FanConstantVolume, FanOnOff, FanVariableVolume, PumpConstantSpeed, PumpVariableSpeed, CoilCoolingWater, CoilHeatingWater.'
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/AddCostToSupplySideHVACComponentByAirLoop/measure.rb', line 16

def name
  return 'Add Cost to Supply Side HVAC Component by Air Loop'
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/AddCostToSupplySideHVACComponentByAirLoop/measure.rb', line 213

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 run

# File 'lib/measures/AddCostToSupplySideHVACComponentByAirLoop/measure.rb', line 148

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
  hvac_comp_type = runner.getStringArgumentValue('hvac_comp_type', 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 loop for reasonableness
  apply_to_all_loops = false
  loop = nil
  if object.empty?
    handle = runner.getStringArgumentValue('loop', user_arguments)
    if handle.empty?
      runner.registerError('No air loop was chosen.')
    else
      runner.registerError("The selected 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?
      loop = object.get.to_AirLoopHVAC.get
    elsif !object.get.to_Building.empty?
      apply_to_all_loops = true
    else
      runner.registerError('Script Error - argument not showing up as air loop.')
      return false
    end
  end

  # set flags to use later
  costs_requested = false
  costs_removed = false

  # 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 on #{loop.name}.")
  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_loops
    loops = model.getAirLoopHVACs
  else
    loops = []
    loops << loop # only run on a single space type
  end

  # find components of requested type on requested air loop(s) and push to hVACComponents array
  hVACComponents = []
  loops.each do |loop|
    counter = hVACComponents.size
    components = loop.supplyComponents
    components.each do |component|
      if !component.to_CoilCoolingDXSingleSpeed.empty? && (hvac_comp_type == 'CoilCoolingDXSingleSpeed')
        hVACComponents << component
      elsif !component.to_CoilCoolingDXTwoSpeed.empty? && (hvac_comp_type == 'CoilCoolingDXTwoSpeed')
        hVACComponents << component
      elsif !component.to_CoilHeatingDXSingleSpeed.empty? && (hvac_comp_type == 'CoilHeatingDXSingleSpeed')
        hVACComponents << component
      elsif !component.to_CoilHeatingElectric.empty? && (hvac_comp_type == 'CoilHeatingElectric')
        hVACComponents << component
      elsif !component.to_CoilHeatingGas.empty? && (hvac_comp_type == 'CoilHeatingGas')
        hVACComponents << component
      elsif !component.to_CoilHeatingWaterBaseboard.empty? && (hvac_comp_type == 'CoilHeatingWaterBaseboard')
        hVACComponents << component
      elsif !component.to_FanConstantVolume.empty? && (hvac_comp_type == 'FanConstantVolume')
        hVACComponents << component
      elsif !component.to_FanOnOff.empty? && (hvac_comp_type == 'FanOnOff')
        hVACComponents << component
      elsif !component.to_FanVariableVolume.empty? && (hvac_comp_type == 'FanVariableVolume')
        hVACComponents << component
      elsif !component.to_PumpConstantSpeed.empty? && (hvac_comp_type == 'PumpConstantSpeed')
        hVACComponents << component
      elsif !component.to_PumpVariableSpeed.empty? && (hvac_comp_type == 'PumpVariableSpeed')
        hVACComponents << component
      elsif !component.to_CoilCoolingWater.empty? && (hvac_comp_type == 'CoilCoolingWater')
        hVACComponents << component
      elsif !component.to_CoilHeatingWater.empty? && (hvac_comp_type == 'CoilHeatingWater')
        hVACComponents << component
      end
    end

    if counter == hVACComponents.size
      runner.registerWarning("#{loop.name} doesn't have any #{hvac_comp_type} components.")
    end
  end

  # get initial year 0 cost
  yr0_capital_totalCosts = get_total_costs_for_objects(hVACComponents)

  # reporting initial condition of model
  runner.registerInitialCondition("There are #{hVACComponents.size} #{hvac_comp_type} objects in the selected air loops. Capital costs for these components is $#{neat_numbers(yr0_capital_totalCosts, 0)}.")

  # loop through hVACComponents to add life cycle costs
  hVACComponents.each do |hVACComponent|
    # remove any component cost line items associated with the hVACComponent
    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 lifeCycleCost objects if there is a non-zero value in one of the cost arguments
    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)
      if demo_cost_initial_const
        lcc_demo = OpenStudio::Model::LifeCycleCost.createLifeCycleCost("LCC_Demo - #{hVACComponent.name}", hVACComponent, demolition_cost, 'CostPerEach', 'Salvage', expected_life, years_until_costs_start)
      else
        lcc_demo = OpenStudio::Model::LifeCycleCost.createLifeCycleCost("LCC_Demo - #{hVACComponent.name}", hVACComponent, demolition_cost, 'CostPerEach', 'Salvage', expected_life, years_until_costs_start + expected_life)
      end
      lcc_om = OpenStudio::Model::LifeCycleCost.createLifeCycleCost("LCC_OM - #{hVACComponent.name}", hVACComponent, om_cost, 'CostPerEach', 'Maintenance', om_frequency, 0)

    end
  end

  # show as not applicable if no cost requested and if no costs removed
  if (costs_requested == false) && (costs_removed == false)
    runner.registerAsNotApplicable('No new lifecycle costs objects were requested, and no costs were deleted.')
  end

  # get final year 0 cost
  yr0_capital_totalCosts = get_total_costs_for_objects(hVACComponents)

  # reporting final condition of model
  if !hVACComponents.empty?
    runner.registerFinalCondition("There are #{hVACComponents.size} #{hvac_comp_type} objects in the selected air loops. Capital costs for these components is $#{neat_numbers(yr0_capital_totalCosts, 0)}.")
  else
    runner.registerAsNotApplicable("There are no #{hvac_comp_type} objects in the selected air loops.")
  end

  return true
end