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