xref: /petsc/include/petscpc.h (revision 023758cecdd3162c7896f8b20e963487a8e45703)
1*023758ceSLois Curfman McInnes /* $Id: pc.h,v 1.25 1995/07/03 21:45:40 bsmith 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 **);
335b116368SBarry Smith 
345b116368SBarry Smith /* Flags for PCSetOperators */
3596e03844SLois Curfman McInnes typedef enum {ALLMAT_DIFFERENT_NONZERO_PATTERN=0,MAT_SAME_NONZERO_PATTERN=1,
3696e03844SLois Curfman McInnes               PMAT_SAME_NONZERO_PATTERN=2,ALLMAT_SAME_NONZERO_PATTERN=3}
3796e03844SLois Curfman McInnes               MatStructure;
385b116368SBarry Smith 
3996e03844SLois Curfman McInnes extern int PCSetOperators(PC,Mat,Mat,MatStructure);
4028988994SBarry Smith extern int PCBJacobiSetUseTrueLocal(PC);
418ed539a5SBarry Smith extern int PCSetVector(PC,Vec);
428ed539a5SBarry Smith extern int PCPrintHelp(PC);
43*023758ceSLois Curfman McInnes extern int PCView(PC,Viewer);
441eb62cbbSBarry Smith extern int PCSetOptionsPrefix(PC,char*);
458ed539a5SBarry Smith 
46ddda3453SLois Curfman McInnes extern int PCSORSetSymmetric(PC, MatSORType);
478ed539a5SBarry Smith extern int PCSORSetOmega(PC, double);
485b116368SBarry Smith extern int PCEisenstatSetOmega(PC, double);
4920563c6bSBarry Smith extern int PCSORSetIterations(PC, int);
50d03aef70SBarry Smith 
511eb62cbbSBarry Smith extern int PCBJacobiSetBlocks(PC, int);
521eb62cbbSBarry Smith 
53e3e2a4cfSLois Curfman McInnes extern int PCBSIterSetBlockSolve(PC);
54e3e2a4cfSLois Curfman McInnes extern int PCBSIterSetFrompOptions(PC);
55e3e2a4cfSLois Curfman McInnes extern int PCBSIterSolve(PC,Vec,Vec,int*);
56c06847eeSLois Curfman McInnes 
57aabeff55SBarry Smith extern int PCShellSetApply(PC, int (*)(void*,Vec,Vec), void*);
58f0479e8cSBarry Smith extern int PCShellSetApplyRichardson(PC,int (*)(void*,Vec,Vec,Vec,int),void*);
59aabeff55SBarry Smith 
60722fc279SLois Curfman McInnes extern int PCGetOperators(PC,Mat*,Mat*,MatStructure*);
61da3a660dSBarry Smith 
6298c7c891SBarry Smith extern int PCLUSetOrdering(PC,MatOrdering);
63070d5079SBarry Smith extern int PCLUSetUseInplace(PC);
6498c7c891SBarry Smith extern int PCILUSetOrdering(PC,MatOrdering);
659e25ed09SBarry Smith extern int PCILUSetLevels(PC,int);
669e25ed09SBarry Smith 
67d03aef70SBarry Smith #endif
68da3a660dSBarry Smith 
69