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