Class: FansMultiplier

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

Overview

start the measure

Instance Method Summary collapse

Instance Method Details

#arguments(model) ⇒ Object

define the arguments that the user will input



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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/measures/FansMultiplier/measure.rb', line 48

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 air loops 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.supplyComponents
    components.each do |component|
      unless component.to_FanConstantVolume.empty?
        show_loop = true
        loop_handles << component.handle.to_s
        loop_display_names << component.name.to_s
      end
      unless component.to_FanVariableVolume.empty?
        show_loop = true
        loop_handles << component.handle.to_s
        loop_display_names << component.name.to_s
      end
      next if component.to_FanOnOff.empty?

      show_loop = true
      loop_handles << component.handle.to_s
      loop_display_names << component.name.to_s
    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 space type
  building = model.getBuilding
  loop_handles << building.handle.to_s
  loop_display_names << '*All Fans*'
  loop_handles << '0'
  loop_display_names << '*None*'

  # make a choice argument for space type
  fan_arg = OpenStudio::Measure::OSArgument.makeChoiceArgument('fan', loop_handles, loop_display_names)
  fan_arg.setDisplayName('Apply the Measure to a SINGLE Fan, ALL the Fans or NONE.')
  fan_arg.setDefaultValue('*All Fans*') # if no space type is chosen this will run on the entire building
  args << fan_arg

  # Maximum FlowRate multiplier
  max_flowrate_multiplier = OpenStudio::Measure::OSArgument.makeDoubleArgument('max_flowrate_multiplier', true)
  max_flowrate_multiplier.setDisplayName('Multiplier for Maximum FlowRate.')
  max_flowrate_multiplier.setDescription('Multiplier for Maximum FlowRate.')
  max_flowrate_multiplier.setDefaultValue(1.0)
  max_flowrate_multiplier.setMinValue(0.0)
  args << max_flowrate_multiplier

  # fan_efficiency_multiplier
  fan_efficiency_multiplier = OpenStudio::Measure::OSArgument.makeDoubleArgument('fan_efficiency_multiplier', true)
  fan_efficiency_multiplier.setDisplayName('Multiplier for Fan Efficiency.')
  fan_efficiency_multiplier.setDescription('Multiplier for Fan Efficiency.')
  fan_efficiency_multiplier.setDefaultValue(1.0)
  args << fan_efficiency_multiplier

  # pressure_rise_multiplier
  pressure_rise_multiplier = OpenStudio::Measure::OSArgument.makeDoubleArgument('pressure_rise_multiplier', true)
  pressure_rise_multiplier.setDisplayName('Multiplier for Pressure Rise.')
  pressure_rise_multiplier.setDescription('Multiplier for Pressure Rise.')
  pressure_rise_multiplier.setDefaultValue(1.0)
  args << pressure_rise_multiplier

  # motor_efficiency_multiplier
  motor_efficiency_multiplier = OpenStudio::Measure::OSArgument.makeDoubleArgument('motor_efficiency_multiplier', true)
  motor_efficiency_multiplier.setDisplayName('Multiplier for Motor Efficiency.')
  motor_efficiency_multiplier.setDescription('Multiplier for Motor Efficiency.')
  motor_efficiency_multiplier.setDefaultValue(1.0)
  args << motor_efficiency_multiplier

  args
end

#change_name(object, max_flowrate_multiplier, fan_efficiency_multiplier, pressure_rise_multiplier, motor_efficiency_multiplier) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/measures/FansMultiplier/measure.rb', line 23

def change_name(object, max_flowrate_multiplier, fan_efficiency_multiplier, pressure_rise_multiplier, motor_efficiency_multiplier)
  nameString = object.name.get.to_s
  if max_flowrate_multiplier != 1.0
    nameString += " #{max_flowrate_multiplier.round(2)}x flow"
  end
  if pressure_rise_multiplier != 1.0
    nameString += " #{pressure_rise_multiplier.round(2)}x press"
  end
  if fan_efficiency_multiplier != 1.0
    nameString += " #{fan_efficiency_multiplier.round(2)}x fanEff"
  end
  if motor_efficiency_multiplier != 1.0
    nameString += " #{motor_efficiency_multiplier.round(2)}x motorEff"
  end
  object.setName(nameString)
end

#check_multiplier(runner, multiplier) ⇒ Object 



40
41
42
43
44
45
 
# File 'lib/measures/FansMultiplier/measure.rb', line 40

def check_multiplier(runner, multiplier)
  if multiplier < 0
    runner.registerError("Multiplier #{multiplier} cannot be negative.")
    false
  end
end

#description ⇒ Object

human readable description



14
15
16
 
# File 'lib/measures/FansMultiplier/measure.rb', line 14

def description
  'This is a general purpose measure to calibrate Fans with a Multiplier.'
end

#modeler_description ⇒ Object

human readable description of modeling approach



19
20
21
 
# File 'lib/measures/FansMultiplier/measure.rb', line 19

def modeler_description
  'It will be used for calibration maximum flow rate, efficiency, pressure rise and motor efficiency. User can choose between a SINGLE Fan or ALL the Fans.'
end

#name ⇒ Object

human readable name



9
10
11
 
# File 'lib/measures/FansMultiplier/measure.rb', line 9

def name
  'Fans Multiplier'
end

#run(model, runner, user_arguments) ⇒ Object

define what happens when the measure is run



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
 
# File 'lib/measures/FansMultiplier/measure.rb', line 137

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

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

  # assign the user inputs to variables
  fan_object = runner.getOptionalWorkspaceObjectChoiceValue('fan', user_arguments, model)
  fan_handle = runner.getStringArgumentValue('fan', user_arguments)
  pressure_rise_multiplier = runner.getDoubleArgumentValue('pressure_rise_multiplier', user_arguments)
  check_multiplier(runner, pressure_rise_multiplier)
  motor_efficiency_multiplier = runner.getDoubleArgumentValue('motor_efficiency_multiplier', user_arguments)
  check_multiplier(runner, motor_efficiency_multiplier)
  max_flowrate_multiplier = runner.getDoubleArgumentValue('max_flowrate_multiplier', user_arguments)
  check_multiplier(runner, max_flowrate_multiplier)
  fan_efficiency_multiplier = runner.getDoubleArgumentValue('fan_efficiency_multiplier', user_arguments)
  check_multiplier(runner, fan_efficiency_multiplier)

  # find objects to change
  fans = []
  building = model.getBuilding
  building_handle = building.handle.to_s
  runner.registerInfo("fan_handle: #{fan_handle}")
  # setup fans
  if fan_handle == building_handle
    # Use ALL Fans
    runner.registerInfo('Applying change to ALL Fans')
    loops = model.getAirLoopHVACs
    # loop through air loops
    loops.each do |loop|
      supply_components = loop.supplyComponents
      # find fans on loops
      supply_components.each do |supply_component|
        if !supply_component.to_FanConstantVolume.empty?
          fans << supply_component.to_FanConstantVolume.get
        elsif !supply_component.to_FanVariableVolume.empty?
          fans << supply_component.to_FanVariableVolume.get
        elsif !supply_component.to_FanOnOff.empty?
          fans << supply_component.to_FanOnOff.get
        end
      end
    end
  elsif fan_handle == 0.to_s
    # Fans set to NONE so do nothing
    runner.registerInfo('Applying change to NONE Fans')
  elsif !fan_handle.empty?
    # Single Fan handle found, check if object is good
    if !fan_object.get.to_FanConstantVolume.empty?
      runner.registerInfo("Applying change to #{fan_object.get.name} Fan")
      fans << fan_object.get.to_FanConstantVolume.get
    elsif !fan_object.get.to_FanVariableVolume.empty?
      runner.registerInfo("Applying change to #{fan_object.get.name} Fan")
      fans << fan_object.get.to_FanVariableVolume.get
    elsif !fan_object.get.to_FanOnOff.empty?
      runner.registerInfo("Applying change to #{fan_object.get.name} Fan")
      fans << fan_object.get.to_FanOnOff.get
    else
      runner.registerError("Fan with handle #{fan_handle} could not be found.")
    end
  else
    runner.registerError('Fan handle is empty.')
    return false
  end

  # report initial condition of model
  runner.registerInitialCondition("Fans to change: #{fans.size}")
  runner.registerInfo("Fans to change: #{fans.size}")
  altered_fans = []
  altered_maxflow = []
  altered_pressurerise = []
  altered_fanefficiency = []
  altered_motorefficiency = []
  # loop through fans
  fans.each do |fan|
    altered_fan = false
    # modify max flowrate
    if max_flowrate_multiplier != 1.0 && fan.maximumFlowRate.is_initialized
      runner.registerInfo("Applying #{max_flowrate_multiplier}x multiplier to #{fan.name.get}.")
      fan.setMaximumFlowRate(fan.maximumFlowRate * max_flowrate_multiplier)
      altered_maxflow << fan.handle.to_s
      altered_fan = true
    end

    # modify fan_efficiency_multiplier
    if fan_efficiency_multiplier != 1.0
      runner.registerInfo("Applying #{fan_efficiency_multiplier}x multiplier to #{fan.name.get}.")
      fan.setFanEfficiency(fan.fanEfficiency * fan_efficiency_multiplier)
      altered_fanefficiency << fan.handle.to_s
      altered_fan = true
    end

    # pressure_rise_multiplier
    if pressure_rise_multiplier != 1.0
      runner.registerInfo("Applying #{pressure_rise_multiplier}x multiplier to #{fan.name.get}.")
      fan.setPressureRise(fan.pressureRise * pressure_rise_multiplier)
      altered_pressurerise << fan.handle.to_s
      altered_fan = true
    end

    # motor_efficiency_multiplier
    if motor_efficiency_multiplier != 1.0
      runner.registerInfo("Applying #{motor_efficiency_multiplier}x multiplier to #{fan.name.get}.")
      fan.setMotorEfficiency(fan.motorEfficiency * motor_efficiency_multiplier)
      altered_motorefficiency << fan.handle.to_s
      altered_fan = true
    end

    next unless altered_fan

    altered_fans << fan.handle.to_s
    change_name(fan, max_flowrate_multiplier, fan_efficiency_multiplier, pressure_rise_multiplier, motor_efficiency_multiplier)
    runner.registerInfo("Fan name changed to: #{fan.name.get}")
  end

  # na if nothing in model to look at
  if altered_fans.empty?
    runner.registerAsNotApplicable('No Fans were altered in the model')
    return true
  end

  # report final condition of model
  runner.registerFinalCondition("#{altered_fans.size} fans objects were altered.")

  true
end