1 /* 2 Preconditioner module. 3 */ 4 #if !defined(__PETSCPC_H) 5 #define __PETSCPC_H 6 #include "petscmat.h" 7 PETSC_EXTERN_CXX_BEGIN 8 9 EXTERN int PCInitializePackage(const char[]); 10 11 /* 12 PCList contains the list of preconditioners currently registered 13 These are added with the PCRegisterDynamic() macro 14 */ 15 extern PetscFList PCList; 16 #define PCType char* 17 18 /*S 19 PC - Abstract PETSc object that manages all preconditioners 20 21 Level: beginner 22 23 Concepts: preconditioners 24 25 .seealso: PCCreate(), PCSetType(), PCType (for list of available types) 26 S*/ 27 typedef struct _p_PC* PC; 28 29 /*E 30 PCType - String with the name of a PETSc preconditioner method or the creation function 31 with an optional dynamic library name, for example 32 http://www.mcs.anl.gov/petsc/lib.a:mypccreate() 33 34 Level: beginner 35 36 Notes: Click on the links below to see details on a particular solver 37 38 .seealso: PCSetType(), PC, PCCreate() 39 E*/ 40 #define PCNONE "none" 41 #define PCJACOBI "jacobi" 42 #define PCSOR "sor" 43 #define PCLU "lu" 44 #define PCSHELL "shell" 45 #define PCBJACOBI "bjacobi" 46 #define PCMG "mg" 47 #define PCEISENSTAT "eisenstat" 48 #define PCILU "ilu" 49 #define PCICC "icc" 50 #define PCASM "asm" 51 #define PCKSP "ksp" 52 #define PCCOMPOSITE "composite" 53 #define PCREDUNDANT "redundant" 54 #define PCSPAI "spai" 55 #define PCNN "nn" 56 #define PCCHOLESKY "cholesky" 57 #define PCRAMG "ramg" 58 #define PCSAMG "samg" 59 #define PCPBJACOBI "pbjacobi" 60 #define PCESI "esi" 61 #define PCPETSCESI "petscesi" 62 #define PCMAT "mat" 63 #define PCHYPRE "hypre" 64 65 /* Logging support */ 66 extern int PC_COOKIE; 67 extern int PC_SetUp, PC_SetUpOnBlocks, PC_Apply, PC_ApplyCoarse, PC_ApplyMultiple, PC_ApplySymmetricLeft; 68 extern int PC_ApplySymmetricRight, PC_ModifySubMatrices; 69 70 /*E 71 PCSide - If the preconditioner is to be applied to the left, right 72 or symmetrically around the operator. 73 74 Level: beginner 75 76 .seealso: 77 E*/ 78 typedef enum { PC_LEFT,PC_RIGHT,PC_SYMMETRIC } PCSide; 79 80 EXTERN int PCCreate(MPI_Comm,PC*); 81 EXTERN int PCSetType(PC,const PCType); 82 EXTERN int PCSetUp(PC); 83 EXTERN int PCSetUpOnBlocks(PC); 84 EXTERN int PCApply(PC,Vec,Vec); 85 EXTERN int PCApplySymmetricLeft(PC,Vec,Vec); 86 EXTERN int PCApplySymmetricRight(PC,Vec,Vec); 87 EXTERN int PCApplyBAorAB(PC,PCSide,Vec,Vec,Vec); 88 EXTERN int PCApplyTranspose(PC,Vec,Vec); 89 EXTERN int PCHasApplyTranspose(PC,PetscTruth*); 90 EXTERN int PCApplyBAorABTranspose(PC,PCSide,Vec,Vec,Vec); 91 EXTERN int PCApplyRichardson(PC,Vec,Vec,Vec,PetscReal,PetscReal,PetscReal,int); 92 EXTERN int PCApplyRichardsonExists(PC,PetscTruth*); 93 94 EXTERN int PCRegisterDestroy(void); 95 EXTERN int PCRegisterAll(const char[]); 96 extern PetscTruth PCRegisterAllCalled; 97 98 EXTERN int PCRegister(const char[],const char[],const char[],int(*)(PC)); 99 100 /*MC 101 PCRegisterDynamic - Adds a method to the preconditioner package. 102 103 Synopsis: 104 int PCRegisterDynamic(char *name_solver,char *path,char *name_create,int (*routine_create)(PC)) 105 106 Not collective 107 108 Input Parameters: 109 + name_solver - name of a new user-defined solver 110 . path - path (either absolute or relative) the library containing this solver 111 . name_create - name of routine to create method context 112 - routine_create - routine to create method context 113 114 Notes: 115 PCRegisterDynamic() may be called multiple times to add several user-defined preconditioners. 116 117 If dynamic libraries are used, then the fourth input argument (routine_create) 118 is ignored. 119 120 Sample usage: 121 .vb 122 PCRegisterDynamic("my_solver","/home/username/my_lib/lib/libO/solaris/mylib", 123 "MySolverCreate",MySolverCreate); 124 .ve 125 126 Then, your solver can be chosen with the procedural interface via 127 $ PCSetType(pc,"my_solver") 128 or at runtime via the option 129 $ -pc_type my_solver 130 131 Level: advanced 132 133 Notes: ${PETSC_ARCH}, ${PETSC_DIR}, ${PETSC_LIB_DIR}, ${BOPT}, or ${any environmental variable} 134 occuring in pathname will be replaced with appropriate values. 135 If your function is not being put into a shared library then use PCRegister() instead 136 137 .keywords: PC, register 138 139 .seealso: PCRegisterAll(), PCRegisterDestroy() 140 M*/ 141 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 142 #define PCRegisterDynamic(a,b,c,d) PCRegister(a,b,c,0) 143 #else 144 #define PCRegisterDynamic(a,b,c,d) PCRegister(a,b,c,d) 145 #endif 146 147 EXTERN int PCDestroy(PC); 148 EXTERN int PCSetFromOptions(PC); 149 EXTERN int PCESISetFromOptions(PC); 150 EXTERN int PCGetType(PC,PCType*); 151 152 EXTERN int PCGetFactoredMatrix(PC,Mat*); 153 EXTERN int PCSetModifySubMatrices(PC,int(*)(PC,int,const IS[],const IS[],Mat[],void*),void*); 154 EXTERN int PCModifySubMatrices(PC,int,const IS[],const IS[],Mat[],void*); 155 156 EXTERN int PCSetOperators(PC,Mat,Mat,MatStructure); 157 EXTERN int PCGetOperators(PC,Mat*,Mat*,MatStructure*); 158 159 EXTERN int PCView(PC,PetscViewer); 160 161 EXTERN int PCSetOptionsPrefix(PC,const char[]); 162 EXTERN int PCAppendOptionsPrefix(PC,const char[]); 163 EXTERN int PCGetOptionsPrefix(PC,char*[]); 164 165 EXTERN int PCComputeExplicitOperator(PC,Mat*); 166 167 /* 168 These are used to provide extra scaling of preconditioned 169 operator for time-stepping schemes like in PVODE 170 */ 171 EXTERN int PCDiagonalScale(PC,PetscTruth*); 172 EXTERN int PCDiagonalScaleLeft(PC,Vec,Vec); 173 EXTERN int PCDiagonalScaleRight(PC,Vec,Vec); 174 EXTERN int PCDiagonalScaleSet(PC,Vec); 175 176 /* ------------- options specific to particular preconditioners --------- */ 177 178 EXTERN int PCJacobiSetUseRowMax(PC); 179 EXTERN int PCSORSetSymmetric(PC,MatSORType); 180 EXTERN int PCSORSetOmega(PC,PetscReal); 181 EXTERN int PCSORSetIterations(PC,int,int); 182 183 EXTERN int PCEisenstatSetOmega(PC,PetscReal); 184 EXTERN int PCEisenstatNoDiagonalScaling(PC); 185 186 #define USE_PRECONDITIONER_MATRIX 0 187 #define USE_TRUE_MATRIX 1 188 EXTERN int PCBJacobiSetUseTrueLocal(PC); 189 EXTERN int PCBJacobiSetTotalBlocks(PC,int,const int[]); 190 EXTERN int PCBJacobiSetLocalBlocks(PC,int,const int[]); 191 192 EXTERN int PCKSPSetUseTrue(PC); 193 194 EXTERN int PCShellSetApply(PC,int (*)(void*,Vec,Vec),void*); 195 EXTERN int PCShellSetApplyTranspose(PC,int (*)(void*,Vec,Vec)); 196 EXTERN int PCShellSetSetUp(PC,int (*)(void*)); 197 EXTERN int PCShellSetApplyRichardson(PC,int (*)(void*,Vec,Vec,Vec,PetscReal,PetscReal,PetscReal,int),void*); 198 EXTERN int PCShellSetView(PC,int (*)(void*,PetscViewer)); 199 EXTERN int PCShellSetName(PC,const char[]); 200 EXTERN int PCShellGetName(PC,char*[]); 201 202 EXTERN int PCLUSetMatOrdering(PC,MatOrderingType); 203 EXTERN int PCLUSetReuseOrdering(PC,PetscTruth); 204 EXTERN int PCLUSetReuseFill(PC,PetscTruth); 205 EXTERN int PCLUSetUseInPlace(PC); 206 EXTERN int PCLUSetFill(PC,PetscReal); 207 EXTERN int PCLUSetDamping(PC,PetscReal); 208 EXTERN int PCLUSetShift(PC,PetscTruth); 209 EXTERN int PCLUSetPivoting(PC,PetscReal); 210 EXTERN int PCLUSetPivotInBlocks(PC,PetscTruth); 211 EXTERN int PCLUSetZeroPivot(PC,PetscReal); 212 213 EXTERN int PCCholeskySetMatOrdering(PC,MatOrderingType); 214 EXTERN int PCCholeskySetReuseOrdering(PC,PetscTruth); 215 EXTERN int PCCholeskySetReuseFill(PC,PetscTruth); 216 EXTERN int PCCholeskySetUseInPlace(PC); 217 EXTERN int PCCholeskySetFill(PC,PetscReal); 218 EXTERN int PCCholeskySetDamping(PC,PetscReal); 219 EXTERN int PCCholeskySetShift(PC,PetscTruth); 220 EXTERN int PCCholeskySetPivotInBlocks(PC,PetscTruth); 221 222 EXTERN int PCILUSetMatOrdering(PC,MatOrderingType); 223 EXTERN int PCILUSetUseInPlace(PC); 224 EXTERN int PCILUSetFill(PC,PetscReal); 225 EXTERN int PCILUSetLevels(PC,int); 226 EXTERN int PCILUSetReuseOrdering(PC,PetscTruth); 227 EXTERN int PCILUSetUseDropTolerance(PC,PetscReal,PetscReal,int); 228 EXTERN int PCILUDTSetReuseFill(PC,PetscTruth); 229 EXTERN int PCILUSetAllowDiagonalFill(PC); 230 EXTERN int PCILUSetDamping(PC,PetscReal); 231 EXTERN int PCILUSetShift(PC,PetscTruth); 232 EXTERN int PCILUSetPivotInBlocks(PC,PetscTruth); 233 EXTERN int PCILUSetZeroPivot(PC,PetscReal); 234 235 EXTERN int PCICCSetMatOrdering(PC,MatOrderingType); 236 EXTERN int PCICCSetFill(PC,PetscReal); 237 EXTERN int PCICCSetLevels(PC,int); 238 EXTERN int PCICCSetDamping(PC,PetscReal); 239 EXTERN int PCICCSetShift(PC,PetscTruth); 240 EXTERN int PCICCSetPivotInBlocks(PC,PetscTruth); 241 EXTERN int PCICCSetZeroPivot(PC,PetscReal); 242 243 EXTERN int PCASMSetLocalSubdomains(PC,int,IS[]); 244 EXTERN int PCASMSetTotalSubdomains(PC,int,IS[]); 245 EXTERN int PCASMSetOverlap(PC,int); 246 /*E 247 PCASMType - Type of additive Schwarz method to use 248 249 $ PC_ASM_BASIC - symmetric version where residuals from the ghost points are used 250 $ and computed values in ghost regions are added together. Classical 251 $ standard additive Schwarz 252 $ PC_ASM_RESTRICT - residuals from ghost points are used but computed values in ghost 253 $ region are discarded. Default 254 $ PC_ASM_INTERPOLATE - residuals from ghost points are not used, computed values in ghost 255 $ region are added back in 256 $ PC_ASM_NONE - ghost point residuals are not used, computed ghost values are discarded 257 $ not very good. 258 259 Level: beginner 260 261 .seealso: PCASMSetType() 262 E*/ 263 typedef enum {PC_ASM_BASIC = 3,PC_ASM_RESTRICT = 1,PC_ASM_INTERPOLATE = 2,PC_ASM_NONE = 0} PCASMType; 264 EXTERN int PCASMSetType(PC,PCASMType); 265 EXTERN int PCASMCreateSubdomains2D(int,int,int,int,int,int,int *,IS **); 266 EXTERN int PCASMSetUseInPlace(PC); 267 EXTERN int PCASMGetLocalSubdomains(PC,int*,IS*[]); 268 EXTERN int PCASMGetLocalSubmatrices(PC,int*,Mat*[]); 269 270 /*E 271 PCCompositeType - Determines how two or more preconditioner are composed 272 273 $ PC_COMPOSITE_ADDITIVE - results from application of all preconditioners are added together 274 $ PC_COMPOSITE_MULTIPLICATIVE - preconditioners are applied sequentially to the residual freshly 275 $ computed after the previous preconditioner application 276 $ PC_COMPOSITE_SPECIAL - This is very special for a matrix of the form alpha I + R + S 277 $ where first preconditioner is built from alpha I + S and second from 278 $ alpha I + R 279 280 Level: beginner 281 282 .seealso: PCCompositeSetType() 283 E*/ 284 typedef enum {PC_COMPOSITE_ADDITIVE,PC_COMPOSITE_MULTIPLICATIVE,PC_COMPOSITE_SPECIAL} PCCompositeType; 285 EXTERN int PCCompositeSetUseTrue(PC); 286 EXTERN int PCCompositeSetType(PC,PCCompositeType); 287 EXTERN int PCCompositeAddPC(PC,PCType); 288 EXTERN int PCCompositeGetPC(PC pc,int n,PC *); 289 EXTERN int PCCompositeSpecialSetAlpha(PC,PetscScalar); 290 291 EXTERN int PCRedundantSetScatter(PC,VecScatter,VecScatter); 292 EXTERN int PCRedundantGetOperators(PC,Mat*,Mat*); 293 EXTERN int PCRedundantGetPC(PC,PC*); 294 EXTERN int MatGetOrderingList(PetscFList *list); 295 296 EXTERN int PCSPAISetEpsilon(PC,double); 297 EXTERN int PCSPAISetNBSteps(PC,int); 298 EXTERN int PCSPAISetMax(PC,int); 299 EXTERN int PCSPAISetMaxNew(PC,int); 300 EXTERN int PCSPAISetBlockSize(PC,int); 301 EXTERN int PCSPAISetCacheSize(PC,int); 302 EXTERN int PCSPAISetVerbose(PC,int); 303 EXTERN int PCSPAISetSp(PC,int); 304 305 EXTERN int PCHYPRESetType(PC,const char[]); 306 EXTERN int PCBJacobiGetLocalBlocks(PC,int*,const int*[]); 307 EXTERN int PCBJacobiGetTotalBlocks(PC,int*,const int*[]); 308 309 PETSC_EXTERN_CXX_END 310 #endif /* __PETSCPC_H */ 311