Actual source code: petscis.h
petsc-3.11.4 2019-09-28
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 <petscistypes.h>
11: #define IS_FILE_CLASSID 1211218
12: PETSC_EXTERN PetscClassId IS_CLASSID;
14: PETSC_EXTERN PetscErrorCode ISInitializePackage(void);
16: /*J
17: ISType - String with the name of a PETSc index set type
19: Level: beginner
21: .seealso: ISSetType(), IS, ISCreate(), ISRegister()
22: J*/
23: typedef const char* ISType;
24: #define ISGENERAL "general"
25: #define ISSTRIDE "stride"
26: #define ISBLOCK "block"
28: /* Dynamic creation and loading functions */
29: PETSC_EXTERN PetscFunctionList ISList;
30: PETSC_EXTERN PetscErrorCode ISSetType(IS, ISType);
31: PETSC_EXTERN PetscErrorCode ISGetType(IS, ISType *);
32: PETSC_EXTERN PetscErrorCode ISRegister(const char[],PetscErrorCode (*)(IS));
33: PETSC_EXTERN PetscErrorCode ISCreate(MPI_Comm,IS*);
35: /*
36: Default index set data structures that PETSc provides.
37: */
38: PETSC_EXTERN PetscErrorCode ISCreateGeneral(MPI_Comm,PetscInt,const PetscInt[],PetscCopyMode,IS *);
39: PETSC_EXTERN PetscErrorCode ISGeneralSetIndices(IS,PetscInt,const PetscInt[],PetscCopyMode);
40: PETSC_EXTERN PetscErrorCode ISCreateBlock(MPI_Comm,PetscInt,PetscInt,const PetscInt[],PetscCopyMode,IS *);
41: PETSC_EXTERN PetscErrorCode ISBlockSetIndices(IS,PetscInt,PetscInt,const PetscInt[],PetscCopyMode);
42: PETSC_EXTERN PetscErrorCode ISCreateStride(MPI_Comm,PetscInt,PetscInt,PetscInt,IS *);
43: PETSC_EXTERN PetscErrorCode ISStrideSetStride(IS,PetscInt,PetscInt,PetscInt);
45: PETSC_EXTERN PetscErrorCode ISDestroy(IS*);
46: PETSC_EXTERN PetscErrorCode ISSetPermutation(IS);
47: PETSC_EXTERN PetscErrorCode ISPermutation(IS,PetscBool *);
48: PETSC_EXTERN PetscErrorCode ISSetIdentity(IS);
49: PETSC_EXTERN PetscErrorCode ISIdentity(IS,PetscBool *);
50: PETSC_EXTERN PetscErrorCode ISContiguousLocal(IS,PetscInt,PetscInt,PetscInt*,PetscBool*);
52: PETSC_EXTERN PetscErrorCode ISGetIndices(IS,const PetscInt *[]);
53: PETSC_EXTERN PetscErrorCode ISRestoreIndices(IS,const PetscInt *[]);
54: PETSC_EXTERN PetscErrorCode ISGetTotalIndices(IS,const PetscInt *[]);
55: PETSC_EXTERN PetscErrorCode ISRestoreTotalIndices(IS,const PetscInt *[]);
56: PETSC_EXTERN PetscErrorCode ISGetNonlocalIndices(IS,const PetscInt *[]);
57: PETSC_EXTERN PetscErrorCode ISRestoreNonlocalIndices(IS,const PetscInt *[]);
58: PETSC_EXTERN PetscErrorCode ISGetNonlocalIS(IS, IS *is);
59: PETSC_EXTERN PetscErrorCode ISRestoreNonlocalIS(IS, IS *is);
60: PETSC_EXTERN PetscErrorCode ISGetSize(IS,PetscInt *);
61: PETSC_EXTERN PetscErrorCode ISGetLocalSize(IS,PetscInt *);
62: PETSC_EXTERN PetscErrorCode ISInvertPermutation(IS,PetscInt,IS*);
63: PETSC_EXTERN PetscErrorCode ISView(IS,PetscViewer);
64: PETSC_STATIC_INLINE PetscErrorCode ISViewFromOptions(IS A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
65: PETSC_EXTERN PetscErrorCode ISLoad(IS,PetscViewer);
66: PETSC_EXTERN PetscErrorCode ISEqual(IS,IS,PetscBool *);
67: PETSC_EXTERN PetscErrorCode ISEqualUnsorted(IS,IS,PetscBool *);
68: PETSC_EXTERN PetscErrorCode ISSort(IS);
69: PETSC_EXTERN PetscErrorCode ISSortRemoveDups(IS);
70: PETSC_EXTERN PetscErrorCode ISSorted(IS,PetscBool *);
71: PETSC_EXTERN PetscErrorCode ISDifference(IS,IS,IS*);
72: PETSC_EXTERN PetscErrorCode ISSum(IS,IS,IS*);
73: PETSC_EXTERN PetscErrorCode ISExpand(IS,IS,IS*);
74: PETSC_EXTERN PetscErrorCode ISIntersect(IS,IS,IS*);
75: PETSC_EXTERN PetscErrorCode ISGetMinMax(IS,PetscInt*,PetscInt*);
77: PETSC_EXTERN PetscErrorCode ISLocate(IS,PetscInt,PetscInt*);
78: PETSC_EXTERN PetscErrorCode ISGetPointRange(IS,PetscInt*,PetscInt*,const PetscInt**);
79: PETSC_EXTERN PetscErrorCode ISRestorePointRange(IS,PetscInt*,PetscInt*,const PetscInt**);
80: PETSC_EXTERN PetscErrorCode ISGetPointSubrange(IS,PetscInt,PetscInt,const PetscInt*);
82: PETSC_EXTERN PetscErrorCode ISBlockGetIndices(IS,const PetscInt *[]);
83: PETSC_EXTERN PetscErrorCode ISBlockRestoreIndices(IS,const PetscInt *[]);
84: PETSC_EXTERN PetscErrorCode ISBlockGetLocalSize(IS,PetscInt *);
85: PETSC_EXTERN PetscErrorCode ISBlockGetSize(IS,PetscInt *);
86: PETSC_EXTERN PetscErrorCode ISGetBlockSize(IS,PetscInt*);
87: PETSC_EXTERN PetscErrorCode ISSetBlockSize(IS,PetscInt);
89: PETSC_EXTERN PetscErrorCode ISStrideGetInfo(IS,PetscInt *,PetscInt*);
91: PETSC_EXTERN PetscErrorCode ISToGeneral(IS);
93: PETSC_EXTERN PetscErrorCode ISDuplicate(IS,IS*);
94: PETSC_EXTERN PetscErrorCode ISCopy(IS,IS);
95: PETSC_EXTERN PetscErrorCode ISAllGather(IS,IS*);
96: PETSC_EXTERN PetscErrorCode ISComplement(IS,PetscInt,PetscInt,IS*);
97: PETSC_EXTERN PetscErrorCode ISConcatenate(MPI_Comm,PetscInt,const IS[],IS*);
98: PETSC_EXTERN PetscErrorCode ISListToPair(MPI_Comm,PetscInt, IS[],IS*,IS*);
99: PETSC_EXTERN PetscErrorCode ISPairToList(IS,IS,PetscInt*, IS *[]);
100: PETSC_EXTERN PetscErrorCode ISEmbed(IS,IS,PetscBool,IS*);
101: PETSC_EXTERN PetscErrorCode ISSortPermutation(IS,PetscBool,IS*);
102: PETSC_EXTERN PetscErrorCode ISOnComm(IS,MPI_Comm,PetscCopyMode,IS*);
103: PETSC_EXTERN PetscErrorCode ISRenumber(IS,IS,PetscInt*,IS*);
104: PETSC_EXTERN PetscErrorCode ISCreateSubIS(IS,IS,IS*);
106: /* --------------------------------------------------------------------------*/
107: PETSC_EXTERN PetscClassId IS_LTOGM_CLASSID;
109: /*E
110: ISGlobalToLocalMappingMode - Indicates if missing global indices are
112: IS_GTOLM_MASK - missing global indices are replaced with -1
113: IS_GTOLM_DROP - missing global indices are dropped
115: Level: beginner
117: .seealso: ISGlobalToLocalMappingApplyBlock(), ISGlobalToLocalMappingApply()
119: E*/
120: typedef enum {IS_GTOLM_MASK,IS_GTOLM_DROP} ISGlobalToLocalMappingMode;
122: /*J
123: ISLocalToGlobalMappingType - String with the name of a mapping method
125: Level: beginner
127: .seealso: ISLocalToGlobalMappingSetType(), ISLocalToGlobalSetFromOptions()
128: J*/
129: typedef const char* ISLocalToGlobalMappingType;
130: #define ISLOCALTOGLOBALMAPPINGBASIC "basic"
131: #define ISLOCALTOGLOBALMAPPINGHASH "hash"
133: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingSetType(ISLocalToGlobalMapping,ISLocalToGlobalMappingType);
134: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRegister(const char[],PetscErrorCode (*)(ISLocalToGlobalMapping));
135: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRegisterAll(void);
136: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingCreate(MPI_Comm,PetscInt,PetscInt,const PetscInt[],PetscCopyMode,ISLocalToGlobalMapping*);
137: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingCreateIS(IS,ISLocalToGlobalMapping *);
138: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingCreateSF(PetscSF,PetscInt,ISLocalToGlobalMapping*);
139: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingSetFromOptions(ISLocalToGlobalMapping);
140: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingSetUp(ISLocalToGlobalMapping);
141: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingView(ISLocalToGlobalMapping,PetscViewer);
142: PETSC_STATIC_INLINE PetscErrorCode ISLocalToGlobalMappingViewFromOptions(ISLocalToGlobalMapping A,PetscObject B,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,B,name);}
144: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingDestroy(ISLocalToGlobalMapping*);
145: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingApply(ISLocalToGlobalMapping,PetscInt,const PetscInt[],PetscInt[]);
146: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingApplyBlock(ISLocalToGlobalMapping,PetscInt,const PetscInt[],PetscInt[]);
147: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingApplyIS(ISLocalToGlobalMapping,IS,IS*);
148: PETSC_EXTERN PetscErrorCode ISGlobalToLocalMappingApply(ISLocalToGlobalMapping,ISGlobalToLocalMappingMode,PetscInt,const PetscInt[],PetscInt*,PetscInt[]);
149: PETSC_EXTERN PetscErrorCode ISGlobalToLocalMappingApplyBlock(ISLocalToGlobalMapping,ISGlobalToLocalMappingMode,PetscInt,const PetscInt[],PetscInt*,PetscInt[]);
150: PETSC_EXTERN PetscErrorCode ISGlobalToLocalMappingApplyIS(ISLocalToGlobalMapping,ISGlobalToLocalMappingMode,IS,IS*);
151: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetSize(ISLocalToGlobalMapping,PetscInt*);
152: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetNodeInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt**[]);
153: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreNodeInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt**[]);
154: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt*[],PetscInt**[]);
155: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt*[],PetscInt**[]);
156: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetBlockInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt*[],PetscInt**[]);
157: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreBlockInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt*[],PetscInt**[]);
158: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetIndices(ISLocalToGlobalMapping,const PetscInt**);
159: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreIndices(ISLocalToGlobalMapping,const PetscInt**);
160: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetBlockIndices(ISLocalToGlobalMapping,const PetscInt**);
161: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreBlockIndices(ISLocalToGlobalMapping,const PetscInt**);
162: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingConcatenate(MPI_Comm,PetscInt,const ISLocalToGlobalMapping[],ISLocalToGlobalMapping*);
163: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetBlockSize(ISLocalToGlobalMapping,PetscInt*);
164: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingSetBlockSize(ISLocalToGlobalMapping,PetscInt);
165: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingDuplicate(ISLocalToGlobalMapping,ISLocalToGlobalMapping*);
168: /* --------------------------------------------------------------------------*/
169: /*E
170: ISColoringType - determines if the coloring is for the entire parallel grid/graph/matrix
171: or for just the local ghosted portion
173: Level: beginner
175: $ IS_COLORING_GLOBAL - does not include the colors for ghost points, this is used when the function
176: $ is called synchronously in parallel. This requires generating a "parallel coloring".
177: $ IS_COLORING_LOCAL - includes colors for ghost points, this is used when the function can be called
178: $ separately on individual processes with the ghost points already filled in. Does not
179: $ require a "parallel coloring", rather each process colors its local + ghost part.
180: $ Using this can result in much less parallel communication. Currently only works
181: $ with DMDA and if you call MatFDColoringSetFunction() with the local function.
183: .seealso: DMCreateColoring()
184: E*/
185: typedef enum {IS_COLORING_GLOBAL,IS_COLORING_LOCAL} ISColoringType;
186: PETSC_EXTERN const char *const ISColoringTypes[];
187: typedef unsigned PETSC_IS_COLOR_VALUE_TYPE ISColoringValue;
188: PETSC_EXTERN PetscErrorCode ISAllGatherColors(MPI_Comm,PetscInt,ISColoringValue*,PetscInt*,ISColoringValue*[]);
190: PETSC_EXTERN PetscErrorCode ISColoringCreate(MPI_Comm,PetscInt,PetscInt,const ISColoringValue[],PetscCopyMode,ISColoring*);
191: PETSC_EXTERN PetscErrorCode ISColoringDestroy(ISColoring*);
192: PETSC_EXTERN PetscErrorCode ISColoringView(ISColoring,PetscViewer);
193: PETSC_EXTERN PetscErrorCode ISColoringViewFromOptions(ISColoring,PetscObject,const char[]);
194: PETSC_EXTERN PetscErrorCode ISColoringGetIS(ISColoring,PetscInt*,IS*[]);
195: PETSC_EXTERN PetscErrorCode ISColoringRestoreIS(ISColoring,IS*[]);
196: PETSC_EXTERN PetscErrorCode ISColoringReference(ISColoring);
197: PETSC_EXTERN PetscErrorCode ISColoringSetType(ISColoring,ISColoringType);
200: /* --------------------------------------------------------------------------*/
201: PETSC_EXTERN PetscErrorCode ISBuildTwoSided(IS,IS,IS*);
202: PETSC_EXTERN PetscErrorCode ISPartitioningToNumbering(IS,IS*);
203: PETSC_EXTERN PetscErrorCode ISPartitioningCount(IS,PetscInt,PetscInt[]);
205: PETSC_EXTERN PetscErrorCode ISCompressIndicesGeneral(PetscInt,PetscInt,PetscInt,PetscInt,const IS[],IS[]);
206: PETSC_EXTERN PetscErrorCode ISCompressIndicesSorted(PetscInt,PetscInt,PetscInt,const IS[],IS[]);
207: PETSC_EXTERN PetscErrorCode ISExpandIndicesGeneral(PetscInt,PetscInt,PetscInt,PetscInt,const IS[],IS[]);
210: struct _n_PetscLayout{
211: MPI_Comm comm;
212: PetscInt n,N; /* local, global vector size */
213: PetscInt rstart,rend; /* local start, local end + 1 */
214: PetscInt *range; /* the offset of each processor */
215: PetscInt bs; /* number of elements in each block (generally for multi-component
216: * problems). Defaults to -1 and can be arbitrarily lazy so always use
217: * PetscAbs(map->bs) when accessing directly and expecting result to be
218: * positive. Do NOT multiply above numbers by bs */
219: PetscInt refcnt; /* MPI Vecs obtained with VecDuplicate() and from MatCreateVecs() reuse map of input object */
220: ISLocalToGlobalMapping mapping; /* mapping used in Vec/MatSetValuesLocal() */
221: };
223: /*@C
224: PetscLayoutFindOwner - Find the owning rank for a global index
226: Not Collective
228: Input Parameters:
229: + map - the layout
230: - idx - global index to find the owner of
232: Output Parameter:
233: . owner - the owning rank
235: Level: developer
237: Fortran Notes:
238: Not available from Fortran
240: @*/
241: PETSC_STATIC_INLINE PetscErrorCode PetscLayoutFindOwner(PetscLayout map,PetscInt idx,PetscInt *owner)
242: {
244: PetscMPIInt lo = 0,hi,t;
247: *owner = -1; /* GCC erroneously issues warning about possibly uninitialized use when error condition */
248: if (!((map->n >= 0) && (map->N >= 0) && (map->range))) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"PetscLayoutSetUp() must be called first");
249: if (idx < 0 || idx > map->N) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Index %D is out of range",idx);
250: MPI_Comm_size(map->comm,&hi);
251: while (hi - lo > 1) {
252: t = lo + (hi - lo) / 2;
253: if (idx < map->range[t]) hi = t;
254: else lo = t;
255: }
256: *owner = lo;
257: return(0);
258: }
260: /*@C
261: PetscLayoutFindOwnerIndex - Find the owning rank and the local index for a global index
263: Not Collective
265: Input Parameters:
266: + map - the layout
267: - idx - global index to find the owner of
269: Output Parameter:
270: + owner - the owning rank
271: - lidx - local index used by the owner for idx
273: Level: developer
275: Fortran Notes:
276: Not available from Fortran
278: @*/
279: PETSC_STATIC_INLINE PetscErrorCode PetscLayoutFindOwnerIndex(PetscLayout map,PetscInt idx,PetscInt *owner, PetscInt *lidx)
280: {
282: PetscMPIInt lo = 0,hi,t;
285: if (!((map->n >= 0) && (map->N >= 0) && (map->range))) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"PetscLayoutSetUp() must be called first");
286: if (idx < 0 || idx > map->N) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Index %D is out of range",idx);
287: MPI_Comm_size(map->comm,&hi);
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: if (owner) *owner = lo;
294: if (lidx) *lidx = idx-map->range[lo];
295: return(0);
296: }
298: PETSC_EXTERN PetscErrorCode PetscLayoutCreate(MPI_Comm,PetscLayout*);
299: PETSC_EXTERN PetscErrorCode PetscLayoutSetUp(PetscLayout);
300: PETSC_EXTERN PetscErrorCode PetscLayoutDestroy(PetscLayout*);
301: PETSC_EXTERN PetscErrorCode PetscLayoutDuplicate(PetscLayout,PetscLayout*);
302: PETSC_EXTERN PetscErrorCode PetscLayoutReference(PetscLayout,PetscLayout*);
303: PETSC_EXTERN PetscErrorCode PetscLayoutSetLocalSize(PetscLayout,PetscInt);
304: PETSC_EXTERN PetscErrorCode PetscLayoutGetLocalSize(PetscLayout,PetscInt *);
305: PETSC_EXTERN PetscErrorCode PetscLayoutSetSize(PetscLayout,PetscInt);
306: PETSC_EXTERN PetscErrorCode PetscLayoutGetSize(PetscLayout,PetscInt *);
307: PETSC_EXTERN PetscErrorCode PetscLayoutSetBlockSize(PetscLayout,PetscInt);
308: PETSC_EXTERN PetscErrorCode PetscLayoutGetBlockSize(PetscLayout,PetscInt*);
309: PETSC_EXTERN PetscErrorCode PetscLayoutGetRange(PetscLayout,PetscInt *,PetscInt *);
310: PETSC_EXTERN PetscErrorCode PetscLayoutGetRanges(PetscLayout,const PetscInt *[]);
311: PETSC_EXTERN PetscErrorCode PetscLayoutCompare(PetscLayout,PetscLayout,PetscBool*);
312: PETSC_EXTERN PetscErrorCode PetscLayoutSetISLocalToGlobalMapping(PetscLayout,ISLocalToGlobalMapping);
313: PETSC_EXTERN PetscErrorCode PetscSFSetGraphLayout(PetscSF,PetscLayout,PetscInt,const PetscInt*,PetscCopyMode,const PetscInt*);
316: PETSC_EXTERN PetscClassId PETSC_SECTION_CLASSID;
318: PETSC_EXTERN PetscErrorCode PetscSectionCreate(MPI_Comm,PetscSection*);
319: PETSC_EXTERN PetscErrorCode PetscSectionClone(PetscSection, PetscSection*);
320: PETSC_EXTERN PetscErrorCode PetscSectionSetFromOptions(PetscSection);
321: PETSC_EXTERN PetscErrorCode PetscSectionCopy(PetscSection, PetscSection);
322: PETSC_EXTERN PetscErrorCode PetscSectionCompare(PetscSection, PetscSection, PetscBool*);
323: PETSC_EXTERN PetscErrorCode PetscSectionGetNumFields(PetscSection, PetscInt *);
324: PETSC_EXTERN PetscErrorCode PetscSectionSetNumFields(PetscSection, PetscInt);
325: PETSC_EXTERN PetscErrorCode PetscSectionGetFieldName(PetscSection, PetscInt, const char *[]);
326: PETSC_EXTERN PetscErrorCode PetscSectionSetFieldName(PetscSection, PetscInt, const char []);
327: PETSC_EXTERN PetscErrorCode PetscSectionGetFieldComponents(PetscSection, PetscInt, PetscInt *);
328: PETSC_EXTERN PetscErrorCode PetscSectionSetFieldComponents(PetscSection, PetscInt, PetscInt);
329: PETSC_EXTERN PetscErrorCode PetscSectionGetChart(PetscSection, PetscInt *, PetscInt *);
330: PETSC_EXTERN PetscErrorCode PetscSectionSetChart(PetscSection, PetscInt, PetscInt);
331: PETSC_EXTERN PetscErrorCode PetscSectionGetPermutation(PetscSection, IS *);
332: PETSC_EXTERN PetscErrorCode PetscSectionSetPermutation(PetscSection, IS);
333: PETSC_EXTERN PetscErrorCode PetscSectionGetPointMajor(PetscSection, PetscBool *);
334: PETSC_EXTERN PetscErrorCode PetscSectionSetPointMajor(PetscSection, PetscBool);
335: PETSC_EXTERN PetscErrorCode PetscSectionGetDof(PetscSection, PetscInt, PetscInt*);
336: PETSC_EXTERN PetscErrorCode PetscSectionSetDof(PetscSection, PetscInt, PetscInt);
337: PETSC_EXTERN PetscErrorCode PetscSectionAddDof(PetscSection, PetscInt, PetscInt);
338: PETSC_EXTERN PetscErrorCode PetscSectionGetFieldDof(PetscSection, PetscInt, PetscInt, PetscInt*);
339: PETSC_EXTERN PetscErrorCode PetscSectionSetFieldDof(PetscSection, PetscInt, PetscInt, PetscInt);
340: PETSC_EXTERN PetscErrorCode PetscSectionAddFieldDof(PetscSection, PetscInt, PetscInt, PetscInt);
341: PETSC_EXTERN PetscErrorCode PetscSectionHasConstraints(PetscSection, PetscBool *);
342: PETSC_EXTERN PetscErrorCode PetscSectionGetConstraintDof(PetscSection, PetscInt, PetscInt*);
343: PETSC_EXTERN PetscErrorCode PetscSectionSetConstraintDof(PetscSection, PetscInt, PetscInt);
344: PETSC_EXTERN PetscErrorCode PetscSectionAddConstraintDof(PetscSection, PetscInt, PetscInt);
345: PETSC_EXTERN PetscErrorCode PetscSectionGetFieldConstraintDof(PetscSection, PetscInt, PetscInt, PetscInt*);
346: PETSC_EXTERN PetscErrorCode PetscSectionSetFieldConstraintDof(PetscSection, PetscInt, PetscInt, PetscInt);
347: PETSC_EXTERN PetscErrorCode PetscSectionAddFieldConstraintDof(PetscSection, PetscInt, PetscInt, PetscInt);
348: PETSC_EXTERN PetscErrorCode PetscSectionGetConstraintIndices(PetscSection, PetscInt, const PetscInt**);
349: PETSC_EXTERN PetscErrorCode PetscSectionSetConstraintIndices(PetscSection, PetscInt, const PetscInt*);
350: PETSC_EXTERN PetscErrorCode PetscSectionGetFieldConstraintIndices(PetscSection, PetscInt, PetscInt, const PetscInt**);
351: PETSC_EXTERN PetscErrorCode PetscSectionSetFieldConstraintIndices(PetscSection, PetscInt, PetscInt, const PetscInt*);
352: PETSC_EXTERN PetscErrorCode PetscSectionSetUpBC(PetscSection);
353: PETSC_EXTERN PetscErrorCode PetscSectionSetUp(PetscSection);
354: PETSC_EXTERN PetscErrorCode PetscSectionGetMaxDof(PetscSection, PetscInt*);
355: PETSC_EXTERN PetscErrorCode PetscSectionGetStorageSize(PetscSection, PetscInt*);
356: PETSC_EXTERN PetscErrorCode PetscSectionGetConstrainedStorageSize(PetscSection, PetscInt*);
357: PETSC_EXTERN PetscErrorCode PetscSectionGetOffset(PetscSection, PetscInt, PetscInt*);
358: PETSC_EXTERN PetscErrorCode PetscSectionSetOffset(PetscSection, PetscInt, PetscInt);
359: PETSC_EXTERN PetscErrorCode PetscSectionGetFieldOffset(PetscSection, PetscInt, PetscInt, PetscInt*);
360: PETSC_EXTERN PetscErrorCode PetscSectionSetFieldOffset(PetscSection, PetscInt, PetscInt, PetscInt);
361: PETSC_EXTERN PetscErrorCode PetscSectionGetOffsetRange(PetscSection, PetscInt *, PetscInt *);
362: PETSC_EXTERN PetscErrorCode PetscSectionView(PetscSection, PetscViewer);
363: PETSC_STATIC_INLINE PetscErrorCode PetscSectionViewFromOptions(PetscSection A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
364: PETSC_EXTERN PetscErrorCode PetscSectionReset(PetscSection);
365: PETSC_EXTERN PetscErrorCode PetscSectionDestroy(PetscSection*);
366: PETSC_EXTERN PetscErrorCode PetscSectionCreateGlobalSection(PetscSection, PetscSF, PetscBool, PetscBool, PetscSection *);
367: PETSC_EXTERN PetscErrorCode PetscSectionCreateGlobalSectionCensored(PetscSection, PetscSF, PetscBool, PetscInt, const PetscInt [], PetscSection *);
368: PETSC_EXTERN PetscErrorCode PetscSectionCreateSubsection(PetscSection, PetscInt, const PetscInt [], PetscSection *);
369: PETSC_EXTERN PetscErrorCode PetscSectionCreateSupersection(PetscSection[], PetscInt, PetscSection *);
370: PETSC_EXTERN PetscErrorCode PetscSectionCreateSubmeshSection(PetscSection, IS, PetscSection *);
371: PETSC_EXTERN PetscErrorCode PetscSectionGetPointLayout(MPI_Comm, PetscSection, PetscLayout *);
372: PETSC_EXTERN PetscErrorCode PetscSectionGetValueLayout(MPI_Comm, PetscSection, PetscLayout *);
373: PETSC_EXTERN PetscErrorCode PetscSectionPermute(PetscSection, IS, PetscSection *);
374: PETSC_EXTERN PetscErrorCode PetscSectionGetField(PetscSection, PetscInt, PetscSection *);
375: PETSC_EXTERN PetscErrorCode PetscSectionSetUseFieldOffsets(PetscSection, PetscBool);
376: PETSC_EXTERN PetscErrorCode PetscSectionGetUseFieldOffsets(PetscSection, PetscBool *);
377: PETSC_EXTERN PetscErrorCode PetscSectionExtractDofsFromArray(PetscSection, MPI_Datatype, const void *, IS, PetscSection *, void *[]);
379: PETSC_EXTERN PetscErrorCode PetscSectionSetClosureIndex(PetscSection, PetscObject, PetscSection, IS);
380: PETSC_EXTERN PetscErrorCode PetscSectionGetClosureIndex(PetscSection, PetscObject, PetscSection *, IS *);
381: PETSC_EXTERN PetscErrorCode PetscSectionSetClosurePermutation(PetscSection, PetscObject, IS);
382: PETSC_EXTERN PetscErrorCode PetscSectionGetClosurePermutation(PetscSection, PetscObject, IS *);
383: PETSC_EXTERN PetscErrorCode PetscSectionGetClosureInversePermutation(PetscSection, PetscObject, IS *);
385: PETSC_EXTERN PetscClassId PETSC_SECTION_SYM_CLASSID;
387: /*J
388: PetscSectionSymType - String with the name of a PetscSectionSym type.
390: Level: developer
392: Notes:
393: PetscSectionSym has no default implementation, but is used by DM in PetscSectionSymCreateLabel().
395: .seealso: PetscSectionSymSetType(), PetscSectionSym, PetscSectionSymCreate(), PetscSectionSymRegister()
396: J*/
397: typedef const char *PetscSectionSymType;
399: PETSC_EXTERN PetscFunctionList PetscSectionSymList;
400: PETSC_EXTERN PetscErrorCode PetscSectionSymSetType(PetscSectionSym, PetscSectionSymType);
401: PETSC_EXTERN PetscErrorCode PetscSectionSymGetType(PetscSectionSym, PetscSectionSymType*);
402: PETSC_EXTERN PetscErrorCode PetscSectionSymRegister(const char[],PetscErrorCode (*)(PetscSectionSym));
404: PETSC_EXTERN PetscErrorCode PetscSectionSymCreate(MPI_Comm, PetscSectionSym*);
405: PETSC_EXTERN PetscErrorCode PetscSectionSymDestroy(PetscSectionSym*);
406: PETSC_EXTERN PetscErrorCode PetscSectionSymView(PetscSectionSym,PetscViewer);
408: PETSC_EXTERN PetscErrorCode PetscSectionSetSym(PetscSection, PetscSectionSym);
409: PETSC_EXTERN PetscErrorCode PetscSectionGetSym(PetscSection, PetscSectionSym*);
410: PETSC_EXTERN PetscErrorCode PetscSectionSetFieldSym(PetscSection, PetscInt, PetscSectionSym);
411: PETSC_EXTERN PetscErrorCode PetscSectionGetFieldSym(PetscSection, PetscInt, PetscSectionSym*);
413: PETSC_EXTERN PetscErrorCode PetscSectionGetPointSyms(PetscSection, PetscInt, const PetscInt *, const PetscInt ***, const PetscScalar ***);
414: PETSC_EXTERN PetscErrorCode PetscSectionRestorePointSyms(PetscSection, PetscInt, const PetscInt *, const PetscInt ***, const PetscScalar ***);
415: PETSC_EXTERN PetscErrorCode PetscSectionGetFieldPointSyms(PetscSection, PetscInt, PetscInt, const PetscInt *, const PetscInt ***, const PetscScalar ***);
416: PETSC_EXTERN PetscErrorCode PetscSectionRestoreFieldPointSyms(PetscSection, PetscInt, PetscInt, const PetscInt *, const PetscInt ***, const PetscScalar ***);
419: /* PetscSF support */
420: PETSC_EXTERN PetscErrorCode PetscSFConvertPartition(PetscSF, PetscSection, IS, ISLocalToGlobalMapping *, PetscSF *);
421: PETSC_EXTERN PetscErrorCode PetscSFCreateRemoteOffsets(PetscSF, PetscSection, PetscSection, PetscInt **);
422: PETSC_EXTERN PetscErrorCode PetscSFDistributeSection(PetscSF, PetscSection, PetscInt **, PetscSection);
423: PETSC_EXTERN PetscErrorCode PetscSFCreateSectionSF(PetscSF, PetscSection, PetscInt [], PetscSection, PetscSF *);
425: #endif