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