Acquire ownership of data returned by compute! #88
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Prior to this version, `ClimaDiagnostics` would directly store use the output returned by `compute!` functions the first time they are called. This leads to problems when the output is a reference to an existing object since multiple diagnostics would modify the same object. Now, `ClimaDiagnostics` makes a copy of the return object so that it is no longer necessary to do so in the `compute!` function.
charleskawczynski
approved these changes
Oct 7, 2024
Yes, I agree, and I don't know why I didn't think about this earlier |
Sbozzolo
added a commit
to CliMA/ClimaAtmos.jl
that referenced
this pull request
Oct 7, 2024
The radiation diagnostics were returning references to objects, leading to conflicts when multiple diagnostics were added at the same time. This commit ensures that all the radiation diagnostics return a new object. CliMA/ClimaDiagnostics.jl#88 fixes the problem direclty in ClimaDiagnostics, but I think it is still worth fixing in atmos, too, so that we can be compatible with previous versions of ClimaDiagnostics and more uniform with what we are doing with all the other diagnostics
Sbozzolo
added a commit
to CliMA/ClimaAtmos.jl
that referenced
this pull request
Oct 7, 2024
The radiation diagnostics were returning references to objects, leading to conflicts when multiple diagnostics were added at the same time. This commit ensures that all the radiation diagnostics return a new object. CliMA/ClimaDiagnostics.jl#88 fixes the problem direclty in ClimaDiagnostics, but I think it is still worth fixing in atmos, too, so that we can be compatible with previous versions of ClimaDiagnostics and more uniform with what we are doing with all the other diagnostics
This was kind of my related concern with the deepcopy (I forget which repo/PR it was from). |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #88 +/- ##
=======================================
Coverage 85.19% 85.19%
=======================================
Files 13 13
Lines 520 520
=======================================
Hits 443 443
Misses 77 77 ☔ View full report in Codecov by Sentry. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Prior to this version,
ClimaDiagnosticswould directly store use the output returned bycompute!functions the first time they are called. This leads to problems when the output is a reference to an existing object since multiple diagnostics would modify the same object. Now,ClimaDiagnosticsmakes a copy of the return object so that it is no longer necessary to do so in thecompute!function.Fixes problem found by @szy21 with radiation