Add unmet water heater loads EMS program

BuildResidentialScheduleFile/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.1</schema_version>
   <name>build_residential_schedule_file</name>
   <uid>f770b2db-1a9f-4e99-99a7-7f3161a594b1</uid>
-  <version_id>d6668365-a78e-4e88-afa1-514e180dc8e2</version_id>
-  <version_modified>2023-09-19T22:23:01Z</version_modified>
+  <version_id>b894dc31-811f-428d-bcc3-47913cab592c</version_id>
+  <version_modified>2023-10-31T20:12:00Z</version_modified>
   <xml_checksum>03F02484</xml_checksum>
   <class_name>BuildResidentialScheduleFile</class_name>
   <display_name>Schedule File Builder</display_name>
@@ -22,7 +22,7 @@
     <argument>
       <name>schedules_column_names</name>
       <display_name>Schedules: Column Names</display_name>
-      <description>A comma-separated list of the column names to generate. If not provided, defaults to all columns. Possible column names are: occupants, lighting_interior, lighting_garage, cooking_range, dishwasher, clothes_washer, clothes_dryer, ceiling_fan, plug_loads_other, plug_loads_tv, hot_water_dishwasher, hot_water_clothes_washer, hot_water_fixtures.</description>
+      <description>A comma-separated list of the column names to generate. If not provided, defaults to all columns. Possible column names are: occupants, lighting_interior, lighting_garage, cooking_range, dishwasher, clothes_washer, clothes_dryer, ceiling_fan, plug_loads_other, plug_loads_tv, hot_water_dishwasher, hot_water_clothes_washer, hot_water_fixtures, hot_water_showers.</description>
       <type>String</type>
       <required>false</required>
       <model_dependent>false</model_dependent>
@@ -184,7 +184,7 @@
       <filename>schedules.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>51D9D15E</checksum>
+      <checksum>E3BE5673</checksum>
     </file>
     <file>
       <filename>schedules_config.md</filename>

BuildResidentialScheduleFile/resources/schedules.rb

@@ -57,7 +57,8 @@ def self.export_columns
             SchedulesFile::ColumnPlugLoadsTV,
             SchedulesFile::ColumnHotWaterDishwasher,
             SchedulesFile::ColumnHotWaterClothesWasher,
-            SchedulesFile::ColumnHotWaterFixtures]
+            SchedulesFile::ColumnHotWaterFixtures,
+            SchedulesFile::ColumnHotWaterShowers]
   end
 
   def schedules
@@ -531,6 +532,7 @@ def create_stochastic_schedules(args:)
     shower_activity_sch = aggregate_array(shower_activity_sch, @minutes_per_step)
     shower_peak_flow = shower_activity_sch.max
     showers = shower_activity_sch.map { |flow| flow / shower_peak_flow }
+    @schedules[SchedulesFile::ColumnHotWaterShowers] = showers
 
     random_offset = (prng.rand * 2 * offset_range).to_i - offset_range
     sink_activity_sch = sink_activity_sch.rotate(-4 * 60 + random_offset) # 4 am shifting

Changelog.md

@@ -21,6 +21,7 @@ __New Features__
   - Always validate the HPXML file before applying defaults and only optionally validate the final HPXML file.
 - Battery losses now split between charging and discharging.
 - Interior/exterior window shading multipliers are now modeled using the EnergyPlus incident solar multiplier.
+- Added metrics for unmet hot water loads
 
 __Bugfixes__
 - Fixes battery resilience output to properly incorporate battery losses.

HPXMLtoOpenStudio/measure.rb

@@ -212,7 +212,7 @@ def self.create(hpxml, runner, model, hpxml_path, epw_path, weather, output_dir,
     add_ceiling_fans(runner, model, weather, spaces)
 
     # Hot Water
-    add_hot_water_and_appliances(runner, model, weather, spaces)
+    hw_plant_loop = add_hot_water_and_appliances(runner, model, weather, spaces)
 
     # Plug Loads & Fuel Loads & Lighting
     add_mels(runner, model, spaces)
@@ -232,6 +232,7 @@ def self.create(hpxml, runner, model, hpxml_path, epw_path, weather, output_dir,
 
     # Output
     add_unmet_hours_output(model, spaces)
+    add_unmet_wh_loads(runner, model, weather, hw_plant_loop)
     add_loads_output(model, spaces, add_component_loads)
     set_output_files(model)
     # Uncomment to debug EMS
@@ -1285,6 +1286,7 @@ def self.add_hot_water_and_appliances(runner, model, weather, spaces)
     unavailable_periods = Schedule.get_unavailable_periods(runner, SchedulesFile::ColumnWaterHeater, @hpxml.header.unavailable_periods)
     has_uncond_bsmnt = @hpxml.has_location(HPXML::LocationBasementUnconditioned)
     plantloop_map = {}
+    sys_id = nil
     @hpxml.water_heating_systems.each do |water_heating_system|
       loc_space, loc_schedule = get_space_or_schedule_from_location(water_heating_system.location, model, spaces)
 
@@ -1317,6 +1319,8 @@ def self.add_hot_water_and_appliances(runner, model, weather, spaces)
 
     # Add combi-system EMS program with water use equipment information
     Waterheater.apply_combi_system_EMS(model, @hpxml.water_heating_systems, plantloop_map)
+
+    return plantloop_map[sys_id]
   end
 
   def self.add_cooling_system(model, spaces, airloop_map)
@@ -1889,6 +1893,107 @@ def self.add_unmet_hours_output(model, spaces)
     program_calling_manager.addProgram(program)
   end
 
+  def self.add_unmet_wh_loads(runner, model, weather, hw_plant_loop)
+    @hpxml.water_heating_systems.each do |water_heating_system|
+      # Get shower schedule max value
+      shower_peak_flow = HotWaterAndAppliances.add_showers_and_calculate_max(model, runner, @hpxml, weather, water_heating_system, @eri_version, @schedules_file, @hpxml.header.unavailable_periods)
+
+      # Get the water storage tanks for the outlet temp sensor
+      num_tanks = 0
+      tank = nil
+
+      hw_plant_loop.components.each do |c|
+        next unless c.to_WaterHeaterMixed.is_initialized
+
+        tank = c.to_WaterHeaterMixed.get
+        num_tanks += 1
+      end
+      hw_plant_loop.components.each do |c|
+        next unless c.to_WaterHeaterStratified.is_initialized
+
+        tank = c.to_WaterHeaterStratified.get
+        num_tanks += 1
+      end
+
+      if num_tanks > 1
+        runner.registerError("Found more WHs than expected. There are #{num_tanks} water heaters instead of 1.")
+      end
+
+      # EMS sensors
+      mixed_setpoint_sensor = OpenStudio::Model::EnergyManagementSystemSensor.new(model, 'Schedule Value')
+      mixed_setpoint_sensor.setName('res_shower_mixsp')
+      mixed_setpoint_sensor.setKeyName('mixed water temperature schedule')
+
+      wh_temp_sensor = OpenStudio::Model::EnergyManagementSystemSensor.new(model, 'Water Heater Use Side Outlet Temperature')
+      wh_temp_sensor.setName("#{tank.name} Outlet Temperature")
+      wh_temp_sensor.setKeyName("#{tank.name}")
+
+      shower_flow_sensor = OpenStudio::Model::EnergyManagementSystemSensor.new(model, 'Schedule Value')
+      shower_flow_sensor.setName('Shower Volume')
+      shower_flow_sensor.setKeyName('hot_water_showers')
+
+      # cw_flow_sensor = OpenStudio::Model::EnergyManagementSystemSensor.new(model, 'Water Use Equipment Hot Water Volume')
+      # cw_flow_sensor.setName('Clothes Washer Volume')
+      # cw_flow_sensor.setKeyName('clothes washer')
+
+      # dw_flow_sensor = OpenStudio::Model::EnergyManagementSystemSensor.new(model, 'Water Use Equipment Hot Water Volume')
+      # dw_flow_sensor.setName('Dishwasher Volume')
+      # dw_flow_sensor.setKeyName('dishwasher')
+
+      # fx_flow_sensor = OpenStudio::Model::EnergyManagementSystemSensor.new(model, 'Water Use Equipment Hot Water Volume')
+      # fx_flow_sensor.setName('Fixture Volume')
+      # fx_flow_sensor.setKeyName('dhw fixtures')
+
+      # EMS program
+      unmet_wh_loads_program = OpenStudio::Model::EnergyManagementSystemProgram.new(model)
+      unmet_wh_loads_program.setName(Constants.ObjectNameUnmetLoadsProgram)
+      unmet_wh_loads_program.addLine("If #{shower_flow_sensor.name} > 0")
+      unmet_wh_loads_program.addLine('Set ShowerTime=SystemTimeStep')
+      unmet_wh_loads_program.addLine('Else')
+      unmet_wh_loads_program.addLine('Set ShowerTime=0')
+      unmet_wh_loads_program.addLine('EndIf')
+      unmet_wh_loads_program.addLine("If (#{shower_flow_sensor.name} > 0) && (#{wh_temp_sensor.name} < #{mixed_setpoint_sensor.name})")
+      # unmet_wh_loads_program.addLine("If (#{shower_flow_sensor.name} > 0) && (49 < #{mixed_setpoint_sensor.name})")
+      unmet_wh_loads_program.addLine('Set ShowerSagTime=SystemTimeStep')
+      # unmet_wh_loads_program.addLine("Set ShowerE=#{shower_flow_sensor.name} * #{shower_peak_flow} * 4141170 * (49 - #{mixed_setpoint_sensor.name})")
+      unmet_wh_loads_program.addLine("Set ShowerE=#{shower_flow_sensor.name} * #{shower_peak_flow} * 4141170 * (#{wh_temp_sensor.name} - #{mixed_setpoint_sensor.name})")
+      unmet_wh_loads_program.addLine('Else')
+      unmet_wh_loads_program.addLine('Set ShowerSagTime=0')
+      unmet_wh_loads_program.addLine('Set ShowerE=0')
+      unmet_wh_loads_program.addLine('EndIf')
+
+      # ProgramCallingManagers
+      program_calling_manager = OpenStudio::Model::EnergyManagementSystemProgramCallingManager.new(model)
+      program_calling_manager.setName("#{unmet_wh_loads_program.name} calling manager")
+      program_calling_manager.setCallingPoint('EndOfSystemTimestepAfterHVACReporting')
+      program_calling_manager.addProgram(unmet_wh_loads_program)
+
+      # # output variables
+      # shower_time_output_var = OpenStudio::Model::EnergyManagementSystemOutputVariable.new(model, 'ShowerTime')
+      # shower_time_output_var.setName('ShowerTime')
+      # shower_time_output_var.setTypeOfDataInVariable('Summed')
+      # shower_time_output_var.setUpdateFrequency('SystemTimestep')
+      # shower_time_output_var.setEMSProgramOrSubroutineName(unmet_wh_loads_program)
+      # shower_time_output_var.setUnits('hr')
+
+      # # output variables
+      # shower_unmet_energy_output_var = OpenStudio::Model::EnergyManagementSystemOutputVariable.new(model, 'ShowerE')
+      # shower_unmet_energy_output_var.setName('ShowerE')
+      # shower_unmet_energy_output_var.setTypeOfDataInVariable('Summed')
+      # shower_unmet_energy_output_var.setUpdateFrequency('SystemTimestep')
+      # shower_unmet_energy_output_var.setEMSProgramOrSubroutineName(unmet_wh_loads_program)
+      # shower_unmet_energy_output_var.setUnits('J')
+
+      # # output variables
+      # shower_unmet_time_output_var = OpenStudio::Model::EnergyManagementSystemOutputVariable.new(model, 'ShowerSagTime')
+      # shower_unmet_time_output_var.setName('ShowerSagTime')
+      # shower_unmet_time_output_var.setTypeOfDataInVariable('Summed')
+      # shower_unmet_time_output_var.setUpdateFrequency('SystemTimestep')
+      # shower_unmet_time_output_var.setEMSProgramOrSubroutineName(unmet_wh_loads_program)
+      # shower_unmet_time_output_var.setUnits('hr')
+    end
+  end
+
   def self.add_loads_output(model, spaces, add_component_loads)
     conditioned_zone = spaces[HPXML::LocationConditionedSpace].thermalZone.get
 

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>7172e5c7-162c-4205-a7fc-adcb3de140e9</version_id>
-  <version_modified>2023-10-18T17:47:01Z</version_modified>
+  <version_id>cebd214f-49dc-4ac9-81bb-dcc8a9890513</version_id>
+  <version_modified>2023-10-31T20:17:56Z</version_modified>
   <xml_checksum>D8922A73</xml_checksum>
   <class_name>HPXMLtoOpenStudio</class_name>
   <display_name>HPXML to OpenStudio Translator</display_name>
@@ -130,7 +130,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>FD70CB3F</checksum>
+      <checksum>407C727D</checksum>
     </file>
     <file>
       <filename>airflow.rb</filename>
@@ -148,7 +148,7 @@
       <filename>constants.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>E73FC04E</checksum>
+      <checksum>A1E4A089</checksum>
     </file>
     <file>
       <filename>constructions.rb</filename>
@@ -232,7 +232,7 @@
       <filename>hotwater_appliances.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>DE9728DA</checksum>
+      <checksum>BFC89603</checksum>
     </file>
     <file>
       <filename>hpxml.rb</filename>
@@ -322,7 +322,7 @@
       <filename>output.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>C73BDCB4</checksum>
+      <checksum>58656952</checksum>
     </file>
     <file>
       <filename>psychrometrics.rb</filename>
@@ -352,19 +352,19 @@
       <filename>schedule_files/occupancy-stochastic-10-mins.csv</filename>
       <filetype>csv</filetype>
       <usage_type>resource</usage_type>
-      <checksum>D4373DC9</checksum>
+      <checksum>811F8B96</checksum>
     </file>
     <file>
       <filename>schedule_files/occupancy-stochastic-30-mins.csv</filename>
       <filetype>csv</filetype>
       <usage_type>resource</usage_type>
-      <checksum>D4373DC9</checksum>
+      <checksum>811F8B96</checksum>
     </file>
     <file>
       <filename>schedule_files/occupancy-stochastic.csv</filename>
       <filetype>csv</filetype>
       <usage_type>resource</usage_type>
-      <checksum>DEED74EA</checksum>
+      <checksum>EDB7F257</checksum>
     </file>
     <file>
       <filename>schedule_files/setpoints-10-mins.csv</filename>
@@ -424,7 +424,7 @@
       <filename>schedules.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>DD62935D</checksum>
+      <checksum>931ED0F1</checksum>
     </file>
     <file>
       <filename>simcontrols.rb</filename>
@@ -460,7 +460,7 @@
       <filename>waterheater.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>38F19A13</checksum>
+      <checksum>DC68703C</checksum>
     </file>
     <file>
       <filename>weather.rb</filename>

HPXMLtoOpenStudio/resources/constants.rb

@@ -394,6 +394,10 @@ def self.ObjectNameRoomAirConditioner
     return 'room ac'
   end
 
+  def self.ObjectNameShowers
+    return 'hot_water_showers'
+  end
+
   def self.ObjectNameSolarHotWater
     return 'solar hot water'
   end
@@ -414,6 +418,10 @@ def self.ObjectNameUnmetHoursProgram
     return 'unmet hours program'
   end
 
+  def self.ObjectNameUnmetLoadsProgram
+    return 'unmet loads program'
+  end
+
   def self.ObjectNameWaterHeater
     return 'water heater'
   end