Merge pull request #1904 from NREL/datapoint_extrapolation

Datapoint extrapolation

Author: shorowit

Diff for: BuildResidentialHPXML/README.md

@@ -2628,7 +2628,7 @@ Type of capacity values for detailed performance data if available. Applies only
 
 **HVAC Detailed Performance Data: Heating Outdoor Temperatures**
 
-Outdoor temperatures of heating detailed performance data if available. Applies only to variable-speed air-source HVAC systems (central air conditioners, mini-split air conditioners, air-to-air heat pumps, and mini-split heat pumps). One of the outdoor temperatures must be 47 F. At least two performance data points are required using a comma-separated list.
+Outdoor temperatures of heating detailed performance data if available. Applies only to variable-speed air-source HVAC systems (central air conditioners, mini-split air conditioners, air-to-air heat pumps, and mini-split heat pumps). Outdoor temperatures must be 47F, 17F, and 5F (and one optional temperature less than 5F). At least two performance data points are required using a comma-separated list.
 
 - **Name:** ``hvac_perf_data_heating_outdoor_temperatures``
 - **Type:** ``String``
@@ -2683,7 +2683,7 @@ Maximum speed efficiency COP values of heating detailed performance data if avai
 
 **HVAC Detailed Performance Data: Cooling Outdoor Temperatures**
 
-Outdoor temperatures of cooling detailed performance data if available. Applies only to variable-speed air-source HVAC systems (central air conditioners, mini-split air conditioners, air-to-air heat pumps, and mini-split heat pumps). One of the outdoor temperatures must be 95 F. At least two performance data points are required using a comma-separated list.
+Outdoor temperatures of cooling detailed performance data if available. Applies only to variable-speed air-source HVAC systems (central air conditioners, mini-split air conditioners, air-to-air heat pumps, and mini-split heat pumps). Outdoor temperatures must be 82F and 95F (and one optional temperature greater than 95F). At least two performance data points are required using a comma-separated list.
 
 - **Name:** ``hvac_perf_data_cooling_outdoor_temperatures``
 - **Type:** ``String``

Diff for: BuildResidentialHPXML/measure.rb

@@ -1584,7 +1584,7 @@ def arguments(model) # rubocop:disable Lint/UnusedMethodArgument
 
     arg = OpenStudio::Measure::OSArgument.makeStringArgument('hvac_perf_data_heating_outdoor_temperatures', false)
     arg.setDisplayName('HVAC Detailed Performance Data: Heating Outdoor Temperatures')
-    arg.setDescription('Outdoor temperatures of heating detailed performance data if available. Applies only to variable-speed air-source HVAC systems (central air conditioners, mini-split air conditioners, air-to-air heat pumps, and mini-split heat pumps). One of the outdoor temperatures must be 47 F. At least two performance data points are required using a comma-separated list.')
+    arg.setDescription('Outdoor temperatures of heating detailed performance data if available. Applies only to variable-speed air-source HVAC systems (central air conditioners, mini-split air conditioners, air-to-air heat pumps, and mini-split heat pumps). Outdoor temperatures must be 47F, 17F, and 5F (and one optional temperature less than 5F). At least two performance data points are required using a comma-separated list.')
     arg.setUnits('F')
     args << arg
 
@@ -1614,7 +1614,7 @@ def arguments(model) # rubocop:disable Lint/UnusedMethodArgument
 
     arg = OpenStudio::Measure::OSArgument.makeStringArgument('hvac_perf_data_cooling_outdoor_temperatures', false)
     arg.setDisplayName('HVAC Detailed Performance Data: Cooling Outdoor Temperatures')
-    arg.setDescription('Outdoor temperatures of cooling detailed performance data if available. Applies only to variable-speed air-source HVAC systems (central air conditioners, mini-split air conditioners, air-to-air heat pumps, and mini-split heat pumps). One of the outdoor temperatures must be 95 F. At least two performance data points are required using a comma-separated list.')
+    arg.setDescription('Outdoor temperatures of cooling detailed performance data if available. Applies only to variable-speed air-source HVAC systems (central air conditioners, mini-split air conditioners, air-to-air heat pumps, and mini-split heat pumps). Outdoor temperatures must be 82F and 95F (and one optional temperature greater than 95F). At least two performance data points are required using a comma-separated list.')
     arg.setUnits('F')
     args << arg
 

Diff for: BuildResidentialHPXML/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.1</schema_version>
   <name>build_residential_hpxml</name>
   <uid>a13a8983-2b01-4930-8af2-42030b6e4233</uid>
-  <version_id>95c9cd41-0567-4b3c-a0d5-4ccdcac03f37</version_id>
-  <version_modified>2025-01-16T05:23:16Z</version_modified>
+  <version_id>e05933ee-362c-46ac-8e6c-ce330b9a6177</version_id>
+  <version_modified>2025-01-16T05:27:23Z</version_modified>
   <xml_checksum>2C38F48B</xml_checksum>
   <class_name>BuildResidentialHPXML</class_name>
   <display_name>HPXML Builder</display_name>
@@ -3242,7 +3242,7 @@
     <argument>
       <name>hvac_perf_data_heating_outdoor_temperatures</name>
       <display_name>HVAC Detailed Performance Data: Heating Outdoor Temperatures</display_name>
-      <description>Outdoor temperatures of heating detailed performance data if available. Applies only to variable-speed air-source HVAC systems (central air conditioners, mini-split air conditioners, air-to-air heat pumps, and mini-split heat pumps). One of the outdoor temperatures must be 47 F. At least two performance data points are required using a comma-separated list.</description>
+      <description>Outdoor temperatures of heating detailed performance data if available. Applies only to variable-speed air-source HVAC systems (central air conditioners, mini-split air conditioners, air-to-air heat pumps, and mini-split heat pumps). Outdoor temperatures must be 47F, 17F, and 5F (and one optional temperature less than 5F). At least two performance data points are required using a comma-separated list.</description>
       <type>String</type>
       <units>F</units>
       <required>false</required>
@@ -3287,7 +3287,7 @@
     <argument>
       <name>hvac_perf_data_cooling_outdoor_temperatures</name>
       <display_name>HVAC Detailed Performance Data: Cooling Outdoor Temperatures</display_name>
-      <description>Outdoor temperatures of cooling detailed performance data if available. Applies only to variable-speed air-source HVAC systems (central air conditioners, mini-split air conditioners, air-to-air heat pumps, and mini-split heat pumps). One of the outdoor temperatures must be 95 F. At least two performance data points are required using a comma-separated list.</description>
+      <description>Outdoor temperatures of cooling detailed performance data if available. Applies only to variable-speed air-source HVAC systems (central air conditioners, mini-split air conditioners, air-to-air heat pumps, and mini-split heat pumps). Outdoor temperatures must be 82F and 95F (and one optional temperature greater than 95F). At least two performance data points are required using a comma-separated list.</description>
       <type>String</type>
       <units>F</units>
       <required>false</required>
@@ -7527,7 +7527,7 @@
       <filename>README.md</filename>
       <filetype>md</filetype>
       <usage_type>readme</usage_type>
-      <checksum>ECAEDA1E</checksum>
+      <checksum>99C4792F</checksum>
     </file>
     <file>
       <filename>README.md.erb</filename>
@@ -7544,7 +7544,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>CD62272E</checksum>
+      <checksum>745930C3</checksum>
     </file>
     <file>
       <filename>constants.rb</filename>

Diff for: Changelog.md

@@ -4,6 +4,9 @@ __New Features__
 - HVAC modeling updates:
   - Updated DX heat pump and air conditioner models per RESNET MINHERS Addendum 82.
   - Allows optional EER or EER2 inputs for central air conditioners/heat pumps and mini-splits.
+  - **Breaking Change**: Detailed performance datapoints must now use `OutdoorTemperature` values of:
+    - Heating: 47F, 17F, and 5F (plus an optional user-specified temperature <5F)
+    - Cooling: 82F and 95F (plus an optional user-specified temperature >95F)
 
 __Bugfixes__
 - Fixes zero occupants specified for one unit in a whole MF building from being treated like zero occupants for every unit.

Diff for: 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>d7ee087e-0335-492e-ba85-c87caad50eff</version_id>
-  <version_modified>2025-01-11T01:57:51Z</version_modified>
+  <version_id>9fa5c41d-db3c-43aa-98c4-2969644a9dfa</version_id>
+  <version_modified>2025-01-17T16:15:49Z</version_modified>
   <xml_checksum>D8922A73</xml_checksum>
   <class_name>HPXMLtoOpenStudio</class_name>
   <display_name>HPXML to OpenStudio Translator</display_name>
@@ -327,7 +327,7 @@
       <filename>defaults.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>7646CD36</checksum>
+      <checksum>3299B5AF</checksum>
     </file>
     <file>
       <filename>energyplus.rb</filename>
@@ -357,7 +357,7 @@
       <filename>hpxml.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>DC04D304</checksum>
+      <checksum>BD9723FA</checksum>
     </file>
     <file>
       <filename>hpxml_schema/HPXML.xsd</filename>
@@ -375,7 +375,7 @@
       <filename>hpxml_schematron/EPvalidator.xml</filename>
       <filetype>xml</filetype>
       <usage_type>resource</usage_type>
-      <checksum>0AC30606</checksum>
+      <checksum>A25F3562</checksum>
     </file>
     <file>
       <filename>hpxml_schematron/iso-schematron.xsd</filename>
@@ -387,13 +387,13 @@
       <filename>hvac.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>1839975D</checksum>
+      <checksum>3B489022</checksum>
     </file>
     <file>
       <filename>hvac_sizing.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>8F69ECDF</checksum>
+      <checksum>6E3654CA</checksum>
     </file>
     <file>
       <filename>internal_gains.rb</filename>
@@ -741,7 +741,7 @@
       <filename>test_validation.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>DEFF0AA8</checksum>
+      <checksum>4F7B35EB</checksum>
     </file>
     <file>
       <filename>test_water_heater.rb</filename>

Diff for: HPXMLtoOpenStudio/resources/defaults.rb

@@ -2434,7 +2434,8 @@ def self.apply_detailed_performance_data_for_var_speed_systems(hpxml_bldg)
             # Calculate heating capacity retention at 5F outdoor drybulb
             target_odb = 5.0
             max_capacity_47 = hvac_system.heating_detailed_performance_data.find { |dp| dp.outdoor_temperature == HVAC::AirSourceHeatRatedODB && dp.capacity_description == HPXML::CapacityDescriptionMaximum }.capacity
-            hvac_system.heating_capacity_retention_fraction = (HVAC.interpolate_to_odb_table_point(hvac_system.heating_detailed_performance_data, HPXML::CapacityDescriptionMaximum, target_odb, :capacity) / max_capacity_47).round(5)
+            max_capacity_5 = HVAC.extrapolate_data_point(hvac_system.heating_detailed_performance_data, HPXML::CapacityDescriptionMaximum, :outdoor_temperature, target_odb, :capacity)
+            hvac_system.heating_capacity_retention_fraction = (max_capacity_5 / max_capacity_47).round(5)
             hvac_system.heating_capacity_retention_fraction = 0.0 if hvac_system.heating_capacity_retention_fraction < 0
             hvac_system.heating_capacity_retention_temp = target_odb
             hvac_system.heating_capacity_retention_fraction_isdefaulted = true

Diff for: HPXMLtoOpenStudio/resources/hpxml.rb

@@ -11147,15 +11147,31 @@ def add(**kwargs)
     # @return [Array<String>] List of error messages
     def check_for_errors
       errors = []
-      # For every unique outdoor temperature, check we have exactly one minimum and one maximum datapoint
+
       outdoor_temps = self.select { |dp| [HPXML::CapacityDescriptionMinimum, HPXML::CapacityDescriptionMaximum].include? dp.capacity_description }.map { |dp| dp.outdoor_temperature }.uniq
       outdoor_temps.each do |outdoor_temp|
-        num_min = count { |dp| dp.capacity_description == HPXML::CapacityDescriptionMinimum && dp.outdoor_temperature == outdoor_temp }
-        num_max = count { |dp| dp.capacity_description == HPXML::CapacityDescriptionMaximum && dp.outdoor_temperature == outdoor_temp }
-        if (num_min != 1) || (num_max != 1)
+        min_dps = self.select { |dp| dp.capacity_description == HPXML::CapacityDescriptionMinimum && dp.outdoor_temperature == outdoor_temp }
+        max_dps = self.select { |dp| dp.capacity_description == HPXML::CapacityDescriptionMaximum && dp.outdoor_temperature == outdoor_temp }
+        # For every unique outdoor temperature, check we have exactly one minimum and one maximum datapoint
+        if (min_dps.size != 1) || (max_dps.size != 1)
           errors << "Cooling detailed performance data for outdoor temperature = #{outdoor_temp} is incomplete; there must be exactly one minimum and one maximum capacity datapoint."
+        else
+          min_capacity = min_dps[0].capacity.nil? ? min_dps[0].capacity_fraction_of_nominal : min_dps[0].capacity
+          max_capacity = max_dps[0].capacity.nil? ? max_dps[0].capacity_fraction_of_nominal : max_dps[0].capacity
+          min_cop = min_dps[0].efficiency_cop
+          max_cop = max_dps[0].efficiency_cop
+
+          # Check power at minimum capacity <= power at maximum capacity
+          if min_capacity / min_cop > max_capacity / max_cop
+            errors << "Cooling detailed performance data for outdoor temperature = #{outdoor_temp} is invalid; Power (capacity / COP) at minimum capacity must be less than power at maximum capacity."
+          end
+          # Check minimum capacity <= maximum capacity
+          if min_capacity > max_capacity
+            errors << "Cooling detailed performance data for outdoor temperature = #{outdoor_temp} is invalid; Maximum capacity must be greater than minimum capacity."
+          end
         end
       end
+
       return errors
     end
 
@@ -11183,7 +11199,9 @@ class CoolingPerformanceDataPoint < BaseElement
              :capacity_description,         # [String] CapacityDescription (HPXML::CapacityDescriptionXXX)
              :efficiency_cop,               # [Double] Efficiency[Units="COP"]/Value (W/W)
              :gross_capacity,               # FUTURE: Not in HPXML schema, should move to additional_properties
-             :gross_efficiency_cop]         # FUTURE: Not in HPXML schema, should move to additional_properties
+             :gross_efficiency_cop,         # FUTURE: Not in HPXML schema, should move to additional_properties
+             :gross_input_power,            # FUTURE: Not in HPXML schema, should move to additional_properties
+             :input_power]                  # FUTURE: Not in HPXML schema, should move to additional_properties
     attr_accessor(*ATTRS)
 
     # Deletes the current object from the array.
@@ -11255,15 +11273,31 @@ def add(**kwargs)
     # @return [Array<String>] List of error messages
     def check_for_errors
       errors = []
-      # For every unique outdoor temperature, check we have exactly one minimum and one maximum datapoint
+
       outdoor_temps = self.select { |dp| [HPXML::CapacityDescriptionMinimum, HPXML::CapacityDescriptionMaximum].include? dp.capacity_description }.map { |dp| dp.outdoor_temperature }.uniq
       outdoor_temps.each do |outdoor_temp|
-        num_min = count { |dp| dp.capacity_description == HPXML::CapacityDescriptionMinimum && dp.outdoor_temperature == outdoor_temp }
-        num_max = count { |dp| dp.capacity_description == HPXML::CapacityDescriptionMaximum && dp.outdoor_temperature == outdoor_temp }
-        if (num_min != 1) || (num_max != 1)
+        min_dps = self.select { |dp| dp.capacity_description == HPXML::CapacityDescriptionMinimum && dp.outdoor_temperature == outdoor_temp }
+        max_dps = self.select { |dp| dp.capacity_description == HPXML::CapacityDescriptionMaximum && dp.outdoor_temperature == outdoor_temp }
+        # For every unique outdoor temperature, check we have exactly one minimum and one maximum datapoint
+        if (min_dps.size != 1) || (max_dps.size != 1)
           errors << "Heating detailed performance data for outdoor temperature = #{outdoor_temp} is incomplete; there must be exactly one minimum and one maximum capacity datapoint."
+        else
+          min_capacity = min_dps[0].capacity.nil? ? min_dps[0].capacity_fraction_of_nominal : min_dps[0].capacity
+          max_capacity = max_dps[0].capacity.nil? ? max_dps[0].capacity_fraction_of_nominal : max_dps[0].capacity
+          min_cop = min_dps[0].efficiency_cop
+          max_cop = max_dps[0].efficiency_cop
+
+          # Check power at minimum capacity <= power at maximum capacity
+          if min_capacity / min_cop > max_capacity / max_cop
+            errors << "Heating detailed performance data for outdoor temperature = #{outdoor_temp} is invalid; Power (capacity / COP) at minimum capacity must be less than power at maximum capacity."
+          end
+          # Check minimum capacity <= maximum capacity
+          if min_capacity > max_capacity
+            errors << "Heating detailed performance data for outdoor temperature = #{outdoor_temp} is invalid; Maximum capacity must be greater than minimum capacity."
+          end
         end
       end
+
       return errors
     end
 
@@ -11290,7 +11324,9 @@ class HeatingPerformanceDataPoint < BaseElement
              :capacity_description,         # [String] CapacityDescription (HPXML::CapacityDescriptionXXX)
              :efficiency_cop,               # [Double] Efficiency[Units="COP"]/Value (W/W)
              :gross_capacity,               # FUTURE: Not in HPXML schema, should move to additional_properties
-             :gross_efficiency_cop]         # FUTURE: Not in HPXML schema, should move to additional_properties
+             :gross_efficiency_cop,         # FUTURE: Not in HPXML schema, should move to additional_properties
+             :gross_input_power,            # FUTURE: Not in HPXML schema, should move to additional_properties
+             :input_power]                  # FUTURE: Not in HPXML schema, should move to additional_properties
     attr_accessor(*ATTRS)
 
     # Deletes the current object from the array.