Actual source code: petscsys.h
petsc-3.8.1 2017-11-04
1: /*
2: This is the main PETSc include file (for C and C++). It is included by all
3: other PETSc include files, so it almost never has to be specifically included.
4: */
7: /* ========================================================================== */
8: /*
9: petscconf.h is contained in ${PETSC_ARCH}/include/petscconf.h it is
10: found automatically by the compiler due to the -I${PETSC_DIR}/${PETSC_ARCH}/include.
11: For --prefix installs the ${PETSC_ARCH}/ does not exist and petscconf.h is in the same
12: directory as the other PETSc include files.
13: */
14: #include <petscconf.h>
15: #include <petscfix.h>
17: #if defined(PETSC_DESIRE_FEATURE_TEST_MACROS)
18: /*
19: Feature test macros must be included before headers defined by IEEE Std 1003.1-2001
20: We only turn these in PETSc source files that require them by setting PETSC_DESIRE_FEATURE_TEST_MACROS
21: */
22: #if defined(PETSC__POSIX_C_SOURCE_200112L) && !defined(_POSIX_C_SOURCE)
23: #define _POSIX_C_SOURCE 200112L
24: #endif
25: #if defined(PETSC__BSD_SOURCE) && !defined(_BSD_SOURCE)
26: #define _BSD_SOURCE
27: #endif
28: #if defined(PETSC__DEFAULT_SOURCE) && !defined(_DEFAULT_SOURCE)
29: #define _DEFAULT_SOURCE
30: #endif
31: #if defined(PETSC__GNU_SOURCE) && !defined(_GNU_SOURCE)
32: #define _GNU_SOURCE
33: #endif
34: #endif
36: /* ========================================================================== */
37: /*
38: This facilitates using the C version of PETSc from C++ and the C++ version from C.
39: */
40: #if defined(__cplusplus)
41: # define PETSC_FUNCTION_NAME PETSC_FUNCTION_NAME_CXX
42: #else
43: # define PETSC_FUNCTION_NAME PETSC_FUNCTION_NAME_C
44: #endif
46: /* ========================================================================== */
47: /*
48: Since PETSc manages its own extern "C" handling users should never include PETSc include
49: files within extern "C". This will generate a compiler error if a user does put the include
50: file within an extern "C".
51: */
52: #if defined(__cplusplus)
53: void assert_never_put_petsc_headers_inside_an_extern_c(int); void assert_never_put_petsc_headers_inside_an_extern_c(double);
54: #endif
56: #if defined(__cplusplus)
57: # define PETSC_RESTRICT PETSC_CXX_RESTRICT
58: #else
59: # define PETSC_RESTRICT PETSC_C_RESTRICT
60: #endif
62: #if defined(__cplusplus)
63: # define PETSC_STATIC_INLINE PETSC_CXX_STATIC_INLINE
64: #else
65: # define PETSC_STATIC_INLINE PETSC_C_STATIC_INLINE
66: #endif
68: #if defined(_WIN32) && defined(PETSC_USE_SHARED_LIBRARIES) /* For Win32 shared libraries */
69: # define __declspec(dllexport)
70: # define PETSC_DLLIMPORT __declspec(dllimport)
71: # define PETSC_VISIBILITY_INTERNAL
72: #elif defined(PETSC_USE_VISIBILITY_CXX) && defined(__cplusplus)
73: # define __attribute__((visibility ("default")))
74: # define PETSC_DLLIMPORT __attribute__((visibility ("default")))
75: # define PETSC_VISIBILITY_INTERNAL __attribute__((visibility ("hidden")))
76: #elif defined(PETSC_USE_VISIBILITY_C) && !defined(__cplusplus)
77: # define __attribute__((visibility ("default")))
78: # define PETSC_DLLIMPORT __attribute__((visibility ("default")))
79: # define PETSC_VISIBILITY_INTERNAL __attribute__((visibility ("hidden")))
80: #else
81: # define
82: # define PETSC_DLLIMPORT
83: # define PETSC_VISIBILITY_INTERNAL
84: #endif
86: #if defined(petsc_EXPORTS) /* CMake defines this when building the shared library */
87: # define PETSC_VISIBILITY_PUBLIC
88: #else /* Win32 users need this to import symbols from petsc.dll */
89: # define PETSC_VISIBILITY_PUBLIC PETSC_DLLIMPORT
90: #endif
92: /*
93: Functions tagged with PETSC_EXTERN in the header files are
94: always defined as extern "C" when compiled with C++ so they may be
95: used from C and are always visible in the shared libraries
96: */
97: #if defined(__cplusplus)
98: #define PETSC_EXTERN extern "C" PETSC_VISIBILITY_PUBLIC
99: #define PETSC_EXTERN_TYPEDEF extern "C"
100: #define PETSC_INTERN extern "C" PETSC_VISIBILITY_INTERNAL
101: #else
102: #define PETSC_EXTERN extern PETSC_VISIBILITY_PUBLIC
103: #define PETSC_EXTERN_TYPEDEF
104: #define PETSC_INTERN extern PETSC_VISIBILITY_INTERNAL
105: #endif
107: #include <petscversion.h>
108: #define PETSC_AUTHOR_INFO " The PETSc Team\n petsc-maint@mcs.anl.gov\n http://www.mcs.anl.gov/petsc/\n"
110: /* ========================================================================== */
112: /*
113: Defines the interface to MPI allowing the use of all MPI functions.
115: PETSc does not use the C++ binding of MPI at ALL. The following flag
116: makes sure the C++ bindings are not included. The C++ bindings REQUIRE
117: putting mpi.h before ANY C++ include files, we cannot control this
118: with all PETSc users. Users who want to use the MPI C++ bindings can include
119: mpicxx.h directly in their code
120: */
121: #if !defined(MPICH_SKIP_MPICXX)
122: # define MPICH_SKIP_MPICXX 1
123: #endif
124: #if !defined(OMPI_SKIP_MPICXX)
125: # define OMPI_SKIP_MPICXX 1
126: #endif
127: #if !defined(OMPI_WANT_MPI_INTERFACE_WARNING)
128: # define OMPI_WANT_MPI_INTERFACE_WARNING 0
129: #endif
130: #include <mpi.h>
132: /*
133: Perform various sanity checks that the correct mpi.h is being included at compile time.
134: This usually happens because
135: * either an unexpected mpi.h is in the default compiler path (i.e. in /usr/include) or
136: * an extra include path -I/something (which contains the unexpected mpi.h) is being passed to the compiler
137: */
138: #if defined(PETSC_HAVE_MPIUNI)
139: # if !defined(__MPIUNI_H)
140: # error "PETSc was configured with --with-mpi=0 but now appears to be compiling using a different mpi.h"
141: # endif
142: #elif defined(PETSC_HAVE_I_MPI_NUMVERSION)
143: # if !defined(I_MPI_NUMVERSION)
144: # error "PETSc was configured with I_MPI but now appears to be compiling using a non-I_MPI mpi.h"
145: # elif I_MPI_NUMVERSION != PETSC_HAVE_I_MPI_NUMVERSION
146: # 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"
147: # endif
148: #elif defined(PETSC_HAVE_MVAPICH2_NUMVERSION)
149: # if !defined(MVAPICH2_NUMVERSION)
150: # error "PETSc was configured with MVAPICH2 but now appears to be compiling using a non-MVAPICH2 mpi.h"
151: # elif MVAPICH2_NUMVERSION != PETSC_HAVE_MVAPICH2_NUMVERSION
152: # error "PETSc was configured with one MVAPICH2 mpi.h version but now appears to be compiling using a different MVAPICH2 mpi.h version"
153: # endif
154: #elif defined(PETSC_HAVE_MPICH_NUMVERSION)
155: # if !defined(MPICH_NUMVERSION) || defined(MVAPICH2_NUMVERSION) || defined(I_MPI_NUMVERSION)
156: # error "PETSc was configured with MPICH but now appears to be compiling using a non-MPICH mpi.h"
157: # elif (MPICH_NUMVERSION/100000 != PETSC_HAVE_MPICH_NUMVERSION/100000) || (MPICH_NUMVERSION%100000/1000 < PETSC_HAVE_MPICH_NUMVERSION%100000/1000)
158: # error "PETSc was configured with one MPICH mpi.h version but now appears to be compiling using a different MPICH mpi.h version"
159: # endif
160: #elif defined(PETSC_HAVE_OMPI_MAJOR_VERSION)
161: # if !defined(OMPI_MAJOR_VERSION)
162: # error "PETSc was configured with OpenMPI but now appears to be compiling using a non-OpenMPI mpi.h"
163: # 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)
164: # error "PETSc was configured with one OpenMPI mpi.h version but now appears to be compiling using a different OpenMPI mpi.h version"
165: # endif
166: #elif defined(OMPI_MAJOR_VERSION) || defined(MPICH_NUMVERSION)
167: # error "PETSc was configured with undetermined MPI - but now appears to be compiling using either of OpenMPI or a MPICH variant"
168: #endif
170: /*
171: Need to put stdio.h AFTER mpi.h for MPICH2 with C++ compiler
172: see the top of mpicxx.h in the MPICH2 distribution.
173: */
174: #include <stdio.h>
176: /* MSMPI on 32bit windows requires this yukky hack - that breaks MPI standard compliance */
177: #if !defined(MPIAPI)
178: #define MPIAPI
179: #endif
181: /*
182: Support for Clang (>=3.2) matching type tag arguments with void* buffer types.
183: This allows the compiler to detect cases where the MPI datatype argument passed to a MPI routine
184: does not match the actual type of the argument being passed in
185: */
186: #if defined(__has_attribute) && defined(works_with_const_which_is_not_true)
187: # if __has_attribute(argument_with_type_tag) && __has_attribute(pointer_with_type_tag) && __has_attribute(type_tag_for_datatype)
188: # define PetscAttrMPIPointerWithType(bufno,typeno) __attribute__((pointer_with_type_tag(MPI,bufno,typeno)))
189: # define PetscAttrMPITypeTag(type) __attribute__((type_tag_for_datatype(MPI,type)))
190: # define PetscAttrMPITypeTagLayoutCompatible(type) __attribute__((type_tag_for_datatype(MPI,type,layout_compatible)))
191: # endif
192: #endif
193: #if !defined(PetscAttrMPIPointerWithType)
194: # define PetscAttrMPIPointerWithType(bufno,typeno)
195: # define PetscAttrMPITypeTag(type)
196: # define PetscAttrMPITypeTagLayoutCompatible(type)
197: #endif
199: /*MC
200: PetscErrorCode - datatype used for return error code from almost all PETSc functions
202: Level: beginner
204: .seealso: CHKERRQ, SETERRQ
205: M*/
206: typedef int PetscErrorCode;
208: /*MC
210: PetscClassId - A unique id used to identify each PETSc class.
212: Notes: Use PetscClassIdRegister() to obtain a new value for a new class being created. Usually
213: XXXInitializePackage() calls it for each class it defines.
215: Developer Notes: Internal integer stored in the _p_PetscObject data structure.
216: These are all computed by an offset from the lowest one, PETSC_SMALLEST_CLASSID.
218: Level: developer
220: .seealso: PetscClassIdRegister(), PetscLogEventRegister(), PetscHeaderCreate()
221: M*/
222: typedef int PetscClassId;
225: /*MC
226: PetscMPIInt - datatype used to represent 'int' parameters to MPI functions.
228: Level: intermediate
230: Notes: usually this is the same as PetscInt, but if PETSc was built with --with-64-bit-indices but
231: standard C/Fortran integers are 32 bit then this is NOT the same as PetscInt it remains 32 bit
233: PetscMPIIntCast(a,&b) checks if the given PetscInt a will fit in a PetscMPIInt, if not it
234: generates a PETSC_ERR_ARG_OUTOFRANGE error.
236: .seealso: PetscBLASInt, PetscInt, PetscMPIIntCast()
238: M*/
239: typedef int PetscMPIInt;
241: /*MC
242: PetscEnum - datatype used to pass enum types within PETSc functions.
244: Level: intermediate
246: .seealso: PetscOptionsGetEnum(), PetscOptionsEnum(), PetscBagRegisterEnum()
247: M*/
248: typedef enum { ENUM_DUMMY } PetscEnum;
249: PETSC_EXTERN MPI_Datatype MPIU_ENUM PetscAttrMPITypeTag(PetscEnum);
251: #if defined(PETSC_HAVE_STDINT_H)
252: #include <stdint.h>
253: #endif
254: #if defined (PETSC_HAVE_INTTYPES_H)
256: #include <inttypes.h>
257: # if !defined(PRId64)
258: # define PRId64 "ld"
259: # endif
260: #endif
262: typedef short PetscShort;
263: typedef char PetscChar;
264: typedef float PetscFloat;
266: /*MC
267: PetscInt - PETSc type that represents integer - used primarily to
268: represent size of arrays and indexing into arrays. Its size can be configured with the option
269: --with-64-bit-indices - to be either 32bit or 64bit [default 32 bit ints]
272: Notes: For MPI calls that require datatypes, use MPIU_INT as the datatype for PetscInt. It will automatically work correctly regardless of
273: the size of PetscInt
275: Level: intermediate
277: .seealso: PetscScalar, PetscBLASInt, PetscMPIInt
278: M*/
279: #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 */
280: typedef int64_t PetscInt64;
281: # define MPIU_INT64 MPI_INT64_T
282: # define PetscInt64_FMT PRId64
283: #elif (PETSC_SIZEOF_LONG_LONG == 8)
284: typedef long long PetscInt64;
285: # define MPIU_INT64 MPI_LONG_LONG_INT
286: # define PetscInt64_FMT "lld"
287: #elif defined(PETSC_HAVE___INT64)
288: typedef __int64 PetscInt64;
289: # define MPIU_INT64 MPI_INT64_T
290: # define PetscInt64_FMT "ld"
291: #else
292: #error "cannot determine PetscInt64 type"
293: #endif
294: #if defined(PETSC_USE_64BIT_INDICES)
295: typedef PetscInt64 PetscInt;
296: #define MPIU_INT MPIU_INT64
297: #define PetscInt_FMT PetscInt64_FMT
298: #else
299: typedef int PetscInt;
300: #define MPIU_INT MPI_INT
301: #define PetscInt_FMT "d"
302: #endif
304: /*MC
305: PetscBLASInt - datatype used to represent 'int' parameters to BLAS/LAPACK functions.
307: Level: intermediate
309: Notes: usually this is the same as PetscInt, but if PETSc was built with --with-64-bit-indices but
310: standard C/Fortran integers are 32 bit then this is NOT the same as PetscInt it remains 32 bit
311: (except on very rare BLAS/LAPACK implementations that support 64 bit integers see the note below).
313: PetscErrorCode PetscBLASIntCast(a,&b) checks if the given PetscInt a will fit in a PetscBLASInt, if not it
314: generates a PETSC_ERR_ARG_OUTOFRANGE error
316: Installation Notes: The 64bit versions of MATLAB ship with BLAS and LAPACK that use 64 bit integers for sizes etc,
317: if you run ./configure with the option
318: --with-blaslapack-lib=[/Applications/MATLAB_R2010b.app/bin/maci64/libmwblas.dylib,/Applications/MATLAB_R2010b.app/bin/maci64/libmwlapack.dylib]
319: but you need to also use --known-64-bit-blas-indices.
321: MKL also ships with 64 bit integer versions of the BLAS and LAPACK, if you select those you must also ./configure with
322: --known-64-bit-blas-indices
324: OpenBLAS can also be built to use 64 bit integers. The ./configure options --download-openblas -download-openblas-64-bit-blas-indices
325: will build a 64 bit integer version
327: Developer Notes: Eventually ./configure should automatically determine the size of the integers used by BLAS/LAPACK.
329: External packages such as hypre, ML, SuperLU etc do not provide any support for passing 64 bit integers to BLAS/LAPACK so cannot
330: be used with PETSc if you have set PetscBLASInt to long int.
332: .seealso: PetscMPIInt, PetscInt, PetscBLASIntCast()
334: M*/
335: #if defined(PETSC_HAVE_64BIT_BLAS_INDICES)
336: typedef PetscInt64 PetscBLASInt;
337: #else
338: typedef int PetscBLASInt;
339: #endif
341: /*
342: For the rare cases when one needs to send a size_t object with MPI
343: */
344: #if (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_INT)
345: #define MPIU_SIZE_T MPI_UNSIGNED
346: #elif (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_LONG)
347: #define MPIU_SIZE_T MPI_UNSIGNED_LONG
348: #elif (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_LONG_LONG)
349: #define MPIU_SIZE_T MPI_UNSIGNED_LONG_LONG
350: #else
351: #error "Unknown size for size_t! Send us a bugreport at petsc-maint@mcs.anl.gov"
352: #endif
354: /*
355: You can use PETSC_STDOUT as a replacement of stdout. You can also change
356: the value of PETSC_STDOUT to redirect all standard output elsewhere
357: */
358: PETSC_EXTERN FILE* PETSC_STDOUT;
360: /*
361: You can use PETSC_STDERR as a replacement of stderr. You can also change
362: the value of PETSC_STDERR to redirect all standard error elsewhere
363: */
364: PETSC_EXTERN FILE* PETSC_STDERR;
366: /*MC
367: PetscUnlikely - hints the compiler that the given condition is usually FALSE
369: Synopsis:
370: #include <petscsys.h>
371: PetscBool PetscUnlikely(PetscBool cond)
373: Not Collective
375: Input Parameters:
376: . cond - condition or expression
378: Note: This returns the same truth value, it is only a hint to compilers that the resulting
379: branch is unlikely.
381: Level: advanced
383: .seealso: PetscLikely(), CHKERRQ
384: M*/
386: /*MC
387: PetscLikely - hints the compiler that the given condition is usually TRUE
389: Synopsis:
390: #include <petscsys.h>
391: PetscBool PetscLikely(PetscBool cond)
393: Not Collective
395: Input Parameters:
396: . cond - condition or expression
398: Note: This returns the same truth value, it is only a hint to compilers that the resulting
399: branch is likely.
401: Level: advanced
403: .seealso: PetscUnlikely()
404: M*/
405: #if defined(PETSC_HAVE_BUILTIN_EXPECT)
406: # define PetscUnlikely(cond) __builtin_expect(!!(cond),0)
407: # define PetscLikely(cond) __builtin_expect(!!(cond),1)
408: #else
409: # define PetscUnlikely(cond) (cond)
410: # define PetscLikely(cond) (cond)
411: #endif
413: /*
414: Declare extern C stuff after including external header files
415: */
418: /*
419: Basic PETSc constants
420: */
422: /*E
423: PetscBool - Logical variable. Actually an int in C and a logical in Fortran.
425: Level: beginner
427: Developer Note: Why have PetscBool , why not use bool in C? The problem is that K and R C, C99 and C++ all have different mechanisms for
428: boolean values. It is not easy to have a simple macro that that will work properly in all circumstances with all three mechanisms.
430: .seealso: PETSC_TRUE, PETSC_FALSE, PetscNot()
431: E*/
432: typedef enum { PETSC_FALSE,PETSC_TRUE } PetscBool;
433: PETSC_EXTERN const char *const PetscBools[];
434: PETSC_EXTERN MPI_Datatype MPIU_BOOL PetscAttrMPITypeTag(PetscBool);
436: /*
437: Defines elementary mathematics functions and constants.
438: */
439: #include <petscmath.h>
441: /*E
442: PetscCopyMode - Determines how an array passed to certain functions is copied or retained
444: Level: beginner
446: $ PETSC_COPY_VALUES - the array values are copied into new space, the user is free to reuse or delete the passed in array
447: $ 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
448: $ delete the array. The array MUST have been obtained with PetscMalloc(). Hence this mode cannot be used in Fortran.
449: $ 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
450: the array but the user must delete the array after the object is destroyed.
452: E*/
453: typedef enum { PETSC_COPY_VALUES, PETSC_OWN_POINTER, PETSC_USE_POINTER} PetscCopyMode;
454: PETSC_EXTERN const char *const PetscCopyModes[];
456: /*MC
457: PETSC_FALSE - False value of PetscBool
459: Level: beginner
461: Note: Zero integer
463: .seealso: PetscBool, PETSC_TRUE
464: M*/
466: /*MC
467: PETSC_TRUE - True value of PetscBool
469: Level: beginner
471: Note: Nonzero integer
473: .seealso: PetscBool, PETSC_FALSE
474: M*/
476: /*MC
477: PETSC_IGNORE - same as NULL, means PETSc will ignore this argument
479: Level: beginner
481: Note: accepted by many PETSc functions to not set a parameter and instead use
482: some default
484: Fortran Notes: This macro does not exist in Fortran; you must use PETSC_NULL_INTEGER,
485: PETSC_NULL_DOUBLE_PRECISION etc
487: .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_NULL, PETSC_DETERMINE
489: M*/
490: #define PETSC_IGNORE NULL
492: /* This is deprecated */
493: #define PETSC_NULL NULL
495: /*MC
496: PETSC_DECIDE - standard way of passing in integer or floating point parameter
497: where you wish PETSc to use the default.
499: Level: beginner
501: .seealso: PETSC_NULL, PETSC_DEFAULT, PETSC_IGNORE, PETSC_DETERMINE
503: M*/
504: #define PETSC_DECIDE -1
506: /*MC
507: PETSC_DETERMINE - standard way of passing in integer or floating point parameter
508: where you wish PETSc to compute the required value.
510: Level: beginner
512: Developer Note: I would like to use const PetscInt PETSC_DETERMINE = PETSC_DECIDE; but for
513: some reason this is not allowed by the standard even though PETSC_DECIDE is a constant value.
515: .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_IGNORE, VecSetSizes()
517: M*/
518: #define PETSC_DETERMINE PETSC_DECIDE
520: /*MC
521: PETSC_DEFAULT - standard way of passing in integer or floating point parameter
522: where you wish PETSc to use the default.
524: Level: beginner
526: Fortran Notes: You need to use PETSC_DEFAULT_INTEGER or PETSC_DEFAULT_REAL.
528: .seealso: PETSC_DECIDE, PETSC_IGNORE, PETSC_DETERMINE
530: M*/
531: #define PETSC_DEFAULT -2
533: /*MC
534: PETSC_COMM_WORLD - the equivalent of the MPI_COMM_WORLD communicator which represents
535: all the processs that PETSc knows about.
537: Level: beginner
539: Notes: By default PETSC_COMM_WORLD and MPI_COMM_WORLD are identical unless you wish to
540: run PETSc on ONLY a subset of MPI_COMM_WORLD. In that case create your new (smaller)
541: communicator, call it, say comm, and set PETSC_COMM_WORLD = comm BEFORE calling
542: PetscInitialize(), but after MPI_Init() has been called.
544: The value of PETSC_COMM_WORLD should never be USED/accessed before PetscInitialize()
545: is called because it may not have a valid value yet.
547: .seealso: PETSC_COMM_SELF
549: M*/
550: PETSC_EXTERN MPI_Comm PETSC_COMM_WORLD;
552: /*MC
553: PETSC_COMM_SELF - This is always MPI_COMM_SELF
555: Level: beginner
557: Notes: Do not USE/access or set this variable before PetscInitialize() has been called.
559: .seealso: PETSC_COMM_WORLD
561: M*/
562: #define PETSC_COMM_SELF MPI_COMM_SELF
564: PETSC_EXTERN PetscBool PetscBeganMPI;
565: PETSC_EXTERN PetscBool PetscInitializeCalled;
566: PETSC_EXTERN PetscBool PetscFinalizeCalled;
567: PETSC_EXTERN PetscBool PetscCUSPSynchronize;
568: PETSC_EXTERN PetscBool PetscViennaCLSynchronize;
569: PETSC_EXTERN PetscBool PetscCUDASynchronize;
571: PETSC_EXTERN PetscErrorCode PetscSetHelpVersionFunctions(PetscErrorCode (*)(MPI_Comm),PetscErrorCode (*)(MPI_Comm));
572: PETSC_EXTERN PetscErrorCode PetscCommDuplicate(MPI_Comm,MPI_Comm*,int*);
573: PETSC_EXTERN PetscErrorCode PetscCommDestroy(MPI_Comm*);
575: /*MC
576: PetscMalloc - Allocates memory, One should use PetscNew(), PetscMalloc1() or PetscCalloc1() usually instead of this
578: Synopsis:
579: #include <petscsys.h>
580: PetscErrorCode PetscMalloc(size_t m,void **result)
582: Not Collective
584: Input Parameter:
585: . m - number of bytes to allocate
587: Output Parameter:
588: . result - memory allocated
590: Level: beginner
592: Notes:
593: Memory is always allocated at least double aligned
595: It is safe to allocate size 0 and pass the resulting pointer (which may or may not be NULL) to PetscFree().
597: .seealso: PetscFree(), PetscNew()
599: Concepts: memory allocation
601: M*/
602: #define PetscMalloc(a,b) ((*PetscTrMalloc)((a),__LINE__,PETSC_FUNCTION_NAME,__FILE__,(void**)(b)))
604: /*MC
605: PetscRealloc - Rellocates memory
607: Synopsis:
608: #include <petscsys.h>
609: PetscErrorCode PetscRealloc(size_t m,void **result)
611: Not Collective
613: Input Parameters:
614: + m - number of bytes to allocate
615: - result - initial memory allocated
617: Output Parameter:
618: . result - new memory allocated
620: Level: developer
622: Notes:
623: Memory is always allocated at least double aligned
625: .seealso: PetscMalloc(), PetscFree(), PetscNew()
627: Concepts: memory allocation
629: M*/
630: #define PetscRealloc(a,b) ((*PetscTrRealloc)((a),__LINE__,PETSC_FUNCTION_NAME,__FILE__,(void**)(b)))
632: /*MC
633: PetscAddrAlign - Rounds up an address to PETSC_MEMALIGN alignment
635: Synopsis:
636: #include <petscsys.h>
637: void *PetscAddrAlign(void *addr)
639: Not Collective
641: Input Parameters:
642: . addr - address to align (any pointer type)
644: Level: developer
646: .seealso: PetscMallocAlign()
648: Concepts: memory allocation
649: M*/
650: #define PetscAddrAlign(a) (void*)((((PETSC_UINTPTR_T)(a))+(PETSC_MEMALIGN-1)) & ~(PETSC_MEMALIGN-1))
652: /*MC
653: PetscMalloc1 - Allocates an array of memory aligned to PETSC_MEMALIGN
655: Synopsis:
656: #include <petscsys.h>
657: PetscErrorCode PetscMalloc1(size_t m1,type **r1)
659: Not Collective
661: Input Parameter:
662: . m1 - number of elements to allocate (may be zero)
664: Output Parameter:
665: . r1 - memory allocated in first chunk
667: Note: This uses the sizeof() of the memory type requested to determine the total memory to be allocated, therefore you should not
668: multiply the number of elements requested by the sizeof() the type. For example use
669: $ PetscInt *id;
670: $ PetscMalloc1(10,&id);
671: not
672: $ PetscInt *id;
673: $ PetscMalloc1(10*sizeof(PetscInt),&id);
675: Does not zero the memory allocatd, used PetscCalloc1() to obtain memory that has been zeroed.
677: Level: beginner
679: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscCalloc1(), PetscMalloc2()
681: Concepts: memory allocation
683: M*/
684: #define PetscMalloc1(m1,r1) PetscMalloc((m1)*sizeof(**(r1)),r1)
686: /*MC
687: PetscCalloc1 - Allocates a cleared (zeroed) array of memory aligned to PETSC_MEMALIGN
689: Synopsis:
690: #include <petscsys.h>
691: PetscErrorCode PetscCalloc1(size_t m1,type **r1)
693: Not Collective
695: Input Parameter:
696: . m1 - number of elements to allocate in 1st chunk (may be zero)
698: Output Parameter:
699: . r1 - memory allocated in first chunk
701: Notes: see PetsMalloc1() for more details on usage.
703: Level: beginner
705: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc1(), PetscCalloc2()
707: Concepts: memory allocation
709: M*/
710: #define PetscCalloc1(m1,r1) (PetscMalloc1((m1),r1) || PetscMemzero(*(r1),(m1)*sizeof(**(r1))))
712: /*MC
713: PetscMalloc2 - Allocates 2 arrays of memory both aligned to PETSC_MEMALIGN
715: Synopsis:
716: #include <petscsys.h>
717: PetscErrorCode PetscMalloc2(size_t m1,type **r1,size_t m2,type **r2)
719: Not Collective
721: Input Parameter:
722: + m1 - number of elements to allocate in 1st chunk (may be zero)
723: - m2 - number of elements to allocate in 2nd chunk (may be zero)
725: Output Parameter:
726: + r1 - memory allocated in first chunk
727: - r2 - memory allocated in second chunk
729: Level: developer
731: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc1(), PetscCalloc2()
733: Concepts: memory allocation
735: M*/
736: #if !defined(PETSC_USE_MALLOC_COALESCED)
737: #define PetscMalloc2(m1,r1,m2,r2) (PetscMalloc1((m1),(r1)) || PetscMalloc1((m2),(r2)))
738: #else
739: #define PetscMalloc2(m1,r1,m2,r2) ((((m1)+(m2)) ? (*(r2) = 0,PetscMalloc((m1)*sizeof(**(r1))+(m2)*sizeof(**(r2))+(PETSC_MEMALIGN-1),r1)) : 0) \
740: || (*(void**)(r2) = PetscAddrAlign(*(r1)+(m1)),0) \
741: || (0==(m1) ? (*(r1) = 0,0) : 0) || (0==(m2) ? (*(r2) = 0,0) : 0))
742: #endif
744: /*MC
745: PetscCalloc2 - Allocates 2 cleared (zeroed) arrays of memory both aligned to PETSC_MEMALIGN
747: Synopsis:
748: #include <petscsys.h>
749: PetscErrorCode PetscCalloc2(size_t m1,type **r1,size_t m2,type **r2)
751: Not Collective
753: Input Parameter:
754: + m1 - number of elements to allocate in 1st chunk (may be zero)
755: - m2 - number of elements to allocate in 2nd chunk (may be zero)
757: Output Parameter:
758: + r1 - memory allocated in first chunk
759: - r2 - memory allocated in second chunk
761: Level: developer
763: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscCalloc1(), PetscMalloc2()
765: Concepts: memory allocation
766: M*/
767: #define PetscCalloc2(m1,r1,m2,r2) (PetscMalloc2((m1),(r1),(m2),(r2)) || PetscMemzero(*(r1),(m1)*sizeof(**(r1))) || PetscMemzero(*(r2),(m2)*sizeof(**(r2))))
769: /*MC
770: PetscMalloc3 - Allocates 3 arrays of memory, all aligned to PETSC_MEMALIGN
772: Synopsis:
773: #include <petscsys.h>
774: PetscErrorCode PetscMalloc3(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3)
776: Not Collective
778: Input Parameter:
779: + m1 - number of elements to allocate in 1st chunk (may be zero)
780: . m2 - number of elements to allocate in 2nd chunk (may be zero)
781: - m3 - number of elements to allocate in 3rd chunk (may be zero)
783: Output Parameter:
784: + r1 - memory allocated in first chunk
785: . r2 - memory allocated in second chunk
786: - r3 - memory allocated in third chunk
788: Level: developer
790: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc3(), PetscFree3()
792: Concepts: memory allocation
794: M*/
795: #if !defined(PETSC_USE_MALLOC_COALESCED)
796: #define PetscMalloc3(m1,r1,m2,r2,m3,r3) (PetscMalloc1((m1),(r1)) || PetscMalloc1((m2),(r2)) || PetscMalloc1((m3),(r3)))
797: #else
798: #define PetscMalloc3(m1,r1,m2,r2,m3,r3) ((((m1)+(m2)+(m3)) ? (*(r2) = 0,*(r3) = 0,PetscMalloc((m1)*sizeof(**(r1))+(m2)*sizeof(**(r2))+(m3)*sizeof(**(r3))+2*(PETSC_MEMALIGN-1),r1)) : 0) \
799: || (*(void**)(r2) = PetscAddrAlign(*(r1)+(m1)),*(void**)(r3) = PetscAddrAlign(*(r2)+(m2)),0) \
800: || (0==(m1) ? (*(r1) = 0,0) : 0) || (0==(m2) ? (*(r2) = 0,0) : 0) || (0==(m3) ? (*(r3) = 0,0) : 0))
801: #endif
803: /*MC
804: PetscCalloc3 - Allocates 3 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN
806: Synopsis:
807: #include <petscsys.h>
808: PetscErrorCode PetscCalloc3(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(), PetscCalloc2(), PetscMalloc3(), PetscFree3()
826: Concepts: memory allocation
827: M*/
828: #define PetscCalloc3(m1,r1,m2,r2,m3,r3) \
829: (PetscMalloc3((m1),(r1),(m2),(r2),(m3),(r3)) \
830: || PetscMemzero(*(r1),(m1)*sizeof(**(r1))) || PetscMemzero(*(r2),(m2)*sizeof(**(r2))) || PetscMemzero(*(r3),(m3)*sizeof(**(r3))))
832: /*MC
833: PetscMalloc4 - Allocates 4 arrays of memory, all aligned to PETSC_MEMALIGN
835: Synopsis:
836: #include <petscsys.h>
837: PetscErrorCode PetscMalloc4(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4)
839: Not Collective
841: Input Parameter:
842: + m1 - number of elements to allocate in 1st chunk (may be zero)
843: . m2 - number of elements to allocate in 2nd chunk (may be zero)
844: . m3 - number of elements to allocate in 3rd chunk (may be zero)
845: - m4 - number of elements to allocate in 4th chunk (may be zero)
847: Output Parameter:
848: + r1 - memory allocated in first chunk
849: . r2 - memory allocated in second chunk
850: . r3 - memory allocated in third chunk
851: - r4 - memory allocated in fourth chunk
853: Level: developer
855: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc4(), PetscFree4()
857: Concepts: memory allocation
859: M*/
860: #if !defined(PETSC_USE_MALLOC_COALESCED)
861: #define PetscMalloc4(m1,r1,m2,r2,m3,r3,m4,r4) (PetscMalloc1((m1),(r1)) || PetscMalloc1((m2),(r2)) || PetscMalloc1((m3),(r3)) || PetscMalloc1((m4),(r4)))
862: #else
863: #define PetscMalloc4(m1,r1,m2,r2,m3,r3,m4,r4) \
864: ((((m1)+(m2)+(m3)+(m4)) ? (*(r2) = 0, *(r3) = 0, *(r4) = 0,PetscMalloc((m1)*sizeof(**(r1))+(m2)*sizeof(**(r2))+(m3)*sizeof(**(r3))+(m4)*sizeof(**(r4))+3*(PETSC_MEMALIGN-1),r1)) : 0) \
865: || (*(void**)(r2) = PetscAddrAlign(*(r1)+(m1)),*(void**)(r3) = PetscAddrAlign(*(r2)+(m2)),*(void**)(r4) = PetscAddrAlign(*(r3)+(m3)),0) \
866: || (0==(m1) ? (*(r1) = 0,0) : 0) || (0==(m2) ? (*(r2) = 0,0) : 0) || (0==(m3) ? (*(r3) = 0,0) : 0) || (0==(m4) ? (*(r4) = 0,0) : 0))
867: #endif
869: /*MC
870: PetscCalloc4 - Allocates 4 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN
872: Synopsis:
873: #include <petscsys.h>
874: PetscErrorCode PetscCalloc4(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4)
876: Not Collective
878: Input Parameter:
879: + m1 - number of elements to allocate in 1st chunk (may be zero)
880: . m2 - number of elements to allocate in 2nd chunk (may be zero)
881: . m3 - number of elements to allocate in 3rd chunk (may be zero)
882: - m4 - number of elements to allocate in 4th chunk (may be zero)
884: Output Parameter:
885: + r1 - memory allocated in first chunk
886: . r2 - memory allocated in second chunk
887: . r3 - memory allocated in third chunk
888: - r4 - memory allocated in fourth chunk
890: Level: developer
892: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc4(), PetscFree4()
894: Concepts: memory allocation
896: M*/
897: #define PetscCalloc4(m1,r1,m2,r2,m3,r3,m4,r4) \
898: (PetscMalloc4(m1,r1,m2,r2,m3,r3,m4,r4) \
899: || PetscMemzero(*(r1),(m1)*sizeof(**(r1))) || PetscMemzero(*(r2),(m2)*sizeof(**(r2))) || PetscMemzero(*(r3),(m3)*sizeof(**(r3))) \
900: || PetscMemzero(*(r4),(m4)*sizeof(**(r4))))
902: /*MC
903: PetscMalloc5 - Allocates 5 arrays of memory, all aligned to PETSC_MEMALIGN
905: Synopsis:
906: #include <petscsys.h>
907: 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)
909: Not Collective
911: Input Parameter:
912: + m1 - number of elements to allocate in 1st chunk (may be zero)
913: . m2 - number of elements to allocate in 2nd chunk (may be zero)
914: . m3 - number of elements to allocate in 3rd chunk (may be zero)
915: . m4 - number of elements to allocate in 4th chunk (may be zero)
916: - m5 - number of elements to allocate in 5th chunk (may be zero)
918: Output Parameter:
919: + r1 - memory allocated in first chunk
920: . r2 - memory allocated in second chunk
921: . r3 - memory allocated in third chunk
922: . r4 - memory allocated in fourth chunk
923: - r5 - memory allocated in fifth chunk
925: Level: developer
927: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc5(), PetscFree5()
929: Concepts: memory allocation
931: M*/
932: #if !defined(PETSC_USE_MALLOC_COALESCED)
933: #define PetscMalloc5(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5) (PetscMalloc1((m1),(r1)) || PetscMalloc1((m2),(r2)) || PetscMalloc1((m3),(r3)) || PetscMalloc1((m4),(r4)) || PetscMalloc1((m5),(r5)))
934: #else
935: #define PetscMalloc5(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5) \
936: ((((m1)+(m2)+(m3)+(m4)+(m5)) ? (*(r2) = 0, *(r3) = 0, *(r4) = 0,*(r5) = 0,PetscMalloc((m1)*sizeof(**(r1))+(m2)*sizeof(**(r2))+(m3)*sizeof(**(r3))+(m4)*sizeof(**(r4))+(m5)*sizeof(**(r5))+4*(PETSC_MEMALIGN-1),r1)) : 0) \
937: || (*(void**)(r2) = PetscAddrAlign(*(r1)+(m1)),*(void**)(r3) = PetscAddrAlign(*(r2)+(m2)),*(void**)(r4) = PetscAddrAlign(*(r3)+(m3)),*(void**)(r5) = PetscAddrAlign(*(r4)+(m4)),0) \
938: || (0==(m1) ? (*(r1) = 0,0) : 0) || (0==(m2) ? (*(r2) = 0,0) : 0) || (0==(m3) ? (*(r3) = 0,0) : 0) || (0==(m4) ? (*(r4) = 0,0) : 0) || (0==(m5) ? (*(r5) = 0,0) : 0))
939: #endif
941: /*MC
942: PetscCalloc5 - Allocates 5 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN
944: Synopsis:
945: #include <petscsys.h>
946: 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)
948: Not Collective
950: Input Parameter:
951: + m1 - number of elements to allocate in 1st chunk (may be zero)
952: . m2 - number of elements to allocate in 2nd chunk (may be zero)
953: . m3 - number of elements to allocate in 3rd chunk (may be zero)
954: . m4 - number of elements to allocate in 4th chunk (may be zero)
955: - m5 - number of elements to allocate in 5th chunk (may be zero)
957: Output Parameter:
958: + r1 - memory allocated in first chunk
959: . r2 - memory allocated in second chunk
960: . r3 - memory allocated in third chunk
961: . r4 - memory allocated in fourth chunk
962: - r5 - memory allocated in fifth chunk
964: Level: developer
966: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc5(), PetscFree5()
968: Concepts: memory allocation
970: M*/
971: #define PetscCalloc5(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5) \
972: (PetscMalloc5(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5) \
973: || PetscMemzero(*(r1),(m1)*sizeof(**(r1))) || PetscMemzero(*(r2),(m2)*sizeof(**(r2))) || PetscMemzero(*(r3),(m3)*sizeof(**(r3))) \
974: || PetscMemzero(*(r4),(m4)*sizeof(**(r4))) || PetscMemzero(*(r5),(m5)*sizeof(**(r5))))
976: /*MC
977: PetscMalloc6 - Allocates 6 arrays of memory, all aligned to PETSC_MEMALIGN
979: Synopsis:
980: #include <petscsys.h>
981: 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)
983: Not Collective
985: Input Parameter:
986: + m1 - number of elements to allocate in 1st chunk (may be zero)
987: . m2 - number of elements to allocate in 2nd chunk (may be zero)
988: . m3 - number of elements to allocate in 3rd chunk (may be zero)
989: . m4 - number of elements to allocate in 4th chunk (may be zero)
990: . m5 - number of elements to allocate in 5th chunk (may be zero)
991: - m6 - number of elements to allocate in 6th chunk (may be zero)
993: Output Parameter:
994: + r1 - memory allocated in first chunk
995: . r2 - memory allocated in second chunk
996: . r3 - memory allocated in third chunk
997: . r4 - memory allocated in fourth chunk
998: . r5 - memory allocated in fifth chunk
999: - r6 - memory allocated in sixth chunk
1001: Level: developer
1003: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc6(), PetscFree3(), PetscFree4(), PetscFree5(), PetscFree6()
1005: Concepts: memory allocation
1007: M*/
1008: #if !defined(PETSC_USE_MALLOC_COALESCED)
1009: #define PetscMalloc6(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6) (PetscMalloc1((m1),(r1)) || PetscMalloc1((m2),(r2)) || PetscMalloc1((m3),(r3)) || PetscMalloc1((m4),(r4)) || PetscMalloc1((m5),(r5)) || PetscMalloc1((m6),(r6)))
1010: #else
1011: #define PetscMalloc6(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6) \
1012: ((((m1)+(m2)+(m3)+(m4)+(m5)+(m6)) ? (*(r2) = 0, *(r3) = 0, *(r4) = 0,*(r5) = 0,*(r6) = 0,PetscMalloc((m1)*sizeof(**(r1))+(m2)*sizeof(**(r2))+(m3)*sizeof(**(r3))+(m4)*sizeof(**(r4))+(m5)*sizeof(**(r5))+(m6)*sizeof(**(r6))+5*(PETSC_MEMALIGN-1),r1)) : 0) \
1013: || (*(void**)(r2) = PetscAddrAlign(*(r1)+(m1)),*(void**)(r3) = PetscAddrAlign(*(r2)+(m2)),*(void**)(r4) = PetscAddrAlign(*(r3)+(m3)),*(void**)(r5) = PetscAddrAlign(*(r4)+(m4)),*(void**)(r6) = PetscAddrAlign(*(r5)+(m5)),0) \
1014: || (0==(m1) ? (*(r1) = 0,0) : 0) || (0==(m2) ? (*(r2) = 0,0) : 0) || (0==(m3) ? (*(r3) = 0,0) : 0) || (0==(m4) ? (*(r4) = 0,0) : 0) || (0==(m5) ? (*(r5) = 0,0) : 0) || (0==(m6) ? (*(r6) = 0,0) : 0))
1015: #endif
1017: /*MC
1018: PetscCalloc6 - Allocates 6 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN
1020: Synopsis:
1021: #include <petscsys.h>
1022: 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)
1024: Not Collective
1026: Input Parameter:
1027: + m1 - number of elements to allocate in 1st chunk (may be zero)
1028: . m2 - number of elements to allocate in 2nd chunk (may be zero)
1029: . m3 - number of elements to allocate in 3rd chunk (may be zero)
1030: . m4 - number of elements to allocate in 4th chunk (may be zero)
1031: . m5 - number of elements to allocate in 5th chunk (may be zero)
1032: - m6 - number of elements to allocate in 6th chunk (may be zero)
1034: Output Parameter:
1035: + r1 - memory allocated in first chunk
1036: . r2 - memory allocated in second chunk
1037: . r3 - memory allocated in third chunk
1038: . r4 - memory allocated in fourth chunk
1039: . r5 - memory allocated in fifth chunk
1040: - r6 - memory allocated in sixth chunk
1042: Level: developer
1044: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscMalloc6(), PetscFree6()
1046: Concepts: memory allocation
1047: M*/
1048: #define PetscCalloc6(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6) \
1049: (PetscMalloc6(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6) \
1050: || PetscMemzero(*(r1),(m1)*sizeof(**(r1))) || PetscMemzero(*(r2),(m2)*sizeof(**(r2))) || PetscMemzero(*(r3),(m3)*sizeof(**(r3))) \
1051: || PetscMemzero(*(r4),(m4)*sizeof(**(r4))) || PetscMemzero(*(r5),(m5)*sizeof(**(r5))) || PetscMemzero(*(r6),(m6)*sizeof(**(r6))))
1053: /*MC
1054: PetscMalloc7 - Allocates 7 arrays of memory, all aligned to PETSC_MEMALIGN
1056: Synopsis:
1057: #include <petscsys.h>
1058: 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)
1060: Not Collective
1062: Input Parameter:
1063: + m1 - number of elements to allocate in 1st chunk (may be zero)
1064: . m2 - number of elements to allocate in 2nd chunk (may be zero)
1065: . m3 - number of elements to allocate in 3rd chunk (may be zero)
1066: . m4 - number of elements to allocate in 4th chunk (may be zero)
1067: . m5 - number of elements to allocate in 5th chunk (may be zero)
1068: . m6 - number of elements to allocate in 6th chunk (may be zero)
1069: - m7 - number of elements to allocate in 7th chunk (may be zero)
1071: Output Parameter:
1072: + r1 - memory allocated in first chunk
1073: . r2 - memory allocated in second chunk
1074: . r3 - memory allocated in third chunk
1075: . r4 - memory allocated in fourth chunk
1076: . r5 - memory allocated in fifth chunk
1077: . r6 - memory allocated in sixth chunk
1078: - r7 - memory allocated in seventh chunk
1080: Level: developer
1082: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc7(), PetscFree7()
1084: Concepts: memory allocation
1086: M*/
1087: #if !defined(PETSC_USE_MALLOC_COALESCED)
1088: #define PetscMalloc7(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6,m7,r7) (PetscMalloc1((m1),(r1)) || PetscMalloc1((m2),(r2)) || PetscMalloc1((m3),(r3)) || PetscMalloc1((m4),(r4)) || PetscMalloc1((m5),(r5)) || PetscMalloc1((m6),(r6)) || PetscMalloc1((m7),(r7)))
1089: #else
1090: #define PetscMalloc7(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6,m7,r7) \
1091: ((((m1)+(m2)+(m3)+(m4)+(m5)+(m6)+(m7)) ? (*(r2) = 0, *(r3) = 0, *(r4) = 0,*(r5) = 0,*(r6) = 0,*(r7) = 0,PetscMalloc((m1)*sizeof(**(r1))+(m2)*sizeof(**(r2))+(m3)*sizeof(**(r3))+(m4)*sizeof(**(r4))+(m5)*sizeof(**(r5))+(m6)*sizeof(**(r6))+(m7)*sizeof(**(r7))+6*(PETSC_MEMALIGN-1),r1)) : 0) \
1092: || (*(void**)(r2) = PetscAddrAlign(*(r1)+(m1)),*(void**)(r3) = PetscAddrAlign(*(r2)+(m2)),*(void**)(r4) = PetscAddrAlign(*(r3)+(m3)),*(void**)(r5) = PetscAddrAlign(*(r4)+(m4)),*(void**)(r6) = PetscAddrAlign(*(r5)+(m5)),*(void**)(r7) = PetscAddrAlign(*(r6)+(m6)),0) \
1093: || (0==(m1) ? (*(r1) = 0,0) : 0) || (0==(m2) ? (*(r2) = 0,0) : 0) || (0==(m3) ? (*(r3) = 0,0) : 0) || (0==(m4) ? (*(r4) = 0,0) : 0) || (0==(m5) ? (*(r5) = 0,0) : 0) || (0==(m6) ? (*(r6) = 0,0) : 0) || (0==(m7) ? (*(r7) = 0,0) : 0))
1094: #endif
1096: /*MC
1097: PetscCalloc7 - Allocates 7 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN
1099: Synopsis:
1100: #include <petscsys.h>
1101: 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)
1103: Not Collective
1105: Input Parameter:
1106: + m1 - number of elements to allocate in 1st chunk (may be zero)
1107: . m2 - number of elements to allocate in 2nd chunk (may be zero)
1108: . m3 - number of elements to allocate in 3rd chunk (may be zero)
1109: . m4 - number of elements to allocate in 4th chunk (may be zero)
1110: . m5 - number of elements to allocate in 5th chunk (may be zero)
1111: . m6 - number of elements to allocate in 6th chunk (may be zero)
1112: - m7 - number of elements to allocate in 7th chunk (may be zero)
1114: Output Parameter:
1115: + r1 - memory allocated in first chunk
1116: . r2 - memory allocated in second chunk
1117: . r3 - memory allocated in third chunk
1118: . r4 - memory allocated in fourth chunk
1119: . r5 - memory allocated in fifth chunk
1120: . r6 - memory allocated in sixth chunk
1121: - r7 - memory allocated in seventh chunk
1123: Level: developer
1125: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscMalloc7(), PetscFree7()
1127: Concepts: memory allocation
1128: M*/
1129: #define PetscCalloc7(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6,m7,r7) \
1130: (PetscMalloc7(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6,m7,r7) \
1131: || PetscMemzero(*(r1),(m1)*sizeof(**(r1))) || PetscMemzero(*(r2),(m2)*sizeof(**(r2))) || PetscMemzero(*(r3),(m3)*sizeof(**(r3))) \
1132: || PetscMemzero(*(r4),(m4)*sizeof(**(r4))) || PetscMemzero(*(r5),(m5)*sizeof(**(r5))) || PetscMemzero(*(r6),(m6)*sizeof(**(r6))) \
1133: || PetscMemzero(*(r7),(m7)*sizeof(**(r7))))
1135: /*MC
1136: PetscNew - Allocates memory of a particular type, zeros the memory! Aligned to PETSC_MEMALIGN
1138: Synopsis:
1139: #include <petscsys.h>
1140: PetscErrorCode PetscNew(type **result)
1142: Not Collective
1144: Output Parameter:
1145: . result - memory allocated, sized to match pointer type
1147: Level: beginner
1149: .seealso: PetscFree(), PetscMalloc(), PetscNewLog(), PetscCalloc1(), PetscMalloc1()
1151: Concepts: memory allocation
1153: M*/
1154: #define PetscNew(b) PetscCalloc1(1,(b))
1156: /*MC
1157: PetscNewLog - Allocates memory of a type matching pointer, zeros the memory! Aligned to PETSC_MEMALIGN. Associates the memory allocated
1158: with the given object using PetscLogObjectMemory().
1160: Synopsis:
1161: #include <petscsys.h>
1162: PetscErrorCode PetscNewLog(PetscObject obj,type **result)
1164: Not Collective
1166: Input Parameter:
1167: . obj - object memory is logged to
1169: Output Parameter:
1170: . result - memory allocated, sized to match pointer type
1172: Level: developer
1174: .seealso: PetscFree(), PetscMalloc(), PetscNew(), PetscLogObjectMemory(), PetscCalloc1(), PetscMalloc1()
1176: Concepts: memory allocation
1178: M*/
1179: #define PetscNewLog(o,b) (PetscNew((b)) || PetscLogObjectMemory((PetscObject)o,sizeof(**(b))))
1181: /*MC
1182: PetscFree - Frees memory
1184: Synopsis:
1185: #include <petscsys.h>
1186: PetscErrorCode PetscFree(void *memory)
1188: Not Collective
1190: Input Parameter:
1191: . memory - memory to free (the pointer is ALWAYS set to NULL upon sucess)
1193: Level: beginner
1195: Notes:
1196: Do not free memory obtained with PetscMalloc2(), PetscCalloc2() etc, they must be freed with PetscFree2() etc.
1198: It is safe to call PetscFree() on a NULL pointer.
1200: .seealso: PetscNew(), PetscMalloc(), PetscNewLog(), PetscMalloc1(), PetscCalloc1()
1202: Concepts: memory allocation
1204: M*/
1205: #define PetscFree(a) ((*PetscTrFree)((void*)(a),__LINE__,PETSC_FUNCTION_NAME,__FILE__) || ((a) = 0,0))
1207: /*MC
1208: PetscFree2 - Frees 2 chunks of memory obtained with PetscMalloc2()
1210: Synopsis:
1211: #include <petscsys.h>
1212: PetscErrorCode PetscFree2(void *memory1,void *memory2)
1214: Not Collective
1216: Input Parameter:
1217: + memory1 - memory to free
1218: - memory2 - 2nd memory to free
1220: Level: developer
1222: Notes: Memory must have been obtained with PetscMalloc2()
1224: .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree()
1226: Concepts: memory allocation
1228: M*/
1229: #if !defined(PETSC_USE_MALLOC_COALESCED)
1230: #define PetscFree2(m1,m2) (PetscFree(m2) || PetscFree(m1))
1231: #else
1232: #define PetscFree2(m1,m2) ((m1) ? ((m2)=0,PetscFree(m1)) : ((m1)=0,PetscFree(m2)))
1233: #endif
1235: /*MC
1236: PetscFree3 - Frees 3 chunks of memory obtained with PetscMalloc3()
1238: Synopsis:
1239: #include <petscsys.h>
1240: PetscErrorCode PetscFree3(void *memory1,void *memory2,void *memory3)
1242: Not Collective
1244: Input Parameter:
1245: + memory1 - memory to free
1246: . memory2 - 2nd memory to free
1247: - memory3 - 3rd memory to free
1249: Level: developer
1251: Notes: Memory must have been obtained with PetscMalloc3()
1253: .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3()
1255: Concepts: memory allocation
1257: M*/
1258: #if !defined(PETSC_USE_MALLOC_COALESCED)
1259: #define PetscFree3(m1,m2,m3) (PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
1260: #else
1261: #define PetscFree3(m1,m2,m3) ((m1) ? ((m3)=0,(m2)=0,PetscFree(m1)) : ((m2) ? ((m3)=0,(m1)=0,PetscFree(m2)) : ((m2)=0,(m1)=0,PetscFree(m3))))
1262: #endif
1264: /*MC
1265: PetscFree4 - Frees 4 chunks of memory obtained with PetscMalloc4()
1267: Synopsis:
1268: #include <petscsys.h>
1269: PetscErrorCode PetscFree4(void *m1,void *m2,void *m3,void *m4)
1271: Not Collective
1273: Input Parameter:
1274: + m1 - memory to free
1275: . m2 - 2nd memory to free
1276: . m3 - 3rd memory to free
1277: - m4 - 4th memory to free
1279: Level: developer
1281: Notes: Memory must have been obtained with PetscMalloc4()
1283: .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4()
1285: Concepts: memory allocation
1287: M*/
1288: #if !defined(PETSC_USE_MALLOC_COALESCED)
1289: #define PetscFree4(m1,m2,m3,m4) (PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
1290: #else
1291: #define PetscFree4(m1,m2,m3,m4) ((m1) ? ((m4)=0,(m3)=0,(m2)=0,PetscFree(m1)) : ((m2) ? ((m4)=0,(m3)=0,(m1)=0,PetscFree(m2)) : ((m3) ? ((m4)=0,(m2)=0,(m1)=0,PetscFree(m3)) : ((m3)=0,(m2)=0,(m1)=0,PetscFree(m4)))))
1292: #endif
1294: /*MC
1295: PetscFree5 - Frees 5 chunks of memory obtained with PetscMalloc5()
1297: Synopsis:
1298: #include <petscsys.h>
1299: PetscErrorCode PetscFree5(void *m1,void *m2,void *m3,void *m4,void *m5)
1301: Not Collective
1303: Input Parameter:
1304: + m1 - memory to free
1305: . m2 - 2nd memory to free
1306: . m3 - 3rd memory to free
1307: . m4 - 4th memory to free
1308: - m5 - 5th memory to free
1310: Level: developer
1312: Notes: Memory must have been obtained with PetscMalloc5()
1314: .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5()
1316: Concepts: memory allocation
1318: M*/
1319: #if !defined(PETSC_USE_MALLOC_COALESCED)
1320: #define PetscFree5(m1,m2,m3,m4,m5) (PetscFree(m5) || PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
1321: #else
1322: #define PetscFree5(m1,m2,m3,m4,m5) ((m1) ? ((m5)=0,(m4)=0,(m3)=0,(m2)=0,PetscFree(m1)) : ((m2) ? ((m5)=0,(m4)=0,(m3)=0,(m1)=0,PetscFree(m2)) : ((m3) ? ((m5)=0,(m4)=0,(m2)=0,(m1)=0,PetscFree(m3)) : \
1323: ((m4) ? ((m5)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m4)) : ((m4)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m5))))))
1324: #endif
1327: /*MC
1328: PetscFree6 - Frees 6 chunks of memory obtained with PetscMalloc6()
1330: Synopsis:
1331: #include <petscsys.h>
1332: PetscErrorCode PetscFree6(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6)
1334: Not Collective
1336: Input Parameter:
1337: + m1 - memory to free
1338: . m2 - 2nd memory to free
1339: . m3 - 3rd memory to free
1340: . m4 - 4th memory to free
1341: . m5 - 5th memory to free
1342: - m6 - 6th memory to free
1345: Level: developer
1347: Notes: Memory must have been obtained with PetscMalloc6()
1349: .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6()
1351: Concepts: memory allocation
1353: M*/
1354: #if !defined(PETSC_USE_MALLOC_COALESCED)
1355: #define PetscFree6(m1,m2,m3,m4,m5,m6) (PetscFree(m6) || PetscFree(m5) || PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
1356: #else
1357: #define PetscFree6(m1,m2,m3,m4,m5,m6) ((m1) ? ((m6)=0,(m5)=0,(m4)=0,(m3)=0,(m2)=0,PetscFree(m1)) : ((m2) ? ((m6)=0,(m5)=0,(m4)=0,(m3)=0,(m1)=0,PetscFree(m2)) : \
1358: ((m3) ? ((m6)=0,(m5)=0,(m4)=0,(m2)=0,(m1)=0,PetscFree(m3)) : ((m4) ? ((m6)=0,(m5)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m4)) : \
1359: ((m5) ? ((m6)=0,(m4)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m5)) : ((m5)=0,(m4)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m6)))))))
1360: #endif
1362: /*MC
1363: PetscFree7 - Frees 7 chunks of memory obtained with PetscMalloc7()
1365: Synopsis:
1366: #include <petscsys.h>
1367: PetscErrorCode PetscFree7(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6,void *m7)
1369: Not Collective
1371: Input Parameter:
1372: + m1 - memory to free
1373: . m2 - 2nd memory to free
1374: . m3 - 3rd memory to free
1375: . m4 - 4th memory to free
1376: . m5 - 5th memory to free
1377: . m6 - 6th memory to free
1378: - m7 - 7th memory to free
1381: Level: developer
1383: Notes: Memory must have been obtained with PetscMalloc7()
1385: .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6(),
1386: PetscMalloc7()
1388: Concepts: memory allocation
1390: M*/
1391: #if !defined(PETSC_USE_MALLOC_COALESCED)
1392: #define PetscFree7(m1,m2,m3,m4,m5,m6,m7) (PetscFree(m7) || PetscFree(m6) || PetscFree(m5) || PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
1393: #else
1394: #define PetscFree7(m1,m2,m3,m4,m5,m6,m7) ((m1) ? ((m7)=0,(m6)=0,(m5)=0,(m4)=0,(m3)=0,(m2)=0,PetscFree(m1)) : ((m2) ? ((m7)=0,(m6)=0,(m5)=0,(m4)=0,(m3)=0,(m1)=0,PetscFree(m2)) : \
1395: ((m3) ? ((m7)=0,(m6)=0,(m5)=0,(m4)=0,(m2)=0,(m1)=0,PetscFree(m3)) : ((m4) ? ((m7)=0,(m6)=0,(m5)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m4)) : \
1396: ((m5) ? ((m7)=0,(m6)=0,(m4)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m5)) : ((m6) ? ((m7)=0,(m5)=0,(m4)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m6)) : \
1397: ((m6)=0,(m5)=0,(m4)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m7))))))))
1398: #endif
1400: PETSC_EXTERN PetscErrorCode (*PetscTrMalloc)(size_t,int,const char[],const char[],void**);
1401: PETSC_EXTERN PetscErrorCode (*PetscTrFree)(void*,int,const char[],const char[]);
1402: PETSC_EXTERN PetscErrorCode (*PetscTrRealloc)(size_t,int,const char[],const char[],void**);
1403: PETSC_EXTERN PetscErrorCode PetscMallocSet(PetscErrorCode (*)(size_t,int,const char[],const char[],void**),PetscErrorCode (*)(void*,int,const char[],const char[]));
1404: PETSC_EXTERN PetscErrorCode PetscMallocClear(void);
1406: /*
1407: Unlike PetscMallocSet and PetscMallocClear which overwrite the existing settings, these two functions save the previous choice of allocator, and should be used in pair.
1408: */
1409: PETSC_EXTERN PetscErrorCode PetscMallocSetDRAM(void);
1410: PETSC_EXTERN PetscErrorCode PetscMallocResetDRAM(void);
1412: /*
1413: PetscLogDouble variables are used to contain double precision numbers
1414: that are not used in the numerical computations, but rather in logging,
1415: timing etc.
1416: */
1417: typedef double PetscLogDouble;
1418: #define MPIU_PETSCLOGDOUBLE MPI_DOUBLE
1420: /*
1421: Routines for tracing memory corruption/bleeding with default PETSc memory allocation
1422: */
1423: PETSC_EXTERN PetscErrorCode PetscMallocDump(FILE *);
1424: PETSC_EXTERN PetscErrorCode PetscMallocDumpLog(FILE *);
1425: PETSC_EXTERN PetscErrorCode PetscMallocGetCurrentUsage(PetscLogDouble *);
1426: PETSC_EXTERN PetscErrorCode PetscMallocGetMaximumUsage(PetscLogDouble *);
1427: PETSC_EXTERN PetscErrorCode PetscMallocDebug(PetscBool);
1428: PETSC_EXTERN PetscErrorCode PetscMallocGetDebug(PetscBool*);
1429: PETSC_EXTERN PetscErrorCode PetscMallocValidate(int,const char[],const char[]);
1430: PETSC_EXTERN PetscErrorCode PetscMallocSetDumpLog(void);
1431: PETSC_EXTERN PetscErrorCode PetscMallocSetDumpLogThreshold(PetscLogDouble);
1432: PETSC_EXTERN PetscErrorCode PetscMallocGetDumpLog(PetscBool*);
1434: /*E
1435: PetscDataType - Used for handling different basic data types.
1437: Level: beginner
1439: Developer comment: It would be nice if we could always just use MPI Datatypes, why can we not?
1441: .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscDataTypeToMPIDataType(),
1442: PetscDataTypeGetSize()
1444: E*/
1445: typedef enum {PETSC_INT = 0,PETSC_DOUBLE = 1,PETSC_COMPLEX = 2, PETSC_LONG = 3 ,PETSC_SHORT = 4,PETSC_FLOAT = 5,
1446: 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;
1447: PETSC_EXTERN const char *const PetscDataTypes[];
1449: #if defined(PETSC_USE_COMPLEX)
1450: #define PETSC_SCALAR PETSC_COMPLEX
1451: #else
1452: #if defined(PETSC_USE_REAL_SINGLE)
1453: #define PETSC_SCALAR PETSC_FLOAT
1454: #elif defined(PETSC_USE_REAL___FLOAT128)
1455: #define PETSC_SCALAR PETSC___FLOAT128
1456: #elif defined(PETSC_USE_REAL___FP16)
1457: #define PETSC_SCALAR PETSC___FP16
1458: #else
1459: #define PETSC_SCALAR PETSC_DOUBLE
1460: #endif
1461: #endif
1462: #if defined(PETSC_USE_REAL_SINGLE)
1463: #define PETSC_REAL PETSC_FLOAT
1464: #elif defined(PETSC_USE_REAL___FLOAT128)
1465: #define PETSC_REAL PETSC___FLOAT128
1466: #elif defined(PETSC_USE_REAL___FP16)
1467: #define PETSC_REAL PETSC___FP16
1468: #else
1469: #define PETSC_REAL PETSC_DOUBLE
1470: #endif
1471: #define PETSC_FORTRANADDR PETSC_LONG
1473: PETSC_EXTERN PetscErrorCode PetscDataTypeToMPIDataType(PetscDataType,MPI_Datatype*);
1474: PETSC_EXTERN PetscErrorCode PetscMPIDataTypeToPetscDataType(MPI_Datatype,PetscDataType*);
1475: PETSC_EXTERN PetscErrorCode PetscDataTypeGetSize(PetscDataType,size_t*);
1476: PETSC_EXTERN PetscErrorCode PetscDataTypeFromString(const char*,PetscDataType*,PetscBool*);
1478: /*
1479: Basic memory and string operations. These are usually simple wrappers
1480: around the basic Unix system calls, but a few of them have additional
1481: functionality and/or error checking.
1482: */
1483: PETSC_EXTERN PetscErrorCode PetscBitMemcpy(void*,PetscInt,const void*,PetscInt,PetscInt,PetscDataType);
1484: PETSC_EXTERN PetscErrorCode PetscMemmove(void*,void *,size_t);
1485: PETSC_EXTERN PetscErrorCode PetscMemcmp(const void*,const void*,size_t,PetscBool *);
1486: PETSC_EXTERN PetscErrorCode PetscStrlen(const char[],size_t*);
1487: PETSC_EXTERN PetscErrorCode PetscStrToArray(const char[],char,int*,char ***);
1488: PETSC_EXTERN PetscErrorCode PetscStrToArrayDestroy(int,char **);
1489: PETSC_EXTERN PetscErrorCode PetscStrcmp(const char[],const char[],PetscBool *);
1490: PETSC_EXTERN PetscErrorCode PetscStrgrt(const char[],const char[],PetscBool *);
1491: PETSC_EXTERN PetscErrorCode PetscStrcasecmp(const char[],const char[],PetscBool *);
1492: PETSC_EXTERN PetscErrorCode PetscStrncmp(const char[],const char[],size_t,PetscBool *);
1493: PETSC_EXTERN PetscErrorCode PetscStrcpy(char[],const char[]);
1494: PETSC_EXTERN PetscErrorCode PetscStrcat(char[],const char[]);
1495: PETSC_EXTERN PetscErrorCode PetscStrncat(char[],const char[],size_t);
1496: PETSC_EXTERN PetscErrorCode PetscStrncpy(char[],const char[],size_t);
1497: PETSC_EXTERN PetscErrorCode PetscStrchr(const char[],char,char *[]);
1498: PETSC_EXTERN PetscErrorCode PetscStrtolower(char[]);
1499: PETSC_EXTERN PetscErrorCode PetscStrtoupper(char[]);
1500: PETSC_EXTERN PetscErrorCode PetscStrrchr(const char[],char,char *[]);
1501: PETSC_EXTERN PetscErrorCode PetscStrstr(const char[],const char[],char *[]);
1502: PETSC_EXTERN PetscErrorCode PetscStrrstr(const char[],const char[],char *[]);
1503: PETSC_EXTERN PetscErrorCode PetscStrendswith(const char[],const char[],PetscBool*);
1504: PETSC_EXTERN PetscErrorCode PetscStrbeginswith(const char[],const char[],PetscBool*);
1505: PETSC_EXTERN PetscErrorCode PetscStrendswithwhich(const char[],const char *const*,PetscInt*);
1506: PETSC_EXTERN PetscErrorCode PetscStrallocpy(const char[],char *[]);
1507: PETSC_EXTERN PetscErrorCode PetscStrArrayallocpy(const char *const*,char***);
1508: PETSC_EXTERN PetscErrorCode PetscStrArrayDestroy(char***);
1509: PETSC_EXTERN PetscErrorCode PetscStrNArrayallocpy(PetscInt,const char *const*,char***);
1510: PETSC_EXTERN PetscErrorCode PetscStrNArrayDestroy(PetscInt,char***);
1511: PETSC_EXTERN PetscErrorCode PetscStrreplace(MPI_Comm,const char[],char[],size_t);
1513: PETSC_EXTERN void PetscStrcmpNoError(const char[],const char[],PetscBool *);
1515: /*S
1516: PetscToken - 'Token' used for managing tokenizing strings
1518: Level: intermediate
1520: .seealso: PetscTokenCreate(), PetscTokenFind(), PetscTokenDestroy()
1521: S*/
1522: typedef struct _p_PetscToken* PetscToken;
1524: PETSC_EXTERN PetscErrorCode PetscTokenCreate(const char[],const char,PetscToken*);
1525: PETSC_EXTERN PetscErrorCode PetscTokenFind(PetscToken,char *[]);
1526: PETSC_EXTERN PetscErrorCode PetscTokenDestroy(PetscToken*);
1528: PETSC_EXTERN PetscErrorCode PetscEListFind(PetscInt,const char *const*,const char*,PetscInt*,PetscBool*);
1529: PETSC_EXTERN PetscErrorCode PetscEnumFind(const char *const*,const char*,PetscEnum*,PetscBool*);
1531: /*
1532: These are MPI operations for MPI_Allreduce() etc
1533: */
1534: PETSC_EXTERN MPI_Op MPIU_MAXSUM_OP;
1535: #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
1536: PETSC_EXTERN MPI_Op MPIU_SUM;
1537: #else
1538: #define MPIU_SUM MPI_SUM
1539: #endif
1540: #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
1541: PETSC_EXTERN MPI_Op MPIU_MAX;
1542: PETSC_EXTERN MPI_Op MPIU_MIN;
1543: #else
1544: #define MPIU_MAX MPI_MAX
1545: #define MPIU_MIN MPI_MIN
1546: #endif
1547: PETSC_EXTERN PetscErrorCode PetscMaxSum(MPI_Comm,const PetscInt[],PetscInt*,PetscInt*);
1549: PETSC_EXTERN PetscErrorCode MPIULong_Send(void*,PetscInt,MPI_Datatype,PetscMPIInt,PetscMPIInt,MPI_Comm);
1550: PETSC_EXTERN PetscErrorCode MPIULong_Recv(void*,PetscInt,MPI_Datatype,PetscMPIInt,PetscMPIInt,MPI_Comm);
1552: /*S
1553: PetscObject - any PETSc object, PetscViewer, Mat, Vec, KSP etc
1555: Level: beginner
1557: Note: This is the base class from which all PETSc objects are derived from.
1559: .seealso: PetscObjectDestroy(), PetscObjectView(), PetscObjectGetName(), PetscObjectSetName(), PetscObjectReference(), PetscObjectDereference()
1560: S*/
1561: typedef struct _p_PetscObject* PetscObject;
1563: /*MC
1564: PetscObjectId - unique integer Id for a PetscObject
1566: Level: developer
1568: Notes: Unlike pointer values, object ids are never reused.
1570: .seealso: PetscObjectState, PetscObjectGetId()
1571: M*/
1572: #if defined(PETSC_USING_F90) && !defined(PETSC_USE_FORTRANKIND) /* compaq F90 */
1573: typedef int PetscObjectId;
1574: #else
1575: typedef PetscInt64 PetscObjectId;
1576: #endif
1578: /*MC
1579: PetscObjectState - integer state for a PetscObject
1581: Level: developer
1583: Notes:
1584: Object state is always-increasing and (for objects that track state) can be used to determine if an object has
1585: changed since the last time you interacted with it. It is 64-bit so that it will not overflow for a very long time.
1587: .seealso: PetscObjectId, PetscObjectStateGet(), PetscObjectStateIncrease(), PetscObjectStateSet()
1588: M*/
1589: #if defined(PETSC_USING_F90) && !defined(PETSC_USE_FORTRANKIND) /* compaq F90 */
1590: typedef int PetscObjectState;
1591: #else
1592: typedef PetscInt64 PetscObjectState;
1593: #endif
1595: /*S
1596: PetscFunctionList - Linked list of functions, possibly stored in dynamic libraries, accessed
1597: by string name
1599: Level: advanced
1601: .seealso: PetscFunctionListAdd(), PetscFunctionListDestroy(), PetscOpFlist
1602: S*/
1603: typedef struct _n_PetscFunctionList *PetscFunctionList;
1605: /*E
1606: PetscFileMode - Access mode for a file.
1608: Level: beginner
1610: $ FILE_MODE_READ - open a file at its beginning for reading
1611: $ FILE_MODE_WRITE - open a file at its beginning for writing (will create if the file does not exist)
1612: $ FILE_MODE_APPEND - open a file at end for writing
1613: $ FILE_MODE_UPDATE - open a file for updating, meaning for reading and writing
1614: $ FILE_MODE_APPEND_UPDATE - open a file for updating, meaning for reading and writing, at the end
1616: .seealso: PetscViewerFileSetMode()
1617: E*/
1618: typedef enum {FILE_MODE_READ, FILE_MODE_WRITE, FILE_MODE_APPEND, FILE_MODE_UPDATE, FILE_MODE_APPEND_UPDATE} PetscFileMode;
1619: extern const char *const PetscFileModes[];
1621: /*
1622: Defines PETSc error handling.
1623: */
1624: #include <petscerror.h>
1626: #define PETSC_SMALLEST_CLASSID 1211211
1627: PETSC_EXTERN PetscClassId PETSC_LARGEST_CLASSID;
1628: PETSC_EXTERN PetscClassId PETSC_OBJECT_CLASSID;
1629: PETSC_EXTERN PetscErrorCode PetscClassIdRegister(const char[],PetscClassId *);
1631: /*
1632: Routines that get memory usage information from the OS
1633: */
1634: PETSC_EXTERN PetscErrorCode PetscMemoryGetCurrentUsage(PetscLogDouble *);
1635: PETSC_EXTERN PetscErrorCode PetscMemoryGetMaximumUsage(PetscLogDouble *);
1636: PETSC_EXTERN PetscErrorCode PetscMemorySetGetMaximumUsage(void);
1637: PETSC_EXTERN PetscErrorCode PetscMemoryTrace(const char[]);
1639: PETSC_EXTERN PetscErrorCode PetscInfoAllow(PetscBool ,const char []);
1640: PETSC_EXTERN PetscErrorCode PetscSleep(PetscReal);
1642: /*
1643: Initialization of PETSc
1644: */
1645: PETSC_EXTERN PetscErrorCode PetscInitialize(int*,char***,const char[],const char[]);
1646: PETSC_EXTERN PetscErrorCode PetscInitializeNoPointers(int,char**,const char[],const char[]);
1647: PETSC_EXTERN PetscErrorCode PetscInitializeNoArguments(void);
1648: PETSC_EXTERN PetscErrorCode PetscInitialized(PetscBool *);
1649: PETSC_EXTERN PetscErrorCode PetscFinalized(PetscBool *);
1650: PETSC_EXTERN PetscErrorCode PetscFinalize(void);
1651: PETSC_EXTERN PetscErrorCode PetscInitializeFortran(void);
1652: PETSC_EXTERN PetscErrorCode PetscGetArgs(int*,char ***);
1653: PETSC_EXTERN PetscErrorCode PetscGetArguments(char ***);
1654: PETSC_EXTERN PetscErrorCode PetscFreeArguments(char **);
1656: PETSC_EXTERN PetscErrorCode PetscEnd(void);
1657: PETSC_EXTERN PetscErrorCode PetscSysInitializePackage(void);
1659: PETSC_EXTERN PetscErrorCode PetscPythonInitialize(const char[],const char[]);
1660: PETSC_EXTERN PetscErrorCode PetscPythonFinalize(void);
1661: PETSC_EXTERN PetscErrorCode PetscPythonPrintError(void);
1662: PETSC_EXTERN PetscErrorCode PetscPythonMonitorSet(PetscObject,const char[]);
1664: /*
1665: These are so that in extern C code we can caste function pointers to non-extern C
1666: function pointers. Since the regular C++ code expects its function pointers to be C++
1667: */
1668: PETSC_EXTERN_TYPEDEF typedef void (**PetscVoidStarFunction)(void);
1669: PETSC_EXTERN_TYPEDEF typedef void (*PetscVoidFunction)(void);
1670: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*PetscErrorCodeFunction)(void);
1672: /*
1673: Functions that can act on any PETSc object.
1674: */
1675: PETSC_EXTERN PetscErrorCode PetscObjectDestroy(PetscObject*);
1676: PETSC_EXTERN PetscErrorCode PetscObjectGetComm(PetscObject,MPI_Comm *);
1677: PETSC_EXTERN PetscErrorCode PetscObjectGetClassId(PetscObject,PetscClassId *);
1678: PETSC_EXTERN PetscErrorCode PetscObjectGetClassName(PetscObject,const char *[]);
1679: PETSC_EXTERN PetscErrorCode PetscObjectSetType(PetscObject,const char []);
1680: PETSC_EXTERN PetscErrorCode PetscObjectGetType(PetscObject,const char *[]);
1681: PETSC_EXTERN PetscErrorCode PetscObjectSetName(PetscObject,const char[]);
1682: PETSC_EXTERN PetscErrorCode PetscObjectGetName(PetscObject,const char*[]);
1683: PETSC_EXTERN PetscErrorCode PetscObjectSetTabLevel(PetscObject,PetscInt);
1684: PETSC_EXTERN PetscErrorCode PetscObjectGetTabLevel(PetscObject,PetscInt*);
1685: PETSC_EXTERN PetscErrorCode PetscObjectIncrementTabLevel(PetscObject,PetscObject,PetscInt);
1686: PETSC_EXTERN PetscErrorCode PetscObjectReference(PetscObject);
1687: PETSC_EXTERN PetscErrorCode PetscObjectGetReference(PetscObject,PetscInt*);
1688: PETSC_EXTERN PetscErrorCode PetscObjectDereference(PetscObject);
1689: PETSC_EXTERN PetscErrorCode PetscObjectGetNewTag(PetscObject,PetscMPIInt *);
1690: PETSC_EXTERN PetscErrorCode PetscObjectCompose(PetscObject,const char[],PetscObject);
1691: PETSC_EXTERN PetscErrorCode PetscObjectRemoveReference(PetscObject,const char[]);
1692: PETSC_EXTERN PetscErrorCode PetscObjectQuery(PetscObject,const char[],PetscObject *);
1693: PETSC_EXTERN PetscErrorCode PetscObjectComposeFunction_Private(PetscObject,const char[],void (*)(void));
1694: #define PetscObjectComposeFunction(a,b,d) PetscObjectComposeFunction_Private(a,b,(PetscVoidFunction)(d))
1695: PETSC_EXTERN PetscErrorCode PetscObjectSetFromOptions(PetscObject);
1696: PETSC_EXTERN PetscErrorCode PetscObjectSetUp(PetscObject);
1697: PETSC_EXTERN PetscErrorCode PetscObjectSetPrintedOptions(PetscObject);
1698: PETSC_EXTERN PetscErrorCode PetscObjectInheritPrintedOptions(PetscObject,PetscObject);
1699: PETSC_EXTERN PetscErrorCode PetscCommGetNewTag(MPI_Comm,PetscMPIInt *);
1701: #include <petscviewertypes.h>
1702: #include <petscoptions.h>
1704: PETSC_EXTERN PetscErrorCode PetscObjectsListGetGlobalNumbering(MPI_Comm,PetscInt,PetscObject*,PetscInt*,PetscInt*);
1706: PETSC_EXTERN PetscErrorCode PetscMemoryShowUsage(PetscViewer,const char[]);
1707: PETSC_EXTERN PetscErrorCode PetscMemoryView(PetscViewer,const char[]);
1708: PETSC_EXTERN PetscErrorCode PetscObjectPrintClassNamePrefixType(PetscObject,PetscViewer);
1709: PETSC_EXTERN PetscErrorCode PetscObjectView(PetscObject,PetscViewer);
1710: #define PetscObjectQueryFunction(obj,name,fptr) PetscObjectQueryFunction_Private((obj),(name),(PetscVoidFunction*)(fptr))
1711: PETSC_EXTERN PetscErrorCode PetscObjectQueryFunction_Private(PetscObject,const char[],void (**)(void));
1712: PETSC_EXTERN PetscErrorCode PetscObjectSetOptionsPrefix(PetscObject,const char[]);
1713: PETSC_EXTERN PetscErrorCode PetscObjectAppendOptionsPrefix(PetscObject,const char[]);
1714: PETSC_EXTERN PetscErrorCode PetscObjectPrependOptionsPrefix(PetscObject,const char[]);
1715: PETSC_EXTERN PetscErrorCode PetscObjectGetOptionsPrefix(PetscObject,const char*[]);
1716: PETSC_EXTERN PetscErrorCode PetscObjectChangeTypeName(PetscObject,const char[]);
1717: PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroy(PetscObject);
1718: PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroyAll(void);
1719: PETSC_EXTERN PetscErrorCode PetscObjectViewFromOptions(PetscObject,PetscObject,const char[]);
1720: PETSC_EXTERN PetscErrorCode PetscObjectName(PetscObject);
1721: PETSC_EXTERN PetscErrorCode PetscObjectTypeCompare(PetscObject,const char[],PetscBool *);
1722: PETSC_EXTERN PetscErrorCode PetscObjectBaseTypeCompare(PetscObject,const char[],PetscBool *);
1723: PETSC_EXTERN PetscErrorCode PetscObjectTypeCompareAny(PetscObject,PetscBool*,const char[],...);
1724: PETSC_EXTERN PetscErrorCode PetscRegisterFinalize(PetscErrorCode (*)(void));
1725: PETSC_EXTERN PetscErrorCode PetscRegisterFinalizeAll(void);
1727: #if defined(PETSC_HAVE_SAWS)
1728: PETSC_EXTERN PetscErrorCode PetscSAWsBlock(void);
1729: PETSC_EXTERN PetscErrorCode PetscObjectSAWsViewOff(PetscObject);
1730: PETSC_EXTERN PetscErrorCode PetscObjectSAWsSetBlock(PetscObject,PetscBool);
1731: PETSC_EXTERN PetscErrorCode PetscObjectSAWsBlock(PetscObject);
1732: PETSC_EXTERN PetscErrorCode PetscObjectSAWsGrantAccess(PetscObject);
1733: PETSC_EXTERN PetscErrorCode PetscObjectSAWsTakeAccess(PetscObject);
1734: PETSC_EXTERN void PetscStackSAWsGrantAccess(void);
1735: PETSC_EXTERN void PetscStackSAWsTakeAccess(void);
1736: PETSC_EXTERN PetscErrorCode PetscStackViewSAWs(void);
1737: PETSC_EXTERN PetscErrorCode PetscStackSAWsViewOff(void);
1739: #else
1740: #define PetscSAWsBlock() 0
1741: #define PetscObjectSAWsViewOff(obj) 0
1742: #define PetscObjectSAWsSetBlock(obj,flg) 0
1743: #define PetscObjectSAWsBlock(obj) 0
1744: #define PetscObjectSAWsGrantAccess(obj) 0
1745: #define PetscObjectSAWsTakeAccess(obj) 0
1746: #define PetscStackViewSAWs() 0
1747: #define PetscStackSAWsViewOff() 0
1748: #define PetscStackSAWsTakeAccess()
1749: #define PetscStackSAWsGrantAccess()
1751: #endif
1753: typedef void* PetscDLHandle;
1754: typedef enum {PETSC_DL_DECIDE=0,PETSC_DL_NOW=1,PETSC_DL_LOCAL=2} PetscDLMode;
1755: PETSC_EXTERN PetscErrorCode PetscDLOpen(const char[],PetscDLMode,PetscDLHandle *);
1756: PETSC_EXTERN PetscErrorCode PetscDLClose(PetscDLHandle *);
1757: PETSC_EXTERN PetscErrorCode PetscDLSym(PetscDLHandle,const char[],void **);
1759: #if defined(PETSC_USE_DEBUG)
1760: PETSC_EXTERN PetscErrorCode PetscMallocGetStack(void*,PetscStack**);
1761: #endif
1762: PETSC_EXTERN PetscErrorCode PetscObjectsDump(FILE*,PetscBool);
1764: /*S
1765: PetscObjectList - Linked list of PETSc objects, each accessable by string name
1767: Level: developer
1769: Notes: Used by PetscObjectCompose() and PetscObjectQuery()
1771: .seealso: PetscObjectListAdd(), PetscObjectListDestroy(), PetscObjectListFind(), PetscObjectCompose(), PetscObjectQuery(), PetscFunctionList
1772: S*/
1773: typedef struct _n_PetscObjectList *PetscObjectList;
1775: PETSC_EXTERN PetscErrorCode PetscObjectListDestroy(PetscObjectList*);
1776: PETSC_EXTERN PetscErrorCode PetscObjectListFind(PetscObjectList,const char[],PetscObject*);
1777: PETSC_EXTERN PetscErrorCode PetscObjectListReverseFind(PetscObjectList,PetscObject,char**,PetscBool*);
1778: PETSC_EXTERN PetscErrorCode PetscObjectListAdd(PetscObjectList *,const char[],PetscObject);
1779: PETSC_EXTERN PetscErrorCode PetscObjectListRemoveReference(PetscObjectList *,const char[]);
1780: PETSC_EXTERN PetscErrorCode PetscObjectListDuplicate(PetscObjectList,PetscObjectList *);
1782: /*
1783: Dynamic library lists. Lists of names of routines in objects or in dynamic
1784: link libraries that will be loaded as needed.
1785: */
1787: #define PetscFunctionListAdd(list,name,fptr) PetscFunctionListAdd_Private((list),(name),(PetscVoidFunction)(fptr))
1788: PETSC_EXTERN PetscErrorCode PetscFunctionListAdd_Private(PetscFunctionList*,const char[],void (*)(void));
1789: PETSC_EXTERN PetscErrorCode PetscFunctionListDestroy(PetscFunctionList*);
1790: #define PetscFunctionListFind(list,name,fptr) PetscFunctionListFind_Private((list),(name),(PetscVoidFunction*)(fptr))
1791: PETSC_EXTERN PetscErrorCode PetscFunctionListFind_Private(PetscFunctionList,const char[],void (**)(void));
1792: PETSC_EXTERN PetscErrorCode PetscFunctionListPrintTypes(MPI_Comm,FILE*,const char[],const char[],const char[],const char[],PetscFunctionList,const char[]);
1793: PETSC_EXTERN PetscErrorCode PetscFunctionListDuplicate(PetscFunctionList,PetscFunctionList *);
1794: PETSC_EXTERN PetscErrorCode PetscFunctionListView(PetscFunctionList,PetscViewer);
1795: PETSC_EXTERN PetscErrorCode PetscFunctionListGet(PetscFunctionList,const char ***,int*);
1797: /*S
1798: PetscDLLibrary - Linked list of dynamics libraries to search for functions
1800: Level: advanced
1802: .seealso: PetscDLLibraryOpen()
1803: S*/
1804: typedef struct _n_PetscDLLibrary *PetscDLLibrary;
1805: PETSC_EXTERN PetscDLLibrary PetscDLLibrariesLoaded;
1806: PETSC_EXTERN PetscErrorCode PetscDLLibraryAppend(MPI_Comm,PetscDLLibrary *,const char[]);
1807: PETSC_EXTERN PetscErrorCode PetscDLLibraryPrepend(MPI_Comm,PetscDLLibrary *,const char[]);
1808: PETSC_EXTERN PetscErrorCode PetscDLLibrarySym(MPI_Comm,PetscDLLibrary *,const char[],const char[],void **);
1809: PETSC_EXTERN PetscErrorCode PetscDLLibraryPrintPath(PetscDLLibrary);
1810: PETSC_EXTERN PetscErrorCode PetscDLLibraryRetrieve(MPI_Comm,const char[],char *,size_t,PetscBool *);
1811: PETSC_EXTERN PetscErrorCode PetscDLLibraryOpen(MPI_Comm,const char[],PetscDLLibrary *);
1812: PETSC_EXTERN PetscErrorCode PetscDLLibraryClose(PetscDLLibrary);
1814: /*
1815: Useful utility routines
1816: */
1817: PETSC_EXTERN PetscErrorCode PetscSplitOwnership(MPI_Comm,PetscInt*,PetscInt*);
1818: PETSC_EXTERN PetscErrorCode PetscSplitOwnershipBlock(MPI_Comm,PetscInt,PetscInt*,PetscInt*);
1819: PETSC_EXTERN PetscErrorCode PetscSequentialPhaseBegin(MPI_Comm,PetscMPIInt);
1820: PETSC_EXTERN PetscErrorCode PetscSequentialPhaseEnd(MPI_Comm,PetscMPIInt);
1821: PETSC_EXTERN PetscErrorCode PetscBarrier(PetscObject);
1822: PETSC_EXTERN PetscErrorCode PetscMPIDump(FILE*);
1824: /*
1825: PetscNot - negates a logical type value and returns result as a PetscBool
1827: Notes: This is useful in cases like
1828: $ int *a;
1829: $ PetscBool flag = PetscNot(a)
1830: where !a would not return a PetscBool because we cannot provide a cast from int to PetscBool in C.
1831: */
1832: #define PetscNot(a) ((a) ? PETSC_FALSE : PETSC_TRUE)
1834: /*MC
1835: PetscHelpPrintf - Prints help messages.
1837: Synopsis:
1838: #include <petscsys.h>
1839: PetscErrorCode (*PetscHelpPrintf)(const char format[],...);
1841: Not Collective
1843: Input Parameters:
1844: . format - the usual printf() format string
1846: Level: developer
1848: Fortran Note:
1849: This routine is not supported in Fortran.
1851: Concepts: help messages^printing
1852: Concepts: printing^help messages
1854: .seealso: PetscFPrintf(), PetscSynchronizedPrintf(), PetscErrorPrintf()
1855: M*/
1856: PETSC_EXTERN PetscErrorCode (*PetscHelpPrintf)(MPI_Comm,const char[],...);
1858: /*
1859: Defines PETSc profiling.
1860: */
1861: #include <petsclog.h>
1863: /*
1864: Simple PETSc parallel IO for ASCII printing
1865: */
1866: PETSC_EXTERN PetscErrorCode PetscFixFilename(const char[],char[]);
1867: PETSC_EXTERN PetscErrorCode PetscFOpen(MPI_Comm,const char[],const char[],FILE**);
1868: PETSC_EXTERN PetscErrorCode PetscFClose(MPI_Comm,FILE*);
1869: PETSC_EXTERN PetscErrorCode PetscFPrintf(MPI_Comm,FILE*,const char[],...);
1870: PETSC_EXTERN PetscErrorCode PetscPrintf(MPI_Comm,const char[],...);
1871: PETSC_EXTERN PetscErrorCode PetscSNPrintf(char*,size_t,const char [],...);
1872: PETSC_EXTERN PetscErrorCode PetscSNPrintfCount(char*,size_t,const char [],size_t*,...);
1874: PETSC_EXTERN PetscErrorCode PetscErrorPrintfDefault(const char [],...);
1875: PETSC_EXTERN PetscErrorCode PetscErrorPrintfNone(const char [],...);
1876: PETSC_EXTERN PetscErrorCode PetscHelpPrintfDefault(MPI_Comm,const char [],...);
1878: #if defined(PETSC_HAVE_POPEN)
1879: PETSC_EXTERN PetscErrorCode PetscPOpen(MPI_Comm,const char[],const char[],const char[],FILE **);
1880: PETSC_EXTERN PetscErrorCode PetscPClose(MPI_Comm,FILE*,int*);
1881: PETSC_EXTERN PetscErrorCode PetscPOpenSetMachine(const char[]);
1882: #endif
1884: PETSC_EXTERN PetscErrorCode PetscSynchronizedPrintf(MPI_Comm,const char[],...);
1885: PETSC_EXTERN PetscErrorCode PetscSynchronizedFPrintf(MPI_Comm,FILE*,const char[],...);
1886: PETSC_EXTERN PetscErrorCode PetscSynchronizedFlush(MPI_Comm,FILE*);
1887: PETSC_EXTERN PetscErrorCode PetscSynchronizedFGets(MPI_Comm,FILE*,size_t,char[]);
1888: PETSC_EXTERN PetscErrorCode PetscStartMatlab(MPI_Comm,const char[],const char[],FILE**);
1889: PETSC_EXTERN PetscErrorCode PetscStartJava(MPI_Comm,const char[],const char[],FILE**);
1890: PETSC_EXTERN PetscErrorCode PetscGetPetscDir(const char*[]);
1892: PETSC_EXTERN PetscErrorCode PetscPopUpSelect(MPI_Comm,const char*,const char*,int,const char**,int*);
1894: /*S
1895: PetscContainer - Simple PETSc object that contains a pointer to any required data
1897: Level: advanced
1899: .seealso: PetscObject, PetscContainerCreate()
1900: S*/
1901: PETSC_EXTERN PetscClassId PETSC_CONTAINER_CLASSID;
1902: typedef struct _p_PetscContainer* PetscContainer;
1903: PETSC_EXTERN PetscErrorCode PetscContainerGetPointer(PetscContainer,void **);
1904: PETSC_EXTERN PetscErrorCode PetscContainerSetPointer(PetscContainer,void *);
1905: PETSC_EXTERN PetscErrorCode PetscContainerDestroy(PetscContainer*);
1906: PETSC_EXTERN PetscErrorCode PetscContainerCreate(MPI_Comm,PetscContainer *);
1907: PETSC_EXTERN PetscErrorCode PetscContainerSetUserDestroy(PetscContainer, PetscErrorCode (*)(void*));
1908: PETSC_EXTERN PetscErrorCode PetscContainerUserDestroyDefault(void*);
1910: /*
1911: For use in debuggers
1912: */
1913: PETSC_EXTERN PetscMPIInt PetscGlobalRank;
1914: PETSC_EXTERN PetscMPIInt PetscGlobalSize;
1915: PETSC_EXTERN PetscErrorCode PetscIntView(PetscInt,const PetscInt[],PetscViewer);
1916: PETSC_EXTERN PetscErrorCode PetscRealView(PetscInt,const PetscReal[],PetscViewer);
1917: PETSC_EXTERN PetscErrorCode PetscScalarView(PetscInt,const PetscScalar[],PetscViewer);
1919: #include <stddef.h>
1920: #include <string.h> /* for memcpy, memset */
1921: #if defined(PETSC_HAVE_STDLIB_H)
1922: #include <stdlib.h>
1923: #endif
1925: #if defined(PETSC_HAVE_XMMINTRIN_H) && !defined(__CUDACC__)
1926: #include <xmmintrin.h>
1927: #endif
1929: /*@C
1930: PetscMemcpy - Copies n bytes, beginning at location b, to the space
1931: beginning at location a. The two memory regions CANNOT overlap, use
1932: PetscMemmove() in that case.
1934: Not Collective
1936: Input Parameters:
1937: + b - pointer to initial memory space
1938: - n - length (in bytes) of space to copy
1940: Output Parameter:
1941: . a - pointer to copy space
1943: Level: intermediate
1945: Compile Option:
1946: PETSC_PREFER_DCOPY_FOR_MEMCPY will cause the BLAS dcopy() routine to be used
1947: for memory copies on double precision values.
1948: PETSC_PREFER_COPY_FOR_MEMCPY will cause C code to be used
1949: for memory copies on double precision values.
1950: PETSC_PREFER_FORTRAN_FORMEMCPY will cause Fortran code to be used
1951: for memory copies on double precision values.
1953: Note:
1954: This routine is analogous to memcpy().
1956: Developer Note: this is inlined for fastest performance
1958: Concepts: memory^copying
1959: Concepts: copying^memory
1961: .seealso: PetscMemmove()
1963: @*/
1964: PETSC_STATIC_INLINE PetscErrorCode PetscMemcpy(void *a,const void *b,size_t n)
1965: {
1966: #if defined(PETSC_USE_DEBUG)
1967: size_t al = (size_t) a,bl = (size_t) b;
1968: size_t nl = (size_t) n;
1970: if (n > 0 && !b) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy from a null pointer");
1971: if (n > 0 && !a) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy to a null pointer");
1972: #else
1974: #endif
1975: if (a != b && n > 0) {
1976: #if defined(PETSC_USE_DEBUG)
1977: if ((al > bl && (al - bl) < nl) || (bl - al) < nl) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_ARG_INCOMP,"Memory regions overlap: either use PetscMemmov()\n\
1978: or make sure your copy regions and lengths are correct. \n\
1979: Length (bytes) %ld first address %ld second address %ld",nl,al,bl);
1980: #endif
1981: #if (defined(PETSC_PREFER_DCOPY_FOR_MEMCPY) || defined(PETSC_PREFER_COPY_FOR_MEMCPY) || defined(PETSC_PREFER_FORTRAN_FORMEMCPY))
1982: if (!(a % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) {
1983: size_t len = n/sizeof(PetscScalar);
1984: #if defined(PETSC_PREFER_DCOPY_FOR_MEMCPY)
1985: PetscBLASInt one = 1,blen;
1987: PetscBLASIntCast(len,&blen);
1988: PetscStackCallBLAS("BLAScopy",BLAScopy_(&blen,(PetscScalar *)b,&one,(PetscScalar *)a,&one));
1989: #elif defined(PETSC_PREFER_FORTRAN_FORMEMCPY)
1990: fortrancopy_(&len,(PetscScalar*)b,(PetscScalar*)a);
1991: #else
1992: size_t i;
1993: PetscScalar *x = (PetscScalar*)b, *y = (PetscScalar*)a;
1994: for (i=0; i<len; i++) y[i] = x[i];
1995: #endif
1996: } else {
1997: memcpy((char*)(a),(char*)(b),n);
1998: }
1999: #else
2000: memcpy((char*)(a),(char*)(b),n);
2001: #endif
2002: }
2003: return(0);
2004: }
2006: /*@C
2007: PetscMemzero - Zeros the specified memory.
2009: Not Collective
2011: Input Parameters:
2012: + a - pointer to beginning memory location
2013: - n - length (in bytes) of memory to initialize
2015: Level: intermediate
2017: Compile Option:
2018: PETSC_PREFER_BZERO - on certain machines (the IBM RS6000) the bzero() routine happens
2019: to be faster than the memset() routine. This flag causes the bzero() routine to be used.
2021: Developer Note: this is inlined for fastest performance
2023: Concepts: memory^zeroing
2024: Concepts: zeroing^memory
2026: .seealso: PetscMemcpy()
2027: @*/
2028: PETSC_STATIC_INLINE PetscErrorCode PetscMemzero(void *a,size_t n)
2029: {
2030: if (n > 0) {
2031: #if defined(PETSC_USE_DEBUG)
2032: if (!a) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to zero at a null pointer");
2033: #endif
2034: #if defined(PETSC_PREFER_ZERO_FOR_MEMZERO)
2035: if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) {
2036: size_t i,len = n/sizeof(PetscScalar);
2037: PetscScalar *x = (PetscScalar*)a;
2038: for (i=0; i<len; i++) x[i] = 0.0;
2039: } else {
2040: #elif defined(PETSC_PREFER_FORTRAN_FOR_MEMZERO)
2041: if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) {
2042: PetscInt len = n/sizeof(PetscScalar);
2043: fortranzero_(&len,(PetscScalar*)a);
2044: } else {
2045: #endif
2046: #if defined(PETSC_PREFER_BZERO)
2047: bzero((char *)a,n);
2048: #else
2049: memset((char*)a,0,n);
2050: #endif
2051: #if defined(PETSC_PREFER_ZERO_FOR_MEMZERO) || defined(PETSC_PREFER_FORTRAN_FOR_MEMZERO)
2052: }
2053: #endif
2054: }
2055: return 0;
2056: }
2058: /*MC
2059: PetscPrefetchBlock - Prefetches a block of memory
2061: Synopsis:
2062: #include <petscsys.h>
2063: void PetscPrefetchBlock(const anytype *a,size_t n,int rw,int t)
2065: Not Collective
2067: Input Parameters:
2068: + a - pointer to first element to fetch (any type but usually PetscInt or PetscScalar)
2069: . n - number of elements to fetch
2070: . rw - 1 if the memory will be written to, otherwise 0 (ignored by many processors)
2071: - t - temporal locality (PETSC_PREFETCH_HINT_{NTA,T0,T1,T2}), see note
2073: Level: developer
2075: Notes:
2076: The last two arguments (rw and t) must be compile-time constants.
2078: Adopting Intel's x86/x86-64 conventions, there are four levels of temporal locality. Not all architectures offer
2079: equivalent locality hints, but the following macros are always defined to their closest analogue.
2080: + PETSC_PREFETCH_HINT_NTA - Non-temporal. Prefetches directly to L1, evicts to memory (skips higher level cache unless it was already there when prefetched).
2081: . 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.
2082: . PETSC_PREFETCH_HINT_T1 - Fetch to level 2 and higher (not L1).
2083: - PETSC_PREFETCH_HINT_T2 - Fetch to high-level cache only. (On many systems, T0 and T1 are equivalent.)
2085: This function does nothing on architectures that do not support prefetch and never errors (even if passed an invalid
2086: address).
2088: Concepts: memory
2089: M*/
2090: #define PetscPrefetchBlock(a,n,rw,t) do { \
2091: const char *_p = (const char*)(a),*_end = (const char*)((a)+(n)); \
2092: for ( ; _p < _end; _p += PETSC_LEVEL1_DCACHE_LINESIZE) PETSC_Prefetch(_p,(rw),(t)); \
2093: } while (0)
2095: /*
2096: Determine if some of the kernel computation routines use
2097: Fortran (rather than C) for the numerical calculations. On some machines
2098: and compilers (like complex numbers) the Fortran version of the routines
2099: is faster than the C/C++ versions. The flag --with-fortran-kernels
2100: should be used with ./configure to turn these on.
2101: */
2102: #if defined(PETSC_USE_FORTRAN_KERNELS)
2104: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTCRL)
2105: #define PETSC_USE_FORTRAN_KERNEL_MULTCRL
2106: #endif
2108: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJPERM)
2109: #define PETSC_USE_FORTRAN_KERNEL_MULTAIJPERM
2110: #endif
2112: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJ)
2113: #define PETSC_USE_FORTRAN_KERNEL_MULTAIJ
2114: #endif
2116: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ)
2117: #define PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ
2118: #endif
2120: #if !defined(PETSC_USE_FORTRAN_KERNEL_NORM)
2121: #define PETSC_USE_FORTRAN_KERNEL_NORM
2122: #endif
2124: #if !defined(PETSC_USE_FORTRAN_KERNEL_MAXPY)
2125: #define PETSC_USE_FORTRAN_KERNEL_MAXPY
2126: #endif
2128: #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ)
2129: #define PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ
2130: #endif
2132: #if !defined(PETSC_USE_FORTRAN_KERNEL_RELAXAIJ)
2133: #define PETSC_USE_FORTRAN_KERNEL_RELAXAIJ
2134: #endif
2136: #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ)
2137: #define PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ
2138: #endif
2140: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ)
2141: #define PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ
2142: #endif
2144: #if !defined(PETSC_USE_FORTRAN_KERNEL_MDOT)
2145: #define PETSC_USE_FORTRAN_KERNEL_MDOT
2146: #endif
2148: #if !defined(PETSC_USE_FORTRAN_KERNEL_XTIMESY)
2149: #define PETSC_USE_FORTRAN_KERNEL_XTIMESY
2150: #endif
2152: #if !defined(PETSC_USE_FORTRAN_KERNEL_AYPX)
2153: #define PETSC_USE_FORTRAN_KERNEL_AYPX
2154: #endif
2156: #if !defined(PETSC_USE_FORTRAN_KERNEL_WAXPY)
2157: #define PETSC_USE_FORTRAN_KERNEL_WAXPY
2158: #endif
2160: #endif
2162: /*
2163: Macros for indicating code that should be compiled with a C interface,
2164: rather than a C++ interface. Any routines that are dynamically loaded
2165: (such as the PCCreate_XXX() routines) must be wrapped so that the name
2166: mangler does not change the functions symbol name. This just hides the
2167: ugly extern "C" {} wrappers.
2168: */
2169: #if defined(__cplusplus)
2170: #define EXTERN_C_BEGIN extern "C" {
2171: #define EXTERN_C_END }
2172: #else
2173: #define EXTERN_C_BEGIN
2174: #define EXTERN_C_END
2175: #endif
2177: /* --------------------------------------------------------------------*/
2179: /*MC
2180: MPI_Comm - the basic object used by MPI to determine which processes are involved in a
2181: communication
2183: Level: beginner
2185: Note: This manual page is a place-holder because MPICH does not have a manual page for MPI_Comm
2187: .seealso: PETSC_COMM_WORLD, PETSC_COMM_SELF
2188: M*/
2190: /*MC
2191: PetscScalar - PETSc type that represents either a double precision real number, a double precision
2192: complex number, a single precision real number, a __float128 real or complex or a __fp16 real - if the code is configured
2193: with --with-scalar-type=real,complex --with-precision=single,double,__float128,__fp16
2195: Notes: For MPI calls that require datatypes, use MPIU_SCALAR as the datatype for PetscScalar and MPIU_SUM, MPIU_MAX etc for operations.
2196: They will automatically work correctly regardless of the size of PetscScalar
2198: Level: beginner
2200: .seealso: PetscReal, MPIU_SCALAR, PetscInt, MPIU_REAL, PetscComplex, MPIU_INT
2201: M*/
2203: /*MC
2204: PetscComplex - PETSc type that represents a complex number with precision matching that of PetscReal.
2206: Synopsis:
2207: #include <petscsys.h>
2208: PetscComplex number = 1. + 2.*PETSC_i;
2210: Level: beginner
2212: Notes: For MPI calls that require datatypes, use MPIU_COMPLEX as the datatype for PetscComplex and MPIU_SUM etc for operations.
2213: They will automatically work correctly regardless of the size of PetscComplex
2215: See PetscScalar for details on how to ./configure the size of PetscReal
2217: Complex numbers are automatically available if PETSc was able to find a working complex implementation
2219: .seealso: PetscReal, PetscComplex, MPIU_COMPLEX, PetscInt, PETSC_i
2220: M*/
2222: /*MC
2223: PetscReal - PETSc type that represents a real number version of PetscScalar
2225: Level: beginner
2227: Notes: For MPI calls that require datatypes, use MPIU_REAL as the datatype for PetscScalar and MPIU_SUM, MPIU_MAX etc for operations.
2228: They will automatically work correctly regardless of the size of PetscReal
2230: See PetscScalar for details on how to ./configure the size of PetscReal
2232: .seealso: PetscScalar, PetscComplex, MPIU_REAL, MPIU_SCALAR
2233: M*/
2235: /*MC
2236: MPIU_SCALAR - MPI datatype corresponding to PetscScalar
2238: Level: beginner
2240: Note: In MPI calls that require an MPI datatype that matches a PetscScalar or array of PetscScalars
2241: pass this value
2243: .seealso: PetscReal, PetscScalar, MPIU_INT, MPIU_REAL, MPIU_COMPLEX
2244: M*/
2246: #if defined(PETSC_HAVE_MPIIO)
2247: #if !defined(PETSC_WORDS_BIGENDIAN)
2248: PETSC_EXTERN PetscErrorCode MPIU_File_write_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*);
2249: PETSC_EXTERN PetscErrorCode MPIU_File_read_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*);
2250: #else
2251: #define MPIU_File_write_all(a,b,c,d,e) MPI_File_write_all(a,b,c,d,e)
2252: #define MPIU_File_read_all(a,b,c,d,e) MPI_File_read_all(a,b,c,d,e)
2253: #endif
2254: #endif
2256: /* the following petsc_static_inline require petscerror.h */
2258: /* Limit MPI to 32-bits */
2259: #define PETSC_MPI_INT_MAX 2147483647
2260: #define PETSC_MPI_INT_MIN -2147483647
2261: /* Limit BLAS to 32-bits */
2262: #define PETSC_BLAS_INT_MAX 2147483647
2263: #define PETSC_BLAS_INT_MIN -2147483647
2265: /*@C
2266: PetscBLASIntCast - casts a PetscInt (which may be 64 bits in size) to a PetscBLASInt (which may be 32 bits in size), generates an
2267: error if the PetscBLASInt is not large enough to hold the number.
2269: Not Collective
2271: Input Parameter:
2272: . a - the PetscInt value
2274: Output Parameter:
2275: . b - the resulting PetscBLASInt value
2277: Level: advanced
2279: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscMPIIntCast()
2280: @*/
2281: PETSC_STATIC_INLINE PetscErrorCode PetscBLASIntCast(PetscInt a,PetscBLASInt *b)
2282: {
2284: *b = (PetscBLASInt)(a);
2285: #if defined(PETSC_USE_64BIT_INDICES) && !defined(PETSC_HAVE_64BIT_BLAS_INDICES)
2286: if ((a) > PETSC_BLAS_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array too long for BLAS/LAPACK");
2287: #endif
2288: return(0);
2289: }
2291: /*@C
2292: PetscMPIIntCast - casts a PetscInt (which may be 64 bits in size) to a PetscMPIInt (which may be 32 bits in size), generates an
2293: error if the PetscMPIInt is not large enough to hold the number.
2295: Not Collective
2297: Input Parameter:
2298: . a - the PetscInt value
2300: Output Parameter:
2301: . b - the resulting PetscMPIInt value
2303: Level: advanced
2305: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast()
2306: @*/
2307: PETSC_STATIC_INLINE PetscErrorCode PetscMPIIntCast(PetscInt a,PetscMPIInt *b)
2308: {
2310: *b = (PetscMPIInt)(a);
2311: #if defined(PETSC_USE_64BIT_INDICES)
2312: if ((a) > PETSC_MPI_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array too long for MPI");
2313: #endif
2314: return(0);
2315: }
2317: #define PetscInt64Mult(a,b) ((PetscInt64)(a))*((PetscInt64)(b))
2319: /*@C
2321: PetscRealIntMultTruncate - Computes the product of a positive PetscReal and a positive PetscInt and truncates the value to slightly less than the maximal possible value
2323: Not Collective
2325: Input Parameter:
2326: + a - the PetscReal value
2327: - b - the second value
2329: Returns:
2330: the result as a PetscInt value
2332: Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64
2333: Use PetscIntMultTruncate() to compute the product of two positive PetscInt and truncate to fit a PetscInt
2334: 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
2336: Developers Note: We currently assume that PetscInt addition can never overflow, this is obviously wrong but requires many more checks.
2338: This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able.
2340: Level: advanced
2342: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult()
2343: @*/
2344: PETSC_STATIC_INLINE PetscInt PetscRealIntMultTruncate(PetscReal a,PetscInt b)
2345: {
2346: PetscInt64 r;
2348: r = (PetscInt64) (a*(PetscReal)b);
2349: if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100;
2350: return (PetscInt) r;
2351: }
2353: /*@C
2355: PetscIntMultTruncate - Computes the product of two positive PetscInt and truncates the value to slightly less than the maximal possible value
2357: Not Collective
2359: Input Parameter:
2360: + a - the PetscInt value
2361: - b - the second value
2363: Returns:
2364: the result as a PetscInt value
2366: Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64
2367: Use PetscRealIntMultTruncate() to compute the product of a PetscReal and a PetscInt and truncate to fit a PetscInt
2368: 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
2370: Developers Note: We currently assume that PetscInt addition can never overflow, this is obviously wrong but requires many more checks.
2372: This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able.
2374: Level: advanced
2376: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult()
2377: @*/
2378: PETSC_STATIC_INLINE PetscInt PetscIntMultTruncate(PetscInt a,PetscInt b)
2379: {
2380: PetscInt64 r;
2382: r = PetscInt64Mult(a,b);
2383: if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100;
2384: return (PetscInt) r;
2385: }
2387: /*@C
2389: PetscIntSumTruncate - Computes the sum of two positive PetscInt and truncates the value to slightly less than the maximal possible value
2391: Not Collective
2393: Input Parameter:
2394: + a - the PetscInt value
2395: - b - the second value
2397: Returns:
2398: the result as a PetscInt value
2400: Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64
2401: Use PetscRealIntMultTruncate() to compute the product of a PetscReal and a PetscInt and truncate to fit a PetscInt
2402: 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
2404: This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able.
2406: Level: advanced
2408: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult()
2409: @*/
2410: PETSC_STATIC_INLINE PetscInt PetscIntSumTruncate(PetscInt a,PetscInt b)
2411: {
2412: PetscInt64 r;
2414: r = ((PetscInt64)a) + ((PetscInt64)b);
2415: if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100;
2416: return (PetscInt) r;
2417: }
2419: /*@C
2421: PetscIntMultError - Computes the product of two positive PetscInt and generates an error with overflow.
2423: Not Collective
2425: Input Parameter:
2426: + a - the PetscInt value
2427: - b - the second value
2429: Output Parameter:ma
2430: . result - the result as a PetscInt value, or NULL if you do not want the result, you just want to check if it overflows
2432: Use PetscInt64Mult() to compute the product of two 32 bit PetscInt and store in a PetscInt64
2433: Use PetscIntMultTruncate() to compute the product of two PetscInt and truncate it to fit in a PetscInt
2435: Developers Note: We currently assume that PetscInt addition does not overflow, this is obviously wrong but requires many more checks.
2437: Level: advanced
2439: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscIntMult64(), PetscIntSumError()
2440: @*/
2441: PETSC_STATIC_INLINE PetscErrorCode PetscIntMultError(PetscInt a,PetscInt b,PetscInt *result)
2442: {
2443: PetscInt64 r;
2446: r = PetscInt64Mult(a,b);
2447: #if !defined(PETSC_USE_64BIT_INDICES)
2448: 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);
2449: #endif
2450: if (result) *result = (PetscInt) r;
2451: return(0);
2452: }
2454: /*@C
2456: PetscIntSumError - Computes the sum of two positive PetscInt and generates an error with overflow.
2458: Not Collective
2460: Input Parameter:
2461: + a - the PetscInt value
2462: - b - the second value
2464: Output Parameter:ma
2465: . c - the result as a PetscInt value, or NULL if you do not want the result, you just want to check if it overflows
2467: Use PetscInt64Mult() to compute the product of two 32 bit PetscInt and store in a PetscInt64
2468: Use PetscIntMultTruncate() to compute the product of two PetscInt and truncate it to fit in a PetscInt
2470: Level: advanced
2472: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult()
2473: @*/
2474: PETSC_STATIC_INLINE PetscErrorCode PetscIntSumError(PetscInt a,PetscInt b,PetscInt *result)
2475: {
2476: PetscInt64 r;
2479: r = ((PetscInt64)a) + ((PetscInt64)b);
2480: #if !defined(PETSC_USE_64BIT_INDICES)
2481: 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);
2482: #endif
2483: if (result) *result = (PetscInt) r;
2484: return(0);
2485: }
2486:
2487: /*
2488: The IBM include files define hz, here we hide it so that it may be used as a regular user variable.
2489: */
2490: #if defined(hz)
2491: #undef hz
2492: #endif
2494: /* For arrays that contain filenames or paths */
2497: #if defined(PETSC_HAVE_LIMITS_H)
2498: #include <limits.h>
2499: #endif
2500: #if defined(PETSC_HAVE_SYS_PARAM_H)
2501: #include <sys/param.h>
2502: #endif
2503: #if defined(PETSC_HAVE_SYS_TYPES_H)
2504: #include <sys/types.h>
2505: #endif
2506: #if defined(MAXPATHLEN)
2507: # define PETSC_MAX_PATH_LEN MAXPATHLEN
2508: #elif defined(MAX_PATH)
2509: # define PETSC_MAX_PATH_LEN MAX_PATH
2510: #elif defined(_MAX_PATH)
2511: # define PETSC_MAX_PATH_LEN _MAX_PATH
2512: #else
2513: # define PETSC_MAX_PATH_LEN 4096
2514: #endif
2516: /*MC
2518: PETSC_VERSION - This manual page provides information about how PETSc documents and uses its version information. This information is available to both C/C++
2519: and Fortran compilers when petscsys.h is included.
2522: The current PETSc version and the API for accessing it are defined in petscversion.h
2524: The complete version number is given as the triple PETSC_VERSION_MAJOR.PETSC_VERSION_MINOR.PETSC_VERSION_SUBMINOR (in short hand x.y.z)
2526: 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
2527: where only a change in the major version number (x) indicates a change in the API.
2529: 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
2531: 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),
2532: 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
2533: version number (x.y.z).
2535: PETSC_RELEASE_DATE is the date the x.y version was released (i.e. the version before any patch releases)
2537: PETSC_VERSION_DATE is the date the x.y.z version was released
2539: PETSC_VERSION_GIT is the last git commit to the repository given in the form vx.y.z-wwwww
2541: PETSC_VERSION_DATE_GIT is the date of the last git commit to the repository
2543: Level: intermediate
2545: PETSC_VERSION_() and PETSC_VERSION_PATCH are deprecated and will eventually be removed. For several releases PETSC_VERSION_PATCH is always 0
2547: M*/
2549: /*MC
2551: UsingFortran - To use PETSc with Fortran you must use both PETSc include files and modules. At the beginning
2552: of every function and module definition you need something like
2554: $
2555: $#include "petsc/finclude/petscXXX.h"
2556: $ use petscXXX
2558: You can declare PETSc variables using either of the following.
2560: $ XXX variablename
2561: $ type(tXXX) variablename
2563: For example,
2565: $#include "petsc/finclude/petscvec.h"
2566: $ use petscvec
2567: $
2568: $ Vec b
2569: $ type(tVec) x
2571: Level: beginner
2573: M*/
2575: PETSC_EXTERN PetscErrorCode PetscGetArchType(char[],size_t);
2576: PETSC_EXTERN PetscErrorCode PetscGetHostName(char[],size_t);
2577: PETSC_EXTERN PetscErrorCode PetscGetUserName(char[],size_t);
2578: PETSC_EXTERN PetscErrorCode PetscGetProgramName(char[],size_t);
2579: PETSC_EXTERN PetscErrorCode PetscSetProgramName(const char[]);
2580: PETSC_EXTERN PetscErrorCode PetscGetDate(char[],size_t);
2581: PETSC_EXTERN PetscErrorCode PetscGetVersion(char[], size_t);
2582: PETSC_EXTERN PetscErrorCode PetscGetVersionNumber(PetscInt*,PetscInt*,PetscInt*,PetscInt*);
2584: PETSC_EXTERN PetscErrorCode PetscSortInt(PetscInt,PetscInt[]);
2585: PETSC_EXTERN PetscErrorCode PetscSortedRemoveDupsInt(PetscInt*,PetscInt[]);
2586: PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsInt(PetscInt*,PetscInt[]);
2587: PETSC_EXTERN PetscErrorCode PetscFindInt(PetscInt, PetscInt, const PetscInt[], PetscInt*);
2588: PETSC_EXTERN PetscErrorCode PetscFindMPIInt(PetscMPIInt, PetscInt, const PetscMPIInt[], PetscInt*);
2589: PETSC_EXTERN PetscErrorCode PetscSortIntWithPermutation(PetscInt,const PetscInt[],PetscInt[]);
2590: PETSC_EXTERN PetscErrorCode PetscSortStrWithPermutation(PetscInt,const char*[],PetscInt[]);
2591: PETSC_EXTERN PetscErrorCode PetscSortIntWithArray(PetscInt,PetscInt[],PetscInt[]);
2592: PETSC_EXTERN PetscErrorCode PetscSortIntWithArrayPair(PetscInt,PetscInt[],PetscInt[],PetscInt[]);
2593: PETSC_EXTERN PetscErrorCode PetscSortMPIInt(PetscInt,PetscMPIInt[]);
2594: PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsMPIInt(PetscInt*,PetscMPIInt[]);
2595: PETSC_EXTERN PetscErrorCode PetscSortMPIIntWithArray(PetscMPIInt,PetscMPIInt[],PetscMPIInt[]);
2596: PETSC_EXTERN PetscErrorCode PetscSortIntWithScalarArray(PetscInt,PetscInt[],PetscScalar[]);
2597: PETSC_EXTERN PetscErrorCode PetscSortIntWithDataArray(PetscInt,PetscInt[],void*,size_t,void*);
2598: PETSC_EXTERN PetscErrorCode PetscSortReal(PetscInt,PetscReal[]);
2599: PETSC_EXTERN PetscErrorCode PetscSortRealWithArrayInt(PetscInt,PetscReal[],PetscInt[]);
2600: PETSC_EXTERN PetscErrorCode PetscSortRealWithPermutation(PetscInt,const PetscReal[],PetscInt[]);
2601: PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsReal(PetscInt*,PetscReal[]);
2602: PETSC_EXTERN PetscErrorCode PetscFindReal(PetscReal,PetscInt,const PetscReal[],PetscReal,PetscInt*);
2603: PETSC_EXTERN PetscErrorCode PetscSortSplit(PetscInt,PetscInt,PetscScalar[],PetscInt[]);
2604: PETSC_EXTERN PetscErrorCode PetscSortSplitReal(PetscInt,PetscInt,PetscReal[],PetscInt[]);
2605: PETSC_EXTERN PetscErrorCode PetscProcessTree(PetscInt,const PetscBool [],const PetscInt[],PetscInt*,PetscInt**,PetscInt**,PetscInt**,PetscInt**);
2606: PETSC_EXTERN PetscErrorCode PetscMergeIntArrayPair(PetscInt,const PetscInt[],const PetscInt[],PetscInt,const PetscInt[],const PetscInt[],PetscInt*,PetscInt**,PetscInt**);
2607: PETSC_EXTERN PetscErrorCode PetscMergeIntArray(PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscInt*,PetscInt**);
2608: PETSC_EXTERN PetscErrorCode PetscMergeMPIIntArray(PetscInt,const PetscMPIInt[],PetscInt,const PetscMPIInt[],PetscInt*,PetscMPIInt**);
2610: PETSC_EXTERN PetscErrorCode PetscSetDisplay(void);
2611: PETSC_EXTERN PetscErrorCode PetscGetDisplay(char[],size_t);
2613: /*J
2614: PetscRandomType - String with the name of a PETSc randomizer
2616: Level: beginner
2618: Notes: to use SPRNG or RANDOM123 you must have ./configure PETSc
2619: with the option --download-sprng or --download-random123
2621: .seealso: PetscRandomSetType(), PetscRandom, PetscRandomCreate()
2622: J*/
2623: typedef const char* PetscRandomType;
2624: #define PETSCRAND "rand"
2625: #define PETSCRAND48 "rand48"
2626: #define PETSCSPRNG "sprng"
2627: #define PETSCRANDER48 "rander48"
2628: #define PETSCRANDOM123 "random123"
2630: /* Logging support */
2631: PETSC_EXTERN PetscClassId PETSC_RANDOM_CLASSID;
2633: PETSC_EXTERN PetscErrorCode PetscRandomInitializePackage(void);
2635: /*S
2636: PetscRandom - Abstract PETSc object that manages generating random numbers
2638: Level: intermediate
2640: Concepts: random numbers
2642: .seealso: PetscRandomCreate(), PetscRandomGetValue(), PetscRandomType
2643: S*/
2644: typedef struct _p_PetscRandom* PetscRandom;
2646: /* Dynamic creation and loading functions */
2647: PETSC_EXTERN PetscFunctionList PetscRandomList;
2649: PETSC_EXTERN PetscErrorCode PetscRandomRegister(const char[],PetscErrorCode (*)(PetscRandom));
2650: PETSC_EXTERN PetscErrorCode PetscRandomSetType(PetscRandom, PetscRandomType);
2651: PETSC_EXTERN PetscErrorCode PetscRandomSetFromOptions(PetscRandom);
2652: PETSC_EXTERN PetscErrorCode PetscRandomGetType(PetscRandom, PetscRandomType*);
2653: PETSC_STATIC_INLINE PetscErrorCode PetscRandomViewFromOptions(PetscRandom A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
2654: PETSC_EXTERN PetscErrorCode PetscRandomView(PetscRandom,PetscViewer);
2656: PETSC_EXTERN PetscErrorCode PetscRandomCreate(MPI_Comm,PetscRandom*);
2657: PETSC_EXTERN PetscErrorCode PetscRandomGetValue(PetscRandom,PetscScalar*);
2658: PETSC_EXTERN PetscErrorCode PetscRandomGetValueReal(PetscRandom,PetscReal*);
2659: PETSC_EXTERN PetscErrorCode PetscRandomGetInterval(PetscRandom,PetscScalar*,PetscScalar*);
2660: PETSC_EXTERN PetscErrorCode PetscRandomSetInterval(PetscRandom,PetscScalar,PetscScalar);
2661: PETSC_EXTERN PetscErrorCode PetscRandomSetSeed(PetscRandom,unsigned long);
2662: PETSC_EXTERN PetscErrorCode PetscRandomGetSeed(PetscRandom,unsigned long *);
2663: PETSC_EXTERN PetscErrorCode PetscRandomSeed(PetscRandom);
2664: PETSC_EXTERN PetscErrorCode PetscRandomDestroy(PetscRandom*);
2666: PETSC_EXTERN PetscErrorCode PetscGetFullPath(const char[],char[],size_t);
2667: PETSC_EXTERN PetscErrorCode PetscGetRelativePath(const char[],char[],size_t);
2668: PETSC_EXTERN PetscErrorCode PetscGetWorkingDirectory(char[],size_t);
2669: PETSC_EXTERN PetscErrorCode PetscGetRealPath(const char[],char[]);
2670: PETSC_EXTERN PetscErrorCode PetscGetHomeDirectory(char[],size_t);
2671: PETSC_EXTERN PetscErrorCode PetscTestFile(const char[],char,PetscBool *);
2672: PETSC_EXTERN PetscErrorCode PetscTestDirectory(const char[],char,PetscBool *);
2673: PETSC_EXTERN PetscErrorCode PetscMkdir(const char[]);
2674: PETSC_EXTERN PetscErrorCode PetscRMTree(const char[]);
2676: PETSC_EXTERN PetscErrorCode PetscBinaryRead(int,void*,PetscInt,PetscDataType);
2677: PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedRead(MPI_Comm,int,void*,PetscInt,PetscDataType);
2678: PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedWrite(MPI_Comm,int,void*,PetscInt,PetscDataType,PetscBool );
2679: PETSC_EXTERN PetscErrorCode PetscBinaryWrite(int,void*,PetscInt,PetscDataType,PetscBool );
2680: PETSC_EXTERN PetscErrorCode PetscBinaryOpen(const char[],PetscFileMode,int *);
2681: PETSC_EXTERN PetscErrorCode PetscBinaryClose(int);
2682: PETSC_EXTERN PetscErrorCode PetscSharedTmp(MPI_Comm,PetscBool *);
2683: PETSC_EXTERN PetscErrorCode PetscSharedWorkingDirectory(MPI_Comm,PetscBool *);
2684: PETSC_EXTERN PetscErrorCode PetscGetTmp(MPI_Comm,char[],size_t);
2685: PETSC_EXTERN PetscErrorCode PetscFileRetrieve(MPI_Comm,const char[],char[],size_t,PetscBool *);
2686: PETSC_EXTERN PetscErrorCode PetscLs(MPI_Comm,const char[],char[],size_t,PetscBool *);
2687: #if defined(PETSC_USE_SOCKET_VIEWER)
2688: PETSC_EXTERN PetscErrorCode PetscOpenSocket(const char[],int,int*);
2689: #endif
2691: /*
2692: In binary files variables are stored using the following lengths,
2693: regardless of how they are stored in memory on any one particular
2694: machine. Use these rather then sizeof() in computing sizes for
2695: PetscBinarySeek().
2696: */
2697: #define PETSC_BINARY_INT_SIZE (32/8)
2698: #define PETSC_BINARY_FLOAT_SIZE (32/8)
2699: #define PETSC_BINARY_CHAR_SIZE (8/8)
2700: #define PETSC_BINARY_SHORT_SIZE (16/8)
2701: #define PETSC_BINARY_DOUBLE_SIZE (64/8)
2702: #define PETSC_BINARY_SCALAR_SIZE sizeof(PetscScalar)
2704: /*E
2705: PetscBinarySeekType - argument to PetscBinarySeek()
2707: Level: advanced
2709: .seealso: PetscBinarySeek(), PetscBinarySynchronizedSeek()
2710: E*/
2711: typedef enum {PETSC_BINARY_SEEK_SET = 0,PETSC_BINARY_SEEK_CUR = 1,PETSC_BINARY_SEEK_END = 2} PetscBinarySeekType;
2712: PETSC_EXTERN PetscErrorCode PetscBinarySeek(int,off_t,PetscBinarySeekType,off_t*);
2713: PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedSeek(MPI_Comm,int,off_t,PetscBinarySeekType,off_t*);
2714: PETSC_EXTERN PetscErrorCode PetscByteSwap(void *,PetscDataType,PetscInt);
2716: PETSC_EXTERN PetscErrorCode PetscSetDebugTerminal(const char[]);
2717: PETSC_EXTERN PetscErrorCode PetscSetDebugger(const char[],PetscBool );
2718: PETSC_EXTERN PetscErrorCode PetscSetDefaultDebugger(void);
2719: PETSC_EXTERN PetscErrorCode PetscSetDebuggerFromString(const char*);
2720: PETSC_EXTERN PetscErrorCode PetscAttachDebugger(void);
2721: PETSC_EXTERN PetscErrorCode PetscStopForDebugger(void);
2723: PETSC_EXTERN PetscErrorCode PetscGatherNumberOfMessages(MPI_Comm,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt*);
2724: PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**);
2725: PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths2(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**,PetscMPIInt**);
2726: PETSC_EXTERN PetscErrorCode PetscPostIrecvInt(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscInt***,MPI_Request**);
2727: PETSC_EXTERN PetscErrorCode PetscPostIrecvScalar(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscScalar***,MPI_Request**);
2728: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSided(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt*,const void*,PetscMPIInt*,PetscMPIInt**,void*)
2729: PetscAttrMPIPointerWithType(6,3);
2730: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedF(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt[],const void*,PetscMPIInt*,PetscMPIInt**,void*,PetscMPIInt,
2731: PetscErrorCode (*send)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,PetscMPIInt,void*,MPI_Request[],void*),
2732: PetscErrorCode (*recv)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,void*,MPI_Request[],void*),void *ctx)
2733: PetscAttrMPIPointerWithType(6,3);
2734: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedFReq(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt[],const void*,PetscMPIInt*,PetscMPIInt**,void*,PetscMPIInt,
2735: MPI_Request**,MPI_Request**,
2736: PetscErrorCode (*send)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,PetscMPIInt,void*,MPI_Request[],void*),
2737: PetscErrorCode (*recv)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,void*,MPI_Request[],void*),void *ctx)
2738: PetscAttrMPIPointerWithType(6,3);
2740: /*E
2741: PetscBuildTwoSidedType - algorithm for setting up two-sided communication
2743: $ PETSC_BUILDTWOSIDED_ALLREDUCE - classical algorithm using an MPI_Allreduce with
2744: $ a buffer of length equal to the communicator size. Not memory-scalable due to
2745: $ the large reduction size. Requires only MPI-1.
2746: $ PETSC_BUILDTWOSIDED_IBARRIER - nonblocking algorithm based on MPI_Issend and MPI_Ibarrier.
2747: $ Proved communication-optimal in Hoefler, Siebert, and Lumsdaine (2010). Requires MPI-3.
2748: $ PETSC_BUILDTWOSIDED_REDSCATTER - similar to above, but use more optimized function
2749: $ that only communicates the part of the reduction that is necessary. Requires MPI-2.
2751: Level: developer
2753: .seealso: PetscCommBuildTwoSided(), PetscCommBuildTwoSidedSetType(), PetscCommBuildTwoSidedGetType()
2754: E*/
2755: typedef enum {
2756: PETSC_BUILDTWOSIDED_NOTSET = -1,
2757: PETSC_BUILDTWOSIDED_ALLREDUCE = 0,
2758: PETSC_BUILDTWOSIDED_IBARRIER = 1,
2759: PETSC_BUILDTWOSIDED_REDSCATTER = 2
2760: /* Updates here must be accompanied by updates in finclude/petscsys.h and the string array in mpits.c */
2761: } PetscBuildTwoSidedType;
2762: PETSC_EXTERN const char *const PetscBuildTwoSidedTypes[];
2763: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedSetType(MPI_Comm,PetscBuildTwoSidedType);
2764: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedGetType(MPI_Comm,PetscBuildTwoSidedType*);
2766: PETSC_EXTERN PetscErrorCode PetscSSEIsEnabled(MPI_Comm,PetscBool *,PetscBool *);
2768: /*E
2769: InsertMode - Whether entries are inserted or added into vectors or matrices
2771: Level: beginner
2773: .seealso: VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(),
2774: VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(),
2775: MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd()
2776: E*/
2777: typedef enum {NOT_SET_VALUES, INSERT_VALUES, ADD_VALUES, MAX_VALUES, INSERT_ALL_VALUES, ADD_ALL_VALUES, INSERT_BC_VALUES, ADD_BC_VALUES} InsertMode;
2779: /*MC
2780: INSERT_VALUES - Put a value into a vector or matrix, overwrites any previous value
2782: Level: beginner
2784: .seealso: InsertMode, VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(),
2785: VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), ADD_VALUES,
2786: MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd(), MAX_VALUES
2788: M*/
2790: /*MC
2791: ADD_VALUES - Adds a value into a vector or matrix, if there previously was no value, just puts the
2792: value into that location
2794: Level: beginner
2796: .seealso: InsertMode, VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(),
2797: VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), INSERT_VALUES,
2798: MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd(), MAX_VALUES
2800: M*/
2802: /*MC
2803: MAX_VALUES - Puts the maximum of the scattered/gathered value and the current value into each location
2805: Level: beginner
2807: .seealso: InsertMode, VecScatterBegin(), VecScatterEnd(), ADD_VALUES, INSERT_VALUES
2809: M*/
2811: PETSC_EXTERN MPI_Comm PetscObjectComm(PetscObject);
2813: typedef enum {PETSC_SUBCOMM_GENERAL=0,PETSC_SUBCOMM_CONTIGUOUS=1,PETSC_SUBCOMM_INTERLACED=2} PetscSubcommType;
2814: PETSC_EXTERN const char *const PetscSubcommTypes[];
2816: /*S
2817: PetscSubcomm - A decomposition of an MPI communicator into subcommunicators
2819: Notes: After a call to PetscSubcommSetType(), PetscSubcommSetTypeGeneral(), or PetscSubcommSetFromOptions() one may call
2820: $ PetscSubcommChild() returns the associated subcommunicator on this process
2821: $ PetscSubcommContiguousParent() returns a parent communitor but with all child of the same subcommunicator having contiguous rank
2823: Sample Usage:
2824: PetscSubcommCreate()
2825: PetscSubcommSetNumber()
2826: PetscSubcommSetType(PETSC_SUBCOMM_INTERLACED);
2827: ccomm = PetscSubcommChild()
2828: PetscSubcommDestroy()
2830: Level: advanced
2832: Concepts: communicator, create
2834: Notes:
2835: $ 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
2836: $ PETSC_SUBCOMM_CONTIGUOUS - each new communicator contains a set of process with contiguous ranks in the original MPI communicator
2837: $ PETSC_SUBCOMM_INTERLACED - each new communictor contains a set of processes equally far apart in rank from the others in that new communicator
2839: Examaple: Consider a communicator with six processes split into 3 subcommunicators.
2840: $ 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
2841: $ PETSC_SUBCOMM_INTERLACED - the first communicator contains rank 0,3, the second 1,4 and the third 2,5
2843: Developer Notes: This is used in objects such as PCREDUNDANT() to manage the subcommunicators on which the redundant computations
2844: are performed.
2847: .seealso: PetscSubcommCreate(), PetscSubcommSetNumber(), PetscSubcommSetType(), PetscSubcommView(), PetscSubcommSetFromOptions()
2849: S*/
2850: typedef struct _n_PetscSubcomm* PetscSubcomm;
2852: struct _n_PetscSubcomm {
2853: MPI_Comm parent; /* parent communicator */
2854: MPI_Comm dupparent; /* duplicate parent communicator, under which the processors of this subcomm have contiguous rank */
2855: MPI_Comm child; /* the sub-communicator */
2856: PetscMPIInt n; /* num of subcommunicators under the parent communicator */
2857: PetscMPIInt color; /* color of processors belong to this communicator */
2858: PetscMPIInt *subsize; /* size of subcommunicator[color] */
2859: PetscSubcommType type;
2860: char *subcommprefix;
2861: };
2863: PETSC_STATIC_INLINE MPI_Comm PetscSubcommParent(PetscSubcomm scomm) {return scomm->parent;}
2864: PETSC_STATIC_INLINE MPI_Comm PetscSubcommChild(PetscSubcomm scomm) {return scomm->child;}
2865: PETSC_STATIC_INLINE MPI_Comm PetscSubcommContiguousParent(PetscSubcomm scomm) {return scomm->dupparent;}
2866: PETSC_EXTERN PetscErrorCode PetscSubcommCreate(MPI_Comm,PetscSubcomm*);
2867: PETSC_EXTERN PetscErrorCode PetscSubcommDestroy(PetscSubcomm*);
2868: PETSC_EXTERN PetscErrorCode PetscSubcommSetNumber(PetscSubcomm,PetscInt);
2869: PETSC_EXTERN PetscErrorCode PetscSubcommSetType(PetscSubcomm,PetscSubcommType);
2870: PETSC_EXTERN PetscErrorCode PetscSubcommSetTypeGeneral(PetscSubcomm,PetscMPIInt,PetscMPIInt);
2871: PETSC_EXTERN PetscErrorCode PetscSubcommView(PetscSubcomm,PetscViewer);
2872: PETSC_EXTERN PetscErrorCode PetscSubcommSetFromOptions(PetscSubcomm);
2873: PETSC_EXTERN PetscErrorCode PetscSubcommSetOptionsPrefix(PetscSubcomm,const char[]);
2875: /*S
2876: PetscHeap - A simple class for managing heaps
2878: Level: intermediate
2880: Concepts: random numbers
2882: .seealso: PetscHeapCreate(), PetscHeapAdd(), PetscHeapPop(), PetscHeapPeek(), PetscHeapStash(), PetscHeapUnstash(), PetscHeapView(), PetscHeapDestroy()
2883: S*/
2884: typedef struct _PetscHeap *PetscHeap;
2886: PETSC_EXTERN PetscErrorCode PetscHeapCreate(PetscInt,PetscHeap*);
2887: PETSC_EXTERN PetscErrorCode PetscHeapAdd(PetscHeap,PetscInt,PetscInt);
2888: PETSC_EXTERN PetscErrorCode PetscHeapPop(PetscHeap,PetscInt*,PetscInt*);
2889: PETSC_EXTERN PetscErrorCode PetscHeapPeek(PetscHeap,PetscInt*,PetscInt*);
2890: PETSC_EXTERN PetscErrorCode PetscHeapStash(PetscHeap,PetscInt,PetscInt);
2891: PETSC_EXTERN PetscErrorCode PetscHeapUnstash(PetscHeap);
2892: PETSC_EXTERN PetscErrorCode PetscHeapDestroy(PetscHeap*);
2893: PETSC_EXTERN PetscErrorCode PetscHeapView(PetscHeap,PetscViewer);
2895: /*S
2896: PetscSegBuffer - a segmented extendable buffer
2898: Level: developer
2900: .seealso: PetscSegBufferCreate(), PetscSegBufferGet(), PetscSegBufferExtract(), PetscSegBufferDestroy()
2901: S*/
2902: typedef struct _n_PetscSegBuffer *PetscSegBuffer;
2903: PETSC_EXTERN PetscErrorCode PetscSegBufferCreate(size_t,size_t,PetscSegBuffer*);
2904: PETSC_EXTERN PetscErrorCode PetscSegBufferDestroy(PetscSegBuffer*);
2905: PETSC_EXTERN PetscErrorCode PetscSegBufferGet(PetscSegBuffer,size_t,void*);
2906: PETSC_EXTERN PetscErrorCode PetscSegBufferExtractAlloc(PetscSegBuffer,void*);
2907: PETSC_EXTERN PetscErrorCode PetscSegBufferExtractTo(PetscSegBuffer,void*);
2908: PETSC_EXTERN PetscErrorCode PetscSegBufferExtractInPlace(PetscSegBuffer,void*);
2909: PETSC_EXTERN PetscErrorCode PetscSegBufferGetSize(PetscSegBuffer,size_t*);
2910: PETSC_EXTERN PetscErrorCode PetscSegBufferUnuse(PetscSegBuffer,size_t);
2913: * prevents the compiler from completely erasing the stub. This is called in inner loops so it has to be as fast as
2914: * possible. */
2915: PETSC_STATIC_INLINE PetscErrorCode PetscSegBufferGetInts(PetscSegBuffer seg,PetscInt count,PetscInt *PETSC_RESTRICT *slot) {return PetscSegBufferGet(seg,(size_t)count,(void**)slot);}
2917: typedef struct _n_PetscOptionsHelpPrinted *PetscOptionsHelpPrinted;
2918: extern PetscOptionsHelpPrinted PetscOptionsHelpPrintedSingleton;
2919: PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedDestroy(PetscOptionsHelpPrinted*);
2920: PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedCreate(PetscOptionsHelpPrinted*);
2921: PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedCheck(PetscOptionsHelpPrinted,const char*,const char*,PetscBool*);
2923: PETSC_EXTERN PetscSegBuffer PetscCitationsList;
2925: /*@C
2926: PetscCitationsRegister - Register a bibtex item to obtain credit for an implemented algorithm used in the code.
2928: Not Collective - only what is registered on rank 0 of PETSC_COMM_WORLD will be printed
2930: Input Parameters:
2931: + cite - the bibtex item, formated to displayed on multiple lines nicely
2932: - set - a boolean variable initially set to PETSC_FALSE; this is used to insure only a single registration of the citation
2934: Level: intermediate
2936: Options Database:
2937: . -citations [filename] - print out the bibtex entries for the given computation
2938: @*/
2939: PETSC_STATIC_INLINE PetscErrorCode PetscCitationsRegister(const char cit[],PetscBool *set)
2940: {
2941: size_t len;
2942: char *vstring;
2946: if (set && *set) return(0);
2947: PetscStrlen(cit,&len);
2948: PetscSegBufferGet(PetscCitationsList,len,&vstring);
2949: PetscMemcpy(vstring,cit,len);
2950: if (set) *set = PETSC_TRUE;
2951: return(0);
2952: }
2954: PETSC_EXTERN PetscErrorCode PetscURLShorten(const char[],char[],size_t);
2955: PETSC_EXTERN PetscErrorCode PetscGoogleDriveAuthorize(MPI_Comm,char[],char[],size_t);
2956: PETSC_EXTERN PetscErrorCode PetscGoogleDriveRefresh(MPI_Comm,const char[],char[],size_t);
2957: PETSC_EXTERN PetscErrorCode PetscGoogleDriveUpload(MPI_Comm,const char[],const char []);
2959: PETSC_EXTERN PetscErrorCode PetscBoxAuthorize(MPI_Comm,char[],char[],size_t);
2960: PETSC_EXTERN PetscErrorCode PetscBoxRefresh(MPI_Comm,const char[],char[],char[],size_t);
2962: PETSC_EXTERN PetscErrorCode PetscTextBelt(MPI_Comm,const char[],const char[],PetscBool*);
2963: PETSC_EXTERN PetscErrorCode PetscTellMyCell(MPI_Comm,const char[],const char[],PetscBool*);
2965: PETSC_EXTERN PetscErrorCode PetscPullJSONValue(const char[],const char[],char[],size_t,PetscBool*);
2966: PETSC_EXTERN PetscErrorCode PetscPushJSONValue(char[],const char[],const char[],size_t);
2969: #if defined(PETSC_USE_DEBUG)
2970: /*
2971: Verify that all processes in the communicator have called this from the same line of code
2972: */
2973: PETSC_EXTERN PetscErrorCode PetscAllreduceBarrierCheck(MPI_Comm,PetscMPIInt,int,const char*,const char *);
2975: /*MC
2976: MPIU_Allreduce - a PETSc replacement for MPI_Allreduce() that tries to determine if the call from all the MPI processes occur from the
2977: same place in the PETSc code. This helps to detect bugs where different MPI processes follow different code paths
2978: resulting in inconsistent and incorrect calls to MPI_Allreduce().
2980: Collective on MPI_Comm
2982: Synopsis:
2983: #include <petscsys.h>
2984: PetscErrorCode MPIU_Allreduce(void *indata,void *outdata,PetscMPIInt count,MPI_Datatype datatype, MPI_Op op, MPI_Comm comm);
2986: Input Parameters:
2987: + indata - pointer to the input data to be reduced
2988: . count - the number of MPI data items in indata and outdata
2989: . datatype - the MPI datatype, for example MPI_INT
2990: . op - the MPI operation, for example MPI_SUM
2991: - comm - the MPI communicator on which the operation occurs
2993: Output Parameter:
2994: . outdata - the reduced values
2996: Notes: In optimized mode this directly calls MPI_Allreduce()
2998: Level: developer
3000: .seealso: MPI_Allreduce()
3001: M*/
3002: #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))
3003: #else
3004: #define MPIU_Allreduce(a,b,c,d,e,fcomm) MPI_Allreduce(a,b,c,d,e,fcomm)
3005: #endif
3007: #endif