petsc-master 2020-03-31
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 PCPatchSetComputeOperator
PCASMCreateSubdomains2D PCGetInterpolations PCPatchSetComputeOperatorInteriorFacets
PCASMDestroySubdomains PCGetOptionsPrefix PCRedistributeGetKSP
PCASMGetLocalSubdomains PCHPDDMSetRHSMat PCRedundantGetKSP
PCASMGetLocalSubmatrices PCHPDDMShellApply PCRedundantGetOperators
PCASMGetSubKSP PCKSPGetKSP PCRedundantSetNumber
PCASMGetSubMatType PCKSPSetKSP PCRedundantSetScatter
PCASMSetLocalSubdomains PCMGGetCoarseSolve PCRegister
PCASMSetSubMatType PCMGGetInjection PCRegisterAll
PCASMSetTotalSubdomains PCMGGetInterpolation PCRichardsonConvergedReason
PCAppendOptionsPrefix PCMGGetLevels PCRowScalingViennaCL
PCBDDCSetDiscreteGradient PCMGGetRScale PCSAViennaCL
PCBDDCSetDivergenceMat PCMGGetRestriction PCSHELL
PCBJacobiGetSubKSP PCMGGetSmoother PCSVD
PCCHOWILUViennaCL PCMGGetSmootherDown PCSetErrorIfFailure
PCComputeOperator PCMGGetSmootherUp PCSetModifySubMatrices
PCDeflationGetCoarseKSP PCMGGetType PCSetOptionsPrefix
PCDeflationGetPC PCMGMultiplicativeSetCycles PCShellGetContext
PCEXOTIC PCMGSetCycleType PCShellSetContext
PCFactorGetMatrix PCMGSetCycleTypeOnLevel PCSysPFMG
PCFieldSplitGetSchurBlocks PCMGSetDistinctSmoothUp PCTELESCOPE
PCFieldSplitGetSubKSP PCMGSetInjection PCTelescopeGetDM
PCFieldSplitRestrictIS PCMGSetInterpolation PCTelescopeGetIgnoreDM
PCFieldSplitSchurGetS PCMGSetNumberSmooth PCTelescopeGetIgnoreKSPComputeOperators
PCFieldSplitSchurGetSubKSP PCMGSetOperators PCTelescopeGetKSP
PCFieldSplitSchurRestoreS PCMGSetR PCTelescopeGetReductionFactor
PCGAMGRegister PCMGSetRScale PCTelescopeGetSubcommType
PCGAMGSetThresholdScale PCMGSetResidual PCTelescopeGetUseCoarseDM
PCGASMCreateSubdomains PCMGSetRestriction PCTelescopeSetIgnoreDM
PCGASMCreateSubdomains2D PCMGSetRhs PCTelescopeSetIgnoreKSPComputeOperators
PCGASMGetSubKSP PCMGSetType PCTelescopeSetReductionFactor
PCGASMGetSubdomains PCMGSetX PCTelescopeSetSubcommType
PCGASMGetSubmatrices PCPFMG PCTelescopeSetUseCoarseDM
PCGASMSetSubdomains PCPatchSetComputeFunction
PCGetCoarseOperators 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

Table of Contents