1 /* $Id: petscpc.h,v 1.113 2001/01/15 21:46:44 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 PetscFList 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 #define PCCHOLESKY "cholesky" 38 #define PCRAMG "ramg" 39 40 typedef struct _p_PC* PC; 41 #define PC_COOKIE PETSC_COOKIE+9 42 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 PCView(PC,PetscViewer); 85 86 EXTERN int PCSetOptionsPrefix(PC,char*); 87 EXTERN int PCAppendOptionsPrefix(PC,char*); 88 EXTERN int PCGetOptionsPrefix(PC,char**); 89 90 EXTERN int PCNullSpaceAttach(PC,MatNullSpace); 91 92 EXTERN int PCComputeExplicitOperator(PC,Mat*); 93 94 /* 95 These are used to provide extra scaling of preconditioned 96 operator for time-stepping schemes like in PVODE 97 */ 98 EXTERN int PCDiagonalScale(PC,PetscTruth*); 99 EXTERN int PCDiagonalScaleleft(PC,Vec); 100 EXTERN int PCDiagonalScaleRight(PC,Vec); 101 102 /* ------------- options specific to particular preconditioners --------- */ 103 104 EXTERN int PCJacobiSetUseRowMax(PC); 105 EXTERN int PCSORSetSymmetric(PC,MatSORType); 106 EXTERN int PCSORSetOmega(PC,double); 107 EXTERN int PCSORSetIterations(PC,int); 108 109 EXTERN int PCEisenstatSetOmega(PC,double); 110 EXTERN int PCEisenstatNoDiagonalScaling(PC); 111 112 #define USE_PRECONDITIONER_MATRIX 0 113 #define USE_TRUE_MATRIX 1 114 EXTERN int PCBJacobiSetUseTrueLocal(PC); 115 EXTERN int PCBJacobiSetTotalBlocks(PC,int,int*); 116 EXTERN int PCBJacobiSetLocalBlocks(PC,int,int*); 117 118 EXTERN int PCSLESSetUseTrue(PC); 119 EXTERN int PCCompositeSetUseTrue(PC); 120 121 EXTERN int PCShellSetApply(PC,int (*)(void*,Vec,Vec),void*); 122 EXTERN int PCShellSetSetUp(PC,int (*)(void*)); 123 EXTERN int PCShellSetApplyRichardson(PC,int (*)(void*,Vec,Vec,Vec,int),void*); 124 EXTERN int PCShellSetName(PC,char*); 125 EXTERN int PCShellGetName(PC,char**); 126 127 EXTERN int PCLUSetMatOrdering(PC,MatOrderingType); 128 EXTERN int PCLUSetReuseOrdering(PC,PetscTruth); 129 EXTERN int PCLUSetReuseFill(PC,PetscTruth); 130 EXTERN int PCLUSetUseInPlace(PC); 131 EXTERN int PCLUSetFill(PC,double); 132 EXTERN int PCLUSetDamping(PC,double); 133 EXTERN int PCLUSetColumnPivoting(PC,PetscReal); 134 135 EXTERN int PCCholeskySetMatOrdering(PC,MatOrderingType); 136 EXTERN int PCCholeskySetReuseOrdering(PC,PetscTruth); 137 EXTERN int PCCholeskySetReuseFill(PC,PetscTruth); 138 EXTERN int PCCholeskySetUseInPlace(PC); 139 EXTERN int PCCholeskySetFill(PC,double); 140 EXTERN int PCCholeskySetDamping(PC,double); 141 142 EXTERN int PCILUSetMatOrdering(PC,MatOrderingType); 143 EXTERN int PCILUSetUseInPlace(PC); 144 EXTERN int PCILUSetFill(PC,double); 145 EXTERN int PCILUSetLevels(PC,int); 146 EXTERN int PCILUSetReuseOrdering(PC,PetscTruth); 147 EXTERN int PCILUSetUseDropTolerance(PC,PetscReal,PetscReal,int); 148 EXTERN int PCILUDTSetReuseFill(PC,PetscTruth); 149 EXTERN int PCILUSetAllowDiagonalFill(PC); 150 EXTERN int PCILUSetDamping(PC,double); 151 152 EXTERN int PCICCSetMatOrdering(PC,MatOrderingType); 153 EXTERN int PCICCSetFill(PC,double); 154 EXTERN int PCICCSetLevels(PC,int); 155 156 EXTERN int PCASMSetLocalSubdomains(PC,int,IS *); 157 EXTERN int PCASMSetTotalSubdomains(PC,int,IS *); 158 EXTERN int PCASMSetOverlap(PC,int); 159 typedef enum {PC_ASM_BASIC = 3,PC_ASM_RESTRICT = 1,PC_ASM_INTERPOLATE = 2,PC_ASM_NONE = 0} PCASMType; 160 EXTERN int PCASMSetType(PC,PCASMType); 161 EXTERN int PCASMCreateSubdomains2D(int,int,int,int,int,int,int *,IS **); 162 EXTERN int PCASMSetUseInPlace(PC); 163 EXTERN int PCASMGetLocalSubdomains(PC,int*,IS**); 164 165 typedef enum {PC_COMPOSITE_ADDITIVE,PC_COMPOSITE_MULTIPLICATIVE,PC_COMPOSITE_SPECIAL} PCCompositeType; 166 EXTERN int PCCompositeSetType(PC,PCCompositeType); 167 EXTERN int PCCompositeAddPC(PC,PCType); 168 EXTERN int PCCompositeGetPC(PC pc,int n,PC *); 169 170 EXTERN int PCRedundantSetScatter(PC,VecScatter,VecScatter); 171 EXTERN int PCRedundantGetOperators(PC,Mat*,Mat*); 172 EXTERN int PCRedundantGetPC(PC,PC*); 173 EXTERN int MatGetOrderingList(PetscFList *list); 174 #endif 175 176 177 178 179