Actual source code: petscsys.h

petsc-master 2017-04-20
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:    For --prefix installs the ${PETSC_ARCH}/ does not exist and petscconf.h is in the same
 12:    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__DEFAULT_SOURCE) && !defined(_DEFAULT_SOURCE)
 29: #define _DEFAULT_SOURCE
 30: #endif
 31: #if defined(PETSC__GNU_SOURCE) && !defined(_GNU_SOURCE)
 32: #define _GNU_SOURCE
 33: #endif
 34: #endif

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

 46: /* ========================================================================== */
 47: /*
 48:    Since PETSc manages its own extern "C" handling users should never include PETSc include
 49:    files within extern "C". This will generate a compiler error if a user does put the include 
 50:    file within an extern "C".
 51: */
 52: #if defined(__cplusplus)
 53: void assert_never_put_petsc_headers_inside_an_extern_c(int); void assert_never_put_petsc_headers_inside_an_extern_c(double);
 54: #endif

 56: #if defined(__cplusplus)
 57: #  define PETSC_RESTRICT PETSC_CXX_RESTRICT
 58: #else
 59: #  define PETSC_RESTRICT PETSC_C_RESTRICT
 60: #endif

 62: #if defined(__cplusplus)
 63: #  define PETSC_STATIC_INLINE PETSC_CXX_STATIC_INLINE
 64: #else
 65: #  define PETSC_STATIC_INLINE PETSC_C_STATIC_INLINE
 66: #endif

 68: #if defined(_WIN32) && defined(PETSC_USE_SHARED_LIBRARIES) /* For Win32 shared libraries */
 69: #  define  __declspec(dllexport)
 70: #  define PETSC_DLLIMPORT __declspec(dllimport)
 71: #  define PETSC_VISIBILITY_INTERNAL
 72: #elif defined(PETSC_USE_VISIBILITY_CXX) && defined(__cplusplus)
 73: #  define  __attribute__((visibility ("default")))
 74: #  define PETSC_DLLIMPORT __attribute__((visibility ("default")))
 75: #  define PETSC_VISIBILITY_INTERNAL __attribute__((visibility ("hidden")))
 76: #elif defined(PETSC_USE_VISIBILITY_C) && !defined(__cplusplus)
 77: #  define  __attribute__((visibility ("default")))
 78: #  define PETSC_DLLIMPORT __attribute__((visibility ("default")))
 79: #  define PETSC_VISIBILITY_INTERNAL __attribute__((visibility ("hidden")))
 80: #else
 81: #  define 
 82: #  define PETSC_DLLIMPORT
 83: #  define PETSC_VISIBILITY_INTERNAL
 84: #endif

 86: #if defined(petsc_EXPORTS)      /* CMake defines this when building the shared library */
 87: #  define PETSC_VISIBILITY_PUBLIC 
 88: #else  /* Win32 users need this to import symbols from petsc.dll */
 89: #  define PETSC_VISIBILITY_PUBLIC PETSC_DLLIMPORT
 90: #endif

 92: /*
 93:     Functions tagged with PETSC_EXTERN in the header files are
 94:   always defined as extern "C" when compiled with C++ so they may be
 95:   used from C and are always visible in the shared libraries
 96: */
 97: #if defined(__cplusplus)
 98: #define PETSC_EXTERN extern "C" PETSC_VISIBILITY_PUBLIC
 99: #define PETSC_EXTERN_TYPEDEF extern "C"
100: #define PETSC_INTERN extern "C" PETSC_VISIBILITY_INTERNAL
101: #else
102: #define PETSC_EXTERN extern PETSC_VISIBILITY_PUBLIC
103: #define PETSC_EXTERN_TYPEDEF
104: #define PETSC_INTERN extern PETSC_VISIBILITY_INTERNAL
105: #endif

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

110: /* ========================================================================== */

112: /*
113:     Defines the interface to MPI allowing the use of all MPI functions.

115:     PETSc does not use the C++ binding of MPI at ALL. The following flag
116:     makes sure the C++ bindings are not included. The C++ bindings REQUIRE
117:     putting mpi.h before ANY C++ include files, we cannot control this
118:     with all PETSc users. Users who want to use the MPI C++ bindings can include
119:     mpicxx.h directly in their code
120: */
121: #if !defined(MPICH_SKIP_MPICXX)
122: #  define MPICH_SKIP_MPICXX 1
123: #endif
124: #if !defined(OMPI_SKIP_MPICXX)
125: #  define OMPI_SKIP_MPICXX 1
126: #endif
127: #if !defined(OMPI_WANT_MPI_INTERFACE_WARNING)
128: #  define OMPI_WANT_MPI_INTERFACE_WARNING 0
129: #endif
130: #include <mpi.h>

132: /*
133:    Perform various sanity checks that the correct mpi.h is being included at compile time.
134:    This usually happens because
135:       * either an unexpected mpi.h is in the default compiler path (i.e. in /usr/include) or
136:       * an extra include path -I/something (which contains the unexpected mpi.h) is being passed to the compiler
137: */
138: #if defined(PETSC_HAVE_MPIUNI)
139: #  if !defined(__MPIUNI_H)
140: #    error "PETSc was configured with --with-mpi=0 but now appears to be compiling using a different mpi.h"
141: #  endif
142: #elif defined(PETSC_HAVE_MPICH_NUMVERSION)
143: #  if !defined(MPICH_NUMVERSION)
144: #    error "PETSc was configured with MPICH but now appears to be compiling using a non-MPICH mpi.h"
145: #  elif MPICH_NUMVERSION != PETSC_HAVE_MPICH_NUMVERSION
146: #    error "PETSc was configured with one MPICH mpi.h version but now appears to be compiling using a different MPICH mpi.h version"
147: #  endif
148: #elif defined(PETSC_HAVE_OMPI_MAJOR_VERSION)
149: #  if !defined(OMPI_MAJOR_VERSION)
150: #    error "PETSc was configured with OpenMPI but now appears to be compiling using a non-OpenMPI mpi.h"
151: #  elif (OMPI_MAJOR_VERSION != PETSC_HAVE_OMPI_MAJOR_VERSION) || (OMPI_MINOR_VERSION != PETSC_HAVE_OMPI_MINOR_VERSION) || (OMPI_RELEASE_VERSION != PETSC_HAVE_OMPI_RELEASE_VERSION)
152: #    error "PETSc was configured with one OpenMPI mpi.h version but now appears to be compiling using a different OpenMPI mpi.h version"
153: #  endif
154: #endif

156: /*
157:     Need to put stdio.h AFTER mpi.h for MPICH2 with C++ compiler
158:     see the top of mpicxx.h in the MPICH2 distribution.
159: */
160: #include <stdio.h>

162: /* MSMPI on 32bit windows requires this yukky hack - that breaks MPI standard compliance */
163: #if !defined(MPIAPI)
164: #define MPIAPI
165: #endif

167: /*
168:    Support for Clang (>=3.2) matching type tag arguments with void* buffer types.
169:    This allows the compiler to detect cases where the MPI datatype argument passed to a MPI routine
170:    does not match the actual type of the argument being passed in
171: */
172: #if defined(__has_attribute) && defined(works_with_const_which_is_not_true)
173: #  if __has_attribute(argument_with_type_tag) && __has_attribute(pointer_with_type_tag) && __has_attribute(type_tag_for_datatype)
174: #    define PetscAttrMPIPointerWithType(bufno,typeno) __attribute__((pointer_with_type_tag(MPI,bufno,typeno)))
175: #    define PetscAttrMPITypeTag(type)                 __attribute__((type_tag_for_datatype(MPI,type)))
176: #    define PetscAttrMPITypeTagLayoutCompatible(type) __attribute__((type_tag_for_datatype(MPI,type,layout_compatible)))
177: #  endif
178: #endif
179: #if !defined(PetscAttrMPIPointerWithType)
180: #  define PetscAttrMPIPointerWithType(bufno,typeno)
181: #  define PetscAttrMPITypeTag(type)
182: #  define PetscAttrMPITypeTagLayoutCompatible(type)
183: #endif

185: /*MC
186:     PetscErrorCode - datatype used for return error code from almost all PETSc functions

188:     Level: beginner

190: .seealso: CHKERRQ, SETERRQ
191: M*/
192: typedef int PetscErrorCode;

194: /*MC

196:     PetscClassId - A unique id used to identify each PETSc class.

198:     Notes: Use PetscClassIdRegister() to obtain a new value for a new class being created. Usually
199:          XXXInitializePackage() calls it for each class it defines.

201:     Developer Notes: Internal integer stored in the _p_PetscObject data structure.
202:          These are all computed by an offset from the lowest one, PETSC_SMALLEST_CLASSID.

204:     Level: developer

206: .seealso: PetscClassIdRegister(), PetscLogEventRegister(), PetscHeaderCreate()
207: M*/
208: typedef int PetscClassId;


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

214:     Level: intermediate

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

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

222: .seealso: PetscBLASInt, PetscInt, PetscMPIIntCast()

224: M*/
225: typedef int PetscMPIInt;

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

230:     Level: intermediate

232: .seealso: PetscOptionsGetEnum(), PetscOptionsEnum(), PetscBagRegisterEnum()
233: M*/
234: typedef enum { ENUM_DUMMY } PetscEnum;
235: PETSC_EXTERN MPI_Datatype MPIU_ENUM PetscAttrMPITypeTag(PetscEnum);

237: #if defined(PETSC_HAVE_STDINT_H)
238: #include <stdint.h>
239: #endif
240: #if defined (PETSC_HAVE_INTTYPES_H)
242: #include <inttypes.h>
243: # if !defined(PRId64)
244: # define PRId64 "ld"
245: # endif
246: #endif

248: typedef short PetscShort;
249: typedef char PetscChar;
250: typedef float PetscFloat;

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


258:    Notes: For MPI calls that require datatypes, use MPIU_INT as the datatype for PetscInt. It will automatically work correctly regardless of 
259:           the size of PetscInt

261:    Level: intermediate

263: .seealso: PetscScalar, PetscBLASInt, PetscMPIInt
264: M*/
265: #if defined(PETSC_HAVE_STDINT_H) && defined(PETSC_HAVE_INTTYPES_H) && defined(PETSC_HAVE_MPI_INT64_T) /* MPI_INT64_T is not guaranteed to be a macro */
266: typedef int64_t PetscInt64;
267: # define MPIU_INT64 MPI_INT64_T
268: # define PetscInt64_FMT PRId64
269: #elif (PETSC_SIZEOF_LONG_LONG == 8)
270: typedef long long PetscInt64;
271: # define MPIU_INT64 MPI_LONG_LONG_INT
272: # define PetscInt64_FMT "lld"
273: #elif defined(PETSC_HAVE___INT64)
274: typedef __int64 PetscInt64;
275: # define MPIU_INT64 MPI_INT64_T
276: # define PetscInt64_FMT "ld"
277: #else
278: #error "cannot determine PetscInt64 type"
279: #endif
280: #if defined(PETSC_USE_64BIT_INDICES)
281: typedef PetscInt64 PetscInt;
282: #define MPIU_INT MPIU_INT64
283: #define PetscInt_FMT PetscInt64_FMT
284: #else
285: typedef int PetscInt;
286: #define MPIU_INT MPI_INT
287: #define PetscInt_FMT "d"
288: #endif

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

293:     Level: intermediate

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

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

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

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

310:         OpenBLAS can also be built to use 64 bit integers. The ./configure options --download-openblas -download-openblas-64-bit-blas-indices 
311:         will build a 64 bit integer version

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

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

318: .seealso: PetscMPIInt, PetscInt, PetscBLASIntCast()

320: M*/
321: #if defined(PETSC_HAVE_64BIT_BLAS_INDICES)
322: typedef PetscInt64 PetscBLASInt;
323: #else
324: typedef int PetscBLASInt;
325: #endif

327: /*
328:     For the rare cases when one needs to send a size_t object with MPI
329: */
330: #if (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_INT)
331: #define MPIU_SIZE_T MPI_UNSIGNED
332: #elif  (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_LONG)
333: #define MPIU_SIZE_T MPI_UNSIGNED_LONG
334: #elif  (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_LONG_LONG)
335: #define MPIU_SIZE_T MPI_UNSIGNED_LONG_LONG
336: #else
337: #error "Unknown size for size_t! Send us a bugreport at petsc-maint@mcs.anl.gov"
338: #endif

340: /*
341:       You can use PETSC_STDOUT as a replacement of stdout. You can also change
342:     the value of PETSC_STDOUT to redirect all standard output elsewhere
343: */
344: PETSC_EXTERN FILE* PETSC_STDOUT;

346: /*
347:       You can use PETSC_STDERR as a replacement of stderr. You can also change
348:     the value of PETSC_STDERR to redirect all standard error elsewhere
349: */
350: PETSC_EXTERN FILE* PETSC_STDERR;

352: /*MC
353:     PetscUnlikely - hints the compiler that the given condition is usually FALSE

355:     Synopsis:
356:     #include <petscsys.h>
357:     PetscBool  PetscUnlikely(PetscBool  cond)

359:     Not Collective

361:     Input Parameters:
362: .   cond - condition or expression

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

367:     Level: advanced

369: .seealso: PetscLikely(), CHKERRQ
370: M*/

372: /*MC
373:     PetscLikely - hints the compiler that the given condition is usually TRUE

375:     Synopsis:
376:     #include <petscsys.h>
377:     PetscBool  PetscLikely(PetscBool  cond)

379:     Not Collective

381:     Input Parameters:
382: .   cond - condition or expression

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

387:     Level: advanced

389: .seealso: PetscUnlikely()
390: M*/
391: #if defined(PETSC_HAVE_BUILTIN_EXPECT)
392: #  define PetscUnlikely(cond)   __builtin_expect(!!(cond),0)
393: #  define PetscLikely(cond)     __builtin_expect(!!(cond),1)
394: #else
395: #  define PetscUnlikely(cond)   (cond)
396: #  define PetscLikely(cond)     (cond)
397: #endif

399: /*
400:     Declare extern C stuff after including external header files
401: */


404: /*
405:        Basic PETSc constants
406: */

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

411:    Level: beginner

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

416: .seealso: PETSC_TRUE, PETSC_FALSE, PetscNot()
417: E*/
418: typedef enum { PETSC_FALSE,PETSC_TRUE } PetscBool;
419: PETSC_EXTERN const char *const PetscBools[];
420: PETSC_EXTERN MPI_Datatype MPIU_BOOL PetscAttrMPITypeTag(PetscBool);

422: /*
423:     Defines elementary mathematics functions and constants.
424: */
425:  #include <petscmath.h>

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

430:    Level: beginner

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

438: E*/
439: typedef enum { PETSC_COPY_VALUES, PETSC_OWN_POINTER, PETSC_USE_POINTER} PetscCopyMode;
440: PETSC_EXTERN const char *const PetscCopyModes[];

442: /*MC
443:     PETSC_FALSE - False value of PetscBool

445:     Level: beginner

447:     Note: Zero integer

449: .seealso: PetscBool, PETSC_TRUE
450: M*/

452: /*MC
453:     PETSC_TRUE - True value of PetscBool

455:     Level: beginner

457:     Note: Nonzero integer

459: .seealso: PetscBool, PETSC_FALSE
460: M*/

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

465:    Level: beginner

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

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

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

475: M*/
476: #define PETSC_IGNORE         NULL

478: /* This is deprecated */
479: #define PETSC_NULL NULL

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

485:    Level: beginner

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

489: M*/
490: #define PETSC_DECIDE  -1

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

496:    Level: beginner

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

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

503: M*/
504: #define PETSC_DETERMINE PETSC_DECIDE

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

510:    Level: beginner

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

514: .seealso: PETSC_DECIDE, PETSC_IGNORE, PETSC_DETERMINE

516: M*/
517: #define PETSC_DEFAULT  -2

519: /*MC
520:     PETSC_COMM_WORLD - the equivalent of the MPI_COMM_WORLD communicator which represents
521:            all the processs that PETSc knows about.

523:    Level: beginner

525:    Notes: By default PETSC_COMM_WORLD and MPI_COMM_WORLD are identical unless you wish to
526:           run PETSc on ONLY a subset of MPI_COMM_WORLD. In that case create your new (smaller)
527:           communicator, call it, say comm, and set PETSC_COMM_WORLD = comm BEFORE calling
528:           PetscInitialize(), but after MPI_Init() has been called.

530:           The value of PETSC_COMM_WORLD should never be USED/accessed before PetscInitialize()
531:           is called because it may not have a valid value yet.

533: .seealso: PETSC_COMM_SELF

535: M*/
536: PETSC_EXTERN MPI_Comm PETSC_COMM_WORLD;

538: /*MC
539:     PETSC_COMM_SELF - This is always MPI_COMM_SELF

541:    Level: beginner

543:    Notes: Do not USE/access or set this variable before PetscInitialize() has been called.

545: .seealso: PETSC_COMM_WORLD

547: M*/
548: #define PETSC_COMM_SELF MPI_COMM_SELF

550: PETSC_EXTERN PetscBool PetscBeganMPI;
551: PETSC_EXTERN PetscBool PetscInitializeCalled;
552: PETSC_EXTERN PetscBool PetscFinalizeCalled;
553: PETSC_EXTERN PetscBool PetscCUSPSynchronize;
554: PETSC_EXTERN PetscBool PetscViennaCLSynchronize;
555: PETSC_EXTERN PetscBool PetscCUDASynchronize;

557: PETSC_EXTERN PetscErrorCode PetscSetHelpVersionFunctions(PetscErrorCode (*)(MPI_Comm),PetscErrorCode (*)(MPI_Comm));
558: PETSC_EXTERN PetscErrorCode PetscCommDuplicate(MPI_Comm,MPI_Comm*,int*);
559: PETSC_EXTERN PetscErrorCode PetscCommDestroy(MPI_Comm*);

561: /*MC
562:    PetscMalloc - Allocates memory, One should use PetscNew(), PetscMalloc1() or PetscCalloc1() usually instead of this

564:    Synopsis:
565:     #include <petscsys.h>
566:    PetscErrorCode PetscMalloc(size_t m,void **result)

568:    Not Collective

570:    Input Parameter:
571: .  m - number of bytes to allocate

573:    Output Parameter:
574: .  result - memory allocated

576:    Level: beginner

578:    Notes:
579:    Memory is always allocated at least double aligned

581:    It is safe to allocate size 0 and pass the resulting pointer (which may or may not be NULL) to PetscFree().

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

585:   Concepts: memory allocation

587: M*/
588: #define PetscMalloc(a,b)  ((*PetscTrMalloc)((a),__LINE__,PETSC_FUNCTION_NAME,__FILE__,(void**)(b)))

590: /*MC
591:    PetscRealloc - Rellocates memory

593:    Synopsis:
594:     #include <petscsys.h>
595:    PetscErrorCode PetscRealloc(size_t m,void **result)

597:    Not Collective

599:    Input Parameters:
600: +  m - number of bytes to allocate
601: -  result - initial memory allocated

603:    Output Parameter:
604: .  result - new memory allocated

606:    Level: developer

608:    Notes:
609:    Memory is always allocated at least double aligned

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

613:   Concepts: memory allocation

615: M*/
616: #define PetscRealloc(a,b)  ((*PetscTrRealloc)((a),__LINE__,PETSC_FUNCTION_NAME,__FILE__,(void**)(b)))

618: /*MC
619:    PetscAddrAlign - Rounds up an address to PETSC_MEMALIGN alignment

621:    Synopsis:
622:     #include <petscsys.h>
623:    void *PetscAddrAlign(void *addr)

625:    Not Collective

627:    Input Parameters:
628: .  addr - address to align (any pointer type)

630:    Level: developer

632: .seealso: PetscMallocAlign()

634:   Concepts: memory allocation
635: M*/
636: #define PetscAddrAlign(a) (void*)((((PETSC_UINTPTR_T)(a))+(PETSC_MEMALIGN-1)) & ~(PETSC_MEMALIGN-1))

638: /*MC
639:    PetscMalloc1 - Allocates an array of memory aligned to PETSC_MEMALIGN

641:    Synopsis:
642:     #include <petscsys.h>
643:    PetscErrorCode PetscMalloc1(size_t m1,type **r1)

645:    Not Collective

647:    Input Parameter:
648: .  m1 - number of elements to allocate  (may be zero)

650:    Output Parameter:
651: .  r1 - memory allocated in first chunk

653:    Note: This uses the sizeof() of the memory type requested to determine the total memory to be allocated, therefore you should not
654:          multiply the number of elements requested by the sizeof() the type. For example use
655: $  PetscInt *id;
656: $  PetscMalloc1(10,&id);
657:         not
658: $  PetscInt *id;
659: $  PetscMalloc1(10*sizeof(PetscInt),&id);

661:         Does not zero the memory allocatd, used PetscCalloc1() to obtain memory that has been zeroed.

663:    Level: beginner

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

667:   Concepts: memory allocation

669: M*/
670: #define PetscMalloc1(m1,r1) PetscMalloc((m1)*sizeof(**(r1)),r1)

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

675:    Synopsis:
676:     #include <petscsys.h>
677:    PetscErrorCode PetscCalloc1(size_t m1,type **r1)

679:    Not Collective

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

684:    Output Parameter:
685: .  r1 - memory allocated in first chunk

687:    Notes: see PetsMalloc1() for more details on usage.

689:    Level: beginner

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

693:   Concepts: memory allocation

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

698: /*MC
699:    PetscMalloc2 - Allocates 2 arrays of memory both aligned to PETSC_MEMALIGN

701:    Synopsis:
702:     #include <petscsys.h>
703:    PetscErrorCode PetscMalloc2(size_t m1,type **r1,size_t m2,type **r2)

705:    Not Collective

707:    Input Parameter:
708: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
709: -  m2 - number of elements to allocate in 2nd chunk  (may be zero)

711:    Output Parameter:
712: +  r1 - memory allocated in first chunk
713: -  r2 - memory allocated in second chunk

715:    Level: developer

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

719:   Concepts: memory allocation

721: M*/
722: #if !defined(PETSC_USE_MALLOC_COALESCED)
723: #define PetscMalloc2(m1,r1,m2,r2) (PetscMalloc1((m1),(r1)) || PetscMalloc1((m2),(r2)))
724: #else
725: #define PetscMalloc2(m1,r1,m2,r2) ((((m1)+(m2)) ? (*(r2) = 0,PetscMalloc((m1)*sizeof(**(r1))+(m2)*sizeof(**(r2))+(PETSC_MEMALIGN-1),r1)) : 0) \
726:                                    || (*(void**)(r2) = PetscAddrAlign(*(r1)+(m1)),0) \
727:                                    || (!(m1) ? (*(r1) = 0,0) : 0) || (!(m2) ? (*(r2) = 0,0) : 0))
728: #endif

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

733:    Synopsis:
734:     #include <petscsys.h>
735:    PetscErrorCode PetscCalloc2(size_t m1,type **r1,size_t m2,type **r2)

737:    Not Collective

739:    Input Parameter:
740: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
741: -  m2 - number of elements to allocate in 2nd chunk  (may be zero)

743:    Output Parameter:
744: +  r1 - memory allocated in first chunk
745: -  r2 - memory allocated in second chunk

747:    Level: developer

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

751:   Concepts: memory allocation
752: M*/
753: #define PetscCalloc2(m1,r1,m2,r2) (PetscMalloc2((m1),(r1),(m2),(r2)) || PetscMemzero(*(r1),(m1)*sizeof(**(r1))) || PetscMemzero(*(r2),(m2)*sizeof(**(r2))))

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

758:    Synopsis:
759:     #include <petscsys.h>
760:    PetscErrorCode PetscMalloc3(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3)

762:    Not Collective

764:    Input Parameter:
765: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
766: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
767: -  m3 - number of elements to allocate in 3rd chunk  (may be zero)

769:    Output Parameter:
770: +  r1 - memory allocated in first chunk
771: .  r2 - memory allocated in second chunk
772: -  r3 - memory allocated in third chunk

774:    Level: developer

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

778:   Concepts: memory allocation

780: M*/
781: #if !defined(PETSC_USE_MALLOC_COALESCED)
782: #define PetscMalloc3(m1,r1,m2,r2,m3,r3) (PetscMalloc1((m1),(r1)) || PetscMalloc1((m2),(r2)) || PetscMalloc1((m3),(r3)))
783: #else
784: #define PetscMalloc3(m1,r1,m2,r2,m3,r3) ((((m1)+(m2)+(m3)) ? (*(r2) = 0,*(r3) = 0,PetscMalloc((m1)*sizeof(**(r1))+(m2)*sizeof(**(r2))+(m3)*sizeof(**(r3))+2*(PETSC_MEMALIGN-1),r1)) : 0) \
785:                                          || (*(void**)(r2) = PetscAddrAlign(*(r1)+(m1)),*(void**)(r3) = PetscAddrAlign(*(r2)+(m2)),0) \
786:                                          || (!(m1) ? (*(r1) = 0,0) : 0) || (!(m2) ? (*(r2) = 0,0) : 0) || (!(m3) ? (*(r3) = 0,0) : 0))
787: #endif

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

792:    Synopsis:
793:     #include <petscsys.h>
794:    PetscErrorCode PetscCalloc3(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3)

796:    Not Collective

798:    Input Parameter:
799: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
800: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
801: -  m3 - number of elements to allocate in 3rd chunk  (may be zero)

803:    Output Parameter:
804: +  r1 - memory allocated in first chunk
805: .  r2 - memory allocated in second chunk
806: -  r3 - memory allocated in third chunk

808:    Level: developer

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

812:   Concepts: memory allocation
813: M*/
814: #define PetscCalloc3(m1,r1,m2,r2,m3,r3)                                 \
815:   (PetscMalloc3((m1),(r1),(m2),(r2),(m3),(r3))                          \
816:    || PetscMemzero(*(r1),(m1)*sizeof(**(r1))) || PetscMemzero(*(r2),(m2)*sizeof(**(r2))) || PetscMemzero(*(r3),(m3)*sizeof(**(r3))))

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

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

825:    Not Collective

827:    Input Parameter:
828: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
829: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
830: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
831: -  m4 - number of elements to allocate in 4th chunk  (may be zero)

833:    Output Parameter:
834: +  r1 - memory allocated in first chunk
835: .  r2 - memory allocated in second chunk
836: .  r3 - memory allocated in third chunk
837: -  r4 - memory allocated in fourth chunk

839:    Level: developer

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

843:   Concepts: memory allocation

845: M*/
846: #if !defined(PETSC_USE_MALLOC_COALESCED)
847: #define PetscMalloc4(m1,r1,m2,r2,m3,r3,m4,r4) (PetscMalloc1((m1),(r1)) || PetscMalloc1((m2),(r2)) || PetscMalloc1((m3),(r3)) || PetscMalloc1((m4),(r4)))
848: #else
849: #define PetscMalloc4(m1,r1,m2,r2,m3,r3,m4,r4)                           \
850:   ((((m1)+(m2)+(m3)+(m4)) ? (*(r2) = 0, *(r3) = 0, *(r4) = 0,PetscMalloc((m1)*sizeof(**(r1))+(m2)*sizeof(**(r2))+(m3)*sizeof(**(r3))+(m4)*sizeof(**(r4))+3*(PETSC_MEMALIGN-1),r1)) : 0) \
851:    || (*(void**)(r2) = PetscAddrAlign(*(r1)+(m1)),*(void**)(r3) = PetscAddrAlign(*(r2)+(m2)),*(void**)(r4) = PetscAddrAlign(*(r3)+(m3)),0) \
852:    || (!(m1) ? (*(r1) = 0,0) : 0) || (!(m2) ? (*(r2) = 0,0) : 0) || (!(m3) ? (*(r3) = 0,0) : 0) || (!(m4) ? (*(r4) = 0,0) : 0))
853: #endif

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

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

862:    Not Collective

864:    Input Parameter:
865: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
866: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
867: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
868: -  m4 - number of elements to allocate in 4th chunk  (may be zero)

870:    Output Parameter:
871: +  r1 - memory allocated in first chunk
872: .  r2 - memory allocated in second chunk
873: .  r3 - memory allocated in third chunk
874: -  r4 - memory allocated in fourth chunk

876:    Level: developer

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

880:   Concepts: memory allocation

882: M*/
883: #define PetscCalloc4(m1,r1,m2,r2,m3,r3,m4,r4)                           \
884:   (PetscMalloc4(m1,r1,m2,r2,m3,r3,m4,r4)                                \
885:    || PetscMemzero(*(r1),(m1)*sizeof(**(r1))) || PetscMemzero(*(r2),(m2)*sizeof(**(r2))) || PetscMemzero(*(r3),(m3)*sizeof(**(r3))) \
886:    || PetscMemzero(*(r4),(m4)*sizeof(**(r4))))

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

891:    Synopsis:
892:     #include <petscsys.h>
893:    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)

895:    Not Collective

897:    Input Parameter:
898: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
899: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
900: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
901: .  m4 - number of elements to allocate in 4th chunk  (may be zero)
902: -  m5 - number of elements to allocate in 5th chunk  (may be zero)

904:    Output Parameter:
905: +  r1 - memory allocated in first chunk
906: .  r2 - memory allocated in second chunk
907: .  r3 - memory allocated in third chunk
908: .  r4 - memory allocated in fourth chunk
909: -  r5 - memory allocated in fifth chunk

911:    Level: developer

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

915:   Concepts: memory allocation

917: M*/
918: #if !defined(PETSC_USE_MALLOC_COALESCED)
919: #define PetscMalloc5(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5) (PetscMalloc1((m1),(r1)) || PetscMalloc1((m2),(r2)) || PetscMalloc1((m3),(r3)) || PetscMalloc1((m4),(r4)) || PetscMalloc1((m5),(r5)))
920: #else
921: #define PetscMalloc5(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5)      \
922:   ((((m1)+(m2)+(m3)+(m4)+(m5)) ? (*(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)) : 0) \
923:    || (*(void**)(r2) = PetscAddrAlign(*(r1)+(m1)),*(void**)(r3) = PetscAddrAlign(*(r2)+(m2)),*(void**)(r4) = PetscAddrAlign(*(r3)+(m3)),*(void**)(r5) = PetscAddrAlign(*(r4)+(m4)),0) \
924:    || (!(m1) ? (*(r1) = 0,0) : 0) || (!(m2) ? (*(r2) = 0,0) : 0) || (!(m3) ? (*(r3) = 0,0) : 0) || (!(m4) ? (*(r4) = 0,0) : 0) || (!(m5) ? (*(r5) = 0,0) : 0))
925: #endif

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

930:    Synopsis:
931:     #include <petscsys.h>
932:    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)

934:    Not Collective

936:    Input Parameter:
937: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
938: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
939: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
940: .  m4 - number of elements to allocate in 4th chunk  (may be zero)
941: -  m5 - number of elements to allocate in 5th chunk  (may be zero)

943:    Output Parameter:
944: +  r1 - memory allocated in first chunk
945: .  r2 - memory allocated in second chunk
946: .  r3 - memory allocated in third chunk
947: .  r4 - memory allocated in fourth chunk
948: -  r5 - memory allocated in fifth chunk

950:    Level: developer

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

954:   Concepts: memory allocation

956: M*/
957: #define PetscCalloc5(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5)                     \
958:   (PetscMalloc5(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5)                          \
959:    || PetscMemzero(*(r1),(m1)*sizeof(**(r1))) || PetscMemzero(*(r2),(m2)*sizeof(**(r2))) || PetscMemzero(*(r3),(m3)*sizeof(**(r3))) \
960:    || PetscMemzero(*(r4),(m4)*sizeof(**(r4))) || PetscMemzero(*(r5),(m5)*sizeof(**(r5))))

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

965:    Synopsis:
966:     #include <petscsys.h>
967:    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)

969:    Not Collective

971:    Input Parameter:
972: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
973: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
974: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
975: .  m4 - number of elements to allocate in 4th chunk  (may be zero)
976: .  m5 - number of elements to allocate in 5th chunk  (may be zero)
977: -  m6 - number of elements to allocate in 6th chunk  (may be zero)

979:    Output Parameter:
980: +  r1 - memory allocated in first chunk
981: .  r2 - memory allocated in second chunk
982: .  r3 - memory allocated in third chunk
983: .  r4 - memory allocated in fourth chunk
984: .  r5 - memory allocated in fifth chunk
985: -  r6 - memory allocated in sixth chunk

987:    Level: developer

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

991:   Concepts: memory allocation

993: M*/
994: #if !defined(PETSC_USE_MALLOC_COALESCED)
995: #define PetscMalloc6(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6) (PetscMalloc1((m1),(r1)) || PetscMalloc1((m2),(r2)) || PetscMalloc1((m3),(r3)) || PetscMalloc1((m4),(r4)) || PetscMalloc1((m5),(r5)) || PetscMalloc1((m6),(r6)))
996: #else
997: #define PetscMalloc6(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6) \
998:   ((((m1)+(m2)+(m3)+(m4)+(m5)+(m6)) ? (*(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)) : 0) \
999:    || (*(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) \
1000:    || (!(m1) ? (*(r1) = 0,0) : 0) || (!(m2) ? (*(r2) = 0,0) : 0) || (!(m3) ? (*(r3) = 0,0) : 0) || (!(m4) ? (*(r4) = 0,0) : 0) || (!(m5) ? (*(r5) = 0,0) : 0) || (!(m6) ? (*(r6) = 0,0) : 0))
1001: #endif

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

1006:    Synopsis:
1007:     #include <petscsys.h>
1008:    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)

1010:    Not Collective

1012:    Input Parameter:
1013: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
1014: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
1015: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
1016: .  m4 - number of elements to allocate in 4th chunk  (may be zero)
1017: .  m5 - number of elements to allocate in 5th chunk  (may be zero)
1018: -  m6 - number of elements to allocate in 6th chunk  (may be zero)

1020:    Output Parameter:
1021: +  r1 - memory allocated in first chunk
1022: .  r2 - memory allocated in second chunk
1023: .  r3 - memory allocated in third chunk
1024: .  r4 - memory allocated in fourth chunk
1025: .  r5 - memory allocated in fifth chunk
1026: -  r6 - memory allocated in sixth chunk

1028:    Level: developer

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

1032:   Concepts: memory allocation
1033: M*/
1034: #define PetscCalloc6(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6)               \
1035:   (PetscMalloc6(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6)                    \
1036:    || PetscMemzero(*(r1),(m1)*sizeof(**(r1))) || PetscMemzero(*(r2),(m2)*sizeof(**(r2))) || PetscMemzero(*(r3),(m3)*sizeof(**(r3))) \
1037:    || PetscMemzero(*(r4),(m4)*sizeof(**(r4))) || PetscMemzero(*(r5),(m5)*sizeof(**(r5))) || PetscMemzero(*(r6),(m6)*sizeof(**(r6))))

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

1042:    Synopsis:
1043:     #include <petscsys.h>
1044:    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)

1046:    Not Collective

1048:    Input Parameter:
1049: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
1050: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
1051: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
1052: .  m4 - number of elements to allocate in 4th chunk  (may be zero)
1053: .  m5 - number of elements to allocate in 5th chunk  (may be zero)
1054: .  m6 - number of elements to allocate in 6th chunk  (may be zero)
1055: -  m7 - number of elements to allocate in 7th chunk  (may be zero)

1057:    Output Parameter:
1058: +  r1 - memory allocated in first chunk
1059: .  r2 - memory allocated in second chunk
1060: .  r3 - memory allocated in third chunk
1061: .  r4 - memory allocated in fourth chunk
1062: .  r5 - memory allocated in fifth chunk
1063: .  r6 - memory allocated in sixth chunk
1064: -  r7 - memory allocated in seventh chunk

1066:    Level: developer

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

1070:   Concepts: memory allocation

1072: M*/
1073: #if !defined(PETSC_USE_MALLOC_COALESCED)
1074: #define PetscMalloc7(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6,m7,r7) (PetscMalloc1((m1),(r1)) || PetscMalloc1((m2),(r2)) || PetscMalloc1((m3),(r3)) || PetscMalloc1((m4),(r4)) || PetscMalloc1((m5),(r5)) || PetscMalloc1((m6),(r6)) || PetscMalloc1((m7),(r7)))
1075: #else
1076: #define PetscMalloc7(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6,m7,r7) \
1077:   ((((m1)+(m2)+(m3)+(m4)+(m5)+(m6)+(m7)) ? (*(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)) : 0) \
1078:    || (*(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) \
1079:    || (!(m1) ? (*(r1) = 0,0) : 0) || (!(m2) ? (*(r2) = 0,0) : 0) || (!(m3) ? (*(r3) = 0,0) : 0) || (!(m4) ? (*(r4) = 0,0) : 0) || (!(m5) ? (*(r5) = 0,0) : 0) || (!(m6) ? (*(r6) = 0,0) : 0) || (!(m7) ? (*(r7) = 0,0) : 0))
1080: #endif

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

1085:    Synopsis:
1086:     #include <petscsys.h>
1087:    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)

1089:    Not Collective

1091:    Input Parameter:
1092: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
1093: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
1094: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
1095: .  m4 - number of elements to allocate in 4th chunk  (may be zero)
1096: .  m5 - number of elements to allocate in 5th chunk  (may be zero)
1097: .  m6 - number of elements to allocate in 6th chunk  (may be zero)
1098: -  m7 - number of elements to allocate in 7th chunk  (may be zero)

1100:    Output Parameter:
1101: +  r1 - memory allocated in first chunk
1102: .  r2 - memory allocated in second chunk
1103: .  r3 - memory allocated in third chunk
1104: .  r4 - memory allocated in fourth chunk
1105: .  r5 - memory allocated in fifth chunk
1106: .  r6 - memory allocated in sixth chunk
1107: -  r7 - memory allocated in seventh chunk

1109:    Level: developer

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

1113:   Concepts: memory allocation
1114: M*/
1115: #define PetscCalloc7(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6,m7,r7)         \
1116:   (PetscMalloc7(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6,m7,r7)              \
1117:    || PetscMemzero(*(r1),(m1)*sizeof(**(r1))) || PetscMemzero(*(r2),(m2)*sizeof(**(r2))) || PetscMemzero(*(r3),(m3)*sizeof(**(r3))) \
1118:    || PetscMemzero(*(r4),(m4)*sizeof(**(r4))) || PetscMemzero(*(r5),(m5)*sizeof(**(r5))) || PetscMemzero(*(r6),(m6)*sizeof(**(r6))) \
1119:    || PetscMemzero(*(r7),(m7)*sizeof(**(r7))))

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

1124:    Synopsis:
1125:     #include <petscsys.h>
1126:    PetscErrorCode PetscNew(type **result)

1128:    Not Collective

1130:    Output Parameter:
1131: .  result - memory allocated, sized to match pointer type

1133:    Level: beginner

1135: .seealso: PetscFree(), PetscMalloc(), PetscNewLog(), PetscCalloc1(), PetscMalloc1()

1137:   Concepts: memory allocation

1139: M*/
1140: #define PetscNew(b)      PetscCalloc1(1,(b))

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

1146:    Synopsis:
1147:     #include <petscsys.h>
1148:    PetscErrorCode PetscNewLog(PetscObject obj,type **result)

1150:    Not Collective

1152:    Input Parameter:
1153: .  obj - object memory is logged to

1155:    Output Parameter:
1156: .  result - memory allocated, sized to match pointer type

1158:    Level: developer

1160: .seealso: PetscFree(), PetscMalloc(), PetscNew(), PetscLogObjectMemory(), PetscCalloc1(), PetscMalloc1()

1162:   Concepts: memory allocation

1164: M*/
1165: #define PetscNewLog(o,b) (PetscNew((b)) || PetscLogObjectMemory((PetscObject)o,sizeof(**(b))))

1167: /*MC
1168:    PetscFree - Frees memory

1170:    Synopsis:
1171:     #include <petscsys.h>
1172:    PetscErrorCode PetscFree(void *memory)

1174:    Not Collective

1176:    Input Parameter:
1177: .   memory - memory to free (the pointer is ALWAYS set to NULL upon sucess)

1179:    Level: beginner

1181:    Notes:
1182:    Do not free memory obtained with PetscMalloc2(), PetscCalloc2() etc, they must be freed with PetscFree2() etc.

1184:    It is safe to call PetscFree() on a NULL pointer.

1186: .seealso: PetscNew(), PetscMalloc(), PetscNewLog(), PetscMalloc1(), PetscCalloc1()

1188:   Concepts: memory allocation

1190: M*/
1191: #define PetscFree(a)   ((*PetscTrFree)((void*)(a),__LINE__,PETSC_FUNCTION_NAME,__FILE__) || ((a) = 0,0))

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

1196:    Synopsis:
1197:     #include <petscsys.h>
1198:    PetscErrorCode PetscFree2(void *memory1,void *memory2)

1200:    Not Collective

1202:    Input Parameter:
1203: +   memory1 - memory to free
1204: -   memory2 - 2nd memory to free

1206:    Level: developer

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

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

1212:   Concepts: memory allocation

1214: M*/
1215: #if !defined(PETSC_USE_MALLOC_COALESCED)
1216: #define PetscFree2(m1,m2)   (PetscFree(m2) || PetscFree(m1))
1217: #else
1218: #define PetscFree2(m1,m2)   ((m1) ? ((m2)=0,PetscFree(m1)) : ((m1)=0,PetscFree(m2)))
1219: #endif

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

1224:    Synopsis:
1225:     #include <petscsys.h>
1226:    PetscErrorCode PetscFree3(void *memory1,void *memory2,void *memory3)

1228:    Not Collective

1230:    Input Parameter:
1231: +   memory1 - memory to free
1232: .   memory2 - 2nd memory to free
1233: -   memory3 - 3rd memory to free

1235:    Level: developer

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

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

1241:   Concepts: memory allocation

1243: M*/
1244: #if !defined(PETSC_USE_MALLOC_COALESCED)
1245: #define PetscFree3(m1,m2,m3)   (PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
1246: #else
1247: #define PetscFree3(m1,m2,m3)   ((m1) ? ((m3)=0,(m2)=0,PetscFree(m1)) : ((m2) ? ((m3)=0,(m1)=0,PetscFree(m2)) : ((m2)=0,(m1)=0,PetscFree(m3))))
1248: #endif

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

1253:    Synopsis:
1254:     #include <petscsys.h>
1255:    PetscErrorCode PetscFree4(void *m1,void *m2,void *m3,void *m4)

1257:    Not Collective

1259:    Input Parameter:
1260: +   m1 - memory to free
1261: .   m2 - 2nd memory to free
1262: .   m3 - 3rd memory to free
1263: -   m4 - 4th memory to free

1265:    Level: developer

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

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

1271:   Concepts: memory allocation

1273: M*/
1274: #if !defined(PETSC_USE_MALLOC_COALESCED)
1275: #define PetscFree4(m1,m2,m3,m4)   (PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
1276: #else
1277: #define PetscFree4(m1,m2,m3,m4)   ((m1) ? ((m4)=0,(m3)=0,(m2)=0,PetscFree(m1)) : ((m2) ? ((m4)=0,(m3)=0,(m1)=0,PetscFree(m2)) : ((m3) ? ((m4)=0,(m2)=0,(m1)=0,PetscFree(m3)) : ((m3)=0,(m2)=0,(m1)=0,PetscFree(m4)))))
1278: #endif

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

1283:    Synopsis:
1284:     #include <petscsys.h>
1285:    PetscErrorCode PetscFree5(void *m1,void *m2,void *m3,void *m4,void *m5)

1287:    Not Collective

1289:    Input Parameter:
1290: +   m1 - memory to free
1291: .   m2 - 2nd memory to free
1292: .   m3 - 3rd memory to free
1293: .   m4 - 4th memory to free
1294: -   m5 - 5th memory to free

1296:    Level: developer

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

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

1302:   Concepts: memory allocation

1304: M*/
1305: #if !defined(PETSC_USE_MALLOC_COALESCED)
1306: #define PetscFree5(m1,m2,m3,m4,m5)   (PetscFree(m5) || PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
1307: #else
1308: #define PetscFree5(m1,m2,m3,m4,m5)   ((m1) ? ((m5)=0,(m4)=0,(m3)=0,(m2)=0,PetscFree(m1)) : ((m2) ? ((m5)=0,(m4)=0,(m3)=0,(m1)=0,PetscFree(m2)) : ((m3) ? ((m5)=0,(m4)=0,(m2)=0,(m1)=0,PetscFree(m3)) : \
1309:                                      ((m4) ? ((m5)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m4)) : ((m4)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m5))))))
1310: #endif


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

1316:    Synopsis:
1317:     #include <petscsys.h>
1318:    PetscErrorCode PetscFree6(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6)

1320:    Not Collective

1322:    Input Parameter:
1323: +   m1 - memory to free
1324: .   m2 - 2nd memory to free
1325: .   m3 - 3rd memory to free
1326: .   m4 - 4th memory to free
1327: .   m5 - 5th memory to free
1328: -   m6 - 6th memory to free


1331:    Level: developer

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

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

1337:   Concepts: memory allocation

1339: M*/
1340: #if !defined(PETSC_USE_MALLOC_COALESCED)
1341: #define PetscFree6(m1,m2,m3,m4,m5,m6)   (PetscFree(m6) || PetscFree(m5) || PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
1342: #else
1343: #define PetscFree6(m1,m2,m3,m4,m5,m6)   ((m1) ? ((m6)=0,(m5)=0,(m4)=0,(m3)=0,(m2)=0,PetscFree(m1)) : ((m2) ? ((m6)=0,(m5)=0,(m4)=0,(m3)=0,(m1)=0,PetscFree(m2)) : \
1344:                                         ((m3) ? ((m6)=0,(m5)=0,(m4)=0,(m2)=0,(m1)=0,PetscFree(m3)) : ((m4) ? ((m6)=0,(m5)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m4)) : \
1345:                                         ((m5) ? ((m6)=0,(m4)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m5)) : ((m5)=0,(m4)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m6)))))))
1346: #endif

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

1351:    Synopsis:
1352:     #include <petscsys.h>
1353:    PetscErrorCode PetscFree7(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6,void *m7)

1355:    Not Collective

1357:    Input Parameter:
1358: +   m1 - memory to free
1359: .   m2 - 2nd memory to free
1360: .   m3 - 3rd memory to free
1361: .   m4 - 4th memory to free
1362: .   m5 - 5th memory to free
1363: .   m6 - 6th memory to free
1364: -   m7 - 7th memory to free


1367:    Level: developer

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

1371: .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6(),
1372:           PetscMalloc7()

1374:   Concepts: memory allocation

1376: M*/
1377: #if !defined(PETSC_USE_MALLOC_COALESCED)
1378: #define PetscFree7(m1,m2,m3,m4,m5,m6,m7)   (PetscFree(m7) || PetscFree(m6) || PetscFree(m5) || PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
1379: #else
1380: #define PetscFree7(m1,m2,m3,m4,m5,m6,m7)   ((m1) ? ((m7)=0,(m6)=0,(m5)=0,(m4)=0,(m3)=0,(m2)=0,PetscFree(m1)) : ((m2) ? ((m7)=0,(m6)=0,(m5)=0,(m4)=0,(m3)=0,(m1)=0,PetscFree(m2)) : \
1381:                                            ((m3) ? ((m7)=0,(m6)=0,(m5)=0,(m4)=0,(m2)=0,(m1)=0,PetscFree(m3)) : ((m4) ? ((m7)=0,(m6)=0,(m5)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m4)) : \
1382:                                            ((m5) ? ((m7)=0,(m6)=0,(m4)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m5)) : ((m6) ? ((m7)=0,(m5)=0,(m4)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m6)) : \
1383:                                                    ((m6)=0,(m5)=0,(m4)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m7))))))))
1384: #endif

1386: PETSC_EXTERN PetscErrorCode (*PetscTrMalloc)(size_t,int,const char[],const char[],void**);
1387: PETSC_EXTERN PetscErrorCode (*PetscTrFree)(void*,int,const char[],const char[]);
1388: PETSC_EXTERN PetscErrorCode (*PetscTrRealloc)(size_t,int,const char[],const char[],void**);
1389: PETSC_EXTERN PetscErrorCode PetscMallocSet(PetscErrorCode (*)(size_t,int,const char[],const char[],void**),PetscErrorCode (*)(void*,int,const char[],const char[]));
1390: PETSC_EXTERN PetscErrorCode PetscMallocClear(void);

1392: /*
1393:   Unlike PetscMallocSet and PetscMallocClear which overwrite the existing settings, these two functions save the previous choice of allocator, and should be used in pair.
1394: */
1395: PETSC_EXTERN PetscErrorCode PetscMallocSetDRAM(void);
1396: PETSC_EXTERN PetscErrorCode PetscMallocResetDRAM(void);

1398: /*
1399:     PetscLogDouble variables are used to contain double precision numbers
1400:   that are not used in the numerical computations, but rather in logging,
1401:   timing etc.
1402: */
1403: typedef double PetscLogDouble;
1404: #define MPIU_PETSCLOGDOUBLE MPI_DOUBLE

1406: /*
1407:    Routines for tracing memory corruption/bleeding with default PETSc memory allocation
1408: */
1409: PETSC_EXTERN PetscErrorCode PetscMallocDump(FILE *);
1410: PETSC_EXTERN PetscErrorCode PetscMallocDumpLog(FILE *);
1411: PETSC_EXTERN PetscErrorCode PetscMallocGetCurrentUsage(PetscLogDouble *);
1412: PETSC_EXTERN PetscErrorCode PetscMallocGetMaximumUsage(PetscLogDouble *);
1413: PETSC_EXTERN PetscErrorCode PetscMallocDebug(PetscBool);
1414: PETSC_EXTERN PetscErrorCode PetscMallocGetDebug(PetscBool*);
1415: PETSC_EXTERN PetscErrorCode PetscMallocValidate(int,const char[],const char[]);
1416: PETSC_EXTERN PetscErrorCode PetscMallocSetDumpLog(void);
1417: PETSC_EXTERN PetscErrorCode PetscMallocSetDumpLogThreshold(PetscLogDouble);
1418: PETSC_EXTERN PetscErrorCode PetscMallocGetDumpLog(PetscBool*);

1420: /*E
1421:     PetscDataType - Used for handling different basic data types.

1423:    Level: beginner

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

1427: .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscDataTypeToMPIDataType(),
1428:           PetscDataTypeGetSize()

1430: E*/
1431: typedef enum {PETSC_INT = 0,PETSC_DOUBLE = 1,PETSC_COMPLEX = 2, PETSC_LONG = 3 ,PETSC_SHORT = 4,PETSC_FLOAT = 5,
1432:               PETSC_CHAR = 6,PETSC_BIT_LOGICAL = 7,PETSC_ENUM = 8,PETSC_BOOL=9, PETSC___FLOAT128 = 10,PETSC_OBJECT = 11, PETSC_FUNCTION = 12, PETSC_STRING = 13, PETSC___FP16 = 14,PETSC_STRUCT, PETSC_DATATYPE_UNKNOWN} PetscDataType;
1433: PETSC_EXTERN const char *const PetscDataTypes[];

1435: #if defined(PETSC_USE_COMPLEX)
1436: #define  PETSC_SCALAR  PETSC_COMPLEX
1437: #else
1438: #if defined(PETSC_USE_REAL_SINGLE)
1439: #define  PETSC_SCALAR  PETSC_FLOAT
1440: #elif defined(PETSC_USE_REAL___FLOAT128)
1441: #define  PETSC_SCALAR  PETSC___FLOAT128
1442: #elif defined(PETSC_USE_REAL___FP16)
1443: #define  PETSC_SCALAR  PETSC___FP16
1444: #else
1445: #define  PETSC_SCALAR  PETSC_DOUBLE
1446: #endif
1447: #endif
1448: #if defined(PETSC_USE_REAL_SINGLE)
1449: #define  PETSC_REAL  PETSC_FLOAT
1450: #elif defined(PETSC_USE_REAL___FLOAT128)
1451: #define  PETSC_REAL  PETSC___FLOAT128
1452: #elif defined(PETSC_USE_REAL___FP16)
1453: #define  PETSC_REAL  PETSC___FP16
1454: #else
1455: #define  PETSC_REAL  PETSC_DOUBLE
1456: #endif
1457: #define  PETSC_FORTRANADDR  PETSC_LONG

1459: PETSC_EXTERN PetscErrorCode PetscDataTypeToMPIDataType(PetscDataType,MPI_Datatype*);
1460: PETSC_EXTERN PetscErrorCode PetscMPIDataTypeToPetscDataType(MPI_Datatype,PetscDataType*);
1461: PETSC_EXTERN PetscErrorCode PetscDataTypeGetSize(PetscDataType,size_t*);
1462: PETSC_EXTERN PetscErrorCode PetscDataTypeFromString(const char*,PetscDataType*,PetscBool*);

1464: /*
1465:     Basic memory and string operations. These are usually simple wrappers
1466:    around the basic Unix system calls, but a few of them have additional
1467:    functionality and/or error checking.
1468: */
1469: PETSC_EXTERN PetscErrorCode PetscBitMemcpy(void*,PetscInt,const void*,PetscInt,PetscInt,PetscDataType);
1470: PETSC_EXTERN PetscErrorCode PetscMemmove(void*,void *,size_t);
1471: PETSC_EXTERN PetscErrorCode PetscMemcmp(const void*,const void*,size_t,PetscBool  *);
1472: PETSC_EXTERN PetscErrorCode PetscStrlen(const char[],size_t*);
1473: PETSC_EXTERN PetscErrorCode PetscStrToArray(const char[],char,int*,char ***);
1474: PETSC_EXTERN PetscErrorCode PetscStrToArrayDestroy(int,char **);
1475: PETSC_EXTERN PetscErrorCode PetscStrcmp(const char[],const char[],PetscBool  *);
1476: PETSC_EXTERN PetscErrorCode PetscStrgrt(const char[],const char[],PetscBool  *);
1477: PETSC_EXTERN PetscErrorCode PetscStrcasecmp(const char[],const char[],PetscBool *);
1478: PETSC_EXTERN PetscErrorCode PetscStrncmp(const char[],const char[],size_t,PetscBool *);
1479: PETSC_EXTERN PetscErrorCode PetscStrcpy(char[],const char[]);
1480: PETSC_EXTERN PetscErrorCode PetscStrcat(char[],const char[]);
1481: PETSC_EXTERN PetscErrorCode PetscStrncat(char[],const char[],size_t);
1482: PETSC_EXTERN PetscErrorCode PetscStrncpy(char[],const char[],size_t);
1483: PETSC_EXTERN PetscErrorCode PetscStrchr(const char[],char,char *[]);
1484: PETSC_EXTERN PetscErrorCode PetscStrtolower(char[]);
1485: PETSC_EXTERN PetscErrorCode PetscStrtoupper(char[]);
1486: PETSC_EXTERN PetscErrorCode PetscStrrchr(const char[],char,char *[]);
1487: PETSC_EXTERN PetscErrorCode PetscStrstr(const char[],const char[],char *[]);
1488: PETSC_EXTERN PetscErrorCode PetscStrrstr(const char[],const char[],char *[]);
1489: PETSC_EXTERN PetscErrorCode PetscStrendswith(const char[],const char[],PetscBool*);
1490: PETSC_EXTERN PetscErrorCode PetscStrbeginswith(const char[],const char[],PetscBool*);
1491: PETSC_EXTERN PetscErrorCode PetscStrendswithwhich(const char[],const char *const*,PetscInt*);
1492: PETSC_EXTERN PetscErrorCode PetscStrallocpy(const char[],char *[]);
1493: PETSC_EXTERN PetscErrorCode PetscStrArrayallocpy(const char *const*,char***);
1494: PETSC_EXTERN PetscErrorCode PetscStrArrayDestroy(char***);
1495: PETSC_EXTERN PetscErrorCode PetscStrNArrayallocpy(PetscInt,const char *const*,char***);
1496: PETSC_EXTERN PetscErrorCode PetscStrNArrayDestroy(PetscInt,char***);
1497: PETSC_EXTERN PetscErrorCode PetscStrreplace(MPI_Comm,const char[],char[],size_t);

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

1501: /*S
1502:     PetscToken - 'Token' used for managing tokenizing strings

1504:   Level: intermediate

1506: .seealso: PetscTokenCreate(), PetscTokenFind(), PetscTokenDestroy()
1507: S*/
1508: typedef struct _p_PetscToken* PetscToken;

1510: PETSC_EXTERN PetscErrorCode PetscTokenCreate(const char[],const char,PetscToken*);
1511: PETSC_EXTERN PetscErrorCode PetscTokenFind(PetscToken,char *[]);
1512: PETSC_EXTERN PetscErrorCode PetscTokenDestroy(PetscToken*);

1514: PETSC_EXTERN PetscErrorCode PetscEListFind(PetscInt,const char *const*,const char*,PetscInt*,PetscBool*);
1515: PETSC_EXTERN PetscErrorCode PetscEnumFind(const char *const*,const char*,PetscEnum*,PetscBool*);

1517: /*
1518:    These are MPI operations for MPI_Allreduce() etc
1519: */
1520: PETSC_EXTERN MPI_Op MPIU_MAXSUM_OP;
1521: #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
1522: PETSC_EXTERN MPI_Op MPIU_SUM;
1523: #else
1524: #define MPIU_SUM MPI_SUM
1525: #endif
1526: #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
1527: PETSC_EXTERN MPI_Op MPIU_MAX;
1528: PETSC_EXTERN MPI_Op MPIU_MIN;
1529: #else
1530: #define MPIU_MAX MPI_MAX
1531: #define MPIU_MIN MPI_MIN
1532: #endif
1533: PETSC_EXTERN PetscErrorCode PetscMaxSum(MPI_Comm,const PetscInt[],PetscInt*,PetscInt*);

1535: PETSC_EXTERN PetscErrorCode MPIULong_Send(void*,PetscInt,MPI_Datatype,PetscMPIInt,PetscMPIInt,MPI_Comm);
1536: PETSC_EXTERN PetscErrorCode MPIULong_Recv(void*,PetscInt,MPI_Datatype,PetscMPIInt,PetscMPIInt,MPI_Comm);

1538: /*S
1539:      PetscObject - any PETSc object, PetscViewer, Mat, Vec, KSP etc

1541:    Level: beginner

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

1545: .seealso:  PetscObjectDestroy(), PetscObjectView(), PetscObjectGetName(), PetscObjectSetName(), PetscObjectReference(), PetscObjectDereference()
1546: S*/
1547: typedef struct _p_PetscObject* PetscObject;

1549: /*MC
1550:     PetscObjectId - unique integer Id for a PetscObject

1552:     Level: developer

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

1556: .seealso: PetscObjectState, PetscObjectGetId()
1557: M*/
1558: #if defined(PETSC_USING_F90) && !defined(PETSC_USE_FORTRANKIND) /* compaq F90 */
1559: typedef int PetscObjectId;
1560: #else
1561: typedef PetscInt64 PetscObjectId;
1562: #endif

1564: /*MC
1565:     PetscObjectState - integer state for a PetscObject

1567:     Level: developer

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

1573: .seealso: PetscObjectId, PetscObjectStateGet(), PetscObjectStateIncrease(), PetscObjectStateSet()
1574: M*/
1575: #if defined(PETSC_USING_F90) && !defined(PETSC_USE_FORTRANKIND) /* compaq F90 */
1576: typedef int PetscObjectState;
1577: #else
1578: typedef PetscInt64 PetscObjectState;
1579: #endif

1581: /*S
1582:      PetscFunctionList - Linked list of functions, possibly stored in dynamic libraries, accessed
1583:       by string name

1585:    Level: advanced

1587: .seealso:  PetscFunctionListAdd(), PetscFunctionListDestroy(), PetscOpFlist
1588: S*/
1589: typedef struct _n_PetscFunctionList *PetscFunctionList;

1591: /*E
1592:   PetscFileMode - Access mode for a file.

1594:   Level: beginner

1596: $  FILE_MODE_READ - open a file at its beginning for reading
1597: $  FILE_MODE_WRITE - open a file at its beginning for writing (will create if the file does not exist)
1598: $  FILE_MODE_APPEND - open a file at end for writing
1599: $  FILE_MODE_UPDATE - open a file for updating, meaning for reading and writing
1600: $  FILE_MODE_APPEND_UPDATE - open a file for updating, meaning for reading and writing, at the end

1602: .seealso: PetscViewerFileSetMode()
1603: E*/
1604: typedef enum {FILE_MODE_READ, FILE_MODE_WRITE, FILE_MODE_APPEND, FILE_MODE_UPDATE, FILE_MODE_APPEND_UPDATE} PetscFileMode;
1605: extern const char *const PetscFileModes[];

1607: /*
1608:     Defines PETSc error handling.
1609: */
1610:  #include <petscerror.h>

1612: #define PETSC_SMALLEST_CLASSID  1211211
1613: PETSC_EXTERN PetscClassId PETSC_LARGEST_CLASSID;
1614: PETSC_EXTERN PetscClassId PETSC_OBJECT_CLASSID;
1615: PETSC_EXTERN PetscErrorCode PetscClassIdRegister(const char[],PetscClassId *);

1617: /*
1618:    Routines that get memory usage information from the OS
1619: */
1620: PETSC_EXTERN PetscErrorCode PetscMemoryGetCurrentUsage(PetscLogDouble *);
1621: PETSC_EXTERN PetscErrorCode PetscMemoryGetMaximumUsage(PetscLogDouble *);
1622: PETSC_EXTERN PetscErrorCode PetscMemorySetGetMaximumUsage(void);
1623: PETSC_EXTERN PetscErrorCode PetscMemoryTrace(const char[]);

1625: PETSC_EXTERN PetscErrorCode PetscInfoAllow(PetscBool ,const char []);
1626: PETSC_EXTERN PetscErrorCode PetscSleep(PetscReal);

1628: /*
1629:    Initialization of PETSc
1630: */
1631: PETSC_EXTERN PetscErrorCode PetscInitialize(int*,char***,const char[],const char[]);
1632: PETSC_EXTERN PetscErrorCode PetscInitializeNoPointers(int,char**,const char[],const char[]);
1633: PETSC_EXTERN PetscErrorCode PetscInitializeNoArguments(void);
1634: PETSC_EXTERN PetscErrorCode PetscInitialized(PetscBool *);
1635: PETSC_EXTERN PetscErrorCode PetscFinalized(PetscBool *);
1636: PETSC_EXTERN PetscErrorCode PetscFinalize(void);
1637: PETSC_EXTERN PetscErrorCode PetscInitializeFortran(void);
1638: PETSC_EXTERN PetscErrorCode PetscGetArgs(int*,char ***);
1639: PETSC_EXTERN PetscErrorCode PetscGetArguments(char ***);
1640: PETSC_EXTERN PetscErrorCode PetscFreeArguments(char **);

1642: PETSC_EXTERN PetscErrorCode PetscEnd(void);
1643: PETSC_EXTERN PetscErrorCode PetscSysInitializePackage(void);

1645: PETSC_EXTERN PetscErrorCode PetscPythonInitialize(const char[],const char[]);
1646: PETSC_EXTERN PetscErrorCode PetscPythonFinalize(void);
1647: PETSC_EXTERN PetscErrorCode PetscPythonPrintError(void);
1648: PETSC_EXTERN PetscErrorCode PetscPythonMonitorSet(PetscObject,const char[]);

1650: /*
1651:      These are so that in extern C code we can caste function pointers to non-extern C
1652:    function pointers. Since the regular C++ code expects its function pointers to be C++
1653: */
1654: PETSC_EXTERN_TYPEDEF typedef void (**PetscVoidStarFunction)(void);
1655: PETSC_EXTERN_TYPEDEF typedef void (*PetscVoidFunction)(void);
1656: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*PetscErrorCodeFunction)(void);

1658: /*
1659:     Functions that can act on any PETSc object.
1660: */
1661: PETSC_EXTERN PetscErrorCode PetscObjectDestroy(PetscObject*);
1662: PETSC_EXTERN PetscErrorCode PetscObjectGetComm(PetscObject,MPI_Comm *);
1663: PETSC_EXTERN PetscErrorCode PetscObjectGetClassId(PetscObject,PetscClassId *);
1664: PETSC_EXTERN PetscErrorCode PetscObjectGetClassName(PetscObject,const char *[]);
1665: PETSC_EXTERN PetscErrorCode PetscObjectSetType(PetscObject,const char []);
1666: PETSC_EXTERN PetscErrorCode PetscObjectGetType(PetscObject,const char *[]);
1667: PETSC_EXTERN PetscErrorCode PetscObjectSetName(PetscObject,const char[]);
1668: PETSC_EXTERN PetscErrorCode PetscObjectGetName(PetscObject,const char*[]);
1669: PETSC_EXTERN PetscErrorCode PetscObjectSetTabLevel(PetscObject,PetscInt);
1670: PETSC_EXTERN PetscErrorCode PetscObjectGetTabLevel(PetscObject,PetscInt*);
1671: PETSC_EXTERN PetscErrorCode PetscObjectIncrementTabLevel(PetscObject,PetscObject,PetscInt);
1672: PETSC_EXTERN PetscErrorCode PetscObjectReference(PetscObject);
1673: PETSC_EXTERN PetscErrorCode PetscObjectGetReference(PetscObject,PetscInt*);
1674: PETSC_EXTERN PetscErrorCode PetscObjectDereference(PetscObject);
1675: PETSC_EXTERN PetscErrorCode PetscObjectGetNewTag(PetscObject,PetscMPIInt *);
1676: PETSC_EXTERN PetscErrorCode PetscObjectCompose(PetscObject,const char[],PetscObject);
1677: PETSC_EXTERN PetscErrorCode PetscObjectRemoveReference(PetscObject,const char[]);
1678: PETSC_EXTERN PetscErrorCode PetscObjectQuery(PetscObject,const char[],PetscObject *);
1679: PETSC_EXTERN PetscErrorCode PetscObjectComposeFunction_Private(PetscObject,const char[],void (*)(void));
1680: #define PetscObjectComposeFunction(a,b,d) PetscObjectComposeFunction_Private(a,b,(PetscVoidFunction)(d))
1681: PETSC_EXTERN PetscErrorCode PetscObjectSetFromOptions(PetscObject);
1682: PETSC_EXTERN PetscErrorCode PetscObjectSetUp(PetscObject);
1683: PETSC_EXTERN PetscErrorCode PetscObjectSetPrintedOptions(PetscObject);
1684: PETSC_EXTERN PetscErrorCode PetscObjectInheritPrintedOptions(PetscObject,PetscObject);
1685: PETSC_EXTERN PetscErrorCode PetscCommGetNewTag(MPI_Comm,PetscMPIInt *);

1687:  #include <petscviewertypes.h>
1688:  #include <petscoptions.h>

1690: PETSC_EXTERN PetscErrorCode PetscObjectsListGetGlobalNumbering(MPI_Comm,PetscInt,PetscObject*,PetscInt*,PetscInt*);

1692: PETSC_EXTERN PetscErrorCode PetscMemoryShowUsage(PetscViewer,const char[]);
1693: PETSC_EXTERN PetscErrorCode PetscMemoryView(PetscViewer,const char[]);
1694: PETSC_EXTERN PetscErrorCode PetscObjectPrintClassNamePrefixType(PetscObject,PetscViewer);
1695: PETSC_EXTERN PetscErrorCode PetscObjectView(PetscObject,PetscViewer);
1696: #define PetscObjectQueryFunction(obj,name,fptr) PetscObjectQueryFunction_Private((obj),(name),(PetscVoidFunction*)(fptr))
1697: PETSC_EXTERN PetscErrorCode PetscObjectQueryFunction_Private(PetscObject,const char[],void (**)(void));
1698: PETSC_EXTERN PetscErrorCode PetscObjectSetOptionsPrefix(PetscObject,const char[]);
1699: PETSC_EXTERN PetscErrorCode PetscObjectAppendOptionsPrefix(PetscObject,const char[]);
1700: PETSC_EXTERN PetscErrorCode PetscObjectPrependOptionsPrefix(PetscObject,const char[]);
1701: PETSC_EXTERN PetscErrorCode PetscObjectGetOptionsPrefix(PetscObject,const char*[]);
1702: PETSC_EXTERN PetscErrorCode PetscObjectChangeTypeName(PetscObject,const char[]);
1703: PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroy(PetscObject);
1704: PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroyAll(void);
1705: PETSC_EXTERN PetscErrorCode PetscObjectViewFromOptions(PetscObject,PetscObject,const char[]);
1706: PETSC_EXTERN PetscErrorCode PetscObjectName(PetscObject);
1707: PETSC_EXTERN PetscErrorCode PetscObjectTypeCompare(PetscObject,const char[],PetscBool *);
1708: PETSC_EXTERN PetscErrorCode PetscObjectTypeCompareAny(PetscObject,PetscBool*,const char[],...);
1709: PETSC_EXTERN PetscErrorCode PetscRegisterFinalize(PetscErrorCode (*)(void));
1710: PETSC_EXTERN PetscErrorCode PetscRegisterFinalizeAll(void);

1712: #if defined(PETSC_HAVE_SAWS)
1713: PETSC_EXTERN PetscErrorCode PetscSAWsBlock(void);
1714: PETSC_EXTERN PetscErrorCode PetscObjectSAWsViewOff(PetscObject);
1715: PETSC_EXTERN PetscErrorCode PetscObjectSAWsSetBlock(PetscObject,PetscBool);
1716: PETSC_EXTERN PetscErrorCode PetscObjectSAWsBlock(PetscObject);
1717: PETSC_EXTERN PetscErrorCode PetscObjectSAWsGrantAccess(PetscObject);
1718: PETSC_EXTERN PetscErrorCode PetscObjectSAWsTakeAccess(PetscObject);
1719: PETSC_EXTERN void           PetscStackSAWsGrantAccess(void);
1720: PETSC_EXTERN void           PetscStackSAWsTakeAccess(void);
1721: PETSC_EXTERN PetscErrorCode PetscStackViewSAWs(void);
1722: PETSC_EXTERN PetscErrorCode PetscStackSAWsViewOff(void);

1724: #else
1725: #define PetscSAWsBlock()                        0
1726: #define PetscObjectSAWsViewOff(obj)             0
1727: #define PetscObjectSAWsSetBlock(obj,flg)        0
1728: #define PetscObjectSAWsBlock(obj)               0
1729: #define PetscObjectSAWsGrantAccess(obj)         0
1730: #define PetscObjectSAWsTakeAccess(obj)          0
1731: #define PetscStackViewSAWs()                    0
1732: #define PetscStackSAWsViewOff()                 0
1733: #define PetscStackSAWsTakeAccess()
1734: #define PetscStackSAWsGrantAccess()

1736: #endif

1738: typedef void* PetscDLHandle;
1739: typedef enum {PETSC_DL_DECIDE=0,PETSC_DL_NOW=1,PETSC_DL_LOCAL=2} PetscDLMode;
1740: PETSC_EXTERN PetscErrorCode PetscDLOpen(const char[],PetscDLMode,PetscDLHandle *);
1741: PETSC_EXTERN PetscErrorCode PetscDLClose(PetscDLHandle *);
1742: PETSC_EXTERN PetscErrorCode PetscDLSym(PetscDLHandle,const char[],void **);

1744: #if defined(PETSC_USE_DEBUG)
1745: PETSC_EXTERN PetscErrorCode PetscMallocGetStack(void*,PetscStack**);
1746: #endif
1747: PETSC_EXTERN PetscErrorCode PetscObjectsDump(FILE*,PetscBool);

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

1752:    Level: developer

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

1756: .seealso:  PetscObjectListAdd(), PetscObjectListDestroy(), PetscObjectListFind(), PetscObjectCompose(), PetscObjectQuery(), PetscFunctionList
1757: S*/
1758: typedef struct _n_PetscObjectList *PetscObjectList;

1760: PETSC_EXTERN PetscErrorCode PetscObjectListDestroy(PetscObjectList*);
1761: PETSC_EXTERN PetscErrorCode PetscObjectListFind(PetscObjectList,const char[],PetscObject*);
1762: PETSC_EXTERN PetscErrorCode PetscObjectListReverseFind(PetscObjectList,PetscObject,char**,PetscBool*);
1763: PETSC_EXTERN PetscErrorCode PetscObjectListAdd(PetscObjectList *,const char[],PetscObject);
1764: PETSC_EXTERN PetscErrorCode PetscObjectListRemoveReference(PetscObjectList *,const char[]);
1765: PETSC_EXTERN PetscErrorCode PetscObjectListDuplicate(PetscObjectList,PetscObjectList *);

1767: /*
1768:     Dynamic library lists. Lists of names of routines in objects or in dynamic
1769:   link libraries that will be loaded as needed.
1770: */

1772: #define PetscFunctionListAdd(list,name,fptr) PetscFunctionListAdd_Private((list),(name),(PetscVoidFunction)(fptr))
1773: PETSC_EXTERN PetscErrorCode PetscFunctionListAdd_Private(PetscFunctionList*,const char[],void (*)(void));
1774: PETSC_EXTERN PetscErrorCode PetscFunctionListDestroy(PetscFunctionList*);
1775: #define PetscFunctionListFind(list,name,fptr) PetscFunctionListFind_Private((list),(name),(PetscVoidFunction*)(fptr))
1776: PETSC_EXTERN PetscErrorCode PetscFunctionListFind_Private(PetscFunctionList,const char[],void (**)(void));
1777: PETSC_EXTERN PetscErrorCode PetscFunctionListPrintTypes(MPI_Comm,FILE*,const char[],const char[],const char[],const char[],PetscFunctionList,const char[]);
1778: PETSC_EXTERN PetscErrorCode PetscFunctionListDuplicate(PetscFunctionList,PetscFunctionList *);
1779: PETSC_EXTERN PetscErrorCode PetscFunctionListView(PetscFunctionList,PetscViewer);
1780: PETSC_EXTERN PetscErrorCode PetscFunctionListGet(PetscFunctionList,const char ***,int*);

1782: /*S
1783:      PetscDLLibrary - Linked list of dynamics libraries to search for functions

1785:    Level: advanced

1787: .seealso:  PetscDLLibraryOpen()
1788: S*/
1789: typedef struct _n_PetscDLLibrary *PetscDLLibrary;
1790: PETSC_EXTERN PetscDLLibrary  PetscDLLibrariesLoaded;
1791: PETSC_EXTERN PetscErrorCode PetscDLLibraryAppend(MPI_Comm,PetscDLLibrary *,const char[]);
1792: PETSC_EXTERN PetscErrorCode PetscDLLibraryPrepend(MPI_Comm,PetscDLLibrary *,const char[]);
1793: PETSC_EXTERN PetscErrorCode PetscDLLibrarySym(MPI_Comm,PetscDLLibrary *,const char[],const char[],void **);
1794: PETSC_EXTERN PetscErrorCode PetscDLLibraryPrintPath(PetscDLLibrary);
1795: PETSC_EXTERN PetscErrorCode PetscDLLibraryRetrieve(MPI_Comm,const char[],char *,size_t,PetscBool  *);
1796: PETSC_EXTERN PetscErrorCode PetscDLLibraryOpen(MPI_Comm,const char[],PetscDLLibrary *);
1797: PETSC_EXTERN PetscErrorCode PetscDLLibraryClose(PetscDLLibrary);

1799: /*
1800:      Useful utility routines
1801: */
1802: PETSC_EXTERN PetscErrorCode PetscSplitOwnership(MPI_Comm,PetscInt*,PetscInt*);
1803: PETSC_EXTERN PetscErrorCode PetscSplitOwnershipBlock(MPI_Comm,PetscInt,PetscInt*,PetscInt*);
1804: PETSC_EXTERN PetscErrorCode PetscSequentialPhaseBegin(MPI_Comm,PetscMPIInt);
1805: PETSC_EXTERN PetscErrorCode PetscSequentialPhaseEnd(MPI_Comm,PetscMPIInt);
1806: PETSC_EXTERN PetscErrorCode PetscBarrier(PetscObject);
1807: PETSC_EXTERN PetscErrorCode PetscMPIDump(FILE*);

1809: /*
1810:     PetscNot - negates a logical type value and returns result as a PetscBool

1812:     Notes: This is useful in cases like
1813: $     int        *a;
1814: $     PetscBool  flag = PetscNot(a)
1815:      where !a would not return a PetscBool because we cannot provide a cast from int to PetscBool in C.
1816: */
1817: #define PetscNot(a) ((a) ? PETSC_FALSE : PETSC_TRUE)

1819: /*MC
1820:     PetscHelpPrintf - Prints help messages.

1822:    Synopsis:
1823:     #include <petscsys.h>
1824:      PetscErrorCode (*PetscHelpPrintf)(const char format[],...);

1826:     Not Collective

1828:     Input Parameters:
1829: .   format - the usual printf() format string

1831:    Level: developer

1833:     Fortran Note:
1834:     This routine is not supported in Fortran.

1836:     Concepts: help messages^printing
1837:     Concepts: printing^help messages

1839: .seealso: PetscFPrintf(), PetscSynchronizedPrintf(), PetscErrorPrintf()
1840: M*/
1841: PETSC_EXTERN PetscErrorCode (*PetscHelpPrintf)(MPI_Comm,const char[],...);

1843: /*
1844:      Defines PETSc profiling.
1845: */
1846:  #include <petsclog.h>

1848: /*
1849:       Simple PETSc parallel IO for ASCII printing
1850: */
1851: PETSC_EXTERN PetscErrorCode PetscFixFilename(const char[],char[]);
1852: PETSC_EXTERN PetscErrorCode PetscFOpen(MPI_Comm,const char[],const char[],FILE**);
1853: PETSC_EXTERN PetscErrorCode PetscFClose(MPI_Comm,FILE*);
1854: PETSC_EXTERN PetscErrorCode PetscFPrintf(MPI_Comm,FILE*,const char[],...);
1855: PETSC_EXTERN PetscErrorCode PetscPrintf(MPI_Comm,const char[],...);
1856: PETSC_EXTERN PetscErrorCode PetscSNPrintf(char*,size_t,const char [],...);
1857: PETSC_EXTERN PetscErrorCode PetscSNPrintfCount(char*,size_t,const char [],size_t*,...);

1859: PETSC_EXTERN PetscErrorCode PetscErrorPrintfDefault(const char [],...);
1860: PETSC_EXTERN PetscErrorCode PetscErrorPrintfNone(const char [],...);
1861: PETSC_EXTERN PetscErrorCode PetscHelpPrintfDefault(MPI_Comm,const char [],...);

1863: #if defined(PETSC_HAVE_POPEN)
1864: PETSC_EXTERN PetscErrorCode PetscPOpen(MPI_Comm,const char[],const char[],const char[],FILE **);
1865: PETSC_EXTERN PetscErrorCode PetscPClose(MPI_Comm,FILE*,int*);
1866: PETSC_EXTERN PetscErrorCode PetscPOpenSetMachine(const char[]);
1867: #endif

1869: PETSC_EXTERN PetscErrorCode PetscSynchronizedPrintf(MPI_Comm,const char[],...);
1870: PETSC_EXTERN PetscErrorCode PetscSynchronizedFPrintf(MPI_Comm,FILE*,const char[],...);
1871: PETSC_EXTERN PetscErrorCode PetscSynchronizedFlush(MPI_Comm,FILE*);
1872: PETSC_EXTERN PetscErrorCode PetscSynchronizedFGets(MPI_Comm,FILE*,size_t,char[]);
1873: PETSC_EXTERN PetscErrorCode PetscStartMatlab(MPI_Comm,const char[],const char[],FILE**);
1874: PETSC_EXTERN PetscErrorCode PetscStartJava(MPI_Comm,const char[],const char[],FILE**);
1875: PETSC_EXTERN PetscErrorCode PetscGetPetscDir(const char*[]);

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

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

1882:    Level: advanced

1884: .seealso:  PetscObject, PetscContainerCreate()
1885: S*/
1886: PETSC_EXTERN PetscClassId PETSC_CONTAINER_CLASSID;
1887: typedef struct _p_PetscContainer*  PetscContainer;
1888: PETSC_EXTERN PetscErrorCode PetscContainerGetPointer(PetscContainer,void **);
1889: PETSC_EXTERN PetscErrorCode PetscContainerSetPointer(PetscContainer,void *);
1890: PETSC_EXTERN PetscErrorCode PetscContainerDestroy(PetscContainer*);
1891: PETSC_EXTERN PetscErrorCode PetscContainerCreate(MPI_Comm,PetscContainer *);
1892: PETSC_EXTERN PetscErrorCode PetscContainerSetUserDestroy(PetscContainer, PetscErrorCode (*)(void*));

1894: /*
1895:    For use in debuggers
1896: */
1897: PETSC_EXTERN PetscMPIInt PetscGlobalRank;
1898: PETSC_EXTERN PetscMPIInt PetscGlobalSize;
1899: PETSC_EXTERN PetscErrorCode PetscIntView(PetscInt,const PetscInt[],PetscViewer);
1900: PETSC_EXTERN PetscErrorCode PetscRealView(PetscInt,const PetscReal[],PetscViewer);
1901: PETSC_EXTERN PetscErrorCode PetscScalarView(PetscInt,const PetscScalar[],PetscViewer);

1903: #include <stddef.h>
1904: #include <string.h>             /* for memcpy, memset */
1905: #if defined(PETSC_HAVE_STDLIB_H)
1906: #include <stdlib.h>
1907: #endif

1909: #if defined(PETSC_HAVE_XMMINTRIN_H) && !defined(__CUDACC__)
1910: #include <xmmintrin.h>
1911: #endif

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

1918:    Not Collective

1920:    Input Parameters:
1921: +  b - pointer to initial memory space
1922: -  n - length (in bytes) of space to copy

1924:    Output Parameter:
1925: .  a - pointer to copy space

1927:    Level: intermediate

1929:    Compile Option:
1930:     PETSC_PREFER_DCOPY_FOR_MEMCPY will cause the BLAS dcopy() routine to be used
1931:                                   for memory copies on double precision values.
1932:     PETSC_PREFER_COPY_FOR_MEMCPY will cause C code to be used
1933:                                   for memory copies on double precision values.
1934:     PETSC_PREFER_FORTRAN_FORMEMCPY will cause Fortran code to be used
1935:                                   for memory copies on double precision values.

1937:    Note:
1938:    This routine is analogous to memcpy().

1940:    Developer Note: this is inlined for fastest performance

1942:   Concepts: memory^copying
1943:   Concepts: copying^memory

1945: .seealso: PetscMemmove()

1947: @*/
1948: PETSC_STATIC_INLINE PetscErrorCode PetscMemcpy(void *a,const void *b,size_t n)
1949: {
1950: #if defined(PETSC_USE_DEBUG)
1951:   size_t al = (size_t) a,bl = (size_t) b;
1952:   size_t nl = (size_t) n;
1954:   if (n > 0 && !b) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy from a null pointer");
1955:   if (n > 0 && !a) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy to a null pointer");
1956: #else
1958: #endif
1959:   if (a != b && n > 0) {
1960: #if defined(PETSC_USE_DEBUG)
1961:     if ((al > bl && (al - bl) < nl) || (bl - al) < nl)  SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_ARG_INCOMP,"Memory regions overlap: either use PetscMemmov()\n\
1962:               or make sure your copy regions and lengths are correct. \n\
1963:               Length (bytes) %ld first address %ld second address %ld",nl,al,bl);
1964: #endif
1965: #if (defined(PETSC_PREFER_DCOPY_FOR_MEMCPY) || defined(PETSC_PREFER_COPY_FOR_MEMCPY) || defined(PETSC_PREFER_FORTRAN_FORMEMCPY))
1966:    if (!(a % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) {
1967:       size_t len = n/sizeof(PetscScalar);
1968: #if defined(PETSC_PREFER_DCOPY_FOR_MEMCPY)
1969:       PetscBLASInt   one = 1,blen;
1971:       PetscBLASIntCast(len,&blen);
1972:       PetscStackCallBLAS("BLAScopy",BLAScopy_(&blen,(PetscScalar *)b,&one,(PetscScalar *)a,&one));
1973: #elif defined(PETSC_PREFER_FORTRAN_FORMEMCPY)
1974:       fortrancopy_(&len,(PetscScalar*)b,(PetscScalar*)a);
1975: #else
1976:       size_t      i;
1977:       PetscScalar *x = (PetscScalar*)b, *y = (PetscScalar*)a;
1978:       for (i=0; i<len; i++) y[i] = x[i];
1979: #endif
1980:     } else {
1981:       memcpy((char*)(a),(char*)(b),n);
1982:     }
1983: #else
1984:     memcpy((char*)(a),(char*)(b),n);
1985: #endif
1986:   }
1987:   return(0);
1988: }

1990: /*@C
1991:    PetscMemzero - Zeros the specified memory.

1993:    Not Collective

1995:    Input Parameters:
1996: +  a - pointer to beginning memory location
1997: -  n - length (in bytes) of memory to initialize

1999:    Level: intermediate

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

2005:    Developer Note: this is inlined for fastest performance

2007:    Concepts: memory^zeroing
2008:    Concepts: zeroing^memory

2010: .seealso: PetscMemcpy()
2011: @*/
2012: PETSC_STATIC_INLINE PetscErrorCode  PetscMemzero(void *a,size_t n)
2013: {
2014:   if (n > 0) {
2015: #if defined(PETSC_USE_DEBUG)
2016:     if (!a) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to zero at a null pointer");
2017: #endif
2018: #if defined(PETSC_PREFER_ZERO_FOR_MEMZERO)
2019:     if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) {
2020:       size_t      i,len = n/sizeof(PetscScalar);
2021:       PetscScalar *x = (PetscScalar*)a;
2022:       for (i=0; i<len; i++) x[i] = 0.0;
2023:     } else {
2024: #elif defined(PETSC_PREFER_FORTRAN_FOR_MEMZERO)
2025:     if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) {
2026:       PetscInt len = n/sizeof(PetscScalar);
2027:       fortranzero_(&len,(PetscScalar*)a);
2028:     } else {
2029: #endif
2030: #if defined(PETSC_PREFER_BZERO)
2031:       bzero((char *)a,n);
2032: #else
2033:       memset((char*)a,0,n);
2034: #endif
2035: #if defined(PETSC_PREFER_ZERO_FOR_MEMZERO) || defined(PETSC_PREFER_FORTRAN_FOR_MEMZERO)
2036:     }
2037: #endif
2038:   }
2039:   return 0;
2040: }

2042: /*MC
2043:    PetscPrefetchBlock - Prefetches a block of memory

2045:    Synopsis:
2046:     #include <petscsys.h>
2047:     void PetscPrefetchBlock(const anytype *a,size_t n,int rw,int t)

2049:    Not Collective

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

2057:    Level: developer

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

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

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

2072:    Concepts: memory
2073: M*/
2074: #define PetscPrefetchBlock(a,n,rw,t) do {                               \
2075:     const char *_p = (const char*)(a),*_end = (const char*)((a)+(n));   \
2076:     for ( ; _p < _end; _p += PETSC_LEVEL1_DCACHE_LINESIZE) PETSC_Prefetch(_p,(rw),(t)); \
2077:   } while (0)

2079: /*
2080:       Determine if some of the kernel computation routines use
2081:    Fortran (rather than C) for the numerical calculations. On some machines
2082:    and compilers (like complex numbers) the Fortran version of the routines
2083:    is faster than the C/C++ versions. The flag --with-fortran-kernels
2084:    should be used with ./configure to turn these on.
2085: */
2086: #if defined(PETSC_USE_FORTRAN_KERNELS)

2088: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTCRL)
2089: #define PETSC_USE_FORTRAN_KERNEL_MULTCRL
2090: #endif

2092: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJPERM)
2093: #define PETSC_USE_FORTRAN_KERNEL_MULTAIJPERM
2094: #endif

2096: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJ)
2097: #define PETSC_USE_FORTRAN_KERNEL_MULTAIJ
2098: #endif

2100: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ)
2101: #define PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ
2102: #endif

2104: #if !defined(PETSC_USE_FORTRAN_KERNEL_NORM)
2105: #define PETSC_USE_FORTRAN_KERNEL_NORM
2106: #endif

2108: #if !defined(PETSC_USE_FORTRAN_KERNEL_MAXPY)
2109: #define PETSC_USE_FORTRAN_KERNEL_MAXPY
2110: #endif

2112: #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ)
2113: #define PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ
2114: #endif

2116: #if !defined(PETSC_USE_FORTRAN_KERNEL_RELAXAIJ)
2117: #define PETSC_USE_FORTRAN_KERNEL_RELAXAIJ
2118: #endif

2120: #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ)
2121: #define PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ
2122: #endif

2124: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ)
2125: #define PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ
2126: #endif

2128: #if !defined(PETSC_USE_FORTRAN_KERNEL_MDOT)
2129: #define PETSC_USE_FORTRAN_KERNEL_MDOT
2130: #endif

2132: #if !defined(PETSC_USE_FORTRAN_KERNEL_XTIMESY)
2133: #define PETSC_USE_FORTRAN_KERNEL_XTIMESY
2134: #endif

2136: #if !defined(PETSC_USE_FORTRAN_KERNEL_AYPX)
2137: #define PETSC_USE_FORTRAN_KERNEL_AYPX
2138: #endif

2140: #if !defined(PETSC_USE_FORTRAN_KERNEL_WAXPY)
2141: #define PETSC_USE_FORTRAN_KERNEL_WAXPY
2142: #endif

2144: #endif

2146: /*
2147:     Macros for indicating code that should be compiled with a C interface,
2148:    rather than a C++ interface. Any routines that are dynamically loaded
2149:    (such as the PCCreate_XXX() routines) must be wrapped so that the name
2150:    mangler does not change the functions symbol name. This just hides the
2151:    ugly extern "C" {} wrappers.
2152: */
2153: #if defined(__cplusplus)
2154: #define EXTERN_C_BEGIN extern "C" {
2155: #define EXTERN_C_END }
2156: #else
2157: #define EXTERN_C_BEGIN
2158: #define EXTERN_C_END
2159: #endif

2161: /* --------------------------------------------------------------------*/

2163: /*MC
2164:     MPI_Comm - the basic object used by MPI to determine which processes are involved in a
2165:         communication

2167:    Level: beginner

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

2171: .seealso: PETSC_COMM_WORLD, PETSC_COMM_SELF
2172: M*/

2174: /*MC
2175:     PetscScalar - PETSc type that represents either a double precision real number, a double precision
2176:        complex number, a single precision real number, a __float128 real or complex or a __fp16 real - if the code is configured
2177:        with --with-scalar-type=real,complex --with-precision=single,double,__float128,__fp16

2179:    Notes: For MPI calls that require datatypes, use MPIU_SCALAR as the datatype for PetscScalar and MPIU_SUM, MPIU_MAX etc for operations.
2180:           They will automatically work correctly regardless of the size of PetscScalar

2182:    Level: beginner

2184: .seealso: PetscReal, MPIU_SCALAR, PetscInt, MPIU_REAL, PetscComplex, MPIU_INT
2185: M*/

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

2190:    Synopsis:
2191:    #include <petscsys.h>
2192:    PetscComplex number = 1. + 2.*PETSC_i;

2194:    Level: beginner

2196:    Notes: For MPI calls that require datatypes, use MPIU_COMPLEX as the datatype for PetscComplex and MPIU_SUM etc for operations.
2197:           They will automatically work correctly regardless of the size of PetscComplex

2199:           See PetscScalar for details on how to ./configure the size of PetscReal

2201:           Complex numbers are automatically available if PETSc was able to find a working complex implementation

2203: .seealso: PetscReal, PetscComplex, MPIU_COMPLEX, PetscInt, PETSC_i
2204: M*/

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

2209:    Level: beginner

2211:    Notes: For MPI calls that require datatypes, use MPIU_REAL as the datatype for PetscScalar and MPIU_SUM, MPIU_MAX etc for operations.
2212:           They will automatically work correctly regardless of the size of PetscReal

2214:           See PetscScalar for details on how to ./configure the size of PetscReal

2216: .seealso: PetscScalar, PetscComplex, MPIU_REAL, MPIU_SCALAR
2217: M*/

2219: /*MC
2220:     MPIU_SCALAR - MPI datatype corresponding to PetscScalar

2222:    Level: beginner

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

2227: .seealso: PetscReal, PetscScalar, MPIU_INT, MPIU_REAL, MPIU_COMPLEX
2228: M*/

2230: #if defined(PETSC_HAVE_MPIIO)
2231: #if !defined(PETSC_WORDS_BIGENDIAN)
2232: PETSC_EXTERN PetscErrorCode MPIU_File_write_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*);
2233: PETSC_EXTERN PetscErrorCode MPIU_File_read_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*);
2234: #else
2235: #define MPIU_File_write_all(a,b,c,d,e) MPI_File_write_all(a,b,c,d,e)
2236: #define MPIU_File_read_all(a,b,c,d,e) MPI_File_read_all(a,b,c,d,e)
2237: #endif
2238: #endif

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

2242: /* Limit MPI to 32-bits */
2243: #define PETSC_MPI_INT_MAX  2147483647
2244: #define PETSC_MPI_INT_MIN -2147483647
2245: /* Limit BLAS to 32-bits */
2246: #define PETSC_BLAS_INT_MAX  2147483647
2247: #define PETSC_BLAS_INT_MIN -2147483647

2249: /*@C
2250:     PetscBLASIntCast - casts a PetscInt (which may be 64 bits in size) to a PetscBLASInt (which may be 32 bits in size), generates an
2251:          error if the PetscBLASInt is not large enough to hold the number.

2253:    Not Collective

2255:    Input Parameter:
2256: .     a - the PetscInt value

2258:    Output Parameter:
2259: .     b - the resulting PetscBLASInt value

2261:    Level: advanced

2263: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscMPIIntCast()
2264: @*/
2265: PETSC_STATIC_INLINE PetscErrorCode PetscBLASIntCast(PetscInt a,PetscBLASInt *b)
2266: {
2268:   *b =  (PetscBLASInt)(a);
2269: #if defined(PETSC_USE_64BIT_INDICES) && !defined(PETSC_HAVE_64BIT_BLAS_INDICES)
2270:   if ((a) > PETSC_BLAS_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array too long for BLAS/LAPACK");
2271: #endif
2272:   return(0);
2273: }

2275: /*@C
2276:     PetscMPIIntCast - casts a PetscInt (which may be 64 bits in size) to a PetscMPIInt (which may be 32 bits in size), generates an
2277:          error if the PetscMPIInt is not large enough to hold the number.

2279:    Not Collective

2281:    Input Parameter:
2282: .     a - the PetscInt value

2284:    Output Parameter:
2285: .     b - the resulting PetscMPIInt value

2287:    Level: advanced

2289: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast()
2290: @*/
2291: PETSC_STATIC_INLINE PetscErrorCode PetscMPIIntCast(PetscInt a,PetscMPIInt *b)
2292: {
2294:   *b =  (PetscMPIInt)(a);
2295: #if defined(PETSC_USE_64BIT_INDICES)
2296:   if ((a) > PETSC_MPI_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array too long for MPI");
2297: #endif
2298:   return(0);
2299: }

2301: #define PetscInt64Mult(a,b)   ((PetscInt64)(a))*((PetscInt64)(b))

2303: /*@C

2305:    PetscRealIntMultTruncate - Computes the product of a positive PetscReal and a positive PetscInt and truncates the value to slightly less than the maximal possible value

2307:    Not Collective

2309:    Input Parameter:
2310: +     a - the PetscReal value
2311: -     b - the second value

2313:    Returns:
2314:       the result as a PetscInt value

2316:    Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64
2317:    Use PetscIntMultTruncate() to compute the product of two positive PetscInt and truncate to fit a PetscInt
2318:    Use PetscIntMultError() to compute the product of two PetscInt if you wish to generate an error if the result will not fit in a PetscInt

2320:    Developers Note: We currently assume that PetscInt addition can never overflow, this is obviously wrong but requires many more checks.

2322:    This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able.

2324:    Level: advanced

2326: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult()
2327: @*/
2328: PETSC_STATIC_INLINE PetscInt PetscRealIntMultTruncate(PetscReal a,PetscInt b)
2329: {
2330:   PetscInt64 r;

2332:   r  =  (PetscInt64) (a*(PetscReal)b);
2333:   if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100;
2334:   return (PetscInt) r;
2335: }

2337: /*@C

2339:    PetscIntMultTruncate - Computes the product of two positive PetscInt and truncates the value to slightly less than the maximal possible value

2341:    Not Collective

2343:    Input Parameter:
2344: +     a - the PetscInt value
2345: -     b - the second value

2347:    Returns:
2348:       the result as a PetscInt value

2350:    Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64
2351:    Use PetscRealIntMultTruncate() to compute the product of a PetscReal and a PetscInt and truncate to fit a PetscInt
2352:    Use PetscIntMultError() to compute the product of two PetscInt if you wish to generate an error if the result will not fit in a PetscInt

2354:    Developers Note: We currently assume that PetscInt addition can never overflow, this is obviously wrong but requires many more checks.

2356:    This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able.

2358:    Level: advanced

2360: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult()
2361: @*/
2362: PETSC_STATIC_INLINE PetscInt PetscIntMultTruncate(PetscInt a,PetscInt b)
2363: {
2364:   PetscInt64 r;

2366:   r  =  PetscInt64Mult(a,b);
2367:   if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100;
2368:   return (PetscInt) r;
2369: }

2371: /*@C

2373:    PetscIntSumTruncate - Computes the sum of two positive PetscInt and truncates the value to slightly less than the maximal possible value

2375:    Not Collective

2377:    Input Parameter:
2378: +     a - the PetscInt value
2379: -     b - the second value

2381:    Returns:
2382:      the result as a PetscInt value

2384:    Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64
2385:    Use PetscRealIntMultTruncate() to compute the product of a PetscReal and a PetscInt and truncate to fit a PetscInt
2386:    Use PetscIntMultError() to compute the product of two PetscInt if you wish to generate an error if the result will not fit in a PetscInt

2388:    This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able.

2390:    Level: advanced

2392: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult()
2393: @*/
2394: PETSC_STATIC_INLINE PetscInt PetscIntSumTruncate(PetscInt a,PetscInt b)
2395: {
2396:   PetscInt64 r;

2398:   r  =  ((PetscInt64)a) + ((PetscInt64)b);
2399:   if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100;
2400:   return (PetscInt) r;
2401: }

2403: /*@C

2405:    PetscIntMultError - Computes the product of two positive PetscInt and generates an error with overflow.

2407:    Not Collective

2409:    Input Parameter:
2410: +     a - the PetscInt value
2411: -     b - the second value

2413:    Output Parameter:ma
2414: .     result - the result as a PetscInt value, or NULL if you do not want the result, you just want to check if it overflows

2416:    Use PetscInt64Mult() to compute the product of two 32 bit PetscInt and store in a PetscInt64
2417:    Use PetscIntMultTruncate() to compute the product of two PetscInt and truncate it to fit in a PetscInt

2419:    Developers Note: We currently assume that PetscInt addition does not overflow, this is obviously wrong but requires many more checks.

2421:    Level: advanced

2423: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscIntMult64(), PetscIntSumError()
2424: @*/
2425: PETSC_STATIC_INLINE PetscErrorCode PetscIntMultError(PetscInt a,PetscInt b,PetscInt *result)
2426: {
2427:   PetscInt64 r;

2430:   r  =  PetscInt64Mult(a,b);
2431: #if !defined(PETSC_USE_64BIT_INDICES)
2432:   if (r > PETSC_MAX_INT) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_SUP,"Product of two integer %d %d overflow, you must ./configure PETSc with --with-64-bit-indices for the case you are running",a,b);
2433: #endif
2434:   if (result) *result = (PetscInt) r;
2435:   return(0);
2436: }

2438: /*@C

2440:    PetscIntSumError - Computes the sum of two positive PetscInt and generates an error with overflow.

2442:    Not Collective

2444:    Input Parameter:
2445: +     a - the PetscInt value
2446: -     b - the second value

2448:    Output Parameter:ma
2449: .     c - the result as a PetscInt value,  or NULL if you do not want the result, you just want to check if it overflows

2451:    Use PetscInt64Mult() to compute the product of two 32 bit PetscInt and store in a PetscInt64
2452:    Use PetscIntMultTruncate() to compute the product of two PetscInt and truncate it to fit in a PetscInt

2454:    Level: advanced

2456: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult()
2457: @*/
2458: PETSC_STATIC_INLINE PetscErrorCode PetscIntSumError(PetscInt a,PetscInt b,PetscInt *result)
2459: {
2460:   PetscInt64 r;

2463:   r  =  ((PetscInt64)a) + ((PetscInt64)b);
2464: #if !defined(PETSC_USE_64BIT_INDICES)
2465:   if (r > PETSC_MAX_INT) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_SUP,"Sum of two integer %d %d overflow, you must ./configure PETSc with --with-64-bit-indices for the case you are running",a,b);
2466: #endif
2467:   if (result) *result = (PetscInt) r;
2468:   return(0);
2469: }
2470: 
2471: /*
2472:      The IBM include files define hz, here we hide it so that it may be used as a regular user variable.
2473: */
2474: #if defined(hz)
2475: #undef hz
2476: #endif

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


2481: #if defined(PETSC_HAVE_LIMITS_H)
2482: #include <limits.h>
2483: #endif
2484: #if defined(PETSC_HAVE_SYS_PARAM_H)
2485: #include <sys/param.h>
2486: #endif
2487: #if defined(PETSC_HAVE_SYS_TYPES_H)
2488: #include <sys/types.h>
2489: #endif
2490: #if defined(MAXPATHLEN)
2491: #  define PETSC_MAX_PATH_LEN     MAXPATHLEN
2492: #elif defined(MAX_PATH)
2493: #  define PETSC_MAX_PATH_LEN     MAX_PATH
2494: #elif defined(_MAX_PATH)
2495: #  define PETSC_MAX_PATH_LEN     _MAX_PATH
2496: #else
2497: #  define PETSC_MAX_PATH_LEN     4096
2498: #endif

2500: /*MC

2502:     UsingFortran - To use PETSc with Fortran you must use both PETSc include files and modules. At the beginning
2503:       of every function and module definition you need something like

2505: $
2506: $#include "petsc/finclude/petscXXX.h"
2507: $         use petscXXXX

2509:      You can delcare PETSc variables using either 

2511: $    XXX variablename
2512: $    type(tXXX) variablename

2514:     for example

2516: $#include "petsc/finclude/petscvec.h"
2517: $         use petscvec
2518: $
2519: $    Vec  A
2520: $    type(tVec) A

2522:     Level: beginner

2524: M*/

2526: PETSC_EXTERN PetscErrorCode PetscGetArchType(char[],size_t);
2527: PETSC_EXTERN PetscErrorCode PetscGetHostName(char[],size_t);
2528: PETSC_EXTERN PetscErrorCode PetscGetUserName(char[],size_t);
2529: PETSC_EXTERN PetscErrorCode PetscGetProgramName(char[],size_t);
2530: PETSC_EXTERN PetscErrorCode PetscSetProgramName(const char[]);
2531: PETSC_EXTERN PetscErrorCode PetscGetDate(char[],size_t);
2532: PETSC_EXTERN PetscErrorCode PetscGetVersion(char[], size_t);
2533: PETSC_EXTERN PetscErrorCode PetscGetVersionNumber(PetscInt*,PetscInt*,PetscInt*,PetscInt*);

2535: PETSC_EXTERN PetscErrorCode PetscSortInt(PetscInt,PetscInt[]);
2536: PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsInt(PetscInt*,PetscInt[]);
2537: PETSC_EXTERN PetscErrorCode PetscFindInt(PetscInt, PetscInt, const PetscInt[], PetscInt*);
2538: PETSC_EXTERN PetscErrorCode PetscSortIntWithPermutation(PetscInt,const PetscInt[],PetscInt[]);
2539: PETSC_EXTERN PetscErrorCode PetscSortStrWithPermutation(PetscInt,const char*[],PetscInt[]);
2540: PETSC_EXTERN PetscErrorCode PetscSortIntWithArray(PetscInt,PetscInt[],PetscInt[]);
2541: PETSC_EXTERN PetscErrorCode PetscSortIntWithArrayPair(PetscInt,PetscInt[],PetscInt[],PetscInt[]);
2542: PETSC_EXTERN PetscErrorCode PetscSortMPIInt(PetscInt,PetscMPIInt[]);
2543: PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsMPIInt(PetscInt*,PetscMPIInt[]);
2544: PETSC_EXTERN PetscErrorCode PetscSortMPIIntWithArray(PetscMPIInt,PetscMPIInt[],PetscMPIInt[]);
2545: PETSC_EXTERN PetscErrorCode PetscSortIntWithScalarArray(PetscInt,PetscInt[],PetscScalar[]);
2546: PETSC_EXTERN PetscErrorCode PetscSortIntWithDataArray(PetscInt,PetscInt[],void*,size_t,void*);
2547: PETSC_EXTERN PetscErrorCode PetscSortReal(PetscInt,PetscReal[]);
2548: PETSC_EXTERN PetscErrorCode PetscSortRealWithPermutation(PetscInt,const PetscReal[],PetscInt[]);
2549: PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsReal(PetscInt*,PetscReal[]);
2550: PETSC_EXTERN PetscErrorCode PetscSortSplit(PetscInt,PetscInt,PetscScalar[],PetscInt[]);
2551: PETSC_EXTERN PetscErrorCode PetscSortSplitReal(PetscInt,PetscInt,PetscReal[],PetscInt[]);
2552: PETSC_EXTERN PetscErrorCode PetscProcessTree(PetscInt,const PetscBool [],const PetscInt[],PetscInt*,PetscInt**,PetscInt**,PetscInt**,PetscInt**);
2553: PETSC_EXTERN PetscErrorCode PetscMergeIntArrayPair(PetscInt,const PetscInt[],const PetscInt[],PetscInt,const PetscInt[],const PetscInt[],PetscInt*,PetscInt**,PetscInt**);
2554: PETSC_EXTERN PetscErrorCode PetscMergeIntArray(PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscInt*,PetscInt**);
2555: PETSC_EXTERN PetscErrorCode PetscMergeMPIIntArray(PetscInt,const PetscMPIInt[],PetscInt,const PetscMPIInt[],PetscInt*,PetscMPIInt**);

2557: PETSC_EXTERN PetscErrorCode PetscSetDisplay(void);
2558: PETSC_EXTERN PetscErrorCode PetscGetDisplay(char[],size_t);

2560: /*J
2561:     PetscRandomType - String with the name of a PETSc randomizer

2563:    Level: beginner

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

2568: .seealso: PetscRandomSetType(), PetscRandom, PetscRandomCreate()
2569: J*/
2570: typedef const char* PetscRandomType;
2571: #define PETSCRAND       "rand"
2572: #define PETSCRAND48     "rand48"
2573: #define PETSCSPRNG      "sprng"
2574: #define PETSCRANDER48   "rander48"

2576: /* Logging support */
2577: PETSC_EXTERN PetscClassId PETSC_RANDOM_CLASSID;

2579: PETSC_EXTERN PetscErrorCode PetscRandomInitializePackage(void);

2581: /*S
2582:      PetscRandom - Abstract PETSc object that manages generating random numbers

2584:    Level: intermediate

2586:   Concepts: random numbers

2588: .seealso:  PetscRandomCreate(), PetscRandomGetValue(), PetscRandomType
2589: S*/
2590: typedef struct _p_PetscRandom*   PetscRandom;

2592: /* Dynamic creation and loading functions */
2593: PETSC_EXTERN PetscFunctionList PetscRandomList;

2595: PETSC_EXTERN PetscErrorCode PetscRandomRegister(const char[],PetscErrorCode (*)(PetscRandom));
2596: PETSC_EXTERN PetscErrorCode PetscRandomSetType(PetscRandom, PetscRandomType);
2597: PETSC_EXTERN PetscErrorCode PetscRandomSetFromOptions(PetscRandom);
2598: PETSC_EXTERN PetscErrorCode PetscRandomGetType(PetscRandom, PetscRandomType*);
2599: PETSC_STATIC_INLINE PetscErrorCode PetscRandomViewFromOptions(PetscRandom A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
2600: PETSC_EXTERN PetscErrorCode PetscRandomView(PetscRandom,PetscViewer);

2602: PETSC_EXTERN PetscErrorCode PetscRandomCreate(MPI_Comm,PetscRandom*);
2603: PETSC_EXTERN PetscErrorCode PetscRandomGetValue(PetscRandom,PetscScalar*);
2604: PETSC_EXTERN PetscErrorCode PetscRandomGetValueReal(PetscRandom,PetscReal*);
2605: PETSC_EXTERN PetscErrorCode PetscRandomGetInterval(PetscRandom,PetscScalar*,PetscScalar*);
2606: PETSC_EXTERN PetscErrorCode PetscRandomSetInterval(PetscRandom,PetscScalar,PetscScalar);
2607: PETSC_EXTERN PetscErrorCode PetscRandomSetSeed(PetscRandom,unsigned long);
2608: PETSC_EXTERN PetscErrorCode PetscRandomGetSeed(PetscRandom,unsigned long *);
2609: PETSC_EXTERN PetscErrorCode PetscRandomSeed(PetscRandom);
2610: PETSC_EXTERN PetscErrorCode PetscRandomDestroy(PetscRandom*);

2612: PETSC_EXTERN PetscErrorCode PetscGetFullPath(const char[],char[],size_t);
2613: PETSC_EXTERN PetscErrorCode PetscGetRelativePath(const char[],char[],size_t);
2614: PETSC_EXTERN PetscErrorCode PetscGetWorkingDirectory(char[],size_t);
2615: PETSC_EXTERN PetscErrorCode PetscGetRealPath(const char[],char[]);
2616: PETSC_EXTERN PetscErrorCode PetscGetHomeDirectory(char[],size_t);
2617: PETSC_EXTERN PetscErrorCode PetscTestFile(const char[],char,PetscBool *);
2618: PETSC_EXTERN PetscErrorCode PetscTestDirectory(const char[],char,PetscBool *);
2619: PETSC_EXTERN PetscErrorCode PetscMkdir(const char[]);
2620: PETSC_EXTERN PetscErrorCode PetscRMTree(const char[]);

2622: PETSC_EXTERN PetscErrorCode PetscBinaryRead(int,void*,PetscInt,PetscDataType);
2623: PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedRead(MPI_Comm,int,void*,PetscInt,PetscDataType);
2624: PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedWrite(MPI_Comm,int,void*,PetscInt,PetscDataType,PetscBool );
2625: PETSC_EXTERN PetscErrorCode PetscBinaryWrite(int,void*,PetscInt,PetscDataType,PetscBool );
2626: PETSC_EXTERN PetscErrorCode PetscBinaryOpen(const char[],PetscFileMode,int *);
2627: PETSC_EXTERN PetscErrorCode PetscBinaryClose(int);
2628: PETSC_EXTERN PetscErrorCode PetscSharedTmp(MPI_Comm,PetscBool  *);
2629: PETSC_EXTERN PetscErrorCode PetscSharedWorkingDirectory(MPI_Comm,PetscBool  *);
2630: PETSC_EXTERN PetscErrorCode PetscGetTmp(MPI_Comm,char[],size_t);
2631: PETSC_EXTERN PetscErrorCode PetscFileRetrieve(MPI_Comm,const char[],char[],size_t,PetscBool *);
2632: PETSC_EXTERN PetscErrorCode PetscLs(MPI_Comm,const char[],char[],size_t,PetscBool *);
2633: PETSC_EXTERN PetscErrorCode PetscOpenSocket(const char[],int,int*);

2635: /*
2636:    In binary files variables are stored using the following lengths,
2637:   regardless of how they are stored in memory on any one particular
2638:   machine. Use these rather then sizeof() in computing sizes for
2639:   PetscBinarySeek().
2640: */
2641: #define PETSC_BINARY_INT_SIZE   (32/8)
2642: #define PETSC_BINARY_FLOAT_SIZE  (32/8)
2643: #define PETSC_BINARY_CHAR_SIZE  (8/8)
2644: #define PETSC_BINARY_SHORT_SIZE  (16/8)
2645: #define PETSC_BINARY_DOUBLE_SIZE  (64/8)
2646: #define PETSC_BINARY_SCALAR_SIZE  sizeof(PetscScalar)

2648: /*E
2649:   PetscBinarySeekType - argument to PetscBinarySeek()

2651:   Level: advanced

2653: .seealso: PetscBinarySeek(), PetscBinarySynchronizedSeek()
2654: E*/
2655: typedef enum {PETSC_BINARY_SEEK_SET = 0,PETSC_BINARY_SEEK_CUR = 1,PETSC_BINARY_SEEK_END = 2} PetscBinarySeekType;
2656: PETSC_EXTERN PetscErrorCode PetscBinarySeek(int,off_t,PetscBinarySeekType,off_t*);
2657: PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedSeek(MPI_Comm,int,off_t,PetscBinarySeekType,off_t*);
2658: PETSC_EXTERN PetscErrorCode PetscByteSwap(void *,PetscDataType,PetscInt);

2660: PETSC_EXTERN PetscErrorCode PetscSetDebugTerminal(const char[]);
2661: PETSC_EXTERN PetscErrorCode PetscSetDebugger(const char[],PetscBool );
2662: PETSC_EXTERN PetscErrorCode PetscSetDefaultDebugger(void);
2663: PETSC_EXTERN PetscErrorCode PetscSetDebuggerFromString(const char*);
2664: PETSC_EXTERN PetscErrorCode PetscAttachDebugger(void);
2665: PETSC_EXTERN PetscErrorCode PetscStopForDebugger(void);

2667: PETSC_EXTERN PetscErrorCode PetscGatherNumberOfMessages(MPI_Comm,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt*);
2668: PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**);
2669: PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths2(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**,PetscMPIInt**);
2670: PETSC_EXTERN PetscErrorCode PetscPostIrecvInt(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscInt***,MPI_Request**);
2671: PETSC_EXTERN PetscErrorCode PetscPostIrecvScalar(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscScalar***,MPI_Request**);
2672: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSided(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt*,const void*,PetscMPIInt*,PetscMPIInt**,void*)
2673:   PetscAttrMPIPointerWithType(6,3);
2674: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedF(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt[],const void*,PetscMPIInt*,PetscMPIInt**,void*,PetscMPIInt,
2675:                                                     PetscErrorCode (*send)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,PetscMPIInt,void*,MPI_Request[],void*),
2676:                                                     PetscErrorCode (*recv)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,void*,MPI_Request[],void*),void *ctx)
2677:   PetscAttrMPIPointerWithType(6,3);
2678: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedFReq(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt[],const void*,PetscMPIInt*,PetscMPIInt**,void*,PetscMPIInt,
2679:                                                        MPI_Request**,MPI_Request**,
2680:                                                        PetscErrorCode (*send)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,PetscMPIInt,void*,MPI_Request[],void*),
2681:                                                        PetscErrorCode (*recv)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,void*,MPI_Request[],void*),void *ctx)
2682:   PetscAttrMPIPointerWithType(6,3);

2684: /*E
2685:     PetscBuildTwoSidedType - algorithm for setting up two-sided communication

2687: $  PETSC_BUILDTWOSIDED_ALLREDUCE - classical algorithm using an MPI_Allreduce with
2688: $      a buffer of length equal to the communicator size. Not memory-scalable due to
2689: $      the large reduction size. Requires only MPI-1.
2690: $  PETSC_BUILDTWOSIDED_IBARRIER - nonblocking algorithm based on MPI_Issend and MPI_Ibarrier.
2691: $      Proved communication-optimal in Hoefler, Siebert, and Lumsdaine (2010). Requires MPI-3.
2692: $  PETSC_BUILDTWOSIDED_REDSCATTER - similar to above, but use more optimized function
2693: $      that only communicates the part of the reduction that is necessary.  Requires MPI-2.

2695:    Level: developer

2697: .seealso: PetscCommBuildTwoSided(), PetscCommBuildTwoSidedSetType(), PetscCommBuildTwoSidedGetType()
2698: E*/
2699: typedef enum {
2700:   PETSC_BUILDTWOSIDED_NOTSET = -1,
2701:   PETSC_BUILDTWOSIDED_ALLREDUCE = 0,
2702:   PETSC_BUILDTWOSIDED_IBARRIER = 1,
2703:   PETSC_BUILDTWOSIDED_REDSCATTER = 2
2704:   /* Updates here must be accompanied by updates in finclude/petscsys.h and the string array in mpits.c */
2705: } PetscBuildTwoSidedType;
2706: PETSC_EXTERN const char *const PetscBuildTwoSidedTypes[];
2707: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedSetType(MPI_Comm,PetscBuildTwoSidedType);
2708: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedGetType(MPI_Comm,PetscBuildTwoSidedType*);

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

2712: /*E
2713:   InsertMode - Whether entries are inserted or added into vectors or matrices

2715:   Level: beginner

2717: .seealso: VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(),
2718:           VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(),
2719:           MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd()
2720: E*/
2721:  typedef enum {NOT_SET_VALUES, INSERT_VALUES, ADD_VALUES, MAX_VALUES, INSERT_ALL_VALUES, ADD_ALL_VALUES, INSERT_BC_VALUES, ADD_BC_VALUES} InsertMode;

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

2726:     Level: beginner

2728: .seealso: InsertMode, VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(),
2729:           VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), ADD_VALUES,
2730:           MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd(), MAX_VALUES

2732: M*/

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

2738:     Level: beginner

2740: .seealso: InsertMode, VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(),
2741:           VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), INSERT_VALUES,
2742:           MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd(), MAX_VALUES

2744: M*/

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

2749:     Level: beginner

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

2753: M*/

2755: PETSC_EXTERN MPI_Comm PetscObjectComm(PetscObject);

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

2760: /*S
2761:    PetscSubcomm - A decomposition of an MPI communicator into subcommunicators

2763:    Notes: After a call to PetscSubcommSetType(), PetscSubcommSetTypeGeneral(), or PetscSubcommSetFromOptions() one may call
2764: $     PetscSubcommChild() returns the associated subcommunicator on this process
2765: $     PetscSubcommContiguousParent() returns a parent communitor but with all child of the same subcommunicator having contiguous rank

2767:    Sample Usage:
2768:        PetscSubcommCreate()
2769:        PetscSubcommSetNumber()
2770:        PetscSubcommSetType(PETSC_SUBCOMM_INTERLACED);
2771:        ccomm = PetscSubcommChild()
2772:        PetscSubcommDestroy()

2774:    Level: advanced

2776:    Concepts: communicator, create

2778:    Notes:
2779: $   PETSC_SUBCOMM_GENERAL - similar to MPI_Comm_split() each process sets the new communicator (color) they will belong to and the order within that communicator
2780: $   PETSC_SUBCOMM_CONTIGUOUS - each new communicator contains a set of process with contiguous ranks in the original MPI communicator
2781: $   PETSC_SUBCOMM_INTERLACED - each new communictor contains a set of processes equally far apart in rank from the others in that new communicator

2783:    Examaple: Consider a communicator with six processes split into 3 subcommunicators.
2784: $     PETSC_SUBCOMM_CONTIGUOUS - the first communicator contains rank 0,1  the second rank 2,3 and the third rank 4,5 in the original ordering of the original communicator
2785: $     PETSC_SUBCOMM_INTERLACED - the first communicator contains rank 0,3, the second 1,4 and the third 2,5

2787:    Developer Notes: This is used in objects such as PCREDUNDANT() to manage the subcommunicators on which the redundant computations
2788:       are performed.


2791: .seealso: PetscSubcommCreate(), PetscSubcommSetNumber(), PetscSubcommSetType(), PetscSubcommView(), PetscSubcommSetFromOptions()

2793: S*/
2794: typedef struct _n_PetscSubcomm* PetscSubcomm;

2796: struct _n_PetscSubcomm {
2797:   MPI_Comm         parent;           /* parent communicator */
2798:   MPI_Comm         dupparent;        /* duplicate parent communicator, under which the processors of this subcomm have contiguous rank */
2799:   MPI_Comm         child;            /* the sub-communicator */
2800:   PetscMPIInt      n;                /* num of subcommunicators under the parent communicator */
2801:   PetscMPIInt      color;            /* color of processors belong to this communicator */
2802:   PetscMPIInt      *subsize;         /* size of subcommunicator[color] */
2803:   PetscSubcommType type;
2804:   char             *subcommprefix;
2805: };

2807: PETSC_STATIC_INLINE MPI_Comm PetscSubcommParent(PetscSubcomm scomm) {return scomm->parent;}
2808: PETSC_STATIC_INLINE MPI_Comm PetscSubcommChild(PetscSubcomm scomm) {return scomm->child;}
2809: PETSC_STATIC_INLINE MPI_Comm PetscSubcommContiguousParent(PetscSubcomm scomm) {return scomm->dupparent;}
2810: PETSC_EXTERN PetscErrorCode PetscSubcommCreate(MPI_Comm,PetscSubcomm*);
2811: PETSC_EXTERN PetscErrorCode PetscSubcommDestroy(PetscSubcomm*);
2812: PETSC_EXTERN PetscErrorCode PetscSubcommSetNumber(PetscSubcomm,PetscInt);
2813: PETSC_EXTERN PetscErrorCode PetscSubcommSetType(PetscSubcomm,PetscSubcommType);
2814: PETSC_EXTERN PetscErrorCode PetscSubcommSetTypeGeneral(PetscSubcomm,PetscMPIInt,PetscMPIInt);
2815: PETSC_EXTERN PetscErrorCode PetscSubcommView(PetscSubcomm,PetscViewer);
2816: PETSC_EXTERN PetscErrorCode PetscSubcommSetFromOptions(PetscSubcomm);
2817: PETSC_EXTERN PetscErrorCode PetscSubcommSetOptionsPrefix(PetscSubcomm,const char[]);

2819: /*S
2820:      PetscHeap - A simple class for managing heaps

2822:    Level: intermediate

2824:   Concepts: random numbers

2826: .seealso:  PetscHeapCreate(), PetscHeapAdd(), PetscHeapPop(), PetscHeapPeek(), PetscHeapStash(), PetscHeapUnstash(), PetscHeapView(), PetscHeapDestroy()
2827: S*/
2828: typedef struct _PetscHeap *PetscHeap;

2830: PETSC_EXTERN PetscErrorCode PetscHeapCreate(PetscInt,PetscHeap*);
2831: PETSC_EXTERN PetscErrorCode PetscHeapAdd(PetscHeap,PetscInt,PetscInt);
2832: PETSC_EXTERN PetscErrorCode PetscHeapPop(PetscHeap,PetscInt*,PetscInt*);
2833: PETSC_EXTERN PetscErrorCode PetscHeapPeek(PetscHeap,PetscInt*,PetscInt*);
2834: PETSC_EXTERN PetscErrorCode PetscHeapStash(PetscHeap,PetscInt,PetscInt);
2835: PETSC_EXTERN PetscErrorCode PetscHeapUnstash(PetscHeap);
2836: PETSC_EXTERN PetscErrorCode PetscHeapDestroy(PetscHeap*);
2837: PETSC_EXTERN PetscErrorCode PetscHeapView(PetscHeap,PetscViewer);

2839: /*S
2840:    PetscSegBuffer - a segmented extendable buffer

2842:    Level: developer

2844: .seealso: PetscSegBufferCreate(), PetscSegBufferGet(), PetscSegBufferExtract(), PetscSegBufferDestroy()
2845: S*/
2846: typedef struct _n_PetscSegBuffer *PetscSegBuffer;
2847: PETSC_EXTERN PetscErrorCode PetscSegBufferCreate(size_t,size_t,PetscSegBuffer*);
2848: PETSC_EXTERN PetscErrorCode PetscSegBufferDestroy(PetscSegBuffer*);
2849: PETSC_EXTERN PetscErrorCode PetscSegBufferGet(PetscSegBuffer,size_t,void*);
2850: PETSC_EXTERN PetscErrorCode PetscSegBufferExtractAlloc(PetscSegBuffer,void*);
2851: PETSC_EXTERN PetscErrorCode PetscSegBufferExtractTo(PetscSegBuffer,void*);
2852: PETSC_EXTERN PetscErrorCode PetscSegBufferExtractInPlace(PetscSegBuffer,void*);
2853: PETSC_EXTERN PetscErrorCode PetscSegBufferGetSize(PetscSegBuffer,size_t*);
2854: PETSC_EXTERN PetscErrorCode PetscSegBufferUnuse(PetscSegBuffer,size_t);

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

2861: typedef struct _n_PetscOptionsHelpPrinted *PetscOptionsHelpPrinted;
2862: extern PetscOptionsHelpPrinted PetscOptionsHelpPrintedSingleton;
2863: PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedDestroy(PetscOptionsHelpPrinted*);
2864: PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedCreate(PetscOptionsHelpPrinted*);
2865: PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedCheck(PetscOptionsHelpPrinted,const char*,const char*,PetscBool*);

2867: PETSC_EXTERN PetscSegBuffer PetscCitationsList;

2869: /*@C
2870:       PetscCitationsRegister - Register a bibtex item to obtain credit for an implemented algorithm used in the code.

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

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

2878:    Level: intermediate

2880:      Options Database:
2881: .     -citations [filename]   - print out the bibtex entries for the given computation
2882: @*/
2883: PETSC_STATIC_INLINE PetscErrorCode PetscCitationsRegister(const char cit[],PetscBool *set)
2884: {
2885:   size_t         len;
2886:   char           *vstring;

2890:   if (set && *set) return(0);
2891:   PetscStrlen(cit,&len);
2892:   PetscSegBufferGet(PetscCitationsList,len,&vstring);
2893:   PetscMemcpy(vstring,cit,len);
2894:   if (set) *set = PETSC_TRUE;
2895:   return(0);
2896: }

2898: PETSC_EXTERN PetscErrorCode PetscURLShorten(const char[],char[],size_t);
2899: PETSC_EXTERN PetscErrorCode PetscGoogleDriveAuthorize(MPI_Comm,char[],char[],size_t);
2900: PETSC_EXTERN PetscErrorCode PetscGoogleDriveRefresh(MPI_Comm,const char[],char[],size_t);
2901: PETSC_EXTERN PetscErrorCode PetscGoogleDriveUpload(MPI_Comm,const char[],const char []);

2903: PETSC_EXTERN PetscErrorCode PetscBoxAuthorize(MPI_Comm,char[],char[],size_t);
2904: PETSC_EXTERN PetscErrorCode PetscBoxRefresh(MPI_Comm,const char[],char[],char[],size_t);

2906: PETSC_EXTERN PetscErrorCode PetscTextBelt(MPI_Comm,const char[],const char[],PetscBool*);
2907: PETSC_EXTERN PetscErrorCode PetscTellMyCell(MPI_Comm,const char[],const char[],PetscBool*);

2909: PETSC_EXTERN PetscErrorCode PetscPullJSONValue(const char[],const char[],char[],size_t,PetscBool*);
2910: PETSC_EXTERN PetscErrorCode PetscPushJSONValue(char[],const char[],const char[],size_t);


2913: #if defined(PETSC_USE_DEBUG)
2914: /*
2915:    Verify that all processes in the communicator have called this from the same line of code
2916:  */
2917: PETSC_EXTERN PetscErrorCode PetscAllreduceBarrierCheck(MPI_Comm,PetscMPIInt,int,const char*,const char *);

2919: /*MC
2920:    MPIU_Allreduce - a PETSc replacement for MPI_Allreduce() that tries to determine if the call from all the MPI processes occur from the
2921:                     same place in the PETSc code. This helps to detect bugs where different MPI processes follow different code paths
2922:                     resulting in inconsistent and incorrect calls to MPI_Allreduce().

2924:    Collective on MPI_Comm

2926:    Synopsis:
2927:      #include <petscsys.h>
2928:      PetscErrorCode MPIU_Allreduce(void *indata,void *outdata,PetscMPIInt count,MPI_Datatype datatype, MPI_Op op, MPI_Comm comm);

2930:    Input Parameters:
2931: +  indata - pointer to the input data to be reduced
2932: .  count - the number of MPI data items in indata and outdata
2933: .  datatype - the MPI datatype, for example MPI_INT
2934: .  op - the MPI operation, for example MPI_SUM
2935: -  comm - the MPI communicator on which the operation occurs

2937:    Output Parameter:
2938: .  outdata - the reduced values

2940:    Notes: In optimized mode this directly calls MPI_Allreduce()

2942:    Level: developer

2944: .seealso: MPI_Allreduce()
2945: M*/
2946: #define MPIU_Allreduce(a,b,c,d,e,fcomm) (PetscAllreduceBarrierCheck(fcomm,c,__LINE__,PETSC_FUNCTION_NAME,__FILE__) || MPI_Allreduce(a,b,c,d,e,fcomm))
2947: #else
2948: #define MPIU_Allreduce(a,b,c,d,e,fcomm) MPI_Allreduce(a,b,c,d,e,fcomm)
2949: #endif

2951: #endif