Class: SetEnergyPlusLightObjectsLPD

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

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

  # make an argument LPD
  lpd = OpenStudio::Measure::OSArgument.makeDoubleArgument('lpd', true)
  lpd.setDisplayName('Lighting Power Density (W/m^2)')
  lpd.setDefaultValue(10.76)
  args << lpd

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

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

  # check the lpd for reasonableness
  if (lpd < 0) || (lpd > 538)
    runner.registerError("A Lighting Power Density of #{lpd} W/m^2 is above the measure limit.")
    return false
  elsif lpd > 226
    runner.registerWarning("A Lighting Power Density of #{lpd} W/m^2 is abnormally high.")
  end

  # get all lights in model
  lights = workspace.getObjectsByType('Lights'.to_IddObjectType)

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

  starting_lpd_values = []
  non_lpd_starting = []
  final_lpd_values = []

  lights.each do |light|
    light_name =  light.getString(0) # Name
    light_starting_calc = light.getString(3) # Design Level Calculation Method
    light_starting_lpd = light.getString(5) # Watts per Zone Floor Area
    light.setString(3, 'Watts/Area') # Design Level Calculation Method
    light.setString(5, lpd.to_s) # Watts per Zone Floor Area

    # populate reporting arrays
    if light_starting_calc.to_s == 'Watts/Area'
      runner.registerInfo("Changing LPD of #{light_name} from #{light_starting_lpd}(W/m^2) to #{light.getString(5)}(W/m^2).")
      starting_lpd_values << light_starting_lpd.get.to_f
      final_lpd_values << light.getString(5).get.to_f
    else
      runner.registerInfo("Setting LPD of #{light_name} to #{light.getString(5)}(W/m^2). Original design level calculation method was #{light_starting_calc}.")
      non_lpd_starting << light_name
      final_lpd_values << light.getString(5).get.to_f
    end
  end

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

  # unique initial conditions based on
  if !starting_lpd_values.empty? && non_lpd_starting.empty?
    runner.registerInitialCondition("The building has #{lights.size} light objects, and started with LPD values ranging from #{starting_lpd_values.min} to #{starting_lpd_values.max}.")
  elsif !starting_lpd_values.empty? && !non_lpd_starting.empty?
    runner.registerInitialCondition("The building has #{lights.size} light objects, and started with LPD values ranging from #{starting_lpd_values.min} to #{starting_lpd_values.max}. #{non_lpd_starting.size} light objects did not start as Watts/Area, and are not included in the LPD range.")
  else
    runner.registerInitialCondition("The building has #{lights.size} light objects. None of the lights started as Watts/Area.")
  end

  # reporting final condition of model
  runner.registerFinalCondition("The building finished with LPD values ranging from #{final_lpd_values.min} to #{final_lpd_values.max}.")

  return true
end