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