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

Comment and cleanup of heat balance arrays #9097

Merged
merged 10 commits into from
Oct 29, 2021

Conversation

xuanluo113
Copy link
Contributor

@xuanluo113 xuanluo113 commented Sep 25, 2021

Pull request overview

This branch includes a few naming convention cleanups and a few local variable refactoring in calculating interior solar distribution.

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

@xuanluo113 xuanluo113 added Documentation Related primarily on the LaTeX-based EnergyPlus documentation Performance Includes code changes that are directed at improving the runtime performance of EnergyPlus labels Sep 25, 2021
@xuanluo113 xuanluo113 added this to the EnergyPlus 2022.1 milestone Sep 25, 2021
@xuanluo113 xuanluo113 self-assigned this Sep 25, 2021
@xuanluo113 xuanluo113 marked this pull request as ready for review October 4, 2021 15:43
@xuanluo113
Copy link
Contributor Author

@mjwitte This branch is ready for review. It's no more than a few naming convention cleanups and a few local variable refactoring in calculating interior solar distribution. Would you help take a look? Thanks!

Copy link
Contributor

@mjwitte mjwitte left a comment

Choose a reason for hiding this comment

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

@xuanluo0113 This looks good. Just a minor comment below.
Also, I don't see any CI results posted on the PR, so I'll check those after the next push.

Comment on lines 581 to 582
// Pointers to Surface Data Structure
// AllSurfF AllSurfL
Copy link
Contributor

Choose a reason for hiding this comment

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

This is very helpful, but I would pay close attention to the alignment and possibly add | characters to draw vertical lines to show the groupings.
Also, some of these will equal each other, e.g. HTSurfaceFirst = OpaqOrIntMassSurfaceFirst.
And comments explaining how these are set if a particular class of surfaces are not present in the zone. e.g. if there are no domes, what are TDDDomeFirst and TDDDomeLast set to?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mjwitte Thanks for the comments! I've committed the changes to make the comments clearer. For TDDDomes, same as Windows, if there are no domes, TDDDomeFirst is set as 0 and TDDDomeLast as -1.

Copy link
Contributor

@mjwitte mjwitte left a comment

Choose a reason for hiding this comment

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

@xuanluo113 Thanks. Much better. Will wait for CI green lights, then merge.

@mjwitte mjwitte merged commit 5b72af3 into NREL:develop Oct 29, 2021
@mjwitte mjwitte deleted the comment-and-cleanup branch October 29, 2021 01:32
yujiex pushed a commit that referenced this pull request Jan 27, 2022
Comment and cleanup of heat balance arrays
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Related primarily on the LaTeX-based EnergyPlus documentation Performance Includes code changes that are directed at improving the runtime performance of EnergyPlus
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants