xref: /petsc/include/petscpc.h (revision 15c3ef5c20f6edfd63caa08e2199f47f28d778cd) 
1*15c3ef5cSLois Curfman McInnes /* $Id: pc.h,v 1.53 1996/02/08 18:28:49 bsmith Exp curfman $ */
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,
124b0e389bSBarry Smith                PCEISENSTAT, PCILU, PCICC, PCASM, PCBGS } PCType;
13d03aef70SBarry Smith 
14d03aef70SBarry Smith typedef struct _PC* PC;
159e25ed09SBarry Smith #define PC_COOKIE    PETSC_COOKIE+9
16d03aef70SBarry Smith 
1721e95762SBarry Smith typedef struct _PCNullSpace* PCNullSpace;
1821e95762SBarry Smith #define PCNULLSPACE_COOKIE    PETSC_COOKIE+17
1921e95762SBarry Smith 
20aad2872bSLois Curfman McInnes typedef enum { PC_LEFT, PC_RIGHT, PC_SYMMETRIC } PCSide;
2172b7852fSLois Curfman McInnes 
226b5873e3SBarry Smith extern int    PCCreate(MPI_Comm,PC*);
234b0e389bSBarry Smith extern int    PCSetType(PC,PCType);
248ed539a5SBarry Smith extern int    PCSetUp(PC);
25aabeff55SBarry Smith extern int    PCApply(PC,Vec,Vec);
269f0e5d82SLois Curfman McInnes extern int    PCApplySymmLeft(PC,Vec,Vec);
279f0e5d82SLois Curfman McInnes extern int    PCApplySymmRight(PC,Vec,Vec);
28aad2872bSLois Curfman McInnes extern int    PCApplyBAorAB(PC,PCSide,Vec,Vec,Vec);
29aabeff55SBarry Smith extern int    PCApplyTrans(PC,Vec,Vec);
30aad2872bSLois Curfman McInnes extern int    PCApplyBAorABTrans(PC,PCSide,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();
354b0e389bSBarry Smith extern int    PCRegister(PCType,char *,int (*)(PC));
368ed539a5SBarry Smith extern int    PCDestroy(PC);
378ed539a5SBarry Smith extern int    PCSetFromOptions(PC);
384b0e389bSBarry Smith extern int    PCGetType(PC,PCType*,char**);
39291315efSLois Curfman McInnes extern int    PCGetFactoredMatrix(PC,Mat*);
405b116368SBarry Smith 
41*15c3ef5cSLois Curfman McInnes typedef enum {SAME_NONZERO_PATTERN=0,DIFFERENT_NONZERO_PATTERN=1,SAME_PRECONDITIONER=2}
42112a2221SBarry Smith               MatStructure;
4396e03844SLois Curfman McInnes extern int PCSetOperators(PC,Mat,Mat,MatStructure);
444b0e389bSBarry Smith extern int PCGetOperators(PC,Mat*,Mat*,MatStructure*);
454b0e389bSBarry Smith 
468ed539a5SBarry Smith extern int PCSetVector(PC,Vec);
478ed539a5SBarry Smith extern int PCPrintHelp(PC);
48023758ceSLois Curfman McInnes extern int PCView(PC,Viewer);
497bc3d0afSSatish Balay 
501eb62cbbSBarry Smith extern int PCSetOptionsPrefix(PC,char*);
510985bb82SSatish Balay extern int PCAppendOptionsPrefix(PC,char*);
520985bb82SSatish Balay extern int PCGetOptionsPrefix(PC,char**);
538ed539a5SBarry Smith 
544b0e389bSBarry Smith extern int PCNullSpaceCreate(MPI_Comm,int,int,Vec *,PCNullSpace*);
554b0e389bSBarry Smith extern int PCNullSpaceDestroy(PCNullSpace);
564b0e389bSBarry Smith extern int PCNullSpaceRemove(PCNullSpace,Vec);
574b0e389bSBarry Smith 
584b0e389bSBarry Smith /* options specific to particular preconditioners */
59ddda3453SLois Curfman McInnes extern int PCSORSetSymmetric(PC, MatSORType);
608ed539a5SBarry Smith extern int PCSORSetOmega(PC, double);
615b116368SBarry Smith extern int PCEisenstatSetOmega(PC, double);
6220563c6bSBarry Smith extern int PCSORSetIterations(PC, int);
63d03aef70SBarry Smith 
64d171954fSSatish Balay typedef enum {BGS_FORWARD_SWEEP=1,BGS_SYMMETRIC_SWEEP=2} PCBGSType;
65b4fd4287SBarry Smith extern int PCBGSSetSymmetric(PC, PCBGSType);
66b4fd4287SBarry Smith 
6749c46530SBarry Smith #define USE_PRECONDITIONER_MATRIX 0
6849c46530SBarry Smith #define USE_TRUE_MATRIX           1
6949c46530SBarry Smith 
7049c46530SBarry Smith extern int PCBJacobiSetUseTrueLocal(PC);
7149c46530SBarry Smith extern int PCBJacobiSetTotalBlocks(PC, int, int*,int*);
7249c46530SBarry Smith extern int PCBJacobiSetLocalBlocks(PC, int, int*,int*);
731eb62cbbSBarry Smith 
747daf8ffeSSatish Balay extern int PCBGSSetUseTrueLocal(PC);
757daf8ffeSSatish Balay extern int PCBGSSetTotalBlocks(PC, int, int*,int*);
767daf8ffeSSatish Balay extern int PCBGSSetLocalBlocks(PC, int, int*,int*);
777daf8ffeSSatish Balay extern int PCBGSSetSymmetric(PC, PCBGSType);
787daf8ffeSSatish Balay 
79e3e2a4cfSLois Curfman McInnes extern int PCBSIterSetBlockSolve(PC);
807d5e31e2SLois Curfman McInnes extern int PCBSIterSetFromOptions(PC);
81e3e2a4cfSLois Curfman McInnes extern int PCBSIterSolve(PC,Vec,Vec,int*);
82c06847eeSLois Curfman McInnes 
83aabeff55SBarry Smith extern int PCShellSetApply(PC, int (*)(void*,Vec,Vec), void*);
84f0479e8cSBarry Smith extern int PCShellSetApplyRichardson(PC,int (*)(void*,Vec,Vec,Vec,int),void*);
855f789019SLois Curfman McInnes extern int PCShellSetName(PC,char*);
865f789019SLois Curfman McInnes extern int PCShellGetName(PC,char**);
87aabeff55SBarry Smith 
880213d9f2SLois Curfman McInnes extern int PCLUSetUseInPlace(PC);
890213d9f2SLois Curfman McInnes extern int PCILUSetUseInPlace(PC);
909e25ed09SBarry Smith extern int PCILUSetLevels(PC,int);
9124a74354SBarry Smith extern int PCEisenstatUseDiagonalScaling(PC);
929e25ed09SBarry Smith 
93d7e8b826SBarry Smith extern int PCASMCreateSubdomains2D(int,int,int,int,int,int,int *,IS **);
94d7e8b826SBarry Smith extern int PCASMSetSubdomains(PC, int, IS *);
95de55ef05SSatish Balay extern int PCASMSetOverlap(PC, int);
96d03aef70SBarry Smith #endif
97da3a660dSBarry Smith 
98