xref: /petsc/include/petscis.h (revision fab16db7bb4a26ecb8a7466bbc83a808c3b2921c)
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 
10 #define IS_FILE_CLASSID 1211218
11 PETSC_EXTERN PetscClassId IS_CLASSID;
12 
13 PETSC_EXTERN PetscErrorCode ISInitializePackage(void);
14 
15 /*S
16      IS - Abstract PETSc object that allows indexing.
17 
18    Level: beginner
19 
20   Concepts: indexing, stride
21 
22 .seealso:  ISCreateGeneral(), ISCreateBlock(), ISCreateStride(), ISGetIndices(), ISDestroy()
23 S*/
24 typedef struct _p_IS* IS;
25 
26 /*J
27     ISType - String with the name of a PETSc index set type
28 
29    Level: beginner
30 
31 .seealso: ISSetType(), IS, ISCreate(), ISRegister()
32 J*/
33 typedef const char* ISType;
34 #define ISGENERAL      "general"
35 #define ISSTRIDE       "stride"
36 #define ISBLOCK        "block"
37 
38 /* Dynamic creation and loading functions */
39 PETSC_EXTERN PetscFunctionList ISList;
40 PETSC_EXTERN PetscBool         ISRegisterAllCalled;
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*);
46 
47 /*
48     Default index set data structures that PETSc provides.
49 */
50 PETSC_EXTERN PetscErrorCode ISCreateGeneral(MPI_Comm,PetscInt,const PetscInt[],PetscCopyMode,IS *);
51 PETSC_EXTERN PetscErrorCode ISGeneralSetIndices(IS,PetscInt,const PetscInt[],PetscCopyMode);
52 PETSC_EXTERN PetscErrorCode ISCreateBlock(MPI_Comm,PetscInt,PetscInt,const PetscInt[],PetscCopyMode,IS *);
53 PETSC_EXTERN PetscErrorCode ISBlockSetIndices(IS,PetscInt,PetscInt,const PetscInt[],PetscCopyMode);
54 PETSC_EXTERN PetscErrorCode ISCreateStride(MPI_Comm,PetscInt,PetscInt,PetscInt,IS *);
55 PETSC_EXTERN PetscErrorCode ISStrideSetStride(IS,PetscInt,PetscInt,PetscInt);
56 
57 PETSC_EXTERN PetscErrorCode ISDestroy(IS*);
58 PETSC_EXTERN PetscErrorCode ISSetPermutation(IS);
59 PETSC_EXTERN PetscErrorCode ISPermutation(IS,PetscBool *);
60 PETSC_EXTERN PetscErrorCode ISSetIdentity(IS);
61 PETSC_EXTERN PetscErrorCode ISIdentity(IS,PetscBool *);
62 PETSC_EXTERN PetscErrorCode ISContiguousLocal(IS,PetscInt,PetscInt,PetscInt*,PetscBool*);
63 
64 PETSC_EXTERN PetscErrorCode ISGetIndices(IS,const PetscInt *[]);
65 PETSC_EXTERN PetscErrorCode ISRestoreIndices(IS,const PetscInt *[]);
66 PETSC_EXTERN PetscErrorCode ISGetTotalIndices(IS,const PetscInt *[]);
67 PETSC_EXTERN PetscErrorCode ISRestoreTotalIndices(IS,const PetscInt *[]);
68 PETSC_EXTERN PetscErrorCode ISGetNonlocalIndices(IS,const PetscInt *[]);
69 PETSC_EXTERN PetscErrorCode ISRestoreNonlocalIndices(IS,const PetscInt *[]);
70 PETSC_EXTERN PetscErrorCode ISGetNonlocalIS(IS, IS *is);
71 PETSC_EXTERN PetscErrorCode ISRestoreNonlocalIS(IS, IS *is);
72 PETSC_EXTERN PetscErrorCode ISGetSize(IS,PetscInt *);
73 PETSC_EXTERN PetscErrorCode ISGetLocalSize(IS,PetscInt *);
74 PETSC_EXTERN PetscErrorCode ISInvertPermutation(IS,PetscInt,IS*);
75 PETSC_EXTERN PetscErrorCode ISView(IS,PetscViewer);
76 PETSC_STATIC_INLINE PetscErrorCode ISViewFromOptions(IS A,const char prefix[],const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,prefix,name);}
77 PETSC_EXTERN PetscErrorCode ISLoad(IS,PetscViewer);
78 PETSC_EXTERN PetscErrorCode ISEqual(IS,IS,PetscBool  *);
79 PETSC_EXTERN PetscErrorCode ISSort(IS);
80 PETSC_EXTERN PetscErrorCode ISSortRemoveDups(IS);
81 PETSC_EXTERN PetscErrorCode ISSorted(IS,PetscBool  *);
82 PETSC_EXTERN PetscErrorCode ISDifference(IS,IS,IS*);
83 PETSC_EXTERN PetscErrorCode ISSum(IS,IS,IS*);
84 PETSC_EXTERN PetscErrorCode ISExpand(IS,IS,IS*);
85 PETSC_EXTERN PetscErrorCode ISGetMinMax(IS,PetscInt*,PetscInt*);
86 
87 PETSC_EXTERN PetscErrorCode ISBlockGetIndices(IS,const PetscInt *[]);
88 PETSC_EXTERN PetscErrorCode ISBlockRestoreIndices(IS,const PetscInt *[]);
89 PETSC_EXTERN PetscErrorCode ISBlockGetLocalSize(IS,PetscInt *);
90 PETSC_EXTERN PetscErrorCode ISBlockGetSize(IS,PetscInt *);
91 PETSC_EXTERN PetscErrorCode ISGetBlockSize(IS,PetscInt*);
92 PETSC_EXTERN PetscErrorCode ISSetBlockSize(IS,PetscInt);
93 
94 PETSC_EXTERN PetscErrorCode ISStrideGetInfo(IS,PetscInt *,PetscInt*);
95 
96 PETSC_EXTERN PetscErrorCode ISToGeneral(IS);
97 
98 PETSC_EXTERN PetscErrorCode ISDuplicate(IS,IS*);
99 PETSC_EXTERN PetscErrorCode ISCopy(IS,IS);
100 PETSC_EXTERN PetscErrorCode ISAllGather(IS,IS*);
101 PETSC_EXTERN PetscErrorCode ISComplement(IS,PetscInt,PetscInt,IS*);
102 PETSC_EXTERN PetscErrorCode ISConcatenate(MPI_Comm,PetscInt,const IS[],IS*);
103 PETSC_EXTERN PetscErrorCode ISListToPair(MPI_Comm,PetscInt, IS[],IS*,IS*);
104 PETSC_EXTERN PetscErrorCode ISPairToList(IS,IS,PetscInt*, IS *[]);
105 PETSC_EXTERN PetscErrorCode ISEmbed(IS,IS,PetscBool,IS*);
106 PETSC_EXTERN PetscErrorCode ISOnComm(IS,MPI_Comm,PetscCopyMode,IS*);
107 
108 /* --------------------------------------------------------------------------*/
109 PETSC_EXTERN PetscClassId IS_LTOGM_CLASSID;
110 
111 /*S
112    ISLocalToGlobalMapping - mappings from an arbitrary
113       local ordering from 0 to n-1 to a global PETSc ordering
114       used by a vector or matrix.
115 
116    Level: intermediate
117 
118    Note: mapping from Local to Global is scalable; but Global
119   to Local may not be if the range of global values represented locally
120   is very large.
121 
122    Note: the ISLocalToGlobalMapping is actually a private object; it is included
123   here for the inline function ISLocalToGlobalMappingApply() to allow it to be inlined since
124   it is used so often.
125 
126 .seealso:  ISLocalToGlobalMappingCreate()
127 S*/
128 typedef struct _p_ISLocalToGlobalMapping* ISLocalToGlobalMapping;
129 
130 /*E
131     ISGlobalToLocalMappingType - Indicates if missing global indices are
132 
133    IS_GTOLM_MASK - missing global indices are replaced with -1
134    IS_GTOLM_DROP - missing global indices are dropped
135 
136    Level: beginner
137 
138 .seealso: ISGlobalToLocalMappingApply()
139 
140 E*/
141 typedef enum {IS_GTOLM_MASK,IS_GTOLM_DROP} ISGlobalToLocalMappingType;
142 
143 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingCreate(MPI_Comm,PetscInt,const PetscInt[],PetscCopyMode,ISLocalToGlobalMapping*);
144 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingCreateIS(IS,ISLocalToGlobalMapping *);
145 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingCreateSF(PetscSF,PetscInt,ISLocalToGlobalMapping*);
146 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingView(ISLocalToGlobalMapping,PetscViewer);
147 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingDestroy(ISLocalToGlobalMapping*);
148 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingApply(ISLocalToGlobalMapping,PetscInt,const PetscInt[],PetscInt[]);
149 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingApplyIS(ISLocalToGlobalMapping,IS,IS*);
150 PETSC_EXTERN PetscErrorCode ISGlobalToLocalMappingApply(ISLocalToGlobalMapping,ISGlobalToLocalMappingType,PetscInt,const PetscInt[],PetscInt*,PetscInt[]);
151 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetSize(ISLocalToGlobalMapping,PetscInt*);
152 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt*[],PetscInt**[]);
153 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt*[],PetscInt**[]);
154 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetIndices(ISLocalToGlobalMapping,const PetscInt**);
155 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreIndices(ISLocalToGlobalMapping,const PetscInt**);
156 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingBlock(ISLocalToGlobalMapping,PetscInt,ISLocalToGlobalMapping*);
157 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingUnBlock(ISLocalToGlobalMapping,PetscInt,ISLocalToGlobalMapping*);
158 PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingConcatenate(MPI_Comm,PetscInt,const ISLocalToGlobalMapping[],ISLocalToGlobalMapping*);
159 PETSC_EXTERN PetscErrorCode ISG2LMapApply(ISLocalToGlobalMapping,PetscInt,const PetscInt[],PetscInt[]);
160 
161 /* --------------------------------------------------------------------------*/
162 /*E
163     ISColoringType - determines if the coloring is for the entire parallel grid/graph/matrix
164                      or for just the local ghosted portion
165 
166     Level: beginner
167 
168 $   IS_COLORING_GLOBAL - does not include the colors for ghost points, this is used when the function
169 $                        is called synchronously in parallel. This requires generating a "parallel coloring".
170 $   IS_COLORING_GHOSTED - includes colors for ghost points, this is used when the function can be called
171 $                         seperately on individual processes with the ghost points already filled in. Does not
172 $                         require a "parallel coloring", rather each process colors its local + ghost part.
173 $                         Using this can result in much less parallel communication. In the paradigm of
174 $                         DMGetLocalVector() and DMGetGlobalVector() this could be called IS_COLORING_LOCAL
175 
176 .seealso: DMCreateColoring()
177 E*/
178 typedef enum {IS_COLORING_GLOBAL,IS_COLORING_GHOSTED} ISColoringType;
179 PETSC_EXTERN const char *const ISColoringTypes[];
180 typedef unsigned PETSC_IS_COLOR_VALUE_TYPE ISColoringValue;
181 PETSC_EXTERN PetscErrorCode ISAllGatherColors(MPI_Comm,PetscInt,ISColoringValue*,PetscInt*,ISColoringValue*[]);
182 
183 /*S
184      ISColoring - sets of IS's that define a coloring
185               of the underlying indices
186 
187    Level: intermediate
188 
189     Notes:
190         One should not access the *is records below directly because they may not yet
191     have been created. One should use ISColoringGetIS() to make sure they are
192     created when needed.
193 
194     Developer Note: this is not a PetscObject
195 
196 .seealso:  ISColoringCreate(), ISColoringGetIS(), ISColoringView(), ISColoringGetIS()
197 S*/
198 struct _n_ISColoring {
199   PetscInt        refct;
200   PetscInt        n;                /* number of colors */
201   IS              *is;              /* for each color indicates columns */
202   MPI_Comm        comm;
203   ISColoringValue *colors;          /* for each column indicates color */
204   PetscInt        N;                /* number of columns */
205   ISColoringType  ctype;
206 };
207 typedef struct _n_ISColoring* ISColoring;
208 
209 PETSC_EXTERN PetscErrorCode ISColoringCreate(MPI_Comm,PetscInt,PetscInt,const ISColoringValue[],ISColoring*);
210 PETSC_EXTERN PetscErrorCode ISColoringDestroy(ISColoring*);
211 PETSC_EXTERN PetscErrorCode ISColoringView(ISColoring,PetscViewer);
212 PETSC_EXTERN PetscErrorCode ISColoringViewFromOptions(ISColoring,const char[],const char[]);
213 PETSC_EXTERN PetscErrorCode ISColoringGetIS(ISColoring,PetscInt*,IS*[]);
214 PETSC_EXTERN PetscErrorCode ISColoringRestoreIS(ISColoring,IS*[]);
215 PETSC_EXTERN PetscErrorCode ISColoringReference(ISColoring);
216 PETSC_EXTERN PetscErrorCode ISColoringSetType(ISColoring,ISColoringType);
217 
218 
219 /* --------------------------------------------------------------------------*/
220 
221 PETSC_EXTERN PetscErrorCode ISPartitioningToNumbering(IS,IS*);
222 PETSC_EXTERN PetscErrorCode ISPartitioningCount(IS,PetscInt,PetscInt[]);
223 
224 PETSC_EXTERN PetscErrorCode ISCompressIndicesGeneral(PetscInt,PetscInt,PetscInt,PetscInt,const IS[],IS[]);
225 PETSC_EXTERN PetscErrorCode ISCompressIndicesSorted(PetscInt,PetscInt,PetscInt,const IS[],IS[]);
226 PETSC_EXTERN PetscErrorCode ISExpandIndicesGeneral(PetscInt,PetscInt,PetscInt,PetscInt,const IS[],IS[]);
227 
228 /*S
229      PetscLayout - defines layout of vectors and matrices across processes (which rows are owned by which processes)
230 
231    Level: developer
232 
233 
234 .seealso:  PetscLayoutCreate(), PetscLayoutDestroy()
235 S*/
236 typedef struct _n_PetscLayout* PetscLayout;
237 struct _n_PetscLayout{
238   MPI_Comm               comm;
239   PetscInt               n,N;         /* local, global vector size */
240   PetscInt               rstart,rend; /* local start, local end + 1 */
241   PetscInt               *range;      /* the offset of each processor */
242   PetscInt               bs;          /* number of elements in each block (generally for multi-component
243                                        * problems). Defaults to -1 and can be arbitrarily lazy so always use
244                                        * PetscAbs(map->bs) when accessing directly and expecting result to be
245                                        * positive. Do NOT multiply above numbers by bs */
246   PetscInt               refcnt;      /* MPI Vecs obtained with VecDuplicate() and from MatGetVecs() reuse map of input object */
247   ISLocalToGlobalMapping mapping;     /* mapping used in Vec/MatSetValuesLocal() */
248   ISLocalToGlobalMapping bmapping;    /* mapping used in Vec/MatSetValuesBlockedLocal() */
249   PetscInt               *trstarts;   /* local start for each thread */
250 };
251 
252 PETSC_EXTERN PetscErrorCode PetscLayoutCreate(MPI_Comm,PetscLayout*);
253 PETSC_EXTERN PetscErrorCode PetscLayoutSetUp(PetscLayout);
254 PETSC_EXTERN PetscErrorCode PetscLayoutDestroy(PetscLayout*);
255 PETSC_EXTERN PetscErrorCode PetscLayoutDuplicate(PetscLayout,PetscLayout*);
256 PETSC_EXTERN PetscErrorCode PetscLayoutReference(PetscLayout,PetscLayout*);
257 PETSC_EXTERN PetscErrorCode PetscLayoutSetLocalSize(PetscLayout,PetscInt);
258 PETSC_EXTERN PetscErrorCode PetscLayoutGetLocalSize(PetscLayout,PetscInt *);
259 PETSC_EXTERN PetscErrorCode PetscLayoutSetSize(PetscLayout,PetscInt);
260 PETSC_EXTERN PetscErrorCode PetscLayoutGetSize(PetscLayout,PetscInt *);
261 PETSC_EXTERN PetscErrorCode PetscLayoutSetBlockSize(PetscLayout,PetscInt);
262 PETSC_EXTERN PetscErrorCode PetscLayoutGetBlockSize(PetscLayout,PetscInt*);
263 PETSC_EXTERN PetscErrorCode PetscLayoutGetRange(PetscLayout,PetscInt *,PetscInt *);
264 PETSC_EXTERN PetscErrorCode PetscLayoutGetRanges(PetscLayout,const PetscInt *[]);
265 PETSC_EXTERN PetscErrorCode PetscLayoutSetISLocalToGlobalMapping(PetscLayout,ISLocalToGlobalMapping);
266 PETSC_EXTERN PetscErrorCode PetscLayoutSetISLocalToGlobalMappingBlock(PetscLayout,ISLocalToGlobalMapping);
267 PETSC_EXTERN PetscErrorCode PetscSFSetGraphLayout(PetscSF,PetscLayout,PetscInt,const PetscInt*,PetscCopyMode,const PetscInt*);
268 
269 #undef __FUNCT__
270 #define __FUNCT__ "PetscLayoutFindOwner"
271 /*@C
272      PetscLayoutFindOwner - Find the owning rank for a global index
273 
274     Not Collective
275 
276    Input Parameters:
277 +    map - the layout
278 -    idx - global index to find the owner of
279 
280    Output Parameter:
281 .    owner - the owning rank
282 
283    Level: developer
284 
285     Fortran Notes:
286       Not available from Fortran
287 
288 @*/
289 PETSC_STATIC_INLINE PetscErrorCode PetscLayoutFindOwner(PetscLayout map,PetscInt idx,PetscInt *owner)
290 {
291   PetscErrorCode ierr;
292   PetscMPIInt    lo = 0,hi,t;
293 
294   PetscFunctionBegin;
295   *owner = -1;                  /* GCC erroneously issues warning about possibly uninitialized use when error condition */
296   if (!((map->n >= 0) && (map->N >= 0) && (map->range))) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"PetscLayoutSetUp() must be called first");
297   if (idx < 0 || idx > map->N) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Index %D is out of range",idx);
298   ierr = MPI_Comm_size(map->comm,&hi);CHKERRQ(ierr);
299   while (hi - lo > 1) {
300     t = lo + (hi - lo) / 2;
301     if (idx < map->range[t]) hi = t;
302     else                     lo = t;
303   }
304   *owner = lo;
305   PetscFunctionReturn(0);
306 }
307 
308 #undef __FUNCT__
309 #define __FUNCT__ "PetscLayoutFindOwnerIndex"
310 /*@C
311      PetscLayoutFindOwnerIndex - Find the owning rank and the local index for a global index
312 
313     Not Collective
314 
315    Input Parameters:
316 +    map   - the layout
317 -    idx   - global index to find the owner of
318 
319    Output Parameter:
320 +    owner - the owning rank
321 -    lidx  - local index used by the owner for idx
322 
323    Level: developer
324 
325     Fortran Notes:
326       Not available from Fortran
327 
328 @*/
329 PETSC_STATIC_INLINE PetscErrorCode PetscLayoutFindOwnerIndex(PetscLayout map,PetscInt idx,PetscInt *owner, PetscInt *lidx)
330 {
331   PetscErrorCode ierr;
332   PetscMPIInt    lo = 0,hi,t;
333 
334   PetscFunctionBegin;
335   if (!((map->n >= 0) && (map->N >= 0) && (map->range))) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"PetscLayoutSetUp() must be called first");
336   if (idx < 0 || idx > map->N) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Index %D is out of range",idx);
337   ierr = MPI_Comm_size(map->comm,&hi);CHKERRQ(ierr);
338   while (hi - lo > 1) {
339     t = lo + (hi - lo) / 2;
340     if (idx < map->range[t]) hi = t;
341     else                     lo = t;
342   }
343   *owner = lo;
344   *lidx  = idx-map->range[lo];
345   PetscFunctionReturn(0);
346 }
347 
348 PETSC_EXTERN PetscClassId PETSC_SECTION_CLASSID;
349 
350 /*S
351   PetscSection - Mapping from integers in a designated range to contiguous sets of integers.
352 
353   In contrast to IS, which maps from integers to single integers, the range of a PetscSection is in the space of
354   contiguous sets of integers. These ranges are frequently interpreted as domains of other array-like objects,
355   especially other PetscSections, Vecs, and ISs. The domain is set with PetscSectionSetChart() and does not need to
356   start at 0. For each point in the domain of a PetscSection, the output set is represented through an offset and a
357   count, which are set using PetscSectionSetOffset() and PetscSectionSetDof() respectively. Lookup is typically using
358   accessors or routines like VecGetValuesSection().
359 
360   Level: developer
361 
362 .seealso:  PetscSectionCreate(), PetscSectionDestroy()
363 S*/
364 typedef struct _p_PetscSection *PetscSection;
365 PETSC_EXTERN PetscErrorCode PetscSectionCreate(MPI_Comm,PetscSection*);
366 PETSC_EXTERN PetscErrorCode PetscSectionClone(PetscSection, PetscSection*);
367 PETSC_EXTERN PetscErrorCode PetscSectionGetNumFields(PetscSection, PetscInt *);
368 PETSC_EXTERN PetscErrorCode PetscSectionSetNumFields(PetscSection, PetscInt);
369 PETSC_EXTERN PetscErrorCode PetscSectionGetFieldName(PetscSection, PetscInt, const char *[]);
370 PETSC_EXTERN PetscErrorCode PetscSectionSetFieldName(PetscSection, PetscInt, const char []);
371 PETSC_EXTERN PetscErrorCode PetscSectionGetFieldComponents(PetscSection, PetscInt, PetscInt *);
372 PETSC_EXTERN PetscErrorCode PetscSectionSetFieldComponents(PetscSection, PetscInt, PetscInt);
373 PETSC_EXTERN PetscErrorCode PetscSectionGetChart(PetscSection, PetscInt *, PetscInt *);
374 PETSC_EXTERN PetscErrorCode PetscSectionSetChart(PetscSection, PetscInt, PetscInt);
375 PETSC_EXTERN PetscErrorCode PetscSectionGetPermutation(PetscSection, IS *);
376 PETSC_EXTERN PetscErrorCode PetscSectionSetPermutation(PetscSection, IS);
377 PETSC_EXTERN PetscErrorCode PetscSectionGetDof(PetscSection, PetscInt, PetscInt*);
378 PETSC_EXTERN PetscErrorCode PetscSectionSetDof(PetscSection, PetscInt, PetscInt);
379 PETSC_EXTERN PetscErrorCode PetscSectionAddDof(PetscSection, PetscInt, PetscInt);
380 PETSC_EXTERN PetscErrorCode PetscSectionGetFieldDof(PetscSection, PetscInt, PetscInt, PetscInt*);
381 PETSC_EXTERN PetscErrorCode PetscSectionSetFieldDof(PetscSection, PetscInt, PetscInt, PetscInt);
382 PETSC_EXTERN PetscErrorCode PetscSectionAddFieldDof(PetscSection, PetscInt, PetscInt, PetscInt);
383 PETSC_EXTERN PetscErrorCode PetscSectionHasConstraints(PetscSection, PetscBool *);
384 PETSC_EXTERN PetscErrorCode PetscSectionGetConstraintDof(PetscSection, PetscInt, PetscInt*);
385 PETSC_EXTERN PetscErrorCode PetscSectionSetConstraintDof(PetscSection, PetscInt, PetscInt);
386 PETSC_EXTERN PetscErrorCode PetscSectionAddConstraintDof(PetscSection, PetscInt, PetscInt);
387 PETSC_EXTERN PetscErrorCode PetscSectionGetFieldConstraintDof(PetscSection, PetscInt, PetscInt, PetscInt*);
388 PETSC_EXTERN PetscErrorCode PetscSectionSetFieldConstraintDof(PetscSection, PetscInt, PetscInt, PetscInt);
389 PETSC_EXTERN PetscErrorCode PetscSectionAddFieldConstraintDof(PetscSection, PetscInt, PetscInt, PetscInt);
390 PETSC_EXTERN PetscErrorCode PetscSectionGetConstraintIndices(PetscSection, PetscInt, const PetscInt**);
391 PETSC_EXTERN PetscErrorCode PetscSectionSetConstraintIndices(PetscSection, PetscInt, const PetscInt*);
392 PETSC_EXTERN PetscErrorCode PetscSectionGetFieldConstraintIndices(PetscSection, PetscInt, PetscInt, const PetscInt**);
393 PETSC_EXTERN PetscErrorCode PetscSectionSetFieldConstraintIndices(PetscSection, PetscInt, PetscInt, const PetscInt*);
394 PETSC_EXTERN PetscErrorCode PetscSectionSetUpBC(PetscSection);
395 PETSC_EXTERN PetscErrorCode PetscSectionSetUp(PetscSection);
396 PETSC_EXTERN PetscErrorCode PetscSectionGetMaxDof(PetscSection, PetscInt*);
397 PETSC_EXTERN PetscErrorCode PetscSectionGetStorageSize(PetscSection, PetscInt*);
398 PETSC_EXTERN PetscErrorCode PetscSectionGetConstrainedStorageSize(PetscSection, PetscInt*);
399 PETSC_EXTERN PetscErrorCode PetscSectionGetOffset(PetscSection, PetscInt, PetscInt*);
400 PETSC_EXTERN PetscErrorCode PetscSectionSetOffset(PetscSection, PetscInt, PetscInt);
401 PETSC_EXTERN PetscErrorCode PetscSectionGetFieldOffset(PetscSection, PetscInt, PetscInt, PetscInt*);
402 PETSC_EXTERN PetscErrorCode PetscSectionSetFieldOffset(PetscSection, PetscInt, PetscInt, PetscInt);
403 PETSC_EXTERN PetscErrorCode PetscSectionGetOffsetRange(PetscSection, PetscInt *, PetscInt *);
404 PETSC_EXTERN PetscErrorCode PetscSectionView(PetscSection, PetscViewer);
405 PETSC_STATIC_INLINE PetscErrorCode PetscSectionViewFromOptions(PetscSection A,const char prefix[],const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,prefix,name);}
406 PETSC_EXTERN PetscErrorCode PetscSectionReset(PetscSection);
407 PETSC_EXTERN PetscErrorCode PetscSectionDestroy(PetscSection*);
408 PETSC_EXTERN PetscErrorCode PetscSectionCreateGlobalSection(PetscSection, PetscSF, PetscBool, PetscSection *);
409 PETSC_EXTERN PetscErrorCode PetscSectionCreateGlobalSectionCensored(PetscSection, PetscSF, PetscBool, PetscInt, const PetscInt [], PetscSection *);
410 PETSC_EXTERN PetscErrorCode PetscSectionCreateSubsection(PetscSection, PetscInt, PetscInt [], PetscSection *);
411 PETSC_EXTERN PetscErrorCode PetscSectionCreateSubmeshSection(PetscSection, IS, PetscSection *);
412 PETSC_EXTERN PetscErrorCode PetscSectionGetPointLayout(MPI_Comm, PetscSection, PetscLayout *);
413 PETSC_EXTERN PetscErrorCode PetscSectionGetValueLayout(MPI_Comm, PetscSection, PetscLayout *);
414 PETSC_EXTERN PetscErrorCode PetscSectionPermute(PetscSection, IS, PetscSection *);
415 PETSC_EXTERN PetscErrorCode PetscSectionGetField(PetscSection, PetscInt, PetscSection *);
416 
417 PETSC_EXTERN PetscErrorCode PetscSectionSetClosureIndex(PetscSection, PetscObject, PetscSection, IS);
418 PETSC_EXTERN PetscErrorCode PetscSectionGetClosureIndex(PetscSection, PetscObject, PetscSection *, IS *);
419 
420 /* PetscSF support */
421 PETSC_EXTERN PetscErrorCode PetscSFConvertPartition(PetscSF, PetscSection, IS, ISLocalToGlobalMapping *, PetscSF *);
422 PETSC_EXTERN PetscErrorCode PetscSFCreateRemoteOffsets(PetscSF, PetscSection, PetscSection, PetscInt **);
423 PETSC_EXTERN PetscErrorCode PetscSFDistributeSection(PetscSF, PetscSection, PetscInt **, PetscSection);
424 PETSC_EXTERN PetscErrorCode PetscSFCreateSectionSF(PetscSF, PetscSection, PetscInt [], PetscSection, PetscSF *);
425 
426 /* Reset __FUNCT__ in case the user does not define it themselves */
427 #undef __FUNCT__
428 #define __FUNCT__ "User provided function"
429 
430 #endif
431