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