Skip to content

Adding GHE borehole field design and sizing#11217

Merged
mitchute merged 18 commits intodevelopfrom
GHEWorkContinued
Oct 15, 2025
Merged

Adding GHE borehole field design and sizing#11217
mitchute merged 18 commits intodevelopfrom
GHEWorkContinued

Conversation

@Myoldmopar
Copy link
Member

@Myoldmopar Myoldmopar commented Sep 18, 2025

Pull request overview

OK, this continues the ground heat exchanger modeling improvements. This one is about adding the ability to design and size the borehole field itself. Lots of caveats in here, and plenty of things needed for error handling, much improved documentation, more tests, double checking my flag usages, improvements to the required input configuration to make it work, etc. I'm pushing it tonight to see how GHA feels about it, and then I'll go from there tomorrow, including plenty of walkthrough.

Notable TO-DO:

  • Need to verify the loads are coming out as expected, and match the load sign convention for GHEDesigner
  • If we add an input field to the new :Sizing object that references the name of a SizingPeriod:WeatherFIleDays object, we could make the whole sizing/load operation much more flexible and robust.
  • Needs documentaiton updates in the engineering reference - probably a good time to go over the whole GLHE section.
  • Verify transition code changes work by pulling a 25.1 file, transitioning it, and running it in 25.2
  • Add outputs to the EIO file for the borehole field. Maybe a list of borehole X, Y coordinates?

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

@Myoldmopar Myoldmopar self-assigned this Sep 18, 2025
@Myoldmopar Myoldmopar added the NewFeature Includes code to add a new feature to EnergyPlus label Sep 18, 2025
@github-actions
Copy link

⚠️ Regressions detected on ubuntu-24.04 for commit 4cbe567

Regression Summary
  • ERR: 1

@github-actions
Copy link

⚠️ Regressions detected on macos-14 for commit 4cbe567

Regression Summary
  • ERR: 1

@mjwitte mjwitte added the IDDChange Code changes impact the IDD file (cannot be merged after IO freeze) label Sep 25, 2025
@mjwitte mjwitte added this to the EnergyPlus 25.2 IO Freeze milestone Sep 25, 2025
@rraustad
Copy link
Collaborator

rraustad commented Oct 8, 2025

I don't know which code is more correct in test_pull_requests.yml so can't correct that. Linux debug failure seems unrelated.

Unit tests run locally. New borehole example file GSHP-GLHE-BoreholeFieldDesign fails witthout Python CLI:

**  Fatal  ** Attempted to use borehole field design in a build without PYTHON_CLI, which is invalid

and has an error when including Python CLI:

** Warning ** [G-Function Calculation for GHE Named: VERTICAL GHE 1X4 STD] EnergyPlus fluid concentration > 60% (GHEDesigner max), reducing to 60%, continuing
**  Fatal  ** GHEDesigner failed to calculate G-functions.
image

@mitchute
Copy link
Collaborator

mitchute commented Oct 8, 2025

Thanks, @rraustad. I've corrected the merge issues, and will push them up in the morning.

@mitchute
Copy link
Collaborator

I'm going to be working on cleaning up the docs and transitions this morning, but would appreciate a general review of the inputs and other changes.

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.

Unit tests all run.

New test file runs, although it has lots of warnings:

   *************  ** Warning ** Actual air mass flow rate is smaller than 25% of water-to-air heat pump coil rated air flow rate.
   *************  **   ~~~   **   This error occurred 283807 total times;
   *************  **   ~~~   **   during Warmup 213 times;
   *************  **   ~~~   **   during Sizing 0 times.
   *************  **   ~~~   **   Max=0.050685  Min=0.000035
   *************
   *************  ** Warning ** Plant loop falling below lower temperature limit, PlantLoop="GROUND LOOP WATER LOOP"
   *************  **   ~~~   **   This error occurred 16354 total times;
   *************  **   ~~~   **   during Warmup 489 times;
   *************  **   ~~~   **   during Sizing 0 times.
   *************  **   ~~~   **   Min=-9.323420

The eio sizing output looks incomplete?

 Component Sizing Information, GroundHeatExchanger:System, VERTICAL GHE 1X4 STD, Borehole Field Locations (x1 y1) (x2 y2) ...,  (0 0) (10 0)

Some further comments below. I didn't try to understand the guts of this.

@mitchute
Copy link
Collaborator

I've addressed the comments. Merging, but likely will follow-up with some more polish here.

@mitchute mitchute merged commit 6a6bc07 into develop Oct 15, 2025
11 checks passed
@mitchute mitchute deleted the GHEWorkContinued branch October 15, 2025 03:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

IDDChange Code changes impact the IDD file (cannot be merged after IO freeze) NewFeature Includes code to add a new feature to EnergyPlus

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants