Class: ReplaceThermostatSchedules

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

Overview

start the measure

Instance Method Summary collapse

Instance Method Details

#arguments(model) ⇒ Object

define the arguments that the user will input



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

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

  # populate choice argument for thermal zones in the model
  zone_handles = OpenStudio::StringVector.new
  zone_display_names = OpenStudio::StringVector.new

  # putting zone names into hash
  zone_hash = {}
  model.getThermalZones.each do |zone|
    zone_hash[zone.name.to_s] = zone
  end

  # looping through sorted hash of zones
  zone_hash.sort.map do |zone_name, zone|
    if zone.thermostatSetpointDualSetpoint.is_initialized
      zone_handles << zone.handle.to_s
      zone_display_names << zone_name
    end
  end

  # add building to string vector with zones
  building = model.getBuilding
  zone_handles << building.handle.to_s
  zone_display_names << '*All Thermal Zones*'

  # make an argument for zones
  zones = OpenStudio::Measure::OSArgument.makeChoiceArgument('zones', zone_handles, zone_display_names, true)
  zones.setDisplayName('Choose Thermal Zones to change thermostat schedules on.')
  zones.setDefaultValue('*All Thermal Zones*') # if no zone is chosen this will run on all zones
  args << zones

  # populate choice argument for schedules in the model
  sch_handles = OpenStudio::StringVector.new
  sch_display_names = OpenStudio::StringVector.new

  # putting schedule names into hash
  sch_hash = {}
  model.getSchedules.each do |sch|
    sch_hash[sch.name.to_s] = sch
  end

  # looping through sorted hash of schedules
  sch_hash.sort.map do |sch_name, sch|
    if !sch.scheduleTypeLimits.empty?
      unitType = sch.scheduleTypeLimits.get.unitType
      # puts "#{sch.name}, #{unitType}"
      if unitType == 'Temperature'
        sch_handles << sch.handle.to_s
        sch_display_names << sch_name
      end
    end
  end

  # add empty handle to string vector with schedules
  sch_handles << OpenStudio.toUUID('').to_s
  sch_display_names << '*No Change*'

  # make an argument for cooling schedule
  cooling_sch = OpenStudio::Measure::OSArgument.makeChoiceArgument('cooling_sch', sch_handles, sch_display_names, true)
  cooling_sch.setDisplayName('Choose Cooling Schedule.')
  cooling_sch.setDefaultValue('*No Change*') # if no change is chosen then cooling schedules will not be changed
  args << cooling_sch

  # make an argument for heating schedule
  heating_sch = OpenStudio::Measure::OSArgument.makeChoiceArgument('heating_sch', sch_handles, sch_display_names, true)
  heating_sch.setDisplayName('Choose Heating Schedule.')
  heating_sch.setDefaultValue('*No Change*') # if no change is chosen then heating schedules will not be changed
  args << heating_sch

  # 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 Thermal Zone ($/thermal zone).')
  material_cost.setDefaultValue(0.0)
  args << material_cost

  return args
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



13
14
15
 
# File 'lib/measures/ReplaceThermostatSchedules/measure.rb', line 13

def name
  return 'Replace Thermostat Schedules'
end

#run(model, runner, user_arguments) ⇒ Object

define what happens when the measure is run



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

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
  zones = runner.getOptionalWorkspaceObjectChoiceValue('zones', user_arguments, model) # model is passed in because of argument type
  cooling_sch = runner.getOptionalWorkspaceObjectChoiceValue('cooling_sch', user_arguments, model) # model is passed in because of argument type
  heating_sch = runner.getOptionalWorkspaceObjectChoiceValue('heating_sch', user_arguments, model) # model is passed in because of argument type
  material_cost = runner.getDoubleArgumentValue('material_cost', user_arguments)

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

  # depending on user input, add selected zones to an array
  selected_zones = []
  if apply_to_all_zones == true
    selected_zones = model.getThermalZones
  else
    selected_zones << selected_zone
  end

  # check the cooling_sch for reasonableness
  if cooling_sch.empty?
    handle = runner.getStringArgumentValue('cooling_sch', user_arguments)
    if handle == OpenStudio.toUUID('').to_s
      # no change
      cooling_sch = nil
    else
      runner.registerError("The selected schedule with handle '#{handle}' was not found in the model. It may have been removed by another measure.")
      return false
    end
  else
    if !cooling_sch.get.to_Schedule.empty?
      cooling_sch = cooling_sch.get.to_Schedule.get
    else
      runner.registerError('Script Error - argument not showing up as schedule.')
      return false
    end
  end

  # check the heating_sch for reasonableness
  if heating_sch.empty?
    handle = runner.getStringArgumentValue('heating_sch', user_arguments)
    if handle == OpenStudio.toUUID('').to_s
      # no change
      heating_sch = nil
    else
      runner.registerError("The selected schedule with handle '#{handle}' was not found in the model. It may have been removed by another measure.")
      return false
    end
  else
    if !heating_sch.get.to_Schedule.empty?
      heating_sch = heating_sch.get.to_Schedule.get
    else
      runner.registerError('Script Error - argument not showing up as schedule.')
      return false
    end
  end

  number_zones_modified = 0
  total_cost = 0
  if heating_sch || cooling_sch

    selected_zones.each do |zone|
      thermostatSetpointDualSetpoint = zone.thermostatSetpointDualSetpoint
      if thermostatSetpointDualSetpoint.empty?
        runner.registerWarning("Cannot find existing thermostat for thermal zone '#{zone.name}', skipping.")
        next
      end
      thermostatSetpointDualSetpoint = thermostatSetpointDualSetpoint.get

      # make sure this thermostat is unique to this zone
      if thermostatSetpointDualSetpoint.getSources('OS_ThermalZone'.to_IddObjectType).size > 1
        # if not create a new copy
        runner.registerInfo("Copying thermostat for thermal zone '#{zone.name}'.")

        oldThermostat = thermostatSetpointDualSetpoint
        thermostatSetpointDualSetpoint = OpenStudio::Model::ThermostatSetpointDualSetpoint.new(model)
        if !oldThermostat.heatingSetpointTemperatureSchedule.empty?
          thermostatSetpointDualSetpoint.setHeatingSetpointTemperatureSchedule(oldThermostat.heatingSetpointTemperatureSchedule.get)
        end
        if !oldThermostat.coolingSetpointTemperatureSchedule.empty?
          thermostatSetpointDualSetpoint.setCoolingSetpointTemperatureSchedule(oldThermostat.coolingSetpointTemperatureSchedule.get)
        end
        zone.setThermostatSetpointDualSetpoint(thermostatSetpointDualSetpoint)
      end

      if heating_sch
        if !thermostatSetpointDualSetpoint.setHeatingSetpointTemperatureSchedule(heating_sch)
          runner.registerError("Script Error - cannot set heating schedule for thermal zone '#{zone.name}'.")
          return false
        end
      end

      if cooling_sch
        if !thermostatSetpointDualSetpoint.setCoolingSetpointTemperatureSchedule(cooling_sch)
          runner.registerError("Script Error - cannot set cooling schedule for thermal zone '#{zone.name}'.")
          return false
        end
      end

      if material_cost.abs != 0
        total_cost += material_cost
        OpenStudio::Model::LifeCycleCost.createLifeCycleCost("LCC_Mat - #{zone.name} Thermostats", zone, material_cost, 'CostPerEach', 'Construction')
      end

      number_zones_modified += 1
    end
  end

  runner.registerFinalCondition("Replaced thermostats for #{number_zones_modified} thermal zones, capital cost #{total_cost}")

  if number_zones_modified == 0
    runner.registerAsNotApplicable('No thermostats altered')
  end

  return true
end