petsc-master 2015-01-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
KSPBCGS KSP_DIVERGED_BREAKDOWN KSPPGMRES
KSPBCGSL KSP_DIVERGED_DTOL KSPPREONLY
KSPBICG KSP_DIVERGED_INDEFINITE_PC KSPReasonView
KSPCG KSP_DIVERGED_ITS KSPReset
KSPCGNE KSP_DIVERGED_NONSYMMETRIC KSPRICHARDSON
KSPCGS KSPFBCGS KSPSetComputeInitialGuess
KSPCGType KSPFBCGSR KSPSetComputeOperators
KSPCHEBYSHEV KSPFCG 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
KSP_DIVERGED_BREAKDOWN_BICG KSPMonitorSet
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 KSPPIPECG
KSPChebyshevSetEigenvalues KSPGetTolerances KSPPIPECR
KSPChebyshevSetEstimateEigenvalues KSPGetType KSPPythonSetType
KSPConvergedDefaultCreate KSPGMRESClassicalGramSchmidtOrthogonalization KSPReasonViewFromOptions
KSPConvergedDefaultDestroy KSPGMRESGetCGSRefinementType KSPRichardsonSetScale
KSPConvergedDefault KSPGMRESGetOrthogonalization KSPRichardsonSetSelfScale
KSPConvergedDefaultSetUIRNorm KSPGMRESGetRestart KSPSetApplicationContext
KSPConvergedDefaultSetUMIRNorm KSPGMRESModifiedGramSchmidtOrthogonalization KSPSetDiagonalScaleFix
KSPFCGGetMmax KSPGMRESMonitorKrylov KSPSetDiagonalScale
KSPFCGGetTruncationType KSPGMRESSetCGSRefinementType KSPSetDMActive
KSPFCGSetMmax KSPGMRESSetHapTol KSPSetDM
KSPFCGSetTruncationType KSPGMRESSetOrthogonalization KSPSetErrorIfNotConverged
KSPFCGTruncationType KSPGMRESSetPreAllocateVectors KSPSetPCSide
KSPFGMRESModifyPCKSP KSPGMRESSetRestart KSPSetReusePreconditioner
KSPFGMRESModifyPCNoChange KSPGROPPCG KSPSetTolerances
KSPFGMRESSetModifyPC KSPLoad KSPSetType
KSPGCRSetModifyPC KSPLSQRDefaultConverged KSPSPECEST
KSPGetApplicationContext KSPLSQRMonitorDefault MatCreateSchurComplement
KSPGetConvergedReason KSPMonitorCancel MatSchurComplementAinvType
KSPGetDiagonalScaleFix KSPMonitorDefault MatSchurComplementGetKSP
KSPGetDiagonalScale KSPMonitorLGResidualNormCreate MatSchurComplementGetSubMatrices
KSPGetDM KSPMonitorLGResidualNormDestroy MatSchurComplementSetSubMatrices
KSPGetErrorIfNotConverged KSPMonitorLGTrueResidualNormCreate MatSchurComplementUpdateSubMatrices
Advanced - Setting more advanced options and customization
DMGlobalToLocalSolve KSPGetOptionsPrefix KSPRegister
DMKSPGetComputeInitialGuess KSPGetResidualHistory 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
KSPCreateVecs KSPNASHSetRadius KSPSTCGGetObjFcn
KSPFCGGetNprealloc KSP_NORM_NATURAL KSPSTCGSetRadius
KSPFCGSetNprealloc KSP_NORM_NONE KSPUnwindPreconditioner
KSPFischerGuessCreate KSP_NORM_PRECONDITIONED MatCreateSchurComplementPmat
KSPGetComputeEigenvalues KSPNormType MatGetSchurComplement
KSPGetComputeSingularValues KSP_NORM_UNPRECONDITIONED MatSchurComplementComputeExplicitOperator
KSPGetConvergenceContext KSPQCGGetQuadratic MatSchurComplementGetAinvType
KSPGetInitialGuessKnoll KSPQCGGetTrialStepNorm MatSchurComplementGetPmat
KSPGetNormType KSPQCGSetTrustRegionRadius MatSchurComplementSetAinvType
KSPGetNullSpace KSPRegisterAll
Developer - Interfaces intended primarily for library developers, not for typical applications programmers
DMCopyDMKSP KSPGetTabLevel KSPSetPreSolve
DMGetDMKSP KSPGLTR KSPSetSupportedNorm
DMGetDMKSPWrite KSPInitializePackage KSPSetTabLevel
DMKSPCopy KSPInitialResidual KSPSetUp
DMPlexProjectField KSPMonitor KSPSolveTranspose
KSPChebyshevSetNewMatrix KSPMonitorSAWsCreate KSPSTCG
KSPFinalizePackage KSPMonitorSAWsDestroy MatSchurComplementSetKSP
KSPGetFischerGuess KSPNASH PCFinalizePackage
KSPGetPC KSPQCG PCInitializePackage
KSPGetRhs KSPSetPC
KSPGetSolution KSPSetPostSolve
No deprecated routines

Table of Contents