Actual source code: petscsys.h

petsc-dev 2014-02-02
Report Typos and Errors
  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: #if defined(PETSC_HAVE_STDINT_H)
182: #include <stdint.h>
183: #endif

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

190:    Level: intermediate

192: .seealso: PetscScalar, PetscBLASInt, PetscMPIInt
193: M*/
194: #if defined(PETSC_HAVE_STDINT_H)
195: typedef int64_t Petsc64bitInt;
196: #elif (PETSC_SIZEOF_LONG_LONG == 8)
197: typedef long long Petsc64bitInt;
198: #elif defined(PETSC_HAVE___INT64)
199: typedef __int64 Petsc64bitInt;
200: #else
201: typedef unknown64bit Petsc64bitInt
202: #endif
203: #if defined(PETSC_USE_64BIT_INDICES)
204: typedef Petsc64bitInt PetscInt;
205: #  if defined(PETSC_HAVE_MPI_INT64_T) /* MPI_INT64_T is not guaranteed to be a macro */
206: #    define MPIU_INT MPI_INT64_T
207: #  else
208: #    define MPIU_INT MPI_LONG_LONG_INT
209: #  endif
210: #else
211: typedef int PetscInt;
212: #define MPIU_INT MPI_INT
213: #endif


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

219:     Level: intermediate

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

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

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

233:         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

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

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

240: .seealso: PetscMPIInt, PetscInt

242: M*/
243: #if defined(PETSC_HAVE_64BIT_BLAS_INDICES)
244: typedef Petsc64bitInt PetscBLASInt;
245: #else
246: typedef int PetscBLASInt;
247: #endif

249: /*EC

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

253:     Level: advanced

255: .seealso: PetscObjectSetPrecision()
256: E*/
257: typedef enum { PETSC_PRECISION_SINGLE=4,PETSC_PRECISION_DOUBLE=8 } PetscPrecision;
258: PETSC_EXTERN const char *PetscPrecisions[];

260: /*
261:     For the rare cases when one needs to send a size_t object with MPI
262: */
263: #if (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_INT)
264: #define MPIU_SIZE_T MPI_UNSIGNED
265: #elif  (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_LONG)
266: #define MPIU_SIZE_T MPI_UNSIGNED_LONG
267: #elif  (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_LONG_LONG)
268: #define MPIU_SIZE_T MPI_UNSIGNED_LONG_LONG
269: #else
270: #error "Unknown size for size_t! Send us a bugreport at petsc-maint@mcs.anl.gov"
271: #endif


274: /*
275:       You can use PETSC_STDOUT as a replacement of stdout. You can also change
276:     the value of PETSC_STDOUT to redirect all standard output elsewhere
277: */
278: PETSC_EXTERN FILE* PETSC_STDOUT;

280: /*
281:       You can use PETSC_STDERR as a replacement of stderr. You can also change
282:     the value of PETSC_STDERR to redirect all standard error elsewhere
283: */
284: PETSC_EXTERN FILE* PETSC_STDERR;

286: /*MC
287:     PetscUnlikely - hints the compiler that the given condition is usually FALSE

289:     Synopsis:
290:     #include <petscsys.h>
291:     PetscBool  PetscUnlikely(PetscBool  cond)

293:     Not Collective

295:     Input Parameters:
296: .   cond - condition or expression

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

301:     Level: advanced

303: .seealso: PetscLikely(), CHKERRQ
304: M*/

306: /*MC
307:     PetscLikely - hints the compiler that the given condition is usually TRUE

309:     Synopsis:
310:     #include <petscsys.h>
311:     PetscBool  PetscUnlikely(PetscBool  cond)

313:     Not Collective

315:     Input Parameters:
316: .   cond - condition or expression

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

321:     Level: advanced

323: .seealso: PetscUnlikely()
324: M*/
325: #if defined(PETSC_HAVE_BUILTIN_EXPECT)
326: #  define PetscUnlikely(cond)   __builtin_expect(!!(cond),0)
327: #  define PetscLikely(cond)     __builtin_expect(!!(cond),1)
328: #else
329: #  define PetscUnlikely(cond)   (cond)
330: #  define PetscLikely(cond)     (cond)
331: #endif

333: /*
334:     Declare extern C stuff after including external header files
335: */


338: /*
339:        Basic PETSc constants
340: */

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

345:    Level: beginner

347:    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
348:       boolean values. It is not easy to have a simple macro that that will work properly in all circumstances with all three mechanisms.

350: E*/
351: typedef enum { PETSC_FALSE,PETSC_TRUE } PetscBool;
352: PETSC_EXTERN const char *const PetscBools[];
353: PETSC_EXTERN MPI_Datatype MPIU_BOOL PetscAttrMPITypeTag(PetscBool);

355: /*
356:     Defines some elementary mathematics functions and constants.
357: */
358: #include <petscmath.h>

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

363:    Level: beginner

365: $   PETSC_COPY_VALUES - the array values are copied into new space, the user is free to reuse or delete the passed in array
366: $   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
367: $                       delete the array. The array MUST have been obtained with PetscMalloc(). Hence this mode cannot be used in Fortran.
368: $   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
369:                         the array but the user must delete the array after the object is destroyed.

371: E*/
372: typedef enum { PETSC_COPY_VALUES, PETSC_OWN_POINTER, PETSC_USE_POINTER} PetscCopyMode;
373: PETSC_EXTERN const char *const PetscCopyModes[];

375: /*MC
376:     PETSC_FALSE - False value of PetscBool

378:     Level: beginner

380:     Note: Zero integer

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

385: /*MC
386:     PETSC_TRUE - True value of PetscBool

388:     Level: beginner

390:     Note: Nonzero integer

392: .seealso: PetscBool , PETSC_FALSE
393: M*/

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

398:    Level: beginner

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

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

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

408: M*/
409: #define PETSC_NULL           NULL

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

414:    Level: beginner

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

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

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

424: M*/
425: #define PETSC_IGNORE         NULL

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

431:    Level: beginner

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

435: M*/
436: #define PETSC_DECIDE  -1

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

442:    Level: beginner


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

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

450: M*/
451: #define PETSC_DETERMINE PETSC_DECIDE

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

457:    Level: beginner

459:    Fortran Notes: You need to use PETSC_DEFAULT_INTEGER or PETSC_DEFAULT_REAL.

461: .seealso: PETSC_DECIDE, PETSC_IGNORE, PETSC_DETERMINE

463: M*/
464: #define PETSC_DEFAULT  -2

466: /*MC
467:     PETSC_COMM_WORLD - the equivalent of the MPI_COMM_WORLD communicator which represents
468:            all the processs that PETSc knows about.

470:    Level: beginner

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

477: .seealso: PETSC_COMM_SELF

479: M*/
480: PETSC_EXTERN MPI_Comm PETSC_COMM_WORLD;

482: /*MC
483:     PETSC_COMM_SELF - This is always MPI_COMM_SELF

485:    Level: beginner

487: .seealso: PETSC_COMM_WORLD

489: M*/
490: #define PETSC_COMM_SELF MPI_COMM_SELF

492: PETSC_EXTERN PetscBool PetscBeganMPI;
493: PETSC_EXTERN PetscBool PetscInitializeCalled;
494: PETSC_EXTERN PetscBool PetscFinalizeCalled;
495: PETSC_EXTERN PetscBool PetscCUSPSynchronize;
496: PETSC_EXTERN PetscBool PetscViennaCLSynchronize;

498: PETSC_EXTERN PetscErrorCode PetscSetHelpVersionFunctions(PetscErrorCode (*)(MPI_Comm),PetscErrorCode (*)(MPI_Comm));
499: PETSC_EXTERN PetscErrorCode PetscCommDuplicate(MPI_Comm,MPI_Comm*,int*);
500: PETSC_EXTERN PetscErrorCode PetscCommDestroy(MPI_Comm*);

502: /*MC
503:    PetscMalloc - Allocates memory

505:    Synopsis:
506:     #include <petscsys.h>
507:    PetscErrorCode PetscMalloc(size_t m,void **result)

509:    Not Collective

511:    Input Parameter:
512: .  m - number of bytes to allocate

514:    Output Parameter:
515: .  result - memory allocated

517:    Level: beginner

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

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

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

526:   Concepts: memory allocation

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

531: /*MC
532:    PetscAddrAlign - Rounds up an address to PETSC_MEMALIGN alignment

534:    Synopsis:
535:     #include <petscsys.h>
536:    void *PetscAddrAlign(void *addr)

538:    Not Collective

540:    Input Parameters:
541: .  addr - address to align (any pointer type)

543:    Level: developer

545: .seealso: PetscMallocAlign()

547:   Concepts: memory allocation
548: M*/
549: #define PetscAddrAlign(a) (void*)((((PETSC_UINTPTR_T)(a))+(PETSC_MEMALIGN-1)) & ~(PETSC_MEMALIGN-1))

551: /*MC
552:    PetscMalloc1 - Allocates an array of memory aligned to PETSC_MEMALIGN

554:    Synopsis:
555:     #include <petscsys.h>
556:    PetscErrorCode PetscMalloc1(size_t m1,type **r1)

558:    Not Collective

560:    Input Parameter:
561: .  m1 - number of elements to allocate in 1st chunk  (may be zero)

563:    Output Parameter:
564: .  r1 - memory allocated in first chunk

566:    Level: developer

568: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscCalloc1(), PetscMalloc2()

570:   Concepts: memory allocation

572: M*/
573: #define PetscMalloc1(m1,r1) PetscMalloc((m1)*sizeof(**(r1)),r1)

575: /*MC
576:    PetscCalloc1 - Allocates a cleared (zeroed) array of memory aligned to PETSC_MEMALIGN

578:    Synopsis:
579:     #include <petscsys.h>
580:    PetscErrorCode PetscCalloc1(size_t m1,type **r1)

582:    Not Collective

584:    Input Parameter:
585: .  m1 - number of elements to allocate in 1st chunk  (may be zero)

587:    Output Parameter:
588: .  r1 - memory allocated in first chunk

590:    Level: developer

592: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc1(), PetscCalloc2()

594:   Concepts: memory allocation

596: M*/
597: #define PetscCalloc1(m1,r1) (PetscMalloc1((m1),r1) || PetscMemzero(*(r1),(m1)*sizeof(**(r1))))

599: /*MC
600:    PetscMalloc2 - Allocates 2 arrays of memory both aligned to PETSC_MEMALIGN

602:    Synopsis:
603:     #include <petscsys.h>
604:    PetscErrorCode PetscMalloc2(size_t m1,type **r1,size_t m2,type **r2)

606:    Not Collective

608:    Input Parameter:
609: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
610: -  m2 - number of elements to allocate in 2nd chunk  (may be zero)

612:    Output Parameter:
613: +  r1 - memory allocated in first chunk
614: -  r2 - memory allocated in second chunk

616:    Level: developer

618: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc1(), PetscCalloc2()

620:   Concepts: memory allocation

622: M*/
623: #if defined(PETSC_USE_DEBUG)
624: #define PetscMalloc2(m1,r1,m2,r2) (PetscMalloc((m1)*sizeof(**(r1)),r1) || PetscMalloc((m2)*sizeof(**(r2)),r2))
625: #else
626: #define PetscMalloc2(m1,r1,m2,r2) ((*(r2) = 0,PetscMalloc((m1)*sizeof(**(r1))+(m2)*sizeof(**(r2))+(PETSC_MEMALIGN-1),r1)) || (*(void**)(r2) = PetscAddrAlign(*(r1)+(m1)),0))
627: #endif

629: /*MC
630:    PetscCalloc2 - Allocates 2 cleared (zeroed) arrays of memory both aligned to PETSC_MEMALIGN

632:    Synopsis:
633:     #include <petscsys.h>
634:    PetscErrorCode PetscCalloc2(size_t m1,type **r1,size_t m2,type **r2)

636:    Not Collective

638:    Input Parameter:
639: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
640: -  m2 - number of elements to allocate in 2nd chunk  (may be zero)

642:    Output Parameter:
643: +  r1 - memory allocated in first chunk
644: -  r2 - memory allocated in second chunk

646:    Level: developer

648: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscCalloc1(), PetscMalloc2()

650:   Concepts: memory allocation
651: M*/
652: #define PetscCalloc2(m1,r1,m2,r2) (PetscMalloc2((m1),(r1),(m2),(r2)) || PetscMemzero(*(r1),(m1)*sizeof(**(r1))) || PetscMemzero(*(r2),(m2)*sizeof(**(r2))))

654: /*MC
655:    PetscMalloc3 - Allocates 3 arrays of memory, all aligned to PETSC_MEMALIGN

657:    Synopsis:
658:     #include <petscsys.h>
659:    PetscErrorCode PetscMalloc3(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3)

661:    Not Collective

663:    Input Parameter:
664: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
665: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
666: -  m3 - number of elements to allocate in 3rd chunk  (may be zero)

668:    Output Parameter:
669: +  r1 - memory allocated in first chunk
670: .  r2 - memory allocated in second chunk
671: -  r3 - memory allocated in third chunk

673:    Level: developer

675: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc3(), PetscFree3()

677:   Concepts: memory allocation

679: M*/
680: #if defined(PETSC_USE_DEBUG)
681: #define PetscMalloc3(m1,r1,m2,r2,m3,r3) (PetscMalloc((m1)*sizeof(**(r1)),r1) || PetscMalloc((m2)*sizeof(**(r2)),r2) || PetscMalloc((m3)*sizeof(**(r3)),r3))
682: #else
683: #define PetscMalloc3(m1,r1,m2,r2,m3,r3) ((*(r2) = 0,*(r3) = 0,PetscMalloc((m1)*sizeof(**(r1))+(m2)*sizeof(**(r2))+(m3)*sizeof(**(r3))+2*(PETSC_MEMALIGN-1),r1)) \
684:                                          || (*(void**)(r2) = PetscAddrAlign(*(r1)+(m1)),*(void**)(r3) = PetscAddrAlign(*(r2)+(m2)),0))
685: #endif

687: /*MC
688:    PetscCalloc3 - Allocates 3 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN

690:    Synopsis:
691:     #include <petscsys.h>
692:    PetscErrorCode PetscCalloc3(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3)

694:    Not Collective

696:    Input Parameter:
697: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
698: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
699: -  m3 - number of elements to allocate in 3rd chunk  (may be zero)

701:    Output Parameter:
702: +  r1 - memory allocated in first chunk
703: .  r2 - memory allocated in second chunk
704: -  r3 - memory allocated in third chunk

706:    Level: developer

708: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscCalloc2(), PetscMalloc3(), PetscFree3()

710:   Concepts: memory allocation
711: M*/
712: #define PetscCalloc3(m1,r1,m2,r2,m3,r3)                                 \
713:   (PetscMalloc3((m1),(r1),(m2),(r2),(m3),(r3))                          \
714:    || PetscMemzero(*(r1),(m1)*sizeof(**(r1))) || PetscMemzero(*(r2),(m2)*sizeof(**(r2))) || PetscMemzero(*(r3),(m3)*sizeof(**(r3))))

716: /*MC
717:    PetscMalloc4 - Allocates 4 arrays of memory, all aligned to PETSC_MEMALIGN

719:    Synopsis:
720:     #include <petscsys.h>
721:    PetscErrorCode PetscMalloc4(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4)

723:    Not Collective

725:    Input Parameter:
726: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
727: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
728: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
729: -  m4 - number of elements to allocate in 4th chunk  (may be zero)

731:    Output Parameter:
732: +  r1 - memory allocated in first chunk
733: .  r2 - memory allocated in second chunk
734: .  r3 - memory allocated in third chunk
735: -  r4 - memory allocated in fourth chunk

737:    Level: developer

739: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc4(), PetscFree4()

741:   Concepts: memory allocation

743: M*/
744: #if defined(PETSC_USE_DEBUG)
745: #define PetscMalloc4(m1,r1,m2,r2,m3,r3,m4,r4) (PetscMalloc((m1)*sizeof(**(r1)),r1) || PetscMalloc((m2)*sizeof(**(r2)),r2) || PetscMalloc((m3)*sizeof(**(r3)),r3) || PetscMalloc((m4)*sizeof(**(r4)),r4))
746: #else
747: #define PetscMalloc4(m1,r1,m2,r2,m3,r3,m4,r4)                           \
748:   ((*(r2) = 0, *(r3) = 0, *(r4) = 0,PetscMalloc((m1)*sizeof(**(r1))+(m2)*sizeof(**(r2))+(m3)*sizeof(**(r3))+(m4)*sizeof(**(r4))+3*(PETSC_MEMALIGN-1),r1)) \
749:    || (*(void**)(r2) = PetscAddrAlign(*(r1)+(m1)),*(void**)(r3) = PetscAddrAlign(*(r2)+(m2)),*(void**)(r4) = PetscAddrAlign(*(r3)+(m3)),0))
750: #endif

752: /*MC
753:    PetscCalloc4 - Allocates 4 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN

755:    Synopsis:
756:     #include <petscsys.h>
757:    PetscErrorCode PetscCalloc4(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4)

759:    Not Collective

761:    Input Parameter:
762: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
763: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
764: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
765: -  m4 - number of elements to allocate in 4th chunk  (may be zero)

767:    Output Parameter:
768: +  r1 - memory allocated in first chunk
769: .  r2 - memory allocated in second chunk
770: .  r3 - memory allocated in third chunk
771: -  r4 - memory allocated in fourth chunk

773:    Level: developer

775: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc4(), PetscFree4()

777:   Concepts: memory allocation

779: M*/
780: #define PetscCalloc4(m1,r1,m2,r2,m3,r3,m4,r4)                           \
781:   (PetscMalloc4(m1,r1,m2,r2,m3,r3,m4,r4)                                \
782:    || PetscMemzero(*(r1),(m1)*sizeof(**(r1))) || PetscMemzero(*(r2),(m2)*sizeof(**(r2))) || PetscMemzero(*(r3),(m3)*sizeof(**(r3))) \
783:    || PetscMemzero(*(r4),(m4)*sizeof(**(r4))))

785: /*MC
786:    PetscMalloc5 - Allocates 5 arrays of memory, all aligned to PETSC_MEMALIGN

788:    Synopsis:
789:     #include <petscsys.h>
790:    PetscErrorCode PetscMalloc5(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4,size_t m5,type **r5)

792:    Not Collective

794:    Input Parameter:
795: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
796: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
797: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
798: .  m4 - number of elements to allocate in 4th chunk  (may be zero)
799: -  m5 - number of elements to allocate in 5th chunk  (may be zero)

801:    Output Parameter:
802: +  r1 - memory allocated in first chunk
803: .  r2 - memory allocated in second chunk
804: .  r3 - memory allocated in third chunk
805: .  r4 - memory allocated in fourth chunk
806: -  r5 - memory allocated in fifth chunk

808:    Level: developer

810: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc5(), PetscFree5()

812:   Concepts: memory allocation

814: M*/
815: #if defined(PETSC_USE_DEBUG)
816: #define PetscMalloc5(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5) (PetscMalloc((m1)*sizeof(**(r1)),r1) || PetscMalloc((m2)*sizeof(**(r2)),r2) || PetscMalloc((m3)*sizeof(**(r3)),r3) || PetscMalloc((m4)*sizeof(**(r4)),r4) || PetscMalloc((m5)*sizeof(**(r5)),r5))
817: #else
818: #define PetscMalloc5(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5)      \
819:   ((*(r2) = 0, *(r3) = 0, *(r4) = 0,*(r5) = 0,PetscMalloc((m1)*sizeof(**(r1))+(m2)*sizeof(**(r2))+(m3)*sizeof(**(r3))+(m4)*sizeof(**(r4))+(m5)*sizeof(**(r5))+4*(PETSC_MEMALIGN-1),r1)) \
820:    || (*(void**)(r2) = PetscAddrAlign(*(r1)+(m1)),*(void**)(r3) = PetscAddrAlign(*(r2)+(m2)),*(void**)(r4) = PetscAddrAlign(*(r3)+(m3)),*(void**)(r5) = PetscAddrAlign(*(r4)+(m4)),0))
821: #endif

823: /*MC
824:    PetscCalloc5 - Allocates 5 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN

826:    Synopsis:
827:     #include <petscsys.h>
828:    PetscErrorCode PetscCalloc5(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4,size_t m5,type **r5)

830:    Not Collective

832:    Input Parameter:
833: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
834: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
835: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
836: .  m4 - number of elements to allocate in 4th chunk  (may be zero)
837: -  m5 - number of elements to allocate in 5th chunk  (may be zero)

839:    Output Parameter:
840: +  r1 - memory allocated in first chunk
841: .  r2 - memory allocated in second chunk
842: .  r3 - memory allocated in third chunk
843: .  r4 - memory allocated in fourth chunk
844: -  r5 - memory allocated in fifth chunk

846:    Level: developer

848: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc5(), PetscFree5()

850:   Concepts: memory allocation

852: M*/
853: #define PetscCalloc5(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5)                     \
854:   (PetscMalloc5(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5)                          \
855:    || PetscMemzero(*(r1),(m1)*sizeof(**(r1))) || PetscMemzero(*(r2),(m2)*sizeof(**(r2))) || PetscMemzero(*(r3),(m3)*sizeof(**(r3))) \
856:    || PetscMemzero(*(r4),(m4)*sizeof(**(r4))) || PetscMemzero(*(r5),(m5)*sizeof(**(r5))))

858: /*MC
859:    PetscMalloc6 - Allocates 6 arrays of memory, all aligned to PETSC_MEMALIGN

861:    Synopsis:
862:     #include <petscsys.h>
863:    PetscErrorCode PetscMalloc6(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4,size_t m5,type **r5,size_t m6,type **r6)

865:    Not Collective

867:    Input Parameter:
868: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
869: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
870: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
871: .  m4 - number of elements to allocate in 4th chunk  (may be zero)
872: .  m5 - number of elements to allocate in 5th chunk  (may be zero)
873: -  m6 - number of elements to allocate in 6th chunk  (may be zero)

875:    Output Parameter:
876: +  r1 - memory allocated in first chunk
877: .  r2 - memory allocated in second chunk
878: .  r3 - memory allocated in third chunk
879: .  r4 - memory allocated in fourth chunk
880: .  r5 - memory allocated in fifth chunk
881: -  r6 - memory allocated in sixth chunk

883:    Level: developer

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

887:   Concepts: memory allocation

889: M*/
890: #if defined(PETSC_USE_DEBUG)
891: #define PetscMalloc6(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6) (PetscMalloc((m1)*sizeof(**(r1)),r1) || PetscMalloc((m2)*sizeof(**(r2)),r2) || PetscMalloc((m3)*sizeof(**(r3)),r3) || PetscMalloc((m4)*sizeof(**(r4)),r4) || PetscMalloc((m5)*sizeof(**(r5)),r5) || PetscMalloc((m6)*sizeof(**(r6)),r6))
892: #else
893: #define PetscMalloc6(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6) \
894:   ((*(r2) = 0, *(r3) = 0, *(r4) = 0,*(r5) = 0,*(r6) = 0,PetscMalloc((m1)*sizeof(**(r1))+(m2)*sizeof(**(r2))+(m3)*sizeof(**(r3))+(m4)*sizeof(**(r4))+(m5)*sizeof(**(r5))+(m6)*sizeof(**(r6))+5*(PETSC_MEMALIGN-1),r1)) \
895:    || (*(void**)(r2) = PetscAddrAlign(*(r1)+(m1)),*(void**)(r3) = PetscAddrAlign(*(r2)+(m2)),*(void**)(r4) = PetscAddrAlign(*(r3)+(m3)),*(void**)(r5) = PetscAddrAlign(*(r4)+(m4)),*(void**)(r6) = PetscAddrAlign(*(r5)+(m5)),0))
896: #endif

898: /*MC
899:    PetscCalloc6 - Allocates 6 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN

901:    Synopsis:
902:     #include <petscsys.h>
903:    PetscErrorCode PetscCalloc6(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4,size_t m5,type **r5,size_t m6,type **r6)

905:    Not Collective

907:    Input Parameter:
908: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
909: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
910: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
911: .  m4 - number of elements to allocate in 4th chunk  (may be zero)
912: .  m5 - number of elements to allocate in 5th chunk  (may be zero)
913: -  m6 - number of elements to allocate in 6th chunk  (may be zero)

915:    Output Parameter:
916: +  r1 - memory allocated in first chunk
917: .  r2 - memory allocated in second chunk
918: .  r3 - memory allocated in third chunk
919: .  r4 - memory allocated in fourth chunk
920: .  r5 - memory allocated in fifth chunk
921: -  r6 - memory allocated in sixth chunk

923:    Level: developer

925: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscMalloc6(), PetscFree6()

927:   Concepts: memory allocation
928: M*/
929: #define PetscCalloc6(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6)               \
930:   (PetscMalloc6(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6)                    \
931:    || PetscMemzero(*(r1),(m1)*sizeof(**(r1))) || PetscMemzero(*(r2),(m2)*sizeof(**(r2))) || PetscMemzero(*(r3),(m3)*sizeof(**(r3))) \
932:    || PetscMemzero(*(r4),(m4)*sizeof(**(r4))) || PetscMemzero(*(r5),(m5)*sizeof(**(r5))) || PetscMemzero(*(r6),(m6)*sizeof(**(r6))))

934: /*MC
935:    PetscMalloc7 - Allocates 7 arrays of memory, all aligned to PETSC_MEMALIGN

937:    Synopsis:
938:     #include <petscsys.h>
939:    PetscErrorCode PetscMalloc7(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4,size_t m5,type **r5,size_t m6,type **r6,size_t m7,type **r7)

941:    Not Collective

943:    Input Parameter:
944: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
945: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
946: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
947: .  m4 - number of elements to allocate in 4th chunk  (may be zero)
948: .  m5 - number of elements to allocate in 5th chunk  (may be zero)
949: .  m6 - number of elements to allocate in 6th chunk  (may be zero)
950: -  m7 - number of elements to allocate in 7th chunk  (may be zero)

952:    Output Parameter:
953: +  r1 - memory allocated in first chunk
954: .  r2 - memory allocated in second chunk
955: .  r3 - memory allocated in third chunk
956: .  r4 - memory allocated in fourth chunk
957: .  r5 - memory allocated in fifth chunk
958: .  r6 - memory allocated in sixth chunk
959: -  r7 - memory allocated in seventh chunk

961:    Level: developer

963: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc7(), PetscFree7()

965:   Concepts: memory allocation

967: M*/
968: #if defined(PETSC_USE_DEBUG)
969: #define PetscMalloc7(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6,m7,r7) (PetscMalloc((m1)*sizeof(**(r1)),r1) || PetscMalloc((m2)*sizeof(**(r2)),r2) || PetscMalloc((m3)*sizeof(**(r3)),r3) || PetscMalloc((m4)*sizeof(**(r4)),r4) || PetscMalloc((m5)*sizeof(**(r5)),r5) || PetscMalloc((m6)*sizeof(**(r6)),r6) || PetscMalloc((m7)*sizeof(**(r7)),r7))
970: #else
971: #define PetscMalloc7(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6,m7,r7) \
972:   ((*(r2) = 0, *(r3) = 0, *(r4) = 0,*(r5) = 0,*(r6) = 0,*(r7) = 0,PetscMalloc((m1)*sizeof(**(r1))+(m2)*sizeof(**(r2))+(m3)*sizeof(**(r3))+(m4)*sizeof(**(r4))+(m5)*sizeof(**(r5))+(m6)*sizeof(**(r6))+(m7)*sizeof(**(r7))+6*(PETSC_MEMALIGN-1),r1)) \
973:    || (*(void**)(r2) = PetscAddrAlign(*(r1)+(m1)),*(void**)(r3) = PetscAddrAlign(*(r2)+(m2)),*(void**)(r4) = PetscAddrAlign(*(r3)+(m3)),*(void**)(r5) = PetscAddrAlign(*(r4)+(m4)),*(void**)(r6) = PetscAddrAlign(*(r5)+(m5)),*(void**)(r7) = PetscAddrAlign(*(r6)+(m6)),0))
974: #endif

976: /*MC
977:    PetscCalloc7 - Allocates 7 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN

979:    Synopsis:
980:     #include <petscsys.h>
981:    PetscErrorCode PetscCalloc7(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4,size_t m5,type **r5,size_t m6,type **r6,size_t m7,type **r7)

983:    Not Collective

985:    Input Parameter:
986: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
987: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
988: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
989: .  m4 - number of elements to allocate in 4th chunk  (may be zero)
990: .  m5 - number of elements to allocate in 5th chunk  (may be zero)
991: .  m6 - number of elements to allocate in 6th chunk  (may be zero)
992: -  m7 - number of elements to allocate in 7th chunk  (may be zero)

994:    Output Parameter:
995: +  r1 - memory allocated in first chunk
996: .  r2 - memory allocated in second chunk
997: .  r3 - memory allocated in third chunk
998: .  r4 - memory allocated in fourth chunk
999: .  r5 - memory allocated in fifth chunk
1000: .  r6 - memory allocated in sixth chunk
1001: -  r7 - memory allocated in seventh chunk

1003:    Level: developer

1005: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscMalloc7(), PetscFree7()

1007:   Concepts: memory allocation
1008: M*/
1009: #define PetscCalloc7(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6,m7,r7)         \
1010:   (PetscMalloc7(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6,m7,r7)              \
1011:    || PetscMemzero(*(r1),(m1)*sizeof(**(r1))) || PetscMemzero(*(r2),(m2)*sizeof(**(r2))) || PetscMemzero(*(r3),(m3)*sizeof(**(r3))) \
1012:    || PetscMemzero(*(r4),(m4)*sizeof(**(r4))) || PetscMemzero(*(r5),(m5)*sizeof(**(r5))) || PetscMemzero(*(r6),(m6)*sizeof(**(r6))) \
1013:    || PetscMemzero(*(r7),(m7)*sizeof(**(r7))))

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

1018:    Synopsis:
1019:     #include <petscsys.h>
1020:    PetscErrorCode PetscNew(type **result)

1022:    Not Collective

1024:    Output Parameter:
1025: .  result - memory allocated, sized to match pointer type

1027:    Level: beginner

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

1031:   Concepts: memory allocation

1033: M*/
1034: #define PetscNew(b)      PetscCalloc1(1,(b))

1036: /*MC
1037:    PetscNewLog - Allocates memory of a type matching pointer, zeros the memory! Aligned to PETSC_MEMALIGN. Associates the memory allocated
1038:          with the given object using PetscLogObjectMemory().

1040:    Synopsis:
1041:     #include <petscsys.h>
1042:    PetscErrorCode PetscNewLog(PetscObject obj,type **result)

1044:    Not Collective

1046:    Input Parameter:
1047: .  obj - object memory is logged to

1049:    Output Parameter:
1050: .  result - memory allocated, sized to match pointer type

1052:    Level: developer

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

1056:   Concepts: memory allocation

1058: M*/
1059: #define PetscNewLog(o,b) (PetscNew((b)) || ((o) ? PetscLogObjectMemory((PetscObject)o,sizeof(**(b))) : 0))

1061: /*MC
1062:    PetscFree - Frees memory

1064:    Synopsis:
1065:     #include <petscsys.h>
1066:    PetscErrorCode PetscFree(void *memory)

1068:    Not Collective

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

1073:    Level: beginner

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

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

1079:   Concepts: memory allocation

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

1084: /*MC
1085:    PetscFreeVoid - Frees memory

1087:    Synopsis:
1088:     #include <petscsys.h>
1089:    void PetscFreeVoid(void *memory)

1091:    Not Collective

1093:    Input Parameter:
1094: .   memory - memory to free

1096:    Level: beginner

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

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

1102:   Concepts: memory allocation

1104: M*/
1105: #define PetscFreeVoid(a) ((*PetscTrFree)((a),__LINE__,PETSC_FUNCTION_NAME,__FILE__),(a) = 0)


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

1111:    Synopsis:
1112:     #include <petscsys.h>
1113:    PetscErrorCode PetscFree2(void *memory1,void *memory2)

1115:    Not Collective

1117:    Input Parameter:
1118: +   memory1 - memory to free
1119: -   memory2 - 2nd memory to free

1121:    Level: developer

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

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

1127:   Concepts: memory allocation

1129: M*/
1130: #if defined(PETSC_USE_DEBUG)
1131: #define PetscFree2(m1,m2)   (PetscFree(m2) || PetscFree(m1))
1132: #else
1133: #define PetscFree2(m1,m2)   ((m2)=0, PetscFree(m1))
1134: #endif

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

1139:    Synopsis:
1140:     #include <petscsys.h>
1141:    PetscErrorCode PetscFree3(void *memory1,void *memory2,void *memory3)

1143:    Not Collective

1145:    Input Parameter:
1146: +   memory1 - memory to free
1147: .   memory2 - 2nd memory to free
1148: -   memory3 - 3rd memory to free

1150:    Level: developer

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

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

1156:   Concepts: memory allocation

1158: M*/
1159: #if defined(PETSC_USE_DEBUG)
1160: #define PetscFree3(m1,m2,m3)   (PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
1161: #else
1162: #define PetscFree3(m1,m2,m3)   ((m3)=0,(m2)=0,PetscFree(m1))
1163: #endif

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

1168:    Synopsis:
1169:     #include <petscsys.h>
1170:    PetscErrorCode PetscFree4(void *m1,void *m2,void *m3,void *m4)

1172:    Not Collective

1174:    Input Parameter:
1175: +   m1 - memory to free
1176: .   m2 - 2nd memory to free
1177: .   m3 - 3rd memory to free
1178: -   m4 - 4th memory to free

1180:    Level: developer

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

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

1186:   Concepts: memory allocation

1188: M*/
1189: #if defined(PETSC_USE_DEBUG)
1190: #define PetscFree4(m1,m2,m3,m4)   (PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
1191: #else
1192: #define PetscFree4(m1,m2,m3,m4)   ((m4)=0,(m3)=0,(m2)=0,PetscFree(m1))
1193: #endif

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

1198:    Synopsis:
1199:     #include <petscsys.h>
1200:    PetscErrorCode PetscFree5(void *m1,void *m2,void *m3,void *m4,void *m5)

1202:    Not Collective

1204:    Input Parameter:
1205: +   m1 - memory to free
1206: .   m2 - 2nd memory to free
1207: .   m3 - 3rd memory to free
1208: .   m4 - 4th memory to free
1209: -   m5 - 5th memory to free

1211:    Level: developer

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

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

1217:   Concepts: memory allocation

1219: M*/
1220: #if defined(PETSC_USE_DEBUG)
1221: #define PetscFree5(m1,m2,m3,m4,m5)   (PetscFree(m5) || PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
1222: #else
1223: #define PetscFree5(m1,m2,m3,m4,m5)   ((m5)=0,(m4)=0,(m3)=0,(m2)=0,PetscFree(m1))
1224: #endif


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

1230:    Synopsis:
1231:     #include <petscsys.h>
1232:    PetscErrorCode PetscFree6(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6)

1234:    Not Collective

1236:    Input Parameter:
1237: +   m1 - memory to free
1238: .   m2 - 2nd memory to free
1239: .   m3 - 3rd memory to free
1240: .   m4 - 4th memory to free
1241: .   m5 - 5th memory to free
1242: -   m6 - 6th memory to free


1245:    Level: developer

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

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

1251:   Concepts: memory allocation

1253: M*/
1254: #if defined(PETSC_USE_DEBUG)
1255: #define PetscFree6(m1,m2,m3,m4,m5,m6)   (PetscFree(m6) || PetscFree(m5) || PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
1256: #else
1257: #define PetscFree6(m1,m2,m3,m4,m5,m6)   ((m6)=0,(m5)=0,(m4)=0,(m3)=0,(m2)=0,PetscFree(m1))
1258: #endif

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

1263:    Synopsis:
1264:     #include <petscsys.h>
1265:    PetscErrorCode PetscFree7(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6,void *m7)

1267:    Not Collective

1269:    Input Parameter:
1270: +   m1 - memory to free
1271: .   m2 - 2nd memory to free
1272: .   m3 - 3rd memory to free
1273: .   m4 - 4th memory to free
1274: .   m5 - 5th memory to free
1275: .   m6 - 6th memory to free
1276: -   m7 - 7th memory to free


1279:    Level: developer

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

1283: .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6(),
1284:           PetscMalloc7()

1286:   Concepts: memory allocation

1288: M*/
1289: #if defined(PETSC_USE_DEBUG)
1290: #define PetscFree7(m1,m2,m3,m4,m5,m6,m7)   (PetscFree(m7) || PetscFree(m6) || PetscFree(m5) || PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
1291: #else
1292: #define PetscFree7(m1,m2,m3,m4,m5,m6,m7)   ((m7)=0,(m6)=0,(m5)=0,(m4)=0,(m3)=0,(m2)=0,PetscFree(m1))
1293: #endif

1295: PETSC_EXTERN PetscErrorCode (*PetscTrMalloc)(size_t,int,const char[],const char[],void**);
1296: PETSC_EXTERN PetscErrorCode (*PetscTrFree)(void*,int,const char[],const char[]);
1297: PETSC_EXTERN PetscErrorCode PetscMallocSet(PetscErrorCode (*)(size_t,int,const char[],const char[],void**),PetscErrorCode (*)(void*,int,const char[],const char[]));
1298: PETSC_EXTERN PetscErrorCode PetscMallocClear(void);

1300: /*
1301:     PetscLogDouble variables are used to contain double precision numbers
1302:   that are not used in the numerical computations, but rather in logging,
1303:   timing etc.
1304: */
1305: typedef double PetscLogDouble;
1306: #define MPIU_PETSCLOGDOUBLE MPI_DOUBLE

1308: /*
1309:    Routines for tracing memory corruption/bleeding with default PETSc  memory allocation
1310: */
1311: PETSC_EXTERN PetscErrorCode PetscMallocDump(FILE *);
1312: PETSC_EXTERN PetscErrorCode PetscMallocDumpLog(FILE *);
1313: PETSC_EXTERN PetscErrorCode PetscMallocGetCurrentUsage(PetscLogDouble *);
1314: PETSC_EXTERN PetscErrorCode PetscMallocGetMaximumUsage(PetscLogDouble *);
1315: PETSC_EXTERN PetscErrorCode PetscMallocDebug(PetscBool);
1316: PETSC_EXTERN PetscErrorCode PetscMallocGetDebug(PetscBool*);
1317: PETSC_EXTERN PetscErrorCode PetscMallocValidate(int,const char[],const char[]);
1318: PETSC_EXTERN PetscErrorCode PetscMallocSetDumpLog(void);
1319: PETSC_EXTERN PetscErrorCode PetscMallocSetDumpLogThreshold(PetscLogDouble);
1320: PETSC_EXTERN PetscErrorCode PetscMallocGetDumpLog(PetscBool*);

1322: /*E
1323:     PetscDataType - Used for handling different basic data types.

1325:    Level: beginner

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

1329: .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscDataTypeToMPIDataType(),
1330:           PetscDataTypeGetSize()

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

1337: #if defined(PETSC_USE_COMPLEX)
1338: #define  PETSC_SCALAR  PETSC_COMPLEX
1339: #else
1340: #if defined(PETSC_USE_REAL_SINGLE)
1341: #define  PETSC_SCALAR  PETSC_FLOAT
1342: #elif defined(PETSC_USE_REAL___FLOAT128)
1343: #define  PETSC_SCALAR  PETSC___FLOAT128
1344: #else
1345: #define  PETSC_SCALAR  PETSC_DOUBLE
1346: #endif
1347: #endif
1348: #if defined(PETSC_USE_REAL_SINGLE)
1349: #define  PETSC_REAL  PETSC_FLOAT
1350: #elif defined(PETSC_USE_REAL___FLOAT128)
1351: #define  PETSC_REAL  PETSC___FLOAT128
1352: #else
1353: #define  PETSC_REAL  PETSC_DOUBLE
1354: #endif
1355: #define  PETSC_FORTRANADDR  PETSC_LONG

1357: PETSC_EXTERN PetscErrorCode PetscDataTypeToMPIDataType(PetscDataType,MPI_Datatype*);
1358: PETSC_EXTERN PetscErrorCode PetscMPIDataTypeToPetscDataType(MPI_Datatype,PetscDataType*);
1359: PETSC_EXTERN PetscErrorCode PetscDataTypeGetSize(PetscDataType,size_t*);
1360: PETSC_EXTERN PetscErrorCode PetscDataTypeFromString(const char*,PetscDataType*,PetscBool*);

1362: /*
1363:     Basic memory and string operations. These are usually simple wrappers
1364:    around the basic Unix system calls, but a few of them have additional
1365:    functionality and/or error checking.
1366: */
1367: PETSC_EXTERN PetscErrorCode PetscBitMemcpy(void*,PetscInt,const void*,PetscInt,PetscInt,PetscDataType);
1368: PETSC_EXTERN PetscErrorCode PetscMemmove(void*,void *,size_t);
1369: PETSC_EXTERN PetscErrorCode PetscMemcmp(const void*,const void*,size_t,PetscBool  *);
1370: PETSC_EXTERN PetscErrorCode PetscStrlen(const char[],size_t*);
1371: PETSC_EXTERN PetscErrorCode PetscStrToArray(const char[],char,int*,char ***);
1372: PETSC_EXTERN PetscErrorCode PetscStrToArrayDestroy(int,char **);
1373: PETSC_EXTERN PetscErrorCode PetscStrcmp(const char[],const char[],PetscBool  *);
1374: PETSC_EXTERN PetscErrorCode PetscStrgrt(const char[],const char[],PetscBool  *);
1375: PETSC_EXTERN PetscErrorCode PetscStrcasecmp(const char[],const char[],PetscBool *);
1376: PETSC_EXTERN PetscErrorCode PetscStrncmp(const char[],const char[],size_t,PetscBool *);
1377: PETSC_EXTERN PetscErrorCode PetscStrcpy(char[],const char[]);
1378: PETSC_EXTERN PetscErrorCode PetscStrcat(char[],const char[]);
1379: PETSC_EXTERN PetscErrorCode PetscStrncat(char[],const char[],size_t);
1380: PETSC_EXTERN PetscErrorCode PetscStrncpy(char[],const char[],size_t);
1381: PETSC_EXTERN PetscErrorCode PetscStrchr(const char[],char,char *[]);
1382: PETSC_EXTERN PetscErrorCode PetscStrtolower(char[]);
1383: PETSC_EXTERN PetscErrorCode PetscStrtoupper(char[]);
1384: PETSC_EXTERN PetscErrorCode PetscStrrchr(const char[],char,char *[]);
1385: PETSC_EXTERN PetscErrorCode PetscStrstr(const char[],const char[],char *[]);
1386: PETSC_EXTERN PetscErrorCode PetscStrrstr(const char[],const char[],char *[]);
1387: PETSC_EXTERN PetscErrorCode PetscStrendswith(const char[],const char[],PetscBool*);
1388: PETSC_EXTERN PetscErrorCode PetscStrbeginswith(const char[],const char[],PetscBool*);
1389: PETSC_EXTERN PetscErrorCode PetscStrendswithwhich(const char[],const char *const*,PetscInt*);
1390: PETSC_EXTERN PetscErrorCode PetscStrallocpy(const char[],char *[]);
1391: PETSC_EXTERN PetscErrorCode PetscStrArrayallocpy(const char *const*,char***);
1392: PETSC_EXTERN PetscErrorCode PetscStrArrayDestroy(char***);
1393: PETSC_EXTERN PetscErrorCode PetscStrreplace(MPI_Comm,const char[],char[],size_t);

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

1397: /*S
1398:     PetscToken - 'Token' used for managing tokenizing strings

1400:   Level: intermediate

1402: .seealso: PetscTokenCreate(), PetscTokenFind(), PetscTokenDestroy()
1403: S*/
1404: typedef struct _p_PetscToken* PetscToken;

1406: PETSC_EXTERN PetscErrorCode PetscTokenCreate(const char[],const char,PetscToken*);
1407: PETSC_EXTERN PetscErrorCode PetscTokenFind(PetscToken,char *[]);
1408: PETSC_EXTERN PetscErrorCode PetscTokenDestroy(PetscToken*);

1410: PETSC_EXTERN PetscErrorCode PetscEListFind(PetscInt,const char *const*,const char*,PetscInt*,PetscBool*);
1411: PETSC_EXTERN PetscErrorCode PetscEnumFind(const char *const*,const char*,PetscEnum*,PetscBool*);

1413: /*
1414:    These are  MPI operations for MPI_Allreduce() etc
1415: */
1416: PETSC_EXTERN MPI_Op PetscMaxSum_Op;
1417: #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
1418: PETSC_EXTERN MPI_Op MPIU_SUM;
1419: #else
1420: #define MPIU_SUM MPI_SUM
1421: #endif
1422: #if defined(PETSC_USE_REAL___FLOAT128)
1423: PETSC_EXTERN MPI_Op MPIU_MAX;
1424: PETSC_EXTERN MPI_Op MPIU_MIN;
1425: #else
1426: #define MPIU_MAX MPI_MAX
1427: #define MPIU_MIN MPI_MIN
1428: #endif
1429: PETSC_EXTERN PetscErrorCode PetscMaxSum(MPI_Comm,const PetscInt[],PetscInt*,PetscInt*);

1431: PETSC_EXTERN PetscErrorCode MPIULong_Send(void*,PetscInt,MPI_Datatype,PetscMPIInt,PetscMPIInt,MPI_Comm);
1432: PETSC_EXTERN PetscErrorCode MPIULong_Recv(void*,PetscInt,MPI_Datatype,PetscMPIInt,PetscMPIInt,MPI_Comm);

1434: /*S
1435:      PetscObject - any PETSc object, PetscViewer, Mat, Vec, KSP etc

1437:    Level: beginner

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

1441: .seealso:  PetscObjectDestroy(), PetscObjectView(), PetscObjectGetName(), PetscObjectSetName(), PetscObjectReference(), PetscObjectDereferenc()
1442: S*/
1443: typedef struct _p_PetscObject* PetscObject;

1445: /*MC
1446:     PetscObjectId - unique integer Id for a PetscObject

1448:     Level: developer

1450:     Notes: Unlike pointer values, object ids are never reused.

1452: .seealso: PetscObjectState, PetscObjectGetId()
1453: M*/
1454: typedef Petsc64bitInt PetscObjectId;

1456: /*MC
1457:     PetscObjectState - integer state for a PetscObject

1459:     Level: developer

1461:     Notes:
1462:     Object state is always-increasing and (for objects that track state) can be used to determine if an object has
1463:     changed since the last time you interacted with it.  It is 64-bit so that it will not overflow for a very long time.

1465: .seealso: PetscObjectId, PetscObjectStateGet(), PetscObjectStateIncrease(), PetscObjectStateSet()
1466: M*/
1467: typedef Petsc64bitInt PetscObjectState;

1469: /*S
1470:      PetscFunctionList - Linked list of functions, possibly stored in dynamic libraries, accessed
1471:       by string name

1473:    Level: advanced

1475: .seealso:  PetscFunctionListAdd(), PetscFunctionListDestroy(), PetscOpFlist
1476: S*/
1477: typedef struct _n_PetscFunctionList *PetscFunctionList;

1479: /*E
1480:   PetscFileMode - Access mode for a file.

1482:   Level: beginner

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

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

1488:   FILE_MODE_APPEND - open a file at end for writing

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

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

1494: .seealso: PetscViewerFileSetMode()
1495: E*/
1496: typedef enum {FILE_MODE_READ, FILE_MODE_WRITE, FILE_MODE_APPEND, FILE_MODE_UPDATE, FILE_MODE_APPEND_UPDATE} PetscFileMode;
1497: extern const char *const PetscFileModes[];

1499: /*
1500:     Defines PETSc error handling.
1501: */
1502: #include <petscerror.h>

1504: #define PETSC_SMALLEST_CLASSID  1211211
1505: PETSC_EXTERN PetscClassId PETSC_LARGEST_CLASSID;
1506: PETSC_EXTERN PetscClassId PETSC_OBJECT_CLASSID;
1507: PETSC_EXTERN PetscErrorCode PetscClassIdRegister(const char[],PetscClassId *);

1509: /*
1510:    Routines that get memory usage information from the OS
1511: */
1512: PETSC_EXTERN PetscErrorCode PetscMemoryGetCurrentUsage(PetscLogDouble *);
1513: PETSC_EXTERN PetscErrorCode PetscMemoryGetMaximumUsage(PetscLogDouble *);
1514: PETSC_EXTERN PetscErrorCode PetscMemorySetGetMaximumUsage(void);

1516: PETSC_EXTERN PetscErrorCode PetscInfoAllow(PetscBool ,const char []);
1517: PETSC_EXTERN PetscErrorCode PetscSleep(PetscReal);

1519: /*
1520:    Initialization of PETSc
1521: */
1522: PETSC_EXTERN PetscErrorCode PetscInitialize(int*,char***,const char[],const char[]);
1523: PETSC_EXTERN PetscErrorCode PetscInitializeNoPointers(int,char**,const char[],const char[]);
1524: PETSC_EXTERN PetscErrorCode PetscInitializeNoArguments(void);
1525: PETSC_EXTERN PetscErrorCode PetscInitialized(PetscBool *);
1526: PETSC_EXTERN PetscErrorCode PetscFinalized(PetscBool *);
1527: PETSC_EXTERN PetscErrorCode PetscFinalize(void);
1528: PETSC_EXTERN PetscErrorCode PetscInitializeFortran(void);
1529: PETSC_EXTERN PetscErrorCode PetscGetArgs(int*,char ***);
1530: PETSC_EXTERN PetscErrorCode PetscGetArguments(char ***);
1531: PETSC_EXTERN PetscErrorCode PetscFreeArguments(char **);

1533: PETSC_EXTERN PetscErrorCode PetscEnd(void);
1534: PETSC_EXTERN PetscErrorCode PetscSysInitializePackage(void);

1536: PETSC_EXTERN PetscErrorCode PetscPythonInitialize(const char[],const char[]);
1537: PETSC_EXTERN PetscErrorCode PetscPythonFinalize(void);
1538: PETSC_EXTERN PetscErrorCode PetscPythonPrintError(void);
1539: PETSC_EXTERN PetscErrorCode PetscPythonMonitorSet(PetscObject,const char[]);

1541: /*
1542:      These are so that in extern C code we can caste function pointers to non-extern C
1543:    function pointers. Since the regular C++ code expects its function pointers to be C++
1544: */
1545: PETSC_EXTERN_TYPEDEF typedef void (**PetscVoidStarFunction)(void);
1546: PETSC_EXTERN_TYPEDEF typedef void (*PetscVoidFunction)(void);
1547: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*PetscErrorCodeFunction)(void);

1549: /*
1550:     Functions that can act on any PETSc object.
1551: */
1552: PETSC_EXTERN PetscErrorCode PetscObjectDestroy(PetscObject*);
1553: PETSC_EXTERN PetscErrorCode PetscObjectGetComm(PetscObject,MPI_Comm *);
1554: PETSC_EXTERN PetscErrorCode PetscObjectGetClassId(PetscObject,PetscClassId *);
1555: PETSC_EXTERN PetscErrorCode PetscObjectGetClassName(PetscObject,const char *[]);
1556: PETSC_EXTERN PetscErrorCode PetscObjectSetType(PetscObject,const char []);
1557: PETSC_EXTERN PetscErrorCode PetscObjectSetPrecision(PetscObject,PetscPrecision);
1558: PETSC_EXTERN PetscErrorCode PetscObjectGetType(PetscObject,const char *[]);
1559: PETSC_EXTERN PetscErrorCode PetscObjectSetName(PetscObject,const char[]);
1560: PETSC_EXTERN PetscErrorCode PetscObjectGetName(PetscObject,const char*[]);
1561: PETSC_EXTERN PetscErrorCode PetscObjectSetTabLevel(PetscObject,PetscInt);
1562: PETSC_EXTERN PetscErrorCode PetscObjectGetTabLevel(PetscObject,PetscInt*);
1563: PETSC_EXTERN PetscErrorCode PetscObjectIncrementTabLevel(PetscObject,PetscObject,PetscInt);
1564: PETSC_EXTERN PetscErrorCode PetscObjectReference(PetscObject);
1565: PETSC_EXTERN PetscErrorCode PetscObjectGetReference(PetscObject,PetscInt*);
1566: PETSC_EXTERN PetscErrorCode PetscObjectDereference(PetscObject);
1567: PETSC_EXTERN PetscErrorCode PetscObjectGetNewTag(PetscObject,PetscMPIInt *);
1568: PETSC_EXTERN PetscErrorCode PetscObjectCompose(PetscObject,const char[],PetscObject);
1569: PETSC_EXTERN PetscErrorCode PetscObjectRemoveReference(PetscObject,const char[]);
1570: PETSC_EXTERN PetscErrorCode PetscObjectQuery(PetscObject,const char[],PetscObject *);
1571: PETSC_EXTERN PetscErrorCode PetscObjectComposeFunction_Private(PetscObject,const char[],void (*)(void));
1572: #define PetscObjectComposeFunction(a,b,d) PetscObjectComposeFunction_Private(a,b,(PetscVoidFunction)(d))
1573: PETSC_EXTERN PetscErrorCode PetscObjectSetFromOptions(PetscObject);
1574: PETSC_EXTERN PetscErrorCode PetscObjectSetUp(PetscObject);
1575: PETSC_EXTERN PetscErrorCode PetscCommGetNewTag(MPI_Comm,PetscMPIInt *);
1576: PETSC_EXTERN PetscErrorCode PetscObjectAddOptionsHandler(PetscObject,PetscErrorCode (*)(PetscObject,void*),PetscErrorCode (*)(PetscObject,void*),void*);
1577: PETSC_EXTERN PetscErrorCode PetscObjectProcessOptionsHandlers(PetscObject);
1578: PETSC_EXTERN PetscErrorCode PetscObjectDestroyOptionsHandlers(PetscObject);
1579: PETSC_EXTERN PetscErrorCode PetscObjectsGetGlobalNumbering(MPI_Comm,PetscInt,PetscObject*,PetscInt*,PetscInt*);

1581: #include <petscviewertypes.h>
1582: #include <petscoptions.h>

1584: PETSC_EXTERN PetscErrorCode PetscMemoryShowUsage(PetscViewer,const char[]);
1585: PETSC_EXTERN PetscErrorCode PetscObjectPrintClassNamePrefixType(PetscObject,PetscViewer);
1586: PETSC_EXTERN PetscErrorCode PetscObjectView(PetscObject,PetscViewer);
1587: #define PetscObjectQueryFunction(obj,name,fptr) PetscObjectQueryFunction_Private((obj),(name),(PetscVoidFunction*)(fptr))
1588: PETSC_EXTERN PetscErrorCode PetscObjectQueryFunction_Private(PetscObject,const char[],void (**)(void));
1589: PETSC_EXTERN PetscErrorCode PetscObjectSetOptionsPrefix(PetscObject,const char[]);
1590: PETSC_EXTERN PetscErrorCode PetscObjectAppendOptionsPrefix(PetscObject,const char[]);
1591: PETSC_EXTERN PetscErrorCode PetscObjectPrependOptionsPrefix(PetscObject,const char[]);
1592: PETSC_EXTERN PetscErrorCode PetscObjectGetOptionsPrefix(PetscObject,const char*[]);
1593: PETSC_EXTERN PetscErrorCode PetscObjectChangeTypeName(PetscObject,const char[]);
1594: PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroy(PetscObject);
1595: PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroyAll(void);
1596: PETSC_EXTERN PetscErrorCode PetscObjectViewFromOptions(PetscObject,const char[],const char[]);
1597: PETSC_EXTERN PetscErrorCode PetscObjectName(PetscObject);
1598: PETSC_EXTERN PetscErrorCode PetscObjectTypeCompare(PetscObject,const char[],PetscBool *);
1599: PETSC_EXTERN PetscErrorCode PetscObjectTypeCompareAny(PetscObject,PetscBool*,const char[],...);
1600: PETSC_EXTERN PetscErrorCode PetscRegisterFinalize(PetscErrorCode (*)(void));
1601: PETSC_EXTERN PetscErrorCode PetscRegisterFinalizeAll(void);

1603: #if defined(PETSC_HAVE_SAWS)
1604: PETSC_EXTERN PetscErrorCode PetscSAWsBlock(void);
1605: PETSC_EXTERN PetscErrorCode PetscObjectSAWsViewOff(PetscObject);
1606: PETSC_EXTERN PetscErrorCode PetscObjectSAWsSetBlock(PetscObject,PetscBool);
1607: PETSC_EXTERN PetscErrorCode PetscObjectSAWsBlock(PetscObject);
1608: PETSC_EXTERN PetscErrorCode PetscObjectSAWsGrantAccess(PetscObject);
1609: PETSC_EXTERN PetscErrorCode PetscObjectSAWsTakeAccess(PetscObject);
1610: PETSC_EXTERN void           PetscStackSAWsGrantAccess(void);
1611: PETSC_EXTERN void           PetscStackSAWsTakeAccess(void);
1612: PETSC_EXTERN PetscErrorCode PetscStackViewSAWs(void);
1613: PETSC_EXTERN PetscErrorCode PetscStackSAWsViewOff(void);

1615: #else
1616: #define PetscSAWsBlock()                        0
1617: #define PetscObjectSAWsViewOff(obj)             0
1618: #define PetscObjectSAWsSetBlock(obj,flg)        0
1619: #define PetscObjectSAWsBlock(obj)               0
1620: #define PetscObjectSAWsGrantAccess(obj)         0
1621: #define PetscObjectSAWsTakeAccess(obj)          0
1622: #define PetscStackViewSAWs()                    0
1623: #define PetscStackSAWsViewOff()                 0
1624: #define PetscStackSAWsTakeAccess()
1625: #define PetscStackSAWsGrantAccess()

1627: #endif

1629: typedef void* PetscDLHandle;
1630: typedef enum {PETSC_DL_DECIDE=0,PETSC_DL_NOW=1,PETSC_DL_LOCAL=2} PetscDLMode;
1631: PETSC_EXTERN PetscErrorCode PetscDLOpen(const char[],PetscDLMode,PetscDLHandle *);
1632: PETSC_EXTERN PetscErrorCode PetscDLClose(PetscDLHandle *);
1633: PETSC_EXTERN PetscErrorCode PetscDLSym(PetscDLHandle,const char[],void **);


1636: #if defined(PETSC_USE_DEBUG)
1637: PETSC_EXTERN PetscErrorCode PetscMallocGetStack(void*,PetscStack**);
1638: #endif
1639: PETSC_EXTERN PetscErrorCode PetscObjectsDump(FILE*,PetscBool);

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

1644:    Level: developer

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

1648: .seealso:  PetscObjectListAdd(), PetscObjectListDestroy(), PetscObjectListFind(), PetscObjectCompose(), PetscObjectQuery(), PetscFunctionList
1649: S*/
1650: typedef struct _n_PetscObjectList *PetscObjectList;

1652: PETSC_EXTERN PetscErrorCode PetscObjectListDestroy(PetscObjectList*);
1653: PETSC_EXTERN PetscErrorCode PetscObjectListFind(PetscObjectList,const char[],PetscObject*);
1654: PETSC_EXTERN PetscErrorCode PetscObjectListReverseFind(PetscObjectList,PetscObject,char**,PetscBool*);
1655: PETSC_EXTERN PetscErrorCode PetscObjectListAdd(PetscObjectList *,const char[],PetscObject);
1656: PETSC_EXTERN PetscErrorCode PetscObjectListRemoveReference(PetscObjectList *,const char[]);
1657: PETSC_EXTERN PetscErrorCode PetscObjectListDuplicate(PetscObjectList,PetscObjectList *);

1659: /*
1660:     Dynamic library lists. Lists of names of routines in objects or in dynamic
1661:   link libraries that will be loaded as needed.
1662: */

1664: #define PetscFunctionListAdd(list,name,fptr) PetscFunctionListAdd_Private((list),(name),(PetscVoidFunction)(fptr))
1665: PETSC_EXTERN PetscErrorCode PetscFunctionListAdd_Private(PetscFunctionList*,const char[],void (*)(void));
1666: PETSC_EXTERN PetscErrorCode PetscFunctionListDestroy(PetscFunctionList*);
1667: #define PetscFunctionListFind(list,name,fptr) PetscFunctionListFind_Private((list),(name),(PetscVoidFunction*)(fptr))
1668: PETSC_EXTERN PetscErrorCode PetscFunctionListFind_Private(PetscFunctionList,const char[],void (**)(void));
1669: PETSC_EXTERN PetscErrorCode PetscFunctionListPrintTypes(MPI_Comm,FILE*,const char[],const char[],const char[],const char[],PetscFunctionList,const char[]);
1670: PETSC_EXTERN PetscErrorCode PetscFunctionListDuplicate(PetscFunctionList,PetscFunctionList *);
1671: PETSC_EXTERN PetscErrorCode PetscFunctionListView(PetscFunctionList,PetscViewer);
1672: PETSC_EXTERN PetscErrorCode PetscFunctionListGet(PetscFunctionList,const char ***,int*);

1674: /*S
1675:      PetscDLLibrary - Linked list of dynamics libraries to search for functions

1677:    Level: advanced

1679: .seealso:  PetscDLLibraryOpen()
1680: S*/
1681: typedef struct _n_PetscDLLibrary *PetscDLLibrary;
1682: PETSC_EXTERN PetscDLLibrary  PetscDLLibrariesLoaded;
1683: PETSC_EXTERN PetscErrorCode PetscDLLibraryAppend(MPI_Comm,PetscDLLibrary *,const char[]);
1684: PETSC_EXTERN PetscErrorCode PetscDLLibraryPrepend(MPI_Comm,PetscDLLibrary *,const char[]);
1685: PETSC_EXTERN PetscErrorCode PetscDLLibrarySym(MPI_Comm,PetscDLLibrary *,const char[],const char[],void **);
1686: PETSC_EXTERN PetscErrorCode PetscDLLibraryPrintPath(PetscDLLibrary);
1687: PETSC_EXTERN PetscErrorCode PetscDLLibraryRetrieve(MPI_Comm,const char[],char *,size_t,PetscBool  *);
1688: PETSC_EXTERN PetscErrorCode PetscDLLibraryOpen(MPI_Comm,const char[],PetscDLLibrary *);
1689: PETSC_EXTERN PetscErrorCode PetscDLLibraryClose(PetscDLLibrary);

1691: /*
1692:      Useful utility routines
1693: */
1694: PETSC_EXTERN PetscErrorCode PetscSplitOwnership(MPI_Comm,PetscInt*,PetscInt*);
1695: PETSC_EXTERN PetscErrorCode PetscSplitOwnershipBlock(MPI_Comm,PetscInt,PetscInt*,PetscInt*);
1696: PETSC_EXTERN PetscErrorCode PetscSequentialPhaseBegin(MPI_Comm,PetscMPIInt);
1697: PETSC_EXTERN PetscErrorCode PetscSequentialPhaseEnd(MPI_Comm,PetscMPIInt);
1698: PETSC_EXTERN PetscErrorCode PetscBarrier(PetscObject);
1699: PETSC_EXTERN PetscErrorCode PetscMPIDump(FILE*);

1701: /*
1702:     PetscNot - negates a logical type value and returns result as a PetscBool

1704:     Notes: This is useful in cases like
1705: $     int        *a;
1706: $     PetscBool  flag = PetscNot(a)
1707:      where !a does not return a PetscBool  because we cannot provide a cast from int to PetscBool  in C.
1708: */
1709: #define PetscNot(a) ((a) ? PETSC_FALSE : PETSC_TRUE)

1711: #if defined(PETSC_HAVE_VALGRIND)
1712: #  include <valgrind/valgrind.h>
1713: #  define PETSC_RUNNING_ON_VALGRIND RUNNING_ON_VALGRIND
1714: #else
1715: #  define PETSC_RUNNING_ON_VALGRIND PETSC_FALSE
1716: #endif


1719: /*MC
1720:     PetscHelpPrintf - Prints help messages.

1722:    Synopsis:
1723:     #include <petscsys.h>
1724:      PetscErrorCode (*PetscHelpPrintf)(const char format[],...);

1726:     Not Collective

1728:     Input Parameters:
1729: .   format - the usual printf() format string

1731:    Level: developer

1733:     Fortran Note:
1734:     This routine is not supported in Fortran.

1736:     Concepts: help messages^printing
1737:     Concepts: printing^help messages

1739: .seealso: PetscFPrintf(), PetscSynchronizedPrintf(), PetscErrorPrintf()
1740: M*/
1741: PETSC_EXTERN PetscErrorCode (*PetscHelpPrintf)(MPI_Comm,const char[],...);

1743: /*
1744:      Defines PETSc profiling.
1745: */
1746: #include <petsclog.h>



1750: /*
1751:       Simple PETSc parallel IO for ASCII printing
1752: */
1753: PETSC_EXTERN PetscErrorCode PetscFixFilename(const char[],char[]);
1754: PETSC_EXTERN PetscErrorCode PetscFOpen(MPI_Comm,const char[],const char[],FILE**);
1755: PETSC_EXTERN PetscErrorCode PetscFClose(MPI_Comm,FILE*);
1756: PETSC_EXTERN PetscErrorCode PetscFPrintf(MPI_Comm,FILE*,const char[],...);
1757: PETSC_EXTERN PetscErrorCode PetscPrintf(MPI_Comm,const char[],...);
1758: PETSC_EXTERN PetscErrorCode PetscSNPrintf(char*,size_t,const char [],...);
1759: PETSC_EXTERN PetscErrorCode PetscSNPrintfCount(char*,size_t,const char [],size_t*,...);

1761: /* These are used internally by PETSc ASCII IO routines*/
1762: #include <stdarg.h>
1763: PETSC_EXTERN PetscErrorCode PetscVSNPrintf(char*,size_t,const char[],size_t*,va_list);
1764: PETSC_EXTERN PetscErrorCode (*PetscVFPrintf)(FILE*,const char[],va_list);
1765: PETSC_EXTERN PetscErrorCode PetscVFPrintfDefault(FILE*,const char[],va_list);

1767: #if defined(PETSC_HAVE_MATLAB_ENGINE)
1768: PETSC_EXTERN PetscErrorCode PetscVFPrintf_Matlab(FILE*,const char[],va_list);
1769: #endif

1771: PETSC_EXTERN PetscErrorCode PetscErrorPrintfDefault(const char [],...);
1772: PETSC_EXTERN PetscErrorCode PetscErrorPrintfNone(const char [],...);
1773: PETSC_EXTERN PetscErrorCode PetscHelpPrintfDefault(MPI_Comm,const char [],...);

1775: #if defined(PETSC_HAVE_POPEN)
1776: PETSC_EXTERN PetscErrorCode PetscPOpen(MPI_Comm,const char[],const char[],const char[],FILE **);
1777: PETSC_EXTERN PetscErrorCode PetscPClose(MPI_Comm,FILE*,int*);
1778: PETSC_EXTERN PetscErrorCode PetscPOpenSetMachine(const char[]);
1779: #endif

1781: PETSC_EXTERN PetscErrorCode PetscSynchronizedPrintf(MPI_Comm,const char[],...);
1782: PETSC_EXTERN PetscErrorCode PetscSynchronizedFPrintf(MPI_Comm,FILE*,const char[],...);
1783: PETSC_EXTERN PetscErrorCode PetscSynchronizedFlush(MPI_Comm,FILE*);
1784: PETSC_EXTERN PetscErrorCode PetscSynchronizedFGets(MPI_Comm,FILE*,size_t,char[]);
1785: PETSC_EXTERN PetscErrorCode PetscStartMatlab(MPI_Comm,const char[],const char[],FILE**);
1786: PETSC_EXTERN PetscErrorCode PetscStartJava(MPI_Comm,const char[],const char[],FILE**);
1787: PETSC_EXTERN PetscErrorCode PetscGetPetscDir(const char*[]);

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

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

1794:    Level: advanced

1796: .seealso:  PetscObject, PetscContainerCreate()
1797: S*/
1798: PETSC_EXTERN PetscClassId PETSC_CONTAINER_CLASSID;
1799: typedef struct _p_PetscContainer*  PetscContainer;
1800: PETSC_EXTERN PetscErrorCode PetscContainerGetPointer(PetscContainer,void **);
1801: PETSC_EXTERN PetscErrorCode PetscContainerSetPointer(PetscContainer,void *);
1802: PETSC_EXTERN PetscErrorCode PetscContainerDestroy(PetscContainer*);
1803: PETSC_EXTERN PetscErrorCode PetscContainerCreate(MPI_Comm,PetscContainer *);
1804: PETSC_EXTERN PetscErrorCode PetscContainerSetUserDestroy(PetscContainer, PetscErrorCode (*)(void*));

1806: /*
1807:    For use in debuggers
1808: */
1809: PETSC_EXTERN PetscMPIInt PetscGlobalRank;
1810: PETSC_EXTERN PetscMPIInt PetscGlobalSize;
1811: PETSC_EXTERN PetscErrorCode PetscIntView(PetscInt,const PetscInt[],PetscViewer);
1812: PETSC_EXTERN PetscErrorCode PetscRealView(PetscInt,const PetscReal[],PetscViewer);
1813: PETSC_EXTERN PetscErrorCode PetscScalarView(PetscInt,const PetscScalar[],PetscViewer);

1815: #include <stddef.h>
1816: #include <string.h>             /* for memcpy, memset */
1817: #if defined(PETSC_HAVE_STDLIB_H)
1818: #include <stdlib.h>
1819: #endif

1821: #if defined(PETSC_HAVE_XMMINTRIN_H) && !defined(__CUDACC__)
1822: #include <xmmintrin.h>
1823: #endif

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

1832:    Not Collective

1834:    Input Parameters:
1835: +  b - pointer to initial memory space
1836: -  n - length (in bytes) of space to copy

1838:    Output Parameter:
1839: .  a - pointer to copy space

1841:    Level: intermediate

1843:    Compile Option:
1844:     PETSC_PREFER_DCOPY_FOR_MEMCPY will cause the BLAS dcopy() routine to be used
1845:                                   for memory copies on double precision values.
1846:     PETSC_PREFER_COPY_FOR_MEMCPY will cause C code to be used
1847:                                   for memory copies on double precision values.
1848:     PETSC_PREFER_FORTRAN_FORMEMCPY will cause Fortran code to be used
1849:                                   for memory copies on double precision values.

1851:    Note:
1852:    This routine is analogous to memcpy().

1854:    Developer Note: this is inlined for fastest performance

1856:   Concepts: memory^copying
1857:   Concepts: copying^memory

1859: .seealso: PetscMemmove()

1861: @*/
1862: PETSC_STATIC_INLINE PetscErrorCode PetscMemcpy(void *a,const void *b,size_t n)
1863: {
1864: #if defined(PETSC_USE_DEBUG)
1865:   unsigned long al = (unsigned long) a,bl = (unsigned long) b;
1866:   unsigned long nl = (unsigned long) n;
1868:   if (n > 0 && !b) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy from a null pointer");
1869:   if (n > 0 && !a) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy to a null pointer");
1870: #else
1872: #endif
1873:   if (a != b) {
1874: #if defined(PETSC_USE_DEBUG)
1875:     if ((al > bl && (al - bl) < nl) || (bl - al) < nl)  SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_ARG_INCOMP,"Memory regions overlap: either use PetscMemmov()\n\
1876:               or make sure your copy regions and lengths are correct. \n\
1877:               Length (bytes) %ld first address %ld second address %ld",nl,al,bl);
1878: #endif
1879: #if (defined(PETSC_PREFER_DCOPY_FOR_MEMCPY) || defined(PETSC_PREFER_COPY_FOR_MEMCPY) || defined(PETSC_PREFER_FORTRAN_FORMEMCPY))
1880:    if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) {
1881:       size_t len = n/sizeof(PetscScalar);
1882: #if defined(PETSC_PREFER_DCOPY_FOR_MEMCPY)
1883:       PetscBLASInt   one = 1,blen;
1885:       PetscBLASIntCast(len,&blen);
1886:       PetscStackCallBLAS("BLAScopy",BLAScopy_(&blen,(PetscScalar *)b,&one,(PetscScalar *)a,&one));
1887: #elif defined(PETSC_PREFER_FORTRAN_FORMEMCPY)
1888:       fortrancopy_(&len,(PetscScalar*)b,(PetscScalar*)a);
1889: #else
1890:       size_t      i;
1891:       PetscScalar *x = (PetscScalar*)b, *y = (PetscScalar*)a;
1892:       for (i=0; i<len; i++) y[i] = x[i];
1893: #endif
1894:     } else {
1895:       memcpy((char*)(a),(char*)(b),n);
1896:     }
1897: #else
1898:     memcpy((char*)(a),(char*)(b),n);
1899: #endif
1900:   }
1901:   return(0);
1902: }

1904: /*@C
1905:    PetscMemzero - Zeros the specified memory.

1907:    Not Collective

1909:    Input Parameters:
1910: +  a - pointer to beginning memory location
1911: -  n - length (in bytes) of memory to initialize

1913:    Level: intermediate

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

1919:    Developer Note: this is inlined for fastest performance

1921:    Concepts: memory^zeroing
1922:    Concepts: zeroing^memory

1924: .seealso: PetscMemcpy()
1925: @*/
1926: PETSC_STATIC_INLINE PetscErrorCode  PetscMemzero(void *a,size_t n)
1927: {
1928:   if (n > 0) {
1929: #if defined(PETSC_USE_DEBUG)
1930:     if (!a) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to zero at a null pointer");
1931: #endif
1932: #if defined(PETSC_PREFER_ZERO_FOR_MEMZERO)
1933:     if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) {
1934:       size_t      i,len = n/sizeof(PetscScalar);
1935:       PetscScalar *x = (PetscScalar*)a;
1936:       for (i=0; i<len; i++) x[i] = 0.0;
1937:     } else {
1938: #elif defined(PETSC_PREFER_FORTRAN_FOR_MEMZERO)
1939:     if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) {
1940:       PetscInt len = n/sizeof(PetscScalar);
1941:       fortranzero_(&len,(PetscScalar*)a);
1942:     } else {
1943: #endif
1944: #if defined(PETSC_PREFER_BZERO)
1945:       bzero((char *)a,n);
1946: #else
1947:       memset((char*)a,0,n);
1948: #endif
1949: #if defined(PETSC_PREFER_ZERO_FOR_MEMZERO) || defined(PETSC_PREFER_FORTRAN_FOR_MEMZERO)
1950:     }
1951: #endif
1952:   }
1953:   return 0;
1954: }

1956: /*MC
1957:    PetscPrefetchBlock - Prefetches a block of memory

1959:    Synopsis:
1960:     #include <petscsys.h>
1961:     void PetscPrefetchBlock(const anytype *a,size_t n,int rw,int t)

1963:    Not Collective

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

1971:    Level: developer

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

1976:    Adopting Intel's x86/x86-64 conventions, there are four levels of temporal locality.  Not all architectures offer
1977:    equivalent locality hints, but the following macros are always defined to their closest analogue.
1978: +  PETSC_PREFETCH_HINT_NTA - Non-temporal.  Prefetches directly to L1, evicts to memory (skips higher level cache unless it was already there when prefetched).
1979: .  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.
1980: .  PETSC_PREFETCH_HINT_T1 - Fetch to level 2 and higher (not L1).
1981: -  PETSC_PREFETCH_HINT_T2 - Fetch to high-level cache only.  (On many systems, T0 and T1 are equivalent.)

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

1986:    Concepts: memory
1987: M*/
1988: #define PetscPrefetchBlock(a,n,rw,t) do {                               \
1989:     const char *_p = (const char*)(a),*_end = (const char*)((a)+(n));   \
1990:     for ( ; _p < _end; _p += PETSC_LEVEL1_DCACHE_LINESIZE) PETSC_Prefetch(_p,(rw),(t)); \
1991:   } while (0)

1993: /*
1994:       Determine if some of the kernel computation routines use
1995:    Fortran (rather than C) for the numerical calculations. On some machines
1996:    and compilers (like complex numbers) the Fortran version of the routines
1997:    is faster than the C/C++ versions. The flag --with-fortran-kernels
1998:    should be used with ./configure to turn these on.
1999: */
2000: #if defined(PETSC_USE_FORTRAN_KERNELS)

2002: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTCRL)
2003: #define PETSC_USE_FORTRAN_KERNEL_MULTCRL
2004: #endif

2006: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJPERM)
2007: #define PETSC_USE_FORTRAN_KERNEL_MULTAIJPERM
2008: #endif

2010: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJ)
2011: #define PETSC_USE_FORTRAN_KERNEL_MULTAIJ
2012: #endif

2014: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ)
2015: #define PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ
2016: #endif

2018: #if !defined(PETSC_USE_FORTRAN_KERNEL_NORM)
2019: #define PETSC_USE_FORTRAN_KERNEL_NORM
2020: #endif

2022: #if !defined(PETSC_USE_FORTRAN_KERNEL_MAXPY)
2023: #define PETSC_USE_FORTRAN_KERNEL_MAXPY
2024: #endif

2026: #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ)
2027: #define PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ
2028: #endif

2030: #if !defined(PETSC_USE_FORTRAN_KERNEL_RELAXAIJ)
2031: #define PETSC_USE_FORTRAN_KERNEL_RELAXAIJ
2032: #endif

2034: #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ)
2035: #define PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ
2036: #endif

2038: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ)
2039: #define PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ
2040: #endif

2042: #if !defined(PETSC_USE_FORTRAN_KERNEL_MDOT)
2043: #define PETSC_USE_FORTRAN_KERNEL_MDOT
2044: #endif

2046: #if !defined(PETSC_USE_FORTRAN_KERNEL_XTIMESY)
2047: #define PETSC_USE_FORTRAN_KERNEL_XTIMESY
2048: #endif

2050: #if !defined(PETSC_USE_FORTRAN_KERNEL_AYPX)
2051: #define PETSC_USE_FORTRAN_KERNEL_AYPX
2052: #endif

2054: #if !defined(PETSC_USE_FORTRAN_KERNEL_WAXPY)
2055: #define PETSC_USE_FORTRAN_KERNEL_WAXPY
2056: #endif

2058: #endif

2060: /*
2061:     Macros for indicating code that should be compiled with a C interface,
2062:    rather than a C++ interface. Any routines that are dynamically loaded
2063:    (such as the PCCreate_XXX() routines) must be wrapped so that the name
2064:    mangler does not change the functions symbol name. This just hides the
2065:    ugly extern "C" {} wrappers.
2066: */
2067: #if defined(__cplusplus)
2068: #define EXTERN_C_BEGIN extern "C" {
2069: #define EXTERN_C_END }
2070: #else
2071: #define EXTERN_C_BEGIN
2072: #define EXTERN_C_END
2073: #endif

2075: /* --------------------------------------------------------------------*/

2077: /*MC
2078:     MPI_Comm - the basic object used by MPI to determine which processes are involved in a
2079:         communication

2081:    Level: beginner

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

2085: .seealso: PETSC_COMM_WORLD, PETSC_COMM_SELF
2086: M*/

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


2094:    Level: beginner

2096: .seealso: PetscReal, PassiveReal, PassiveScalar, MPIU_SCALAR, PetscInt
2097: M*/

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

2102:    Synopsis:
2103:    #define PETSC_DESIRE_COMPLEX
2104:    #include <petscsys.h>
2105:    PetscComplex number = 1. + 2.*PETSC_i;

2107:    Level: beginner

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

2115: .seealso: PetscReal, PetscComplex, MPIU_COMPLEX, PetscInt, PETSC_i
2116: M*/

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

2121:    Level: beginner

2123: .seealso: PetscScalar, PassiveReal, PassiveScalar
2124: M*/

2126: /*MC
2127:     PassiveScalar - PETSc type that represents a PetscScalar
2128:    Level: beginner

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

2133: .seealso: PetscReal, PassiveReal, PetscScalar
2134: M*/

2136: /*MC
2137:     PassiveReal - PETSc type that represents a PetscReal

2139:    Level: beginner

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

2144: .seealso: PetscScalar, PetscReal, PassiveScalar
2145: M*/

2147: /*MC
2148:     MPIU_SCALAR - MPI datatype corresponding to PetscScalar

2150:    Level: beginner

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

2155: .seealso: PetscReal, PassiveReal, PassiveScalar, PetscScalar, MPIU_INT
2156: M*/

2158: #if defined(PETSC_HAVE_MPIIO)
2159: #if !defined(PETSC_WORDS_BIGENDIAN)
2160: PETSC_EXTERN PetscErrorCode MPIU_File_write_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*);
2161: PETSC_EXTERN PetscErrorCode MPIU_File_read_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*);
2162: #else
2163: #define MPIU_File_write_all(a,b,c,d,e) MPI_File_write_all(a,b,c,d,e)
2164: #define MPIU_File_read_all(a,b,c,d,e) MPI_File_read_all(a,b,c,d,e)
2165: #endif
2166: #endif

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

2170: /* Limit MPI to 32-bits */
2171: #define PETSC_MPI_INT_MAX  2147483647
2172: #define PETSC_MPI_INT_MIN -2147483647
2173: /* Limit BLAS to 32-bits */
2174: #define PETSC_BLAS_INT_MAX  2147483647
2175: #define PETSC_BLAS_INT_MIN -2147483647

2179: PETSC_STATIC_INLINE PetscErrorCode PetscBLASIntCast(PetscInt a,PetscBLASInt *b)
2180: {
2182: #if defined(PETSC_USE_64BIT_INDICES) && !defined(PETSC_HAVE_64BIT_BLAS_INDICES)
2183:   if ((a) > PETSC_BLAS_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array too long for BLAS/LAPACK");
2184: #endif
2185:   *b =  (PetscBLASInt)(a);
2186:   return(0);
2187: }

2191: PETSC_STATIC_INLINE PetscErrorCode PetscMPIIntCast(PetscInt a,PetscMPIInt *b)
2192: {
2194: #if defined(PETSC_USE_64BIT_INDICES)
2195:   if ((a) > PETSC_MPI_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array too long for MPI");
2196: #endif
2197:   *b =  (PetscMPIInt)(a);
2198:   return(0);
2199: }


2202: /*
2203:      The IBM include files define hz, here we hide it so that it may be used as a regular user variable.
2204: */
2205: #if defined(hz)
2206: #undef hz
2207: #endif

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


2212: #if defined(PETSC_HAVE_LIMITS_H)
2213: #include <limits.h>
2214: #endif
2215: #if defined(PETSC_HAVE_SYS_PARAM_H)
2216: #include <sys/param.h>
2217: #endif
2218: #if defined(PETSC_HAVE_SYS_TYPES_H)
2219: #include <sys/types.h>
2220: #endif
2221: #if defined(MAXPATHLEN)
2222: #  define PETSC_MAX_PATH_LEN     MAXPATHLEN
2223: #elif defined(MAX_PATH)
2224: #  define PETSC_MAX_PATH_LEN     MAX_PATH
2225: #elif defined(_MAX_PATH)
2226: #  define PETSC_MAX_PATH_LEN     _MAX_PATH
2227: #else
2228: #  define PETSC_MAX_PATH_LEN     4096
2229: #endif

2231: /*MC

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

2235: $    1) classic Fortran 77 style
2236: $#include "finclude/petscXXX.h" to work with material from the XXX component of PETSc
2237: $       XXX variablename
2238: $      You cannot use this approach if you wish to use the Fortran 90 specific PETSc routines
2239: $      which end in F90; such as VecGetArrayF90()
2240: $
2241: $    2) classic Fortran 90 style
2242: $#include "finclude/petscXXX.h"
2243: $#include "finclude/petscXXX.h90" to work with material from the XXX component of PETSc
2244: $       XXX variablename
2245: $
2246: $    3) Using Fortran modules
2247: $#include "finclude/petscXXXdef.h"
2248: $         use petscXXXX
2249: $       XXX variablename
2250: $
2251: $    4) Use Fortran modules and Fortran data types for PETSc types
2252: $#include "finclude/petscXXXdef.h"
2253: $         use petscXXXX
2254: $       type(XXX) variablename
2255: $      To use this approach you must ./configure PETSc with the additional
2256: $      option --with-fortran-datatypes You cannot use the type(XXX) declaration approach without using Fortran modules

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

2260: $    3a) skip the #include BUT you cannot use any PETSc data type names like Vec, Mat, PetscInt, PetscErrorCode etc
2261: $        and you must declare the variables as integer, for example
2262: $        integer variablename
2263: $
2264: $    4a) skip the #include, you use the object types like type(Vec) type(Mat) but cannot use the data type
2265: $        names like PetscErrorCode, PetscInt etc. again for those you must use integer

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

2270:    Fortran type checking with interfaces is strick, this means you cannot pass a scalar value when an array value
2271: is expected (even though it is legal Fortran). For example when setting a single value in a matrix with MatSetValues()
2272: you cannot have something like
2273: $      PetscInt row,col
2274: $      PetscScalar val
2275: $        ...
2276: $      call MatSetValues(mat,1,row,1,col,val,INSERT_VALUES,ierr)
2277: You must instead have
2278: $      PetscInt row(1),col(1)
2279: $      PetscScalar val(1)
2280: $        ...
2281: $      call MatSetValues(mat,1,row,1,col,val,INSERT_VALUES,ierr)


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

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

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

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

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

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

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

2306:     Level: beginner

2308: M*/

2310: PETSC_EXTERN PetscErrorCode PetscGetArchType(char[],size_t);
2311: PETSC_EXTERN PetscErrorCode PetscGetHostName(char[],size_t);
2312: PETSC_EXTERN PetscErrorCode PetscGetUserName(char[],size_t);
2313: PETSC_EXTERN PetscErrorCode PetscGetProgramName(char[],size_t);
2314: PETSC_EXTERN PetscErrorCode PetscSetProgramName(const char[]);
2315: PETSC_EXTERN PetscErrorCode PetscGetDate(char[],size_t);
2316: PETSC_EXTERN PetscErrorCode PetscGetVersion(char[], size_t);

2318: PETSC_EXTERN PetscErrorCode PetscSortInt(PetscInt,PetscInt[]);
2319: PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsInt(PetscInt*,PetscInt[]);
2320: PETSC_EXTERN PetscErrorCode PetscFindInt(PetscInt, PetscInt, const PetscInt[], PetscInt*);
2321: PETSC_EXTERN PetscErrorCode PetscSortIntWithPermutation(PetscInt,const PetscInt[],PetscInt[]);
2322: PETSC_EXTERN PetscErrorCode PetscSortStrWithPermutation(PetscInt,const char*[],PetscInt[]);
2323: PETSC_EXTERN PetscErrorCode PetscSortIntWithArray(PetscInt,PetscInt[],PetscInt[]);
2324: PETSC_EXTERN PetscErrorCode PetscSortIntWithArrayPair(PetscInt,PetscInt*,PetscInt*,PetscInt*);
2325: PETSC_EXTERN PetscErrorCode PetscSortMPIInt(PetscInt,PetscMPIInt[]);
2326: PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsMPIInt(PetscInt*,PetscMPIInt[]);
2327: PETSC_EXTERN PetscErrorCode PetscSortMPIIntWithArray(PetscMPIInt,PetscMPIInt[],PetscMPIInt[]);
2328: PETSC_EXTERN PetscErrorCode PetscSortIntWithScalarArray(PetscInt,PetscInt[],PetscScalar[]);
2329: PETSC_EXTERN PetscErrorCode PetscSortReal(PetscInt,PetscReal[]);
2330: PETSC_EXTERN PetscErrorCode PetscSortRealWithPermutation(PetscInt,const PetscReal[],PetscInt[]);
2331: PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsReal(PetscInt*,PetscReal[]);
2332: PETSC_EXTERN PetscErrorCode PetscSortSplit(PetscInt,PetscInt,PetscScalar[],PetscInt[]);
2333: PETSC_EXTERN PetscErrorCode PetscSortSplitReal(PetscInt,PetscInt,PetscReal[],PetscInt[]);
2334: PETSC_EXTERN PetscErrorCode PetscProcessTree(PetscInt,const PetscBool [],const PetscInt[],PetscInt*,PetscInt**,PetscInt**,PetscInt**,PetscInt**);
2335: PETSC_EXTERN PetscErrorCode PetscMergeIntArrayPair(PetscInt,const PetscInt*,const PetscInt*,PetscInt,const PetscInt*,const PetscInt*,PetscInt*,PetscInt**,PetscInt**);

2337: PETSC_EXTERN PetscErrorCode PetscSetDisplay(void);
2338: PETSC_EXTERN PetscErrorCode PetscGetDisplay(char[],size_t);

2340: /*J
2341:     PetscRandomType - String with the name of a PETSc randomizer

2343:    Level: beginner

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

2348: .seealso: PetscRandomSetType(), PetscRandom, PetscRandomCreate()
2349: J*/
2350: typedef const char* PetscRandomType;
2351: #define PETSCRAND       "rand"
2352: #define PETSCRAND48     "rand48"
2353: #define PETSCSPRNG      "sprng"

2355: /* Logging support */
2356: PETSC_EXTERN PetscClassId PETSC_RANDOM_CLASSID;

2358: PETSC_EXTERN PetscErrorCode PetscRandomInitializePackage(void);

2360: /*S
2361:      PetscRandom - Abstract PETSc object that manages generating random numbers

2363:    Level: intermediate

2365:   Concepts: random numbers

2367: .seealso:  PetscRandomCreate(), PetscRandomGetValue(), PetscRandomType
2368: S*/
2369: typedef struct _p_PetscRandom*   PetscRandom;

2371: /* Dynamic creation and loading functions */
2372: PETSC_EXTERN PetscFunctionList PetscRandomList;
2373: PETSC_EXTERN PetscBool         PetscRandomRegisterAllCalled;

2375: PETSC_EXTERN PetscErrorCode PetscRandomRegisterAll(void);
2376: PETSC_EXTERN PetscErrorCode PetscRandomRegister(const char[],PetscErrorCode (*)(PetscRandom));
2377: PETSC_EXTERN PetscErrorCode PetscRandomSetType(PetscRandom, PetscRandomType);
2378: PETSC_EXTERN PetscErrorCode PetscRandomSetFromOptions(PetscRandom);
2379: PETSC_EXTERN PetscErrorCode PetscRandomGetType(PetscRandom, PetscRandomType*);
2380: PETSC_STATIC_INLINE PetscErrorCode PetscRandomViewFromOptions(PetscRandom A,const char prefix[],const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,prefix,name);}
2381: PETSC_EXTERN PetscErrorCode PetscRandomView(PetscRandom,PetscViewer);

2383: PETSC_EXTERN PetscErrorCode PetscRandomCreate(MPI_Comm,PetscRandom*);
2384: PETSC_EXTERN PetscErrorCode PetscRandomGetValue(PetscRandom,PetscScalar*);
2385: PETSC_EXTERN PetscErrorCode PetscRandomGetValueReal(PetscRandom,PetscReal*);
2386: PETSC_EXTERN PetscErrorCode PetscRandomGetInterval(PetscRandom,PetscScalar*,PetscScalar*);
2387: PETSC_EXTERN PetscErrorCode PetscRandomSetInterval(PetscRandom,PetscScalar,PetscScalar);
2388: PETSC_EXTERN PetscErrorCode PetscRandomSetSeed(PetscRandom,unsigned long);
2389: PETSC_EXTERN PetscErrorCode PetscRandomGetSeed(PetscRandom,unsigned long *);
2390: PETSC_EXTERN PetscErrorCode PetscRandomSeed(PetscRandom);
2391: PETSC_EXTERN PetscErrorCode PetscRandomDestroy(PetscRandom*);

2393: PETSC_EXTERN PetscErrorCode PetscGetFullPath(const char[],char[],size_t);
2394: PETSC_EXTERN PetscErrorCode PetscGetRelativePath(const char[],char[],size_t);
2395: PETSC_EXTERN PetscErrorCode PetscGetWorkingDirectory(char[],size_t);
2396: PETSC_EXTERN PetscErrorCode PetscGetRealPath(const char[],char[]);
2397: PETSC_EXTERN PetscErrorCode PetscGetHomeDirectory(char[],size_t);
2398: PETSC_EXTERN PetscErrorCode PetscTestFile(const char[],char,PetscBool *);
2399: PETSC_EXTERN PetscErrorCode PetscTestDirectory(const char[],char,PetscBool *);

2401: PETSC_EXTERN PetscErrorCode PetscBinaryRead(int,void*,PetscInt,PetscDataType);
2402: PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedRead(MPI_Comm,int,void*,PetscInt,PetscDataType);
2403: PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedWrite(MPI_Comm,int,void*,PetscInt,PetscDataType,PetscBool );
2404: PETSC_EXTERN PetscErrorCode PetscBinaryWrite(int,void*,PetscInt,PetscDataType,PetscBool );
2405: PETSC_EXTERN PetscErrorCode PetscBinaryOpen(const char[],PetscFileMode,int *);
2406: PETSC_EXTERN PetscErrorCode PetscBinaryClose(int);
2407: PETSC_EXTERN PetscErrorCode PetscSharedTmp(MPI_Comm,PetscBool  *);
2408: PETSC_EXTERN PetscErrorCode PetscSharedWorkingDirectory(MPI_Comm,PetscBool  *);
2409: PETSC_EXTERN PetscErrorCode PetscGetTmp(MPI_Comm,char[],size_t);
2410: PETSC_EXTERN PetscErrorCode PetscFileRetrieve(MPI_Comm,const char[],char[],size_t,PetscBool *);
2411: PETSC_EXTERN PetscErrorCode PetscLs(MPI_Comm,const char[],char[],size_t,PetscBool *);
2412: PETSC_EXTERN PetscErrorCode PetscOpenSocket(const char[],int,int*);
2413: PETSC_EXTERN PetscErrorCode PetscWebServe(MPI_Comm,int);

2415: /*
2416:    In binary files variables are stored using the following lengths,
2417:   regardless of how they are stored in memory on any one particular
2418:   machine. Use these rather then sizeof() in computing sizes for
2419:   PetscBinarySeek().
2420: */
2421: #define PETSC_BINARY_INT_SIZE   (32/8)
2422: #define PETSC_BINARY_FLOAT_SIZE  (32/8)
2423: #define PETSC_BINARY_CHAR_SIZE  (8/8)
2424: #define PETSC_BINARY_SHORT_SIZE  (16/8)
2425: #define PETSC_BINARY_DOUBLE_SIZE  (64/8)
2426: #define PETSC_BINARY_SCALAR_SIZE  sizeof(PetscScalar)

2428: /*E
2429:   PetscBinarySeekType - argument to PetscBinarySeek()

2431:   Level: advanced

2433: .seealso: PetscBinarySeek(), PetscBinarySynchronizedSeek()
2434: E*/
2435: typedef enum {PETSC_BINARY_SEEK_SET = 0,PETSC_BINARY_SEEK_CUR = 1,PETSC_BINARY_SEEK_END = 2} PetscBinarySeekType;
2436: PETSC_EXTERN PetscErrorCode PetscBinarySeek(int,off_t,PetscBinarySeekType,off_t*);
2437: PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedSeek(MPI_Comm,int,off_t,PetscBinarySeekType,off_t*);
2438: PETSC_EXTERN PetscErrorCode PetscByteSwap(void *,PetscDataType,PetscInt);

2440: PETSC_EXTERN PetscErrorCode PetscSetDebugTerminal(const char[]);
2441: PETSC_EXTERN PetscErrorCode PetscSetDebugger(const char[],PetscBool );
2442: PETSC_EXTERN PetscErrorCode PetscSetDefaultDebugger(void);
2443: PETSC_EXTERN PetscErrorCode PetscSetDebuggerFromString(const char*);
2444: PETSC_EXTERN PetscErrorCode PetscAttachDebugger(void);
2445: PETSC_EXTERN PetscErrorCode PetscStopForDebugger(void);

2447: PETSC_EXTERN PetscErrorCode PetscGatherNumberOfMessages(MPI_Comm,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt*);
2448: PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**);
2449: PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths2(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**,PetscMPIInt**);
2450: PETSC_EXTERN PetscErrorCode PetscPostIrecvInt(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscInt***,MPI_Request**);
2451: PETSC_EXTERN PetscErrorCode PetscPostIrecvScalar(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscScalar***,MPI_Request**);
2452: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSided(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscInt,const PetscMPIInt*,const void*,PetscInt*,PetscMPIInt**,void*) PetscAttrMPIPointerWithType(6,3);

2454: /*E
2455:     PetscBuildTwoSidedType - algorithm for setting up two-sided communication

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

2463:    Level: developer

2465: .seealso: PetscCommBuildTwoSided(), PetscCommBuildTwoSidedSetType(), PetscCommBuildTwoSidedGetType()
2466: E*/
2467: typedef enum {
2468:   PETSC_BUILDTWOSIDED_NOTSET = -1,
2469:   PETSC_BUILDTWOSIDED_ALLREDUCE = 0,
2470:   PETSC_BUILDTWOSIDED_IBARRIER = 1
2471:   /* Updates here must be accompanied by updates in finclude/petscsys.h and the string array in mpits.c */
2472: } PetscBuildTwoSidedType;
2473: PETSC_EXTERN const char *const PetscBuildTwoSidedTypes[];
2474: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedSetType(MPI_Comm,PetscBuildTwoSidedType);
2475: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedGetType(MPI_Comm,PetscBuildTwoSidedType*);

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

2479: /*E
2480:   InsertMode - Whether entries are inserted or added into vectors or matrices

2482:   Level: beginner

2484: .seealso: VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(),
2485:           VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(),
2486:           MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd()
2487: E*/
2488:  typedef enum {NOT_SET_VALUES, INSERT_VALUES, ADD_VALUES, MAX_VALUES, INSERT_ALL_VALUES, ADD_ALL_VALUES, INSERT_BC_VALUES, ADD_BC_VALUES} InsertMode;

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

2493:     Level: beginner

2495: .seealso: InsertMode, VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(),
2496:           VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), ADD_VALUES,
2497:           MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd(), MAX_VALUES

2499: M*/

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

2505:     Level: beginner

2507: .seealso: InsertMode, VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(),
2508:           VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), INSERT_VALUES,
2509:           MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd(), MAX_VALUES

2511: M*/

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

2516:     Level: beginner

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

2520: M*/

2522: PETSC_EXTERN MPI_Comm PetscObjectComm(PetscObject);

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

2527: /*S
2528:    PetscSubcomm - Context of MPI subcommunicators, used by PCREDUNDANT

2530:    Level: advanced

2532:    Concepts: communicator, create
2533: S*/
2534: typedef struct _n_PetscSubcomm* PetscSubcomm;

2536: struct _n_PetscSubcomm {
2537:   MPI_Comm    parent;           /* parent communicator */
2538:   MPI_Comm    dupparent;        /* duplicate parent communicator, under which the processors of this subcomm have contiguous rank */
2539:   MPI_Comm    comm;             /* this communicator */
2540:   PetscMPIInt n;                /* num of subcommunicators under the parent communicator */
2541:   PetscMPIInt color;            /* color of processors belong to this communicator */
2542:   PetscMPIInt *subsize;         /* size of subcommunicator[color] */
2543:   PetscSubcommType type;
2544: };

2546: PETSC_EXTERN PetscErrorCode PetscSubcommCreate(MPI_Comm,PetscSubcomm*);
2547: PETSC_EXTERN PetscErrorCode PetscSubcommDestroy(PetscSubcomm*);
2548: PETSC_EXTERN PetscErrorCode PetscSubcommSetNumber(PetscSubcomm,PetscInt);
2549: PETSC_EXTERN PetscErrorCode PetscSubcommSetType(PetscSubcomm,PetscSubcommType);
2550: PETSC_EXTERN PetscErrorCode PetscSubcommSetTypeGeneral(PetscSubcomm,PetscMPIInt,PetscMPIInt);
2551: PETSC_EXTERN PetscErrorCode PetscSubcommView(PetscSubcomm,PetscViewer);
2552: PETSC_EXTERN PetscErrorCode PetscSubcommSetFromOptions(PetscSubcomm);

2554: /*S
2555:    PetscSegBuffer - a segmented extendable buffer

2557:    Level: developer

2559: .seealso: PetscSegBufferCreate(), PetscSegBufferGet(), PetscSegBufferExtract(), PetscSegBufferDestroy()
2560: S*/
2561: typedef struct _n_PetscSegBuffer *PetscSegBuffer;
2562: PETSC_EXTERN PetscErrorCode PetscSegBufferCreate(size_t,size_t,PetscSegBuffer*);
2563: PETSC_EXTERN PetscErrorCode PetscSegBufferDestroy(PetscSegBuffer*);
2564: PETSC_EXTERN PetscErrorCode PetscSegBufferGet(PetscSegBuffer,size_t,void*);
2565: PETSC_EXTERN PetscErrorCode PetscSegBufferExtractAlloc(PetscSegBuffer,void*);
2566: PETSC_EXTERN PetscErrorCode PetscSegBufferExtractTo(PetscSegBuffer,void*);
2567: PETSC_EXTERN PetscErrorCode PetscSegBufferExtractInPlace(PetscSegBuffer,void*);
2568: PETSC_EXTERN PetscErrorCode PetscSegBufferGetSize(PetscSegBuffer,size_t*);
2569: PETSC_EXTERN PetscErrorCode PetscSegBufferUnuse(PetscSegBuffer,size_t);

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

2576: extern PetscSegBuffer PetscCitationsList;
2579: /*@C
2580:       PetscCitationsRegister - Register a bibtex item to obtain credit for an implemented algorithm used in the code.

2582:      Not Collective - only what is registered on rank 0 of PETSC_COMM_WORLD will be printed

2584:      Input Parameters:
2585: +      cite - the bibtex item, formated to displayed on multiple lines nicely
2586: -      set - a boolean variable initially set to PETSC_FALSE; this is used to insure only a single registration of the citation

2588:    Level: intermediate

2590:      Options Database:
2591: .     -citations [filenmae]   - print out the bibtex entries for the given computation
2592: @*/
2593: PETSC_STATIC_INLINE PetscErrorCode PetscCitationsRegister(const char cit[],PetscBool *set)
2594: {
2595:   size_t         len;
2596:   char           *vstring;

2600:   if (set && *set) return(0);
2601:   PetscStrlen(cit,&len);
2602:   PetscSegBufferGet(PetscCitationsList,(PetscInt)len,&vstring);
2603:   PetscMemcpy(vstring,cit,len);
2604:   if (set) *set = PETSC_TRUE;
2605:   return(0);
2606: }


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

2613: #endif