openstudio-common-measures 0.3.0 → 0.3.1

data/lib/measures/IncreaseInsulationRValueForExteriorWallsByPercentage/measure.xml

@@ -1,98 +0,0 @@
-<measure>
-  <schema_version>3.0</schema_version>
-  <name>increase_insulation_r_value_for_exterior_walls_by_percentage</name>
-  <uid>7508c563-22bd-49f4-b646-aac69b02a82d</uid>
-  <version_id>9ef20b5d-2bdd-417b-a5d9-b7f77d509133</version_id>
-  <version_modified>20200229T024318Z</version_modified>
-  <xml_checksum>EB1A0C08</xml_checksum>
-  <class_name>IncreaseInsulationRValueForExteriorWallsByPercentage</class_name>
-  <display_name>Increase R-value of Insulation for Exterior Walls By a Specified Percentage</display_name>
-  <description>Increase the R value of the insulation layer in wall constructinons by a percentage.</description>
-  <modeler_description>Insulation later is inferred by finding the existing layer with the highest thermal resistance.</modeler_description>
-  <arguments>
-    <argument>
-      <name>r_value</name>
-      <display_name>Percentage Increase of R-value for Exterior Wall Insulation.</display_name>
-      <type>Double</type>
-      <required>true</required>
-      <model_dependent>false</model_dependent>
-      <default_value>30</default_value>
-    </argument>
-  </arguments>
-  <outputs/>
-  <provenances/>
-  <tags>
-    <tag>Envelope.Opaque</tag>
-  </tags>
-  <attributes>
-    <attribute>
-      <name>Measure Function</name>
-      <value>Measure</value>
-      <datatype>string</datatype>
-    </attribute>
-    <attribute>
-      <name>Requires EnergyPlus Results</name>
-      <value>false</value>
-      <datatype>boolean</datatype>
-    </attribute>
-    <attribute>
-      <name>Measure Type</name>
-      <value>ModelMeasure</value>
-      <datatype>string</datatype>
-    </attribute>
-    <attribute>
-      <name>Uses SketchUp API</name>
-      <value>false</value>
-      <datatype>boolean</datatype>
-    </attribute>
-  </attributes>
-  <files>
-    <file>
-      <filename>EnvelopeAndLoadTestModel_01.osm</filename>
-      <filetype>osm</filetype>
-      <usage_type>test</usage_type>
-      <checksum>10AA8866</checksum>
-    </file>
-    <file>
-      <filename>ReverseTranslatedModel.osm</filename>
-      <filetype>osm</filetype>
-      <usage_type>test</usage_type>
-      <checksum>0B94403D</checksum>
-    </file>
-    <file>
-      <filename>README.md.erb</filename>
-      <filetype>erb</filetype>
-      <usage_type>readmeerb</usage_type>
-      <checksum>703C9964</checksum>
-    </file>
-    <file>
-      <filename>README.md</filename>
-      <filetype>md</filetype>
-      <usage_type>readme</usage_type>
-      <checksum>D4B90CE5</checksum>
-    </file>
-    <file>
-      <filename>LICENSE.md</filename>
-      <filetype>md</filetype>
-      <usage_type>license</usage_type>
-      <checksum>E0468DD6</checksum>
-    </file>
-    <file>
-      <version>
-        <software_program>OpenStudio</software_program>
-        <identifier>2.0.0</identifier>
-        <min_compatible>2.0.0</min_compatible>
-      </version>
-      <filename>measure.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>script</usage_type>
-      <checksum>478DC9B7</checksum>
-    </file>
-    <file>
-      <filename>IncreaseInsulationRValueForExteriorWalls_Test.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>test</usage_type>
-      <checksum>01E73CC1</checksum>
-    </file>
-  </files>
-</measure>

data/lib/measures/IncreaseInsulationRValueForRoofs/LICENSE.md

@@ -1,27 +0,0 @@
-OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC. All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification, are permitted 
-provided that the following conditions are met:
-
-(1) Redistributions of source code must retain the above copyright notice, this list of conditions 
-and the following disclaimer.
-
-(2) Redistributions in binary form must reproduce the above copyright notice, this list of conditions
-and the following disclaimer in the documentation and/or other materials provided with the distribution.
-
-(3) Neither the name of the copyright holder nor the names of any contributors may be used to endorse 
-or promote products derived from this software without specific prior written permission from the 
-respective party.
-
-(4) Other than as required in clauses (1) and (2), distributions in any form of modifications or other 
-derivative works may not use the "OpenStudio" trademark, "OS", "os", or any other confusingly similar 
-designation without specific prior written permission from Alliance for Sustainable Energy, LLC.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED 
-WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A 
-PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER, THE UNITED STATES GOVERNMENT, 
-OR ANY CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, 
-OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
-STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/lib/measures/IncreaseInsulationRValueForRoofs/README.md

@@ -1,64 +0,0 @@
-
-
-###### (Automatically generated documentation)
-
-# Increase R-value of Insulation for Roofs to a Specific Value
-
-## Description
-
-
-## Modeler Description
-
-
-## Measure Type
-ModelMeasure
-
-## Taxonomy
-
-
-## Arguments
-
-
-### Insulation R-value (ft^2*h*R/Btu).
-
-**Name:** r_value,
-**Type:** Double,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-### Allow both increase and decrease in R-value to reach requested target?
-
-**Name:** allow_reduction,
-**Type:** Boolean,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-### Increase in Material and Installation Costs for Construction per Area Used ($/ft^2).
-
-**Name:** material_cost_increase_ip,
-**Type:** Double,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-### One Time Retrofit Cost to Add Insulation to Construction ($/ft^2).
-
-**Name:** one_time_retrofit_cost_ip,
-**Type:** Double,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-### Year to Incur One Time Retrofit Cost (whole years).
-
-**Name:** years_until_retrofit_cost,
-**Type:** Integer,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-
-
-

data/lib/measures/IncreaseInsulationRValueForRoofs/README.md.erb

@@ -1,42 +0,0 @@
-<%#= README.md.erb is used to auto-generate README.md. %>
-<%#= To manually maintain README.md throw away README.md.erb and manually edit README.md %>
-###### (Automatically generated documentation)
-
-# <%= name %>
-
-## Description
-<%= description %>
-
-## Modeler Description
-<%= modelerDescription %>
-
-## Measure Type
-<%= measureType %>
-
-## Taxonomy
-<%= taxonomy %>
-
-## Arguments
-
-<% arguments.each do |argument| %>
-### <%= argument[:display_name] %>
-<%= argument[:description] %>
-**Name:** <%= argument[:name] %>,
-**Type:** <%= argument[:type] %>,
-**Units:** <%= argument[:units] %>,
-**Required:** <%= argument[:required] %>,
-**Model Dependent:** <%= argument[:model_dependent] %>
-<% end %>
-
-<% if arguments.size == 0 %>
-<%= "This measure does not have any user arguments" %>
-<% end %>
-
-<% if outputs.size > 0 %>
-## Outputs
-<% output_names = [] %>
-<% outputs.each do |output| %>
-<% output_names << output[:display_name] %>
-<% end %>
-<%= output_names.join(", ") %>
-<% end %>

data/lib/measures/IncreaseInsulationRValueForRoofs/measure.rb

@@ -1,422 +0,0 @@
-# *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
-# All rights reserved.
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
-#
-# (1) Redistributions of source code must retain the above copyright notice,
-# this list of conditions and the following disclaimer.
-#
-# (2) Redistributions in binary form must reproduce the above copyright notice,
-# this list of conditions and the following disclaimer in the documentation
-# and/or other materials provided with the distribution.
-#
-# (3) Neither the name of the copyright holder nor the names of any contributors
-# may be used to endorse or promote products derived from this software without
-# specific prior written permission from the respective party.
-#
-# (4) Other than as required in clauses (1) and (2), distributions in any form
-# of modifications or other derivative works may not use the "OpenStudio"
-# trademark, "OS", "os", or any other confusingly similar designation without
-# specific prior written permission from Alliance for Sustainable Energy, LLC.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS
-# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
-# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE
-# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
-# THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
-# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
-# OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
-# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
-# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-# *******************************************************************************
-
-# start the measure
-class IncreaseInsulationRValueForRoofs < OpenStudio::Measure::ModelMeasure
-  # define the name that a user will see
-  def name
-    return 'Increase R-value of Insulation for Roofs to a Specific Value'
-  end
-
-  # define the arguments that the user will input
-  def arguments(model)
-    args = OpenStudio::Measure::OSArgumentVector.new
-
-    # make an argument insulation R-value
-    r_value = OpenStudio::Measure::OSArgument.makeDoubleArgument('r_value', true)
-    r_value.setDisplayName('Insulation R-value (ft^2*h*R/Btu).')
-    r_value.setDefaultValue(30.0)
-    args << r_value
-
-    # make bool argument to allow both increase and decrease in R value
-    allow_reduction = OpenStudio::Measure::OSArgument.makeBoolArgument('allow_reduction', true)
-    allow_reduction.setDisplayName('Allow both increase and decrease in R-value to reach requested target?')
-    allow_reduction.setDefaultValue(false)
-    args << allow_reduction
-
-    # make an argument for material and installation cost
-    material_cost_increase_ip = OpenStudio::Measure::OSArgument.makeDoubleArgument('material_cost_increase_ip', true)
-    material_cost_increase_ip.setDisplayName('Increase in Material and Installation Costs for Construction per Area Used ($/ft^2).')
-    material_cost_increase_ip.setDefaultValue(0.0)
-    args << material_cost_increase_ip
-
-    # make an argument for demolition cost
-    one_time_retrofit_cost_ip = OpenStudio::Measure::OSArgument.makeDoubleArgument('one_time_retrofit_cost_ip', true)
-    one_time_retrofit_cost_ip.setDisplayName('One Time Retrofit Cost to Add Insulation to Construction ($/ft^2).')
-    one_time_retrofit_cost_ip.setDefaultValue(0.0)
-    args << one_time_retrofit_cost_ip
-
-    # make an argument for duration in years until costs start
-    years_until_retrofit_cost = OpenStudio::Measure::OSArgument.makeIntegerArgument('years_until_retrofit_cost', true)
-    years_until_retrofit_cost.setDisplayName('Year to Incur One Time Retrofit Cost (whole years).')
-    years_until_retrofit_cost.setDefaultValue(0)
-    args << years_until_retrofit_cost
-
-    return args
-  end
-
-  # define what happens when the measure is run
-  def run(model, runner, user_arguments)
-    super(model, runner, user_arguments)
-
-    # use the built-in error checking
-    if !runner.validateUserArguments(arguments(model), user_arguments)
-      return false
-    end
-
-    # assign the user inputs to variables
-    r_value = runner.getDoubleArgumentValue('r_value', user_arguments)
-    allow_reduction = runner.getBoolArgumentValue('allow_reduction', user_arguments)
-    material_cost_increase_ip = runner.getDoubleArgumentValue('material_cost_increase_ip', user_arguments)
-    one_time_retrofit_cost_ip = runner.getDoubleArgumentValue('one_time_retrofit_cost_ip', user_arguments)
-    years_until_retrofit_cost = runner.getIntegerArgumentValue('years_until_retrofit_cost', user_arguments)
-
-    # set limit for minimum insulation. This is used to limit input and for inferring insulation layer in construction.
-    min_expected_r_value_ip = 1 # ip units
-
-    # check the R-value for reasonableness
-    if (r_value < 0) || (r_value > 500)
-      runner.registerError("The requested roof insulation R-value of #{r_value} ft^2*h*R/Btu was above the measure limit.")
-      return false
-    elsif r_value > 60
-      runner.registerWarning("The requested roof insulation R-value of #{r_value} ft^2*h*R/Btu is abnormally high.")
-    elsif r_value < min_expected_r_value_ip
-      runner.registerWarning("The requested roof insulation R-value of #{r_value} ft^2*h*R/Btu is abnormally low.")
-    end
-
-    # check lifecycle arguments for reasonableness
-    if (years_until_retrofit_cost < 0) && (years_until_retrofit_cost > 100)
-      runner.registerError('Year to incur one time retrofit cost should be a non-negative integer less than or equal to 100.')
-    end
-
-    # short def to make numbers pretty (converts 4125001.25641 to 4,125,001.26 or 4,125,001). The definition be called through this measure
-    def neat_numbers(number, roundto = 2) # round to 0 or 2)
-      if roundto == 2
-        number = format '%.2f', number
-      else
-        number = number.round
-      end
-      # regex to add commas
-      number.to_s.reverse.gsub(/([0-9]{3}(?=([0-9])))/, '\\1,').reverse
-    end
-
-    # helper to make it easier to do unit conversions on the fly
-    def unit_helper(number, from_unit_string, to_unit_string)
-      converted_number = OpenStudio.convert(OpenStudio::Quantity.new(number, OpenStudio.createUnit(from_unit_string).get), OpenStudio.createUnit(to_unit_string).get).get.value
-    end
-
-    # convert r_value and material_cost to si for future use
-    r_value_si = unit_helper(r_value, 'ft^2*h*R/Btu', 'm^2*K/W')
-    material_cost_increase_si = unit_helper(material_cost_increase_ip, '1/ft^2', '1/m^2')
-
-    # create an array of roofs and find range of starting construction R-value (not just insulation layer)
-    surfaces = model.getSurfaces
-    exterior_surfaces = []
-    exterior_surface_constructions = []
-    exterior_surface_construction_names = []
-    roof_resistance = []
-    surfaces.each do |surface|
-      if (surface.outsideBoundaryCondition == 'Outdoors') && (surface.surfaceType == 'RoofCeiling')
-        exterior_surfaces << surface
-        roof_const = surface.construction.get
-        # only add construction if it hasn't been added yet
-        if !exterior_surface_construction_names.include?(roof_const.name.to_s)
-          exterior_surface_constructions << roof_const.to_Construction.get
-        end
-        exterior_surface_construction_names << roof_const.name.to_s
-        roof_resistance << 1 / roof_const.thermalConductance.to_f
-      end
-    end
-
-    # nothing will be done if there are no exterior surfaces
-    if exterior_surfaces.empty?
-      runner.registerAsNotApplicable('Model does not have any roofs.')
-      return true
-    end
-
-    # report strings for initial condition
-    initial_string = []
-    exterior_surface_constructions.uniq.each do |exterior_surface_construction|
-      # unit conversion of roof insulation from SI units (M^2*K/W) to IP units (ft^2*h*R/Btu)
-      initial_conductance_ip = unit_helper(1 / exterior_surface_construction.thermalConductance.to_f, 'm^2*K/W', 'ft^2*h*R/Btu')
-      initial_string << "#{exterior_surface_construction.name} (R-#{(format '%.1f', initial_conductance_ip)})"
-    end
-    runner.registerInitialCondition("The building had #{initial_string.size} roof constructions: #{initial_string.sort.join(', ')}.")
-
-    # hashes to track constructions and materials made by the measure, to avoid duplicates
-    constructions_hash_old_new = {}
-    constructions_hash_new_old = {} # used to get netArea of new construction and then cost objects of construction it replaced
-    materials_hash = {}
-
-    # array and counter for new constructions that are made, used for reporting final condition
-    final_constructions_array = []
-
-    # loop through all constructions and materials used on roofs, edit and clone
-    exterior_surface_constructions.each do |exterior_surface_construction|
-      construction_layers = exterior_surface_construction.layers
-      max_thermal_resistance_material = ''
-      max_thermal_resistance_material_index = ''
-      materials_in_construction = construction_layers.map.with_index do |layer, i|
-        { 'name' => layer.name.to_s,
-          'index' => i,
-          'nomass' => !layer.to_MasslessOpaqueMaterial.empty?,
-          'r_value' => layer.to_OpaqueMaterial.get.thermalResistance,
-          'mat' => layer }
-      end
-
-      no_mass_materials = materials_in_construction.select { |mat| mat['nomass'] == true }
-      # measure will select the no mass material with the highest r-value as the insulation layer
-      # if no mass materials are present, the measure will select the material with the highest r-value per inch
-      if !no_mass_materials.empty?
-        thermal_resistance_values = no_mass_materials.map { |mat| mat['r_value'] }
-        max_mat_hash = no_mass_materials.select { |mat| mat['r_value'] >= thermal_resistance_values.max }
-      else
-        thermal_resistance_per_thickness_values = materials_in_construction.map { |mat| mat['r_value'] / mat['mat'].thickness }
-        target_index = thermal_resistance_per_thickness_values.index(thermal_resistance_per_thickness_values.max)
-        max_mat_hash = materials_in_construction.select { |mat| mat['index'] == target_index }
-        thermal_resistance_values = materials_in_construction.map { |mat| mat['r_value'] }
-      end
-      max_thermal_resistance_material = max_mat_hash[0]['mat']
-      max_thermal_resistance_material_index = max_mat_hash[0]['index']
-      max_thermal_resistance = max_thermal_resistance_material.to_OpaqueMaterial.get.thermalResistance
-
-      if max_thermal_resistance <= unit_helper(min_expected_r_value_ip, 'ft^2*h*R/Btu', 'm^2*K/W')
-        runner.registerWarning("Construction '#{exterior_surface_construction.name}' does not appear to have an insulation layer and was not altered.")
-      elsif (max_thermal_resistance >= r_value_si) && !allow_reduction
-        runner.registerInfo("The insulation layer of construction #{exterior_surface_construction.name} exceeds the requested R-Value. It was not altered.")
-      else
-        # clone the construction
-        final_construction = exterior_surface_construction.clone(model)
-        final_construction = final_construction.to_Construction.get
-        final_construction.setName("#{exterior_surface_construction.name} adj roof insulation")
-        final_constructions_array << final_construction
-
-        # loop through lifecycle costs getting total costs under "Construction" or "Salvage" category and add to counter if occurs during year 0
-        const_LCCs = final_construction.lifeCycleCosts
-        cost_added = false
-        const_LCC_cat_const = false
-        updated_cost_si = 0
-        const_LCCs.each do |const_LCC|
-          if (const_LCC.category == 'Construction') && (material_cost_increase_si != 0)
-            const_LCC_cat_const = true # need this test to add proper lcc if it didn't exist to start with
-            # if multiple LCC objects associated with construction only adjust the cost of one of them.
-            if !cost_added
-              const_LCC.setCost(const_LCC.cost + material_cost_increase_si)
-            else
-              runner.registerInfo("More than one LifeCycleCost object with a category of Construction was associated with #{final_construction.name}. Cost was only adjusted for one of the LifeCycleCost objects.")
-            end
-            updated_cost_si += const_LCC.cost
-          end
-        end
-
-        if cost_added
-          runner.registerInfo("Adjusting material and installation cost for #{final_construction.name} to #{neat_numbers(unit_helper(updated_cost_si, '1/m^2', '1/ft^2'))} ($/ft^2).")
-        end
-
-        # add construction object if it didnt exist to start with and a cost increase was requested
-        if (const_LCC_cat_const == false) && (material_cost_increase_si != 0)
-          lcc_for_uncosted_const = OpenStudio::Model::LifeCycleCost.createLifeCycleCost('LCC_increase_insulation', final_construction, material_cost_increase_si, 'CostPerArea', 'Construction', 20, 0).get
-          runner.registerInfo("No material or installation costs existed for #{final_construction.name}. Created a new LifeCycleCost object with a material and installation cost of #{neat_numbers(unit_helper(lcc_for_uncosted_const.cost, '1/m^2', '1/ft^2'))} ($/ft^2). Assumed capitol cost in first year, an expected life of 20 years, and no O & M costs.")
-        end
-
-        # add one time cost if requested
-        if one_time_retrofit_cost_ip > 0
-          one_time_retrofit_cost_si = unit_helper(one_time_retrofit_cost_ip, '1/ft^2', '1/m^2')
-          lcc_retrofit_specific = OpenStudio::Model::LifeCycleCost.createLifeCycleCost('LCC_retrofit_specific', final_construction, one_time_retrofit_cost_si, 'CostPerArea', 'Construction', 0, years_until_retrofit_cost).get # using 0 for repeat period since one time cost.
-          runner.registerInfo("Adding one time cost of #{neat_numbers(unit_helper(lcc_retrofit_specific.cost, '1/m^2', '1/ft^2'))} ($/ft^2) related to retrofit of roof insulation.")
-        end
-
-        # push to hashes
-        constructions_hash_old_new[exterior_surface_construction.name.to_s] = final_construction
-        constructions_hash_new_old[final_construction] = exterior_surface_construction # push the object to hash key vs. name
-
-        # find already cloned insulation material and link to construction
-        target_material = max_thermal_resistance_material
-        found_material = false
-        materials_hash.each do |orig, new|
-          if target_material.name.to_s == orig
-            new_material = new
-            materials_hash[max_thermal_resistance_material.name.to_s] = new_material
-            final_construction.eraseLayer(max_thermal_resistance_material_index)
-            final_construction.insertLayer(max_thermal_resistance_material_index, new_material)
-            found_material = true
-          end
-        end
-
-        # clone and edit insulation material and link to construction
-        if found_material == false
-          new_material = max_thermal_resistance_material.clone(model)
-          new_material = new_material.to_OpaqueMaterial.get
-          new_material.setName("#{max_thermal_resistance_material.name}_R-value #{r_value} (ft^2*h*R/Btu)")
-          materials_hash[max_thermal_resistance_material.name.to_s] = new_material
-          final_construction.eraseLayer(max_thermal_resistance_material_index)
-          final_construction.insertLayer(max_thermal_resistance_material_index, new_material)
-          runner.registerInfo("For construction'#{final_construction.name}', material'#{new_material.name}' was altered.")
-
-          # edit insulation material
-          new_material_matt = new_material.to_Material
-          if !new_material_matt.empty?
-            starting_thickness = new_material_matt.get.thickness
-            target_thickness = starting_thickness * r_value_si / thermal_resistance_values.max
-            final_thickness = new_material_matt.get.setThickness(target_thickness)
-          end
-          new_material_massless = new_material.to_MasslessOpaqueMaterial
-          if !new_material_massless.empty?
-            final_thermal_resistance = new_material_massless.get.setThermalResistance(r_value_si)
-          end
-          new_material_airgap = new_material.to_AirGap
-          if !new_material_airgap.empty?
-            final_thermal_resistance = new_material_airgap.get.setThermalResistance(r_value_si)
-          end
-        end
-      end
-    end
-
-    # loop through construction sets used in the model
-    default_construction_sets = model.getDefaultConstructionSets
-    default_construction_sets.each do |default_construction_set|
-      if default_construction_set.directUseCount > 0
-        default_surface_const_set = default_construction_set.defaultExteriorSurfaceConstructions
-        if !default_surface_const_set.empty?
-          starting_construction = default_surface_const_set.get.roofCeilingConstruction
-
-          # creating new default construction set
-          new_default_construction_set = default_construction_set.clone(model)
-          new_default_construction_set = new_default_construction_set.to_DefaultConstructionSet.get
-          new_default_construction_set.setName("#{default_construction_set.name} adj roof insulation")
-
-          # create new surface set and link to construction set
-          new_default_surface_const_set = default_surface_const_set.get.clone(model)
-          new_default_surface_const_set = new_default_surface_const_set.to_DefaultSurfaceConstructions.get
-          new_default_surface_const_set.setName("#{default_surface_const_set.get.name} adj roof insulation")
-          new_default_construction_set.setDefaultExteriorSurfaceConstructions(new_default_surface_const_set)
-
-          # use the hash to find the proper construction and link to new_default_surface_const_set
-          target_const = new_default_surface_const_set.roofCeilingConstruction
-          if !target_const.empty?
-            target_const = target_const.get.name.to_s
-            found_const_flag = false
-            constructions_hash_old_new.each do |orig, new|
-              if target_const == orig
-                final_construction = new
-                new_default_surface_const_set.setRoofCeilingConstruction(final_construction)
-                found_const_flag = true
-              end
-            end
-            if found_const_flag == false # this should never happen but is just an extra test in case something goes wrong with the measure code
-              runner.registerWarning("Measure couldn't find the construction named '#{target_const}' in the exterior surface hash.")
-            end
-          end
-
-          # swap all uses of the old construction set for the new
-          construction_set_sources = default_construction_set.sources
-          construction_set_sources.each do |construction_set_source|
-            building_source = construction_set_source.to_Building
-            # if statement for each type of object than can use a DefaultConstructionSet
-            if !building_source.empty?
-              building_source = building_source.get
-              building_source.setDefaultConstructionSet(new_default_construction_set)
-            end
-            building_story_source = construction_set_source.to_BuildingStory
-            if !building_story_source.empty?
-              building_story_source = building_story_source.get
-              building_story_source.setDefaultConstructionSet(new_default_construction_set)
-            end
-            space_type_source = construction_set_source.to_SpaceType
-            if !space_type_source.empty?
-              space_type_source = space_type_source.get
-              space_type_source.setDefaultConstructionSet(new_default_construction_set)
-            end
-            space_source = construction_set_source.to_Space
-            if !space_source.empty?
-              space_source = space_source.get
-              space_source.setDefaultConstructionSet(new_default_construction_set)
-            end
-          end
-
-        end
-      end
-    end
-
-    # link cloned and edited constructions for surfaces with hard assigned constructions
-    exterior_surfaces.each do |exterior_surface|
-      if !exterior_surface.isConstructionDefaulted && !exterior_surface.construction.empty?
-
-        # use the hash to find the proper construction and link to surface
-        target_const = exterior_surface.construction
-        if !target_const.empty?
-          target_const = target_const.get.name.to_s
-          constructions_hash_old_new.each do |orig, new|
-            if target_const == orig
-              final_construction = new
-              exterior_surface.setConstruction(final_construction)
-            end
-          end
-        end
-
-      end
-    end
-
-    # report strings for final condition
-    final_string = [] # not all exterior roof constructions, but only new ones made. If  roof didn't have insulation and was not altered we don't want to show it
-    affected_area_si = 0
-    totalCost_of_affected_area = 0
-    yr0_capital_totalCosts = 0
-    final_constructions_array.each do |final_construction|
-      # unit conversion of roof insulation from SI units (M^2*K/W) to IP units (ft^2*h*R/Btu)
-      final_conductance_ip = unit_helper(1 / final_construction.thermalConductance.to_f, 'm^2*K/W', 'ft^2*h*R/Btu')
-      final_string << "#{final_construction.name} (R-#{(format '%.1f', final_conductance_ip)})"
-      affected_area_si += final_construction.getNetArea
-
-      # loop through lifecycle costs getting total costs under "Construction" or "Salvage" category and add to counter if occurs during year 0
-      const_LCCs = final_construction.lifeCycleCosts
-      const_LCCs.each do |const_LCC|
-        if (const_LCC.category == 'Construction') || (const_LCC.category == 'Salvage')
-          if const_LCC.yearsFromStart == 0
-            yr0_capital_totalCosts += const_LCC.totalCost
-          end
-        end
-      end
-    end
-
-    # add not applicable test if there were exterior roof constructions but non of them were altered (already enough insulation or doesn't look like insulated wall)
-    if affected_area_si == 0
-      runner.registerAsNotApplicable('No roofs were altered.')
-      return true
-      # affected_area_ip = affected_area_si
-    else
-      # ip construction area for reporting
-      affected_area_ip = unit_helper(affected_area_si, 'm^2', 'ft^2')
-    end
-
-    # report final condition
-    runner.registerFinalCondition("The existing insulation for roofs was changed to R-#{r_value}. This was accomplished for an initial cost of #{one_time_retrofit_cost_ip} ($/sf) and an increase of #{material_cost_increase_ip} ($/sf) for construction. This was applied to #{neat_numbers(affected_area_ip, 0)} (ft^2) across #{final_string.size} roof constructions: #{final_string.sort.join(', ')}.")
-
-    return true
-  end
-end
-
-# this allows the measure to be used by the application
-IncreaseInsulationRValueForRoofs.new.registerWithApplication