Class: SetEnergyPlusInfiltrationFlowRatePerFloorArea

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

Overview

start the measure

Instance Method Summary collapse

Instance Method Details

#arguments(workspace) ⇒ Object

define the arguments that the user will input



27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/measures/SetEnergyPlusInfiltrationFlowRatePerFloorArea/measure.rb', line 27

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

  # make an argument
  flowPerZoneFloorArea = OpenStudio::Measure::OSArgument.makeDoubleArgument('flowPerZoneFloorArea', true)
  flowPerZoneFloorArea.setDisplayName('Flow per Zone Floor Area (m^3/s-m^2).')
  # flowPerZoneFloorArea.setDefaultValue(10.76)
  args << flowPerZoneFloorArea

  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



22
23
24
 
# File 'lib/measures/SetEnergyPlusInfiltrationFlowRatePerFloorArea/measure.rb', line 22

def name
  return 'SetEnergyPlusInfiltrationFlowRatePerFloorArea'
end

#run(workspace, runner, user_arguments) ⇒ Object

define what happens when the measure is run



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
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/measures/SetEnergyPlusInfiltrationFlowRatePerFloorArea/measure.rb', line 40

def run(workspace, runner, user_arguments)
  super(workspace, runner, user_arguments)

  # use the built-in error checking
  if !runner.validateUserArguments(arguments(workspace), user_arguments)
    return false
  end

  # assign the user inputs to variables
  flowPerZoneFloorArea = runner.getDoubleArgumentValue('flowPerZoneFloorArea', user_arguments)

  # check the flowPerZoneFloorArea for reasonableness
  if flowPerZoneFloorArea < 0
    runner.registerError('Please enter a non-negative value for Flow per Zone Floor Area.')
    return false
  end

  # get all infiltrationObjects in model
  infiltrationObjects = workspace.getObjectsByType('ZoneInfiltration:DesignFlowRate'.to_IddObjectType)

  if infiltrationObjects.empty?
    runner.registerAsNotApplicable('The model does not contain any infiltration objects. The model will not be altered.')
    return true
  end

  starting_flowPerZoneFloorArea_values = []
  non_flowPerZoneFloorArea_starting = []
  final_flowPerZoneFloorArea_values = []

  infiltrationObjects.each do |infiltrationObject|
    infiltrationObject_name =  infiltrationObject.getString(0) # Name
    infiltrationObject_starting_calc = infiltrationObject.getString(3) # Design Flow Rate Calculation Method
    infiltrationObject_starting_flowPerZoneFloorArea = infiltrationObject.getString(5) # Flow per Zone Floor Area
    infiltrationObject.setString(3, 'Flow/Area') # Design Flow Rate Calculation Method
    infiltrationObject.setString(5, flowPerZoneFloorArea.to_s) # Flow per Zone Floor Area

    # populate reporting arrays
    if infiltrationObject_starting_calc.to_s == 'Flow/Area'
      runner.registerInfo("Changing #{infiltrationObject_name} from flow per zone floor area of #{infiltrationObject_starting_flowPerZoneFloorArea}(m^3/s-m^2) to #{infiltrationObject.getString(5)}(W/m^2).")
      starting_flowPerZoneFloorArea_values << infiltrationObject_starting_flowPerZoneFloorArea.get.to_f
      final_flowPerZoneFloorArea_values << infiltrationObject.getString(5).get.to_f
    else
      runner.registerInfo("Setting flow per zone floor area of #{infiltrationObject_name} to #{infiltrationObject.getString(5)}(m^3/s-m^2) and changing design flow calculation rate method to Flow/Zone. Original design flow calculation method was #{infiltrationObject_starting_calc}.")
      non_flowPerZoneFloorArea_starting << infiltrationObject_name
      final_flowPerZoneFloorArea_values << infiltrationObject.getString(5).get.to_f
    end
  end

  # TODO: - add warning if a thermal zone has more than one infiltrationObjects object, as that may not result in the desired impact.

  # TODO: - may also want to warn or have info message for zones that dont have any infiltrationObjects

  # unique initial conditions based on
  if !starting_flowPerZoneFloorArea_values.empty? && non_flowPerZoneFloorArea_starting.empty?
    runner.registerInitialCondition("The building has #{infiltrationObjects.size} infiltrationObject objects, and started with flow per zone floor area values ranging from #{starting_flowPerZoneFloorArea_values.min} to #{starting_flowPerZoneFloorArea_values.max}.")
  elsif !starting_flowPerZoneFloorArea_values.empty? && !non_flowPerZoneFloorArea_starting.empty?
    runner.registerInitialCondition("The building has #{infiltrationObjects.size} infiltrationObject objects, and started with flow per zone floor area values ranging from #{starting_flowPerZoneFloorArea_values.min} to #{starting_flowPerZoneFloorArea_values.max}. #{non_flowPerZoneFloorArea_starting.size} infiltrationObject objects did not start as Flow/Area, and are not included in the flow per zone floor area range.")
  else
    runner.registerInitialCondition("The building has #{infiltrationObjects.size} infiltrationObject objects. None of the infiltrationObjects started as Flow/Area.")
  end

  # reporting final condition of model
  runner.registerFinalCondition("The building finished with flow per zone floor area values ranging from #{final_flowPerZoneFloorArea_values.min} to #{final_flowPerZoneFloorArea_values.max}.")

  return true
end