Wrap Coil:Cooling:DX:SingleSpeed:ThermalStorage #5059

joseph-robertson · 2023-12-08T22:13:28Z

Pull request overview

Fixes Wrap Coil:Cooling:DX:SingleSpeed:ThermalStorage #5055.
Questions / issues:
- Inconsistencies in autosizable vs autocalculatable; change openstudio idd to be consistent? (Appears perhaps E+ doesn't make distinction between "autosize" and "autocalculate"?)
  - Update: I changed all autocalculatable to autosizable.
- Ctor should follow RetailPackagedTESCoil.idf? Or a mix of the idf values and idd defaults?
  - Update: Ctor generally follows idd defaults, with a few exceptions where it uses values found in RetailPackagedTESCoil.idf.
- Make all non curve fields required so that, even when Mode=No, the fields are pre-populated in case Mode is switched to Yes?
  - Update: No, not taking this approach. All modes are set to No in the Ctor and no curves are populated; it is up to the user to provide all the required curves for a given mode when set to Yes.

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 Coil:Cooling:DX:SingleSpeed:ThermalStorage OpenStudio-resources#206
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

joseph-robertson · 2024-01-25T17:15:44Z

@shorowit pointed out that it's not always appropriate to use idf testfile values.
@DavidGoldwasser pointed out that there may be helpful curve information on other DX coil objects.

jmarrec · 2024-01-29T10:54:44Z

Make all non curve fields required so that, even when Mode=No, the fields are pre-populated in case Mode is switched to Yes?

I'm kinda torn on this one. There are three options:

Indeed make them required, do not translate them if the choice field is No
- Pros: easier for the user
- Cons: that's 5 extra curves for each of these... model bloats
Make a model-time bool validityCheck() method, and call that at the beginning of the FT or something similar (this is what's done for the ElectricLoadCenterDistribution, since dependending on some choice fields you must have an inverter or not for eg). Then issue a loud warn, and do not translate it.
- Pros: identifies the issue (provided the user actually reads the warnings)
- Cons: could potentially not be translated without the user realizing
Leave them optional, check nothing, let E+ crash (I assume E+ actually crashes)
- Pros: implementation is easier
- Cons: problem is detected much later

Worth noting that I doubt this object will be commonly used by people, so factor that in.

@kbenne Can you please advise here?

joseph-robertson · 2024-01-29T20:47:30Z

My vote is leave the curves as optionals (so either bullet 2 or 3); it doesn't look the one testfile on the E+ repo with Coil:Cooling:DX:SingleSpeed:ThermalStorage has all the curve fields populated, so what would we set them to?

joseph-robertson · 2024-01-30T17:39:21Z

I don't see where ElectricLoadCenterDistribution's validityCheck even gets called?

jmarrec

Thanks for the changes @joseph-robertson

I think there are a couple of loose ens to tie up still, but it's almost there!

resources/model/OpenStudio.idd

src/model/CoilCoolingDXSingleSpeedThermalStorage.cpp

jmarrec · 2024-02-16T10:08:54Z

src/model/CoilCoolingDXSingleSpeedThermalStorage.cpp

+    ok = setAncillaryElectricPower(0.0);
+    OS_ASSERT(ok);
+    ok = setColdWeatherOperationAncillaryPower(0.0);
+    OS_ASSERT(ok);


(now that I've requested it, I hope we don't find out later that E+ treats blank and zero differently... sometimes that happens)

src/model/CoilCoolingDXSingleSpeedThermalStorage.cpp

jmarrec · 2024-02-16T10:10:37Z

src/model/test/CoilCoolingDXSingleSpeedThermalStorage_GTest.cpp

+    EXPECT_EQ(0u, rmed.size());
+    ASSERT_TRUE(unitary.coolingCoil());
+    EXPECT_EQ(dx, unitary.coolingCoil().get());
+  }


maybe test you can setCoolingCoil with another type of Unitary sys then?

Same: test with the ZoneHVACComponents.

setCoolingCoil for these system types should throw? Do we have examples/precedents for doing this?

jmarrec · 2024-02-16T10:11:43Z

src/model/test/CoilCoolingDXSingleSpeedThermalStorage_GTest.cpp

+  EXPECT_EQ(2u, model.getConcreteModelObjects<AirLoopHVACUnitarySystem>().size());
+  EXPECT_EQ(2u, model.getConcreteModelObjects<CoilCoolingDXSingleSpeedThermalStorage>().size());
+  EXPECT_EQ(dx, unitary.coolingCoil().get());
+  EXPECT_NE(dx, unitaryClone.coolingCoil().get());


Need test to check what happens when you clone to another model. And when removing (are curves dragged / removed?)

src/energyplus/ForwardTranslator/ForwardTranslateAirLoopHVACUnitaryHeatPumpAirToAir.cpp

src/model/CoilCoolingDXSingleSpeedThermalStorage.cpp

jmarrec · 2024-02-16T10:16:55Z

src/energyplus/ForwardTranslator/ForwardTranslateZoneHVACPackagedTerminalAirConditioner.cpp

+      } else if (_coolingCoil->iddObject().type() == IddObjectType::Coil_Cooling_DX_SingleSpeed_ThermalStorage) {
+        _coolingCoil->setString(Coil_Cooling_DX_SingleSpeed_ThermalStorageFields::EvaporatorAirInletNodeName, coolingCoilInletNodeName);
+        _coolingCoil->setString(Coil_Cooling_DX_SingleSpeed_ThermalStorageFields::EvaporatorAirOutletNodeName, coolingCoilOutletNodeName);


Either we can assign it to a PTAC, PTHP, then we should have a containingZoneHVACComponent implemented in model, or this should be removed.

Either way, looks like we need model tests indeed to check what this can or cannot be assigned to.

jmarrec · 2024-03-05T15:23:32Z

@joseph-robertson One failing test

1056: [ RUN      ] ModelFixture.CoilCoolingDXSingleSpeedThermalStorage_clone
1056: /srv/jenkins/openstudio/docker-volumes/ubuntu-2004/src/model/test/CoilCoolingDXSingleSpeedThermalStorage_GTest.cpp:992: Failure
1056: Expected equality of these values:
1056:   0
1056:   model.getModelObjects<Curve>().size()
1056:     Which is: 3
1056: /srv/jenkins/openstudio/docker-volumes/ubuntu-2004/src/model/test/CoilCoolingDXSingleSpeedThermalStorage_GTest.cpp:993: Failure
1056: Expected equality of these values:
1056:   0
1056:   model.getConcreteModelObjects<CurveBiquadratic>().size()
1056:     Which is: 1
1056: /srv/jenkins/openstudio/docker-volumes/ubuntu-2004/src/model/test/CoilCoolingDXSingleSpeedThermalStorage_GTest.cpp:994: Failure
1056: Expected equality of these values:
1056:   0
1056:   model.getConcreteModelObjects<CurveQuadratic>().size()
1056:     Which is: 1
1056: /srv/jenkins/openstudio/docker-volumes/ubuntu-2004/src/model/test/CoilCoolingDXSingleSpeedThermalStorage_GTest.cpp:995: Failure
1056: Expected equality of these values:
1056:   0
1056:   model.getConcreteModelObjects<CurveTriquadratic>().size()
1056:     Which is: 1
1056: [  FAILED  ] ModelFixture.CoilCoolingDXSingleSpeedThermalStorage_clone (10 ms)
1056: [----------] 1 test from ModelFixture (11 ms total)
1056: 
1056: [----------] Global test environment tear-down
1056: [==========] 1 test from 1 test suite ran. (11 ms total)
1056: [  PASSED  ] 0 tests.
1056: [  FAILED  ] 1 test, listed below:
1056: [  FAILED  ] ModelFixture.CoilCoolingDXSingleSpeedThermalStorage_clone

ci-commercialbuildings · 2024-03-12T17:21:18Z

CI Results for faffcfd:

Ubuntu 20.04:
Ubuntu 22.04:
- OpenStudio-3.8.0+faffcfd8b8-Ubuntu-22.04-x86_64.deb
- OpenStudio-3.8.0+faffcfd8b8-Ubuntu-22.04-x86_64.tar.gz
Darwin:
Windows:
- OpenStudio-3.8.0+faffcfd8b8-Windows.exe
- OpenStudio-3.8.0+faffcfd8b8-Windows.tar.gz
Code Coverage:

jmarrec

Thanks for the work @joseph-robertson ! Tests are passing now, this looks good to go

Found while writing NREL/OpenStudio-resources#206

Hotfix #5059

Add new thermal storage cooling coil object to idd.

158ae72

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. IDDChange labels Dec 8, 2023

joseph-robertson self-assigned this Dec 8, 2023

joseph-robertson added 16 commits December 8, 2023 20:08

Add src model files from GenerateClass.rb.

e2bd5fe

Add src ft files from GenerateClass.rb.

114364e

Formatting.

02246c8

Update schedule type registry cpp.

610bb1a

Formatting.

91b8a6b

Update condenser air node fields in idd.

07388cc

Start to update the ctor.

abd85d1

Formatting.

bb11cf9

Start adding curves to ctor.

863ffa2

Formatting.

0686a69

Change all xxxFunctions to Curve.

778534f

Stub validity check in FT for required curves with modes.

957e301

Missing required field in idd.

e70af23

Add convenience ctor exposing modes available.

5184eac

Clean up ft test.

5543a5e

Merge branch 'develop' into coil-thermal-storage

2340337

Merge branch 'develop' into coil-thermal-storage

61fcc1b

joseph-robertson added 2 commits January 30, 2024 11:43

Clean up model files.

41d8b04

Clean up ft file.

c198e7f

joseph-robertson added 12 commits February 14, 2024 11:18

Update ft includes.

da9da35

Update model and ft tests.

049c99c

Typo.

2aac063

Another typo.

25d6de8

Another include.

6f2fd81

Update methods around glycol concentration.

4b454b8

More required fields in idd and reset method removals.

728566e

Fix cpp and start adding ft parent system tests.

3f71ca7

Updates and fixes for containing hvac.

545e093

Update addToNode.

13cfe58

Fix a couple typos in ft test.

aab11b6

Avoid overriding availability schedule in an ft test.

df48009

jmarrec requested changes Feb 16, 2024

View reviewed changes

joseph-robertson added 4 commits February 16, 2024 09:11

Revert ft changes on components that cannot have the new coil.

5d5171d

Format the list of output variables.

662edba

Update idd, remove overrides, extra clone and remove model tests.

060f040

Fix up new model tests.

69274c5

joseph-robertson requested a review from jmarrec February 23, 2024 02:31

jmarrec and others added 4 commits March 8, 2024 15:21

Merge branch 'develop' into coil-thermal-storage

8d78cd8

Merge branch 'develop' into coil-thermal-storage

9eaa096

Update model test expects for remove.

0123337

Override children with all curves.

faffcfd

jmarrec approved these changes Mar 27, 2024

View reviewed changes

jmarrec merged commit bf61a99 into develop Mar 27, 2024
3 of 6 checks passed

jmarrec deleted the coil-thermal-storage branch March 27, 2024 15:26

jmarrec added a commit that referenced this pull request May 7, 2024

Hotfix #5059

ba2bc42

Found while writing NREL/OpenStudio-resources#206

jmarrec mentioned this pull request May 7, 2024

Hotfix #5059 #5187

Merged

19 tasks

jmarrec added a commit that referenced this pull request May 7, 2024

Merge pull request #5187 from NREL/Coil_TES_fixup

0133825

Hotfix #5059

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Wrap Coil:Cooling:DX:SingleSpeed:ThermalStorage #5059

Wrap Coil:Cooling:DX:SingleSpeed:ThermalStorage #5059

joseph-robertson commented Dec 8, 2023 •

edited

Loading

joseph-robertson commented Jan 25, 2024

jmarrec commented Jan 29, 2024

joseph-robertson commented Jan 29, 2024

joseph-robertson commented Jan 30, 2024

jmarrec left a comment

jmarrec Feb 16, 2024

jmarrec Feb 16, 2024

jmarrec Feb 16, 2024

joseph-robertson Feb 16, 2024

jmarrec Feb 16, 2024

jmarrec Feb 16, 2024

jmarrec commented Mar 5, 2024

ci-commercialbuildings commented Mar 12, 2024 •

edited

Loading

jmarrec left a comment

Wrap Coil:Cooling:DX:SingleSpeed:ThermalStorage #5059

Wrap Coil:Cooling:DX:SingleSpeed:ThermalStorage #5059

Conversation

joseph-robertson commented Dec 8, 2023 • edited Loading

Pull request overview

Pull Request Author

Review Checklist

joseph-robertson commented Jan 25, 2024

jmarrec commented Jan 29, 2024

joseph-robertson commented Jan 29, 2024

joseph-robertson commented Jan 30, 2024

jmarrec left a comment

Choose a reason for hiding this comment

jmarrec Feb 16, 2024

Choose a reason for hiding this comment

jmarrec Feb 16, 2024

Choose a reason for hiding this comment

jmarrec Feb 16, 2024

Choose a reason for hiding this comment

joseph-robertson Feb 16, 2024

Choose a reason for hiding this comment

jmarrec Feb 16, 2024

Choose a reason for hiding this comment

jmarrec Feb 16, 2024

Choose a reason for hiding this comment

jmarrec commented Mar 5, 2024

ci-commercialbuildings commented Mar 12, 2024 • edited Loading

jmarrec left a comment

Choose a reason for hiding this comment

joseph-robertson commented Dec 8, 2023 •

edited

Loading

ci-commercialbuildings commented Mar 12, 2024 •

edited

Loading