correctly exclude flux vars from searches by default #1070
Merged
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
Yurlungur
requested review from
bprather,
jdolence,
lroberts36,
pgrete and
pdmullen
Yurlungur
commented
May 8, 2024
Comment on lines
+162
to
+165
| [[noreturn]] inline void fail(std::string const &message, const char *const filename, | ||
| int const linenumber) { | ||
| fail(message.c_str(), filename, linenumber); | ||
| } |
There was a problem hiding this comment.
This overload was missing for whatever reason. Added it.
bprather
approved these changes
May 8, 2024
…k its unlikely to hit this edge case
pdmullen
approved these changes
May 8, 2024
| ----------------------------------------------------- | ||
|
|
||
| As discussed above, fluxes are themselves ``Metadata::OneCopy`` | ||
| variables. A flux variable will have ``Metadata::Flux`` flag |
There was a problem hiding this comment.
Suggested change
| variables. A flux variable will have ``Metadata::Flux`` flag | |
| variables. A flux variable will have a ``Metadata::Flux`` flag |
| the flux variable **associated** with the variable | ||
| requested. ``FluxRequest::Any`` does not modify search parameters. You | ||
| will get flux or non-flux variables, and variable associations will be | ||
| ignored. |
There was a problem hiding this comment.
Can we mention how PDOPt::WithFluxes is related here? Typically, if I want the variable and the flux, I would create a SparsePack with PDOPt::WithFluxes. I am sure you have ensured backwards compatibility here, but this documentation led to this confusion for me...
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.
PR Summary
PR #1043 introduced an unexpected bug/interaction. When searching for vars by flag or by unique ID, it's possible to accidentally include fluxes, since they are now variables. To retain previous behavior, I introduce an enum
FluxRequest, which can take on the valuesAny,NoFlux, orOnlyFlux. IfAnyis specified, the search does nothing special for fluxes. IfNoFluxis specified, flux vars are explicitly excluded. IfOnlyFluxis specified, behavior is a little special. Vars that have fluxes are searched for, and then the fluxes of those variables are returned.I add a test to ensure the unexpected behavior is no longer present and confirmed in riot that the bug is now resolved.
PR Checklist