petsc-master 2016-05-28
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
KSCGLS KSPFGMRES KSPSetComputeRHS
KSP KSPGCR KSPSetFromOptions
KSPAGMRES KSPGMRES KSPSetInitialGuessNonzero
KSPBCGS KSPIBCGS KSPSetOperators
KSPBCGSL KSPLCD KSPSolve
KSPBICG KSPLGMRES KSPTCQMR
KSPCG KSPLSQR KSPTFQMR
KSPCGNE KSPMINRES KSPType
KSPCGS KSPMonitorSet KSPView
KSPCGType KSPPGMRES KSP_CONVERGED_ATOL
KSPCHEBYSHEV KSPPIPEFGMRES KSP_CONVERGED_ITERATING
KSPCR KSPPIPEGCR 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 KSPSYMMLQ KSP_DIVERGED_INDEFINITE_PC
KSPFBCGSR KSPSetComputeInitialGuess KSP_DIVERGED_ITS
KSPFCG KSPSetComputeOperators KSP_DIVERGED_NONSYMMETRIC
Intermediate - Setting options for algorithms and data structures
KSPBCGSLSetEll KSPGMRESSetPreAllocateVectors KSPPIPEFCG
KSPBCGSLSetPol KSPGMRESSetRestart KSPPIPEFCGGetMmax
KSPBCGSLSetUsePseudoinverse KSPGROPPCG KSPPIPEFCGGetTruncationType
KSPBCGSLSetXRes KSPGetApplicationContext KSPPIPEFCGSetMmax
KSPCGSetType KSPGetConvergedReason KSPPIPEFCGSetTruncationType
KSPCGUseSingleReduction KSPGetDM KSPPIPEFGMRESSetShift
KSPChebyshevEstEigGetKSP KSPGetDiagonalScale KSPPIPEGCRGetMmax
KSPChebyshevEstEigSet KSPGetDiagonalScaleFix KSPPIPEGCRGetTruncationType
KSPChebyshevEstEigSetRandom KSPGetErrorIfNotConverged KSPPIPEGCRGetUnrollW
KSPChebyshevEstEigSetUseRandom KSPGetInitialGuessNonzero KSPPIPEGCRSetMmax
KSPChebyshevSetEigenvalues KSPGetIterationNumber KSPPIPEGCRSetModifyPC
KSPConvergedDefault KSPGetMonitorContext KSPPIPEGCRSetTruncationType
KSPConvergedDefaultCreate KSPGetOperators KSPPIPEGCRSetUnrollW
KSPConvergedDefaultDestroy KSPGetOperatorsSet KSPPythonSetType
KSPConvergedDefaultSetUIRNorm KSPGetPCSide KSPReasonViewFromOptions
KSPConvergedDefaultSetUMIRNorm KSPGetResidualNorm KSPRichardsonSetScale
KSPFCDTruncationType KSPGetTolerances KSPRichardsonSetSelfScale
KSPFCGGetMmax KSPGetTotalIterations KSPSetApplicationContext
KSPFCGGetTruncationType KSPGetType KSPSetDM
KSPFCGSetMmax KSPLSQRDefaultConverged KSPSetDMActive
KSPFCGSetTruncationType KSPLSQRMonitorDefault KSPSetDiagonalScale
KSPFGMRESModifyPCKSP KSPLoad KSPSetDiagonalScaleFix
KSPFGMRESModifyPCNoChange KSPMonitorCancel KSPSetErrorIfNotConverged
KSPFGMRESSetModifyPC KSPMonitorDefault KSPSetPCSide
KSPGCRSetModifyPC KSPMonitorLGResidualNormCreate KSPSetReusePreconditioner
KSPGMRESClassicalGramSchmidtOrthogonalization KSPMonitorLGTrueResidualNormCreate KSPSetSkipPCSetFromOptions
KSPGMRESGetCGSRefinementType KSPMonitorRange KSPSetTolerances
KSPGMRESGetOrthogonalization KSPMonitorSingularValue KSPSetType
KSPGMRESGetRestart KSPMonitorSolution MatCreateSchurComplement
KSPGMRESModifiedGramSchmidtOrthogonalization KSPMonitorTrueResidualMaxNorm MatSchurComplementAinvType
KSPGMRESMonitorKrylov KSPMonitorTrueResidualNorm MatSchurComplementGetKSP
KSPGMRESSetCGSRefinementType KSPPIPECG MatSchurComplementGetSubMatrices
KSPGMRESSetHapTol KSPPIPECGRR MatSchurComplementSetSubMatrices
KSPGMRESSetOrthogonalization KSPPIPECR MatSchurComplementUpdateSubMatrices
Advanced - Setting more advanced options and customization
DMGlobalToLocalSolve KSPGetComputeSingularValues KSPSetComputeRitz
DMKSPGetComputeInitialGuess KSPGetConvergenceContext KSPSetComputeSingularValues
DMKSPGetComputeOperators KSPGetInitialGuessKnoll KSPSetConvergenceTest
DMKSPGetComputeRHS KSPGetNormType KSPSetFischerGuess
DMKSPSetComputeInitialGuess KSPGetOptionsPrefix KSPSetInitialGuessKnoll
DMKSPSetComputeOperators KSPGetResidualHistory KSPSetLagNorm
DMKSPSetComputeRHS KSPMatRegisterAll KSPSetNormType
KSPAppendOptionsPrefix KSPMonitorDynamicTolerance KSPSetOptionsPrefix
KSPBuildResidual KSPMonitorSAWs KSPSetResidualHistory
KSPBuildSolution KSPNASHGetNormD KSPSetUpOnBlocks
KSPComputeEigenvalues KSPNASHGetObjFcn KSPSetUseFischerGuess
KSPComputeEigenvaluesExplicitly KSPNASHSetRadius KSPTSIRM
KSPComputeExplicitOperator KSPNormType KSPUnwindPreconditioner
KSPComputeExtremeSingularValues KSPPIPEFCGGetNprealloc KSP_GMRES_CGS_REFINE_IFNEEDED
KSPComputeRitz KSPPIPEFCGSetNprealloc KSP_GMRES_CGS_REFINE_NEVER
KSPConvergedSkip KSPPIPEGCRGetNprealloc KSP_NORM_NATURAL
KSPCreateVecs KSPPIPEGCRSetNprealloc KSP_NORM_NONE
KSPFCGGetNprealloc KSPQCGGetQuadratic KSP_NORM_PRECONDITIONED
KSPFCGSetNprealloc KSPQCGGetTrialStepNorm KSP_NORM_UNPRECONDITIONED
KSPFischerGuessCreate KSPQCGSetTrustRegionRadius MatCreateSchurComplementPmat
KSPGLTRGetLambda KSPRegister MatGetSchurComplement
KSPGLTRGetMinEig KSPRegisterAll MatSchurComplementComputeExplicitOperator
KSPGLTRGetNormD KSPSTCGGetNormD MatSchurComplementGetAinvType
KSPGLTRGetObjFcn KSPSTCGGetObjFcn MatSchurComplementGetPmat
KSPGLTRSetRadius KSPSTCGSetRadius MatSchurComplementSetAinvType
KSPGMRESCGSRefinementType KSPSetCheckNormIteration
KSPGetComputeEigenvalues KSPSetComputeEigenvalues
Developer - Interfaces intended primarily for library developers, not for typical applications programmers
DMCopyDMKSP KSPGetTabLevel KSPSetPostSolve
DMGetDMKSP KSPInitialResidual KSPSetPreSolve
DMGetDMKSPWrite KSPInitializePackage KSPSetSupportedNorm
DMKSPCopy KSPMonitor KSPSetTabLevel
DMProjectField KSPMonitorSAWsCreate KSPSetUp
KSPFinalizePackage KSPMonitorSAWsDestroy KSPSolveTranspose
KSPGLTR KSPMonitorSetFromOptions MatSchurComplementSetKSP
KSPGetFischerGuess KSPNASH PCFinalizePackage
KSPGetPC KSPQCG PCInitializePackage
KSPGetRhs KSPSTCG
KSPGetSolution KSPSetPC
No deprecated routines
None: Not yet cataloged
limination xtract

Table of Contents