petsc-master 2019-10-23
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 PCFactorSetUseInPlace PCHPDDMSetCoarseCorrectionType
PCASMGetLocalType PCFactorSetZeroPivot PCHYPRE
PCASMGetType PCFieldSplitGetDMSplits PCHYPREGetType
PCASMSetDMSubdomains PCFieldSplitGetDetectSaddlePoint PCHYPRESetAlphaPoissonMatrix
PCASMSetLocalType PCFieldSplitGetDiagUseAmat PCHYPRESetBetaPoissonMatrix
PCASMSetOverlap PCFieldSplitGetIS PCHYPRESetDiscreteCurl
PCASMSetSortIndices PCFieldSplitGetISByIndex PCHYPRESetDiscreteGradient
PCASMSetType PCFieldSplitGetOffDiagUseAmat PCHYPRESetEdgeConstantVectors
PCBDDC PCFieldSplitGetSchurPre PCHYPRESetInterpolations
PCBDDCGetDirichletBoundaries PCFieldSplitGetType PCHYPRESetType
PCBDDCGetDirichletBoundariesLocal PCFieldSplitSchurFactType PCISSetSubdomainDiagonalScaling
PCBDDCGetNeumannBoundaries PCFieldSplitSchurPreType PCISSetSubdomainScalingFactor
PCBDDCGetNeumannBoundariesLocal PCFieldSplitSetBlockSize PCISSetUseStiffnessScaling
PCBDDCGetPrimalVerticesIS PCFieldSplitSetDMSplits PCJacobiGetType
PCBDDCGetPrimalVerticesLocalIS PCFieldSplitSetDetectSaddlePoint PCJacobiGetUseAbs
PCBDDCInterfaceExtType PCFieldSplitSetDiagUseAmat PCJacobiSetType
PCBDDCSetChangeOfBasisMat PCFieldSplitSetFields PCJacobiSetUseAbs
PCBDDCSetCoarseningRatio PCFieldSplitSetGKBDelay PCJacobiType
PCBDDCSetDirichletBoundaries PCFieldSplitSetGKBMaxit PCKSP
PCBDDCSetDirichletBoundariesLocal PCFieldSplitSetGKBNu PCLMVM
PCBDDCSetDofsSplitting PCFieldSplitSetGKBTol PCLMVMClearIS
PCBDDCSetDofsSplittingLocal PCFieldSplitSetIS PCLMVMGetMatLMVM
PCBDDCSetLevels PCFieldSplitSetOffDiagUseAmat PCLMVMSetIS
PCBDDCSetLocalAdjacencyGraph PCFieldSplitSetSchurFactType PCLMVMSetMatLMVM
PCBDDCSetNeumannBoundaries PCFieldSplitSetSchurPre PCLSC
PCBDDCSetNeumannBoundariesLocal PCFieldSplitSetSchurScale PCLoad
PCBDDCSetPrimalVerticesIS PCFieldSplitSetType PCMAT
PCBDDCSetPrimalVerticesLocalIS PCGALERKIN PCMG
PCBJacobiGetLocalBlocks PCGAMG PCMGGetGalerkin
PCBJacobiGetTotalBlocks PCGAMGASMSetUseAggs PCMGSetGalerkin
PCBJacobiSetLocalBlocks PCGAMGClassicalGetType PCMGSetLevels
PCBJacobiSetTotalBlocks PCGAMGClassicalSetType PCML
PCCOMPOSITE PCGAMGGetType PCNN
PCCP PCGAMGLayoutType PCPARMS
PCDEFLATION PCGAMGSetCoarseEqLim PCPARMSGlobalType
PCDeflationSetCorrectionFactor PCGAMGSetCoarseGridLayoutType PCPARMSLocalType
PCDeflationSetInitOnly PCGAMGSetCpuPinCoarseGrids PCPARMSSetFill
PCDeflationSetLevels PCGAMGSetNSmooths PCPARMSSetGlobal
PCDeflationSetReductionFactor PCGAMGSetNlevels PCPARMSSetLocal
PCDeflationSetSpace PCGAMGSetProcEqLim PCPARMSSetNonsymPerm
PCDeflationSetSpaceToCompute PCGAMGSetRepartition PCPARMSSetSolveRestart
PCDeflationSpaceType PCGAMGSetReuseInterpolation PCPARMSSetSolveTolerances
PCDiagonalScaleLeft PCGAMGSetSquareGraph PCPATCH
PCDiagonalScaleRight PCGAMGSetSymGraph PCPythonSetType
PCEisenstatGetNoDiagonalScaling PCGAMGSetThreshold PCREDISTRIBUTE
PCEisenstatGetOmega PCGAMGSetType PCREDUNDANT
PCEisenstatSetNoDiagonalScaling PCGAMGSetUseParallelCoarseGridSolve PCSORGetIterations
PCEisenstatSetOmega PCGAMGType PCSORGetOmega
PCExoticSetType PCGASMDestroySubdomains PCSORGetSymmetric
PCFIELDSPLIT PCGASMGetUseDMSubdomains PCSORSetIterations
PCFactorGetAllowDiagonalFill PCGASMSetOverlap PCSORSetOmega
PCFactorGetLevels PCGASMSetSortIndices PCSORSetSymmetric
PCFactorGetMatSolverType PCGASMSetType PCSPAISetBlockSize
PCFactorGetShiftAmount PCGASMSetUseDMSubdomains PCSPAISetCacheSize
PCFactorGetShiftType PCGalerkinGetKSP PCSPAISetEpsilon
PCFactorGetUseInPlace PCGalerkinSetComputeSubmatrix PCSPAISetMax
PCFactorGetZeroPivot PCGalerkinSetInterpolation PCSPAISetMaxNew
PCFactorReorderForNonzeroDiagonal PCGalerkinSetRestriction PCSPAISetNBSteps
PCFactorSetAllowDiagonalFill PCGetApplicationContext PCSPAISetSp
PCFactorSetColumnPivot PCGetDM PCSPAISetVerbose
PCFactorSetFill PCGetOperators PCSetApplicationContext
PCFactorSetLevels PCGetOperatorsSet PCSetCoordinates
PCFactorSetMatOrderingType PCGetReusePreconditioner PCSetDM
PCFactorSetMatSolverType PCGetType PCSetDiagonalScale
PCFactorSetPivotInBlocks PCGetUseAmat PCSetOperators
PCFactorSetReuseFill PCHPDDM PCSetReusePreconditioner
PCFactorSetReuseOrdering PCHPDDMCoarseCorrectionType PCSetType
PCFactorSetShiftAmount PCHPDDMGetCoarseCorrectionType PCSetUseAmat
PCFactorSetShiftType PCHPDDMHasNeumannMat
PCFactorSetUpMatSolverType PCHPDDMSetAuxiliaryMat
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