petsc-dev 2014-04-23
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 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
KSPConvergedDefaultCreate KSPGMRESGetOrthogonalization KSPSetApplicationContext
KSPConvergedDefaultDestroy KSPGMRESGetRestart KSPSetDiagonalScaleFix
KSPConvergedDefault KSPGMRESModifiedGramSchmidtOrthogonalization KSPSetDiagonalScale
KSPConvergedDefaultSetUIRNorm KSPGMRESMonitorKrylov KSPSetDMActive
KSPConvergedDefaultSetUMIRNorm KSPGMRESSetCGSRefinementType KSPSetDM
KSPFGMRESModifyPCKSP KSPGMRESSetHapTol KSPSetErrorIfNotConverged
KSPFGMRESModifyPCNoChange KSPGMRESSetOrthogonalization KSPSetPCSide
KSPFGMRESSetModifyPC KSPGMRESSetPreAllocateVectors KSPSetReusePreconditioner
KSPGCRSetModifyPC KSPGMRESSetRestart KSPSetTolerances
KSPGetApplicationContext KSPLoad KSPSetType
KSPGetConvergedReason KSPLSQRDefaultConverged KSPSPECEST
KSPGetDiagonalScaleFix KSPLSQRMonitorDefault MatCreateSchurComplement
KSPGetDiagonalScale KSPMonitorCancel MatSchurComplementAinvType
KSPGetDM KSPMonitorDefault MatSchurComplementGetKSP
KSPGetErrorIfNotConverged KSPMonitorLGResidualNormCreate MatSchurComplementGetSubMatrices
KSPGetInitialGuessNonzero KSPMonitorLGResidualNormDestroy MatSchurComplementSetSubMatrices
KSPGetIterationNumber KSPMonitorLGTrueResidualNormCreate MatSchurComplementUpdateSubMatrices
Advanced - Setting more advanced options and customization
DMKSPGetComputeInitialGuess KSPGLTRGetLambda KSPSetCheckNormIteration
DMKSPGetComputeOperators KSPGLTRGetMinEig KSPSetComputeEigenvalues
DMKSPGetComputeRHS KSPGLTRGetNormD KSPSetComputeSingularValues
DMKSPSetComputeInitialGuess KSPGLTRGetObjFcn KSPSetConvergenceTest
DMKSPSetComputeOperators KSPGLTRSetRadius KSPSetFischerGuess
DMKSPSetComputeRHS KSP_GMRES_CGS_REFINE_IFNEEDED KSPSetInitialGuessKnoll
KSPAppendOptionsPrefix KSPGMRESCGSRefinementType KSPSetLagNorm
KSPBuildResidual KSP_GMRES_CGS_REFINE_NEVER KSPSetNormType
KSPBuildSolution KSPMatRegisterAll KSPSetNullSpace
KSPComputeEigenvaluesExplicitly KSPMonitorDynamicTolerance KSPSetOptionsPrefix
KSPComputeEigenvalues KSPMonitorSAWs KSPSetResidualHistory
KSPComputeExplicitOperator KSPNASHGetNormD KSPSetUpOnBlocks
KSPComputeExtremeSingularValues KSPNASHGetObjFcn KSPSetUseFischerGuess
KSPConvergedSkip KSPNASHSetRadius KSPSTCGGetNormD
KSPFischerGuessCreate KSP_NORM_NATURAL KSPSTCGGetObjFcn
KSPGetComputeEigenvalues KSP_NORM_NONE KSPSTCGSetRadius
KSPGetComputeSingularValues KSP_NORM_PRECONDITIONED KSPUnwindPreconditioner
KSPGetConvergenceContext KSPNormType MatCreateSchurComplementPmat
KSPGetInitialGuessKnoll KSP_NORM_UNPRECONDITIONED MatGetSchurComplement
KSPGetNormType KSPQCGGetQuadratic MatSchurComplementComputeExplicitOperator
KSPGetNullSpace KSPQCGGetTrialStepNorm MatSchurComplementGetAinvType
KSPGetOptionsPrefix KSPQCGSetTrustRegionRadius MatSchurComplementGetPmat
KSPGetResidualHistory KSPRegisterAll MatSchurComplementSetAinvType
KSPGetVecs 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

Table of Contents