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