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