Actual source code: petscsys.h

petsc-3.10.2 2018-10-09
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_INLINE PETSC_CXX_INLINE
 64: #else
 65: #  define PETSC_INLINE PETSC_C_INLINE
 66: #endif

 68: #define PETSC_STATIC_INLINE static PETSC_INLINE

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

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

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

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

112: /* ========================================================================== */

114: /*
115:     Defines the interface to MPI allowing the use of all MPI functions.

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

135: /*
136:    Perform various sanity checks that the correct mpi.h is being included at compile time.
137:    This usually happens because
138:       * either an unexpected mpi.h is in the default compiler path (i.e. in /usr/include) or
139:       * an extra include path -I/something (which contains the unexpected mpi.h) is being passed to the compiler
140: */
141: #if defined(PETSC_HAVE_MPIUNI)
142: #  if !defined(__MPIUNI_H)
143: #    error "PETSc was configured with --with-mpi=0 but now appears to be compiling using a different mpi.h"
144: #  endif
145: #elif defined(PETSC_HAVE_I_MPI_NUMVERSION)
146: #  if !defined(I_MPI_NUMVERSION)
147: #    error "PETSc was configured with I_MPI but now appears to be compiling using a non-I_MPI mpi.h"
148: #  elif I_MPI_NUMVERSION != PETSC_HAVE_I_MPI_NUMVERSION
149: #    error "PETSc was configured with one I_MPI mpi.h version but now appears to be compiling using a different I_MPI mpi.h version"
150: #  endif
151: #elif defined(PETSC_HAVE_MVAPICH2_NUMVERSION)
152: #  if !defined(MVAPICH2_NUMVERSION)
153: #    error "PETSc was configured with MVAPICH2 but now appears to be compiling using a non-MVAPICH2 mpi.h"
154: #  elif MVAPICH2_NUMVERSION != PETSC_HAVE_MVAPICH2_NUMVERSION
155: #    error "PETSc was configured with one MVAPICH2 mpi.h version but now appears to be compiling using a different MVAPICH2 mpi.h version"
156: #  endif
157: #elif defined(PETSC_HAVE_MPICH_NUMVERSION)
158: #  if !defined(MPICH_NUMVERSION) || defined(MVAPICH2_NUMVERSION) || defined(I_MPI_NUMVERSION)
159: #    error "PETSc was configured with MPICH but now appears to be compiling using a non-MPICH mpi.h"
160: #  elif (MPICH_NUMVERSION/100000 != PETSC_HAVE_MPICH_NUMVERSION/100000) || (MPICH_NUMVERSION%100000/1000 < PETSC_HAVE_MPICH_NUMVERSION%100000/1000)
161: #    error "PETSc was configured with one MPICH mpi.h version but now appears to be compiling using a different MPICH mpi.h version"
162: #  endif
163: #elif defined(PETSC_HAVE_OMPI_MAJOR_VERSION)
164: #  if !defined(OMPI_MAJOR_VERSION)
165: #    error "PETSc was configured with OpenMPI but now appears to be compiling using a non-OpenMPI mpi.h"
166: #  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)
167: #    error "PETSc was configured with one OpenMPI mpi.h version but now appears to be compiling using a different OpenMPI mpi.h version"
168: #  endif
169: #elif defined(OMPI_MAJOR_VERSION) || defined(MPICH_NUMVERSION)
170: #  error "PETSc was configured with undetermined MPI - but now appears to be compiling using either of OpenMPI or a MPICH variant"
171: #endif

173: /*
174:     Need to put stdio.h AFTER mpi.h for MPICH2 with C++ compiler
175:     see the top of mpicxx.h in the MPICH2 distribution.
176: */
177: #include <stdio.h>

179: /* MSMPI on 32bit windows requires this yukky hack - that breaks MPI standard compliance */
180: #if !defined(MPIAPI)
181: #define MPIAPI
182: #endif

184: /*
185:    Support for Clang (>=3.2) matching type tag arguments with void* buffer types.
186:    This allows the compiler to detect cases where the MPI datatype argument passed to a MPI routine
187:    does not match the actual type of the argument being passed in
188: */
189: #if defined(__has_attribute) && defined(works_with_const_which_is_not_true)
190: #  if __has_attribute(argument_with_type_tag) && __has_attribute(pointer_with_type_tag) && __has_attribute(type_tag_for_datatype)
191: #    define PetscAttrMPIPointerWithType(bufno,typeno) __attribute__((pointer_with_type_tag(MPI,bufno,typeno)))
192: #    define PetscAttrMPITypeTag(type)                 __attribute__((type_tag_for_datatype(MPI,type)))
193: #    define PetscAttrMPITypeTagLayoutCompatible(type) __attribute__((type_tag_for_datatype(MPI,type,layout_compatible)))
194: #  endif
195: #endif
196: #if !defined(PetscAttrMPIPointerWithType)
197: #  define PetscAttrMPIPointerWithType(bufno,typeno)
198: #  define PetscAttrMPITypeTag(type)
199: #  define PetscAttrMPITypeTagLayoutCompatible(type)
200: #endif

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

205:     Level: beginner

207: .seealso: CHKERRQ, SETERRQ
208: M*/
209: typedef int PetscErrorCode;

211: /*MC

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

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

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

223:     Level: developer

225: .seealso: PetscClassIdRegister(), PetscLogEventRegister(), PetscHeaderCreate()
226: M*/
227: typedef int PetscClassId;


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

233:     Level: intermediate

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

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

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

244: M*/
245: typedef int PetscMPIInt;

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

250:     Level: intermediate

252: .seealso: PetscOptionsGetEnum(), PetscOptionsEnum(), PetscBagRegisterEnum()
253: M*/
254: typedef enum { ENUM_DUMMY } PetscEnum;
255: PETSC_EXTERN MPI_Datatype MPIU_ENUM PetscAttrMPITypeTag(PetscEnum);

257: #if defined(PETSC_HAVE_STDINT_H)
258: #include <stdint.h>
259: #endif
260: #if defined (PETSC_HAVE_INTTYPES_H)
263: #endif
264: #include <inttypes.h>
265: # if !defined(PRId64)
266: # define PRId64 "ld"
267: # endif
268: #endif

270: typedef short PetscShort;
271: typedef char PetscChar;
272: typedef float PetscFloat;

274: /*MC
275:   PetscInt - PETSc type that represents an integer, used primarily to
276:       represent size of arrays and indexing into arrays. Its size can be configured with the option --with-64-bit-indices to be either 32-bit (default) or 64-bit.

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

281:   Level: beginner

283: .seealso: PetscBLASInt, PetscMPIInt, PetscReal, PetscScalar, PetscComplex, PetscInt, MPIU_REAL, MPIU_SCALAR, MPIU_COMPLEX, MPIU_INT
284: M*/

286: /*MC
287:    MPIU_INT - MPI datatype corresponding to PetscInt

289:    Notes:
290:    In MPI calls that require an MPI datatype that matches a PetscInt or array of PetscInt values, pass this value.

292:    Level: beginner

294: .seealso: PetscReal, PetscScalar, PetscComplex, PetscInt, MPIU_REAL, MPIU_SCALAR, MPIU_COMPLEX
295: M*/

297: #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 */
298: typedef int64_t PetscInt64;
299: # define MPIU_INT64 MPI_INT64_T
300: # define PetscInt64_FMT PRId64
301: #elif (PETSC_SIZEOF_LONG_LONG == 8)
302: typedef long long PetscInt64;
303: # define MPIU_INT64 MPI_LONG_LONG_INT
304: # define PetscInt64_FMT "lld"
305: #elif defined(PETSC_HAVE___INT64)
306: typedef __int64 PetscInt64;
307: # define MPIU_INT64 MPI_INT64_T
308: # define PetscInt64_FMT "ld"
309: #else
310: #error "cannot determine PetscInt64 type"
311: #endif

313: #if PETSC_SIZEOF_VOID_P == 4
314: #define MPIU_FORTRANADDR MPI_INT
315: #else
316: #define MPIU_FORTRANADDR MPIU_INT64
317: #endif

319: #if defined(PETSC_USE_64BIT_INDICES)
320: typedef PetscInt64 PetscInt;
321: #define MPIU_INT MPIU_INT64
322: #define PetscInt_FMT PetscInt64_FMT
323: #else
324: typedef int PetscInt;
325: #define MPIU_INT MPI_INT
326: #define PetscInt_FMT "d"
327: #endif

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

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

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

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

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

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

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

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

358:    Level: intermediate

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

362: M*/
363: #if defined(PETSC_HAVE_64BIT_BLAS_INDICES)
364: typedef PetscInt64 PetscBLASInt;
365: #else
366: typedef int PetscBLASInt;
367: #endif

369: /*
370:     For the rare cases when one needs to send a size_t object with MPI
371: */
372: #if (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_INT)
373: #define MPIU_SIZE_T MPI_UNSIGNED
374: #elif  (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_LONG)
375: #define MPIU_SIZE_T MPI_UNSIGNED_LONG
376: #elif  (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_LONG_LONG)
377: #define MPIU_SIZE_T MPI_UNSIGNED_LONG_LONG
378: #else
379: #error "Unknown size for size_t! Send us a bugreport at petsc-maint@mcs.anl.gov"
380: #endif

382: /*
383:       You can use PETSC_STDOUT as a replacement of stdout. You can also change
384:     the value of PETSC_STDOUT to redirect all standard output elsewhere
385: */
386: PETSC_EXTERN FILE* PETSC_STDOUT;

388: /*
389:       You can use PETSC_STDERR as a replacement of stderr. You can also change
390:     the value of PETSC_STDERR to redirect all standard error elsewhere
391: */
392: PETSC_EXTERN FILE* PETSC_STDERR;

394: /*MC
395:     PetscUnlikely - hints the compiler that the given condition is usually FALSE

397:     Synopsis:
398:     #include <petscsys.h>
399:     PetscBool  PetscUnlikely(PetscBool  cond)

401:     Not Collective

403:     Input Parameters:
404: .   cond - condition or expression

406:     Notes:
407:     This returns the same truth value, it is only a hint to compilers that the resulting
408:     branch is unlikely.

410:     Level: advanced

412: .seealso: PetscLikely(), CHKERRQ
413: M*/

415: /*MC
416:     PetscLikely - hints the compiler that the given condition is usually TRUE

418:     Synopsis:
419:     #include <petscsys.h>
420:     PetscBool  PetscLikely(PetscBool  cond)

422:     Not Collective

424:     Input Parameters:
425: .   cond - condition or expression

427:     Notes:
428:     This returns the same truth value, it is only a hint to compilers that the resulting
429:     branch is likely.

431:     Level: advanced

433: .seealso: PetscUnlikely()
434: M*/
435: #if defined(PETSC_HAVE_BUILTIN_EXPECT)
436: #  define PetscUnlikely(cond)   __builtin_expect(!!(cond),0)
437: #  define PetscLikely(cond)     __builtin_expect(!!(cond),1)
438: #else
439: #  define PetscUnlikely(cond)   (cond)
440: #  define PetscLikely(cond)     (cond)
441: #endif

443: /*
444:     Declare extern C stuff after including external header files
445: */


448: /*
449:        Basic PETSc constants
450: */

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

455:    Level: beginner

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

461: .seealso: PETSC_TRUE, PETSC_FALSE, PetscNot()
462: E*/
463: typedef enum { PETSC_FALSE,PETSC_TRUE } PetscBool;
464: PETSC_EXTERN const char *const PetscBools[];
465: PETSC_EXTERN MPI_Datatype MPIU_BOOL PetscAttrMPITypeTag(PetscBool);

467: /*
468:     Defines elementary mathematics functions and constants.
469: */
470:  #include <petscmath.h>

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

475:    Level: beginner

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

483: E*/
484: typedef enum { PETSC_COPY_VALUES, PETSC_OWN_POINTER, PETSC_USE_POINTER} PetscCopyMode;
485: PETSC_EXTERN const char *const PetscCopyModes[];

487: /*MC
488:     PETSC_FALSE - False value of PetscBool

490:     Level: beginner

492:     Note:
493:     Zero integer

495: .seealso: PetscBool, PETSC_TRUE
496: M*/

498: /*MC
499:     PETSC_TRUE - True value of PetscBool

501:     Level: beginner

503:     Note:
504:     Nonzero integer

506: .seealso: PetscBool, PETSC_FALSE
507: M*/

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

512:    Level: beginner

514:    Note:
515:    Accepted by many PETSc functions to not set a parameter and instead use
516:           some default

518:    Fortran Notes:
519:    This macro does not exist in Fortran; you must use PETSC_NULL_INTEGER,
520:           PETSC_NULL_DOUBLE_PRECISION etc

522: .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_DETERMINE

524: M*/
525: #define PETSC_IGNORE         NULL

527: /* This is deprecated */
528: #define PETSC_NULL NULL

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

534:    Level: beginner

536: .seealso: PETSC_DEFAULT, PETSC_IGNORE, PETSC_DETERMINE

538: M*/
539: #define PETSC_DECIDE  -1

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

545:    Level: beginner

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

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

553: M*/
554: #define PETSC_DETERMINE PETSC_DECIDE

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

560:    Level: beginner

562:    Fortran Notes:
563:    You need to use PETSC_DEFAULT_INTEGER or PETSC_DEFAULT_REAL.

565: .seealso: PETSC_DECIDE, PETSC_IGNORE, PETSC_DETERMINE

567: M*/
568: #define PETSC_DEFAULT  -2

570: /*MC
571:     PETSC_COMM_WORLD - the equivalent of the MPI_COMM_WORLD communicator which represents
572:            all the processs that PETSc knows about.

574:    Level: beginner

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

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

585: .seealso: PETSC_COMM_SELF

587: M*/
588: PETSC_EXTERN MPI_Comm PETSC_COMM_WORLD;

590: /*MC
591:     PETSC_COMM_SELF - This is always MPI_COMM_SELF

593:    Level: beginner

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

598: .seealso: PETSC_COMM_WORLD

600: M*/
601: #define PETSC_COMM_SELF MPI_COMM_SELF

603: PETSC_EXTERN PetscBool PetscBeganMPI;
604: PETSC_EXTERN PetscBool PetscInitializeCalled;
605: PETSC_EXTERN PetscBool PetscFinalizeCalled;
606: PETSC_EXTERN PetscBool PetscViennaCLSynchronize;
607: PETSC_EXTERN PetscBool PetscCUDASynchronize;

609: PETSC_EXTERN PetscErrorCode PetscSetHelpVersionFunctions(PetscErrorCode (*)(MPI_Comm),PetscErrorCode (*)(MPI_Comm));
610: PETSC_EXTERN PetscErrorCode PetscCommDuplicate(MPI_Comm,MPI_Comm*,int*);
611: PETSC_EXTERN PetscErrorCode PetscCommDestroy(MPI_Comm*);

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

616:    Synopsis:
617:     #include <petscsys.h>
618:    PetscErrorCode PetscMalloc(size_t m,void **result)

620:    Not Collective

622:    Input Parameter:
623: .  m - number of bytes to allocate

625:    Output Parameter:
626: .  result - memory allocated

628:    Level: beginner

630:    Notes:
631:    Memory is always allocated at least double aligned

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

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

637:   Concepts: memory allocation

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

642: /*MC
643:    PetscRealloc - Rellocates memory

645:    Synopsis:
646:     #include <petscsys.h>
647:    PetscErrorCode PetscRealloc(size_t m,void **result)

649:    Not Collective

651:    Input Parameters:
652: +  m - number of bytes to allocate
653: -  result - initial memory allocated

655:    Output Parameter:
656: .  result - new memory allocated

658:    Level: developer

660:    Notes:
661:    Memory is always allocated at least double aligned

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

665:   Concepts: memory allocation

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

670: /*MC
671:    PetscAddrAlign - Rounds up an address to PETSC_MEMALIGN alignment

673:    Synopsis:
674:     #include <petscsys.h>
675:    void *PetscAddrAlign(void *addr)

677:    Not Collective

679:    Input Parameters:
680: .  addr - address to align (any pointer type)

682:    Level: developer

684: .seealso: PetscMallocAlign()

686:   Concepts: memory allocation
687: M*/
688: #define PetscAddrAlign(a) (void*)((((PETSC_UINTPTR_T)(a))+(PETSC_MEMALIGN-1)) & ~(PETSC_MEMALIGN-1))

690: /*MC
691:    PetscMalloc1 - Allocates an array of memory aligned to PETSC_MEMALIGN

693:    Synopsis:
694:     #include <petscsys.h>
695:    PetscErrorCode PetscMalloc1(size_t m1,type **r1)

697:    Not Collective

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

702:    Output Parameter:
703: .  r1 - memory allocated in first chunk

705:    Note:
706:    This uses the sizeof() of the memory type requested to determine the total memory to be allocated, therefore you should not
707:          multiply the number of elements requested by the sizeof() the type. For example use
708: $  PetscInt *id;
709: $  PetscMalloc1(10,&id);
710:         not
711: $  PetscInt *id;
712: $  PetscMalloc1(10*sizeof(PetscInt),&id);

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

716:    Level: beginner

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

720:   Concepts: memory allocation

722: M*/
723: #define PetscMalloc1(m1,r1) PetscMallocA(1,PETSC_FALSE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1))

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

728:    Synopsis:
729:     #include <petscsys.h>
730:    PetscErrorCode PetscCalloc1(size_t m1,type **r1)

732:    Not Collective

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

737:    Output Parameter:
738: .  r1 - memory allocated in first chunk

740:    Notes:
741:    See PetsMalloc1() for more details on usage.

743:    Level: beginner

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

747:   Concepts: memory allocation

749: M*/
750: #define PetscCalloc1(m1,r1) PetscMallocA(1,PETSC_TRUE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1))

752: /*MC
753:    PetscMalloc2 - Allocates 2 arrays of memory both aligned to PETSC_MEMALIGN

755:    Synopsis:
756:     #include <petscsys.h>
757:    PetscErrorCode PetscMalloc2(size_t m1,type **r1,size_t m2,type **r2)

759:    Not Collective

761:    Input Parameter:
762: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
763: -  m2 - number of elements to allocate in 2nd chunk  (may be zero)

765:    Output Parameter:
766: +  r1 - memory allocated in first chunk
767: -  r2 - memory allocated in second chunk

769:    Level: developer

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

773:   Concepts: memory allocation

775: M*/
776: #define PetscMalloc2(m1,r1,m2,r2) PetscMallocA(2,PETSC_FALSE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2))

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

781:    Synopsis:
782:     #include <petscsys.h>
783:    PetscErrorCode PetscCalloc2(size_t m1,type **r1,size_t m2,type **r2)

785:    Not Collective

787:    Input Parameter:
788: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
789: -  m2 - number of elements to allocate in 2nd chunk  (may be zero)

791:    Output Parameter:
792: +  r1 - memory allocated in first chunk
793: -  r2 - memory allocated in second chunk

795:    Level: developer

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

799:   Concepts: memory allocation
800: M*/
801: #define PetscCalloc2(m1,r1,m2,r2) PetscMallocA(2,PETSC_TRUE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2))

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

806:    Synopsis:
807:     #include <petscsys.h>
808:    PetscErrorCode PetscMalloc3(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3)

810:    Not Collective

812:    Input Parameter:
813: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
814: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
815: -  m3 - number of elements to allocate in 3rd chunk  (may be zero)

817:    Output Parameter:
818: +  r1 - memory allocated in first chunk
819: .  r2 - memory allocated in second chunk
820: -  r3 - memory allocated in third chunk

822:    Level: developer

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

826:   Concepts: memory allocation

828: M*/
829: #define PetscMalloc3(m1,r1,m2,r2,m3,r3) PetscMallocA(3,PETSC_FALSE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3))

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

834:    Synopsis:
835:     #include <petscsys.h>
836:    PetscErrorCode PetscCalloc3(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3)

838:    Not Collective

840:    Input Parameter:
841: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
842: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
843: -  m3 - number of elements to allocate in 3rd chunk  (may be zero)

845:    Output Parameter:
846: +  r1 - memory allocated in first chunk
847: .  r2 - memory allocated in second chunk
848: -  r3 - memory allocated in third chunk

850:    Level: developer

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

854:   Concepts: memory allocation
855: M*/
856: #define PetscCalloc3(m1,r1,m2,r2,m3,r3) PetscMallocA(3,PETSC_TRUE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3))

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

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

865:    Not Collective

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

873:    Output Parameter:
874: +  r1 - memory allocated in first chunk
875: .  r2 - memory allocated in second chunk
876: .  r3 - memory allocated in third chunk
877: -  r4 - memory allocated in fourth chunk

879:    Level: developer

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

883:   Concepts: memory allocation

885: M*/
886: #define PetscMalloc4(m1,r1,m2,r2,m3,r3,m4,r4) PetscMallocA(4,PETSC_FALSE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3),(size_t)(m4)*sizeof(**(r4)),(r4))

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

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

895:    Not Collective

897:    Input Parameters:
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)

903:    Output Parameters:
904: +  r1 - memory allocated in first chunk
905: .  r2 - memory allocated in second chunk
906: .  r3 - memory allocated in third chunk
907: -  r4 - memory allocated in fourth chunk

909:    Level: developer

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

913:   Concepts: memory allocation

915: M*/
916: #define PetscCalloc4(m1,r1,m2,r2,m3,r3,m4,r4) PetscMallocA(4,PETSC_TRUE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3),(size_t)(m4)*sizeof(**(r4)),(r4))

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

921:    Synopsis:
922:     #include <petscsys.h>
923:    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)

925:    Not Collective

927:    Input Parameters:
928: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
929: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
930: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
931: .  m4 - number of elements to allocate in 4th chunk  (may be zero)
932: -  m5 - number of elements to allocate in 5th chunk  (may be zero)

934:    Output Parameters:
935: +  r1 - memory allocated in first chunk
936: .  r2 - memory allocated in second chunk
937: .  r3 - memory allocated in third chunk
938: .  r4 - memory allocated in fourth chunk
939: -  r5 - memory allocated in fifth chunk

941:    Level: developer

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

945:   Concepts: memory allocation

947: M*/
948: #define PetscMalloc5(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5) PetscMallocA(5,PETSC_FALSE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3),(size_t)(m4)*sizeof(**(r4)),(r4),(size_t)(m5)*sizeof(**(r5)),(r5))

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

953:    Synopsis:
954:     #include <petscsys.h>
955:    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)

957:    Not Collective

959:    Input Parameters:
960: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
961: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
962: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
963: .  m4 - number of elements to allocate in 4th chunk  (may be zero)
964: -  m5 - number of elements to allocate in 5th chunk  (may be zero)

966:    Output Parameters:
967: +  r1 - memory allocated in first chunk
968: .  r2 - memory allocated in second chunk
969: .  r3 - memory allocated in third chunk
970: .  r4 - memory allocated in fourth chunk
971: -  r5 - memory allocated in fifth chunk

973:    Level: developer

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

977:   Concepts: memory allocation

979: M*/
980: #define PetscCalloc5(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5) PetscMallocA(5,PETSC_TRUE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3),(size_t)(m4)*sizeof(**(r4)),(r4),(size_t)(m5)*sizeof(**(r5)),(r5))

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

985:    Synopsis:
986:     #include <petscsys.h>
987:    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)

989:    Not Collective

991:    Input Parameters:
992: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
993: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
994: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
995: .  m4 - number of elements to allocate in 4th chunk  (may be zero)
996: .  m5 - number of elements to allocate in 5th chunk  (may be zero)
997: -  m6 - number of elements to allocate in 6th chunk  (may be zero)

999:    Output Parameteasr:
1000: +  r1 - memory allocated in first chunk
1001: .  r2 - memory allocated in second chunk
1002: .  r3 - memory allocated in third chunk
1003: .  r4 - memory allocated in fourth chunk
1004: .  r5 - memory allocated in fifth chunk
1005: -  r6 - memory allocated in sixth chunk

1007:    Level: developer

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

1011:   Concepts: memory allocation

1013: M*/
1014: #define PetscMalloc6(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6) PetscMallocA(6,PETSC_FALSE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3),(size_t)(m4)*sizeof(**(r4)),(r4),(size_t)(m5)*sizeof(**(r5)),(r5),(size_t)(m6)*sizeof(**(r6)),(r6))

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

1019:    Synopsis:
1020:     #include <petscsys.h>
1021:    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)

1023:    Not Collective

1025:    Input Parameters:
1026: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
1027: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
1028: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
1029: .  m4 - number of elements to allocate in 4th chunk  (may be zero)
1030: .  m5 - number of elements to allocate in 5th chunk  (may be zero)
1031: -  m6 - number of elements to allocate in 6th chunk  (may be zero)

1033:    Output Parameters:
1034: +  r1 - memory allocated in first chunk
1035: .  r2 - memory allocated in second chunk
1036: .  r3 - memory allocated in third chunk
1037: .  r4 - memory allocated in fourth chunk
1038: .  r5 - memory allocated in fifth chunk
1039: -  r6 - memory allocated in sixth chunk

1041:    Level: developer

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

1045:   Concepts: memory allocation
1046: M*/
1047: #define PetscCalloc6(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6) PetscMallocA(6,PETSC_TRUE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3),(size_t)(m4)*sizeof(**(r4)),(r4),(size_t)(m5)*sizeof(**(r5)),(r5),(size_t)(m6)*sizeof(**(r6)),(r6))

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

1052:    Synopsis:
1053:     #include <petscsys.h>
1054:    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)

1056:    Not Collective

1058:    Input Parameters:
1059: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
1060: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
1061: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
1062: .  m4 - number of elements to allocate in 4th chunk  (may be zero)
1063: .  m5 - number of elements to allocate in 5th chunk  (may be zero)
1064: .  m6 - number of elements to allocate in 6th chunk  (may be zero)
1065: -  m7 - number of elements to allocate in 7th chunk  (may be zero)

1067:    Output Parameters:
1068: +  r1 - memory allocated in first chunk
1069: .  r2 - memory allocated in second chunk
1070: .  r3 - memory allocated in third chunk
1071: .  r4 - memory allocated in fourth chunk
1072: .  r5 - memory allocated in fifth chunk
1073: .  r6 - memory allocated in sixth chunk
1074: -  r7 - memory allocated in seventh chunk

1076:    Level: developer

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

1080:   Concepts: memory allocation

1082: M*/
1083: #define PetscMalloc7(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6,m7,r7) PetscMallocA(7,PETSC_FALSE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3),(size_t)(m4)*sizeof(**(r4)),(r4),(size_t)(m5)*sizeof(**(r5)),(r5),(size_t)(m6)*sizeof(**(r6)),(r6),(size_t)(m7)*sizeof(**(r7)),(r7))

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

1088:    Synopsis:
1089:     #include <petscsys.h>
1090:    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)

1092:    Not Collective

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

1103:    Output Parameters:
1104: +  r1 - memory allocated in first chunk
1105: .  r2 - memory allocated in second chunk
1106: .  r3 - memory allocated in third chunk
1107: .  r4 - memory allocated in fourth chunk
1108: .  r5 - memory allocated in fifth chunk
1109: .  r6 - memory allocated in sixth chunk
1110: -  r7 - memory allocated in seventh chunk

1112:    Level: developer

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

1116:   Concepts: memory allocation
1117: M*/
1118: #define PetscCalloc7(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6,m7,r7) PetscMallocA(7,PETSC_TRUE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3),(size_t)(m4)*sizeof(**(r4)),(r4),(size_t)(m5)*sizeof(**(r5)),(r5),(size_t)(m6)*sizeof(**(r6)),(r6),(size_t)(m7)*sizeof(**(r7)),(r7))

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

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

1127:    Not Collective

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

1132:    Level: beginner

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

1136:   Concepts: memory allocation

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

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

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

1149:    Not Collective

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

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

1157:    Level: developer

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

1161:   Concepts: memory allocation

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

1166: /*MC
1167:    PetscFree - Frees memory

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

1173:    Not Collective

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

1178:    Level: beginner

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

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

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

1187:   Concepts: memory allocation

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

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

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

1199:    Not Collective

1201:    Input Parameters:
1202: +   memory1 - memory to free
1203: -   memory2 - 2nd memory to free

1205:    Level: developer

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

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

1212:   Concepts: memory allocation

1214: M*/
1215: #define PetscFree2(m1,m2)   PetscFreeA(2,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2))

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

1220:    Synopsis:
1221:     #include <petscsys.h>
1222:    PetscErrorCode PetscFree3(void *memory1,void *memory2,void *memory3)

1224:    Not Collective

1226:    Input Parameters:
1227: +   memory1 - memory to free
1228: .   memory2 - 2nd memory to free
1229: -   memory3 - 3rd memory to free

1231:    Level: developer

1233:    Notes:
1234:     Memory must have been obtained with PetscMalloc3()

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

1238:   Concepts: memory allocation

1240: M*/
1241: #define PetscFree3(m1,m2,m3)   PetscFreeA(3,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3))

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

1246:    Synopsis:
1247:     #include <petscsys.h>
1248:    PetscErrorCode PetscFree4(void *m1,void *m2,void *m3,void *m4)

1250:    Not Collective

1252:    Input Parameters:
1253: +   m1 - memory to free
1254: .   m2 - 2nd memory to free
1255: .   m3 - 3rd memory to free
1256: -   m4 - 4th memory to free

1258:    Level: developer

1260:    Notes:
1261:     Memory must have been obtained with PetscMalloc4()

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

1265:   Concepts: memory allocation

1267: M*/
1268: #define PetscFree4(m1,m2,m3,m4)   PetscFreeA(4,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3),&(m4))

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

1273:    Synopsis:
1274:     #include <petscsys.h>
1275:    PetscErrorCode PetscFree5(void *m1,void *m2,void *m3,void *m4,void *m5)

1277:    Not Collective

1279:    Input Parameters:
1280: +   m1 - memory to free
1281: .   m2 - 2nd memory to free
1282: .   m3 - 3rd memory to free
1283: .   m4 - 4th memory to free
1284: -   m5 - 5th memory to free

1286:    Level: developer

1288:    Notes:
1289:     Memory must have been obtained with PetscMalloc5()

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

1293:   Concepts: memory allocation

1295: M*/
1296: #define PetscFree5(m1,m2,m3,m4,m5)   PetscFreeA(5,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3),&(m4),&(m5))

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

1301:    Synopsis:
1302:     #include <petscsys.h>
1303:    PetscErrorCode PetscFree6(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6)

1305:    Not Collective

1307:    Input Parameters:
1308: +   m1 - memory to free
1309: .   m2 - 2nd memory to free
1310: .   m3 - 3rd memory to free
1311: .   m4 - 4th memory to free
1312: .   m5 - 5th memory to free
1313: -   m6 - 6th memory to free


1316:    Level: developer

1318:    Notes:
1319:     Memory must have been obtained with PetscMalloc6()

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

1323:   Concepts: memory allocation

1325: M*/
1326: #define PetscFree6(m1,m2,m3,m4,m5,m6)   PetscFreeA(6,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3),&(m4),&(m5),&(m6))

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

1331:    Synopsis:
1332:     #include <petscsys.h>
1333:    PetscErrorCode PetscFree7(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6,void *m7)

1335:    Not Collective

1337:    Input Parameters:
1338: +   m1 - memory to free
1339: .   m2 - 2nd memory to free
1340: .   m3 - 3rd memory to free
1341: .   m4 - 4th memory to free
1342: .   m5 - 5th memory to free
1343: .   m6 - 6th memory to free
1344: -   m7 - 7th memory to free


1347:    Level: developer

1349:    Notes:
1350:     Memory must have been obtained with PetscMalloc7()

1352: .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6(),
1353:           PetscMalloc7()

1355:   Concepts: memory allocation

1357: M*/
1358: #define PetscFree7(m1,m2,m3,m4,m5,m6,m7)   PetscFreeA(7,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3),&(m4),&(m5),&(m6),&(m7))

1360: PETSC_EXTERN PetscErrorCode PetscMallocA(int,PetscBool,int,const char *,const char *,size_t,void *,...);
1361: PETSC_EXTERN PetscErrorCode PetscFreeA(int,int,const char *,const char *,void *,...);
1362: PETSC_EXTERN PetscErrorCode (*PetscTrMalloc)(size_t,int,const char[],const char[],void**);
1363: PETSC_EXTERN PetscErrorCode (*PetscTrFree)(void*,int,const char[],const char[]);
1364: PETSC_EXTERN PetscErrorCode (*PetscTrRealloc)(size_t,int,const char[],const char[],void**);
1365: PETSC_EXTERN PetscErrorCode PetscMallocSetCoalesce(PetscBool);
1366: PETSC_EXTERN PetscErrorCode PetscMallocSet(PetscErrorCode (*)(size_t,int,const char[],const char[],void**),PetscErrorCode (*)(void*,int,const char[],const char[]));
1367: PETSC_EXTERN PetscErrorCode PetscMallocClear(void);

1369: /*
1370:   Unlike PetscMallocSet and PetscMallocClear which overwrite the existing settings, these two functions save the previous choice of allocator, and should be used in pair.
1371: */
1372: PETSC_EXTERN PetscErrorCode PetscMallocSetDRAM(void);
1373: PETSC_EXTERN PetscErrorCode PetscMallocResetDRAM(void);

1375: /*
1376:     PetscLogDouble variables are used to contain double precision numbers
1377:   that are not used in the numerical computations, but rather in logging,
1378:   timing etc.
1379: */
1380: typedef double PetscLogDouble;
1381: #define MPIU_PETSCLOGDOUBLE MPI_DOUBLE

1383: /*
1384:    Routines for tracing memory corruption/bleeding with default PETSc memory allocation
1385: */
1386: PETSC_EXTERN PetscErrorCode PetscMallocDump(FILE *);
1387: PETSC_EXTERN PetscErrorCode PetscMallocDumpLog(FILE *);
1388: PETSC_EXTERN PetscErrorCode PetscMallocGetCurrentUsage(PetscLogDouble *);
1389: PETSC_EXTERN PetscErrorCode PetscMallocGetMaximumUsage(PetscLogDouble *);
1390: PETSC_EXTERN PetscErrorCode PetscMallocDebug(PetscBool);
1391: PETSC_EXTERN PetscErrorCode PetscMallocGetDebug(PetscBool*);
1392: PETSC_EXTERN PetscErrorCode PetscMallocValidate(int,const char[],const char[]);
1393: PETSC_EXTERN PetscErrorCode PetscMallocSetDumpLog(void);
1394: PETSC_EXTERN PetscErrorCode PetscMallocSetDumpLogThreshold(PetscLogDouble);
1395: PETSC_EXTERN PetscErrorCode PetscMallocGetDumpLog(PetscBool*);

1397: /*E
1398:     PetscDataType - Used for handling different basic data types.

1400:    Level: beginner

1402:    Notes:
1403:    Use of this should be avoided if one can directly use MPI_Datatype instead.

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

1408: .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscDataTypeToMPIDataType(),
1409:           PetscDataTypeGetSize()

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

1416: #if defined(PETSC_USE_COMPLEX)
1417: #define  PETSC_SCALAR  PETSC_COMPLEX
1418: #else
1419: #if defined(PETSC_USE_REAL_SINGLE)
1420: #define  PETSC_SCALAR  PETSC_FLOAT
1421: #elif defined(PETSC_USE_REAL___FLOAT128)
1422: #define  PETSC_SCALAR  PETSC___FLOAT128
1423: #elif defined(PETSC_USE_REAL___FP16)
1424: #define  PETSC_SCALAR  PETSC___FP16
1425: #else
1426: #define  PETSC_SCALAR  PETSC_DOUBLE
1427: #endif
1428: #endif
1429: #if defined(PETSC_USE_REAL_SINGLE)
1430: #define  PETSC_REAL  PETSC_FLOAT
1431: #elif defined(PETSC_USE_REAL___FLOAT128)
1432: #define  PETSC_REAL  PETSC___FLOAT128
1433: #elif defined(PETSC_USE_REAL___FP16)
1434: #define  PETSC_REAL  PETSC___FP16
1435: #else
1436: #define  PETSC_REAL  PETSC_DOUBLE
1437: #endif
1438: #define  PETSC_FORTRANADDR  PETSC_LONG

1440: PETSC_EXTERN PetscErrorCode PetscDataTypeToMPIDataType(PetscDataType,MPI_Datatype*);
1441: PETSC_EXTERN PetscErrorCode PetscMPIDataTypeToPetscDataType(MPI_Datatype,PetscDataType*);
1442: PETSC_EXTERN PetscErrorCode PetscDataTypeGetSize(PetscDataType,size_t*);
1443: PETSC_EXTERN PetscErrorCode PetscDataTypeFromString(const char*,PetscDataType*,PetscBool*);

1445: /*
1446:     Basic memory and string operations. These are usually simple wrappers
1447:    around the basic Unix system calls, but a few of them have additional
1448:    functionality and/or error checking.
1449: */
1450: PETSC_EXTERN PetscErrorCode PetscBitMemcpy(void*,PetscInt,const void*,PetscInt,PetscInt,PetscDataType);
1451: PETSC_EXTERN PetscErrorCode PetscMemmove(void*,void *,size_t);
1452: PETSC_EXTERN PetscErrorCode PetscMemcmp(const void*,const void*,size_t,PetscBool  *);
1453: PETSC_EXTERN PetscErrorCode PetscStrlen(const char[],size_t*);
1454: PETSC_EXTERN PetscErrorCode PetscStrToArray(const char[],char,int*,char ***);
1455: PETSC_EXTERN PetscErrorCode PetscStrToArrayDestroy(int,char **);
1456: PETSC_EXTERN PetscErrorCode PetscStrcmp(const char[],const char[],PetscBool  *);
1457: PETSC_EXTERN PetscErrorCode PetscStrgrt(const char[],const char[],PetscBool  *);
1458: PETSC_EXTERN PetscErrorCode PetscStrcasecmp(const char[],const char[],PetscBool *);
1459: PETSC_EXTERN PetscErrorCode PetscStrncmp(const char[],const char[],size_t,PetscBool *);
1460: PETSC_EXTERN PetscErrorCode PetscStrcpy(char[],const char[]);
1461: PETSC_EXTERN PetscErrorCode PetscStrcat(char[],const char[]);
1462: PETSC_EXTERN PetscErrorCode PetscStrlcat(char[],const char[],size_t);
1463: PETSC_EXTERN PetscErrorCode PetscStrncpy(char[],const char[],size_t);
1464: PETSC_EXTERN PetscErrorCode PetscStrchr(const char[],char,char *[]);
1465: PETSC_EXTERN PetscErrorCode PetscStrtolower(char[]);
1466: PETSC_EXTERN PetscErrorCode PetscStrtoupper(char[]);
1467: PETSC_EXTERN PetscErrorCode PetscStrrchr(const char[],char,char *[]);
1468: PETSC_EXTERN PetscErrorCode PetscStrstr(const char[],const char[],char *[]);
1469: PETSC_EXTERN PetscErrorCode PetscStrrstr(const char[],const char[],char *[]);
1470: PETSC_EXTERN PetscErrorCode PetscStrendswith(const char[],const char[],PetscBool*);
1471: PETSC_EXTERN PetscErrorCode PetscStrbeginswith(const char[],const char[],PetscBool*);
1472: PETSC_EXTERN PetscErrorCode PetscStrendswithwhich(const char[],const char *const*,PetscInt*);
1473: PETSC_EXTERN PetscErrorCode PetscStrallocpy(const char[],char *[]);
1474: PETSC_EXTERN PetscErrorCode PetscStrArrayallocpy(const char *const*,char***);
1475: PETSC_EXTERN PetscErrorCode PetscStrArrayDestroy(char***);
1476: PETSC_EXTERN PetscErrorCode PetscStrNArrayallocpy(PetscInt,const char *const*,char***);
1477: PETSC_EXTERN PetscErrorCode PetscStrNArrayDestroy(PetscInt,char***);
1478: PETSC_EXTERN PetscErrorCode PetscStrreplace(MPI_Comm,const char[],char[],size_t);

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

1482: /*S
1483:     PetscToken - 'Token' used for managing tokenizing strings

1485:   Level: intermediate

1487: .seealso: PetscTokenCreate(), PetscTokenFind(), PetscTokenDestroy()
1488: S*/
1489: typedef struct _p_PetscToken* PetscToken;

1491: PETSC_EXTERN PetscErrorCode PetscTokenCreate(const char[],const char,PetscToken*);
1492: PETSC_EXTERN PetscErrorCode PetscTokenFind(PetscToken,char *[]);
1493: PETSC_EXTERN PetscErrorCode PetscTokenDestroy(PetscToken*);
1494: PETSC_EXTERN PetscErrorCode PetscStrInList(const char[],const char[],char,PetscBool*);

1496: PETSC_EXTERN PetscErrorCode PetscEListFind(PetscInt,const char *const*,const char*,PetscInt*,PetscBool*);
1497: PETSC_EXTERN PetscErrorCode PetscEnumFind(const char *const*,const char*,PetscEnum*,PetscBool*);

1499: /*
1500:    These are MPI operations for MPI_Allreduce() etc
1501: */
1502: PETSC_EXTERN MPI_Op MPIU_MAXSUM_OP;
1503: #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
1504: PETSC_EXTERN MPI_Op MPIU_SUM;
1505: #else
1506: #define MPIU_SUM MPI_SUM
1507: #endif
1508: #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
1509: PETSC_EXTERN MPI_Op MPIU_MAX;
1510: PETSC_EXTERN MPI_Op MPIU_MIN;
1511: #else
1512: #define MPIU_MAX MPI_MAX
1513: #define MPIU_MIN MPI_MIN
1514: #endif
1515: PETSC_EXTERN PetscErrorCode PetscMaxSum(MPI_Comm,const PetscInt[],PetscInt*,PetscInt*);

1517: PETSC_EXTERN PetscErrorCode MPIULong_Send(void*,PetscInt,MPI_Datatype,PetscMPIInt,PetscMPIInt,MPI_Comm);
1518: PETSC_EXTERN PetscErrorCode MPIULong_Recv(void*,PetscInt,MPI_Datatype,PetscMPIInt,PetscMPIInt,MPI_Comm);

1520: /*S
1521:      PetscObject - any PETSc object, PetscViewer, Mat, Vec, KSP etc

1523:    Level: beginner

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

1528: .seealso:  PetscObjectDestroy(), PetscObjectView(), PetscObjectGetName(), PetscObjectSetName(), PetscObjectReference(), PetscObjectDereference()
1529: S*/
1530: typedef struct _p_PetscObject* PetscObject;

1532: /*MC
1533:     PetscObjectId - unique integer Id for a PetscObject

1535:     Level: developer

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

1540: .seealso: PetscObjectState, PetscObjectGetId()
1541: M*/
1542: #if defined(PETSC_USING_F90) && !defined(PETSC_USE_FORTRANKIND) /* compaq F90 */
1543: typedef int PetscObjectId;
1544: #else
1545: typedef PetscInt64 PetscObjectId;
1546: #endif

1548: /*MC
1549:     PetscObjectState - integer state for a PetscObject

1551:     Level: developer

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

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

1565: /*S
1566:      PetscFunctionList - Linked list of functions, possibly stored in dynamic libraries, accessed
1567:       by string name

1569:    Level: advanced

1571: .seealso:  PetscFunctionListAdd(), PetscFunctionListDestroy(), PetscOpFlist
1572: S*/
1573: typedef struct _n_PetscFunctionList *PetscFunctionList;

1575: /*E
1576:   PetscFileMode - Access mode for a file.

1578:   Level: beginner

1580: $  FILE_MODE_READ - open a file at its beginning for reading
1581: $  FILE_MODE_WRITE - open a file at its beginning for writing (will create if the file does not exist)
1582: $  FILE_MODE_APPEND - open a file at end for writing
1583: $  FILE_MODE_UPDATE - open a file for updating, meaning for reading and writing
1584: $  FILE_MODE_APPEND_UPDATE - open a file for updating, meaning for reading and writing, at the end

1586: .seealso: PetscViewerFileSetMode()
1587: E*/
1588: typedef enum {FILE_MODE_READ, FILE_MODE_WRITE, FILE_MODE_APPEND, FILE_MODE_UPDATE, FILE_MODE_APPEND_UPDATE} PetscFileMode;
1589: PETSC_EXTERN const char *const PetscFileModes[];

1591: /*
1592:     Defines PETSc error handling.
1593: */
1594:  #include <petscerror.h>

1596: #define PETSC_SMALLEST_CLASSID  1211211
1597: PETSC_EXTERN PetscClassId PETSC_LARGEST_CLASSID;
1598: PETSC_EXTERN PetscClassId PETSC_OBJECT_CLASSID;
1599: PETSC_EXTERN PetscErrorCode PetscClassIdRegister(const char[],PetscClassId *);

1601: /*
1602:    Routines that get memory usage information from the OS
1603: */
1604: PETSC_EXTERN PetscErrorCode PetscMemoryGetCurrentUsage(PetscLogDouble *);
1605: PETSC_EXTERN PetscErrorCode PetscMemoryGetMaximumUsage(PetscLogDouble *);
1606: PETSC_EXTERN PetscErrorCode PetscMemorySetGetMaximumUsage(void);
1607: PETSC_EXTERN PetscErrorCode PetscMemoryTrace(const char[]);

1609: PETSC_EXTERN PetscErrorCode PetscInfoAllow(PetscBool ,const char []);
1610: PETSC_EXTERN PetscErrorCode PetscSleep(PetscReal);

1612: /*
1613:    Initialization of PETSc
1614: */
1615: PETSC_EXTERN PetscErrorCode PetscInitialize(int*,char***,const char[],const char[]);
1616: PETSC_EXTERN PetscErrorCode PetscInitializeNoPointers(int,char**,const char[],const char[]);
1617: PETSC_EXTERN PetscErrorCode PetscInitializeNoArguments(void);
1618: PETSC_EXTERN PetscErrorCode PetscInitialized(PetscBool *);
1619: PETSC_EXTERN PetscErrorCode PetscFinalized(PetscBool *);
1620: PETSC_EXTERN PetscErrorCode PetscFinalize(void);
1621: PETSC_EXTERN PetscErrorCode PetscInitializeFortran(void);
1622: PETSC_EXTERN PetscErrorCode PetscGetArgs(int*,char ***);
1623: PETSC_EXTERN PetscErrorCode PetscGetArguments(char ***);
1624: PETSC_EXTERN PetscErrorCode PetscFreeArguments(char **);

1626: PETSC_EXTERN PetscErrorCode PetscEnd(void);
1627: PETSC_EXTERN PetscErrorCode PetscSysInitializePackage(void);

1629: PETSC_EXTERN PetscErrorCode PetscPythonInitialize(const char[],const char[]);
1630: PETSC_EXTERN PetscErrorCode PetscPythonFinalize(void);
1631: PETSC_EXTERN PetscErrorCode PetscPythonPrintError(void);
1632: PETSC_EXTERN PetscErrorCode PetscPythonMonitorSet(PetscObject,const char[]);

1634: /*
1635:      These are so that in extern C code we can caste function pointers to non-extern C
1636:    function pointers. Since the regular C++ code expects its function pointers to be C++
1637: */
1638: PETSC_EXTERN_TYPEDEF typedef void (**PetscVoidStarFunction)(void);
1639: PETSC_EXTERN_TYPEDEF typedef void (*PetscVoidFunction)(void);
1640: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*PetscErrorCodeFunction)(void);

1642: /*
1643:     Functions that can act on any PETSc object.
1644: */
1645: PETSC_EXTERN PetscErrorCode PetscObjectDestroy(PetscObject*);
1646: PETSC_EXTERN PetscErrorCode PetscObjectGetComm(PetscObject,MPI_Comm *);
1647: PETSC_EXTERN PetscErrorCode PetscObjectGetClassId(PetscObject,PetscClassId *);
1648: PETSC_EXTERN PetscErrorCode PetscObjectGetClassName(PetscObject,const char *[]);
1649: PETSC_EXTERN PetscErrorCode PetscObjectSetType(PetscObject,const char []);
1650: PETSC_EXTERN PetscErrorCode PetscObjectGetType(PetscObject,const char *[]);
1651: PETSC_EXTERN PetscErrorCode PetscObjectSetName(PetscObject,const char[]);
1652: PETSC_EXTERN PetscErrorCode PetscObjectGetName(PetscObject,const char*[]);
1653: PETSC_EXTERN PetscErrorCode PetscObjectSetTabLevel(PetscObject,PetscInt);
1654: PETSC_EXTERN PetscErrorCode PetscObjectGetTabLevel(PetscObject,PetscInt*);
1655: PETSC_EXTERN PetscErrorCode PetscObjectIncrementTabLevel(PetscObject,PetscObject,PetscInt);
1656: PETSC_EXTERN PetscErrorCode PetscObjectReference(PetscObject);
1657: PETSC_EXTERN PetscErrorCode PetscObjectGetReference(PetscObject,PetscInt*);
1658: PETSC_EXTERN PetscErrorCode PetscObjectDereference(PetscObject);
1659: PETSC_EXTERN PetscErrorCode PetscObjectGetNewTag(PetscObject,PetscMPIInt *);
1660: PETSC_EXTERN PetscErrorCode PetscObjectCompose(PetscObject,const char[],PetscObject);
1661: PETSC_EXTERN PetscErrorCode PetscObjectRemoveReference(PetscObject,const char[]);
1662: PETSC_EXTERN PetscErrorCode PetscObjectQuery(PetscObject,const char[],PetscObject *);
1663: PETSC_EXTERN PetscErrorCode PetscObjectComposeFunction_Private(PetscObject,const char[],void (*)(void));
1664: #define PetscObjectComposeFunction(a,b,d) PetscObjectComposeFunction_Private(a,b,(PetscVoidFunction)(d))
1665: PETSC_EXTERN PetscErrorCode PetscObjectSetFromOptions(PetscObject);
1666: PETSC_EXTERN PetscErrorCode PetscObjectSetUp(PetscObject);
1667: PETSC_EXTERN PetscErrorCode PetscObjectSetPrintedOptions(PetscObject);
1668: PETSC_EXTERN PetscErrorCode PetscObjectInheritPrintedOptions(PetscObject,PetscObject);
1669: PETSC_EXTERN PetscErrorCode PetscCommGetNewTag(MPI_Comm,PetscMPIInt *);

1671:  #include <petscviewertypes.h>
1672:  #include <petscoptions.h>

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

1676: PETSC_EXTERN PetscErrorCode PetscMemoryShowUsage(PetscViewer,const char[]);
1677: PETSC_EXTERN PetscErrorCode PetscMemoryView(PetscViewer,const char[]);
1678: PETSC_EXTERN PetscErrorCode PetscObjectPrintClassNamePrefixType(PetscObject,PetscViewer);
1679: PETSC_EXTERN PetscErrorCode PetscObjectView(PetscObject,PetscViewer);
1680: #define PetscObjectQueryFunction(obj,name,fptr) PetscObjectQueryFunction_Private((obj),(name),(PetscVoidFunction*)(fptr))
1681: PETSC_EXTERN PetscErrorCode PetscObjectQueryFunction_Private(PetscObject,const char[],void (**)(void));
1682: PETSC_EXTERN PetscErrorCode PetscObjectSetOptionsPrefix(PetscObject,const char[]);
1683: PETSC_EXTERN PetscErrorCode PetscObjectAppendOptionsPrefix(PetscObject,const char[]);
1684: PETSC_EXTERN PetscErrorCode PetscObjectPrependOptionsPrefix(PetscObject,const char[]);
1685: PETSC_EXTERN PetscErrorCode PetscObjectGetOptionsPrefix(PetscObject,const char*[]);
1686: PETSC_EXTERN PetscErrorCode PetscObjectChangeTypeName(PetscObject,const char[]);
1687: PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroy(PetscObject);
1688: PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroyAll(void);
1689: PETSC_EXTERN PetscErrorCode PetscObjectViewFromOptions(PetscObject,PetscObject,const char[]);
1690: PETSC_EXTERN PetscErrorCode PetscObjectName(PetscObject);
1691: PETSC_EXTERN PetscErrorCode PetscObjectTypeCompare(PetscObject,const char[],PetscBool *);
1692: PETSC_EXTERN PetscErrorCode PetscObjectBaseTypeCompare(PetscObject,const char[],PetscBool *);
1693: PETSC_EXTERN PetscErrorCode PetscObjectTypeCompareAny(PetscObject,PetscBool*,const char[],...);
1694: PETSC_EXTERN PetscErrorCode PetscRegisterFinalize(PetscErrorCode (*)(void));
1695: PETSC_EXTERN PetscErrorCode PetscRegisterFinalizeAll(void);

1697: #if defined(PETSC_HAVE_SAWS)
1698: PETSC_EXTERN PetscErrorCode PetscSAWsBlock(void);
1699: PETSC_EXTERN PetscErrorCode PetscObjectSAWsViewOff(PetscObject);
1700: PETSC_EXTERN PetscErrorCode PetscObjectSAWsSetBlock(PetscObject,PetscBool);
1701: PETSC_EXTERN PetscErrorCode PetscObjectSAWsBlock(PetscObject);
1702: PETSC_EXTERN PetscErrorCode PetscObjectSAWsGrantAccess(PetscObject);
1703: PETSC_EXTERN PetscErrorCode PetscObjectSAWsTakeAccess(PetscObject);
1704: PETSC_EXTERN void           PetscStackSAWsGrantAccess(void);
1705: PETSC_EXTERN void           PetscStackSAWsTakeAccess(void);
1706: PETSC_EXTERN PetscErrorCode PetscStackViewSAWs(void);
1707: PETSC_EXTERN PetscErrorCode PetscStackSAWsViewOff(void);

1709: #else
1710: #define PetscSAWsBlock()                        0
1711: #define PetscObjectSAWsViewOff(obj)             0
1712: #define PetscObjectSAWsSetBlock(obj,flg)        0
1713: #define PetscObjectSAWsBlock(obj)               0
1714: #define PetscObjectSAWsGrantAccess(obj)         0
1715: #define PetscObjectSAWsTakeAccess(obj)          0
1716: #define PetscStackViewSAWs()                    0
1717: #define PetscStackSAWsViewOff()                 0
1718: #define PetscStackSAWsTakeAccess()
1719: #define PetscStackSAWsGrantAccess()

1721: #endif

1723: typedef void* PetscDLHandle;
1724: typedef enum {PETSC_DL_DECIDE=0,PETSC_DL_NOW=1,PETSC_DL_LOCAL=2} PetscDLMode;
1725: PETSC_EXTERN PetscErrorCode PetscDLOpen(const char[],PetscDLMode,PetscDLHandle *);
1726: PETSC_EXTERN PetscErrorCode PetscDLClose(PetscDLHandle *);
1727: PETSC_EXTERN PetscErrorCode PetscDLSym(PetscDLHandle,const char[],void **);

1729: #if defined(PETSC_USE_DEBUG)
1730: PETSC_EXTERN PetscErrorCode PetscMallocGetStack(void*,PetscStack**);
1731: #endif
1732: PETSC_EXTERN PetscErrorCode PetscObjectsDump(FILE*,PetscBool);

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

1737:    Level: developer

1739:    Notes:
1740:    Used by PetscObjectCompose() and PetscObjectQuery()

1742: .seealso:  PetscObjectListAdd(), PetscObjectListDestroy(), PetscObjectListFind(), PetscObjectCompose(), PetscObjectQuery(), PetscFunctionList
1743: S*/
1744: typedef struct _n_PetscObjectList *PetscObjectList;

1746: PETSC_EXTERN PetscErrorCode PetscObjectListDestroy(PetscObjectList*);
1747: PETSC_EXTERN PetscErrorCode PetscObjectListFind(PetscObjectList,const char[],PetscObject*);
1748: PETSC_EXTERN PetscErrorCode PetscObjectListReverseFind(PetscObjectList,PetscObject,char**,PetscBool*);
1749: PETSC_EXTERN PetscErrorCode PetscObjectListAdd(PetscObjectList *,const char[],PetscObject);
1750: PETSC_EXTERN PetscErrorCode PetscObjectListRemoveReference(PetscObjectList *,const char[]);
1751: PETSC_EXTERN PetscErrorCode PetscObjectListDuplicate(PetscObjectList,PetscObjectList *);

1753: /*
1754:     Dynamic library lists. Lists of names of routines in objects or in dynamic
1755:   link libraries that will be loaded as needed.
1756: */

1758: #define PetscFunctionListAdd(list,name,fptr) PetscFunctionListAdd_Private((list),(name),(PetscVoidFunction)(fptr))
1759: PETSC_EXTERN PetscErrorCode PetscFunctionListAdd_Private(PetscFunctionList*,const char[],void (*)(void));
1760: PETSC_EXTERN PetscErrorCode PetscFunctionListDestroy(PetscFunctionList*);
1761: #define PetscFunctionListFind(list,name,fptr) PetscFunctionListFind_Private((list),(name),(PetscVoidFunction*)(fptr))
1762: PETSC_EXTERN PetscErrorCode PetscFunctionListFind_Private(PetscFunctionList,const char[],void (**)(void));
1763: PETSC_EXTERN PetscErrorCode PetscFunctionListPrintTypes(MPI_Comm,FILE*,const char[],const char[],const char[],const char[],PetscFunctionList,const char[]);
1764: PETSC_EXTERN PetscErrorCode PetscFunctionListDuplicate(PetscFunctionList,PetscFunctionList *);
1765: PETSC_EXTERN PetscErrorCode PetscFunctionListView(PetscFunctionList,PetscViewer);
1766: PETSC_EXTERN PetscErrorCode PetscFunctionListGet(PetscFunctionList,const char ***,int*);

1768: /*S
1769:      PetscDLLibrary - Linked list of dynamics libraries to search for functions

1771:    Level: advanced

1773: .seealso:  PetscDLLibraryOpen()
1774: S*/
1775: typedef struct _n_PetscDLLibrary *PetscDLLibrary;
1776: PETSC_EXTERN PetscDLLibrary  PetscDLLibrariesLoaded;
1777: PETSC_EXTERN PetscErrorCode PetscDLLibraryAppend(MPI_Comm,PetscDLLibrary *,const char[]);
1778: PETSC_EXTERN PetscErrorCode PetscDLLibraryPrepend(MPI_Comm,PetscDLLibrary *,const char[]);
1779: PETSC_EXTERN PetscErrorCode PetscDLLibrarySym(MPI_Comm,PetscDLLibrary *,const char[],const char[],void **);
1780: PETSC_EXTERN PetscErrorCode PetscDLLibraryPrintPath(PetscDLLibrary);
1781: PETSC_EXTERN PetscErrorCode PetscDLLibraryRetrieve(MPI_Comm,const char[],char *,size_t,PetscBool  *);
1782: PETSC_EXTERN PetscErrorCode PetscDLLibraryOpen(MPI_Comm,const char[],PetscDLLibrary *);
1783: PETSC_EXTERN PetscErrorCode PetscDLLibraryClose(PetscDLLibrary);

1785: /*
1786:      Useful utility routines
1787: */
1788: PETSC_EXTERN PetscErrorCode PetscSplitOwnership(MPI_Comm,PetscInt*,PetscInt*);
1789: PETSC_EXTERN PetscErrorCode PetscSplitOwnershipBlock(MPI_Comm,PetscInt,PetscInt*,PetscInt*);
1790: PETSC_EXTERN PetscErrorCode PetscSequentialPhaseBegin(MPI_Comm,PetscMPIInt);
1791: PETSC_EXTERN PetscErrorCode PetscSequentialPhaseEnd(MPI_Comm,PetscMPIInt);
1792: PETSC_EXTERN PetscErrorCode PetscBarrier(PetscObject);
1793: PETSC_EXTERN PetscErrorCode PetscMPIDump(FILE*);
1794: PETSC_EXTERN PetscErrorCode PetscGlobalMinMaxInt(MPI_Comm,PetscInt[],PetscInt[]);
1795: PETSC_EXTERN PetscErrorCode PetscGlobalMinMaxReal(MPI_Comm,PetscReal[],PetscReal[]);

1797: /*
1798:     PetscNot - negates a logical type value and returns result as a PetscBool

1800:     Notes:
1801:     This is useful in cases like
1802: $     int        *a;
1803: $     PetscBool  flag = PetscNot(a)
1804:      where !a would not return a PetscBool because we cannot provide a cast from int to PetscBool in C.
1805: */
1806: #define PetscNot(a) ((a) ? PETSC_FALSE : PETSC_TRUE)

1808: /*MC
1809:     PetscHelpPrintf - Prints help messages.

1811:    Synopsis:
1812:     #include <petscsys.h>
1813:      PetscErrorCode (*PetscHelpPrintf)(const char format[],...);

1815:     Not Collective

1817:     Input Parameters:
1818: .   format - the usual printf() format string

1820:    Level: developer

1822:     Fortran Note:
1823:     This routine is not supported in Fortran.

1825:     Concepts: help messages^printing
1826:     Concepts: printing^help messages

1828: .seealso: PetscFPrintf(), PetscSynchronizedPrintf(), PetscErrorPrintf()
1829: M*/
1830: PETSC_EXTERN PetscErrorCode (*PetscHelpPrintf)(MPI_Comm,const char[],...);

1832: /*
1833:      Defines PETSc profiling.
1834: */
1835:  #include <petsclog.h>

1837: /*
1838:       Simple PETSc parallel IO for ASCII printing
1839: */
1840: PETSC_EXTERN PetscErrorCode PetscFixFilename(const char[],char[]);
1841: PETSC_EXTERN PetscErrorCode PetscFOpen(MPI_Comm,const char[],const char[],FILE**);
1842: PETSC_EXTERN PetscErrorCode PetscFClose(MPI_Comm,FILE*);
1843: PETSC_EXTERN PetscErrorCode PetscFPrintf(MPI_Comm,FILE*,const char[],...);
1844: PETSC_EXTERN PetscErrorCode PetscPrintf(MPI_Comm,const char[],...);
1845: PETSC_EXTERN PetscErrorCode PetscSNPrintf(char*,size_t,const char [],...);
1846: PETSC_EXTERN PetscErrorCode PetscSNPrintfCount(char*,size_t,const char [],size_t*,...);
1847: PETSC_EXTERN PetscErrorCode PetscFormatRealArray(char[],size_t,const char*,PetscInt,const PetscReal[]);

1849: PETSC_EXTERN PetscErrorCode PetscErrorPrintfDefault(const char [],...);
1850: PETSC_EXTERN PetscErrorCode PetscErrorPrintfNone(const char [],...);
1851: PETSC_EXTERN PetscErrorCode PetscHelpPrintfDefault(MPI_Comm,const char [],...);

1853: PETSC_EXTERN PetscErrorCode PetscFormatConvertGetSize(const char*,size_t*);
1854: PETSC_EXTERN PetscErrorCode PetscFormatConvert(const char*,char *);

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

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

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

1873:    Level: advanced

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

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

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

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

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

1910:    Not Collective

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

1916:    Output Parameter:
1917: .  a - pointer to copy space

1919:    Level: intermediate

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

1929:    Note:
1930:    This routine is analogous to memcpy().

1932:    Not available from Fortran

1934:    Developer Note: this is inlined for fastest performance

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

1939: .seealso: PetscMemmove(), PetscStrallocpy()

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:    Not available from Fortran

2001:    Developer Note: this is inlined for fastest performance

2003:    Concepts: memory^zeroing
2004:    Concepts: zeroing^memory

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

2038: /*MC
2039:    PetscPrefetchBlock - Prefetches a block of memory

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

2045:    Not Collective

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

2053:    Level: developer

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

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

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

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

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

2084: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTCRL)
2085: #define PETSC_USE_FORTRAN_KERNEL_MULTCRL
2086: #endif

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

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

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

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

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

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

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

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

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

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

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

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

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

2140: #endif

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

2157: /* --------------------------------------------------------------------*/

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

2163:    Level: beginner

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

2167: .seealso: PETSC_COMM_WORLD, PETSC_COMM_SELF
2168: M*/

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

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

2178:    Level: beginner

2180: .seealso: PetscReal, PetscComplex, PetscInt, MPIU_REAL, MPIU_SCALAR, MPIU_COMPLEX, MPIU_INT, PetscRealPart(), PetscImaginaryPart()
2181: M*/

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

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

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

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

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

2198:    Level: beginner

2200: .seealso: PetscReal, PetscScalar, PetscComplex, PetscInt, MPIU_REAL, MPIU_SCALAR, MPIU_COMPLEX, MPIU_INT, PETSC_i
2201: M*/

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


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

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

2213:    Level: beginner

2215: .seealso: PetscScalar, PetscComplex, PetscInt, MPIU_REAL, MPIU_SCALAR, MPIU_COMPLEX, MPIU_INT
2216: M*/

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

2221:    Notes:
2222:    In MPI calls that require an MPI datatype that matches a PetscScalar or array of PetscScalar values, pass this value.

2224:    Level: beginner

2226: .seealso: PetscReal, PetscScalar, PetscComplex, PetscInt, MPIU_REAL, MPIU_COMPLEX, MPIU_INT
2227: M*/

2229: /*MC
2230:    MPIU_COMPLEX - MPI datatype corresponding to PetscComplex

2232:    Notes:
2233:    In MPI calls that require an MPI datatype that matches a PetscComplex or array of PetscComplex values, pass this value.

2235:    Level: beginner

2237: .seealso: PetscReal, PetscScalar, PetscComplex, PetscInt, MPIU_REAL, MPIU_SCALAR, MPIU_COMPLEX, MPIU_INT, PETSC_i
2238: M*/

2240: /*MC
2241:    MPIU_REAL - MPI datatype corresponding to PetscReal

2243:    Notes:
2244:    In MPI calls that require an MPI datatype that matches a PetscReal or array of PetscReal values, pass this value.

2246:    Level: beginner

2248: .seealso: PetscReal, PetscScalar, PetscComplex, PetscInt, MPIU_SCALAR, MPIU_COMPLEX, MPIU_INT
2249: M*/

2251: #if defined(PETSC_HAVE_MPIIO)
2252: #if !defined(PETSC_WORDS_BIGENDIAN)
2253: PETSC_EXTERN PetscErrorCode MPIU_File_write_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*);
2254: PETSC_EXTERN PetscErrorCode MPIU_File_read_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*);
2255: #else
2256: #define MPIU_File_write_all(a,b,c,d,e) MPI_File_write_all(a,b,c,d,e)
2257: #define MPIU_File_read_all(a,b,c,d,e) MPI_File_read_all(a,b,c,d,e)
2258: #endif
2259: #endif

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

2263: /* Limit MPI to 32-bits */
2264: #define PETSC_MPI_INT_MAX  2147483647
2265: #define PETSC_MPI_INT_MIN -2147483647
2266: /* Limit BLAS to 32-bits */
2267: #define PETSC_BLAS_INT_MAX  2147483647
2268: #define PETSC_BLAS_INT_MIN -2147483647

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

2274:    Not Collective

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

2279:    Output Parameter:
2280: .     b - the resulting PetscBLASInt value

2282:    Level: advanced

2284:    Not available from Fortran

2286: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscMPIIntCast()
2287: @*/
2288: PETSC_STATIC_INLINE PetscErrorCode PetscBLASIntCast(PetscInt a,PetscBLASInt *b)
2289: {
2291:   *b =  (PetscBLASInt)(a);
2292: #if defined(PETSC_USE_64BIT_INDICES) && !defined(PETSC_HAVE_64BIT_BLAS_INDICES)
2293:   if ((a) > PETSC_BLAS_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array too long for BLAS/LAPACK");
2294: #endif
2295:   return(0);
2296: }

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

2302:    Not Collective

2304:    Input Parameter:
2305: .     a - the PetscInt value

2307:    Output Parameter:
2308: .     b - the resulting PetscMPIInt value

2310:    Level: advanced

2312:    Not available from Fortran

2314: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast()
2315: @*/
2316: PETSC_STATIC_INLINE PetscErrorCode PetscMPIIntCast(PetscInt a,PetscMPIInt *b)
2317: {
2319:   *b =  (PetscMPIInt)(a);
2320: #if defined(PETSC_USE_64BIT_INDICES)
2321:   if ((a) > PETSC_MPI_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array too long for MPI");
2322: #endif
2323:   return(0);
2324: }

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

2328: /*@C

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

2332:    Not Collective

2334:    Input Parameter:
2335: +     a - the PetscReal value
2336: -     b - the second value

2338:    Returns:
2339:       the result as a PetscInt value

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

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

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

2350:    Not available from Fortran

2352:    Level: advanced

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

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

2365: /*@C

2367:    PetscIntMultTruncate - Computes the product 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:    Not available from Fortran

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

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

2388:    Level: advanced

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

2396:   r  =  PetscInt64Mult(a,b);
2397:   if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100;
2398:   return (PetscInt) r;
2399: }

2401: /*@C

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

2405:    Not Collective

2407:    Input Parameter:
2408: +     a - the PetscInt value
2409: -     b - the second value

2411:    Returns:
2412:      the result as a PetscInt value

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

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

2420:    Not available from Fortran

2422:    Level: advanced

2424: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult()
2425: @*/
2426: PETSC_STATIC_INLINE PetscInt PetscIntSumTruncate(PetscInt a,PetscInt b)
2427: {
2428:   PetscInt64 r;

2430:   r  =  ((PetscInt64)a) + ((PetscInt64)b);
2431:   if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100;
2432:   return (PetscInt) r;
2433: }

2435: /*@C

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

2439:    Not Collective

2441:    Input Parameter:
2442: +     a - the PetscInt value
2443: -     b - the second value

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

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

2451:    Not available from Fortran

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

2455:    Level: advanced

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

2464:   r  =  PetscInt64Mult(a,b);
2465: #if !defined(PETSC_USE_64BIT_INDICES)
2466:   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);
2467: #endif
2468:   if (result) *result = (PetscInt) r;
2469:   return(0);
2470: }

2472: /*@C

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

2476:    Not Collective

2478:    Input Parameter:
2479: +     a - the PetscInt value
2480: -     b - the second value

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

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

2488:    Not available from Fortran

2490:    Level: advanced

2492: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult()
2493: @*/
2494: PETSC_STATIC_INLINE PetscErrorCode PetscIntSumError(PetscInt a,PetscInt b,PetscInt *result)
2495: {
2496:   PetscInt64 r;

2499:   r  =  ((PetscInt64)a) + ((PetscInt64)b);
2500: #if !defined(PETSC_USE_64BIT_INDICES)
2501:   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);
2502: #endif
2503:   if (result) *result = (PetscInt) r;
2504:   return(0);
2505: }

2507: /*
2508:      The IBM include files define hz, here we hide it so that it may be used as a regular user variable.
2509: */
2510: #if defined(hz)
2511: #undef hz
2512: #endif

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


2517: #if defined(PETSC_HAVE_LIMITS_H)
2518: #include <limits.h>
2519: #endif
2520: #if defined(PETSC_HAVE_SYS_PARAM_H)
2521: #include <sys/param.h>
2522: #endif
2523: #if defined(PETSC_HAVE_SYS_TYPES_H)
2524: #include <sys/types.h>
2525: #endif
2526: #if defined(MAXPATHLEN)
2527: #  define PETSC_MAX_PATH_LEN     MAXPATHLEN
2528: #elif defined(MAX_PATH)
2529: #  define PETSC_MAX_PATH_LEN     MAX_PATH
2530: #elif defined(_MAX_PATH)
2531: #  define PETSC_MAX_PATH_LEN     _MAX_PATH
2532: #else
2533: #  define PETSC_MAX_PATH_LEN     4096
2534: #endif

2536: /*MC

2538:     PETSC_VERSION - This manual page provides information about how PETSc documents and uses its version information. This information is available to both C/C++
2539:                     and Fortran compilers when petscsys.h is included.


2542:     The current PETSc version and the API for accessing it are defined in petscversion.h

2544:     The complete version number is given as the triple  PETSC_VERSION_MAJOR.PETSC_VERSION_MINOR.PETSC_VERSION_SUBMINOR (in short hand x.y.z)

2546:     A change in the minor version number (y) indicates possible/likely changes in the PETSc API. Note this is different than with the semantic versioning convention
2547:     where only a change in the major version number (x) indicates a change in the API.

2549:     A subminor greater than zero indicates a patch release. Version x.y.z maintains source and binary compatibility with version x.y.w for all z and w

2551:     Use the macros PETSC_VERSION_EQ(x,y,z), PETSC_VERSION_LT(x,y,z), PETSC_VERSION_LE(x,y,z), PETSC_VERSION_GT(x,y,z),
2552:     PETSC_VERSION_GE(x,y,z) to determine if the current version is equal to, less than, less than or equal to, greater than or greater than or equal to a given
2553:     version number (x.y.z).

2555:     PETSC_RELEASE_DATE is the date the x.y version was released (i.e. the version before any patch releases)

2557:     PETSC_VERSION_DATE is the date the x.y.z version was released

2559:     PETSC_VERSION_GIT is the last git commit to the repository given in the form vx.y.z-wwwww

2561:     PETSC_VERSION_DATE_GIT is the date of the last git commit to the repository

2563:     Level: intermediate

2565:     PETSC_VERSION_() and PETSC_VERSION_PATCH are deprecated and will eventually be removed. For several releases PETSC_VERSION_PATCH is always 0

2567: M*/

2569: /*MC

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

2574: $
2575: $#include "petsc/finclude/petscXXX.h"
2576: $         use petscXXX

2578:      You can declare PETSc variables using either of the following.

2580: $    XXX variablename
2581: $    type(tXXX) variablename

2583:     For example,

2585: $#include "petsc/finclude/petscvec.h"
2586: $         use petscvec
2587: $
2588: $    Vec b
2589: $    type(tVec) x

2591:     Level: beginner

2593: M*/

2595: PETSC_EXTERN PetscErrorCode PetscGetArchType(char[],size_t);
2596: PETSC_EXTERN PetscErrorCode PetscGetHostName(char[],size_t);
2597: PETSC_EXTERN PetscErrorCode PetscGetUserName(char[],size_t);
2598: PETSC_EXTERN PetscErrorCode PetscGetProgramName(char[],size_t);
2599: PETSC_EXTERN PetscErrorCode PetscSetProgramName(const char[]);
2600: PETSC_EXTERN PetscErrorCode PetscGetDate(char[],size_t);
2601: PETSC_EXTERN PetscErrorCode PetscGetVersion(char[], size_t);
2602: PETSC_EXTERN PetscErrorCode PetscGetVersionNumber(PetscInt*,PetscInt*,PetscInt*,PetscInt*);

2604: PETSC_EXTERN PetscErrorCode PetscSortInt(PetscInt,PetscInt[]);
2605: PETSC_EXTERN PetscErrorCode PetscSortedRemoveDupsInt(PetscInt*,PetscInt[]);
2606: PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsInt(PetscInt*,PetscInt[]);
2607: PETSC_EXTERN PetscErrorCode PetscFindInt(PetscInt, PetscInt, const PetscInt[], PetscInt*);
2608: PETSC_EXTERN PetscErrorCode PetscFindMPIInt(PetscMPIInt, PetscInt, const PetscMPIInt[], PetscInt*);
2609: PETSC_EXTERN PetscErrorCode PetscSortIntWithPermutation(PetscInt,const PetscInt[],PetscInt[]);
2610: PETSC_EXTERN PetscErrorCode PetscSortStrWithPermutation(PetscInt,const char*[],PetscInt[]);
2611: PETSC_EXTERN PetscErrorCode PetscSortIntWithArray(PetscInt,PetscInt[],PetscInt[]);
2612: PETSC_EXTERN PetscErrorCode PetscSortIntWithArrayPair(PetscInt,PetscInt[],PetscInt[],PetscInt[]);
2613: PETSC_EXTERN PetscErrorCode PetscSortMPIInt(PetscInt,PetscMPIInt[]);
2614: PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsMPIInt(PetscInt*,PetscMPIInt[]);
2615: PETSC_EXTERN PetscErrorCode PetscSortMPIIntWithArray(PetscMPIInt,PetscMPIInt[],PetscMPIInt[]);
2616: PETSC_EXTERN PetscErrorCode PetscSortIntWithScalarArray(PetscInt,PetscInt[],PetscScalar[]);
2617: PETSC_EXTERN PetscErrorCode PetscSortIntWithDataArray(PetscInt,PetscInt[],void*,size_t,void*);
2618: PETSC_EXTERN PetscErrorCode PetscSortReal(PetscInt,PetscReal[]);
2619: PETSC_EXTERN PetscErrorCode PetscSortRealWithArrayInt(PetscInt,PetscReal[],PetscInt[]);
2620: PETSC_EXTERN PetscErrorCode PetscSortRealWithPermutation(PetscInt,const PetscReal[],PetscInt[]);
2621: PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsReal(PetscInt*,PetscReal[]);
2622: PETSC_EXTERN PetscErrorCode PetscFindReal(PetscReal,PetscInt,const PetscReal[],PetscReal,PetscInt*);
2623: PETSC_EXTERN PetscErrorCode PetscSortSplit(PetscInt,PetscInt,PetscScalar[],PetscInt[]);
2624: PETSC_EXTERN PetscErrorCode PetscSortSplitReal(PetscInt,PetscInt,PetscReal[],PetscInt[]);
2625: PETSC_EXTERN PetscErrorCode PetscProcessTree(PetscInt,const PetscBool [],const PetscInt[],PetscInt*,PetscInt**,PetscInt**,PetscInt**,PetscInt**);
2626: PETSC_EXTERN PetscErrorCode PetscMergeIntArrayPair(PetscInt,const PetscInt[],const PetscInt[],PetscInt,const PetscInt[],const PetscInt[],PetscInt*,PetscInt**,PetscInt**);
2627: PETSC_EXTERN PetscErrorCode PetscMergeIntArray(PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscInt*,PetscInt**);
2628: PETSC_EXTERN PetscErrorCode PetscMergeMPIIntArray(PetscInt,const PetscMPIInt[],PetscInt,const PetscMPIInt[],PetscInt*,PetscMPIInt**);

2630: PETSC_EXTERN PetscErrorCode PetscSetDisplay(void);
2631: PETSC_EXTERN PetscErrorCode PetscGetDisplay(char[],size_t);

2633: /*J
2634:     PetscRandomType - String with the name of a PETSc randomizer

2636:    Level: beginner

2638:    Notes:
2639:    To use SPRNG or RANDOM123 you must have ./configure PETSc
2640:    with the option --download-sprng or --download-random123

2642: .seealso: PetscRandomSetType(), PetscRandom, PetscRandomCreate()
2643: J*/
2644: typedef const char* PetscRandomType;
2645: #define PETSCRAND       "rand"
2646: #define PETSCRAND48     "rand48"
2647: #define PETSCSPRNG      "sprng"
2648: #define PETSCRANDER48   "rander48"
2649: #define PETSCRANDOM123  "random123"

2651: /* Logging support */
2652: PETSC_EXTERN PetscClassId PETSC_RANDOM_CLASSID;

2654: PETSC_EXTERN PetscErrorCode PetscRandomInitializePackage(void);

2656: /*S
2657:      PetscRandom - Abstract PETSc object that manages generating random numbers

2659:    Level: intermediate

2661:   Concepts: random numbers

2663: .seealso:  PetscRandomCreate(), PetscRandomGetValue(), PetscRandomType
2664: S*/
2665: typedef struct _p_PetscRandom*   PetscRandom;

2667: /* Dynamic creation and loading functions */
2668: PETSC_EXTERN PetscFunctionList PetscRandomList;

2670: PETSC_EXTERN PetscErrorCode PetscRandomRegister(const char[],PetscErrorCode (*)(PetscRandom));
2671: PETSC_EXTERN PetscErrorCode PetscRandomSetType(PetscRandom, PetscRandomType);
2672: PETSC_EXTERN PetscErrorCode PetscRandomSetFromOptions(PetscRandom);
2673: PETSC_EXTERN PetscErrorCode PetscRandomGetType(PetscRandom, PetscRandomType*);
2674: PETSC_STATIC_INLINE PetscErrorCode PetscRandomViewFromOptions(PetscRandom A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
2675: PETSC_EXTERN PetscErrorCode PetscRandomView(PetscRandom,PetscViewer);

2677: PETSC_EXTERN PetscErrorCode PetscRandomCreate(MPI_Comm,PetscRandom*);
2678: PETSC_EXTERN PetscErrorCode PetscRandomGetValue(PetscRandom,PetscScalar*);
2679: PETSC_EXTERN PetscErrorCode PetscRandomGetValueReal(PetscRandom,PetscReal*);
2680: PETSC_EXTERN PetscErrorCode PetscRandomGetInterval(PetscRandom,PetscScalar*,PetscScalar*);
2681: PETSC_EXTERN PetscErrorCode PetscRandomSetInterval(PetscRandom,PetscScalar,PetscScalar);
2682: PETSC_EXTERN PetscErrorCode PetscRandomSetSeed(PetscRandom,unsigned long);
2683: PETSC_EXTERN PetscErrorCode PetscRandomGetSeed(PetscRandom,unsigned long *);
2684: PETSC_EXTERN PetscErrorCode PetscRandomSeed(PetscRandom);
2685: PETSC_EXTERN PetscErrorCode PetscRandomDestroy(PetscRandom*);

2687: PETSC_EXTERN PetscErrorCode PetscGetFullPath(const char[],char[],size_t);
2688: PETSC_EXTERN PetscErrorCode PetscGetRelativePath(const char[],char[],size_t);
2689: PETSC_EXTERN PetscErrorCode PetscGetWorkingDirectory(char[],size_t);
2690: PETSC_EXTERN PetscErrorCode PetscGetRealPath(const char[],char[]);
2691: PETSC_EXTERN PetscErrorCode PetscGetHomeDirectory(char[],size_t);
2692: PETSC_EXTERN PetscErrorCode PetscTestFile(const char[],char,PetscBool *);
2693: PETSC_EXTERN PetscErrorCode PetscTestDirectory(const char[],char,PetscBool *);
2694: PETSC_EXTERN PetscErrorCode PetscMkdir(const char[]);
2695: PETSC_EXTERN PetscErrorCode PetscRMTree(const char[]);

2697: PETSC_EXTERN PetscErrorCode PetscBinaryRead(int,void*,PetscInt,PetscDataType);
2698: PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedRead(MPI_Comm,int,void*,PetscInt,PetscDataType);
2699: PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedWrite(MPI_Comm,int,void*,PetscInt,PetscDataType,PetscBool );
2700: PETSC_EXTERN PetscErrorCode PetscBinaryWrite(int,void*,PetscInt,PetscDataType,PetscBool );
2701: PETSC_EXTERN PetscErrorCode PetscBinaryOpen(const char[],PetscFileMode,int *);
2702: PETSC_EXTERN PetscErrorCode PetscBinaryClose(int);
2703: PETSC_EXTERN PetscErrorCode PetscSharedTmp(MPI_Comm,PetscBool  *);
2704: PETSC_EXTERN PetscErrorCode PetscSharedWorkingDirectory(MPI_Comm,PetscBool  *);
2705: PETSC_EXTERN PetscErrorCode PetscGetTmp(MPI_Comm,char[],size_t);
2706: PETSC_EXTERN PetscErrorCode PetscFileRetrieve(MPI_Comm,const char[],char[],size_t,PetscBool *);
2707: PETSC_EXTERN PetscErrorCode PetscLs(MPI_Comm,const char[],char[],size_t,PetscBool *);
2708: #if defined(PETSC_USE_SOCKET_VIEWER)
2709: PETSC_EXTERN PetscErrorCode PetscOpenSocket(const char[],int,int*);
2710: #endif

2712: /*
2713:    In binary files variables are stored using the following lengths,
2714:   regardless of how they are stored in memory on any one particular
2715:   machine. Use these rather then sizeof() in computing sizes for
2716:   PetscBinarySeek().
2717: */
2718: #define PETSC_BINARY_INT_SIZE   (32/8)
2719: #define PETSC_BINARY_FLOAT_SIZE  (32/8)
2720: #define PETSC_BINARY_CHAR_SIZE  (8/8)
2721: #define PETSC_BINARY_SHORT_SIZE  (16/8)
2722: #define PETSC_BINARY_DOUBLE_SIZE  (64/8)
2723: #define PETSC_BINARY_SCALAR_SIZE  sizeof(PetscScalar)

2725: /*E
2726:   PetscBinarySeekType - argument to PetscBinarySeek()

2728:   Level: advanced

2730: .seealso: PetscBinarySeek(), PetscBinarySynchronizedSeek()
2731: E*/
2732: typedef enum {PETSC_BINARY_SEEK_SET = 0,PETSC_BINARY_SEEK_CUR = 1,PETSC_BINARY_SEEK_END = 2} PetscBinarySeekType;
2733: PETSC_EXTERN PetscErrorCode PetscBinarySeek(int,off_t,PetscBinarySeekType,off_t*);
2734: PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedSeek(MPI_Comm,int,off_t,PetscBinarySeekType,off_t*);
2735: PETSC_EXTERN PetscErrorCode PetscByteSwap(void *,PetscDataType,PetscInt);

2737: PETSC_EXTERN PetscErrorCode PetscSetDebugTerminal(const char[]);
2738: PETSC_EXTERN PetscErrorCode PetscSetDebugger(const char[],PetscBool );
2739: PETSC_EXTERN PetscErrorCode PetscSetDefaultDebugger(void);
2740: PETSC_EXTERN PetscErrorCode PetscSetDebuggerFromString(const char*);
2741: PETSC_EXTERN PetscErrorCode PetscAttachDebugger(void);
2742: PETSC_EXTERN PetscErrorCode PetscStopForDebugger(void);

2744: PETSC_EXTERN PetscErrorCode PetscGatherNumberOfMessages(MPI_Comm,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt*);
2745: PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**);
2746: PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths2(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**,PetscMPIInt**);
2747: PETSC_EXTERN PetscErrorCode PetscPostIrecvInt(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscInt***,MPI_Request**);
2748: PETSC_EXTERN PetscErrorCode PetscPostIrecvScalar(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscScalar***,MPI_Request**);
2749: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSided(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt*,const void*,PetscMPIInt*,PetscMPIInt**,void*)
2750:   PetscAttrMPIPointerWithType(6,3);
2751: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedF(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt[],const void*,PetscMPIInt*,PetscMPIInt**,void*,PetscMPIInt,
2752:                                                     PetscErrorCode (*send)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,PetscMPIInt,void*,MPI_Request[],void*),
2753:                                                     PetscErrorCode (*recv)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,void*,MPI_Request[],void*),void *ctx)
2754:   PetscAttrMPIPointerWithType(6,3);
2755: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedFReq(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt[],const void*,PetscMPIInt*,PetscMPIInt**,void*,PetscMPIInt,
2756:                                                        MPI_Request**,MPI_Request**,
2757:                                                        PetscErrorCode (*send)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,PetscMPIInt,void*,MPI_Request[],void*),
2758:                                                        PetscErrorCode (*recv)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,void*,MPI_Request[],void*),void *ctx)
2759:   PetscAttrMPIPointerWithType(6,3);

2761: /*E
2762:     PetscBuildTwoSidedType - algorithm for setting up two-sided communication

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

2772:    Level: developer

2774: .seealso: PetscCommBuildTwoSided(), PetscCommBuildTwoSidedSetType(), PetscCommBuildTwoSidedGetType()
2775: E*/
2776: typedef enum {
2777:   PETSC_BUILDTWOSIDED_NOTSET = -1,
2778:   PETSC_BUILDTWOSIDED_ALLREDUCE = 0,
2779:   PETSC_BUILDTWOSIDED_IBARRIER = 1,
2780:   PETSC_BUILDTWOSIDED_REDSCATTER = 2
2781:   /* Updates here must be accompanied by updates in finclude/petscsys.h and the string array in mpits.c */
2782: } PetscBuildTwoSidedType;
2783: PETSC_EXTERN const char *const PetscBuildTwoSidedTypes[];
2784: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedSetType(MPI_Comm,PetscBuildTwoSidedType);
2785: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedGetType(MPI_Comm,PetscBuildTwoSidedType*);

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

2789: /*E
2790:   InsertMode - Whether entries are inserted or added into vectors or matrices

2792:   Level: beginner

2794: .seealso: VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(),
2795:           VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(),
2796:           MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd()
2797: E*/
2798:  typedef enum {NOT_SET_VALUES, INSERT_VALUES, ADD_VALUES, MAX_VALUES, INSERT_ALL_VALUES, ADD_ALL_VALUES, INSERT_BC_VALUES, ADD_BC_VALUES} InsertMode;

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

2803:     Level: beginner

2805: .seealso: InsertMode, VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(),
2806:           VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), ADD_VALUES,
2807:           MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd(), MAX_VALUES

2809: M*/

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

2815:     Level: beginner

2817: .seealso: InsertMode, VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(),
2818:           VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), INSERT_VALUES,
2819:           MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd(), MAX_VALUES

2821: M*/

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

2826:     Level: beginner

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

2830: M*/

2832: PETSC_EXTERN MPI_Comm PetscObjectComm(PetscObject);

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

2837: /*S
2838:    PetscSubcomm - A decomposition of an MPI communicator into subcommunicators

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

2845:    Sample Usage:
2846:        PetscSubcommCreate()
2847:        PetscSubcommSetNumber()
2848:        PetscSubcommSetType(PETSC_SUBCOMM_INTERLACED);
2849:        ccomm = PetscSubcommChild()
2850:        PetscSubcommDestroy()

2852:    Level: advanced

2854:    Concepts: communicator, create

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

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

2865:    Developer Notes:
2866:    This is used in objects such as PCREDUNDANT to manage the subcommunicators on which the redundant computations
2867:       are performed.


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

2872: S*/
2873: typedef struct _n_PetscSubcomm* PetscSubcomm;

2875: struct _n_PetscSubcomm {
2876:   MPI_Comm         parent;           /* parent communicator */
2877:   MPI_Comm         dupparent;        /* duplicate parent communicator, under which the processors of this subcomm have contiguous rank */
2878:   MPI_Comm         child;            /* the sub-communicator */
2879:   PetscMPIInt      n;                /* num of subcommunicators under the parent communicator */
2880:   PetscMPIInt      color;            /* color of processors belong to this communicator */
2881:   PetscMPIInt      *subsize;         /* size of subcommunicator[color] */
2882:   PetscSubcommType type;
2883:   char             *subcommprefix;
2884: };

2886: PETSC_STATIC_INLINE MPI_Comm PetscSubcommParent(PetscSubcomm scomm) {return scomm->parent;}
2887: PETSC_STATIC_INLINE MPI_Comm PetscSubcommChild(PetscSubcomm scomm) {return scomm->child;}
2888: PETSC_STATIC_INLINE MPI_Comm PetscSubcommContiguousParent(PetscSubcomm scomm) {return scomm->dupparent;}
2889: PETSC_EXTERN PetscErrorCode PetscSubcommCreate(MPI_Comm,PetscSubcomm*);
2890: PETSC_EXTERN PetscErrorCode PetscSubcommDestroy(PetscSubcomm*);
2891: PETSC_EXTERN PetscErrorCode PetscSubcommSetNumber(PetscSubcomm,PetscInt);
2892: PETSC_EXTERN PetscErrorCode PetscSubcommSetType(PetscSubcomm,PetscSubcommType);
2893: PETSC_EXTERN PetscErrorCode PetscSubcommSetTypeGeneral(PetscSubcomm,PetscMPIInt,PetscMPIInt);
2894: PETSC_EXTERN PetscErrorCode PetscSubcommView(PetscSubcomm,PetscViewer);
2895: PETSC_EXTERN PetscErrorCode PetscSubcommSetFromOptions(PetscSubcomm);
2896: PETSC_EXTERN PetscErrorCode PetscSubcommSetOptionsPrefix(PetscSubcomm,const char[]);

2898: /*S
2899:      PetscHeap - A simple class for managing heaps

2901:    Level: intermediate

2903:   Concepts: random numbers

2905: .seealso:  PetscHeapCreate(), PetscHeapAdd(), PetscHeapPop(), PetscHeapPeek(), PetscHeapStash(), PetscHeapUnstash(), PetscHeapView(), PetscHeapDestroy()
2906: S*/
2907: typedef struct _PetscHeap *PetscHeap;

2909: PETSC_EXTERN PetscErrorCode PetscHeapCreate(PetscInt,PetscHeap*);
2910: PETSC_EXTERN PetscErrorCode PetscHeapAdd(PetscHeap,PetscInt,PetscInt);
2911: PETSC_EXTERN PetscErrorCode PetscHeapPop(PetscHeap,PetscInt*,PetscInt*);
2912: PETSC_EXTERN PetscErrorCode PetscHeapPeek(PetscHeap,PetscInt*,PetscInt*);
2913: PETSC_EXTERN PetscErrorCode PetscHeapStash(PetscHeap,PetscInt,PetscInt);
2914: PETSC_EXTERN PetscErrorCode PetscHeapUnstash(PetscHeap);
2915: PETSC_EXTERN PetscErrorCode PetscHeapDestroy(PetscHeap*);
2916: PETSC_EXTERN PetscErrorCode PetscHeapView(PetscHeap,PetscViewer);

2918: PETSC_EXTERN PetscErrorCode PetscProcessPlacementView(PetscViewer);
2919: typedef struct _n_PetscShmComm* PetscShmComm;
2920: PETSC_EXTERN PetscErrorCode PetscShmCommGet(MPI_Comm,PetscShmComm*);
2921: PETSC_EXTERN PetscErrorCode PetscShmCommGlobalToLocal(PetscShmComm,PetscMPIInt,PetscMPIInt*);
2922: PETSC_EXTERN PetscErrorCode PetscShmCommLocalToGlobal(PetscShmComm,PetscMPIInt,PetscMPIInt*);
2923: PETSC_EXTERN PetscErrorCode PetscShmCommGetMpiShmComm(PetscShmComm,MPI_Comm*);

2925: /* routines to better support OpenMP multithreading needs of some PETSc third party libraries */
2926: typedef struct _n_PetscOmpCtrl* PetscOmpCtrl;
2927: PETSC_EXTERN PetscErrorCode PetscOmpCtrlCreate(MPI_Comm,PetscInt,PetscOmpCtrl*);
2928: PETSC_EXTERN PetscErrorCode PetscOmpCtrlGetOmpComms(PetscOmpCtrl,MPI_Comm*,MPI_Comm*,PetscBool*);
2929: PETSC_EXTERN PetscErrorCode PetscOmpCtrlDestroy(PetscOmpCtrl*);
2930: PETSC_EXTERN PetscErrorCode PetscOmpCtrlBarrier(PetscOmpCtrl);
2931: PETSC_EXTERN PetscErrorCode PetscOmpCtrlOmpRegionOnMasterBegin(PetscOmpCtrl);
2932: PETSC_EXTERN PetscErrorCode PetscOmpCtrlOmpRegionOnMasterEnd(PetscOmpCtrl);

2934: /*S
2935:    PetscSegBuffer - a segmented extendable buffer

2937:    Level: developer

2939: .seealso: PetscSegBufferCreate(), PetscSegBufferGet(), PetscSegBufferExtract(), PetscSegBufferDestroy()
2940: S*/
2941: typedef struct _n_PetscSegBuffer *PetscSegBuffer;
2942: PETSC_EXTERN PetscErrorCode PetscSegBufferCreate(size_t,size_t,PetscSegBuffer*);
2943: PETSC_EXTERN PetscErrorCode PetscSegBufferDestroy(PetscSegBuffer*);
2944: PETSC_EXTERN PetscErrorCode PetscSegBufferGet(PetscSegBuffer,size_t,void*);
2945: PETSC_EXTERN PetscErrorCode PetscSegBufferExtractAlloc(PetscSegBuffer,void*);
2946: PETSC_EXTERN PetscErrorCode PetscSegBufferExtractTo(PetscSegBuffer,void*);
2947: PETSC_EXTERN PetscErrorCode PetscSegBufferExtractInPlace(PetscSegBuffer,void*);
2948: PETSC_EXTERN PetscErrorCode PetscSegBufferGetSize(PetscSegBuffer,size_t*);
2949: PETSC_EXTERN PetscErrorCode PetscSegBufferUnuse(PetscSegBuffer,size_t);


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

2957: typedef struct _n_PetscOptionsHelpPrinted *PetscOptionsHelpPrinted;
2958: extern PetscOptionsHelpPrinted PetscOptionsHelpPrintedSingleton;
2959: PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedDestroy(PetscOptionsHelpPrinted*);
2960: PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedCreate(PetscOptionsHelpPrinted*);
2961: PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedCheck(PetscOptionsHelpPrinted,const char*,const char*,PetscBool*);

2963: #include <stdarg.h>
2964: PETSC_EXTERN PetscErrorCode PetscVSNPrintf(char*,size_t,const char[],size_t*,va_list);
2965: PETSC_EXTERN PetscErrorCode (*PetscVFPrintf)(FILE*,const char[],va_list);

2967: PETSC_EXTERN PetscSegBuffer PetscCitationsList;

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

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

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

2978:    Level: intermediate

2980:    Not available from Fortran

2982:      Options Database:
2983: .     -citations [filename]   - print out the bibtex entries for the given computation
2984: @*/
2985: PETSC_STATIC_INLINE PetscErrorCode PetscCitationsRegister(const char cit[],PetscBool *set)
2986: {
2987:   size_t         len;
2988:   char           *vstring;

2992:   if (set && *set) return(0);
2993:   PetscStrlen(cit,&len);
2994:   PetscSegBufferGet(PetscCitationsList,len,&vstring);
2995:   PetscMemcpy(vstring,cit,len);
2996:   if (set) *set = PETSC_TRUE;
2997:   return(0);
2998: }

3000: PETSC_EXTERN PetscErrorCode PetscURLShorten(const char[],char[],size_t);
3001: PETSC_EXTERN PetscErrorCode PetscGoogleDriveAuthorize(MPI_Comm,char[],char[],size_t);
3002: PETSC_EXTERN PetscErrorCode PetscGoogleDriveRefresh(MPI_Comm,const char[],char[],size_t);
3003: PETSC_EXTERN PetscErrorCode PetscGoogleDriveUpload(MPI_Comm,const char[],const char []);

3005: PETSC_EXTERN PetscErrorCode PetscBoxAuthorize(MPI_Comm,char[],char[],size_t);
3006: PETSC_EXTERN PetscErrorCode PetscBoxRefresh(MPI_Comm,const char[],char[],char[],size_t);

3008: PETSC_EXTERN PetscErrorCode PetscGlobusGetTransfers(MPI_Comm,const char[],char[],size_t);

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

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


3017: #if defined(PETSC_USE_DEBUG)
3018: /*
3019:    Verify that all processes in the communicator have called this from the same line of code
3020:  */
3021: PETSC_EXTERN PetscErrorCode PetscAllreduceBarrierCheck(MPI_Comm,PetscMPIInt,int,const char*,const char *);

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

3028:    Collective on MPI_Comm

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

3034:    Input Parameters:
3035: +  indata - pointer to the input data to be reduced
3036: .  count - the number of MPI data items in indata and outdata
3037: .  datatype - the MPI datatype, for example MPI_INT
3038: .  op - the MPI operation, for example MPI_SUM
3039: -  comm - the MPI communicator on which the operation occurs

3041:    Output Parameter:
3042: .  outdata - the reduced values

3044:    Notes:
3045:    In optimized mode this directly calls MPI_Allreduce()

3047:    Level: developer

3049: .seealso: MPI_Allreduce()
3050: M*/
3051: #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))
3052: #else
3053: #define MPIU_Allreduce(a,b,c,d,e,fcomm) MPI_Allreduce(a,b,c,d,e,fcomm)
3054: #endif

3056: #if defined(PETSC_HAVE_MPI_WIN_CREATE_FEATURE)
3057: PETSC_EXTERN PetscErrorCode MPIU_Win_allocate_shared(MPI_Aint,PetscMPIInt,MPI_Info,MPI_Comm,void*,MPI_Win*);
3058: PETSC_EXTERN PetscErrorCode MPIU_Win_shared_query(MPI_Win,PetscMPIInt,MPI_Aint*,PetscMPIInt*,void*);
3059: #endif

3061: /*
3062:     Returned from PETSc functions that are called from MPI, such as related to attributes
3063: */
3064: PETSC_EXTERN PetscMPIInt PETSC_MPI_ERROR_CLASS;
3065: PETSC_EXTERN PetscMPIInt PETSC_MPI_ERROR_CODE;

3067: #endif