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