Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix #10279 - Make sure that assigning the result of a TendVariable (eg @TrendValue) results in proper actuator behavior #10575

Merged
merged 4 commits into from
Jun 25, 2024
Merged

Fix #10279 - Make sure that assigning the result of a TendVariable (eg @TrendValue) results in proper actuator behavior #10575

merged 4 commits into from
Jun 25, 2024

Conversation

jmarrec
Copy link
Contributor

@jmarrec jmarrec commented Jun 19, 2024 •
edited
Loading

Pull request overview

First commit only takes a few references so the code is more readable (and debuggable...). Exclude it from the diff when reviewing: https://github.com/NREL/EnergyPlus/pull/10575/files/84c142cf8edb62e90735ef23c0ddf2e37c0491db..dd1efa4e56c4090afaf769b063ed1c4014b53169

Comparing before and after, for mcve.idf in the EnergyPlusDevSupport:

image

Pull Request Author

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

  • Title of PR should be user-synopsis style (clearly understandable in a standalone changelog context)
  • Label the PR with at least one of: Defect, Refactoring, NewFeature, Performance, and/or DoNoPublish
  • Pull requests that impact EnergyPlus code must also include unit tests to cover enhancement or defect repair
  • Author should provide a "walkthrough" of relevant code changes using a GitHub code review comment process
  • If any diffs are expected, author must demonstrate they are justified using plots and descriptions
  • If changes fix a defect, the fix should be demonstrated in plots and descriptions
  • If any defect files are updated to a more recent version, upload new versions here or on DevSupport
  • If IDD requires transition, transition source, rules, ExpandObjects, and IDFs must be updated, and add IDDChange label
  • If structural output changes, add to output rules file and add OutputChange label
  • If adding/removing any LaTeX docs or figures, update that document's CMakeLists file dependencies

Reviewer

This will not be exhaustively relevant to every PR.

  • Perform a Code Review on GitHub
  • If branch is behind develop, merge develop and build locally to check for side effects of the merge
  • 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
  • Check that performance is not impacted (CI Linux results include performance check)
  • Run Unit Test(s) locally
  • Check any new function arguments for performance impacts
  • Verify IDF naming conventions and styles, memos and notes and defaults
  • If new idf included, locally check the err file and other outputs

@jmarrec
Take a couple of references so the code becomes readable (and debugga…
84c142c 
…ble)
@jmarrec
Add a unit test for #10279
daac99a
@jmarrec
Improve unit tests for #10279 to illustrate what happens during the a…
366286c 
…nnual simulation

```
/home/julien/Software/Others/EnergyPlus/tst/EnergyPlus/unit/EMSManager.unit.cc:2463: Failure
Value of: actuatorDirectErlVar.Value.TrendVariable
  Actual: true
Expected: false
/home/julien/Software/Others/EnergyPlus/tst/EnergyPlus/unit/EMSManager.unit.cc:2464: Failure
Expected equality of these values:
  0
  actuatorDirectErlVar.Value.TrendVarPointer
    Which is: 1
/home/julien/Software/Others/EnergyPlus/tst/EnergyPlus/unit/EMSManager.unit.cc:2475: Failure
Value of: actuatorIndirectErlVar.Value.TrendVariable
  Actual: true
Expected: false
/home/julien/Software/Others/EnergyPlus/tst/EnergyPlus/unit/EMSManager.unit.cc:2476: Failure
Expected equality of these values:
  0
  actuatorIndirectErlVar.Value.TrendVarPointer
    Which is: 1
/home/julien/Software/Others/EnergyPlus/tst/EnergyPlus/unit/EMSManager.unit.cc:2499: Failure
Value of: resultValueErlVar.Value.TrendVariable
  Actual: true
Expected: false
/home/julien/Software/Others/EnergyPlus/tst/EnergyPlus/unit/EMSManager.unit.cc:2500: Failure
Expected equality of these values:
  0
  resultValueErlVar.Value.TrendVarPointer
    Which is: 1
/home/julien/Software/Others/EnergyPlus/tst/EnergyPlus/unit/EMSManager.unit.cc:2536: Failure
In comparing enums of type 'EnergyPlus::DataRuntimeLanguage::Value', Expected equality of these values:
  DataRuntimeLanguage::Value::Number
    Which is: 1
  actuatorDirectErlVar.Value.Type
    Which is: 0
/home/julien/Software/Others/EnergyPlus/tst/EnergyPlus/unit/EMSManager.unit.cc:2540: Failure
Value of: actuatorDirectErlVar.Value.TrendVariable
  Actual: true
Expected: false
/home/julien/Software/Others/EnergyPlus/tst/EnergyPlus/unit/EMSManager.unit.cc:2541: Failure
Expected equality of these values:
  0
  actuatorDirectErlVar.Value.TrendVarPointer
    Which is: 1
/home/julien/Software/Others/EnergyPlus/tst/EnergyPlus/unit/EMSManager.unit.cc:2548: Failure
In comparing enums of type 'EnergyPlus::DataRuntimeLanguage::Value', Expected equality of these values:
  DataRuntimeLanguage::Value::Number
    Which is: 1
  actuatorIndirectErlVar.Value.Type
    Which is: 0
/home/julien/Software/Others/EnergyPlus/tst/EnergyPlus/unit/EMSManager.unit.cc:2552: Failure
Value of: actuatorIndirectErlVar.Value.TrendVariable
  Actual: true
Expected: false
/home/julien/Software/Others/EnergyPlus/tst/EnergyPlus/unit/EMSManager.unit.cc:2553: Failure
Expected equality of these values:
  0
  actuatorIndirectErlVar.Value.TrendVarPointer
    Which is: 1
/home/julien/Software/Others/EnergyPlus/tst/EnergyPlus/unit/EMSManager.unit.cc:2576: Failure
Value of: resultValueErlVar.Value.TrendVariable
  Actual: true
Expected: false
/home/julien/Software/Others/EnergyPlus/tst/EnergyPlus/unit/EMSManager.unit.cc:2577: Failure
Expected equality of these values:
  0
  resultValueErlVar.Value.TrendVarPointer
    Which is: 1
/home/julien/Software/Others/EnergyPlus/tst/EnergyPlus/unit/EMSManager.unit.cc:2582: Failure
Expected equality of these values:
  45.0
    Which is: 45
  schDirect.CurrentValue
    Which is: 18
/home/julien/Software/Others/EnergyPlus/tst/EnergyPlus/unit/EMSManager.unit.cc:2583: Failure
Value of: schDirect.EMSActuatedOn
  Actual: false
Expected: true
/home/julien/Software/Others/EnergyPlus/tst/EnergyPlus/unit/EMSManager.unit.cc:2584: Failure
Expected equality of these values:
  45.0
    Which is: 45
  schDirect.EMSValue
    Which is: 0
/home/julien/Software/Others/EnergyPlus/tst/EnergyPlus/unit/EMSManager.unit.cc:2585: Failure
Expected equality of these values:
  45.0
    Which is: 45
  schIndirect.CurrentValue
    Which is: 18
/home/julien/Software/Others/EnergyPlus/tst/EnergyPlus/unit/EMSManager.unit.cc:2586: Failure
Value of: schIndirect.EMSActuatedOn
  Actual: false
Expected: true
/home/julien/Software/Others/EnergyPlus/tst/EnergyPlus/unit/EMSManager.unit.cc:2587: Failure
Expected equality of these values:
  45.0
    Which is: 45
  schIndirect.EMSValue
    Which is: 0

```
@jmarrec
Fix #10279 - Don't copy TrendVariable stuff when assigning Value in EMS
dd1efa4 
Before the simulation, the Actuators in EvaluateStack would be assigned a Value naively, which means if it was assigned the result of a @TrendValue, it would set the TrendVariable to true

Once we get to the Simulation itself again, BeginEnvrnInitializeRuntimeLanguage is called, which resets the actuators to a Value with Type Null

In EvaluateStack, we go into a different block, because it now thinks it is a trendVariable
And the assignment for trend variable only sets Number, not Type, so Type stays Null, and the actuator is not actuating anything as a result.
@jmarrec jmarrec added the Defect Includes code to repair a defect in EnergyPlus label Jun 19, 2024
@jmarrec jmarrec self-assigned this Jun 19, 2024
jmarrec
jmarrec commented Jun 19, 2024
View reviewed changes
tst/EnergyPlus/unit/EMSManager.unit.cc
EXPECT_EQ(45.0, actuatorDirectErlVar.Value.Number);
EXPECT_TRUE(actuatorDirectErlVar.Value.String.empty());
EXPECT_EQ(0, actuatorDirectErlVar.Value.Expression);
EXPECT_FALSE(actuatorDirectErlVar.Value.TrendVariable);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Before fix, this is actually TRUE, because we assigned a Value to the actuator that is the result of evaluating a trend variable.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense. Good fix and test.

tst/EnergyPlus/unit/EMSManager.unit.cc
Comment on lines +2516 to +2526
// Now, here's the kicker. Once we get to the Simulation itself again, we go into a different block, because t thinks it's a trend variable
// BeginEnvrnInitializeRuntimeLanguage is called, which resets the actuators to a Value with Type Null
// And the assignment for trend variable only sets Number, not Type, so Type stays Null, and the actuator is not actuating
EMSManager::ManageEMS(*state, EMSManager::EMSCallFrom::SetupSimulation, anyEMSRan, ObjexxFCL::Optional_int_const());
EXPECT_FALSE(anyEMSRan);

trendVar.TrendValARR = trendValues;

state->dataGlobal->CurrentTime = 24.00;
EMSManager::ManageEMS(*state, EMSManager::EMSCallFrom::BeginTimestepBeforePredictor, anyEMSRan, ObjexxFCL::Optional_int_const());
EXPECT_TRUE(anyEMSRan);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This explains what was happening before.

tst/EnergyPlus/unit/EMSManager.unit.cc
Comment on lines +2581 to +2587
ScheduleManager::UpdateScheduleValues(*state);
EXPECT_EQ(45.0, schDirect.CurrentValue);
EXPECT_TRUE(schDirect.EMSActuatedOn);
EXPECT_EQ(45.0, schDirect.EMSValue);
EXPECT_EQ(45.0, schIndirect.CurrentValue);
EXPECT_TRUE(schIndirect.EMSActuatedOn);
EXPECT_EQ(45.0, schIndirect.EMSValue);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Before fix, schedule CurrentValue is 18, and the EMS is off.

src/EnergyPlus/RuntimeLanguageProcessor.cc
Comment on lines +836 to +841
// #10279 - We don't do `thisErlVar.Value = ReturnValue;` because we don't want to copy TrendVariable stuff
thisErlVar.Value.Type = ReturnValue.Type;
thisErlVar.Value.Number = ReturnValue.Number;
// thisErlVar.Value.String = ReturnValue.String;
thisErlVar.Value.Error = ReturnValue.Error;
thisErlVar.Value.initialized = ReturnValue.initialized;
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the actual fix...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ahhh very nice. 👍

@jmarrec jmarrec requested a review from Myoldmopar June 19, 2024 15:40
@Myoldmopar Myoldmopar self-assigned this Jun 24, 2024
Myoldmopar
Myoldmopar approved these changes Jun 25, 2024
View reviewed changes
Copy link
Member

@Myoldmopar Myoldmopar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great!!

src/EnergyPlus/RuntimeLanguageProcessor.cc
Comment on lines +836 to +841
// #10279 - We don't do `thisErlVar.Value = ReturnValue;` because we don't want to copy TrendVariable stuff
thisErlVar.Value.Type = ReturnValue.Type;
thisErlVar.Value.Number = ReturnValue.Number;
// thisErlVar.Value.String = ReturnValue.String;
thisErlVar.Value.Error = ReturnValue.Error;
thisErlVar.Value.initialized = ReturnValue.initialized;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ahhh very nice. 👍

tst/EnergyPlus/unit/EMSManager.unit.cc
EXPECT_EQ(45.0, actuatorDirectErlVar.Value.Number);
EXPECT_TRUE(actuatorDirectErlVar.Value.String.empty());
EXPECT_EQ(0, actuatorDirectErlVar.Value.Expression);
EXPECT_FALSE(actuatorDirectErlVar.Value.TrendVariable);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense. Good fix and test.

@Myoldmopar
Copy link
Member

Great stuff, thanks @jmarrec, merging this.

@Myoldmopar Myoldmopar merged commit 69012c5 into develop Jun 25, 2024
17 checks passed
@Myoldmopar Myoldmopar deleted the 10279_EMS_Actuator_not_actualized branch June 25, 2024 17:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Myoldmopar Myoldmopar Myoldmopar approved these changes

Assignees

@Myoldmopar Myoldmopar

@jmarrec jmarrec

Labels
Defect Includes code to repair a defect in EnergyPlus
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Simple EMS actuator : is it a bug?
6 participants
@jmarrec @Myoldmopar @nrel-bot @nrel-bot-2 @nrel-bot-3 @nrel-bot-2c