Actual source code: petscis.h
1: /*
2: An index set is a generalization of a subset of integers. Index sets
3: are used for defining scatters and gathers.
4: */
5: #pragma once
7: #include "petscsystypes.h"
8: #include <petscsys.h>
9: #include <petscsftypes.h>
10: #include <petscsectiontypes.h>
11: #include <petscistypes.h>
13: /* SUBMANSEC = IS */
15: #define IS_FILE_CLASSID 1211218
16: PETSC_EXTERN PetscClassId IS_CLASSID;
18: PETSC_EXTERN PetscErrorCode ISInitializePackage(void);
19: PETSC_EXTERN PetscErrorCode ISFinalizePackage(void);
21: /*J
22: ISType - String with the name of a PETSc index set type
24: Values:
25: + `ISGENERAL` - the values are stored with an array of indices and generally have no structure
26: . `ISSTRIDE` - the values have a simple structure of an initial offset and then a step size between values
27: - `ISBLOCK` - values are an array of indices, each representing a block (of the same common length) of values
29: Level: beginner
31: .seealso: `ISSetType()`, `IS`, `ISCreateGeneral()`, `ISCreateStride()`, `ISCreateBlock()`, `ISCreate()`, `ISRegister()`,
32: `VecScatterCreate()`, `MatGetSubMatrices()`
33: J*/
34: typedef const char *ISType;
35: #define ISGENERAL "general"
36: #define ISSTRIDE "stride"
37: #define ISBLOCK "block"
39: /* Dynamic creation and loading functions */
40: PETSC_EXTERN PetscFunctionList ISList;
41: PETSC_EXTERN PetscErrorCode ISSetType(IS, ISType);
42: PETSC_EXTERN PetscErrorCode ISGetType(IS, ISType *);
43: PETSC_EXTERN PetscErrorCode ISRegister(const char[], PetscErrorCode (*)(IS));
44: PETSC_EXTERN PetscErrorCode ISRegisterAll(void);
45: PETSC_EXTERN PetscErrorCode ISCreate(MPI_Comm, IS *);
47: PETSC_EXTERN PetscErrorCode ISDestroy(IS *);
48: PETSC_EXTERN PetscErrorCode ISSetPermutation(IS);
49: PETSC_EXTERN PetscErrorCode ISPermutation(IS, PetscBool *);
50: PETSC_EXTERN PetscErrorCode ISSetIdentity(IS);
51: PETSC_EXTERN PetscErrorCode ISIdentity(IS, PetscBool *);
52: PETSC_EXTERN PetscErrorCode ISContiguousLocal(IS, PetscInt, PetscInt, PetscInt *, PetscBool *);
54: /*E
55: ISInfo - Info that may either be computed or set as known for an index set
57: Level: intermediate
59: Developer Note:
60: Entries that are negative need not be called collectively by all processes.
62: .seealso: `IS`, `ISType`, `ISSetInfo()`
63: E*/
64: typedef enum {
65: IS_INFO_MIN = -1,
66: IS_SORTED = 0,
67: IS_UNIQUE = 1,
68: IS_PERMUTATION = 2,
69: IS_INTERVAL = 3,
70: IS_IDENTITY = 4,
71: IS_INFO_MAX = 5
72: } ISInfo;
74: typedef enum {
75: IS_LOCAL,
76: IS_GLOBAL
77: } ISInfoType;
79: PETSC_EXTERN PetscErrorCode ISSetInfo(IS, ISInfo, ISInfoType, PetscBool, PetscBool);
80: PETSC_EXTERN PetscErrorCode ISGetInfo(IS, ISInfo, ISInfoType, PetscBool, PetscBool *);
81: PETSC_EXTERN PetscErrorCode ISClearInfoCache(IS, PetscBool);
82: PETSC_EXTERN PetscErrorCode ISGetIndices(IS, const PetscInt *[]);
83: PETSC_EXTERN PetscErrorCode ISRestoreIndices(IS, const PetscInt *[]);
84: PETSC_EXTERN PetscErrorCode ISGetTotalIndices(IS, const PetscInt *[]);
85: PETSC_EXTERN PetscErrorCode ISRestoreTotalIndices(IS, const PetscInt *[]);
86: PETSC_EXTERN PetscErrorCode ISGetNonlocalIndices(IS, const PetscInt *[]);
87: PETSC_EXTERN PetscErrorCode ISRestoreNonlocalIndices(IS, const PetscInt *[]);
88: PETSC_EXTERN PetscErrorCode ISGetNonlocalIS(IS, IS *);
89: PETSC_EXTERN PetscErrorCode ISRestoreNonlocalIS(IS, IS *);
90: PETSC_EXTERN PetscErrorCode ISGetSize(IS, PetscInt *);
91: PETSC_EXTERN PetscErrorCode ISGetLocalSize(IS, PetscInt *);
92: PETSC_EXTERN PetscErrorCode ISInvertPermutation(IS, PetscInt, IS *);
93: PETSC_EXTERN PetscErrorCode ISView(IS, PetscViewer);
94: PETSC_EXTERN PetscErrorCode ISViewFromOptions(IS, PetscObject, const char[]);
95: PETSC_EXTERN PetscErrorCode ISLoad(IS, PetscViewer);
96: PETSC_EXTERN PetscErrorCode ISEqual(IS, IS, PetscBool *);
97: PETSC_EXTERN PetscErrorCode ISEqualUnsorted(IS, IS, PetscBool *);
98: PETSC_EXTERN PetscErrorCode ISSort(IS);
99: PETSC_EXTERN PetscErrorCode ISSortRemoveDups(IS);
100: PETSC_EXTERN PetscErrorCode ISSorted(IS, PetscBool *);
101: PETSC_EXTERN PetscErrorCode ISDifference(IS, IS, IS *);
102: PETSC_EXTERN PetscErrorCode ISSum(IS, IS, IS *);
103: PETSC_EXTERN PetscErrorCode ISExpand(IS, IS, IS *);
104: PETSC_EXTERN PetscErrorCode ISIntersect(IS, IS, IS *);
105: PETSC_EXTERN PetscErrorCode ISGetMinMax(IS, PetscInt *, PetscInt *);
107: PETSC_EXTERN PetscErrorCode ISLocate(IS, PetscInt, PetscInt *);
108: PETSC_EXTERN PetscErrorCode ISGetPointRange(IS, PetscInt *, PetscInt *, const PetscInt **);
109: PETSC_EXTERN PetscErrorCode ISRestorePointRange(IS, PetscInt *, PetscInt *, const PetscInt **);
110: PETSC_EXTERN PetscErrorCode ISGetPointSubrange(IS, PetscInt, PetscInt, const PetscInt *);
112: PETSC_EXTERN PetscErrorCode ISGetBlockSize(IS, PetscInt *);
113: PETSC_EXTERN PetscErrorCode ISSetBlockSize(IS, PetscInt);
114: PETSC_EXTERN PetscErrorCode ISGetCompressOutput(IS, PetscBool *);
115: PETSC_EXTERN PetscErrorCode ISSetCompressOutput(IS, PetscBool);
117: PETSC_EXTERN PetscErrorCode ISToGeneral(IS);
119: PETSC_EXTERN PetscErrorCode ISDuplicate(IS, IS *);
120: PETSC_EXTERN PetscErrorCode ISCopy(IS, IS);
121: PETSC_EXTERN PetscErrorCode ISShift(IS, PetscInt, IS);
122: PETSC_EXTERN PetscErrorCode ISAllGather(IS, IS *);
123: PETSC_EXTERN PetscErrorCode ISComplement(IS, PetscInt, PetscInt, IS *);
124: PETSC_EXTERN PetscErrorCode ISConcatenate(MPI_Comm, PetscInt, const IS[], IS *);
125: PETSC_EXTERN PetscErrorCode ISListToPair(MPI_Comm, PetscInt, IS[], IS *, IS *);
126: PETSC_EXTERN PetscErrorCode ISPairToList(IS, IS, PetscInt *, IS *[]);
127: PETSC_EXTERN PetscErrorCode ISEmbed(IS, IS, PetscBool, IS *);
128: PETSC_EXTERN PetscErrorCode ISSortPermutation(IS, PetscBool, IS *);
129: PETSC_EXTERN PetscErrorCode ISOnComm(IS, MPI_Comm, PetscCopyMode, IS *);
130: PETSC_EXTERN PetscErrorCode ISRenumber(IS, IS, PetscInt *, IS *);
131: PETSC_EXTERN PetscErrorCode ISCreateSubIS(IS, IS, IS *);
133: /* ISGENERAL specific */
134: PETSC_EXTERN PetscErrorCode ISCreateGeneral(MPI_Comm, PetscInt, const PetscInt[], PetscCopyMode, IS *);
135: PETSC_EXTERN PetscErrorCode ISGeneralSetIndices(IS, PetscInt, const PetscInt[], PetscCopyMode);
136: PETSC_EXTERN PetscErrorCode ISGeneralSetIndicesFromMask(IS, PetscInt, PetscInt, const PetscBool[]);
137: PETSC_EXTERN PetscErrorCode ISGeneralFilter(IS, PetscInt, PetscInt);
139: /* ISBLOCK specific */
140: PETSC_EXTERN PetscErrorCode ISCreateBlock(MPI_Comm, PetscInt, PetscInt, const PetscInt[], PetscCopyMode, IS *);
141: PETSC_EXTERN PetscErrorCode ISBlockSetIndices(IS, PetscInt, PetscInt, const PetscInt[], PetscCopyMode);
142: PETSC_EXTERN PetscErrorCode ISBlockGetIndices(IS, const PetscInt *[]);
143: PETSC_EXTERN PetscErrorCode ISBlockRestoreIndices(IS, const PetscInt *[]);
144: PETSC_EXTERN PetscErrorCode ISBlockGetLocalSize(IS, PetscInt *);
145: PETSC_EXTERN PetscErrorCode ISBlockGetSize(IS, PetscInt *);
147: /* ISSTRIDE specific */
148: PETSC_EXTERN PetscErrorCode ISCreateStride(MPI_Comm, PetscInt, PetscInt, PetscInt, IS *);
149: PETSC_EXTERN PetscErrorCode ISStrideSetStride(IS, PetscInt, PetscInt, PetscInt);
150: PETSC_EXTERN PetscErrorCode ISStrideGetInfo(IS, PetscInt *, PetscInt *);
152: #define IS_LTOGM_FILE_CLASSID 1211217
153: PETSC_EXTERN PetscClassId IS_LTOGM_CLASSID;
155: /*E
156: ISGlobalToLocalMappingMode - Indicates mapping behavior if global indices are missing
158: Values:
159: + `IS_GTOLM_MASK` - missing global indices are masked by mapping them to a local index of -1
160: - `IS_GTOLM_DROP` - missing global indices are dropped
162: Level: beginner
164: .seealso: `ISGlobalToLocalMappingApplyBlock()`, `ISGlobalToLocalMappingApply()`
165: E*/
166: typedef enum {
167: IS_GTOLM_MASK,
168: IS_GTOLM_DROP
169: } ISGlobalToLocalMappingMode;
171: /*J
172: ISLocalToGlobalMappingType - String with the name of a mapping method
174: Values:
175: + `ISLOCALTOGLOBALMAPPINGBASIC` - a non-memory scalable way of storing `ISLocalToGlobalMapping` that allows applying `ISGlobalToLocalMappingApply()` efficiently
176: - `ISLOCALTOGLOBALMAPPINGHASH` - a memory scalable way of storing `ISLocalToGlobalMapping` that allows applying `ISGlobalToLocalMappingApply()` reasonably efficiently
178: Level: beginner
180: .seealso: `ISLocalToGlobalMapping`, `ISLocalToGlobalMappingSetType()`, `ISLocalToGlobalSetFromOptions()`, `ISGlobalToLocalMappingMode`
181: J*/
182: typedef const char *ISLocalToGlobalMappingType;
183: #define ISLOCALTOGLOBALMAPPINGBASIC "basic"
184: #define ISLOCALTOGLOBALMAPPINGHASH "hash"
186: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingSetType(ISLocalToGlobalMapping, ISLocalToGlobalMappingType);
187: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetType(ISLocalToGlobalMapping, ISLocalToGlobalMappingType *);
188: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRegister(const char[], PetscErrorCode (*)(ISLocalToGlobalMapping));
189: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRegisterAll(void);
190: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingCreate(MPI_Comm, PetscInt, PetscInt, const PetscInt[], PetscCopyMode, ISLocalToGlobalMapping *);
191: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingCreateIS(IS, ISLocalToGlobalMapping *);
192: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingCreateSF(PetscSF, PetscInt, ISLocalToGlobalMapping *);
193: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingSetFromOptions(ISLocalToGlobalMapping);
194: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingSetUp(ISLocalToGlobalMapping);
195: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingView(ISLocalToGlobalMapping, PetscViewer);
196: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingLoad(ISLocalToGlobalMapping, PetscViewer);
197: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingViewFromOptions(ISLocalToGlobalMapping, PetscObject, const char[]);
198: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingConcatenate(MPI_Comm, PetscInt, const ISLocalToGlobalMapping[], ISLocalToGlobalMapping *);
199: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingDuplicate(ISLocalToGlobalMapping, ISLocalToGlobalMapping *);
200: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingDestroy(ISLocalToGlobalMapping *);
201: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetSize(ISLocalToGlobalMapping, PetscInt *);
202: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetIndices(ISLocalToGlobalMapping, const PetscInt **);
203: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreIndices(ISLocalToGlobalMapping, const PetscInt **);
204: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetBlockIndices(ISLocalToGlobalMapping, const PetscInt **);
205: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreBlockIndices(ISLocalToGlobalMapping, const PetscInt **);
206: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetBlockSize(ISLocalToGlobalMapping, PetscInt *);
207: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingSetBlockSize(ISLocalToGlobalMapping, PetscInt);
209: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingApply(ISLocalToGlobalMapping, PetscInt, const PetscInt[], PetscInt[]);
210: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingApplyBlock(ISLocalToGlobalMapping, PetscInt, const PetscInt[], PetscInt[]);
211: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingApplyIS(ISLocalToGlobalMapping, IS, IS *);
212: PETSC_EXTERN PetscErrorCode ISGlobalToLocalMappingApply(ISLocalToGlobalMapping, ISGlobalToLocalMappingMode, PetscInt, const PetscInt[], PetscInt *, PetscInt[]);
213: PETSC_EXTERN PetscErrorCode ISGlobalToLocalMappingApplyBlock(ISLocalToGlobalMapping, ISGlobalToLocalMappingMode, PetscInt, const PetscInt[], PetscInt *, PetscInt[]);
214: PETSC_EXTERN PetscErrorCode ISGlobalToLocalMappingApplyIS(ISLocalToGlobalMapping, ISGlobalToLocalMappingMode, IS, IS *);
216: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetNodeInfo(ISLocalToGlobalMapping, PetscInt *, PetscInt *[], PetscInt **[]);
217: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreNodeInfo(ISLocalToGlobalMapping, PetscInt *, PetscInt *[], PetscInt **[]);
218: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetInfo(ISLocalToGlobalMapping, PetscInt *, PetscInt *[], PetscInt *[], PetscInt **[]);
219: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreInfo(ISLocalToGlobalMapping, PetscInt *, PetscInt *[], PetscInt *[], PetscInt **[]);
220: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetBlockNodeInfo(ISLocalToGlobalMapping, PetscInt *, PetscInt *[], PetscInt **[]);
221: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreBlockNodeInfo(ISLocalToGlobalMapping, PetscInt *, PetscInt *[], PetscInt **[]);
222: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetBlockInfo(ISLocalToGlobalMapping, PetscInt *, PetscInt *[], PetscInt *[], PetscInt **[]);
223: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreBlockInfo(ISLocalToGlobalMapping, PetscInt *, PetscInt *[], PetscInt *[], PetscInt **[]);
224: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetBlockMultiLeavesSF(ISLocalToGlobalMapping, PetscSF *);
226: /*E
227: ISColoringType - determines if the coloring is for the entire parallel grid/graph/matrix
228: or for just the local ghosted portion
230: Values:
231: + `IS_COLORING_GLOBAL` - does not include the colors for ghost points, this is used when the function
232: is called synchronously in parallel. This requires generating a "parallel coloring".
233: - `IS_COLORING_LOCAL` - includes colors for ghost points, this is used when the function can be called
234: separately on individual processes with the ghost points already filled in. Does not
235: require a "parallel coloring", rather each process colors its local + ghost part.
236: Using this can result in much less parallel communication. Currently only works
237: with `DMDA` and if you call `MatFDColoringSetFunction()` with the local function.
239: Level: beginner
241: .seealso: `ISColoring`, `ISColoringSetType()`, `ISColoringGetType()`, `DMCreateColoring()`
242: E*/
243: typedef enum {
244: IS_COLORING_GLOBAL,
245: IS_COLORING_LOCAL
246: } ISColoringType;
248: PETSC_EXTERN const char *const ISColoringTypes[];
249: typedef unsigned PETSC_IS_COLORING_VALUE_TYPE ISColoringValue;
250: #define IS_COLORING_MAX PETSC_IS_COLORING_MAX
251: #define MPIU_COLORING_VALUE PETSC_MPIU_IS_COLORING_VALUE_TYPE
252: PETSC_EXTERN PetscErrorCode ISAllGatherColors(MPI_Comm, PetscInt, ISColoringValue *, PetscInt *, ISColoringValue *[]);
254: /*@C
255: ISColoringValueCast - casts an integer a `ISColoringValue` (which may be 1-bits in size), generates an
256: error if the value is too large
258: Not Collective; No Fortran Support
260: Input Parameter:
261: . a - the `PetscCount` value
263: Output Parameter:
264: . b - the resulting `ISColoringValue` value
266: Level: advanced
268: Note:
269: Errors if the integer is negative
271: .seealso: `ISColoringValue`, `ISColoringCreate()`, `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscMPIIntCast()`, `PetscIntCast()`
272: @*/
273: static inline PetscErrorCode ISColoringValueCast(PetscCount a, ISColoringValue *b)
274: {
275: PetscFunctionBegin;
276: *b = 0;
277: PetscCheck(a >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Passing negative integer not supported");
278: PetscCheck(a < PETSC_IS_COLORING_MAX, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Integer too large to convert");
279: *b = (ISColoringValue)a;
280: PetscFunctionReturn(PETSC_SUCCESS);
281: }
283: PETSC_EXTERN PetscErrorCode ISColoringCreate(MPI_Comm, PetscInt, PetscInt, const ISColoringValue[], PetscCopyMode, ISColoring *);
284: PETSC_EXTERN PetscErrorCode ISColoringDestroy(ISColoring *);
285: PETSC_EXTERN PetscErrorCode ISColoringView(ISColoring, PetscViewer);
286: PETSC_EXTERN PetscErrorCode ISColoringViewFromOptions(ISColoring, PetscObject, const char[]);
287: PETSC_EXTERN PetscErrorCode ISColoringGetIS(ISColoring, PetscCopyMode, PetscInt *, IS *[]);
288: PETSC_EXTERN PetscErrorCode ISColoringRestoreIS(ISColoring, PetscCopyMode, IS *[]);
289: PETSC_EXTERN PetscErrorCode ISColoringReference(ISColoring);
290: PETSC_EXTERN PetscErrorCode ISColoringSetType(ISColoring, ISColoringType);
291: PETSC_EXTERN PetscErrorCode ISColoringGetType(ISColoring, ISColoringType *);
292: PETSC_EXTERN PetscErrorCode ISColoringGetColors(ISColoring, PetscInt *, PetscInt *, const ISColoringValue **);
294: PETSC_EXTERN PetscErrorCode ISBuildTwoSided(IS, IS, IS *);
295: PETSC_EXTERN PetscErrorCode ISPartitioningToNumbering(IS, IS *);
296: PETSC_EXTERN PetscErrorCode ISPartitioningCount(IS, PetscInt, PetscInt[]);
298: PETSC_EXTERN PetscErrorCode ISCompressIndicesGeneral(PetscInt, PetscInt, PetscInt, PetscInt, const IS[], IS[]);
299: PETSC_DEPRECATED_FUNCTION(3, 19, 0, "ISCompressIndicesGeneral()", ) static inline PetscErrorCode ISCompressIndicesSorted(PetscInt n, PetscInt bs, PetscInt imax, const IS is_in[], IS is_out[])
300: {
301: return ISCompressIndicesGeneral(n, bs, n, imax, is_in, is_out);
302: }
303: PETSC_EXTERN PetscErrorCode ISExpandIndicesGeneral(PetscInt, PetscInt, PetscInt, PetscInt, const IS[], IS[]);
305: struct _n_PetscLayout {
306: MPI_Comm comm;
307: PetscMPIInt size;
308: PetscInt n, N; /* local, global vector size */
309: PetscInt rstart, rend; /* local start, local end + 1 */
310: PetscInt *range; /* the offset of each processor */
311: PetscBool range_alloc; /* should range be freed in Destroy? */
312: PetscInt bs; /* number of elements in each block (generally for multi-component
313: * problems). Defaults to -1 and can be arbitrarily lazy so always use
314: * PetscAbs(map->bs) when accessing directly and expecting result to be
315: * positive. Do NOT multiply above numbers by bs */
316: PetscInt refcnt; /* MPI Vecs obtained with VecDuplicate() and from MatCreateVecs() reuse map of input object */
317: ISLocalToGlobalMapping mapping; /* mapping used in Vec/MatSetValuesLocal() */
318: PetscBool setupcalled; /* Forbid setup more than once */
319: PetscInt oldn, oldN; /* Checking if setup is allowed */
320: PetscInt oldbs; /* And again */
321: };
323: PETSC_EXTERN PetscErrorCode PetscLayoutCreate(MPI_Comm, PetscLayout *);
324: PETSC_EXTERN PetscErrorCode PetscLayoutFindOwner(PetscLayout, PetscInt, PetscMPIInt *);
325: PETSC_EXTERN PetscErrorCode PetscLayoutFindOwnerIndex(PetscLayout, PetscInt, PetscMPIInt *, PetscInt *);
326: PETSC_EXTERN PetscErrorCode PetscLayoutCreateFromSizes(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscLayout *);
327: PETSC_EXTERN PetscErrorCode PetscLayoutCreateFromRanges(MPI_Comm, const PetscInt[], PetscCopyMode, PetscInt, PetscLayout *);
328: PETSC_EXTERN PetscErrorCode PetscLayoutSetUp(PetscLayout);
329: PETSC_EXTERN PetscErrorCode PetscLayoutDestroy(PetscLayout *);
330: PETSC_EXTERN PetscErrorCode PetscLayoutDuplicate(PetscLayout, PetscLayout *);
331: PETSC_EXTERN PetscErrorCode PetscLayoutReference(PetscLayout, PetscLayout *);
332: PETSC_EXTERN PetscErrorCode PetscLayoutSetLocalSize(PetscLayout, PetscInt);
333: PETSC_EXTERN PetscErrorCode PetscLayoutGetLocalSize(PetscLayout, PetscInt *);
334: PETSC_EXTERN PetscErrorCode PetscLayoutSetSize(PetscLayout, PetscInt);
335: PETSC_EXTERN PetscErrorCode PetscLayoutGetSize(PetscLayout, PetscInt *);
336: PETSC_EXTERN PetscErrorCode PetscLayoutSetBlockSize(PetscLayout, PetscInt);
337: PETSC_EXTERN PetscErrorCode PetscLayoutGetBlockSize(PetscLayout, PetscInt *);
338: PETSC_EXTERN PetscErrorCode PetscLayoutGetRange(PetscLayout, PetscInt *, PetscInt *);
339: PETSC_EXTERN PetscErrorCode PetscLayoutGetRanges(PetscLayout, const PetscInt *[]);
340: PETSC_EXTERN PetscErrorCode PetscLayoutCompare(PetscLayout, PetscLayout, PetscBool *);
341: PETSC_EXTERN PetscErrorCode PetscLayoutSetISLocalToGlobalMapping(PetscLayout, ISLocalToGlobalMapping);
342: PETSC_EXTERN PetscErrorCode PetscLayoutMapLocal(PetscLayout, PetscInt, const PetscInt[], PetscInt *, PetscInt **, PetscInt **);
344: PETSC_EXTERN PetscErrorCode PetscParallelSortInt(PetscLayout, PetscLayout, PetscInt *, PetscInt *);
346: PETSC_EXTERN PetscErrorCode ISGetLayout(IS, PetscLayout *);
347: PETSC_EXTERN PetscErrorCode ISSetLayout(IS, PetscLayout);