Fix #5371 - add FuelTypes to PlantComponentUserDefined #5372

jmarrec · 2025-03-18T16:42:59Z

Pull request overview

Fixes PlantComponentUserDefined missing fuelTypes #5371

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

jmarrec · 2025-03-19T09:29:42Z

src/model/EnergyManagementSystemSubroutine.hpp

+    // Convenience method to return all EnergyManagementSystemMeteredOutputVariable that refer to this Subroutine
+    std::vector<EnergyManagementSystemMeteredOutputVariable> energyManagementSystemMeteredOutputVariables() const;


Convenience

jmarrec · 2025-03-19T09:29:59Z

src/model/EnergyManagementSystemSubroutine.cpp

+    std::vector<EnergyManagementSystemMeteredOutputVariable>
+      EnergyManagementSystemSubroutine_Impl::energyManagementSystemMeteredOutputVariables() const {
+      return getObject<ModelObject>().getModelObjectSources<EnergyManagementSystemMeteredOutputVariable>(
+        EnergyManagementSystemMeteredOutputVariable::iddObjectType());
+    }


jmarrec · 2025-03-19T09:30:12Z

src/model/EnergyManagementSystemProgram.hpp

+    // Convenience method to return all EnergyManagementSystemMeteredOutputVariable that refer to this Program
+    std::vector<EnergyManagementSystemMeteredOutputVariable> energyManagementSystemMeteredOutputVariables() const;


Convenience for Program too

jmarrec · 2025-03-19T09:30:41Z

src/model/EnergyManagementSystemMeteredOutputVariable.hpp

+    // This is not an HVACComponent but it will help in the determination of the PlantUserDefinedComponent, so implementation is here because it's
+    // more logical
+    ComponentType componentType() const;
+    std::vector<FuelType> coolingFuelTypes() const;
+    std::vector<FuelType> heatingFuelTypes() const;
+    std::vector<AppGFuelType> appGHeatingFuelTypes() const;


New fuel type methods for EMS:MeteredOutputVariable

jmarrec · 2025-03-19T09:30:54Z

src/model/EnergyManagementSystemMeteredOutputVariable_Impl.hpp

+      // This is not an HVACComponent but it will help in the determination of the PlantUserDefinedComponent, so implementation is here because it's
+      // more logical
+      ComponentType componentType() const;
+      boost::optional<FuelType> fuelTypeFromResourceType() const;


On the Impl side you also have this

jmarrec · 2025-03-19T09:42:56Z

src/model/PlantComponentUserDefined.cpp

+      std::set<AppGFuelType> result;
+      for (const auto& ems_metered_var : energyManagementSystemMeteredOutputVariables()) {
+        for (auto& ft : ems_metered_var.appGHeatingFuelTypes()) {
+          result.insert(ft);
+        }
+      }
+      return {result.begin(), result.end()};


appGHeatingFuelTypes

jmarrec · 2025-03-19T09:43:44Z

src/model/test/PlantComponentUserDefined_GTest.cpp

+TEST_F(ModelFixture, PlantComponentUserDefined_EMSProgram_emsMeteredOutputVariables) {
+
+  Model m;
+  PlantComponentUserDefined plant_comp(m);
+  plant_comp.setPlantLoadingMode("MeetsLoadWithNominalCapacityHiOutLimit");
+  plant_comp.setPlantLoopFlowRequestMode("NeedsFlowIfLoopIsOn");
+
+  EXPECT_EQ(ComponentType(ComponentType::None), plant_comp.componentType());
+  testFuelTypeEquality({}, plant_comp.coolingFuelTypes());
+  testFuelTypeEquality({}, plant_comp.heatingFuelTypes());
+  testAppGFuelTypeEquality({}, plant_comp.appGHeatingFuelTypes());


PlantComponentUserDefined has CompType::None until it has EMS MeteredOutputVariables

jmarrec · 2025-03-19T09:44:27Z

src/model/test/PlantComponentUserDefined_GTest.cpp

+  EXPECT_EQ(0, plant_comp.energyManagementSystemMeteredOutputVariables().size());
+  auto sim_pgrm = plant_comp.plantSimulationProgram().get();
+  sim_pgrm.setName("Sim_Pgrm");
+  sim_pgrm.setBody("SET Elec_Htg_Cons = 0");
+  EnergyManagementSystemMeteredOutputVariable meteredoutvar(m, "Plant Heating Comp Electricity Consumption");
+  EXPECT_TRUE(meteredoutvar.setEMSVariableName("Elec_Htg_Cons"));
+  EXPECT_TRUE(meteredoutvar.setUpdateFrequency("SystemTimestep"));
+  EXPECT_TRUE(meteredoutvar.setEMSProgramOrSubroutineName(sim_pgrm));
+  EXPECT_TRUE(meteredoutvar.setResourceType("Electricity"));
+  EXPECT_TRUE(meteredoutvar.setGroupType("HVAC"));
+  EXPECT_TRUE(meteredoutvar.setEndUseCategory("Heating"));
+  EXPECT_TRUE(meteredoutvar.setEndUseSubcategory(""));
+  EXPECT_TRUE(meteredoutvar.setUnits("J"));
+  EXPECT_EQ(1, plant_comp.energyManagementSystemMeteredOutputVariables().size());
+  EXPECT_EQ(ComponentType(ComponentType::Heating), plant_comp.componentType());
+  testFuelTypeEquality({}, plant_comp.coolingFuelTypes());
+  testFuelTypeEquality({FuelType::Electricity}, plant_comp.heatingFuelTypes());
+  testAppGFuelTypeEquality({AppGFuelType::Electric}, meteredoutvar.appGHeatingFuelTypes());


I create an EMSMeteredOutputVar of type "Heating" and "Electricity" into the plantSimulationProgram, and check that the PlantComponentUserDefined has the right fuel types

jmarrec · 2025-03-19T09:45:14Z

src/model/test/PlantComponentUserDefined_GTest.cpp

+  PlantLoop plant(m);
+  EXPECT_EQ(ComponentType(ComponentType::None), plant.componentType());
+  testFuelTypeEquality({}, plant.coolingFuelTypes());
+  testFuelTypeEquality({}, plant.heatingFuelTypes());
+  testAppGFuelTypeEquality({}, plant.appGHeatingFuelTypes());
+
+  EXPECT_TRUE(plant.addSupplyBranchForComponent(plant_comp));
+  EXPECT_EQ(ComponentType(ComponentType::Heating), plant.componentType());
+  testFuelTypeEquality({}, plant.coolingFuelTypes());
+  testFuelTypeEquality({FuelType::Electricity}, plant.heatingFuelTypes());
+  testAppGFuelTypeEquality({AppGFuelType::Electric}, plant.appGHeatingFuelTypes());


Plant inherits it correctly AFTER I assign the PlantComponentUserDefined on the supply side

jmarrec · 2025-03-19T09:45:35Z

src/model/test/PlantComponentUserDefined_GTest.cpp

+  sim_pgrm.setBody("SET Elec_Htg_Cons = 0\nSET Elec_Clg_Cons = 0");
+  EnergyManagementSystemMeteredOutputVariable meteredoutvar2(m, "Plant Cooling Comp Electricity Consumption");
+  EXPECT_TRUE(meteredoutvar2.setEMSVariableName("Elec_Htg_Cons"));
+  EXPECT_TRUE(meteredoutvar2.setUpdateFrequency("SystemTimestep"));
+  EXPECT_TRUE(meteredoutvar2.setEMSProgramOrSubroutineName(sim_pgrm));
+  EXPECT_TRUE(meteredoutvar2.setResourceType("NaturalGas"));
+  EXPECT_TRUE(meteredoutvar2.setGroupType("HVAC"));
+  EXPECT_TRUE(meteredoutvar2.setEndUseCategory("Chillers"));
+  EXPECT_TRUE(meteredoutvar2.setEndUseSubcategory(""));
+  EXPECT_TRUE(meteredoutvar2.setUnits("J"));
+  EXPECT_EQ(2, plant_comp.energyManagementSystemMeteredOutputVariables().size());
+  EXPECT_EQ(ComponentType(ComponentType::Both), plant_comp.componentType());
+  EXPECT_TRUE(testFuelTypeEquality({FuelType::Gas}, plant_comp.coolingFuelTypes()));
+  EXPECT_TRUE(testFuelTypeEquality({FuelType::Electricity}, plant_comp.heatingFuelTypes()));
+  EXPECT_TRUE(testAppGFuelTypeEquality({}, meteredoutvar2.appGHeatingFuelTypes()));
+
+  EXPECT_EQ(ComponentType(ComponentType::Both), plant.componentType());
+  EXPECT_TRUE(testFuelTypeEquality({FuelType::Gas}, plant.coolingFuelTypes()));
+  EXPECT_TRUE(testFuelTypeEquality({FuelType::Electricity}, plant.heatingFuelTypes()));
+  EXPECT_TRUE(testAppGFuelTypeEquality({AppGFuelType::Electric}, plant.appGHeatingFuelTypes()));


Test with a second variable, this type "Chillers" with "Natural Gas"

…ariable MeteredOutputVar also has the OnSiteGeneration, but that maps to Cogenation and I can't add a third alias for it... Will handle manually

…mentSystemMeteredOutputVariables to find linked Metered vars

…gFuelTypes, and appGHeatingFuelTypes

…termine the componentType / fuelTypes

ci-commercialbuildings · 2025-03-19T10:56:21Z

CI Results for b2461a8:

jmarrec added component - Model Pull Request - Ready for CI This pull request if finalized and is ready for continuous integration verification prior to merge. component - Standards labels Mar 18, 2025

jmarrec self-assigned this Mar 18, 2025

jmarrec commented Mar 19, 2025

View reviewed changes

jmarrec added 7 commits March 19, 2025 10:58

Add Chillers End Use Type: it is valid and used by EMS:MeteredOutputV…

bf19f5d

…ariable MeteredOutputVar also has the OnSiteGeneration, but that maps to Cogenation and I can't add a third alias for it... Will handle manually

EMS:Program and EMS:Subroutine: add convenience function energyManage…

3c36326

…mentSystemMeteredOutputVariables to find linked Metered vars

EMS:MeteredOutputVar: add componentType, heatingFuelTypes, and coolin…

42b7eb0

…gFuelTypes, and appGHeatingFuelTypes

PlantCOmponentUserDefined: use the linked EMS:MeteredOutputVars to de…

d2355ac

…termine the componentType / fuelTypes

CoolingCoils is cooling of course

4140a53

Adding tests

b077726

fixup comment

0cde810

jmarrec mentioned this pull request Mar 19, 2025

PlantComponentUserDefined missing fuelTypes #5371

Closed

Improve the test

b2461a8

jmarrec force-pushed the handle-ashp branch from b582841 to b2461a8 Compare March 19, 2025 10:33

jmarrec requested a review from joseph-robertson March 19, 2025 11:19

joseph-robertson approved these changes Mar 31, 2025

View reviewed changes

jmarrec merged commit d9e51bd into develop Mar 31, 2025
5 of 6 checks passed

jmarrec deleted the handle-ashp branch March 31, 2025 19:42

jmarrec added a commit that referenced this pull request Mar 31, 2025

Hotfix Merge pull request #5372 from NREL/handle-ashp

a882f64

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix #5371 - add FuelTypes to PlantComponentUserDefined #5372

Fix #5371 - add FuelTypes to PlantComponentUserDefined #5372

Uh oh!

jmarrec commented Mar 18, 2025

Uh oh!

jmarrec Mar 19, 2025

Uh oh!

jmarrec Mar 19, 2025

Uh oh!

jmarrec Mar 19, 2025

Uh oh!

jmarrec Mar 19, 2025

Uh oh!

jmarrec Mar 19, 2025

Uh oh!

jmarrec Mar 19, 2025

Uh oh!

jmarrec Mar 19, 2025

Uh oh!

jmarrec Mar 19, 2025

Uh oh!

jmarrec Mar 19, 2025

Uh oh!

jmarrec Mar 19, 2025

Uh oh!

ci-commercialbuildings commented Mar 19, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

		// Convenience method to return all EnergyManagementSystemMeteredOutputVariable that refer to this Subroutine
		std::vector<EnergyManagementSystemMeteredOutputVariable> energyManagementSystemMeteredOutputVariables() const;

Fix #5371 - add FuelTypes to PlantComponentUserDefined #5372

Fix #5371 - add FuelTypes to PlantComponentUserDefined #5372

Uh oh!

Conversation

jmarrec commented Mar 18, 2025

Pull request overview

Pull Request Author

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!

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!

Choose a reason for hiding this comment

Uh oh!

ci-commercialbuildings commented Mar 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ci-commercialbuildings commented Mar 19, 2025 •

edited

Loading