Wrap ZoneHVAC:EvaporativeCoolerUnit #215

joseph-robertson · 2025-01-07T18:50:27Z

Pull request overview

Companion PR:

Wrap ZoneHVAC:EvaporativeCoolerUnit OpenStudio#5326

Link to relevant GitHub Issue(s) if appropriate:

Link to the Ubuntu 22.04 .deb installer to use for CI Testing. If not set, it will default to latest official release.
[OpenStudio Installer]: http://openstudio-ci-builds.s3-website-us-west-2.amazonaws.com/PR-5326/OpenStudio-3.9.1-alpha%2B73365b115a-Ubuntu-22.04-x86_64.deb

This Pull Request is concerning:

Case 1 - NewTest: a new test for a new model API class,
Case 2 - TestFix: a fix for an existing test. The GitHub issue should be referenced in the PR description
Case 3 - NewTestForExisting: a new test for an already-existing model API class
Case 4 - Other: Something else, like maintenance of the repo, or just committing test results with a new OpenStudio version.

Depending on your answer, please fill out the required section below, and delete the three others.
Leave the review checklist in place.

Case 1: New test for a new model API class

This pull request is in relation with the Pull Request:

Wrap ZoneHVAC:EvaporativeCoolerUnit OpenStudio#5326)

and will specifically test for the following classes:

ZoneHVACEvaporativeCoolerUnit

Work Checklist

The following has been checked to ensure compliance with the guidelines:

Review Checklist

Code style (indentation, variable names, strip trailing spaces)
Functional code review (it has to work!)
Matching OSM test has been added or # TODO added to model_tests.rb
Appropriate out.osw have been committed
Test is stable
Object is tested in autosize_hvac as appropriate
The appropriate labels have been added to this PR:
- One of: NewTest, TestFix, NewTestForExisting, Other
- If NewTest: add PendingOSM or AddedOSM

…on 1f4d455848) [x86_64-linux], Rubocop 0.81.0)

jmarrec · 2025-01-16T10:52:34Z

model/simulationtests/zone_hvac_evaporative_cooler.rb

+# Add ZoneHVACEvaporativeCoolerUnit
+zoneHVACEvaporativeCoolerUnit = OpenStudio::Model::ZoneHVACEvaporativeCoolerUnit.new(model)
+direct_evap = zoneHVACEvaporativeCoolerUnit.firstEvaporativeCooler
+indirect_evap = OpenStudio::Model::EvaporativeCoolerIndirectResearchSpecial.new(model)
+zoneHVACEvaporativeCoolerUnit.setSecondEvaporativeCooler(indirect_evap)
+zoneHVACEvaporativeCoolerUnit.addToThermalZone(z)


This should exercise the other setters for demonstration purposes

jmarrec · 2025-01-16T10:53:09Z

model_tests.rb

+  # def test_zone_hvac_evaporative_cooler_py
+  # result = sim_test('zone_hvac_evaporative_cooler.py')
+  # end


TODO: once happy with he ruby test, the python one needs to be added now in this PR

jmarrec · 2025-01-16T10:53:29Z

model_tests.rb

+  # result = sim_test('zone_hvac_evaporative_cooler.py')
+  # end
+
+  # def test_zone_hvac_evaporative_cooler_osm


MISSING the # TODO: To be added in the next official release after: 3.9.0

jmarrec · 2025-01-16T10:54:48Z

Also needs to be added to autosize_hvac test since the Design Supply Air Flow Rate is autosizable

…on 1f4d455848) [x86_64-linux], Rubocop 0.81.0)

jmarrec · 2025-01-16T11:53:32Z

   **   ~~~   ** For explicit details on each unused construction, use Output:Diagnostics,DisplayExtraWarnings;
   ** Severe  ** Missing temperature setpoint for Evap Cooler unit EVAPORATIVE COOLER DIRECT RESEARCH SPECIAL 1
   **   ~~~   **  use a Setpoint Manager to establish a setpoint at the unit control node.
   ** Severe  ** Missing temperature setpoint for Evap Cooler unit EVAPORATIVE COOLER DIRECT RESEARCH SPECIAL 1
   **   ~~~   **  use a Setpoint Manager to establish a setpoint at the unit control node.

…x Direct/Indirect x secondary (8 combos)

…on 1f4d455848) [x86_64-linux], Rubocop 0.81.0)

jmarrec · 2025-01-16T15:28:11Z

model/simulationtests/autosize_hvac.rb

+  when 44
+    zoneHVACEvaporativeCoolerUnit = OpenStudio::Model::ZoneHVACEvaporativeCoolerUnit.new(model)
+    zoneHVACEvaporativeCoolerUnit.autosizeDesignSupplyAirFlowRate
+    zoneHVACEvaporativeCoolerUnit.addToThermalZone(zn)
+


Added to the autosize_hvac! Which told me the method was not implemented correctly so did NatLabRockies/OpenStudio@c969110

jmarrec · 2025-01-16T15:28:28Z

model_tests.rb

+  # result = sim_test('zone_hvac_evaporative_cooler.py')
+  # end
+
+  # def test_zone_hvac_evaporative_cooler_osm


jmarrec · 2025-01-16T15:28:50Z

model/simulationtests/zone_hvac_evaporative_cooler.rb

+# make a 8 stories, 100m X 50m, 8 zone building
+model.add_geometry({ 'length' => 100,
+                     'width' => 50,
+                     'num_floors' => 8,
+                     'floor_to_floor_height' => 4,
+                     'plenum_height' => 0,
+                     'perimeter_zone_depth' => 0 })


Because I found the node connections to be broken, I'm using 8 zones...

jmarrec · 2025-01-16T15:29:16Z

model/simulationtests/zone_hvac_evaporative_cooler.rb

+def make_zone_hvac_cooler(z, direct_is_first: false, add_secondary: true, fan_placement: 'BlowThrough')
+  model = z.model
+  indirect_evap = nil
+  direct_evap = nil
+  if direct_is_first
+    # There is a default ctor
+    zoneHVACEvaporativeCoolerUnit = OpenStudio::Model::ZoneHVACEvaporativeCoolerUnit.new(model)
+    direct_evap = zoneHVACEvaporativeCoolerUnit.firstEvaporativeCooler
+    supplyAirFan = zoneHVACEvaporativeCoolerUnit.supplyAirFan
+
+    fan_system = OpenStudio::Model::FanSystemModel.new(model)
+    zoneHVACEvaporativeCoolerUnit.setSupplyAirFan(fan_system)
+    supplyAirFan.remove
+    supplyAirFan = fan_system
+    # An optional Second EvaporativeCooler
+    if add_secondary
+      indirect_evap = OpenStudio::Model::EvaporativeCoolerIndirectResearchSpecial.new(model)
+      zoneHVACEvaporativeCoolerUnit.setSecondEvaporativeCooler(indirect_evap)
+    end
+  else
+    # And an explicit Ctor:
+    # ZoneHVACEvaporativeCoolerUnit(const Model& model, Schedule& availabilitySchedule, HVACComponent& supplyAirFan, HVACComponent& firstEvaporativeCooler);
+    supplyAirFan = OpenStudio::Model::FanSystemModel.new(model)
+
+    indirect_evap = OpenStudio::Model::EvaporativeCoolerIndirectResearchSpecial.new(model)
+    zoneHVACEvaporativeCoolerUnit = OpenStudio::Model::ZoneHVACEvaporativeCoolerUnit.new(
+      model, model.alwaysOnDiscreteSchedule, supplyAirFan, indirect_evap
+    )
+    # An optional Second EvaporativeCooler
+    if add_secondary
+      direct_evap = OpenStudio::Model::EvaporativeCoolerDirectResearchSpecial.new(model, model.alwaysOnDiscreteSchedule)
+      zoneHVACEvaporativeCoolerUnit.setSecondEvaporativeCooler(direct_evap)
+    end
+  end
+  indirect_evap&.setName("#{z.nameString} Indirect Evaporative Cooler")
+  direct_evap&.setName("#{z.nameString} Direct Evaporative Cooler")
+  supplyAirFan.setName("#{z.nameString} Supply Fan")
+  zoneHVACEvaporativeCoolerUnit.setName("#{z.nameString} Evap Unit")
+  # zoneHVACEvaporativeCoolerUnit.resetSecondEvaporativeCooler
+  #
+  # Redoing what the default constructor does for demonstration purposes
+  # zoneHVACEvaporativeCoolerUnit.setDesignSupplyAirFlowRate(1.0)
+  zoneHVACEvaporativeCoolerUnit.autosizeDesignSupplyAirFlowRate
+  zoneHVACEvaporativeCoolerUnit.setAvailabilitySchedule(model.alwaysOnDiscreteSchedule)
+  zoneHVACEvaporativeCoolerUnit.setSupplyAirFan(zoneHVACEvaporativeCoolerUnit.supplyAirFan)
+  zoneHVACEvaporativeCoolerUnit.setFanPlacement(fan_placement)
+  zoneHVACEvaporativeCoolerUnit.setCoolerUnitControlMethod('ZoneCoolingLoadVariableSpeedFan')
+  zoneHVACEvaporativeCoolerUnit.setThrottlingRangeTemperatureDifference(1.1)
+  zoneHVACEvaporativeCoolerUnit.setCoolingLoadControlThresholdHeatTransferRate(100.0)
+  zoneHVACEvaporativeCoolerUnit.setShutOffRelativeHumidity(100.0)
+
+  # Add it to a ThermalZone
+  zoneHVACEvaporativeCoolerUnit.addToThermalZone(z)
+
+  # Rename nodes for clarity
+  z.zoneAirNode.setName("#{z.nameString} Zone Air Node")
+  # z.returnAirModelObjects.modelObjects[0].setName("#{z.nameString} Zone Return Air Node")
+  z.inletPortList.modelObjects[0].setName("#{z.nameString} Zone Air Inlet Node")
+  z.exhaustPortList.modelObjects[0].setName("#{z.nameString} Zone Air Exhaust Node")
+end


Helper to create a specific configuration

jmarrec · 2025-01-16T15:29:59Z

model/simulationtests/zone_hvac_evaporative_cooler.rb

+# In order to produce more consistent results between different runs,
+# we sort the zones by names
+zones = model.getThermalZones.sort_by { |z| z.name.to_s }
+
+configs = [
+  { zone_name: 'DirectFirst', direct_is_first: true, add_secondary: true },
+
+  # Mimic SMStore8 from StripMallZoneEvapCoolerAutosized.idf
+  # https://github.com/NREL/EnergyPlus/blob/31e3c33467c5873371bf48b12a7318215971c315/testfiles/StripMallZoneEvapCoolerAutosized.idf#L4767-L4784
+  { zone_name: 'IndirectFirst', direct_is_first: false, add_secondary: true },
+
+  { zone_name: 'DirectOnly', direct_is_first: true, add_secondary: false },
+
+  { zone_name: 'IndirectOnly', direct_is_first: false, add_secondary: false }
+]
+fan_placements = ['BlowThrough', 'DrawThrough']
+raise 'Mismatch' unless configs.size * fan_placements.size == zones.size
+
+configs.product(fan_placements).zip(zones).each do |(config, fan_placement), z|
+  z.setName("#{config[:zone_name]} #{fan_placement} Zn")
+  make_zone_hvac_cooler(
+    z,
+    direct_is_first: config[:direct_is_first],
+    add_secondary: config[:add_secondary],
+    fan_placement: fan_placement
+  )
+end


Testing 8 combinations: for each of these four, I test BlowThrough + DrawThrough

DirectOnly

IndirectOnly

Direct then Indirect

Indirect then Direct

jmarrec · 2025-01-16T15:32:28Z

Geez, eplusout.err still shows a node error

   ** Severe  ** Node Connection Error, Node="DIRECTFIRST DRAWTHROUGH ZN EVAP UNIT FIRST EVAPORATIVE COOLER - SECOND EVAPORATIVE COOLER NODE", Inlet node did not find an appropriate matching "outlet" node.
   **   ~~~   ** If this is an outdoor air inlet node, it must be listed in an OutdoorAir:Node or OutdoorAir:NodeList object.
   **   ~~~   ** Reference Object=EvaporativeCooler:Indirect:ResearchSpecial, Name=DIRECTFIRST DRAWTHROUGH ZN INDIRECT EVAPORATIVE COOLER
   ** Severe  ** Node Connection Error, Node="INDIRECTFIRST DRAWTHROUGH ZN EVAP UNIT FIRST EVAPORATIVE COOLER - SECOND EVAPORATIVE COOLER NODE", Inlet node did not find an appropriate matching "outlet" node.
   **   ~~~   ** If this is an outdoor air inlet node, it must be listed in an OutdoorAir:Node or OutdoorAir:NodeList object.
   **   ~~~   ** Reference Object=EvaporativeCooler:Direct:ResearchSpecial, Name=INDIRECTFIRST DRAWTHROUGH ZN DIRECT EVAPORATIVE COOLER

cf NatLabRockies/OpenStudio-resources#215 (comment)

jmarrec · 2025-01-16T15:50:18Z

Geez, eplusout.err still shows a node error

   ** Severe  ** Node Connection Error, Node="DIRECTFIRST DRAWTHROUGH ZN EVAP UNIT FIRST EVAPORATIVE COOLER - SECOND EVAPORATIVE COOLER NODE", Inlet node did not find an appropriate matching "outlet" node.
   **   ~~~   ** If this is an outdoor air inlet node, it must be listed in an OutdoorAir:Node or OutdoorAir:NodeList object.
   **   ~~~   ** Reference Object=EvaporativeCooler:Indirect:ResearchSpecial, Name=DIRECTFIRST DRAWTHROUGH ZN INDIRECT EVAPORATIVE COOLER
   ** Severe  ** Node Connection Error, Node="INDIRECTFIRST DRAWTHROUGH ZN EVAP UNIT FIRST EVAPORATIVE COOLER - SECOND EVAPORATIVE COOLER NODE", Inlet node did not find an appropriate matching "outlet" node.
   **   ~~~   ** If this is an outdoor air inlet node, it must be listed in an OutdoorAir:Node or OutdoorAir:NodeList object.
   **   ~~~   ** Reference Object=EvaporativeCooler:Direct:ResearchSpecial, Name=INDIRECTFIRST DRAWTHROUGH ZN DIRECT EVAPORATIVE COOLER

Ok fixed via NatLabRockies/OpenStudio@73365b1

jmarrec · 2025-01-16T15:51:05Z

Getting a warning in ONE of the cases, but AFAIK I can't fix that anyways,so I'm going to ignore it (FYI @joseph-robertson )

   ** Severe  ** Missing temperature setpoint for Evap Cooler unit DIRECTFIRST BLOWTHROUGH ZN DIRECT EVAPORATIVE COOLER
   **   ~~~   **  use a Setpoint Manager to establish a setpoint at the unit control node.

jmarrec · 2025-01-16T16:17:03Z

model/simulationtests/zone_hvac_evaporative_cooler.py

Here is that python version!

Stub new zonehvac evap cooler test file.

be72603

joseph-robertson added NewTest PR type: a new test for a new model API class PendingOSM A matching OSM test has yet to be added with the next official OpenStudio Release labels Jan 7, 2025

joseph-robertson self-assigned this Jan 7, 2025

Commit rubocop --auto-correct (Ruby ruby 2.7.8p225 (2023-03-30 revisi…

fa5ae45

…on 1f4d455848) [x86_64-linux], Rubocop 0.81.0)

jmarrec force-pushed the zonehvac-evap-cooler branch 2 times, most recently from 9c7f8bf to 0aba90c Compare January 9, 2025 13:24

jmarrec mentioned this pull request Jan 15, 2025

Wrap ZoneHVAC:EvaporativeCoolerUnit NatLabRockies/OpenStudio#5326

Merged

19 tasks

Adjust test and rename nodes for clarity

75f4ccc

jmarrec force-pushed the zonehvac-evap-cooler branch from 0aba90c to 75f4ccc Compare January 16, 2025 10:39

jmarrec reviewed Jan 16, 2025

View reviewed changes

jmarrec and others added 3 commits January 16, 2025 12:00

Add missing TODO + exercice entire API for demonstration purposes

96801a1

Add ZoneHVACEvaporativeCoollerUnit to autosize_hvac

9eaada9

Commit rubocop --auto-correct (Ruby ruby 2.7.8p225 (2023-03-30 revisi…

f16dda8

…on 1f4d455848) [x86_64-linux], Rubocop 0.81.0)

jmarrec and others added 3 commits January 16, 2025 16:03

Make the test use both configuration: Direct first or Indirect first.

516030d

The nodes are HARD to manage: test all combinations of Fan Placement …

9670dce

…x Direct/Indirect x secondary (8 combos)

Commit rubocop --auto-correct (Ruby ruby 2.7.8p225 (2023-03-30 revisi…

f90ba33

…on 1f4d455848) [x86_64-linux], Rubocop 0.81.0)

jmarrec marked this pull request as ready for review January 16, 2025 15:26

jmarrec approved these changes Jan 16, 2025

View reviewed changes

jmarrec added a commit to NatLabRockies/OpenStudio that referenced this pull request Jan 16, 2025

Fix Severe Node Connection error

73365b1

cf NatLabRockies/OpenStudio-resources#215 (comment)

Make a python version of the test

9c626d4

jmarrec approved these changes Jan 16, 2025

View reviewed changes

model/simulationtests/zone_hvac_evaporative_cooler.py

Copy link

Contributor

jmarrec Jan 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here is that python version!

Lint (isort & black) the new python test

0299faf

jmarrec merged commit 306c503 into develop Jan 30, 2025
2 of 3 checks passed

jmarrec deleted the zonehvac-evap-cooler branch January 30, 2025 10:29

jmarrec added AddedOSM A matching OSM test has been added with an official OpenStudio release and removed PendingOSM A matching OSM test has yet to be added with the next official OpenStudio Release labels Jun 20, 2025

Wrap ZoneHVAC:EvaporativeCoolerUnit #215

Wrap ZoneHVAC:EvaporativeCoolerUnit #215

Uh oh!

Conversation

joseph-robertson commented Jan 7, 2025 • edited by jmarrec Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull request overview

Case 1: New test for a new model API class

Work Checklist

Review Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jmarrec commented Jan 16, 2025

Uh oh!

jmarrec commented Jan 16, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jmarrec commented Jan 16, 2025

Uh oh!

jmarrec commented Jan 16, 2025

Uh oh!

jmarrec commented Jan 16, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

joseph-robertson commented Jan 7, 2025 •

edited by jmarrec

Loading