xref: /petsc/include/petscis.h (revision ebead697dbf761eb322f829370bbe90b3bd93fa3)
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 #if !defined(PETSCIS_H)
6 #define PETSCIS_H
7 
8 #include <petscsys.h>
9 #include <petscsftypes.h>
10 #include <petscsectiontypes.h>
11 #include <petscistypes.h>    /*I  "petscis.h" I*/
12 
13 /* SUBMANSEC = IS */
14 
15 #define IS_FILE_CLASSID 1211218
16 PETSC_EXTERN PetscClassId IS_CLASSID;
17 
18 PETSC_EXTERN PetscErrorCode ISInitializePackage(void);
19 
20 /*J
21     ISType - String with the name of a PETSc index set type
22 
23    Level: beginner
24 
25 .seealso: `ISSetType()`, `IS`, `ISCreate()`, `ISRegister()`
26 J*/
27 typedef const char* ISType;
28 #define ISGENERAL      "general"
29 #define ISSTRIDE       "stride"
30 #define ISBLOCK        "block"
31 
32 /* Dynamic creation and loading functions */
33 PETSC_EXTERN PetscFunctionList ISList;
34 PETSC_EXTERN PetscErrorCode ISSetType(IS,ISType);
35 PETSC_EXTERN PetscErrorCode ISGetType(IS,ISType*);
36 PETSC_EXTERN PetscErrorCode ISRegister(const char[],PetscErrorCode (*)(IS));
37 PETSC_EXTERN PetscErrorCode ISCreate(MPI_Comm,IS*);
38 
39 PETSC_EXTERN PetscErrorCode ISDestroy(IS*);
40 PETSC_EXTERN PetscErrorCode ISSetPermutation(IS);
41 PETSC_EXTERN PetscErrorCode ISPermutation(IS,PetscBool*);
42 PETSC_EXTERN PetscErrorCode ISSetIdentity(IS);
43 PETSC_EXTERN PetscErrorCode ISIdentity(IS,PetscBool*);
44 PETSC_EXTERN PetscErrorCode ISContiguousLocal(IS,PetscInt,PetscInt,PetscInt*,PetscBool*);
45 
46 /*E
47     ISInfo - Info that may either be computed or set as known for an index set
48 
49     Level: beginner
50 
51    Any additions/changes here MUST also be made in include/petsc/finclude/petscis.h
52    Any additions/changes here must also be made in src/vec/vec/interface/dlregisvec.c in ISInfos[]
53 
54    Developer Notes:
55     Entries that are negative need not be called collectively by all processes.
56 
57 .seealso: `ISSetInfo()`
58 E*/
59 typedef enum {IS_INFO_MIN = -1,
60               IS_SORTED = 0,
61               IS_UNIQUE = 1,
62               IS_PERMUTATION = 2,
63               IS_INTERVAL = 3,
64               IS_IDENTITY = 4,
65               IS_INFO_MAX = 5} ISInfo;
66 
67 typedef enum {IS_LOCAL, IS_GLOBAL} ISInfoType;
68 
69 PETSC_EXTERN PetscErrorCode ISSetInfo(IS,ISInfo,ISInfoType,PetscBool,PetscBool);
70 PETSC_EXTERN PetscErrorCode ISGetInfo(IS,ISInfo,ISInfoType,PetscBool,PetscBool*);
71 PETSC_EXTERN PetscErrorCode ISClearInfoCache(IS,PetscBool);
72 PETSC_EXTERN PetscErrorCode ISGetIndices(IS,const PetscInt*[]);
73 PETSC_EXTERN PetscErrorCode ISRestoreIndices(IS,const PetscInt*[]);
74 PETSC_EXTERN PetscErrorCode ISGetTotalIndices(IS,const PetscInt*[]);
75 PETSC_EXTERN PetscErrorCode ISRestoreTotalIndices(IS,const PetscInt*[]);
76 PETSC_EXTERN PetscErrorCode ISGetNonlocalIndices(IS,const PetscInt*[]);
77 PETSC_EXTERN PetscErrorCode ISRestoreNonlocalIndices(IS,const PetscInt*[]);
78 PETSC_EXTERN PetscErrorCode ISGetNonlocalIS(IS,IS*);
79 PETSC_EXTERN PetscErrorCode ISRestoreNonlocalIS(IS,IS*);
80 PETSC_EXTERN PetscErrorCode ISGetSize(IS,PetscInt*);
81 PETSC_EXTERN PetscErrorCode ISGetLocalSize(IS,PetscInt*);
82 PETSC_EXTERN PetscErrorCode ISInvertPermutation(IS,PetscInt,IS*);
83 PETSC_EXTERN PetscErrorCode ISView(IS,PetscViewer);
84 PETSC_EXTERN PetscErrorCode ISViewFromOptions(IS,PetscObject,const char[]);
85 PETSC_EXTERN PetscErrorCode ISLoad(IS,PetscViewer);
86 PETSC_EXTERN PetscErrorCode ISEqual(IS,IS,PetscBool*);
87 PETSC_EXTERN PetscErrorCode ISEqualUnsorted(IS,IS,PetscBool *);
88 PETSC_EXTERN PetscErrorCode ISSort(IS);
89 PETSC_EXTERN PetscErrorCode ISSortRemoveDups(IS);
90 PETSC_EXTERN PetscErrorCode ISSorted(IS,PetscBool*);
91 PETSC_EXTERN PetscErrorCode ISDifference(IS,IS,IS*);
92 PETSC_EXTERN PetscErrorCode ISSum(IS,IS,IS*);
93 PETSC_EXTERN PetscErrorCode ISExpand(IS,IS,IS*);
94 PETSC_EXTERN PetscErrorCode ISIntersect(IS,IS,IS*);
95 PETSC_EXTERN PetscErrorCode ISGetMinMax(IS,PetscInt*,PetscInt*);
96 
97 PETSC_EXTERN PetscErrorCode ISLocate(IS,PetscInt,PetscInt*);
98 PETSC_EXTERN PetscErrorCode ISGetPointRange(IS,PetscInt*,PetscInt*,const PetscInt**);
99 PETSC_EXTERN PetscErrorCode ISRestorePointRange(IS,PetscInt*,PetscInt*,const PetscInt**);
100 PETSC_EXTERN PetscErrorCode ISGetPointSubrange(IS,PetscInt,PetscInt,const PetscInt*);
101 
102 PETSC_EXTERN PetscErrorCode ISGetBlockSize(IS,PetscInt*);
103 PETSC_EXTERN PetscErrorCode ISSetBlockSize(IS,PetscInt);
104 
105 PETSC_EXTERN PetscErrorCode ISToGeneral(IS);
106 
107 PETSC_EXTERN PetscErrorCode ISDuplicate(IS,IS*);
108 PETSC_EXTERN PetscErrorCode ISCopy(IS,IS);
109 PETSC_EXTERN PetscErrorCode ISShift(IS,PetscInt,IS);
110 PETSC_EXTERN PetscErrorCode ISAllGather(IS,IS*);
111 PETSC_EXTERN PetscErrorCode ISComplement(IS,PetscInt,PetscInt,IS*);
112 PETSC_EXTERN PetscErrorCode ISConcatenate(MPI_Comm,PetscInt,const IS[],IS*);
113 PETSC_EXTERN PetscErrorCode ISListToPair(MPI_Comm,PetscInt,IS[],IS*,IS*);
114 PETSC_EXTERN PetscErrorCode ISPairToList(IS,IS,PetscInt*,IS*[]);
115 PETSC_EXTERN PetscErrorCode ISEmbed(IS,IS,PetscBool,IS*);
116 PETSC_EXTERN PetscErrorCode ISSortPermutation(IS,PetscBool,IS*);
117 PETSC_EXTERN PetscErrorCode ISOnComm(IS,MPI_Comm,PetscCopyMode,IS*);
118 PETSC_EXTERN PetscErrorCode ISRenumber(IS,IS,PetscInt*,IS*);
119 PETSC_EXTERN PetscErrorCode ISCreateSubIS(IS,IS,IS*);
120 
121 /* ISGENERAL specific */
122 PETSC_EXTERN PetscErrorCode ISCreateGeneral(MPI_Comm,PetscInt,const PetscInt[],PetscCopyMode,IS*);
123 PETSC_EXTERN PetscErrorCode ISGeneralSetIndices(IS,PetscInt,const PetscInt[],PetscCopyMode);
124 PETSC_EXTERN PetscErrorCode ISGeneralSetIndicesFromMask(IS,PetscInt,PetscInt,const PetscBool[]);
125 PETSC_EXTERN PetscErrorCode ISGeneralFilter(IS,PetscInt,PetscInt);
126 
127 /* ISBLOCK specific */
128 PETSC_EXTERN PetscErrorCode ISCreateBlock(MPI_Comm,PetscInt,PetscInt,const PetscInt[],PetscCopyMode,IS*);
129 PETSC_EXTERN PetscErrorCode ISBlockSetIndices(IS,PetscInt,PetscInt,const PetscInt[],PetscCopyMode);
130 PETSC_EXTERN PetscErrorCode ISBlockGetIndices(IS,const PetscInt*[]);
131 PETSC_EXTERN PetscErrorCode ISBlockRestoreIndices(IS,const PetscInt*[]);
132 PETSC_EXTERN PetscErrorCode ISBlockGetLocalSize(IS,PetscInt*);
133 PETSC_EXTERN PetscErrorCode ISBlockGetSize(IS,PetscInt*);
134 
135 /* ISSTRIDE specific */
136 PETSC_EXTERN PetscErrorCode ISCreateStride(MPI_Comm,PetscInt,PetscInt,PetscInt,IS*);
137 PETSC_EXTERN PetscErrorCode ISStrideSetStride(IS,PetscInt,PetscInt,PetscInt);
138 PETSC_EXTERN PetscErrorCode ISStrideGetInfo(IS,PetscInt*,PetscInt*);
139 
140 /* --------------------------------------------------------------------------*/
141 PETSC_EXTERN PetscClassId IS_LTOGM_CLASSID;
142 
143 /*E
144     ISGlobalToLocalMappingMode - Indicates mapping behavior if global indices are missing
145 
146    IS_GTOLM_MASK - missing global indices are masked by mapping them to a local index of -1
147    IS_GTOLM_DROP - missing global indices are dropped
148 
149    Level: beginner
150 
151 .seealso: `ISGlobalToLocalMappingApplyBlock()`, `ISGlobalToLocalMappingApply()`
152 
153 E*/
154 typedef enum {IS_GTOLM_MASK,IS_GTOLM_DROP} ISGlobalToLocalMappingMode;
155 
156 /*J
157     ISLocalToGlobalMappingType - String with the name of a mapping method
158 
159    Level: beginner
160 
161 .seealso: `ISLocalToGlobalMappingSetType()`, `ISLocalToGlobalSetFromOptions()`
162 J*/
163 typedef const char* ISLocalToGlobalMappingType;
164 #define ISLOCALTOGLOBALMAPPINGBASIC "basic"
165 #define ISLOCALTOGLOBALMAPPINGHASH  "hash"
166 
167 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingSetType(ISLocalToGlobalMapping,ISLocalToGlobalMappingType);
168 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetType(ISLocalToGlobalMapping,ISLocalToGlobalMappingType*);
169 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRegister(const char[],PetscErrorCode (*)(ISLocalToGlobalMapping));
170 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRegisterAll(void);
171 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingCreate(MPI_Comm,PetscInt,PetscInt,const PetscInt[],PetscCopyMode,ISLocalToGlobalMapping*);
172 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingCreateIS(IS,ISLocalToGlobalMapping *);
173 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingCreateSF(PetscSF,PetscInt,ISLocalToGlobalMapping*);
174 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingSetFromOptions(ISLocalToGlobalMapping);
175 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingSetUp(ISLocalToGlobalMapping);
176 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingView(ISLocalToGlobalMapping,PetscViewer);
177 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingViewFromOptions(ISLocalToGlobalMapping,PetscObject,const char[]);
178 
179 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingDestroy(ISLocalToGlobalMapping*);
180 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingApply(ISLocalToGlobalMapping,PetscInt,const PetscInt[],PetscInt[]);
181 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingApplyBlock(ISLocalToGlobalMapping,PetscInt,const PetscInt[],PetscInt[]);
182 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingApplyIS(ISLocalToGlobalMapping,IS,IS*);
183 PETSC_EXTERN PetscErrorCode ISGlobalToLocalMappingApply(ISLocalToGlobalMapping,ISGlobalToLocalMappingMode,PetscInt,const PetscInt[],PetscInt*,PetscInt[]);
184 PETSC_EXTERN PetscErrorCode ISGlobalToLocalMappingApplyBlock(ISLocalToGlobalMapping,ISGlobalToLocalMappingMode,PetscInt,const PetscInt[],PetscInt*,PetscInt[]);
185 PETSC_EXTERN PetscErrorCode ISGlobalToLocalMappingApplyIS(ISLocalToGlobalMapping,ISGlobalToLocalMappingMode,IS,IS*);
186 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetSize(ISLocalToGlobalMapping,PetscInt*);
187 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetNodeInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt**[]);
188 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreNodeInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt**[]);
189 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt*[],PetscInt**[]);
190 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt*[],PetscInt**[]);
191 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetBlockInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt*[],PetscInt**[]);
192 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreBlockInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt*[],PetscInt**[]);
193 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetIndices(ISLocalToGlobalMapping,const PetscInt**);
194 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreIndices(ISLocalToGlobalMapping,const PetscInt**);
195 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetBlockIndices(ISLocalToGlobalMapping,const PetscInt**);
196 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreBlockIndices(ISLocalToGlobalMapping,const PetscInt**);
197 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingConcatenate(MPI_Comm,PetscInt,const ISLocalToGlobalMapping[],ISLocalToGlobalMapping*);
198 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetBlockSize(ISLocalToGlobalMapping,PetscInt*);
199 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingSetBlockSize(ISLocalToGlobalMapping,PetscInt);
200 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingDuplicate(ISLocalToGlobalMapping,ISLocalToGlobalMapping*);
201 
202 /* --------------------------------------------------------------------------*/
203 /*E
204     ISColoringType - determines if the coloring is for the entire parallel grid/graph/matrix
205                      or for just the local ghosted portion
206 
207     Level: beginner
208 
209 $   IS_COLORING_GLOBAL - does not include the colors for ghost points, this is used when the function
210 $                        is called synchronously in parallel. This requires generating a "parallel coloring".
211 $   IS_COLORING_LOCAL - includes colors for ghost points, this is used when the function can be called
212 $                         separately on individual processes with the ghost points already filled in. Does not
213 $                         require a "parallel coloring", rather each process colors its local + ghost part.
214 $                         Using this can result in much less parallel communication. Currently only works
215 $                         with DMDA and if you call MatFDColoringSetFunction() with the local function.
216 
217 .seealso: `DMCreateColoring()`
218 E*/
219 typedef enum {IS_COLORING_GLOBAL,IS_COLORING_LOCAL} ISColoringType;
220 PETSC_EXTERN const char *const ISColoringTypes[];
221 typedef unsigned PETSC_IS_COLORING_VALUE_TYPE ISColoringValue;
222 #define IS_COLORING_MAX PETSC_IS_COLORING_MAX
223 #define MPIU_COLORING_VALUE PETSC_MPIU_IS_COLORING_VALUE_TYPE
224 PETSC_EXTERN PetscErrorCode ISAllGatherColors(MPI_Comm,PetscInt,ISColoringValue*,PetscInt*,ISColoringValue*[]);
225 
226 PETSC_EXTERN PetscErrorCode ISColoringCreate(MPI_Comm,PetscInt,PetscInt,const ISColoringValue[],PetscCopyMode,ISColoring*);
227 PETSC_EXTERN PetscErrorCode ISColoringDestroy(ISColoring*);
228 PETSC_EXTERN PetscErrorCode ISColoringView(ISColoring,PetscViewer);
229 PETSC_EXTERN PetscErrorCode ISColoringViewFromOptions(ISColoring,PetscObject,const char[]);
230 PETSC_EXTERN PetscErrorCode ISColoringGetIS(ISColoring,PetscCopyMode,PetscInt*,IS*[]);
231 PETSC_EXTERN PetscErrorCode ISColoringRestoreIS(ISColoring,PetscCopyMode,IS*[]);
232 PETSC_EXTERN PetscErrorCode ISColoringReference(ISColoring);
233 PETSC_EXTERN PetscErrorCode ISColoringSetType(ISColoring,ISColoringType);
234 PETSC_EXTERN PetscErrorCode ISColoringGetType(ISColoring,ISColoringType*);
235 PETSC_EXTERN PetscErrorCode ISColoringGetColors(ISColoring,PetscInt*,PetscInt*,const ISColoringValue**);
236 
237 /* --------------------------------------------------------------------------*/
238 PETSC_EXTERN PetscErrorCode ISBuildTwoSided(IS,IS,IS*);
239 PETSC_EXTERN PetscErrorCode ISPartitioningToNumbering(IS,IS*);
240 PETSC_EXTERN PetscErrorCode ISPartitioningCount(IS,PetscInt,PetscInt[]);
241 
242 PETSC_EXTERN PetscErrorCode ISCompressIndicesGeneral(PetscInt,PetscInt,PetscInt,PetscInt,const IS[],IS[]);
243 PETSC_EXTERN PetscErrorCode ISCompressIndicesSorted(PetscInt,PetscInt,PetscInt,const IS[],IS[]);
244 PETSC_EXTERN PetscErrorCode ISExpandIndicesGeneral(PetscInt,PetscInt,PetscInt,PetscInt,const IS[],IS[]);
245 
246 struct _n_PetscLayout{
247   MPI_Comm               comm;
248   PetscMPIInt            size;
249   PetscInt               n,N;         /* local, global vector size */
250   PetscInt               rstart,rend; /* local start, local end + 1 */
251   PetscInt               *range;      /* the offset of each processor */
252   PetscBool              range_alloc; /* should range be freed in Destroy? */
253   PetscInt               bs;          /* number of elements in each block (generally for multi-component
254                                        * problems). Defaults to -1 and can be arbitrarily lazy so always use
255                                        * PetscAbs(map->bs) when accessing directly and expecting result to be
256                                        * positive. Do NOT multiply above numbers by bs */
257   PetscInt               refcnt;      /* MPI Vecs obtained with VecDuplicate() and from MatCreateVecs() reuse map of input object */
258   ISLocalToGlobalMapping mapping;     /* mapping used in Vec/MatSetValuesLocal() */
259   PetscBool              setupcalled; /* Forbid setup more than once */
260   PetscInt               oldn,oldN;   /* Checking if setup is allowed */
261   PetscInt               oldbs;       /* And again */
262 };
263 
264 /*@C
265      PetscLayoutFindOwner - Find the owning rank for a global index
266 
267     Not Collective
268 
269    Input Parameters:
270 +    map - the layout
271 -    idx - global index to find the owner of
272 
273    Output Parameter:
274 .    owner - the owning rank
275 
276    Level: developer
277 
278     Fortran Notes:
279       Not available from Fortran
280 
281 @*/
282 static inline PetscErrorCode PetscLayoutFindOwner(PetscLayout map,PetscInt idx,PetscMPIInt *owner)
283 {
284   PetscMPIInt lo = 0,hi,t;
285 
286   PetscFunctionBegin;
287   *owner = -1;                  /* GCC erroneously issues warning about possibly uninitialized use when error condition */
288 #if defined(PETSC_USE_DEBUG)
289   PetscCheck((map->n >= 0) && (map->N >= 0) && (map->range),PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"PetscLayoutSetUp() must be called first");
290   PetscCheck(idx >= 0 && idx <= map->N,PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Index %" PetscInt_FMT " is out of range",idx);
291 #endif
292   hi = map->size;
293   while (hi - lo > 1) {
294     t = lo + (hi - lo) / 2;
295     if (idx < map->range[t]) hi = t;
296     else                     lo = t;
297   }
298   *owner = lo;
299   PetscFunctionReturn(0);
300 }
301 
302 /*@C
303      PetscLayoutFindOwnerIndex - Find the owning rank and the local index for a global index
304 
305     Not Collective
306 
307    Input Parameters:
308 +    map   - the layout
309 -    idx   - global index to find the owner of
310 
311    Output Parameters:
312 +    owner - the owning rank
313 -    lidx  - local index used by the owner for idx
314 
315    Level: developer
316 
317     Fortran Notes:
318       Not available from Fortran
319 
320 @*/
321 static inline PetscErrorCode PetscLayoutFindOwnerIndex(PetscLayout map,PetscInt idx,PetscMPIInt *owner,PetscInt *lidx)
322 {
323   PetscMPIInt lo = 0,hi,t;
324 
325   PetscFunctionBegin;
326 #if defined(PETSC_USE_DEBUG)
327   PetscCheck((map->n >= 0) && (map->N >= 0) && (map->range),PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"PetscLayoutSetUp() must be called first");
328   PetscCheck(idx >= 0 && idx <= map->N,PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Index %" PetscInt_FMT " is out of range",idx);
329 #endif
330   hi = map->size;
331   while (hi - lo > 1) {
332     t = lo + (hi - lo) / 2;
333     if (idx < map->range[t]) hi = t;
334     else                     lo = t;
335   }
336   if (owner) *owner = lo;
337   if (lidx) *lidx  = idx - map->range[lo];
338   PetscFunctionReturn(0);
339 }
340 
341 PETSC_EXTERN PetscErrorCode PetscLayoutCreate(MPI_Comm,PetscLayout*);
342 PETSC_EXTERN PetscErrorCode PetscLayoutCreateFromSizes(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscLayout*);
343 PETSC_EXTERN PetscErrorCode PetscLayoutCreateFromRanges(MPI_Comm,const PetscInt[],PetscCopyMode,PetscInt,PetscLayout*);
344 PETSC_EXTERN PetscErrorCode PetscLayoutSetUp(PetscLayout);
345 PETSC_EXTERN PetscErrorCode PetscLayoutDestroy(PetscLayout*);
346 PETSC_EXTERN PetscErrorCode PetscLayoutDuplicate(PetscLayout,PetscLayout*);
347 PETSC_EXTERN PetscErrorCode PetscLayoutReference(PetscLayout,PetscLayout*);
348 PETSC_EXTERN PetscErrorCode PetscLayoutSetLocalSize(PetscLayout,PetscInt);
349 PETSC_EXTERN PetscErrorCode PetscLayoutGetLocalSize(PetscLayout,PetscInt *);
350 PETSC_EXTERN PetscErrorCode PetscLayoutSetSize(PetscLayout,PetscInt);
351 PETSC_EXTERN PetscErrorCode PetscLayoutGetSize(PetscLayout,PetscInt*);
352 PETSC_EXTERN PetscErrorCode PetscLayoutSetBlockSize(PetscLayout,PetscInt);
353 PETSC_EXTERN PetscErrorCode PetscLayoutGetBlockSize(PetscLayout,PetscInt*);
354 PETSC_EXTERN PetscErrorCode PetscLayoutGetRange(PetscLayout,PetscInt*,PetscInt*);
355 PETSC_EXTERN PetscErrorCode PetscLayoutGetRanges(PetscLayout,const PetscInt*[]);
356 PETSC_EXTERN PetscErrorCode PetscLayoutCompare(PetscLayout,PetscLayout,PetscBool*);
357 PETSC_EXTERN PetscErrorCode PetscLayoutSetISLocalToGlobalMapping(PetscLayout,ISLocalToGlobalMapping);
358 PETSC_EXTERN PetscErrorCode PetscLayoutMapLocal(PetscLayout,PetscInt,const PetscInt[],PetscInt*,PetscInt**,PetscInt**);
359 
360 PETSC_EXTERN PetscErrorCode PetscParallelSortInt(PetscLayout, PetscLayout, PetscInt*, PetscInt*);
361 
362 PETSC_EXTERN PetscErrorCode ISGetLayout(IS,PetscLayout*);
363 PETSC_EXTERN PetscErrorCode ISSetLayout(IS,PetscLayout);
364 
365 #endif
366