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.

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

Correction of Hybrid Model Reporting Issues #10581

Merged
merged 3 commits into from
Jun 25, 2024

Conversation

RKStrand
Copy link
Contributor

Pull request overview

  • Fixes Hybrid Model Internal Thermal Mass Calculation Issues #10508
  • The hybrid model had a small logic issue where if the hybrid model thermal mass multiplier was not being calculated for whatever reason during the last time step of the last day of the time period for when it is valid the average thermal mass multiplier was not being calculated and simply reporting a default value of 1.0. In addition, the maximum value, when it exceeded 30 was being reset to 1.0. While the maximum value could be debated, it did not seem correct that this value was being reset to 1.0. Now, if the value exceeds 30, then a warning message is produced (first time with a message at the occurrence and then a recurring warning at the end) but the value is not reset. In addition, a new output variable was added so report the value of this parameter. Before, the only value that could be obtained was the average value over the course of the simulation. Now, users can look at the new output variable and calculate the value they wish to use using whatever method they wish. A unit test for the new subroutine enforcing the correction and additions to the documentation in the input/output reference and the engineering reference.

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

Fixes the defect with a solution suggested in GitHub which includes the following:
1. Calculates average multiplier regardless of system operation (now simply calculates it every time)
2. Uses the limit of 30 as a warning threshold but does not eliminate the value (previously set to 1 so that it wouldn't affect the average)
These items have been accomplished through the creation of a new subroutine that controls the calculation limits and calculates the sum, count, and average.
This commit includes:
1. Addition of a new report variable for the output parameter that spurred this defect.
2. A unit test was added to exercise the new subroutine through its various cases.
3. Documentation edits for both the input-output and engineering references.
Potential PR candidate.
@RKStrand RKStrand added the Defect Includes code to repair a defect in EnergyPlus label Jun 21, 2024
@RKStrand RKStrand added this to the EnergyPlus 24.2 IOFreeze milestone Jun 21, 2024
@RKStrand RKStrand self-assigned this Jun 21, 2024
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.

Minimal change and looks good.

@Myoldmopar
Copy link
Member

Tested locally, all good. Thanks @RKStrand

@Myoldmopar Myoldmopar merged commit 2abd001 into develop Jun 25, 2024
17 checks passed
@Myoldmopar Myoldmopar deleted the 10508HybridModelThermalMassCalculationIssue branch June 25, 2024 20:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Defect Includes code to repair a defect in EnergyPlus
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Hybrid Model Internal Thermal Mass Calculation Issues
7 participants