Class: AedgK12ElectricEquipmentControls

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

Overview

start the measure

Instance Method Summary collapse

Instance Method Details

#arguments(model) ⇒ Object

define the arguments that the user will input



33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/measures/AedgK12ElectricEquipmentControls/measure.rb', line 33

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

  # make an argument for material and installation cost
  costTotal = OpenStudio::Measure::OSArgument.makeDoubleArgument('costTotal', true)
  costTotal.setDisplayName('Total cost for all Equipment Controls in the Building ($).')
  costTotal.setDefaultValue(0.0)
  args << costTotal

  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



28
29
30
 
# File 'lib/measures/AedgK12ElectricEquipmentControls/measure.rb', line 28

def name
  return 'AedgK12ElectricEquipmentControls'
end

#run(model, runner, user_arguments) ⇒ Object

define what happens when the measure is run



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

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
  costTotal = runner.getDoubleArgumentValue('costTotal', user_arguments)

  non_neg_args = ['costTotal']
  non_neg = OsLib_HelperMethods.checkDoubleAndIntegerArguments(runner, user_arguments, 'min' => 0.0, 'max' => nil, 'min_eq_bool' => true, 'max_eq_bool' => false, 'arg_array' => non_neg_args)
  if !non_neg then return false end

  # create not applicable flag if building doesn't have any equipments.
  if model.getBuilding.electricEquipmentPower == 0
    runner.registerAsNotApplicable('The model does not appear to have electric equipment, the model will not be altered.')
    return true
  end

  # get the initial range of equipment schedule values in the building for initial condition
  electricEquipmentHash = {} # key = existSch, value = newSch
  affectedSpaceTypeArray = []

  existMin = []
  existMax = []
  newMin = []
  newMax = []

  # make array of space and space types to loop through
  spacesAndSpaceTypes = []
  model.getSpaceTypes.each do |spaceType|
    if !spaceType.spaces.empty?
      standardsInfo = OsLib_HelperMethods.getSpaceTypeStandardsInformation([spaceType])
      if standardsInfo[spaceType][1] == 'Kitchen'
        runner.registerInfo("Kitchen equipment is handled in its own measure, so #{spaceType.name} schedules won't be edited by this measure.")
        next
      end
      spacesAndSpaceTypes << spaceType
      affectedSpaceTypeArray << spaceType
    end
  end

  # TODO: - removing code to alter space equipment schedules. All that should be left are elevators and un-recongnized space types
  #     model.getSpaces.each do |space|
  #       next if space.spaceType.empty?
  #       spaceType = space.spaceType.get
  #       standardsInfo = OsLib_HelperMethods.getSpaceTypeStandardsInformation([spaceType])
  #       next if standardsInfo[1] == "Kitchen"
  #       spacesAndSpaceTypes << space
  #     end

  # loop through used space types and spaces
  spacesAndSpaceTypes.each do |object|
    # only alter space types that are used
    if !object.to_SpaceType.empty?
      next if object.to_SpaceType.get.spaces.size <= 0
    end

    electricEquipment = object.electricEquipment
    electricEquipment.each do |equipment|
      # get schedule
      if !equipment.schedule.empty?
        existSch = equipment.schedule.get

        # next if space type is kitchen. This should be taken care of in kitchen measure

        # can't process if not ruleset
        if existSch.to_ScheduleRuleset.empty?
          runner.registerWarning("#{existSch.name} isn't a ruleset schedule. It can't be altered by this measure.")
          next
        end

        # update schedule
        if electricEquipmentHash.key?(existSch)
          # connect equipment to new schedule
          equipment.setSchedule(electricEquipmentHash[existSch])
        else

          # make new schedule
          newSchedule = existSch.clone(model).to_ScheduleRuleset.get
          newSchedule.setName("#{existSch.name} - Controls Reduction")

          # connect to electricEquipment
          equipment.setSchedule(newSchedule)

          # edit schedule
          # valueTestDouble was .05 but changed to 0.51 since ran across some schedules that hit this for unoccupied times
          valueTestDouble = 0.51 # if the profile value is lower than this value then uses passDouble for value adjustment, otherwise it uses failDouble as value adjustment
          passDouble = -0.25
          failDouble = 0.0 # no decrease during operating hours
          floorDouble = 0.1 # values below this level will be left alone, and adjusted values will not be lowered beyond this.
          modificationType = 'Sum' # double will be added to current value (in this case passing a negative value to lower it)
          OsLib_Schedules.conditionalScheduleValueAdjust(model, newSchedule, valueTestDouble, passDouble, failDouble, floorDouble, modificationType)

          # add info to hash
          electricEquipmentHash[existSch] = newSchedule

          # get sch values from new and old schedules to use in initial and final condition
          existMinMax = OsLib_Schedules.getMinMaxAnnualProfileValue(model, existSch.to_ScheduleRuleset.get)
          existMin <<  existMinMax['min']
          existMax <<  existMinMax['max']
          newMinMax = OsLib_Schedules.getMinMaxAnnualProfileValue(model, newSchedule)
          newMin <<  newMinMax['min']
          newMax <<  newMinMax['max']
        end

      else
        runner.registerWarning("Can't find schedule for #{equipment.name} in #{object.name}. Won't attempt to create schedule for it.")
      end
    end
  end

  affectedSpaceTypeArray.each do |spaceType|
    runner.registerInfo("Adjusting equipment schedules for #{spaceType.name}.")
  end

  # reporting initial condition of model
  runner.registerInitialCondition("Fractional schedule values for equipment in the initial model excluding kitchens range from #{OpenStudio.toNeatString(existMin.min, 2, true)} to #{OpenStudio.toNeatString(existMax.max, 2, true)}.")

  # get building to add cost to
  building = model.getBuilding

  # global variables for costs
  expected_life = 25
  years_until_costs_start = 0

  # add cost to building
  if costTotal > 0
    lcc_mat = OpenStudio::Model::LifeCycleCost.createLifeCycleCost('Equipment Controls', building, costTotal, 'CostPerEach', 'Construction', expected_life, years_until_costs_start)
    lcc_mat_TotalCost = lcc_mat.get.totalCost
  else
    lcc_mat_TotalCost = 0
  end

  # populate AEDG tip keys
  aedgTips = ['PL02', 'PL03', 'PL04']

  # populate how to tip messages
  aedgTipsLong = OsLib_AedgMeasures.getLongHowToTips('K12', aedgTips.uniq.sort, runner)
  if !aedgTipsLong
    return false # this should only happen if measure writer passes bad values to getLongHowToTips
  end

  # reporting final condition of model
  if lcc_mat_TotalCost > 0
    runner.registerFinalCondition("Fractional schedule values for electric equipment in the final model excluding kitchens range from #{OpenStudio.toNeatString(newMin.min, 2, true)} to #{OpenStudio.toNeatString(newMax.max, 2, true)}. The cost for these control improvements is $#{OpenStudio.toNeatString(lcc_mat_TotalCost, 2, true)}. #{aedgTipsLong}")
  else
    runner.registerFinalCondition("Fractional schedule values for electric equipment in the final model excluding kitchens range from #{OpenStudio.toNeatString(newMin.min, 2, true)} to #{OpenStudio.toNeatString(newMax.max, 2, true)}. #{aedgTipsLong}")
  end

  return true
end