1 /* $Id: petscpc.h,v 1.101 2000/05/29 21:59:14 bsmith Exp balay $ */ 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 #define PCSPAI "spai" 35 #define PCMILU "milu" 36 37 typedef struct _p_PC* PC; 38 #define PC_COOKIE PETSC_COOKIE+9 39 40 /* 41 Null space code is not yet developed 42 */ 43 typedef struct _p_PCNullSpace* PCNullSpace; 44 #define PCNULLSPACE_COOKIE PETSC_COOKIE+17 45 46 typedef enum { PC_LEFT,PC_RIGHT,PC_SYMMETRIC } PCSide; 47 48 EXTERN int PCCreate(MPI_Comm,PC*); 49 EXTERN int PCSetType(PC,PCType); 50 EXTERN int PCSetUp(PC); 51 EXTERN int PCSetUpOnBlocks(PC); 52 EXTERN int PCApply(PC,Vec,Vec); 53 EXTERN int PCApplySymmetricLeft(PC,Vec,Vec); 54 EXTERN int PCApplySymmetricRight(PC,Vec,Vec); 55 EXTERN int PCApplyBAorAB(PC,PCSide,Vec,Vec,Vec); 56 EXTERN int PCApplyTranspose(PC,Vec,Vec); 57 EXTERN int PCApplyBAorABTranspose(PC,PCSide,Vec,Vec,Vec); 58 EXTERN int PCApplyRichardson(PC,Vec,Vec,Vec,int); 59 EXTERN int PCApplyRichardsonExists(PC,PetscTruth*); 60 61 EXTERN int PCRegisterDestroy(void); 62 EXTERN int PCRegisterAll(char*); 63 extern PetscTruth PCRegisterAllCalled; 64 65 EXTERN int PCRegister(char*,char*,char*,int(*)(PC)); 66 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 67 #define PCRegisterDynamic(a,b,c,d) PCRegister(a,b,c,0) 68 #else 69 #define PCRegisterDynamic(a,b,c,d) PCRegister(a,b,c,d) 70 #endif 71 72 EXTERN int PCDestroy(PC); 73 EXTERN int PCSetFromOptions(PC); 74 EXTERN int PCSetTypeFromOptions(PC); 75 EXTERN int PCGetType(PC,PCType*); 76 77 EXTERN int PCGetFactoredMatrix(PC,Mat*); 78 EXTERN int PCSetModifySubMatrices(PC,int(*)(PC,int,IS*,IS*,Mat*,void*),void*); 79 EXTERN int PCModifySubMatrices(PC,int,IS*,IS*,Mat*,void*); 80 81 EXTERN int PCSetOperators(PC,Mat,Mat,MatStructure); 82 EXTERN int PCGetOperators(PC,Mat*,Mat*,MatStructure*); 83 84 EXTERN int PCSetVector(PC,Vec); 85 EXTERN int PCGetVector(PC,Vec*); 86 EXTERN int PCPrintHelp(PC); 87 EXTERN int PCView(PC,Viewer); 88 89 EXTERN int PCSetOptionsPrefix(PC,char*); 90 EXTERN int PCAppendOptionsPrefix(PC,char*); 91 EXTERN int PCGetOptionsPrefix(PC,char**); 92 93 EXTERN int PCNullSpaceCreate(MPI_Comm,int,int,Vec *,PCNullSpace*); 94 EXTERN int PCNullSpaceDestroy(PCNullSpace); 95 EXTERN int PCNullSpaceRemove(PCNullSpace,Vec); 96 EXTERN int PCNullSpaceAttach(PC,PCNullSpace); 97 98 /* ------------- options specific to particular preconditioners --------- */ 99 100 EXTERN int PCSORSetSymmetric(PC,MatSORType); 101 EXTERN int PCSORSetOmega(PC,double); 102 EXTERN int PCSORSetIterations(PC,int); 103 104 EXTERN int PCEisenstatSetOmega(PC,double); 105 EXTERN int PCEisenstatNoDiagonalScaling(PC); 106 107 #define USE_PRECONDITIONER_MATRIX 0 108 #define USE_TRUE_MATRIX 1 109 EXTERN int PCBJacobiSetUseTrueLocal(PC); 110 EXTERN int PCBJacobiSetTotalBlocks(PC,int,int*); 111 EXTERN int PCBJacobiSetLocalBlocks(PC,int,int*); 112 113 EXTERN int PCSLESSetUseTrue(PC); 114 EXTERN int PCCompositeSetUseTrue(PC); 115 116 EXTERN int PCShellSetApply(PC,int (*)(void*,Vec,Vec),void*); 117 EXTERN int PCShellSetSetUp(PC,int (*)(void*)); 118 EXTERN int PCShellSetApplyRichardson(PC,int (*)(void*,Vec,Vec,Vec,int),void*); 119 EXTERN int PCShellSetName(PC,char*); 120 EXTERN int PCShellGetName(PC,char**); 121 122 EXTERN int PCLUSetMatOrdering(PC,MatOrderingType); 123 EXTERN int PCLUSetReuseOrdering(PC,PetscTruth); 124 EXTERN int PCLUSetReuseFill(PC,PetscTruth); 125 EXTERN int PCLUSetUseInPlace(PC); 126 EXTERN int PCLUSetFill(PC,double); 127 EXTERN int PCLUSetColumnPivoting(PC,PetscReal); 128 129 EXTERN int PCILUSetMatOrdering(PC,MatOrderingType); 130 EXTERN int PCILUSetUseInPlace(PC); 131 EXTERN int PCILUSetFill(PC,double); 132 EXTERN int PCILUSetLevels(PC,int); 133 EXTERN int PCILUSetReuseOrdering(PC,PetscTruth); 134 EXTERN int PCILUSetUseDropTolerance(PC,PetscReal,PetscReal,int); 135 EXTERN int PCILUSetReuseFill(PC,PetscTruth); 136 EXTERN int PCILUSetAllowDiagonalFill(PC); 137 138 EXTERN int PCASMSetLocalSubdomains(PC,int,IS *); 139 EXTERN int PCASMSetTotalSubdomains(PC,int,IS *); 140 EXTERN int PCASMSetOverlap(PC,int); 141 typedef enum {PC_ASM_BASIC = 3,PC_ASM_RESTRICT = 1,PC_ASM_INTERPOLATE = 2,PC_ASM_NONE = 0} PCASMType; 142 EXTERN int PCASMSetType(PC,PCASMType); 143 EXTERN int PCASMCreateSubdomains2D(int,int,int,int,int,int,int *,IS **); 144 EXTERN int PCASMSetUseInPlace(PC); 145 EXTERN int PCASMGetLocalSubdomains(PC,int*,IS**); 146 147 typedef enum {PC_COMPOSITE_ADDITIVE,PC_COMPOSITE_MULTIPLICATIVE} PCCompositeType; 148 EXTERN int PCCompositeSetType(PC,PCCompositeType); 149 EXTERN int PCCompositeAddPC(PC,PCType); 150 EXTERN int PCCompositeGetPC(PC pc,int n,PC *); 151 152 EXTERN int PCRedundantSetScatter(PC,VecScatter,VecScatter); 153 154 155 #endif 156 157 158 159 160