Actual source code: petscis.h

petsc-3.4.0 2013-05-13
  1: /*
  2:    An index set is a generalization of a subset of integers.  Index sets
  3:    are used for defining scatters and gathers.
  4: */
  7: #include <petscsys.h>
  8: #include <petscviewertypes.h>
  9: #include <petscsftypes.h>

 11: #define IS_FILE_CLASSID 1211218
 12: PETSC_EXTERN PetscClassId IS_CLASSID;

 14: PETSC_EXTERN PetscErrorCode ISInitializePackage(void);

 16: /*S
 17:      IS - Abstract PETSc object that allows indexing.

 19:    Level: beginner

 21:   Concepts: indexing, stride

 23: .seealso:  ISCreateGeneral(), ISCreateBlock(), ISCreateStride(), ISGetIndices(), ISDestroy()
 24: S*/
 25: typedef struct _p_IS* IS;

 27: /*J
 28:     ISType - String with the name of a PETSc vector or the creation function
 29:        with an optional dynamic library name, for example
 30:        http://www.mcs.anl.gov/petsc/lib.a:myveccreate()

 32:    Level: beginner

 34: .seealso: ISSetType(), IS
 35: J*/
 36: typedef const char* ISType;
 37: #define ISGENERAL      "general"
 38: #define ISSTRIDE       "stride"
 39: #define ISBLOCK        "block"

 41: /* Dynamic creation and loading functions */
 42: PETSC_EXTERN PetscFunctionList ISList;
 43: PETSC_EXTERN PetscBool         ISRegisterAllCalled;
 44: PETSC_EXTERN PetscErrorCode ISSetType(IS, ISType);
 45: PETSC_EXTERN PetscErrorCode ISGetType(IS, ISType *);
 46: PETSC_EXTERN PetscErrorCode ISRegister(const char[],PetscErrorCode (*)(IS));
 47: PETSC_EXTERN PetscErrorCode ISRegisterAll(void);
 48: PETSC_EXTERN PetscErrorCode ISCreate(MPI_Comm,IS*);

 50: /*
 51:     Default index set data structures that PETSc provides.
 52: */
 53: PETSC_EXTERN PetscErrorCode ISCreateGeneral(MPI_Comm,PetscInt,const PetscInt[],PetscCopyMode,IS *);
 54: PETSC_EXTERN PetscErrorCode ISGeneralSetIndices(IS,PetscInt,const PetscInt[],PetscCopyMode);
 55: PETSC_EXTERN PetscErrorCode ISCreateBlock(MPI_Comm,PetscInt,PetscInt,const PetscInt[],PetscCopyMode,IS *);
 56: PETSC_EXTERN PetscErrorCode ISBlockSetIndices(IS,PetscInt,PetscInt,const PetscInt[],PetscCopyMode);
 57: PETSC_EXTERN PetscErrorCode ISCreateStride(MPI_Comm,PetscInt,PetscInt,PetscInt,IS *);
 58: PETSC_EXTERN PetscErrorCode ISStrideSetStride(IS,PetscInt,PetscInt,PetscInt);

 60: PETSC_EXTERN PetscErrorCode ISDestroy(IS*);
 61: PETSC_EXTERN PetscErrorCode ISSetPermutation(IS);
 62: PETSC_EXTERN PetscErrorCode ISPermutation(IS,PetscBool *);
 63: PETSC_EXTERN PetscErrorCode ISSetIdentity(IS);
 64: PETSC_EXTERN PetscErrorCode ISIdentity(IS,PetscBool *);
 65: PETSC_EXTERN PetscErrorCode ISContiguousLocal(IS,PetscInt,PetscInt,PetscInt*,PetscBool*);

 67: PETSC_EXTERN PetscErrorCode ISGetIndices(IS,const PetscInt *[]);
 68: PETSC_EXTERN PetscErrorCode ISRestoreIndices(IS,const PetscInt *[]);
 69: PETSC_EXTERN PetscErrorCode ISGetTotalIndices(IS,const PetscInt *[]);
 70: PETSC_EXTERN PetscErrorCode ISRestoreTotalIndices(IS,const PetscInt *[]);
 71: PETSC_EXTERN PetscErrorCode ISGetNonlocalIndices(IS,const PetscInt *[]);
 72: PETSC_EXTERN PetscErrorCode ISRestoreNonlocalIndices(IS,const PetscInt *[]);
 73: PETSC_EXTERN PetscErrorCode ISGetNonlocalIS(IS, IS *is);
 74: PETSC_EXTERN PetscErrorCode ISRestoreNonlocalIS(IS, IS *is);
 75: PETSC_EXTERN PetscErrorCode ISGetSize(IS,PetscInt *);
 76: PETSC_EXTERN PetscErrorCode ISGetLocalSize(IS,PetscInt *);
 77: PETSC_EXTERN PetscErrorCode ISInvertPermutation(IS,PetscInt,IS*);
 78: PETSC_EXTERN PetscErrorCode ISView(IS,PetscViewer);
 79: PETSC_EXTERN PetscErrorCode ISEqual(IS,IS,PetscBool  *);
 80: PETSC_EXTERN PetscErrorCode ISSort(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*);

 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);

 94: PETSC_EXTERN PetscErrorCode ISStrideGetInfo(IS,PetscInt *,PetscInt*);

 96: PETSC_EXTERN PetscErrorCode ISToGeneral(IS);

 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*);

108: /* --------------------------------------------------------------------------*/
109: PETSC_EXTERN PetscClassId IS_LTOGM_CLASSID;

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.

116:    Level: intermediate

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.

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.

126: .seealso:  ISLocalToGlobalMappingCreate()
127: S*/
128: typedef struct _p_ISLocalToGlobalMapping* ISLocalToGlobalMapping;

130: /*E
131:     ISGlobalToLocalMappingType - Indicates if missing global indices are

133:    IS_GTOLM_MASK - missing global indices are replaced with -1
134:    IS_GTOLM_DROP - missing global indices are dropped

136:    Level: beginner

138: .seealso: ISGlobalToLocalMappingApply()

140: E*/
141: typedef enum {IS_GTOLM_MASK,IS_GTOLM_DROP} ISGlobalToLocalMappingType;

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 ISLocalToGlobalMappingApplyIS(ISLocalToGlobalMapping,IS,IS*);
149: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingApply(ISLocalToGlobalMapping,PetscInt,const PetscInt[],PetscInt[]);
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[]);

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

166:     Level: beginner

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

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*[]);

183: /*S
184:      ISColoring - sets of IS's that define a coloring
185:               of the underlying indices

187:    Level: intermediate

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.

194:     Developer Note: this is not a PetscObject

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;

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 ISColoringGetIS(ISColoring,PetscInt*,IS*[]);
213: PETSC_EXTERN PetscErrorCode ISColoringRestoreIS(ISColoring,IS*[]);
214: PETSC_EXTERN PetscErrorCode ISColoringReference(ISColoring);
215: PETSC_EXTERN PetscErrorCode ISColoringSetType(ISColoring,ISColoringType);


218: /* --------------------------------------------------------------------------*/

220: PETSC_EXTERN PetscErrorCode ISPartitioningToNumbering(IS,IS*);
221: PETSC_EXTERN PetscErrorCode ISPartitioningCount(IS,PetscInt,PetscInt[]);

223: PETSC_EXTERN PetscErrorCode ISCompressIndicesGeneral(PetscInt,PetscInt,PetscInt,PetscInt,const IS[],IS[]);
224: PETSC_EXTERN PetscErrorCode ISCompressIndicesSorted(PetscInt,PetscInt,PetscInt,const IS[],IS[]);
225: PETSC_EXTERN PetscErrorCode ISExpandIndicesGeneral(PetscInt,PetscInt,PetscInt,PetscInt,const IS[],IS[]);

227: /*S
228:      PetscLayout - defines layout of vectors and matrices across processes (which rows are owned by which processes)

230:    Level: developer


233: .seealso:  PetscLayoutCreate(), PetscLayoutDestroy()
234: S*/
235: typedef struct _n_PetscLayout* PetscLayout;
236: struct _n_PetscLayout{
237:   MPI_Comm               comm;
238:   PetscInt               n,N;         /* local, global vector size */
239:   PetscInt               rstart,rend; /* local start, local end + 1 */
240:   PetscInt               *range;      /* the offset of each processor */
241:   PetscInt               bs;          /* number of elements in each block (generally for multi-component problems) Do NOT multiply above numbers by bs */
242:   PetscInt               refcnt;      /* MPI Vecs obtained with VecDuplicate() and from MatGetVecs() reuse map of input object */
243:   ISLocalToGlobalMapping mapping;     /* mapping used in Vec/MatSetValuesLocal() */
244:   ISLocalToGlobalMapping bmapping;    /* mapping used in Vec/MatSetValuesBlockedLocal() */
245:   PetscInt               *trstarts;   /* local start for each thread */
246: };

248: PETSC_EXTERN PetscErrorCode PetscLayoutCreate(MPI_Comm,PetscLayout*);
249: PETSC_EXTERN PetscErrorCode PetscLayoutSetUp(PetscLayout);
250: PETSC_EXTERN PetscErrorCode PetscLayoutDestroy(PetscLayout*);
251: PETSC_EXTERN PetscErrorCode PetscLayoutDuplicate(PetscLayout,PetscLayout*);
252: PETSC_EXTERN PetscErrorCode PetscLayoutReference(PetscLayout,PetscLayout*);
253: PETSC_EXTERN PetscErrorCode PetscLayoutSetLocalSize(PetscLayout,PetscInt);
254: PETSC_EXTERN PetscErrorCode PetscLayoutGetLocalSize(PetscLayout,PetscInt *);
255: PETSC_EXTERN PetscErrorCode PetscLayoutSetSize(PetscLayout,PetscInt);
256: PETSC_EXTERN PetscErrorCode PetscLayoutGetSize(PetscLayout,PetscInt *);
257: PETSC_EXTERN PetscErrorCode PetscLayoutSetBlockSize(PetscLayout,PetscInt);
258: PETSC_EXTERN PetscErrorCode PetscLayoutGetBlockSize(PetscLayout,PetscInt*);
259: PETSC_EXTERN PetscErrorCode PetscLayoutGetRange(PetscLayout,PetscInt *,PetscInt *);
260: PETSC_EXTERN PetscErrorCode PetscLayoutGetRanges(PetscLayout,const PetscInt *[]);
261: PETSC_EXTERN PetscErrorCode PetscLayoutSetISLocalToGlobalMapping(PetscLayout,ISLocalToGlobalMapping);
262: PETSC_EXTERN PetscErrorCode PetscLayoutSetISLocalToGlobalMappingBlock(PetscLayout,ISLocalToGlobalMapping);
263: PETSC_EXTERN PetscErrorCode PetscSFSetGraphLayout(PetscSF,PetscLayout,PetscInt,const PetscInt*,PetscCopyMode,const PetscInt*);

267: /*@C
268:      PetscLayoutFindOwner - Find the owning rank for a global index

270:     Not Collective

272:    Input Parameters:
273: +    map - the layout
274: -    idx - global index to find the owner of

276:    Output Parameter:
277: .    owner - the owning rank

279:    Level: developer

281:     Fortran Notes:
282:       Not available from Fortran

284: @*/
285: PETSC_STATIC_INLINE PetscErrorCode PetscLayoutFindOwner(PetscLayout map,PetscInt idx,PetscInt *owner)
286: {
288:   PetscMPIInt    lo = 0,hi,t;

291:   *owner = -1;                  /* GCC erroneously issues warning about possibly uninitialized use when error condition */
292:   if (!((map->n >= 0) && (map->N >= 0) && (map->range))) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"PetscLayoutSetUp() must be called first");
293:   if (idx < 0 || idx > map->N) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Index %D is out of range",idx);
294:   MPI_Comm_size(map->comm,&hi);
295:   while (hi - lo > 1) {
296:     t = lo + (hi - lo) / 2;
297:     if (idx < map->range[t]) hi = t;
298:     else                     lo = t;
299:   }
300:   *owner = lo;
301:   return(0);
302: }

306: /*@C
307:      PetscLayoutFindOwnerIndex - Find the owning rank and the local index for a global index

309:     Not Collective

311:    Input Parameters:
312: +    map   - the layout
313: -    idx   - global index to find the owner of

315:    Output Parameter:
316: +    owner - the owning rank
317: -    lidx  - local index used by the owner for idx

319:    Level: developer

321:     Fortran Notes:
322:       Not available from Fortran

324: @*/
325: PETSC_STATIC_INLINE PetscErrorCode PetscLayoutFindOwnerIndex(PetscLayout map,PetscInt idx,PetscInt *owner, PetscInt *lidx)
326: {
328:   PetscMPIInt    lo = 0,hi,t;

331:   if (!((map->n >= 0) && (map->N >= 0) && (map->range))) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"PetscLayoutSetUp() must be called first");
332:   if (idx < 0 || idx > map->N) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Index %D is out of range",idx);
333:   MPI_Comm_size(map->comm,&hi);
334:   while (hi - lo > 1) {
335:     t = lo + (hi - lo) / 2;
336:     if (idx < map->range[t]) hi = t;
337:     else                     lo = t;
338:   }
339:   *owner = lo;
340:   *lidx  = idx-map->range[lo];
341:   return(0);
342: }

344: PETSC_EXTERN PetscClassId PETSC_SECTION_CLASSID;

346: /*S
347:   PetscSection - Mapping from integers in a designated range to contiguous sets of integers.

349:   In contrast to IS, which maps from integers to single integers, the range of a PetscSection is in the space of
350:   contiguous sets of integers. These ranges are frequently interpreted as domains of other array-like objects,
351:   especially other PetscSections, Vecs, and ISs. The domain is set with PetscSectionSetChart() and does not need to
352:   start at 0. For each point in the domain of a PetscSection, the output set is represented through an offset and a
353:   count, which are set using PetscSectionSetOffset() and PetscSectionSetDof() respectively. Lookup is typically using
354:   accessors or routines like VecGetValuesSection().

356:   Level: developer

358: .seealso:  PetscSectionCreate(), PetscSectionDestroy()
359: S*/
360: typedef struct _p_PetscSection *PetscSection;
361: PETSC_EXTERN PetscErrorCode PetscSectionCreate(MPI_Comm,PetscSection*);
362: PETSC_EXTERN PetscErrorCode PetscSectionClone(PetscSection, PetscSection*);
363: PETSC_EXTERN PetscErrorCode PetscSectionGetNumFields(PetscSection, PetscInt *);
364: PETSC_EXTERN PetscErrorCode PetscSectionSetNumFields(PetscSection, PetscInt);
365: PETSC_EXTERN PetscErrorCode PetscSectionGetFieldName(PetscSection, PetscInt, const char *[]);
366: PETSC_EXTERN PetscErrorCode PetscSectionSetFieldName(PetscSection, PetscInt, const char []);
367: PETSC_EXTERN PetscErrorCode PetscSectionGetFieldComponents(PetscSection, PetscInt, PetscInt *);
368: PETSC_EXTERN PetscErrorCode PetscSectionSetFieldComponents(PetscSection, PetscInt, PetscInt);
369: PETSC_EXTERN PetscErrorCode PetscSectionGetChart(PetscSection, PetscInt *, PetscInt *);
370: PETSC_EXTERN PetscErrorCode PetscSectionSetChart(PetscSection, PetscInt, PetscInt);
371: PETSC_EXTERN PetscErrorCode PetscSectionGetDof(PetscSection, PetscInt, PetscInt*);
372: PETSC_EXTERN PetscErrorCode PetscSectionSetDof(PetscSection, PetscInt, PetscInt);
373: PETSC_EXTERN PetscErrorCode PetscSectionAddDof(PetscSection, PetscInt, PetscInt);
374: PETSC_EXTERN PetscErrorCode PetscSectionGetFieldDof(PetscSection, PetscInt, PetscInt, PetscInt*);
375: PETSC_EXTERN PetscErrorCode PetscSectionSetFieldDof(PetscSection, PetscInt, PetscInt, PetscInt);
376: PETSC_EXTERN PetscErrorCode PetscSectionAddFieldDof(PetscSection, PetscInt, PetscInt, PetscInt);
377: PETSC_EXTERN PetscErrorCode PetscSectionGetConstraintDof(PetscSection, PetscInt, PetscInt*);
378: PETSC_EXTERN PetscErrorCode PetscSectionSetConstraintDof(PetscSection, PetscInt, PetscInt);
379: PETSC_EXTERN PetscErrorCode PetscSectionAddConstraintDof(PetscSection, PetscInt, PetscInt);
380: PETSC_EXTERN PetscErrorCode PetscSectionGetFieldConstraintDof(PetscSection, PetscInt, PetscInt, PetscInt*);
381: PETSC_EXTERN PetscErrorCode PetscSectionSetFieldConstraintDof(PetscSection, PetscInt, PetscInt, PetscInt);
382: PETSC_EXTERN PetscErrorCode PetscSectionAddFieldConstraintDof(PetscSection, PetscInt, PetscInt, PetscInt);
383: PETSC_EXTERN PetscErrorCode PetscSectionGetConstraintIndices(PetscSection, PetscInt, const PetscInt**);
384: PETSC_EXTERN PetscErrorCode PetscSectionSetConstraintIndices(PetscSection, PetscInt, const PetscInt*);
385: PETSC_EXTERN PetscErrorCode PetscSectionGetFieldConstraintIndices(PetscSection, PetscInt, PetscInt, const PetscInt**);
386: PETSC_EXTERN PetscErrorCode PetscSectionSetFieldConstraintIndices(PetscSection, PetscInt, PetscInt, const PetscInt*);
387: PETSC_EXTERN PetscErrorCode PetscSectionSetUpBC(PetscSection);
388: PETSC_EXTERN PetscErrorCode PetscSectionSetUp(PetscSection);
389: PETSC_EXTERN PetscErrorCode PetscSectionGetMaxDof(PetscSection, PetscInt*);
390: PETSC_EXTERN PetscErrorCode PetscSectionGetStorageSize(PetscSection, PetscInt*);
391: PETSC_EXTERN PetscErrorCode PetscSectionGetConstrainedStorageSize(PetscSection, PetscInt*);
392: PETSC_EXTERN PetscErrorCode PetscSectionGetOffset(PetscSection, PetscInt, PetscInt*);
393: PETSC_EXTERN PetscErrorCode PetscSectionSetOffset(PetscSection, PetscInt, PetscInt);
394: PETSC_EXTERN PetscErrorCode PetscSectionGetFieldOffset(PetscSection, PetscInt, PetscInt, PetscInt*);
395: PETSC_EXTERN PetscErrorCode PetscSectionSetFieldOffset(PetscSection, PetscInt, PetscInt, PetscInt);
396: PETSC_EXTERN PetscErrorCode PetscSectionGetOffsetRange(PetscSection, PetscInt *, PetscInt *);
397: PETSC_EXTERN PetscErrorCode PetscSectionView(PetscSection, PetscViewer);
398: PETSC_EXTERN PetscErrorCode PetscSectionReset(PetscSection);
399: PETSC_EXTERN PetscErrorCode PetscSectionDestroy(PetscSection*);
400: PETSC_EXTERN PetscErrorCode PetscSectionCreateGlobalSection(PetscSection, PetscSF, PetscBool, PetscSection *);
401: PETSC_EXTERN PetscErrorCode PetscSectionCreateGlobalSectionCensored(PetscSection, PetscSF, PetscBool, PetscInt, const PetscInt [], PetscSection *);
402: PETSC_EXTERN PetscErrorCode PetscSectionCreateSubsection(PetscSection, PetscInt, PetscInt [], PetscSection *);
403: PETSC_EXTERN PetscErrorCode PetscSectionCreateSubmeshSection(PetscSection, IS, PetscSection *);
404: PETSC_EXTERN PetscErrorCode PetscSectionGetPointLayout(MPI_Comm, PetscSection, PetscLayout *);
405: PETSC_EXTERN PetscErrorCode PetscSectionGetValueLayout(MPI_Comm, PetscSection, PetscLayout *);

407: /* PetscSF support */
408: PETSC_EXTERN PetscErrorCode PetscSFConvertPartition(PetscSF, PetscSection, IS, ISLocalToGlobalMapping *, PetscSF *);
409: PETSC_EXTERN PetscErrorCode PetscSFCreateRemoteOffsets(PetscSF, PetscSection, PetscSection, PetscInt **);
410: PETSC_EXTERN PetscErrorCode PetscSFDistributeSection(PetscSF, PetscSection, PetscInt **, PetscSection);
411: PETSC_EXTERN PetscErrorCode PetscSFCreateSectionSF(PetscSF, PetscSection, PetscInt [], PetscSection, PetscSF *);

413: /* Reset __FUNCT__ in case the user does not define it themselves */

417: #endif