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 bmake/${PETSC_ARCH}/petscconf.h it is 10 found automatically by the compiler due to the -I${PETSC_DIR}/bmake/${PETSC_ARCH} 11 in the bmake/common_variables definition of PETSC_INCLUDE 12 */ 13 #include "petscconf.h" 14 15 /* ========================================================================== */ 16 /* 17 This facilitates using C version of PETSc from C++ and 18 C++ version from C (use --with-c-support --with-language=c++ with config/configure.py) 19 */ 20 #if defined(PETSC_CLANGUAGE_CXX) && !defined(PETSC_USE_EXTERN_CXX) && !defined(__cplusplus) 21 #error "PETSc configured with --with-clanguage=c++ and NOT --with-c-support - it can be used only with a C++ compiler" 22 #endif 23 24 /* 25 Allows standard Unix binary IO to access files larger than 2 gigabytes 26 on some systems. This is made the default so that users won't suddenly 27 get stuck with things suddenly not working. 28 */ 29 #define __USE_FILE_OFFSET64 30 31 #if defined(PETSC_USE_EXTERN_CXX) && defined(__cplusplus) 32 #define PETSC_EXTERN_CXX_BEGIN extern "C" { 33 #define PETSC_EXTERN_CXX_END } 34 #else 35 #define PETSC_EXTERN_CXX_BEGIN 36 #define PETSC_EXTERN_CXX_END 37 #endif 38 /* ========================================================================== */ 39 /* 40 Current PETSc version number and release date 41 */ 42 #include "petscversion.h" 43 44 /* 45 Currently cannot check formatting for PETSc print statements because we have our 46 own format %D and %G 47 */ 48 #undef PETSC_PRINTF_FORMAT_CHECK 49 #define PETSC_PRINTF_FORMAT_CHECK(a,b) 50 #undef PETSC_FPRINTF_FORMAT_CHECK 51 #define PETSC_FPRINTF_FORMAT_CHECK(a,b) 52 53 /* 54 Fixes for configure time choices which impact our interface. Currently only 55 calling conventions and extra compiler checking falls under this category. 56 */ 57 #if !defined(PETSC_STDCALL) 58 #define PETSC_STDCALL 59 #endif 60 #if !defined(PETSC_TEMPLATE) 61 #define PETSC_TEMPLATE 62 #endif 63 #if !defined(PETSC_HAVE_DLL_EXPORT) 64 #define PETSC_DLL_EXPORT 65 #define PETSC_DLL_IMPORT 66 #endif 67 #if !defined(PETSC_DLLEXPORT) 68 #define PETSC_DLLEXPORT 69 #endif 70 #if !defined(PETSCVEC_DLLEXPORT) 71 #define PETSCVEC_DLLEXPORT 72 #endif 73 #if !defined(PETSCMAT_DLLEXPORT) 74 #define PETSCMAT_DLLEXPORT 75 #endif 76 #if !defined(PETSCDM_DLLEXPORT) 77 #define PETSCDM_DLLEXPORT 78 #endif 79 #if !defined(PETSCKSP_DLLEXPORT) 80 #define PETSCKSP_DLLEXPORT 81 #endif 82 #if !defined(PETSCSNES_DLLEXPORT) 83 #define PETSCSNES_DLLEXPORT 84 #endif 85 #if !defined(PETSCTS_DLLEXPORT) 86 #define PETSCTS_DLLEXPORT 87 #endif 88 #if !defined(PETSCFORTRAN_DLLEXPORT) 89 #define PETSCFORTRAN_DLLEXPORT 90 #endif 91 /* ========================================================================== */ 92 93 /* 94 Defines the interface to MPI allowing the use of all MPI functions. 95 96 PETSc does not use the C++ binding of MPI at ALL. The following flag 97 makes sure the C++ bindings are not included. The C++ binds REQUIRE 98 putting mpi.h before ANY C++ include files, we cannot control this 99 with all PETSc users. 100 */ 101 #define MPICH_SKIP_MPICXX 1 102 #include "mpi.h" 103 /* 104 Yuck, we need to put stdio.h AFTER mpi.h for MPICH2 with C++ compiler 105 see the top of mpicxx.h 106 107 The MPI STANDARD HAS TO BE CHANGED to prevent this nonsense. 108 */ 109 #include <stdio.h> 110 111 /* 112 All PETSc C functions return this error code, it is the final argument of 113 all Fortran subroutines 114 */ 115 116 /*MC 117 PetscErrorCode - datatype used for return error code from all PETSc functions 118 119 Level: beginner 120 121 .seealso: CHKERRQ, SETERRQ 122 M*/ 123 typedef int PetscErrorCode; 124 /*MC 125 126 PetscCookie - A unique id used to identify each PETSc object. 127 (internal integer in the data structure used for error 128 checking). These are all defined by an offset from the lowest 129 one, PETSC_COOKIE. 130 131 Level: advanced 132 M*/ 133 typedef int PetscCookie; 134 /*MC 135 PetscEvent - id used to identify PETSc or user events - primarily for logging 136 137 Level: intermediate 138 139 .seealso: PetscLogEventRegister, PetscLogEventBegin PetscLogEventEnd 140 M*/ 141 typedef int PetscEvent; 142 /*MC 143 PetscBLASInt - datatype used to represent 'int' parameters to blas functions. 144 145 Level: intermediate 146 M*/ 147 typedef int PetscBLASInt; 148 /*MC 149 PetscMPIInt - datatype used to represent 'int' parameters to MPI functions. 150 151 Level: intermediate 152 M*/ 153 typedef int PetscMPIInt; 154 /*MC 155 PetscEnum - datatype used to pass enum types within PETSc functions. 156 157 Level: intermediate 158 159 .seealso: PetscOptionsGetEnum, PetscOptionsEnum, PetscBagRegisterEnum 160 M*/ 161 typedef enum { ENUM_DUMMY } PetscEnum; 162 /*MC 163 PetscInt - PETSc type that represents integer - used primarily to 164 represent size of objects. Its size can be configured with the option 165 --with-64-bit-indices - to be either 32bit or 64bit [default 32 bit ints] 166 167 Level: intermediate 168 169 .seealso: PetscScalar, VecSetSizes 170 M*/ 171 #if defined(PETSC_USE_64BIT_INDICES) 172 typedef long long PetscInt; 173 #define MPIU_INT MPI_LONG_LONG_INT 174 #else 175 typedef int PetscInt; 176 #define MPIU_INT MPI_INT 177 #endif 178 179 /* 180 You can use PETSC_STDOUT as a replacement of stdout. You can also change 181 the value of PETSC_STDOUT to redirect all standard output elsewhere 182 */ 183 extern FILE* PETSC_STDOUT; 184 185 #if !defined(PETSC_USE_EXTERN_CXX) && defined(__cplusplus) 186 /*MC 187 PetscPolymorphicSubroutine - allows defining a C++ polymorphic version of 188 a PETSc function that remove certain optional arguments for a simplier user interface 189 190 Not collective 191 192 Synopsis: 193 PetscPolymorphicSubroutine(Functionname,(arguments of C++ function),(arguments of C function)) 194 195 Level: developer 196 197 Example: 198 PetscPolymorphicSubroutine(VecNorm,(Vec x,PetscReal *r),(x,NORM_2,r)) generates the new routine 199 PetscErrorCode VecNorm(Vec x,PetscReal *r) = VecNorm(x,NORM_2,r) 200 201 .seealso: PetscPolymorphicFunction() 202 203 M*/ 204 #define PetscPolymorphicSubroutine(A,B,C) PETSC_STATIC_INLINE PetscErrorCode A B {return A C;} 205 206 /*MC 207 PetscPolymorphicScalar - allows defining a C++ polymorphic version of 208 a PETSc function that replaces a PetscScalar * argument with a PetscScalar argument 209 210 Not collective 211 212 Synopsis: 213 PetscPolymorphicScalar(Functionname,(arguments of C++ function),(arguments of C function)) 214 215 Level: developer 216 217 Example: 218 PetscPolymorphicScalar(VecAXPY,(PetscScalar _t,Vec x,Vec y),(&_T,x,y)) generates the new routine 219 PetscErrorCode VecAXPY(PetscScalar _t,Vec x,Vec y) = {PetscScalar _T = _t; return VecAXPY(&_T,x,y);} 220 221 .seealso: PetscPolymorphicFunction(),PetscPolymorphicSubroutine() 222 223 M*/ 224 #define PetscPolymorphicScalar(A,B,C) PETSC_STATIC_INLINE PetscErrorCode A B {PetscScalar _T = _t; return A C;} 225 226 /*MC 227 PetscPolymorphicFunction - allows defining a C++ polymorphic version of 228 a PETSc function that remove certain optional arguments for a simplier user interface 229 and returns the computed value (istead of an error code) 230 231 Not collective 232 233 Synopsis: 234 PetscPolymorphicFunction(Functionname,(arguments of C++ function),(arguments of C function),return type,return variable name) 235 236 Level: developer 237 238 Example: 239 PetscPolymorphicFunction(VecNorm,(Vec x,NormType t),(x,t,&r),PetscReal,r) generates the new routine 240 PetscReal VecNorm(Vec x,NormType t) = {PetscReal r; VecNorm(x,t,&r); return r;} 241 242 .seealso: PetscPolymorphicSubroutine() 243 244 M*/ 245 #define PetscPolymorphicFunction(A,B,C,D,E) PETSC_STATIC_INLINE D A B {D E; A C;return E;} 246 247 #else 248 #define PetscPolymorphicSubroutine(A,B,C) 249 #define PetscPolymorphicScalar(A,B,C) 250 #define PetscPolymorphicFunction(A,B,C,D,E) 251 #endif 252 253 /* 254 Extern indicates a PETSc function defined elsewhere 255 */ 256 #if !defined(EXTERN) 257 #define EXTERN extern 258 #endif 259 260 /* 261 Defines some elementary mathematics functions and constants. 262 */ 263 #include "petscmath.h" 264 265 /* 266 Declare extern C stuff after incuding external header files 267 */ 268 269 PETSC_EXTERN_CXX_BEGIN 270 271 /* 272 Basic PETSc constants 273 */ 274 275 /*E 276 PetscTruth - Logical variable. Actually an integer 277 278 Level: beginner 279 280 E*/ 281 typedef enum { PETSC_FALSE,PETSC_TRUE } PetscTruth; 282 extern const char *PetscTruths[]; 283 284 /*MC 285 PETSC_FALSE - False value of PetscTruth 286 287 Level: beginner 288 289 Note: Zero integer 290 291 .seealso: PetscTruth 292 M*/ 293 294 /*MC 295 PETSC_TRUE - True value of PetscTruth 296 297 Level: beginner 298 299 Note: Nonzero integer 300 301 .seealso: PetscTruth 302 M*/ 303 304 /*MC 305 PETSC_YES - Alias for PETSC_TRUE 306 307 Level: beginner 308 309 Note: Zero integer 310 311 .seealso: PetscTruth 312 M*/ 313 #define PETSC_YES PETSC_TRUE 314 315 /*MC 316 PETSC_NO - Alias for PETSC_FALSE 317 318 Level: beginner 319 320 Note: Nonzero integer 321 322 .seealso: PetscTruth 323 M*/ 324 #define PETSC_NO PETSC_FALSE 325 326 /*MC 327 PETSC_NULL - standard way of passing in a null or array or pointer 328 329 Level: beginner 330 331 Notes: accepted by many PETSc functions to not set a parameter and instead use 332 some default 333 334 This macro does not exist in Fortran; you must use PETSC_NULL_INTEGER, 335 PETSC_NULL_DOUBLE_PRECISION etc 336 337 .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_IGNORE, PETSC_DETERMINE 338 339 M*/ 340 #define PETSC_NULL 0 341 342 /*MC 343 PETSC_DECIDE - standard way of passing in integer or floating point parameter 344 where you wish PETSc to use the default. 345 346 Level: beginner 347 348 .seealso: PETSC_NULL, PETSC_DEFAULT, PETSC_IGNORE, PETSC_DETERMINE 349 350 M*/ 351 #define PETSC_DECIDE -1 352 353 /*MC 354 PETSC_DEFAULT - standard way of passing in integer or floating point parameter 355 where you wish PETSc to use the default. 356 357 Level: beginner 358 359 .seealso: PETSC_DECIDE, PETSC_NULL, PETSC_IGNORE, PETSC_DETERMINE 360 361 M*/ 362 #define PETSC_DEFAULT -2 363 364 365 /*MC 366 PETSC_IGNORE - same as PETSC_NULL, means PETSc will ignore this argument 367 368 Level: beginner 369 370 Notes: accepted by many PETSc functions to not set a parameter and instead use 371 some default 372 373 This macro does not exist in Fortran; you must use PETSC_NULL_INTEGER, 374 PETSC_NULL_DOUBLE_PRECISION etc 375 376 .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_NULL, PETSC_DETERMINE 377 378 M*/ 379 #define PETSC_IGNORE PETSC_NULL 380 381 /*MC 382 PETSC_DETERMINE - standard way of passing in integer or floating point parameter 383 where you wish PETSc to compute the required value. 384 385 Level: beginner 386 387 .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_IGNORE, PETSC_NULL, VecSetSizes() 388 389 M*/ 390 #define PETSC_DETERMINE PETSC_DECIDE 391 392 /*MC 393 PETSC_COMM_WORLD - the equivalent of the MPI_COMM_WORLD communicator which represents 394 all the processs that PETSc knows about. 395 396 Level: beginner 397 398 Notes: By default PETSC_COMM_WORLD and MPI_COMM_WORLD are identical unless you wish to 399 run PETSc on ONLY a subset of MPI_COMM_WORLD. In that case create your new (smaller) 400 communicator, call it, say comm, and set PETSC_COMM_WORLD = comm BEFORE calling 401 PetscInitialize() 402 403 .seealso: PETSC_COMM_SELF 404 405 M*/ 406 extern MPI_Comm PETSC_COMM_WORLD; 407 408 /*MC 409 PETSC_COMM_SELF - a duplicate of the MPI_COMM_SELF communicator which represents 410 the current process 411 412 Level: beginner 413 414 Notes: PETSC_COMM_SELF and MPI_COMM_SELF are equivalent. 415 416 .seealso: PETSC_COMM_WORLD 417 418 M*/ 419 #define PETSC_COMM_SELF MPI_COMM_SELF 420 421 extern PETSC_DLLEXPORT PetscTruth PetscInitializeCalled; 422 extern PETSC_DLLEXPORT PetscTruth PetscFinalizeCalled; 423 424 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSetHelpVersionFunctions(PetscErrorCode (*)(MPI_Comm),PetscErrorCode (*)(MPI_Comm)); 425 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscCommDuplicate(MPI_Comm,MPI_Comm*,int*); 426 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscCommDestroy(MPI_Comm*); 427 428 /*MC 429 PetscMalloc - Allocates memory 430 431 Input Parameter: 432 . m - number of bytes to allocate 433 434 Output Parameter: 435 . result - memory allocated 436 437 Synopsis: 438 PetscErrorCode PetscMalloc(size_t m,void **result) 439 440 Level: beginner 441 442 Notes: Memory is always allocated at least double aligned 443 444 If you request memory of zero size it will allocate no space and assign the pointer to 0; PetscFree() will 445 properly handle not freeing the null pointer. 446 447 .seealso: PetscFree(), PetscNew() 448 449 Concepts: memory allocation 450 451 M*/ 452 #define PetscMalloc(a,b) ((a != 0) ? (*PetscTrMalloc)((a),__LINE__,__FUNCT__,__FILE__,__SDIR__,(void**)(b)) : (*(b) = 0,0) ) 453 454 /*MC 455 PetscMalloc2 - Allocates 2 chunks of memory 456 457 Input Parameter: 458 + m1 - number of elements to allocate in 1st chunk (may be zero) 459 . t1 - type of first memory elements 460 . m2 - number of elements to allocate in 2nd chunk (may be zero) 461 - t2 - type of second memory elements 462 463 Output Parameter: 464 + r1 - memory allocated in first chunk 465 - r2 - memory allocated in second chunk 466 467 Synopsis: 468 PetscErrorCode PetscMalloc2(size_t m1,type, t1,void **r1,size_t m2,type t2,void **r2) 469 470 Level: developer 471 472 Notes: Memory of first chunk is always allocated at least double aligned 473 474 .seealso: PetscFree(), PetscNew(), PetscMalloc() 475 476 Concepts: memory allocation 477 478 M*/ 479 #if defined(PETSC_USE_DEBUG) 480 #define PetscMalloc2(m1,t1,r1,m2,t2,r2) (PetscMalloc((m1)*sizeof(t1),r1) || PetscMalloc((m2)*sizeof(t2),r2)) 481 #else 482 #define PetscMalloc2(m1,t1,r1,m2,t2,r2) (PetscMalloc((m1)*sizeof(t1)+(m2)*sizeof(t2),r1) || (*(r2) = (t2*)(*(r1)+m1),0)) 483 #endif 484 485 /*MC 486 PetscMalloc3 - Allocates 3 chunks of memory 487 488 Input Parameter: 489 + m1 - number of elements to allocate in 1st chunk (may be zero) 490 . t1 - type of first memory elements 491 . m2 - number of elements to allocate in 2nd chunk (may be zero) 492 . t2 - type of second memory elements 493 . m3 - number of elements to allocate in 3rd chunk (may be zero) 494 - t3 - type of third memory elements 495 496 Output Parameter: 497 + r1 - memory allocated in first chunk 498 . r2 - memory allocated in second chunk 499 - r3 - memory allocated in third chunk 500 501 Synopsis: 502 PetscErrorCode PetscMalloc3(size_t m1,type, t1,void **r1,size_t m2,type t2,void **r2,size_t m3,type t3,void **r3) 503 504 Level: developer 505 506 Notes: Memory of first chunk is always allocated at least double aligned 507 508 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree3() 509 510 Concepts: memory allocation 511 512 M*/ 513 #if defined(PETSC_USE_DEBUG) 514 #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)) 515 #else 516 #define PetscMalloc3(m1,t1,r1,m2,t2,r2,m3,t3,r3) (PetscMalloc((m1)*sizeof(t1)+(m2)*sizeof(t2)+(m3)*sizeof(t3),r1) || (*(r2) = (t2*)(*(r1)+m1),*(r3) = (t3*)(*(r2)+m2),0)) 517 #endif 518 519 /*MC 520 PetscMalloc4 - Allocates 4 chunks of memory 521 522 Input Parameter: 523 + m1 - number of elements to allocate in 1st chunk (may be zero) 524 . t1 - type of first memory elements 525 . m2 - number of elements to allocate in 2nd chunk (may be zero) 526 . t2 - type of second memory elements 527 . m3 - number of elements to allocate in 3rd chunk (may be zero) 528 . t3 - type of third memory elements 529 . m4 - number of elements to allocate in 4th chunk (may be zero) 530 - t4 - type of fourth memory elements 531 532 Output Parameter: 533 + r1 - memory allocated in first chunk 534 . r2 - memory allocated in second chunk 535 . r3 - memory allocated in third chunk 536 - r4 - memory allocated in fourth chunk 537 538 Synopsis: 539 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) 540 541 Level: developer 542 543 Notes: Memory of first chunk is always allocated at least double aligned 544 545 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree3(), PetscFree4() 546 547 Concepts: memory allocation 548 549 M*/ 550 #if defined(PETSC_USE_DEBUG) 551 #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)) 552 #else 553 #define PetscMalloc4(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4) (PetscMalloc((m1)*sizeof(t1)+(m2)*sizeof(t2)+(m3)*sizeof(t3)+(m4)*sizeof(t4),r1) || (*(r2) = (t2*)(*(r1)+m1),*(r3) = (t3*)(*(r2)+m2),*(r4) = (t4*)(*(r3)+m3),0)) 554 #endif 555 556 /*MC 557 PetscMalloc5 - Allocates 5 chunks of memory 558 559 Input Parameter: 560 + m1 - number of elements to allocate in 1st chunk (may be zero) 561 . t1 - type of first memory elements 562 . m2 - number of elements to allocate in 2nd chunk (may be zero) 563 . t2 - type of second memory elements 564 . m3 - number of elements to allocate in 3rd chunk (may be zero) 565 . t3 - type of third memory elements 566 . m4 - number of elements to allocate in 4th chunk (may be zero) 567 . t4 - type of fourth memory elements 568 . m5 - number of elements to allocate in 5th chunk (may be zero) 569 - t5 - type of fifth memory elements 570 571 Output Parameter: 572 + r1 - memory allocated in first chunk 573 . r2 - memory allocated in second chunk 574 . r3 - memory allocated in third chunk 575 . r4 - memory allocated in fourth chunk 576 - r5 - memory allocated in fifth chunk 577 578 Synopsis: 579 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) 580 581 Level: developer 582 583 Notes: Memory of first chunk is always allocated at least double aligned 584 585 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree3(), PetscFree4(), PetscFree5() 586 587 Concepts: memory allocation 588 589 M*/ 590 #if defined(PETSC_USE_DEBUG) 591 #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)) 592 #else 593 #define PetscMalloc5(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4,m5,t5,r5) (PetscMalloc((m1)*sizeof(t1)+(m2)*sizeof(t2)+(m3)*sizeof(t3)+(m4)*sizeof(t4)+(m5)*sizeof(t5),r1) || (*(r2) = (t2*)(*(r1)+m1),*(r3) = (t3*)(*(r2)+m2),*(r4) = (t4*)(*(r3)+m3),*(r5) = (t5*)(*(r4)+m4),0)) 594 #endif 595 596 597 /*MC 598 PetscMalloc6 - Allocates 6 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 . m4 - number of elements to allocate in 4th chunk (may be zero) 608 . t4 - type of fourth memory elements 609 . m5 - number of elements to allocate in 5th chunk (may be zero) 610 . t5 - type of fifth memory elements 611 . m6 - number of elements to allocate in 6th chunk (may be zero) 612 - t6 - type of sixth memory elements 613 614 Output Parameter: 615 + r1 - memory allocated in first chunk 616 . r2 - memory allocated in second chunk 617 . r3 - memory allocated in third chunk 618 . r4 - memory allocated in fourth chunk 619 . r5 - memory allocated in fifth chunk 620 - r6 - memory allocated in sixth chunk 621 622 Synopsis: 623 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) 624 625 Level: developer 626 627 Notes: Memory of first chunk is always allocated at least double aligned 628 629 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree3(), PetscFree4(), PetscFree5(), PetscFree6() 630 631 Concepts: memory allocation 632 633 M*/ 634 #if defined(PETSC_USE_DEBUG) 635 #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)) 636 #else 637 #define PetscMalloc6(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4,m5,t5,r5,m6,t6,r6) (PetscMalloc((m1)*sizeof(t1)+(m2)*sizeof(t2)+(m3)*sizeof(t3)+(m4)*sizeof(t4)+(m5)*sizeof(t5)+(m6)*sizeof(t6),r1) || (*(r2) = (t2*)(*(r1)+m1),*(r3) = (t3*)(*(r2)+m2),*(r4) = (t4*)(*(r3)+m3),*(r5) = (t5*)(*(r4)+m4),*(r6) = (t6*)(*(r5)+m5),0)) 638 #endif 639 640 /*MC 641 PetscMalloc7 - Allocates 7 chunks of memory 642 643 Input Parameter: 644 + m1 - number of elements to allocate in 1st chunk (may be zero) 645 . t1 - type of first memory elements 646 . m2 - number of elements to allocate in 2nd chunk (may be zero) 647 . t2 - type of second memory elements 648 . m3 - number of elements to allocate in 3rd chunk (may be zero) 649 . t3 - type of third memory elements 650 . m4 - number of elements to allocate in 4th chunk (may be zero) 651 . t4 - type of fourth memory elements 652 . m5 - number of elements to allocate in 5th chunk (may be zero) 653 . t5 - type of fifth memory elements 654 . m6 - number of elements to allocate in 6th chunk (may be zero) 655 . t6 - type of sixth memory elements 656 . m7 - number of elements to allocate in 7th chunk (may be zero) 657 - t7 - type of sixth memory elements 658 659 Output Parameter: 660 + r1 - memory allocated in first chunk 661 . r2 - memory allocated in second chunk 662 . r3 - memory allocated in third chunk 663 . r4 - memory allocated in fourth chunk 664 . r5 - memory allocated in fifth chunk 665 . r6 - memory allocated in sixth chunk 666 - r7 - memory allocated in sixth chunk 667 668 Synopsis: 669 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) 670 671 Level: developer 672 673 Notes: Memory of first chunk is always allocated at least double aligned 674 675 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree3(), PetscFree4(), PetscFree5(), PetscFree6(), PetscFree7() 676 677 Concepts: memory allocation 678 679 M*/ 680 #if defined(PETSC_USE_DEBUG) 681 #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)) 682 #else 683 #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)+(m2)*sizeof(t2)+(m3)*sizeof(t3)+(m4)*sizeof(t4)+(m5)*sizeof(t5)+(m6)*sizeof(t6)+(m7)*sizeof(t7),r1) || (*(r2) = (t2*)(*(r1)+m1),*(r3) = (t3*)(*(r2)+m2),*(r4) = (t4*)(*(r3)+m3),*(r5) = (t5*)(*(r4)+m4),*(r6) = (t6*)(*(r5)+m5),*(r7) = (t7*)(*(r6)+m6),0)) 684 #endif 685 686 /*MC 687 PetscNew - Allocates memory of a particular type, Zeros the memory! 688 689 Input Parameter: 690 . type - structure name of space to be allocated. Memory of size sizeof(type) is allocated 691 692 Output Parameter: 693 . result - memory allocated 694 695 Synopsis: 696 PetscErrorCode PetscNew(struct type,((type *))result) 697 698 Level: beginner 699 700 .seealso: PetscFree(), PetscMalloc() 701 702 Concepts: memory allocation 703 704 M*/ 705 #define PetscNew(A,b) (PetscMalloc(sizeof(A),(b)) || PetscMemzero(*(b),sizeof(A))) 706 707 /*MC 708 PetscFree - Frees memory 709 710 Input Parameter: 711 . memory - memory to free 712 713 Synopsis: 714 PetscErrorCode PetscFree(void *memory) 715 716 Level: beginner 717 718 Notes: Memory must have been obtained with PetscNew() or PetscMalloc() 719 720 .seealso: PetscNew(), PetscMalloc() 721 722 Concepts: memory allocation 723 724 M*/ 725 #define PetscFree(a) ((a) ? ((*PetscTrFree)((a),__LINE__,__FUNCT__,__FILE__,__SDIR__) || ((a = 0),0)) : 0) 726 727 /*MC 728 PetscFreeVoid - Frees memory 729 730 Input Parameter: 731 . memory - memory to free 732 733 Synopsis: 734 void PetscFreeVoid(void *memory) 735 736 Level: beginner 737 738 Notes: This is different from PetscFree() in that no error code is returned 739 740 .seealso: PetscFree(), PetscNew(), PetscMalloc() 741 742 Concepts: memory allocation 743 744 M*/ 745 #define PetscFreeVoid(a) ((*PetscTrFree)((a),__LINE__,__FUNCT__,__FILE__,__SDIR__),(a) = 0) 746 747 748 /*MC 749 PetscFree2 - Frees 2 chunks of memory obtained with PetscMalloc2() 750 751 Input Parameter: 752 + memory1 - memory to free 753 - memory2 - 2nd memory to free 754 755 756 Synopsis: 757 PetscErrorCode PetscFree2(void *memory1,void *memory2) 758 759 Level: developer 760 761 Notes: Memory must have been obtained with PetscMalloc2() 762 763 .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree() 764 765 Concepts: memory allocation 766 767 M*/ 768 #if defined(PETSC_USE_DEBUG) 769 #define PetscFree2(m1,m2) (PetscFree(m2) || PetscFree(m1)) 770 #else 771 #define PetscFree2(m1,m2) (PetscFree(m1)) 772 #endif 773 774 /*MC 775 PetscFree3 - Frees 3 chunks of memory obtained with PetscMalloc3() 776 777 Input Parameter: 778 + memory1 - memory to free 779 . memory2 - 2nd memory to free 780 - memory3 - 3rd memory to free 781 782 783 Synopsis: 784 PetscErrorCode PetscFree3(void *memory1,void *memory2,void *memory3) 785 786 Level: developer 787 788 Notes: Memory must have been obtained with PetscMalloc3() 789 790 .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3() 791 792 Concepts: memory allocation 793 794 M*/ 795 #if defined(PETSC_USE_DEBUG) 796 #define PetscFree3(m1,m2,m3) (PetscFree(m3) || PetscFree(m2) || PetscFree(m1)) 797 #else 798 #define PetscFree3(m1,m2,m3) (PetscFree(m1)) 799 #endif 800 801 /*MC 802 PetscFree4 - Frees 4 chunks of memory obtained with PetscMalloc4() 803 804 Input Parameter: 805 + m1 - memory to free 806 . m2 - 2nd memory to free 807 . m3 - 3rd memory to free 808 - m4 - 4th memory to free 809 810 811 Synopsis: 812 PetscErrorCode PetscFree4(void *m1,void *m2,void *m3,void *m4) 813 814 Level: developer 815 816 Notes: Memory must have been obtained with PetscMalloc4() 817 818 .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4() 819 820 Concepts: memory allocation 821 822 M*/ 823 #if defined(PETSC_USE_DEBUG) 824 #define PetscFree4(m1,m2,m3,m4) (PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1)) 825 #else 826 #define PetscFree4(m1,m2,m3,m4) (PetscFree(m1)) 827 #endif 828 829 /*MC 830 PetscFree5 - Frees 5 chunks of memory obtained with PetscMalloc5() 831 832 Input Parameter: 833 + m1 - memory to free 834 . m2 - 2nd memory to free 835 . m3 - 3rd memory to free 836 . m4 - 4th memory to free 837 - m5 - 5th memory to free 838 839 840 Synopsis: 841 PetscErrorCode PetscFree5(void *m1,void *m2,void *m3,void *m4,void *m5) 842 843 Level: developer 844 845 Notes: Memory must have been obtained with PetscMalloc5() 846 847 .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5() 848 849 Concepts: memory allocation 850 851 M*/ 852 #if defined(PETSC_USE_DEBUG) 853 #define PetscFree5(m1,m2,m3,m4,m5) (PetscFree(m5) || PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1)) 854 #else 855 #define PetscFree5(m1,m2,m3,m4,m5) (PetscFree(m1)) 856 #endif 857 858 859 /*MC 860 PetscFree6 - Frees 6 chunks of memory obtained with PetscMalloc6() 861 862 Input Parameter: 863 + m1 - memory to free 864 . m2 - 2nd memory to free 865 . m3 - 3rd memory to free 866 . m4 - 4th memory to free 867 . m5 - 5th memory to free 868 - m6 - 6th memory to free 869 870 871 Synopsis: 872 PetscErrorCode PetscFree6(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6) 873 874 Level: developer 875 876 Notes: Memory must have been obtained with PetscMalloc6() 877 878 .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6() 879 880 Concepts: memory allocation 881 882 M*/ 883 #if defined(PETSC_USE_DEBUG) 884 #define PetscFree6(m1,m2,m3,m4,m5,m6) (PetscFree(m6) || PetscFree(m5) || PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1)) 885 #else 886 #define PetscFree6(m1,m2,m3,m4,m5,m6) (PetscFree(m1)) 887 #endif 888 889 /*MC 890 PetscFree7 - Frees 7 chunks of memory obtained with PetscMalloc7() 891 892 Input Parameter: 893 + m1 - memory to free 894 . m2 - 2nd memory to free 895 . m3 - 3rd memory to free 896 . m4 - 4th memory to free 897 . m5 - 5th memory to free 898 . m6 - 6th memory to free 899 - m7 - 7th memory to free 900 901 902 Synopsis: 903 PetscErrorCode PetscFree7(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6,void *m7) 904 905 Level: developer 906 907 Notes: Memory must have been obtained with PetscMalloc6() 908 909 .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6(), 910 PetscMalloc7() 911 912 Concepts: memory allocation 913 914 M*/ 915 #if defined(PETSC_USE_DEBUG) 916 #define PetscFree7(m1,m2,m3,m4,m5,m6,m7) (PetscFree(m7) || PetscFree(m6) || PetscFree(m5) || PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1)) 917 #else 918 #define PetscFree7(m1,m2,m3,m4,m5,m6,m7) (PetscFree(m1)) 919 #endif 920 921 EXTERN PETSC_DLLEXPORT PetscErrorCode (*PetscTrMalloc)(size_t,int,const char[],const char[],const char[],void**); 922 EXTERN PETSC_DLLEXPORT PetscErrorCode (*PetscTrFree)(void*,int,const char[],const char[],const char[]); 923 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSetMalloc(PetscErrorCode (*)(size_t,int,const char[],const char[],const char[],void**),PetscErrorCode (*)(void*,int,const char[],const char[],const char[])); 924 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscClearMalloc(void); 925 926 /* 927 Routines for tracing memory corruption/bleeding with default PETSc 928 memory allocation 929 */ 930 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMallocDump(FILE *); 931 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMallocDumpLog(FILE *); 932 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMallocGetCurrentUsage(PetscLogDouble *); 933 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMallocGetMaximumUsage(PetscLogDouble *); 934 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMallocDebug(PetscTruth); 935 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMallocValidate(int,const char[],const char[],const char[]); 936 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMallocSetDumpLog(void); 937 938 939 /* 940 Variable type where we stash PETSc object pointers in Fortran. 941 Assumes that sizeof(long) == sizeof(void*)which is true on 942 all machines that we know. 943 */ 944 #define PetscFortranAddr long 945 946 /*E 947 PetscDataType - Used for handling different basic data types. 948 949 Level: beginner 950 951 .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscDataTypeToMPIDataType(), 952 PetscDataTypeGetSize() 953 954 E*/ 955 typedef enum {PETSC_INT = 0,PETSC_DOUBLE = 1,PETSC_COMPLEX = 2, 956 PETSC_LONG = 3 ,PETSC_SHORT = 4,PETSC_FLOAT = 5, 957 PETSC_CHAR = 6,PETSC_LOGICAL = 7,PETSC_ENUM = 8,PETSC_TRUTH=9, PETSC_LONG_DOUBLE = 10} PetscDataType; 958 extern const char *PetscDataTypes[]; 959 960 #if defined(PETSC_USE_COMPLEX) 961 #define PETSC_SCALAR PETSC_COMPLEX 962 #else 963 #if defined(PETSC_USE_SINGLE) 964 #define PETSC_SCALAR PETSC_FLOAT 965 #elif defined(PETSC_USE_LONG_DOUBLE) 966 #define PETSC_SCALAR PETSC_LONG_DOUBLE 967 #elif defined(PETSC_USE_INT) 968 #define PETSC_SCALAR PETSC_INT 969 #else 970 #define PETSC_SCALAR PETSC_DOUBLE 971 #endif 972 #endif 973 #if defined(PETSC_USE_SINGLE) 974 #define PETSC_REAL PETSC_FLOAT 975 #elif defined(PETSC_USE_LONG_DOUBLE) 976 #define PETSC_REAL PETSC_LONG_DOUBLE 977 #elif defined(PETSC_USE_INT) 978 #define PETSC_REAL PETSC_INT 979 #else 980 #define PETSC_REAL PETSC_DOUBLE 981 #endif 982 #define PETSC_FORTRANADDR PETSC_LONG 983 984 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDataTypeToMPIDataType(PetscDataType,MPI_Datatype*); 985 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDataTypeGetSize(PetscDataType,PetscInt*); 986 987 /* 988 Basic memory and string operations. These are usually simple wrappers 989 around the basic Unix system calls, but a few of them have additional 990 functionality and/or error checking. 991 */ 992 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMemcpy(void*,const void *,size_t); 993 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscBitMemcpy(void*,PetscInt,const void*,PetscInt,PetscInt,PetscDataType); 994 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMemmove(void*,void *,size_t); 995 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMemzero(void*,size_t); 996 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMemcmp(const void*,const void*,size_t,PetscTruth *); 997 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrlen(const char[],size_t*); 998 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrcmp(const char[],const char[],PetscTruth *); 999 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrgrt(const char[],const char[],PetscTruth *); 1000 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrcasecmp(const char[],const char[],PetscTruth*); 1001 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrncmp(const char[],const char[],size_t,PetscTruth*); 1002 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrcpy(char[],const char[]); 1003 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrcat(char[],const char[]); 1004 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrncat(char[],const char[],size_t); 1005 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrncpy(char[],const char[],size_t); 1006 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrchr(const char[],char,char *[]); 1007 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrtolower(char[]); 1008 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrrchr(const char[],char,char *[]); 1009 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrstr(const char[],const char[],char *[]); 1010 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrrstr(const char[],const char[],char *[]); 1011 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrallocpy(const char[],char *[]); 1012 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrreplace(MPI_Comm,const char[],char[],size_t); 1013 #define PetscStrfree(a) ((a) ? PetscFree(a) : 0) 1014 /*S 1015 PetscToken - 'Token' used for managing tokenizing strings 1016 1017 Level: intermediate 1018 1019 .seealso: PetscTokenCreate(), PetscTokenFind(), PetscTokenDestroy() 1020 S*/ 1021 typedef struct {char token;char *array;char *current;} PetscToken; 1022 1023 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscTokenCreate(const char[],const char,PetscToken**); 1024 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscTokenFind(PetscToken*,char *[]); 1025 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscTokenDestroy(PetscToken*); 1026 1027 /* 1028 These are MPI operations for MPI_Allreduce() etc 1029 */ 1030 EXTERN PETSC_DLLEXPORT MPI_Op PetscMaxSum_Op; 1031 #if defined(PETSC_USE_COMPLEX) 1032 EXTERN PETSC_DLLEXPORT MPI_Op PetscSum_Op; 1033 #else 1034 #define PetscSum_Op MPI_SUM 1035 #endif 1036 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMaxSum(MPI_Comm,const PetscInt[],PetscInt*,PetscInt*); 1037 1038 /*S 1039 PetscObject - any PETSc object, PetscViewer, Mat, Vec, KSP etc 1040 1041 Level: beginner 1042 1043 Note: This is the base class from which all objects appear. 1044 1045 .seealso: PetscObjectDestroy(), PetscObjectView(), PetscObjectGetName(), PetscObjectSetName() 1046 S*/ 1047 typedef struct _p_PetscObject* PetscObject; 1048 1049 /*S 1050 PetscFList - Linked list of functions, possibly stored in dynamic libraries, accessed 1051 by string name 1052 1053 Level: advanced 1054 1055 .seealso: PetscFListAdd(), PetscFListDestroy() 1056 S*/ 1057 typedef struct _n_PetscFList *PetscFList; 1058 1059 /*E 1060 PetscFileMode - Access mode for a file. 1061 1062 Level: beginner 1063 1064 FILE_MODE_READ - open a file at its beginning for reading 1065 1066 FILE_MODE_WRITE - open a file at its beginning for writing (will create if the file does not exist) 1067 1068 FILE_MODE_APPEND - open a file at end for writing 1069 1070 FILE_MODE_UPDATE - open a file for updating, meaning for reading and writing 1071 1072 FILE_MODE_APPEND_UPDATE - open a file for updating, meaning for reading and writing, at the end 1073 1074 .seealso: PetscViewerFileSetMode() 1075 E*/ 1076 typedef enum {FILE_MODE_READ, FILE_MODE_WRITE, FILE_MODE_APPEND, FILE_MODE_UPDATE, FILE_MODE_APPEND_UPDATE} PetscFileMode; 1077 1078 #include "petscviewer.h" 1079 #include "petscoptions.h" 1080 1081 #define PETSC_COOKIE 1211211 1082 extern PETSC_DLLEXPORT PetscCookie PETSC_LARGEST_COOKIE; 1083 extern PETSC_DLLEXPORT PetscCookie PETSC_OBJECT_COOKIE; 1084 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscCookieRegister(PetscCookie *); 1085 1086 /* 1087 Routines that get memory usage information from the OS 1088 */ 1089 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMemoryGetCurrentUsage(PetscLogDouble *); 1090 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMemoryGetMaximumUsage(PetscLogDouble *); 1091 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMemorySetGetMaximumUsage(void); 1092 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMemoryShowUsage(PetscViewer,const char[]); 1093 1094 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscVerboseInfoAllow(PetscTruth,const char []); 1095 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscGetTime(PetscLogDouble*); 1096 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscGetCPUTime(PetscLogDouble*); 1097 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSleep(int); 1098 1099 /* 1100 Initialization of PETSc 1101 */ 1102 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscInitialize(int*,char***,const char[],const char[]); 1103 PetscPolymorphicSubroutine(PetscInitialize,(int *argc,char ***args),(argc,args,PETSC_NULL,PETSC_NULL)) 1104 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscInitializeNoArguments(void); 1105 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscInitialized(PetscTruth *); 1106 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFinalized(PetscTruth *); 1107 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFinalize(void); 1108 EXTERN PetscErrorCode PetscInitializeFortran(void); 1109 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscGetArgs(int*,char ***); 1110 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscEnd(void); 1111 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscInitializePackage(char *); 1112 1113 /* 1114 These are so that in extern C code we can caste function pointers to non-extern C 1115 function pointers. Since the regular C++ code expects its function pointers to be 1116 C++. 1117 */ 1118 typedef void (**PetscVoidStarFunction)(void); 1119 typedef void (*PetscVoidFunction)(void); 1120 typedef PetscErrorCode (*PetscErrorCodeFunction)(void); 1121 1122 /* 1123 PetscTryMethod - Queries an object for a method, if it exists then calls it. 1124 These are intended to be used only inside PETSc functions. 1125 */ 1126 #define PetscTryMethod(obj,A,B,C) \ 1127 0;{ PetscErrorCode (*f)B, __ierr; \ 1128 __ierr = PetscObjectQueryFunction((PetscObject)obj,#A,(PetscVoidStarFunction)&f);CHKERRQ(__ierr); \ 1129 if (f) {__ierr = (*f)C;CHKERRQ(__ierr);}\ 1130 } 1131 #define PetscUseMethod(obj,A,B,C) \ 1132 0;{ PetscErrorCode (*f)B, __ierr; \ 1133 __ierr = PetscObjectQueryFunction((PetscObject)obj,A,(PetscVoidStarFunction)&f);CHKERRQ(__ierr); \ 1134 if (f) {__ierr = (*f)C;CHKERRQ(__ierr);}\ 1135 else {SETERRQ1(PETSC_ERR_SUP,"Cannot locate function %s in object",A);} \ 1136 } 1137 /* 1138 Functions that can act on any PETSc object. 1139 */ 1140 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectCreate(MPI_Comm,PetscObject*); 1141 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectDestroy(PetscObject); 1142 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectExists(PetscObject,PetscTruth*); 1143 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectGetComm(PetscObject,MPI_Comm *); 1144 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectGetCookie(PetscObject,int *); 1145 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectSetType(PetscObject,const char []); 1146 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectGetType(PetscObject,const char *[]); 1147 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectSetName(PetscObject,const char[]); 1148 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectGetName(PetscObject,const char*[]); 1149 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectReference(PetscObject); 1150 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectGetReference(PetscObject,PetscInt*); 1151 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectDereference(PetscObject); 1152 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectGetNewTag(PetscObject,PetscMPIInt *); 1153 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscCommGetNewTag(MPI_Comm,PetscMPIInt *); 1154 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectView(PetscObject,PetscViewer); 1155 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectCompose(PetscObject,const char[],PetscObject); 1156 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectQuery(PetscObject,const char[],PetscObject *); 1157 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectComposeFunction(PetscObject,const char[],const char[],void (*)(void)); 1158 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectSetFromOptions(PetscObject); 1159 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectSetUp(PetscObject); 1160 1161 /*MC 1162 PetscObjectComposeFunctionDynamic - Associates a function with a given PETSc object. 1163 1164 Collective on PetscObject 1165 1166 Input Parameters: 1167 + obj - the PETSc object; this must be cast with a (PetscObject), for example, 1168 PetscObjectCompose((PetscObject)mat,...); 1169 . name - name associated with the child function 1170 . fname - name of the function 1171 - ptr - function pointer (or PETSC_NULL if using dynamic libraries) 1172 1173 Level: advanced 1174 1175 Synopsis: 1176 PetscErrorCode PetscObjectComposeFunctionDynamic(PetscObject obj,const char name[],const char fname[],void *ptr) 1177 1178 Notes: 1179 To remove a registered routine, pass in a PETSC_NULL rname and fnc(). 1180 1181 PetscObjectComposeFunctionDynamic() can be used with any PETSc object (such as 1182 Mat, Vec, KSP, SNES, etc.) or any user-provided object. 1183 1184 The composed function must be wrapped in a EXTERN_C_BEGIN/END for this to 1185 work in C++/complex with dynamic link libraries (PETSC_USE_DYNAMIC_LIBRARIES) 1186 enabled. 1187 1188 Concepts: objects^composing functions 1189 Concepts: composing functions 1190 Concepts: functions^querying 1191 Concepts: objects^querying 1192 Concepts: querying objects 1193 1194 .seealso: PetscObjectQueryFunction() 1195 M*/ 1196 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 1197 #define PetscObjectComposeFunctionDynamic(a,b,c,d) PetscObjectComposeFunction(a,b,c,0) 1198 #else 1199 #define PetscObjectComposeFunctionDynamic(a,b,c,d) PetscObjectComposeFunction(a,b,c,(PetscVoidFunction)(d)) 1200 #endif 1201 1202 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectQueryFunction(PetscObject,const char[],void (**)(void)); 1203 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectSetOptionsPrefix(PetscObject,const char[]); 1204 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectAppendOptionsPrefix(PetscObject,const char[]); 1205 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectPrependOptionsPrefix(PetscObject,const char[]); 1206 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectGetOptionsPrefix(PetscObject,const char*[]); 1207 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectPublish(PetscObject); 1208 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectChangeTypeName(PetscObject,const char[]); 1209 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectRegisterDestroy(PetscObject); 1210 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectRegisterDestroyAll(void); 1211 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectName(PetscObject); 1212 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscTypeCompare(PetscObject,const char[],PetscTruth*); 1213 1214 /* 1215 Defines PETSc error handling. 1216 */ 1217 #include "petscerror.h" 1218 1219 /*S 1220 PetscOList - Linked list of PETSc objects, accessable by string name 1221 1222 Level: advanced 1223 1224 .seealso: PetscOListAdd(), PetscOListDestroy(), PetscOListFind() 1225 S*/ 1226 typedef struct _n_PetscOList *PetscOList; 1227 1228 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOListDestroy(PetscOList *); 1229 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOListFind(PetscOList,const char[],PetscObject*); 1230 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOListReverseFind(PetscOList,PetscObject,char**); 1231 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOListAdd(PetscOList *,const char[],PetscObject); 1232 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOListDuplicate(PetscOList,PetscOList *); 1233 1234 /* 1235 Dynamic library lists. Lists of names of routines in dynamic 1236 link libraries that will be loaded as needed. 1237 */ 1238 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFListAdd(PetscFList*,const char[],const char[],void (*)(void)); 1239 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFListDestroy(PetscFList*); 1240 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFListFind(MPI_Comm,PetscFList,const char[],void (**)(void)); 1241 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFListPrintTypes(MPI_Comm,FILE*,const char[],const char[],const char[],const char[],PetscFList); 1242 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 1243 #define PetscFListAddDynamic(a,b,p,c) PetscFListAdd(a,b,p,0) 1244 #else 1245 #define PetscFListAddDynamic(a,b,p,c) PetscFListAdd(a,b,p,(void (*)(void))c) 1246 #endif 1247 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFListDuplicate(PetscFList,PetscFList *); 1248 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFListView(PetscFList,PetscViewer); 1249 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFListConcat(const char [],const char [],char []); 1250 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFListGet(PetscFList,char ***,int*); 1251 1252 /*S 1253 PetscDLLibraryList - Linked list of dynamics libraries to search for functions 1254 1255 Level: advanced 1256 1257 PETSC_USE_DYNAMIC_LIBRARIES must be defined in petscconf.h to use dynamic libraries 1258 1259 .seealso: PetscDLLibraryOpen() 1260 S*/ 1261 typedef struct _n_PetscDLLibraryList *PetscDLLibraryList; 1262 extern PetscDLLibraryList DLLibrariesLoaded; 1263 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryRetrieve(MPI_Comm,const char[],char *,int,PetscTruth *); 1264 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryOpen(MPI_Comm,const char[],void **); 1265 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDLLibrarySym(MPI_Comm,PetscDLLibraryList *,const char[],const char[],void **); 1266 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryAppend(MPI_Comm,PetscDLLibraryList *,const char[]); 1267 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryPrepend(MPI_Comm,PetscDLLibraryList *,const char[]); 1268 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryClose(PetscDLLibraryList); 1269 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryPrintPath(void); 1270 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryGetInfo(void*,const char[],const char *[]); 1271 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryCCAAppend(MPI_Comm,PetscDLLibraryList *,const char[]); 1272 1273 /* 1274 Mechanism for translating PETSc object representations between languages 1275 Not currently used. 1276 */ 1277 typedef enum {PETSC_LANGUAGE_C,PETSC_LANGUAGE_CXX} PetscLanguage; 1278 #define PETSC_LANGUAGE_F77 PETSC_LANGUAGE_C 1279 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectComposeLanguage(PetscObject,PetscLanguage,void *); 1280 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectQueryLanguage(PetscObject,PetscLanguage,void **); 1281 1282 /* 1283 Useful utility routines 1284 */ 1285 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSplitOwnership(MPI_Comm,PetscInt*,PetscInt*); 1286 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSplitOwnershipBlock(MPI_Comm,PetscInt,PetscInt*,PetscInt*); 1287 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSequentialPhaseBegin(MPI_Comm,PetscMPIInt); 1288 PetscPolymorphicSubroutine(PetscSequentialPhaseBegin,(MPI_Comm comm),(comm,1)) 1289 PetscPolymorphicSubroutine(PetscSequentialPhaseBegin,(void),(PETSC_COMM_WORLD,1)) 1290 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSequentialPhaseEnd(MPI_Comm,PetscMPIInt); 1291 PetscPolymorphicSubroutine(PetscSequentialPhaseEnd,(MPI_Comm comm),(comm,1)) 1292 PetscPolymorphicSubroutine(PetscSequentialPhaseEnd,(void),(PETSC_COMM_WORLD,1)) 1293 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscBarrier(PetscObject); 1294 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMPIDump(FILE*); 1295 1296 #define PetscNot(a) ((a) ? PETSC_FALSE : PETSC_TRUE) 1297 /* 1298 Defines basic graphics available from PETSc. 1299 */ 1300 #include "petscdraw.h" 1301 1302 /* 1303 Defines the base data structures for all PETSc objects 1304 */ 1305 PETSC_EXTERN_CXX_END 1306 #include "private/petscimpl.h" 1307 PETSC_EXTERN_CXX_BEGIN 1308 /* 1309 Defines PETSc profiling. 1310 */ 1311 #include "petsclog.h" 1312 1313 /* 1314 For locking, unlocking and destroying AMS memories associated with 1315 PETSc objects. Not currently used. 1316 */ 1317 #define PetscPublishAll(v) 0 1318 #define PetscObjectTakeAccess(obj) 0 1319 #define PetscObjectGrantAccess(obj) 0 1320 #define PetscObjectDepublish(obj) 0 1321 1322 1323 1324 /* 1325 This code allows one to pass a MPI communicator between 1326 C and Fortran. MPI 2.0 defines a standard API for doing this. 1327 The code here is provided to allow PETSc to work with MPI 1.1 1328 standard MPI libraries. 1329 */ 1330 EXTERN PetscErrorCode MPICCommToFortranComm(MPI_Comm,int *); 1331 EXTERN PetscErrorCode MPIFortranCommToCComm(int,MPI_Comm*); 1332 1333 /* 1334 Simple PETSc parallel IO for ASCII printing 1335 */ 1336 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFixFilename(const char[],char[]); 1337 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFOpen(MPI_Comm,const char[],const char[],FILE**); 1338 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFClose(MPI_Comm,FILE*); 1339 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFPrintf(MPI_Comm,FILE*,const char[],...) PETSC_PRINTF_FORMAT_CHECK(3,4); 1340 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscPrintf(MPI_Comm,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3); 1341 1342 /* These are used internally by PETSc ASCII IO routines*/ 1343 #include <stdarg.h> 1344 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscVSNPrintf(char*,size_t,const char*,va_list); 1345 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscVFPrintf(FILE*,const char*,va_list); 1346 1347 /*MC 1348 PetscErrorPrintf - Prints error messages. 1349 1350 Not Collective 1351 1352 Synopsis: 1353 PetscErrorCode (*PetscErrorPrintf)(const char format[],...); 1354 1355 Input Parameters: 1356 . format - the usual printf() format string 1357 1358 Options Database Keys: 1359 . -error_output_stderr - cause error messages to be printed to stderr instead of the 1360 (default) stdout 1361 1362 1363 Level: developer 1364 1365 Fortran Note: 1366 This routine is not supported in Fortran. 1367 1368 Concepts: error messages^printing 1369 Concepts: printing^error messages 1370 1371 .seealso: PetscFPrintf(), PetscSynchronizedPrintf(), PetscHelpPrintf() 1372 M*/ 1373 EXTERN PETSC_DLLEXPORT PetscErrorCode (*PetscErrorPrintf)(const char[],...); 1374 1375 /*MC 1376 PetscHelpPrintf - Prints help messages. 1377 1378 Not Collective 1379 1380 Synopsis: 1381 PetscErrorCode (*PetscHelpPrintf)(const char format[],...); 1382 1383 Input Parameters: 1384 . format - the usual printf() format string 1385 1386 Level: developer 1387 1388 Fortran Note: 1389 This routine is not supported in Fortran. 1390 1391 Concepts: help messages^printing 1392 Concepts: printing^help messages 1393 1394 .seealso: PetscFPrintf(), PetscSynchronizedPrintf(), PetscErrorPrintf() 1395 M*/ 1396 EXTERN PETSC_DLLEXPORT PetscErrorCode (*PetscHelpPrintf)(MPI_Comm,const char[],...); 1397 1398 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscPOpen(MPI_Comm,const char[],const char[],const char[],FILE **); 1399 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscPClose(MPI_Comm,FILE*); 1400 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSynchronizedPrintf(MPI_Comm,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3); 1401 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSynchronizedFPrintf(MPI_Comm,FILE*,const char[],...) PETSC_PRINTF_FORMAT_CHECK(3,4); 1402 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSynchronizedFlush(MPI_Comm); 1403 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSynchronizedFGets(MPI_Comm,FILE*,size_t,char[]); 1404 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStartMatlab(MPI_Comm,const char[],const char[],FILE**); 1405 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStartJava(MPI_Comm,const char[],const char[],FILE**); 1406 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscGetPetscDir(const char*[]); 1407 1408 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscPopUpSelect(MPI_Comm,char*,char*,int,char**,int*); 1409 /*S 1410 PetscObjectContainer - Simple PETSc object that contains a pointer to any required data 1411 1412 Level: advanced 1413 1414 .seealso: PetscObject, PetscObjectContainerCreate() 1415 S*/ 1416 typedef struct _p_PetscObjectContainer* PetscObjectContainer; 1417 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectContainerGetPointer(PetscObjectContainer,void **); 1418 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectContainerSetPointer(PetscObjectContainer,void *); 1419 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectContainerDestroy(PetscObjectContainer); 1420 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectContainerCreate(MPI_Comm comm,PetscObjectContainer *); 1421 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectContainerSetUserDestroy(PetscObjectContainer, PetscErrorCode (*)(void*)); 1422 1423 /* 1424 For use in debuggers 1425 */ 1426 extern PETSC_DLLEXPORT PetscMPIInt PetscGlobalRank; 1427 extern PETSC_DLLEXPORT PetscMPIInt PetscGlobalSize; 1428 1429 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscIntView(PetscInt,PetscInt[],PetscViewer); 1430 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscRealView(PetscInt,PetscReal[],PetscViewer); 1431 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscScalarView(PetscInt,PetscScalar[],PetscViewer); 1432 1433 /* 1434 Allows accessing Matlab Engine 1435 */ 1436 #include "petscmatlab.h" 1437 1438 /* 1439 Determine if some of the kernel computation routines use 1440 Fortran (rather than C) for the numerical calculations. On some machines 1441 and compilers (like complex numbers) the Fortran version of the routines 1442 is faster than the C/C++ versions. The flag PETSC_USE_FORTRAN_KERNELS 1443 would be set in the petscconf.h file 1444 */ 1445 #if defined(PETSC_USE_FORTRAN_KERNELS) 1446 1447 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTCRL) 1448 #define PETSC_USE_FORTRAN_KERNEL_MULTCRL 1449 #endif 1450 1451 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTCSRPERM) 1452 #define PETSC_USE_FORTRAN_KERNEL_MULTCSRPERM 1453 #endif 1454 1455 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJ) 1456 #define PETSC_USE_FORTRAN_KERNEL_MULTAIJ 1457 #endif 1458 1459 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ) 1460 #define PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ 1461 #endif 1462 1463 #if !defined(PETSC_USE_FORTRAN_KERNEL_NORM) 1464 #define PETSC_USE_FORTRAN_KERNEL_NORM 1465 #endif 1466 1467 #if !defined(PETSC_USE_FORTRAN_KERNEL_MAXPY) 1468 #define PETSC_USE_FORTRAN_KERNEL_MAXPY 1469 #endif 1470 1471 #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ) 1472 #define PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ 1473 #endif 1474 1475 #if !defined(PETSC_USE_FORTRAN_KERNEL_RELAXAIJ) 1476 #define PETSC_USE_FORTRAN_KERNEL_RELAXAIJ 1477 #endif 1478 1479 #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ) 1480 #define PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ 1481 #endif 1482 1483 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ) 1484 #define PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ 1485 #endif 1486 1487 #if !defined(PETSC_USE_FORTRAN_KERNEL_MDOT) 1488 #define PETSC_USE_FORTRAN_KERNEL_MDOT 1489 #endif 1490 1491 #if !defined(PETSC_USE_FORTRAN_KERNEL_XTIMESY) 1492 #define PETSC_USE_FORTRAN_KERNEL_XTIMESY 1493 #endif 1494 1495 #if !defined(PETSC_USE_FORTRAN_KERNEL_AYPX) 1496 #define PETSC_USE_FORTRAN_KERNEL_AYPX 1497 #endif 1498 1499 #if !defined(PETSC_USE_FORTRAN_KERNEL_WAXPY) 1500 #define PETSC_USE_FORTRAN_KERNEL_WAXPY 1501 #endif 1502 1503 #endif 1504 1505 /* 1506 Macros for indicating code that should be compiled with a C interface, 1507 rather than a C++ interface. Any routines that are dynamically loaded 1508 (such as the PCCreate_XXX() routines) must be wrapped so that the name 1509 mangler does not change the functions symbol name. This just hides the 1510 ugly extern "C" {} wrappers. 1511 */ 1512 #if defined(__cplusplus) 1513 #define EXTERN_C_BEGIN extern "C" { 1514 #define EXTERN_C_END } 1515 #else 1516 #define EXTERN_C_BEGIN 1517 #define EXTERN_C_END 1518 #endif 1519 1520 /* --------------------------------------------------------------------*/ 1521 1522 /*MC 1523 size - integer variable used to contain the number of processors in 1524 the relevent MPI_Comm 1525 1526 Level: beginner 1527 1528 .seealso: rank, comm 1529 M*/ 1530 1531 /*MC 1532 rank - integer variable used to contain the number of this processor relative 1533 to all in the relevent MPI_Comm 1534 1535 Level: beginner 1536 1537 .seealso: size, comm 1538 M*/ 1539 1540 /*MC 1541 comm - MPI_Comm used in the current routine or object 1542 1543 Level: beginner 1544 1545 .seealso: size, rank 1546 M*/ 1547 1548 /*MC 1549 MPI_Comm - the basic object used by MPI to determine which processes are involved in a 1550 communication 1551 1552 Level: beginner 1553 1554 Note: This manual page is a place-holder because MPICH does not have a manual page for MPI_Comm 1555 1556 .seealso: size, rank, comm, PETSC_COMM_WORLD, PETSC_COMM_SELF 1557 M*/ 1558 1559 /*MC 1560 PetscScalar - PETSc type that represents either a double precision real number or 1561 a double precision complex number if the code is configured with --with-scalar-type=complex 1562 1563 Level: beginner 1564 1565 .seealso: PetscReal, PassiveReal, PassiveScalar 1566 M*/ 1567 1568 /*MC 1569 PetscReal - PETSc type that represents a double precision real number 1570 1571 Level: beginner 1572 1573 .seealso: PetscScalar, PassiveReal, PassiveScalar 1574 M*/ 1575 1576 /*MC 1577 PassiveScalar - PETSc type that represents either a double precision real number or 1578 a double precision complex number if the code is code is configured with --with-scalar-type=complex 1579 1580 Level: beginner 1581 1582 This is the same as a PetscScalar except in code that is automatically differentiated it is 1583 treated as a constant (not an indendent or dependent variable) 1584 1585 .seealso: PetscReal, PassiveReal, PetscScalar 1586 M*/ 1587 1588 /*MC 1589 PassiveReal - PETSc type that represents a double precision real number 1590 1591 Level: beginner 1592 1593 This is the same as a PetscReal except in code that is automatically differentiated it is 1594 treated as a constant (not an indendent or dependent variable) 1595 1596 .seealso: PetscScalar, PetscReal, PassiveScalar 1597 M*/ 1598 1599 /*MC 1600 MPIU_SCALAR - MPI datatype corresponding to PetscScalar 1601 1602 Level: beginner 1603 1604 Note: In MPI calls that require an MPI datatype that matches a PetscScalar or array of PetscScalars 1605 pass this value 1606 1607 .seealso: PetscReal, PassiveReal, PassiveScalar, PetscScalar 1608 M*/ 1609 1610 /* 1611 The IBM include files define hz, here we hide it so that it may be used 1612 as a regular user variable. 1613 */ 1614 #if defined(hz) 1615 #undef hz 1616 #endif 1617 1618 /* For arrays that contain filenames or paths */ 1619 1620 1621 #if defined(PETSC_HAVE_LIMITS_H) 1622 #include <limits.h> 1623 #endif 1624 #if defined(PETSC_HAVE_SYS_PARAM_H) 1625 #include <sys/param.h> 1626 #endif 1627 #if defined(PETSC_HAVE_SYS_TYPES_H) 1628 #include <sys/types.h> 1629 #endif 1630 #if defined(MAXPATHLEN) 1631 # define PETSC_MAX_PATH_LEN MAXPATHLEN 1632 #elif defined(MAX_PATH) 1633 # define PETSC_MAX_PATH_LEN MAX_PATH 1634 #elif defined(_MAX_PATH) 1635 # define PETSC_MAX_PATH_LEN _MAX_PATH 1636 #else 1637 # define PETSC_MAX_PATH_LEN 4096 1638 #endif 1639 1640 PETSC_EXTERN_CXX_END 1641 #endif 1642 1643 1644