openstudio-load-flexibility-measures 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 537d8d5a9f2f9e508453d1e45d23cb5c7ee10b149a6df8b4df9e835b077a6bbf
-  data.tar.gz: bb9151db95b85b535e02fbf76383d4edb7e9a902de644afa0e1bf95e9cbf989b
+  metadata.gz: 678b5aacbeb51baa27c912b8691b2eaa2279ba92dbc96ebe0a9dd3f111a29c42
+  data.tar.gz: 12768b48601c478e3e6119d7aff9c1456c21ca4ded142561a061303839458aad
 SHA512:
-  metadata.gz: ac277da97b3f779204ebf87737c3e2fdd3f2eadc5943eb785c221d63e585ce5fe3cc3b49799d7612220bfd1337aa2f4b048167ee3c75f5917a152eae163fdddc
-  data.tar.gz: 8e89c3dbccfba007051aee78e7ca84071b522087b7956b423f9b188e3254b8d5c62da13ffcfd1929cdc4ef65c2cb885255044c14e77499a4c8c33779b8088137
+  metadata.gz: ef15d6c3b4900eda9ca4d128668a06e1dbf77335902a61732bd920cff9748f061bb907810c2a497ea0127e450d5d5f8b2a217d526d9fe85938b3743b36db20d6
+  data.tar.gz: 93e4dedd2bd79ef2d9b1254e3e78eebbf3bd949f18682b224219c468c04c22365d3a958cc917a8ec38157107aab0bd8c2c0bd811cf19e7816b734c21fa86f5b3

data/CHANGELOG.md

@@ -1,8 +1,14 @@
 # OpenStudio Load Flexibility Measures Gem
 
+## Version 0.3.2
+* Modify HPWH measure "simplified" option to automatically identify water heater objects without explicit user naming
+* Modify HPWH measure to improve integration with URBANopt workflow
+* Update HPWH measure documentation
+
 ## Version 0.3.1
 * Updated OS Extension dependency to 0.4.2
 * Updated OS Standards dependency to 0.2.13
+* Added Jenkins file for CI testing
 
 ## Version 0.3.0
 * Merged [#20](https://github.com/NREL/openstudio-load-flexibility-measures-gem/pull/20), 030 upgrade

data/lib/measures/add_hpwh/README.md

@@ -2,14 +2,12 @@
 
 ###### (Automatically generated documentation)
 
-# Add HPWH for Domestic Hot Water
+# 
 
 ## Description
-This measure adds or replaces existing domestic hot water heater with air source heat pump system and allows for the addition of multiple daily flexible control time windows. The heater/tank system may charge at maximum capacity up to an elevated temperature, or float without any heat addition for a specified timeframe down to a minimum tank temperature.
+
 
 ## Modeler Description
-This measure allows selection between three heat pump water heater modeling approaches in EnergyPlus.The user may select between the pumped-condenser or wrapped-condenser objects. They may also elect to use a simplified calculation which does not use the heat pump objects, but instead used an electric resistance heater and approximates the equivalent electrical input that would be required from a heat pump. This expedites simulation at the expense of accuracy. 
-The flexibility of the system is based on user-defined temperatures and times, which are converted into schedule objects. There are four flexibility options. (1) None: normal operation of the DHW system at a fixed tank temperature setpoint. (2) Charge - Heat Pump: the tank is charged to a maximum temperature using only the heat pump. (3) Charge - Electric: the tank is charged using internal electric resistance heaters to a maximum temperature. (4) Float: all heating elements are turned-off for a user-defined time period unless the tank temperature falls below a minimum value. The heat pump will be prioritized in a low tank temperature event, with the electric resistance heaters serving as back-up. 
 
 
 ## Measure Type
@@ -21,166 +19,8 @@ ModelMeasure
 ## Arguments
 
 
-### Remove existing water heater on selected loop
-
-**Name:** remove_wh,
-**Type:** Boolean,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-### Select hot water loop
-The water tank will be placed on the supply side of this loop.
-**Name:** loop,
-**Type:** Choice,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-### Select thermal zone
-This is where the water heater tank will be placed
-**Name:** zone,
-**Type:** Choice,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-### Select heat pump water heater type
-
-**Name:** type,
-**Type:** Choice,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-### Set hot water tank volume
-[gal]
-**Name:** vol,
-**Type:** Double,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-### Set heat pump heating capacity
-[kW]
-**Name:** cap,
-**Type:** Double,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-### Set heat pump rated COP (heating)
-
-**Name:** cop,
-**Type:** Double,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-### Set electric backup heating capacity
-[kW]
-**Name:** bu_cap,
-**Type:** Double,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-### Set maximum tank temperature
-[F]
-**Name:** max_temp,
-**Type:** Double,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-### Set minimum tank temperature during float
-[F]
-**Name:** min_temp,
-**Type:** Double,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-### Set deadband temperature difference between heat pump and electric backup
-[F]
-**Name:** db_temp,
-**Type:** Double,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-### Select reference tank setpoint temperature schedule
-
-**Name:** sched,
-**Type:** Choice,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-### Daily Flex Period 1:
-Applies every day in the full run period.
-**Name:** flex0,
-**Type:** Choice,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-### Use 24-Hour Format
-
-**Name:** flex_hrs0,
-**Type:** String,
-**Units:** ,
-**Required:** false,
-**Model Dependent:** false
-
-### Daily Flex Period 2:
-Applies every day in the full run period.
-**Name:** flex1,
-**Type:** Choice,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-### Use 24-Hour Format
-
-**Name:** flex_hrs1,
-**Type:** String,
-**Units:** ,
-**Required:** false,
-**Model Dependent:** false
-
-### Daily Flex Period 3:
-Applies every day in the full run period.
-**Name:** flex2,
-**Type:** Choice,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-### Use 24-Hour Format
-
-**Name:** flex_hrs2,
-**Type:** String,
-**Units:** ,
-**Required:** false,
-**Model Dependent:** false
-
-### Daily Flex Period 4:
-Applies every day in the full run period.
-**Name:** flex3,
-**Type:** Choice,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-### Use 24-Hour Format
-
-**Name:** flex_hrs3,
-**Type:** String,
-**Units:** ,
-**Required:** false,
-**Model Dependent:** false
 
 
+This measure does not have any user arguments
 
 

data/lib/measures/add_hpwh/measure.rb

@@ -87,36 +87,49 @@ class AddHphw < OpenStudio::Measure::ModelMeasure
 
     # create argument for removal of existing water heater tanks on selected loop
     remove_wh = OpenStudio::Measure::OSArgument.makeBoolArgument('remove_wh', true)
-    remove_wh.setDisplayName('Remove existing water heater on selected loop')
+    remove_wh.setDisplayName('Remove existing water heater?')
     remove_wh.setDescription('')
     remove_wh.setDefaultValue(true)
     args << remove_wh
 
-    # find available plant loops (heating)
-    loop_names = []
+    # find available water heaters and get default volume
+    if !model.getWaterHeaterMixeds.empty?
+      wheaters = model.getWaterHeaterMixeds
+    end
 
-    unless model.getPlantLoops.empty?
-      loops = model.getPlantLoops
-      loops.each do |lp|
-        unless lp.sizingPlant.loopType.empty?
-          next unless lp.sizingPlant.loopType.to_s == 'Heating'
-          loop_names << lp.name.to_s
-        end
+    default_vol = 80.0 # gallons
+    wh_names = ['All Water Heaters (Simplified Only)']
+    wheaters.each do |w|
+      if w.tankVolume.to_f > OpenStudio.convert(39, 'gal', 'm^3').to_f
+        wh_names << w.name.to_s
+        default_vol = [default_vol, (w.tankVolume.to_f / 0.0037854118).round(1)].max
       end
     end
 
-    loop_names << 'Error: No Service Water Loop Found' if loop_names.empty?
+    wh = OpenStudio::Measure::OSArgument.makeChoiceArgument('wh', wh_names, true)
+    wh.setDisplayName('Select 40+ gallon water heater to replace or augment')
+    wh.setDescription("All can only be used with the 'Simplified' model")
+    wh.setDefaultValue(wh_names[0])
+    args << wh
 
-    # create argument for loop selection
-    loop = OpenStudio::Measure::OSArgument.makeChoiceArgument('loop', loop_names.sort, true)
-    loop.setDisplayName('Select hot water loop')
-    loop.setDescription('The water tank will be placed on the supply side of this loop.')
-    loop.setDefaultValue(loop_names.sort[0])
-    args << loop
+    # create argument for hot water tank volume
+    vol = OpenStudio::Measure::OSArgument.makeDoubleArgument('vol', false)
+    vol.setDisplayName('Set hot water tank volume [gal]')
+    vol.setDescription('Enter 0 to use existing tank volume(s). Values less than 5 are treated as sizing multipliers.')
+    vol.setUnits('gal')
+    vol.setDefaultValue(0)
+    args << vol
+
+    # create argument for water heater type
+    type = OpenStudio::Measure::OSArgument.makeChoiceArgument('type',
+                                                              ['Simplified', 'PumpedCondenser', 'WrappedCondenser'], true)
+    type.setDisplayName('Select heat pump water heater type')
+    type.setDescription('')
+    type.setDefaultValue('Simplified')
+    args << type
 
     # find available spaces for heater location
     zone_names = []
-
     unless model.getThermalZones.empty?
       zones = model.getThermalZones
       zones.each do |zn|
@@ -126,46 +139,15 @@ class AddHphw < OpenStudio::Measure::ModelMeasure
     end
 
     zone_names << 'Error: No Thermal Zones Found' if zone_names.empty?
+    zone_names = ['N/A - Simplified'] + zone_names
 
     # create argument for thermal zone selection (location of water heater)
     zone = OpenStudio::Measure::OSArgument.makeChoiceArgument('zone', zone_names, true)
-    zone.setDisplayName('Select thermal zone')
-    zone.setDescription('This is where the water heater tank will be placed')
+    zone.setDisplayName('Select thermal zone for HP evaporator')
+    zone.setDescription("Does not apply to 'Simplified' cases")
     zone.setDefaultValue(zone_names[0])
     args << zone
 
-    # create argument for water heater type
-    type = OpenStudio::Measure::OSArgument.makeChoiceArgument('type',
-                                                              ['PumpedCondenser', 'WrappedCondenser', 'Simplified'], true)
-    type.setDisplayName('Select heat pump water heater type')
-    type.setDescription('')
-    type.setDefaultValue('PumpedCondenser')
-    args << type
-
-    # find largest current water heater volume - if any mixed tanks are already present. Default is 80 gal.
-    default_vol = 80.0 # gal
-
-    wheaters = if !model.getWaterHeaterMixeds.empty?
-                 model.getWaterHeaterMixeds
-               else
-                 []
-               end
-
-    unless wheaters.empty?
-      wheaters.each do |wh|
-        unless wh.tankVolume.empty?
-          default_vol = [default_vol, (wh.tankVolume.to_f / 0.0037854118).round(1)].max # convert m^3 to gal
-        end
-      end
-    end
-
-    # create argument for hot water tank volume
-    vol = OpenStudio::Measure::OSArgument.makeDoubleArgument('vol', true)
-    vol.setDisplayName('Set hot water tank volume')
-    vol.setDescription('[gal]')
-    vol.setDefaultValue(default_vol)
-    args << vol
-
     # create argument for heat pump capacity
     cap = OpenStudio::Measure::OSArgument.makeDoubleArgument('cap', true)
     cap.setDisplayName('Set heat pump heating capacity')
@@ -176,7 +158,7 @@ class AddHphw < OpenStudio::Measure::ModelMeasure
     # create argument for heat pump rated cop
     cop = OpenStudio::Measure::OSArgument.makeDoubleArgument('cop', true)
     cop.setDisplayName('Set heat pump rated COP (heating)')
-    cop.setDefaultValue(2.8)
+    cop.setDefaultValue(3.2)
     args << cop
 
     # create argument for electric backup capacity
@@ -289,13 +271,13 @@ class AddHphw < OpenStudio::Measure::ModelMeasure
 
     # assign the user inputs to variables
     remove_wh = runner.getBoolArgumentValue('remove_wh', user_arguments)
-    loop = runner.getStringArgumentValue('loop', user_arguments)
-    zone = runner.getStringArgumentValue('zone', user_arguments)
+    wh = runner.getStringArgumentValue('wh', user_arguments)
+    vol = runner.getDoubleArgumentValue('vol', user_arguments)
     type = runner.getStringArgumentValue('type', user_arguments)
+    zone = runner.getStringArgumentValue('zone', user_arguments)
     cap = runner.getDoubleArgumentValue('cap', user_arguments)
     cop = runner.getDoubleArgumentValue('cop', user_arguments)
     bu_cap = runner.getDoubleArgumentValue('bu_cap', user_arguments)
-    vol = runner.getDoubleArgumentValue('vol', user_arguments)
     max_temp = runner.getDoubleArgumentValue('max_temp', user_arguments)
     min_temp = runner.getDoubleArgumentValue('min_temp', user_arguments)
     db_temp = runner.getDoubleArgumentValue('db_temp', user_arguments)
@@ -306,15 +288,6 @@ class AddHphw < OpenStudio::Measure::ModelMeasure
       flex_hrs << runner.getStringArgumentValue('flex_hrs' + n.to_s, user_arguments)
     end
 
-    # check for error inputs
-    if loop.include?('Error')
-      runner.registerError('No service hot water loop was found. Measure did not run.')
-    end
-
-    if zone.include?('Error')
-      runner.registerError('No thermal zone was found. Measure did not run.')
-    end
-
     # check capacity, volume, and temps for reasonableness
     if cap < 5
       runner.registerWarning('HPWH heating capacity is less than 5kW ( 17kBtu/hr)')
@@ -324,7 +297,9 @@ class AddHphw < OpenStudio::Measure::ModelMeasure
       runner.registerWarning('Backup heating capaicty is less than 5kW ( 17kBtu/hr).')
     end
 
-    if vol < 40
+    if vol == 0
+      runner.registerInfo('Tank volume was not specified, using existing tank capacity.')
+    elsif vol < 40
       runner.registerWarning('Tank has less than 40 gallon capacity; check heat pump sizing if model fails.')
     end
 
@@ -334,15 +309,15 @@ class AddHphw < OpenStudio::Measure::ModelMeasure
                             'conditions facilitate the growth of Legionella.')
     end
 
-    if max_temp > 180
-      runner.registerWarning('Maximum charging temperature exceeded practical limits; reset to 180F.')
-      max_temp = 180.0
+    if max_temp > 185
+      runner.registerWarning('Maximum charging temperature exceeded practical limits; reset to 185F.')
+      max_temp = 185.0
     end
 
-    if max_temp > 160
+    if max_temp > 170
       runner.registerWarning("#{max_temp}F is above or near the limit of the HP performance curves. If the " \
                             'simulation fails with cooling capacity less than 0, you have exceeded performance ' \
-                            'limits. Consider setting max temp to less than 160F.')
+                            'limits. Consider setting max temp to less than 170F.')
     end
 
     # check selected schedule and set flag for later use
@@ -483,7 +458,7 @@ class AddHphw < OpenStudio::Measure::ModelMeasure
       idx += 1
     end
 
-    ## CONTROLS: TANK TEMPERATURE SETPOINT SCHEDULE (ELECTRIC BACKUP) --------------------------------------------------
+    ## END CONTROLS: TANK TEMPERATURE SETPOINT SCHEDULE (ELECTRIC BACKUP) ----------------------------------------------
 
     ## HARDWARE --------------------------------------------------------------------------------------------------------
     # This section adds the selected type of heat pump water heater to the supply side of the selected loop. If
@@ -493,99 +468,122 @@ class AddHphw < OpenStudio::Measure::ModelMeasure
     # use OS standards build - arbitrary selection, but NZE Ready seems appropriate
     std = Standard.build('NREL ZNE Ready 2017')
 
-    # create empty arrays and initialize variables for later use
-    old_heater = []
-    count = 0
-
-    # convert loop and zone names from STRINGS into OS model OBJECTS
-    zone =  model.getThermalZoneByName(zone).get
-    loop =  model.getPlantLoopByName(loop).get
-
-    # find and locate old water heater on selected loop, if applicable
-    loop_equip = loop.supplyComponents
-    loop_equip.each do |le|
-      if le.iddObject.name.include?('WaterHeater:Mixed')
-        old_heater << model.getWaterHeaterMixedByName(le.name.to_s).get
-        count += 1
-      elsif le.iddObject.name.include?('WaterHeater:Stratified')
-        old_heater << model.getWaterHeaterStratifiedByName(le.name.to_s).get
-        count += 1
+    #####
+    # get the selected water heaters
+    whtrs = []
+    model.getWaterHeaterMixeds.each do |w|
+      if wh == 'All Water Heaters (Simplified Only)'
+        # exclude booster tanks (<10gal):
+        if w.tankVolume.to_f < 0.037854
+          next
+        else
+          whtrs << w
+        end
+      elsif w.name.to_s == wh
+        whtrs << w
       end
     end
 
-    unless old_heater.empty?
-      inlet = old_heater[0].supplyInletModelObject.get.to_Node.get
-      outlet = old_heater[0].supplyOutletModelObject.get.to_Node.get
-    end
+    whtrs.each do |wh|
+      # create empty arrays and initialize variables for later use
+      old_heater = []
+      count = 0
 
-    # Add heat pump water heater and attach to selected loop
-    # Reference: https://github.com/NREL/openstudio-standards/blob/master/lib/
-    # => openstudio-standards/prototypes/common/objects/Prototype.ServiceWaterHeating.rb
-    if type != 'Simplified'
-      hpwh = std.model_add_heatpump_water_heater(model, # model
-                                                 type: type,                                                           # type
-                                                 water_heater_capacity: (cap * 1000 / cop),                            # water_heater_capacity
-                                                 electric_backup_capacity: (bu_cap * 1000),                            # electric_backup_capacity
-                                                 water_heater_volume: OpenStudio.convert(vol, 'gal', 'm^3').get,       # water_heater_volume
-                                                 service_water_temperature: OpenStudio.convert(140.0, 'F', 'C').get,   # service_water_temperature
-                                                 parasitic_fuel_consumption_rate: 3.0,                                 # parasitic_fuel_consumption_rate
-                                                 swh_temp_sch: sched,                                                  # swh_temp_sch
-                                                 cop: cop,                                                             # cop
-                                                 shr: 0.88,                                                            # shr
-                                                 tank_ua: 3.9,                                                         # tank_ua
-                                                 set_peak_use_flowrate: false,                                         # set_peak_use_flowrate
-                                                 peak_flowrate: 0.0,                                                   # peak_flowrate
-                                                 flowrate_schedule: nil,                                               # flowrate_schedule
-                                                 water_heater_thermal_zone: zone)                                      # water_heater_thermal_zone
-    else
-      hpwh = std.model_add_water_heater(model, # model
-                                        (cap * 1000),                                                         # water_heater_capacity
-                                        OpenStudio.convert(vol, 'gal', 'm^3').get,                            # water_heater_volume
-                                        'HeatPump',                                                           # water_heater_fuel
-                                        OpenStudio.convert(140.0, 'F', 'C').get,                              # service_water_temperature
-                                        3.0,                                                                  # parasitic_fuel_consumption_rate
-                                        sched,                                                                # swh_temp_sch
-                                        false,                                                                # set_peak_use_flowrate
-                                        0.0,                                                                  # peak_flowrate
-                                        nil,                                                                  # flowrate_schedule
-                                        zone,                                                                 # water_heater_thermal_zone
-                                        1)                                                                    # number_water_heaters
-    end
+      # get the appropriate plant loop
+      loop = ''
+      loops = model.getPlantLoops
+      loops.each do |l|
+        l.supplyComponents.each do |c|
+          if c.name.to_s == wh.name.to_s
+            loop = l
+          end
+        end
+      end
 
-    # add tank to appropriate branch and node (will be placed first in series if old tanks not removed)
-    # modify objects as ncessary
-    if old_heater.empty?
-      loop.addSupplyBranchForComponent(hpwh.tank)
-    elsif type != 'Simplified'
-      hpwh.tank.addToNode(inlet)
-      hpwh.setDeadBandTemperatureDifference(db_temp / 1.8)
-      runner.registerInfo("#{hpwh.tank.name} was added to the model on #{loop.name}")
-    else
-      hpwh.addToNode(inlet)
-      hpwh.setMaximumTemperatureLimit(OpenStudio.convert(max_temp, 'F', 'C').get)
-      runner.registerInfo("#{hpwh.name} was added to the model on #{loop.name}")
-    end
+      # use existing tank volume unless otherwise specified
+      # values between 0.0 and 5.0 are considered tank sizing multipliers
+      if vol == 0
+        v = wh.tankVolume
+      elsif (vol > 0.0) && (vol < 5.0)
+        v = wh.tankVolume.to_f * vol
+      else
+        v = OpenStudio.convert(vol, 'gal', 'm^3').get
+      end
 
-    # remove old tank objects if necessary
-    if remove_wh
-      old_heater.each do |oh|
-        runner.registerInfo("#{oh.name} was removed from the model.")
-        oh.remove
+      inlet = wh.supplyInletModelObject.get.to_Node.get
+      outlet = wh.supplyOutletModelObject.get.to_Node.get
+
+      # Add heat pump water heater and attach to selected loop
+      # Reference: https://github.com/NREL/openstudio-standards/blob/master/lib/
+      # => openstudio-standards/prototypes/common/objects/Prototype.ServiceWaterHeating.rb
+      if type != 'Simplified'
+        # convert zone name from STRING into OS model OBJECT
+        zone = model.getThermalZoneByName(zone).get
+        hpwh = std.model_add_heatpump_water_heater(model, # model
+                                                   type: type,                                                           # type
+                                                   water_heater_capacity: (cap * 1000 / cop),                            # water_heater_capacity
+                                                   electric_backup_capacity: (bu_cap * 1000),                            # electric_backup_capacity
+                                                   water_heater_volume: v,                                               # water_heater_volume
+                                                   service_water_temperature: OpenStudio.convert(140.0, 'F', 'C').get,   # service_water_temperature
+                                                   parasitic_fuel_consumption_rate: 3.0,                                 # parasitic_fuel_consumption_rate
+                                                   swh_temp_sch: sched,                                                  # swh_temp_sch
+                                                   cop: cop,                                                             # cop
+                                                   shr: 0.88,                                                            # shr
+                                                   tank_ua: 3.9,                                                         # tank_ua
+                                                   set_peak_use_flowrate: false,                                         # set_peak_use_flowrate
+                                                   peak_flowrate: 0.0,                                                   # peak_flowrate
+                                                   flowrate_schedule: nil,                                               # flowrate_schedule
+                                                   water_heater_thermal_zone: zone)                                      # water_heater_thermal_zone
+      else
+        # zone = wh.ambientTemperatureThermalZone.get
+        runner.registerWarning(wh.to_s)
+        hpwh = std.model_add_water_heater(model, # model
+                                          (cap * 1000),                                                         # water_heater_capacity
+                                          v.to_f,                                                               # water_heater_volume
+                                          'HeatPump',                                                           # water_heater_fuel
+                                          OpenStudio.convert(140.0, 'F', 'C').to_f,                             # service_water_temperature
+                                          3.0,                                                                  # parasitic_fuel_consumption_rate
+                                          sched,                                                                # swh_temp_sch
+                                          false,                                                                # set_peak_use_flowrate
+                                          0.0,                                                                  # peak_flowrate
+                                          nil,                                                                  # flowrate_schedule
+                                          model.getThermalZones[0], # water_heater_thermal_zone
+                                          1) # number_water_heaters
+        # set COP in PLF curve
+        cop_curve = hpwh.partLoadFactorCurve.get
+        cop_curve.setName(cop_curve.name.get.gsub('2.8', cop.to_s))
+        cop_curve.setCoefficient1Constant(cop)
+      end
+
+      # add tank to appropriate branch and node (will be placed first in series if old tanks not removed)
+      # modify objects as ncessary
+      if type != 'Simplified'
+        hpwh.tank.addToNode(inlet)
+        hpwh.setDeadBandTemperatureDifference(db_temp / 1.8)
+        runner.registerInfo("#{hpwh.tank.name} was added to the model on #{loop.name}")
+      else
+        hpwh.addToNode(inlet)
+        hpwh.setMaximumTemperatureLimit(OpenStudio.convert(max_temp, 'F', 'C').get)
+        runner.registerInfo("#{hpwh.name} was added to the model on #{loop.name}")
       end
-    end
-    ## END HARDWARE ----------------------------------------------------------------------------------------------------
 
-    ## CONTROLS MODIFICATIONS FOR TANK ---------------------------------------------------------------------------------
-    # apply schedule to tank
-    if type == 'PumpedCondenser'
-      hpwh.tank.to_WaterHeaterMixed.get.setSetpointTemperatureSchedule(tank_sched)
-    elsif type == 'WrappedCondenser'
-      hpwh.tank.to_WaterHeaterStratified.get.setHeater1SetpointTemperatureSchedule(tank_sched)
-      hpwh.tank.to_WaterHeaterStratified.get.setHeater2SetpointTemperatureSchedule(tank_sched)
-    elsif type == 'Simplified'
-      runner.registerInfo('Line 492 was used. Nothing done here yet... Check tank temperature schedules...')
+      # remove old tank objects if necessary
+      if remove_wh
+        runner.registerInfo("#{wh.name} was removed from the model.")
+        wh.remove
+      end
+
+      # CONTROLS MODIFICATIONS FOR TANK ---------------------------------------------------------------------------------
+      # apply schedule to tank
+      if type == 'PumpedCondenser'
+        hpwh.tank.to_WaterHeaterMixed.get.setSetpointTemperatureSchedule(tank_sched)
+      elsif type == 'WrappedCondenser'
+        hpwh.tank.to_WaterHeaterStratified.get.setHeater1SetpointTemperatureSchedule(tank_sched)
+        hpwh.tank.to_WaterHeaterStratified.get.setHeater2SetpointTemperatureSchedule(tank_sched)
+      end
+      # END CONTROLS MODIFICATIONS FOR TANK -----------------------------------------------------------------------------
     end
-    ## END CONTROLS MODIFICATIONS FOR TANK -----------------------------------------------------------------------------
+    ## END HARDWARE ----------------------------------------------------------------------------------------------------
 
     ## ADD REPORTED VARIABLES ------------------------------------------------------------------------------------------
 

data/lib/measures/add_hpwh/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>add_hphw</name>
   <uid>518cde6f-1806-4b9a-bee9-ccaac49c7a53</uid>
-  <version_id>0a64fe16-eef8-4026-a3a6-45fa8dcad162</version_id>
-  <version_modified>20210317T134945Z</version_modified>
+  <version_id>1ddd139f-d267-4817-95c1-339d78c6594e</version_id>
+  <version_modified>20210512T163832Z</version_modified>
   <xml_checksum>A374667A</xml_checksum>
   <class_name>AddHphw</class_name>
   <display_name>Add HPWH for Domestic Hot Water</display_name>
@@ -18,6 +18,7 @@ The flexibility of the system is based on user-defined temperatures and times, w
       <display_name>Remove existing water heater on selected loop</display_name>
       <description></description>
       <type>Boolean</type>
+      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>true</default_value>
@@ -31,12 +32,15 @@ The flexibility of the system is based on user-defined temperatures and times, w
           <display_name>false</display_name>
         </choice>
       </choices>
+      <min_value></min_value>
+      <max_value></max_value>
     </argument>
     <argument>
       <name>loop</name>
       <display_name>Select hot water loop</display_name>
       <description>The water tank will be placed on the supply side of this loop.</description>
       <type>Choice</type>
+      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>Error: No Service Water Loop Found</default_value>
@@ -46,12 +50,15 @@ The flexibility of the system is based on user-defined temperatures and times, w
           <display_name>Error: No Service Water Loop Found</display_name>
         </choice>
       </choices>
+      <min_value></min_value>
+      <max_value></max_value>
     </argument>
     <argument>
       <name>zone</name>
       <display_name>Select thermal zone</display_name>
       <description>This is where the water heater tank will be placed</description>
       <type>Choice</type>
+      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>Error: No Thermal Zones Found</default_value>
@@ -61,15 +68,18 @@ The flexibility of the system is based on user-defined temperatures and times, w
           <display_name>Error: No Thermal Zones Found</display_name>
         </choice>
       </choices>
+      <min_value></min_value>
+      <max_value></max_value>
     </argument>
     <argument>
       <name>type</name>
       <display_name>Select heat pump water heater type</display_name>
       <description></description>
       <type>Choice</type>
+      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
-      <default_value>PumpedCondenser</default_value>
+      <default_value>Simplified</default_value>
       <choices>
         <choice>
           <value>PumpedCondenser</value>
@@ -84,74 +94,99 @@ The flexibility of the system is based on user-defined temperatures and times, w
           <display_name>Simplified</display_name>
         </choice>
       </choices>
+      <min_value></min_value>
+      <max_value></max_value>
     </argument>
     <argument>
       <name>vol</name>
       <display_name>Set hot water tank volume</display_name>
       <description>[gal]</description>
       <type>Double</type>
+      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>80</default_value>
+      <min_value></min_value>
+      <max_value></max_value>
     </argument>
     <argument>
       <name>cap</name>
       <display_name>Set heat pump heating capacity</display_name>
       <description>[kW]</description>
       <type>Double</type>
+      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>23.4</default_value>
+      <min_value></min_value>
+      <max_value></max_value>
     </argument>
     <argument>
       <name>cop</name>
       <display_name>Set heat pump rated COP (heating)</display_name>
+      <description></description>
       <type>Double</type>
+      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>2.8</default_value>
+      <min_value></min_value>
+      <max_value></max_value>
     </argument>
     <argument>
       <name>bu_cap</name>
       <display_name>Set electric backup heating capacity</display_name>
       <description>[kW]</description>
       <type>Double</type>
+      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>23.4</default_value>
+      <min_value></min_value>
+      <max_value></max_value>
     </argument>
     <argument>
       <name>max_temp</name>
       <display_name>Set maximum tank temperature</display_name>
       <description>[F]</description>
       <type>Double</type>
+      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>160</default_value>
+      <min_value></min_value>
+      <max_value></max_value>
     </argument>
     <argument>
       <name>min_temp</name>
       <display_name>Set minimum tank temperature during float</display_name>
       <description>[F]</description>
       <type>Double</type>
+      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>120</default_value>
+      <min_value></min_value>
+      <max_value></max_value>
     </argument>
     <argument>
       <name>db_temp</name>
       <display_name>Set deadband temperature difference between heat pump and electric backup</display_name>
       <description>[F]</description>
       <type>Double</type>
+      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>5</default_value>
+      <min_value></min_value>
+      <max_value></max_value>
     </argument>
     <argument>
       <name>sched</name>
       <display_name>Select reference tank setpoint temperature schedule</display_name>
       <description></description>
       <type>Choice</type>
+      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>--Create New @ 140F--</default_value>
@@ -161,12 +196,15 @@ The flexibility of the system is based on user-defined temperatures and times, w
           <display_name>--Create New @ 140F--</display_name>
         </choice>
       </choices>
+      <min_value></min_value>
+      <max_value></max_value>
     </argument>
     <argument>
       <name>flex0</name>
       <display_name>Daily Flex Period 1:</display_name>
       <description>Applies every day in the full run period.</description>
       <type>Choice</type>
+      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>None</default_value>
@@ -188,20 +226,27 @@ The flexibility of the system is based on user-defined temperatures and times, w
           <display_name>Float</display_name>
         </choice>
       </choices>
+      <min_value></min_value>
+      <max_value></max_value>
     </argument>
     <argument>
       <name>flex_hrs0</name>
       <display_name>Use 24-Hour Format</display_name>
+      <description></description>
       <type>String</type>
+      <units></units>
       <required>false</required>
       <model_dependent>false</model_dependent>
       <default_value>HH:MM - HH:MM</default_value>
+      <min_value></min_value>
+      <max_value></max_value>
     </argument>
     <argument>
       <name>flex1</name>
       <display_name>Daily Flex Period 2:</display_name>
       <description>Applies every day in the full run period.</description>
       <type>Choice</type>
+      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>None</default_value>
@@ -223,20 +268,27 @@ The flexibility of the system is based on user-defined temperatures and times, w
           <display_name>Float</display_name>
         </choice>
       </choices>
+      <min_value></min_value>
+      <max_value></max_value>
     </argument>
     <argument>
       <name>flex_hrs1</name>
       <display_name>Use 24-Hour Format</display_name>
+      <description></description>
       <type>String</type>
+      <units></units>
       <required>false</required>
       <model_dependent>false</model_dependent>
       <default_value>HH:MM - HH:MM</default_value>
+      <min_value></min_value>
+      <max_value></max_value>
     </argument>
     <argument>
       <name>flex2</name>
       <display_name>Daily Flex Period 3:</display_name>
       <description>Applies every day in the full run period.</description>
       <type>Choice</type>
+      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>None</default_value>
@@ -258,20 +310,27 @@ The flexibility of the system is based on user-defined temperatures and times, w
           <display_name>Float</display_name>
         </choice>
       </choices>
+      <min_value></min_value>
+      <max_value></max_value>
     </argument>
     <argument>
       <name>flex_hrs2</name>
       <display_name>Use 24-Hour Format</display_name>
+      <description></description>
       <type>String</type>
+      <units></units>
       <required>false</required>
       <model_dependent>false</model_dependent>
       <default_value>HH:MM - HH:MM</default_value>
+      <min_value></min_value>
+      <max_value></max_value>
     </argument>
     <argument>
       <name>flex3</name>
       <display_name>Daily Flex Period 4:</display_name>
       <description>Applies every day in the full run period.</description>
       <type>Choice</type>
+      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>None</default_value>
@@ -293,14 +352,20 @@ The flexibility of the system is based on user-defined temperatures and times, w
           <display_name>Float</display_name>
         </choice>
       </choices>
+      <min_value></min_value>
+      <max_value></max_value>
     </argument>
     <argument>
       <name>flex_hrs3</name>
       <display_name>Use 24-Hour Format</display_name>
+      <description></description>
       <type>String</type>
+      <units></units>
       <required>false</required>
       <model_dependent>false</model_dependent>
       <default_value>HH:MM - HH:MM</default_value>
+      <min_value></min_value>
+      <max_value></max_value>
     </argument>
   </arguments>
   <outputs />
@@ -376,12 +441,6 @@ The flexibility of the system is based on user-defined temperatures and times, w
       <usage_type>test</usage_type>
       <checksum>15E27276</checksum>
     </file>
-    <file>
-      <filename>README.md</filename>
-      <filetype>md</filetype>
-      <usage_type>readme</usage_type>
-      <checksum>1FE9503E</checksum>
-    </file>
     <file>
       <version>
         <software_program>OpenStudio</software_program>
@@ -391,7 +450,14 @@ The flexibility of the system is based on user-defined temperatures and times, w
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>F8FEB798</checksum>
+      <checksum>44E0C02B</checksum>
+    </file>
+    <file>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>0B68E96D</checksum>
     </file>
   </files>
 </measure>
+<error>undefined method `each' for nil:NilClass</error>

data/lib/measures/add_packaged_ice_storage/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>add_packaged_ice_storage</name>
   <uid>2aa8c128-53b9-49fd-9aaf-9253a1f05936</uid>
-  <version_id>1a0ab79e-1825-4418-a4ad-aec2194d4707</version_id>
-  <version_modified>20201208T224029Z</version_modified>
+  <version_id>c0df7e6f-d86f-4f80-875d-420a727dbf8a</version_id>
+  <version_modified>20210421T154438Z</version_modified>
   <xml_checksum>2617824F</xml_checksum>
   <class_name>AddPackagedIceStorage</class_name>
   <display_name>Add Packaged Ice Storage</display_name>
@@ -224,12 +224,6 @@ If 'AutoSize' is selected for ice capacity, these inputs set an ice capacity siz
       <usage_type>test</usage_type>
       <checksum>2D918464</checksum>
     </file>
-    <file>
-      <filename>README.md</filename>
-      <filetype>md</filetype>
-      <usage_type>readme</usage_type>
-      <checksum>A67F3738</checksum>
-    </file>
     <file>
       <version>
         <software_program>OpenStudio</software_program>
@@ -241,5 +235,11 @@ If 'AutoSize' is selected for ice capacity, these inputs set an ice capacity siz
       <usage_type>script</usage_type>
       <checksum>749A70A0</checksum>
     </file>
+    <file>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>E6FBC489</checksum>
+    </file>
   </files>
 </measure>

data/lib/openstudio/load_flexibility_measures/version.rb

@@ -35,6 +35,6 @@
 
 module OpenStudio
   module LoadFlexibilityMeasures
-    VERSION = '0.3.1'.freeze
+    VERSION = '0.3.2'.freeze
   end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: openstudio-load-flexibility-measures
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Karl Heine
 - Ryan Meyer
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-22 00:00:00.000000000 Z
+date: 2021-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -147,7 +147,7 @@ files:
 homepage: https://openstudio.net
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -162,8 +162,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: library and measures for OpenStudio for load flexibility applications.
 test_files: []