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

Table of Contents