xref: /petsc/include/petscpc.h (revision 76be6f4ff3bd4e251c19fc00ebbebfd58b6e7589) 
1 /*
2       Preconditioner module.
3 */
4 #if !defined(PETSCPC_H)
5 #define PETSCPC_H
6 
7 #include <petscmat.h>
8 #include <petscdmtypes.h>
9 #include <petscpctypes.h>
10 
11 /* SUBMANSEC = PC */
12 
13 PETSC_EXTERN PetscErrorCode PCInitializePackage(void);
14 
15 /*
16     PCList contains the list of preconditioners currently registered
17    These are added with PCRegister()
18 */
19 PETSC_EXTERN PetscFunctionList PCList;
20 
21 /* Logging support */
22 PETSC_EXTERN PetscClassId PC_CLASSID;
23 
24 /* Arrays of names for options in implementation PCs */
25 PETSC_EXTERN const char *const *const PCSides;
26 PETSC_EXTERN const char *const PCJacobiTypes[];
27 PETSC_EXTERN const char *const PCASMTypes[];
28 PETSC_EXTERN const char *const PCGASMTypes[];
29 PETSC_EXTERN const char *const PCCompositeTypes[];
30 PETSC_EXTERN const char *const PCFieldSplitSchurPreTypes[];
31 PETSC_EXTERN const char *const PCFieldSplitSchurFactTypes[];
32 PETSC_EXTERN const char *const PCPARMSGlobalTypes[];
33 PETSC_EXTERN const char *const PCPARMSLocalTypes[];
34 PETSC_EXTERN const char *const PCMGTypes[];
35 PETSC_EXTERN const char *const PCMGCycleTypes[];
36 PETSC_EXTERN const char *const PCMGGalerkinTypes[];
37 PETSC_EXTERN const char *const PCMGCoarseSpaceTypes[];
38 PETSC_EXTERN const char *const PCExoticTypes[];
39 PETSC_EXTERN const char *const PCPatchConstructTypes[];
40 PETSC_EXTERN const char *const PCDeflationTypes[];
41 PETSC_EXTERN const char *const *const PCFailedReasons;
42 
43 PETSC_EXTERN PetscErrorCode PCCreate(MPI_Comm,PC*);
44 PETSC_EXTERN PetscErrorCode PCSetType(PC,PCType);
45 PETSC_EXTERN PetscErrorCode PCGetType(PC,PCType*);
46 PETSC_EXTERN PetscErrorCode PCSetUp(PC);
47 
48 PETSC_EXTERN PetscErrorCode PCSetFailedReason(PC,PCFailedReason);
49 PETSC_EXTERN PetscErrorCode PCGetFailedReason(PC,PCFailedReason*);
50 PETSC_DEPRECATED_FUNCTION("Use PCGetFailedReason() (since version 3.11)") static inline PetscErrorCode PCGetSetUpFailedReason(PC pc,PCFailedReason *reason) {return PCGetFailedReason(pc,reason);}
51 PETSC_EXTERN PetscErrorCode PCGetFailedReasonRank(PC,PCFailedReason*);
52 
53 PETSC_EXTERN PetscErrorCode PCSetUpOnBlocks(PC);
54 PETSC_EXTERN PetscErrorCode PCApply(PC,Vec,Vec);
55 PETSC_EXTERN PetscErrorCode PCMatApply(PC,Mat,Mat);
56 PETSC_EXTERN PetscErrorCode PCApplySymmetricLeft(PC,Vec,Vec);
57 PETSC_EXTERN PetscErrorCode PCApplySymmetricRight(PC,Vec,Vec);
58 PETSC_EXTERN PetscErrorCode PCApplyBAorAB(PC,PCSide,Vec,Vec,Vec);
59 PETSC_EXTERN PetscErrorCode PCApplyTranspose(PC,Vec,Vec);
60 PETSC_EXTERN PetscErrorCode PCApplyTransposeExists(PC,PetscBool *);
61 PETSC_EXTERN PetscErrorCode PCApplyBAorABTranspose(PC,PCSide,Vec,Vec,Vec);
62 PETSC_EXTERN PetscErrorCode PCSetReusePreconditioner(PC,PetscBool);
63 PETSC_EXTERN PetscErrorCode PCGetReusePreconditioner(PC,PetscBool*);
64 PETSC_EXTERN PetscErrorCode PCSetErrorIfFailure(PC,PetscBool);
65 
66 #define PC_FILE_CLASSID 1211222
67 
68 PETSC_EXTERN PetscErrorCode PCApplyRichardson(PC,Vec,Vec,Vec,PetscReal,PetscReal,PetscReal,PetscInt,PetscBool ,PetscInt*,PCRichardsonConvergedReason*);
69 PETSC_EXTERN PetscErrorCode PCApplyRichardsonExists(PC,PetscBool *);
70 PETSC_EXTERN PetscErrorCode PCSetUseAmat(PC,PetscBool);
71 PETSC_EXTERN PetscErrorCode PCGetUseAmat(PC,PetscBool*);
72 
73 PETSC_EXTERN PetscErrorCode PCRegister(const char[],PetscErrorCode(*)(PC));
74 
75 PETSC_EXTERN PetscErrorCode PCReset(PC);
76 PETSC_EXTERN PetscErrorCode PCDestroy(PC*);
77 PETSC_EXTERN PetscErrorCode PCSetFromOptions(PC);
78 
79 PETSC_EXTERN PetscErrorCode PCFactorGetMatrix(PC,Mat*);
80 PETSC_EXTERN PetscErrorCode PCSetModifySubMatrices(PC,PetscErrorCode(*)(PC,PetscInt,const IS[],const IS[],Mat[],void*),void*);
81 PETSC_EXTERN PetscErrorCode PCModifySubMatrices(PC,PetscInt,const IS[],const IS[],Mat[],void*);
82 
83 PETSC_EXTERN PetscErrorCode PCSetOperators(PC,Mat,Mat);
84 PETSC_EXTERN PetscErrorCode PCGetOperators(PC,Mat*,Mat*);
85 PETSC_EXTERN PetscErrorCode PCGetOperatorsSet(PC,PetscBool*,PetscBool*);
86 
87 PETSC_EXTERN PetscErrorCode PCView(PC,PetscViewer);
88 PETSC_EXTERN PetscErrorCode PCLoad(PC,PetscViewer);
89 PETSC_EXTERN PetscErrorCode PCViewFromOptions(PC,PetscObject,const char[]);
90 
91 PETSC_EXTERN PetscErrorCode PCSetOptionsPrefix(PC,const char[]);
92 PETSC_EXTERN PetscErrorCode PCAppendOptionsPrefix(PC,const char[]);
93 PETSC_EXTERN PetscErrorCode PCGetOptionsPrefix(PC,const char*[]);
94 
95 PETSC_EXTERN PetscErrorCode PCComputeOperator(PC,MatType,Mat*);
96 PETSC_DEPRECATED_FUNCTION("Use PCComputeOperator() (since version 3.12)") static inline PetscErrorCode PCComputeExplicitOperator(PC A,Mat* B) { return PCComputeOperator(A,NULL,B); }
97 
98 /*
99       These are used to provide extra scaling of preconditioned
100    operator for time-stepping schemes like in SUNDIALS
101 */
102 PETSC_EXTERN PetscErrorCode PCGetDiagonalScale(PC,PetscBool *);
103 PETSC_EXTERN PetscErrorCode PCDiagonalScaleLeft(PC,Vec,Vec);
104 PETSC_EXTERN PetscErrorCode PCDiagonalScaleRight(PC,Vec,Vec);
105 PETSC_EXTERN PetscErrorCode PCSetDiagonalScale(PC,Vec);
106 
107 PETSC_EXTERN PetscErrorCode PCSetDM(PC,DM);
108 PETSC_EXTERN PetscErrorCode PCGetDM(PC,DM*);
109 
110 PETSC_EXTERN PetscErrorCode PCGetInterpolations(PC,PetscInt*,Mat*[]);
111 PETSC_EXTERN PetscErrorCode PCGetCoarseOperators(PC pc,PetscInt*,Mat*[]);
112 
113 PETSC_EXTERN PetscErrorCode PCSetCoordinates(PC,PetscInt,PetscInt,PetscReal*);
114 
115 PETSC_EXTERN PetscErrorCode PCSetApplicationContext(PC,void*);
116 PETSC_EXTERN PetscErrorCode PCGetApplicationContext(PC,void*);
117 
118 /* ------------- options specific to particular preconditioners --------- */
119 
120 PETSC_EXTERN PetscErrorCode PCJacobiSetType(PC,PCJacobiType);
121 PETSC_EXTERN PetscErrorCode PCJacobiGetType(PC,PCJacobiType*);
122 PETSC_EXTERN PetscErrorCode PCJacobiSetUseAbs(PC,PetscBool);
123 PETSC_EXTERN PetscErrorCode PCJacobiGetUseAbs(PC,PetscBool*);
124 PETSC_EXTERN PetscErrorCode PCJacobiSetFixDiagonal(PC,PetscBool);
125 PETSC_EXTERN PetscErrorCode PCJacobiGetFixDiagonal(PC,PetscBool*);
126 PETSC_EXTERN PetscErrorCode PCSORSetSymmetric(PC,MatSORType);
127 PETSC_EXTERN PetscErrorCode PCSORGetSymmetric(PC,MatSORType*);
128 PETSC_EXTERN PetscErrorCode PCSORSetOmega(PC,PetscReal);
129 PETSC_EXTERN PetscErrorCode PCSORGetOmega(PC,PetscReal*);
130 PETSC_EXTERN PetscErrorCode PCSORSetIterations(PC,PetscInt,PetscInt);
131 PETSC_EXTERN PetscErrorCode PCSORGetIterations(PC,PetscInt*,PetscInt*);
132 
133 PETSC_EXTERN PetscErrorCode PCEisenstatSetOmega(PC,PetscReal);
134 PETSC_EXTERN PetscErrorCode PCEisenstatGetOmega(PC,PetscReal*);
135 PETSC_EXTERN PetscErrorCode PCEisenstatSetNoDiagonalScaling(PC,PetscBool);
136 PETSC_EXTERN PetscErrorCode PCEisenstatGetNoDiagonalScaling(PC,PetscBool*);
137 
138 PETSC_EXTERN PetscErrorCode PCBJacobiSetTotalBlocks(PC,PetscInt,const PetscInt[]);
139 PETSC_EXTERN PetscErrorCode PCBJacobiGetTotalBlocks(PC,PetscInt*,const PetscInt*[]);
140 PETSC_EXTERN PetscErrorCode PCBJacobiSetLocalBlocks(PC,PetscInt,const PetscInt[]);
141 PETSC_EXTERN PetscErrorCode PCBJacobiGetLocalBlocks(PC,PetscInt*,const PetscInt*[]);
142 
143 PETSC_EXTERN PetscErrorCode PCShellSetApply(PC,PetscErrorCode (*)(PC,Vec,Vec));
144 PETSC_EXTERN PetscErrorCode PCShellSetMatApply(PC,PetscErrorCode (*)(PC,Mat,Mat));
145 PETSC_EXTERN PetscErrorCode PCShellSetApplySymmetricLeft(PC,PetscErrorCode (*)(PC,Vec,Vec));
146 PETSC_EXTERN PetscErrorCode PCShellSetApplySymmetricRight(PC,PetscErrorCode (*)(PC,Vec,Vec));
147 PETSC_EXTERN PetscErrorCode PCShellSetApplyBA(PC,PetscErrorCode (*)(PC,PCSide,Vec,Vec,Vec));
148 PETSC_EXTERN PetscErrorCode PCShellSetApplyTranspose(PC,PetscErrorCode (*)(PC,Vec,Vec));
149 PETSC_EXTERN PetscErrorCode PCShellSetSetUp(PC,PetscErrorCode (*)(PC));
150 PETSC_EXTERN PetscErrorCode PCShellSetApplyRichardson(PC,PetscErrorCode (*)(PC,Vec,Vec,Vec,PetscReal,PetscReal,PetscReal,PetscInt,PetscBool ,PetscInt*,PCRichardsonConvergedReason*));
151 PETSC_EXTERN PetscErrorCode PCShellSetView(PC,PetscErrorCode (*)(PC,PetscViewer));
152 PETSC_EXTERN PetscErrorCode PCShellSetDestroy(PC,PetscErrorCode (*)(PC));
153 PETSC_EXTERN PetscErrorCode PCShellSetContext(PC,void*);
154 PETSC_EXTERN PetscErrorCode PCShellGetContext(PC,void*);
155 PETSC_EXTERN PetscErrorCode PCShellSetName(PC,const char[]);
156 PETSC_EXTERN PetscErrorCode PCShellGetName(PC,const char*[]);
157 
158 PETSC_EXTERN PetscErrorCode PCFactorSetZeroPivot(PC,PetscReal);
159 
160 PETSC_EXTERN PetscErrorCode PCFactorSetShiftType(PC,MatFactorShiftType);
161 PETSC_EXTERN PetscErrorCode PCFactorSetShiftAmount(PC,PetscReal);
162 
163 PETSC_EXTERN PetscErrorCode PCFactorSetMatSolverType(PC,MatSolverType);
164 PETSC_EXTERN PetscErrorCode PCFactorGetMatSolverType(PC,MatSolverType*);
165 PETSC_EXTERN PetscErrorCode PCFactorSetUpMatSolverType(PC);
166 PETSC_DEPRECATED_FUNCTION("Use PCFactorSetMatSolverType() (since version 3.9)") static inline PetscErrorCode PCFactorSetMatSolverPackage(PC pc,MatSolverType stype) {return PCFactorSetMatSolverType(pc,stype);}
167 PETSC_DEPRECATED_FUNCTION("Use PCFactorGetMatSolverType() (since version 3.9)") static inline PetscErrorCode PCFactorGetMatSolverPackage(PC pc,MatSolverType *stype) {return PCFactorGetMatSolverType(pc,stype);}
168 PETSC_DEPRECATED_FUNCTION("Use PCFactorSetUpMatSolverType() (since version 3.9)") static inline PetscErrorCode PCFactorSetUpMatSolverPackage(PC pc) {return PCFactorSetUpMatSolverType(pc);}
169 
170 PETSC_EXTERN PetscErrorCode PCFactorSetFill(PC,PetscReal);
171 PETSC_EXTERN PetscErrorCode PCFactorSetColumnPivot(PC,PetscReal);
172 PETSC_EXTERN PetscErrorCode PCFactorReorderForNonzeroDiagonal(PC,PetscReal);
173 
174 PETSC_EXTERN PetscErrorCode PCFactorSetMatOrderingType(PC,MatOrderingType);
175 PETSC_EXTERN PetscErrorCode PCFactorSetReuseOrdering(PC,PetscBool);
176 PETSC_EXTERN PetscErrorCode PCFactorSetReuseFill(PC,PetscBool);
177 PETSC_EXTERN PetscErrorCode PCFactorSetUseInPlace(PC,PetscBool);
178 PETSC_EXTERN PetscErrorCode PCFactorGetUseInPlace(PC,PetscBool*);
179 PETSC_EXTERN PetscErrorCode PCFactorSetAllowDiagonalFill(PC,PetscBool);
180 PETSC_EXTERN PetscErrorCode PCFactorGetAllowDiagonalFill(PC,PetscBool*);
181 PETSC_EXTERN PetscErrorCode PCFactorSetPivotInBlocks(PC,PetscBool);
182 
183 PETSC_EXTERN PetscErrorCode PCFactorSetLevels(PC,PetscInt);
184 PETSC_EXTERN PetscErrorCode PCFactorGetLevels(PC,PetscInt*);
185 PETSC_EXTERN PetscErrorCode PCFactorSetDropTolerance(PC,PetscReal,PetscReal,PetscInt);
186 PETSC_EXTERN PetscErrorCode PCFactorGetZeroPivot(PC,PetscReal*);
187 PETSC_EXTERN PetscErrorCode PCFactorGetShiftAmount(PC,PetscReal*);
188 PETSC_EXTERN PetscErrorCode PCFactorGetShiftType(PC,MatFactorShiftType*);
189 
190 PETSC_EXTERN PetscErrorCode PCASMSetLocalSubdomains(PC,PetscInt,IS[],IS[]);
191 PETSC_EXTERN PetscErrorCode PCASMSetTotalSubdomains(PC,PetscInt,IS[],IS[]);
192 PETSC_EXTERN PetscErrorCode PCASMSetOverlap(PC,PetscInt);
193 PETSC_EXTERN PetscErrorCode PCASMSetDMSubdomains(PC,PetscBool);
194 PETSC_EXTERN PetscErrorCode PCASMGetDMSubdomains(PC,PetscBool*);
195 PETSC_EXTERN PetscErrorCode PCASMSetSortIndices(PC,PetscBool);
196 
197 PETSC_EXTERN PetscErrorCode PCASMSetType(PC,PCASMType);
198 PETSC_EXTERN PetscErrorCode PCASMGetType(PC,PCASMType*);
199 PETSC_EXTERN PetscErrorCode PCASMSetLocalType(PC,PCCompositeType);
200 PETSC_EXTERN PetscErrorCode PCASMGetLocalType(PC,PCCompositeType*);
201 PETSC_EXTERN PetscErrorCode PCASMCreateSubdomains(Mat,PetscInt,IS*[]);
202 PETSC_EXTERN PetscErrorCode PCASMDestroySubdomains(PetscInt,IS[],IS[]);
203 PETSC_EXTERN PetscErrorCode PCASMCreateSubdomains2D(PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt*,IS**,IS**);
204 PETSC_EXTERN PetscErrorCode PCASMGetLocalSubdomains(PC,PetscInt*,IS*[],IS*[]);
205 PETSC_EXTERN PetscErrorCode PCASMGetLocalSubmatrices(PC,PetscInt*,Mat*[]);
206 PETSC_EXTERN PetscErrorCode PCASMGetSubMatType(PC,MatType*);
207 PETSC_EXTERN PetscErrorCode PCASMSetSubMatType(PC,MatType);
208 
209 PETSC_EXTERN PetscErrorCode PCGASMSetTotalSubdomains(PC,PetscInt);
210 PETSC_EXTERN PetscErrorCode PCGASMSetSubdomains(PC,PetscInt,IS[],IS[]);
211 PETSC_EXTERN PetscErrorCode PCGASMSetOverlap(PC,PetscInt);
212 PETSC_EXTERN PetscErrorCode PCGASMSetUseDMSubdomains(PC,PetscBool);
213 PETSC_EXTERN PetscErrorCode PCGASMGetUseDMSubdomains(PC,PetscBool*);
214 PETSC_EXTERN PetscErrorCode PCGASMSetSortIndices(PC,PetscBool);
215 
216 PETSC_EXTERN PetscErrorCode PCGASMSetType(PC,PCGASMType);
217 PETSC_EXTERN PetscErrorCode PCGASMCreateSubdomains(Mat,PetscInt,PetscInt*,IS*[]);
218 PETSC_EXTERN PetscErrorCode PCGASMDestroySubdomains(PetscInt,IS*[],IS*[]);
219 PETSC_EXTERN PetscErrorCode PCGASMCreateSubdomains2D(PC,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt*,IS**,IS**);
220 PETSC_EXTERN PetscErrorCode PCGASMGetSubdomains(PC,PetscInt*,IS*[],IS*[]);
221 PETSC_EXTERN PetscErrorCode PCGASMGetSubmatrices(PC,PetscInt*,Mat*[]);
222 
223 PETSC_EXTERN PetscErrorCode PCCompositeSetType(PC,PCCompositeType);
224 PETSC_EXTERN PetscErrorCode PCCompositeGetType(PC,PCCompositeType*);
225 PETSC_EXTERN PetscErrorCode PCCompositeAddPCType(PC,PCType);
226 PETSC_EXTERN PetscErrorCode PCCompositeAddPC(PC,PC);
227 PETSC_EXTERN PetscErrorCode PCCompositeGetNumberPC(PC,PetscInt *);
228 PETSC_EXTERN PetscErrorCode PCCompositeGetPC(PC,PetscInt,PC *);
229 PETSC_EXTERN PetscErrorCode PCCompositeSpecialSetAlpha(PC,PetscScalar);
230 
231 PETSC_EXTERN PetscErrorCode PCRedundantSetNumber(PC,PetscInt);
232 PETSC_EXTERN PetscErrorCode PCRedundantSetScatter(PC,VecScatter,VecScatter);
233 PETSC_EXTERN PetscErrorCode PCRedundantGetOperators(PC,Mat*,Mat*);
234 
235 PETSC_EXTERN PetscErrorCode PCSPAISetEpsilon(PC,PetscReal);
236 PETSC_EXTERN PetscErrorCode PCSPAISetNBSteps(PC,PetscInt);
237 PETSC_EXTERN PetscErrorCode PCSPAISetMax(PC,PetscInt);
238 PETSC_EXTERN PetscErrorCode PCSPAISetMaxNew(PC,PetscInt);
239 PETSC_EXTERN PetscErrorCode PCSPAISetBlockSize(PC,PetscInt);
240 PETSC_EXTERN PetscErrorCode PCSPAISetCacheSize(PC,PetscInt);
241 PETSC_EXTERN PetscErrorCode PCSPAISetVerbose(PC,PetscInt);
242 PETSC_EXTERN PetscErrorCode PCSPAISetSp(PC,PetscInt);
243 
244 PETSC_EXTERN PetscErrorCode PCHYPRESetType(PC,const char[]);
245 PETSC_EXTERN PetscErrorCode PCHYPREGetType(PC,const char*[]);
246 PETSC_EXTERN PetscErrorCode PCHYPRESetDiscreteGradient(PC,Mat);
247 PETSC_EXTERN PetscErrorCode PCHYPRESetDiscreteCurl(PC,Mat);
248 PETSC_EXTERN PetscErrorCode PCHYPRESetInterpolations(PC,PetscInt,Mat,Mat[],Mat,Mat[]);
249 PETSC_EXTERN PetscErrorCode PCHYPRESetEdgeConstantVectors(PC,Vec,Vec,Vec);
250 PETSC_EXTERN PetscErrorCode PCHYPRESetAlphaPoissonMatrix(PC,Mat);
251 PETSC_EXTERN PetscErrorCode PCHYPRESetBetaPoissonMatrix(PC,Mat);
252 
253 PETSC_EXTERN PetscErrorCode PCFieldSplitSetFields(PC,const char[],PetscInt,const PetscInt*,const PetscInt*);
254 PETSC_EXTERN PetscErrorCode PCFieldSplitSetType(PC,PCCompositeType);
255 PETSC_EXTERN PetscErrorCode PCFieldSplitGetType(PC,PCCompositeType*);
256 PETSC_EXTERN PetscErrorCode PCFieldSplitSetBlockSize(PC,PetscInt);
257 PETSC_EXTERN PetscErrorCode PCFieldSplitSetIS(PC,const char[],IS);
258 PETSC_EXTERN PetscErrorCode PCFieldSplitGetIS(PC,const char[],IS*);
259 PETSC_EXTERN PetscErrorCode PCFieldSplitGetISByIndex(PC,PetscInt,IS*);
260 PETSC_EXTERN PetscErrorCode PCFieldSplitRestrictIS(PC,IS);
261 PETSC_EXTERN PetscErrorCode PCFieldSplitSetDMSplits(PC,PetscBool);
262 PETSC_EXTERN PetscErrorCode PCFieldSplitGetDMSplits(PC,PetscBool*);
263 PETSC_EXTERN PetscErrorCode PCFieldSplitSetDiagUseAmat(PC,PetscBool);
264 PETSC_EXTERN PetscErrorCode PCFieldSplitGetDiagUseAmat(PC,PetscBool*);
265 PETSC_EXTERN PetscErrorCode PCFieldSplitSetOffDiagUseAmat(PC,PetscBool);
266 PETSC_EXTERN PetscErrorCode PCFieldSplitGetOffDiagUseAmat(PC,PetscBool*);
267 
268 PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use PCFieldSplitSetSchurPre() (since version 3.5)") PetscErrorCode PCFieldSplitSchurPrecondition(PC,PCFieldSplitSchurPreType,Mat);
269 PETSC_EXTERN PetscErrorCode PCFieldSplitSetSchurPre(PC,PCFieldSplitSchurPreType,Mat);
270 PETSC_EXTERN PetscErrorCode PCFieldSplitGetSchurPre(PC,PCFieldSplitSchurPreType*,Mat*);
271 PETSC_EXTERN PetscErrorCode PCFieldSplitSetSchurFactType(PC,PCFieldSplitSchurFactType);
272 PETSC_EXTERN PetscErrorCode PCFieldSplitSetSchurScale(PC,PetscScalar);
273 PETSC_EXTERN PetscErrorCode PCFieldSplitGetSchurBlocks(PC,Mat*,Mat*,Mat*,Mat*);
274 PETSC_EXTERN PetscErrorCode PCFieldSplitSchurGetS(PC,Mat *S);
275 PETSC_EXTERN PetscErrorCode PCFieldSplitSchurRestoreS(PC,Mat *S);
276 PETSC_EXTERN PetscErrorCode PCFieldSplitGetDetectSaddlePoint(PC,PetscBool*);
277 PETSC_EXTERN PetscErrorCode PCFieldSplitSetDetectSaddlePoint(PC,PetscBool);
278 PETSC_EXTERN PetscErrorCode PCFieldSplitSetGKBTol(PC,PetscReal);
279 PETSC_EXTERN PetscErrorCode PCFieldSplitSetGKBNu(PC,PetscReal);
280 PETSC_EXTERN PetscErrorCode PCFieldSplitSetGKBMaxit(PC,PetscInt);
281 PETSC_EXTERN PetscErrorCode PCFieldSplitSetGKBDelay(PC,PetscInt);
282 
283 PETSC_EXTERN PetscErrorCode PCGalerkinSetRestriction(PC,Mat);
284 PETSC_EXTERN PetscErrorCode PCGalerkinSetInterpolation(PC,Mat);
285 PETSC_EXTERN PetscErrorCode PCGalerkinSetComputeSubmatrix(PC,PetscErrorCode (*)(PC,Mat,Mat,Mat*,void*),void*);
286 
287 PETSC_EXTERN PetscErrorCode PCPythonSetType(PC,const char[]);
288 
289 PETSC_EXTERN PetscErrorCode PCPARMSSetGlobal(PC,PCPARMSGlobalType);
290 PETSC_EXTERN PetscErrorCode PCPARMSSetLocal(PC,PCPARMSLocalType);
291 PETSC_EXTERN PetscErrorCode PCPARMSSetSolveTolerances(PC,PetscReal,PetscInt);
292 PETSC_EXTERN PetscErrorCode PCPARMSSetSolveRestart(PC,PetscInt);
293 PETSC_EXTERN PetscErrorCode PCPARMSSetNonsymPerm(PC,PetscBool);
294 PETSC_EXTERN PetscErrorCode PCPARMSSetFill(PC,PetscInt,PetscInt,PetscInt);
295 
296 PETSC_EXTERN PetscErrorCode PCGAMGSetType(PC,PCGAMGType);
297 PETSC_EXTERN PetscErrorCode PCGAMGGetType(PC,PCGAMGType*);
298 PETSC_EXTERN PetscErrorCode PCGAMGSetProcEqLim(PC,PetscInt);
299 
300 PETSC_EXTERN PetscErrorCode PCGAMGSetRepartition(PC,PetscBool);
301 PETSC_EXTERN PetscErrorCode PCGAMGSetUseSAEstEig(PC,PetscBool);
302 PETSC_EXTERN PetscErrorCode PCGAMGSetEigenvalues(PC,PetscReal,PetscReal);
303 PETSC_EXTERN PetscErrorCode PCGAMGASMSetUseAggs(PC,PetscBool);
304 PETSC_EXTERN PetscErrorCode PCGAMGSetUseParallelCoarseGridSolve(PC,PetscBool);
305 PETSC_EXTERN PetscErrorCode PCGAMGSetCpuPinCoarseGrids(PC,PetscBool);
306 PETSC_EXTERN PetscErrorCode PCGAMGSetCoarseGridLayoutType(PC,PCGAMGLayoutType);
307 PETSC_EXTERN PetscErrorCode PCGAMGSetThreshold(PC,PetscReal[],PetscInt);
308 PETSC_EXTERN PetscErrorCode PCGAMGSetRankReductionFactors(PC,PetscInt[],PetscInt);
309 PETSC_EXTERN PetscErrorCode PCGAMGSetThresholdScale(PC,PetscReal);
310 PETSC_EXTERN PetscErrorCode PCGAMGSetCoarseEqLim(PC,PetscInt);
311 PETSC_EXTERN PetscErrorCode PCGAMGSetNlevels(PC,PetscInt);
312 PETSC_EXTERN PetscErrorCode PCGAMGSetNSmooths(PC,PetscInt);
313 PETSC_EXTERN PetscErrorCode PCGAMGSetSymGraph(PC,PetscBool);
314 PETSC_EXTERN PetscErrorCode PCGAMGSetSquareGraph(PC,PetscInt);
315 PETSC_EXTERN PetscErrorCode PCGAMGSetReuseInterpolation(PC,PetscBool);
316 PETSC_EXTERN PetscErrorCode PCGAMGFinalizePackage(void);
317 PETSC_EXTERN PetscErrorCode PCGAMGInitializePackage(void);
318 PETSC_EXTERN PetscErrorCode PCGAMGRegister(PCGAMGType,PetscErrorCode (*)(PC));
319 
320 PETSC_EXTERN PetscErrorCode PCGAMGClassicalSetType(PC,PCGAMGClassicalType);
321 PETSC_EXTERN PetscErrorCode PCGAMGClassicalGetType(PC,PCGAMGClassicalType*);
322 
323 PETSC_EXTERN PetscErrorCode PCBDDCSetDiscreteGradient(PC,Mat,PetscInt,PetscInt,PetscBool,PetscBool);
324 PETSC_EXTERN PetscErrorCode PCBDDCSetDivergenceMat(PC,Mat,PetscBool,IS);
325 PETSC_EXTERN PetscErrorCode PCBDDCSetChangeOfBasisMat(PC,Mat,PetscBool);
326 PETSC_EXTERN PetscErrorCode PCBDDCSetPrimalVerticesIS(PC,IS);
327 PETSC_EXTERN PetscErrorCode PCBDDCSetPrimalVerticesLocalIS(PC,IS);
328 PETSC_EXTERN PetscErrorCode PCBDDCGetPrimalVerticesIS(PC,IS*);
329 PETSC_EXTERN PetscErrorCode PCBDDCGetPrimalVerticesLocalIS(PC,IS*);
330 PETSC_EXTERN PetscErrorCode PCBDDCSetCoarseningRatio(PC,PetscInt);
331 PETSC_EXTERN PetscErrorCode PCBDDCSetLevels(PC,PetscInt);
332 PETSC_EXTERN PetscErrorCode PCBDDCSetDirichletBoundaries(PC,IS);
333 PETSC_EXTERN PetscErrorCode PCBDDCSetDirichletBoundariesLocal(PC,IS);
334 PETSC_EXTERN PetscErrorCode PCBDDCGetDirichletBoundaries(PC,IS*);
335 PETSC_EXTERN PetscErrorCode PCBDDCGetDirichletBoundariesLocal(PC,IS*);
336 PETSC_EXTERN PetscErrorCode PCBDDCSetInterfaceExtType(PC,PCBDDCInterfaceExtType);
337 PETSC_EXTERN PetscErrorCode PCBDDCSetNeumannBoundaries(PC,IS);
338 PETSC_EXTERN PetscErrorCode PCBDDCSetNeumannBoundariesLocal(PC,IS);
339 PETSC_EXTERN PetscErrorCode PCBDDCGetNeumannBoundaries(PC,IS*);
340 PETSC_EXTERN PetscErrorCode PCBDDCGetNeumannBoundariesLocal(PC,IS*);
341 PETSC_EXTERN PetscErrorCode PCBDDCSetDofsSplitting(PC,PetscInt,IS[]);
342 PETSC_EXTERN PetscErrorCode PCBDDCSetDofsSplittingLocal(PC,PetscInt,IS[]);
343 PETSC_EXTERN PetscErrorCode PCBDDCSetLocalAdjacencyGraph(PC,PetscInt,const PetscInt[],const PetscInt[],PetscCopyMode);
344 PETSC_EXTERN PetscErrorCode PCBDDCCreateFETIDPOperators(PC,PetscBool,const char*,Mat*,PC*);
345 PETSC_EXTERN PetscErrorCode PCBDDCMatFETIDPGetRHS(Mat,Vec,Vec);
346 PETSC_EXTERN PetscErrorCode PCBDDCMatFETIDPGetSolution(Mat,Vec,Vec);
347 PETSC_EXTERN PetscErrorCode PCBDDCFinalizePackage(void);
348 PETSC_EXTERN PetscErrorCode PCBDDCInitializePackage(void);
349 
350 PETSC_EXTERN PetscErrorCode PCISSetUseStiffnessScaling(PC,PetscBool);
351 PETSC_EXTERN PetscErrorCode PCISSetSubdomainScalingFactor(PC,PetscScalar);
352 PETSC_EXTERN PetscErrorCode PCISSetSubdomainDiagonalScaling(PC,Vec);
353 
354 PETSC_EXTERN PetscInt PetscMGLevelId;
355 PETSC_EXTERN PetscErrorCode PCMGSetType(PC,PCMGType);
356 PETSC_EXTERN PetscErrorCode PCMGGetType(PC,PCMGType*);
357 PETSC_EXTERN PetscErrorCode PCMGSetLevels(PC,PetscInt,MPI_Comm*);
358 PETSC_EXTERN PetscErrorCode PCMGGetLevels(PC,PetscInt*);
359 
360 PETSC_EXTERN PetscErrorCode PCMGSetDistinctSmoothUp(PC);
361 PETSC_EXTERN PetscErrorCode PCMGSetNumberSmooth(PC,PetscInt);
362 PETSC_EXTERN PetscErrorCode PCMGSetCycleType(PC,PCMGCycleType);
363 PETSC_EXTERN PetscErrorCode PCMGSetCycleTypeOnLevel(PC,PetscInt,PCMGCycleType);
364 PETSC_DEPRECATED_FUNCTION("Use PCMGSetCycleTypeOnLevel() (since version 3.5)") static inline PetscErrorCode PCMGSetCyclesOnLevel(PC pc,PetscInt l,PetscInt t) {return PCMGSetCycleTypeOnLevel(pc,l,(PCMGCycleType)t);}
365 PETSC_EXTERN PetscErrorCode PCMGMultiplicativeSetCycles(PC,PetscInt);
366 PETSC_EXTERN PetscErrorCode PCMGSetGalerkin(PC,PCMGGalerkinType);
367 PETSC_EXTERN PetscErrorCode PCMGGetGalerkin(PC,PCMGGalerkinType*);
368 PETSC_EXTERN PetscErrorCode PCMGSetAdaptInterpolation(PC,PetscBool);
369 PETSC_EXTERN PetscErrorCode PCMGGetAdaptInterpolation(PC,PetscBool*);
370 PETSC_EXTERN PetscErrorCode PCMGSetAdaptCR(PC,PetscBool);
371 PETSC_EXTERN PetscErrorCode PCMGGetAdaptCR(PC,PetscBool*);
372 
373 PETSC_EXTERN PetscErrorCode PCMGSetRhs(PC,PetscInt,Vec);
374 PETSC_EXTERN PetscErrorCode PCMGSetX(PC,PetscInt,Vec);
375 PETSC_EXTERN PetscErrorCode PCMGSetR(PC,PetscInt,Vec);
376 
377 PETSC_EXTERN PetscErrorCode PCMGSetRestriction(PC,PetscInt,Mat);
378 PETSC_EXTERN PetscErrorCode PCMGGetRestriction(PC,PetscInt,Mat*);
379 PETSC_EXTERN PetscErrorCode PCMGSetInjection(PC,PetscInt,Mat);
380 PETSC_EXTERN PetscErrorCode PCMGGetInjection(PC,PetscInt,Mat*);
381 PETSC_EXTERN PetscErrorCode PCMGSetInterpolation(PC,PetscInt,Mat);
382 PETSC_EXTERN PetscErrorCode PCMGSetOperators(PC,PetscInt,Mat,Mat);
383 PETSC_EXTERN PetscErrorCode PCMGGetInterpolation(PC,PetscInt,Mat*);
384 PETSC_EXTERN PetscErrorCode PCMGSetRScale(PC,PetscInt,Vec);
385 PETSC_EXTERN PetscErrorCode PCMGGetRScale(PC,PetscInt,Vec*);
386 PETSC_EXTERN PetscErrorCode PCMGSetResidual(PC,PetscInt,PetscErrorCode (*)(Mat,Vec,Vec,Vec),Mat);
387 PETSC_EXTERN PetscErrorCode PCMGSetResidualTranspose(PC,PetscInt,PetscErrorCode (*)(Mat,Vec,Vec,Vec),Mat);
388 PETSC_EXTERN PetscErrorCode PCMGResidualDefault(Mat,Vec,Vec,Vec);
389 PETSC_EXTERN PetscErrorCode PCMGResidualTransposeDefault(Mat,Vec,Vec,Vec);
390 PETSC_EXTERN PetscErrorCode PCMGMatResidualDefault(Mat,Mat,Mat,Mat);
391 PETSC_EXTERN PetscErrorCode PCMGMatResidualTransposeDefault(Mat,Mat,Mat,Mat);
392 PETSC_EXTERN PetscErrorCode PCMGGalerkinSetMatProductAlgorithm(PC,const char[]);
393 PETSC_EXTERN PetscErrorCode PCMGGalerkinGetMatProductAlgorithm(PC,const char*[]);
394 PETSC_EXTERN PetscErrorCode PCMGGetGridComplexity(PC,PetscReal*,PetscReal*);
395 
396 PETSC_EXTERN PetscErrorCode PCHMGSetReuseInterpolation(PC,PetscBool);
397 PETSC_EXTERN PetscErrorCode PCHMGSetUseSubspaceCoarsening(PC,PetscBool);
398 PETSC_EXTERN PetscErrorCode PCHMGSetInnerPCType(PC,PCType);
399 PETSC_EXTERN PetscErrorCode PCHMGSetCoarseningComponent(PC,PetscInt);
400 PETSC_EXTERN PetscErrorCode PCHMGUseMatMAIJ(PC,PetscBool);
401 
402 PETSC_EXTERN PetscErrorCode PCTelescopeGetSubcommType(PC,PetscSubcommType*);
403 PETSC_EXTERN PetscErrorCode PCTelescopeSetSubcommType(PC,PetscSubcommType);
404 PETSC_EXTERN PetscErrorCode PCTelescopeGetReductionFactor(PC,PetscInt*);
405 PETSC_EXTERN PetscErrorCode PCTelescopeSetReductionFactor(PC,PetscInt);
406 PETSC_EXTERN PetscErrorCode PCTelescopeGetIgnoreDM(PC,PetscBool*);
407 PETSC_EXTERN PetscErrorCode PCTelescopeSetIgnoreDM(PC,PetscBool);
408 PETSC_EXTERN PetscErrorCode PCTelescopeGetUseCoarseDM(PC,PetscBool*);
409 PETSC_EXTERN PetscErrorCode PCTelescopeSetUseCoarseDM(PC,PetscBool);
410 PETSC_EXTERN PetscErrorCode PCTelescopeGetIgnoreKSPComputeOperators(PC,PetscBool*);
411 PETSC_EXTERN PetscErrorCode PCTelescopeSetIgnoreKSPComputeOperators(PC,PetscBool);
412 PETSC_EXTERN PetscErrorCode PCTelescopeGetDM(PC,DM*);
413 
414 PETSC_EXTERN PetscErrorCode PCPatchSetSaveOperators(PC, PetscBool);
415 PETSC_EXTERN PetscErrorCode PCPatchGetSaveOperators(PC, PetscBool *);
416 PETSC_EXTERN PetscErrorCode PCPatchSetPrecomputeElementTensors(PC, PetscBool);
417 PETSC_EXTERN PetscErrorCode PCPatchGetPrecomputeElementTensors(PC, PetscBool *);
418 PETSC_EXTERN PetscErrorCode PCPatchSetPartitionOfUnity(PC, PetscBool);
419 PETSC_EXTERN PetscErrorCode PCPatchGetPartitionOfUnity(PC, PetscBool *);
420 PETSC_EXTERN PetscErrorCode PCPatchSetSubMatType(PC, MatType);
421 PETSC_EXTERN PetscErrorCode PCPatchGetSubMatType(PC, MatType *);
422 PETSC_EXTERN PetscErrorCode PCPatchSetCellNumbering(PC, PetscSection);
423 PETSC_EXTERN PetscErrorCode PCPatchGetCellNumbering(PC, PetscSection *);
424 PETSC_EXTERN PetscErrorCode PCPatchSetConstructType(PC, PCPatchConstructType,   PetscErrorCode (*)(PC, PetscInt *, IS **, IS *, void *), void *);
425 PETSC_EXTERN PetscErrorCode PCPatchGetConstructType(PC, PCPatchConstructType *, PetscErrorCode (**)(PC, PetscInt *, IS **, IS *, void *), void **);
426 PETSC_EXTERN PetscErrorCode PCPatchSetDiscretisationInfo(PC, PetscInt, DM *, PetscInt *, PetscInt *, const PetscInt **, const PetscInt *, PetscInt, const PetscInt *, PetscInt, const PetscInt *);
427 PETSC_EXTERN PetscErrorCode PCPatchSetComputeOperator(PC, PetscErrorCode (*)(PC,PetscInt,Vec,Mat,IS,PetscInt,const PetscInt *,const PetscInt *, void *), void *);
428 PETSC_EXTERN PetscErrorCode PCPatchSetComputeFunction(PC pc, PetscErrorCode (*func)(PC, PetscInt, Vec, Vec, IS, PetscInt, const PetscInt *, const PetscInt *, void *), void *ctx);
429 PETSC_EXTERN PetscErrorCode PCPatchSetComputeOperatorInteriorFacets(PC, PetscErrorCode (*)(PC,PetscInt,Vec,Mat,IS,PetscInt,const PetscInt *,const PetscInt *, void *), void *);
430 PETSC_EXTERN PetscErrorCode PCPatchSetComputeFunctionInteriorFacets(PC pc, PetscErrorCode (*func)(PC, PetscInt, Vec, Vec, IS, PetscInt, const PetscInt *, const PetscInt *, void *), void *ctx);
431 
432 PETSC_EXTERN PetscErrorCode PCLMVMSetMatLMVM(PC, Mat);
433 PETSC_EXTERN PetscErrorCode PCLMVMGetMatLMVM(PC, Mat*);
434 PETSC_EXTERN PetscErrorCode PCLMVMSetIS(PC, IS);
435 PETSC_EXTERN PetscErrorCode PCLMVMClearIS(PC);
436 
437 PETSC_EXTERN PetscErrorCode PCExoticSetType(PC,PCExoticType);
438 
439 PETSC_EXTERN PetscErrorCode PCDeflationSetInitOnly(PC,PetscBool);
440 PETSC_EXTERN PetscErrorCode PCDeflationSetLevels(PC,PetscInt);
441 PETSC_EXTERN PetscErrorCode PCDeflationSetReductionFactor(PC,PetscInt);
442 PETSC_EXTERN PetscErrorCode PCDeflationSetCorrectionFactor(PC,PetscScalar);
443 PETSC_EXTERN PetscErrorCode PCDeflationSetSpaceToCompute(PC,PCDeflationSpaceType,PetscInt);
444 PETSC_EXTERN PetscErrorCode PCDeflationSetSpace(PC,Mat,PetscBool);
445 PETSC_EXTERN PetscErrorCode PCDeflationSetProjectionNullSpaceMat(PC,Mat);
446 PETSC_EXTERN PetscErrorCode PCDeflationSetCoarseMat(PC,Mat);
447 PETSC_EXTERN PetscErrorCode PCDeflationGetPC(PC,PC*);
448 
449 PETSC_EXTERN PetscErrorCode PCHPDDMSetAuxiliaryMat(PC,IS,Mat,PetscErrorCode (*)(Mat,PetscReal,Vec,Vec,PetscReal,IS,void*),void*);
450 PETSC_EXTERN PetscErrorCode PCHPDDMSetRHSMat(PC,Mat);
451 PETSC_EXTERN PetscErrorCode PCHPDDMHasNeumannMat(PC,PetscBool);
452 PETSC_EXTERN PetscErrorCode PCHPDDMSetCoarseCorrectionType(PC,PCHPDDMCoarseCorrectionType);
453 PETSC_EXTERN PetscErrorCode PCHPDDMGetCoarseCorrectionType(PC,PCHPDDMCoarseCorrectionType*);
454 PETSC_EXTERN PetscErrorCode PCHPDDMGetSTShareSubKSP(PC,PetscBool*);
455 PETSC_EXTERN PetscErrorCode PCHPDDMSetDeflationMat(PC,IS,Mat);
456 PETSC_EXTERN PetscErrorCode PCHPDDMFinalizePackage(void);
457 PETSC_EXTERN PetscErrorCode PCHPDDMInitializePackage(void);
458 
459 #endif /* PETSCPC_H */
460