xref: /petsc/include/petscpc.h (revision eccfb7eb91040ee4c7822ee2cc0d92b9472b1531)
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, PCLU, 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    PCGetMethodFromContext(PC,PCMethod*);
31 extern int    PCGetMethodName(PCMethod,char **);
32 
33 /* Flags for PCSetOperators */
34 typedef enum {ALLMAT_DIFFERENT_NONZERO_PATTERN=0,MAT_SAME_NONZERO_PATTERN=1,
35               PMAT_SAME_NONZERO_PATTERN=2,ALLMAT_SAME_NONZERO_PATTERN=3}
36               MatStructure;
37 
38 extern int PCSetOperators(PC,Mat,Mat,MatStructure);
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, MatSORType);
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 PCBSIterSetBlockSolve(PC);
52 extern int PCBSIterSetFrompOptions(PC);
53 extern int PCBSIterSolve(PC,Vec,Vec,int*);
54 
55 extern int PCShellSetApply(PC, int (*)(void*,Vec,Vec), void*);
56 extern int PCShellSetApplyRichardson(PC,int (*)(void*,Vec,Vec,Vec,int),void*);
57 
58 extern int PCGetOperators(PC,Mat*,Mat*,int*);
59 
60 extern int PCLUSetOrdering(PC,MatOrdering);
61 extern int PCLUSetUseInplace(PC);
62 extern int PCILUSetOrdering(PC,MatOrdering);
63 extern int PCILUSetLevels(PC,int);
64 
65 #endif
66 
67