petsc-master 2018-08-17
Report Typos and Errors

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 KSPSetComputeRHS
KSPAGMRES KSPGMRES KSPSetFromOptions
KSPBCGS KSPGuess KSPSetInitialGuessNonzero
KSPBCGSL KSPGuessCreate KSPSetOperators
KSPBICG KSPGuessSetFromOptions KSPSolve
KSPCG KSPGuessType KSPTCQMR
KSPCGLS KSPIBCGS KSPTFQMR
KSPCGNE KSPLCD KSPType
KSPCGS KSPLGMRES KSPView
KSPCGType KSPLSQR KSP_CONVERGED_ATOL
KSPCHEBYSHEV KSPMINRES KSP_CONVERGED_ITERATING
KSPCR KSPMonitorSet KSP_CONVERGED_ITS
KSPConvergedReason KSPPGMRES KSP_CONVERGED_RTOL
KSPCreate KSPPREONLY KSP_DIVERGED_BREAKDOWN
KSPDGMRES KSPRICHARDSON KSP_DIVERGED_BREAKDOWN_BICG
KSPDestroy KSPReasonView KSP_DIVERGED_DTOL
KSPFBCGS KSPReset KSP_DIVERGED_INDEFINITE_PC
KSPFBCGSR KSPSYMMLQ KSP_DIVERGED_ITS
KSPFCG KSPSetComputeInitialGuess KSP_DIVERGED_NONSYMMETRIC
KSPFGMRES KSPSetComputeOperators KSP_DIVERGED_PCSETUP_FAILED
Intermediate - Setting options for algorithms and data structures
KSPBCGSLSetEll KSPGetIterationNumber KSPPIPEGCRGetMmax
KSPBCGSLSetPol KSPGetMonitorContext KSPPIPEGCRGetTruncationType
KSPBCGSLSetUsePseudoinverse KSPGetOperators KSPPIPEGCRGetUnrollW
KSPBCGSLSetXRes KSPGetOperatorsSet KSPPIPEGCRSetMmax
KSPCGSetType KSPGetPCSide KSPPIPEGCRSetModifyPC
KSPCGUseSingleReduction KSPGetResidualNorm KSPPIPEGCRSetTruncationType
KSPChebyshevEstEigGetKSP KSPGetTolerances KSPPIPEGCRSetUnrollW
KSPChebyshevEstEigSet KSPGetTotalIterations KSPPythonSetType
KSPChebyshevEstEigSetUseNoisy KSPGetType KSPReasonViewFromOptions
KSPChebyshevSetEigenvalues KSPGuessFormGuess KSPRichardsonSetScale
KSPConvergedDefault KSPGuessGetType KSPRichardsonSetSelfScale
KSPConvergedDefaultCreate KSPGuessSetType KSPSetApplicationContext
KSPConvergedDefaultDestroy KSPGuessSetUp KSPSetDM
KSPConvergedDefaultSetUIRNorm KSPGuessUpdate KSPSetDMActive
KSPConvergedDefaultSetUMIRNorm KSPGuessView KSPSetDiagonalScale
KSPFCDTruncationType KSPLSQRConvergedDefault KSPSetDiagonalScaleFix
KSPFCGGetMmax KSPLSQRGetNorms KSPSetErrorIfNotConverged
KSPFCGGetTruncationType KSPLSQRGetStandardErrorVec KSPSetPCSide
KSPFCGSetMmax KSPLSQRMonitorDefault KSPSetReusePreconditioner
KSPFCGSetTruncationType KSPLSQRSetComputeStandardErrorVec KSPSetSkipPCSetFromOptions
KSPFGMRESModifyPCKSP KSPLSQRSetExactMatNorm KSPSetTolerances
KSPFGMRESModifyPCNoChange KSPLoad KSPSetType
KSPFGMRESSetModifyPC KSPMonitorCancel MatCreateLMVMBFGS
KSPGCRSetModifyPC KSPMonitorDefault MatCreateLMVMBadBrdn
KSPGMRESClassicalGramSchmidtOrthogonalization KSPMonitorLGResidualNormCreate MatCreateLMVMBrdn
KSPGMRESGetCGSRefinementType KSPMonitorLGTrueResidualNormCreate MatCreateLMVMDFP
KSPGMRESGetOrthogonalization KSPMonitorRange MatCreateLMVMSR1
KSPGMRESGetRestart KSPMonitorSingularValue MatCreateLMVMSymBrdn
KSPGMRESModifiedGramSchmidtOrthogonalization KSPMonitorSolution MatCreateSchurComplement
KSPGMRESMonitorKrylov KSPMonitorTrueResidualMaxNorm MatLMVMAllocate
KSPGMRESSetCGSRefinementType KSPMonitorTrueResidualNorm MatLMVMGetRejectCount
KSPGMRESSetHapTol KSPPIPEBCGS MatLMVMGetUpdateCount
KSPGMRESSetOrthogonalization KSPPIPECG MatLMVMIsAllocated
KSPGMRESSetPreAllocateVectors KSPPIPECGRR MatLMVMReset
KSPGMRESSetRestart KSPPIPECR MatLMVMResetShift
KSPGROPPCG KSPPIPEFCG MatLMVMUpdate
KSPGetApplicationContext KSPPIPEFCGGetMmax MatSchurComplementAinvType
KSPGetConvergedReason KSPPIPEFCGGetTruncationType MatSchurComplementGetKSP
KSPGetDM KSPPIPEFCGSetMmax MatSchurComplementGetSubMatrices
KSPGetDiagonalScale KSPPIPEFCGSetTruncationType MatSchurComplementSetSubMatrices
KSPGetDiagonalScaleFix KSPPIPEFGMRES MatSchurComplementUpdateSubMatrices
KSPGetErrorIfNotConverged KSPPIPEFGMRESSetShift
KSPGetInitialGuessNonzero KSPPIPEGCR
Advanced - Setting more advanced options and customization
DMGlobalToLocalSolve KSPGetComputeEigenvalues KSPSetOptionsPrefix
DMKSPGetComputeInitialGuess KSPGetComputeSingularValues KSPSetResidualHistory
DMKSPGetComputeOperators KSPGetConvergenceContext KSPSetUpOnBlocks
DMKSPGetComputeRHS KSPGetInitialGuessKnoll KSPSetUseFischerGuess
DMKSPSetComputeInitialGuess KSPGetNormType KSPTSIRM
DMKSPSetComputeOperators KSPGetOptionsPrefix KSPUnwindPreconditioner
DMKSPSetComputeRHS KSPGetResidualHistory KSP_GMRES_CGS_REFINE_IFNEEDED
KSPAppendOptionsPrefix KSPGuessFischerSetModel KSP_GMRES_CGS_REFINE_NEVER
KSPBuildResidual KSPMatRegisterAll KSP_NORM_NATURAL
KSPBuildSolution KSPMonitorDynamicTolerance KSP_NORM_NONE
KSPCGGLTRGetLambda KSPMonitorSAWs KSP_NORM_PRECONDITIONED
KSPCGGLTRGetMinEig KSPNormType KSP_NORM_UNPRECONDITIONED
KSPCGGetNormD KSPPIPEFCGGetNprealloc MatCreateSchurComplementPmat
KSPCGGetObjFcn KSPPIPEFCGSetNprealloc MatGetSchurComplement
KSPCGSetRadius KSPPIPEGCRGetNprealloc MatLMVMApplyJ0Fwd
KSPComputeEigenvalues KSPPIPEGCRSetNprealloc MatLMVMApplyJ0Inv
KSPComputeEigenvaluesExplicitly KSPQCGGetQuadratic MatLMVMClearJ0
KSPComputeExplicitOperator KSPQCGGetTrialStepNorm MatLMVMGetJ0
KSPComputeExtremeSingularValues KSPQCGSetTrustRegionRadius MatLMVMGetJ0KSP
KSPComputeRitz KSPRegister MatLMVMGetJ0PC
KSPConvergedSkip KSPRegisterAll MatLMVMSetJ0
KSPCreateVecs KSPSetCheckNormIteration MatLMVMSetJ0Diag
KSPFCGGetNprealloc KSPSetComputeEigenvalues MatLMVMSetJ0KSP
KSPFCGSetNprealloc KSPSetComputeRitz MatLMVMSetJ0PC
KSPFETIDP KSPSetComputeSingularValues MatLMVMSetJ0Scale
KSPFETIDPGetInnerBDDC KSPSetConvergenceTest MatSchurComplementComputeExplicitOperator
KSPFETIDPGetInnerKSP KSPSetGuess MatSchurComplementGetAinvType
KSPFETIDPSetInnerBDDC KSPSetInitialGuessKnoll MatSchurComplementGetPmat
KSPFETIDPSetPressureOperator KSPSetLagNorm MatSchurComplementSetAinvType
KSPGMRESCGSRefinementType KSPSetNormType
Developer - Interfaces intended primarily for library developers, not for typical applications programmers
DMCopyDMKSP KSPGetRhs KSPSetPostSolve
DMGetDMKSP KSPGetSolution KSPSetPreSolve
DMGetDMKSPWrite KSPGetTabLevel KSPSetSupportedNorm
DMKSPCopy KSPInitialResidual KSPSetTabLevel
DMProjectField KSPInitializePackage KSPSetUp
KSPCGGLTR KSPMonitor KSPSetWorkVecs
KSPCGNASH KSPMonitorSAWsCreate KSPSolveTranspose
KSPCGSTCG KSPMonitorSAWsDestroy MatSchurComplementSetKSP
KSPFinalizePackage KSPMonitorSetFromOptions PCFinalizePackage
KSPGetGuess KSPQCG PCInitializePackage
KSPGetPC KSPSetPC
No deprecated routines
None: Not yet cataloged
KSPPIPELCG MatSymBrdnSetDelta

Table of Contents