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