1 /* 2 This is the main PETSc include file (for C and C++). It is included by all 3 other PETSc include files, so it almost never has to be specifically included. 4 Portions of this code are under: 5 Copyright (c) 2022 Advanced Micro Devices, Inc. All rights reserved. 6 */ 7 #ifndef PETSCSYS_H 8 #define PETSCSYS_H 9 10 /* ========================================================================== */ 11 /* 12 petscconf.h is contained in ${PETSC_ARCH}/include/petscconf.h it is 13 found automatically by the compiler due to the -I${PETSC_DIR}/${PETSC_ARCH}/include that 14 PETSc's makefiles add to the compiler rules. 15 For --prefix installs the directory ${PETSC_ARCH} does not exist and petscconf.h is in the same 16 directory as the other PETSc include files. 17 */ 18 #include <petscconf.h> 19 #include <petscconf_poison.h> 20 #include <petscfix.h> 21 #include <petscmacros.h> 22 23 /* SUBMANSEC = Sys */ 24 25 #if defined(PETSC_DESIRE_FEATURE_TEST_MACROS) 26 /* 27 Feature test macros must be included before headers defined by IEEE Std 1003.1-2001 28 We only turn these in PETSc source files that require them by setting PETSC_DESIRE_FEATURE_TEST_MACROS 29 */ 30 #if defined(PETSC__POSIX_C_SOURCE_200112L) && !defined(_POSIX_C_SOURCE) 31 #define _POSIX_C_SOURCE 200112L 32 #endif 33 #if defined(PETSC__BSD_SOURCE) && !defined(_BSD_SOURCE) 34 #define _BSD_SOURCE 35 #endif 36 #if defined(PETSC__DEFAULT_SOURCE) && !defined(_DEFAULT_SOURCE) 37 #define _DEFAULT_SOURCE 38 #endif 39 #if defined(PETSC__GNU_SOURCE) && !defined(_GNU_SOURCE) 40 #define _GNU_SOURCE 41 #endif 42 #endif 43 44 #include <petscsystypes.h> 45 46 /* ========================================================================== */ 47 48 /* 49 Defines the interface to MPI allowing the use of all MPI functions. 50 51 PETSc does not use the C++ binding of MPI at ALL. The following flag 52 makes sure the C++ bindings are not included. The C++ bindings REQUIRE 53 putting mpi.h before ANY C++ include files, we cannot control this 54 with all PETSc users. Users who want to use the MPI C++ bindings can include 55 mpicxx.h directly in their code 56 */ 57 #if !defined(MPICH_SKIP_MPICXX) 58 #define MPICH_SKIP_MPICXX 1 59 #endif 60 #if !defined(OMPI_SKIP_MPICXX) 61 #define OMPI_SKIP_MPICXX 1 62 #endif 63 #if defined(PETSC_HAVE_MPIUNI) 64 #include <petsc/mpiuni/mpi.h> 65 #else 66 #include <mpi.h> 67 #endif 68 69 /* 70 Perform various sanity checks that the correct mpi.h is being included at compile time. 71 This usually happens because 72 * either an unexpected mpi.h is in the default compiler path (i.e. in /usr/include) or 73 * an extra include path -I/something (which contains the unexpected mpi.h) is being passed to the compiler 74 */ 75 #if defined(PETSC_HAVE_MPIUNI) 76 #ifndef MPIUNI_H 77 #error "PETSc was configured with --with-mpi=0 but now appears to be compiling using a different mpi.h" 78 #endif 79 #elif defined(PETSC_HAVE_I_MPI_NUMVERSION) 80 #if !defined(I_MPI_NUMVERSION) 81 #error "PETSc was configured with I_MPI but now appears to be compiling using a non-I_MPI mpi.h" 82 #elif I_MPI_NUMVERSION != PETSC_HAVE_I_MPI_NUMVERSION 83 #error "PETSc was configured with one I_MPI mpi.h version but now appears to be compiling using a different I_MPI mpi.h version" 84 #endif 85 #elif defined(PETSC_HAVE_MVAPICH2_NUMVERSION) 86 #if !defined(MVAPICH2_NUMVERSION) 87 #error "PETSc was configured with MVAPICH2 but now appears to be compiling using a non-MVAPICH2 mpi.h" 88 #elif MVAPICH2_NUMVERSION != PETSC_HAVE_MVAPICH2_NUMVERSION 89 #error "PETSc was configured with one MVAPICH2 mpi.h version but now appears to be compiling using a different MVAPICH2 mpi.h version" 90 #endif 91 #elif defined(PETSC_HAVE_MPICH_NUMVERSION) 92 #if !defined(MPICH_NUMVERSION) || defined(MVAPICH2_NUMVERSION) || defined(I_MPI_NUMVERSION) 93 #error "PETSc was configured with MPICH but now appears to be compiling using a non-MPICH mpi.h" 94 #elif (MPICH_NUMVERSION / 100000000 != PETSC_HAVE_MPICH_NUMVERSION / 100000000) || (MPICH_NUMVERSION / 100000 < PETSC_HAVE_MPICH_NUMVERSION / 100000) || (MPICH_NUMVERSION / 100000 == PETSC_HAVE_MPICH_NUMVERSION / 100000 && MPICH_NUMVERSION % 100000 / 1000 < PETSC_HAVE_MPICH_NUMVERSION % 100000 / 1000) 95 #error "PETSc was configured with one MPICH mpi.h version but now appears to be compiling using a different MPICH mpi.h version" 96 #endif 97 #elif defined(PETSC_HAVE_OMPI_MAJOR_VERSION) 98 #if !defined(OMPI_MAJOR_VERSION) 99 #error "PETSc was configured with OpenMPI but now appears to be compiling using a non-OpenMPI mpi.h" 100 #elif (OMPI_MAJOR_VERSION != PETSC_HAVE_OMPI_MAJOR_VERSION) || (OMPI_MINOR_VERSION < PETSC_HAVE_OMPI_MINOR_VERSION) || (OMPI_MINOR_VERSION == PETSC_HAVE_OMPI_MINOR_VERSION && OMPI_RELEASE_VERSION < PETSC_HAVE_OMPI_RELEASE_VERSION) 101 #error "PETSc was configured with one OpenMPI mpi.h version but now appears to be compiling using a different OpenMPI mpi.h version" 102 #endif 103 #define PETSC_MPI_COMM_FMT "p" 104 #define PETSC_MPI_WIN_FMT "p" 105 #elif defined(PETSC_HAVE_MSMPI_VERSION) 106 #if !defined(MSMPI_VER) 107 #error "PETSc was configured with MSMPI but now appears to be compiling using a non-MSMPI mpi.h" 108 #elif (MSMPI_VER != PETSC_HAVE_MSMPI_VERSION) 109 #error "PETSc was configured with one MSMPI mpi.h version but now appears to be compiling using a different MSMPI mpi.h version" 110 #endif 111 #elif defined(OMPI_MAJOR_VERSION) || defined(MPICH_NUMVERSION) || defined(MSMPI_VER) 112 #error "PETSc was configured with undetermined MPI - but now appears to be compiling using any of OpenMPI, MS-MPI or a MPICH variant" 113 #endif 114 115 /* Format specifier for printing MPI_Comm (most implementations use 'int' as type) */ 116 #if !defined(PETSC_MPI_COMM_FMT) 117 #define PETSC_MPI_COMM_FMT "d" 118 #endif 119 120 #if !defined(PETSC_MPI_WIN_FMT) 121 #define PETSC_MPI_WIN_FMT "d" 122 #endif 123 124 /* 125 Need to put stdio.h AFTER mpi.h for MPICH2 with C++ compiler 126 see the top of mpicxx.h in the MPICH2 distribution. 127 */ 128 #include <stdio.h> 129 130 /* MSMPI on 32bit windows requires this yukky hack - that breaks MPI standard compliance */ 131 #if !defined(MPIAPI) 132 #define MPIAPI 133 #endif 134 135 PETSC_EXTERN MPI_Datatype MPIU_ENUM PETSC_ATTRIBUTE_MPI_TYPE_TAG(PetscEnum); 136 PETSC_EXTERN MPI_Datatype MPIU_BOOL PETSC_ATTRIBUTE_MPI_TYPE_TAG(PetscBool); 137 138 /*MC 139 MPIU_INT - Portable MPI datatype corresponding to `PetscInt` independent of the precision of `PetscInt` 140 141 Notes: 142 In MPI calls that require an MPI datatype that matches a `PetscInt` or array of `PetscInt` values, pass this value. 143 144 Level: beginner 145 146 .seealso: `PetscReal`, `PetscScalar`, `PetscComplex`, `PetscInt`, `MPIU_REAL`, `MPIU_SCALAR`, `MPIU_COMPLEX` 147 M*/ 148 149 PETSC_EXTERN MPI_Datatype MPIU_FORTRANADDR; 150 151 #if defined(PETSC_USE_64BIT_INDICES) 152 #define MPIU_INT MPIU_INT64 153 #define PetscInt_FMT PetscInt64_FMT 154 #else 155 #define MPIU_INT MPI_INT 156 #define PetscInt_FMT "d" 157 #endif 158 159 /* 160 For the rare cases when one needs to send a size_t object with MPI 161 */ 162 PETSC_EXTERN MPI_Datatype MPIU_SIZE_T PETSC_ATTRIBUTE_MPI_TYPE_TAG(size_t); 163 164 /* 165 You can use PETSC_STDOUT as a replacement of stdout. You can also change 166 the value of PETSC_STDOUT to redirect all standard output elsewhere 167 */ 168 PETSC_EXTERN FILE *PETSC_STDOUT; 169 170 /* 171 You can use PETSC_STDERR as a replacement of stderr. You can also change 172 the value of PETSC_STDERR to redirect all standard error elsewhere 173 */ 174 PETSC_EXTERN FILE *PETSC_STDERR; 175 176 /* PetscPragmaSIMD - from CeedPragmaSIMD */ 177 178 #if defined(__NEC__) 179 #define PetscPragmaSIMD _Pragma("_NEC ivdep") 180 #elif defined(__INTEL_COMPILER) && !defined(_WIN32) 181 #define PetscPragmaSIMD _Pragma("vector") 182 #elif defined(__GNUC__) && __GNUC__ >= 5 && !defined(__PGI) 183 #define PetscPragmaSIMD _Pragma("GCC ivdep") 184 #elif defined(_OPENMP) && _OPENMP >= 201307 185 #if defined(_MSC_VER) 186 #define PetscPragmaSIMD __pragma(omp simd) 187 #else 188 #define PetscPragmaSIMD _Pragma("omp simd") 189 #endif 190 #elif defined(PETSC_HAVE_CRAY_VECTOR) 191 #define PetscPragmaSIMD _Pragma("_CRI ivdep") 192 #else 193 #define PetscPragmaSIMD 194 #endif 195 196 /* 197 Declare extern C stuff after including external header files 198 */ 199 200 PETSC_EXTERN const char *const PetscBools[]; 201 202 PETSC_EXTERN PetscBool PETSC_RUNNING_ON_VALGRIND; 203 /* 204 Defines elementary mathematics functions and constants. 205 */ 206 #include <petscmath.h> 207 208 PETSC_EXTERN const char *const PetscCopyModes[]; 209 210 /*MC 211 PETSC_IGNORE - same as NULL, means PETSc will ignore this argument 212 213 Level: beginner 214 215 Note: 216 Accepted by many PETSc functions to not set a parameter and instead use some default 217 218 Fortran Note: 219 This macro does not exist in Fortran; you must use `PETSC_NULL_INTEGER`, `PETSC_NULL_DOUBLE_PRECISION` etc 220 221 .seealso: `PETSC_DECIDE`, `PETSC_DEFAULT`, `PETSC_DETERMINE` 222 223 M*/ 224 #define PETSC_IGNORE NULL 225 226 /* This is deprecated */ 227 #define PETSC_NULL NULL 228 229 /*MC 230 PETSC_DECIDE - standard way of passing in integer or floating point parameter 231 where you wish PETSc to use the default. 232 233 Level: beginner 234 235 .seealso: `PETSC_DEFAULT`, `PETSC_IGNORE`, `PETSC_DETERMINE` 236 237 M*/ 238 #define PETSC_DECIDE -1 239 240 /*MC 241 PETSC_DETERMINE - standard way of passing in integer or floating point parameter 242 where you wish PETSc to compute the required value. 243 244 Level: beginner 245 246 Developer Note: 247 I would like to use const `PetscInt` `PETSC_DETERMINE` = `PETSC_DECIDE`; but for 248 some reason this is not allowed by the standard even though `PETSC_DECIDE` is a constant value. 249 250 .seealso: `PETSC_DECIDE`, `PETSC_DEFAULT`, `PETSC_IGNORE`, `VecSetSizes()` 251 252 M*/ 253 #define PETSC_DETERMINE PETSC_DECIDE 254 255 /*MC 256 PETSC_DEFAULT - standard way of passing in integer or floating point parameter 257 where you wish PETSc to use the default. 258 259 Level: beginner 260 261 Fortran Note: 262 You need to use `PETSC_DEFAULT_INTEGER` or `PETSC_DEFAULT_REAL`. 263 264 .seealso: `PETSC_DECIDE`, `PETSC_IGNORE`, `PETSC_DETERMINE` 265 266 M*/ 267 #define PETSC_DEFAULT -2 268 269 /*MC 270 PETSC_COMM_WORLD - the equivalent of the `MPI_COMM_WORLD` communicator which represents 271 all the processes that PETSc knows about. 272 273 Level: beginner 274 275 Notes: 276 By default `PETSC_COMM_WORLD` and `MPI_COMM_WORLD` are identical unless you wish to 277 run PETSc on ONLY a subset of `MPI_COMM_WORLD`. In that case create your new (smaller) 278 communicator, call it, say comm, and set `PETSC_COMM_WORLD` = comm BEFORE calling 279 PetscInitialize(), but after `MPI_Init()` has been called. 280 281 The value of `PETSC_COMM_WORLD` should never be USED/accessed before `PetscInitialize()` 282 is called because it may not have a valid value yet. 283 284 .seealso: `PETSC_COMM_SELF` 285 286 M*/ 287 PETSC_EXTERN MPI_Comm PETSC_COMM_WORLD; 288 289 /*MC 290 PETSC_COMM_SELF - This is always `MPI_COMM_SELF` 291 292 Level: beginner 293 294 Notes: 295 Do not USE/access or set this variable before PetscInitialize() has been called. 296 297 .seealso: `PETSC_COMM_WORLD` 298 299 M*/ 300 #define PETSC_COMM_SELF MPI_COMM_SELF 301 302 /*MC 303 PETSC_MPI_THREAD_REQUIRED - the required threading support used if PETSc initializes 304 MPI with `MPI_Init_thread()`. 305 306 Level: beginner 307 308 Notes: 309 By default `PETSC_MPI_THREAD_REQUIRED` equals `MPI_THREAD_FUNNELED`. 310 311 .seealso: `PetscInitialize()` 312 313 M*/ 314 PETSC_EXTERN PetscMPIInt PETSC_MPI_THREAD_REQUIRED; 315 316 PETSC_EXTERN PetscBool PetscBeganMPI; 317 PETSC_EXTERN PetscBool PetscErrorHandlingInitialized; 318 PETSC_EXTERN PetscBool PetscInitializeCalled; 319 PETSC_EXTERN PetscBool PetscFinalizeCalled; 320 PETSC_EXTERN PetscBool PetscViennaCLSynchronize; 321 322 PETSC_EXTERN PetscErrorCode PetscSetHelpVersionFunctions(PetscErrorCode (*)(MPI_Comm), PetscErrorCode (*)(MPI_Comm)); 323 PETSC_EXTERN PetscErrorCode PetscCommDuplicate(MPI_Comm, MPI_Comm *, int *); 324 PETSC_EXTERN PetscErrorCode PetscCommDestroy(MPI_Comm *); 325 PETSC_EXTERN PetscErrorCode PetscCommGetComm(MPI_Comm, MPI_Comm *); 326 PETSC_EXTERN PetscErrorCode PetscCommRestoreComm(MPI_Comm, MPI_Comm *); 327 328 #if defined(PETSC_HAVE_KOKKOS) 329 PETSC_EXTERN PetscErrorCode PetscKokkosInitializeCheck(void); /* Initialize Kokkos if not yet. */ 330 #endif 331 332 #if defined(PETSC_HAVE_NVSHMEM) 333 PETSC_EXTERN PetscBool PetscBeganNvshmem; 334 PETSC_EXTERN PetscBool PetscNvshmemInitialized; 335 PETSC_EXTERN PetscErrorCode PetscNvshmemFinalize(void); 336 #endif 337 338 #if defined(PETSC_HAVE_ELEMENTAL) 339 PETSC_EXTERN PetscErrorCode PetscElementalInitializePackage(void); 340 PETSC_EXTERN PetscErrorCode PetscElementalInitialized(PetscBool *); 341 PETSC_EXTERN PetscErrorCode PetscElementalFinalizePackage(void); 342 #endif 343 344 /*MC 345 PetscMalloc - Allocates memory, One should use `PetscNew()`, `PetscMalloc1()` or `PetscCalloc1()` usually instead of this 346 347 Synopsis: 348 #include <petscsys.h> 349 PetscErrorCode PetscMalloc(size_t m,void **result) 350 351 Not Collective 352 353 Input Parameter: 354 . m - number of bytes to allocate 355 356 Output Parameter: 357 . result - memory allocated 358 359 Level: beginner 360 361 Notes: 362 Memory is always allocated at least double aligned 363 364 It is safe to allocate size 0 and pass the resulting pointer (which may or may not be NULL) to `PetscFree()`. 365 366 .seealso: `PetscFree()`, `PetscNew()` 367 368 M*/ 369 #define PetscMalloc(a, b) ((*PetscTrMalloc)((a), PETSC_FALSE, __LINE__, PETSC_FUNCTION_NAME, __FILE__, (void **)(b))) 370 371 /*MC 372 PetscRealloc - Reallocates memory 373 374 Synopsis: 375 #include <petscsys.h> 376 PetscErrorCode PetscRealloc(size_t m,void **result) 377 378 Not Collective 379 380 Input Parameters: 381 + m - number of bytes to allocate 382 - result - previous memory 383 384 Output Parameter: 385 . result - new memory allocated 386 387 Level: developer 388 389 Notes: 390 Memory is always allocated at least double aligned 391 392 .seealso: `PetscMalloc()`, `PetscFree()`, `PetscNew()` 393 394 M*/ 395 #define PetscRealloc(a, b) ((*PetscTrRealloc)((a), __LINE__, PETSC_FUNCTION_NAME, __FILE__, (void **)(b))) 396 397 /*MC 398 PetscAddrAlign - Rounds up an address to `PETSC_MEMALIGN` alignment 399 400 Synopsis: 401 #include <petscsys.h> 402 void *PetscAddrAlign(void *addr) 403 404 Not Collective 405 406 Input Parameters: 407 . addr - address to align (any pointer type) 408 409 Level: developer 410 411 .seealso: `PetscMallocAlign()` 412 413 M*/ 414 #define PetscAddrAlign(a) (void *)((((PETSC_UINTPTR_T)(a)) + (PETSC_MEMALIGN - 1)) & ~(PETSC_MEMALIGN - 1)) 415 416 /*MC 417 PetscCalloc - Allocates a cleared (zeroed) memory region aligned to `PETSC_MEMALIGN` 418 419 Synopsis: 420 #include <petscsys.h> 421 PetscErrorCode PetscCalloc(size_t m,void **result) 422 423 Not Collective 424 425 Input Parameter: 426 . m - number of bytes to allocate 427 428 Output Parameter: 429 . result - memory allocated 430 431 Level: beginner 432 433 Notes: 434 Memory is always allocated at least double aligned. This macro is useful in allocating memory pointed by void pointers 435 436 It is safe to allocate size 0 and pass the resulting pointer (which may or may not be NULL) to PetscFree(). 437 438 .seealso: `PetscFree()`, `PetscNew()` 439 440 M*/ 441 #define PetscCalloc(m, result) PetscMallocA(1, PETSC_TRUE, __LINE__, PETSC_FUNCTION_NAME, __FILE__, (size_t)((size_t)m), (result)) 442 443 /*MC 444 PetscMalloc1 - Allocates an array of memory aligned to `PETSC_MEMALIGN` 445 446 Synopsis: 447 #include <petscsys.h> 448 PetscErrorCode PetscMalloc1(size_t m1,type **r1) 449 450 Not Collective 451 452 Input Parameter: 453 . m1 - number of elements to allocate (may be zero) 454 455 Output Parameter: 456 . r1 - memory allocated 457 458 Note: 459 This uses the sizeof() of the memory type requested to determine the total memory to be allocated, therefore you should not 460 multiply the number of elements requested by the `sizeof()` the type. For example use 461 $ PetscInt *id; 462 $ PetscMalloc1(10,&id); 463 not 464 $ PetscInt *id; 465 $ PetscMalloc1(10*sizeof(PetscInt),&id); 466 467 Does not zero the memory allocated, use `PetscCalloc1()` to obtain memory that has been zeroed. 468 469 Level: beginner 470 471 .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscCalloc1()`, `PetscMalloc2()` 472 473 M*/ 474 #define PetscMalloc1(m1, r1) PetscMallocA(1, PETSC_FALSE, __LINE__, PETSC_FUNCTION_NAME, __FILE__, (size_t)((size_t)m1) * sizeof(**(r1)), (r1)) 475 476 /*MC 477 PetscCalloc1 - Allocates a cleared (zeroed) array of memory aligned to `PETSC_MEMALIGN` 478 479 Synopsis: 480 #include <petscsys.h> 481 PetscErrorCode PetscCalloc1(size_t m1,type **r1) 482 483 Not Collective 484 485 Input Parameter: 486 . m1 - number of elements to allocate in 1st chunk (may be zero) 487 488 Output Parameter: 489 . r1 - memory allocated 490 491 Notes: 492 See `PetsMalloc1()` for more details on usage. 493 494 Level: beginner 495 496 .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscMalloc1()`, `PetscCalloc2()` 497 498 M*/ 499 #define PetscCalloc1(m1, r1) PetscMallocA(1, PETSC_TRUE, __LINE__, PETSC_FUNCTION_NAME, __FILE__, (size_t)((size_t)m1) * sizeof(**(r1)), (r1)) 500 501 /*MC 502 PetscMalloc2 - Allocates 2 arrays of memory both aligned to `PETSC_MEMALIGN` 503 504 Synopsis: 505 #include <petscsys.h> 506 PetscErrorCode PetscMalloc2(size_t m1,type **r1,size_t m2,type **r2) 507 508 Not Collective 509 510 Input Parameters: 511 + m1 - number of elements to allocate in 1st chunk (may be zero) 512 - m2 - number of elements to allocate in 2nd chunk (may be zero) 513 514 Output Parameters: 515 + r1 - memory allocated in first chunk 516 - r2 - memory allocated in second chunk 517 518 Level: developer 519 520 .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscMalloc1()`, `PetscCalloc2()` 521 522 M*/ 523 #define PetscMalloc2(m1, r1, m2, r2) PetscMallocA(2, PETSC_FALSE, __LINE__, PETSC_FUNCTION_NAME, __FILE__, (size_t)((size_t)m1) * sizeof(**(r1)), (r1), (size_t)((size_t)m2) * sizeof(**(r2)), (r2)) 524 525 /*MC 526 PetscCalloc2 - Allocates 2 cleared (zeroed) arrays of memory both aligned to `PETSC_MEMALIGN` 527 528 Synopsis: 529 #include <petscsys.h> 530 PetscErrorCode PetscCalloc2(size_t m1,type **r1,size_t m2,type **r2) 531 532 Not Collective 533 534 Input Parameters: 535 + m1 - number of elements to allocate in 1st chunk (may be zero) 536 - m2 - number of elements to allocate in 2nd chunk (may be zero) 537 538 Output Parameters: 539 + r1 - memory allocated in first chunk 540 - r2 - memory allocated in second chunk 541 542 Level: developer 543 544 .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscCalloc1()`, `PetscMalloc2()` 545 546 M*/ 547 #define PetscCalloc2(m1, r1, m2, r2) PetscMallocA(2, PETSC_TRUE, __LINE__, PETSC_FUNCTION_NAME, __FILE__, (size_t)((size_t)m1) * sizeof(**(r1)), (r1), (size_t)((size_t)m2) * sizeof(**(r2)), (r2)) 548 549 /*MC 550 PetscMalloc3 - Allocates 3 arrays of memory, all aligned to `PETSC_MEMALIGN` 551 552 Synopsis: 553 #include <petscsys.h> 554 PetscErrorCode PetscMalloc3(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3) 555 556 Not Collective 557 558 Input Parameters: 559 + m1 - number of elements to allocate in 1st chunk (may be zero) 560 . m2 - number of elements to allocate in 2nd chunk (may be zero) 561 - m3 - number of elements to allocate in 3rd chunk (may be zero) 562 563 Output Parameters: 564 + r1 - memory allocated in first chunk 565 . r2 - memory allocated in second chunk 566 - r3 - memory allocated in third chunk 567 568 Level: developer 569 570 .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscCalloc3()`, `PetscFree3()` 571 572 M*/ 573 #define PetscMalloc3(m1, r1, m2, r2, m3, r3) PetscMallocA(3, PETSC_FALSE, __LINE__, PETSC_FUNCTION_NAME, __FILE__, (size_t)((size_t)m1) * sizeof(**(r1)), (r1), (size_t)((size_t)m2) * sizeof(**(r2)), (r2), (size_t)((size_t)m3) * sizeof(**(r3)), (r3)) 574 575 /*MC 576 PetscCalloc3 - Allocates 3 cleared (zeroed) arrays of memory, all aligned to `PETSC_MEMALIGN` 577 578 Synopsis: 579 #include <petscsys.h> 580 PetscErrorCode PetscCalloc3(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3) 581 582 Not Collective 583 584 Input Parameters: 585 + m1 - number of elements to allocate in 1st chunk (may be zero) 586 . m2 - number of elements to allocate in 2nd chunk (may be zero) 587 - m3 - number of elements to allocate in 3rd chunk (may be zero) 588 589 Output Parameters: 590 + r1 - memory allocated in first chunk 591 . r2 - memory allocated in second chunk 592 - r3 - memory allocated in third chunk 593 594 Level: developer 595 596 .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscCalloc2()`, `PetscMalloc3()`, `PetscFree3()` 597 598 M*/ 599 #define PetscCalloc3(m1, r1, m2, r2, m3, r3) PetscMallocA(3, PETSC_TRUE, __LINE__, PETSC_FUNCTION_NAME, __FILE__, (size_t)((size_t)m1) * sizeof(**(r1)), (r1), (size_t)((size_t)m2) * sizeof(**(r2)), (r2), (size_t)((size_t)m3) * sizeof(**(r3)), (r3)) 600 601 /*MC 602 PetscMalloc4 - Allocates 4 arrays of memory, all aligned to `PETSC_MEMALIGN` 603 604 Synopsis: 605 #include <petscsys.h> 606 PetscErrorCode PetscMalloc4(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4) 607 608 Not Collective 609 610 Input Parameters: 611 + m1 - number of elements to allocate in 1st chunk (may be zero) 612 . m2 - number of elements to allocate in 2nd chunk (may be zero) 613 . m3 - number of elements to allocate in 3rd chunk (may be zero) 614 - m4 - number of elements to allocate in 4th chunk (may be zero) 615 616 Output Parameters: 617 + r1 - memory allocated in first chunk 618 . r2 - memory allocated in second chunk 619 . r3 - memory allocated in third chunk 620 - r4 - memory allocated in fourth chunk 621 622 Level: developer 623 624 .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscCalloc4()`, `PetscFree4()` 625 626 M*/ 627 #define PetscMalloc4(m1, r1, m2, r2, m3, r3, m4, r4) \ 628 PetscMallocA(4, PETSC_FALSE, __LINE__, PETSC_FUNCTION_NAME, __FILE__, (size_t)((size_t)m1) * sizeof(**(r1)), (r1), (size_t)((size_t)m2) * sizeof(**(r2)), (r2), (size_t)((size_t)m3) * sizeof(**(r3)), (r3), (size_t)((size_t)m4) * sizeof(**(r4)), (r4)) 629 630 /*MC 631 PetscCalloc4 - Allocates 4 cleared (zeroed) arrays of memory, all aligned to `PETSC_MEMALIGN` 632 633 Synopsis: 634 #include <petscsys.h> 635 PetscErrorCode PetscCalloc4(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4) 636 637 Not Collective 638 639 Input Parameters: 640 + m1 - number of elements to allocate in 1st chunk (may be zero) 641 . m2 - number of elements to allocate in 2nd chunk (may be zero) 642 . m3 - number of elements to allocate in 3rd chunk (may be zero) 643 - m4 - number of elements to allocate in 4th chunk (may be zero) 644 645 Output Parameters: 646 + r1 - memory allocated in first chunk 647 . r2 - memory allocated in second chunk 648 . r3 - memory allocated in third chunk 649 - r4 - memory allocated in fourth chunk 650 651 Level: developer 652 653 .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscCalloc4()`, `PetscFree4()` 654 655 M*/ 656 #define PetscCalloc4(m1, r1, m2, r2, m3, r3, m4, r4) \ 657 PetscMallocA(4, PETSC_TRUE, __LINE__, PETSC_FUNCTION_NAME, __FILE__, (size_t)((size_t)m1) * sizeof(**(r1)), (r1), (size_t)((size_t)m2) * sizeof(**(r2)), (r2), (size_t)((size_t)m3) * sizeof(**(r3)), (r3), (size_t)((size_t)m4) * sizeof(**(r4)), (r4)) 658 659 /*MC 660 PetscMalloc5 - Allocates 5 arrays of memory, all aligned to `PETSC_MEMALIGN` 661 662 Synopsis: 663 #include <petscsys.h> 664 PetscErrorCode PetscMalloc5(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4,size_t m5,type **r5) 665 666 Not Collective 667 668 Input Parameters: 669 + m1 - number of elements to allocate in 1st chunk (may be zero) 670 . m2 - number of elements to allocate in 2nd chunk (may be zero) 671 . m3 - number of elements to allocate in 3rd chunk (may be zero) 672 . m4 - number of elements to allocate in 4th chunk (may be zero) 673 - m5 - number of elements to allocate in 5th chunk (may be zero) 674 675 Output Parameters: 676 + r1 - memory allocated in first chunk 677 . r2 - memory allocated in second chunk 678 . r3 - memory allocated in third chunk 679 . r4 - memory allocated in fourth chunk 680 - r5 - memory allocated in fifth chunk 681 682 Level: developer 683 684 .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscCalloc5()`, `PetscFree5()` 685 686 M*/ 687 #define PetscMalloc5(m1, r1, m2, r2, m3, r3, m4, r4, m5, r5) \ 688 PetscMallocA(5, PETSC_FALSE, __LINE__, PETSC_FUNCTION_NAME, __FILE__, (size_t)((size_t)m1) * sizeof(**(r1)), (r1), (size_t)((size_t)m2) * sizeof(**(r2)), (r2), (size_t)((size_t)m3) * sizeof(**(r3)), (r3), (size_t)((size_t)m4) * sizeof(**(r4)), (r4), (size_t)((size_t)m5) * sizeof(**(r5)), (r5)) 689 690 /*MC 691 PetscCalloc5 - Allocates 5 cleared (zeroed) arrays of memory, all aligned to `PETSC_MEMALIGN` 692 693 Synopsis: 694 #include <petscsys.h> 695 PetscErrorCode PetscCalloc5(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4,size_t m5,type **r5) 696 697 Not Collective 698 699 Input Parameters: 700 + m1 - number of elements to allocate in 1st chunk (may be zero) 701 . m2 - number of elements to allocate in 2nd chunk (may be zero) 702 . m3 - number of elements to allocate in 3rd chunk (may be zero) 703 . m4 - number of elements to allocate in 4th chunk (may be zero) 704 - m5 - number of elements to allocate in 5th chunk (may be zero) 705 706 Output Parameters: 707 + r1 - memory allocated in first chunk 708 . r2 - memory allocated in second chunk 709 . r3 - memory allocated in third chunk 710 . r4 - memory allocated in fourth chunk 711 - r5 - memory allocated in fifth chunk 712 713 Level: developer 714 715 .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscMalloc5()`, `PetscFree5()` 716 717 M*/ 718 #define PetscCalloc5(m1, r1, m2, r2, m3, r3, m4, r4, m5, r5) \ 719 PetscMallocA(5, PETSC_TRUE, __LINE__, PETSC_FUNCTION_NAME, __FILE__, (size_t)((size_t)m1) * sizeof(**(r1)), (r1), (size_t)((size_t)m2) * sizeof(**(r2)), (r2), (size_t)((size_t)m3) * sizeof(**(r3)), (r3), (size_t)((size_t)m4) * sizeof(**(r4)), (r4), (size_t)((size_t)m5) * sizeof(**(r5)), (r5)) 720 721 /*MC 722 PetscMalloc6 - Allocates 6 arrays of memory, all aligned to `PETSC_MEMALIGN` 723 724 Synopsis: 725 #include <petscsys.h> 726 PetscErrorCode PetscMalloc6(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4,size_t m5,type **r5,size_t m6,type **r6) 727 728 Not Collective 729 730 Input Parameters: 731 + m1 - number of elements to allocate in 1st chunk (may be zero) 732 . m2 - number of elements to allocate in 2nd chunk (may be zero) 733 . m3 - number of elements to allocate in 3rd chunk (may be zero) 734 . m4 - number of elements to allocate in 4th chunk (may be zero) 735 . m5 - number of elements to allocate in 5th chunk (may be zero) 736 - m6 - number of elements to allocate in 6th chunk (may be zero) 737 738 Output Parameteasr: 739 + r1 - memory allocated in first chunk 740 . r2 - memory allocated in second chunk 741 . r3 - memory allocated in third chunk 742 . r4 - memory allocated in fourth chunk 743 . r5 - memory allocated in fifth chunk 744 - r6 - memory allocated in sixth chunk 745 746 Level: developer 747 748 .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscCalloc6()`, `PetscFree3()`, `PetscFree4()`, `PetscFree5()`, `PetscFree6()` 749 750 M*/ 751 #define PetscMalloc6(m1, r1, m2, r2, m3, r3, m4, r4, m5, r5, m6, r6) \ 752 PetscMallocA(6, PETSC_FALSE, __LINE__, PETSC_FUNCTION_NAME, __FILE__, (size_t)((size_t)m1) * sizeof(**(r1)), (r1), (size_t)((size_t)m2) * sizeof(**(r2)), (r2), (size_t)((size_t)m3) * sizeof(**(r3)), (r3), (size_t)((size_t)m4) * sizeof(**(r4)), (r4), (size_t)((size_t)m5) * sizeof(**(r5)), (r5), (size_t)((size_t)m6) * sizeof(**(r6)), (r6)) 753 754 /*MC 755 PetscCalloc6 - Allocates 6 cleared (zeroed) arrays of memory, all aligned to `PETSC_MEMALIGN` 756 757 Synopsis: 758 #include <petscsys.h> 759 PetscErrorCode PetscCalloc6(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4,size_t m5,type **r5,size_t m6,type **r6) 760 761 Not Collective 762 763 Input Parameters: 764 + m1 - number of elements to allocate in 1st chunk (may be zero) 765 . m2 - number of elements to allocate in 2nd chunk (may be zero) 766 . m3 - number of elements to allocate in 3rd chunk (may be zero) 767 . m4 - number of elements to allocate in 4th chunk (may be zero) 768 . m5 - number of elements to allocate in 5th chunk (may be zero) 769 - m6 - number of elements to allocate in 6th chunk (may be zero) 770 771 Output Parameters: 772 + r1 - memory allocated in first chunk 773 . r2 - memory allocated in second chunk 774 . r3 - memory allocated in third chunk 775 . r4 - memory allocated in fourth chunk 776 . r5 - memory allocated in fifth chunk 777 - r6 - memory allocated in sixth chunk 778 779 Level: developer 780 781 .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscMalloc6()`, `PetscFree6()` 782 783 M*/ 784 #define PetscCalloc6(m1, r1, m2, r2, m3, r3, m4, r4, m5, r5, m6, r6) \ 785 PetscMallocA(6, PETSC_TRUE, __LINE__, PETSC_FUNCTION_NAME, __FILE__, (size_t)((size_t)m1) * sizeof(**(r1)), (r1), (size_t)((size_t)m2) * sizeof(**(r2)), (r2), (size_t)((size_t)m3) * sizeof(**(r3)), (r3), (size_t)((size_t)m4) * sizeof(**(r4)), (r4), (size_t)((size_t)m5) * sizeof(**(r5)), (r5), (size_t)((size_t)m6) * sizeof(**(r6)), (r6)) 786 787 /*MC 788 PetscMalloc7 - Allocates 7 arrays of memory, all aligned to `PETSC_MEMALIGN` 789 790 Synopsis: 791 #include <petscsys.h> 792 PetscErrorCode PetscMalloc7(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4,size_t m5,type **r5,size_t m6,type **r6,size_t m7,type **r7) 793 794 Not Collective 795 796 Input Parameters: 797 + m1 - number of elements to allocate in 1st chunk (may be zero) 798 . m2 - number of elements to allocate in 2nd chunk (may be zero) 799 . m3 - number of elements to allocate in 3rd chunk (may be zero) 800 . m4 - number of elements to allocate in 4th chunk (may be zero) 801 . m5 - number of elements to allocate in 5th chunk (may be zero) 802 . m6 - number of elements to allocate in 6th chunk (may be zero) 803 - m7 - number of elements to allocate in 7th chunk (may be zero) 804 805 Output Parameters: 806 + r1 - memory allocated in first chunk 807 . r2 - memory allocated in second chunk 808 . r3 - memory allocated in third chunk 809 . r4 - memory allocated in fourth chunk 810 . r5 - memory allocated in fifth chunk 811 . r6 - memory allocated in sixth chunk 812 - r7 - memory allocated in seventh chunk 813 814 Level: developer 815 816 .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscCalloc7()`, `PetscFree7()` 817 818 M*/ 819 #define PetscMalloc7(m1, r1, m2, r2, m3, r3, m4, r4, m5, r5, m6, r6, m7, r7) \ 820 PetscMallocA(7, PETSC_FALSE, __LINE__, PETSC_FUNCTION_NAME, __FILE__, (size_t)((size_t)m1) * sizeof(**(r1)), (r1), (size_t)((size_t)m2) * sizeof(**(r2)), (r2), (size_t)((size_t)m3) * sizeof(**(r3)), (r3), (size_t)((size_t)m4) * sizeof(**(r4)), (r4), (size_t)((size_t)m5) * sizeof(**(r5)), (r5), (size_t)((size_t)m6) * sizeof(**(r6)), (r6), (size_t)((size_t)m7) * sizeof(**(r7)), (r7)) 821 822 /*MC 823 PetscCalloc7 - Allocates 7 cleared (zeroed) arrays of memory, all aligned to `PETSC_MEMALIGN` 824 825 Synopsis: 826 #include <petscsys.h> 827 PetscErrorCode PetscCalloc7(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4,size_t m5,type **r5,size_t m6,type **r6,size_t m7,type **r7) 828 829 Not Collective 830 831 Input Parameters: 832 + m1 - number of elements to allocate in 1st chunk (may be zero) 833 . m2 - number of elements to allocate in 2nd chunk (may be zero) 834 . m3 - number of elements to allocate in 3rd chunk (may be zero) 835 . m4 - number of elements to allocate in 4th chunk (may be zero) 836 . m5 - number of elements to allocate in 5th chunk (may be zero) 837 . m6 - number of elements to allocate in 6th chunk (may be zero) 838 - m7 - number of elements to allocate in 7th chunk (may be zero) 839 840 Output Parameters: 841 + r1 - memory allocated in first chunk 842 . r2 - memory allocated in second chunk 843 . r3 - memory allocated in third chunk 844 . r4 - memory allocated in fourth chunk 845 . r5 - memory allocated in fifth chunk 846 . r6 - memory allocated in sixth chunk 847 - r7 - memory allocated in seventh chunk 848 849 Level: developer 850 851 .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscMalloc7()`, `PetscFree7()` 852 853 M*/ 854 #define PetscCalloc7(m1, r1, m2, r2, m3, r3, m4, r4, m5, r5, m6, r6, m7, r7) \ 855 PetscMallocA(7, PETSC_TRUE, __LINE__, PETSC_FUNCTION_NAME, __FILE__, (size_t)((size_t)m1) * sizeof(**(r1)), (r1), (size_t)((size_t)m2) * sizeof(**(r2)), (r2), (size_t)((size_t)m3) * sizeof(**(r3)), (r3), (size_t)((size_t)m4) * sizeof(**(r4)), (r4), (size_t)((size_t)m5) * sizeof(**(r5)), (r5), (size_t)((size_t)m6) * sizeof(**(r6)), (r6), (size_t)((size_t)m7) * sizeof(**(r7)), (r7)) 856 857 /*MC 858 PetscNew - Allocates memory of a particular type, zeros the memory! Aligned to `PETSC_MEMALIGN` 859 860 Synopsis: 861 #include <petscsys.h> 862 PetscErrorCode PetscNew(type **result) 863 864 Not Collective 865 866 Output Parameter: 867 . result - memory allocated, sized to match pointer type 868 869 Level: beginner 870 871 .seealso: `PetscFree()`, `PetscMalloc()`, `PetscCalloc1()`, `PetscMalloc1()` 872 873 M*/ 874 #define PetscNew(b) PetscCalloc1(1, (b)) 875 876 #define PetscNewLog(o, b) PETSC_DEPRECATED_MACRO("GCC warning \"PetscNewLog is deprecated, use PetscNew() instead (since version 3.18)\"") PetscNew((b)) 877 878 /*MC 879 PetscFree - Frees memory 880 881 Synopsis: 882 #include <petscsys.h> 883 PetscErrorCode PetscFree(void *memory) 884 885 Not Collective 886 887 Input Parameter: 888 . memory - memory to free (the pointer is ALWAYS set to NULL upon success) 889 890 Level: beginner 891 892 Notes: 893 Do not free memory obtained with `PetscMalloc2()`, `PetscCalloc2()` etc, they must be freed with `PetscFree2()` etc. 894 895 It is safe to call `PetscFree()` on a NULL pointer. 896 897 .seealso: `PetscNew()`, `PetscMalloc()`, `PetscMalloc1()`, `PetscCalloc1()` 898 899 M*/ 900 #define PetscFree(a) ((*PetscTrFree)((void *)(a), __LINE__, PETSC_FUNCTION_NAME, __FILE__) || ((a) = NULL, 0)) 901 902 /*MC 903 PetscFree2 - Frees 2 chunks of memory obtained with `PetscMalloc2()` 904 905 Synopsis: 906 #include <petscsys.h> 907 PetscErrorCode PetscFree2(void *memory1,void *memory2) 908 909 Not Collective 910 911 Input Parameters: 912 + memory1 - memory to free 913 - memory2 - 2nd memory to free 914 915 Level: developer 916 917 Notes: 918 Memory must have been obtained with `PetscMalloc2()` 919 920 .seealso: `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscFree()` 921 922 M*/ 923 #define PetscFree2(m1, m2) PetscFreeA(2, __LINE__, PETSC_FUNCTION_NAME, __FILE__, &(m1), &(m2)) 924 925 /*MC 926 PetscFree3 - Frees 3 chunks of memory obtained with `PetscMalloc3()` 927 928 Synopsis: 929 #include <petscsys.h> 930 PetscErrorCode PetscFree3(void *memory1,void *memory2,void *memory3) 931 932 Not Collective 933 934 Input Parameters: 935 + memory1 - memory to free 936 . memory2 - 2nd memory to free 937 - memory3 - 3rd memory to free 938 939 Level: developer 940 941 Notes: 942 Memory must have been obtained with `PetscMalloc3()` 943 944 .seealso: `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscFree()`, `PetscMalloc3()` 945 946 M*/ 947 #define PetscFree3(m1, m2, m3) PetscFreeA(3, __LINE__, PETSC_FUNCTION_NAME, __FILE__, &(m1), &(m2), &(m3)) 948 949 /*MC 950 PetscFree4 - Frees 4 chunks of memory obtained with `PetscMalloc4()` 951 952 Synopsis: 953 #include <petscsys.h> 954 PetscErrorCode PetscFree4(void *m1,void *m2,void *m3,void *m4) 955 956 Not Collective 957 958 Input Parameters: 959 + m1 - memory to free 960 . m2 - 2nd memory to free 961 . m3 - 3rd memory to free 962 - m4 - 4th memory to free 963 964 Level: developer 965 966 Notes: 967 Memory must have been obtained with `PetscMalloc4()` 968 969 .seealso: `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscFree()`, `PetscMalloc3()`, `PetscMalloc4()` 970 971 M*/ 972 #define PetscFree4(m1, m2, m3, m4) PetscFreeA(4, __LINE__, PETSC_FUNCTION_NAME, __FILE__, &(m1), &(m2), &(m3), &(m4)) 973 974 /*MC 975 PetscFree5 - Frees 5 chunks of memory obtained with `PetscMalloc5()` 976 977 Synopsis: 978 #include <petscsys.h> 979 PetscErrorCode PetscFree5(void *m1,void *m2,void *m3,void *m4,void *m5) 980 981 Not Collective 982 983 Input Parameters: 984 + m1 - memory to free 985 . m2 - 2nd memory to free 986 . m3 - 3rd memory to free 987 . m4 - 4th memory to free 988 - m5 - 5th memory to free 989 990 Level: developer 991 992 Notes: 993 Memory must have been obtained with `PetscMalloc5()` 994 995 .seealso: `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscFree()`, `PetscMalloc3()`, `PetscMalloc4()`, `PetscMalloc5()` 996 997 M*/ 998 #define PetscFree5(m1, m2, m3, m4, m5) PetscFreeA(5, __LINE__, PETSC_FUNCTION_NAME, __FILE__, &(m1), &(m2), &(m3), &(m4), &(m5)) 999 1000 /*MC 1001 PetscFree6 - Frees 6 chunks of memory obtained with `PetscMalloc6()` 1002 1003 Synopsis: 1004 #include <petscsys.h> 1005 PetscErrorCode PetscFree6(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6) 1006 1007 Not Collective 1008 1009 Input Parameters: 1010 + m1 - memory to free 1011 . m2 - 2nd memory to free 1012 . m3 - 3rd memory to free 1013 . m4 - 4th memory to free 1014 . m5 - 5th memory to free 1015 - m6 - 6th memory to free 1016 1017 Level: developer 1018 1019 Notes: 1020 Memory must have been obtained with `PetscMalloc6()` 1021 1022 .seealso: `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscFree()`, `PetscMalloc3()`, `PetscMalloc4()`, `PetscMalloc5()`, `PetscMalloc6()` 1023 1024 M*/ 1025 #define PetscFree6(m1, m2, m3, m4, m5, m6) PetscFreeA(6, __LINE__, PETSC_FUNCTION_NAME, __FILE__, &(m1), &(m2), &(m3), &(m4), &(m5), &(m6)) 1026 1027 /*MC 1028 PetscFree7 - Frees 7 chunks of memory obtained with `PetscMalloc7()` 1029 1030 Synopsis: 1031 #include <petscsys.h> 1032 PetscErrorCode PetscFree7(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6,void *m7) 1033 1034 Not Collective 1035 1036 Input Parameters: 1037 + m1 - memory to free 1038 . m2 - 2nd memory to free 1039 . m3 - 3rd memory to free 1040 . m4 - 4th memory to free 1041 . m5 - 5th memory to free 1042 . m6 - 6th memory to free 1043 - m7 - 7th memory to free 1044 1045 Level: developer 1046 1047 Notes: 1048 Memory must have been obtained with `PetscMalloc7()` 1049 1050 .seealso: `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscFree()`, `PetscMalloc3()`, `PetscMalloc4()`, `PetscMalloc5()`, `PetscMalloc6()`, 1051 `PetscMalloc7()` 1052 1053 M*/ 1054 #define PetscFree7(m1, m2, m3, m4, m5, m6, m7) PetscFreeA(7, __LINE__, PETSC_FUNCTION_NAME, __FILE__, &(m1), &(m2), &(m3), &(m4), &(m5), &(m6), &(m7)) 1055 1056 PETSC_EXTERN PetscErrorCode PetscMallocA(int, PetscBool, int, const char *, const char *, size_t, void *, ...); 1057 PETSC_EXTERN PetscErrorCode PetscFreeA(int, int, const char *, const char *, void *, ...); 1058 PETSC_EXTERN PetscErrorCode (*PetscTrMalloc)(size_t, PetscBool, int, const char[], const char[], void **); 1059 PETSC_EXTERN PetscErrorCode (*PetscTrFree)(void *, int, const char[], const char[]); 1060 PETSC_EXTERN PetscErrorCode (*PetscTrRealloc)(size_t, int, const char[], const char[], void **); 1061 PETSC_EXTERN PetscErrorCode PetscMallocSetCoalesce(PetscBool); 1062 PETSC_EXTERN PetscErrorCode PetscMallocSet(PetscErrorCode (*)(size_t, PetscBool, int, const char[], const char[], void **), PetscErrorCode (*)(void *, int, const char[], const char[]), PetscErrorCode (*)(size_t, int, const char[], const char[], void **)); 1063 PETSC_EXTERN PetscErrorCode PetscMallocClear(void); 1064 1065 /* 1066 Unlike PetscMallocSet and PetscMallocClear which overwrite the existing settings, these two functions save the previous choice of allocator, and should be used in pair. 1067 */ 1068 PETSC_EXTERN PetscErrorCode PetscMallocSetDRAM(void); 1069 PETSC_EXTERN PetscErrorCode PetscMallocResetDRAM(void); 1070 #if defined(PETSC_HAVE_CUDA) 1071 PETSC_EXTERN PetscErrorCode PetscMallocSetCUDAHost(void); 1072 PETSC_EXTERN PetscErrorCode PetscMallocResetCUDAHost(void); 1073 #endif 1074 #if defined(PETSC_HAVE_HIP) 1075 PETSC_EXTERN PetscErrorCode PetscMallocSetHIPHost(void); 1076 PETSC_EXTERN PetscErrorCode PetscMallocResetHIPHost(void); 1077 #endif 1078 1079 #define MPIU_PETSCLOGDOUBLE MPI_DOUBLE 1080 #define MPIU_2PETSCLOGDOUBLE MPI_2DOUBLE_PRECISION 1081 1082 /* 1083 Routines for tracing memory corruption/bleeding with default PETSc memory allocation 1084 */ 1085 PETSC_EXTERN PetscErrorCode PetscMallocDump(FILE *); 1086 PETSC_EXTERN PetscErrorCode PetscMallocView(FILE *); 1087 PETSC_EXTERN PetscErrorCode PetscMallocGetCurrentUsage(PetscLogDouble *); 1088 PETSC_EXTERN PetscErrorCode PetscMallocGetMaximumUsage(PetscLogDouble *); 1089 PETSC_EXTERN PetscErrorCode PetscMallocPushMaximumUsage(int); 1090 PETSC_EXTERN PetscErrorCode PetscMallocPopMaximumUsage(int, PetscLogDouble *); 1091 PETSC_EXTERN PetscErrorCode PetscMallocSetDebug(PetscBool, PetscBool); 1092 PETSC_EXTERN PetscErrorCode PetscMallocGetDebug(PetscBool *, PetscBool *, PetscBool *); 1093 PETSC_EXTERN PetscErrorCode PetscMallocValidate(int, const char[], const char[]); 1094 PETSC_EXTERN PetscErrorCode PetscMallocViewSet(PetscLogDouble); 1095 PETSC_EXTERN PetscErrorCode PetscMallocViewGet(PetscBool *); 1096 PETSC_EXTERN PetscErrorCode PetscMallocLogRequestedSizeSet(PetscBool); 1097 PETSC_EXTERN PetscErrorCode PetscMallocLogRequestedSizeGet(PetscBool *); 1098 1099 PETSC_EXTERN const char *const PetscDataTypes[]; 1100 PETSC_EXTERN PetscErrorCode PetscDataTypeToMPIDataType(PetscDataType, MPI_Datatype *); 1101 PETSC_EXTERN PetscErrorCode PetscMPIDataTypeToPetscDataType(MPI_Datatype, PetscDataType *); 1102 PETSC_EXTERN PetscErrorCode PetscDataTypeGetSize(PetscDataType, size_t *); 1103 PETSC_EXTERN PetscErrorCode PetscDataTypeFromString(const char *, PetscDataType *, PetscBool *); 1104 1105 /* 1106 Basic memory and string operations. These are usually simple wrappers 1107 around the basic Unix system calls, but a few of them have additional 1108 functionality and/or error checking. 1109 */ 1110 PETSC_EXTERN PetscErrorCode PetscMemcmp(const void *, const void *, size_t, PetscBool *); 1111 PETSC_EXTERN PetscErrorCode PetscStrlen(const char[], size_t *); 1112 PETSC_EXTERN PetscErrorCode PetscStrToArray(const char[], char, int *, char ***); 1113 PETSC_EXTERN PetscErrorCode PetscStrToArrayDestroy(int, char **); 1114 PETSC_EXTERN PetscErrorCode PetscStrcmp(const char[], const char[], PetscBool *); 1115 PETSC_EXTERN PetscErrorCode PetscStrgrt(const char[], const char[], PetscBool *); 1116 PETSC_EXTERN PetscErrorCode PetscStrcasecmp(const char[], const char[], PetscBool *); 1117 PETSC_EXTERN PetscErrorCode PetscStrncmp(const char[], const char[], size_t, PetscBool *); 1118 PETSC_EXTERN PetscErrorCode PetscStrcpy(char[], const char[]); 1119 PETSC_EXTERN PetscErrorCode PetscStrcat(char[], const char[]); 1120 PETSC_EXTERN PetscErrorCode PetscStrlcat(char[], const char[], size_t); 1121 PETSC_EXTERN PetscErrorCode PetscStrncpy(char[], const char[], size_t); 1122 PETSC_EXTERN PetscErrorCode PetscStrchr(const char[], char, char *[]); 1123 PETSC_EXTERN PetscErrorCode PetscStrtolower(char[]); 1124 PETSC_EXTERN PetscErrorCode PetscStrtoupper(char[]); 1125 PETSC_EXTERN PetscErrorCode PetscStrrchr(const char[], char, char *[]); 1126 PETSC_EXTERN PetscErrorCode PetscStrstr(const char[], const char[], char *[]); 1127 PETSC_EXTERN PetscErrorCode PetscStrrstr(const char[], const char[], char *[]); 1128 PETSC_EXTERN PetscErrorCode PetscStrendswith(const char[], const char[], PetscBool *); 1129 PETSC_EXTERN PetscErrorCode PetscStrbeginswith(const char[], const char[], PetscBool *); 1130 PETSC_EXTERN PetscErrorCode PetscStrendswithwhich(const char[], const char *const *, PetscInt *); 1131 PETSC_EXTERN PetscErrorCode PetscStrallocpy(const char[], char *[]); 1132 PETSC_EXTERN PetscErrorCode PetscStrArrayallocpy(const char *const *, char ***); 1133 PETSC_EXTERN PetscErrorCode PetscStrArrayDestroy(char ***); 1134 PETSC_EXTERN PetscErrorCode PetscStrNArrayallocpy(PetscInt, const char *const *, char ***); 1135 PETSC_EXTERN PetscErrorCode PetscStrNArrayDestroy(PetscInt, char ***); 1136 PETSC_EXTERN PetscErrorCode PetscStrreplace(MPI_Comm, const char[], char[], size_t); 1137 1138 PETSC_EXTERN void PetscStrcmpNoError(const char[], const char[], PetscBool *); 1139 1140 PETSC_EXTERN PetscErrorCode PetscTokenCreate(const char[], const char, PetscToken *); 1141 PETSC_EXTERN PetscErrorCode PetscTokenFind(PetscToken, char *[]); 1142 PETSC_EXTERN PetscErrorCode PetscTokenDestroy(PetscToken *); 1143 1144 PETSC_EXTERN PetscErrorCode PetscStrInList(const char[], const char[], char, PetscBool *); 1145 PETSC_EXTERN const char *PetscBasename(const char[]); 1146 PETSC_EXTERN PetscErrorCode PetscEListFind(PetscInt, const char *const *, const char *, PetscInt *, PetscBool *); 1147 PETSC_EXTERN PetscErrorCode PetscEnumFind(const char *const *, const char *, PetscEnum *, PetscBool *); 1148 1149 /* 1150 These are MPI operations for MPI_Allreduce() etc 1151 */ 1152 PETSC_EXTERN MPI_Op MPIU_MAXSUM_OP; 1153 #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16) 1154 PETSC_EXTERN MPI_Op MPIU_SUM; 1155 PETSC_EXTERN MPI_Op MPIU_MAX; 1156 PETSC_EXTERN MPI_Op MPIU_MIN; 1157 #else 1158 #define MPIU_SUM MPI_SUM 1159 #define MPIU_MAX MPI_MAX 1160 #define MPIU_MIN MPI_MIN 1161 #endif 1162 PETSC_EXTERN MPI_Op Petsc_Garbage_SetIntersectOp; 1163 PETSC_EXTERN PetscErrorCode PetscMaxSum(MPI_Comm, const PetscInt[], PetscInt *, PetscInt *); 1164 1165 #if defined(PETSC_HAVE_REAL___FLOAT128) || defined(PETSC_HAVE_REAL___FP16) 1166 /*MC 1167 MPIU_SUM___FP16___FLOAT128 - MPI_Op that acts as a replacement for MPI_SUM with 1168 custom MPI_Datatype `MPIU___FLOAT128`, `MPIU___COMPLEX128`, and `MPIU___FP16`. 1169 1170 Level: advanced 1171 1172 Developer Note: 1173 This should be unified with `MPIU_SUM` 1174 1175 .seealso: `MPIU_REAL`, `MPIU_SCALAR`, `MPIU_COMPLEX` 1176 M*/ 1177 PETSC_EXTERN MPI_Op MPIU_SUM___FP16___FLOAT128; 1178 #endif 1179 PETSC_EXTERN PetscErrorCode PetscMaxSum(MPI_Comm, const PetscInt[], PetscInt *, PetscInt *); 1180 1181 PETSC_EXTERN PetscErrorCode MPIULong_Send(void *, PetscInt, MPI_Datatype, PetscMPIInt, PetscMPIInt, MPI_Comm) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(1, 3); 1182 PETSC_EXTERN PetscErrorCode MPIULong_Recv(void *, PetscInt, MPI_Datatype, PetscMPIInt, PetscMPIInt, MPI_Comm) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(1, 3); 1183 1184 PETSC_EXTERN const char *const PetscFileModes[]; 1185 1186 /* 1187 Defines PETSc error handling. 1188 */ 1189 #include <petscerror.h> 1190 1191 PETSC_EXTERN PetscBool PetscCIEnabled; /* code is running in the PETSc test harness CI */ 1192 PETSC_EXTERN PetscBool PetscCIEnabledPortableErrorOutput; /* error output is stripped to ensure portability of error messages across systems */ 1193 PETSC_EXTERN const char *PetscCIFilename(const char *); 1194 PETSC_EXTERN int PetscCILinenumber(int); 1195 1196 #define PETSC_SMALLEST_CLASSID 1211211 1197 PETSC_EXTERN PetscClassId PETSC_LARGEST_CLASSID; 1198 PETSC_EXTERN PetscClassId PETSC_OBJECT_CLASSID; 1199 PETSC_EXTERN PetscErrorCode PetscClassIdRegister(const char[], PetscClassId *); 1200 PETSC_EXTERN PetscErrorCode PetscObjectGetId(PetscObject, PetscObjectId *); 1201 PETSC_EXTERN PetscErrorCode PetscObjectCompareId(PetscObject, PetscObjectId, PetscBool *); 1202 1203 /* 1204 Routines that get memory usage information from the OS 1205 */ 1206 PETSC_EXTERN PetscErrorCode PetscMemoryGetCurrentUsage(PetscLogDouble *); 1207 PETSC_EXTERN PetscErrorCode PetscMemoryGetMaximumUsage(PetscLogDouble *); 1208 PETSC_EXTERN PetscErrorCode PetscMemorySetGetMaximumUsage(void); 1209 PETSC_EXTERN PetscErrorCode PetscMemoryTrace(const char[]); 1210 1211 PETSC_EXTERN PetscErrorCode PetscSleep(PetscReal); 1212 1213 /* 1214 Initialization of PETSc 1215 */ 1216 PETSC_EXTERN PetscErrorCode PetscInitialize(int *, char ***, const char[], const char[]); 1217 PETSC_EXTERN PetscErrorCode PetscInitializeNoPointers(int, char **, const char[], const char[]); 1218 PETSC_EXTERN PetscErrorCode PetscInitializeNoArguments(void); 1219 PETSC_EXTERN PetscErrorCode PetscInitialized(PetscBool *); 1220 PETSC_EXTERN PetscErrorCode PetscFinalized(PetscBool *); 1221 PETSC_EXTERN PetscErrorCode PetscFinalize(void); 1222 PETSC_EXTERN PetscErrorCode PetscInitializeFortran(void); 1223 PETSC_EXTERN PetscErrorCode PetscGetArgs(int *, char ***); 1224 PETSC_EXTERN PetscErrorCode PetscGetArguments(char ***); 1225 PETSC_EXTERN PetscErrorCode PetscFreeArguments(char **); 1226 1227 PETSC_EXTERN PetscErrorCode PetscEnd(void); 1228 PETSC_EXTERN PetscErrorCode PetscSysInitializePackage(void); 1229 1230 PETSC_EXTERN PetscErrorCode PetscPythonInitialize(const char[], const char[]); 1231 PETSC_EXTERN PetscErrorCode PetscPythonFinalize(void); 1232 PETSC_EXTERN PetscErrorCode PetscPythonPrintError(void); 1233 PETSC_EXTERN PetscErrorCode PetscPythonMonitorSet(PetscObject, const char[]); 1234 1235 PETSC_EXTERN PetscErrorCode PetscMonitorCompare(PetscErrorCode (*)(void), void *, PetscErrorCode (*)(void **), PetscErrorCode (*)(void), void *, PetscErrorCode (*)(void **), PetscBool *); 1236 1237 /* 1238 These are so that in extern C code we can caste function pointers to non-extern C 1239 function pointers. Since the regular C++ code expects its function pointers to be C++ 1240 */ 1241 PETSC_EXTERN_TYPEDEF typedef void (**PetscVoidStarFunction)(void); 1242 PETSC_EXTERN_TYPEDEF typedef void (*PetscVoidFunction)(void); 1243 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*PetscErrorCodeFunction)(void); 1244 1245 /* 1246 Functions that can act on any PETSc object. 1247 */ 1248 PETSC_EXTERN PetscErrorCode PetscObjectDestroy(PetscObject *); 1249 PETSC_EXTERN PetscErrorCode PetscObjectGetComm(PetscObject, MPI_Comm *); 1250 PETSC_EXTERN PetscErrorCode PetscObjectGetClassId(PetscObject, PetscClassId *); 1251 PETSC_EXTERN PetscErrorCode PetscObjectGetClassName(PetscObject, const char *[]); 1252 PETSC_EXTERN PetscErrorCode PetscObjectGetType(PetscObject, const char *[]); 1253 PETSC_EXTERN PetscErrorCode PetscObjectSetName(PetscObject, const char[]); 1254 PETSC_EXTERN PetscErrorCode PetscObjectGetName(PetscObject, const char *[]); 1255 PETSC_EXTERN PetscErrorCode PetscObjectSetTabLevel(PetscObject, PetscInt); 1256 PETSC_EXTERN PetscErrorCode PetscObjectGetTabLevel(PetscObject, PetscInt *); 1257 PETSC_EXTERN PetscErrorCode PetscObjectIncrementTabLevel(PetscObject, PetscObject, PetscInt); 1258 PETSC_EXTERN PetscErrorCode PetscObjectReference(PetscObject); 1259 PETSC_EXTERN PetscErrorCode PetscObjectGetReference(PetscObject, PetscInt *); 1260 PETSC_EXTERN PetscErrorCode PetscObjectDereference(PetscObject); 1261 PETSC_EXTERN PetscErrorCode PetscObjectGetNewTag(PetscObject, PetscMPIInt *); 1262 PETSC_EXTERN PetscErrorCode PetscObjectCompose(PetscObject, const char[], PetscObject); 1263 PETSC_EXTERN PetscErrorCode PetscObjectRemoveReference(PetscObject, const char[]); 1264 PETSC_EXTERN PetscErrorCode PetscObjectQuery(PetscObject, const char[], PetscObject *); 1265 PETSC_EXTERN PetscErrorCode PetscObjectComposeFunction_Private(PetscObject, const char[], void (*)(void)); 1266 #define PetscObjectComposeFunction(a, b, d) PetscObjectComposeFunction_Private(a, b, (PetscVoidFunction)(d)) 1267 PETSC_EXTERN PetscErrorCode PetscObjectSetFromOptions(PetscObject); 1268 PETSC_EXTERN PetscErrorCode PetscObjectSetUp(PetscObject); 1269 PETSC_EXTERN PetscErrorCode PetscObjectSetPrintedOptions(PetscObject); 1270 PETSC_EXTERN PetscErrorCode PetscObjectInheritPrintedOptions(PetscObject, PetscObject); 1271 PETSC_EXTERN PetscErrorCode PetscCommGetNewTag(MPI_Comm, PetscMPIInt *); 1272 1273 #include <petscviewertypes.h> 1274 #include <petscoptions.h> 1275 1276 PETSC_EXTERN PetscErrorCode PetscMallocTraceSet(PetscViewer, PetscBool, PetscLogDouble); 1277 PETSC_EXTERN PetscErrorCode PetscMallocTraceGet(PetscBool *); 1278 1279 PETSC_EXTERN PetscErrorCode PetscObjectsListGetGlobalNumbering(MPI_Comm, PetscInt, PetscObject *, PetscInt *, PetscInt *); 1280 1281 PETSC_EXTERN PetscErrorCode PetscMemoryView(PetscViewer, const char[]); 1282 PETSC_EXTERN PetscErrorCode PetscObjectPrintClassNamePrefixType(PetscObject, PetscViewer); 1283 PETSC_EXTERN PetscErrorCode PetscObjectView(PetscObject, PetscViewer); 1284 #define PetscObjectQueryFunction(obj, name, fptr) PetscObjectQueryFunction_Private((obj), (name), (PetscVoidFunction *)(fptr)) 1285 PETSC_EXTERN PetscErrorCode PetscObjectQueryFunction_Private(PetscObject, const char[], void (**)(void)); 1286 PETSC_EXTERN PetscErrorCode PetscObjectSetOptionsPrefix(PetscObject, const char[]); 1287 PETSC_EXTERN PetscErrorCode PetscObjectAppendOptionsPrefix(PetscObject, const char[]); 1288 PETSC_EXTERN PetscErrorCode PetscObjectPrependOptionsPrefix(PetscObject, const char[]); 1289 PETSC_EXTERN PetscErrorCode PetscObjectGetOptionsPrefix(PetscObject, const char *[]); 1290 PETSC_EXTERN PetscErrorCode PetscObjectChangeTypeName(PetscObject, const char[]); 1291 PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroy(PetscObject); 1292 PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroyAll(void); 1293 PETSC_EXTERN PetscErrorCode PetscObjectViewFromOptions(PetscObject, PetscObject, const char[]); 1294 PETSC_EXTERN PetscErrorCode PetscObjectName(PetscObject); 1295 PETSC_EXTERN PetscErrorCode PetscObjectTypeCompare(PetscObject, const char[], PetscBool *); 1296 PETSC_EXTERN PetscErrorCode PetscObjectObjectTypeCompare(PetscObject, PetscObject, PetscBool *); 1297 PETSC_EXTERN PetscErrorCode PetscObjectBaseTypeCompare(PetscObject, const char[], PetscBool *); 1298 PETSC_EXTERN PetscErrorCode PetscObjectTypeCompareAny(PetscObject, PetscBool *, const char[], ...); 1299 PETSC_EXTERN PetscErrorCode PetscObjectBaseTypeCompareAny(PetscObject, PetscBool *, const char[], ...); 1300 PETSC_EXTERN PetscErrorCode PetscRegisterFinalize(PetscErrorCode (*)(void)); 1301 PETSC_EXTERN PetscErrorCode PetscRegisterFinalizeAll(void); 1302 1303 #if defined(PETSC_HAVE_SAWS) 1304 PETSC_EXTERN PetscErrorCode PetscSAWsBlock(void); 1305 PETSC_EXTERN PetscErrorCode PetscObjectSAWsViewOff(PetscObject); 1306 PETSC_EXTERN PetscErrorCode PetscObjectSAWsSetBlock(PetscObject, PetscBool); 1307 PETSC_EXTERN PetscErrorCode PetscObjectSAWsBlock(PetscObject); 1308 PETSC_EXTERN PetscErrorCode PetscObjectSAWsGrantAccess(PetscObject); 1309 PETSC_EXTERN PetscErrorCode PetscObjectSAWsTakeAccess(PetscObject); 1310 PETSC_EXTERN void PetscStackSAWsGrantAccess(void); 1311 PETSC_EXTERN void PetscStackSAWsTakeAccess(void); 1312 PETSC_EXTERN PetscErrorCode PetscStackViewSAWs(void); 1313 PETSC_EXTERN PetscErrorCode PetscStackSAWsViewOff(void); 1314 1315 #else 1316 #define PetscSAWsBlock() 0 1317 #define PetscObjectSAWsViewOff(obj) 0 1318 #define PetscObjectSAWsSetBlock(obj, flg) 0 1319 #define PetscObjectSAWsBlock(obj) 0 1320 #define PetscObjectSAWsGrantAccess(obj) 0 1321 #define PetscObjectSAWsTakeAccess(obj) 0 1322 #define PetscStackViewSAWs() 0 1323 #define PetscStackSAWsViewOff() 0 1324 #define PetscStackSAWsTakeAccess() 1325 #define PetscStackSAWsGrantAccess() 1326 1327 #endif 1328 1329 PETSC_EXTERN PetscErrorCode PetscDLOpen(const char[], PetscDLMode, PetscDLHandle *); 1330 PETSC_EXTERN PetscErrorCode PetscDLClose(PetscDLHandle *); 1331 PETSC_EXTERN PetscErrorCode PetscDLSym(PetscDLHandle, const char[], void **); 1332 PETSC_EXTERN PetscErrorCode PetscDLAddr(void (*)(void), char **); 1333 #ifdef PETSC_HAVE_CXX 1334 PETSC_EXTERN PetscErrorCode PetscDemangleSymbol(const char *, char **); 1335 #endif 1336 1337 PETSC_EXTERN PetscErrorCode PetscMallocGetStack(void *, PetscStack **); 1338 1339 PETSC_EXTERN PetscErrorCode PetscObjectsDump(FILE *, PetscBool); 1340 PETSC_EXTERN PetscErrorCode PetscObjectListDestroy(PetscObjectList *); 1341 PETSC_EXTERN PetscErrorCode PetscObjectListFind(PetscObjectList, const char[], PetscObject *); 1342 PETSC_EXTERN PetscErrorCode PetscObjectListReverseFind(PetscObjectList, PetscObject, char **, PetscBool *); 1343 PETSC_EXTERN PetscErrorCode PetscObjectListAdd(PetscObjectList *, const char[], PetscObject); 1344 PETSC_EXTERN PetscErrorCode PetscObjectListRemoveReference(PetscObjectList *, const char[]); 1345 PETSC_EXTERN PetscErrorCode PetscObjectListDuplicate(PetscObjectList, PetscObjectList *); 1346 1347 /* 1348 Dynamic library lists. Lists of names of routines in objects or in dynamic 1349 link libraries that will be loaded as needed. 1350 */ 1351 1352 #define PetscFunctionListAdd(list, name, fptr) PetscFunctionListAdd_Private((list), (name), (PetscVoidFunction)(fptr)) 1353 PETSC_EXTERN PetscErrorCode PetscFunctionListAdd_Private(PetscFunctionList *, const char[], void (*)(void)); 1354 PETSC_EXTERN PetscErrorCode PetscFunctionListDestroy(PetscFunctionList *); 1355 PETSC_EXTERN PetscErrorCode PetscFunctionListClear(PetscFunctionList); 1356 #define PetscFunctionListFind(list, name, fptr) PetscFunctionListFind_Private((list), (name), (PetscVoidFunction *)(fptr)) 1357 PETSC_EXTERN PetscErrorCode PetscFunctionListFind_Private(PetscFunctionList, const char[], void (**)(void)); 1358 PETSC_EXTERN PetscErrorCode PetscFunctionListPrintTypes(MPI_Comm, FILE *, const char[], const char[], const char[], const char[], PetscFunctionList, const char[], const char[]); 1359 PETSC_EXTERN PetscErrorCode PetscFunctionListDuplicate(PetscFunctionList, PetscFunctionList *); 1360 PETSC_EXTERN PetscErrorCode PetscFunctionListView(PetscFunctionList, PetscViewer); 1361 PETSC_EXTERN PetscErrorCode PetscFunctionListGet(PetscFunctionList, const char ***, int *); 1362 PETSC_EXTERN PetscErrorCode PetscFunctionListPrintNonEmpty(PetscFunctionList); 1363 PETSC_EXTERN PetscErrorCode PetscFunctionListPrintAll(void); 1364 1365 PETSC_EXTERN PetscDLLibrary PetscDLLibrariesLoaded; 1366 PETSC_EXTERN PetscErrorCode PetscDLLibraryAppend(MPI_Comm, PetscDLLibrary *, const char[]); 1367 PETSC_EXTERN PetscErrorCode PetscDLLibraryPrepend(MPI_Comm, PetscDLLibrary *, const char[]); 1368 PETSC_EXTERN PetscErrorCode PetscDLLibrarySym(MPI_Comm, PetscDLLibrary *, const char[], const char[], void **); 1369 PETSC_EXTERN PetscErrorCode PetscDLLibraryPrintPath(PetscDLLibrary); 1370 PETSC_EXTERN PetscErrorCode PetscDLLibraryRetrieve(MPI_Comm, const char[], char *, size_t, PetscBool *); 1371 PETSC_EXTERN PetscErrorCode PetscDLLibraryOpen(MPI_Comm, const char[], PetscDLLibrary *); 1372 PETSC_EXTERN PetscErrorCode PetscDLLibraryClose(PetscDLLibrary); 1373 1374 /* 1375 Useful utility routines 1376 */ 1377 PETSC_EXTERN PetscErrorCode PetscSplitOwnership(MPI_Comm, PetscInt *, PetscInt *); 1378 PETSC_EXTERN PetscErrorCode PetscSplitOwnershipBlock(MPI_Comm, PetscInt, PetscInt *, PetscInt *); 1379 PETSC_EXTERN PetscErrorCode PetscSplitOwnershipEqual(MPI_Comm, PetscInt *, PetscInt *); 1380 PETSC_EXTERN PetscErrorCode PetscSequentialPhaseBegin(MPI_Comm, PetscMPIInt); 1381 PETSC_EXTERN PetscErrorCode PetscSequentialPhaseEnd(MPI_Comm, PetscMPIInt); 1382 PETSC_EXTERN PetscErrorCode PetscBarrier(PetscObject); 1383 PETSC_EXTERN PetscErrorCode PetscMPIDump(FILE *); 1384 PETSC_EXTERN PetscErrorCode PetscGlobalMinMaxInt(MPI_Comm, const PetscInt[2], PetscInt[2]); 1385 PETSC_EXTERN PetscErrorCode PetscGlobalMinMaxReal(MPI_Comm, const PetscReal[2], PetscReal[2]); 1386 1387 /*MC 1388 PetscNot - negates a logical type value and returns result as a `PetscBool` 1389 1390 Level: beginner 1391 1392 Note: 1393 This is useful in cases like 1394 .vb 1395 int *a; 1396 PetscBool flag = PetscNot(a) 1397 .ve 1398 where !a would not return a `PetscBool` because we cannot provide a cast from int to `PetscBool` in C. 1399 1400 .seealso: `PetscBool`, `PETSC_TRUE`, `PETSC_FALSE` 1401 M*/ 1402 #define PetscNot(a) ((a) ? PETSC_FALSE : PETSC_TRUE) 1403 1404 /*MC 1405 PetscHelpPrintf - Prints help messages. 1406 1407 Not Collective, only applies on rank 0; No Fortran Support 1408 1409 Synopsis: 1410 #include <petscsys.h> 1411 PetscErrorCode (*PetscHelpPrintf)(MPI_Comm comm, const char format[],args); 1412 1413 Input Parameters: 1414 + comm - the MPI communicator over which the help message is printed 1415 . format - the usual printf() format string 1416 - args - arguments to be printed 1417 1418 Level: developer 1419 1420 Note: 1421 You can change how help messages are printed by replacing the function pointer with a function that does not simply write to stdout. 1422 1423 To use, write your own function, for example, 1424 $PetscErrorCode mypetschelpprintf(MPI_Comm comm,const char format[],....) 1425 ${ 1426 $ PetscFunctionReturn(0); 1427 $} 1428 then do the assignment 1429 $ PetscHelpPrintf = mypetschelpprintf; 1430 You can do the assignment before `PetscInitialize()`. 1431 1432 The default routine used is called `PetscHelpPrintfDefault()`. 1433 1434 .seealso: `PetscFPrintf()`, `PetscSynchronizedPrintf()`, `PetscErrorPrintf()` 1435 M*/ 1436 PETSC_EXTERN PetscErrorCode (*PetscHelpPrintf)(MPI_Comm, const char[], ...) PETSC_ATTRIBUTE_FORMAT(2, 3); 1437 1438 /* 1439 Defines PETSc profiling. 1440 */ 1441 #include <petsclog.h> 1442 1443 /* 1444 Simple PETSc parallel IO for ASCII printing 1445 */ 1446 PETSC_EXTERN PetscErrorCode PetscFixFilename(const char[], char[]); 1447 PETSC_EXTERN PetscErrorCode PetscFOpen(MPI_Comm, const char[], const char[], FILE **); 1448 PETSC_EXTERN PetscErrorCode PetscFClose(MPI_Comm, FILE *); 1449 PETSC_EXTERN PetscErrorCode PetscFPrintf(MPI_Comm, FILE *, const char[], ...) PETSC_ATTRIBUTE_FORMAT(3, 4); 1450 PETSC_EXTERN PetscErrorCode PetscPrintf(MPI_Comm, const char[], ...) PETSC_ATTRIBUTE_FORMAT(2, 3); 1451 PETSC_EXTERN PetscErrorCode PetscSNPrintf(char *, size_t, const char[], ...) PETSC_ATTRIBUTE_FORMAT(3, 4); 1452 PETSC_EXTERN PetscErrorCode PetscSNPrintfCount(char *, size_t, const char[], size_t *, ...) PETSC_ATTRIBUTE_FORMAT(3, 5); 1453 PETSC_EXTERN PetscErrorCode PetscFormatRealArray(char[], size_t, const char *, PetscInt, const PetscReal[]); 1454 1455 PETSC_EXTERN PetscErrorCode PetscErrorPrintfDefault(const char[], ...) PETSC_ATTRIBUTE_FORMAT(1, 2); 1456 PETSC_EXTERN PetscErrorCode PetscErrorPrintfNone(const char[], ...) PETSC_ATTRIBUTE_FORMAT(1, 2); 1457 PETSC_EXTERN PetscErrorCode PetscHelpPrintfDefault(MPI_Comm, const char[], ...) PETSC_ATTRIBUTE_FORMAT(2, 3); 1458 1459 PETSC_EXTERN PetscErrorCode PetscFormatConvertGetSize(const char *, size_t *); 1460 PETSC_EXTERN PetscErrorCode PetscFormatConvert(const char *, char *); 1461 1462 #if defined(PETSC_HAVE_POPEN) 1463 PETSC_EXTERN PetscErrorCode PetscPOpen(MPI_Comm, const char[], const char[], const char[], FILE **); 1464 PETSC_EXTERN PetscErrorCode PetscPClose(MPI_Comm, FILE *); 1465 PETSC_EXTERN PetscErrorCode PetscPOpenSetMachine(const char[]); 1466 #endif 1467 1468 PETSC_EXTERN PetscErrorCode PetscSynchronizedPrintf(MPI_Comm, const char[], ...) PETSC_ATTRIBUTE_FORMAT(2, 3); 1469 PETSC_EXTERN PetscErrorCode PetscSynchronizedFPrintf(MPI_Comm, FILE *, const char[], ...) PETSC_ATTRIBUTE_FORMAT(3, 4); 1470 PETSC_EXTERN PetscErrorCode PetscSynchronizedFlush(MPI_Comm, FILE *); 1471 PETSC_EXTERN PetscErrorCode PetscSynchronizedFGets(MPI_Comm, FILE *, size_t, char[]); 1472 PETSC_EXTERN PetscErrorCode PetscStartMatlab(MPI_Comm, const char[], const char[], FILE **); 1473 PETSC_EXTERN PetscErrorCode PetscStartJava(MPI_Comm, const char[], const char[], FILE **); 1474 PETSC_EXTERN PetscErrorCode PetscGetPetscDir(const char *[]); 1475 1476 PETSC_EXTERN PetscClassId PETSC_CONTAINER_CLASSID; 1477 PETSC_EXTERN PetscErrorCode PetscContainerGetPointer(PetscContainer, void **); 1478 PETSC_EXTERN PetscErrorCode PetscContainerSetPointer(PetscContainer, void *); 1479 PETSC_EXTERN PetscErrorCode PetscContainerDestroy(PetscContainer *); 1480 PETSC_EXTERN PetscErrorCode PetscContainerCreate(MPI_Comm, PetscContainer *); 1481 PETSC_EXTERN PetscErrorCode PetscContainerSetUserDestroy(PetscContainer, PetscErrorCode (*)(void *)); 1482 PETSC_EXTERN PetscErrorCode PetscContainerUserDestroyDefault(void *); 1483 1484 /* 1485 For use in debuggers 1486 */ 1487 PETSC_EXTERN PetscMPIInt PetscGlobalRank; 1488 PETSC_EXTERN PetscMPIInt PetscGlobalSize; 1489 PETSC_EXTERN PetscErrorCode PetscIntView(PetscInt, const PetscInt[], PetscViewer); 1490 PETSC_EXTERN PetscErrorCode PetscRealView(PetscInt, const PetscReal[], PetscViewer); 1491 PETSC_EXTERN PetscErrorCode PetscScalarView(PetscInt, const PetscScalar[], PetscViewer); 1492 1493 #include <stddef.h> 1494 #include <string.h> /* for memcpy, memset */ 1495 #include <stdlib.h> 1496 1497 #if defined(PETSC_HAVE_XMMINTRIN_H) && !defined(__CUDACC__) 1498 #include <xmmintrin.h> 1499 #endif 1500 1501 /*@C 1502 PetscMemmove - Copies n bytes, beginning at location b, to the space 1503 beginning at location a. Copying between regions that overlap will 1504 take place correctly. Use `PetscMemcpy()` if the locations do not overlap 1505 1506 Not Collective 1507 1508 Input Parameters: 1509 + b - pointer to initial memory space 1510 . a - pointer to copy space 1511 - n - length (in bytes) of space to copy 1512 1513 Level: intermediate 1514 1515 Notes: 1516 `PetscArraymove()` is preferred 1517 1518 This routine is analogous to `memmove()`. 1519 1520 Developers Note: 1521 This is inlined for performance 1522 1523 .seealso: `PetscMemcpy()`, `PetscMemcmp()`, `PetscArrayzero()`, `PetscMemzero()`, `PetscArraycmp()`, `PetscArraycpy()`, `PetscStrallocpy()`, 1524 `PetscArraymove()` 1525 @*/ 1526 static inline PetscErrorCode PetscMemmove(void *a, const void *b, size_t n) 1527 { 1528 PetscFunctionBegin; 1529 if (n > 0) { 1530 PetscCheck(a, PETSC_COMM_SELF, PETSC_ERR_ARG_NULL, "Trying to copy to null pointer"); 1531 PetscCheck(b, PETSC_COMM_SELF, PETSC_ERR_ARG_NULL, "Trying to copy from a null pointer"); 1532 } 1533 #if !defined(PETSC_HAVE_MEMMOVE) 1534 if (a < b) { 1535 if (a <= b - n) memcpy(a, b, n); 1536 else { 1537 memcpy(a, b, (int)(b - a)); 1538 PetscMemmove(b, b + (int)(b - a), n - (int)(b - a)); 1539 } 1540 } else { 1541 if (b <= a - n) memcpy(a, b, n); 1542 else { 1543 memcpy(b + n, b + (n - (int)(a - b)), (int)(a - b)); 1544 PetscMemmove(a, b, n - (int)(a - b)); 1545 } 1546 } 1547 #else 1548 memmove((char *)(a), (char *)(b), n); 1549 #endif 1550 PetscFunctionReturn(0); 1551 } 1552 1553 /*@C 1554 PetscMemcpy - Copies n bytes, beginning at location b, to the space 1555 beginning at location a. The two memory regions CANNOT overlap, use 1556 `PetscMemmove()` in that case. 1557 1558 Not Collective 1559 1560 Input Parameters: 1561 + b - pointer to initial memory space 1562 - n - length (in bytes) of space to copy 1563 1564 Output Parameter: 1565 . a - pointer to copy space 1566 1567 Level: intermediate 1568 1569 Compile Option: 1570 `PETSC_PREFER_DCOPY_FOR_MEMCPY` will cause the BLAS dcopy() routine to be used 1571 for memory copies on double precision values. 1572 `PETSC_PREFER_COPY_FOR_MEMCPY` will cause C code to be used 1573 for memory copies on double precision values. 1574 `PETSC_PREFER_FORTRAN_FORMEMCPY` will cause Fortran code to be used 1575 for memory copies on double precision values. 1576 1577 Notes: 1578 Prefer `PetscArraycpy()` 1579 1580 This routine is analogous to `memcpy()`. 1581 1582 Not available from Fortran 1583 1584 Developer Note: 1585 This is inlined for fastest performance 1586 1587 .seealso: `PetscMemzero()`, `PetscMemcmp()`, `PetscArrayzero()`, `PetscArraycmp()`, `PetscArraycpy()`, `PetscMemmove()`, `PetscStrallocpy()` 1588 1589 @*/ 1590 static inline PetscErrorCode PetscMemcpy(void *a, const void *b, size_t n) 1591 { 1592 #if defined(PETSC_USE_DEBUG) 1593 size_t al = (size_t)a, bl = (size_t)b; 1594 size_t nl = (size_t)n; 1595 PetscFunctionBegin; 1596 if (n > 0) { 1597 PetscCheck(b, PETSC_COMM_SELF, PETSC_ERR_ARG_NULL, "Trying to copy from a null pointer"); 1598 PetscCheck(a, PETSC_COMM_SELF, PETSC_ERR_ARG_NULL, "Trying to copy to a null pointer"); 1599 } 1600 #else 1601 PetscFunctionBegin; 1602 #endif 1603 if (a != b && n > 0) { 1604 #if defined(PETSC_USE_DEBUG) 1605 PetscCheck(!((al > bl && (al - bl) < nl) || (bl - al) < nl), PETSC_COMM_SELF, PETSC_ERR_ARG_INCOMP, "Memory regions overlap: either use PetscMemmov()\n\ 1606 or make sure your copy regions and lengths are correct. \n\ 1607 Length (bytes) %zu first address %zu second address %zu", 1608 nl, al, bl); 1609 #endif 1610 #if (defined(PETSC_PREFER_DCOPY_FOR_MEMCPY) || defined(PETSC_PREFER_COPY_FOR_MEMCPY) || defined(PETSC_PREFER_FORTRAN_FORMEMCPY)) 1611 if (!(a % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) { 1612 size_t len = n / sizeof(PetscScalar); 1613 #if defined(PETSC_PREFER_DCOPY_FOR_MEMCPY) 1614 PetscBLASInt one = 1, blen; 1615 PetscCall(PetscBLASIntCast(len, &blen)); 1616 PetscCallBLAS("BLAScopy", BLAScopy_(&blen, (PetscScalar *)b, &one, (PetscScalar *)a, &one)); 1617 #elif defined(PETSC_PREFER_FORTRAN_FORMEMCPY) 1618 fortrancopy_(&len, (PetscScalar *)b, (PetscScalar *)a); 1619 #else 1620 PetscScalar *x = (PetscScalar *)b, *y = (PetscScalar *)a; 1621 for (size_t i = 0; i < len; i++) y[i] = x[i]; 1622 #endif 1623 } else { 1624 memcpy((char *)(a), (char *)(b), n); 1625 } 1626 #else 1627 memcpy((char *)(a), (char *)(b), n); 1628 #endif 1629 } 1630 PetscFunctionReturn(0); 1631 } 1632 1633 /*@C 1634 PetscMemzero - Zeros the specified memory. 1635 1636 Not Collective 1637 1638 Input Parameters: 1639 + a - pointer to beginning memory location 1640 - n - length (in bytes) of memory to initialize 1641 1642 Level: intermediate 1643 1644 Compile Option: 1645 `PETSC_PREFER_BZERO` - on certain machines (the IBM RS6000) the bzero() routine happens 1646 to be faster than the memset() routine. This flag causes the bzero() routine to be used. 1647 1648 Notes: 1649 Not available from Fortran 1650 1651 Prefer `PetscArrayzero()` 1652 1653 Developer Note: 1654 This is inlined for fastest performance 1655 1656 .seealso: `PetscMemcpy()`, `PetscMemcmp()`, `PetscArrayzero()`, `PetscArraycmp()`, `PetscArraycpy()`, `PetscMemmove()`, `PetscStrallocpy()` 1657 @*/ 1658 static inline PetscErrorCode PetscMemzero(void *a, size_t n) 1659 { 1660 if (n > 0) { 1661 #if defined(PETSC_USE_DEBUG) 1662 PetscCheck(a, PETSC_COMM_SELF, PETSC_ERR_ARG_NULL, "Trying to zero at a null pointer with %zu bytes", n); 1663 #endif 1664 #if defined(PETSC_PREFER_ZERO_FOR_MEMZERO) 1665 if (!(((long)a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) { 1666 size_t i, len = n / sizeof(PetscScalar); 1667 PetscScalar *x = (PetscScalar *)a; 1668 for (i = 0; i < len; i++) x[i] = 0.0; 1669 } else { 1670 #elif defined(PETSC_PREFER_FORTRAN_FOR_MEMZERO) 1671 if (!(((long)a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) { 1672 PetscInt len = n / sizeof(PetscScalar); 1673 fortranzero_(&len, (PetscScalar *)a); 1674 } else { 1675 #endif 1676 #if defined(PETSC_PREFER_BZERO) 1677 bzero((char *)a, n); 1678 #else 1679 memset((char *)a, 0, n); 1680 #endif 1681 #if defined(PETSC_PREFER_ZERO_FOR_MEMZERO) || defined(PETSC_PREFER_FORTRAN_FOR_MEMZERO) 1682 } 1683 #endif 1684 } 1685 return 0; 1686 } 1687 1688 /*MC 1689 PetscArraycmp - Compares two arrays in memory. 1690 1691 Synopsis: 1692 #include <petscsys.h> 1693 PetscErrorCode PetscArraycmp(const anytype *str1,const anytype *str2,size_t cnt,PetscBool *e) 1694 1695 Not Collective 1696 1697 Input Parameters: 1698 + str1 - First array 1699 . str2 - Second array 1700 - cnt - Count of the array, not in bytes, but number of entries in the arrays 1701 1702 Output Parameters: 1703 . e - `PETSC_TRUE` if equal else `PETSC_FALSE`. 1704 1705 Level: intermediate 1706 1707 Notes: 1708 This routine is a preferred replacement to `PetscMemcmp()` 1709 1710 The arrays must be of the same type 1711 1712 .seealso: `PetscMemcpy()`, `PetscMemcmp()`, `PetscArrayzero()`, `PetscMemzero()`, `PetscArraycpy()`, `PetscMemmove()`, `PetscStrallocpy()`, 1713 `PetscArraymove()` 1714 M*/ 1715 #define PetscArraycmp(str1, str2, cnt, e) ((sizeof(*(str1)) != sizeof(*(str2))) || PetscMemcmp(str1, str2, (size_t)(cnt) * sizeof(*(str1)), e)) 1716 1717 /*MC 1718 PetscArraymove - Copies from one array in memory to another, the arrays may overlap. Use `PetscArraycpy()` when the arrays 1719 do not overlap 1720 1721 Synopsis: 1722 #include <petscsys.h> 1723 PetscErrorCode PetscArraymove(anytype *str1,const anytype *str2,size_t cnt) 1724 1725 Not Collective 1726 1727 Input Parameters: 1728 + str1 - First array 1729 . str2 - Second array 1730 - cnt - Count of the array, not in bytes, but number of entries in the arrays 1731 1732 Level: intermediate 1733 1734 Notes: 1735 This routine is a preferred replacement to `PetscMemmove()` 1736 1737 The arrays must be of the same type 1738 1739 .seealso: `PetscMemcpy()`, `PetscMemcmp()`, `PetscArrayzero()`, `PetscMemzero()`, `PetscArraycpy()`, `PetscMemmove()`, `PetscArraycmp()`, `PetscStrallocpy()` 1740 M*/ 1741 #define PetscArraymove(str1, str2, cnt) ((sizeof(*(str1)) != sizeof(*(str2))) || PetscMemmove(str1, str2, (size_t)(cnt) * sizeof(*(str1)))) 1742 1743 /*MC 1744 PetscArraycpy - Copies from one array in memory to another 1745 1746 Synopsis: 1747 #include <petscsys.h> 1748 PetscErrorCode PetscArraycpy(anytype *str1,const anytype *str2,size_t cnt) 1749 1750 Not Collective 1751 1752 Input Parameters: 1753 + str1 - First array (destination) 1754 . str2 - Second array (source) 1755 - cnt - Count of the array, not in bytes, but number of entries in the arrays 1756 1757 Level: intermediate 1758 1759 Notes: 1760 This routine is a preferred replacement to `PetscMemcpy()` 1761 1762 The arrays must be of the same type 1763 1764 .seealso: `PetscMemcpy()`, `PetscMemcmp()`, `PetscArrayzero()`, `PetscMemzero()`, `PetscArraymove()`, `PetscMemmove()`, `PetscArraycmp()`, `PetscStrallocpy()` 1765 M*/ 1766 #define PetscArraycpy(str1, str2, cnt) ((sizeof(*(str1)) != sizeof(*(str2))) || PetscMemcpy(str1, str2, (size_t)(cnt) * sizeof(*(str1)))) 1767 1768 /*MC 1769 PetscArrayzero - Zeros an array in memory. 1770 1771 Synopsis: 1772 #include <petscsys.h> 1773 PetscErrorCode PetscArrayzero(anytype *str1,size_t cnt) 1774 1775 Not Collective 1776 1777 Input Parameters: 1778 + str1 - array 1779 - cnt - Count of the array, not in bytes, but number of entries in the array 1780 1781 Level: intermediate 1782 1783 Note: 1784 This routine is a preferred replacement to `PetscMemzero()` 1785 1786 .seealso: `PetscMemcpy()`, `PetscMemcmp()`, `PetscMemzero()`, `PetscArraycmp()`, `PetscArraycpy()`, `PetscMemmove()`, `PetscStrallocpy()`, `PetscArraymove()` 1787 M*/ 1788 #define PetscArrayzero(str1, cnt) PetscMemzero(str1, (size_t)(cnt) * sizeof(*(str1))) 1789 1790 /*MC 1791 PetscPrefetchBlock - Prefetches a block of memory 1792 1793 Synopsis: 1794 #include <petscsys.h> 1795 void PetscPrefetchBlock(const anytype *a,size_t n,int rw,int t) 1796 1797 Not Collective 1798 1799 Input Parameters: 1800 + a - pointer to first element to fetch (any type but usually PetscInt or PetscScalar) 1801 . n - number of elements to fetch 1802 . rw - 1 if the memory will be written to, otherwise 0 (ignored by many processors) 1803 - t - temporal locality (PETSC_PREFETCH_HINT_{NTA,T0,T1,T2}), see note 1804 1805 Level: developer 1806 1807 Notes: 1808 The last two arguments (rw and t) must be compile-time constants. 1809 1810 Adopting Intel's x86/x86-64 conventions, there are four levels of temporal locality. Not all architectures offer 1811 equivalent locality hints, but the following macros are always defined to their closest analogue. 1812 + `PETSC_PREFETCH_HINT_NTA` - Non-temporal. Prefetches directly to L1, evicts to memory (skips higher level cache unless it was already there when prefetched). 1813 . `PETSC_PREFETCH_HINT_T0` - Fetch to all levels of cache and evict to the closest level. Use this when the memory will be reused regularly despite necessary eviction from L1. 1814 . `PETSC_PREFETCH_HINT_T1` - Fetch to level 2 and higher (not L1). 1815 - `PETSC_PREFETCH_HINT_T2` - Fetch to high-level cache only. (On many systems, T0 and T1 are equivalent.) 1816 1817 This function does nothing on architectures that do not support prefetch and never errors (even if passed an invalid 1818 address). 1819 1820 M*/ 1821 #define PetscPrefetchBlock(a, n, rw, t) \ 1822 do { \ 1823 const char *_p = (const char *)(a), *_end = (const char *)((a) + (n)); \ 1824 for (; _p < _end; _p += PETSC_LEVEL1_DCACHE_LINESIZE) PETSC_Prefetch(_p, (rw), (t)); \ 1825 } while (0) 1826 1827 /* 1828 Determine if some of the kernel computation routines use 1829 Fortran (rather than C) for the numerical calculations. On some machines 1830 and compilers (like complex numbers) the Fortran version of the routines 1831 is faster than the C/C++ versions. The flag --with-fortran-kernels 1832 should be used with ./configure to turn these on. 1833 */ 1834 #if defined(PETSC_USE_FORTRAN_KERNELS) 1835 1836 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTCRL) 1837 #define PETSC_USE_FORTRAN_KERNEL_MULTCRL 1838 #endif 1839 1840 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJPERM) 1841 #define PETSC_USE_FORTRAN_KERNEL_MULTAIJPERM 1842 #endif 1843 1844 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJ) 1845 #define PETSC_USE_FORTRAN_KERNEL_MULTAIJ 1846 #endif 1847 1848 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ) 1849 #define PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ 1850 #endif 1851 1852 #if !defined(PETSC_USE_FORTRAN_KERNEL_NORM) 1853 #define PETSC_USE_FORTRAN_KERNEL_NORM 1854 #endif 1855 1856 #if !defined(PETSC_USE_FORTRAN_KERNEL_MAXPY) 1857 #define PETSC_USE_FORTRAN_KERNEL_MAXPY 1858 #endif 1859 1860 #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ) 1861 #define PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ 1862 #endif 1863 1864 #if !defined(PETSC_USE_FORTRAN_KERNEL_RELAXAIJ) 1865 #define PETSC_USE_FORTRAN_KERNEL_RELAXAIJ 1866 #endif 1867 1868 #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ) 1869 #define PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ 1870 #endif 1871 1872 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ) 1873 #define PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ 1874 #endif 1875 1876 #if !defined(PETSC_USE_FORTRAN_KERNEL_MDOT) 1877 #define PETSC_USE_FORTRAN_KERNEL_MDOT 1878 #endif 1879 1880 #if !defined(PETSC_USE_FORTRAN_KERNEL_XTIMESY) 1881 #define PETSC_USE_FORTRAN_KERNEL_XTIMESY 1882 #endif 1883 1884 #if !defined(PETSC_USE_FORTRAN_KERNEL_AYPX) 1885 #define PETSC_USE_FORTRAN_KERNEL_AYPX 1886 #endif 1887 1888 #if !defined(PETSC_USE_FORTRAN_KERNEL_WAXPY) 1889 #define PETSC_USE_FORTRAN_KERNEL_WAXPY 1890 #endif 1891 1892 #endif 1893 1894 /* 1895 Macros for indicating code that should be compiled with a C interface, 1896 rather than a C++ interface. Any routines that are dynamically loaded 1897 (such as the PCCreate_XXX() routines) must be wrapped so that the name 1898 mangler does not change the functions symbol name. This just hides the 1899 ugly extern "C" {} wrappers. 1900 */ 1901 #if defined(__cplusplus) 1902 #define EXTERN_C_BEGIN extern "C" { 1903 #define EXTERN_C_END } 1904 #else 1905 #define EXTERN_C_BEGIN 1906 #define EXTERN_C_END 1907 #endif 1908 1909 /* --------------------------------------------------------------------*/ 1910 1911 /*MC 1912 MPI_Comm - the basic object used by MPI to determine which processes are involved in a 1913 communication 1914 1915 Level: beginner 1916 1917 Note: This manual page is a place-holder because MPICH does not have a manual page for MPI_Comm 1918 1919 .seealso: `PETSC_COMM_WORLD`, `PETSC_COMM_SELF` 1920 M*/ 1921 1922 #if defined(PETSC_HAVE_MPIIO) 1923 PETSC_EXTERN PetscErrorCode MPIU_File_write_all(MPI_File, void *, PetscMPIInt, MPI_Datatype, MPI_Status *) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(2, 4); 1924 PETSC_EXTERN PetscErrorCode MPIU_File_read_all(MPI_File, void *, PetscMPIInt, MPI_Datatype, MPI_Status *) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(2, 4); 1925 PETSC_EXTERN PetscErrorCode MPIU_File_write_at(MPI_File, MPI_Offset, void *, PetscMPIInt, MPI_Datatype, MPI_Status *) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(3, 5); 1926 PETSC_EXTERN PetscErrorCode MPIU_File_read_at(MPI_File, MPI_Offset, void *, PetscMPIInt, MPI_Datatype, MPI_Status *) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(3, 5); 1927 PETSC_EXTERN PetscErrorCode MPIU_File_write_at_all(MPI_File, MPI_Offset, void *, PetscMPIInt, MPI_Datatype, MPI_Status *) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(3, 5); 1928 PETSC_EXTERN PetscErrorCode MPIU_File_read_at_all(MPI_File, MPI_Offset, void *, PetscMPIInt, MPI_Datatype, MPI_Status *) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(3, 5); 1929 #endif 1930 1931 /* the following petsc_static_inline require petscerror.h */ 1932 1933 /* Limit MPI to 32-bits */ 1934 #define PETSC_MPI_INT_MAX 2147483647 1935 #define PETSC_MPI_INT_MIN -2147483647 1936 /* Limit BLAS to 32-bits */ 1937 #define PETSC_BLAS_INT_MAX 2147483647 1938 #define PETSC_BLAS_INT_MIN -2147483647 1939 #define PETSC_CUBLAS_INT_MAX 2147483647 1940 #define PETSC_HIPBLAS_INT_MAX 2147483647 1941 1942 /*@C 1943 PetscIntCast - casts a `PetscInt64` (which is 64 bits in size) to a `PetscInt` (which may be 32 bits in size), generates an 1944 error if the `PetscInt` is not large enough to hold the number. 1945 1946 Not Collective 1947 1948 Input Parameter: 1949 . a - the `PetscInt64` value 1950 1951 Output Parameter: 1952 . b - the resulting `PetscInt` value 1953 1954 Level: advanced 1955 1956 Notes: 1957 If integers needed for the applications are too large to fit in 32 bit ints you can ./configure using --with-64-bit-indices to make `PetscInt` use 64 bit ints 1958 1959 Not available from Fortran 1960 1961 .seealso: `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscMPIIntCast()`, `PetscBLASIntCast()`, `PetscIntMultError()`, `PetscIntSumError()` 1962 @*/ 1963 static inline PetscErrorCode PetscIntCast(PetscInt64 a, PetscInt *b) 1964 { 1965 PetscFunctionBegin; 1966 #if !defined(PETSC_USE_64BIT_INDICES) 1967 if (a > PETSC_MAX_INT) { 1968 *b = 0; 1969 SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "%" PetscInt64_FMT " is too big for PetscInt, you may need to ./configure using --with-64-bit-indices", a); 1970 } 1971 #endif 1972 *b = (PetscInt)(a); 1973 PetscFunctionReturn(0); 1974 } 1975 1976 /*@C 1977 PetscCountCast - casts a `PetscCount` to a `PetscInt` (which may be 32 bits in size), generates an 1978 error if the `PetscInt` is not large enough to hold the number. 1979 1980 Not Collective 1981 1982 Input Parameter: 1983 . a - the `PetscCount` value 1984 1985 Output Parameter: 1986 . b - the resulting `PetscInt` value 1987 1988 Level: advanced 1989 1990 Notes: 1991 If integers needed for the applications are too large to fit in 32 bit ints you can ./configure using --with-64-bit-indices to make PetscInt use 64 bit ints 1992 1993 Not available from Fortran 1994 1995 .seealso: `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscMPIIntCast()`, `PetscBLASIntCast()`, `PetscIntMultError()`, `PetscIntSumError()`, `PetscIntCast()` 1996 @*/ 1997 static inline PetscErrorCode PetscCountCast(PetscCount a, PetscInt *b) 1998 { 1999 PetscFunctionBegin; 2000 if (sizeof(PetscCount) > sizeof(PetscInt) && a > PETSC_MAX_INT) { 2001 *b = 0; 2002 SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "%" PetscCount_FMT " is too big for PetscInt, you may need to ./configure using --with-64-bit-indices", a); 2003 } 2004 *b = (PetscInt)(a); 2005 PetscFunctionReturn(0); 2006 } 2007 2008 /*@C 2009 PetscBLASIntCast - casts a `PetscInt` (which may be 64 bits in size) to a `PetscBLASInt` (which may be 32 bits in size), generates an 2010 error if the `PetscBLASInt` is not large enough to hold the number. 2011 2012 Not Collective 2013 2014 Input Parameter: 2015 . a - the `PetscInt` value 2016 2017 Output Parameter: 2018 . b - the resulting `PetscBLASInt` value 2019 2020 Level: advanced 2021 2022 Notes: 2023 Not available from Fortran 2024 2025 Errors if the integer is negative since PETSc calls to BLAS/LAPACK never need to cast negative integer inputs 2026 2027 .seealso: `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscMPIIntCast()`, `PetscIntCast()`, `PetscCountCast()` 2028 @*/ 2029 static inline PetscErrorCode PetscBLASIntCast(PetscInt a, PetscBLASInt *b) 2030 { 2031 PetscFunctionBegin; 2032 *b = 0; 2033 if (PetscDefined(USE_64BIT_INDICES) && !PetscDefined(HAVE_64BIT_BLAS_INDICES)) { 2034 PetscCheck(a <= PETSC_BLAS_INT_MAX, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "%" PetscInt_FMT " is too big for BLAS/LAPACK, which is restricted to 32 bit integers. Either you have an invalidly large integer error in your code or you must ./configure PETSc with --with-64-bit-blas-indices for the case you are running", a); 2035 } 2036 PetscCheck(a >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Passing negative integer to BLAS/LAPACK routine"); 2037 *b = (PetscBLASInt)(a); 2038 PetscFunctionReturn(0); 2039 } 2040 2041 /*@C 2042 PetscCuBLASIntCast - like `PetscBLASIntCast()`, but for `PetscCuBLASInt`. 2043 2044 Not Collective 2045 2046 Input Parameter: 2047 . a - the `PetscInt` value 2048 2049 Output Parameter: 2050 . b - the resulting `PetscCuBLASInt` value 2051 2052 Level: advanced 2053 2054 Notes: 2055 Errors if the integer is negative since PETSc calls to cuBLAS and friends never need to cast negative integer inputs 2056 2057 .seealso: `PetscCuBLASInt`, `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscBLASIntCast()`, `PetscMPIIntCast()`, `PetscIntCast()` 2058 @*/ 2059 static inline PetscErrorCode PetscCuBLASIntCast(PetscInt a, PetscCuBLASInt *b) 2060 { 2061 PetscFunctionBegin; 2062 *b = 0; 2063 if (PetscDefined(USE_64BIT_INDICES)) PetscCheck(a <= PETSC_CUBLAS_INT_MAX, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "%" PetscInt_FMT " is too big for cuBLAS, which is restricted to 32 bit integers.", a); 2064 PetscCheck(a >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Passing negative integer to cuBLAS routine"); 2065 *b = (PetscCuBLASInt)(a); 2066 PetscFunctionReturn(0); 2067 } 2068 2069 /*@C 2070 PetscHipBLASIntCast - like `PetscBLASIntCast()`, but for `PetscHipBLASInt`. 2071 2072 Not Collective 2073 2074 Input Parameter: 2075 . a - the `PetscInt` value 2076 2077 Output Parameter: 2078 . b - the resulting `PetscHipBLASInt` value 2079 2080 Level: advanced 2081 2082 Notes: 2083 Errors if the integer is negative since PETSc calls to hipBLAS and friends never need to cast negative integer inputs 2084 2085 .seealso: `PetscHipBLASInt`, `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscBLASIntCast()`, `PetscMPIIntCast()`, `PetscIntCast()` 2086 @*/ 2087 static inline PetscErrorCode PetscHipBLASIntCast(PetscInt a, PetscHipBLASInt *b) 2088 { 2089 PetscFunctionBegin; 2090 *b = 0; 2091 if (PetscDefined(USE_64BIT_INDICES)) PetscCheck(a <= PETSC_HIPBLAS_INT_MAX, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "%" PetscInt_FMT " is too big for hipBLAS, which is restricted to 32 bit integers.", a); 2092 PetscCheck(a >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Passing negative integer to hipBLAS routine"); 2093 *b = (PetscHipBLASInt)(a); 2094 PetscFunctionReturn(0); 2095 } 2096 2097 /*@C 2098 PetscMPIIntCast - casts a PetscInt (which may be 64 bits in size) to a PetscMPIInt (which may be 32 bits in size), generates an 2099 error if the PetscMPIInt is not large enough to hold the number. 2100 2101 Not Collective 2102 2103 Input Parameter: 2104 . a - the `PetscInt` value 2105 2106 Output Parameter: 2107 . b - the resulting `PetscMPIInt` value 2108 2109 Level: advanced 2110 2111 Not available from Fortran 2112 2113 .seealso: `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscBLASIntCast()`, `PetscIntCast()` 2114 @*/ 2115 static inline PetscErrorCode PetscMPIIntCast(PetscInt a, PetscMPIInt *b) 2116 { 2117 PetscFunctionBegin; 2118 *b = 0; 2119 if (PetscDefined(USE_64BIT_INDICES)) PetscCheck(a <= PETSC_MPI_INT_MAX, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "%" PetscInt_FMT " is too big for MPI buffer length. We currently only support 32 bit integers", a); 2120 *b = (PetscMPIInt)(a); 2121 PetscFunctionReturn(0); 2122 } 2123 2124 #define PetscInt64Mult(a, b) ((PetscInt64)(a)) * ((PetscInt64)(b)) 2125 2126 /*@C 2127 2128 PetscRealIntMultTruncate - Computes the product of a positive `PetscReal` and a positive `PetscInt` and truncates the value to slightly less than the maximal possible value 2129 2130 Not Collective 2131 2132 Input Parameters: 2133 + a - the `PetscReal` value 2134 - b - the second value 2135 2136 Returns: 2137 the result as a `PetscInt` value 2138 2139 Use `PetscInt64Mult()` to compute the product of two `PetscInt` as a `PetscInt64` 2140 Use `PetscIntMultTruncate()` to compute the product of two positive `PetscInt` and truncate to fit a `PetscInt` 2141 Use `PetscIntMultError()` to compute the product of two `PetscInt` if you wish to generate an error if the result will not fit in a `PetscInt` 2142 2143 Developers Note: 2144 We currently assume that `PetscInt` addition can never overflow, this is obviously wrong but requires many more checks. 2145 2146 This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able. 2147 2148 Not available from Fortran 2149 2150 Level: advanced 2151 2152 .seealso: `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscBLASIntCast()`, `PetscInt64Mult()`, `PetscIntMultError()`, `PetscIntSumError()` 2153 @*/ 2154 static inline PetscInt PetscRealIntMultTruncate(PetscReal a, PetscInt b) 2155 { 2156 PetscInt64 r = (PetscInt64)(a * (PetscReal)b); 2157 if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100; 2158 return (PetscInt)r; 2159 } 2160 2161 /*@C 2162 2163 PetscIntMultTruncate - Computes the product of two positive `PetscInt` and truncates the value to slightly less than the maximal possible value 2164 2165 Not Collective 2166 2167 Input Parameters: 2168 + a - the PetscInt value 2169 - b - the second value 2170 2171 Returns: 2172 the result as a `PetscInt` value 2173 2174 Use `PetscInt64Mult()` to compute the product of two `PetscInt` as a `PetscInt64` 2175 Use `PetscRealIntMultTruncate()` to compute the product of a `PetscReal` and a `PetscInt` and truncate to fit a `PetscInt` 2176 Use `PetscIntMultError()` to compute the product of two `PetscInt` if you wish to generate an error if the result will not fit in a `PetscInt` 2177 2178 Not available from Fortran 2179 2180 Developers Note: 2181 We currently assume that `PetscInt` addition can never overflow, this is obviously wrong but requires many more checks. 2182 2183 This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able. 2184 2185 Level: advanced 2186 2187 .seealso: `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscBLASIntCast()`, `PetscInt64Mult()`, `PetscIntMultError()`, `PetscIntSumError()` 2188 @*/ 2189 static inline PetscInt PetscIntMultTruncate(PetscInt a, PetscInt b) 2190 { 2191 PetscInt64 r = PetscInt64Mult(a, b); 2192 if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100; 2193 return (PetscInt)r; 2194 } 2195 2196 /*@C 2197 2198 PetscIntSumTruncate - Computes the sum of two positive `PetscInt` and truncates the value to slightly less than the maximal possible value 2199 2200 Not Collective 2201 2202 Input Parameters: 2203 + a - the `PetscInt` value 2204 - b - the second value 2205 2206 Returns: 2207 the result as a `PetscInt` value 2208 2209 Use `PetscInt64Mult()` to compute the product of two `PetscInt` as a `PetscInt64` 2210 Use `PetscRealIntMultTruncate()` to compute the product of a `PetscReal` and a `PetscInt` and truncate to fit a `PetscInt` 2211 Use `PetscIntMultError()` to compute the product of two `PetscInt` if you wish to generate an error if the result will not fit in a `PetscInt` 2212 2213 This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able. 2214 2215 Not available from Fortran 2216 2217 Level: advanced 2218 2219 .seealso: `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscBLASIntCast()`, `PetscInt64Mult()`, `PetscIntMultError()` 2220 @*/ 2221 static inline PetscInt PetscIntSumTruncate(PetscInt a, PetscInt b) 2222 { 2223 PetscInt64 r = ((PetscInt64)a) + ((PetscInt64)b); 2224 if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100; 2225 return (PetscInt)r; 2226 } 2227 2228 /*@C 2229 2230 PetscIntMultError - Computes the product of two positive `PetscInt` and generates an error with overflow. 2231 2232 Not Collective 2233 2234 Input Parameters: 2235 + a - the `PetscInt` value 2236 - b - the second value 2237 2238 Output Parameter: 2239 . result - the result as a `PetscInt` value, or NULL if you do not want the result, you just want to check if it overflows 2240 2241 Use `PetscInt64Mult()` to compute the product of two `PetscInt` and store in a `PetscInt64` 2242 Use `PetscIntMultTruncate()` to compute the product of two `PetscInt` and truncate it to fit in a `PetscInt` 2243 2244 Not available from Fortran 2245 2246 Developers Note: 2247 We currently assume that `PetscInt` addition does not overflow, this is obviously wrong but requires many more checks. 2248 2249 Level: advanced 2250 2251 .seealso: `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscBLASIntCast()`, `PetscIntMult64()`, `PetscIntSumError()` 2252 @*/ 2253 static inline PetscErrorCode PetscIntMultError(PetscInt a, PetscInt b, PetscInt *result) 2254 { 2255 PetscInt64 r; 2256 2257 PetscFunctionBegin; 2258 r = PetscInt64Mult(a, b); 2259 #if !defined(PETSC_USE_64BIT_INDICES) 2260 PetscCheck(r <= PETSC_MAX_INT, PETSC_COMM_SELF, PETSC_ERR_SUP, "Product of two integers %d %d overflow, either you have an invalidly large integer error in your code or you must ./configure PETSc with --with-64-bit-indices for the case you are running", a, b); 2261 #endif 2262 if (result) *result = (PetscInt)r; 2263 PetscFunctionReturn(0); 2264 } 2265 2266 /*@C 2267 2268 PetscIntSumError - Computes the sum of two positive `PetscInt` and generates an error with overflow. 2269 2270 Not Collective 2271 2272 Input Parameters: 2273 + a - the `PetscInt` value 2274 - b - the second value 2275 2276 Output Parameter: 2277 . c - the result as a `PetscInt` value, or NULL if you do not want the result, you just want to check if it overflows 2278 2279 Use `PetscInt64Mult()` to compute the product of two 32 bit PetscInt and store in a `PetscInt64` 2280 Use `PetscIntMultTruncate()` to compute the product of two `PetscInt` and truncate it to fit in a `PetscInt` 2281 2282 Not available from Fortran 2283 2284 Level: advanced 2285 2286 .seealso: `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscBLASIntCast()`, `PetscInt64Mult()`, `PetscIntMultError()` 2287 @*/ 2288 static inline PetscErrorCode PetscIntSumError(PetscInt a, PetscInt b, PetscInt *result) 2289 { 2290 PetscInt64 r; 2291 2292 PetscFunctionBegin; 2293 r = ((PetscInt64)a) + ((PetscInt64)b); 2294 #if !defined(PETSC_USE_64BIT_INDICES) 2295 PetscCheck(r <= PETSC_MAX_INT, PETSC_COMM_SELF, PETSC_ERR_SUP, "Sum of two integers %d %d overflow, either you have an invalidly large integer error in your code or you must ./configure PETSc with --with-64-bit-indices for the case you are running", a, b); 2296 #endif 2297 if (result) *result = (PetscInt)r; 2298 PetscFunctionReturn(0); 2299 } 2300 2301 /* 2302 The IBM include files define hz, here we hide it so that it may be used as a regular user variable. 2303 */ 2304 #if defined(hz) 2305 #undef hz 2306 #endif 2307 2308 #include <limits.h> 2309 2310 /* The number of bits in a byte */ 2311 2312 #define PETSC_BITS_PER_BYTE CHAR_BIT 2313 2314 #if defined(PETSC_HAVE_SYS_TYPES_H) 2315 #include <sys/types.h> 2316 #endif 2317 2318 /*MC 2319 2320 PETSC_VERSION - This manual page provides information about how PETSc documents and uses its version information. This information is available to both C/C++ 2321 and Fortran compilers when petscsys.h is included. 2322 2323 The current PETSc version and the API for accessing it are defined in <A HREF="PETSC_DOC_OUT_ROOT_PLACEHOLDER/include/petscversion.h.html">include/petscverson.html</A> 2324 2325 The complete version number is given as the triple PETSC_VERSION_MAJOR.PETSC_VERSION_MINOR.PETSC_VERSION_SUBMINOR (in short hand x.y.z) 2326 2327 A change in the minor version number (y) indicates possible/likely changes in the PETSc API. Note this is different than with the semantic versioning convention 2328 where only a change in the major version number (x) indicates a change in the API. 2329 2330 A subminor greater than zero indicates a patch release. Version x.y.z maintains source and binary compatibility with version x.y.w for all z and w 2331 2332 Use the macros PETSC_VERSION_EQ(x,y,z), PETSC_VERSION_LT(x,y,z), PETSC_VERSION_LE(x,y,z), PETSC_VERSION_GT(x,y,z), 2333 PETSC_VERSION_GE(x,y,z) to determine if the current version is equal to, less than, less than or equal to, greater than or greater than or equal to a given 2334 version number (x.y.z). 2335 2336 `PETSC_RELEASE_DATE` is the date the x.y version was released (i.e. the version before any patch releases) 2337 2338 `PETSC_VERSION_DATE` is the date the x.y.z version was released 2339 2340 `PETSC_VERSION_GIT` is the last git commit to the repository given in the form vx.y.z-wwwww 2341 2342 `PETSC_VERSION_DATE_GIT` is the date of the last git commit to the repository 2343 2344 `PETSC_VERSION_()` is deprecated and will eventually be removed. 2345 2346 Level: intermediate 2347 2348 M*/ 2349 2350 PETSC_EXTERN PetscErrorCode PetscGetArchType(char[], size_t); 2351 PETSC_EXTERN PetscErrorCode PetscGetHostName(char[], size_t); 2352 PETSC_EXTERN PetscErrorCode PetscGetUserName(char[], size_t); 2353 PETSC_EXTERN PetscErrorCode PetscGetProgramName(char[], size_t); 2354 PETSC_EXTERN PetscErrorCode PetscSetProgramName(const char[]); 2355 PETSC_EXTERN PetscErrorCode PetscGetDate(char[], size_t); 2356 PETSC_EXTERN PetscErrorCode PetscGetVersion(char[], size_t); 2357 PETSC_EXTERN PetscErrorCode PetscGetVersionNumber(PetscInt *, PetscInt *, PetscInt *, PetscInt *); 2358 2359 PETSC_EXTERN PetscErrorCode PetscSortedInt(PetscInt, const PetscInt[], PetscBool *); 2360 PETSC_EXTERN PetscErrorCode PetscSortedInt64(PetscInt, const PetscInt64[], PetscBool *); 2361 PETSC_EXTERN PetscErrorCode PetscSortedMPIInt(PetscInt, const PetscMPIInt[], PetscBool *); 2362 PETSC_EXTERN PetscErrorCode PetscSortedReal(PetscInt, const PetscReal[], PetscBool *); 2363 PETSC_EXTERN PetscErrorCode PetscSortInt(PetscInt, PetscInt[]); 2364 PETSC_EXTERN PetscErrorCode PetscSortInt64(PetscInt, PetscInt64[]); 2365 PETSC_EXTERN PetscErrorCode PetscSortCount(PetscInt, PetscCount[]); 2366 PETSC_EXTERN PetscErrorCode PetscSortReverseInt(PetscInt, PetscInt[]); 2367 PETSC_EXTERN PetscErrorCode PetscSortedRemoveDupsInt(PetscInt *, PetscInt[]); 2368 PETSC_EXTERN PetscErrorCode PetscSortedCheckDupsInt(PetscInt, const PetscInt[], PetscBool *); 2369 PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsInt(PetscInt *, PetscInt[]); 2370 PETSC_EXTERN PetscErrorCode PetscCheckDupsInt(PetscInt, const PetscInt[], PetscBool *); 2371 PETSC_EXTERN PetscErrorCode PetscFindInt(PetscInt, PetscInt, const PetscInt[], PetscInt *); 2372 PETSC_EXTERN PetscErrorCode PetscFindMPIInt(PetscMPIInt, PetscInt, const PetscMPIInt[], PetscInt *); 2373 PETSC_EXTERN PetscErrorCode PetscSortIntWithPermutation(PetscInt, const PetscInt[], PetscInt[]); 2374 PETSC_EXTERN PetscErrorCode PetscSortStrWithPermutation(PetscInt, const char *[], PetscInt[]); 2375 PETSC_EXTERN PetscErrorCode PetscSortIntWithArray(PetscInt, PetscInt[], PetscInt[]); 2376 PETSC_EXTERN PetscErrorCode PetscSortIntWithCountArray(PetscCount, PetscInt[], PetscCount[]); 2377 PETSC_EXTERN PetscErrorCode PetscSortIntWithArrayPair(PetscInt, PetscInt[], PetscInt[], PetscInt[]); 2378 PETSC_EXTERN PetscErrorCode PetscSortIntWithIntCountArrayPair(PetscCount, PetscInt[], PetscInt[], PetscCount[]); 2379 PETSC_EXTERN PetscErrorCode PetscSortMPIInt(PetscInt, PetscMPIInt[]); 2380 PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsMPIInt(PetscInt *, PetscMPIInt[]); 2381 PETSC_EXTERN PetscErrorCode PetscSortMPIIntWithArray(PetscMPIInt, PetscMPIInt[], PetscMPIInt[]); 2382 PETSC_EXTERN PetscErrorCode PetscSortMPIIntWithIntArray(PetscMPIInt, PetscMPIInt[], PetscInt[]); 2383 PETSC_EXTERN PetscErrorCode PetscSortIntWithScalarArray(PetscInt, PetscInt[], PetscScalar[]); 2384 PETSC_EXTERN PetscErrorCode PetscSortIntWithDataArray(PetscInt, PetscInt[], void *, size_t, void *); 2385 PETSC_EXTERN PetscErrorCode PetscSortReal(PetscInt, PetscReal[]); 2386 PETSC_EXTERN PetscErrorCode PetscSortRealWithArrayInt(PetscInt, PetscReal[], PetscInt[]); 2387 PETSC_EXTERN PetscErrorCode PetscSortRealWithPermutation(PetscInt, const PetscReal[], PetscInt[]); 2388 PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsReal(PetscInt *, PetscReal[]); 2389 PETSC_EXTERN PetscErrorCode PetscFindReal(PetscReal, PetscInt, const PetscReal[], PetscReal, PetscInt *); 2390 PETSC_EXTERN PetscErrorCode PetscSortSplit(PetscInt, PetscInt, PetscScalar[], PetscInt[]); 2391 PETSC_EXTERN PetscErrorCode PetscSortSplitReal(PetscInt, PetscInt, PetscReal[], PetscInt[]); 2392 PETSC_EXTERN PetscErrorCode PetscProcessTree(PetscInt, const PetscBool[], const PetscInt[], PetscInt *, PetscInt **, PetscInt **, PetscInt **, PetscInt **); 2393 PETSC_EXTERN PetscErrorCode PetscMergeIntArrayPair(PetscInt, const PetscInt[], const PetscInt[], PetscInt, const PetscInt[], const PetscInt[], PetscInt *, PetscInt **, PetscInt **); 2394 PETSC_EXTERN PetscErrorCode PetscMergeIntArray(PetscInt, const PetscInt[], PetscInt, const PetscInt[], PetscInt *, PetscInt **); 2395 PETSC_EXTERN PetscErrorCode PetscMergeMPIIntArray(PetscInt, const PetscMPIInt[], PetscInt, const PetscMPIInt[], PetscInt *, PetscMPIInt **); 2396 PETSC_EXTERN PetscErrorCode PetscParallelSortedInt(MPI_Comm, PetscInt, const PetscInt[], PetscBool *); 2397 2398 PETSC_EXTERN PetscErrorCode PetscTimSort(PetscInt, void *, size_t, int (*)(const void *, const void *, void *), void *); 2399 PETSC_EXTERN PetscErrorCode PetscIntSortSemiOrdered(PetscInt, PetscInt[]); 2400 PETSC_EXTERN PetscErrorCode PetscMPIIntSortSemiOrdered(PetscInt, PetscMPIInt[]); 2401 PETSC_EXTERN PetscErrorCode PetscRealSortSemiOrdered(PetscInt, PetscReal[]); 2402 PETSC_EXTERN PetscErrorCode PetscTimSortWithArray(PetscInt, void *, size_t, void *, size_t, int (*)(const void *, const void *, void *), void *); 2403 PETSC_EXTERN PetscErrorCode PetscIntSortSemiOrderedWithArray(PetscInt, PetscInt[], PetscInt[]); 2404 PETSC_EXTERN PetscErrorCode PetscMPIIntSortSemiOrderedWithArray(PetscInt, PetscMPIInt[], PetscMPIInt[]); 2405 PETSC_EXTERN PetscErrorCode PetscRealSortSemiOrderedWithArrayInt(PetscInt, PetscReal[], PetscInt[]); 2406 2407 PETSC_EXTERN PetscErrorCode PetscSetDisplay(void); 2408 PETSC_EXTERN PetscErrorCode PetscGetDisplay(char[], size_t); 2409 2410 /*J 2411 PetscRandomType - String with the name of a PETSc randomizer 2412 2413 Level: beginner 2414 2415 Notes: 2416 To use `PETSCSPRNG` or `PETSCRANDOM123` you must have ./configure PETSc 2417 with the option --download-sprng or --download-random123 2418 2419 .seealso: `PetscRandomSetType()`, `PetscRandom`, `PetscRandomCreate()` 2420 J*/ 2421 typedef const char *PetscRandomType; 2422 #define PETSCRAND "rand" 2423 #define PETSCRAND48 "rand48" 2424 #define PETSCSPRNG "sprng" 2425 #define PETSCRANDER48 "rander48" 2426 #define PETSCRANDOM123 "random123" 2427 #define PETSCCURAND "curand" 2428 2429 /* Logging support */ 2430 PETSC_EXTERN PetscClassId PETSC_RANDOM_CLASSID; 2431 2432 PETSC_EXTERN PetscErrorCode PetscRandomInitializePackage(void); 2433 2434 /* Dynamic creation and loading functions */ 2435 PETSC_EXTERN PetscFunctionList PetscRandomList; 2436 2437 PETSC_EXTERN PetscErrorCode PetscRandomRegister(const char[], PetscErrorCode (*)(PetscRandom)); 2438 PETSC_EXTERN PetscErrorCode PetscRandomSetType(PetscRandom, PetscRandomType); 2439 PETSC_EXTERN PetscErrorCode PetscRandomSetFromOptions(PetscRandom); 2440 PETSC_EXTERN PetscErrorCode PetscRandomGetType(PetscRandom, PetscRandomType *); 2441 PETSC_EXTERN PetscErrorCode PetscRandomViewFromOptions(PetscRandom, PetscObject, const char[]); 2442 PETSC_EXTERN PetscErrorCode PetscRandomView(PetscRandom, PetscViewer); 2443 2444 PETSC_EXTERN PetscErrorCode PetscRandomCreate(MPI_Comm, PetscRandom *); 2445 PETSC_EXTERN PetscErrorCode PetscRandomGetValue(PetscRandom, PetscScalar *); 2446 PETSC_EXTERN PetscErrorCode PetscRandomGetValueReal(PetscRandom, PetscReal *); 2447 PETSC_EXTERN PetscErrorCode PetscRandomGetValues(PetscRandom, PetscInt, PetscScalar *); 2448 PETSC_EXTERN PetscErrorCode PetscRandomGetValuesReal(PetscRandom, PetscInt, PetscReal *); 2449 PETSC_EXTERN PetscErrorCode PetscRandomGetInterval(PetscRandom, PetscScalar *, PetscScalar *); 2450 PETSC_EXTERN PetscErrorCode PetscRandomSetInterval(PetscRandom, PetscScalar, PetscScalar); 2451 PETSC_EXTERN PetscErrorCode PetscRandomSetSeed(PetscRandom, unsigned long); 2452 PETSC_EXTERN PetscErrorCode PetscRandomGetSeed(PetscRandom, unsigned long *); 2453 PETSC_EXTERN PetscErrorCode PetscRandomSeed(PetscRandom); 2454 PETSC_EXTERN PetscErrorCode PetscRandomDestroy(PetscRandom *); 2455 2456 PETSC_EXTERN PetscErrorCode PetscGetFullPath(const char[], char[], size_t); 2457 PETSC_EXTERN PetscErrorCode PetscGetRelativePath(const char[], char[], size_t); 2458 PETSC_EXTERN PetscErrorCode PetscGetWorkingDirectory(char[], size_t); 2459 PETSC_EXTERN PetscErrorCode PetscGetRealPath(const char[], char[]); 2460 PETSC_EXTERN PetscErrorCode PetscGetHomeDirectory(char[], size_t); 2461 PETSC_EXTERN PetscErrorCode PetscTestFile(const char[], char, PetscBool *); 2462 PETSC_EXTERN PetscErrorCode PetscTestDirectory(const char[], char, PetscBool *); 2463 PETSC_EXTERN PetscErrorCode PetscMkdir(const char[]); 2464 PETSC_EXTERN PetscErrorCode PetscMkdtemp(char[]); 2465 PETSC_EXTERN PetscErrorCode PetscRMTree(const char[]); 2466 2467 static inline PetscBool PetscBinaryBigEndian(void) 2468 { 2469 long _petsc_v = 1; 2470 return ((char *)&_petsc_v)[0] ? PETSC_FALSE : PETSC_TRUE; 2471 } 2472 2473 PETSC_EXTERN PetscErrorCode PetscBinaryRead(int, void *, PetscInt, PetscInt *, PetscDataType); 2474 PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedRead(MPI_Comm, int, void *, PetscInt, PetscInt *, PetscDataType); 2475 PETSC_EXTERN PetscErrorCode PetscBinaryWrite(int, const void *, PetscInt, PetscDataType); 2476 PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedWrite(MPI_Comm, int, const void *, PetscInt, PetscDataType); 2477 PETSC_EXTERN PetscErrorCode PetscBinaryOpen(const char[], PetscFileMode, int *); 2478 PETSC_EXTERN PetscErrorCode PetscBinaryClose(int); 2479 PETSC_EXTERN PetscErrorCode PetscSharedTmp(MPI_Comm, PetscBool *); 2480 PETSC_EXTERN PetscErrorCode PetscSharedWorkingDirectory(MPI_Comm, PetscBool *); 2481 PETSC_EXTERN PetscErrorCode PetscGetTmp(MPI_Comm, char[], size_t); 2482 PETSC_EXTERN PetscErrorCode PetscFileRetrieve(MPI_Comm, const char[], char[], size_t, PetscBool *); 2483 PETSC_EXTERN PetscErrorCode PetscLs(MPI_Comm, const char[], char[], size_t, PetscBool *); 2484 #if defined(PETSC_USE_SOCKET_VIEWER) 2485 PETSC_EXTERN PetscErrorCode PetscOpenSocket(const char[], int, int *); 2486 #endif 2487 2488 PETSC_EXTERN PetscErrorCode PetscBinarySeek(int, off_t, PetscBinarySeekType, off_t *); 2489 PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedSeek(MPI_Comm, int, off_t, PetscBinarySeekType, off_t *); 2490 PETSC_EXTERN PetscErrorCode PetscByteSwap(void *, PetscDataType, PetscInt); 2491 2492 PETSC_EXTERN PetscErrorCode PetscSetDebugTerminal(const char[]); 2493 PETSC_EXTERN PetscErrorCode PetscSetDebugger(const char[], PetscBool); 2494 PETSC_EXTERN PetscErrorCode PetscSetDefaultDebugger(void); 2495 PETSC_EXTERN PetscErrorCode PetscSetDebuggerFromString(const char *); 2496 PETSC_EXTERN PetscErrorCode PetscAttachDebugger(void); 2497 PETSC_EXTERN PetscErrorCode PetscStopForDebugger(void); 2498 PETSC_EXTERN PetscErrorCode PetscWaitOnError(void); 2499 2500 PETSC_EXTERN PetscErrorCode PetscGatherNumberOfMessages(MPI_Comm, const PetscMPIInt[], const PetscMPIInt[], PetscMPIInt *); 2501 PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths(MPI_Comm, PetscMPIInt, PetscMPIInt, const PetscMPIInt[], PetscMPIInt **, PetscMPIInt **); 2502 PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths2(MPI_Comm, PetscMPIInt, PetscMPIInt, const PetscMPIInt[], const PetscMPIInt[], PetscMPIInt **, PetscMPIInt **, PetscMPIInt **); 2503 PETSC_EXTERN PetscErrorCode PetscPostIrecvInt(MPI_Comm, PetscMPIInt, PetscMPIInt, const PetscMPIInt[], const PetscMPIInt[], PetscInt ***, MPI_Request **); 2504 PETSC_EXTERN PetscErrorCode PetscPostIrecvScalar(MPI_Comm, PetscMPIInt, PetscMPIInt, const PetscMPIInt[], const PetscMPIInt[], PetscScalar ***, MPI_Request **); 2505 PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSided(MPI_Comm, PetscMPIInt, MPI_Datatype, PetscMPIInt, const PetscMPIInt *, const void *, PetscMPIInt *, PetscMPIInt **, void *) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(6, 3); 2506 PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedF(MPI_Comm, PetscMPIInt, MPI_Datatype, PetscMPIInt, const PetscMPIInt[], const void *, PetscMPIInt *, PetscMPIInt **, void *, PetscMPIInt, PetscErrorCode (*send)(MPI_Comm, const PetscMPIInt[], PetscMPIInt, PetscMPIInt, void *, MPI_Request[], void *), PetscErrorCode (*recv)(MPI_Comm, const PetscMPIInt[], PetscMPIInt, void *, MPI_Request[], void *), void *ctx) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(6, 3); 2507 PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedFReq(MPI_Comm, PetscMPIInt, MPI_Datatype, PetscMPIInt, const PetscMPIInt[], const void *, PetscMPIInt *, PetscMPIInt **, void *, PetscMPIInt, MPI_Request **, MPI_Request **, PetscErrorCode (*send)(MPI_Comm, const PetscMPIInt[], PetscMPIInt, PetscMPIInt, void *, MPI_Request[], void *), PetscErrorCode (*recv)(MPI_Comm, const PetscMPIInt[], PetscMPIInt, void *, MPI_Request[], void *), void *ctx) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(6, 3); 2508 2509 PETSC_EXTERN const char *const PetscBuildTwoSidedTypes[]; 2510 PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedSetType(MPI_Comm, PetscBuildTwoSidedType); 2511 PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedGetType(MPI_Comm, PetscBuildTwoSidedType *); 2512 2513 PETSC_EXTERN PetscErrorCode PetscSSEIsEnabled(MPI_Comm, PetscBool *, PetscBool *); 2514 2515 PETSC_EXTERN MPI_Comm PetscObjectComm(PetscObject); 2516 2517 PETSC_EXTERN const char *const PetscSubcommTypes[]; 2518 2519 struct _n_PetscSubcomm { 2520 MPI_Comm parent; /* parent communicator */ 2521 MPI_Comm dupparent; /* duplicate parent communicator, under which the processors of this subcomm have contiguous rank */ 2522 MPI_Comm child; /* the sub-communicator */ 2523 PetscMPIInt n; /* num of subcommunicators under the parent communicator */ 2524 PetscMPIInt color; /* color of processors belong to this communicator */ 2525 PetscMPIInt *subsize; /* size of subcommunicator[color] */ 2526 PetscSubcommType type; 2527 char *subcommprefix; 2528 }; 2529 2530 static inline MPI_Comm PetscSubcommParent(PetscSubcomm scomm) 2531 { 2532 return scomm->parent; 2533 } 2534 static inline MPI_Comm PetscSubcommChild(PetscSubcomm scomm) 2535 { 2536 return scomm->child; 2537 } 2538 static inline MPI_Comm PetscSubcommContiguousParent(PetscSubcomm scomm) 2539 { 2540 return scomm->dupparent; 2541 } 2542 PETSC_EXTERN PetscErrorCode PetscSubcommCreate(MPI_Comm, PetscSubcomm *); 2543 PETSC_EXTERN PetscErrorCode PetscSubcommDestroy(PetscSubcomm *); 2544 PETSC_EXTERN PetscErrorCode PetscSubcommSetNumber(PetscSubcomm, PetscInt); 2545 PETSC_EXTERN PetscErrorCode PetscSubcommSetType(PetscSubcomm, PetscSubcommType); 2546 PETSC_EXTERN PetscErrorCode PetscSubcommSetTypeGeneral(PetscSubcomm, PetscMPIInt, PetscMPIInt); 2547 PETSC_EXTERN PetscErrorCode PetscSubcommView(PetscSubcomm, PetscViewer); 2548 PETSC_EXTERN PetscErrorCode PetscSubcommSetFromOptions(PetscSubcomm); 2549 PETSC_EXTERN PetscErrorCode PetscSubcommSetOptionsPrefix(PetscSubcomm, const char[]); 2550 PETSC_EXTERN PetscErrorCode PetscSubcommGetParent(PetscSubcomm, MPI_Comm *); 2551 PETSC_EXTERN PetscErrorCode PetscSubcommGetContiguousParent(PetscSubcomm, MPI_Comm *); 2552 PETSC_EXTERN PetscErrorCode PetscSubcommGetChild(PetscSubcomm, MPI_Comm *); 2553 2554 PETSC_EXTERN PetscErrorCode PetscHeapCreate(PetscInt, PetscHeap *); 2555 PETSC_EXTERN PetscErrorCode PetscHeapAdd(PetscHeap, PetscInt, PetscInt); 2556 PETSC_EXTERN PetscErrorCode PetscHeapPop(PetscHeap, PetscInt *, PetscInt *); 2557 PETSC_EXTERN PetscErrorCode PetscHeapPeek(PetscHeap, PetscInt *, PetscInt *); 2558 PETSC_EXTERN PetscErrorCode PetscHeapStash(PetscHeap, PetscInt, PetscInt); 2559 PETSC_EXTERN PetscErrorCode PetscHeapUnstash(PetscHeap); 2560 PETSC_EXTERN PetscErrorCode PetscHeapDestroy(PetscHeap *); 2561 PETSC_EXTERN PetscErrorCode PetscHeapView(PetscHeap, PetscViewer); 2562 2563 PETSC_EXTERN PetscErrorCode PetscProcessPlacementView(PetscViewer); 2564 PETSC_EXTERN PetscErrorCode PetscShmCommGet(MPI_Comm, PetscShmComm *); 2565 PETSC_EXTERN PetscErrorCode PetscShmCommGlobalToLocal(PetscShmComm, PetscMPIInt, PetscMPIInt *); 2566 PETSC_EXTERN PetscErrorCode PetscShmCommLocalToGlobal(PetscShmComm, PetscMPIInt, PetscMPIInt *); 2567 PETSC_EXTERN PetscErrorCode PetscShmCommGetMpiShmComm(PetscShmComm, MPI_Comm *); 2568 2569 /* routines to better support OpenMP multithreading needs of some PETSc third party libraries */ 2570 PETSC_EXTERN PetscErrorCode PetscOmpCtrlCreate(MPI_Comm, PetscInt, PetscOmpCtrl *); 2571 PETSC_EXTERN PetscErrorCode PetscOmpCtrlGetOmpComms(PetscOmpCtrl, MPI_Comm *, MPI_Comm *, PetscBool *); 2572 PETSC_EXTERN PetscErrorCode PetscOmpCtrlDestroy(PetscOmpCtrl *); 2573 PETSC_EXTERN PetscErrorCode PetscOmpCtrlBarrier(PetscOmpCtrl); 2574 PETSC_EXTERN PetscErrorCode PetscOmpCtrlOmpRegionOnMasterBegin(PetscOmpCtrl); 2575 PETSC_EXTERN PetscErrorCode PetscOmpCtrlOmpRegionOnMasterEnd(PetscOmpCtrl); 2576 2577 PETSC_EXTERN PetscErrorCode PetscSegBufferCreate(size_t, size_t, PetscSegBuffer *); 2578 PETSC_EXTERN PetscErrorCode PetscSegBufferDestroy(PetscSegBuffer *); 2579 PETSC_EXTERN PetscErrorCode PetscSegBufferGet(PetscSegBuffer, size_t, void *); 2580 PETSC_EXTERN PetscErrorCode PetscSegBufferExtractAlloc(PetscSegBuffer, void *); 2581 PETSC_EXTERN PetscErrorCode PetscSegBufferExtractTo(PetscSegBuffer, void *); 2582 PETSC_EXTERN PetscErrorCode PetscSegBufferExtractInPlace(PetscSegBuffer, void *); 2583 PETSC_EXTERN PetscErrorCode PetscSegBufferGetSize(PetscSegBuffer, size_t *); 2584 PETSC_EXTERN PetscErrorCode PetscSegBufferUnuse(PetscSegBuffer, size_t); 2585 2586 /* Type-safe wrapper to encourage use of PETSC_RESTRICT. Does not use PetscFunctionBegin because the error handling 2587 * prevents the compiler from completely erasing the stub. This is called in inner loops so it has to be as fast as 2588 * possible. */ 2589 static inline PetscErrorCode PetscSegBufferGetInts(PetscSegBuffer seg, size_t count, PetscInt *PETSC_RESTRICT *slot) 2590 { 2591 return PetscSegBufferGet(seg, count, (void **)slot); 2592 } 2593 2594 extern PetscOptionsHelpPrinted PetscOptionsHelpPrintedSingleton; 2595 PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedDestroy(PetscOptionsHelpPrinted *); 2596 PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedCreate(PetscOptionsHelpPrinted *); 2597 PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedCheck(PetscOptionsHelpPrinted, const char *, const char *, PetscBool *); 2598 2599 #include <stdarg.h> 2600 PETSC_EXTERN PetscErrorCode PetscVSNPrintf(char *, size_t, const char[], size_t *, va_list); 2601 PETSC_EXTERN PetscErrorCode (*PetscVFPrintf)(FILE *, const char[], va_list); 2602 2603 PETSC_EXTERN PetscSegBuffer PetscCitationsList; 2604 2605 /*@C 2606 PetscCitationsRegister - Register a bibtex item to obtain credit for an implemented algorithm used in the code. 2607 2608 Not Collective - only what is registered on rank 0 of `PETSC_COMM_WORLD` will be printed 2609 2610 Input Parameters: 2611 + cite - the bibtex item, formated to displayed on multiple lines nicely 2612 - set - a boolean variable initially set to `PETSC_FALSE`; this is used to insure only a single registration of the citation 2613 2614 Options Database: Key 2615 . -citations [filename] - print out the bibtex entries for the given computation 2616 2617 Level: intermediate 2618 2619 Fortran Note: 2620 Not available from Fortran 2621 2622 @*/ 2623 static inline PetscErrorCode PetscCitationsRegister(const char cit[], PetscBool *set) 2624 { 2625 size_t len; 2626 char *vstring; 2627 2628 PetscFunctionBegin; 2629 if (set && *set) PetscFunctionReturn(0); 2630 PetscCall(PetscStrlen(cit, &len)); 2631 PetscCall(PetscSegBufferGet(PetscCitationsList, len, &vstring)); 2632 PetscCall(PetscArraycpy(vstring, cit, len)); 2633 if (set) *set = PETSC_TRUE; 2634 PetscFunctionReturn(0); 2635 } 2636 2637 PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Google has discontinued its URL shortener service") PetscErrorCode PetscURLShorten(const char[], char[], size_t c); 2638 PETSC_EXTERN PetscErrorCode PetscGoogleDriveAuthorize(MPI_Comm, char[], char[], size_t); 2639 PETSC_EXTERN PetscErrorCode PetscGoogleDriveRefresh(MPI_Comm, const char[], char[], size_t); 2640 PETSC_EXTERN PetscErrorCode PetscGoogleDriveUpload(MPI_Comm, const char[], const char[]); 2641 2642 PETSC_EXTERN PetscErrorCode PetscBoxAuthorize(MPI_Comm, char[], char[], size_t); 2643 PETSC_EXTERN PetscErrorCode PetscBoxRefresh(MPI_Comm, const char[], char[], char[], size_t); 2644 2645 PETSC_EXTERN PetscErrorCode PetscGlobusGetTransfers(MPI_Comm, const char[], char[], size_t); 2646 2647 PETSC_EXTERN PetscErrorCode PetscTextBelt(MPI_Comm, const char[], const char[], PetscBool *); 2648 PETSC_EXTERN PetscErrorCode PetscTellMyCell(MPI_Comm, const char[], const char[], PetscBool *); 2649 2650 PETSC_EXTERN PetscErrorCode PetscPullJSONValue(const char[], const char[], char[], size_t, PetscBool *); 2651 PETSC_EXTERN PetscErrorCode PetscPushJSONValue(char[], const char[], const char[], size_t); 2652 2653 #if defined(PETSC_USE_DEBUG) 2654 static inline unsigned int PetscStrHash(const char *str) 2655 { 2656 unsigned int c, hash = 5381; 2657 2658 while ((c = (unsigned int)*str++)) hash = ((hash << 5) + hash) + c; /* hash * 33 + c */ 2659 return hash; 2660 } 2661 2662 /*MC 2663 MPIU_Allreduce - a PETSc replacement for `MPI_Allreduce()` that tries to determine if the call from all the MPI ranks occur from the 2664 same place in the PETSc code. This helps to detect bugs where different MPI ranks follow different code paths 2665 resulting in inconsistent and incorrect calls to `MPI_Allreduce()`. 2666 2667 Collective 2668 2669 Synopsis: 2670 #include <petscsys.h> 2671 PetscErrorCode MPIU_Allreduce(void *indata,void *outdata,PetscMPIInt count,MPI_Datatype datatype, MPI_Op op, MPI_Comm comm); 2672 2673 Input Parameters: 2674 + a - pointer to the input data to be reduced 2675 . c - the number of MPI data items in a and b 2676 . d - the MPI datatype, for example `MPI_INT` 2677 . e - the MPI operation, for example `MPI_SUM` 2678 - fcomm - the MPI communicator on which the operation occurs 2679 2680 Output Parameter: 2681 . b - the reduced values 2682 2683 Notes: 2684 In optimized mode this directly calls `MPI_Allreduce()` 2685 2686 This is defined as a macro that can return error codes internally so it cannot be used in a subroutine that returns void. 2687 2688 The error code this returns should be checked with `PetscCall()` even though it looks like an MPI function because it always returns PETSc error codes 2689 2690 Level: developer 2691 2692 .seealso: `MPI_Allreduce()` 2693 M*/ 2694 #define MPIU_Allreduce(a, b, c, d, e, fcomm) \ 2695 PetscMacroReturnStandard(PetscMPIInt a_b1[6], a_b2[6]; int _mpiu_allreduce_c_int = (int)c; a_b1[0] = -(PetscMPIInt)__LINE__; a_b1[1] = -a_b1[0]; a_b1[2] = -(PetscMPIInt)PetscStrHash(PETSC_FUNCTION_NAME); a_b1[3] = -a_b1[2]; a_b1[4] = -(PetscMPIInt)(c); a_b1[5] = -a_b1[4]; PetscCallMPI(MPI_Allreduce(a_b1, a_b2, 6, MPI_INT, MPI_MAX, fcomm)); PetscCheck(-a_b2[0] == a_b2[1], PETSC_COMM_SELF, PETSC_ERR_PLIB, "MPI_Allreduce() called in different locations (code lines) on different processors"); PetscCheck(-a_b2[2] == a_b2[3], PETSC_COMM_SELF, PETSC_ERR_PLIB, "MPI_Allreduce() called in different locations (functions) on different processors"); PetscCheck(-a_b2[4] == a_b2[5], PETSC_COMM_SELF, PETSC_ERR_PLIB, "MPI_Allreduce() called with different counts %d on different processors", _mpiu_allreduce_c_int); PetscCallMPI(MPI_Allreduce((a), (b), (c), d, e, (fcomm)));) 2696 #else 2697 #define MPIU_Allreduce(a, b, c, d, e, fcomm) PetscMacroReturnStandard(PetscCallMPI(MPI_Allreduce((a), (b), (c), d, e, (fcomm)))) 2698 #endif 2699 2700 #if defined(PETSC_HAVE_MPI_PROCESS_SHARED_MEMORY) 2701 PETSC_EXTERN PetscErrorCode MPIU_Win_allocate_shared(MPI_Aint, PetscMPIInt, MPI_Info, MPI_Comm, void *, MPI_Win *); 2702 PETSC_EXTERN PetscErrorCode MPIU_Win_shared_query(MPI_Win, PetscMPIInt, MPI_Aint *, PetscMPIInt *, void *); 2703 #endif 2704 2705 /* this is a vile hack */ 2706 #if defined(PETSC_HAVE_NECMPI) 2707 #if !defined(PETSC_NECMPI_VERSION_MAJOR) || !defined(PETSC_NECMPI_VERSION_MINOR) || PETSC_NECMPI_VERSION_MAJOR < 2 || (PETSC_NECMPI_VERSION_MAJOR == 2 && PETSC_NECMPI_VERSION_MINOR < 18) 2708 #define MPI_Type_free(a) (*(a) = MPI_DATATYPE_NULL, 0); 2709 #endif 2710 #endif 2711 2712 /* 2713 List of external packages and queries on it 2714 */ 2715 PETSC_EXTERN PetscErrorCode PetscHasExternalPackage(const char[], PetscBool *); 2716 2717 /* 2718 OpenMP support 2719 */ 2720 #if defined(_OPENMP) 2721 #define PetscPragmaOMP(...) _Pragma(PetscStringize(omp __VA_ARGS__)) 2722 #else // no OpenMP so no threads 2723 #define PetscPragmaOMP(...) 2724 #endif 2725 2726 /* this cannot go here because it may be in a different shared library */ 2727 PETSC_EXTERN PetscErrorCode PCMPIServerBegin(void); 2728 PETSC_EXTERN PetscErrorCode PCMPIServerEnd(void); 2729 PETSC_EXTERN PetscErrorCode PCMPICommsDestroy(void); 2730 #endif 2731