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

Table of Contents