xref: /petsc/include/petscpc.h (revision 08480c60afa5ef1d2e4e27b9ebdf48b02c6a2186) !
1 /* $Id: pc.h,v 1.34 1995/10/11 15:20:50 bsmith Exp curfman $ */
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                PCEISENSTAT, 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 extern int    PCGetFactoredMatrix(PC,Mat*);
34 
35 /* Flags for PCSetOperators */
36 typedef enum {ALLMAT_DIFFERENT_NONZERO_PATTERN=0,MAT_SAME_NONZERO_PATTERN=1,
37               PMAT_SAME_NONZERO_PATTERN=2,ALLMAT_SAME_NONZERO_PATTERN=3}
38               MatStructure;
39 
40 extern int PCSetOperators(PC,Mat,Mat,MatStructure);
41 extern int PCBJacobiSetUseTrueLocal(PC);
42 extern int PCSetVector(PC,Vec);
43 extern int PCPrintHelp(PC);
44 extern int PCView(PC,Viewer);
45 extern int PCSetOptionsPrefix(PC,char*);
46 
47 extern int PCSORSetSymmetric(PC, MatSORType);
48 extern int PCSORSetOmega(PC, double);
49 extern int PCEisenstatSetOmega(PC, double);
50 extern int PCSORSetIterations(PC, int);
51 
52 extern int PCBJacobiSetTotalBlocks(PC, int, int*);
53 extern int PCBJacobiSetLocalBlocks(PC, int, int*);
54 
55 extern int PCBSIterSetBlockSolve(PC);
56 extern int PCBSIterSetFromOptions(PC);
57 extern int PCBSIterSolve(PC,Vec,Vec,int*);
58 
59 extern int PCShellSetApply(PC, int (*)(void*,Vec,Vec), void*);
60 extern int PCShellSetApplyRichardson(PC,int (*)(void*,Vec,Vec,Vec,int),void*);
61 
62 extern int PCGetOperators(PC,Mat*,Mat*,MatStructure*);
63 
64 extern int PCLUSetUseInPlace(PC);
65 extern int PCILUSetUseInPlace(PC);
66 extern int PCILUSetLevels(PC,int);
67 extern int PCEisenstatUseDiagonalScaling(PC);
68 
69 extern int PCSPAISetParameters(PC,int,int,double);
70 extern int PCSPAIGetApproximateInverse(PC,Mat*);
71 
72 #endif
73 
74