Actual source code: petscsys.h

petsc-master 2017-01-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  PetscUnlikely(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:     PetscLogDouble variables are used to contain double precision numbers
1394:   that are not used in the numerical computations, but rather in logging,
1395:   timing etc.
1396: */
1397: typedef double PetscLogDouble;
1398: #define MPIU_PETSCLOGDOUBLE MPI_DOUBLE

1400: /*
1401:    Routines for tracing memory corruption/bleeding with default PETSc memory allocation
1402: */
1403: PETSC_EXTERN PetscErrorCode PetscMallocDump(FILE *);
1404: PETSC_EXTERN PetscErrorCode PetscMallocDumpLog(FILE *);
1405: PETSC_EXTERN PetscErrorCode PetscMallocGetCurrentUsage(PetscLogDouble *);
1406: PETSC_EXTERN PetscErrorCode PetscMallocGetMaximumUsage(PetscLogDouble *);
1407: PETSC_EXTERN PetscErrorCode PetscMallocDebug(PetscBool);
1408: PETSC_EXTERN PetscErrorCode PetscMallocGetDebug(PetscBool*);
1409: PETSC_EXTERN PetscErrorCode PetscMallocValidate(int,const char[],const char[]);
1410: PETSC_EXTERN PetscErrorCode PetscMallocSetDumpLog(void);
1411: PETSC_EXTERN PetscErrorCode PetscMallocSetDumpLogThreshold(PetscLogDouble);
1412: PETSC_EXTERN PetscErrorCode PetscMallocGetDumpLog(PetscBool*);

1414: /*E
1415:     PetscDataType - Used for handling different basic data types.

1417:    Level: beginner

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

1421: .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscDataTypeToMPIDataType(),
1422:           PetscDataTypeGetSize()

1424: E*/
1425: typedef enum {PETSC_INT = 0,PETSC_DOUBLE = 1,PETSC_COMPLEX = 2, PETSC_LONG = 3 ,PETSC_SHORT = 4,PETSC_FLOAT = 5,
1426:               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;
1427: PETSC_EXTERN const char *const PetscDataTypes[];

1429: #if defined(PETSC_USE_COMPLEX)
1430: #define  PETSC_SCALAR  PETSC_COMPLEX
1431: #else
1432: #if defined(PETSC_USE_REAL_SINGLE)
1433: #define  PETSC_SCALAR  PETSC_FLOAT
1434: #elif defined(PETSC_USE_REAL___FLOAT128)
1435: #define  PETSC_SCALAR  PETSC___FLOAT128
1436: #elif defined(PETSC_USE_REAL___FP16)
1437: #define  PETSC_SCALAR  PETSC___FP16
1438: #else
1439: #define  PETSC_SCALAR  PETSC_DOUBLE
1440: #endif
1441: #endif
1442: #if defined(PETSC_USE_REAL_SINGLE)
1443: #define  PETSC_REAL  PETSC_FLOAT
1444: #elif defined(PETSC_USE_REAL___FLOAT128)
1445: #define  PETSC_REAL  PETSC___FLOAT128
1446: #elif defined(PETSC_USE_REAL___FP16)
1447: #define  PETSC_REAL  PETSC___FP16
1448: #else
1449: #define  PETSC_REAL  PETSC_DOUBLE
1450: #endif
1451: #define  PETSC_FORTRANADDR  PETSC_LONG

1453: PETSC_EXTERN PetscErrorCode PetscDataTypeToMPIDataType(PetscDataType,MPI_Datatype*);
1454: PETSC_EXTERN PetscErrorCode PetscMPIDataTypeToPetscDataType(MPI_Datatype,PetscDataType*);
1455: PETSC_EXTERN PetscErrorCode PetscDataTypeGetSize(PetscDataType,size_t*);
1456: PETSC_EXTERN PetscErrorCode PetscDataTypeFromString(const char*,PetscDataType*,PetscBool*);

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

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

1495: /*S
1496:     PetscToken - 'Token' used for managing tokenizing strings

1498:   Level: intermediate

1500: .seealso: PetscTokenCreate(), PetscTokenFind(), PetscTokenDestroy()
1501: S*/
1502: typedef struct _p_PetscToken* PetscToken;

1504: PETSC_EXTERN PetscErrorCode PetscTokenCreate(const char[],const char,PetscToken*);
1505: PETSC_EXTERN PetscErrorCode PetscTokenFind(PetscToken,char *[]);
1506: PETSC_EXTERN PetscErrorCode PetscTokenDestroy(PetscToken*);

1508: PETSC_EXTERN PetscErrorCode PetscEListFind(PetscInt,const char *const*,const char*,PetscInt*,PetscBool*);
1509: PETSC_EXTERN PetscErrorCode PetscEnumFind(const char *const*,const char*,PetscEnum*,PetscBool*);

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

1529: PETSC_EXTERN PetscErrorCode MPIULong_Send(void*,PetscInt,MPI_Datatype,PetscMPIInt,PetscMPIInt,MPI_Comm);
1530: PETSC_EXTERN PetscErrorCode MPIULong_Recv(void*,PetscInt,MPI_Datatype,PetscMPIInt,PetscMPIInt,MPI_Comm);

1532: /*S
1533:      PetscObject - any PETSc object, PetscViewer, Mat, Vec, KSP etc

1535:    Level: beginner

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

1539: .seealso:  PetscObjectDestroy(), PetscObjectView(), PetscObjectGetName(), PetscObjectSetName(), PetscObjectReference(), PetscObjectDereference()
1540: S*/
1541: typedef struct _p_PetscObject* PetscObject;

1543: /*MC
1544:     PetscObjectId - unique integer Id for a PetscObject

1546:     Level: developer

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

1550: .seealso: PetscObjectState, PetscObjectGetId()
1551: M*/
1552: #if defined(PETSC_USING_F90) && !defined(PETSC_USE_FORTRANKIND) /* compaq F90 */
1553: typedef int PetscObjectId;
1554: #else
1555: typedef PetscInt64 PetscObjectId;
1556: #endif

1558: /*MC
1559:     PetscObjectState - integer state for a PetscObject

1561:     Level: developer

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

1567: .seealso: PetscObjectId, PetscObjectStateGet(), PetscObjectStateIncrease(), PetscObjectStateSet()
1568: M*/
1569: #if defined(PETSC_USING_F90) && !defined(PETSC_USE_FORTRANKIND) /* compaq F90 */
1570: typedef int PetscObjectState;
1571: #else
1572: typedef PetscInt64 PetscObjectState;
1573: #endif

1575: /*S
1576:      PetscFunctionList - Linked list of functions, possibly stored in dynamic libraries, accessed
1577:       by string name

1579:    Level: advanced

1581: .seealso:  PetscFunctionListAdd(), PetscFunctionListDestroy(), PetscOpFlist
1582: S*/
1583: typedef struct _n_PetscFunctionList *PetscFunctionList;

1585: /*E
1586:   PetscFileMode - Access mode for a file.

1588:   Level: beginner

1590: $  FILE_MODE_READ - open a file at its beginning for reading
1591: $  FILE_MODE_WRITE - open a file at its beginning for writing (will create if the file does not exist)
1592: $  FILE_MODE_APPEND - open a file at end for writing
1593: $  FILE_MODE_UPDATE - open a file for updating, meaning for reading and writing
1594: $  FILE_MODE_APPEND_UPDATE - open a file for updating, meaning for reading and writing, at the end

1596: .seealso: PetscViewerFileSetMode()
1597: E*/
1598: typedef enum {FILE_MODE_READ, FILE_MODE_WRITE, FILE_MODE_APPEND, FILE_MODE_UPDATE, FILE_MODE_APPEND_UPDATE} PetscFileMode;
1599: extern const char *const PetscFileModes[];

1601: /*
1602:     Defines PETSc error handling.
1603: */
1604:  #include <petscerror.h>

1606: #define PETSC_SMALLEST_CLASSID  1211211
1607: PETSC_EXTERN PetscClassId PETSC_LARGEST_CLASSID;
1608: PETSC_EXTERN PetscClassId PETSC_OBJECT_CLASSID;
1609: PETSC_EXTERN PetscErrorCode PetscClassIdRegister(const char[],PetscClassId *);

1611: /*
1612:    Routines that get memory usage information from the OS
1613: */
1614: PETSC_EXTERN PetscErrorCode PetscMemoryGetCurrentUsage(PetscLogDouble *);
1615: PETSC_EXTERN PetscErrorCode PetscMemoryGetMaximumUsage(PetscLogDouble *);
1616: PETSC_EXTERN PetscErrorCode PetscMemorySetGetMaximumUsage(void);
1617: PETSC_EXTERN PetscErrorCode PetscMemoryTrace(const char[]);

1619: PETSC_EXTERN PetscErrorCode PetscInfoAllow(PetscBool ,const char []);
1620: PETSC_EXTERN PetscErrorCode PetscSleep(PetscReal);

1622: /*
1623:    Initialization of PETSc
1624: */
1625: PETSC_EXTERN PetscErrorCode PetscInitialize(int*,char***,const char[],const char[]);
1626: PETSC_EXTERN PetscErrorCode PetscInitializeNoPointers(int,char**,const char[],const char[]);
1627: PETSC_EXTERN PetscErrorCode PetscInitializeNoArguments(void);
1628: PETSC_EXTERN PetscErrorCode PetscInitialized(PetscBool *);
1629: PETSC_EXTERN PetscErrorCode PetscFinalized(PetscBool *);
1630: PETSC_EXTERN PetscErrorCode PetscFinalize(void);
1631: PETSC_EXTERN PetscErrorCode PetscInitializeFortran(void);
1632: PETSC_EXTERN PetscErrorCode PetscGetArgs(int*,char ***);
1633: PETSC_EXTERN PetscErrorCode PetscGetArguments(char ***);
1634: PETSC_EXTERN PetscErrorCode PetscFreeArguments(char **);

1636: PETSC_EXTERN PetscErrorCode PetscEnd(void);
1637: PETSC_EXTERN PetscErrorCode PetscSysInitializePackage(void);

1639: PETSC_EXTERN PetscErrorCode PetscPythonInitialize(const char[],const char[]);
1640: PETSC_EXTERN PetscErrorCode PetscPythonFinalize(void);
1641: PETSC_EXTERN PetscErrorCode PetscPythonPrintError(void);
1642: PETSC_EXTERN PetscErrorCode PetscPythonMonitorSet(PetscObject,const char[]);

1644: /*
1645:      These are so that in extern C code we can caste function pointers to non-extern C
1646:    function pointers. Since the regular C++ code expects its function pointers to be C++
1647: */
1648: PETSC_EXTERN_TYPEDEF typedef void (**PetscVoidStarFunction)(void);
1649: PETSC_EXTERN_TYPEDEF typedef void (*PetscVoidFunction)(void);
1650: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*PetscErrorCodeFunction)(void);

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

1681:  #include <petscviewertypes.h>
1682:  #include <petscoptions.h>

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

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

1706: #if defined(PETSC_HAVE_SAWS)
1707: PETSC_EXTERN PetscErrorCode PetscSAWsBlock(void);
1708: PETSC_EXTERN PetscErrorCode PetscObjectSAWsViewOff(PetscObject);
1709: PETSC_EXTERN PetscErrorCode PetscObjectSAWsSetBlock(PetscObject,PetscBool);
1710: PETSC_EXTERN PetscErrorCode PetscObjectSAWsBlock(PetscObject);
1711: PETSC_EXTERN PetscErrorCode PetscObjectSAWsGrantAccess(PetscObject);
1712: PETSC_EXTERN PetscErrorCode PetscObjectSAWsTakeAccess(PetscObject);
1713: PETSC_EXTERN void           PetscStackSAWsGrantAccess(void);
1714: PETSC_EXTERN void           PetscStackSAWsTakeAccess(void);
1715: PETSC_EXTERN PetscErrorCode PetscStackViewSAWs(void);
1716: PETSC_EXTERN PetscErrorCode PetscStackSAWsViewOff(void);

1718: #else
1719: #define PetscSAWsBlock()                        0
1720: #define PetscObjectSAWsViewOff(obj)             0
1721: #define PetscObjectSAWsSetBlock(obj,flg)        0
1722: #define PetscObjectSAWsBlock(obj)               0
1723: #define PetscObjectSAWsGrantAccess(obj)         0
1724: #define PetscObjectSAWsTakeAccess(obj)          0
1725: #define PetscStackViewSAWs()                    0
1726: #define PetscStackSAWsViewOff()                 0
1727: #define PetscStackSAWsTakeAccess()
1728: #define PetscStackSAWsGrantAccess()

1730: #endif

1732: typedef void* PetscDLHandle;
1733: typedef enum {PETSC_DL_DECIDE=0,PETSC_DL_NOW=1,PETSC_DL_LOCAL=2} PetscDLMode;
1734: PETSC_EXTERN PetscErrorCode PetscDLOpen(const char[],PetscDLMode,PetscDLHandle *);
1735: PETSC_EXTERN PetscErrorCode PetscDLClose(PetscDLHandle *);
1736: PETSC_EXTERN PetscErrorCode PetscDLSym(PetscDLHandle,const char[],void **);

1738: #if defined(PETSC_USE_DEBUG)
1739: PETSC_EXTERN PetscErrorCode PetscMallocGetStack(void*,PetscStack**);
1740: #endif
1741: PETSC_EXTERN PetscErrorCode PetscObjectsDump(FILE*,PetscBool);

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

1746:    Level: developer

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

1750: .seealso:  PetscObjectListAdd(), PetscObjectListDestroy(), PetscObjectListFind(), PetscObjectCompose(), PetscObjectQuery(), PetscFunctionList
1751: S*/
1752: typedef struct _n_PetscObjectList *PetscObjectList;

1754: PETSC_EXTERN PetscErrorCode PetscObjectListDestroy(PetscObjectList*);
1755: PETSC_EXTERN PetscErrorCode PetscObjectListFind(PetscObjectList,const char[],PetscObject*);
1756: PETSC_EXTERN PetscErrorCode PetscObjectListReverseFind(PetscObjectList,PetscObject,char**,PetscBool*);
1757: PETSC_EXTERN PetscErrorCode PetscObjectListAdd(PetscObjectList *,const char[],PetscObject);
1758: PETSC_EXTERN PetscErrorCode PetscObjectListRemoveReference(PetscObjectList *,const char[]);
1759: PETSC_EXTERN PetscErrorCode PetscObjectListDuplicate(PetscObjectList,PetscObjectList *);

1761: /*
1762:     Dynamic library lists. Lists of names of routines in objects or in dynamic
1763:   link libraries that will be loaded as needed.
1764: */

1766: #define PetscFunctionListAdd(list,name,fptr) PetscFunctionListAdd_Private((list),(name),(PetscVoidFunction)(fptr))
1767: PETSC_EXTERN PetscErrorCode PetscFunctionListAdd_Private(PetscFunctionList*,const char[],void (*)(void));
1768: PETSC_EXTERN PetscErrorCode PetscFunctionListDestroy(PetscFunctionList*);
1769: #define PetscFunctionListFind(list,name,fptr) PetscFunctionListFind_Private((list),(name),(PetscVoidFunction*)(fptr))
1770: PETSC_EXTERN PetscErrorCode PetscFunctionListFind_Private(PetscFunctionList,const char[],void (**)(void));
1771: PETSC_EXTERN PetscErrorCode PetscFunctionListPrintTypes(MPI_Comm,FILE*,const char[],const char[],const char[],const char[],PetscFunctionList,const char[]);
1772: PETSC_EXTERN PetscErrorCode PetscFunctionListDuplicate(PetscFunctionList,PetscFunctionList *);
1773: PETSC_EXTERN PetscErrorCode PetscFunctionListView(PetscFunctionList,PetscViewer);
1774: PETSC_EXTERN PetscErrorCode PetscFunctionListGet(PetscFunctionList,const char ***,int*);

1776: /*S
1777:      PetscDLLibrary - Linked list of dynamics libraries to search for functions

1779:    Level: advanced

1781: .seealso:  PetscDLLibraryOpen()
1782: S*/
1783: typedef struct _n_PetscDLLibrary *PetscDLLibrary;
1784: PETSC_EXTERN PetscDLLibrary  PetscDLLibrariesLoaded;
1785: PETSC_EXTERN PetscErrorCode PetscDLLibraryAppend(MPI_Comm,PetscDLLibrary *,const char[]);
1786: PETSC_EXTERN PetscErrorCode PetscDLLibraryPrepend(MPI_Comm,PetscDLLibrary *,const char[]);
1787: PETSC_EXTERN PetscErrorCode PetscDLLibrarySym(MPI_Comm,PetscDLLibrary *,const char[],const char[],void **);
1788: PETSC_EXTERN PetscErrorCode PetscDLLibraryPrintPath(PetscDLLibrary);
1789: PETSC_EXTERN PetscErrorCode PetscDLLibraryRetrieve(MPI_Comm,const char[],char *,size_t,PetscBool  *);
1790: PETSC_EXTERN PetscErrorCode PetscDLLibraryOpen(MPI_Comm,const char[],PetscDLLibrary *);
1791: PETSC_EXTERN PetscErrorCode PetscDLLibraryClose(PetscDLLibrary);

1793: /*
1794:      Useful utility routines
1795: */
1796: PETSC_EXTERN PetscErrorCode PetscSplitOwnership(MPI_Comm,PetscInt*,PetscInt*);
1797: PETSC_EXTERN PetscErrorCode PetscSplitOwnershipBlock(MPI_Comm,PetscInt,PetscInt*,PetscInt*);
1798: PETSC_EXTERN PetscErrorCode PetscSequentialPhaseBegin(MPI_Comm,PetscMPIInt);
1799: PETSC_EXTERN PetscErrorCode PetscSequentialPhaseEnd(MPI_Comm,PetscMPIInt);
1800: PETSC_EXTERN PetscErrorCode PetscBarrier(PetscObject);
1801: PETSC_EXTERN PetscErrorCode PetscMPIDump(FILE*);

1803: /*
1804:     PetscNot - negates a logical type value and returns result as a PetscBool

1806:     Notes: This is useful in cases like
1807: $     int        *a;
1808: $     PetscBool  flag = PetscNot(a)
1809:      where !a would not return a PetscBool because we cannot provide a cast from int to PetscBool in C.
1810: */
1811: #define PetscNot(a) ((a) ? PETSC_FALSE : PETSC_TRUE)

1813: /*MC
1814:     PetscHelpPrintf - Prints help messages.

1816:    Synopsis:
1817:     #include <petscsys.h>
1818:      PetscErrorCode (*PetscHelpPrintf)(const char format[],...);

1820:     Not Collective

1822:     Input Parameters:
1823: .   format - the usual printf() format string

1825:    Level: developer

1827:     Fortran Note:
1828:     This routine is not supported in Fortran.

1830:     Concepts: help messages^printing
1831:     Concepts: printing^help messages

1833: .seealso: PetscFPrintf(), PetscSynchronizedPrintf(), PetscErrorPrintf()
1834: M*/
1835: PETSC_EXTERN PetscErrorCode (*PetscHelpPrintf)(MPI_Comm,const char[],...);

1837: /*
1838:      Defines PETSc profiling.
1839: */
1840:  #include <petsclog.h>

1842: /*
1843:       Simple PETSc parallel IO for ASCII printing
1844: */
1845: PETSC_EXTERN PetscErrorCode PetscFixFilename(const char[],char[]);
1846: PETSC_EXTERN PetscErrorCode PetscFOpen(MPI_Comm,const char[],const char[],FILE**);
1847: PETSC_EXTERN PetscErrorCode PetscFClose(MPI_Comm,FILE*);
1848: PETSC_EXTERN PetscErrorCode PetscFPrintf(MPI_Comm,FILE*,const char[],...);
1849: PETSC_EXTERN PetscErrorCode PetscPrintf(MPI_Comm,const char[],...);
1850: PETSC_EXTERN PetscErrorCode PetscSNPrintf(char*,size_t,const char [],...);
1851: PETSC_EXTERN PetscErrorCode PetscSNPrintfCount(char*,size_t,const char [],size_t*,...);

1853: PETSC_EXTERN PetscErrorCode PetscErrorPrintfDefault(const char [],...);
1854: PETSC_EXTERN PetscErrorCode PetscErrorPrintfNone(const char [],...);
1855: PETSC_EXTERN PetscErrorCode PetscHelpPrintfDefault(MPI_Comm,const char [],...);

1857: #if defined(PETSC_HAVE_POPEN)
1858: PETSC_EXTERN PetscErrorCode PetscPOpen(MPI_Comm,const char[],const char[],const char[],FILE **);
1859: PETSC_EXTERN PetscErrorCode PetscPClose(MPI_Comm,FILE*,int*);
1860: PETSC_EXTERN PetscErrorCode PetscPOpenSetMachine(const char[]);
1861: #endif

1863: PETSC_EXTERN PetscErrorCode PetscSynchronizedPrintf(MPI_Comm,const char[],...);
1864: PETSC_EXTERN PetscErrorCode PetscSynchronizedFPrintf(MPI_Comm,FILE*,const char[],...);
1865: PETSC_EXTERN PetscErrorCode PetscSynchronizedFlush(MPI_Comm,FILE*);
1866: PETSC_EXTERN PetscErrorCode PetscSynchronizedFGets(MPI_Comm,FILE*,size_t,char[]);
1867: PETSC_EXTERN PetscErrorCode PetscStartMatlab(MPI_Comm,const char[],const char[],FILE**);
1868: PETSC_EXTERN PetscErrorCode PetscStartJava(MPI_Comm,const char[],const char[],FILE**);
1869: PETSC_EXTERN PetscErrorCode PetscGetPetscDir(const char*[]);

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

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

1876:    Level: advanced

1878: .seealso:  PetscObject, PetscContainerCreate()
1879: S*/
1880: PETSC_EXTERN PetscClassId PETSC_CONTAINER_CLASSID;
1881: typedef struct _p_PetscContainer*  PetscContainer;
1882: PETSC_EXTERN PetscErrorCode PetscContainerGetPointer(PetscContainer,void **);
1883: PETSC_EXTERN PetscErrorCode PetscContainerSetPointer(PetscContainer,void *);
1884: PETSC_EXTERN PetscErrorCode PetscContainerDestroy(PetscContainer*);
1885: PETSC_EXTERN PetscErrorCode PetscContainerCreate(MPI_Comm,PetscContainer *);
1886: PETSC_EXTERN PetscErrorCode PetscContainerSetUserDestroy(PetscContainer, PetscErrorCode (*)(void*));

1888: /*
1889:    For use in debuggers
1890: */
1891: PETSC_EXTERN PetscMPIInt PetscGlobalRank;
1892: PETSC_EXTERN PetscMPIInt PetscGlobalSize;
1893: PETSC_EXTERN PetscErrorCode PetscIntView(PetscInt,const PetscInt[],PetscViewer);
1894: PETSC_EXTERN PetscErrorCode PetscRealView(PetscInt,const PetscReal[],PetscViewer);
1895: PETSC_EXTERN PetscErrorCode PetscScalarView(PetscInt,const PetscScalar[],PetscViewer);

1897: #include <stddef.h>
1898: #include <string.h>             /* for memcpy, memset */
1899: #if defined(PETSC_HAVE_STDLIB_H)
1900: #include <stdlib.h>
1901: #endif

1903: #if defined(PETSC_HAVE_XMMINTRIN_H) && !defined(__CUDACC__)
1904: #include <xmmintrin.h>
1905: #endif

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

1912:    Not Collective

1914:    Input Parameters:
1915: +  b - pointer to initial memory space
1916: -  n - length (in bytes) of space to copy

1918:    Output Parameter:
1919: .  a - pointer to copy space

1921:    Level: intermediate

1923:    Compile Option:
1924:     PETSC_PREFER_DCOPY_FOR_MEMCPY will cause the BLAS dcopy() routine to be used
1925:                                   for memory copies on double precision values.
1926:     PETSC_PREFER_COPY_FOR_MEMCPY will cause C code to be used
1927:                                   for memory copies on double precision values.
1928:     PETSC_PREFER_FORTRAN_FORMEMCPY will cause Fortran code to be used
1929:                                   for memory copies on double precision values.

1931:    Note:
1932:    This routine is analogous to memcpy().

1934:    Developer Note: this is inlined for fastest performance

1936:   Concepts: memory^copying
1937:   Concepts: copying^memory

1939: .seealso: PetscMemmove()

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

1984: /*@C
1985:    PetscMemzero - Zeros the specified memory.

1987:    Not Collective

1989:    Input Parameters:
1990: +  a - pointer to beginning memory location
1991: -  n - length (in bytes) of memory to initialize

1993:    Level: intermediate

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

1999:    Developer Note: this is inlined for fastest performance

2001:    Concepts: memory^zeroing
2002:    Concepts: zeroing^memory

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

2036: /*MC
2037:    PetscPrefetchBlock - Prefetches a block of memory

2039:    Synopsis:
2040:     #include <petscsys.h>
2041:     void PetscPrefetchBlock(const anytype *a,size_t n,int rw,int t)

2043:    Not Collective

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

2051:    Level: developer

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

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

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

2066:    Concepts: memory
2067: M*/
2068: #define PetscPrefetchBlock(a,n,rw,t) do {                               \
2069:     const char *_p = (const char*)(a),*_end = (const char*)((a)+(n));   \
2070:     for ( ; _p < _end; _p += PETSC_LEVEL1_DCACHE_LINESIZE) PETSC_Prefetch(_p,(rw),(t)); \
2071:   } while (0)

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

2082: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTCRL)
2083: #define PETSC_USE_FORTRAN_KERNEL_MULTCRL
2084: #endif

2086: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJPERM)
2087: #define PETSC_USE_FORTRAN_KERNEL_MULTAIJPERM
2088: #endif

2090: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJ)
2091: #define PETSC_USE_FORTRAN_KERNEL_MULTAIJ
2092: #endif

2094: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ)
2095: #define PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ
2096: #endif

2098: #if !defined(PETSC_USE_FORTRAN_KERNEL_NORM)
2099: #define PETSC_USE_FORTRAN_KERNEL_NORM
2100: #endif

2102: #if !defined(PETSC_USE_FORTRAN_KERNEL_MAXPY)
2103: #define PETSC_USE_FORTRAN_KERNEL_MAXPY
2104: #endif

2106: #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ)
2107: #define PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ
2108: #endif

2110: #if !defined(PETSC_USE_FORTRAN_KERNEL_RELAXAIJ)
2111: #define PETSC_USE_FORTRAN_KERNEL_RELAXAIJ
2112: #endif

2114: #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ)
2115: #define PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ
2116: #endif

2118: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ)
2119: #define PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ
2120: #endif

2122: #if !defined(PETSC_USE_FORTRAN_KERNEL_MDOT)
2123: #define PETSC_USE_FORTRAN_KERNEL_MDOT
2124: #endif

2126: #if !defined(PETSC_USE_FORTRAN_KERNEL_XTIMESY)
2127: #define PETSC_USE_FORTRAN_KERNEL_XTIMESY
2128: #endif

2130: #if !defined(PETSC_USE_FORTRAN_KERNEL_AYPX)
2131: #define PETSC_USE_FORTRAN_KERNEL_AYPX
2132: #endif

2134: #if !defined(PETSC_USE_FORTRAN_KERNEL_WAXPY)
2135: #define PETSC_USE_FORTRAN_KERNEL_WAXPY
2136: #endif

2138: #endif

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

2155: /* --------------------------------------------------------------------*/

2157: /*MC
2158:     MPI_Comm - the basic object used by MPI to determine which processes are involved in a
2159:         communication

2161:    Level: beginner

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

2165: .seealso: PETSC_COMM_WORLD, PETSC_COMM_SELF
2166: M*/

2168: /*MC
2169:     PetscScalar - PETSc type that represents either a double precision real number, a double precision
2170:        complex number, a single precision real number, a __float128 real or complex or a __fp16 real - if the code is configured
2171:        with --with-scalar-type=real,complex --with-precision=single,double,__float128,__fp16

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

2176:    Level: beginner

2178: .seealso: PetscReal, MPIU_SCALAR, PetscInt, MPIU_REAL, PetscComplex, MPIU_INT
2179: M*/

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

2184:    Synopsis:
2185:    #include <petscsys.h>
2186:    PetscComplex number = 1. + 2.*PETSC_i;

2188:    Level: beginner

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

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

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

2197: .seealso: PetscReal, PetscComplex, MPIU_COMPLEX, PetscInt, PETSC_i
2198: M*/

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

2203:    Level: beginner

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

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

2210: .seealso: PetscScalar, PetscComplex, MPIU_REAL, MPIU_SCALAR
2211: M*/

2213: /*MC
2214:     MPIU_SCALAR - MPI datatype corresponding to PetscScalar

2216:    Level: beginner

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

2221: .seealso: PetscReal, PetscScalar, MPIU_INT, MPIU_REAL, MPIU_COMPLEX
2222: M*/

2224: #if defined(PETSC_HAVE_MPIIO)
2225: #if !defined(PETSC_WORDS_BIGENDIAN)
2226: PETSC_EXTERN PetscErrorCode MPIU_File_write_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*);
2227: PETSC_EXTERN PetscErrorCode MPIU_File_read_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*);
2228: #else
2229: #define MPIU_File_write_all(a,b,c,d,e) MPI_File_write_all(a,b,c,d,e)
2230: #define MPIU_File_read_all(a,b,c,d,e) MPI_File_read_all(a,b,c,d,e)
2231: #endif
2232: #endif

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

2236: /* Limit MPI to 32-bits */
2237: #define PETSC_MPI_INT_MAX  2147483647
2238: #define PETSC_MPI_INT_MIN -2147483647
2239: /* Limit BLAS to 32-bits */
2240: #define PETSC_BLAS_INT_MAX  2147483647
2241: #define PETSC_BLAS_INT_MIN -2147483647

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

2247:    Not Collective

2249:    Input Parameter:
2250: .     a - the PetscInt value

2252:    Output Parameter:
2253: .     b - the resulting PetscBLASInt value

2255:    Level: advanced

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

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

2273:    Not Collective

2275:    Input Parameter:
2276: .     a - the PetscInt value

2278:    Output Parameter:
2279: .     b - the resulting PetscMPIInt value

2281:    Level: advanced

2283: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast()
2284: @*/
2285: PETSC_STATIC_INLINE PetscErrorCode PetscMPIIntCast(PetscInt a,PetscMPIInt *b)
2286: {
2288:   *b =  (PetscMPIInt)(a);
2289: #if defined(PETSC_USE_64BIT_INDICES)
2290:   if ((a) > PETSC_MPI_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array too long for MPI");
2291: #endif
2292:   return(0);
2293: }

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

2297: /*@C

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

2301:    Not Collective

2303:    Input Parameter:
2304: +     a - the PetscReal value
2305: -     b - the second value

2307:    Returns:
2308:       the result as a PetscInt value

2310:    Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64
2311:    Use PetscIntMultTruncate() to compute the product of two positive PetscInt and truncate to fit a PetscInt
2312:    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

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

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

2318:    Level: advanced

2320: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult()
2321: @*/
2322: PETSC_STATIC_INLINE PetscInt PetscRealIntMultTruncate(PetscReal a,PetscInt b)
2323: {
2324:   PetscInt64 r;

2326:   r  =  (PetscInt64) (a*(PetscReal)b);
2327:   if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100;
2328:   return (PetscInt) r;
2329: }

2331: /*@C

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

2335:    Not Collective

2337:    Input Parameter:
2338: +     a - the PetscInt value
2339: -     b - the second value

2341:    Returns:
2342:       the result as a PetscInt value

2344:    Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64
2345:    Use PetscRealIntMultTruncate() to compute the product of a PetscReal and a PetscInt and truncate to fit a PetscInt
2346:    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

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

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

2352:    Level: advanced

2354: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult()
2355: @*/
2356: PETSC_STATIC_INLINE PetscInt PetscIntMultTruncate(PetscInt a,PetscInt b)
2357: {
2358:   PetscInt64 r;

2360:   r  =  PetscInt64Mult(a,b);
2361:   if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100;
2362:   return (PetscInt) r;
2363: }

2365: /*@C

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

2369:    Not Collective

2371:    Input Parameter:
2372: +     a - the PetscInt value
2373: -     b - the second value

2375:    Returns:
2376:      the result as a PetscInt value

2378:    Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64
2379:    Use PetscRealIntMultTruncate() to compute the product of a PetscReal and a PetscInt and truncate to fit a PetscInt
2380:    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

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

2384:    Level: advanced

2386: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult()
2387: @*/
2388: PETSC_STATIC_INLINE PetscInt PetscIntSumTruncate(PetscInt a,PetscInt b)
2389: {
2390:   PetscInt64 r;

2392:   r  =  ((PetscInt64)a) + ((PetscInt64)b);
2393:   if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100;
2394:   return (PetscInt) r;
2395: }

2397: /*@C

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

2401:    Not Collective

2403:    Input Parameter:
2404: +     a - the PetscInt value
2405: -     b - the second value

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

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

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

2415:    Level: advanced

2417: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscIntMult64(), PetscIntSumError()
2418: @*/
2419: PETSC_STATIC_INLINE PetscErrorCode PetscIntMultError(PetscInt a,PetscInt b,PetscInt *result)
2420: {
2421:   PetscInt64 r;

2424:   r  =  PetscInt64Mult(a,b);
2425: #if !defined(PETSC_USE_64BIT_INDICES)
2426:   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);
2427: #endif
2428:   if (result) *result = (PetscInt) r;
2429:   return(0);
2430: }

2432: /*@C

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

2436:    Not Collective

2438:    Input Parameter:
2439: +     a - the PetscInt value
2440: -     b - the second value

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

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

2448:    Level: advanced

2450: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult()
2451: @*/
2452: PETSC_STATIC_INLINE PetscErrorCode PetscIntSumError(PetscInt a,PetscInt b,PetscInt *result)
2453: {
2454:   PetscInt64 r;

2457:   r  =  ((PetscInt64)a) + ((PetscInt64)b);
2458: #if !defined(PETSC_USE_64BIT_INDICES)
2459:   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);
2460: #endif
2461:   if (result) *result = (PetscInt) r;
2462:   return(0);
2463: }
2464: 
2465: /*
2466:      The IBM include files define hz, here we hide it so that it may be used as a regular user variable.
2467: */
2468: #if defined(hz)
2469: #undef hz
2470: #endif

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


2475: #if defined(PETSC_HAVE_LIMITS_H)
2476: #include <limits.h>
2477: #endif
2478: #if defined(PETSC_HAVE_SYS_PARAM_H)
2479: #include <sys/param.h>
2480: #endif
2481: #if defined(PETSC_HAVE_SYS_TYPES_H)
2482: #include <sys/types.h>
2483: #endif
2484: #if defined(MAXPATHLEN)
2485: #  define PETSC_MAX_PATH_LEN     MAXPATHLEN
2486: #elif defined(MAX_PATH)
2487: #  define PETSC_MAX_PATH_LEN     MAX_PATH
2488: #elif defined(_MAX_PATH)
2489: #  define PETSC_MAX_PATH_LEN     _MAX_PATH
2490: #else
2491: #  define PETSC_MAX_PATH_LEN     4096
2492: #endif

2494: /*MC

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

2499: $
2500: $#include "petsc/finclude/petscXXX.h"
2501: $         use petscXXXX

2503:      You can delcare PETSc variables using either 

2505: $    XXX variablename
2506: $    type(tXXX) variablename

2508:     for example

2510: $#include "petsc/finclude/petscvec.h"
2511: $         use petscvec
2512: $
2513: $    Vec  A
2514: $    type(tVec) A

2516:     Level: beginner

2518: M*/

2520: PETSC_EXTERN PetscErrorCode PetscGetArchType(char[],size_t);
2521: PETSC_EXTERN PetscErrorCode PetscGetHostName(char[],size_t);
2522: PETSC_EXTERN PetscErrorCode PetscGetUserName(char[],size_t);
2523: PETSC_EXTERN PetscErrorCode PetscGetProgramName(char[],size_t);
2524: PETSC_EXTERN PetscErrorCode PetscSetProgramName(const char[]);
2525: PETSC_EXTERN PetscErrorCode PetscGetDate(char[],size_t);
2526: PETSC_EXTERN PetscErrorCode PetscGetVersion(char[], size_t);
2527: PETSC_EXTERN PetscErrorCode PetscGetVersionNumber(PetscInt*,PetscInt*,PetscInt*,PetscInt*);

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

2551: PETSC_EXTERN PetscErrorCode PetscSetDisplay(void);
2552: PETSC_EXTERN PetscErrorCode PetscGetDisplay(char[],size_t);

2554: /*J
2555:     PetscRandomType - String with the name of a PETSc randomizer

2557:    Level: beginner

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

2562: .seealso: PetscRandomSetType(), PetscRandom, PetscRandomCreate()
2563: J*/
2564: typedef const char* PetscRandomType;
2565: #define PETSCRAND       "rand"
2566: #define PETSCRAND48     "rand48"
2567: #define PETSCSPRNG      "sprng"
2568: #define PETSCRANDER48   "rander48"

2570: /* Logging support */
2571: PETSC_EXTERN PetscClassId PETSC_RANDOM_CLASSID;

2573: PETSC_EXTERN PetscErrorCode PetscRandomInitializePackage(void);

2575: /*S
2576:      PetscRandom - Abstract PETSc object that manages generating random numbers

2578:    Level: intermediate

2580:   Concepts: random numbers

2582: .seealso:  PetscRandomCreate(), PetscRandomGetValue(), PetscRandomType
2583: S*/
2584: typedef struct _p_PetscRandom*   PetscRandom;

2586: /* Dynamic creation and loading functions */
2587: PETSC_EXTERN PetscFunctionList PetscRandomList;

2589: PETSC_EXTERN PetscErrorCode PetscRandomRegister(const char[],PetscErrorCode (*)(PetscRandom));
2590: PETSC_EXTERN PetscErrorCode PetscRandomSetType(PetscRandom, PetscRandomType);
2591: PETSC_EXTERN PetscErrorCode PetscRandomSetFromOptions(PetscRandom);
2592: PETSC_EXTERN PetscErrorCode PetscRandomGetType(PetscRandom, PetscRandomType*);
2593: PETSC_STATIC_INLINE PetscErrorCode PetscRandomViewFromOptions(PetscRandom A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
2594: PETSC_EXTERN PetscErrorCode PetscRandomView(PetscRandom,PetscViewer);

2596: PETSC_EXTERN PetscErrorCode PetscRandomCreate(MPI_Comm,PetscRandom*);
2597: PETSC_EXTERN PetscErrorCode PetscRandomGetValue(PetscRandom,PetscScalar*);
2598: PETSC_EXTERN PetscErrorCode PetscRandomGetValueReal(PetscRandom,PetscReal*);
2599: PETSC_EXTERN PetscErrorCode PetscRandomGetInterval(PetscRandom,PetscScalar*,PetscScalar*);
2600: PETSC_EXTERN PetscErrorCode PetscRandomSetInterval(PetscRandom,PetscScalar,PetscScalar);
2601: PETSC_EXTERN PetscErrorCode PetscRandomSetSeed(PetscRandom,unsigned long);
2602: PETSC_EXTERN PetscErrorCode PetscRandomGetSeed(PetscRandom,unsigned long *);
2603: PETSC_EXTERN PetscErrorCode PetscRandomSeed(PetscRandom);
2604: PETSC_EXTERN PetscErrorCode PetscRandomDestroy(PetscRandom*);

2606: PETSC_EXTERN PetscErrorCode PetscGetFullPath(const char[],char[],size_t);
2607: PETSC_EXTERN PetscErrorCode PetscGetRelativePath(const char[],char[],size_t);
2608: PETSC_EXTERN PetscErrorCode PetscGetWorkingDirectory(char[],size_t);
2609: PETSC_EXTERN PetscErrorCode PetscGetRealPath(const char[],char[]);
2610: PETSC_EXTERN PetscErrorCode PetscGetHomeDirectory(char[],size_t);
2611: PETSC_EXTERN PetscErrorCode PetscTestFile(const char[],char,PetscBool *);
2612: PETSC_EXTERN PetscErrorCode PetscTestDirectory(const char[],char,PetscBool *);
2613: PETSC_EXTERN PetscErrorCode PetscMkdir(const char[]);
2614: PETSC_EXTERN PetscErrorCode PetscRMTree(const char[]);

2616: PETSC_EXTERN PetscErrorCode PetscBinaryRead(int,void*,PetscInt,PetscDataType);
2617: PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedRead(MPI_Comm,int,void*,PetscInt,PetscDataType);
2618: PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedWrite(MPI_Comm,int,void*,PetscInt,PetscDataType,PetscBool );
2619: PETSC_EXTERN PetscErrorCode PetscBinaryWrite(int,void*,PetscInt,PetscDataType,PetscBool );
2620: PETSC_EXTERN PetscErrorCode PetscBinaryOpen(const char[],PetscFileMode,int *);
2621: PETSC_EXTERN PetscErrorCode PetscBinaryClose(int);
2622: PETSC_EXTERN PetscErrorCode PetscSharedTmp(MPI_Comm,PetscBool  *);
2623: PETSC_EXTERN PetscErrorCode PetscSharedWorkingDirectory(MPI_Comm,PetscBool  *);
2624: PETSC_EXTERN PetscErrorCode PetscGetTmp(MPI_Comm,char[],size_t);
2625: PETSC_EXTERN PetscErrorCode PetscFileRetrieve(MPI_Comm,const char[],char[],size_t,PetscBool *);
2626: PETSC_EXTERN PetscErrorCode PetscLs(MPI_Comm,const char[],char[],size_t,PetscBool *);
2627: PETSC_EXTERN PetscErrorCode PetscOpenSocket(const char[],int,int*);

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

2642: /*E
2643:   PetscBinarySeekType - argument to PetscBinarySeek()

2645:   Level: advanced

2647: .seealso: PetscBinarySeek(), PetscBinarySynchronizedSeek()
2648: E*/
2649: typedef enum {PETSC_BINARY_SEEK_SET = 0,PETSC_BINARY_SEEK_CUR = 1,PETSC_BINARY_SEEK_END = 2} PetscBinarySeekType;
2650: PETSC_EXTERN PetscErrorCode PetscBinarySeek(int,off_t,PetscBinarySeekType,off_t*);
2651: PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedSeek(MPI_Comm,int,off_t,PetscBinarySeekType,off_t*);
2652: PETSC_EXTERN PetscErrorCode PetscByteSwap(void *,PetscDataType,PetscInt);

2654: PETSC_EXTERN PetscErrorCode PetscSetDebugTerminal(const char[]);
2655: PETSC_EXTERN PetscErrorCode PetscSetDebugger(const char[],PetscBool );
2656: PETSC_EXTERN PetscErrorCode PetscSetDefaultDebugger(void);
2657: PETSC_EXTERN PetscErrorCode PetscSetDebuggerFromString(const char*);
2658: PETSC_EXTERN PetscErrorCode PetscAttachDebugger(void);
2659: PETSC_EXTERN PetscErrorCode PetscStopForDebugger(void);

2661: PETSC_EXTERN PetscErrorCode PetscGatherNumberOfMessages(MPI_Comm,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt*);
2662: PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**);
2663: PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths2(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**,PetscMPIInt**);
2664: PETSC_EXTERN PetscErrorCode PetscPostIrecvInt(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscInt***,MPI_Request**);
2665: PETSC_EXTERN PetscErrorCode PetscPostIrecvScalar(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscScalar***,MPI_Request**);
2666: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSided(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt*,const void*,PetscMPIInt*,PetscMPIInt**,void*)
2667:   PetscAttrMPIPointerWithType(6,3);
2668: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedF(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt[],const void*,PetscMPIInt*,PetscMPIInt**,void*,PetscMPIInt,
2669:                                                     PetscErrorCode (*send)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,PetscMPIInt,void*,MPI_Request[],void*),
2670:                                                     PetscErrorCode (*recv)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,void*,MPI_Request[],void*),void *ctx)
2671:   PetscAttrMPIPointerWithType(6,3);
2672: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedFReq(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt[],const void*,PetscMPIInt*,PetscMPIInt**,void*,PetscMPIInt,
2673:                                                        MPI_Request**,MPI_Request**,
2674:                                                        PetscErrorCode (*send)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,PetscMPIInt,void*,MPI_Request[],void*),
2675:                                                        PetscErrorCode (*recv)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,void*,MPI_Request[],void*),void *ctx)
2676:   PetscAttrMPIPointerWithType(6,3);

2678: /*E
2679:     PetscBuildTwoSidedType - algorithm for setting up two-sided communication

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

2689:    Level: developer

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

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

2706: /*E
2707:   InsertMode - Whether entries are inserted or added into vectors or matrices

2709:   Level: beginner

2711: .seealso: VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(),
2712:           VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(),
2713:           MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd()
2714: E*/
2715:  typedef enum {NOT_SET_VALUES, INSERT_VALUES, ADD_VALUES, MAX_VALUES, INSERT_ALL_VALUES, ADD_ALL_VALUES, INSERT_BC_VALUES, ADD_BC_VALUES} InsertMode;

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

2720:     Level: beginner

2722: .seealso: InsertMode, VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(),
2723:           VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), ADD_VALUES,
2724:           MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd(), MAX_VALUES

2726: M*/

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

2732:     Level: beginner

2734: .seealso: InsertMode, VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(),
2735:           VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), INSERT_VALUES,
2736:           MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd(), MAX_VALUES

2738: M*/

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

2743:     Level: beginner

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

2747: M*/

2749: PETSC_EXTERN MPI_Comm PetscObjectComm(PetscObject);

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

2754: /*S
2755:    PetscSubcomm - A decomposition of an MPI communicator into subcommunicators

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

2761:    Sample Usage:
2762:        PetscSubcommCreate()
2763:        PetscSubcommSetNumber()
2764:        PetscSubcommSetType(PETSC_SUBCOMM_INTERLACED);
2765:        ccomm = PetscSubcommChild()
2766:        PetscSubcommDestroy()

2768:    Level: advanced

2770:    Concepts: communicator, create

2772:    Notes:
2773: $   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
2774: $   PETSC_SUBCOMM_CONTIGUOUS - each new communicator contains a set of process with contiguous ranks in the original MPI communicator
2775: $   PETSC_SUBCOMM_INTERLACED - each new communictor contains a set of processes equally far apart in rank from the others in that new communicator

2777:    Examaple: Consider a communicator with six processes split into 3 subcommunicators.
2778: $     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
2779: $     PETSC_SUBCOMM_INTERLACED - the first communicator contains rank 0,3, the second 1,4 and the third 2,5

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


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

2787: S*/
2788: typedef struct _n_PetscSubcomm* PetscSubcomm;

2790: struct _n_PetscSubcomm {
2791:   MPI_Comm         parent;           /* parent communicator */
2792:   MPI_Comm         dupparent;        /* duplicate parent communicator, under which the processors of this subcomm have contiguous rank */
2793:   MPI_Comm         child;            /* the sub-communicator */
2794:   PetscMPIInt      n;                /* num of subcommunicators under the parent communicator */
2795:   PetscMPIInt      color;            /* color of processors belong to this communicator */
2796:   PetscMPIInt      *subsize;         /* size of subcommunicator[color] */
2797:   PetscSubcommType type;
2798:   char             *subcommprefix;
2799: };

2801: PETSC_STATIC_INLINE MPI_Comm PetscSubcommParent(PetscSubcomm scomm) {return scomm->parent;}
2802: PETSC_STATIC_INLINE MPI_Comm PetscSubcommChild(PetscSubcomm scomm) {return scomm->child;}
2803: PETSC_STATIC_INLINE MPI_Comm PetscSubcommContiguousParent(PetscSubcomm scomm) {return scomm->dupparent;}
2804: PETSC_EXTERN PetscErrorCode PetscSubcommCreate(MPI_Comm,PetscSubcomm*);
2805: PETSC_EXTERN PetscErrorCode PetscSubcommDestroy(PetscSubcomm*);
2806: PETSC_EXTERN PetscErrorCode PetscSubcommSetNumber(PetscSubcomm,PetscInt);
2807: PETSC_EXTERN PetscErrorCode PetscSubcommSetType(PetscSubcomm,PetscSubcommType);
2808: PETSC_EXTERN PetscErrorCode PetscSubcommSetTypeGeneral(PetscSubcomm,PetscMPIInt,PetscMPIInt);
2809: PETSC_EXTERN PetscErrorCode PetscSubcommView(PetscSubcomm,PetscViewer);
2810: PETSC_EXTERN PetscErrorCode PetscSubcommSetFromOptions(PetscSubcomm);
2811: PETSC_EXTERN PetscErrorCode PetscSubcommSetOptionsPrefix(PetscSubcomm,const char[]);

2813: /*S
2814:      PetscHeap - A simple class for managing heaps

2816:    Level: intermediate

2818:   Concepts: random numbers

2820: .seealso:  PetscHeapCreate(), PetscHeapAdd(), PetscHeapPop(), PetscHeapPeek(), PetscHeapStash(), PetscHeapUnstash(), PetscHeapView(), PetscHeapDestroy()
2821: S*/
2822: typedef struct _PetscHeap *PetscHeap;

2824: PETSC_EXTERN PetscErrorCode PetscHeapCreate(PetscInt,PetscHeap*);
2825: PETSC_EXTERN PetscErrorCode PetscHeapAdd(PetscHeap,PetscInt,PetscInt);
2826: PETSC_EXTERN PetscErrorCode PetscHeapPop(PetscHeap,PetscInt*,PetscInt*);
2827: PETSC_EXTERN PetscErrorCode PetscHeapPeek(PetscHeap,PetscInt*,PetscInt*);
2828: PETSC_EXTERN PetscErrorCode PetscHeapStash(PetscHeap,PetscInt,PetscInt);
2829: PETSC_EXTERN PetscErrorCode PetscHeapUnstash(PetscHeap);
2830: PETSC_EXTERN PetscErrorCode PetscHeapDestroy(PetscHeap*);
2831: PETSC_EXTERN PetscErrorCode PetscHeapView(PetscHeap,PetscViewer);

2833: /*S
2834:    PetscSegBuffer - a segmented extendable buffer

2836:    Level: developer

2838: .seealso: PetscSegBufferCreate(), PetscSegBufferGet(), PetscSegBufferExtract(), PetscSegBufferDestroy()
2839: S*/
2840: typedef struct _n_PetscSegBuffer *PetscSegBuffer;
2841: PETSC_EXTERN PetscErrorCode PetscSegBufferCreate(size_t,size_t,PetscSegBuffer*);
2842: PETSC_EXTERN PetscErrorCode PetscSegBufferDestroy(PetscSegBuffer*);
2843: PETSC_EXTERN PetscErrorCode PetscSegBufferGet(PetscSegBuffer,size_t,void*);
2844: PETSC_EXTERN PetscErrorCode PetscSegBufferExtractAlloc(PetscSegBuffer,void*);
2845: PETSC_EXTERN PetscErrorCode PetscSegBufferExtractTo(PetscSegBuffer,void*);
2846: PETSC_EXTERN PetscErrorCode PetscSegBufferExtractInPlace(PetscSegBuffer,void*);
2847: PETSC_EXTERN PetscErrorCode PetscSegBufferGetSize(PetscSegBuffer,size_t*);
2848: PETSC_EXTERN PetscErrorCode PetscSegBufferUnuse(PetscSegBuffer,size_t);

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

2855: typedef struct _n_PetscOptionsHelpPrinted *PetscOptionsHelpPrinted;
2856: extern PetscOptionsHelpPrinted PetscOptionsHelpPrintedSingleton;
2857: PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedDestroy(PetscOptionsHelpPrinted*);
2858: PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedCreate(PetscOptionsHelpPrinted*);
2859: PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedCheck(PetscOptionsHelpPrinted,const char*,const char*,PetscBool*);

2861: PETSC_EXTERN PetscSegBuffer PetscCitationsList;

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

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

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

2872:    Level: intermediate

2874:      Options Database:
2875: .     -citations [filename]   - print out the bibtex entries for the given computation
2876: @*/
2877: PETSC_STATIC_INLINE PetscErrorCode PetscCitationsRegister(const char cit[],PetscBool *set)
2878: {
2879:   size_t         len;
2880:   char           *vstring;

2884:   if (set && *set) return(0);
2885:   PetscStrlen(cit,&len);
2886:   PetscSegBufferGet(PetscCitationsList,len,&vstring);
2887:   PetscMemcpy(vstring,cit,len);
2888:   if (set) *set = PETSC_TRUE;
2889:   return(0);
2890: }

2892: PETSC_EXTERN PetscErrorCode PetscURLShorten(const char[],char[],size_t);
2893: PETSC_EXTERN PetscErrorCode PetscGoogleDriveAuthorize(MPI_Comm,char[],char[],size_t);
2894: PETSC_EXTERN PetscErrorCode PetscGoogleDriveRefresh(MPI_Comm,const char[],char[],size_t);
2895: PETSC_EXTERN PetscErrorCode PetscGoogleDriveUpload(MPI_Comm,const char[],const char []);

2897: PETSC_EXTERN PetscErrorCode PetscBoxAuthorize(MPI_Comm,char[],char[],size_t);
2898: PETSC_EXTERN PetscErrorCode PetscBoxRefresh(MPI_Comm,const char[],char[],char[],size_t);

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

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


2907: #if defined(PETSC_USE_DEBUG)
2908: /*
2909:    Verify that all processes in the communicator have called this from the same line of code
2910:  */
2911: PETSC_EXTERN PetscErrorCode PetscAllreduceBarrierCheck(MPI_Comm,PetscMPIInt,int,const char*,const char *);

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

2918:    Collective on MPI_Comm

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

2924:    Input Parameters:
2925: +  indata - pointer to the input data to be reduced
2926: .  count - the number of MPI data items in indata and outdata
2927: .  datatype - the MPI datatype, for example MPI_INT
2928: .  op - the MPI operation, for example MPI_SUM
2929: -  comm - the MPI communicator on which the operation occurs

2931:    Output Parameter:
2932: .  outdata - the reduced values

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

2936:    Level: developer

2938: .seealso: MPI_Allreduce()
2939: M*/
2940: #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))
2941: #else
2942: #define MPIU_Allreduce(a,b,c,d,e,fcomm) MPI_Allreduce(a,b,c,d,e,fcomm)
2943: #endif

2945: #endif