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