petsc-master 2016-09-27
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 KSPSetInitialGuessNonzero
KSP KSPGCR KSPSetOperators
KSPAGMRES KSPGMRES KSPSolve
KSPBCGS KSPIBCGS KSPTCQMR
KSPBCGSL KSPLCD KSPTFQMR
KSPBICG KSPLGMRES KSPType
KSPCG 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 KSPPIPEFCGSetMmax
KSPBCGSLSetPol KSPGetApplicationContext KSPPIPEFCGSetTruncationType
KSPBCGSLSetUsePseudoinverse KSPGetConvergedReason KSPPIPEFGMRES
KSPBCGSLSetXRes KSPGetDM KSPPIPEFGMRESSetShift
KSPCGSetType KSPGetDiagonalScale KSPPIPEGCR
KSPCGUseSingleReduction KSPGetDiagonalScaleFix KSPPIPEGCRGetMmax
KSPChebyshevEstEigGetKSP KSPGetErrorIfNotConverged KSPPIPEGCRGetTruncationType
KSPChebyshevEstEigSet KSPGetInitialGuessNonzero KSPPIPEGCRGetUnrollW
KSPChebyshevEstEigSetUseNoisy KSPGetIterationNumber KSPPIPEGCRSetMmax
KSPChebyshevSetEigenvalues KSPGetMonitorContext KSPPIPEGCRSetModifyPC
KSPConvergedDefault KSPGetOperators KSPPIPEGCRSetTruncationType
KSPConvergedDefaultCreate KSPGetOperatorsSet KSPPIPEGCRSetUnrollW
KSPConvergedDefaultDestroy KSPGetPCSide KSPPythonSetType
KSPConvergedDefaultSetUIRNorm KSPGetResidualNorm KSPReasonViewFromOptions
KSPConvergedDefaultSetUMIRNorm KSPGetTolerances KSPRichardsonSetScale
KSPFCDTruncationType KSPGetTotalIterations KSPRichardsonSetSelfScale
KSPFCGGetMmax KSPGetType KSPSetApplicationContext
KSPFCGGetTruncationType KSPLSQRDefaultConverged KSPSetDM
KSPFCGSetMmax KSPLSQRMonitorDefault KSPSetDMActive
KSPFCGSetTruncationType KSPLoad KSPSetDiagonalScale
KSPFGMRESModifyPCKSP KSPMonitorCancel KSPSetDiagonalScaleFix
KSPFGMRESModifyPCNoChange KSPMonitorDefault KSPSetErrorIfNotConverged
KSPFGMRESSetModifyPC KSPMonitorLGResidualNormCreate KSPSetPCSide
KSPGCRSetModifyPC KSPMonitorLGTrueResidualNormCreate KSPSetReusePreconditioner
KSPGMRESClassicalGramSchmidtOrthogonalization KSPMonitorRange KSPSetSkipPCSetFromOptions
KSPGMRESGetCGSRefinementType KSPMonitorSingularValue KSPSetTolerances
KSPGMRESGetOrthogonalization KSPMonitorSolution KSPSetType
KSPGMRESGetRestart KSPMonitorTrueResidualMaxNorm MatCreateSchurComplement
KSPGMRESModifiedGramSchmidtOrthogonalization KSPMonitorTrueResidualNorm MatSchurComplementAinvType
KSPGMRESMonitorKrylov KSPPIPECG MatSchurComplementGetKSP
KSPGMRESSetCGSRefinementType KSPPIPECGRR MatSchurComplementGetSubMatrices
KSPGMRESSetHapTol KSPPIPECR MatSchurComplementSetSubMatrices
KSPGMRESSetOrthogonalization KSPPIPEFCG MatSchurComplementUpdateSubMatrices
KSPGMRESSetPreAllocateVectors KSPPIPEFCGGetMmax
KSPGMRESSetRestart KSPPIPEFCGGetTruncationType
Advanced - Setting more advanced options and customization
DMGlobalToLocalSolve KSPFETIDPGetInnerKSP KSPSetComputeRitz
DMKSPGetComputeInitialGuess KSPFETIDPSetInnerBDDC KSPSetComputeSingularValues
DMKSPGetComputeOperators KSPFischerGuessCreate KSPSetConvergenceTest
DMKSPGetComputeRHS KSPGMRESCGSRefinementType KSPSetFischerGuess
DMKSPSetComputeInitialGuess KSPGetComputeEigenvalues KSPSetInitialGuessKnoll
DMKSPSetComputeOperators KSPGetComputeSingularValues KSPSetLagNorm
DMKSPSetComputeRHS KSPGetConvergenceContext KSPSetNormType
KSPAppendOptionsPrefix KSPGetInitialGuessKnoll KSPSetOptionsPrefix
KSPBuildResidual KSPGetNormType KSPSetResidualHistory
KSPBuildSolution KSPGetOptionsPrefix KSPSetUpOnBlocks
KSPCGGLTRGetLambda KSPGetResidualHistory KSPSetUseFischerGuess
KSPCGGLTRGetMinEig KSPMatRegisterAll KSPTSIRM
KSPCGGetNormD KSPMonitorDynamicTolerance KSPUnwindPreconditioner
KSPCGGetObjFcn KSPMonitorSAWs KSP_GMRES_CGS_REFINE_IFNEEDED
KSPCGSetRadius KSPNormType KSP_GMRES_CGS_REFINE_NEVER
KSPComputeEigenvalues KSPPIPEFCGGetNprealloc KSP_NORM_NATURAL
KSPComputeEigenvaluesExplicitly KSPPIPEFCGSetNprealloc KSP_NORM_NONE
KSPComputeExplicitOperator KSPPIPEGCRGetNprealloc KSP_NORM_PRECONDITIONED
KSPComputeExtremeSingularValues KSPPIPEGCRSetNprealloc KSP_NORM_UNPRECONDITIONED
KSPComputeRitz KSPQCGGetQuadratic MatCreateSchurComplementPmat
KSPConvergedSkip KSPQCGGetTrialStepNorm MatGetSchurComplement
KSPCreateVecs KSPQCGSetTrustRegionRadius MatSchurComplementComputeExplicitOperator
KSPFCGGetNprealloc KSPRegister MatSchurComplementGetAinvType
KSPFCGSetNprealloc KSPRegisterAll MatSchurComplementGetPmat
KSPFETIDP KSPSetCheckNormIteration MatSchurComplementSetAinvType
KSPFETIDPGetInnerBDDC KSPSetComputeEigenvalues
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
None: Not yet cataloged
limination xtract

Table of Contents