xref: /petsc/src/vec/is/section/interface/section.c (revision dbbe0bcd3f3a8fbab5a45420dc06f8387e5764c6)
1ea844a1aSMatthew Knepley /*
2ea844a1aSMatthew Knepley    This file contains routines for basic section object implementation.
3ea844a1aSMatthew Knepley */
4ea844a1aSMatthew Knepley 
5ea844a1aSMatthew Knepley #include <petsc/private/sectionimpl.h>   /*I  "petscsection.h"   I*/
6ea844a1aSMatthew Knepley #include <petscsf.h>
7ea844a1aSMatthew Knepley 
8ea844a1aSMatthew Knepley PetscClassId PETSC_SECTION_CLASSID;
9ea844a1aSMatthew Knepley 
10ea844a1aSMatthew Knepley /*@
11ea844a1aSMatthew Knepley   PetscSectionCreate - Allocates PetscSection space and sets the map contents to the default.
12ea844a1aSMatthew Knepley 
13ea844a1aSMatthew Knepley   Collective
14ea844a1aSMatthew Knepley 
15ea844a1aSMatthew Knepley   Input Parameters:
16ea844a1aSMatthew Knepley + comm - the MPI communicator
17ea844a1aSMatthew Knepley - s    - pointer to the section
18ea844a1aSMatthew Knepley 
19ea844a1aSMatthew Knepley   Level: beginner
20ea844a1aSMatthew Knepley 
21ea844a1aSMatthew Knepley   Notes:
22ea844a1aSMatthew Knepley   Typical calling sequence
23ea844a1aSMatthew Knepley $       PetscSectionCreate(MPI_Comm,PetscSection *);
24ea844a1aSMatthew Knepley $       PetscSectionSetNumFields(PetscSection, numFields);
25ea844a1aSMatthew Knepley $       PetscSectionSetChart(PetscSection,low,high);
26ea844a1aSMatthew Knepley $       PetscSectionSetDof(PetscSection,point,numdof);
27ea844a1aSMatthew Knepley $       PetscSectionSetUp(PetscSection);
28ea844a1aSMatthew Knepley $       PetscSectionGetOffset(PetscSection,point,PetscInt *);
29ea844a1aSMatthew Knepley $       PetscSectionDestroy(PetscSection);
30ea844a1aSMatthew Knepley 
316aad120cSJose E. Roman   The PetscSection object and methods are intended to be used in the PETSc Vec and Mat implementations; it is
32ea844a1aSMatthew Knepley   recommended they not be used in user codes unless you really gain something in their use.
33ea844a1aSMatthew Knepley 
34db781477SPatrick Sanan .seealso: `PetscSection`, `PetscSectionDestroy()`
35ea844a1aSMatthew Knepley @*/
36ea844a1aSMatthew Knepley PetscErrorCode PetscSectionCreate(MPI_Comm comm, PetscSection *s)
37ea844a1aSMatthew Knepley {
38ea844a1aSMatthew Knepley   PetscFunctionBegin;
39ea844a1aSMatthew Knepley   PetscValidPointer(s,2);
409566063dSJacob Faibussowitsch   PetscCall(ISInitializePackage());
41ea844a1aSMatthew Knepley 
429566063dSJacob Faibussowitsch   PetscCall(PetscHeaderCreate(*s,PETSC_SECTION_CLASSID,"PetscSection","Section","IS",comm,PetscSectionDestroy,PetscSectionView));
43ea844a1aSMatthew Knepley 
44ea844a1aSMatthew Knepley   (*s)->pStart              = -1;
45ea844a1aSMatthew Knepley   (*s)->pEnd                = -1;
46ea844a1aSMatthew Knepley   (*s)->perm                = NULL;
47ea844a1aSMatthew Knepley   (*s)->pointMajor          = PETSC_TRUE;
4887e637c6Sksagiyam   (*s)->includesConstraints = PETSC_TRUE;
49ea844a1aSMatthew Knepley   (*s)->atlasDof            = NULL;
50ea844a1aSMatthew Knepley   (*s)->atlasOff            = NULL;
51ea844a1aSMatthew Knepley   (*s)->bc                  = NULL;
52ea844a1aSMatthew Knepley   (*s)->bcIndices           = NULL;
53ea844a1aSMatthew Knepley   (*s)->setup               = PETSC_FALSE;
54ea844a1aSMatthew Knepley   (*s)->numFields           = 0;
55ea844a1aSMatthew Knepley   (*s)->fieldNames          = NULL;
56ea844a1aSMatthew Knepley   (*s)->field               = NULL;
57ea844a1aSMatthew Knepley   (*s)->useFieldOff         = PETSC_FALSE;
58b778fa18SValeria Barra   (*s)->compNames           = NULL;
59ea844a1aSMatthew Knepley   (*s)->clObj               = NULL;
60c459fbc1SJed Brown   (*s)->clHash              = NULL;
61ea844a1aSMatthew Knepley   (*s)->clSection           = NULL;
62ea844a1aSMatthew Knepley   (*s)->clPoints            = NULL;
6369c11d05SVaclav Hapla   PetscCall(PetscSectionInvalidateMaxDof_Internal(*s));
64ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
65ea844a1aSMatthew Knepley }
66ea844a1aSMatthew Knepley 
67ea844a1aSMatthew Knepley /*@
68ea844a1aSMatthew Knepley   PetscSectionCopy - Creates a shallow (if possible) copy of the PetscSection
69ea844a1aSMatthew Knepley 
70ea844a1aSMatthew Knepley   Collective
71ea844a1aSMatthew Knepley 
72ea844a1aSMatthew Knepley   Input Parameter:
73ea844a1aSMatthew Knepley . section - the PetscSection
74ea844a1aSMatthew Knepley 
75ea844a1aSMatthew Knepley   Output Parameter:
76ea844a1aSMatthew Knepley . newSection - the copy
77ea844a1aSMatthew Knepley 
78ea844a1aSMatthew Knepley   Level: intermediate
79ea844a1aSMatthew Knepley 
80db781477SPatrick Sanan .seealso: `PetscSection`, `PetscSectionCreate()`, `PetscSectionDestroy()`
81ea844a1aSMatthew Knepley @*/
82ea844a1aSMatthew Knepley PetscErrorCode PetscSectionCopy(PetscSection section, PetscSection newSection)
83ea844a1aSMatthew Knepley {
84ea844a1aSMatthew Knepley   PetscSectionSym sym;
85ea844a1aSMatthew Knepley   IS              perm;
86b778fa18SValeria Barra   PetscInt        numFields, f, c, pStart, pEnd, p;
87ea844a1aSMatthew Knepley 
88ea844a1aSMatthew Knepley   PetscFunctionBegin;
89ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1);
90ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(newSection, PETSC_SECTION_CLASSID, 2);
919566063dSJacob Faibussowitsch   PetscCall(PetscSectionReset(newSection));
929566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetNumFields(section, &numFields));
939566063dSJacob Faibussowitsch   if (numFields) PetscCall(PetscSectionSetNumFields(newSection, numFields));
94ea844a1aSMatthew Knepley   for (f = 0; f < numFields; ++f) {
95b778fa18SValeria Barra     const char *fieldName = NULL, *compName = NULL;
96ea844a1aSMatthew Knepley     PetscInt   numComp = 0;
97ea844a1aSMatthew Knepley 
989566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldName(section, f, &fieldName));
999566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldName(newSection, f, fieldName));
1009566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldComponents(section, f, &numComp));
1019566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldComponents(newSection, f, numComp));
102b778fa18SValeria Barra     for (c = 0; c < numComp; ++c) {
1039566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetComponentName(section, f, c, &compName));
1049566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetComponentName(newSection, f, c, compName));
105b778fa18SValeria Barra     }
1069566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldSym(section, f, &sym));
1079566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldSym(newSection, f, sym));
108ea844a1aSMatthew Knepley   }
1099566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(section, &pStart, &pEnd));
1109566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(newSection, pStart, pEnd));
1119566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetPermutation(section, &perm));
1129566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetPermutation(newSection, perm));
1139566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetSym(section, &sym));
1149566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetSym(newSection, sym));
115ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
116ea844a1aSMatthew Knepley     PetscInt dof, cdof, fcdof = 0;
117ea844a1aSMatthew Knepley 
1189566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(section, p, &dof));
1199566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(newSection, p, dof));
1209566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(section, p, &cdof));
1219566063dSJacob Faibussowitsch     if (cdof) PetscCall(PetscSectionSetConstraintDof(newSection, p, cdof));
122ea844a1aSMatthew Knepley     for (f = 0; f < numFields; ++f) {
1239566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldDof(section, p, f, &dof));
1249566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldDof(newSection, p, f, dof));
125ea844a1aSMatthew Knepley       if (cdof) {
1269566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetFieldConstraintDof(section, p, f, &fcdof));
1279566063dSJacob Faibussowitsch         if (fcdof) PetscCall(PetscSectionSetFieldConstraintDof(newSection, p, f, fcdof));
128ea844a1aSMatthew Knepley       }
129ea844a1aSMatthew Knepley     }
130ea844a1aSMatthew Knepley   }
1319566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(newSection));
132ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
133ea844a1aSMatthew Knepley     PetscInt       off, cdof, fcdof = 0;
134ea844a1aSMatthew Knepley     const PetscInt *cInd;
135ea844a1aSMatthew Knepley 
136ea844a1aSMatthew Knepley     /* Must set offsets in case they do not agree with the prefix sums */
1379566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(section, p, &off));
1389566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetOffset(newSection, p, off));
1399566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(section, p, &cdof));
140ea844a1aSMatthew Knepley     if (cdof) {
1419566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetConstraintIndices(section, p, &cInd));
1429566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetConstraintIndices(newSection, p, cInd));
143ea844a1aSMatthew Knepley       for (f = 0; f < numFields; ++f) {
1449566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetFieldConstraintDof(section, p, f, &fcdof));
145ea844a1aSMatthew Knepley         if (fcdof) {
1469566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetFieldConstraintIndices(section, p, f, &cInd));
1479566063dSJacob Faibussowitsch           PetscCall(PetscSectionSetFieldConstraintIndices(newSection, p, f, cInd));
148ea844a1aSMatthew Knepley         }
149ea844a1aSMatthew Knepley       }
150ea844a1aSMatthew Knepley     }
151ea844a1aSMatthew Knepley   }
152ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
153ea844a1aSMatthew Knepley }
154ea844a1aSMatthew Knepley 
155ea844a1aSMatthew Knepley /*@
156ea844a1aSMatthew Knepley   PetscSectionClone - Creates a shallow (if possible) copy of the PetscSection
157ea844a1aSMatthew Knepley 
158ea844a1aSMatthew Knepley   Collective
159ea844a1aSMatthew Knepley 
160ea844a1aSMatthew Knepley   Input Parameter:
161ea844a1aSMatthew Knepley . section - the PetscSection
162ea844a1aSMatthew Knepley 
163ea844a1aSMatthew Knepley   Output Parameter:
164ea844a1aSMatthew Knepley . newSection - the copy
165ea844a1aSMatthew Knepley 
166ea844a1aSMatthew Knepley   Level: beginner
167ea844a1aSMatthew Knepley 
168db781477SPatrick Sanan .seealso: `PetscSection`, `PetscSectionCreate()`, `PetscSectionDestroy()`
169ea844a1aSMatthew Knepley @*/
170ea844a1aSMatthew Knepley PetscErrorCode PetscSectionClone(PetscSection section, PetscSection *newSection)
171ea844a1aSMatthew Knepley {
172ea844a1aSMatthew Knepley   PetscFunctionBegin;
173ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1);
174ea844a1aSMatthew Knepley   PetscValidPointer(newSection, 2);
1759566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject) section), newSection));
1769566063dSJacob Faibussowitsch   PetscCall(PetscSectionCopy(section, *newSection));
177ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
178ea844a1aSMatthew Knepley }
179ea844a1aSMatthew Knepley 
180ea844a1aSMatthew Knepley /*@
181ea844a1aSMatthew Knepley   PetscSectionSetFromOptions - sets parameters in a PetscSection from the options database
182ea844a1aSMatthew Knepley 
18340750d41SVaclav Hapla   Collective
184ea844a1aSMatthew Knepley 
185ea844a1aSMatthew Knepley   Input Parameter:
186ea844a1aSMatthew Knepley . section - the PetscSection
187ea844a1aSMatthew Knepley 
188ea844a1aSMatthew Knepley   Options Database:
189147403d9SBarry Smith . -petscsection_point_major - PETSC_TRUE for point-major order
190ea844a1aSMatthew Knepley 
191ea844a1aSMatthew Knepley   Level: intermediate
192ea844a1aSMatthew Knepley 
193db781477SPatrick Sanan .seealso: `PetscSection`, `PetscSectionCreate()`, `PetscSectionDestroy()`
194ea844a1aSMatthew Knepley @*/
195ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetFromOptions(PetscSection s)
196ea844a1aSMatthew Knepley {
197ea844a1aSMatthew Knepley   PetscFunctionBegin;
198ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
199d0609cedSBarry Smith   PetscObjectOptionsBegin((PetscObject) s);
2009566063dSJacob Faibussowitsch   PetscCall(PetscOptionsBool("-petscsection_point_major", "The for ordering, either point major or field major", "PetscSectionSetPointMajor", s->pointMajor, &s->pointMajor, NULL));
201ea844a1aSMatthew Knepley   /* process any options handlers added with PetscObjectAddOptionsHandler() */
202*dbbe0bcdSBarry Smith   PetscCall(PetscObjectProcessOptionsHandlers((PetscObject) s,PetscOptionsObject));
203d0609cedSBarry Smith   PetscOptionsEnd();
2049566063dSJacob Faibussowitsch   PetscCall(PetscObjectViewFromOptions((PetscObject) s, NULL, "-petscsection_view"));
205ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
206ea844a1aSMatthew Knepley }
207ea844a1aSMatthew Knepley 
208ea844a1aSMatthew Knepley /*@
209ea844a1aSMatthew Knepley   PetscSectionCompare - Compares two sections
210ea844a1aSMatthew Knepley 
21140750d41SVaclav Hapla   Collective
212ea844a1aSMatthew Knepley 
2137a7aea1fSJed Brown   Input Parameters:
214ea844a1aSMatthew Knepley + s1 - the first PetscSection
215ea844a1aSMatthew Knepley - s2 - the second PetscSection
216ea844a1aSMatthew Knepley 
217ea844a1aSMatthew Knepley   Output Parameter:
218ea844a1aSMatthew Knepley . congruent - PETSC_TRUE if the two sections are congruent, PETSC_FALSE otherwise
219ea844a1aSMatthew Knepley 
220ea844a1aSMatthew Knepley   Level: intermediate
221ea844a1aSMatthew Knepley 
222ea844a1aSMatthew Knepley   Notes:
223ea844a1aSMatthew Knepley   Field names are disregarded.
224ea844a1aSMatthew Knepley 
225db781477SPatrick Sanan .seealso: `PetscSection`, `PetscSectionCreate()`, `PetscSectionCopy()`, `PetscSectionClone()`
226ea844a1aSMatthew Knepley @*/
227ea844a1aSMatthew Knepley PetscErrorCode PetscSectionCompare(PetscSection s1, PetscSection s2, PetscBool *congruent)
228ea844a1aSMatthew Knepley {
229ea844a1aSMatthew Knepley   PetscInt pStart, pEnd, nfields, ncdof, nfcdof, p, f, n1, n2;
230ea844a1aSMatthew Knepley   const PetscInt *idx1, *idx2;
231ea844a1aSMatthew Knepley   IS perm1, perm2;
232ea844a1aSMatthew Knepley   PetscBool flg;
233ea844a1aSMatthew Knepley   PetscMPIInt mflg;
234ea844a1aSMatthew Knepley 
235ea844a1aSMatthew Knepley   PetscFunctionBegin;
236ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s1, PETSC_SECTION_CLASSID, 1);
237ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s2, PETSC_SECTION_CLASSID, 2);
238064a246eSJacob Faibussowitsch   PetscValidBoolPointer(congruent,3);
239ea844a1aSMatthew Knepley   flg = PETSC_FALSE;
240ea844a1aSMatthew Knepley 
2419566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_compare(PetscObjectComm((PetscObject)s1),PetscObjectComm((PetscObject)s2),&mflg));
242ea844a1aSMatthew Knepley   if (mflg != MPI_CONGRUENT && mflg != MPI_IDENT) {
243ea844a1aSMatthew Knepley     *congruent = PETSC_FALSE;
244ea844a1aSMatthew Knepley     PetscFunctionReturn(0);
245ea844a1aSMatthew Knepley   }
246ea844a1aSMatthew Knepley 
2479566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s1, &pStart, &pEnd));
2489566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s2, &n1, &n2));
249ea844a1aSMatthew Knepley   if (pStart != n1 || pEnd != n2) goto not_congruent;
250ea844a1aSMatthew Knepley 
2519566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetPermutation(s1, &perm1));
2529566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetPermutation(s2, &perm2));
253ea844a1aSMatthew Knepley   if (perm1 && perm2) {
2549566063dSJacob Faibussowitsch     PetscCall(ISEqual(perm1, perm2, congruent));
255ea844a1aSMatthew Knepley     if (!(*congruent)) goto not_congruent;
256ea844a1aSMatthew Knepley   } else if (perm1 != perm2) goto not_congruent;
257ea844a1aSMatthew Knepley 
258ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
2599566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(s1, p, &n1));
2609566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(s2, p, &n2));
261ea844a1aSMatthew Knepley     if (n1 != n2) goto not_congruent;
262ea844a1aSMatthew Knepley 
2639566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s1, p, &n1));
2649566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s2, p, &n2));
265ea844a1aSMatthew Knepley     if (n1 != n2) goto not_congruent;
266ea844a1aSMatthew Knepley 
2679566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s1, p, &ncdof));
2689566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s2, p, &n2));
269ea844a1aSMatthew Knepley     if (ncdof != n2) goto not_congruent;
270ea844a1aSMatthew Knepley 
2719566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintIndices(s1, p, &idx1));
2729566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintIndices(s2, p, &idx2));
2739566063dSJacob Faibussowitsch     PetscCall(PetscArraycmp(idx1, idx2, ncdof, congruent));
274ea844a1aSMatthew Knepley     if (!(*congruent)) goto not_congruent;
275ea844a1aSMatthew Knepley   }
276ea844a1aSMatthew Knepley 
2779566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetNumFields(s1, &nfields));
2789566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetNumFields(s2, &n2));
279ea844a1aSMatthew Knepley   if (nfields != n2) goto not_congruent;
280ea844a1aSMatthew Knepley 
281ea844a1aSMatthew Knepley   for (f = 0; f < nfields; ++f) {
2829566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldComponents(s1, f, &n1));
2839566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldComponents(s2, f, &n2));
284ea844a1aSMatthew Knepley     if (n1 != n2) goto not_congruent;
285ea844a1aSMatthew Knepley 
286ea844a1aSMatthew Knepley     for (p = pStart; p < pEnd; ++p) {
2879566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldOffset(s1, p, f, &n1));
2889566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldOffset(s2, p, f, &n2));
289ea844a1aSMatthew Knepley       if (n1 != n2) goto not_congruent;
290ea844a1aSMatthew Knepley 
2919566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldDof(s1, p, f, &n1));
2929566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldDof(s2, p, f, &n2));
293ea844a1aSMatthew Knepley       if (n1 != n2) goto not_congruent;
294ea844a1aSMatthew Knepley 
2959566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintDof(s1, p, f, &nfcdof));
2969566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintDof(s2, p, f, &n2));
297ea844a1aSMatthew Knepley       if (nfcdof != n2) goto not_congruent;
298ea844a1aSMatthew Knepley 
2999566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintIndices(s1, p, f, &idx1));
3009566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintIndices(s2, p, f, &idx2));
3019566063dSJacob Faibussowitsch       PetscCall(PetscArraycmp(idx1, idx2, nfcdof, congruent));
302ea844a1aSMatthew Knepley       if (!(*congruent)) goto not_congruent;
303ea844a1aSMatthew Knepley     }
304ea844a1aSMatthew Knepley   }
305ea844a1aSMatthew Knepley 
306ea844a1aSMatthew Knepley   flg = PETSC_TRUE;
307ea844a1aSMatthew Knepley not_congruent:
3081c2dc1cbSBarry Smith   PetscCall(MPIU_Allreduce(&flg,congruent,1,MPIU_BOOL,MPI_LAND,PetscObjectComm((PetscObject)s1)));
309ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
310ea844a1aSMatthew Knepley }
311ea844a1aSMatthew Knepley 
312ea844a1aSMatthew Knepley /*@
313ea844a1aSMatthew Knepley   PetscSectionGetNumFields - Returns the number of fields, or 0 if no fields were defined.
314ea844a1aSMatthew Knepley 
31540750d41SVaclav Hapla   Not Collective
316ea844a1aSMatthew Knepley 
317ea844a1aSMatthew Knepley   Input Parameter:
318ea844a1aSMatthew Knepley . s - the PetscSection
319ea844a1aSMatthew Knepley 
320ea844a1aSMatthew Knepley   Output Parameter:
321ea844a1aSMatthew Knepley . numFields - the number of fields defined, or 0 if none were defined
322ea844a1aSMatthew Knepley 
323ea844a1aSMatthew Knepley   Level: intermediate
324ea844a1aSMatthew Knepley 
325db781477SPatrick Sanan .seealso: `PetscSectionSetNumFields()`
326ea844a1aSMatthew Knepley @*/
327ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetNumFields(PetscSection s, PetscInt *numFields)
328ea844a1aSMatthew Knepley {
329ea844a1aSMatthew Knepley   PetscFunctionBegin;
330ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
331dadcf809SJacob Faibussowitsch   PetscValidIntPointer(numFields,2);
332ea844a1aSMatthew Knepley   *numFields = s->numFields;
333ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
334ea844a1aSMatthew Knepley }
335ea844a1aSMatthew Knepley 
336ea844a1aSMatthew Knepley /*@
337ea844a1aSMatthew Knepley   PetscSectionSetNumFields - Sets the number of fields.
338ea844a1aSMatthew Knepley 
33940750d41SVaclav Hapla   Not Collective
340ea844a1aSMatthew Knepley 
341ea844a1aSMatthew Knepley   Input Parameters:
342ea844a1aSMatthew Knepley + s - the PetscSection
343ea844a1aSMatthew Knepley - numFields - the number of fields
344ea844a1aSMatthew Knepley 
345ea844a1aSMatthew Knepley   Level: intermediate
346ea844a1aSMatthew Knepley 
347db781477SPatrick Sanan .seealso: `PetscSectionGetNumFields()`
348ea844a1aSMatthew Knepley @*/
349ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetNumFields(PetscSection s, PetscInt numFields)
350ea844a1aSMatthew Knepley {
351ea844a1aSMatthew Knepley   PetscInt       f;
352ea844a1aSMatthew Knepley 
353ea844a1aSMatthew Knepley   PetscFunctionBegin;
354ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
35508401ef6SPierre Jolivet   PetscCheck(numFields > 0,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "The number of fields %" PetscInt_FMT " must be positive", numFields);
3569566063dSJacob Faibussowitsch   PetscCall(PetscSectionReset(s));
357ea844a1aSMatthew Knepley 
358ea844a1aSMatthew Knepley   s->numFields = numFields;
3599566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(s->numFields, &s->numFieldComponents));
3609566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(s->numFields, &s->fieldNames));
3619566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(s->numFields, &s->compNames));
3629566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(s->numFields, &s->field));
363ea844a1aSMatthew Knepley   for (f = 0; f < s->numFields; ++f) {
364ea844a1aSMatthew Knepley     char name[64];
365ea844a1aSMatthew Knepley 
366ea844a1aSMatthew Knepley     s->numFieldComponents[f] = 1;
367ea844a1aSMatthew Knepley 
3689566063dSJacob Faibussowitsch     PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject) s), &s->field[f]));
3699566063dSJacob Faibussowitsch     PetscCall(PetscSNPrintf(name, 64, "Field_%" PetscInt_FMT, f));
3709566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(name, (char **) &s->fieldNames[f]));
3719566063dSJacob Faibussowitsch     PetscCall(PetscSNPrintf(name, 64, "Component_0"));
3729566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(s->numFieldComponents[f], &s->compNames[f]));
3739566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(name, (char **) &s->compNames[f][0]));
374ea844a1aSMatthew Knepley   }
375ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
376ea844a1aSMatthew Knepley }
377ea844a1aSMatthew Knepley 
378ea844a1aSMatthew Knepley /*@C
379ea844a1aSMatthew Knepley   PetscSectionGetFieldName - Returns the name of a field in the PetscSection
380ea844a1aSMatthew Knepley 
381ea844a1aSMatthew Knepley   Not Collective
382ea844a1aSMatthew Knepley 
383ea844a1aSMatthew Knepley   Input Parameters:
384ea844a1aSMatthew Knepley + s     - the PetscSection
385ea844a1aSMatthew Knepley - field - the field number
386ea844a1aSMatthew Knepley 
387ea844a1aSMatthew Knepley   Output Parameter:
388ea844a1aSMatthew Knepley . fieldName - the field name
389ea844a1aSMatthew Knepley 
390ea844a1aSMatthew Knepley   Level: intermediate
391ea844a1aSMatthew Knepley 
392db781477SPatrick Sanan .seealso: `PetscSectionSetFieldName()`
393ea844a1aSMatthew Knepley @*/
394ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetFieldName(PetscSection s, PetscInt field, const char *fieldName[])
395ea844a1aSMatthew Knepley {
396ea844a1aSMatthew Knepley   PetscFunctionBegin;
397ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
398ea844a1aSMatthew Knepley   PetscValidPointer(fieldName, 3);
3992abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
400ea844a1aSMatthew Knepley   *fieldName = s->fieldNames[field];
401ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
402ea844a1aSMatthew Knepley }
403ea844a1aSMatthew Knepley 
404ea844a1aSMatthew Knepley /*@C
405ea844a1aSMatthew Knepley   PetscSectionSetFieldName - Sets the name of a field in the PetscSection
406ea844a1aSMatthew Knepley 
407ea844a1aSMatthew Knepley   Not Collective
408ea844a1aSMatthew Knepley 
409ea844a1aSMatthew Knepley   Input Parameters:
410ea844a1aSMatthew Knepley + s     - the PetscSection
411ea844a1aSMatthew Knepley . field - the field number
412ea844a1aSMatthew Knepley - fieldName - the field name
413ea844a1aSMatthew Knepley 
414ea844a1aSMatthew Knepley   Level: intermediate
415ea844a1aSMatthew Knepley 
416db781477SPatrick Sanan .seealso: `PetscSectionGetFieldName()`
417ea844a1aSMatthew Knepley @*/
418ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetFieldName(PetscSection s, PetscInt field, const char fieldName[])
419ea844a1aSMatthew Knepley {
420ea844a1aSMatthew Knepley   PetscFunctionBegin;
421ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
422ea844a1aSMatthew Knepley   if (fieldName) PetscValidCharPointer(fieldName, 3);
4232abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
4249566063dSJacob Faibussowitsch   PetscCall(PetscFree(s->fieldNames[field]));
4259566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(fieldName, (char**) &s->fieldNames[field]));
426ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
427ea844a1aSMatthew Knepley }
428ea844a1aSMatthew Knepley 
429b778fa18SValeria Barra /*@C
430b778fa18SValeria Barra   PetscSectionGetComponentName - Gets the name of a field component in the PetscSection
431b778fa18SValeria Barra 
432b778fa18SValeria Barra   Not Collective
433b778fa18SValeria Barra 
434b778fa18SValeria Barra   Input Parameters:
435b778fa18SValeria Barra + s     - the PetscSection
436b778fa18SValeria Barra . field - the field number
437b778fa18SValeria Barra . comp  - the component number
438b778fa18SValeria Barra - compName - the component name
439b778fa18SValeria Barra 
440b778fa18SValeria Barra   Level: intermediate
441b778fa18SValeria Barra 
442db781477SPatrick Sanan .seealso: `PetscSectionSetComponentName()`
443b778fa18SValeria Barra @*/
444b778fa18SValeria Barra PetscErrorCode PetscSectionGetComponentName(PetscSection s, PetscInt field, PetscInt comp, const char *compName[])
445b778fa18SValeria Barra {
446b778fa18SValeria Barra   PetscFunctionBegin;
447b778fa18SValeria Barra   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
448064a246eSJacob Faibussowitsch   PetscValidPointer(compName, 4);
4492abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
4502abc8c78SJacob Faibussowitsch   PetscSectionCheckValidFieldComponent(comp,s->numFieldComponents[field]);
451b778fa18SValeria Barra   *compName = s->compNames[field][comp];
452b778fa18SValeria Barra   PetscFunctionReturn(0);
453b778fa18SValeria Barra }
454b778fa18SValeria Barra 
455b778fa18SValeria Barra /*@C
456b778fa18SValeria Barra   PetscSectionSetComponentName - Sets the name of a field component in the PetscSection
457b778fa18SValeria Barra 
458b778fa18SValeria Barra   Not Collective
459b778fa18SValeria Barra 
460b778fa18SValeria Barra   Input Parameters:
461b778fa18SValeria Barra + s     - the PetscSection
462b778fa18SValeria Barra . field - the field number
463b778fa18SValeria Barra . comp  - the component number
464b778fa18SValeria Barra - compName - the component name
465b778fa18SValeria Barra 
466b778fa18SValeria Barra   Level: intermediate
467b778fa18SValeria Barra 
468db781477SPatrick Sanan .seealso: `PetscSectionGetComponentName()`
469b778fa18SValeria Barra @*/
470b778fa18SValeria Barra PetscErrorCode PetscSectionSetComponentName(PetscSection s, PetscInt field, PetscInt comp, const char compName[])
471b778fa18SValeria Barra {
472b778fa18SValeria Barra   PetscFunctionBegin;
473b778fa18SValeria Barra   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
474064a246eSJacob Faibussowitsch   if (compName) PetscValidCharPointer(compName, 4);
4752abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
4762abc8c78SJacob Faibussowitsch   PetscSectionCheckValidFieldComponent(comp,s->numFieldComponents[field]);
4779566063dSJacob Faibussowitsch   PetscCall(PetscFree(s->compNames[field][comp]));
4789566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(compName, (char**) &s->compNames[field][comp]));
479b778fa18SValeria Barra   PetscFunctionReturn(0);
480b778fa18SValeria Barra }
481b778fa18SValeria Barra 
482ea844a1aSMatthew Knepley /*@
483ea844a1aSMatthew Knepley   PetscSectionGetFieldComponents - Returns the number of field components for the given field.
484ea844a1aSMatthew Knepley 
48540750d41SVaclav Hapla   Not Collective
486ea844a1aSMatthew Knepley 
487ea844a1aSMatthew Knepley   Input Parameters:
488ea844a1aSMatthew Knepley + s - the PetscSection
489ea844a1aSMatthew Knepley - field - the field number
490ea844a1aSMatthew Knepley 
491ea844a1aSMatthew Knepley   Output Parameter:
492ea844a1aSMatthew Knepley . numComp - the number of field components
493ea844a1aSMatthew Knepley 
494ea844a1aSMatthew Knepley   Level: intermediate
495ea844a1aSMatthew Knepley 
496db781477SPatrick Sanan .seealso: `PetscSectionSetFieldComponents()`, `PetscSectionGetNumFields()`
497ea844a1aSMatthew Knepley @*/
498ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetFieldComponents(PetscSection s, PetscInt field, PetscInt *numComp)
499ea844a1aSMatthew Knepley {
500ea844a1aSMatthew Knepley   PetscFunctionBegin;
501ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
5022abc8c78SJacob Faibussowitsch   PetscValidIntPointer(numComp, 3);
5032abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
504ea844a1aSMatthew Knepley   *numComp = s->numFieldComponents[field];
505ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
506ea844a1aSMatthew Knepley }
507ea844a1aSMatthew Knepley 
508ea844a1aSMatthew Knepley /*@
509ea844a1aSMatthew Knepley   PetscSectionSetFieldComponents - Sets the number of field components for the given field.
510ea844a1aSMatthew Knepley 
51140750d41SVaclav Hapla   Not Collective
512ea844a1aSMatthew Knepley 
513ea844a1aSMatthew Knepley   Input Parameters:
514ea844a1aSMatthew Knepley + s - the PetscSection
515ea844a1aSMatthew Knepley . field - the field number
516ea844a1aSMatthew Knepley - numComp - the number of field components
517ea844a1aSMatthew Knepley 
518ea844a1aSMatthew Knepley   Level: intermediate
519ea844a1aSMatthew Knepley 
520db781477SPatrick Sanan .seealso: `PetscSectionGetFieldComponents()`, `PetscSectionGetNumFields()`
521ea844a1aSMatthew Knepley @*/
522ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetFieldComponents(PetscSection s, PetscInt field, PetscInt numComp)
523ea844a1aSMatthew Knepley {
524b778fa18SValeria Barra   PetscInt       c;
525b778fa18SValeria Barra 
526ea844a1aSMatthew Knepley   PetscFunctionBegin;
527ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
5282abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
529b778fa18SValeria Barra   if (s->compNames) {
530b778fa18SValeria Barra     for (c = 0; c < s->numFieldComponents[field]; ++c) {
5319566063dSJacob Faibussowitsch       PetscCall(PetscFree(s->compNames[field][c]));
532b778fa18SValeria Barra     }
5339566063dSJacob Faibussowitsch     PetscCall(PetscFree(s->compNames[field]));
534b778fa18SValeria Barra   }
535b778fa18SValeria Barra 
536ea844a1aSMatthew Knepley   s->numFieldComponents[field] = numComp;
537b778fa18SValeria Barra   if (numComp) {
5389566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(numComp, (char ***) &s->compNames[field]));
539b778fa18SValeria Barra     for (c = 0; c < numComp; ++c) {
5402abc8c78SJacob Faibussowitsch       char name[64];
5412abc8c78SJacob Faibussowitsch 
5429566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(name, 64, "%" PetscInt_FMT, c));
5439566063dSJacob Faibussowitsch       PetscCall(PetscStrallocpy(name, (char **) &s->compNames[field][c]));
544b778fa18SValeria Barra     }
545b778fa18SValeria Barra   }
546ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
547ea844a1aSMatthew Knepley }
548ea844a1aSMatthew Knepley 
549ea844a1aSMatthew Knepley /*@
550ea844a1aSMatthew Knepley   PetscSectionGetChart - Returns the range [pStart, pEnd) in which points lie.
551ea844a1aSMatthew Knepley 
55240750d41SVaclav Hapla   Not Collective
553ea844a1aSMatthew Knepley 
554ea844a1aSMatthew Knepley   Input Parameter:
555ea844a1aSMatthew Knepley . s - the PetscSection
556ea844a1aSMatthew Knepley 
557ea844a1aSMatthew Knepley   Output Parameters:
558ea844a1aSMatthew Knepley + pStart - the first point
559ea844a1aSMatthew Knepley - pEnd - one past the last point
560ea844a1aSMatthew Knepley 
561ea844a1aSMatthew Knepley   Level: intermediate
562ea844a1aSMatthew Knepley 
563db781477SPatrick Sanan .seealso: `PetscSectionSetChart()`, `PetscSectionCreate()`
564ea844a1aSMatthew Knepley @*/
565ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetChart(PetscSection s, PetscInt *pStart, PetscInt *pEnd)
566ea844a1aSMatthew Knepley {
567ea844a1aSMatthew Knepley   PetscFunctionBegin;
568ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
569ea844a1aSMatthew Knepley   if (pStart) *pStart = s->pStart;
570ea844a1aSMatthew Knepley   if (pEnd)   *pEnd   = s->pEnd;
571ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
572ea844a1aSMatthew Knepley }
573ea844a1aSMatthew Knepley 
574ea844a1aSMatthew Knepley /*@
575ea844a1aSMatthew Knepley   PetscSectionSetChart - Sets the range [pStart, pEnd) in which points lie.
576ea844a1aSMatthew Knepley 
57740750d41SVaclav Hapla   Not Collective
578ea844a1aSMatthew Knepley 
579ea844a1aSMatthew Knepley   Input Parameters:
580ea844a1aSMatthew Knepley + s - the PetscSection
581ea844a1aSMatthew Knepley . pStart - the first point
582ea844a1aSMatthew Knepley - pEnd - one past the last point
583ea844a1aSMatthew Knepley 
584ea844a1aSMatthew Knepley   Level: intermediate
585ea844a1aSMatthew Knepley 
586db781477SPatrick Sanan .seealso: `PetscSectionGetChart()`, `PetscSectionCreate()`
587ea844a1aSMatthew Knepley @*/
588ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetChart(PetscSection s, PetscInt pStart, PetscInt pEnd)
589ea844a1aSMatthew Knepley {
590ea844a1aSMatthew Knepley   PetscInt       f;
591ea844a1aSMatthew Knepley 
592ea844a1aSMatthew Knepley   PetscFunctionBegin;
593ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
5949318fe57SMatthew G. Knepley   if (pStart == s->pStart && pEnd == s->pEnd) PetscFunctionReturn(0);
595ea844a1aSMatthew Knepley   /* Cannot Reset() because it destroys field information */
596ea844a1aSMatthew Knepley   s->setup = PETSC_FALSE;
5979566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&s->bc));
5989566063dSJacob Faibussowitsch   PetscCall(PetscFree(s->bcIndices));
5999566063dSJacob Faibussowitsch   PetscCall(PetscFree2(s->atlasDof, s->atlasOff));
600ea844a1aSMatthew Knepley 
601ea844a1aSMatthew Knepley   s->pStart = pStart;
602ea844a1aSMatthew Knepley   s->pEnd   = pEnd;
6039566063dSJacob Faibussowitsch   PetscCall(PetscMalloc2((pEnd - pStart), &s->atlasDof, (pEnd - pStart), &s->atlasOff));
6049566063dSJacob Faibussowitsch   PetscCall(PetscArrayzero(s->atlasDof, pEnd - pStart));
605ea844a1aSMatthew Knepley   for (f = 0; f < s->numFields; ++f) {
6069566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetChart(s->field[f], pStart, pEnd));
607ea844a1aSMatthew Knepley   }
608ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
609ea844a1aSMatthew Knepley }
610ea844a1aSMatthew Knepley 
611ea844a1aSMatthew Knepley /*@
612ea844a1aSMatthew Knepley   PetscSectionGetPermutation - Returns the permutation of [0, pEnd-pStart) or NULL
613ea844a1aSMatthew Knepley 
61440750d41SVaclav Hapla   Not Collective
615ea844a1aSMatthew Knepley 
616ea844a1aSMatthew Knepley   Input Parameter:
617ea844a1aSMatthew Knepley . s - the PetscSection
618ea844a1aSMatthew Knepley 
619ea844a1aSMatthew Knepley   Output Parameters:
620ea844a1aSMatthew Knepley . perm - The permutation as an IS
621ea844a1aSMatthew Knepley 
622ea844a1aSMatthew Knepley   Level: intermediate
623ea844a1aSMatthew Knepley 
624db781477SPatrick Sanan .seealso: `PetscSectionSetPermutation()`, `PetscSectionCreate()`
625ea844a1aSMatthew Knepley @*/
626ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetPermutation(PetscSection s, IS *perm)
627ea844a1aSMatthew Knepley {
628ea844a1aSMatthew Knepley   PetscFunctionBegin;
629ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
630ea844a1aSMatthew Knepley   if (perm) {PetscValidPointer(perm, 2); *perm = s->perm;}
631ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
632ea844a1aSMatthew Knepley }
633ea844a1aSMatthew Knepley 
634ea844a1aSMatthew Knepley /*@
635ea844a1aSMatthew Knepley   PetscSectionSetPermutation - Sets the permutation for [0, pEnd-pStart)
636ea844a1aSMatthew Knepley 
63740750d41SVaclav Hapla   Not Collective
638ea844a1aSMatthew Knepley 
639ea844a1aSMatthew Knepley   Input Parameters:
640ea844a1aSMatthew Knepley + s - the PetscSection
641ea844a1aSMatthew Knepley - perm - the permutation of points
642ea844a1aSMatthew Knepley 
643ea844a1aSMatthew Knepley   Level: intermediate
644ea844a1aSMatthew Knepley 
645db781477SPatrick Sanan .seealso: `PetscSectionGetPermutation()`, `PetscSectionCreate()`
646ea844a1aSMatthew Knepley @*/
647ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetPermutation(PetscSection s, IS perm)
648ea844a1aSMatthew Knepley {
649ea844a1aSMatthew Knepley   PetscFunctionBegin;
650ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
651ea844a1aSMatthew Knepley   if (perm) PetscValidHeaderSpecific(perm, IS_CLASSID, 2);
65228b400f6SJacob Faibussowitsch   PetscCheck(!s->setup,PetscObjectComm((PetscObject) s), PETSC_ERR_ARG_WRONGSTATE, "Cannot set a permutation after the section is setup");
653ea844a1aSMatthew Knepley   if (s->perm != perm) {
6549566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&s->perm));
655ea844a1aSMatthew Knepley     if (perm) {
656ea844a1aSMatthew Knepley       s->perm = perm;
6579566063dSJacob Faibussowitsch       PetscCall(PetscObjectReference((PetscObject) s->perm));
658ea844a1aSMatthew Knepley     }
659ea844a1aSMatthew Knepley   }
660ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
661ea844a1aSMatthew Knepley }
662ea844a1aSMatthew Knepley 
663ea844a1aSMatthew Knepley /*@
664ea844a1aSMatthew Knepley   PetscSectionGetPointMajor - Returns the flag for dof ordering, true if it is point major, otherwise field major
665ea844a1aSMatthew Knepley 
66640750d41SVaclav Hapla   Not Collective
667ea844a1aSMatthew Knepley 
668ea844a1aSMatthew Knepley   Input Parameter:
669ea844a1aSMatthew Knepley . s - the PetscSection
670ea844a1aSMatthew Knepley 
671ea844a1aSMatthew Knepley   Output Parameter:
672ea844a1aSMatthew Knepley . pm - the flag for point major ordering
673ea844a1aSMatthew Knepley 
674ea844a1aSMatthew Knepley   Level: intermediate
675ea844a1aSMatthew Knepley 
676db781477SPatrick Sanan .seealso: `PetscSectionSetPointMajor()`
677ea844a1aSMatthew Knepley @*/
678ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetPointMajor(PetscSection s, PetscBool *pm)
679ea844a1aSMatthew Knepley {
680ea844a1aSMatthew Knepley   PetscFunctionBegin;
681ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
682dadcf809SJacob Faibussowitsch   PetscValidBoolPointer(pm,2);
683ea844a1aSMatthew Knepley   *pm = s->pointMajor;
684ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
685ea844a1aSMatthew Knepley }
686ea844a1aSMatthew Knepley 
687ea844a1aSMatthew Knepley /*@
688ea844a1aSMatthew Knepley   PetscSectionSetPointMajor - Sets the flag for dof ordering, true if it is point major, otherwise field major
689ea844a1aSMatthew Knepley 
69040750d41SVaclav Hapla   Not Collective
691ea844a1aSMatthew Knepley 
692ea844a1aSMatthew Knepley   Input Parameters:
693ea844a1aSMatthew Knepley + s  - the PetscSection
694ea844a1aSMatthew Knepley - pm - the flag for point major ordering
695ea844a1aSMatthew Knepley 
696ea844a1aSMatthew Knepley   Level: intermediate
697ea844a1aSMatthew Knepley 
698db781477SPatrick Sanan .seealso: `PetscSectionGetPointMajor()`
699ea844a1aSMatthew Knepley @*/
700ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetPointMajor(PetscSection s, PetscBool pm)
701ea844a1aSMatthew Knepley {
702ea844a1aSMatthew Knepley   PetscFunctionBegin;
703ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
70428b400f6SJacob Faibussowitsch   PetscCheck(!s->setup,PetscObjectComm((PetscObject) s), PETSC_ERR_ARG_WRONGSTATE, "Cannot set the dof ordering after the section is setup");
705ea844a1aSMatthew Knepley   s->pointMajor = pm;
706ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
707ea844a1aSMatthew Knepley }
708ea844a1aSMatthew Knepley 
709ea844a1aSMatthew Knepley /*@
71087e637c6Sksagiyam   PetscSectionGetIncludesConstraints - Returns the flag indicating if constrained dofs were included when computing offsets
71187e637c6Sksagiyam 
71240750d41SVaclav Hapla   Not Collective
71387e637c6Sksagiyam 
71487e637c6Sksagiyam   Input Parameter:
71587e637c6Sksagiyam . s - the PetscSection
71687e637c6Sksagiyam 
71787e637c6Sksagiyam   Output Parameter:
71887e637c6Sksagiyam . includesConstraints - the flag indicating if constrained dofs were included when computing offsets
71987e637c6Sksagiyam 
72087e637c6Sksagiyam   Level: intermediate
72187e637c6Sksagiyam 
722db781477SPatrick Sanan .seealso: `PetscSectionSetIncludesConstraints()`
72387e637c6Sksagiyam @*/
72487e637c6Sksagiyam PetscErrorCode PetscSectionGetIncludesConstraints(PetscSection s, PetscBool *includesConstraints)
72587e637c6Sksagiyam {
72687e637c6Sksagiyam   PetscFunctionBegin;
72787e637c6Sksagiyam   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
72887e637c6Sksagiyam   PetscValidBoolPointer(includesConstraints,2);
72987e637c6Sksagiyam   *includesConstraints = s->includesConstraints;
73087e637c6Sksagiyam   PetscFunctionReturn(0);
73187e637c6Sksagiyam }
73287e637c6Sksagiyam 
73387e637c6Sksagiyam /*@
73487e637c6Sksagiyam   PetscSectionSetIncludesConstraints - Sets the flag indicating if constrained dofs are to be included when computing offsets
73587e637c6Sksagiyam 
73640750d41SVaclav Hapla   Not Collective
73787e637c6Sksagiyam 
73887e637c6Sksagiyam   Input Parameters:
73987e637c6Sksagiyam + s  - the PetscSection
74087e637c6Sksagiyam - includesConstraints - the flag indicating if constrained dofs are to be included when computing offsets
74187e637c6Sksagiyam 
74287e637c6Sksagiyam   Level: intermediate
74387e637c6Sksagiyam 
744db781477SPatrick Sanan .seealso: `PetscSectionGetIncludesConstraints()`
74587e637c6Sksagiyam @*/
74687e637c6Sksagiyam PetscErrorCode PetscSectionSetIncludesConstraints(PetscSection s, PetscBool includesConstraints)
74787e637c6Sksagiyam {
74887e637c6Sksagiyam   PetscFunctionBegin;
74987e637c6Sksagiyam   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
75028b400f6SJacob Faibussowitsch   PetscCheck(!s->setup,PetscObjectComm((PetscObject) s), PETSC_ERR_ARG_WRONGSTATE, "Cannot set includesConstraints after the section is set up");
75187e637c6Sksagiyam   s->includesConstraints = includesConstraints;
75287e637c6Sksagiyam   PetscFunctionReturn(0);
75387e637c6Sksagiyam }
75487e637c6Sksagiyam 
75587e637c6Sksagiyam /*@
756ea844a1aSMatthew Knepley   PetscSectionGetDof - Return the number of degrees of freedom associated with a given point.
757ea844a1aSMatthew Knepley 
75840750d41SVaclav Hapla   Not Collective
759ea844a1aSMatthew Knepley 
760ea844a1aSMatthew Knepley   Input Parameters:
761ea844a1aSMatthew Knepley + s - the PetscSection
762ea844a1aSMatthew Knepley - point - the point
763ea844a1aSMatthew Knepley 
764ea844a1aSMatthew Knepley   Output Parameter:
765ea844a1aSMatthew Knepley . numDof - the number of dof
766ea844a1aSMatthew Knepley 
767ea844a1aSMatthew Knepley   Level: intermediate
768ea844a1aSMatthew Knepley 
769db781477SPatrick Sanan .seealso: `PetscSectionSetDof()`, `PetscSectionCreate()`
770ea844a1aSMatthew Knepley @*/
771ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetDof(PetscSection s, PetscInt point, PetscInt *numDof)
772ea844a1aSMatthew Knepley {
77376bd3646SJed Brown   PetscFunctionBeginHot;
774ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
775dadcf809SJacob Faibussowitsch   PetscValidIntPointer(numDof, 3);
776c8bf3acbSVaclav Hapla   PetscAssert(point >= s->pStart && point < s->pEnd, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Section point %" PetscInt_FMT " should be in [%" PetscInt_FMT ", %" PetscInt_FMT ")", point, s->pStart, s->pEnd);
777ea844a1aSMatthew Knepley   *numDof = s->atlasDof[point - s->pStart];
778ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
779ea844a1aSMatthew Knepley }
780ea844a1aSMatthew Knepley 
781ea844a1aSMatthew Knepley /*@
782ea844a1aSMatthew Knepley   PetscSectionSetDof - Sets the number of degrees of freedom associated with a given point.
783ea844a1aSMatthew Knepley 
78440750d41SVaclav Hapla   Not Collective
785ea844a1aSMatthew Knepley 
786ea844a1aSMatthew Knepley   Input Parameters:
787ea844a1aSMatthew Knepley + s - the PetscSection
788ea844a1aSMatthew Knepley . point - the point
789ea844a1aSMatthew Knepley - numDof - the number of dof
790ea844a1aSMatthew Knepley 
791ea844a1aSMatthew Knepley   Level: intermediate
792ea844a1aSMatthew Knepley 
793db781477SPatrick Sanan .seealso: `PetscSectionGetDof()`, `PetscSectionAddDof()`, `PetscSectionCreate()`
794ea844a1aSMatthew Knepley @*/
795ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetDof(PetscSection s, PetscInt point, PetscInt numDof)
796ea844a1aSMatthew Knepley {
797ea844a1aSMatthew Knepley   PetscFunctionBegin;
798ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
799c8bf3acbSVaclav Hapla   PetscAssert(point >= s->pStart && point < s->pEnd, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Section point %" PetscInt_FMT " should be in [%" PetscInt_FMT ", %" PetscInt_FMT ")", point, s->pStart, s->pEnd);
800ea844a1aSMatthew Knepley   s->atlasDof[point - s->pStart] = numDof;
80169c11d05SVaclav Hapla   PetscCall(PetscSectionInvalidateMaxDof_Internal(s));
802ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
803ea844a1aSMatthew Knepley }
804ea844a1aSMatthew Knepley 
805ea844a1aSMatthew Knepley /*@
806ea844a1aSMatthew Knepley   PetscSectionAddDof - Adds to the number of degrees of freedom associated with a given point.
807ea844a1aSMatthew Knepley 
80840750d41SVaclav Hapla   Not Collective
809ea844a1aSMatthew Knepley 
810ea844a1aSMatthew Knepley   Input Parameters:
811ea844a1aSMatthew Knepley + s - the PetscSection
812ea844a1aSMatthew Knepley . point - the point
813ea844a1aSMatthew Knepley - numDof - the number of additional dof
814ea844a1aSMatthew Knepley 
815ea844a1aSMatthew Knepley   Level: intermediate
816ea844a1aSMatthew Knepley 
817db781477SPatrick Sanan .seealso: `PetscSectionGetDof()`, `PetscSectionSetDof()`, `PetscSectionCreate()`
818ea844a1aSMatthew Knepley @*/
819ea844a1aSMatthew Knepley PetscErrorCode PetscSectionAddDof(PetscSection s, PetscInt point, PetscInt numDof)
820ea844a1aSMatthew Knepley {
82176bd3646SJed Brown   PetscFunctionBeginHot;
822ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
823c8bf3acbSVaclav Hapla   PetscAssert(point >= s->pStart && point < s->pEnd, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Section point %" PetscInt_FMT " should be in [%" PetscInt_FMT ", %" PetscInt_FMT ")", point, s->pStart, s->pEnd);
824ea844a1aSMatthew Knepley   s->atlasDof[point - s->pStart] += numDof;
82569c11d05SVaclav Hapla   PetscCall(PetscSectionInvalidateMaxDof_Internal(s));
826ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
827ea844a1aSMatthew Knepley }
828ea844a1aSMatthew Knepley 
829ea844a1aSMatthew Knepley /*@
830ea844a1aSMatthew Knepley   PetscSectionGetFieldDof - Return the number of degrees of freedom associated with a field on a given point.
831ea844a1aSMatthew Knepley 
83240750d41SVaclav Hapla   Not Collective
833ea844a1aSMatthew Knepley 
834ea844a1aSMatthew Knepley   Input Parameters:
835ea844a1aSMatthew Knepley + s - the PetscSection
836ea844a1aSMatthew Knepley . point - the point
837ea844a1aSMatthew Knepley - field - the field
838ea844a1aSMatthew Knepley 
839ea844a1aSMatthew Knepley   Output Parameter:
840ea844a1aSMatthew Knepley . numDof - the number of dof
841ea844a1aSMatthew Knepley 
842ea844a1aSMatthew Knepley   Level: intermediate
843ea844a1aSMatthew Knepley 
844db781477SPatrick Sanan .seealso: `PetscSectionSetFieldDof()`, `PetscSectionCreate()`
845ea844a1aSMatthew Knepley @*/
846ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetFieldDof(PetscSection s, PetscInt point, PetscInt field, PetscInt *numDof)
847ea844a1aSMatthew Knepley {
848ea844a1aSMatthew Knepley   PetscFunctionBegin;
849ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
8502abc8c78SJacob Faibussowitsch   PetscValidIntPointer(numDof,4);
8512abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
8529566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetDof(s->field[field], point, numDof));
853ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
854ea844a1aSMatthew Knepley }
855ea844a1aSMatthew Knepley 
856ea844a1aSMatthew Knepley /*@
857ea844a1aSMatthew Knepley   PetscSectionSetFieldDof - Sets the number of degrees of freedom associated with a field on a given point.
858ea844a1aSMatthew Knepley 
85940750d41SVaclav Hapla   Not Collective
860ea844a1aSMatthew Knepley 
861ea844a1aSMatthew Knepley   Input Parameters:
862ea844a1aSMatthew Knepley + s - the PetscSection
863ea844a1aSMatthew Knepley . point - the point
864ea844a1aSMatthew Knepley . field - the field
865ea844a1aSMatthew Knepley - numDof - the number of dof
866ea844a1aSMatthew Knepley 
867ea844a1aSMatthew Knepley   Level: intermediate
868ea844a1aSMatthew Knepley 
869db781477SPatrick Sanan .seealso: `PetscSectionGetFieldDof()`, `PetscSectionCreate()`
870ea844a1aSMatthew Knepley @*/
871ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetFieldDof(PetscSection s, PetscInt point, PetscInt field, PetscInt numDof)
872ea844a1aSMatthew Knepley {
873ea844a1aSMatthew Knepley   PetscFunctionBegin;
874ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
8752abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
8769566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetDof(s->field[field], point, numDof));
877ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
878ea844a1aSMatthew Knepley }
879ea844a1aSMatthew Knepley 
880ea844a1aSMatthew Knepley /*@
881ea844a1aSMatthew Knepley   PetscSectionAddFieldDof - Adds a number of degrees of freedom associated with a field on a given point.
882ea844a1aSMatthew Knepley 
88340750d41SVaclav Hapla   Not Collective
884ea844a1aSMatthew Knepley 
885ea844a1aSMatthew Knepley   Input Parameters:
886ea844a1aSMatthew Knepley + s - the PetscSection
887ea844a1aSMatthew Knepley . point - the point
888ea844a1aSMatthew Knepley . field - the field
889ea844a1aSMatthew Knepley - numDof - the number of dof
890ea844a1aSMatthew Knepley 
891ea844a1aSMatthew Knepley   Level: intermediate
892ea844a1aSMatthew Knepley 
893db781477SPatrick Sanan .seealso: `PetscSectionSetFieldDof()`, `PetscSectionGetFieldDof()`, `PetscSectionCreate()`
894ea844a1aSMatthew Knepley @*/
895ea844a1aSMatthew Knepley PetscErrorCode PetscSectionAddFieldDof(PetscSection s, PetscInt point, PetscInt field, PetscInt numDof)
896ea844a1aSMatthew Knepley {
897ea844a1aSMatthew Knepley   PetscFunctionBegin;
898ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
8992abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
9009566063dSJacob Faibussowitsch   PetscCall(PetscSectionAddDof(s->field[field], point, numDof));
901ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
902ea844a1aSMatthew Knepley }
903ea844a1aSMatthew Knepley 
904ea844a1aSMatthew Knepley /*@
905ea844a1aSMatthew Knepley   PetscSectionGetConstraintDof - Return the number of constrained degrees of freedom associated with a given point.
906ea844a1aSMatthew Knepley 
90740750d41SVaclav Hapla   Not Collective
908ea844a1aSMatthew Knepley 
909ea844a1aSMatthew Knepley   Input Parameters:
910ea844a1aSMatthew Knepley + s - the PetscSection
911ea844a1aSMatthew Knepley - point - the point
912ea844a1aSMatthew Knepley 
913ea844a1aSMatthew Knepley   Output Parameter:
914ea844a1aSMatthew Knepley . numDof - the number of dof which are fixed by constraints
915ea844a1aSMatthew Knepley 
916ea844a1aSMatthew Knepley   Level: intermediate
917ea844a1aSMatthew Knepley 
918db781477SPatrick Sanan .seealso: `PetscSectionGetDof()`, `PetscSectionSetConstraintDof()`, `PetscSectionCreate()`
919ea844a1aSMatthew Knepley @*/
920ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetConstraintDof(PetscSection s, PetscInt point, PetscInt *numDof)
921ea844a1aSMatthew Knepley {
922ea844a1aSMatthew Knepley   PetscFunctionBegin;
923ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
924dadcf809SJacob Faibussowitsch   PetscValidIntPointer(numDof, 3);
925ea844a1aSMatthew Knepley   if (s->bc) {
9269566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s->bc, point, numDof));
927ea844a1aSMatthew Knepley   } else *numDof = 0;
928ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
929ea844a1aSMatthew Knepley }
930ea844a1aSMatthew Knepley 
931ea844a1aSMatthew Knepley /*@
932ea844a1aSMatthew Knepley   PetscSectionSetConstraintDof - Set the number of constrained degrees of freedom associated with a given point.
933ea844a1aSMatthew Knepley 
93440750d41SVaclav Hapla   Not Collective
935ea844a1aSMatthew Knepley 
936ea844a1aSMatthew Knepley   Input Parameters:
937ea844a1aSMatthew Knepley + s - the PetscSection
938ea844a1aSMatthew Knepley . point - the point
939ea844a1aSMatthew Knepley - numDof - the number of dof which are fixed by constraints
940ea844a1aSMatthew Knepley 
941ea844a1aSMatthew Knepley   Level: intermediate
942ea844a1aSMatthew Knepley 
943db781477SPatrick Sanan .seealso: `PetscSectionSetDof()`, `PetscSectionGetConstraintDof()`, `PetscSectionCreate()`
944ea844a1aSMatthew Knepley @*/
945ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetConstraintDof(PetscSection s, PetscInt point, PetscInt numDof)
946ea844a1aSMatthew Knepley {
947ea844a1aSMatthew Knepley   PetscFunctionBegin;
948ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
949ea844a1aSMatthew Knepley   if (numDof) {
9507c0883d5SVaclav Hapla     PetscCall(PetscSectionCheckConstraints_Private(s));
9519566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(s->bc, point, numDof));
952ea844a1aSMatthew Knepley   }
953ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
954ea844a1aSMatthew Knepley }
955ea844a1aSMatthew Knepley 
956ea844a1aSMatthew Knepley /*@
957ea844a1aSMatthew Knepley   PetscSectionAddConstraintDof - Increment the number of constrained degrees of freedom associated with a given point.
958ea844a1aSMatthew Knepley 
95940750d41SVaclav Hapla   Not Collective
960ea844a1aSMatthew Knepley 
961ea844a1aSMatthew Knepley   Input Parameters:
962ea844a1aSMatthew Knepley + s - the PetscSection
963ea844a1aSMatthew Knepley . point - the point
964ea844a1aSMatthew Knepley - numDof - the number of additional dof which are fixed by constraints
965ea844a1aSMatthew Knepley 
966ea844a1aSMatthew Knepley   Level: intermediate
967ea844a1aSMatthew Knepley 
968db781477SPatrick Sanan .seealso: `PetscSectionAddDof()`, `PetscSectionGetConstraintDof()`, `PetscSectionCreate()`
969ea844a1aSMatthew Knepley @*/
970ea844a1aSMatthew Knepley PetscErrorCode PetscSectionAddConstraintDof(PetscSection s, PetscInt point, PetscInt numDof)
971ea844a1aSMatthew Knepley {
972ea844a1aSMatthew Knepley   PetscFunctionBegin;
973ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
974ea844a1aSMatthew Knepley   if (numDof) {
9757c0883d5SVaclav Hapla     PetscCall(PetscSectionCheckConstraints_Private(s));
9769566063dSJacob Faibussowitsch     PetscCall(PetscSectionAddDof(s->bc, point, numDof));
977ea844a1aSMatthew Knepley   }
978ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
979ea844a1aSMatthew Knepley }
980ea844a1aSMatthew Knepley 
981ea844a1aSMatthew Knepley /*@
982ea844a1aSMatthew Knepley   PetscSectionGetFieldConstraintDof - Return the number of constrained degrees of freedom associated with a given field on a point.
983ea844a1aSMatthew Knepley 
98440750d41SVaclav Hapla   Not Collective
985ea844a1aSMatthew Knepley 
986ea844a1aSMatthew Knepley   Input Parameters:
987ea844a1aSMatthew Knepley + s - the PetscSection
988ea844a1aSMatthew Knepley . point - the point
989ea844a1aSMatthew Knepley - field - the field
990ea844a1aSMatthew Knepley 
991ea844a1aSMatthew Knepley   Output Parameter:
992ea844a1aSMatthew Knepley . numDof - the number of dof which are fixed by constraints
993ea844a1aSMatthew Knepley 
994ea844a1aSMatthew Knepley   Level: intermediate
995ea844a1aSMatthew Knepley 
996db781477SPatrick Sanan .seealso: `PetscSectionGetDof()`, `PetscSectionSetFieldConstraintDof()`, `PetscSectionCreate()`
997ea844a1aSMatthew Knepley @*/
998ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetFieldConstraintDof(PetscSection s, PetscInt point, PetscInt field, PetscInt *numDof)
999ea844a1aSMatthew Knepley {
1000ea844a1aSMatthew Knepley   PetscFunctionBegin;
1001ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
10022abc8c78SJacob Faibussowitsch   PetscValidIntPointer(numDof, 4);
10032abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
10049566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstraintDof(s->field[field], point, numDof));
1005ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1006ea844a1aSMatthew Knepley }
1007ea844a1aSMatthew Knepley 
1008ea844a1aSMatthew Knepley /*@
1009ea844a1aSMatthew Knepley   PetscSectionSetFieldConstraintDof - Set the number of constrained degrees of freedom associated with a given field on a point.
1010ea844a1aSMatthew Knepley 
101140750d41SVaclav Hapla   Not Collective
1012ea844a1aSMatthew Knepley 
1013ea844a1aSMatthew Knepley   Input Parameters:
1014ea844a1aSMatthew Knepley + s - the PetscSection
1015ea844a1aSMatthew Knepley . point - the point
1016ea844a1aSMatthew Knepley . field - the field
1017ea844a1aSMatthew Knepley - numDof - the number of dof which are fixed by constraints
1018ea844a1aSMatthew Knepley 
1019ea844a1aSMatthew Knepley   Level: intermediate
1020ea844a1aSMatthew Knepley 
1021db781477SPatrick Sanan .seealso: `PetscSectionSetDof()`, `PetscSectionGetFieldConstraintDof()`, `PetscSectionCreate()`
1022ea844a1aSMatthew Knepley @*/
1023ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetFieldConstraintDof(PetscSection s, PetscInt point, PetscInt field, PetscInt numDof)
1024ea844a1aSMatthew Knepley {
1025ea844a1aSMatthew Knepley   PetscFunctionBegin;
1026ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
10272abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
10289566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetConstraintDof(s->field[field], point, numDof));
1029ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1030ea844a1aSMatthew Knepley }
1031ea844a1aSMatthew Knepley 
1032ea844a1aSMatthew Knepley /*@
1033ea844a1aSMatthew Knepley   PetscSectionAddFieldConstraintDof - Increment the number of constrained degrees of freedom associated with a given field on a point.
1034ea844a1aSMatthew Knepley 
103540750d41SVaclav Hapla   Not Collective
1036ea844a1aSMatthew Knepley 
1037ea844a1aSMatthew Knepley   Input Parameters:
1038ea844a1aSMatthew Knepley + s - the PetscSection
1039ea844a1aSMatthew Knepley . point - the point
1040ea844a1aSMatthew Knepley . field - the field
1041ea844a1aSMatthew Knepley - numDof - the number of additional dof which are fixed by constraints
1042ea844a1aSMatthew Knepley 
1043ea844a1aSMatthew Knepley   Level: intermediate
1044ea844a1aSMatthew Knepley 
1045db781477SPatrick Sanan .seealso: `PetscSectionAddDof()`, `PetscSectionGetFieldConstraintDof()`, `PetscSectionCreate()`
1046ea844a1aSMatthew Knepley @*/
1047ea844a1aSMatthew Knepley PetscErrorCode PetscSectionAddFieldConstraintDof(PetscSection s, PetscInt point, PetscInt field, PetscInt numDof)
1048ea844a1aSMatthew Knepley {
1049ea844a1aSMatthew Knepley   PetscFunctionBegin;
1050ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
10512abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
10529566063dSJacob Faibussowitsch   PetscCall(PetscSectionAddConstraintDof(s->field[field], point, numDof));
1053ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1054ea844a1aSMatthew Knepley }
1055ea844a1aSMatthew Knepley 
1056ea844a1aSMatthew Knepley /*@
1057ea844a1aSMatthew Knepley   PetscSectionSetUpBC - Setup the subsections describing boundary conditions.
1058ea844a1aSMatthew Knepley 
105940750d41SVaclav Hapla   Not Collective
1060ea844a1aSMatthew Knepley 
1061ea844a1aSMatthew Knepley   Input Parameter:
1062ea844a1aSMatthew Knepley . s - the PetscSection
1063ea844a1aSMatthew Knepley 
1064ea844a1aSMatthew Knepley   Level: advanced
1065ea844a1aSMatthew Knepley 
1066db781477SPatrick Sanan .seealso: `PetscSectionSetUp()`, `PetscSectionCreate()`
1067ea844a1aSMatthew Knepley @*/
1068ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetUpBC(PetscSection s)
1069ea844a1aSMatthew Knepley {
1070ea844a1aSMatthew Knepley   PetscFunctionBegin;
1071ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1072ea844a1aSMatthew Knepley   if (s->bc) {
1073ea844a1aSMatthew Knepley     const PetscInt last = (s->bc->pEnd-s->bc->pStart) - 1;
1074ea844a1aSMatthew Knepley 
10759566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetUp(s->bc));
10768da24d32SBarry Smith     PetscCall(PetscMalloc1((last >= 0 ? s->bc->atlasOff[last] + s->bc->atlasDof[last] : 0), &s->bcIndices));
1077ea844a1aSMatthew Knepley   }
1078ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1079ea844a1aSMatthew Knepley }
1080ea844a1aSMatthew Knepley 
1081ea844a1aSMatthew Knepley /*@
1082ea844a1aSMatthew Knepley   PetscSectionSetUp - Calculate offsets based upon the number of degrees of freedom for each point.
1083ea844a1aSMatthew Knepley 
108440750d41SVaclav Hapla   Not Collective
1085ea844a1aSMatthew Knepley 
1086ea844a1aSMatthew Knepley   Input Parameter:
1087ea844a1aSMatthew Knepley . s - the PetscSection
1088ea844a1aSMatthew Knepley 
1089ea844a1aSMatthew Knepley   Level: intermediate
1090ea844a1aSMatthew Knepley 
1091db781477SPatrick Sanan .seealso: `PetscSectionCreate()`
1092ea844a1aSMatthew Knepley @*/
1093ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetUp(PetscSection s)
1094ea844a1aSMatthew Knepley {
1095ea844a1aSMatthew Knepley   const PetscInt *pind   = NULL;
1096ea844a1aSMatthew Knepley   PetscInt        offset = 0, foff, p, f;
1097ea844a1aSMatthew Knepley 
1098ea844a1aSMatthew Knepley   PetscFunctionBegin;
1099ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1100ea844a1aSMatthew Knepley   if (s->setup) PetscFunctionReturn(0);
1101ea844a1aSMatthew Knepley   s->setup = PETSC_TRUE;
1102ea844a1aSMatthew Knepley   /* Set offsets and field offsets for all points */
1103ea844a1aSMatthew Knepley   /*   Assume that all fields have the same chart */
110428b400f6SJacob Faibussowitsch   PetscCheck(s->includesConstraints,PETSC_COMM_SELF,PETSC_ERR_SUP,"PetscSectionSetUp is currently unsupported for includesConstraints = PETSC_TRUE");
11059566063dSJacob Faibussowitsch   if (s->perm) PetscCall(ISGetIndices(s->perm, &pind));
1106ea844a1aSMatthew Knepley   if (s->pointMajor) {
1107ea844a1aSMatthew Knepley     for (p = 0; p < s->pEnd - s->pStart; ++p) {
1108ea844a1aSMatthew Knepley       const PetscInt q = pind ? pind[p] : p;
1109ea844a1aSMatthew Knepley 
1110ea844a1aSMatthew Knepley       /* Set point offset */
1111ea844a1aSMatthew Knepley       s->atlasOff[q] = offset;
1112ea844a1aSMatthew Knepley       offset        += s->atlasDof[q];
1113ea844a1aSMatthew Knepley       /* Set field offset */
1114ea844a1aSMatthew Knepley       for (f = 0, foff = s->atlasOff[q]; f < s->numFields; ++f) {
1115ea844a1aSMatthew Knepley         PetscSection sf = s->field[f];
1116ea844a1aSMatthew Knepley 
1117ea844a1aSMatthew Knepley         sf->atlasOff[q] = foff;
1118ea844a1aSMatthew Knepley         foff += sf->atlasDof[q];
1119ea844a1aSMatthew Knepley       }
1120ea844a1aSMatthew Knepley     }
1121ea844a1aSMatthew Knepley   } else {
1122ea844a1aSMatthew Knepley     /* Set field offsets for all points */
1123ea844a1aSMatthew Knepley     for (f = 0; f < s->numFields; ++f) {
1124ea844a1aSMatthew Knepley       PetscSection sf = s->field[f];
1125ea844a1aSMatthew Knepley 
1126ea844a1aSMatthew Knepley       for (p = 0; p < s->pEnd - s->pStart; ++p) {
1127ea844a1aSMatthew Knepley         const PetscInt q = pind ? pind[p] : p;
1128ea844a1aSMatthew Knepley 
1129ea844a1aSMatthew Knepley         sf->atlasOff[q] = offset;
1130ea844a1aSMatthew Knepley         offset += sf->atlasDof[q];
1131ea844a1aSMatthew Knepley       }
1132ea844a1aSMatthew Knepley     }
1133ea844a1aSMatthew Knepley     /* Disable point offsets since these are unused */
1134ea844a1aSMatthew Knepley     for (p = 0; p < s->pEnd - s->pStart; ++p) {
1135ea844a1aSMatthew Knepley       s->atlasOff[p] = -1;
1136ea844a1aSMatthew Knepley     }
1137ea844a1aSMatthew Knepley   }
11389566063dSJacob Faibussowitsch   if (s->perm) PetscCall(ISRestoreIndices(s->perm, &pind));
1139ea844a1aSMatthew Knepley   /* Setup BC sections */
11409566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUpBC(s));
11419566063dSJacob Faibussowitsch   for (f = 0; f < s->numFields; ++f) PetscCall(PetscSectionSetUpBC(s->field[f]));
1142ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1143ea844a1aSMatthew Knepley }
1144ea844a1aSMatthew Knepley 
1145ea844a1aSMatthew Knepley /*@
1146ea844a1aSMatthew Knepley   PetscSectionGetMaxDof - Return the maximum number of degrees of freedom on any point in the chart
1147ea844a1aSMatthew Knepley 
114840750d41SVaclav Hapla   Not Collective
1149ea844a1aSMatthew Knepley 
1150ea844a1aSMatthew Knepley   Input Parameters:
1151ea844a1aSMatthew Knepley . s - the PetscSection
1152ea844a1aSMatthew Knepley 
1153ea844a1aSMatthew Knepley   Output Parameter:
1154ea844a1aSMatthew Knepley . maxDof - the maximum dof
1155ea844a1aSMatthew Knepley 
1156ea844a1aSMatthew Knepley   Level: intermediate
1157ea844a1aSMatthew Knepley 
115869c11d05SVaclav Hapla   Notes:
115969c11d05SVaclav Hapla   The returned number is up-to-date without need for PetscSectionSetUp().
116069c11d05SVaclav Hapla 
116169c11d05SVaclav Hapla   Developer Notes:
116269c11d05SVaclav Hapla   The returned number is calculated lazily and stashed.
116369c11d05SVaclav Hapla   A call to PetscSectionInvalidateMaxDof_Internal() invalidates the stashed value.
116469c11d05SVaclav Hapla   PetscSectionInvalidateMaxDof_Internal() is called in PetscSectionSetDof(), PetscSectionAddDof() and PetscSectionReset().
116569c11d05SVaclav Hapla   It should also be called every time atlasDof is modified directly.
116669c11d05SVaclav Hapla 
1167db781477SPatrick Sanan .seealso: `PetscSectionGetDof()`, `PetscSectionSetDof()`, `PetscSectionAddDof()`, `PetscSectionCreate()`
1168ea844a1aSMatthew Knepley @*/
1169ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetMaxDof(PetscSection s, PetscInt *maxDof)
1170ea844a1aSMatthew Knepley {
117169c11d05SVaclav Hapla   PetscInt p;
117269c11d05SVaclav Hapla 
1173ea844a1aSMatthew Knepley   PetscFunctionBegin;
1174ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1175dadcf809SJacob Faibussowitsch   PetscValidIntPointer(maxDof, 2);
117669c11d05SVaclav Hapla   if (s->maxDof == PETSC_MIN_INT) {
117769c11d05SVaclav Hapla     s->maxDof = 0;
117869c11d05SVaclav Hapla     for (p = 0; p < s->pEnd - s->pStart; ++p) {
117969c11d05SVaclav Hapla       s->maxDof = PetscMax(s->maxDof, s->atlasDof[p]);
118069c11d05SVaclav Hapla     }
118169c11d05SVaclav Hapla   }
1182ea844a1aSMatthew Knepley   *maxDof = s->maxDof;
1183ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1184ea844a1aSMatthew Knepley }
1185ea844a1aSMatthew Knepley 
1186ea844a1aSMatthew Knepley /*@
1187ea844a1aSMatthew Knepley   PetscSectionGetStorageSize - Return the size of an array or local Vec capable of holding all the degrees of freedom.
1188ea844a1aSMatthew Knepley 
118940750d41SVaclav Hapla   Not Collective
1190ea844a1aSMatthew Knepley 
1191ea844a1aSMatthew Knepley   Input Parameter:
1192ea844a1aSMatthew Knepley . s - the PetscSection
1193ea844a1aSMatthew Knepley 
1194ea844a1aSMatthew Knepley   Output Parameter:
1195ea844a1aSMatthew Knepley . size - the size of an array which can hold all the dofs
1196ea844a1aSMatthew Knepley 
1197ea844a1aSMatthew Knepley   Level: intermediate
1198ea844a1aSMatthew Knepley 
1199db781477SPatrick Sanan .seealso: `PetscSectionGetOffset()`, `PetscSectionGetConstrainedStorageSize()`, `PetscSectionCreate()`
1200ea844a1aSMatthew Knepley @*/
1201ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetStorageSize(PetscSection s, PetscInt *size)
1202ea844a1aSMatthew Knepley {
1203ea844a1aSMatthew Knepley   PetscInt p, n = 0;
1204ea844a1aSMatthew Knepley 
1205ea844a1aSMatthew Knepley   PetscFunctionBegin;
1206ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1207dadcf809SJacob Faibussowitsch   PetscValidIntPointer(size, 2);
1208ea844a1aSMatthew Knepley   for (p = 0; p < s->pEnd - s->pStart; ++p) n += s->atlasDof[p] > 0 ? s->atlasDof[p] : 0;
1209ea844a1aSMatthew Knepley   *size = n;
1210ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1211ea844a1aSMatthew Knepley }
1212ea844a1aSMatthew Knepley 
1213ea844a1aSMatthew Knepley /*@
1214ea844a1aSMatthew Knepley   PetscSectionGetConstrainedStorageSize - Return the size of an array or local Vec capable of holding all unconstrained degrees of freedom.
1215ea844a1aSMatthew Knepley 
121640750d41SVaclav Hapla   Not Collective
1217ea844a1aSMatthew Knepley 
1218064ec1f3Sprj-   Input Parameter:
1219064ec1f3Sprj- . s - the PetscSection
1220ea844a1aSMatthew Knepley 
1221ea844a1aSMatthew Knepley   Output Parameter:
1222ea844a1aSMatthew Knepley . size - the size of an array which can hold all unconstrained dofs
1223ea844a1aSMatthew Knepley 
1224ea844a1aSMatthew Knepley   Level: intermediate
1225ea844a1aSMatthew Knepley 
1226db781477SPatrick Sanan .seealso: `PetscSectionGetStorageSize()`, `PetscSectionGetOffset()`, `PetscSectionCreate()`
1227ea844a1aSMatthew Knepley @*/
1228ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetConstrainedStorageSize(PetscSection s, PetscInt *size)
1229ea844a1aSMatthew Knepley {
1230ea844a1aSMatthew Knepley   PetscInt p, n = 0;
1231ea844a1aSMatthew Knepley 
1232ea844a1aSMatthew Knepley   PetscFunctionBegin;
1233ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1234dadcf809SJacob Faibussowitsch   PetscValidIntPointer(size, 2);
1235ea844a1aSMatthew Knepley   for (p = 0; p < s->pEnd - s->pStart; ++p) {
1236ea844a1aSMatthew Knepley     const PetscInt cdof = s->bc ? s->bc->atlasDof[p] : 0;
1237ea844a1aSMatthew Knepley     n += s->atlasDof[p] > 0 ? s->atlasDof[p] - cdof : 0;
1238ea844a1aSMatthew Knepley   }
1239ea844a1aSMatthew Knepley   *size = n;
1240ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1241ea844a1aSMatthew Knepley }
1242ea844a1aSMatthew Knepley 
1243ea844a1aSMatthew Knepley /*@
1244ea844a1aSMatthew Knepley   PetscSectionCreateGlobalSection - Create a section describing the global field layout using
1245ea844a1aSMatthew Knepley   the local section and an SF describing the section point overlap.
1246ea844a1aSMatthew Knepley 
1247ea844a1aSMatthew Knepley   Input Parameters:
1248ea844a1aSMatthew Knepley + s - The PetscSection for the local field layout
1249ea844a1aSMatthew Knepley . sf - The SF describing parallel layout of the section points (leaves are unowned local points)
1250ea844a1aSMatthew Knepley . includeConstraints - By default this is PETSC_FALSE, meaning that the global field vector will not possess constrained dofs
1251ea844a1aSMatthew Knepley - localOffsets - If PETSC_TRUE, use local rather than global offsets for the points
1252ea844a1aSMatthew Knepley 
1253ea844a1aSMatthew Knepley   Output Parameter:
1254ea844a1aSMatthew Knepley . gsection - The PetscSection for the global field layout
1255ea844a1aSMatthew Knepley 
1256ea844a1aSMatthew Knepley   Note: This gives negative sizes and offsets to points not owned by this process
1257ea844a1aSMatthew Knepley 
1258ea844a1aSMatthew Knepley   Level: intermediate
1259ea844a1aSMatthew Knepley 
1260db781477SPatrick Sanan .seealso: `PetscSectionCreate()`
1261ea844a1aSMatthew Knepley @*/
1262ea844a1aSMatthew Knepley PetscErrorCode PetscSectionCreateGlobalSection(PetscSection s, PetscSF sf, PetscBool includeConstraints, PetscBool localOffsets, PetscSection *gsection)
1263ea844a1aSMatthew Knepley {
1264ea844a1aSMatthew Knepley   PetscSection    gs;
1265ea844a1aSMatthew Knepley   const PetscInt *pind = NULL;
1266ea844a1aSMatthew Knepley   PetscInt       *recv = NULL, *neg = NULL;
1267046d2115Sksagiyam   PetscInt        pStart, pEnd, p, dof, cdof, off, foff, globalOff = 0, nroots, nlocal, maxleaf;
1268046d2115Sksagiyam   PetscInt        numFields, f, numComponents;
1269ea844a1aSMatthew Knepley 
1270ea844a1aSMatthew Knepley   PetscFunctionBegin;
1271ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1272ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
1273ea844a1aSMatthew Knepley   PetscValidLogicalCollectiveBool(s, includeConstraints, 3);
1274ea844a1aSMatthew Knepley   PetscValidLogicalCollectiveBool(s, localOffsets, 4);
1275ea844a1aSMatthew Knepley   PetscValidPointer(gsection, 5);
127628b400f6SJacob Faibussowitsch   PetscCheck(s->pointMajor,PETSC_COMM_SELF,PETSC_ERR_SUP, "No support for field major ordering");
12779566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject) s), &gs));
12789566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetNumFields(s, &numFields));
12799566063dSJacob Faibussowitsch   if (numFields > 0) PetscCall(PetscSectionSetNumFields(gs, numFields));
12809566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
12819566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(gs, pStart, pEnd));
128287e637c6Sksagiyam   gs->includesConstraints = includeConstraints;
12839566063dSJacob Faibussowitsch   PetscCall(PetscSFGetGraph(sf, &nroots, NULL, NULL, NULL));
1284ea844a1aSMatthew Knepley   nlocal = nroots;              /* The local/leaf space matches global/root space */
1285ea844a1aSMatthew Knepley   /* Must allocate for all points visible to SF, which may be more than this section */
1286ea844a1aSMatthew Knepley   if (nroots >= 0) {             /* nroots < 0 means that the graph has not been set, only happens in serial */
12879566063dSJacob Faibussowitsch     PetscCall(PetscSFGetLeafRange(sf, NULL, &maxleaf));
128808401ef6SPierre Jolivet     PetscCheck(nroots >= pEnd,PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "SF roots %" PetscInt_FMT " < pEnd %" PetscInt_FMT, nroots, pEnd);
128908401ef6SPierre Jolivet     PetscCheck(maxleaf < nroots,PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "Max local leaf %" PetscInt_FMT " >= nroots %" PetscInt_FMT, maxleaf, nroots);
12909566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nroots,&neg,nlocal,&recv));
12919566063dSJacob Faibussowitsch     PetscCall(PetscArrayzero(neg,nroots));
1292ea844a1aSMatthew Knepley   }
1293ea844a1aSMatthew Knepley   /* Mark all local points with negative dof */
1294ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
12959566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s, p, &dof));
12969566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(gs, p, dof));
12979566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s, p, &cdof));
12989566063dSJacob Faibussowitsch     if (!includeConstraints && cdof > 0) PetscCall(PetscSectionSetConstraintDof(gs, p, cdof));
1299ea844a1aSMatthew Knepley     if (neg) neg[p] = -(dof+1);
1300ea844a1aSMatthew Knepley   }
13019566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUpBC(gs));
13029566063dSJacob Faibussowitsch   if (gs->bcIndices) PetscCall(PetscArraycpy(gs->bcIndices, s->bcIndices, gs->bc->atlasOff[gs->bc->pEnd-gs->bc->pStart-1] + gs->bc->atlasDof[gs->bc->pEnd-gs->bc->pStart-1]));
1303ea844a1aSMatthew Knepley   if (nroots >= 0) {
13049566063dSJacob Faibussowitsch     PetscCall(PetscArrayzero(recv,nlocal));
13059566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastBegin(sf, MPIU_INT, neg, recv,MPI_REPLACE));
13069566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastEnd(sf, MPIU_INT, neg, recv,MPI_REPLACE));
1307ea844a1aSMatthew Knepley     for (p = pStart; p < pEnd; ++p) {
1308ea844a1aSMatthew Knepley       if (recv[p] < 0) {
1309ea844a1aSMatthew Knepley         gs->atlasDof[p-pStart] = recv[p];
13109566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetDof(s, p, &dof));
131108401ef6SPierre Jolivet         PetscCheck(-(recv[p]+1) == dof,PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Global dof %" PetscInt_FMT " for point %" PetscInt_FMT " is not the unconstrained %" PetscInt_FMT, -(recv[p]+1), p, dof);
1312ea844a1aSMatthew Knepley       }
1313ea844a1aSMatthew Knepley     }
1314ea844a1aSMatthew Knepley   }
1315ea844a1aSMatthew Knepley   /* Calculate new sizes, get process offset, and calculate point offsets */
13169566063dSJacob Faibussowitsch   if (s->perm) PetscCall(ISGetIndices(s->perm, &pind));
1317ea844a1aSMatthew Knepley   for (p = 0, off = 0; p < pEnd-pStart; ++p) {
1318ea844a1aSMatthew Knepley     const PetscInt q = pind ? pind[p] : p;
1319ea844a1aSMatthew Knepley 
1320ea844a1aSMatthew Knepley     cdof = (!includeConstraints && s->bc) ? s->bc->atlasDof[q] : 0;
1321ea844a1aSMatthew Knepley     gs->atlasOff[q] = off;
1322ea844a1aSMatthew Knepley     off += gs->atlasDof[q] > 0 ? gs->atlasDof[q]-cdof : 0;
1323ea844a1aSMatthew Knepley   }
1324ea844a1aSMatthew Knepley   if (!localOffsets) {
13259566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Scan(&off, &globalOff, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject) s)));
1326ea844a1aSMatthew Knepley     globalOff -= off;
1327ea844a1aSMatthew Knepley   }
1328ea844a1aSMatthew Knepley   for (p = pStart, off = 0; p < pEnd; ++p) {
1329ea844a1aSMatthew Knepley     gs->atlasOff[p-pStart] += globalOff;
1330ea844a1aSMatthew Knepley     if (neg) neg[p] = -(gs->atlasOff[p-pStart]+1);
1331ea844a1aSMatthew Knepley   }
13329566063dSJacob Faibussowitsch   if (s->perm) PetscCall(ISRestoreIndices(s->perm, &pind));
1333ea844a1aSMatthew Knepley   /* Put in negative offsets for ghost points */
1334ea844a1aSMatthew Knepley   if (nroots >= 0) {
13359566063dSJacob Faibussowitsch     PetscCall(PetscArrayzero(recv,nlocal));
13369566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastBegin(sf, MPIU_INT, neg, recv,MPI_REPLACE));
13379566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastEnd(sf, MPIU_INT, neg, recv,MPI_REPLACE));
1338ea844a1aSMatthew Knepley     for (p = pStart; p < pEnd; ++p) {
1339ea844a1aSMatthew Knepley       if (recv[p] < 0) gs->atlasOff[p-pStart] = recv[p];
1340ea844a1aSMatthew Knepley     }
1341ea844a1aSMatthew Knepley   }
13429566063dSJacob Faibussowitsch   PetscCall(PetscFree2(neg,recv));
1343046d2115Sksagiyam   /* Set field dofs/offsets/constraints */
1344046d2115Sksagiyam   for (f = 0; f < numFields; ++f) {
1345046d2115Sksagiyam     gs->field[f]->includesConstraints = includeConstraints;
13469566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldComponents(s, f, &numComponents));
13479566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldComponents(gs, f, numComponents));
1348046d2115Sksagiyam   }
1349046d2115Sksagiyam   for (p = pStart; p < pEnd; ++p) {
13509566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(gs, p, &off));
1351046d2115Sksagiyam     for (f = 0, foff = off; f < numFields; ++f) {
13529566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintDof(s, p, f, &cdof));
13539566063dSJacob Faibussowitsch       if (!includeConstraints && cdof > 0) PetscCall(PetscSectionSetFieldConstraintDof(gs, p, f, cdof));
13549566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldDof(s, p, f, &dof));
13559566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldDof(gs, p, f, off < 0 ? -(dof + 1) : dof));
13569566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldOffset(gs, p, f, foff));
13579566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintDof(gs, p, f, &cdof));
1358046d2115Sksagiyam       foff = off < 0 ? foff - (dof - cdof) : foff + (dof - cdof);
1359046d2115Sksagiyam     }
1360046d2115Sksagiyam   }
1361046d2115Sksagiyam   for (f = 0; f < numFields; ++f) {
1362046d2115Sksagiyam     PetscSection gfs = gs->field[f];
1363046d2115Sksagiyam 
13649566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetUpBC(gfs));
13659566063dSJacob Faibussowitsch     if (gfs->bcIndices) PetscCall(PetscArraycpy(gfs->bcIndices, s->field[f]->bcIndices, gfs->bc->atlasOff[gfs->bc->pEnd-gfs->bc->pStart-1] + gfs->bc->atlasDof[gfs->bc->pEnd-gfs->bc->pStart-1]));
1366046d2115Sksagiyam   }
1367046d2115Sksagiyam   gs->setup = PETSC_TRUE;
13689566063dSJacob Faibussowitsch   PetscCall(PetscSectionViewFromOptions(gs, NULL, "-global_section_view"));
1369ea844a1aSMatthew Knepley   *gsection = gs;
1370ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1371ea844a1aSMatthew Knepley }
1372ea844a1aSMatthew Knepley 
1373ea844a1aSMatthew Knepley /*@
1374ea844a1aSMatthew Knepley   PetscSectionCreateGlobalSectionCensored - Create a section describing the global field layout using
1375ea844a1aSMatthew Knepley   the local section and an SF describing the section point overlap.
1376ea844a1aSMatthew Knepley 
1377ea844a1aSMatthew Knepley   Input Parameters:
1378ea844a1aSMatthew Knepley + s - The PetscSection for the local field layout
1379ea844a1aSMatthew Knepley . sf - The SF describing parallel layout of the section points
1380ea844a1aSMatthew Knepley . includeConstraints - By default this is PETSC_FALSE, meaning that the global field vector will not possess constrained dofs
1381ea844a1aSMatthew Knepley . numExcludes - The number of exclusion ranges
1382ea844a1aSMatthew Knepley - excludes - An array [start_0, end_0, start_1, end_1, ...] where there are numExcludes pairs
1383ea844a1aSMatthew Knepley 
1384ea844a1aSMatthew Knepley   Output Parameter:
1385ea844a1aSMatthew Knepley . gsection - The PetscSection for the global field layout
1386ea844a1aSMatthew Knepley 
1387ea844a1aSMatthew Knepley   Note: This gives negative sizes and offsets to points not owned by this process
1388ea844a1aSMatthew Knepley 
1389ea844a1aSMatthew Knepley   Level: advanced
1390ea844a1aSMatthew Knepley 
1391db781477SPatrick Sanan .seealso: `PetscSectionCreate()`
1392ea844a1aSMatthew Knepley @*/
1393ea844a1aSMatthew Knepley PetscErrorCode PetscSectionCreateGlobalSectionCensored(PetscSection s, PetscSF sf, PetscBool includeConstraints, PetscInt numExcludes, const PetscInt excludes[], PetscSection *gsection)
1394ea844a1aSMatthew Knepley {
1395ea844a1aSMatthew Knepley   const PetscInt *pind = NULL;
1396ea844a1aSMatthew Knepley   PetscInt       *neg  = NULL, *tmpOff = NULL;
1397ea844a1aSMatthew Knepley   PetscInt        pStart, pEnd, p, e, dof, cdof, off, globalOff = 0, nroots;
1398ea844a1aSMatthew Knepley 
1399ea844a1aSMatthew Knepley   PetscFunctionBegin;
1400ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1401ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
1402ea844a1aSMatthew Knepley   PetscValidPointer(gsection, 6);
14039566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject) s), gsection));
14049566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
14059566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(*gsection, pStart, pEnd));
14069566063dSJacob Faibussowitsch   PetscCall(PetscSFGetGraph(sf, &nroots, NULL, NULL, NULL));
1407ea844a1aSMatthew Knepley   if (nroots >= 0) {
140808401ef6SPierre Jolivet     PetscCheck(nroots >= pEnd-pStart,PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "PetscSF nroots %" PetscInt_FMT " < %" PetscInt_FMT " section size", nroots, pEnd-pStart);
14099566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(nroots, &neg));
1410ea844a1aSMatthew Knepley     if (nroots > pEnd-pStart) {
14119566063dSJacob Faibussowitsch       PetscCall(PetscCalloc1(nroots, &tmpOff));
1412ea844a1aSMatthew Knepley     } else {
1413ea844a1aSMatthew Knepley       tmpOff = &(*gsection)->atlasDof[-pStart];
1414ea844a1aSMatthew Knepley     }
1415ea844a1aSMatthew Knepley   }
1416ea844a1aSMatthew Knepley   /* Mark ghost points with negative dof */
1417ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
1418ea844a1aSMatthew Knepley     for (e = 0; e < numExcludes; ++e) {
1419ea844a1aSMatthew Knepley       if ((p >= excludes[e*2+0]) && (p < excludes[e*2+1])) {
14209566063dSJacob Faibussowitsch         PetscCall(PetscSectionSetDof(*gsection, p, 0));
1421ea844a1aSMatthew Knepley         break;
1422ea844a1aSMatthew Knepley       }
1423ea844a1aSMatthew Knepley     }
1424ea844a1aSMatthew Knepley     if (e < numExcludes) continue;
14259566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s, p, &dof));
14269566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(*gsection, p, dof));
14279566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s, p, &cdof));
14289566063dSJacob Faibussowitsch     if (!includeConstraints && cdof > 0) PetscCall(PetscSectionSetConstraintDof(*gsection, p, cdof));
1429ea844a1aSMatthew Knepley     if (neg) neg[p] = -(dof+1);
1430ea844a1aSMatthew Knepley   }
14319566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUpBC(*gsection));
1432ea844a1aSMatthew Knepley   if (nroots >= 0) {
14339566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastBegin(sf, MPIU_INT, neg, tmpOff,MPI_REPLACE));
14349566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastEnd(sf, MPIU_INT, neg, tmpOff,MPI_REPLACE));
1435ea844a1aSMatthew Knepley     if (nroots > pEnd - pStart) {
1436ea844a1aSMatthew Knepley       for (p = pStart; p < pEnd; ++p) {if (tmpOff[p] < 0) (*gsection)->atlasDof[p-pStart] = tmpOff[p];}
1437ea844a1aSMatthew Knepley     }
1438ea844a1aSMatthew Knepley   }
1439ea844a1aSMatthew Knepley   /* Calculate new sizes, get proccess offset, and calculate point offsets */
14409566063dSJacob Faibussowitsch   if (s->perm) PetscCall(ISGetIndices(s->perm, &pind));
1441ea844a1aSMatthew Knepley   for (p = 0, off = 0; p < pEnd-pStart; ++p) {
1442ea844a1aSMatthew Knepley     const PetscInt q = pind ? pind[p] : p;
1443ea844a1aSMatthew Knepley 
1444ea844a1aSMatthew Knepley     cdof = (!includeConstraints && s->bc) ? s->bc->atlasDof[q] : 0;
1445ea844a1aSMatthew Knepley     (*gsection)->atlasOff[q] = off;
1446ea844a1aSMatthew Knepley     off += (*gsection)->atlasDof[q] > 0 ? (*gsection)->atlasDof[q]-cdof : 0;
1447ea844a1aSMatthew Knepley   }
14489566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Scan(&off, &globalOff, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject) s)));
1449ea844a1aSMatthew Knepley   globalOff -= off;
1450ea844a1aSMatthew Knepley   for (p = 0, off = 0; p < pEnd-pStart; ++p) {
1451ea844a1aSMatthew Knepley     (*gsection)->atlasOff[p] += globalOff;
1452ea844a1aSMatthew Knepley     if (neg) neg[p+pStart] = -((*gsection)->atlasOff[p]+1);
1453ea844a1aSMatthew Knepley   }
14549566063dSJacob Faibussowitsch   if (s->perm) PetscCall(ISRestoreIndices(s->perm, &pind));
1455ea844a1aSMatthew Knepley   /* Put in negative offsets for ghost points */
1456ea844a1aSMatthew Knepley   if (nroots >= 0) {
1457ea844a1aSMatthew Knepley     if (nroots == pEnd-pStart) tmpOff = &(*gsection)->atlasOff[-pStart];
14589566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastBegin(sf, MPIU_INT, neg, tmpOff,MPI_REPLACE));
14599566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastEnd(sf, MPIU_INT, neg, tmpOff,MPI_REPLACE));
1460ea844a1aSMatthew Knepley     if (nroots > pEnd - pStart) {
1461ea844a1aSMatthew Knepley       for (p = pStart; p < pEnd; ++p) {if (tmpOff[p] < 0) (*gsection)->atlasOff[p-pStart] = tmpOff[p];}
1462ea844a1aSMatthew Knepley     }
1463ea844a1aSMatthew Knepley   }
14649566063dSJacob Faibussowitsch   if (nroots >= 0 && nroots > pEnd-pStart) PetscCall(PetscFree(tmpOff));
14659566063dSJacob Faibussowitsch   PetscCall(PetscFree(neg));
1466ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1467ea844a1aSMatthew Knepley }
1468ea844a1aSMatthew Knepley 
1469ea844a1aSMatthew Knepley /*@
1470ea844a1aSMatthew Knepley   PetscSectionGetPointLayout - Get the PetscLayout associated with the section points
1471ea844a1aSMatthew Knepley 
1472ea844a1aSMatthew Knepley   Collective on comm
1473ea844a1aSMatthew Knepley 
1474ea844a1aSMatthew Knepley   Input Parameters:
1475ea844a1aSMatthew Knepley + comm - The MPI_Comm
1476ea844a1aSMatthew Knepley - s    - The PetscSection
1477ea844a1aSMatthew Knepley 
1478ea844a1aSMatthew Knepley   Output Parameter:
1479ea844a1aSMatthew Knepley . layout - The point layout for the section
1480ea844a1aSMatthew Knepley 
14811681d8a4SMatthew Knepley   Note: This is usually called for the default global section.
1482ea844a1aSMatthew Knepley 
1483ea844a1aSMatthew Knepley   Level: advanced
1484ea844a1aSMatthew Knepley 
1485db781477SPatrick Sanan .seealso: `PetscSectionGetValueLayout()`, `PetscSectionCreate()`
1486ea844a1aSMatthew Knepley @*/
1487ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetPointLayout(MPI_Comm comm, PetscSection s, PetscLayout *layout)
1488ea844a1aSMatthew Knepley {
1489ea844a1aSMatthew Knepley   PetscInt       pStart, pEnd, p, localSize = 0;
1490ea844a1aSMatthew Knepley 
1491ea844a1aSMatthew Knepley   PetscFunctionBegin;
14929566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
1493ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
1494ea844a1aSMatthew Knepley     PetscInt dof;
1495ea844a1aSMatthew Knepley 
14969566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s, p, &dof));
14979120ba30SVaclav Hapla     if (dof >= 0) ++localSize;
1498ea844a1aSMatthew Knepley   }
14999566063dSJacob Faibussowitsch   PetscCall(PetscLayoutCreate(comm, layout));
15009566063dSJacob Faibussowitsch   PetscCall(PetscLayoutSetLocalSize(*layout, localSize));
15019566063dSJacob Faibussowitsch   PetscCall(PetscLayoutSetBlockSize(*layout, 1));
15029566063dSJacob Faibussowitsch   PetscCall(PetscLayoutSetUp(*layout));
1503ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1504ea844a1aSMatthew Knepley }
1505ea844a1aSMatthew Knepley 
1506ea844a1aSMatthew Knepley /*@
1507ea844a1aSMatthew Knepley   PetscSectionGetValueLayout - Get the PetscLayout associated with the section dofs.
1508ea844a1aSMatthew Knepley 
1509ea844a1aSMatthew Knepley   Collective on comm
1510ea844a1aSMatthew Knepley 
1511ea844a1aSMatthew Knepley   Input Parameters:
1512ea844a1aSMatthew Knepley + comm - The MPI_Comm
1513ea844a1aSMatthew Knepley - s    - The PetscSection
1514ea844a1aSMatthew Knepley 
1515ea844a1aSMatthew Knepley   Output Parameter:
1516ea844a1aSMatthew Knepley . layout - The dof layout for the section
1517ea844a1aSMatthew Knepley 
1518ea844a1aSMatthew Knepley   Note: This is usually called for the default global section.
1519ea844a1aSMatthew Knepley 
1520ea844a1aSMatthew Knepley   Level: advanced
1521ea844a1aSMatthew Knepley 
1522db781477SPatrick Sanan .seealso: `PetscSectionGetPointLayout()`, `PetscSectionCreate()`
1523ea844a1aSMatthew Knepley @*/
1524ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetValueLayout(MPI_Comm comm, PetscSection s, PetscLayout *layout)
1525ea844a1aSMatthew Knepley {
1526ea844a1aSMatthew Knepley   PetscInt       pStart, pEnd, p, localSize = 0;
1527ea844a1aSMatthew Knepley 
1528ea844a1aSMatthew Knepley   PetscFunctionBegin;
1529ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 2);
1530ea844a1aSMatthew Knepley   PetscValidPointer(layout, 3);
15319566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
1532ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
1533ea844a1aSMatthew Knepley     PetscInt dof,cdof;
1534ea844a1aSMatthew Knepley 
15359566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s, p, &dof));
15369566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s, p, &cdof));
1537ea844a1aSMatthew Knepley     if (dof-cdof > 0) localSize += dof-cdof;
1538ea844a1aSMatthew Knepley   }
15399566063dSJacob Faibussowitsch   PetscCall(PetscLayoutCreate(comm, layout));
15409566063dSJacob Faibussowitsch   PetscCall(PetscLayoutSetLocalSize(*layout, localSize));
15419566063dSJacob Faibussowitsch   PetscCall(PetscLayoutSetBlockSize(*layout, 1));
15429566063dSJacob Faibussowitsch   PetscCall(PetscLayoutSetUp(*layout));
1543ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1544ea844a1aSMatthew Knepley }
1545ea844a1aSMatthew Knepley 
1546ea844a1aSMatthew Knepley /*@
1547ea844a1aSMatthew Knepley   PetscSectionGetOffset - Return the offset into an array or local Vec for the dof associated with the given point.
1548ea844a1aSMatthew Knepley 
154940750d41SVaclav Hapla   Not Collective
1550ea844a1aSMatthew Knepley 
1551ea844a1aSMatthew Knepley   Input Parameters:
1552ea844a1aSMatthew Knepley + s - the PetscSection
1553ea844a1aSMatthew Knepley - point - the point
1554ea844a1aSMatthew Knepley 
1555ea844a1aSMatthew Knepley   Output Parameter:
1556ea844a1aSMatthew Knepley . offset - the offset
1557ea844a1aSMatthew Knepley 
1558ea844a1aSMatthew Knepley   Level: intermediate
1559ea844a1aSMatthew Knepley 
1560db781477SPatrick Sanan .seealso: `PetscSectionGetFieldOffset()`, `PetscSectionCreate()`
1561ea844a1aSMatthew Knepley @*/
1562ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetOffset(PetscSection s, PetscInt point, PetscInt *offset)
1563ea844a1aSMatthew Knepley {
1564ea844a1aSMatthew Knepley   PetscFunctionBegin;
1565ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1566dadcf809SJacob Faibussowitsch   PetscValidIntPointer(offset, 3);
156776bd3646SJed Brown   if (PetscDefined(USE_DEBUG)) {
156808401ef6SPierre Jolivet     PetscCheck(!(point < s->pStart) && !(point >= s->pEnd),PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Section point %" PetscInt_FMT " should be in [%" PetscInt_FMT ", %" PetscInt_FMT ")", point, s->pStart, s->pEnd);
156976bd3646SJed Brown   }
1570ea844a1aSMatthew Knepley   *offset = s->atlasOff[point - s->pStart];
1571ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1572ea844a1aSMatthew Knepley }
1573ea844a1aSMatthew Knepley 
1574ea844a1aSMatthew Knepley /*@
1575ea844a1aSMatthew Knepley   PetscSectionSetOffset - Set the offset into an array or local Vec for the dof associated with the given point.
1576ea844a1aSMatthew Knepley 
157740750d41SVaclav Hapla   Not Collective
1578ea844a1aSMatthew Knepley 
1579ea844a1aSMatthew Knepley   Input Parameters:
1580ea844a1aSMatthew Knepley + s - the PetscSection
1581ea844a1aSMatthew Knepley . point - the point
1582ea844a1aSMatthew Knepley - offset - the offset
1583ea844a1aSMatthew Knepley 
1584ea844a1aSMatthew Knepley   Note: The user usually does not call this function, but uses PetscSectionSetUp()
1585ea844a1aSMatthew Knepley 
1586ea844a1aSMatthew Knepley   Level: intermediate
1587ea844a1aSMatthew Knepley 
1588db781477SPatrick Sanan .seealso: `PetscSectionGetFieldOffset()`, `PetscSectionCreate()`, `PetscSectionSetUp()`
1589ea844a1aSMatthew Knepley @*/
1590ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetOffset(PetscSection s, PetscInt point, PetscInt offset)
1591ea844a1aSMatthew Knepley {
1592ea844a1aSMatthew Knepley   PetscFunctionBegin;
1593ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
159408401ef6SPierre Jolivet   PetscCheck(!(point < s->pStart) && !(point >= s->pEnd),PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Section point %" PetscInt_FMT " should be in [%" PetscInt_FMT ", %" PetscInt_FMT ")", point, s->pStart, s->pEnd);
1595ea844a1aSMatthew Knepley   s->atlasOff[point - s->pStart] = offset;
1596ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1597ea844a1aSMatthew Knepley }
1598ea844a1aSMatthew Knepley 
1599ea844a1aSMatthew Knepley /*@
1600ea844a1aSMatthew Knepley   PetscSectionGetFieldOffset - Return the offset into an array or local Vec for the dof associated with the given point.
1601ea844a1aSMatthew Knepley 
160240750d41SVaclav Hapla   Not Collective
1603ea844a1aSMatthew Knepley 
1604ea844a1aSMatthew Knepley   Input Parameters:
1605ea844a1aSMatthew Knepley + s - the PetscSection
1606ea844a1aSMatthew Knepley . point - the point
1607ea844a1aSMatthew Knepley - field - the field
1608ea844a1aSMatthew Knepley 
1609ea844a1aSMatthew Knepley   Output Parameter:
1610ea844a1aSMatthew Knepley . offset - the offset
1611ea844a1aSMatthew Knepley 
1612ea844a1aSMatthew Knepley   Level: intermediate
1613ea844a1aSMatthew Knepley 
1614db781477SPatrick Sanan .seealso: `PetscSectionGetOffset()`, `PetscSectionCreate()`
1615ea844a1aSMatthew Knepley @*/
1616ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetFieldOffset(PetscSection s, PetscInt point, PetscInt field, PetscInt *offset)
1617ea844a1aSMatthew Knepley {
1618ea844a1aSMatthew Knepley   PetscFunctionBegin;
1619ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
16202abc8c78SJacob Faibussowitsch   PetscValidIntPointer(offset, 4);
16212abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
16229566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(s->field[field], point, offset));
1623ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1624ea844a1aSMatthew Knepley }
1625ea844a1aSMatthew Knepley 
1626ea844a1aSMatthew Knepley /*@
16271681d8a4SMatthew Knepley   PetscSectionSetFieldOffset - Set the offset into an array or local Vec for the dof associated with the given field at a point.
1628ea844a1aSMatthew Knepley 
162940750d41SVaclav Hapla   Not Collective
1630ea844a1aSMatthew Knepley 
1631ea844a1aSMatthew Knepley   Input Parameters:
1632ea844a1aSMatthew Knepley + s - the PetscSection
1633ea844a1aSMatthew Knepley . point - the point
1634ea844a1aSMatthew Knepley . field - the field
1635ea844a1aSMatthew Knepley - offset - the offset
1636ea844a1aSMatthew Knepley 
1637ea844a1aSMatthew Knepley   Note: The user usually does not call this function, but uses PetscSectionSetUp()
1638ea844a1aSMatthew Knepley 
1639ea844a1aSMatthew Knepley   Level: intermediate
1640ea844a1aSMatthew Knepley 
1641db781477SPatrick Sanan .seealso: `PetscSectionGetFieldOffset()`, `PetscSectionSetOffset()`, `PetscSectionCreate()`, `PetscSectionSetUp()`
1642ea844a1aSMatthew Knepley @*/
1643ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetFieldOffset(PetscSection s, PetscInt point, PetscInt field, PetscInt offset)
1644ea844a1aSMatthew Knepley {
1645ea844a1aSMatthew Knepley   PetscFunctionBegin;
1646ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
16472abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
16489566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetOffset(s->field[field], point, offset));
1649ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1650ea844a1aSMatthew Knepley }
1651ea844a1aSMatthew Knepley 
1652ea844a1aSMatthew Knepley /*@
1653ea844a1aSMatthew Knepley   PetscSectionGetFieldPointOffset - Return the offset on the given point for the dof associated with the given point.
1654ea844a1aSMatthew Knepley 
165540750d41SVaclav Hapla   Not Collective
1656ea844a1aSMatthew Knepley 
1657ea844a1aSMatthew Knepley   Input Parameters:
1658ea844a1aSMatthew Knepley + s - the PetscSection
1659ea844a1aSMatthew Knepley . point - the point
1660ea844a1aSMatthew Knepley - field - the field
1661ea844a1aSMatthew Knepley 
1662ea844a1aSMatthew Knepley   Output Parameter:
1663ea844a1aSMatthew Knepley . offset - the offset
1664ea844a1aSMatthew Knepley 
1665ea844a1aSMatthew Knepley   Note: This gives the offset on a point of the field, ignoring constraints, meaning starting at the first dof for
1666ea844a1aSMatthew Knepley         this point, what number is the first dof with this field.
1667ea844a1aSMatthew Knepley 
1668ea844a1aSMatthew Knepley   Level: advanced
1669ea844a1aSMatthew Knepley 
1670db781477SPatrick Sanan .seealso: `PetscSectionGetOffset()`, `PetscSectionCreate()`
1671ea844a1aSMatthew Knepley @*/
1672ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetFieldPointOffset(PetscSection s, PetscInt point, PetscInt field, PetscInt *offset)
1673ea844a1aSMatthew Knepley {
1674ea844a1aSMatthew Knepley   PetscInt       off, foff;
1675ea844a1aSMatthew Knepley 
1676ea844a1aSMatthew Knepley   PetscFunctionBegin;
1677ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
16782abc8c78SJacob Faibussowitsch   PetscValidIntPointer(offset, 4);
16792abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
16809566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(s, point, &off));
16819566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(s->field[field], point, &foff));
1682ea844a1aSMatthew Knepley   *offset = foff - off;
1683ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1684ea844a1aSMatthew Knepley }
1685ea844a1aSMatthew Knepley 
1686ea844a1aSMatthew Knepley /*@
1687ea844a1aSMatthew Knepley   PetscSectionGetOffsetRange - Return the full range of offsets [start, end)
1688ea844a1aSMatthew Knepley 
168940750d41SVaclav Hapla   Not Collective
1690ea844a1aSMatthew Knepley 
1691ea844a1aSMatthew Knepley   Input Parameter:
1692ea844a1aSMatthew Knepley . s - the PetscSection
1693ea844a1aSMatthew Knepley 
1694ea844a1aSMatthew Knepley   Output Parameters:
1695ea844a1aSMatthew Knepley + start - the minimum offset
1696ea844a1aSMatthew Knepley - end   - one more than the maximum offset
1697ea844a1aSMatthew Knepley 
1698ea844a1aSMatthew Knepley   Level: intermediate
1699ea844a1aSMatthew Knepley 
1700db781477SPatrick Sanan .seealso: `PetscSectionGetOffset()`, `PetscSectionCreate()`
1701ea844a1aSMatthew Knepley @*/
1702ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetOffsetRange(PetscSection s, PetscInt *start, PetscInt *end)
1703ea844a1aSMatthew Knepley {
1704ea844a1aSMatthew Knepley   PetscInt       os = 0, oe = 0, pStart, pEnd, p;
1705ea844a1aSMatthew Knepley 
1706ea844a1aSMatthew Knepley   PetscFunctionBegin;
1707ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1708ea844a1aSMatthew Knepley   if (s->atlasOff) {os = s->atlasOff[0]; oe = s->atlasOff[0];}
17099566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
1710ea844a1aSMatthew Knepley   for (p = 0; p < pEnd-pStart; ++p) {
1711ea844a1aSMatthew Knepley     PetscInt dof = s->atlasDof[p], off = s->atlasOff[p];
1712ea844a1aSMatthew Knepley 
1713ea844a1aSMatthew Knepley     if (off >= 0) {
1714ea844a1aSMatthew Knepley       os = PetscMin(os, off);
1715ea844a1aSMatthew Knepley       oe = PetscMax(oe, off+dof);
1716ea844a1aSMatthew Knepley     }
1717ea844a1aSMatthew Knepley   }
1718ea844a1aSMatthew Knepley   if (start) *start = os;
1719ea844a1aSMatthew Knepley   if (end)   *end   = oe;
1720ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1721ea844a1aSMatthew Knepley }
1722ea844a1aSMatthew Knepley 
1723ea844a1aSMatthew Knepley /*@
1724ea844a1aSMatthew Knepley   PetscSectionCreateSubsection - Create a new, smaller section composed of only the selected fields
1725ea844a1aSMatthew Knepley 
172640750d41SVaclav Hapla   Collective
1727ea844a1aSMatthew Knepley 
1728d8d19677SJose E. Roman   Input Parameters:
1729ea844a1aSMatthew Knepley + s      - the PetscSection
1730ea844a1aSMatthew Knepley . len    - the number of subfields
1731ea844a1aSMatthew Knepley - fields - the subfield numbers
1732ea844a1aSMatthew Knepley 
1733ea844a1aSMatthew Knepley   Output Parameter:
1734ea844a1aSMatthew Knepley . subs   - the subsection
1735ea844a1aSMatthew Knepley 
1736ea844a1aSMatthew Knepley   Note: The section offsets now refer to a new, smaller vector.
1737ea844a1aSMatthew Knepley 
1738ea844a1aSMatthew Knepley   Level: advanced
1739ea844a1aSMatthew Knepley 
1740db781477SPatrick Sanan .seealso: `PetscSectionCreateSupersection()`, `PetscSectionCreate()`
1741ea844a1aSMatthew Knepley @*/
1742ea844a1aSMatthew Knepley PetscErrorCode PetscSectionCreateSubsection(PetscSection s, PetscInt len, const PetscInt fields[], PetscSection *subs)
1743ea844a1aSMatthew Knepley {
1744b778fa18SValeria Barra   PetscInt       nF, f, c, pStart, pEnd, p, maxCdof = 0;
1745ea844a1aSMatthew Knepley 
1746ea844a1aSMatthew Knepley   PetscFunctionBegin;
1747ea844a1aSMatthew Knepley   if (!len) PetscFunctionReturn(0);
1748ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1749dadcf809SJacob Faibussowitsch   PetscValidIntPointer(fields, 3);
1750ea844a1aSMatthew Knepley   PetscValidPointer(subs, 4);
17519566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetNumFields(s, &nF));
175208401ef6SPierre Jolivet   PetscCheck(len <= nF,PetscObjectComm((PetscObject) s), PETSC_ERR_ARG_WRONG, "Number of requested fields %" PetscInt_FMT " greater than number of fields %" PetscInt_FMT, len, nF);
17539566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject) s), subs));
17549566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetNumFields(*subs, len));
1755ea844a1aSMatthew Knepley   for (f = 0; f < len; ++f) {
1756ea844a1aSMatthew Knepley     const char *name   = NULL;
1757ea844a1aSMatthew Knepley     PetscInt   numComp = 0;
1758ea844a1aSMatthew Knepley 
17599566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldName(s, fields[f], &name));
17609566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldName(*subs, f, name));
17619566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldComponents(s, fields[f], &numComp));
17629566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldComponents(*subs, f, numComp));
1763b778fa18SValeria Barra     for (c = 0; c < s->numFieldComponents[fields[f]]; ++c) {
17649566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetComponentName(s, fields[f], c, &name));
17659566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetComponentName(*subs, f, c, name));
1766b778fa18SValeria Barra     }
1767ea844a1aSMatthew Knepley   }
17689566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
17699566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(*subs, pStart, pEnd));
1770ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
1771ea844a1aSMatthew Knepley     PetscInt dof = 0, cdof = 0, fdof = 0, cfdof = 0;
1772ea844a1aSMatthew Knepley 
1773ea844a1aSMatthew Knepley     for (f = 0; f < len; ++f) {
17749566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldDof(s, p, fields[f], &fdof));
17759566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldDof(*subs, p, f, fdof));
17769566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintDof(s, p, fields[f], &cfdof));
17779566063dSJacob Faibussowitsch       if (cfdof) PetscCall(PetscSectionSetFieldConstraintDof(*subs, p, f, cfdof));
1778ea844a1aSMatthew Knepley       dof  += fdof;
1779ea844a1aSMatthew Knepley       cdof += cfdof;
1780ea844a1aSMatthew Knepley     }
17819566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(*subs, p, dof));
17829566063dSJacob Faibussowitsch     if (cdof) PetscCall(PetscSectionSetConstraintDof(*subs, p, cdof));
1783ea844a1aSMatthew Knepley     maxCdof = PetscMax(cdof, maxCdof);
1784ea844a1aSMatthew Knepley   }
17859566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(*subs));
1786ea844a1aSMatthew Knepley   if (maxCdof) {
1787ea844a1aSMatthew Knepley     PetscInt *indices;
1788ea844a1aSMatthew Knepley 
17899566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(maxCdof, &indices));
1790ea844a1aSMatthew Knepley     for (p = pStart; p < pEnd; ++p) {
1791ea844a1aSMatthew Knepley       PetscInt cdof;
1792ea844a1aSMatthew Knepley 
17939566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetConstraintDof(*subs, p, &cdof));
1794ea844a1aSMatthew Knepley       if (cdof) {
1795ea844a1aSMatthew Knepley         const PetscInt *oldIndices = NULL;
1796ea844a1aSMatthew Knepley         PetscInt       fdof = 0, cfdof = 0, fc, numConst = 0, fOff = 0;
1797ea844a1aSMatthew Knepley 
1798ea844a1aSMatthew Knepley         for (f = 0; f < len; ++f) {
17999566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetFieldDof(s, p, fields[f], &fdof));
18009566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetFieldConstraintDof(s, p, fields[f], &cfdof));
18019566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetFieldConstraintIndices(s, p, fields[f], &oldIndices));
18029566063dSJacob Faibussowitsch           PetscCall(PetscSectionSetFieldConstraintIndices(*subs, p, f, oldIndices));
18039574d0f0SMatthew G. Knepley           for (fc = 0; fc < cfdof; ++fc) indices[numConst+fc] = oldIndices[fc] + fOff;
1804ea844a1aSMatthew Knepley           numConst += cfdof;
1805ea844a1aSMatthew Knepley           fOff     += fdof;
1806ea844a1aSMatthew Knepley         }
18079566063dSJacob Faibussowitsch         PetscCall(PetscSectionSetConstraintIndices(*subs, p, indices));
1808ea844a1aSMatthew Knepley       }
1809ea844a1aSMatthew Knepley     }
18109566063dSJacob Faibussowitsch     PetscCall(PetscFree(indices));
1811ea844a1aSMatthew Knepley   }
1812ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1813ea844a1aSMatthew Knepley }
1814ea844a1aSMatthew Knepley 
1815ea844a1aSMatthew Knepley /*@
1816ea844a1aSMatthew Knepley   PetscSectionCreateSupersection - Create a new, larger section composed of the input sections
1817ea844a1aSMatthew Knepley 
181840750d41SVaclav Hapla   Collective
1819ea844a1aSMatthew Knepley 
1820ea844a1aSMatthew Knepley   Input Parameters:
1821ea844a1aSMatthew Knepley + s     - the input sections
1822ea844a1aSMatthew Knepley - len   - the number of input sections
1823ea844a1aSMatthew Knepley 
1824ea844a1aSMatthew Knepley   Output Parameter:
1825ea844a1aSMatthew Knepley . supers - the supersection
1826ea844a1aSMatthew Knepley 
1827ea844a1aSMatthew Knepley   Note: The section offsets now refer to a new, larger vector.
1828ea844a1aSMatthew Knepley 
1829ea844a1aSMatthew Knepley   Level: advanced
1830ea844a1aSMatthew Knepley 
1831db781477SPatrick Sanan .seealso: `PetscSectionCreateSubsection()`, `PetscSectionCreate()`
1832ea844a1aSMatthew Knepley @*/
1833ea844a1aSMatthew Knepley PetscErrorCode PetscSectionCreateSupersection(PetscSection s[], PetscInt len, PetscSection *supers)
1834ea844a1aSMatthew Knepley {
1835ea844a1aSMatthew Knepley   PetscInt       Nf = 0, f, pStart = PETSC_MAX_INT, pEnd = 0, p, maxCdof = 0, i;
1836ea844a1aSMatthew Knepley 
1837ea844a1aSMatthew Knepley   PetscFunctionBegin;
1838ea844a1aSMatthew Knepley   if (!len) PetscFunctionReturn(0);
1839ea844a1aSMatthew Knepley   for (i = 0; i < len; ++i) {
1840ea844a1aSMatthew Knepley     PetscInt nf, pStarti, pEndi;
1841ea844a1aSMatthew Knepley 
18429566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetNumFields(s[i], &nf));
18439566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetChart(s[i], &pStarti, &pEndi));
1844ea844a1aSMatthew Knepley     pStart = PetscMin(pStart, pStarti);
1845ea844a1aSMatthew Knepley     pEnd   = PetscMax(pEnd,   pEndi);
1846ea844a1aSMatthew Knepley     Nf += nf;
1847ea844a1aSMatthew Knepley   }
18489566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject) s[0]), supers));
18499566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetNumFields(*supers, Nf));
1850ea844a1aSMatthew Knepley   for (i = 0, f = 0; i < len; ++i) {
1851b778fa18SValeria Barra     PetscInt nf, fi, ci;
1852ea844a1aSMatthew Knepley 
18539566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetNumFields(s[i], &nf));
1854ea844a1aSMatthew Knepley     for (fi = 0; fi < nf; ++fi, ++f) {
1855ea844a1aSMatthew Knepley       const char *name   = NULL;
1856ea844a1aSMatthew Knepley       PetscInt   numComp = 0;
1857ea844a1aSMatthew Knepley 
18589566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldName(s[i], fi, &name));
18599566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldName(*supers, f, name));
18609566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldComponents(s[i], fi, &numComp));
18619566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldComponents(*supers, f, numComp));
1862b778fa18SValeria Barra       for (ci = 0; ci < s[i]->numFieldComponents[fi]; ++ci) {
18639566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetComponentName(s[i], fi, ci, &name));
18649566063dSJacob Faibussowitsch         PetscCall(PetscSectionSetComponentName(*supers, f, ci, name));
1865b778fa18SValeria Barra       }
1866ea844a1aSMatthew Knepley     }
1867ea844a1aSMatthew Knepley   }
18689566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(*supers, pStart, pEnd));
1869ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
1870ea844a1aSMatthew Knepley     PetscInt dof = 0, cdof = 0;
1871ea844a1aSMatthew Knepley 
1872ea844a1aSMatthew Knepley     for (i = 0, f = 0; i < len; ++i) {
1873ea844a1aSMatthew Knepley       PetscInt nf, fi, pStarti, pEndi;
1874ea844a1aSMatthew Knepley       PetscInt fdof = 0, cfdof = 0;
1875ea844a1aSMatthew Knepley 
18769566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetNumFields(s[i], &nf));
18779566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetChart(s[i], &pStarti, &pEndi));
1878ea844a1aSMatthew Knepley       if ((p < pStarti) || (p >= pEndi)) continue;
1879ea844a1aSMatthew Knepley       for (fi = 0; fi < nf; ++fi, ++f) {
18809566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetFieldDof(s[i], p, fi, &fdof));
18819566063dSJacob Faibussowitsch         PetscCall(PetscSectionAddFieldDof(*supers, p, f, fdof));
18829566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetFieldConstraintDof(s[i], p, fi, &cfdof));
18839566063dSJacob Faibussowitsch         if (cfdof) PetscCall(PetscSectionAddFieldConstraintDof(*supers, p, f, cfdof));
1884ea844a1aSMatthew Knepley         dof  += fdof;
1885ea844a1aSMatthew Knepley         cdof += cfdof;
1886ea844a1aSMatthew Knepley       }
1887ea844a1aSMatthew Knepley     }
18889566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(*supers, p, dof));
18899566063dSJacob Faibussowitsch     if (cdof) PetscCall(PetscSectionSetConstraintDof(*supers, p, cdof));
1890ea844a1aSMatthew Knepley     maxCdof = PetscMax(cdof, maxCdof);
1891ea844a1aSMatthew Knepley   }
18929566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(*supers));
1893ea844a1aSMatthew Knepley   if (maxCdof) {
1894ea844a1aSMatthew Knepley     PetscInt *indices;
1895ea844a1aSMatthew Knepley 
18969566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(maxCdof, &indices));
1897ea844a1aSMatthew Knepley     for (p = pStart; p < pEnd; ++p) {
1898ea844a1aSMatthew Knepley       PetscInt cdof;
1899ea844a1aSMatthew Knepley 
19009566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetConstraintDof(*supers, p, &cdof));
1901ea844a1aSMatthew Knepley       if (cdof) {
1902ea844a1aSMatthew Knepley         PetscInt dof, numConst = 0, fOff = 0;
1903ea844a1aSMatthew Knepley 
1904ea844a1aSMatthew Knepley         for (i = 0, f = 0; i < len; ++i) {
1905ea844a1aSMatthew Knepley           const PetscInt *oldIndices = NULL;
1906ea844a1aSMatthew Knepley           PetscInt        nf, fi, pStarti, pEndi, fdof, cfdof, fc;
1907ea844a1aSMatthew Knepley 
19089566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetNumFields(s[i], &nf));
19099566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetChart(s[i], &pStarti, &pEndi));
1910ea844a1aSMatthew Knepley           if ((p < pStarti) || (p >= pEndi)) continue;
1911ea844a1aSMatthew Knepley           for (fi = 0; fi < nf; ++fi, ++f) {
19129566063dSJacob Faibussowitsch             PetscCall(PetscSectionGetFieldDof(s[i], p, fi, &fdof));
19139566063dSJacob Faibussowitsch             PetscCall(PetscSectionGetFieldConstraintDof(s[i], p, fi, &cfdof));
19149566063dSJacob Faibussowitsch             PetscCall(PetscSectionGetFieldConstraintIndices(s[i], p, fi, &oldIndices));
1915fcd2503dSMatthew G. Knepley             for (fc = 0; fc < cfdof; ++fc) indices[numConst+fc] = oldIndices[fc];
19169566063dSJacob Faibussowitsch             PetscCall(PetscSectionSetFieldConstraintIndices(*supers, p, f, &indices[numConst]));
1917fcd2503dSMatthew G. Knepley             for (fc = 0; fc < cfdof; ++fc) indices[numConst+fc] += fOff;
1918ea844a1aSMatthew Knepley             numConst += cfdof;
1919ea844a1aSMatthew Knepley           }
19209566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetDof(s[i], p, &dof));
1921ea844a1aSMatthew Knepley           fOff += dof;
1922ea844a1aSMatthew Knepley         }
19239566063dSJacob Faibussowitsch         PetscCall(PetscSectionSetConstraintIndices(*supers, p, indices));
1924ea844a1aSMatthew Knepley       }
1925ea844a1aSMatthew Knepley     }
19269566063dSJacob Faibussowitsch     PetscCall(PetscFree(indices));
1927ea844a1aSMatthew Knepley   }
1928ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1929ea844a1aSMatthew Knepley }
1930ea844a1aSMatthew Knepley 
193141f23ed0SMatthew G. Knepley PetscErrorCode PetscSectionCreateSubplexSection_Internal(PetscSection s, IS subpointMap, PetscBool renumberPoints, PetscSection *subs)
1932ea844a1aSMatthew Knepley {
1933ea844a1aSMatthew Knepley   const PetscInt *points = NULL, *indices = NULL;
193441f23ed0SMatthew G. Knepley   PetscInt       numFields, f, c, numSubpoints = 0, pStart, pEnd, p, spStart, spEnd, subp;
1935ea844a1aSMatthew Knepley 
1936ea844a1aSMatthew Knepley   PetscFunctionBegin;
1937ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1938ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(subpointMap, IS_CLASSID, 2);
193941f23ed0SMatthew G. Knepley   PetscValidPointer(subs, 4);
19409566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetNumFields(s, &numFields));
19419566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject) s), subs));
19429566063dSJacob Faibussowitsch   if (numFields) PetscCall(PetscSectionSetNumFields(*subs, numFields));
1943ea844a1aSMatthew Knepley   for (f = 0; f < numFields; ++f) {
1944ea844a1aSMatthew Knepley     const char *name   = NULL;
1945ea844a1aSMatthew Knepley     PetscInt   numComp = 0;
1946ea844a1aSMatthew Knepley 
19479566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldName(s, f, &name));
19489566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldName(*subs, f, name));
19499566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldComponents(s, f, &numComp));
19509566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldComponents(*subs, f, numComp));
1951b778fa18SValeria Barra     for (c = 0; c < s->numFieldComponents[f]; ++c) {
19529566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetComponentName(s, f, c, &name));
19539566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetComponentName(*subs, f, c, name));
1954b778fa18SValeria Barra     }
1955ea844a1aSMatthew Knepley   }
1956ea844a1aSMatthew Knepley   /* For right now, we do not try to squeeze the subchart */
1957ea844a1aSMatthew Knepley   if (subpointMap) {
19589566063dSJacob Faibussowitsch     PetscCall(ISGetSize(subpointMap, &numSubpoints));
19599566063dSJacob Faibussowitsch     PetscCall(ISGetIndices(subpointMap, &points));
1960ea844a1aSMatthew Knepley   }
19619566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
196241f23ed0SMatthew G. Knepley   if (renumberPoints) {
196341f23ed0SMatthew G. Knepley     spStart = 0;
196441f23ed0SMatthew G. Knepley     spEnd   = numSubpoints;
196541f23ed0SMatthew G. Knepley   } else {
196641f23ed0SMatthew G. Knepley     PetscCall(ISGetMinMax(subpointMap, &spStart, &spEnd));
196741f23ed0SMatthew G. Knepley     ++spEnd;
196841f23ed0SMatthew G. Knepley   }
196941f23ed0SMatthew G. Knepley   PetscCall(PetscSectionSetChart(*subs, spStart, spEnd));
1970ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
1971ea844a1aSMatthew Knepley     PetscInt dof, cdof, fdof = 0, cfdof = 0;
1972ea844a1aSMatthew Knepley 
19739566063dSJacob Faibussowitsch     PetscCall(PetscFindInt(p, numSubpoints, points, &subp));
1974ea844a1aSMatthew Knepley     if (subp < 0) continue;
197541f23ed0SMatthew G. Knepley     if (!renumberPoints) subp = p;
1976ea844a1aSMatthew Knepley     for (f = 0; f < numFields; ++f) {
19779566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldDof(s, p, f, &fdof));
19789566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldDof(*subs, subp, f, fdof));
19799566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintDof(s, p, f, &cfdof));
19809566063dSJacob Faibussowitsch       if (cfdof) PetscCall(PetscSectionSetFieldConstraintDof(*subs, subp, f, cfdof));
1981ea844a1aSMatthew Knepley     }
19829566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s, p, &dof));
19839566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(*subs, subp, dof));
19849566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s, p, &cdof));
19859566063dSJacob Faibussowitsch     if (cdof) PetscCall(PetscSectionSetConstraintDof(*subs, subp, cdof));
1986ea844a1aSMatthew Knepley   }
19879566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(*subs));
1988ea844a1aSMatthew Knepley   /* Change offsets to original offsets */
1989ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
1990ea844a1aSMatthew Knepley     PetscInt off, foff = 0;
1991ea844a1aSMatthew Knepley 
19929566063dSJacob Faibussowitsch     PetscCall(PetscFindInt(p, numSubpoints, points, &subp));
1993ea844a1aSMatthew Knepley     if (subp < 0) continue;
199441f23ed0SMatthew G. Knepley     if (!renumberPoints) subp = p;
1995ea844a1aSMatthew Knepley     for (f = 0; f < numFields; ++f) {
19969566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldOffset(s, p, f, &foff));
19979566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldOffset(*subs, subp, f, foff));
1998ea844a1aSMatthew Knepley     }
19999566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(s, p, &off));
20009566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetOffset(*subs, subp, off));
2001ea844a1aSMatthew Knepley   }
2002ea844a1aSMatthew Knepley   /* Copy constraint indices */
200341f23ed0SMatthew G. Knepley   for (subp = spStart; subp < spEnd; ++subp) {
2004ea844a1aSMatthew Knepley     PetscInt cdof;
2005ea844a1aSMatthew Knepley 
20069566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(*subs, subp, &cdof));
2007ea844a1aSMatthew Knepley     if (cdof) {
2008ea844a1aSMatthew Knepley       for (f = 0; f < numFields; ++f) {
200941f23ed0SMatthew G. Knepley         PetscCall(PetscSectionGetFieldConstraintIndices(s, points[subp-spStart], f, &indices));
20109566063dSJacob Faibussowitsch         PetscCall(PetscSectionSetFieldConstraintIndices(*subs, subp, f, indices));
2011ea844a1aSMatthew Knepley       }
201241f23ed0SMatthew G. Knepley       PetscCall(PetscSectionGetConstraintIndices(s, points[subp-spStart], &indices));
20139566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetConstraintIndices(*subs, subp, indices));
2014ea844a1aSMatthew Knepley     }
2015ea844a1aSMatthew Knepley   }
20169566063dSJacob Faibussowitsch   if (subpointMap) PetscCall(ISRestoreIndices(subpointMap, &points));
2017ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2018ea844a1aSMatthew Knepley }
2019ea844a1aSMatthew Knepley 
202041f23ed0SMatthew G. Knepley /*@
202141f23ed0SMatthew G. Knepley   PetscSectionCreateSubmeshSection - Create a new, smaller section with support on the submesh
202241f23ed0SMatthew G. Knepley 
202341f23ed0SMatthew G. Knepley   Collective on s
202441f23ed0SMatthew G. Knepley 
202541f23ed0SMatthew G. Knepley   Input Parameters:
202641f23ed0SMatthew G. Knepley + s           - the PetscSection
202741f23ed0SMatthew G. Knepley - subpointMap - a sorted list of points in the original mesh which are in the submesh
202841f23ed0SMatthew G. Knepley 
202941f23ed0SMatthew G. Knepley   Output Parameter:
203041f23ed0SMatthew G. Knepley . subs - the subsection
203141f23ed0SMatthew G. Knepley 
203241f23ed0SMatthew G. Knepley   Note:
203341f23ed0SMatthew G. Knepley   The points are renumbered from 0, and the section offsets now refer to a new, smaller vector.
203441f23ed0SMatthew G. Knepley 
203541f23ed0SMatthew G. Knepley   Level: advanced
203641f23ed0SMatthew G. Knepley 
2037db781477SPatrick Sanan .seealso: `PetscSectionCreateSubdomainSection()`, `PetscSectionCreateSubsection()`, `DMPlexGetSubpointMap()`, `PetscSectionCreate()`
203841f23ed0SMatthew G. Knepley @*/
203941f23ed0SMatthew G. Knepley PetscErrorCode PetscSectionCreateSubmeshSection(PetscSection s, IS subpointMap, PetscSection *subs)
204041f23ed0SMatthew G. Knepley {
204141f23ed0SMatthew G. Knepley   PetscFunctionBegin;
204241f23ed0SMatthew G. Knepley   PetscCall(PetscSectionCreateSubplexSection_Internal(s, subpointMap, PETSC_TRUE, subs));
204341f23ed0SMatthew G. Knepley   PetscFunctionReturn(0);
204441f23ed0SMatthew G. Knepley }
204541f23ed0SMatthew G. Knepley 
204641f23ed0SMatthew G. Knepley /*@
204741f23ed0SMatthew G. Knepley   PetscSectionCreateSubdomainSection - Create a new, smaller section with support on a subdomain of the mesh
204841f23ed0SMatthew G. Knepley 
204941f23ed0SMatthew G. Knepley   Collective on s
205041f23ed0SMatthew G. Knepley 
205141f23ed0SMatthew G. Knepley   Input Parameters:
205241f23ed0SMatthew G. Knepley + s           - the PetscSection
205341f23ed0SMatthew G. Knepley - subpointMap - a sorted list of points in the original mesh which are in the subdomain
205441f23ed0SMatthew G. Knepley 
205541f23ed0SMatthew G. Knepley   Output Parameter:
205641f23ed0SMatthew G. Knepley . subs - the subsection
205741f23ed0SMatthew G. Knepley 
205841f23ed0SMatthew G. Knepley   Note:
205941f23ed0SMatthew G. Knepley   The point numbers remain the same, but the section offsets now refer to a new, smaller vector.
206041f23ed0SMatthew G. Knepley 
206141f23ed0SMatthew G. Knepley   Level: advanced
206241f23ed0SMatthew G. Knepley 
2063db781477SPatrick Sanan .seealso: `PetscSectionCreateSubmeshSection()`, `PetscSectionCreateSubsection()`, `DMPlexGetSubpointMap()`, `PetscSectionCreate()`
206441f23ed0SMatthew G. Knepley @*/
206541f23ed0SMatthew G. Knepley PetscErrorCode PetscSectionCreateSubdomainSection(PetscSection s, IS subpointMap, PetscSection *subs)
206641f23ed0SMatthew G. Knepley {
206741f23ed0SMatthew G. Knepley   PetscFunctionBegin;
206841f23ed0SMatthew G. Knepley   PetscCall(PetscSectionCreateSubplexSection_Internal(s, subpointMap, PETSC_FALSE, subs));
206941f23ed0SMatthew G. Knepley   PetscFunctionReturn(0);
207041f23ed0SMatthew G. Knepley }
207141f23ed0SMatthew G. Knepley 
2072ea844a1aSMatthew Knepley static PetscErrorCode PetscSectionView_ASCII(PetscSection s, PetscViewer viewer)
2073ea844a1aSMatthew Knepley {
2074ea844a1aSMatthew Knepley   PetscInt       p;
2075ea844a1aSMatthew Knepley   PetscMPIInt    rank;
2076ea844a1aSMatthew Knepley 
2077ea844a1aSMatthew Knepley   PetscFunctionBegin;
20789566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(PetscObjectComm((PetscObject)viewer), &rank));
20799566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPushSynchronized(viewer));
20809566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "Process %d:\n", rank));
2081ea844a1aSMatthew Knepley   for (p = 0; p < s->pEnd - s->pStart; ++p) {
2082ea844a1aSMatthew Knepley     if ((s->bc) && (s->bc->atlasDof[p] > 0)) {
2083ea844a1aSMatthew Knepley       PetscInt b;
2084ea844a1aSMatthew Knepley 
20859566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "  (%4" PetscInt_FMT ") dim %2" PetscInt_FMT " offset %3" PetscInt_FMT " constrained", p+s->pStart, s->atlasDof[p], s->atlasOff[p]));
2086083401c6SMatthew G. Knepley       if (s->bcIndices) {
2087ea844a1aSMatthew Knepley         for (b = 0; b < s->bc->atlasDof[p]; ++b) {
20889566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, " %" PetscInt_FMT, s->bcIndices[s->bc->atlasOff[p]+b]));
2089ea844a1aSMatthew Knepley         }
2090083401c6SMatthew G. Knepley       }
20919566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "\n"));
2092ea844a1aSMatthew Knepley     } else {
20939566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "  (%4" PetscInt_FMT ") dim %2" PetscInt_FMT " offset %3" PetscInt_FMT "\n", p+s->pStart, s->atlasDof[p], s->atlasOff[p]));
2094ea844a1aSMatthew Knepley     }
2095ea844a1aSMatthew Knepley   }
20969566063dSJacob Faibussowitsch   PetscCall(PetscViewerFlush(viewer));
20979566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPopSynchronized(viewer));
2098ea844a1aSMatthew Knepley   if (s->sym) {
20999566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPushTab(viewer));
21009566063dSJacob Faibussowitsch     PetscCall(PetscSectionSymView(s->sym,viewer));
21019566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopTab(viewer));
2102ea844a1aSMatthew Knepley   }
2103ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2104ea844a1aSMatthew Knepley }
2105ea844a1aSMatthew Knepley 
2106ea844a1aSMatthew Knepley /*@C
2107fe2efc57SMark    PetscSectionViewFromOptions - View from Options
2108fe2efc57SMark 
210940750d41SVaclav Hapla    Collective
2110fe2efc57SMark 
2111fe2efc57SMark    Input Parameters:
2112fe2efc57SMark +  A - the PetscSection object to view
2113736c3998SJose E. Roman .  obj - Optional object
2114736c3998SJose E. Roman -  name - command line option
2115fe2efc57SMark 
2116fe2efc57SMark    Level: intermediate
2117db781477SPatrick Sanan .seealso: `PetscSection`, `PetscSectionView`, `PetscObjectViewFromOptions()`, `PetscSectionCreate()`
2118fe2efc57SMark @*/
2119fe2efc57SMark PetscErrorCode  PetscSectionViewFromOptions(PetscSection A,PetscObject obj,const char name[])
2120fe2efc57SMark {
2121fe2efc57SMark   PetscFunctionBegin;
2122fe2efc57SMark   PetscValidHeaderSpecific(A,PETSC_SECTION_CLASSID,1);
21239566063dSJacob Faibussowitsch   PetscCall(PetscObjectViewFromOptions((PetscObject)A,obj,name));
2124fe2efc57SMark   PetscFunctionReturn(0);
2125fe2efc57SMark }
2126fe2efc57SMark 
2127fe2efc57SMark /*@C
2128ea844a1aSMatthew Knepley   PetscSectionView - Views a PetscSection
2129ea844a1aSMatthew Knepley 
213040750d41SVaclav Hapla   Collective
2131ea844a1aSMatthew Knepley 
2132ea844a1aSMatthew Knepley   Input Parameters:
2133ea844a1aSMatthew Knepley + s - the PetscSection object to view
2134ea844a1aSMatthew Knepley - v - the viewer
2135ea844a1aSMatthew Knepley 
21361ddd528eSksagiyam   Note:
21371ddd528eSksagiyam   PetscSectionView(), when viewer is of type PETSCVIEWERHDF5, only saves
21381ddd528eSksagiyam   distribution independent data, such as dofs, offsets, constraint dofs,
21391ddd528eSksagiyam   and constraint indices. Points that have negative dofs, for instance,
21401ddd528eSksagiyam   are not saved as they represent points owned by other processes.
21411ddd528eSksagiyam   Point numbering and rank assignment is currently not stored.
21421ddd528eSksagiyam   The saved section can be loaded with PetscSectionLoad().
21431ddd528eSksagiyam 
2144ea844a1aSMatthew Knepley   Level: beginner
2145ea844a1aSMatthew Knepley 
2146db781477SPatrick Sanan .seealso `PetscSectionCreate()`, `PetscSectionDestroy()`, `PetscSectionLoad()`
2147ea844a1aSMatthew Knepley @*/
2148ea844a1aSMatthew Knepley PetscErrorCode PetscSectionView(PetscSection s, PetscViewer viewer)
2149ea844a1aSMatthew Knepley {
21501ddd528eSksagiyam   PetscBool      isascii, ishdf5;
2151ea844a1aSMatthew Knepley   PetscInt       f;
2152ea844a1aSMatthew Knepley 
2153ea844a1aSMatthew Knepley   PetscFunctionBegin;
2154ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
21559566063dSJacob Faibussowitsch   if (!viewer) PetscCall(PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)s), &viewer));
2156ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(viewer, PETSC_VIEWER_CLASSID, 2);
21579566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject) viewer, PETSCVIEWERASCII, &isascii));
21589566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject) viewer, PETSCVIEWERHDF5, &ishdf5));
2159ea844a1aSMatthew Knepley   if (isascii) {
21609566063dSJacob Faibussowitsch     PetscCall(PetscObjectPrintClassNamePrefixType((PetscObject)s,viewer));
2161ea844a1aSMatthew Knepley     if (s->numFields) {
21629566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "%" PetscInt_FMT " fields\n", s->numFields));
2163ea844a1aSMatthew Knepley       for (f = 0; f < s->numFields; ++f) {
21649566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  field %" PetscInt_FMT " with %" PetscInt_FMT " components\n", f, s->numFieldComponents[f]));
21659566063dSJacob Faibussowitsch         PetscCall(PetscSectionView_ASCII(s->field[f], viewer));
2166ea844a1aSMatthew Knepley       }
2167ea844a1aSMatthew Knepley     } else {
21689566063dSJacob Faibussowitsch       PetscCall(PetscSectionView_ASCII(s, viewer));
2169ea844a1aSMatthew Knepley     }
21701ddd528eSksagiyam   } else if (ishdf5) {
21711ddd528eSksagiyam #if PetscDefined(HAVE_HDF5)
21729566063dSJacob Faibussowitsch     PetscCall(PetscSectionView_HDF5_Internal(s, viewer));
21731ddd528eSksagiyam #else
21741ddd528eSksagiyam     SETERRQ(PetscObjectComm((PetscObject) s), PETSC_ERR_SUP, "HDF5 not supported in this build.\nPlease reconfigure using --download-hdf5");
21751ddd528eSksagiyam #endif
2176ea844a1aSMatthew Knepley   }
2177ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2178ea844a1aSMatthew Knepley }
2179ea844a1aSMatthew Knepley 
2180fde5e3acSksagiyam /*@C
2181fde5e3acSksagiyam   PetscSectionLoad - Loads a PetscSection
2182fde5e3acSksagiyam 
218340750d41SVaclav Hapla   Collective
2184fde5e3acSksagiyam 
2185fde5e3acSksagiyam   Input Parameters:
2186fde5e3acSksagiyam + s - the PetscSection object to load
2187fde5e3acSksagiyam - v - the viewer
2188fde5e3acSksagiyam 
2189fde5e3acSksagiyam   Note:
2190fde5e3acSksagiyam   PetscSectionLoad(), when viewer is of type PETSCVIEWERHDF5, loads
2191fde5e3acSksagiyam   a section saved with PetscSectionView(). The number of processes
2192fde5e3acSksagiyam   used here (N) does not need to be the same as that used when saving.
2193fde5e3acSksagiyam   After calling this function, the chart of s on rank i will be set
2194fde5e3acSksagiyam   to [0, E_i), where \sum_{i=0}^{N-1}E_i equals to the total number of
2195fde5e3acSksagiyam   saved section points.
2196fde5e3acSksagiyam 
2197fde5e3acSksagiyam   Level: beginner
2198fde5e3acSksagiyam 
2199db781477SPatrick Sanan .seealso `PetscSectionCreate()`, `PetscSectionDestroy()`, `PetscSectionView()`
2200fde5e3acSksagiyam @*/
2201fde5e3acSksagiyam PetscErrorCode PetscSectionLoad(PetscSection s, PetscViewer viewer)
2202fde5e3acSksagiyam {
2203fde5e3acSksagiyam   PetscBool      ishdf5;
2204fde5e3acSksagiyam 
2205fde5e3acSksagiyam   PetscFunctionBegin;
2206fde5e3acSksagiyam   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2207fde5e3acSksagiyam   PetscValidHeaderSpecific(viewer, PETSC_VIEWER_CLASSID, 2);
22089566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject) viewer, PETSCVIEWERHDF5, &ishdf5));
2209fde5e3acSksagiyam   if (ishdf5) {
2210fde5e3acSksagiyam #if PetscDefined(HAVE_HDF5)
22119566063dSJacob Faibussowitsch     PetscCall(PetscSectionLoad_HDF5_Internal(s, viewer));
2212fde5e3acSksagiyam     PetscFunctionReturn(0);
2213fde5e3acSksagiyam #else
2214fde5e3acSksagiyam     SETERRQ(PetscObjectComm((PetscObject) s), PETSC_ERR_SUP, "HDF5 not supported in this build.\nPlease reconfigure using --download-hdf5");
2215fde5e3acSksagiyam #endif
221698921bdaSJacob Faibussowitsch   } else SETERRQ(PetscObjectComm((PetscObject) s), PETSC_ERR_SUP, "Viewer type %s not yet supported for PetscSection loading", ((PetscObject)viewer)->type_name);
2217fde5e3acSksagiyam }
2218fde5e3acSksagiyam 
2219c459fbc1SJed Brown static PetscErrorCode PetscSectionResetClosurePermutation(PetscSection section)
2220c459fbc1SJed Brown {
2221c459fbc1SJed Brown   PetscSectionClosurePermVal clVal;
2222c459fbc1SJed Brown 
2223c459fbc1SJed Brown   PetscFunctionBegin;
2224c459fbc1SJed Brown   if (!section->clHash) PetscFunctionReturn(0);
2225c459fbc1SJed Brown   kh_foreach_value(section->clHash, clVal, {
22269566063dSJacob Faibussowitsch       PetscCall(PetscFree(clVal.perm));
22279566063dSJacob Faibussowitsch       PetscCall(PetscFree(clVal.invPerm));
2228c459fbc1SJed Brown     });
2229c459fbc1SJed Brown   kh_destroy(ClPerm, section->clHash);
2230c459fbc1SJed Brown   section->clHash = NULL;
2231c459fbc1SJed Brown   PetscFunctionReturn(0);
2232c459fbc1SJed Brown }
2233c459fbc1SJed Brown 
2234ea844a1aSMatthew Knepley /*@
2235ea844a1aSMatthew Knepley   PetscSectionReset - Frees all section data.
2236ea844a1aSMatthew Knepley 
223740750d41SVaclav Hapla   Not Collective
2238ea844a1aSMatthew Knepley 
2239ea844a1aSMatthew Knepley   Input Parameters:
2240ea844a1aSMatthew Knepley . s - the PetscSection
2241ea844a1aSMatthew Knepley 
2242ea844a1aSMatthew Knepley   Level: beginner
2243ea844a1aSMatthew Knepley 
2244db781477SPatrick Sanan .seealso: `PetscSection`, `PetscSectionCreate()`
2245ea844a1aSMatthew Knepley @*/
2246ea844a1aSMatthew Knepley PetscErrorCode PetscSectionReset(PetscSection s)
2247ea844a1aSMatthew Knepley {
2248b778fa18SValeria Barra   PetscInt       f, c;
2249ea844a1aSMatthew Knepley 
2250ea844a1aSMatthew Knepley   PetscFunctionBegin;
2251ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2252ea844a1aSMatthew Knepley   for (f = 0; f < s->numFields; ++f) {
22539566063dSJacob Faibussowitsch     PetscCall(PetscSectionDestroy(&s->field[f]));
22549566063dSJacob Faibussowitsch     PetscCall(PetscFree(s->fieldNames[f]));
2255b146d1acSSatish Balay     for (c = 0; c < s->numFieldComponents[f]; ++c) {
22569566063dSJacob Faibussowitsch       PetscCall(PetscFree(s->compNames[f][c]));
2257b146d1acSSatish Balay     }
22589566063dSJacob Faibussowitsch     PetscCall(PetscFree(s->compNames[f]));
2259ea844a1aSMatthew Knepley   }
22609566063dSJacob Faibussowitsch   PetscCall(PetscFree(s->numFieldComponents));
22619566063dSJacob Faibussowitsch   PetscCall(PetscFree(s->fieldNames));
22629566063dSJacob Faibussowitsch   PetscCall(PetscFree(s->compNames));
22639566063dSJacob Faibussowitsch   PetscCall(PetscFree(s->field));
22649566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&s->bc));
22659566063dSJacob Faibussowitsch   PetscCall(PetscFree(s->bcIndices));
22669566063dSJacob Faibussowitsch   PetscCall(PetscFree2(s->atlasDof, s->atlasOff));
22679566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&s->clSection));
22689566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&s->clPoints));
22699566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&s->perm));
22709566063dSJacob Faibussowitsch   PetscCall(PetscSectionResetClosurePermutation(s));
22719566063dSJacob Faibussowitsch   PetscCall(PetscSectionSymDestroy(&s->sym));
22729566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&s->clSection));
22739566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&s->clPoints));
227469c11d05SVaclav Hapla   PetscCall(PetscSectionInvalidateMaxDof_Internal(s));
2275ea844a1aSMatthew Knepley   s->pStart    = -1;
2276ea844a1aSMatthew Knepley   s->pEnd      = -1;
2277ea844a1aSMatthew Knepley   s->maxDof    = 0;
2278ea844a1aSMatthew Knepley   s->setup     = PETSC_FALSE;
2279ea844a1aSMatthew Knepley   s->numFields = 0;
2280ea844a1aSMatthew Knepley   s->clObj     = NULL;
2281ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2282ea844a1aSMatthew Knepley }
2283ea844a1aSMatthew Knepley 
2284ea844a1aSMatthew Knepley /*@
2285ea844a1aSMatthew Knepley   PetscSectionDestroy - Frees a section object and frees its range if that exists.
2286ea844a1aSMatthew Knepley 
228740750d41SVaclav Hapla   Not Collective
2288ea844a1aSMatthew Knepley 
2289ea844a1aSMatthew Knepley   Input Parameters:
2290ea844a1aSMatthew Knepley . s - the PetscSection
2291ea844a1aSMatthew Knepley 
2292ea844a1aSMatthew Knepley   Level: beginner
2293ea844a1aSMatthew Knepley 
2294db781477SPatrick Sanan .seealso: `PetscSection`, `PetscSectionCreate()`
2295ea844a1aSMatthew Knepley @*/
2296ea844a1aSMatthew Knepley PetscErrorCode PetscSectionDestroy(PetscSection *s)
2297ea844a1aSMatthew Knepley {
2298ea844a1aSMatthew Knepley   PetscFunctionBegin;
2299ea844a1aSMatthew Knepley   if (!*s) PetscFunctionReturn(0);
230062f17a49SStefano Zampini   PetscValidHeaderSpecific(*s,PETSC_SECTION_CLASSID,1);
2301ea844a1aSMatthew Knepley   if (--((PetscObject)(*s))->refct > 0) {
2302ea844a1aSMatthew Knepley     *s = NULL;
2303ea844a1aSMatthew Knepley     PetscFunctionReturn(0);
2304ea844a1aSMatthew Knepley   }
23059566063dSJacob Faibussowitsch   PetscCall(PetscSectionReset(*s));
23069566063dSJacob Faibussowitsch   PetscCall(PetscHeaderDestroy(s));
2307ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2308ea844a1aSMatthew Knepley }
2309ea844a1aSMatthew Knepley 
2310ea844a1aSMatthew Knepley PetscErrorCode VecIntGetValuesSection(PetscInt *baseArray, PetscSection s, PetscInt point, const PetscInt **values)
2311ea844a1aSMatthew Knepley {
2312ea844a1aSMatthew Knepley   const PetscInt p = point - s->pStart;
2313ea844a1aSMatthew Knepley 
2314ea844a1aSMatthew Knepley   PetscFunctionBegin;
2315ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 2);
2316ea844a1aSMatthew Knepley   *values = &baseArray[s->atlasOff[p]];
2317ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2318ea844a1aSMatthew Knepley }
2319ea844a1aSMatthew Knepley 
2320ea844a1aSMatthew Knepley PetscErrorCode VecIntSetValuesSection(PetscInt *baseArray, PetscSection s, PetscInt point, const PetscInt values[], InsertMode mode)
2321ea844a1aSMatthew Knepley {
2322ea844a1aSMatthew Knepley   PetscInt       *array;
2323ea844a1aSMatthew Knepley   const PetscInt p           = point - s->pStart;
2324ea844a1aSMatthew Knepley   const PetscInt orientation = 0; /* Needs to be included for use in closure operations */
2325ea844a1aSMatthew Knepley   PetscInt       cDim        = 0;
2326ea844a1aSMatthew Knepley 
2327ea844a1aSMatthew Knepley   PetscFunctionBegin;
2328ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 2);
23299566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstraintDof(s, p, &cDim));
2330ea844a1aSMatthew Knepley   array = &baseArray[s->atlasOff[p]];
2331ea844a1aSMatthew Knepley   if (!cDim) {
2332ea844a1aSMatthew Knepley     if (orientation >= 0) {
2333ea844a1aSMatthew Knepley       const PetscInt dim = s->atlasDof[p];
2334ea844a1aSMatthew Knepley       PetscInt       i;
2335ea844a1aSMatthew Knepley 
2336ea844a1aSMatthew Knepley       if (mode == INSERT_VALUES) {
2337ea844a1aSMatthew Knepley         for (i = 0; i < dim; ++i) array[i] = values[i];
2338ea844a1aSMatthew Knepley       } else {
2339ea844a1aSMatthew Knepley         for (i = 0; i < dim; ++i) array[i] += values[i];
2340ea844a1aSMatthew Knepley       }
2341ea844a1aSMatthew Knepley     } else {
2342ea844a1aSMatthew Knepley       PetscInt offset = 0;
2343ea844a1aSMatthew Knepley       PetscInt j      = -1, field, i;
2344ea844a1aSMatthew Knepley 
2345ea844a1aSMatthew Knepley       for (field = 0; field < s->numFields; ++field) {
2346ea844a1aSMatthew Knepley         const PetscInt dim = s->field[field]->atlasDof[p];
2347ea844a1aSMatthew Knepley 
2348ea844a1aSMatthew Knepley         for (i = dim-1; i >= 0; --i) array[++j] = values[i+offset];
2349ea844a1aSMatthew Knepley         offset += dim;
2350ea844a1aSMatthew Knepley       }
2351ea844a1aSMatthew Knepley     }
2352ea844a1aSMatthew Knepley   } else {
2353ea844a1aSMatthew Knepley     if (orientation >= 0) {
2354ea844a1aSMatthew Knepley       const PetscInt dim  = s->atlasDof[p];
2355ea844a1aSMatthew Knepley       PetscInt       cInd = 0, i;
2356ea844a1aSMatthew Knepley       const PetscInt *cDof;
2357ea844a1aSMatthew Knepley 
23589566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetConstraintIndices(s, point, &cDof));
2359ea844a1aSMatthew Knepley       if (mode == INSERT_VALUES) {
2360ea844a1aSMatthew Knepley         for (i = 0; i < dim; ++i) {
2361ea844a1aSMatthew Knepley           if ((cInd < cDim) && (i == cDof[cInd])) {++cInd; continue;}
2362ea844a1aSMatthew Knepley           array[i] = values[i];
2363ea844a1aSMatthew Knepley         }
2364ea844a1aSMatthew Knepley       } else {
2365ea844a1aSMatthew Knepley         for (i = 0; i < dim; ++i) {
2366ea844a1aSMatthew Knepley           if ((cInd < cDim) && (i == cDof[cInd])) {++cInd; continue;}
2367ea844a1aSMatthew Knepley           array[i] += values[i];
2368ea844a1aSMatthew Knepley         }
2369ea844a1aSMatthew Knepley       }
2370ea844a1aSMatthew Knepley     } else {
2371ea844a1aSMatthew Knepley       const PetscInt *cDof;
2372ea844a1aSMatthew Knepley       PetscInt       offset  = 0;
2373ea844a1aSMatthew Knepley       PetscInt       cOffset = 0;
2374ea844a1aSMatthew Knepley       PetscInt       j       = 0, field;
2375ea844a1aSMatthew Knepley 
23769566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetConstraintIndices(s, point, &cDof));
2377ea844a1aSMatthew Knepley       for (field = 0; field < s->numFields; ++field) {
2378ea844a1aSMatthew Knepley         const PetscInt dim  = s->field[field]->atlasDof[p];     /* PetscSectionGetFieldDof() */
2379ea844a1aSMatthew Knepley         const PetscInt tDim = s->field[field]->bc->atlasDof[p]; /* PetscSectionGetFieldConstraintDof() */
2380ea844a1aSMatthew Knepley         const PetscInt sDim = dim - tDim;
2381ea844a1aSMatthew Knepley         PetscInt       cInd = 0, i,k;
2382ea844a1aSMatthew Knepley 
2383ea844a1aSMatthew Knepley         for (i = 0, k = dim+offset-1; i < dim; ++i, ++j, --k) {
2384ea844a1aSMatthew Knepley           if ((cInd < sDim) && (j == cDof[cInd+cOffset])) {++cInd; continue;}
2385ea844a1aSMatthew Knepley           array[j] = values[k];
2386ea844a1aSMatthew Knepley         }
2387ea844a1aSMatthew Knepley         offset  += dim;
2388ea844a1aSMatthew Knepley         cOffset += dim - tDim;
2389ea844a1aSMatthew Knepley       }
2390ea844a1aSMatthew Knepley     }
2391ea844a1aSMatthew Knepley   }
2392ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2393ea844a1aSMatthew Knepley }
2394ea844a1aSMatthew Knepley 
2395ea844a1aSMatthew Knepley /*@C
2396ea844a1aSMatthew Knepley   PetscSectionHasConstraints - Determine whether a section has constrained dofs
2397ea844a1aSMatthew Knepley 
239840750d41SVaclav Hapla   Not Collective
2399ea844a1aSMatthew Knepley 
2400ea844a1aSMatthew Knepley   Input Parameter:
2401ea844a1aSMatthew Knepley . s - The PetscSection
2402ea844a1aSMatthew Knepley 
2403ea844a1aSMatthew Knepley   Output Parameter:
2404ea844a1aSMatthew Knepley . hasConstraints - flag indicating that the section has constrained dofs
2405ea844a1aSMatthew Knepley 
2406ea844a1aSMatthew Knepley   Level: intermediate
2407ea844a1aSMatthew Knepley 
2408db781477SPatrick Sanan .seealso: `PetscSectionSetConstraintIndices()`, `PetscSectionGetConstraintDof()`, `PetscSection`
2409ea844a1aSMatthew Knepley @*/
2410ea844a1aSMatthew Knepley PetscErrorCode PetscSectionHasConstraints(PetscSection s, PetscBool *hasConstraints)
2411ea844a1aSMatthew Knepley {
2412ea844a1aSMatthew Knepley   PetscFunctionBegin;
2413ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2414dadcf809SJacob Faibussowitsch   PetscValidBoolPointer(hasConstraints, 2);
2415ea844a1aSMatthew Knepley   *hasConstraints = s->bc ? PETSC_TRUE : PETSC_FALSE;
2416ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2417ea844a1aSMatthew Knepley }
2418ea844a1aSMatthew Knepley 
2419ea844a1aSMatthew Knepley /*@C
2420ea844a1aSMatthew Knepley   PetscSectionGetConstraintIndices - Get the point dof numbers, in [0, dof), which are constrained
2421ea844a1aSMatthew Knepley 
242240750d41SVaclav Hapla   Not Collective
2423ea844a1aSMatthew Knepley 
2424ea844a1aSMatthew Knepley   Input Parameters:
2425ea844a1aSMatthew Knepley + s     - The PetscSection
2426ea844a1aSMatthew Knepley - point - The point
2427ea844a1aSMatthew Knepley 
2428ea844a1aSMatthew Knepley   Output Parameter:
2429ea844a1aSMatthew Knepley . indices - The constrained dofs
2430ea844a1aSMatthew Knepley 
2431ea844a1aSMatthew Knepley   Note: In Fortran, you call PetscSectionGetConstraintIndicesF90() and PetscSectionRestoreConstraintIndicesF90()
2432ea844a1aSMatthew Knepley 
2433ea844a1aSMatthew Knepley   Level: intermediate
2434ea844a1aSMatthew Knepley 
2435db781477SPatrick Sanan .seealso: `PetscSectionSetConstraintIndices()`, `PetscSectionGetConstraintDof()`, `PetscSection`
2436ea844a1aSMatthew Knepley @*/
2437ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetConstraintIndices(PetscSection s, PetscInt point, const PetscInt **indices)
2438ea844a1aSMatthew Knepley {
2439ea844a1aSMatthew Knepley   PetscFunctionBegin;
2440ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2441ea844a1aSMatthew Knepley   if (s->bc) {
24429566063dSJacob Faibussowitsch     PetscCall(VecIntGetValuesSection(s->bcIndices, s->bc, point, indices));
2443ea844a1aSMatthew Knepley   } else *indices = NULL;
2444ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2445ea844a1aSMatthew Knepley }
2446ea844a1aSMatthew Knepley 
2447ea844a1aSMatthew Knepley /*@C
2448ea844a1aSMatthew Knepley   PetscSectionSetConstraintIndices - Set the point dof numbers, in [0, dof), which are constrained
2449ea844a1aSMatthew Knepley 
245040750d41SVaclav Hapla   Not Collective
2451ea844a1aSMatthew Knepley 
2452ea844a1aSMatthew Knepley   Input Parameters:
2453ea844a1aSMatthew Knepley + s     - The PetscSection
2454ea844a1aSMatthew Knepley . point - The point
2455ea844a1aSMatthew Knepley - indices - The constrained dofs
2456ea844a1aSMatthew Knepley 
2457ea844a1aSMatthew Knepley   Note: The Fortran is PetscSectionSetConstraintIndicesF90()
2458ea844a1aSMatthew Knepley 
2459ea844a1aSMatthew Knepley   Level: intermediate
2460ea844a1aSMatthew Knepley 
2461db781477SPatrick Sanan .seealso: `PetscSectionGetConstraintIndices()`, `PetscSectionGetConstraintDof()`, `PetscSection`
2462ea844a1aSMatthew Knepley @*/
2463ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetConstraintIndices(PetscSection s, PetscInt point, const PetscInt indices[])
2464ea844a1aSMatthew Knepley {
2465ea844a1aSMatthew Knepley   PetscFunctionBegin;
2466ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2467ea844a1aSMatthew Knepley   if (s->bc) {
2468d57bb9dbSMatthew G. Knepley     const PetscInt dof  = s->atlasDof[point];
2469d57bb9dbSMatthew G. Knepley     const PetscInt cdof = s->bc->atlasDof[point];
2470d57bb9dbSMatthew G. Knepley     PetscInt       d;
2471d57bb9dbSMatthew G. Knepley 
2472d57bb9dbSMatthew G. Knepley     for (d = 0; d < cdof; ++d) {
2473e2bfaee7SMatthew G. Knepley       PetscCheck(indices[d] < dof,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Point %" PetscInt_FMT " dof %" PetscInt_FMT ", invalid constraint index[%" PetscInt_FMT "]: %" PetscInt_FMT, point, dof, d, indices[d]);
2474d57bb9dbSMatthew G. Knepley     }
24759566063dSJacob Faibussowitsch     PetscCall(VecIntSetValuesSection(s->bcIndices, s->bc, point, indices, INSERT_VALUES));
2476ea844a1aSMatthew Knepley   }
2477ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2478ea844a1aSMatthew Knepley }
2479ea844a1aSMatthew Knepley 
2480ea844a1aSMatthew Knepley /*@C
2481ea844a1aSMatthew Knepley   PetscSectionGetFieldConstraintIndices - Get the field dof numbers, in [0, fdof), which are constrained
2482ea844a1aSMatthew Knepley 
248340750d41SVaclav Hapla   Not Collective
2484ea844a1aSMatthew Knepley 
2485ea844a1aSMatthew Knepley   Input Parameters:
2486ea844a1aSMatthew Knepley + s     - The PetscSection
2487ea844a1aSMatthew Knepley . field  - The field number
2488ea844a1aSMatthew Knepley - point - The point
2489ea844a1aSMatthew Knepley 
2490ea844a1aSMatthew Knepley   Output Parameter:
24919759eb26SJed Brown . indices - The constrained dofs sorted in ascending order
2492ea844a1aSMatthew Knepley 
24939759eb26SJed Brown   Notes:
24949759eb26SJed Brown   The indices array, which is provided by the caller, must have capacity to hold the number of constrained dofs, e.g., as returned by PetscSectionGetConstraintDof().
24959759eb26SJed Brown 
24969759eb26SJed Brown   Fortran Note:
24979759eb26SJed Brown   In Fortran, you call PetscSectionGetFieldConstraintIndicesF90() and PetscSectionRestoreFieldConstraintIndicesF90()
2498ea844a1aSMatthew Knepley 
2499ea844a1aSMatthew Knepley   Level: intermediate
2500ea844a1aSMatthew Knepley 
2501db781477SPatrick Sanan .seealso: `PetscSectionSetFieldConstraintIndices()`, `PetscSectionGetConstraintIndices()`, `PetscSectionGetConstraintDof()`, `PetscSection`
2502ea844a1aSMatthew Knepley @*/
2503ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetFieldConstraintIndices(PetscSection s, PetscInt point, PetscInt field, const PetscInt **indices)
2504ea844a1aSMatthew Knepley {
2505ea844a1aSMatthew Knepley   PetscFunctionBegin;
2506ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2507dadcf809SJacob Faibussowitsch   PetscValidPointer(indices,4);
25082abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
25099566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstraintIndices(s->field[field], point, indices));
2510ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2511ea844a1aSMatthew Knepley }
2512ea844a1aSMatthew Knepley 
2513ea844a1aSMatthew Knepley /*@C
2514ea844a1aSMatthew Knepley   PetscSectionSetFieldConstraintIndices - Set the field dof numbers, in [0, fdof), which are constrained
2515ea844a1aSMatthew Knepley 
251640750d41SVaclav Hapla   Not Collective
2517ea844a1aSMatthew Knepley 
2518ea844a1aSMatthew Knepley   Input Parameters:
2519ea844a1aSMatthew Knepley + s       - The PetscSection
2520ea844a1aSMatthew Knepley . point   - The point
2521ea844a1aSMatthew Knepley . field   - The field number
2522ea844a1aSMatthew Knepley - indices - The constrained dofs
2523ea844a1aSMatthew Knepley 
2524ea844a1aSMatthew Knepley   Note: The Fortran is PetscSectionSetFieldConstraintIndicesF90()
2525ea844a1aSMatthew Knepley 
2526ea844a1aSMatthew Knepley   Level: intermediate
2527ea844a1aSMatthew Knepley 
2528db781477SPatrick Sanan .seealso: `PetscSectionSetConstraintIndices()`, `PetscSectionGetFieldConstraintIndices()`, `PetscSectionGetConstraintDof()`, `PetscSection`
2529ea844a1aSMatthew Knepley @*/
2530ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetFieldConstraintIndices(PetscSection s, PetscInt point, PetscInt field, const PetscInt indices[])
2531ea844a1aSMatthew Knepley {
2532ea844a1aSMatthew Knepley   PetscFunctionBegin;
2533ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
25342abc8c78SJacob Faibussowitsch   if (PetscDefined(USE_DEBUG)) {
2535e2bfaee7SMatthew G. Knepley     PetscInt nfdof;
25362abc8c78SJacob Faibussowitsch 
25379566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldConstraintDof(s, point, field, &nfdof));
2538e2bfaee7SMatthew G. Knepley     if (nfdof) PetscValidIntPointer(indices, 4);
25392abc8c78SJacob Faibussowitsch   }
25402abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
25419566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetConstraintIndices(s->field[field], point, indices));
2542ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2543ea844a1aSMatthew Knepley }
2544ea844a1aSMatthew Knepley 
2545ea844a1aSMatthew Knepley /*@
2546ea844a1aSMatthew Knepley   PetscSectionPermute - Reorder the section according to the input point permutation
2547ea844a1aSMatthew Knepley 
254840750d41SVaclav Hapla   Collective
2549ea844a1aSMatthew Knepley 
2550d8d19677SJose E. Roman   Input Parameters:
2551ea844a1aSMatthew Knepley + section - The PetscSection object
2552ea844a1aSMatthew Knepley - perm - The point permutation, old point p becomes new point perm[p]
2553ea844a1aSMatthew Knepley 
2554ea844a1aSMatthew Knepley   Output Parameter:
2555ea844a1aSMatthew Knepley . sectionNew - The permuted PetscSection
2556ea844a1aSMatthew Knepley 
2557ea844a1aSMatthew Knepley   Level: intermediate
2558ea844a1aSMatthew Knepley 
2559db781477SPatrick Sanan .seealso: `MatPermute()`
2560ea844a1aSMatthew Knepley @*/
2561ea844a1aSMatthew Knepley PetscErrorCode PetscSectionPermute(PetscSection section, IS permutation, PetscSection *sectionNew)
2562ea844a1aSMatthew Knepley {
2563ea844a1aSMatthew Knepley   PetscSection    s = section, sNew;
2564ea844a1aSMatthew Knepley   const PetscInt *perm;
2565b778fa18SValeria Barra   PetscInt        numFields, f, c, numPoints, pStart, pEnd, p;
2566ea844a1aSMatthew Knepley 
2567ea844a1aSMatthew Knepley   PetscFunctionBegin;
2568ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1);
2569ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(permutation, IS_CLASSID, 2);
2570ea844a1aSMatthew Knepley   PetscValidPointer(sectionNew, 3);
25719566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject) s), &sNew));
25729566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetNumFields(s, &numFields));
25739566063dSJacob Faibussowitsch   if (numFields) PetscCall(PetscSectionSetNumFields(sNew, numFields));
2574ea844a1aSMatthew Knepley   for (f = 0; f < numFields; ++f) {
2575ea844a1aSMatthew Knepley     const char *name;
2576ea844a1aSMatthew Knepley     PetscInt    numComp;
2577ea844a1aSMatthew Knepley 
25789566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldName(s, f, &name));
25799566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldName(sNew, f, name));
25809566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldComponents(s, f, &numComp));
25819566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldComponents(sNew, f, numComp));
2582b778fa18SValeria Barra     for (c = 0; c < s->numFieldComponents[f]; ++c) {
25839566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetComponentName(s, f, c, &name));
25849566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetComponentName(sNew, f, c, name));
2585b778fa18SValeria Barra     }
2586ea844a1aSMatthew Knepley   }
25879566063dSJacob Faibussowitsch   PetscCall(ISGetLocalSize(permutation, &numPoints));
25889566063dSJacob Faibussowitsch   PetscCall(ISGetIndices(permutation, &perm));
25899566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
25909566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(sNew, pStart, pEnd));
259108401ef6SPierre Jolivet   PetscCheck(numPoints >= pEnd,PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "Permutation size %" PetscInt_FMT " is less than largest Section point %" PetscInt_FMT, numPoints, pEnd);
2592ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
2593ea844a1aSMatthew Knepley     PetscInt dof, cdof;
2594ea844a1aSMatthew Knepley 
25959566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s, p, &dof));
25969566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(sNew, perm[p], dof));
25979566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s, p, &cdof));
25989566063dSJacob Faibussowitsch     if (cdof) PetscCall(PetscSectionSetConstraintDof(sNew, perm[p], cdof));
2599ea844a1aSMatthew Knepley     for (f = 0; f < numFields; ++f) {
26009566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldDof(s, p, f, &dof));
26019566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldDof(sNew, perm[p], f, dof));
26029566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintDof(s, p, f, &cdof));
26039566063dSJacob Faibussowitsch       if (cdof) PetscCall(PetscSectionSetFieldConstraintDof(sNew, perm[p], f, cdof));
2604ea844a1aSMatthew Knepley     }
2605ea844a1aSMatthew Knepley   }
26069566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(sNew));
2607ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
2608ea844a1aSMatthew Knepley     const PetscInt *cind;
2609ea844a1aSMatthew Knepley     PetscInt        cdof;
2610ea844a1aSMatthew Knepley 
26119566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s, p, &cdof));
2612ea844a1aSMatthew Knepley     if (cdof) {
26139566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetConstraintIndices(s, p, &cind));
26149566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetConstraintIndices(sNew, perm[p], cind));
2615ea844a1aSMatthew Knepley     }
2616ea844a1aSMatthew Knepley     for (f = 0; f < numFields; ++f) {
26179566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintDof(s, p, f, &cdof));
2618ea844a1aSMatthew Knepley       if (cdof) {
26199566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetFieldConstraintIndices(s, p, f, &cind));
26209566063dSJacob Faibussowitsch         PetscCall(PetscSectionSetFieldConstraintIndices(sNew, perm[p], f, cind));
2621ea844a1aSMatthew Knepley       }
2622ea844a1aSMatthew Knepley     }
2623ea844a1aSMatthew Knepley   }
26249566063dSJacob Faibussowitsch   PetscCall(ISRestoreIndices(permutation, &perm));
2625ea844a1aSMatthew Knepley   *sectionNew = sNew;
2626ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2627ea844a1aSMatthew Knepley }
2628ea844a1aSMatthew Knepley 
2629ea844a1aSMatthew Knepley /*@
2630ea844a1aSMatthew Knepley   PetscSectionSetClosureIndex - Set a cache of points in the closure of each point in the section
2631ea844a1aSMatthew Knepley 
263240750d41SVaclav Hapla   Collective
2633ea844a1aSMatthew Knepley 
2634ea844a1aSMatthew Knepley   Input Parameters:
2635ea844a1aSMatthew Knepley + section   - The PetscSection
2636ea844a1aSMatthew Knepley . obj       - A PetscObject which serves as the key for this index
2637ea844a1aSMatthew Knepley . clSection - Section giving the size of the closure of each point
2638ea844a1aSMatthew Knepley - clPoints  - IS giving the points in each closure
2639ea844a1aSMatthew Knepley 
2640ea844a1aSMatthew Knepley   Note: We compress out closure points with no dofs in this section
2641ea844a1aSMatthew Knepley 
2642ea844a1aSMatthew Knepley   Level: advanced
2643ea844a1aSMatthew Knepley 
2644db781477SPatrick Sanan .seealso: `PetscSectionGetClosureIndex()`, `DMPlexCreateClosureIndex()`
2645ea844a1aSMatthew Knepley @*/
2646ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetClosureIndex(PetscSection section, PetscObject obj, PetscSection clSection, IS clPoints)
2647ea844a1aSMatthew Knepley {
2648ea844a1aSMatthew Knepley   PetscFunctionBegin;
26493e03ebd8SStefano Zampini   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,1);
26503e03ebd8SStefano Zampini   PetscValidHeaderSpecific(clSection,PETSC_SECTION_CLASSID,3);
26513e03ebd8SStefano Zampini   PetscValidHeaderSpecific(clPoints,IS_CLASSID,4);
26529566063dSJacob Faibussowitsch   if (section->clObj != obj) PetscCall(PetscSectionResetClosurePermutation(section));
2653ea844a1aSMatthew Knepley   section->clObj     = obj;
26549566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)clSection));
26559566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)clPoints));
26569566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&section->clSection));
26579566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&section->clPoints));
2658ea844a1aSMatthew Knepley   section->clSection = clSection;
2659ea844a1aSMatthew Knepley   section->clPoints  = clPoints;
2660ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2661ea844a1aSMatthew Knepley }
2662ea844a1aSMatthew Knepley 
2663ea844a1aSMatthew Knepley /*@
2664ea844a1aSMatthew Knepley   PetscSectionGetClosureIndex - Get the cache of points in the closure of each point in the section
2665ea844a1aSMatthew Knepley 
266640750d41SVaclav Hapla   Collective
2667ea844a1aSMatthew Knepley 
2668ea844a1aSMatthew Knepley   Input Parameters:
2669ea844a1aSMatthew Knepley + section   - The PetscSection
2670ea844a1aSMatthew Knepley - obj       - A PetscObject which serves as the key for this index
2671ea844a1aSMatthew Knepley 
2672ea844a1aSMatthew Knepley   Output Parameters:
2673ea844a1aSMatthew Knepley + clSection - Section giving the size of the closure of each point
2674ea844a1aSMatthew Knepley - clPoints  - IS giving the points in each closure
2675ea844a1aSMatthew Knepley 
2676ea844a1aSMatthew Knepley   Note: We compress out closure points with no dofs in this section
2677ea844a1aSMatthew Knepley 
2678ea844a1aSMatthew Knepley   Level: advanced
2679ea844a1aSMatthew Knepley 
2680db781477SPatrick Sanan .seealso: `PetscSectionSetClosureIndex()`, `DMPlexCreateClosureIndex()`
2681ea844a1aSMatthew Knepley @*/
2682ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetClosureIndex(PetscSection section, PetscObject obj, PetscSection *clSection, IS *clPoints)
2683ea844a1aSMatthew Knepley {
2684ea844a1aSMatthew Knepley   PetscFunctionBegin;
2685ea844a1aSMatthew Knepley   if (section->clObj == obj) {
2686ea844a1aSMatthew Knepley     if (clSection) *clSection = section->clSection;
2687ea844a1aSMatthew Knepley     if (clPoints)  *clPoints  = section->clPoints;
2688ea844a1aSMatthew Knepley   } else {
2689ea844a1aSMatthew Knepley     if (clSection) *clSection = NULL;
2690ea844a1aSMatthew Knepley     if (clPoints)  *clPoints  = NULL;
2691ea844a1aSMatthew Knepley   }
2692ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2693ea844a1aSMatthew Knepley }
2694ea844a1aSMatthew Knepley 
2695c459fbc1SJed Brown PetscErrorCode PetscSectionSetClosurePermutation_Internal(PetscSection section, PetscObject obj, PetscInt depth, PetscInt clSize, PetscCopyMode mode, PetscInt *clPerm)
2696ea844a1aSMatthew Knepley {
2697ea844a1aSMatthew Knepley   PetscInt       i;
2698c459fbc1SJed Brown   khiter_t iter;
2699c459fbc1SJed Brown   int new_entry;
2700c459fbc1SJed Brown   PetscSectionClosurePermKey key = {depth, clSize};
2701c459fbc1SJed Brown   PetscSectionClosurePermVal *val;
2702ea844a1aSMatthew Knepley 
2703ea844a1aSMatthew Knepley   PetscFunctionBegin;
2704ea844a1aSMatthew Knepley   if (section->clObj != obj) {
27059566063dSJacob Faibussowitsch     PetscCall(PetscSectionDestroy(&section->clSection));
27069566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&section->clPoints));
2707ea844a1aSMatthew Knepley   }
2708ea844a1aSMatthew Knepley   section->clObj = obj;
27099566063dSJacob Faibussowitsch   if (!section->clHash) PetscCall(PetscClPermCreate(&section->clHash));
2710c459fbc1SJed Brown   iter = kh_put(ClPerm, section->clHash, key, &new_entry);
2711c459fbc1SJed Brown   val = &kh_val(section->clHash, iter);
2712c459fbc1SJed Brown   if (!new_entry) {
27139566063dSJacob Faibussowitsch     PetscCall(PetscFree(val->perm));
27149566063dSJacob Faibussowitsch     PetscCall(PetscFree(val->invPerm));
2715c459fbc1SJed Brown   }
2716ea844a1aSMatthew Knepley   if (mode == PETSC_COPY_VALUES) {
27179566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(clSize, &val->perm));
27189566063dSJacob Faibussowitsch     PetscCall(PetscLogObjectMemory((PetscObject) obj, clSize*sizeof(PetscInt)));
27199566063dSJacob Faibussowitsch     PetscCall(PetscArraycpy(val->perm, clPerm, clSize));
2720ea844a1aSMatthew Knepley   } else if (mode == PETSC_OWN_POINTER) {
2721c459fbc1SJed Brown     val->perm = clPerm;
2722ea844a1aSMatthew Knepley   } else SETERRQ(PetscObjectComm(obj), PETSC_ERR_SUP, "Do not support borrowed arrays");
27239566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(clSize, &val->invPerm));
2724c459fbc1SJed Brown   for (i = 0; i < clSize; ++i) val->invPerm[clPerm[i]] = i;
2725ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2726ea844a1aSMatthew Knepley }
2727ea844a1aSMatthew Knepley 
2728ea844a1aSMatthew Knepley /*@
2729c459fbc1SJed Brown   PetscSectionSetClosurePermutation - Set the dof permutation for the closure of each cell in the section, meaning clPerm[newIndex] = oldIndex.
2730ea844a1aSMatthew Knepley 
2731ea844a1aSMatthew Knepley   Not Collective
2732ea844a1aSMatthew Knepley 
2733ea844a1aSMatthew Knepley   Input Parameters:
2734ea844a1aSMatthew Knepley + section - The PetscSection
2735c459fbc1SJed Brown . obj     - A PetscObject which serves as the key for this index (usually a DM)
2736c459fbc1SJed Brown . depth   - Depth of points on which to apply the given permutation
2737ea844a1aSMatthew Knepley - perm    - Permutation of the cell dof closure
2738ea844a1aSMatthew Knepley 
2739c459fbc1SJed Brown   Note:
2740c459fbc1SJed Brown   The specified permutation will only be applied to points at depth whose closure size matches the length of perm.  In a
2741c459fbc1SJed Brown   mixed-topology or variable-degree finite element space, this function can be called multiple times at each depth for
2742c459fbc1SJed Brown   each topology and degree.
2743c459fbc1SJed Brown 
2744c459fbc1SJed Brown   This approach assumes that (depth, len(perm)) uniquely identifies the desired permutation; this might not be true for
2745c459fbc1SJed Brown   exotic/enriched spaces on mixed topology meshes.
2746ea844a1aSMatthew Knepley 
2747ea844a1aSMatthew Knepley   Level: intermediate
2748ea844a1aSMatthew Knepley 
2749db781477SPatrick Sanan .seealso: `PetscSectionGetClosurePermutation()`, `PetscSectionGetClosureIndex()`, `DMPlexCreateClosureIndex()`, `PetscCopyMode`
2750ea844a1aSMatthew Knepley @*/
2751c459fbc1SJed Brown PetscErrorCode PetscSectionSetClosurePermutation(PetscSection section, PetscObject obj, PetscInt depth, IS perm)
2752ea844a1aSMatthew Knepley {
2753ea844a1aSMatthew Knepley   const PetscInt *clPerm = NULL;
2754ea844a1aSMatthew Knepley   PetscInt        clSize = 0;
2755ea844a1aSMatthew Knepley 
2756ea844a1aSMatthew Knepley   PetscFunctionBegin;
2757ea844a1aSMatthew Knepley   if (perm) {
27589566063dSJacob Faibussowitsch     PetscCall(ISGetLocalSize(perm, &clSize));
27599566063dSJacob Faibussowitsch     PetscCall(ISGetIndices(perm, &clPerm));
2760ea844a1aSMatthew Knepley   }
27619566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetClosurePermutation_Internal(section, obj, depth, clSize, PETSC_COPY_VALUES, (PetscInt *) clPerm));
27629566063dSJacob Faibussowitsch   if (perm) PetscCall(ISRestoreIndices(perm, &clPerm));
2763ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2764ea844a1aSMatthew Knepley }
2765ea844a1aSMatthew Knepley 
2766c459fbc1SJed Brown PetscErrorCode PetscSectionGetClosurePermutation_Internal(PetscSection section, PetscObject obj, PetscInt depth, PetscInt size, const PetscInt *perm[])
2767ea844a1aSMatthew Knepley {
2768ea844a1aSMatthew Knepley   PetscFunctionBegin;
2769ea844a1aSMatthew Knepley   if (section->clObj == obj) {
2770c459fbc1SJed Brown     PetscSectionClosurePermKey k = {depth, size};
2771c459fbc1SJed Brown     PetscSectionClosurePermVal v;
27729566063dSJacob Faibussowitsch     PetscCall(PetscClPermGet(section->clHash, k, &v));
2773c459fbc1SJed Brown     if (perm) *perm = v.perm;
2774ea844a1aSMatthew Knepley   } else {
2775ea844a1aSMatthew Knepley     if (perm) *perm = NULL;
2776ea844a1aSMatthew Knepley   }
2777ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2778ea844a1aSMatthew Knepley }
2779ea844a1aSMatthew Knepley 
2780ea844a1aSMatthew Knepley /*@
2781ea844a1aSMatthew Knepley   PetscSectionGetClosurePermutation - Get the dof permutation for the closure of each cell in the section, meaning clPerm[newIndex] = oldIndex.
2782ea844a1aSMatthew Knepley 
278340750d41SVaclav Hapla   Not Collective
2784ea844a1aSMatthew Knepley 
2785ea844a1aSMatthew Knepley   Input Parameters:
2786ea844a1aSMatthew Knepley + section   - The PetscSection
2787c459fbc1SJed Brown . obj       - A PetscObject which serves as the key for this index (usually a DM)
2788c459fbc1SJed Brown . depth     - Depth stratum on which to obtain closure permutation
2789c459fbc1SJed Brown - clSize    - Closure size to be permuted (e.g., may vary with element topology and degree)
2790ea844a1aSMatthew Knepley 
2791ea844a1aSMatthew Knepley   Output Parameter:
2792ea844a1aSMatthew Knepley . perm - The dof closure permutation
2793ea844a1aSMatthew Knepley 
2794c459fbc1SJed Brown   Note:
2795ea844a1aSMatthew Knepley   The user must destroy the IS that is returned.
2796ea844a1aSMatthew Knepley 
2797ea844a1aSMatthew Knepley   Level: intermediate
2798ea844a1aSMatthew Knepley 
2799db781477SPatrick Sanan .seealso: `PetscSectionSetClosurePermutation()`, `PetscSectionGetClosureInversePermutation()`, `PetscSectionGetClosureIndex()`, `PetscSectionSetClosureIndex()`, `DMPlexCreateClosureIndex()`
2800ea844a1aSMatthew Knepley @*/
2801c459fbc1SJed Brown PetscErrorCode PetscSectionGetClosurePermutation(PetscSection section, PetscObject obj, PetscInt depth, PetscInt clSize, IS *perm)
2802ea844a1aSMatthew Knepley {
2803ea844a1aSMatthew Knepley   const PetscInt *clPerm;
2804ea844a1aSMatthew Knepley 
2805ea844a1aSMatthew Knepley   PetscFunctionBegin;
28069566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetClosurePermutation_Internal(section, obj, depth, clSize, &clPerm));
28079566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(PETSC_COMM_SELF, clSize, clPerm, PETSC_USE_POINTER, perm));
2808ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2809ea844a1aSMatthew Knepley }
2810ea844a1aSMatthew Knepley 
2811c459fbc1SJed Brown PetscErrorCode PetscSectionGetClosureInversePermutation_Internal(PetscSection section, PetscObject obj, PetscInt depth, PetscInt size, const PetscInt *perm[])
2812ea844a1aSMatthew Knepley {
2813ea844a1aSMatthew Knepley   PetscFunctionBegin;
2814c459fbc1SJed Brown   if (section->clObj == obj && section->clHash) {
2815c459fbc1SJed Brown     PetscSectionClosurePermKey k = {depth, size};
2816c459fbc1SJed Brown     PetscSectionClosurePermVal v;
28179566063dSJacob Faibussowitsch     PetscCall(PetscClPermGet(section->clHash, k, &v));
2818c459fbc1SJed Brown     if (perm) *perm = v.invPerm;
2819ea844a1aSMatthew Knepley   } else {
2820ea844a1aSMatthew Knepley     if (perm) *perm = NULL;
2821ea844a1aSMatthew Knepley   }
2822ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2823ea844a1aSMatthew Knepley }
2824ea844a1aSMatthew Knepley 
2825ea844a1aSMatthew Knepley /*@
2826ea844a1aSMatthew Knepley   PetscSectionGetClosureInversePermutation - Get the inverse dof permutation for the closure of each cell in the section, meaning clPerm[oldIndex] = newIndex.
2827ea844a1aSMatthew Knepley 
282840750d41SVaclav Hapla   Not Collective
2829ea844a1aSMatthew Knepley 
2830ea844a1aSMatthew Knepley   Input Parameters:
2831ea844a1aSMatthew Knepley + section   - The PetscSection
2832c459fbc1SJed Brown . obj       - A PetscObject which serves as the key for this index (usually a DM)
2833c459fbc1SJed Brown . depth     - Depth stratum on which to obtain closure permutation
2834c459fbc1SJed Brown - clSize    - Closure size to be permuted (e.g., may vary with element topology and degree)
2835ea844a1aSMatthew Knepley 
2836ea844a1aSMatthew Knepley   Output Parameters:
2837c459fbc1SJed Brown . perm - The dof closure permutation
2838ea844a1aSMatthew Knepley 
2839c459fbc1SJed Brown   Note:
2840ea844a1aSMatthew Knepley   The user must destroy the IS that is returned.
2841ea844a1aSMatthew Knepley 
2842ea844a1aSMatthew Knepley   Level: intermediate
2843ea844a1aSMatthew Knepley 
2844db781477SPatrick Sanan .seealso: `PetscSectionSetClosurePermutation()`, `PetscSectionGetClosureIndex()`, `PetscSectionSetClosureIndex()`, `DMPlexCreateClosureIndex()`
2845ea844a1aSMatthew Knepley @*/
2846c459fbc1SJed Brown PetscErrorCode PetscSectionGetClosureInversePermutation(PetscSection section, PetscObject obj, PetscInt depth, PetscInt clSize, IS *perm)
2847ea844a1aSMatthew Knepley {
2848ea844a1aSMatthew Knepley   const PetscInt *clPerm;
2849ea844a1aSMatthew Knepley 
2850ea844a1aSMatthew Knepley   PetscFunctionBegin;
28519566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetClosureInversePermutation_Internal(section, obj, depth, clSize, &clPerm));
28529566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(PETSC_COMM_SELF, clSize, clPerm, PETSC_USE_POINTER, perm));
2853ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2854ea844a1aSMatthew Knepley }
2855ea844a1aSMatthew Knepley 
2856ea844a1aSMatthew Knepley /*@
2857ea844a1aSMatthew Knepley   PetscSectionGetField - Get the subsection associated with a single field
2858ea844a1aSMatthew Knepley 
2859ea844a1aSMatthew Knepley   Input Parameters:
2860ea844a1aSMatthew Knepley + s     - The PetscSection
2861ea844a1aSMatthew Knepley - field - The field number
2862ea844a1aSMatthew Knepley 
2863ea844a1aSMatthew Knepley   Output Parameter:
2864ea844a1aSMatthew Knepley . subs  - The subsection for the given field
2865ea844a1aSMatthew Knepley 
2866ea844a1aSMatthew Knepley   Level: intermediate
2867ea844a1aSMatthew Knepley 
2868db781477SPatrick Sanan .seealso: `PetscSectionSetNumFields()`
2869ea844a1aSMatthew Knepley @*/
2870ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetField(PetscSection s, PetscInt field, PetscSection *subs)
2871ea844a1aSMatthew Knepley {
2872ea844a1aSMatthew Knepley   PetscFunctionBegin;
2873ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s,PETSC_SECTION_CLASSID,1);
2874ea844a1aSMatthew Knepley   PetscValidPointer(subs,3);
28752abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
2876ea844a1aSMatthew Knepley   *subs = s->field[field];
2877ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2878ea844a1aSMatthew Knepley }
2879ea844a1aSMatthew Knepley 
2880ea844a1aSMatthew Knepley PetscClassId      PETSC_SECTION_SYM_CLASSID;
2881ea844a1aSMatthew Knepley PetscFunctionList PetscSectionSymList = NULL;
2882ea844a1aSMatthew Knepley 
2883ea844a1aSMatthew Knepley /*@
2884ea844a1aSMatthew Knepley   PetscSectionSymCreate - Creates an empty PetscSectionSym object.
2885ea844a1aSMatthew Knepley 
2886ea844a1aSMatthew Knepley   Collective
2887ea844a1aSMatthew Knepley 
2888ea844a1aSMatthew Knepley   Input Parameter:
2889ea844a1aSMatthew Knepley . comm - the MPI communicator
2890ea844a1aSMatthew Knepley 
2891ea844a1aSMatthew Knepley   Output Parameter:
2892ea844a1aSMatthew Knepley . sym - pointer to the new set of symmetries
2893ea844a1aSMatthew Knepley 
2894ea844a1aSMatthew Knepley   Level: developer
2895ea844a1aSMatthew Knepley 
2896db781477SPatrick Sanan .seealso: `PetscSectionSym`, `PetscSectionSymDestroy()`
2897ea844a1aSMatthew Knepley @*/
2898ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSymCreate(MPI_Comm comm, PetscSectionSym *sym)
2899ea844a1aSMatthew Knepley {
2900ea844a1aSMatthew Knepley   PetscFunctionBegin;
2901ea844a1aSMatthew Knepley   PetscValidPointer(sym,2);
29029566063dSJacob Faibussowitsch   PetscCall(ISInitializePackage());
29039566063dSJacob Faibussowitsch   PetscCall(PetscHeaderCreate(*sym,PETSC_SECTION_SYM_CLASSID,"PetscSectionSym","Section Symmetry","IS",comm,PetscSectionSymDestroy,PetscSectionSymView));
2904ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2905ea844a1aSMatthew Knepley }
2906ea844a1aSMatthew Knepley 
2907ea844a1aSMatthew Knepley /*@C
2908ea844a1aSMatthew Knepley   PetscSectionSymSetType - Builds a PetscSection symmetry, for a particular implementation.
2909ea844a1aSMatthew Knepley 
291040750d41SVaclav Hapla   Collective
2911ea844a1aSMatthew Knepley 
2912ea844a1aSMatthew Knepley   Input Parameters:
2913ea844a1aSMatthew Knepley + sym    - The section symmetry object
2914ea844a1aSMatthew Knepley - method - The name of the section symmetry type
2915ea844a1aSMatthew Knepley 
2916ea844a1aSMatthew Knepley   Level: developer
2917ea844a1aSMatthew Knepley 
2918db781477SPatrick Sanan .seealso: `PetscSectionSymGetType()`, `PetscSectionSymCreate()`
2919ea844a1aSMatthew Knepley @*/
2920ea844a1aSMatthew Knepley PetscErrorCode  PetscSectionSymSetType(PetscSectionSym sym, PetscSectionSymType method)
2921ea844a1aSMatthew Knepley {
2922ea844a1aSMatthew Knepley   PetscErrorCode (*r)(PetscSectionSym);
2923ea844a1aSMatthew Knepley   PetscBool      match;
2924ea844a1aSMatthew Knepley 
2925ea844a1aSMatthew Knepley   PetscFunctionBegin;
2926ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID,1);
29279566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject) sym, method, &match));
2928ea844a1aSMatthew Knepley   if (match) PetscFunctionReturn(0);
2929ea844a1aSMatthew Knepley 
29309566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListFind(PetscSectionSymList,method,&r));
293128b400f6SJacob Faibussowitsch   PetscCheck(r,PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown PetscSectionSym type: %s", method);
2932*dbbe0bcdSBarry Smith   PetscTryTypeMethod(sym,destroy);
2933ea844a1aSMatthew Knepley   sym->ops->destroy = NULL;
2934*dbbe0bcdSBarry Smith 
29359566063dSJacob Faibussowitsch   PetscCall((*r)(sym));
29369566063dSJacob Faibussowitsch   PetscCall(PetscObjectChangeTypeName((PetscObject)sym,method));
2937ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2938ea844a1aSMatthew Knepley }
2939ea844a1aSMatthew Knepley 
2940ea844a1aSMatthew Knepley /*@C
2941ea844a1aSMatthew Knepley   PetscSectionSymGetType - Gets the section symmetry type name (as a string) from the PetscSectionSym.
2942ea844a1aSMatthew Knepley 
2943ea844a1aSMatthew Knepley   Not Collective
2944ea844a1aSMatthew Knepley 
2945ea844a1aSMatthew Knepley   Input Parameter:
2946ea844a1aSMatthew Knepley . sym  - The section symmetry
2947ea844a1aSMatthew Knepley 
2948ea844a1aSMatthew Knepley   Output Parameter:
2949ea844a1aSMatthew Knepley . type - The index set type name
2950ea844a1aSMatthew Knepley 
2951ea844a1aSMatthew Knepley   Level: developer
2952ea844a1aSMatthew Knepley 
2953db781477SPatrick Sanan .seealso: `PetscSectionSymSetType()`, `PetscSectionSymCreate()`
2954ea844a1aSMatthew Knepley @*/
2955ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSymGetType(PetscSectionSym sym, PetscSectionSymType *type)
2956ea844a1aSMatthew Knepley {
2957ea844a1aSMatthew Knepley   PetscFunctionBegin;
2958ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID,1);
2959dadcf809SJacob Faibussowitsch   PetscValidPointer(type,2);
2960ea844a1aSMatthew Knepley   *type = ((PetscObject)sym)->type_name;
2961ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2962ea844a1aSMatthew Knepley }
2963ea844a1aSMatthew Knepley 
2964ea844a1aSMatthew Knepley /*@C
2965ea844a1aSMatthew Knepley   PetscSectionSymRegister - Adds a new section symmetry implementation
2966ea844a1aSMatthew Knepley 
2967ea844a1aSMatthew Knepley   Not Collective
2968ea844a1aSMatthew Knepley 
2969ea844a1aSMatthew Knepley   Input Parameters:
2970ea844a1aSMatthew Knepley + name        - The name of a new user-defined creation routine
2971ea844a1aSMatthew Knepley - create_func - The creation routine itself
2972ea844a1aSMatthew Knepley 
2973ea844a1aSMatthew Knepley   Notes:
2974ea844a1aSMatthew Knepley   PetscSectionSymRegister() may be called multiple times to add several user-defined vectors
2975ea844a1aSMatthew Knepley 
2976ea844a1aSMatthew Knepley   Level: developer
2977ea844a1aSMatthew Knepley 
2978db781477SPatrick Sanan .seealso: `PetscSectionSymCreate()`, `PetscSectionSymSetType()`
2979ea844a1aSMatthew Knepley @*/
2980ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSymRegister(const char sname[], PetscErrorCode (*function)(PetscSectionSym))
2981ea844a1aSMatthew Knepley {
2982ea844a1aSMatthew Knepley   PetscFunctionBegin;
29839566063dSJacob Faibussowitsch   PetscCall(ISInitializePackage());
29849566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListAdd(&PetscSectionSymList,sname,function));
2985ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2986ea844a1aSMatthew Knepley }
2987ea844a1aSMatthew Knepley 
2988ea844a1aSMatthew Knepley /*@
2989ea844a1aSMatthew Knepley    PetscSectionSymDestroy - Destroys a section symmetry.
2990ea844a1aSMatthew Knepley 
299140750d41SVaclav Hapla    Collective
2992ea844a1aSMatthew Knepley 
2993ea844a1aSMatthew Knepley    Input Parameters:
2994ea844a1aSMatthew Knepley .  sym - the section symmetry
2995ea844a1aSMatthew Knepley 
2996ea844a1aSMatthew Knepley    Level: developer
2997ea844a1aSMatthew Knepley 
2998db781477SPatrick Sanan .seealso: `PetscSectionSymCreate()`, `PetscSectionSymDestroy()`
2999ea844a1aSMatthew Knepley @*/
3000ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSymDestroy(PetscSectionSym *sym)
3001ea844a1aSMatthew Knepley {
3002ea844a1aSMatthew Knepley   SymWorkLink    link,next;
3003ea844a1aSMatthew Knepley 
3004ea844a1aSMatthew Knepley   PetscFunctionBegin;
3005ea844a1aSMatthew Knepley   if (!*sym) PetscFunctionReturn(0);
3006ea844a1aSMatthew Knepley   PetscValidHeaderSpecific((*sym),PETSC_SECTION_SYM_CLASSID,1);
30074c8fdceaSLisandro Dalcin   if (--((PetscObject)(*sym))->refct > 0) {*sym = NULL; PetscFunctionReturn(0);}
3008ea844a1aSMatthew Knepley   if ((*sym)->ops->destroy) {
30099566063dSJacob Faibussowitsch     PetscCall((*(*sym)->ops->destroy)(*sym));
3010ea844a1aSMatthew Knepley   }
3011c9cc58a2SBarry Smith   PetscCheck(!(*sym)->workout,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Work array still checked out");
3012ea844a1aSMatthew Knepley   for (link=(*sym)->workin; link; link=next) {
30130c99d500SBarry Smith     PetscInt    **perms = (PetscInt **)link->perms;
30140c99d500SBarry Smith     PetscScalar **rots  = (PetscScalar **) link->rots;
30150c99d500SBarry Smith     PetscCall(PetscFree2(perms,rots));
3016ea844a1aSMatthew Knepley     next = link->next;
30179566063dSJacob Faibussowitsch     PetscCall(PetscFree(link));
3018ea844a1aSMatthew Knepley   }
3019ea844a1aSMatthew Knepley   (*sym)->workin = NULL;
30209566063dSJacob Faibussowitsch   PetscCall(PetscHeaderDestroy(sym));
3021ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3022ea844a1aSMatthew Knepley }
3023ea844a1aSMatthew Knepley 
3024ea844a1aSMatthew Knepley /*@C
3025ea844a1aSMatthew Knepley    PetscSectionSymView - Displays a section symmetry
3026ea844a1aSMatthew Knepley 
302740750d41SVaclav Hapla    Collective
3028ea844a1aSMatthew Knepley 
3029ea844a1aSMatthew Knepley    Input Parameters:
3030ea844a1aSMatthew Knepley +  sym - the index set
3031ea844a1aSMatthew Knepley -  viewer - viewer used to display the set, for example PETSC_VIEWER_STDOUT_SELF.
3032ea844a1aSMatthew Knepley 
3033ea844a1aSMatthew Knepley    Level: developer
3034ea844a1aSMatthew Knepley 
3035db781477SPatrick Sanan .seealso: `PetscViewerASCIIOpen()`
3036ea844a1aSMatthew Knepley @*/
3037ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSymView(PetscSectionSym sym,PetscViewer viewer)
3038ea844a1aSMatthew Knepley {
3039ea844a1aSMatthew Knepley   PetscFunctionBegin;
3040ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(sym,PETSC_SECTION_SYM_CLASSID,1);
3041ea844a1aSMatthew Knepley   if (!viewer) {
30429566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)sym),&viewer));
3043ea844a1aSMatthew Knepley   }
3044ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
3045ea844a1aSMatthew Knepley   PetscCheckSameComm(sym,1,viewer,2);
30469566063dSJacob Faibussowitsch   PetscCall(PetscObjectPrintClassNamePrefixType((PetscObject)sym,viewer));
3047*dbbe0bcdSBarry Smith   PetscTryTypeMethod(sym,view,viewer);
3048ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3049ea844a1aSMatthew Knepley }
3050ea844a1aSMatthew Knepley 
3051ea844a1aSMatthew Knepley /*@
3052ea844a1aSMatthew Knepley   PetscSectionSetSym - Set the symmetries for the data referred to by the section
3053ea844a1aSMatthew Knepley 
305440750d41SVaclav Hapla   Collective
3055ea844a1aSMatthew Knepley 
3056ea844a1aSMatthew Knepley   Input Parameters:
3057ea844a1aSMatthew Knepley + section - the section describing data layout
3058ea844a1aSMatthew Knepley - sym - the symmetry describing the affect of orientation on the access of the data
3059ea844a1aSMatthew Knepley 
3060ea844a1aSMatthew Knepley   Level: developer
3061ea844a1aSMatthew Knepley 
3062db781477SPatrick Sanan .seealso: `PetscSectionGetSym()`, `PetscSectionSymCreate()`
3063ea844a1aSMatthew Knepley @*/
3064ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetSym(PetscSection section, PetscSectionSym sym)
3065ea844a1aSMatthew Knepley {
3066ea844a1aSMatthew Knepley   PetscFunctionBegin;
3067ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,1);
30689566063dSJacob Faibussowitsch   PetscCall(PetscSectionSymDestroy(&(section->sym)));
3069ea844a1aSMatthew Knepley   if (sym) {
3070ea844a1aSMatthew Knepley     PetscValidHeaderSpecific(sym,PETSC_SECTION_SYM_CLASSID,2);
3071ea844a1aSMatthew Knepley     PetscCheckSameComm(section,1,sym,2);
30729566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject) sym));
3073ea844a1aSMatthew Knepley   }
3074ea844a1aSMatthew Knepley   section->sym = sym;
3075ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3076ea844a1aSMatthew Knepley }
3077ea844a1aSMatthew Knepley 
3078ea844a1aSMatthew Knepley /*@
3079ea844a1aSMatthew Knepley   PetscSectionGetSym - Get the symmetries for the data referred to by the section
3080ea844a1aSMatthew Knepley 
308140750d41SVaclav Hapla   Not Collective
3082ea844a1aSMatthew Knepley 
3083ea844a1aSMatthew Knepley   Input Parameters:
3084ea844a1aSMatthew Knepley . section - the section describing data layout
3085ea844a1aSMatthew Knepley 
3086ea844a1aSMatthew Knepley   Output Parameters:
3087ea844a1aSMatthew Knepley . sym - the symmetry describing the affect of orientation on the access of the data
3088ea844a1aSMatthew Knepley 
3089ea844a1aSMatthew Knepley   Level: developer
3090ea844a1aSMatthew Knepley 
3091db781477SPatrick Sanan .seealso: `PetscSectionSetSym()`, `PetscSectionSymCreate()`
3092ea844a1aSMatthew Knepley @*/
3093ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetSym(PetscSection section, PetscSectionSym *sym)
3094ea844a1aSMatthew Knepley {
3095ea844a1aSMatthew Knepley   PetscFunctionBegin;
3096ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,1);
3097ea844a1aSMatthew Knepley   *sym = section->sym;
3098ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3099ea844a1aSMatthew Knepley }
3100ea844a1aSMatthew Knepley 
3101ea844a1aSMatthew Knepley /*@
3102ea844a1aSMatthew Knepley   PetscSectionSetFieldSym - Set the symmetries for the data referred to by a field of the section
3103ea844a1aSMatthew Knepley 
310440750d41SVaclav Hapla   Collective
3105ea844a1aSMatthew Knepley 
3106ea844a1aSMatthew Knepley   Input Parameters:
3107ea844a1aSMatthew Knepley + section - the section describing data layout
3108ea844a1aSMatthew Knepley . field - the field number
3109ea844a1aSMatthew Knepley - sym - the symmetry describing the affect of orientation on the access of the data
3110ea844a1aSMatthew Knepley 
3111ea844a1aSMatthew Knepley   Level: developer
3112ea844a1aSMatthew Knepley 
3113db781477SPatrick Sanan .seealso: `PetscSectionGetFieldSym()`, `PetscSectionSymCreate()`
3114ea844a1aSMatthew Knepley @*/
3115ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetFieldSym(PetscSection section, PetscInt field, PetscSectionSym sym)
3116ea844a1aSMatthew Knepley {
3117ea844a1aSMatthew Knepley   PetscFunctionBegin;
3118ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,1);
31192abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,section->numFields);
31209566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetSym(section->field[field],sym));
3121ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3122ea844a1aSMatthew Knepley }
3123ea844a1aSMatthew Knepley 
3124ea844a1aSMatthew Knepley /*@
3125ea844a1aSMatthew Knepley   PetscSectionGetFieldSym - Get the symmetries for the data referred to by a field of the section
3126ea844a1aSMatthew Knepley 
312740750d41SVaclav Hapla   Collective
3128ea844a1aSMatthew Knepley 
3129ea844a1aSMatthew Knepley   Input Parameters:
3130ea844a1aSMatthew Knepley + section - the section describing data layout
3131ea844a1aSMatthew Knepley - field - the field number
3132ea844a1aSMatthew Knepley 
3133ea844a1aSMatthew Knepley   Output Parameters:
3134ea844a1aSMatthew Knepley . sym - the symmetry describing the affect of orientation on the access of the data
3135ea844a1aSMatthew Knepley 
3136ea844a1aSMatthew Knepley   Level: developer
3137ea844a1aSMatthew Knepley 
3138db781477SPatrick Sanan .seealso: `PetscSectionSetFieldSym()`, `PetscSectionSymCreate()`
3139ea844a1aSMatthew Knepley @*/
3140ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetFieldSym(PetscSection section, PetscInt field, PetscSectionSym *sym)
3141ea844a1aSMatthew Knepley {
3142ea844a1aSMatthew Knepley   PetscFunctionBegin;
3143ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,1);
31442abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,section->numFields);
3145ea844a1aSMatthew Knepley   *sym = section->field[field]->sym;
3146ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3147ea844a1aSMatthew Knepley }
3148ea844a1aSMatthew Knepley 
3149ea844a1aSMatthew Knepley /*@C
3150ea844a1aSMatthew Knepley   PetscSectionGetPointSyms - Get the symmetries for a set of points in a PetscSection under specific orientations.
3151ea844a1aSMatthew Knepley 
315240750d41SVaclav Hapla   Not Collective
3153ea844a1aSMatthew Knepley 
3154ea844a1aSMatthew Knepley   Input Parameters:
3155ea844a1aSMatthew Knepley + section - the section
3156ea844a1aSMatthew Knepley . numPoints - the number of points
3157ea844a1aSMatthew Knepley - points - an array of size 2 * numPoints, containing a list of (point, orientation) pairs. (An orientation is an
3158ea844a1aSMatthew Knepley     arbitrary integer: its interpretation is up to sym.  Orientations are used by DM: for their interpretation in that
3159ea844a1aSMatthew Knepley     context, see DMPlexGetConeOrientation()).
3160ea844a1aSMatthew Knepley 
3161d8d19677SJose E. Roman   Output Parameters:
3162ea844a1aSMatthew Knepley + perms - The permutations for the given orientations (or NULL if there is no symmetry or the permutation is the identity).
3163ea844a1aSMatthew Knepley - rots - The field rotations symmetries for the given orientations (or NULL if there is no symmetry or the rotations are all
3164ea844a1aSMatthew Knepley     identity).
3165ea844a1aSMatthew Knepley 
3166ea844a1aSMatthew Knepley   Example of usage, gathering dofs into a local array (lArray) from a section array (sArray):
3167ea844a1aSMatthew Knepley .vb
3168ea844a1aSMatthew Knepley      const PetscInt    **perms;
3169ea844a1aSMatthew Knepley      const PetscScalar **rots;
3170ea844a1aSMatthew Knepley      PetscInt            lOffset;
3171ea844a1aSMatthew Knepley 
3172ea844a1aSMatthew Knepley      PetscSectionGetPointSyms(section,numPoints,points,&perms,&rots);
3173ea844a1aSMatthew Knepley      for (i = 0, lOffset = 0; i < numPoints; i++) {
3174ea844a1aSMatthew Knepley        PetscInt           point = points[2*i], dof, sOffset;
3175ea844a1aSMatthew Knepley        const PetscInt    *perm  = perms ? perms[i] : NULL;
3176ea844a1aSMatthew Knepley        const PetscScalar *rot   = rots  ? rots[i]  : NULL;
3177ea844a1aSMatthew Knepley 
3178ea844a1aSMatthew Knepley        PetscSectionGetDof(section,point,&dof);
3179ea844a1aSMatthew Knepley        PetscSectionGetOffset(section,point,&sOffset);
3180ea844a1aSMatthew Knepley 
3181ea844a1aSMatthew Knepley        if (perm) {for (j = 0; j < dof; j++) {lArray[lOffset + perm[j]]  = sArray[sOffset + j];}}
3182ea844a1aSMatthew Knepley        else      {for (j = 0; j < dof; j++) {lArray[lOffset +      j ]  = sArray[sOffset + j];}}
3183ea844a1aSMatthew Knepley        if (rot)  {for (j = 0; j < dof; j++) {lArray[lOffset +      j ] *= rot[j];             }}
3184ea844a1aSMatthew Knepley        lOffset += dof;
3185ea844a1aSMatthew Knepley      }
3186ea844a1aSMatthew Knepley      PetscSectionRestorePointSyms(section,numPoints,points,&perms,&rots);
3187ea844a1aSMatthew Knepley .ve
3188ea844a1aSMatthew Knepley 
3189ea844a1aSMatthew Knepley   Example of usage, adding dofs into a section array (sArray) from a local array (lArray):
3190ea844a1aSMatthew Knepley .vb
3191ea844a1aSMatthew Knepley      const PetscInt    **perms;
3192ea844a1aSMatthew Knepley      const PetscScalar **rots;
3193ea844a1aSMatthew Knepley      PetscInt            lOffset;
3194ea844a1aSMatthew Knepley 
3195ea844a1aSMatthew Knepley      PetscSectionGetPointSyms(section,numPoints,points,&perms,&rots);
3196ea844a1aSMatthew Knepley      for (i = 0, lOffset = 0; i < numPoints; i++) {
3197ea844a1aSMatthew Knepley        PetscInt           point = points[2*i], dof, sOffset;
3198ea844a1aSMatthew Knepley        const PetscInt    *perm  = perms ? perms[i] : NULL;
3199ea844a1aSMatthew Knepley        const PetscScalar *rot   = rots  ? rots[i]  : NULL;
3200ea844a1aSMatthew Knepley 
3201ea844a1aSMatthew Knepley        PetscSectionGetDof(section,point,&dof);
3202ea844a1aSMatthew Knepley        PetscSectionGetOffset(section,point,&sOff);
3203ea844a1aSMatthew Knepley 
3204ea844a1aSMatthew Knepley        if (perm) {for (j = 0; j < dof; j++) {sArray[sOffset + j] += lArray[lOffset + perm[j]] * (rot ? PetscConj(rot[perm[j]]) : 1.);}}
3205ea844a1aSMatthew Knepley        else      {for (j = 0; j < dof; j++) {sArray[sOffset + j] += lArray[lOffset +      j ] * (rot ? PetscConj(rot[     j ]) : 1.);}}
3206ea844a1aSMatthew Knepley        offset += dof;
3207ea844a1aSMatthew Knepley      }
3208ea844a1aSMatthew Knepley      PetscSectionRestorePointSyms(section,numPoints,points,&perms,&rots);
3209ea844a1aSMatthew Knepley .ve
3210ea844a1aSMatthew Knepley 
3211ea844a1aSMatthew Knepley   Level: developer
3212ea844a1aSMatthew Knepley 
3213db781477SPatrick Sanan .seealso: `PetscSectionRestorePointSyms()`, `PetscSectionSymCreate()`, `PetscSectionSetSym()`, `PetscSectionGetSym()`
3214ea844a1aSMatthew Knepley @*/
3215ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetPointSyms(PetscSection section, PetscInt numPoints, const PetscInt *points, const PetscInt ***perms, const PetscScalar ***rots)
3216ea844a1aSMatthew Knepley {
3217ea844a1aSMatthew Knepley   PetscSectionSym sym;
3218ea844a1aSMatthew Knepley 
3219ea844a1aSMatthew Knepley   PetscFunctionBegin;
3220ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,1);
3221ea844a1aSMatthew Knepley   if (numPoints) PetscValidIntPointer(points,3);
3222ea844a1aSMatthew Knepley   if (perms) *perms = NULL;
3223ea844a1aSMatthew Knepley   if (rots)  *rots  = NULL;
3224ea844a1aSMatthew Knepley   sym = section->sym;
3225ea844a1aSMatthew Knepley   if (sym && (perms || rots)) {
3226ea844a1aSMatthew Knepley     SymWorkLink link;
3227ea844a1aSMatthew Knepley 
3228ea844a1aSMatthew Knepley     if (sym->workin) {
3229ea844a1aSMatthew Knepley       link        = sym->workin;
3230ea844a1aSMatthew Knepley       sym->workin = sym->workin->next;
3231ea844a1aSMatthew Knepley     } else {
32329566063dSJacob Faibussowitsch       PetscCall(PetscNewLog(sym,&link));
3233ea844a1aSMatthew Knepley     }
3234ea844a1aSMatthew Knepley     if (numPoints > link->numPoints) {
32350c99d500SBarry Smith       PetscInt    **perms = (PetscInt **)link->perms;
32360c99d500SBarry Smith       PetscScalar **rots  = (PetscScalar **) link->rots;
32370c99d500SBarry Smith       PetscCall(PetscFree2(perms,rots));
32380c99d500SBarry Smith       PetscCall(PetscMalloc2(numPoints,(PetscInt***)&link->perms,numPoints,(PetscScalar***)&link->rots));
3239ea844a1aSMatthew Knepley       link->numPoints = numPoints;
3240ea844a1aSMatthew Knepley     }
3241ea844a1aSMatthew Knepley     link->next   = sym->workout;
3242ea844a1aSMatthew Knepley     sym->workout = link;
32439566063dSJacob Faibussowitsch     PetscCall(PetscArrayzero((PetscInt**)link->perms,numPoints));
32449566063dSJacob Faibussowitsch     PetscCall(PetscArrayzero((PetscInt**)link->rots,numPoints));
32459566063dSJacob Faibussowitsch     PetscCall((*sym->ops->getpoints) (sym, section, numPoints, points, link->perms, link->rots));
3246ea844a1aSMatthew Knepley     if (perms) *perms = link->perms;
3247ea844a1aSMatthew Knepley     if (rots)  *rots  = link->rots;
3248ea844a1aSMatthew Knepley   }
3249ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3250ea844a1aSMatthew Knepley }
3251ea844a1aSMatthew Knepley 
3252ea844a1aSMatthew Knepley /*@C
3253ea844a1aSMatthew Knepley   PetscSectionRestorePointSyms - Restore the symmetries returned by PetscSectionGetPointSyms()
3254ea844a1aSMatthew Knepley 
325540750d41SVaclav Hapla   Not Collective
3256ea844a1aSMatthew Knepley 
3257ea844a1aSMatthew Knepley   Input Parameters:
3258ea844a1aSMatthew Knepley + section - the section
3259ea844a1aSMatthew Knepley . numPoints - the number of points
3260ea844a1aSMatthew Knepley - points - an array of size 2 * numPoints, containing a list of (point, orientation) pairs. (An orientation is an
3261ea844a1aSMatthew Knepley     arbitrary integer: its interpretation is up to sym.  Orientations are used by DM: for their interpretation in that
3262ea844a1aSMatthew Knepley     context, see DMPlexGetConeOrientation()).
3263ea844a1aSMatthew Knepley 
3264d8d19677SJose E. Roman   Output Parameters:
3265ea844a1aSMatthew Knepley + perms - The permutations for the given orientations: set to NULL at conclusion
3266ea844a1aSMatthew Knepley - rots - The field rotations symmetries for the given orientations: set to NULL at conclusion
3267ea844a1aSMatthew Knepley 
3268ea844a1aSMatthew Knepley   Level: developer
3269ea844a1aSMatthew Knepley 
3270db781477SPatrick Sanan .seealso: `PetscSectionGetPointSyms()`, `PetscSectionSymCreate()`, `PetscSectionSetSym()`, `PetscSectionGetSym()`
3271ea844a1aSMatthew Knepley @*/
3272ea844a1aSMatthew Knepley PetscErrorCode PetscSectionRestorePointSyms(PetscSection section, PetscInt numPoints, const PetscInt *points, const PetscInt ***perms, const PetscScalar ***rots)
3273ea844a1aSMatthew Knepley {
3274ea844a1aSMatthew Knepley   PetscSectionSym sym;
3275ea844a1aSMatthew Knepley 
3276ea844a1aSMatthew Knepley   PetscFunctionBegin;
3277ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,1);
3278ea844a1aSMatthew Knepley   sym = section->sym;
3279ea844a1aSMatthew Knepley   if (sym && (perms || rots)) {
3280ea844a1aSMatthew Knepley     SymWorkLink *p,link;
3281ea844a1aSMatthew Knepley 
3282ea844a1aSMatthew Knepley     for (p=&sym->workout; (link=*p); p=&link->next) {
3283ea844a1aSMatthew Knepley       if ((perms && link->perms == *perms) || (rots && link->rots == *rots)) {
3284ea844a1aSMatthew Knepley         *p          = link->next;
3285ea844a1aSMatthew Knepley         link->next  = sym->workin;
3286ea844a1aSMatthew Knepley         sym->workin = link;
3287ea844a1aSMatthew Knepley         if (perms) *perms = NULL;
3288ea844a1aSMatthew Knepley         if (rots)  *rots  = NULL;
3289ea844a1aSMatthew Knepley         PetscFunctionReturn(0);
3290ea844a1aSMatthew Knepley       }
3291ea844a1aSMatthew Knepley     }
3292ea844a1aSMatthew Knepley     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Array was not checked out");
3293ea844a1aSMatthew Knepley   }
3294ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3295ea844a1aSMatthew Knepley }
3296ea844a1aSMatthew Knepley 
3297ea844a1aSMatthew Knepley /*@C
3298ea844a1aSMatthew Knepley   PetscSectionGetFieldPointSyms - Get the symmetries for a set of points in a field of a PetscSection under specific orientations.
3299ea844a1aSMatthew Knepley 
330040750d41SVaclav Hapla   Not Collective
3301ea844a1aSMatthew Knepley 
3302ea844a1aSMatthew Knepley   Input Parameters:
3303ea844a1aSMatthew Knepley + section - the section
3304ea844a1aSMatthew Knepley . field - the field of the section
3305ea844a1aSMatthew Knepley . numPoints - the number of points
3306ea844a1aSMatthew Knepley - points - an array of size 2 * numPoints, containing a list of (point, orientation) pairs. (An orientation is an
3307ea844a1aSMatthew Knepley     arbitrary integer: its interpretation is up to sym.  Orientations are used by DM: for their interpretation in that
3308ea844a1aSMatthew Knepley     context, see DMPlexGetConeOrientation()).
3309ea844a1aSMatthew Knepley 
3310d8d19677SJose E. Roman   Output Parameters:
3311ea844a1aSMatthew Knepley + perms - The permutations for the given orientations (or NULL if there is no symmetry or the permutation is the identity).
3312ea844a1aSMatthew Knepley - rots - The field rotations symmetries for the given orientations (or NULL if there is no symmetry or the rotations are all
3313ea844a1aSMatthew Knepley     identity).
3314ea844a1aSMatthew Knepley 
3315ea844a1aSMatthew Knepley   Level: developer
3316ea844a1aSMatthew Knepley 
3317db781477SPatrick Sanan .seealso: `PetscSectionGetPointSyms()`, `PetscSectionRestoreFieldPointSyms()`
3318ea844a1aSMatthew Knepley @*/
3319ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetFieldPointSyms(PetscSection section, PetscInt field, PetscInt numPoints, const PetscInt *points, const PetscInt ***perms, const PetscScalar ***rots)
3320ea844a1aSMatthew Knepley {
3321ea844a1aSMatthew Knepley   PetscFunctionBegin;
3322ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,1);
332308401ef6SPierre Jolivet   PetscCheck(field <= section->numFields,PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"field %" PetscInt_FMT " greater than number of fields (%" PetscInt_FMT ") in section",field,section->numFields);
33249566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetPointSyms(section->field[field],numPoints,points,perms,rots));
3325ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3326ea844a1aSMatthew Knepley }
3327ea844a1aSMatthew Knepley 
3328ea844a1aSMatthew Knepley /*@C
3329ea844a1aSMatthew Knepley   PetscSectionRestoreFieldPointSyms - Restore the symmetries returned by PetscSectionGetFieldPointSyms()
3330ea844a1aSMatthew Knepley 
333140750d41SVaclav Hapla   Not Collective
3332ea844a1aSMatthew Knepley 
3333ea844a1aSMatthew Knepley   Input Parameters:
3334ea844a1aSMatthew Knepley + section - the section
3335ea844a1aSMatthew Knepley . field - the field number
3336ea844a1aSMatthew Knepley . numPoints - the number of points
3337ea844a1aSMatthew Knepley - points - an array of size 2 * numPoints, containing a list of (point, orientation) pairs. (An orientation is an
3338ea844a1aSMatthew Knepley     arbitrary integer: its interpretation is up to sym.  Orientations are used by DM: for their interpretation in that
3339ea844a1aSMatthew Knepley     context, see DMPlexGetConeOrientation()).
3340ea844a1aSMatthew Knepley 
3341d8d19677SJose E. Roman   Output Parameters:
3342ea844a1aSMatthew Knepley + perms - The permutations for the given orientations: set to NULL at conclusion
3343ea844a1aSMatthew Knepley - rots - The field rotations symmetries for the given orientations: set to NULL at conclusion
3344ea844a1aSMatthew Knepley 
3345ea844a1aSMatthew Knepley   Level: developer
3346ea844a1aSMatthew Knepley 
3347db781477SPatrick Sanan .seealso: `PetscSectionRestorePointSyms()`, `petscSectionGetFieldPointSyms()`, `PetscSectionSymCreate()`, `PetscSectionSetSym()`, `PetscSectionGetSym()`
3348ea844a1aSMatthew Knepley @*/
3349ea844a1aSMatthew Knepley PetscErrorCode PetscSectionRestoreFieldPointSyms(PetscSection section, PetscInt field, PetscInt numPoints, const PetscInt *points, const PetscInt ***perms, const PetscScalar ***rots)
3350ea844a1aSMatthew Knepley {
3351ea844a1aSMatthew Knepley   PetscFunctionBegin;
3352ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,1);
335308401ef6SPierre Jolivet   PetscCheck(field <= section->numFields,PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"field %" PetscInt_FMT " greater than number of fields (%" PetscInt_FMT ") in section",field,section->numFields);
33549566063dSJacob Faibussowitsch   PetscCall(PetscSectionRestorePointSyms(section->field[field],numPoints,points,perms,rots));
3355ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3356ea844a1aSMatthew Knepley }
3357ea844a1aSMatthew Knepley 
3358ea844a1aSMatthew Knepley /*@
3359b004864fSMatthew G. Knepley   PetscSectionSymCopy - Copy the symmetries, assuming that the point structure is compatible
3360b004864fSMatthew G. Knepley 
336140750d41SVaclav Hapla   Not Collective
3362b004864fSMatthew G. Knepley 
3363b004864fSMatthew G. Knepley   Input Parameter:
3364b004864fSMatthew G. Knepley . sym - the PetscSectionSym
3365b004864fSMatthew G. Knepley 
3366b004864fSMatthew G. Knepley   Output Parameter:
3367b004864fSMatthew G. Knepley . nsym - the equivalent symmetries
3368b004864fSMatthew G. Knepley 
3369b004864fSMatthew G. Knepley   Level: developer
3370b004864fSMatthew G. Knepley 
3371db781477SPatrick Sanan .seealso: `PetscSectionSymCreate()`, `PetscSectionSetSym()`, `PetscSectionGetSym()`, `PetscSectionSymLabelSetStratum()`, `PetscSectionGetPointSyms()`
3372b004864fSMatthew G. Knepley @*/
3373b004864fSMatthew G. Knepley PetscErrorCode PetscSectionSymCopy(PetscSectionSym sym, PetscSectionSym nsym)
3374b004864fSMatthew G. Knepley {
3375b004864fSMatthew G. Knepley   PetscFunctionBegin;
3376b004864fSMatthew G. Knepley   PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID, 1);
3377b004864fSMatthew G. Knepley   PetscValidHeaderSpecific(nsym, PETSC_SECTION_SYM_CLASSID, 2);
3378*dbbe0bcdSBarry Smith   PetscTryTypeMethod(sym,copy, nsym);
3379b004864fSMatthew G. Knepley   PetscFunctionReturn(0);
3380b004864fSMatthew G. Knepley }
3381b004864fSMatthew G. Knepley 
3382b004864fSMatthew G. Knepley /*@
3383b004864fSMatthew G. Knepley   PetscSectionSymDistribute - Distribute the symmetries in accordance with the input SF
3384b004864fSMatthew G. Knepley 
3385b004864fSMatthew G. Knepley   Collective
3386b004864fSMatthew G. Knepley 
3387b004864fSMatthew G. Knepley   Input Parameters:
3388b004864fSMatthew G. Knepley + sym - the PetscSectionSym
3389b004864fSMatthew G. Knepley - migrationSF - the distribution map from roots to leaves
3390b004864fSMatthew G. Knepley 
3391b004864fSMatthew G. Knepley   Output Parameters:
3392b004864fSMatthew G. Knepley . dsym - the redistributed symmetries
3393b004864fSMatthew G. Knepley 
3394b004864fSMatthew G. Knepley   Level: developer
3395b004864fSMatthew G. Knepley 
3396db781477SPatrick Sanan .seealso: `PetscSectionSymCreate()`, `PetscSectionSetSym()`, `PetscSectionGetSym()`, `PetscSectionSymLabelSetStratum()`, `PetscSectionGetPointSyms()`
3397b004864fSMatthew G. Knepley @*/
3398b004864fSMatthew G. Knepley PetscErrorCode PetscSectionSymDistribute(PetscSectionSym sym, PetscSF migrationSF, PetscSectionSym *dsym)
3399b004864fSMatthew G. Knepley {
3400b004864fSMatthew G. Knepley   PetscFunctionBegin;
3401b004864fSMatthew G. Knepley   PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID, 1);
3402b004864fSMatthew G. Knepley   PetscValidHeaderSpecific(migrationSF, PETSCSF_CLASSID, 2);
3403b004864fSMatthew G. Knepley   PetscValidPointer(dsym, 3);
3404*dbbe0bcdSBarry Smith   PetscTryTypeMethod(sym,distribute, migrationSF, dsym);
3405b004864fSMatthew G. Knepley   PetscFunctionReturn(0);
3406b004864fSMatthew G. Knepley }
3407b004864fSMatthew G. Knepley 
3408b004864fSMatthew G. Knepley /*@
3409ea844a1aSMatthew Knepley   PetscSectionGetUseFieldOffsets - Get the flag to use field offsets directly in a global section, rather than just the point offset
3410ea844a1aSMatthew Knepley 
341140750d41SVaclav Hapla   Not Collective
3412ea844a1aSMatthew Knepley 
3413ea844a1aSMatthew Knepley   Input Parameter:
3414ea844a1aSMatthew Knepley . s - the global PetscSection
3415ea844a1aSMatthew Knepley 
3416ea844a1aSMatthew Knepley   Output Parameters:
3417ea844a1aSMatthew Knepley . flg - the flag
3418ea844a1aSMatthew Knepley 
3419ea844a1aSMatthew Knepley   Level: developer
3420ea844a1aSMatthew Knepley 
3421db781477SPatrick Sanan .seealso: `PetscSectionSetChart()`, `PetscSectionCreate()`
3422ea844a1aSMatthew Knepley @*/
3423ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetUseFieldOffsets(PetscSection s, PetscBool *flg)
3424ea844a1aSMatthew Knepley {
3425ea844a1aSMatthew Knepley   PetscFunctionBegin;
3426ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
3427ea844a1aSMatthew Knepley   *flg = s->useFieldOff;
3428ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3429ea844a1aSMatthew Knepley }
3430ea844a1aSMatthew Knepley 
3431ea844a1aSMatthew Knepley /*@
3432ea844a1aSMatthew Knepley   PetscSectionSetUseFieldOffsets - Set the flag to use field offsets directly in a global section, rather than just the point offset
3433ea844a1aSMatthew Knepley 
343440750d41SVaclav Hapla   Not Collective
3435ea844a1aSMatthew Knepley 
3436ea844a1aSMatthew Knepley   Input Parameters:
3437ea844a1aSMatthew Knepley + s   - the global PetscSection
3438ea844a1aSMatthew Knepley - flg - the flag
3439ea844a1aSMatthew Knepley 
3440ea844a1aSMatthew Knepley   Level: developer
3441ea844a1aSMatthew Knepley 
3442db781477SPatrick Sanan .seealso: `PetscSectionGetUseFieldOffsets()`, `PetscSectionSetChart()`, `PetscSectionCreate()`
3443ea844a1aSMatthew Knepley @*/
3444ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetUseFieldOffsets(PetscSection s, PetscBool flg)
3445ea844a1aSMatthew Knepley {
3446ea844a1aSMatthew Knepley   PetscFunctionBegin;
3447ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
3448ea844a1aSMatthew Knepley   s->useFieldOff = flg;
3449ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3450ea844a1aSMatthew Knepley }
3451ea844a1aSMatthew Knepley 
3452ea844a1aSMatthew Knepley #define PetscSectionExpandPoints_Loop(TYPE) \
3453ea844a1aSMatthew Knepley { \
3454ea844a1aSMatthew Knepley   PetscInt i, n, o0, o1, size; \
3455ea844a1aSMatthew Knepley   TYPE *a0 = (TYPE*)origArray, *a1; \
34569566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetStorageSize(s, &size)); \
34579566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(size, &a1)); \
3458ea844a1aSMatthew Knepley   for (i=0; i<npoints; i++) { \
34599566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(origSection, points_[i], &o0)); \
34609566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(s, i, &o1)); \
34619566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s, i, &n)); \
34629566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(&a1[o1], &a0[o0], n*unitsize)); \
3463ea844a1aSMatthew Knepley   } \
3464ea844a1aSMatthew Knepley   *newArray = (void*)a1; \
3465ea844a1aSMatthew Knepley }
3466ea844a1aSMatthew Knepley 
3467ea844a1aSMatthew Knepley /*@
3468ea844a1aSMatthew Knepley   PetscSectionExtractDofsFromArray - Extracts elements of an array corresponding to DOFs of specified points.
3469ea844a1aSMatthew Knepley 
347040750d41SVaclav Hapla   Not Collective
3471ea844a1aSMatthew Knepley 
3472ea844a1aSMatthew Knepley   Input Parameters:
3473ea844a1aSMatthew Knepley + origSection - the PetscSection describing the layout of the array
3474ea844a1aSMatthew Knepley . dataType - MPI_Datatype describing the data type of the array (currently only MPIU_INT, MPIU_SCALAR, MPIU_REAL)
3475ea844a1aSMatthew Knepley . origArray - the array; its size must be equal to the storage size of origSection
3476ea844a1aSMatthew Knepley - points - IS with points to extract; its indices must lie in the chart of origSection
3477ea844a1aSMatthew Knepley 
3478ea844a1aSMatthew Knepley   Output Parameters:
3479ea844a1aSMatthew Knepley + newSection - the new PetscSection desribing the layout of the new array (with points renumbered 0,1,... but preserving numbers of DOFs)
3480ea844a1aSMatthew Knepley - newArray - the array of the extracted DOFs; its size is the storage size of newSection
3481ea844a1aSMatthew Knepley 
3482ea844a1aSMatthew Knepley   Level: developer
3483ea844a1aSMatthew Knepley 
3484db781477SPatrick Sanan .seealso: `PetscSectionGetChart()`, `PetscSectionGetDof()`, `PetscSectionGetStorageSize()`, `PetscSectionCreate()`
3485ea844a1aSMatthew Knepley @*/
3486ea844a1aSMatthew Knepley PetscErrorCode PetscSectionExtractDofsFromArray(PetscSection origSection, MPI_Datatype dataType, const void *origArray, IS points, PetscSection *newSection, void *newArray[])
3487ea844a1aSMatthew Knepley {
3488ea844a1aSMatthew Knepley   PetscSection        s;
3489ea844a1aSMatthew Knepley   const PetscInt      *points_;
3490ea844a1aSMatthew Knepley   PetscInt            i, n, npoints, pStart, pEnd;
3491ea844a1aSMatthew Knepley   PetscMPIInt         unitsize;
3492ea844a1aSMatthew Knepley 
3493ea844a1aSMatthew Knepley   PetscFunctionBegin;
3494ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(origSection, PETSC_SECTION_CLASSID, 1);
3495ea844a1aSMatthew Knepley   PetscValidPointer(origArray, 3);
3496ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(points, IS_CLASSID, 4);
3497ea844a1aSMatthew Knepley   if (newSection) PetscValidPointer(newSection, 5);
3498ea844a1aSMatthew Knepley   if (newArray) PetscValidPointer(newArray, 6);
34999566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Type_size(dataType, &unitsize));
35009566063dSJacob Faibussowitsch   PetscCall(ISGetLocalSize(points, &npoints));
35019566063dSJacob Faibussowitsch   PetscCall(ISGetIndices(points, &points_));
35029566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(origSection, &pStart, &pEnd));
35039566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PETSC_COMM_SELF, &s));
35049566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(s, 0, npoints));
3505ea844a1aSMatthew Knepley   for (i=0; i<npoints; i++) {
3506c9cc58a2SBarry Smith     PetscCheck(points_[i] >= pStart && points_[i] < pEnd,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "point %" PetscInt_FMT " (index %" PetscInt_FMT ") in input IS out of input section's chart", points_[i], i);
35079566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(origSection, points_[i], &n));
35089566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(s, i, n));
3509ea844a1aSMatthew Knepley   }
35109566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(s));
3511ea844a1aSMatthew Knepley   if (newArray) {
3512ea844a1aSMatthew Knepley     if (dataType == MPIU_INT)           {PetscSectionExpandPoints_Loop(PetscInt);}
3513ea844a1aSMatthew Knepley     else if (dataType == MPIU_SCALAR)   {PetscSectionExpandPoints_Loop(PetscScalar);}
3514ea844a1aSMatthew Knepley     else if (dataType == MPIU_REAL)     {PetscSectionExpandPoints_Loop(PetscReal);}
3515ea844a1aSMatthew Knepley     else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP, "not implemented for this MPI_Datatype");
3516ea844a1aSMatthew Knepley   }
3517ea844a1aSMatthew Knepley   if (newSection) {
3518ea844a1aSMatthew Knepley     *newSection = s;
3519ea844a1aSMatthew Knepley   } else {
35209566063dSJacob Faibussowitsch     PetscCall(PetscSectionDestroy(&s));
3521ea844a1aSMatthew Knepley   }
35229566063dSJacob Faibussowitsch   PetscCall(ISRestoreIndices(points, &points_));
3523ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3524ea844a1aSMatthew Knepley }
3525