Krylov Methods - KSP Manual Pages#
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
- KSPAGMRES
- KSPBCGS
- KSPBCGSL
- KSPBICG
- KSPCG
- KSPCGLS
- KSPCGNE
- KSPCGS
- KSPCGType
- KSPCHEBYSHEV
- KSPCR
- KSPConvergedReason
- KSPConvergedReasonView
- KSPCreate
- KSPDGMRES
- KSPDestroy
- KSPFBCGS
- KSPFBCGSR
- KSPFCG
- KSPFGMRES
- KSPGCR
- KSPGMRES
- KSPGetConvergedReasonString
- KSPGuess
- KSPGuessCreate
- KSPGuessDestroy
- KSPGuessType
- KSPIBCGS
- KSPLCD
- KSPLGMRES
- KSPLSQR
- KSPMINRES
- KSPMonitorSet
- KSPPGMRES
- KSPPREONLY
- KSPQMRCGS
- KSPRICHARDSON
- KSPReset
- KSPResetFromOptions
- KSPResetViewers
- KSPSYMMLQ
- KSPSetComputeInitialGuess
- KSPSetComputeOperators
- KSPSetComputeRHS
- KSPSetFromOptions
- KSPSetInitialGuessNonzero
- KSPSetOperators
- KSPSolve
- KSPTCQMR
- KSPTFQMR
- KSPType
- KSPView
- KSP_CONVERGED_ATOL
- KSP_CONVERGED_ITERATING
- KSP_CONVERGED_ITS
- KSP_CONVERGED_RTOL
- KSP_DIVERGED_BREAKDOWN
- KSP_DIVERGED_BREAKDOWN_BICG
- KSP_DIVERGED_DTOL
- KSP_DIVERGED_INDEFINITE_PC
- KSP_DIVERGED_ITS
- KSP_DIVERGED_NONSYMMETRIC
- KSP_DIVERGED_PC_FAILED
- MatLMVMSetHistorySize
Intermediate - Setting options for algorithms and data structures#
- DMProjectField
- KSPBCGSLSetEll
- KSPBCGSLSetPol
- KSPBCGSLSetUsePseudoinverse
- KSPBCGSLSetXRes
- KSPCGSetType
- KSPCGUseSingleReduction
- KSPChebyshevEstEigGetKSP
- KSPChebyshevEstEigSet
- KSPChebyshevEstEigSetUseNoisy
- KSPChebyshevSetEigenvalues
- KSPConvergedDefault
- KSPConvergedDefaultCreate
- KSPConvergedDefaultDestroy
- KSPConvergedDefaultSetConvergedMaxits
- KSPConvergedDefaultSetUIRNorm
- KSPConvergedDefaultSetUMIRNorm
- KSPConvergedRateView
- KSPConvergedReasonViewCancel
- KSPConvergedReasonViewFromOptions
- KSPConvergedReasonViewSet
- KSPFCDTruncationType
- KSPFCGGetMmax
- KSPFCGGetTruncationType
- KSPFCGSetMmax
- KSPFCGSetTruncationType
- KSPFGMRESModifyPCKSP
- KSPFGMRESModifyPCNoChange
- KSPFGMRESSetModifyPC
- KSPGCRGetRestart
- KSPGCRSetModifyPC
- KSPGCRSetRestart
- KSPGMRESClassicalGramSchmidtOrthogonalization
- KSPGMRESGetCGSRefinementType
- KSPGMRESGetOrthogonalization
- KSPGMRESGetRestart
- KSPGMRESModifiedGramSchmidtOrthogonalization
- KSPGMRESMonitorKrylov
- KSPGMRESSetBreakdownTolerance
- KSPGMRESSetCGSRefinementType
- KSPGMRESSetHapTol
- KSPGMRESSetOrthogonalization
- KSPGMRESSetPreAllocateVectors
- KSPGMRESSetRestart
- KSPGROPPCG
- KSPGetApplicationContext
- KSPGetConvergedReason
- KSPGetDM
- KSPGetDiagonalScale
- KSPGetDiagonalScaleFix
- KSPGetErrorIfNotConverged
- KSPGetInitialGuessNonzero
- KSPGetIterationNumber
- KSPGetMonitorContext
- KSPGetOperators
- KSPGetOperatorsSet
- KSPGetPCSide
- KSPGetResidualNorm
- KSPGetReusePreconditioner
- KSPGetTolerances
- KSPGetTotalIterations
- KSPGetType
- KSPGuessFormGuess
- KSPGuessGetType
- KSPGuessSetFromOptions
- KSPGuessSetTolerance
- KSPGuessSetType
- KSPGuessSetUp
- KSPGuessUpdate
- KSPGuessView
- KSPHPDDM
- KSPHPDDMGetDeflationMat
- KSPHPDDMGetType
- KSPHPDDMPrecision
- KSPHPDDMSetDeflationMat
- KSPHPDDMSetType
- KSPHPDDMType
- KSPLSQRConvergedDefault
- KSPLSQRGetNorms
- KSPLSQRGetStandardErrorVec
- KSPLSQRMonitorResidual
- KSPLSQRMonitorResidualDrawLG
- KSPLSQRMonitorResidualDrawLGCreate
- KSPLSQRSetComputeStandardErrorVec
- KSPLSQRSetExactMatNorm
- KSPLoad
- KSPMatSolve
- KSPMonitorCancel
- KSPMonitorError
- KSPMonitorErrorDraw
- KSPMonitorErrorDrawLG
- KSPMonitorErrorDrawLGCreate
- KSPMonitorResidual
- KSPMonitorResidualDraw
- KSPMonitorResidualDrawLG
- KSPMonitorResidualDrawLGCreate
- KSPMonitorResidualRange
- KSPMonitorSingularValue
- KSPMonitorSingularValueCreate
- KSPMonitorSolution
- KSPMonitorSolutionDraw
- KSPMonitorSolutionDrawLG
- KSPMonitorSolutionDrawLGCreate
- KSPMonitorTrueResidual
- KSPMonitorTrueResidualDraw
- KSPMonitorTrueResidualDrawLG
- KSPMonitorTrueResidualDrawLGCreate
- KSPMonitorTrueResidualMax
- KSPPIPEBCGS
- KSPPIPECG
- KSPPIPECG2
- KSPPIPECGRR
- KSPPIPECR
- KSPPIPEFCG
- KSPPIPEFCGGetMmax
- KSPPIPEFCGGetTruncationType
- KSPPIPEFCGSetMmax
- KSPPIPEFCGSetTruncationType
- KSPPIPEFGMRES
- KSPPIPEFGMRESSetShift
- KSPPIPEGCR
- KSPPIPEGCRGetMmax
- KSPPIPEGCRGetTruncationType
- KSPPIPEGCRGetUnrollW
- KSPPIPEGCRSetMmax
- KSPPIPEGCRSetModifyPC
- KSPPIPEGCRSetTruncationType
- KSPPIPEGCRSetUnrollW
- KSPPIPEPRCG
- KSPPythonSetType
- KSPRichardsonSetScale
- KSPRichardsonSetSelfScale
- KSPSetApplicationContext
- KSPSetDM
- KSPSetDMActive
- KSPSetDiagonalScale
- KSPSetDiagonalScaleFix
- KSPSetErrorIfNotConverged
- KSPSetPCSide
- KSPSetReusePreconditioner
- KSPSetSkipPCSetFromOptions
- KSPSetTolerances
- KSPSetType
- KSPViewFromOptions
- MatCreateLMVMBFGS
- MatCreateLMVMBadBroyden
- MatCreateLMVMBroyden
- MatCreateLMVMDFP
- MatCreateLMVMDiagBroyden
- MatCreateLMVMSR1
- MatCreateLMVMSymBadBroyden
- MatCreateLMVMSymBroyden
- MatCreateSchurComplement
- MatLMVMAllocate
- MatLMVMGetRejectCount
- MatLMVMGetUpdateCount
- MatLMVMIsAllocated
- MatLMVMReset
- MatLMVMResetShift
- MatLMVMSymBroydenSetDelta
- MatLMVMSymBroydenSetScaleType
- MatLMVMUpdate
- MatSchurComplementAinvType
- MatSchurComplementGetKSP
- MatSchurComplementGetSubMatrices
- MatSchurComplementSetSubMatrices
- MatSchurComplementUpdateSubMatrices
Advanced - Setting more advanced options and customization#
- DMGlobalToLocalSolve
- DMKSPGetComputeInitialGuess
- DMKSPGetComputeOperators
- DMKSPGetComputeRHS
- DMKSPSetComputeInitialGuess
- DMKSPSetComputeOperators
- DMKSPSetComputeRHS
- KSPAppendOptionsPrefix
- KSPBuildResidual
- KSPBuildSolution
- KSPCGGetNormD
- KSPCGGetObjFcn
- KSPCGSetRadius
- KSPComputeEigenvalues
- KSPComputeEigenvaluesExplicitly
- KSPComputeExtremeSingularValues
- KSPComputeOperator
- KSPComputeRitz
- KSPConvergedSkip
- KSPCreateVecs
- KSPFCGGetNprealloc
- KSPFCGSetNprealloc
- KSPFETIDP
- KSPFETIDPGetInnerBDDC
- KSPFETIDPGetInnerKSP
- KSPFETIDPSetInnerBDDC
- KSPFETIDPSetPressureOperator
- KSPGLTRGetLambda
- KSPGLTRGetMinEig
- KSPGMRESCGSRefinementType
- KSPGetAndClearConvergenceTest
- KSPGetComputeEigenvalues
- KSPGetComputeSingularValues
- KSPGetConvergenceContext
- KSPGetConvergenceTest
- KSPGetErrorHistory
- KSPGetInitialGuessKnoll
- KSPGetMatSolveBatchSize
- KSPGetNormType
- KSPGetOptionsPrefix
- KSPGetResidualHistory
- KSPGuessFischerSetModel
- KSPMatRegisterAll
- KSPMonitoRegisterAll
- KSPMonitorDynamicTolerance
- KSPMonitorRegister
- KSPMonitorSAWs
- KSPNormType
- KSPPIPEFCGGetNprealloc
- KSPPIPEFCGSetNprealloc
- KSPPIPEGCRGetNprealloc
- KSPPIPEGCRSetNprealloc
- KSPPIPELCG
- KSPQCGGetQuadratic
- KSPQCGGetTrialStepNorm
- KSPQCGSetTrustRegionRadius
- KSPRegister
- KSPRegisterAll
- KSPSetCheckNormIteration
- KSPSetComputeEigenvalues
- KSPSetComputeRitz
- KSPSetComputeSingularValues
- KSPSetConvergenceTest
- KSPSetErrorHistory
- KSPSetGuess
- KSPSetInitialGuessKnoll
- KSPSetLagNorm
- KSPSetMatSolveBatchSize
- KSPSetNormType
- KSPSetOptionsPrefix
- KSPSetResidualHistory
- KSPSetUpOnBlocks
- KSPSetUseExplicitTranspose
- KSPSetUseFischerGuess
- KSPTSIRM
- KSPUnwindPreconditioner
- KSP_GMRES_CGS_REFINE_IFNEEDED
- KSP_GMRES_CGS_REFINE_NEVER
- KSP_NORM_NATURAL
- KSP_NORM_NONE
- KSP_NORM_PRECONDITIONED
- KSP_NORM_UNPRECONDITIONED
- MatCreateSchurComplementPmat
- MatGetSchurComplement
- MatLMVMApplyJ0Fwd
- MatLMVMApplyJ0Inv
- MatLMVMClearJ0
- MatLMVMGetJ0
- MatLMVMGetJ0KSP
- MatLMVMGetJ0PC
- MatLMVMSetJ0
- MatLMVMSetJ0Diag
- MatLMVMSetJ0KSP
- MatLMVMSetJ0PC
- MatLMVMSetJ0Scale
- MatSchurComplementComputeExplicitOperator
- MatSchurComplementGetAinvType
- MatSchurComplementGetPmat
- MatSchurComplementSetAinvType
Developer - Interfaces intended primarily for library developers, not for typical applications programmers#
- DMCopyDMKSP
- DMGetDMKSP
- DMGetDMKSPWrite
- DMKSPCopy
- KSPCheckDot
- KSPCheckNorm
- KSPCheckSolve
- KSPFinalizePackage
- KSPGLTR
- KSPGetGuess
- KSPGetPC
- KSPGetRhs
- KSPGetSolution
- KSPInitialResidual
- KSPInitializePackage
- KSPMonitor
- KSPMonitorSAWsCreate
- KSPMonitorSAWsDestroy
- KSPMonitorSetFromOptions
- KSPNASH
- KSPQCG
- KSPSTCG
- KSPSetPC
- KSPSetPostSolve
- KSPSetPreSolve
- KSPSetSupportedNorm
- KSPSetUp
- KSPSetWorkVecs
- KSPSolveTranspose
- MatSchurComplementSetKSP
- PCFinalizePackage
- PCInitializePackage