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