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