Class: SimplifyGeometryToSlicedBar

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

Overview

start the measure

Instance Method Summary collapse

Instance Method Details

#arguments(model) ⇒ Object

define the arguments that the user will input



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/measures/SimplifyGeometryToSlicedBar/measure.rb', line 30

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

  # make choice argument for geometry size logic
  choices = OpenStudio::StringVector.new
  choices << 'Maintain Bounding Box Aspect Ratio'
  choices << 'Maintain Total Exterior Wall Area'
  choices << 'Maintain Facade Specific Exterior Wall Area' #  using 2 bar solution with adiabatic ends
  logic = OpenStudio::Measure::OSArgument.makeChoiceArgument('logic', choices, true)
  logic.setDisplayName('Maintain Total Floor Area and the following characteristic.')
  logic.setDefaultValue('Maintain Bounding Box Aspect Ratio')
  args << logic

  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



25
26
27
 
# File 'lib/measures/SimplifyGeometryToSlicedBar/measure.rb', line 25

def name
  return 'SimplifyGeometryToSlicedBar'
end

#run(model, runner, user_arguments) ⇒ Object

define what happens when the measure is run



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

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

  # get bounding box. This measure assumes ideal rotation for best bounding box is set as building rotation in source model
  boundingBox = OpenStudio::BoundingBox.new

  spaces = model.getSpaces
  spaces.each do |space|
    spaceSurfaces = space.surfaces
    spaceSurfaces.each do |spaceSurface|
      boundingBox.addPoints(space.transformation * spaceSurface.vertices)
    end
  end

  xmin = boundingBox.minX.get
  ymin = boundingBox.minY.get
  zmin = boundingBox.minZ.get
  xmax = boundingBox.maxX.get
  ymax = boundingBox.maxY.get
  zmax = boundingBox.maxZ.get

  # get total floor area for building
  building = model.getBuilding
  totalFloorArea = building.floorArea # TODO: - this doesn't include spaces tagged as not included in floor area. This would include spaces like plenums and attics
  runner.registerInfo("Initial Floor Area is #{OpenStudio.toNeatString(OpenStudio.convert(totalFloorArea, 'm^2', 'ft^2').get, 0, true)}.")
  
  # get get number of floors. Assume that user has properly used story object.
  numStories = 0
  stories = model.getBuildingStorys
  stories.each do |story|
    if !story.spaces.empty?
      numStories += 1
    end
  end
  runner.registerInfo("Initial Number of Stories is #{numStories}.")

  # warn if source model uses multiplier on zones.
  zones = model.getThermalZones
  zones.each do |zone|
    if zone.multiplier > 1
      runner.registerWarning('One or more zones have a multiplier greater than 1. This may create unexpected results.')
      break
    end
  end

  # create hash of space types used and area for each.
  spaceTypeHash = {} # spaceType object and target floor area
  totalSpaceTypeArea = 0

  # loop through space types
  spaceTypes = model.getSpaceTypes
  spaceTypes.each do |spaceType|
    next if spaceType.spaces.empty?

    result = OpenstudioStandards::Geometry.spaces_get_floor_area(spaceType.spaces)
    spaceTypeHash[spaceType] = result
    totalSpaceTypeArea += result
  end

  runner.registerInfo("Initial Space Type Total Floor Area is #{OpenStudio.toNeatString(OpenStudio.convert(totalSpaceTypeArea, 'm^2', 'ft^2').get, 0, true)}.")

  spaceTypeHash.sort_by { |key, value| value }.reverse_each do |k, v|
    runner.registerInfo("Floor Area for #{k.name} is  #{OpenStudio.toNeatString(OpenStudio.convert(v, 'm^2', 'ft^2').get, 0, true)}.")
  end

  # TODO: - warn if some spaces are not included in floor area (plenum and attic)
  # todo - warn if any hard assigned constructions are found. This measure will use default constructions, except for adiabatic surfaces
  # todo - warn if some spaces don't have space type
  # todo - warn if some spaces have extra internal loads beyond the space type
  # todo - warn if it looks like building has basement, not currently setup to look at that
  # todo - this measure wont' touch HVAC systems, consider warning user if model already has HVAC, as it won't be hooked up to anything after this.

  # get wall and window area by facade
  areaByFacade = OpenstudioStandards::Geometry.model_get_exterior_window_and_wall_area_by_orientation(model)
  northWallGross = OpenStudio.toNeatString(OpenStudio.convert(areaByFacade['north_wall'], 'm^2', 'ft^2').get, 0, true)
  southWallGross = OpenStudio.toNeatString(OpenStudio.convert(areaByFacade['south_wall'], 'm^2', 'ft^2').get, 0, true)
  eastWallGross = OpenStudio.toNeatString(OpenStudio.convert(areaByFacade['east_wall'], 'm^2', 'ft^2').get, 0, true)
  westWallGross = OpenStudio.toNeatString(OpenStudio.convert(areaByFacade['west_wall'], 'm^2', 'ft^2').get, 0, true)
  runner.registerInfo("Initial Exterior Wall Breakdown. North: #{northWallGross}, South: #{southWallGross}, East: #{eastWallGross}, West: #{westWallGross}")

  # reporting initial condition of model
  floorArea_si = OpenstudioStandards::Geometry.spaces_get_floor_area(model.getSpaces)
  floorArea_ip = OpenStudio.toNeatString(OpenStudio.convert(floorArea_si, 'm^2', 'ft^2').get, 0, true)
  exteriorArea_si = OpenstudioStandards::Geometry.spaces_get_exterior_wall_area(model.getSpaces)
  exteriorArea_ip = OpenStudio.toNeatString(OpenStudio.convert(exteriorArea_si, 'm^2', 'ft^2').get, 0, true)

  runner.registerInitialCondition("The building started with #{floorArea_ip} of floor area, and  #{exteriorArea_ip} of exterior wall area.")

  # remove all spaces, zones, and stories in the model
  spaces.each(&:remove)
  stories.each(&:remove)
  zones.each(&:remove)

  # see which path to take
  midFloorMultiplier = 1 # show as 1 even on 1 and 2 story buildings where there is no mid floor, in addition to 3 story building
  if numStories > 3
    # use floor multiplier version. Set mid floor multiplier, use adibatic floors/ceilings and set constructions, raise up building
    midFloorMultiplier = numStories - 2
  end

  # calculate bounding box area
  lengthX = xmax - xmin
  lengthY = ymax - ymin
  areaBounding = lengthX * lengthY
  lengthX_display = OpenStudio.toNeatString(OpenStudio.convert(lengthX, 'm', 'ft').get, 0, true)
  lengthY_display = OpenStudio.toNeatString(OpenStudio.convert(lengthY, 'm', 'ft').get, 0, true)
  areaBounding_display = OpenStudio.toNeatString(OpenStudio.convert(areaBounding, 'm^2', 'ft^2').get, 0, true)
  runner.registerInfo("Bounding box area is #{areaBounding_display}. #{lengthX_display} by #{lengthY_display}.")

  # get target footprint size
  case logic
  when 'Maintain Bounding Box Aspect Ratio'
    areaTarget = totalFloorArea / numStories
    areaMultiplier = areaTarget / areaBounding
    edgeMultiplier = Math.sqrt(areaMultiplier)
    lengthXTarget = lengthX * edgeMultiplier
    lengthYTarget = lengthY * edgeMultiplier

    # run def to create bar
    bar_AspectRatio = OsLib_Cofee.createBar(model, spaceTypeHash, lengthXTarget, lengthYTarget, totalFloorArea, numStories, midFloorMultiplier, xmin, ymin, lengthX, lengthY, zmin, zmax, true)

  when 'Maintain Total Exterior Wall Area'
    areaTarget = totalFloorArea / numStories
    perim = exteriorArea_si / (zmax - zmin)
    lengthYTarget = 0.25 * perim - 0.25 * Math.sqrt(perim**2 - 16 * areaTarget)
    lengthXTarget = areaTarget / lengthYTarget

    # run def to create bar
    bar_ExteriorArea = OsLib_Cofee.createBar(model, spaceTypeHash, lengthXTarget, lengthYTarget, totalFloorArea, numStories, midFloorMultiplier, xmin, ymin, lengthX, lengthY, zmin, zmax, true)

  else
    areaTarget = totalFloorArea / numStories
    lengthXTarget_Bar1 = (areaByFacade['north_wall'] + areaByFacade['south_wall']) / (2 * (zmax - zmin))
    lengthYTarget_Bar2 = (areaByFacade['east_wall'] + areaByFacade['west_wall']) / (2 * (zmax - zmin))
    lengthYTarget_Bar1 = areaTarget / (lengthXTarget_Bar1 + lengthYTarget_Bar2)
    lengthXTarget_Bar2 = lengthYTarget_Bar1

    # run def to create bar1
    bar1_FacadeSpecific = OsLib_Cofee.createBar(model, spaceTypeHash, lengthXTarget_Bar1, lengthYTarget_Bar1, totalFloorArea, numStories, midFloorMultiplier, xmin, ymin, lengthX, lengthY, zmin, zmax, false)

    # make ends of bar1 adiabatic
    bar1_FacadeSpecific.flatten.each do |space|
      space.surfaces.each do |surface|
        relativeAzimuth = OpenStudio.convert(surface.azimuth, 'rad', 'deg').get
        next if surface.outsideBoundaryCondition != 'Outdoors'
        next if surface.surfaceType != 'Wall'

        if (relativeAzimuth.round == 90) || (relativeAzimuth.round == 270)
          construction = surface.construction # TODO: - this isn't really the construction I want since it wasn't an interior one, but will work for now
          surface.setOutsideBoundaryCondition('Adiabatic')
          if !construction.empty?
            surface.setConstruction(construction.get)
          end
        end
      end
    end

    # update origin position (todo - not quite working as expected)
    xmin += lengthYTarget_Bar1 + (zmax - zmin) * 2 # gap equal two twice the height.

    # run def to create bar2 (todo - calling this twice is slower and ends up with wrong number of story objects, which will create problems in calibration)
    bar2_FacadeSpecific = OsLib_Cofee.createBar(model, spaceTypeHash, lengthYTarget_Bar2, lengthXTarget_Bar2, totalFloorArea, numStories, midFloorMultiplier, xmin, ymin, lengthX, lengthY, zmin, zmax, false)

    # update origin transformation or rotation  (todo - don't use building as transformation origin)
    bar2_FacadeSpecific.flatten.each do |space|
      space.changeTransformation(building.transformation)
      space.setDirectionofRelativeNorth(building.northAxis - 90)
    end

    # make ends of bar1 adiabatic
    bar2_FacadeSpecific.flatten.each do |space|
      space.surfaces.each do |surface|
        relativeAzimuth = OpenStudio.convert(surface.azimuth, 'rad', 'deg').get
        next if surface.outsideBoundaryCondition != 'Outdoors'
        next if surface.surfaceType != 'Wall'

        if (relativeAzimuth.round == 90) || (relativeAzimuth.round == 270)
          construction = surface.construction # TODO: - this isn't really the construction I want since it wasn't an interior one, but will work for now
          surface.setOutsideBoundaryCondition('Adiabatic')
          if !construction.empty?
            surface.setConstruction(construction.get)
          end
        end
      end
    end

  end

  areaByFacade = OpenstudioStandards::Geometry.model_get_exterior_window_and_wall_area_by_orientation(model)
  northWallGross = OpenStudio.toNeatString(OpenStudio.convert(areaByFacade['north_wall'], 'm^2', 'ft^2').get, 0, true)
  southWallGross = OpenStudio.toNeatString(OpenStudio.convert(areaByFacade['south_wall'], 'm^2', 'ft^2').get, 0, true)
  eastWallGross = OpenStudio.toNeatString(OpenStudio.convert(areaByFacade['east_wall'], 'm^2', 'ft^2').get, 0, true)
  westWallGross = OpenStudio.toNeatString(OpenStudio.convert(areaByFacade['west_wall'], 'm^2', 'ft^2').get, 0, true)
  runner.registerInfo("Final Exterior Wall Breakdown. North: #{northWallGross}, South: #{southWallGross}, East: #{eastWallGross}, West: #{westWallGross}")

  # reporting final condition of model
  floorArea_si = OpenstudioStandards::Geometry.spaces_get_floor_area(model.getSpaces)
  floorArea_ip = OpenStudio.toNeatString(OpenStudio.convert(floorArea_si, 'm^2', 'ft^2').get, 0, true)
  exteriorArea_si = OpenstudioStandards::Geometry.spaces_get_exterior_wall_area(model.getSpaces)
  exteriorArea_ip = OpenStudio.toNeatString(OpenStudio.convert(exteriorArea_si, 'm^2', 'ft^2').get, 0, true)

  runner.registerFinalCondition("The building finished with #{floorArea_ip} of floor area, and  #{exteriorArea_ip} of exterior wall area.")

  return true
end