set colocate=False in output field monitors for backwards compatibility #1144
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
momchil-flex
reviewed
Sep 6, 2023
| if mnt.colocate: | ||
| log.warning( | ||
| "Output field monitors in the adjoint plugin require " | ||
| "explicitly setting 'colocate=False'. Setting 'False' as the default value." |
There was a problem hiding this comment.
I think Setting 'False' as the default value. might be misleading because we're also overriding the value even if it was explicitly set to 'True'. I also feel like giving a bit more hints as in the old warning message would be nice, e.g. something like
Output field monitors in the adjoint plugin require explicitly setting 'colocate=False'. Setting 'colocate=False' in monitor {mnt.name}. Use 'SimulationData.at_boundaries' after the solver run to automatically colocate the fields to the grid boundaries, or 'MonitorData.colocate' if colocating to custom coordinates.
Just to let people know they can still do that with the adjiont data.
There was a problem hiding this comment.
ok. updated the warning message accordingly.
tylerflex
force-pushed
the
tyler/adjoint/fix/colocate_error
branch
from
2308390
to
09e2f9d
Compare
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.
No description provided.