Actual source code: petscsys.h
petsc-master 2020-03-31
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: */
5: #if !defined(PETSCSYS_H)
6: #define PETSCSYS_H
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: #include <petscsystypes.h>
38: /* ========================================================================== */
39: /*
40: This facilitates using the C version of PETSc from C++ and the C++ version from C.
41: */
42: #if defined(__cplusplus)
43: # define PETSC_FUNCTION_NAME PETSC_FUNCTION_NAME_CXX
44: #else
45: # define PETSC_FUNCTION_NAME PETSC_FUNCTION_NAME_C
46: #endif
48: /* ========================================================================== */
49: /*
50: Since PETSc manages its own extern "C" handling users should never include PETSc include
51: files within extern "C". This will generate a compiler error if a user does put the include
52: file within an extern "C".
53: */
54: #if defined(__cplusplus)
55: void assert_never_put_petsc_headers_inside_an_extern_c(int); void assert_never_put_petsc_headers_inside_an_extern_c(double);
56: #endif
58: #if defined(__cplusplus)
59: # define PETSC_RESTRICT PETSC_CXX_RESTRICT
60: #else
61: # define PETSC_RESTRICT PETSC_C_RESTRICT
62: #endif
64: #if defined(__cplusplus)
65: # define PETSC_INLINE PETSC_CXX_INLINE
66: #else
67: # define PETSC_INLINE PETSC_C_INLINE
68: #endif
70: #define PETSC_STATIC_INLINE static PETSC_INLINE
72: #if defined(_WIN32) && defined(PETSC_USE_SHARED_LIBRARIES) /* For Win32 shared libraries */
73: # define __declspec(dllexport)
74: # define PETSC_DLLIMPORT __declspec(dllimport)
75: # define PETSC_VISIBILITY_INTERNAL
76: #elif defined(PETSC_USE_VISIBILITY_CXX) && defined(__cplusplus)
77: # define __attribute__((visibility ("default")))
78: # define PETSC_DLLIMPORT __attribute__((visibility ("default")))
79: # define PETSC_VISIBILITY_INTERNAL __attribute__((visibility ("hidden")))
80: #elif defined(PETSC_USE_VISIBILITY_C) && !defined(__cplusplus)
81: # define __attribute__((visibility ("default")))
82: # define PETSC_DLLIMPORT __attribute__((visibility ("default")))
83: # define PETSC_VISIBILITY_INTERNAL __attribute__((visibility ("hidden")))
84: #else
85: # define
86: # define PETSC_DLLIMPORT
87: # define PETSC_VISIBILITY_INTERNAL
88: #endif
90: #if defined(petsc_EXPORTS) /* CMake defines this when building the shared library */
91: # define PETSC_VISIBILITY_PUBLIC
92: #else /* Win32 users need this to import symbols from petsc.dll */
93: # define PETSC_VISIBILITY_PUBLIC PETSC_DLLIMPORT
94: #endif
96: /*
97: Functions tagged with PETSC_EXTERN in the header files are
98: always defined as extern "C" when compiled with C++ so they may be
99: used from C and are always visible in the shared libraries
100: */
101: #if defined(__cplusplus)
102: # define PETSC_EXTERN extern "C" PETSC_VISIBILITY_PUBLIC
103: # define PETSC_EXTERN_TYPEDEF extern "C"
104: # define PETSC_INTERN extern "C" PETSC_VISIBILITY_INTERNAL
105: #else
106: # define PETSC_EXTERN extern PETSC_VISIBILITY_PUBLIC
107: # define PETSC_EXTERN_TYPEDEF
108: # define PETSC_INTERN extern PETSC_VISIBILITY_INTERNAL
109: #endif
111: #include <petscversion.h>
112: #define PETSC_AUTHOR_INFO " The PETSc Team\n petsc-maint@mcs.anl.gov\n https://www.mcs.anl.gov/petsc/\n"
114: /* ========================================================================== */
116: /*
117: Defines the interface to MPI allowing the use of all MPI functions.
119: PETSc does not use the C++ binding of MPI at ALL. The following flag
120: makes sure the C++ bindings are not included. The C++ bindings REQUIRE
121: putting mpi.h before ANY C++ include files, we cannot control this
122: with all PETSc users. Users who want to use the MPI C++ bindings can include
123: mpicxx.h directly in their code
124: */
125: #if !defined(MPICH_SKIP_MPICXX)
126: # define MPICH_SKIP_MPICXX 1
127: #endif
128: #if !defined(OMPI_SKIP_MPICXX)
129: # define OMPI_SKIP_MPICXX 1
130: #endif
131: #if defined(PETSC_HAVE_MPIUNI)
132: # include <petsc/mpiuni/mpi.h>
133: #else
134: # include <mpi.h>
135: #endif
137: /*
138: Perform various sanity checks that the correct mpi.h is being included at compile time.
139: This usually happens because
140: * either an unexpected mpi.h is in the default compiler path (i.e. in /usr/include) or
141: * an extra include path -I/something (which contains the unexpected mpi.h) is being passed to the compiler
142: */
143: #if defined(PETSC_HAVE_MPIUNI)
144: # if !defined(MPIUNI_H)
145: # error "PETSc was configured with --with-mpi=0 but now appears to be compiling using a different mpi.h"
146: # endif
147: #elif defined(PETSC_HAVE_I_MPI_NUMVERSION)
148: # if !defined(I_MPI_NUMVERSION)
149: # error "PETSc was configured with I_MPI but now appears to be compiling using a non-I_MPI mpi.h"
150: # elif I_MPI_NUMVERSION != PETSC_HAVE_I_MPI_NUMVERSION
151: # 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"
152: # endif
153: #elif defined(PETSC_HAVE_MVAPICH2_NUMVERSION)
154: # if !defined(MVAPICH2_NUMVERSION)
155: # error "PETSc was configured with MVAPICH2 but now appears to be compiling using a non-MVAPICH2 mpi.h"
156: # elif MVAPICH2_NUMVERSION != PETSC_HAVE_MVAPICH2_NUMVERSION
157: # error "PETSc was configured with one MVAPICH2 mpi.h version but now appears to be compiling using a different MVAPICH2 mpi.h version"
158: # endif
159: #elif defined(PETSC_HAVE_MPICH_NUMVERSION)
160: # if !defined(MPICH_NUMVERSION) || defined(MVAPICH2_NUMVERSION) || defined(I_MPI_NUMVERSION)
161: # error "PETSc was configured with MPICH but now appears to be compiling using a non-MPICH mpi.h"
162: # elif (MPICH_NUMVERSION/100000 != PETSC_HAVE_MPICH_NUMVERSION/100000) || (MPICH_NUMVERSION%100000/1000 < PETSC_HAVE_MPICH_NUMVERSION%100000/1000)
163: # error "PETSc was configured with one MPICH mpi.h version but now appears to be compiling using a different MPICH mpi.h version"
164: # endif
165: #elif defined(PETSC_HAVE_OMPI_MAJOR_VERSION)
166: # if !defined(OMPI_MAJOR_VERSION)
167: # error "PETSc was configured with OpenMPI but now appears to be compiling using a non-OpenMPI mpi.h"
168: # 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)
169: # error "PETSc was configured with one OpenMPI mpi.h version but now appears to be compiling using a different OpenMPI mpi.h version"
170: # endif
171: #elif defined(PETSC_HAVE_MSMPI_VERSION)
172: # if !defined(MSMPI_VER)
173: # error "PETSc was configured with MSMPI but now appears to be compiling using a non-MSMPI mpi.h"
174: # elif (MSMPI_VER != PETSC_HAVE_MSMPI_VERSION)
175: # error "PETSc was configured with one MSMPI mpi.h version but now appears to be compiling using a different MSMPI mpi.h version"
176: # endif
177: #elif defined(OMPI_MAJOR_VERSION) || defined(MPICH_NUMVERSION) || defined(MSMPI_VER)
178: # error "PETSc was configured with undetermined MPI - but now appears to be compiling using any of OpenMPI, MS-MPI or a MPICH variant"
179: #endif
181: /*
182: Need to put stdio.h AFTER mpi.h for MPICH2 with C++ compiler
183: see the top of mpicxx.h in the MPICH2 distribution.
184: */
185: #include <stdio.h>
187: /* MSMPI on 32bit windows requires this yukky hack - that breaks MPI standard compliance */
188: #if !defined(MPIAPI)
189: #define MPIAPI
190: #endif
192: /*
193: Support for Clang (>=3.2) matching type tag arguments with void* buffer types.
194: This allows the compiler to detect cases where the MPI datatype argument passed to a MPI routine
195: does not match the actual type of the argument being passed in
196: */
197: #if defined(__has_attribute) && defined(works_with_const_which_is_not_true)
198: # if __has_attribute(argument_with_type_tag) && __has_attribute(pointer_with_type_tag) && __has_attribute(type_tag_for_datatype)
199: # define PetscAttrMPIPointerWithType(bufno,typeno) __attribute__((pointer_with_type_tag(MPI,bufno,typeno)))
200: # define PetscAttrMPITypeTag(type) __attribute__((type_tag_for_datatype(MPI,type)))
201: # define PetscAttrMPITypeTagLayoutCompatible(type) __attribute__((type_tag_for_datatype(MPI,type,layout_compatible)))
202: # endif
203: #endif
204: #if !defined(PetscAttrMPIPointerWithType)
205: # define PetscAttrMPIPointerWithType(bufno,typeno)
206: # define PetscAttrMPITypeTag(type)
207: # define PetscAttrMPITypeTagLayoutCompatible(type)
208: #endif
210: PETSC_EXTERN MPI_Datatype MPIU_ENUM PetscAttrMPITypeTag(PetscEnum);
211: PETSC_EXTERN MPI_Datatype MPIU_BOOL PetscAttrMPITypeTag(PetscBool);
213: /*MC
214: MPIU_INT - MPI datatype corresponding to PetscInt
216: Notes:
217: In MPI calls that require an MPI datatype that matches a PetscInt or array of PetscInt values, pass this value.
219: Level: beginner
221: .seealso: PetscReal, PetscScalar, PetscComplex, PetscInt, MPIU_REAL, MPIU_SCALAR, MPIU_COMPLEX
222: M*/
224: #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 */
225: # define MPIU_INT64 MPI_INT64_T
226: # define PetscInt64_FMT PRId64
227: #elif (PETSC_SIZEOF_LONG_LONG == 8)
228: # define MPIU_INT64 MPI_LONG_LONG_INT
229: # define PetscInt64_FMT "lld"
230: #elif defined(PETSC_HAVE___INT64)
231: # define MPIU_INT64 MPI_INT64_T
232: # define PetscInt64_FMT "ld"
233: #else
234: # error "cannot determine PetscInt64 type"
235: #endif
237: PETSC_EXTERN MPI_Datatype MPIU_FORTRANADDR;
239: #if defined(PETSC_USE_64BIT_INDICES)
240: # define MPIU_INT MPIU_INT64
241: # define PetscInt_FMT PetscInt64_FMT
242: #else
243: # define MPIU_INT MPI_INT
244: # define PetscInt_FMT "d"
245: #endif
247: /*
248: For the rare cases when one needs to send a size_t object with MPI
249: */
250: PETSC_EXTERN MPI_Datatype MPIU_SIZE_T;
252: /*
253: You can use PETSC_STDOUT as a replacement of stdout. You can also change
254: the value of PETSC_STDOUT to redirect all standard output elsewhere
255: */
256: PETSC_EXTERN FILE* PETSC_STDOUT;
258: /*
259: You can use PETSC_STDERR as a replacement of stderr. You can also change
260: the value of PETSC_STDERR to redirect all standard error elsewhere
261: */
262: PETSC_EXTERN FILE* PETSC_STDERR;
264: /*MC
265: PetscUnlikely - hints the compiler that the given condition is usually FALSE
267: Synopsis:
268: #include <petscsys.h>
269: PetscBool PetscUnlikely(PetscBool cond)
271: Not Collective
273: Input Parameters:
274: . cond - condition or expression
276: Notes:
277: This returns the same truth value, it is only a hint to compilers that the resulting
278: branch is unlikely.
280: Level: advanced
282: .seealso: PetscLikely(), CHKERRQ
283: M*/
285: /*MC
286: PetscLikely - hints the compiler that the given condition is usually TRUE
288: Synopsis:
289: #include <petscsys.h>
290: PetscBool PetscLikely(PetscBool cond)
292: Not Collective
294: Input Parameters:
295: . cond - condition or expression
297: Notes:
298: This returns the same truth value, it is only a hint to compilers that the resulting
299: branch is likely.
301: Level: advanced
303: .seealso: PetscUnlikely()
304: M*/
305: #if defined(PETSC_HAVE_BUILTIN_EXPECT)
306: # define PetscUnlikely(cond) __builtin_expect(!!(cond),0)
307: # define PetscLikely(cond) __builtin_expect(!!(cond),1)
308: #else
309: # define PetscUnlikely(cond) (cond)
310: # define PetscLikely(cond) (cond)
311: #endif
313: /*
314: Declare extern C stuff after including external header files
315: */
317: PETSC_EXTERN const char *const PetscBools[];
319: /*
320: Defines elementary mathematics functions and constants.
321: */
322: #include <petscmath.h>
324: PETSC_EXTERN const char *const PetscCopyModes[];
326: /*MC
327: PETSC_IGNORE - same as NULL, means PETSc will ignore this argument
329: Level: beginner
331: Note:
332: Accepted by many PETSc functions to not set a parameter and instead use
333: some default
335: Fortran Notes:
336: This macro does not exist in Fortran; you must use PETSC_NULL_INTEGER,
337: PETSC_NULL_DOUBLE_PRECISION etc
339: .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_DETERMINE
341: M*/
342: #define PETSC_IGNORE NULL
344: /* This is deprecated */
345: #define PETSC_NULL NULL
347: /*MC
348: PETSC_DECIDE - standard way of passing in integer or floating point parameter
349: where you wish PETSc to use the default.
351: Level: beginner
353: .seealso: PETSC_DEFAULT, PETSC_IGNORE, PETSC_DETERMINE
355: M*/
356: #define PETSC_DECIDE -1
358: /*MC
359: PETSC_DETERMINE - standard way of passing in integer or floating point parameter
360: where you wish PETSc to compute the required value.
362: Level: beginner
364: Developer Note:
365: I would like to use const PetscInt PETSC_DETERMINE = PETSC_DECIDE; but for
366: some reason this is not allowed by the standard even though PETSC_DECIDE is a constant value.
368: .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_IGNORE, VecSetSizes()
370: M*/
371: #define PETSC_DETERMINE PETSC_DECIDE
373: /*MC
374: PETSC_DEFAULT - standard way of passing in integer or floating point parameter
375: where you wish PETSc to use the default.
377: Level: beginner
379: Fortran Notes:
380: You need to use PETSC_DEFAULT_INTEGER or PETSC_DEFAULT_REAL.
382: .seealso: PETSC_DECIDE, PETSC_IGNORE, PETSC_DETERMINE
384: M*/
385: #define PETSC_DEFAULT -2
387: /*MC
388: PETSC_COMM_WORLD - the equivalent of the MPI_COMM_WORLD communicator which represents
389: all the processes that PETSc knows about.
391: Level: beginner
393: Notes:
394: By default PETSC_COMM_WORLD and MPI_COMM_WORLD are identical unless you wish to
395: run PETSc on ONLY a subset of MPI_COMM_WORLD. In that case create your new (smaller)
396: communicator, call it, say comm, and set PETSC_COMM_WORLD = comm BEFORE calling
397: PetscInitialize(), but after MPI_Init() has been called.
399: The value of PETSC_COMM_WORLD should never be USED/accessed before PetscInitialize()
400: is called because it may not have a valid value yet.
402: .seealso: PETSC_COMM_SELF
404: M*/
405: PETSC_EXTERN MPI_Comm PETSC_COMM_WORLD;
407: /*MC
408: PETSC_COMM_SELF - This is always MPI_COMM_SELF
410: Level: beginner
412: Notes:
413: Do not USE/access or set this variable before PetscInitialize() has been called.
415: .seealso: PETSC_COMM_WORLD
417: M*/
418: #define PETSC_COMM_SELF MPI_COMM_SELF
420: PETSC_EXTERN PetscBool PetscBeganMPI;
421: PETSC_EXTERN PetscBool PetscInitializeCalled;
422: PETSC_EXTERN PetscBool PetscFinalizeCalled;
423: PETSC_EXTERN PetscBool PetscViennaCLSynchronize;
424: PETSC_EXTERN PetscBool PetscCUDASynchronize;
426: PETSC_EXTERN PetscErrorCode PetscSetHelpVersionFunctions(PetscErrorCode (*)(MPI_Comm),PetscErrorCode (*)(MPI_Comm));
427: PETSC_EXTERN PetscErrorCode PetscCommDuplicate(MPI_Comm,MPI_Comm*,int*);
428: PETSC_EXTERN PetscErrorCode PetscCommDestroy(MPI_Comm*);
430: #if defined(PETSC_HAVE_CUDA)
431: PETSC_EXTERN PetscErrorCode PetscCUDAInitialize(MPI_Comm);
432: #endif
434: /*MC
435: PetscMalloc - Allocates memory, One should use PetscNew(), PetscMalloc1() or PetscCalloc1() usually instead of this
437: Synopsis:
438: #include <petscsys.h>
439: PetscErrorCode PetscMalloc(size_t m,void **result)
441: Not Collective
443: Input Parameter:
444: . m - number of bytes to allocate
446: Output Parameter:
447: . result - memory allocated
449: Level: beginner
451: Notes:
452: Memory is always allocated at least double aligned
454: It is safe to allocate size 0 and pass the resulting pointer (which may or may not be NULL) to PetscFree().
456: .seealso: PetscFree(), PetscNew()
458: M*/
459: #define PetscMalloc(a,b) ((*PetscTrMalloc)((a),PETSC_FALSE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(void**)(b)))
461: /*MC
462: PetscRealloc - Rellocates memory
464: Synopsis:
465: #include <petscsys.h>
466: PetscErrorCode PetscRealloc(size_t m,void **result)
468: Not Collective
470: Input Parameters:
471: + m - number of bytes to allocate
472: - result - previous memory
474: Output Parameter:
475: . result - new memory allocated
477: Level: developer
479: Notes:
480: Memory is always allocated at least double aligned
482: .seealso: PetscMalloc(), PetscFree(), PetscNew()
484: M*/
485: #define PetscRealloc(a,b) ((*PetscTrRealloc)((a),__LINE__,PETSC_FUNCTION_NAME,__FILE__,(void**)(b)))
487: /*MC
488: PetscAddrAlign - Rounds up an address to PETSC_MEMALIGN alignment
490: Synopsis:
491: #include <petscsys.h>
492: void *PetscAddrAlign(void *addr)
494: Not Collective
496: Input Parameters:
497: . addr - address to align (any pointer type)
499: Level: developer
501: .seealso: PetscMallocAlign()
503: M*/
504: #define PetscAddrAlign(a) (void*)((((PETSC_UINTPTR_T)(a))+(PETSC_MEMALIGN-1)) & ~(PETSC_MEMALIGN-1))
506: /*MC
507: PetscMalloc1 - Allocates an array of memory aligned to PETSC_MEMALIGN
509: Synopsis:
510: #include <petscsys.h>
511: PetscErrorCode PetscMalloc1(size_t m1,type **r1)
513: Not Collective
515: Input Parameter:
516: . m1 - number of elements to allocate (may be zero)
518: Output Parameter:
519: . r1 - memory allocated
521: Note:
522: This uses the sizeof() of the memory type requested to determine the total memory to be allocated, therefore you should not
523: multiply the number of elements requested by the sizeof() the type. For example use
524: $ PetscInt *id;
525: $ PetscMalloc1(10,&id);
526: not
527: $ PetscInt *id;
528: $ PetscMalloc1(10*sizeof(PetscInt),&id);
530: Does not zero the memory allocated, use PetscCalloc1() to obtain memory that has been zeroed.
532: Level: beginner
534: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscCalloc1(), PetscMalloc2()
536: M*/
537: #define PetscMalloc1(m1,r1) PetscMallocA(1,PETSC_FALSE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1))
539: /*MC
540: PetscCalloc1 - Allocates a cleared (zeroed) array of memory aligned to PETSC_MEMALIGN
542: Synopsis:
543: #include <petscsys.h>
544: PetscErrorCode PetscCalloc1(size_t m1,type **r1)
546: Not Collective
548: Input Parameter:
549: . m1 - number of elements to allocate in 1st chunk (may be zero)
551: Output Parameter:
552: . r1 - memory allocated
554: Notes:
555: See PetsMalloc1() for more details on usage.
557: Level: beginner
559: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc1(), PetscCalloc2()
561: M*/
562: #define PetscCalloc1(m1,r1) PetscMallocA(1,PETSC_TRUE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1))
564: /*MC
565: PetscMalloc2 - Allocates 2 arrays of memory both aligned to PETSC_MEMALIGN
567: Synopsis:
568: #include <petscsys.h>
569: PetscErrorCode PetscMalloc2(size_t m1,type **r1,size_t m2,type **r2)
571: Not Collective
573: Input Parameter:
574: + m1 - number of elements to allocate in 1st chunk (may be zero)
575: - m2 - number of elements to allocate in 2nd chunk (may be zero)
577: Output Parameter:
578: + r1 - memory allocated in first chunk
579: - r2 - memory allocated in second chunk
581: Level: developer
583: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc1(), PetscCalloc2()
585: M*/
586: #define PetscMalloc2(m1,r1,m2,r2) PetscMallocA(2,PETSC_FALSE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2))
588: /*MC
589: PetscCalloc2 - Allocates 2 cleared (zeroed) arrays of memory both aligned to PETSC_MEMALIGN
591: Synopsis:
592: #include <petscsys.h>
593: PetscErrorCode PetscCalloc2(size_t m1,type **r1,size_t m2,type **r2)
595: Not Collective
597: Input Parameter:
598: + m1 - number of elements to allocate in 1st chunk (may be zero)
599: - m2 - number of elements to allocate in 2nd chunk (may be zero)
601: Output Parameter:
602: + r1 - memory allocated in first chunk
603: - r2 - memory allocated in second chunk
605: Level: developer
607: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscCalloc1(), PetscMalloc2()
609: M*/
610: #define PetscCalloc2(m1,r1,m2,r2) PetscMallocA(2,PETSC_TRUE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2))
612: /*MC
613: PetscMalloc3 - Allocates 3 arrays of memory, all aligned to PETSC_MEMALIGN
615: Synopsis:
616: #include <petscsys.h>
617: PetscErrorCode PetscMalloc3(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3)
619: Not Collective
621: Input Parameter:
622: + m1 - number of elements to allocate in 1st chunk (may be zero)
623: . m2 - number of elements to allocate in 2nd chunk (may be zero)
624: - m3 - number of elements to allocate in 3rd chunk (may be zero)
626: Output Parameter:
627: + r1 - memory allocated in first chunk
628: . r2 - memory allocated in second chunk
629: - r3 - memory allocated in third chunk
631: Level: developer
633: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc3(), PetscFree3()
635: M*/
636: #define PetscMalloc3(m1,r1,m2,r2,m3,r3) PetscMallocA(3,PETSC_FALSE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3))
638: /*MC
639: PetscCalloc3 - Allocates 3 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN
641: Synopsis:
642: #include <petscsys.h>
643: PetscErrorCode PetscCalloc3(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3)
645: Not Collective
647: Input Parameter:
648: + m1 - number of elements to allocate in 1st chunk (may be zero)
649: . m2 - number of elements to allocate in 2nd chunk (may be zero)
650: - m3 - number of elements to allocate in 3rd chunk (may be zero)
652: Output Parameter:
653: + r1 - memory allocated in first chunk
654: . r2 - memory allocated in second chunk
655: - r3 - memory allocated in third chunk
657: Level: developer
659: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscCalloc2(), PetscMalloc3(), PetscFree3()
661: M*/
662: #define PetscCalloc3(m1,r1,m2,r2,m3,r3) PetscMallocA(3,PETSC_TRUE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3))
664: /*MC
665: PetscMalloc4 - Allocates 4 arrays of memory, all aligned to PETSC_MEMALIGN
667: Synopsis:
668: #include <petscsys.h>
669: PetscErrorCode PetscMalloc4(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4)
671: Not Collective
673: Input Parameter:
674: + m1 - number of elements to allocate in 1st chunk (may be zero)
675: . m2 - number of elements to allocate in 2nd chunk (may be zero)
676: . m3 - number of elements to allocate in 3rd chunk (may be zero)
677: - m4 - number of elements to allocate in 4th chunk (may be zero)
679: Output Parameter:
680: + r1 - memory allocated in first chunk
681: . r2 - memory allocated in second chunk
682: . r3 - memory allocated in third chunk
683: - r4 - memory allocated in fourth chunk
685: Level: developer
687: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc4(), PetscFree4()
689: M*/
690: #define PetscMalloc4(m1,r1,m2,r2,m3,r3,m4,r4) PetscMallocA(4,PETSC_FALSE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3),(size_t)(m4)*sizeof(**(r4)),(r4))
692: /*MC
693: PetscCalloc4 - Allocates 4 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN
695: Synopsis:
696: #include <petscsys.h>
697: PetscErrorCode PetscCalloc4(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4)
699: Not Collective
701: Input Parameters:
702: + m1 - number of elements to allocate in 1st chunk (may be zero)
703: . m2 - number of elements to allocate in 2nd chunk (may be zero)
704: . m3 - number of elements to allocate in 3rd chunk (may be zero)
705: - m4 - number of elements to allocate in 4th chunk (may be zero)
707: Output Parameters:
708: + r1 - memory allocated in first chunk
709: . r2 - memory allocated in second chunk
710: . r3 - memory allocated in third chunk
711: - r4 - memory allocated in fourth chunk
713: Level: developer
715: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc4(), PetscFree4()
717: M*/
718: #define PetscCalloc4(m1,r1,m2,r2,m3,r3,m4,r4) PetscMallocA(4,PETSC_TRUE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3),(size_t)(m4)*sizeof(**(r4)),(r4))
720: /*MC
721: PetscMalloc5 - Allocates 5 arrays of memory, all aligned to PETSC_MEMALIGN
723: Synopsis:
724: #include <petscsys.h>
725: 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)
727: Not Collective
729: Input Parameters:
730: + m1 - number of elements to allocate in 1st chunk (may be zero)
731: . m2 - number of elements to allocate in 2nd chunk (may be zero)
732: . m3 - number of elements to allocate in 3rd chunk (may be zero)
733: . m4 - number of elements to allocate in 4th chunk (may be zero)
734: - m5 - number of elements to allocate in 5th chunk (may be zero)
736: Output Parameters:
737: + r1 - memory allocated in first chunk
738: . r2 - memory allocated in second chunk
739: . r3 - memory allocated in third chunk
740: . r4 - memory allocated in fourth chunk
741: - r5 - memory allocated in fifth chunk
743: Level: developer
745: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc5(), PetscFree5()
747: M*/
748: #define PetscMalloc5(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5) PetscMallocA(5,PETSC_FALSE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3),(size_t)(m4)*sizeof(**(r4)),(r4),(size_t)(m5)*sizeof(**(r5)),(r5))
750: /*MC
751: PetscCalloc5 - Allocates 5 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN
753: Synopsis:
754: #include <petscsys.h>
755: 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)
757: Not Collective
759: Input Parameters:
760: + m1 - number of elements to allocate in 1st chunk (may be zero)
761: . m2 - number of elements to allocate in 2nd chunk (may be zero)
762: . m3 - number of elements to allocate in 3rd chunk (may be zero)
763: . m4 - number of elements to allocate in 4th chunk (may be zero)
764: - m5 - number of elements to allocate in 5th chunk (may be zero)
766: Output Parameters:
767: + r1 - memory allocated in first chunk
768: . r2 - memory allocated in second chunk
769: . r3 - memory allocated in third chunk
770: . r4 - memory allocated in fourth chunk
771: - r5 - memory allocated in fifth chunk
773: Level: developer
775: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc5(), PetscFree5()
777: M*/
778: #define PetscCalloc5(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5) PetscMallocA(5,PETSC_TRUE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3),(size_t)(m4)*sizeof(**(r4)),(r4),(size_t)(m5)*sizeof(**(r5)),(r5))
780: /*MC
781: PetscMalloc6 - Allocates 6 arrays of memory, all aligned to PETSC_MEMALIGN
783: Synopsis:
784: #include <petscsys.h>
785: 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)
787: Not Collective
789: Input Parameters:
790: + m1 - number of elements to allocate in 1st chunk (may be zero)
791: . m2 - number of elements to allocate in 2nd chunk (may be zero)
792: . m3 - number of elements to allocate in 3rd chunk (may be zero)
793: . m4 - number of elements to allocate in 4th chunk (may be zero)
794: . m5 - number of elements to allocate in 5th chunk (may be zero)
795: - m6 - number of elements to allocate in 6th chunk (may be zero)
797: Output Parameteasr:
798: + r1 - memory allocated in first chunk
799: . r2 - memory allocated in second chunk
800: . r3 - memory allocated in third chunk
801: . r4 - memory allocated in fourth chunk
802: . r5 - memory allocated in fifth chunk
803: - r6 - memory allocated in sixth chunk
805: Level: developer
807: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc6(), PetscFree3(), PetscFree4(), PetscFree5(), PetscFree6()
809: M*/
810: #define PetscMalloc6(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6) PetscMallocA(6,PETSC_FALSE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3),(size_t)(m4)*sizeof(**(r4)),(r4),(size_t)(m5)*sizeof(**(r5)),(r5),(size_t)(m6)*sizeof(**(r6)),(r6))
812: /*MC
813: PetscCalloc6 - Allocates 6 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN
815: Synopsis:
816: #include <petscsys.h>
817: 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)
819: Not Collective
821: Input Parameters:
822: + m1 - number of elements to allocate in 1st chunk (may be zero)
823: . m2 - number of elements to allocate in 2nd chunk (may be zero)
824: . m3 - number of elements to allocate in 3rd chunk (may be zero)
825: . m4 - number of elements to allocate in 4th chunk (may be zero)
826: . m5 - number of elements to allocate in 5th chunk (may be zero)
827: - m6 - number of elements to allocate in 6th chunk (may be zero)
829: Output Parameters:
830: + r1 - memory allocated in first chunk
831: . r2 - memory allocated in second chunk
832: . r3 - memory allocated in third chunk
833: . r4 - memory allocated in fourth chunk
834: . r5 - memory allocated in fifth chunk
835: - r6 - memory allocated in sixth chunk
837: Level: developer
839: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscMalloc6(), PetscFree6()
841: M*/
842: #define PetscCalloc6(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6) PetscMallocA(6,PETSC_TRUE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3),(size_t)(m4)*sizeof(**(r4)),(r4),(size_t)(m5)*sizeof(**(r5)),(r5),(size_t)(m6)*sizeof(**(r6)),(r6))
844: /*MC
845: PetscMalloc7 - Allocates 7 arrays of memory, all aligned to PETSC_MEMALIGN
847: Synopsis:
848: #include <petscsys.h>
849: 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)
851: Not Collective
853: Input Parameters:
854: + m1 - number of elements to allocate in 1st chunk (may be zero)
855: . m2 - number of elements to allocate in 2nd chunk (may be zero)
856: . m3 - number of elements to allocate in 3rd chunk (may be zero)
857: . m4 - number of elements to allocate in 4th chunk (may be zero)
858: . m5 - number of elements to allocate in 5th chunk (may be zero)
859: . m6 - number of elements to allocate in 6th chunk (may be zero)
860: - m7 - number of elements to allocate in 7th chunk (may be zero)
862: Output Parameters:
863: + r1 - memory allocated in first chunk
864: . r2 - memory allocated in second chunk
865: . r3 - memory allocated in third chunk
866: . r4 - memory allocated in fourth chunk
867: . r5 - memory allocated in fifth chunk
868: . r6 - memory allocated in sixth chunk
869: - r7 - memory allocated in seventh chunk
871: Level: developer
873: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc7(), PetscFree7()
875: M*/
876: #define PetscMalloc7(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6,m7,r7) PetscMallocA(7,PETSC_FALSE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3),(size_t)(m4)*sizeof(**(r4)),(r4),(size_t)(m5)*sizeof(**(r5)),(r5),(size_t)(m6)*sizeof(**(r6)),(r6),(size_t)(m7)*sizeof(**(r7)),(r7))
878: /*MC
879: PetscCalloc7 - Allocates 7 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN
881: Synopsis:
882: #include <petscsys.h>
883: 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)
885: Not Collective
887: Input Parameters:
888: + m1 - number of elements to allocate in 1st chunk (may be zero)
889: . m2 - number of elements to allocate in 2nd chunk (may be zero)
890: . m3 - number of elements to allocate in 3rd chunk (may be zero)
891: . m4 - number of elements to allocate in 4th chunk (may be zero)
892: . m5 - number of elements to allocate in 5th chunk (may be zero)
893: . m6 - number of elements to allocate in 6th chunk (may be zero)
894: - m7 - number of elements to allocate in 7th chunk (may be zero)
896: Output Parameters:
897: + r1 - memory allocated in first chunk
898: . r2 - memory allocated in second chunk
899: . r3 - memory allocated in third chunk
900: . r4 - memory allocated in fourth chunk
901: . r5 - memory allocated in fifth chunk
902: . r6 - memory allocated in sixth chunk
903: - r7 - memory allocated in seventh chunk
905: Level: developer
907: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscMalloc7(), PetscFree7()
909: M*/
910: #define PetscCalloc7(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6,m7,r7) PetscMallocA(7,PETSC_TRUE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3),(size_t)(m4)*sizeof(**(r4)),(r4),(size_t)(m5)*sizeof(**(r5)),(r5),(size_t)(m6)*sizeof(**(r6)),(r6),(size_t)(m7)*sizeof(**(r7)),(r7))
912: /*MC
913: PetscNew - Allocates memory of a particular type, zeros the memory! Aligned to PETSC_MEMALIGN
915: Synopsis:
916: #include <petscsys.h>
917: PetscErrorCode PetscNew(type **result)
919: Not Collective
921: Output Parameter:
922: . result - memory allocated, sized to match pointer type
924: Level: beginner
926: .seealso: PetscFree(), PetscMalloc(), PetscNewLog(), PetscCalloc1(), PetscMalloc1()
928: M*/
929: #define PetscNew(b) PetscCalloc1(1,(b))
931: /*MC
932: PetscNewLog - Allocates memory of a type matching pointer, zeros the memory! Aligned to PETSC_MEMALIGN. Associates the memory allocated
933: with the given object using PetscLogObjectMemory().
935: Synopsis:
936: #include <petscsys.h>
937: PetscErrorCode PetscNewLog(PetscObject obj,type **result)
939: Not Collective
941: Input Parameter:
942: . obj - object memory is logged to
944: Output Parameter:
945: . result - memory allocated, sized to match pointer type
947: Level: developer
949: .seealso: PetscFree(), PetscMalloc(), PetscNew(), PetscLogObjectMemory(), PetscCalloc1(), PetscMalloc1()
951: M*/
952: #define PetscNewLog(o,b) (PetscNew((b)) || PetscLogObjectMemory((PetscObject)o,sizeof(**(b))))
954: /*MC
955: PetscFree - Frees memory
957: Synopsis:
958: #include <petscsys.h>
959: PetscErrorCode PetscFree(void *memory)
961: Not Collective
963: Input Parameter:
964: . memory - memory to free (the pointer is ALWAYS set to NULL upon success)
966: Level: beginner
968: Notes:
969: Do not free memory obtained with PetscMalloc2(), PetscCalloc2() etc, they must be freed with PetscFree2() etc.
971: It is safe to call PetscFree() on a NULL pointer.
973: .seealso: PetscNew(), PetscMalloc(), PetscNewLog(), PetscMalloc1(), PetscCalloc1()
975: M*/
976: #define PetscFree(a) ((*PetscTrFree)((void*)(a),__LINE__,PETSC_FUNCTION_NAME,__FILE__) || ((a) = NULL,0))
978: /*MC
979: PetscFree2 - Frees 2 chunks of memory obtained with PetscMalloc2()
981: Synopsis:
982: #include <petscsys.h>
983: PetscErrorCode PetscFree2(void *memory1,void *memory2)
985: Not Collective
987: Input Parameters:
988: + memory1 - memory to free
989: - memory2 - 2nd memory to free
991: Level: developer
993: Notes:
994: Memory must have been obtained with PetscMalloc2()
996: .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree()
998: M*/
999: #define PetscFree2(m1,m2) PetscFreeA(2,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2))
1001: /*MC
1002: PetscFree3 - Frees 3 chunks of memory obtained with PetscMalloc3()
1004: Synopsis:
1005: #include <petscsys.h>
1006: PetscErrorCode PetscFree3(void *memory1,void *memory2,void *memory3)
1008: Not Collective
1010: Input Parameters:
1011: + memory1 - memory to free
1012: . memory2 - 2nd memory to free
1013: - memory3 - 3rd memory to free
1015: Level: developer
1017: Notes:
1018: Memory must have been obtained with PetscMalloc3()
1020: .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3()
1022: M*/
1023: #define PetscFree3(m1,m2,m3) PetscFreeA(3,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3))
1025: /*MC
1026: PetscFree4 - Frees 4 chunks of memory obtained with PetscMalloc4()
1028: Synopsis:
1029: #include <petscsys.h>
1030: PetscErrorCode PetscFree4(void *m1,void *m2,void *m3,void *m4)
1032: Not Collective
1034: Input Parameters:
1035: + m1 - memory to free
1036: . m2 - 2nd memory to free
1037: . m3 - 3rd memory to free
1038: - m4 - 4th memory to free
1040: Level: developer
1042: Notes:
1043: Memory must have been obtained with PetscMalloc4()
1045: .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4()
1047: M*/
1048: #define PetscFree4(m1,m2,m3,m4) PetscFreeA(4,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3),&(m4))
1050: /*MC
1051: PetscFree5 - Frees 5 chunks of memory obtained with PetscMalloc5()
1053: Synopsis:
1054: #include <petscsys.h>
1055: PetscErrorCode PetscFree5(void *m1,void *m2,void *m3,void *m4,void *m5)
1057: Not Collective
1059: Input Parameters:
1060: + m1 - memory to free
1061: . m2 - 2nd memory to free
1062: . m3 - 3rd memory to free
1063: . m4 - 4th memory to free
1064: - m5 - 5th memory to free
1066: Level: developer
1068: Notes:
1069: Memory must have been obtained with PetscMalloc5()
1071: .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5()
1073: M*/
1074: #define PetscFree5(m1,m2,m3,m4,m5) PetscFreeA(5,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3),&(m4),&(m5))
1076: /*MC
1077: PetscFree6 - Frees 6 chunks of memory obtained with PetscMalloc6()
1079: Synopsis:
1080: #include <petscsys.h>
1081: PetscErrorCode PetscFree6(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6)
1083: Not Collective
1085: Input Parameters:
1086: + m1 - memory to free
1087: . m2 - 2nd memory to free
1088: . m3 - 3rd memory to free
1089: . m4 - 4th memory to free
1090: . m5 - 5th memory to free
1091: - m6 - 6th memory to free
1094: Level: developer
1096: Notes:
1097: Memory must have been obtained with PetscMalloc6()
1099: .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6()
1101: M*/
1102: #define PetscFree6(m1,m2,m3,m4,m5,m6) PetscFreeA(6,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3),&(m4),&(m5),&(m6))
1104: /*MC
1105: PetscFree7 - Frees 7 chunks of memory obtained with PetscMalloc7()
1107: Synopsis:
1108: #include <petscsys.h>
1109: PetscErrorCode PetscFree7(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6,void *m7)
1111: Not Collective
1113: Input Parameters:
1114: + m1 - memory to free
1115: . m2 - 2nd memory to free
1116: . m3 - 3rd memory to free
1117: . m4 - 4th memory to free
1118: . m5 - 5th memory to free
1119: . m6 - 6th memory to free
1120: - m7 - 7th memory to free
1123: Level: developer
1125: Notes:
1126: Memory must have been obtained with PetscMalloc7()
1128: .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6(),
1129: PetscMalloc7()
1131: M*/
1132: #define PetscFree7(m1,m2,m3,m4,m5,m6,m7) PetscFreeA(7,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3),&(m4),&(m5),&(m6),&(m7))
1134: PETSC_EXTERN PetscErrorCode PetscMallocA(int,PetscBool,int,const char *,const char *,size_t,void *,...);
1135: PETSC_EXTERN PetscErrorCode PetscFreeA(int,int,const char *,const char *,void *,...);
1136: PETSC_EXTERN PetscErrorCode (*PetscTrMalloc)(size_t,PetscBool,int,const char[],const char[],void**);
1137: PETSC_EXTERN PetscErrorCode (*PetscTrFree)(void*,int,const char[],const char[]);
1138: PETSC_EXTERN PetscErrorCode (*PetscTrRealloc)(size_t,int,const char[],const char[],void**);
1139: PETSC_EXTERN PetscErrorCode PetscMallocSetCoalesce(PetscBool);
1140: PETSC_EXTERN PetscErrorCode PetscMallocSet(PetscErrorCode (*)(size_t,PetscBool,int,const char[],const char[],void**),PetscErrorCode (*)(void*,int,const char[],const char[]),PetscErrorCode (*)(size_t,int,const char[],const char[], void **));
1141: PETSC_EXTERN PetscErrorCode PetscMallocClear(void);
1143: /*
1144: Unlike PetscMallocSet and PetscMallocClear which overwrite the existing settings, these two functions save the previous choice of allocator, and should be used in pair.
1145: */
1146: PETSC_EXTERN PetscErrorCode PetscMallocSetDRAM(void);
1147: PETSC_EXTERN PetscErrorCode PetscMallocResetDRAM(void);
1148: #if defined(PETSC_HAVE_CUDA)
1149: PETSC_EXTERN PetscErrorCode PetscMallocSetCUDAHost(void);
1150: PETSC_EXTERN PetscErrorCode PetscMallocResetCUDAHost(void);
1151: #endif
1153: #define MPIU_PETSCLOGDOUBLE MPI_DOUBLE
1154: #define MPIU_2PETSCLOGDOUBLE MPI_2DOUBLE_PRECISION
1156: /*
1157: Routines for tracing memory corruption/bleeding with default PETSc memory allocation
1158: */
1159: PETSC_EXTERN PetscErrorCode PetscMallocDump(FILE *);
1160: PETSC_EXTERN PetscErrorCode PetscMallocView(FILE *);
1161: PETSC_EXTERN PetscErrorCode PetscMallocGetCurrentUsage(PetscLogDouble *);
1162: PETSC_EXTERN PetscErrorCode PetscMallocGetMaximumUsage(PetscLogDouble *);
1163: PETSC_EXTERN PetscErrorCode PetscMallocPushMaximumUsage(int);
1164: PETSC_EXTERN PetscErrorCode PetscMallocPopMaximumUsage(int,PetscLogDouble*);
1165: PETSC_EXTERN PetscErrorCode PetscMallocSetDebug(PetscBool,PetscBool);
1166: PETSC_EXTERN PetscErrorCode PetscMallocGetDebug(PetscBool*,PetscBool*,PetscBool*);
1167: PETSC_EXTERN PetscErrorCode PetscMallocValidate(int,const char[],const char[]);
1168: PETSC_EXTERN PetscErrorCode PetscMallocViewSet(PetscLogDouble);
1169: PETSC_EXTERN PetscErrorCode PetscMallocViewGet(PetscBool*);
1171: PETSC_EXTERN const char *const PetscDataTypes[];
1172: PETSC_EXTERN PetscErrorCode PetscDataTypeToMPIDataType(PetscDataType,MPI_Datatype*);
1173: PETSC_EXTERN PetscErrorCode PetscMPIDataTypeToPetscDataType(MPI_Datatype,PetscDataType*);
1174: PETSC_EXTERN PetscErrorCode PetscDataTypeGetSize(PetscDataType,size_t*);
1175: PETSC_EXTERN PetscErrorCode PetscDataTypeFromString(const char*,PetscDataType*,PetscBool*);
1177: /*
1178: Basic memory and string operations. These are usually simple wrappers
1179: around the basic Unix system calls, but a few of them have additional
1180: functionality and/or error checking.
1181: */
1182: PETSC_EXTERN PetscErrorCode PetscBitMemcpy(void*,PetscInt,const void*,PetscInt,PetscInt,PetscDataType);
1183: PETSC_EXTERN PetscErrorCode PetscMemcmp(const void*,const void*,size_t,PetscBool *);
1184: PETSC_EXTERN PetscErrorCode PetscStrlen(const char[],size_t*);
1185: PETSC_EXTERN PetscErrorCode PetscStrToArray(const char[],char,int*,char ***);
1186: PETSC_EXTERN PetscErrorCode PetscStrToArrayDestroy(int,char **);
1187: PETSC_EXTERN PetscErrorCode PetscStrcmp(const char[],const char[],PetscBool *);
1188: PETSC_EXTERN PetscErrorCode PetscStrgrt(const char[],const char[],PetscBool *);
1189: PETSC_EXTERN PetscErrorCode PetscStrcasecmp(const char[],const char[],PetscBool *);
1190: PETSC_EXTERN PetscErrorCode PetscStrncmp(const char[],const char[],size_t,PetscBool *);
1191: PETSC_EXTERN PetscErrorCode PetscStrcpy(char[],const char[]);
1192: PETSC_EXTERN PetscErrorCode PetscStrcat(char[],const char[]);
1193: PETSC_EXTERN PetscErrorCode PetscStrlcat(char[],const char[],size_t);
1194: PETSC_EXTERN PetscErrorCode PetscStrncpy(char[],const char[],size_t);
1195: PETSC_EXTERN PetscErrorCode PetscStrchr(const char[],char,char *[]);
1196: PETSC_EXTERN PetscErrorCode PetscStrtolower(char[]);
1197: PETSC_EXTERN PetscErrorCode PetscStrtoupper(char[]);
1198: PETSC_EXTERN PetscErrorCode PetscStrrchr(const char[],char,char *[]);
1199: PETSC_EXTERN PetscErrorCode PetscStrstr(const char[],const char[],char *[]);
1200: PETSC_EXTERN PetscErrorCode PetscStrrstr(const char[],const char[],char *[]);
1201: PETSC_EXTERN PetscErrorCode PetscStrendswith(const char[],const char[],PetscBool*);
1202: PETSC_EXTERN PetscErrorCode PetscStrbeginswith(const char[],const char[],PetscBool*);
1203: PETSC_EXTERN PetscErrorCode PetscStrendswithwhich(const char[],const char *const*,PetscInt*);
1204: PETSC_EXTERN PetscErrorCode PetscStrallocpy(const char[],char *[]);
1205: PETSC_EXTERN PetscErrorCode PetscStrArrayallocpy(const char *const*,char***);
1206: PETSC_EXTERN PetscErrorCode PetscStrArrayDestroy(char***);
1207: PETSC_EXTERN PetscErrorCode PetscStrNArrayallocpy(PetscInt,const char *const*,char***);
1208: PETSC_EXTERN PetscErrorCode PetscStrNArrayDestroy(PetscInt,char***);
1209: PETSC_EXTERN PetscErrorCode PetscStrreplace(MPI_Comm,const char[],char[],size_t);
1211: PETSC_EXTERN void PetscStrcmpNoError(const char[],const char[],PetscBool *);
1213: PETSC_EXTERN PetscErrorCode PetscTokenCreate(const char[],const char,PetscToken*);
1214: PETSC_EXTERN PetscErrorCode PetscTokenFind(PetscToken,char *[]);
1215: PETSC_EXTERN PetscErrorCode PetscTokenDestroy(PetscToken*);
1217: PETSC_EXTERN PetscErrorCode PetscStrInList(const char[],const char[],char,PetscBool*);
1218: PETSC_EXTERN PetscErrorCode PetscEListFind(PetscInt,const char *const*,const char*,PetscInt*,PetscBool*);
1219: PETSC_EXTERN PetscErrorCode PetscEnumFind(const char *const*,const char*,PetscEnum*,PetscBool*);
1221: /*
1222: These are MPI operations for MPI_Allreduce() etc
1223: */
1224: PETSC_EXTERN MPI_Op MPIU_MAXSUM_OP;
1225: #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
1226: PETSC_EXTERN MPI_Op MPIU_SUM;
1227: #else
1228: #define MPIU_SUM MPI_SUM
1229: #endif
1230: #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
1231: PETSC_EXTERN MPI_Op MPIU_MAX;
1232: PETSC_EXTERN MPI_Op MPIU_MIN;
1233: #else
1234: #define MPIU_MAX MPI_MAX
1235: #define MPIU_MIN MPI_MIN
1236: #endif
1237: PETSC_EXTERN PetscErrorCode PetscMaxSum(MPI_Comm,const PetscInt[],PetscInt*,PetscInt*);
1239: PETSC_EXTERN PetscErrorCode MPIULong_Send(void*,PetscInt,MPI_Datatype,PetscMPIInt,PetscMPIInt,MPI_Comm);
1240: PETSC_EXTERN PetscErrorCode MPIULong_Recv(void*,PetscInt,MPI_Datatype,PetscMPIInt,PetscMPIInt,MPI_Comm);
1242: PETSC_EXTERN const char *const PetscFileModes[];
1244: /*
1245: Defines PETSc error handling.
1246: */
1247: #include <petscerror.h>
1249: #define PETSC_SMALLEST_CLASSID 1211211
1250: PETSC_EXTERN PetscClassId PETSC_LARGEST_CLASSID;
1251: PETSC_EXTERN PetscClassId PETSC_OBJECT_CLASSID;
1252: PETSC_EXTERN PetscErrorCode PetscClassIdRegister(const char[],PetscClassId *);
1253: PETSC_EXTERN PetscErrorCode PetscObjectGetId(PetscObject,PetscObjectId*);
1254: PETSC_EXTERN PetscErrorCode PetscObjectCompareId(PetscObject,PetscObjectId,PetscBool*);
1257: /*
1258: Routines that get memory usage information from the OS
1259: */
1260: PETSC_EXTERN PetscErrorCode PetscMemoryGetCurrentUsage(PetscLogDouble *);
1261: PETSC_EXTERN PetscErrorCode PetscMemoryGetMaximumUsage(PetscLogDouble *);
1262: PETSC_EXTERN PetscErrorCode PetscMemorySetGetMaximumUsage(void);
1263: PETSC_EXTERN PetscErrorCode PetscMemoryTrace(const char[]);
1265: PETSC_EXTERN PetscErrorCode PetscSleep(PetscReal);
1267: /*
1268: Initialization of PETSc
1269: */
1270: PETSC_EXTERN PetscErrorCode PetscInitialize(int*,char***,const char[],const char[]);
1271: PETSC_EXTERN PetscErrorCode PetscInitializeNoPointers(int,char**,const char[],const char[]);
1272: PETSC_EXTERN PetscErrorCode PetscInitializeNoArguments(void);
1273: PETSC_EXTERN PetscErrorCode PetscInitialized(PetscBool *);
1274: PETSC_EXTERN PetscErrorCode PetscFinalized(PetscBool *);
1275: PETSC_EXTERN PetscErrorCode PetscFinalize(void);
1276: PETSC_EXTERN PetscErrorCode PetscInitializeFortran(void);
1277: PETSC_EXTERN PetscErrorCode PetscGetArgs(int*,char ***);
1278: PETSC_EXTERN PetscErrorCode PetscGetArguments(char ***);
1279: PETSC_EXTERN PetscErrorCode PetscFreeArguments(char **);
1281: PETSC_EXTERN PetscErrorCode PetscEnd(void);
1282: PETSC_EXTERN PetscErrorCode PetscSysInitializePackage(void);
1284: PETSC_EXTERN PetscErrorCode PetscPythonInitialize(const char[],const char[]);
1285: PETSC_EXTERN PetscErrorCode PetscPythonFinalize(void);
1286: PETSC_EXTERN PetscErrorCode PetscPythonPrintError(void);
1287: PETSC_EXTERN PetscErrorCode PetscPythonMonitorSet(PetscObject,const char[]);
1289: PETSC_EXTERN PetscErrorCode PetscMonitorCompare(PetscErrorCode (*)(void),void *,PetscErrorCode (*)(void**),PetscErrorCode (*)(void),void *,PetscErrorCode (*)(void**),PetscBool *);
1292: /*
1293: These are so that in extern C code we can caste function pointers to non-extern C
1294: function pointers. Since the regular C++ code expects its function pointers to be C++
1295: */
1296: PETSC_EXTERN_TYPEDEF typedef void (**PetscVoidStarFunction)(void);
1297: PETSC_EXTERN_TYPEDEF typedef void (*PetscVoidFunction)(void);
1298: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*PetscErrorCodeFunction)(void);
1300: /*
1301: Functions that can act on any PETSc object.
1302: */
1303: PETSC_EXTERN PetscErrorCode PetscObjectDestroy(PetscObject*);
1304: PETSC_EXTERN PetscErrorCode PetscObjectGetComm(PetscObject,MPI_Comm *);
1305: PETSC_EXTERN PetscErrorCode PetscObjectGetClassId(PetscObject,PetscClassId *);
1306: PETSC_EXTERN PetscErrorCode PetscObjectGetClassName(PetscObject,const char *[]);
1307: PETSC_EXTERN PetscErrorCode PetscObjectSetType(PetscObject,const char []);
1308: PETSC_EXTERN PetscErrorCode PetscObjectGetType(PetscObject,const char *[]);
1309: PETSC_EXTERN PetscErrorCode PetscObjectSetName(PetscObject,const char[]);
1310: PETSC_EXTERN PetscErrorCode PetscObjectGetName(PetscObject,const char*[]);
1311: PETSC_EXTERN PetscErrorCode PetscObjectSetTabLevel(PetscObject,PetscInt);
1312: PETSC_EXTERN PetscErrorCode PetscObjectGetTabLevel(PetscObject,PetscInt*);
1313: PETSC_EXTERN PetscErrorCode PetscObjectIncrementTabLevel(PetscObject,PetscObject,PetscInt);
1314: PETSC_EXTERN PetscErrorCode PetscObjectReference(PetscObject);
1315: PETSC_EXTERN PetscErrorCode PetscObjectGetReference(PetscObject,PetscInt*);
1316: PETSC_EXTERN PetscErrorCode PetscObjectDereference(PetscObject);
1317: PETSC_EXTERN PetscErrorCode PetscObjectGetNewTag(PetscObject,PetscMPIInt *);
1318: PETSC_EXTERN PetscErrorCode PetscObjectCompose(PetscObject,const char[],PetscObject);
1319: PETSC_EXTERN PetscErrorCode PetscObjectRemoveReference(PetscObject,const char[]);
1320: PETSC_EXTERN PetscErrorCode PetscObjectQuery(PetscObject,const char[],PetscObject *);
1321: PETSC_EXTERN PetscErrorCode PetscObjectComposeFunction_Private(PetscObject,const char[],void (*)(void));
1322: #define PetscObjectComposeFunction(a,b,d) PetscObjectComposeFunction_Private(a,b,(PetscVoidFunction)(d))
1323: PETSC_EXTERN PetscErrorCode PetscObjectSetFromOptions(PetscObject);
1324: PETSC_EXTERN PetscErrorCode PetscObjectSetUp(PetscObject);
1325: PETSC_EXTERN PetscErrorCode PetscObjectSetPrintedOptions(PetscObject);
1326: PETSC_EXTERN PetscErrorCode PetscObjectInheritPrintedOptions(PetscObject,PetscObject);
1327: PETSC_EXTERN PetscErrorCode PetscCommGetNewTag(MPI_Comm,PetscMPIInt *);
1329: #include <petscviewertypes.h>
1330: #include <petscoptions.h>
1332: PETSC_EXTERN PetscErrorCode PetscObjectsListGetGlobalNumbering(MPI_Comm,PetscInt,PetscObject*,PetscInt*,PetscInt*);
1334: PETSC_EXTERN PetscErrorCode PetscMemoryShowUsage(PetscViewer,const char[]);
1335: PETSC_EXTERN PetscErrorCode PetscMemoryView(PetscViewer,const char[]);
1336: PETSC_EXTERN PetscErrorCode PetscObjectPrintClassNamePrefixType(PetscObject,PetscViewer);
1337: PETSC_EXTERN PetscErrorCode PetscObjectView(PetscObject,PetscViewer);
1338: #define PetscObjectQueryFunction(obj,name,fptr) PetscObjectQueryFunction_Private((obj),(name),(PetscVoidFunction*)(fptr))
1339: PETSC_EXTERN PetscErrorCode PetscObjectQueryFunction_Private(PetscObject,const char[],void (**)(void));
1340: PETSC_EXTERN PetscErrorCode PetscObjectSetOptionsPrefix(PetscObject,const char[]);
1341: PETSC_EXTERN PetscErrorCode PetscObjectAppendOptionsPrefix(PetscObject,const char[]);
1342: PETSC_EXTERN PetscErrorCode PetscObjectPrependOptionsPrefix(PetscObject,const char[]);
1343: PETSC_EXTERN PetscErrorCode PetscObjectGetOptionsPrefix(PetscObject,const char*[]);
1344: PETSC_EXTERN PetscErrorCode PetscObjectChangeTypeName(PetscObject,const char[]);
1345: PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroy(PetscObject);
1346: PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroyAll(void);
1347: PETSC_EXTERN PetscErrorCode PetscObjectViewFromOptions(PetscObject,PetscObject,const char[]);
1348: PETSC_EXTERN PetscErrorCode PetscObjectName(PetscObject);
1349: PETSC_EXTERN PetscErrorCode PetscObjectTypeCompare(PetscObject,const char[],PetscBool *);
1350: PETSC_EXTERN PetscErrorCode PetscObjectBaseTypeCompare(PetscObject,const char[],PetscBool *);
1351: PETSC_EXTERN PetscErrorCode PetscObjectTypeCompareAny(PetscObject,PetscBool*,const char[],...);
1352: PETSC_EXTERN PetscErrorCode PetscObjectBaseTypeCompareAny(PetscObject,PetscBool*,const char[],...);
1353: PETSC_EXTERN PetscErrorCode PetscRegisterFinalize(PetscErrorCode (*)(void));
1354: PETSC_EXTERN PetscErrorCode PetscRegisterFinalizeAll(void);
1356: #if defined(PETSC_HAVE_SAWS)
1357: PETSC_EXTERN PetscErrorCode PetscSAWsBlock(void);
1358: PETSC_EXTERN PetscErrorCode PetscObjectSAWsViewOff(PetscObject);
1359: PETSC_EXTERN PetscErrorCode PetscObjectSAWsSetBlock(PetscObject,PetscBool);
1360: PETSC_EXTERN PetscErrorCode PetscObjectSAWsBlock(PetscObject);
1361: PETSC_EXTERN PetscErrorCode PetscObjectSAWsGrantAccess(PetscObject);
1362: PETSC_EXTERN PetscErrorCode PetscObjectSAWsTakeAccess(PetscObject);
1363: PETSC_EXTERN void PetscStackSAWsGrantAccess(void);
1364: PETSC_EXTERN void PetscStackSAWsTakeAccess(void);
1365: PETSC_EXTERN PetscErrorCode PetscStackViewSAWs(void);
1366: PETSC_EXTERN PetscErrorCode PetscStackSAWsViewOff(void);
1368: #else
1369: #define PetscSAWsBlock() 0
1370: #define PetscObjectSAWsViewOff(obj) 0
1371: #define PetscObjectSAWsSetBlock(obj,flg) 0
1372: #define PetscObjectSAWsBlock(obj) 0
1373: #define PetscObjectSAWsGrantAccess(obj) 0
1374: #define PetscObjectSAWsTakeAccess(obj) 0
1375: #define PetscStackViewSAWs() 0
1376: #define PetscStackSAWsViewOff() 0
1377: #define PetscStackSAWsTakeAccess()
1378: #define PetscStackSAWsGrantAccess()
1380: #endif
1382: PETSC_EXTERN PetscErrorCode PetscDLOpen(const char[],PetscDLMode,PetscDLHandle *);
1383: PETSC_EXTERN PetscErrorCode PetscDLClose(PetscDLHandle *);
1384: PETSC_EXTERN PetscErrorCode PetscDLSym(PetscDLHandle,const char[],void **);
1386: #if defined(PETSC_USE_DEBUG)
1387: PETSC_EXTERN PetscErrorCode PetscMallocGetStack(void*,PetscStack**);
1388: #endif
1389: PETSC_EXTERN PetscErrorCode PetscObjectsDump(FILE*,PetscBool);
1391: PETSC_EXTERN PetscErrorCode PetscObjectListDestroy(PetscObjectList*);
1392: PETSC_EXTERN PetscErrorCode PetscObjectListFind(PetscObjectList,const char[],PetscObject*);
1393: PETSC_EXTERN PetscErrorCode PetscObjectListReverseFind(PetscObjectList,PetscObject,char**,PetscBool*);
1394: PETSC_EXTERN PetscErrorCode PetscObjectListAdd(PetscObjectList *,const char[],PetscObject);
1395: PETSC_EXTERN PetscErrorCode PetscObjectListRemoveReference(PetscObjectList *,const char[]);
1396: PETSC_EXTERN PetscErrorCode PetscObjectListDuplicate(PetscObjectList,PetscObjectList *);
1398: /*
1399: Dynamic library lists. Lists of names of routines in objects or in dynamic
1400: link libraries that will be loaded as needed.
1401: */
1403: #define PetscFunctionListAdd(list,name,fptr) PetscFunctionListAdd_Private((list),(name),(PetscVoidFunction)(fptr))
1404: PETSC_EXTERN PetscErrorCode PetscFunctionListAdd_Private(PetscFunctionList*,const char[],void (*)(void));
1405: PETSC_EXTERN PetscErrorCode PetscFunctionListDestroy(PetscFunctionList*);
1406: #define PetscFunctionListFind(list,name,fptr) PetscFunctionListFind_Private((list),(name),(PetscVoidFunction*)(fptr))
1407: PETSC_EXTERN PetscErrorCode PetscFunctionListFind_Private(PetscFunctionList,const char[],void (**)(void));
1408: PETSC_EXTERN PetscErrorCode PetscFunctionListPrintTypes(MPI_Comm,FILE*,const char[],const char[],const char[],const char[],PetscFunctionList,const char[],const char[]);
1409: PETSC_EXTERN PetscErrorCode PetscFunctionListDuplicate(PetscFunctionList,PetscFunctionList *);
1410: PETSC_EXTERN PetscErrorCode PetscFunctionListView(PetscFunctionList,PetscViewer);
1411: PETSC_EXTERN PetscErrorCode PetscFunctionListGet(PetscFunctionList,const char ***,int*);
1413: PETSC_EXTERN PetscDLLibrary PetscDLLibrariesLoaded;
1414: PETSC_EXTERN PetscErrorCode PetscDLLibraryAppend(MPI_Comm,PetscDLLibrary *,const char[]);
1415: PETSC_EXTERN PetscErrorCode PetscDLLibraryPrepend(MPI_Comm,PetscDLLibrary *,const char[]);
1416: PETSC_EXTERN PetscErrorCode PetscDLLibrarySym(MPI_Comm,PetscDLLibrary *,const char[],const char[],void **);
1417: PETSC_EXTERN PetscErrorCode PetscDLLibraryPrintPath(PetscDLLibrary);
1418: PETSC_EXTERN PetscErrorCode PetscDLLibraryRetrieve(MPI_Comm,const char[],char *,size_t,PetscBool *);
1419: PETSC_EXTERN PetscErrorCode PetscDLLibraryOpen(MPI_Comm,const char[],PetscDLLibrary *);
1420: PETSC_EXTERN PetscErrorCode PetscDLLibraryClose(PetscDLLibrary);
1422: /*
1423: Useful utility routines
1424: */
1425: PETSC_EXTERN PetscErrorCode PetscSplitOwnership(MPI_Comm,PetscInt*,PetscInt*);
1426: PETSC_EXTERN PetscErrorCode PetscSplitOwnershipBlock(MPI_Comm,PetscInt,PetscInt*,PetscInt*);
1427: PETSC_EXTERN PetscErrorCode PetscSequentialPhaseBegin(MPI_Comm,PetscMPIInt);
1428: PETSC_EXTERN PetscErrorCode PetscSequentialPhaseEnd(MPI_Comm,PetscMPIInt);
1429: PETSC_EXTERN PetscErrorCode PetscBarrier(PetscObject);
1430: PETSC_EXTERN PetscErrorCode PetscMPIDump(FILE*);
1431: PETSC_EXTERN PetscErrorCode PetscGlobalMinMaxInt(MPI_Comm,PetscInt[],PetscInt[]);
1432: PETSC_EXTERN PetscErrorCode PetscGlobalMinMaxReal(MPI_Comm,PetscReal[],PetscReal[]);
1434: /*MC
1435: PetscNot - negates a logical type value and returns result as a PetscBool
1437: Notes:
1438: This is useful in cases like
1439: $ int *a;
1440: $ PetscBool flag = PetscNot(a)
1441: where !a would not return a PetscBool because we cannot provide a cast from int to PetscBool in C.
1443: Level: beginner
1445: .seealso : PetscBool, PETSC_TRUE, PETSC_FALSE
1446: M*/
1447: #define PetscNot(a) ((a) ? PETSC_FALSE : PETSC_TRUE)
1449: /*MC
1450: PetscHelpPrintf - Prints help messages.
1452: Synopsis:
1453: #include <petscsys.h>
1454: PetscErrorCode (*PetscHelpPrintf)(const char format[],...);
1456: Not Collective
1458: Input Parameters:
1459: . format - the usual printf() format string
1461: Level: developer
1463: Fortran Note:
1464: This routine is not supported in Fortran.
1467: .seealso: PetscFPrintf(), PetscSynchronizedPrintf(), PetscErrorPrintf()
1468: M*/
1469: PETSC_EXTERN PetscErrorCode (*PetscHelpPrintf)(MPI_Comm,const char[],...);
1471: /*
1472: Defines PETSc profiling.
1473: */
1474: #include <petsclog.h>
1476: /*
1477: Simple PETSc parallel IO for ASCII printing
1478: */
1479: PETSC_EXTERN PetscErrorCode PetscFixFilename(const char[],char[]);
1480: PETSC_EXTERN PetscErrorCode PetscFOpen(MPI_Comm,const char[],const char[],FILE**);
1481: PETSC_EXTERN PetscErrorCode PetscFClose(MPI_Comm,FILE*);
1482: PETSC_EXTERN PetscErrorCode PetscFPrintf(MPI_Comm,FILE*,const char[],...);
1483: PETSC_EXTERN PetscErrorCode PetscPrintf(MPI_Comm,const char[],...);
1484: PETSC_EXTERN PetscErrorCode PetscSNPrintf(char*,size_t,const char [],...);
1485: PETSC_EXTERN PetscErrorCode PetscSNPrintfCount(char*,size_t,const char [],size_t*,...);
1486: PETSC_EXTERN PetscErrorCode PetscFormatRealArray(char[],size_t,const char*,PetscInt,const PetscReal[]);
1488: PETSC_EXTERN PetscErrorCode PetscErrorPrintfDefault(const char [],...);
1489: PETSC_EXTERN PetscErrorCode PetscErrorPrintfNone(const char [],...);
1490: PETSC_EXTERN PetscErrorCode PetscHelpPrintfDefault(MPI_Comm,const char [],...);
1492: PETSC_EXTERN PetscErrorCode PetscFormatConvertGetSize(const char*,size_t*);
1493: PETSC_EXTERN PetscErrorCode PetscFormatConvert(const char*,char *);
1495: #if defined(PETSC_HAVE_POPEN)
1496: PETSC_EXTERN PetscErrorCode PetscPOpen(MPI_Comm,const char[],const char[],const char[],FILE **);
1497: PETSC_EXTERN PetscErrorCode PetscPClose(MPI_Comm,FILE*);
1498: PETSC_EXTERN PetscErrorCode PetscPOpenSetMachine(const char[]);
1499: #endif
1501: PETSC_EXTERN PetscErrorCode PetscSynchronizedPrintf(MPI_Comm,const char[],...);
1502: PETSC_EXTERN PetscErrorCode PetscSynchronizedFPrintf(MPI_Comm,FILE*,const char[],...);
1503: PETSC_EXTERN PetscErrorCode PetscSynchronizedFlush(MPI_Comm,FILE*);
1504: PETSC_EXTERN PetscErrorCode PetscSynchronizedFGets(MPI_Comm,FILE*,size_t,char[]);
1505: PETSC_EXTERN PetscErrorCode PetscStartMatlab(MPI_Comm,const char[],const char[],FILE**);
1506: PETSC_EXTERN PetscErrorCode PetscStartJava(MPI_Comm,const char[],const char[],FILE**);
1507: PETSC_EXTERN PetscErrorCode PetscGetPetscDir(const char*[]);
1509: PETSC_EXTERN PetscClassId PETSC_CONTAINER_CLASSID;
1510: PETSC_EXTERN PetscErrorCode PetscContainerGetPointer(PetscContainer,void **);
1511: PETSC_EXTERN PetscErrorCode PetscContainerSetPointer(PetscContainer,void *);
1512: PETSC_EXTERN PetscErrorCode PetscContainerDestroy(PetscContainer*);
1513: PETSC_EXTERN PetscErrorCode PetscContainerCreate(MPI_Comm,PetscContainer *);
1514: PETSC_EXTERN PetscErrorCode PetscContainerSetUserDestroy(PetscContainer, PetscErrorCode (*)(void*));
1515: PETSC_EXTERN PetscErrorCode PetscContainerUserDestroyDefault(void*);
1517: /*
1518: For use in debuggers
1519: */
1520: PETSC_EXTERN PetscMPIInt PetscGlobalRank;
1521: PETSC_EXTERN PetscMPIInt PetscGlobalSize;
1522: PETSC_EXTERN PetscErrorCode PetscIntView(PetscInt,const PetscInt[],PetscViewer);
1523: PETSC_EXTERN PetscErrorCode PetscRealView(PetscInt,const PetscReal[],PetscViewer);
1524: PETSC_EXTERN PetscErrorCode PetscScalarView(PetscInt,const PetscScalar[],PetscViewer);
1526: #include <stddef.h>
1527: #include <string.h> /* for memcpy, memset */
1528: #include <stdlib.h>
1530: #if defined(PETSC_HAVE_XMMINTRIN_H) && !defined(__CUDACC__)
1531: #include <xmmintrin.h>
1532: #endif
1534: /*@C
1535: PetscMemmove - Copies n bytes, beginning at location b, to the space
1536: beginning at location a. Copying between regions that overlap will
1537: take place correctly. Use PetscMemcpy() if the locations do not overlap
1539: Not Collective
1541: Input Parameters:
1542: + b - pointer to initial memory space
1543: . a - pointer to copy space
1544: - n - length (in bytes) of space to copy
1546: Level: intermediate
1548: Note:
1549: PetscArraymove() is preferred
1550: This routine is analogous to memmove().
1552: Developers Note: This is inlined for performance
1554: .seealso: PetscMemcpy(), PetscMemcmp(), PetscArrayzero(), PetscMemzero(), PetscArraycmp(), PetscArraycpy(), PetscStrallocpy(),
1555: PetscArraymove()
1556: @*/
1557: PETSC_STATIC_INLINE PetscErrorCode PetscMemmove(void *a,const void *b,size_t n)
1558: {
1560: if (n > 0 && !a) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy to null pointer");
1561: if (n > 0 && !b) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy from a null pointer");
1562: #if !defined(PETSC_HAVE_MEMMOVE)
1563: if (a < b) {
1564: if (a <= b - n) memcpy(a,b,n);
1565: else {
1566: memcpy(a,b,(int)(b - a));
1567: PetscMemmove(b,b + (int)(b - a),n - (int)(b - a));
1568: }
1569: } else {
1570: if (b <= a - n) memcpy(a,b,n);
1571: else {
1572: memcpy(b + n,b + (n - (int)(a - b)),(int)(a - b));
1573: PetscMemmove(a,b,n - (int)(a - b));
1574: }
1575: }
1576: #else
1577: memmove((char*)(a),(char*)(b),n);
1578: #endif
1579: return(0);
1580: }
1582: /*@C
1583: PetscMemcpy - Copies n bytes, beginning at location b, to the space
1584: beginning at location a. The two memory regions CANNOT overlap, use
1585: PetscMemmove() in that case.
1587: Not Collective
1589: Input Parameters:
1590: + b - pointer to initial memory space
1591: - n - length (in bytes) of space to copy
1593: Output Parameter:
1594: . a - pointer to copy space
1596: Level: intermediate
1598: Compile Option:
1599: PETSC_PREFER_DCOPY_FOR_MEMCPY will cause the BLAS dcopy() routine to be used
1600: for memory copies on double precision values.
1601: PETSC_PREFER_COPY_FOR_MEMCPY will cause C code to be used
1602: for memory copies on double precision values.
1603: PETSC_PREFER_FORTRAN_FORMEMCPY will cause Fortran code to be used
1604: for memory copies on double precision values.
1606: Note:
1607: Prefer PetscArraycpy()
1608: This routine is analogous to memcpy().
1609: Not available from Fortran
1611: Developer Note: this is inlined for fastest performance
1613: .seealso: PetscMemzero(), PetscMemcmp(), PetscArrayzero(), PetscArraycmp(), PetscArraycpy(), PetscMemmove(), PetscStrallocpy()
1615: @*/
1616: PETSC_STATIC_INLINE PetscErrorCode PetscMemcpy(void *a,const void *b,size_t n)
1617: {
1618: #if defined(PETSC_USE_DEBUG)
1619: size_t al = (size_t) a,bl = (size_t) b;
1620: size_t nl = (size_t) n;
1622: if (n > 0 && !b) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy from a null pointer");
1623: if (n > 0 && !a) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy to a null pointer");
1624: #else
1626: #endif
1627: if (a != b && n > 0) {
1628: #if defined(PETSC_USE_DEBUG)
1629: if ((al > bl && (al - bl) < nl) || (bl - al) < nl) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_ARG_INCOMP,"Memory regions overlap: either use PetscMemmov()\n\
1630: or make sure your copy regions and lengths are correct. \n\
1631: Length (bytes) %ld first address %ld second address %ld",nl,al,bl);
1632: #endif
1633: #if (defined(PETSC_PREFER_DCOPY_FOR_MEMCPY) || defined(PETSC_PREFER_COPY_FOR_MEMCPY) || defined(PETSC_PREFER_FORTRAN_FORMEMCPY))
1634: if (!(a % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) {
1635: size_t len = n/sizeof(PetscScalar);
1636: #if defined(PETSC_PREFER_DCOPY_FOR_MEMCPY)
1637: PetscBLASInt one = 1,blen;
1639: PetscBLASIntCast(len,&blen);
1640: PetscStackCallBLAS("BLAScopy",BLAScopy_(&blen,(PetscScalar *)b,&one,(PetscScalar *)a,&one));
1641: #elif defined(PETSC_PREFER_FORTRAN_FORMEMCPY)
1642: fortrancopy_(&len,(PetscScalar*)b,(PetscScalar*)a);
1643: #else
1644: size_t i;
1645: PetscScalar *x = (PetscScalar*)b, *y = (PetscScalar*)a;
1646: for (i=0; i<len; i++) y[i] = x[i];
1647: #endif
1648: } else {
1649: memcpy((char*)(a),(char*)(b),n);
1650: }
1651: #else
1652: memcpy((char*)(a),(char*)(b),n);
1653: #endif
1654: }
1655: return(0);
1656: }
1658: /*@C
1659: PetscMemzero - Zeros the specified memory.
1661: Not Collective
1663: Input Parameters:
1664: + a - pointer to beginning memory location
1665: - n - length (in bytes) of memory to initialize
1667: Level: intermediate
1669: Compile Option:
1670: PETSC_PREFER_BZERO - on certain machines (the IBM RS6000) the bzero() routine happens
1671: to be faster than the memset() routine. This flag causes the bzero() routine to be used.
1673: Not available from Fortran
1674: Prefer PetscArrayzero()
1676: Developer Note: this is inlined for fastest performance
1678: .seealso: PetscMemcpy(), PetscMemcmp(), PetscArrayzero(), PetscArraycmp(), PetscArraycpy(), PetscMemmove(), PetscStrallocpy()
1679: @*/
1680: PETSC_STATIC_INLINE PetscErrorCode PetscMemzero(void *a,size_t n)
1681: {
1682: if (n > 0) {
1683: #if defined(PETSC_USE_DEBUG)
1684: if (!a) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to zero at a null pointer");
1685: #endif
1686: #if defined(PETSC_PREFER_ZERO_FOR_MEMZERO)
1687: if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) {
1688: size_t i,len = n/sizeof(PetscScalar);
1689: PetscScalar *x = (PetscScalar*)a;
1690: for (i=0; i<len; i++) x[i] = 0.0;
1691: } else {
1692: #elif defined(PETSC_PREFER_FORTRAN_FOR_MEMZERO)
1693: if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) {
1694: PetscInt len = n/sizeof(PetscScalar);
1695: fortranzero_(&len,(PetscScalar*)a);
1696: } else {
1697: #endif
1698: #if defined(PETSC_PREFER_BZERO)
1699: bzero((char *)a,n);
1700: #else
1701: memset((char*)a,0,n);
1702: #endif
1703: #if defined(PETSC_PREFER_ZERO_FOR_MEMZERO) || defined(PETSC_PREFER_FORTRAN_FOR_MEMZERO)
1704: }
1705: #endif
1706: }
1707: return 0;
1708: }
1710: /*MC
1711: PetscArraycmp - Compares two arrays in memory.
1713: Synopsis:
1714: #include <petscsys.h>
1715: PetscErrorCode PetscArraycmp(const anytype *str1,const anytype *str2,size_t cnt,PetscBool *e)
1717: Not Collective
1719: Input Parameters:
1720: + str1 - First array
1721: . str2 - Second array
1722: - cnt - Count of the array, not in bytes, but number of entries in the arrays
1724: Output Parameters:
1725: . e - PETSC_TRUE if equal else PETSC_FALSE.
1727: Level: intermediate
1729: Note:
1730: This routine is a preferred replacement to PetscMemcmp()
1731: The arrays must be of the same type
1733: .seealso: PetscMemcpy(), PetscMemcmp(), PetscArrayzero(), PetscMemzero(), PetscArraycpy(), PetscMemmove(), PetscStrallocpy(),
1734: PetscArraymove()
1735: M*/
1736: #define PetscArraycmp(str1,str2,cnt,e) ((sizeof(*(str1)) != sizeof(*(str2))) || PetscMemcmp(str1,str2,(size_t)(cnt)*sizeof(*(str1)),e))
1738: /*MC
1739: PetscArraymove - Copies from one array in memory to another, the arrays may overlap. Use PetscArraycpy() when the arrays
1740: do not overlap
1742: Synopsis:
1743: #include <petscsys.h>
1744: PetscErrorCode PetscArraymove(anytype *str1,const anytype *str2,size_t cnt)
1746: Not Collective
1748: Input Parameters:
1749: + str1 - First array
1750: . str2 - Second array
1751: - cnt - Count of the array, not in bytes, but number of entries in the arrays
1753: Level: intermediate
1755: Note:
1756: This routine is a preferred replacement to PetscMemmove()
1757: The arrays must be of the same type
1759: .seealso: PetscMemcpy(), PetscMemcmp(), PetscArrayzero(), PetscMemzero(), PetscArraycpy(), PetscMemmove(), PetscArraycmp(), PetscStrallocpy()
1760: M*/
1761: #define PetscArraymove(str1,str2,cnt) ((sizeof(*(str1)) != sizeof(*(str2))) || PetscMemmove(str1,str2,(size_t)(cnt)*sizeof(*(str1))))
1763: /*MC
1764: PetscArraycpy - Copies from one array in memory to another
1766: Synopsis:
1767: #include <petscsys.h>
1768: PetscErrorCode PetscArraycpy(anytype *str1,const anytype *str2,size_t cnt)
1770: Not Collective
1772: Input Parameters:
1773: + str1 - First array (destination)
1774: . str2 - Second array (source)
1775: - cnt - Count of the array, not in bytes, but number of entries in the arrays
1777: Level: intermediate
1779: Note:
1780: This routine is a preferred replacement to PetscMemcpy()
1781: The arrays must be of the same type
1783: .seealso: PetscMemcpy(), PetscMemcmp(), PetscArrayzero(), PetscMemzero(), PetscArraymove(), PetscMemmove(), PetscArraycmp(), PetscStrallocpy()
1784: M*/
1785: #define PetscArraycpy(str1,str2,cnt) ((sizeof(*(str1)) != sizeof(*(str2))) || PetscMemcpy(str1,str2,(size_t)(cnt)*sizeof(*(str1))))
1787: /*MC
1788: PetscArrayzero - Zeros an array in memory.
1790: Synopsis:
1791: #include <petscsys.h>
1792: PetscErrorCode PetscArrayzero(anytype *str1,size_t cnt)
1794: Not Collective
1796: Input Parameters:
1797: + str1 - array
1798: - cnt - Count of the array, not in bytes, but number of entries in the array
1800: Level: intermediate
1802: Note:
1803: This routine is a preferred replacement to PetscMemzero()
1805: .seealso: PetscMemcpy(), PetscMemcmp(), PetscMemzero(), PetscArraycmp(), PetscArraycpy(), PetscMemmove(), PetscStrallocpy(), PetscArraymove()
1806: M*/
1807: #define PetscArrayzero(str1,cnt) PetscMemzero(str1,(size_t)(cnt)*sizeof(*(str1)))
1809: /*MC
1810: PetscPrefetchBlock - Prefetches a block of memory
1812: Synopsis:
1813: #include <petscsys.h>
1814: void PetscPrefetchBlock(const anytype *a,size_t n,int rw,int t)
1816: Not Collective
1818: Input Parameters:
1819: + a - pointer to first element to fetch (any type but usually PetscInt or PetscScalar)
1820: . n - number of elements to fetch
1821: . rw - 1 if the memory will be written to, otherwise 0 (ignored by many processors)
1822: - t - temporal locality (PETSC_PREFETCH_HINT_{NTA,T0,T1,T2}), see note
1824: Level: developer
1826: Notes:
1827: The last two arguments (rw and t) must be compile-time constants.
1829: Adopting Intel's x86/x86-64 conventions, there are four levels of temporal locality. Not all architectures offer
1830: equivalent locality hints, but the following macros are always defined to their closest analogue.
1831: + PETSC_PREFETCH_HINT_NTA - Non-temporal. Prefetches directly to L1, evicts to memory (skips higher level cache unless it was already there when prefetched).
1832: . 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.
1833: . PETSC_PREFETCH_HINT_T1 - Fetch to level 2 and higher (not L1).
1834: - PETSC_PREFETCH_HINT_T2 - Fetch to high-level cache only. (On many systems, T0 and T1 are equivalent.)
1836: This function does nothing on architectures that do not support prefetch and never errors (even if passed an invalid
1837: address).
1839: M*/
1840: #define PetscPrefetchBlock(a,n,rw,t) do { \
1841: const char *_p = (const char*)(a),*_end = (const char*)((a)+(n)); \
1842: for ( ; _p < _end; _p += PETSC_LEVEL1_DCACHE_LINESIZE) PETSC_Prefetch(_p,(rw),(t)); \
1843: } while (0)
1845: /*
1846: Determine if some of the kernel computation routines use
1847: Fortran (rather than C) for the numerical calculations. On some machines
1848: and compilers (like complex numbers) the Fortran version of the routines
1849: is faster than the C/C++ versions. The flag --with-fortran-kernels
1850: should be used with ./configure to turn these on.
1851: */
1852: #if defined(PETSC_USE_FORTRAN_KERNELS)
1854: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTCRL)
1855: #define PETSC_USE_FORTRAN_KERNEL_MULTCRL
1856: #endif
1858: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJPERM)
1859: #define PETSC_USE_FORTRAN_KERNEL_MULTAIJPERM
1860: #endif
1862: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJ)
1863: #define PETSC_USE_FORTRAN_KERNEL_MULTAIJ
1864: #endif
1866: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ)
1867: #define PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ
1868: #endif
1870: #if !defined(PETSC_USE_FORTRAN_KERNEL_NORM)
1871: #define PETSC_USE_FORTRAN_KERNEL_NORM
1872: #endif
1874: #if !defined(PETSC_USE_FORTRAN_KERNEL_MAXPY)
1875: #define PETSC_USE_FORTRAN_KERNEL_MAXPY
1876: #endif
1878: #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ)
1879: #define PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ
1880: #endif
1882: #if !defined(PETSC_USE_FORTRAN_KERNEL_RELAXAIJ)
1883: #define PETSC_USE_FORTRAN_KERNEL_RELAXAIJ
1884: #endif
1886: #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ)
1887: #define PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ
1888: #endif
1890: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ)
1891: #define PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ
1892: #endif
1894: #if !defined(PETSC_USE_FORTRAN_KERNEL_MDOT)
1895: #define PETSC_USE_FORTRAN_KERNEL_MDOT
1896: #endif
1898: #if !defined(PETSC_USE_FORTRAN_KERNEL_XTIMESY)
1899: #define PETSC_USE_FORTRAN_KERNEL_XTIMESY
1900: #endif
1902: #if !defined(PETSC_USE_FORTRAN_KERNEL_AYPX)
1903: #define PETSC_USE_FORTRAN_KERNEL_AYPX
1904: #endif
1906: #if !defined(PETSC_USE_FORTRAN_KERNEL_WAXPY)
1907: #define PETSC_USE_FORTRAN_KERNEL_WAXPY
1908: #endif
1910: #endif
1912: /*
1913: Macros for indicating code that should be compiled with a C interface,
1914: rather than a C++ interface. Any routines that are dynamically loaded
1915: (such as the PCCreate_XXX() routines) must be wrapped so that the name
1916: mangler does not change the functions symbol name. This just hides the
1917: ugly extern "C" {} wrappers.
1918: */
1919: #if defined(__cplusplus)
1920: # define EXTERN_C_BEGIN extern "C" {
1921: # define EXTERN_C_END }
1922: #else
1923: # define EXTERN_C_BEGIN
1924: # define EXTERN_C_END
1925: #endif
1927: /* --------------------------------------------------------------------*/
1929: /*MC
1930: MPI_Comm - the basic object used by MPI to determine which processes are involved in a
1931: communication
1933: Level: beginner
1935: Note: This manual page is a place-holder because MPICH does not have a manual page for MPI_Comm
1937: .seealso: PETSC_COMM_WORLD, PETSC_COMM_SELF
1938: M*/
1940: #if defined(PETSC_HAVE_MPIIO)
1941: PETSC_EXTERN PetscErrorCode MPIU_File_write_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*);
1942: PETSC_EXTERN PetscErrorCode MPIU_File_read_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*);
1943: PETSC_EXTERN PetscErrorCode MPIU_File_write_at(MPI_File,MPI_Offset,void*,PetscMPIInt,MPI_Datatype,MPI_Status*);
1944: PETSC_EXTERN PetscErrorCode MPIU_File_read_at(MPI_File,MPI_Offset,void*,PetscMPIInt,MPI_Datatype,MPI_Status*);
1945: PETSC_EXTERN PetscErrorCode MPIU_File_write_at_all(MPI_File,MPI_Offset,void*,PetscMPIInt,MPI_Datatype,MPI_Status*);
1946: PETSC_EXTERN PetscErrorCode MPIU_File_read_at_all(MPI_File,MPI_Offset,void*,PetscMPIInt,MPI_Datatype,MPI_Status*);
1947: #endif
1949: /* the following petsc_static_inline require petscerror.h */
1951: /* Limit MPI to 32-bits */
1952: #define PETSC_MPI_INT_MAX 2147483647
1953: #define PETSC_MPI_INT_MIN -2147483647
1954: /* Limit BLAS to 32-bits */
1955: #define PETSC_BLAS_INT_MAX 2147483647
1956: #define PETSC_BLAS_INT_MIN -2147483647
1958: /*@C
1959: PetscIntCast - casts a PetscInt64 (which is 64 bits in size) to a PetscInt (which may be 32 bits in size), generates an
1960: error if the PetscInt is not large enough to hold the number.
1962: Not Collective
1964: Input Parameter:
1965: . a - the PetscInt64 value
1967: Output Parameter:
1968: . b - the resulting PetscInt value
1970: Level: advanced
1972: Notes: If integers needed for the applications are too large to fit in 32 bit ints you can ./configure using --with-64-bit-indices to make PetscInt use 64 bit ints
1974: Not available from Fortran
1976: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscMPIIntCast(), PetscBLASIntCast()
1977: @*/
1978: PETSC_STATIC_INLINE PetscErrorCode PetscIntCast(PetscInt64 a,PetscInt *b)
1979: {
1981: #if !defined(PETSC_USE_64BIT_INDICES)
1982: if ((a) > PETSC_MAX_INT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Integer too long for PetscInt, you may need to ./configure using --with-64-bit-indices");
1983: #endif
1984: *b = (PetscInt)(a);
1985: return(0);
1986: }
1988: /*@C
1989: PetscBLASIntCast - casts a PetscInt (which may be 64 bits in size) to a PetscBLASInt (which may be 32 bits in size), generates an
1990: error if the PetscBLASInt is not large enough to hold the number.
1992: Not Collective
1994: Input Parameter:
1995: . a - the PetscInt value
1997: Output Parameter:
1998: . b - the resulting PetscBLASInt value
2000: Level: advanced
2002: Not available from Fortran
2004: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscMPIIntCast(), PetscIntCast()
2005: @*/
2006: PETSC_STATIC_INLINE PetscErrorCode PetscBLASIntCast(PetscInt a,PetscBLASInt *b)
2007: {
2009: #if defined(PETSC_USE_64BIT_INDICES) && !defined(PETSC_HAVE_64BIT_BLAS_INDICES)
2010: *b = 0;
2011: if ((a) > PETSC_BLAS_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array too long for BLAS/LAPACK");
2012: #endif
2013: *b = (PetscBLASInt)(a);
2014: return(0);
2015: }
2017: /*@C
2018: PetscMPIIntCast - casts a PetscInt (which may be 64 bits in size) to a PetscMPIInt (which may be 32 bits in size), generates an
2019: error if the PetscMPIInt is not large enough to hold the number.
2021: Not Collective
2023: Input Parameter:
2024: . a - the PetscInt value
2026: Output Parameter:
2027: . b - the resulting PetscMPIInt value
2029: Level: advanced
2031: Not available from Fortran
2033: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscIntCast()
2034: @*/
2035: PETSC_STATIC_INLINE PetscErrorCode PetscMPIIntCast(PetscInt a,PetscMPIInt *b)
2036: {
2038: #if defined(PETSC_USE_64BIT_INDICES)
2039: *b = 0;
2040: if ((a) > PETSC_MPI_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array too long for MPI");
2041: #endif
2042: *b = (PetscMPIInt)(a);
2043: return(0);
2044: }
2046: #define PetscInt64Mult(a,b) ((PetscInt64)(a))*((PetscInt64)(b))
2048: /*@C
2050: PetscRealIntMultTruncate - Computes the product of a positive PetscReal and a positive PetscInt and truncates the value to slightly less than the maximal possible value
2052: Not Collective
2054: Input Parameter:
2055: + a - the PetscReal value
2056: - b - the second value
2058: Returns:
2059: the result as a PetscInt value
2061: Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64
2062: Use PetscIntMultTruncate() to compute the product of two positive PetscInt and truncate to fit a PetscInt
2063: 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
2065: Developers Note:
2066: We currently assume that PetscInt addition can never overflow, this is obviously wrong but requires many more checks.
2068: This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able.
2070: Not available from Fortran
2072: Level: advanced
2074: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult()
2075: @*/
2076: PETSC_STATIC_INLINE PetscInt PetscRealIntMultTruncate(PetscReal a,PetscInt b)
2077: {
2078: PetscInt64 r;
2080: r = (PetscInt64) (a*(PetscReal)b);
2081: if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100;
2082: return (PetscInt) r;
2083: }
2085: /*@C
2087: PetscIntMultTruncate - Computes the product of two positive PetscInt and truncates the value to slightly less than the maximal possible value
2089: Not Collective
2091: Input Parameter:
2092: + a - the PetscInt value
2093: - b - the second value
2095: Returns:
2096: the result as a PetscInt value
2098: Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64
2099: Use PetscRealIntMultTruncate() to compute the product of a PetscReal and a PetscInt and truncate to fit a PetscInt
2100: 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
2102: Not available from Fortran
2104: Developers Note: We currently assume that PetscInt addition can never overflow, this is obviously wrong but requires many more checks.
2106: This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able.
2108: Level: advanced
2110: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult()
2111: @*/
2112: PETSC_STATIC_INLINE PetscInt PetscIntMultTruncate(PetscInt a,PetscInt b)
2113: {
2114: PetscInt64 r;
2116: r = PetscInt64Mult(a,b);
2117: if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100;
2118: return (PetscInt) r;
2119: }
2121: /*@C
2123: PetscIntSumTruncate - Computes the sum of two positive PetscInt and truncates the value to slightly less than the maximal possible value
2125: Not Collective
2127: Input Parameter:
2128: + a - the PetscInt value
2129: - b - the second value
2131: Returns:
2132: the result as a PetscInt value
2134: Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64
2135: Use PetscRealIntMultTruncate() to compute the product of a PetscReal and a PetscInt and truncate to fit a PetscInt
2136: 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
2138: This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able.
2140: Not available from Fortran
2142: Level: advanced
2144: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult()
2145: @*/
2146: PETSC_STATIC_INLINE PetscInt PetscIntSumTruncate(PetscInt a,PetscInt b)
2147: {
2148: PetscInt64 r;
2150: r = ((PetscInt64)a) + ((PetscInt64)b);
2151: if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100;
2152: return (PetscInt) r;
2153: }
2155: /*@C
2157: PetscIntMultError - Computes the product of two positive PetscInt and generates an error with overflow.
2159: Not Collective
2161: Input Parameter:
2162: + a - the PetscInt value
2163: - b - the second value
2165: Output Parameter:ma
2166: . result - the result as a PetscInt value, or NULL if you do not want the result, you just want to check if it overflows
2168: Use PetscInt64Mult() to compute the product of two 32 bit PetscInt and store in a PetscInt64
2169: Use PetscIntMultTruncate() to compute the product of two PetscInt and truncate it to fit in a PetscInt
2171: Not available from Fortran
2173: Developers Note: We currently assume that PetscInt addition does not overflow, this is obviously wrong but requires many more checks.
2175: Level: advanced
2177: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscIntMult64(), PetscIntSumError()
2178: @*/
2179: PETSC_STATIC_INLINE PetscErrorCode PetscIntMultError(PetscInt a,PetscInt b,PetscInt *result)
2180: {
2181: PetscInt64 r;
2184: r = PetscInt64Mult(a,b);
2185: #if !defined(PETSC_USE_64BIT_INDICES)
2186: 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);
2187: #endif
2188: if (result) *result = (PetscInt) r;
2189: return(0);
2190: }
2192: /*@C
2194: PetscIntSumError - Computes the sum of two positive PetscInt and generates an error with overflow.
2196: Not Collective
2198: Input Parameter:
2199: + a - the PetscInt value
2200: - b - the second value
2202: Output Parameter:ma
2203: . c - the result as a PetscInt value, or NULL if you do not want the result, you just want to check if it overflows
2205: Use PetscInt64Mult() to compute the product of two 32 bit PetscInt and store in a PetscInt64
2206: Use PetscIntMultTruncate() to compute the product of two PetscInt and truncate it to fit in a PetscInt
2208: Not available from Fortran
2210: Level: advanced
2212: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult()
2213: @*/
2214: PETSC_STATIC_INLINE PetscErrorCode PetscIntSumError(PetscInt a,PetscInt b,PetscInt *result)
2215: {
2216: PetscInt64 r;
2219: r = ((PetscInt64)a) + ((PetscInt64)b);
2220: #if !defined(PETSC_USE_64BIT_INDICES)
2221: 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);
2222: #endif
2223: if (result) *result = (PetscInt) r;
2224: return(0);
2225: }
2227: /*
2228: The IBM include files define hz, here we hide it so that it may be used as a regular user variable.
2229: */
2230: #if defined(hz)
2231: # undef hz
2232: #endif
2234: #include <limits.h>
2236: /* The number of bits in a byte */
2238: #define PETSC_BITS_PER_BYTE CHAR_BIT
2240: /* For arrays that contain filenames or paths */
2242: #if defined(PETSC_HAVE_SYS_PARAM_H)
2243: # include <sys/param.h>
2244: #endif
2245: #if defined(PETSC_HAVE_SYS_TYPES_H)
2246: # include <sys/types.h>
2247: #endif
2248: #if defined(MAXPATHLEN)
2249: # define PETSC_MAX_PATH_LEN MAXPATHLEN
2250: #elif defined(MAX_PATH)
2251: # define PETSC_MAX_PATH_LEN MAX_PATH
2252: #elif defined(_MAX_PATH)
2253: # define PETSC_MAX_PATH_LEN _MAX_PATH
2254: #else
2255: # define PETSC_MAX_PATH_LEN 4096
2256: #endif
2258: /*MC
2260: PETSC_VERSION - This manual page provides information about how PETSc documents and uses its version information. This information is available to both C/C++
2261: and Fortran compilers when petscsys.h is included.
2264: The current PETSc version and the API for accessing it are defined in petscversion.h
2266: The complete version number is given as the triple PETSC_VERSION_MAJOR.PETSC_VERSION_MINOR.PETSC_VERSION_SUBMINOR (in short hand x.y.z)
2268: 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
2269: where only a change in the major version number (x) indicates a change in the API.
2271: 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
2273: 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),
2274: 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
2275: version number (x.y.z).
2277: PETSC_RELEASE_DATE is the date the x.y version was released (i.e. the version before any patch releases)
2279: PETSC_VERSION_DATE is the date the x.y.z version was released
2281: PETSC_VERSION_GIT is the last git commit to the repository given in the form vx.y.z-wwwww
2283: PETSC_VERSION_DATE_GIT is the date of the last git commit to the repository
2285: Level: intermediate
2287: PETSC_VERSION_() and PETSC_VERSION_PATCH are deprecated and will eventually be removed. For several releases PETSC_VERSION_PATCH is always 0
2289: M*/
2291: /*MC
2293: UsingFortran - To use PETSc with Fortran you must use both PETSc include files and modules. At the beginning
2294: of every function and module definition you need something like
2296: $
2297: $#include "petsc/finclude/petscXXX.h"
2298: $ use petscXXX
2300: You can declare PETSc variables using either of the following.
2302: $ XXX variablename
2303: $ type(tXXX) variablename
2305: For example,
2307: $#include "petsc/finclude/petscvec.h"
2308: $ use petscvec
2309: $
2310: $ Vec b
2311: $ type(tVec) x
2313: Level: beginner
2315: M*/
2317: PETSC_EXTERN PetscErrorCode PetscGetArchType(char[],size_t);
2318: PETSC_EXTERN PetscErrorCode PetscGetHostName(char[],size_t);
2319: PETSC_EXTERN PetscErrorCode PetscGetUserName(char[],size_t);
2320: PETSC_EXTERN PetscErrorCode PetscGetProgramName(char[],size_t);
2321: PETSC_EXTERN PetscErrorCode PetscSetProgramName(const char[]);
2322: PETSC_EXTERN PetscErrorCode PetscGetDate(char[],size_t);
2323: PETSC_EXTERN PetscErrorCode PetscGetVersion(char[], size_t);
2324: PETSC_EXTERN PetscErrorCode PetscGetVersionNumber(PetscInt*,PetscInt*,PetscInt*,PetscInt*);
2326: PETSC_EXTERN PetscErrorCode PetscSortedInt(PetscInt,const PetscInt[],PetscBool*);
2327: PETSC_EXTERN PetscErrorCode PetscSortedMPIInt(PetscInt,const PetscMPIInt[],PetscBool*);
2328: PETSC_EXTERN PetscErrorCode PetscSortedReal(PetscInt,const PetscReal[],PetscBool*);
2329: PETSC_EXTERN PetscErrorCode PetscSortInt(PetscInt,PetscInt[]);
2330: PETSC_EXTERN PetscErrorCode PetscSortReverseInt(PetscInt,PetscInt[]);
2331: PETSC_EXTERN PetscErrorCode PetscSortedRemoveDupsInt(PetscInt*,PetscInt[]);
2332: PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsInt(PetscInt*,PetscInt[]);
2334: PETSC_EXTERN PetscErrorCode PetscFindInt(PetscInt, PetscInt, const PetscInt[], PetscInt*);
2335: PETSC_EXTERN PetscErrorCode PetscFindMPIInt(PetscMPIInt, PetscInt, const PetscMPIInt[], PetscInt*);
2336: PETSC_EXTERN PetscErrorCode PetscSortIntWithPermutation(PetscInt,const PetscInt[],PetscInt[]);
2337: PETSC_EXTERN PetscErrorCode PetscSortStrWithPermutation(PetscInt,const char*[],PetscInt[]);
2338: PETSC_EXTERN PetscErrorCode PetscSortIntWithArray(PetscInt,PetscInt[],PetscInt[]);
2339: PETSC_EXTERN PetscErrorCode PetscSortIntWithArrayPair(PetscInt,PetscInt[],PetscInt[],PetscInt[]);
2340: PETSC_EXTERN PetscErrorCode PetscSortMPIInt(PetscInt,PetscMPIInt[]);
2341: PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsMPIInt(PetscInt*,PetscMPIInt[]);
2342: PETSC_EXTERN PetscErrorCode PetscSortMPIIntWithArray(PetscMPIInt,PetscMPIInt[],PetscMPIInt[]);
2343: PETSC_EXTERN PetscErrorCode PetscSortMPIIntWithIntArray(PetscMPIInt,PetscMPIInt[],PetscInt[]);
2344: PETSC_EXTERN PetscErrorCode PetscSortIntWithScalarArray(PetscInt,PetscInt[],PetscScalar[]);
2345: PETSC_EXTERN PetscErrorCode PetscSortIntWithDataArray(PetscInt,PetscInt[],void*,size_t,void*);
2346: PETSC_EXTERN PetscErrorCode PetscSortReal(PetscInt,PetscReal[]);
2347: PETSC_EXTERN PetscErrorCode PetscSortRealWithArrayInt(PetscInt,PetscReal[],PetscInt[]);
2348: PETSC_EXTERN PetscErrorCode PetscSortRealWithPermutation(PetscInt,const PetscReal[],PetscInt[]);
2349: PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsReal(PetscInt*,PetscReal[]);
2350: PETSC_EXTERN PetscErrorCode PetscFindReal(PetscReal,PetscInt,const PetscReal[],PetscReal,PetscInt*);
2351: PETSC_EXTERN PetscErrorCode PetscSortSplit(PetscInt,PetscInt,PetscScalar[],PetscInt[]);
2352: PETSC_EXTERN PetscErrorCode PetscSortSplitReal(PetscInt,PetscInt,PetscReal[],PetscInt[]);
2353: PETSC_EXTERN PetscErrorCode PetscProcessTree(PetscInt,const PetscBool [],const PetscInt[],PetscInt*,PetscInt**,PetscInt**,PetscInt**,PetscInt**);
2354: PETSC_EXTERN PetscErrorCode PetscMergeIntArrayPair(PetscInt,const PetscInt[],const PetscInt[],PetscInt,const PetscInt[],const PetscInt[],PetscInt*,PetscInt**,PetscInt**);
2355: PETSC_EXTERN PetscErrorCode PetscMergeIntArray(PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscInt*,PetscInt**);
2356: PETSC_EXTERN PetscErrorCode PetscMergeMPIIntArray(PetscInt,const PetscMPIInt[],PetscInt,const PetscMPIInt[],PetscInt*,PetscMPIInt**);
2358: PETSC_EXTERN PetscErrorCode PetscParallelSortedInt(MPI_Comm, PetscInt, const PetscInt[], PetscBool *);
2360: PETSC_EXTERN PetscErrorCode PetscSetDisplay(void);
2361: PETSC_EXTERN PetscErrorCode PetscGetDisplay(char[],size_t);
2363: /*J
2364: PetscRandomType - String with the name of a PETSc randomizer
2366: Level: beginner
2368: Notes:
2369: To use SPRNG or RANDOM123 you must have ./configure PETSc
2370: with the option --download-sprng or --download-random123
2372: .seealso: PetscRandomSetType(), PetscRandom, PetscRandomCreate()
2373: J*/
2374: typedef const char* PetscRandomType;
2375: #define PETSCRAND "rand"
2376: #define PETSCRAND48 "rand48"
2377: #define PETSCSPRNG "sprng"
2378: #define PETSCRANDER48 "rander48"
2379: #define PETSCRANDOM123 "random123"
2381: /* Logging support */
2382: PETSC_EXTERN PetscClassId PETSC_RANDOM_CLASSID;
2384: PETSC_EXTERN PetscErrorCode PetscRandomInitializePackage(void);
2386: /* Dynamic creation and loading functions */
2387: PETSC_EXTERN PetscFunctionList PetscRandomList;
2389: PETSC_EXTERN PetscErrorCode PetscRandomRegister(const char[],PetscErrorCode (*)(PetscRandom));
2390: PETSC_EXTERN PetscErrorCode PetscRandomSetType(PetscRandom, PetscRandomType);
2391: PETSC_EXTERN PetscErrorCode PetscRandomSetFromOptions(PetscRandom);
2392: PETSC_EXTERN PetscErrorCode PetscRandomGetType(PetscRandom, PetscRandomType*);
2393: PETSC_EXTERN PetscErrorCode PetscRandomViewFromOptions(PetscRandom,PetscObject,const char[]);
2394: PETSC_EXTERN PetscErrorCode PetscRandomView(PetscRandom,PetscViewer);
2396: PETSC_EXTERN PetscErrorCode PetscRandomCreate(MPI_Comm,PetscRandom*);
2397: PETSC_EXTERN PetscErrorCode PetscRandomGetValue(PetscRandom,PetscScalar*);
2398: PETSC_EXTERN PetscErrorCode PetscRandomGetValueReal(PetscRandom,PetscReal*);
2399: PETSC_EXTERN PetscErrorCode PetscRandomGetInterval(PetscRandom,PetscScalar*,PetscScalar*);
2400: PETSC_EXTERN PetscErrorCode PetscRandomSetInterval(PetscRandom,PetscScalar,PetscScalar);
2401: PETSC_EXTERN PetscErrorCode PetscRandomSetSeed(PetscRandom,unsigned long);
2402: PETSC_EXTERN PetscErrorCode PetscRandomGetSeed(PetscRandom,unsigned long *);
2403: PETSC_EXTERN PetscErrorCode PetscRandomSeed(PetscRandom);
2404: PETSC_EXTERN PetscErrorCode PetscRandomDestroy(PetscRandom*);
2406: PETSC_EXTERN PetscErrorCode PetscGetFullPath(const char[],char[],size_t);
2407: PETSC_EXTERN PetscErrorCode PetscGetRelativePath(const char[],char[],size_t);
2408: PETSC_EXTERN PetscErrorCode PetscGetWorkingDirectory(char[],size_t);
2409: PETSC_EXTERN PetscErrorCode PetscGetRealPath(const char[],char[]);
2410: PETSC_EXTERN PetscErrorCode PetscGetHomeDirectory(char[],size_t);
2411: PETSC_EXTERN PetscErrorCode PetscTestFile(const char[],char,PetscBool *);
2412: PETSC_EXTERN PetscErrorCode PetscTestDirectory(const char[],char,PetscBool *);
2413: PETSC_EXTERN PetscErrorCode PetscMkdir(const char[]);
2414: PETSC_EXTERN PetscErrorCode PetscMkdtemp(char[]);
2415: PETSC_EXTERN PetscErrorCode PetscRMTree(const char[]);
2417: PETSC_STATIC_INLINE PetscBool PetscBinaryBigEndian(void) {long _petsc_v = 1; return ((char*)&_petsc_v)[0] ? PETSC_FALSE : PETSC_TRUE;}
2419: PETSC_EXTERN PetscErrorCode PetscBinaryRead(int,void*,PetscInt,PetscInt*,PetscDataType);
2420: PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedRead(MPI_Comm,int,void*,PetscInt,PetscInt*,PetscDataType);
2421: PETSC_EXTERN PetscErrorCode PetscBinaryWrite(int,const void*,PetscInt,PetscDataType);
2422: PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedWrite(MPI_Comm,int,const void*,PetscInt,PetscDataType);
2423: PETSC_EXTERN PetscErrorCode PetscBinaryOpen(const char[],PetscFileMode,int *);
2424: PETSC_EXTERN PetscErrorCode PetscBinaryClose(int);
2425: PETSC_EXTERN PetscErrorCode PetscSharedTmp(MPI_Comm,PetscBool *);
2426: PETSC_EXTERN PetscErrorCode PetscSharedWorkingDirectory(MPI_Comm,PetscBool *);
2427: PETSC_EXTERN PetscErrorCode PetscGetTmp(MPI_Comm,char[],size_t);
2428: PETSC_EXTERN PetscErrorCode PetscFileRetrieve(MPI_Comm,const char[],char[],size_t,PetscBool *);
2429: PETSC_EXTERN PetscErrorCode PetscLs(MPI_Comm,const char[],char[],size_t,PetscBool *);
2430: #if defined(PETSC_USE_SOCKET_VIEWER)
2431: PETSC_EXTERN PetscErrorCode PetscOpenSocket(const char[],int,int*);
2432: #endif
2434: PETSC_EXTERN PetscErrorCode PetscBinarySeek(int,off_t,PetscBinarySeekType,off_t*);
2435: PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedSeek(MPI_Comm,int,off_t,PetscBinarySeekType,off_t*);
2436: PETSC_EXTERN PetscErrorCode PetscByteSwap(void *,PetscDataType,PetscInt);
2438: PETSC_EXTERN PetscErrorCode PetscSetDebugTerminal(const char[]);
2439: PETSC_EXTERN PetscErrorCode PetscSetDebugger(const char[],PetscBool );
2440: PETSC_EXTERN PetscErrorCode PetscSetDefaultDebugger(void);
2441: PETSC_EXTERN PetscErrorCode PetscSetDebuggerFromString(const char*);
2442: PETSC_EXTERN PetscErrorCode PetscAttachDebugger(void);
2443: PETSC_EXTERN PetscErrorCode PetscStopForDebugger(void);
2445: PETSC_EXTERN PetscErrorCode PetscGatherNumberOfMessages(MPI_Comm,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt*);
2446: PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**);
2447: PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths2(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**,PetscMPIInt**);
2448: PETSC_EXTERN PetscErrorCode PetscPostIrecvInt(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscInt***,MPI_Request**);
2449: PETSC_EXTERN PetscErrorCode PetscPostIrecvScalar(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscScalar***,MPI_Request**);
2450: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSided(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt*,const void*,PetscMPIInt*,PetscMPIInt**,void*)
2451: PetscAttrMPIPointerWithType(6,3);
2452: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedF(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt[],const void*,PetscMPIInt*,PetscMPIInt**,void*,PetscMPIInt,
2453: PetscErrorCode (*send)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,PetscMPIInt,void*,MPI_Request[],void*),
2454: PetscErrorCode (*recv)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,void*,MPI_Request[],void*),void *ctx)
2455: PetscAttrMPIPointerWithType(6,3);
2456: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedFReq(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt[],const void*,PetscMPIInt*,PetscMPIInt**,void*,PetscMPIInt,
2457: MPI_Request**,MPI_Request**,
2458: PetscErrorCode (*send)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,PetscMPIInt,void*,MPI_Request[],void*),
2459: PetscErrorCode (*recv)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,void*,MPI_Request[],void*),void *ctx)
2460: PetscAttrMPIPointerWithType(6,3);
2462: PETSC_EXTERN const char *const PetscBuildTwoSidedTypes[];
2463: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedSetType(MPI_Comm,PetscBuildTwoSidedType);
2464: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedGetType(MPI_Comm,PetscBuildTwoSidedType*);
2466: PETSC_EXTERN PetscErrorCode PetscSSEIsEnabled(MPI_Comm,PetscBool*,PetscBool*);
2468: PETSC_EXTERN MPI_Comm PetscObjectComm(PetscObject);
2470: PETSC_EXTERN const char *const PetscSubcommTypes[];
2472: struct _n_PetscSubcomm {
2473: MPI_Comm parent; /* parent communicator */
2474: MPI_Comm dupparent; /* duplicate parent communicator, under which the processors of this subcomm have contiguous rank */
2475: MPI_Comm child; /* the sub-communicator */
2476: PetscMPIInt n; /* num of subcommunicators under the parent communicator */
2477: PetscMPIInt color; /* color of processors belong to this communicator */
2478: PetscMPIInt *subsize; /* size of subcommunicator[color] */
2479: PetscSubcommType type;
2480: char *subcommprefix;
2481: };
2483: PETSC_STATIC_INLINE MPI_Comm PetscSubcommParent(PetscSubcomm scomm) {return scomm->parent;}
2484: PETSC_STATIC_INLINE MPI_Comm PetscSubcommChild(PetscSubcomm scomm) {return scomm->child;}
2485: PETSC_STATIC_INLINE MPI_Comm PetscSubcommContiguousParent(PetscSubcomm scomm) {return scomm->dupparent;}
2486: PETSC_EXTERN PetscErrorCode PetscSubcommCreate(MPI_Comm,PetscSubcomm*);
2487: PETSC_EXTERN PetscErrorCode PetscSubcommDestroy(PetscSubcomm*);
2488: PETSC_EXTERN PetscErrorCode PetscSubcommSetNumber(PetscSubcomm,PetscInt);
2489: PETSC_EXTERN PetscErrorCode PetscSubcommSetType(PetscSubcomm,PetscSubcommType);
2490: PETSC_EXTERN PetscErrorCode PetscSubcommSetTypeGeneral(PetscSubcomm,PetscMPIInt,PetscMPIInt);
2491: PETSC_EXTERN PetscErrorCode PetscSubcommView(PetscSubcomm,PetscViewer);
2492: PETSC_EXTERN PetscErrorCode PetscSubcommSetFromOptions(PetscSubcomm);
2493: PETSC_EXTERN PetscErrorCode PetscSubcommSetOptionsPrefix(PetscSubcomm,const char[]);
2494: PETSC_EXTERN PetscErrorCode PetscSubcommGetParent(PetscSubcomm,MPI_Comm*);
2495: PETSC_EXTERN PetscErrorCode PetscSubcommGetContiguousParent(PetscSubcomm,MPI_Comm*);
2496: PETSC_EXTERN PetscErrorCode PetscSubcommGetChild(PetscSubcomm,MPI_Comm*);
2498: PETSC_EXTERN PetscErrorCode PetscHeapCreate(PetscInt,PetscHeap*);
2499: PETSC_EXTERN PetscErrorCode PetscHeapAdd(PetscHeap,PetscInt,PetscInt);
2500: PETSC_EXTERN PetscErrorCode PetscHeapPop(PetscHeap,PetscInt*,PetscInt*);
2501: PETSC_EXTERN PetscErrorCode PetscHeapPeek(PetscHeap,PetscInt*,PetscInt*);
2502: PETSC_EXTERN PetscErrorCode PetscHeapStash(PetscHeap,PetscInt,PetscInt);
2503: PETSC_EXTERN PetscErrorCode PetscHeapUnstash(PetscHeap);
2504: PETSC_EXTERN PetscErrorCode PetscHeapDestroy(PetscHeap*);
2505: PETSC_EXTERN PetscErrorCode PetscHeapView(PetscHeap,PetscViewer);
2507: PETSC_EXTERN PetscErrorCode PetscProcessPlacementView(PetscViewer);
2508: PETSC_EXTERN PetscErrorCode PetscShmCommGet(MPI_Comm,PetscShmComm*);
2509: PETSC_EXTERN PetscErrorCode PetscShmCommGlobalToLocal(PetscShmComm,PetscMPIInt,PetscMPIInt*);
2510: PETSC_EXTERN PetscErrorCode PetscShmCommLocalToGlobal(PetscShmComm,PetscMPIInt,PetscMPIInt*);
2511: PETSC_EXTERN PetscErrorCode PetscShmCommGetMpiShmComm(PetscShmComm,MPI_Comm*);
2513: /* routines to better support OpenMP multithreading needs of some PETSc third party libraries */
2514: PETSC_EXTERN PetscErrorCode PetscOmpCtrlCreate(MPI_Comm,PetscInt,PetscOmpCtrl*);
2515: PETSC_EXTERN PetscErrorCode PetscOmpCtrlGetOmpComms(PetscOmpCtrl,MPI_Comm*,MPI_Comm*,PetscBool*);
2516: PETSC_EXTERN PetscErrorCode PetscOmpCtrlDestroy(PetscOmpCtrl*);
2517: PETSC_EXTERN PetscErrorCode PetscOmpCtrlBarrier(PetscOmpCtrl);
2518: PETSC_EXTERN PetscErrorCode PetscOmpCtrlOmpRegionOnMasterBegin(PetscOmpCtrl);
2519: PETSC_EXTERN PetscErrorCode PetscOmpCtrlOmpRegionOnMasterEnd(PetscOmpCtrl);
2521: PETSC_EXTERN PetscErrorCode PetscSegBufferCreate(size_t,size_t,PetscSegBuffer*);
2522: PETSC_EXTERN PetscErrorCode PetscSegBufferDestroy(PetscSegBuffer*);
2523: PETSC_EXTERN PetscErrorCode PetscSegBufferGet(PetscSegBuffer,size_t,void*);
2524: PETSC_EXTERN PetscErrorCode PetscSegBufferExtractAlloc(PetscSegBuffer,void*);
2525: PETSC_EXTERN PetscErrorCode PetscSegBufferExtractTo(PetscSegBuffer,void*);
2526: PETSC_EXTERN PetscErrorCode PetscSegBufferExtractInPlace(PetscSegBuffer,void*);
2527: PETSC_EXTERN PetscErrorCode PetscSegBufferGetSize(PetscSegBuffer,size_t*);
2528: PETSC_EXTERN PetscErrorCode PetscSegBufferUnuse(PetscSegBuffer,size_t);
2532: * prevents the compiler from completely erasing the stub. This is called in inner loops so it has to be as fast as
2533: * possible. */
2534: PETSC_STATIC_INLINE PetscErrorCode PetscSegBufferGetInts(PetscSegBuffer seg,size_t count,PetscInt *PETSC_RESTRICT *slot) {return PetscSegBufferGet(seg,count,(void**)slot);}
2536: extern PetscOptionsHelpPrinted PetscOptionsHelpPrintedSingleton;
2537: PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedDestroy(PetscOptionsHelpPrinted*);
2538: PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedCreate(PetscOptionsHelpPrinted*);
2539: PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedCheck(PetscOptionsHelpPrinted,const char*,const char*,PetscBool*);
2541: #include <stdarg.h>
2542: PETSC_EXTERN PetscErrorCode PetscVSNPrintf(char*,size_t,const char[],size_t*,va_list);
2543: PETSC_EXTERN PetscErrorCode (*PetscVFPrintf)(FILE*,const char[],va_list);
2545: PETSC_EXTERN PetscSegBuffer PetscCitationsList;
2547: /*@C
2548: PetscCitationsRegister - Register a bibtex item to obtain credit for an implemented algorithm used in the code.
2550: Not Collective - only what is registered on rank 0 of PETSC_COMM_WORLD will be printed
2552: Input Parameters:
2553: + cite - the bibtex item, formated to displayed on multiple lines nicely
2554: - set - a boolean variable initially set to PETSC_FALSE; this is used to insure only a single registration of the citation
2556: Level: intermediate
2558: Not available from Fortran
2560: Options Database:
2561: . -citations [filename] - print out the bibtex entries for the given computation
2562: @*/
2563: PETSC_STATIC_INLINE PetscErrorCode PetscCitationsRegister(const char cit[],PetscBool *set)
2564: {
2565: size_t len;
2566: char *vstring;
2570: if (set && *set) return(0);
2571: PetscStrlen(cit,&len);
2572: PetscSegBufferGet(PetscCitationsList,len,&vstring);
2573: PetscArraycpy(vstring,cit,len);
2574: if (set) *set = PETSC_TRUE;
2575: return(0);
2576: }
2578: PETSC_EXTERN PetscErrorCode PetscURLShorten(const char[],char[],size_t);
2579: PETSC_EXTERN PetscErrorCode PetscGoogleDriveAuthorize(MPI_Comm,char[],char[],size_t);
2580: PETSC_EXTERN PetscErrorCode PetscGoogleDriveRefresh(MPI_Comm,const char[],char[],size_t);
2581: PETSC_EXTERN PetscErrorCode PetscGoogleDriveUpload(MPI_Comm,const char[],const char []);
2583: PETSC_EXTERN PetscErrorCode PetscBoxAuthorize(MPI_Comm,char[],char[],size_t);
2584: PETSC_EXTERN PetscErrorCode PetscBoxRefresh(MPI_Comm,const char[],char[],char[],size_t);
2586: PETSC_EXTERN PetscErrorCode PetscGlobusGetTransfers(MPI_Comm,const char[],char[],size_t);
2588: PETSC_EXTERN PetscErrorCode PetscTextBelt(MPI_Comm,const char[],const char[],PetscBool*);
2589: PETSC_EXTERN PetscErrorCode PetscTellMyCell(MPI_Comm,const char[],const char[],PetscBool*);
2591: PETSC_EXTERN PetscErrorCode PetscPullJSONValue(const char[],const char[],char[],size_t,PetscBool*);
2592: PETSC_EXTERN PetscErrorCode PetscPushJSONValue(char[],const char[],const char[],size_t);
2595: #if defined(PETSC_USE_DEBUG)
2596: /*
2597: Verify that all processes in the communicator have called this from the same line of code
2598: */
2599: PETSC_EXTERN PetscErrorCode PetscAllreduceBarrierCheck(MPI_Comm,PetscMPIInt,int,const char*,const char *);
2601: /*MC
2602: MPIU_Allreduce - a PETSc replacement for MPI_Allreduce() that tries to determine if the call from all the MPI processes occur from the
2603: same place in the PETSc code. This helps to detect bugs where different MPI processes follow different code paths
2604: resulting in inconsistent and incorrect calls to MPI_Allreduce().
2606: Collective
2608: Synopsis:
2609: #include <petscsys.h>
2610: PetscErrorCode MPIU_Allreduce(void *indata,void *outdata,PetscMPIInt count,MPI_Datatype datatype, MPI_Op op, MPI_Comm comm);
2612: Input Parameters:
2613: + indata - pointer to the input data to be reduced
2614: . count - the number of MPI data items in indata and outdata
2615: . datatype - the MPI datatype, for example MPI_INT
2616: . op - the MPI operation, for example MPI_SUM
2617: - comm - the MPI communicator on which the operation occurs
2619: Output Parameter:
2620: . outdata - the reduced values
2622: Notes:
2623: In optimized mode this directly calls MPI_Allreduce()
2625: Level: developer
2627: .seealso: MPI_Allreduce()
2628: M*/
2629: #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))
2630: #else
2631: #define MPIU_Allreduce(a,b,c,d,e,fcomm) MPI_Allreduce(a,b,c,d,e,fcomm)
2632: #endif
2634: #if defined(PETSC_HAVE_MPI_PROCESS_SHARED_MEMORY)
2635: PETSC_EXTERN PetscErrorCode MPIU_Win_allocate_shared(MPI_Aint,PetscMPIInt,MPI_Info,MPI_Comm,void*,MPI_Win*);
2636: PETSC_EXTERN PetscErrorCode MPIU_Win_shared_query(MPI_Win,PetscMPIInt,MPI_Aint*,PetscMPIInt*,void*);
2637: #endif
2639: /*
2640: Returned from PETSc functions that are called from MPI, such as related to attributes
2641: */
2642: PETSC_EXTERN PetscMPIInt PETSC_MPI_ERROR_CLASS;
2643: PETSC_EXTERN PetscMPIInt PETSC_MPI_ERROR_CODE;
2645: #endif