Linear Solvers and Krylov Methods (KSP)

The KSP class provides an easy-to-use interface to the combination of a Krylov subspace iterative method and a preconditioner PC.

Examples

Beginner - Basic usage

DMSwarmProjectFields KSP KSPBCGS KSPBICG KSPCG KSPCGLS KSPCGNE KSPCGS KSPCGType KSPCHEBYSHEV KSPCR KSPConvergedReason KSPConvergedReasonView KSPCreate KSPDGMRES KSPDestroy KSPFBCGS KSPFBCGSR KSPFCG KSPFGMRES KSPGCR

KSPGMRES KSPGetConvergedReasonString KSPIBCGS KSPLCD KSPLGMRES KSPLSQR KSPMINRES KSPMINRESGetUseQLP KSPMINRESSetRadius KSPMINRESSetUseQLP KSPMonitorSet KSPNONE KSPPGMRES KSPPREONLY KSPQMRCGS KSPRICHARDSON KSPReset 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

KSPAGMRES KSPAppendOptionsPrefix KSPBCGSL KSPBCGSLSetEll KSPBCGSLSetPol KSPBCGSLSetUsePseudoinverse KSPBCGSLSetXRes KSPCGSetType KSPCGUseSingleReduction KSPChebyshevEstEigSet KSPChebyshevEstEigSetUseNoisy KSPChebyshevGetKind KSPChebyshevKind KSPChebyshevSetEigenvalues KSPChebyshevSetKind 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 KSPGUESSFISCHER KSPGUESSPOD KSPGetApplicationContext KSPGetConvergedReason KSPGetDM KSPGetDiagonalScale KSPGetDiagonalScaleFix KSPGetErrorIfNotConverged KSPGetInitialGuessNonzero KSPGetIterationNumber

KSPGetMinimumIterations KSPGetMonitorContext KSPGetOperators KSPGetOperatorsSet KSPGetPCSide KSPGetResidualNorm KSPGetReusePreconditioner KSPGetTolerances KSPGetTotalIterations KSPGetType KSPGuess KSPGuessType KSPHPDDM KSPHPDDMGetDeflationMat KSPHPDDMGetType KSPHPDDMPrecision KSPHPDDMSetDeflationMat KSPHPDDMSetType KSPHPDDMType KSPLGMRESSetAugDim KSPLGMRESSetConstant KSPLSQRGetNorms KSPLSQRGetStandardErrorVec KSPLSQRMonitorResidual KSPLSQRMonitorResidualDrawLG KSPLSQRMonitorResidualDrawLGCreate KSPLSQRSetComputeStandardErrorVec KSPLSQRSetExactMatNorm KSPLoad KSPMatSolve KSPMatSolveTranspose 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 KSPPythonGetType KSPPythonSetType KSPRichardsonSetScale KSPRichardsonSetSelfScale KSPSetApplicationContext KSPSetDM KSPSetDMActive KSPSetDiagonalScaleFix KSPSetErrorIfNotConverged KSPSetMinimumIterations KSPSetOptionsPrefix KSPSetPCSide KSPSetReusePreconditioner KSPSetSkipPCSetFromOptions KSPSetTolerances KSPSetType KSPViewFromOptions MATSCHURCOMPLEMENT 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 DMKSPGetComputeRHS DMProjectField KSPBuildResidual KSPBuildResidualDefault KSPCGGetNormD KSPCGGetObjFcn KSPCGSetObjectiveTarget KSPCGSetRadius KSPChebyshevEstEigGetKSP KSPComputeConvergenceRate KSPComputeEigenvalues KSPComputeEigenvaluesExplicitly KSPComputeExtremeSingularValues KSPComputeOperator KSPComputeRitz KSPConvergedDefault KSPConvergedSkip KSPCreateVecs KSPFCGGetNprealloc KSPFCGSetNprealloc KSPFETIDP KSPFETIDPGetInnerBDDC KSPFETIDPGetInnerKSP KSPFETIDPSetInnerBDDC KSPFETIDPSetPressureOperator KSPGLTRGetLambda KSPGLTRGetMinEig KSPGMRESCGSRefinementType KSPGetAndClearConvergenceTest KSPGetComputeEigenvalues KSPGetComputeSingularValues KSPGetConvergedNegativeCurvature KSPGetConvergenceContext KSPGetConvergenceTest

KSPGetErrorHistory KSPGetInitialGuessKnoll KSPGetMatSolveBatchSize KSPGetNormType KSPGetOptionsPrefix KSPGetResidualHistory KSPGuessFischerSetModel KSPLSQRConvergedDefault KSPMatRegisterAll KSPMonitorDynamicTolerance KSPMonitorDynamicToleranceCreate KSPMonitorDynamicToleranceDestroy KSPMonitorDynamicToleranceSetCoefficient KSPMonitorRegister KSPMonitorRegisterAll KSPMonitorSAWs KSPNormType KSPPIPEFCGGetNprealloc KSPPIPEFCGSetNprealloc KSPPIPEGCRGetNprealloc KSPPIPEGCRSetNprealloc KSPPIPELCG KSPQCGGetQuadratic KSPQCGGetTrialStepNorm KSPQCGSetTrustRegionRadius KSPRegister KSPRegisterAll KSPResetFromOptions KSPSetCheckNormIteration KSPSetComputeEigenvalues KSPSetComputeRitz KSPSetComputeSingularValues KSPSetConvergedNegativeCurvature KSPSetConvergenceTest KSPSetDiagonalScale KSPSetErrorHistory

KSPSetGuess KSPSetInitialGuessKnoll KSPSetLagNorm KSPSetMatSolveBatchSize KSPSetNormType KSPSetResidualHistory KSPSetUpOnBlocks KSPSetUseExplicitTranspose KSPSetUseFischerGuess KSPTSIRM KSPUnwindPreconditioner KSP_GMRES_CGS_REFINE_ALWAYS 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 rarely needed by applications programmers

DMCopyDMKSP DMGetDMKSP DMGetDMKSPWrite DMKSPGetComputeOperators DMKSPSetComputeInitialGuess DMKSPSetComputeOperators DMKSPSetComputeRHS KSPBuildSolution KSPCheckDot KSPCheckNorm KSPCheckPCMPI KSPCheckSolve KSPFinalizePackage KSPGLTR KSPGetGuess KSPGetNestLevel KSPGetPC

KSPGetRhs KSPGetSolution KSPGuessCreate KSPGuessDestroy KSPGuessFormGuess KSPGuessGetType KSPGuessRegister KSPGuessRegisterAll KSPGuessSetFromOptions KSPGuessSetTolerance KSPGuessSetType KSPGuessSetUp KSPGuessUpdate KSPGuessView KSPInitialResidual KSPInitializePackage KSPMonitor

KSPMonitorSAWsCreate KSPMonitorSAWsDestroy KSPMonitorSetFromOptions KSPNASH KSPQCG KSPSTCG KSPSetNestLevel KSPSetPC KSPSetPostSolve KSPSetPreSolve KSPSetSupportedNorm KSPSetUp KSPSetWorkVecs KSPSolveTranspose MatSchurComplementSetKSP PCFinalizePackage PCInitializePackage

Single list of manual pages

DMCopyDMKSP DMGetDMKSP DMGetDMKSPWrite DMGlobalToLocalSolve DMKSPGetComputeInitialGuess DMKSPGetComputeOperators DMKSPGetComputeRHS DMKSPSetComputeInitialGuess DMKSPSetComputeOperators DMKSPSetComputeRHS DMProjectField DMSwarmProjectFields KSP KSPAGMRES KSPAppendOptionsPrefix KSPBCGS KSPBCGSL KSPBCGSLSetEll KSPBCGSLSetPol KSPBCGSLSetUsePseudoinverse KSPBCGSLSetXRes KSPBICG KSPBuildResidual KSPBuildResidualDefault KSPBuildSolution KSPCG KSPCGGetNormD KSPCGGetObjFcn KSPCGLS KSPCGNE KSPCGS KSPCGSetObjectiveTarget KSPCGSetRadius KSPCGSetType KSPCGType KSPCGUseSingleReduction KSPCHEBYSHEV KSPCR KSPChebyshevEstEigGetKSP KSPChebyshevEstEigSet KSPChebyshevEstEigSetUseNoisy KSPChebyshevGetKind KSPChebyshevKind KSPChebyshevSetEigenvalues KSPChebyshevSetKind KSPCheckDot KSPCheckNorm KSPCheckPCMPI KSPCheckSolve KSPComputeConvergenceRate KSPComputeEigenvalues KSPComputeEigenvaluesExplicitly KSPComputeExtremeSingularValues KSPComputeOperator KSPComputeRitz KSPConvergedDefault KSPConvergedDefaultCreate KSPConvergedDefaultDestroy KSPConvergedDefaultSetConvergedMaxits KSPConvergedDefaultSetUIRNorm KSPConvergedDefaultSetUMIRNorm KSPConvergedRateView KSPConvergedReason KSPConvergedReasonView KSPConvergedReasonViewCancel KSPConvergedReasonViewFromOptions KSPConvergedReasonViewSet KSPConvergedSkip KSPCreate KSPCreateVecs KSPDGMRES KSPDestroy KSPFBCGS KSPFBCGSR KSPFCDTruncationType KSPFCG KSPFCGGetMmax KSPFCGGetNprealloc KSPFCGGetTruncationType KSPFCGSetMmax KSPFCGSetNprealloc KSPFCGSetTruncationType KSPFETIDP KSPFETIDPGetInnerBDDC KSPFETIDPGetInnerKSP KSPFETIDPSetInnerBDDC KSPFETIDPSetPressureOperator KSPFGMRES KSPFGMRESModifyPCKSP KSPFGMRESModifyPCNoChange KSPFGMRESSetModifyPC KSPFinalizePackage KSPGCR KSPGCRGetRestart KSPGCRSetModifyPC KSPGCRSetRestart KSPGLTR KSPGLTRGetLambda KSPGLTRGetMinEig KSPGMRES KSPGMRESCGSRefinementType KSPGMRESClassicalGramSchmidtOrthogonalization KSPGMRESGetCGSRefinementType KSPGMRESGetOrthogonalization KSPGMRESGetRestart KSPGMRESModifiedGramSchmidtOrthogonalization KSPGMRESMonitorKrylov KSPGMRESSetBreakdownTolerance KSPGMRESSetCGSRefinementType KSPGMRESSetHapTol KSPGMRESSetOrthogonalization KSPGMRESSetPreAllocateVectors KSPGMRESSetRestart KSPGROPPCG KSPGUESSFISCHER KSPGUESSPOD KSPGetAndClearConvergenceTest KSPGetApplicationContext KSPGetComputeEigenvalues KSPGetComputeSingularValues KSPGetConvergedNegativeCurvature KSPGetConvergedReason KSPGetConvergedReasonString KSPGetConvergenceContext KSPGetConvergenceTest KSPGetDM KSPGetDiagonalScale KSPGetDiagonalScaleFix KSPGetErrorHistory KSPGetErrorIfNotConverged KSPGetGuess

KSPGetInitialGuessKnoll KSPGetInitialGuessNonzero KSPGetIterationNumber KSPGetMatSolveBatchSize KSPGetMinimumIterations KSPGetMonitorContext KSPGetNestLevel KSPGetNormType KSPGetOperators KSPGetOperatorsSet KSPGetOptionsPrefix KSPGetPC KSPGetPCSide KSPGetResidualHistory KSPGetResidualNorm KSPGetReusePreconditioner KSPGetRhs KSPGetSolution KSPGetTolerances KSPGetTotalIterations KSPGetType KSPGuess KSPGuessCreate KSPGuessDestroy KSPGuessFischerSetModel KSPGuessFormGuess KSPGuessGetType KSPGuessRegister KSPGuessRegisterAll KSPGuessSetFromOptions KSPGuessSetTolerance KSPGuessSetType KSPGuessSetUp KSPGuessType KSPGuessUpdate KSPGuessView KSPHPDDM KSPHPDDMGetDeflationMat KSPHPDDMGetType KSPHPDDMPrecision KSPHPDDMSetDeflationMat KSPHPDDMSetType KSPHPDDMType KSPIBCGS KSPInitialResidual KSPInitializePackage KSPLCD KSPLGMRES KSPLGMRESSetAugDim KSPLGMRESSetConstant KSPLSQR KSPLSQRConvergedDefault KSPLSQRGetNorms KSPLSQRGetStandardErrorVec KSPLSQRMonitorResidual KSPLSQRMonitorResidualDrawLG KSPLSQRMonitorResidualDrawLGCreate KSPLSQRSetComputeStandardErrorVec KSPLSQRSetExactMatNorm KSPLoad KSPMINRES KSPMINRESGetUseQLP KSPMINRESSetRadius KSPMINRESSetUseQLP KSPMatRegisterAll KSPMatSolve KSPMatSolveTranspose KSPMonitor KSPMonitorCancel KSPMonitorDynamicTolerance KSPMonitorDynamicToleranceCreate KSPMonitorDynamicToleranceDestroy KSPMonitorDynamicToleranceSetCoefficient KSPMonitorError KSPMonitorErrorDraw KSPMonitorErrorDrawLG KSPMonitorErrorDrawLGCreate KSPMonitorRegister KSPMonitorRegisterAll KSPMonitorResidual KSPMonitorResidualDraw KSPMonitorResidualDrawLG KSPMonitorResidualDrawLGCreate KSPMonitorResidualRange KSPMonitorSAWs KSPMonitorSAWsCreate KSPMonitorSAWsDestroy KSPMonitorSet KSPMonitorSetFromOptions KSPMonitorSingularValue KSPMonitorSingularValueCreate KSPMonitorSolution KSPMonitorSolutionDraw KSPMonitorSolutionDrawLG KSPMonitorSolutionDrawLGCreate KSPMonitorTrueResidual KSPMonitorTrueResidualDraw KSPMonitorTrueResidualDrawLG KSPMonitorTrueResidualDrawLGCreate KSPMonitorTrueResidualMax KSPNASH KSPNONE KSPNormType KSPPGMRES KSPPIPEBCGS KSPPIPECG KSPPIPECG2 KSPPIPECGRR KSPPIPECR KSPPIPEFCG KSPPIPEFCGGetMmax KSPPIPEFCGGetNprealloc KSPPIPEFCGGetTruncationType KSPPIPEFCGSetMmax KSPPIPEFCGSetNprealloc KSPPIPEFCGSetTruncationType KSPPIPEFGMRES KSPPIPEFGMRESSetShift KSPPIPEGCR KSPPIPEGCRGetMmax KSPPIPEGCRGetNprealloc KSPPIPEGCRGetTruncationType KSPPIPEGCRGetUnrollW KSPPIPEGCRSetMmax KSPPIPEGCRSetModifyPC KSPPIPEGCRSetNprealloc KSPPIPEGCRSetTruncationType KSPPIPEGCRSetUnrollW KSPPIPELCG KSPPIPEPRCG KSPPREONLY

KSPPythonGetType KSPPythonSetType KSPQCG KSPQCGGetQuadratic KSPQCGGetTrialStepNorm KSPQCGSetTrustRegionRadius KSPQMRCGS KSPRICHARDSON KSPRegister KSPRegisterAll KSPReset KSPResetFromOptions KSPResetViewers KSPRichardsonSetScale KSPRichardsonSetSelfScale KSPSTCG KSPSYMMLQ KSPSetApplicationContext KSPSetCheckNormIteration KSPSetComputeEigenvalues KSPSetComputeInitialGuess KSPSetComputeOperators KSPSetComputeRHS KSPSetComputeRitz KSPSetComputeSingularValues KSPSetConvergedNegativeCurvature KSPSetConvergenceTest KSPSetDM KSPSetDMActive KSPSetDiagonalScale KSPSetDiagonalScaleFix KSPSetErrorHistory KSPSetErrorIfNotConverged KSPSetFromOptions KSPSetGuess KSPSetInitialGuessKnoll KSPSetInitialGuessNonzero KSPSetLagNorm KSPSetMatSolveBatchSize KSPSetMinimumIterations KSPSetNestLevel KSPSetNormType KSPSetOperators KSPSetOptionsPrefix KSPSetPC KSPSetPCSide KSPSetPostSolve KSPSetPreSolve KSPSetResidualHistory KSPSetReusePreconditioner KSPSetSkipPCSetFromOptions KSPSetSupportedNorm KSPSetTolerances KSPSetType KSPSetUp KSPSetUpOnBlocks KSPSetUseExplicitTranspose KSPSetUseFischerGuess KSPSetWorkVecs KSPSolve KSPSolveTranspose KSPTCQMR KSPTFQMR KSPTSIRM KSPType KSPUnwindPreconditioner KSPView KSPViewFromOptions 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 KSP_GMRES_CGS_REFINE_ALWAYS KSP_GMRES_CGS_REFINE_IFNEEDED KSP_GMRES_CGS_REFINE_NEVER KSP_NORM_NATURAL KSP_NORM_NONE KSP_NORM_PRECONDITIONED KSP_NORM_UNPRECONDITIONED MATSCHURCOMPLEMENT MatCreateLMVMBFGS MatCreateLMVMBadBroyden MatCreateLMVMBroyden MatCreateLMVMDFP MatCreateLMVMDiagBroyden MatCreateLMVMSR1 MatCreateLMVMSymBadBroyden MatCreateLMVMSymBroyden MatCreateSchurComplement MatCreateSchurComplementPmat MatGetSchurComplement MatLMVMAllocate MatLMVMApplyJ0Fwd MatLMVMApplyJ0Inv MatLMVMClearJ0 MatLMVMGetJ0 MatLMVMGetJ0KSP MatLMVMGetJ0PC MatLMVMGetRejectCount MatLMVMGetUpdateCount MatLMVMIsAllocated MatLMVMReset MatLMVMResetShift MatLMVMSetHistorySize MatLMVMSetJ0 MatLMVMSetJ0Diag MatLMVMSetJ0KSP MatLMVMSetJ0PC MatLMVMSetJ0Scale MatLMVMSymBroydenSetDelta MatLMVMSymBroydenSetScaleType MatLMVMUpdate MatSchurComplementAinvType MatSchurComplementComputeExplicitOperator MatSchurComplementGetAinvType MatSchurComplementGetKSP MatSchurComplementGetPmat MatSchurComplementGetSubMatrices MatSchurComplementSetAinvType MatSchurComplementSetKSP MatSchurComplementSetSubMatrices MatSchurComplementUpdateSubMatrices PCFinalizePackage PCInitializePackage