xref: /petsc/include/petscpc.h (revision 4f312a90a366a13095c7f6ce7977c3885e6f093f)
1 /* $Id: pc.h,v 1.38 1995/11/19 00:51:30 bsmith Exp bsmith $ */
2 
3 /*
4       Preconditioner module. Defines the preconditioner routines.
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, PCASM } 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} MatStructure;
38 
39 extern int PCSetOperators(PC,Mat,Mat,MatStructure);
40 extern int PCSetVector(PC,Vec);
41 extern int PCPrintHelp(PC);
42 extern int PCView(PC,Viewer);
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 #define USE_PRECONDITIONER_MATRIX 0
51 #define USE_TRUE_MATRIX           1
52 
53 extern int PCBJacobiSetUseTrueLocal(PC);
54 extern int PCBJacobiSetTotalBlocks(PC, int, int*,int*);
55 extern int PCBJacobiSetLocalBlocks(PC, int, int*,int*);
56 
57 extern int PCBSIterSetBlockSolve(PC);
58 extern int PCBSIterSetFromOptions(PC);
59 extern int PCBSIterSolve(PC,Vec,Vec,int*);
60 
61 extern int PCShellSetApply(PC, int (*)(void*,Vec,Vec), void*);
62 extern int PCShellSetApplyRichardson(PC,int (*)(void*,Vec,Vec,Vec,int),void*);
63 
64 extern int PCGetOperators(PC,Mat*,Mat*,MatStructure*);
65 
66 extern int PCLUSetUseInPlace(PC);
67 extern int PCILUSetUseInPlace(PC);
68 extern int PCILUSetLevels(PC,int);
69 extern int PCEisenstatUseDiagonalScaling(PC);
70 
71 extern int PCASMCreateSubdomains2D(int,int,int,int,int,int,int *,IS **);
72 extern int PCASMSetSubdomains(PC, int, IS *);
73 
74 #endif
75 
76