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 KSPGMRESSetRestart KSPLGTrueMonitorCreate
KSPChebychevSetEigenvalues KSPGetConvergedReason KSPLGTrueMonitorDestroy
KSPClearMonitor KSPGetInitialGuessNonzero KSPResidual
KSPDefaultConverged KSPGetIterationNumber KSPRichardsonSetScale
KSPDefaultMonitor KSPGetMonitorContext KSPSetPreconditionerSide
KSPFGMRESModifyPCNoChange KSPGetPreconditionerSide KSPSetTolerances
KSPFGMRESModifyPCSLES KSPGetResidualNorm KSPSetType
KSPFGMRESSetModifyPC KSPGetTolerances KSPSingularValueMonitor
KSPGMRESKrylovMonitor KSPGetType KSPTrueMonitor
KSPGMRESSetOrthogonalization KSPLGMonitorCreate KSPVecViewMonitor
KSPGMRESSetPreAllocateVectors KSPLGMonitorDestroy
Advanced - Setting more advanced options and customization
KSPAppendOptionsPrefix KSPGetOptionsPrefix KSPSetComputeSingularValues
KSPBuildResidual KSPGetResidualHistory KSPSetConvergenceTest
KSPBuildSolution KSPRegisterAll KSPSetOptionsPrefix
KSPComputeEigenvalues KSPRegisterDestroy KSPSetResidualHistory
KSPComputeEigenvaluesExplicitly KSPRegisterDynamic KSPSetUsePreconditionedResidual
KSPComputeExplicitOperator KSPSetAvoidNorms KSPSkipConverged
KSPComputeExtremeSingularValues KSPSetComputeEigenvalues KSPUnwindPreconditioner
KSPGetConvergenceContext KSPSetComputeResidual
Developer - Interfaces intended primarily for library developers, not for typical applications programmers
KSPAddOptionsChecker KSPPrintHelp KSPSetUp
KSPCreate KSPSetFromOptions KSPSolve
KSPDestroy KSPSetPC KSPSolveTranspose
KSPGetPC KSPSetRhs KSPView
KSPGetRhs KSPSetSolution
KSPGetSolution KSPSetTypeFromOptions

Table of Contents