KSP Manual Pages

The Scalable Linear Equations Solvers (SLES) component provides an easy-to-use interface to the combination of a Krylov subspace iterative method and a preconditioner (in the KSP and PC components, respectively) or a sequential direct solver. SLES users can set various Krylov subspace options at runtime via the options database (e.g., -ksp_type cg ). SLES users can also set KSP options directly in application codes by first extracting the KSP context from the SLES context via SLESGetKSP() and then directly calling the KSP routines listed below (e.g., KSPSetType() ). KSP components can be used directly to create and destroy solvers; this is not needed for users but is intended for library developers.

Beginner - Basic usage
KSPSetInitialGuessNonzero KSPSetMonitor
Intermediate - Setting options for algorithms and data structures
KSPCGSetType KSPGetIterationNumber KSPResidual
KSPChebychevSetEigenvalues KSPGetMonitorContext KSPRichardsonSetScale
KSPClearMonitor KSPGetPreconditionerSide KSPSetPreconditionerSide
KSPDefaultConverged KSPGetResidualNorm KSPSetTolerances
KSPDefaultMonitor KSPGetTolerances KSPSetType
KSPGMRESPrestartSet KSPGetType KSPSingularValueMonitor
KSPGMRESSetOrthogonalization KSPLGMonitorCreate KSPSolveTrans
KSPGMRESSetPreAllocateVectors KSPLGMonitorDestroy KSPTrueMonitor
KSPGMRESSetRestart KSPLGTrueMonitorCreate KSPVecViewMonitor
KSPGetInitialGuessNonzero KSPLGTrueMonitorDestroy
Advanced - Setting more advanced options and customization
KSPAppendOptionsPrefix KSPGetOptionsPrefix KSPSetComputeSingularValues
KSPBuildResidual KSPGetResidualHistory KSPSetConvergenceTest
KSPBuildSolution KSPRegister KSPSetOptionsPrefix
KSPComputeEigenvalues KSPRegisterAll KSPSetResidualHistory
KSPComputeEigenvaluesExplicitly KSPRegisterDestroy KSPSetUsePreconditionedResidual
KSPComputeExplicitOperator KSPSetAvoidNorms KSPSkipConverged
KSPComputeExtremeSingularValues KSPSetComputeEigenvalues KSPUnwindPreconditioner
KSPGetConvergenceContext KSPSetComputeResidual
Developer - Interfaces intended primarily for library developers, not for typical applications programmers
KSPAddOptionsChecker KSPGetSolution KSPSetSolution
KSPCreate KSPPrintHelp KSPSetTypeFromOptions
KSPDestroy KSPSetFromOptions KSPSetUp
KSPGetPC KSPSetPC KSPSolve
KSPGetRhs KSPSetRhs KSPView

Table of Contents