openstudio-standards 0.8.5 → 0.8.7

data/lib/openstudio-standards/btap/carbon/btap_carbon.rb

@@ -1,177 +1,234 @@
-class BTAPCarbon
-  def initialize(attributes:, standards_data:)
-    @carbon_database  = {}
-    @costing_database = CostingDatabase.instance
-    @cp               = CommonPaths.instance
-    @attributes       = attributes
-    @carbon_report    = {}
-    @frame_m_to_kg    = standards_data["constants"]["glazing_frame_m_to_kg"]
-
-    # Build the carbon database.
-    carbon_opaque = CSV.read(@cp.carbon_opaque_path)
-    @carbon_database["opaque"] = Array.new
-
-    1.upto carbon_opaque.length - 1 do |i|
-      row   = carbon_opaque[i]
-      index = row.each
-      item  = Hash.new
-
-      item["materials_opaque_id"]                     = index.next
-      item["description"]                             = index.next
-      item["type"]                                    = index.next
-      item["quantity"]                                = index.next.to_f
-      item["per m2"]                                  = index.next.to_f
-      item["Product Category"]                        = index.next
-      item["Embodied Carbon (A1-A5)"]                 = index.next.to_f
-      item["Embodied Carbon (A-C)"]                   = index.next.to_f
-      item["Environmental Product Declaration (EPD)"] = index.next
-
-      @carbon_database["opaque"] << item
-    end
+# BTAP Carbon
+#
+# Calculates embodied carbon emissions currently accounting only for building
+# envelopes.
+
+module BTAP
+  class Carbon
+
+    # @param attributes     [BTAP::Attributes]
+    # @param standards_data [Hash] Required for window frame conversions.
+    def initialize(attributes:, standards_data:)
+      @carbon_database  = {}
+      @costing_database = Database.instance
+      @attributes       = attributes
+      @carbon_report    = {}
+      @frame_m_to_kg    = standards_data["constants"]["glazing_frame_m_to_kg"]
+
+      # Build the carbon database.
+      carbon_opaque = CSV.read(Paths::CARBON_OPAQUE_PATH)
+      @carbon_database["opaque"] = Array.new
+
+      1.upto carbon_opaque.length - 1 do |i|
+        row   = carbon_opaque[i]
+        index = row.each
+        item  = Hash.new
+
+        item["materials_opaque_id"]                     = index.next
+        item["description"]                             = index.next
+        item["type"]                                    = index.next
+        item["quantity"]                                = index.next.to_f
+        item["per m2"]                                  = index.next.to_f
+        item["Product Category"]                        = index.next
+        item["Embodied Carbon (A1-A5)"]                 = index.next.to_f
+        item["Embodied Carbon (A-C)"]                   = index.next.to_f
+        item["Environmental Product Declaration (EPD)"] = index.next
+
+        @carbon_database["opaque"] << item
+      end
 
-    carbon_glazing = CSV.read(@cp.carbon_glazing_path)
-    @carbon_database["glazing"] = Array.new
+      carbon_glazing = CSV.read(Paths::CARBON_GLAZING_PATH)
+      @carbon_database["glazing"] = Array.new
 
-    1.upto carbon_glazing.length - 1 do |i|
-      row   = carbon_glazing[i]
-      index = row.each
-      item  = Hash.new
+      1.upto carbon_glazing.length - 1 do |i|
+        row   = carbon_glazing[i]
+        index = row.each
+        item  = Hash.new
 
-      item["materials_glazing_id"]    = index.next
-      item["description"]             = index.next
-      item["per m2"]                  = index.next.to_f
-      item["Embodied Carbon (A1-A5)"] = index.next.to_f
-      item["Embodied Carbon (A-C)"]   = index.next.to_f
-      item["Environmental Product Declaration (EPD)"] = index.next
+        item["materials_glazing_id"]    = index.next
+        item["description"]             = index.next
+        item["per m2"]                  = index.next.to_f
+        item["Embodied Carbon (A1-A5)"] = index.next.to_f
+        item["Embodied Carbon (A-C)"]   = index.next.to_f
+        item["Environmental Product Declaration (EPD)"] = index.next
 
-      @carbon_database["glazing"] << item
-    end
+        @carbon_database["glazing"] << item
+      end
 
-    carbon_frame = CSV.read(@cp.carbon_frame_path)
-    @carbon_database["frame"] = Array.new
+      carbon_frame = CSV.read(Paths::CARBON_FRAME_PATH)
+      @carbon_database["frame"] = Array.new
 
-    1.upto carbon_frame.length - 1 do |i|
-      row   = carbon_frame[i]
-      index = row.each
-      item  = Hash.new
+      1.upto carbon_frame.length - 1 do |i|
+        row   = carbon_frame[i]
+        index = row.each
+        item  = Hash.new
 
-      item["materials_glazing_id"]    = index.next
-      item["description"]             = index.next
-      item["per m2"]                  = index.next.to_f
-      item["Embodied Carbon (A1-A5)"] = index.next.to_f
-      item["Embodied Carbon (A-C)"]   = index.next.to_f
-      item["Environmental Product Declaration (EPD)"] = index.next
+        item["materials_glazing_id"]    = index.next
+        item["description"]             = index.next
+        item["per m2"]                  = index.next.to_f
+        item["Embodied Carbon (A1-A5)"] = index.next.to_f
+        item["Embodied Carbon (A-C)"]   = index.next.to_f
+        item["Environmental Product Declaration (EPD)"] = index.next
 
-      @carbon_database["frame"] << item
+        @carbon_database["frame"] << item
+      end
     end
-  end
 
-  def audit_embodied_carbon
-    @attributes.surface_types.each do |surface_type|
-      @carbon_report["#{surface_type.underscore}_area_m2"] = 0.0
-      @carbon_report["#{surface_type.underscore}_carbon"]  = 0.0
-    end
+    def audit_embodied_carbon
+      total_emissions = 0
 
-    @attributes.spaces.each do |space|
       @attributes.surface_types.each do |surface_type|
-        space.surfaces_hash[surface_type].each do |surface|
-          surface_area = surface.netArea * space.thermalZone.get.multiplier
-          @carbon_report["#{surface_type.underscore}_area_m2"] = \
-            (@carbon_report["#{surface_type.underscore}_area_m2"] + surface_area).round(2)
-
-          # Get the carbon emissions for each material in the space.
-          if surface.construction_hash.nil?
-            emissions = 0.0
-          else
-            emissions = get_carbon_emissions(surface.construction_hash, surface, surface_area) 
-            construction = surface.construction_hash
-          end
+        @carbon_report["#{@attributes.surface_types_to_snake[surface_type]}_area_m2"]       = 0.0
+        @carbon_report["#{@attributes.surface_types_to_snake[surface_type]}_carbon"]        = 0.0
+        @carbon_report["#{@attributes.surface_types_to_snake[surface_type]}_carbon_per_m2"] = 0.0
+      end
 
-          # Calculate the carbon emissions
-          @carbon_report["#{surface_type.underscore}_carbon"] = \
-            (@carbon_report["#{surface_type.underscore}_carbon"] + emissions).round(2)
+      # Calculate emissions for all constructions found by BTAP Attributes.
+      @attributes.constructions.each_value do |construction|
+        construction["subsets"].each do |subset|
+          subset["carbon"] = emissions_from_construction(subset, construction["type"])
         end
       end
-    end
 
-    # Get the total emissions from all the surface types.
-    total_emissions = 0
-    @attributes.surface_types.each do |surface_type|
-      total_emissions += @carbon_report["#{surface_type.underscore}_carbon"]
-    end
+      # Calculate window perimeter for frame calculations.
+      @attributes.compile_window_perimeter
 
-    @carbon_report["total"] = total_emissions
-    return @carbon_report
-  end
+      @attributes.surface_types.each do |surface_type|
+        unless @attributes.surface_types_to_assembly_tallies[surface_type].empty?
+          @attributes.surface_types_to_assembly_tallies[surface_type].each_pair do |assembly_name, tallies|
+            total_area         = tallies["area"]
+            construction       = @attributes.constructions[assembly_name]
+            rsi                = construction["rsi"]
+            surface_is_glazing = surface_type =~ /Window/
+
+            # Factor in window frame emissions if this is a glazing
+            # construction. Currently we only have data for fixed and operable
+            # windows.
+            if surface_is_glazing
+              carbon_range_array = construction["subsets"].map { |subset|
+                [subset["rsi"], subset["carbon"] + emissions_from_window_frame(subset, tallies["perimeter"])] }
+            else
+              carbon_range_array = construction["subsets"].map { |subset| [subset["rsi"], subset["carbon"]] }
+            end
+
+            emissions, _ = BTAP::LinearRegression.interpolate(x_y_array: carbon_range_array, x2: rsi)
+
+            # Calculate the carbon emissions for the surface type and append the
+            # result to the total emissions.
+            @carbon_report["#{@attributes.surface_types_to_snake[surface_type]}_carbon"]        = emissions
+            @carbon_report["#{@attributes.surface_types_to_snake[surface_type]}_area_m2"]       = total_area
+            @carbon_report["#{@attributes.surface_types_to_snake[surface_type]}_carbon_per_m2"] = (
+              @carbon_report["#{@attributes.surface_types_to_snake[surface_type]}_carbon"] /
+              @carbon_report["#{@attributes.surface_types_to_snake[surface_type]}_area_m2"])
+
+            total_emissions += emissions * total_area
+          end
+        end
+      end
 
-  # Retrieve the carbon emissions given a surface, its construction, and its area.
-  def get_carbon_emissions(construction, surface, surface_area)
-    total_emissions  = 0.0
-    materials_file   = "materials_#{construction["type"]}"
-    id_column        = materials_file + "_id"
-    id_layers_column = "material_#{construction["type"]}_id_layers"
+      # Get the total emissions from all the surface types.
+      @attributes.surface_types.each do |surface_type|
+        total_emissions += @carbon_report["#{@attributes.surface_types_to_snake[surface_type]}_carbon"]
+      end
 
-    construction[id_layers_column].split(',').each do |material_id|
+      # Add the embodied carbon tallied from TBD which tallies carbon emissions
+      # of items that aren't explicitly modeled
+      structure_carbon = @attributes.model.getBuilding.additionalProperties.getFeatureAsDouble("co2_structure").get
+      @carbon_report["structure_carbon"] = structure_carbon.round(2)
+      total_emissions += structure_carbon
+
+      # Factor in parapets likewise for costing in `envelope_costing.rb`.
+      if @attributes.use_tbd
+        wall_carbon_per_m2 = @carbon_report["exterior_wall_carbon_per_m2"]
+        parapet_carbon = @attributes.tbd_edge_tallies["parapet"].values.first * wall_carbon_per_m2
+        @carbon_report["parapet_carbon"] = parapet_carbon.round(2)
+        total_emissions += parapet_carbon
+      end
 
-      # Locate the material entry in the carbon database
-      material_carbon = @carbon_database[construction["type"]].find { |row| 
-        row[id_column] == material_id }["Embodied Carbon (A-C)"]
+      puts "Warning: Interpolation limits exceeded." if BTAP::LinearRegression.extrapolation_boundaries_exceeded?
 
-      if material_carbon.nil?
-        raise("Error: Could not find material with ID #{material_id} in the carbon database.")
+      # Round everything at the end.
+      @attributes.surface_types.each do |surface_type|
+        @carbon_report["#{@attributes.surface_types_to_snake[surface_type]}_carbon"] = \
+          @carbon_report["#{@attributes.surface_types_to_snake[surface_type]}_carbon"].round(2)
+        @carbon_report["#{@attributes.surface_types_to_snake[surface_type]}_area_m2"] = \
+          @carbon_report["#{@attributes.surface_types_to_snake[surface_type]}_area_m2"].round(2)
+        @carbon_report["#{@attributes.surface_types_to_snake[surface_type]}_carbon_per_m2"] = \
+          @carbon_report["#{@attributes.surface_types_to_snake[surface_type]}_carbon_per_m2"].round(2)
       end
 
-      # If the material is glazing, the frame must be calculated by retrieving the perimeter of the window
-      # and converting according to the correct attributes of the window.
-      if construction["type"] == "glazing"
-        fenestration_type = construction["fenestration_type"]
+      puts "\nEmbodied carbon data successfully generated. Total embodied carbon emissions is " \
+           "#{total_emissions.to_f.round(2)} kg/m^2"
+      @carbon_report["total"] = total_emissions
+      return @carbon_report
+    end
 
-        # Skip skylights and doors since we don't have the data for them.
-        # Only consider fixed and operable windows.
-        if fenestration_type != "FixedWindow" and fenestration_type != "OperableWindow"
-          puts "Fenestration type #{fenestration_type} is not defined for carbon calculation, skipping this component."
-          next
-        end
+    # Retrieve the carbon emissions given a construction.
+    #
+    # @param construction [Hash]
+    # @param type [String] either "opaque" or "glazing"
+    # @return [Float]
+    def emissions_from_construction(construction, type)
+      total_emissions  = 0.0
+      materials_file   = "materials_#{type}"
+      id_column        = materials_file + "_id"
+
+      construction["id_layers"].each do |material_id|
+        material_entry = get_material_entry(material_id, id_column, type)
+        next if material_entry.nil?
+        material_emissions  = material_entry["Embodied Carbon (A-C)"]
+        total_emissions += material_emissions
+      end
 
-        material_frame = @carbon_database["frame"].find { |row|
-          row[id_column] == material_id }["Embodied Carbon (A-C)"]
+      return total_emissions
+    end
 
-        # Get the materials_glazing entry from the costing database to access the number of panes the window has.
-        material_costing = @costing_database["raw"][materials_file].find { |row| row[id_column] == material_id }
+    # Retrieve the carbon emissions for window frames. This requires its surface,
+    # its construction, and its perimeter.
+    #
+    # @param construction [Hash]
+    # @param Perimeter    [Float]
+    # @return [Float]
+    def emissions_from_window_frame(construction, perimeter)
+      fenestration_type = construction["fenestration_type"]
+
+      # Skip skylights and doors since we don't have the data for them.
+      # Only consider fixed and operable windows.
+      if fenestration_type != "FixedWindow" and fenestration_type != "OperableWindow"
+        puts "Warning: #{construction["name"]} is not available for carbon calculation, returning zero."
+        return 0.0
+      end
 
-        if material_costing.nil?
-          raise("Error: Could not find material with ID #{material_id} in the costing database.")
-        end
+      frame_emissions              = 0.0
+      frame_material               = construction["frame_material"]
+      fenestration_number_of_panes = construction["fenestration_number_of_panes"]
 
-        fenestration_number_of_panes = material_costing["fenestration_number_of_panes"]
-
-        # Try to get the correct frame material. 
-        frame_material = nil
-        construction_component   = construction["component"].downcase
-        construction_description = construction["description"].downcase
-        ["vinyl-wood", "plastic", "aluminum"].each do |material|
-          if material in construction_component
-            frame_material = material
-            break
-          elsif material in construction_description
-            frame_material = material
-            break
-          end
-        end
+      construction["id_layers"].each do |material_id|
+        material_entry = get_material_entry(material_id, "materials_glazing_id", "frame")
+        next if material_entry.nil?
+        frame_emissions += material_entry["Embodied Carbon (A-C)"]
+      end
 
-        if frame_material.nil?
-          raise("Error: Could not find frame material for glazing ID #{material_id} in constructions_glazing.csv.")
-        end
+      # Get the conversion factor for the window frame and add it to the total emissions.
+      conversion_factor = @frame_m_to_kg[frame_material][fenestration_type][fenestration_number_of_panes]
+      return frame_emissions * perimeter * conversion_factor
+    end
 
-        # Get the conversion factor for the window frame and add it to the total emissions.
-        conversion_factor = @frame_m_to_kg[frame_material][fenestration_type][fenestration_number_of_panes] 
-        perimeter = BTAP::Geometry::Surfaces.getSurfacePerimeterFromVertices(vertices: surface.vertices)
-        total_emissions += material_frame * perimeter * conversion_factor
+    # Get a material entry from the carbon database.
+    #
+    # @param type [String] Name of the hash key.
+    def get_material_entry(id, id_column, materials_file)
+      material_entry = @carbon_database[materials_file].find { |row| row[id_column] == id }
+
+      if material_entry.nil?
+        # TODO: This will happen a lot because of the new thermal bridging entries
+        # as of nrcan_476. The carbon database needs to be updated. BTAP Carbon
+        # will not be very useful until then.
+        puts "Error: Could not find #{materials_file} material with ID #{id} in the carbon database. " \
+             "Skipping."
       end
 
-      total_emissions += material_carbon * surface_area
+      return material_entry
     end
-
-    return total_emissions
   end
 end