1 #if !defined(_PETSCPCTYPES_H) 2 #define _PETSCPCTYPES_H 3 4 #include <petscdmtypes.h> 5 6 /*S 7 PC - Abstract PETSc object that manages all preconditioners including direct solvers such as PCLU 8 9 Level: beginner 10 11 Concepts: preconditioners 12 13 .seealso: PCCreate(), PCSetType(), PCType (for list of available types) 14 S*/ 15 typedef struct _p_PC* PC; 16 17 /*J 18 PCType - String with the name of a PETSc preconditioner method. 19 20 Level: beginner 21 22 Notes: 23 Click on the links above to see details on a particular solver 24 25 PCRegister() is used to register preconditioners that are then accessible via PCSetType() 26 27 .seealso: PCSetType(), PC, PCCreate(), PCRegister(), PCSetFromOptions() 28 J*/ 29 typedef const char* PCType; 30 #define PCNONE "none" 31 #define PCJACOBI "jacobi" 32 #define PCSOR "sor" 33 #define PCLU "lu" 34 #define PCSHELL "shell" 35 #define PCBJACOBI "bjacobi" 36 #define PCMG "mg" 37 #define PCEISENSTAT "eisenstat" 38 #define PCILU "ilu" 39 #define PCICC "icc" 40 #define PCASM "asm" 41 #define PCGASM "gasm" 42 #define PCKSP "ksp" 43 #define PCCOMPOSITE "composite" 44 #define PCREDUNDANT "redundant" 45 #define PCSPAI "spai" 46 #define PCNN "nn" 47 #define PCCHOLESKY "cholesky" 48 #define PCPBJACOBI "pbjacobi" 49 #define PCVPBJACOBI "vpbjacobi" 50 #define PCMAT "mat" 51 #define PCHYPRE "hypre" 52 #define PCPARMS "parms" 53 #define PCFIELDSPLIT "fieldsplit" 54 #define PCTFS "tfs" 55 #define PCML "ml" 56 #define PCGALERKIN "galerkin" 57 #define PCEXOTIC "exotic" 58 #define PCCP "cp" 59 #define PCBFBT "bfbt" 60 #define PCLSC "lsc" 61 #define PCPYTHON "python" 62 #define PCPFMG "pfmg" 63 #define PCSYSPFMG "syspfmg" 64 #define PCREDISTRIBUTE "redistribute" 65 #define PCSVD "svd" 66 #define PCGAMG "gamg" 67 #define PCCHOWILUVIENNACL "chowiluviennacl" 68 #define PCROWSCALINGVIENNACL "rowscalingviennacl" 69 #define PCSAVIENNACL "saviennacl" 70 #define PCBDDC "bddc" 71 #define PCKACZMARZ "kaczmarz" 72 #define PCTELESCOPE "telescope" 73 #define PCLMVM "lmvm" 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_SIDE_DEFAULT=-1,PC_LEFT,PC_RIGHT,PC_SYMMETRIC} PCSide; 84 #define PC_SIDE_MAX (PC_SYMMETRIC + 1) 85 PETSC_EXTERN const char *const *const PCSides; 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 PETSC_EXTERN const char *const PCJacobiTypes[]; 112 113 /*E 114 PCASMType - Type of additive Schwarz method to use 115 116 $ PC_ASM_BASIC - Symmetric version where residuals from the ghost points are used 117 $ and computed values in ghost regions are added together. 118 $ Classical standard additive Schwarz. 119 $ PC_ASM_RESTRICT - Residuals from ghost points are used but computed values in ghost 120 $ region are discarded. 121 $ Default. 122 $ PC_ASM_INTERPOLATE - Residuals from ghost points are not used, computed values in ghost 123 $ region are added back in. 124 $ PC_ASM_NONE - Residuals from ghost points are not used, computed ghost values are 125 $ discarded. 126 $ Not very good. 127 128 Level: beginner 129 130 .seealso: PCASMSetType() 131 E*/ 132 typedef enum {PC_ASM_BASIC = 3,PC_ASM_RESTRICT = 1,PC_ASM_INTERPOLATE = 2,PC_ASM_NONE = 0} PCASMType; 133 PETSC_EXTERN const char *const PCASMTypes[]; 134 135 /*E 136 PCGASMType - Type of generalized additive Schwarz method to use (differs from ASM in allowing multiple processors per subdomain). 137 138 Each subdomain has nested inner and outer parts. The inner subdomains are assumed to form a non-overlapping covering of the computational 139 domain, while the outer subdomains contain the inner subdomains and overlap with each other. This preconditioner will compute 140 a subdomain correction over each *outer* subdomain from a residual computed there, but its different variants will differ in 141 (a) how the outer subdomain residual is computed, and (b) how the outer subdomain correction is computed. 142 143 $ PC_GASM_BASIC - Symmetric version where the full from the outer subdomain is used, and the resulting correction is applied 144 $ over the outer subdomains. As a result, points in the overlap will receive the sum of the corrections 145 $ from neighboring subdomains. 146 $ Classical standard additive Schwarz. 147 $ PC_GASM_RESTRICT - Residual from the outer subdomain is used but the correction is restricted to the inner subdomain only 148 $ (i.e., zeroed out over the overlap portion of the outer subdomain before being applied). As a result, 149 $ each point will receive a correction only from the unique inner subdomain containing it (nonoverlapping covering 150 $ assumption). 151 $ Default. 152 $ PC_GASM_INTERPOLATE - Residual is zeroed out over the overlap portion of the outer subdomain, but the resulting correction is 153 $ applied over the outer subdomain. As a result, points in the overlap will receive the sum of the corrections 154 $ from neighboring subdomains. 155 $ 156 $ PC_GASM_NONE - Residuals and corrections are zeroed out outside the local subdomains. 157 $ Not very good. 158 159 Level: beginner 160 161 .seealso: PCGASMSetType() 162 E*/ 163 typedef enum {PC_GASM_BASIC = 3,PC_GASM_RESTRICT = 1,PC_GASM_INTERPOLATE = 2,PC_GASM_NONE = 0} PCGASMType; 164 PETSC_EXTERN const char *const PCGASMTypes[]; 165 166 /*E 167 PCCompositeType - Determines how two or more preconditioner are composed 168 169 $ PC_COMPOSITE_ADDITIVE - results from application of all preconditioners are added together 170 $ PC_COMPOSITE_MULTIPLICATIVE - preconditioners are applied sequentially to the residual freshly 171 $ computed after the previous preconditioner application 172 $ PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE - preconditioners are applied sequentially to the residual freshly 173 $ computed from first preconditioner to last and then back (Use only for symmetric matrices and preconditioners) 174 $ PC_COMPOSITE_SPECIAL - This is very special for a matrix of the form alpha I + R + S 175 $ where first preconditioner is built from alpha I + S and second from 176 $ alpha I + R 177 178 Level: beginner 179 180 .seealso: PCCompositeSetType() 181 E*/ 182 typedef enum {PC_COMPOSITE_ADDITIVE,PC_COMPOSITE_MULTIPLICATIVE,PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE,PC_COMPOSITE_SPECIAL,PC_COMPOSITE_SCHUR} PCCompositeType; 183 PETSC_EXTERN const char *const PCCompositeTypes[]; 184 185 /*E 186 PCFieldSplitSchurPreType - Determines how to precondition Schur complement 187 188 Level: intermediate 189 190 .seealso: PCFieldSplitSetSchurPre() 191 E*/ 192 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; 193 PETSC_EXTERN const char *const PCFieldSplitSchurPreTypes[]; 194 195 /*E 196 PCFieldSplitSchurFactType - determines which off-diagonal parts of the approximate block factorization to use 197 198 Level: intermediate 199 200 .seealso: PCFieldSplitSetSchurFactType() 201 E*/ 202 typedef enum { 203 PC_FIELDSPLIT_SCHUR_FACT_DIAG, 204 PC_FIELDSPLIT_SCHUR_FACT_LOWER, 205 PC_FIELDSPLIT_SCHUR_FACT_UPPER, 206 PC_FIELDSPLIT_SCHUR_FACT_FULL 207 } PCFieldSplitSchurFactType; 208 PETSC_EXTERN const char *const PCFieldSplitSchurFactTypes[]; 209 210 /*E 211 PCPARMSGlobalType - Determines the global preconditioner method in PARMS 212 213 Level: intermediate 214 215 .seealso: PCPARMSSetGlobal() 216 E*/ 217 typedef enum {PC_PARMS_GLOBAL_RAS,PC_PARMS_GLOBAL_SCHUR,PC_PARMS_GLOBAL_BJ} PCPARMSGlobalType; 218 PETSC_EXTERN const char *const PCPARMSGlobalTypes[]; 219 /*E 220 PCPARMSLocalType - Determines the local preconditioner method in PARMS 221 222 Level: intermediate 223 224 .seealso: PCPARMSSetLocal() 225 E*/ 226 typedef enum {PC_PARMS_LOCAL_ILU0,PC_PARMS_LOCAL_ILUK,PC_PARMS_LOCAL_ILUT,PC_PARMS_LOCAL_ARMS} PCPARMSLocalType; 227 PETSC_EXTERN const char *const PCPARMSLocalTypes[]; 228 229 /*E 230 PCGAMGType - type of generalized algebraic multigrid (PCGAMG) method 231 232 Level: intermediate 233 234 .seealso: PCMG, PCSetType(), PCGAMGSetThreshold(), PCGAMGSetThreshold(), PCGAMGSetReuseInterpolation() 235 E*/ 236 typedef const char *PCGAMGType; 237 #define PCGAMGAGG "agg" 238 #define PCGAMGGEO "geo" 239 #define PCGAMGCLASSICAL "classical" 240 241 typedef const char *PCGAMGClassicalType; 242 #define PCGAMGCLASSICALDIRECT "direct" 243 #define PCGAMGCLASSICALSTANDARD "standard" 244 245 /*E 246 PCMGType - Determines the type of multigrid method that is run. 247 248 Level: beginner 249 250 Values: 251 + PC_MG_MULTIPLICATIVE (default) - traditional V or W cycle as determined by PCMGSetCycleType() 252 . PC_MG_ADDITIVE - the additive multigrid preconditioner where all levels are 253 smoothed before updating the residual. This only uses the 254 down smoother, in the preconditioner the upper smoother is ignored 255 . PC_MG_FULL - same as multiplicative except one also performs grid sequencing, 256 that is starts on the coarsest grid, performs a cycle, interpolates 257 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 258 algorithm supports smoothing on before the restriction on each level in the initial restriction to the coarsest stage. In addition that algorithm 259 calls the V-cycle only on the coarser level and has a post-smoother instead. 260 - PC_MG_KASKADE - like full multigrid except one never goes back to a coarser level 261 from a finer 262 263 .seealso: PCMGSetType(), PCMGSetCycleType(), PCMGSetCycleTypeOnLevel() 264 265 E*/ 266 typedef enum { PC_MG_MULTIPLICATIVE,PC_MG_ADDITIVE,PC_MG_FULL,PC_MG_KASKADE } PCMGType; 267 PETSC_EXTERN const char *const PCMGTypes[]; 268 #define PC_MG_CASCADE PC_MG_KASKADE; 269 270 /*E 271 PCMGCycleType - Use V-cycle or W-cycle 272 273 Level: beginner 274 275 Values: 276 + PC_MG_V_CYCLE 277 - PC_MG_W_CYCLE 278 279 .seealso: PCMGSetCycleType() 280 281 E*/ 282 typedef enum { PC_MG_CYCLE_V = 1,PC_MG_CYCLE_W = 2 } PCMGCycleType; 283 PETSC_EXTERN const char *const PCMGCycleTypes[]; 284 285 /*E 286 PCMGalerkinType - Determines if the coarse grid operators are computed via the Galerkin process 287 288 Level: beginner 289 290 Values: 291 + PC_MG_GALERKIN_PMAT - computes the pmat (matrix from which the preconditioner is built) via the Galerkin process from the finest grid 292 . PC_MG_GALERKIN_MAT - computes the mat (matrix used to apply the operator) via the Galerkin process from the finest grid 293 . PC_MG_GALERKIN_BOTH - computes both the mat and pmat via the Galerkin process (if pmat == mat the construction is only done once 294 - PC_MG_GALERKIN_NONE - neither operator is computed via the Galerkin process, the user must provide the operator 295 296 Users should never set PC_MG_GALERKIN_EXTERNAL, it is used by GAMG and ML 297 298 .seealso: PCMGSetCycleType() 299 300 E*/ 301 typedef enum { PC_MG_GALERKIN_BOTH,PC_MG_GALERKIN_PMAT,PC_MG_GALERKIN_MAT, PC_MG_GALERKIN_NONE, PC_MG_GALERKIN_EXTERNAL} PCMGGalerkinType; 302 PETSC_EXTERN const char *const PCMGGalerkinTypes[]; 303 304 /*E 305 PCExoticType - Face based or wirebasket based coarse grid space 306 307 Level: beginner 308 309 .seealso: PCExoticSetType(), PCEXOTIC 310 E*/ 311 typedef enum { PC_EXOTIC_FACE,PC_EXOTIC_WIREBASKET } PCExoticType; 312 PETSC_EXTERN const char *const PCExoticTypes[]; 313 PETSC_EXTERN PetscErrorCode PCExoticSetType(PC,PCExoticType); 314 315 /*E 316 PCFailedReason - indicates type of PC failure 317 318 Level: beginner 319 320 Any additions/changes here MUST also be made in include/petsc/finclude/petscpc.h 321 E*/ 322 typedef enum {PC_NOERROR,PC_FACTOR_STRUCT_ZEROPIVOT,PC_FACTOR_NUMERIC_ZEROPIVOT,PC_FACTOR_OUTMEMORY,PC_FACTOR_OTHER,PC_SUBPC_ERROR} PCFailedReason; 323 PETSC_EXTERN const char *const PCFailedReasons[]; 324 #endif 325