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