Class: ImproveMotorEfficiency

Inherits:
OpenStudio::Measure::ModelMeasure
  • Object
show all
Defined in:
lib/measures/ImproveMotorEfficiency/measure.rb

Overview

start the measure

Instance Method Summary collapse

Instance Method Details

#arguments(model) ⇒ Object

define the arguments that the user will input



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/measures/ImproveMotorEfficiency/measure.rb', line 17

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

  # putting loops and names into hash
  loop_args = model.getLoops
  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.supplyComponents
    components.each do |component|
      show_loop = true unless component.to_FanConstantVolume.empty?
      show_loop = true unless component.to_FanVariableVolume.empty?
      show_loop = true unless component.to_FanOnOff.empty?
      show_loop = true unless component.to_PumpConstantSpeed.empty?
      show_loop = true unless component.to_PumpVariableSpeed.empty?
    end

    # if loop as object of correct type then add to hash.
    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 Plant and Air Loops*'

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

  # make an argument to add new space true/false
  motor_eff = OpenStudio::Measure::OSArgument.makeDoubleArgument('motor_eff', true)
  motor_eff.setDisplayName('Set Motor Efficiency(%).')
  motor_eff.setDefaultValue(96.0)
  args << motor_eff

  # bool argument to remove existing costs
  remove_costs = OpenStudio::Measure::OSArgument.makeBoolArgument('remove_costs', true)
  remove_costs.setDisplayName('Remove Baseline Costs From Effected Fans and Pumps?')
  remove_costs.setDefaultValue(false)
  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 Motor ($).')
  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 Motor ($).')
  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 Motor ($).')
  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

  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



201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/measures/ImproveMotorEfficiency/measure.rb', line 201

def get_total_costs_for_objects(objects)
  counter = 0
  objects.each do |object|
    object_LCCs = object.lifeCycleCosts
    object_LCCs.each do |object_LCC|
      next unless (object_LCC.category == 'Construction') || (object_LCC.category == 'Salvage')

      counter += object_LCC.totalCost if object_LCC.yearsFromStart == 0
    end
  end
  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



12
13
14
 
# File 'lib/measures/ImproveMotorEfficiency/measure.rb', line 12

def name
  'Improve Motor Efficiency in Selected Fans and Pumps'
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



190
191
192
193
194
195
196
197
198
 
# File 'lib/measures/ImproveMotorEfficiency/measure.rb', line 190

def neat_numbers(number, roundto = 2) # round to 0 or 2)
  number = if roundto == 2
             format '%.2f', number
           else
             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 cop



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/measures/ImproveMotorEfficiency/measure.rb', line 119

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

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

  # assign the user inputs to variables
  object = runner.getOptionalWorkspaceObjectChoiceValue('object', user_arguments, model) # model is passed in because of argument type
  motor_eff = runner.getDoubleArgumentValue('motor_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 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 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
  elsif !object.get.to_Loop.empty?
    loop = object.get.to_Loop.get
  elsif !object.get.to_Building.empty?
    apply_to_all_loops = true
  else
    runner.registerError('Script Error - argument not showing up as loop.')
    return false
  end

  # check the user_name for reasonableness
  if (motor_eff <= 0) || (motor_eff >= 100)
    runner.registerError('Please enter a number between 0 and 100 for motor efficiency percentage.')
    return false
  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 motors improvements.')
  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
  runner.registerError('Choose an integer greater than 0 for O & M Frequency.') if om_frequency < 1

  # 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)
    number = if roundto == 2
               format '%.2f', number
             else
               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|
        next unless (object_LCC.category == 'Construction') || (object_LCC.category == 'Salvage')

        counter += object_LCC.totalCost if object_LCC.yearsFromStart == 0
      end
    end
    counter
  end

  # get loops for measure
  if apply_to_all_loops
    loops = model.getLoops
  else
    loops = []
    loops << loop # only run on a single space type
  end

  # get cop values
  initial_motor_efficiency_values = []
  missing_initial_motor_efficiency = 0

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

    # find fans and pumps on loop
    supply_components.each do |supply_component|
      hVACComponent = supply_component.to_FanConstantVolume
      hVACComponent = supply_component.to_FanVariableVolume if hVACComponent.empty?
      hVACComponent = supply_component.to_FanOnOff if hVACComponent.empty?
      hVACComponent = supply_component.to_PumpConstantSpeed if hVACComponent.empty?
      hVACComponent = supply_component.to_PumpVariableSpeed if hVACComponent.empty?

      # alter components of correct type
      next if hVACComponent.empty?

      hVACComponent = hVACComponent.get

      # change and report changes to fans and motors
      initial_motor_efficiency = hVACComponent.motorEfficiency
      runner.registerInfo("Changing the motor efficiency from #{initial_motor_efficiency * 100}% to #{motor_eff}% for '#{hVACComponent.name}' onloop '#{loop.name}.'")
      initial_motor_efficiency_values << initial_motor_efficiency
      hVACComponent.setMotorEfficiency(motor_eff * 0.01)

      # 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|
        demo_costs_of_baseline_objects += demo_LCC.totalCost if demo_LCC.category == 'Salvage'
      end

      # remove all old costs
      if !hVACComponent.lifeCycleCosts.empty? && (remove_costs == true)
        runner.registerInfo("Removing existing lifecycle cost objects associated with #{hVACComponent.name}")
        removed_costs = hVACComponent.removeLifeCycleCosts
      end

      # add new costs
      next unless 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

  # add one time demo cost of removed windows if appropriate
  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
    yr0_capital_totalCosts_proposed += lcc_baseline_demo.totalCost if lcc_baseline_demo.yearsFromStart == 0
  end

  if initial_motor_efficiency_values.size + missing_initial_motor_efficiency == 0
    runner.registerAsNotApplicable('The affected loop(s) does not contain any fans or pumps, the model will not be altered.')
    return true
  end

  # reporting initial condition of model
  runner.registerInitialCondition("The starting motor efficiency values in affected loop(s) range from #{initial_motor_efficiency_values.min * 100}% to #{initial_motor_efficiency_values.max * 100}%. Initial year 0 capital costs for affected fans or pumps is $#{neat_numbers(
    yr0_capital_totalCosts_baseline, 0
  )}.")

  # reporting final condition of model
  runner.registerFinalCondition("#{initial_motor_efficiency_values.size + missing_initial_motor_efficiency} fans or pumps had motor efficiency values set to #{motor_eff}%. Final year 0 capital costs for affected fans and pumps is $#{neat_numbers(
    yr0_capital_totalCosts_proposed, 0
  )}.")

  true
end