Module: OsLib_OutdoorAirAndInfiltration

Defined in:
lib/openstudio/extension/core/os_lib_outdoorair_and_infiltration.rb

Overview

******************************************************************************* OpenStudio(R), Copyright © 2008-2021, Alliance for Sustainable Energy, LLC. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

(1) Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

(2) Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

(3) Neither the name of the copyright holder nor the names of any contributors may be used to endorse or promote products derived from this software without specific prior written permission from the respective party.

(4) Other than as required in clauses (1) and (2), distributions in any form of modifications or other derivative works may not use the “OpenStudio” trademark, “OS”, “os”, or any other confusingly similar designation without specific prior written permission from Alliance for Sustainable Energy, LLC.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *******************************************************************************

Class Method Summary collapse

Class Method Details

.addScheduleToArrayAndRemove(space_infiltration_object) ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/openstudio/extension/core/os_lib_outdoorair_and_infiltration.rb', line 45

def OsLib_OutdoorAirAndInfiltration.addScheduleToArrayAndRemove(space_infiltration_object)
  # get schedule and add to hash
  if !space_infiltration_object.isScheduleDefaulted
    if !space_infiltration_object.schedule.empty?
      schedule = space_infiltration_object.schedule.get
      if @infiltrationSchedulesHardAssigned.key?(schedule)
        @infiltrationSchedulesHardAssigned[schedule] = @infiltrationSchedulesHardAssigned[schedule] + 1
      else
        @infiltrationSchedulesHardAssigned[schedule] = 1
      end
    end
  end
  space_infiltration_object.remove
end

.addSpaceInfiltrationDesignFlowRate(model, runner, objects, options = {}) ⇒ Object

create new infiltration def and apply it to all spaces throughout the entire building



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
 
# File 'lib/openstudio/extension/core/os_lib_outdoorair_and_infiltration.rb', line 89

def self.addSpaceInfiltrationDesignFlowRate(model, runner, objects, options = {})
  # set defaults to use if user inputs not passed in
  defaults = {
    'nameSuffix' => ' - infiltration', # add this to object name for infiltration
    'defaultBuildingSchedule' => nil, # this will set schedule set for selected object
    'schedule' => nil, # this will hard assign a schedule
    'setCalculationMethod' => nil, # should be string like setFlowerExteriorSurfaceArea
    'valueForSelectedCalcMethod' => nil
  }

  # merge user inputs with defaults
  options = defaults.merge(options)
  building = model.getBuilding
  newSpaceInfiltrationObjects = []

  # set default building infiltration schedule if requested
  if !options['defaultBuildingSchedule'].nil?
    if !building.defaultScheduleSet.empty?
      defaultScheduleSet = building.defaultScheduleSet.get
    else
      defaultScheduleSet = OpenStudio::Model::DefaultScheduleSet.new(model)
      defaultScheduleSet.setName('Default Schedules')
      building.setDefaultScheduleSet(defaultScheduleSet)
    end
    # set requested default schedule
    defaultScheduleSet.setInfiltrationSchedule(options['defaultBuildingSchedule'])
  end

  # note: object should be the building, or an array of space and or space types
  if objects == building
    # if no default space type then add an empty one (to hold new space infiltration object)
    if building.spaceType.empty?
      new_default = OpenStudio::Model::SpaceType.new(model)
      new_default.setName('Building Default Space Type')
      building.setSpaceType(new_default)
      runner.registerInfo("Adding a building default space type to hold space infiltration for spaces that previously didn't have a space type.")
    end

    # change objects to be all space types used in the model
    objects = []
    space_types = model.getSpaceTypes.sort
    space_types.each do |space_type|
      if !space_type.spaces.empty?
        objects << space_type
      end
    end
  end

  # loop through objects
  objects.each do |object|
    # create the infiltration object and associate with space or space type
    new_infil = OpenStudio::Model::SpaceInfiltrationDesignFlowRate.new(model)
    newSpaceInfiltrationObjects << new_infil
    eval("new_infil.#{options['setCalculationMethod']}(#{options['valueForSelectedCalcMethod']})")
    if !object.to_SpaceType.empty?
      new_infil.setSpaceType(object)
    elsif !object.to_Space.empty?
      new_infil.setSpace(object)
    else
      runner.registerWarning("#{object.name} isn't a space or a space type. Can't assign infiltration object to it.")
    end
    new_infil.setName("#{object.name} #{options['nameSuffix']}")

    # set hard assigned schedule if requested
    if options['schedule']
      new_infil.setSchedule(options['schedule'])
    end

    if new_infil.schedule.empty?
      runner.registerWarning("The new infiltration object for space type '#{object.name}' does not have a schedule. Assigning a default schedule set including an infiltration schedule to the space type or the building will address this.")
    end
  end

  result = newSpaceInfiltrationObjects
  return result
end

.eraseInfiltrationUsedInModel(model, runner) ⇒ Object

delete any infiltration objects used in the model.



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
 
# File 'lib/openstudio/extension/core/os_lib_outdoorair_and_infiltration.rb', line 38

def self.eraseInfiltrationUsedInModel(model, runner)
  # get space infiltration objects.
  space_infiltration_objects = model.getSpaceInfiltrationDesignFlowRates.sort

  # hash to hold schedules used for infiltration objects in the model
  @infiltrationSchedulesHardAssigned = {}

  def OsLib_OutdoorAirAndInfiltration.addScheduleToArrayAndRemove(space_infiltration_object)
    # get schedule and add to hash
    if !space_infiltration_object.isScheduleDefaulted
      if !space_infiltration_object.schedule.empty?
        schedule = space_infiltration_object.schedule.get
        if @infiltrationSchedulesHardAssigned.key?(schedule)
          @infiltrationSchedulesHardAssigned[schedule] = @infiltrationSchedulesHardAssigned[schedule] + 1
        else
          @infiltrationSchedulesHardAssigned[schedule] = 1
        end
      end
    end
    space_infiltration_object.remove
  end

  # remove space infiltration objects
  number_removed = 0
  number_left = 0
  space_infiltration_objects.each do |space_infiltration_object|
    opt_space_type = space_infiltration_object.spaceType
    if opt_space_type.empty?
      # add schedule if exists to array and remove object
      OsLib_OutdoorAirAndInfiltration.addScheduleToArrayAndRemove(space_infiltration_object)
      number_removed += 1
    elsif !opt_space_type.get.spaces.empty?
      # add schedule if exists to array and remove object
      OsLib_OutdoorAirAndInfiltration.addScheduleToArrayAndRemove(space_infiltration_object)
      number_removed += 1
    else
      number_left += 1
    end
  end
  if number_removed > 0
    runner.registerInfo("#{number_removed} infiltration objects were removed.")
  end
  if number_left > 0
    runner.registerInfo("#{number_left} infiltration objects in unused space types were left in the model. They will not be altered.")
  end

  result = @infiltrationSchedulesHardAssigned.sort_by { |k, v| v }.reverse # want schedule with largest key first
  return result
end