xref: /petsc/include/petscpc.h (revision 18cf2ef4c649226b74061aabdfca4cf4dbcdc7f6)
1 /* $Id: snes.h,v 1.17 1995/06/02 21:05:19 bsmith Exp $ */
2 
3 /*
4       Preconditioner module.
5 */
6 #if !defined(__PC_PACKAGE)
7 #define __PC_PACKAGE
8 #include "petsc.h"
9 #include "mat.h"
10 
11 typedef enum { PCNONE, PCJACOBI, PCSOR, PCLU, PCSHELL, PCBJACOBI, PCMG,
12                PCESOR, PCILU, PCICC } PCMethod;
13 
14 typedef struct _PC* PC;
15 #define PC_COOKIE    PETSC_COOKIE+9
16 
17 extern int    PCCreate(MPI_Comm,PC*);
18 extern int    PCSetMethod(PC,PCMethod);
19 extern int    PCSetUp(PC);
20 extern int    PCApply(PC,Vec,Vec);
21 extern int    PCApplyBAorAB(PC,int,Vec,Vec,Vec);
22 extern int    PCApplyTrans(PC,Vec,Vec);
23 extern int    PCApplyBAorABTrans(PC,int,Vec,Vec,Vec);
24 extern int    PCApplyRichardson(PC,Vec,Vec,Vec,int);
25 extern int    PCApplyRichardsonExists(PC);
26 extern int    PCRegisterAll();
27 extern int    PCRegisterDestroy();
28 extern int    PCRegister(PCMethod,char *,int (*)(PC));
29 extern int    PCDestroy(PC);
30 extern int    PCSetFromOptions(PC);
31 extern int    PCGetMethodFromContext(PC,PCMethod*);
32 extern int    PCGetMethodName(PCMethod,char **);
33 
34 /* Flags for PCSetOperators */
35 typedef enum {ALLMAT_DIFFERENT_NONZERO_PATTERN=0,MAT_SAME_NONZERO_PATTERN=1,
36               PMAT_SAME_NONZERO_PATTERN=2,ALLMAT_SAME_NONZERO_PATTERN=3}
37               MatStructure;
38 
39 extern int PCSetOperators(PC,Mat,Mat,MatStructure);
40 extern int PCBJacobiSetUseTrueLocal(PC);
41 extern int PCSetVector(PC,Vec);
42 extern int PCPrintHelp(PC);
43 extern int PCSetOptionsPrefix(PC,char*);
44 
45 extern int PCSORSetSymmetric(PC, MatSORType);
46 extern int PCSORSetOmega(PC, double);
47 extern int PCEisenstatSetOmega(PC, double);
48 extern int PCSORSetIterations(PC, int);
49 
50 extern int PCBJacobiSetBlocks(PC, int);
51 
52 extern int PCBSIterSetBlockSolve(PC);
53 extern int PCBSIterSetFrompOptions(PC);
54 extern int PCBSIterSolve(PC,Vec,Vec,int*);
55 
56 extern int PCShellSetApply(PC, int (*)(void*,Vec,Vec), void*);
57 extern int PCShellSetApplyRichardson(PC,int (*)(void*,Vec,Vec,Vec,int),void*);
58 
59 extern int PCGetOperators(PC,Mat*,Mat*,MatStructure*);
60 
61 extern int PCLUSetOrdering(PC,MatOrdering);
62 extern int PCLUSetUseInplace(PC);
63 extern int PCILUSetOrdering(PC,MatOrdering);
64 extern int PCILUSetLevels(PC,int);
65 
66 #endif
67 
68