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