urbanopt-cli 0.4.1 → 0.6.1

data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/schedules.rb

@@ -63,7 +63,7 @@ class HourlyByMonthSchedule
   def calcMaxval()
     maxval = [@weekday_month_by_hour_values.flatten.max, @weekend_month_by_hour_values.flatten.max].max
     if maxval == 0.0
-      maxval == 1.0 # Prevent divide by zero
+      maxval = 1.0 # Prevent divide by zero
     end
     return maxval
   end
@@ -178,7 +178,7 @@ class MonthWeekdayWeekendSchedule
   # monthly_values can either be a comma-separated string of 12 numbers or a 12-element array of numbers.
   def initialize(model, sch_name, weekday_hourly_values, weekend_hourly_values, monthly_values,
                  schedule_type_limits_name = nil, normalize_values = true, begin_month = 1,
-                 begin_day_of_month = 1, end_month = 12, end_day_of_month = 31)
+                 begin_day = 1, end_month = 12, end_day = 31)
     @model = model
     @sch_name = sch_name
     @schedule = nil
@@ -187,9 +187,9 @@ class MonthWeekdayWeekendSchedule
     @monthly_values = validateValues(monthly_values, 12, 'monthly')
     @schedule_type_limits_name = schedule_type_limits_name
     @begin_month = begin_month
-    @begin_day_of_month = begin_day_of_month
+    @begin_day = begin_day
     @end_month = end_month
-    @end_day_of_month = end_day_of_month
+    @end_day = end_day
 
     if normalize_values
       @weekday_hourly_values = normalizeSumToOne(@weekday_hourly_values)
@@ -281,7 +281,7 @@ class MonthWeekdayWeekendSchedule
       maxval = @monthly_values.max * @weekend_hourly_values.max
     end
     if maxval == 0.0
-      maxval == 1.0 # Prevent divide by zero
+      maxval = 1.0 # Prevent divide by zero
     end
     return maxval
   end
@@ -311,7 +311,7 @@ class MonthWeekdayWeekendSchedule
     end
 
     num_days_in_each_month = [0, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
-    num_days_in_each_month[@end_month] = @end_day_of_month
+    num_days_in_each_month[@end_month] = @end_day
     num_days_in_each_month.each_index do |i|
       num_days_in_each_month[i] += leap_offset if i == 2
     end
@@ -320,7 +320,7 @@ class MonthWeekdayWeekendSchedule
       orig_day_startm[i] += leap_offset if i > 2
     end
     day_startm = orig_day_startm.map(&:clone)
-    day_startm[@begin_month] = orig_day_startm[@begin_month] + @begin_day_of_month - 1
+    day_startm[@begin_month] = orig_day_startm[@begin_month] + @begin_day - 1
     day_endm = [orig_day_startm, num_days_in_each_month].transpose.map { |i| (i != [0, 0]) ? i.reduce(:+) - 1 : 0 }
     time = []
     for h in 1..24
@@ -528,6 +528,7 @@ class HotWaterSchedule
       # with a minimum runtime in minutes.
       items.reverse.each_with_index do |val, i|
         next unless val > 0
+
         place = (items.length - 1) - i
         last = place + dryer_exhaust_min_runtime
         items.fill(1, place...last)
@@ -1085,7 +1086,7 @@ class SchedulesFile
     schedule_file.setColumnNumber(col_index + 1)
     schedule_file.setRowstoSkipatTop(rows_to_skip)
     schedule_file.setNumberofHoursofData(num_hrs_in_year.to_i)
-    schedule_file.setMinutesperItem("#{min_per_item.to_i}")
+    schedule_file.setMinutesperItem(min_per_item.to_i)
 
     return schedule_file
   end
@@ -1202,17 +1203,48 @@ class SchedulesFile
     return external_file
   end
 
-  def set_vacancy(col_names:)
+  def set_vacancy
     return unless @schedules.keys.include? 'vacancy'
     return if @schedules['vacancy'].all? { |i| i == 0 }
 
-    @schedules[col_names[0]].each_with_index do |ts, i|
-      col_names.each do |col_name|
+    col_names = ScheduleGenerator.col_names
+
+    @schedules[col_names.keys[0]].each_with_index do |ts, i|
+      col_names.keys.each do |col_name|
+        next unless col_names[col_name] # skip those unaffected by vacancy
+
         @schedules[col_name][i] *= (1.0 - @schedules['vacancy'][i])
       end
     end
 
-    update(col_names: col_names)
+    update(col_names: col_names.keys)
+  end
+
+  def set_outage(outage_start_date:,
+                 outage_end_date:)
+
+    minutes_per_step = 60
+    if @model.getSimulationControl.timestep.is_initialized
+      minutes_per_step = 60 / @model.getSimulationControl.timestep.get.numberOfTimestepsPerHour
+    end
+
+    col_names = ScheduleGenerator.col_names
+
+    sec_per_step = minutes_per_step * 60.0
+    col_names.each do |col_name, val|
+      next if col_name == 'occupants'
+      next if val.nil?
+
+      ts = Time.new(outage_start_date.year, 'Jan', 1)
+      @schedules[col_name].each_with_index do |step, i|
+        if outage_start_date <= ts && ts < outage_end_date # in the outage period
+          @schedules[col_name][i] = 0.0
+        end
+        ts += sec_per_step
+      end
+    end
+
+    update(col_names: col_names.keys)
   end
 
   def import(col_names:)
@@ -1247,9 +1279,14 @@ class SchedulesFile
     return false if @schedules_path.nil?
 
     # need to update schedules csv in generated_files folder (alongside run folder) since this is what the simulation points to
-    schedules_path = File.expand_path(File.join(File.dirname(@schedules_path), '../generated_files', File.basename(@schedules_path)))
+    begin
+      schedules_path = File.expand_path(File.join(File.dirname(@schedules_path), '../generated_files', File.basename(@schedules_path))) # called from cli
+      columns = CSV.read(schedules_path).transpose
+    rescue
+      schedules_path = File.expand_path(File.join(File.dirname(@schedules_path), '../../../files', File.basename(@schedules_path))) # testing
+      columns = CSV.read(schedules_path).transpose
+    end
 
-    columns = CSV.read(schedules_path).transpose
     col_names.each do |col_name|
       col_num = get_col_index(col_name: col_name)
       columns.each_with_index do |col, i|

data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/simcontrols.rb

@@ -1,16 +1,33 @@
 # frozen_string_literal: true
 
 class SimControls
-  def self.apply(model, header)
+  def self.apply(model, hpxml)
     sim = model.getSimulationControl
     sim.setRunSimulationforSizingPeriods(false)
 
     tstep = model.getTimestep
-    tstep.setNumberOfTimestepsPerHour(60 / header.timestep)
+    tstep.setNumberOfTimestepsPerHour(60 / hpxml.header.timestep)
 
     shad = model.getShadowCalculation
-    shad.setShadingCalculationUpdateFrequency(20)
     shad.setMaximumFiguresInShadowOverlapCalculations(200)
+    # Use EnergyPlus default of 20 days for update frequency; it is a reasonable balance
+    # between speed and accuracy (e.g., sun position, picking up any change in window
+    # interior shading transmittance, etc.).
+    shad.setShadingCalculationUpdateFrequency(20)
+
+    has_windows_varying_transmittance = false
+    hpxml.windows.each do |window|
+      sf_summer = window.interior_shading_factor_summer * window.exterior_shading_factor_summer
+      sf_winter = window.interior_shading_factor_winter * window.exterior_shading_factor_winter
+      next if sf_summer == sf_winter
+
+      has_windows_varying_transmittance = true
+    end
+    if has_windows_varying_transmittance
+      # Detailed diffuse algorithm is required for window interior shading with varying
+      # transmittance schedules
+      shad.setSkyDiffuseModelingAlgorithm('DetailedSkyDiffuseModeling')
+    end
 
     outsurf = model.getOutsideSurfaceConvectionAlgorithm
     outsurf.setAlgorithm('DOE-2')
@@ -25,9 +42,9 @@ class SimControls
     convlim.setMinimumSystemTimestep(0)
 
     run_period = model.getRunPeriod
-    run_period.setBeginMonth(header.sim_begin_month)
-    run_period.setBeginDayOfMonth(header.sim_begin_day_of_month)
-    run_period.setEndMonth(header.sim_end_month)
-    run_period.setEndDayOfMonth(header.sim_end_day_of_month)
+    run_period.setBeginMonth(hpxml.header.sim_begin_month)
+    run_period.setBeginDayOfMonth(hpxml.header.sim_begin_day)
+    run_period.setEndMonth(hpxml.header.sim_end_month)
+    run_period.setEndDayOfMonth(hpxml.header.sim_end_day)
   end
 end

data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/unit_conversions.rb

@@ -167,6 +167,8 @@ class UnitConversions
       return x + 273.15
     elsif key == ['f', 'c']
       return (x - 32.0) / 1.8
+    elsif key == ['f', 'k']
+      return (x - 32.0) / 1.8 + 273.15
     elsif key == ['f', 'r']
       return x + 459.67
     elsif key == ['k', 'c']

data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/validator.rb

@@ -1,37 +1,98 @@
 # frozen_string_literal: true
 
 class Validator
-  def self.run_validator(hpxml_doc, stron_path)
+  def self.run_validators(hpxml_doc, stron_paths)
     errors = []
+    warnings = []
+
+    context_elements_cache = {}
+    stron_paths.each do |stron_path|
+      error, warning = run_validator(hpxml_doc, stron_path, context_elements_cache)
+      errors += error
+      warnings += warning
+    end
+
+    return errors.uniq, warnings.uniq
+  end
+
+  private
+
+  def self.run_validator(hpxml_doc, stron_path, context_elements_cache)
+    errors = []
+    warnings = []
+
     doc = XMLHelper.parse_file(stron_path)
     XMLHelper.get_elements(doc, '/sch:schema/sch:pattern/sch:rule').each do |rule|
       context_xpath = XMLHelper.get_attribute_value(rule, 'context').gsub('h:', '')
 
-      begin
-        context_elements = hpxml_doc.xpath(context_xpath)
-      rescue
-        fail "Invalid xpath: #{context_xpath}"
-      end
+      context_elements = get_context_elements(hpxml_doc, context_xpath, context_elements_cache)
       next if context_elements.empty? # Skip if context element doesn't exist
 
-      XMLHelper.get_elements(rule, 'sch:assert').each do |assert_element|
-        assert_test = XMLHelper.get_attribute_value(assert_element, 'test').gsub('h:', '')
+      ['sch:assert', 'sch:report'].each do |element_name|
+        elements = XMLHelper.get_elements(rule, element_name)
+        elements.each do |element|
+          test_attr = XMLHelper.get_attribute_value(element, 'test').gsub('h:', '')
 
-        context_elements.each do |context_element|
-          begin
-            xpath_result = context_element.xpath(assert_test)
-          rescue
-            fail "Invalid xpath: #{assert_test}"
-          end
-          next if xpath_result # check if assert_test is false
+          context_elements.each do |context_element|
+            begin
+              xpath_result = context_element.xpath(test_attr)
+            rescue
+              fail "Invalid xpath: #{test_attr}"
+            end
+
+            if element_name == 'sch:assert'
+              next if xpath_result # check if assert_test is false
+
+              error_message = element.children.text # the value of sch:assert
+              extended_error_message = [error_message, "[context: #{context_xpath}]"].join(' ') # add context xpath to the error message
+              errors << extended_error_message
+            elsif element_name == 'sch:report'
+              next unless xpath_result # check if assert_test is true
 
-          assert_value = assert_element.children.text # the value of sch:assert
-          error_message = assert_value.gsub(': ', ": #{context_xpath}: ") # insert context xpath into the error message
-          errors << error_message
+              warning_message = element.children.text # the value of sch:report
+              warnings << warning_message
+            end
+          end
         end
       end
     end
 
-    return errors
+    return errors, warnings
+  end
+
+  def self.get_context_elements(hpxml_doc, context_xpath, context_elements_cache)
+    # Returns all XML elements that match context_xpath.
+    # This method is used to incorporate performance improvements by
+    # attempting to avoid expensive xpath() calls when possible.
+
+    # Check if context_xpath already queried
+    context_elements = context_elements_cache[context_xpath]
+    return context_elements unless context_elements.nil?
+
+    # Check if a parent xpath already found to have no element matches
+    parent_is_empty = false
+    context_elements_cache.each do |k, v|
+      next unless context_xpath.include? k
+      next unless v.empty?
+
+      parent_is_empty = true
+      break
+    end
+    if parent_is_empty
+      # If a parent xpath had no element matches, then context_xpath must
+      # also have no element matches. So return an empty list to skip the
+      # xpath query.
+      context_elements_cache[context_xpath] = []
+      return context_elements_cache[context_xpath]
+    end
+
+    # If we got this far, we must proceed with the xpath query.
+    begin
+      context_elements_cache[context_xpath] = hpxml_doc.xpath(context_xpath)
+    rescue
+      fail "Invalid xpath: #{context_xpath}"
+    end
+
+    return context_elements_cache[context_xpath]
   end
 end

data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/version.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
 class Version
-  OS_HPXML_Version = '0.11.0' # Version of the OS-HPXML workflow
-  OS_Version = '3.0' # Required version of OpenStudio (can be 'X.X' or 'X.X.X')
+  OS_HPXML_Version = '1.1.0' # Version of the OS-HPXML workflow
+  OS_Version = '3.2.0' # Required version of OpenStudio (can be 'X.X' or 'X.X.X')
+  HPXML_Version = '3.0' # HPXML schemaVersion
 
   def self.check_openstudio_version
     if not OpenStudio.openStudioVersion.start_with? OS_Version
@@ -13,4 +14,10 @@ class Version
       end
     end
   end
+
+  def self.check_hpxml_version(hpxml_version)
+    if hpxml_version != HPXML_Version
+      fail "HPXML version #{HPXML_Version} is required."
+    end
+  end
 end

data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/waterheater.rb

@@ -6,10 +6,6 @@ class Waterheater
 
     dhw_map[water_heating_system.id] = []
 
-    if water_heating_system.energy_factor.nil?
-      water_heating_system.energy_factor = calc_ef_from_uef(water_heating_system)
-    end
-
     solar_fraction = get_water_heater_solar_fraction(water_heating_system, solar_thermal_system)
     set_temp_c = get_set_temp_c(water_heating_system.temperature, water_heating_system.water_heater_type)
     loop = create_new_loop(model, Constants.ObjectNamePlantLoopDHW, set_temp_c)
@@ -51,11 +47,7 @@ class Waterheater
 
     dhw_map[water_heating_system.id] = []
 
-    if water_heating_system.energy_factor.nil?
-      water_heating_system.energy_factor = calc_ef_from_uef(water_heating_system)
-    end
     water_heating_system.heating_capacity = 100000000000.0
-
     solar_fraction = get_water_heater_solar_fraction(water_heating_system, solar_thermal_system)
     set_temp_c = get_set_temp_c(water_heating_system.temperature, water_heating_system.water_heater_type)
     loop = create_new_loop(model, Constants.ObjectNamePlantLoopDHW, set_temp_c)
@@ -97,10 +89,6 @@ class Waterheater
 
     dhw_map[water_heating_system.id] = []
 
-    if water_heating_system.energy_factor.nil?
-      water_heating_system.energy_factor = calc_ef_from_uef(water_heating_system)
-    end
-
     obj_name_hpwh = Constants.ObjectNameWaterHeater
     solar_fraction = get_water_heater_solar_fraction(water_heating_system, solar_thermal_system)
     set_temp_c = get_set_temp_c(water_heating_system.temperature, water_heating_system.water_heater_type)
@@ -157,6 +145,7 @@ class Waterheater
 
     # Fan:OnOff
     fan = setup_hpwh_fan(hpwh, obj_name_hpwh, airflow_rate)
+    dhw_map[water_heating_system.id] << fan
 
     # Amb temp & RH sensors, temp sensor shared across programs
     amb_temp_sensor, amb_rh_sensors = get_loc_temp_rh_sensors(model, obj_name_hpwh, loc_schedule, loc_space, living_zone)
@@ -192,12 +181,9 @@ class Waterheater
 
     if water_heating_system.water_heater_type == HPXML::WaterHeaterTypeCombiStorage
       if water_heating_system.standby_loss <= 0
-        fail 'Indirect water heater standby loss is negative, double check TankVolume to be <829 gal or StandbyLoss to be >0.0 F/hr.'
+        fail 'A negative indirect water heater standby loss was calculated, double check water heater inputs.'
       end
 
-      if water_heating_system.standby_loss > 10.0
-        runner.registerWarning('Indirect water heater standby loss is over 10.0 F/hr, double check water heater inputs.')
-      end
       act_vol = calc_storage_tank_actual_vol(water_heating_system.tank_volume, nil)
       a_side = calc_tank_areas(act_vol)[1]
       ua = calc_indirect_ua_with_standbyloss(act_vol, water_heating_system, a_side, solar_fraction)
@@ -342,10 +328,10 @@ class Waterheater
           tank_spt_sensor.setName("#{sys_id} Setpoint Temperature")
           tank_spt_sensor.setKeyName(object.setpointTemperatureSchedule.get.name.to_s)
           alt_spt_sch = object.indirectAlternateSetpointTemperatureSchedule.get
-          altsch_actuator = OpenStudio::Model::EnergyManagementSystemActuator.new(alt_spt_sch, 'Schedule:Constant', 'Schedule Value')
+          altsch_actuator = OpenStudio::Model::EnergyManagementSystemActuator.new(alt_spt_sch, *EPlus::EMSActuatorScheduleConstantValue)
           altsch_actuator.setName("#{sys_id} AltSchedOverride")
         elsif object.is_a? OpenStudio::Model::PumpVariableSpeed
-          pump_actuator = OpenStudio::Model::EnergyManagementSystemActuator.new(object, 'Pump', 'Pump Mass Flow Rate')
+          pump_actuator = OpenStudio::Model::EnergyManagementSystemActuator.new(object, *EPlus::EMSActuatorPumpMassFlowRate)
           pump_actuator.setName("#{sys_id} Pump MFR")
         elsif object.is_a? OpenStudio::Model::SetpointManagerScheduled
           tank_source_temp = object.schedule.to_ScheduleConstant.get.value
@@ -671,7 +657,7 @@ class Waterheater
     tank_source_sensor.setKeyName("#{storage_tank.demandOutletModelObject.get.to_Node.get.name}")
 
     # Actuators
-    swh_pump_actuator = OpenStudio::Model::EnergyManagementSystemActuator.new(pump, 'Pump', 'Pump Mass Flow Rate')
+    swh_pump_actuator = OpenStudio::Model::EnergyManagementSystemActuator.new(pump, *EPlus::EMSActuatorPumpMassFlowRate)
     swh_pump_actuator.setName("#{obj_name}_pump")
 
     # Program
@@ -770,8 +756,21 @@ class Waterheater
     twb_adj = Psychrometrics.Twb_fT_w_P(rated_edb_F, w_adj, p_atm)
 
     # Calculate the COP based on EF
-    uef = (0.60522 + water_heating_system.energy_factor) / 1.2101
-    cop = 1.174536058 * uef # Based on simulation of the UEF test procedure at varying COPs
+    if not water_heating_system.energy_factor.nil?
+      uef = (0.60522 + water_heating_system.energy_factor) / 1.2101
+      cop = 1.174536058 * uef # Based on simulation of the UEF test procedure at varying COPs
+    elsif not water_heating_system.uniform_energy_factor.nil?
+      uef = water_heating_system.uniform_energy_factor
+      if water_heating_system.first_hour_rating < 18.0
+        fail 'It is unlikely that a heat pump water heater falls into the very small bin of the First Hour Rating (FHR) test. Double check FHR input.'
+      elsif water_heating_system.first_hour_rating < 51.0 # Includes 18 gal up to (but not including) 51
+        cop = 1.0005 * uef - 0.0789
+      elsif water_heating_system.first_hour_rating < 75.0
+        cop = 1.0909 * uef - 0.0868
+      else
+        cop = 1.1022 * uef - 0.0877
+      end
+    end
 
     coil = hpwh.dXCoil.to_CoilWaterHeatingAirToWaterHeatPumpWrapped.get
     coil.setName("#{obj_name_hpwh} coil")
@@ -916,10 +915,10 @@ class Waterheater
 
   def self.add_hpwh_inlet_air_and_zone_heat_gain_program(model, obj_name_hpwh, loc_space, loc_schedule, hpwh_tamb, hpwh_rhamb, tank, coil, fan, amb_temp_sensor, amb_rh_sensors)
     # EMS Actuators: Inlet T & RH, sensible and latent gains to the space
-    tamb_act_actuator = OpenStudio::Model::EnergyManagementSystemActuator.new(hpwh_tamb, 'Schedule:Constant', 'Schedule Value')
+    tamb_act_actuator = OpenStudio::Model::EnergyManagementSystemActuator.new(hpwh_tamb, *EPlus::EMSActuatorScheduleConstantValue)
     tamb_act_actuator.setName("#{obj_name_hpwh} Tamb act")
 
-    rhamb_act_actuator = OpenStudio::Model::EnergyManagementSystemActuator.new(hpwh_rhamb, 'Schedule:Constant', 'Schedule Value')
+    rhamb_act_actuator = OpenStudio::Model::EnergyManagementSystemActuator.new(hpwh_rhamb, *EPlus::EMSActuatorScheduleConstantValue)
     rhamb_act_actuator.setName("#{obj_name_hpwh} RHamb act")
 
     if not loc_space.nil? # If located in space
@@ -946,10 +945,10 @@ class Waterheater
       hpwh_lat_def.setFractionLost(0)
       hpwh_lat.setSchedule(model.alwaysOnDiscreteSchedule)
 
-      sens_act_actuator = OpenStudio::Model::EnergyManagementSystemActuator.new(hpwh_sens, 'OtherEquipment', 'Power Level')
+      sens_act_actuator = OpenStudio::Model::EnergyManagementSystemActuator.new(hpwh_sens, *EPlus::EMSActuatorOtherEquipmentPower)
       sens_act_actuator.setName("#{hpwh_sens.name} act")
 
-      lat_act_actuator = OpenStudio::Model::EnergyManagementSystemActuator.new(hpwh_lat, 'OtherEquipment', 'Power Level')
+      lat_act_actuator = OpenStudio::Model::EnergyManagementSystemActuator.new(hpwh_lat, *EPlus::EMSActuatorOtherEquipmentPower)
       lat_act_actuator.setName("#{hpwh_lat.name} act")
     end
 
@@ -966,7 +965,7 @@ class Waterheater
     lat_cool_sensor.setName("#{obj_name_hpwh} lat cool")
     lat_cool_sensor.setKeyName(coil.name.to_s)
 
-    fan_power_sensor = OpenStudio::Model::EnergyManagementSystemSensor.new(model, 'Fan Electric Power')
+    fan_power_sensor = OpenStudio::Model::EnergyManagementSystemSensor.new(model, "Fan #{EPlus::FuelTypeElectricity} Rate")
     fan_power_sensor.setName("#{obj_name_hpwh} fan pwr")
     fan_power_sensor.setKeyName(fan.name.to_s)
 
@@ -988,7 +987,7 @@ class Waterheater
 
   def self.add_hpwh_control_program(model, obj_name_hpwh, amb_temp_sensor, hpwh_bottom_element_sp, min_temp, max_temp, tset_C)
     # Lower element is enabled if the ambient air temperature prevents the HP from running
-    leschedoverride_actuator = OpenStudio::Model::EnergyManagementSystemActuator.new(hpwh_bottom_element_sp, 'Schedule:Constant', 'Schedule Value')
+    leschedoverride_actuator = OpenStudio::Model::EnergyManagementSystemActuator.new(hpwh_bottom_element_sp, *EPlus::EMSActuatorScheduleConstantValue)
     leschedoverride_actuator.setName("#{obj_name_hpwh} LESchedOverride")
     hpwh_ctrl_program = OpenStudio::Model::EnergyManagementSystemProgram.new(model)
     hpwh_ctrl_program.setName("#{obj_name_hpwh} Control")
@@ -1052,7 +1051,7 @@ class Waterheater
                                      loc_schedule: loc_schedule,
                                      model: model,
                                      ua: assumed_ua,
-                                     is_storage: true)
+                                     is_dsh_storage: true)
     set_parasitic_power_for_storage_wh(water_heater: storage_tank)
 
     loop.addSupplyBranchForComponent(storage_tank)
@@ -1188,15 +1187,17 @@ class Waterheater
     if water_heating_system.fuel_type == HPXML::FuelTypeElectricity
       return 0.98
     else
+      # FUTURE: Develop a separate algorithm specific to UEF.
       ef = water_heating_system.energy_factor
       if ef.nil?
         ef = calc_ef_from_uef(water_heating_system)
       end
       if ef >= 0.75
-        return 0.778114 * ef + 0.276679
+        re = 0.561 * ef + 0.439
       else
-        return 0.252117 * ef + 0.607997
+        re = 0.252 * ef + 0.608
       end
+      return re
     end
   end
 
@@ -1283,12 +1284,6 @@ class Waterheater
     # EMS for calculating the EC_adj
 
     # Sensors
-    eplus_fuel = EPlus.input_fuel_map(fuel_type)
-    if eplus_fuel == EPlus::FuelTypeElectricity
-      ep_consumption_name = "#{EPlus.output_fuel_map(eplus_fuel)} Power"
-    else
-      ep_consumption_name = "#{EPlus.output_fuel_map(eplus_fuel)} Rate"
-    end
     if [HPXML::WaterHeaterTypeCombiStorage, HPXML::WaterHeaterTypeCombiTankless].include? water_heating_system.water_heater_type
       ec_adj_sensor_hx = OpenStudio::Model::EnergyManagementSystemSensor.new(model, 'Fluid Heat Exchanger Heat Transfer Energy')
       ec_adj_sensor_hx.setName("#{combi_hx.name} energy")
@@ -1296,32 +1291,32 @@ class Waterheater
       ec_adj_sensor_boiler_heating = OpenStudio::Model::EnergyManagementSystemSensor.new(model, 'Boiler Heating Energy')
       ec_adj_sensor_boiler_heating.setName("#{combi_boiler.name} heating energy")
       ec_adj_sensor_boiler_heating.setKeyName(combi_boiler.name.to_s)
-      ec_adj_sensor_boiler = OpenStudio::Model::EnergyManagementSystemSensor.new(model, "Boiler #{ep_consumption_name}")
+      ec_adj_sensor_boiler = OpenStudio::Model::EnergyManagementSystemSensor.new(model, "Boiler #{EPlus.fuel_type(fuel_type)} Rate")
       ec_adj_sensor_boiler.setName("#{combi_boiler.name} energy")
       ec_adj_sensor_boiler.setKeyName(combi_boiler.name.to_s)
     else
-      ec_adj_sensor = OpenStudio::Model::EnergyManagementSystemSensor.new(model, "Water Heater #{ep_consumption_name}")
+      ec_adj_sensor = OpenStudio::Model::EnergyManagementSystemSensor.new(model, "Water Heater #{EPlus.fuel_type(fuel_type)} Rate")
       ec_adj_sensor.setName("#{tank.name} energy")
       ec_adj_sensor.setKeyName(tank.name.to_s)
       if water_heating_system.water_heater_type == HPXML::WaterHeaterTypeHeatPump
-        ec_adj_hp_sensor = OpenStudio::Model::EnergyManagementSystemSensor.new(model, 'Cooling Coil Water Heating Electric Power')
+        ec_adj_hp_sensor = OpenStudio::Model::EnergyManagementSystemSensor.new(model, "Cooling Coil Water Heating #{EPlus::FuelTypeElectricity} Rate")
         ec_adj_hp_sensor.setName("#{heater.dXCoil.name} energy")
         ec_adj_hp_sensor.setKeyName(heater.dXCoil.name.to_s)
-        ec_adj_fan_sensor = OpenStudio::Model::EnergyManagementSystemSensor.new(model, 'Fan Electric Power')
+        ec_adj_fan_sensor = OpenStudio::Model::EnergyManagementSystemSensor.new(model, "Fan #{EPlus::FuelTypeElectricity} Rate")
         ec_adj_fan_sensor.setName("#{heater.fan.name} energy")
         ec_adj_fan_sensor.setKeyName(heater.fan.name.to_s)
       end
     end
 
-    ec_adj_oncyc_sensor = OpenStudio::Model::EnergyManagementSystemSensor.new(model, 'Water Heater On Cycle Parasitic Electric Power')
+    ec_adj_oncyc_sensor = OpenStudio::Model::EnergyManagementSystemSensor.new(model, "Water Heater On Cycle Parasitic #{EPlus::FuelTypeElectricity} Rate")
     ec_adj_oncyc_sensor.setName("#{tank.name} on cycle parasitic")
     ec_adj_oncyc_sensor.setKeyName(tank.name.to_s)
-    ec_adj_offcyc_sensor = OpenStudio::Model::EnergyManagementSystemSensor.new(model, 'Water Heater Off Cycle Parasitic Electric Power')
+    ec_adj_offcyc_sensor = OpenStudio::Model::EnergyManagementSystemSensor.new(model, "Water Heater Off Cycle Parasitic #{EPlus::FuelTypeElectricity} Rate")
     ec_adj_offcyc_sensor.setName("#{tank.name} off cycle parasitic")
     ec_adj_offcyc_sensor.setKeyName(tank.name.to_s)
 
     # Actuators
-    ec_adj_actuator = OpenStudio::Model::EnergyManagementSystemActuator.new(ec_adj_object, 'OtherEquipment', 'Power Level')
+    ec_adj_actuator = OpenStudio::Model::EnergyManagementSystemActuator.new(ec_adj_object, *EPlus::EMSActuatorOtherEquipmentPower)
     ec_adj_actuator.setName("#{heater.name} ec_adj_act")
 
     # Program
@@ -1347,7 +1342,7 @@ class Waterheater
     program_calling_manager.addProgram(ec_adj_program)
 
     # Sensor for EMS reporting
-    ec_adj_object_sensor = OpenStudio::Model::EnergyManagementSystemSensor.new(model, "Other Equipment #{ep_consumption_name.gsub('Rate', 'Energy').gsub('Power', 'Energy')}")
+    ec_adj_object_sensor = OpenStudio::Model::EnergyManagementSystemSensor.new(model, "Other Equipment #{EPlus.fuel_type(fuel_type)} Energy")
     ec_adj_object_sensor.setName("#{ec_adj_object.name} energy consumption")
     ec_adj_object_sensor.setKeyName(ec_adj_object.name.to_s)
 
@@ -1386,8 +1381,11 @@ class Waterheater
 
   def self.get_default_performance_adjustment(water_heating_system)
     return unless water_heating_system.water_heater_type == HPXML::WaterHeaterTypeTankless
-
-    return 0.92 # Applies to EF
+    if not water_heating_system.energy_factor.nil?
+      return 0.92 # Applies EF, updated per 301-2019
+    elsif not water_heating_system.uniform_energy_factor.nil?
+      return 0.94 # Applies UEF, updated per 301-2019
+    end
   end
 
   def self.get_default_location(hpxml, iecc_zone)
@@ -1402,8 +1400,6 @@ class Waterheater
       location_hierarchy = [HPXML::LocationBasementConditioned,
                             HPXML::LocationBasementUnconditioned,
                             HPXML::LocationLivingSpace]
-    else
-      fail "Unexpected IECC climate zone: '#{iecc_zone}'."
     end
     location_hierarchy.each do |space_type|
       if hpxml.has_space_type(space_type)
@@ -1439,29 +1435,62 @@ class Waterheater
   end
 
   def self.calc_tank_UA(act_vol, water_heating_system, solar_fraction)
-    # Calculates the U value, UA of the tank and conversion efficiency (eta_c)
-    # based on the Energy Factor and recovery efficiency of the tank
-    # Source: Burch and Erickson 2004 - http://www.nrel.gov/docs/gen/fy04/36035.pdf
+    # If using EF:
+    #   Calculates the U value, UA of the tank and conversion efficiency (eta_c)
+    #   based on the Energy Factor and recovery efficiency of the tank
+    #   Source: Burch and Erickson 2004 - http://www.nrel.gov/docs/gen/fy04/36035.pdf
+    # IF using UEF:
+    #   Calculates the U value, UA of the tank and conversion efficiency (eta_c)
+    #   based on the Uniform Energy Factor, First Hour Rating, and Recovery Efficiency of the tank
+    #   Source: Maguire and Roberts 2020 - https://www.ashrae.org/file%20library/conferences/specialty%20conferences/2020%20building%20performance/papers/d-bsc20-c039.pdf
     if water_heating_system.water_heater_type == HPXML::WaterHeaterTypeTankless
-      eta_c = water_heating_system.energy_factor * water_heating_system.performance_adjustment
+      if not water_heating_system.energy_factor.nil?
+        eta_c = water_heating_system.energy_factor * water_heating_system.performance_adjustment
+      elsif not water_heating_system.uniform_energy_factor.nil?
+        eta_c = water_heating_system.uniform_energy_factor * water_heating_system.performance_adjustment
+      end
       ua = 0.0
       surface_area = 1.0
     else
-      volume_drawn = 64.3 # gal/day
       density = 8.2938 # lb/gal
-      draw_mass = volume_drawn * density # lb
       cp = 1.0007 # Btu/lb-F
-      t = 135.0 # F
       t_in = 58.0 # F
       t_env = 67.5 # F
+
+      if not water_heating_system.energy_factor.nil?
+        t = 135.0 # F
+        volume_drawn = 64.3 # gal/day
+      elsif not water_heating_system.uniform_energy_factor.nil?
+        t = 125.0 # F
+        if water_heating_system.first_hour_rating < 18.0
+          volume_drawn = 10.0 # gal
+        elsif water_heating_system.first_hour_rating < 51.0 # Includes 18 gal up to (but not including) 51
+          volume_drawn = 38.0 # gal
+        elsif water_heating_system.first_hour_rating < 75.0
+          volume_drawn = 55.0 # gal
+        else
+          volume_drawn = 84.0 # gal
+        end
+      end
+
+      draw_mass = volume_drawn * density # lb
       q_load = draw_mass * cp * (t - t_in) # Btu/day
-      pow = water_heating_system.heating_capacity / 1000.0 # kbtu/h
+      pow = water_heating_system.heating_capacity # Btu/h
       surface_area, a_side = calc_tank_areas(act_vol)
       if water_heating_system.fuel_type != HPXML::FuelTypeElectricity
-        ua = (water_heating_system.recovery_efficiency / water_heating_system.energy_factor - 1.0) / ((t - t_env) * (24.0 / q_load - 1.0 / (1000.0 * pow * water_heating_system.energy_factor))) # Btu/hr-F
-        eta_c = (water_heating_system.recovery_efficiency + ua * (t - t_env) / (1000 * pow)) # conversion efficiency is supposed to be calculated with initial tank ua
+        if not water_heating_system.energy_factor.nil?
+          ua = (water_heating_system.recovery_efficiency / water_heating_system.energy_factor - 1.0) / ((t - t_env) * (24.0 / q_load - 1.0 / (pow * water_heating_system.energy_factor))) # Btu/hr-F
+          eta_c = (water_heating_system.recovery_efficiency + ua * (t - t_env) / pow) # conversion efficiency is supposed to be calculated with initial tank ua
+        elsif not water_heating_system.uniform_energy_factor.nil?
+          ua = ((water_heating_system.recovery_efficiency / water_heating_system.uniform_energy_factor) - 1.0) / ((t - t_env) * (24.0 / q_load) - ((t - t_env) / (pow * water_heating_system.uniform_energy_factor))) # Btu/hr-F
+          eta_c = water_heating_system.recovery_efficiency + ((ua * (t - t_env)) / pow) # conversion efficiency is slightly larger than recovery efficiency
+        end
       else # is Electric
-        ua = q_load * (1.0 / water_heating_system.energy_factor - 1.0) / ((t - t_env) * 24.0)
+        if not water_heating_system.energy_factor.nil?
+          ua = q_load * (1.0 / water_heating_system.energy_factor - 1.0) / ((t - t_env) * 24.0)
+        elsif not water_heating_system.uniform_energy_factor.nil?
+          ua = q_load * (1.0 / water_heating_system.uniform_energy_factor - 1.0) / ((24.0 * (t - t_env)) * (0.8 + 0.2 * ((t_in - t_env) / (t - t_env))))
+        end
         eta_c = 1.0
       end
       ua = apply_tank_jacket(water_heating_system, ua, a_side)
@@ -1551,12 +1580,12 @@ class Waterheater
     OpenStudio::Model::SetpointManagerScheduled.new(model, new_schedule)
   end
 
-  def self.create_new_heater(name:, water_heating_system: nil, act_vol:, t_set_c: nil, loc_space:, loc_schedule: nil, model:, ua:, eta_c: nil, oncycle_p: 0.0, is_storage: false, is_combi: false)
-    # storage tank doesn't requier water_heating_system class argument being passed
-    if is_storage || is_combi
+  def self.create_new_heater(name:, water_heating_system: nil, act_vol:, t_set_c: nil, loc_space:, loc_schedule: nil, model:, ua:, eta_c: nil, oncycle_p: 0.0, is_dsh_storage: false, is_combi: false)
+    # storage tank doesn't require water_heating_system class argument being passed
+    if is_dsh_storage || is_combi
       fuel = nil
       cap = 0.0
-      if is_storage
+      if is_dsh_storage
         tank_type = HPXML::WaterHeaterTypeStorage
       else
         tank_type = water_heating_system.water_heater_type
@@ -1569,7 +1598,7 @@ class Waterheater
     new_heater = OpenStudio::Model::WaterHeaterMixed.new(model)
     new_heater.setName(name)
     new_heater.setHeaterThermalEfficiency(eta_c) unless eta_c.nil?
-    new_heater.setHeaterFuelType(EPlus.input_fuel_map(fuel)) unless fuel.nil?
+    new_heater.setHeaterFuelType(EPlus.fuel_type(fuel)) unless fuel.nil?
     configure_setpoint_schedule(new_heater, t_set_c, model)
     new_heater.setMaximumTemperatureLimit(99.0)
     if [HPXML::WaterHeaterTypeTankless, HPXML::WaterHeaterTypeCombiTankless].include? tank_type
@@ -1583,7 +1612,7 @@ class Waterheater
     new_heater.setHeaterMaximumCapacity(UnitConversions.convert(cap, 'kBtu/hr', 'W'))
     new_heater.setHeaterMinimumCapacity(0.0)
     new_heater.setTankVolume(UnitConversions.convert(act_vol, 'gal', 'm^3'))
-    set_wh_parasitic_parameters(oncycle_p, water_heating_system, new_heater, is_storage)
+    set_wh_parasitic_parameters(oncycle_p, water_heating_system, new_heater, is_dsh_storage)
     set_wh_ambient(loc_space, loc_schedule, model, new_heater)
 
     ua_w_k = UnitConversions.convert(ua, 'Btu/(hr*F)', 'W/K')
@@ -1593,7 +1622,7 @@ class Waterheater
     return new_heater
   end
 
-  def self.set_wh_parasitic_parameters(oncycle_p, water_heating_system, water_heater, is_storage)
+  def self.set_wh_parasitic_parameters(oncycle_p, water_heating_system, water_heater, is_dsh_storage)
     water_heater.setOnCycleParasiticFuelType(EPlus::FuelTypeElectricity)
     water_heater.setOnCycleParasiticHeatFractiontoTank(0)
     water_heater.setOnCycleLossFractiontoThermalZone(1.0)
@@ -1604,15 +1633,15 @@ class Waterheater
     # Set fraction of heat loss from tank to ambient (vs out flue)
     # Based on lab testing done by LBNL
     skinlossfrac = 1.0
-    if not is_storage
-      if (water_heating_system.fuel_type != HPXML::FuelTypeElectricity) && (water_heating_system.water_heater_type == HPXML::WaterHeaterTypeStorage)
-        if oncycle_p == 0.0
-          skinlossfrac = 0.64
-        elsif water_heating_system.energy_factor < 0.8
-          skinlossfrac = 0.91
-        else
-          skinlossfrac = 0.96
-        end
+    if (not is_dsh_storage) && (water_heating_system.fuel_type != HPXML::FuelTypeElectricity) && (water_heating_system.water_heater_type == HPXML::WaterHeaterTypeStorage)
+      # Fuel storage water heater
+      # FUTURE: We currently always end up with oncycle_p (i.e., natural draft); revise this algorithm.
+      if oncycle_p == 0.0
+        skinlossfrac = 0.64 # Natural draft
+      elsif water_heating_system.energy_factor < 0.8
+        skinlossfrac = 0.91 # Power vent
+      else
+        skinlossfrac = 0.96 # Condensing
       end
     end
     water_heater.setOffCycleLossFractiontoThermalZone(skinlossfrac)
@@ -1636,12 +1665,14 @@ class Waterheater
     end
     avg_elec = oncycle_p * runtime_frac + offcycle_p * (1 - runtime_frac)
 
+    # FUTURE: These are always zero right now; develop smart defaults.
     water_heater.setOnCycleParasiticFuelConsumptionRate(avg_elec)
     water_heater.setOffCycleParasiticFuelConsumptionRate(avg_elec)
   end
 
   def self.set_parasitic_power_for_storage_wh(oncycle_p: 0.0, offcycle_p: 0.0, water_heater:)
     # Set parasitic power consumption
+    # FUTURE: These are always zero right now; develop smart defaults.
     water_heater.setOnCycleParasiticFuelConsumptionRate(oncycle_p)
     water_heater.setOffCycleParasiticFuelConsumptionRate(offcycle_p)
   end