Actual source code: petscsystypes.h
petsc-3.12.0 2019-09-29
1: #if !defined(PETSCSYSTYPES_H)
2: #define PETSCSYSTYPES_H
4: #include <petscconf.h>
5: #include <petscfix.h>
7: /*MC
8: PetscErrorCode - datatype used for return error code from almost all PETSc functions
10: Level: beginner
12: .seealso: CHKERRQ, SETERRQ
13: M*/
14: typedef int PetscErrorCode;
16: /*MC
18: PetscClassId - A unique id used to identify each PETSc class.
20: Notes:
21: Use PetscClassIdRegister() to obtain a new value for a new class being created. Usually
22: XXXInitializePackage() calls it for each class it defines.
24: Developer Notes:
25: Internal integer stored in the _p_PetscObject data structure.
26: These are all computed by an offset from the lowest one, PETSC_SMALLEST_CLASSID.
28: Level: developer
30: .seealso: PetscClassIdRegister(), PetscLogEventRegister(), PetscHeaderCreate()
31: M*/
32: typedef int PetscClassId;
34: /*MC
35: PetscMPIInt - datatype used to represent 'int' parameters to MPI functions.
37: Level: intermediate
39: Notes:
40: usually this is the same as PetscInt, but if PETSc was built with --with-64-bit-indices but
41: standard C/Fortran integers are 32 bit then this is NOT the same as PetscInt; it remains 32 bit.
43: PetscMPIIntCast(a,&b) checks if the given PetscInt a will fit in a PetscMPIInt, if not it
44: generates a PETSC_ERR_ARG_OUTOFRANGE error.
46: .seealso: PetscBLASInt, PetscInt, PetscMPIIntCast()
48: M*/
49: typedef int PetscMPIInt;
51: /*MC
52: PetscEnum - datatype used to pass enum types within PETSc functions.
54: Level: intermediate
56: .seealso: PetscOptionsGetEnum(), PetscOptionsEnum(), PetscBagRegisterEnum()
57: M*/
58: typedef enum { ENUM_DUMMY } PetscEnum;
60: typedef short PetscShort;
61: typedef char PetscChar;
62: typedef float PetscFloat;
64: /*MC
65: PetscInt - PETSc type that represents an integer, used primarily to
66: represent size of arrays and indexing into arrays. Its size can be configured with the option --with-64-bit-indices to be either 32-bit (default) or 64-bit.
68: Notes:
69: For MPI calls that require datatypes, use MPIU_INT as the datatype for PetscInt. It will automatically work correctly regardless of the size of PetscInt.
71: Level: beginner
73: .seealso: PetscBLASInt, PetscMPIInt, PetscReal, PetscScalar, PetscComplex, PetscInt, MPIU_REAL, MPIU_SCALAR, MPIU_COMPLEX, MPIU_INT
74: M*/
76: #if defined(PETSC_HAVE_STDINT_H)
77: # include <stdint.h>
78: #endif
79: #if defined (PETSC_HAVE_INTTYPES_H)
80: # if !defined(__STDC_FORMAT_MACROS)
81: # define __STDC_FORMAT_MACROS /* required for using PRId64 from c++ */
82: # endif
83: # include <inttypes.h>
84: # if !defined(PRId64)
85: # define PRId64 "ld"
86: # endif
87: #endif
89: #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 */
90: typedef int64_t PetscInt64;
91: #elif (PETSC_SIZEOF_LONG_LONG == 8)
92: typedef long long PetscInt64;
93: #elif defined(PETSC_HAVE___INT64)
94: typedef __int64 PetscInt64;
95: #else
96: # error "cannot determine PetscInt64 type"
97: #endif
99: #if defined(PETSC_USE_64BIT_INDICES)
100: typedef PetscInt64 PetscInt;
101: #else
102: typedef int PetscInt;
103: #endif
105: /*MC
106: PetscBLASInt - datatype used to represent 'int' parameters to BLAS/LAPACK functions.
108: Notes:
109: Usually this is the same as PetscInt, but if PETSc was built with --with-64-bit-indices but
110: standard C/Fortran integers are 32 bit then this is NOT the same as PetscInt it remains 32 bit
111: (except on very rare BLAS/LAPACK implementations that support 64 bit integers see the notes below).
113: PetscErrorCode PetscBLASIntCast(a,&b) checks if the given PetscInt a will fit in a PetscBLASInt, if not it
114: generates a PETSC_ERR_ARG_OUTOFRANGE error
116: Installation Notes:
117: ./configure automatically determines the size of the integers used by BLAS/LAPACK except when --with-batch is used
118: in that situation one must know (by some other means) if the integers used by BLAS/LAPACK are 64 bit and if so pass the flag --known-64-bit-blas-indice
120: MATLAB ships with BLAS and LAPACK that use 64 bit integers, for example if you run ./configure with, the option
121: --with-blaslapack-lib=[/Applications/MATLAB_R2010b.app/bin/maci64/libmwblas.dylib,/Applications/MATLAB_R2010b.app/bin/maci64/libmwlapack.dylib]
123: MKL ships with both 32 and 64 bit integer versions of the BLAS and LAPACK. If you pass the flag -with-64-bit-blas-indices PETSc will link
124: against the 64 bit version, otherwise it use the 32 bit version
126: OpenBLAS can be built to use 64 bit integers. The ./configure options --download-openblas -with-64-bit-blas-indices will build a 64 bit integer version
128: External packages such as hypre, ML, SuperLU etc do not provide any support for passing 64 bit integers to BLAS/LAPACK so cannot
129: be used with PETSc when PETSc links against 64 bit integer BLAS/LAPACK. ./configure will generate an error if you attempt to link PETSc against any of
130: these external libraries while using 64 bit integer BLAS/LAPACK.
132: Level: intermediate
134: .seealso: PetscMPIInt, PetscInt, PetscBLASIntCast()
136: M*/
137: #if defined(PETSC_HAVE_64BIT_BLAS_INDICES)
138: typedef PetscInt64 PetscBLASInt;
139: #else
140: typedef int PetscBLASInt;
141: #endif
143: /*E
144: PetscBool - Logical variable. Actually an int in C and a logical in Fortran.
146: Level: beginner
148: Developer Note:
149: Why have PetscBool , why not use bool in C? The problem is that K and R C, C99 and C++ all have different mechanisms for
150: boolean values. It is not easy to have a simple macro that that will work properly in all circumstances with all three mechanisms.
152: .seealso: PETSC_TRUE, PETSC_FALSE, PetscNot()
153: E*/
154: typedef enum { PETSC_FALSE,PETSC_TRUE } PetscBool;
156: /*MC
157: PetscReal - PETSc type that represents a real number version of PetscScalar
160: Notes:
161: For MPI calls that require datatypes, use MPIU_REAL as the datatype for PetscScalar and MPIU_SUM, MPIU_MAX, etc. for operations.
162: They will automatically work correctly regardless of the size of PetscReal.
164: See PetscScalar for details on how to ./configure the size of PetscReal.
166: Level: beginner
168: .seealso: PetscScalar, PetscComplex, PetscInt, MPIU_REAL, MPIU_SCALAR, MPIU_COMPLEX, MPIU_INT
169: M*/
171: #if defined(PETSC_USE_REAL_SINGLE)
172: typedef float PetscReal;
173: #elif defined(PETSC_USE_REAL_DOUBLE)
174: typedef double PetscReal;
175: #elif defined(PETSC_USE_REAL___FLOAT128)
176: # if defined(__cplusplus)
177: extern "C" {
178: # endif
179: # include <quadmath.h>
180: # if defined(__cplusplus)
181: }
182: # endif
183: typedef __float128 PetscReal;
184: #elif defined(PETSC_USE_REAL___FP16)
185: typedef __fp16 PetscReal;
186: #endif /* PETSC_USE_REAL_* */
188: /*MC
189: PetscComplex - PETSc type that represents a complex number with precision matching that of PetscReal.
191: Synopsis:
192: #include <petscsys.h>
193: PetscComplex number = 1. + 2.*PETSC_i;
195: Notes:
196: For MPI calls that require datatypes, use MPIU_COMPLEX as the datatype for PetscComplex and MPIU_SUM etc for operations.
197: They will automatically work correctly regardless of the size of PetscComplex.
199: See PetscScalar for details on how to ./configure the size of PetscReal
201: Complex numbers are automatically available if PETSc was able to find a working complex implementation
203: Level: beginner
205: .seealso: PetscReal, PetscScalar, PetscComplex, PetscInt, MPIU_REAL, MPIU_SCALAR, MPIU_COMPLEX, MPIU_INT, PETSC_i
206: M*/
208: #if defined(__cplusplus) && defined(PETSC_HAVE_CXX_COMPLEX) && !defined(PETSC_USE_REAL___FLOAT128)
209: # if !defined(PETSC_SKIP_COMPLEX)
210: /* C++ support of complex number */
211: # define PETSC_HAVE_COMPLEX 1
212: # if defined(PETSC_HAVE_CUDA) && __CUDACC_VER_MAJOR__ > 6
213: /* complex headers in thrust only available in CUDA 7.0 and above */
214: # define petsccomplexlib thrust
215: # include <thrust/complex.h>
216: # else
217: # define petsccomplexlib std
218: # include <complex>
219: # endif
220: # if defined(PETSC_USE_REAL_SINGLE)
221: typedef petsccomplexlib::complex<float> PetscComplex;
222: # elif defined(PETSC_USE_REAL_DOUBLE)
223: typedef petsccomplexlib::complex<double> PetscComplex;
224: # elif defined(PETSC_USE_REAL___FLOAT128)
225: typedef petsccomplexlib::complex<__float128> PetscComplex; /* Notstandard and not expected to work, use __complex128 */
226: # endif /* PETSC_USE_REAL_ */
227: # endif /* ! PETSC_SKIP_COMPLEX */
228: # if !defined(PETSC_SKIP_CXX_COMPLEX_FIX)
229: # include <petsccxxcomplexfix.h>
230: # endif /* ! PETSC_SKIP_CXX_COMPLEX_FIX */
231: #elif defined(PETSC_HAVE_C99_COMPLEX) && !defined(PETSC_USE_REAL___FP16)
232: # if !defined(PETSC_SKIP_COMPLEX)
233: # define PETSC_HAVE_COMPLEX 1
234: # include <complex.h>
235: # if defined(PETSC_USE_REAL_SINGLE) || defined(PETSC_USE_REAL___FP16)
236: typedef float _Complex PetscComplex;
237: # elif defined(PETSC_USE_REAL_DOUBLE)
238: typedef double _Complex PetscComplex;
239: # elif defined(PETSC_USE_REAL___FLOAT128)
240: typedef __complex128 PetscComplex;
241: # endif /* PETSC_USE_REAL_* */
242: # endif /* !PETSC_SKIP_COMPLEX */
243: #elif (defined(PETSC_USE_COMPLEX) && !defined(PETSC_SKIP_COMPLEX))
244: # error "PETSc was configured --with-scalar-type=complex, but a language-appropriate complex library is not available"
245: #endif /* !PETSC_SKIP_COMPLEX */
247: /*MC
248: PetscScalar - PETSc type that represents either a double precision real number, a double precision
249: complex number, a single precision real number, a __float128 real or complex or a __fp16 real - if the code is configured
250: with --with-scalar-type=real,complex --with-precision=single,double,__float128,__fp16
252: Notes:
253: For MPI calls that require datatypes, use MPIU_SCALAR as the datatype for PetscScalar and MPIU_SUM, MPIU_MAX etc for operations. They will automatically work correctly regardless of the size of PetscScalar.
255: Level: beginner
257: .seealso: PetscReal, PetscComplex, PetscInt, MPIU_REAL, MPIU_SCALAR, MPIU_COMPLEX, MPIU_INT, PetscRealPart(), PetscImaginaryPart()
258: M*/
260: #if (defined(PETSC_USE_COMPLEX) && !defined(PETSC_SKIP_COMPLEX))
261: typedef PetscComplex PetscScalar;
262: #else /* PETSC_USE_COMPLEX */
263: typedef PetscReal PetscScalar;
264: #endif /* PETSC_USE_COMPLEX */
266: /*E
267: PetscCopyMode - Determines how an array passed to certain functions is copied or retained
269: Level: beginner
271: $ PETSC_COPY_VALUES - the array values are copied into new space, the user is free to reuse or delete the passed in array
272: $ PETSC_OWN_POINTER - the array values are NOT copied, the object takes ownership of the array and will free it later, the user cannot change or
273: $ delete the array. The array MUST have been obtained with PetscMalloc(). Hence this mode cannot be used in Fortran.
274: $ PETSC_USE_POINTER - the array values are NOT copied, the object uses the array but does NOT take ownership of the array. The user cannot use
275: the array but the user must delete the array after the object is destroyed.
277: E*/
278: typedef enum {PETSC_COPY_VALUES, PETSC_OWN_POINTER, PETSC_USE_POINTER} PetscCopyMode;
280: /*MC
281: PETSC_FALSE - False value of PetscBool
283: Level: beginner
285: Note:
286: Zero integer
288: .seealso: PetscBool, PETSC_TRUE
289: M*/
291: /*MC
292: PETSC_TRUE - True value of PetscBool
294: Level: beginner
296: Note:
297: Nonzero integer
299: .seealso: PetscBool, PETSC_FALSE
300: M*/
302: /*MC
303: PetscLogDouble - Used for logging times
305: Notes:
306: Contains double precision numbers that are not used in the numerical computations, but rather in logging, timing etc.
308: Level: developer
310: M*/
311: typedef double PetscLogDouble;
313: /*E
314: PetscDataType - Used for handling different basic data types.
316: Level: beginner
318: Notes:
319: Use of this should be avoided if one can directly use MPI_Datatype instead.
321: Developer comment:
322: It would be nice if we could always just use MPI Datatypes, why can we not?
324: If you change any values in PetscDatatype make sure you update their usage in
325: share/petsc/matlab/PetscBagRead.m
327: .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscDataTypeToMPIDataType(),
328: PetscDataTypeGetSize()
330: E*/
331: typedef enum {PETSC_DATATYPE_UNKNOWN = 0,
332: PETSC_DOUBLE = 1, PETSC_COMPLEX = 2, PETSC_LONG = 3, PETSC_SHORT = 4, PETSC_FLOAT = 5,
333: PETSC_CHAR = 6, PETSC_BIT_LOGICAL = 7, PETSC_ENUM = 8, PETSC_BOOL = 9, PETSC___FLOAT128 = 10,
334: PETSC_OBJECT = 11, PETSC_FUNCTION = 12, PETSC_STRING = 13, PETSC___FP16 = 14, PETSC_STRUCT = 15,
335: PETSC_INT = 16, PETSC_INT64 = 17} PetscDataType;
337: #if defined(PETSC_USE_REAL_SINGLE)
338: # define PETSC_REAL PETSC_FLOAT
339: #elif defined(PETSC_USE_REAL_DOUBLE)
340: # define PETSC_REAL PETSC_DOUBLE
341: #elif defined(PETSC_USE_REAL___FLOAT128)
342: # define PETSC_REAL PETSC___FLOAT128
343: #elif defined(PETSC_USE_REAL___FP16)
344: # define PETSC_REAL PETSC___FP16
345: #else
346: # define PETSC_REAL PETSC_DOUBLE
347: #endif
349: #if defined(PETSC_USE_COMPLEX)
350: # define PETSC_SCALAR PETSC_COMPLEX
351: #else
352: # define PETSC_SCALAR PETSC_REAL
353: #endif
355: #define PETSC_FORTRANADDR PETSC_LONG
357: /*S
358: PetscToken - 'Token' used for managing tokenizing strings
360: Level: intermediate
362: .seealso: PetscTokenCreate(), PetscTokenFind(), PetscTokenDestroy()
363: S*/
364: typedef struct _p_PetscToken* PetscToken;
366: /*S
367: PetscObject - any PETSc object, PetscViewer, Mat, Vec, KSP etc
369: Level: beginner
371: Note:
372: This is the base class from which all PETSc objects are derived from.
374: .seealso: PetscObjectDestroy(), PetscObjectView(), PetscObjectGetName(), PetscObjectSetName(), PetscObjectReference(), PetscObjectDereference()
375: S*/
376: typedef struct _p_PetscObject* PetscObject;
378: /*MC
379: PetscObjectId - unique integer Id for a PetscObject
381: Level: developer
383: Notes:
384: Unlike pointer values, object ids are never reused.
386: .seealso: PetscObjectState, PetscObjectGetId()
387: M*/
388: #if defined(PETSC_USING_F90) && !defined(PETSC_USE_FORTRANKIND) /* compaq F90 */
389: typedef int PetscObjectId;
390: #else
391: typedef PetscInt64 PetscObjectId;
392: #endif
394: /*MC
395: PetscObjectState - integer state for a PetscObject
397: Level: developer
399: Notes:
400: Object state is always-increasing and (for objects that track state) can be used to determine if an object has
401: changed since the last time you interacted with it. It is 64-bit so that it will not overflow for a very long time.
403: .seealso: PetscObjectId, PetscObjectStateGet(), PetscObjectStateIncrease(), PetscObjectStateSet()
404: M*/
405: #if defined(PETSC_USING_F90) && !defined(PETSC_USE_FORTRANKIND) /* compaq F90 */
406: typedef int PetscObjectState;
407: #else
408: typedef PetscInt64 PetscObjectState;
409: #endif
411: /*S
412: PetscFunctionList - Linked list of functions, possibly stored in dynamic libraries, accessed
413: by string name
415: Level: advanced
417: .seealso: PetscFunctionListAdd(), PetscFunctionListDestroy(), PetscOpFlist
418: S*/
419: typedef struct _n_PetscFunctionList *PetscFunctionList;
421: /*E
422: PetscFileMode - Access mode for a file.
424: Level: beginner
426: $ FILE_MODE_READ - open a file at its beginning for reading
427: $ FILE_MODE_WRITE - open a file at its beginning for writing (will create if the file does not exist)
428: $ FILE_MODE_APPEND - open a file at end for writing
429: $ FILE_MODE_UPDATE - open a file for updating, meaning for reading and writing
430: $ FILE_MODE_APPEND_UPDATE - open a file for updating, meaning for reading and writing, at the end
432: .seealso: PetscViewerFileSetMode()
433: E*/
434: typedef enum {FILE_MODE_READ, FILE_MODE_WRITE, FILE_MODE_APPEND, FILE_MODE_UPDATE, FILE_MODE_APPEND_UPDATE} PetscFileMode;
436: typedef void* PetscDLHandle;
437: typedef enum {PETSC_DL_DECIDE=0,PETSC_DL_NOW=1,PETSC_DL_LOCAL=2} PetscDLMode;
439: /*S
440: PetscObjectList - Linked list of PETSc objects, each accessable by string name
442: Level: developer
444: Notes:
445: Used by PetscObjectCompose() and PetscObjectQuery()
447: .seealso: PetscObjectListAdd(), PetscObjectListDestroy(), PetscObjectListFind(), PetscObjectCompose(), PetscObjectQuery(), PetscFunctionList
448: S*/
449: typedef struct _n_PetscObjectList *PetscObjectList;
451: /*S
452: PetscDLLibrary - Linked list of dynamics libraries to search for functions
454: Level: advanced
456: .seealso: PetscDLLibraryOpen()
457: S*/
458: typedef struct _n_PetscDLLibrary *PetscDLLibrary;
460: /*S
461: PetscContainer - Simple PETSc object that contains a pointer to any required data
463: Level: advanced
465: .seealso: PetscObject, PetscContainerCreate()
466: S*/
467: typedef struct _p_PetscContainer* PetscContainer;
469: /*S
470: PetscRandom - Abstract PETSc object that manages generating random numbers
472: Level: intermediate
474: .seealso: PetscRandomCreate(), PetscRandomGetValue(), PetscRandomType
475: S*/
476: typedef struct _p_PetscRandom* PetscRandom;
478: /*
479: In binary files variables are stored using the following lengths,
480: regardless of how they are stored in memory on any one particular
481: machine. Use these rather then sizeof() in computing sizes for
482: PetscBinarySeek().
483: */
484: #define PETSC_BINARY_INT_SIZE (32/8)
485: #define PETSC_BINARY_FLOAT_SIZE (32/8)
486: #define PETSC_BINARY_CHAR_SIZE (8/8)
487: #define PETSC_BINARY_SHORT_SIZE (16/8)
488: #define PETSC_BINARY_DOUBLE_SIZE (64/8)
489: #define PETSC_BINARY_SCALAR_SIZE sizeof(PetscScalar)
491: /*E
492: PetscBinarySeekType - argument to PetscBinarySeek()
494: Level: advanced
496: .seealso: PetscBinarySeek(), PetscBinarySynchronizedSeek()
497: E*/
498: typedef enum {PETSC_BINARY_SEEK_SET = 0,PETSC_BINARY_SEEK_CUR = 1,PETSC_BINARY_SEEK_END = 2} PetscBinarySeekType;
500: /*E
501: PetscBuildTwoSidedType - algorithm for setting up two-sided communication
503: $ PETSC_BUILDTWOSIDED_ALLREDUCE - classical algorithm using an MPI_Allreduce with
504: $ a buffer of length equal to the communicator size. Not memory-scalable due to
505: $ the large reduction size. Requires only MPI-1.
506: $ PETSC_BUILDTWOSIDED_IBARRIER - nonblocking algorithm based on MPI_Issend and MPI_Ibarrier.
507: $ Proved communication-optimal in Hoefler, Siebert, and Lumsdaine (2010). Requires MPI-3.
508: $ PETSC_BUILDTWOSIDED_REDSCATTER - similar to above, but use more optimized function
509: $ that only communicates the part of the reduction that is necessary. Requires MPI-2.
511: Level: developer
513: .seealso: PetscCommBuildTwoSided(), PetscCommBuildTwoSidedSetType(), PetscCommBuildTwoSidedGetType()
514: E*/
515: typedef enum {
516: PETSC_BUILDTWOSIDED_NOTSET = -1,
517: PETSC_BUILDTWOSIDED_ALLREDUCE = 0,
518: PETSC_BUILDTWOSIDED_IBARRIER = 1,
519: PETSC_BUILDTWOSIDED_REDSCATTER = 2
520: /* Updates here must be accompanied by updates in finclude/petscsys.h and the string array in mpits.c */
521: } PetscBuildTwoSidedType;
523: /*E
524: InsertMode - Whether entries are inserted or added into vectors or matrices
526: Level: beginner
528: .seealso: VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(),
529: VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(),
530: MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd()
531: E*/
532: typedef enum {NOT_SET_VALUES, INSERT_VALUES, ADD_VALUES, MAX_VALUES, MIN_VALUES, INSERT_ALL_VALUES, ADD_ALL_VALUES, INSERT_BC_VALUES, ADD_BC_VALUES} InsertMode;
534: /*MC
535: INSERT_VALUES - Put a value into a vector or matrix, overwrites any previous value
537: Level: beginner
539: .seealso: InsertMode, VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(),
540: VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), ADD_VALUES,
541: MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd(), MAX_VALUES
543: M*/
545: /*MC
546: ADD_VALUES - Adds a value into a vector or matrix, if there previously was no value, just puts the
547: value into that location
549: Level: beginner
551: .seealso: InsertMode, VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(),
552: VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), INSERT_VALUES,
553: MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd(), MAX_VALUES
555: M*/
557: /*MC
558: MAX_VALUES - Puts the maximum of the scattered/gathered value and the current value into each location
560: Level: beginner
562: .seealso: InsertMode, VecScatterBegin(), VecScatterEnd(), ADD_VALUES, INSERT_VALUES
564: M*/
566: /*MC
567: MIN_VALUES - Puts the minimal of the scattered/gathered value and the current value into each location
569: Level: beginner
571: .seealso: InsertMode, VecScatterBegin(), VecScatterEnd(), ADD_VALUES, INSERT_VALUES
573: M*/
576: /*S
577: PetscSubcomm - A decomposition of an MPI communicator into subcommunicators
579: Notes:
580: After a call to PetscSubcommSetType(), PetscSubcommSetTypeGeneral(), or PetscSubcommSetFromOptions() one may call
581: $ PetscSubcommChild() returns the associated subcommunicator on this process
582: $ PetscSubcommContiguousParent() returns a parent communitor but with all child of the same subcommunicator having contiguous rank
584: Sample Usage:
585: PetscSubcommCreate()
586: PetscSubcommSetNumber()
587: PetscSubcommSetType(PETSC_SUBCOMM_INTERLACED);
588: ccomm = PetscSubcommChild()
589: PetscSubcommDestroy()
591: Level: advanced
593: Notes:
594: $ PETSC_SUBCOMM_GENERAL - similar to MPI_Comm_split() each process sets the new communicator (color) they will belong to and the order within that communicator
595: $ PETSC_SUBCOMM_CONTIGUOUS - each new communicator contains a set of process with contiguous ranks in the original MPI communicator
596: $ PETSC_SUBCOMM_INTERLACED - each new communictor contains a set of processes equally far apart in rank from the others in that new communicator
598: Example: Consider a communicator with six processes split into 3 subcommunicators.
599: $ PETSC_SUBCOMM_CONTIGUOUS - the first communicator contains rank 0,1 the second rank 2,3 and the third rank 4,5 in the original ordering of the original communicator
600: $ PETSC_SUBCOMM_INTERLACED - the first communicator contains rank 0,3, the second 1,4 and the third 2,5
602: Developer Notes:
603: This is used in objects such as PCREDUNDANT to manage the subcommunicators on which the redundant computations
604: are performed.
607: .seealso: PetscSubcommCreate(), PetscSubcommSetNumber(), PetscSubcommSetType(), PetscSubcommView(), PetscSubcommSetFromOptions()
609: S*/
610: typedef struct _n_PetscSubcomm* PetscSubcomm;
611: typedef enum {PETSC_SUBCOMM_GENERAL=0,PETSC_SUBCOMM_CONTIGUOUS=1,PETSC_SUBCOMM_INTERLACED=2} PetscSubcommType;
613: /*S
614: PetscHeap - A simple class for managing heaps
616: Level: intermediate
618: .seealso: PetscHeapCreate(), PetscHeapAdd(), PetscHeapPop(), PetscHeapPeek(), PetscHeapStash(), PetscHeapUnstash(), PetscHeapView(), PetscHeapDestroy()
619: S*/
620: typedef struct _PetscHeap *PetscHeap;
622: typedef struct _n_PetscShmComm* PetscShmComm;
623: typedef struct _n_PetscOmpCtrl* PetscOmpCtrl;
625: /*S
626: PetscSegBuffer - a segmented extendable buffer
628: Level: developer
630: .seealso: PetscSegBufferCreate(), PetscSegBufferGet(), PetscSegBufferExtract(), PetscSegBufferDestroy()
631: S*/
632: typedef struct _n_PetscSegBuffer *PetscSegBuffer;
634: typedef struct _n_PetscOptionsHelpPrinted *PetscOptionsHelpPrinted;
636: #endif