xref: /petsc/src/vec/is/section/interface/section.c (revision 7c0883d534795ebc7b69f947707473b1809c98bb)
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 
31ea844a1aSMatthew Knepley   The PetscSection object and methods are intended to be used in the PETSc Vec and Mat implementions; it is
32ea844a1aSMatthew Knepley   recommended they not be used in user codes unless you really gain something in their use.
33ea844a1aSMatthew Knepley 
34ea844a1aSMatthew Knepley .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)->maxDof              = 0;
50ea844a1aSMatthew Knepley   (*s)->atlasDof            = NULL;
51ea844a1aSMatthew Knepley   (*s)->atlasOff            = NULL;
52ea844a1aSMatthew Knepley   (*s)->bc                  = NULL;
53ea844a1aSMatthew Knepley   (*s)->bcIndices           = NULL;
54ea844a1aSMatthew Knepley   (*s)->setup               = PETSC_FALSE;
55ea844a1aSMatthew Knepley   (*s)->numFields           = 0;
56ea844a1aSMatthew Knepley   (*s)->fieldNames          = NULL;
57ea844a1aSMatthew Knepley   (*s)->field               = NULL;
58ea844a1aSMatthew Knepley   (*s)->useFieldOff         = PETSC_FALSE;
59b778fa18SValeria Barra   (*s)->compNames           = NULL;
60ea844a1aSMatthew Knepley   (*s)->clObj               = NULL;
61c459fbc1SJed Brown   (*s)->clHash              = NULL;
62ea844a1aSMatthew Knepley   (*s)->clSection           = NULL;
63ea844a1aSMatthew Knepley   (*s)->clPoints            = NULL;
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 
80ea844a1aSMatthew Knepley .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 
168ea844a1aSMatthew Knepley .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 
193ea844a1aSMatthew Knepley .seealso: PetscSection, PetscSectionCreate(), PetscSectionDestroy()
194ea844a1aSMatthew Knepley @*/
195ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetFromOptions(PetscSection s)
196ea844a1aSMatthew Knepley {
197ea844a1aSMatthew Knepley   PetscErrorCode ierr;
198ea844a1aSMatthew Knepley 
199ea844a1aSMatthew Knepley   PetscFunctionBegin;
200ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2019566063dSJacob Faibussowitsch   ierr = PetscObjectOptionsBegin((PetscObject) s);PetscCall(ierr);
2029566063dSJacob Faibussowitsch   PetscCall(PetscOptionsBool("-petscsection_point_major", "The for ordering, either point major or field major", "PetscSectionSetPointMajor", s->pointMajor, &s->pointMajor, NULL));
203ea844a1aSMatthew Knepley   /* process any options handlers added with PetscObjectAddOptionsHandler() */
2049566063dSJacob Faibussowitsch   PetscCall(PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject) s));
2059566063dSJacob Faibussowitsch   ierr = PetscOptionsEnd();PetscCall(ierr);
2069566063dSJacob Faibussowitsch   PetscCall(PetscObjectViewFromOptions((PetscObject) s, NULL, "-petscsection_view"));
207ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
208ea844a1aSMatthew Knepley }
209ea844a1aSMatthew Knepley 
210ea844a1aSMatthew Knepley /*@
211ea844a1aSMatthew Knepley   PetscSectionCompare - Compares two sections
212ea844a1aSMatthew Knepley 
21340750d41SVaclav Hapla   Collective
214ea844a1aSMatthew Knepley 
2157a7aea1fSJed Brown   Input Parameters:
216ea844a1aSMatthew Knepley + s1 - the first PetscSection
217ea844a1aSMatthew Knepley - s2 - the second PetscSection
218ea844a1aSMatthew Knepley 
219ea844a1aSMatthew Knepley   Output Parameter:
220ea844a1aSMatthew Knepley . congruent - PETSC_TRUE if the two sections are congruent, PETSC_FALSE otherwise
221ea844a1aSMatthew Knepley 
222ea844a1aSMatthew Knepley   Level: intermediate
223ea844a1aSMatthew Knepley 
224ea844a1aSMatthew Knepley   Notes:
225ea844a1aSMatthew Knepley   Field names are disregarded.
226ea844a1aSMatthew Knepley 
227ea844a1aSMatthew Knepley .seealso: PetscSection, PetscSectionCreate(), PetscSectionCopy(), PetscSectionClone()
228ea844a1aSMatthew Knepley @*/
229ea844a1aSMatthew Knepley PetscErrorCode PetscSectionCompare(PetscSection s1, PetscSection s2, PetscBool *congruent)
230ea844a1aSMatthew Knepley {
231ea844a1aSMatthew Knepley   PetscInt pStart, pEnd, nfields, ncdof, nfcdof, p, f, n1, n2;
232ea844a1aSMatthew Knepley   const PetscInt *idx1, *idx2;
233ea844a1aSMatthew Knepley   IS perm1, perm2;
234ea844a1aSMatthew Knepley   PetscBool flg;
235ea844a1aSMatthew Knepley   PetscMPIInt mflg;
236ea844a1aSMatthew Knepley 
237ea844a1aSMatthew Knepley   PetscFunctionBegin;
238ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s1, PETSC_SECTION_CLASSID, 1);
239ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s2, PETSC_SECTION_CLASSID, 2);
240064a246eSJacob Faibussowitsch   PetscValidBoolPointer(congruent,3);
241ea844a1aSMatthew Knepley   flg = PETSC_FALSE;
242ea844a1aSMatthew Knepley 
2439566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_compare(PetscObjectComm((PetscObject)s1),PetscObjectComm((PetscObject)s2),&mflg));
244ea844a1aSMatthew Knepley   if (mflg != MPI_CONGRUENT && mflg != MPI_IDENT) {
245ea844a1aSMatthew Knepley     *congruent = PETSC_FALSE;
246ea844a1aSMatthew Knepley     PetscFunctionReturn(0);
247ea844a1aSMatthew Knepley   }
248ea844a1aSMatthew Knepley 
2499566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s1, &pStart, &pEnd));
2509566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s2, &n1, &n2));
251ea844a1aSMatthew Knepley   if (pStart != n1 || pEnd != n2) goto not_congruent;
252ea844a1aSMatthew Knepley 
2539566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetPermutation(s1, &perm1));
2549566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetPermutation(s2, &perm2));
255ea844a1aSMatthew Knepley   if (perm1 && perm2) {
2569566063dSJacob Faibussowitsch     PetscCall(ISEqual(perm1, perm2, congruent));
257ea844a1aSMatthew Knepley     if (!(*congruent)) goto not_congruent;
258ea844a1aSMatthew Knepley   } else if (perm1 != perm2) goto not_congruent;
259ea844a1aSMatthew Knepley 
260ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
2619566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(s1, p, &n1));
2629566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(s2, p, &n2));
263ea844a1aSMatthew Knepley     if (n1 != n2) goto not_congruent;
264ea844a1aSMatthew Knepley 
2659566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s1, p, &n1));
2669566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s2, p, &n2));
267ea844a1aSMatthew Knepley     if (n1 != n2) goto not_congruent;
268ea844a1aSMatthew Knepley 
2699566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s1, p, &ncdof));
2709566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s2, p, &n2));
271ea844a1aSMatthew Knepley     if (ncdof != n2) goto not_congruent;
272ea844a1aSMatthew Knepley 
2739566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintIndices(s1, p, &idx1));
2749566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintIndices(s2, p, &idx2));
2759566063dSJacob Faibussowitsch     PetscCall(PetscArraycmp(idx1, idx2, ncdof, congruent));
276ea844a1aSMatthew Knepley     if (!(*congruent)) goto not_congruent;
277ea844a1aSMatthew Knepley   }
278ea844a1aSMatthew Knepley 
2799566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetNumFields(s1, &nfields));
2809566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetNumFields(s2, &n2));
281ea844a1aSMatthew Knepley   if (nfields != n2) goto not_congruent;
282ea844a1aSMatthew Knepley 
283ea844a1aSMatthew Knepley   for (f = 0; f < nfields; ++f) {
2849566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldComponents(s1, f, &n1));
2859566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldComponents(s2, f, &n2));
286ea844a1aSMatthew Knepley     if (n1 != n2) goto not_congruent;
287ea844a1aSMatthew Knepley 
288ea844a1aSMatthew Knepley     for (p = pStart; p < pEnd; ++p) {
2899566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldOffset(s1, p, f, &n1));
2909566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldOffset(s2, p, f, &n2));
291ea844a1aSMatthew Knepley       if (n1 != n2) goto not_congruent;
292ea844a1aSMatthew Knepley 
2939566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldDof(s1, p, f, &n1));
2949566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldDof(s2, p, f, &n2));
295ea844a1aSMatthew Knepley       if (n1 != n2) goto not_congruent;
296ea844a1aSMatthew Knepley 
2979566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintDof(s1, p, f, &nfcdof));
2989566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintDof(s2, p, f, &n2));
299ea844a1aSMatthew Knepley       if (nfcdof != n2) goto not_congruent;
300ea844a1aSMatthew Knepley 
3019566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintIndices(s1, p, f, &idx1));
3029566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintIndices(s2, p, f, &idx2));
3039566063dSJacob Faibussowitsch       PetscCall(PetscArraycmp(idx1, idx2, nfcdof, congruent));
304ea844a1aSMatthew Knepley       if (!(*congruent)) goto not_congruent;
305ea844a1aSMatthew Knepley     }
306ea844a1aSMatthew Knepley   }
307ea844a1aSMatthew Knepley 
308ea844a1aSMatthew Knepley   flg = PETSC_TRUE;
309ea844a1aSMatthew Knepley not_congruent:
3109566063dSJacob Faibussowitsch   PetscCallMPI(MPIU_Allreduce(&flg,congruent,1,MPIU_BOOL,MPI_LAND,PetscObjectComm((PetscObject)s1)));
311ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
312ea844a1aSMatthew Knepley }
313ea844a1aSMatthew Knepley 
314ea844a1aSMatthew Knepley /*@
315ea844a1aSMatthew Knepley   PetscSectionGetNumFields - Returns the number of fields, or 0 if no fields were defined.
316ea844a1aSMatthew Knepley 
31740750d41SVaclav Hapla   Not Collective
318ea844a1aSMatthew Knepley 
319ea844a1aSMatthew Knepley   Input Parameter:
320ea844a1aSMatthew Knepley . s - the PetscSection
321ea844a1aSMatthew Knepley 
322ea844a1aSMatthew Knepley   Output Parameter:
323ea844a1aSMatthew Knepley . numFields - the number of fields defined, or 0 if none were defined
324ea844a1aSMatthew Knepley 
325ea844a1aSMatthew Knepley   Level: intermediate
326ea844a1aSMatthew Knepley 
327ea844a1aSMatthew Knepley .seealso: PetscSectionSetNumFields()
328ea844a1aSMatthew Knepley @*/
329ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetNumFields(PetscSection s, PetscInt *numFields)
330ea844a1aSMatthew Knepley {
331ea844a1aSMatthew Knepley   PetscFunctionBegin;
332ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
333dadcf809SJacob Faibussowitsch   PetscValidIntPointer(numFields,2);
334ea844a1aSMatthew Knepley   *numFields = s->numFields;
335ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
336ea844a1aSMatthew Knepley }
337ea844a1aSMatthew Knepley 
338ea844a1aSMatthew Knepley /*@
339ea844a1aSMatthew Knepley   PetscSectionSetNumFields - Sets the number of fields.
340ea844a1aSMatthew Knepley 
34140750d41SVaclav Hapla   Not Collective
342ea844a1aSMatthew Knepley 
343ea844a1aSMatthew Knepley   Input Parameters:
344ea844a1aSMatthew Knepley + s - the PetscSection
345ea844a1aSMatthew Knepley - numFields - the number of fields
346ea844a1aSMatthew Knepley 
347ea844a1aSMatthew Knepley   Level: intermediate
348ea844a1aSMatthew Knepley 
349ea844a1aSMatthew Knepley .seealso: PetscSectionGetNumFields()
350ea844a1aSMatthew Knepley @*/
351ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetNumFields(PetscSection s, PetscInt numFields)
352ea844a1aSMatthew Knepley {
353ea844a1aSMatthew Knepley   PetscInt       f;
354ea844a1aSMatthew Knepley 
355ea844a1aSMatthew Knepley   PetscFunctionBegin;
356ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
3572c71b3e2SJacob Faibussowitsch   PetscCheckFalse(numFields <= 0,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "The number of fields %" PetscInt_FMT " must be positive", numFields);
3589566063dSJacob Faibussowitsch   PetscCall(PetscSectionReset(s));
359ea844a1aSMatthew Knepley 
360ea844a1aSMatthew Knepley   s->numFields = numFields;
3619566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(s->numFields, &s->numFieldComponents));
3629566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(s->numFields, &s->fieldNames));
3639566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(s->numFields, &s->compNames));
3649566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(s->numFields, &s->field));
365ea844a1aSMatthew Knepley   for (f = 0; f < s->numFields; ++f) {
366ea844a1aSMatthew Knepley     char name[64];
367ea844a1aSMatthew Knepley 
368ea844a1aSMatthew Knepley     s->numFieldComponents[f] = 1;
369ea844a1aSMatthew Knepley 
3709566063dSJacob Faibussowitsch     PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject) s), &s->field[f]));
3719566063dSJacob Faibussowitsch     PetscCall(PetscSNPrintf(name, 64, "Field_%" PetscInt_FMT, f));
3729566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(name, (char **) &s->fieldNames[f]));
3739566063dSJacob Faibussowitsch     PetscCall(PetscSNPrintf(name, 64, "Component_0"));
3749566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(s->numFieldComponents[f], &s->compNames[f]));
3759566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(name, (char **) &s->compNames[f][0]));
376ea844a1aSMatthew Knepley   }
377ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
378ea844a1aSMatthew Knepley }
379ea844a1aSMatthew Knepley 
380ea844a1aSMatthew Knepley /*@C
381ea844a1aSMatthew Knepley   PetscSectionGetFieldName - Returns the name of a field in the PetscSection
382ea844a1aSMatthew Knepley 
383ea844a1aSMatthew Knepley   Not Collective
384ea844a1aSMatthew Knepley 
385ea844a1aSMatthew Knepley   Input Parameters:
386ea844a1aSMatthew Knepley + s     - the PetscSection
387ea844a1aSMatthew Knepley - field - the field number
388ea844a1aSMatthew Knepley 
389ea844a1aSMatthew Knepley   Output Parameter:
390ea844a1aSMatthew Knepley . fieldName - the field name
391ea844a1aSMatthew Knepley 
392ea844a1aSMatthew Knepley   Level: intermediate
393ea844a1aSMatthew Knepley 
394ea844a1aSMatthew Knepley .seealso: PetscSectionSetFieldName()
395ea844a1aSMatthew Knepley @*/
396ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetFieldName(PetscSection s, PetscInt field, const char *fieldName[])
397ea844a1aSMatthew Knepley {
398ea844a1aSMatthew Knepley   PetscFunctionBegin;
399ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
400ea844a1aSMatthew Knepley   PetscValidPointer(fieldName, 3);
4012abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
402ea844a1aSMatthew Knepley   *fieldName = s->fieldNames[field];
403ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
404ea844a1aSMatthew Knepley }
405ea844a1aSMatthew Knepley 
406ea844a1aSMatthew Knepley /*@C
407ea844a1aSMatthew Knepley   PetscSectionSetFieldName - Sets the name of a field in the PetscSection
408ea844a1aSMatthew Knepley 
409ea844a1aSMatthew Knepley   Not Collective
410ea844a1aSMatthew Knepley 
411ea844a1aSMatthew Knepley   Input Parameters:
412ea844a1aSMatthew Knepley + s     - the PetscSection
413ea844a1aSMatthew Knepley . field - the field number
414ea844a1aSMatthew Knepley - fieldName - the field name
415ea844a1aSMatthew Knepley 
416ea844a1aSMatthew Knepley   Level: intermediate
417ea844a1aSMatthew Knepley 
418ea844a1aSMatthew Knepley .seealso: PetscSectionGetFieldName()
419ea844a1aSMatthew Knepley @*/
420ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetFieldName(PetscSection s, PetscInt field, const char fieldName[])
421ea844a1aSMatthew Knepley {
422ea844a1aSMatthew Knepley   PetscFunctionBegin;
423ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
424ea844a1aSMatthew Knepley   if (fieldName) PetscValidCharPointer(fieldName, 3);
4252abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
4269566063dSJacob Faibussowitsch   PetscCall(PetscFree(s->fieldNames[field]));
4279566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(fieldName, (char**) &s->fieldNames[field]));
428ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
429ea844a1aSMatthew Knepley }
430ea844a1aSMatthew Knepley 
431b778fa18SValeria Barra /*@C
432b778fa18SValeria Barra   PetscSectionGetComponentName - Gets the name of a field component in the PetscSection
433b778fa18SValeria Barra 
434b778fa18SValeria Barra   Not Collective
435b778fa18SValeria Barra 
436b778fa18SValeria Barra   Input Parameters:
437b778fa18SValeria Barra + s     - the PetscSection
438b778fa18SValeria Barra . field - the field number
439b778fa18SValeria Barra . comp  - the component number
440b778fa18SValeria Barra - compName - the component name
441b778fa18SValeria Barra 
442b778fa18SValeria Barra   Level: intermediate
443b778fa18SValeria Barra 
444b778fa18SValeria Barra .seealso: PetscSectionSetComponentName()
445b778fa18SValeria Barra @*/
446b778fa18SValeria Barra PetscErrorCode PetscSectionGetComponentName(PetscSection s, PetscInt field, PetscInt comp, const char *compName[])
447b778fa18SValeria Barra {
448b778fa18SValeria Barra   PetscFunctionBegin;
449b778fa18SValeria Barra   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
450064a246eSJacob Faibussowitsch   PetscValidPointer(compName, 4);
4512abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
4522abc8c78SJacob Faibussowitsch   PetscSectionCheckValidFieldComponent(comp,s->numFieldComponents[field]);
453b778fa18SValeria Barra   *compName = s->compNames[field][comp];
454b778fa18SValeria Barra   PetscFunctionReturn(0);
455b778fa18SValeria Barra }
456b778fa18SValeria Barra 
457b778fa18SValeria Barra /*@C
458b778fa18SValeria Barra   PetscSectionSetComponentName - Sets the name of a field component in the PetscSection
459b778fa18SValeria Barra 
460b778fa18SValeria Barra   Not Collective
461b778fa18SValeria Barra 
462b778fa18SValeria Barra   Input Parameters:
463b778fa18SValeria Barra + s     - the PetscSection
464b778fa18SValeria Barra . field - the field number
465b778fa18SValeria Barra . comp  - the component number
466b778fa18SValeria Barra - compName - the component name
467b778fa18SValeria Barra 
468b778fa18SValeria Barra   Level: intermediate
469b778fa18SValeria Barra 
470b778fa18SValeria Barra .seealso: PetscSectionGetComponentName()
471b778fa18SValeria Barra @*/
472b778fa18SValeria Barra PetscErrorCode PetscSectionSetComponentName(PetscSection s, PetscInt field, PetscInt comp, const char compName[])
473b778fa18SValeria Barra {
474b778fa18SValeria Barra   PetscFunctionBegin;
475b778fa18SValeria Barra   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
476064a246eSJacob Faibussowitsch   if (compName) PetscValidCharPointer(compName, 4);
4772abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
4782abc8c78SJacob Faibussowitsch   PetscSectionCheckValidFieldComponent(comp,s->numFieldComponents[field]);
4799566063dSJacob Faibussowitsch   PetscCall(PetscFree(s->compNames[field][comp]));
4809566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(compName, (char**) &s->compNames[field][comp]));
481b778fa18SValeria Barra   PetscFunctionReturn(0);
482b778fa18SValeria Barra }
483b778fa18SValeria Barra 
484ea844a1aSMatthew Knepley /*@
485ea844a1aSMatthew Knepley   PetscSectionGetFieldComponents - Returns the number of field components for the given field.
486ea844a1aSMatthew Knepley 
48740750d41SVaclav Hapla   Not Collective
488ea844a1aSMatthew Knepley 
489ea844a1aSMatthew Knepley   Input Parameters:
490ea844a1aSMatthew Knepley + s - the PetscSection
491ea844a1aSMatthew Knepley - field - the field number
492ea844a1aSMatthew Knepley 
493ea844a1aSMatthew Knepley   Output Parameter:
494ea844a1aSMatthew Knepley . numComp - the number of field components
495ea844a1aSMatthew Knepley 
496ea844a1aSMatthew Knepley   Level: intermediate
497ea844a1aSMatthew Knepley 
498ea844a1aSMatthew Knepley .seealso: PetscSectionSetFieldComponents(), PetscSectionGetNumFields()
499ea844a1aSMatthew Knepley @*/
500ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetFieldComponents(PetscSection s, PetscInt field, PetscInt *numComp)
501ea844a1aSMatthew Knepley {
502ea844a1aSMatthew Knepley   PetscFunctionBegin;
503ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
5042abc8c78SJacob Faibussowitsch   PetscValidIntPointer(numComp, 3);
5052abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
506ea844a1aSMatthew Knepley   *numComp = s->numFieldComponents[field];
507ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
508ea844a1aSMatthew Knepley }
509ea844a1aSMatthew Knepley 
510ea844a1aSMatthew Knepley /*@
511ea844a1aSMatthew Knepley   PetscSectionSetFieldComponents - Sets the number of field components for the given field.
512ea844a1aSMatthew Knepley 
51340750d41SVaclav Hapla   Not Collective
514ea844a1aSMatthew Knepley 
515ea844a1aSMatthew Knepley   Input Parameters:
516ea844a1aSMatthew Knepley + s - the PetscSection
517ea844a1aSMatthew Knepley . field - the field number
518ea844a1aSMatthew Knepley - numComp - the number of field components
519ea844a1aSMatthew Knepley 
520ea844a1aSMatthew Knepley   Level: intermediate
521ea844a1aSMatthew Knepley 
522245d9833Sprj- .seealso: PetscSectionGetFieldComponents(), PetscSectionGetNumFields()
523ea844a1aSMatthew Knepley @*/
524ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetFieldComponents(PetscSection s, PetscInt field, PetscInt numComp)
525ea844a1aSMatthew Knepley {
526b778fa18SValeria Barra   PetscInt       c;
527b778fa18SValeria Barra 
528ea844a1aSMatthew Knepley   PetscFunctionBegin;
529ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
5302abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
531b778fa18SValeria Barra   if (s->compNames) {
532b778fa18SValeria Barra     for (c = 0; c < s->numFieldComponents[field]; ++c) {
5339566063dSJacob Faibussowitsch       PetscCall(PetscFree(s->compNames[field][c]));
534b778fa18SValeria Barra     }
5359566063dSJacob Faibussowitsch     PetscCall(PetscFree(s->compNames[field]));
536b778fa18SValeria Barra   }
537b778fa18SValeria Barra 
538ea844a1aSMatthew Knepley   s->numFieldComponents[field] = numComp;
539b778fa18SValeria Barra   if (numComp) {
5409566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(numComp, (char ***) &s->compNames[field]));
541b778fa18SValeria Barra     for (c = 0; c < numComp; ++c) {
5422abc8c78SJacob Faibussowitsch       char name[64];
5432abc8c78SJacob Faibussowitsch 
5449566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(name, 64, "%" PetscInt_FMT, c));
5459566063dSJacob Faibussowitsch       PetscCall(PetscStrallocpy(name, (char **) &s->compNames[field][c]));
546b778fa18SValeria Barra     }
547b778fa18SValeria Barra   }
548ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
549ea844a1aSMatthew Knepley }
550ea844a1aSMatthew Knepley 
551ea844a1aSMatthew Knepley /*@
552ea844a1aSMatthew Knepley   PetscSectionGetChart - Returns the range [pStart, pEnd) in which points lie.
553ea844a1aSMatthew Knepley 
55440750d41SVaclav Hapla   Not Collective
555ea844a1aSMatthew Knepley 
556ea844a1aSMatthew Knepley   Input Parameter:
557ea844a1aSMatthew Knepley . s - the PetscSection
558ea844a1aSMatthew Knepley 
559ea844a1aSMatthew Knepley   Output Parameters:
560ea844a1aSMatthew Knepley + pStart - the first point
561ea844a1aSMatthew Knepley - pEnd - one past the last point
562ea844a1aSMatthew Knepley 
563ea844a1aSMatthew Knepley   Level: intermediate
564ea844a1aSMatthew Knepley 
565ea844a1aSMatthew Knepley .seealso: PetscSectionSetChart(), PetscSectionCreate()
566ea844a1aSMatthew Knepley @*/
567ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetChart(PetscSection s, PetscInt *pStart, PetscInt *pEnd)
568ea844a1aSMatthew Knepley {
569ea844a1aSMatthew Knepley   PetscFunctionBegin;
570ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
571ea844a1aSMatthew Knepley   if (pStart) *pStart = s->pStart;
572ea844a1aSMatthew Knepley   if (pEnd)   *pEnd   = s->pEnd;
573ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
574ea844a1aSMatthew Knepley }
575ea844a1aSMatthew Knepley 
576ea844a1aSMatthew Knepley /*@
577ea844a1aSMatthew Knepley   PetscSectionSetChart - Sets the range [pStart, pEnd) in which points lie.
578ea844a1aSMatthew Knepley 
57940750d41SVaclav Hapla   Not Collective
580ea844a1aSMatthew Knepley 
581ea844a1aSMatthew Knepley   Input Parameters:
582ea844a1aSMatthew Knepley + s - the PetscSection
583ea844a1aSMatthew Knepley . pStart - the first point
584ea844a1aSMatthew Knepley - pEnd - one past the last point
585ea844a1aSMatthew Knepley 
586ea844a1aSMatthew Knepley   Level: intermediate
587ea844a1aSMatthew Knepley 
588ea844a1aSMatthew Knepley .seealso: PetscSectionGetChart(), PetscSectionCreate()
589ea844a1aSMatthew Knepley @*/
590ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetChart(PetscSection s, PetscInt pStart, PetscInt pEnd)
591ea844a1aSMatthew Knepley {
592ea844a1aSMatthew Knepley   PetscInt       f;
593ea844a1aSMatthew Knepley 
594ea844a1aSMatthew Knepley   PetscFunctionBegin;
595ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
5969318fe57SMatthew G. Knepley   if (pStart == s->pStart && pEnd == s->pEnd) PetscFunctionReturn(0);
597ea844a1aSMatthew Knepley   /* Cannot Reset() because it destroys field information */
598ea844a1aSMatthew Knepley   s->setup = PETSC_FALSE;
5999566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&s->bc));
6009566063dSJacob Faibussowitsch   PetscCall(PetscFree(s->bcIndices));
6019566063dSJacob Faibussowitsch   PetscCall(PetscFree2(s->atlasDof, s->atlasOff));
602ea844a1aSMatthew Knepley 
603ea844a1aSMatthew Knepley   s->pStart = pStart;
604ea844a1aSMatthew Knepley   s->pEnd   = pEnd;
6059566063dSJacob Faibussowitsch   PetscCall(PetscMalloc2((pEnd - pStart), &s->atlasDof, (pEnd - pStart), &s->atlasOff));
6069566063dSJacob Faibussowitsch   PetscCall(PetscArrayzero(s->atlasDof, pEnd - pStart));
607ea844a1aSMatthew Knepley   for (f = 0; f < s->numFields; ++f) {
6089566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetChart(s->field[f], pStart, pEnd));
609ea844a1aSMatthew Knepley   }
610ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
611ea844a1aSMatthew Knepley }
612ea844a1aSMatthew Knepley 
613ea844a1aSMatthew Knepley /*@
614ea844a1aSMatthew Knepley   PetscSectionGetPermutation - Returns the permutation of [0, pEnd-pStart) or NULL
615ea844a1aSMatthew Knepley 
61640750d41SVaclav Hapla   Not Collective
617ea844a1aSMatthew Knepley 
618ea844a1aSMatthew Knepley   Input Parameter:
619ea844a1aSMatthew Knepley . s - the PetscSection
620ea844a1aSMatthew Knepley 
621ea844a1aSMatthew Knepley   Output Parameters:
622ea844a1aSMatthew Knepley . perm - The permutation as an IS
623ea844a1aSMatthew Knepley 
624ea844a1aSMatthew Knepley   Level: intermediate
625ea844a1aSMatthew Knepley 
626ea844a1aSMatthew Knepley .seealso: PetscSectionSetPermutation(), PetscSectionCreate()
627ea844a1aSMatthew Knepley @*/
628ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetPermutation(PetscSection s, IS *perm)
629ea844a1aSMatthew Knepley {
630ea844a1aSMatthew Knepley   PetscFunctionBegin;
631ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
632ea844a1aSMatthew Knepley   if (perm) {PetscValidPointer(perm, 2); *perm = s->perm;}
633ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
634ea844a1aSMatthew Knepley }
635ea844a1aSMatthew Knepley 
636ea844a1aSMatthew Knepley /*@
637ea844a1aSMatthew Knepley   PetscSectionSetPermutation - Sets the permutation for [0, pEnd-pStart)
638ea844a1aSMatthew Knepley 
63940750d41SVaclav Hapla   Not Collective
640ea844a1aSMatthew Knepley 
641ea844a1aSMatthew Knepley   Input Parameters:
642ea844a1aSMatthew Knepley + s - the PetscSection
643ea844a1aSMatthew Knepley - perm - the permutation of points
644ea844a1aSMatthew Knepley 
645ea844a1aSMatthew Knepley   Level: intermediate
646ea844a1aSMatthew Knepley 
647ea844a1aSMatthew Knepley .seealso: PetscSectionGetPermutation(), PetscSectionCreate()
648ea844a1aSMatthew Knepley @*/
649ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetPermutation(PetscSection s, IS perm)
650ea844a1aSMatthew Knepley {
651ea844a1aSMatthew Knepley   PetscFunctionBegin;
652ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
653ea844a1aSMatthew Knepley   if (perm) PetscValidHeaderSpecific(perm, IS_CLASSID, 2);
65428b400f6SJacob Faibussowitsch   PetscCheck(!s->setup,PetscObjectComm((PetscObject) s), PETSC_ERR_ARG_WRONGSTATE, "Cannot set a permutation after the section is setup");
655ea844a1aSMatthew Knepley   if (s->perm != perm) {
6569566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&s->perm));
657ea844a1aSMatthew Knepley     if (perm) {
658ea844a1aSMatthew Knepley       s->perm = perm;
6599566063dSJacob Faibussowitsch       PetscCall(PetscObjectReference((PetscObject) s->perm));
660ea844a1aSMatthew Knepley     }
661ea844a1aSMatthew Knepley   }
662ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
663ea844a1aSMatthew Knepley }
664ea844a1aSMatthew Knepley 
665ea844a1aSMatthew Knepley /*@
666ea844a1aSMatthew Knepley   PetscSectionGetPointMajor - Returns the flag for dof ordering, true if it is point major, otherwise field major
667ea844a1aSMatthew Knepley 
66840750d41SVaclav Hapla   Not Collective
669ea844a1aSMatthew Knepley 
670ea844a1aSMatthew Knepley   Input Parameter:
671ea844a1aSMatthew Knepley . s - the PetscSection
672ea844a1aSMatthew Knepley 
673ea844a1aSMatthew Knepley   Output Parameter:
674ea844a1aSMatthew Knepley . pm - the flag for point major ordering
675ea844a1aSMatthew Knepley 
676ea844a1aSMatthew Knepley   Level: intermediate
677ea844a1aSMatthew Knepley 
678ea844a1aSMatthew Knepley .seealso: PetscSectionSetPointMajor()
679ea844a1aSMatthew Knepley @*/
680ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetPointMajor(PetscSection s, PetscBool *pm)
681ea844a1aSMatthew Knepley {
682ea844a1aSMatthew Knepley   PetscFunctionBegin;
683ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
684dadcf809SJacob Faibussowitsch   PetscValidBoolPointer(pm,2);
685ea844a1aSMatthew Knepley   *pm = s->pointMajor;
686ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
687ea844a1aSMatthew Knepley }
688ea844a1aSMatthew Knepley 
689ea844a1aSMatthew Knepley /*@
690ea844a1aSMatthew Knepley   PetscSectionSetPointMajor - Sets the flag for dof ordering, true if it is point major, otherwise field major
691ea844a1aSMatthew Knepley 
69240750d41SVaclav Hapla   Not Collective
693ea844a1aSMatthew Knepley 
694ea844a1aSMatthew Knepley   Input Parameters:
695ea844a1aSMatthew Knepley + s  - the PetscSection
696ea844a1aSMatthew Knepley - pm - the flag for point major ordering
697ea844a1aSMatthew Knepley 
698ea844a1aSMatthew Knepley   Level: intermediate
699ea844a1aSMatthew Knepley 
700ea844a1aSMatthew Knepley .seealso: PetscSectionGetPointMajor()
701ea844a1aSMatthew Knepley @*/
702ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetPointMajor(PetscSection s, PetscBool pm)
703ea844a1aSMatthew Knepley {
704ea844a1aSMatthew Knepley   PetscFunctionBegin;
705ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
70628b400f6SJacob Faibussowitsch   PetscCheck(!s->setup,PetscObjectComm((PetscObject) s), PETSC_ERR_ARG_WRONGSTATE, "Cannot set the dof ordering after the section is setup");
707ea844a1aSMatthew Knepley   s->pointMajor = pm;
708ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
709ea844a1aSMatthew Knepley }
710ea844a1aSMatthew Knepley 
711ea844a1aSMatthew Knepley /*@
71287e637c6Sksagiyam   PetscSectionGetIncludesConstraints - Returns the flag indicating if constrained dofs were included when computing offsets
71387e637c6Sksagiyam 
71440750d41SVaclav Hapla   Not Collective
71587e637c6Sksagiyam 
71687e637c6Sksagiyam   Input Parameter:
71787e637c6Sksagiyam . s - the PetscSection
71887e637c6Sksagiyam 
71987e637c6Sksagiyam   Output Parameter:
72087e637c6Sksagiyam . includesConstraints - the flag indicating if constrained dofs were included when computing offsets
72187e637c6Sksagiyam 
72287e637c6Sksagiyam   Level: intermediate
72387e637c6Sksagiyam 
72487e637c6Sksagiyam .seealso: PetscSectionSetIncludesConstraints()
72587e637c6Sksagiyam @*/
72687e637c6Sksagiyam PetscErrorCode PetscSectionGetIncludesConstraints(PetscSection s, PetscBool *includesConstraints)
72787e637c6Sksagiyam {
72887e637c6Sksagiyam   PetscFunctionBegin;
72987e637c6Sksagiyam   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
73087e637c6Sksagiyam   PetscValidBoolPointer(includesConstraints,2);
73187e637c6Sksagiyam   *includesConstraints = s->includesConstraints;
73287e637c6Sksagiyam   PetscFunctionReturn(0);
73387e637c6Sksagiyam }
73487e637c6Sksagiyam 
73587e637c6Sksagiyam /*@
73687e637c6Sksagiyam   PetscSectionSetIncludesConstraints - Sets the flag indicating if constrained dofs are to be included when computing offsets
73787e637c6Sksagiyam 
73840750d41SVaclav Hapla   Not Collective
73987e637c6Sksagiyam 
74087e637c6Sksagiyam   Input Parameters:
74187e637c6Sksagiyam + s  - the PetscSection
74287e637c6Sksagiyam - includesConstraints - the flag indicating if constrained dofs are to be included when computing offsets
74387e637c6Sksagiyam 
74487e637c6Sksagiyam   Level: intermediate
74587e637c6Sksagiyam 
74687e637c6Sksagiyam .seealso: PetscSectionGetIncludesConstraints()
74787e637c6Sksagiyam @*/
74887e637c6Sksagiyam PetscErrorCode PetscSectionSetIncludesConstraints(PetscSection s, PetscBool includesConstraints)
74987e637c6Sksagiyam {
75087e637c6Sksagiyam   PetscFunctionBegin;
75187e637c6Sksagiyam   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
75228b400f6SJacob Faibussowitsch   PetscCheck(!s->setup,PetscObjectComm((PetscObject) s), PETSC_ERR_ARG_WRONGSTATE, "Cannot set includesConstraints after the section is set up");
75387e637c6Sksagiyam   s->includesConstraints = includesConstraints;
75487e637c6Sksagiyam   PetscFunctionReturn(0);
75587e637c6Sksagiyam }
75687e637c6Sksagiyam 
75787e637c6Sksagiyam /*@
758ea844a1aSMatthew Knepley   PetscSectionGetDof - Return the number of degrees of freedom associated with a given point.
759ea844a1aSMatthew Knepley 
76040750d41SVaclav Hapla   Not Collective
761ea844a1aSMatthew Knepley 
762ea844a1aSMatthew Knepley   Input Parameters:
763ea844a1aSMatthew Knepley + s - the PetscSection
764ea844a1aSMatthew Knepley - point - the point
765ea844a1aSMatthew Knepley 
766ea844a1aSMatthew Knepley   Output Parameter:
767ea844a1aSMatthew Knepley . numDof - the number of dof
768ea844a1aSMatthew Knepley 
769ea844a1aSMatthew Knepley   Level: intermediate
770ea844a1aSMatthew Knepley 
771ea844a1aSMatthew Knepley .seealso: PetscSectionSetDof(), PetscSectionCreate()
772ea844a1aSMatthew Knepley @*/
773ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetDof(PetscSection s, PetscInt point, PetscInt *numDof)
774ea844a1aSMatthew Knepley {
77576bd3646SJed Brown   PetscFunctionBeginHot;
776ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
777dadcf809SJacob Faibussowitsch   PetscValidIntPointer(numDof, 3);
778c8bf3acbSVaclav 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);
779ea844a1aSMatthew Knepley   *numDof = s->atlasDof[point - s->pStart];
780ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
781ea844a1aSMatthew Knepley }
782ea844a1aSMatthew Knepley 
783ea844a1aSMatthew Knepley /*@
784ea844a1aSMatthew Knepley   PetscSectionSetDof - Sets the number of degrees of freedom associated with a given point.
785ea844a1aSMatthew Knepley 
78640750d41SVaclav Hapla   Not Collective
787ea844a1aSMatthew Knepley 
788ea844a1aSMatthew Knepley   Input Parameters:
789ea844a1aSMatthew Knepley + s - the PetscSection
790ea844a1aSMatthew Knepley . point - the point
791ea844a1aSMatthew Knepley - numDof - the number of dof
792ea844a1aSMatthew Knepley 
793ea844a1aSMatthew Knepley   Level: intermediate
794ea844a1aSMatthew Knepley 
795ea844a1aSMatthew Knepley .seealso: PetscSectionGetDof(), PetscSectionAddDof(), PetscSectionCreate()
796ea844a1aSMatthew Knepley @*/
797ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetDof(PetscSection s, PetscInt point, PetscInt numDof)
798ea844a1aSMatthew Knepley {
799ea844a1aSMatthew Knepley   PetscFunctionBegin;
800ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
801c8bf3acbSVaclav 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);
802ea844a1aSMatthew Knepley   s->atlasDof[point - s->pStart] = numDof;
803ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
804ea844a1aSMatthew Knepley }
805ea844a1aSMatthew Knepley 
806ea844a1aSMatthew Knepley /*@
807ea844a1aSMatthew Knepley   PetscSectionAddDof - Adds to the number of degrees of freedom associated with a given point.
808ea844a1aSMatthew Knepley 
80940750d41SVaclav Hapla   Not Collective
810ea844a1aSMatthew Knepley 
811ea844a1aSMatthew Knepley   Input Parameters:
812ea844a1aSMatthew Knepley + s - the PetscSection
813ea844a1aSMatthew Knepley . point - the point
814ea844a1aSMatthew Knepley - numDof - the number of additional dof
815ea844a1aSMatthew Knepley 
816ea844a1aSMatthew Knepley   Level: intermediate
817ea844a1aSMatthew Knepley 
818ea844a1aSMatthew Knepley .seealso: PetscSectionGetDof(), PetscSectionSetDof(), PetscSectionCreate()
819ea844a1aSMatthew Knepley @*/
820ea844a1aSMatthew Knepley PetscErrorCode PetscSectionAddDof(PetscSection s, PetscInt point, PetscInt numDof)
821ea844a1aSMatthew Knepley {
82276bd3646SJed Brown   PetscFunctionBeginHot;
823ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
824c8bf3acbSVaclav 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);
825ea844a1aSMatthew Knepley   s->atlasDof[point - s->pStart] += numDof;
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 
844ea844a1aSMatthew Knepley .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 
869ea844a1aSMatthew Knepley .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 
893ea844a1aSMatthew Knepley .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 
918ea844a1aSMatthew Knepley .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 
943ea844a1aSMatthew Knepley .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) {
950*7c0883d5SVaclav 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 
968ea844a1aSMatthew Knepley .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) {
975*7c0883d5SVaclav 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 
996ea844a1aSMatthew Knepley .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 
1021ea844a1aSMatthew Knepley .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 
1045ea844a1aSMatthew Knepley .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 
1066ea844a1aSMatthew Knepley .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));
10769566063dSJacob Faibussowitsch     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 
1091ea844a1aSMatthew Knepley .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       s->maxDof      = PetscMax(s->maxDof, s->atlasDof[q]);
1114ea844a1aSMatthew Knepley       /* Set field offset */
1115ea844a1aSMatthew Knepley       for (f = 0, foff = s->atlasOff[q]; f < s->numFields; ++f) {
1116ea844a1aSMatthew Knepley         PetscSection sf = s->field[f];
1117ea844a1aSMatthew Knepley 
1118ea844a1aSMatthew Knepley         sf->atlasOff[q] = foff;
1119ea844a1aSMatthew Knepley         foff += sf->atlasDof[q];
1120ea844a1aSMatthew Knepley       }
1121ea844a1aSMatthew Knepley     }
1122ea844a1aSMatthew Knepley   } else {
1123ea844a1aSMatthew Knepley     /* Set field offsets for all points */
1124ea844a1aSMatthew Knepley     for (f = 0; f < s->numFields; ++f) {
1125ea844a1aSMatthew Knepley       PetscSection sf = s->field[f];
1126ea844a1aSMatthew Knepley 
1127ea844a1aSMatthew Knepley       for (p = 0; p < s->pEnd - s->pStart; ++p) {
1128ea844a1aSMatthew Knepley         const PetscInt q = pind ? pind[p] : p;
1129ea844a1aSMatthew Knepley 
1130ea844a1aSMatthew Knepley         sf->atlasOff[q] = offset;
1131ea844a1aSMatthew Knepley         offset += sf->atlasDof[q];
1132ea844a1aSMatthew Knepley       }
1133ea844a1aSMatthew Knepley     }
1134ea844a1aSMatthew Knepley     /* Disable point offsets since these are unused */
1135ea844a1aSMatthew Knepley     for (p = 0; p < s->pEnd - s->pStart; ++p) {
1136ea844a1aSMatthew Knepley       s->atlasOff[p] = -1;
1137ea844a1aSMatthew Knepley       s->maxDof      = PetscMax(s->maxDof, s->atlasDof[p]);
1138ea844a1aSMatthew Knepley     }
1139ea844a1aSMatthew Knepley   }
11409566063dSJacob Faibussowitsch   if (s->perm) PetscCall(ISRestoreIndices(s->perm, &pind));
1141ea844a1aSMatthew Knepley   /* Setup BC sections */
11429566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUpBC(s));
11439566063dSJacob Faibussowitsch   for (f = 0; f < s->numFields; ++f) PetscCall(PetscSectionSetUpBC(s->field[f]));
1144ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1145ea844a1aSMatthew Knepley }
1146ea844a1aSMatthew Knepley 
1147ea844a1aSMatthew Knepley /*@
1148ea844a1aSMatthew Knepley   PetscSectionGetMaxDof - Return the maximum number of degrees of freedom on any point in the chart
1149ea844a1aSMatthew Knepley 
115040750d41SVaclav Hapla   Not Collective
1151ea844a1aSMatthew Knepley 
1152ea844a1aSMatthew Knepley   Input Parameters:
1153ea844a1aSMatthew Knepley . s - the PetscSection
1154ea844a1aSMatthew Knepley 
1155ea844a1aSMatthew Knepley   Output Parameter:
1156ea844a1aSMatthew Knepley . maxDof - the maximum dof
1157ea844a1aSMatthew Knepley 
1158ea844a1aSMatthew Knepley   Level: intermediate
1159ea844a1aSMatthew Knepley 
1160ea844a1aSMatthew Knepley .seealso: PetscSectionGetDof(), PetscSectionSetDof(), PetscSectionCreate()
1161ea844a1aSMatthew Knepley @*/
1162ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetMaxDof(PetscSection s, PetscInt *maxDof)
1163ea844a1aSMatthew Knepley {
1164ea844a1aSMatthew Knepley   PetscFunctionBegin;
1165ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1166dadcf809SJacob Faibussowitsch   PetscValidIntPointer(maxDof, 2);
1167ea844a1aSMatthew Knepley   *maxDof = s->maxDof;
1168ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1169ea844a1aSMatthew Knepley }
1170ea844a1aSMatthew Knepley 
1171ea844a1aSMatthew Knepley /*@
1172ea844a1aSMatthew Knepley   PetscSectionGetStorageSize - Return the size of an array or local Vec capable of holding all the degrees of freedom.
1173ea844a1aSMatthew Knepley 
117440750d41SVaclav Hapla   Not Collective
1175ea844a1aSMatthew Knepley 
1176ea844a1aSMatthew Knepley   Input Parameter:
1177ea844a1aSMatthew Knepley . s - the PetscSection
1178ea844a1aSMatthew Knepley 
1179ea844a1aSMatthew Knepley   Output Parameter:
1180ea844a1aSMatthew Knepley . size - the size of an array which can hold all the dofs
1181ea844a1aSMatthew Knepley 
1182ea844a1aSMatthew Knepley   Level: intermediate
1183ea844a1aSMatthew Knepley 
1184ea844a1aSMatthew Knepley .seealso: PetscSectionGetOffset(), PetscSectionGetConstrainedStorageSize(), PetscSectionCreate()
1185ea844a1aSMatthew Knepley @*/
1186ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetStorageSize(PetscSection s, PetscInt *size)
1187ea844a1aSMatthew Knepley {
1188ea844a1aSMatthew Knepley   PetscInt p, n = 0;
1189ea844a1aSMatthew Knepley 
1190ea844a1aSMatthew Knepley   PetscFunctionBegin;
1191ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1192dadcf809SJacob Faibussowitsch   PetscValidIntPointer(size, 2);
1193ea844a1aSMatthew Knepley   for (p = 0; p < s->pEnd - s->pStart; ++p) n += s->atlasDof[p] > 0 ? s->atlasDof[p] : 0;
1194ea844a1aSMatthew Knepley   *size = n;
1195ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1196ea844a1aSMatthew Knepley }
1197ea844a1aSMatthew Knepley 
1198ea844a1aSMatthew Knepley /*@
1199ea844a1aSMatthew Knepley   PetscSectionGetConstrainedStorageSize - Return the size of an array or local Vec capable of holding all unconstrained degrees of freedom.
1200ea844a1aSMatthew Knepley 
120140750d41SVaclav Hapla   Not Collective
1202ea844a1aSMatthew Knepley 
1203064ec1f3Sprj-   Input Parameter:
1204064ec1f3Sprj- . s - the PetscSection
1205ea844a1aSMatthew Knepley 
1206ea844a1aSMatthew Knepley   Output Parameter:
1207ea844a1aSMatthew Knepley . size - the size of an array which can hold all unconstrained dofs
1208ea844a1aSMatthew Knepley 
1209ea844a1aSMatthew Knepley   Level: intermediate
1210ea844a1aSMatthew Knepley 
1211ea844a1aSMatthew Knepley .seealso: PetscSectionGetStorageSize(), PetscSectionGetOffset(), PetscSectionCreate()
1212ea844a1aSMatthew Knepley @*/
1213ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetConstrainedStorageSize(PetscSection s, PetscInt *size)
1214ea844a1aSMatthew Knepley {
1215ea844a1aSMatthew Knepley   PetscInt p, n = 0;
1216ea844a1aSMatthew Knepley 
1217ea844a1aSMatthew Knepley   PetscFunctionBegin;
1218ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1219dadcf809SJacob Faibussowitsch   PetscValidIntPointer(size, 2);
1220ea844a1aSMatthew Knepley   for (p = 0; p < s->pEnd - s->pStart; ++p) {
1221ea844a1aSMatthew Knepley     const PetscInt cdof = s->bc ? s->bc->atlasDof[p] : 0;
1222ea844a1aSMatthew Knepley     n += s->atlasDof[p] > 0 ? s->atlasDof[p] - cdof : 0;
1223ea844a1aSMatthew Knepley   }
1224ea844a1aSMatthew Knepley   *size = n;
1225ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1226ea844a1aSMatthew Knepley }
1227ea844a1aSMatthew Knepley 
1228ea844a1aSMatthew Knepley /*@
1229ea844a1aSMatthew Knepley   PetscSectionCreateGlobalSection - Create a section describing the global field layout using
1230ea844a1aSMatthew Knepley   the local section and an SF describing the section point overlap.
1231ea844a1aSMatthew Knepley 
1232ea844a1aSMatthew Knepley   Input Parameters:
1233ea844a1aSMatthew Knepley + s - The PetscSection for the local field layout
1234ea844a1aSMatthew Knepley . sf - The SF describing parallel layout of the section points (leaves are unowned local points)
1235ea844a1aSMatthew Knepley . includeConstraints - By default this is PETSC_FALSE, meaning that the global field vector will not possess constrained dofs
1236ea844a1aSMatthew Knepley - localOffsets - If PETSC_TRUE, use local rather than global offsets for the points
1237ea844a1aSMatthew Knepley 
1238ea844a1aSMatthew Knepley   Output Parameter:
1239ea844a1aSMatthew Knepley . gsection - The PetscSection for the global field layout
1240ea844a1aSMatthew Knepley 
1241ea844a1aSMatthew Knepley   Note: This gives negative sizes and offsets to points not owned by this process
1242ea844a1aSMatthew Knepley 
1243ea844a1aSMatthew Knepley   Level: intermediate
1244ea844a1aSMatthew Knepley 
1245ea844a1aSMatthew Knepley .seealso: PetscSectionCreate()
1246ea844a1aSMatthew Knepley @*/
1247ea844a1aSMatthew Knepley PetscErrorCode PetscSectionCreateGlobalSection(PetscSection s, PetscSF sf, PetscBool includeConstraints, PetscBool localOffsets, PetscSection *gsection)
1248ea844a1aSMatthew Knepley {
1249ea844a1aSMatthew Knepley   PetscSection    gs;
1250ea844a1aSMatthew Knepley   const PetscInt *pind = NULL;
1251ea844a1aSMatthew Knepley   PetscInt       *recv = NULL, *neg = NULL;
1252046d2115Sksagiyam   PetscInt        pStart, pEnd, p, dof, cdof, off, foff, globalOff = 0, nroots, nlocal, maxleaf;
1253046d2115Sksagiyam   PetscInt        numFields, f, numComponents;
1254ea844a1aSMatthew Knepley 
1255ea844a1aSMatthew Knepley   PetscFunctionBegin;
1256ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1257ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
1258ea844a1aSMatthew Knepley   PetscValidLogicalCollectiveBool(s, includeConstraints, 3);
1259ea844a1aSMatthew Knepley   PetscValidLogicalCollectiveBool(s, localOffsets, 4);
1260ea844a1aSMatthew Knepley   PetscValidPointer(gsection, 5);
126128b400f6SJacob Faibussowitsch   PetscCheck(s->pointMajor,PETSC_COMM_SELF,PETSC_ERR_SUP, "No support for field major ordering");
12629566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject) s), &gs));
12639566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetNumFields(s, &numFields));
12649566063dSJacob Faibussowitsch   if (numFields > 0) PetscCall(PetscSectionSetNumFields(gs, numFields));
12659566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
12669566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(gs, pStart, pEnd));
126787e637c6Sksagiyam   gs->includesConstraints = includeConstraints;
12689566063dSJacob Faibussowitsch   PetscCall(PetscSFGetGraph(sf, &nroots, NULL, NULL, NULL));
1269ea844a1aSMatthew Knepley   nlocal = nroots;              /* The local/leaf space matches global/root space */
1270ea844a1aSMatthew Knepley   /* Must allocate for all points visible to SF, which may be more than this section */
1271ea844a1aSMatthew Knepley   if (nroots >= 0) {             /* nroots < 0 means that the graph has not been set, only happens in serial */
12729566063dSJacob Faibussowitsch     PetscCall(PetscSFGetLeafRange(sf, NULL, &maxleaf));
12732c71b3e2SJacob Faibussowitsch     PetscCheckFalse(nroots < pEnd,PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "SF roots %" PetscInt_FMT " < pEnd %" PetscInt_FMT, nroots, pEnd);
12742c71b3e2SJacob Faibussowitsch     PetscCheckFalse(maxleaf >= nroots,PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "Max local leaf %" PetscInt_FMT " >= nroots %" PetscInt_FMT, maxleaf, nroots);
12759566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nroots,&neg,nlocal,&recv));
12769566063dSJacob Faibussowitsch     PetscCall(PetscArrayzero(neg,nroots));
1277ea844a1aSMatthew Knepley   }
1278ea844a1aSMatthew Knepley   /* Mark all local points with negative dof */
1279ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
12809566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s, p, &dof));
12819566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(gs, p, dof));
12829566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s, p, &cdof));
12839566063dSJacob Faibussowitsch     if (!includeConstraints && cdof > 0) PetscCall(PetscSectionSetConstraintDof(gs, p, cdof));
1284ea844a1aSMatthew Knepley     if (neg) neg[p] = -(dof+1);
1285ea844a1aSMatthew Knepley   }
12869566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUpBC(gs));
12879566063dSJacob 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]));
1288ea844a1aSMatthew Knepley   if (nroots >= 0) {
12899566063dSJacob Faibussowitsch     PetscCall(PetscArrayzero(recv,nlocal));
12909566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastBegin(sf, MPIU_INT, neg, recv,MPI_REPLACE));
12919566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastEnd(sf, MPIU_INT, neg, recv,MPI_REPLACE));
1292ea844a1aSMatthew Knepley     for (p = pStart; p < pEnd; ++p) {
1293ea844a1aSMatthew Knepley       if (recv[p] < 0) {
1294ea844a1aSMatthew Knepley         gs->atlasDof[p-pStart] = recv[p];
12959566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetDof(s, p, &dof));
12962c71b3e2SJacob Faibussowitsch         PetscCheckFalse(-(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);
1297ea844a1aSMatthew Knepley       }
1298ea844a1aSMatthew Knepley     }
1299ea844a1aSMatthew Knepley   }
1300ea844a1aSMatthew Knepley   /* Calculate new sizes, get process offset, and calculate point offsets */
13019566063dSJacob Faibussowitsch   if (s->perm) PetscCall(ISGetIndices(s->perm, &pind));
1302ea844a1aSMatthew Knepley   for (p = 0, off = 0; p < pEnd-pStart; ++p) {
1303ea844a1aSMatthew Knepley     const PetscInt q = pind ? pind[p] : p;
1304ea844a1aSMatthew Knepley 
1305ea844a1aSMatthew Knepley     cdof = (!includeConstraints && s->bc) ? s->bc->atlasDof[q] : 0;
1306ea844a1aSMatthew Knepley     gs->atlasOff[q] = off;
1307ea844a1aSMatthew Knepley     off += gs->atlasDof[q] > 0 ? gs->atlasDof[q]-cdof : 0;
1308ea844a1aSMatthew Knepley   }
1309ea844a1aSMatthew Knepley   if (!localOffsets) {
13109566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Scan(&off, &globalOff, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject) s)));
1311ea844a1aSMatthew Knepley     globalOff -= off;
1312ea844a1aSMatthew Knepley   }
1313ea844a1aSMatthew Knepley   for (p = pStart, off = 0; p < pEnd; ++p) {
1314ea844a1aSMatthew Knepley     gs->atlasOff[p-pStart] += globalOff;
1315ea844a1aSMatthew Knepley     if (neg) neg[p] = -(gs->atlasOff[p-pStart]+1);
1316ea844a1aSMatthew Knepley   }
13179566063dSJacob Faibussowitsch   if (s->perm) PetscCall(ISRestoreIndices(s->perm, &pind));
1318ea844a1aSMatthew Knepley   /* Put in negative offsets for ghost points */
1319ea844a1aSMatthew Knepley   if (nroots >= 0) {
13209566063dSJacob Faibussowitsch     PetscCall(PetscArrayzero(recv,nlocal));
13219566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastBegin(sf, MPIU_INT, neg, recv,MPI_REPLACE));
13229566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastEnd(sf, MPIU_INT, neg, recv,MPI_REPLACE));
1323ea844a1aSMatthew Knepley     for (p = pStart; p < pEnd; ++p) {
1324ea844a1aSMatthew Knepley       if (recv[p] < 0) gs->atlasOff[p-pStart] = recv[p];
1325ea844a1aSMatthew Knepley     }
1326ea844a1aSMatthew Knepley   }
13279566063dSJacob Faibussowitsch   PetscCall(PetscFree2(neg,recv));
1328046d2115Sksagiyam   /* Set field dofs/offsets/constraints */
1329046d2115Sksagiyam   for (f = 0; f < numFields; ++f) {
1330046d2115Sksagiyam     gs->field[f]->includesConstraints = includeConstraints;
13319566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldComponents(s, f, &numComponents));
13329566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldComponents(gs, f, numComponents));
1333046d2115Sksagiyam   }
1334046d2115Sksagiyam   for (p = pStart; p < pEnd; ++p) {
13359566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(gs, p, &off));
1336046d2115Sksagiyam     for (f = 0, foff = off; f < numFields; ++f) {
13379566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintDof(s, p, f, &cdof));
13389566063dSJacob Faibussowitsch       if (!includeConstraints && cdof > 0) PetscCall(PetscSectionSetFieldConstraintDof(gs, p, f, cdof));
13399566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldDof(s, p, f, &dof));
13409566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldDof(gs, p, f, off < 0 ? -(dof + 1) : dof));
13419566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldOffset(gs, p, f, foff));
13429566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintDof(gs, p, f, &cdof));
1343046d2115Sksagiyam       foff = off < 0 ? foff - (dof - cdof) : foff + (dof - cdof);
1344046d2115Sksagiyam     }
1345046d2115Sksagiyam   }
1346046d2115Sksagiyam   for (f = 0; f < numFields; ++f) {
1347046d2115Sksagiyam     PetscSection gfs = gs->field[f];
1348046d2115Sksagiyam 
13499566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetUpBC(gfs));
13509566063dSJacob 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]));
1351046d2115Sksagiyam   }
1352046d2115Sksagiyam   gs->setup = PETSC_TRUE;
13539566063dSJacob Faibussowitsch   PetscCall(PetscSectionViewFromOptions(gs, NULL, "-global_section_view"));
1354ea844a1aSMatthew Knepley   *gsection = gs;
1355ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1356ea844a1aSMatthew Knepley }
1357ea844a1aSMatthew Knepley 
1358ea844a1aSMatthew Knepley /*@
1359ea844a1aSMatthew Knepley   PetscSectionCreateGlobalSectionCensored - Create a section describing the global field layout using
1360ea844a1aSMatthew Knepley   the local section and an SF describing the section point overlap.
1361ea844a1aSMatthew Knepley 
1362ea844a1aSMatthew Knepley   Input Parameters:
1363ea844a1aSMatthew Knepley   + s - The PetscSection for the local field layout
1364ea844a1aSMatthew Knepley   . sf - The SF describing parallel layout of the section points
1365ea844a1aSMatthew Knepley   . includeConstraints - By default this is PETSC_FALSE, meaning that the global field vector will not possess constrained dofs
1366ea844a1aSMatthew Knepley   . numExcludes - The number of exclusion ranges
1367ea844a1aSMatthew Knepley   - excludes - An array [start_0, end_0, start_1, end_1, ...] where there are numExcludes pairs
1368ea844a1aSMatthew Knepley 
1369ea844a1aSMatthew Knepley   Output Parameter:
1370ea844a1aSMatthew Knepley   . gsection - The PetscSection for the global field layout
1371ea844a1aSMatthew Knepley 
1372ea844a1aSMatthew Knepley   Note: This gives negative sizes and offsets to points not owned by this process
1373ea844a1aSMatthew Knepley 
1374ea844a1aSMatthew Knepley   Level: advanced
1375ea844a1aSMatthew Knepley 
1376ea844a1aSMatthew Knepley .seealso: PetscSectionCreate()
1377ea844a1aSMatthew Knepley @*/
1378ea844a1aSMatthew Knepley PetscErrorCode PetscSectionCreateGlobalSectionCensored(PetscSection s, PetscSF sf, PetscBool includeConstraints, PetscInt numExcludes, const PetscInt excludes[], PetscSection *gsection)
1379ea844a1aSMatthew Knepley {
1380ea844a1aSMatthew Knepley   const PetscInt *pind = NULL;
1381ea844a1aSMatthew Knepley   PetscInt       *neg  = NULL, *tmpOff = NULL;
1382ea844a1aSMatthew Knepley   PetscInt        pStart, pEnd, p, e, dof, cdof, off, globalOff = 0, nroots;
1383ea844a1aSMatthew Knepley 
1384ea844a1aSMatthew Knepley   PetscFunctionBegin;
1385ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1386ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
1387ea844a1aSMatthew Knepley   PetscValidPointer(gsection, 6);
13889566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject) s), gsection));
13899566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
13909566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(*gsection, pStart, pEnd));
13919566063dSJacob Faibussowitsch   PetscCall(PetscSFGetGraph(sf, &nroots, NULL, NULL, NULL));
1392ea844a1aSMatthew Knepley   if (nroots >= 0) {
13932c71b3e2SJacob Faibussowitsch     PetscCheckFalse(nroots < pEnd-pStart,PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "PetscSF nroots %" PetscInt_FMT " < %" PetscInt_FMT " section size", nroots, pEnd-pStart);
13949566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(nroots, &neg));
1395ea844a1aSMatthew Knepley     if (nroots > pEnd-pStart) {
13969566063dSJacob Faibussowitsch       PetscCall(PetscCalloc1(nroots, &tmpOff));
1397ea844a1aSMatthew Knepley     } else {
1398ea844a1aSMatthew Knepley       tmpOff = &(*gsection)->atlasDof[-pStart];
1399ea844a1aSMatthew Knepley     }
1400ea844a1aSMatthew Knepley   }
1401ea844a1aSMatthew Knepley   /* Mark ghost points with negative dof */
1402ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
1403ea844a1aSMatthew Knepley     for (e = 0; e < numExcludes; ++e) {
1404ea844a1aSMatthew Knepley       if ((p >= excludes[e*2+0]) && (p < excludes[e*2+1])) {
14059566063dSJacob Faibussowitsch         PetscCall(PetscSectionSetDof(*gsection, p, 0));
1406ea844a1aSMatthew Knepley         break;
1407ea844a1aSMatthew Knepley       }
1408ea844a1aSMatthew Knepley     }
1409ea844a1aSMatthew Knepley     if (e < numExcludes) continue;
14109566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s, p, &dof));
14119566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(*gsection, p, dof));
14129566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s, p, &cdof));
14139566063dSJacob Faibussowitsch     if (!includeConstraints && cdof > 0) PetscCall(PetscSectionSetConstraintDof(*gsection, p, cdof));
1414ea844a1aSMatthew Knepley     if (neg) neg[p] = -(dof+1);
1415ea844a1aSMatthew Knepley   }
14169566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUpBC(*gsection));
1417ea844a1aSMatthew Knepley   if (nroots >= 0) {
14189566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastBegin(sf, MPIU_INT, neg, tmpOff,MPI_REPLACE));
14199566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastEnd(sf, MPIU_INT, neg, tmpOff,MPI_REPLACE));
1420ea844a1aSMatthew Knepley     if (nroots > pEnd - pStart) {
1421ea844a1aSMatthew Knepley       for (p = pStart; p < pEnd; ++p) {if (tmpOff[p] < 0) (*gsection)->atlasDof[p-pStart] = tmpOff[p];}
1422ea844a1aSMatthew Knepley     }
1423ea844a1aSMatthew Knepley   }
1424ea844a1aSMatthew Knepley   /* Calculate new sizes, get proccess offset, and calculate point offsets */
14259566063dSJacob Faibussowitsch   if (s->perm) PetscCall(ISGetIndices(s->perm, &pind));
1426ea844a1aSMatthew Knepley   for (p = 0, off = 0; p < pEnd-pStart; ++p) {
1427ea844a1aSMatthew Knepley     const PetscInt q = pind ? pind[p] : p;
1428ea844a1aSMatthew Knepley 
1429ea844a1aSMatthew Knepley     cdof = (!includeConstraints && s->bc) ? s->bc->atlasDof[q] : 0;
1430ea844a1aSMatthew Knepley     (*gsection)->atlasOff[q] = off;
1431ea844a1aSMatthew Knepley     off += (*gsection)->atlasDof[q] > 0 ? (*gsection)->atlasDof[q]-cdof : 0;
1432ea844a1aSMatthew Knepley   }
14339566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Scan(&off, &globalOff, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject) s)));
1434ea844a1aSMatthew Knepley   globalOff -= off;
1435ea844a1aSMatthew Knepley   for (p = 0, off = 0; p < pEnd-pStart; ++p) {
1436ea844a1aSMatthew Knepley     (*gsection)->atlasOff[p] += globalOff;
1437ea844a1aSMatthew Knepley     if (neg) neg[p+pStart] = -((*gsection)->atlasOff[p]+1);
1438ea844a1aSMatthew Knepley   }
14399566063dSJacob Faibussowitsch   if (s->perm) PetscCall(ISRestoreIndices(s->perm, &pind));
1440ea844a1aSMatthew Knepley   /* Put in negative offsets for ghost points */
1441ea844a1aSMatthew Knepley   if (nroots >= 0) {
1442ea844a1aSMatthew Knepley     if (nroots == pEnd-pStart) tmpOff = &(*gsection)->atlasOff[-pStart];
14439566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastBegin(sf, MPIU_INT, neg, tmpOff,MPI_REPLACE));
14449566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastEnd(sf, MPIU_INT, neg, tmpOff,MPI_REPLACE));
1445ea844a1aSMatthew Knepley     if (nroots > pEnd - pStart) {
1446ea844a1aSMatthew Knepley       for (p = pStart; p < pEnd; ++p) {if (tmpOff[p] < 0) (*gsection)->atlasOff[p-pStart] = tmpOff[p];}
1447ea844a1aSMatthew Knepley     }
1448ea844a1aSMatthew Knepley   }
14499566063dSJacob Faibussowitsch   if (nroots >= 0 && nroots > pEnd-pStart) PetscCall(PetscFree(tmpOff));
14509566063dSJacob Faibussowitsch   PetscCall(PetscFree(neg));
1451ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1452ea844a1aSMatthew Knepley }
1453ea844a1aSMatthew Knepley 
1454ea844a1aSMatthew Knepley /*@
1455ea844a1aSMatthew Knepley   PetscSectionGetPointLayout - Get the PetscLayout associated with the section points
1456ea844a1aSMatthew Knepley 
1457ea844a1aSMatthew Knepley   Collective on comm
1458ea844a1aSMatthew Knepley 
1459ea844a1aSMatthew Knepley   Input Parameters:
1460ea844a1aSMatthew Knepley + comm - The MPI_Comm
1461ea844a1aSMatthew Knepley - s    - The PetscSection
1462ea844a1aSMatthew Knepley 
1463ea844a1aSMatthew Knepley   Output Parameter:
1464ea844a1aSMatthew Knepley . layout - The point layout for the section
1465ea844a1aSMatthew Knepley 
14661681d8a4SMatthew Knepley   Note: This is usually called for the default global section.
1467ea844a1aSMatthew Knepley 
1468ea844a1aSMatthew Knepley   Level: advanced
1469ea844a1aSMatthew Knepley 
1470ea844a1aSMatthew Knepley .seealso: PetscSectionGetValueLayout(), PetscSectionCreate()
1471ea844a1aSMatthew Knepley @*/
1472ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetPointLayout(MPI_Comm comm, PetscSection s, PetscLayout *layout)
1473ea844a1aSMatthew Knepley {
1474ea844a1aSMatthew Knepley   PetscInt       pStart, pEnd, p, localSize = 0;
1475ea844a1aSMatthew Knepley 
1476ea844a1aSMatthew Knepley   PetscFunctionBegin;
14779566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
1478ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
1479ea844a1aSMatthew Knepley     PetscInt dof;
1480ea844a1aSMatthew Knepley 
14819566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s, p, &dof));
14829120ba30SVaclav Hapla     if (dof >= 0) ++localSize;
1483ea844a1aSMatthew Knepley   }
14849566063dSJacob Faibussowitsch   PetscCall(PetscLayoutCreate(comm, layout));
14859566063dSJacob Faibussowitsch   PetscCall(PetscLayoutSetLocalSize(*layout, localSize));
14869566063dSJacob Faibussowitsch   PetscCall(PetscLayoutSetBlockSize(*layout, 1));
14879566063dSJacob Faibussowitsch   PetscCall(PetscLayoutSetUp(*layout));
1488ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1489ea844a1aSMatthew Knepley }
1490ea844a1aSMatthew Knepley 
1491ea844a1aSMatthew Knepley /*@
1492ea844a1aSMatthew Knepley   PetscSectionGetValueLayout - Get the PetscLayout associated with the section dofs.
1493ea844a1aSMatthew Knepley 
1494ea844a1aSMatthew Knepley   Collective on comm
1495ea844a1aSMatthew Knepley 
1496ea844a1aSMatthew Knepley   Input Parameters:
1497ea844a1aSMatthew Knepley + comm - The MPI_Comm
1498ea844a1aSMatthew Knepley - s    - The PetscSection
1499ea844a1aSMatthew Knepley 
1500ea844a1aSMatthew Knepley   Output Parameter:
1501ea844a1aSMatthew Knepley . layout - The dof layout for the section
1502ea844a1aSMatthew Knepley 
1503ea844a1aSMatthew Knepley   Note: This is usually called for the default global section.
1504ea844a1aSMatthew Knepley 
1505ea844a1aSMatthew Knepley   Level: advanced
1506ea844a1aSMatthew Knepley 
1507ea844a1aSMatthew Knepley .seealso: PetscSectionGetPointLayout(), PetscSectionCreate()
1508ea844a1aSMatthew Knepley @*/
1509ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetValueLayout(MPI_Comm comm, PetscSection s, PetscLayout *layout)
1510ea844a1aSMatthew Knepley {
1511ea844a1aSMatthew Knepley   PetscInt       pStart, pEnd, p, localSize = 0;
1512ea844a1aSMatthew Knepley 
1513ea844a1aSMatthew Knepley   PetscFunctionBegin;
1514ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 2);
1515ea844a1aSMatthew Knepley   PetscValidPointer(layout, 3);
15169566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
1517ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
1518ea844a1aSMatthew Knepley     PetscInt dof,cdof;
1519ea844a1aSMatthew Knepley 
15209566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s, p, &dof));
15219566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s, p, &cdof));
1522ea844a1aSMatthew Knepley     if (dof-cdof > 0) localSize += dof-cdof;
1523ea844a1aSMatthew Knepley   }
15249566063dSJacob Faibussowitsch   PetscCall(PetscLayoutCreate(comm, layout));
15259566063dSJacob Faibussowitsch   PetscCall(PetscLayoutSetLocalSize(*layout, localSize));
15269566063dSJacob Faibussowitsch   PetscCall(PetscLayoutSetBlockSize(*layout, 1));
15279566063dSJacob Faibussowitsch   PetscCall(PetscLayoutSetUp(*layout));
1528ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1529ea844a1aSMatthew Knepley }
1530ea844a1aSMatthew Knepley 
1531ea844a1aSMatthew Knepley /*@
1532ea844a1aSMatthew Knepley   PetscSectionGetOffset - Return the offset into an array or local Vec for the dof associated with the given point.
1533ea844a1aSMatthew Knepley 
153440750d41SVaclav Hapla   Not Collective
1535ea844a1aSMatthew Knepley 
1536ea844a1aSMatthew Knepley   Input Parameters:
1537ea844a1aSMatthew Knepley + s - the PetscSection
1538ea844a1aSMatthew Knepley - point - the point
1539ea844a1aSMatthew Knepley 
1540ea844a1aSMatthew Knepley   Output Parameter:
1541ea844a1aSMatthew Knepley . offset - the offset
1542ea844a1aSMatthew Knepley 
1543ea844a1aSMatthew Knepley   Level: intermediate
1544ea844a1aSMatthew Knepley 
1545ea844a1aSMatthew Knepley .seealso: PetscSectionGetFieldOffset(), PetscSectionCreate()
1546ea844a1aSMatthew Knepley @*/
1547ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetOffset(PetscSection s, PetscInt point, PetscInt *offset)
1548ea844a1aSMatthew Knepley {
1549ea844a1aSMatthew Knepley   PetscFunctionBegin;
1550ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1551dadcf809SJacob Faibussowitsch   PetscValidIntPointer(offset, 3);
155276bd3646SJed Brown   if (PetscDefined(USE_DEBUG)) {
15532c71b3e2SJacob Faibussowitsch     PetscCheckFalse((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);
155476bd3646SJed Brown   }
1555ea844a1aSMatthew Knepley   *offset = s->atlasOff[point - s->pStart];
1556ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1557ea844a1aSMatthew Knepley }
1558ea844a1aSMatthew Knepley 
1559ea844a1aSMatthew Knepley /*@
1560ea844a1aSMatthew Knepley   PetscSectionSetOffset - Set the offset into an array or local Vec for the dof associated with the given point.
1561ea844a1aSMatthew Knepley 
156240750d41SVaclav Hapla   Not Collective
1563ea844a1aSMatthew Knepley 
1564ea844a1aSMatthew Knepley   Input Parameters:
1565ea844a1aSMatthew Knepley + s - the PetscSection
1566ea844a1aSMatthew Knepley . point - the point
1567ea844a1aSMatthew Knepley - offset - the offset
1568ea844a1aSMatthew Knepley 
1569ea844a1aSMatthew Knepley   Note: The user usually does not call this function, but uses PetscSectionSetUp()
1570ea844a1aSMatthew Knepley 
1571ea844a1aSMatthew Knepley   Level: intermediate
1572ea844a1aSMatthew Knepley 
1573ea844a1aSMatthew Knepley .seealso: PetscSectionGetFieldOffset(), PetscSectionCreate(), PetscSectionSetUp()
1574ea844a1aSMatthew Knepley @*/
1575ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetOffset(PetscSection s, PetscInt point, PetscInt offset)
1576ea844a1aSMatthew Knepley {
1577ea844a1aSMatthew Knepley   PetscFunctionBegin;
1578ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
15792c71b3e2SJacob Faibussowitsch   PetscCheckFalse((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);
1580ea844a1aSMatthew Knepley   s->atlasOff[point - s->pStart] = offset;
1581ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1582ea844a1aSMatthew Knepley }
1583ea844a1aSMatthew Knepley 
1584ea844a1aSMatthew Knepley /*@
1585ea844a1aSMatthew Knepley   PetscSectionGetFieldOffset - Return the offset into an array or local Vec for the dof associated with the given point.
1586ea844a1aSMatthew Knepley 
158740750d41SVaclav Hapla   Not Collective
1588ea844a1aSMatthew Knepley 
1589ea844a1aSMatthew Knepley   Input Parameters:
1590ea844a1aSMatthew Knepley + s - the PetscSection
1591ea844a1aSMatthew Knepley . point - the point
1592ea844a1aSMatthew Knepley - field - the field
1593ea844a1aSMatthew Knepley 
1594ea844a1aSMatthew Knepley   Output Parameter:
1595ea844a1aSMatthew Knepley . offset - the offset
1596ea844a1aSMatthew Knepley 
1597ea844a1aSMatthew Knepley   Level: intermediate
1598ea844a1aSMatthew Knepley 
1599ea844a1aSMatthew Knepley .seealso: PetscSectionGetOffset(), PetscSectionCreate()
1600ea844a1aSMatthew Knepley @*/
1601ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetFieldOffset(PetscSection s, PetscInt point, PetscInt field, PetscInt *offset)
1602ea844a1aSMatthew Knepley {
1603ea844a1aSMatthew Knepley   PetscFunctionBegin;
1604ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
16052abc8c78SJacob Faibussowitsch   PetscValidIntPointer(offset, 4);
16062abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
16079566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(s->field[field], point, offset));
1608ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1609ea844a1aSMatthew Knepley }
1610ea844a1aSMatthew Knepley 
1611ea844a1aSMatthew Knepley /*@
16121681d8a4SMatthew Knepley   PetscSectionSetFieldOffset - Set the offset into an array or local Vec for the dof associated with the given field at a point.
1613ea844a1aSMatthew Knepley 
161440750d41SVaclav Hapla   Not Collective
1615ea844a1aSMatthew Knepley 
1616ea844a1aSMatthew Knepley   Input Parameters:
1617ea844a1aSMatthew Knepley + s - the PetscSection
1618ea844a1aSMatthew Knepley . point - the point
1619ea844a1aSMatthew Knepley . field - the field
1620ea844a1aSMatthew Knepley - offset - the offset
1621ea844a1aSMatthew Knepley 
1622ea844a1aSMatthew Knepley   Note: The user usually does not call this function, but uses PetscSectionSetUp()
1623ea844a1aSMatthew Knepley 
1624ea844a1aSMatthew Knepley   Level: intermediate
1625ea844a1aSMatthew Knepley 
16261681d8a4SMatthew Knepley .seealso: PetscSectionGetFieldOffset(), PetscSectionSetOffset(), PetscSectionCreate(), PetscSectionSetUp()
1627ea844a1aSMatthew Knepley @*/
1628ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetFieldOffset(PetscSection s, PetscInt point, PetscInt field, PetscInt offset)
1629ea844a1aSMatthew Knepley {
1630ea844a1aSMatthew Knepley   PetscFunctionBegin;
1631ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
16322abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
16339566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetOffset(s->field[field], point, offset));
1634ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1635ea844a1aSMatthew Knepley }
1636ea844a1aSMatthew Knepley 
1637ea844a1aSMatthew Knepley /*@
1638ea844a1aSMatthew Knepley   PetscSectionGetFieldPointOffset - Return the offset on the given point for the dof associated with the given point.
1639ea844a1aSMatthew Knepley 
164040750d41SVaclav Hapla   Not Collective
1641ea844a1aSMatthew Knepley 
1642ea844a1aSMatthew Knepley   Input Parameters:
1643ea844a1aSMatthew Knepley + s - the PetscSection
1644ea844a1aSMatthew Knepley . point - the point
1645ea844a1aSMatthew Knepley - field - the field
1646ea844a1aSMatthew Knepley 
1647ea844a1aSMatthew Knepley   Output Parameter:
1648ea844a1aSMatthew Knepley . offset - the offset
1649ea844a1aSMatthew Knepley 
1650ea844a1aSMatthew Knepley   Note: This gives the offset on a point of the field, ignoring constraints, meaning starting at the first dof for
1651ea844a1aSMatthew Knepley         this point, what number is the first dof with this field.
1652ea844a1aSMatthew Knepley 
1653ea844a1aSMatthew Knepley   Level: advanced
1654ea844a1aSMatthew Knepley 
1655ea844a1aSMatthew Knepley .seealso: PetscSectionGetOffset(), PetscSectionCreate()
1656ea844a1aSMatthew Knepley @*/
1657ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetFieldPointOffset(PetscSection s, PetscInt point, PetscInt field, PetscInt *offset)
1658ea844a1aSMatthew Knepley {
1659ea844a1aSMatthew Knepley   PetscInt       off, foff;
1660ea844a1aSMatthew Knepley 
1661ea844a1aSMatthew Knepley   PetscFunctionBegin;
1662ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
16632abc8c78SJacob Faibussowitsch   PetscValidIntPointer(offset, 4);
16642abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
16659566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(s, point, &off));
16669566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(s->field[field], point, &foff));
1667ea844a1aSMatthew Knepley   *offset = foff - off;
1668ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1669ea844a1aSMatthew Knepley }
1670ea844a1aSMatthew Knepley 
1671ea844a1aSMatthew Knepley /*@
1672ea844a1aSMatthew Knepley   PetscSectionGetOffsetRange - Return the full range of offsets [start, end)
1673ea844a1aSMatthew Knepley 
167440750d41SVaclav Hapla   Not Collective
1675ea844a1aSMatthew Knepley 
1676ea844a1aSMatthew Knepley   Input Parameter:
1677ea844a1aSMatthew Knepley . s - the PetscSection
1678ea844a1aSMatthew Knepley 
1679ea844a1aSMatthew Knepley   Output Parameters:
1680ea844a1aSMatthew Knepley + start - the minimum offset
1681ea844a1aSMatthew Knepley - end   - one more than the maximum offset
1682ea844a1aSMatthew Knepley 
1683ea844a1aSMatthew Knepley   Level: intermediate
1684ea844a1aSMatthew Knepley 
1685ea844a1aSMatthew Knepley .seealso: PetscSectionGetOffset(), PetscSectionCreate()
1686ea844a1aSMatthew Knepley @*/
1687ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetOffsetRange(PetscSection s, PetscInt *start, PetscInt *end)
1688ea844a1aSMatthew Knepley {
1689ea844a1aSMatthew Knepley   PetscInt       os = 0, oe = 0, pStart, pEnd, p;
1690ea844a1aSMatthew Knepley 
1691ea844a1aSMatthew Knepley   PetscFunctionBegin;
1692ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1693ea844a1aSMatthew Knepley   if (s->atlasOff) {os = s->atlasOff[0]; oe = s->atlasOff[0];}
16949566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
1695ea844a1aSMatthew Knepley   for (p = 0; p < pEnd-pStart; ++p) {
1696ea844a1aSMatthew Knepley     PetscInt dof = s->atlasDof[p], off = s->atlasOff[p];
1697ea844a1aSMatthew Knepley 
1698ea844a1aSMatthew Knepley     if (off >= 0) {
1699ea844a1aSMatthew Knepley       os = PetscMin(os, off);
1700ea844a1aSMatthew Knepley       oe = PetscMax(oe, off+dof);
1701ea844a1aSMatthew Knepley     }
1702ea844a1aSMatthew Knepley   }
1703ea844a1aSMatthew Knepley   if (start) *start = os;
1704ea844a1aSMatthew Knepley   if (end)   *end   = oe;
1705ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1706ea844a1aSMatthew Knepley }
1707ea844a1aSMatthew Knepley 
1708ea844a1aSMatthew Knepley /*@
1709ea844a1aSMatthew Knepley   PetscSectionCreateSubsection - Create a new, smaller section composed of only the selected fields
1710ea844a1aSMatthew Knepley 
171140750d41SVaclav Hapla   Collective
1712ea844a1aSMatthew Knepley 
1713d8d19677SJose E. Roman   Input Parameters:
1714ea844a1aSMatthew Knepley + s      - the PetscSection
1715ea844a1aSMatthew Knepley . len    - the number of subfields
1716ea844a1aSMatthew Knepley - fields - the subfield numbers
1717ea844a1aSMatthew Knepley 
1718ea844a1aSMatthew Knepley   Output Parameter:
1719ea844a1aSMatthew Knepley . subs   - the subsection
1720ea844a1aSMatthew Knepley 
1721ea844a1aSMatthew Knepley   Note: The section offsets now refer to a new, smaller vector.
1722ea844a1aSMatthew Knepley 
1723ea844a1aSMatthew Knepley   Level: advanced
1724ea844a1aSMatthew Knepley 
1725ea844a1aSMatthew Knepley .seealso: PetscSectionCreateSupersection(), PetscSectionCreate()
1726ea844a1aSMatthew Knepley @*/
1727ea844a1aSMatthew Knepley PetscErrorCode PetscSectionCreateSubsection(PetscSection s, PetscInt len, const PetscInt fields[], PetscSection *subs)
1728ea844a1aSMatthew Knepley {
1729b778fa18SValeria Barra   PetscInt       nF, f, c, pStart, pEnd, p, maxCdof = 0;
1730ea844a1aSMatthew Knepley 
1731ea844a1aSMatthew Knepley   PetscFunctionBegin;
1732ea844a1aSMatthew Knepley   if (!len) PetscFunctionReturn(0);
1733ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1734dadcf809SJacob Faibussowitsch   PetscValidIntPointer(fields, 3);
1735ea844a1aSMatthew Knepley   PetscValidPointer(subs, 4);
17369566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetNumFields(s, &nF));
17372c71b3e2SJacob Faibussowitsch   PetscCheckFalse(len > nF,PetscObjectComm((PetscObject) s), PETSC_ERR_ARG_WRONG, "Number of requested fields %" PetscInt_FMT " greater than number of fields %" PetscInt_FMT, len, nF);
17389566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject) s), subs));
17399566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetNumFields(*subs, len));
1740ea844a1aSMatthew Knepley   for (f = 0; f < len; ++f) {
1741ea844a1aSMatthew Knepley     const char *name   = NULL;
1742ea844a1aSMatthew Knepley     PetscInt   numComp = 0;
1743ea844a1aSMatthew Knepley 
17449566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldName(s, fields[f], &name));
17459566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldName(*subs, f, name));
17469566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldComponents(s, fields[f], &numComp));
17479566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldComponents(*subs, f, numComp));
1748b778fa18SValeria Barra     for (c = 0; c < s->numFieldComponents[fields[f]]; ++c) {
17499566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetComponentName(s, fields[f], c, &name));
17509566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetComponentName(*subs, f, c, name));
1751b778fa18SValeria Barra     }
1752ea844a1aSMatthew Knepley   }
17539566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
17549566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(*subs, pStart, pEnd));
1755ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
1756ea844a1aSMatthew Knepley     PetscInt dof = 0, cdof = 0, fdof = 0, cfdof = 0;
1757ea844a1aSMatthew Knepley 
1758ea844a1aSMatthew Knepley     for (f = 0; f < len; ++f) {
17599566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldDof(s, p, fields[f], &fdof));
17609566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldDof(*subs, p, f, fdof));
17619566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintDof(s, p, fields[f], &cfdof));
17629566063dSJacob Faibussowitsch       if (cfdof) PetscCall(PetscSectionSetFieldConstraintDof(*subs, p, f, cfdof));
1763ea844a1aSMatthew Knepley       dof  += fdof;
1764ea844a1aSMatthew Knepley       cdof += cfdof;
1765ea844a1aSMatthew Knepley     }
17669566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(*subs, p, dof));
17679566063dSJacob Faibussowitsch     if (cdof) PetscCall(PetscSectionSetConstraintDof(*subs, p, cdof));
1768ea844a1aSMatthew Knepley     maxCdof = PetscMax(cdof, maxCdof);
1769ea844a1aSMatthew Knepley   }
17709566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(*subs));
1771ea844a1aSMatthew Knepley   if (maxCdof) {
1772ea844a1aSMatthew Knepley     PetscInt *indices;
1773ea844a1aSMatthew Knepley 
17749566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(maxCdof, &indices));
1775ea844a1aSMatthew Knepley     for (p = pStart; p < pEnd; ++p) {
1776ea844a1aSMatthew Knepley       PetscInt cdof;
1777ea844a1aSMatthew Knepley 
17789566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetConstraintDof(*subs, p, &cdof));
1779ea844a1aSMatthew Knepley       if (cdof) {
1780ea844a1aSMatthew Knepley         const PetscInt *oldIndices = NULL;
1781ea844a1aSMatthew Knepley         PetscInt       fdof = 0, cfdof = 0, fc, numConst = 0, fOff = 0;
1782ea844a1aSMatthew Knepley 
1783ea844a1aSMatthew Knepley         for (f = 0; f < len; ++f) {
17849566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetFieldDof(s, p, fields[f], &fdof));
17859566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetFieldConstraintDof(s, p, fields[f], &cfdof));
17869566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetFieldConstraintIndices(s, p, fields[f], &oldIndices));
17879566063dSJacob Faibussowitsch           PetscCall(PetscSectionSetFieldConstraintIndices(*subs, p, f, oldIndices));
17889574d0f0SMatthew G. Knepley           for (fc = 0; fc < cfdof; ++fc) indices[numConst+fc] = oldIndices[fc] + fOff;
1789ea844a1aSMatthew Knepley           numConst += cfdof;
1790ea844a1aSMatthew Knepley           fOff     += fdof;
1791ea844a1aSMatthew Knepley         }
17929566063dSJacob Faibussowitsch         PetscCall(PetscSectionSetConstraintIndices(*subs, p, indices));
1793ea844a1aSMatthew Knepley       }
1794ea844a1aSMatthew Knepley     }
17959566063dSJacob Faibussowitsch     PetscCall(PetscFree(indices));
1796ea844a1aSMatthew Knepley   }
1797ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1798ea844a1aSMatthew Knepley }
1799ea844a1aSMatthew Knepley 
1800ea844a1aSMatthew Knepley /*@
1801ea844a1aSMatthew Knepley   PetscSectionCreateSupersection - Create a new, larger section composed of the input sections
1802ea844a1aSMatthew Knepley 
180340750d41SVaclav Hapla   Collective
1804ea844a1aSMatthew Knepley 
1805ea844a1aSMatthew Knepley   Input Parameters:
1806ea844a1aSMatthew Knepley + s     - the input sections
1807ea844a1aSMatthew Knepley - len   - the number of input sections
1808ea844a1aSMatthew Knepley 
1809ea844a1aSMatthew Knepley   Output Parameter:
1810ea844a1aSMatthew Knepley . supers - the supersection
1811ea844a1aSMatthew Knepley 
1812ea844a1aSMatthew Knepley   Note: The section offsets now refer to a new, larger vector.
1813ea844a1aSMatthew Knepley 
1814ea844a1aSMatthew Knepley   Level: advanced
1815ea844a1aSMatthew Knepley 
1816ea844a1aSMatthew Knepley .seealso: PetscSectionCreateSubsection(), PetscSectionCreate()
1817ea844a1aSMatthew Knepley @*/
1818ea844a1aSMatthew Knepley PetscErrorCode PetscSectionCreateSupersection(PetscSection s[], PetscInt len, PetscSection *supers)
1819ea844a1aSMatthew Knepley {
1820ea844a1aSMatthew Knepley   PetscInt       Nf = 0, f, pStart = PETSC_MAX_INT, pEnd = 0, p, maxCdof = 0, i;
1821ea844a1aSMatthew Knepley 
1822ea844a1aSMatthew Knepley   PetscFunctionBegin;
1823ea844a1aSMatthew Knepley   if (!len) PetscFunctionReturn(0);
1824ea844a1aSMatthew Knepley   for (i = 0; i < len; ++i) {
1825ea844a1aSMatthew Knepley     PetscInt nf, pStarti, pEndi;
1826ea844a1aSMatthew Knepley 
18279566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetNumFields(s[i], &nf));
18289566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetChart(s[i], &pStarti, &pEndi));
1829ea844a1aSMatthew Knepley     pStart = PetscMin(pStart, pStarti);
1830ea844a1aSMatthew Knepley     pEnd   = PetscMax(pEnd,   pEndi);
1831ea844a1aSMatthew Knepley     Nf += nf;
1832ea844a1aSMatthew Knepley   }
18339566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject) s[0]), supers));
18349566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetNumFields(*supers, Nf));
1835ea844a1aSMatthew Knepley   for (i = 0, f = 0; i < len; ++i) {
1836b778fa18SValeria Barra     PetscInt nf, fi, ci;
1837ea844a1aSMatthew Knepley 
18389566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetNumFields(s[i], &nf));
1839ea844a1aSMatthew Knepley     for (fi = 0; fi < nf; ++fi, ++f) {
1840ea844a1aSMatthew Knepley       const char *name   = NULL;
1841ea844a1aSMatthew Knepley       PetscInt   numComp = 0;
1842ea844a1aSMatthew Knepley 
18439566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldName(s[i], fi, &name));
18449566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldName(*supers, f, name));
18459566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldComponents(s[i], fi, &numComp));
18469566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldComponents(*supers, f, numComp));
1847b778fa18SValeria Barra       for (ci = 0; ci < s[i]->numFieldComponents[fi]; ++ci) {
18489566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetComponentName(s[i], fi, ci, &name));
18499566063dSJacob Faibussowitsch         PetscCall(PetscSectionSetComponentName(*supers, f, ci, name));
1850b778fa18SValeria Barra       }
1851ea844a1aSMatthew Knepley     }
1852ea844a1aSMatthew Knepley   }
18539566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(*supers, pStart, pEnd));
1854ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
1855ea844a1aSMatthew Knepley     PetscInt dof = 0, cdof = 0;
1856ea844a1aSMatthew Knepley 
1857ea844a1aSMatthew Knepley     for (i = 0, f = 0; i < len; ++i) {
1858ea844a1aSMatthew Knepley       PetscInt nf, fi, pStarti, pEndi;
1859ea844a1aSMatthew Knepley       PetscInt fdof = 0, cfdof = 0;
1860ea844a1aSMatthew Knepley 
18619566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetNumFields(s[i], &nf));
18629566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetChart(s[i], &pStarti, &pEndi));
1863ea844a1aSMatthew Knepley       if ((p < pStarti) || (p >= pEndi)) continue;
1864ea844a1aSMatthew Knepley       for (fi = 0; fi < nf; ++fi, ++f) {
18659566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetFieldDof(s[i], p, fi, &fdof));
18669566063dSJacob Faibussowitsch         PetscCall(PetscSectionAddFieldDof(*supers, p, f, fdof));
18679566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetFieldConstraintDof(s[i], p, fi, &cfdof));
18689566063dSJacob Faibussowitsch         if (cfdof) PetscCall(PetscSectionAddFieldConstraintDof(*supers, p, f, cfdof));
1869ea844a1aSMatthew Knepley         dof  += fdof;
1870ea844a1aSMatthew Knepley         cdof += cfdof;
1871ea844a1aSMatthew Knepley       }
1872ea844a1aSMatthew Knepley     }
18739566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(*supers, p, dof));
18749566063dSJacob Faibussowitsch     if (cdof) PetscCall(PetscSectionSetConstraintDof(*supers, p, cdof));
1875ea844a1aSMatthew Knepley     maxCdof = PetscMax(cdof, maxCdof);
1876ea844a1aSMatthew Knepley   }
18779566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(*supers));
1878ea844a1aSMatthew Knepley   if (maxCdof) {
1879ea844a1aSMatthew Knepley     PetscInt *indices;
1880ea844a1aSMatthew Knepley 
18819566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(maxCdof, &indices));
1882ea844a1aSMatthew Knepley     for (p = pStart; p < pEnd; ++p) {
1883ea844a1aSMatthew Knepley       PetscInt cdof;
1884ea844a1aSMatthew Knepley 
18859566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetConstraintDof(*supers, p, &cdof));
1886ea844a1aSMatthew Knepley       if (cdof) {
1887ea844a1aSMatthew Knepley         PetscInt dof, numConst = 0, fOff = 0;
1888ea844a1aSMatthew Knepley 
1889ea844a1aSMatthew Knepley         for (i = 0, f = 0; i < len; ++i) {
1890ea844a1aSMatthew Knepley           const PetscInt *oldIndices = NULL;
1891ea844a1aSMatthew Knepley           PetscInt        nf, fi, pStarti, pEndi, fdof, cfdof, fc;
1892ea844a1aSMatthew Knepley 
18939566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetNumFields(s[i], &nf));
18949566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetChart(s[i], &pStarti, &pEndi));
1895ea844a1aSMatthew Knepley           if ((p < pStarti) || (p >= pEndi)) continue;
1896ea844a1aSMatthew Knepley           for (fi = 0; fi < nf; ++fi, ++f) {
18979566063dSJacob Faibussowitsch             PetscCall(PetscSectionGetFieldDof(s[i], p, fi, &fdof));
18989566063dSJacob Faibussowitsch             PetscCall(PetscSectionGetFieldConstraintDof(s[i], p, fi, &cfdof));
18999566063dSJacob Faibussowitsch             PetscCall(PetscSectionGetFieldConstraintIndices(s[i], p, fi, &oldIndices));
1900fcd2503dSMatthew G. Knepley             for (fc = 0; fc < cfdof; ++fc) indices[numConst+fc] = oldIndices[fc];
19019566063dSJacob Faibussowitsch             PetscCall(PetscSectionSetFieldConstraintIndices(*supers, p, f, &indices[numConst]));
1902fcd2503dSMatthew G. Knepley             for (fc = 0; fc < cfdof; ++fc) indices[numConst+fc] += fOff;
1903ea844a1aSMatthew Knepley             numConst += cfdof;
1904ea844a1aSMatthew Knepley           }
19059566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetDof(s[i], p, &dof));
1906ea844a1aSMatthew Knepley           fOff += dof;
1907ea844a1aSMatthew Knepley         }
19089566063dSJacob Faibussowitsch         PetscCall(PetscSectionSetConstraintIndices(*supers, p, indices));
1909ea844a1aSMatthew Knepley       }
1910ea844a1aSMatthew Knepley     }
19119566063dSJacob Faibussowitsch     PetscCall(PetscFree(indices));
1912ea844a1aSMatthew Knepley   }
1913ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1914ea844a1aSMatthew Knepley }
1915ea844a1aSMatthew Knepley 
1916ea844a1aSMatthew Knepley /*@
1917ea844a1aSMatthew Knepley   PetscSectionCreateSubmeshSection - Create a new, smaller section with support on the submesh
1918ea844a1aSMatthew Knepley 
191940750d41SVaclav Hapla   Collective
1920ea844a1aSMatthew Knepley 
1921ea844a1aSMatthew Knepley   Input Parameters:
1922ea844a1aSMatthew Knepley + s           - the PetscSection
1923ea844a1aSMatthew Knepley - subpointMap - a sorted list of points in the original mesh which are in the submesh
1924ea844a1aSMatthew Knepley 
1925ea844a1aSMatthew Knepley   Output Parameter:
1926ea844a1aSMatthew Knepley . subs - the subsection
1927ea844a1aSMatthew Knepley 
1928ea844a1aSMatthew Knepley   Note: The section offsets now refer to a new, smaller vector.
1929ea844a1aSMatthew Knepley 
1930ea844a1aSMatthew Knepley   Level: advanced
1931ea844a1aSMatthew Knepley 
1932ea844a1aSMatthew Knepley .seealso: PetscSectionCreateSubsection(), DMPlexGetSubpointMap(), PetscSectionCreate()
1933ea844a1aSMatthew Knepley @*/
1934ea844a1aSMatthew Knepley PetscErrorCode PetscSectionCreateSubmeshSection(PetscSection s, IS subpointMap, PetscSection *subs)
1935ea844a1aSMatthew Knepley {
1936ea844a1aSMatthew Knepley   const PetscInt *points = NULL, *indices = NULL;
1937b778fa18SValeria Barra   PetscInt       numFields, f, c, numSubpoints = 0, pStart, pEnd, p, subp;
1938ea844a1aSMatthew Knepley 
1939ea844a1aSMatthew Knepley   PetscFunctionBegin;
1940ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1941ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(subpointMap, IS_CLASSID, 2);
1942ea844a1aSMatthew Knepley   PetscValidPointer(subs, 3);
19439566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetNumFields(s, &numFields));
19449566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject) s), subs));
19459566063dSJacob Faibussowitsch   if (numFields) PetscCall(PetscSectionSetNumFields(*subs, numFields));
1946ea844a1aSMatthew Knepley   for (f = 0; f < numFields; ++f) {
1947ea844a1aSMatthew Knepley     const char *name   = NULL;
1948ea844a1aSMatthew Knepley     PetscInt   numComp = 0;
1949ea844a1aSMatthew Knepley 
19509566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldName(s, f, &name));
19519566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldName(*subs, f, name));
19529566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldComponents(s, f, &numComp));
19539566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldComponents(*subs, f, numComp));
1954b778fa18SValeria Barra     for (c = 0; c < s->numFieldComponents[f]; ++c) {
19559566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetComponentName(s, f, c, &name));
19569566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetComponentName(*subs, f, c, name));
1957b778fa18SValeria Barra     }
1958ea844a1aSMatthew Knepley   }
1959ea844a1aSMatthew Knepley   /* For right now, we do not try to squeeze the subchart */
1960ea844a1aSMatthew Knepley   if (subpointMap) {
19619566063dSJacob Faibussowitsch     PetscCall(ISGetSize(subpointMap, &numSubpoints));
19629566063dSJacob Faibussowitsch     PetscCall(ISGetIndices(subpointMap, &points));
1963ea844a1aSMatthew Knepley   }
19649566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
19659566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(*subs, 0, numSubpoints));
1966ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
1967ea844a1aSMatthew Knepley     PetscInt dof, cdof, fdof = 0, cfdof = 0;
1968ea844a1aSMatthew Knepley 
19699566063dSJacob Faibussowitsch     PetscCall(PetscFindInt(p, numSubpoints, points, &subp));
1970ea844a1aSMatthew Knepley     if (subp < 0) continue;
1971ea844a1aSMatthew Knepley     for (f = 0; f < numFields; ++f) {
19729566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldDof(s, p, f, &fdof));
19739566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldDof(*subs, subp, f, fdof));
19749566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintDof(s, p, f, &cfdof));
19759566063dSJacob Faibussowitsch       if (cfdof) PetscCall(PetscSectionSetFieldConstraintDof(*subs, subp, f, cfdof));
1976ea844a1aSMatthew Knepley     }
19779566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s, p, &dof));
19789566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(*subs, subp, dof));
19799566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s, p, &cdof));
19809566063dSJacob Faibussowitsch     if (cdof) PetscCall(PetscSectionSetConstraintDof(*subs, subp, cdof));
1981ea844a1aSMatthew Knepley   }
19829566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(*subs));
1983ea844a1aSMatthew Knepley   /* Change offsets to original offsets */
1984ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
1985ea844a1aSMatthew Knepley     PetscInt off, foff = 0;
1986ea844a1aSMatthew Knepley 
19879566063dSJacob Faibussowitsch     PetscCall(PetscFindInt(p, numSubpoints, points, &subp));
1988ea844a1aSMatthew Knepley     if (subp < 0) continue;
1989ea844a1aSMatthew Knepley     for (f = 0; f < numFields; ++f) {
19909566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldOffset(s, p, f, &foff));
19919566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldOffset(*subs, subp, f, foff));
1992ea844a1aSMatthew Knepley     }
19939566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(s, p, &off));
19949566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetOffset(*subs, subp, off));
1995ea844a1aSMatthew Knepley   }
1996ea844a1aSMatthew Knepley   /* Copy constraint indices */
1997ea844a1aSMatthew Knepley   for (subp = 0; subp < numSubpoints; ++subp) {
1998ea844a1aSMatthew Knepley     PetscInt cdof;
1999ea844a1aSMatthew Knepley 
20009566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(*subs, subp, &cdof));
2001ea844a1aSMatthew Knepley     if (cdof) {
2002ea844a1aSMatthew Knepley       for (f = 0; f < numFields; ++f) {
20039566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetFieldConstraintIndices(s, points[subp], f, &indices));
20049566063dSJacob Faibussowitsch         PetscCall(PetscSectionSetFieldConstraintIndices(*subs, subp, f, indices));
2005ea844a1aSMatthew Knepley       }
20069566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetConstraintIndices(s, points[subp], &indices));
20079566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetConstraintIndices(*subs, subp, indices));
2008ea844a1aSMatthew Knepley     }
2009ea844a1aSMatthew Knepley   }
20109566063dSJacob Faibussowitsch   if (subpointMap) PetscCall(ISRestoreIndices(subpointMap, &points));
2011ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2012ea844a1aSMatthew Knepley }
2013ea844a1aSMatthew Knepley 
2014ea844a1aSMatthew Knepley static PetscErrorCode PetscSectionView_ASCII(PetscSection s, PetscViewer viewer)
2015ea844a1aSMatthew Knepley {
2016ea844a1aSMatthew Knepley   PetscInt       p;
2017ea844a1aSMatthew Knepley   PetscMPIInt    rank;
2018ea844a1aSMatthew Knepley 
2019ea844a1aSMatthew Knepley   PetscFunctionBegin;
20209566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(PetscObjectComm((PetscObject)viewer), &rank));
20219566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPushSynchronized(viewer));
20229566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "Process %d:\n", rank));
2023ea844a1aSMatthew Knepley   for (p = 0; p < s->pEnd - s->pStart; ++p) {
2024ea844a1aSMatthew Knepley     if ((s->bc) && (s->bc->atlasDof[p] > 0)) {
2025ea844a1aSMatthew Knepley       PetscInt b;
2026ea844a1aSMatthew Knepley 
20279566063dSJacob 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]));
2028083401c6SMatthew G. Knepley       if (s->bcIndices) {
2029ea844a1aSMatthew Knepley         for (b = 0; b < s->bc->atlasDof[p]; ++b) {
20309566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, " %" PetscInt_FMT, s->bcIndices[s->bc->atlasOff[p]+b]));
2031ea844a1aSMatthew Knepley         }
2032083401c6SMatthew G. Knepley       }
20339566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "\n"));
2034ea844a1aSMatthew Knepley     } else {
20359566063dSJacob 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]));
2036ea844a1aSMatthew Knepley     }
2037ea844a1aSMatthew Knepley   }
20389566063dSJacob Faibussowitsch   PetscCall(PetscViewerFlush(viewer));
20399566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPopSynchronized(viewer));
2040ea844a1aSMatthew Knepley   if (s->sym) {
20419566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPushTab(viewer));
20429566063dSJacob Faibussowitsch     PetscCall(PetscSectionSymView(s->sym,viewer));
20439566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopTab(viewer));
2044ea844a1aSMatthew Knepley   }
2045ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2046ea844a1aSMatthew Knepley }
2047ea844a1aSMatthew Knepley 
2048ea844a1aSMatthew Knepley /*@C
2049fe2efc57SMark    PetscSectionViewFromOptions - View from Options
2050fe2efc57SMark 
205140750d41SVaclav Hapla    Collective
2052fe2efc57SMark 
2053fe2efc57SMark    Input Parameters:
2054fe2efc57SMark +  A - the PetscSection object to view
2055736c3998SJose E. Roman .  obj - Optional object
2056736c3998SJose E. Roman -  name - command line option
2057fe2efc57SMark 
2058fe2efc57SMark    Level: intermediate
2059fe2efc57SMark .seealso:  PetscSection, PetscSectionView, PetscObjectViewFromOptions(), PetscSectionCreate()
2060fe2efc57SMark @*/
2061fe2efc57SMark PetscErrorCode  PetscSectionViewFromOptions(PetscSection A,PetscObject obj,const char name[])
2062fe2efc57SMark {
2063fe2efc57SMark   PetscFunctionBegin;
2064fe2efc57SMark   PetscValidHeaderSpecific(A,PETSC_SECTION_CLASSID,1);
20659566063dSJacob Faibussowitsch   PetscCall(PetscObjectViewFromOptions((PetscObject)A,obj,name));
2066fe2efc57SMark   PetscFunctionReturn(0);
2067fe2efc57SMark }
2068fe2efc57SMark 
2069fe2efc57SMark /*@C
2070ea844a1aSMatthew Knepley   PetscSectionView - Views a PetscSection
2071ea844a1aSMatthew Knepley 
207240750d41SVaclav Hapla   Collective
2073ea844a1aSMatthew Knepley 
2074ea844a1aSMatthew Knepley   Input Parameters:
2075ea844a1aSMatthew Knepley + s - the PetscSection object to view
2076ea844a1aSMatthew Knepley - v - the viewer
2077ea844a1aSMatthew Knepley 
20781ddd528eSksagiyam   Note:
20791ddd528eSksagiyam   PetscSectionView(), when viewer is of type PETSCVIEWERHDF5, only saves
20801ddd528eSksagiyam   distribution independent data, such as dofs, offsets, constraint dofs,
20811ddd528eSksagiyam   and constraint indices. Points that have negative dofs, for instance,
20821ddd528eSksagiyam   are not saved as they represent points owned by other processes.
20831ddd528eSksagiyam   Point numbering and rank assignment is currently not stored.
20841ddd528eSksagiyam   The saved section can be loaded with PetscSectionLoad().
20851ddd528eSksagiyam 
2086ea844a1aSMatthew Knepley   Level: beginner
2087ea844a1aSMatthew Knepley 
2088fde5e3acSksagiyam .seealso PetscSectionCreate(), PetscSectionDestroy(), PetscSectionLoad()
2089ea844a1aSMatthew Knepley @*/
2090ea844a1aSMatthew Knepley PetscErrorCode PetscSectionView(PetscSection s, PetscViewer viewer)
2091ea844a1aSMatthew Knepley {
20921ddd528eSksagiyam   PetscBool      isascii, ishdf5;
2093ea844a1aSMatthew Knepley   PetscInt       f;
2094ea844a1aSMatthew Knepley 
2095ea844a1aSMatthew Knepley   PetscFunctionBegin;
2096ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
20979566063dSJacob Faibussowitsch   if (!viewer) PetscCall(PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)s), &viewer));
2098ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(viewer, PETSC_VIEWER_CLASSID, 2);
20999566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject) viewer, PETSCVIEWERASCII, &isascii));
21009566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject) viewer, PETSCVIEWERHDF5, &ishdf5));
2101ea844a1aSMatthew Knepley   if (isascii) {
21029566063dSJacob Faibussowitsch     PetscCall(PetscObjectPrintClassNamePrefixType((PetscObject)s,viewer));
2103ea844a1aSMatthew Knepley     if (s->numFields) {
21049566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "%" PetscInt_FMT " fields\n", s->numFields));
2105ea844a1aSMatthew Knepley       for (f = 0; f < s->numFields; ++f) {
21069566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  field %" PetscInt_FMT " with %" PetscInt_FMT " components\n", f, s->numFieldComponents[f]));
21079566063dSJacob Faibussowitsch         PetscCall(PetscSectionView_ASCII(s->field[f], viewer));
2108ea844a1aSMatthew Knepley       }
2109ea844a1aSMatthew Knepley     } else {
21109566063dSJacob Faibussowitsch       PetscCall(PetscSectionView_ASCII(s, viewer));
2111ea844a1aSMatthew Knepley     }
21121ddd528eSksagiyam   } else if (ishdf5) {
21131ddd528eSksagiyam #if PetscDefined(HAVE_HDF5)
21149566063dSJacob Faibussowitsch     PetscCall(PetscSectionView_HDF5_Internal(s, viewer));
21151ddd528eSksagiyam #else
21161ddd528eSksagiyam     SETERRQ(PetscObjectComm((PetscObject) s), PETSC_ERR_SUP, "HDF5 not supported in this build.\nPlease reconfigure using --download-hdf5");
21171ddd528eSksagiyam #endif
2118ea844a1aSMatthew Knepley   }
2119ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2120ea844a1aSMatthew Knepley }
2121ea844a1aSMatthew Knepley 
2122fde5e3acSksagiyam /*@C
2123fde5e3acSksagiyam   PetscSectionLoad - Loads a PetscSection
2124fde5e3acSksagiyam 
212540750d41SVaclav Hapla   Collective
2126fde5e3acSksagiyam 
2127fde5e3acSksagiyam   Input Parameters:
2128fde5e3acSksagiyam + s - the PetscSection object to load
2129fde5e3acSksagiyam - v - the viewer
2130fde5e3acSksagiyam 
2131fde5e3acSksagiyam   Note:
2132fde5e3acSksagiyam   PetscSectionLoad(), when viewer is of type PETSCVIEWERHDF5, loads
2133fde5e3acSksagiyam   a section saved with PetscSectionView(). The number of processes
2134fde5e3acSksagiyam   used here (N) does not need to be the same as that used when saving.
2135fde5e3acSksagiyam   After calling this function, the chart of s on rank i will be set
2136fde5e3acSksagiyam   to [0, E_i), where \sum_{i=0}^{N-1}E_i equals to the total number of
2137fde5e3acSksagiyam   saved section points.
2138fde5e3acSksagiyam 
2139fde5e3acSksagiyam   Level: beginner
2140fde5e3acSksagiyam 
2141fde5e3acSksagiyam .seealso PetscSectionCreate(), PetscSectionDestroy(), PetscSectionView()
2142fde5e3acSksagiyam @*/
2143fde5e3acSksagiyam PetscErrorCode PetscSectionLoad(PetscSection s, PetscViewer viewer)
2144fde5e3acSksagiyam {
2145fde5e3acSksagiyam   PetscBool      ishdf5;
2146fde5e3acSksagiyam 
2147fde5e3acSksagiyam   PetscFunctionBegin;
2148fde5e3acSksagiyam   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2149fde5e3acSksagiyam   PetscValidHeaderSpecific(viewer, PETSC_VIEWER_CLASSID, 2);
21509566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject) viewer, PETSCVIEWERHDF5, &ishdf5));
2151fde5e3acSksagiyam   if (ishdf5) {
2152fde5e3acSksagiyam #if PetscDefined(HAVE_HDF5)
21539566063dSJacob Faibussowitsch     PetscCall(PetscSectionLoad_HDF5_Internal(s, viewer));
2154fde5e3acSksagiyam     PetscFunctionReturn(0);
2155fde5e3acSksagiyam #else
2156fde5e3acSksagiyam     SETERRQ(PetscObjectComm((PetscObject) s), PETSC_ERR_SUP, "HDF5 not supported in this build.\nPlease reconfigure using --download-hdf5");
2157fde5e3acSksagiyam #endif
215898921bdaSJacob Faibussowitsch   } else SETERRQ(PetscObjectComm((PetscObject) s), PETSC_ERR_SUP, "Viewer type %s not yet supported for PetscSection loading", ((PetscObject)viewer)->type_name);
2159fde5e3acSksagiyam }
2160fde5e3acSksagiyam 
2161c459fbc1SJed Brown static PetscErrorCode PetscSectionResetClosurePermutation(PetscSection section)
2162c459fbc1SJed Brown {
2163c459fbc1SJed Brown   PetscSectionClosurePermVal clVal;
2164c459fbc1SJed Brown 
2165c459fbc1SJed Brown   PetscFunctionBegin;
2166c459fbc1SJed Brown   if (!section->clHash) PetscFunctionReturn(0);
2167c459fbc1SJed Brown   kh_foreach_value(section->clHash, clVal, {
21689566063dSJacob Faibussowitsch       PetscCall(PetscFree(clVal.perm));
21699566063dSJacob Faibussowitsch       PetscCall(PetscFree(clVal.invPerm));
2170c459fbc1SJed Brown     });
2171c459fbc1SJed Brown   kh_destroy(ClPerm, section->clHash);
2172c459fbc1SJed Brown   section->clHash = NULL;
2173c459fbc1SJed Brown   PetscFunctionReturn(0);
2174c459fbc1SJed Brown }
2175c459fbc1SJed Brown 
2176ea844a1aSMatthew Knepley /*@
2177ea844a1aSMatthew Knepley   PetscSectionReset - Frees all section data.
2178ea844a1aSMatthew Knepley 
217940750d41SVaclav Hapla   Not Collective
2180ea844a1aSMatthew Knepley 
2181ea844a1aSMatthew Knepley   Input Parameters:
2182ea844a1aSMatthew Knepley . s - the PetscSection
2183ea844a1aSMatthew Knepley 
2184ea844a1aSMatthew Knepley   Level: beginner
2185ea844a1aSMatthew Knepley 
2186ea844a1aSMatthew Knepley .seealso: PetscSection, PetscSectionCreate()
2187ea844a1aSMatthew Knepley @*/
2188ea844a1aSMatthew Knepley PetscErrorCode PetscSectionReset(PetscSection s)
2189ea844a1aSMatthew Knepley {
2190b778fa18SValeria Barra   PetscInt       f, c;
2191ea844a1aSMatthew Knepley 
2192ea844a1aSMatthew Knepley   PetscFunctionBegin;
2193ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2194ea844a1aSMatthew Knepley   for (f = 0; f < s->numFields; ++f) {
21959566063dSJacob Faibussowitsch     PetscCall(PetscSectionDestroy(&s->field[f]));
21969566063dSJacob Faibussowitsch     PetscCall(PetscFree(s->fieldNames[f]));
2197b146d1acSSatish Balay     for (c = 0; c < s->numFieldComponents[f]; ++c) {
21989566063dSJacob Faibussowitsch       PetscCall(PetscFree(s->compNames[f][c]));
2199b146d1acSSatish Balay     }
22009566063dSJacob Faibussowitsch     PetscCall(PetscFree(s->compNames[f]));
2201ea844a1aSMatthew Knepley   }
22029566063dSJacob Faibussowitsch   PetscCall(PetscFree(s->numFieldComponents));
22039566063dSJacob Faibussowitsch   PetscCall(PetscFree(s->fieldNames));
22049566063dSJacob Faibussowitsch   PetscCall(PetscFree(s->compNames));
22059566063dSJacob Faibussowitsch   PetscCall(PetscFree(s->field));
22069566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&s->bc));
22079566063dSJacob Faibussowitsch   PetscCall(PetscFree(s->bcIndices));
22089566063dSJacob Faibussowitsch   PetscCall(PetscFree2(s->atlasDof, s->atlasOff));
22099566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&s->clSection));
22109566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&s->clPoints));
22119566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&s->perm));
22129566063dSJacob Faibussowitsch   PetscCall(PetscSectionResetClosurePermutation(s));
22139566063dSJacob Faibussowitsch   PetscCall(PetscSectionSymDestroy(&s->sym));
22149566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&s->clSection));
22159566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&s->clPoints));
2216ea844a1aSMatthew Knepley 
2217ea844a1aSMatthew Knepley   s->pStart    = -1;
2218ea844a1aSMatthew Knepley   s->pEnd      = -1;
2219ea844a1aSMatthew Knepley   s->maxDof    = 0;
2220ea844a1aSMatthew Knepley   s->setup     = PETSC_FALSE;
2221ea844a1aSMatthew Knepley   s->numFields = 0;
2222ea844a1aSMatthew Knepley   s->clObj     = NULL;
2223ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2224ea844a1aSMatthew Knepley }
2225ea844a1aSMatthew Knepley 
2226ea844a1aSMatthew Knepley /*@
2227ea844a1aSMatthew Knepley   PetscSectionDestroy - Frees a section object and frees its range if that exists.
2228ea844a1aSMatthew Knepley 
222940750d41SVaclav Hapla   Not Collective
2230ea844a1aSMatthew Knepley 
2231ea844a1aSMatthew Knepley   Input Parameters:
2232ea844a1aSMatthew Knepley . s - the PetscSection
2233ea844a1aSMatthew Knepley 
2234ea844a1aSMatthew Knepley   Level: beginner
2235ea844a1aSMatthew Knepley 
2236ea844a1aSMatthew Knepley .seealso: PetscSection, PetscSectionCreate()
2237ea844a1aSMatthew Knepley @*/
2238ea844a1aSMatthew Knepley PetscErrorCode PetscSectionDestroy(PetscSection *s)
2239ea844a1aSMatthew Knepley {
2240ea844a1aSMatthew Knepley   PetscFunctionBegin;
2241ea844a1aSMatthew Knepley   if (!*s) PetscFunctionReturn(0);
224262f17a49SStefano Zampini   PetscValidHeaderSpecific(*s,PETSC_SECTION_CLASSID,1);
2243ea844a1aSMatthew Knepley   if (--((PetscObject)(*s))->refct > 0) {
2244ea844a1aSMatthew Knepley     *s = NULL;
2245ea844a1aSMatthew Knepley     PetscFunctionReturn(0);
2246ea844a1aSMatthew Knepley   }
22479566063dSJacob Faibussowitsch   PetscCall(PetscSectionReset(*s));
22489566063dSJacob Faibussowitsch   PetscCall(PetscHeaderDestroy(s));
2249ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2250ea844a1aSMatthew Knepley }
2251ea844a1aSMatthew Knepley 
2252ea844a1aSMatthew Knepley PetscErrorCode VecIntGetValuesSection(PetscInt *baseArray, PetscSection s, PetscInt point, const PetscInt **values)
2253ea844a1aSMatthew Knepley {
2254ea844a1aSMatthew Knepley   const PetscInt p = point - s->pStart;
2255ea844a1aSMatthew Knepley 
2256ea844a1aSMatthew Knepley   PetscFunctionBegin;
2257ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 2);
2258ea844a1aSMatthew Knepley   *values = &baseArray[s->atlasOff[p]];
2259ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2260ea844a1aSMatthew Knepley }
2261ea844a1aSMatthew Knepley 
2262ea844a1aSMatthew Knepley PetscErrorCode VecIntSetValuesSection(PetscInt *baseArray, PetscSection s, PetscInt point, const PetscInt values[], InsertMode mode)
2263ea844a1aSMatthew Knepley {
2264ea844a1aSMatthew Knepley   PetscInt       *array;
2265ea844a1aSMatthew Knepley   const PetscInt p           = point - s->pStart;
2266ea844a1aSMatthew Knepley   const PetscInt orientation = 0; /* Needs to be included for use in closure operations */
2267ea844a1aSMatthew Knepley   PetscInt       cDim        = 0;
2268ea844a1aSMatthew Knepley 
2269ea844a1aSMatthew Knepley   PetscFunctionBegin;
2270ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 2);
22719566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstraintDof(s, p, &cDim));
2272ea844a1aSMatthew Knepley   array = &baseArray[s->atlasOff[p]];
2273ea844a1aSMatthew Knepley   if (!cDim) {
2274ea844a1aSMatthew Knepley     if (orientation >= 0) {
2275ea844a1aSMatthew Knepley       const PetscInt dim = s->atlasDof[p];
2276ea844a1aSMatthew Knepley       PetscInt       i;
2277ea844a1aSMatthew Knepley 
2278ea844a1aSMatthew Knepley       if (mode == INSERT_VALUES) {
2279ea844a1aSMatthew Knepley         for (i = 0; i < dim; ++i) array[i] = values[i];
2280ea844a1aSMatthew Knepley       } else {
2281ea844a1aSMatthew Knepley         for (i = 0; i < dim; ++i) array[i] += values[i];
2282ea844a1aSMatthew Knepley       }
2283ea844a1aSMatthew Knepley     } else {
2284ea844a1aSMatthew Knepley       PetscInt offset = 0;
2285ea844a1aSMatthew Knepley       PetscInt j      = -1, field, i;
2286ea844a1aSMatthew Knepley 
2287ea844a1aSMatthew Knepley       for (field = 0; field < s->numFields; ++field) {
2288ea844a1aSMatthew Knepley         const PetscInt dim = s->field[field]->atlasDof[p];
2289ea844a1aSMatthew Knepley 
2290ea844a1aSMatthew Knepley         for (i = dim-1; i >= 0; --i) array[++j] = values[i+offset];
2291ea844a1aSMatthew Knepley         offset += dim;
2292ea844a1aSMatthew Knepley       }
2293ea844a1aSMatthew Knepley     }
2294ea844a1aSMatthew Knepley   } else {
2295ea844a1aSMatthew Knepley     if (orientation >= 0) {
2296ea844a1aSMatthew Knepley       const PetscInt dim  = s->atlasDof[p];
2297ea844a1aSMatthew Knepley       PetscInt       cInd = 0, i;
2298ea844a1aSMatthew Knepley       const PetscInt *cDof;
2299ea844a1aSMatthew Knepley 
23009566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetConstraintIndices(s, point, &cDof));
2301ea844a1aSMatthew Knepley       if (mode == INSERT_VALUES) {
2302ea844a1aSMatthew Knepley         for (i = 0; i < dim; ++i) {
2303ea844a1aSMatthew Knepley           if ((cInd < cDim) && (i == cDof[cInd])) {++cInd; continue;}
2304ea844a1aSMatthew Knepley           array[i] = values[i];
2305ea844a1aSMatthew Knepley         }
2306ea844a1aSMatthew Knepley       } else {
2307ea844a1aSMatthew Knepley         for (i = 0; i < dim; ++i) {
2308ea844a1aSMatthew Knepley           if ((cInd < cDim) && (i == cDof[cInd])) {++cInd; continue;}
2309ea844a1aSMatthew Knepley           array[i] += values[i];
2310ea844a1aSMatthew Knepley         }
2311ea844a1aSMatthew Knepley       }
2312ea844a1aSMatthew Knepley     } else {
2313ea844a1aSMatthew Knepley       const PetscInt *cDof;
2314ea844a1aSMatthew Knepley       PetscInt       offset  = 0;
2315ea844a1aSMatthew Knepley       PetscInt       cOffset = 0;
2316ea844a1aSMatthew Knepley       PetscInt       j       = 0, field;
2317ea844a1aSMatthew Knepley 
23189566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetConstraintIndices(s, point, &cDof));
2319ea844a1aSMatthew Knepley       for (field = 0; field < s->numFields; ++field) {
2320ea844a1aSMatthew Knepley         const PetscInt dim  = s->field[field]->atlasDof[p];     /* PetscSectionGetFieldDof() */
2321ea844a1aSMatthew Knepley         const PetscInt tDim = s->field[field]->bc->atlasDof[p]; /* PetscSectionGetFieldConstraintDof() */
2322ea844a1aSMatthew Knepley         const PetscInt sDim = dim - tDim;
2323ea844a1aSMatthew Knepley         PetscInt       cInd = 0, i,k;
2324ea844a1aSMatthew Knepley 
2325ea844a1aSMatthew Knepley         for (i = 0, k = dim+offset-1; i < dim; ++i, ++j, --k) {
2326ea844a1aSMatthew Knepley           if ((cInd < sDim) && (j == cDof[cInd+cOffset])) {++cInd; continue;}
2327ea844a1aSMatthew Knepley           array[j] = values[k];
2328ea844a1aSMatthew Knepley         }
2329ea844a1aSMatthew Knepley         offset  += dim;
2330ea844a1aSMatthew Knepley         cOffset += dim - tDim;
2331ea844a1aSMatthew Knepley       }
2332ea844a1aSMatthew Knepley     }
2333ea844a1aSMatthew Knepley   }
2334ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2335ea844a1aSMatthew Knepley }
2336ea844a1aSMatthew Knepley 
2337ea844a1aSMatthew Knepley /*@C
2338ea844a1aSMatthew Knepley   PetscSectionHasConstraints - Determine whether a section has constrained dofs
2339ea844a1aSMatthew Knepley 
234040750d41SVaclav Hapla   Not Collective
2341ea844a1aSMatthew Knepley 
2342ea844a1aSMatthew Knepley   Input Parameter:
2343ea844a1aSMatthew Knepley . s - The PetscSection
2344ea844a1aSMatthew Knepley 
2345ea844a1aSMatthew Knepley   Output Parameter:
2346ea844a1aSMatthew Knepley . hasConstraints - flag indicating that the section has constrained dofs
2347ea844a1aSMatthew Knepley 
2348ea844a1aSMatthew Knepley   Level: intermediate
2349ea844a1aSMatthew Knepley 
2350ea844a1aSMatthew Knepley .seealso: PetscSectionSetConstraintIndices(), PetscSectionGetConstraintDof(), PetscSection
2351ea844a1aSMatthew Knepley @*/
2352ea844a1aSMatthew Knepley PetscErrorCode PetscSectionHasConstraints(PetscSection s, PetscBool *hasConstraints)
2353ea844a1aSMatthew Knepley {
2354ea844a1aSMatthew Knepley   PetscFunctionBegin;
2355ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2356dadcf809SJacob Faibussowitsch   PetscValidBoolPointer(hasConstraints, 2);
2357ea844a1aSMatthew Knepley   *hasConstraints = s->bc ? PETSC_TRUE : PETSC_FALSE;
2358ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2359ea844a1aSMatthew Knepley }
2360ea844a1aSMatthew Knepley 
2361ea844a1aSMatthew Knepley /*@C
2362ea844a1aSMatthew Knepley   PetscSectionGetConstraintIndices - Get the point dof numbers, in [0, dof), which are constrained
2363ea844a1aSMatthew Knepley 
236440750d41SVaclav Hapla   Not Collective
2365ea844a1aSMatthew Knepley 
2366ea844a1aSMatthew Knepley   Input Parameters:
2367ea844a1aSMatthew Knepley + s     - The PetscSection
2368ea844a1aSMatthew Knepley - point - The point
2369ea844a1aSMatthew Knepley 
2370ea844a1aSMatthew Knepley   Output Parameter:
2371ea844a1aSMatthew Knepley . indices - The constrained dofs
2372ea844a1aSMatthew Knepley 
2373ea844a1aSMatthew Knepley   Note: In Fortran, you call PetscSectionGetConstraintIndicesF90() and PetscSectionRestoreConstraintIndicesF90()
2374ea844a1aSMatthew Knepley 
2375ea844a1aSMatthew Knepley   Level: intermediate
2376ea844a1aSMatthew Knepley 
2377ea844a1aSMatthew Knepley .seealso: PetscSectionSetConstraintIndices(), PetscSectionGetConstraintDof(), PetscSection
2378ea844a1aSMatthew Knepley @*/
2379ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetConstraintIndices(PetscSection s, PetscInt point, const PetscInt **indices)
2380ea844a1aSMatthew Knepley {
2381ea844a1aSMatthew Knepley   PetscFunctionBegin;
2382ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2383ea844a1aSMatthew Knepley   if (s->bc) {
23849566063dSJacob Faibussowitsch     PetscCall(VecIntGetValuesSection(s->bcIndices, s->bc, point, indices));
2385ea844a1aSMatthew Knepley   } else *indices = NULL;
2386ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2387ea844a1aSMatthew Knepley }
2388ea844a1aSMatthew Knepley 
2389ea844a1aSMatthew Knepley /*@C
2390ea844a1aSMatthew Knepley   PetscSectionSetConstraintIndices - Set the point dof numbers, in [0, dof), which are constrained
2391ea844a1aSMatthew Knepley 
239240750d41SVaclav Hapla   Not Collective
2393ea844a1aSMatthew Knepley 
2394ea844a1aSMatthew Knepley   Input Parameters:
2395ea844a1aSMatthew Knepley + s     - The PetscSection
2396ea844a1aSMatthew Knepley . point - The point
2397ea844a1aSMatthew Knepley - indices - The constrained dofs
2398ea844a1aSMatthew Knepley 
2399ea844a1aSMatthew Knepley   Note: The Fortran is PetscSectionSetConstraintIndicesF90()
2400ea844a1aSMatthew Knepley 
2401ea844a1aSMatthew Knepley   Level: intermediate
2402ea844a1aSMatthew Knepley 
2403ea844a1aSMatthew Knepley .seealso: PetscSectionGetConstraintIndices(), PetscSectionGetConstraintDof(), PetscSection
2404ea844a1aSMatthew Knepley @*/
2405ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetConstraintIndices(PetscSection s, PetscInt point, const PetscInt indices[])
2406ea844a1aSMatthew Knepley {
2407ea844a1aSMatthew Knepley   PetscFunctionBegin;
2408ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2409ea844a1aSMatthew Knepley   if (s->bc) {
2410d57bb9dbSMatthew G. Knepley     const PetscInt dof  = s->atlasDof[point];
2411d57bb9dbSMatthew G. Knepley     const PetscInt cdof = s->bc->atlasDof[point];
2412d57bb9dbSMatthew G. Knepley     PetscInt       d;
2413d57bb9dbSMatthew G. Knepley 
2414d57bb9dbSMatthew G. Knepley     for (d = 0; d < cdof; ++d) {
2415e2bfaee7SMatthew 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]);
2416d57bb9dbSMatthew G. Knepley     }
24179566063dSJacob Faibussowitsch     PetscCall(VecIntSetValuesSection(s->bcIndices, s->bc, point, indices, INSERT_VALUES));
2418ea844a1aSMatthew Knepley   }
2419ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2420ea844a1aSMatthew Knepley }
2421ea844a1aSMatthew Knepley 
2422ea844a1aSMatthew Knepley /*@C
2423ea844a1aSMatthew Knepley   PetscSectionGetFieldConstraintIndices - Get the field dof numbers, in [0, fdof), which are constrained
2424ea844a1aSMatthew Knepley 
242540750d41SVaclav Hapla   Not Collective
2426ea844a1aSMatthew Knepley 
2427ea844a1aSMatthew Knepley   Input Parameters:
2428ea844a1aSMatthew Knepley + s     - The PetscSection
2429ea844a1aSMatthew Knepley . field  - The field number
2430ea844a1aSMatthew Knepley - point - The point
2431ea844a1aSMatthew Knepley 
2432ea844a1aSMatthew Knepley   Output Parameter:
24339759eb26SJed Brown . indices - The constrained dofs sorted in ascending order
2434ea844a1aSMatthew Knepley 
24359759eb26SJed Brown   Notes:
24369759eb26SJed 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().
24379759eb26SJed Brown 
24389759eb26SJed Brown   Fortran Note:
24399759eb26SJed Brown   In Fortran, you call PetscSectionGetFieldConstraintIndicesF90() and PetscSectionRestoreFieldConstraintIndicesF90()
2440ea844a1aSMatthew Knepley 
2441ea844a1aSMatthew Knepley   Level: intermediate
2442ea844a1aSMatthew Knepley 
2443ea844a1aSMatthew Knepley .seealso: PetscSectionSetFieldConstraintIndices(), PetscSectionGetConstraintIndices(), PetscSectionGetConstraintDof(), PetscSection
2444ea844a1aSMatthew Knepley @*/
2445ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetFieldConstraintIndices(PetscSection s, PetscInt point, PetscInt field, const PetscInt **indices)
2446ea844a1aSMatthew Knepley {
2447ea844a1aSMatthew Knepley   PetscFunctionBegin;
2448ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2449dadcf809SJacob Faibussowitsch   PetscValidPointer(indices,4);
24502abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
24519566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstraintIndices(s->field[field], point, indices));
2452ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2453ea844a1aSMatthew Knepley }
2454ea844a1aSMatthew Knepley 
2455ea844a1aSMatthew Knepley /*@C
2456ea844a1aSMatthew Knepley   PetscSectionSetFieldConstraintIndices - Set the field dof numbers, in [0, fdof), which are constrained
2457ea844a1aSMatthew Knepley 
245840750d41SVaclav Hapla   Not Collective
2459ea844a1aSMatthew Knepley 
2460ea844a1aSMatthew Knepley   Input Parameters:
2461ea844a1aSMatthew Knepley + s       - The PetscSection
2462ea844a1aSMatthew Knepley . point   - The point
2463ea844a1aSMatthew Knepley . field   - The field number
2464ea844a1aSMatthew Knepley - indices - The constrained dofs
2465ea844a1aSMatthew Knepley 
2466ea844a1aSMatthew Knepley   Note: The Fortran is PetscSectionSetFieldConstraintIndicesF90()
2467ea844a1aSMatthew Knepley 
2468ea844a1aSMatthew Knepley   Level: intermediate
2469ea844a1aSMatthew Knepley 
2470ea844a1aSMatthew Knepley .seealso: PetscSectionSetConstraintIndices(), PetscSectionGetFieldConstraintIndices(), PetscSectionGetConstraintDof(), PetscSection
2471ea844a1aSMatthew Knepley @*/
2472ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetFieldConstraintIndices(PetscSection s, PetscInt point, PetscInt field, const PetscInt indices[])
2473ea844a1aSMatthew Knepley {
2474ea844a1aSMatthew Knepley   PetscFunctionBegin;
2475ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
24762abc8c78SJacob Faibussowitsch   if (PetscDefined(USE_DEBUG)) {
2477e2bfaee7SMatthew G. Knepley     PetscInt nfdof;
24782abc8c78SJacob Faibussowitsch 
24799566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldConstraintDof(s, point, field, &nfdof));
2480e2bfaee7SMatthew G. Knepley     if (nfdof) PetscValidIntPointer(indices, 4);
24812abc8c78SJacob Faibussowitsch   }
24822abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
24839566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetConstraintIndices(s->field[field], point, indices));
2484ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2485ea844a1aSMatthew Knepley }
2486ea844a1aSMatthew Knepley 
2487ea844a1aSMatthew Knepley /*@
2488ea844a1aSMatthew Knepley   PetscSectionPermute - Reorder the section according to the input point permutation
2489ea844a1aSMatthew Knepley 
249040750d41SVaclav Hapla   Collective
2491ea844a1aSMatthew Knepley 
2492d8d19677SJose E. Roman   Input Parameters:
2493ea844a1aSMatthew Knepley + section - The PetscSection object
2494ea844a1aSMatthew Knepley - perm - The point permutation, old point p becomes new point perm[p]
2495ea844a1aSMatthew Knepley 
2496ea844a1aSMatthew Knepley   Output Parameter:
2497ea844a1aSMatthew Knepley . sectionNew - The permuted PetscSection
2498ea844a1aSMatthew Knepley 
2499ea844a1aSMatthew Knepley   Level: intermediate
2500ea844a1aSMatthew Knepley 
2501ea844a1aSMatthew Knepley .seealso: MatPermute()
2502ea844a1aSMatthew Knepley @*/
2503ea844a1aSMatthew Knepley PetscErrorCode PetscSectionPermute(PetscSection section, IS permutation, PetscSection *sectionNew)
2504ea844a1aSMatthew Knepley {
2505ea844a1aSMatthew Knepley   PetscSection    s = section, sNew;
2506ea844a1aSMatthew Knepley   const PetscInt *perm;
2507b778fa18SValeria Barra   PetscInt        numFields, f, c, numPoints, pStart, pEnd, p;
2508ea844a1aSMatthew Knepley 
2509ea844a1aSMatthew Knepley   PetscFunctionBegin;
2510ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1);
2511ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(permutation, IS_CLASSID, 2);
2512ea844a1aSMatthew Knepley   PetscValidPointer(sectionNew, 3);
25139566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject) s), &sNew));
25149566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetNumFields(s, &numFields));
25159566063dSJacob Faibussowitsch   if (numFields) PetscCall(PetscSectionSetNumFields(sNew, numFields));
2516ea844a1aSMatthew Knepley   for (f = 0; f < numFields; ++f) {
2517ea844a1aSMatthew Knepley     const char *name;
2518ea844a1aSMatthew Knepley     PetscInt    numComp;
2519ea844a1aSMatthew Knepley 
25209566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldName(s, f, &name));
25219566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldName(sNew, f, name));
25229566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldComponents(s, f, &numComp));
25239566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldComponents(sNew, f, numComp));
2524b778fa18SValeria Barra     for (c = 0; c < s->numFieldComponents[f]; ++c) {
25259566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetComponentName(s, f, c, &name));
25269566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetComponentName(sNew, f, c, name));
2527b778fa18SValeria Barra     }
2528ea844a1aSMatthew Knepley   }
25299566063dSJacob Faibussowitsch   PetscCall(ISGetLocalSize(permutation, &numPoints));
25309566063dSJacob Faibussowitsch   PetscCall(ISGetIndices(permutation, &perm));
25319566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
25329566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(sNew, pStart, pEnd));
25332c71b3e2SJacob Faibussowitsch   PetscCheckFalse(numPoints < pEnd,PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "Permutation size %" PetscInt_FMT " is less than largest Section point %" PetscInt_FMT, numPoints, pEnd);
2534ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
2535ea844a1aSMatthew Knepley     PetscInt dof, cdof;
2536ea844a1aSMatthew Knepley 
25379566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s, p, &dof));
25389566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(sNew, perm[p], dof));
25399566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s, p, &cdof));
25409566063dSJacob Faibussowitsch     if (cdof) PetscCall(PetscSectionSetConstraintDof(sNew, perm[p], cdof));
2541ea844a1aSMatthew Knepley     for (f = 0; f < numFields; ++f) {
25429566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldDof(s, p, f, &dof));
25439566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldDof(sNew, perm[p], f, dof));
25449566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintDof(s, p, f, &cdof));
25459566063dSJacob Faibussowitsch       if (cdof) PetscCall(PetscSectionSetFieldConstraintDof(sNew, perm[p], f, cdof));
2546ea844a1aSMatthew Knepley     }
2547ea844a1aSMatthew Knepley   }
25489566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(sNew));
2549ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
2550ea844a1aSMatthew Knepley     const PetscInt *cind;
2551ea844a1aSMatthew Knepley     PetscInt        cdof;
2552ea844a1aSMatthew Knepley 
25539566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s, p, &cdof));
2554ea844a1aSMatthew Knepley     if (cdof) {
25559566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetConstraintIndices(s, p, &cind));
25569566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetConstraintIndices(sNew, perm[p], cind));
2557ea844a1aSMatthew Knepley     }
2558ea844a1aSMatthew Knepley     for (f = 0; f < numFields; ++f) {
25599566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintDof(s, p, f, &cdof));
2560ea844a1aSMatthew Knepley       if (cdof) {
25619566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetFieldConstraintIndices(s, p, f, &cind));
25629566063dSJacob Faibussowitsch         PetscCall(PetscSectionSetFieldConstraintIndices(sNew, perm[p], f, cind));
2563ea844a1aSMatthew Knepley       }
2564ea844a1aSMatthew Knepley     }
2565ea844a1aSMatthew Knepley   }
25669566063dSJacob Faibussowitsch   PetscCall(ISRestoreIndices(permutation, &perm));
2567ea844a1aSMatthew Knepley   *sectionNew = sNew;
2568ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2569ea844a1aSMatthew Knepley }
2570ea844a1aSMatthew Knepley 
2571ea844a1aSMatthew Knepley /*@
2572ea844a1aSMatthew Knepley   PetscSectionSetClosureIndex - Set a cache of points in the closure of each point in the section
2573ea844a1aSMatthew Knepley 
257440750d41SVaclav Hapla   Collective
2575ea844a1aSMatthew Knepley 
2576ea844a1aSMatthew Knepley   Input Parameters:
2577ea844a1aSMatthew Knepley + section   - The PetscSection
2578ea844a1aSMatthew Knepley . obj       - A PetscObject which serves as the key for this index
2579ea844a1aSMatthew Knepley . clSection - Section giving the size of the closure of each point
2580ea844a1aSMatthew Knepley - clPoints  - IS giving the points in each closure
2581ea844a1aSMatthew Knepley 
2582ea844a1aSMatthew Knepley   Note: We compress out closure points with no dofs in this section
2583ea844a1aSMatthew Knepley 
2584ea844a1aSMatthew Knepley   Level: advanced
2585ea844a1aSMatthew Knepley 
2586ea844a1aSMatthew Knepley .seealso: PetscSectionGetClosureIndex(), DMPlexCreateClosureIndex()
2587ea844a1aSMatthew Knepley @*/
2588ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetClosureIndex(PetscSection section, PetscObject obj, PetscSection clSection, IS clPoints)
2589ea844a1aSMatthew Knepley {
2590ea844a1aSMatthew Knepley   PetscFunctionBegin;
25913e03ebd8SStefano Zampini   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,1);
25923e03ebd8SStefano Zampini   PetscValidHeaderSpecific(clSection,PETSC_SECTION_CLASSID,3);
25933e03ebd8SStefano Zampini   PetscValidHeaderSpecific(clPoints,IS_CLASSID,4);
25949566063dSJacob Faibussowitsch   if (section->clObj != obj) PetscCall(PetscSectionResetClosurePermutation(section));
2595ea844a1aSMatthew Knepley   section->clObj     = obj;
25969566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)clSection));
25979566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)clPoints));
25989566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&section->clSection));
25999566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&section->clPoints));
2600ea844a1aSMatthew Knepley   section->clSection = clSection;
2601ea844a1aSMatthew Knepley   section->clPoints  = clPoints;
2602ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2603ea844a1aSMatthew Knepley }
2604ea844a1aSMatthew Knepley 
2605ea844a1aSMatthew Knepley /*@
2606ea844a1aSMatthew Knepley   PetscSectionGetClosureIndex - Get the cache of points in the closure of each point in the section
2607ea844a1aSMatthew Knepley 
260840750d41SVaclav Hapla   Collective
2609ea844a1aSMatthew Knepley 
2610ea844a1aSMatthew Knepley   Input Parameters:
2611ea844a1aSMatthew Knepley + section   - The PetscSection
2612ea844a1aSMatthew Knepley - obj       - A PetscObject which serves as the key for this index
2613ea844a1aSMatthew Knepley 
2614ea844a1aSMatthew Knepley   Output Parameters:
2615ea844a1aSMatthew Knepley + clSection - Section giving the size of the closure of each point
2616ea844a1aSMatthew Knepley - clPoints  - IS giving the points in each closure
2617ea844a1aSMatthew Knepley 
2618ea844a1aSMatthew Knepley   Note: We compress out closure points with no dofs in this section
2619ea844a1aSMatthew Knepley 
2620ea844a1aSMatthew Knepley   Level: advanced
2621ea844a1aSMatthew Knepley 
2622ea844a1aSMatthew Knepley .seealso: PetscSectionSetClosureIndex(), DMPlexCreateClosureIndex()
2623ea844a1aSMatthew Knepley @*/
2624ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetClosureIndex(PetscSection section, PetscObject obj, PetscSection *clSection, IS *clPoints)
2625ea844a1aSMatthew Knepley {
2626ea844a1aSMatthew Knepley   PetscFunctionBegin;
2627ea844a1aSMatthew Knepley   if (section->clObj == obj) {
2628ea844a1aSMatthew Knepley     if (clSection) *clSection = section->clSection;
2629ea844a1aSMatthew Knepley     if (clPoints)  *clPoints  = section->clPoints;
2630ea844a1aSMatthew Knepley   } else {
2631ea844a1aSMatthew Knepley     if (clSection) *clSection = NULL;
2632ea844a1aSMatthew Knepley     if (clPoints)  *clPoints  = NULL;
2633ea844a1aSMatthew Knepley   }
2634ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2635ea844a1aSMatthew Knepley }
2636ea844a1aSMatthew Knepley 
2637c459fbc1SJed Brown PetscErrorCode PetscSectionSetClosurePermutation_Internal(PetscSection section, PetscObject obj, PetscInt depth, PetscInt clSize, PetscCopyMode mode, PetscInt *clPerm)
2638ea844a1aSMatthew Knepley {
2639ea844a1aSMatthew Knepley   PetscInt       i;
2640c459fbc1SJed Brown   khiter_t iter;
2641c459fbc1SJed Brown   int new_entry;
2642c459fbc1SJed Brown   PetscSectionClosurePermKey key = {depth, clSize};
2643c459fbc1SJed Brown   PetscSectionClosurePermVal *val;
2644ea844a1aSMatthew Knepley 
2645ea844a1aSMatthew Knepley   PetscFunctionBegin;
2646ea844a1aSMatthew Knepley   if (section->clObj != obj) {
26479566063dSJacob Faibussowitsch     PetscCall(PetscSectionDestroy(&section->clSection));
26489566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&section->clPoints));
2649ea844a1aSMatthew Knepley   }
2650ea844a1aSMatthew Knepley   section->clObj = obj;
26519566063dSJacob Faibussowitsch   if (!section->clHash) PetscCall(PetscClPermCreate(&section->clHash));
2652c459fbc1SJed Brown   iter = kh_put(ClPerm, section->clHash, key, &new_entry);
2653c459fbc1SJed Brown   val = &kh_val(section->clHash, iter);
2654c459fbc1SJed Brown   if (!new_entry) {
26559566063dSJacob Faibussowitsch     PetscCall(PetscFree(val->perm));
26569566063dSJacob Faibussowitsch     PetscCall(PetscFree(val->invPerm));
2657c459fbc1SJed Brown   }
2658ea844a1aSMatthew Knepley   if (mode == PETSC_COPY_VALUES) {
26599566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(clSize, &val->perm));
26609566063dSJacob Faibussowitsch     PetscCall(PetscLogObjectMemory((PetscObject) obj, clSize*sizeof(PetscInt)));
26619566063dSJacob Faibussowitsch     PetscCall(PetscArraycpy(val->perm, clPerm, clSize));
2662ea844a1aSMatthew Knepley   } else if (mode == PETSC_OWN_POINTER) {
2663c459fbc1SJed Brown     val->perm = clPerm;
2664ea844a1aSMatthew Knepley   } else SETERRQ(PetscObjectComm(obj), PETSC_ERR_SUP, "Do not support borrowed arrays");
26659566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(clSize, &val->invPerm));
2666c459fbc1SJed Brown   for (i = 0; i < clSize; ++i) val->invPerm[clPerm[i]] = i;
2667ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2668ea844a1aSMatthew Knepley }
2669ea844a1aSMatthew Knepley 
2670ea844a1aSMatthew Knepley /*@
2671c459fbc1SJed Brown   PetscSectionSetClosurePermutation - Set the dof permutation for the closure of each cell in the section, meaning clPerm[newIndex] = oldIndex.
2672ea844a1aSMatthew Knepley 
2673ea844a1aSMatthew Knepley   Not Collective
2674ea844a1aSMatthew Knepley 
2675ea844a1aSMatthew Knepley   Input Parameters:
2676ea844a1aSMatthew Knepley + section - The PetscSection
2677c459fbc1SJed Brown . obj     - A PetscObject which serves as the key for this index (usually a DM)
2678c459fbc1SJed Brown . depth   - Depth of points on which to apply the given permutation
2679ea844a1aSMatthew Knepley - perm    - Permutation of the cell dof closure
2680ea844a1aSMatthew Knepley 
2681c459fbc1SJed Brown   Note:
2682c459fbc1SJed Brown   The specified permutation will only be applied to points at depth whose closure size matches the length of perm.  In a
2683c459fbc1SJed Brown   mixed-topology or variable-degree finite element space, this function can be called multiple times at each depth for
2684c459fbc1SJed Brown   each topology and degree.
2685c459fbc1SJed Brown 
2686c459fbc1SJed Brown   This approach assumes that (depth, len(perm)) uniquely identifies the desired permutation; this might not be true for
2687c459fbc1SJed Brown   exotic/enriched spaces on mixed topology meshes.
2688ea844a1aSMatthew Knepley 
2689ea844a1aSMatthew Knepley   Level: intermediate
2690ea844a1aSMatthew Knepley 
2691ea844a1aSMatthew Knepley .seealso: PetscSectionGetClosurePermutation(), PetscSectionGetClosureIndex(), DMPlexCreateClosureIndex(), PetscCopyMode
2692ea844a1aSMatthew Knepley @*/
2693c459fbc1SJed Brown PetscErrorCode PetscSectionSetClosurePermutation(PetscSection section, PetscObject obj, PetscInt depth, IS perm)
2694ea844a1aSMatthew Knepley {
2695ea844a1aSMatthew Knepley   const PetscInt *clPerm = NULL;
2696ea844a1aSMatthew Knepley   PetscInt        clSize = 0;
2697ea844a1aSMatthew Knepley 
2698ea844a1aSMatthew Knepley   PetscFunctionBegin;
2699ea844a1aSMatthew Knepley   if (perm) {
27009566063dSJacob Faibussowitsch     PetscCall(ISGetLocalSize(perm, &clSize));
27019566063dSJacob Faibussowitsch     PetscCall(ISGetIndices(perm, &clPerm));
2702ea844a1aSMatthew Knepley   }
27039566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetClosurePermutation_Internal(section, obj, depth, clSize, PETSC_COPY_VALUES, (PetscInt *) clPerm));
27049566063dSJacob Faibussowitsch   if (perm) PetscCall(ISRestoreIndices(perm, &clPerm));
2705ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2706ea844a1aSMatthew Knepley }
2707ea844a1aSMatthew Knepley 
2708c459fbc1SJed Brown PetscErrorCode PetscSectionGetClosurePermutation_Internal(PetscSection section, PetscObject obj, PetscInt depth, PetscInt size, const PetscInt *perm[])
2709ea844a1aSMatthew Knepley {
2710ea844a1aSMatthew Knepley   PetscFunctionBegin;
2711ea844a1aSMatthew Knepley   if (section->clObj == obj) {
2712c459fbc1SJed Brown     PetscSectionClosurePermKey k = {depth, size};
2713c459fbc1SJed Brown     PetscSectionClosurePermVal v;
27149566063dSJacob Faibussowitsch     PetscCall(PetscClPermGet(section->clHash, k, &v));
2715c459fbc1SJed Brown     if (perm) *perm = v.perm;
2716ea844a1aSMatthew Knepley   } else {
2717ea844a1aSMatthew Knepley     if (perm) *perm = NULL;
2718ea844a1aSMatthew Knepley   }
2719ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2720ea844a1aSMatthew Knepley }
2721ea844a1aSMatthew Knepley 
2722ea844a1aSMatthew Knepley /*@
2723ea844a1aSMatthew Knepley   PetscSectionGetClosurePermutation - Get the dof permutation for the closure of each cell in the section, meaning clPerm[newIndex] = oldIndex.
2724ea844a1aSMatthew Knepley 
272540750d41SVaclav Hapla   Not Collective
2726ea844a1aSMatthew Knepley 
2727ea844a1aSMatthew Knepley   Input Parameters:
2728ea844a1aSMatthew Knepley + section   - The PetscSection
2729c459fbc1SJed Brown . obj       - A PetscObject which serves as the key for this index (usually a DM)
2730c459fbc1SJed Brown . depth     - Depth stratum on which to obtain closure permutation
2731c459fbc1SJed Brown - clSize    - Closure size to be permuted (e.g., may vary with element topology and degree)
2732ea844a1aSMatthew Knepley 
2733ea844a1aSMatthew Knepley   Output Parameter:
2734ea844a1aSMatthew Knepley . perm - The dof closure permutation
2735ea844a1aSMatthew Knepley 
2736c459fbc1SJed Brown   Note:
2737ea844a1aSMatthew Knepley   The user must destroy the IS that is returned.
2738ea844a1aSMatthew Knepley 
2739ea844a1aSMatthew Knepley   Level: intermediate
2740ea844a1aSMatthew Knepley 
2741ea844a1aSMatthew Knepley .seealso: PetscSectionSetClosurePermutation(), PetscSectionGetClosureInversePermutation(), PetscSectionGetClosureIndex(), PetscSectionSetClosureIndex(), DMPlexCreateClosureIndex()
2742ea844a1aSMatthew Knepley @*/
2743c459fbc1SJed Brown PetscErrorCode PetscSectionGetClosurePermutation(PetscSection section, PetscObject obj, PetscInt depth, PetscInt clSize, IS *perm)
2744ea844a1aSMatthew Knepley {
2745ea844a1aSMatthew Knepley   const PetscInt *clPerm;
2746ea844a1aSMatthew Knepley 
2747ea844a1aSMatthew Knepley   PetscFunctionBegin;
27489566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetClosurePermutation_Internal(section, obj, depth, clSize, &clPerm));
27499566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(PETSC_COMM_SELF, clSize, clPerm, PETSC_USE_POINTER, perm));
2750ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2751ea844a1aSMatthew Knepley }
2752ea844a1aSMatthew Knepley 
2753c459fbc1SJed Brown PetscErrorCode PetscSectionGetClosureInversePermutation_Internal(PetscSection section, PetscObject obj, PetscInt depth, PetscInt size, const PetscInt *perm[])
2754ea844a1aSMatthew Knepley {
2755ea844a1aSMatthew Knepley   PetscFunctionBegin;
2756c459fbc1SJed Brown   if (section->clObj == obj && section->clHash) {
2757c459fbc1SJed Brown     PetscSectionClosurePermKey k = {depth, size};
2758c459fbc1SJed Brown     PetscSectionClosurePermVal v;
27599566063dSJacob Faibussowitsch     PetscCall(PetscClPermGet(section->clHash, k, &v));
2760c459fbc1SJed Brown     if (perm) *perm = v.invPerm;
2761ea844a1aSMatthew Knepley   } else {
2762ea844a1aSMatthew Knepley     if (perm) *perm = NULL;
2763ea844a1aSMatthew Knepley   }
2764ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2765ea844a1aSMatthew Knepley }
2766ea844a1aSMatthew Knepley 
2767ea844a1aSMatthew Knepley /*@
2768ea844a1aSMatthew Knepley   PetscSectionGetClosureInversePermutation - Get the inverse dof permutation for the closure of each cell in the section, meaning clPerm[oldIndex] = newIndex.
2769ea844a1aSMatthew Knepley 
277040750d41SVaclav Hapla   Not Collective
2771ea844a1aSMatthew Knepley 
2772ea844a1aSMatthew Knepley   Input Parameters:
2773ea844a1aSMatthew Knepley + section   - The PetscSection
2774c459fbc1SJed Brown . obj       - A PetscObject which serves as the key for this index (usually a DM)
2775c459fbc1SJed Brown . depth     - Depth stratum on which to obtain closure permutation
2776c459fbc1SJed Brown - clSize    - Closure size to be permuted (e.g., may vary with element topology and degree)
2777ea844a1aSMatthew Knepley 
2778ea844a1aSMatthew Knepley   Output Parameters:
2779c459fbc1SJed Brown . perm - The dof closure permutation
2780ea844a1aSMatthew Knepley 
2781c459fbc1SJed Brown   Note:
2782ea844a1aSMatthew Knepley   The user must destroy the IS that is returned.
2783ea844a1aSMatthew Knepley 
2784ea844a1aSMatthew Knepley   Level: intermediate
2785ea844a1aSMatthew Knepley 
2786ea844a1aSMatthew Knepley .seealso: PetscSectionSetClosurePermutation(), PetscSectionGetClosureIndex(), PetscSectionSetClosureIndex(), DMPlexCreateClosureIndex()
2787ea844a1aSMatthew Knepley @*/
2788c459fbc1SJed Brown PetscErrorCode PetscSectionGetClosureInversePermutation(PetscSection section, PetscObject obj, PetscInt depth, PetscInt clSize, IS *perm)
2789ea844a1aSMatthew Knepley {
2790ea844a1aSMatthew Knepley   const PetscInt *clPerm;
2791ea844a1aSMatthew Knepley 
2792ea844a1aSMatthew Knepley   PetscFunctionBegin;
27939566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetClosureInversePermutation_Internal(section, obj, depth, clSize, &clPerm));
27949566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(PETSC_COMM_SELF, clSize, clPerm, PETSC_USE_POINTER, perm));
2795ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2796ea844a1aSMatthew Knepley }
2797ea844a1aSMatthew Knepley 
2798ea844a1aSMatthew Knepley /*@
2799ea844a1aSMatthew Knepley   PetscSectionGetField - Get the subsection associated with a single field
2800ea844a1aSMatthew Knepley 
2801ea844a1aSMatthew Knepley   Input Parameters:
2802ea844a1aSMatthew Knepley + s     - The PetscSection
2803ea844a1aSMatthew Knepley - field - The field number
2804ea844a1aSMatthew Knepley 
2805ea844a1aSMatthew Knepley   Output Parameter:
2806ea844a1aSMatthew Knepley . subs  - The subsection for the given field
2807ea844a1aSMatthew Knepley 
2808ea844a1aSMatthew Knepley   Level: intermediate
2809ea844a1aSMatthew Knepley 
2810ea844a1aSMatthew Knepley .seealso: PetscSectionSetNumFields()
2811ea844a1aSMatthew Knepley @*/
2812ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetField(PetscSection s, PetscInt field, PetscSection *subs)
2813ea844a1aSMatthew Knepley {
2814ea844a1aSMatthew Knepley   PetscFunctionBegin;
2815ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s,PETSC_SECTION_CLASSID,1);
2816ea844a1aSMatthew Knepley   PetscValidPointer(subs,3);
28172abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
2818ea844a1aSMatthew Knepley   *subs = s->field[field];
2819ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2820ea844a1aSMatthew Knepley }
2821ea844a1aSMatthew Knepley 
2822ea844a1aSMatthew Knepley PetscClassId      PETSC_SECTION_SYM_CLASSID;
2823ea844a1aSMatthew Knepley PetscFunctionList PetscSectionSymList = NULL;
2824ea844a1aSMatthew Knepley 
2825ea844a1aSMatthew Knepley /*@
2826ea844a1aSMatthew Knepley   PetscSectionSymCreate - Creates an empty PetscSectionSym object.
2827ea844a1aSMatthew Knepley 
2828ea844a1aSMatthew Knepley   Collective
2829ea844a1aSMatthew Knepley 
2830ea844a1aSMatthew Knepley   Input Parameter:
2831ea844a1aSMatthew Knepley . comm - the MPI communicator
2832ea844a1aSMatthew Knepley 
2833ea844a1aSMatthew Knepley   Output Parameter:
2834ea844a1aSMatthew Knepley . sym - pointer to the new set of symmetries
2835ea844a1aSMatthew Knepley 
2836ea844a1aSMatthew Knepley   Level: developer
2837ea844a1aSMatthew Knepley 
2838ea844a1aSMatthew Knepley .seealso: PetscSectionSym, PetscSectionSymDestroy()
2839ea844a1aSMatthew Knepley @*/
2840ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSymCreate(MPI_Comm comm, PetscSectionSym *sym)
2841ea844a1aSMatthew Knepley {
2842ea844a1aSMatthew Knepley   PetscFunctionBegin;
2843ea844a1aSMatthew Knepley   PetscValidPointer(sym,2);
28449566063dSJacob Faibussowitsch   PetscCall(ISInitializePackage());
28459566063dSJacob Faibussowitsch   PetscCall(PetscHeaderCreate(*sym,PETSC_SECTION_SYM_CLASSID,"PetscSectionSym","Section Symmetry","IS",comm,PetscSectionSymDestroy,PetscSectionSymView));
2846ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2847ea844a1aSMatthew Knepley }
2848ea844a1aSMatthew Knepley 
2849ea844a1aSMatthew Knepley /*@C
2850ea844a1aSMatthew Knepley   PetscSectionSymSetType - Builds a PetscSection symmetry, for a particular implementation.
2851ea844a1aSMatthew Knepley 
285240750d41SVaclav Hapla   Collective
2853ea844a1aSMatthew Knepley 
2854ea844a1aSMatthew Knepley   Input Parameters:
2855ea844a1aSMatthew Knepley + sym    - The section symmetry object
2856ea844a1aSMatthew Knepley - method - The name of the section symmetry type
2857ea844a1aSMatthew Knepley 
2858ea844a1aSMatthew Knepley   Level: developer
2859ea844a1aSMatthew Knepley 
2860ea844a1aSMatthew Knepley .seealso: PetscSectionSymGetType(), PetscSectionSymCreate()
2861ea844a1aSMatthew Knepley @*/
2862ea844a1aSMatthew Knepley PetscErrorCode  PetscSectionSymSetType(PetscSectionSym sym, PetscSectionSymType method)
2863ea844a1aSMatthew Knepley {
2864ea844a1aSMatthew Knepley   PetscErrorCode (*r)(PetscSectionSym);
2865ea844a1aSMatthew Knepley   PetscBool      match;
2866ea844a1aSMatthew Knepley 
2867ea844a1aSMatthew Knepley   PetscFunctionBegin;
2868ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID,1);
28699566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject) sym, method, &match));
2870ea844a1aSMatthew Knepley   if (match) PetscFunctionReturn(0);
2871ea844a1aSMatthew Knepley 
28729566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListFind(PetscSectionSymList,method,&r));
287328b400f6SJacob Faibussowitsch   PetscCheck(r,PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown PetscSectionSym type: %s", method);
2874ea844a1aSMatthew Knepley   if (sym->ops->destroy) {
28759566063dSJacob Faibussowitsch     PetscCall((*sym->ops->destroy)(sym));
2876ea844a1aSMatthew Knepley     sym->ops->destroy = NULL;
2877ea844a1aSMatthew Knepley   }
28789566063dSJacob Faibussowitsch   PetscCall((*r)(sym));
28799566063dSJacob Faibussowitsch   PetscCall(PetscObjectChangeTypeName((PetscObject)sym,method));
2880ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2881ea844a1aSMatthew Knepley }
2882ea844a1aSMatthew Knepley 
2883ea844a1aSMatthew Knepley /*@C
2884ea844a1aSMatthew Knepley   PetscSectionSymGetType - Gets the section symmetry type name (as a string) from the PetscSectionSym.
2885ea844a1aSMatthew Knepley 
2886ea844a1aSMatthew Knepley   Not Collective
2887ea844a1aSMatthew Knepley 
2888ea844a1aSMatthew Knepley   Input Parameter:
2889ea844a1aSMatthew Knepley . sym  - The section symmetry
2890ea844a1aSMatthew Knepley 
2891ea844a1aSMatthew Knepley   Output Parameter:
2892ea844a1aSMatthew Knepley . type - The index set type name
2893ea844a1aSMatthew Knepley 
2894ea844a1aSMatthew Knepley   Level: developer
2895ea844a1aSMatthew Knepley 
2896ea844a1aSMatthew Knepley .seealso: PetscSectionSymSetType(), PetscSectionSymCreate()
2897ea844a1aSMatthew Knepley @*/
2898ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSymGetType(PetscSectionSym sym, PetscSectionSymType *type)
2899ea844a1aSMatthew Knepley {
2900ea844a1aSMatthew Knepley   PetscFunctionBegin;
2901ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID,1);
2902dadcf809SJacob Faibussowitsch   PetscValidPointer(type,2);
2903ea844a1aSMatthew Knepley   *type = ((PetscObject)sym)->type_name;
2904ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2905ea844a1aSMatthew Knepley }
2906ea844a1aSMatthew Knepley 
2907ea844a1aSMatthew Knepley /*@C
2908ea844a1aSMatthew Knepley   PetscSectionSymRegister - Adds a new section symmetry implementation
2909ea844a1aSMatthew Knepley 
2910ea844a1aSMatthew Knepley   Not Collective
2911ea844a1aSMatthew Knepley 
2912ea844a1aSMatthew Knepley   Input Parameters:
2913ea844a1aSMatthew Knepley + name        - The name of a new user-defined creation routine
2914ea844a1aSMatthew Knepley - create_func - The creation routine itself
2915ea844a1aSMatthew Knepley 
2916ea844a1aSMatthew Knepley   Notes:
2917ea844a1aSMatthew Knepley   PetscSectionSymRegister() may be called multiple times to add several user-defined vectors
2918ea844a1aSMatthew Knepley 
2919ea844a1aSMatthew Knepley   Level: developer
2920ea844a1aSMatthew Knepley 
2921ea844a1aSMatthew Knepley .seealso: PetscSectionSymCreate(), PetscSectionSymSetType()
2922ea844a1aSMatthew Knepley @*/
2923ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSymRegister(const char sname[], PetscErrorCode (*function)(PetscSectionSym))
2924ea844a1aSMatthew Knepley {
2925ea844a1aSMatthew Knepley   PetscFunctionBegin;
29269566063dSJacob Faibussowitsch   PetscCall(ISInitializePackage());
29279566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListAdd(&PetscSectionSymList,sname,function));
2928ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2929ea844a1aSMatthew Knepley }
2930ea844a1aSMatthew Knepley 
2931ea844a1aSMatthew Knepley /*@
2932ea844a1aSMatthew Knepley    PetscSectionSymDestroy - Destroys a section symmetry.
2933ea844a1aSMatthew Knepley 
293440750d41SVaclav Hapla    Collective
2935ea844a1aSMatthew Knepley 
2936ea844a1aSMatthew Knepley    Input Parameters:
2937ea844a1aSMatthew Knepley .  sym - the section symmetry
2938ea844a1aSMatthew Knepley 
2939ea844a1aSMatthew Knepley    Level: developer
2940ea844a1aSMatthew Knepley 
2941ea844a1aSMatthew Knepley .seealso: PetscSectionSymCreate(), PetscSectionSymDestroy()
2942ea844a1aSMatthew Knepley @*/
2943ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSymDestroy(PetscSectionSym *sym)
2944ea844a1aSMatthew Knepley {
2945ea844a1aSMatthew Knepley   SymWorkLink    link,next;
2946ea844a1aSMatthew Knepley 
2947ea844a1aSMatthew Knepley   PetscFunctionBegin;
2948ea844a1aSMatthew Knepley   if (!*sym) PetscFunctionReturn(0);
2949ea844a1aSMatthew Knepley   PetscValidHeaderSpecific((*sym),PETSC_SECTION_SYM_CLASSID,1);
29504c8fdceaSLisandro Dalcin   if (--((PetscObject)(*sym))->refct > 0) {*sym = NULL; PetscFunctionReturn(0);}
2951ea844a1aSMatthew Knepley   if ((*sym)->ops->destroy) {
29529566063dSJacob Faibussowitsch     PetscCall((*(*sym)->ops->destroy)(*sym));
2953ea844a1aSMatthew Knepley   }
29542c71b3e2SJacob Faibussowitsch   PetscCheckFalse((*sym)->workout,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Work array still checked out");
2955ea844a1aSMatthew Knepley   for (link=(*sym)->workin; link; link=next) {
2956ea844a1aSMatthew Knepley     next = link->next;
29579566063dSJacob Faibussowitsch     PetscCall(PetscFree2(link->perms,link->rots));
29589566063dSJacob Faibussowitsch     PetscCall(PetscFree(link));
2959ea844a1aSMatthew Knepley   }
2960ea844a1aSMatthew Knepley   (*sym)->workin = NULL;
29619566063dSJacob Faibussowitsch   PetscCall(PetscHeaderDestroy(sym));
2962ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2963ea844a1aSMatthew Knepley }
2964ea844a1aSMatthew Knepley 
2965ea844a1aSMatthew Knepley /*@C
2966ea844a1aSMatthew Knepley    PetscSectionSymView - Displays a section symmetry
2967ea844a1aSMatthew Knepley 
296840750d41SVaclav Hapla    Collective
2969ea844a1aSMatthew Knepley 
2970ea844a1aSMatthew Knepley    Input Parameters:
2971ea844a1aSMatthew Knepley +  sym - the index set
2972ea844a1aSMatthew Knepley -  viewer - viewer used to display the set, for example PETSC_VIEWER_STDOUT_SELF.
2973ea844a1aSMatthew Knepley 
2974ea844a1aSMatthew Knepley    Level: developer
2975ea844a1aSMatthew Knepley 
2976ea844a1aSMatthew Knepley .seealso: PetscViewerASCIIOpen()
2977ea844a1aSMatthew Knepley @*/
2978ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSymView(PetscSectionSym sym,PetscViewer viewer)
2979ea844a1aSMatthew Knepley {
2980ea844a1aSMatthew Knepley   PetscFunctionBegin;
2981ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(sym,PETSC_SECTION_SYM_CLASSID,1);
2982ea844a1aSMatthew Knepley   if (!viewer) {
29839566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)sym),&viewer));
2984ea844a1aSMatthew Knepley   }
2985ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
2986ea844a1aSMatthew Knepley   PetscCheckSameComm(sym,1,viewer,2);
29879566063dSJacob Faibussowitsch   PetscCall(PetscObjectPrintClassNamePrefixType((PetscObject)sym,viewer));
2988ea844a1aSMatthew Knepley   if (sym->ops->view) {
29899566063dSJacob Faibussowitsch     PetscCall((*sym->ops->view)(sym,viewer));
2990ea844a1aSMatthew Knepley   }
2991ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2992ea844a1aSMatthew Knepley }
2993ea844a1aSMatthew Knepley 
2994ea844a1aSMatthew Knepley /*@
2995ea844a1aSMatthew Knepley   PetscSectionSetSym - Set the symmetries for the data referred to by the section
2996ea844a1aSMatthew Knepley 
299740750d41SVaclav Hapla   Collective
2998ea844a1aSMatthew Knepley 
2999ea844a1aSMatthew Knepley   Input Parameters:
3000ea844a1aSMatthew Knepley + section - the section describing data layout
3001ea844a1aSMatthew Knepley - sym - the symmetry describing the affect of orientation on the access of the data
3002ea844a1aSMatthew Knepley 
3003ea844a1aSMatthew Knepley   Level: developer
3004ea844a1aSMatthew Knepley 
3005ea844a1aSMatthew Knepley .seealso: PetscSectionGetSym(), PetscSectionSymCreate()
3006ea844a1aSMatthew Knepley @*/
3007ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetSym(PetscSection section, PetscSectionSym sym)
3008ea844a1aSMatthew Knepley {
3009ea844a1aSMatthew Knepley   PetscFunctionBegin;
3010ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,1);
30119566063dSJacob Faibussowitsch   PetscCall(PetscSectionSymDestroy(&(section->sym)));
3012ea844a1aSMatthew Knepley   if (sym) {
3013ea844a1aSMatthew Knepley     PetscValidHeaderSpecific(sym,PETSC_SECTION_SYM_CLASSID,2);
3014ea844a1aSMatthew Knepley     PetscCheckSameComm(section,1,sym,2);
30159566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject) sym));
3016ea844a1aSMatthew Knepley   }
3017ea844a1aSMatthew Knepley   section->sym = sym;
3018ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3019ea844a1aSMatthew Knepley }
3020ea844a1aSMatthew Knepley 
3021ea844a1aSMatthew Knepley /*@
3022ea844a1aSMatthew Knepley   PetscSectionGetSym - Get the symmetries for the data referred to by the section
3023ea844a1aSMatthew Knepley 
302440750d41SVaclav Hapla   Not Collective
3025ea844a1aSMatthew Knepley 
3026ea844a1aSMatthew Knepley   Input Parameters:
3027ea844a1aSMatthew Knepley . section - the section describing data layout
3028ea844a1aSMatthew Knepley 
3029ea844a1aSMatthew Knepley   Output Parameters:
3030ea844a1aSMatthew Knepley . sym - the symmetry describing the affect of orientation on the access of the data
3031ea844a1aSMatthew Knepley 
3032ea844a1aSMatthew Knepley   Level: developer
3033ea844a1aSMatthew Knepley 
3034ea844a1aSMatthew Knepley .seealso: PetscSectionSetSym(), PetscSectionSymCreate()
3035ea844a1aSMatthew Knepley @*/
3036ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetSym(PetscSection section, PetscSectionSym *sym)
3037ea844a1aSMatthew Knepley {
3038ea844a1aSMatthew Knepley   PetscFunctionBegin;
3039ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,1);
3040ea844a1aSMatthew Knepley   *sym = section->sym;
3041ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3042ea844a1aSMatthew Knepley }
3043ea844a1aSMatthew Knepley 
3044ea844a1aSMatthew Knepley /*@
3045ea844a1aSMatthew Knepley   PetscSectionSetFieldSym - Set the symmetries for the data referred to by a field of the section
3046ea844a1aSMatthew Knepley 
304740750d41SVaclav Hapla   Collective
3048ea844a1aSMatthew Knepley 
3049ea844a1aSMatthew Knepley   Input Parameters:
3050ea844a1aSMatthew Knepley + section - the section describing data layout
3051ea844a1aSMatthew Knepley . field - the field number
3052ea844a1aSMatthew Knepley - sym - the symmetry describing the affect of orientation on the access of the data
3053ea844a1aSMatthew Knepley 
3054ea844a1aSMatthew Knepley   Level: developer
3055ea844a1aSMatthew Knepley 
3056ea844a1aSMatthew Knepley .seealso: PetscSectionGetFieldSym(), PetscSectionSymCreate()
3057ea844a1aSMatthew Knepley @*/
3058ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetFieldSym(PetscSection section, PetscInt field, PetscSectionSym sym)
3059ea844a1aSMatthew Knepley {
3060ea844a1aSMatthew Knepley   PetscFunctionBegin;
3061ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,1);
30622abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,section->numFields);
30639566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetSym(section->field[field],sym));
3064ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3065ea844a1aSMatthew Knepley }
3066ea844a1aSMatthew Knepley 
3067ea844a1aSMatthew Knepley /*@
3068ea844a1aSMatthew Knepley   PetscSectionGetFieldSym - Get the symmetries for the data referred to by a field of the section
3069ea844a1aSMatthew Knepley 
307040750d41SVaclav Hapla   Collective
3071ea844a1aSMatthew Knepley 
3072ea844a1aSMatthew Knepley   Input Parameters:
3073ea844a1aSMatthew Knepley + section - the section describing data layout
3074ea844a1aSMatthew Knepley - field - the field number
3075ea844a1aSMatthew Knepley 
3076ea844a1aSMatthew Knepley   Output Parameters:
3077ea844a1aSMatthew Knepley . sym - the symmetry describing the affect of orientation on the access of the data
3078ea844a1aSMatthew Knepley 
3079ea844a1aSMatthew Knepley   Level: developer
3080ea844a1aSMatthew Knepley 
3081ea844a1aSMatthew Knepley .seealso: PetscSectionSetFieldSym(), PetscSectionSymCreate()
3082ea844a1aSMatthew Knepley @*/
3083ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetFieldSym(PetscSection section, PetscInt field, PetscSectionSym *sym)
3084ea844a1aSMatthew Knepley {
3085ea844a1aSMatthew Knepley   PetscFunctionBegin;
3086ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,1);
30872abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,section->numFields);
3088ea844a1aSMatthew Knepley   *sym = section->field[field]->sym;
3089ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3090ea844a1aSMatthew Knepley }
3091ea844a1aSMatthew Knepley 
3092ea844a1aSMatthew Knepley /*@C
3093ea844a1aSMatthew Knepley   PetscSectionGetPointSyms - Get the symmetries for a set of points in a PetscSection under specific orientations.
3094ea844a1aSMatthew Knepley 
309540750d41SVaclav Hapla   Not Collective
3096ea844a1aSMatthew Knepley 
3097ea844a1aSMatthew Knepley   Input Parameters:
3098ea844a1aSMatthew Knepley + section - the section
3099ea844a1aSMatthew Knepley . numPoints - the number of points
3100ea844a1aSMatthew Knepley - points - an array of size 2 * numPoints, containing a list of (point, orientation) pairs. (An orientation is an
3101ea844a1aSMatthew Knepley     arbitrary integer: its interpretation is up to sym.  Orientations are used by DM: for their interpretation in that
3102ea844a1aSMatthew Knepley     context, see DMPlexGetConeOrientation()).
3103ea844a1aSMatthew Knepley 
3104d8d19677SJose E. Roman   Output Parameters:
3105ea844a1aSMatthew Knepley + perms - The permutations for the given orientations (or NULL if there is no symmetry or the permutation is the identity).
3106ea844a1aSMatthew Knepley - rots - The field rotations symmetries for the given orientations (or NULL if there is no symmetry or the rotations are all
3107ea844a1aSMatthew Knepley     identity).
3108ea844a1aSMatthew Knepley 
3109ea844a1aSMatthew Knepley   Example of usage, gathering dofs into a local array (lArray) from a section array (sArray):
3110ea844a1aSMatthew Knepley .vb
3111ea844a1aSMatthew Knepley      const PetscInt    **perms;
3112ea844a1aSMatthew Knepley      const PetscScalar **rots;
3113ea844a1aSMatthew Knepley      PetscInt            lOffset;
3114ea844a1aSMatthew Knepley 
3115ea844a1aSMatthew Knepley      PetscSectionGetPointSyms(section,numPoints,points,&perms,&rots);
3116ea844a1aSMatthew Knepley      for (i = 0, lOffset = 0; i < numPoints; i++) {
3117ea844a1aSMatthew Knepley        PetscInt           point = points[2*i], dof, sOffset;
3118ea844a1aSMatthew Knepley        const PetscInt    *perm  = perms ? perms[i] : NULL;
3119ea844a1aSMatthew Knepley        const PetscScalar *rot   = rots  ? rots[i]  : NULL;
3120ea844a1aSMatthew Knepley 
3121ea844a1aSMatthew Knepley        PetscSectionGetDof(section,point,&dof);
3122ea844a1aSMatthew Knepley        PetscSectionGetOffset(section,point,&sOffset);
3123ea844a1aSMatthew Knepley 
3124ea844a1aSMatthew Knepley        if (perm) {for (j = 0; j < dof; j++) {lArray[lOffset + perm[j]]  = sArray[sOffset + j];}}
3125ea844a1aSMatthew Knepley        else      {for (j = 0; j < dof; j++) {lArray[lOffset +      j ]  = sArray[sOffset + j];}}
3126ea844a1aSMatthew Knepley        if (rot)  {for (j = 0; j < dof; j++) {lArray[lOffset +      j ] *= rot[j];             }}
3127ea844a1aSMatthew Knepley        lOffset += dof;
3128ea844a1aSMatthew Knepley      }
3129ea844a1aSMatthew Knepley      PetscSectionRestorePointSyms(section,numPoints,points,&perms,&rots);
3130ea844a1aSMatthew Knepley .ve
3131ea844a1aSMatthew Knepley 
3132ea844a1aSMatthew Knepley   Example of usage, adding dofs into a section array (sArray) from a local array (lArray):
3133ea844a1aSMatthew Knepley .vb
3134ea844a1aSMatthew Knepley      const PetscInt    **perms;
3135ea844a1aSMatthew Knepley      const PetscScalar **rots;
3136ea844a1aSMatthew Knepley      PetscInt            lOffset;
3137ea844a1aSMatthew Knepley 
3138ea844a1aSMatthew Knepley      PetscSectionGetPointSyms(section,numPoints,points,&perms,&rots);
3139ea844a1aSMatthew Knepley      for (i = 0, lOffset = 0; i < numPoints; i++) {
3140ea844a1aSMatthew Knepley        PetscInt           point = points[2*i], dof, sOffset;
3141ea844a1aSMatthew Knepley        const PetscInt    *perm  = perms ? perms[i] : NULL;
3142ea844a1aSMatthew Knepley        const PetscScalar *rot   = rots  ? rots[i]  : NULL;
3143ea844a1aSMatthew Knepley 
3144ea844a1aSMatthew Knepley        PetscSectionGetDof(section,point,&dof);
3145ea844a1aSMatthew Knepley        PetscSectionGetOffset(section,point,&sOff);
3146ea844a1aSMatthew Knepley 
3147ea844a1aSMatthew Knepley        if (perm) {for (j = 0; j < dof; j++) {sArray[sOffset + j] += lArray[lOffset + perm[j]] * (rot ? PetscConj(rot[perm[j]]) : 1.);}}
3148ea844a1aSMatthew Knepley        else      {for (j = 0; j < dof; j++) {sArray[sOffset + j] += lArray[lOffset +      j ] * (rot ? PetscConj(rot[     j ]) : 1.);}}
3149ea844a1aSMatthew Knepley        offset += dof;
3150ea844a1aSMatthew Knepley      }
3151ea844a1aSMatthew Knepley      PetscSectionRestorePointSyms(section,numPoints,points,&perms,&rots);
3152ea844a1aSMatthew Knepley .ve
3153ea844a1aSMatthew Knepley 
3154ea844a1aSMatthew Knepley   Level: developer
3155ea844a1aSMatthew Knepley 
3156ea844a1aSMatthew Knepley .seealso: PetscSectionRestorePointSyms(), PetscSectionSymCreate(), PetscSectionSetSym(), PetscSectionGetSym()
3157ea844a1aSMatthew Knepley @*/
3158ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetPointSyms(PetscSection section, PetscInt numPoints, const PetscInt *points, const PetscInt ***perms, const PetscScalar ***rots)
3159ea844a1aSMatthew Knepley {
3160ea844a1aSMatthew Knepley   PetscSectionSym sym;
3161ea844a1aSMatthew Knepley 
3162ea844a1aSMatthew Knepley   PetscFunctionBegin;
3163ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,1);
3164ea844a1aSMatthew Knepley   if (numPoints) PetscValidIntPointer(points,3);
3165ea844a1aSMatthew Knepley   if (perms) *perms = NULL;
3166ea844a1aSMatthew Knepley   if (rots)  *rots  = NULL;
3167ea844a1aSMatthew Knepley   sym = section->sym;
3168ea844a1aSMatthew Knepley   if (sym && (perms || rots)) {
3169ea844a1aSMatthew Knepley     SymWorkLink link;
3170ea844a1aSMatthew Knepley 
3171ea844a1aSMatthew Knepley     if (sym->workin) {
3172ea844a1aSMatthew Knepley       link        = sym->workin;
3173ea844a1aSMatthew Knepley       sym->workin = sym->workin->next;
3174ea844a1aSMatthew Knepley     } else {
31759566063dSJacob Faibussowitsch       PetscCall(PetscNewLog(sym,&link));
3176ea844a1aSMatthew Knepley     }
3177ea844a1aSMatthew Knepley     if (numPoints > link->numPoints) {
31789566063dSJacob Faibussowitsch       PetscCall(PetscFree2(link->perms,link->rots));
31799566063dSJacob Faibussowitsch       PetscCall(PetscMalloc2(numPoints,&link->perms,numPoints,&link->rots));
3180ea844a1aSMatthew Knepley       link->numPoints = numPoints;
3181ea844a1aSMatthew Knepley     }
3182ea844a1aSMatthew Knepley     link->next   = sym->workout;
3183ea844a1aSMatthew Knepley     sym->workout = link;
31849566063dSJacob Faibussowitsch     PetscCall(PetscArrayzero((PetscInt**)link->perms,numPoints));
31859566063dSJacob Faibussowitsch     PetscCall(PetscArrayzero((PetscInt**)link->rots,numPoints));
31869566063dSJacob Faibussowitsch     PetscCall((*sym->ops->getpoints) (sym, section, numPoints, points, link->perms, link->rots));
3187ea844a1aSMatthew Knepley     if (perms) *perms = link->perms;
3188ea844a1aSMatthew Knepley     if (rots)  *rots  = link->rots;
3189ea844a1aSMatthew Knepley   }
3190ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3191ea844a1aSMatthew Knepley }
3192ea844a1aSMatthew Knepley 
3193ea844a1aSMatthew Knepley /*@C
3194ea844a1aSMatthew Knepley   PetscSectionRestorePointSyms - Restore the symmetries returned by PetscSectionGetPointSyms()
3195ea844a1aSMatthew Knepley 
319640750d41SVaclav Hapla   Not Collective
3197ea844a1aSMatthew Knepley 
3198ea844a1aSMatthew Knepley   Input Parameters:
3199ea844a1aSMatthew Knepley + section - the section
3200ea844a1aSMatthew Knepley . numPoints - the number of points
3201ea844a1aSMatthew Knepley - points - an array of size 2 * numPoints, containing a list of (point, orientation) pairs. (An orientation is an
3202ea844a1aSMatthew Knepley     arbitrary integer: its interpretation is up to sym.  Orientations are used by DM: for their interpretation in that
3203ea844a1aSMatthew Knepley     context, see DMPlexGetConeOrientation()).
3204ea844a1aSMatthew Knepley 
3205d8d19677SJose E. Roman   Output Parameters:
3206ea844a1aSMatthew Knepley + perms - The permutations for the given orientations: set to NULL at conclusion
3207ea844a1aSMatthew Knepley - rots - The field rotations symmetries for the given orientations: set to NULL at conclusion
3208ea844a1aSMatthew Knepley 
3209ea844a1aSMatthew Knepley   Level: developer
3210ea844a1aSMatthew Knepley 
3211ea844a1aSMatthew Knepley .seealso: PetscSectionGetPointSyms(), PetscSectionSymCreate(), PetscSectionSetSym(), PetscSectionGetSym()
3212ea844a1aSMatthew Knepley @*/
3213ea844a1aSMatthew Knepley PetscErrorCode PetscSectionRestorePointSyms(PetscSection section, PetscInt numPoints, const PetscInt *points, const PetscInt ***perms, const PetscScalar ***rots)
3214ea844a1aSMatthew Knepley {
3215ea844a1aSMatthew Knepley   PetscSectionSym sym;
3216ea844a1aSMatthew Knepley 
3217ea844a1aSMatthew Knepley   PetscFunctionBegin;
3218ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,1);
3219ea844a1aSMatthew Knepley   sym = section->sym;
3220ea844a1aSMatthew Knepley   if (sym && (perms || rots)) {
3221ea844a1aSMatthew Knepley     SymWorkLink *p,link;
3222ea844a1aSMatthew Knepley 
3223ea844a1aSMatthew Knepley     for (p=&sym->workout; (link=*p); p=&link->next) {
3224ea844a1aSMatthew Knepley       if ((perms && link->perms == *perms) || (rots && link->rots == *rots)) {
3225ea844a1aSMatthew Knepley         *p          = link->next;
3226ea844a1aSMatthew Knepley         link->next  = sym->workin;
3227ea844a1aSMatthew Knepley         sym->workin = link;
3228ea844a1aSMatthew Knepley         if (perms) *perms = NULL;
3229ea844a1aSMatthew Knepley         if (rots)  *rots  = NULL;
3230ea844a1aSMatthew Knepley         PetscFunctionReturn(0);
3231ea844a1aSMatthew Knepley       }
3232ea844a1aSMatthew Knepley     }
3233ea844a1aSMatthew Knepley     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Array was not checked out");
3234ea844a1aSMatthew Knepley   }
3235ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3236ea844a1aSMatthew Knepley }
3237ea844a1aSMatthew Knepley 
3238ea844a1aSMatthew Knepley /*@C
3239ea844a1aSMatthew Knepley   PetscSectionGetFieldPointSyms - Get the symmetries for a set of points in a field of a PetscSection under specific orientations.
3240ea844a1aSMatthew Knepley 
324140750d41SVaclav Hapla   Not Collective
3242ea844a1aSMatthew Knepley 
3243ea844a1aSMatthew Knepley   Input Parameters:
3244ea844a1aSMatthew Knepley + section - the section
3245ea844a1aSMatthew Knepley . field - the field of the section
3246ea844a1aSMatthew Knepley . numPoints - the number of points
3247ea844a1aSMatthew Knepley - points - an array of size 2 * numPoints, containing a list of (point, orientation) pairs. (An orientation is an
3248ea844a1aSMatthew Knepley     arbitrary integer: its interpretation is up to sym.  Orientations are used by DM: for their interpretation in that
3249ea844a1aSMatthew Knepley     context, see DMPlexGetConeOrientation()).
3250ea844a1aSMatthew Knepley 
3251d8d19677SJose E. Roman   Output Parameters:
3252ea844a1aSMatthew Knepley + perms - The permutations for the given orientations (or NULL if there is no symmetry or the permutation is the identity).
3253ea844a1aSMatthew Knepley - rots - The field rotations symmetries for the given orientations (or NULL if there is no symmetry or the rotations are all
3254ea844a1aSMatthew Knepley     identity).
3255ea844a1aSMatthew Knepley 
3256ea844a1aSMatthew Knepley   Level: developer
3257ea844a1aSMatthew Knepley 
3258ea844a1aSMatthew Knepley .seealso: PetscSectionGetPointSyms(), PetscSectionRestoreFieldPointSyms()
3259ea844a1aSMatthew Knepley @*/
3260ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetFieldPointSyms(PetscSection section, PetscInt field, PetscInt numPoints, const PetscInt *points, const PetscInt ***perms, const PetscScalar ***rots)
3261ea844a1aSMatthew Knepley {
3262ea844a1aSMatthew Knepley   PetscFunctionBegin;
3263ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,1);
32642c71b3e2SJacob Faibussowitsch   PetscCheckFalse(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);
32659566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetPointSyms(section->field[field],numPoints,points,perms,rots));
3266ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3267ea844a1aSMatthew Knepley }
3268ea844a1aSMatthew Knepley 
3269ea844a1aSMatthew Knepley /*@C
3270ea844a1aSMatthew Knepley   PetscSectionRestoreFieldPointSyms - Restore the symmetries returned by PetscSectionGetFieldPointSyms()
3271ea844a1aSMatthew Knepley 
327240750d41SVaclav Hapla   Not Collective
3273ea844a1aSMatthew Knepley 
3274ea844a1aSMatthew Knepley   Input Parameters:
3275ea844a1aSMatthew Knepley + section - the section
3276ea844a1aSMatthew Knepley . field - the field number
3277ea844a1aSMatthew Knepley . numPoints - the number of points
3278ea844a1aSMatthew Knepley - points - an array of size 2 * numPoints, containing a list of (point, orientation) pairs. (An orientation is an
3279ea844a1aSMatthew Knepley     arbitrary integer: its interpretation is up to sym.  Orientations are used by DM: for their interpretation in that
3280ea844a1aSMatthew Knepley     context, see DMPlexGetConeOrientation()).
3281ea844a1aSMatthew Knepley 
3282d8d19677SJose E. Roman   Output Parameters:
3283ea844a1aSMatthew Knepley + perms - The permutations for the given orientations: set to NULL at conclusion
3284ea844a1aSMatthew Knepley - rots - The field rotations symmetries for the given orientations: set to NULL at conclusion
3285ea844a1aSMatthew Knepley 
3286ea844a1aSMatthew Knepley   Level: developer
3287ea844a1aSMatthew Knepley 
3288ea844a1aSMatthew Knepley .seealso: PetscSectionRestorePointSyms(), petscSectionGetFieldPointSyms(), PetscSectionSymCreate(), PetscSectionSetSym(), PetscSectionGetSym()
3289ea844a1aSMatthew Knepley @*/
3290ea844a1aSMatthew Knepley PetscErrorCode PetscSectionRestoreFieldPointSyms(PetscSection section, PetscInt field, PetscInt numPoints, const PetscInt *points, const PetscInt ***perms, const PetscScalar ***rots)
3291ea844a1aSMatthew Knepley {
3292ea844a1aSMatthew Knepley   PetscFunctionBegin;
3293ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,1);
32942c71b3e2SJacob Faibussowitsch   PetscCheckFalse(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);
32959566063dSJacob Faibussowitsch   PetscCall(PetscSectionRestorePointSyms(section->field[field],numPoints,points,perms,rots));
3296ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3297ea844a1aSMatthew Knepley }
3298ea844a1aSMatthew Knepley 
3299ea844a1aSMatthew Knepley /*@
3300b004864fSMatthew G. Knepley   PetscSectionSymCopy - Copy the symmetries, assuming that the point structure is compatible
3301b004864fSMatthew G. Knepley 
330240750d41SVaclav Hapla   Not Collective
3303b004864fSMatthew G. Knepley 
3304b004864fSMatthew G. Knepley   Input Parameter:
3305b004864fSMatthew G. Knepley . sym - the PetscSectionSym
3306b004864fSMatthew G. Knepley 
3307b004864fSMatthew G. Knepley   Output Parameter:
3308b004864fSMatthew G. Knepley . nsym - the equivalent symmetries
3309b004864fSMatthew G. Knepley 
3310b004864fSMatthew G. Knepley   Level: developer
3311b004864fSMatthew G. Knepley 
3312b004864fSMatthew G. Knepley .seealso: PetscSectionSymCreate(), PetscSectionSetSym(), PetscSectionGetSym(), PetscSectionSymLabelSetStratum(), PetscSectionGetPointSyms()
3313b004864fSMatthew G. Knepley @*/
3314b004864fSMatthew G. Knepley PetscErrorCode PetscSectionSymCopy(PetscSectionSym sym, PetscSectionSym nsym)
3315b004864fSMatthew G. Knepley {
3316b004864fSMatthew G. Knepley   PetscFunctionBegin;
3317b004864fSMatthew G. Knepley   PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID, 1);
3318b004864fSMatthew G. Knepley   PetscValidHeaderSpecific(nsym, PETSC_SECTION_SYM_CLASSID, 2);
33199566063dSJacob Faibussowitsch   if (sym->ops->copy) PetscCall((*sym->ops->copy)(sym, nsym));
3320b004864fSMatthew G. Knepley   PetscFunctionReturn(0);
3321b004864fSMatthew G. Knepley }
3322b004864fSMatthew G. Knepley 
3323b004864fSMatthew G. Knepley /*@
3324b004864fSMatthew G. Knepley   PetscSectionSymDistribute - Distribute the symmetries in accordance with the input SF
3325b004864fSMatthew G. Knepley 
3326b004864fSMatthew G. Knepley   Collective
3327b004864fSMatthew G. Knepley 
3328b004864fSMatthew G. Knepley   Input Parameters:
3329b004864fSMatthew G. Knepley + sym - the PetscSectionSym
3330b004864fSMatthew G. Knepley - migrationSF - the distribution map from roots to leaves
3331b004864fSMatthew G. Knepley 
3332b004864fSMatthew G. Knepley   Output Parameters:
3333b004864fSMatthew G. Knepley . dsym - the redistributed symmetries
3334b004864fSMatthew G. Knepley 
3335b004864fSMatthew G. Knepley   Level: developer
3336b004864fSMatthew G. Knepley 
3337b004864fSMatthew G. Knepley .seealso: PetscSectionSymCreate(), PetscSectionSetSym(), PetscSectionGetSym(), PetscSectionSymLabelSetStratum(), PetscSectionGetPointSyms()
3338b004864fSMatthew G. Knepley @*/
3339b004864fSMatthew G. Knepley PetscErrorCode PetscSectionSymDistribute(PetscSectionSym sym, PetscSF migrationSF, PetscSectionSym *dsym)
3340b004864fSMatthew G. Knepley {
3341b004864fSMatthew G. Knepley   PetscFunctionBegin;
3342b004864fSMatthew G. Knepley   PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID, 1);
3343b004864fSMatthew G. Knepley   PetscValidHeaderSpecific(migrationSF, PETSCSF_CLASSID, 2);
3344b004864fSMatthew G. Knepley   PetscValidPointer(dsym, 3);
33459566063dSJacob Faibussowitsch   if (sym->ops->distribute) PetscCall((*sym->ops->distribute)(sym, migrationSF, dsym));
3346b004864fSMatthew G. Knepley   PetscFunctionReturn(0);
3347b004864fSMatthew G. Knepley }
3348b004864fSMatthew G. Knepley 
3349b004864fSMatthew G. Knepley /*@
3350ea844a1aSMatthew Knepley   PetscSectionGetUseFieldOffsets - Get the flag to use field offsets directly in a global section, rather than just the point offset
3351ea844a1aSMatthew Knepley 
335240750d41SVaclav Hapla   Not Collective
3353ea844a1aSMatthew Knepley 
3354ea844a1aSMatthew Knepley   Input Parameter:
3355ea844a1aSMatthew Knepley . s - the global PetscSection
3356ea844a1aSMatthew Knepley 
3357ea844a1aSMatthew Knepley   Output Parameters:
3358ea844a1aSMatthew Knepley . flg - the flag
3359ea844a1aSMatthew Knepley 
3360ea844a1aSMatthew Knepley   Level: developer
3361ea844a1aSMatthew Knepley 
3362ea844a1aSMatthew Knepley .seealso: PetscSectionSetChart(), PetscSectionCreate()
3363ea844a1aSMatthew Knepley @*/
3364ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetUseFieldOffsets(PetscSection s, PetscBool *flg)
3365ea844a1aSMatthew Knepley {
3366ea844a1aSMatthew Knepley   PetscFunctionBegin;
3367ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
3368ea844a1aSMatthew Knepley   *flg = s->useFieldOff;
3369ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3370ea844a1aSMatthew Knepley }
3371ea844a1aSMatthew Knepley 
3372ea844a1aSMatthew Knepley /*@
3373ea844a1aSMatthew Knepley   PetscSectionSetUseFieldOffsets - Set the flag to use field offsets directly in a global section, rather than just the point offset
3374ea844a1aSMatthew Knepley 
337540750d41SVaclav Hapla   Not Collective
3376ea844a1aSMatthew Knepley 
3377ea844a1aSMatthew Knepley   Input Parameters:
3378ea844a1aSMatthew Knepley + s   - the global PetscSection
3379ea844a1aSMatthew Knepley - flg - the flag
3380ea844a1aSMatthew Knepley 
3381ea844a1aSMatthew Knepley   Level: developer
3382ea844a1aSMatthew Knepley 
3383ea844a1aSMatthew Knepley .seealso: PetscSectionGetUseFieldOffsets(), PetscSectionSetChart(), PetscSectionCreate()
3384ea844a1aSMatthew Knepley @*/
3385ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetUseFieldOffsets(PetscSection s, PetscBool flg)
3386ea844a1aSMatthew Knepley {
3387ea844a1aSMatthew Knepley   PetscFunctionBegin;
3388ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
3389ea844a1aSMatthew Knepley   s->useFieldOff = flg;
3390ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3391ea844a1aSMatthew Knepley }
3392ea844a1aSMatthew Knepley 
3393ea844a1aSMatthew Knepley #define PetscSectionExpandPoints_Loop(TYPE) \
3394ea844a1aSMatthew Knepley { \
3395ea844a1aSMatthew Knepley   PetscInt i, n, o0, o1, size; \
3396ea844a1aSMatthew Knepley   TYPE *a0 = (TYPE*)origArray, *a1; \
33979566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetStorageSize(s, &size)); \
33989566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(size, &a1)); \
3399ea844a1aSMatthew Knepley   for (i=0; i<npoints; i++) { \
34009566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(origSection, points_[i], &o0)); \
34019566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(s, i, &o1)); \
34029566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s, i, &n)); \
34039566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(&a1[o1], &a0[o0], n*unitsize)); \
3404ea844a1aSMatthew Knepley   } \
3405ea844a1aSMatthew Knepley   *newArray = (void*)a1; \
3406ea844a1aSMatthew Knepley }
3407ea844a1aSMatthew Knepley 
3408ea844a1aSMatthew Knepley /*@
3409ea844a1aSMatthew Knepley   PetscSectionExtractDofsFromArray - Extracts elements of an array corresponding to DOFs of specified points.
3410ea844a1aSMatthew Knepley 
341140750d41SVaclav Hapla   Not Collective
3412ea844a1aSMatthew Knepley 
3413ea844a1aSMatthew Knepley   Input Parameters:
3414ea844a1aSMatthew Knepley + origSection - the PetscSection describing the layout of the array
3415ea844a1aSMatthew Knepley . dataType - MPI_Datatype describing the data type of the array (currently only MPIU_INT, MPIU_SCALAR, MPIU_REAL)
3416ea844a1aSMatthew Knepley . origArray - the array; its size must be equal to the storage size of origSection
3417ea844a1aSMatthew Knepley - points - IS with points to extract; its indices must lie in the chart of origSection
3418ea844a1aSMatthew Knepley 
3419ea844a1aSMatthew Knepley   Output Parameters:
3420ea844a1aSMatthew Knepley + newSection - the new PetscSection desribing the layout of the new array (with points renumbered 0,1,... but preserving numbers of DOFs)
3421ea844a1aSMatthew Knepley - newArray - the array of the extracted DOFs; its size is the storage size of newSection
3422ea844a1aSMatthew Knepley 
3423ea844a1aSMatthew Knepley   Level: developer
3424ea844a1aSMatthew Knepley 
3425ea844a1aSMatthew Knepley .seealso: PetscSectionGetChart(), PetscSectionGetDof(), PetscSectionGetStorageSize(), PetscSectionCreate()
3426ea844a1aSMatthew Knepley @*/
3427ea844a1aSMatthew Knepley PetscErrorCode PetscSectionExtractDofsFromArray(PetscSection origSection, MPI_Datatype dataType, const void *origArray, IS points, PetscSection *newSection, void *newArray[])
3428ea844a1aSMatthew Knepley {
3429ea844a1aSMatthew Knepley   PetscSection        s;
3430ea844a1aSMatthew Knepley   const PetscInt      *points_;
3431ea844a1aSMatthew Knepley   PetscInt            i, n, npoints, pStart, pEnd;
3432ea844a1aSMatthew Knepley   PetscMPIInt         unitsize;
3433ea844a1aSMatthew Knepley 
3434ea844a1aSMatthew Knepley   PetscFunctionBegin;
3435ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(origSection, PETSC_SECTION_CLASSID, 1);
3436ea844a1aSMatthew Knepley   PetscValidPointer(origArray, 3);
3437ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(points, IS_CLASSID, 4);
3438ea844a1aSMatthew Knepley   if (newSection) PetscValidPointer(newSection, 5);
3439ea844a1aSMatthew Knepley   if (newArray) PetscValidPointer(newArray, 6);
34409566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Type_size(dataType, &unitsize));
34419566063dSJacob Faibussowitsch   PetscCall(ISGetLocalSize(points, &npoints));
34429566063dSJacob Faibussowitsch   PetscCall(ISGetIndices(points, &points_));
34439566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(origSection, &pStart, &pEnd));
34449566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PETSC_COMM_SELF, &s));
34459566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(s, 0, npoints));
3446ea844a1aSMatthew Knepley   for (i=0; i<npoints; i++) {
34472c71b3e2SJacob Faibussowitsch     PetscCheckFalse(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);
34489566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(origSection, points_[i], &n));
34499566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(s, i, n));
3450ea844a1aSMatthew Knepley   }
34519566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(s));
3452ea844a1aSMatthew Knepley   if (newArray) {
3453ea844a1aSMatthew Knepley     if (dataType == MPIU_INT)           {PetscSectionExpandPoints_Loop(PetscInt);}
3454ea844a1aSMatthew Knepley     else if (dataType == MPIU_SCALAR)   {PetscSectionExpandPoints_Loop(PetscScalar);}
3455ea844a1aSMatthew Knepley     else if (dataType == MPIU_REAL)     {PetscSectionExpandPoints_Loop(PetscReal);}
3456ea844a1aSMatthew Knepley     else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP, "not implemented for this MPI_Datatype");
3457ea844a1aSMatthew Knepley   }
3458ea844a1aSMatthew Knepley   if (newSection) {
3459ea844a1aSMatthew Knepley     *newSection = s;
3460ea844a1aSMatthew Knepley   } else {
34619566063dSJacob Faibussowitsch     PetscCall(PetscSectionDestroy(&s));
3462ea844a1aSMatthew Knepley   }
34639566063dSJacob Faibussowitsch   PetscCall(ISRestoreIndices(points, &points_));
3464ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3465ea844a1aSMatthew Knepley }
3466