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