1 /* $Id: pc.h,v 1.97 2000/01/11 21:04:04 bsmith Exp bsmith $ */ 2 3 /* 4 Preconditioner module. 5 */ 6 #if !defined(__PC_H) 7 #define __PC_H 8 #include "mat.h" 9 10 /* 11 PCList contains the list of preconditioners currently registered 12 These are added with the PCRegisterDynamic() macro 13 */ 14 extern FList PCList; 15 typedef char *PCType; 16 17 /* 18 Standard PETSc preconditioners 19 */ 20 #define PCNONE "none" 21 #define PCJACOBI "jacobi" 22 #define PCSOR "sor" 23 #define PCLU "lu" 24 #define PCSHELL "shell" 25 #define PCBJACOBI "bjacobi" 26 #define PCMG "mg" 27 #define PCEISENSTAT "eisenstat" 28 #define PCILU "ilu" 29 #define PCICC "icc" 30 #define PCASM "asm" 31 #define PCSLES "sles" 32 #define PCCOMPOSITE "composite" 33 #define PCREDUNDANT "redundant" 34 35 typedef struct _p_PC* PC; 36 #define PC_COOKIE PETSC_COOKIE+9 37 38 /* 39 Null space code is not yet developed 40 */ 41 typedef struct _p_PCNullSpace* PCNullSpace; 42 #define PCNULLSPACE_COOKIE PETSC_COOKIE+17 43 44 typedef enum { PC_LEFT,PC_RIGHT,PC_SYMMETRIC } PCSide; 45 46 extern int PCCreate(MPI_Comm,PC*); 47 extern int PCSetType(PC,PCType); 48 extern int PCSetUp(PC); 49 extern int PCSetUpOnBlocks(PC); 50 extern int PCApply(PC,Vec,Vec); 51 extern int PCApplySymmetricLeft(PC,Vec,Vec); 52 extern int PCApplySymmetricRight(PC,Vec,Vec); 53 extern int PCApplyBAorAB(PC,PCSide,Vec,Vec,Vec); 54 extern int PCApplyTranspose(PC,Vec,Vec); 55 extern int PCApplyBAorABTranspose(PC,PCSide,Vec,Vec,Vec); 56 extern int PCApplyRichardson(PC,Vec,Vec,Vec,int); 57 extern int PCApplyRichardsonExists(PC,PetscTruth*); 58 59 extern int PCRegisterDestroy(void); 60 extern int PCRegisterAll(char*); 61 extern PetscTruth PCRegisterAllCalled; 62 63 extern int PCRegister(char*,char*,char*,int(*)(PC)); 64 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 65 #define PCRegisterDynamic(a,b,c,d) PCRegister(a,b,c,0) 66 #else 67 #define PCRegisterDynamic(a,b,c,d) PCRegister(a,b,c,d) 68 #endif 69 70 extern int PCDestroy(PC); 71 extern int PCSetFromOptions(PC); 72 extern int PCSetTypeFromOptions(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 extern int PCNullSpaceAttach(PC,PCNullSpace); 95 96 /* ------------- options specific to particular preconditioners --------- */ 97 98 extern int PCSORSetSymmetric(PC,MatSORType); 99 extern int PCSORSetOmega(PC,double); 100 extern int PCSORSetIterations(PC,int); 101 102 extern int PCEisenstatSetOmega(PC,double); 103 extern int PCEisenstatNoDiagonalScaling(PC); 104 105 #define USE_PRECONDITIONER_MATRIX 0 106 #define USE_TRUE_MATRIX 1 107 extern int PCBJacobiSetUseTrueLocal(PC); 108 extern int PCBJacobiSetTotalBlocks(PC,int,int*); 109 extern int PCBJacobiSetLocalBlocks(PC,int,int*); 110 111 extern int PCSLESSetUseTrue(PC); 112 extern int PCCompositeSetUseTrue(PC); 113 114 extern int PCShellSetApply(PC,int (*)(void*,Vec,Vec),void*); 115 extern int PCShellSetSetUp(PC,int (*)(void*)); 116 extern int PCShellSetApplyRichardson(PC,int (*)(void*,Vec,Vec,Vec,int),void*); 117 extern int PCShellSetName(PC,char*); 118 extern int PCShellGetName(PC,char**); 119 120 extern int PCLUSetMatOrdering(PC,MatOrderingType); 121 extern int PCLUSetReuseOrdering(PC,PetscTruth); 122 extern int PCLUSetReuseFill(PC,PetscTruth); 123 extern int PCLUSetUseInPlace(PC); 124 extern int PCLUSetFill(PC,double); 125 126 extern int PCILUSetMatOrdering(PC,MatOrderingType); 127 extern int PCILUSetUseInPlace(PC); 128 extern int PCILUSetFill(PC,double); 129 extern int PCILUSetLevels(PC,int); 130 extern int PCILUSetReuseOrdering(PC,PetscTruth); 131 extern int PCILUSetUseDropTolerance(PC,double,double,int); 132 extern int PCILUSetReuseFill(PC,PetscTruth); 133 extern int PCILUSetAllowDiagonalFill(PC); 134 135 extern int PCASMSetLocalSubdomains(PC,int,IS *); 136 extern int PCASMSetTotalSubdomains(PC,int,IS *); 137 extern int PCASMSetOverlap(PC,int); 138 typedef enum {PC_ASM_BASIC = 3,PC_ASM_RESTRICT = 1,PC_ASM_INTERPOLATE = 2,PC_ASM_NONE = 0} PCASMType; 139 extern int PCASMSetType(PC,PCASMType); 140 extern int PCASMCreateSubdomains2D(int,int,int,int,int,int,int *,IS **); 141 extern int PCASMSetUseInPlace(PC); 142 143 typedef enum {PC_COMPOSITE_ADDITIVE,PC_COMPOSITE_MULTIPLICATIVE} PCCompositeType; 144 extern int PCCompositeSetType(PC,PCCompositeType); 145 extern int PCCompositeAddPC(PC,PCType); 146 extern int PCCompositeGetPC(PC pc,int n,PC *); 147 148 extern int PCRedundantSetScatter(PC,VecScatter,VecScatter); 149 150 151 #endif 152 153 154 155 156