Class: SetEnergyPlusMinimumOutdoorAirFlowRate

Inherits:
OpenStudio::Measure::EnergyPlusMeasure
  • Object
show all
Defined in:
lib/measures/SetEnergyPlusMinimumOutdoorAirFlowRate/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/SetEnergyPlusMinimumOutdoorAirFlowRate/measure.rb', line 27

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

  # make an argument
  minOutdoorAirFlow = OpenStudio::Measure::OSArgument.makeDoubleArgument('minOutdoorAirFlow', true)
  minOutdoorAirFlow.setDisplayName('Minimum Outdoor Air Flow Rate (m^3/s).')
  # minOutdoorAirFlow.setDefaultValue(10.76)
  args << minOutdoorAirFlow

  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/SetEnergyPlusMinimumOutdoorAirFlowRate/measure.rb', line 22

def name
  return 'SetEnergyPlusMinimumOutdoorAirFlowRate'
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
 
# File 'lib/measures/SetEnergyPlusMinimumOutdoorAirFlowRate/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
  minOutdoorAirFlow = runner.getDoubleArgumentValue('minOutdoorAirFlow', user_arguments)

  # check the minOutdoorAirFlow for reasonableness
  if minOutdoorAirFlow < 0
    runner.registerError('Please enter a non-negative value for Minimum Outdoor Air Flow Rate.')
    return false
  end

  # get all outdoorAirObjects in model
  outdoorAirObjects = workspace.getObjectsByType('Controller:OutdoorAir'.to_IddObjectType)

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

  starting_minOutdoorAirFlow_values = []
  final_minOutdoorAirFlow_values = []

  outdoorAirObjects.each do |outdoorAirObject|
    outdoorAirObject_name =  outdoorAirObject.getString(0) # Name
    outdoorAirObject_starting_minOutdoorAirFlow = outdoorAirObject.getString(5) # Minimum Outdoor Air Flow Rate
    outdoorAirObject.setString(5, minOutdoorAirFlow.to_s) # Minimum Outdoor Air Flow Rate

    # populate reporting arrays
    runner.registerInfo("Changing minimum outdoor air flow rate of #{outdoorAirObject_name} from #{outdoorAirObject_starting_minOutdoorAirFlow}(m^3/s) to #{outdoorAirObject.getString(5)}(m^3/s).")
    starting_minOutdoorAirFlow_values << outdoorAirObject_starting_minOutdoorAirFlow.get.to_f
    final_minOutdoorAirFlow_values << outdoorAirObject.getString(5).get.to_f
  end

  # TODO: - add warning if a thermal zone has more than one outdoorAirObjects 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 outdoorAirObjects

  # unique initial conditions based on
  runner.registerInitialCondition("The building has #{outdoorAirObjects.size} outdoorAirObject objects, and started with minimum outdoor air flow rate values ranging from #{starting_minOutdoorAirFlow_values.min} to #{starting_minOutdoorAirFlow_values.max}.")

  # reporting final condition of model
  runner.registerFinalCondition("The building finished with minimum outdoor air flow rate values ranging from #{final_minOutdoorAirFlow_values.min} to #{final_minOutdoorAirFlow_values.max}.")

  return true
end