1 /* $Id: petscpc.h,v 1.116 2001/03/28 19:41:44 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 PetscFList PCList; 15 typedef char *PCType; 16 17 18 #define PC_COOKIE PETSC_COOKIE+9 19 /*S 20 PC - Abstract PETSc object that manages all preconditioners 21 22 Level: beginner 23 24 Concepts: preconditioners 25 26 .seealso: PCCreate(), PCSetType(), PCType 27 S*/ 28 typedef struct _p_PC* PC; 29 30 /*E 31 PCType - String with the name of a PETSc preconditioner method or the creation function 32 with an optional dynamic library name, for example 33 http://www.mcs.anl.gov/petsc/lib.a:mypccreate() 34 35 Level: beginner 36 37 .seealso: PCSetType(), PC 38 E*/ 39 #define PCNONE "none" 40 #define PCJACOBI "jacobi" 41 #define PCSOR "sor" 42 #define PCLU "lu" 43 #define PCSHELL "shell" 44 #define PCBJACOBI "bjacobi" 45 #define PCMG "mg" 46 #define PCEISENSTAT "eisenstat" 47 #define PCILU "ilu" 48 #define PCICC "icc" 49 #define PCASM "asm" 50 #define PCSLES "sles" 51 #define PCCOMPOSITE "composite" 52 #define PCREDUNDANT "redundant" 53 #define PCSPAI "spai" 54 #define PCMILU "milu" 55 #define PCNN "nn" 56 #define PCCHOLESKY "cholesky" 57 #define PCRAMG "ramg" 58 #define PCPBJACOBI "pbjacobi" 59 60 /*E 61 PCSide - If the preconditioner is to be applied to the left, right 62 or symmetrically around the operator. 63 64 Level: beginner 65 66 .seealso: 67 E*/ 68 typedef enum { PC_LEFT,PC_RIGHT,PC_SYMMETRIC } PCSide; 69 70 EXTERN int PCCreate(MPI_Comm,PC*); 71 EXTERN int PCSetType(PC,PCType); 72 EXTERN int PCSetUp(PC); 73 EXTERN int PCSetUpOnBlocks(PC); 74 EXTERN int PCApply(PC,Vec,Vec); 75 EXTERN int PCApplySymmetricLeft(PC,Vec,Vec); 76 EXTERN int PCApplySymmetricRight(PC,Vec,Vec); 77 EXTERN int PCApplyBAorAB(PC,PCSide,Vec,Vec,Vec); 78 EXTERN int PCApplyTranspose(PC,Vec,Vec); 79 EXTERN int PCApplyBAorABTranspose(PC,PCSide,Vec,Vec,Vec); 80 EXTERN int PCApplyRichardson(PC,Vec,Vec,Vec,int); 81 EXTERN int PCApplyRichardsonExists(PC,PetscTruth*); 82 83 EXTERN int PCRegisterDestroy(void); 84 EXTERN int PCRegisterAll(char*); 85 extern PetscTruth PCRegisterAllCalled; 86 87 EXTERN int PCRegister(char*,char*,char*,int(*)(PC)); 88 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 89 #define PCRegisterDynamic(a,b,c,d) PCRegister(a,b,c,0) 90 #else 91 #define PCRegisterDynamic(a,b,c,d) PCRegister(a,b,c,d) 92 #endif 93 94 EXTERN int PCDestroy(PC); 95 EXTERN int PCSetFromOptions(PC); 96 EXTERN int PCSetTypeFromOptions(PC); 97 EXTERN int PCGetType(PC,PCType*); 98 99 EXTERN int PCGetFactoredMatrix(PC,Mat*); 100 EXTERN int PCSetModifySubMatrices(PC,int(*)(PC,int,IS*,IS*,Mat*,void*),void*); 101 EXTERN int PCModifySubMatrices(PC,int,IS*,IS*,Mat*,void*); 102 103 EXTERN int PCSetOperators(PC,Mat,Mat,MatStructure); 104 EXTERN int PCGetOperators(PC,Mat*,Mat*,MatStructure*); 105 106 EXTERN int PCSetVector(PC,Vec); 107 EXTERN int PCGetVector(PC,Vec*); 108 EXTERN int PCView(PC,PetscViewer); 109 110 EXTERN int PCSetOptionsPrefix(PC,char*); 111 EXTERN int PCAppendOptionsPrefix(PC,char*); 112 EXTERN int PCGetOptionsPrefix(PC,char**); 113 114 EXTERN int PCNullSpaceAttach(PC,MatNullSpace); 115 116 EXTERN int PCComputeExplicitOperator(PC,Mat*); 117 118 /* 119 These are used to provide extra scaling of preconditioned 120 operator for time-stepping schemes like in PVODE 121 */ 122 EXTERN int PCDiagonalScale(PC,PetscTruth*); 123 EXTERN int PCDiagonalScaleLeft(PC,Vec,Vec); 124 EXTERN int PCDiagonalScaleRight(PC,Vec,Vec); 125 EXTERN int PCDiagonalScaleSet(PC,Vec); 126 127 /* ------------- options specific to particular preconditioners --------- */ 128 129 EXTERN int PCJacobiSetUseRowMax(PC); 130 EXTERN int PCSORSetSymmetric(PC,MatSORType); 131 EXTERN int PCSORSetOmega(PC,double); 132 EXTERN int PCSORSetIterations(PC,int); 133 134 EXTERN int PCEisenstatSetOmega(PC,double); 135 EXTERN int PCEisenstatNoDiagonalScaling(PC); 136 137 #define USE_PRECONDITIONER_MATRIX 0 138 #define USE_TRUE_MATRIX 1 139 EXTERN int PCBJacobiSetUseTrueLocal(PC); 140 EXTERN int PCBJacobiSetTotalBlocks(PC,int,int*); 141 EXTERN int PCBJacobiSetLocalBlocks(PC,int,int*); 142 143 EXTERN int PCSLESSetUseTrue(PC); 144 145 EXTERN int PCShellSetApply(PC,int (*)(void*,Vec,Vec),void*); 146 EXTERN int PCShellSetSetUp(PC,int (*)(void*)); 147 EXTERN int PCShellSetApplyRichardson(PC,int (*)(void*,Vec,Vec,Vec,int),void*); 148 EXTERN int PCShellSetView(PC,int (*)(void*,PetscViewer)); 149 EXTERN int PCShellSetName(PC,char*); 150 EXTERN int PCShellGetName(PC,char**); 151 152 EXTERN int PCLUSetMatOrdering(PC,MatOrderingType); 153 EXTERN int PCLUSetReuseOrdering(PC,PetscTruth); 154 EXTERN int PCLUSetReuseFill(PC,PetscTruth); 155 EXTERN int PCLUSetUseInPlace(PC); 156 EXTERN int PCLUSetFill(PC,double); 157 EXTERN int PCLUSetDamping(PC,double); 158 EXTERN int PCLUSetPivoting(PC,PetscReal); 159 160 EXTERN int PCCholeskySetMatOrdering(PC,MatOrderingType); 161 EXTERN int PCCholeskySetReuseOrdering(PC,PetscTruth); 162 EXTERN int PCCholeskySetReuseFill(PC,PetscTruth); 163 EXTERN int PCCholeskySetUseInPlace(PC); 164 EXTERN int PCCholeskySetFill(PC,double); 165 EXTERN int PCCholeskySetDamping(PC,double); 166 167 EXTERN int PCILUSetMatOrdering(PC,MatOrderingType); 168 EXTERN int PCILUSetUseInPlace(PC); 169 EXTERN int PCILUSetFill(PC,double); 170 EXTERN int PCILUSetLevels(PC,int); 171 EXTERN int PCILUSetReuseOrdering(PC,PetscTruth); 172 EXTERN int PCILUSetUseDropTolerance(PC,PetscReal,PetscReal,int); 173 EXTERN int PCILUDTSetReuseFill(PC,PetscTruth); 174 EXTERN int PCILUSetAllowDiagonalFill(PC); 175 EXTERN int PCILUSetDamping(PC,double); 176 177 EXTERN int PCICCSetMatOrdering(PC,MatOrderingType); 178 EXTERN int PCICCSetFill(PC,double); 179 EXTERN int PCICCSetLevels(PC,int); 180 181 EXTERN int PCASMSetLocalSubdomains(PC,int,IS *); 182 EXTERN int PCASMSetTotalSubdomains(PC,int,IS *); 183 EXTERN int PCASMSetOverlap(PC,int); 184 /*E 185 PCASMType - Type of additive Schwarz method to use 186 187 $ PC_ASM_BASIC - symmetric version where residuals from the ghost points are used 188 $ and computed values in ghost regions are added together. Classical 189 $ standard additive Schwarz 190 $ PC_ASM_RESTRICT - residuals from ghost points are used but computed values in ghost 191 $ region are discarded. Default 192 $ PC_ASM_INTERPOLATE - residuals from ghost points are not used, computed values in ghost 193 $ region are added back in 194 $ PC_ASM_NONE - ghost point residuals are not used, computed ghost values are discarded 195 $ not very good. 196 197 Level: beginner 198 199 .seealso: PCASMSetType() 200 E*/ 201 typedef enum {PC_ASM_BASIC = 3,PC_ASM_RESTRICT = 1,PC_ASM_INTERPOLATE = 2,PC_ASM_NONE = 0} PCASMType; 202 EXTERN int PCASMSetType(PC,PCASMType); 203 EXTERN int PCASMCreateSubdomains2D(int,int,int,int,int,int,int *,IS **); 204 EXTERN int PCASMSetUseInPlace(PC); 205 EXTERN int PCASMGetLocalSubdomains(PC,int*,IS**); 206 EXTERN int PCASMGetLocalSubmatrices(PC,int*,Mat**); 207 208 /*E 209 PCCompositeType - Determines how two or more preconditioner are composed 210 211 $ PC_COMPOSITE_ADDITIVE - results from application of all preconditioners are added together 212 $ PC_COMPOSITE_MULTIPLICATIVE - preconditioners are applied sequentially to the residual freshly 213 $ computed after the previous preconditioner application 214 $ PC_COMPOSITE_SPECIAL - This is very special for a matrix of the form alpha I + R + S 215 $ where first preconditioner is built from alpha I + S and second from 216 $ alpha I + R 217 218 Level: beginner 219 220 .seealso: PCCompositeSetType() 221 E*/ 222 typedef enum {PC_COMPOSITE_ADDITIVE,PC_COMPOSITE_MULTIPLICATIVE,PC_COMPOSITE_SPECIAL} PCCompositeType; 223 EXTERN int PCCompositeSetUseTrue(PC); 224 EXTERN int PCCompositeSetType(PC,PCCompositeType); 225 EXTERN int PCCompositeAddPC(PC,PCType); 226 EXTERN int PCCompositeGetPC(PC pc,int n,PC *); 227 EXTERN int PCCompositeSpecialSetAlpha(PC,Scalar); 228 229 EXTERN int PCRedundantSetScatter(PC,VecScatter,VecScatter); 230 EXTERN int PCRedundantGetOperators(PC,Mat*,Mat*); 231 EXTERN int PCRedundantGetPC(PC,PC*); 232 EXTERN int MatGetOrderingList(PetscFList *list); 233 #endif 234 235 236 237 238