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