petsc-3.5.4 2015-05-23
Report Typos and Errors

Preconditioners - PC: 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 preconditioning options at runtime via the options database (e.g., -pc_type jacobi ). KSP users can also set PC options directly in application codes by first extracting the PC context from the KSP context via KSPGetPC() and then directly calling the PC routines listed below (e.g., PCSetType() ). PC components can be used directly to create and destroy solvers; this is not needed for users but is for library developers.

Beginner - Basic usage
PC PCGASM PCMGType
PCASM PCGASMType PCNONE
PCASMType PCICC PCPBJACOBI
PCBJACOBI PCILU PCSOR
PCCHOLESKY PCJACOBI PCSPAI
PCCompositeType PCKaczmarz PCSide
PCEISENSTAT PCLU PCTFS
PCExoticType PCMGCycleType PCType
Intermediate - Setting options for algorithms and data structures
PCASMGetDMSubdomains PCFactorSetUseInPlace PCHYPRE
PCASMSetDMSubdomains PCFactorSetZeroPivot PCHYPREGetType
PCASMSetOverlap PCFieldSplitGetDMSplits PCHYPRESetType
PCASMSetSortIndices PCFieldSplitGetDiagUseAmat PCISSetSubdomainDiagonalScaling
PCASMSetType PCFieldSplitGetIS PCISSetSubdomainScalingFactor
PCBDDC PCFieldSplitGetOffDiagUseAmat PCISSetUseStiffnessScaling
PCBDDCGetDirichletBoundaries PCFieldSplitGetSchurPre PCJacobiSetUseAbs
PCBDDCGetDirichletBoundariesLocal PCFieldSplitGetType PCJacobiSetUseRowMax
PCBDDCGetNeumannBoundaries PCFieldSplitSchurFactType PCJacobiSetUseRowSum
PCBDDCGetNeumannBoundariesLocal PCFieldSplitSchurPreType PCKSP
PCBDDCSetChangeOfBasisLocalMat PCFieldSplitSetBlockSize PCLSC
PCBDDCSetCoarseningRatio PCFieldSplitSetDMSplits PCLoad
PCBDDCSetDirichletBoundaries PCFieldSplitSetDiagUseAmat PCMAT
PCBDDCSetDirichletBoundariesLocal PCFieldSplitSetFields PCMG
PCBDDCSetDofsSplitting PCFieldSplitSetIS PCMGGetGalerkin
PCBDDCSetDofsSplittingLocal PCFieldSplitSetOffDiagUseAmat PCMGSetGalerkin
PCBDDCSetLevels PCFieldSplitSetSchurFactType PCMGSetLevels
PCBDDCSetLocalAdjacencyGraph PCFieldSplitSetSchurPre PCML
PCBDDCSetNeumannBoundaries PCFieldSplitSetType PCNN
PCBDDCSetNeumannBoundariesLocal PCGALERKIN PCPARMS
PCBDDCSetNullSpace PCGAMG PCPARMSGlobalType
PCBDDCSetPrimalVerticesLocalIS PCGAMGClassicalSetType PCPARMSLocalType
PCBJacobiGetLocalBlocks PCGAMGSetCoarseEqLim PCPARMSSetFill
PCBJacobiGetTotalBlocks PCGAMGSetNSmooths PCPARMSSetGlobal
PCBJacobiSetLocalBlocks PCGAMGSetNlevels PCPARMSSetLocal
PCBJacobiSetTotalBlocks PCGAMGSetProcEqLim PCPARMSSetNonsymPerm
PCCOMPOSITE PCGAMGSetRepartitioning PCPARMSSetSolveRestart
PCCP PCGAMGSetReuseProl PCPARMSSetSolveTolerances
PCDiagonalScaleLeft PCGAMGSetSquareGraph PCPythonSetType
PCDiagonalScaleRight PCGAMGSetSymGraph PCREDISTRIBUTE
PCEisenstatNoDiagonalScaling PCGAMGSetThreshold PCREDUNDANT
PCEisenstatSetOmega PCGAMGSetType PCSORSetIterations
PCExoticSetType PCGAMGSetUseASMAggs PCSORSetOmega
PCFIELDSPLIT PCGAMGType PCSORSetSymmetric
PCFactorGetLevels PCGASMDestroySubdomains PCSPAISetBlockSize
PCFactorGetMatSolverPackage PCGASMGetDMSubdomains PCSPAISetCacheSize
PCFactorReorderForNonzeroDiagonal PCGASMSetDMSubdomains PCSPAISetEpsilon
PCFactorSetAllowDiagonalFill PCGASMSetOverlap PCSPAISetMax
PCFactorSetColumnPivot PCGASMSetSortIndices PCSPAISetMaxNew
PCFactorSetFill PCGASMSetType PCSPAISetNBSteps
PCFactorSetLevels PCGalerkinGetKSP PCSPAISetSp
PCFactorSetMatOrderingType PCGalerkinSetInterpolation PCSPAISetVerbose
PCFactorSetMatSolverPackage PCGalerkinSetRestriction PCSetApplicationContext
PCFactorSetPivotInBlocks PCGetApplicationContext PCSetCoordinates
PCFactorSetReuseFill PCGetDM PCSetDM
PCFactorSetReuseOrdering PCGetOperators PCSetDiagonalScale
PCFactorSetShiftAmount PCGetOperatorsSet PCSetOperators
PCFactorSetShiftType PCGetType PCSetType
PCFactorSetUpMatSolverPackage PCGetUseAmat PCSetUseAmat
Advanced - Setting more advanced options and customization
PCAINVCUSP PCGASMGetSubmatrices PCMGSetRestriction
PCASMCreateSubdomains PCGASMSetSubdomains PCMGSetRhs
PCASMCreateSubdomains2D PCGASMSetTotalSubdomains PCMGSetType
PCASMDestroySubdomains PCGetOptionsPrefix PCMGSetX
PCASMGetLocalSubdomains PCKSPGetKSP PCPFMG
PCASMGetLocalSubmatrices PCMGGetCoarseSolve PCRedistributeGetKSP
PCASMGetSubKSP PCMGGetInterpolation PCRedundantGetKSP
PCASMSetLocalSubdomains PCMGGetLevels PCRedundantGetOperators
PCASMSetTotalSubdomains PCMGGetRScale PCRedundantSetNumber
PCAppendOptionsPrefix PCMGGetRestriction PCRedundantSetScatter
PCBJacobiGetSubKSP PCMGGetSmoother PCRegister
PCComputeExplicitOperator PCMGGetSmootherDown PCRegisterAll
PCEXOTIC PCMGGetSmootherUp PCRichardsonConvergedReason
PCFactorGetMatrix PCMGMultiplicativeSetCycles PCSACUSP
PCFieldSplitGetSchurBlocks PCMGSetCycleType PCSHELL
PCFieldSplitGetSubKSP PCMGSetCyclesOnLevel PCSVD
PCFieldSplitSchurGetS PCMGSetInterpolation PCSetModifySubMatrices
PCFieldSplitSchurRestoreS PCMGSetNumberSmoothDown PCSetOptionsPrefix
PCGASMCreateLocalSubdomains PCMGSetNumberSmoothUp PCShellGetContext
PCGASMCreateSubdomains2D PCMGSetR PCShellSetContext
PCGASMGetSubKSP PCMGSetRScale PCSysPFMG
PCGASMGetSubdomains PCMGSetResidual
Developer - Interfaces intended primarily for library developers, not for typical applications programmers
PCApply PCCompositeSetType PCSetUp
PCApplyBAorAB PCCompositeSpecialSetAlpha PCSetUpOnBlocks
PCApplyBAorABTranspose PCCreate PCShellGetName
PCApplyRichardson PCDestroy PCShellSetApply
PCApplyRichardsonExists PCGAMGFinalizePackage PCShellSetApplyBA
PCApplySymmetricLeft PCGAMGInitializePackage PCShellSetApplyRichardson
PCApplySymmetricRight PCGetDiagonalScale PCShellSetApplyTranspose
PCApplyTranspose PCMGResidualDefault PCShellSetDestroy
PCApplyTransposeExists PCModifySubMatrices PCShellSetName
PCBDDCCreateFETIDPOperators PCPostSolve PCShellSetPostSolve
PCBDDCMatFETIDPGetRHS PCPreSolve PCShellSetPreSolve
PCBDDCMatFETIDPGetSolution PCReset PCShellSetSetUp
PCCompositeAddPC PCSetFromOptions PCShellSetView
PCCompositeGetPC PCSetInitialGuessNonzero PCView
No deprecated routines
None: Not yet cataloged
PCGetReusePreconditioner PCSetReusePreconditioner

Table of Contents