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

AirflowNetwork network validation refactor #10349

Draft
wants to merge 6 commits into
base: develop
Choose a base branch
from

Conversation

jasondegraw
Copy link
Member

Pull request overview

This PR refactors how the AirflowNetwork pressure network is validated. The diagnostic script is being removed from the repo and the content included in a separate Python tool that does additional validation. Some of validation done by the script (and now the Python tool) is probably not appropriate for the solver, so the focus is on things that have come up in the past. Additional checks may be added with an on/off switch (maybe in the AFN simulation control object) in the future.

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

The content is being moved to a separate tool and this setup really
didn't pan out as hoped, so to avoid duplication it makes sense to
remove the files.
@@ -96,53 +96,17 @@ namespace AirflowNetwork {

enum class DuctLineType
{
Invalid = -1,
Unknown = 0,
Copy link
Collaborator

Choose a reason for hiding this comment

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

Ummm, why Unknown = 0 as opposed to Invalid = -1 which is what we are doing everywhere else?

Copy link
Member Author

Choose a reason for hiding this comment

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

See other longer comment, I'm trying to get all these to the point where they're not read in or ever possibly invalid.

// TODO: enum check
Invalid = -1,
DOP = 1, // Detailed large opening component
Unknown = -1,
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why Unknown and not Invalid, which is what we are calling that spot everywhere else?

Copy link
Member Author

Choose a reason for hiding this comment

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

The ultimate goal is to eliminate additional members entirely because it isn't read in through the input processor. It's currently needed because there's a helper data structure AirflowNetworkCompProp that I haven't managed to get rid of yet. The helper structure is used for some introspection-type things that should instead be asking the element itself what type it is via the type method. I changed it to 'Unknown' because it will never be invalid and the goal it to get rid of it anyway.

HEX = 6, // Heat exchanger
RVD = 7, // Reheat VAV terminal damper
Num
Unknown = 0,
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same question.

Copy link
Member Author

Choose a reason for hiding this comment

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

See other longer comment, I'm trying to get all these to the point where they're not read in or ever possibly invalid.

The AirflowNetwork_MultiAirLoopTest unit test now has a chunk
commented out, that will need to be fixed before this can be
merged.
@nrel-bot-3
Copy link

@jasondegraw @Myoldmopar it has been 28 days since this pull request was last updated.

1 similar comment
@nrel-bot-2c
Copy link

@jasondegraw @Myoldmopar it has been 28 days since this pull request was last updated.

@Myoldmopar Myoldmopar added this to the EnergyPlus 24.2 milestone Mar 14, 2024
@nrel-bot
Copy link

@jasondegraw @Myoldmopar it has been 28 days since this pull request was last updated.

7 similar comments
@nrel-bot-2b
Copy link

@jasondegraw @Myoldmopar it has been 28 days since this pull request was last updated.

@nrel-bot-2c
Copy link

@jasondegraw @Myoldmopar it has been 28 days since this pull request was last updated.

@nrel-bot
Copy link

nrel-bot commented Jun 7, 2024

@jasondegraw @Myoldmopar it has been 28 days since this pull request was last updated.

@nrel-bot-3
Copy link

@jasondegraw @Myoldmopar it has been 28 days since this pull request was last updated.

@nrel-bot
Copy link

nrel-bot commented Jul 5, 2024

@jasondegraw @Myoldmopar it has been 28 days since this pull request was last updated.

@nrel-bot-3
Copy link

@jasondegraw @Myoldmopar it has been 28 days since this pull request was last updated.

@nrel-bot
Copy link

@jasondegraw @Myoldmopar it has been 28 days since this pull request was last updated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants