Skip to content

Ifpack2: updated block relaxation options in user's guide (Fix #971)

James Willenbring requested to merge brian-kelley:Fix971 into develop

Created by: brian-kelley

Also fixed the actual default BlockRelaxation container type (set in getValidParameters()) from "TriDi" to "Dense" to match the documentation, comments and value set in the constructor.



In options.tex for the Ifpack2 user's guide, added brief documentation for the BlockRelaxation parameters that were missing. Did not add the "schwarz: ..." options, which are valid (added to list in BlockRelaxation::getValidParameters()) but whose values are never used, so there is no reason for users to care about them.

Motivation and Context

The section of the user's guide about BlockRelaxation was out of date and it was necessary to look at source code to find the full set of valid parameters and their meanings.

How Has This Been Tested?


  • My commit messages mention the appropriate GitHub issue numbers.
  • My code follows the code style of the affected package(s).
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the code contribution guidelines for this project.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • No new compiler warnings were introduced.
  • These changes break backwards compatibility.

Merge request reports