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} 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 #else 1159 #define PETSC_SCALAR PETSC_DOUBLE 1160 #endif 1161 #endif 1162 #if defined(PETSC_USE_SCALAR_SINGLE) 1163 #define PETSC_REAL PETSC_FLOAT 1164 #elif defined(PETSC_USE_SCALAR_LONG_DOUBLE) 1165 #define PETSC_REAL PETSC_LONG_DOUBLE 1166 #elif defined(PETSC_USE_SCALAR_INT) 1167 #define PETSC_REAL PETSC_INT 1168 #else 1169 #define PETSC_REAL PETSC_DOUBLE 1170 #endif 1171 #define PETSC_FORTRANADDR PETSC_LONG 1172 1173 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDataTypeToMPIDataType(PetscDataType,MPI_Datatype*); 1174 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMPIDataTypeToPetscDataType(MPI_Datatype,PetscDataType*); 1175 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDataTypeGetSize(PetscDataType,size_t*); 1176 1177 /* 1178 Basic memory and string operations. These are usually simple wrappers 1179 around the basic Unix system calls, but a few of them have additional 1180 functionality and/or error checking. 1181 */ 1182 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscBitMemcpy(void*,PetscInt,const void*,PetscInt,PetscInt,PetscDataType); 1183 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMemmove(void*,void *,size_t); 1184 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMemcmp(const void*,const void*,size_t,PetscTruth *); 1185 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrlen(const char[],size_t*); 1186 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrcmp(const char[],const char[],PetscTruth *); 1187 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrgrt(const char[],const char[],PetscTruth *); 1188 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrcasecmp(const char[],const char[],PetscTruth*); 1189 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrncmp(const char[],const char[],size_t,PetscTruth*); 1190 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrcpy(char[],const char[]); 1191 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrcat(char[],const char[]); 1192 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrncat(char[],const char[],size_t); 1193 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrncpy(char[],const char[],size_t); 1194 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrchr(const char[],char,char *[]); 1195 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrtolower(char[]); 1196 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrrchr(const char[],char,char *[]); 1197 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrstr(const char[],const char[],char *[]); 1198 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrrstr(const char[],const char[],char *[]); 1199 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrallocpy(const char[],char *[]); 1200 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrreplace(MPI_Comm,const char[],char[],size_t); 1201 #define PetscStrfree(a) ((a) ? PetscFree(a) : 0) 1202 1203 1204 /*S 1205 PetscToken - 'Token' used for managing tokenizing strings 1206 1207 Level: intermediate 1208 1209 .seealso: PetscTokenCreate(), PetscTokenFind(), PetscTokenDestroy() 1210 S*/ 1211 typedef struct _p_PetscToken* PetscToken; 1212 1213 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscTokenCreate(const char[],const char,PetscToken*); 1214 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscTokenFind(PetscToken,char *[]); 1215 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscTokenDestroy(PetscToken); 1216 1217 /* 1218 These are MPI operations for MPI_Allreduce() etc 1219 */ 1220 EXTERN PETSC_DLLEXPORT MPI_Op PetscMaxSum_Op; 1221 #if defined(PETSC_USE_COMPLEX) 1222 EXTERN PETSC_DLLEXPORT MPI_Op PetscSum_Op; 1223 #else 1224 #define PetscSum_Op MPI_SUM 1225 #endif 1226 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMaxSum(MPI_Comm,const PetscInt[],PetscInt*,PetscInt*); 1227 1228 /*S 1229 PetscObject - any PETSc object, PetscViewer, Mat, Vec, KSP etc 1230 1231 Level: beginner 1232 1233 Note: This is the base class from which all objects appear. 1234 1235 .seealso: PetscObjectDestroy(), PetscObjectView(), PetscObjectGetName(), PetscObjectSetName() 1236 S*/ 1237 typedef struct _p_PetscObject* PetscObject; 1238 1239 /*S 1240 PetscFList - Linked list of functions, possibly stored in dynamic libraries, accessed 1241 by string name 1242 1243 Level: advanced 1244 1245 .seealso: PetscFListAdd(), PetscFListDestroy() 1246 S*/ 1247 typedef struct _n_PetscFList *PetscFList; 1248 1249 /*E 1250 PetscFileMode - Access mode for a file. 1251 1252 Level: beginner 1253 1254 FILE_MODE_READ - open a file at its beginning for reading 1255 1256 FILE_MODE_WRITE - open a file at its beginning for writing (will create if the file does not exist) 1257 1258 FILE_MODE_APPEND - open a file at end for writing 1259 1260 FILE_MODE_UPDATE - open a file for updating, meaning for reading and writing 1261 1262 FILE_MODE_APPEND_UPDATE - open a file for updating, meaning for reading and writing, at the end 1263 1264 .seealso: PetscViewerFileSetMode() 1265 E*/ 1266 typedef enum {FILE_MODE_READ, FILE_MODE_WRITE, FILE_MODE_APPEND, FILE_MODE_UPDATE, FILE_MODE_APPEND_UPDATE} PetscFileMode; 1267 1268 #include "petscviewer.h" 1269 #include "petscoptions.h" 1270 1271 #define PETSC_SMALLEST_COOKIE 1211211 1272 extern PETSC_DLLEXPORT PetscCookie PETSC_LARGEST_COOKIE; 1273 extern PETSC_DLLEXPORT PetscCookie PETSC_OBJECT_COOKIE; 1274 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscCookieRegister(const char[],PetscCookie *); 1275 1276 /* 1277 Routines that get memory usage information from the OS 1278 */ 1279 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMemoryGetCurrentUsage(PetscLogDouble *); 1280 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMemoryGetMaximumUsage(PetscLogDouble *); 1281 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMemorySetGetMaximumUsage(void); 1282 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMemoryShowUsage(PetscViewer,const char[]); 1283 1284 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscInfoAllow(PetscTruth,const char []); 1285 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscGetTime(PetscLogDouble*); 1286 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscGetCPUTime(PetscLogDouble*); 1287 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSleep(PetscReal); 1288 1289 /* 1290 Initialization of PETSc 1291 */ 1292 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscInitialize(int*,char***,const char[],const char[]); 1293 PetscPolymorphicSubroutine(PetscInitialize,(int *argc,char ***args),(argc,args,PETSC_NULL,PETSC_NULL)) 1294 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscInitializeNoArguments(void); 1295 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscInitialized(PetscTruth *); 1296 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFinalized(PetscTruth *); 1297 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFinalize(void); 1298 EXTERN PetscErrorCode PetscInitializeFortran(void); 1299 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscGetArgs(int*,char ***); 1300 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscGetArguments(char ***); 1301 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFreeArguments(char **); 1302 1303 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscEnd(void); 1304 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscInitializePackage(const char[]); 1305 1306 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOpenMPMerge(PetscMPIInt); 1307 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOpenMPSpawn(PetscMPIInt); 1308 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOpenMPFinalize(void); 1309 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOpenMPRun(MPI_Comm,PetscErrorCode (*)(MPI_Comm,void *),void*); 1310 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOpenMPFree(MPI_Comm,void*); 1311 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOpenMPNew(MPI_Comm,PetscInt,void**); 1312 1313 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscPythonInitialize(const char[],const char[]); 1314 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscPythonFinalize(void); 1315 1316 /* 1317 These are so that in extern C code we can caste function pointers to non-extern C 1318 function pointers. Since the regular C++ code expects its function pointers to be 1319 C++. 1320 */ 1321 typedef void (**PetscVoidStarFunction)(void); 1322 typedef void (*PetscVoidFunction)(void); 1323 typedef PetscErrorCode (*PetscErrorCodeFunction)(void); 1324 1325 /* 1326 PetscTryMethod - Queries an object for a method, if it exists then calls it. 1327 These are intended to be used only inside PETSc functions. 1328 */ 1329 #define PetscTryMethod(obj,A,B,C) \ 1330 0;{ PetscErrorCode (*f)B, __ierr; \ 1331 __ierr = PetscObjectQueryFunction((PetscObject)obj,A,(PetscVoidStarFunction)&f);CHKERRQ(__ierr); \ 1332 if (f) {__ierr = (*f)C;CHKERRQ(__ierr);}\ 1333 } 1334 #define PetscUseMethod(obj,A,B,C) \ 1335 0;{ PetscErrorCode (*f)B, __ierr; \ 1336 __ierr = PetscObjectQueryFunction((PetscObject)obj,A,(PetscVoidStarFunction)&f);CHKERRQ(__ierr); \ 1337 if (f) {__ierr = (*f)C;CHKERRQ(__ierr);}\ 1338 else {SETERRQ1(PETSC_ERR_SUP,"Cannot locate function %s in object",A);} \ 1339 } 1340 /* 1341 Functions that can act on any PETSc object. 1342 */ 1343 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectCreate(MPI_Comm,PetscObject*); 1344 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectCreateGeneric(MPI_Comm, PetscCookie, const char [], PetscObject *); 1345 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectDestroy(PetscObject); 1346 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectExists(PetscObject,PetscTruth*); 1347 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectGetComm(PetscObject,MPI_Comm *); 1348 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectGetCookie(PetscObject,PetscCookie *); 1349 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectSetType(PetscObject,const char []); 1350 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectGetType(PetscObject,const char *[]); 1351 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectSetName(PetscObject,const char[]); 1352 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectGetName(PetscObject,const char*[]); 1353 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectSetTabLevel(PetscObject,PetscInt); 1354 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectGetTabLevel(PetscObject,PetscInt*); 1355 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectIncrementTabLevel(PetscObject,PetscObject,PetscInt); 1356 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectReference(PetscObject); 1357 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectGetReference(PetscObject,PetscInt*); 1358 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectDereference(PetscObject); 1359 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectGetNewTag(PetscObject,PetscMPIInt *); 1360 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectView(PetscObject,PetscViewer); 1361 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectCompose(PetscObject,const char[],PetscObject); 1362 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectQuery(PetscObject,const char[],PetscObject *); 1363 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectComposeFunction(PetscObject,const char[],const char[],void (*)(void)); 1364 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectSetFromOptions(PetscObject); 1365 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectSetUp(PetscObject); 1366 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscCommGetNewTag(MPI_Comm,PetscMPIInt *); 1367 1368 /*MC 1369 PetscObjectComposeFunctionDynamic - Associates a function with a given PETSc object. 1370 1371 Collective on PetscObject 1372 1373 Input Parameters: 1374 + obj - the PETSc object; this must be cast with a (PetscObject), for example, 1375 PetscObjectCompose((PetscObject)mat,...); 1376 . name - name associated with the child function 1377 . fname - name of the function 1378 - ptr - function pointer (or PETSC_NULL if using dynamic libraries) 1379 1380 Level: advanced 1381 1382 Synopsis: 1383 PetscErrorCode PetscObjectComposeFunctionDynamic(PetscObject obj,const char name[],const char fname[],void *ptr) 1384 1385 Notes: 1386 To remove a registered routine, pass in a PETSC_NULL rname and fnc(). 1387 1388 PetscObjectComposeFunctionDynamic() can be used with any PETSc object (such as 1389 Mat, Vec, KSP, SNES, etc.) or any user-provided object. 1390 1391 The composed function must be wrapped in a EXTERN_C_BEGIN/END for this to 1392 work in C++/complex with dynamic link libraries (config/configure.py options --with-shared --with-dynamic) 1393 enabled. 1394 1395 Concepts: objects^composing functions 1396 Concepts: composing functions 1397 Concepts: functions^querying 1398 Concepts: objects^querying 1399 Concepts: querying objects 1400 1401 .seealso: PetscObjectQueryFunction() 1402 M*/ 1403 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 1404 #define PetscObjectComposeFunctionDynamic(a,b,c,d) PetscObjectComposeFunction(a,b,c,0) 1405 #else 1406 #define PetscObjectComposeFunctionDynamic(a,b,c,d) PetscObjectComposeFunction(a,b,c,(PetscVoidFunction)(d)) 1407 #endif 1408 1409 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectQueryFunction(PetscObject,const char[],void (**)(void)); 1410 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectSetOptionsPrefix(PetscObject,const char[]); 1411 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectAppendOptionsPrefix(PetscObject,const char[]); 1412 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectPrependOptionsPrefix(PetscObject,const char[]); 1413 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectGetOptionsPrefix(PetscObject,const char*[]); 1414 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectPublish(PetscObject); 1415 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectChangeTypeName(PetscObject,const char[]); 1416 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectRegisterDestroy(PetscObject); 1417 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectRegisterDestroyAll(void); 1418 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectName(PetscObject); 1419 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscTypeCompare(PetscObject,const char[],PetscTruth*); 1420 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscRegisterFinalize(PetscErrorCode (*)(void)); 1421 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscRegisterFinalizeAll(void); 1422 1423 /* 1424 Defines PETSc error handling. 1425 */ 1426 #include "petscerror.h" 1427 1428 /*S 1429 PetscOList - Linked list of PETSc objects, accessable by string name 1430 1431 Level: advanced 1432 1433 .seealso: PetscOListAdd(), PetscOListDestroy(), PetscOListFind() 1434 S*/ 1435 typedef struct _n_PetscOList *PetscOList; 1436 1437 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOListDestroy(PetscOList); 1438 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOListFind(PetscOList,const char[],PetscObject*); 1439 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOListReverseFind(PetscOList,PetscObject,char**); 1440 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOListAdd(PetscOList *,const char[],PetscObject); 1441 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOListDuplicate(PetscOList,PetscOList *); 1442 1443 /* 1444 Dynamic library lists. Lists of names of routines in dynamic 1445 link libraries that will be loaded as needed. 1446 */ 1447 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFListAdd(PetscFList*,const char[],const char[],void (*)(void)); 1448 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFListDestroy(PetscFList*); 1449 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFListFind(PetscFList,MPI_Comm,const char[],void (**)(void)); 1450 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFListPrintTypes(PetscFList,MPI_Comm,FILE*,const char[],const char[],const char[],const char[]); 1451 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 1452 #define PetscFListAddDynamic(a,b,p,c) PetscFListAdd(a,b,p,0) 1453 #else 1454 #define PetscFListAddDynamic(a,b,p,c) PetscFListAdd(a,b,p,(void (*)(void))c) 1455 #endif 1456 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFListDuplicate(PetscFList,PetscFList *); 1457 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFListView(PetscFList,PetscViewer); 1458 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFListConcat(const char [],const char [],char []); 1459 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFListGet(PetscFList,char ***,int*); 1460 1461 /*S 1462 PetscDLLibrary - Linked list of dynamics libraries to search for functions 1463 1464 Level: advanced 1465 1466 --with-shared --with-dynamic must be used with config/configure.py to use dynamic libraries 1467 1468 .seealso: PetscDLLibraryOpen() 1469 S*/ 1470 typedef struct _n_PetscDLLibrary *PetscDLLibrary; 1471 extern PETSC_DLLEXPORT PetscDLLibrary DLLibrariesLoaded; 1472 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryAppend(MPI_Comm,PetscDLLibrary *,const char[]); 1473 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryPrepend(MPI_Comm,PetscDLLibrary *,const char[]); 1474 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDLLibrarySym(MPI_Comm,PetscDLLibrary *,const char[],const char[],void **); 1475 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryPrintPath(PetscDLLibrary); 1476 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryRetrieve(MPI_Comm,const char[],char *,size_t,PetscTruth *); 1477 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryOpen(MPI_Comm,const char[],PetscDLLibrary *); 1478 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryClose(PetscDLLibrary); 1479 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryCCAAppend(MPI_Comm,PetscDLLibrary *,const char[]); 1480 1481 /* 1482 Useful utility routines 1483 */ 1484 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSplitOwnership(MPI_Comm,PetscInt*,PetscInt*); 1485 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSplitOwnershipBlock(MPI_Comm,PetscInt,PetscInt*,PetscInt*); 1486 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSequentialPhaseBegin(MPI_Comm,PetscMPIInt); 1487 PetscPolymorphicSubroutine(PetscSequentialPhaseBegin,(MPI_Comm comm),(comm,1)) 1488 PetscPolymorphicSubroutine(PetscSequentialPhaseBegin,(void),(PETSC_COMM_WORLD,1)) 1489 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSequentialPhaseEnd(MPI_Comm,PetscMPIInt); 1490 PetscPolymorphicSubroutine(PetscSequentialPhaseEnd,(MPI_Comm comm),(comm,1)) 1491 PetscPolymorphicSubroutine(PetscSequentialPhaseEnd,(void),(PETSC_COMM_WORLD,1)) 1492 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscBarrier(PetscObject); 1493 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMPIDump(FILE*); 1494 1495 #define PetscNot(a) ((a) ? PETSC_FALSE : PETSC_TRUE) 1496 /* 1497 Defines basic graphics available from PETSc. 1498 */ 1499 #include "petscdraw.h" 1500 1501 /* 1502 Defines the base data structures for all PETSc objects 1503 */ 1504 #include "private/petscimpl.h" 1505 /* 1506 Defines PETSc profiling. 1507 */ 1508 #include "petsclog.h" 1509 1510 /* 1511 For locking, unlocking and destroying AMS memories associated with 1512 PETSc objects. Not currently used. 1513 */ 1514 #define PetscPublishAll(v) 0 1515 #define PetscObjectTakeAccess(obj) 0 1516 #define PetscObjectGrantAccess(obj) 0 1517 #define PetscObjectDepublish(obj) 0 1518 1519 /* 1520 Simple PETSc parallel IO for ASCII printing 1521 */ 1522 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFixFilename(const char[],char[]); 1523 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFOpen(MPI_Comm,const char[],const char[],FILE**); 1524 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFClose(MPI_Comm,FILE*); 1525 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFPrintf(MPI_Comm,FILE*,const char[],...) PETSC_PRINTF_FORMAT_CHECK(3,4); 1526 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscPrintf(MPI_Comm,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3); 1527 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSNPrintf(char*,size_t,const char [],...); 1528 1529 /* These are used internally by PETSc ASCII IO routines*/ 1530 #include <stdarg.h> 1531 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscVSNPrintf(char*,size_t,const char[],int*,va_list); 1532 EXTERN PetscErrorCode PETSC_DLLEXPORT (*PetscVFPrintf)(FILE*,const char[],va_list); 1533 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscVFPrintfDefault(FILE*,const char[],va_list); 1534 1535 /*MC 1536 PetscErrorPrintf - Prints error messages. 1537 1538 Not Collective 1539 1540 Synopsis: 1541 PetscErrorCode (*PetscErrorPrintf)(const char format[],...); 1542 1543 Input Parameters: 1544 . format - the usual printf() format string 1545 1546 Options Database Keys: 1547 + -error_output_stdout - cause error messages to be printed to stdout instead of the 1548 (default) stderr 1549 - -error_output_none to turn off all printing of error messages (does not change the way the 1550 error is handled.) 1551 1552 Notes: Use 1553 $ PetscErrorPrintf = PetscErrorPrintfNone; to turn off all printing of error messages (does not change the way the 1554 $ error is handled.) and 1555 $ PetscErrorPrintf = PetscErrorPrintfDefault; to turn it back on 1556 1557 Use 1558 PETSC_STDERR = FILE* obtained from a file open etc. to have stderr printed to the file. 1559 PETSC_STDOUT = FILE* obtained from a file open etc. to have stdout printed to the file. 1560 1561 Use 1562 PetscPushErrorHandler() to provide your own error handler that determines what kind of messages to print 1563 1564 Level: developer 1565 1566 Fortran Note: 1567 This routine is not supported in Fortran. 1568 1569 Concepts: error messages^printing 1570 Concepts: printing^error messages 1571 1572 .seealso: PetscFPrintf(), PetscSynchronizedPrintf(), PetscHelpPrintf(), PetscPrintf(), PetscErrorHandlerPush() 1573 M*/ 1574 EXTERN PETSC_DLLEXPORT PetscErrorCode (*PetscErrorPrintf)(const char[],...); 1575 1576 /*MC 1577 PetscHelpPrintf - Prints help messages. 1578 1579 Not Collective 1580 1581 Synopsis: 1582 PetscErrorCode (*PetscHelpPrintf)(const char format[],...); 1583 1584 Input Parameters: 1585 . format - the usual printf() format string 1586 1587 Level: developer 1588 1589 Fortran Note: 1590 This routine is not supported in Fortran. 1591 1592 Concepts: help messages^printing 1593 Concepts: printing^help messages 1594 1595 .seealso: PetscFPrintf(), PetscSynchronizedPrintf(), PetscErrorPrintf() 1596 M*/ 1597 EXTERN PETSC_DLLEXPORT PetscErrorCode (*PetscHelpPrintf)(MPI_Comm,const char[],...); 1598 1599 EXTERN PetscErrorCode PetscErrorPrintfDefault(const char [],...); 1600 EXTERN PetscErrorCode PetscErrorPrintfNone(const char [],...); 1601 EXTERN PetscErrorCode PetscHelpPrintfDefault(MPI_Comm,const char [],...); 1602 1603 #if defined(PETSC_HAVE_POPEN) 1604 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscPOpen(MPI_Comm,const char[],const char[],const char[],FILE **); 1605 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscPClose(MPI_Comm,FILE*); 1606 #endif 1607 1608 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSynchronizedPrintf(MPI_Comm,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3); 1609 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSynchronizedFPrintf(MPI_Comm,FILE*,const char[],...) PETSC_PRINTF_FORMAT_CHECK(3,4); 1610 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSynchronizedFlush(MPI_Comm); 1611 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSynchronizedFGets(MPI_Comm,FILE*,size_t,char[]); 1612 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStartMatlab(MPI_Comm,const char[],const char[],FILE**); 1613 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStartJava(MPI_Comm,const char[],const char[],FILE**); 1614 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscGetPetscDir(const char*[]); 1615 1616 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscPopUpSelect(MPI_Comm,const char*,const char*,int,const char**,int*); 1617 1618 /*S 1619 PetscContainer - Simple PETSc object that contains a pointer to any required data 1620 1621 Level: advanced 1622 1623 .seealso: PetscObject, PetscContainerCreate() 1624 S*/ 1625 extern PetscCookie PETSC_DLLEXPORT PETSC_CONTAINER_COOKIE; 1626 typedef struct _p_PetscContainer* PetscContainer; 1627 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscContainerGetPointer(PetscContainer,void **); 1628 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscContainerSetPointer(PetscContainer,void *); 1629 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscContainerDestroy(PetscContainer); 1630 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscContainerCreate(MPI_Comm,PetscContainer *); 1631 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscContainerSetUserDestroy(PetscContainer, PetscErrorCode (*)(void*)); 1632 1633 /* 1634 For use in debuggers 1635 */ 1636 extern PETSC_DLLEXPORT PetscMPIInt PetscGlobalRank; 1637 extern PETSC_DLLEXPORT PetscMPIInt PetscGlobalSize; 1638 1639 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscIntView(PetscInt,const PetscInt[],PetscViewer); 1640 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscRealView(PetscInt,const PetscReal[],PetscViewer); 1641 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscScalarView(PetscInt,const PetscScalar[],PetscViewer); 1642 1643 #if defined(PETSC_HAVE_MEMORY_H) 1644 #include <memory.h> 1645 #endif 1646 #if defined(PETSC_HAVE_STDLIB_H) 1647 #include <stdlib.h> 1648 #endif 1649 #if defined(PETSC_HAVE_STRINGS_H) 1650 #include <strings.h> 1651 #endif 1652 #if defined(PETSC_HAVE_STRING_H) 1653 #include <string.h> 1654 #endif 1655 #if defined(PETSC_PREFER_DCOPY_FOR_MEMCPY) 1656 #include "petscblaslapack.h" 1657 #endif 1658 #if defined(PETSC_HAVE_XMMINTRIN_H) 1659 #include <xmmintrin.h> 1660 #endif 1661 #if defined(PETSC_HAVE_STDINT_H) 1662 #include <stdint.h> 1663 #endif 1664 1665 /*@C 1666 PetscMemcpy - Copies n bytes, beginning at location b, to the space 1667 beginning at location a. The two memory regions CANNOT overlap, use 1668 PetscMemmove() in that case. 1669 1670 Not Collective 1671 1672 Input Parameters: 1673 + b - pointer to initial memory space 1674 - n - length (in bytes) of space to copy 1675 1676 Output Parameter: 1677 . a - pointer to copy space 1678 1679 Level: intermediate 1680 1681 Compile Option: 1682 PETSC_PREFER_DCOPY_FOR_MEMCPY will cause the BLAS dcopy() routine to be used 1683 for memory copies on double precision values. 1684 PETSC_PREFER_COPY_FOR_MEMCPY will cause C code to be used 1685 for memory copies on double precision values. 1686 PETSC_PREFER_FORTRAN_FORMEMCPY will cause Fortran code to be used 1687 for memory copies on double precision values. 1688 1689 Note: 1690 This routine is analogous to memcpy(). 1691 1692 Concepts: memory^copying 1693 Concepts: copying^memory 1694 1695 .seealso: PetscMemmove() 1696 1697 @*/ 1698 PETSC_STATIC_INLINE PetscErrorCode PETSC_DLLEXPORT PetscMemcpy(void *a,const void *b,size_t n) 1699 { 1700 #if defined(PETSC_USE_DEBUG) 1701 unsigned long al = (unsigned long) a,bl = (unsigned long) b; 1702 unsigned long nl = (unsigned long) n; 1703 if (n > 0 && !b) SETERRQ(PETSC_ERR_ARG_NULL,"Trying to copy from a null pointer"); 1704 if (n > 0 && !a) SETERRQ(PETSC_ERR_ARG_NULL,"Trying to copy to a null pointer"); 1705 #endif 1706 PetscFunctionBegin; 1707 if (a != b) { 1708 #if defined(PETSC_USE_DEBUG) 1709 if ((al > bl && (al - bl) < nl) || (bl - al) < nl) { 1710 SETERRQ3(PETSC_ERR_ARG_INCOMP,"Memory regions overlap: either use PetscMemmov()\n\ 1711 or make sure your copy regions and lengths are correct. \n\ 1712 Length (bytes) %ld first address %ld second address %ld",nl,al,bl); 1713 } 1714 #endif 1715 #if (defined(PETSC_PREFER_DCOPY_FOR_MEMCPY) || defined(PETSC_PREFER_COPY_FOR_MEMCPY) || defined(PETSC_PREFER_FORTRAN_FORMEMCPY)) 1716 if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) { 1717 size_t len = n/sizeof(PetscScalar); 1718 #if defined(PETSC_PREFER_DCOPY_FOR_MEMCPY) 1719 PetscBLASInt one = 1,blen = PetscBLASIntCast(len); 1720 BLAScopy_(&blen,(PetscScalar *)b,&one,(PetscScalar *)a,&one); 1721 #elif defined(PETSC_PREFER_FORTRAN_FORMEMCPY) 1722 fortrancopy_(&len,(PetscScalar*)b,(PetscScalar*)a); 1723 #else 1724 size_t i; 1725 PetscScalar *x = (PetscScalar*)b, *y = (PetscScalar*)a; 1726 for (i=0; i<len; i++) y[i] = x[i]; 1727 #endif 1728 } else { 1729 memcpy((char*)(a),(char*)(b),n); 1730 } 1731 #elif defined(PETSC_HAVE__INTEL_FAST_MEMCPY) 1732 _intel_fast_memcpy((char*)(a),(char*)(b),n); 1733 #else 1734 memcpy((char*)(a),(char*)(b),n); 1735 #endif 1736 } 1737 PetscFunctionReturn(0); 1738 } 1739 1740 /*@C 1741 PetscMemzero - Zeros the specified memory. 1742 1743 Not Collective 1744 1745 Input Parameters: 1746 + a - pointer to beginning memory location 1747 - n - length (in bytes) of memory to initialize 1748 1749 Level: intermediate 1750 1751 Compile Option: 1752 PETSC_PREFER_BZERO - on certain machines (the IBM RS6000) the bzero() routine happens 1753 to be faster than the memset() routine. This flag causes the bzero() routine to be used. 1754 1755 Concepts: memory^zeroing 1756 Concepts: zeroing^memory 1757 1758 .seealso: PetscMemcpy() 1759 @*/ 1760 PETSC_STATIC_INLINE PetscErrorCode PETSC_DLLEXPORT PetscMemzero(void *a,size_t n) 1761 { 1762 if (n > 0) { 1763 #if defined(PETSC_USE_DEBUG) 1764 if (!a) SETERRQ(PETSC_ERR_ARG_NULL,"Trying to zero at a null pointer"); 1765 #endif 1766 #if defined(PETSC_PREFER_ZERO_FOR_MEMZERO) 1767 if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) { 1768 size_t i,len = n/sizeof(PetscScalar); 1769 PetscScalar *x = (PetscScalar*)a; 1770 for (i=0; i<len; i++) x[i] = 0.0; 1771 } else { 1772 #elif defined(PETSC_PREFER_FORTRAN_FOR_MEMZERO) 1773 if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) { 1774 PetscInt len = n/sizeof(PetscScalar); 1775 fortranzero_(&len,(PetscScalar*)a); 1776 } else { 1777 #endif 1778 #if defined(PETSC_PREFER_BZERO) 1779 bzero((char *)a,n); 1780 #elif defined (PETSC_HAVE__INTEL_FAST_MEMSET) 1781 _intel_fast_memset((char*)a,0,n); 1782 #else 1783 memset((char*)a,0,n); 1784 #endif 1785 #if defined(PETSC_PREFER_ZERO_FOR_MEMZERO) || defined(PETSC_PREFER_FORTRAN_FOR_MEMZERO) 1786 } 1787 #endif 1788 } 1789 return 0; 1790 } 1791 1792 /* 1793 Allows accessing Matlab Engine 1794 */ 1795 #include "petscmatlab.h" 1796 1797 /* 1798 Determine if some of the kernel computation routines use 1799 Fortran (rather than C) for the numerical calculations. On some machines 1800 and compilers (like complex numbers) the Fortran version of the routines 1801 is faster than the C/C++ versions. The flag --with-fortran-kernels 1802 should be used with config/configure.py to turn these on. 1803 */ 1804 #if defined(PETSC_USE_FORTRAN_KERNELS) 1805 1806 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTCRL) 1807 #define PETSC_USE_FORTRAN_KERNEL_MULTCRL 1808 #endif 1809 1810 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTCSRPERM) 1811 #define PETSC_USE_FORTRAN_KERNEL_MULTCSRPERM 1812 #endif 1813 1814 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJ) 1815 #define PETSC_USE_FORTRAN_KERNEL_MULTAIJ 1816 #endif 1817 1818 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ) 1819 #define PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ 1820 #endif 1821 1822 #if !defined(PETSC_USE_FORTRAN_KERNEL_NORM) 1823 #define PETSC_USE_FORTRAN_KERNEL_NORM 1824 #endif 1825 1826 #if !defined(PETSC_USE_FORTRAN_KERNEL_MAXPY) 1827 #define PETSC_USE_FORTRAN_KERNEL_MAXPY 1828 #endif 1829 1830 #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ) 1831 #define PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ 1832 #endif 1833 1834 #if !defined(PETSC_USE_FORTRAN_KERNEL_RELAXAIJ) 1835 #define PETSC_USE_FORTRAN_KERNEL_RELAXAIJ 1836 #endif 1837 1838 #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ) 1839 #define PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ 1840 #endif 1841 1842 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ) 1843 #define PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ 1844 #endif 1845 1846 #if !defined(PETSC_USE_FORTRAN_KERNEL_MDOT) 1847 #define PETSC_USE_FORTRAN_KERNEL_MDOT 1848 #endif 1849 1850 #if !defined(PETSC_USE_FORTRAN_KERNEL_XTIMESY) 1851 #define PETSC_USE_FORTRAN_KERNEL_XTIMESY 1852 #endif 1853 1854 #if !defined(PETSC_USE_FORTRAN_KERNEL_AYPX) 1855 #define PETSC_USE_FORTRAN_KERNEL_AYPX 1856 #endif 1857 1858 #if !defined(PETSC_USE_FORTRAN_KERNEL_WAXPY) 1859 #define PETSC_USE_FORTRAN_KERNEL_WAXPY 1860 #endif 1861 1862 #endif 1863 1864 /* 1865 Macros for indicating code that should be compiled with a C interface, 1866 rather than a C++ interface. Any routines that are dynamically loaded 1867 (such as the PCCreate_XXX() routines) must be wrapped so that the name 1868 mangler does not change the functions symbol name. This just hides the 1869 ugly extern "C" {} wrappers. 1870 */ 1871 #if defined(__cplusplus) 1872 #define EXTERN_C_BEGIN extern "C" { 1873 #define EXTERN_C_END } 1874 #else 1875 #define EXTERN_C_BEGIN 1876 #define EXTERN_C_END 1877 #endif 1878 1879 /* --------------------------------------------------------------------*/ 1880 1881 /*MC 1882 size - integer variable used to contain the number of processors in 1883 the relevent MPI_Comm 1884 1885 Level: beginner 1886 1887 .seealso: rank, comm 1888 M*/ 1889 1890 /*MC 1891 rank - integer variable used to contain the number of this processor relative 1892 to all in the relevent MPI_Comm 1893 1894 Level: beginner 1895 1896 .seealso: size, comm 1897 M*/ 1898 1899 /*MC 1900 comm - MPI_Comm used in the current routine or object 1901 1902 Level: beginner 1903 1904 .seealso: size, rank 1905 M*/ 1906 1907 /*MC 1908 MPI_Comm - the basic object used by MPI to determine which processes are involved in a 1909 communication 1910 1911 Level: beginner 1912 1913 Note: This manual page is a place-holder because MPICH does not have a manual page for MPI_Comm 1914 1915 .seealso: size, rank, comm, PETSC_COMM_WORLD, PETSC_COMM_SELF 1916 M*/ 1917 1918 /*MC 1919 PetscScalar - PETSc type that represents either a double precision real number, a double precision 1920 complex number, a single precision real number, a long double or an int - if the code is configured 1921 with --with-scalar-type=real,complex --with-precision=single,double,longdouble,int,matsingle 1922 1923 1924 Level: beginner 1925 1926 .seealso: PetscReal, PassiveReal, PassiveScalar, MPIU_SCALAR, PetscInt 1927 M*/ 1928 1929 /*MC 1930 PetscReal - PETSc type that represents a real number version of PetscScalar 1931 1932 Level: beginner 1933 1934 .seealso: PetscScalar, PassiveReal, PassiveScalar 1935 M*/ 1936 1937 /*MC 1938 PassiveScalar - PETSc type that represents a PetscScalar 1939 Level: beginner 1940 1941 This is the same as a PetscScalar except in code that is automatically differentiated it is 1942 treated as a constant (not an indendent or dependent variable) 1943 1944 .seealso: PetscReal, PassiveReal, PetscScalar 1945 M*/ 1946 1947 /*MC 1948 PassiveReal - PETSc type that represents a PetscReal 1949 1950 Level: beginner 1951 1952 This is the same as a PetscReal except in code that is automatically differentiated it is 1953 treated as a constant (not an indendent or dependent variable) 1954 1955 .seealso: PetscScalar, PetscReal, PassiveScalar 1956 M*/ 1957 1958 /*MC 1959 MPIU_SCALAR - MPI datatype corresponding to PetscScalar 1960 1961 Level: beginner 1962 1963 Note: In MPI calls that require an MPI datatype that matches a PetscScalar or array of PetscScalars 1964 pass this value 1965 1966 .seealso: PetscReal, PassiveReal, PassiveScalar, PetscScalar, MPIU_INT 1967 M*/ 1968 1969 #if defined(PETSC_HAVE_MPIIO) 1970 #if !defined(PETSC_WORDS_BIGENDIAN) 1971 extern PetscErrorCode MPIU_File_write_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*); 1972 extern PetscErrorCode MPIU_File_read_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*); 1973 #else 1974 #define MPIU_File_write_all(a,b,c,d,e) MPI_File_write_all(a,b,c,d,e) 1975 #define MPIU_File_read_all(a,b,c,d,e) MPI_File_read_all(a,b,c,d,e) 1976 #endif 1977 #endif 1978 1979 /* the following petsc_static_inline require petscerror.h */ 1980 1981 /* Limit MPI to 32-bits */ 1982 #define PETSC_MPI_INT_MAX 2147483647 1983 #define PETSC_MPI_INT_MIN -2147483647 1984 /* Limit BLAS to 32-bits */ 1985 #define PETSC_BLAS_INT_MAX 2147483647 1986 #define PETSC_BLAS_INT_MIN -2147483647 1987 /* On 32 bit systems HDF5 is limited by size of integer, because hsize_t is defined as size_t */ 1988 #define PETSC_HDF5_INT_MAX 2147483647 1989 #define PETSC_HDF5_INT_MIN -2147483647 1990 1991 #if defined(PETSC_USE_64BIT_INDICES) 1992 #define PetscMPIIntCheck(a) if ((a) > PETSC_MPI_INT_MAX) SETERRQ(PETSC_ERR_ARG_OUTOFRANGE,"Message too long for MPI") 1993 #define PetscBLASIntCheck(a) if ((a) > PETSC_BLAS_INT_MAX) SETERRQ(PETSC_ERR_ARG_OUTOFRANGE,"Array too long for BLAS/LAPACK") 1994 #define PetscMPIIntCast(a) (a);PetscMPIIntCheck(a) 1995 #define PetscBLASIntCast(a) (a);PetscBLASIntCheck(a) 1996 1997 #if (PETSC_SIZEOF_SIZE_T == 4) 1998 #define PetscHDF5IntCheck(a) if ((a) > PETSC_HDF5_INT_MAX) SETERRQ(PETSC_ERR_ARG_OUTOFRANGE,"Array too long for HDF5") 1999 #define PetscHDF5IntCast(a) (a);PetscHDF5IntCheck(a) 2000 #else 2001 #define PetscHDF5IntCheck(a) 2002 #define PetscHDF5IntCast(a) a 2003 #endif 2004 2005 #else 2006 #define PetscMPIIntCheck(a) 2007 #define PetscBLASIntCheck(a) 2008 #define PetscHDF5IntCheck(a) 2009 #define PetscMPIIntCast(a) a 2010 #define PetscBLASIntCast(a) a 2011 #define PetscHDF5IntCast(a) a 2012 #endif 2013 2014 2015 /* 2016 The IBM include files define hz, here we hide it so that it may be used 2017 as a regular user variable. 2018 */ 2019 #if defined(hz) 2020 #undef hz 2021 #endif 2022 2023 /* For arrays that contain filenames or paths */ 2024 2025 2026 #if defined(PETSC_HAVE_LIMITS_H) 2027 #include <limits.h> 2028 #endif 2029 #if defined(PETSC_HAVE_SYS_PARAM_H) 2030 #include <sys/param.h> 2031 #endif 2032 #if defined(PETSC_HAVE_SYS_TYPES_H) 2033 #include <sys/types.h> 2034 #endif 2035 #if defined(MAXPATHLEN) 2036 # define PETSC_MAX_PATH_LEN MAXPATHLEN 2037 #elif defined(MAX_PATH) 2038 # define PETSC_MAX_PATH_LEN MAX_PATH 2039 #elif defined(_MAX_PATH) 2040 # define PETSC_MAX_PATH_LEN _MAX_PATH 2041 #else 2042 # define PETSC_MAX_PATH_LEN 4096 2043 #endif 2044 2045 /* Special support for C++ */ 2046 #include "petsc.hh" 2047 2048 /*MC 2049 2050 UsingFortran - Fortran can be used with PETSc in four distinct approaches 2051 2052 $ 1) classic Fortran 77 style 2053 $#include "petscXXX.h" to work with material from the XXX component of PETSc 2054 $ XXX variablename 2055 $ You cannot use this approach if you wish to use the Fortran 90 specific PETSc routines 2056 $ which end in F90; such as VecGetArrayF90() 2057 $ 2058 $ 2) classic Fortran 90 style 2059 $#include "petscXXX.h" 2060 $#include "petscXXX.h90" to work with material from the XXX component of PETSc 2061 $ XXX variablename 2062 $ 2063 $ 3) Using Fortran modules 2064 $#include "petscXXXdef.h" 2065 $ use petscXXXX 2066 $ XXX variablename 2067 $ 2068 $ 4) Use Fortran modules and Fortran data types for PETSc types 2069 $#include "petscXXXdef.h" 2070 $ use petscXXXX 2071 $ type(XXX) variablename 2072 $ To use this approach you must config/configure.py PETSc with the additional 2073 $ option --with-fortran-datatypes You cannot use the type(XXX) declaration approach without using Fortran modules 2074 2075 Finally if you absolutely do not want to use any #include you can use either 2076 2077 $ 3a) skip the #include BUT you cannot use any PETSc data type names like Vec, Mat, PetscInt, PetscErrorCode etc 2078 $ and you must declare the variables as integer, for example 2079 $ integer variablename 2080 $ 2081 $ 4a) skip the #include, you use the object types like type(Vec) type(Mat) but cannot use the data type 2082 $ names like PetscErrorCode, PetscInt etc. again for those you must use integer 2083 2084 We recommend either 2 or 3. Approaches 2 and 3 provide type checking for most PETSc function calls; 4 has type checking 2085 for only a few PETSc functions. 2086 2087 Fortran type checking with interfaces is strick, this means you cannot pass a scalar value when an array value 2088 is expected (even though it is legal Fortran). For example when setting a single value in a matrix with MatSetValues() 2089 you cannot have something like 2090 $ PetscInt row,col 2091 $ PetscScalar val 2092 $ ... 2093 $ call MatSetValues(mat,1,row,1,col,val,INSERT_VALUES,ierr) 2094 You must instead have 2095 $ PetscInt row(1),col(1) 2096 $ PetscScalar val(1) 2097 $ ... 2098 $ call MatSetValues(mat,1,row,1,col,val,INSERT_VALUES,ierr) 2099 2100 2101 See the example src/vec/vec/examples/tutorials/ex20f90.F90 for an example that can use all four approaches 2102 2103 Developer Notes: The finclude/petscXXXdef.h contain all the #defines (would be typedefs in C code) these 2104 automatically include their predecessors; for example finclude/petscvecdef.h includes finclude/petscisdef.h 2105 2106 The finclude/petscXXXX.h contain all the parameter statements for that package. These automatically include 2107 their finclude/petscXXXdef.h file but DO NOT automatically include their predecessors; for example 2108 finclude/petscvec.h does NOT automatically include finclude/petscis.h 2109 2110 The finclude/ftn-custom/petscXXXdef.h90 are not intended to be used directly in code, they define the 2111 Fortran data type type(XXX) (for example type(Vec)) when PETSc is config/configure.py with the --with-fortran-datatypes option. 2112 2113 The finclude/ftn-custom/petscXXX.h90 (not included directly by code) contain interface definitions for 2114 the PETSc Fortran stubs that have different bindings then their C version (for example VecGetArrayF90). 2115 2116 The finclude/ftn-auto/petscXXX.h90 (not included directly by code) contain interface definitions generated 2117 automatically by "make allfortranstubs". 2118 2119 The finclude/petscXXX.h90 includes the custom finclude/ftn-custom/petscXXX.h90 and if config/configure.py 2120 was run with --with-fortran-interfaces it also includes the finclude/ftn-auto/petscXXX.h90 These DO NOT automatically 2121 include their predecessors 2122 2123 Level: beginner 2124 2125 M*/ 2126 PETSC_EXTERN_CXX_END 2127 #endif 2128