petsc-3.12.1 2019-10-22
Report Typos and Errors

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

Table of Contents