Class: OpenStudio::Model::BuildingStory

Inherits:
Object
  • Object
show all
Defined in:
lib/openstudio-standards/standards/Standards.BuildingStory.rb

Overview

open the class to add methods to apply HVAC efficiency standards

Instance Method Summary collapse

Instance Method Details

#floor_multiplier ⇒ Integer

Checks all spaces on this story that are part of the total floor area to see if they have the same multiplier. If they do, assume that the multipliers are being used as a floor multiplier.

returning 1 if no floor multiplier.

Returns:

  • (Integer) —

    return the floor multiplier for this story,



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/openstudio-standards/standards/Standards.BuildingStory.rb', line 11

def floor_multiplier
  floor_multiplier = 1

  # Determine the multipliers for all spaces
  multipliers = []
  spaces.each do |space|
    # Ignore spaces that aren't part of the total floor area
    next unless space.partofTotalFloorArea
    multipliers << space.multiplier
  end

  # If there are no spaces on this story, assume
  # a multiplier of 1
  if multipliers.size.zero?
    return floor_multiplier
  end

  # Calculate the average multiplier and
  # then convert to integer.
  avg_multiplier = (multipliers.inject { |a, e| a + e }.to_f / multipliers.size).to_i

  # If the multiplier is greater than 1, report this
  if avg_multiplier > 1
    floor_multiplier = avg_multiplier
    OpenStudio.logFree(OpenStudio::Info, 'openstudio.standards.BuildingStory', "Story #{name} has a multiplier of #{floor_multiplier}.")
  end

  return floor_multiplier
end

#minimum_z_value ⇒ Double

Gets the minimum z-value of the story. This is considered to be the minimum z value of any vertex of any surface of any space on the story, with the exception of plenum spaces.

Returns:

  • (Double) —

    the minimum z-value, in m



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
 
# File 'lib/openstudio-standards/standards/Standards.BuildingStory.rb', line 47

def minimum_z_value
  z_heights = []
  spaces.each do |space|
    # Skip plenum spaces
    next if space.plenum?

    # Get the z value of the space, which
    # vertices in space surfaces are relative to.
    z_origin = space.zOrigin

    # loop through space surfaces to find min z value
    space.surfaces.each do |surface|
      surface.vertices.each do |vertex|
        z_heights << vertex.z + z_origin
      end
    end
  end

  # Error if no z heights were found
  z = 999.9 
  if z_heights.size > 0
    z = z_heights.min
  else
    OpenStudio.logFree(OpenStudio::Error, 'openstudio.standards.Model', "For #{name} could not find the minimum_z_value, which means the story has no spaces assigned or the spaces have no surfaces.")
  end

  return z
end