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