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