xref: /petsc/include/petscpc.h (revision 21e957620e51e475c881b717474b8eb4dde9eeda)
1*21e95762SBarry Smith /* $Id: pc.h,v 1.39 1995/12/03 02:42:03 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,
12*21e95762SBarry Smith                PCEISENSTAT, PCILU, PCICC, PCASM, PCBGS } PCMethod;
13d03aef70SBarry Smith 
14d03aef70SBarry Smith typedef struct _PC* PC;
159e25ed09SBarry Smith #define PC_COOKIE    PETSC_COOKIE+9
16d03aef70SBarry Smith 
17*21e95762SBarry Smith typedef struct _PCNullSpace* PCNullSpace;
18*21e95762SBarry Smith #define PCNULLSPACE_COOKIE    PETSC_COOKIE+17
19*21e95762SBarry Smith 
20*21e95762SBarry Smith extern int    PCNullSpaceCreate(MPI_Comm,int,int,Vec *,PCNullSpace*);
21*21e95762SBarry Smith extern int    PCNullSpaceDestroy(PCNullSpace);
22*21e95762SBarry Smith extern int    PCNullSpaceRemove(PCNullSpace,Vec);
23*21e95762SBarry Smith 
246b5873e3SBarry Smith extern int    PCCreate(MPI_Comm,PC*);
25ca9b4cbeSLois Curfman McInnes extern int    PCSetMethod(PC,PCMethod);
268ed539a5SBarry Smith extern int    PCSetUp(PC);
27aabeff55SBarry Smith extern int    PCApply(PC,Vec,Vec);
28aabeff55SBarry Smith extern int    PCApplyBAorAB(PC,int,Vec,Vec,Vec);
29aabeff55SBarry Smith extern int    PCApplyTrans(PC,Vec,Vec);
30aabeff55SBarry Smith extern int    PCApplyBAorABTrans(PC,int,Vec,Vec,Vec);
31aabeff55SBarry Smith extern int    PCApplyRichardson(PC,Vec,Vec,Vec,int);
328ed539a5SBarry Smith extern int    PCApplyRichardsonExists(PC);
338ed539a5SBarry Smith extern int    PCRegisterAll();
34d6dfbf8fSBarry Smith extern int    PCRegisterDestroy();
35ca9b4cbeSLois Curfman McInnes extern int    PCRegister(PCMethod,char *,int (*)(PC));
368ed539a5SBarry Smith extern int    PCDestroy(PC);
378ed539a5SBarry Smith extern int    PCSetFromOptions(PC);
38ca9b4cbeSLois Curfman McInnes extern int    PCGetMethodFromContext(PC,PCMethod*);
39ca9b4cbeSLois Curfman McInnes extern int    PCGetMethodName(PCMethod,char **);
40291315efSLois Curfman McInnes extern int    PCGetFactoredMatrix(PC,Mat*);
415b116368SBarry Smith 
425b116368SBarry Smith /* Flags for PCSetOperators */
4396e03844SLois Curfman McInnes typedef enum {ALLMAT_DIFFERENT_NONZERO_PATTERN=0,MAT_SAME_NONZERO_PATTERN=1,
44f26ada1bSBarry Smith               PMAT_SAME_NONZERO_PATTERN=2,ALLMAT_SAME_NONZERO_PATTERN=3} MatStructure;
455b116368SBarry Smith 
4696e03844SLois Curfman McInnes extern int PCSetOperators(PC,Mat,Mat,MatStructure);
478ed539a5SBarry Smith extern int PCSetVector(PC,Vec);
488ed539a5SBarry Smith extern int PCPrintHelp(PC);
49023758ceSLois Curfman McInnes extern int PCView(PC,Viewer);
501eb62cbbSBarry Smith extern int PCSetOptionsPrefix(PC,char*);
518ed539a5SBarry Smith 
52ddda3453SLois Curfman McInnes extern int PCSORSetSymmetric(PC, MatSORType);
538ed539a5SBarry Smith extern int PCSORSetOmega(PC, double);
545b116368SBarry Smith extern int PCEisenstatSetOmega(PC, double);
5520563c6bSBarry Smith extern int PCSORSetIterations(PC, int);
56d03aef70SBarry Smith 
5749c46530SBarry Smith #define USE_PRECONDITIONER_MATRIX 0
5849c46530SBarry Smith #define USE_TRUE_MATRIX           1
5949c46530SBarry Smith 
6049c46530SBarry Smith extern int PCBJacobiSetUseTrueLocal(PC);
6149c46530SBarry Smith extern int PCBJacobiSetTotalBlocks(PC, int, int*,int*);
6249c46530SBarry Smith extern int PCBJacobiSetLocalBlocks(PC, int, int*,int*);
631eb62cbbSBarry Smith 
64e3e2a4cfSLois Curfman McInnes extern int PCBSIterSetBlockSolve(PC);
657d5e31e2SLois Curfman McInnes extern int PCBSIterSetFromOptions(PC);
66e3e2a4cfSLois Curfman McInnes extern int PCBSIterSolve(PC,Vec,Vec,int*);
67c06847eeSLois Curfman McInnes 
68aabeff55SBarry Smith extern int PCShellSetApply(PC, int (*)(void*,Vec,Vec), void*);
69f0479e8cSBarry Smith extern int PCShellSetApplyRichardson(PC,int (*)(void*,Vec,Vec,Vec,int),void*);
70aabeff55SBarry Smith 
71722fc279SLois Curfman McInnes extern int PCGetOperators(PC,Mat*,Mat*,MatStructure*);
72da3a660dSBarry Smith 
730213d9f2SLois Curfman McInnes extern int PCLUSetUseInPlace(PC);
740213d9f2SLois Curfman McInnes extern int PCILUSetUseInPlace(PC);
759e25ed09SBarry Smith extern int PCILUSetLevels(PC,int);
7624a74354SBarry Smith extern int PCEisenstatUseDiagonalScaling(PC);
779e25ed09SBarry Smith 
78d7e8b826SBarry Smith extern int PCASMCreateSubdomains2D(int,int,int,int,int,int,int *,IS **);
79d7e8b826SBarry Smith extern int PCASMSetSubdomains(PC, int, IS *);
8060907fceSBarry Smith 
81d03aef70SBarry Smith #endif
82da3a660dSBarry Smith 
83