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