Skip to content
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

Enqueue Convergence Output Only if Needed #6086

Merged
merged 1 commit into from
Mar 19, 2025

Conversation

bska
Copy link
Member

@bska bska commented Mar 14, 2025

While here, also add Doxygen style documentation to the data members and member functions of class SimulatorConvergenceOutput.

@bska
Copy link
Member Author

bska commented Mar 14, 2025

I'm creating this PR in draft mode because it depends on, and contains, the earlier PR #6085. I will keep the PR in a draft state until such time as it is ready for review.

@bska bska force-pushed the skip-empty-convergence-reports branch 5 times, most recently from 3e6de90 to 055b581 Compare March 17, 2025 16:36
@bska
Copy link
Member Author

bska commented Mar 17, 2025

I'm creating this PR in draft mode because it depends on, and contains, the earlier PR #6085.

The earlier PR was merged into the master branch. I'm marking this PR as "ready for review" and I'm running a build check.

@bska bska marked this pull request as ready for review March 17, 2025 16:37
@bska
Copy link
Member Author

bska commented Mar 17, 2025

jenkins build this please

@bska bska force-pushed the skip-empty-convergence-reports branch from 055b581 to faeb624 Compare March 19, 2025 08:30
@bska
Copy link
Member Author

bska commented Mar 19, 2025

jenkins build this please

@bska bska force-pushed the skip-empty-convergence-reports branch from faeb624 to bb26314 Compare March 19, 2025 09:13
Copy link
Member

@akva2 akva2 left a comment

Choose a reason for hiding this comment

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

Output as a verb reads a little awkward but it is of course correct.

@bska
Copy link
Member Author

bska commented Mar 19, 2025

Output as a verb reads a little awkward

I suppose we can say "we've already written..." instead. Would that be an improvement?

@akva2
Copy link
Member

akva2 commented Mar 19, 2025

yes i think using written is an improvement.

@bska bska force-pushed the skip-empty-convergence-reports branch from bb26314 to 5a9b124 Compare March 19, 2025 11:40
@bska
Copy link
Member Author

bska commented Mar 19, 2025

i think using "written" is an improvement.

Cool–I've pushed an update to that effect.

@bska
Copy link
Member Author

bska commented Mar 19, 2025

jenkins build this please

/// Must not be called before startThread() or after endThread().
///
/// Only those reports which have not previously been emitted will be
/// output, and only if the run actually requests convergence output at
Copy link
Member

Choose a reason for hiding this comment

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

here as well

Copy link
Member Author

Choose a reason for hiding this comment

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

here as well

Right–sorry about that. I've pushed another update to address this.

While here, also add Doxygen style documentation to the data members
and member functions of class SimulatorConvergenceOutput.
@bska bska force-pushed the skip-empty-convergence-reports branch from 5a9b124 to b3f9848 Compare March 19, 2025 12:00
@bska
Copy link
Member Author

bska commented Mar 19, 2025

jenkins build this please

@bska
Copy link
Member Author

bska commented Mar 19, 2025

PR approved and build check is green. I'll merge into master.

@bska bska merged commit c3e1591 into OPM:master Mar 19, 2025
1 check passed
@bska bska deleted the skip-empty-convergence-reports branch March 19, 2025 12:26
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.

2 participants