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