1 /* $Id: pc.h,v 1.80 1998/04/22 14:24:26 curfman Exp bsmith $ */ 2 3 /* 4 Preconditioner module. 5 */ 6 #if !defined(__PC_H) 7 #define __PC_H 8 #include "petsc.h" 9 #include "mat.h" 10 11 extern DLList PCList; 12 typedef char *PCType; 13 14 #define PCNONE "none" 15 #define PCJACOBI "jacobi" 16 #define PCSOR "sor" 17 #define PCLU "lu" 18 #define PCSHELL "shell" 19 #define PCBJACOBI "bjacobi" 20 #define PCMG "mg" 21 #define PCEISENSTAT "eisenstat" 22 #define PCILU "ilu" 23 #define PCICC "icc" 24 #define PCASM "asm" 25 #define PCBGS "bgs" 26 #define PCSLES "sles" 27 #define PCCOMPOSITE "composite" 28 29 typedef struct _p_PC* PC; 30 #define PC_COOKIE PETSC_COOKIE+9 31 32 /* 33 Null space code is not yet developed 34 */ 35 typedef struct _p_PCNullSpace* PCNullSpace; 36 #define PCNULLSPACE_COOKIE PETSC_COOKIE+17 37 38 typedef enum { PC_LEFT, PC_RIGHT, PC_SYMMETRIC } PCSide; 39 40 extern int PCCreate(MPI_Comm,PC*); 41 extern int PCSetType(PC,PCType); 42 extern int PCSetUp(PC); 43 extern int PCSetUpOnBlocks(PC); 44 extern int PCApply(PC,Vec,Vec); 45 extern int PCApplySymmetricLeft(PC,Vec,Vec); 46 extern int PCApplySymmetricRight(PC,Vec,Vec); 47 extern int PCApplyBAorAB(PC,PCSide,Vec,Vec,Vec); 48 extern int PCApplyTrans(PC,Vec,Vec); 49 extern int PCApplyBAorABTrans(PC,PCSide,Vec,Vec,Vec); 50 extern int PCApplyRichardson(PC,Vec,Vec,Vec,int); 51 extern int PCApplyRichardsonExists(PC,PetscTruth*); 52 53 extern int PCRegisterDestroy(void); 54 extern int PCRegisterAll(char*); 55 extern int PCRegisterAllCalled; 56 57 extern int PCRegister_Private(char*,char*,char*,int(*)(PC)); 58 #if defined(USE_DYNAMIC_LIBRARIES) 59 #define PCRegister(a,b,c,d) PCRegister_Private(a,b,c,0) 60 #else 61 #define PCRegister(a,b,c,d) PCRegister_Private(a,b,c,d) 62 #endif 63 64 extern int PCDestroy(PC); 65 extern int PCSetFromOptions(PC); 66 extern int PCGetType(PC,PCType*); 67 68 extern int PCGetFactoredMatrix(PC,Mat*); 69 extern int PCSetModifySubMatrices(PC,int(*)(PC,int,IS*,IS*,Mat*,void*),void*); 70 extern int PCModifySubMatrices(PC,int,IS*,IS*,Mat*,void*); 71 72 extern int PCSetOperators(PC,Mat,Mat,MatStructure); 73 extern int PCGetOperators(PC,Mat*,Mat*,MatStructure*); 74 75 extern int PCSetVector(PC,Vec); 76 extern int PCPrintHelp(PC); 77 extern int PCView(PC,Viewer); 78 79 extern int PCSetOptionsPrefix(PC,char*); 80 extern int PCAppendOptionsPrefix(PC,char*); 81 extern int PCGetOptionsPrefix(PC,char**); 82 83 extern int PCNullSpaceCreate(MPI_Comm,int,int,Vec *,PCNullSpace*); 84 extern int PCNullSpaceDestroy(PCNullSpace); 85 extern int PCNullSpaceRemove(PCNullSpace,Vec); 86 87 /* ------------- options specific to particular preconditioners --------- */ 88 extern int PCSORSetSymmetric(PC, MatSORType); 89 extern int PCSORSetOmega(PC, double); 90 extern int PCEisenstatSetOmega(PC, double); 91 extern int PCSORSetIterations(PC, int); 92 93 typedef enum {PCBGS_FORWARD_SWEEP=1,PCBGS_SYMMETRIC_SWEEP=2} PCBGSType; 94 extern int PCBGSSetSymmetric(PC, PCBGSType); 95 96 #define USE_PRECONDITIONER_MATRIX 0 97 #define USE_TRUE_MATRIX 1 98 extern int PCBJacobiSetUseTrueLocal(PC); 99 extern int PCBJacobiSetTotalBlocks(PC, int, int*); 100 extern int PCBJacobiSetLocalBlocks(PC, int, int*); 101 102 extern int PCBGSSetUseTrueLocal(PC); 103 extern int PCBGSSetTotalBlocks(PC, int, int*); 104 extern int PCBGSSetLocalBlocks(PC, int, int*); 105 extern int PCBGSSetSymmetric(PC, PCBGSType); 106 107 extern int PCSLESSetUseTrue(PC); 108 extern int PCCompositeSetUseTrue(PC); 109 110 extern int PCShellSetApply(PC, int (*)(void*,Vec,Vec), void*); 111 extern int PCShellSetApplyRichardson(PC,int (*)(void*,Vec,Vec,Vec,int),void*); 112 extern int PCShellSetName(PC,char*); 113 extern int PCShellGetName(PC,char**); 114 115 extern int PCLUSetMatReordering(PC,MatReorderingType); 116 extern int PCILUSetMatReordering(PC,MatReorderingType); 117 extern int PCLUSetUseInPlace(PC); 118 extern int PCLUSetFill(PC,double); 119 extern int PCILUSetUseInPlace(PC); 120 extern int PCILUSetFill(PC,double); 121 extern int PCILUSetLevels(PC,int); 122 extern int PCILUSetReuseReordering(PC,PetscTruth); 123 extern int PCILUSetUseDropTolerance(PC,double,int); 124 extern int PCILUSetReuseFill(PC,PetscTruth); 125 126 extern int PCEisenstatUseDiagonalScaling(PC); 127 128 extern int PCASMSetLocalSubdomains(PC, int, IS *); 129 extern int PCASMSetTotalSubdomains(PC, int, IS *); 130 extern int PCASMSetOverlap(PC, int); 131 typedef enum {PC_ASM_BASIC = 3,PC_ASM_RESTRICT = 1,PC_ASM_INTERPOLATE = 2,PC_ASM_NONE = 0} PCASMType; 132 extern int PCASMSetType(PC,PCASMType); 133 134 extern int PCASMCreateSubdomains2D(int,int,int,int,int,int,int *,IS **); 135 136 typedef enum {PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE} PCCompositeType; 137 extern int PCCompositeSetType(PC,PCCompositeType); 138 extern int PCCompositeAddPC(PC,PCType); 139 140 #endif 141 142 143 144 145