1 /* Portions of this code are under: 2 Copyright (c) 2022 Advanced Micro Devices, Inc. All rights reserved. 3 */ 4 5 #pragma once 6 7 #include <petscconf.h> 8 #include <petscconf_poison.h> 9 #include <petscfix.h> 10 #include <petscmacros.h> // PETSC_NODISCARD, PETSC_CPP_VERSION 11 #include <stddef.h> 12 #include <stdbool.h> 13 14 /* SUBMANSEC = Sys */ 15 16 #include <limits.h> // INT_MIN, INT_MAX, CHAR_BIT 17 18 #if defined(__clang__) || (PETSC_CPP_VERSION >= 17) 19 // clang allows both [[nodiscard]] and __attribute__((warn_unused_result)) on type 20 // definitions. GCC, however, does not, so check that we are using C++17 [[nodiscard]] 21 // instead of __attribute__((warn_unused_result)) 22 #define PETSC_ERROR_CODE_NODISCARD PETSC_NODISCARD 23 #else 24 #define PETSC_ERROR_CODE_NODISCARD 25 #endif 26 27 #ifdef PETSC_CLANG_STATIC_ANALYZER 28 #undef PETSC_USE_STRICT_PETSCERRORCODE 29 #endif 30 31 #ifdef PETSC_USE_STRICT_PETSCERRORCODE 32 #define PETSC_ERROR_CODE_TYPEDEF typedef 33 #define PETSC_ERROR_CODE_ENUM_NAME PetscErrorCode 34 #else 35 #define PETSC_ERROR_CODE_TYPEDEF 36 #define PETSC_ERROR_CODE_ENUM_NAME 37 #endif 38 39 /*E 40 PetscErrorCode - Datatype used to return PETSc error codes. 41 42 Level: beginner 43 44 Notes: 45 Virtually all PETSc functions return an error code. It is the callers responsibility to check 46 the value of the returned error code after each PETSc call to determine if any errors 47 occurred. A set of convenience macros (e.g. `PetscCall()`, `PetscCallVoid()`) are provided 48 for this purpose. Failing to properly check for errors is not supported, as errors may leave 49 PETSc in an undetermined state. 50 51 One can retrieve the error string corresponding to a particular error code using 52 `PetscErrorMessage()`. 53 54 The user can also configure PETSc with the `--with-strict-petscerrorcode` option to enable 55 compiler warnings when the returned error codes are not captured and checked. Users are 56 *heavily* encouraged to opt-in to this option, as it will become enabled by default in a 57 future release. 58 59 Developer Notes: 60 These are the generic error codes. These error codes are used in many different places in the 61 PETSc source code. The C-string versions are at defined in `PetscErrorStrings[]` in 62 `src/sys/error/err.c`, while the Fortran versions are defined in 63 `src/sys/ftn-mod/petscerror.h`. Any changes here must also be made in both locations. 64 65 .seealso: `PetscErrorMessage()`, `PetscCall()`, `SETERRQ()` 66 E*/ 67 PETSC_ERROR_CODE_TYPEDEF enum PETSC_ERROR_CODE_NODISCARD { 68 PETSC_SUCCESS = 0, 69 PETSC_ERR_BOOLEAN_MACRO_FAILURE = 1, /* do not use */ 70 71 PETSC_ERR_MIN_VALUE = 54, /* should always be one less than the smallest value */ 72 73 PETSC_ERR_MEM = 55, /* unable to allocate requested memory */ 74 PETSC_ERR_SUP = 56, /* no support for requested operation */ 75 PETSC_ERR_SUP_SYS = 57, /* no support for requested operation on this computer system */ 76 PETSC_ERR_ORDER = 58, /* operation done in wrong order */ 77 PETSC_ERR_SIG = 59, /* signal received */ 78 PETSC_ERR_FP = 72, /* floating point exception */ 79 PETSC_ERR_COR = 74, /* corrupted PETSc object */ 80 PETSC_ERR_LIB = 76, /* error in library called by PETSc */ 81 PETSC_ERR_PLIB = 77, /* PETSc library generated inconsistent data */ 82 PETSC_ERR_MEMC = 78, /* memory corruption */ 83 PETSC_ERR_CONV_FAILED = 82, /* iterative method (KSP or SNES) failed */ 84 PETSC_ERR_USER = 83, /* user has not provided needed function */ 85 PETSC_ERR_SYS = 88, /* error in system call */ 86 PETSC_ERR_POINTER = 70, /* pointer does not point to valid address */ 87 PETSC_ERR_MPI_LIB_INCOMP = 87, /* MPI library at runtime is not compatible with MPI user compiled with */ 88 89 PETSC_ERR_ARG_SIZ = 60, /* nonconforming object sizes used in operation */ 90 PETSC_ERR_ARG_IDN = 61, /* two arguments not allowed to be the same */ 91 PETSC_ERR_ARG_WRONG = 62, /* wrong argument (but object probably ok) */ 92 PETSC_ERR_ARG_CORRUPT = 64, /* null or corrupted PETSc object as argument */ 93 PETSC_ERR_ARG_OUTOFRANGE = 63, /* input argument, out of range */ 94 PETSC_ERR_ARG_BADPTR = 68, /* invalid pointer argument */ 95 PETSC_ERR_ARG_NOTSAMETYPE = 69, /* two args must be same object type */ 96 PETSC_ERR_ARG_NOTSAMECOMM = 80, /* two args must be same communicators */ 97 PETSC_ERR_ARG_WRONGSTATE = 73, /* object in argument is in wrong state, e.g. unassembled mat */ 98 PETSC_ERR_ARG_TYPENOTSET = 89, /* the type of the object has not yet been set */ 99 PETSC_ERR_ARG_INCOMP = 75, /* two arguments are incompatible */ 100 PETSC_ERR_ARG_NULL = 85, /* argument is null that should not be */ 101 PETSC_ERR_ARG_UNKNOWN_TYPE = 86, /* type name doesn't match any registered type */ 102 103 PETSC_ERR_FILE_OPEN = 65, /* unable to open file */ 104 PETSC_ERR_FILE_READ = 66, /* unable to read from file */ 105 PETSC_ERR_FILE_WRITE = 67, /* unable to write to file */ 106 PETSC_ERR_FILE_UNEXPECTED = 79, /* unexpected data in file */ 107 108 PETSC_ERR_MAT_LU_ZRPVT = 71, /* detected a zero pivot during LU factorization */ 109 PETSC_ERR_MAT_CH_ZRPVT = 81, /* detected a zero pivot during Cholesky factorization */ 110 111 PETSC_ERR_INT_OVERFLOW = 84, 112 PETSC_ERR_FLOP_COUNT = 90, 113 PETSC_ERR_NOT_CONVERGED = 91, /* solver did not converge */ 114 PETSC_ERR_MISSING_FACTOR = 92, /* MatGetFactor() failed */ 115 PETSC_ERR_OPT_OVERWRITE = 93, /* attempted to over write options which should not be changed */ 116 PETSC_ERR_WRONG_MPI_SIZE = 94, /* example/application run with number of MPI ranks it does not support */ 117 PETSC_ERR_USER_INPUT = 95, /* missing or incorrect user input */ 118 PETSC_ERR_GPU_RESOURCE = 96, /* unable to load a GPU resource, for example cuBLAS */ 119 PETSC_ERR_GPU = 97, /* An error from a GPU call, this may be due to lack of resources on the GPU or a true error in the call */ 120 PETSC_ERR_MPI = 98, /* general MPI error */ 121 PETSC_ERR_RETURN = 99, /* PetscError() incorrectly returned an error code of 0 */ 122 PETSC_ERR_MEM_LEAK = 100, /* memory alloc/free imbalance */ 123 PETSC_ERR_PYTHON = 101, /* Exception in Python */ 124 PETSC_ERR_MAX_VALUE = 102, /* this is always the one more than the largest error code */ 125 126 /* 127 do not use, exist purely to make the enum bounds equal that of a regular int (so conversion 128 to int in main() is not undefined behavior) 129 */ 130 PETSC_ERR_MIN_SIGNED_BOUND_DO_NOT_USE = INT_MIN, 131 PETSC_ERR_MAX_SIGNED_BOUND_DO_NOT_USE = INT_MAX 132 } PETSC_ERROR_CODE_ENUM_NAME; 133 134 #if !defined(PETSC_USE_STRICT_PETSCERRORCODE) 135 typedef int PetscErrorCode; 136 137 /* 138 Needed so that C++ lambdas can deduce the return type as PetscErrorCode from 139 PetscFunctionReturn(PETSC_SUCCESS). Otherwise we get 140 141 error: return type '(unnamed enum at include/petscsystypes.h:50:1)' must match previous 142 return type 'int' when lambda expression has unspecified explicit return type 143 PetscFunctionReturn(PETSC_SUCCESS); 144 ^ 145 */ 146 #define PETSC_SUCCESS ((PetscErrorCode)0) 147 #endif 148 149 #undef PETSC_ERROR_CODE_NODISCARD 150 #undef PETSC_ERROR_CODE_TYPEDEF 151 #undef PETSC_ERROR_CODE_ENUM_NAME 152 153 /*MC 154 PetscClassId - A unique id used to identify each PETSc class. 155 156 Level: developer 157 158 Note: 159 Use `PetscClassIdRegister()` to obtain a new value for a new class being created. Usually 160 XXXInitializePackage() calls it for each class it defines. 161 162 Developer Note: 163 Internal integer stored in the `_p_PetscObject` data structure. These are all computed by an offset from the lowest one, `PETSC_SMALLEST_CLASSID`. 164 165 .seealso: `PetscClassIdRegister()`, `PetscLogEventRegister()`, `PetscHeaderCreate()` 166 M*/ 167 typedef int PetscClassId; 168 169 /*MC 170 PetscMPIInt - datatype used to represent `int` parameters to MPI functions. 171 172 Level: intermediate 173 174 Notes: 175 This is always a 32-bit integer even if PETSc was built with `--with-64-bit-indices`. 176 Hence, it is not guaranteed that it is the same as `PetscInt`. 177 178 `PetscMPIIntCast`(a,&b) checks if the given `PetscInt` a will fit in a `PetscMPIInt`, if not it 179 generates a `PETSC_ERR_ARG_OUTOFRANGE` error. 180 181 .seealso: [](stylePetscCount), `PetscBLASInt`, `PetscInt`, `PetscMPIIntCast()` 182 M*/ 183 typedef int PetscMPIInt; 184 185 /* Limit MPI to 32-bits */ 186 enum { 187 PETSC_MPI_INT_MIN = INT_MIN, 188 PETSC_MPI_INT_MAX = INT_MAX 189 }; 190 191 /*MC 192 PetscSizeT - datatype used to represent sizes in memory (like `size_t`) 193 194 Level: intermediate 195 196 Notes: 197 This is equivalent to `size_t`, but defined for consistency with Fortran, which lacks a native equivalent of `size_t`. 198 199 .seealso: `PetscInt`, `PetscInt64`, `PetscCount` 200 M*/ 201 typedef size_t PetscSizeT; 202 203 /*MC 204 PetscCount - signed datatype used to represent counts 205 206 Level: intermediate 207 208 Notes: 209 This is equivalent to `ptrdiff_t`, but defined for consistency with Fortran, which lacks a native equivalent of `ptrdiff_t`. 210 211 Use `PetscCount_FMT` to format with `PetscPrintf()`, `printf()`, and related functions. 212 213 .seealso: [](stylePetscCount), `PetscInt`, `PetscInt64`, `PetscSizeT` 214 M*/ 215 typedef ptrdiff_t PetscCount; 216 #define PetscCount_FMT "td" 217 218 /*MC 219 PetscEnum - datatype used to pass enum types within PETSc functions. 220 221 Level: intermediate 222 223 .seealso: `PetscOptionsGetEnum()`, `PetscOptionsEnum()`, `PetscBagRegisterEnum()` 224 M*/ 225 typedef enum { 226 ENUM_DUMMY 227 } PetscEnum; 228 229 typedef short PetscShort; 230 typedef float PetscFloat; 231 232 /*MC 233 PetscInt - PETSc type that represents an integer, used primarily to 234 represent size of arrays and indexing into arrays. Its size can be configured with the option `--with-64-bit-indices` to be either 32-bit (default) or 64-bit. 235 236 Level: beginner 237 238 Notes: 239 For MPI calls that require datatypes, use `MPIU_INT` as the datatype for `PetscInt`. It will automatically work correctly regardless of the size of `PetscInt`. 240 241 .seealso: `PetscBLASInt`, `PetscMPIInt`, `PetscReal`, `PetscScalar`, `PetscComplex`, `PetscInt`, `MPIU_REAL`, `MPIU_SCALAR`, `MPIU_COMPLEX`, `MPIU_INT`, `PetscIntCast()` 242 M*/ 243 244 #if defined(PETSC_HAVE_STDINT_H) 245 #include <stdint.h> 246 #endif 247 #if defined(PETSC_HAVE_INTTYPES_H) 248 #if !defined(__STDC_FORMAT_MACROS) 249 #define __STDC_FORMAT_MACROS /* required for using PRId64 from c++ */ 250 #endif 251 #include <inttypes.h> 252 #if !defined(PRId64) 253 #define PRId64 "ld" 254 #endif 255 #endif 256 257 #if defined(PETSC_HAVE_STDINT_H) && defined(PETSC_HAVE_INTTYPES_H) && (defined(PETSC_HAVE_MPIUNI) || defined(PETSC_HAVE_MPI_INT64_T)) /* MPI_INT64_T is not guaranteed to be a macro */ 258 typedef int64_t PetscInt64; 259 260 #define PETSC_INT64_MIN INT64_MIN 261 #define PETSC_INT64_MAX INT64_MAX 262 263 #elif (PETSC_SIZEOF_LONG_LONG == 8) 264 typedef long long PetscInt64; 265 266 #define PETSC_INT64_MIN LLONG_MIN 267 #define PETSC_INT64_MAX LLONG_MAX 268 269 #elif defined(PETSC_HAVE___INT64) 270 typedef __int64 PetscInt64; 271 272 #define PETSC_INT64_MIN INT64_MIN 273 #define PETSC_INT64_MAX INT64_MAX 274 275 #else 276 #error "cannot determine PetscInt64 type" 277 #endif 278 279 #if PETSC_SIZEOF_SIZE_T == 4 280 #define PETSC_COUNT_MIN INT_MIN 281 #define PETSC_COUNT_MAX INT_MAX 282 #else 283 #define PETSC_COUNT_MIN PETSC_INT64_MIN 284 #define PETSC_COUNT_MAX PETSC_INT64_MAX 285 #endif 286 287 typedef int32_t PetscInt32; 288 #define PETSC_INT32_MIN INT32_MIN 289 #define PETSC_INT32_MAX INT32_MAX 290 291 #if defined(PETSC_USE_64BIT_INDICES) 292 typedef PetscInt64 PetscInt; 293 294 #define PETSC_INT_MIN PETSC_INT64_MIN 295 #define PETSC_INT_MAX PETSC_INT64_MAX 296 #define PetscInt_FMT PetscInt64_FMT 297 #else 298 typedef int PetscInt; 299 300 enum { 301 PETSC_INT_MIN = INT_MIN, 302 PETSC_INT_MAX = INT_MAX 303 }; 304 #define PetscInt_FMT "d" 305 #endif 306 307 #define PETSC_UINT16_MAX 65535 308 309 /* deprecated */ 310 #define PETSC_MIN_INT PETSC_INT_MIN 311 #define PETSC_MAX_INT PETSC_INT_MAX 312 #define PETSC_MAX_UINT16 PETSC_UINT16_MAX 313 314 #if defined(PETSC_HAVE_STDINT_H) && defined(PETSC_HAVE_INTTYPES_H) && (defined(PETSC_HAVE_MPIUNI) || defined(PETSC_HAVE_MPI_INT64_T)) /* MPI_INT64_T is not guaranteed to be a macro */ 315 #define MPIU_INT64 MPI_INT64_T 316 #define PetscInt64_FMT PRId64 317 #elif (PETSC_SIZEOF_LONG_LONG == 8) 318 #define MPIU_INT64 MPI_LONG_LONG_INT 319 #define PetscInt64_FMT "lld" 320 #elif defined(PETSC_HAVE___INT64) 321 #define MPIU_INT64 MPI_INT64_T 322 #define PetscInt64_FMT "ld" 323 #else 324 #error "cannot determine PetscInt64 type" 325 #endif 326 327 #define MPIU_INT32 MPI_INT32_T 328 #define PetscInt32_FMT PRId32 329 330 /*MC 331 PetscBLASInt - datatype used to represent 'int' parameters to BLAS/LAPACK functions. 332 333 Level: intermediate 334 335 Notes: 336 Usually this is the same as `PetscInt`, but if PETSc was built with `--with-64-bit-indices` but 337 standard C/Fortran integers are 32-bit then this may not be the same as `PetscInt`, 338 except on some BLAS/LAPACK implementations that support 64-bit integers see the notes below. 339 340 `PetscErrorCode` `PetscBLASIntCast`(a,&b) checks if the given `PetscInt` a will fit in a `PetscBLASInt`, if not it 341 generates a `PETSC_ERR_ARG_OUTOFRANGE` error 342 343 Installation Notes\: 344 ./configure automatically determines the size of the integers used by BLAS/LAPACK except when `--with-batch` is used 345 in that situation one must know (by some other means) if the integers used by BLAS/LAPACK are 64-bit and if so pass the flag `--known-64-bit-blas-indices` 346 347 MATLAB ships with BLAS and LAPACK that use 64-bit integers, for example if you run ./configure with, the option 348 `--with-blaslapack-lib`=[/Applications/MATLAB_R2010b.app/bin/maci64/libmwblas.dylib,/Applications/MATLAB_R2010b.app/bin/maci64/libmwlapack.dylib] 349 350 MKL ships with both 32 and 64-bit integer versions of the BLAS and LAPACK. If you pass the flag `-with-64-bit-blas-indices` PETSc will link 351 against the 64-bit version, otherwise it uses the 32-bit version 352 353 OpenBLAS can be built to use 64-bit integers. The ./configure options `--download-openblas` `-with-64-bit-blas-indices` will build a 64-bit integer version 354 355 External packages such as hypre, ML, SuperLU etc do not provide any support for passing 64-bit integers to BLAS/LAPACK so cannot 356 be used with PETSc when PETSc links against 64-bit integer BLAS/LAPACK. ./configure will generate an error if you attempt to link PETSc against any of 357 these external libraries while using 64-bit integer BLAS/LAPACK. 358 359 .seealso: `PetscMPIInt`, `PetscInt`, `PetscBLASIntCast()` 360 M*/ 361 #if defined(PETSC_HAVE_64BIT_BLAS_INDICES) 362 typedef PetscInt64 PetscBLASInt; 363 364 #define PETSC_BLAS_INT_MIN PETSC_INT64_MIN 365 #define PETSC_BLAS_INT_MAX PETSC_INT64_MAX 366 #define PetscBLASInt_FMT PetscInt64_FMT 367 #else 368 typedef int PetscBLASInt; 369 370 enum { 371 PETSC_BLAS_INT_MIN = INT_MIN, 372 PETSC_BLAS_INT_MAX = INT_MAX 373 }; 374 375 #define PetscBLASInt_FMT "d" 376 #endif 377 378 /*MC 379 PetscCuBLASInt - datatype used to represent 'int' parameters to cuBLAS/cuSOLVER functions. 380 381 Level: intermediate 382 383 Notes: 384 As of this writing `PetscCuBLASInt` is always the system `int`. 385 386 `PetscErrorCode` `PetscCuBLASIntCast`(a,&b) checks if the given `PetscInt` a will fit in a `PetscCuBLASInt`, if not it 387 generates a `PETSC_ERR_ARG_OUTOFRANGE` error 388 389 .seealso: `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscCuBLASIntCast()` 390 M*/ 391 typedef int PetscCuBLASInt; 392 393 enum { 394 PETSC_CUBLAS_INT_MIN = INT_MIN, 395 PETSC_CUBLAS_INT_MAX = INT_MAX 396 }; 397 398 /*MC 399 PetscHipBLASInt - datatype used to represent 'int' parameters to hipBLAS/hipSOLVER functions. 400 401 Level: intermediate 402 403 Notes: 404 `PetscHipBLASInt` is always the system `int`. 405 406 `PetscErrorCode` `PetscHipBLASIntCast`(a,&b) checks if the given `PetscInt` a will fit in a `PetscHipBLASInt`, if not it 407 generates a `PETSC_ERR_ARG_OUTOFRANGE` error 408 409 .seealso: `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscHipBLASIntCast()` 410 M*/ 411 typedef int PetscHipBLASInt; 412 413 enum { 414 PETSC_HIPBLAS_INT_MIN = INT_MIN, 415 PETSC_HIPBLAS_INT_MAX = INT_MAX 416 }; 417 418 /*MC 419 PetscExodusIIInt - datatype used to represent 'int' parameters to ExodusII functions. 420 421 Level: intermediate 422 423 Notes: 424 This is the same as `int` 425 426 .seealso: `PetscMPIInt`, `PetscInt`, `PetscExodusIIFloat`, `PetscBLASIntCast()` 427 M*/ 428 typedef int PetscExodusIIInt; 429 #define PetscExodusIIInt_FMT "d" 430 431 /*MC 432 PetscExodusIIFloat - datatype used to represent 'float' parameters to ExodusII functions. 433 434 Level: intermediate 435 436 Notes: 437 This is the same as `float` 438 439 .seealso: `PetscMPIInt`, `PetscInt`, `PetscExodusIIInt`, `PetscBLASIntCast()` 440 M*/ 441 typedef float PetscExodusIIFloat; 442 443 /*E 444 PetscBool - Logical variable. 445 446 Level: beginner 447 448 Notes: 449 This is a C bool. 450 451 Use `MPI_C_BOOL` for communicating with MPI calls in C, C++, and Fortran. 452 453 Fortran Note: 454 This is a `logical(C_BOOL)` with an internal representation that is equivalent to that of a `bool` in C and C++. 455 It typically has a size of 1 byte, in contrast to a default `logical` which has the size of a default integer (typically 4 bytes). 456 457 Developer Note: 458 We should deprecate this definition since there is a native representation in all the languages. 459 460 .seealso: `PETSC_TRUE`, `PETSC_FALSE`, `PetscNot()`, `PetscBool3` 461 E*/ 462 typedef bool PetscBool; 463 #define PETSC_FALSE false 464 #define PETSC_TRUE true 465 PETSC_EXTERN const char *const PetscBools[]; 466 467 /*E 468 PetscBool3 - Ternary logical variable. Actually an enum in C and a 4 byte integer in Fortran. 469 470 Level: beginner 471 472 Note: 473 Should not be used with the if (flg) or if (!flg) syntax. 474 475 .seealso: `PETSC_TRUE`, `PETSC_FALSE`, `PetscNot()`, `PETSC_BOOL3_TRUE`, `PETSC_BOOL3_FALSE`, `PETSC_BOOL3_UNKNOWN` 476 E*/ 477 typedef enum { 478 PETSC_BOOL3_FALSE = 0, 479 PETSC_BOOL3_TRUE = 1, 480 PETSC_BOOL3_UNKNOWN = -1 /* the value is unknown at the time of query, but might be determined later */ 481 } PetscBool3; 482 PETSC_EXTERN const char *const PetscBool3s[]; 483 484 #define PetscBool3ToBool(a) ((a) == PETSC_BOOL3_TRUE ? PETSC_TRUE : PETSC_FALSE) 485 #define PetscBoolToBool3(a) ((a) == PETSC_TRUE ? PETSC_BOOL3_TRUE : PETSC_BOOL3_FALSE) 486 487 /*MC 488 PetscReal - PETSc type that represents a real number version of `PetscScalar` 489 490 Level: beginner 491 492 Notes: 493 For MPI calls that require datatypes, use `MPIU_REAL` as the datatype for `PetscReal` and `MPIU_SUM`, `MPIU_MAX`, etc. for operations. 494 They will automatically work correctly regardless of the size of `PetscReal`. 495 496 See `PetscScalar` for details on how to ./configure the size of `PetscReal`. 497 498 .seealso: `PetscScalar`, `PetscComplex`, `PetscInt`, `MPIU_REAL`, `MPIU_SCALAR`, `MPIU_COMPLEX`, `MPIU_INT` 499 M*/ 500 501 #if defined(PETSC_USE_REAL_SINGLE) 502 typedef float PetscReal; 503 #elif defined(PETSC_USE_REAL_DOUBLE) 504 typedef double PetscReal; 505 #elif defined(PETSC_USE_REAL___FLOAT128) 506 #if defined(__cplusplus) 507 extern "C" { 508 #endif 509 #include <quadmath.h> 510 #if defined(__cplusplus) 511 } 512 #endif 513 typedef __float128 PetscReal; 514 #elif defined(PETSC_USE_REAL___FP16) 515 typedef __fp16 PetscReal; 516 #endif /* PETSC_USE_REAL_* */ 517 518 /*MC 519 PetscComplex - PETSc type that represents a complex number with precision matching that of `PetscReal`. 520 521 Synopsis: 522 #include <petscsys.h> 523 PetscComplex number = 1. + 2.*PETSC_i; 524 525 Level: beginner 526 527 Notes: 528 For MPI calls that require datatypes, use `MPIU_COMPLEX` as the datatype for `PetscComplex` and `MPIU_SUM` etc for operations. 529 They will automatically work correctly regardless of the size of `PetscComplex`. 530 531 See `PetscScalar` for details on how to ./configure the size of `PetscReal` 532 533 Complex numbers are automatically available if PETSc was able to find a working complex implementation 534 535 PETSc has a 'fix' for complex numbers to support expressions such as `std::complex<PetscReal>` + `PetscInt`, which are not supported by the standard 536 C++ library, but are convenient for PETSc users. If the C++ compiler is able to compile code in `petsccxxcomplexfix.h` (This is checked by 537 configure), we include `petsccxxcomplexfix.h` to provide this convenience. 538 539 If the fix causes conflicts, or one really does not want this fix for a particular C++ file, one can define `PETSC_SKIP_CXX_COMPLEX_FIX` 540 at the beginning of the C++ file to skip the fix. 541 542 .seealso: `PetscReal`, `PetscScalar`, `PetscComplex`, `PetscInt`, `MPIU_REAL`, `MPIU_SCALAR`, `MPIU_COMPLEX`, `MPIU_INT`, `PETSC_i` 543 M*/ 544 #if !defined(PETSC_SKIP_COMPLEX) 545 #if defined(PETSC_CLANGUAGE_CXX) 546 #if !defined(PETSC_USE_REAL___FP16) && !defined(PETSC_USE_REAL___FLOAT128) 547 #if defined(__cplusplus) && defined(PETSC_HAVE_CXX_COMPLEX) /* enable complex for library code */ 548 #define PETSC_HAVE_COMPLEX 1 549 #elif !defined(__cplusplus) && defined(PETSC_HAVE_C99_COMPLEX) && defined(PETSC_HAVE_CXX_COMPLEX) /* User code only - conditional on library code complex support */ 550 #define PETSC_HAVE_COMPLEX 1 551 #endif 552 #elif defined(PETSC_USE_REAL___FLOAT128) && defined(PETSC_HAVE_C99_COMPLEX) 553 #define PETSC_HAVE_COMPLEX 1 554 #endif 555 #else /* !PETSC_CLANGUAGE_CXX */ 556 #if !defined(PETSC_USE_REAL___FP16) 557 #if !defined(__cplusplus) && defined(PETSC_HAVE_C99_COMPLEX) /* enable complex for library code */ 558 #define PETSC_HAVE_COMPLEX 1 559 #elif defined(__cplusplus) && defined(PETSC_HAVE_C99_COMPLEX) && defined(PETSC_HAVE_CXX_COMPLEX) /* User code only - conditional on library code complex support */ 560 #define PETSC_HAVE_COMPLEX 1 561 #endif 562 #endif 563 #endif /* PETSC_CLANGUAGE_CXX */ 564 #endif /* !PETSC_SKIP_COMPLEX */ 565 566 #if defined(PETSC_HAVE_COMPLEX) 567 #if defined(__cplusplus) /* C++ complex support */ 568 /* Locate a C++ complex template library */ 569 #if defined(PETSC_DESIRE_KOKKOS_COMPLEX) /* Defined in petscvec_kokkos.hpp for *.kokkos.cxx files */ 570 #define petsccomplexlib Kokkos 571 #include <Kokkos_Complex.hpp> 572 #elif (defined(__CUDACC__) && defined(PETSC_HAVE_CUDA)) || (defined(__HIPCC__) && defined(PETSC_HAVE_HIP)) 573 #define petsccomplexlib thrust 574 #include <thrust/complex.h> 575 #elif defined(PETSC_USE_REAL___FLOAT128) 576 #include <complex.h> 577 #else 578 #define petsccomplexlib std 579 #include <complex> 580 #endif 581 582 /* Define PetscComplex based on the precision */ 583 #if defined(PETSC_USE_REAL_SINGLE) 584 typedef petsccomplexlib::complex<float> PetscComplex; 585 #elif defined(PETSC_USE_REAL_DOUBLE) 586 typedef petsccomplexlib::complex<double> PetscComplex; 587 #elif defined(PETSC_USE_REAL___FLOAT128) 588 typedef __complex128 PetscComplex; 589 #endif 590 591 /* Include a PETSc C++ complex 'fix'. Check PetscComplex manual page for details */ 592 #if defined(PETSC_HAVE_CXX_COMPLEX_FIX) && !defined(PETSC_SKIP_CXX_COMPLEX_FIX) 593 #include <petsccxxcomplexfix.h> 594 #endif 595 #else /* c99 complex support */ 596 #include <complex.h> 597 #if defined(PETSC_USE_REAL_SINGLE) || defined(PETSC_USE_REAL___FP16) 598 typedef float _Complex PetscComplex; 599 #elif defined(PETSC_USE_REAL_DOUBLE) 600 typedef double _Complex PetscComplex; 601 #elif defined(PETSC_USE_REAL___FLOAT128) 602 typedef __complex128 PetscComplex; 603 #endif /* PETSC_USE_REAL_* */ 604 #endif /* !__cplusplus */ 605 #endif /* PETSC_HAVE_COMPLEX */ 606 607 /*MC 608 PetscScalar - PETSc type that represents either a double precision real number, a double precision 609 complex number, a single precision real number, a __float128 real or complex or a __fp16 real - if the code is configured 610 with `--with-scalar-type`=real,complex `--with-precision`=single,double,__float128,__fp16 611 612 Level: beginner 613 614 Note: 615 For MPI calls that require datatypes, use `MPIU_SCALAR` as the datatype for `PetscScalar` and `MPIU_SUM`, etc for operations. They will automatically work correctly regardless of the size of `PetscScalar`. 616 617 .seealso: `PetscReal`, `PetscComplex`, `PetscInt`, `MPIU_REAL`, `MPIU_SCALAR`, `MPIU_COMPLEX`, `MPIU_INT`, `PetscRealPart()`, `PetscImaginaryPart()` 618 M*/ 619 620 #if defined(PETSC_USE_COMPLEX) && defined(PETSC_HAVE_COMPLEX) 621 typedef PetscComplex PetscScalar; 622 #else /* PETSC_USE_COMPLEX */ 623 typedef PetscReal PetscScalar; 624 #endif /* PETSC_USE_COMPLEX */ 625 626 /*E 627 PetscCopyMode - Determines how an array or `PetscObject` passed to certain functions is copied or retained by the aggregate `PetscObject` 628 629 Values for array input: 630 + `PETSC_COPY_VALUES` - the array values are copied into new space, the user is free to reuse or delete the passed in array 631 . `PETSC_OWN_POINTER` - the array values are NOT copied, the object takes ownership of the array and will free it later, the user cannot change or 632 delete the array. The array MUST have been obtained with `PetscMalloc()`. Hence this mode cannot be used in Fortran. 633 - `PETSC_USE_POINTER` - the array values are NOT copied, the object uses the array but does NOT take ownership of the array. The user cannot use 634 the array but the user must delete the array after the object is destroyed. 635 636 Values for PetscObject: 637 + `PETSC_COPY_VALUES` - the input `PetscObject` is cloned into the aggregate `PetscObject`; the user is free to reuse/modify the input `PetscObject` without side effects. 638 . `PETSC_OWN_POINTER` - the input `PetscObject` is referenced by pointer (with reference count), thus should not be modified by the user. 639 increases its reference count). 640 - `PETSC_USE_POINTER` - invalid for `PetscObject` inputs. 641 642 Level: beginner 643 644 .seealso: `InsertMode` 645 E*/ 646 typedef enum { 647 PETSC_COPY_VALUES, 648 PETSC_OWN_POINTER, 649 PETSC_USE_POINTER 650 } PetscCopyMode; 651 PETSC_EXTERN const char *const PetscCopyModes[]; 652 653 /*MC 654 PETSC_FALSE - False value of `PetscBool` 655 656 Level: beginner 657 658 Note: 659 Zero integer 660 661 .seealso: `PetscBool`, `PetscBool3`, `PETSC_TRUE` 662 M*/ 663 664 /*MC 665 PETSC_TRUE - True value of `PetscBool` 666 667 Level: beginner 668 669 Note: 670 Nonzero integer 671 672 .seealso: `PetscBool`, `PetscBool3`, `PETSC_FALSE` 673 M*/ 674 675 /*MC 676 PetscLogDouble - Used for logging times 677 678 Level: developer 679 680 Note: 681 Contains double precision numbers that are not used in the numerical computations, but rather in logging, timing etc. 682 683 .seealso: `PetscBool`, `PetscDataType` 684 M*/ 685 typedef double PetscLogDouble; 686 687 /*E 688 PetscDataType - Used for handling different basic data types. 689 690 Level: beginner 691 692 Notes: 693 Use of this should be avoided if one can directly use `MPI_Datatype` instead. 694 695 `PETSC_INT` is the datatype for a `PetscInt`, regardless of whether it is 4 or 8 bytes. 696 `PETSC_REAL`, `PETSC_COMPLEX` and `PETSC_SCALAR` are the datatypes for `PetscReal`, `PetscComplex` and `PetscScalar`, regardless of their sizes. 697 698 Developer Notes: 699 It would be nice if we could always just use MPI Datatypes, why can we not? 700 701 If you change any values in `PetscDatatype` make sure you update their usage in 702 share/petsc/matlab/PetscBagRead.m and share/petsc/matlab/@PetscOpenSocket/read/write.m 703 704 TODO: 705 Remove use of improper `PETSC_ENUM` 706 707 .seealso: `PetscBinaryRead()`, `PetscBinaryWrite()`, `PetscDataTypeToMPIDataType()`, 708 `PetscDataTypeGetSize()` 709 E*/ 710 typedef enum { 711 PETSC_DATATYPE_UNKNOWN = 0, 712 PETSC_DOUBLE = 1, 713 PETSC_COMPLEX = 2, 714 PETSC_LONG = 3, 715 PETSC_SHORT = 4, 716 PETSC_FLOAT = 5, 717 PETSC_CHAR = 6, 718 PETSC_BIT_LOGICAL = 7, 719 PETSC_ENUM = 8, 720 PETSC_BOOL = 9, 721 PETSC___FLOAT128 = 10, 722 PETSC_OBJECT = 11, 723 PETSC_FUNCTION = 12, 724 PETSC_STRING = 13, 725 PETSC___FP16 = 14, 726 PETSC_STRUCT = 15, 727 PETSC_INT = 16, 728 PETSC_INT64 = 17, 729 PETSC_COUNT = 18, 730 PETSC_INT32 = 19, 731 } PetscDataType; 732 PETSC_EXTERN const char *const PetscDataTypes[]; 733 734 #if defined(PETSC_USE_REAL_SINGLE) 735 #define PETSC_REAL PETSC_FLOAT 736 #elif defined(PETSC_USE_REAL_DOUBLE) 737 #define PETSC_REAL PETSC_DOUBLE 738 #elif defined(PETSC_USE_REAL___FLOAT128) 739 #define PETSC_REAL PETSC___FLOAT128 740 #elif defined(PETSC_USE_REAL___FP16) 741 #define PETSC_REAL PETSC___FP16 742 #else 743 #define PETSC_REAL PETSC_DOUBLE 744 #endif 745 746 #if defined(PETSC_USE_COMPLEX) 747 #define PETSC_SCALAR PETSC_COMPLEX 748 #else 749 #define PETSC_SCALAR PETSC_REAL 750 #endif 751 752 #define PETSC_FORTRANADDR PETSC_LONG 753 754 /*S 755 PetscToken - 'Token' used for managing tokenizing strings 756 757 Level: intermediate 758 759 .seealso: `PetscTokenCreate()`, `PetscTokenFind()`, `PetscTokenDestroy()` 760 S*/ 761 typedef struct _n_PetscToken *PetscToken; 762 763 /*S 764 PetscObject - any PETSc object, for example: `PetscViewer`, `Mat`, `Vec`, `KSP`, `DM` 765 766 Level: beginner 767 768 Notes: 769 This is the base class from which all PETSc objects are derived. 770 771 In certain situations one can cast an object, for example a `Vec`, to a `PetscObject` with (`PetscObject`)vec 772 773 .seealso: `PetscObjectDestroy()`, `PetscObjectView()`, `PetscObjectGetName()`, `PetscObjectSetName()`, `PetscObjectReference()`, `PetscObjectDereference()` 774 S*/ 775 typedef struct _p_PetscObject *PetscObject; 776 777 /*MC 778 PetscObjectId - unique integer Id for a `PetscObject` 779 780 Level: developer 781 782 Note: 783 Unlike pointer values, object ids are never reused so one may save a `PetscObjectId` and compare it to one obtained later from a `PetscObject` to determine 784 if the objects are the same. Never compare two object pointer values. 785 786 .seealso: `PetscObjectState`, `PetscObjectGetId()` 787 M*/ 788 typedef PetscInt64 PetscObjectId; 789 790 /*MC 791 PetscObjectState - integer state for a `PetscObject` 792 793 Level: developer 794 795 Note: 796 Object state is always-increasing and (for objects that track state) can be used to determine if an object has 797 changed since the last time you interacted with it. It is 64-bit so that it will not overflow for a very long time. 798 799 .seealso: `PetscObjectId`, `PetscObjectStateGet()`, `PetscObjectStateIncrease()`, `PetscObjectStateSet()` 800 M*/ 801 typedef PetscInt64 PetscObjectState; 802 803 /*S 804 PetscFunctionList - Linked list of functions, possibly stored in dynamic libraries, accessed 805 by string name 806 807 Level: advanced 808 809 .seealso: `PetscFunctionListAdd()`, `PetscFunctionListDestroy()` 810 S*/ 811 typedef struct _n_PetscFunctionList *PetscFunctionList; 812 813 /*E 814 PetscFileMode - Access mode for a file. 815 816 Values: 817 + `FILE_MODE_UNDEFINED` - initial invalid value 818 . `FILE_MODE_READ` - open a file at its beginning for reading 819 . `FILE_MODE_WRITE` - open a file at its beginning for writing (will create if the file does not exist) 820 . `FILE_MODE_APPEND` - open a file at end for writing 821 . `FILE_MODE_UPDATE` - open a file for updating, meaning for reading and writing 822 - `FILE_MODE_APPEND_UPDATE` - open a file for updating, meaning for reading and writing, at the end 823 824 Level: beginner 825 826 .seealso: `PetscViewerFileSetMode()` 827 E*/ 828 typedef enum { 829 FILE_MODE_UNDEFINED = -1, 830 FILE_MODE_READ = 0, 831 FILE_MODE_WRITE = 1, 832 FILE_MODE_APPEND = 2, 833 FILE_MODE_UPDATE = 3, 834 FILE_MODE_APPEND_UPDATE = 4 835 } PetscFileMode; 836 PETSC_EXTERN const char *const PetscFileModes[]; 837 838 typedef void *PetscDLHandle; 839 typedef enum { 840 PETSC_DL_DECIDE = 0, 841 PETSC_DL_NOW = 1, 842 PETSC_DL_LOCAL = 2 843 } PetscDLMode; 844 845 /*S 846 PetscObjectList - Linked list of PETSc objects, each accessible by string name 847 848 Level: developer 849 850 Note: 851 Used by `PetscObjectCompose()` and `PetscObjectQuery()` 852 853 .seealso: `PetscObjectListAdd()`, `PetscObjectListDestroy()`, `PetscObjectListFind()`, `PetscObjectCompose()`, `PetscObjectQuery()`, `PetscFunctionList` 854 S*/ 855 typedef struct _n_PetscObjectList *PetscObjectList; 856 857 /*S 858 PetscDLLibrary - Linked list of dynamic libraries to search for functions 859 860 Level: developer 861 862 .seealso: `PetscDLLibraryOpen()` 863 S*/ 864 typedef struct _n_PetscDLLibrary *PetscDLLibrary; 865 866 /*S 867 PetscContainer - Simple PETSc object that contains a pointer to any required data 868 869 Level: advanced 870 871 Note: 872 This is useful to attach arbitrary data to a `PetscObject` with `PetscObjectCompose()` and `PetscObjectQuery()` 873 874 .seealso: `PetscObject`, `PetscContainerCreate()`, `PetscObjectCompose()`, `PetscObjectQuery()` 875 S*/ 876 typedef struct _p_PetscContainer *PetscContainer; 877 878 /*S 879 PetscRandom - Abstract PETSc object that manages generating random numbers 880 881 Level: intermediate 882 883 .seealso: `PetscRandomCreate()`, `PetscRandomGetValue()`, `PetscRandomType` 884 S*/ 885 typedef struct _p_PetscRandom *PetscRandom; 886 887 /* 888 In binary files variables are stored using the following lengths, 889 regardless of how they are stored in memory on any one particular 890 machine. Use these rather than sizeof() in computing sizes for 891 PetscBinarySeek(). 892 */ 893 #define PETSC_BINARY_INT_SIZE (32 / 8) 894 #define PETSC_BINARY_FLOAT_SIZE (32 / 8) 895 #define PETSC_BINARY_CHAR_SIZE (8 / 8) 896 #define PETSC_BINARY_SHORT_SIZE (16 / 8) 897 #define PETSC_BINARY_DOUBLE_SIZE (64 / 8) 898 #define PETSC_BINARY_SCALAR_SIZE sizeof(PetscScalar) 899 900 /*E 901 PetscBinarySeekType - argument to `PetscBinarySeek()` 902 903 Values: 904 + `PETSC_BINARY_SEEK_SET` - offset is an absolute location in the file 905 . `PETSC_BINARY_SEEK_CUR` - offset is an offset from the current location of the file pointer 906 - `PETSC_BINARY_SEEK_END` - offset is an offset from the end of the file 907 908 Level: advanced 909 910 .seealso: `PetscBinarySeek()`, `PetscBinarySynchronizedSeek()` 911 E*/ 912 typedef enum { 913 PETSC_BINARY_SEEK_SET = 0, 914 PETSC_BINARY_SEEK_CUR = 1, 915 PETSC_BINARY_SEEK_END = 2 916 } PetscBinarySeekType; 917 918 /*E 919 PetscBuildTwoSidedType - algorithm for setting up two-sided communication for use with `PetscSF` 920 921 Values: 922 + `PETSC_BUILDTWOSIDED_ALLREDUCE` - classical algorithm using an `MPI_Allreduce()` with 923 a buffer of length equal to the communicator size. Not memory-scalable due to 924 the large reduction size. Requires only an MPI-1 implementation. 925 . `PETSC_BUILDTWOSIDED_IBARRIER` - nonblocking algorithm based on `MPI_Issend()` and `MPI_Ibarrier()`. 926 Proved communication-optimal in Hoefler, Siebert, and Lumsdaine (2010). Requires an MPI-3 implementation. 927 - `PETSC_BUILDTWOSIDED_REDSCATTER` - similar to above, but use more optimized function 928 that only communicates the part of the reduction that is necessary. Requires an MPI-2 implementation. 929 930 Level: developer 931 932 .seealso: `PetscCommBuildTwoSided()`, `PetscCommBuildTwoSidedSetType()`, `PetscCommBuildTwoSidedGetType()` 933 E*/ 934 typedef enum { 935 PETSC_BUILDTWOSIDED_NOTSET = -1, 936 PETSC_BUILDTWOSIDED_ALLREDUCE = 0, 937 PETSC_BUILDTWOSIDED_IBARRIER = 1, 938 PETSC_BUILDTWOSIDED_REDSCATTER = 2 939 /* Updates here must be accompanied by updates in finclude/petscsys.h and the string array in mpits.c */ 940 } PetscBuildTwoSidedType; 941 PETSC_EXTERN const char *const PetscBuildTwoSidedTypes[]; 942 943 /*E 944 InsertMode - How the entries are combined with the current values in the vectors or matrices 945 946 Values: 947 + `NOT_SET_VALUES` - do not actually use the values 948 . `INSERT_VALUES` - replace the current values with the provided values, unless the index is marked as constrained by the `PetscSection` 949 . `ADD_VALUES` - add the values to the current values, unless the index is marked as constrained by the `PetscSection` 950 . `MAX_VALUES` - use the maximum of each current value and provided value 951 . `MIN_VALUES` - use the minimum of each current value and provided value 952 . `INSERT_ALL_VALUES` - insert, even if indices that are not marked as constrained by the `PetscSection` 953 . `ADD_ALL_VALUES` - add, even if indices that are not marked as constrained by the `PetscSection` 954 . `INSERT_BC_VALUES` - insert, but ignore indices that are not marked as constrained by the `PetscSection` 955 - `ADD_BC_VALUES` - add, but ignore indices that are not marked as constrained by the `PetscSection` 956 957 Level: beginner 958 959 Note: 960 The `PetscSection` that determines the effects of the `InsertMode` values can be obtained by the `Vec` object with `VecGetDM()` 961 and `DMGetLocalSection()`. 962 963 Not all options are supported for all operations or PETSc object types. 964 965 .seealso: `VecSetValues()`, `MatSetValues()`, `VecSetValue()`, `VecSetValuesBlocked()`, 966 `VecSetValuesLocal()`, `VecSetValuesBlockedLocal()`, `MatSetValuesBlocked()`, 967 `MatSetValuesBlockedLocal()`, `MatSetValuesLocal()`, `VecScatterBegin()`, `VecScatterEnd()` 968 E*/ 969 typedef enum { 970 NOT_SET_VALUES, 971 INSERT_VALUES, 972 ADD_VALUES, 973 MAX_VALUES, 974 MIN_VALUES, 975 INSERT_ALL_VALUES, 976 ADD_ALL_VALUES, 977 INSERT_BC_VALUES, 978 ADD_BC_VALUES 979 } InsertMode; 980 981 /*MC 982 INSERT_VALUES - Put a value into a vector or matrix, overwrites any previous value 983 984 Level: beginner 985 986 .seealso: `InsertMode`, `VecSetValues()`, `MatSetValues()`, `VecSetValue()`, `VecSetValuesBlocked()`, 987 `VecSetValuesLocal()`, `VecSetValuesBlockedLocal()`, `MatSetValuesBlocked()`, `ADD_VALUES`, 988 `MatSetValuesBlockedLocal()`, `MatSetValuesLocal()`, `VecScatterBegin()`, `VecScatterEnd()`, `MAX_VALUES` 989 M*/ 990 991 /*MC 992 ADD_VALUES - Adds a value into a vector or matrix, if there previously was no value, just puts the 993 value into that location 994 995 Level: beginner 996 997 .seealso: `InsertMode`, `VecSetValues()`, `MatSetValues()`, `VecSetValue()`, `VecSetValuesBlocked()`, 998 `VecSetValuesLocal()`, `VecSetValuesBlockedLocal()`, `MatSetValuesBlocked()`, `INSERT_VALUES`, 999 `MatSetValuesBlockedLocal()`, `MatSetValuesLocal()`, `VecScatterBegin()`, `VecScatterEnd()`, `MAX_VALUES` 1000 M*/ 1001 1002 /*MC 1003 MAX_VALUES - Puts the maximum of the scattered/gathered value and the current value into each location 1004 1005 Level: beginner 1006 1007 .seealso: `InsertMode`, `VecScatterBegin()`, `VecScatterEnd()`, `ADD_VALUES`, `INSERT_VALUES` 1008 M*/ 1009 1010 /*MC 1011 MIN_VALUES - Puts the minimal of the scattered/gathered value and the current value into each location 1012 1013 Level: beginner 1014 1015 .seealso: `InsertMode`, `VecScatterBegin()`, `VecScatterEnd()`, `ADD_VALUES`, `INSERT_VALUES` 1016 M*/ 1017 1018 /*S 1019 PetscSubcomm - A decomposition of an MPI communicator into subcommunicators 1020 1021 Values: 1022 + `PETSC_SUBCOMM_GENERAL` - similar to `MPI_Comm_split()` each process sets the new communicator (color) they will belong to and the order within that communicator 1023 . `PETSC_SUBCOMM_CONTIGUOUS` - each new communicator contains a set of process with contiguous ranks in the original MPI communicator 1024 - `PETSC_SUBCOMM_INTERLACED` - each new communictor contains a set of processes equally far apart in rank from the others in that new communicator 1025 1026 Sample Usage: 1027 .vb 1028 PetscSubcommCreate() 1029 PetscSubcommSetNumber() 1030 PetscSubcommSetType(PETSC_SUBCOMM_INTERLACED); 1031 ccomm = PetscSubcommChild() 1032 PetscSubcommDestroy() 1033 .ve 1034 1035 Example: 1036 Consider a communicator with six processes split into 3 subcommunicators. 1037 .vb 1038 PETSC_SUBCOMM_CONTIGUOUS - the first communicator contains rank 0,1 the second rank 2,3 and the third rank 4,5 in the original ordering of the original communicator 1039 PETSC_SUBCOMM_INTERLACED - the first communicator contains rank 0,3, the second 1,4 and the third 2,5 1040 .ve 1041 1042 Level: advanced 1043 1044 Note: 1045 After a call to `PetscSubcommSetType()`, `PetscSubcommSetTypeGeneral()`, or `PetscSubcommSetFromOptions()` one may call 1046 .vb 1047 PetscSubcommChild() returns the associated subcommunicator on this process 1048 PetscSubcommContiguousParent() returns a parent communitor but with all child of the same subcommunicator having contiguous rank 1049 .ve 1050 1051 Developer Note: 1052 This is used in objects such as `PCREDUNDANT` to manage the subcommunicators on which the redundant computations 1053 are performed. 1054 1055 .seealso: `PetscSubcommCreate()`, `PetscSubcommSetNumber()`, `PetscSubcommSetType()`, `PetscSubcommView()`, `PetscSubcommSetFromOptions()` 1056 S*/ 1057 typedef struct _n_PetscSubcomm *PetscSubcomm; 1058 typedef enum { 1059 PETSC_SUBCOMM_GENERAL = 0, 1060 PETSC_SUBCOMM_CONTIGUOUS = 1, 1061 PETSC_SUBCOMM_INTERLACED = 2 1062 } PetscSubcommType; 1063 PETSC_EXTERN const char *const PetscSubcommTypes[]; 1064 1065 /*S 1066 PetscHeap - A simple class for managing heaps 1067 1068 Level: intermediate 1069 1070 .seealso: `PetscHeapCreate()`, `PetscHeapAdd()`, `PetscHeapPop()`, `PetscHeapPeek()`, `PetscHeapStash()`, `PetscHeapUnstash()`, `PetscHeapView()`, `PetscHeapDestroy()` 1071 S*/ 1072 typedef struct _n_PetscHeap *PetscHeap; 1073 1074 typedef struct _n_PetscShmComm *PetscShmComm; 1075 typedef struct _n_PetscOmpCtrl *PetscOmpCtrl; 1076 1077 /*S 1078 PetscSegBuffer - a segmented extendable buffer 1079 1080 Level: developer 1081 1082 .seealso: `PetscSegBufferCreate()`, `PetscSegBufferGet()`, `PetscSegBufferExtract()`, `PetscSegBufferDestroy()` 1083 S*/ 1084 typedef struct _n_PetscSegBuffer *PetscSegBuffer; 1085 1086 typedef struct _n_PetscOptionsHelpPrinted *PetscOptionsHelpPrinted; 1087 1088 /*S 1089 PetscByte - datatype used to represent bytes 1090 1091 Level: intermediate 1092 1093 .seealso: `PetscBT` 1094 S*/ 1095 typedef unsigned char PetscByte; 1096 1097 /*S 1098 PetscBT - PETSc bitarrays, efficient storage of arrays of boolean values 1099 1100 Level: advanced 1101 1102 Notes: 1103 The following routines do not have their own manual pages 1104 1105 .vb 1106 PetscBTCreate(m,&bt) - creates a bit array with enough room to hold m values 1107 PetscBTDestroy(&bt) - destroys the bit array 1108 PetscBTMemzero(m,bt) - zeros the entire bit array (sets all values to false) 1109 PetscBTSet(bt,index) - sets a particular entry as true 1110 PetscBTClear(bt,index) - sets a particular entry as false 1111 PetscBTLookup(bt,index) - returns the value 1112 PetscBTLookupSet(bt,index) - returns the value and then sets it true 1113 PetscBTLookupClear(bt,index) - returns the value and then sets it false 1114 PetscBTLength(m) - returns number of bytes in array with m bits 1115 PetscBTView(m,bt,viewer) - prints all the entries in a bit array 1116 .ve 1117 1118 PETSc does not check error flags on `PetscBTLookup()`, `PetscBTLookupSet()`, `PetscBTLength()` because error checking 1119 would cost hundreds more cycles then the operation. 1120 1121 S*/ 1122 typedef PetscByte *PetscBT; 1123 1124 /* The number of bits in a byte */ 1125 #define PETSC_BITS_PER_BYTE CHAR_BIT 1126