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