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