1 #if !defined(PETSCPCTYPES_H) 2 #define PETSCPCTYPES_H 3 4 /*S 5 PC - Abstract PETSc object that manages all preconditioners including direct solvers such as PCLU 6 7 Level: beginner 8 9 .seealso: PCCreate(), PCSetType(), PCType (for list of available types) 10 S*/ 11 typedef struct _p_PC* PC; 12 13 /*J 14 PCType - String with the name of a PETSc preconditioner method. 15 16 Level: beginner 17 18 Notes: 19 Click on the links above to see details on a particular solver 20 21 PCRegister() is used to register preconditioners that are then accessible via PCSetType() 22 23 .seealso: PCSetType(), PC, PCCreate(), PCRegister(), PCSetFromOptions() 24 J*/ 25 typedef const char* PCType; 26 #define PCNONE "none" 27 #define PCJACOBI "jacobi" 28 #define PCSOR "sor" 29 #define PCLU "lu" 30 #define PCSHELL "shell" 31 #define PCBJACOBI "bjacobi" 32 #define PCMG "mg" 33 #define PCEISENSTAT "eisenstat" 34 #define PCILU "ilu" 35 #define PCICC "icc" 36 #define PCASM "asm" 37 #define PCGASM "gasm" 38 #define PCKSP "ksp" 39 #define PCCOMPOSITE "composite" 40 #define PCREDUNDANT "redundant" 41 #define PCSPAI "spai" 42 #define PCNN "nn" 43 #define PCCHOLESKY "cholesky" 44 #define PCPBJACOBI "pbjacobi" 45 #define PCVPBJACOBI "vpbjacobi" 46 #define PCMAT "mat" 47 #define PCHYPRE "hypre" 48 #define PCPARMS "parms" 49 #define PCFIELDSPLIT "fieldsplit" 50 #define PCTFS "tfs" 51 #define PCML "ml" 52 #define PCGALERKIN "galerkin" 53 #define PCEXOTIC "exotic" 54 #define PCCP "cp" 55 #define PCBFBT "bfbt" 56 #define PCLSC "lsc" 57 #define PCPYTHON "python" 58 #define PCPFMG "pfmg" 59 #define PCSYSPFMG "syspfmg" 60 #define PCREDISTRIBUTE "redistribute" 61 #define PCSVD "svd" 62 #define PCGAMG "gamg" 63 #define PCCHOWILUVIENNACL "chowiluviennacl" 64 #define PCROWSCALINGVIENNACL "rowscalingviennacl" 65 #define PCSAVIENNACL "saviennacl" 66 #define PCBDDC "bddc" 67 #define PCKACZMARZ "kaczmarz" 68 #define PCTELESCOPE "telescope" 69 #define PCPATCH "patch" 70 #define PCLMVM "lmvm" 71 #define PCHMG "hmg" 72 #define PCDEFLATION "deflation" 73 #define PCHPDDM "hpddm" 74 #define PCHARA "hara" 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_SIDE_DEFAULT=-1,PC_LEFT,PC_RIGHT,PC_SYMMETRIC} PCSide; 85 #define PC_SIDE_MAX (PC_SYMMETRIC + 1) 86 87 /*E 88 PCRichardsonConvergedReason - reason a PCApplyRichardson method terminates 89 90 Level: advanced 91 92 Notes: 93 this must match petsc/finclude/petscpc.h and the KSPConvergedReason values in petscksp.h 94 95 .seealso: PCApplyRichardson() 96 E*/ 97 typedef enum { 98 PCRICHARDSON_CONVERGED_RTOL = 2, 99 PCRICHARDSON_CONVERGED_ATOL = 3, 100 PCRICHARDSON_CONVERGED_ITS = 4, 101 PCRICHARDSON_DIVERGED_DTOL = -4} PCRichardsonConvergedReason; 102 103 /*E 104 PCJacobiType - What elements are used to form the Jacobi preconditioner 105 106 Level: intermediate 107 108 .seealso: 109 E*/ 110 typedef enum { PC_JACOBI_DIAGONAL,PC_JACOBI_ROWMAX,PC_JACOBI_ROWSUM} PCJacobiType; 111 112 /*E 113 PCASMType - Type of additive Schwarz method to use 114 115 $ PC_ASM_BASIC - Symmetric version where residuals from the ghost points are used 116 $ and computed values in ghost regions are added together. 117 $ Classical standard additive Schwarz. 118 $ PC_ASM_RESTRICT - Residuals from ghost points are used but computed values in ghost 119 $ region are discarded. 120 $ Default. 121 $ PC_ASM_INTERPOLATE - Residuals from ghost points are not used, computed values in ghost 122 $ region are added back in. 123 $ PC_ASM_NONE - Residuals from ghost points are not used, computed ghost values are 124 $ discarded. 125 $ Not very good. 126 127 Level: beginner 128 129 .seealso: PCASMSetType() 130 E*/ 131 typedef enum {PC_ASM_BASIC = 3,PC_ASM_RESTRICT = 1,PC_ASM_INTERPOLATE = 2,PC_ASM_NONE = 0} PCASMType; 132 133 /*E 134 PCGASMType - Type of generalized additive Schwarz method to use (differs from ASM in allowing multiple processors per subdomain). 135 136 Each subdomain has nested inner and outer parts. The inner subdomains are assumed to form a non-overlapping covering of the computational 137 domain, while the outer subdomains contain the inner subdomains and overlap with each other. This preconditioner will compute 138 a subdomain correction over each *outer* subdomain from a residual computed there, but its different variants will differ in 139 (a) how the outer subdomain residual is computed, and (b) how the outer subdomain correction is computed. 140 141 $ PC_GASM_BASIC - Symmetric version where the full from the outer subdomain is used, and the resulting correction is applied 142 $ over the outer subdomains. As a result, points in the overlap will receive the sum of the corrections 143 $ from neighboring subdomains. 144 $ Classical standard additive Schwarz. 145 $ PC_GASM_RESTRICT - Residual from the outer subdomain is used but the correction is restricted to the inner subdomain only 146 $ (i.e., zeroed out over the overlap portion of the outer subdomain before being applied). As a result, 147 $ each point will receive a correction only from the unique inner subdomain containing it (nonoverlapping covering 148 $ assumption). 149 $ Default. 150 $ PC_GASM_INTERPOLATE - Residual is zeroed out over the overlap portion of the outer subdomain, but the resulting correction is 151 $ applied over the outer subdomain. As a result, points in the overlap will receive the sum of the corrections 152 $ from neighboring subdomains. 153 $ 154 $ PC_GASM_NONE - Residuals and corrections are zeroed out outside the local subdomains. 155 $ Not very good. 156 157 Level: beginner 158 159 .seealso: PCGASMSetType() 160 E*/ 161 typedef enum {PC_GASM_BASIC = 3,PC_GASM_RESTRICT = 1,PC_GASM_INTERPOLATE = 2,PC_GASM_NONE = 0} PCGASMType; 162 163 /*E 164 PCCompositeType - Determines how two or more preconditioner are composed 165 166 $ PC_COMPOSITE_ADDITIVE - results from application of all preconditioners are added together 167 $ PC_COMPOSITE_MULTIPLICATIVE - preconditioners are applied sequentially to the residual freshly 168 $ computed after the previous preconditioner application 169 $ PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE - preconditioners are applied sequentially to the residual freshly 170 $ computed from first preconditioner to last and then back (Use only for symmetric matrices and preconditioners) 171 $ PC_COMPOSITE_SPECIAL - This is very special for a matrix of the form alpha I + R + S 172 $ where first preconditioner is built from alpha I + S and second from 173 $ alpha I + R 174 175 Level: beginner 176 177 .seealso: PCCompositeSetType() 178 E*/ 179 typedef enum {PC_COMPOSITE_ADDITIVE,PC_COMPOSITE_MULTIPLICATIVE,PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE,PC_COMPOSITE_SPECIAL,PC_COMPOSITE_SCHUR,PC_COMPOSITE_GKB} PCCompositeType; 180 181 /*E 182 PCFieldSplitSchurPreType - Determines how to precondition Schur complement 183 184 Level: intermediate 185 186 .seealso: PCFieldSplitSetSchurPre() 187 E*/ 188 typedef enum {PC_FIELDSPLIT_SCHUR_PRE_SELF,PC_FIELDSPLIT_SCHUR_PRE_SELFP,PC_FIELDSPLIT_SCHUR_PRE_A11,PC_FIELDSPLIT_SCHUR_PRE_USER,PC_FIELDSPLIT_SCHUR_PRE_FULL} PCFieldSplitSchurPreType; 189 190 /*E 191 PCFieldSplitSchurFactType - determines which off-diagonal parts of the approximate block factorization to use 192 193 Level: intermediate 194 195 .seealso: PCFieldSplitSetSchurFactType() 196 E*/ 197 typedef enum { 198 PC_FIELDSPLIT_SCHUR_FACT_DIAG, 199 PC_FIELDSPLIT_SCHUR_FACT_LOWER, 200 PC_FIELDSPLIT_SCHUR_FACT_UPPER, 201 PC_FIELDSPLIT_SCHUR_FACT_FULL 202 } PCFieldSplitSchurFactType; 203 204 /*E 205 PCPARMSGlobalType - Determines the global preconditioner method in PARMS 206 207 Level: intermediate 208 209 .seealso: PCPARMSSetGlobal() 210 E*/ 211 typedef enum {PC_PARMS_GLOBAL_RAS,PC_PARMS_GLOBAL_SCHUR,PC_PARMS_GLOBAL_BJ} PCPARMSGlobalType; 212 213 /*E 214 PCPARMSLocalType - Determines the local preconditioner method in PARMS 215 216 Level: intermediate 217 218 .seealso: PCPARMSSetLocal() 219 E*/ 220 typedef enum {PC_PARMS_LOCAL_ILU0,PC_PARMS_LOCAL_ILUK,PC_PARMS_LOCAL_ILUT,PC_PARMS_LOCAL_ARMS} PCPARMSLocalType; 221 222 /*J 223 PCGAMGType - type of generalized algebraic multigrid (PCGAMG) method 224 225 Level: intermediate 226 227 $ PCGAMGAGG - (the default) smoothed aggregation algorithm, robust, very well tested 228 $ PCGAMGGEO - geometric coarsening, uses mesh generator to produce coarser meshes, limited to triangles, not well tested 229 $ PCGAMGCLASSICAL - classical algebraic multigrid preconditioner, incomplete, poorly tested 230 231 .seealso: PCMG, PCSetType(), PCGAMGSetThreshold(), PCGAMGSetThreshold(), PCGAMGSetReuseInterpolation() 232 J*/ 233 typedef const char *PCGAMGType; 234 #define PCGAMGAGG "agg" 235 #define PCGAMGGEO "geo" 236 #define PCGAMGCLASSICAL "classical" 237 238 typedef const char *PCGAMGClassicalType; 239 #define PCGAMGCLASSICALDIRECT "direct" 240 #define PCGAMGCLASSICALSTANDARD "standard" 241 242 /*E 243 PCMGType - Determines the type of multigrid method that is run. 244 245 Level: beginner 246 247 Values: 248 + PC_MG_MULTIPLICATIVE (default) - traditional V or W cycle as determined by PCMGSetCycleType() 249 . PC_MG_ADDITIVE - the additive multigrid preconditioner where all levels are 250 smoothed before updating the residual. This only uses the 251 down smoother, in the preconditioner the upper smoother is ignored 252 . PC_MG_FULL - same as multiplicative except one also performs grid sequencing, 253 that is starts on the coarsest grid, performs a cycle, interpolates 254 to the next, performs a cycle etc. This is much like the F-cycle presented in "Multigrid" by Trottenberg, Oosterlee, Schuller page 49, but that 255 algorithm supports smoothing on before the restriction on each level in the initial restriction to the coarsest stage. In addition that algorithm 256 calls the V-cycle only on the coarser level and has a post-smoother instead. 257 - PC_MG_KASKADE - like full multigrid except one never goes back to a coarser level 258 from a finer 259 260 .seealso: PCMGSetType(), PCMGSetCycleType(), PCMGSetCycleTypeOnLevel() 261 262 E*/ 263 typedef enum { PC_MG_MULTIPLICATIVE,PC_MG_ADDITIVE,PC_MG_FULL,PC_MG_KASKADE } PCMGType; 264 #define PC_MG_CASCADE PC_MG_KASKADE; 265 266 /*E 267 PCMGCycleType - Use V-cycle or W-cycle 268 269 Level: beginner 270 271 Values: 272 + PC_MG_V_CYCLE 273 - PC_MG_W_CYCLE 274 275 .seealso: PCMGSetCycleType() 276 277 E*/ 278 typedef enum { PC_MG_CYCLE_V = 1,PC_MG_CYCLE_W = 2 } PCMGCycleType; 279 280 /*E 281 PCMGalerkinType - Determines if the coarse grid operators are computed via the Galerkin process 282 283 Level: beginner 284 285 Values: 286 + PC_MG_GALERKIN_PMAT - computes the pmat (matrix from which the preconditioner is built) via the Galerkin process from the finest grid 287 . PC_MG_GALERKIN_MAT - computes the mat (matrix used to apply the operator) via the Galerkin process from the finest grid 288 . PC_MG_GALERKIN_BOTH - computes both the mat and pmat via the Galerkin process (if pmat == mat the construction is only done once 289 - PC_MG_GALERKIN_NONE - neither operator is computed via the Galerkin process, the user must provide the operator 290 291 Users should never set PC_MG_GALERKIN_EXTERNAL, it is used by GAMG and ML 292 293 .seealso: PCMGSetCycleType() 294 295 E*/ 296 typedef enum { PC_MG_GALERKIN_BOTH,PC_MG_GALERKIN_PMAT,PC_MG_GALERKIN_MAT, PC_MG_GALERKIN_NONE, PC_MG_GALERKIN_EXTERNAL} PCMGGalerkinType; 297 298 /*E 299 PCExoticType - Face based or wirebasket based coarse grid space 300 301 Level: beginner 302 303 .seealso: PCExoticSetType(), PCEXOTIC 304 E*/ 305 typedef enum { PC_EXOTIC_FACE,PC_EXOTIC_WIREBASKET } PCExoticType; 306 307 /*E 308 PCBDDCInterfaceExtType - Defines how interface balancing is extended into the interior of subdomains. 309 310 Level: intermediate 311 312 Values: 313 + PC_BDDC_INTERFACE_EXT_DIRICHLET - solves Dirichlet interior problem; this is the standard BDDC algorithm 314 - PC_BDDC_INTERFACE_EXT_LUMP - skips interior solve; sometimes called M_1 and associated with "lumped FETI-DP" 315 316 E*/ 317 typedef enum { 318 PC_BDDC_INTERFACE_EXT_DIRICHLET, 319 PC_BDDC_INTERFACE_EXT_LUMP 320 } PCBDDCInterfaceExtType; 321 322 /*E 323 PCPatchConstructType - The algorithm used to construct patches for the preconditioner 324 325 Level: beginner 326 327 .seealso: PCPatchSetConstructType(), PCEXOTIC 328 E*/ 329 typedef enum {PC_PATCH_STAR, PC_PATCH_VANKA, PC_PATCH_PARDECOMP, PC_PATCH_USER, PC_PATCH_PYTHON} PCPatchConstructType; 330 331 /*E 332 PCDeflationSpaceType - Type of deflation 333 334 Values: 335 + PC_DEFLATION_SPACE_HAAR - directly assembled based on Haar (db2) wavelet with overflowed filter cuted-off 336 . PC_DEFLATION_SPACE_DB2 - MATCOMPOSITE of 1-lvl matices based on db2 (2 coefficient Daubechies / Haar wavelet) 337 . PC_DEFLATION_SPACE_DB4 - same as above, but with db4 (4 coefficient Daubechies) 338 . PC_DEFLATION_SPACE_DB8 - same as above, but with db8 (8 coefficient Daubechies) 339 . PC_DEFLATION_SPACE_DB16 - same as above, but with db16 (16 coefficient Daubechies) 340 . PC_DEFLATION_SPACE_BIORTH22 - same as above, but with biorthogonal 2.2 (6 coefficients) 341 . PC_DEFLATION_SPACE_MEYER - same as above, but with Meyer/FIR (62 coefficients) 342 . PC_DEFLATION_SPACE_AGGREGATION - aggregates local indices (given by operator matix distribution) into a subdomain 343 - PC_DEFLATION_SPACE_USER - indicates space set by user 344 345 Notes: 346 Wavelet-based space (except Haar) can be used in multilevel deflation. 347 348 Level: intermediate 349 350 .seealso: PCDeflationSetSpaceToCompute(), PCDEFLATION 351 E*/ 352 typedef enum { 353 PC_DEFLATION_SPACE_HAAR, 354 PC_DEFLATION_SPACE_DB2, 355 PC_DEFLATION_SPACE_DB4, 356 PC_DEFLATION_SPACE_DB8, 357 PC_DEFLATION_SPACE_DB16, 358 PC_DEFLATION_SPACE_BIORTH22, 359 PC_DEFLATION_SPACE_MEYER, 360 PC_DEFLATION_SPACE_AGGREGATION, 361 PC_DEFLATION_SPACE_USER 362 } PCDeflationSpaceType; 363 364 /*E 365 PCHPDDMCoarseCorrectionType - Type of coarse correction used by PCHPDDM 366 367 Level: intermediate 368 369 Values: 370 + PC_HPDDM_COARSE_CORRECTION_DEFLATED (default) - eq. (1) in PCHPDDMShellApply() 371 . PC_HPDDM_COARSE_CORRECTION_ADDITIVE - eq. (2) 372 - PC_HPDDM_COARSE_CORRECTION_BALANCED - eq. (3) 373 374 .seealso: PCHPDDM, PCSetType(), PCHPDDMShellApply() 375 E*/ 376 typedef enum { PC_HPDDM_COARSE_CORRECTION_DEFLATED, PC_HPDDM_COARSE_CORRECTION_ADDITIVE, PC_HPDDM_COARSE_CORRECTION_BALANCED } PCHPDDMCoarseCorrectionType; 377 378 /*E 379 PCFailedReason - indicates type of PC failure 380 381 Level: beginner 382 383 Any additions/changes here MUST also be made in include/petsc/finclude/petscpc.h 384 E*/ 385 typedef enum {PC_NOERROR,PC_FACTOR_STRUCT_ZEROPIVOT,PC_FACTOR_NUMERIC_ZEROPIVOT,PC_FACTOR_OUTMEMORY,PC_FACTOR_OTHER,PC_SUBPC_ERROR} PCFailedReason; 386 387 /*E 388 PCGAMGLayoutType - Layout for reduced grids 389 390 Level: intermediate 391 392 .seealso: PCGAMGSetCoarseGridLayoutType() 393 Any additions/changes here MUST also be made in include/petsc/finclude/petscpc.h 394 E*/ 395 typedef enum {PCGAMG_LAYOUT_COMPACT,PCGAMG_LAYOUT_SPREAD} PCGAMGLayoutType; 396 397 #endif 398