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

Table of Contents