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

Table of Contents