1 /* $Id: pc.h,v 1.65 1997/02/03 06:03:27 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, PCNEW } PCType; 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 typedef enum { PC_LEFT, PC_RIGHT, PC_SYMMETRIC } PCSide; 21 22 extern int PCCreate(MPI_Comm,PC*); 23 extern int PCSetType(PC,PCType); 24 extern int PCSetUp(PC); 25 extern int PCSetUpOnBlocks(PC); 26 extern int PCApply(PC,Vec,Vec); 27 extern int PCApplySymmetricLeft(PC,Vec,Vec); 28 extern int PCApplySymmetricRight(PC,Vec,Vec); 29 extern int PCApplyBAorAB(PC,PCSide,Vec,Vec,Vec); 30 extern int PCApplyTrans(PC,Vec,Vec); 31 extern int PCApplyBAorABTrans(PC,PCSide,Vec,Vec,Vec); 32 extern int PCApplyRichardson(PC,Vec,Vec,Vec,int); 33 extern int PCApplyRichardsonExists(PC,PetscTruth*); 34 35 extern int PCRegister(PCType,PCType*,char *,int (*)(PC)); 36 extern int PCRegisterDestroy(); 37 extern int PCRegisterAll(); 38 extern int PCRegisterAllCalled; 39 40 extern int PCDestroy(PC); 41 extern int PCSetFromOptions(PC); 42 extern int PCGetType(PC,PCType*,char**); 43 extern int PCGetFactoredMatrix(PC,Mat*); 44 extern int PCSetModifySubMatrices(PC,int(*)(PC,int,IS*,IS*,Mat*,void*),void*); 45 extern int PCModifySubMatrices(PC,int,IS*,IS*,Mat*,void*); 46 47 typedef enum {SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER} 48 MatStructure; 49 extern int PCSetOperators(PC,Mat,Mat,MatStructure); 50 extern int PCGetOperators(PC,Mat*,Mat*,MatStructure*); 51 52 extern int PCSetVector(PC,Vec); 53 extern int PCPrintHelp(PC); 54 extern int PCView(PC,Viewer); 55 56 extern int PCSetOptionsPrefix(PC,char*); 57 extern int PCAppendOptionsPrefix(PC,char*); 58 extern int PCGetOptionsPrefix(PC,char**); 59 60 extern int PCNullSpaceCreate(MPI_Comm,int,int,Vec *,PCNullSpace*); 61 extern int PCNullSpaceDestroy(PCNullSpace); 62 extern int PCNullSpaceRemove(PCNullSpace,Vec); 63 64 /* ------------- options specific to particular preconditioners --------- */ 65 extern int PCSORSetSymmetric(PC, MatSORType); 66 extern int PCSORSetOmega(PC, double); 67 extern int PCEisenstatSetOmega(PC, double); 68 extern int PCSORSetIterations(PC, int); 69 70 typedef enum {PCBGS_FORWARD_SWEEP=1,PCBGS_SYMMETRIC_SWEEP=2} PCBGSType; 71 extern int PCBGSSetSymmetric(PC, PCBGSType); 72 73 #define USE_PRECONDITIONER_MATRIX 0 74 #define USE_TRUE_MATRIX 1 75 extern int PCBJacobiSetUseTrueLocal(PC); 76 extern int PCBJacobiSetTotalBlocks(PC, int, int*); 77 extern int PCBJacobiSetLocalBlocks(PC, int, int*); 78 79 extern int PCBGSSetUseTrueLocal(PC); 80 extern int PCBGSSetTotalBlocks(PC, int, int*); 81 extern int PCBGSSetLocalBlocks(PC, int, int*); 82 extern int PCBGSSetSymmetric(PC, PCBGSType); 83 84 extern int PCShellSetApply(PC, int (*)(void*,Vec,Vec), void*); 85 extern int PCShellSetApplyRichardson(PC,int (*)(void*,Vec,Vec,Vec,int),void*); 86 extern int PCShellSetName(PC,char*); 87 extern int PCShellGetName(PC,char**); 88 89 extern int PCLUSetUseInPlace(PC); 90 extern int PCILUSetUseInPlace(PC); 91 extern int PCILUSetLevels(PC,int); 92 extern int PCILUSetReuseReordering(PC,PetscTruth); 93 extern int PCILUSetUseDropTolerance(PC,double,int); 94 extern int PCILUSetReuseFill(PC,PetscTruth); 95 96 extern int PCEisenstatUseDiagonalScaling(PC); 97 98 extern int PCASMSetLocalSubdomains(PC, int, IS *); 99 extern int PCASMSetTotalSubdomains(PC, int, IS *); 100 extern int PCASMSetOverlap(PC, int); 101 typedef enum {PC_ASM_BASIC = 3,PC_ASM_RESTRICT = 1,PC_ASM_INTERPOLATE = 2,PC_ASM_NONE = 0} PCASMType; 102 extern int PCASMSetType(PC,PCASMType); 103 104 extern int PCASMCreateSubdomains2D(int,int,int,int,int,int,int *,IS **); 105 #endif 106 107