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 in the conf/variables definition of PETSC_INCLUDE. For --prefix installs the ${PETSC_ARCH}/ 12 does not exist and petscconf.h is in the same 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__GNU_SOURCE) && !defined(_GNU_SOURCE) 29 #define _GNU_SOURCE 30 #endif 31 #endif 32 33 /* ========================================================================== */ 34 /* 35 This facilitates using the C version of PETSc from C++ and the 36 C++ version from C. Use --with-c-support --with-clanguage=c++ with ./configure for the latter) 37 */ 38 #if defined(PETSC_CLANGUAGE_CXX) && !defined(PETSC_USE_EXTERN_CXX) && !defined(__cplusplus) 39 #error "PETSc configured with --with-clanguage=c++ and NOT --with-c-support - it can be used only with a C++ compiler" 40 #endif 41 42 #if defined(__cplusplus) 43 # define PETSC_FUNCTION_NAME PETSC_FUNCTION_NAME_CXX 44 #else 45 # define PETSC_FUNCTION_NAME PETSC_FUNCTION_NAME_C 46 #endif 47 48 #if defined(_WIN32) && defined(PETSC_USE_SHARED_LIBRARIES) /* For Win32 shared libraries */ 49 # define PETSC_DLLEXPORT __declspec(dllexport) 50 # define PETSC_DLLIMPORT __declspec(dllimport) 51 #elif defined(PETSC_USE_VISIBILITY) 52 # define PETSC_DLLEXPORT __attribute__((visibility ("default"))) 53 # define PETSC_DLLIMPORT __attribute__((visibility ("default"))) 54 #else 55 # define PETSC_DLLEXPORT 56 # define PETSC_DLLIMPORT 57 #endif 58 59 #if defined(petsc_EXPORTS) /* CMake defines this when building the shared library */ 60 # define PETSC_VISIBILITY_PUBLIC PETSC_DLLEXPORT 61 #else /* Win32 users need this to import symbols from petsc.dll */ 62 # define PETSC_VISIBILITY_PUBLIC PETSC_DLLIMPORT 63 #endif 64 65 #if defined(PETSC_USE_EXTERN_CXX) && defined(__cplusplus) 66 #define PETSC_EXTERN extern "C" PETSC_VISIBILITY_PUBLIC 67 #define PETSC_EXTERN_TYPEDEF extern "C" 68 #else 69 #define PETSC_EXTERN extern PETSC_VISIBILITY_PUBLIC 70 #define PETSC_EXTERN_TYPEDEF 71 #endif 72 73 #include <petscversion.h> 74 #define PETSC_AUTHOR_INFO " The PETSc Team\n petsc-maint@mcs.anl.gov\n http://www.mcs.anl.gov/petsc/\n" 75 76 /* ========================================================================== */ 77 78 /* 79 Defines the interface to MPI allowing the use of all MPI functions. 80 81 PETSc does not use the C++ binding of MPI at ALL. The following flag 82 makes sure the C++ bindings are not included. The C++ bindings REQUIRE 83 putting mpi.h before ANY C++ include files, we cannot control this 84 with all PETSc users. Users who want to use the MPI C++ bindings can include 85 mpicxx.h directly in their code 86 */ 87 #define MPICH_SKIP_MPICXX 1 88 #define OMPI_SKIP_MPICXX 1 89 #include <mpi.h> 90 91 /* 92 Need to put stdio.h AFTER mpi.h for MPICH2 with C++ compiler 93 see the top of mpicxx.h in the MPICH2 distribution. 94 */ 95 #include <stdio.h> 96 97 /* MSMPI on 32bit windows requires this yukky hack - that breaks MPI standard compliance */ 98 #if !defined(MPIAPI) 99 #define MPIAPI 100 #endif 101 102 103 /*MC 104 PetscErrorCode - datatype used for return error code from all PETSc functions 105 106 Level: beginner 107 108 .seealso: CHKERRQ, SETERRQ 109 M*/ 110 typedef int PetscErrorCode; 111 112 /*MC 113 114 PetscClassId - A unique id used to identify each PETSc class. 115 (internal integer in the data structure used for error 116 checking). These are all computed by an offset from the lowest 117 one, PETSC_SMALLEST_CLASSID. 118 119 Level: advanced 120 121 .seealso: PetscClassIdRegister(), PetscLogEventRegister(), PetscHeaderCreate() 122 M*/ 123 typedef int PetscClassId; 124 125 126 /*MC 127 PetscMPIInt - datatype used to represent 'int' parameters to MPI functions. 128 129 Level: intermediate 130 131 Notes: usually this is the same as PetscInt, but if PETSc was built with --with-64-bit-indices but 132 standard C/Fortran integers are 32 bit then this is NOT the same as PetscInt it remains 32 bit 133 134 PetscMPIIntCheck(a) checks if the given PetscInt a will fit in a PetscMPIInt, if not it generates a 135 PETSC_ERR_ARG_OUTOFRANGE error. 136 137 PetscMPIInt b = PetscMPIIntCast(a) checks if the given PetscInt a will fit in a PetscMPIInt, if not it 138 generates a PETSC_ERR_ARG_OUTOFRANGE error. 139 140 .seealso: PetscBLASInt, PetscInt 141 142 M*/ 143 typedef int PetscMPIInt; 144 145 /*MC 146 PetscEnum - datatype used to pass enum types within PETSc functions. 147 148 Level: intermediate 149 150 .seealso: PetscOptionsGetEnum(), PetscOptionsEnum(), PetscBagRegisterEnum() 151 M*/ 152 typedef enum { ENUM_DUMMY } PetscEnum; 153 154 /*MC 155 PetscInt - PETSc type that represents integer - used primarily to 156 represent size of arrays and indexing into arrays. Its size can be configured with the option 157 --with-64-bit-indices - to be either 32bit or 64bit [default 32 bit ints] 158 159 Level: intermediate 160 161 .seealso: PetscScalar, PetscBLASInt, PetscMPIInt 162 M*/ 163 #if (PETSC_SIZEOF_LONG_LONG == 8) 164 typedef long long Petsc64bitInt; 165 #elif defined(PETSC_HAVE___INT64) 166 typedef __int64 Petsc64bitInt; 167 #else 168 typedef unknown64bit Petsc64bitInt 169 #endif 170 #if defined(PETSC_USE_64BIT_INDICES) 171 typedef Petsc64bitInt PetscInt; 172 #define MPIU_INT MPI_LONG_LONG_INT 173 #else 174 typedef int PetscInt; 175 #define MPIU_INT MPI_INT 176 #endif 177 178 179 /*MC 180 PetscBLASInt - datatype used to represent 'int' parameters to BLAS/LAPACK functions. 181 182 Level: intermediate 183 184 Notes: usually this is the same as PetscInt, but if PETSc was built with --with-64-bit-indices but 185 standard C/Fortran integers are 32 bit then this is NOT the same as PetscInt it remains 32 bit 186 (except on very rare BLAS/LAPACK implementations that support 64 bit integers see the note below). 187 188 PetscBLASIntCheck(a) checks if the given PetscInt a will fit in a PetscBLASInt, if not it generates a 189 PETSC_ERR_ARG_OUTOFRANGE error. 190 191 PetscBLASInt b = PetscBLASIntCast(a) checks if the given PetscInt a will fit in a PetscBLASInt, if not it 192 generates a PETSC_ERR_ARG_OUTOFRANGE error 193 194 Installation Notes: The 64bit versions of MATLAB ship with BLAS and LAPACK that use 64 bit integers for sizes etc, 195 if you run ./configure with the option 196 --with-blas-lapack-lib=[/Applications/MATLAB_R2010b.app/bin/maci64/libmwblas.dylib,/Applications/MATLAB_R2010b.app/bin/maci64/libmwlapack.dylib] 197 but you need to also use --known-64-bit-blas-indices. 198 199 MKL also ships with 64 bit integer versions of the BLAS and LAPACK, if you select those you must also ./configure with --known-64-bit-blas-indices 200 201 Developer Notes: Eventually ./configure should automatically determine the size of the integers used by BLAS/LAPACK. 202 203 External packages such as hypre, ML, SuperLU etc do not provide any support for passing 64 bit integers to BLAS/LAPACK so cannot 204 be used with PETSc if you have set PetscBLASInt to long int. 205 206 .seealso: PetscMPIInt, PetscInt 207 208 M*/ 209 #if defined(PETSC_HAVE_64BIT_BLAS_INDICES) 210 typedef Petsc64bitInt PetscBLASInt; 211 #else 212 typedef int PetscBLASInt; 213 #endif 214 215 /*EC 216 217 PetscPrecision - indicates what precision the object is using. This is currently not used. 218 219 Level: advanced 220 221 .seealso: PetscObjectSetPrecision() 222 E*/ 223 typedef enum { PETSC_PRECISION_SINGLE=4,PETSC_PRECISION_DOUBLE=8 } PetscPrecision; 224 PETSC_EXTERN const char *PetscPrecisions[]; 225 226 /* 227 For the rare cases when one needs to send a size_t object with MPI 228 */ 229 #if (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_INT) 230 #define MPIU_SIZE_T MPI_INT 231 #elif (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_LONG) 232 #define MPIU_SIZE_T MPI_LONG 233 #elif (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_LONG_LONG) 234 #define MPIU_SIZE_T MPI_LONG_LONG_INT 235 #else 236 #error "Unknown size for size_t! Send us a bugreport at petsc-maint@mcs.anl.gov" 237 #endif 238 239 240 /* 241 You can use PETSC_STDOUT as a replacement of stdout. You can also change 242 the value of PETSC_STDOUT to redirect all standard output elsewhere 243 */ 244 PETSC_EXTERN FILE* PETSC_STDOUT; 245 246 /* 247 You can use PETSC_STDERR as a replacement of stderr. You can also change 248 the value of PETSC_STDERR to redirect all standard error elsewhere 249 */ 250 PETSC_EXTERN FILE* PETSC_STDERR; 251 252 /*MC 253 PetscUnlikely - hints the compiler that the given condition is usually FALSE 254 255 Synopsis: 256 PetscBool PetscUnlikely(PetscBool cond) 257 258 Not Collective 259 260 Input Parameters: 261 . cond - condition or expression 262 263 Note: This returns the same truth value, it is only a hint to compilers that the resulting 264 branch is unlikely. 265 266 Level: advanced 267 268 .seealso: PetscLikely(), CHKERRQ 269 M*/ 270 271 /*MC 272 PetscLikely - hints the compiler that the given condition is usually TRUE 273 274 Synopsis: 275 PetscBool PetscUnlikely(PetscBool cond) 276 277 Not Collective 278 279 Input Parameters: 280 . cond - condition or expression 281 282 Note: This returns the same truth value, it is only a hint to compilers that the resulting 283 branch is likely. 284 285 Level: advanced 286 287 .seealso: PetscUnlikely() 288 M*/ 289 #if defined(PETSC_HAVE_BUILTIN_EXPECT) 290 # define PetscUnlikely(cond) __builtin_expect(!!(cond),0) 291 # define PetscLikely(cond) __builtin_expect(!!(cond),1) 292 #else 293 # define PetscUnlikely(cond) (cond) 294 # define PetscLikely(cond) (cond) 295 #endif 296 297 /* 298 Defines some elementary mathematics functions and constants. 299 */ 300 #include <petscmath.h> 301 302 /* 303 Declare extern C stuff after including external header files 304 */ 305 306 307 /* 308 Basic PETSc constants 309 */ 310 311 /*E 312 PetscBool - Logical variable. Actually an int in C and a logical in Fortran. 313 314 Level: beginner 315 316 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 317 boolean values. It is not easy to have a simple macro that that will work properly in all circumstances with all three mechanisms. 318 319 E*/ 320 typedef enum { PETSC_FALSE,PETSC_TRUE } PetscBool; 321 PETSC_EXTERN const char *const PetscBools[]; 322 323 /*E 324 PetscCopyMode - Determines how an array passed to certain functions is copied or retained 325 326 Level: beginner 327 328 $ PETSC_COPY_VALUES - the array values are copied into new space, the user is free to reuse or delete the passed in array 329 $ 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 330 $ delete the array. The array MUST have been obtained with PetscMalloc(). Hence this mode cannot be used in Fortran. 331 $ 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 332 the array but the user must delete the array after the object is destroyed. 333 334 E*/ 335 typedef enum { PETSC_COPY_VALUES, PETSC_OWN_POINTER, PETSC_USE_POINTER} PetscCopyMode; 336 PETSC_EXTERN const char *const PetscCopyModes[]; 337 338 /*MC 339 PETSC_FALSE - False value of PetscBool 340 341 Level: beginner 342 343 Note: Zero integer 344 345 .seealso: PetscBool , PETSC_TRUE 346 M*/ 347 348 /*MC 349 PETSC_TRUE - True value of PetscBool 350 351 Level: beginner 352 353 Note: Nonzero integer 354 355 .seealso: PetscBool , PETSC_FALSE 356 M*/ 357 358 /*MC 359 PETSC_NULL - standard way of passing in a null or array or pointer 360 361 Level: beginner 362 363 Notes: accepted by many PETSc functions to not set a parameter and instead use 364 some default 365 366 This macro does not exist in Fortran; you must use PETSC_NULL_INTEGER, 367 PETSC_NULL_DOUBLE_PRECISION, PETSC_NULL_FUNCTION, PETSC_NULL_OBJECT etc 368 369 Developer Note: Why have PETSC_NULL, why not just use NULL? The problem is that NULL is defined in different include files under 370 different versions of Unix. It is tricky to insure the correct include file is always included. 371 372 .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_IGNORE, PETSC_DETERMINE 373 374 M*/ 375 #define PETSC_NULL 0 376 377 /*MC 378 PETSC_IGNORE - same as PETSC_NULL, means PETSc will ignore this argument 379 380 Level: beginner 381 382 Note: accepted by many PETSc functions to not set a parameter and instead use 383 some default 384 385 Fortran Notes: This macro does not exist in Fortran; you must use PETSC_NULL_INTEGER, 386 PETSC_NULL_DOUBLE_PRECISION etc 387 388 .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_NULL, PETSC_DETERMINE 389 390 M*/ 391 #define PETSC_IGNORE PETSC_NULL 392 393 /*MC 394 PETSC_DECIDE - standard way of passing in integer or floating point parameter 395 where you wish PETSc to use the default. 396 397 Level: beginner 398 399 .seealso: PETSC_NULL, PETSC_DEFAULT, PETSC_IGNORE, PETSC_DETERMINE 400 401 M*/ 402 #define PETSC_DECIDE -1 403 404 /*MC 405 PETSC_DETERMINE - standard way of passing in integer or floating point parameter 406 where you wish PETSc to compute the required value. 407 408 Level: beginner 409 410 411 Developer Note: I would like to use const PetscInt PETSC_DETERMINE = PETSC_DECIDE; but for 412 some reason this is not allowed by the standard even though PETSC_DECIDE is a constant value. 413 414 .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_IGNORE, PETSC_NULL, VecSetSizes() 415 416 M*/ 417 #define PETSC_DETERMINE PETSC_DECIDE 418 419 /*MC 420 PETSC_DEFAULT - standard way of passing in integer or floating point parameter 421 where you wish PETSc to use the default. 422 423 Level: beginner 424 425 Fortran Notes: You need to use PETSC_DEFAULT_INTEGER or PETSC_DEFAULT_DOUBLE_PRECISION. 426 427 .seealso: PETSC_DECIDE, PETSC_NULL, PETSC_IGNORE, PETSC_DETERMINE 428 429 M*/ 430 #define PETSC_DEFAULT -2 431 432 /*MC 433 PETSC_COMM_WORLD - the equivalent of the MPI_COMM_WORLD communicator which represents 434 all the processs that PETSc knows about. 435 436 Level: beginner 437 438 Notes: By default PETSC_COMM_WORLD and MPI_COMM_WORLD are identical unless you wish to 439 run PETSc on ONLY a subset of MPI_COMM_WORLD. In that case create your new (smaller) 440 communicator, call it, say comm, and set PETSC_COMM_WORLD = comm BEFORE calling 441 PetscInitialize() 442 443 .seealso: PETSC_COMM_SELF 444 445 M*/ 446 PETSC_EXTERN MPI_Comm PETSC_COMM_WORLD; 447 448 /*MC 449 PETSC_COMM_SELF - This is always MPI_COMM_SELF 450 451 Level: beginner 452 453 .seealso: PETSC_COMM_WORLD 454 455 M*/ 456 #define PETSC_COMM_SELF MPI_COMM_SELF 457 458 PETSC_EXTERN PetscBool PetscInitializeCalled; 459 PETSC_EXTERN PetscBool PetscFinalizeCalled; 460 PETSC_EXTERN PetscBool PetscCUSPSynchronize; 461 462 PETSC_EXTERN PetscErrorCode PetscSetHelpVersionFunctions(PetscErrorCode (*)(MPI_Comm),PetscErrorCode (*)(MPI_Comm)); 463 PETSC_EXTERN PetscErrorCode PetscCommDuplicate(MPI_Comm,MPI_Comm*,int*); 464 PETSC_EXTERN PetscErrorCode PetscCommDestroy(MPI_Comm*); 465 466 /*MC 467 PetscMalloc - Allocates memory 468 469 Synopsis: 470 PetscErrorCode PetscMalloc(size_t m,void **result) 471 472 Not Collective 473 474 Input Parameter: 475 . m - number of bytes to allocate 476 477 Output Parameter: 478 . result - memory allocated 479 480 Level: beginner 481 482 Notes: Memory is always allocated at least double aligned 483 484 If you request memory of zero size it will allocate no space and assign the pointer to 0; PetscFree() will 485 properly handle not freeing the null pointer. 486 487 .seealso: PetscFree(), PetscNew() 488 489 Concepts: memory allocation 490 491 M*/ 492 #define PetscMalloc(a,b) ((a != 0) ? (*PetscTrMalloc)((a),__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__,(void**)(b)) : (*(b) = 0,0) ) 493 494 /*MC 495 PetscAddrAlign - Rounds up an address to PETSC_MEMALIGN alignment 496 497 Synopsis: 498 void *PetscAddrAlign(void *addr) 499 500 Not Collective 501 502 Input Parameters: 503 . addr - address to align (any pointer type) 504 505 Level: developer 506 507 .seealso: PetscMallocAlign() 508 509 Concepts: memory allocation 510 M*/ 511 #define PetscAddrAlign(a) (void*)((((PETSC_UINTPTR_T)(a))+(PETSC_MEMALIGN-1)) & ~(PETSC_MEMALIGN-1)) 512 513 /*MC 514 PetscMalloc2 - Allocates 2 chunks of memory both aligned to PETSC_MEMALIGN 515 516 Synopsis: 517 PetscErrorCode PetscMalloc2(size_t m1,type, t1,void **r1,size_t m2,type t2,void **r2) 518 519 Not Collective 520 521 Input Parameter: 522 + m1 - number of elements to allocate in 1st chunk (may be zero) 523 . t1 - type of first memory elements 524 . m2 - number of elements to allocate in 2nd chunk (may be zero) 525 - t2 - type of second memory elements 526 527 Output Parameter: 528 + r1 - memory allocated in first chunk 529 - r2 - memory allocated in second chunk 530 531 Level: developer 532 533 .seealso: PetscFree(), PetscNew(), PetscMalloc() 534 535 Concepts: memory allocation 536 537 M*/ 538 #if defined(PETSC_USE_DEBUG) 539 #define PetscMalloc2(m1,t1,r1,m2,t2,r2) (PetscMalloc((m1)*sizeof(t1),r1) || PetscMalloc((m2)*sizeof(t2),r2)) 540 #else 541 #define PetscMalloc2(m1,t1,r1,m2,t2,r2) ((*(r2) = 0,PetscMalloc((m1)*sizeof(t1)+(m2)*sizeof(t2)+(PETSC_MEMALIGN-1),r1)) || (*(r2) = (t2*)PetscAddrAlign(*(r1)+m1),0)) 542 #endif 543 544 /*MC 545 PetscMalloc3 - Allocates 3 chunks of memory all aligned to PETSC_MEMALIGN 546 547 Synopsis: 548 PetscErrorCode PetscMalloc3(size_t m1,type, t1,void **r1,size_t m2,type t2,void **r2,size_t m3,type t3,void **r3) 549 550 Not Collective 551 552 Input Parameter: 553 + m1 - number of elements to allocate in 1st chunk (may be zero) 554 . t1 - type of first memory elements 555 . m2 - number of elements to allocate in 2nd chunk (may be zero) 556 . t2 - type of second memory elements 557 . m3 - number of elements to allocate in 3rd chunk (may be zero) 558 - t3 - type of third memory elements 559 560 Output Parameter: 561 + r1 - memory allocated in first chunk 562 . r2 - memory allocated in second chunk 563 - r3 - memory allocated in third chunk 564 565 Level: developer 566 567 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree3() 568 569 Concepts: memory allocation 570 571 M*/ 572 #if defined(PETSC_USE_DEBUG) 573 #define PetscMalloc3(m1,t1,r1,m2,t2,r2,m3,t3,r3) (PetscMalloc((m1)*sizeof(t1),r1) || PetscMalloc((m2)*sizeof(t2),r2) || PetscMalloc((m3)*sizeof(t3),r3)) 574 #else 575 #define PetscMalloc3(m1,t1,r1,m2,t2,r2,m3,t3,r3) ((*(r2) = 0,*(r3) = 0,PetscMalloc((m1)*sizeof(t1)+(m2)*sizeof(t2)+(m3)*sizeof(t3)+2*(PETSC_MEMALIGN-1),r1)) \ 576 || (*(r2) = (t2*)PetscAddrAlign(*(r1)+m1),*(r3) = (t3*)PetscAddrAlign(*(r2)+m2),0)) 577 #endif 578 579 /*MC 580 PetscMalloc4 - Allocates 4 chunks of memory all aligned to PETSC_MEMALIGN 581 582 Synopsis: 583 PetscErrorCode PetscMalloc4(size_t m1,type, t1,void **r1,size_t m2,type t2,void **r2,size_t m3,type t3,void **r3,size_t m4,type t4,void **r4) 584 585 Not Collective 586 587 Input Parameter: 588 + m1 - number of elements to allocate in 1st chunk (may be zero) 589 . t1 - type of first memory elements 590 . m2 - number of elements to allocate in 2nd chunk (may be zero) 591 . t2 - type of second memory elements 592 . m3 - number of elements to allocate in 3rd chunk (may be zero) 593 . t3 - type of third memory elements 594 . m4 - number of elements to allocate in 4th chunk (may be zero) 595 - t4 - type of fourth memory elements 596 597 Output Parameter: 598 + r1 - memory allocated in first chunk 599 . r2 - memory allocated in second chunk 600 . r3 - memory allocated in third chunk 601 - r4 - memory allocated in fourth chunk 602 603 Level: developer 604 605 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree3(), PetscFree4() 606 607 Concepts: memory allocation 608 609 M*/ 610 #if defined(PETSC_USE_DEBUG) 611 #define PetscMalloc4(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4) (PetscMalloc((m1)*sizeof(t1),r1) || PetscMalloc((m2)*sizeof(t2),r2) || PetscMalloc((m3)*sizeof(t3),r3) || PetscMalloc((m4)*sizeof(t4),r4)) 612 #else 613 #define PetscMalloc4(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4) \ 614 ((*(r2) = 0, *(r3) = 0, *(r4) = 0,PetscMalloc((m1)*sizeof(t1)+(m2)*sizeof(t2)+(m3)*sizeof(t3)+(m4)*sizeof(t4)+3*(PETSC_MEMALIGN-1),r1)) \ 615 || (*(r2) = (t2*)PetscAddrAlign(*(r1)+m1),*(r3) = (t3*)PetscAddrAlign(*(r2)+m2),*(r4) = (t4*)PetscAddrAlign(*(r3)+m3),0)) 616 #endif 617 618 /*MC 619 PetscMalloc5 - Allocates 5 chunks of memory all aligned to PETSC_MEMALIGN 620 621 Synopsis: 622 PetscErrorCode PetscMalloc5(size_t m1,type, t1,void **r1,size_t m2,type t2,void **r2,size_t m3,type t3,void **r3,size_t m4,type t4,void **r4,size_t m5,type t5,void **r5) 623 624 Not Collective 625 626 Input Parameter: 627 + m1 - number of elements to allocate in 1st chunk (may be zero) 628 . t1 - type of first memory elements 629 . m2 - number of elements to allocate in 2nd chunk (may be zero) 630 . t2 - type of second memory elements 631 . m3 - number of elements to allocate in 3rd chunk (may be zero) 632 . t3 - type of third memory elements 633 . m4 - number of elements to allocate in 4th chunk (may be zero) 634 . t4 - type of fourth memory elements 635 . m5 - number of elements to allocate in 5th chunk (may be zero) 636 - t5 - type of fifth memory elements 637 638 Output Parameter: 639 + r1 - memory allocated in first chunk 640 . r2 - memory allocated in second chunk 641 . r3 - memory allocated in third chunk 642 . r4 - memory allocated in fourth chunk 643 - r5 - memory allocated in fifth chunk 644 645 Level: developer 646 647 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree3(), PetscFree4(), PetscFree5() 648 649 Concepts: memory allocation 650 651 M*/ 652 #if defined(PETSC_USE_DEBUG) 653 #define PetscMalloc5(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4,m5,t5,r5) (PetscMalloc((m1)*sizeof(t1),r1) || PetscMalloc((m2)*sizeof(t2),r2) || PetscMalloc((m3)*sizeof(t3),r3) || PetscMalloc((m4)*sizeof(t4),r4) || PetscMalloc((m5)*sizeof(t5),r5)) 654 #else 655 #define PetscMalloc5(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4,m5,t5,r5) \ 656 ((*(r2) = 0, *(r3) = 0, *(r4) = 0,*(r5) = 0,PetscMalloc((m1)*sizeof(t1)+(m2)*sizeof(t2)+(m3)*sizeof(t3)+(m4)*sizeof(t4)+(m5)*sizeof(t5)+4*(PETSC_MEMALIGN-1),r1)) \ 657 || (*(r2) = (t2*)PetscAddrAlign(*(r1)+m1),*(r3) = (t3*)PetscAddrAlign(*(r2)+m2),*(r4) = (t4*)PetscAddrAlign(*(r3)+m3),*(r5) = (t5*)PetscAddrAlign(*(r4)+m4),0)) 658 #endif 659 660 661 /*MC 662 PetscMalloc6 - Allocates 6 chunks of memory all aligned to PETSC_MEMALIGN 663 664 Synopsis: 665 PetscErrorCode PetscMalloc6(size_t m1,type, t1,void **r1,size_t m2,type t2,void **r2,size_t m3,type t3,void **r3,size_t m4,type t4,void **r4,size_t m5,type t5,void **r5,size_t m6,type t6,void **r6) 666 667 Not Collective 668 669 Input Parameter: 670 + m1 - number of elements to allocate in 1st chunk (may be zero) 671 . t1 - type of first memory elements 672 . m2 - number of elements to allocate in 2nd chunk (may be zero) 673 . t2 - type of second memory elements 674 . m3 - number of elements to allocate in 3rd chunk (may be zero) 675 . t3 - type of third memory elements 676 . m4 - number of elements to allocate in 4th chunk (may be zero) 677 . t4 - type of fourth memory elements 678 . m5 - number of elements to allocate in 5th chunk (may be zero) 679 . t5 - type of fifth memory elements 680 . m6 - number of elements to allocate in 6th chunk (may be zero) 681 - t6 - type of sixth memory elements 682 683 Output Parameter: 684 + r1 - memory allocated in first chunk 685 . r2 - memory allocated in second chunk 686 . r3 - memory allocated in third chunk 687 . r4 - memory allocated in fourth chunk 688 . r5 - memory allocated in fifth chunk 689 - r6 - memory allocated in sixth chunk 690 691 Level: developer 692 693 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree3(), PetscFree4(), PetscFree5(), PetscFree6() 694 695 Concepts: memory allocation 696 697 M*/ 698 #if defined(PETSC_USE_DEBUG) 699 #define PetscMalloc6(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4,m5,t5,r5,m6,t6,r6) (PetscMalloc((m1)*sizeof(t1),r1) || PetscMalloc((m2)*sizeof(t2),r2) || PetscMalloc((m3)*sizeof(t3),r3) || PetscMalloc((m4)*sizeof(t4),r4) || PetscMalloc((m5)*sizeof(t5),r5) || PetscMalloc((m6)*sizeof(t6),r6)) 700 #else 701 #define PetscMalloc6(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4,m5,t5,r5,m6,t6,r6) \ 702 ((*(r2) = 0, *(r3) = 0, *(r4) = 0,*(r5) = 0,*(r6) = 0,PetscMalloc((m1)*sizeof(t1)+(m2)*sizeof(t2)+(m3)*sizeof(t3)+(m4)*sizeof(t4)+(m5)*sizeof(t5)+(m6)*sizeof(t6)+5*(PETSC_MEMALIGN-1),r1)) \ 703 || (*(r2) = (t2*)PetscAddrAlign(*(r1)+m1),*(r3) = (t3*)PetscAddrAlign(*(r2)+m2),*(r4) = (t4*)PetscAddrAlign(*(r3)+m3),*(r5) = (t5*)PetscAddrAlign(*(r4)+m4),*(r6) = (t6*)PetscAddrAlign(*(r5)+m5),0)) 704 #endif 705 706 /*MC 707 PetscMalloc7 - Allocates 7 chunks of memory all aligned to PETSC_MEMALIGN 708 709 Synopsis: 710 PetscErrorCode PetscMalloc7(size_t m1,type, t1,void **r1,size_t m2,type t2,void **r2,size_t m3,type t3,void **r3,size_t m4,type t4,void **r4,size_t m5,type t5,void **r5,size_t m6,type t6,void **r6,size_t m7,type t7,void **r7) 711 712 Not Collective 713 714 Input Parameter: 715 + m1 - number of elements to allocate in 1st chunk (may be zero) 716 . t1 - type of first memory elements 717 . m2 - number of elements to allocate in 2nd chunk (may be zero) 718 . t2 - type of second memory elements 719 . m3 - number of elements to allocate in 3rd chunk (may be zero) 720 . t3 - type of third memory elements 721 . m4 - number of elements to allocate in 4th chunk (may be zero) 722 . t4 - type of fourth memory elements 723 . m5 - number of elements to allocate in 5th chunk (may be zero) 724 . t5 - type of fifth memory elements 725 . m6 - number of elements to allocate in 6th chunk (may be zero) 726 . t6 - type of sixth memory elements 727 . m7 - number of elements to allocate in 7th chunk (may be zero) 728 - t7 - type of sixth memory elements 729 730 Output Parameter: 731 + r1 - memory allocated in first chunk 732 . r2 - memory allocated in second chunk 733 . r3 - memory allocated in third chunk 734 . r4 - memory allocated in fourth chunk 735 . r5 - memory allocated in fifth chunk 736 . r6 - memory allocated in sixth chunk 737 - r7 - memory allocated in seventh chunk 738 739 Level: developer 740 741 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree3(), PetscFree4(), PetscFree5(), PetscFree6(), PetscFree7() 742 743 Concepts: memory allocation 744 745 M*/ 746 #if defined(PETSC_USE_DEBUG) 747 #define PetscMalloc7(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4,m5,t5,r5,m6,t6,r6,m7,t7,r7) (PetscMalloc((m1)*sizeof(t1),r1) || PetscMalloc((m2)*sizeof(t2),r2) || PetscMalloc((m3)*sizeof(t3),r3) || PetscMalloc((m4)*sizeof(t4),r4) || PetscMalloc((m5)*sizeof(t5),r5) || PetscMalloc((m6)*sizeof(t6),r6) || PetscMalloc((m7)*sizeof(t7),r7)) 748 #else 749 #define PetscMalloc7(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4,m5,t5,r5,m6,t6,r6,m7,t7,r7) \ 750 ((*(r2) = 0, *(r3) = 0, *(r4) = 0,*(r5) = 0,*(r6) = 0,*(r7) = 0,PetscMalloc((m1)*sizeof(t1)+(m2)*sizeof(t2)+(m3)*sizeof(t3)+(m4)*sizeof(t4)+(m5)*sizeof(t5)+(m6)*sizeof(t6)+(m7)*sizeof(t7)+6*(PETSC_MEMALIGN-1),r1)) \ 751 || (*(r2) = (t2*)PetscAddrAlign(*(r1)+m1),*(r3) = (t3*)PetscAddrAlign(*(r2)+m2),*(r4) = (t4*)PetscAddrAlign(*(r3)+m3),*(r5) = (t5*)PetscAddrAlign(*(r4)+m4),*(r6) = (t6*)PetscAddrAlign(*(r5)+m5),*(r7) = (t7*)PetscAddrAlign(*(r6)+m6),0)) 752 #endif 753 754 /*MC 755 PetscNew - Allocates memory of a particular type, zeros the memory! Aligned to PETSC_MEMALIGN 756 757 Synopsis: 758 PetscErrorCode PetscNew(struct type,((type *))result) 759 760 Not Collective 761 762 Input Parameter: 763 . type - structure name of space to be allocated. Memory of size sizeof(type) is allocated 764 765 Output Parameter: 766 . result - memory allocated 767 768 Level: beginner 769 770 .seealso: PetscFree(), PetscMalloc(), PetscNewLog() 771 772 Concepts: memory allocation 773 774 M*/ 775 #define PetscNew(A,b) (PetscMalloc(sizeof(A),(b)) || PetscMemzero(*(b),sizeof(A))) 776 777 /*MC 778 PetscNewLog - Allocates memory of a particular type, zeros the memory! Aligned to PETSC_MEMALIGN. Associates the memory allocated 779 with the given object using PetscLogObjectMemory(). 780 781 Synopsis: 782 PetscErrorCode PetscNewLog(PetscObject obj,struct type,((type *))result) 783 784 Not Collective 785 786 Input Parameter: 787 + obj - object memory is logged to 788 - type - structure name of space to be allocated. Memory of size sizeof(type) is allocated 789 790 Output Parameter: 791 . result - memory allocated 792 793 Level: developer 794 795 .seealso: PetscFree(), PetscMalloc(), PetscNew(), PetscLogObjectMemory() 796 797 Concepts: memory allocation 798 799 M*/ 800 #define PetscNewLog(o,A,b) (PetscNew(A,b) || ((o) ? PetscLogObjectMemory(o,sizeof(A)) : 0)) 801 802 /*MC 803 PetscFree - Frees memory 804 805 Synopsis: 806 PetscErrorCode PetscFree(void *memory) 807 808 Not Collective 809 810 Input Parameter: 811 . memory - memory to free (the pointer is ALWAYS set to 0 upon sucess) 812 813 Level: beginner 814 815 Notes: Memory must have been obtained with PetscNew() or PetscMalloc() 816 817 .seealso: PetscNew(), PetscMalloc(), PetscFreeVoid() 818 819 Concepts: memory allocation 820 821 M*/ 822 #define PetscFree(a) ((a) && ((*PetscTrFree)((void*)(a),__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__) || ((a) = 0,0))) 823 824 /*MC 825 PetscFreeVoid - Frees memory 826 827 Synopsis: 828 void PetscFreeVoid(void *memory) 829 830 Not Collective 831 832 Input Parameter: 833 . memory - memory to free 834 835 Level: beginner 836 837 Notes: This is different from PetscFree() in that no error code is returned 838 839 .seealso: PetscFree(), PetscNew(), PetscMalloc() 840 841 Concepts: memory allocation 842 843 M*/ 844 #define PetscFreeVoid(a) ((*PetscTrFree)((a),__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__),(a) = 0) 845 846 847 /*MC 848 PetscFree2 - Frees 2 chunks of memory obtained with PetscMalloc2() 849 850 Synopsis: 851 PetscErrorCode PetscFree2(void *memory1,void *memory2) 852 853 Not Collective 854 855 Input Parameter: 856 + memory1 - memory to free 857 - memory2 - 2nd memory to free 858 859 Level: developer 860 861 Notes: Memory must have been obtained with PetscMalloc2() 862 863 .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree() 864 865 Concepts: memory allocation 866 867 M*/ 868 #if defined(PETSC_USE_DEBUG) 869 #define PetscFree2(m1,m2) (PetscFree(m2) || PetscFree(m1)) 870 #else 871 #define PetscFree2(m1,m2) ((m2)=0, PetscFree(m1)) 872 #endif 873 874 /*MC 875 PetscFree3 - Frees 3 chunks of memory obtained with PetscMalloc3() 876 877 Synopsis: 878 PetscErrorCode PetscFree3(void *memory1,void *memory2,void *memory3) 879 880 Not Collective 881 882 Input Parameter: 883 + memory1 - memory to free 884 . memory2 - 2nd memory to free 885 - memory3 - 3rd memory to free 886 887 Level: developer 888 889 Notes: Memory must have been obtained with PetscMalloc3() 890 891 .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3() 892 893 Concepts: memory allocation 894 895 M*/ 896 #if defined(PETSC_USE_DEBUG) 897 #define PetscFree3(m1,m2,m3) (PetscFree(m3) || PetscFree(m2) || PetscFree(m1)) 898 #else 899 #define PetscFree3(m1,m2,m3) ((m3)=0,(m2)=0,PetscFree(m1)) 900 #endif 901 902 /*MC 903 PetscFree4 - Frees 4 chunks of memory obtained with PetscMalloc4() 904 905 Synopsis: 906 PetscErrorCode PetscFree4(void *m1,void *m2,void *m3,void *m4) 907 908 Not Collective 909 910 Input Parameter: 911 + m1 - memory to free 912 . m2 - 2nd memory to free 913 . m3 - 3rd memory to free 914 - m4 - 4th memory to free 915 916 Level: developer 917 918 Notes: Memory must have been obtained with PetscMalloc4() 919 920 .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4() 921 922 Concepts: memory allocation 923 924 M*/ 925 #if defined(PETSC_USE_DEBUG) 926 #define PetscFree4(m1,m2,m3,m4) (PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1)) 927 #else 928 #define PetscFree4(m1,m2,m3,m4) ((m4)=0,(m3)=0,(m2)=0,PetscFree(m1)) 929 #endif 930 931 /*MC 932 PetscFree5 - Frees 5 chunks of memory obtained with PetscMalloc5() 933 934 Synopsis: 935 PetscErrorCode PetscFree5(void *m1,void *m2,void *m3,void *m4,void *m5) 936 937 Not Collective 938 939 Input Parameter: 940 + m1 - memory to free 941 . m2 - 2nd memory to free 942 . m3 - 3rd memory to free 943 . m4 - 4th memory to free 944 - m5 - 5th memory to free 945 946 Level: developer 947 948 Notes: Memory must have been obtained with PetscMalloc5() 949 950 .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5() 951 952 Concepts: memory allocation 953 954 M*/ 955 #if defined(PETSC_USE_DEBUG) 956 #define PetscFree5(m1,m2,m3,m4,m5) (PetscFree(m5) || PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1)) 957 #else 958 #define PetscFree5(m1,m2,m3,m4,m5) ((m5)=0,(m4)=0,(m3)=0,(m2)=0,PetscFree(m1)) 959 #endif 960 961 962 /*MC 963 PetscFree6 - Frees 6 chunks of memory obtained with PetscMalloc6() 964 965 Synopsis: 966 PetscErrorCode PetscFree6(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6) 967 968 Not Collective 969 970 Input Parameter: 971 + m1 - memory to free 972 . m2 - 2nd memory to free 973 . m3 - 3rd memory to free 974 . m4 - 4th memory to free 975 . m5 - 5th memory to free 976 - m6 - 6th memory to free 977 978 979 Level: developer 980 981 Notes: Memory must have been obtained with PetscMalloc6() 982 983 .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6() 984 985 Concepts: memory allocation 986 987 M*/ 988 #if defined(PETSC_USE_DEBUG) 989 #define PetscFree6(m1,m2,m3,m4,m5,m6) (PetscFree(m6) || PetscFree(m5) || PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1)) 990 #else 991 #define PetscFree6(m1,m2,m3,m4,m5,m6) ((m6)=0,(m5)=0,(m4)=0,(m3)=0,(m2)=0,PetscFree(m1)) 992 #endif 993 994 /*MC 995 PetscFree7 - Frees 7 chunks of memory obtained with PetscMalloc7() 996 997 Synopsis: 998 PetscErrorCode PetscFree7(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6,void *m7) 999 1000 Not Collective 1001 1002 Input Parameter: 1003 + m1 - memory to free 1004 . m2 - 2nd memory to free 1005 . m3 - 3rd memory to free 1006 . m4 - 4th memory to free 1007 . m5 - 5th memory to free 1008 . m6 - 6th memory to free 1009 - m7 - 7th memory to free 1010 1011 1012 Level: developer 1013 1014 Notes: Memory must have been obtained with PetscMalloc7() 1015 1016 .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6(), 1017 PetscMalloc7() 1018 1019 Concepts: memory allocation 1020 1021 M*/ 1022 #if defined(PETSC_USE_DEBUG) 1023 #define PetscFree7(m1,m2,m3,m4,m5,m6,m7) (PetscFree(m7) || PetscFree(m6) || PetscFree(m5) || PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1)) 1024 #else 1025 #define PetscFree7(m1,m2,m3,m4,m5,m6,m7) ((m7)=0,(m6)=0,(m5)=0,(m4)=0,(m3)=0,(m2)=0,PetscFree(m1)) 1026 #endif 1027 1028 PETSC_EXTERN PetscErrorCode (*PetscTrMalloc)(size_t,int,const char[],const char[],const char[],void**); 1029 PETSC_EXTERN PetscErrorCode (*PetscTrFree)(void*,int,const char[],const char[],const char[]); 1030 PETSC_EXTERN PetscErrorCode PetscMallocSet(PetscErrorCode (*)(size_t,int,const char[],const char[],const char[],void**),PetscErrorCode (*)(void*,int,const char[],const char[],const char[])); 1031 PETSC_EXTERN PetscErrorCode PetscMallocClear(void); 1032 1033 /* 1034 PetscLogDouble variables are used to contain double precision numbers 1035 that are not used in the numerical computations, but rather in logging, 1036 timing etc. 1037 */ 1038 typedef double PetscLogDouble; 1039 #define MPIU_PETSCLOGDOUBLE MPI_DOUBLE 1040 1041 /* 1042 Routines for tracing memory corruption/bleeding with default PETSc memory allocation 1043 */ 1044 PETSC_EXTERN PetscErrorCode PetscMallocDump(FILE *); 1045 PETSC_EXTERN PetscErrorCode PetscMallocDumpLog(FILE *); 1046 PETSC_EXTERN PetscErrorCode PetscMallocGetCurrentUsage(PetscLogDouble *); 1047 PETSC_EXTERN PetscErrorCode PetscMallocGetMaximumUsage(PetscLogDouble *); 1048 PETSC_EXTERN PetscErrorCode PetscMallocDebug(PetscBool); 1049 PETSC_EXTERN PetscErrorCode PetscMallocValidate(int,const char[],const char[],const char[]); 1050 PETSC_EXTERN PetscErrorCode PetscMallocSetDumpLog(void); 1051 PETSC_EXTERN PetscErrorCode PetscMallocSetDumpLogThreshold(PetscLogDouble); 1052 PETSC_EXTERN PetscErrorCode PetscMallocGetDumpLog(PetscBool*); 1053 1054 /*E 1055 PetscDataType - Used for handling different basic data types. 1056 1057 Level: beginner 1058 1059 Developer comment: It would be nice if we could always just use MPI Datatypes, why can we not? 1060 1061 .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscDataTypeToMPIDataType(), 1062 PetscDataTypeGetSize() 1063 1064 E*/ 1065 typedef enum {PETSC_INT = 0,PETSC_DOUBLE = 1,PETSC_COMPLEX = 2, PETSC_LONG = 3 ,PETSC_SHORT = 4,PETSC_FLOAT = 5, 1066 PETSC_CHAR = 6,PETSC_BIT_LOGICAL = 7,PETSC_ENUM = 8,PETSC_BOOL=9, PETSC___FLOAT128 = 10,PETSC_OBJECT = 11, PETSC_FUNCTION = 12} PetscDataType; 1067 PETSC_EXTERN const char *const PetscDataTypes[]; 1068 1069 #if defined(PETSC_USE_COMPLEX) 1070 #define PETSC_SCALAR PETSC_COMPLEX 1071 #else 1072 #if defined(PETSC_USE_REAL_SINGLE) 1073 #define PETSC_SCALAR PETSC_FLOAT 1074 #elif defined(PETSC_USE_REAL___FLOAT128) 1075 #define PETSC_SCALAR PETSC___FLOAT128 1076 #else 1077 #define PETSC_SCALAR PETSC_DOUBLE 1078 #endif 1079 #endif 1080 #if defined(PETSC_USE_REAL_SINGLE) 1081 #define PETSC_REAL PETSC_FLOAT 1082 #elif defined(PETSC_USE_REAL___FLOAT128) 1083 #define PETSC_REAL PETSC___FLOAT128 1084 #else 1085 #define PETSC_REAL PETSC_DOUBLE 1086 #endif 1087 #define PETSC_FORTRANADDR PETSC_LONG 1088 1089 PETSC_EXTERN PetscErrorCode PetscDataTypeToMPIDataType(PetscDataType,MPI_Datatype*); 1090 PETSC_EXTERN PetscErrorCode PetscMPIDataTypeToPetscDataType(MPI_Datatype,PetscDataType*); 1091 PETSC_EXTERN PetscErrorCode PetscDataTypeGetSize(PetscDataType,size_t*); 1092 1093 /* 1094 Basic memory and string operations. These are usually simple wrappers 1095 around the basic Unix system calls, but a few of them have additional 1096 functionality and/or error checking. 1097 */ 1098 PETSC_EXTERN PetscErrorCode PetscBitMemcpy(void*,PetscInt,const void*,PetscInt,PetscInt,PetscDataType); 1099 PETSC_EXTERN PetscErrorCode PetscMemmove(void*,void *,size_t); 1100 PETSC_EXTERN PetscErrorCode PetscMemcmp(const void*,const void*,size_t,PetscBool *); 1101 PETSC_EXTERN PetscErrorCode PetscStrlen(const char[],size_t*); 1102 PETSC_EXTERN PetscErrorCode PetscStrToArray(const char[],char,int*,char ***); 1103 PETSC_EXTERN PetscErrorCode PetscStrToArrayDestroy(int,char **); 1104 PETSC_EXTERN PetscErrorCode PetscStrcmp(const char[],const char[],PetscBool *); 1105 PETSC_EXTERN PetscErrorCode PetscStrgrt(const char[],const char[],PetscBool *); 1106 PETSC_EXTERN PetscErrorCode PetscStrcasecmp(const char[],const char[],PetscBool *); 1107 PETSC_EXTERN PetscErrorCode PetscStrncmp(const char[],const char[],size_t,PetscBool *); 1108 PETSC_EXTERN PetscErrorCode PetscStrcpy(char[],const char[]); 1109 PETSC_EXTERN PetscErrorCode PetscStrcat(char[],const char[]); 1110 PETSC_EXTERN PetscErrorCode PetscStrncat(char[],const char[],size_t); 1111 PETSC_EXTERN PetscErrorCode PetscStrncpy(char[],const char[],size_t); 1112 PETSC_EXTERN PetscErrorCode PetscStrchr(const char[],char,char *[]); 1113 PETSC_EXTERN PetscErrorCode PetscStrtolower(char[]); 1114 PETSC_EXTERN PetscErrorCode PetscStrrchr(const char[],char,char *[]); 1115 PETSC_EXTERN PetscErrorCode PetscStrstr(const char[],const char[],char *[]); 1116 PETSC_EXTERN PetscErrorCode PetscStrrstr(const char[],const char[],char *[]); 1117 PETSC_EXTERN PetscErrorCode PetscStrendswith(const char[],const char[],PetscBool*); 1118 PETSC_EXTERN PetscErrorCode PetscStrbeginswith(const char[],const char[],PetscBool*); 1119 PETSC_EXTERN PetscErrorCode PetscStrendswithwhich(const char[],const char *const*,PetscInt*); 1120 PETSC_EXTERN PetscErrorCode PetscStrallocpy(const char[],char *[]); 1121 PETSC_EXTERN PetscErrorCode PetscStrArrayallocpy(const char *const*,char***); 1122 PETSC_EXTERN PetscErrorCode PetscStrArrayDestroy(char***); 1123 PETSC_EXTERN PetscErrorCode PetscStrreplace(MPI_Comm,const char[],char[],size_t); 1124 1125 /*S 1126 PetscToken - 'Token' used for managing tokenizing strings 1127 1128 Level: intermediate 1129 1130 .seealso: PetscTokenCreate(), PetscTokenFind(), PetscTokenDestroy() 1131 S*/ 1132 typedef struct _p_PetscToken* PetscToken; 1133 1134 PETSC_EXTERN PetscErrorCode PetscTokenCreate(const char[],const char,PetscToken*); 1135 PETSC_EXTERN PetscErrorCode PetscTokenFind(PetscToken,char *[]); 1136 PETSC_EXTERN PetscErrorCode PetscTokenDestroy(PetscToken*); 1137 1138 /* 1139 These are MPI operations for MPI_Allreduce() etc 1140 */ 1141 PETSC_EXTERN MPI_Op PetscMaxSum_Op; 1142 #if (defined(PETSC_USE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) 1143 PETSC_EXTERN MPI_Op MPIU_SUM; 1144 #else 1145 #define MPIU_SUM MPI_SUM 1146 #endif 1147 #if defined(PETSC_USE_REAL___FLOAT128) 1148 PETSC_EXTERN MPI_Op MPIU_MAX; 1149 PETSC_EXTERN MPI_Op MPIU_MIN; 1150 #else 1151 #define MPIU_MAX MPI_MAX 1152 #define MPIU_MIN MPI_MIN 1153 #endif 1154 PETSC_EXTERN PetscErrorCode PetscMaxSum(MPI_Comm,const PetscInt[],PetscInt*,PetscInt*); 1155 1156 PETSC_EXTERN PetscErrorCode MPIULong_Send(void*,PetscInt,MPI_Datatype,PetscMPIInt,PetscMPIInt,MPI_Comm); 1157 PETSC_EXTERN PetscErrorCode MPIULong_Recv(void*,PetscInt,MPI_Datatype,PetscMPIInt,PetscMPIInt,MPI_Comm); 1158 1159 /*S 1160 PetscObject - any PETSc object, PetscViewer, Mat, Vec, KSP etc 1161 1162 Level: beginner 1163 1164 Note: This is the base class from which all PETSc objects are derived from. 1165 1166 .seealso: PetscObjectDestroy(), PetscObjectView(), PetscObjectGetName(), PetscObjectSetName(), PetscObjectReference(), PetscObjectDereferenc() 1167 S*/ 1168 typedef struct _p_PetscObject* PetscObject; 1169 1170 /*S 1171 PetscFList - Linked list of functions, possibly stored in dynamic libraries, accessed 1172 by string name 1173 1174 Level: advanced 1175 1176 .seealso: PetscFListAdd(), PetscFListDestroy(), PetscOpFlist 1177 S*/ 1178 typedef struct _n_PetscFList *PetscFList; 1179 1180 /*S 1181 PetscOpFList - Linked list of operations on objects, implemented by functions, possibly stored in dynamic libraries, 1182 accessed by string op name together with string argument types. 1183 1184 Level: advanced 1185 1186 .seealso: PetscFList, PetscOpFListAdd(), PetscOpFListFind(), PetscOpFListDestroy() 1187 S*/ 1188 typedef struct _n_PetscOpFList *PetscOpFList; 1189 1190 /*E 1191 PetscFileMode - Access mode for a file. 1192 1193 Level: beginner 1194 1195 FILE_MODE_READ - open a file at its beginning for reading 1196 1197 FILE_MODE_WRITE - open a file at its beginning for writing (will create if the file does not exist) 1198 1199 FILE_MODE_APPEND - open a file at end for writing 1200 1201 FILE_MODE_UPDATE - open a file for updating, meaning for reading and writing 1202 1203 FILE_MODE_APPEND_UPDATE - open a file for updating, meaning for reading and writing, at the end 1204 1205 .seealso: PetscViewerFileSetMode() 1206 E*/ 1207 typedef enum {FILE_MODE_READ, FILE_MODE_WRITE, FILE_MODE_APPEND, FILE_MODE_UPDATE, FILE_MODE_APPEND_UPDATE} PetscFileMode; 1208 1209 #include <petscviewer.h> 1210 #include <petscoptions.h> 1211 1212 #define PETSC_SMALLEST_CLASSID 1211211 1213 PETSC_EXTERN PetscClassId PETSC_LARGEST_CLASSID; 1214 PETSC_EXTERN PetscClassId PETSC_OBJECT_CLASSID; 1215 PETSC_EXTERN PetscErrorCode PetscClassIdRegister(const char[],PetscClassId *); 1216 1217 /* 1218 Routines that get memory usage information from the OS 1219 */ 1220 PETSC_EXTERN PetscErrorCode PetscMemoryGetCurrentUsage(PetscLogDouble *); 1221 PETSC_EXTERN PetscErrorCode PetscMemoryGetMaximumUsage(PetscLogDouble *); 1222 PETSC_EXTERN PetscErrorCode PetscMemorySetGetMaximumUsage(void); 1223 PETSC_EXTERN PetscErrorCode PetscMemoryShowUsage(PetscViewer,const char[]); 1224 1225 PETSC_EXTERN PetscErrorCode PetscInfoAllow(PetscBool ,const char []); 1226 PETSC_EXTERN PetscErrorCode PetscGetTime(PetscLogDouble*); 1227 PETSC_EXTERN PetscErrorCode PetscGetCPUTime(PetscLogDouble*); 1228 PETSC_EXTERN PetscErrorCode PetscSleep(PetscReal); 1229 1230 /* 1231 Initialization of PETSc 1232 */ 1233 PETSC_EXTERN PetscErrorCode PetscInitialize(int*,char***,const char[],const char[]); 1234 PETSC_EXTERN PetscErrorCode PetscInitializeNoPointers(int,char**,const char[],const char[]); 1235 PETSC_EXTERN PetscErrorCode PetscInitializeNoArguments(void); 1236 PETSC_EXTERN PetscErrorCode PetscInitialized(PetscBool *); 1237 PETSC_EXTERN PetscErrorCode PetscFinalized(PetscBool *); 1238 PETSC_EXTERN PetscErrorCode PetscFinalize(void); 1239 PETSC_EXTERN PetscErrorCode PetscInitializeFortran(void); 1240 PETSC_EXTERN PetscErrorCode PetscGetArgs(int*,char ***); 1241 PETSC_EXTERN PetscErrorCode PetscGetArguments(char ***); 1242 PETSC_EXTERN PetscErrorCode PetscFreeArguments(char **); 1243 1244 PETSC_EXTERN PetscErrorCode PetscEnd(void); 1245 PETSC_EXTERN PetscErrorCode PetscSysInitializePackage(const char[]); 1246 1247 PETSC_EXTERN MPI_Comm PETSC_COMM_LOCAL_WORLD; 1248 PETSC_EXTERN PetscErrorCode PetscHMPIMerge(PetscMPIInt,PetscErrorCode (*)(void*),void*); 1249 PETSC_EXTERN PetscErrorCode PetscHMPISpawn(PetscMPIInt); 1250 PETSC_EXTERN PetscErrorCode PetscHMPIFinalize(void); 1251 PETSC_EXTERN PetscErrorCode PetscHMPIRun(MPI_Comm,PetscErrorCode (*)(MPI_Comm,void *),void*); 1252 PETSC_EXTERN PetscErrorCode PetscHMPIRunCtx(MPI_Comm,PetscErrorCode (*)(MPI_Comm,void*,void *),void*); 1253 PETSC_EXTERN PetscErrorCode PetscHMPIFree(MPI_Comm,void*); 1254 PETSC_EXTERN PetscErrorCode PetscHMPIMalloc(MPI_Comm,size_t,void**); 1255 1256 PETSC_EXTERN PetscErrorCode PetscPythonInitialize(const char[],const char[]); 1257 PETSC_EXTERN PetscErrorCode PetscPythonFinalize(void); 1258 PETSC_EXTERN PetscErrorCode PetscPythonPrintError(void); 1259 PETSC_EXTERN PetscErrorCode PetscPythonMonitorSet(PetscObject,const char[]); 1260 1261 /* 1262 These are so that in extern C code we can caste function pointers to non-extern C 1263 function pointers. Since the regular C++ code expects its function pointers to be C++ 1264 */ 1265 PETSC_EXTERN_TYPEDEF typedef void (**PetscVoidStarFunction)(void); 1266 PETSC_EXTERN_TYPEDEF typedef void (*PetscVoidFunction)(void); 1267 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*PetscErrorCodeFunction)(void); 1268 1269 /* 1270 PetscTryMethod - Queries an object for a method, if it exists then calls it. 1271 These are intended to be used only inside PETSc functions. 1272 1273 Level: developer 1274 1275 .seealso: PetscUseMethod() 1276 */ 1277 #define PetscTryMethod(obj,A,B,C) \ 1278 0;{ PetscErrorCode (*f)B, __ierr; \ 1279 __ierr = PetscObjectQueryFunction((PetscObject)obj,A,(PetscVoidStarFunction)&f);CHKERRQ(__ierr); \ 1280 if (f) {__ierr = (*f)C;CHKERRQ(__ierr);}\ 1281 } 1282 1283 /* 1284 PetscUseMethod - Queries an object for a method, if it exists then calls it, otherwise generates an error. 1285 These are intended to be used only inside PETSc functions. 1286 1287 Level: developer 1288 1289 .seealso: PetscTryMethod() 1290 */ 1291 #define PetscUseMethod(obj,A,B,C) \ 1292 0;{ PetscErrorCode (*f)B, __ierr; \ 1293 __ierr = PetscObjectQueryFunction((PetscObject)obj,A,(PetscVoidStarFunction)&f);CHKERRQ(__ierr); \ 1294 if (f) {__ierr = (*f)C;CHKERRQ(__ierr);}\ 1295 else SETERRQ1(((PetscObject)obj)->comm,PETSC_ERR_SUP,"Cannot locate function %s in object",A); \ 1296 } 1297 1298 /* 1299 Functions that can act on any PETSc object. 1300 */ 1301 PETSC_EXTERN PetscErrorCode PetscObjectDestroy(PetscObject*); 1302 PETSC_EXTERN PetscErrorCode PetscObjectGetComm(PetscObject,MPI_Comm *); 1303 PETSC_EXTERN PetscErrorCode PetscObjectGetClassId(PetscObject,PetscClassId *); 1304 PETSC_EXTERN PetscErrorCode PetscObjectGetClassName(PetscObject,const char *[]); 1305 PETSC_EXTERN PetscErrorCode PetscObjectSetType(PetscObject,const char []); 1306 PETSC_EXTERN PetscErrorCode PetscObjectSetPrecision(PetscObject,PetscPrecision); 1307 PETSC_EXTERN PetscErrorCode PetscObjectGetType(PetscObject,const char *[]); 1308 PETSC_EXTERN PetscErrorCode PetscObjectSetName(PetscObject,const char[]); 1309 PETSC_EXTERN PetscErrorCode PetscObjectGetName(PetscObject,const char*[]); 1310 PETSC_EXTERN PetscErrorCode PetscObjectPrintClassNamePrefixType(PetscObject,PetscViewer,const char[]); 1311 PETSC_EXTERN PetscErrorCode PetscObjectSetTabLevel(PetscObject,PetscInt); 1312 PETSC_EXTERN PetscErrorCode PetscObjectGetTabLevel(PetscObject,PetscInt*); 1313 PETSC_EXTERN PetscErrorCode PetscObjectIncrementTabLevel(PetscObject,PetscObject,PetscInt); 1314 PETSC_EXTERN PetscErrorCode PetscObjectReference(PetscObject); 1315 PETSC_EXTERN PetscErrorCode PetscObjectGetReference(PetscObject,PetscInt*); 1316 PETSC_EXTERN PetscErrorCode PetscObjectDereference(PetscObject); 1317 PETSC_EXTERN PetscErrorCode PetscObjectGetNewTag(PetscObject,PetscMPIInt *); 1318 PETSC_EXTERN PetscErrorCode PetscObjectView(PetscObject,PetscViewer); 1319 PETSC_EXTERN PetscErrorCode PetscObjectCompose(PetscObject,const char[],PetscObject); 1320 PETSC_EXTERN PetscErrorCode PetscObjectRemoveReference(PetscObject,const char[]); 1321 PETSC_EXTERN PetscErrorCode PetscObjectQuery(PetscObject,const char[],PetscObject *); 1322 PETSC_EXTERN PetscErrorCode PetscObjectComposeFunction(PetscObject,const char[],const char[],void (*)(void)); 1323 PETSC_EXTERN PetscErrorCode PetscObjectSetFromOptions(PetscObject); 1324 PETSC_EXTERN PetscErrorCode PetscObjectSetUp(PetscObject); 1325 PETSC_EXTERN PetscErrorCode PetscCommGetNewTag(MPI_Comm,PetscMPIInt *); 1326 PETSC_EXTERN PetscErrorCode PetscObjectAddOptionsHandler(PetscObject,PetscErrorCode (*)(PetscObject,void*),PetscErrorCode (*)(PetscObject,void*),void*); 1327 PETSC_EXTERN PetscErrorCode PetscObjectProcessOptionsHandlers(PetscObject); 1328 PETSC_EXTERN PetscErrorCode PetscObjectDestroyOptionsHandlers(PetscObject); 1329 PETSC_EXTERN PetscErrorCode PetscObjectsGetGlobalNumbering(MPI_Comm,PetscInt,PetscObject*,PetscInt*,PetscInt*); 1330 1331 /*MC 1332 PetscObjectComposeFunctionDynamic - Associates a function with a given PETSc object. 1333 1334 Synopsis: 1335 PetscErrorCode PetscObjectComposeFunctionDynamic(PetscObject obj,const char name[],const char fname[],void *ptr) 1336 1337 Logically Collective on PetscObject 1338 1339 Input Parameters: 1340 + obj - the PETSc object; this must be cast with a (PetscObject), for example, 1341 PetscObjectCompose((PetscObject)mat,...); 1342 . name - name associated with the child function 1343 . fname - name of the function 1344 - ptr - function pointer (or PETSC_NULL if using dynamic libraries) 1345 1346 Level: advanced 1347 1348 1349 Notes: 1350 To remove a registered routine, pass in a PETSC_NULL rname and fnc(). 1351 1352 PetscObjectComposeFunctionDynamic() can be used with any PETSc object (such as 1353 Mat, Vec, KSP, SNES, etc.) or any user-provided object. 1354 1355 The composed function must be wrapped in a EXTERN_C_BEGIN/END for this to 1356 work in C++/complex with dynamic link libraries (./configure options --with-shared-libraries --with-dynamic-loading) 1357 enabled. 1358 1359 Concepts: objects^composing functions 1360 Concepts: composing functions 1361 Concepts: functions^querying 1362 Concepts: objects^querying 1363 Concepts: querying objects 1364 1365 .seealso: PetscObjectQueryFunction() 1366 M*/ 1367 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 1368 #define PetscObjectComposeFunctionDynamic(a,b,c,d) PetscObjectComposeFunction(a,b,c,0) 1369 #else 1370 #define PetscObjectComposeFunctionDynamic(a,b,c,d) PetscObjectComposeFunction(a,b,c,(PetscVoidFunction)(d)) 1371 #endif 1372 1373 PETSC_EXTERN PetscErrorCode PetscObjectQueryFunction(PetscObject,const char[],void (**)(void)); 1374 PETSC_EXTERN PetscErrorCode PetscObjectSetOptionsPrefix(PetscObject,const char[]); 1375 PETSC_EXTERN PetscErrorCode PetscObjectAppendOptionsPrefix(PetscObject,const char[]); 1376 PETSC_EXTERN PetscErrorCode PetscObjectPrependOptionsPrefix(PetscObject,const char[]); 1377 PETSC_EXTERN PetscErrorCode PetscObjectGetOptionsPrefix(PetscObject,const char*[]); 1378 PETSC_EXTERN PetscErrorCode PetscObjectAMSPublish(PetscObject); 1379 PETSC_EXTERN PetscErrorCode PetscObjectUnPublish(PetscObject); 1380 PETSC_EXTERN PetscErrorCode PetscObjectChangeTypeName(PetscObject,const char[]); 1381 PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroy(PetscObject); 1382 PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroyAll(void); 1383 PETSC_EXTERN PetscErrorCode PetscObjectName(PetscObject); 1384 PETSC_EXTERN PetscErrorCode PetscObjectTypeCompare(PetscObject,const char[],PetscBool *); 1385 PETSC_EXTERN PetscErrorCode PetscObjectTypeCompareAny(PetscObject,PetscBool*,const char[],...); 1386 PETSC_EXTERN PetscErrorCode PetscRegisterFinalize(PetscErrorCode (*)(void)); 1387 PETSC_EXTERN PetscErrorCode PetscRegisterFinalizeAll(void); 1388 1389 typedef void* PetscDLHandle; 1390 typedef enum {PETSC_DL_DECIDE=0,PETSC_DL_NOW=1,PETSC_DL_LOCAL=2} PetscDLMode; 1391 extern PetscErrorCode PetscDLOpen(const char[],PetscDLMode,PetscDLHandle *); 1392 extern PetscErrorCode PetscDLClose(PetscDLHandle *); 1393 extern PetscErrorCode PetscDLSym(PetscDLHandle,const char[],void **); 1394 1395 /* 1396 Defines PETSc error handling. 1397 */ 1398 #include <petscerror.h> 1399 1400 #if defined(PETSC_USE_DEBUG) 1401 PETSC_EXTERN PetscErrorCode PetscMallocGetStack(void*,PetscStack**); 1402 #endif 1403 PETSC_EXTERN PetscErrorCode PetscObjectsDump(FILE*,PetscBool); 1404 1405 /*S 1406 PetscOList - Linked list of PETSc objects, each accessable by string name 1407 1408 Level: developer 1409 1410 Notes: Used by PetscObjectCompose() and PetscObjectQuery() 1411 1412 .seealso: PetscOListAdd(), PetscOListDestroy(), PetscOListFind(), PetscObjectCompose(), PetscObjectQuery(), PetscFList 1413 S*/ 1414 typedef struct _n_PetscOList *PetscOList; 1415 1416 PETSC_EXTERN PetscErrorCode PetscOListDestroy(PetscOList*); 1417 PETSC_EXTERN PetscErrorCode PetscOListFind(PetscOList,const char[],PetscObject*); 1418 PETSC_EXTERN PetscErrorCode PetscOListReverseFind(PetscOList,PetscObject,char**,PetscBool*); 1419 PETSC_EXTERN PetscErrorCode PetscOListAdd(PetscOList *,const char[],PetscObject); 1420 PETSC_EXTERN PetscErrorCode PetscOListRemoveReference(PetscOList *,const char[]); 1421 PETSC_EXTERN PetscErrorCode PetscOListDuplicate(PetscOList,PetscOList *); 1422 1423 /* 1424 Dynamic library lists. Lists of names of routines in objects or in dynamic 1425 link libraries that will be loaded as needed. 1426 */ 1427 PETSC_EXTERN PetscErrorCode PetscFListAdd(PetscFList*,const char[],const char[],void (*)(void)); 1428 PETSC_EXTERN PetscErrorCode PetscFListDestroy(PetscFList*); 1429 PETSC_EXTERN PetscErrorCode PetscFListFind(PetscFList,MPI_Comm,const char[],PetscBool,void (**)(void)); 1430 PETSC_EXTERN PetscErrorCode PetscFListPrintTypes(MPI_Comm,FILE*,const char[],const char[],const char[],const char[],PetscFList,const char[]); 1431 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 1432 #define PetscFListAddDynamic(a,b,p,c) PetscFListAdd(a,b,p,0) 1433 #else 1434 #define PetscFListAddDynamic(a,b,p,c) PetscFListAdd(a,b,p,(void (*)(void))c) 1435 #endif 1436 PETSC_EXTERN PetscErrorCode PetscFListDuplicate(PetscFList,PetscFList *); 1437 PETSC_EXTERN PetscErrorCode PetscFListView(PetscFList,PetscViewer); 1438 PETSC_EXTERN PetscErrorCode PetscFListConcat(const char [],const char [],char []); 1439 PETSC_EXTERN PetscErrorCode PetscFListGet(PetscFList,const char ***,int*); 1440 1441 /* 1442 Multiple dispatch operation function lists. Lists of names of routines with corresponding 1443 argument type names with function pointers or in dynamic link libraries that will be loaded 1444 as needed. Search on the op name and argument type names. 1445 */ 1446 PETSC_EXTERN PetscErrorCode PetscOpFListAdd(MPI_Comm, PetscOpFList*,const char[],PetscVoidFunction, const char[], PetscInt, char*[]); 1447 PETSC_EXTERN PetscErrorCode PetscOpFListDestroy(PetscOpFList*); 1448 PETSC_EXTERN PetscErrorCode PetscOpFListFind(MPI_Comm, PetscOpFList, PetscVoidFunction*, const char[], PetscInt, char*[]); 1449 PETSC_EXTERN PetscErrorCode PetscOpFListView(PetscOpFList,PetscViewer); 1450 1451 /*S 1452 PetscDLLibrary - Linked list of dynamics libraries to search for functions 1453 1454 Level: advanced 1455 1456 --with-shared-libraries --with-dynamic-loading must be used with ./configure to use dynamic libraries 1457 1458 .seealso: PetscDLLibraryOpen() 1459 S*/ 1460 typedef struct _n_PetscDLLibrary *PetscDLLibrary; 1461 PETSC_EXTERN PetscDLLibrary PetscDLLibrariesLoaded; 1462 PETSC_EXTERN PetscErrorCode PetscDLLibraryAppend(MPI_Comm,PetscDLLibrary *,const char[]); 1463 PETSC_EXTERN PetscErrorCode PetscDLLibraryPrepend(MPI_Comm,PetscDLLibrary *,const char[]); 1464 PETSC_EXTERN PetscErrorCode PetscDLLibrarySym(MPI_Comm,PetscDLLibrary *,const char[],const char[],void **); 1465 PETSC_EXTERN PetscErrorCode PetscDLLibraryPrintPath(PetscDLLibrary); 1466 PETSC_EXTERN PetscErrorCode PetscDLLibraryRetrieve(MPI_Comm,const char[],char *,size_t,PetscBool *); 1467 PETSC_EXTERN PetscErrorCode PetscDLLibraryOpen(MPI_Comm,const char[],PetscDLLibrary *); 1468 PETSC_EXTERN PetscErrorCode PetscDLLibraryClose(PetscDLLibrary); 1469 1470 /* 1471 PetscShell support. Needs to be better documented. 1472 Logically it is an extension of PetscDLLXXX, PetscObjectCompose, etc. 1473 */ 1474 #include <petscshell.h> 1475 1476 /* 1477 Useful utility routines 1478 */ 1479 PETSC_EXTERN PetscErrorCode PetscSplitOwnership(MPI_Comm,PetscInt*,PetscInt*); 1480 PETSC_EXTERN PetscErrorCode PetscSplitOwnershipBlock(MPI_Comm,PetscInt,PetscInt*,PetscInt*); 1481 PETSC_EXTERN PetscErrorCode PetscSequentialPhaseBegin(MPI_Comm,PetscMPIInt); 1482 PETSC_EXTERN PetscErrorCode PetscSequentialPhaseEnd(MPI_Comm,PetscMPIInt); 1483 PETSC_EXTERN PetscErrorCode PetscBarrier(PetscObject); 1484 PETSC_EXTERN PetscErrorCode PetscMPIDump(FILE*); 1485 1486 /* 1487 PetscNot - negates a logical type value and returns result as a PetscBool 1488 1489 Notes: This is useful in cases like 1490 $ int *a; 1491 $ PetscBool flag = PetscNot(a) 1492 where !a does not return a PetscBool because we cannot provide a cast from int to PetscBool in C. 1493 */ 1494 #define PetscNot(a) ((a) ? PETSC_FALSE : PETSC_TRUE) 1495 1496 /* 1497 Defines basic graphics available from PETSc. 1498 */ 1499 #include <petscdraw.h> 1500 1501 #if defined(PETSC_HAVE_VALGRIND) 1502 # include <valgrind/valgrind.h> 1503 # define PETSC_RUNNING_ON_VALGRIND RUNNING_ON_VALGRIND 1504 #else 1505 # define PETSC_RUNNING_ON_VALGRIND PETSC_FALSE 1506 #endif 1507 1508 /* 1509 Defines the base data structures for all PETSc objects 1510 */ 1511 #include <petsc-private/petscimpl.h> 1512 1513 1514 /*MC 1515 PetscErrorPrintf - Prints error messages. 1516 1517 Synopsis: 1518 PetscErrorCode (*PetscErrorPrintf)(const char format[],...); 1519 1520 Not Collective 1521 1522 Input Parameters: 1523 . format - the usual printf() format string 1524 1525 Options Database Keys: 1526 + -error_output_stdout - cause error messages to be printed to stdout instead of the 1527 (default) stderr 1528 - -error_output_none to turn off all printing of error messages (does not change the way the 1529 error is handled.) 1530 1531 Notes: Use 1532 $ PetscErrorPrintf = PetscErrorPrintfNone; to turn off all printing of error messages (does not change the way the 1533 $ error is handled.) and 1534 $ PetscErrorPrintf = PetscErrorPrintfDefault; to turn it back on 1535 $ of you can use your own function 1536 1537 Use 1538 PETSC_STDERR = FILE* obtained from a file open etc. to have stderr printed to the file. 1539 PETSC_STDOUT = FILE* obtained from a file open etc. to have stdout printed to the file. 1540 1541 Use 1542 PetscPushErrorHandler() to provide your own error handler that determines what kind of messages to print 1543 1544 Level: developer 1545 1546 Fortran Note: 1547 This routine is not supported in Fortran. 1548 1549 Concepts: error messages^printing 1550 Concepts: printing^error messages 1551 1552 .seealso: PetscFPrintf(), PetscSynchronizedPrintf(), PetscHelpPrintf(), PetscPrintf(), PetscErrorHandlerPush(), PetscVFPrintf(), PetscHelpPrintf() 1553 M*/ 1554 PETSC_EXTERN PetscErrorCode (*PetscErrorPrintf)(const char[],...); 1555 1556 /*MC 1557 PetscHelpPrintf - Prints help messages. 1558 1559 Synopsis: 1560 PetscErrorCode (*PetscHelpPrintf)(const char format[],...); 1561 1562 Not Collective 1563 1564 Input Parameters: 1565 . format - the usual printf() format string 1566 1567 Level: developer 1568 1569 Fortran Note: 1570 This routine is not supported in Fortran. 1571 1572 Concepts: help messages^printing 1573 Concepts: printing^help messages 1574 1575 .seealso: PetscFPrintf(), PetscSynchronizedPrintf(), PetscErrorPrintf() 1576 M*/ 1577 PETSC_EXTERN PetscErrorCode (*PetscHelpPrintf)(MPI_Comm,const char[],...); 1578 1579 /* 1580 Defines PETSc profiling. 1581 */ 1582 #include <petsclog.h> 1583 1584 /* 1585 For locking, unlocking and destroying AMS memories associated with PETSc objects. ams.h is included in petscviewer.h 1586 */ 1587 #if defined(PETSC_HAVE_AMS) 1588 PETSC_EXTERN PetscBool PetscAMSPublishAll; 1589 #define PetscObjectTakeAccess(obj) ((((PetscObject)(obj))->amem == -1) ? 0 : AMS_Memory_take_access(((PetscObject)(obj))->amem)) 1590 #define PetscObjectGrantAccess(obj) ((((PetscObject)(obj))->amem == -1) ? 0 : AMS_Memory_grant_access(((PetscObject)(obj))->amem)) 1591 #define PetscObjectDepublish(obj) ((((PetscObject)(obj))->amem == -1) ? 0 : AMS_Memory_destroy(((PetscObject)(obj))->amem));((PetscObject)(obj))->amem = -1; 1592 #else 1593 #define PetscObjectTakeAccess(obj) 0 1594 #define PetscObjectGrantAccess(obj) 0 1595 #define PetscObjectDepublish(obj) 0 1596 #endif 1597 1598 /* 1599 Simple PETSc parallel IO for ASCII printing 1600 */ 1601 PETSC_EXTERN PetscErrorCode PetscFixFilename(const char[],char[]); 1602 PETSC_EXTERN PetscErrorCode PetscFOpen(MPI_Comm,const char[],const char[],FILE**); 1603 PETSC_EXTERN PetscErrorCode PetscFClose(MPI_Comm,FILE*); 1604 PETSC_EXTERN PetscErrorCode PetscFPrintf(MPI_Comm,FILE*,const char[],...); 1605 PETSC_EXTERN PetscErrorCode PetscPrintf(MPI_Comm,const char[],...); 1606 PETSC_EXTERN PetscErrorCode PetscSNPrintf(char*,size_t,const char [],...); 1607 PETSC_EXTERN PetscErrorCode PetscSNPrintfCount(char*,size_t,const char [],size_t*,...); 1608 1609 /* These are used internally by PETSc ASCII IO routines*/ 1610 #include <stdarg.h> 1611 PETSC_EXTERN PetscErrorCode PetscVSNPrintf(char*,size_t,const char[],size_t*,va_list); 1612 PETSC_EXTERN PetscErrorCode (*PetscVFPrintf)(FILE*,const char[],va_list); 1613 PETSC_EXTERN PetscErrorCode PetscVFPrintfDefault(FILE*,const char[],va_list); 1614 1615 #if defined(PETSC_HAVE_MATLAB_ENGINE) 1616 PETSC_EXTERN PetscErrorCode PetscVFPrintf_Matlab(FILE*,const char[],va_list); 1617 #endif 1618 1619 PETSC_EXTERN PetscErrorCode PetscErrorPrintfDefault(const char [],...); 1620 PETSC_EXTERN PetscErrorCode PetscErrorPrintfNone(const char [],...); 1621 PETSC_EXTERN PetscErrorCode PetscHelpPrintfDefault(MPI_Comm,const char [],...); 1622 1623 #if defined(PETSC_HAVE_POPEN) 1624 PETSC_EXTERN PetscErrorCode PetscPOpen(MPI_Comm,const char[],const char[],const char[],FILE **); 1625 PETSC_EXTERN PetscErrorCode PetscPClose(MPI_Comm,FILE*,PetscInt*); 1626 #endif 1627 1628 PETSC_EXTERN PetscErrorCode PetscSynchronizedPrintf(MPI_Comm,const char[],...); 1629 PETSC_EXTERN PetscErrorCode PetscSynchronizedFPrintf(MPI_Comm,FILE*,const char[],...); 1630 PETSC_EXTERN PetscErrorCode PetscSynchronizedFlush(MPI_Comm); 1631 PETSC_EXTERN PetscErrorCode PetscSynchronizedFGets(MPI_Comm,FILE*,size_t,char[]); 1632 PETSC_EXTERN PetscErrorCode PetscStartMatlab(MPI_Comm,const char[],const char[],FILE**); 1633 PETSC_EXTERN PetscErrorCode PetscStartJava(MPI_Comm,const char[],const char[],FILE**); 1634 PETSC_EXTERN PetscErrorCode PetscGetPetscDir(const char*[]); 1635 1636 PETSC_EXTERN PetscErrorCode PetscPopUpSelect(MPI_Comm,const char*,const char*,int,const char**,int*); 1637 1638 /*S 1639 PetscContainer - Simple PETSc object that contains a pointer to any required data 1640 1641 Level: advanced 1642 1643 .seealso: PetscObject, PetscContainerCreate() 1644 S*/ 1645 PETSC_EXTERN PetscClassId PETSC_CONTAINER_CLASSID; 1646 typedef struct _p_PetscContainer* PetscContainer; 1647 PETSC_EXTERN PetscErrorCode PetscContainerGetPointer(PetscContainer,void **); 1648 PETSC_EXTERN PetscErrorCode PetscContainerSetPointer(PetscContainer,void *); 1649 PETSC_EXTERN PetscErrorCode PetscContainerDestroy(PetscContainer*); 1650 PETSC_EXTERN PetscErrorCode PetscContainerCreate(MPI_Comm,PetscContainer *); 1651 PETSC_EXTERN PetscErrorCode PetscContainerSetUserDestroy(PetscContainer, PetscErrorCode (*)(void*)); 1652 1653 /* 1654 For use in debuggers 1655 */ 1656 PETSC_EXTERN PetscMPIInt PetscGlobalRank; 1657 PETSC_EXTERN PetscMPIInt PetscGlobalSize; 1658 PETSC_EXTERN PetscErrorCode PetscIntView(PetscInt,const PetscInt[],PetscViewer); 1659 PETSC_EXTERN PetscErrorCode PetscRealView(PetscInt,const PetscReal[],PetscViewer); 1660 PETSC_EXTERN PetscErrorCode PetscScalarView(PetscInt,const PetscScalar[],PetscViewer); 1661 1662 #if defined(PETSC_HAVE_MEMORY_H) 1663 #include <memory.h> 1664 #endif 1665 #if defined(PETSC_HAVE_STDLIB_H) 1666 #include <stdlib.h> 1667 #endif 1668 #if defined(PETSC_HAVE_STRINGS_H) 1669 #include <strings.h> 1670 #endif 1671 #if defined(PETSC_HAVE_STRING_H) 1672 #include <string.h> 1673 #endif 1674 1675 #if defined(PETSC_HAVE_XMMINTRIN_H) && !defined(__CUDACC__) 1676 #include <xmmintrin.h> 1677 #endif 1678 #if defined(PETSC_HAVE_STDINT_H) 1679 #include <stdint.h> 1680 #endif 1681 1682 #undef __FUNCT__ 1683 #define __FUNCT__ "PetscMemcpy" 1684 /*@C 1685 PetscMemcpy - Copies n bytes, beginning at location b, to the space 1686 beginning at location a. The two memory regions CANNOT overlap, use 1687 PetscMemmove() in that case. 1688 1689 Not Collective 1690 1691 Input Parameters: 1692 + b - pointer to initial memory space 1693 - n - length (in bytes) of space to copy 1694 1695 Output Parameter: 1696 . a - pointer to copy space 1697 1698 Level: intermediate 1699 1700 Compile Option: 1701 PETSC_PREFER_DCOPY_FOR_MEMCPY will cause the BLAS dcopy() routine to be used 1702 for memory copies on double precision values. 1703 PETSC_PREFER_COPY_FOR_MEMCPY will cause C code to be used 1704 for memory copies on double precision values. 1705 PETSC_PREFER_FORTRAN_FORMEMCPY will cause Fortran code to be used 1706 for memory copies on double precision values. 1707 1708 Note: 1709 This routine is analogous to memcpy(). 1710 1711 Developer Note: this is inlined for fastest performance 1712 1713 Concepts: memory^copying 1714 Concepts: copying^memory 1715 1716 .seealso: PetscMemmove() 1717 1718 @*/ 1719 PETSC_STATIC_INLINE PetscErrorCode PetscMemcpy(void *a,const void *b,size_t n) 1720 { 1721 #if defined(PETSC_USE_DEBUG) 1722 unsigned long al = (unsigned long) a,bl = (unsigned long) b; 1723 unsigned long nl = (unsigned long) n; 1724 PetscFunctionBegin; 1725 if (n > 0 && !b) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy from a null pointer"); 1726 if (n > 0 && !a) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy to a null pointer"); 1727 #else 1728 PetscFunctionBegin; 1729 #endif 1730 if (a != b) { 1731 #if defined(PETSC_USE_DEBUG) 1732 if ((al > bl && (al - bl) < nl) || (bl - al) < nl) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_ARG_INCOMP,"Memory regions overlap: either use PetscMemmov()\n\ 1733 or make sure your copy regions and lengths are correct. \n\ 1734 Length (bytes) %ld first address %ld second address %ld",nl,al,bl); 1735 #endif 1736 #if (defined(PETSC_PREFER_DCOPY_FOR_MEMCPY) || defined(PETSC_PREFER_COPY_FOR_MEMCPY) || defined(PETSC_PREFER_FORTRAN_FORMEMCPY)) 1737 if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) { 1738 size_t len = n/sizeof(PetscScalar); 1739 #if defined(PETSC_PREFER_DCOPY_FOR_MEMCPY) 1740 PetscBLASInt one = 1,blen = PetscBLASIntCast(len); 1741 BLAScopy_(&blen,(PetscScalar *)b,&one,(PetscScalar *)a,&one); 1742 #elif defined(PETSC_PREFER_FORTRAN_FORMEMCPY) 1743 fortrancopy_(&len,(PetscScalar*)b,(PetscScalar*)a); 1744 #else 1745 size_t i; 1746 PetscScalar *x = (PetscScalar*)b, *y = (PetscScalar*)a; 1747 for (i=0; i<len; i++) y[i] = x[i]; 1748 #endif 1749 } else { 1750 memcpy((char*)(a),(char*)(b),n); 1751 } 1752 #else 1753 memcpy((char*)(a),(char*)(b),n); 1754 #endif 1755 } 1756 PetscFunctionReturn(0); 1757 } 1758 1759 /*@C 1760 PetscMemzero - Zeros the specified memory. 1761 1762 Not Collective 1763 1764 Input Parameters: 1765 + a - pointer to beginning memory location 1766 - n - length (in bytes) of memory to initialize 1767 1768 Level: intermediate 1769 1770 Compile Option: 1771 PETSC_PREFER_BZERO - on certain machines (the IBM RS6000) the bzero() routine happens 1772 to be faster than the memset() routine. This flag causes the bzero() routine to be used. 1773 1774 Developer Note: this is inlined for fastest performance 1775 1776 Concepts: memory^zeroing 1777 Concepts: zeroing^memory 1778 1779 .seealso: PetscMemcpy() 1780 @*/ 1781 PETSC_STATIC_INLINE PetscErrorCode PetscMemzero(void *a,size_t n) 1782 { 1783 if (n > 0) { 1784 #if defined(PETSC_USE_DEBUG) 1785 if (!a) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to zero at a null pointer"); 1786 #endif 1787 #if defined(PETSC_PREFER_ZERO_FOR_MEMZERO) 1788 if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) { 1789 size_t i,len = n/sizeof(PetscScalar); 1790 PetscScalar *x = (PetscScalar*)a; 1791 for (i=0; i<len; i++) x[i] = 0.0; 1792 } else { 1793 #elif defined(PETSC_PREFER_FORTRAN_FOR_MEMZERO) 1794 if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) { 1795 PetscInt len = n/sizeof(PetscScalar); 1796 fortranzero_(&len,(PetscScalar*)a); 1797 } else { 1798 #endif 1799 #if defined(PETSC_PREFER_BZERO) 1800 bzero((char *)a,n); 1801 #else 1802 memset((char*)a,0,n); 1803 #endif 1804 #if defined(PETSC_PREFER_ZERO_FOR_MEMZERO) || defined(PETSC_PREFER_FORTRAN_FOR_MEMZERO) 1805 } 1806 #endif 1807 } 1808 return 0; 1809 } 1810 1811 /*MC 1812 PetscPrefetchBlock - Prefetches a block of memory 1813 1814 Synopsis: 1815 void PetscPrefetchBlock(const anytype *a,size_t n,int rw,int t) 1816 1817 Not Collective 1818 1819 Input Parameters: 1820 + a - pointer to first element to fetch (any type but usually PetscInt or PetscScalar) 1821 . n - number of elements to fetch 1822 . rw - 1 if the memory will be written to, otherwise 0 (ignored by many processors) 1823 - t - temporal locality (PETSC_PREFETCH_HINT_{NTA,T0,T1,T2}), see note 1824 1825 Level: developer 1826 1827 Notes: 1828 The last two arguments (rw and t) must be compile-time constants. 1829 1830 Adopting Intel's x86/x86-64 conventions, there are four levels of temporal locality. Not all architectures offer 1831 equivalent locality hints, but the following macros are always defined to their closest analogue. 1832 + PETSC_PREFETCH_HINT_NTA - Non-temporal. Prefetches directly to L1, evicts to memory (skips higher level cache unless it was already there when prefetched). 1833 . 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. 1834 . PETSC_PREFETCH_HINT_T1 - Fetch to level 2 and higher (not L1). 1835 - PETSC_PREFETCH_HINT_T2 - Fetch to high-level cache only. (On many systems, T0 and T1 are equivalent.) 1836 1837 This function does nothing on architectures that do not support prefetch and never errors (even if passed an invalid 1838 address). 1839 1840 Concepts: memory 1841 M*/ 1842 #define PetscPrefetchBlock(a,n,rw,t) do { \ 1843 const char *_p = (const char*)(a),*_end = (const char*)((a)+(n)); \ 1844 for ( ; _p < _end; _p += PETSC_LEVEL1_DCACHE_LINESIZE) PETSC_Prefetch(_p,(rw),(t)); \ 1845 } while (0) 1846 1847 /* 1848 Allows accessing MATLAB Engine 1849 */ 1850 #include <petscmatlab.h> 1851 1852 /* 1853 Determine if some of the kernel computation routines use 1854 Fortran (rather than C) for the numerical calculations. On some machines 1855 and compilers (like complex numbers) the Fortran version of the routines 1856 is faster than the C/C++ versions. The flag --with-fortran-kernels 1857 should be used with ./configure to turn these on. 1858 */ 1859 #if defined(PETSC_USE_FORTRAN_KERNELS) 1860 1861 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTCRL) 1862 #define PETSC_USE_FORTRAN_KERNEL_MULTCRL 1863 #endif 1864 1865 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJPERM) 1866 #define PETSC_USE_FORTRAN_KERNEL_MULTAIJPERM 1867 #endif 1868 1869 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJ) 1870 #define PETSC_USE_FORTRAN_KERNEL_MULTAIJ 1871 #endif 1872 1873 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ) 1874 #define PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ 1875 #endif 1876 1877 #if !defined(PETSC_USE_FORTRAN_KERNEL_NORM) 1878 #define PETSC_USE_FORTRAN_KERNEL_NORM 1879 #endif 1880 1881 #if !defined(PETSC_USE_FORTRAN_KERNEL_MAXPY) 1882 #define PETSC_USE_FORTRAN_KERNEL_MAXPY 1883 #endif 1884 1885 #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ) 1886 #define PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ 1887 #endif 1888 1889 #if !defined(PETSC_USE_FORTRAN_KERNEL_RELAXAIJ) 1890 #define PETSC_USE_FORTRAN_KERNEL_RELAXAIJ 1891 #endif 1892 1893 #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ) 1894 #define PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ 1895 #endif 1896 1897 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ) 1898 #define PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ 1899 #endif 1900 1901 #if !defined(PETSC_USE_FORTRAN_KERNEL_MDOT) 1902 #define PETSC_USE_FORTRAN_KERNEL_MDOT 1903 #endif 1904 1905 #if !defined(PETSC_USE_FORTRAN_KERNEL_XTIMESY) 1906 #define PETSC_USE_FORTRAN_KERNEL_XTIMESY 1907 #endif 1908 1909 #if !defined(PETSC_USE_FORTRAN_KERNEL_AYPX) 1910 #define PETSC_USE_FORTRAN_KERNEL_AYPX 1911 #endif 1912 1913 #if !defined(PETSC_USE_FORTRAN_KERNEL_WAXPY) 1914 #define PETSC_USE_FORTRAN_KERNEL_WAXPY 1915 #endif 1916 1917 #endif 1918 1919 /* 1920 Macros for indicating code that should be compiled with a C interface, 1921 rather than a C++ interface. Any routines that are dynamically loaded 1922 (such as the PCCreate_XXX() routines) must be wrapped so that the name 1923 mangler does not change the functions symbol name. This just hides the 1924 ugly extern "C" {} wrappers. 1925 */ 1926 #if defined(__cplusplus) 1927 #define PETSC_EXTERN_C extern "C" PETSC_VISIBILITY_PUBLIC 1928 #define EXTERN_C_BEGIN extern "C" { 1929 #define EXTERN_C_END } 1930 #else 1931 #define PETSC_EXTERN_C PETSC_EXTERN 1932 #define EXTERN_C_BEGIN 1933 #define EXTERN_C_END 1934 #endif 1935 1936 /* --------------------------------------------------------------------*/ 1937 1938 /*MC 1939 MPI_Comm - the basic object used by MPI to determine which processes are involved in a 1940 communication 1941 1942 Level: beginner 1943 1944 Note: This manual page is a place-holder because MPICH does not have a manual page for MPI_Comm 1945 1946 .seealso: PETSC_COMM_WORLD, PETSC_COMM_SELF 1947 M*/ 1948 1949 /*MC 1950 PetscScalar - PETSc type that represents either a double precision real number, a double precision 1951 complex number, a single precision real number, a long double or an int - if the code is configured 1952 with --with-scalar-type=real,complex --with-precision=single,double,longdouble,int,matsingle 1953 1954 1955 Level: beginner 1956 1957 .seealso: PetscReal, PassiveReal, PassiveScalar, MPIU_SCALAR, PetscInt 1958 M*/ 1959 1960 /*MC 1961 PetscReal - PETSc type that represents a real number version of PetscScalar 1962 1963 Level: beginner 1964 1965 .seealso: PetscScalar, PassiveReal, PassiveScalar 1966 M*/ 1967 1968 /*MC 1969 PassiveScalar - PETSc type that represents a PetscScalar 1970 Level: beginner 1971 1972 This is the same as a PetscScalar except in code that is automatically differentiated it is 1973 treated as a constant (not an indendent or dependent variable) 1974 1975 .seealso: PetscReal, PassiveReal, PetscScalar 1976 M*/ 1977 1978 /*MC 1979 PassiveReal - PETSc type that represents a PetscReal 1980 1981 Level: beginner 1982 1983 This is the same as a PetscReal except in code that is automatically differentiated it is 1984 treated as a constant (not an indendent or dependent variable) 1985 1986 .seealso: PetscScalar, PetscReal, PassiveScalar 1987 M*/ 1988 1989 /*MC 1990 MPIU_SCALAR - MPI datatype corresponding to PetscScalar 1991 1992 Level: beginner 1993 1994 Note: In MPI calls that require an MPI datatype that matches a PetscScalar or array of PetscScalars 1995 pass this value 1996 1997 .seealso: PetscReal, PassiveReal, PassiveScalar, PetscScalar, MPIU_INT 1998 M*/ 1999 2000 #if defined(PETSC_HAVE_MPIIO) 2001 #if !defined(PETSC_WORDS_BIGENDIAN) 2002 PETSC_EXTERN PetscErrorCode MPIU_File_write_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*); 2003 PETSC_EXTERN PetscErrorCode MPIU_File_read_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*); 2004 #else 2005 #define MPIU_File_write_all(a,b,c,d,e) MPI_File_write_all(a,b,c,d,e) 2006 #define MPIU_File_read_all(a,b,c,d,e) MPI_File_read_all(a,b,c,d,e) 2007 #endif 2008 #endif 2009 2010 /* the following petsc_static_inline require petscerror.h */ 2011 2012 /* Limit MPI to 32-bits */ 2013 #define PETSC_MPI_INT_MAX 2147483647 2014 #define PETSC_MPI_INT_MIN -2147483647 2015 /* Limit BLAS to 32-bits */ 2016 #define PETSC_BLAS_INT_MAX 2147483647 2017 #define PETSC_BLAS_INT_MIN -2147483647 2018 /* On 32 bit systems HDF5 is limited by size of integer, because hsize_t is defined as size_t */ 2019 #define PETSC_HDF5_INT_MAX 2147483647 2020 #define PETSC_HDF5_INT_MIN -2147483647 2021 2022 #if defined(PETSC_USE_64BIT_INDICES) 2023 #define PetscMPIIntCheck(a) if ((a) > PETSC_MPI_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Message too long for MPI") 2024 #define PetscBLASIntCheck(a) if ((a) > PETSC_BLAS_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array too long for BLAS/LAPACK") 2025 #define PetscMPIIntCast(a) (PetscMPIInt)(a);PetscMPIIntCheck(a) 2026 #define PetscBLASIntCast(a) (PetscBLASInt)(a);PetscBLASIntCheck(a) 2027 2028 #if (PETSC_SIZEOF_SIZE_T == 4) 2029 #define PetscHDF5IntCheck(a) if ((a) > PETSC_HDF5_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array too long for HDF5") 2030 #define PetscHDF5IntCast(a) (hsize_t)(a);PetscHDF5IntCheck(a) 2031 #else 2032 #define PetscHDF5IntCheck(a) 2033 #define PetscHDF5IntCast(a) a 2034 #endif 2035 2036 #else 2037 #define PetscMPIIntCheck(a) 2038 #define PetscBLASIntCheck(a) 2039 #define PetscHDF5IntCheck(a) 2040 #define PetscMPIIntCast(a) a 2041 #define PetscBLASIntCast(a) a 2042 #define PetscHDF5IntCast(a) a 2043 #endif 2044 2045 /* 2046 The IBM include files define hz, here we hide it so that it may be used as a regular user variable. 2047 */ 2048 #if defined(hz) 2049 #undef hz 2050 #endif 2051 2052 /* For arrays that contain filenames or paths */ 2053 2054 2055 #if defined(PETSC_HAVE_LIMITS_H) 2056 #include <limits.h> 2057 #endif 2058 #if defined(PETSC_HAVE_SYS_PARAM_H) 2059 #include <sys/param.h> 2060 #endif 2061 #if defined(PETSC_HAVE_SYS_TYPES_H) 2062 #include <sys/types.h> 2063 #endif 2064 #if defined(MAXPATHLEN) 2065 # define PETSC_MAX_PATH_LEN MAXPATHLEN 2066 #elif defined(MAX_PATH) 2067 # define PETSC_MAX_PATH_LEN MAX_PATH 2068 #elif defined(_MAX_PATH) 2069 # define PETSC_MAX_PATH_LEN _MAX_PATH 2070 #else 2071 # define PETSC_MAX_PATH_LEN 4096 2072 #endif 2073 2074 /* Special support for C++ */ 2075 #if defined(PETSC_CLANGUAGE_CXX) && !defined(PETSC_USE_EXTERN_CXX) 2076 #include <petscsys.hh> 2077 #endif 2078 2079 /*MC 2080 2081 UsingFortran - Fortran can be used with PETSc in four distinct approaches 2082 2083 $ 1) classic Fortran 77 style 2084 $#include "finclude/petscXXX.h" to work with material from the XXX component of PETSc 2085 $ XXX variablename 2086 $ You cannot use this approach if you wish to use the Fortran 90 specific PETSc routines 2087 $ which end in F90; such as VecGetArrayF90() 2088 $ 2089 $ 2) classic Fortran 90 style 2090 $#include "finclude/petscXXX.h" 2091 $#include "finclude/petscXXX.h90" to work with material from the XXX component of PETSc 2092 $ XXX variablename 2093 $ 2094 $ 3) Using Fortran modules 2095 $#include "finclude/petscXXXdef.h" 2096 $ use petscXXXX 2097 $ XXX variablename 2098 $ 2099 $ 4) Use Fortran modules and Fortran data types for PETSc types 2100 $#include "finclude/petscXXXdef.h" 2101 $ use petscXXXX 2102 $ type(XXX) variablename 2103 $ To use this approach you must ./configure PETSc with the additional 2104 $ option --with-fortran-datatypes You cannot use the type(XXX) declaration approach without using Fortran modules 2105 2106 Finally if you absolutely do not want to use any #include you can use either 2107 2108 $ 3a) skip the #include BUT you cannot use any PETSc data type names like Vec, Mat, PetscInt, PetscErrorCode etc 2109 $ and you must declare the variables as integer, for example 2110 $ integer variablename 2111 $ 2112 $ 4a) skip the #include, you use the object types like type(Vec) type(Mat) but cannot use the data type 2113 $ names like PetscErrorCode, PetscInt etc. again for those you must use integer 2114 2115 We recommend either 2 or 3. Approaches 2 and 3 provide type checking for most PETSc function calls; 4 has type checking 2116 for only a few PETSc functions. 2117 2118 Fortran type checking with interfaces is strick, this means you cannot pass a scalar value when an array value 2119 is expected (even though it is legal Fortran). For example when setting a single value in a matrix with MatSetValues() 2120 you cannot have something like 2121 $ PetscInt row,col 2122 $ PetscScalar val 2123 $ ... 2124 $ call MatSetValues(mat,1,row,1,col,val,INSERT_VALUES,ierr) 2125 You must instead have 2126 $ PetscInt row(1),col(1) 2127 $ PetscScalar val(1) 2128 $ ... 2129 $ call MatSetValues(mat,1,row,1,col,val,INSERT_VALUES,ierr) 2130 2131 2132 See the example src/vec/vec/examples/tutorials/ex20f90.F90 for an example that can use all four approaches 2133 2134 Developer Notes: The finclude/petscXXXdef.h contain all the #defines (would be typedefs in C code) these 2135 automatically include their predecessors; for example finclude/petscvecdef.h includes finclude/petscisdef.h 2136 2137 The finclude/petscXXXX.h contain all the parameter statements for that package. These automatically include 2138 their finclude/petscXXXdef.h file but DO NOT automatically include their predecessors; for example 2139 finclude/petscvec.h does NOT automatically include finclude/petscis.h 2140 2141 The finclude/ftn-custom/petscXXXdef.h90 are not intended to be used directly in code, they define the 2142 Fortran data type type(XXX) (for example type(Vec)) when PETSc is ./configure with the --with-fortran-datatypes option. 2143 2144 The finclude/ftn-custom/petscXXX.h90 (not included directly by code) contain interface definitions for 2145 the PETSc Fortran stubs that have different bindings then their C version (for example VecGetArrayF90). 2146 2147 The finclude/ftn-auto/petscXXX.h90 (not included directly by code) contain interface definitions generated 2148 automatically by "make allfortranstubs". 2149 2150 The finclude/petscXXX.h90 includes the custom finclude/ftn-custom/petscXXX.h90 and if ./configure 2151 was run with --with-fortran-interfaces it also includes the finclude/ftn-auto/petscXXX.h90 These DO NOT automatically 2152 include their predecessors 2153 2154 Level: beginner 2155 2156 M*/ 2157 2158 PETSC_EXTERN PetscErrorCode PetscGetArchType(char[],size_t); 2159 PETSC_EXTERN PetscErrorCode PetscGetHostName(char[],size_t); 2160 PETSC_EXTERN PetscErrorCode PetscGetUserName(char[],size_t); 2161 PETSC_EXTERN PetscErrorCode PetscGetProgramName(char[],size_t); 2162 PETSC_EXTERN PetscErrorCode PetscSetProgramName(const char[]); 2163 PETSC_EXTERN PetscErrorCode PetscGetDate(char[],size_t); 2164 PETSC_EXTERN PetscErrorCode PetscGetVersion(char[], size_t); 2165 2166 PETSC_EXTERN PetscErrorCode PetscSortInt(PetscInt,PetscInt[]); 2167 PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsInt(PetscInt*,PetscInt[]); 2168 PETSC_EXTERN PetscErrorCode PetscFindInt(PetscInt, PetscInt, const PetscInt[], PetscInt*); 2169 PETSC_EXTERN PetscErrorCode PetscSortIntWithPermutation(PetscInt,const PetscInt[],PetscInt[]); 2170 PETSC_EXTERN PetscErrorCode PetscSortStrWithPermutation(PetscInt,const char*[],PetscInt[]); 2171 PETSC_EXTERN PetscErrorCode PetscSortIntWithArray(PetscInt,PetscInt[],PetscInt[]); 2172 PETSC_EXTERN PetscErrorCode PetscSortIntWithArrayPair(PetscInt,PetscInt*,PetscInt*,PetscInt*); 2173 PETSC_EXTERN PetscErrorCode PetscSortMPIInt(PetscInt,PetscMPIInt[]); 2174 PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsMPIInt(PetscInt*,PetscMPIInt[]); 2175 PETSC_EXTERN PetscErrorCode PetscSortMPIIntWithArray(PetscMPIInt,PetscMPIInt[],PetscMPIInt[]); 2176 PETSC_EXTERN PetscErrorCode PetscSortIntWithScalarArray(PetscInt,PetscInt[],PetscScalar[]); 2177 PETSC_EXTERN PetscErrorCode PetscSortReal(PetscInt,PetscReal[]); 2178 PETSC_EXTERN PetscErrorCode PetscSortRealWithPermutation(PetscInt,const PetscReal[],PetscInt[]); 2179 PETSC_EXTERN PetscErrorCode PetscSortSplit(PetscInt,PetscInt,PetscScalar[],PetscInt[]); 2180 PETSC_EXTERN PetscErrorCode PetscSortSplitReal(PetscInt,PetscInt,PetscReal[],PetscInt[]); 2181 PETSC_EXTERN PetscErrorCode PetscProcessTree(PetscInt,const PetscBool [],const PetscInt[],PetscInt*,PetscInt**,PetscInt**,PetscInt**,PetscInt**); 2182 PETSC_EXTERN PetscErrorCode PetscMergeIntArrayPair(PetscInt,const PetscInt*,const PetscInt*,PetscInt,const PetscInt*,const PetscInt*,PetscInt*,PetscInt**,PetscInt**); 2183 2184 PETSC_EXTERN PetscErrorCode PetscSetDisplay(void); 2185 PETSC_EXTERN PetscErrorCode PetscGetDisplay(char[],size_t); 2186 2187 /*J 2188 PetscRandomType - String with the name of a PETSc randomizer 2189 with an optional dynamic library name, for example 2190 http://www.mcs.anl.gov/petsc/lib.a:myrandcreate() 2191 2192 Level: beginner 2193 2194 Notes: to use the SPRNG you must have ./configure PETSc 2195 with the option --download-sprng 2196 2197 .seealso: PetscRandomSetType(), PetscRandom 2198 J*/ 2199 typedef const char* PetscRandomType; 2200 #define PETSCRAND "rand" 2201 #define PETSCRAND48 "rand48" 2202 #define PETSCSPRNG "sprng" 2203 2204 /* Logging support */ 2205 PETSC_EXTERN PetscClassId PETSC_RANDOM_CLASSID; 2206 2207 PETSC_EXTERN PetscErrorCode PetscRandomInitializePackage(const char[]); 2208 2209 /*S 2210 PetscRandom - Abstract PETSc object that manages generating random numbers 2211 2212 Level: intermediate 2213 2214 Concepts: random numbers 2215 2216 .seealso: PetscRandomCreate(), PetscRandomGetValue(), PetscRandomType 2217 S*/ 2218 typedef struct _p_PetscRandom* PetscRandom; 2219 2220 /* Dynamic creation and loading functions */ 2221 PETSC_EXTERN PetscFList PetscRandomList; 2222 PETSC_EXTERN PetscBool PetscRandomRegisterAllCalled; 2223 2224 PETSC_EXTERN PetscErrorCode PetscRandomRegisterAll(const char []); 2225 PETSC_EXTERN PetscErrorCode PetscRandomRegister(const char[],const char[],const char[],PetscErrorCode (*)(PetscRandom)); 2226 PETSC_EXTERN PetscErrorCode PetscRandomRegisterDestroy(void); 2227 PETSC_EXTERN PetscErrorCode PetscRandomSetType(PetscRandom, PetscRandomType); 2228 PETSC_EXTERN PetscErrorCode PetscRandomSetFromOptions(PetscRandom); 2229 PETSC_EXTERN PetscErrorCode PetscRandomGetType(PetscRandom, PetscRandomType*); 2230 PETSC_EXTERN PetscErrorCode PetscRandomViewFromOptions(PetscRandom,char*); 2231 PETSC_EXTERN PetscErrorCode PetscRandomView(PetscRandom,PetscViewer); 2232 2233 /*MC 2234 PetscRandomRegisterDynamic - Adds a new PetscRandom component implementation 2235 2236 Synopsis: 2237 PetscErrorCode PetscRandomRegisterDynamic(const char *name, const char *path, const char *func_name, PetscErrorCode (*create_func)(PetscRandom)) 2238 2239 Not Collective 2240 2241 Input Parameters: 2242 + name - The name of a new user-defined creation routine 2243 . path - The path (either absolute or relative) of the library containing this routine 2244 . func_name - The name of routine to create method context 2245 - create_func - The creation routine itself 2246 2247 Notes: 2248 PetscRandomRegisterDynamic() may be called multiple times to add several user-defined randome number generators 2249 2250 If dynamic libraries are used, then the fourth input argument (routine_create) is ignored. 2251 2252 Sample usage: 2253 .vb 2254 PetscRandomRegisterDynamic("my_rand","/home/username/my_lib/lib/libO/solaris/libmy.a", "MyPetscRandomtorCreate", MyPetscRandomtorCreate); 2255 .ve 2256 2257 Then, your random type can be chosen with the procedural interface via 2258 .vb 2259 PetscRandomCreate(MPI_Comm, PetscRandom *); 2260 PetscRandomSetType(PetscRandom,"my_random_name"); 2261 .ve 2262 or at runtime via the option 2263 .vb 2264 -random_type my_random_name 2265 .ve 2266 2267 Notes: $PETSC_ARCH occuring in pathname will be replaced with appropriate values. 2268 2269 For an example of the code needed to interface your own random number generator see 2270 src/sys/random/impls/rand/rand.c 2271 2272 Level: advanced 2273 2274 .keywords: PetscRandom, register 2275 .seealso: PetscRandomRegisterAll(), PetscRandomRegisterDestroy(), PetscRandomRegister() 2276 M*/ 2277 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 2278 #define PetscRandomRegisterDynamic(a,b,c,d) PetscRandomRegister(a,b,c,0) 2279 #else 2280 #define PetscRandomRegisterDynamic(a,b,c,d) PetscRandomRegister(a,b,c,d) 2281 #endif 2282 2283 PETSC_EXTERN PetscErrorCode PetscRandomCreate(MPI_Comm,PetscRandom*); 2284 PETSC_EXTERN PetscErrorCode PetscRandomGetValue(PetscRandom,PetscScalar*); 2285 PETSC_EXTERN PetscErrorCode PetscRandomGetValueReal(PetscRandom,PetscReal*); 2286 PETSC_EXTERN PetscErrorCode PetscRandomGetInterval(PetscRandom,PetscScalar*,PetscScalar*); 2287 PETSC_EXTERN PetscErrorCode PetscRandomSetInterval(PetscRandom,PetscScalar,PetscScalar); 2288 PETSC_EXTERN PetscErrorCode PetscRandomSetSeed(PetscRandom,unsigned long); 2289 PETSC_EXTERN PetscErrorCode PetscRandomGetSeed(PetscRandom,unsigned long *); 2290 PETSC_EXTERN PetscErrorCode PetscRandomSeed(PetscRandom); 2291 PETSC_EXTERN PetscErrorCode PetscRandomDestroy(PetscRandom*); 2292 2293 PETSC_EXTERN PetscErrorCode PetscGetFullPath(const char[],char[],size_t); 2294 PETSC_EXTERN PetscErrorCode PetscGetRelativePath(const char[],char[],size_t); 2295 PETSC_EXTERN PetscErrorCode PetscGetWorkingDirectory(char[],size_t); 2296 PETSC_EXTERN PetscErrorCode PetscGetRealPath(const char[],char[]); 2297 PETSC_EXTERN PetscErrorCode PetscGetHomeDirectory(char[],size_t); 2298 PETSC_EXTERN PetscErrorCode PetscTestFile(const char[],char,PetscBool *); 2299 PETSC_EXTERN PetscErrorCode PetscTestDirectory(const char[],char,PetscBool *); 2300 2301 PETSC_EXTERN PetscErrorCode PetscBinaryRead(int,void*,PetscInt,PetscDataType); 2302 PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedRead(MPI_Comm,int,void*,PetscInt,PetscDataType); 2303 PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedWrite(MPI_Comm,int,void*,PetscInt,PetscDataType,PetscBool ); 2304 PETSC_EXTERN PetscErrorCode PetscBinaryWrite(int,void*,PetscInt,PetscDataType,PetscBool ); 2305 PETSC_EXTERN PetscErrorCode PetscBinaryOpen(const char[],PetscFileMode,int *); 2306 PETSC_EXTERN PetscErrorCode PetscBinaryClose(int); 2307 PETSC_EXTERN PetscErrorCode PetscSharedTmp(MPI_Comm,PetscBool *); 2308 PETSC_EXTERN PetscErrorCode PetscSharedWorkingDirectory(MPI_Comm,PetscBool *); 2309 PETSC_EXTERN PetscErrorCode PetscGetTmp(MPI_Comm,char[],size_t); 2310 PETSC_EXTERN PetscErrorCode PetscFileRetrieve(MPI_Comm,const char[],char[],size_t,PetscBool *); 2311 PETSC_EXTERN PetscErrorCode PetscLs(MPI_Comm,const char[],char[],size_t,PetscBool *); 2312 PETSC_EXTERN PetscErrorCode PetscOpenSocket(char*,int,int*); 2313 PETSC_EXTERN PetscErrorCode PetscWebServe(MPI_Comm,int); 2314 2315 /* 2316 In binary files variables are stored using the following lengths, 2317 regardless of how they are stored in memory on any one particular 2318 machine. Use these rather then sizeof() in computing sizes for 2319 PetscBinarySeek(). 2320 */ 2321 #define PETSC_BINARY_INT_SIZE (32/8) 2322 #define PETSC_BINARY_FLOAT_SIZE (32/8) 2323 #define PETSC_BINARY_CHAR_SIZE (8/8) 2324 #define PETSC_BINARY_SHORT_SIZE (16/8) 2325 #define PETSC_BINARY_DOUBLE_SIZE (64/8) 2326 #define PETSC_BINARY_SCALAR_SIZE sizeof(PetscScalar) 2327 2328 /*E 2329 PetscBinarySeekType - argument to PetscBinarySeek() 2330 2331 Level: advanced 2332 2333 .seealso: PetscBinarySeek(), PetscBinarySynchronizedSeek() 2334 E*/ 2335 typedef enum {PETSC_BINARY_SEEK_SET = 0,PETSC_BINARY_SEEK_CUR = 1,PETSC_BINARY_SEEK_END = 2} PetscBinarySeekType; 2336 PETSC_EXTERN PetscErrorCode PetscBinarySeek(int,off_t,PetscBinarySeekType,off_t*); 2337 PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedSeek(MPI_Comm,int,off_t,PetscBinarySeekType,off_t*); 2338 PETSC_EXTERN PetscErrorCode PetscByteSwap(void *,PetscDataType,PetscInt); 2339 2340 PETSC_EXTERN PetscErrorCode PetscSetDebugTerminal(const char[]); 2341 PETSC_EXTERN PetscErrorCode PetscSetDebugger(const char[],PetscBool ); 2342 PETSC_EXTERN PetscErrorCode PetscSetDefaultDebugger(void); 2343 PETSC_EXTERN PetscErrorCode PetscSetDebuggerFromString(const char*); 2344 PETSC_EXTERN PetscErrorCode PetscAttachDebugger(void); 2345 PETSC_EXTERN PetscErrorCode PetscStopForDebugger(void); 2346 2347 PETSC_EXTERN PetscErrorCode PetscGatherNumberOfMessages(MPI_Comm,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt*); 2348 PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**); 2349 PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths2(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**,PetscMPIInt**); 2350 PETSC_EXTERN PetscErrorCode PetscPostIrecvInt(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscInt***,MPI_Request**); 2351 PETSC_EXTERN PetscErrorCode PetscPostIrecvScalar(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscScalar***,MPI_Request**); 2352 2353 PETSC_EXTERN PetscErrorCode PetscSSEIsEnabled(MPI_Comm,PetscBool *,PetscBool *); 2354 2355 /*E 2356 InsertMode - Whether entries are inserted or added into vectors or matrices 2357 2358 Level: beginner 2359 2360 .seealso: VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(), 2361 VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), 2362 MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd() 2363 E*/ 2364 typedef enum {NOT_SET_VALUES, INSERT_VALUES, ADD_VALUES, MAX_VALUES, INSERT_ALL_VALUES, ADD_ALL_VALUES, INSERT_BC_VALUES, ADD_BC_VALUES} InsertMode; 2365 2366 /*MC 2367 INSERT_VALUES - Put a value into a vector or matrix, overwrites any previous value 2368 2369 Level: beginner 2370 2371 .seealso: InsertMode, VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(), 2372 VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), ADD_VALUES, 2373 MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd(), MAX_VALUES 2374 2375 M*/ 2376 2377 /*MC 2378 ADD_VALUES - Adds a value into a vector or matrix, if there previously was no value, just puts the 2379 value into that location 2380 2381 Level: beginner 2382 2383 .seealso: InsertMode, VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(), 2384 VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), INSERT_VALUES, 2385 MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd(), MAX_VALUES 2386 2387 M*/ 2388 2389 /*MC 2390 MAX_VALUES - Puts the maximum of the scattered/gathered value and the current value into each location 2391 2392 Level: beginner 2393 2394 .seealso: InsertMode, VecScatterBegin(), VecScatterEnd(), ADD_VALUES, INSERT_VALUES 2395 2396 M*/ 2397 2398 /*S 2399 PetscSubcomm - Context of MPI subcommunicators, used by PCREDUNDANT 2400 2401 Level: advanced 2402 2403 Concepts: communicator, create 2404 S*/ 2405 typedef struct _n_PetscSubcomm* PetscSubcomm; 2406 2407 struct _n_PetscSubcomm { 2408 MPI_Comm parent; /* parent communicator */ 2409 MPI_Comm dupparent; /* duplicate parent communicator, under which the processors of this subcomm have contiguous rank */ 2410 MPI_Comm comm; /* this communicator */ 2411 PetscInt n; /* num of subcommunicators under the parent communicator */ 2412 PetscInt color; /* color of processors belong to this communicator */ 2413 }; 2414 2415 typedef enum {PETSC_SUBCOMM_GENERAL=0,PETSC_SUBCOMM_CONTIGUOUS=1,PETSC_SUBCOMM_INTERLACED=2} PetscSubcommType; 2416 PETSC_EXTERN const char *const PetscSubcommTypes[]; 2417 2418 PETSC_EXTERN PetscErrorCode PetscSubcommCreate(MPI_Comm,PetscSubcomm*); 2419 PETSC_EXTERN PetscErrorCode PetscSubcommDestroy(PetscSubcomm*); 2420 PETSC_EXTERN PetscErrorCode PetscSubcommSetNumber(PetscSubcomm,PetscInt); 2421 PETSC_EXTERN PetscErrorCode PetscSubcommSetType(PetscSubcomm,PetscSubcommType); 2422 PETSC_EXTERN PetscErrorCode PetscSubcommSetTypeGeneral(PetscSubcomm,PetscMPIInt,PetscMPIInt,PetscMPIInt); 2423 2424 #include <petscctable.h> 2425 2426 2427 /* Reset __FUNCT__ in case the user does not define it themselves */ 2428 #undef __FUNCT__ 2429 #define __FUNCT__ "User provided function" 2430 2431 2432 #endif 2433