Squashed 'resources/hpxml-measures/' changes from 9a9e161fe79..af5aa8…

…d0329

af5aa8d0329 Merge pull request #1729 from NREL/msgpack_num_decimal
3613b3a118e Merge branch 'master' of https://github.com/NREL/OpenStudio-HPXML into msgpack_num_decimal
0464d0f2a1b Merge pull request #1668 from NREL/tcm
92461e0dd85 Allow specifying the number of decimal places in the msgpack timeseries output file if desired.
885ca266360 Update Changelog.md [ci skip]
2aaeea43fe6 Merge branch 'tcm' of https://github.com/NREL/OpenStudio-HPXML into tcm
84b537c5b65 Address FIXME.
cf34e930f47 Latest results.
d69047cd470 Merge branch 'master' of https://github.com/NREL/OpenStudio-HPXML into tcm
ff7edc61146 Increase cooling setpoint by 1F to avoid NREL/OpenStudio-HPXML#1728.
1c8fec2b53b Merge branch 'master' of https://github.com/NREL/OpenStudio-HPXML into tcm
e33fd4ab605 Merge branch 'master' of https://github.com/NREL/OpenStudio-HPXML into tcm
3cf79029b58 Latest results.
40cf39be6f3 Merge branch 'master' of https://github.com/NREL/OpenStudio-HPXML into tcm
1fde6c94bc8 Latest results.
8a424ac348e Merge branch 'master' of https://github.com/NREL/OpenStudio-HPXML into tcm
4d683d214ef Skip test for now.
65e9873dd06 update measure.xml
1c8a6d382ab Merge branch 'master' of https://github.com/NREL/OpenStudio-HPXML into tcm
c5ccab5eb07 Make rubocop happy.
0d4064ecd40 Merge branch 'master' of https://github.com/NREL/OpenStudio-HPXML into tcm
a4640da4cc8 Fix a CI test.
c364d15971a Updates default temperature capacitance multiplier to 7.

git-subtree-dir: resources/hpxml-measures
git-subtree-split: af5aa8d03298b86af8f96317c5303647553a17d3

Changelog.md

@@ -41,6 +41,7 @@ __New Features__
 - Adds optional `Slab/extension/GapInsulationRValue` input for cases where a slab has horizontal (under slab) insulation.
 - Allows radiant barriers for additional locations (attic gable walls and floor); reduced emissivity due to dust assumed for radiant barriers on attic floor.
 - Adds window and skylight `GlassType` options of "low-e, high-solar-gain" and "low-e, low-solar-gain"; updates U-factor/SHGC lookup tables.
+- Updates default temperature capacitance multiplier from 1 to 7, an average value found in the literature when calibrating timeseries EnergyPlus indoor temperatures to field data.
 - BuildResidentialHPXML measure:
   - **Breaking change**: Replaces `roof_radiant_barrier`/`roof_radiant_barrier_grade` arguments with `radiant_barrier_attic_location`/`radiant_barrier_grade`.
   - Allows specifying number of bedrooms served by the water heater which is used for apportioning tank losses; **Breaking change**: Replaces `water_heater_num_units_served` with `water_heater_num_bedrooms_served`.

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>e1ba2ce2-ad01-41ba-87d8-6571f385e588</version_id>
-  <version_modified>2024-05-19T18:13:06Z</version_modified>
+  <version_id>74afbf86-1597-475c-9d85-162dda013201</version_id>
+  <version_modified>2024-05-24T00:01:31Z</version_modified>
   <xml_checksum>D8922A73</xml_checksum>
   <class_name>HPXMLtoOpenStudio</class_name>
   <display_name>HPXML to OpenStudio Translator</display_name>
@@ -351,7 +351,7 @@
       <filename>hpxml_defaults.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>DCEA4986</checksum>
+      <checksum>ACA8684E</checksum>
     </file>
     <file>
       <filename>hpxml_schema/HPXML.xsd</filename>
@@ -381,13 +381,13 @@
       <filename>hvac.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>0370F183</checksum>
+      <checksum>FC8B73E3</checksum>
     </file>
     <file>
       <filename>hvac_sizing.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>8526074F</checksum>
+      <checksum>E9C68804</checksum>
     </file>
     <file>
       <filename>lighting.rb</filename>
@@ -639,7 +639,7 @@
       <filename>test_defaults.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>A84FE910</checksum>
+      <checksum>FC67054F</checksum>
     </file>
     <file>
       <filename>test_enclosure.rb</filename>

HPXMLtoOpenStudio/resources/hpxml_defaults.rb

@@ -169,7 +169,7 @@ def self.apply_header(hpxml_header, epw_file, hpxml_bldg)
     end
 
     if hpxml_header.temperature_capacitance_multiplier.nil?
-      hpxml_header.temperature_capacitance_multiplier = 1.0
+      hpxml_header.temperature_capacitance_multiplier = 7.0
       hpxml_header.temperature_capacitance_multiplier_isdefaulted = true
     end
 

HPXMLtoOpenStudio/resources/hvac_sizing.rb

@@ -3919,8 +3919,7 @@ def self.write_detailed_output(output_format, output_file_path, hpxml_bldg, all_
                         HPXML::OrientationSouth => 'S',
                         HPXML::OrientationSoutheast => 'SE',
                         HPXML::OrientationSouthwest => 'SW',
-                        HPXML::OrientationWest => 'W',
-                        nil => 'N/S/E/W' }
+                        HPXML::OrientationWest => 'W' }
 
     def self.windows(obj)
       return obj.windows.select { |s| s.additional_properties.respond_to?(:formj1_values) }

HPXMLtoOpenStudio/tests/test_defaults.rb

@@ -55,7 +55,7 @@ def test_header
     hpxml.header.sim_calendar_year = 2020
     XMLHelper.write_file(hpxml.to_doc, @tmp_hpxml_path)
     default_hpxml, _default_hpxml_bldg = _test_measure()
-    _test_default_header_values(default_hpxml, 60, 1, 1, 12, 31, 2012, 1.0, nil, nil, nil)
+    _test_default_header_values(default_hpxml, 60, 1, 1, 12, 31, 2012, 7.0, nil, nil, nil)
 
     # Test defaults - southern hemisphere
     hpxml, _hpxml_bldg = _create_hpxml('base-location-capetown-zaf.xml')
@@ -68,7 +68,7 @@ def test_header
     hpxml.header.temperature_capacitance_multiplier = nil
     XMLHelper.write_file(hpxml.to_doc, @tmp_hpxml_path)
     default_hpxml, _default_hpxml_bldg = _test_measure()
-    _test_default_header_values(default_hpxml, 60, 1, 1, 12, 31, 2007, 1.0, nil, nil, nil)
+    _test_default_header_values(default_hpxml, 60, 1, 1, 12, 31, 2007, 7.0, nil, nil, nil)
   end
 
   def test_emissions_factors

ReportSimulationOutput/README.md

@@ -382,7 +382,7 @@ Determines whether timeseries timestamps use the start-of-period or end-of-perio
 
 **Generate Timeseries Output: Number of Decimal Places**
 
-Allows overriding the default number of decimal places for timeseries output. Does not apply if output format is msgpack, where no rounding is performed because there is no file size penalty to storing full precision.
+Allows overriding the default number of decimal places for timeseries output.
 
 - **Name:** ``timeseries_num_decimal_places``
 - **Type:** ``Integer``

ReportSimulationOutput/measure.rb

@@ -247,7 +247,7 @@ def arguments(model) # rubocop:disable Lint/UnusedMethodArgument
 
     arg = OpenStudio::Measure::OSArgument::makeIntegerArgument('timeseries_num_decimal_places', false)
     arg.setDisplayName('Generate Timeseries Output: Number of Decimal Places')
-    arg.setDescription('Allows overriding the default number of decimal places for timeseries output. Does not apply if output format is msgpack, where no rounding is performed because there is no file size penalty to storing full precision.')
+    arg.setDescription('Allows overriding the default number of decimal places for timeseries output.')
     args << arg
 
     arg = OpenStudio::Measure::OSArgument::makeBoolArgument('add_timeseries_dst_column', false)
@@ -1599,11 +1599,11 @@ def report_timeseries_output_results(runner, outputs, timeseries_output_path, ar
       fail "Unexpected timeseries_frequency: #{args[:timeseries_frequency]}."
     end
 
-    if args[:output_format] == 'msgpack'
+    if not args[:timeseries_num_decimal_places].nil?
+      n_digits = args[:timeseries_num_decimal_places]
+    elsif args[:output_format] == 'msgpack'
       # No need to round; no file size penalty to storing full precision
       n_digits = 100
-    elsif not args[:timeseries_num_decimal_places].nil?
-      n_digits = args[:timeseries_num_decimal_places]
     else
       # Set rounding precision for timeseries (e.g., hourly) outputs.
       # Note: Make sure to round outputs with sufficient resolution for the worst case -- i.e., 1 minute date instead of hourly data.

ReportSimulationOutput/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.1</schema_version>
   <name>report_simulation_output</name>
   <uid>df9d170c-c21a-4130-866d-0d46b06073fd</uid>
-  <version_id>bd97b330-917d-4c82-a98a-61990e0ed4d0</version_id>
-  <version_modified>2024-05-19T16:40:46Z</version_modified>
+  <version_id>ec111528-5b18-43ad-ae95-0a41f5aaec05</version_id>
+  <version_modified>2024-05-24T00:08:38Z</version_modified>
   <xml_checksum>9BF1E6AC</xml_checksum>
   <class_name>ReportSimulationOutput</class_name>
   <display_name>HPXML Simulation Output Report</display_name>
@@ -661,7 +661,7 @@
     <argument>
       <name>timeseries_num_decimal_places</name>
       <display_name>Generate Timeseries Output: Number of Decimal Places</display_name>
-      <description>Allows overriding the default number of decimal places for timeseries output. Does not apply if output format is msgpack, where no rounding is performed because there is no file size penalty to storing full precision.</description>
+      <description>Allows overriding the default number of decimal places for timeseries output.</description>
       <type>Integer</type>
       <required>false</required>
       <model_dependent>false</model_dependent>
@@ -1912,7 +1912,7 @@
       <filename>README.md</filename>
       <filetype>md</filetype>
       <usage_type>readme</usage_type>
-      <checksum>86FD2C61</checksum>
+      <checksum>CDB2D617</checksum>
     </file>
     <file>
       <filename>README.md.erb</filename>
@@ -1929,7 +1929,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>8AC9A54E</checksum>
+      <checksum>BA579923</checksum>
     </file>
     <file>
       <filename>test_report_sim_output.rb</filename>

docs/source/workflow_inputs.rst

@@ -105,10 +105,11 @@ These features may require shorter timesteps, allow more sophisticated simulatio
   ====================================  ========  =======  ================  ========  ========  ========================================================
   Element                               Type      Units    Constraints       Required  Default   Notes
   ====================================  ========  =======  ================  ========  ========  ========================================================
-  ``TemperatureCapacitanceMultiplier``  double             > 0               No        1.0       Multiplier on air heat capacitance [#]_
+  ``TemperatureCapacitanceMultiplier``  double             > 0               No        7.0 [#]_  Multiplier on air heat capacitance [#]_
   ``DefrostModelType``                  string             See [#]_          No        standard  Defrost model type for air source heat pumps [#]_
   ====================================  ========  =======  ================  ========  ========  ========================================================
 
+  .. [#] The default value of 7 is an average value found in the literature when calibrating timeseries EnergyPlus indoor temperatures to field data.
   .. [#] TemperatureCapacitanceMultiplier affects the transient calculation of indoor air temperatures.
          Values greater than 1.0 have the effect of smoothing or damping the rate of change in the indoor air temperature from timestep to timestep.
          This heat capacitance effect is modeled on top of any other individual mass inputs (e.g., furniture mass, partition wall mass, interior drywall, etc.) in the HPXML.

workflow/real_homes/house019.xml

@@ -356,7 +356,7 @@
             <SetbackTempHeatingSeason>65.0</SetbackTempHeatingSeason>
             <TotalSetbackHoursperWeekHeating>49</TotalSetbackHoursperWeekHeating>
             <SetupTempCoolingSeason>75.0</SetupTempCoolingSeason>
-            <SetpointTempCoolingSeason>70.0</SetpointTempCoolingSeason>
+            <SetpointTempCoolingSeason>71.0</SetpointTempCoolingSeason>
             <TotalSetupHoursperWeekCooling>42</TotalSetupHoursperWeekCooling>
           </HVACControl>
           <HVACDistribution>

workflow/tests/base_results/results_ashrae_140.csv

@@ -1,27 +1,27 @@
 Test Case,Annual Heating Load [MMBtu],Annual Cooling Load [MMBtu]
-L100AC.xml,51.41,N/A
-L110AC.xml,77.05,N/A
-L120AC.xml,39.84,N/A
-L130AC.xml,43.86,N/A
-L140AC.xml,48.05,N/A
-L150AC.xml,40.85,N/A
-L155AC.xml,44.14,N/A
-L160AC.xml,52.19,N/A
-L170AC.xml,62.0,N/A
-L200AC.xml,124.27,N/A
-L202AC.xml,131.27,N/A
-L302XC.xml,46.87,N/A
-L304XC.xml,45.2,N/A
-L322XC.xml,66.93,N/A
-L324XC.xml,48.62,N/A
-L100AL.xml,N/A,51.47
-L110AL.xml,N/A,55.25
-L120AL.xml,N/A,47.69
-L130AL.xml,N/A,36.35
-L140AL.xml,N/A,24.32
-L150AL.xml,N/A,64.56
-L155AL.xml,N/A,48.79
-L160AL.xml,N/A,62.49
-L170AL.xml,N/A,42.11
-L200AL.xml,N/A,64.53
-L202AL.xml,N/A,54.83
+L100AC.xml,51.28,N/A
+L110AC.xml,76.84,N/A
+L120AC.xml,39.74,N/A
+L130AC.xml,43.88,N/A
+L140AC.xml,48.15,N/A
+L150AC.xml,40.49,N/A
+L155AC.xml,43.88,N/A
+L160AC.xml,52.13,N/A
+L170AC.xml,61.89,N/A
+L200AC.xml,123.75,N/A
+L202AC.xml,130.8,N/A
+L302XC.xml,46.8,N/A
+L304XC.xml,45.13,N/A
+L322XC.xml,66.99,N/A
+L324XC.xml,48.68,N/A
+L100AL.xml,N/A,50.42
+L110AL.xml,N/A,54.33
+L120AL.xml,N/A,46.96
+L130AL.xml,N/A,35.82
+L140AL.xml,N/A,24.02
+L150AL.xml,N/A,62.19
+L155AL.xml,N/A,46.92
+L160AL.xml,N/A,61.5
+L170AL.xml,N/A,41.14
+L200AL.xml,N/A,63.27
+L202AL.xml,N/A,54.21

workflow/tests/base_results/results_hers_dse.csv

@@ -1,9 +1,9 @@
 Test Case,Heat/Cool (kWh or therm),HVAC Fan (kWh)
-HVAC3a.xml,560.83,453.09
-HVAC3e.xml,6335.32,980.03
-HVAC3b.xml,677.0,660.0
-HVAC3c.xml,588.34,525.48
-HVAC3d.xml,640.83,624.83
-HVAC3f.xml,7992.34,1236.76
-HVAC3g.xml,6754.41,1042.16
-HVAC3h.xml,7519.91,1137.99
+HVAC3a.xml,557.36,450.16
+HVAC3e.xml,6217.5,957.76
+HVAC3b.xml,673.73,656.77
+HVAC3c.xml,585.15,522.55
+HVAC3d.xml,637.48,621.6
+HVAC3f.xml,7859.29,1211.56
+HVAC3g.xml,6632.49,1019.3
+HVAC3h.xml,7388.32,1113.67

workflow/tests/base_results/results_hers_hot_water.csv

@@ -7,9 +7,9 @@ L100AD-HW-05.xml,548.5,439.6
 L100AD-HW-06.xml,227.5,5.9
 L100AD-HW-07.xml,206.5,0.0
 L100AM-HW-01.xml,110.3,0.0
-L100AM-HW-02.xml,135.7,0.0
-L100AM-HW-03.xml,90.9,0.0
+L100AM-HW-02.xml,135.6,0.0
+L100AM-HW-03.xml,90.8,0.0
 L100AM-HW-04.xml,132.5,0.0
-L100AM-HW-05.xml,295.8,439.6
+L100AM-HW-05.xml,295.7,439.6
 L100AM-HW-06.xml,122.7,5.9
 L100AM-HW-07.xml,120.4,0.0

workflow/tests/base_results/results_hers_hvac.csv

@@ -1,8 +1,8 @@
 Test Case,HVAC (kWh or therm),HVAC Fan (kWh)
-HVAC1a.xml,6277.0,803.89
-HVAC1b.xml,4660.12,803.89
-HVAC2a.xml,639.46,623.66
-HVAC2b.xml,554.19,623.66
-HVAC2c.xml,7623.36,1192.21
-HVAC2d.xml,4619.68,1192.21
-HVAC2e.xml,14617.8,623.66
+HVAC1a.xml,6160.06,785.72
+HVAC1b.xml,4574.55,785.72
+HVAC2a.xml,635.91,620.14
+HVAC2b.xml,551.12,620.14
+HVAC2c.xml,7589.08,1187.82
+HVAC2d.xml,4600.92,1187.82
+HVAC2e.xml,14536.62,620.14