xref: /petsc/include/petscpc.h (revision 291315efcac66f81e33b4eec1bc3b04228488bd5)
1*291315efSLois Curfman McInnes /* $Id: pc.h,v 1.26 1995/07/07 17:53:54 curfman Exp curfman $ */
2d03aef70SBarry Smith 
3d03aef70SBarry Smith /*
4d03aef70SBarry Smith       Preconditioner module.
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,
12108006f4SBarry Smith                PCESOR, PCILU, PCICC, PCSPAI } 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 **);
33*291315efSLois 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,
3796e03844SLois Curfman McInnes               PMAT_SAME_NONZERO_PATTERN=2,ALLMAT_SAME_NONZERO_PATTERN=3}
3896e03844SLois Curfman McInnes               MatStructure;
395b116368SBarry Smith 
4096e03844SLois Curfman McInnes extern int PCSetOperators(PC,Mat,Mat,MatStructure);
4128988994SBarry Smith extern int PCBJacobiSetUseTrueLocal(PC);
428ed539a5SBarry Smith extern int PCSetVector(PC,Vec);
438ed539a5SBarry Smith extern int PCPrintHelp(PC);
44023758ceSLois Curfman McInnes extern int PCView(PC,Viewer);
451eb62cbbSBarry Smith extern int PCSetOptionsPrefix(PC,char*);
468ed539a5SBarry Smith 
47ddda3453SLois Curfman McInnes extern int PCSORSetSymmetric(PC, MatSORType);
488ed539a5SBarry Smith extern int PCSORSetOmega(PC, double);
495b116368SBarry Smith extern int PCEisenstatSetOmega(PC, double);
5020563c6bSBarry Smith extern int PCSORSetIterations(PC, int);
51d03aef70SBarry Smith 
521eb62cbbSBarry Smith extern int PCBJacobiSetBlocks(PC, int);
531eb62cbbSBarry Smith 
54e3e2a4cfSLois Curfman McInnes extern int PCBSIterSetBlockSolve(PC);
55e3e2a4cfSLois Curfman McInnes extern int PCBSIterSetFrompOptions(PC);
56e3e2a4cfSLois Curfman McInnes extern int PCBSIterSolve(PC,Vec,Vec,int*);
57c06847eeSLois Curfman McInnes 
58aabeff55SBarry Smith extern int PCShellSetApply(PC, int (*)(void*,Vec,Vec), void*);
59f0479e8cSBarry Smith extern int PCShellSetApplyRichardson(PC,int (*)(void*,Vec,Vec,Vec,int),void*);
60aabeff55SBarry Smith 
61722fc279SLois Curfman McInnes extern int PCGetOperators(PC,Mat*,Mat*,MatStructure*);
62da3a660dSBarry Smith 
6398c7c891SBarry Smith extern int PCLUSetOrdering(PC,MatOrdering);
64070d5079SBarry Smith extern int PCLUSetUseInplace(PC);
6598c7c891SBarry Smith extern int PCILUSetOrdering(PC,MatOrdering);
669e25ed09SBarry Smith extern int PCILUSetLevels(PC,int);
679e25ed09SBarry Smith 
68d03aef70SBarry Smith #endif
69da3a660dSBarry Smith 
70