xref: /petsc/include/petscpc.h (revision 77a3c058ac268fd01aa3de55bca5e82364c6a5ac)
1d03aef70SBarry Smith /*
237f753daSBarry Smith       Preconditioner module.
3d03aef70SBarry Smith */
40a835dfdSSatish Balay #if !defined(__PETSCPC_H)
50a835dfdSSatish Balay #define __PETSCPC_H
61e25c274SJed Brown #include <petscmat.h>
7*77a3c058SKarl Rupp #include <petscdmtypes.h>
8b0753f9dSMatthew G. Knepley #include <petscpctypes.h>
9d03aef70SBarry Smith 
10607a6623SBarry Smith PETSC_EXTERN PetscErrorCode PCInitializePackage(void);
111dbb0a54SBarry Smith 
12eec0b4cfSBarry Smith /*
13eec0b4cfSBarry Smith     PCList contains the list of preconditioners currently registered
14bdf89e91SBarry Smith    These are added with PCRegister()
15eec0b4cfSBarry Smith */
16140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList PCList;
1782bf6240SBarry Smith 
18123ea438SMatthew Knepley /* Logging support */
19014dd563SJed Brown PETSC_EXTERN PetscClassId PC_CLASSID;
20123ea438SMatthew Knepley 
219d8081ecSMatthew G. Knepley /* Arrays of names for options in implementation PCs */
229d8081ecSMatthew G. Knepley PETSC_EXTERN const char *const *const PCSides;
239d8081ecSMatthew G. Knepley PETSC_EXTERN const char *const PCJacobiTypes[];
249d8081ecSMatthew G. Knepley PETSC_EXTERN const char *const PCASMTypes[];
259d8081ecSMatthew G. Knepley PETSC_EXTERN const char *const PCGASMTypes[];
269d8081ecSMatthew G. Knepley PETSC_EXTERN const char *const PCCompositeTypes[];
279d8081ecSMatthew G. Knepley PETSC_EXTERN const char *const PCFieldSplitSchurPreTypes[];
289d8081ecSMatthew G. Knepley PETSC_EXTERN const char *const PCFieldSplitSchurFactTypes[];
299d8081ecSMatthew G. Knepley PETSC_EXTERN const char *const PCPARMSGlobalTypes[];
309d8081ecSMatthew G. Knepley PETSC_EXTERN const char *const PCPARMSLocalTypes[];
319d8081ecSMatthew G. Knepley PETSC_EXTERN const char *const PCMGTypes[];
329d8081ecSMatthew G. Knepley PETSC_EXTERN const char *const PCMGCycleTypes[];
339d8081ecSMatthew G. Knepley PETSC_EXTERN const char *const PCMGGalerkinTypes[];
349d8081ecSMatthew G. Knepley PETSC_EXTERN const char *const PCExoticTypes[];
359d8081ecSMatthew G. Knepley PETSC_EXTERN const char *const PCPatchConstructTypes[];
369d8081ecSMatthew G. Knepley PETSC_EXTERN const char *const PCFailedReasons[];
379d8081ecSMatthew G. Knepley 
38014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCCreate(MPI_Comm,PC*);
3919fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode PCSetType(PC,PCType);
40c60c7ad4SBarry Smith PETSC_EXTERN PetscErrorCode PCGetType(PC,PCType*);
41014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCSetUp(PC);
428c1cd74cSHong Zhang PETSC_EXTERN PetscErrorCode PCGetSetUpFailedReason(PC,PCFailedReason*);
43014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCSetUpOnBlocks(PC);
44014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCApply(PC,Vec,Vec);
45014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCApplySymmetricLeft(PC,Vec,Vec);
46014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCApplySymmetricRight(PC,Vec,Vec);
47014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCApplyBAorAB(PC,PCSide,Vec,Vec,Vec);
48014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCApplyTranspose(PC,Vec,Vec);
49014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCApplyTransposeExists(PC,PetscBool *);
50014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCApplyBAorABTranspose(PC,PCSide,Vec,Vec,Vec);
5123ee1639SBarry Smith PETSC_EXTERN PetscErrorCode PCSetReusePreconditioner(PC,PetscBool);
52c60c7ad4SBarry Smith PETSC_EXTERN PetscErrorCode PCGetReusePreconditioner(PC,PetscBool*);
53422a814eSBarry Smith PETSC_EXTERN PetscErrorCode PCSetErrorIfFailure(PC,PetscBool);
544d0a8057SBarry Smith 
5555849f57SBarry Smith #define PC_FILE_CLASSID 1211222
5655849f57SBarry Smith 
57014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCApplyRichardson(PC,Vec,Vec,Vec,PetscReal,PetscReal,PetscReal,PetscInt,PetscBool ,PetscInt*,PCRichardsonConvergedReason*);
58014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCApplyRichardsonExists(PC,PetscBool *);
5949517cdeSBarry Smith PETSC_EXTERN PetscErrorCode PCSetUseAmat(PC,PetscBool);
6049517cdeSBarry Smith PETSC_EXTERN PetscErrorCode PCGetUseAmat(PC,PetscBool*);
6184cb2905SBarry Smith 
6284cb2905SBarry Smith 
63bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode PCRegister(const char[],PetscErrorCode(*)(PC));
6430de9b25SBarry Smith 
65014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCReset(PC);
66014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCDestroy(PC*);
67014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCSetFromOptions(PC);
6814c91fddSBarry Smith 
69014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCFactorGetMatrix(PC,Mat*);
70014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCSetModifySubMatrices(PC,PetscErrorCode(*)(PC,PetscInt,const IS[],const IS[],Mat[],void*),void*);
71014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCModifySubMatrices(PC,PetscInt,const IS[],const IS[],Mat[],void*);
725b116368SBarry Smith 
7323ee1639SBarry Smith PETSC_EXTERN PetscErrorCode PCSetOperators(PC,Mat,Mat);
7423ee1639SBarry Smith PETSC_EXTERN PetscErrorCode PCGetOperators(PC,Mat*,Mat*);
75014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCGetOperatorsSet(PC,PetscBool *,PetscBool *);
764b0e389bSBarry Smith 
77014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCView(PC,PetscViewer);
7855849f57SBarry Smith PETSC_EXTERN PetscErrorCode PCLoad(PC,PetscViewer);
79685405a1SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PCViewFromOptions(PC A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
807bc3d0afSSatish Balay 
81014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCSetOptionsPrefix(PC,const char[]);
82014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCAppendOptionsPrefix(PC,const char[]);
83014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCGetOptionsPrefix(PC,const char*[]);
848ed539a5SBarry Smith 
85014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCComputeExplicitOperator(PC,Mat*);
8671601f6fSBarry Smith 
87d6913704SBarry Smith /*
88d6913704SBarry Smith       These are used to provide extra scaling of preconditioned
890f3b3ca1SHong Zhang    operator for time-stepping schemes like in SUNDIALS
90d6913704SBarry Smith */
91014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCGetDiagonalScale(PC,PetscBool *);
92014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCDiagonalScaleLeft(PC,Vec,Vec);
93014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCDiagonalScaleRight(PC,Vec,Vec);
94014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCSetDiagonalScale(PC,Vec);
95d6913704SBarry Smith 
96f02e8f50SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PCSetDM(PC,DM);
97f02e8f50SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PCGetDM(PC,DM*);
98f02e8f50SMatthew G. Knepley 
99f02e8f50SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PCSetCoordinates(PC,PetscInt,PetscInt,PetscReal*);
100f02e8f50SMatthew G. Knepley 
101f02e8f50SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PCSetApplicationContext(PC,void*);
102f02e8f50SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PCGetApplicationContext(PC,void*);
103f02e8f50SMatthew G. Knepley 
10484cb2905SBarry Smith /* ------------- options specific to particular preconditioners --------- */
105329f5518SBarry Smith 
106baa89ecbSBarry Smith PETSC_EXTERN PetscErrorCode PCJacobiSetType(PC,PCJacobiType);
107baa89ecbSBarry Smith PETSC_EXTERN PetscErrorCode PCJacobiGetType(PC,PCJacobiType*);
108baa89ecbSBarry Smith PETSC_EXTERN PetscErrorCode PCJacobiSetUseAbs(PC,PetscBool);
109baa89ecbSBarry Smith PETSC_EXTERN PetscErrorCode PCJacobiGetUseAbs(PC,PetscBool*);
110014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCSORSetSymmetric(PC,MatSORType);
111c60c7ad4SBarry Smith PETSC_EXTERN PetscErrorCode PCSORGetSymmetric(PC,MatSORType*);
112014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCSORSetOmega(PC,PetscReal);
113c60c7ad4SBarry Smith PETSC_EXTERN PetscErrorCode PCSORGetOmega(PC,PetscReal*);
114014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCSORSetIterations(PC,PetscInt,PetscInt);
115c60c7ad4SBarry Smith PETSC_EXTERN PetscErrorCode PCSORGetIterations(PC,PetscInt*,PetscInt*);
116d03aef70SBarry Smith 
117014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCEisenstatSetOmega(PC,PetscReal);
118c60c7ad4SBarry Smith PETSC_EXTERN PetscErrorCode PCEisenstatGetOmega(PC,PetscReal*);
119c60c7ad4SBarry Smith PETSC_EXTERN PetscErrorCode PCEisenstatSetNoDiagonalScaling(PC,PetscBool);
120c60c7ad4SBarry Smith PETSC_EXTERN PetscErrorCode PCEisenstatGetNoDiagonalScaling(PC,PetscBool*);
121421c37bdSBarry Smith 
122014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCBJacobiSetTotalBlocks(PC,PetscInt,const PetscInt[]);
123c60c7ad4SBarry Smith PETSC_EXTERN PetscErrorCode PCBJacobiGetTotalBlocks(PC,PetscInt*,const PetscInt*[]);
124014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCBJacobiSetLocalBlocks(PC,PetscInt,const PetscInt[]);
125c60c7ad4SBarry Smith PETSC_EXTERN PetscErrorCode PCBJacobiGetLocalBlocks(PC,PetscInt*,const PetscInt*[]);
1261eb62cbbSBarry Smith 
127014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCShellSetApply(PC,PetscErrorCode (*)(PC,Vec,Vec));
1281b581b66SBarry Smith PETSC_EXTERN PetscErrorCode PCShellSetApplySymmetricLeft(PC,PetscErrorCode (*)(PC,Vec,Vec));
1291b581b66SBarry Smith PETSC_EXTERN PetscErrorCode PCShellSetApplySymmetricRight(PC,PetscErrorCode (*)(PC,Vec,Vec));
130014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCShellSetApplyBA(PC,PetscErrorCode (*)(PC,PCSide,Vec,Vec,Vec));
131014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCShellSetApplyTranspose(PC,PetscErrorCode (*)(PC,Vec,Vec));
132014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCShellSetSetUp(PC,PetscErrorCode (*)(PC));
133014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCShellSetApplyRichardson(PC,PetscErrorCode (*)(PC,Vec,Vec,Vec,PetscReal,PetscReal,PetscReal,PetscInt,PetscBool ,PetscInt*,PCRichardsonConvergedReason*));
134014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCShellSetView(PC,PetscErrorCode (*)(PC,PetscViewer));
135014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCShellSetDestroy(PC,PetscErrorCode (*)(PC));
136014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCShellSetContext(PC,void*);
137c60c7ad4SBarry Smith PETSC_EXTERN PetscErrorCode PCShellGetContext(PC,void**);
138014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCShellSetName(PC,const char[]);
139014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCShellGetName(PC,const char*[]);
140aabeff55SBarry Smith 
141014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCFactorSetZeroPivot(PC,PetscReal);
142d90ac83dSHong Zhang 
143014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCFactorSetShiftType(PC,MatFactorShiftType);
144014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCFactorSetShiftAmount(PC,PetscReal);
145d90ac83dSHong Zhang 
146ea799195SBarry Smith PETSC_EXTERN PetscErrorCode PCFactorSetMatSolverType(PC,MatSolverType);
147ea799195SBarry Smith PETSC_EXTERN PetscErrorCode PCFactorGetMatSolverType(PC,MatSolverType*);
1483ca39a21SBarry Smith PETSC_EXTERN PetscErrorCode PCFactorSetUpMatSolverType(PC);
149c19b563cSJed Brown PETSC_DEPRECATED("Use PCFactorSetMatSolverType") PETSC_STATIC_INLINE PetscErrorCode PCFactorSetMatSolverPackage(PC pc,MatSolverType stype)
150c19b563cSJed Brown { return PCFactorSetMatSolverType(pc,stype); }
151c19b563cSJed Brown PETSC_DEPRECATED("Use PCFactorGetMatSolverType") PETSC_STATIC_INLINE PetscErrorCode PCFactorGetMatSolverPackage(PC pc,MatSolverType *stype)
152c19b563cSJed Brown { return PCFactorGetMatSolverType(pc,stype); }
153c19b563cSJed Brown PETSC_DEPRECATED("Use PCFactorSetUpMatSolverType") PETSC_STATIC_INLINE PetscErrorCode PCFactorSetUpMatSolverPackage(PC pc)
154c19b563cSJed Brown { return PCFactorSetUpMatSolverType(pc); }
1552401956bSBarry Smith 
156014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCFactorSetFill(PC,PetscReal);
157014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCFactorSetColumnPivot(PC,PetscReal);
158014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCFactorReorderForNonzeroDiagonal(PC,PetscReal);
159421c37bdSBarry Smith 
16019fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode PCFactorSetMatOrderingType(PC,MatOrderingType);
161014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCFactorSetReuseOrdering(PC,PetscBool );
162014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCFactorSetReuseFill(PC,PetscBool );
1638e37d05fSBarry Smith PETSC_EXTERN PetscErrorCode PCFactorSetUseInPlace(PC,PetscBool);
1648e37d05fSBarry Smith PETSC_EXTERN PetscErrorCode PCFactorGetUseInPlace(PC,PetscBool*);
16592e9c092SBarry Smith PETSC_EXTERN PetscErrorCode PCFactorSetAllowDiagonalFill(PC,PetscBool);
16692e9c092SBarry Smith PETSC_EXTERN PetscErrorCode PCFactorGetAllowDiagonalFill(PC,PetscBool*);
167014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCFactorSetPivotInBlocks(PC,PetscBool);
168f5a88c2aSLois Curfman McInnes 
169014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCFactorSetLevels(PC,PetscInt);
170c60c7ad4SBarry Smith PETSC_EXTERN PetscErrorCode PCFactorGetLevels(PC,PetscInt*);
171014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCFactorSetDropTolerance(PC,PetscReal,PetscReal,PetscInt);
172c7f610a1SBarry Smith PETSC_EXTERN PetscErrorCode PCFactorGetZeroPivot(PC,PetscReal*);
173c7f610a1SBarry Smith PETSC_EXTERN PetscErrorCode PCFactorGetShiftAmount(PC,PetscReal*);
174c7f610a1SBarry Smith PETSC_EXTERN PetscErrorCode PCFactorGetShiftType(PC,MatFactorShiftType*);
175b35a507dSBarry Smith 
176014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCASMSetLocalSubdomains(PC,PetscInt,IS[],IS[]);
177014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCASMSetTotalSubdomains(PC,PetscInt,IS[],IS[]);
178014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCASMSetOverlap(PC,PetscInt);
179d709ea83SDmitry Karpeev PETSC_EXTERN PetscErrorCode PCASMSetDMSubdomains(PC,PetscBool);
180d709ea83SDmitry Karpeev PETSC_EXTERN PetscErrorCode PCASMGetDMSubdomains(PC,PetscBool*);
181014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCASMSetSortIndices(PC,PetscBool);
182f746d493SDmitry Karpeev 
183014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCASMSetType(PC,PCASMType);
184c60c7ad4SBarry Smith PETSC_EXTERN PetscErrorCode PCASMGetType(PC,PCASMType*);
18512cd4985SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PCASMSetLocalType(PC,PCCompositeType);
18612cd4985SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PCASMGetLocalType(PC,PCCompositeType*);
187014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCASMCreateSubdomains(Mat,PetscInt,IS*[]);
188014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCASMDestroySubdomains(PetscInt,IS[],IS[]);
189014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCASMCreateSubdomains2D(PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt*,IS**,IS**);
190014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCASMGetLocalSubdomains(PC,PetscInt*,IS*[],IS*[]);
191014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCASMGetLocalSubmatrices(PC,PetscInt*,Mat*[]);
19280ec0b7dSPatrick Sanan PETSC_EXTERN PetscErrorCode PCASMGetSubMatType(PC,MatType*);
19380ec0b7dSPatrick Sanan PETSC_EXTERN PetscErrorCode PCASMSetSubMatType(PC,MatType);
194981c4779SBarry Smith 
1958f3b4b4dSDmitry Karpeev PETSC_EXTERN PetscErrorCode PCGASMSetTotalSubdomains(PC,PetscInt);
196014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCGASMSetSubdomains(PC,PetscInt,IS[],IS[]);
197014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCGASMSetOverlap(PC,PetscInt);
1988f3b4b4dSDmitry Karpeev PETSC_EXTERN PetscErrorCode PCGASMSetUseDMSubdomains(PC,PetscBool);
1998f3b4b4dSDmitry Karpeev PETSC_EXTERN PetscErrorCode PCGASMGetUseDMSubdomains(PC,PetscBool*);
200014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCGASMSetSortIndices(PC,PetscBool );
201f746d493SDmitry Karpeev 
202014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCGASMSetType(PC,PCGASMType);
2038f3b4b4dSDmitry Karpeev PETSC_EXTERN PetscErrorCode PCGASMCreateSubdomains(Mat,PetscInt,PetscInt*,IS*[]);
2042c112581SDmitry Karpeev PETSC_EXTERN PetscErrorCode PCGASMDestroySubdomains(PetscInt,IS*[],IS*[]);
205014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCGASMCreateSubdomains2D(PC,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt*,IS**,IS**);
206014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCGASMGetSubdomains(PC,PetscInt*,IS*[],IS*[]);
207014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCGASMGetSubmatrices(PC,PetscInt*,Mat*[]);
208f746d493SDmitry Karpeev 
209014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCCompositeSetType(PC,PCCompositeType);
210c60c7ad4SBarry Smith PETSC_EXTERN PetscErrorCode PCCompositeGetType(PC,PCCompositeType*);
21119fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode PCCompositeAddPC(PC,PCType);
2128e6eba06SBarry Smith PETSC_EXTERN PetscErrorCode PCCompositeGetNumberPC(PC,PetscInt *);
213014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCCompositeGetPC(PC,PetscInt,PC *);
214014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCCompositeSpecialSetAlpha(PC,PetscScalar);
215981c4779SBarry Smith 
216014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCRedundantSetNumber(PC,PetscInt);
217014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCRedundantSetScatter(PC,VecScatter,VecScatter);
218014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCRedundantGetOperators(PC,Mat*,Mat*);
219da3a660dSBarry Smith 
220014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCSPAISetEpsilon(PC,double);
221014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCSPAISetNBSteps(PC,PetscInt);
222014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCSPAISetMax(PC,PetscInt);
223014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCSPAISetMaxNew(PC,PetscInt);
224014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCSPAISetBlockSize(PC,PetscInt);
225014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCSPAISetCacheSize(PC,PetscInt);
226014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCSPAISetVerbose(PC,PetscInt);
227014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCSPAISetSp(PC,PetscInt);
2283304466cSBarry Smith 
229014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCHYPRESetType(PC,const char[]);
230014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCHYPREGetType(PC,const char*[]);
2314cb006feSStefano Zampini PETSC_EXTERN PetscErrorCode PCHYPRESetDiscreteGradient(PC,Mat);
232863406b8SStefano Zampini PETSC_EXTERN PetscErrorCode PCHYPRESetDiscreteCurl(PC,Mat);
2336bf688a0SCe Qin PETSC_EXTERN PetscErrorCode PCHYPRESetInterpolations(PC,PetscInt,Mat,Mat[],Mat,Mat[]);
2344cb006feSStefano Zampini PETSC_EXTERN PetscErrorCode PCHYPRESetEdgeConstantVectors(PC,Vec,Vec,Vec);
2354cb006feSStefano Zampini PETSC_EXTERN PetscErrorCode PCHYPRESetAlphaPoissonMatrix(PC,Mat);
2364cb006feSStefano Zampini PETSC_EXTERN PetscErrorCode PCHYPRESetBetaPoissonMatrix(PC,Mat);
2373304466cSBarry Smith 
238014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCFieldSplitSetFields(PC,const char[],PetscInt,const PetscInt*,const PetscInt*);
239014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCFieldSplitSetType(PC,PCCompositeType);
240c60c7ad4SBarry Smith PETSC_EXTERN PetscErrorCode PCFieldSplitGetType(PC,PCCompositeType*);
241014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCFieldSplitSetBlockSize(PC,PetscInt);
242014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCFieldSplitSetIS(PC,const char[],IS);
243014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCFieldSplitGetIS(PC,const char[],IS*);
2446dbb499eSCian Wilson PETSC_EXTERN PetscErrorCode PCFieldSplitRestrictIS(PC,IS);
2454ab8060aSDmitry Karpeev PETSC_EXTERN PetscErrorCode PCFieldSplitSetDMSplits(PC,PetscBool);
2464ab8060aSDmitry Karpeev PETSC_EXTERN PetscErrorCode PCFieldSplitGetDMSplits(PC,PetscBool*);
247c84da90fSDmitry Karpeev PETSC_EXTERN PetscErrorCode PCFieldSplitSetDiagUseAmat(PC,PetscBool);
248c84da90fSDmitry Karpeev PETSC_EXTERN PetscErrorCode PCFieldSplitGetDiagUseAmat(PC,PetscBool*);
249c84da90fSDmitry Karpeev PETSC_EXTERN PetscErrorCode PCFieldSplitSetOffDiagUseAmat(PC,PetscBool);
250c84da90fSDmitry Karpeev PETSC_EXTERN PetscErrorCode PCFieldSplitGetOffDiagUseAmat(PC,PetscBool*);
251c84da90fSDmitry Karpeev 
25229f8a81cSJed Brown PETSC_EXTERN PETSC_DEPRECATED("Use PCFieldSplitSetSchurPre") PetscErrorCode PCFieldSplitSchurPrecondition(PC,PCFieldSplitSchurPreType,Mat);
25329f8a81cSJed Brown PETSC_EXTERN PetscErrorCode PCFieldSplitSetSchurPre(PC,PCFieldSplitSchurPreType,Mat);
25437a82bf0SJed Brown PETSC_EXTERN PetscErrorCode PCFieldSplitGetSchurPre(PC,PCFieldSplitSchurPreType*,Mat*);
255014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCFieldSplitSetSchurFactType(PC,PCFieldSplitSchurFactType);
256c096484dSStefano Zampini PETSC_EXTERN PetscErrorCode PCFieldSplitSetSchurScale(PC,PetscScalar);
257014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCFieldSplitGetSchurBlocks(PC,Mat*,Mat*,Mat*,Mat*);
258470b340bSDmitry Karpeev PETSC_EXTERN PetscErrorCode PCFieldSplitSchurGetS(PC,Mat *S);
259470b340bSDmitry Karpeev PETSC_EXTERN PetscErrorCode PCFieldSplitSchurRestoreS(PC,Mat *S);
2607b752e3dSPatrick Sanan PETSC_EXTERN PetscErrorCode PCFieldSplitGetDetectSaddlePoint(PC,PetscBool*);
2617b752e3dSPatrick Sanan PETSC_EXTERN PetscErrorCode PCFieldSplitSetDetectSaddlePoint(PC,PetscBool);
2623d30b1ffSBarry Smith 
263014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCGalerkinSetRestriction(PC,Mat);
264014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCGalerkinSetInterpolation(PC,Mat);
265b3402f20SBarry Smith PETSC_EXTERN PetscErrorCode PCGalerkinSetComputeSubmatrix(PC,PetscErrorCode (*)(PC,Mat,Mat,Mat*,void*),void*);
2662a6744ebSBarry Smith 
267014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCPythonSetType(PC,const char[]);
26867fac13cSBarry Smith 
269014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCBiCGStabCUSPSetTolerance(PC,PetscReal);
270014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCBiCGStabCUSPSetIterations(PC,PetscInt);
271014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCBiCGStabCUSPSetUseVerboseMonitor(PC,PetscBool);
2726c699258SBarry Smith 
273014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCAINVCUSPSetDropTolerance(PC,PetscReal);
274014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCAINVCUSPUseScaling(PC,PetscBool);
275014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCAINVCUSPSetNonzeros(PC,PetscInt);
276014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCAINVCUSPSetLinParameter(PC,PetscInt);
27737f80224SJose E. Roman 
278baa89ecbSBarry Smith PETSC_EXTERN PetscErrorCode PCPARMSSetGlobal(PC,PCPARMSGlobalType);
279baa89ecbSBarry Smith PETSC_EXTERN PetscErrorCode PCPARMSSetLocal(PC,PCPARMSLocalType);
280baa89ecbSBarry Smith PETSC_EXTERN PetscErrorCode PCPARMSSetSolveTolerances(PC,PetscReal,PetscInt);
281baa89ecbSBarry Smith PETSC_EXTERN PetscErrorCode PCPARMSSetSolveRestart(PC,PetscInt);
282baa89ecbSBarry Smith PETSC_EXTERN PetscErrorCode PCPARMSSetNonsymPerm(PC,PetscBool);
283baa89ecbSBarry Smith PETSC_EXTERN PetscErrorCode PCPARMSSetFill(PC,PetscInt,PetscInt,PetscInt);
28437f80224SJose E. Roman 
285c60c7ad4SBarry Smith PETSC_EXTERN PetscErrorCode PCGAMGSetType( PC,PCGAMGType);
286c60c7ad4SBarry Smith PETSC_EXTERN PetscErrorCode PCGAMGGetType( PC,PCGAMGType*);
287014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCGAMGSetProcEqLim(PC,PetscInt);
288cab9ed1eSBarry Smith PETSC_EXTERN PetscErrorCode PCGAMGSetRepartition(PC,PetscBool);
289cab9ed1eSBarry Smith PETSC_EXTERN PetscErrorCode PCGAMGASMSetUseAggs(PC,PetscBool);
290171cca9aSMark Adams PETSC_EXTERN PetscErrorCode PCGAMGSetUseParallelCoarseGridSolve(PC,PetscBool);
291014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCGAMGSetSolverType(PC,char[],PetscInt);
292c1eae691SMark Adams PETSC_EXTERN PetscErrorCode PCGAMGSetThreshold(PC,PetscReal[],PetscInt);
293c1eae691SMark Adams PETSC_EXTERN PetscErrorCode PCGAMGSetThresholdScale(PC,PetscReal);
294014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCGAMGSetCoarseEqLim(PC,PetscInt);
295014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCGAMGSetNlevels(PC,PetscInt);
296baa89ecbSBarry Smith PETSC_EXTERN PetscErrorCode PCGAMGSetNSmooths(PC,PetscInt);
297baa89ecbSBarry Smith PETSC_EXTERN PetscErrorCode PCGAMGSetSymGraph(PC,PetscBool);
2989ab59c8bSMark Adams PETSC_EXTERN PetscErrorCode PCGAMGSetSquareGraph(PC,PetscInt);
2991cc46a46SBarry Smith PETSC_EXTERN PetscErrorCode PCGAMGSetReuseInterpolation(PC,PetscBool);
3003e3471ccSMark Adams PETSC_EXTERN PetscErrorCode PCGAMGFinalizePackage(void);
3013e3471ccSMark Adams PETSC_EXTERN PetscErrorCode PCGAMGInitializePackage(void);
302a36cf38bSToby Isaac PETSC_EXTERN PetscErrorCode PCGAMGRegister(PCGAMGType,PetscErrorCode (*)(PC));
30356de70efSSatish Balay 
3048eab0cc1SPeter Brune PETSC_EXTERN PetscErrorCode PCGAMGClassicalSetType(PC,PCGAMGClassicalType);
305c60c7ad4SBarry Smith PETSC_EXTERN PetscErrorCode PCGAMGClassicalGetType(PC,PCGAMGClassicalType*);
3068eab0cc1SPeter Brune 
3071e0482f5SStefano Zampini PETSC_EXTERN PetscErrorCode PCBDDCSetDiscreteGradient(PC,Mat,PetscInt,PetscInt,PetscBool,PetscBool);
3088ae0ca82SStefano Zampini PETSC_EXTERN PetscErrorCode PCBDDCSetDivergenceMat(PC,Mat,PetscBool,IS);
3091dd7afcfSStefano Zampini PETSC_EXTERN PetscErrorCode PCBDDCSetChangeOfBasisMat(PC,Mat,PetscBool);
31030368db7SStefano Zampini PETSC_EXTERN PetscErrorCode PCBDDCSetPrimalVerticesIS(PC,IS);
311674ae819SStefano Zampini PETSC_EXTERN PetscErrorCode PCBDDCSetPrimalVerticesLocalIS(PC,IS);
3123100ebe3SStefano Zampini PETSC_EXTERN PetscErrorCode PCBDDCGetPrimalVerticesIS(PC,IS*);
3133100ebe3SStefano Zampini PETSC_EXTERN PetscErrorCode PCBDDCGetPrimalVerticesLocalIS(PC,IS*);
3144fad6a16SStefano Zampini PETSC_EXTERN PetscErrorCode PCBDDCSetCoarseningRatio(PC,PetscInt);
3152b510759SStefano Zampini PETSC_EXTERN PetscErrorCode PCBDDCSetLevels(PC,PetscInt);
316014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCBDDCSetDirichletBoundaries(PC,IS);
31782ba6b80SStefano Zampini PETSC_EXTERN PetscErrorCode PCBDDCSetDirichletBoundariesLocal(PC,IS);
318014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCBDDCGetDirichletBoundaries(PC,IS*);
31982ba6b80SStefano Zampini PETSC_EXTERN PetscErrorCode PCBDDCGetDirichletBoundariesLocal(PC,IS*);
320014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCBDDCSetNeumannBoundaries(PC,IS);
32182ba6b80SStefano Zampini PETSC_EXTERN PetscErrorCode PCBDDCSetNeumannBoundariesLocal(PC,IS);
322014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCBDDCGetNeumannBoundaries(PC,IS*);
32382ba6b80SStefano Zampini PETSC_EXTERN PetscErrorCode PCBDDCGetNeumannBoundariesLocal(PC,IS*);
324014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCBDDCSetDofsSplitting(PC,PetscInt,IS[]);
32563602bcaSStefano Zampini PETSC_EXTERN PetscErrorCode PCBDDCSetDofsSplittingLocal(PC,PetscInt,IS[]);
3261a83f524SJed Brown PETSC_EXTERN PetscErrorCode PCBDDCSetLocalAdjacencyGraph(PC,PetscInt,const PetscInt[],const PetscInt[],PetscCopyMode);
327547c9a8eSstefano_zampini PETSC_EXTERN PetscErrorCode PCBDDCCreateFETIDPOperators(PC,PetscBool,const char*,Mat*,PC*);
3283425bc38SStefano Zampini PETSC_EXTERN PetscErrorCode PCBDDCMatFETIDPGetRHS(Mat,Vec,Vec);
3293425bc38SStefano Zampini PETSC_EXTERN PetscErrorCode PCBDDCMatFETIDPGetSolution(Mat,Vec,Vec);
33043371fb9SStefano Zampini PETSC_EXTERN PetscErrorCode PCBDDCFinalizePackage(void);
33143371fb9SStefano Zampini PETSC_EXTERN PetscErrorCode PCBDDCInitializePackage(void);
3320c7d97c5SJed Brown 
333b965d45eSStefano Zampini PETSC_EXTERN PetscErrorCode PCISSetUseStiffnessScaling(PC,PetscBool);
334014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCISSetSubdomainScalingFactor(PC,PetscScalar);
33546caae47SJed Brown PETSC_EXTERN PetscErrorCode PCISSetSubdomainDiagonalScaling(PC,Vec);
336d3b1e0e7SMatthew Knepley 
337ab83eea4SMatthew G. Knepley PETSC_EXTERN PetscInt PetscMGLevelId;
338b4876bcbSBarry Smith PETSC_EXTERN PetscErrorCode PCMGSetType(PC,PCMGType);
339c60c7ad4SBarry Smith PETSC_EXTERN PetscErrorCode PCMGGetType(PC,PCMGType*);
340b4876bcbSBarry Smith PETSC_EXTERN PetscErrorCode PCMGSetLevels(PC,PetscInt,MPI_Comm*);
341b4876bcbSBarry Smith PETSC_EXTERN PetscErrorCode PCMGGetLevels(PC,PetscInt*);
342b4876bcbSBarry Smith 
343f442ab6aSBarry Smith PETSC_EXTERN PetscErrorCode PCMGSetDistinctSmoothUp(PC);
34406792cafSBarry Smith PETSC_EXTERN PetscErrorCode PCMGSetNumberSmooth(PC,PetscInt);
345b4876bcbSBarry Smith PETSC_EXTERN PetscErrorCode PCMGSetCycleType(PC,PCMGCycleType);
346b4876bcbSBarry Smith PETSC_EXTERN PetscErrorCode PCMGSetCycleTypeOnLevel(PC,PetscInt,PCMGCycleType);
347c1cbb1deSBarry Smith PETSC_DEPRECATED("Use PCMGSetCycleTypeOnLevel") PETSC_STATIC_INLINE PetscErrorCode PCMGSetCyclesOnLevel(PC pc,PetscInt l,PetscInt t) {return PCMGSetCycleTypeOnLevel(pc,l,(PCMGCycleType)t);}
348b4876bcbSBarry Smith PETSC_EXTERN PetscErrorCode PCMGMultiplicativeSetCycles(PC,PetscInt);
3492134b1e4SBarry Smith PETSC_EXTERN PetscErrorCode PCMGSetGalerkin(PC,PCMGGalerkinType);
3502134b1e4SBarry Smith PETSC_EXTERN PetscErrorCode PCMGGetGalerkin(PC,PCMGGalerkinType*);
351b4876bcbSBarry Smith 
352b4876bcbSBarry Smith PETSC_EXTERN PetscErrorCode PCMGSetRhs(PC,PetscInt,Vec);
353b4876bcbSBarry Smith PETSC_EXTERN PetscErrorCode PCMGSetX(PC,PetscInt,Vec);
354b4876bcbSBarry Smith PETSC_EXTERN PetscErrorCode PCMGSetR(PC,PetscInt,Vec);
355b4876bcbSBarry Smith 
356b4876bcbSBarry Smith PETSC_EXTERN PetscErrorCode PCMGSetRestriction(PC,PetscInt,Mat);
357b4876bcbSBarry Smith PETSC_EXTERN PetscErrorCode PCMGGetRestriction(PC,PetscInt,Mat*);
358eab52d2bSLawrence Mitchell PETSC_EXTERN PetscErrorCode PCMGSetInjection(PC,PetscInt,Mat);
359eab52d2bSLawrence Mitchell PETSC_EXTERN PetscErrorCode PCMGGetInjection(PC,PetscInt,Mat*);
360b4876bcbSBarry Smith PETSC_EXTERN PetscErrorCode PCMGSetInterpolation(PC,PetscInt,Mat);
361b4876bcbSBarry Smith PETSC_EXTERN PetscErrorCode PCMGGetInterpolation(PC,PetscInt,Mat*);
362b4876bcbSBarry Smith PETSC_EXTERN PetscErrorCode PCMGSetRScale(PC,PetscInt,Vec);
363b4876bcbSBarry Smith PETSC_EXTERN PetscErrorCode PCMGGetRScale(PC,PetscInt,Vec*);
364b4876bcbSBarry Smith PETSC_EXTERN PetscErrorCode PCMGSetResidual(PC,PetscInt,PetscErrorCode (*)(Mat,Vec,Vec,Vec),Mat);
36554b2cd4bSJed Brown PETSC_EXTERN PetscErrorCode PCMGResidualDefault(Mat,Vec,Vec,Vec);
366b4876bcbSBarry Smith 
36748a10b22SPatrick Sanan PETSC_EXTERN PetscErrorCode PCTelescopeGetSubcommType(PC,PetscSubcommType*);
36848a10b22SPatrick Sanan PETSC_EXTERN PetscErrorCode PCTelescopeSetSubcommType(PC,PetscSubcommType);
36968ddcbeaSBarry Smith PETSC_EXTERN PetscErrorCode PCTelescopeGetReductionFactor(PC,PetscInt*);
37068ddcbeaSBarry Smith PETSC_EXTERN PetscErrorCode PCTelescopeSetReductionFactor(PC,PetscInt);
37168ddcbeaSBarry Smith PETSC_EXTERN PetscErrorCode PCTelescopeGetIgnoreDM(PC,PetscBool*);
372bfd6bcc6SSatish Balay PETSC_EXTERN PetscErrorCode PCTelescopeSetIgnoreDM(PC,PetscBool);
3730ae7c45bSDave May PETSC_EXTERN PetscErrorCode PCTelescopeGetIgnoreKSPComputeOperators(PC,PetscBool*);
3740ae7c45bSDave May PETSC_EXTERN PetscErrorCode PCTelescopeSetIgnoreKSPComputeOperators(PC,PetscBool);
37568ddcbeaSBarry Smith PETSC_EXTERN PetscErrorCode PCTelescopeGetDM(PC,DM*);
3766ab51f8fSDave May 
3774bbf5ea8SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PCPatchSetSaveOperators(PC, PetscBool);
3784bbf5ea8SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PCPatchGetSaveOperators(PC, PetscBool *);
3794bbf5ea8SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PCPatchSetPartitionOfUnity(PC, PetscBool);
3804bbf5ea8SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PCPatchGetPartitionOfUnity(PC, PetscBool *);
3814bbf5ea8SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PCPatchSetMultiplicative(PC, PetscBool);
3824bbf5ea8SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PCPatchGetMultiplicative(PC, PetscBool *);
3834bbf5ea8SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PCPatchSetSubMatType(PC, MatType);
3844bbf5ea8SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PCPatchGetSubMatType(PC, MatType *);
3854bbf5ea8SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PCPatchSetCellNumbering(PC, PetscSection);
3864bbf5ea8SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PCPatchGetCellNumbering(PC, PetscSection *);
3874bbf5ea8SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PCPatchSetConstructType(PC, PCPatchConstructType,   PetscErrorCode (*)(PC, PetscInt *, IS **, IS *, void *), void *);
3884bbf5ea8SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PCPatchGetConstructType(PC, PCPatchConstructType *, PetscErrorCode (**)(PC, PetscInt *, IS **, IS *, void *), void **);
3894bbf5ea8SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PCPatchSetDiscretisationInfo(PC, PetscInt, DM *, PetscInt *, PetscInt *, const PetscInt **, const PetscInt *, PetscInt, const PetscInt *, PetscInt, const PetscInt *);
3906f158342SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PCPatchSetComputeOperator(PC, PetscErrorCode (*)(PC,PetscInt,Mat,IS,PetscInt,const PetscInt *,void *), void *);
3914bbf5ea8SMatthew G. Knepley 
392b9ac7092SAlp Dener PETSC_EXTERN PetscErrorCode PCLMVMSetMatLMVM(PC, Mat);
393b9ac7092SAlp Dener PETSC_EXTERN PetscErrorCode PCLMVMGetMatLMVM(PC, Mat*);
394b9ac7092SAlp Dener PETSC_EXTERN PetscErrorCode PCLMVMSetIS(PC, IS);
395b9ac7092SAlp Dener PETSC_EXTERN PetscErrorCode PCLMVMClearIS(PC);
396b9ac7092SAlp Dener 
3977ede41a2SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PCExoticSetType(PC,PCExoticType);
3987ede41a2SMatthew G. Knepley 
399123ea438SMatthew Knepley #endif /* __PETSCPC_H */
400