xref: /petsc/include/petscpc.h (revision ca9b4cbefb8bdd5bf33d30f0b59e3256ed28803f)
1d03aef70SBarry Smith 
2d03aef70SBarry Smith /*
3d03aef70SBarry Smith       Preconditioner module.
4d03aef70SBarry Smith */
5d03aef70SBarry Smith #if !defined(__PC_PACKAGE)
6d03aef70SBarry Smith #define __PC_PACKAGE
7d03aef70SBarry Smith #include "petsc.h"
8d03aef70SBarry Smith #include "mat.h"
9d03aef70SBarry Smith 
10070d5079SBarry Smith typedef enum { PCNONE, PCJACOBI, PCSOR, PCLU, PCSHELL, PCBJACOBI, PCMG,
11*ca9b4cbeSLois Curfman McInnes                PCESOR, PCILU, PCICC } PCMethod;
12d03aef70SBarry Smith 
13d03aef70SBarry Smith typedef struct _PC* PC;
149e25ed09SBarry Smith #define PC_COOKIE    PETSC_COOKIE+9
15d03aef70SBarry Smith 
166b5873e3SBarry Smith extern int    PCCreate(MPI_Comm,PC*);
17*ca9b4cbeSLois Curfman McInnes extern int    PCSetMethod(PC,PCMethod);
188ed539a5SBarry Smith extern int    PCSetUp(PC);
19aabeff55SBarry Smith extern int    PCApply(PC,Vec,Vec);
20aabeff55SBarry Smith extern int    PCApplyBAorAB(PC,int,Vec,Vec,Vec);
21aabeff55SBarry Smith extern int    PCApplyTrans(PC,Vec,Vec);
22aabeff55SBarry Smith extern int    PCApplyBAorABTrans(PC,int,Vec,Vec,Vec);
23aabeff55SBarry Smith extern int    PCApplyRichardson(PC,Vec,Vec,Vec,int);
248ed539a5SBarry Smith extern int    PCApplyRichardsonExists(PC);
258ed539a5SBarry Smith extern int    PCRegisterAll();
26d6dfbf8fSBarry Smith extern int    PCRegisterDestroy();
27*ca9b4cbeSLois Curfman McInnes extern int    PCRegister(PCMethod,char *,int (*)(PC));
288ed539a5SBarry Smith extern int    PCDestroy(PC);
298ed539a5SBarry Smith extern int    PCSetFromOptions(PC);
30*ca9b4cbeSLois Curfman McInnes extern int    PCGetMethodFromContext(PC,PCMethod*);
31*ca9b4cbeSLois Curfman McInnes extern int    PCGetMethodName(PCMethod,char **);
325b116368SBarry Smith 
335b116368SBarry Smith /* Flags for PCSetOperators */
345b116368SBarry Smith #define MAT_SAME_NONZERO_PATTERN 1
355b116368SBarry Smith 
3628988994SBarry Smith extern int    PCSetOperators(PC,Mat,Mat,int);
3728988994SBarry Smith extern int    PCBJacobiSetUseTrueLocal(PC);
388ed539a5SBarry Smith extern int    PCSetVector(PC,Vec);
398ed539a5SBarry Smith extern int    PCPrintHelp(PC);
401eb62cbbSBarry Smith extern int    PCSetOptionsPrefix(PC,char*);
418ed539a5SBarry Smith 
428ed539a5SBarry Smith extern int PCSORSetSymmetric(PC, int);
438ed539a5SBarry Smith extern int PCSORSetOmega(PC, double);
445b116368SBarry Smith extern int PCEisenstatSetOmega(PC, double);
4520563c6bSBarry Smith extern int PCSORSetIterations(PC, int);
46d03aef70SBarry Smith 
471eb62cbbSBarry Smith extern int PCBJacobiSetBlocks(PC, int);
481eb62cbbSBarry Smith 
49e3e2a4cfSLois Curfman McInnes extern int PCBSIterSetBlockSolve(PC);
50e3e2a4cfSLois Curfman McInnes extern int PCBSIterSetFrompOptions(PC);
51e3e2a4cfSLois Curfman McInnes extern int PCBSIterSolve(PC,Vec,Vec,int*);
52c06847eeSLois Curfman McInnes 
53aabeff55SBarry Smith extern int PCShellSetApply(PC, int (*)(void*,Vec,Vec), void*);
54f0479e8cSBarry Smith extern int PCShellSetApplyRichardson(PC,int (*)(void*,Vec,Vec,Vec,int),void*);
55aabeff55SBarry Smith 
564a18de47SLois Curfman McInnes extern int PCGetOperators(PC,Mat*,Mat*,int*);
57da3a660dSBarry Smith 
58070d5079SBarry Smith extern int PCLUSetOrdering(PC,int);
59070d5079SBarry Smith extern int PCLUSetUseInplace(PC);
609e25ed09SBarry Smith extern int PCILUSetOrdering(PC,int);
619e25ed09SBarry Smith extern int PCILUSetLevels(PC,int);
629e25ed09SBarry Smith 
63d03aef70SBarry Smith #endif
64da3a660dSBarry Smith 
65