Fix #10220 - LifeCycleCost objects are using "Steam" not "DistrictHeatingSteam" #10229

jmarrec · 2023-09-18T09:01:59Z

Pull request overview

Fixes LifeCycleCost objects are using "Steam" not "DistrictHeatingSteam" #10220
Transition for Steam => DistrictHeatingSteam for LCC objects
Add DistrictHeating and DistrictCooling as well

Pull Request Author

Add to this list or remove from it as applicable. This is a simple templated set of guidelines.

Reviewer

This will not be exhaustively relevant to every PR.

…getObjectSchemaProps`

…of std::all_of) ``` [ RUN ] EnergyPlusFixture.EconomicLifeCycleCost_GetInput_EnsureFuelTypesAllRecognized /home/julien/Software/Others/EnergyPlus/tst/EnergyPlus/unit/EconomicLifeCycleCost.unit.cc:601: Failure Expected equality of these values: numResources Which is: 18 enum_values.size() Which is: 16 /home/julien/Software/Others/EnergyPlus/tst/EnergyPlus/unit/EconomicLifeCycleCost.unit.cc:648: Failure Expected equality of these values: numResources Which is: 18 state->dataEconLifeCycleCost->numUsePriceEscalation Which is: 16 /home/julien/Software/Others/EnergyPlus/tst/EnergyPlus/unit/Fixtures/EnergyPlusFixture.hh:137: Failure Expected: (static_cast<typename std::underlying_type_t<T>>(expected)) != (static_cast<typename std::underlying_type_t<T>>(actual)), actual: -1 vs -1 /home/julien/Software/Others/EnergyPlus/tst/EnergyPlus/unit/EconomicLifeCycleCost.unit.cc:650: Failure Value of: compare_enums(lcc.resource, Constant::eResource::Invalid, false) Actual: true Expected: false Failed for LCCUSEPRICEESCALATION STEAM /home/julien/Software/Others/EnergyPlus/tst/EnergyPlus/unit/EconomicLifeCycleCost.unit.cc:652: Failure Expected equality of these values: numResources Which is: 18 state->dataEconLifeCycleCost->numUseAdjustment Which is: 16 /home/julien/Software/Others/EnergyPlus/tst/EnergyPlus/unit/Fixtures/EnergyPlusFixture.hh:137: Failure Expected: (static_cast<typename std::underlying_type_t<T>>(expected)) != (static_cast<typename std::underlying_type_t<T>>(actual)), actual: -1 vs -1 /home/julien/Software/Others/EnergyPlus/tst/EnergyPlus/unit/EconomicLifeCycleCost.unit.cc:654: Failure Value of: compare_enums(lcc.resource, Constant::eResource::Invalid, false) Actual: true Expected: false Failed for LCCUSEADJUSTMENT STEAM ```

jmarrec · 2023-09-18T09:04:01Z

idd/Energy+.idd.in

+        \key DistrictCooling
+        \key DistrictHeatingWater
+        \key DistrictHeatingSteam


For LifeCycleCost:UsePriceEscalation and LifeCycleCost:UseAdjustment

Replace Steam with DistrictHeatingSteam like the rest of the objects

OK, good catch.

jmarrec · 2023-09-18T09:05:29Z

src/Transition/CreateNewIDFUsingRulesV23_2_0.f90

+              CASE('LIFECYCLECOST:USEPRICEESCALATION')
+                 CALL GetNewObjectDefInIDD(ObjectName,NwNumArgs,NwAorN,NwReqFld,NwObjMinFlds,NwFldNames,NwFldDefaults,NwFldUnits)
+                 nodiff=.false.
+                 OutArgs(1:CurArgs)=InArgs(1:CurArgs)
+                 IF (SameString(OutArgs(2), "STEAM")) THEN
+                     OutArgs(2) = "DistrictHeatingSteam"
+                 END IF
+
+              CASE('LIFECYCLECOST:USEADJUSTMENT')
+                 CALL GetNewObjectDefInIDD(ObjectName,NwNumArgs,NwAorN,NwReqFld,NwObjMinFlds,NwFldNames,NwFldDefaults,NwFldUnits)
+                 nodiff=.false.
+                 OutArgs(1:CurArgs)=InArgs(1:CurArgs)
+                 IF (SameString(OutArgs(2), "STEAM")) THEN
+                     OutArgs(2) = "DistrictHeatingSteam"
+                 END IF


Transition. See test on DevSupport: https://github.com/NREL/EnergyPlusDevSupport/blob/master/DefectFiles/10000s/10220/transition.idf

./Transition-V23-1-0-to-V23-2-0 /path/to/EnergyPlusDevSupport/DefectFiles/10000s/10220/transition.idf gvim -d -f transition.idfold transition.idfnew

jmarrec · 2023-09-18T09:06:07Z

tst/EnergyPlus/unit/EconomicLifeCycleCost.unit.cc

+TEST_F(EnergyPlusFixture, EconomicLifeCycleCost_GetInput_EnsureFuelTypesAllRecognized)
+{
+    using json = nlohmann::json;
+    const json &lcc_useprice_props = state->dataInputProcessing->inputProcessor->getObjectSchemaProps(*state, "LifeCycleCost:UsePriceEscalation");
+    const json &resource_field = lcc_useprice_props.at("resource");
+    const json &enum_values = resource_field.at("enum");
+
+    // Should support all fuels + Water + ElectricityXXX (Purchased, Produced, SurplusSold, Net)
+    constexpr size_t numResources = static_cast<size_t>(Constant::eFuel::Num) + 5;
+    EXPECT_EQ(numResources, enum_values.size());
+    std::string idf_objects = delimited_string({
+        "LifeCycleCost:Parameters,",
+        "  TypicalLCC,              !- Name",
+        "  EndOfYear,               !- Discounting Convention",
+        "  ConstantDollar,          !- Inflation Approach",
+        "  0.03,                    !- Real Discount Rate",
+        "  ,                        !- Nominal Discount Rate",
+        "  ,                        !- Inflation",
+        "  January,                 !- Base Date Month",
+        "  2012,                    !- Base Date Year",
+        "  January,                 !- Service Date Month",
+        "  2014,                    !- Service Date Year",
+        "  100,                     !- Length of Study Period in Years",
+        "  0,                       !- Tax rate",
+        "  ;                        !- Depreciation Method",
+    });
+    // All should be valid resources
+    for (const auto &enum_value : enum_values) {
+        const std::string enum_string = enum_value.get<std::string>();
+
+        const auto resource = static_cast<Constant::eResource>(getEnumValue(Constant::eResourceNamesUC, enum_string));
+        EXPECT_TRUE(compare_enums(Constant::eResource::Invalid, resource)) << "Failed for " << enum_string;
+
+        idf_objects += fmt::format(R"idf(
+LifeCycleCost:UsePriceEscalation,
+  LCCUsePriceEscalation {0},             !- Name
+  {0},                                   !- Resource
+  2009,                                   !- Escalation Start Year
+  January,                                !- Escalation Start Month
+  1,                                      !- Year Escalation 1
+  1.01,                                   !- Year Escalation 2
+  1.02;                                   !- Year Escalation 3
+
+LifeCycleCost:UseAdjustment,
+  LCCUseAdjustment {0},              !- Name
+  {0},                               !- Resource
+  1,                                      !- Year Multiplier 1
+  1.005,                                  !- Year Multiplier 2
+  1.01;                                   !- Year Multiplier 3
+  )idf",
+                                   enum_string);
+    }
+    ASSERT_TRUE(process_idf(idf_objects));
+
+    GetInputForLifeCycleCost(*state);
+
+    EXPECT_EQ(numResources, state->dataEconLifeCycleCost->numUsePriceEscalation);
+    for (const auto &lcc : state->dataEconLifeCycleCost->UsePriceEscalation) {
+        EXPECT_FALSE(compare_enums(lcc.resource, Constant::eResource::Invalid, false)) << "Failed for " << lcc.name;
+    }
+    EXPECT_EQ(numResources, state->dataEconLifeCycleCost->numUseAdjustment);
+    for (const auto &lcc : state->dataEconLifeCycleCost->UseAdjustment) {
+        EXPECT_FALSE(compare_enums(lcc.resource, Constant::eResource::Invalid, false)) << "Failed for " << lcc.name;
+    }
+}


(meta) testing to ensure this doesn't creep back in.

jmarrec · 2023-09-18T09:11:23Z

Using the MCVE files on DevSupport:

in_ori.idf: uses Steam LCC objects, and does not include DistrictCooling, DistrictHeatingWater or it throws on input parsing
in.idf uses DistrictHeatingSteam, DistrictCooling, DistrictHeatingWater objects
Both files include LCC objects for all other fuels

Ori:

eplusout.err has a warning

   ** Warning ** The resource referenced by LifeCycleCost:UsePriceEscalation= "LCCUSEPRICEESCALATION DISTRICTHEATINGSTEAM" has no energy cost. 
   **   ~~~   ** ... It is likely that the wrong resource is used. The resource should match the meter used in Utility:Tariff.

as you can see, DistrictHeatingSteam is not changed whatsoever.

New:

All fuels are properly affected by the LCC objects:

Myoldmopar · 2023-09-19T18:47:24Z

src/Transition/CreateNewIDFUsingRulesV23_2_0.f90

+                 OutArgs(1:CurArgs)=InArgs(1:CurArgs)
+                 IF (SameString(OutArgs(2), "STEAM")) THEN
+                     OutArgs(2) = "DistrictHeatingSteam"
+                 END IF


Great catch, @jmarrec, thanks.

Myoldmopar · 2023-09-19T18:47:39Z

idd/Energy+.idd.in

+        \key DistrictCooling
+        \key DistrictHeatingWater
+        \key DistrictHeatingSteam


OK, good catch.

Myoldmopar · 2023-09-19T18:56:30Z

This also tests happily, and the only diff is the spurious table diff. I am going to go ahead and merge this in, thanks @jmarrec

NatLabRockies/EnergyPlus#10229 was merged

jmarrec added 5 commits September 18, 2023 10:35

(meta) unit test for #10220

5f3de84

Don't expose the schema() to EnergyPlusFixture, just use the public `…

8c6cbf0

…getObjectSchemaProps`

For #10220 - Replace Steam with DistrictHeatingSteam in LCC objects

7ae61a9

Add DistrictCooling and DistrictHeatingWater to LCC

1f48979

jmarrec added Defect Includes code to repair a defect in EnergyPlus IDDChange Code changes impact the IDD file (cannot be merged after IO freeze) labels Sep 18, 2023

jmarrec self-assigned this Sep 18, 2023

Update InputRules

afe8486

jmarrec commented Sep 18, 2023

View reviewed changes

This was referenced Sep 19, 2023

V23.2.0-IOFreeze - Fuel Type enum changes (DistrictHeatingWater / DistrictHeatingSteam) NatLabRockies/OpenStudio#4968

Merged

Update to EnergyPlus 23.2.0 NatLabRockies/OpenStudio#4934

Closed

Myoldmopar approved these changes Sep 19, 2023

View reviewed changes

Myoldmopar merged commit 25fac22 into develop Sep 19, 2023

Myoldmopar deleted the 10220_LifeCycleCost_Steam branch September 19, 2023 18:56

jmarrec added a commit to NatLabRockies/OpenStudio that referenced this pull request Sep 28, 2023

DistrictCooling/DistictHeatingSteam in LCC objects following E+ fix

d63e07b

NatLabRockies/EnergyPlus#10229 was merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix #10220 - LifeCycleCost objects are using "Steam" not "DistrictHeatingSteam" #10229

Fix #10220 - LifeCycleCost objects are using "Steam" not "DistrictHeatingSteam" #10229

Uh oh!

jmarrec commented Sep 18, 2023

Uh oh!

jmarrec Sep 18, 2023

Uh oh!

Myoldmopar Sep 19, 2023

Uh oh!

jmarrec Sep 18, 2023

Uh oh!

jmarrec Sep 18, 2023

Uh oh!

jmarrec commented Sep 18, 2023 •

edited

Loading

Uh oh!

Myoldmopar Sep 19, 2023

Uh oh!

Myoldmopar Sep 19, 2023

Uh oh!

Myoldmopar commented Sep 19, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

Fix #10220 - LifeCycleCost objects are using "Steam" not "DistrictHeatingSteam" #10229

Fix #10220 - LifeCycleCost objects are using "Steam" not "DistrictHeatingSteam" #10229

Uh oh!

Conversation

jmarrec commented Sep 18, 2023

Pull request overview

Pull Request Author

Reviewer

Uh oh!

jmarrec Sep 18, 2023

Choose a reason for hiding this comment

Uh oh!

Myoldmopar Sep 19, 2023

Choose a reason for hiding this comment

Uh oh!

jmarrec Sep 18, 2023

Choose a reason for hiding this comment

Uh oh!

jmarrec Sep 18, 2023

Choose a reason for hiding this comment

Uh oh!

jmarrec commented Sep 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Ori:

New:

Uh oh!

Myoldmopar Sep 19, 2023

Choose a reason for hiding this comment

Uh oh!

Myoldmopar Sep 19, 2023

Choose a reason for hiding this comment

Uh oh!

Myoldmopar commented Sep 19, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

jmarrec commented Sep 18, 2023 •

edited

Loading