Add documentation to set methods for bound violation in QN acceleration#861
Open
Add documentation to set methods for bound violation in QN acceleration#861
Conversation
MakisH
reviewed
Mar 20, 2026
Member
MakisH
left a comment
MakisH
left a comment
There was a problem hiding this comment.
The current diff looks good, I have not yet looked at the bigger picture.
content/docs/configuration/basics/configuration-acceleration.md
Outdated
Show resolved
Hide resolved
MakisH
reviewed
Mar 24, 2026
Member
MakisH
left a comment
MakisH
left a comment
There was a problem hiding this comment.
The text looks good to me now. I have no idea about the feature, though, so you tell me when it's ready to merge.
| * `clamp`: preCICE checks the accelerated values against the given bound(s) after a QN update step is computed. The violating values will be clamped to the bounds respectively. Non-violating values are not influenced by this check. | ||
| * `scale`: preCICE checks the accelerated values against the given bound(s) after a QN update step is computed. If any violation is found, the update from this QN step is scaled by a scalar factor between 0 and 1, to fit all the violating values into the bounded range. | ||
|
|
||
| While `discard` and `clamp` are convenient options for single value or occasional bound violation, `scale` helps to retain the direction of the QN step by only shortening the step length. The best option for this attribute is problem-dependent. |
Member
There was a problem hiding this comment.
Ad the bottom of this, a version alert would be useful.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
To provide hints on using the new feature in acceleration configuration added by precice/precice#1952.