xref: /petsc/include/petscpc.h (revision 49c465302fbc3d2f8bd3a12a002e9ced08d7a437)
1*49c46530SBarry Smith /* $Id: pc.h,v 1.38 1995/11/19 00:51:30 bsmith Exp bsmith $ */
2d03aef70SBarry Smith 
3d03aef70SBarry Smith /*
4f26ada1bSBarry Smith       Preconditioner module. Defines the preconditioner routines.
5d03aef70SBarry Smith */
6d03aef70SBarry Smith #if !defined(__PC_PACKAGE)
7d03aef70SBarry Smith #define __PC_PACKAGE
8d03aef70SBarry Smith #include "petsc.h"
9d03aef70SBarry Smith #include "mat.h"
10d03aef70SBarry Smith 
11070d5079SBarry Smith typedef enum { PCNONE, PCJACOBI, PCSOR, PCLU, PCSHELL, PCBJACOBI, PCMG,
12cddf8d76SBarry Smith                PCEISENSTAT, PCILU, PCICC, PCASM } PCMethod;
13d03aef70SBarry Smith 
14d03aef70SBarry Smith typedef struct _PC* PC;
159e25ed09SBarry Smith #define PC_COOKIE    PETSC_COOKIE+9
16d03aef70SBarry Smith 
176b5873e3SBarry Smith extern int    PCCreate(MPI_Comm,PC*);
18ca9b4cbeSLois Curfman McInnes extern int    PCSetMethod(PC,PCMethod);
198ed539a5SBarry Smith extern int    PCSetUp(PC);
20aabeff55SBarry Smith extern int    PCApply(PC,Vec,Vec);
21aabeff55SBarry Smith extern int    PCApplyBAorAB(PC,int,Vec,Vec,Vec);
22aabeff55SBarry Smith extern int    PCApplyTrans(PC,Vec,Vec);
23aabeff55SBarry Smith extern int    PCApplyBAorABTrans(PC,int,Vec,Vec,Vec);
24aabeff55SBarry Smith extern int    PCApplyRichardson(PC,Vec,Vec,Vec,int);
258ed539a5SBarry Smith extern int    PCApplyRichardsonExists(PC);
268ed539a5SBarry Smith extern int    PCRegisterAll();
27d6dfbf8fSBarry Smith extern int    PCRegisterDestroy();
28ca9b4cbeSLois Curfman McInnes extern int    PCRegister(PCMethod,char *,int (*)(PC));
298ed539a5SBarry Smith extern int    PCDestroy(PC);
308ed539a5SBarry Smith extern int    PCSetFromOptions(PC);
31ca9b4cbeSLois Curfman McInnes extern int    PCGetMethodFromContext(PC,PCMethod*);
32ca9b4cbeSLois Curfman McInnes extern int    PCGetMethodName(PCMethod,char **);
33291315efSLois Curfman McInnes extern int    PCGetFactoredMatrix(PC,Mat*);
345b116368SBarry Smith 
355b116368SBarry Smith /* Flags for PCSetOperators */
3696e03844SLois Curfman McInnes typedef enum {ALLMAT_DIFFERENT_NONZERO_PATTERN=0,MAT_SAME_NONZERO_PATTERN=1,
37f26ada1bSBarry Smith               PMAT_SAME_NONZERO_PATTERN=2,ALLMAT_SAME_NONZERO_PATTERN=3} MatStructure;
385b116368SBarry Smith 
3996e03844SLois Curfman McInnes extern int PCSetOperators(PC,Mat,Mat,MatStructure);
408ed539a5SBarry Smith extern int PCSetVector(PC,Vec);
418ed539a5SBarry Smith extern int PCPrintHelp(PC);
42023758ceSLois Curfman McInnes extern int PCView(PC,Viewer);
431eb62cbbSBarry Smith extern int PCSetOptionsPrefix(PC,char*);
448ed539a5SBarry Smith 
45ddda3453SLois Curfman McInnes extern int PCSORSetSymmetric(PC, MatSORType);
468ed539a5SBarry Smith extern int PCSORSetOmega(PC, double);
475b116368SBarry Smith extern int PCEisenstatSetOmega(PC, double);
4820563c6bSBarry Smith extern int PCSORSetIterations(PC, int);
49d03aef70SBarry Smith 
50*49c46530SBarry Smith #define USE_PRECONDITIONER_MATRIX 0
51*49c46530SBarry Smith #define USE_TRUE_MATRIX           1
52*49c46530SBarry Smith 
53*49c46530SBarry Smith extern int PCBJacobiSetUseTrueLocal(PC);
54*49c46530SBarry Smith extern int PCBJacobiSetTotalBlocks(PC, int, int*,int*);
55*49c46530SBarry Smith extern int PCBJacobiSetLocalBlocks(PC, int, int*,int*);
561eb62cbbSBarry Smith 
57e3e2a4cfSLois Curfman McInnes extern int PCBSIterSetBlockSolve(PC);
587d5e31e2SLois Curfman McInnes extern int PCBSIterSetFromOptions(PC);
59e3e2a4cfSLois Curfman McInnes extern int PCBSIterSolve(PC,Vec,Vec,int*);
60c06847eeSLois Curfman McInnes 
61aabeff55SBarry Smith extern int PCShellSetApply(PC, int (*)(void*,Vec,Vec), void*);
62f0479e8cSBarry Smith extern int PCShellSetApplyRichardson(PC,int (*)(void*,Vec,Vec,Vec,int),void*);
63aabeff55SBarry Smith 
64722fc279SLois Curfman McInnes extern int PCGetOperators(PC,Mat*,Mat*,MatStructure*);
65da3a660dSBarry Smith 
660213d9f2SLois Curfman McInnes extern int PCLUSetUseInPlace(PC);
670213d9f2SLois Curfman McInnes extern int PCILUSetUseInPlace(PC);
689e25ed09SBarry Smith extern int PCILUSetLevels(PC,int);
6924a74354SBarry Smith extern int PCEisenstatUseDiagonalScaling(PC);
709e25ed09SBarry Smith 
71d7e8b826SBarry Smith extern int PCASMCreateSubdomains2D(int,int,int,int,int,int,int *,IS **);
72d7e8b826SBarry Smith extern int PCASMSetSubdomains(PC, int, IS *);
7360907fceSBarry Smith 
74d03aef70SBarry Smith #endif
75da3a660dSBarry Smith 
76