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