petsc-dev 2013-05-13

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_BICG KSPMonitorSet
KSPBCGSL KSP_DIVERGED_BREAKDOWN KSPPGMRES
KSPBICG KSP_DIVERGED_DTOL KSPPREONLY
KSPCG KSP_DIVERGED_INDEFINITE_PC KSPReset
KSPCGNE KSP_DIVERGED_ITS KSPRICHARDSON
KSPCGS KSP_DIVERGED_NONSYMMETRIC KSPSetComputeInitialGuess
KSPCGType KSPFBCGS KSPSetComputeOperators
KSPCHEBYSHEV KSPFBCGSR KSPSetComputeRHS
KSP_CONVERGED_ATOL KSPFGMRES KSPSetFromOptions
KSP_CONVERGED_ITERATING KSPGCR KSPSetInitialGuessNonzero
KSP_CONVERGED_ITS KSPGMRES KSPSetOperators
KSPConvergedReason KSP KSPSolve
KSP_CONVERGED_RTOL KSPIBCGS KSPSYMMLQ
KSPCreate KSPLCD KSPTCQMR
KSPCR KSPLGMRES KSPTFQMR
KSPDestroy KSPLSQR KSPType
KSPDGMRES KSPMINRES KSPView
Intermediate - Setting options for algorithms and data structures
KSPBCGSLSetEll KSPGetMonitorContext KSPMonitorLGTrueResidualNormDestroy
KSPBCGSLSetPol KSPGetOperators KSPMonitorRange
KSPBCGSLSetUsePseudoinverse KSPGetOperatorsSet KSPMonitorSingularValue
KSPBCGSLSetXRes KSPGetPCSide KSPMonitorSolution
KSPCGSetType KSPGetResidualNorm KSPMonitorTrueResidualMaxNorm
KSPCGUseSingleReduction KSPGetTolerances KSPMonitorTrueResidualNorm
KSPChebyshevEstEigSetRandom KSPGetType KSPPythonSetType
KSPChebyshevSetEigenvalues KSPGMRESClassicalGramSchmidtOrthogonalization KSPRichardsonSetScale
KSPChebyshevSetEstimateEigenvalues KSPGMRESGetCGSRefinementType KSPRichardsonSetSelfScale
KSPDefaultConvergedCreate KSPGMRESGetOrthogonalization KSPSetApplicationContext
KSPDefaultConvergedDestroy KSPGMRESGetRestart KSPSetDiagonalScaleFix
KSPDefaultConverged KSPGMRESModifiedGramSchmidtOrthogonalization KSPSetDiagonalScale
KSPDefaultConvergedSetUIRNorm KSPGMRESMonitorKrylov KSPSetDMActive
KSPDefaultConvergedSetUMIRNorm KSPGMRESSetCGSRefinementType KSPSetDM
KSPFGMRESModifyPCKSP KSPGMRESSetHapTol KSPSetErrorIfNotConverged
KSPFGMRESModifyPCNoChange KSPGMRESSetOrthogonalization KSPSetPCSide
KSPFGMRESSetModifyPC KSPGMRESSetPreAllocateVectors KSPSetTolerances
KSPGCRSetModifyPC KSPGMRESSetRestart KSPSetType
KSPGetApplicationContext KSPLoad KSPSPECEST
KSPGetConvergedReason KSPLSQRDefaultConverged MatCreateSchurComplement
KSPGetDiagonalScaleFix KSPLSQRMonitorDefault MatSchurComplementGetKSP
KSPGetDiagonalScale KSPMonitorCancel MatSchurComplementGetSubmatrices
KSPGetDM KSPMonitorDefault MatSchurComplementSet
KSPGetErrorIfNotConverged KSPMonitorLGResidualNormCreate MatSchurComplementUpdate
KSPGetInitialGuessNonzero KSPMonitorLGResidualNormDestroy
KSPGetIterationNumber KSPMonitorLGTrueResidualNormCreate
Advanced - Setting more advanced options and customization
DMKSPGetComputeInitialGuess KSPGetVecs KSPQCGSetTrustRegionRadius
DMKSPGetComputeOperators KSPGLTRGetLambda KSPRegisterAll
DMKSPGetComputeRHS KSPGLTRGetMinEig KSPRegister
DMKSPSetComputeInitialGuess KSPGLTRGetNormD KSPSetCheckNormIteration
DMKSPSetComputeOperators KSPGLTRGetObjFcn KSPSetComputeEigenvalues
DMKSPSetComputeRHS KSPGLTRSetRadius KSPSetComputeSingularValues
KSPAppendOptionsPrefix KSP_GMRES_CGS_REFINE_IFNEEDED KSPSetConvergenceTest
KSPBuildResidual KSPGMRESCGSRefinementType KSPSetFischerGuess
KSPBuildSolution KSP_GMRES_CGS_REFINE_NEVER KSPSetInitialGuessKnoll
KSPComputeEigenvaluesExplicitly KSPMatRegisterAll KSPSetLagNorm
KSPComputeEigenvalues KSPMonitorAMS KSPSetNormType
KSPComputeExplicitOperator KSPMonitorDynamicTolerance KSPSetNullSpace
KSPComputeExtremeSingularValues KSPNASHGetNormD KSPSetOptionsPrefix
KSPFischerGuessCreate KSPNASHGetObjFcn KSPSetResidualHistory
KSPGetComputeEigenvalues KSPNASHSetRadius KSPSetUpOnBlocks
KSPGetComputeSingularValues KSP_NORM_NATURAL KSPSetUseFischerGuess
KSPGetConvergenceContext KSP_NORM_NONE KSPSkipConverged
KSPGetInitialGuessKnoll KSP_NORM_PRECONDITIONED KSPSTCGGetNormD
KSPGetNormType KSPNormType KSPSTCGGetObjFcn
KSPGetNullSpace KSP_NORM_UNPRECONDITIONED KSPSTCGSetRadius
KSPGetOptionsPrefix KSPQCGGetQuadratic KSPUnwindPreconditioner
KSPGetResidualHistory KSPQCGGetTrialStepNorm MatGetSchurComplement
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 KSPMonitorAMSCreate KSPSetUp
KSPFinalizePackage KSPMonitorAMSDestroy KSPSolveTranspose
KSPGetFischerGuess KSPMonitor KSPSTCG
KSPGetPC KSPNASH MatSchurComplementSetKSP
KSPGetRhs KSPQCG PCFinalizePackage
KSPGetSolution KSPSetPC PCInitializePackage
No deprecated routines

Table of Contents