petsc-master 2014-09-18
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
KSPBCGS KSP_DIVERGED_BREAKDOWN KSPPGMRES
KSPBCGSL KSP_DIVERGED_DTOL KSPPIPECG
KSPBICG KSP_DIVERGED_INDEFINITE_PC KSPPIPECR
KSPCG KSP_DIVERGED_ITS KSPPREONLY
KSPCGNE KSP_DIVERGED_NONSYMMETRIC KSPReset
KSPCGS KSPFBCGS KSPRICHARDSON
KSPCGType KSPFBCGSR KSPSetComputeInitialGuess
KSPCHEBYSHEV KSPFGMRES KSPSetComputeOperators
KSP_CONVERGED_ATOL KSPGCR KSPSetComputeRHS
KSP_CONVERGED_ITERATING KSPGMRES KSPSetFromOptions
KSP_CONVERGED_ITS KSPGROPPCG KSPSetInitialGuessNonzero
KSPConvergedReason KSP KSPSetOperators
KSP_CONVERGED_RTOL KSPIBCGS KSPSolve
KSPCreate KSPLCD KSPSYMMLQ
KSPCR KSPLGMRES KSPTCQMR
KSPDestroy KSPLSQR KSPTFQMR
KSPDGMRES KSPMINRES KSPType
KSP_DIVERGED_BREAKDOWN_BICG KSPMonitorSet KSPView
Intermediate - Setting options for algorithms and data structures
KSPBCGSLSetEll KSPGetInitialGuessNonzero KSPMonitorLGTrueResidualNormDestroy
KSPBCGSLSetPol KSPGetIterationNumber KSPMonitorRange
KSPBCGSLSetUsePseudoinverse KSPGetMonitorContext KSPMonitorSingularValue
KSPBCGSLSetXRes KSPGetOperators KSPMonitorSolution
KSPCGSetType KSPGetOperatorsSet KSPMonitorTrueResidualMaxNorm
KSPCGUseSingleReduction KSPGetPCSide KSPMonitorTrueResidualNorm
KSPChebyshevEstEigSetRandom KSPGetResidualNorm KSPPythonSetType
KSPChebyshevSetEigenvalues KSPGetTolerances KSPRichardsonSetScale
KSPChebyshevSetEstimateEigenvalues KSPGetType KSPRichardsonSetSelfScale
KSPConvergedDefaultCreate KSPGMRESClassicalGramSchmidtOrthogonalization KSPSetApplicationContext
KSPConvergedDefaultDestroy KSPGMRESGetCGSRefinementType KSPSetDiagonalScaleFix
KSPConvergedDefault KSPGMRESGetOrthogonalization KSPSetDiagonalScale
KSPConvergedDefaultSetUIRNorm KSPGMRESGetRestart KSPSetDMActive
KSPConvergedDefaultSetUMIRNorm KSPGMRESModifiedGramSchmidtOrthogonalization KSPSetDM
KSPFCGGetMmax KSPGMRESMonitorKrylov KSPSetErrorIfNotConverged
KSPFCGGetTruncationType KSPGMRESSetCGSRefinementType KSPSetPCSide
KSPFCGSetMmax KSPGMRESSetHapTol KSPSetReusePreconditioner
KSPFCGSetTruncationType KSPGMRESSetOrthogonalization KSPSetTolerances
KSPFGMRESModifyPCKSP KSPGMRESSetPreAllocateVectors KSPSetType
KSPFGMRESModifyPCNoChange KSPGMRESSetRestart KSPSPECEST
KSPFGMRESSetModifyPC KSPLoad MatCreateSchurComplement
KSPGCRSetModifyPC KSPLSQRDefaultConverged MatSchurComplementAinvType
KSPGetApplicationContext KSPLSQRMonitorDefault MatSchurComplementGetKSP
KSPGetConvergedReason KSPMonitorCancel MatSchurComplementGetSubMatrices
KSPGetDiagonalScaleFix KSPMonitorDefault MatSchurComplementSetSubMatrices
KSPGetDiagonalScale KSPMonitorLGResidualNormCreate MatSchurComplementUpdateSubMatrices
KSPGetDM KSPMonitorLGResidualNormDestroy
KSPGetErrorIfNotConverged KSPMonitorLGTrueResidualNormCreate
Advanced - Setting more advanced options and customization
DMKSPGetComputeInitialGuess KSPGetVecs KSPSetCheckNormIteration
DMKSPGetComputeOperators KSPGLTRGetLambda KSPSetComputeEigenvalues
DMKSPGetComputeRHS KSPGLTRGetMinEig KSPSetComputeSingularValues
DMKSPSetComputeInitialGuess KSPGLTRGetNormD KSPSetConvergenceTest
DMKSPSetComputeOperators KSPGLTRGetObjFcn KSPSetFischerGuess
DMKSPSetComputeRHS KSPGLTRSetRadius KSPSetInitialGuessKnoll
KSPAppendOptionsPrefix KSP_GMRES_CGS_REFINE_IFNEEDED KSPSetLagNorm
KSPBuildResidual KSPGMRESCGSRefinementType KSPSetNormType
KSPBuildSolution KSP_GMRES_CGS_REFINE_NEVER KSPSetNullSpace
KSPComputeEigenvaluesExplicitly KSPMatRegisterAll KSPSetOptionsPrefix
KSPComputeEigenvalues KSPMonitorDynamicTolerance KSPSetResidualHistory
KSPComputeExplicitOperator KSPMonitorSAWs KSPSetUpOnBlocks
KSPComputeExtremeSingularValues KSPNASHGetNormD KSPSetUseFischerGuess
KSPConvergedSkip KSPNASHGetObjFcn KSPSTCGGetNormD
KSPFCGGetNprealloc KSPNASHSetRadius KSPSTCGGetObjFcn
KSPFCGSetNprealloc KSP_NORM_NATURAL KSPSTCGSetRadius
KSPFischerGuessCreate KSP_NORM_NONE KSPUnwindPreconditioner
KSPGetComputeEigenvalues KSP_NORM_PRECONDITIONED MatCreateSchurComplementPmat
KSPGetComputeSingularValues KSPNormType MatGetSchurComplement
KSPGetConvergenceContext KSP_NORM_UNPRECONDITIONED MatSchurComplementComputeExplicitOperator
KSPGetInitialGuessKnoll KSPQCGGetQuadratic MatSchurComplementGetAinvType
KSPGetNormType KSPQCGGetTrialStepNorm MatSchurComplementGetPmat
KSPGetNullSpace KSPQCGSetTrustRegionRadius MatSchurComplementSetAinvType
KSPGetOptionsPrefix KSPRegisterAll
KSPGetResidualHistory KSPRegister
Developer - Interfaces intended primarily for library developers, not for typical applications programmers
DMCopyDMKSP KSPGetTabLevel KSPSetPostSolve
DMGetDMKSP KSPGLTR KSPSetPreSolve
DMGetDMKSPWrite KSPInitializePackage KSPSetSupportedNorm
DMKSPCopy KSPInitialResidual KSPSetTabLevel
KSPChebyshevSetNewMatrix KSPMonitor KSPSetUp
KSPFinalizePackage KSPMonitorSAWsCreate KSPSolveTranspose
KSPGetFischerGuess KSPMonitorSAWsDestroy KSPSTCG
KSPGetPC KSPNASH MatSchurComplementSetKSP
KSPGetRhs KSPQCG PCFinalizePackage
KSPGetSolution KSPSetPC PCInitializePackage
No deprecated routines
None: Not yet cataloged
KSPFCG KSPFCGTruncationType

Table of Contents