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 KSPGCR KSPSetOperators
KSPBCGS KSPGMRES KSPSolve
KSPBCGSL KSPIBCGS KSPType
KSPBICG KSPLCD KSPView
KSPBROYDEN KSPLGMRES KSP_CONVERGED_ATOL
KSPCG KSPLSQR KSP_CONVERGED_ITERATING
KSPCGNE KSPMINRES KSP_CONVERGED_ITS
KSPCGS KSPMonitorSet KSP_CONVERGED_RTOL
KSPCGType KSPPREONLY KSP_DIVERGED_BREAKDOWN
KSPCHEBYCHEV KSPRICHARDSON KSP_DIVERGED_BREAKDOWN_BICG
KSPCR KSPRTCQMR KSP_DIVERGED_DTOL
KSPConvergedReason KSPRTFQMR KSP_DIVERGED_INDEFINITE_PC
KSPCreate KSPSYMMLQ KSP_DIVERGED_ITS
KSPDestroy KSPSetFromOptions KSP_DIVERGED_NONSYMMETRIC
KSPFGMRES KSPSetInitialGuessNonzero
Intermediate - Setting options for algorithms and data structures
KSPBCGSLSetEll KSPGMRESSetOrthogonalization KSPMonitorLGRangeDestroy
KSPBCGSLSetPol KSPGMRESSetPreAllocateVectors KSPMonitorLGTrueResidualNormCreate
KSPBCGSLSetXRes KSPGMRESSetRestart KSPMonitorLGTrueResidualNormDestroy
KSPCGSetType KSPGetConvergedReason KSPMonitorRange
KSPCGUseSingleReduction KSPGetDiagonalScale KSPMonitorSingularValue
KSPChebychevSetEigenvalues KSPGetDiagonalScaleFix KSPMonitorSolution
KSPDefaultConverged KSPGetInitialGuessNonzero KSPMonitorTrueResidualNorm
KSPDefaultConvergedCreate KSPGetIterationNumber KSPPythonSetType
KSPDefaultConvergedDestroy KSPGetMonitorContext KSPRichardsonSetScale
KSPDefaultConvergedSetUIRNorm KSPGetOperators KSPSetDiagonalScale
KSPDefaultConvergedSetUMIRNorm KSPGetOperatorsSet KSPSetDiagonalScaleFix
KSPFGMRESModifyPCKSP KSPGetPreconditionerSide KSPSetPreconditionerSide
KSPFGMRESModifyPCNoChange KSPGetResidualNorm KSPSetTolerances
KSPFGMRESSetModifyPC KSPGetTolerances KSPSetType
KSPGCRSetModifyPC KSPGetType MatCreateSchurComplement
KSPGMRESClassicalGramSchmidtOrthogonalization KSPMonitorCancel MatSchurComplementGetKSP
KSPGMRESModifiedGramSchmidtOrthogonalization KSPMonitorDefault MatSchurComplementGetSubmatrices
KSPGMRESMonitorKrylov KSPMonitorLGCreate MatSchurComplementUpdate
KSPGMRESSetCGSRefinementType KSPMonitorLGDestroy
KSPGMRESSetHapTol 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 MatGetSchurComplement
KSPGetNullSpace KSPSetComputeSingularValues
Developer - Interfaces intended primarily for library developers, not for typical applications programmers
KSPAddOptionsChecker KSPGetSolution KSPSetPC
KSPFinalizePackage KSPInitialResidual KSPSetUp
KSPGLTR KSPInitializePackage KSPSolveTranspose
KSPGetFischerGuess KSPNASH PCFinalizePackage
KSPGetPC KSPQCG PCInitializePackage
KSPGetRhs KSPSTCG
No deprecated routines

Table of Contents