Add unmet water heater loads EMS program

HPXMLtoOpenStudio/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.1</schema_version>
   <name>hpxm_lto_openstudio</name>
   <uid>b1543b30-9465-45ff-ba04-1d1f85e763bc</uid>
-  <version_id>bae0ddc1-27d7-46c7-b934-c04ffdb673cb</version_id>
-  <version_modified>2024-09-25T16:46:36Z</version_modified>
+  <version_id>102e707e-21f1-4f23-a882-d135393366a5</version_id>
+  <version_modified>2024-09-25T20:17:02Z</version_modified>
   <xml_checksum>D8922A73</xml_checksum>
   <class_name>HPXMLtoOpenStudio</class_name>
   <display_name>HPXML to OpenStudio Translator</display_name>
@@ -207,7 +207,7 @@
       <filename>constants.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>9F041A7A</checksum>
+      <checksum>E5FBA337</checksum>
     </file>
     <file>
       <filename>constructions.rb</filename>
@@ -453,7 +453,7 @@
       <filename>output.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>F5CC8A4A</checksum>
+      <checksum>475A27D4</checksum>
     </file>
     <file>
       <filename>psychrometrics.rb</filename>
@@ -627,7 +627,7 @@
       <filename>waterheater.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>91E22A62</checksum>
+      <checksum>19BE9876</checksum>
     </file>
     <file>
       <filename>weather.rb</filename>

HPXMLtoOpenStudio/resources/constants.rb

@@ -80,8 +80,8 @@ module Constants
   ObjectTypeUnitHeater = 'unit heater'
   ObjectTypeUnmetHoursProgram = 'unmet hours program'
   ObjectTypeUnmetLoadsProgram = 'unmet loads program'
-  ObjectTypeUnmetLoadsShowerE = 'unmet loads shower e'
-  ObjectTypeUnmetLoadsShowerSagTime = 'unmet loads shower sag time'
+  ObjectTypeUnmetLoadsShowerUnmetTime = 'unmet loads shower unmet time'
+  ObjectTypeUnmetLoadsShowerTime = 'unmet loads shower time'
   ObjectTypeWaterHeater = 'water heater'
   ObjectTypeWaterHeaterSetpoint = 'water heater setpoint'
   ObjectTypeWaterHeaterAdjustment = 'water heater energy adjustment'

HPXMLtoOpenStudio/resources/output.rb

@@ -113,13 +113,7 @@ module UHT
   # Unmet Hours Types
   Heating = 'Heating'
   Cooling = 'Cooling'
-end
-
-# TODO
-module ULT
-  # Unmet Loads Types
-  HotWaterShowerE = 'Hot Water Shower Energy'
-  HotWaterShowerTime = 'Hot Water Shower Time'
+  HotWaterShower = 'Showers'
 end
 
 # TODO
@@ -928,31 +922,36 @@ def self.add_unmet_loads_output(model, hpxml_osm_map)
     return if hpxml_osm_map.select { |hpxml_bldg, _unit_model| !hpxml_bldg.water_heating_systems.empty? }.empty?
 
     # Retrieve objects
-    shower_e_vars = []
-    shower_sag_time_vars = []
+    shower_unmet_time_vars = []
+    shower_time_vars = []
     unit_multipliers = []
     hpxml_osm_map.each do |hpxml_bldg, unit_model|
-      shower_e_vars << unit_model.getEnergyManagementSystemGlobalVariables.find { |v| v.additionalProperties.getFeatureAsString('ObjectType').to_s == Constants::ObjectTypeUnmetLoadsShowerE }
-      shower_sag_time_vars << unit_model.getEnergyManagementSystemGlobalVariables.find { |v| v.additionalProperties.getFeatureAsString('ObjectType').to_s == Constants::ObjectTypeUnmetLoadsShowerSagTime }
+      shower_unmet_time_vars << unit_model.getEnergyManagementSystemGlobalVariables.find { |v| v.additionalProperties.getFeatureAsString('ObjectType').to_s == Constants::ObjectTypeUnmetLoadsShowerUnmetTime }
+      shower_time_vars << unit_model.getEnergyManagementSystemGlobalVariables.find { |v| v.additionalProperties.getFeatureAsString('ObjectType').to_s == Constants::ObjectTypeUnmetLoadsShowerTime }
+
       unit_multipliers << hpxml_bldg.building_construction.number_of_units
     end
 
     # EMS program
-    total_shower_e = 'total_shower_e'
-    total_shower_sag_time = 'total_shower_sag_time'
-    unit_shower_sag_time = 'unit_shower_sag_time'
+    total_shower_unmet_time = 'total_shower_unmet_time'
+    total_shower_time = 'total_shower_time'
+    unit_shower_unmet_time = 'unit_shower_unmet_time'
+    unit_shower_time = 'unit_shower_time'
     program = OpenStudio::Model::EnergyManagementSystemProgram.new(model)
     program.setName('unmet loads program')
     program.additionalProperties.setFeature('ObjectType', Constants::ObjectTypeUnmetLoadsProgram)
-    program.addLine("Set #{total_shower_e} = 0")
-    program.addLine("Set #{total_shower_sag_time} = 0")
-    shower_e_vars.each_with_index do |shower_e_var, i|
-      program.addLine("Set total_shower_e = total_shower_e + (#{shower_e_var.name} * #{unit_multipliers[i]})")
+    program.addLine("Set #{total_shower_unmet_time} = 0")
+    program.addLine("Set #{total_shower_time} = 0")
+    shower_unmet_time_vars.each_with_index do |shower_unmet_time_var, _i|
+      program.addLine("Set #{unit_shower_unmet_time} = #{shower_unmet_time_var.name}")
+      program.addLine("  If #{unit_shower_unmet_time} > #{total_shower_unmet_time}") # Use max hourly value across all units
+      program.addLine("    Set #{total_shower_unmet_time} = #{unit_shower_unmet_time}")
+      program.addLine('  EndIf')
     end
-    shower_sag_time_vars.each_with_index do |shower_sag_time_var, _i|
-      program.addLine("Set #{unit_shower_sag_time} = #{shower_sag_time_var.name}")
-      program.addLine("  If #{unit_shower_sag_time} > #{total_shower_sag_time}") # Use max hourly value across all units
-      program.addLine("    Set #{total_shower_sag_time} = #{unit_shower_sag_time}")
+    shower_time_vars.each_with_index do |shower_time_var, _i|
+      program.addLine("Set #{unit_shower_time} = #{shower_time_var.name}")
+      program.addLine("  If #{unit_shower_time} > #{total_shower_time}") # Use max hourly value across all units
+      program.addLine("    Set #{total_shower_time} = #{unit_shower_time}")
       program.addLine('  EndIf')
     end
 

HPXMLtoOpenStudio/resources/waterheater.rb

@@ -2338,7 +2338,7 @@ def self.get_usage_bin_from_first_hour_rating(fhr)
   # @param plantloop_map [TODO] TODO
   # @param showers_peak_flows [TODO] TODO
   # @return [TODO] TODO
-  def self.unmet_wh_loads_program(model, water_heating_systems, plantloop_map, showers_peak_flows)
+  def self.unmet_wh_loads_program(model, water_heating_systems, plantloop_map, _showers_peak_flows)
     return if water_heating_systems.empty?
 
     # EMS sensors
@@ -2357,8 +2357,8 @@ def self.unmet_wh_loads_program(model, water_heating_systems, plantloop_map, sho
     # EMS program
     program = OpenStudio::Model::EnergyManagementSystemProgram.new(model)
     program.setName('unmet loads program')
-    program.addLine('Set ShowerE = 0') # Init
-    program.addLine('Set ShowerSagTime = 0') # Init
+    program.addLine('Set ShowerUnmetTime = 0') # Init
+    program.addLine('Set ShowerTime = 0') # Init
     program.addLine('If WarmupFlag == 0') # Prevent unmet hours in the first hour because of the warmup period
 
     water_heating_systems.each do |water_heating_system|
@@ -2383,13 +2383,15 @@ def self.unmet_wh_loads_program(model, water_heating_systems, plantloop_map, sho
       wh_temp_sensor.setKeyName("#{tank.name}")
 
       program.addLine("If (#{shower_flow_sensor.name} > 0) && (#{wh_temp_sensor.name} < #{mixed_setpoint_sensor.name})")
-      program.addLine('Set ShowerSagTime = 1')
-      program.addLine("Set ShowerE = ShowerE + ( #{water_heating_system.fraction_dhw_load_served} * #{shower_flow_sensor.name} * #{showers_peak_flows[water_heating_system.id]} * 990 * 4183 * (3600 / #{model.getTimestep.numberOfTimestepsPerHour}) * (#{mixed_setpoint_sensor.name} - #{wh_temp_sensor.name}) )") # assume specific heat of 4183 J/kg-K and density of 990 kg/m^3
+      program.addLine('Set ShowerUnmetTime = 1')
       program.addLine('EndIf')
     end
 
-    program.addLine('If (ShowerSagTime > 0)')
-    program.addLine('Set ShowerSagTime = SystemTimeStep')
+    program.addLine('If (ShowerUnmetTime > 0)')
+    program.addLine('Set ShowerUnmetTime = SystemTimeStep')
+    program.addLine('EndIf')
+    program.addLine("If (#{shower_flow_sensor.name} > 0)")
+    program.addLine('Set ShowerTime = SystemTimeStep')
     program.addLine('EndIf')
     program.addLine('EndIf')
 
@@ -2399,11 +2401,11 @@ def self.unmet_wh_loads_program(model, water_heating_systems, plantloop_map, sho
     manager.setCallingPoint('EndOfSystemTimestepAfterHVACReporting')
     manager.addProgram(program)
 
-    shower_e_var = OpenStudio::Model::EnergyManagementSystemGlobalVariable.new(model, "#{program.name}_ShowerE")
-    shower_sag_time_var = OpenStudio::Model::EnergyManagementSystemGlobalVariable.new(model, "#{program.name}_ShowerSagTime")
-    shower_e_var.additionalProperties.setFeature('ObjectType', Constants::ObjectTypeUnmetLoadsShowerE)
-    shower_sag_time_var.additionalProperties.setFeature('ObjectType', Constants::ObjectTypeUnmetLoadsShowerSagTime)
-    program.addLine("Set #{shower_e_var.name} = ShowerE")
-    program.addLine("Set #{shower_sag_time_var.name} = ShowerSagTime")
+    shower_unmet_time_var = OpenStudio::Model::EnergyManagementSystemGlobalVariable.new(model, "#{program.name}_ShowerUnmetTime")
+    shower_unmet_time_var.additionalProperties.setFeature('ObjectType', Constants::ObjectTypeUnmetLoadsShowerUnmetTime)
+    shower_time_var = OpenStudio::Model::EnergyManagementSystemGlobalVariable.new(model, "#{program.name}_ShowerTime")
+    shower_time_var.additionalProperties.setFeature('ObjectType', Constants::ObjectTypeUnmetLoadsShowerTime)
+    program.addLine("Set #{shower_unmet_time_var.name} = ShowerUnmetTime")
+    program.addLine("Set #{shower_time_var.name} = ShowerTime")
   end
 end

ReportSimulationOutput/README.md

@@ -123,17 +123,6 @@ Generates annual unmet hours for heating and cooling.
 
 <br/>
 
-**Generate Annual Output: Unmet Loads**
-
-Generates annual unmet loads.
-
-- **Name:** ``include_annual_unmet_loads``
-- **Type:** ``Boolean``
-
-- **Required:** ``false``
-
-<br/>
-
 **Generate Annual Output: Peak Fuels**
 
 Generates annual electricity peaks for summer/winter.
@@ -334,17 +323,6 @@ Generates timeseries unmet hours for heating and cooling.
 
 <br/>
 
-**Generate Timeseries Output: Unmet Loads**
-
-Generates timeseries unmet hours for hot water.
-
-- **Name:** ``include_timeseries_unmet_loads``
-- **Type:** ``Boolean``
-
-- **Required:** ``false``
-
-<br/>
-
 **Generate Timeseries Output: Zone Temperatures**
 
 Generates timeseries temperatures for each thermal zone.
@@ -706,9 +684,9 @@ All possible measure outputs are listed below. Actual outputs depend on measure
 
 - ``unmet_hours_cooling_hr``
 
-- ``unmet_loads_hot_water_shower_energy_k_btu``
+- ``unmet_hours_showers_hr``
 
-- ``unmet_loads_hot_water_shower_time_hr``
+- ``unmet_hours_showers``
 
 - ``peak_electricity_winter_total_w``