Wrap ZoneHVAC:EvaporativeCoolerUnit #5326

joseph-robertson · 2024-12-18T21:52:05Z

Pull request overview

Fixes Wrap ZoneHVAC:EvaporativeCoolerUnit #5253

Pull Request Author

Model API Changes / Additions
Any new or modified fields have been implemented in the EnergyPlus ForwardTranslator (and ReverseTranslator as appropriate)
Model API methods are tested (in src/model/test)
EnergyPlus ForwardTranslator Tests (in src/energyplus/Test)
If a new object or method, added a test in NREL/OpenStudio-resources: Add Link
If needed, added VersionTranslation rules for the objects (src/osversion/VersionTranslator.cpp)
Verified that C# bindings built fine on Windows, partial classes used as needed, etc.
All new and existing tests passes
If methods have been deprecated, update rest of code to use the new methods

Labels:

If change to an IDD file, add the label IDDChange
If breaking existing API, add the label APIChange
If deemed ready, add label Pull Request - Ready for CI so that CI builds your PR

Review Checklist

This will not be exhaustively relevant to every PR.

Perform a Code Review on GitHub
Code Style, strip trailing whitespace, etc.
All related changes have been implemented: model changes, model tests, FT changes, FT tests, VersionTranslation, OS App
Labeling is ok
If defect, verify by running develop branch and reproducing defect, then running PR and reproducing fix
If feature, test running new feature, try creative ways to break it
CI status: all green or justified

resources/model/OpenStudio.idd

jmarrec · 2024-12-19T10:55:36Z

resources/model/OpenStudio.idd

+  A5,  \field Outdoor Air Inlet Node Name
+       \required-field
+       \type object-list
+       \object-list ConnectionNames
+       \note this is an outdoor air node


I think you may want to not add it?

resources/model/OpenStudio.idd

jmarrec · 2024-12-19T11:00:34Z

resources/model/OpenStudio.idd

+  A11, \field First Evaporative Cooler Object Name
+       \required-field
+       \type object-list
+       \object-list EvapCoolerNames
+  A12, \field Second Evaporative Cooler Name


I know this is just E+. still bothers me that the second doesn't have "Object" in it.
In any case, beware here because GenerateClass.rb will name the getters/setters differently and we don't want that.

I'd remove both "Object Name" from it, so that the getters are firstEvaporativeCooler and secondEvaporativeCooler

jmarrec

Pretty minor comments (mostly: tests), this is looking very good otherwise.

jmarrec · 2024-12-24T08:18:05Z

src/model/test/ZoneHVACEvaporativeCoolerUnit_GTest.cpp

Would be good to add tests for:

Nodes/Connections:

addToThermalZone (are the inlet/outlet nodes set correctly)

addToNode.

Not familiar with this object, but at least it should be rejected on a PlantLoop, Not sure about AirLoopHVAC (ZoneHVACComponent will allow a connection with an AirTerminalSingleDuctInletSideMixer). Bottom line: are the addToThermalZone & addToNode from ZoneHVACComponent doing the right thing for this object?

clone: same model, and another model. And remove.

OpenStudio/src/model/ZoneHVACComponent.cpp

Lines 320 to 336 in 0314c3e

bool ZoneHVACComponent_Impl::addToNode(Node& node) {

bool result = false;

boost::optional<ThermalZone> thermalZone;

boost::optional<AirTerminalSingleDuctInletSideMixer> terminal;

if (boost::optional<ModelObject> outlet = node.outletModelObject()) {

if (boost::optional<PortList> pl = outlet->optionalCast<PortList>()) {

thermalZone = pl->thermalZone();

}

}

if (boost::optional<ModelObject> inlet = node.inletModelObject()) {

terminal = inlet->optionalCast<AirTerminalSingleDuctInletSideMixer>();

}

if (thermalZone && terminal) {

jmarrec · 2024-12-24T08:20:07Z

src/model/ZoneHVACEvaporativeCoolerUnit.cpp

+      return std::move(evaporativeCoolUnitClone);
+    }
+
+    std::vector<IdfObject> ZoneHVACEvaporativeCoolerUnit_Impl::remove() {


Could consider using #include "../utilities/core/ContainersMove.hpp", eg

OpenStudio/src/model/Building.cpp

Line 122 in 0314c3e

openstudio::detail::concat_helper(result, ParentObject_Impl::remove());

Also, given the way you wrote the children() method, I'm not sure explicitly cloning the children is necessary, but I could be wrong. In the end, I only care if the (future) test shows everything works as expected.

src/model/ZoneHVACEvaporativeCoolerUnit.cpp

jmarrec · 2024-12-24T08:29:18Z

src/osversion/VersionTranslator.cpp

Why is there a (clang-format) diff here?

jmarrec · 2024-12-24T08:31:24Z

src/energyplus/ForwardTranslator/ForwardTranslateZoneHVACEvaporativeCoolerUnit.cpp

+    // Outdoor Air Inlet Node Name: Required Node
+    if (boost::optional<Node> node = modelObject.inletNode()) {


Do/should we catch the case where it's somehow not set?

src/energyplus/ForwardTranslator/ForwardTranslateZoneHVACEvaporativeCoolerUnit.cpp

jmarrec · 2025-01-06T08:53:52Z

The following tests FAILED:
	2756 - ModelFixture.ZoneHVACEvaporativeCoolerUnit_clone (Failed)
	2757 - ModelFixture.ZoneHVACEvaporativeCoolerUnit_remove (Failed)
	2758 - ModelFixture.ZoneHVACEvaporativeCoolerUnit_addToNode (Failed)

joseph-robertson · 2025-01-06T16:53:08Z

src/model/test/ZoneHVACEvaporativeCoolerUnit_GTest.cpp

+  EXPECT_FALSE(zonehvac.remove().empty());
+  EXPECT_EQ(size - 1, m.modelObjects().size());


I'm not really sure what remove is actually supposed to remove. Looks like, without an override, it currently removes more than just the ZoneHVACEvaporativeCoolerUnit...?

Remove is supposed to remove the children - that aren't resource objects - and their recursive children as well as the ZoneHVACEvaporativeCoolerUnit.

ZoneHVACEvaporativeCoolerUnit is a ZoneHVACComponent > HVACComponent > ParentObject

Eventually this is what's called.

OpenStudio/src/model/ParentObject.cpp

Lines 44 to 72 in 0314c3e

/// remove self and all children objects recursively

std::vector<IdfObject> ParentObject_Impl::remove() {

std::vector<IdfObject> result;

// DLM: the following code does not work because subTree includes this object

// and we don't want to call remove on the same object recursively

//

//ModelObjectVector subTree = getRecursiveChildren(getObject<ParentObject>());

//for (ModelObject& object : subTree) {

// std::vector<IdfObject> removed = object.remove();

// result.insert(result.end(), removed.begin(), removed.end());

//}

// subTree includes this object, make sure to include costs as well

// drop the ResourceObject instances, if they are used by other objects

// This is probably the unique situation where you want to get children minus ResourceObjects

auto subTree = getRecursiveChildren(getObject<ParentObject>(), true, false);

result.reserve(subTree.size());

for (const ModelObject& object : subTree) {

result.emplace_back(object.idfObject());

}

bool ok = model().removeObjects(getHandles<ModelObject>(subTree));

if (!ok) {

result.clear();

}

return result;

}

i'm building your PR locally, will check out the tests in a bit

jmarrec · 2025-01-07T16:13:46Z

src/model/ZoneHVACEvaporativeCoolerUnit.hpp

+
+    Schedule availabilitySchedule() const;
+
+    HVACComponent supplyAirFan() const;


All fans need an addition to their containingZoneHVACComponent

This is used in particular to check if the HVACComponent::isRemovable when remove() is called.

jmarrec · 2025-01-07T16:18:51Z

src/model/ZoneHVACEvaporativeCoolerUnit.hpp

+
+    double coolingLoadControlThresholdHeatTransferRate() const;
+
+    HVACComponent firstEvaporativeCooler() const;


SAme comment

There are five types of evaporative cooler component models to choose from: EvaporativeCooler:Direct:CelDekPad, EvaporativeCooler:Direct:ResearchSpecial, EvaporativeCooler:Indirect:CelDekPad, EvaporativeCooler:Indirect:WetCoil, or EvaporativeCooler:Indirect:ResearchSpecial.

For us that's EvaporativeCoolerDirectResearchSpecial and EvaporativeCoolerIndirectResearchSpecial

…ponent` #5326 (comment)

… models `containingZoneHVACComponent` cf #5326 (comment)

jmarrec · 2025-01-07T16:49:37Z

@joseph-robertson I made adjustments: https://github.com/NREL/OpenStudio/pull/5326/files/4cb656d678a376bb72010aacce41d44eefd03c47..bbbda1d885418e99ff57e9094f8803acda1ceab2

You'll need to add an OpenStudio-resources test for this object and add it to the top post's checklist please

ci-commercialbuildings · 2025-01-07T17:10:45Z

CI Results for bbbda1d:

Ubuntu 24.04:
- OpenStudio-3.9.1-alpha+27df95bad9-Ubuntu-24.04-x86_64.deb
- OpenStudio-3.9.1-alpha+27df95bad9-Ubuntu-24.04-x86_64.tar.gz
Ubuntu 22.04:
Darwin:
- OpenStudio-3.9.1-alpha+bbbda1d885-Darwin-x86_64.dmg
- OpenStudio-3.9.1-alpha+bbbda1d885-Darwin-x86_64.tar.gz
Windows:
- OpenStudio-3.9.1-alpha+bbbda1d885-Windows.exe
- OpenStudio-3.9.1-alpha+bbbda1d885-Windows.tar.gz
Code Coverage:

Add ZoneHVAC:EvaporativeCoolerUnit to idd.

995c10a

joseph-robertson added Enhancement Request component - HVAC Pull Request - Ready for CI This pull request if finalized and is ready for continuous integration verification prior to merge. IDDChange labels Dec 18, 2024

joseph-robertson self-assigned this Dec 18, 2024

jmarrec requested changes Dec 19, 2024

View reviewed changes

joseph-robertson added 6 commits December 19, 2024 10:38

Update the new idd entry.

b06d24a

Merge branch 'develop' into zonehvac-evap-cooler

835b1ef

First add of model, ft, and test files.

861dfdf

Update model resource files.

44f0405

Update nodes in ft, general cleanup.

42303c1

Fix and improve model and ft tests.

9265da3

jmarrec requested changes Dec 24, 2024

View reviewed changes

joseph-robertson added 3 commits January 2, 2025 14:47

Merge branch 'develop' into zonehvac-evap-cooler

6562431

Add tests and clean up cpp and ft.

a82562b

Fix ft and tests.

21017b9

Remove remove override and update tests.

4cb656d

joseph-robertson commented Jan 6, 2025

View reviewed changes

joseph-robertson marked this pull request as ready for review January 6, 2025 18:48

joseph-robertson requested a review from jmarrec January 6, 2025 18:48

jmarrec reviewed Jan 7, 2025

View reviewed changes

jmarrec added 3 commits January 7, 2025 17:34

Add ZoneHVACEvaporativeCoolerUnit to all Fan's `containingZoneHVACCom…

0cd17fc

…ponent` #5326 (comment)

Add ZoneHVACEvaporativeCoolerUnit to all evaporative cooler component…

194a51b

… models `containingZoneHVACComponent` cf #5326 (comment)

Improve and fixup tests

bbbda1d

joseph-robertson mentioned this pull request Jan 7, 2025

Wrap ZoneHVAC:EvaporativeCoolerUnit NREL/OpenStudio-resources#215

Draft

26 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Wrap ZoneHVAC:EvaporativeCoolerUnit #5326

Wrap ZoneHVAC:EvaporativeCoolerUnit #5326

joseph-robertson commented Dec 18, 2024 •

edited

Loading

jmarrec Dec 19, 2024

jmarrec Dec 19, 2024

jmarrec left a comment

jmarrec Dec 24, 2024

jmarrec Dec 24, 2024

jmarrec Dec 24, 2024

jmarrec Dec 24, 2024

jmarrec Dec 24, 2024

jmarrec commented Jan 6, 2025

joseph-robertson Jan 6, 2025

jmarrec Jan 7, 2025

jmarrec Jan 7, 2025

jmarrec Jan 7, 2025

jmarrec Jan 7, 2025

jmarrec Jan 7, 2025

jmarrec Jan 7, 2025

jmarrec commented Jan 7, 2025 •

edited

Loading

ci-commercialbuildings commented Jan 7, 2025 •

edited

Loading

	bool ZoneHVACComponent_Impl::addToNode(Node& node) {
	bool result = false;

	boost::optional<ThermalZone> thermalZone;
	boost::optional<AirTerminalSingleDuctInletSideMixer> terminal;

	if (boost::optional<ModelObject> outlet = node.outletModelObject()) {
	if (boost::optional<PortList> pl = outlet->optionalCast<PortList>()) {
	thermalZone = pl->thermalZone();
	}
	}

	if (boost::optional<ModelObject> inlet = node.inletModelObject()) {
	terminal = inlet->optionalCast<AirTerminalSingleDuctInletSideMixer>();
	}

	if (thermalZone && terminal) {

		// Outdoor Air Inlet Node Name: Required Node
		if (boost::optional<Node> node = modelObject.inletNode()) {

		EXPECT_FALSE(zonehvac.remove().empty());
		EXPECT_EQ(size - 1, m.modelObjects().size());

	/// remove self and all children objects recursively
	std::vector<IdfObject> ParentObject_Impl::remove() {
	std::vector<IdfObject> result;

	// DLM: the following code does not work because subTree includes this object
	// and we don't want to call remove on the same object recursively
	//
	//ModelObjectVector subTree = getRecursiveChildren(getObject<ParentObject>());
	//for (ModelObject& object : subTree) {
	// std::vector<IdfObject> removed = object.remove();
	// result.insert(result.end(), removed.begin(), removed.end());
	//}

	// subTree includes this object, make sure to include costs as well
	// drop the ResourceObject instances, if they are used by other objects
	// This is probably the unique situation where you want to get children minus ResourceObjects
	auto subTree = getRecursiveChildren(getObject<ParentObject>(), true, false);
	result.reserve(subTree.size());
	for (const ModelObject& object : subTree) {
	result.emplace_back(object.idfObject());
	}

	bool ok = model().removeObjects(getHandles<ModelObject>(subTree));
	if (!ok) {
	result.clear();
	}

	return result;
	}


		Schedule availabilitySchedule() const;

		HVACComponent supplyAirFan() const;


		double coolingLoadControlThresholdHeatTransferRate() const;

		HVACComponent firstEvaporativeCooler() const;

Wrap ZoneHVAC:EvaporativeCoolerUnit #5326

Are you sure you want to change the base?

Wrap ZoneHVAC:EvaporativeCoolerUnit #5326

Conversation

joseph-robertson commented Dec 18, 2024 • edited Loading

Pull request overview

Pull Request Author

Review Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jmarrec left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jmarrec commented Jan 6, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jmarrec commented Jan 7, 2025 • edited Loading

ci-commercialbuildings commented Jan 7, 2025 • edited Loading

joseph-robertson commented Dec 18, 2024 •

edited

Loading

jmarrec commented Jan 7, 2025 •

edited

Loading

ci-commercialbuildings commented Jan 7, 2025 •

edited

Loading