Skip to content

Avoid using undesired convergence criterion

Maziar Veyskarami requested to merge fix/reorder-checking-newton-criteria into master

What this MR does / why does DuMux need it:

Since EnableShiftCriterion is the default convergence criterion, it should be checked after the criteria that might be selected by user in input file are checked. Otherwise, it could be the case that despite choosing another criterion by user, still EnableShiftCriterion is checked first in the code and is used as the convergence criterion.

A new parameter called SatisfyResidualOrShiftCriterion is introduced, that user can set if either residual or shift criterion is desired. Such a condition could also be met before by setting both EnableShiftCriterion and EnableResidualCriterion to true, which was confusing and could lead easily to mistakes.

Notes for the reviewer

TODO: insert text here

Before you request a review from someone, make sure to revise the following points:

  • does the new code follow the style guide?
  • do the test pipelines pass? (see guide on how to run pipelines for a merge request)
  • is the code you changed and/or the new code you wrote covered in the test suite? (if not, extend the existing tests or write new ones)
  • does your change affect public interfaces or behavior, or, does it introduce a new feature? If so, document the change in CHANGELOG.md.
  • is the list of the header includes complete? ("include what you use")
  • all files have to end with a \n character. Make sure there is no \ No newline at end of file comment in "Changes" of this MR.
Edited by Maziar Veyskarami

Merge request reports

Loading