petsc-master 2016-09-28
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 PCGASMSetTotalSubdomains PCMGalerkinType
PCASMType PCGASMType PCNONE
PCBJACOBI PCICC PCPBJACOBI
PCCHOLESKY PCILU PCSOR
PCCompositeType PCJACOBI PCSPAI
PCEISENSTAT PCKaczmarz PCSide
PCExoticType PCLU PCTFS
PCFailedReason PCMGCycleType PCType
Intermediate - Setting options for algorithms and data structures
PCASMGetDMSubdomains PCFactorSetUpMatSolverPackage PCHYPRESetBetaPoissonMatrix
PCASMGetLocalType PCFactorSetUseInPlace PCHYPRESetDiscreteCurl
PCASMGetType PCFactorSetZeroPivot PCHYPRESetDiscreteGradient
PCASMSetDMSubdomains PCFieldSplitGetDMSplits PCHYPRESetEdgeConstantVectors
PCASMSetLocalType PCFieldSplitGetDiagUseAmat PCHYPRESetType
PCASMSetOverlap PCFieldSplitGetIS PCISSetSubdomainDiagonalScaling
PCASMSetSortIndices PCFieldSplitGetOffDiagUseAmat PCISSetSubdomainScalingFactor
PCASMSetType PCFieldSplitGetSchurPre PCISSetUseStiffnessScaling
PCBDDC PCFieldSplitGetType PCJacobiGetType
PCBDDCGetDirichletBoundaries PCFieldSplitSchurFactType PCJacobiGetUseAbs
PCBDDCGetDirichletBoundariesLocal PCFieldSplitSchurPreType PCJacobiSetType
PCBDDCGetNeumannBoundaries PCFieldSplitSetBlockSize PCJacobiSetUseAbs
PCBDDCGetNeumannBoundariesLocal PCFieldSplitSetDMSplits PCJacobiType
PCBDDCSetChangeOfBasisMat PCFieldSplitSetDiagUseAmat PCKSP
PCBDDCSetCoarseningRatio PCFieldSplitSetFields PCLSC
PCBDDCSetDirichletBoundaries PCFieldSplitSetIS PCLoad
PCBDDCSetDirichletBoundariesLocal PCFieldSplitSetOffDiagUseAmat PCMAT
PCBDDCSetDofsSplitting PCFieldSplitSetSchurFactType PCMG
PCBDDCSetDofsSplittingLocal PCFieldSplitSetSchurPre PCMGGetGalerkin
PCBDDCSetLevels PCFieldSplitSetType PCMGSetGalerkin
PCBDDCSetLocalAdjacencyGraph PCGALERKIN PCMGSetLevels
PCBDDCSetNeumannBoundaries PCGAMG PCML
PCBDDCSetNeumannBoundariesLocal PCGAMGASMSetUseAggs PCNN
PCBDDCSetPrimalVerticesLocalIS PCGAMGClassicalGetType PCPARMS
PCBJacobiGetLocalBlocks PCGAMGClassicalSetType PCPARMSGlobalType
PCBJacobiGetTotalBlocks PCGAMGGetType PCPARMSLocalType
PCBJacobiSetLocalBlocks PCGAMGSetCoarseEqLim PCPARMSSetFill
PCBJacobiSetTotalBlocks PCGAMGSetNSmooths PCPARMSSetGlobal
PCCOMPOSITE PCGAMGSetNlevels PCPARMSSetLocal
PCCP PCGAMGSetProcEqLim PCPARMSSetNonsymPerm
PCDiagonalScaleLeft PCGAMGSetRepartition PCPARMSSetSolveRestart
PCDiagonalScaleRight PCGAMGSetReuseInterpolation PCPARMSSetSolveTolerances
PCEisenstatGetNoDiagonalScaling PCGAMGSetSquareGraph PCPythonSetType
PCEisenstatGetOmega PCGAMGSetSymGraph PCREDISTRIBUTE
PCEisenstatSetNoDiagonalScaling PCGAMGSetThreshold PCREDUNDANT
PCEisenstatSetOmega PCGAMGSetType PCSORGetIterations
PCExoticSetType PCGAMGSetUseParallelCoarseGridSolve PCSORGetOmega
PCFIELDSPLIT PCGAMGType PCSORGetSymmetric
PCFactorGetAllowDiagonalFill PCGASMDestroySubdomains PCSORSetIterations
PCFactorGetLevels PCGASMGetUseDMSubdomains PCSORSetOmega
PCFactorGetMatSolverPackage PCGASMSetOverlap PCSORSetSymmetric
PCFactorGetShiftAmount PCGASMSetSortIndices PCSPAISetBlockSize
PCFactorGetShiftType PCGASMSetType PCSPAISetCacheSize
PCFactorGetUseInPlace PCGASMSetUseDMSubdomains PCSPAISetEpsilon
PCFactorGetZeroPivot PCGalerkinGetKSP PCSPAISetMax
PCFactorReorderForNonzeroDiagonal PCGalerkinSetInterpolation PCSPAISetMaxNew
PCFactorSetAllowDiagonalFill PCGalerkinSetRestriction PCSPAISetNBSteps
PCFactorSetColumnPivot PCGetApplicationContext PCSPAISetSp
PCFactorSetFill PCGetDM PCSPAISetVerbose
PCFactorSetLevels PCGetOperators PCSetApplicationContext
PCFactorSetMatOrderingType PCGetOperatorsSet PCSetCoordinates
PCFactorSetMatSolverPackage PCGetReusePreconditioner PCSetDM
PCFactorSetPivotInBlocks PCGetType PCSetDiagonalScale
PCFactorSetReuseFill PCGetUseAmat PCSetOperators
PCFactorSetReuseOrdering PCHYPRE PCSetReusePreconditioner
PCFactorSetShiftAmount PCHYPREGetType PCSetType
PCFactorSetShiftType PCHYPRESetAlphaPoissonMatrix PCSetUseAmat
Advanced - Setting more advanced options and customization
PCAINVCUSP PCGetOptionsPrefix PCRedundantGetKSP
PCASMCreateSubdomains PCGetSetUpFailedReason PCRedundantGetOperators
PCASMCreateSubdomains2D PCKSPGetKSP PCRedundantSetNumber
PCASMDestroySubdomains PCMGGetCoarseSolve PCRedundantSetScatter
PCASMGetLocalSubdomains PCMGGetInterpolation PCRegister
PCASMGetLocalSubmatrices PCMGGetLevels PCRegisterAll
PCASMGetSubKSP PCMGGetRScale PCRichardsonConvergedReason
PCASMGetSubMatType PCMGGetRestriction PCSACUSP
PCASMSetLocalSubdomains PCMGGetSmoother PCSHELL
PCASMSetSubMatType PCMGGetSmootherDown PCSVD
PCASMSetTotalSubdomains PCMGGetSmootherUp PCSetErrorIfFailure
PCAppendOptionsPrefix PCMGGetType PCSetModifySubMatrices
PCBJacobiGetSubKSP PCMGMultiplicativeSetCycles PCSetOptionsPrefix
PCComputeExplicitOperator PCMGSetCycleType PCShellGetContext
PCEXOTIC PCMGSetCyclesOnLevel PCShellSetContext
PCFactorGetMatrix PCMGSetInterpolation PCSysPFMG
PCFieldSplitGetSchurBlocks PCMGSetNumberSmooth PCTELESCOPE
PCFieldSplitGetSubKSP PCMGSetNumberSmoothDown PCTelescopeGetDM
PCFieldSplitRestrictIS PCMGSetNumberSmoothUp PCTelescopeGetIgnoreDM
PCFieldSplitSchurGetS PCMGSetR PCTelescopeGetIgnoreKSPComputeOperators
PCFieldSplitSchurRestoreS PCMGSetRScale PCTelescopeGetKSP
PCGAMGRegister PCMGSetResidual PCTelescopeGetReductionFactor
PCGASMCreateSubdomains PCMGSetRestriction PCTelescopeGetSubcommType
PCGASMCreateSubdomains2D PCMGSetRhs PCTelescopeSetIgnoreDM
PCGASMGetSubKSP PCMGSetType PCTelescopeSetIgnoreKSPComputeOperators
PCGASMGetSubdomains PCMGSetX PCTelescopeSetReductionFactor
PCGASMGetSubmatrices PCPFMG PCTelescopeSetSubcommType
PCGASMSetSubdomains PCRedistributeGetKSP
Developer - Interfaces intended primarily for library developers, not for typical applications programmers
PCApply PCCompositeGetType PCSetUpOnBlocks
PCApplyBAorAB PCCompositeSetType PCShellGetName
PCApplyBAorABTranspose PCCompositeSpecialSetAlpha PCShellSetApply
PCApplyRichardson PCCreate PCShellSetApplyBA
PCApplyRichardsonExists PCDestroy PCShellSetApplyRichardson
PCApplySymmetricLeft PCGAMGFinalizePackage PCShellSetApplySymmetricLeft
PCApplySymmetricRight PCGAMGInitializePackage PCShellSetApplySymmetricRight
PCApplyTranspose PCGetDiagonalScale PCShellSetApplyTranspose
PCApplyTransposeExists PCMGResidualDefault PCShellSetDestroy
PCBDDCCreateFETIDPOperators PCModifySubMatrices PCShellSetName
PCBDDCMatFETIDPGetRHS PCPostSolve PCShellSetPostSolve
PCBDDCMatFETIDPGetSolution PCPreSolve PCShellSetPreSolve
PCCompositeAddPC PCReset PCShellSetSetUp
PCCompositeGetNumberPC PCSetFromOptions PCShellSetView
PCCompositeGetPC PCSetUp PCView
No deprecated routines

Table of Contents