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