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
KSPBCGS KSPCR KSPLSQR
KSPBCGSL KSPDestroy KSPMINRES
KSPBICG KSP_DIVERGED_BREAKDOWN_BICG KSPMonitorSet
KSPCG KSP_DIVERGED_BREAKDOWN KSPPREONLY
KSPCGNE KSP_DIVERGED_DTOL KSPRICHARDSON
KSPCGS KSP_DIVERGED_INDEFINITE_PC KSPRTCQMR
KSPCGType KSP_DIVERGED_ITS KSPRTFQMR
KSPCHEBYCHEV KSP_DIVERGED_NONSYMMETRIC KSPSetFromOptions
KSP_CONVERGED_ATOL KSPFGMRES KSPSetInitialGuessNonzero
KSP_CONVERGED_ITERATING KSPGMRES KSPSetOperators
KSP_CONVERGED_ITS KSP KSPSolve
KSPConvergedReason KSPIBCGS KSPSYMMLQ
KSP_CONVERGED_RTOL KSPLCD KSPType
KSPCreate KSPLGMRES KSPView
Intermediate - Setting options for algorithms and data structures
KSPBCGSLSetEll KSPGetOperators KSPMonitorLGRangeDestroy
KSPBCGSLSetPol KSPGetOperatorsSet KSPMonitorLGTrueResidualNormCreate
KSPBCGSLSetXRes KSPGetPreconditionerSide KSPMonitorLGTrueResidualNormDestroy
KSPCGSetType KSPGetResidualNorm KSPMonitorRange
KSPChebychevSetEigenvalues KSPGetTolerances KSPMonitorSingularValue
KSPDefaultConvergedCreate KSPGetType KSPMonitorSolution
KSPDefaultConvergedDestroy KSPGMRESClassicalGramSchmidtOrthogonalization KSPMonitorTrueResidualNorm
KSPDefaultConverged KSPGMRESModifiedGramSchmidtOrthogonalization KSPPythonSetType
KSPDefaultConvergedSetUIRNorm KSPGMRESMonitorKrylov KSPRichardsonSetScale
KSPDefaultConvergedSetUMIRNorm KSPGMRESSetCGSRefinementType KSPSetDiagonalScaleFix
KSPFGMRESModifyPCKSP KSPGMRESSetHapTol KSPSetDiagonalScale
KSPFGMRESModifyPCNoChange KSPGMRESSetOrthogonalization KSPSetPreconditionerSide
KSPFGMRESSetModifyPC KSPGMRESSetPreAllocateVectors KSPSetTolerances
KSPGetConvergedReason KSPGMRESSetRestart KSPSetType
KSPGetDiagonalScaleFix KSPMonitorCancel MatCreateSchurComplement
KSPGetDiagonalScale KSPMonitorDefault MatSchurComplementGetKSP
KSPGetInitialGuessNonzero KSPMonitorLGCreate MatSchurComplementGetSubmatrices
KSPGetIterationNumber KSPMonitorLGDestroy MatSchurComplementUpdate
KSPGetMonitorContext KSPMonitorLGRangeCreate
Advanced - Setting more advanced options and customization
KSPAppendOptionsPrefix KSPGLTRGetObjFcn KSPSetCheckNormIteration
KSPBuildResidual KSPGLTRSetRadius KSPSetComputeEigenvalues
KSPBuildSolution KSP_GMRES_CGS_REFINE_IFNEEDED KSPSetComputeSingularValues
KSPComputeEigenvaluesExplicitly KSPGMRESCGSRefinementType KSPSetConvergenceTest
KSPComputeEigenvalues KSP_GMRES_CGS_REFINE_NEVER KSPSetFischerGuess
KSPComputeExplicitOperator KSPNASHGetNormD KSPSetInitialGuessKnoll
KSPComputeExtremeSingularValues KSPNASHGetObjFcn KSPSetLagNorm
KSPFischerGuessCreate KSPNASHSetRadius KSPSetNormType
KSPGetComputeEigenvalues KSP_NORM_NATURAL KSPSetNullSpace
KSPGetComputeSingularValues KSP_NORM_NO KSPSetOptionsPrefix
KSPGetConvergenceContext KSP_NORM_PRECONDITIONED KSPSetResidualHistory
KSPGetInitialGuessKnoll KSPNormType KSPSetUpOnBlocks
KSPGetNormType KSP_NORM_UNPRECONDITIONED KSPSetUseFischerGuess
KSPGetNullSpace KSPQCGGetQuadratic KSPSkipConverged
KSPGetOptionsPrefix KSPQCGGetTrialStepNorm KSPSTCGGetNormD
KSPGetResidualHistory KSPQCGSetTrustRegionRadius KSPSTCGGetObjFcn
KSPGetVecs KSPRegisterAll KSPSTCGSetRadius
KSPGLTRGetLambda KSPRegisterDestroy KSPUnwindPreconditioner
KSPGLTRGetMinEig KSPRegisterDynamic
KSPGLTRGetNormD KSPRegister
Developer - Interfaces intended primarily for library developers, not for typical applications programmers
KSPAddOptionsChecker KSPGLTR KSPSetPC
KSPGetFischerGuess KSPInitializePackage KSPSetUp
KSPGetPC KSPInitialResidual KSPSolveTranspose
KSPGetRhs KSPNASH KSPSTCG
KSPGetSolution KSPQCG PCInitializePackage
No deprecated routines

Table of Contents