Wrap AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl and AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl:HR #4778

joseph-robertson · 2022-12-21T19:33:08Z

Pull request overview

Fixes Add new E+ VRF objects: AirConditionerVariableRefrigerantfFowFluidTemperatureControl and AirConditionerVariableRefrigerantfFowFluidTemperatureControlHR #2609
Fixes Wrap AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl:HR #4714
TODO:
- Update ZoneHVACTerminalUnitVariableRefrigerantFlow to handle FT of:
  - FanVariableVolume fan
  - FluidTemperatureControl cooling/heating dx coils
- Wrap Coil:Cooling:DX:VariableRefrigerantFlow:FluidTemperatureControl (break API by changing CoilCoolingDXVRF to HVACComponent in ZoneHVACTerminalUnitVRF)
- Wrap Coil:Heating:DX:VariableRefrigerantFlow:FluidTemperatureControl (break API by changing CoilHeatingDXVRF to HVACComponent in ZoneHVACTerminalUnitVRF)
- Fix failing model tests
  - addToNode (need to change from StraightComponent to HVACComponent?)
  - Remove

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:
- Wrap AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl and AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl:HR OpenStudio-resources#188
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

part 1 was 3ec06cf

jmarrec · 2023-02-06T09:39:53Z

@joseph-robertson reported the new AirConditionerVRF objects do not have a name()/setName() method, and I realized they also don't serialize in ruby... something's wrong with the SWIG stuff

$ Products/openstudio -e 'm = OpenStudio::Model::Model.new; vrf = OpenStudio::Model::AirConditionerVariableRefrigerantFlowFluidTemperatureControl.new(m); puts vrf'
#<OpenStudio::Model::AirConditionerVariableRefrigerantFlowFluidTemperatureControl:0x000056251ac3e8b8>

Edit: fixed in ff3124f , the order matters

…t in particular.

…l and FluidCtrlHR, not the original AirCondVRF)

…e works as intended

…ditionerVariableRefrigerantFlow. It clones all curves and one of them is cloned TWICE

…oning the child `Curve` objects (20 of them)

…te if no terminals, for consistency

jmarrec · 2023-02-10T10:31:13Z

A few things are missing here I think:

A ZoneHVACTerminalUnitVariableRefrigerantFlow should enforce using the same coil types (FluidTemp Control Or not) for both HC and CC
The AirCondVRFs types should only accept the right types of ZoneHVACTUs
The Fan type should match as well

I will make the changes (I have them partially done, but failing tests)

…ls, and AirCOnd and ZoneHVACTU. + Add a Ctor for convenience for ZOneHVACTU that can create a FluidTempCtrl one

jmarrec

@joseph-robertson can you review my changes quickly please?

developer/doc/ReleaseNotes/OpenStudio_Release_Notes_3_6_0_TBD.md

jmarrec · 2023-02-06T09:10:22Z

resources/model/OpenStudio.idd

+  A2 , \field Name
+       \required-field
+       \type alpha
+       \reference ConnectionObject


I don't think it's a ConnectionObject since it doesn't actually have any nodes. In which case it's actually a ParentObject and not an HVACComponent... That feels kinda weird though, I need to think this through a bit more...

jmarrec · 2023-02-10T15:15:49Z

src/model/ZoneHVACTerminalUnitVariableRefrigerantFlow.hpp

@@ -54,11 +56,16 @@ namespace model {
  {

   public:
-    explicit ZoneHVACTerminalUnitVariableRefrigerantFlow(const Model& model);
+    explicit ZoneHVACTerminalUnitVariableRefrigerantFlow(const Model& model, bool isFluidTemperatureControl = false);


New convenience ctor. When isFLuidTemperature Control, it uses CoilHeating/CoolingDXVariableRefrigerantFluidTemperatureControl coils + a FanSystemModel

Wait, we want this to be "+ a FanVariableVolume", no?

I checked the idd, and you're right. It can be FanSystemModel or FanVariableVolume.

jmarrec · 2023-02-10T15:16:57Z

src/model/ZoneHVACTerminalUnitVariableRefrigerantFlow.hpp

+    // Returns true if the Cooling and Heating Coils are of the FluidTemperatureControl type
+    bool isFluidTemperatureControl() const;


jmarrec · 2023-02-10T15:17:18Z

src/model/ZoneHVACTerminalUnitVariableRefrigerantFlow.cpp

+      auto fanType = component.iddObjectType();
+      if (isFluidTemperatureControl()) {
+        if ((fanType != IddObjectType::OS_Fan_SystemModel) && (fanType != IddObjectType::OS_Fan_VariableVolume)) {
+          LOG(Warn, "For " << briefDescription()
+                           << ", since it is a FluidTemperatureControl unit, fan type must be FanSystemModel or FanVariableVolume, not "
+                           << component.briefDescription());
+          return false;
+        }
+      } else {
+        if ((fanType != IddObjectType::OS_Fan_SystemModel) && (fanType != IddObjectType::OS_Fan_OnOff)
+            && (fanType != IddObjectType::OS_Fan_ConstantVolume)) {
+          LOG(Warn,
+              "For " << briefDescription()
+                     << ", since it is a non-FluidTemperatureControl unit, fan type must be FanSystemModel, FanOnOff, or FanConstantVolume, not "
+                     << component.briefDescription());
+          return false;
+        }
+      }


supplyAirFan type is also enforced.

jmarrec · 2023-02-10T15:18:19Z

src/model/ZoneHVACTerminalUnitVariableRefrigerantFlow.cpp

+    if (isFluidTemperatureControl) {
+      CoilCoolingDXVariableRefrigerantFlowFluidTemperatureControl coolingCoil(model);
+      coolingCoil.setName(name().get() + " Cooling Coil");
+      getImpl<detail::ZoneHVACTerminalUnitVariableRefrigerantFlow_Impl>()->setCoolingCoil(coolingCoil);
+
+      CoilHeatingDXVariableRefrigerantFlowFluidTemperatureControl heatingCoil(model);
+      heatingCoil.setName(name().get() + " Heating Coil");
+      getImpl<detail::ZoneHVACTerminalUnitVariableRefrigerantFlow_Impl>()->setHeatingCoil(heatingCoil);

-    CoilHeatingDXVariableRefrigerantFlow heatingCoil(model);
-    heatingCoil.setName(name().get() + " Heating Coil");
-    getImpl<detail::ZoneHVACTerminalUnitVariableRefrigerantFlow_Impl>()->setHeatingCoil(heatingCoil);
+      FanSystemModel fan(model);
+      fan.setName(name().get() + " Fan");
+      getImpl<detail::ZoneHVACTerminalUnitVariableRefrigerantFlow_Impl>()->setSupplyAirFan(fan);
+    } else {
+      CoilCoolingDXVariableRefrigerantFlow coolingCoil(model);
+      coolingCoil.setName(name().get() + " Cooling Coil");
+      getImpl<detail::ZoneHVACTerminalUnitVariableRefrigerantFlow_Impl>()->setCoolingCoil(coolingCoil);

-    FanOnOff fan(model, alwaysOnSchedule);
-    fan.setName(name().get() + " Fan");
-    getImpl<detail::ZoneHVACTerminalUnitVariableRefrigerantFlow_Impl>()->setSupplyAirFan(fan);
+      CoilHeatingDXVariableRefrigerantFlow heatingCoil(model);
+      heatingCoil.setName(name().get() + " Heating Coil");
+      getImpl<detail::ZoneHVACTerminalUnitVariableRefrigerantFlow_Impl>()->setHeatingCoil(heatingCoil);
+
+      FanOnOff fan(model, alwaysOnSchedule);
+      fan.setName(name().get() + " Fan");
+      getImpl<detail::ZoneHVACTerminalUnitVariableRefrigerantFlow_Impl>()->setSupplyAirFan(fan);
+    }


Convenience ctor logic.

jmarrec · 2023-02-10T15:18:52Z

src/model/AirConditionerVariableRefrigerantFlow.cpp

+    bool AirConditionerVariableRefrigerantFlow_Impl::addTerminal(ZoneHVACTerminalUnitVariableRefrigerantFlow& vrf) {
+      if (vrf.isFluidTemperatureControl()) {
+        LOG(Warn, "For " << briefDescription() << ", cannot add a terminal that uses FluidTemperatureControl coils: " << vrf.briefDescription());
+        return false;
+      }
+      return vrfModelObjectList().addModelObject(vrf);


AirConditionerVariableRefrigerantFlow only accepts Non-FluidCtrl terminals

jmarrec · 2023-02-10T15:20:00Z

src/model/AirConditionerVariableRefrigerantFlowFluidTemperatureControl.cpp

+    bool AirConditionerVariableRefrigerantFlowFluidTemperatureControl_Impl::addTerminal(ZoneHVACTerminalUnitVariableRefrigerantFlow& vrf) {
+      if (!vrf.isFluidTemperatureControl()) {
+        LOG(Warn, "For " << briefDescription() << ", cannot add a terminal that uses non-FluidTemperatureControl coils: " << vrf.briefDescription());
+        return false;
+      }
+      return vrfModelObjectList().addModelObject(vrf);
+    }


AirConditionerVariableRefrigerantFlowFluidTemperatureControl only accepts FluidCtrl terminals

jmarrec · 2023-02-10T15:20:37Z

src/model/AirConditionerVariableRefrigerantFlowFluidTemperatureControlHR.cpp

+    bool AirConditionerVariableRefrigerantFlowFluidTemperatureControlHR_Impl::addTerminal(ZoneHVACTerminalUnitVariableRefrigerantFlow& vrf) {
+      if (!vrf.isFluidTemperatureControl()) {
+        LOG(Warn, "For " << briefDescription() << ", cannot add a terminal that uses non-FluidTemperatureControl coils: " << vrf.briefDescription());
+        return false;
+      }
+      return vrfModelObjectList().addModelObject(vrf);
+    }


AirConditionerVariableRefrigerantFlowFluidTemperatureControlHR only accepts FluidCtrl terminals

jmarrec · 2023-02-10T15:20:55Z

src/model/AirConditionerVariableRefrigerantFlow.hpp

@@ -477,7 +477,7 @@ namespace model {

    bool setHeatRecoveryHeatingEnergyTimeConstant(double heatRecoveryHeatingEnergyTimeConstant);

-    void addTerminal(ZoneHVACTerminalUnitVariableRefrigerantFlow& vrf);
+    bool addTerminal(ZoneHVACTerminalUnitVariableRefrigerantFlow& vrf);


addTerminal returns a bool now. True for all three types

ci-commercialbuildings · 2023-02-10T15:48:32Z

CI Results for 8411966:

Ubuntu 18.04:
- OpenStudio-3.5.1-alpha+841196687e-Ubuntu-18.04.deb
- OpenStudio-3.5.1-alpha+841196687e-Ubuntu-18.04.tar.gz
Ubuntu 20.04:
Darwin:
- OpenStudio-3.5.1-alpha+841196687e-Darwin-x86_64.dmg
- OpenStudio-3.5.1-alpha+841196687e-Darwin-x86_64.tar.gz
Windows:
- OpenStudio-3.5.1-alpha+841196687e-Windows.exe
- OpenStudio-3.5.1-alpha+841196687e-Windows.tar.gz
Code Coverage:

joseph-robertson added 4 commits December 21, 2022 12:29

Stub additions to idd.

b41740e

Stub new model files.

ef743a8

Stub new energyplus files.

da24b34

Formatting.

31754d1

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

joseph-robertson self-assigned this Dec 21, 2022

joseph-robertson added 21 commits December 21, 2022 13:43

Fix copy errors on model files.

35efe16

Fix copy errors on ft files.

2707bfb

Formatting.

d7d9704

Typo in class name.

78722e6

Minor edits.

740b878

Merge branch 'develop' into vrf-temp-ctrl

af567f2

Create model and ft files using generateclass.

cc182c2

Formatting.

8d12b0d

Uncomment ft tests.

80c11f4

Begin process of cleaning up after generateclass.

95eeec1

Updates for curves.

b70f485

Merge branch 'develop' into vrf-temp-ctrl

054a202

Update os idd.

4bbf836

Clear out tests.

9c92737

Stub loading index extensible group class.

0131343

Finish loading index class implementation.

022ca7d

Add loading index methods to HR.

277340d

Add ft of loading indexes.

bce2f1c

Stub model and ft test files.

6ba4d18

Got a pretty good handle on model tests.

6fe0196

Delete curve removes and add tests.

24aaa8e

joseph-robertson and others added 4 commits February 3, 2023 11:12

Create a ft no op for coil cooling water panel radiant.

1e789c6

Clang format

d0919b9

Merge remote-tracking branch 'origin/develop' into vrf-temp-ctrl

72d4837

getConcreteModelObjects, part 2

018132d

part 1 was 3ec06cf

jmarrec added 7 commits February 6, 2023 10:44

Fixup SWIG: order matters. They need to be defined after HVACComponen…

ff3124f

…t in particular.

Fixup includes and name the VRF Curves

c908557

addLoadingIndex should return bool

37bfda5

Adjust Unit tests for wanted behavior of clone / remove (for FluidCtr…

6e508ac

…l and FluidCtrlHR, not the original AirCondVRF)

Adjust methods in FluidCtrl and FluidCtrlHR so that the clone / remov…

01a4ed5

…e works as intended

Add a **failing** (badly) clone + remove test for the existing AirCon…

746ef30

…ditionerVariableRefrigerantFlow. It clones all curves and one of them is cloned TWICE

AirConditionerVariableRefrigerantFlow::clone was changed to stop cl…

4fea937

…oning the child `Curve` objects (20 of them)

jmarrec force-pushed the vrf-temp-ctrl branch from b300444 to 4fea937 Compare February 6, 2023 13:17

joseph-robertson and others added 9 commits February 6, 2023 09:39

Use createregisterandname in ft.

973c385

Avoid ft if no terminals, and add tests.

3f09f6f

Few typos.

06aafbb

Fix new ft tests.

e297cbb

Update ft tests for vrf object names.

1c8318e

Formatting.

955c1cc

Update name field in proposed idd.

80a8ec0

Typo in idd field name.

5d460c0

Rename "Heat Pump Name" for AirCondVRF (existing one) + don't transla…

bea9275

…te if no terminals, for consistency

Enforce matching Coil Types (FluidCtrl or not), Fan type based on coi…

8411966

…ls, and AirCOnd and ZoneHVACTU. + Add a Ctor for convenience for ZOneHVACTU that can create a FluidTempCtrl one

jmarrec reviewed Feb 10, 2023

View reviewed changes

joseph-robertson requested a review from jmarrec February 10, 2023 18:00

Misc unrelated cppcheck + extra non char in docstring

755c992

jmarrec merged commit 9f2a92a into develop Feb 14, 2023

jmarrec deleted the vrf-temp-ctrl branch February 14, 2023 10:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Wrap AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl and AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl:HR #4778

Wrap AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl and AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl:HR #4778

joseph-robertson commented Dec 21, 2022 •

edited

jmarrec commented Feb 6, 2023 •

edited

jmarrec commented Feb 10, 2023 •

edited

jmarrec left a comment

jmarrec Feb 6, 2023

jmarrec Feb 10, 2023

joseph-robertson Feb 10, 2023

joseph-robertson Feb 10, 2023

jmarrec Feb 10, 2023

joseph-robertson Feb 10, 2023

jmarrec Feb 10, 2023

jmarrec Feb 10, 2023

jmarrec Feb 10, 2023

jmarrec Feb 10, 2023

jmarrec Feb 10, 2023

jmarrec Feb 10, 2023

ci-commercialbuildings commented Feb 10, 2023 •

edited

		// Returns true if the Cooling and Heating Coils are of the FluidTemperatureControl type
		bool isFluidTemperatureControl() const;

Wrap AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl and AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl:HR #4778

Wrap AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl and AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl:HR #4778

Conversation

joseph-robertson commented Dec 21, 2022 • edited

Pull request overview

Pull Request Author

Review Checklist

jmarrec commented Feb 6, 2023 • edited

jmarrec commented Feb 10, 2023 • edited

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

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

ci-commercialbuildings commented Feb 10, 2023 • edited

joseph-robertson commented Dec 21, 2022 •

edited

jmarrec commented Feb 6, 2023 •

edited

jmarrec commented Feb 10, 2023 •

edited

ci-commercialbuildings commented Feb 10, 2023 •

edited