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