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