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