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