Krylov Methods - KSP: : Examples

The Scalable Linear Equations Solvers (KSP) 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. KSP users can set various Krylov subspace options at runtime via the options database (e.g., -ksp_type cg ). KSP users can also set KSP options directly in application by 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
KSP KSPGMRES KSPSolve
KSPBCGS KSPGetConvergedReason KSPType
KSPBCGSL KSPLGMRES KSPView
KSPBICG KSPLSQR KSP_CONVERGED_ATOL
KSPCG KSPMINRES KSP_CONVERGED_ITERATING
KSPCGNE KSPPREONLY KSP_CONVERGED_ITS
KSPCGS KSPRICHARDSON KSP_CONVERGED_RTOL
KSPCGType KSPRTCQMR KSP_DIVERGED_BREAKDOWN
KSPCHEBYCHEV KSPRTFQMR KSP_DIVERGED_BREAKDOWN_BICG
KSPCR KSPSYMMLQ KSP_DIVERGED_DTOL
KSPConvergedReason KSPSetFromOptions KSP_DIVERGED_INDEFINITE_PC
KSPCreate KSPSetInitialGuessNonzero KSP_DIVERGED_ITS
KSPDestroy KSPSetMonitor KSP_DIVERGED_NONSYMMETRIC
KSPFGMRES KSPSetOperators
Intermediate - Setting options for algorithms and data structures
KSPBCGSLSetEll KSPGMRESSetCGSRefinementType KSPGetType
KSPBCGSLSetPol KSPGMRESSetHapTol KSPLGMonitorCreate
KSPBCGSLSetXRes KSPGMRESSetOrthogonalization KSPLGMonitorDestroy
KSPCGSetType KSPGMRESSetPreAllocateVectors KSPLGTrueMonitorCreate
KSPChebychevSetEigenvalues KSPGMRESSetRestart KSPLGTrueMonitorDestroy
KSPClearMonitor KSPGetDiagonalScale KSPRichardsonSetScale
KSPDefaultConverged KSPGetDiagonalScaleFix KSPSetDiagonalScale
KSPDefaultMonitor KSPGetInitialGuessNonzero KSPSetDiagonalScaleFix
KSPFGMRESModifyPCKSP KSPGetIterationNumber KSPSetPreconditionerSide
KSPFGMRESModifyPCNoChange KSPGetMonitorContext KSPSetTolerances
KSPFGMRESSetModifyPC KSPGetOperators KSPSetType
KSPGMRESClassicalGramSchmidtOrthogonalization KSPGetPreconditionerSide KSPSingularValueMonitor
KSPGMRESKrylovMonitor KSPGetResidualNorm KSPTrueMonitor
KSPGMRESModifiedGramSchmidtOrthogonalization KSPGetTolerances KSPVecViewMonitor
Advanced - Setting more advanced options and customization
KSPAppendOptionsPrefix KSPGetVecs KSPSetNormType
KSPBuildResidual KSPNormType KSPSetNullSpace
KSPBuildSolution KSPQCGGetQuadratic KSPSetOptionsPrefix
KSPComputeEigenvalues KSPQCGGetTrialStepNorm KSPSetResidualHistory
KSPComputeEigenvaluesExplicitly KSPQCGSetTrustRegionRadius KSPSetUpOnBlocks
KSPComputeExplicitOperator KSPRegister KSPSkipConverged
KSPComputeExtremeSingularValues KSPRegisterAll KSPUnwindPreconditioner
KSPGMRESCGSRefinementType KSPRegisterDestroy KSP_GMRES_CGS_REFINE_IFNEEDED
KSPGetComputeEigenvalues KSPRegisterDynamic KSP_GMRES_CGS_REFINE_NEVER
KSPGetComputeSingularValues KSPSTCGGetQuadratic KSP_NATURAL_NORM
KSPGetConvergenceContext KSPSTCGSetRadius KSP_NO_NORM
KSPGetInitialGuessKnoll KSPSetComputeEigenvalues KSP_PRECONDITIONED_NORM
KSPGetNullSpace KSPSetComputeSingularValues KSP_UNPRECONDITIONED_NORM
KSPGetOptionsPrefix KSPSetConvergenceTest
KSPGetResidualHistory KSPSetInitialGuessKnoll
Developer - Interfaces intended primarily for library developers, not for typical applications programmers
KSPAddOptionsChecker KSPInitialResidual KSPSetPC
KSPGetPC KSPInitializePackage KSPSetUp
KSPGetRhs KSPQCG KSPSolveTranspose
KSPGetSolution KSPSTCG PCInitializePackage

Table of Contents