openstudio-standards 0.8.2 → 0.8.4

data/lib/openstudio-standards/btap/costing/led_lighting_costing.rb

@@ -0,0 +1,155 @@
+class BTAPCosting
+
+  def cost_audit_led_lighting(model:, prototype_creator:)
+    a = 0 # This is for reporting purposes.
+    standards_template = model.building.get.standardsTemplate.to_s
+    if standards_template.include?('NECB')
+      standards_template = standards_template.gsub(/(?<=\p{L})(?=\d)/, ' ') #insert a space between NECB and 2011/2015/2017
+    end
+    # puts standards_template
+
+    #-------------------------------------------------------------------------------------------------------------------
+    led_cost_total = 0.0
+    #-------------------------------------------------------------------------------------------------------------------
+    model.getSpaces.sort.each do |space|
+
+      ##### Find height of the space
+      max_space_height_m = 0.0
+      space.surfaces.sort.select { |surface| surface.surfaceType == 'Wall' }.each do |wall_surface|
+        # Find the vertex with the max z value.
+        vertex_with_max_height = wall_surface.vertices.max_by(&:z)
+        # Replace max if this surface has something bigger.
+        max_space_height_m = vertex_with_max_height.z if vertex_with_max_height.z > max_space_height_m
+      end
+      # puts "max_space_height_m - #{max_space_height_m}"
+      max_space_height_ft = (OpenStudio.convert(max_space_height_m, 'm', 'ft').get) #Convert height to ft
+      # puts "max_space_height_ft - #{max_space_height_ft}"
+
+      ##### Find space's floor area
+      floor_surface = nil
+      floor_area_m2 = 0.0
+      floor_vertices = []
+      space.surfaces.sort.each do |surface|
+        # puts floor_area_m2
+        if surface.surfaceType == 'Floor'
+          floor_surface = surface
+          floor_area_m2 += surface.netArea
+          # puts floor_area_m2
+        end
+      end
+      floor_area_ft2 = (OpenStudio.convert(floor_area_m2, 'm^2', 'ft^2').get) #convert floor_area_m2 to ft2
+      # puts "floor_area_m2 - #{floor_area_m2}"
+      # puts "floor_area_ft2 - #{floor_area_ft2}"
+
+      ##### Find type of the space
+      space_type = space.spaceType()
+      # puts space_type.get
+      space_type_name = space_type.get.standardsSpaceType
+      # puts "space_type_name - #{space_type_name}"
+
+      ##### Figure out if the space has LED lighting; and calculate its associated cost
+      space_type.get.lights.sort.each do |light|
+        space_lights_definition = light.lightsDefinition
+        space_lights_definition_name = space_lights_definition.name
+        # puts space_lights_definition_name
+
+        if space_lights_definition_name.to_s.include?('LED lighting')
+          led_cost_space = 0.0
+          ##### COSTING-related step: Find fixture type that should be used in the space based on space_type, template, and lights_type
+          search_fixture_type = {
+              row_id_1: space_type_name,
+              row_id_2: standards_template,
+              row_id_3: 'LED'
+          }
+          sheet_name = 'lighting_sets'
+          if max_space_height_ft < 7.88
+            column_search = 'Fixture_type_less_than_7.88ft_ht'
+          elsif max_space_height_ft >= 7.88 && max_space_height_ft < 15.75
+            column_search = 'Fixture_type_7.88_to_15.75ft_ht'
+          else #i.e. max_space_height_ft >= 15.75ft_ht
+            column_search = 'Fixture_type_greater_than_>15.75ft_ht'
+          end
+          row_search_1 = 'space_type'
+          row_search_2 = 'template'
+          row_search_3 = 'Type'
+          fixture_type = get_fixture_type_id(fixture_info: search_fixture_type, sheet_name: sheet_name, row_name_1: row_search_1, row_name_2: row_search_2, row_name_3: row_search_3, column_search: column_search)
+          # puts "fixture_type - #{fixture_type}"
+
+          ##### COSTING-related step: Find 'id_layers' and 'Id_layers_quantity_multipliers' based on fixture_type; and calculate LED cost
+          search_id_layers = @costing_database['raw']['lighting'].select { |data|
+            data['lighting_type_id'].to_f.round(1) == fixture_type.to_f.round(1)
+          }.first
+          if search_id_layers.nil?
+            puts("No data found for #{search_id_layers}!")
+            raise
+          end
+          ids = search_id_layers['id_layers'].to_s.split(',')
+          # puts "id_layers - #{ids}"
+
+          search_id_layers_quantity_multipliers = @costing_database['raw']['lighting'].select { |data|
+            data['lighting_type_id'].to_f.round(1) == fixture_type.to_f.round(1)
+          }.first
+          if search_id_layers_quantity_multipliers.nil?
+            puts("No data found for #{search_id_layers_quantity_multipliers}!")
+            raise
+          end
+          id_quants = search_id_layers_quantity_multipliers['Id_layers_quantity_multipliers'].to_s.split(',')
+          # puts "id_layers_quantity_multipliers - #{id_quants}"
+
+          overall_mult = 1.0
+
+          index_id_quant = 0.0
+          ids.each do |id|
+            quantity_led = id_quants[index_id_quant].to_f * overall_mult * floor_area_ft2
+            # id_description_search = @costing_database['raw']['materials_lighting'].select { |data|
+            #   data['lighting_type_id'].to_f.round(1) == id.to_f.round(1)
+            # }.first
+            # id_description = id_description_search['description']
+
+            search_led = {
+                row_id_1: nil,
+                row_id_2: id
+            }
+            sheet_name = 'materials_lighting'
+            column_1 = nil
+            column_2 = 'lighting_type_id'
+            tags = ['lighting', 'led_lighting']
+            led_costing = assembly_cost(cost_info:search_led,
+                                        sheet_name:sheet_name,
+                                        column_1:column_1,
+                                        column_2:column_2,
+                                        quantity:quantity_led,
+                                        tags: tags)
+            led_cost_space += led_costing
+            index_id_quant += 1.0
+          end
+
+          led_cost_total += led_cost_space
+
+          @costing_report["lighting"]["led_lighting"] << {
+              'space' => space.name.to_s,
+              'led_costing' => led_cost_space,
+          }
+
+          a += 1
+
+        end #if space_lights_definition_name.to_s.include?('LED lighting')
+      end #space_type.get.lights.sort.each do |light|
+      #-------------------------------------------------------------------------------------------------------------------
+
+    end #model.getSpaces.sort.each do |space|
+    #-------------------------------------------------------------------------------------------------------------------
+
+    if a > 0
+      @costing_report["lighting"]["led_lighting"] << {
+          'total_cost' => led_cost_total
+      }
+    end
+
+    puts "\nLED lighting costing data successfully generated. Total LED lighting costs: $#{led_cost_total.round(2)}"
+
+    return led_cost_total
+
+  end #cost_audit_led_lighting(model, prototype_creator)
+
+end

data/lib/openstudio-standards/btap/costing/lighting_costing.rb

@@ -0,0 +1,209 @@
+class BTAPCosting
+
+  def cost_audit_lighting(model, prototype_creator)
+    # Store number of stories. Required for envelope costing logic.
+    num_of_above_ground_stories = model.getBuilding.standardsNumberOfAboveGroundStories.to_i
+
+    template_type = prototype_creator.template
+
+    closest_loc = get_closest_cost_location(model.getWeatherFile.latitude, model.getWeatherFile.longitude)
+    generate_construction_cost_database_for_city(@costing_report["city"],@costing_report["province_state"])
+
+    totLgtCost = 0
+
+    # daylighting sensor control costing
+    dsc_cost_total = cost_audit_daylighting_sensor_control(model: model, prototype_creator: prototype_creator)
+
+    # led lighting costing
+    led_cost_total = cost_audit_led_lighting(model: model, prototype_creator: prototype_creator)
+
+    totLgtCost += dsc_cost_total
+
+    # Iterate through the thermal zones.
+
+    #Create Zonal report.
+    @costing_report["lighting"]["fixture_report"] = []
+    @costing_report["lighting"]["space_report"] = []
+    model.getThermalZones.sort.each do |zone|
+      # Iterate through spaces.
+      spaceNum = 0  # Counting number of spaces for reporting
+      total_with_region = 0
+      zone.spaces.sort.each do |space|
+        spaceNum += 1  # Counting number of spaces for reporting
+        # Get SpaceType defined for space.. if not defined it will skip the spacetype. May have to deal with Attic spaces.
+        if space.spaceType.empty? or space.spaceType.get.standardsSpaceType.empty? or space.spaceType.get.standardsBuildingType.empty?
+          raise ("standards Space type and building type is not defined for space:#{space.name.get}. Skipping this space for costing.")
+        end
+
+        # Get space type standard names.
+        space_type = space.spaceType.get.standardsSpaceType
+        building_type = space.spaceType.get.standardsBuildingType
+        space_light = space.spaceType.get.lights
+        space_has_no_light = space_light.empty?
+
+        # Figure out what light_type is used in the building
+        light_type = 'Nil'
+        if space_has_no_light == false
+          space.spaceType.get.lights.sort.each do |light|
+            space_lights_definition = light.lightsDefinition
+            space_lights_definition_name = space_lights_definition.name
+            if space_lights_definition_name.to_s.include?('LED lighting') or template_type=='NECB2020' # Note: NECB2020's lights default is LED
+              light_type = 'LED'
+            else
+              light_type = 'CFL'
+            end
+          end
+        end
+
+        # Get standard lighting sets based on collected information (spacetype, no of stories, etc..)
+        if space_has_no_light == false
+          lighting_set = @costing_database['raw']['lighting_sets'].detect {|data|
+            data['template'].to_s.gsub(/\s*/, '') == template_type and
+              data['building_type'].to_s.downcase == building_type.to_s.downcase and
+              data['space_type'].to_s.downcase == space_type.to_s.downcase and
+              data['Type'].to_s.downcase == light_type.to_s.downcase
+          }
+        else
+          lighting_set = @costing_database['raw']['lighting_sets'].detect {|data|
+            data['template'].to_s.gsub(/\s*/, '') == template_type and
+              data['building_type'].to_s.downcase == building_type.to_s.downcase and
+              data['space_type'].to_s.downcase == space_type.to_s.downcase
+          }
+        end
+
+        # Determine average space height using space volume and floor area (convert to feet)
+        ceilHgt, flrArea = 0
+        if space.floorArea > 0
+          ceilHgt = space.volume / space.floorArea
+          ceilHgt = OpenStudio.convert(ceilHgt,"m","ft").get
+          flrArea = OpenStudio.convert(space.floorArea,"m^2","ft^2").get
+        end
+
+        # Find Fixture type for this space ceiling height (ft)
+        fixtureType = 'Nil'
+        fixture_description = ""
+        if lighting_set.nil?
+          raise("Error: lighting_set empty for zone #{zone.name.to_s} and space type #{building_type} #{space_type.to_s}!")
+        else
+          if ceilHgt > 0 && ceilHgt < 7.88
+            fixtureType = lighting_set["Fixture_type_less_than_7.88ft_ht"]
+          elsif ceilHgt >= 7.88 && ceilHgt <= 15.75
+            fixtureType = lighting_set["Fixture_type_7.88_to_15.75ft_ht"]
+          elsif ceilHgt > 15.75
+            fixtureType = lighting_set["Fixture_type_greater_than_>15.75ft_ht"]
+          end
+        end
+
+        # Costs are 0 for 'Nil' because no fixture type due to either zero floor area, zero ceiling height or a 'Nil'
+        # setting for fixture type in lighting_sets sheet ("- undefined -" space)
+        if fixtureType != 'Nil'
+          # Get lighting type sets based on fixtureType
+          lighting_type = @costing_database['raw']['lighting'].select {|lighting_layer_data|
+            lighting_layer_data['lighting_type_id'].to_s == fixtureType.to_s
+          }.first
+
+          # Scan through layer IDs in id_layers field to get API data from materials_lighting sheet
+          materials_lighting_database = @costing_database["raw"]["materials_lighting"]
+
+          layer_type_IDs = []
+          layer_type_mult = []
+          layer_MaterialCost = 0
+          layer_LabourCost = 0
+
+          if lighting_type["id_layers"].empty?
+            raise ("Lighting type layers list for lighting type ID #{fixtureType} is empty.")
+          else
+            layer_type_IDs = lighting_type["id_layers"].split(/\s*,\s*/)
+            layer_type_mult = lighting_type["Id_layers_quantity_multipliers"].split(/\s*,\s*/)
+            lighting_layers = layer_type_IDs.zip(layer_type_mult).to_h
+
+            lighting_layers.each do |layer_id, layer_mult|
+              # Note: The column in the spreadsheet labelled "lighting_type_id" is mislabelled and should
+              # really be "lighting_type_layer_id" but left it as-is (below).
+              lighting_material = materials_lighting_database.find do |data|
+                data["lighting_type_id"].to_s == layer_id.to_s
+              end
+              if lighting_material.nil?
+                puts "Lighting material error..could not find lighting material #{layer_id} in #{materials_lighting_database}"
+                raise
+              else
+                costing_data = @costing_database['costs'].detect {|data| data['id'].to_s.upcase == lighting_material['id'].to_s.upcase}
+                if costing_data.nil?
+                  puts "Lighting material id #{lighting_material['id']} not found in costing data. Skipping."
+                  raise
+                else
+                  # Get cost information from lookup.
+                  material_cost = costing_data['baseCosts']['materialOpCost'].to_f * layer_mult.to_f * flrArea * zone.multiplier
+                  labour_cost = costing_data['baseCosts']['laborOpCost'].to_f * layer_mult.to_f * flrArea * zone.multiplier
+                  layer_MaterialCost += material_cost
+                  layer_LabourCost += labour_cost
+
+                  regional_material, regional_installation =
+                    get_regional_cost_factors(@costing_report["province_state"], @costing_report["city"], lighting_material)
+                  total_with_region = layer_MaterialCost * regional_material / 100.0 + layer_LabourCost * regional_installation / 100.0
+
+                  # Gather info for costed items output file
+                  tags = ['lighting','necb_default']
+                  add_costed_item(material_id: costing_data['id'],
+                                  quantity: layer_mult.to_f * flrArea * zone.multiplier,
+                                  material_mult: costing_data['material_mult'].to_f,
+                                  labour_mult: costing_data['labour_mult'].to_f,
+                                  equip_mult: 1.0,
+                                  tags: tags)
+
+
+                end # costing_data Nil check
+              end # lighting_material Nil check
+            end # lighting layer ids loop
+
+            totLgtCost += total_with_region
+            fixture_description = lighting_type["description"]
+          end # lighting layer ids check
+        end # fixtureType Nil check
+
+        zName = zone.name.to_s
+
+        # Create Lighting space report.
+        @costing_report["lighting"]["space_report"] << {
+          'space' => space.name.to_s,
+          'zone' => zone.name.to_s,
+          'building_type' =>space.spaceType.get.standardsBuildingType.to_s,
+          'space_type' => space.spaceType.get.standardsSpaceType.to_s,
+          'zone_multiplier' => space.multiplier,
+          'fixture_type' => fixtureType,
+          'fixture_desciption' => fixture_description,
+          'height_avg_ft' => ceilHgt.round(1),
+          'floor_area_ft2' => (flrArea * space.multiplier).round(1),
+          'cost' => total_with_region.round(2),
+          'cost_per_ft2' => (total_with_region / ( flrArea * space.multiplier )).round(2),
+          'note' => ""
+        }
+
+        # Create Lighting Zonal report.
+        lighting_fixture_report = @costing_report["lighting"]["fixture_report"].detect {|fixture_report| fixture_report["fixture_type"] == fixtureType}
+        unless lighting_fixture_report.nil?
+          lighting_fixture_report['floor_area_ft2'] = (lighting_fixture_report['floor_area_ft2'] + (flrArea * space.multiplier)).round(1)
+          lighting_fixture_report['cost'] = (lighting_fixture_report['cost'] + total_with_region).round(2)
+          lighting_fixture_report['cost_per_ft2'] = (lighting_fixture_report['cost'] / lighting_fixture_report['floor_area_ft2']).round(2)
+          lighting_fixture_report['spaces'] << space.name.get
+          lighting_fixture_report['number_of_spaces'] = lighting_fixture_report['spaces'].size
+        else
+          @costing_report["lighting"]["fixture_report"] << {
+            'fixture_type' => fixtureType,
+            'fixture_description' => fixture_description,
+            'floor_area_ft2' => (flrArea * space.multiplier).round(1),
+            'cost' => total_with_region.round(2),
+            'cost_per_ft2' => (total_with_region / (flrArea * space.multiplier)).round(2),
+            'spaces' => [space.name.get],
+            'number_of_spaces' => 1
+          }
+        end
+      end # Spaces loop
+    end # thermalzone loop
+
+    @costing_report["lighting"]['total_lighting_cost'] = totLgtCost.round(2)
+    puts "\nLighting costing data successfully generated. Total lighting cost is $#{totLgtCost.round(2)}"
+
+    return totLgtCost
+  end
+end