RubyGems - openstudio-calibration - Versions diffs - 0.1.2 - Mend

openstudio-calibration 0.1.2

Files changed (218) hide show

data/lib/measures/TimeseriesPlot/resources/report.html.erb ADDED Viewed

@@ -0,0 +1,270 @@
+<%
+  # *******************************************************************************
+  # 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.
+  # *******************************************************************************
+%>
+<!DOCTYPE html>
+<meta charset="utf-8">
+<style>
+svg {
+  font: 10px sans-serif;
+}
+.axis path,
+.axis line {
+  fill: none;
+  stroke: #000;
+  shape-rendering: crispEdges;
+}
+.brush .extent {
+  stroke: #fff;
+  fill-opacity: .125;
+  shape-rendering: crispEdges;
+}
+.xline {
+  stroke-width: 1;
+  fill: none;
+  clip-path: url(#clip);
+}
+</style>
+<title>Timeseries</title>
+<link href="http://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.2.0/css/bootstrap.css" rel="stylesheet">
+<script type="text/javascript" src="http://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
+<script type="text/javascript" src="http://cdnjs.cloudflare.com/ajax/libs/d3/3.3.9/d3.min.js"></script>
+<script src="http://d3js.org/d3.v3.min.js" charset="utf-8"></script>
+</head>
+<body>
+<div id="timeseriesplot" class="container">
+  <h1 id="plottitle">Timeseries Plot</h1>
+</div>
+<script>
+var allSeries = <%= all_series %>;
+// Set the overall plot heading
+$("#plottitle").text(allSeries[0].type);
+// Define size and margins of chart
+var margin = {top: 10, right: 350, bottom: 100, left: 40},
+    margin2 = {top: 430, right: 350, bottom: 20, left: 40},
+    width = 1500 - margin.left - margin.right,
+    height = 500 - margin.top - margin.bottom,
+    height2 = 500 - margin2.top - margin2.bottom;
+var parseDate = d3.time.format("%b %Y").parse;
+// Determine the bounds of the chart
+var x_min = new Date('January 1, 3000 00:00:00');
+var x_max = new Date('January 1, 1900 00:00:00');
+var y_min = Number.POSITIVE_INFINITY;
+var y_max = Number.NEGATIVE_INFINITY;
+$.each(allSeries, function(index, all_series) {
+  var series = allSeries[index];
+  this_x_min = d3.min(series.data.map(function(d) { return new Date(d.time); }))
+  this_x_max = d3.max(series.data.map(function(d) { return new Date(d.time); }))
+  this_y_min = d3.min(series.data.map(function(d) { return d.y; }))
+  this_y_max = d3.max(series.data.map(function(d) { return d.y; }))
+  if (this_x_min < x_min) x_min = this_x_min;
+  if (this_x_max > x_max) x_max = this_x_max;
+  if (this_y_min < y_min) y_min = this_y_min;
+  if (this_y_max > y_max) y_max = this_y_max;
+});
+// Log the bounds for debugging
+console.log("x_min = " + x_min)
+console.log("x_max = " + x_max)
+console.log("y_min = " + y_min)
+console.log("y_max = " + y_max)
+// Increase the y max by a little for readability
+y_max = y_max + ((y_max - y_min) * 0.25);
+// Horizontal axis scale
+var x_extent = [this.x_min, this.x_max];
+// Vertical axis scale
+var y_extent = [this.y_min, this.y_max];
+// Create the x and y scales (width on page) for both chart areas
+var x = d3.time.scale().range([0, width]),
+    x2 = d3.time.scale().range([0, width]),
+    y = d3.scale.linear().range([height, 0]),
+    y2 = d3.scale.linear().range([height2, 0]);
+// Create the x and y domains (extent of the data) for both chart areas
+x.domain(x_extent);
+y.domain(y_extent);
+x2.domain(x.domain());
+y2.domain(y.domain());
+// Create and position axes
+var xAxis = d3.svg.axis().scale(x).orient("bottom"),
+    xAxis2 = d3.svg.axis().scale(x2).orient("bottom"),
+    yAxis = d3.svg.axis().scale(y).orient("left"),
+    yAxis2 = d3.svg.axis().scale(y2).orient("left");
+// Create the selector
+var brush = d3.svg.brush()
+    .x(x2)
+    .on("brush", brushed);
+// Function to create lines in the focus area
+var line = d3.svg.line()
+    .x(function(d) { return x(new Date(d.time)); })
+    .y(function(d) { return y(d.y); });
+// Function to create lines in the context area
+var line2 = d3.svg.line()
+    .x(function(d) { return x2(new Date(d.time)); })
+    .y(function(d) { return y2(d.y); });
+// Create the overall SVG
+var svg = d3.select("#timeseriesplot").append("svg")
+    .attr("width", width + margin.left + margin.right)
+    .attr("height", height + margin.top + margin.bottom);
+svg.append("defs").append("clipPath")
+    .attr("id", "clip")
+  .append("rect")
+    .attr("width", width)
+    .attr("height", height);
+// Draw the focus section (main plot)
+var focus = svg.append("g")
+    .attr("class", "focus")
+    .attr("transform", "translate(" + margin.left + "," + margin.top + ")");
+// Draw the focus x and y axes
+focusaxis = focus.append("g")
+  .attr("class", "x axis")
+  .attr("transform", "translate(0," + height + ")")
+  .call(xAxis);
+focusaxis.append("text")
+      .text(allSeries[0].type + " [" + allSeries[0].units + "]")
+      .attr("transform", "rotate (-90, 0, 0) translate(" + (height / 5) + "," + (-1*(margin.left / 2 + 10)) + ")"); // TODO dynamically account for width of axis label to center
+focus.append("g")
+  .attr("class", "y axis")
+  .call(yAxis);
+// Draw the context section (selector)
+var context = svg.append("g")
+  .attr("class", "context")
+  .attr("transform", "translate(" + margin2.left + "," + margin2.top + ")");
+// Draw the context x axis
+context.append("g")
+  .attr("class", "x axis")
+  .attr("transform", "translate(0," + height2 + ")")
+  .call(xAxis2);
+// Draw the brush selector for the context
+context.append("g")
+    .attr("class", "x brush")
+    .call(brush)
+  .selectAll("rect")
+    .attr("y", -6)
+    .attr("height", height2 + 7);
+// Setup the spacing for the legends
+var legendSpacing = 25;
+// Create a legend for the data series
+var primlegend = focus.append("g")
+  .attr("class", "w axis")
+  .attr("transform", "translate(" + (width + 10) + ",0)");
+// TODO make series toggle-able
+primlegend.append("text").text("Series Names")
+  //.style("cursor", " pointer")
+  .attr("y", legendSpacing * 1)
+  .attr("class", "noselect");
+// Define the color scale
+var c20 = d3.scale.category20();
+c20.domain([1, allSeries.length]);
+// Plot each series
+var i = 1;
+$.each(allSeries, function(index, all_series) {
+  var series = allSeries[index];
+  // Generate a color
+  var lineColor = c20(i)
+  // Plot on the focus
+  focus.append("path")
+  .datum(series.data)
+  .attr("class", "xline")
+  .attr("d", line)
+  .style("stroke", lineColor);
+  // Plot on the context
+  // Note that line2 uses the x2 and y2 scales
+  context.append("path")
+  .datum(series.data)
+  .attr("class", "xline")
+  .attr("d", line2)
+  .style("stroke", lineColor);
+  // Add the series name to the legend
+  primlegend.append("text").text(series.name + " [" + series.units + "]")
+    .style("cursor", " pointer")
+    .attr("y", legendSpacing * (i + 1))
+    .attr("class", "noselect")
+    .style("fill", lineColor);
+  i += 1;
+});
+// Define what to do when the selector is moved around
+function brushed() {
+  console.log("Brushed")
+  x.domain(brush.empty() ? x2.domain() : brush.extent());
+  focus.selectAll(".xline").attr("d", line);
+  focus.selectAll(".x.axis").call(xAxis);
+}
+</script>

data/lib/measures/WaterHeaterMixedMultiplier/LICENSE.md ADDED Viewed

@@ -0,0 +1,27 @@
+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/WaterHeaterMixedMultiplier/README.md ADDED Viewed

@@ -0,0 +1,64 @@
+###### (Automatically generated documentation)
+# Water Heater Mixed Multiplier
+## Description
+This is a general purpose measure to calibrate WaterHeaterMixed with a Multiplier.
+## Modeler Description
+It will be used for calibration of WaterHeaterMixed. User can choose between a SINGLE WaterHeaterMixed or ALL the WaterHeaterMixed objects.
+## Measure Type
+ModelMeasure
+## Taxonomy
+## Arguments
+### Apply the Measure to a SINGLE WaterHeaterMixed, ALL the WaterHeaterMixeds or NONE.
+**Name:** water_heater,
+**Type:** Choice,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+### Multiplier for Heater Maximum Capacity.
+Multiplier for Heater Maximum Capacity.
+**Name:** maximum_capacity_multiplier,
+**Type:** Double,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+### Multiplier for Heater Minimum Capacity.
+Multiplier for Heater Minimum Capacity.
+**Name:** minimum_capacity_multiplier,
+**Type:** Double,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+### Multiplier for Thermal Efficiency.
+Multiplier for Thermal Efficiency.
+**Name:** thermal_efficiency_multiplier,
+**Type:** Double,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+### Heater Fuel Type.
+Heater Fuel Type.
+**Name:** fuel_type,
+**Type:** Choice,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false

data/lib/measures/WaterHeaterMixedMultiplier/README.md.erb ADDED Viewed

@@ -0,0 +1,42 @@
+<%#= 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/WaterHeaterMixedMultiplier/measure.rb ADDED Viewed

@@ -0,0 +1,255 @@
+# *******************************************************************************
+# 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 WaterHeaterMixedMultiplier < OpenStudio::Measure::ModelMeasure
+  # human readable name
+  def name
+    'Water Heater Mixed Multiplier'
+  end
+  # human readable description
+  def description
+    'This is a general purpose measure to calibrate WaterHeaterMixed with a Multiplier.'
+  end
+  # human readable description of modeling approach
+  def modeler_description
+    'It will be used for calibration of WaterHeaterMixed. User can choose between a SINGLE WaterHeaterMixed or ALL the WaterHeaterMixed objects.'
+  end
+  def change_name(object, maximum_capacity_multiplier, minimum_capacity_multiplier, thermal_efficiency_multiplier, fuel_type, orig_fuel_type)
+    nameString = object.name.get.to_s
+    if maximum_capacity_multiplier != 1.0
+      nameString += " #{maximum_capacity_multiplier.round(2)}x maxCap"
+    end
+    if minimum_capacity_multiplier != 1.0
+      nameString += " #{minimum_capacity_multiplier.round(2)}x minCap"
+    end
+    if thermal_efficiency_multiplier != 1.0
+      nameString += " #{thermal_efficiency_multiplier.round(2)}x thermEff"
+    end
+    nameString += " #{fuel_type} fuel Change" if orig_fuel_type != fuel_type
+    object.setName(nameString)
+  end
+  def check_multiplier(runner, multiplier)
+    if multiplier < 0
+      runner.registerError("Multiplier #{multiplier} cannot be negative.")
+      false
+    end
+  end
+  # define the arguments that the user will input
+  def arguments(model)
+    args = OpenStudio::Measure::OSArgumentVector.new
+    # make a choice argument for model objects
+    water_heater_handles = OpenStudio::StringVector.new
+    water_heater_display_names = OpenStudio::StringVector.new
+    # putting model object and names into hash
+    water_heater_args = model.getWaterHeaterMixeds
+    water_heater_args.each do |water_heater_arg|
+      water_heater_handles << water_heater_arg.handle.to_s
+      water_heater_display_names << water_heater_arg.name.to_s
+    end
+    # add building to string vector with space type
+    building = model.getBuilding
+    water_heater_handles << building.handle.to_s
+    water_heater_display_names << '*All WaterHeaterMixeds*'
+    water_heater_handles << '0'
+    water_heater_display_names << '*None*'
+    # make a choice argument for space type
+    water_heater = OpenStudio::Measure::OSArgument.makeChoiceArgument('water_heater', water_heater_handles, water_heater_display_names)
+    water_heater.setDisplayName('Apply the Measure to a SINGLE WaterHeaterMixed, ALL the WaterHeaterMixeds or NONE.')
+    water_heater.setDefaultValue('*All WaterHeaterMixeds*') # if no space type is chosen this will run on the entire building
+    args << water_heater
+    # maximum_capacity_multiplier
+    maximum_capacity_multiplier = OpenStudio::Measure::OSArgument.makeDoubleArgument('maximum_capacity_multiplier', true)
+    maximum_capacity_multiplier.setDisplayName('Multiplier for Heater Maximum Capacity.')
+    maximum_capacity_multiplier.setDescription('Multiplier for Heater Maximum Capacity.')
+    maximum_capacity_multiplier.setDefaultValue(1.0)
+    maximum_capacity_multiplier.setMinValue(0.0)
+    args << maximum_capacity_multiplier
+    # minimum_capacity_multiplier
+    minimum_capacity_multiplier = OpenStudio::Measure::OSArgument.makeDoubleArgument('minimum_capacity_multiplier', true)
+    minimum_capacity_multiplier.setDisplayName('Multiplier for Heater Minimum Capacity.')
+    minimum_capacity_multiplier.setDescription('Multiplier for Heater Minimum Capacity.')
+    minimum_capacity_multiplier.setDefaultValue(1.0)
+    args << minimum_capacity_multiplier
+    # thermal_efficiency_multiplier
+    thermal_efficiency_multiplier = OpenStudio::Measure::OSArgument.makeDoubleArgument('thermal_efficiency_multiplier', true)
+    thermal_efficiency_multiplier.setDisplayName('Multiplier for Thermal Efficiency.')
+    thermal_efficiency_multiplier.setDescription('Multiplier for Thermal Efficiency.')
+    thermal_efficiency_multiplier.setDefaultValue(1.0)
+    args << thermal_efficiency_multiplier
+    # make a choice argument for fuel type
+    fuel_type = OpenStudio::StringVector.new
+    fuel_type << 'NaturalGas'
+    fuel_type << 'Electricity'
+    fuel_type << 'PropaneGas'
+    # heater_fuel_type
+    heater_fuel_type = OpenStudio::Measure::OSArgument.makeChoiceArgument('fuel_type', fuel_type, fuel_type)
+    heater_fuel_type.setDisplayName('Heater Fuel Type.')
+    heater_fuel_type.setDescription('Heater Fuel Type.')
+    heater_fuel_type.setDefaultValue('NaturalGas')
+    args << heater_fuel_type
+    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
+    unless runner.validateUserArguments(arguments(model), user_arguments)
+      return false
+    end
+    # assign the user inputs to variables
+    water_heater_object = runner.getOptionalWorkspaceObjectChoiceValue('water_heater', user_arguments, model)
+    water_heater_handle = runner.getStringArgumentValue('water_heater', user_arguments)
+    fuel_type = runner.getStringArgumentValue('fuel_type', user_arguments)
+    thermal_efficiency_multiplier = runner.getDoubleArgumentValue('thermal_efficiency_multiplier', user_arguments)
+    check_multiplier(runner, thermal_efficiency_multiplier)
+    maximum_capacity_multiplier = runner.getDoubleArgumentValue('maximum_capacity_multiplier', user_arguments)
+    check_multiplier(runner, maximum_capacity_multiplier)
+    minimum_capacity_multiplier = runner.getDoubleArgumentValue('minimum_capacity_multiplier', user_arguments)
+    check_multiplier(runner, minimum_capacity_multiplier)
+    # find objects to change
+    water_heaters = []
+    building = model.getBuilding
+    building_handle = building.handle.to_s
+    runner.registerInfo("water_heater_handle: #{water_heater_handle}")
+    # setup water_heaters
+    if water_heater_handle == building_handle
+      # Use ALL SpaceTypes
+      runner.registerInfo('Applying change to ALL SpaceTypes')
+      water_heaters = model.getWaterHeaterMixeds
+    elsif water_heater_handle == 0.to_s
+      # SpaceTypes set to NONE so do nothing
+      runner.registerInfo('Applying change to NONE SpaceTypes')
+    elsif !water_heater_handle.empty?
+      # Single WaterHeaterMixed handle found, check if object is good
+      if !water_heater_object.get.to_WaterHeaterMixed.empty?
+        runner.registerInfo("Applying change to #{water_heater_object.get.name} WaterHeaterMixed")
+        water_heaters << water_heater_object.get.to_WaterHeaterMixed.get
+      else
+        runner.registerError("WaterHeaterMixed with handle #{water_heater_handle} could not be found.")
+      end
+    else
+      runner.registerError('WaterHeaterMixed handle is empty.')
+      return false
+    end
+    altered_heaters = []
+    altered_thermalefficiency = []
+    altered_max_cap = []
+    altered_min_cap = []
+    # report initial condition of model
+    runner.registerInitialCondition("Applying Multiplier to #{water_heaters.size} Water Heaters.")
+    # loop through space types
+    water_heaters.each do |water_heater|
+      altered_heater = false
+      # modify maximum_capacity_multiplier
+      if maximum_capacity_multiplier != 1.0
+        if water_heater.heaterMaximumCapacity.is_initialized
+          runner.registerInfo("Applying #{maximum_capacity_multiplier}x maximum capacity multiplier to #{water_heater.name.get}.")
+          water_heater.setHeaterMaximumCapacity(water_heater.heaterMaximumCapacity.get * maximum_capacity_multiplier)
+          altered_max_cap << water_heater.handle.to_s
+          altered_heater = true
+        end
+      end
+      # modify minimum_capacity_multiplier
+      if minimum_capacity_multiplier != 1.0
+        if water_heater.heaterMinimumCapacity.is_initialized
+          runner.registerInfo("Applying #{minimum_capacity_multiplier}x minimum capacity multiplier to #{water_heater.name.get}.")
+          water_heater.setHeaterMaximumCapacity(water_heater.heaterMinimumCapacity.get * minimum_capacity_multiplier)
+          altered_min_cap << water_heater.handle.to_s
+          altered_heater = true
+        end
+      end
+      # modify thermal_efficiency_multiplier
+      if thermal_efficiency_multiplier != 1.0
+        if water_heater.heaterThermalEfficiency.is_initialized
+          runner.registerInfo("Applying #{thermal_efficiency_multiplier}x thermal efficiency multiplier to #{water_heater.name.get}.")
+          water_heater.setHeaterThermalEfficiency(water_heater.heaterThermalEfficiency.get * thermal_efficiency_multiplier)
+          altered_thermalefficiency << water_heater.handle.to_s
+          altered_heater = true
+        end
+      end
+      orig_fuel_type = water_heater.heaterFuelType
+      if orig_fuel_type != fuel_type
+        runner.registerInfo("Changing Fuel Type to #{fuel_type} for #{water_heater.name.get}.")
+        water_heater.setHeaterFuelType(fuel_type)
+        altered_heater = true
+      end
+      next unless altered_heater
+      altered_heaters << water_heater.handle.to_s
+      change_name(water_heater, maximum_capacity_multiplier, minimum_capacity_multiplier, thermal_efficiency_multiplier, fuel_type, orig_fuel_type)
+      runner.registerInfo("WaterHeater name changed to: #{water_heater.name.get}")
+    end # end water_heater loop
+    # na if nothing in model to look at
+    if altered_heaters.empty?
+      runner.registerAsNotApplicable('No WaterHeaters were altered in the model')
+      return true
+    end
+    # report final condition of model
+    runner.registerFinalCondition("#{altered_heaters.size} WaterHeater objects were altered.")
+    true
+  end
+end
+# register the measure to be used by the application
+WaterHeaterMixedMultiplier.new.registerWithApplication