Skip to content

Add COP report for boilers - #11741

Merged
mitchute merged 3 commits into
developfrom
6733-Add-output-for-boiler-COP
Aug 13, 2026
Merged

Add COP report for boilers#11741
mitchute merged 3 commits into
developfrom
6733-Add-output-for-boiler-COP

Conversation

@rraustad

@rraustad rraustad commented Aug 12, 2026

Copy link
Copy Markdown
Collaborator

Pull request overview

Description of the purpose of this PR

Add calculation for boiler COP during heating operation.

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
  • If adding/removing any output files (e.g., eplustbl.*)
    • Update ..\scripts\Epl-run.bat
    • Update ..\scripts\RunEPlus.bat
    • Update ..\src\EPLaunch\ MainModule.bas, epl-ui.frm, and epl.vbp (VersionComments)
    • Update ...github\workflows\energyplus.py

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

@rraustad rraustad added the Defect Includes code to repair a defect in EnergyPlus label Aug 12, 2026
@rraustad rraustad self-assigned this Aug 12, 2026
@rraustad

rraustad commented Aug 12, 2026

Copy link
Copy Markdown
Collaborator Author

Result from the modified 5ZoneAirCooled example file:

image

@github-actions

github-actions Bot commented Aug 12, 2026

Copy link
Copy Markdown

⚠️ Regressions detected on macos-14 for commit b113648

Regression Summary
  • Audit: 216
  • RDD: 210
  • ERR: 1
  • MTD: 1

@github-actions

github-actions Bot commented Aug 12, 2026

Copy link
Copy Markdown

⚠️ Regressions detected on ubuntu-24.04 for commit b113648

Regression Summary
  • Audit: 216
  • RDD: 210
  • ERR: 1
  • MTD: 1

@github-actions

github-actions Bot commented Aug 12, 2026

Copy link
Copy Markdown

⚠️ Regressions detected on macos-14 for commit a90bd2d

Regression Summary
  • Audit: 216
  • RDD: 210
  • MTD: 2

@github-actions

github-actions Bot commented Aug 12, 2026

Copy link
Copy Markdown

⚠️ Regressions detected on ubuntu-24.04 for commit a90bd2d

Regression Summary
  • Audit: 216
  • RDD: 210
  • MTD: 2

mitchute
mitchute reviewed Aug 12, 2026
View reviewed changes
Comment thread doc/input-output-reference/src/overview/group-plant-equipment.tex Outdated
mitchute
mitchute reviewed Aug 12, 2026
View reviewed changes
Comment thread doc/input-output-reference/src/overview/group-plant-equipment.tex Outdated
mitchute
mitchute reviewed Aug 12, 2026
View reviewed changes
Comment thread doc/input-output-reference/src/overview/group-plant-equipment.tex Outdated

This output is the coefficient of performance for the boiler during heating operation. It is calculated by dividing the boiler heating rate by the sum of the boiler electricity rate, boiler ancillary electricity rate and the boiler ancillary fuel (fuel type dependent) rate.

\emph{Note that this variable is reported as zero when the boiler is not operating. When reported for frequencies longer than ``detailed'' (such as timestep, hourly, daily, monthly or environment), this output will only be meaningful when the boiler is operating for the entire reporting period. To determine an efficiency for a longer time period, compute the efficiency based on boiler heating rate divided by boiler gas rate over the desired period.}

@mitchute mitchute Aug 12, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Broader question - should we be computing COPs based on energy instead of instantaneous power, so they aggregate? I don't see similar caveats like this elsewhere.

@mitchute mitchute Aug 12, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I was misunderstanding how our reporting works, so my suggestion above is invalid.

mitchute
mitchute reviewed Aug 12, 2026
View reviewed changes
Comment thread doc/input-output-reference/src/overview/group-plant-equipment.tex Outdated
@mitchute

mitchute commented Aug 12, 2026

Copy link
Copy Markdown
Collaborator

@rraustad I went ahead and updated the docs so we can move this one along. I believe it's ready to go.

@github-actions

github-actions Bot commented Aug 12, 2026

Copy link
Copy Markdown

⚠️ Regressions detected on macos-14 for commit eb30e40

Regression Summary
  • Audit: 216
  • RDD: 210
  • MTD: 2

@github-actions

github-actions Bot commented Aug 12, 2026

Copy link
Copy Markdown

⚠️ Regressions detected on ubuntu-24.04 for commit eb30e40

Regression Summary
  • Audit: 216
  • RDD: 210
  • MTD: 2

mitchute
mitchute approved these changes Aug 13, 2026
View reviewed changes

@mitchute mitchute left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks @rraustad. Ready to rumble.

@mitchute
mitchute merged commit 1d8feb7 into develop Aug 13, 2026
8 checks passed
@mitchute
mitchute deleted the 6733-Add-output-for-boiler-COP branch August 13, 2026 01:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mitchute mitchute mitchute approved these changes

Assignees

@rraustad rraustad

Labels

Defect Includes code to repair a defect in EnergyPlus

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add an Output:Variable for BoilerHotWater efficiency

3 participants

@rraustad @mitchute @nrel-bot-2c