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