xref: /petsc/include/petscpc.h (revision 6b5873e37b549cc139dbd34cfb32e6aff4f310b3)
1 
2 /*
3       Preconditioner module.
4 */
5 #if !defined(__PC_PACKAGE)
6 #define __PC_PACKAGE
7 #include "petsc.h"
8 #include "mat.h"
9 
10 typedef enum { PCNONE, PCJACOBI, PCSOR, PCDIRECT, PCSHELL, PCBJACOBI, PCMG,
11                PCESOR, PCILU, PCICC } PCMETHOD;
12 
13 typedef struct _PC* PC;
14 #define PC_COOKIE    PETSC_COOKIE+9
15 
16 extern int    PCCreate(MPI_Comm,PC*);
17 extern int    PCSetMethod(PC,PCMETHOD);
18 extern int    PCSetUp(PC);
19 extern int    PCApply(PC,Vec,Vec);
20 extern int    PCApplyBAorAB(PC,int,Vec,Vec,Vec);
21 extern int    PCApplyTrans(PC,Vec,Vec);
22 extern int    PCApplyBAorABTrans(PC,int,Vec,Vec,Vec);
23 extern int    PCApplyRichardson(PC,Vec,Vec,Vec,int);
24 extern int    PCApplyRichardsonExists(PC);
25 extern int    PCRegisterAll();
26 extern int    PCRegisterDestroy();
27 extern int    PCRegister(PCMETHOD,char *,int (*)(PC));
28 extern int    PCDestroy(PC);
29 extern int    PCSetFromOptions(PC);
30 extern int    PCGetMethodFromOptions(PC pc,PCMETHOD *);
31 extern int    PCPrintMethods(char*,char *);
32 extern int    PCGetMethodFromContext(PC,PCMETHOD*);
33 extern int    PCGetMethodName(PCMETHOD,char **);
34 
35 /* Flags for PCSetOperators */
36 #define MAT_SAME_NONZERO_PATTERN 1
37 
38 extern int    PCSetOperators(PC,Mat,Mat,int);
39 extern int    PCBJacobiSetUseTrueLocal(PC);
40 extern int    PCSetVector(PC,Vec);
41 extern int    PCPrintHelp(PC);
42 extern int    PCSetOptionsPrefix(PC,char*);
43 
44 extern int PCSORSetSymmetric(PC, int);
45 extern int PCSORSetOmega(PC, double);
46 extern int PCEisenstatSetOmega(PC, double);
47 extern int PCSORSetIterations(PC, int);
48 
49 extern int PCBJacobiSetBlocks(PC, int);
50 
51 extern int PCICCSetBlockSolveIter(PC);
52 
53 extern int PCShellSetApply(PC, int (*)(void*,Vec,Vec), void*);
54 extern int PCShellSetApplyRichardson(PC,int (*)(void*,Vec,Vec,Vec,int),void*);
55 
56 extern int PCGetOperators(PC,Mat*,Mat*,int*);
57 
58 extern int PCDirectSetOrdering(PC,int);
59 extern int PCDirectSetUseInplace(PC);
60 extern int PCILUSetOrdering(PC,int);
61 extern int PCILUSetLevels(PC,int);
62 
63 #endif
64 
65