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