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 PetscCUSPSynchronize; 599 PETSC_EXTERN PetscBool PetscViennaCLSynchronize; 600 PETSC_EXTERN PetscBool PetscCUDASynchronize; 601 602 PETSC_EXTERN PetscErrorCode PetscSetHelpVersionFunctions(PetscErrorCode (*)(MPI_Comm),PetscErrorCode (*)(MPI_Comm)); 603 PETSC_EXTERN PetscErrorCode PetscCommDuplicate(MPI_Comm,MPI_Comm*,int*); 604 PETSC_EXTERN PetscErrorCode PetscCommDestroy(MPI_Comm*); 605 606 /*MC 607 PetscMalloc - Allocates memory, One should use PetscNew(), PetscMalloc1() or PetscCalloc1() usually instead of this 608 609 Synopsis: 610 #include <petscsys.h> 611 PetscErrorCode PetscMalloc(size_t m,void **result) 612 613 Not Collective 614 615 Input Parameter: 616 . m - number of bytes to allocate 617 618 Output Parameter: 619 . result - memory allocated 620 621 Level: beginner 622 623 Notes: 624 Memory is always allocated at least double aligned 625 626 It is safe to allocate size 0 and pass the resulting pointer (which may or may not be NULL) to PetscFree(). 627 628 .seealso: PetscFree(), PetscNew() 629 630 Concepts: memory allocation 631 632 M*/ 633 #define PetscMalloc(a,b) ((*PetscTrMalloc)((a),__LINE__,PETSC_FUNCTION_NAME,__FILE__,(void**)(b))) 634 635 /*MC 636 PetscRealloc - Rellocates memory 637 638 Synopsis: 639 #include <petscsys.h> 640 PetscErrorCode PetscRealloc(size_t m,void **result) 641 642 Not Collective 643 644 Input Parameters: 645 + m - number of bytes to allocate 646 - result - initial memory allocated 647 648 Output Parameter: 649 . result - new memory allocated 650 651 Level: developer 652 653 Notes: 654 Memory is always allocated at least double aligned 655 656 .seealso: PetscMalloc(), PetscFree(), PetscNew() 657 658 Concepts: memory allocation 659 660 M*/ 661 #define PetscRealloc(a,b) ((*PetscTrRealloc)((a),__LINE__,PETSC_FUNCTION_NAME,__FILE__,(void**)(b))) 662 663 /*MC 664 PetscAddrAlign - Rounds up an address to PETSC_MEMALIGN alignment 665 666 Synopsis: 667 #include <petscsys.h> 668 void *PetscAddrAlign(void *addr) 669 670 Not Collective 671 672 Input Parameters: 673 . addr - address to align (any pointer type) 674 675 Level: developer 676 677 .seealso: PetscMallocAlign() 678 679 Concepts: memory allocation 680 M*/ 681 #define PetscAddrAlign(a) (void*)((((PETSC_UINTPTR_T)(a))+(PETSC_MEMALIGN-1)) & ~(PETSC_MEMALIGN-1)) 682 683 /*MC 684 PetscMalloc1 - Allocates an array of memory aligned to PETSC_MEMALIGN 685 686 Synopsis: 687 #include <petscsys.h> 688 PetscErrorCode PetscMalloc1(size_t m1,type **r1) 689 690 Not Collective 691 692 Input Parameter: 693 . m1 - number of elements to allocate (may be zero) 694 695 Output Parameter: 696 . r1 - memory allocated in first chunk 697 698 Note: 699 This uses the sizeof() of the memory type requested to determine the total memory to be allocated, therefore you should not 700 multiply the number of elements requested by the sizeof() the type. For example use 701 $ PetscInt *id; 702 $ PetscMalloc1(10,&id); 703 not 704 $ PetscInt *id; 705 $ PetscMalloc1(10*sizeof(PetscInt),&id); 706 707 Does not zero the memory allocatd, used PetscCalloc1() to obtain memory that has been zeroed. 708 709 Level: beginner 710 711 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscCalloc1(), PetscMalloc2() 712 713 Concepts: memory allocation 714 715 M*/ 716 #define PetscMalloc1(m1,r1) PetscMallocA(1,PETSC_FALSE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1)) 717 718 /*MC 719 PetscCalloc1 - Allocates a cleared (zeroed) array of memory aligned to PETSC_MEMALIGN 720 721 Synopsis: 722 #include <petscsys.h> 723 PetscErrorCode PetscCalloc1(size_t m1,type **r1) 724 725 Not Collective 726 727 Input Parameter: 728 . m1 - number of elements to allocate in 1st chunk (may be zero) 729 730 Output Parameter: 731 . r1 - memory allocated in first chunk 732 733 Notes: 734 See PetsMalloc1() for more details on usage. 735 736 Level: beginner 737 738 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc1(), PetscCalloc2() 739 740 Concepts: memory allocation 741 742 M*/ 743 #define PetscCalloc1(m1,r1) PetscMallocA(1,PETSC_TRUE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1)) 744 745 /*MC 746 PetscMalloc2 - Allocates 2 arrays of memory both aligned to PETSC_MEMALIGN 747 748 Synopsis: 749 #include <petscsys.h> 750 PetscErrorCode PetscMalloc2(size_t m1,type **r1,size_t m2,type **r2) 751 752 Not Collective 753 754 Input Parameter: 755 + m1 - number of elements to allocate in 1st chunk (may be zero) 756 - m2 - number of elements to allocate in 2nd chunk (may be zero) 757 758 Output Parameter: 759 + r1 - memory allocated in first chunk 760 - r2 - memory allocated in second chunk 761 762 Level: developer 763 764 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc1(), PetscCalloc2() 765 766 Concepts: memory allocation 767 768 M*/ 769 #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)) 770 771 /*MC 772 PetscCalloc2 - Allocates 2 cleared (zeroed) arrays of memory both aligned to PETSC_MEMALIGN 773 774 Synopsis: 775 #include <petscsys.h> 776 PetscErrorCode PetscCalloc2(size_t m1,type **r1,size_t m2,type **r2) 777 778 Not Collective 779 780 Input Parameter: 781 + m1 - number of elements to allocate in 1st chunk (may be zero) 782 - m2 - number of elements to allocate in 2nd chunk (may be zero) 783 784 Output Parameter: 785 + r1 - memory allocated in first chunk 786 - r2 - memory allocated in second chunk 787 788 Level: developer 789 790 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscCalloc1(), PetscMalloc2() 791 792 Concepts: memory allocation 793 M*/ 794 #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)) 795 796 /*MC 797 PetscMalloc3 - Allocates 3 arrays of memory, all aligned to PETSC_MEMALIGN 798 799 Synopsis: 800 #include <petscsys.h> 801 PetscErrorCode PetscMalloc3(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3) 802 803 Not Collective 804 805 Input Parameter: 806 + m1 - number of elements to allocate in 1st chunk (may be zero) 807 . m2 - number of elements to allocate in 2nd chunk (may be zero) 808 - m3 - number of elements to allocate in 3rd chunk (may be zero) 809 810 Output Parameter: 811 + r1 - memory allocated in first chunk 812 . r2 - memory allocated in second chunk 813 - r3 - memory allocated in third chunk 814 815 Level: developer 816 817 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc3(), PetscFree3() 818 819 Concepts: memory allocation 820 821 M*/ 822 #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)) 823 824 /*MC 825 PetscCalloc3 - Allocates 3 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN 826 827 Synopsis: 828 #include <petscsys.h> 829 PetscErrorCode PetscCalloc3(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3) 830 831 Not Collective 832 833 Input Parameter: 834 + m1 - number of elements to allocate in 1st chunk (may be zero) 835 . m2 - number of elements to allocate in 2nd chunk (may be zero) 836 - m3 - number of elements to allocate in 3rd chunk (may be zero) 837 838 Output Parameter: 839 + r1 - memory allocated in first chunk 840 . r2 - memory allocated in second chunk 841 - r3 - memory allocated in third chunk 842 843 Level: developer 844 845 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscCalloc2(), PetscMalloc3(), PetscFree3() 846 847 Concepts: memory allocation 848 M*/ 849 #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)) 850 851 /*MC 852 PetscMalloc4 - Allocates 4 arrays of memory, all aligned to PETSC_MEMALIGN 853 854 Synopsis: 855 #include <petscsys.h> 856 PetscErrorCode PetscMalloc4(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4) 857 858 Not Collective 859 860 Input Parameter: 861 + m1 - number of elements to allocate in 1st chunk (may be zero) 862 . m2 - number of elements to allocate in 2nd chunk (may be zero) 863 . m3 - number of elements to allocate in 3rd chunk (may be zero) 864 - m4 - number of elements to allocate in 4th chunk (may be zero) 865 866 Output Parameter: 867 + r1 - memory allocated in first chunk 868 . r2 - memory allocated in second chunk 869 . r3 - memory allocated in third chunk 870 - r4 - memory allocated in fourth chunk 871 872 Level: developer 873 874 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc4(), PetscFree4() 875 876 Concepts: memory allocation 877 878 M*/ 879 #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)) 880 881 /*MC 882 PetscCalloc4 - Allocates 4 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN 883 884 Synopsis: 885 #include <petscsys.h> 886 PetscErrorCode PetscCalloc4(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4) 887 888 Not Collective 889 890 Input Parameters: 891 + m1 - number of elements to allocate in 1st chunk (may be zero) 892 . m2 - number of elements to allocate in 2nd chunk (may be zero) 893 . m3 - number of elements to allocate in 3rd chunk (may be zero) 894 - m4 - number of elements to allocate in 4th chunk (may be zero) 895 896 Output Parameters: 897 + r1 - memory allocated in first chunk 898 . r2 - memory allocated in second chunk 899 . r3 - memory allocated in third chunk 900 - r4 - memory allocated in fourth chunk 901 902 Level: developer 903 904 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc4(), PetscFree4() 905 906 Concepts: memory allocation 907 908 M*/ 909 #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)) 910 911 /*MC 912 PetscMalloc5 - Allocates 5 arrays of memory, all aligned to PETSC_MEMALIGN 913 914 Synopsis: 915 #include <petscsys.h> 916 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) 917 918 Not Collective 919 920 Input Parameters: 921 + m1 - number of elements to allocate in 1st chunk (may be zero) 922 . m2 - number of elements to allocate in 2nd chunk (may be zero) 923 . m3 - number of elements to allocate in 3rd chunk (may be zero) 924 . m4 - number of elements to allocate in 4th chunk (may be zero) 925 - m5 - number of elements to allocate in 5th chunk (may be zero) 926 927 Output Parameters: 928 + r1 - memory allocated in first chunk 929 . r2 - memory allocated in second chunk 930 . r3 - memory allocated in third chunk 931 . r4 - memory allocated in fourth chunk 932 - r5 - memory allocated in fifth chunk 933 934 Level: developer 935 936 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc5(), PetscFree5() 937 938 Concepts: memory allocation 939 940 M*/ 941 #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)) 942 943 /*MC 944 PetscCalloc5 - Allocates 5 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN 945 946 Synopsis: 947 #include <petscsys.h> 948 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) 949 950 Not Collective 951 952 Input Parameters: 953 + m1 - number of elements to allocate in 1st chunk (may be zero) 954 . m2 - number of elements to allocate in 2nd chunk (may be zero) 955 . m3 - number of elements to allocate in 3rd chunk (may be zero) 956 . m4 - number of elements to allocate in 4th chunk (may be zero) 957 - m5 - number of elements to allocate in 5th chunk (may be zero) 958 959 Output Parameters: 960 + r1 - memory allocated in first chunk 961 . r2 - memory allocated in second chunk 962 . r3 - memory allocated in third chunk 963 . r4 - memory allocated in fourth chunk 964 - r5 - memory allocated in fifth chunk 965 966 Level: developer 967 968 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc5(), PetscFree5() 969 970 Concepts: memory allocation 971 972 M*/ 973 #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)) 974 975 /*MC 976 PetscMalloc6 - Allocates 6 arrays of memory, all aligned to PETSC_MEMALIGN 977 978 Synopsis: 979 #include <petscsys.h> 980 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) 981 982 Not Collective 983 984 Input Parameters: 985 + m1 - number of elements to allocate in 1st chunk (may be zero) 986 . m2 - number of elements to allocate in 2nd chunk (may be zero) 987 . m3 - number of elements to allocate in 3rd chunk (may be zero) 988 . m4 - number of elements to allocate in 4th chunk (may be zero) 989 . m5 - number of elements to allocate in 5th chunk (may be zero) 990 - m6 - number of elements to allocate in 6th chunk (may be zero) 991 992 Output Parameteasr: 993 + r1 - memory allocated in first chunk 994 . r2 - memory allocated in second chunk 995 . r3 - memory allocated in third chunk 996 . r4 - memory allocated in fourth chunk 997 . r5 - memory allocated in fifth chunk 998 - r6 - memory allocated in sixth chunk 999 1000 Level: developer 1001 1002 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc6(), PetscFree3(), PetscFree4(), PetscFree5(), PetscFree6() 1003 1004 Concepts: memory allocation 1005 1006 M*/ 1007 #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)) 1008 1009 /*MC 1010 PetscCalloc6 - Allocates 6 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN 1011 1012 Synopsis: 1013 #include <petscsys.h> 1014 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) 1015 1016 Not Collective 1017 1018 Input Parameters: 1019 + m1 - number of elements to allocate in 1st chunk (may be zero) 1020 . m2 - number of elements to allocate in 2nd chunk (may be zero) 1021 . m3 - number of elements to allocate in 3rd chunk (may be zero) 1022 . m4 - number of elements to allocate in 4th chunk (may be zero) 1023 . m5 - number of elements to allocate in 5th chunk (may be zero) 1024 - m6 - number of elements to allocate in 6th chunk (may be zero) 1025 1026 Output Parameters: 1027 + r1 - memory allocated in first chunk 1028 . r2 - memory allocated in second chunk 1029 . r3 - memory allocated in third chunk 1030 . r4 - memory allocated in fourth chunk 1031 . r5 - memory allocated in fifth chunk 1032 - r6 - memory allocated in sixth chunk 1033 1034 Level: developer 1035 1036 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscMalloc6(), PetscFree6() 1037 1038 Concepts: memory allocation 1039 M*/ 1040 #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)) 1041 1042 /*MC 1043 PetscMalloc7 - Allocates 7 arrays of memory, all aligned to PETSC_MEMALIGN 1044 1045 Synopsis: 1046 #include <petscsys.h> 1047 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) 1048 1049 Not Collective 1050 1051 Input Parameters: 1052 + m1 - number of elements to allocate in 1st chunk (may be zero) 1053 . m2 - number of elements to allocate in 2nd chunk (may be zero) 1054 . m3 - number of elements to allocate in 3rd chunk (may be zero) 1055 . m4 - number of elements to allocate in 4th chunk (may be zero) 1056 . m5 - number of elements to allocate in 5th chunk (may be zero) 1057 . m6 - number of elements to allocate in 6th chunk (may be zero) 1058 - m7 - number of elements to allocate in 7th chunk (may be zero) 1059 1060 Output Parameters: 1061 + r1 - memory allocated in first chunk 1062 . r2 - memory allocated in second chunk 1063 . r3 - memory allocated in third chunk 1064 . r4 - memory allocated in fourth chunk 1065 . r5 - memory allocated in fifth chunk 1066 . r6 - memory allocated in sixth chunk 1067 - r7 - memory allocated in seventh chunk 1068 1069 Level: developer 1070 1071 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc7(), PetscFree7() 1072 1073 Concepts: memory allocation 1074 1075 M*/ 1076 #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)) 1077 1078 /*MC 1079 PetscCalloc7 - Allocates 7 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN 1080 1081 Synopsis: 1082 #include <petscsys.h> 1083 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) 1084 1085 Not Collective 1086 1087 Input Parameters: 1088 + m1 - number of elements to allocate in 1st chunk (may be zero) 1089 . m2 - number of elements to allocate in 2nd chunk (may be zero) 1090 . m3 - number of elements to allocate in 3rd chunk (may be zero) 1091 . m4 - number of elements to allocate in 4th chunk (may be zero) 1092 . m5 - number of elements to allocate in 5th chunk (may be zero) 1093 . m6 - number of elements to allocate in 6th chunk (may be zero) 1094 - m7 - number of elements to allocate in 7th chunk (may be zero) 1095 1096 Output Parameters: 1097 + r1 - memory allocated in first chunk 1098 . r2 - memory allocated in second chunk 1099 . r3 - memory allocated in third chunk 1100 . r4 - memory allocated in fourth chunk 1101 . r5 - memory allocated in fifth chunk 1102 . r6 - memory allocated in sixth chunk 1103 - r7 - memory allocated in seventh chunk 1104 1105 Level: developer 1106 1107 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscMalloc7(), PetscFree7() 1108 1109 Concepts: memory allocation 1110 M*/ 1111 #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)) 1112 1113 /*MC 1114 PetscNew - Allocates memory of a particular type, zeros the memory! Aligned to PETSC_MEMALIGN 1115 1116 Synopsis: 1117 #include <petscsys.h> 1118 PetscErrorCode PetscNew(type **result) 1119 1120 Not Collective 1121 1122 Output Parameter: 1123 . result - memory allocated, sized to match pointer type 1124 1125 Level: beginner 1126 1127 .seealso: PetscFree(), PetscMalloc(), PetscNewLog(), PetscCalloc1(), PetscMalloc1() 1128 1129 Concepts: memory allocation 1130 1131 M*/ 1132 #define PetscNew(b) PetscCalloc1(1,(b)) 1133 1134 /*MC 1135 PetscNewLog - Allocates memory of a type matching pointer, zeros the memory! Aligned to PETSC_MEMALIGN. Associates the memory allocated 1136 with the given object using PetscLogObjectMemory(). 1137 1138 Synopsis: 1139 #include <petscsys.h> 1140 PetscErrorCode PetscNewLog(PetscObject obj,type **result) 1141 1142 Not Collective 1143 1144 Input Parameter: 1145 . obj - object memory is logged to 1146 1147 Output Parameter: 1148 . result - memory allocated, sized to match pointer type 1149 1150 Level: developer 1151 1152 .seealso: PetscFree(), PetscMalloc(), PetscNew(), PetscLogObjectMemory(), PetscCalloc1(), PetscMalloc1() 1153 1154 Concepts: memory allocation 1155 1156 M*/ 1157 #define PetscNewLog(o,b) (PetscNew((b)) || PetscLogObjectMemory((PetscObject)o,sizeof(**(b)))) 1158 1159 /*MC 1160 PetscFree - Frees memory 1161 1162 Synopsis: 1163 #include <petscsys.h> 1164 PetscErrorCode PetscFree(void *memory) 1165 1166 Not Collective 1167 1168 Input Parameter: 1169 . memory - memory to free (the pointer is ALWAYS set to NULL upon sucess) 1170 1171 Level: beginner 1172 1173 Notes: 1174 Do not free memory obtained with PetscMalloc2(), PetscCalloc2() etc, they must be freed with PetscFree2() etc. 1175 1176 It is safe to call PetscFree() on a NULL pointer. 1177 1178 .seealso: PetscNew(), PetscMalloc(), PetscNewLog(), PetscMalloc1(), PetscCalloc1() 1179 1180 Concepts: memory allocation 1181 1182 M*/ 1183 #define PetscFree(a) ((*PetscTrFree)((void*)(a),__LINE__,PETSC_FUNCTION_NAME,__FILE__) || ((a) = 0,0)) 1184 1185 /*MC 1186 PetscFree2 - Frees 2 chunks of memory obtained with PetscMalloc2() 1187 1188 Synopsis: 1189 #include <petscsys.h> 1190 PetscErrorCode PetscFree2(void *memory1,void *memory2) 1191 1192 Not Collective 1193 1194 Input Parameters: 1195 + memory1 - memory to free 1196 - memory2 - 2nd memory to free 1197 1198 Level: developer 1199 1200 Notes: 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: Memory must have been obtained with PetscMalloc3() 1226 1227 .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3() 1228 1229 Concepts: memory allocation 1230 1231 M*/ 1232 #define PetscFree3(m1,m2,m3) PetscFreeA(3,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3)) 1233 1234 /*MC 1235 PetscFree4 - Frees 4 chunks of memory obtained with PetscMalloc4() 1236 1237 Synopsis: 1238 #include <petscsys.h> 1239 PetscErrorCode PetscFree4(void *m1,void *m2,void *m3,void *m4) 1240 1241 Not Collective 1242 1243 Input Parameters: 1244 + m1 - memory to free 1245 . m2 - 2nd memory to free 1246 . m3 - 3rd memory to free 1247 - m4 - 4th memory to free 1248 1249 Level: developer 1250 1251 Notes: Memory must have been obtained with PetscMalloc4() 1252 1253 .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4() 1254 1255 Concepts: memory allocation 1256 1257 M*/ 1258 #define PetscFree4(m1,m2,m3,m4) PetscFreeA(4,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3),&(m4)) 1259 1260 /*MC 1261 PetscFree5 - Frees 5 chunks of memory obtained with PetscMalloc5() 1262 1263 Synopsis: 1264 #include <petscsys.h> 1265 PetscErrorCode PetscFree5(void *m1,void *m2,void *m3,void *m4,void *m5) 1266 1267 Not Collective 1268 1269 Input Parameters: 1270 + m1 - memory to free 1271 . m2 - 2nd memory to free 1272 . m3 - 3rd memory to free 1273 . m4 - 4th memory to free 1274 - m5 - 5th memory to free 1275 1276 Level: developer 1277 1278 Notes: Memory must have been obtained with PetscMalloc5() 1279 1280 .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5() 1281 1282 Concepts: memory allocation 1283 1284 M*/ 1285 #define PetscFree5(m1,m2,m3,m4,m5) PetscFreeA(5,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3),&(m4),&(m5)) 1286 1287 /*MC 1288 PetscFree6 - Frees 6 chunks of memory obtained with PetscMalloc6() 1289 1290 Synopsis: 1291 #include <petscsys.h> 1292 PetscErrorCode PetscFree6(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6) 1293 1294 Not Collective 1295 1296 Input Parameters: 1297 + m1 - memory to free 1298 . m2 - 2nd memory to free 1299 . m3 - 3rd memory to free 1300 . m4 - 4th memory to free 1301 . m5 - 5th memory to free 1302 - m6 - 6th memory to free 1303 1304 1305 Level: developer 1306 1307 Notes: Memory must have been obtained with PetscMalloc6() 1308 1309 .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6() 1310 1311 Concepts: memory allocation 1312 1313 M*/ 1314 #define PetscFree6(m1,m2,m3,m4,m5,m6) PetscFreeA(6,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3),&(m4),&(m5),&(m6)) 1315 1316 /*MC 1317 PetscFree7 - Frees 7 chunks of memory obtained with PetscMalloc7() 1318 1319 Synopsis: 1320 #include <petscsys.h> 1321 PetscErrorCode PetscFree7(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6,void *m7) 1322 1323 Not Collective 1324 1325 Input Parameters: 1326 + m1 - memory to free 1327 . m2 - 2nd memory to free 1328 . m3 - 3rd memory to free 1329 . m4 - 4th memory to free 1330 . m5 - 5th memory to free 1331 . m6 - 6th memory to free 1332 - m7 - 7th memory to free 1333 1334 1335 Level: developer 1336 1337 Notes: Memory must have been obtained with PetscMalloc7() 1338 1339 .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6(), 1340 PetscMalloc7() 1341 1342 Concepts: memory allocation 1343 1344 M*/ 1345 #define PetscFree7(m1,m2,m3,m4,m5,m6,m7) PetscFreeA(7,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3),&(m4),&(m5),&(m6),&(m7)) 1346 1347 PETSC_EXTERN PetscErrorCode PetscMallocA(int,PetscBool,int,const char *,const char *,size_t,void *,...); 1348 PETSC_EXTERN PetscErrorCode PetscFreeA(int,int,const char *,const char *,void *,...); 1349 PETSC_EXTERN PetscErrorCode (*PetscTrMalloc)(size_t,int,const char[],const char[],void**); 1350 PETSC_EXTERN PetscErrorCode (*PetscTrFree)(void*,int,const char[],const char[]); 1351 PETSC_EXTERN PetscErrorCode (*PetscTrRealloc)(size_t,int,const char[],const char[],void**); 1352 PETSC_EXTERN PetscErrorCode PetscMallocSetCoalesce(PetscBool); 1353 PETSC_EXTERN PetscErrorCode PetscMallocSet(PetscErrorCode (*)(size_t,int,const char[],const char[],void**),PetscErrorCode (*)(void*,int,const char[],const char[])); 1354 PETSC_EXTERN PetscErrorCode PetscMallocClear(void); 1355 1356 /* 1357 Unlike PetscMallocSet and PetscMallocClear which overwrite the existing settings, these two functions save the previous choice of allocator, and should be used in pair. 1358 */ 1359 PETSC_EXTERN PetscErrorCode PetscMallocSetDRAM(void); 1360 PETSC_EXTERN PetscErrorCode PetscMallocResetDRAM(void); 1361 1362 /* 1363 PetscLogDouble variables are used to contain double precision numbers 1364 that are not used in the numerical computations, but rather in logging, 1365 timing etc. 1366 */ 1367 typedef double PetscLogDouble; 1368 #define MPIU_PETSCLOGDOUBLE MPI_DOUBLE 1369 1370 /* 1371 Routines for tracing memory corruption/bleeding with default PETSc memory allocation 1372 */ 1373 PETSC_EXTERN PetscErrorCode PetscMallocDump(FILE *); 1374 PETSC_EXTERN PetscErrorCode PetscMallocDumpLog(FILE *); 1375 PETSC_EXTERN PetscErrorCode PetscMallocGetCurrentUsage(PetscLogDouble *); 1376 PETSC_EXTERN PetscErrorCode PetscMallocGetMaximumUsage(PetscLogDouble *); 1377 PETSC_EXTERN PetscErrorCode PetscMallocDebug(PetscBool); 1378 PETSC_EXTERN PetscErrorCode PetscMallocGetDebug(PetscBool*); 1379 PETSC_EXTERN PetscErrorCode PetscMallocValidate(int,const char[],const char[]); 1380 PETSC_EXTERN PetscErrorCode PetscMallocSetDumpLog(void); 1381 PETSC_EXTERN PetscErrorCode PetscMallocSetDumpLogThreshold(PetscLogDouble); 1382 PETSC_EXTERN PetscErrorCode PetscMallocGetDumpLog(PetscBool*); 1383 1384 /*E 1385 PetscDataType - Used for handling different basic data types. 1386 1387 Level: beginner 1388 1389 Notes: 1390 Use of this should be avoided if one can directly use MPI_Datatype instead. 1391 1392 Developer comment: 1393 It would be nice if we could always just use MPI Datatypes, why can we not? 1394 1395 .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscDataTypeToMPIDataType(), 1396 PetscDataTypeGetSize() 1397 1398 E*/ 1399 typedef enum {PETSC_INT = 0,PETSC_DOUBLE = 1,PETSC_COMPLEX = 2, PETSC_LONG = 3 ,PETSC_SHORT = 4,PETSC_FLOAT = 5, 1400 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; 1401 PETSC_EXTERN const char *const PetscDataTypes[]; 1402 1403 #if defined(PETSC_USE_COMPLEX) 1404 #define PETSC_SCALAR PETSC_COMPLEX 1405 #else 1406 #if defined(PETSC_USE_REAL_SINGLE) 1407 #define PETSC_SCALAR PETSC_FLOAT 1408 #elif defined(PETSC_USE_REAL___FLOAT128) 1409 #define PETSC_SCALAR PETSC___FLOAT128 1410 #elif defined(PETSC_USE_REAL___FP16) 1411 #define PETSC_SCALAR PETSC___FP16 1412 #else 1413 #define PETSC_SCALAR PETSC_DOUBLE 1414 #endif 1415 #endif 1416 #if defined(PETSC_USE_REAL_SINGLE) 1417 #define PETSC_REAL PETSC_FLOAT 1418 #elif defined(PETSC_USE_REAL___FLOAT128) 1419 #define PETSC_REAL PETSC___FLOAT128 1420 #elif defined(PETSC_USE_REAL___FP16) 1421 #define PETSC_REAL PETSC___FP16 1422 #else 1423 #define PETSC_REAL PETSC_DOUBLE 1424 #endif 1425 #define PETSC_FORTRANADDR PETSC_LONG 1426 1427 PETSC_EXTERN PetscErrorCode PetscDataTypeToMPIDataType(PetscDataType,MPI_Datatype*); 1428 PETSC_EXTERN PetscErrorCode PetscMPIDataTypeToPetscDataType(MPI_Datatype,PetscDataType*); 1429 PETSC_EXTERN PetscErrorCode PetscDataTypeGetSize(PetscDataType,size_t*); 1430 PETSC_EXTERN PetscErrorCode PetscDataTypeFromString(const char*,PetscDataType*,PetscBool*); 1431 1432 /* 1433 Basic memory and string operations. These are usually simple wrappers 1434 around the basic Unix system calls, but a few of them have additional 1435 functionality and/or error checking. 1436 */ 1437 PETSC_EXTERN PetscErrorCode PetscBitMemcpy(void*,PetscInt,const void*,PetscInt,PetscInt,PetscDataType); 1438 PETSC_EXTERN PetscErrorCode PetscMemmove(void*,void *,size_t); 1439 PETSC_EXTERN PetscErrorCode PetscMemcmp(const void*,const void*,size_t,PetscBool *); 1440 PETSC_EXTERN PetscErrorCode PetscStrlen(const char[],size_t*); 1441 PETSC_EXTERN PetscErrorCode PetscStrToArray(const char[],char,int*,char ***); 1442 PETSC_EXTERN PetscErrorCode PetscStrToArrayDestroy(int,char **); 1443 PETSC_EXTERN PetscErrorCode PetscStrcmp(const char[],const char[],PetscBool *); 1444 PETSC_EXTERN PetscErrorCode PetscStrgrt(const char[],const char[],PetscBool *); 1445 PETSC_EXTERN PetscErrorCode PetscStrcasecmp(const char[],const char[],PetscBool *); 1446 PETSC_EXTERN PetscErrorCode PetscStrncmp(const char[],const char[],size_t,PetscBool *); 1447 PETSC_EXTERN PetscErrorCode PetscStrcpy(char[],const char[]); 1448 PETSC_EXTERN PetscErrorCode PetscStrcat(char[],const char[]); 1449 PETSC_EXTERN PetscErrorCode PetscStrncat(char[],const char[],size_t); 1450 PETSC_EXTERN PetscErrorCode PetscStrncpy(char[],const char[],size_t); 1451 PETSC_EXTERN PetscErrorCode PetscStrchr(const char[],char,char *[]); 1452 PETSC_EXTERN PetscErrorCode PetscStrtolower(char[]); 1453 PETSC_EXTERN PetscErrorCode PetscStrtoupper(char[]); 1454 PETSC_EXTERN PetscErrorCode PetscStrrchr(const char[],char,char *[]); 1455 PETSC_EXTERN PetscErrorCode PetscStrstr(const char[],const char[],char *[]); 1456 PETSC_EXTERN PetscErrorCode PetscStrrstr(const char[],const char[],char *[]); 1457 PETSC_EXTERN PetscErrorCode PetscStrendswith(const char[],const char[],PetscBool*); 1458 PETSC_EXTERN PetscErrorCode PetscStrbeginswith(const char[],const char[],PetscBool*); 1459 PETSC_EXTERN PetscErrorCode PetscStrendswithwhich(const char[],const char *const*,PetscInt*); 1460 PETSC_EXTERN PetscErrorCode PetscStrallocpy(const char[],char *[]); 1461 PETSC_EXTERN PetscErrorCode PetscStrArrayallocpy(const char *const*,char***); 1462 PETSC_EXTERN PetscErrorCode PetscStrArrayDestroy(char***); 1463 PETSC_EXTERN PetscErrorCode PetscStrNArrayallocpy(PetscInt,const char *const*,char***); 1464 PETSC_EXTERN PetscErrorCode PetscStrNArrayDestroy(PetscInt,char***); 1465 PETSC_EXTERN PetscErrorCode PetscStrreplace(MPI_Comm,const char[],char[],size_t); 1466 1467 PETSC_EXTERN void PetscStrcmpNoError(const char[],const char[],PetscBool *); 1468 1469 /*S 1470 PetscToken - 'Token' used for managing tokenizing strings 1471 1472 Level: intermediate 1473 1474 .seealso: PetscTokenCreate(), PetscTokenFind(), PetscTokenDestroy() 1475 S*/ 1476 typedef struct _p_PetscToken* PetscToken; 1477 1478 PETSC_EXTERN PetscErrorCode PetscTokenCreate(const char[],const char,PetscToken*); 1479 PETSC_EXTERN PetscErrorCode PetscTokenFind(PetscToken,char *[]); 1480 PETSC_EXTERN PetscErrorCode PetscTokenDestroy(PetscToken*); 1481 1482 PETSC_EXTERN PetscErrorCode PetscEListFind(PetscInt,const char *const*,const char*,PetscInt*,PetscBool*); 1483 PETSC_EXTERN PetscErrorCode PetscEnumFind(const char *const*,const char*,PetscEnum*,PetscBool*); 1484 1485 /* 1486 These are MPI operations for MPI_Allreduce() etc 1487 */ 1488 PETSC_EXTERN MPI_Op MPIU_MAXSUM_OP; 1489 #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16) 1490 PETSC_EXTERN MPI_Op MPIU_SUM; 1491 #else 1492 #define MPIU_SUM MPI_SUM 1493 #endif 1494 #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16) 1495 PETSC_EXTERN MPI_Op MPIU_MAX; 1496 PETSC_EXTERN MPI_Op MPIU_MIN; 1497 #else 1498 #define MPIU_MAX MPI_MAX 1499 #define MPIU_MIN MPI_MIN 1500 #endif 1501 PETSC_EXTERN PetscErrorCode PetscMaxSum(MPI_Comm,const PetscInt[],PetscInt*,PetscInt*); 1502 1503 PETSC_EXTERN PetscErrorCode MPIULong_Send(void*,PetscInt,MPI_Datatype,PetscMPIInt,PetscMPIInt,MPI_Comm); 1504 PETSC_EXTERN PetscErrorCode MPIULong_Recv(void*,PetscInt,MPI_Datatype,PetscMPIInt,PetscMPIInt,MPI_Comm); 1505 1506 /*S 1507 PetscObject - any PETSc object, PetscViewer, Mat, Vec, KSP etc 1508 1509 Level: beginner 1510 1511 Note: 1512 This is the base class from which all PETSc objects are derived from. 1513 1514 .seealso: PetscObjectDestroy(), PetscObjectView(), PetscObjectGetName(), PetscObjectSetName(), PetscObjectReference(), PetscObjectDereference() 1515 S*/ 1516 typedef struct _p_PetscObject* PetscObject; 1517 1518 /*MC 1519 PetscObjectId - unique integer Id for a PetscObject 1520 1521 Level: developer 1522 1523 Notes: 1524 Unlike pointer values, object ids are never reused. 1525 1526 .seealso: PetscObjectState, PetscObjectGetId() 1527 M*/ 1528 #if defined(PETSC_USING_F90) && !defined(PETSC_USE_FORTRANKIND) /* compaq F90 */ 1529 typedef int PetscObjectId; 1530 #else 1531 typedef PetscInt64 PetscObjectId; 1532 #endif 1533 1534 /*MC 1535 PetscObjectState - integer state for a PetscObject 1536 1537 Level: developer 1538 1539 Notes: 1540 Object state is always-increasing and (for objects that track state) can be used to determine if an object has 1541 changed since the last time you interacted with it. It is 64-bit so that it will not overflow for a very long time. 1542 1543 .seealso: PetscObjectId, PetscObjectStateGet(), PetscObjectStateIncrease(), PetscObjectStateSet() 1544 M*/ 1545 #if defined(PETSC_USING_F90) && !defined(PETSC_USE_FORTRANKIND) /* compaq F90 */ 1546 typedef int PetscObjectState; 1547 #else 1548 typedef PetscInt64 PetscObjectState; 1549 #endif 1550 1551 /*S 1552 PetscFunctionList - Linked list of functions, possibly stored in dynamic libraries, accessed 1553 by string name 1554 1555 Level: advanced 1556 1557 .seealso: PetscFunctionListAdd(), PetscFunctionListDestroy(), PetscOpFlist 1558 S*/ 1559 typedef struct _n_PetscFunctionList *PetscFunctionList; 1560 1561 /*E 1562 PetscFileMode - Access mode for a file. 1563 1564 Level: beginner 1565 1566 $ FILE_MODE_READ - open a file at its beginning for reading 1567 $ FILE_MODE_WRITE - open a file at its beginning for writing (will create if the file does not exist) 1568 $ FILE_MODE_APPEND - open a file at end for writing 1569 $ FILE_MODE_UPDATE - open a file for updating, meaning for reading and writing 1570 $ FILE_MODE_APPEND_UPDATE - open a file for updating, meaning for reading and writing, at the end 1571 1572 .seealso: PetscViewerFileSetMode() 1573 E*/ 1574 typedef enum {FILE_MODE_READ, FILE_MODE_WRITE, FILE_MODE_APPEND, FILE_MODE_UPDATE, FILE_MODE_APPEND_UPDATE} PetscFileMode; 1575 extern const char *const PetscFileModes[]; 1576 1577 /* 1578 Defines PETSc error handling. 1579 */ 1580 #include <petscerror.h> 1581 1582 #define PETSC_SMALLEST_CLASSID 1211211 1583 PETSC_EXTERN PetscClassId PETSC_LARGEST_CLASSID; 1584 PETSC_EXTERN PetscClassId PETSC_OBJECT_CLASSID; 1585 PETSC_EXTERN PetscErrorCode PetscClassIdRegister(const char[],PetscClassId *); 1586 1587 /* 1588 Routines that get memory usage information from the OS 1589 */ 1590 PETSC_EXTERN PetscErrorCode PetscMemoryGetCurrentUsage(PetscLogDouble *); 1591 PETSC_EXTERN PetscErrorCode PetscMemoryGetMaximumUsage(PetscLogDouble *); 1592 PETSC_EXTERN PetscErrorCode PetscMemorySetGetMaximumUsage(void); 1593 PETSC_EXTERN PetscErrorCode PetscMemoryTrace(const char[]); 1594 1595 PETSC_EXTERN PetscErrorCode PetscInfoAllow(PetscBool ,const char []); 1596 PETSC_EXTERN PetscErrorCode PetscSleep(PetscReal); 1597 1598 /* 1599 Initialization of PETSc 1600 */ 1601 PETSC_EXTERN PetscErrorCode PetscInitialize(int*,char***,const char[],const char[]); 1602 PETSC_EXTERN PetscErrorCode PetscInitializeNoPointers(int,char**,const char[],const char[]); 1603 PETSC_EXTERN PetscErrorCode PetscInitializeNoArguments(void); 1604 PETSC_EXTERN PetscErrorCode PetscInitialized(PetscBool *); 1605 PETSC_EXTERN PetscErrorCode PetscFinalized(PetscBool *); 1606 PETSC_EXTERN PetscErrorCode PetscFinalize(void); 1607 PETSC_EXTERN PetscErrorCode PetscInitializeFortran(void); 1608 PETSC_EXTERN PetscErrorCode PetscGetArgs(int*,char ***); 1609 PETSC_EXTERN PetscErrorCode PetscGetArguments(char ***); 1610 PETSC_EXTERN PetscErrorCode PetscFreeArguments(char **); 1611 1612 PETSC_EXTERN PetscErrorCode PetscEnd(void); 1613 PETSC_EXTERN PetscErrorCode PetscSysInitializePackage(void); 1614 1615 PETSC_EXTERN PetscErrorCode PetscPythonInitialize(const char[],const char[]); 1616 PETSC_EXTERN PetscErrorCode PetscPythonFinalize(void); 1617 PETSC_EXTERN PetscErrorCode PetscPythonPrintError(void); 1618 PETSC_EXTERN PetscErrorCode PetscPythonMonitorSet(PetscObject,const char[]); 1619 1620 /* 1621 These are so that in extern C code we can caste function pointers to non-extern C 1622 function pointers. Since the regular C++ code expects its function pointers to be C++ 1623 */ 1624 PETSC_EXTERN_TYPEDEF typedef void (**PetscVoidStarFunction)(void); 1625 PETSC_EXTERN_TYPEDEF typedef void (*PetscVoidFunction)(void); 1626 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*PetscErrorCodeFunction)(void); 1627 1628 /* 1629 Functions that can act on any PETSc object. 1630 */ 1631 PETSC_EXTERN PetscErrorCode PetscObjectDestroy(PetscObject*); 1632 PETSC_EXTERN PetscErrorCode PetscObjectGetComm(PetscObject,MPI_Comm *); 1633 PETSC_EXTERN PetscErrorCode PetscObjectGetClassId(PetscObject,PetscClassId *); 1634 PETSC_EXTERN PetscErrorCode PetscObjectGetClassName(PetscObject,const char *[]); 1635 PETSC_EXTERN PetscErrorCode PetscObjectSetType(PetscObject,const char []); 1636 PETSC_EXTERN PetscErrorCode PetscObjectGetType(PetscObject,const char *[]); 1637 PETSC_EXTERN PetscErrorCode PetscObjectSetName(PetscObject,const char[]); 1638 PETSC_EXTERN PetscErrorCode PetscObjectGetName(PetscObject,const char*[]); 1639 PETSC_EXTERN PetscErrorCode PetscObjectSetTabLevel(PetscObject,PetscInt); 1640 PETSC_EXTERN PetscErrorCode PetscObjectGetTabLevel(PetscObject,PetscInt*); 1641 PETSC_EXTERN PetscErrorCode PetscObjectIncrementTabLevel(PetscObject,PetscObject,PetscInt); 1642 PETSC_EXTERN PetscErrorCode PetscObjectReference(PetscObject); 1643 PETSC_EXTERN PetscErrorCode PetscObjectGetReference(PetscObject,PetscInt*); 1644 PETSC_EXTERN PetscErrorCode PetscObjectDereference(PetscObject); 1645 PETSC_EXTERN PetscErrorCode PetscObjectGetNewTag(PetscObject,PetscMPIInt *); 1646 PETSC_EXTERN PetscErrorCode PetscObjectCompose(PetscObject,const char[],PetscObject); 1647 PETSC_EXTERN PetscErrorCode PetscObjectRemoveReference(PetscObject,const char[]); 1648 PETSC_EXTERN PetscErrorCode PetscObjectQuery(PetscObject,const char[],PetscObject *); 1649 PETSC_EXTERN PetscErrorCode PetscObjectComposeFunction_Private(PetscObject,const char[],void (*)(void)); 1650 #define PetscObjectComposeFunction(a,b,d) PetscObjectComposeFunction_Private(a,b,(PetscVoidFunction)(d)) 1651 PETSC_EXTERN PetscErrorCode PetscObjectSetFromOptions(PetscObject); 1652 PETSC_EXTERN PetscErrorCode PetscObjectSetUp(PetscObject); 1653 PETSC_EXTERN PetscErrorCode PetscObjectSetPrintedOptions(PetscObject); 1654 PETSC_EXTERN PetscErrorCode PetscObjectInheritPrintedOptions(PetscObject,PetscObject); 1655 PETSC_EXTERN PetscErrorCode PetscCommGetNewTag(MPI_Comm,PetscMPIInt *); 1656 1657 #include <petscviewertypes.h> 1658 #include <petscoptions.h> 1659 1660 PETSC_EXTERN PetscErrorCode PetscObjectsListGetGlobalNumbering(MPI_Comm,PetscInt,PetscObject*,PetscInt*,PetscInt*); 1661 1662 PETSC_EXTERN PetscErrorCode PetscMemoryShowUsage(PetscViewer,const char[]); 1663 PETSC_EXTERN PetscErrorCode PetscMemoryView(PetscViewer,const char[]); 1664 PETSC_EXTERN PetscErrorCode PetscObjectPrintClassNamePrefixType(PetscObject,PetscViewer); 1665 PETSC_EXTERN PetscErrorCode PetscObjectView(PetscObject,PetscViewer); 1666 #define PetscObjectQueryFunction(obj,name,fptr) PetscObjectQueryFunction_Private((obj),(name),(PetscVoidFunction*)(fptr)) 1667 PETSC_EXTERN PetscErrorCode PetscObjectQueryFunction_Private(PetscObject,const char[],void (**)(void)); 1668 PETSC_EXTERN PetscErrorCode PetscObjectSetOptionsPrefix(PetscObject,const char[]); 1669 PETSC_EXTERN PetscErrorCode PetscObjectAppendOptionsPrefix(PetscObject,const char[]); 1670 PETSC_EXTERN PetscErrorCode PetscObjectPrependOptionsPrefix(PetscObject,const char[]); 1671 PETSC_EXTERN PetscErrorCode PetscObjectGetOptionsPrefix(PetscObject,const char*[]); 1672 PETSC_EXTERN PetscErrorCode PetscObjectChangeTypeName(PetscObject,const char[]); 1673 PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroy(PetscObject); 1674 PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroyAll(void); 1675 PETSC_EXTERN PetscErrorCode PetscObjectViewFromOptions(PetscObject,PetscObject,const char[]); 1676 PETSC_EXTERN PetscErrorCode PetscObjectName(PetscObject); 1677 PETSC_EXTERN PetscErrorCode PetscObjectTypeCompare(PetscObject,const char[],PetscBool *); 1678 PETSC_EXTERN PetscErrorCode PetscObjectBaseTypeCompare(PetscObject,const char[],PetscBool *); 1679 PETSC_EXTERN PetscErrorCode PetscObjectTypeCompareAny(PetscObject,PetscBool*,const char[],...); 1680 PETSC_EXTERN PetscErrorCode PetscRegisterFinalize(PetscErrorCode (*)(void)); 1681 PETSC_EXTERN PetscErrorCode PetscRegisterFinalizeAll(void); 1682 1683 #if defined(PETSC_HAVE_SAWS) 1684 PETSC_EXTERN PetscErrorCode PetscSAWsBlock(void); 1685 PETSC_EXTERN PetscErrorCode PetscObjectSAWsViewOff(PetscObject); 1686 PETSC_EXTERN PetscErrorCode PetscObjectSAWsSetBlock(PetscObject,PetscBool); 1687 PETSC_EXTERN PetscErrorCode PetscObjectSAWsBlock(PetscObject); 1688 PETSC_EXTERN PetscErrorCode PetscObjectSAWsGrantAccess(PetscObject); 1689 PETSC_EXTERN PetscErrorCode PetscObjectSAWsTakeAccess(PetscObject); 1690 PETSC_EXTERN void PetscStackSAWsGrantAccess(void); 1691 PETSC_EXTERN void PetscStackSAWsTakeAccess(void); 1692 PETSC_EXTERN PetscErrorCode PetscStackViewSAWs(void); 1693 PETSC_EXTERN PetscErrorCode PetscStackSAWsViewOff(void); 1694 1695 #else 1696 #define PetscSAWsBlock() 0 1697 #define PetscObjectSAWsViewOff(obj) 0 1698 #define PetscObjectSAWsSetBlock(obj,flg) 0 1699 #define PetscObjectSAWsBlock(obj) 0 1700 #define PetscObjectSAWsGrantAccess(obj) 0 1701 #define PetscObjectSAWsTakeAccess(obj) 0 1702 #define PetscStackViewSAWs() 0 1703 #define PetscStackSAWsViewOff() 0 1704 #define PetscStackSAWsTakeAccess() 1705 #define PetscStackSAWsGrantAccess() 1706 1707 #endif 1708 1709 typedef void* PetscDLHandle; 1710 typedef enum {PETSC_DL_DECIDE=0,PETSC_DL_NOW=1,PETSC_DL_LOCAL=2} PetscDLMode; 1711 PETSC_EXTERN PetscErrorCode PetscDLOpen(const char[],PetscDLMode,PetscDLHandle *); 1712 PETSC_EXTERN PetscErrorCode PetscDLClose(PetscDLHandle *); 1713 PETSC_EXTERN PetscErrorCode PetscDLSym(PetscDLHandle,const char[],void **); 1714 1715 #if defined(PETSC_USE_DEBUG) 1716 PETSC_EXTERN PetscErrorCode PetscMallocGetStack(void*,PetscStack**); 1717 #endif 1718 PETSC_EXTERN PetscErrorCode PetscObjectsDump(FILE*,PetscBool); 1719 1720 /*S 1721 PetscObjectList - Linked list of PETSc objects, each accessable by string name 1722 1723 Level: developer 1724 1725 Notes: 1726 Used by PetscObjectCompose() and PetscObjectQuery() 1727 1728 .seealso: PetscObjectListAdd(), PetscObjectListDestroy(), PetscObjectListFind(), PetscObjectCompose(), PetscObjectQuery(), PetscFunctionList 1729 S*/ 1730 typedef struct _n_PetscObjectList *PetscObjectList; 1731 1732 PETSC_EXTERN PetscErrorCode PetscObjectListDestroy(PetscObjectList*); 1733 PETSC_EXTERN PetscErrorCode PetscObjectListFind(PetscObjectList,const char[],PetscObject*); 1734 PETSC_EXTERN PetscErrorCode PetscObjectListReverseFind(PetscObjectList,PetscObject,char**,PetscBool*); 1735 PETSC_EXTERN PetscErrorCode PetscObjectListAdd(PetscObjectList *,const char[],PetscObject); 1736 PETSC_EXTERN PetscErrorCode PetscObjectListRemoveReference(PetscObjectList *,const char[]); 1737 PETSC_EXTERN PetscErrorCode PetscObjectListDuplicate(PetscObjectList,PetscObjectList *); 1738 1739 /* 1740 Dynamic library lists. Lists of names of routines in objects or in dynamic 1741 link libraries that will be loaded as needed. 1742 */ 1743 1744 #define PetscFunctionListAdd(list,name,fptr) PetscFunctionListAdd_Private((list),(name),(PetscVoidFunction)(fptr)) 1745 PETSC_EXTERN PetscErrorCode PetscFunctionListAdd_Private(PetscFunctionList*,const char[],void (*)(void)); 1746 PETSC_EXTERN PetscErrorCode PetscFunctionListDestroy(PetscFunctionList*); 1747 #define PetscFunctionListFind(list,name,fptr) PetscFunctionListFind_Private((list),(name),(PetscVoidFunction*)(fptr)) 1748 PETSC_EXTERN PetscErrorCode PetscFunctionListFind_Private(PetscFunctionList,const char[],void (**)(void)); 1749 PETSC_EXTERN PetscErrorCode PetscFunctionListPrintTypes(MPI_Comm,FILE*,const char[],const char[],const char[],const char[],PetscFunctionList,const char[]); 1750 PETSC_EXTERN PetscErrorCode PetscFunctionListDuplicate(PetscFunctionList,PetscFunctionList *); 1751 PETSC_EXTERN PetscErrorCode PetscFunctionListView(PetscFunctionList,PetscViewer); 1752 PETSC_EXTERN PetscErrorCode PetscFunctionListGet(PetscFunctionList,const char ***,int*); 1753 1754 /*S 1755 PetscDLLibrary - Linked list of dynamics libraries to search for functions 1756 1757 Level: advanced 1758 1759 .seealso: PetscDLLibraryOpen() 1760 S*/ 1761 typedef struct _n_PetscDLLibrary *PetscDLLibrary; 1762 PETSC_EXTERN PetscDLLibrary PetscDLLibrariesLoaded; 1763 PETSC_EXTERN PetscErrorCode PetscDLLibraryAppend(MPI_Comm,PetscDLLibrary *,const char[]); 1764 PETSC_EXTERN PetscErrorCode PetscDLLibraryPrepend(MPI_Comm,PetscDLLibrary *,const char[]); 1765 PETSC_EXTERN PetscErrorCode PetscDLLibrarySym(MPI_Comm,PetscDLLibrary *,const char[],const char[],void **); 1766 PETSC_EXTERN PetscErrorCode PetscDLLibraryPrintPath(PetscDLLibrary); 1767 PETSC_EXTERN PetscErrorCode PetscDLLibraryRetrieve(MPI_Comm,const char[],char *,size_t,PetscBool *); 1768 PETSC_EXTERN PetscErrorCode PetscDLLibraryOpen(MPI_Comm,const char[],PetscDLLibrary *); 1769 PETSC_EXTERN PetscErrorCode PetscDLLibraryClose(PetscDLLibrary); 1770 1771 /* 1772 Useful utility routines 1773 */ 1774 PETSC_EXTERN PetscErrorCode PetscSplitOwnership(MPI_Comm,PetscInt*,PetscInt*); 1775 PETSC_EXTERN PetscErrorCode PetscSplitOwnershipBlock(MPI_Comm,PetscInt,PetscInt*,PetscInt*); 1776 PETSC_EXTERN PetscErrorCode PetscSequentialPhaseBegin(MPI_Comm,PetscMPIInt); 1777 PETSC_EXTERN PetscErrorCode PetscSequentialPhaseEnd(MPI_Comm,PetscMPIInt); 1778 PETSC_EXTERN PetscErrorCode PetscBarrier(PetscObject); 1779 PETSC_EXTERN PetscErrorCode PetscMPIDump(FILE*); 1780 PETSC_EXTERN PetscErrorCode PetscGlobalMinMaxInt(MPI_Comm,PetscInt[],PetscInt[]); 1781 PETSC_EXTERN PetscErrorCode PetscGlobalMinMaxReal(MPI_Comm,PetscReal[],PetscReal[]); 1782 1783 /* 1784 PetscNot - negates a logical type value and returns result as a PetscBool 1785 1786 Notes: 1787 This is useful in cases like 1788 $ int *a; 1789 $ PetscBool flag = PetscNot(a) 1790 where !a would not return a PetscBool because we cannot provide a cast from int to PetscBool in C. 1791 */ 1792 #define PetscNot(a) ((a) ? PETSC_FALSE : PETSC_TRUE) 1793 1794 /*MC 1795 PetscHelpPrintf - Prints help messages. 1796 1797 Synopsis: 1798 #include <petscsys.h> 1799 PetscErrorCode (*PetscHelpPrintf)(const char format[],...); 1800 1801 Not Collective 1802 1803 Input Parameters: 1804 . format - the usual printf() format string 1805 1806 Level: developer 1807 1808 Fortran Note: 1809 This routine is not supported in Fortran. 1810 1811 Concepts: help messages^printing 1812 Concepts: printing^help messages 1813 1814 .seealso: PetscFPrintf(), PetscSynchronizedPrintf(), PetscErrorPrintf() 1815 M*/ 1816 PETSC_EXTERN PetscErrorCode (*PetscHelpPrintf)(MPI_Comm,const char[],...); 1817 1818 /* 1819 Defines PETSc profiling. 1820 */ 1821 #include <petsclog.h> 1822 1823 /* 1824 Simple PETSc parallel IO for ASCII printing 1825 */ 1826 PETSC_EXTERN PetscErrorCode PetscFixFilename(const char[],char[]); 1827 PETSC_EXTERN PetscErrorCode PetscFOpen(MPI_Comm,const char[],const char[],FILE**); 1828 PETSC_EXTERN PetscErrorCode PetscFClose(MPI_Comm,FILE*); 1829 PETSC_EXTERN PetscErrorCode PetscFPrintf(MPI_Comm,FILE*,const char[],...); 1830 PETSC_EXTERN PetscErrorCode PetscPrintf(MPI_Comm,const char[],...); 1831 PETSC_EXTERN PetscErrorCode PetscSNPrintf(char*,size_t,const char [],...); 1832 PETSC_EXTERN PetscErrorCode PetscSNPrintfCount(char*,size_t,const char [],size_t*,...); 1833 1834 PETSC_EXTERN PetscErrorCode PetscErrorPrintfDefault(const char [],...); 1835 PETSC_EXTERN PetscErrorCode PetscErrorPrintfNone(const char [],...); 1836 PETSC_EXTERN PetscErrorCode PetscHelpPrintfDefault(MPI_Comm,const char [],...); 1837 1838 #if defined(PETSC_HAVE_POPEN) 1839 PETSC_EXTERN PetscErrorCode PetscPOpen(MPI_Comm,const char[],const char[],const char[],FILE **); 1840 PETSC_EXTERN PetscErrorCode PetscPClose(MPI_Comm,FILE*,int*); 1841 PETSC_EXTERN PetscErrorCode PetscPOpenSetMachine(const char[]); 1842 #endif 1843 1844 PETSC_EXTERN PetscErrorCode PetscSynchronizedPrintf(MPI_Comm,const char[],...); 1845 PETSC_EXTERN PetscErrorCode PetscSynchronizedFPrintf(MPI_Comm,FILE*,const char[],...); 1846 PETSC_EXTERN PetscErrorCode PetscSynchronizedFlush(MPI_Comm,FILE*); 1847 PETSC_EXTERN PetscErrorCode PetscSynchronizedFGets(MPI_Comm,FILE*,size_t,char[]); 1848 PETSC_EXTERN PetscErrorCode PetscStartMatlab(MPI_Comm,const char[],const char[],FILE**); 1849 PETSC_EXTERN PetscErrorCode PetscStartJava(MPI_Comm,const char[],const char[],FILE**); 1850 PETSC_EXTERN PetscErrorCode PetscGetPetscDir(const char*[]); 1851 1852 PETSC_EXTERN PetscErrorCode PetscPopUpSelect(MPI_Comm,const char*,const char*,int,const char**,int*); 1853 1854 /*S 1855 PetscContainer - Simple PETSc object that contains a pointer to any required data 1856 1857 Level: advanced 1858 1859 .seealso: PetscObject, PetscContainerCreate() 1860 S*/ 1861 PETSC_EXTERN PetscClassId PETSC_CONTAINER_CLASSID; 1862 typedef struct _p_PetscContainer* PetscContainer; 1863 PETSC_EXTERN PetscErrorCode PetscContainerGetPointer(PetscContainer,void **); 1864 PETSC_EXTERN PetscErrorCode PetscContainerSetPointer(PetscContainer,void *); 1865 PETSC_EXTERN PetscErrorCode PetscContainerDestroy(PetscContainer*); 1866 PETSC_EXTERN PetscErrorCode PetscContainerCreate(MPI_Comm,PetscContainer *); 1867 PETSC_EXTERN PetscErrorCode PetscContainerSetUserDestroy(PetscContainer, PetscErrorCode (*)(void*)); 1868 PETSC_EXTERN PetscErrorCode PetscContainerUserDestroyDefault(void*); 1869 1870 /* 1871 For use in debuggers 1872 */ 1873 PETSC_EXTERN PetscMPIInt PetscGlobalRank; 1874 PETSC_EXTERN PetscMPIInt PetscGlobalSize; 1875 PETSC_EXTERN PetscErrorCode PetscIntView(PetscInt,const PetscInt[],PetscViewer); 1876 PETSC_EXTERN PetscErrorCode PetscRealView(PetscInt,const PetscReal[],PetscViewer); 1877 PETSC_EXTERN PetscErrorCode PetscScalarView(PetscInt,const PetscScalar[],PetscViewer); 1878 1879 #include <stddef.h> 1880 #include <string.h> /* for memcpy, memset */ 1881 #if defined(PETSC_HAVE_STDLIB_H) 1882 #include <stdlib.h> 1883 #endif 1884 1885 #if defined(PETSC_HAVE_XMMINTRIN_H) && !defined(__CUDACC__) 1886 #include <xmmintrin.h> 1887 #endif 1888 1889 /*@C 1890 PetscMemcpy - Copies n bytes, beginning at location b, to the space 1891 beginning at location a. The two memory regions CANNOT overlap, use 1892 PetscMemmove() in that case. 1893 1894 Not Collective 1895 1896 Input Parameters: 1897 + b - pointer to initial memory space 1898 - n - length (in bytes) of space to copy 1899 1900 Output Parameter: 1901 . a - pointer to copy space 1902 1903 Level: intermediate 1904 1905 Compile Option: 1906 PETSC_PREFER_DCOPY_FOR_MEMCPY will cause the BLAS dcopy() routine to be used 1907 for memory copies on double precision values. 1908 PETSC_PREFER_COPY_FOR_MEMCPY will cause C code to be used 1909 for memory copies on double precision values. 1910 PETSC_PREFER_FORTRAN_FORMEMCPY will cause Fortran code to be used 1911 for memory copies on double precision values. 1912 1913 Note: 1914 This routine is analogous to memcpy(). 1915 1916 Developer Note: this is inlined for fastest performance 1917 1918 Concepts: memory^copying 1919 Concepts: copying^memory 1920 1921 .seealso: PetscMemmove() 1922 1923 @*/ 1924 PETSC_STATIC_INLINE PetscErrorCode PetscMemcpy(void *a,const void *b,size_t n) 1925 { 1926 #if defined(PETSC_USE_DEBUG) 1927 size_t al = (size_t) a,bl = (size_t) b; 1928 size_t nl = (size_t) n; 1929 PetscFunctionBegin; 1930 if (n > 0 && !b) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy from a null pointer"); 1931 if (n > 0 && !a) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy to a null pointer"); 1932 #else 1933 PetscFunctionBegin; 1934 #endif 1935 if (a != b && n > 0) { 1936 #if defined(PETSC_USE_DEBUG) 1937 if ((al > bl && (al - bl) < nl) || (bl - al) < nl) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_ARG_INCOMP,"Memory regions overlap: either use PetscMemmov()\n\ 1938 or make sure your copy regions and lengths are correct. \n\ 1939 Length (bytes) %ld first address %ld second address %ld",nl,al,bl); 1940 #endif 1941 #if (defined(PETSC_PREFER_DCOPY_FOR_MEMCPY) || defined(PETSC_PREFER_COPY_FOR_MEMCPY) || defined(PETSC_PREFER_FORTRAN_FORMEMCPY)) 1942 if (!(a % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) { 1943 size_t len = n/sizeof(PetscScalar); 1944 #if defined(PETSC_PREFER_DCOPY_FOR_MEMCPY) 1945 PetscBLASInt one = 1,blen; 1946 PetscErrorCode ierr; 1947 ierr = PetscBLASIntCast(len,&blen);CHKERRQ(ierr); 1948 PetscStackCallBLAS("BLAScopy",BLAScopy_(&blen,(PetscScalar *)b,&one,(PetscScalar *)a,&one)); 1949 #elif defined(PETSC_PREFER_FORTRAN_FORMEMCPY) 1950 fortrancopy_(&len,(PetscScalar*)b,(PetscScalar*)a); 1951 #else 1952 size_t i; 1953 PetscScalar *x = (PetscScalar*)b, *y = (PetscScalar*)a; 1954 for (i=0; i<len; i++) y[i] = x[i]; 1955 #endif 1956 } else { 1957 memcpy((char*)(a),(char*)(b),n); 1958 } 1959 #else 1960 memcpy((char*)(a),(char*)(b),n); 1961 #endif 1962 } 1963 PetscFunctionReturn(0); 1964 } 1965 1966 /*@C 1967 PetscMemzero - Zeros the specified memory. 1968 1969 Not Collective 1970 1971 Input Parameters: 1972 + a - pointer to beginning memory location 1973 - n - length (in bytes) of memory to initialize 1974 1975 Level: intermediate 1976 1977 Compile Option: 1978 PETSC_PREFER_BZERO - on certain machines (the IBM RS6000) the bzero() routine happens 1979 to be faster than the memset() routine. This flag causes the bzero() routine to be used. 1980 1981 Developer Note: this is inlined for fastest performance 1982 1983 Concepts: memory^zeroing 1984 Concepts: zeroing^memory 1985 1986 .seealso: PetscMemcpy() 1987 @*/ 1988 PETSC_STATIC_INLINE PetscErrorCode PetscMemzero(void *a,size_t n) 1989 { 1990 if (n > 0) { 1991 #if defined(PETSC_USE_DEBUG) 1992 if (!a) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to zero at a null pointer"); 1993 #endif 1994 #if defined(PETSC_PREFER_ZERO_FOR_MEMZERO) 1995 if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) { 1996 size_t i,len = n/sizeof(PetscScalar); 1997 PetscScalar *x = (PetscScalar*)a; 1998 for (i=0; i<len; i++) x[i] = 0.0; 1999 } else { 2000 #elif defined(PETSC_PREFER_FORTRAN_FOR_MEMZERO) 2001 if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) { 2002 PetscInt len = n/sizeof(PetscScalar); 2003 fortranzero_(&len,(PetscScalar*)a); 2004 } else { 2005 #endif 2006 #if defined(PETSC_PREFER_BZERO) 2007 bzero((char *)a,n); 2008 #else 2009 memset((char*)a,0,n); 2010 #endif 2011 #if defined(PETSC_PREFER_ZERO_FOR_MEMZERO) || defined(PETSC_PREFER_FORTRAN_FOR_MEMZERO) 2012 } 2013 #endif 2014 } 2015 return 0; 2016 } 2017 2018 /*MC 2019 PetscPrefetchBlock - Prefetches a block of memory 2020 2021 Synopsis: 2022 #include <petscsys.h> 2023 void PetscPrefetchBlock(const anytype *a,size_t n,int rw,int t) 2024 2025 Not Collective 2026 2027 Input Parameters: 2028 + a - pointer to first element to fetch (any type but usually PetscInt or PetscScalar) 2029 . n - number of elements to fetch 2030 . rw - 1 if the memory will be written to, otherwise 0 (ignored by many processors) 2031 - t - temporal locality (PETSC_PREFETCH_HINT_{NTA,T0,T1,T2}), see note 2032 2033 Level: developer 2034 2035 Notes: 2036 The last two arguments (rw and t) must be compile-time constants. 2037 2038 Adopting Intel's x86/x86-64 conventions, there are four levels of temporal locality. Not all architectures offer 2039 equivalent locality hints, but the following macros are always defined to their closest analogue. 2040 + PETSC_PREFETCH_HINT_NTA - Non-temporal. Prefetches directly to L1, evicts to memory (skips higher level cache unless it was already there when prefetched). 2041 . 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. 2042 . PETSC_PREFETCH_HINT_T1 - Fetch to level 2 and higher (not L1). 2043 - PETSC_PREFETCH_HINT_T2 - Fetch to high-level cache only. (On many systems, T0 and T1 are equivalent.) 2044 2045 This function does nothing on architectures that do not support prefetch and never errors (even if passed an invalid 2046 address). 2047 2048 Concepts: memory 2049 M*/ 2050 #define PetscPrefetchBlock(a,n,rw,t) do { \ 2051 const char *_p = (const char*)(a),*_end = (const char*)((a)+(n)); \ 2052 for ( ; _p < _end; _p += PETSC_LEVEL1_DCACHE_LINESIZE) PETSC_Prefetch(_p,(rw),(t)); \ 2053 } while (0) 2054 2055 /* 2056 Determine if some of the kernel computation routines use 2057 Fortran (rather than C) for the numerical calculations. On some machines 2058 and compilers (like complex numbers) the Fortran version of the routines 2059 is faster than the C/C++ versions. The flag --with-fortran-kernels 2060 should be used with ./configure to turn these on. 2061 */ 2062 #if defined(PETSC_USE_FORTRAN_KERNELS) 2063 2064 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTCRL) 2065 #define PETSC_USE_FORTRAN_KERNEL_MULTCRL 2066 #endif 2067 2068 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJPERM) 2069 #define PETSC_USE_FORTRAN_KERNEL_MULTAIJPERM 2070 #endif 2071 2072 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJ) 2073 #define PETSC_USE_FORTRAN_KERNEL_MULTAIJ 2074 #endif 2075 2076 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ) 2077 #define PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ 2078 #endif 2079 2080 #if !defined(PETSC_USE_FORTRAN_KERNEL_NORM) 2081 #define PETSC_USE_FORTRAN_KERNEL_NORM 2082 #endif 2083 2084 #if !defined(PETSC_USE_FORTRAN_KERNEL_MAXPY) 2085 #define PETSC_USE_FORTRAN_KERNEL_MAXPY 2086 #endif 2087 2088 #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ) 2089 #define PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ 2090 #endif 2091 2092 #if !defined(PETSC_USE_FORTRAN_KERNEL_RELAXAIJ) 2093 #define PETSC_USE_FORTRAN_KERNEL_RELAXAIJ 2094 #endif 2095 2096 #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ) 2097 #define PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ 2098 #endif 2099 2100 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ) 2101 #define PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ 2102 #endif 2103 2104 #if !defined(PETSC_USE_FORTRAN_KERNEL_MDOT) 2105 #define PETSC_USE_FORTRAN_KERNEL_MDOT 2106 #endif 2107 2108 #if !defined(PETSC_USE_FORTRAN_KERNEL_XTIMESY) 2109 #define PETSC_USE_FORTRAN_KERNEL_XTIMESY 2110 #endif 2111 2112 #if !defined(PETSC_USE_FORTRAN_KERNEL_AYPX) 2113 #define PETSC_USE_FORTRAN_KERNEL_AYPX 2114 #endif 2115 2116 #if !defined(PETSC_USE_FORTRAN_KERNEL_WAXPY) 2117 #define PETSC_USE_FORTRAN_KERNEL_WAXPY 2118 #endif 2119 2120 #endif 2121 2122 /* 2123 Macros for indicating code that should be compiled with a C interface, 2124 rather than a C++ interface. Any routines that are dynamically loaded 2125 (such as the PCCreate_XXX() routines) must be wrapped so that the name 2126 mangler does not change the functions symbol name. This just hides the 2127 ugly extern "C" {} wrappers. 2128 */ 2129 #if defined(__cplusplus) 2130 #define EXTERN_C_BEGIN extern "C" { 2131 #define EXTERN_C_END } 2132 #else 2133 #define EXTERN_C_BEGIN 2134 #define EXTERN_C_END 2135 #endif 2136 2137 /* --------------------------------------------------------------------*/ 2138 2139 /*MC 2140 MPI_Comm - the basic object used by MPI to determine which processes are involved in a 2141 communication 2142 2143 Level: beginner 2144 2145 Note: This manual page is a place-holder because MPICH does not have a manual page for MPI_Comm 2146 2147 .seealso: PETSC_COMM_WORLD, PETSC_COMM_SELF 2148 M*/ 2149 2150 /*MC 2151 PetscScalar - PETSc type that represents either a double precision real number, a double precision 2152 complex number, a single precision real number, a __float128 real or complex or a __fp16 real - if the code is configured 2153 with --with-scalar-type=real,complex --with-precision=single,double,__float128,__fp16 2154 2155 Notes: 2156 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. 2157 2158 Level: beginner 2159 2160 .seealso: PetscReal, PetscComplex, PetscInt, MPIU_REAL, MPIU_SCALAR, MPIU_COMPLEX, MPIU_INT 2161 M*/ 2162 2163 /*MC 2164 PetscComplex - PETSc type that represents a complex number with precision matching that of PetscReal. 2165 2166 Synopsis: 2167 #include <petscsys.h> 2168 PetscComplex number = 1. + 2.*PETSC_i; 2169 2170 Notes: 2171 For MPI calls that require datatypes, use MPIU_COMPLEX as the datatype for PetscComplex and MPIU_SUM etc for operations. 2172 They will automatically work correctly regardless of the size of PetscComplex. 2173 2174 See PetscScalar for details on how to ./configure the size of PetscReal 2175 2176 Complex numbers are automatically available if PETSc was able to find a working complex implementation 2177 2178 Level: beginner 2179 2180 .seealso: PetscReal, PetscScalar, PetscComplex, PetscInt, MPIU_REAL, MPIU_SCALAR, MPIU_COMPLEX, MPIU_INT, PETSC_i 2181 M*/ 2182 2183 /*MC 2184 PetscReal - PETSc type that represents a real number version of PetscScalar 2185 2186 2187 Notes: 2188 For MPI calls that require datatypes, use MPIU_REAL as the datatype for PetscScalar and MPIU_SUM, MPIU_MAX, etc. for operations. 2189 They will automatically work correctly regardless of the size of PetscReal. 2190 2191 See PetscScalar for details on how to ./configure the size of PetscReal. 2192 2193 Level: beginner 2194 2195 .seealso: PetscScalar, PetscComplex, PetscInt, MPIU_REAL, MPIU_SCALAR, MPIU_COMPLEX, MPIU_INT 2196 M*/ 2197 2198 /*MC 2199 MPIU_SCALAR - MPI datatype corresponding to PetscScalar 2200 2201 Notes: 2202 In MPI calls that require an MPI datatype that matches a PetscScalar or array of PetscScalar values, pass this value. 2203 2204 Level: beginner 2205 2206 .seealso: PetscReal, PetscScalar, PetscComplex, PetscInt, MPIU_REAL, MPIU_COMPLEX, MPIU_INT 2207 M*/ 2208 2209 /*MC 2210 MPIU_COMPLEX - MPI datatype corresponding to PetscComplex 2211 2212 Notes: 2213 In MPI calls that require an MPI datatype that matches a PetscComplex or array of PetscComplex values, pass this value. 2214 2215 Level: beginner 2216 2217 .seealso: PetscReal, PetscScalar, PetscComplex, PetscInt, MPIU_REAL, MPIU_SCALAR, MPIU_COMPLEX, MPIU_INT, PETSC_i 2218 M*/ 2219 2220 /*MC 2221 MPIU_REAL - MPI datatype corresponding to PetscReal 2222 2223 Notes: 2224 In MPI calls that require an MPI datatype that matches a PetscReal or array of PetscReal values, pass this value. 2225 2226 Level: beginner 2227 2228 .seealso: PetscReal, PetscScalar, PetscComplex, PetscInt, MPIU_SCALAR, MPIU_COMPLEX, MPIU_INT 2229 M*/ 2230 2231 #if defined(PETSC_HAVE_MPIIO) 2232 #if !defined(PETSC_WORDS_BIGENDIAN) 2233 PETSC_EXTERN PetscErrorCode MPIU_File_write_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*); 2234 PETSC_EXTERN PetscErrorCode MPIU_File_read_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*); 2235 #else 2236 #define MPIU_File_write_all(a,b,c,d,e) MPI_File_write_all(a,b,c,d,e) 2237 #define MPIU_File_read_all(a,b,c,d,e) MPI_File_read_all(a,b,c,d,e) 2238 #endif 2239 #endif 2240 2241 /* the following petsc_static_inline require petscerror.h */ 2242 2243 /* Limit MPI to 32-bits */ 2244 #define PETSC_MPI_INT_MAX 2147483647 2245 #define PETSC_MPI_INT_MIN -2147483647 2246 /* Limit BLAS to 32-bits */ 2247 #define PETSC_BLAS_INT_MAX 2147483647 2248 #define PETSC_BLAS_INT_MIN -2147483647 2249 2250 /*@C 2251 PetscBLASIntCast - casts a PetscInt (which may be 64 bits in size) to a PetscBLASInt (which may be 32 bits in size), generates an 2252 error if the PetscBLASInt is not large enough to hold the number. 2253 2254 Not Collective 2255 2256 Input Parameter: 2257 . a - the PetscInt value 2258 2259 Output Parameter: 2260 . b - the resulting PetscBLASInt value 2261 2262 Level: advanced 2263 2264 .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscMPIIntCast() 2265 @*/ 2266 PETSC_STATIC_INLINE PetscErrorCode PetscBLASIntCast(PetscInt a,PetscBLASInt *b) 2267 { 2268 PetscFunctionBegin; 2269 *b = (PetscBLASInt)(a); 2270 #if defined(PETSC_USE_64BIT_INDICES) && !defined(PETSC_HAVE_64BIT_BLAS_INDICES) 2271 if ((a) > PETSC_BLAS_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array too long for BLAS/LAPACK"); 2272 #endif 2273 PetscFunctionReturn(0); 2274 } 2275 2276 /*@C 2277 PetscMPIIntCast - casts a PetscInt (which may be 64 bits in size) to a PetscMPIInt (which may be 32 bits in size), generates an 2278 error if the PetscMPIInt is not large enough to hold the number. 2279 2280 Not Collective 2281 2282 Input Parameter: 2283 . a - the PetscInt value 2284 2285 Output Parameter: 2286 . b - the resulting PetscMPIInt value 2287 2288 Level: advanced 2289 2290 .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast() 2291 @*/ 2292 PETSC_STATIC_INLINE PetscErrorCode PetscMPIIntCast(PetscInt a,PetscMPIInt *b) 2293 { 2294 PetscFunctionBegin; 2295 *b = (PetscMPIInt)(a); 2296 #if defined(PETSC_USE_64BIT_INDICES) 2297 if ((a) > PETSC_MPI_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array too long for MPI"); 2298 #endif 2299 PetscFunctionReturn(0); 2300 } 2301 2302 #define PetscInt64Mult(a,b) ((PetscInt64)(a))*((PetscInt64)(b)) 2303 2304 /*@C 2305 2306 PetscRealIntMultTruncate - Computes the product of a positive PetscReal and a positive PetscInt and truncates the value to slightly less than the maximal possible value 2307 2308 Not Collective 2309 2310 Input Parameter: 2311 + a - the PetscReal value 2312 - b - the second value 2313 2314 Returns: 2315 the result as a PetscInt value 2316 2317 Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64 2318 Use PetscIntMultTruncate() to compute the product of two positive PetscInt and truncate to fit a PetscInt 2319 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 2320 2321 Developers Note: 2322 We currently assume that PetscInt addition can never overflow, this is obviously wrong but requires many more checks. 2323 2324 This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able. 2325 2326 Level: advanced 2327 2328 .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult() 2329 @*/ 2330 PETSC_STATIC_INLINE PetscInt PetscRealIntMultTruncate(PetscReal a,PetscInt b) 2331 { 2332 PetscInt64 r; 2333 2334 r = (PetscInt64) (a*(PetscReal)b); 2335 if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100; 2336 return (PetscInt) r; 2337 } 2338 2339 /*@C 2340 2341 PetscIntMultTruncate - Computes the product of two positive PetscInt and truncates the value to slightly less than the maximal possible value 2342 2343 Not Collective 2344 2345 Input Parameter: 2346 + a - the PetscInt value 2347 - b - the second value 2348 2349 Returns: 2350 the result as a PetscInt value 2351 2352 Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64 2353 Use PetscRealIntMultTruncate() to compute the product of a PetscReal and a PetscInt and truncate to fit a PetscInt 2354 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 2355 2356 Developers Note: We currently assume that PetscInt addition can never overflow, this is obviously wrong but requires many more checks. 2357 2358 This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able. 2359 2360 Level: advanced 2361 2362 .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult() 2363 @*/ 2364 PETSC_STATIC_INLINE PetscInt PetscIntMultTruncate(PetscInt a,PetscInt b) 2365 { 2366 PetscInt64 r; 2367 2368 r = PetscInt64Mult(a,b); 2369 if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100; 2370 return (PetscInt) r; 2371 } 2372 2373 /*@C 2374 2375 PetscIntSumTruncate - Computes the sum of two positive PetscInt and truncates the value to slightly less than the maximal possible value 2376 2377 Not Collective 2378 2379 Input Parameter: 2380 + a - the PetscInt value 2381 - b - the second value 2382 2383 Returns: 2384 the result as a PetscInt value 2385 2386 Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64 2387 Use PetscRealIntMultTruncate() to compute the product of a PetscReal and a PetscInt and truncate to fit a PetscInt 2388 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 2389 2390 This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able. 2391 2392 Level: advanced 2393 2394 .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult() 2395 @*/ 2396 PETSC_STATIC_INLINE PetscInt PetscIntSumTruncate(PetscInt a,PetscInt b) 2397 { 2398 PetscInt64 r; 2399 2400 r = ((PetscInt64)a) + ((PetscInt64)b); 2401 if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100; 2402 return (PetscInt) r; 2403 } 2404 2405 /*@C 2406 2407 PetscIntMultError - Computes the product of two positive PetscInt and generates an error with overflow. 2408 2409 Not Collective 2410 2411 Input Parameter: 2412 + a - the PetscInt value 2413 - b - the second value 2414 2415 Output Parameter:ma 2416 . result - the result as a PetscInt value, or NULL if you do not want the result, you just want to check if it overflows 2417 2418 Use PetscInt64Mult() to compute the product of two 32 bit PetscInt and store in a PetscInt64 2419 Use PetscIntMultTruncate() to compute the product of two PetscInt and truncate it to fit in a PetscInt 2420 2421 Developers Note: We currently assume that PetscInt addition does not overflow, this is obviously wrong but requires many more checks. 2422 2423 Level: advanced 2424 2425 .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscIntMult64(), PetscIntSumError() 2426 @*/ 2427 PETSC_STATIC_INLINE PetscErrorCode PetscIntMultError(PetscInt a,PetscInt b,PetscInt *result) 2428 { 2429 PetscInt64 r; 2430 2431 PetscFunctionBegin; 2432 r = PetscInt64Mult(a,b); 2433 #if !defined(PETSC_USE_64BIT_INDICES) 2434 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); 2435 #endif 2436 if (result) *result = (PetscInt) r; 2437 PetscFunctionReturn(0); 2438 } 2439 2440 /*@C 2441 2442 PetscIntSumError - Computes the sum of two positive PetscInt and generates an error with overflow. 2443 2444 Not Collective 2445 2446 Input Parameter: 2447 + a - the PetscInt value 2448 - b - the second value 2449 2450 Output Parameter:ma 2451 . c - the result as a PetscInt value, or NULL if you do not want the result, you just want to check if it overflows 2452 2453 Use PetscInt64Mult() to compute the product of two 32 bit PetscInt and store in a PetscInt64 2454 Use PetscIntMultTruncate() to compute the product of two PetscInt and truncate it to fit in a PetscInt 2455 2456 Level: advanced 2457 2458 .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult() 2459 @*/ 2460 PETSC_STATIC_INLINE PetscErrorCode PetscIntSumError(PetscInt a,PetscInt b,PetscInt *result) 2461 { 2462 PetscInt64 r; 2463 2464 PetscFunctionBegin; 2465 r = ((PetscInt64)a) + ((PetscInt64)b); 2466 #if !defined(PETSC_USE_64BIT_INDICES) 2467 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); 2468 #endif 2469 if (result) *result = (PetscInt) r; 2470 PetscFunctionReturn(0); 2471 } 2472 2473 /* 2474 The IBM include files define hz, here we hide it so that it may be used as a regular user variable. 2475 */ 2476 #if defined(hz) 2477 #undef hz 2478 #endif 2479 2480 /* For arrays that contain filenames or paths */ 2481 2482 2483 #if defined(PETSC_HAVE_LIMITS_H) 2484 #include <limits.h> 2485 #endif 2486 #if defined(PETSC_HAVE_SYS_PARAM_H) 2487 #include <sys/param.h> 2488 #endif 2489 #if defined(PETSC_HAVE_SYS_TYPES_H) 2490 #include <sys/types.h> 2491 #endif 2492 #if defined(MAXPATHLEN) 2493 # define PETSC_MAX_PATH_LEN MAXPATHLEN 2494 #elif defined(MAX_PATH) 2495 # define PETSC_MAX_PATH_LEN MAX_PATH 2496 #elif defined(_MAX_PATH) 2497 # define PETSC_MAX_PATH_LEN _MAX_PATH 2498 #else 2499 # define PETSC_MAX_PATH_LEN 4096 2500 #endif 2501 2502 /*MC 2503 2504 PETSC_VERSION - This manual page provides information about how PETSc documents and uses its version information. This information is available to both C/C++ 2505 and Fortran compilers when petscsys.h is included. 2506 2507 2508 The current PETSc version and the API for accessing it are defined in petscversion.h 2509 2510 The complete version number is given as the triple PETSC_VERSION_MAJOR.PETSC_VERSION_MINOR.PETSC_VERSION_SUBMINOR (in short hand x.y.z) 2511 2512 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 2513 where only a change in the major version number (x) indicates a change in the API. 2514 2515 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 2516 2517 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), 2518 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 2519 version number (x.y.z). 2520 2521 PETSC_RELEASE_DATE is the date the x.y version was released (i.e. the version before any patch releases) 2522 2523 PETSC_VERSION_DATE is the date the x.y.z version was released 2524 2525 PETSC_VERSION_GIT is the last git commit to the repository given in the form vx.y.z-wwwww 2526 2527 PETSC_VERSION_DATE_GIT is the date of the last git commit to the repository 2528 2529 Level: intermediate 2530 2531 PETSC_VERSION_() and PETSC_VERSION_PATCH are deprecated and will eventually be removed. For several releases PETSC_VERSION_PATCH is always 0 2532 2533 M*/ 2534 2535 /*MC 2536 2537 UsingFortran - To use PETSc with Fortran you must use both PETSc include files and modules. At the beginning 2538 of every function and module definition you need something like 2539 2540 $ 2541 $#include "petsc/finclude/petscXXX.h" 2542 $ use petscXXX 2543 2544 You can declare PETSc variables using either of the following. 2545 2546 $ XXX variablename 2547 $ type(tXXX) variablename 2548 2549 For example, 2550 2551 $#include "petsc/finclude/petscvec.h" 2552 $ use petscvec 2553 $ 2554 $ Vec b 2555 $ type(tVec) x 2556 2557 Level: beginner 2558 2559 M*/ 2560 2561 PETSC_EXTERN PetscErrorCode PetscGetArchType(char[],size_t); 2562 PETSC_EXTERN PetscErrorCode PetscGetHostName(char[],size_t); 2563 PETSC_EXTERN PetscErrorCode PetscGetUserName(char[],size_t); 2564 PETSC_EXTERN PetscErrorCode PetscGetProgramName(char[],size_t); 2565 PETSC_EXTERN PetscErrorCode PetscSetProgramName(const char[]); 2566 PETSC_EXTERN PetscErrorCode PetscGetDate(char[],size_t); 2567 PETSC_EXTERN PetscErrorCode PetscGetVersion(char[], size_t); 2568 PETSC_EXTERN PetscErrorCode PetscGetVersionNumber(PetscInt*,PetscInt*,PetscInt*,PetscInt*); 2569 2570 PETSC_EXTERN PetscErrorCode PetscSortInt(PetscInt,PetscInt[]); 2571 PETSC_EXTERN PetscErrorCode PetscSortedRemoveDupsInt(PetscInt*,PetscInt[]); 2572 PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsInt(PetscInt*,PetscInt[]); 2573 PETSC_EXTERN PetscErrorCode PetscFindInt(PetscInt, PetscInt, const PetscInt[], PetscInt*); 2574 PETSC_EXTERN PetscErrorCode PetscFindMPIInt(PetscMPIInt, PetscInt, const PetscMPIInt[], PetscInt*); 2575 PETSC_EXTERN PetscErrorCode PetscSortIntWithPermutation(PetscInt,const PetscInt[],PetscInt[]); 2576 PETSC_EXTERN PetscErrorCode PetscSortStrWithPermutation(PetscInt,const char*[],PetscInt[]); 2577 PETSC_EXTERN PetscErrorCode PetscSortIntWithArray(PetscInt,PetscInt[],PetscInt[]); 2578 PETSC_EXTERN PetscErrorCode PetscSortIntWithArrayPair(PetscInt,PetscInt[],PetscInt[],PetscInt[]); 2579 PETSC_EXTERN PetscErrorCode PetscSortMPIInt(PetscInt,PetscMPIInt[]); 2580 PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsMPIInt(PetscInt*,PetscMPIInt[]); 2581 PETSC_EXTERN PetscErrorCode PetscSortMPIIntWithArray(PetscMPIInt,PetscMPIInt[],PetscMPIInt[]); 2582 PETSC_EXTERN PetscErrorCode PetscSortIntWithScalarArray(PetscInt,PetscInt[],PetscScalar[]); 2583 PETSC_EXTERN PetscErrorCode PetscSortIntWithDataArray(PetscInt,PetscInt[],void*,size_t,void*); 2584 PETSC_EXTERN PetscErrorCode PetscSortReal(PetscInt,PetscReal[]); 2585 PETSC_EXTERN PetscErrorCode PetscSortRealWithArrayInt(PetscInt,PetscReal[],PetscInt[]); 2586 PETSC_EXTERN PetscErrorCode PetscSortRealWithPermutation(PetscInt,const PetscReal[],PetscInt[]); 2587 PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsReal(PetscInt*,PetscReal[]); 2588 PETSC_EXTERN PetscErrorCode PetscFindReal(PetscReal,PetscInt,const PetscReal[],PetscReal,PetscInt*); 2589 PETSC_EXTERN PetscErrorCode PetscSortSplit(PetscInt,PetscInt,PetscScalar[],PetscInt[]); 2590 PETSC_EXTERN PetscErrorCode PetscSortSplitReal(PetscInt,PetscInt,PetscReal[],PetscInt[]); 2591 PETSC_EXTERN PetscErrorCode PetscProcessTree(PetscInt,const PetscBool [],const PetscInt[],PetscInt*,PetscInt**,PetscInt**,PetscInt**,PetscInt**); 2592 PETSC_EXTERN PetscErrorCode PetscMergeIntArrayPair(PetscInt,const PetscInt[],const PetscInt[],PetscInt,const PetscInt[],const PetscInt[],PetscInt*,PetscInt**,PetscInt**); 2593 PETSC_EXTERN PetscErrorCode PetscMergeIntArray(PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscInt*,PetscInt**); 2594 PETSC_EXTERN PetscErrorCode PetscMergeMPIIntArray(PetscInt,const PetscMPIInt[],PetscInt,const PetscMPIInt[],PetscInt*,PetscMPIInt**); 2595 2596 PETSC_EXTERN PetscErrorCode PetscSetDisplay(void); 2597 PETSC_EXTERN PetscErrorCode PetscGetDisplay(char[],size_t); 2598 2599 /*J 2600 PetscRandomType - String with the name of a PETSc randomizer 2601 2602 Level: beginner 2603 2604 Notes: 2605 To use SPRNG or RANDOM123 you must have ./configure PETSc 2606 with the option --download-sprng or --download-random123 2607 2608 .seealso: PetscRandomSetType(), PetscRandom, PetscRandomCreate() 2609 J*/ 2610 typedef const char* PetscRandomType; 2611 #define PETSCRAND "rand" 2612 #define PETSCRAND48 "rand48" 2613 #define PETSCSPRNG "sprng" 2614 #define PETSCRANDER48 "rander48" 2615 #define PETSCRANDOM123 "random123" 2616 2617 /* Logging support */ 2618 PETSC_EXTERN PetscClassId PETSC_RANDOM_CLASSID; 2619 2620 PETSC_EXTERN PetscErrorCode PetscRandomInitializePackage(void); 2621 2622 /*S 2623 PetscRandom - Abstract PETSc object that manages generating random numbers 2624 2625 Level: intermediate 2626 2627 Concepts: random numbers 2628 2629 .seealso: PetscRandomCreate(), PetscRandomGetValue(), PetscRandomType 2630 S*/ 2631 typedef struct _p_PetscRandom* PetscRandom; 2632 2633 /* Dynamic creation and loading functions */ 2634 PETSC_EXTERN PetscFunctionList PetscRandomList; 2635 2636 PETSC_EXTERN PetscErrorCode PetscRandomRegister(const char[],PetscErrorCode (*)(PetscRandom)); 2637 PETSC_EXTERN PetscErrorCode PetscRandomSetType(PetscRandom, PetscRandomType); 2638 PETSC_EXTERN PetscErrorCode PetscRandomSetFromOptions(PetscRandom); 2639 PETSC_EXTERN PetscErrorCode PetscRandomGetType(PetscRandom, PetscRandomType*); 2640 PETSC_STATIC_INLINE PetscErrorCode PetscRandomViewFromOptions(PetscRandom A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);} 2641 PETSC_EXTERN PetscErrorCode PetscRandomView(PetscRandom,PetscViewer); 2642 2643 PETSC_EXTERN PetscErrorCode PetscRandomCreate(MPI_Comm,PetscRandom*); 2644 PETSC_EXTERN PetscErrorCode PetscRandomGetValue(PetscRandom,PetscScalar*); 2645 PETSC_EXTERN PetscErrorCode PetscRandomGetValueReal(PetscRandom,PetscReal*); 2646 PETSC_EXTERN PetscErrorCode PetscRandomGetInterval(PetscRandom,PetscScalar*,PetscScalar*); 2647 PETSC_EXTERN PetscErrorCode PetscRandomSetInterval(PetscRandom,PetscScalar,PetscScalar); 2648 PETSC_EXTERN PetscErrorCode PetscRandomSetSeed(PetscRandom,unsigned long); 2649 PETSC_EXTERN PetscErrorCode PetscRandomGetSeed(PetscRandom,unsigned long *); 2650 PETSC_EXTERN PetscErrorCode PetscRandomSeed(PetscRandom); 2651 PETSC_EXTERN PetscErrorCode PetscRandomDestroy(PetscRandom*); 2652 2653 PETSC_EXTERN PetscErrorCode PetscGetFullPath(const char[],char[],size_t); 2654 PETSC_EXTERN PetscErrorCode PetscGetRelativePath(const char[],char[],size_t); 2655 PETSC_EXTERN PetscErrorCode PetscGetWorkingDirectory(char[],size_t); 2656 PETSC_EXTERN PetscErrorCode PetscGetRealPath(const char[],char[]); 2657 PETSC_EXTERN PetscErrorCode PetscGetHomeDirectory(char[],size_t); 2658 PETSC_EXTERN PetscErrorCode PetscTestFile(const char[],char,PetscBool *); 2659 PETSC_EXTERN PetscErrorCode PetscTestDirectory(const char[],char,PetscBool *); 2660 PETSC_EXTERN PetscErrorCode PetscMkdir(const char[]); 2661 PETSC_EXTERN PetscErrorCode PetscRMTree(const char[]); 2662 2663 PETSC_EXTERN PetscErrorCode PetscBinaryRead(int,void*,PetscInt,PetscDataType); 2664 PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedRead(MPI_Comm,int,void*,PetscInt,PetscDataType); 2665 PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedWrite(MPI_Comm,int,void*,PetscInt,PetscDataType,PetscBool ); 2666 PETSC_EXTERN PetscErrorCode PetscBinaryWrite(int,void*,PetscInt,PetscDataType,PetscBool ); 2667 PETSC_EXTERN PetscErrorCode PetscBinaryOpen(const char[],PetscFileMode,int *); 2668 PETSC_EXTERN PetscErrorCode PetscBinaryClose(int); 2669 PETSC_EXTERN PetscErrorCode PetscSharedTmp(MPI_Comm,PetscBool *); 2670 PETSC_EXTERN PetscErrorCode PetscSharedWorkingDirectory(MPI_Comm,PetscBool *); 2671 PETSC_EXTERN PetscErrorCode PetscGetTmp(MPI_Comm,char[],size_t); 2672 PETSC_EXTERN PetscErrorCode PetscFileRetrieve(MPI_Comm,const char[],char[],size_t,PetscBool *); 2673 PETSC_EXTERN PetscErrorCode PetscLs(MPI_Comm,const char[],char[],size_t,PetscBool *); 2674 #if defined(PETSC_USE_SOCKET_VIEWER) 2675 PETSC_EXTERN PetscErrorCode PetscOpenSocket(const char[],int,int*); 2676 #endif 2677 2678 /* 2679 In binary files variables are stored using the following lengths, 2680 regardless of how they are stored in memory on any one particular 2681 machine. Use these rather then sizeof() in computing sizes for 2682 PetscBinarySeek(). 2683 */ 2684 #define PETSC_BINARY_INT_SIZE (32/8) 2685 #define PETSC_BINARY_FLOAT_SIZE (32/8) 2686 #define PETSC_BINARY_CHAR_SIZE (8/8) 2687 #define PETSC_BINARY_SHORT_SIZE (16/8) 2688 #define PETSC_BINARY_DOUBLE_SIZE (64/8) 2689 #define PETSC_BINARY_SCALAR_SIZE sizeof(PetscScalar) 2690 2691 /*E 2692 PetscBinarySeekType - argument to PetscBinarySeek() 2693 2694 Level: advanced 2695 2696 .seealso: PetscBinarySeek(), PetscBinarySynchronizedSeek() 2697 E*/ 2698 typedef enum {PETSC_BINARY_SEEK_SET = 0,PETSC_BINARY_SEEK_CUR = 1,PETSC_BINARY_SEEK_END = 2} PetscBinarySeekType; 2699 PETSC_EXTERN PetscErrorCode PetscBinarySeek(int,off_t,PetscBinarySeekType,off_t*); 2700 PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedSeek(MPI_Comm,int,off_t,PetscBinarySeekType,off_t*); 2701 PETSC_EXTERN PetscErrorCode PetscByteSwap(void *,PetscDataType,PetscInt); 2702 2703 PETSC_EXTERN PetscErrorCode PetscSetDebugTerminal(const char[]); 2704 PETSC_EXTERN PetscErrorCode PetscSetDebugger(const char[],PetscBool ); 2705 PETSC_EXTERN PetscErrorCode PetscSetDefaultDebugger(void); 2706 PETSC_EXTERN PetscErrorCode PetscSetDebuggerFromString(const char*); 2707 PETSC_EXTERN PetscErrorCode PetscAttachDebugger(void); 2708 PETSC_EXTERN PetscErrorCode PetscStopForDebugger(void); 2709 2710 PETSC_EXTERN PetscErrorCode PetscGatherNumberOfMessages(MPI_Comm,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt*); 2711 PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**); 2712 PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths2(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**,PetscMPIInt**); 2713 PETSC_EXTERN PetscErrorCode PetscPostIrecvInt(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscInt***,MPI_Request**); 2714 PETSC_EXTERN PetscErrorCode PetscPostIrecvScalar(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscScalar***,MPI_Request**); 2715 PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSided(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt*,const void*,PetscMPIInt*,PetscMPIInt**,void*) 2716 PetscAttrMPIPointerWithType(6,3); 2717 PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedF(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt[],const void*,PetscMPIInt*,PetscMPIInt**,void*,PetscMPIInt, 2718 PetscErrorCode (*send)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,PetscMPIInt,void*,MPI_Request[],void*), 2719 PetscErrorCode (*recv)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,void*,MPI_Request[],void*),void *ctx) 2720 PetscAttrMPIPointerWithType(6,3); 2721 PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedFReq(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt[],const void*,PetscMPIInt*,PetscMPIInt**,void*,PetscMPIInt, 2722 MPI_Request**,MPI_Request**, 2723 PetscErrorCode (*send)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,PetscMPIInt,void*,MPI_Request[],void*), 2724 PetscErrorCode (*recv)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,void*,MPI_Request[],void*),void *ctx) 2725 PetscAttrMPIPointerWithType(6,3); 2726 2727 /*E 2728 PetscBuildTwoSidedType - algorithm for setting up two-sided communication 2729 2730 $ PETSC_BUILDTWOSIDED_ALLREDUCE - classical algorithm using an MPI_Allreduce with 2731 $ a buffer of length equal to the communicator size. Not memory-scalable due to 2732 $ the large reduction size. Requires only MPI-1. 2733 $ PETSC_BUILDTWOSIDED_IBARRIER - nonblocking algorithm based on MPI_Issend and MPI_Ibarrier. 2734 $ Proved communication-optimal in Hoefler, Siebert, and Lumsdaine (2010). Requires MPI-3. 2735 $ PETSC_BUILDTWOSIDED_REDSCATTER - similar to above, but use more optimized function 2736 $ that only communicates the part of the reduction that is necessary. Requires MPI-2. 2737 2738 Level: developer 2739 2740 .seealso: PetscCommBuildTwoSided(), PetscCommBuildTwoSidedSetType(), PetscCommBuildTwoSidedGetType() 2741 E*/ 2742 typedef enum { 2743 PETSC_BUILDTWOSIDED_NOTSET = -1, 2744 PETSC_BUILDTWOSIDED_ALLREDUCE = 0, 2745 PETSC_BUILDTWOSIDED_IBARRIER = 1, 2746 PETSC_BUILDTWOSIDED_REDSCATTER = 2 2747 /* Updates here must be accompanied by updates in finclude/petscsys.h and the string array in mpits.c */ 2748 } PetscBuildTwoSidedType; 2749 PETSC_EXTERN const char *const PetscBuildTwoSidedTypes[]; 2750 PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedSetType(MPI_Comm,PetscBuildTwoSidedType); 2751 PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedGetType(MPI_Comm,PetscBuildTwoSidedType*); 2752 2753 PETSC_EXTERN PetscErrorCode PetscSSEIsEnabled(MPI_Comm,PetscBool *,PetscBool *); 2754 2755 /*E 2756 InsertMode - Whether entries are inserted or added into vectors or matrices 2757 2758 Level: beginner 2759 2760 .seealso: VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(), 2761 VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), 2762 MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd() 2763 E*/ 2764 typedef enum {NOT_SET_VALUES, INSERT_VALUES, ADD_VALUES, MAX_VALUES, INSERT_ALL_VALUES, ADD_ALL_VALUES, INSERT_BC_VALUES, ADD_BC_VALUES} InsertMode; 2765 2766 /*MC 2767 INSERT_VALUES - Put a value into a vector or matrix, overwrites any previous value 2768 2769 Level: beginner 2770 2771 .seealso: InsertMode, VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(), 2772 VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), ADD_VALUES, 2773 MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd(), MAX_VALUES 2774 2775 M*/ 2776 2777 /*MC 2778 ADD_VALUES - Adds a value into a vector or matrix, if there previously was no value, just puts the 2779 value into that location 2780 2781 Level: beginner 2782 2783 .seealso: InsertMode, VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(), 2784 VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), INSERT_VALUES, 2785 MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd(), MAX_VALUES 2786 2787 M*/ 2788 2789 /*MC 2790 MAX_VALUES - Puts the maximum of the scattered/gathered value and the current value into each location 2791 2792 Level: beginner 2793 2794 .seealso: InsertMode, VecScatterBegin(), VecScatterEnd(), ADD_VALUES, INSERT_VALUES 2795 2796 M*/ 2797 2798 PETSC_EXTERN MPI_Comm PetscObjectComm(PetscObject); 2799 2800 typedef enum {PETSC_SUBCOMM_GENERAL=0,PETSC_SUBCOMM_CONTIGUOUS=1,PETSC_SUBCOMM_INTERLACED=2} PetscSubcommType; 2801 PETSC_EXTERN const char *const PetscSubcommTypes[]; 2802 2803 /*S 2804 PetscSubcomm - A decomposition of an MPI communicator into subcommunicators 2805 2806 Notes: 2807 After a call to PetscSubcommSetType(), PetscSubcommSetTypeGeneral(), or PetscSubcommSetFromOptions() one may call 2808 $ PetscSubcommChild() returns the associated subcommunicator on this process 2809 $ PetscSubcommContiguousParent() returns a parent communitor but with all child of the same subcommunicator having contiguous rank 2810 2811 Sample Usage: 2812 PetscSubcommCreate() 2813 PetscSubcommSetNumber() 2814 PetscSubcommSetType(PETSC_SUBCOMM_INTERLACED); 2815 ccomm = PetscSubcommChild() 2816 PetscSubcommDestroy() 2817 2818 Level: advanced 2819 2820 Concepts: communicator, create 2821 2822 Notes: 2823 $ 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 2824 $ PETSC_SUBCOMM_CONTIGUOUS - each new communicator contains a set of process with contiguous ranks in the original MPI communicator 2825 $ PETSC_SUBCOMM_INTERLACED - each new communictor contains a set of processes equally far apart in rank from the others in that new communicator 2826 2827 Example: Consider a communicator with six processes split into 3 subcommunicators. 2828 $ 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 2829 $ PETSC_SUBCOMM_INTERLACED - the first communicator contains rank 0,3, the second 1,4 and the third 2,5 2830 2831 Developer Notes: 2832 This is used in objects such as PCREDUNDANT to manage the subcommunicators on which the redundant computations 2833 are performed. 2834 2835 2836 .seealso: PetscSubcommCreate(), PetscSubcommSetNumber(), PetscSubcommSetType(), PetscSubcommView(), PetscSubcommSetFromOptions() 2837 2838 S*/ 2839 typedef struct _n_PetscSubcomm* PetscSubcomm; 2840 2841 struct _n_PetscSubcomm { 2842 MPI_Comm parent; /* parent communicator */ 2843 MPI_Comm dupparent; /* duplicate parent communicator, under which the processors of this subcomm have contiguous rank */ 2844 MPI_Comm child; /* the sub-communicator */ 2845 PetscMPIInt n; /* num of subcommunicators under the parent communicator */ 2846 PetscMPIInt color; /* color of processors belong to this communicator */ 2847 PetscMPIInt *subsize; /* size of subcommunicator[color] */ 2848 PetscSubcommType type; 2849 char *subcommprefix; 2850 }; 2851 2852 PETSC_STATIC_INLINE MPI_Comm PetscSubcommParent(PetscSubcomm scomm) {return scomm->parent;} 2853 PETSC_STATIC_INLINE MPI_Comm PetscSubcommChild(PetscSubcomm scomm) {return scomm->child;} 2854 PETSC_STATIC_INLINE MPI_Comm PetscSubcommContiguousParent(PetscSubcomm scomm) {return scomm->dupparent;} 2855 PETSC_EXTERN PetscErrorCode PetscSubcommCreate(MPI_Comm,PetscSubcomm*); 2856 PETSC_EXTERN PetscErrorCode PetscSubcommDestroy(PetscSubcomm*); 2857 PETSC_EXTERN PetscErrorCode PetscSubcommSetNumber(PetscSubcomm,PetscInt); 2858 PETSC_EXTERN PetscErrorCode PetscSubcommSetType(PetscSubcomm,PetscSubcommType); 2859 PETSC_EXTERN PetscErrorCode PetscSubcommSetTypeGeneral(PetscSubcomm,PetscMPIInt,PetscMPIInt); 2860 PETSC_EXTERN PetscErrorCode PetscSubcommView(PetscSubcomm,PetscViewer); 2861 PETSC_EXTERN PetscErrorCode PetscSubcommSetFromOptions(PetscSubcomm); 2862 PETSC_EXTERN PetscErrorCode PetscSubcommSetOptionsPrefix(PetscSubcomm,const char[]); 2863 2864 /*S 2865 PetscHeap - A simple class for managing heaps 2866 2867 Level: intermediate 2868 2869 Concepts: random numbers 2870 2871 .seealso: PetscHeapCreate(), PetscHeapAdd(), PetscHeapPop(), PetscHeapPeek(), PetscHeapStash(), PetscHeapUnstash(), PetscHeapView(), PetscHeapDestroy() 2872 S*/ 2873 typedef struct _PetscHeap *PetscHeap; 2874 2875 PETSC_EXTERN PetscErrorCode PetscHeapCreate(PetscInt,PetscHeap*); 2876 PETSC_EXTERN PetscErrorCode PetscHeapAdd(PetscHeap,PetscInt,PetscInt); 2877 PETSC_EXTERN PetscErrorCode PetscHeapPop(PetscHeap,PetscInt*,PetscInt*); 2878 PETSC_EXTERN PetscErrorCode PetscHeapPeek(PetscHeap,PetscInt*,PetscInt*); 2879 PETSC_EXTERN PetscErrorCode PetscHeapStash(PetscHeap,PetscInt,PetscInt); 2880 PETSC_EXTERN PetscErrorCode PetscHeapUnstash(PetscHeap); 2881 PETSC_EXTERN PetscErrorCode PetscHeapDestroy(PetscHeap*); 2882 PETSC_EXTERN PetscErrorCode PetscHeapView(PetscHeap,PetscViewer); 2883 2884 PETSC_EXTERN PetscErrorCode PetscProcessPlacementView(PetscViewer); 2885 typedef struct _n_PetscCommShared* PetscCommShared; 2886 PETSC_EXTERN PetscErrorCode PetscCommSharedGet(MPI_Comm,PetscCommShared*); 2887 PETSC_EXTERN PetscErrorCode PetscCommSharedGlobalToLocal(PetscCommShared,PetscMPIInt,PetscMPIInt*); 2888 PETSC_EXTERN PetscErrorCode PetscCommSharedGetComm(PetscCommShared,MPI_Comm*); 2889 2890 /*S 2891 PetscSegBuffer - a segmented extendable buffer 2892 2893 Level: developer 2894 2895 .seealso: PetscSegBufferCreate(), PetscSegBufferGet(), PetscSegBufferExtract(), PetscSegBufferDestroy() 2896 S*/ 2897 typedef struct _n_PetscSegBuffer *PetscSegBuffer; 2898 PETSC_EXTERN PetscErrorCode PetscSegBufferCreate(size_t,size_t,PetscSegBuffer*); 2899 PETSC_EXTERN PetscErrorCode PetscSegBufferDestroy(PetscSegBuffer*); 2900 PETSC_EXTERN PetscErrorCode PetscSegBufferGet(PetscSegBuffer,size_t,void*); 2901 PETSC_EXTERN PetscErrorCode PetscSegBufferExtractAlloc(PetscSegBuffer,void*); 2902 PETSC_EXTERN PetscErrorCode PetscSegBufferExtractTo(PetscSegBuffer,void*); 2903 PETSC_EXTERN PetscErrorCode PetscSegBufferExtractInPlace(PetscSegBuffer,void*); 2904 PETSC_EXTERN PetscErrorCode PetscSegBufferGetSize(PetscSegBuffer,size_t*); 2905 PETSC_EXTERN PetscErrorCode PetscSegBufferUnuse(PetscSegBuffer,size_t); 2906 2907 2908 /* Type-safe wrapper to encourage use of PETSC_RESTRICT. Does not use PetscFunctionBegin because the error handling 2909 * prevents the compiler from completely erasing the stub. This is called in inner loops so it has to be as fast as 2910 * possible. */ 2911 PETSC_STATIC_INLINE PetscErrorCode PetscSegBufferGetInts(PetscSegBuffer seg,PetscInt count,PetscInt *PETSC_RESTRICT *slot) {return PetscSegBufferGet(seg,(size_t)count,(void**)slot);} 2912 2913 typedef struct _n_PetscOptionsHelpPrinted *PetscOptionsHelpPrinted; 2914 extern PetscOptionsHelpPrinted PetscOptionsHelpPrintedSingleton; 2915 PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedDestroy(PetscOptionsHelpPrinted*); 2916 PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedCreate(PetscOptionsHelpPrinted*); 2917 PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedCheck(PetscOptionsHelpPrinted,const char*,const char*,PetscBool*); 2918 2919 PETSC_EXTERN PetscSegBuffer PetscCitationsList; 2920 2921 /*@C 2922 PetscCitationsRegister - Register a bibtex item to obtain credit for an implemented algorithm used in the code. 2923 2924 Not Collective - only what is registered on rank 0 of PETSC_COMM_WORLD will be printed 2925 2926 Input Parameters: 2927 + cite - the bibtex item, formated to displayed on multiple lines nicely 2928 - set - a boolean variable initially set to PETSC_FALSE; this is used to insure only a single registration of the citation 2929 2930 Level: intermediate 2931 2932 Options Database: 2933 . -citations [filename] - print out the bibtex entries for the given computation 2934 @*/ 2935 PETSC_STATIC_INLINE PetscErrorCode PetscCitationsRegister(const char cit[],PetscBool *set) 2936 { 2937 size_t len; 2938 char *vstring; 2939 PetscErrorCode ierr; 2940 2941 PetscFunctionBegin; 2942 if (set && *set) PetscFunctionReturn(0); 2943 ierr = PetscStrlen(cit,&len);CHKERRQ(ierr); 2944 ierr = PetscSegBufferGet(PetscCitationsList,len,&vstring);CHKERRQ(ierr); 2945 ierr = PetscMemcpy(vstring,cit,len);CHKERRQ(ierr); 2946 if (set) *set = PETSC_TRUE; 2947 PetscFunctionReturn(0); 2948 } 2949 2950 PETSC_EXTERN PetscErrorCode PetscURLShorten(const char[],char[],size_t); 2951 PETSC_EXTERN PetscErrorCode PetscGoogleDriveAuthorize(MPI_Comm,char[],char[],size_t); 2952 PETSC_EXTERN PetscErrorCode PetscGoogleDriveRefresh(MPI_Comm,const char[],char[],size_t); 2953 PETSC_EXTERN PetscErrorCode PetscGoogleDriveUpload(MPI_Comm,const char[],const char []); 2954 2955 PETSC_EXTERN PetscErrorCode PetscBoxAuthorize(MPI_Comm,char[],char[],size_t); 2956 PETSC_EXTERN PetscErrorCode PetscBoxRefresh(MPI_Comm,const char[],char[],char[],size_t); 2957 2958 PETSC_EXTERN PetscErrorCode PetscGlobusGetTransfers(MPI_Comm,const char[],char[],size_t); 2959 2960 PETSC_EXTERN PetscErrorCode PetscTextBelt(MPI_Comm,const char[],const char[],PetscBool*); 2961 PETSC_EXTERN PetscErrorCode PetscTellMyCell(MPI_Comm,const char[],const char[],PetscBool*); 2962 2963 PETSC_EXTERN PetscErrorCode PetscPullJSONValue(const char[],const char[],char[],size_t,PetscBool*); 2964 PETSC_EXTERN PetscErrorCode PetscPushJSONValue(char[],const char[],const char[],size_t); 2965 2966 2967 #if defined(PETSC_USE_DEBUG) 2968 /* 2969 Verify that all processes in the communicator have called this from the same line of code 2970 */ 2971 PETSC_EXTERN PetscErrorCode PetscAllreduceBarrierCheck(MPI_Comm,PetscMPIInt,int,const char*,const char *); 2972 2973 /*MC 2974 MPIU_Allreduce - a PETSc replacement for MPI_Allreduce() that tries to determine if the call from all the MPI processes occur from the 2975 same place in the PETSc code. This helps to detect bugs where different MPI processes follow different code paths 2976 resulting in inconsistent and incorrect calls to MPI_Allreduce(). 2977 2978 Collective on MPI_Comm 2979 2980 Synopsis: 2981 #include <petscsys.h> 2982 PetscErrorCode MPIU_Allreduce(void *indata,void *outdata,PetscMPIInt count,MPI_Datatype datatype, MPI_Op op, MPI_Comm comm); 2983 2984 Input Parameters: 2985 + indata - pointer to the input data to be reduced 2986 . count - the number of MPI data items in indata and outdata 2987 . datatype - the MPI datatype, for example MPI_INT 2988 . op - the MPI operation, for example MPI_SUM 2989 - comm - the MPI communicator on which the operation occurs 2990 2991 Output Parameter: 2992 . outdata - the reduced values 2993 2994 Notes: 2995 In optimized mode this directly calls MPI_Allreduce() 2996 2997 Level: developer 2998 2999 .seealso: MPI_Allreduce() 3000 M*/ 3001 #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)) 3002 #else 3003 #define MPIU_Allreduce(a,b,c,d,e,fcomm) MPI_Allreduce(a,b,c,d,e,fcomm) 3004 #endif 3005 3006 /* 3007 Returned from PETSc functions that are called from MPI, such as related to attributes 3008 */ 3009 PETSC_EXTERN PetscMPIInt PETSC_MPI_ERROR_CLASS,PETSC_MPI_ERROR_CODE; 3010 3011 #endif 3012