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