Actual source code: petscsys.h

petsc-3.4.4 2014-03-13
  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: */
  7: /* ========================================================================== */
  8: /*
  9:    petscconf.h is contained in ${PETSC_ARCH}/include/petscconf.h it is
 10:    found automatically by the compiler due to the -I${PETSC_DIR}/${PETSC_ARCH}/include
 11:    in the conf/variables definition of PETSC_INCLUDE. For --prefix installs the ${PETSC_ARCH}/
 12:    does not exist and petscconf.h is in the same directory as the other PETSc include files.
 13: */
 14: #include <petscconf.h>
 15: #include <petscfix.h>

 17: #if defined(PETSC_DESIRE_FEATURE_TEST_MACROS)
 18: /*
 19:    Feature test macros must be included before headers defined by IEEE Std 1003.1-2001
 20:    We only turn these in PETSc source files that require them by setting PETSC_DESIRE_FEATURE_TEST_MACROS
 21: */
 22: #if defined(PETSC__POSIX_C_SOURCE_200112L) && !defined(_POSIX_C_SOURCE)
 23: #define _POSIX_C_SOURCE 200112L
 24: #endif
 25: #if defined(PETSC__BSD_SOURCE) && !defined(_BSD_SOURCE)
 26: #define _BSD_SOURCE
 27: #endif
 28: #if defined(PETSC__GNU_SOURCE) && !defined(_GNU_SOURCE)
 29: #define _GNU_SOURCE
 30: #endif
 31: #endif

 33: /* ========================================================================== */
 34: /*
 35:    This facilitates using the C version of PETSc from C++ and the C++ version from C.
 36: */
 37: #if defined(__cplusplus)
 38: #  define PETSC_FUNCTION_NAME PETSC_FUNCTION_NAME_CXX
 39: #else
 40: #  define PETSC_FUNCTION_NAME PETSC_FUNCTION_NAME_C
 41: #endif

 43: #if defined(__cplusplus)
 44: #  define PETSC_RESTRICT PETSC_CXX_RESTRICT
 45: #else
 46: #  define PETSC_RESTRICT PETSC_C_RESTRICT
 47: #endif

 49: #if defined(__cplusplus)
 50: #  define PETSC_STATIC_INLINE PETSC_CXX_STATIC_INLINE
 51: #else
 52: #  define PETSC_STATIC_INLINE PETSC_C_STATIC_INLINE
 53: #endif

 55: #if defined(_WIN32) && defined(PETSC_USE_SHARED_LIBRARIES) /* For Win32 shared libraries */
 56: #  define  __declspec(dllexport)
 57: #  define PETSC_DLLIMPORT __declspec(dllimport)
 58: #  define PETSC_VISIBILITY_INTERNAL
 59: #elif defined(PETSC_USE_VISIBILITY)
 60: #  define  __attribute__((visibility ("default")))
 61: #  define PETSC_DLLIMPORT __attribute__((visibility ("default")))
 62: #  define PETSC_VISIBILITY_INTERNAL __attribute__((visibility ("hidden")))
 63: #else
 64: #  define 
 65: #  define PETSC_DLLIMPORT
 66: #  define PETSC_VISIBILITY_INTERNAL
 67: #endif

 69: #if defined(petsc_EXPORTS)      /* CMake defines this when building the shared library */
 70: #  define PETSC_VISIBILITY_PUBLIC 
 71: #else  /* Win32 users need this to import symbols from petsc.dll */
 72: #  define PETSC_VISIBILITY_PUBLIC PETSC_DLLIMPORT
 73: #endif

 75: #if defined(__cplusplus)
 76: #define PETSC_EXTERN extern "C" PETSC_VISIBILITY_PUBLIC
 77: #define PETSC_EXTERN_TYPEDEF extern "C"
 78: #define PETSC_INTERN extern "C" PETSC_VISIBILITY_INTERNAL
 79: #else
 80: #define PETSC_EXTERN extern PETSC_VISIBILITY_PUBLIC
 81: #define PETSC_EXTERN_TYPEDEF
 82: #define PETSC_INTERN extern PETSC_VISIBILITY_INTERNAL
 83: #endif

 85: #include <petscversion.h>
 86: #define PETSC_AUTHOR_INFO  "       The PETSc Team\n    petsc-maint@mcs.anl.gov\n http://www.mcs.anl.gov/petsc/\n"

 88: /* ========================================================================== */

 90: /*
 91:     Defines the interface to MPI allowing the use of all MPI functions.

 93:     PETSc does not use the C++ binding of MPI at ALL. The following flag
 94:     makes sure the C++ bindings are not included. The C++ bindings REQUIRE
 95:     putting mpi.h before ANY C++ include files, we cannot control this
 96:     with all PETSc users. Users who want to use the MPI C++ bindings can include
 97:     mpicxx.h directly in their code
 98: */
 99: #if !defined(MPICH_SKIP_MPICXX)
100: #  define MPICH_SKIP_MPICXX 1
101: #endif
102: #if !defined(OMPI_SKIP_MPICXX)
103: #  define OMPI_SKIP_MPICXX 1
104: #endif
105: #include <mpi.h>

107: /*
108:     Need to put stdio.h AFTER mpi.h for MPICH2 with C++ compiler
109:     see the top of mpicxx.h in the MPICH2 distribution.
110: */
111: #include <stdio.h>

113: /* MSMPI on 32bit windows requires this yukky hack - that breaks MPI standard compliance */
114: #if !defined(MPIAPI)
115: #define MPIAPI
116: #endif

118: /* Support for Clang (>=3.2) matching type tag arguments with void* buffer types */
119: #if defined(__has_attribute)
120: #  if __has_attribute(argument_with_type_tag) && __has_attribute(pointer_with_type_tag) && __has_attribute(type_tag_for_datatype)
121: #    define PetscAttrMPIPointerWithType(bufno,typeno) __attribute__((pointer_with_type_tag(MPI,bufno,typeno)))
122: #    define PetscAttrMPITypeTag(type)                 __attribute__((type_tag_for_datatype(MPI,type)))
123: #    define PetscAttrMPITypeTagLayoutCompatible(type) __attribute__((type_tag_for_datatype(MPI,type,layout_compatible)))
124: #  endif
125: #endif
126: #if !defined(PetscAttrMPIPointerWithType)
127: #  define PetscAttrMPIPointerWithType(bufno,typeno)
128: #  define PetscAttrMPITypeTag(type)
129: #  define PetscAttrMPITypeTagLayoutCompatible(type)
130: #endif

132: /*MC
133:     PetscErrorCode - datatype used for return error code from all PETSc functions

135:     Level: beginner

137: .seealso: CHKERRQ, SETERRQ
138: M*/
139: typedef int PetscErrorCode;

141: /*MC

143:     PetscClassId - A unique id used to identify each PETSc class.
144:          (internal integer in the data structure used for error
145:          checking). These are all computed by an offset from the lowest
146:          one, PETSC_SMALLEST_CLASSID.

148:     Level: advanced

150: .seealso: PetscClassIdRegister(), PetscLogEventRegister(), PetscHeaderCreate()
151: M*/
152: typedef int PetscClassId;


155: /*MC
156:     PetscMPIInt - datatype used to represent 'int' parameters to MPI functions.

158:     Level: intermediate

160:     Notes: usually this is the same as PetscInt, but if PETSc was built with --with-64-bit-indices but
161:            standard C/Fortran integers are 32 bit then this is NOT the same as PetscInt it remains 32 bit

163:     PetscMPIIntCast(a,&b) checks if the given PetscInt a will fit in a PetscMPIInt, if not it
164:       generates a PETSC_ERR_ARG_OUTOFRANGE error.

166: .seealso: PetscBLASInt, PetscInt

168: M*/
169: typedef int PetscMPIInt;

171: /*MC
172:     PetscEnum - datatype used to pass enum types within PETSc functions.

174:     Level: intermediate

176: .seealso: PetscOptionsGetEnum(), PetscOptionsEnum(), PetscBagRegisterEnum()
177: M*/
178: typedef enum { ENUM_DUMMY } PetscEnum;
179: PETSC_EXTERN MPI_Datatype MPIU_ENUM PetscAttrMPITypeTag(PetscEnum);

181: /*MC
182:     PetscInt - PETSc type that represents integer - used primarily to
183:       represent size of arrays and indexing into arrays. Its size can be configured with the option
184:       --with-64-bit-indices - to be either 32bit or 64bit [default 32 bit ints]

186:    Level: intermediate

188: .seealso: PetscScalar, PetscBLASInt, PetscMPIInt
189: M*/
190: #if (PETSC_SIZEOF_LONG_LONG == 8)
191: typedef long long Petsc64bitInt;
192: #elif defined(PETSC_HAVE___INT64)
193: typedef __int64 Petsc64bitInt;
194: #else
195: typedef unknown64bit Petsc64bitInt
196: #endif
197: #if defined(PETSC_USE_64BIT_INDICES)
198: typedef Petsc64bitInt PetscInt;
199: #define MPIU_INT MPI_LONG_LONG_INT
200: #else
201: typedef int PetscInt;
202: #define MPIU_INT MPI_INT
203: #endif


206: /*MC
207:     PetscBLASInt - datatype used to represent 'int' parameters to BLAS/LAPACK functions.

209:     Level: intermediate

211:     Notes: usually this is the same as PetscInt, but if PETSc was built with --with-64-bit-indices but
212:            standard C/Fortran integers are 32 bit then this is NOT the same as PetscInt it remains 32 bit
213:            (except on very rare BLAS/LAPACK implementations that support 64 bit integers see the note below).

215:     PetscErrorCode PetscBLASIntCast(a,&b) checks if the given PetscInt a will fit in a PetscBLASInt, if not it
216:       generates a PETSC_ERR_ARG_OUTOFRANGE error

218:     Installation Notes: The 64bit versions of MATLAB ship with BLAS and LAPACK that use 64 bit integers for sizes etc,
219:      if you run ./configure with the option
220:      --with-blas-lapack-lib=[/Applications/MATLAB_R2010b.app/bin/maci64/libmwblas.dylib,/Applications/MATLAB_R2010b.app/bin/maci64/libmwlapack.dylib]
221:      but you need to also use --known-64-bit-blas-indices.

223:         MKL also ships with 64 bit integer versions of the BLAS and LAPACK, if you select those you must also ./configure with --known-64-bit-blas-indices

225:      Developer Notes: Eventually ./configure should automatically determine the size of the integers used by BLAS/LAPACK.

227:      External packages such as hypre, ML, SuperLU etc do not provide any support for passing 64 bit integers to BLAS/LAPACK so cannot
228:      be used with PETSc if you have set PetscBLASInt to long int.

230: .seealso: PetscMPIInt, PetscInt

232: M*/
233: #if defined(PETSC_HAVE_64BIT_BLAS_INDICES)
234: typedef Petsc64bitInt PetscBLASInt;
235: #else
236: typedef int PetscBLASInt;
237: #endif

239: /*EC

241:     PetscPrecision - indicates what precision the object is using. This is currently not used.

243:     Level: advanced

245: .seealso: PetscObjectSetPrecision()
246: E*/
247: typedef enum { PETSC_PRECISION_SINGLE=4,PETSC_PRECISION_DOUBLE=8 } PetscPrecision;
248: PETSC_EXTERN const char *PetscPrecisions[];

250: /*
251:     For the rare cases when one needs to send a size_t object with MPI
252: */
253: #if (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_INT)
254: #define MPIU_SIZE_T MPI_UNSIGNED
255: #elif  (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_LONG)
256: #define MPIU_SIZE_T MPI_UNSIGNED_LONG
257: #elif  (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_LONG_LONG)
258: #define MPIU_SIZE_T MPI_UNSIGNED_LONG_LONG
259: #else
260: #error "Unknown size for size_t! Send us a bugreport at petsc-maint@mcs.anl.gov"
261: #endif


264: /*
265:       You can use PETSC_STDOUT as a replacement of stdout. You can also change
266:     the value of PETSC_STDOUT to redirect all standard output elsewhere
267: */
268: PETSC_EXTERN FILE* PETSC_STDOUT;

270: /*
271:       You can use PETSC_STDERR as a replacement of stderr. You can also change
272:     the value of PETSC_STDERR to redirect all standard error elsewhere
273: */
274: PETSC_EXTERN FILE* PETSC_STDERR;

276: /*MC
277:     PetscUnlikely - hints the compiler that the given condition is usually FALSE

279:     Synopsis:
280:     #include "petscsys.h"
281:     PetscBool  PetscUnlikely(PetscBool  cond)

283:     Not Collective

285:     Input Parameters:
286: .   cond - condition or expression

288:     Note: This returns the same truth value, it is only a hint to compilers that the resulting
289:     branch is unlikely.

291:     Level: advanced

293: .seealso: PetscLikely(), CHKERRQ
294: M*/

296: /*MC
297:     PetscLikely - hints the compiler that the given condition is usually TRUE

299:     Synopsis:
300:     #include "petscsys.h"
301:     PetscBool  PetscUnlikely(PetscBool  cond)

303:     Not Collective

305:     Input Parameters:
306: .   cond - condition or expression

308:     Note: This returns the same truth value, it is only a hint to compilers that the resulting
309:     branch is likely.

311:     Level: advanced

313: .seealso: PetscUnlikely()
314: M*/
315: #if defined(PETSC_HAVE_BUILTIN_EXPECT)
316: #  define PetscUnlikely(cond)   __builtin_expect(!!(cond),0)
317: #  define PetscLikely(cond)     __builtin_expect(!!(cond),1)
318: #else
319: #  define PetscUnlikely(cond)   (cond)
320: #  define PetscLikely(cond)     (cond)
321: #endif

323: /*
324:     Defines some elementary mathematics functions and constants.
325: */
326: #include <petscmath.h>

328: /*
329:     Declare extern C stuff after including external header files
330: */


333: /*
334:        Basic PETSc constants
335: */

337: /*E
338:     PetscBool  - Logical variable. Actually an int in C and a logical in Fortran.

340:    Level: beginner

342:    Developer Note: Why have PetscBool , why not use bool in C? The problem is that K and R C, C99 and C++ all have different mechanisms for
343:       boolean values. It is not easy to have a simple macro that that will work properly in all circumstances with all three mechanisms.

345: E*/
346: typedef enum { PETSC_FALSE,PETSC_TRUE } PetscBool;
347: PETSC_EXTERN const char *const PetscBools[];
348: PETSC_EXTERN MPI_Datatype MPIU_BOOL PetscAttrMPITypeTag(PetscBool);

350: /*E
351:     PetscCopyMode  - Determines how an array passed to certain functions is copied or retained

353:    Level: beginner

355: $   PETSC_COPY_VALUES - the array values are copied into new space, the user is free to reuse or delete the passed in array
356: $   PETSC_OWN_POINTER - the array values are NOT copied, the object takes ownership of the array and will free it later, the user cannot change or
357: $                       delete the array. The array MUST have been obtained with PetscMalloc(). Hence this mode cannot be used in Fortran.
358: $   PETSC_USE_POINTER - the array values are NOT copied, the object uses the array but does NOT take ownership of the array. The user cannot use
359:                         the array but the user must delete the array after the object is destroyed.

361: E*/
362: typedef enum { PETSC_COPY_VALUES, PETSC_OWN_POINTER, PETSC_USE_POINTER} PetscCopyMode;
363: PETSC_EXTERN const char *const PetscCopyModes[];

365: /*MC
366:     PETSC_FALSE - False value of PetscBool

368:     Level: beginner

370:     Note: Zero integer

372: .seealso: PetscBool , PETSC_TRUE
373: M*/

375: /*MC
376:     PETSC_TRUE - True value of PetscBool

378:     Level: beginner

380:     Note: Nonzero integer

382: .seealso: PetscBool , PETSC_FALSE
383: M*/

385: /*MC
386:     PETSC_NULL - standard way of passing in a null or array or pointer. This is deprecated in C/C++ simply use NULL

388:    Level: beginner

390:    Notes: accepted by many PETSc functions to not set a parameter and instead use
391:           some default

393:           This macro does not exist in Fortran; you must use PETSC_NULL_INTEGER,
394:           PETSC_NULL_DOUBLE_PRECISION, PETSC_NULL_FUNCTION, PETSC_NULL_OBJECT etc

396: .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_IGNORE, PETSC_DETERMINE

398: M*/
399: #define PETSC_NULL           NULL

401: /*MC
402:     PETSC_IGNORE - same as NULL, means PETSc will ignore this argument

404:    Level: beginner

406:    Note: accepted by many PETSc functions to not set a parameter and instead use
407:           some default

409:    Fortran Notes: This macro does not exist in Fortran; you must use PETSC_NULL_INTEGER,
410:           PETSC_NULL_DOUBLE_PRECISION etc

412: .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_NULL, PETSC_DETERMINE

414: M*/
415: #define PETSC_IGNORE         NULL

417: /*MC
418:     PETSC_DECIDE - standard way of passing in integer or floating point parameter
419:        where you wish PETSc to use the default.

421:    Level: beginner

423: .seealso: PETSC_NULL, PETSC_DEFAULT, PETSC_IGNORE, PETSC_DETERMINE

425: M*/
426: #define PETSC_DECIDE  -1

428: /*MC
429:     PETSC_DETERMINE - standard way of passing in integer or floating point parameter
430:        where you wish PETSc to compute the required value.

432:    Level: beginner


435:    Developer Note: I would like to use const PetscInt PETSC_DETERMINE = PETSC_DECIDE; but for
436:      some reason this is not allowed by the standard even though PETSC_DECIDE is a constant value.

438: .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_IGNORE, VecSetSizes()

440: M*/
441: #define PETSC_DETERMINE PETSC_DECIDE

443: /*MC
444:     PETSC_DEFAULT - standard way of passing in integer or floating point parameter
445:        where you wish PETSc to use the default.

447:    Level: beginner

449:    Fortran Notes: You need to use PETSC_DEFAULT_INTEGER or PETSC_DEFAULT_DOUBLE_PRECISION.

451: .seealso: PETSC_DECIDE, PETSC_IGNORE, PETSC_DETERMINE

453: M*/
454: #define PETSC_DEFAULT  -2

456: /*MC
457:     PETSC_COMM_WORLD - the equivalent of the MPI_COMM_WORLD communicator which represents
458:            all the processs that PETSc knows about.

460:    Level: beginner

462:    Notes: By default PETSC_COMM_WORLD and MPI_COMM_WORLD are identical unless you wish to
463:           run PETSc on ONLY a subset of MPI_COMM_WORLD. In that case create your new (smaller)
464:           communicator, call it, say comm, and set PETSC_COMM_WORLD = comm BEFORE calling
465:           PetscInitialize()

467: .seealso: PETSC_COMM_SELF

469: M*/
470: PETSC_EXTERN MPI_Comm PETSC_COMM_WORLD;

472: /*MC
473:     PETSC_COMM_SELF - This is always MPI_COMM_SELF

475:    Level: beginner

477: .seealso: PETSC_COMM_WORLD

479: M*/
480: #define PETSC_COMM_SELF MPI_COMM_SELF

482: PETSC_EXTERN PetscBool PetscBeganMPI;
483: PETSC_EXTERN PetscBool PetscInitializeCalled;
484: PETSC_EXTERN PetscBool PetscFinalizeCalled;
485: PETSC_EXTERN PetscBool PetscCUSPSynchronize;

487: PETSC_EXTERN PetscErrorCode PetscSetHelpVersionFunctions(PetscErrorCode (*)(MPI_Comm),PetscErrorCode (*)(MPI_Comm));
488: PETSC_EXTERN PetscErrorCode PetscCommDuplicate(MPI_Comm,MPI_Comm*,int*);
489: PETSC_EXTERN PetscErrorCode PetscCommDestroy(MPI_Comm*);

491: /*MC
492:    PetscMalloc - Allocates memory

494:    Synopsis:
495:     #include "petscsys.h"
496:    PetscErrorCode PetscMalloc(size_t m,void **result)

498:    Not Collective

500:    Input Parameter:
501: .  m - number of bytes to allocate

503:    Output Parameter:
504: .  result - memory allocated

506:    Level: beginner

508:    Notes: Memory is always allocated at least double aligned

510:           If you request memory of zero size it will allocate no space and assign the pointer to 0; PetscFree() will
511:           properly handle not freeing the null pointer.

513: .seealso: PetscFree(), PetscNew()

515:   Concepts: memory allocation

517: M*/
518: #define PetscMalloc(a,b)  ((a != 0) ? (*PetscTrMalloc)((a),__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__,(void**)(b)) : (*(b) = 0,0) )

520: /*MC
521:    PetscAddrAlign - Rounds up an address to PETSC_MEMALIGN alignment

523:    Synopsis:
524:     #include "petscsys.h"
525:    void *PetscAddrAlign(void *addr)

527:    Not Collective

529:    Input Parameters:
530: .  addr - address to align (any pointer type)

532:    Level: developer

534: .seealso: PetscMallocAlign()

536:   Concepts: memory allocation
537: M*/
538: #define PetscAddrAlign(a) (void*)((((PETSC_UINTPTR_T)(a))+(PETSC_MEMALIGN-1)) & ~(PETSC_MEMALIGN-1))

540: /*MC
541:    PetscMalloc2 - Allocates 2 chunks of  memory both aligned to PETSC_MEMALIGN

543:    Synopsis:
544:     #include "petscsys.h"
545:    PetscErrorCode PetscMalloc2(size_t m1,type, t1,void **r1,size_t m2,type t2,void **r2)

547:    Not Collective

549:    Input Parameter:
550: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
551: .  t1 - type of first memory elements
552: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
553: -  t2 - type of second memory elements

555:    Output Parameter:
556: +  r1 - memory allocated in first chunk
557: -  r2 - memory allocated in second chunk

559:    Level: developer

561: .seealso: PetscFree(), PetscNew(), PetscMalloc()

563:   Concepts: memory allocation

565: M*/
566: #if defined(PETSC_USE_DEBUG)
567: #define PetscMalloc2(m1,t1,r1,m2,t2,r2) (PetscMalloc((m1)*sizeof(t1),r1) || PetscMalloc((m2)*sizeof(t2),r2))
568: #else
569: #define PetscMalloc2(m1,t1,r1,m2,t2,r2) ((*(r2) = 0,PetscMalloc((m1)*sizeof(t1)+(m2)*sizeof(t2)+(PETSC_MEMALIGN-1),r1)) || (*(r2) = (t2*)PetscAddrAlign(*(r1)+m1),0))
570: #endif

572: /*MC
573:    PetscMalloc3 - Allocates 3 chunks of  memory  all aligned to PETSC_MEMALIGN

575:    Synopsis:
576:     #include "petscsys.h"
577:    PetscErrorCode PetscMalloc3(size_t m1,type, t1,void **r1,size_t m2,type t2,void **r2,size_t m3,type t3,void **r3)

579:    Not Collective

581:    Input Parameter:
582: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
583: .  t1 - type of first memory elements
584: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
585: .  t2 - type of second memory elements
586: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
587: -  t3 - type of third memory elements

589:    Output Parameter:
590: +  r1 - memory allocated in first chunk
591: .  r2 - memory allocated in second chunk
592: -  r3 - memory allocated in third chunk

594:    Level: developer

596: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree3()

598:   Concepts: memory allocation

600: M*/
601: #if defined(PETSC_USE_DEBUG)
602: #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))
603: #else
604: #define PetscMalloc3(m1,t1,r1,m2,t2,r2,m3,t3,r3) ((*(r2) = 0,*(r3) = 0,PetscMalloc((m1)*sizeof(t1)+(m2)*sizeof(t2)+(m3)*sizeof(t3)+2*(PETSC_MEMALIGN-1),r1)) \
605:                                                   || (*(r2) = (t2*)PetscAddrAlign(*(r1)+m1),*(r3) = (t3*)PetscAddrAlign(*(r2)+m2),0))
606: #endif

608: /*MC
609:    PetscMalloc4 - Allocates 4 chunks of  memory  all aligned to PETSC_MEMALIGN

611:    Synopsis:
612:     #include "petscsys.h"
613:    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)

615:    Not Collective

617:    Input Parameter:
618: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
619: .  t1 - type of first memory elements
620: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
621: .  t2 - type of second memory elements
622: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
623: .  t3 - type of third memory elements
624: .  m4 - number of elements to allocate in 4th chunk  (may be zero)
625: -  t4 - type of fourth memory elements

627:    Output Parameter:
628: +  r1 - memory allocated in first chunk
629: .  r2 - memory allocated in second chunk
630: .  r3 - memory allocated in third chunk
631: -  r4 - memory allocated in fourth chunk

633:    Level: developer

635: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree3(), PetscFree4()

637:   Concepts: memory allocation

639: M*/
640: #if defined(PETSC_USE_DEBUG)
641: #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))
642: #else
643: #define PetscMalloc4(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4)               \
644:   ((*(r2) = 0, *(r3) = 0, *(r4) = 0,PetscMalloc((m1)*sizeof(t1)+(m2)*sizeof(t2)+(m3)*sizeof(t3)+(m4)*sizeof(t4)+3*(PETSC_MEMALIGN-1),r1)) \
645:    || (*(r2) = (t2*)PetscAddrAlign(*(r1)+m1),*(r3) = (t3*)PetscAddrAlign(*(r2)+m2),*(r4) = (t4*)PetscAddrAlign(*(r3)+m3),0))
646: #endif

648: /*MC
649:    PetscMalloc5 - Allocates 5 chunks of  memory all aligned to PETSC_MEMALIGN

651:    Synopsis:
652:     #include "petscsys.h"
653:    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)

655:    Not Collective

657:    Input Parameter:
658: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
659: .  t1 - type of first memory elements
660: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
661: .  t2 - type of second memory elements
662: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
663: .  t3 - type of third memory elements
664: .  m4 - number of elements to allocate in 4th chunk  (may be zero)
665: .  t4 - type of fourth memory elements
666: .  m5 - number of elements to allocate in 5th chunk  (may be zero)
667: -  t5 - type of fifth memory elements

669:    Output Parameter:
670: +  r1 - memory allocated in first chunk
671: .  r2 - memory allocated in second chunk
672: .  r3 - memory allocated in third chunk
673: .  r4 - memory allocated in fourth chunk
674: -  r5 - memory allocated in fifth chunk

676:    Level: developer

678: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree3(), PetscFree4(), PetscFree5()

680:   Concepts: memory allocation

682: M*/
683: #if defined(PETSC_USE_DEBUG)
684: #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))
685: #else
686: #define PetscMalloc5(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4,m5,t5,r5)      \
687:   ((*(r2) = 0, *(r3) = 0, *(r4) = 0,*(r5) = 0,PetscMalloc((m1)*sizeof(t1)+(m2)*sizeof(t2)+(m3)*sizeof(t3)+(m4)*sizeof(t4)+(m5)*sizeof(t5)+4*(PETSC_MEMALIGN-1),r1)) \
688:    || (*(r2) = (t2*)PetscAddrAlign(*(r1)+m1),*(r3) = (t3*)PetscAddrAlign(*(r2)+m2),*(r4) = (t4*)PetscAddrAlign(*(r3)+m3),*(r5) = (t5*)PetscAddrAlign(*(r4)+m4),0))
689: #endif


692: /*MC
693:    PetscMalloc6 - Allocates 6 chunks of  memory all aligned to PETSC_MEMALIGN

695:    Synopsis:
696:     #include "petscsys.h"
697:    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)

699:    Not Collective

701:    Input Parameter:
702: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
703: .  t1 - type of first memory elements
704: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
705: .  t2 - type of second memory elements
706: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
707: .  t3 - type of third memory elements
708: .  m4 - number of elements to allocate in 4th chunk  (may be zero)
709: .  t4 - type of fourth memory elements
710: .  m5 - number of elements to allocate in 5th chunk  (may be zero)
711: .  t5 - type of fifth memory elements
712: .  m6 - number of elements to allocate in 6th chunk  (may be zero)
713: -  t6 - type of sixth memory elements

715:    Output Parameter:
716: +  r1 - memory allocated in first chunk
717: .  r2 - memory allocated in second chunk
718: .  r3 - memory allocated in third chunk
719: .  r4 - memory allocated in fourth chunk
720: .  r5 - memory allocated in fifth chunk
721: -  r6 - memory allocated in sixth chunk

723:    Level: developer

725: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree3(), PetscFree4(), PetscFree5(), PetscFree6()

727:   Concepts: memory allocation

729: M*/
730: #if defined(PETSC_USE_DEBUG)
731: #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))
732: #else
733: #define PetscMalloc6(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4,m5,t5,r5,m6,t6,r6) \
734:   ((*(r2) = 0, *(r3) = 0, *(r4) = 0,*(r5) = 0,*(r6) = 0,PetscMalloc((m1)*sizeof(t1)+(m2)*sizeof(t2)+(m3)*sizeof(t3)+(m4)*sizeof(t4)+(m5)*sizeof(t5)+(m6)*sizeof(t6)+5*(PETSC_MEMALIGN-1),r1)) \
735:    || (*(r2) = (t2*)PetscAddrAlign(*(r1)+m1),*(r3) = (t3*)PetscAddrAlign(*(r2)+m2),*(r4) = (t4*)PetscAddrAlign(*(r3)+m3),*(r5) = (t5*)PetscAddrAlign(*(r4)+m4),*(r6) = (t6*)PetscAddrAlign(*(r5)+m5),0))
736: #endif

738: /*MC
739:    PetscMalloc7 - Allocates 7 chunks of  memory all aligned to PETSC_MEMALIGN

741:    Synopsis:
742:     #include "petscsys.h"
743:    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)

745:    Not Collective

747:    Input Parameter:
748: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
749: .  t1 - type of first memory elements
750: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
751: .  t2 - type of second memory elements
752: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
753: .  t3 - type of third memory elements
754: .  m4 - number of elements to allocate in 4th chunk  (may be zero)
755: .  t4 - type of fourth memory elements
756: .  m5 - number of elements to allocate in 5th chunk  (may be zero)
757: .  t5 - type of fifth memory elements
758: .  m6 - number of elements to allocate in 6th chunk  (may be zero)
759: .  t6 - type of sixth memory elements
760: .  m7 - number of elements to allocate in 7th chunk  (may be zero)
761: -  t7 - type of sixth memory elements

763:    Output Parameter:
764: +  r1 - memory allocated in first chunk
765: .  r2 - memory allocated in second chunk
766: .  r3 - memory allocated in third chunk
767: .  r4 - memory allocated in fourth chunk
768: .  r5 - memory allocated in fifth chunk
769: .  r6 - memory allocated in sixth chunk
770: -  r7 - memory allocated in seventh chunk

772:    Level: developer

774: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree3(), PetscFree4(), PetscFree5(), PetscFree6(), PetscFree7()

776:   Concepts: memory allocation

778: M*/
779: #if defined(PETSC_USE_DEBUG)
780: #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))
781: #else
782: #define PetscMalloc7(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4,m5,t5,r5,m6,t6,r6,m7,t7,r7) \
783:   ((*(r2) = 0, *(r3) = 0, *(r4) = 0,*(r5) = 0,*(r6) = 0,*(r7) = 0,PetscMalloc((m1)*sizeof(t1)+(m2)*sizeof(t2)+(m3)*sizeof(t3)+(m4)*sizeof(t4)+(m5)*sizeof(t5)+(m6)*sizeof(t6)+(m7)*sizeof(t7)+6*(PETSC_MEMALIGN-1),r1)) \
784:    || (*(r2) = (t2*)PetscAddrAlign(*(r1)+m1),*(r3) = (t3*)PetscAddrAlign(*(r2)+m2),*(r4) = (t4*)PetscAddrAlign(*(r3)+m3),*(r5) = (t5*)PetscAddrAlign(*(r4)+m4),*(r6) = (t6*)PetscAddrAlign(*(r5)+m5),*(r7) = (t7*)PetscAddrAlign(*(r6)+m6),0))
785: #endif

787: /*MC
788:    PetscNew - Allocates memory of a particular type, zeros the memory! Aligned to PETSC_MEMALIGN

790:    Synopsis:
791:     #include "petscsys.h"
792:    PetscErrorCode PetscNew(struct type,((type *))result)

794:    Not Collective

796:    Input Parameter:
797: .  type - structure name of space to be allocated. Memory of size sizeof(type) is allocated

799:    Output Parameter:
800: .  result - memory allocated

802:    Level: beginner

804: .seealso: PetscFree(), PetscMalloc(), PetscNewLog()

806:   Concepts: memory allocation

808: M*/
809: #define PetscNew(A,b)      (PetscMalloc(sizeof(A),(b)) || PetscMemzero(*(b),sizeof(A)))

811: /*MC
812:    PetscNewLog - Allocates memory of a particular type, zeros the memory! Aligned to PETSC_MEMALIGN. Associates the memory allocated
813:          with the given object using PetscLogObjectMemory().

815:    Synopsis:
816:     #include "petscsys.h"
817:    PetscErrorCode PetscNewLog(PetscObject obj,struct type,((type *))result)

819:    Not Collective

821:    Input Parameter:
822: +  obj - object memory is logged to
823: -  type - structure name of space to be allocated. Memory of size sizeof(type) is allocated

825:    Output Parameter:
826: .  result - memory allocated

828:    Level: developer

830: .seealso: PetscFree(), PetscMalloc(), PetscNew(), PetscLogObjectMemory()

832:   Concepts: memory allocation

834: M*/
835: #define PetscNewLog(o,A,b) (PetscNew(A,b) || ((o) ? PetscLogObjectMemory(o,sizeof(A)) : 0))

837: /*MC
838:    PetscFree - Frees memory

840:    Synopsis:
841:     #include "petscsys.h"
842:    PetscErrorCode PetscFree(void *memory)

844:    Not Collective

846:    Input Parameter:
847: .   memory - memory to free (the pointer is ALWAYS set to 0 upon sucess)

849:    Level: beginner

851:    Notes: Memory must have been obtained with PetscNew() or PetscMalloc()

853: .seealso: PetscNew(), PetscMalloc(), PetscFreeVoid()

855:   Concepts: memory allocation

857: M*/
858: #define PetscFree(a)   ((a) && ((*PetscTrFree)((void*)(a),__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__) || ((a) = 0,0)))

860: /*MC
861:    PetscFreeVoid - Frees memory

863:    Synopsis:
864:     #include "petscsys.h"
865:    void PetscFreeVoid(void *memory)

867:    Not Collective

869:    Input Parameter:
870: .   memory - memory to free

872:    Level: beginner

874:    Notes: This is different from PetscFree() in that no error code is returned

876: .seealso: PetscFree(), PetscNew(), PetscMalloc()

878:   Concepts: memory allocation

880: M*/
881: #define PetscFreeVoid(a) ((*PetscTrFree)((a),__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__),(a) = 0)


884: /*MC
885:    PetscFree2 - Frees 2 chunks of memory obtained with PetscMalloc2()

887:    Synopsis:
888:     #include "petscsys.h"
889:    PetscErrorCode PetscFree2(void *memory1,void *memory2)

891:    Not Collective

893:    Input Parameter:
894: +   memory1 - memory to free
895: -   memory2 - 2nd memory to free

897:    Level: developer

899:    Notes: Memory must have been obtained with PetscMalloc2()

901: .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree()

903:   Concepts: memory allocation

905: M*/
906: #if defined(PETSC_USE_DEBUG)
907: #define PetscFree2(m1,m2)   (PetscFree(m2) || PetscFree(m1))
908: #else
909: #define PetscFree2(m1,m2)   ((m2)=0, PetscFree(m1))
910: #endif

912: /*MC
913:    PetscFree3 - Frees 3 chunks of memory obtained with PetscMalloc3()

915:    Synopsis:
916:     #include "petscsys.h"
917:    PetscErrorCode PetscFree3(void *memory1,void *memory2,void *memory3)

919:    Not Collective

921:    Input Parameter:
922: +   memory1 - memory to free
923: .   memory2 - 2nd memory to free
924: -   memory3 - 3rd memory to free

926:    Level: developer

928:    Notes: Memory must have been obtained with PetscMalloc3()

930: .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3()

932:   Concepts: memory allocation

934: M*/
935: #if defined(PETSC_USE_DEBUG)
936: #define PetscFree3(m1,m2,m3)   (PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
937: #else
938: #define PetscFree3(m1,m2,m3)   ((m3)=0,(m2)=0,PetscFree(m1))
939: #endif

941: /*MC
942:    PetscFree4 - Frees 4 chunks of memory obtained with PetscMalloc4()

944:    Synopsis:
945:     #include "petscsys.h"
946:    PetscErrorCode PetscFree4(void *m1,void *m2,void *m3,void *m4)

948:    Not Collective

950:    Input Parameter:
951: +   m1 - memory to free
952: .   m2 - 2nd memory to free
953: .   m3 - 3rd memory to free
954: -   m4 - 4th memory to free

956:    Level: developer

958:    Notes: Memory must have been obtained with PetscMalloc4()

960: .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4()

962:   Concepts: memory allocation

964: M*/
965: #if defined(PETSC_USE_DEBUG)
966: #define PetscFree4(m1,m2,m3,m4)   (PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
967: #else
968: #define PetscFree4(m1,m2,m3,m4)   ((m4)=0,(m3)=0,(m2)=0,PetscFree(m1))
969: #endif

971: /*MC
972:    PetscFree5 - Frees 5 chunks of memory obtained with PetscMalloc5()

974:    Synopsis:
975:     #include "petscsys.h"
976:    PetscErrorCode PetscFree5(void *m1,void *m2,void *m3,void *m4,void *m5)

978:    Not Collective

980:    Input Parameter:
981: +   m1 - memory to free
982: .   m2 - 2nd memory to free
983: .   m3 - 3rd memory to free
984: .   m4 - 4th memory to free
985: -   m5 - 5th memory to free

987:    Level: developer

989:    Notes: Memory must have been obtained with PetscMalloc5()

991: .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5()

993:   Concepts: memory allocation

995: M*/
996: #if defined(PETSC_USE_DEBUG)
997: #define PetscFree5(m1,m2,m3,m4,m5)   (PetscFree(m5) || PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
998: #else
999: #define PetscFree5(m1,m2,m3,m4,m5)   ((m5)=0,(m4)=0,(m3)=0,(m2)=0,PetscFree(m1))
1000: #endif


1003: /*MC
1004:    PetscFree6 - Frees 6 chunks of memory obtained with PetscMalloc6()

1006:    Synopsis:
1007:     #include "petscsys.h"
1008:    PetscErrorCode PetscFree6(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6)

1010:    Not Collective

1012:    Input Parameter:
1013: +   m1 - memory to free
1014: .   m2 - 2nd memory to free
1015: .   m3 - 3rd memory to free
1016: .   m4 - 4th memory to free
1017: .   m5 - 5th memory to free
1018: -   m6 - 6th memory to free


1021:    Level: developer

1023:    Notes: Memory must have been obtained with PetscMalloc6()

1025: .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6()

1027:   Concepts: memory allocation

1029: M*/
1030: #if defined(PETSC_USE_DEBUG)
1031: #define PetscFree6(m1,m2,m3,m4,m5,m6)   (PetscFree(m6) || PetscFree(m5) || PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
1032: #else
1033: #define PetscFree6(m1,m2,m3,m4,m5,m6)   ((m6)=0,(m5)=0,(m4)=0,(m3)=0,(m2)=0,PetscFree(m1))
1034: #endif

1036: /*MC
1037:    PetscFree7 - Frees 7 chunks of memory obtained with PetscMalloc7()

1039:    Synopsis:
1040:     #include "petscsys.h"
1041:    PetscErrorCode PetscFree7(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6,void *m7)

1043:    Not Collective

1045:    Input Parameter:
1046: +   m1 - memory to free
1047: .   m2 - 2nd memory to free
1048: .   m3 - 3rd memory to free
1049: .   m4 - 4th memory to free
1050: .   m5 - 5th memory to free
1051: .   m6 - 6th memory to free
1052: -   m7 - 7th memory to free


1055:    Level: developer

1057:    Notes: Memory must have been obtained with PetscMalloc7()

1059: .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6(),
1060:           PetscMalloc7()

1062:   Concepts: memory allocation

1064: M*/
1065: #if defined(PETSC_USE_DEBUG)
1066: #define PetscFree7(m1,m2,m3,m4,m5,m6,m7)   (PetscFree(m7) || PetscFree(m6) || PetscFree(m5) || PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
1067: #else
1068: #define PetscFree7(m1,m2,m3,m4,m5,m6,m7)   ((m7)=0,(m6)=0,(m5)=0,(m4)=0,(m3)=0,(m2)=0,PetscFree(m1))
1069: #endif

1071: PETSC_EXTERN PetscErrorCode (*PetscTrMalloc)(size_t,int,const char[],const char[],const char[],void**);
1072: PETSC_EXTERN PetscErrorCode (*PetscTrFree)(void*,int,const char[],const char[],const char[]);
1073: PETSC_EXTERN PetscErrorCode PetscMallocSet(PetscErrorCode (*)(size_t,int,const char[],const char[],const char[],void**),PetscErrorCode (*)(void*,int,const char[],const char[],const char[]));
1074: PETSC_EXTERN PetscErrorCode PetscMallocClear(void);

1076: /*
1077:     PetscLogDouble variables are used to contain double precision numbers
1078:   that are not used in the numerical computations, but rather in logging,
1079:   timing etc.
1080: */
1081: typedef double PetscLogDouble;
1082: #define MPIU_PETSCLOGDOUBLE MPI_DOUBLE

1084: /*
1085:    Routines for tracing memory corruption/bleeding with default PETSc  memory allocation
1086: */
1087: PETSC_EXTERN PetscErrorCode PetscMallocDump(FILE *);
1088: PETSC_EXTERN PetscErrorCode PetscMallocDumpLog(FILE *);
1089: PETSC_EXTERN PetscErrorCode PetscMallocGetCurrentUsage(PetscLogDouble *);
1090: PETSC_EXTERN PetscErrorCode PetscMallocGetMaximumUsage(PetscLogDouble *);
1091: PETSC_EXTERN PetscErrorCode PetscMallocDebug(PetscBool);
1092: PETSC_EXTERN PetscErrorCode PetscMallocGetDebug(PetscBool*);
1093: PETSC_EXTERN PetscErrorCode PetscMallocValidate(int,const char[],const char[],const char[]);
1094: PETSC_EXTERN PetscErrorCode PetscMallocSetDumpLog(void);
1095: PETSC_EXTERN PetscErrorCode PetscMallocSetDumpLogThreshold(PetscLogDouble);
1096: PETSC_EXTERN PetscErrorCode PetscMallocGetDumpLog(PetscBool*);

1098: /*E
1099:     PetscDataType - Used for handling different basic data types.

1101:    Level: beginner

1103:    Developer comment: It would be nice if we could always just use MPI Datatypes, why can we not?

1105: .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscDataTypeToMPIDataType(),
1106:           PetscDataTypeGetSize()

1108: E*/
1109: typedef enum {PETSC_INT = 0,PETSC_DOUBLE = 1,PETSC_COMPLEX = 2, PETSC_LONG = 3 ,PETSC_SHORT = 4,PETSC_FLOAT = 5,
1110:               PETSC_CHAR = 6,PETSC_BIT_LOGICAL = 7,PETSC_ENUM = 8,PETSC_BOOL=9, PETSC___FLOAT128 = 10,PETSC_OBJECT = 11, PETSC_FUNCTION = 12} PetscDataType;
1111: PETSC_EXTERN const char *const PetscDataTypes[];

1113: #if defined(PETSC_USE_COMPLEX)
1114: #define  PETSC_SCALAR  PETSC_COMPLEX
1115: #else
1116: #if defined(PETSC_USE_REAL_SINGLE)
1117: #define  PETSC_SCALAR  PETSC_FLOAT
1118: #elif defined(PETSC_USE_REAL___FLOAT128)
1119: #define  PETSC_SCALAR  PETSC___FLOAT128
1120: #else
1121: #define  PETSC_SCALAR  PETSC_DOUBLE
1122: #endif
1123: #endif
1124: #if defined(PETSC_USE_REAL_SINGLE)
1125: #define  PETSC_REAL  PETSC_FLOAT
1126: #elif defined(PETSC_USE_REAL___FLOAT128)
1127: #define  PETSC_REAL  PETSC___FLOAT128
1128: #else
1129: #define  PETSC_REAL  PETSC_DOUBLE
1130: #endif
1131: #define  PETSC_FORTRANADDR  PETSC_LONG

1133: PETSC_EXTERN PetscErrorCode PetscDataTypeToMPIDataType(PetscDataType,MPI_Datatype*);
1134: PETSC_EXTERN PetscErrorCode PetscMPIDataTypeToPetscDataType(MPI_Datatype,PetscDataType*);
1135: PETSC_EXTERN PetscErrorCode PetscDataTypeGetSize(PetscDataType,size_t*);
1136: PETSC_EXTERN PetscErrorCode PetscDataTypeFromString(const char*,PetscDataType*,PetscBool*);

1138: /*
1139:     Basic memory and string operations. These are usually simple wrappers
1140:    around the basic Unix system calls, but a few of them have additional
1141:    functionality and/or error checking.
1142: */
1143: PETSC_EXTERN PetscErrorCode PetscBitMemcpy(void*,PetscInt,const void*,PetscInt,PetscInt,PetscDataType);
1144: PETSC_EXTERN PetscErrorCode PetscMemmove(void*,void *,size_t);
1145: PETSC_EXTERN PetscErrorCode PetscMemcmp(const void*,const void*,size_t,PetscBool  *);
1146: PETSC_EXTERN PetscErrorCode PetscStrlen(const char[],size_t*);
1147: PETSC_EXTERN PetscErrorCode PetscStrToArray(const char[],char,int*,char ***);
1148: PETSC_EXTERN PetscErrorCode PetscStrToArrayDestroy(int,char **);
1149: PETSC_EXTERN PetscErrorCode PetscStrcmp(const char[],const char[],PetscBool  *);
1150: PETSC_EXTERN PetscErrorCode PetscStrgrt(const char[],const char[],PetscBool  *);
1151: PETSC_EXTERN PetscErrorCode PetscStrcasecmp(const char[],const char[],PetscBool *);
1152: PETSC_EXTERN PetscErrorCode PetscStrncmp(const char[],const char[],size_t,PetscBool *);
1153: PETSC_EXTERN PetscErrorCode PetscStrcpy(char[],const char[]);
1154: PETSC_EXTERN PetscErrorCode PetscStrcat(char[],const char[]);
1155: PETSC_EXTERN PetscErrorCode PetscStrncat(char[],const char[],size_t);
1156: PETSC_EXTERN PetscErrorCode PetscStrncpy(char[],const char[],size_t);
1157: PETSC_EXTERN PetscErrorCode PetscStrchr(const char[],char,char *[]);
1158: PETSC_EXTERN PetscErrorCode PetscStrtolower(char[]);
1159: PETSC_EXTERN PetscErrorCode PetscStrtoupper(char[]);
1160: PETSC_EXTERN PetscErrorCode PetscStrrchr(const char[],char,char *[]);
1161: PETSC_EXTERN PetscErrorCode PetscStrstr(const char[],const char[],char *[]);
1162: PETSC_EXTERN PetscErrorCode PetscStrrstr(const char[],const char[],char *[]);
1163: PETSC_EXTERN PetscErrorCode PetscStrendswith(const char[],const char[],PetscBool*);
1164: PETSC_EXTERN PetscErrorCode PetscStrbeginswith(const char[],const char[],PetscBool*);
1165: PETSC_EXTERN PetscErrorCode PetscStrendswithwhich(const char[],const char *const*,PetscInt*);
1166: PETSC_EXTERN PetscErrorCode PetscStrallocpy(const char[],char *[]);
1167: PETSC_EXTERN PetscErrorCode PetscStrArrayallocpy(const char *const*,char***);
1168: PETSC_EXTERN PetscErrorCode PetscStrArrayDestroy(char***);
1169: PETSC_EXTERN PetscErrorCode PetscStrreplace(MPI_Comm,const char[],char[],size_t);

1171: PETSC_EXTERN void PetscStrcmpNoError(const char[],const char[],PetscBool  *);

1173: /*S
1174:     PetscToken - 'Token' used for managing tokenizing strings

1176:   Level: intermediate

1178: .seealso: PetscTokenCreate(), PetscTokenFind(), PetscTokenDestroy()
1179: S*/
1180: typedef struct _p_PetscToken* PetscToken;

1182: PETSC_EXTERN PetscErrorCode PetscTokenCreate(const char[],const char,PetscToken*);
1183: PETSC_EXTERN PetscErrorCode PetscTokenFind(PetscToken,char *[]);
1184: PETSC_EXTERN PetscErrorCode PetscTokenDestroy(PetscToken*);

1186: PETSC_EXTERN PetscErrorCode PetscEListFind(PetscInt,const char *const*,const char*,PetscInt*,PetscBool*);
1187: PETSC_EXTERN PetscErrorCode PetscEnumFind(const char *const*,const char*,PetscEnum*,PetscBool*);

1189: /*
1190:    These are  MPI operations for MPI_Allreduce() etc
1191: */
1192: PETSC_EXTERN MPI_Op PetscMaxSum_Op;
1193: #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
1194: PETSC_EXTERN MPI_Op MPIU_SUM;
1195: #else
1196: #define MPIU_SUM MPI_SUM
1197: #endif
1198: #if defined(PETSC_USE_REAL___FLOAT128)
1199: PETSC_EXTERN MPI_Op MPIU_MAX;
1200: PETSC_EXTERN MPI_Op MPIU_MIN;
1201: #else
1202: #define MPIU_MAX MPI_MAX
1203: #define MPIU_MIN MPI_MIN
1204: #endif
1205: PETSC_EXTERN PetscErrorCode PetscMaxSum(MPI_Comm,const PetscInt[],PetscInt*,PetscInt*);

1207: PETSC_EXTERN PetscErrorCode MPIULong_Send(void*,PetscInt,MPI_Datatype,PetscMPIInt,PetscMPIInt,MPI_Comm);
1208: PETSC_EXTERN PetscErrorCode MPIULong_Recv(void*,PetscInt,MPI_Datatype,PetscMPIInt,PetscMPIInt,MPI_Comm);

1210: /*S
1211:      PetscObject - any PETSc object, PetscViewer, Mat, Vec, KSP etc

1213:    Level: beginner

1215:    Note: This is the base class from which all PETSc objects are derived from.

1217: .seealso:  PetscObjectDestroy(), PetscObjectView(), PetscObjectGetName(), PetscObjectSetName(), PetscObjectReference(), PetscObjectDereferenc()
1218: S*/
1219: typedef struct _p_PetscObject* PetscObject;

1221: /*S
1222:      PetscFunctionList - Linked list of functions, possibly stored in dynamic libraries, accessed
1223:       by string name

1225:    Level: advanced

1227: .seealso:  PetscFunctionListAdd(), PetscFunctionListDestroy(), PetscOpFlist
1228: S*/
1229: typedef struct _n_PetscFunctionList *PetscFunctionList;

1231: /*E
1232:   PetscFileMode - Access mode for a file.

1234:   Level: beginner

1236:   FILE_MODE_READ - open a file at its beginning for reading

1238:   FILE_MODE_WRITE - open a file at its beginning for writing (will create if the file does not exist)

1240:   FILE_MODE_APPEND - open a file at end for writing

1242:   FILE_MODE_UPDATE - open a file for updating, meaning for reading and writing

1244:   FILE_MODE_APPEND_UPDATE - open a file for updating, meaning for reading and writing, at the end

1246: .seealso: PetscViewerFileSetMode()
1247: E*/
1248: typedef enum {FILE_MODE_READ, FILE_MODE_WRITE, FILE_MODE_APPEND, FILE_MODE_UPDATE, FILE_MODE_APPEND_UPDATE} PetscFileMode;
1249: extern const char *const PetscFileModes[];

1251: /*
1252:     Defines PETSc error handling.
1253: */
1254: #include <petscerror.h>

1256: #define PETSC_SMALLEST_CLASSID  1211211
1257: PETSC_EXTERN PetscClassId PETSC_LARGEST_CLASSID;
1258: PETSC_EXTERN PetscClassId PETSC_OBJECT_CLASSID;
1259: PETSC_EXTERN PetscErrorCode PetscClassIdRegister(const char[],PetscClassId *);

1261: /*
1262:    Routines that get memory usage information from the OS
1263: */
1264: PETSC_EXTERN PetscErrorCode PetscMemoryGetCurrentUsage(PetscLogDouble *);
1265: PETSC_EXTERN PetscErrorCode PetscMemoryGetMaximumUsage(PetscLogDouble *);
1266: PETSC_EXTERN PetscErrorCode PetscMemorySetGetMaximumUsage(void);

1268: PETSC_EXTERN PetscErrorCode PetscInfoAllow(PetscBool ,const char []);
1269: PETSC_EXTERN PetscErrorCode PetscSleep(PetscReal);

1271: /*
1272:    Initialization of PETSc
1273: */
1274: PETSC_EXTERN PetscErrorCode PetscInitialize(int*,char***,const char[],const char[]);
1275: PETSC_EXTERN PetscErrorCode PetscInitializeNoPointers(int,char**,const char[],const char[]);
1276: PETSC_EXTERN PetscErrorCode PetscInitializeNoArguments(void);
1277: PETSC_EXTERN PetscErrorCode PetscInitialized(PetscBool *);
1278: PETSC_EXTERN PetscErrorCode PetscFinalized(PetscBool *);
1279: PETSC_EXTERN PetscErrorCode PetscFinalize(void);
1280: PETSC_EXTERN PetscErrorCode PetscInitializeFortran(void);
1281: PETSC_EXTERN PetscErrorCode PetscGetArgs(int*,char ***);
1282: PETSC_EXTERN PetscErrorCode PetscGetArguments(char ***);
1283: PETSC_EXTERN PetscErrorCode PetscFreeArguments(char **);

1285: PETSC_EXTERN PetscErrorCode PetscEnd(void);
1286: PETSC_EXTERN PetscErrorCode PetscSysInitializePackage(void);

1288: PETSC_EXTERN MPI_Comm PETSC_COMM_LOCAL_WORLD;
1289: PETSC_EXTERN PetscErrorCode PetscHMPIMerge(PetscMPIInt,PetscErrorCode (*)(void*),void*);
1290: PETSC_EXTERN PetscErrorCode PetscHMPISpawn(PetscMPIInt);
1291: PETSC_EXTERN PetscErrorCode PetscHMPIFinalize(void);
1292: PETSC_EXTERN PetscErrorCode PetscHMPIRun(MPI_Comm,PetscErrorCode (*)(MPI_Comm,void *),void*);
1293: PETSC_EXTERN PetscErrorCode PetscHMPIRunCtx(MPI_Comm,PetscErrorCode (*)(MPI_Comm,void*,void *),void*);
1294: PETSC_EXTERN PetscErrorCode PetscHMPIFree(MPI_Comm,void*);
1295: PETSC_EXTERN PetscErrorCode PetscHMPIMalloc(MPI_Comm,size_t,void**);

1297: PETSC_EXTERN PetscErrorCode PetscPythonInitialize(const char[],const char[]);
1298: PETSC_EXTERN PetscErrorCode PetscPythonFinalize(void);
1299: PETSC_EXTERN PetscErrorCode PetscPythonPrintError(void);
1300: PETSC_EXTERN PetscErrorCode PetscPythonMonitorSet(PetscObject,const char[]);

1302: /*
1303:      These are so that in extern C code we can caste function pointers to non-extern C
1304:    function pointers. Since the regular C++ code expects its function pointers to be C++
1305: */
1306: PETSC_EXTERN_TYPEDEF typedef void (**PetscVoidStarFunction)(void);
1307: PETSC_EXTERN_TYPEDEF typedef void (*PetscVoidFunction)(void);
1308: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*PetscErrorCodeFunction)(void);

1310: /*
1311:     Functions that can act on any PETSc object.
1312: */
1313: PETSC_EXTERN PetscErrorCode PetscObjectDestroy(PetscObject*);
1314: PETSC_EXTERN PetscErrorCode PetscObjectGetComm(PetscObject,MPI_Comm *);
1315: PETSC_EXTERN PetscErrorCode PetscObjectGetClassId(PetscObject,PetscClassId *);
1316: PETSC_EXTERN PetscErrorCode PetscObjectGetClassName(PetscObject,const char *[]);
1317: PETSC_EXTERN PetscErrorCode PetscObjectSetType(PetscObject,const char []);
1318: PETSC_EXTERN PetscErrorCode PetscObjectSetPrecision(PetscObject,PetscPrecision);
1319: PETSC_EXTERN PetscErrorCode PetscObjectGetType(PetscObject,const char *[]);
1320: PETSC_EXTERN PetscErrorCode PetscObjectSetName(PetscObject,const char[]);
1321: PETSC_EXTERN PetscErrorCode PetscObjectGetName(PetscObject,const char*[]);
1322: PETSC_EXTERN PetscErrorCode PetscObjectSetTabLevel(PetscObject,PetscInt);
1323: PETSC_EXTERN PetscErrorCode PetscObjectGetTabLevel(PetscObject,PetscInt*);
1324: PETSC_EXTERN PetscErrorCode PetscObjectIncrementTabLevel(PetscObject,PetscObject,PetscInt);
1325: PETSC_EXTERN PetscErrorCode PetscObjectReference(PetscObject);
1326: PETSC_EXTERN PetscErrorCode PetscObjectGetReference(PetscObject,PetscInt*);
1327: PETSC_EXTERN PetscErrorCode PetscObjectDereference(PetscObject);
1328: PETSC_EXTERN PetscErrorCode PetscObjectGetNewTag(PetscObject,PetscMPIInt *);
1329: PETSC_EXTERN PetscErrorCode PetscObjectCompose(PetscObject,const char[],PetscObject);
1330: PETSC_EXTERN PetscErrorCode PetscObjectRemoveReference(PetscObject,const char[]);
1331: PETSC_EXTERN PetscErrorCode PetscObjectQuery(PetscObject,const char[],PetscObject *);
1332: PETSC_EXTERN PetscErrorCode PetscObjectComposeFunction_Private(PetscObject,const char[],void (*)(void));
1333: #define PetscObjectComposeFunction(a,b,d) PetscObjectComposeFunction_Private(a,b,(PetscVoidFunction)(d))
1334: PETSC_EXTERN PetscErrorCode PetscObjectSetFromOptions(PetscObject);
1335: PETSC_EXTERN PetscErrorCode PetscObjectSetUp(PetscObject);
1336: PETSC_EXTERN PetscErrorCode PetscCommGetNewTag(MPI_Comm,PetscMPIInt *);
1337: PETSC_EXTERN PetscErrorCode PetscObjectAddOptionsHandler(PetscObject,PetscErrorCode (*)(PetscObject,void*),PetscErrorCode (*)(PetscObject,void*),void*);
1338: PETSC_EXTERN PetscErrorCode PetscObjectProcessOptionsHandlers(PetscObject);
1339: PETSC_EXTERN PetscErrorCode PetscObjectDestroyOptionsHandlers(PetscObject);
1340: PETSC_EXTERN PetscErrorCode PetscObjectsGetGlobalNumbering(MPI_Comm,PetscInt,PetscObject*,PetscInt*,PetscInt*);

1342: #include <petscviewertypes.h>
1343: #include <petscoptions.h>

1345: PETSC_EXTERN PetscErrorCode PetscMemoryShowUsage(PetscViewer,const char[]);
1346: PETSC_EXTERN PetscErrorCode PetscObjectPrintClassNamePrefixType(PetscObject,PetscViewer,const char[]);
1347: PETSC_EXTERN PetscErrorCode PetscObjectView(PetscObject,PetscViewer);
1348: #define PetscObjectQueryFunction(obj,name,fptr) PetscObjectQueryFunction_Private((obj),(name),(PetscVoidFunction*)(fptr))
1349: PETSC_EXTERN PetscErrorCode PetscObjectQueryFunction_Private(PetscObject,const char[],void (**)(void));
1350: PETSC_EXTERN PetscErrorCode PetscObjectSetOptionsPrefix(PetscObject,const char[]);
1351: PETSC_EXTERN PetscErrorCode PetscObjectAppendOptionsPrefix(PetscObject,const char[]);
1352: PETSC_EXTERN PetscErrorCode PetscObjectPrependOptionsPrefix(PetscObject,const char[]);
1353: PETSC_EXTERN PetscErrorCode PetscObjectGetOptionsPrefix(PetscObject,const char*[]);
1354: PETSC_EXTERN PetscErrorCode PetscObjectChangeTypeName(PetscObject,const char[]);
1355: PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroy(PetscObject);
1356: PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroyAll(void);
1357: PETSC_EXTERN PetscErrorCode PetscObjectName(PetscObject);
1358: PETSC_EXTERN PetscErrorCode PetscObjectTypeCompare(PetscObject,const char[],PetscBool *);
1359: PETSC_EXTERN PetscErrorCode PetscObjectTypeCompareAny(PetscObject,PetscBool*,const char[],...);
1360: PETSC_EXTERN PetscErrorCode PetscRegisterFinalize(PetscErrorCode (*)(void));
1361: PETSC_EXTERN PetscErrorCode PetscRegisterFinalizeAll(void);

1363: #if defined(PETSC_HAVE_AMS)
1364: PETSC_EXTERN PetscErrorCode PetscObjectAMSViewOff(PetscObject);
1365: PETSC_EXTERN PetscErrorCode PetscObjectAMSSetBlock(PetscObject,PetscBool);
1366: PETSC_EXTERN PetscErrorCode PetscObjectAMSBlock(PetscObject);
1367: PETSC_EXTERN PetscErrorCode PetscObjectAMSGrantAccess(PetscObject);
1368: PETSC_EXTERN PetscErrorCode PetscObjectAMSTakeAccess(PetscObject);
1369: PETSC_EXTERN void           PetscStackAMSGrantAccess(void);
1370: PETSC_EXTERN void           PetscStackAMSTakeAccess(void);
1371: PETSC_EXTERN PetscErrorCode PetscStackViewAMS(void);
1372: PETSC_EXTERN PetscErrorCode PetscStackAMSViewOff(void);

1374: #else
1375: #define PetscObjectAMSViewOff(obj)             0
1376: #define PetscObjectAMSSetBlock(obj,flg)        0
1377: #define PetscObjectAMSBlock(obj)               0
1378: #define PetscObjectAMSGrantAccess(obj)         0
1379: #define PetscObjectAMSTakeAccess(obj)          0
1380: #define PetscStackViewAMS()                    0
1381: #define PetscStackAMSViewOff()                 0
1382: #define PetscStackAMSTakeAccess()
1383: #define PetscStackAMSGrantAccess()

1385: #endif

1387: typedef void* PetscDLHandle;
1388: typedef enum {PETSC_DL_DECIDE=0,PETSC_DL_NOW=1,PETSC_DL_LOCAL=2} PetscDLMode;
1389: PETSC_EXTERN PetscErrorCode PetscDLOpen(const char[],PetscDLMode,PetscDLHandle *);
1390: PETSC_EXTERN PetscErrorCode PetscDLClose(PetscDLHandle *);
1391: PETSC_EXTERN PetscErrorCode PetscDLSym(PetscDLHandle,const char[],void **);


1394: #if defined(PETSC_USE_DEBUG)
1395: PETSC_EXTERN PetscErrorCode PetscMallocGetStack(void*,PetscStack**);
1396: #endif
1397: PETSC_EXTERN PetscErrorCode PetscObjectsDump(FILE*,PetscBool);

1399: /*S
1400:      PetscObjectList - Linked list of PETSc objects, each accessable by string name

1402:    Level: developer

1404:    Notes: Used by PetscObjectCompose() and PetscObjectQuery()

1406: .seealso:  PetscObjectListAdd(), PetscObjectListDestroy(), PetscObjectListFind(), PetscObjectCompose(), PetscObjectQuery(), PetscFunctionList
1407: S*/
1408: typedef struct _n_PetscObjectList *PetscObjectList;

1410: PETSC_EXTERN PetscErrorCode PetscObjectListDestroy(PetscObjectList*);
1411: PETSC_EXTERN PetscErrorCode PetscObjectListFind(PetscObjectList,const char[],PetscObject*);
1412: PETSC_EXTERN PetscErrorCode PetscObjectListReverseFind(PetscObjectList,PetscObject,char**,PetscBool*);
1413: PETSC_EXTERN PetscErrorCode PetscObjectListAdd(PetscObjectList *,const char[],PetscObject);
1414: PETSC_EXTERN PetscErrorCode PetscObjectListRemoveReference(PetscObjectList *,const char[]);
1415: PETSC_EXTERN PetscErrorCode PetscObjectListDuplicate(PetscObjectList,PetscObjectList *);

1417: /*
1418:     Dynamic library lists. Lists of names of routines in objects or in dynamic
1419:   link libraries that will be loaded as needed.
1420: */

1422: #define PetscFunctionListAdd(list,name,fptr) PetscFunctionListAdd_Private((list),(name),(PetscVoidFunction)(fptr))
1423: PETSC_EXTERN PetscErrorCode PetscFunctionListAdd_Private(PetscFunctionList*,const char[],void (*)(void));
1424: PETSC_EXTERN PetscErrorCode PetscFunctionListDestroy(PetscFunctionList*);
1425: #define PetscFunctionListFind(list,name,fptr) PetscFunctionListFind_Private((list),(name),(PetscVoidFunction*)(fptr))
1426: PETSC_EXTERN PetscErrorCode PetscFunctionListFind_Private(PetscFunctionList,const char[],void (**)(void));
1427: PETSC_EXTERN PetscErrorCode PetscFunctionListPrintTypes(MPI_Comm,FILE*,const char[],const char[],const char[],const char[],PetscFunctionList,const char[]);
1428: PETSC_EXTERN PetscErrorCode PetscFunctionListDuplicate(PetscFunctionList,PetscFunctionList *);
1429: PETSC_EXTERN PetscErrorCode PetscFunctionListView(PetscFunctionList,PetscViewer);
1430: PETSC_EXTERN PetscErrorCode PetscFunctionListGet(PetscFunctionList,const char ***,int*);

1432: /*S
1433:      PetscDLLibrary - Linked list of dynamics libraries to search for functions

1435:    Level: advanced

1437:    --with-shared-libraries --with-dynamic-loading must be used with ./configure to use dynamic libraries

1439: .seealso:  PetscDLLibraryOpen()
1440: S*/
1441: typedef struct _n_PetscDLLibrary *PetscDLLibrary;
1442: PETSC_EXTERN PetscDLLibrary  PetscDLLibrariesLoaded;
1443: PETSC_EXTERN PetscErrorCode PetscDLLibraryAppend(MPI_Comm,PetscDLLibrary *,const char[]);
1444: PETSC_EXTERN PetscErrorCode PetscDLLibraryPrepend(MPI_Comm,PetscDLLibrary *,const char[]);
1445: PETSC_EXTERN PetscErrorCode PetscDLLibrarySym(MPI_Comm,PetscDLLibrary *,const char[],const char[],void **);
1446: PETSC_EXTERN PetscErrorCode PetscDLLibraryPrintPath(PetscDLLibrary);
1447: PETSC_EXTERN PetscErrorCode PetscDLLibraryRetrieve(MPI_Comm,const char[],char *,size_t,PetscBool  *);
1448: PETSC_EXTERN PetscErrorCode PetscDLLibraryOpen(MPI_Comm,const char[],PetscDLLibrary *);
1449: PETSC_EXTERN PetscErrorCode PetscDLLibraryClose(PetscDLLibrary);

1451: /*
1452:      Useful utility routines
1453: */
1454: PETSC_EXTERN PetscErrorCode PetscSplitOwnership(MPI_Comm,PetscInt*,PetscInt*);
1455: PETSC_EXTERN PetscErrorCode PetscSplitOwnershipBlock(MPI_Comm,PetscInt,PetscInt*,PetscInt*);
1456: PETSC_EXTERN PetscErrorCode PetscSequentialPhaseBegin(MPI_Comm,PetscMPIInt);
1457: PETSC_EXTERN PetscErrorCode PetscSequentialPhaseEnd(MPI_Comm,PetscMPIInt);
1458: PETSC_EXTERN PetscErrorCode PetscBarrier(PetscObject);
1459: PETSC_EXTERN PetscErrorCode PetscMPIDump(FILE*);

1461: /*
1462:     PetscNot - negates a logical type value and returns result as a PetscBool

1464:     Notes: This is useful in cases like
1465: $     int        *a;
1466: $     PetscBool  flag = PetscNot(a)
1467:      where !a does not return a PetscBool  because we cannot provide a cast from int to PetscBool  in C.
1468: */
1469: #define PetscNot(a) ((a) ? PETSC_FALSE : PETSC_TRUE)

1471: #if defined(PETSC_HAVE_VALGRIND)
1472: #  include <valgrind/valgrind.h>
1473: #  define PETSC_RUNNING_ON_VALGRIND RUNNING_ON_VALGRIND
1474: #else
1475: #  define PETSC_RUNNING_ON_VALGRIND PETSC_FALSE
1476: #endif


1479: /*MC
1480:     PetscHelpPrintf - Prints help messages.

1482:    Synopsis:
1483:     #include "petscsys.h"
1484:      PetscErrorCode (*PetscHelpPrintf)(const char format[],...);

1486:     Not Collective

1488:     Input Parameters:
1489: .   format - the usual printf() format string

1491:    Level: developer

1493:     Fortran Note:
1494:     This routine is not supported in Fortran.

1496:     Concepts: help messages^printing
1497:     Concepts: printing^help messages

1499: .seealso: PetscFPrintf(), PetscSynchronizedPrintf(), PetscErrorPrintf()
1500: M*/
1501: PETSC_EXTERN PetscErrorCode (*PetscHelpPrintf)(MPI_Comm,const char[],...);

1503: /*
1504:      Defines PETSc profiling.
1505: */
1506: #include <petsclog.h>



1510: /*
1511:       Simple PETSc parallel IO for ASCII printing
1512: */
1513: PETSC_EXTERN PetscErrorCode PetscFixFilename(const char[],char[]);
1514: PETSC_EXTERN PetscErrorCode PetscFOpen(MPI_Comm,const char[],const char[],FILE**);
1515: PETSC_EXTERN PetscErrorCode PetscFClose(MPI_Comm,FILE*);
1516: PETSC_EXTERN PetscErrorCode PetscFPrintf(MPI_Comm,FILE*,const char[],...);
1517: PETSC_EXTERN PetscErrorCode PetscPrintf(MPI_Comm,const char[],...);
1518: PETSC_EXTERN PetscErrorCode PetscSNPrintf(char*,size_t,const char [],...);
1519: PETSC_EXTERN PetscErrorCode PetscSNPrintfCount(char*,size_t,const char [],size_t*,...);

1521: /* These are used internally by PETSc ASCII IO routines*/
1522: #include <stdarg.h>
1523: PETSC_EXTERN PetscErrorCode PetscVSNPrintf(char*,size_t,const char[],size_t*,va_list);
1524: PETSC_EXTERN PetscErrorCode (*PetscVFPrintf)(FILE*,const char[],va_list);
1525: PETSC_EXTERN PetscErrorCode PetscVFPrintfDefault(FILE*,const char[],va_list);

1527: #if defined(PETSC_HAVE_MATLAB_ENGINE)
1528: PETSC_EXTERN PetscErrorCode PetscVFPrintf_Matlab(FILE*,const char[],va_list);
1529: #endif

1531: PETSC_EXTERN PetscErrorCode PetscErrorPrintfDefault(const char [],...);
1532: PETSC_EXTERN PetscErrorCode PetscErrorPrintfNone(const char [],...);
1533: PETSC_EXTERN PetscErrorCode PetscHelpPrintfDefault(MPI_Comm,const char [],...);

1535: #if defined(PETSC_HAVE_POPEN)
1536: PETSC_EXTERN PetscErrorCode PetscPOpen(MPI_Comm,const char[],const char[],const char[],FILE **);
1537: PETSC_EXTERN PetscErrorCode PetscPClose(MPI_Comm,FILE*,PetscInt*);
1538: #endif

1540: PETSC_EXTERN PetscErrorCode PetscSynchronizedPrintf(MPI_Comm,const char[],...);
1541: PETSC_EXTERN PetscErrorCode PetscSynchronizedFPrintf(MPI_Comm,FILE*,const char[],...);
1542: PETSC_EXTERN PetscErrorCode PetscSynchronizedFlush(MPI_Comm);
1543: PETSC_EXTERN PetscErrorCode PetscSynchronizedFGets(MPI_Comm,FILE*,size_t,char[]);
1544: PETSC_EXTERN PetscErrorCode PetscStartMatlab(MPI_Comm,const char[],const char[],FILE**);
1545: PETSC_EXTERN PetscErrorCode PetscStartJava(MPI_Comm,const char[],const char[],FILE**);
1546: PETSC_EXTERN PetscErrorCode PetscGetPetscDir(const char*[]);

1548: PETSC_EXTERN PetscErrorCode PetscPopUpSelect(MPI_Comm,const char*,const char*,int,const char**,int*);

1550: /*S
1551:      PetscContainer - Simple PETSc object that contains a pointer to any required data

1553:    Level: advanced

1555: .seealso:  PetscObject, PetscContainerCreate()
1556: S*/
1557: PETSC_EXTERN PetscClassId PETSC_CONTAINER_CLASSID;
1558: typedef struct _p_PetscContainer*  PetscContainer;
1559: PETSC_EXTERN PetscErrorCode PetscContainerGetPointer(PetscContainer,void **);
1560: PETSC_EXTERN PetscErrorCode PetscContainerSetPointer(PetscContainer,void *);
1561: PETSC_EXTERN PetscErrorCode PetscContainerDestroy(PetscContainer*);
1562: PETSC_EXTERN PetscErrorCode PetscContainerCreate(MPI_Comm,PetscContainer *);
1563: PETSC_EXTERN PetscErrorCode PetscContainerSetUserDestroy(PetscContainer, PetscErrorCode (*)(void*));

1565: /*
1566:    For use in debuggers
1567: */
1568: PETSC_EXTERN PetscMPIInt PetscGlobalRank;
1569: PETSC_EXTERN PetscMPIInt PetscGlobalSize;
1570: PETSC_EXTERN PetscErrorCode PetscIntView(PetscInt,const PetscInt[],PetscViewer);
1571: PETSC_EXTERN PetscErrorCode PetscRealView(PetscInt,const PetscReal[],PetscViewer);
1572: PETSC_EXTERN PetscErrorCode PetscScalarView(PetscInt,const PetscScalar[],PetscViewer);

1574: #include <stddef.h>
1575: #if defined(PETSC_HAVE_MEMORY_H)
1576: #include <memory.h>
1577: #endif
1578: #if defined(PETSC_HAVE_STDLIB_H)
1579: #include <stdlib.h>
1580: #endif

1582: #if defined(PETSC_HAVE_XMMINTRIN_H) && !defined(__CUDACC__)
1583: #include <xmmintrin.h>
1584: #endif
1585: #if defined(PETSC_HAVE_STDINT_H)
1586: #include <stdint.h>
1587: #endif

1591: /*@C
1592:    PetscMemcpy - Copies n bytes, beginning at location b, to the space
1593:    beginning at location a. The two memory regions CANNOT overlap, use
1594:    PetscMemmove() in that case.

1596:    Not Collective

1598:    Input Parameters:
1599: +  b - pointer to initial memory space
1600: -  n - length (in bytes) of space to copy

1602:    Output Parameter:
1603: .  a - pointer to copy space

1605:    Level: intermediate

1607:    Compile Option:
1608:     PETSC_PREFER_DCOPY_FOR_MEMCPY will cause the BLAS dcopy() routine to be used
1609:                                   for memory copies on double precision values.
1610:     PETSC_PREFER_COPY_FOR_MEMCPY will cause C code to be used
1611:                                   for memory copies on double precision values.
1612:     PETSC_PREFER_FORTRAN_FORMEMCPY will cause Fortran code to be used
1613:                                   for memory copies on double precision values.

1615:    Note:
1616:    This routine is analogous to memcpy().

1618:    Developer Note: this is inlined for fastest performance

1620:   Concepts: memory^copying
1621:   Concepts: copying^memory

1623: .seealso: PetscMemmove()

1625: @*/
1626: PETSC_STATIC_INLINE PetscErrorCode PetscMemcpy(void *a,const void *b,size_t n)
1627: {
1628: #if defined(PETSC_USE_DEBUG)
1629:   unsigned long al = (unsigned long) a,bl = (unsigned long) b;
1630:   unsigned long nl = (unsigned long) n;
1632:   if (n > 0 && !b) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy from a null pointer");
1633:   if (n > 0 && !a) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy to a null pointer");
1634: #else
1636: #endif
1637:   if (a != b) {
1638: #if defined(PETSC_USE_DEBUG)
1639:     if ((al > bl && (al - bl) < nl) || (bl - al) < nl)  SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_ARG_INCOMP,"Memory regions overlap: either use PetscMemmov()\n\
1640:               or make sure your copy regions and lengths are correct. \n\
1641:               Length (bytes) %ld first address %ld second address %ld",nl,al,bl);
1642: #endif
1643: #if (defined(PETSC_PREFER_DCOPY_FOR_MEMCPY) || defined(PETSC_PREFER_COPY_FOR_MEMCPY) || defined(PETSC_PREFER_FORTRAN_FORMEMCPY))
1644:    if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) {
1645:       size_t len = n/sizeof(PetscScalar);
1646: #if defined(PETSC_PREFER_DCOPY_FOR_MEMCPY)
1647:       PetscBLASInt   one = 1,blen;
1649:       PetscBLASIntCast(len,&blen);
1650:       PetscStackCallBLAS("BLAScopy",BLAScopy_(&blen,(PetscScalar *)b,&one,(PetscScalar *)a,&one));
1651: #elif defined(PETSC_PREFER_FORTRAN_FORMEMCPY)
1652:       fortrancopy_(&len,(PetscScalar*)b,(PetscScalar*)a);
1653: #else
1654:       size_t      i;
1655:       PetscScalar *x = (PetscScalar*)b, *y = (PetscScalar*)a;
1656:       for (i=0; i<len; i++) y[i] = x[i];
1657: #endif
1658:     } else {
1659:       memcpy((char*)(a),(char*)(b),n);
1660:     }
1661: #else
1662:     memcpy((char*)(a),(char*)(b),n);
1663: #endif
1664:   }
1665:   return(0);
1666: }

1668: /*@C
1669:    PetscMemzero - Zeros the specified memory.

1671:    Not Collective

1673:    Input Parameters:
1674: +  a - pointer to beginning memory location
1675: -  n - length (in bytes) of memory to initialize

1677:    Level: intermediate

1679:    Compile Option:
1680:    PETSC_PREFER_BZERO - on certain machines (the IBM RS6000) the bzero() routine happens
1681:   to be faster than the memset() routine. This flag causes the bzero() routine to be used.

1683:    Developer Note: this is inlined for fastest performance

1685:    Concepts: memory^zeroing
1686:    Concepts: zeroing^memory

1688: .seealso: PetscMemcpy()
1689: @*/
1690: PETSC_STATIC_INLINE PetscErrorCode  PetscMemzero(void *a,size_t n)
1691: {
1692:   if (n > 0) {
1693: #if defined(PETSC_USE_DEBUG)
1694:     if (!a) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to zero at a null pointer");
1695: #endif
1696: #if defined(PETSC_PREFER_ZERO_FOR_MEMZERO)
1697:     if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) {
1698:       size_t      i,len = n/sizeof(PetscScalar);
1699:       PetscScalar *x = (PetscScalar*)a;
1700:       for (i=0; i<len; i++) x[i] = 0.0;
1701:     } else {
1702: #elif defined(PETSC_PREFER_FORTRAN_FOR_MEMZERO)
1703:     if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) {
1704:       PetscInt len = n/sizeof(PetscScalar);
1705:       fortranzero_(&len,(PetscScalar*)a);
1706:     } else {
1707: #endif
1708: #if defined(PETSC_PREFER_BZERO)
1709:       bzero((char *)a,n);
1710: #else
1711:       memset((char*)a,0,n);
1712: #endif
1713: #if defined(PETSC_PREFER_ZERO_FOR_MEMZERO) || defined(PETSC_PREFER_FORTRAN_FOR_MEMZERO)
1714:     }
1715: #endif
1716:   }
1717:   return 0;
1718: }

1720: /*MC
1721:    PetscPrefetchBlock - Prefetches a block of memory

1723:    Synopsis:
1724:     #include "petscsys.h"
1725:     void PetscPrefetchBlock(const anytype *a,size_t n,int rw,int t)

1727:    Not Collective

1729:    Input Parameters:
1730: +  a - pointer to first element to fetch (any type but usually PetscInt or PetscScalar)
1731: .  n - number of elements to fetch
1732: .  rw - 1 if the memory will be written to, otherwise 0 (ignored by many processors)
1733: -  t - temporal locality (PETSC_PREFETCH_HINT_{NTA,T0,T1,T2}), see note

1735:    Level: developer

1737:    Notes:
1738:    The last two arguments (rw and t) must be compile-time constants.

1740:    Adopting Intel's x86/x86-64 conventions, there are four levels of temporal locality.  Not all architectures offer
1741:    equivalent locality hints, but the following macros are always defined to their closest analogue.
1742: +  PETSC_PREFETCH_HINT_NTA - Non-temporal.  Prefetches directly to L1, evicts to memory (skips higher level cache unless it was already there when prefetched).
1743: .  PETSC_PREFETCH_HINT_T0 - Fetch to all levels of cache and evict to the closest level.  Use this when the memory will be reused regularly despite necessary eviction from L1.
1744: .  PETSC_PREFETCH_HINT_T1 - Fetch to level 2 and higher (not L1).
1745: -  PETSC_PREFETCH_HINT_T2 - Fetch to high-level cache only.  (On many systems, T0 and T1 are equivalent.)

1747:    This function does nothing on architectures that do not support prefetch and never errors (even if passed an invalid
1748:    address).

1750:    Concepts: memory
1751: M*/
1752: #define PetscPrefetchBlock(a,n,rw,t) do {                               \
1753:     const char *_p = (const char*)(a),*_end = (const char*)((a)+(n));   \
1754:     for ( ; _p < _end; _p += PETSC_LEVEL1_DCACHE_LINESIZE) PETSC_Prefetch(_p,(rw),(t)); \
1755:   } while (0)

1757: /*
1758:       Determine if some of the kernel computation routines use
1759:    Fortran (rather than C) for the numerical calculations. On some machines
1760:    and compilers (like complex numbers) the Fortran version of the routines
1761:    is faster than the C/C++ versions. The flag --with-fortran-kernels
1762:    should be used with ./configure to turn these on.
1763: */
1764: #if defined(PETSC_USE_FORTRAN_KERNELS)

1766: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTCRL)
1767: #define PETSC_USE_FORTRAN_KERNEL_MULTCRL
1768: #endif

1770: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJPERM)
1771: #define PETSC_USE_FORTRAN_KERNEL_MULTAIJPERM
1772: #endif

1774: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJ)
1775: #define PETSC_USE_FORTRAN_KERNEL_MULTAIJ
1776: #endif

1778: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ)
1779: #define PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ
1780: #endif

1782: #if !defined(PETSC_USE_FORTRAN_KERNEL_NORM)
1783: #define PETSC_USE_FORTRAN_KERNEL_NORM
1784: #endif

1786: #if !defined(PETSC_USE_FORTRAN_KERNEL_MAXPY)
1787: #define PETSC_USE_FORTRAN_KERNEL_MAXPY
1788: #endif

1790: #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ)
1791: #define PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ
1792: #endif

1794: #if !defined(PETSC_USE_FORTRAN_KERNEL_RELAXAIJ)
1795: #define PETSC_USE_FORTRAN_KERNEL_RELAXAIJ
1796: #endif

1798: #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ)
1799: #define PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ
1800: #endif

1802: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ)
1803: #define PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ
1804: #endif

1806: #if !defined(PETSC_USE_FORTRAN_KERNEL_MDOT)
1807: #define PETSC_USE_FORTRAN_KERNEL_MDOT
1808: #endif

1810: #if !defined(PETSC_USE_FORTRAN_KERNEL_XTIMESY)
1811: #define PETSC_USE_FORTRAN_KERNEL_XTIMESY
1812: #endif

1814: #if !defined(PETSC_USE_FORTRAN_KERNEL_AYPX)
1815: #define PETSC_USE_FORTRAN_KERNEL_AYPX
1816: #endif

1818: #if !defined(PETSC_USE_FORTRAN_KERNEL_WAXPY)
1819: #define PETSC_USE_FORTRAN_KERNEL_WAXPY
1820: #endif

1822: #endif

1824: /*
1825:     Macros for indicating code that should be compiled with a C interface,
1826:    rather than a C++ interface. Any routines that are dynamically loaded
1827:    (such as the PCCreate_XXX() routines) must be wrapped so that the name
1828:    mangler does not change the functions symbol name. This just hides the
1829:    ugly extern "C" {} wrappers.
1830: */
1831: #if defined(__cplusplus)
1832: #define EXTERN_C_BEGIN extern "C" {
1833: #define EXTERN_C_END }
1834: #else
1835: #define EXTERN_C_BEGIN
1836: #define EXTERN_C_END
1837: #endif

1839: /* --------------------------------------------------------------------*/

1841: /*MC
1842:     MPI_Comm - the basic object used by MPI to determine which processes are involved in a
1843:         communication

1845:    Level: beginner

1847:    Note: This manual page is a place-holder because MPICH does not have a manual page for MPI_Comm

1849: .seealso: PETSC_COMM_WORLD, PETSC_COMM_SELF
1850: M*/

1852: /*MC
1853:     PetscScalar - PETSc type that represents either a double precision real number, a double precision
1854:        complex number, a single precision real number, a long double or an int - if the code is configured
1855:        with --with-scalar-type=real,complex --with-precision=single,double,longdouble,int,matsingle


1858:    Level: beginner

1860: .seealso: PetscReal, PassiveReal, PassiveScalar, MPIU_SCALAR, PetscInt
1861: M*/

1863: /*MC
1864:     PetscComplex - PETSc type that represents a complex number with precision matching that of PetscReal.

1866:    Synopsis:
1867:    #define PETSC_DESIRE_COMPLEX
1868:    #include <petscsys.h>
1869:    PetscComplex number = 1. + 2.*PETSC_i;

1871:    Level: beginner

1873:    Note:
1874:    Complex numbers are automatically available if PETSc was configured --with-scalar-type=complex (in which case
1875:    PetscComplex will match PetscScalar), otherwise the macro PETSC_DESIRE_COMPLEX must be defined before including any
1876:    PETSc headers. If the compiler supports complex numbers, PetscComplex and associated variables and functions will be
1877:    defined and PETSC_HAVE_COMPLEX will be set.

1879: .seealso: PetscReal, PetscComplex, MPIU_COMPLEX, PetscInt, PETSC_i
1880: M*/

1882: /*MC
1883:     PetscReal - PETSc type that represents a real number version of PetscScalar

1885:    Level: beginner

1887: .seealso: PetscScalar, PassiveReal, PassiveScalar
1888: M*/

1890: /*MC
1891:     PassiveScalar - PETSc type that represents a PetscScalar
1892:    Level: beginner

1894:     This is the same as a PetscScalar except in code that is automatically differentiated it is
1895:    treated as a constant (not an indendent or dependent variable)

1897: .seealso: PetscReal, PassiveReal, PetscScalar
1898: M*/

1900: /*MC
1901:     PassiveReal - PETSc type that represents a PetscReal

1903:    Level: beginner

1905:     This is the same as a PetscReal except in code that is automatically differentiated it is
1906:    treated as a constant (not an indendent or dependent variable)

1908: .seealso: PetscScalar, PetscReal, PassiveScalar
1909: M*/

1911: /*MC
1912:     MPIU_SCALAR - MPI datatype corresponding to PetscScalar

1914:    Level: beginner

1916:     Note: In MPI calls that require an MPI datatype that matches a PetscScalar or array of PetscScalars
1917:           pass this value

1919: .seealso: PetscReal, PassiveReal, PassiveScalar, PetscScalar, MPIU_INT
1920: M*/

1922: #if defined(PETSC_HAVE_MPIIO)
1923: #if !defined(PETSC_WORDS_BIGENDIAN)
1924: PETSC_EXTERN PetscErrorCode MPIU_File_write_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*);
1925: PETSC_EXTERN PetscErrorCode MPIU_File_read_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*);
1926: #else
1927: #define MPIU_File_write_all(a,b,c,d,e) MPI_File_write_all(a,b,c,d,e)
1928: #define MPIU_File_read_all(a,b,c,d,e) MPI_File_read_all(a,b,c,d,e)
1929: #endif
1930: #endif

1932: /* the following petsc_static_inline require petscerror.h */

1934: /* Limit MPI to 32-bits */
1935: #define PETSC_MPI_INT_MAX  2147483647
1936: #define PETSC_MPI_INT_MIN -2147483647
1937: /* Limit BLAS to 32-bits */
1938: #define PETSC_BLAS_INT_MAX  2147483647
1939: #define PETSC_BLAS_INT_MIN -2147483647

1943: PETSC_STATIC_INLINE PetscErrorCode PetscBLASIntCast(PetscInt a,PetscBLASInt *b)
1944: {
1946: #if defined(PETSC_USE_64BIT_INDICES) && !defined(PETSC_HAVE_64BIT_BLAS_INDICES)
1947:   if ((a) > PETSC_BLAS_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array too long for BLAS/LAPACK");
1948: #endif
1949:   *b =  (PetscBLASInt)(a);
1950:   return(0);
1951: }

1955: PETSC_STATIC_INLINE PetscErrorCode PetscMPIIntCast(PetscInt a,PetscMPIInt *b)
1956: {
1958: #if defined(PETSC_USE_64BIT_INDICES)
1959:   if ((a) > PETSC_MPI_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array too long for MPI");
1960: #endif
1961:   *b =  (PetscMPIInt)(a);
1962:   return(0);
1963: }


1966: /*
1967:      The IBM include files define hz, here we hide it so that it may be used as a regular user variable.
1968: */
1969: #if defined(hz)
1970: #undef hz
1971: #endif

1973: /*  For arrays that contain filenames or paths */


1976: #if defined(PETSC_HAVE_LIMITS_H)
1977: #include <limits.h>
1978: #endif
1979: #if defined(PETSC_HAVE_SYS_PARAM_H)
1980: #include <sys/param.h>
1981: #endif
1982: #if defined(PETSC_HAVE_SYS_TYPES_H)
1983: #include <sys/types.h>
1984: #endif
1985: #if defined(MAXPATHLEN)
1986: #  define PETSC_MAX_PATH_LEN     MAXPATHLEN
1987: #elif defined(MAX_PATH)
1988: #  define PETSC_MAX_PATH_LEN     MAX_PATH
1989: #elif defined(_MAX_PATH)
1990: #  define PETSC_MAX_PATH_LEN     _MAX_PATH
1991: #else
1992: #  define PETSC_MAX_PATH_LEN     4096
1993: #endif

1995: /* Special support for C++ */
1996: #if defined(PETSC_CLANGUAGE_CXX) && defined(__cplusplus)
1997: #include <petscsys.hh>
1998: #endif

2000: /*MC

2002:     UsingFortran - Fortran can be used with PETSc in four distinct approaches

2004: $    1) classic Fortran 77 style
2005: $#include "finclude/petscXXX.h" to work with material from the XXX component of PETSc
2006: $       XXX variablename
2007: $      You cannot use this approach if you wish to use the Fortran 90 specific PETSc routines
2008: $      which end in F90; such as VecGetArrayF90()
2009: $
2010: $    2) classic Fortran 90 style
2011: $#include "finclude/petscXXX.h"
2012: $#include "finclude/petscXXX.h90" to work with material from the XXX component of PETSc
2013: $       XXX variablename
2014: $
2015: $    3) Using Fortran modules
2016: $#include "finclude/petscXXXdef.h"
2017: $         use petscXXXX
2018: $       XXX variablename
2019: $
2020: $    4) Use Fortran modules and Fortran data types for PETSc types
2021: $#include "finclude/petscXXXdef.h"
2022: $         use petscXXXX
2023: $       type(XXX) variablename
2024: $      To use this approach you must ./configure PETSc with the additional
2025: $      option --with-fortran-datatypes You cannot use the type(XXX) declaration approach without using Fortran modules

2027:     Finally if you absolutely do not want to use any #include you can use either

2029: $    3a) skip the #include BUT you cannot use any PETSc data type names like Vec, Mat, PetscInt, PetscErrorCode etc
2030: $        and you must declare the variables as integer, for example
2031: $        integer variablename
2032: $
2033: $    4a) skip the #include, you use the object types like type(Vec) type(Mat) but cannot use the data type
2034: $        names like PetscErrorCode, PetscInt etc. again for those you must use integer

2036:    We recommend either 2 or 3. Approaches 2 and 3 provide type checking for most PETSc function calls; 4 has type checking
2037: for only a few PETSc functions.

2039:    Fortran type checking with interfaces is strick, this means you cannot pass a scalar value when an array value
2040: is expected (even though it is legal Fortran). For example when setting a single value in a matrix with MatSetValues()
2041: you cannot have something like
2042: $      PetscInt row,col
2043: $      PetscScalar val
2044: $        ...
2045: $      call MatSetValues(mat,1,row,1,col,val,INSERT_VALUES,ierr)
2046: You must instead have
2047: $      PetscInt row(1),col(1)
2048: $      PetscScalar val(1)
2049: $        ...
2050: $      call MatSetValues(mat,1,row,1,col,val,INSERT_VALUES,ierr)


2053:     See the example src/vec/vec/examples/tutorials/ex20f90.F90 for an example that can use all four approaches

2055:     Developer Notes: The finclude/petscXXXdef.h contain all the #defines (would be typedefs in C code) these
2056:      automatically include their predecessors; for example finclude/petscvecdef.h includes finclude/petscisdef.h

2058:      The finclude/petscXXXX.h contain all the parameter statements for that package. These automatically include
2059:      their finclude/petscXXXdef.h file but DO NOT automatically include their predecessors;  for example
2060:      finclude/petscvec.h does NOT automatically include finclude/petscis.h

2062:      The finclude/ftn-custom/petscXXXdef.h90 are not intended to be used directly in code, they define the
2063:      Fortran data type type(XXX) (for example type(Vec)) when PETSc is ./configure with the --with-fortran-datatypes option.

2065:      The finclude/ftn-custom/petscXXX.h90 (not included directly by code) contain interface definitions for
2066:      the PETSc Fortran stubs that have different bindings then their C version (for example VecGetArrayF90).

2068:      The finclude/ftn-auto/petscXXX.h90 (not included directly by code) contain interface definitions generated
2069:      automatically by "make allfortranstubs".

2071:      The finclude/petscXXX.h90 includes the custom finclude/ftn-custom/petscXXX.h90 and if ./configure
2072:      was run with --with-fortran-interfaces it also includes the finclude/ftn-auto/petscXXX.h90 These DO NOT automatically
2073:      include their predecessors

2075:     Level: beginner

2077: M*/

2079: PETSC_EXTERN PetscErrorCode PetscGetArchType(char[],size_t);
2080: PETSC_EXTERN PetscErrorCode PetscGetHostName(char[],size_t);
2081: PETSC_EXTERN PetscErrorCode PetscGetUserName(char[],size_t);
2082: PETSC_EXTERN PetscErrorCode PetscGetProgramName(char[],size_t);
2083: PETSC_EXTERN PetscErrorCode PetscSetProgramName(const char[]);
2084: PETSC_EXTERN PetscErrorCode PetscGetDate(char[],size_t);
2085: PETSC_EXTERN PetscErrorCode PetscGetVersion(char[], size_t);

2087: PETSC_EXTERN PetscErrorCode PetscSortInt(PetscInt,PetscInt[]);
2088: PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsInt(PetscInt*,PetscInt[]);
2089: PETSC_EXTERN PetscErrorCode PetscFindInt(PetscInt, PetscInt, const PetscInt[], PetscInt*);
2090: PETSC_EXTERN PetscErrorCode PetscSortIntWithPermutation(PetscInt,const PetscInt[],PetscInt[]);
2091: PETSC_EXTERN PetscErrorCode PetscSortStrWithPermutation(PetscInt,const char*[],PetscInt[]);
2092: PETSC_EXTERN PetscErrorCode PetscSortIntWithArray(PetscInt,PetscInt[],PetscInt[]);
2093: PETSC_EXTERN PetscErrorCode PetscSortIntWithArrayPair(PetscInt,PetscInt*,PetscInt*,PetscInt*);
2094: PETSC_EXTERN PetscErrorCode PetscSortMPIInt(PetscInt,PetscMPIInt[]);
2095: PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsMPIInt(PetscInt*,PetscMPIInt[]);
2096: PETSC_EXTERN PetscErrorCode PetscSortMPIIntWithArray(PetscMPIInt,PetscMPIInt[],PetscMPIInt[]);
2097: PETSC_EXTERN PetscErrorCode PetscSortIntWithScalarArray(PetscInt,PetscInt[],PetscScalar[]);
2098: PETSC_EXTERN PetscErrorCode PetscSortReal(PetscInt,PetscReal[]);
2099: PETSC_EXTERN PetscErrorCode PetscSortRealWithPermutation(PetscInt,const PetscReal[],PetscInt[]);
2100: PETSC_EXTERN PetscErrorCode PetscSortSplit(PetscInt,PetscInt,PetscScalar[],PetscInt[]);
2101: PETSC_EXTERN PetscErrorCode PetscSortSplitReal(PetscInt,PetscInt,PetscReal[],PetscInt[]);
2102: PETSC_EXTERN PetscErrorCode PetscProcessTree(PetscInt,const PetscBool [],const PetscInt[],PetscInt*,PetscInt**,PetscInt**,PetscInt**,PetscInt**);
2103: PETSC_EXTERN PetscErrorCode PetscMergeIntArrayPair(PetscInt,const PetscInt*,const PetscInt*,PetscInt,const PetscInt*,const PetscInt*,PetscInt*,PetscInt**,PetscInt**);

2105: PETSC_EXTERN PetscErrorCode PetscSetDisplay(void);
2106: PETSC_EXTERN PetscErrorCode PetscGetDisplay(char[],size_t);

2108: /*J
2109:     PetscRandomType - String with the name of a PETSc randomizer

2111:    Level: beginner

2113:    Notes: to use the SPRNG you must have ./configure PETSc
2114:    with the option --download-sprng

2116: .seealso: PetscRandomSetType(), PetscRandom, PetscRandomCreate()
2117: J*/
2118: typedef const char* PetscRandomType;
2119: #define PETSCRAND       "rand"
2120: #define PETSCRAND48     "rand48"
2121: #define PETSCSPRNG      "sprng"

2123: /* Logging support */
2124: PETSC_EXTERN PetscClassId PETSC_RANDOM_CLASSID;

2126: PETSC_EXTERN PetscErrorCode PetscRandomInitializePackage(void);

2128: /*S
2129:      PetscRandom - Abstract PETSc object that manages generating random numbers

2131:    Level: intermediate

2133:   Concepts: random numbers

2135: .seealso:  PetscRandomCreate(), PetscRandomGetValue(), PetscRandomType
2136: S*/
2137: typedef struct _p_PetscRandom*   PetscRandom;

2139: /* Dynamic creation and loading functions */
2140: PETSC_EXTERN PetscFunctionList PetscRandomList;
2141: PETSC_EXTERN PetscBool         PetscRandomRegisterAllCalled;

2143: PETSC_EXTERN PetscErrorCode PetscRandomRegisterAll(void);
2144: PETSC_EXTERN PetscErrorCode PetscRandomRegister(const char[],PetscErrorCode (*)(PetscRandom));
2145: PETSC_EXTERN PetscErrorCode PetscRandomSetType(PetscRandom, PetscRandomType);
2146: PETSC_EXTERN PetscErrorCode PetscRandomSetFromOptions(PetscRandom);
2147: PETSC_EXTERN PetscErrorCode PetscRandomGetType(PetscRandom, PetscRandomType*);
2148:  PETSC_EXTERN PetscErrorCode PetscRandomViewFromOptions(PetscRandom,const char[],const char[]);
2149: PETSC_EXTERN PetscErrorCode PetscRandomView(PetscRandom,PetscViewer);

2151: PETSC_EXTERN PetscErrorCode PetscRandomCreate(MPI_Comm,PetscRandom*);
2152: PETSC_EXTERN PetscErrorCode PetscRandomGetValue(PetscRandom,PetscScalar*);
2153: PETSC_EXTERN PetscErrorCode PetscRandomGetValueReal(PetscRandom,PetscReal*);
2154: PETSC_EXTERN PetscErrorCode PetscRandomGetInterval(PetscRandom,PetscScalar*,PetscScalar*);
2155: PETSC_EXTERN PetscErrorCode PetscRandomSetInterval(PetscRandom,PetscScalar,PetscScalar);
2156: PETSC_EXTERN PetscErrorCode PetscRandomSetSeed(PetscRandom,unsigned long);
2157: PETSC_EXTERN PetscErrorCode PetscRandomGetSeed(PetscRandom,unsigned long *);
2158: PETSC_EXTERN PetscErrorCode PetscRandomSeed(PetscRandom);
2159: PETSC_EXTERN PetscErrorCode PetscRandomDestroy(PetscRandom*);

2161: PETSC_EXTERN PetscErrorCode PetscGetFullPath(const char[],char[],size_t);
2162: PETSC_EXTERN PetscErrorCode PetscGetRelativePath(const char[],char[],size_t);
2163: PETSC_EXTERN PetscErrorCode PetscGetWorkingDirectory(char[],size_t);
2164: PETSC_EXTERN PetscErrorCode PetscGetRealPath(const char[],char[]);
2165: PETSC_EXTERN PetscErrorCode PetscGetHomeDirectory(char[],size_t);
2166: PETSC_EXTERN PetscErrorCode PetscTestFile(const char[],char,PetscBool *);
2167: PETSC_EXTERN PetscErrorCode PetscTestDirectory(const char[],char,PetscBool *);

2169: PETSC_EXTERN PetscErrorCode PetscBinaryRead(int,void*,PetscInt,PetscDataType);
2170: PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedRead(MPI_Comm,int,void*,PetscInt,PetscDataType);
2171: PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedWrite(MPI_Comm,int,void*,PetscInt,PetscDataType,PetscBool );
2172: PETSC_EXTERN PetscErrorCode PetscBinaryWrite(int,void*,PetscInt,PetscDataType,PetscBool );
2173: PETSC_EXTERN PetscErrorCode PetscBinaryOpen(const char[],PetscFileMode,int *);
2174: PETSC_EXTERN PetscErrorCode PetscBinaryClose(int);
2175: PETSC_EXTERN PetscErrorCode PetscSharedTmp(MPI_Comm,PetscBool  *);
2176: PETSC_EXTERN PetscErrorCode PetscSharedWorkingDirectory(MPI_Comm,PetscBool  *);
2177: PETSC_EXTERN PetscErrorCode PetscGetTmp(MPI_Comm,char[],size_t);
2178: PETSC_EXTERN PetscErrorCode PetscFileRetrieve(MPI_Comm,const char[],char[],size_t,PetscBool *);
2179: PETSC_EXTERN PetscErrorCode PetscLs(MPI_Comm,const char[],char[],size_t,PetscBool *);
2180: PETSC_EXTERN PetscErrorCode PetscOpenSocket(char*,int,int*);
2181: PETSC_EXTERN PetscErrorCode PetscWebServe(MPI_Comm,int);

2183: /*
2184:    In binary files variables are stored using the following lengths,
2185:   regardless of how they are stored in memory on any one particular
2186:   machine. Use these rather then sizeof() in computing sizes for
2187:   PetscBinarySeek().
2188: */
2189: #define PETSC_BINARY_INT_SIZE   (32/8)
2190: #define PETSC_BINARY_FLOAT_SIZE  (32/8)
2191: #define PETSC_BINARY_CHAR_SIZE  (8/8)
2192: #define PETSC_BINARY_SHORT_SIZE  (16/8)
2193: #define PETSC_BINARY_DOUBLE_SIZE  (64/8)
2194: #define PETSC_BINARY_SCALAR_SIZE  sizeof(PetscScalar)

2196: /*E
2197:   PetscBinarySeekType - argument to PetscBinarySeek()

2199:   Level: advanced

2201: .seealso: PetscBinarySeek(), PetscBinarySynchronizedSeek()
2202: E*/
2203: typedef enum {PETSC_BINARY_SEEK_SET = 0,PETSC_BINARY_SEEK_CUR = 1,PETSC_BINARY_SEEK_END = 2} PetscBinarySeekType;
2204: PETSC_EXTERN PetscErrorCode PetscBinarySeek(int,off_t,PetscBinarySeekType,off_t*);
2205: PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedSeek(MPI_Comm,int,off_t,PetscBinarySeekType,off_t*);
2206: PETSC_EXTERN PetscErrorCode PetscByteSwap(void *,PetscDataType,PetscInt);

2208: PETSC_EXTERN PetscErrorCode PetscSetDebugTerminal(const char[]);
2209: PETSC_EXTERN PetscErrorCode PetscSetDebugger(const char[],PetscBool );
2210: PETSC_EXTERN PetscErrorCode PetscSetDefaultDebugger(void);
2211: PETSC_EXTERN PetscErrorCode PetscSetDebuggerFromString(const char*);
2212: PETSC_EXTERN PetscErrorCode PetscAttachDebugger(void);
2213: PETSC_EXTERN PetscErrorCode PetscStopForDebugger(void);

2215: PETSC_EXTERN PetscErrorCode PetscGatherNumberOfMessages(MPI_Comm,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt*);
2216: PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**);
2217: PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths2(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**,PetscMPIInt**);
2218: PETSC_EXTERN PetscErrorCode PetscPostIrecvInt(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscInt***,MPI_Request**);
2219: PETSC_EXTERN PetscErrorCode PetscPostIrecvScalar(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscScalar***,MPI_Request**);
2220: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSided(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscInt,const PetscMPIInt*,const void*,PetscInt*,PetscMPIInt**,void*) PetscAttrMPIPointerWithType(6,3);

2222: /*E
2223:     PetscBuildTwoSidedType - algorithm for setting up two-sided communication

2225: $  PETSC_BUILDTWOSIDED_ALLREDUCE - classical algorithm using an MPI_Allreduce with
2226: $      a buffer of length equal to the communicator size. Not memory-scalable due to
2227: $      the large reduction size. Requires only MPI-1.
2228: $  PETSC_BUILDTWOSIDED_IBARRIER - nonblocking algorithm based on MPI_Issend and MPI_Ibarrier.
2229: $      Proved communication-optimal in Hoefler, Siebert, and Lumsdaine (2010). Requires MPI-3.

2231:    Level: developer

2233: .seealso: PetscCommBuildTwoSided(), PetscCommBuildTwoSidedSetType(), PetscCommBuildTwoSidedGetType()
2234: E*/
2235: typedef enum {
2236:   PETSC_BUILDTWOSIDED_NOTSET = -1,
2237:   PETSC_BUILDTWOSIDED_ALLREDUCE = 0,
2238:   PETSC_BUILDTWOSIDED_IBARRIER = 1
2239:   /* Updates here must be accompanied by updates in finclude/petscsys.h and the string array in mpits.c */
2240: } PetscBuildTwoSidedType;
2241: PETSC_EXTERN const char *const PetscBuildTwoSidedTypes[];
2242: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedSetType(MPI_Comm,PetscBuildTwoSidedType);
2243: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedGetType(MPI_Comm,PetscBuildTwoSidedType*);

2245: PETSC_EXTERN PetscErrorCode PetscSSEIsEnabled(MPI_Comm,PetscBool  *,PetscBool  *);

2247: /*E
2248:   InsertMode - Whether entries are inserted or added into vectors or matrices

2250:   Level: beginner

2252: .seealso: VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(),
2253:           VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(),
2254:           MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd()
2255: E*/
2256:  typedef enum {NOT_SET_VALUES, INSERT_VALUES, ADD_VALUES, MAX_VALUES, INSERT_ALL_VALUES, ADD_ALL_VALUES, INSERT_BC_VALUES, ADD_BC_VALUES} InsertMode;

2258: /*MC
2259:     INSERT_VALUES - Put a value into a vector or matrix, overwrites any previous value

2261:     Level: beginner

2263: .seealso: InsertMode, VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(),
2264:           VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), ADD_VALUES,
2265:           MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd(), MAX_VALUES

2267: M*/

2269: /*MC
2270:     ADD_VALUES - Adds a value into a vector or matrix, if there previously was no value, just puts the
2271:                 value into that location

2273:     Level: beginner

2275: .seealso: InsertMode, VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(),
2276:           VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), INSERT_VALUES,
2277:           MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd(), MAX_VALUES

2279: M*/

2281: /*MC
2282:     MAX_VALUES - Puts the maximum of the scattered/gathered value and the current value into each location

2284:     Level: beginner

2286: .seealso: InsertMode, VecScatterBegin(), VecScatterEnd(), ADD_VALUES, INSERT_VALUES

2288: M*/

2290: PETSC_EXTERN MPI_Comm PetscObjectComm(PetscObject);

2292: /*S
2293:    PetscSubcomm - Context of MPI subcommunicators, used by PCREDUNDANT

2295:    Level: advanced

2297:    Concepts: communicator, create
2298: S*/
2299: typedef struct _n_PetscSubcomm* PetscSubcomm;

2301: struct _n_PetscSubcomm {
2302:   MPI_Comm   parent;      /* parent communicator */
2303:   MPI_Comm   dupparent;   /* duplicate parent communicator, under which the processors of this subcomm have contiguous rank */
2304:   MPI_Comm   comm;        /* this communicator */
2305:   PetscInt   n;           /* num of subcommunicators under the parent communicator */
2306:   PetscInt   color;       /* color of processors belong to this communicator */
2307: };

2309: typedef enum {PETSC_SUBCOMM_GENERAL=0,PETSC_SUBCOMM_CONTIGUOUS=1,PETSC_SUBCOMM_INTERLACED=2} PetscSubcommType;
2310: PETSC_EXTERN const char *const PetscSubcommTypes[];

2312: PETSC_EXTERN PetscErrorCode PetscSubcommCreate(MPI_Comm,PetscSubcomm*);
2313: PETSC_EXTERN PetscErrorCode PetscSubcommDestroy(PetscSubcomm*);
2314: PETSC_EXTERN PetscErrorCode PetscSubcommSetNumber(PetscSubcomm,PetscInt);
2315: PETSC_EXTERN PetscErrorCode PetscSubcommSetType(PetscSubcomm,PetscSubcommType);
2316: PETSC_EXTERN PetscErrorCode PetscSubcommSetTypeGeneral(PetscSubcomm,PetscMPIInt,PetscMPIInt,PetscMPIInt);

2318: /*S
2319:    PetscSegBuffer - a segmented extendable buffer

2321:    Level: developer

2323: .seealso: PetscSegBufferCreate(), PetscSegBufferGet(), PetscSegBufferExtract(), PetscSegBufferDestroy()
2324: S*/
2325: typedef struct _n_PetscSegBuffer *PetscSegBuffer;
2326: PETSC_EXTERN PetscErrorCode PetscSegBufferCreate(size_t,size_t,PetscSegBuffer*);
2327: PETSC_EXTERN PetscErrorCode PetscSegBufferDestroy(PetscSegBuffer*);
2328: PETSC_EXTERN PetscErrorCode PetscSegBufferGet(PetscSegBuffer,size_t,void*);
2329: PETSC_EXTERN PetscErrorCode PetscSegBufferExtractAlloc(PetscSegBuffer,void*);
2330: PETSC_EXTERN PetscErrorCode PetscSegBufferExtractTo(PetscSegBuffer,void*);
2331: PETSC_EXTERN PetscErrorCode PetscSegBufferExtractInPlace(PetscSegBuffer,void*);
2332: PETSC_EXTERN PetscErrorCode PetscSegBufferGetSize(PetscSegBuffer,size_t*);
2333: PETSC_EXTERN PetscErrorCode PetscSegBufferUnuse(PetscSegBuffer,size_t);

2336:  * prevents the compiler from completely erasing the stub. This is called in inner loops so it has to be as fast as
2337:  * possible. */
2338: PETSC_STATIC_INLINE PetscErrorCode PetscSegBufferGetInts(PetscSegBuffer seg,PetscInt count,PetscInt *PETSC_RESTRICT *slot) {return PetscSegBufferGet(seg,count,(void**)slot);}

2340: /* Reset __FUNCT__ in case the user does not define it themselves */

2344: #endif