Skip to content

Correction of Error in Xing Ground Temperature Model Get Input #11096

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.

Sign up for GitHub

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

Jump to bottom
Merged
Myoldmopar merged 1 commit into from
Jul 7, 2025
Merged

Correction of Error in Xing Ground Temperature Model Get Input #11096

Myoldmopar merged 1 commit into from
Jul 7, 2025

Conversation

@RKStrand
Copy link
Contributor

@RKStrand RKStrand commented Jun 10, 2025

Pull request overview

For some reason, when the get input routine for the Xing model was executed, the variable objectName was being overwritten and turned into a blank field when GetObjectItem was called. The solution was to follow the method used by another ground temperature get routines which included moving the assignments for the base class to before the call to GetObjectItem. The unit test shows that the name and model type are preserved and no fatal error happens. Testing with the user example file no longer crashes but successfully completes.

Description of the purpose of this PR

This PR fixes the issue (user file now runs successfully) and includes a unit test.

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

@RKStrand
Solution and Unit Test
742b3fa 
For some reason, the variable objectName was being overwritten and turned into a blank field when GetObjectItem was called.  The solution was to follow the method used by other ground temperature get routines which included moving the assignments for the base class to before the call to GetObjectItem.  The unit test shows that the name and model type are preserved and no fatal error happens.  Testing with the user example file no longer crashes but successfully completes.
@RKStrand RKStrand added this to the EnergyPlus 25.2 milestone Jun 10, 2025
@RKStrand RKStrand self-assigned this Jun 10, 2025
@RKStrand RKStrand added the Defect Includes code to repair a defect in EnergyPlus label Jun 10, 2025
@RKStrand RKStrand requested a review from Myoldmopar June 10, 2025 12:04
@Myoldmopar
Copy link
Member

Myoldmopar commented Jul 7, 2025

For some reason, when the get input routine for the Xing model was executed, the variable objectName was being overwritten and turned into a blank field when GetObjectItem was called.

The reason is almost certainly that both of them are trying to use the DataIPShortcuts object name variable to hold the current object name. This was a nice touch in Fortran, but completely unnecessary with C++, and we should try to just use a local string instead of the "global" object name variable whenever possible. Anyway, this is a fine fix. Merging. And thanks.

@Myoldmopar Myoldmopar merged commit 876dbb8 into develop Jul 7, 2025
10 checks passed
@Myoldmopar Myoldmopar deleted the 10981GetGroundTempModelNameErrorXingInput branch July 7, 2025 19:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Myoldmopar Myoldmopar Awaiting requested review from Myoldmopar

Assignees

@RKStrand RKStrand

Labels

Defect Includes code to repair a defect in EnergyPlus

Projects

None yet

Milestone

EnergyPlus 25.2

Development

Successfully merging this pull request may close these issues.

GetGroundTempModelAndInit: Unable to read Xing

4 participants

@RKStrand @Myoldmopar @nrel-bot-2c