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

Table of Contents