1 /* $Id: petscpc.h,v 1.99 2000/05/08 15:09:50 balay Exp bsmith $ */ 2 3 /* 4 Preconditioner module. 5 */ 6 #if !defined(__PETSCPC_H) 7 #define __PETSCPC_H 8 #include "petscmat.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