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