Skip to content

Figure of Merit implementation #3363

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

Merged
merged 64 commits into from
May 3, 2025
Merged

Conversation

Grego01-biot
Copy link
Contributor

@Grego01-biot Grego01-biot commented Mar 27, 2025

Description

This PR introduces a new statistical capability in OpenMC: the ability to compute the figure of merit for each tally bin. This could provide the user with more information on how quickly the population variance of a tally bin decreases. This tally reliability indicator is already implemented in MCNP and can be of interest for many users. Indeed, in order to optimize the tally efficiency, the user could run several simulations using different variance reduction techniques and choose the one with the largest FOM.

Fixes # (issue)
At the moment, this functionality is simply a flag defined in the settings of the tally that the user can activate in order to get it for every tally bin. Most of the modifications are made in the Python API since the mean, the variance and the wall time are already available in the statepoint file.

Checklist

  • I have performed a self-review of my own code
  • I have run clang-format (version 15) on any C++ source files (if applicable)
  • I have followed the style guidelines for Python source files (if applicable)
  • I have made corresponding changes to the documentation (if applicable)
  • I have added tests that prove my fix is effective or that my feature works (if applicable)

@shimwell
Copy link
Member

I had a quick skim through the code, congrats on this work, I am keen to see this feature added.

@Grego01-biot Grego01-biot marked this pull request as ready for review April 22, 2025 13:39
Copy link
Contributor

@paulromano paulromano left a comment

Choose a reason for hiding this comment

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

@Grego01-biot I just did a bit of clean up here and I'd say it's ready to go. Thanks again for the PR!

@paulromano
Copy link
Contributor

@eepeterson let me know if you're good with the changes here now. If so, please approve so we can merge. Thanks!

@paulromano paulromano enabled auto-merge (squash) May 3, 2025 01:48
Copy link
Contributor

@eepeterson eepeterson left a comment

Choose a reason for hiding this comment

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

yep all good now.

@paulromano paulromano merged commit 1e7d832 into openmc-dev:develop May 3, 2025
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants