Squashed 'hpxml-measures/' changes from 0b66c38a5e..f5b5c0ea68

f5b5c0ea68 Merge pull request #1712 from NREL/mj8_ventilation a1957244e3 Latest results. 1a024de35b Merge branch 'mj8_ventilation' of https://github.com/NREL/OpenStudio-HPXML into mj8_ventilation 0bf1102664 Merge branch 'master' of https://github.com/NREL/OpenStudio-HPXML into mj8_ventilation d22f6ef664 Merge pull request #1674 from NREL/defrost_improvements f430afbbfe Latest results. 6d5e02aaf7 Merge pull request #1723 from NREL/os380final 512a0716a1 Throw error if old TCM input is used. 184d4b58fb Cleanup. 6001fe4383 Update test. dfadcfb82e Fix error. 8e49cd0663 Update to final OS 3.8 1953ddf99c oops 3da62e2928 address comments 0e843c722b 🤦 68d6a07061 Further match Worksheet E instructions. 7305b3c33f Latest results. 102c209904 Merge branch 'master' of https://github.com/NREL/OpenStudio-HPXML into mj8_ventilation ed22b0e8da Misc language suggestions. f242ee1c14 Merge branch 'master' of https://github.com/NREL/OpenStudio-HPXML into defrost_improvements 0f7604c2ce Merge branch 'defrost_improvements' of https://github.com/NREL/OpenStudio-HPXML into defrost_improvements e2710bb049 update measures 13a75d9ac9 Merge pull request #1719 from NREL/enhance-spaces-hpxml 4c8b7b9047 Latest results. 079f029da4 Merge branch 'master' of https://github.com/NREL/OpenStudio-HPXML into defrost_improvements 7ce36a66bb Add multiple spaces to base-zones-spaces.xml and base-zones-spaces-multiple.xml for better example and testing. ed39bd7885 Merge pull request #1718 from NREL/skylight_bugfix d1eaceb32d Oops [ci skip] 52ff7cf13c Latest results. 257ead464a Updated vent/infil calcs to be consistent with MJ8. 9c7249b067 Latest results. 27b02b3785 bugfix and docs a5b0fcc980 refactor inputs cba595e62e Merge branch 'master' of https://github.com/NREL/OpenStudio-HPXML into defrost_improvements 82d5f8488b Latest results. b12ba5107b Merge branch 'master' of https://github.com/NREL/OpenStudio-HPXML into defrost_improvements 280d3ca2f3 address a few comments a4c855ceef Latest results. bb25da0ddf updates for ductless systems 502f687c98 Merge branch 'master' of https://github.com/NREL/OpenStudio-HPXML into defrost_improvements f186290874 unit multiplier fix with blower and fan power accounted af7ab86d39 bugfix ef48fd2add p_dot_blower and p_dot_odu_fan b35a7b6b18 unit multiplier bugfix, update q_dot p_dot calculation 94b751346b Merge branch 'master' of https://github.com/NREL/OpenStudio-HPXML into defrost_improvements 6330e3cf49 docs and hvac unit test added. 1596977deb bugfix, default, and more test files 152071e59e first cut of defrost EMS and other equipment objects dc68b98704 Merge branch 'master' of https://github.com/NREL/OpenStudio-HPXML into defrost_improvements 0b08c5f9c7 change E+ defrost inputs git-subtree-dir: hpxml-measures git-subtree-split: f5b5c0ea68c31922dd4d7b108d47ea0067cda6a6
NREL · May 19, 2024 · 467acf2 · 467acf2
1 parent ec7e229
commit 467acf2
Show file tree

Hide file tree

Showing 40 changed files with 5,295 additions and 1,483 deletions.
diff --git a/.github/workflows/config.yml b/.github/workflows/config.yml
@@ -11,7 +11,7 @@ jobs:
   run-unit-tests:
     runs-on: ubuntu-latest
     container:
-      image: docker://nrel/openstudio:3.8.0-rc3
+      image: docker://nrel/openstudio:3.8.0
     steps:
       - uses: actions/checkout@v4
         with:
@@ -68,7 +68,7 @@ jobs:
   run-workflow1-tests:
     runs-on: ubuntu-latest
     container:
-      image: docker://nrel/openstudio:3.8.0-rc3
+      image: docker://nrel/openstudio:3.8.0
     steps:
       - uses: actions/checkout@v4
         with:
@@ -91,7 +91,7 @@ jobs:
   run-workflow2-tests:
     runs-on: ubuntu-latest
     container:
-      image: docker://nrel/openstudio:3.8.0-rc3
+      image: docker://nrel/openstudio:3.8.0
     steps:
       - uses: actions/checkout@v4
         with:
@@ -120,8 +120,8 @@ jobs:
       - name: Install software and run test
         shell: pwsh
         run: |
-          $env:OS_VERSION="3.8.0-rc3"
-          $env:OS_SHA="d8eac889d0"
+          $env:OS_VERSION="3.8.0"
+          $env:OS_SHA="f953b6fcaf"
           Invoke-WebRequest -OutFile Windows.tar.gz -URI "https://github.com/NREL/OpenStudio/releases/download/v${env:OS_VERSION}/OpenStudio-${env:OS_VERSION}+${env:OS_SHA}-Windows.tar.gz"
           tar -xzf Windows.tar.gz
           & .\OpenStudio-${env:OS_VERSION}+${env:OS_SHA}-Windows\bin\openstudio.exe workflow\run_simulation.rb -x workflow\sample_files\base.xml --hourly ALL --add-component-loads --add-stochastic-schedules

diff --git a/BuildResidentialHPXML/README.md b/BuildResidentialHPXML/README.md
@@ -180,6 +180,19 @@ Affects the transient calculation of indoor air temperatures. If not provided, t
 
 <br/>
 
+**Simulation Control: Defrost Model Type**
+
+Research feature to select the type of defrost model. Use standard for default E+ defrost setting. Use advanced for an improved model that better accounts for load and energy use during defrost; using advanced may impact simulation runtime. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.7.0/workflow_inputs.html#hpxml-simulation-control'>HPXML Simulation Control</a>) is used.
+
+- **Name:** ``simulation_control_defrost_model_type``
+- **Type:** ``Choice``
+
+- **Required:** ``false``
+
+- **Choices:** `standard`, `advanced`
+
+<br/>
+
 **Site: Type**
 
 The type of site. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.7.0/workflow_inputs.html#hpxml-site'>HPXML Site</a>) is used.

diff --git a/BuildResidentialHPXML/measure.rb b/BuildResidentialHPXML/measure.rb
@@ -116,6 +116,14 @@ def arguments(model) # rubocop:disable Lint/UnusedMethodArgument
     arg.setDescription("Affects the transient calculation of indoor air temperatures. If not provided, the OS-HPXML default (see <a href='#{docs_base_url}#hpxml-simulation-control'>HPXML Simulation Control</a>) is used.")
     args << arg
 
+    defrost_model_type_choices = OpenStudio::StringVector.new
+    defrost_model_type_choices << HPXML::AdvancedResearchDefrostModelTypeStandard
+    defrost_model_type_choices << HPXML::AdvancedResearchDefrostModelTypeAdvanced
+    arg = OpenStudio::Measure::OSArgument::makeChoiceArgument('simulation_control_defrost_model_type', defrost_model_type_choices, false)
+    arg.setDisplayName('Simulation Control: Defrost Model Type')
+    arg.setDescription("Research feature to select the type of defrost model. Use #{HPXML::AdvancedResearchDefrostModelTypeStandard} for default E+ defrost setting. Use #{HPXML::AdvancedResearchDefrostModelTypeAdvanced} for an improved model that better accounts for load and energy use during defrost; using #{HPXML::AdvancedResearchDefrostModelTypeAdvanced} may impact simulation runtime. If not provided, the OS-HPXML default (see <a href='#{docs_base_url}#hpxml-simulation-control'>HPXML Simulation Control</a>) is used.")
+    args << arg
+
     site_type_choices = OpenStudio::StringVector.new
     site_type_choices << HPXML::SiteTypeSuburban
     site_type_choices << HPXML::SiteTypeUrban
@@ -4022,6 +4030,13 @@ def self.set_header(runner, hpxml, args)
       hpxml.header.temperature_capacitance_multiplier = args[:simulation_control_temperature_capacitance_multiplier]
     end
 
+    if not args[:simulation_control_defrost_model_type].nil?
+      if (not hpxml.header.defrost_model_type.nil?) && (hpxml.header.defrost_model_type != args[:simulation_control_defrost_model_type])
+        errors << "'Simulation Control: Defrost Model Type' cannot vary across dwelling units."
+      end
+      hpxml.header.defrost_model_type = args[:simulation_control_defrost_model_type]
+    end
+
     if not args[:emissions_scenario_names].nil?
       emissions_scenario_names = args[:emissions_scenario_names].split(',').map(&:strip)
       emissions_types = args[:emissions_types].split(',').map(&:strip)

diff --git a/BuildResidentialHPXML/measure.xml b/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>89391782-f408-4b0e-9801-b5f67d0f8241</version_id>
-  <version_modified>2024-05-15T20:26:57Z</version_modified>
+  <version_id>d6c720db-f7cf-4aff-b36e-a6e133c6ddc9</version_id>
+  <version_modified>2024-05-17T22:42:28Z</version_modified>
   <xml_checksum>2C38F48B</xml_checksum>
   <class_name>BuildResidentialHPXML</class_name>
   <display_name>HPXML Builder</display_name>
@@ -153,6 +153,24 @@
       <required>false</required>
       <model_dependent>false</model_dependent>
     </argument>
+    <argument>
+      <name>simulation_control_defrost_model_type</name>
+      <display_name>Simulation Control: Defrost Model Type</display_name>
+      <description>Research feature to select the type of defrost model. Use standard for default E+ defrost setting. Use advanced for an improved model that better accounts for load and energy use during defrost; using advanced may impact simulation runtime. If not provided, the OS-HPXML default (see &lt;a href='https://openstudio-hpxml.readthedocs.io/en/v1.7.0/workflow_inputs.html#hpxml-simulation-control'&gt;HPXML Simulation Control&lt;/a&gt;) is used.</description>
+      <type>Choice</type>
+      <required>false</required>
+      <model_dependent>false</model_dependent>
+      <choices>
+        <choice>
+          <value>standard</value>
+          <display_name>standard</display_name>
+        </choice>
+        <choice>
+          <value>advanced</value>
+          <display_name>advanced</display_name>
+        </choice>
+      </choices>
+    </argument>
     <argument>
       <name>site_type</name>
       <display_name>Site: Type</display_name>
@@ -7325,7 +7343,7 @@
       <filename>README.md</filename>
       <filetype>md</filetype>
       <usage_type>readme</usage_type>
-      <checksum>54A95546</checksum>
+      <checksum>65DD9340</checksum>
     </file>
     <file>
       <filename>README.md.erb</filename>
@@ -7342,7 +7360,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>8BEED0CA</checksum>
+      <checksum>4D94208D</checksum>
     </file>
     <file>
       <filename>geometry.rb</filename>

diff --git a/Changelog.md b/Changelog.md
@@ -34,6 +34,7 @@ __New Features__
   - Allows optional ground diffusivity input.
   - Updates to using G-Functions from the [G-Function Library for Modeling Vertical Bore Ground Heat Exchanger](https://gdr.openei.org/submissions/1325).
   - Updated heating/cooling performance curves to reflect newer equipment.
+  - Adds geothermal loop outputs (number/length of boreholes) to annual results output file.
 - Allows optional `Ducts/DuctShape` and `Ducts/DuctFractionRectangular` inputs, which affect duct effective R-value used for modeling.
 - Allows optional `HeatingAutosizingFactor`, `CoolingAutosizingFactor`, `BackupHeatingAutosizingFactor` inputs to scale HVAC capacities for autosized equipment.
 - Allows optional `HeatingAutosizingLimit`, `CoolingAutosizingLimit`, `BackupHeatingAutosizingLimit` inputs to set maximum HVAC capacities ceiling for autosized equipment.
@@ -61,7 +62,6 @@ __New Features__
 - Adds net energy and net electricity timeseries output columns even when there is no PV or generator.
 - Adds more error-checking for inappropriate inputs (e.g., HVAC SHR=0 or clothes washer IMEF=0).
 - Allow alternative label energy use (W) input for ceiling fans.
-- Adds geothermal loop outputs (number/length of boreholes) to annual results output file.
 - Updates to run_simulation.rb script:
   - Allows requesting timeseries outputs with different frequencies (e.g., `--hourly enduses --monthly temperatures`).
   - **Breaking change**: Deprecates `--add-timeseries-output-variable`; EnergyPlus output variables can now be requested like other timeseries categories (using e.g. `--hourly 'Zone People Occupant Count'`).
@@ -71,6 +71,9 @@ __New Features__
   - Other plug load schedules now use Other schedule fractions per ANSI/RESNET/ICC 301-2022 Addendum C.
   - TV plug load schedules now use TV schedule fractions from the American Time Use Survey and monthly multipliers from the 2010 Building America Analysis Spreadsheets.
   - Ceiling fan schedules now use ceiling fan schedule fractions and monthly multipliers from ANSI/RESNET/ICC 301-2022 Addendum C.
+- Advanced research features:
+  - **Breaking change**: Replaces `SimulationControl/TemperatureCapacitanceMultiplier` with `SimulationControl/AdvancedResearchFeatures/TemperatureCapacitanceMultiplier`.
+  - Allows an optional boolean input `SimulationControl/AdvancedResearchFeatures/DefrostModelType` for heat pump advanced defrost model.
 
 __Bugfixes__
 - Fixes error if using AllowIncreasedFixedCapacities=true w/ HP detailed performance data.

diff --git a/HPXMLtoOpenStudio/measure.rb b/HPXMLtoOpenStudio/measure.rb
@@ -1629,7 +1629,8 @@ def add_cooling_system(model, runner, weather, spaces, airloop_map)
 
         airloop_map[sys_id] = HVAC.apply_air_source_hvac_systems(model, runner, cooling_system, heating_system, sequential_cool_load_fracs, sequential_heat_load_fracs,
                                                                  weather.data.AnnualMaxDrybulb, weather.data.AnnualMinDrybulb,
-                                                                 conditioned_zone, @hvac_unavailable_periods, @schedules_file, @hpxml_bldg)
+                                                                 conditioned_zone, @hvac_unavailable_periods, @schedules_file, @hpxml_bldg,
+                                                                 @hpxml_header)
 
       elsif [HPXML::HVACTypeEvaporativeCooler].include? cooling_system.cooling_system_type
 
@@ -1674,7 +1675,8 @@ def add_heating_system(runner, model, weather, spaces, airloop_map)
 
         airloop_map[sys_id] = HVAC.apply_air_source_hvac_systems(model, runner, nil, heating_system, [0], sequential_heat_load_fracs,
                                                                  weather.data.AnnualMaxDrybulb, weather.data.AnnualMinDrybulb,
-                                                                 conditioned_zone, @hvac_unavailable_periods, @schedules_file, @hpxml_bldg)
+                                                                 conditioned_zone, @hvac_unavailable_periods, @schedules_file, @hpxml_bldg,
+                                                                 @hpxml_header)
 
       elsif [HPXML::HVACTypeBoiler].include? heating_system.heating_system_type
 
@@ -1737,7 +1739,8 @@ def add_heat_pump(runner, model, weather, spaces, airloop_map)
 
         airloop_map[sys_id] = HVAC.apply_air_source_hvac_systems(model, runner, heat_pump, heat_pump, sequential_cool_load_fracs, sequential_heat_load_fracs,
                                                                  weather.data.AnnualMaxDrybulb, weather.data.AnnualMinDrybulb,
-                                                                 conditioned_zone, @hvac_unavailable_periods, @schedules_file, @hpxml_bldg)
+                                                                 conditioned_zone, @hvac_unavailable_periods, @schedules_file, @hpxml_bldg,
+                                                                 @hpxml_header)
       elsif [HPXML::HVACTypeHeatPumpGroundToAir].include? heat_pump.heat_pump_type
 
         airloop_map[sys_id] = HVAC.apply_ground_to_air_heat_pump(model, runner, weather, heat_pump,

diff --git a/HPXMLtoOpenStudio/measure.xml b/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>e7f26795-4d02-4766-96ef-2be68a5c28fa</version_id>
-  <version_modified>2024-05-17T00:15:39Z</version_modified>
+  <version_id>a3010ed3-bfec-4d89-b425-0ec627863167</version_id>
+  <version_modified>2024-05-18T15:40:55Z</version_modified>
   <xml_checksum>D8922A73</xml_checksum>
   <class_name>HPXMLtoOpenStudio</class_name>
   <display_name>HPXML to OpenStudio Translator</display_name>
@@ -183,7 +183,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>59D5267D</checksum>
+      <checksum>4D2BAEDD</checksum>
     </file>
     <file>
       <filename>airflow.rb</filename>
@@ -201,7 +201,7 @@
       <filename>constants.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>461EDD72</checksum>
+      <checksum>7B2EC023</checksum>
     </file>
     <file>
       <filename>constructions.rb</filename>
@@ -345,13 +345,13 @@
       <filename>hpxml.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>6812FFA1</checksum>
+      <checksum>65FDCD3D</checksum>
     </file>
     <file>
       <filename>hpxml_defaults.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>EEB1E5B7</checksum>
+      <checksum>DCEA4986</checksum>
     </file>
     <file>
       <filename>hpxml_schema/HPXML.xsd</filename>
@@ -369,7 +369,7 @@
       <filename>hpxml_schematron/EPvalidator.xml</filename>
       <filetype>xml</filetype>
       <usage_type>resource</usage_type>
-      <checksum>A438D5D8</checksum>
+      <checksum>960E3924</checksum>
     </file>
     <file>
       <filename>hpxml_schematron/iso-schematron.xsd</filename>
@@ -381,13 +381,13 @@
       <filename>hvac.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>5C9FA161</checksum>
+      <checksum>0370F183</checksum>
     </file>
     <file>
       <filename>hvac_sizing.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>828250E9</checksum>
+      <checksum>8526074F</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>8EEC2D8E</checksum>
+      <checksum>A84FE910</checksum>
     </file>
     <file>
       <filename>test_enclosure.rb</filename>
@@ -663,13 +663,13 @@
       <filename>test_hvac.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>1F2A5548</checksum>
+      <checksum>8CDA3FA3</checksum>
     </file>
     <file>
       <filename>test_hvac_sizing.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>CA29EBD8</checksum>
+      <checksum>BA43A919</checksum>
     </file>
     <file>
       <filename>test_lighting.rb</filename>
@@ -711,7 +711,7 @@
       <filename>test_validation.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>EB20FBC0</checksum>
+      <checksum>81FC99DF</checksum>
     </file>
     <file>
       <filename>test_water_heater.rb</filename>

diff --git a/HPXMLtoOpenStudio/resources/constants.rb b/HPXMLtoOpenStudio/resources/constants.rb
@@ -288,6 +288,10 @@ def self.ObjectNamePTAC
     return 'packaged terminal air conditioner'
   end
 
+  def self.ObjectNameBackupSuppHeat
+    return 'back up supp heat'
+  end
+
   def self.ObjectNameMiscGrill
     return 'misc grill'
   end