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

Addresses #4538, wrap phase change material properties #4610

Merged
merged 55 commits into from Jul 22, 2022

Conversation

joseph-robertson
Copy link
Collaborator

@joseph-robertson joseph-robertson commented Jun 15, 2022

Pull request overview

  • Fixes Wrap phase change material properties #4538
  • Questions:
    • MaterialProperty:PhaseChange
      • Is at least one temperature-enthalpy extensible object required? (Based on the os-resources test, are at least 3 required?)
      • If some temperature-enthalpy pairs are required, do we need to pass them into the ctor? Update: I created a second ctor that takes temperature-enthalpy pairs as an argument, but there is no minimum on the number of the pairs.
    • MaterialProperty:PhaseChangeHysteresis
    • Reverse translators? There currently isn't one for MaterialPropertyMoisturePenetrationDepthSettings.

Pull Request Author

  • Model API Changes / Additions
  • Any new or modified fields have been implemented in the EnergyPlus ForwardTranslator (and ReverseTranslator as appropriate)
  • Model API methods are tested (in src/model/test)
  • EnergyPlus ForwardTranslator Tests (in src/energyplus/Test)
  • If a new object or method, added a test in NREL/OpenStudio-resources: Addresses #4538, wrap phase change material properties OpenStudio-resources#168
  • If needed, added VersionTranslation rules for the objects (src/osversion/VersionTranslator.cpp)
  • Verified that C# bindings built fine on Windows, partial classes used as needed, etc.
  • All new and existing tests passes
  • If methods have been deprecated, update rest of code to use the new methods

Labels:

  • If change to an IDD file, add the label IDDChange
  • If breaking existing API, add the label APIChange
  • If deemed ready, add label Pull Request - Ready for CI so that CI builds your PR

Review Checklist

This will not be exhaustively relevant to every PR.

  • Perform a Code Review on GitHub
  • Code Style, strip trailing whitespace, etc.
  • All related changes have been implemented: model changes, model tests, FT changes, FT tests, VersionTranslation, OS App
  • Labeling is ok
  • 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

@joseph-robertson joseph-robertson added the Pull Request - Ready for CI This pull request if finalized and is ready for continuous integration verification prior to merge. label Jun 17, 2022
Copy link
Collaborator

@jmarrec jmarrec left a comment

Choose a reason for hiding this comment

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

Jumping in unannounced because I saw swig build error. I didn't do a full review since this is still marked as a draft.

src/model/ModelResources.i Show resolved Hide resolved
src/model/Material.hpp Outdated Show resolved Hide resolved
@joseph-robertson
Copy link
Collaborator Author

joseph-robertson commented Jul 7, 2022

@jmarrec I responded to most of your comments. What (optionally?) remains:

  • bool initializeTemperatureEnthalpyWithDefaults in MaterialPropertyPhaseChange ctor
  • temperatureEnthalpyIndex and getTemperatureEnthalpy (you sound a little torn on this one)

Copy link
Collaborator

@jmarrec jmarrec left a comment

Choose a reason for hiding this comment

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

Suggested an IDD change (which we should probably propose to E+ on the issue board too), otherwise I think it's ready to drop! Thanks for the new objects @joseph-robertson !

resources/model/OpenStudio.idd Show resolved Hide resolved
@joseph-robertson joseph-robertson merged commit 28bbd74 into develop Jul 22, 2022
@joseph-robertson joseph-robertson deleted the issue-4538 branch July 22, 2022 19:34
jmarrec added a commit to NREL/OpenStudio-resources that referenced this pull request Sep 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component - Model Enhancement Request IDDChange Pull Request - Ready for CI This pull request if finalized and is ready for continuous integration verification prior to merge.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Wrap phase change material properties
3 participants