Skip to content

Ifpack2: improved FastILU section in user's guide

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

Created by: brian-kelley

@trilinos/ifpack2

Description

Simplified, clarified and corrected the FAST_ILU, FAST_IC and FAST_ILDL sections of Ifpack2 user's guide:

  • replaced "\shylu{}" with "ShyLU" to fix a LaTeX unknown directive error
  • Merged together the parameter lists for the 3, since they are identical
  • Before the parameters added a table of the relevant "Preconditioner type:" values and the human-readable names of the preconditioners
  • Fixed "IC" being expanded as "incomplete Chebyshev", it should be "incomplete Cholesky"
  • Use alpha and omega to refer to Manteuffel shift parameter and Jacobi damping factor, respectively
  • explain that "damping factor" parameter corresponds to Jacobi

Motivation and Context

The LaTeX error and inaccuracies definitely needed to be fixed, and it had too much redundancy and didn't explain parameters well before

How Has This Been Tested?

Built the user's guide with a clean install of MacTeX and made sure everything looks ok in the PDF

(Only changes are in documentation, so tests and compiler warnings don't apply)

Checklist

  • 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