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