Module: OsLib_LightingAndEquipment

Includes:
OsLib_Schedules
Defined in:
lib/openstudio/extension/core/os_lib_lighting_and_equipment.rb

Overview

load OpenStudio measure libraries

Class Method Summary collapse

Methods included from OsLib_Schedules

addScheduleTypeLimits, adjust_hours_of_operation_for_schedule_ruleset, conditionalScheduleValueAdjust, createComplexSchedule, createSimpleSchedule, create_schedule_variable_interval_from_time_series, create_timeseries_from_schedule_ruleset, getMinMaxAnnualProfileValue, scheduleFromRateOfChange, simpleScheduleValueAdjust, timeConditionalScheduleValueAdjust, weightedMergeScheduleRulesets

Class Method Details

.addDaylightSensor(model, options = {}) ⇒ Object

add daylight sensor



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

def self.addDaylightSensor(model, options = {})
  # set defaults to use if user inputs not passed in
  defaults = {
    'name' => nil,
    'space' => nil,
    'position' => nil,
    'phiRotationAroundZAxis' => nil,
    'illuminanceSetpoint' => nil,
    'lightingControlType' => '1', # 1 = Continuous
    'minInputPowerFractionContinuous' => nil,
    'minOutputPowerFractionContinuous' => nil,
    'numberOfSteppedControlSteps' => nil
  }

  # merge user inputs with defaults
  options = defaults.merge(options)

  pri_light_sensor = OpenStudio::Model::DaylightingControl.new(model)
  if !options['name'].nil? then pri_light_sensor.setName(options['name']) end
  if !options['space'].nil? then pri_light_sensor.setSpace(options['space']) end
  if !options['position'].nil? then pri_light_sensor.setPosition(options['position']) end
  if !options['phiRotationAroundZAxis'].nil? then pri_light_sensor.setPhiRotationAroundZAxis(options['phiRotationAroundZAxis']) end
  if !options['illuminanceSetpoint'].nil? then  pri_light_sensor.setIlluminanceSetpoint(options['illuminanceSetpoint']) end
  if !options['lightingControlType'].nil? then  pri_light_sensor.setLightingControlType(options['lightingControlType']) end

  result = pri_light_sensor
  return result
end

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

return min ans max from array



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

def self.addExteriorLights(model, runner, options = {})
  # set defaults to use if user inputs not passed in
  defaults = {
    'name' => 'Exterior Light',
    'power' => 0,
    'subCategory' => 'Exterior Lighting',
    'controlOption' => 'AstronomicalClock',
    'setbackStartTime' => 0,
    'setbackEndTime' => 0,
    'setbackFraction' => 0.25
  }

  # merge user inputs with defaults
  options = defaults.merge(options)

  ext_lights_def = OpenStudio::Model::ExteriorLightsDefinition.new(model)
  ext_lights_def.setName("#{options['name']} Definition")
  runner.registerInfo("Setting #{ext_lights_def.name} to a design power of #{options['power']} Watts")
  ext_lights_def.setDesignLevel(options['power'])

  # creating schedule type limits for the exterior lights schedule
  ext_lights_sch_type_limits = OpenStudio::Model::ScheduleTypeLimits.new(model)
  ext_lights_sch_type_limits.setName("#{options['name']} Fractional")
  ext_lights_sch_type_limits.setLowerLimitValue(0)
  ext_lights_sch_type_limits.setUpperLimitValue(1)
  ext_lights_sch_type_limits.setNumericType('Continuous')

  # prepare values for profile
  if options['setbackStartTime'] == 24
    profile = { options['setbackEndTime'] => options['setbackFraction'], 24.0 => 1.0 }
  elsif options['setbackStartTime'] == 0
    profile = { options['setbackEndTime'] => options['setbackFraction'], 24.0 => 1.0 }
  elsif options['setbackStartTime'] > options['setbackEndTime']
    profile = { options['setbackEndTime'] => options['setbackFraction'], options['setbackStartTime'] => 1.0, 24.0 => options['setbackFraction'] }
  else
    profile = { options['setbackStartTime'] => 1.0, options['setbackEndTime'] => options['setbackFraction'] }
  end

  # inputs
  createSimpleSchedule_inputs = {
    'name' => options['name'],
    'winterTimeValuePairs' => profile,
    'summerTimeValuePairs' => profile,
    'defaultTimeValuePairs' => profile
  }

  # create a ruleset schedule with a basic profile
  ext_lights_sch = OsLib_Schedules.createSimpleSchedule(model, createSimpleSchedule_inputs)

  # creating exterior lights object
  ext_lights = OpenStudio::Model::ExteriorLights.new(ext_lights_def, ext_lights_sch)
  ext_lights.setName("#{options['power']} w Exterior Light")
  ext_lights.setControlOption(options['controlOption'])
  ext_lights.setEndUseSubcategory(options['subCategory'])

  result = ext_lights
  return result
end

.createHashOfInternalLoadWithHardAssignedSchedules(internalLoadArray) ⇒ Object

make hash of hard assigned schedules with lighting levels



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/openstudio/extension/core/os_lib_lighting_and_equipment.rb', line 134

def self.createHashOfInternalLoadWithHardAssignedSchedules(internalLoadArray)
  hardAssignedScheduleHash = {}
  internalLoadArray.each do |load|
    if !load.isScheduleDefaulted
      # add to schedule hash
      if !load.schedule.empty?
        if !(hardAssignedScheduleHash[load.schedule.get])
          hardAssignedScheduleHash[load.schedule.get] = 1
        else
          hardAssignedScheduleHash[load.schedule.get] += 1 # this is to catch multiple objects instances using the same hard assigned schedule
        end
      end
    end
  end

  result = hardAssignedScheduleHash
  return result
end

.getEpdForSpaceArray(spaceArray) ⇒ Object

get value per area for electric equipment loads in space array.



154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/openstudio/extension/core/os_lib_lighting_and_equipment.rb', line 154

def self.getEpdForSpaceArray(spaceArray)
  floorArea = 0
  electricEquipmentPower = 0

  spaceArray.each do |space|
    floorArea += space.floorArea * space.multiplier
    electricEquipmentPower += space.electricEquipmentPower * space.multiplier
  end

  epd = electricEquipmentPower / floorArea

  result = epd
  return result
end

.getExteriorLightsValue(model) ⇒ Object

return min ans max from array



13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/openstudio/extension/core/os_lib_lighting_and_equipment.rb', line 13

def self.getExteriorLightsValue(model)
  facility = model.getFacility
  exterior_lights_power = 0
  exterior_lights = facility.exteriorLights
  exterior_lights.each do |exterior_light|
    exterior_light_multiplier = exterior_light.multiplier
    exterior_light_def = exterior_light.exteriorLightsDefinition
    exterior_light_base_power = exterior_light_def.designLevel
    exterior_lights_power += exterior_light_base_power * exterior_light_multiplier
  end

  result = { 'exterior_lighting_power' => exterior_lights_power, 'exterior_lights' => exterior_lights }
  return result
end

.getLpdForSpaceArray(spaceArray) ⇒ Object

get value per area for electric equipment loads in space array.



170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/openstudio/extension/core/os_lib_lighting_and_equipment.rb', line 170

def self.getLpdForSpaceArray(spaceArray)
  floorArea = 0
  lightingPower = 0

  spaceArray.each do |space|
    floorArea += space.floorArea * space.multiplier
    lightingPower += space.lightingPower * space.multiplier
  end

  lpd = lightingPower / floorArea

  result = lpd
  return result
end

.removeAllExteriorLights(model, runner) ⇒ Object

return min ans max from array



29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/openstudio/extension/core/os_lib_lighting_and_equipment.rb', line 29

def self.removeAllExteriorLights(model, runner)
  facility = model.getFacility
  lightsRemoved = false
  exterior_lights = facility.exteriorLights
  exterior_lights.each do |exterior_light|
    runner.registerInfo("Removed exterior light named #{exterior_light.name}.")
    exterior_light.remove
    lightsRemoved = true
  end

  result = lightsRemoved
  return result
end