PETSc version v3.16.0-284-g50ae73ce4b

Preconditioners - PC:

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 PCHMGSetCoarseningComponent PCMGalerkinType
PCASM PCHMGSetInnerPCType PCNONE
PCASMType PCHMGSetReuseInterpolation PCPBJACOBI
PCBJACOBI PCHMGSetUseSubspaceCoarsening PCPatchConstructType
PCCHOLESKY PCHMGUseMatMAIJ PCQR
PCCompositeType PCICC PCSOR
PCEISENSTAT PCILU PCSPAI
PCExoticType PCJACOBI PCSide
PCFailedReason PCKaczmarz PCTFS
PCGASM PCLU PCType
PCGASMSetTotalSubdomains PCMGCoarseSpaceType PCVPBJACOBI
PCGASMType PCMGCycleType
PCHMG PCMGType
Intermediate - Setting options for algorithms and data structures
PCASMGetDMSubdomains PCFieldSplitGetDiagUseAmat PCHYPREGetType
PCASMGetLocalType PCFieldSplitGetIS PCHYPRESetAlphaPoissonMatrix
PCASMGetType PCFieldSplitGetISByIndex PCHYPRESetBetaPoissonMatrix
PCASMSetDMSubdomains PCFieldSplitGetOffDiagUseAmat PCHYPRESetDiscreteCurl
PCASMSetLocalType PCFieldSplitGetSchurPre PCHYPRESetDiscreteGradient
PCASMSetOverlap PCFieldSplitGetType PCHYPRESetEdgeConstantVectors
PCASMSetSortIndices PCFieldSplitSchurFactType PCHYPRESetInterpolations
PCASMSetType PCFieldSplitSchurPreType PCHYPRESetType
PCBDDC PCFieldSplitSetBlockSize PCISSetSubdomainDiagonalScaling
PCBDDCGetDirichletBoundaries PCFieldSplitSetDMSplits PCISSetSubdomainScalingFactor
PCBDDCGetDirichletBoundariesLocal PCFieldSplitSetDetectSaddlePoint PCISSetUseStiffnessScaling
PCBDDCGetNeumannBoundaries PCFieldSplitSetDiagUseAmat PCJacobiGetFixDiagonal
PCBDDCGetNeumannBoundariesLocal PCFieldSplitSetFields PCJacobiGetType
PCBDDCGetPrimalVerticesIS PCFieldSplitSetGKBDelay PCJacobiGetUseAbs
PCBDDCGetPrimalVerticesLocalIS PCFieldSplitSetGKBMaxit PCJacobiSetFixDiagonal
PCBDDCInterfaceExtType PCFieldSplitSetGKBNu PCJacobiSetType
PCBDDCSetChangeOfBasisMat PCFieldSplitSetGKBTol PCJacobiSetUseAbs
PCBDDCSetCoarseningRatio PCFieldSplitSetIS PCJacobiType
PCBDDCSetDirichletBoundaries PCFieldSplitSetOffDiagUseAmat PCKSP
PCBDDCSetDirichletBoundariesLocal PCFieldSplitSetSchurFactType PCLMVM
PCBDDCSetDofsSplitting PCFieldSplitSetSchurPre PCLMVMClearIS
PCBDDCSetDofsSplittingLocal PCFieldSplitSetSchurScale PCLMVMGetMatLMVM
PCBDDCSetLevels PCFieldSplitSetType PCLMVMSetIS
PCBDDCSetLocalAdjacencyGraph PCGALERKIN PCLMVMSetMatLMVM
PCBDDCSetNeumannBoundaries PCGAMG PCLSC
PCBDDCSetNeumannBoundariesLocal PCGAMGASMSetUseAggs PCLoad
PCBDDCSetPrimalVerticesIS PCGAMGClassicalGetType PCMAT
PCBDDCSetPrimalVerticesLocalIS PCGAMGClassicalSetType PCMG
PCBJacobiGetLocalBlocks PCGAMGGetType PCMGGetAdaptCR
PCBJacobiGetTotalBlocks PCGAMGLayoutType PCMGGetAdaptInterpolation
PCBJacobiSetLocalBlocks PCGAMGSetCoarseEqLim PCMGGetGalerkin
PCBJacobiSetTotalBlocks PCGAMGSetCoarseGridLayoutType PCMGSetAdaptCR
PCCOMPOSITE PCGAMGSetCpuPinCoarseGrids PCMGSetAdaptInterpolation
PCCP PCGAMGSetEigenvalues PCMGSetGalerkin
PCDEFLATION PCGAMGSetEstEigKSPMaxIt PCMGSetLevels
PCDeflationSetCorrectionFactor PCGAMGSetEstEigKSPType PCML
PCDeflationSetInitOnly PCGAMGSetNSmooths PCNN
PCDeflationSetLevels PCGAMGSetNlevels PCPARMS
PCDeflationSetReductionFactor PCGAMGSetProcEqLim PCPARMSGlobalType
PCDeflationSetSpace PCGAMGSetRankReductionFactors PCPARMSLocalType
PCDeflationSetSpaceToCompute PCGAMGSetRepartition PCPARMSSetFill
PCDeflationSpaceType PCGAMGSetReuseInterpolation PCPARMSSetGlobal
PCDiagonalScaleLeft PCGAMGSetSquareGraph PCPARMSSetLocal
PCDiagonalScaleRight PCGAMGSetSymGraph PCPARMSSetNonsymPerm
PCEisenstatGetNoDiagonalScaling PCGAMGSetThreshold PCPARMSSetSolveRestart
PCEisenstatGetOmega PCGAMGSetType PCPARMSSetSolveTolerances
PCEisenstatSetNoDiagonalScaling PCGAMGSetUseParallelCoarseGridSolve PCPATCH
PCEisenstatSetOmega PCGAMGSetUseSAEstEig PCPythonSetType
PCExoticSetType PCGAMGType PCREDISTRIBUTE
PCFIELDSPLIT PCGASMDestroySubdomains PCREDUNDANT
PCFactorGetAllowDiagonalFill PCGASMGetUseDMSubdomains PCSORGetIterations
PCFactorGetLevels PCGASMSetOverlap PCSORGetOmega
PCFactorGetMatSolverType PCGASMSetSortIndices PCSORGetSymmetric
PCFactorGetShiftAmount PCGASMSetType PCSORSetIterations
PCFactorGetShiftType PCGASMSetUseDMSubdomains PCSORSetOmega
PCFactorGetUseInPlace PCGalerkinGetKSP PCSORSetSymmetric
PCFactorGetZeroPivot PCGalerkinSetComputeSubmatrix PCSPAISetBlockSize
PCFactorReorderForNonzeroDiagonal PCGalerkinSetInterpolation PCSPAISetCacheSize
PCFactorSetAllowDiagonalFill PCGalerkinSetRestriction PCSPAISetEpsilon
PCFactorSetColumnPivot PCGetApplicationContext PCSPAISetMax
PCFactorSetDropTolerance PCGetDM PCSPAISetMaxNew
PCFactorSetFill PCGetOperators PCSPAISetNBSteps
PCFactorSetLevels PCGetOperatorsSet PCSPAISetSp
PCFactorSetMatOrderingType PCGetReusePreconditioner PCSPAISetVerbose
PCFactorSetMatSolverType PCGetType PCSetApplicationContext
PCFactorSetPivotInBlocks PCGetUseAmat PCSetCoordinates
PCFactorSetReuseFill PCHPDDM PCSetDM
PCFactorSetReuseOrdering PCHPDDMCoarseCorrectionType PCSetDiagonalScale
PCFactorSetShiftAmount PCHPDDMFinalizePackage PCSetOperators
PCFactorSetShiftType PCHPDDMGetCoarseCorrectionType PCSetReusePreconditioner
PCFactorSetUpMatSolverType PCHPDDMHasNeumannMat PCSetType
PCFactorSetUseInPlace PCHPDDMInitializePackage PCSetUseAmat
PCFactorSetZeroPivot PCHPDDMSetAuxiliaryMat PCViewFromOptions
PCFieldSplitGetDMSplits PCHPDDMSetCoarseCorrectionType
PCFieldSplitGetDetectSaddlePoint PCHYPRE
Advanced - Setting more advanced options and customization
PCASMCreateSubdomains PCGetInterpolations PCPFMG
PCASMCreateSubdomains2D PCGetOptionsPrefix PCPatchSetComputeFunction
PCASMDestroySubdomains PCHPDDMGetComplexities PCPatchSetComputeFunctionInteriorFacets
PCASMGetLocalSubdomains PCHPDDMGetSTShareSubKSP PCPatchSetComputeOperator
PCASMGetLocalSubmatrices PCHPDDMSetRHSMat PCPatchSetComputeOperatorInteriorFacets
PCASMGetSubKSP PCHPDDMShellApply PCRedistributeGetKSP
PCASMGetSubMatType PCHPDDMShellMatApply PCRedundantGetKSP
PCASMSetLocalSubdomains PCKSPGetKSP PCRedundantGetOperators
PCASMSetSubMatType PCKSPSetKSP PCRedundantSetNumber
PCASMSetTotalSubdomains PCMGGetCoarseSolve PCRedundantSetScatter
PCAppendOptionsPrefix PCMGGetCoarseSpaceConstructor PCRegister
PCBDDCSetDiscreteGradient PCMGGetInjection PCRegisterAll
PCBDDCSetDivergenceMat PCMGGetInterpolation PCRichardsonConvergedReason
PCBJacobiGetSubKSP PCMGGetLevels PCRowScalingViennaCL
PCCHOWILUViennaCL PCMGGetRScale PCSAViennaCL
PCComputeOperator PCMGGetRestriction PCSHELL
PCDeflationGetCoarseKSP PCMGGetSmoother PCSVD
PCDeflationGetPC PCMGGetSmootherDown PCSetErrorIfFailure
PCEXOTIC PCMGGetSmootherUp PCSetFailedReason
PCFactorGetMatrix PCMGGetType PCSetModifySubMatrices
PCFieldSplitGetSchurBlocks PCMGMultiplicativeSetCycles PCSetOptionsPrefix
PCFieldSplitGetSubKSP PCMGRegisterCoarseSpaceConstructor PCShellGetContext
PCFieldSplitRestrictIS PCMGSetCycleType PCShellSetContext
PCFieldSplitSchurGetS PCMGSetCycleTypeOnLevel PCSysPFMG
PCFieldSplitSchurGetSubKSP PCMGSetDistinctSmoothUp PCTELESCOPE
PCFieldSplitSchurRestoreS PCMGSetInjection PCTelescopeGetDM
PCGAMGRegister PCMGSetInterpolation PCTelescopeGetIgnoreDM
PCGAMGSetThresholdScale PCMGSetNumberSmooth PCTelescopeGetIgnoreKSPComputeOperators
PCGASMCreateSubdomains PCMGSetOperators PCTelescopeGetKSP
PCGASMCreateSubdomains2D PCMGSetR PCTelescopeGetReductionFactor
PCGASMGetSubKSP PCMGSetRScale PCTelescopeGetSubcommType
PCGASMGetSubdomains PCMGSetResidual PCTelescopeGetUseCoarseDM
PCGASMGetSubmatrices PCMGSetResidualTranspose PCTelescopeSetIgnoreDM
PCGASMSetSubdomains PCMGSetRestriction PCTelescopeSetIgnoreKSPComputeOperators
PCGetCoarseOperators PCMGSetRhs PCTelescopeSetReductionFactor
PCGetFailedReason PCMGSetType PCTelescopeSetSubcommType
PCGetFailedReasonRank PCMGSetX PCTelescopeSetUseCoarseDM
Developer - Interfaces intended primarily for library developers, not for typical applications programmers
PCApply PCCompositeSetType PCSetFromOptions
PCApplyBAorAB PCCompositeSpecialSetAlpha PCSetPreSolve
PCApplyBAorABTranspose PCCreate PCSetUp
PCApplyRichardson PCDeflationSetCoarseMat PCSetUpOnBlocks
PCApplyRichardsonExists PCDeflationSetProjectionNullSpaceMat PCShellGetName
PCApplySymmetricLeft PCDestroy PCShellSetApply
PCApplySymmetricRight PCGAMGFilterGraph PCShellSetApplyBA
PCApplyTranspose PCGAMGFinalizePackage PCShellSetApplyRichardson
PCApplyTransposeExists PCGAMGInitializePackage PCShellSetApplySymmetricLeft
PCBDDCCreateFETIDPOperators PCGetDiagonalScale PCShellSetApplySymmetricRight
PCBDDCFinalizePackage PCMGMatResidualDefault PCShellSetApplyTranspose
PCBDDCInitializePackage PCMGMatResidualTransposeDefault PCShellSetDestroy
PCBDDCMatFETIDPGetRHS PCMGResidualDefault PCShellSetMatApply
PCBDDCMatFETIDPGetSolution PCMGResidualTransposeDefault PCShellSetName
PCCompositeAddPC PCMatApply PCShellSetPostSolve
PCCompositeAddPCType PCModifySubMatrices PCShellSetPreSolve
PCCompositeGetNumberPC PCPostSolve PCShellSetSetUp
PCCompositeGetPC PCPreSolve PCShellSetView
PCCompositeGetType PCReset PCView
No deprecated routines

Table of Contents