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