Class: TariffSelectionFlat

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

Overview

start the measure

Instance Method Summary collapse

Instance Method Details

#arguments(workspace) ⇒ Object

define the arguments that the user will input



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

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

  # make choice argument for facade
  choices = OpenStudio::StringVector.new
  choices << 'QuarterHour'
  choices << 'HalfHour'
  choices << 'FullHour'
  # don't want to offer Day or Week even though valid E+ options
  # choices << "Day"
  # choices << "Week"
  demand_window_length = OpenStudio::Measure::OSArgument.makeChoiceArgument('demand_window_length', choices, true)
  demand_window_length.setDisplayName('Demand Window Length.')
  demand_window_length.setDefaultValue('QuarterHour')
  args << demand_window_length

  # adding argument for elec_rate
  elec_rate = OpenStudio::Measure::OSArgument.makeDoubleArgument('elec_rate', true)
  elec_rate.setDisplayName('Electric Rate')
  elec_rate.setUnits('$/kWh')
  elec_rate.setDefaultValue(0.12)
  args << elec_rate

  # adding argument for electric demand rate
  elec_demand_rate = OpenStudio::Measure::OSArgument.makeDoubleArgument('elec_demand_rate', true)
  elec_demand_rate.setDisplayName('Electric Demand Rate')
  elec_demand_rate.setUnits('$/kW')
  elec_demand_rate.setDefaultValue(12.00)
  args << elec_demand_rate

  # adding argument for electric monthly charge
  elec_monthly_rate = OpenStudio::Measure::OSArgument.makeDoubleArgument('elec_monthly_rate', true)
  elec_monthly_rate.setDisplayName('Electric Monthly Rate')
  elec_monthly_rate.setUnits('$/month')
  elec_monthly_rate.setDefaultValue(120.0)
  args << elec_monthly_rate

  # adding argument for gas_rate
  gas_rate = OpenStudio::Measure::OSArgument.makeDoubleArgument('gas_rate', true)
  gas_rate.setDisplayName('Gas Rate')
  gas_rate.setUnits('$/therm')
  gas_rate.setDefaultValue(0.5)
  args << gas_rate

  # adding argument for gas monthly rate
  gas_monthly_rate = OpenStudio::Measure::OSArgument.makeDoubleArgument('gas_monthly_rate', true)
  gas_monthly_rate.setDisplayName('Gas Montly Rate')
  gas_monthly_rate.setUnits('$/month')
  gas_monthly_rate.setDefaultValue(50)
  args << gas_monthly_rate

  # adding argument for water_rate
  water_rate = OpenStudio::Measure::OSArgument.makeDoubleArgument('water_rate', true)
  water_rate.setDisplayName('Water Rate')
  water_rate.setUnits('$/gal')
  water_rate.setDefaultValue(0.005)
  args << water_rate

  # adding argument for disthtg_rate
  disthtg_rate = OpenStudio::Measure::OSArgument.makeDoubleArgument('disthtg_rate', true)
  disthtg_rate.setDisplayName('District Heating Rate')
  disthtg_rate.setUnits('$/therm')
  disthtg_rate.setDefaultValue(0.2)
  args << disthtg_rate

  # adding argument for distclg_rate
  distclg_rate = OpenStudio::Measure::OSArgument.makeDoubleArgument('distclg_rate', true)
  distclg_rate.setDisplayName('District Cooling Rate')
  distclg_rate.setUnits('$/therm')
  distclg_rate.setDefaultValue(0.2)
  args << distclg_rate

  return args
end

#description ⇒ Object

human readable description



17
18
19
 
# File 'lib/measures/tariff_selection_flat/measure.rb', line 17

def description
  return 'This measure sets flat rates for electricity, gas, water, district heating, and district cooling.'
end

#modeler_description ⇒ Object

human readable description of modeling approach



22
23
24
 
# File 'lib/measures/tariff_selection_flat/measure.rb', line 22

def modeler_description
  return 'Will add the necessary UtilityCost objects into the model.'
end

#name ⇒ Object

human readable name



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

def name
  return 'Tariff Selection-Flat'
end

#run(workspace, runner, user_arguments) ⇒ Object

define what happens when the measure is run



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
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
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/measures/tariff_selection_flat/measure.rb', line 103

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

  # assign the user inputs to variables
  args = runner.getArgumentValues(arguments(workspace), user_arguments)
  args = Hash[args.collect{ |k, v| [k.to_s, v] }]
  
  if !args then return false end

  # reporting initial condition of model
  starting_tariffs = workspace.getObjectsByType('UtilityCost:Tariff'.to_IddObjectType)
  runner.registerInitialCondition("The model started with #{starting_tariffs.size} tariff objects.")

  # map demand window length to integer
  demand_window_per_hour = nil
  if args['demand_window_length'] == 'QuarterHour'
    demand_window_per_hour = 4
  elsif args['demand_window_length'] == 'HalfHour'
    demand_window_per_hour = 2
  elsif args['demand_window_length'] == 'FullHour'
    demand_window_per_hour = 1
  end

  # make sure demand window length is is divisible by timestep
  if !workspace.getObjectsByType('Timestep'.to_IddObjectType).empty?
    initial_timestep = workspace.getObjectsByType('Timestep'.to_IddObjectType)[0].getString(0).get

    if initial_timestep.to_f / demand_window_per_hour.to_f == (initial_timestep.to_f / demand_window_per_hour.to_f).truncate # checks if remainder of divided numbers is > 0
      runner.registerInfo("The demand window length of a #{args['demand_window_length']} is compatible with the current setting of #{initial_timestep} timesteps per hour.")
    else
      workspace.getObjectsByType('Timestep'.to_IddObjectType)[0].setString(0, demand_window_per_hour.to_s)
      runner.registerInfo("Updating the timesteps per hour in the model from #{initial_timestep} to #{demand_window_per_hour} to be compatible with the demand window length of a #{args['demand_window_length']}")
    end
  else

    # add a timestep object to the workspace
    new_object_string = "
    Timestep,
      4;                                      !- Number of Timesteps per Hour
      "
    idfObject = OpenStudio::IdfObject.load(new_object_string)
    object = idfObject.get
    wsObject = workspace.addObject(object)
    new_object = wsObject.get
    runner.registerInfo('No timestep object found. Added a new timestep object set to 4 timesteps per hour')
  end

  # elec tariff object
  if args['elec_rate'] > 0
    new_object_string = "
    UtilityCost:Tariff,
      Electricity Tariff,                     !- Name
      ElectricityPurchased:Facility,          !- Output Meter Name
      kWh,                                    !- Conversion Factor Choice
      ,                                       !- Energy Conversion Factor
      ,                                       !- Demand Conversion Factor
      ,                                       !- Time of Use Period Schedule Name
      ,                                       !- Season Schedule Name
      ,                                       !- Month Schedule Name
      Day,                                    !- Demand Window Length
      #{args['elec_monthly_rate']};                                    !- Monthly Charge or Variable Name
      "
    elec_tariff = workspace.addObject(OpenStudio::IdfObject.load(new_object_string).get).get

    # make UtilityCost:Charge:Simple objects for electricity
    new_object_string = "
    UtilityCost:Charge:Simple,
      ElectricityTariffEnergyCharge, !- Name
      Electricity Tariff,                     !- Tariff Name
      totalEnergy,                            !- Source Variable
      Annual,                                 !- Season
      EnergyCharges,                          !- Category Variable Name
      #{args['elec_rate']};          !- Cost per Unit Value or Variable Name
      "
    elec_utility_cost = workspace.addObject(OpenStudio::IdfObject.load(new_object_string).get).get

    if args['elec_demand_rate'] > 0
      new_object_string = "
      UtilityCost:Charge:Simple,
        ElectricityTariffDemandCharge,        !- Name
        Electricity Tariff,                   !- Tariff Name
        totalDemand,                          !- Source Variable
        Annual,                               !- Season
        DemandCharges,                        !- Category Variable Name
        #{args['elec_demand_rate']};          !- Cost per Unit Value or Variable Name
        "
      elec_utility_cost = workspace.addObject(OpenStudio::IdfObject.load(new_object_string).get).get
    end
  end

  # gas tariff object
  if args['gas_rate'] > 0
    new_object_string = "
    UtilityCost:Tariff,
      Gas Tariff,                             !- Name
      NaturalGas:Facility,                    !- Output Meter Name
      Therm,                                  !- Conversion Factor Choice
      ,                                       !- Energy Conversion Factor
      ,                                       !- Demand Conversion Factor
      ,                                       !- Time of Use Period Schedule Name
      ,                                       !- Season Schedule Name
      ,                                       !- Month Schedule Name
      Day,                                    !- Demand Window Length
      #{args['gas_monthly_rate']};                                    !- Monthly Charge or Variable Name
      "
    gas_tariff = workspace.addObject(OpenStudio::IdfObject.load(new_object_string).get).get

    # make UtilityCost:Charge:Simple objects for gas
    new_object_string = "
    UtilityCost:Charge:Simple,
      GasTariffEnergyCharge, !- Name
      Gas Tariff,                             !- Tariff Name
      totalEnergy,                            !- Source Variable
      Annual,                                 !- Season
      EnergyCharges,                          !- Category Variable Name
      #{args['gas_rate']};          !- Cost per Unit Value or Variable Name
      "
    gas_utility_cost = workspace.addObject(OpenStudio::IdfObject.load(new_object_string).get).get
  end

  # conversion for water tariff rate
  dollars_per_gallon = args['water_rate']
  dollars_per_meter_cubed = OpenStudio.convert(dollars_per_gallon, '1/gal', '1/m^3').get

  # water tariff object
  if args['water_rate'] > 0
    new_object_string = "
    UtilityCost:Tariff,
      Water Tariff,                             !- Name
      Water:Facility,             !- Output Meter Name
      UserDefined,                            !- Conversion Factor Choice
      1,                                       !- Energy Conversion Factor
      ,                                       !- Demand Conversion Factor
      ,                                       !- Time of Use Period Schedule Name
      ,                                       !- Season Schedule Name
      ,                                       !- Month Schedule Name
      ,                                       !- Demand Window Length
      0.0;                                    !- Monthly Charge or Variable Name
      "
    water_tariff = workspace.addObject(OpenStudio::IdfObject.load(new_object_string).get).get

    # make UtilityCost:Charge:Simple objects for water
    new_object_string = "
    UtilityCost:Charge:Simple,
      WaterTariffEnergyCharge, !- Name
      Water Tariff,                             !- Tariff Name
      totalEnergy,                             !- Source Variable
      Annual,                                 !- Season
      EnergyCharges,                          !- Category Variable Name
      #{dollars_per_meter_cubed};          !- Cost per Unit Value or Variable Name
      "
    water_utility_cost = workspace.addObject(OpenStudio::IdfObject.load(new_object_string).get).get
  end

  # disthtg tariff object
  if args['disthtg_rate'] > 0
    new_object_string = "
    UtilityCost:Tariff,
      DistrictHeating Tariff,                             !- Name
      DistrictHeating:Facility,                           !- Output Meter Name
      Therm,                                  !- Conversion Factor Choice
      ,                                       !- Energy Conversion Factor
      ,                                       !- Demand Conversion Factor
      ,                                       !- Time of Use Period Schedule Name
      ,                                       !- Season Schedule Name
      ,                                       !- Month Schedule Name
      Day,                                    !- Demand Window Length
      0.0;                                    !- Monthly Charge or Variable Name
      "
    disthtg_tariff = workspace.addObject(OpenStudio::IdfObject.load(new_object_string).get).get

    # make UtilityCost:Charge:Simple objects for disthtg
    new_object_string = "
    UtilityCost:Charge:Simple,
      DistrictHeatingTariffEnergyCharge, !- Name
      DistrictHeating Tariff,                             !- Tariff Name
      totalEnergy,                            !- Source Variable
      Annual,                                 !- Season
      EnergyCharges,                          !- Category Variable Name
      #{args['disthtg_rate']};          !- Cost per Unit Value or Variable Name
      "
    disthtg_utility_cost = workspace.addObject(OpenStudio::IdfObject.load(new_object_string).get).get
  end

  # distclg tariff object
  if args['distclg_rate'] > 0
    new_object_string = "
    UtilityCost:Tariff,
      DistrictCooling Tariff,                             !- Name
      DistrictCooling:Facility,                           !- Output Meter Name
      Therm,                                  !- Conversion Factor Choice
      ,                                       !- Energy Conversion Factor
      ,                                       !- Demand Conversion Factor
      ,                                       !- Time of Use Period Schedule Name
      ,                                       !- Season Schedule Name
      ,                                       !- Month Schedule Name
      Day,                                    !- Demand Window Length
      0.0;                                    !- Monthly Charge or Variable Name
      "
    distclg_tariff = workspace.addObject(OpenStudio::IdfObject.load(new_object_string).get).get

    # make UtilityCost:Charge:Simple objects for distclg
    new_object_string = "
    UtilityCost:Charge:Simple,
      DistrictCoolingTariffEnergyCharge, !- Name
      DistrictCooling Tariff,                             !- Tariff Name
      totalEnergy,                            !- Source Variable
      Annual,                                 !- Season
      EnergyCharges,                          !- Category Variable Name
      #{args['distclg_rate']};          !- Cost per Unit Value or Variable Name
    "
    distclg_utility_cost = workspace.addObject(OpenStudio::IdfObject.load(new_object_string).get).get
  end

  # report final condition of model
  finishing_tariffs = workspace.getObjectsByType('UtilityCost:Tariff'.to_IddObjectType)
  runner.registerFinalCondition("The model finished with #{finishing_tariffs.size} tariff objects.")

  return true
end