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