1 /* $Id: pc.h,v 1.39 1995/12/03 02:42:03 bsmith Exp bsmith $ */ 2 3 /* 4 Preconditioner module. Defines the preconditioner routines. 5 */ 6 #if !defined(__PC_PACKAGE) 7 #define __PC_PACKAGE 8 #include "petsc.h" 9 #include "mat.h" 10 11 typedef enum { PCNONE, PCJACOBI, PCSOR, PCLU, PCSHELL, PCBJACOBI, PCMG, 12 PCEISENSTAT, PCILU, PCICC, PCASM, PCBGS } PCMethod; 13 14 typedef struct _PC* PC; 15 #define PC_COOKIE PETSC_COOKIE+9 16 17 typedef struct _PCNullSpace* PCNullSpace; 18 #define PCNULLSPACE_COOKIE PETSC_COOKIE+17 19 20 extern int PCNullSpaceCreate(MPI_Comm,int,int,Vec *,PCNullSpace*); 21 extern int PCNullSpaceDestroy(PCNullSpace); 22 extern int PCNullSpaceRemove(PCNullSpace,Vec); 23 24 extern int PCCreate(MPI_Comm,PC*); 25 extern int PCSetMethod(PC,PCMethod); 26 extern int PCSetUp(PC); 27 extern int PCApply(PC,Vec,Vec); 28 extern int PCApplyBAorAB(PC,int,Vec,Vec,Vec); 29 extern int PCApplyTrans(PC,Vec,Vec); 30 extern int PCApplyBAorABTrans(PC,int,Vec,Vec,Vec); 31 extern int PCApplyRichardson(PC,Vec,Vec,Vec,int); 32 extern int PCApplyRichardsonExists(PC); 33 extern int PCRegisterAll(); 34 extern int PCRegisterDestroy(); 35 extern int PCRegister(PCMethod,char *,int (*)(PC)); 36 extern int PCDestroy(PC); 37 extern int PCSetFromOptions(PC); 38 extern int PCGetMethodFromContext(PC,PCMethod*); 39 extern int PCGetMethodName(PCMethod,char **); 40 extern int PCGetFactoredMatrix(PC,Mat*); 41 42 /* Flags for PCSetOperators */ 43 typedef enum {ALLMAT_DIFFERENT_NONZERO_PATTERN=0,MAT_SAME_NONZERO_PATTERN=1, 44 PMAT_SAME_NONZERO_PATTERN=2,ALLMAT_SAME_NONZERO_PATTERN=3} MatStructure; 45 46 extern int PCSetOperators(PC,Mat,Mat,MatStructure); 47 extern int PCSetVector(PC,Vec); 48 extern int PCPrintHelp(PC); 49 extern int PCView(PC,Viewer); 50 extern int PCSetOptionsPrefix(PC,char*); 51 52 extern int PCSORSetSymmetric(PC, MatSORType); 53 extern int PCSORSetOmega(PC, double); 54 extern int PCEisenstatSetOmega(PC, double); 55 extern int PCSORSetIterations(PC, int); 56 57 #define USE_PRECONDITIONER_MATRIX 0 58 #define USE_TRUE_MATRIX 1 59 60 extern int PCBJacobiSetUseTrueLocal(PC); 61 extern int PCBJacobiSetTotalBlocks(PC, int, int*,int*); 62 extern int PCBJacobiSetLocalBlocks(PC, int, int*,int*); 63 64 extern int PCBSIterSetBlockSolve(PC); 65 extern int PCBSIterSetFromOptions(PC); 66 extern int PCBSIterSolve(PC,Vec,Vec,int*); 67 68 extern int PCShellSetApply(PC, int (*)(void*,Vec,Vec), void*); 69 extern int PCShellSetApplyRichardson(PC,int (*)(void*,Vec,Vec,Vec,int),void*); 70 71 extern int PCGetOperators(PC,Mat*,Mat*,MatStructure*); 72 73 extern int PCLUSetUseInPlace(PC); 74 extern int PCILUSetUseInPlace(PC); 75 extern int PCILUSetLevels(PC,int); 76 extern int PCEisenstatUseDiagonalScaling(PC); 77 78 extern int PCASMCreateSubdomains2D(int,int,int,int,int,int,int *,IS **); 79 extern int PCASMSetSubdomains(PC, int, IS *); 80 81 #endif 82 83