Skip to content

Conversation

@RKStrand
Copy link
Contributor

@RKStrand RKStrand commented Jun 9, 2025

In order to run an EcoRoof simulation, the user must run a CTF based solution for the surface(s) that is/are green roof(s) or EcoRoof(s). Currently, E+ provides a severe error when the user requests an EcoRoof simulation but does not use the CTF solution algorithm. However, after an error message is produced, the simulation continues on. The improvement here is that now E+ will fatal out. In addition, more details are provided to the user as part of the error message that reminds the user of what syntax changes the solution procedure including for surfaces and also point to the surface that has a problem. Unit tests also verify that the solution must be CTF or an error will be produced.

Pull request overview

Description of the purpose of this PR

This PR provides the fix and unit test to solve the defect with E+ where the solution continues when an EcoRoof is defined and the surface does NOT use the CTF solution algorithm.

Pull Request Author

  • 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

  • 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

Improvement of error message for EcoRoof simulation.  Now fatals out as requested.  Also provides additional information to tell user what is happening and why.  Also points user to the surface where the problem occurs.  Unit test also included in this commit.
@RKStrand RKStrand added this to the EnergyPlus 25.2 milestone Jun 9, 2025
@RKStrand RKStrand requested review from Myoldmopar and mjwitte June 9, 2025 15:13
@RKStrand RKStrand self-assigned this Jun 9, 2025
@RKStrand RKStrand added the Defect Includes code to repair a defect in EnergyPlus label Jun 9, 2025
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.

Works as advertised. Thanks @RKStrand !

@mjwitte mjwitte merged commit e9810ee into develop Jun 13, 2025
10 checks passed
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.

Material:RoofVegetation with anything other than CTF should be fatal.

4 participants