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