xref: /petsc/include/petscpc.h (revision 96e03844b6074df1b564e8b619e85999f387aba6)
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,
11ca9b4cbeSLois 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*);
17ca9b4cbeSLois 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();
27ca9b4cbeSLois Curfman McInnes extern int    PCRegister(PCMethod,char *,int (*)(PC));
288ed539a5SBarry Smith extern int    PCDestroy(PC);
298ed539a5SBarry Smith extern int    PCSetFromOptions(PC);
30ca9b4cbeSLois Curfman McInnes extern int    PCGetMethodFromContext(PC,PCMethod*);
31ca9b4cbeSLois Curfman McInnes extern int    PCGetMethodName(PCMethod,char **);
325b116368SBarry Smith 
335b116368SBarry Smith /* Flags for PCSetOperators */
34*96e03844SLois Curfman McInnes typedef enum {ALLMAT_DIFFERENT_NONZERO_PATTERN=0,MAT_SAME_NONZERO_PATTERN=1,
35*96e03844SLois Curfman McInnes               PMAT_SAME_NONZERO_PATTERN=2,ALLMAT_SAME_NONZERO_PATTERN=3}
36*96e03844SLois Curfman McInnes               MatStructure;
375b116368SBarry Smith 
38*96e03844SLois Curfman McInnes extern int PCSetOperators(PC,Mat,Mat,MatStructure);
3928988994SBarry Smith extern int PCBJacobiSetUseTrueLocal(PC);
408ed539a5SBarry Smith extern int PCSetVector(PC,Vec);
418ed539a5SBarry Smith extern int PCPrintHelp(PC);
421eb62cbbSBarry Smith extern int PCSetOptionsPrefix(PC,char*);
438ed539a5SBarry Smith 
44ddda3453SLois Curfman McInnes extern int PCSORSetSymmetric(PC, MatSORType);
458ed539a5SBarry Smith extern int PCSORSetOmega(PC, double);
465b116368SBarry Smith extern int PCEisenstatSetOmega(PC, double);
4720563c6bSBarry Smith extern int PCSORSetIterations(PC, int);
48d03aef70SBarry Smith 
491eb62cbbSBarry Smith extern int PCBJacobiSetBlocks(PC, int);
501eb62cbbSBarry Smith 
51e3e2a4cfSLois Curfman McInnes extern int PCBSIterSetBlockSolve(PC);
52e3e2a4cfSLois Curfman McInnes extern int PCBSIterSetFrompOptions(PC);
53e3e2a4cfSLois Curfman McInnes extern int PCBSIterSolve(PC,Vec,Vec,int*);
54c06847eeSLois Curfman McInnes 
55aabeff55SBarry Smith extern int PCShellSetApply(PC, int (*)(void*,Vec,Vec), void*);
56f0479e8cSBarry Smith extern int PCShellSetApplyRichardson(PC,int (*)(void*,Vec,Vec,Vec,int),void*);
57aabeff55SBarry Smith 
584a18de47SLois Curfman McInnes extern int PCGetOperators(PC,Mat*,Mat*,int*);
59da3a660dSBarry Smith 
6098c7c891SBarry Smith extern int PCLUSetOrdering(PC,MatOrdering);
61070d5079SBarry Smith extern int PCLUSetUseInplace(PC);
6298c7c891SBarry Smith extern int PCILUSetOrdering(PC,MatOrdering);
639e25ed09SBarry Smith extern int PCILUSetLevels(PC,int);
649e25ed09SBarry Smith 
65d03aef70SBarry Smith #endif
66da3a660dSBarry Smith 
67