petsc-master 2017-05-25
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 KSPFGMRES KSPSetInitialGuessNonzero
KSPAGMRES KSPGCR KSPSetOperators
KSPBCGS KSPGMRES KSPSolve
KSPBCGSL KSPIBCGS KSPTCQMR
KSPBICG KSPLCD KSPTFQMR
KSPCG KSPLGMRES KSPType
KSPCGLS KSPLSQR KSPView
KSPCGNE KSPMINRES KSP_CONVERGED_ATOL
KSPCGS KSPMonitorSet KSP_CONVERGED_ITERATING
KSPCGType KSPPGMRES KSP_CONVERGED_ITS
KSPCHEBYSHEV KSPPREONLY KSP_CONVERGED_RTOL
KSPCR KSPRICHARDSON KSP_DIVERGED_BREAKDOWN
KSPConvergedReason KSPReasonView KSP_DIVERGED_BREAKDOWN_BICG
KSPCreate KSPReset KSP_DIVERGED_DTOL
KSPDGMRES KSPSYMMLQ KSP_DIVERGED_INDEFINITE_PC
KSPDestroy KSPSetComputeInitialGuess KSP_DIVERGED_ITS
KSPFBCGS KSPSetComputeOperators KSP_DIVERGED_NONSYMMETRIC
KSPFBCGSR KSPSetComputeRHS KSP_DIVERGED_PCSETUP_FAILED
KSPFCG KSPSetFromOptions
Intermediate - Setting options for algorithms and data structures
KSPBCGSLSetEll KSPGROPPCG KSPPIPEFCGGetTruncationType
KSPBCGSLSetPol KSPGetApplicationContext KSPPIPEFCGSetMmax
KSPBCGSLSetUsePseudoinverse KSPGetConvergedReason KSPPIPEFCGSetTruncationType
KSPBCGSLSetXRes KSPGetDM KSPPIPEFGMRES
KSPCGSetType KSPGetDiagonalScale KSPPIPEFGMRESSetShift
KSPCGUseSingleReduction KSPGetDiagonalScaleFix KSPPIPEGCR
KSPChebyshevEstEigGetKSP KSPGetErrorIfNotConverged KSPPIPEGCRGetMmax
KSPChebyshevEstEigSet KSPGetInitialGuessNonzero KSPPIPEGCRGetTruncationType
KSPChebyshevEstEigSetUseNoisy KSPGetIterationNumber KSPPIPEGCRGetUnrollW
KSPChebyshevSetEigenvalues KSPGetMonitorContext KSPPIPEGCRSetMmax
KSPConvergedDefault KSPGetOperators KSPPIPEGCRSetModifyPC
KSPConvergedDefaultCreate KSPGetOperatorsSet KSPPIPEGCRSetTruncationType
KSPConvergedDefaultDestroy KSPGetPCSide KSPPIPEGCRSetUnrollW
KSPConvergedDefaultSetUIRNorm KSPGetResidualNorm KSPPythonSetType
KSPConvergedDefaultSetUMIRNorm KSPGetTolerances KSPReasonViewFromOptions
KSPFCDTruncationType KSPGetTotalIterations KSPRichardsonSetScale
KSPFCGGetMmax KSPGetType KSPRichardsonSetSelfScale
KSPFCGGetTruncationType KSPLSQRDefaultConverged KSPSetApplicationContext
KSPFCGSetMmax KSPLSQRMonitorDefault KSPSetDM
KSPFCGSetTruncationType KSPLoad KSPSetDMActive
KSPFGMRESModifyPCKSP KSPMonitorCancel KSPSetDiagonalScale
KSPFGMRESModifyPCNoChange KSPMonitorDefault KSPSetDiagonalScaleFix
KSPFGMRESSetModifyPC KSPMonitorLGResidualNormCreate KSPSetErrorIfNotConverged
KSPGCRSetModifyPC KSPMonitorLGTrueResidualNormCreate KSPSetPCSide
KSPGMRESClassicalGramSchmidtOrthogonalization KSPMonitorRange KSPSetReusePreconditioner
KSPGMRESGetCGSRefinementType KSPMonitorSingularValue KSPSetSkipPCSetFromOptions
KSPGMRESGetOrthogonalization KSPMonitorSolution KSPSetTolerances
KSPGMRESGetRestart KSPMonitorTrueResidualMaxNorm KSPSetType
KSPGMRESModifiedGramSchmidtOrthogonalization KSPMonitorTrueResidualNorm MatCreateSchurComplement
KSPGMRESMonitorKrylov KSPPIPEBCGS MatSchurComplementAinvType
KSPGMRESSetCGSRefinementType KSPPIPECG MatSchurComplementGetKSP
KSPGMRESSetHapTol KSPPIPECGRR MatSchurComplementGetSubMatrices
KSPGMRESSetOrthogonalization KSPPIPECR MatSchurComplementSetSubMatrices
KSPGMRESSetPreAllocateVectors KSPPIPEFCG MatSchurComplementUpdateSubMatrices
KSPGMRESSetRestart KSPPIPEFCGGetMmax
Advanced - Setting more advanced options and customization
DMGlobalToLocalSolve KSPFETIDPGetInnerKSP KSPSetComputeEigenvalues
DMKSPGetComputeInitialGuess KSPFETIDPSetInnerBDDC KSPSetComputeRitz
DMKSPGetComputeOperators KSPFETIDPSetPressureOperators KSPSetComputeSingularValues
DMKSPGetComputeRHS KSPFischerGuessCreate KSPSetConvergenceTest
DMKSPSetComputeInitialGuess KSPGMRESCGSRefinementType KSPSetFischerGuess
DMKSPSetComputeOperators KSPGetComputeEigenvalues KSPSetInitialGuessKnoll
DMKSPSetComputeRHS KSPGetComputeSingularValues KSPSetLagNorm
KSPAppendOptionsPrefix KSPGetConvergenceContext KSPSetNormType
KSPBuildResidual KSPGetInitialGuessKnoll KSPSetOptionsPrefix
KSPBuildSolution KSPGetNormType KSPSetResidualHistory
KSPCGGLTRGetLambda KSPGetOptionsPrefix KSPSetUpOnBlocks
KSPCGGLTRGetMinEig KSPGetResidualHistory KSPSetUseFischerGuess
KSPCGGetNormD KSPMatRegisterAll KSPTSIRM
KSPCGGetObjFcn KSPMonitorDynamicTolerance KSPUnwindPreconditioner
KSPCGSetRadius KSPMonitorSAWs KSP_GMRES_CGS_REFINE_IFNEEDED
KSPComputeEigenvalues KSPNormType KSP_GMRES_CGS_REFINE_NEVER
KSPComputeEigenvaluesExplicitly KSPPIPEFCGGetNprealloc KSP_NORM_NATURAL
KSPComputeExplicitOperator KSPPIPEFCGSetNprealloc KSP_NORM_NONE
KSPComputeExtremeSingularValues KSPPIPEGCRGetNprealloc KSP_NORM_PRECONDITIONED
KSPComputeRitz KSPPIPEGCRSetNprealloc KSP_NORM_UNPRECONDITIONED
KSPConvergedSkip KSPQCGGetQuadratic MatCreateSchurComplementPmat
KSPCreateVecs KSPQCGGetTrialStepNorm MatGetSchurComplement
KSPFCGGetNprealloc KSPQCGSetTrustRegionRadius MatSchurComplementComputeExplicitOperator
KSPFCGSetNprealloc KSPRegister MatSchurComplementGetAinvType
KSPFETIDP KSPRegisterAll MatSchurComplementGetPmat
KSPFETIDPGetInnerBDDC KSPSetCheckNormIteration MatSchurComplementSetAinvType
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
KSPGetFischerGuess KSPQCG PCInitializePackage
KSPGetPC KSPSetPC
No deprecated routines

Table of Contents