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