1 /* $Id: pc.h,v 1.89 1999/03/11 16:24:44 bsmith 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 /* 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 PCSLES "sles" 33 #define PCCOMPOSITE "composite" 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 PCApplyTrans(PC,Vec,Vec); 55 extern int PCApplyBAorABTrans(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 int PCRegisterAllCalled; 62 63 extern int PCRegister_Private(char*,char*,char*,int(*)(PC)); 64 #if defined(USE_DYNAMIC_LIBRARIES) 65 #define PCRegister(a,b,c,d) PCRegister_Private(a,b,c,0) 66 #else 67 #define PCRegister(a,b,c,d) PCRegister_Private(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 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 #define USE_PRECONDITIONER_MATRIX 0 102 #define USE_TRUE_MATRIX 1 103 extern int PCBJacobiSetUseTrueLocal(PC); 104 extern int PCBJacobiSetTotalBlocks(PC, int, int*); 105 extern int PCBJacobiSetLocalBlocks(PC, int, int*); 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 PCShellSetSetUp(PC, int (*)(void*)); 112 extern int PCShellSetApplyRichardson(PC,int (*)(void*,Vec,Vec,Vec,int),void*); 113 extern int PCShellSetName(PC,char*); 114 extern int PCShellGetName(PC,char**); 115 116 extern int PCLUSetMatOrdering(PC,MatOrderingType); 117 extern int PCLUSetReuseOrdering(PC,PetscTruth); 118 extern int PCLUSetReuseFill(PC,PetscTruth); 119 120 extern int PCILUSetMatOrdering(PC,MatOrderingType); 121 extern int PCLUSetUseInPlace(PC); 122 extern int PCLUSetFill(PC,double); 123 extern int PCILUSetUseInPlace(PC); 124 extern int PCILUSetFill(PC,double); 125 extern int PCILUSetLevels(PC,int); 126 extern int PCILUSetReuseOrdering(PC,PetscTruth); 127 extern int PCILUSetUseDropTolerance(PC,double,int); 128 extern int PCILUSetReuseFill(PC,PetscTruth); 129 extern int PCILUSetAllowDiagonalFill(PC); 130 131 extern int PCEisenstatNoDiagonalScaling(PC); 132 133 extern int PCASMSetLocalSubdomains(PC, int, IS *); 134 extern int PCASMSetTotalSubdomains(PC, int, IS *); 135 extern int PCASMSetOverlap(PC, int); 136 typedef enum {PC_ASM_BASIC = 3,PC_ASM_RESTRICT = 1,PC_ASM_INTERPOLATE = 2,PC_ASM_NONE = 0} PCASMType; 137 extern int PCASMSetType(PC,PCASMType); 138 extern int PCASMCreateSubdomains2D(int,int,int,int,int,int,int *,IS **); 139 extern int PCASMSetUseInPlace(PC); 140 141 typedef enum {PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE} PCCompositeType; 142 extern int PCCompositeSetType(PC,PCCompositeType); 143 extern int PCCompositeAddPC(PC,PCType); 144 extern int PCCompositeGetPC(PC pc,int n,PC *); 145 146 #endif 147 148 149 150 151