xref: /petsc/src/vec/is/section/interface/section.c (revision 1c2dc1cbabe5212f80cf309c4ca5a26f0cadc660)
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)->atlasDof            = NULL;
50ea844a1aSMatthew Knepley   (*s)->atlasOff            = NULL;
51ea844a1aSMatthew Knepley   (*s)->bc                  = NULL;
52ea844a1aSMatthew Knepley   (*s)->bcIndices           = NULL;
53ea844a1aSMatthew Knepley   (*s)->setup               = PETSC_FALSE;
54ea844a1aSMatthew Knepley   (*s)->numFields           = 0;
55ea844a1aSMatthew Knepley   (*s)->fieldNames          = NULL;
56ea844a1aSMatthew Knepley   (*s)->field               = NULL;
57ea844a1aSMatthew Knepley   (*s)->useFieldOff         = PETSC_FALSE;
58b778fa18SValeria Barra   (*s)->compNames           = NULL;
59ea844a1aSMatthew Knepley   (*s)->clObj               = NULL;
60c459fbc1SJed Brown   (*s)->clHash              = NULL;
61ea844a1aSMatthew Knepley   (*s)->clSection           = NULL;
62ea844a1aSMatthew Knepley   (*s)->clPoints            = NULL;
6369c11d05SVaclav Hapla   PetscCall(PetscSectionInvalidateMaxDof_Internal(*s));
64ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
65ea844a1aSMatthew Knepley }
66ea844a1aSMatthew Knepley 
67ea844a1aSMatthew Knepley /*@
68ea844a1aSMatthew Knepley   PetscSectionCopy - Creates a shallow (if possible) copy of the PetscSection
69ea844a1aSMatthew Knepley 
70ea844a1aSMatthew Knepley   Collective
71ea844a1aSMatthew Knepley 
72ea844a1aSMatthew Knepley   Input Parameter:
73ea844a1aSMatthew Knepley . section - the PetscSection
74ea844a1aSMatthew Knepley 
75ea844a1aSMatthew Knepley   Output Parameter:
76ea844a1aSMatthew Knepley . newSection - the copy
77ea844a1aSMatthew Knepley 
78ea844a1aSMatthew Knepley   Level: intermediate
79ea844a1aSMatthew Knepley 
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:
310*1c2dc1cbSBarry Smith   PetscCall(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;
80369c11d05SVaclav Hapla   PetscCall(PetscSectionInvalidateMaxDof_Internal(s));
804ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
805ea844a1aSMatthew Knepley }
806ea844a1aSMatthew Knepley 
807ea844a1aSMatthew Knepley /*@
808ea844a1aSMatthew Knepley   PetscSectionAddDof - Adds to the number of degrees of freedom associated with a given point.
809ea844a1aSMatthew Knepley 
81040750d41SVaclav Hapla   Not Collective
811ea844a1aSMatthew Knepley 
812ea844a1aSMatthew Knepley   Input Parameters:
813ea844a1aSMatthew Knepley + s - the PetscSection
814ea844a1aSMatthew Knepley . point - the point
815ea844a1aSMatthew Knepley - numDof - the number of additional dof
816ea844a1aSMatthew Knepley 
817ea844a1aSMatthew Knepley   Level: intermediate
818ea844a1aSMatthew Knepley 
819ea844a1aSMatthew Knepley .seealso: PetscSectionGetDof(), PetscSectionSetDof(), PetscSectionCreate()
820ea844a1aSMatthew Knepley @*/
821ea844a1aSMatthew Knepley PetscErrorCode PetscSectionAddDof(PetscSection s, PetscInt point, PetscInt numDof)
822ea844a1aSMatthew Knepley {
82376bd3646SJed Brown   PetscFunctionBeginHot;
824ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
825c8bf3acbSVaclav 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);
826ea844a1aSMatthew Knepley   s->atlasDof[point - s->pStart] += numDof;
82769c11d05SVaclav Hapla   PetscCall(PetscSectionInvalidateMaxDof_Internal(s));
828ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
829ea844a1aSMatthew Knepley }
830ea844a1aSMatthew Knepley 
831ea844a1aSMatthew Knepley /*@
832ea844a1aSMatthew Knepley   PetscSectionGetFieldDof - Return the number of degrees of freedom associated with a field on a given point.
833ea844a1aSMatthew Knepley 
83440750d41SVaclav Hapla   Not Collective
835ea844a1aSMatthew Knepley 
836ea844a1aSMatthew Knepley   Input Parameters:
837ea844a1aSMatthew Knepley + s - the PetscSection
838ea844a1aSMatthew Knepley . point - the point
839ea844a1aSMatthew Knepley - field - the field
840ea844a1aSMatthew Knepley 
841ea844a1aSMatthew Knepley   Output Parameter:
842ea844a1aSMatthew Knepley . numDof - the number of dof
843ea844a1aSMatthew Knepley 
844ea844a1aSMatthew Knepley   Level: intermediate
845ea844a1aSMatthew Knepley 
846ea844a1aSMatthew Knepley .seealso: PetscSectionSetFieldDof(), PetscSectionCreate()
847ea844a1aSMatthew Knepley @*/
848ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetFieldDof(PetscSection s, PetscInt point, PetscInt field, PetscInt *numDof)
849ea844a1aSMatthew Knepley {
850ea844a1aSMatthew Knepley   PetscFunctionBegin;
851ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
8522abc8c78SJacob Faibussowitsch   PetscValidIntPointer(numDof,4);
8532abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
8549566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetDof(s->field[field], point, numDof));
855ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
856ea844a1aSMatthew Knepley }
857ea844a1aSMatthew Knepley 
858ea844a1aSMatthew Knepley /*@
859ea844a1aSMatthew Knepley   PetscSectionSetFieldDof - Sets the number of degrees of freedom associated with a field on a given point.
860ea844a1aSMatthew Knepley 
86140750d41SVaclav Hapla   Not Collective
862ea844a1aSMatthew Knepley 
863ea844a1aSMatthew Knepley   Input Parameters:
864ea844a1aSMatthew Knepley + s - the PetscSection
865ea844a1aSMatthew Knepley . point - the point
866ea844a1aSMatthew Knepley . field - the field
867ea844a1aSMatthew Knepley - numDof - the number of dof
868ea844a1aSMatthew Knepley 
869ea844a1aSMatthew Knepley   Level: intermediate
870ea844a1aSMatthew Knepley 
871ea844a1aSMatthew Knepley .seealso: PetscSectionGetFieldDof(), PetscSectionCreate()
872ea844a1aSMatthew Knepley @*/
873ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetFieldDof(PetscSection s, PetscInt point, PetscInt field, PetscInt numDof)
874ea844a1aSMatthew Knepley {
875ea844a1aSMatthew Knepley   PetscFunctionBegin;
876ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
8772abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
8789566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetDof(s->field[field], point, numDof));
879ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
880ea844a1aSMatthew Knepley }
881ea844a1aSMatthew Knepley 
882ea844a1aSMatthew Knepley /*@
883ea844a1aSMatthew Knepley   PetscSectionAddFieldDof - Adds a number of degrees of freedom associated with a field on a given point.
884ea844a1aSMatthew Knepley 
88540750d41SVaclav Hapla   Not Collective
886ea844a1aSMatthew Knepley 
887ea844a1aSMatthew Knepley   Input Parameters:
888ea844a1aSMatthew Knepley + s - the PetscSection
889ea844a1aSMatthew Knepley . point - the point
890ea844a1aSMatthew Knepley . field - the field
891ea844a1aSMatthew Knepley - numDof - the number of dof
892ea844a1aSMatthew Knepley 
893ea844a1aSMatthew Knepley   Level: intermediate
894ea844a1aSMatthew Knepley 
895ea844a1aSMatthew Knepley .seealso: PetscSectionSetFieldDof(), PetscSectionGetFieldDof(), PetscSectionCreate()
896ea844a1aSMatthew Knepley @*/
897ea844a1aSMatthew Knepley PetscErrorCode PetscSectionAddFieldDof(PetscSection s, PetscInt point, PetscInt field, PetscInt numDof)
898ea844a1aSMatthew Knepley {
899ea844a1aSMatthew Knepley   PetscFunctionBegin;
900ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
9012abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
9029566063dSJacob Faibussowitsch   PetscCall(PetscSectionAddDof(s->field[field], point, numDof));
903ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
904ea844a1aSMatthew Knepley }
905ea844a1aSMatthew Knepley 
906ea844a1aSMatthew Knepley /*@
907ea844a1aSMatthew Knepley   PetscSectionGetConstraintDof - Return the number of constrained degrees of freedom associated with a given point.
908ea844a1aSMatthew Knepley 
90940750d41SVaclav Hapla   Not Collective
910ea844a1aSMatthew Knepley 
911ea844a1aSMatthew Knepley   Input Parameters:
912ea844a1aSMatthew Knepley + s - the PetscSection
913ea844a1aSMatthew Knepley - point - the point
914ea844a1aSMatthew Knepley 
915ea844a1aSMatthew Knepley   Output Parameter:
916ea844a1aSMatthew Knepley . numDof - the number of dof which are fixed by constraints
917ea844a1aSMatthew Knepley 
918ea844a1aSMatthew Knepley   Level: intermediate
919ea844a1aSMatthew Knepley 
920ea844a1aSMatthew Knepley .seealso: PetscSectionGetDof(), PetscSectionSetConstraintDof(), PetscSectionCreate()
921ea844a1aSMatthew Knepley @*/
922ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetConstraintDof(PetscSection s, PetscInt point, PetscInt *numDof)
923ea844a1aSMatthew Knepley {
924ea844a1aSMatthew Knepley   PetscFunctionBegin;
925ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
926dadcf809SJacob Faibussowitsch   PetscValidIntPointer(numDof, 3);
927ea844a1aSMatthew Knepley   if (s->bc) {
9289566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s->bc, point, numDof));
929ea844a1aSMatthew Knepley   } else *numDof = 0;
930ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
931ea844a1aSMatthew Knepley }
932ea844a1aSMatthew Knepley 
933ea844a1aSMatthew Knepley /*@
934ea844a1aSMatthew Knepley   PetscSectionSetConstraintDof - Set the number of constrained degrees of freedom associated with a given point.
935ea844a1aSMatthew Knepley 
93640750d41SVaclav Hapla   Not Collective
937ea844a1aSMatthew Knepley 
938ea844a1aSMatthew Knepley   Input Parameters:
939ea844a1aSMatthew Knepley + s - the PetscSection
940ea844a1aSMatthew Knepley . point - the point
941ea844a1aSMatthew Knepley - numDof - the number of dof which are fixed by constraints
942ea844a1aSMatthew Knepley 
943ea844a1aSMatthew Knepley   Level: intermediate
944ea844a1aSMatthew Knepley 
945ea844a1aSMatthew Knepley .seealso: PetscSectionSetDof(), PetscSectionGetConstraintDof(), PetscSectionCreate()
946ea844a1aSMatthew Knepley @*/
947ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetConstraintDof(PetscSection s, PetscInt point, PetscInt numDof)
948ea844a1aSMatthew Knepley {
949ea844a1aSMatthew Knepley   PetscFunctionBegin;
950ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
951ea844a1aSMatthew Knepley   if (numDof) {
9527c0883d5SVaclav Hapla     PetscCall(PetscSectionCheckConstraints_Private(s));
9539566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(s->bc, point, numDof));
954ea844a1aSMatthew Knepley   }
955ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
956ea844a1aSMatthew Knepley }
957ea844a1aSMatthew Knepley 
958ea844a1aSMatthew Knepley /*@
959ea844a1aSMatthew Knepley   PetscSectionAddConstraintDof - Increment the number of constrained degrees of freedom associated with a given point.
960ea844a1aSMatthew Knepley 
96140750d41SVaclav Hapla   Not Collective
962ea844a1aSMatthew Knepley 
963ea844a1aSMatthew Knepley   Input Parameters:
964ea844a1aSMatthew Knepley + s - the PetscSection
965ea844a1aSMatthew Knepley . point - the point
966ea844a1aSMatthew Knepley - numDof - the number of additional dof which are fixed by constraints
967ea844a1aSMatthew Knepley 
968ea844a1aSMatthew Knepley   Level: intermediate
969ea844a1aSMatthew Knepley 
970ea844a1aSMatthew Knepley .seealso: PetscSectionAddDof(), PetscSectionGetConstraintDof(), PetscSectionCreate()
971ea844a1aSMatthew Knepley @*/
972ea844a1aSMatthew Knepley PetscErrorCode PetscSectionAddConstraintDof(PetscSection s, PetscInt point, PetscInt numDof)
973ea844a1aSMatthew Knepley {
974ea844a1aSMatthew Knepley   PetscFunctionBegin;
975ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
976ea844a1aSMatthew Knepley   if (numDof) {
9777c0883d5SVaclav Hapla     PetscCall(PetscSectionCheckConstraints_Private(s));
9789566063dSJacob Faibussowitsch     PetscCall(PetscSectionAddDof(s->bc, point, numDof));
979ea844a1aSMatthew Knepley   }
980ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
981ea844a1aSMatthew Knepley }
982ea844a1aSMatthew Knepley 
983ea844a1aSMatthew Knepley /*@
984ea844a1aSMatthew Knepley   PetscSectionGetFieldConstraintDof - Return the number of constrained degrees of freedom associated with a given field on a point.
985ea844a1aSMatthew Knepley 
98640750d41SVaclav Hapla   Not Collective
987ea844a1aSMatthew Knepley 
988ea844a1aSMatthew Knepley   Input Parameters:
989ea844a1aSMatthew Knepley + s - the PetscSection
990ea844a1aSMatthew Knepley . point - the point
991ea844a1aSMatthew Knepley - field - the field
992ea844a1aSMatthew Knepley 
993ea844a1aSMatthew Knepley   Output Parameter:
994ea844a1aSMatthew Knepley . numDof - the number of dof which are fixed by constraints
995ea844a1aSMatthew Knepley 
996ea844a1aSMatthew Knepley   Level: intermediate
997ea844a1aSMatthew Knepley 
998ea844a1aSMatthew Knepley .seealso: PetscSectionGetDof(), PetscSectionSetFieldConstraintDof(), PetscSectionCreate()
999ea844a1aSMatthew Knepley @*/
1000ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetFieldConstraintDof(PetscSection s, PetscInt point, PetscInt field, PetscInt *numDof)
1001ea844a1aSMatthew Knepley {
1002ea844a1aSMatthew Knepley   PetscFunctionBegin;
1003ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
10042abc8c78SJacob Faibussowitsch   PetscValidIntPointer(numDof, 4);
10052abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
10069566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstraintDof(s->field[field], point, numDof));
1007ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1008ea844a1aSMatthew Knepley }
1009ea844a1aSMatthew Knepley 
1010ea844a1aSMatthew Knepley /*@
1011ea844a1aSMatthew Knepley   PetscSectionSetFieldConstraintDof - Set the number of constrained degrees of freedom associated with a given field on a point.
1012ea844a1aSMatthew Knepley 
101340750d41SVaclav Hapla   Not Collective
1014ea844a1aSMatthew Knepley 
1015ea844a1aSMatthew Knepley   Input Parameters:
1016ea844a1aSMatthew Knepley + s - the PetscSection
1017ea844a1aSMatthew Knepley . point - the point
1018ea844a1aSMatthew Knepley . field - the field
1019ea844a1aSMatthew Knepley - numDof - the number of dof which are fixed by constraints
1020ea844a1aSMatthew Knepley 
1021ea844a1aSMatthew Knepley   Level: intermediate
1022ea844a1aSMatthew Knepley 
1023ea844a1aSMatthew Knepley .seealso: PetscSectionSetDof(), PetscSectionGetFieldConstraintDof(), PetscSectionCreate()
1024ea844a1aSMatthew Knepley @*/
1025ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetFieldConstraintDof(PetscSection s, PetscInt point, PetscInt field, PetscInt numDof)
1026ea844a1aSMatthew Knepley {
1027ea844a1aSMatthew Knepley   PetscFunctionBegin;
1028ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
10292abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
10309566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetConstraintDof(s->field[field], point, numDof));
1031ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1032ea844a1aSMatthew Knepley }
1033ea844a1aSMatthew Knepley 
1034ea844a1aSMatthew Knepley /*@
1035ea844a1aSMatthew Knepley   PetscSectionAddFieldConstraintDof - Increment the number of constrained degrees of freedom associated with a given field on a point.
1036ea844a1aSMatthew Knepley 
103740750d41SVaclav Hapla   Not Collective
1038ea844a1aSMatthew Knepley 
1039ea844a1aSMatthew Knepley   Input Parameters:
1040ea844a1aSMatthew Knepley + s - the PetscSection
1041ea844a1aSMatthew Knepley . point - the point
1042ea844a1aSMatthew Knepley . field - the field
1043ea844a1aSMatthew Knepley - numDof - the number of additional dof which are fixed by constraints
1044ea844a1aSMatthew Knepley 
1045ea844a1aSMatthew Knepley   Level: intermediate
1046ea844a1aSMatthew Knepley 
1047ea844a1aSMatthew Knepley .seealso: PetscSectionAddDof(), PetscSectionGetFieldConstraintDof(), PetscSectionCreate()
1048ea844a1aSMatthew Knepley @*/
1049ea844a1aSMatthew Knepley PetscErrorCode PetscSectionAddFieldConstraintDof(PetscSection s, PetscInt point, PetscInt field, PetscInt numDof)
1050ea844a1aSMatthew Knepley {
1051ea844a1aSMatthew Knepley   PetscFunctionBegin;
1052ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
10532abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
10549566063dSJacob Faibussowitsch   PetscCall(PetscSectionAddConstraintDof(s->field[field], point, numDof));
1055ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1056ea844a1aSMatthew Knepley }
1057ea844a1aSMatthew Knepley 
1058ea844a1aSMatthew Knepley /*@
1059ea844a1aSMatthew Knepley   PetscSectionSetUpBC - Setup the subsections describing boundary conditions.
1060ea844a1aSMatthew Knepley 
106140750d41SVaclav Hapla   Not Collective
1062ea844a1aSMatthew Knepley 
1063ea844a1aSMatthew Knepley   Input Parameter:
1064ea844a1aSMatthew Knepley . s - the PetscSection
1065ea844a1aSMatthew Knepley 
1066ea844a1aSMatthew Knepley   Level: advanced
1067ea844a1aSMatthew Knepley 
1068ea844a1aSMatthew Knepley .seealso: PetscSectionSetUp(), PetscSectionCreate()
1069ea844a1aSMatthew Knepley @*/
1070ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetUpBC(PetscSection s)
1071ea844a1aSMatthew Knepley {
1072ea844a1aSMatthew Knepley   PetscFunctionBegin;
1073ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1074ea844a1aSMatthew Knepley   if (s->bc) {
1075ea844a1aSMatthew Knepley     const PetscInt last = (s->bc->pEnd-s->bc->pStart) - 1;
1076ea844a1aSMatthew Knepley 
10779566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetUp(s->bc));
10789566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(last >= 0 ? s->bc->atlasOff[last] + s->bc->atlasDof[last] : 0, &s->bcIndices));
1079ea844a1aSMatthew Knepley   }
1080ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1081ea844a1aSMatthew Knepley }
1082ea844a1aSMatthew Knepley 
1083ea844a1aSMatthew Knepley /*@
1084ea844a1aSMatthew Knepley   PetscSectionSetUp - Calculate offsets based upon the number of degrees of freedom for each point.
1085ea844a1aSMatthew Knepley 
108640750d41SVaclav Hapla   Not Collective
1087ea844a1aSMatthew Knepley 
1088ea844a1aSMatthew Knepley   Input Parameter:
1089ea844a1aSMatthew Knepley . s - the PetscSection
1090ea844a1aSMatthew Knepley 
1091ea844a1aSMatthew Knepley   Level: intermediate
1092ea844a1aSMatthew Knepley 
1093ea844a1aSMatthew Knepley .seealso: PetscSectionCreate()
1094ea844a1aSMatthew Knepley @*/
1095ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetUp(PetscSection s)
1096ea844a1aSMatthew Knepley {
1097ea844a1aSMatthew Knepley   const PetscInt *pind   = NULL;
1098ea844a1aSMatthew Knepley   PetscInt        offset = 0, foff, p, f;
1099ea844a1aSMatthew Knepley 
1100ea844a1aSMatthew Knepley   PetscFunctionBegin;
1101ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1102ea844a1aSMatthew Knepley   if (s->setup) PetscFunctionReturn(0);
1103ea844a1aSMatthew Knepley   s->setup = PETSC_TRUE;
1104ea844a1aSMatthew Knepley   /* Set offsets and field offsets for all points */
1105ea844a1aSMatthew Knepley   /*   Assume that all fields have the same chart */
110628b400f6SJacob Faibussowitsch   PetscCheck(s->includesConstraints,PETSC_COMM_SELF,PETSC_ERR_SUP,"PetscSectionSetUp is currently unsupported for includesConstraints = PETSC_TRUE");
11079566063dSJacob Faibussowitsch   if (s->perm) PetscCall(ISGetIndices(s->perm, &pind));
1108ea844a1aSMatthew Knepley   if (s->pointMajor) {
1109ea844a1aSMatthew Knepley     for (p = 0; p < s->pEnd - s->pStart; ++p) {
1110ea844a1aSMatthew Knepley       const PetscInt q = pind ? pind[p] : p;
1111ea844a1aSMatthew Knepley 
1112ea844a1aSMatthew Knepley       /* Set point offset */
1113ea844a1aSMatthew Knepley       s->atlasOff[q] = offset;
1114ea844a1aSMatthew Knepley       offset        += s->atlasDof[q];
1115ea844a1aSMatthew Knepley       /* Set field offset */
1116ea844a1aSMatthew Knepley       for (f = 0, foff = s->atlasOff[q]; f < s->numFields; ++f) {
1117ea844a1aSMatthew Knepley         PetscSection sf = s->field[f];
1118ea844a1aSMatthew Knepley 
1119ea844a1aSMatthew Knepley         sf->atlasOff[q] = foff;
1120ea844a1aSMatthew Knepley         foff += sf->atlasDof[q];
1121ea844a1aSMatthew Knepley       }
1122ea844a1aSMatthew Knepley     }
1123ea844a1aSMatthew Knepley   } else {
1124ea844a1aSMatthew Knepley     /* Set field offsets for all points */
1125ea844a1aSMatthew Knepley     for (f = 0; f < s->numFields; ++f) {
1126ea844a1aSMatthew Knepley       PetscSection sf = s->field[f];
1127ea844a1aSMatthew Knepley 
1128ea844a1aSMatthew Knepley       for (p = 0; p < s->pEnd - s->pStart; ++p) {
1129ea844a1aSMatthew Knepley         const PetscInt q = pind ? pind[p] : p;
1130ea844a1aSMatthew Knepley 
1131ea844a1aSMatthew Knepley         sf->atlasOff[q] = offset;
1132ea844a1aSMatthew Knepley         offset += sf->atlasDof[q];
1133ea844a1aSMatthew Knepley       }
1134ea844a1aSMatthew Knepley     }
1135ea844a1aSMatthew Knepley     /* Disable point offsets since these are unused */
1136ea844a1aSMatthew Knepley     for (p = 0; p < s->pEnd - s->pStart; ++p) {
1137ea844a1aSMatthew Knepley       s->atlasOff[p] = -1;
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 
116069c11d05SVaclav Hapla   Notes:
116169c11d05SVaclav Hapla   The returned number is up-to-date without need for PetscSectionSetUp().
116269c11d05SVaclav Hapla 
116369c11d05SVaclav Hapla   Developer Notes:
116469c11d05SVaclav Hapla   The returned number is calculated lazily and stashed.
116569c11d05SVaclav Hapla   A call to PetscSectionInvalidateMaxDof_Internal() invalidates the stashed value.
116669c11d05SVaclav Hapla   PetscSectionInvalidateMaxDof_Internal() is called in PetscSectionSetDof(), PetscSectionAddDof() and PetscSectionReset().
116769c11d05SVaclav Hapla   It should also be called every time atlasDof is modified directly.
116869c11d05SVaclav Hapla 
116969c11d05SVaclav Hapla .seealso: PetscSectionGetDof(), PetscSectionSetDof(), PetscSectionAddDof(), PetscSectionCreate()
1170ea844a1aSMatthew Knepley @*/
1171ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetMaxDof(PetscSection s, PetscInt *maxDof)
1172ea844a1aSMatthew Knepley {
117369c11d05SVaclav Hapla   PetscInt p;
117469c11d05SVaclav Hapla 
1175ea844a1aSMatthew Knepley   PetscFunctionBegin;
1176ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1177dadcf809SJacob Faibussowitsch   PetscValidIntPointer(maxDof, 2);
117869c11d05SVaclav Hapla   if (s->maxDof == PETSC_MIN_INT) {
117969c11d05SVaclav Hapla     s->maxDof = 0;
118069c11d05SVaclav Hapla     for (p = 0; p < s->pEnd - s->pStart; ++p) {
118169c11d05SVaclav Hapla       s->maxDof = PetscMax(s->maxDof, s->atlasDof[p]);
118269c11d05SVaclav Hapla     }
118369c11d05SVaclav Hapla   }
1184ea844a1aSMatthew Knepley   *maxDof = s->maxDof;
1185ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1186ea844a1aSMatthew Knepley }
1187ea844a1aSMatthew Knepley 
1188ea844a1aSMatthew Knepley /*@
1189ea844a1aSMatthew Knepley   PetscSectionGetStorageSize - Return the size of an array or local Vec capable of holding all the degrees of freedom.
1190ea844a1aSMatthew Knepley 
119140750d41SVaclav Hapla   Not Collective
1192ea844a1aSMatthew Knepley 
1193ea844a1aSMatthew Knepley   Input Parameter:
1194ea844a1aSMatthew Knepley . s - the PetscSection
1195ea844a1aSMatthew Knepley 
1196ea844a1aSMatthew Knepley   Output Parameter:
1197ea844a1aSMatthew Knepley . size - the size of an array which can hold all the dofs
1198ea844a1aSMatthew Knepley 
1199ea844a1aSMatthew Knepley   Level: intermediate
1200ea844a1aSMatthew Knepley 
1201ea844a1aSMatthew Knepley .seealso: PetscSectionGetOffset(), PetscSectionGetConstrainedStorageSize(), PetscSectionCreate()
1202ea844a1aSMatthew Knepley @*/
1203ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetStorageSize(PetscSection s, PetscInt *size)
1204ea844a1aSMatthew Knepley {
1205ea844a1aSMatthew Knepley   PetscInt p, n = 0;
1206ea844a1aSMatthew Knepley 
1207ea844a1aSMatthew Knepley   PetscFunctionBegin;
1208ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1209dadcf809SJacob Faibussowitsch   PetscValidIntPointer(size, 2);
1210ea844a1aSMatthew Knepley   for (p = 0; p < s->pEnd - s->pStart; ++p) n += s->atlasDof[p] > 0 ? s->atlasDof[p] : 0;
1211ea844a1aSMatthew Knepley   *size = n;
1212ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1213ea844a1aSMatthew Knepley }
1214ea844a1aSMatthew Knepley 
1215ea844a1aSMatthew Knepley /*@
1216ea844a1aSMatthew Knepley   PetscSectionGetConstrainedStorageSize - Return the size of an array or local Vec capable of holding all unconstrained degrees of freedom.
1217ea844a1aSMatthew Knepley 
121840750d41SVaclav Hapla   Not Collective
1219ea844a1aSMatthew Knepley 
1220064ec1f3Sprj-   Input Parameter:
1221064ec1f3Sprj- . s - the PetscSection
1222ea844a1aSMatthew Knepley 
1223ea844a1aSMatthew Knepley   Output Parameter:
1224ea844a1aSMatthew Knepley . size - the size of an array which can hold all unconstrained dofs
1225ea844a1aSMatthew Knepley 
1226ea844a1aSMatthew Knepley   Level: intermediate
1227ea844a1aSMatthew Knepley 
1228ea844a1aSMatthew Knepley .seealso: PetscSectionGetStorageSize(), PetscSectionGetOffset(), PetscSectionCreate()
1229ea844a1aSMatthew Knepley @*/
1230ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetConstrainedStorageSize(PetscSection s, PetscInt *size)
1231ea844a1aSMatthew Knepley {
1232ea844a1aSMatthew Knepley   PetscInt p, n = 0;
1233ea844a1aSMatthew Knepley 
1234ea844a1aSMatthew Knepley   PetscFunctionBegin;
1235ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1236dadcf809SJacob Faibussowitsch   PetscValidIntPointer(size, 2);
1237ea844a1aSMatthew Knepley   for (p = 0; p < s->pEnd - s->pStart; ++p) {
1238ea844a1aSMatthew Knepley     const PetscInt cdof = s->bc ? s->bc->atlasDof[p] : 0;
1239ea844a1aSMatthew Knepley     n += s->atlasDof[p] > 0 ? s->atlasDof[p] - cdof : 0;
1240ea844a1aSMatthew Knepley   }
1241ea844a1aSMatthew Knepley   *size = n;
1242ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1243ea844a1aSMatthew Knepley }
1244ea844a1aSMatthew Knepley 
1245ea844a1aSMatthew Knepley /*@
1246ea844a1aSMatthew Knepley   PetscSectionCreateGlobalSection - Create a section describing the global field layout using
1247ea844a1aSMatthew Knepley   the local section and an SF describing the section point overlap.
1248ea844a1aSMatthew Knepley 
1249ea844a1aSMatthew Knepley   Input Parameters:
1250ea844a1aSMatthew Knepley + s - The PetscSection for the local field layout
1251ea844a1aSMatthew Knepley . sf - The SF describing parallel layout of the section points (leaves are unowned local points)
1252ea844a1aSMatthew Knepley . includeConstraints - By default this is PETSC_FALSE, meaning that the global field vector will not possess constrained dofs
1253ea844a1aSMatthew Knepley - localOffsets - If PETSC_TRUE, use local rather than global offsets for the points
1254ea844a1aSMatthew Knepley 
1255ea844a1aSMatthew Knepley   Output Parameter:
1256ea844a1aSMatthew Knepley . gsection - The PetscSection for the global field layout
1257ea844a1aSMatthew Knepley 
1258ea844a1aSMatthew Knepley   Note: This gives negative sizes and offsets to points not owned by this process
1259ea844a1aSMatthew Knepley 
1260ea844a1aSMatthew Knepley   Level: intermediate
1261ea844a1aSMatthew Knepley 
1262ea844a1aSMatthew Knepley .seealso: PetscSectionCreate()
1263ea844a1aSMatthew Knepley @*/
1264ea844a1aSMatthew Knepley PetscErrorCode PetscSectionCreateGlobalSection(PetscSection s, PetscSF sf, PetscBool includeConstraints, PetscBool localOffsets, PetscSection *gsection)
1265ea844a1aSMatthew Knepley {
1266ea844a1aSMatthew Knepley   PetscSection    gs;
1267ea844a1aSMatthew Knepley   const PetscInt *pind = NULL;
1268ea844a1aSMatthew Knepley   PetscInt       *recv = NULL, *neg = NULL;
1269046d2115Sksagiyam   PetscInt        pStart, pEnd, p, dof, cdof, off, foff, globalOff = 0, nroots, nlocal, maxleaf;
1270046d2115Sksagiyam   PetscInt        numFields, f, numComponents;
1271ea844a1aSMatthew Knepley 
1272ea844a1aSMatthew Knepley   PetscFunctionBegin;
1273ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1274ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
1275ea844a1aSMatthew Knepley   PetscValidLogicalCollectiveBool(s, includeConstraints, 3);
1276ea844a1aSMatthew Knepley   PetscValidLogicalCollectiveBool(s, localOffsets, 4);
1277ea844a1aSMatthew Knepley   PetscValidPointer(gsection, 5);
127828b400f6SJacob Faibussowitsch   PetscCheck(s->pointMajor,PETSC_COMM_SELF,PETSC_ERR_SUP, "No support for field major ordering");
12799566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject) s), &gs));
12809566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetNumFields(s, &numFields));
12819566063dSJacob Faibussowitsch   if (numFields > 0) PetscCall(PetscSectionSetNumFields(gs, numFields));
12829566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
12839566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(gs, pStart, pEnd));
128487e637c6Sksagiyam   gs->includesConstraints = includeConstraints;
12859566063dSJacob Faibussowitsch   PetscCall(PetscSFGetGraph(sf, &nroots, NULL, NULL, NULL));
1286ea844a1aSMatthew Knepley   nlocal = nroots;              /* The local/leaf space matches global/root space */
1287ea844a1aSMatthew Knepley   /* Must allocate for all points visible to SF, which may be more than this section */
1288ea844a1aSMatthew Knepley   if (nroots >= 0) {             /* nroots < 0 means that the graph has not been set, only happens in serial */
12899566063dSJacob Faibussowitsch     PetscCall(PetscSFGetLeafRange(sf, NULL, &maxleaf));
12902c71b3e2SJacob Faibussowitsch     PetscCheckFalse(nroots < pEnd,PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "SF roots %" PetscInt_FMT " < pEnd %" PetscInt_FMT, nroots, pEnd);
12912c71b3e2SJacob Faibussowitsch     PetscCheckFalse(maxleaf >= nroots,PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "Max local leaf %" PetscInt_FMT " >= nroots %" PetscInt_FMT, maxleaf, nroots);
12929566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nroots,&neg,nlocal,&recv));
12939566063dSJacob Faibussowitsch     PetscCall(PetscArrayzero(neg,nroots));
1294ea844a1aSMatthew Knepley   }
1295ea844a1aSMatthew Knepley   /* Mark all local points with negative dof */
1296ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
12979566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s, p, &dof));
12989566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(gs, p, dof));
12999566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s, p, &cdof));
13009566063dSJacob Faibussowitsch     if (!includeConstraints && cdof > 0) PetscCall(PetscSectionSetConstraintDof(gs, p, cdof));
1301ea844a1aSMatthew Knepley     if (neg) neg[p] = -(dof+1);
1302ea844a1aSMatthew Knepley   }
13039566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUpBC(gs));
13049566063dSJacob 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]));
1305ea844a1aSMatthew Knepley   if (nroots >= 0) {
13069566063dSJacob Faibussowitsch     PetscCall(PetscArrayzero(recv,nlocal));
13079566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastBegin(sf, MPIU_INT, neg, recv,MPI_REPLACE));
13089566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastEnd(sf, MPIU_INT, neg, recv,MPI_REPLACE));
1309ea844a1aSMatthew Knepley     for (p = pStart; p < pEnd; ++p) {
1310ea844a1aSMatthew Knepley       if (recv[p] < 0) {
1311ea844a1aSMatthew Knepley         gs->atlasDof[p-pStart] = recv[p];
13129566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetDof(s, p, &dof));
13132c71b3e2SJacob 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);
1314ea844a1aSMatthew Knepley       }
1315ea844a1aSMatthew Knepley     }
1316ea844a1aSMatthew Knepley   }
1317ea844a1aSMatthew Knepley   /* Calculate new sizes, get process offset, and calculate point offsets */
13189566063dSJacob Faibussowitsch   if (s->perm) PetscCall(ISGetIndices(s->perm, &pind));
1319ea844a1aSMatthew Knepley   for (p = 0, off = 0; p < pEnd-pStart; ++p) {
1320ea844a1aSMatthew Knepley     const PetscInt q = pind ? pind[p] : p;
1321ea844a1aSMatthew Knepley 
1322ea844a1aSMatthew Knepley     cdof = (!includeConstraints && s->bc) ? s->bc->atlasDof[q] : 0;
1323ea844a1aSMatthew Knepley     gs->atlasOff[q] = off;
1324ea844a1aSMatthew Knepley     off += gs->atlasDof[q] > 0 ? gs->atlasDof[q]-cdof : 0;
1325ea844a1aSMatthew Knepley   }
1326ea844a1aSMatthew Knepley   if (!localOffsets) {
13279566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Scan(&off, &globalOff, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject) s)));
1328ea844a1aSMatthew Knepley     globalOff -= off;
1329ea844a1aSMatthew Knepley   }
1330ea844a1aSMatthew Knepley   for (p = pStart, off = 0; p < pEnd; ++p) {
1331ea844a1aSMatthew Knepley     gs->atlasOff[p-pStart] += globalOff;
1332ea844a1aSMatthew Knepley     if (neg) neg[p] = -(gs->atlasOff[p-pStart]+1);
1333ea844a1aSMatthew Knepley   }
13349566063dSJacob Faibussowitsch   if (s->perm) PetscCall(ISRestoreIndices(s->perm, &pind));
1335ea844a1aSMatthew Knepley   /* Put in negative offsets for ghost points */
1336ea844a1aSMatthew Knepley   if (nroots >= 0) {
13379566063dSJacob Faibussowitsch     PetscCall(PetscArrayzero(recv,nlocal));
13389566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastBegin(sf, MPIU_INT, neg, recv,MPI_REPLACE));
13399566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastEnd(sf, MPIU_INT, neg, recv,MPI_REPLACE));
1340ea844a1aSMatthew Knepley     for (p = pStart; p < pEnd; ++p) {
1341ea844a1aSMatthew Knepley       if (recv[p] < 0) gs->atlasOff[p-pStart] = recv[p];
1342ea844a1aSMatthew Knepley     }
1343ea844a1aSMatthew Knepley   }
13449566063dSJacob Faibussowitsch   PetscCall(PetscFree2(neg,recv));
1345046d2115Sksagiyam   /* Set field dofs/offsets/constraints */
1346046d2115Sksagiyam   for (f = 0; f < numFields; ++f) {
1347046d2115Sksagiyam     gs->field[f]->includesConstraints = includeConstraints;
13489566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldComponents(s, f, &numComponents));
13499566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldComponents(gs, f, numComponents));
1350046d2115Sksagiyam   }
1351046d2115Sksagiyam   for (p = pStart; p < pEnd; ++p) {
13529566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(gs, p, &off));
1353046d2115Sksagiyam     for (f = 0, foff = off; f < numFields; ++f) {
13549566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintDof(s, p, f, &cdof));
13559566063dSJacob Faibussowitsch       if (!includeConstraints && cdof > 0) PetscCall(PetscSectionSetFieldConstraintDof(gs, p, f, cdof));
13569566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldDof(s, p, f, &dof));
13579566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldDof(gs, p, f, off < 0 ? -(dof + 1) : dof));
13589566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldOffset(gs, p, f, foff));
13599566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintDof(gs, p, f, &cdof));
1360046d2115Sksagiyam       foff = off < 0 ? foff - (dof - cdof) : foff + (dof - cdof);
1361046d2115Sksagiyam     }
1362046d2115Sksagiyam   }
1363046d2115Sksagiyam   for (f = 0; f < numFields; ++f) {
1364046d2115Sksagiyam     PetscSection gfs = gs->field[f];
1365046d2115Sksagiyam 
13669566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetUpBC(gfs));
13679566063dSJacob 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]));
1368046d2115Sksagiyam   }
1369046d2115Sksagiyam   gs->setup = PETSC_TRUE;
13709566063dSJacob Faibussowitsch   PetscCall(PetscSectionViewFromOptions(gs, NULL, "-global_section_view"));
1371ea844a1aSMatthew Knepley   *gsection = gs;
1372ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1373ea844a1aSMatthew Knepley }
1374ea844a1aSMatthew Knepley 
1375ea844a1aSMatthew Knepley /*@
1376ea844a1aSMatthew Knepley   PetscSectionCreateGlobalSectionCensored - Create a section describing the global field layout using
1377ea844a1aSMatthew Knepley   the local section and an SF describing the section point overlap.
1378ea844a1aSMatthew Knepley 
1379ea844a1aSMatthew Knepley   Input Parameters:
1380ea844a1aSMatthew Knepley   + s - The PetscSection for the local field layout
1381ea844a1aSMatthew Knepley   . sf - The SF describing parallel layout of the section points
1382ea844a1aSMatthew Knepley   . includeConstraints - By default this is PETSC_FALSE, meaning that the global field vector will not possess constrained dofs
1383ea844a1aSMatthew Knepley   . numExcludes - The number of exclusion ranges
1384ea844a1aSMatthew Knepley   - excludes - An array [start_0, end_0, start_1, end_1, ...] where there are numExcludes pairs
1385ea844a1aSMatthew Knepley 
1386ea844a1aSMatthew Knepley   Output Parameter:
1387ea844a1aSMatthew Knepley   . gsection - The PetscSection for the global field layout
1388ea844a1aSMatthew Knepley 
1389ea844a1aSMatthew Knepley   Note: This gives negative sizes and offsets to points not owned by this process
1390ea844a1aSMatthew Knepley 
1391ea844a1aSMatthew Knepley   Level: advanced
1392ea844a1aSMatthew Knepley 
1393ea844a1aSMatthew Knepley .seealso: PetscSectionCreate()
1394ea844a1aSMatthew Knepley @*/
1395ea844a1aSMatthew Knepley PetscErrorCode PetscSectionCreateGlobalSectionCensored(PetscSection s, PetscSF sf, PetscBool includeConstraints, PetscInt numExcludes, const PetscInt excludes[], PetscSection *gsection)
1396ea844a1aSMatthew Knepley {
1397ea844a1aSMatthew Knepley   const PetscInt *pind = NULL;
1398ea844a1aSMatthew Knepley   PetscInt       *neg  = NULL, *tmpOff = NULL;
1399ea844a1aSMatthew Knepley   PetscInt        pStart, pEnd, p, e, dof, cdof, off, globalOff = 0, nroots;
1400ea844a1aSMatthew Knepley 
1401ea844a1aSMatthew Knepley   PetscFunctionBegin;
1402ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1403ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
1404ea844a1aSMatthew Knepley   PetscValidPointer(gsection, 6);
14059566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject) s), gsection));
14069566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
14079566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(*gsection, pStart, pEnd));
14089566063dSJacob Faibussowitsch   PetscCall(PetscSFGetGraph(sf, &nroots, NULL, NULL, NULL));
1409ea844a1aSMatthew Knepley   if (nroots >= 0) {
14102c71b3e2SJacob Faibussowitsch     PetscCheckFalse(nroots < pEnd-pStart,PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "PetscSF nroots %" PetscInt_FMT " < %" PetscInt_FMT " section size", nroots, pEnd-pStart);
14119566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(nroots, &neg));
1412ea844a1aSMatthew Knepley     if (nroots > pEnd-pStart) {
14139566063dSJacob Faibussowitsch       PetscCall(PetscCalloc1(nroots, &tmpOff));
1414ea844a1aSMatthew Knepley     } else {
1415ea844a1aSMatthew Knepley       tmpOff = &(*gsection)->atlasDof[-pStart];
1416ea844a1aSMatthew Knepley     }
1417ea844a1aSMatthew Knepley   }
1418ea844a1aSMatthew Knepley   /* Mark ghost points with negative dof */
1419ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
1420ea844a1aSMatthew Knepley     for (e = 0; e < numExcludes; ++e) {
1421ea844a1aSMatthew Knepley       if ((p >= excludes[e*2+0]) && (p < excludes[e*2+1])) {
14229566063dSJacob Faibussowitsch         PetscCall(PetscSectionSetDof(*gsection, p, 0));
1423ea844a1aSMatthew Knepley         break;
1424ea844a1aSMatthew Knepley       }
1425ea844a1aSMatthew Knepley     }
1426ea844a1aSMatthew Knepley     if (e < numExcludes) continue;
14279566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s, p, &dof));
14289566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(*gsection, p, dof));
14299566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s, p, &cdof));
14309566063dSJacob Faibussowitsch     if (!includeConstraints && cdof > 0) PetscCall(PetscSectionSetConstraintDof(*gsection, p, cdof));
1431ea844a1aSMatthew Knepley     if (neg) neg[p] = -(dof+1);
1432ea844a1aSMatthew Knepley   }
14339566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUpBC(*gsection));
1434ea844a1aSMatthew Knepley   if (nroots >= 0) {
14359566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastBegin(sf, MPIU_INT, neg, tmpOff,MPI_REPLACE));
14369566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastEnd(sf, MPIU_INT, neg, tmpOff,MPI_REPLACE));
1437ea844a1aSMatthew Knepley     if (nroots > pEnd - pStart) {
1438ea844a1aSMatthew Knepley       for (p = pStart; p < pEnd; ++p) {if (tmpOff[p] < 0) (*gsection)->atlasDof[p-pStart] = tmpOff[p];}
1439ea844a1aSMatthew Knepley     }
1440ea844a1aSMatthew Knepley   }
1441ea844a1aSMatthew Knepley   /* Calculate new sizes, get proccess offset, and calculate point offsets */
14429566063dSJacob Faibussowitsch   if (s->perm) PetscCall(ISGetIndices(s->perm, &pind));
1443ea844a1aSMatthew Knepley   for (p = 0, off = 0; p < pEnd-pStart; ++p) {
1444ea844a1aSMatthew Knepley     const PetscInt q = pind ? pind[p] : p;
1445ea844a1aSMatthew Knepley 
1446ea844a1aSMatthew Knepley     cdof = (!includeConstraints && s->bc) ? s->bc->atlasDof[q] : 0;
1447ea844a1aSMatthew Knepley     (*gsection)->atlasOff[q] = off;
1448ea844a1aSMatthew Knepley     off += (*gsection)->atlasDof[q] > 0 ? (*gsection)->atlasDof[q]-cdof : 0;
1449ea844a1aSMatthew Knepley   }
14509566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Scan(&off, &globalOff, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject) s)));
1451ea844a1aSMatthew Knepley   globalOff -= off;
1452ea844a1aSMatthew Knepley   for (p = 0, off = 0; p < pEnd-pStart; ++p) {
1453ea844a1aSMatthew Knepley     (*gsection)->atlasOff[p] += globalOff;
1454ea844a1aSMatthew Knepley     if (neg) neg[p+pStart] = -((*gsection)->atlasOff[p]+1);
1455ea844a1aSMatthew Knepley   }
14569566063dSJacob Faibussowitsch   if (s->perm) PetscCall(ISRestoreIndices(s->perm, &pind));
1457ea844a1aSMatthew Knepley   /* Put in negative offsets for ghost points */
1458ea844a1aSMatthew Knepley   if (nroots >= 0) {
1459ea844a1aSMatthew Knepley     if (nroots == pEnd-pStart) tmpOff = &(*gsection)->atlasOff[-pStart];
14609566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastBegin(sf, MPIU_INT, neg, tmpOff,MPI_REPLACE));
14619566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastEnd(sf, MPIU_INT, neg, tmpOff,MPI_REPLACE));
1462ea844a1aSMatthew Knepley     if (nroots > pEnd - pStart) {
1463ea844a1aSMatthew Knepley       for (p = pStart; p < pEnd; ++p) {if (tmpOff[p] < 0) (*gsection)->atlasOff[p-pStart] = tmpOff[p];}
1464ea844a1aSMatthew Knepley     }
1465ea844a1aSMatthew Knepley   }
14669566063dSJacob Faibussowitsch   if (nroots >= 0 && nroots > pEnd-pStart) PetscCall(PetscFree(tmpOff));
14679566063dSJacob Faibussowitsch   PetscCall(PetscFree(neg));
1468ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1469ea844a1aSMatthew Knepley }
1470ea844a1aSMatthew Knepley 
1471ea844a1aSMatthew Knepley /*@
1472ea844a1aSMatthew Knepley   PetscSectionGetPointLayout - Get the PetscLayout associated with the section points
1473ea844a1aSMatthew Knepley 
1474ea844a1aSMatthew Knepley   Collective on comm
1475ea844a1aSMatthew Knepley 
1476ea844a1aSMatthew Knepley   Input Parameters:
1477ea844a1aSMatthew Knepley + comm - The MPI_Comm
1478ea844a1aSMatthew Knepley - s    - The PetscSection
1479ea844a1aSMatthew Knepley 
1480ea844a1aSMatthew Knepley   Output Parameter:
1481ea844a1aSMatthew Knepley . layout - The point layout for the section
1482ea844a1aSMatthew Knepley 
14831681d8a4SMatthew Knepley   Note: This is usually called for the default global section.
1484ea844a1aSMatthew Knepley 
1485ea844a1aSMatthew Knepley   Level: advanced
1486ea844a1aSMatthew Knepley 
1487ea844a1aSMatthew Knepley .seealso: PetscSectionGetValueLayout(), PetscSectionCreate()
1488ea844a1aSMatthew Knepley @*/
1489ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetPointLayout(MPI_Comm comm, PetscSection s, PetscLayout *layout)
1490ea844a1aSMatthew Knepley {
1491ea844a1aSMatthew Knepley   PetscInt       pStart, pEnd, p, localSize = 0;
1492ea844a1aSMatthew Knepley 
1493ea844a1aSMatthew Knepley   PetscFunctionBegin;
14949566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
1495ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
1496ea844a1aSMatthew Knepley     PetscInt dof;
1497ea844a1aSMatthew Knepley 
14989566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s, p, &dof));
14999120ba30SVaclav Hapla     if (dof >= 0) ++localSize;
1500ea844a1aSMatthew Knepley   }
15019566063dSJacob Faibussowitsch   PetscCall(PetscLayoutCreate(comm, layout));
15029566063dSJacob Faibussowitsch   PetscCall(PetscLayoutSetLocalSize(*layout, localSize));
15039566063dSJacob Faibussowitsch   PetscCall(PetscLayoutSetBlockSize(*layout, 1));
15049566063dSJacob Faibussowitsch   PetscCall(PetscLayoutSetUp(*layout));
1505ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1506ea844a1aSMatthew Knepley }
1507ea844a1aSMatthew Knepley 
1508ea844a1aSMatthew Knepley /*@
1509ea844a1aSMatthew Knepley   PetscSectionGetValueLayout - Get the PetscLayout associated with the section dofs.
1510ea844a1aSMatthew Knepley 
1511ea844a1aSMatthew Knepley   Collective on comm
1512ea844a1aSMatthew Knepley 
1513ea844a1aSMatthew Knepley   Input Parameters:
1514ea844a1aSMatthew Knepley + comm - The MPI_Comm
1515ea844a1aSMatthew Knepley - s    - The PetscSection
1516ea844a1aSMatthew Knepley 
1517ea844a1aSMatthew Knepley   Output Parameter:
1518ea844a1aSMatthew Knepley . layout - The dof layout for the section
1519ea844a1aSMatthew Knepley 
1520ea844a1aSMatthew Knepley   Note: This is usually called for the default global section.
1521ea844a1aSMatthew Knepley 
1522ea844a1aSMatthew Knepley   Level: advanced
1523ea844a1aSMatthew Knepley 
1524ea844a1aSMatthew Knepley .seealso: PetscSectionGetPointLayout(), PetscSectionCreate()
1525ea844a1aSMatthew Knepley @*/
1526ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetValueLayout(MPI_Comm comm, PetscSection s, PetscLayout *layout)
1527ea844a1aSMatthew Knepley {
1528ea844a1aSMatthew Knepley   PetscInt       pStart, pEnd, p, localSize = 0;
1529ea844a1aSMatthew Knepley 
1530ea844a1aSMatthew Knepley   PetscFunctionBegin;
1531ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 2);
1532ea844a1aSMatthew Knepley   PetscValidPointer(layout, 3);
15339566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
1534ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
1535ea844a1aSMatthew Knepley     PetscInt dof,cdof;
1536ea844a1aSMatthew Knepley 
15379566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s, p, &dof));
15389566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s, p, &cdof));
1539ea844a1aSMatthew Knepley     if (dof-cdof > 0) localSize += dof-cdof;
1540ea844a1aSMatthew Knepley   }
15419566063dSJacob Faibussowitsch   PetscCall(PetscLayoutCreate(comm, layout));
15429566063dSJacob Faibussowitsch   PetscCall(PetscLayoutSetLocalSize(*layout, localSize));
15439566063dSJacob Faibussowitsch   PetscCall(PetscLayoutSetBlockSize(*layout, 1));
15449566063dSJacob Faibussowitsch   PetscCall(PetscLayoutSetUp(*layout));
1545ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1546ea844a1aSMatthew Knepley }
1547ea844a1aSMatthew Knepley 
1548ea844a1aSMatthew Knepley /*@
1549ea844a1aSMatthew Knepley   PetscSectionGetOffset - Return the offset into an array or local Vec for the dof associated with the given point.
1550ea844a1aSMatthew Knepley 
155140750d41SVaclav Hapla   Not Collective
1552ea844a1aSMatthew Knepley 
1553ea844a1aSMatthew Knepley   Input Parameters:
1554ea844a1aSMatthew Knepley + s - the PetscSection
1555ea844a1aSMatthew Knepley - point - the point
1556ea844a1aSMatthew Knepley 
1557ea844a1aSMatthew Knepley   Output Parameter:
1558ea844a1aSMatthew Knepley . offset - the offset
1559ea844a1aSMatthew Knepley 
1560ea844a1aSMatthew Knepley   Level: intermediate
1561ea844a1aSMatthew Knepley 
1562ea844a1aSMatthew Knepley .seealso: PetscSectionGetFieldOffset(), PetscSectionCreate()
1563ea844a1aSMatthew Knepley @*/
1564ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetOffset(PetscSection s, PetscInt point, PetscInt *offset)
1565ea844a1aSMatthew Knepley {
1566ea844a1aSMatthew Knepley   PetscFunctionBegin;
1567ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1568dadcf809SJacob Faibussowitsch   PetscValidIntPointer(offset, 3);
156976bd3646SJed Brown   if (PetscDefined(USE_DEBUG)) {
15702c71b3e2SJacob 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);
157176bd3646SJed Brown   }
1572ea844a1aSMatthew Knepley   *offset = s->atlasOff[point - s->pStart];
1573ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1574ea844a1aSMatthew Knepley }
1575ea844a1aSMatthew Knepley 
1576ea844a1aSMatthew Knepley /*@
1577ea844a1aSMatthew Knepley   PetscSectionSetOffset - Set the offset into an array or local Vec for the dof associated with the given point.
1578ea844a1aSMatthew Knepley 
157940750d41SVaclav Hapla   Not Collective
1580ea844a1aSMatthew Knepley 
1581ea844a1aSMatthew Knepley   Input Parameters:
1582ea844a1aSMatthew Knepley + s - the PetscSection
1583ea844a1aSMatthew Knepley . point - the point
1584ea844a1aSMatthew Knepley - offset - the offset
1585ea844a1aSMatthew Knepley 
1586ea844a1aSMatthew Knepley   Note: The user usually does not call this function, but uses PetscSectionSetUp()
1587ea844a1aSMatthew Knepley 
1588ea844a1aSMatthew Knepley   Level: intermediate
1589ea844a1aSMatthew Knepley 
1590ea844a1aSMatthew Knepley .seealso: PetscSectionGetFieldOffset(), PetscSectionCreate(), PetscSectionSetUp()
1591ea844a1aSMatthew Knepley @*/
1592ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetOffset(PetscSection s, PetscInt point, PetscInt offset)
1593ea844a1aSMatthew Knepley {
1594ea844a1aSMatthew Knepley   PetscFunctionBegin;
1595ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
15962c71b3e2SJacob 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);
1597ea844a1aSMatthew Knepley   s->atlasOff[point - s->pStart] = offset;
1598ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1599ea844a1aSMatthew Knepley }
1600ea844a1aSMatthew Knepley 
1601ea844a1aSMatthew Knepley /*@
1602ea844a1aSMatthew Knepley   PetscSectionGetFieldOffset - Return the offset into an array or local Vec for the dof associated with the given point.
1603ea844a1aSMatthew Knepley 
160440750d41SVaclav Hapla   Not Collective
1605ea844a1aSMatthew Knepley 
1606ea844a1aSMatthew Knepley   Input Parameters:
1607ea844a1aSMatthew Knepley + s - the PetscSection
1608ea844a1aSMatthew Knepley . point - the point
1609ea844a1aSMatthew Knepley - field - the field
1610ea844a1aSMatthew Knepley 
1611ea844a1aSMatthew Knepley   Output Parameter:
1612ea844a1aSMatthew Knepley . offset - the offset
1613ea844a1aSMatthew Knepley 
1614ea844a1aSMatthew Knepley   Level: intermediate
1615ea844a1aSMatthew Knepley 
1616ea844a1aSMatthew Knepley .seealso: PetscSectionGetOffset(), PetscSectionCreate()
1617ea844a1aSMatthew Knepley @*/
1618ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetFieldOffset(PetscSection s, PetscInt point, PetscInt field, PetscInt *offset)
1619ea844a1aSMatthew Knepley {
1620ea844a1aSMatthew Knepley   PetscFunctionBegin;
1621ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
16222abc8c78SJacob Faibussowitsch   PetscValidIntPointer(offset, 4);
16232abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
16249566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(s->field[field], point, offset));
1625ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1626ea844a1aSMatthew Knepley }
1627ea844a1aSMatthew Knepley 
1628ea844a1aSMatthew Knepley /*@
16291681d8a4SMatthew Knepley   PetscSectionSetFieldOffset - Set the offset into an array or local Vec for the dof associated with the given field at a point.
1630ea844a1aSMatthew Knepley 
163140750d41SVaclav Hapla   Not Collective
1632ea844a1aSMatthew Knepley 
1633ea844a1aSMatthew Knepley   Input Parameters:
1634ea844a1aSMatthew Knepley + s - the PetscSection
1635ea844a1aSMatthew Knepley . point - the point
1636ea844a1aSMatthew Knepley . field - the field
1637ea844a1aSMatthew Knepley - offset - the offset
1638ea844a1aSMatthew Knepley 
1639ea844a1aSMatthew Knepley   Note: The user usually does not call this function, but uses PetscSectionSetUp()
1640ea844a1aSMatthew Knepley 
1641ea844a1aSMatthew Knepley   Level: intermediate
1642ea844a1aSMatthew Knepley 
16431681d8a4SMatthew Knepley .seealso: PetscSectionGetFieldOffset(), PetscSectionSetOffset(), PetscSectionCreate(), PetscSectionSetUp()
1644ea844a1aSMatthew Knepley @*/
1645ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetFieldOffset(PetscSection s, PetscInt point, PetscInt field, PetscInt offset)
1646ea844a1aSMatthew Knepley {
1647ea844a1aSMatthew Knepley   PetscFunctionBegin;
1648ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
16492abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
16509566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetOffset(s->field[field], point, offset));
1651ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1652ea844a1aSMatthew Knepley }
1653ea844a1aSMatthew Knepley 
1654ea844a1aSMatthew Knepley /*@
1655ea844a1aSMatthew Knepley   PetscSectionGetFieldPointOffset - Return the offset on the given point for the dof associated with the given point.
1656ea844a1aSMatthew Knepley 
165740750d41SVaclav Hapla   Not Collective
1658ea844a1aSMatthew Knepley 
1659ea844a1aSMatthew Knepley   Input Parameters:
1660ea844a1aSMatthew Knepley + s - the PetscSection
1661ea844a1aSMatthew Knepley . point - the point
1662ea844a1aSMatthew Knepley - field - the field
1663ea844a1aSMatthew Knepley 
1664ea844a1aSMatthew Knepley   Output Parameter:
1665ea844a1aSMatthew Knepley . offset - the offset
1666ea844a1aSMatthew Knepley 
1667ea844a1aSMatthew Knepley   Note: This gives the offset on a point of the field, ignoring constraints, meaning starting at the first dof for
1668ea844a1aSMatthew Knepley         this point, what number is the first dof with this field.
1669ea844a1aSMatthew Knepley 
1670ea844a1aSMatthew Knepley   Level: advanced
1671ea844a1aSMatthew Knepley 
1672ea844a1aSMatthew Knepley .seealso: PetscSectionGetOffset(), PetscSectionCreate()
1673ea844a1aSMatthew Knepley @*/
1674ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetFieldPointOffset(PetscSection s, PetscInt point, PetscInt field, PetscInt *offset)
1675ea844a1aSMatthew Knepley {
1676ea844a1aSMatthew Knepley   PetscInt       off, foff;
1677ea844a1aSMatthew Knepley 
1678ea844a1aSMatthew Knepley   PetscFunctionBegin;
1679ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
16802abc8c78SJacob Faibussowitsch   PetscValidIntPointer(offset, 4);
16812abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
16829566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(s, point, &off));
16839566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(s->field[field], point, &foff));
1684ea844a1aSMatthew Knepley   *offset = foff - off;
1685ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1686ea844a1aSMatthew Knepley }
1687ea844a1aSMatthew Knepley 
1688ea844a1aSMatthew Knepley /*@
1689ea844a1aSMatthew Knepley   PetscSectionGetOffsetRange - Return the full range of offsets [start, end)
1690ea844a1aSMatthew Knepley 
169140750d41SVaclav Hapla   Not Collective
1692ea844a1aSMatthew Knepley 
1693ea844a1aSMatthew Knepley   Input Parameter:
1694ea844a1aSMatthew Knepley . s - the PetscSection
1695ea844a1aSMatthew Knepley 
1696ea844a1aSMatthew Knepley   Output Parameters:
1697ea844a1aSMatthew Knepley + start - the minimum offset
1698ea844a1aSMatthew Knepley - end   - one more than the maximum offset
1699ea844a1aSMatthew Knepley 
1700ea844a1aSMatthew Knepley   Level: intermediate
1701ea844a1aSMatthew Knepley 
1702ea844a1aSMatthew Knepley .seealso: PetscSectionGetOffset(), PetscSectionCreate()
1703ea844a1aSMatthew Knepley @*/
1704ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetOffsetRange(PetscSection s, PetscInt *start, PetscInt *end)
1705ea844a1aSMatthew Knepley {
1706ea844a1aSMatthew Knepley   PetscInt       os = 0, oe = 0, pStart, pEnd, p;
1707ea844a1aSMatthew Knepley 
1708ea844a1aSMatthew Knepley   PetscFunctionBegin;
1709ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1710ea844a1aSMatthew Knepley   if (s->atlasOff) {os = s->atlasOff[0]; oe = s->atlasOff[0];}
17119566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
1712ea844a1aSMatthew Knepley   for (p = 0; p < pEnd-pStart; ++p) {
1713ea844a1aSMatthew Knepley     PetscInt dof = s->atlasDof[p], off = s->atlasOff[p];
1714ea844a1aSMatthew Knepley 
1715ea844a1aSMatthew Knepley     if (off >= 0) {
1716ea844a1aSMatthew Knepley       os = PetscMin(os, off);
1717ea844a1aSMatthew Knepley       oe = PetscMax(oe, off+dof);
1718ea844a1aSMatthew Knepley     }
1719ea844a1aSMatthew Knepley   }
1720ea844a1aSMatthew Knepley   if (start) *start = os;
1721ea844a1aSMatthew Knepley   if (end)   *end   = oe;
1722ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1723ea844a1aSMatthew Knepley }
1724ea844a1aSMatthew Knepley 
1725ea844a1aSMatthew Knepley /*@
1726ea844a1aSMatthew Knepley   PetscSectionCreateSubsection - Create a new, smaller section composed of only the selected fields
1727ea844a1aSMatthew Knepley 
172840750d41SVaclav Hapla   Collective
1729ea844a1aSMatthew Knepley 
1730d8d19677SJose E. Roman   Input Parameters:
1731ea844a1aSMatthew Knepley + s      - the PetscSection
1732ea844a1aSMatthew Knepley . len    - the number of subfields
1733ea844a1aSMatthew Knepley - fields - the subfield numbers
1734ea844a1aSMatthew Knepley 
1735ea844a1aSMatthew Knepley   Output Parameter:
1736ea844a1aSMatthew Knepley . subs   - the subsection
1737ea844a1aSMatthew Knepley 
1738ea844a1aSMatthew Knepley   Note: The section offsets now refer to a new, smaller vector.
1739ea844a1aSMatthew Knepley 
1740ea844a1aSMatthew Knepley   Level: advanced
1741ea844a1aSMatthew Knepley 
1742ea844a1aSMatthew Knepley .seealso: PetscSectionCreateSupersection(), PetscSectionCreate()
1743ea844a1aSMatthew Knepley @*/
1744ea844a1aSMatthew Knepley PetscErrorCode PetscSectionCreateSubsection(PetscSection s, PetscInt len, const PetscInt fields[], PetscSection *subs)
1745ea844a1aSMatthew Knepley {
1746b778fa18SValeria Barra   PetscInt       nF, f, c, pStart, pEnd, p, maxCdof = 0;
1747ea844a1aSMatthew Knepley 
1748ea844a1aSMatthew Knepley   PetscFunctionBegin;
1749ea844a1aSMatthew Knepley   if (!len) PetscFunctionReturn(0);
1750ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1751dadcf809SJacob Faibussowitsch   PetscValidIntPointer(fields, 3);
1752ea844a1aSMatthew Knepley   PetscValidPointer(subs, 4);
17539566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetNumFields(s, &nF));
17542c71b3e2SJacob 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);
17559566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject) s), subs));
17569566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetNumFields(*subs, len));
1757ea844a1aSMatthew Knepley   for (f = 0; f < len; ++f) {
1758ea844a1aSMatthew Knepley     const char *name   = NULL;
1759ea844a1aSMatthew Knepley     PetscInt   numComp = 0;
1760ea844a1aSMatthew Knepley 
17619566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldName(s, fields[f], &name));
17629566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldName(*subs, f, name));
17639566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldComponents(s, fields[f], &numComp));
17649566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldComponents(*subs, f, numComp));
1765b778fa18SValeria Barra     for (c = 0; c < s->numFieldComponents[fields[f]]; ++c) {
17669566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetComponentName(s, fields[f], c, &name));
17679566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetComponentName(*subs, f, c, name));
1768b778fa18SValeria Barra     }
1769ea844a1aSMatthew Knepley   }
17709566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
17719566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(*subs, pStart, pEnd));
1772ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
1773ea844a1aSMatthew Knepley     PetscInt dof = 0, cdof = 0, fdof = 0, cfdof = 0;
1774ea844a1aSMatthew Knepley 
1775ea844a1aSMatthew Knepley     for (f = 0; f < len; ++f) {
17769566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldDof(s, p, fields[f], &fdof));
17779566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldDof(*subs, p, f, fdof));
17789566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintDof(s, p, fields[f], &cfdof));
17799566063dSJacob Faibussowitsch       if (cfdof) PetscCall(PetscSectionSetFieldConstraintDof(*subs, p, f, cfdof));
1780ea844a1aSMatthew Knepley       dof  += fdof;
1781ea844a1aSMatthew Knepley       cdof += cfdof;
1782ea844a1aSMatthew Knepley     }
17839566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(*subs, p, dof));
17849566063dSJacob Faibussowitsch     if (cdof) PetscCall(PetscSectionSetConstraintDof(*subs, p, cdof));
1785ea844a1aSMatthew Knepley     maxCdof = PetscMax(cdof, maxCdof);
1786ea844a1aSMatthew Knepley   }
17879566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(*subs));
1788ea844a1aSMatthew Knepley   if (maxCdof) {
1789ea844a1aSMatthew Knepley     PetscInt *indices;
1790ea844a1aSMatthew Knepley 
17919566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(maxCdof, &indices));
1792ea844a1aSMatthew Knepley     for (p = pStart; p < pEnd; ++p) {
1793ea844a1aSMatthew Knepley       PetscInt cdof;
1794ea844a1aSMatthew Knepley 
17959566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetConstraintDof(*subs, p, &cdof));
1796ea844a1aSMatthew Knepley       if (cdof) {
1797ea844a1aSMatthew Knepley         const PetscInt *oldIndices = NULL;
1798ea844a1aSMatthew Knepley         PetscInt       fdof = 0, cfdof = 0, fc, numConst = 0, fOff = 0;
1799ea844a1aSMatthew Knepley 
1800ea844a1aSMatthew Knepley         for (f = 0; f < len; ++f) {
18019566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetFieldDof(s, p, fields[f], &fdof));
18029566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetFieldConstraintDof(s, p, fields[f], &cfdof));
18039566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetFieldConstraintIndices(s, p, fields[f], &oldIndices));
18049566063dSJacob Faibussowitsch           PetscCall(PetscSectionSetFieldConstraintIndices(*subs, p, f, oldIndices));
18059574d0f0SMatthew G. Knepley           for (fc = 0; fc < cfdof; ++fc) indices[numConst+fc] = oldIndices[fc] + fOff;
1806ea844a1aSMatthew Knepley           numConst += cfdof;
1807ea844a1aSMatthew Knepley           fOff     += fdof;
1808ea844a1aSMatthew Knepley         }
18099566063dSJacob Faibussowitsch         PetscCall(PetscSectionSetConstraintIndices(*subs, p, indices));
1810ea844a1aSMatthew Knepley       }
1811ea844a1aSMatthew Knepley     }
18129566063dSJacob Faibussowitsch     PetscCall(PetscFree(indices));
1813ea844a1aSMatthew Knepley   }
1814ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1815ea844a1aSMatthew Knepley }
1816ea844a1aSMatthew Knepley 
1817ea844a1aSMatthew Knepley /*@
1818ea844a1aSMatthew Knepley   PetscSectionCreateSupersection - Create a new, larger section composed of the input sections
1819ea844a1aSMatthew Knepley 
182040750d41SVaclav Hapla   Collective
1821ea844a1aSMatthew Knepley 
1822ea844a1aSMatthew Knepley   Input Parameters:
1823ea844a1aSMatthew Knepley + s     - the input sections
1824ea844a1aSMatthew Knepley - len   - the number of input sections
1825ea844a1aSMatthew Knepley 
1826ea844a1aSMatthew Knepley   Output Parameter:
1827ea844a1aSMatthew Knepley . supers - the supersection
1828ea844a1aSMatthew Knepley 
1829ea844a1aSMatthew Knepley   Note: The section offsets now refer to a new, larger vector.
1830ea844a1aSMatthew Knepley 
1831ea844a1aSMatthew Knepley   Level: advanced
1832ea844a1aSMatthew Knepley 
1833ea844a1aSMatthew Knepley .seealso: PetscSectionCreateSubsection(), PetscSectionCreate()
1834ea844a1aSMatthew Knepley @*/
1835ea844a1aSMatthew Knepley PetscErrorCode PetscSectionCreateSupersection(PetscSection s[], PetscInt len, PetscSection *supers)
1836ea844a1aSMatthew Knepley {
1837ea844a1aSMatthew Knepley   PetscInt       Nf = 0, f, pStart = PETSC_MAX_INT, pEnd = 0, p, maxCdof = 0, i;
1838ea844a1aSMatthew Knepley 
1839ea844a1aSMatthew Knepley   PetscFunctionBegin;
1840ea844a1aSMatthew Knepley   if (!len) PetscFunctionReturn(0);
1841ea844a1aSMatthew Knepley   for (i = 0; i < len; ++i) {
1842ea844a1aSMatthew Knepley     PetscInt nf, pStarti, pEndi;
1843ea844a1aSMatthew Knepley 
18449566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetNumFields(s[i], &nf));
18459566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetChart(s[i], &pStarti, &pEndi));
1846ea844a1aSMatthew Knepley     pStart = PetscMin(pStart, pStarti);
1847ea844a1aSMatthew Knepley     pEnd   = PetscMax(pEnd,   pEndi);
1848ea844a1aSMatthew Knepley     Nf += nf;
1849ea844a1aSMatthew Knepley   }
18509566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject) s[0]), supers));
18519566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetNumFields(*supers, Nf));
1852ea844a1aSMatthew Knepley   for (i = 0, f = 0; i < len; ++i) {
1853b778fa18SValeria Barra     PetscInt nf, fi, ci;
1854ea844a1aSMatthew Knepley 
18559566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetNumFields(s[i], &nf));
1856ea844a1aSMatthew Knepley     for (fi = 0; fi < nf; ++fi, ++f) {
1857ea844a1aSMatthew Knepley       const char *name   = NULL;
1858ea844a1aSMatthew Knepley       PetscInt   numComp = 0;
1859ea844a1aSMatthew Knepley 
18609566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldName(s[i], fi, &name));
18619566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldName(*supers, f, name));
18629566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldComponents(s[i], fi, &numComp));
18639566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldComponents(*supers, f, numComp));
1864b778fa18SValeria Barra       for (ci = 0; ci < s[i]->numFieldComponents[fi]; ++ci) {
18659566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetComponentName(s[i], fi, ci, &name));
18669566063dSJacob Faibussowitsch         PetscCall(PetscSectionSetComponentName(*supers, f, ci, name));
1867b778fa18SValeria Barra       }
1868ea844a1aSMatthew Knepley     }
1869ea844a1aSMatthew Knepley   }
18709566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(*supers, pStart, pEnd));
1871ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
1872ea844a1aSMatthew Knepley     PetscInt dof = 0, cdof = 0;
1873ea844a1aSMatthew Knepley 
1874ea844a1aSMatthew Knepley     for (i = 0, f = 0; i < len; ++i) {
1875ea844a1aSMatthew Knepley       PetscInt nf, fi, pStarti, pEndi;
1876ea844a1aSMatthew Knepley       PetscInt fdof = 0, cfdof = 0;
1877ea844a1aSMatthew Knepley 
18789566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetNumFields(s[i], &nf));
18799566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetChart(s[i], &pStarti, &pEndi));
1880ea844a1aSMatthew Knepley       if ((p < pStarti) || (p >= pEndi)) continue;
1881ea844a1aSMatthew Knepley       for (fi = 0; fi < nf; ++fi, ++f) {
18829566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetFieldDof(s[i], p, fi, &fdof));
18839566063dSJacob Faibussowitsch         PetscCall(PetscSectionAddFieldDof(*supers, p, f, fdof));
18849566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetFieldConstraintDof(s[i], p, fi, &cfdof));
18859566063dSJacob Faibussowitsch         if (cfdof) PetscCall(PetscSectionAddFieldConstraintDof(*supers, p, f, cfdof));
1886ea844a1aSMatthew Knepley         dof  += fdof;
1887ea844a1aSMatthew Knepley         cdof += cfdof;
1888ea844a1aSMatthew Knepley       }
1889ea844a1aSMatthew Knepley     }
18909566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(*supers, p, dof));
18919566063dSJacob Faibussowitsch     if (cdof) PetscCall(PetscSectionSetConstraintDof(*supers, p, cdof));
1892ea844a1aSMatthew Knepley     maxCdof = PetscMax(cdof, maxCdof);
1893ea844a1aSMatthew Knepley   }
18949566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(*supers));
1895ea844a1aSMatthew Knepley   if (maxCdof) {
1896ea844a1aSMatthew Knepley     PetscInt *indices;
1897ea844a1aSMatthew Knepley 
18989566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(maxCdof, &indices));
1899ea844a1aSMatthew Knepley     for (p = pStart; p < pEnd; ++p) {
1900ea844a1aSMatthew Knepley       PetscInt cdof;
1901ea844a1aSMatthew Knepley 
19029566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetConstraintDof(*supers, p, &cdof));
1903ea844a1aSMatthew Knepley       if (cdof) {
1904ea844a1aSMatthew Knepley         PetscInt dof, numConst = 0, fOff = 0;
1905ea844a1aSMatthew Knepley 
1906ea844a1aSMatthew Knepley         for (i = 0, f = 0; i < len; ++i) {
1907ea844a1aSMatthew Knepley           const PetscInt *oldIndices = NULL;
1908ea844a1aSMatthew Knepley           PetscInt        nf, fi, pStarti, pEndi, fdof, cfdof, fc;
1909ea844a1aSMatthew Knepley 
19109566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetNumFields(s[i], &nf));
19119566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetChart(s[i], &pStarti, &pEndi));
1912ea844a1aSMatthew Knepley           if ((p < pStarti) || (p >= pEndi)) continue;
1913ea844a1aSMatthew Knepley           for (fi = 0; fi < nf; ++fi, ++f) {
19149566063dSJacob Faibussowitsch             PetscCall(PetscSectionGetFieldDof(s[i], p, fi, &fdof));
19159566063dSJacob Faibussowitsch             PetscCall(PetscSectionGetFieldConstraintDof(s[i], p, fi, &cfdof));
19169566063dSJacob Faibussowitsch             PetscCall(PetscSectionGetFieldConstraintIndices(s[i], p, fi, &oldIndices));
1917fcd2503dSMatthew G. Knepley             for (fc = 0; fc < cfdof; ++fc) indices[numConst+fc] = oldIndices[fc];
19189566063dSJacob Faibussowitsch             PetscCall(PetscSectionSetFieldConstraintIndices(*supers, p, f, &indices[numConst]));
1919fcd2503dSMatthew G. Knepley             for (fc = 0; fc < cfdof; ++fc) indices[numConst+fc] += fOff;
1920ea844a1aSMatthew Knepley             numConst += cfdof;
1921ea844a1aSMatthew Knepley           }
19229566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetDof(s[i], p, &dof));
1923ea844a1aSMatthew Knepley           fOff += dof;
1924ea844a1aSMatthew Knepley         }
19259566063dSJacob Faibussowitsch         PetscCall(PetscSectionSetConstraintIndices(*supers, p, indices));
1926ea844a1aSMatthew Knepley       }
1927ea844a1aSMatthew Knepley     }
19289566063dSJacob Faibussowitsch     PetscCall(PetscFree(indices));
1929ea844a1aSMatthew Knepley   }
1930ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1931ea844a1aSMatthew Knepley }
1932ea844a1aSMatthew Knepley 
1933ea844a1aSMatthew Knepley /*@
1934ea844a1aSMatthew Knepley   PetscSectionCreateSubmeshSection - Create a new, smaller section with support on the submesh
1935ea844a1aSMatthew Knepley 
193640750d41SVaclav Hapla   Collective
1937ea844a1aSMatthew Knepley 
1938ea844a1aSMatthew Knepley   Input Parameters:
1939ea844a1aSMatthew Knepley + s           - the PetscSection
1940ea844a1aSMatthew Knepley - subpointMap - a sorted list of points in the original mesh which are in the submesh
1941ea844a1aSMatthew Knepley 
1942ea844a1aSMatthew Knepley   Output Parameter:
1943ea844a1aSMatthew Knepley . subs - the subsection
1944ea844a1aSMatthew Knepley 
1945ea844a1aSMatthew Knepley   Note: The section offsets now refer to a new, smaller vector.
1946ea844a1aSMatthew Knepley 
1947ea844a1aSMatthew Knepley   Level: advanced
1948ea844a1aSMatthew Knepley 
1949ea844a1aSMatthew Knepley .seealso: PetscSectionCreateSubsection(), DMPlexGetSubpointMap(), PetscSectionCreate()
1950ea844a1aSMatthew Knepley @*/
1951ea844a1aSMatthew Knepley PetscErrorCode PetscSectionCreateSubmeshSection(PetscSection s, IS subpointMap, PetscSection *subs)
1952ea844a1aSMatthew Knepley {
1953ea844a1aSMatthew Knepley   const PetscInt *points = NULL, *indices = NULL;
1954b778fa18SValeria Barra   PetscInt       numFields, f, c, numSubpoints = 0, pStart, pEnd, p, subp;
1955ea844a1aSMatthew Knepley 
1956ea844a1aSMatthew Knepley   PetscFunctionBegin;
1957ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1958ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(subpointMap, IS_CLASSID, 2);
1959ea844a1aSMatthew Knepley   PetscValidPointer(subs, 3);
19609566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetNumFields(s, &numFields));
19619566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject) s), subs));
19629566063dSJacob Faibussowitsch   if (numFields) PetscCall(PetscSectionSetNumFields(*subs, numFields));
1963ea844a1aSMatthew Knepley   for (f = 0; f < numFields; ++f) {
1964ea844a1aSMatthew Knepley     const char *name   = NULL;
1965ea844a1aSMatthew Knepley     PetscInt   numComp = 0;
1966ea844a1aSMatthew Knepley 
19679566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldName(s, f, &name));
19689566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldName(*subs, f, name));
19699566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldComponents(s, f, &numComp));
19709566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldComponents(*subs, f, numComp));
1971b778fa18SValeria Barra     for (c = 0; c < s->numFieldComponents[f]; ++c) {
19729566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetComponentName(s, f, c, &name));
19739566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetComponentName(*subs, f, c, name));
1974b778fa18SValeria Barra     }
1975ea844a1aSMatthew Knepley   }
1976ea844a1aSMatthew Knepley   /* For right now, we do not try to squeeze the subchart */
1977ea844a1aSMatthew Knepley   if (subpointMap) {
19789566063dSJacob Faibussowitsch     PetscCall(ISGetSize(subpointMap, &numSubpoints));
19799566063dSJacob Faibussowitsch     PetscCall(ISGetIndices(subpointMap, &points));
1980ea844a1aSMatthew Knepley   }
19819566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
19829566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(*subs, 0, numSubpoints));
1983ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
1984ea844a1aSMatthew Knepley     PetscInt dof, cdof, fdof = 0, cfdof = 0;
1985ea844a1aSMatthew Knepley 
19869566063dSJacob Faibussowitsch     PetscCall(PetscFindInt(p, numSubpoints, points, &subp));
1987ea844a1aSMatthew Knepley     if (subp < 0) continue;
1988ea844a1aSMatthew Knepley     for (f = 0; f < numFields; ++f) {
19899566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldDof(s, p, f, &fdof));
19909566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldDof(*subs, subp, f, fdof));
19919566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintDof(s, p, f, &cfdof));
19929566063dSJacob Faibussowitsch       if (cfdof) PetscCall(PetscSectionSetFieldConstraintDof(*subs, subp, f, cfdof));
1993ea844a1aSMatthew Knepley     }
19949566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s, p, &dof));
19959566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(*subs, subp, dof));
19969566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s, p, &cdof));
19979566063dSJacob Faibussowitsch     if (cdof) PetscCall(PetscSectionSetConstraintDof(*subs, subp, cdof));
1998ea844a1aSMatthew Knepley   }
19999566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(*subs));
2000ea844a1aSMatthew Knepley   /* Change offsets to original offsets */
2001ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
2002ea844a1aSMatthew Knepley     PetscInt off, foff = 0;
2003ea844a1aSMatthew Knepley 
20049566063dSJacob Faibussowitsch     PetscCall(PetscFindInt(p, numSubpoints, points, &subp));
2005ea844a1aSMatthew Knepley     if (subp < 0) continue;
2006ea844a1aSMatthew Knepley     for (f = 0; f < numFields; ++f) {
20079566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldOffset(s, p, f, &foff));
20089566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldOffset(*subs, subp, f, foff));
2009ea844a1aSMatthew Knepley     }
20109566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(s, p, &off));
20119566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetOffset(*subs, subp, off));
2012ea844a1aSMatthew Knepley   }
2013ea844a1aSMatthew Knepley   /* Copy constraint indices */
2014ea844a1aSMatthew Knepley   for (subp = 0; subp < numSubpoints; ++subp) {
2015ea844a1aSMatthew Knepley     PetscInt cdof;
2016ea844a1aSMatthew Knepley 
20179566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(*subs, subp, &cdof));
2018ea844a1aSMatthew Knepley     if (cdof) {
2019ea844a1aSMatthew Knepley       for (f = 0; f < numFields; ++f) {
20209566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetFieldConstraintIndices(s, points[subp], f, &indices));
20219566063dSJacob Faibussowitsch         PetscCall(PetscSectionSetFieldConstraintIndices(*subs, subp, f, indices));
2022ea844a1aSMatthew Knepley       }
20239566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetConstraintIndices(s, points[subp], &indices));
20249566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetConstraintIndices(*subs, subp, indices));
2025ea844a1aSMatthew Knepley     }
2026ea844a1aSMatthew Knepley   }
20279566063dSJacob Faibussowitsch   if (subpointMap) PetscCall(ISRestoreIndices(subpointMap, &points));
2028ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2029ea844a1aSMatthew Knepley }
2030ea844a1aSMatthew Knepley 
2031ea844a1aSMatthew Knepley static PetscErrorCode PetscSectionView_ASCII(PetscSection s, PetscViewer viewer)
2032ea844a1aSMatthew Knepley {
2033ea844a1aSMatthew Knepley   PetscInt       p;
2034ea844a1aSMatthew Knepley   PetscMPIInt    rank;
2035ea844a1aSMatthew Knepley 
2036ea844a1aSMatthew Knepley   PetscFunctionBegin;
20379566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(PetscObjectComm((PetscObject)viewer), &rank));
20389566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPushSynchronized(viewer));
20399566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "Process %d:\n", rank));
2040ea844a1aSMatthew Knepley   for (p = 0; p < s->pEnd - s->pStart; ++p) {
2041ea844a1aSMatthew Knepley     if ((s->bc) && (s->bc->atlasDof[p] > 0)) {
2042ea844a1aSMatthew Knepley       PetscInt b;
2043ea844a1aSMatthew Knepley 
20449566063dSJacob 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]));
2045083401c6SMatthew G. Knepley       if (s->bcIndices) {
2046ea844a1aSMatthew Knepley         for (b = 0; b < s->bc->atlasDof[p]; ++b) {
20479566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, " %" PetscInt_FMT, s->bcIndices[s->bc->atlasOff[p]+b]));
2048ea844a1aSMatthew Knepley         }
2049083401c6SMatthew G. Knepley       }
20509566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "\n"));
2051ea844a1aSMatthew Knepley     } else {
20529566063dSJacob 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]));
2053ea844a1aSMatthew Knepley     }
2054ea844a1aSMatthew Knepley   }
20559566063dSJacob Faibussowitsch   PetscCall(PetscViewerFlush(viewer));
20569566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPopSynchronized(viewer));
2057ea844a1aSMatthew Knepley   if (s->sym) {
20589566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPushTab(viewer));
20599566063dSJacob Faibussowitsch     PetscCall(PetscSectionSymView(s->sym,viewer));
20609566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopTab(viewer));
2061ea844a1aSMatthew Knepley   }
2062ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2063ea844a1aSMatthew Knepley }
2064ea844a1aSMatthew Knepley 
2065ea844a1aSMatthew Knepley /*@C
2066fe2efc57SMark    PetscSectionViewFromOptions - View from Options
2067fe2efc57SMark 
206840750d41SVaclav Hapla    Collective
2069fe2efc57SMark 
2070fe2efc57SMark    Input Parameters:
2071fe2efc57SMark +  A - the PetscSection object to view
2072736c3998SJose E. Roman .  obj - Optional object
2073736c3998SJose E. Roman -  name - command line option
2074fe2efc57SMark 
2075fe2efc57SMark    Level: intermediate
2076fe2efc57SMark .seealso:  PetscSection, PetscSectionView, PetscObjectViewFromOptions(), PetscSectionCreate()
2077fe2efc57SMark @*/
2078fe2efc57SMark PetscErrorCode  PetscSectionViewFromOptions(PetscSection A,PetscObject obj,const char name[])
2079fe2efc57SMark {
2080fe2efc57SMark   PetscFunctionBegin;
2081fe2efc57SMark   PetscValidHeaderSpecific(A,PETSC_SECTION_CLASSID,1);
20829566063dSJacob Faibussowitsch   PetscCall(PetscObjectViewFromOptions((PetscObject)A,obj,name));
2083fe2efc57SMark   PetscFunctionReturn(0);
2084fe2efc57SMark }
2085fe2efc57SMark 
2086fe2efc57SMark /*@C
2087ea844a1aSMatthew Knepley   PetscSectionView - Views a PetscSection
2088ea844a1aSMatthew Knepley 
208940750d41SVaclav Hapla   Collective
2090ea844a1aSMatthew Knepley 
2091ea844a1aSMatthew Knepley   Input Parameters:
2092ea844a1aSMatthew Knepley + s - the PetscSection object to view
2093ea844a1aSMatthew Knepley - v - the viewer
2094ea844a1aSMatthew Knepley 
20951ddd528eSksagiyam   Note:
20961ddd528eSksagiyam   PetscSectionView(), when viewer is of type PETSCVIEWERHDF5, only saves
20971ddd528eSksagiyam   distribution independent data, such as dofs, offsets, constraint dofs,
20981ddd528eSksagiyam   and constraint indices. Points that have negative dofs, for instance,
20991ddd528eSksagiyam   are not saved as they represent points owned by other processes.
21001ddd528eSksagiyam   Point numbering and rank assignment is currently not stored.
21011ddd528eSksagiyam   The saved section can be loaded with PetscSectionLoad().
21021ddd528eSksagiyam 
2103ea844a1aSMatthew Knepley   Level: beginner
2104ea844a1aSMatthew Knepley 
2105fde5e3acSksagiyam .seealso PetscSectionCreate(), PetscSectionDestroy(), PetscSectionLoad()
2106ea844a1aSMatthew Knepley @*/
2107ea844a1aSMatthew Knepley PetscErrorCode PetscSectionView(PetscSection s, PetscViewer viewer)
2108ea844a1aSMatthew Knepley {
21091ddd528eSksagiyam   PetscBool      isascii, ishdf5;
2110ea844a1aSMatthew Knepley   PetscInt       f;
2111ea844a1aSMatthew Knepley 
2112ea844a1aSMatthew Knepley   PetscFunctionBegin;
2113ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
21149566063dSJacob Faibussowitsch   if (!viewer) PetscCall(PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)s), &viewer));
2115ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(viewer, PETSC_VIEWER_CLASSID, 2);
21169566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject) viewer, PETSCVIEWERASCII, &isascii));
21179566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject) viewer, PETSCVIEWERHDF5, &ishdf5));
2118ea844a1aSMatthew Knepley   if (isascii) {
21199566063dSJacob Faibussowitsch     PetscCall(PetscObjectPrintClassNamePrefixType((PetscObject)s,viewer));
2120ea844a1aSMatthew Knepley     if (s->numFields) {
21219566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "%" PetscInt_FMT " fields\n", s->numFields));
2122ea844a1aSMatthew Knepley       for (f = 0; f < s->numFields; ++f) {
21239566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  field %" PetscInt_FMT " with %" PetscInt_FMT " components\n", f, s->numFieldComponents[f]));
21249566063dSJacob Faibussowitsch         PetscCall(PetscSectionView_ASCII(s->field[f], viewer));
2125ea844a1aSMatthew Knepley       }
2126ea844a1aSMatthew Knepley     } else {
21279566063dSJacob Faibussowitsch       PetscCall(PetscSectionView_ASCII(s, viewer));
2128ea844a1aSMatthew Knepley     }
21291ddd528eSksagiyam   } else if (ishdf5) {
21301ddd528eSksagiyam #if PetscDefined(HAVE_HDF5)
21319566063dSJacob Faibussowitsch     PetscCall(PetscSectionView_HDF5_Internal(s, viewer));
21321ddd528eSksagiyam #else
21331ddd528eSksagiyam     SETERRQ(PetscObjectComm((PetscObject) s), PETSC_ERR_SUP, "HDF5 not supported in this build.\nPlease reconfigure using --download-hdf5");
21341ddd528eSksagiyam #endif
2135ea844a1aSMatthew Knepley   }
2136ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2137ea844a1aSMatthew Knepley }
2138ea844a1aSMatthew Knepley 
2139fde5e3acSksagiyam /*@C
2140fde5e3acSksagiyam   PetscSectionLoad - Loads a PetscSection
2141fde5e3acSksagiyam 
214240750d41SVaclav Hapla   Collective
2143fde5e3acSksagiyam 
2144fde5e3acSksagiyam   Input Parameters:
2145fde5e3acSksagiyam + s - the PetscSection object to load
2146fde5e3acSksagiyam - v - the viewer
2147fde5e3acSksagiyam 
2148fde5e3acSksagiyam   Note:
2149fde5e3acSksagiyam   PetscSectionLoad(), when viewer is of type PETSCVIEWERHDF5, loads
2150fde5e3acSksagiyam   a section saved with PetscSectionView(). The number of processes
2151fde5e3acSksagiyam   used here (N) does not need to be the same as that used when saving.
2152fde5e3acSksagiyam   After calling this function, the chart of s on rank i will be set
2153fde5e3acSksagiyam   to [0, E_i), where \sum_{i=0}^{N-1}E_i equals to the total number of
2154fde5e3acSksagiyam   saved section points.
2155fde5e3acSksagiyam 
2156fde5e3acSksagiyam   Level: beginner
2157fde5e3acSksagiyam 
2158fde5e3acSksagiyam .seealso PetscSectionCreate(), PetscSectionDestroy(), PetscSectionView()
2159fde5e3acSksagiyam @*/
2160fde5e3acSksagiyam PetscErrorCode PetscSectionLoad(PetscSection s, PetscViewer viewer)
2161fde5e3acSksagiyam {
2162fde5e3acSksagiyam   PetscBool      ishdf5;
2163fde5e3acSksagiyam 
2164fde5e3acSksagiyam   PetscFunctionBegin;
2165fde5e3acSksagiyam   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2166fde5e3acSksagiyam   PetscValidHeaderSpecific(viewer, PETSC_VIEWER_CLASSID, 2);
21679566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject) viewer, PETSCVIEWERHDF5, &ishdf5));
2168fde5e3acSksagiyam   if (ishdf5) {
2169fde5e3acSksagiyam #if PetscDefined(HAVE_HDF5)
21709566063dSJacob Faibussowitsch     PetscCall(PetscSectionLoad_HDF5_Internal(s, viewer));
2171fde5e3acSksagiyam     PetscFunctionReturn(0);
2172fde5e3acSksagiyam #else
2173fde5e3acSksagiyam     SETERRQ(PetscObjectComm((PetscObject) s), PETSC_ERR_SUP, "HDF5 not supported in this build.\nPlease reconfigure using --download-hdf5");
2174fde5e3acSksagiyam #endif
217598921bdaSJacob Faibussowitsch   } else SETERRQ(PetscObjectComm((PetscObject) s), PETSC_ERR_SUP, "Viewer type %s not yet supported for PetscSection loading", ((PetscObject)viewer)->type_name);
2176fde5e3acSksagiyam }
2177fde5e3acSksagiyam 
2178c459fbc1SJed Brown static PetscErrorCode PetscSectionResetClosurePermutation(PetscSection section)
2179c459fbc1SJed Brown {
2180c459fbc1SJed Brown   PetscSectionClosurePermVal clVal;
2181c459fbc1SJed Brown 
2182c459fbc1SJed Brown   PetscFunctionBegin;
2183c459fbc1SJed Brown   if (!section->clHash) PetscFunctionReturn(0);
2184c459fbc1SJed Brown   kh_foreach_value(section->clHash, clVal, {
21859566063dSJacob Faibussowitsch       PetscCall(PetscFree(clVal.perm));
21869566063dSJacob Faibussowitsch       PetscCall(PetscFree(clVal.invPerm));
2187c459fbc1SJed Brown     });
2188c459fbc1SJed Brown   kh_destroy(ClPerm, section->clHash);
2189c459fbc1SJed Brown   section->clHash = NULL;
2190c459fbc1SJed Brown   PetscFunctionReturn(0);
2191c459fbc1SJed Brown }
2192c459fbc1SJed Brown 
2193ea844a1aSMatthew Knepley /*@
2194ea844a1aSMatthew Knepley   PetscSectionReset - Frees all section data.
2195ea844a1aSMatthew Knepley 
219640750d41SVaclav Hapla   Not Collective
2197ea844a1aSMatthew Knepley 
2198ea844a1aSMatthew Knepley   Input Parameters:
2199ea844a1aSMatthew Knepley . s - the PetscSection
2200ea844a1aSMatthew Knepley 
2201ea844a1aSMatthew Knepley   Level: beginner
2202ea844a1aSMatthew Knepley 
2203ea844a1aSMatthew Knepley .seealso: PetscSection, PetscSectionCreate()
2204ea844a1aSMatthew Knepley @*/
2205ea844a1aSMatthew Knepley PetscErrorCode PetscSectionReset(PetscSection s)
2206ea844a1aSMatthew Knepley {
2207b778fa18SValeria Barra   PetscInt       f, c;
2208ea844a1aSMatthew Knepley 
2209ea844a1aSMatthew Knepley   PetscFunctionBegin;
2210ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2211ea844a1aSMatthew Knepley   for (f = 0; f < s->numFields; ++f) {
22129566063dSJacob Faibussowitsch     PetscCall(PetscSectionDestroy(&s->field[f]));
22139566063dSJacob Faibussowitsch     PetscCall(PetscFree(s->fieldNames[f]));
2214b146d1acSSatish Balay     for (c = 0; c < s->numFieldComponents[f]; ++c) {
22159566063dSJacob Faibussowitsch       PetscCall(PetscFree(s->compNames[f][c]));
2216b146d1acSSatish Balay     }
22179566063dSJacob Faibussowitsch     PetscCall(PetscFree(s->compNames[f]));
2218ea844a1aSMatthew Knepley   }
22199566063dSJacob Faibussowitsch   PetscCall(PetscFree(s->numFieldComponents));
22209566063dSJacob Faibussowitsch   PetscCall(PetscFree(s->fieldNames));
22219566063dSJacob Faibussowitsch   PetscCall(PetscFree(s->compNames));
22229566063dSJacob Faibussowitsch   PetscCall(PetscFree(s->field));
22239566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&s->bc));
22249566063dSJacob Faibussowitsch   PetscCall(PetscFree(s->bcIndices));
22259566063dSJacob Faibussowitsch   PetscCall(PetscFree2(s->atlasDof, s->atlasOff));
22269566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&s->clSection));
22279566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&s->clPoints));
22289566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&s->perm));
22299566063dSJacob Faibussowitsch   PetscCall(PetscSectionResetClosurePermutation(s));
22309566063dSJacob Faibussowitsch   PetscCall(PetscSectionSymDestroy(&s->sym));
22319566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&s->clSection));
22329566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&s->clPoints));
223369c11d05SVaclav Hapla   PetscCall(PetscSectionInvalidateMaxDof_Internal(s));
2234ea844a1aSMatthew Knepley   s->pStart    = -1;
2235ea844a1aSMatthew Knepley   s->pEnd      = -1;
2236ea844a1aSMatthew Knepley   s->maxDof    = 0;
2237ea844a1aSMatthew Knepley   s->setup     = PETSC_FALSE;
2238ea844a1aSMatthew Knepley   s->numFields = 0;
2239ea844a1aSMatthew Knepley   s->clObj     = NULL;
2240ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2241ea844a1aSMatthew Knepley }
2242ea844a1aSMatthew Knepley 
2243ea844a1aSMatthew Knepley /*@
2244ea844a1aSMatthew Knepley   PetscSectionDestroy - Frees a section object and frees its range if that exists.
2245ea844a1aSMatthew Knepley 
224640750d41SVaclav Hapla   Not Collective
2247ea844a1aSMatthew Knepley 
2248ea844a1aSMatthew Knepley   Input Parameters:
2249ea844a1aSMatthew Knepley . s - the PetscSection
2250ea844a1aSMatthew Knepley 
2251ea844a1aSMatthew Knepley   Level: beginner
2252ea844a1aSMatthew Knepley 
2253ea844a1aSMatthew Knepley .seealso: PetscSection, PetscSectionCreate()
2254ea844a1aSMatthew Knepley @*/
2255ea844a1aSMatthew Knepley PetscErrorCode PetscSectionDestroy(PetscSection *s)
2256ea844a1aSMatthew Knepley {
2257ea844a1aSMatthew Knepley   PetscFunctionBegin;
2258ea844a1aSMatthew Knepley   if (!*s) PetscFunctionReturn(0);
225962f17a49SStefano Zampini   PetscValidHeaderSpecific(*s,PETSC_SECTION_CLASSID,1);
2260ea844a1aSMatthew Knepley   if (--((PetscObject)(*s))->refct > 0) {
2261ea844a1aSMatthew Knepley     *s = NULL;
2262ea844a1aSMatthew Knepley     PetscFunctionReturn(0);
2263ea844a1aSMatthew Knepley   }
22649566063dSJacob Faibussowitsch   PetscCall(PetscSectionReset(*s));
22659566063dSJacob Faibussowitsch   PetscCall(PetscHeaderDestroy(s));
2266ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2267ea844a1aSMatthew Knepley }
2268ea844a1aSMatthew Knepley 
2269ea844a1aSMatthew Knepley PetscErrorCode VecIntGetValuesSection(PetscInt *baseArray, PetscSection s, PetscInt point, const PetscInt **values)
2270ea844a1aSMatthew Knepley {
2271ea844a1aSMatthew Knepley   const PetscInt p = point - s->pStart;
2272ea844a1aSMatthew Knepley 
2273ea844a1aSMatthew Knepley   PetscFunctionBegin;
2274ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 2);
2275ea844a1aSMatthew Knepley   *values = &baseArray[s->atlasOff[p]];
2276ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2277ea844a1aSMatthew Knepley }
2278ea844a1aSMatthew Knepley 
2279ea844a1aSMatthew Knepley PetscErrorCode VecIntSetValuesSection(PetscInt *baseArray, PetscSection s, PetscInt point, const PetscInt values[], InsertMode mode)
2280ea844a1aSMatthew Knepley {
2281ea844a1aSMatthew Knepley   PetscInt       *array;
2282ea844a1aSMatthew Knepley   const PetscInt p           = point - s->pStart;
2283ea844a1aSMatthew Knepley   const PetscInt orientation = 0; /* Needs to be included for use in closure operations */
2284ea844a1aSMatthew Knepley   PetscInt       cDim        = 0;
2285ea844a1aSMatthew Knepley 
2286ea844a1aSMatthew Knepley   PetscFunctionBegin;
2287ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 2);
22889566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstraintDof(s, p, &cDim));
2289ea844a1aSMatthew Knepley   array = &baseArray[s->atlasOff[p]];
2290ea844a1aSMatthew Knepley   if (!cDim) {
2291ea844a1aSMatthew Knepley     if (orientation >= 0) {
2292ea844a1aSMatthew Knepley       const PetscInt dim = s->atlasDof[p];
2293ea844a1aSMatthew Knepley       PetscInt       i;
2294ea844a1aSMatthew Knepley 
2295ea844a1aSMatthew Knepley       if (mode == INSERT_VALUES) {
2296ea844a1aSMatthew Knepley         for (i = 0; i < dim; ++i) array[i] = values[i];
2297ea844a1aSMatthew Knepley       } else {
2298ea844a1aSMatthew Knepley         for (i = 0; i < dim; ++i) array[i] += values[i];
2299ea844a1aSMatthew Knepley       }
2300ea844a1aSMatthew Knepley     } else {
2301ea844a1aSMatthew Knepley       PetscInt offset = 0;
2302ea844a1aSMatthew Knepley       PetscInt j      = -1, field, i;
2303ea844a1aSMatthew Knepley 
2304ea844a1aSMatthew Knepley       for (field = 0; field < s->numFields; ++field) {
2305ea844a1aSMatthew Knepley         const PetscInt dim = s->field[field]->atlasDof[p];
2306ea844a1aSMatthew Knepley 
2307ea844a1aSMatthew Knepley         for (i = dim-1; i >= 0; --i) array[++j] = values[i+offset];
2308ea844a1aSMatthew Knepley         offset += dim;
2309ea844a1aSMatthew Knepley       }
2310ea844a1aSMatthew Knepley     }
2311ea844a1aSMatthew Knepley   } else {
2312ea844a1aSMatthew Knepley     if (orientation >= 0) {
2313ea844a1aSMatthew Knepley       const PetscInt dim  = s->atlasDof[p];
2314ea844a1aSMatthew Knepley       PetscInt       cInd = 0, i;
2315ea844a1aSMatthew Knepley       const PetscInt *cDof;
2316ea844a1aSMatthew Knepley 
23179566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetConstraintIndices(s, point, &cDof));
2318ea844a1aSMatthew Knepley       if (mode == INSERT_VALUES) {
2319ea844a1aSMatthew Knepley         for (i = 0; i < dim; ++i) {
2320ea844a1aSMatthew Knepley           if ((cInd < cDim) && (i == cDof[cInd])) {++cInd; continue;}
2321ea844a1aSMatthew Knepley           array[i] = values[i];
2322ea844a1aSMatthew Knepley         }
2323ea844a1aSMatthew Knepley       } else {
2324ea844a1aSMatthew Knepley         for (i = 0; i < dim; ++i) {
2325ea844a1aSMatthew Knepley           if ((cInd < cDim) && (i == cDof[cInd])) {++cInd; continue;}
2326ea844a1aSMatthew Knepley           array[i] += values[i];
2327ea844a1aSMatthew Knepley         }
2328ea844a1aSMatthew Knepley       }
2329ea844a1aSMatthew Knepley     } else {
2330ea844a1aSMatthew Knepley       const PetscInt *cDof;
2331ea844a1aSMatthew Knepley       PetscInt       offset  = 0;
2332ea844a1aSMatthew Knepley       PetscInt       cOffset = 0;
2333ea844a1aSMatthew Knepley       PetscInt       j       = 0, field;
2334ea844a1aSMatthew Knepley 
23359566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetConstraintIndices(s, point, &cDof));
2336ea844a1aSMatthew Knepley       for (field = 0; field < s->numFields; ++field) {
2337ea844a1aSMatthew Knepley         const PetscInt dim  = s->field[field]->atlasDof[p];     /* PetscSectionGetFieldDof() */
2338ea844a1aSMatthew Knepley         const PetscInt tDim = s->field[field]->bc->atlasDof[p]; /* PetscSectionGetFieldConstraintDof() */
2339ea844a1aSMatthew Knepley         const PetscInt sDim = dim - tDim;
2340ea844a1aSMatthew Knepley         PetscInt       cInd = 0, i,k;
2341ea844a1aSMatthew Knepley 
2342ea844a1aSMatthew Knepley         for (i = 0, k = dim+offset-1; i < dim; ++i, ++j, --k) {
2343ea844a1aSMatthew Knepley           if ((cInd < sDim) && (j == cDof[cInd+cOffset])) {++cInd; continue;}
2344ea844a1aSMatthew Knepley           array[j] = values[k];
2345ea844a1aSMatthew Knepley         }
2346ea844a1aSMatthew Knepley         offset  += dim;
2347ea844a1aSMatthew Knepley         cOffset += dim - tDim;
2348ea844a1aSMatthew Knepley       }
2349ea844a1aSMatthew Knepley     }
2350ea844a1aSMatthew Knepley   }
2351ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2352ea844a1aSMatthew Knepley }
2353ea844a1aSMatthew Knepley 
2354ea844a1aSMatthew Knepley /*@C
2355ea844a1aSMatthew Knepley   PetscSectionHasConstraints - Determine whether a section has constrained dofs
2356ea844a1aSMatthew Knepley 
235740750d41SVaclav Hapla   Not Collective
2358ea844a1aSMatthew Knepley 
2359ea844a1aSMatthew Knepley   Input Parameter:
2360ea844a1aSMatthew Knepley . s - The PetscSection
2361ea844a1aSMatthew Knepley 
2362ea844a1aSMatthew Knepley   Output Parameter:
2363ea844a1aSMatthew Knepley . hasConstraints - flag indicating that the section has constrained dofs
2364ea844a1aSMatthew Knepley 
2365ea844a1aSMatthew Knepley   Level: intermediate
2366ea844a1aSMatthew Knepley 
2367ea844a1aSMatthew Knepley .seealso: PetscSectionSetConstraintIndices(), PetscSectionGetConstraintDof(), PetscSection
2368ea844a1aSMatthew Knepley @*/
2369ea844a1aSMatthew Knepley PetscErrorCode PetscSectionHasConstraints(PetscSection s, PetscBool *hasConstraints)
2370ea844a1aSMatthew Knepley {
2371ea844a1aSMatthew Knepley   PetscFunctionBegin;
2372ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2373dadcf809SJacob Faibussowitsch   PetscValidBoolPointer(hasConstraints, 2);
2374ea844a1aSMatthew Knepley   *hasConstraints = s->bc ? PETSC_TRUE : PETSC_FALSE;
2375ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2376ea844a1aSMatthew Knepley }
2377ea844a1aSMatthew Knepley 
2378ea844a1aSMatthew Knepley /*@C
2379ea844a1aSMatthew Knepley   PetscSectionGetConstraintIndices - Get the point dof numbers, in [0, dof), which are constrained
2380ea844a1aSMatthew Knepley 
238140750d41SVaclav Hapla   Not Collective
2382ea844a1aSMatthew Knepley 
2383ea844a1aSMatthew Knepley   Input Parameters:
2384ea844a1aSMatthew Knepley + s     - The PetscSection
2385ea844a1aSMatthew Knepley - point - The point
2386ea844a1aSMatthew Knepley 
2387ea844a1aSMatthew Knepley   Output Parameter:
2388ea844a1aSMatthew Knepley . indices - The constrained dofs
2389ea844a1aSMatthew Knepley 
2390ea844a1aSMatthew Knepley   Note: In Fortran, you call PetscSectionGetConstraintIndicesF90() and PetscSectionRestoreConstraintIndicesF90()
2391ea844a1aSMatthew Knepley 
2392ea844a1aSMatthew Knepley   Level: intermediate
2393ea844a1aSMatthew Knepley 
2394ea844a1aSMatthew Knepley .seealso: PetscSectionSetConstraintIndices(), PetscSectionGetConstraintDof(), PetscSection
2395ea844a1aSMatthew Knepley @*/
2396ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetConstraintIndices(PetscSection s, PetscInt point, const PetscInt **indices)
2397ea844a1aSMatthew Knepley {
2398ea844a1aSMatthew Knepley   PetscFunctionBegin;
2399ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2400ea844a1aSMatthew Knepley   if (s->bc) {
24019566063dSJacob Faibussowitsch     PetscCall(VecIntGetValuesSection(s->bcIndices, s->bc, point, indices));
2402ea844a1aSMatthew Knepley   } else *indices = NULL;
2403ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2404ea844a1aSMatthew Knepley }
2405ea844a1aSMatthew Knepley 
2406ea844a1aSMatthew Knepley /*@C
2407ea844a1aSMatthew Knepley   PetscSectionSetConstraintIndices - Set the point dof numbers, in [0, dof), which are constrained
2408ea844a1aSMatthew Knepley 
240940750d41SVaclav Hapla   Not Collective
2410ea844a1aSMatthew Knepley 
2411ea844a1aSMatthew Knepley   Input Parameters:
2412ea844a1aSMatthew Knepley + s     - The PetscSection
2413ea844a1aSMatthew Knepley . point - The point
2414ea844a1aSMatthew Knepley - indices - The constrained dofs
2415ea844a1aSMatthew Knepley 
2416ea844a1aSMatthew Knepley   Note: The Fortran is PetscSectionSetConstraintIndicesF90()
2417ea844a1aSMatthew Knepley 
2418ea844a1aSMatthew Knepley   Level: intermediate
2419ea844a1aSMatthew Knepley 
2420ea844a1aSMatthew Knepley .seealso: PetscSectionGetConstraintIndices(), PetscSectionGetConstraintDof(), PetscSection
2421ea844a1aSMatthew Knepley @*/
2422ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetConstraintIndices(PetscSection s, PetscInt point, const PetscInt indices[])
2423ea844a1aSMatthew Knepley {
2424ea844a1aSMatthew Knepley   PetscFunctionBegin;
2425ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2426ea844a1aSMatthew Knepley   if (s->bc) {
2427d57bb9dbSMatthew G. Knepley     const PetscInt dof  = s->atlasDof[point];
2428d57bb9dbSMatthew G. Knepley     const PetscInt cdof = s->bc->atlasDof[point];
2429d57bb9dbSMatthew G. Knepley     PetscInt       d;
2430d57bb9dbSMatthew G. Knepley 
2431d57bb9dbSMatthew G. Knepley     for (d = 0; d < cdof; ++d) {
2432e2bfaee7SMatthew 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]);
2433d57bb9dbSMatthew G. Knepley     }
24349566063dSJacob Faibussowitsch     PetscCall(VecIntSetValuesSection(s->bcIndices, s->bc, point, indices, INSERT_VALUES));
2435ea844a1aSMatthew Knepley   }
2436ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2437ea844a1aSMatthew Knepley }
2438ea844a1aSMatthew Knepley 
2439ea844a1aSMatthew Knepley /*@C
2440ea844a1aSMatthew Knepley   PetscSectionGetFieldConstraintIndices - Get the field dof numbers, in [0, fdof), which are constrained
2441ea844a1aSMatthew Knepley 
244240750d41SVaclav Hapla   Not Collective
2443ea844a1aSMatthew Knepley 
2444ea844a1aSMatthew Knepley   Input Parameters:
2445ea844a1aSMatthew Knepley + s     - The PetscSection
2446ea844a1aSMatthew Knepley . field  - The field number
2447ea844a1aSMatthew Knepley - point - The point
2448ea844a1aSMatthew Knepley 
2449ea844a1aSMatthew Knepley   Output Parameter:
24509759eb26SJed Brown . indices - The constrained dofs sorted in ascending order
2451ea844a1aSMatthew Knepley 
24529759eb26SJed Brown   Notes:
24539759eb26SJed 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().
24549759eb26SJed Brown 
24559759eb26SJed Brown   Fortran Note:
24569759eb26SJed Brown   In Fortran, you call PetscSectionGetFieldConstraintIndicesF90() and PetscSectionRestoreFieldConstraintIndicesF90()
2457ea844a1aSMatthew Knepley 
2458ea844a1aSMatthew Knepley   Level: intermediate
2459ea844a1aSMatthew Knepley 
2460ea844a1aSMatthew Knepley .seealso: PetscSectionSetFieldConstraintIndices(), PetscSectionGetConstraintIndices(), PetscSectionGetConstraintDof(), PetscSection
2461ea844a1aSMatthew Knepley @*/
2462ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetFieldConstraintIndices(PetscSection s, PetscInt point, PetscInt field, const PetscInt **indices)
2463ea844a1aSMatthew Knepley {
2464ea844a1aSMatthew Knepley   PetscFunctionBegin;
2465ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2466dadcf809SJacob Faibussowitsch   PetscValidPointer(indices,4);
24672abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
24689566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstraintIndices(s->field[field], point, indices));
2469ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2470ea844a1aSMatthew Knepley }
2471ea844a1aSMatthew Knepley 
2472ea844a1aSMatthew Knepley /*@C
2473ea844a1aSMatthew Knepley   PetscSectionSetFieldConstraintIndices - Set the field dof numbers, in [0, fdof), which are constrained
2474ea844a1aSMatthew Knepley 
247540750d41SVaclav Hapla   Not Collective
2476ea844a1aSMatthew Knepley 
2477ea844a1aSMatthew Knepley   Input Parameters:
2478ea844a1aSMatthew Knepley + s       - The PetscSection
2479ea844a1aSMatthew Knepley . point   - The point
2480ea844a1aSMatthew Knepley . field   - The field number
2481ea844a1aSMatthew Knepley - indices - The constrained dofs
2482ea844a1aSMatthew Knepley 
2483ea844a1aSMatthew Knepley   Note: The Fortran is PetscSectionSetFieldConstraintIndicesF90()
2484ea844a1aSMatthew Knepley 
2485ea844a1aSMatthew Knepley   Level: intermediate
2486ea844a1aSMatthew Knepley 
2487ea844a1aSMatthew Knepley .seealso: PetscSectionSetConstraintIndices(), PetscSectionGetFieldConstraintIndices(), PetscSectionGetConstraintDof(), PetscSection
2488ea844a1aSMatthew Knepley @*/
2489ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetFieldConstraintIndices(PetscSection s, PetscInt point, PetscInt field, const PetscInt indices[])
2490ea844a1aSMatthew Knepley {
2491ea844a1aSMatthew Knepley   PetscFunctionBegin;
2492ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
24932abc8c78SJacob Faibussowitsch   if (PetscDefined(USE_DEBUG)) {
2494e2bfaee7SMatthew G. Knepley     PetscInt nfdof;
24952abc8c78SJacob Faibussowitsch 
24969566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldConstraintDof(s, point, field, &nfdof));
2497e2bfaee7SMatthew G. Knepley     if (nfdof) PetscValidIntPointer(indices, 4);
24982abc8c78SJacob Faibussowitsch   }
24992abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
25009566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetConstraintIndices(s->field[field], point, indices));
2501ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2502ea844a1aSMatthew Knepley }
2503ea844a1aSMatthew Knepley 
2504ea844a1aSMatthew Knepley /*@
2505ea844a1aSMatthew Knepley   PetscSectionPermute - Reorder the section according to the input point permutation
2506ea844a1aSMatthew Knepley 
250740750d41SVaclav Hapla   Collective
2508ea844a1aSMatthew Knepley 
2509d8d19677SJose E. Roman   Input Parameters:
2510ea844a1aSMatthew Knepley + section - The PetscSection object
2511ea844a1aSMatthew Knepley - perm - The point permutation, old point p becomes new point perm[p]
2512ea844a1aSMatthew Knepley 
2513ea844a1aSMatthew Knepley   Output Parameter:
2514ea844a1aSMatthew Knepley . sectionNew - The permuted PetscSection
2515ea844a1aSMatthew Knepley 
2516ea844a1aSMatthew Knepley   Level: intermediate
2517ea844a1aSMatthew Knepley 
2518ea844a1aSMatthew Knepley .seealso: MatPermute()
2519ea844a1aSMatthew Knepley @*/
2520ea844a1aSMatthew Knepley PetscErrorCode PetscSectionPermute(PetscSection section, IS permutation, PetscSection *sectionNew)
2521ea844a1aSMatthew Knepley {
2522ea844a1aSMatthew Knepley   PetscSection    s = section, sNew;
2523ea844a1aSMatthew Knepley   const PetscInt *perm;
2524b778fa18SValeria Barra   PetscInt        numFields, f, c, numPoints, pStart, pEnd, p;
2525ea844a1aSMatthew Knepley 
2526ea844a1aSMatthew Knepley   PetscFunctionBegin;
2527ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1);
2528ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(permutation, IS_CLASSID, 2);
2529ea844a1aSMatthew Knepley   PetscValidPointer(sectionNew, 3);
25309566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject) s), &sNew));
25319566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetNumFields(s, &numFields));
25329566063dSJacob Faibussowitsch   if (numFields) PetscCall(PetscSectionSetNumFields(sNew, numFields));
2533ea844a1aSMatthew Knepley   for (f = 0; f < numFields; ++f) {
2534ea844a1aSMatthew Knepley     const char *name;
2535ea844a1aSMatthew Knepley     PetscInt    numComp;
2536ea844a1aSMatthew Knepley 
25379566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldName(s, f, &name));
25389566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldName(sNew, f, name));
25399566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldComponents(s, f, &numComp));
25409566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldComponents(sNew, f, numComp));
2541b778fa18SValeria Barra     for (c = 0; c < s->numFieldComponents[f]; ++c) {
25429566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetComponentName(s, f, c, &name));
25439566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetComponentName(sNew, f, c, name));
2544b778fa18SValeria Barra     }
2545ea844a1aSMatthew Knepley   }
25469566063dSJacob Faibussowitsch   PetscCall(ISGetLocalSize(permutation, &numPoints));
25479566063dSJacob Faibussowitsch   PetscCall(ISGetIndices(permutation, &perm));
25489566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
25499566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(sNew, pStart, pEnd));
25502c71b3e2SJacob 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);
2551ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
2552ea844a1aSMatthew Knepley     PetscInt dof, cdof;
2553ea844a1aSMatthew Knepley 
25549566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s, p, &dof));
25559566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(sNew, perm[p], dof));
25569566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s, p, &cdof));
25579566063dSJacob Faibussowitsch     if (cdof) PetscCall(PetscSectionSetConstraintDof(sNew, perm[p], cdof));
2558ea844a1aSMatthew Knepley     for (f = 0; f < numFields; ++f) {
25599566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldDof(s, p, f, &dof));
25609566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldDof(sNew, perm[p], f, dof));
25619566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintDof(s, p, f, &cdof));
25629566063dSJacob Faibussowitsch       if (cdof) PetscCall(PetscSectionSetFieldConstraintDof(sNew, perm[p], f, cdof));
2563ea844a1aSMatthew Knepley     }
2564ea844a1aSMatthew Knepley   }
25659566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(sNew));
2566ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
2567ea844a1aSMatthew Knepley     const PetscInt *cind;
2568ea844a1aSMatthew Knepley     PetscInt        cdof;
2569ea844a1aSMatthew Knepley 
25709566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s, p, &cdof));
2571ea844a1aSMatthew Knepley     if (cdof) {
25729566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetConstraintIndices(s, p, &cind));
25739566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetConstraintIndices(sNew, perm[p], cind));
2574ea844a1aSMatthew Knepley     }
2575ea844a1aSMatthew Knepley     for (f = 0; f < numFields; ++f) {
25769566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintDof(s, p, f, &cdof));
2577ea844a1aSMatthew Knepley       if (cdof) {
25789566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetFieldConstraintIndices(s, p, f, &cind));
25799566063dSJacob Faibussowitsch         PetscCall(PetscSectionSetFieldConstraintIndices(sNew, perm[p], f, cind));
2580ea844a1aSMatthew Knepley       }
2581ea844a1aSMatthew Knepley     }
2582ea844a1aSMatthew Knepley   }
25839566063dSJacob Faibussowitsch   PetscCall(ISRestoreIndices(permutation, &perm));
2584ea844a1aSMatthew Knepley   *sectionNew = sNew;
2585ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2586ea844a1aSMatthew Knepley }
2587ea844a1aSMatthew Knepley 
2588ea844a1aSMatthew Knepley /*@
2589ea844a1aSMatthew Knepley   PetscSectionSetClosureIndex - Set a cache of points in the closure of each point in the section
2590ea844a1aSMatthew Knepley 
259140750d41SVaclav Hapla   Collective
2592ea844a1aSMatthew Knepley 
2593ea844a1aSMatthew Knepley   Input Parameters:
2594ea844a1aSMatthew Knepley + section   - The PetscSection
2595ea844a1aSMatthew Knepley . obj       - A PetscObject which serves as the key for this index
2596ea844a1aSMatthew Knepley . clSection - Section giving the size of the closure of each point
2597ea844a1aSMatthew Knepley - clPoints  - IS giving the points in each closure
2598ea844a1aSMatthew Knepley 
2599ea844a1aSMatthew Knepley   Note: We compress out closure points with no dofs in this section
2600ea844a1aSMatthew Knepley 
2601ea844a1aSMatthew Knepley   Level: advanced
2602ea844a1aSMatthew Knepley 
2603ea844a1aSMatthew Knepley .seealso: PetscSectionGetClosureIndex(), DMPlexCreateClosureIndex()
2604ea844a1aSMatthew Knepley @*/
2605ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetClosureIndex(PetscSection section, PetscObject obj, PetscSection clSection, IS clPoints)
2606ea844a1aSMatthew Knepley {
2607ea844a1aSMatthew Knepley   PetscFunctionBegin;
26083e03ebd8SStefano Zampini   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,1);
26093e03ebd8SStefano Zampini   PetscValidHeaderSpecific(clSection,PETSC_SECTION_CLASSID,3);
26103e03ebd8SStefano Zampini   PetscValidHeaderSpecific(clPoints,IS_CLASSID,4);
26119566063dSJacob Faibussowitsch   if (section->clObj != obj) PetscCall(PetscSectionResetClosurePermutation(section));
2612ea844a1aSMatthew Knepley   section->clObj     = obj;
26139566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)clSection));
26149566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)clPoints));
26159566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&section->clSection));
26169566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&section->clPoints));
2617ea844a1aSMatthew Knepley   section->clSection = clSection;
2618ea844a1aSMatthew Knepley   section->clPoints  = clPoints;
2619ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2620ea844a1aSMatthew Knepley }
2621ea844a1aSMatthew Knepley 
2622ea844a1aSMatthew Knepley /*@
2623ea844a1aSMatthew Knepley   PetscSectionGetClosureIndex - Get the cache of points in the closure of each point in the section
2624ea844a1aSMatthew Knepley 
262540750d41SVaclav Hapla   Collective
2626ea844a1aSMatthew Knepley 
2627ea844a1aSMatthew Knepley   Input Parameters:
2628ea844a1aSMatthew Knepley + section   - The PetscSection
2629ea844a1aSMatthew Knepley - obj       - A PetscObject which serves as the key for this index
2630ea844a1aSMatthew Knepley 
2631ea844a1aSMatthew Knepley   Output Parameters:
2632ea844a1aSMatthew Knepley + clSection - Section giving the size of the closure of each point
2633ea844a1aSMatthew Knepley - clPoints  - IS giving the points in each closure
2634ea844a1aSMatthew Knepley 
2635ea844a1aSMatthew Knepley   Note: We compress out closure points with no dofs in this section
2636ea844a1aSMatthew Knepley 
2637ea844a1aSMatthew Knepley   Level: advanced
2638ea844a1aSMatthew Knepley 
2639ea844a1aSMatthew Knepley .seealso: PetscSectionSetClosureIndex(), DMPlexCreateClosureIndex()
2640ea844a1aSMatthew Knepley @*/
2641ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetClosureIndex(PetscSection section, PetscObject obj, PetscSection *clSection, IS *clPoints)
2642ea844a1aSMatthew Knepley {
2643ea844a1aSMatthew Knepley   PetscFunctionBegin;
2644ea844a1aSMatthew Knepley   if (section->clObj == obj) {
2645ea844a1aSMatthew Knepley     if (clSection) *clSection = section->clSection;
2646ea844a1aSMatthew Knepley     if (clPoints)  *clPoints  = section->clPoints;
2647ea844a1aSMatthew Knepley   } else {
2648ea844a1aSMatthew Knepley     if (clSection) *clSection = NULL;
2649ea844a1aSMatthew Knepley     if (clPoints)  *clPoints  = NULL;
2650ea844a1aSMatthew Knepley   }
2651ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2652ea844a1aSMatthew Knepley }
2653ea844a1aSMatthew Knepley 
2654c459fbc1SJed Brown PetscErrorCode PetscSectionSetClosurePermutation_Internal(PetscSection section, PetscObject obj, PetscInt depth, PetscInt clSize, PetscCopyMode mode, PetscInt *clPerm)
2655ea844a1aSMatthew Knepley {
2656ea844a1aSMatthew Knepley   PetscInt       i;
2657c459fbc1SJed Brown   khiter_t iter;
2658c459fbc1SJed Brown   int new_entry;
2659c459fbc1SJed Brown   PetscSectionClosurePermKey key = {depth, clSize};
2660c459fbc1SJed Brown   PetscSectionClosurePermVal *val;
2661ea844a1aSMatthew Knepley 
2662ea844a1aSMatthew Knepley   PetscFunctionBegin;
2663ea844a1aSMatthew Knepley   if (section->clObj != obj) {
26649566063dSJacob Faibussowitsch     PetscCall(PetscSectionDestroy(&section->clSection));
26659566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&section->clPoints));
2666ea844a1aSMatthew Knepley   }
2667ea844a1aSMatthew Knepley   section->clObj = obj;
26689566063dSJacob Faibussowitsch   if (!section->clHash) PetscCall(PetscClPermCreate(&section->clHash));
2669c459fbc1SJed Brown   iter = kh_put(ClPerm, section->clHash, key, &new_entry);
2670c459fbc1SJed Brown   val = &kh_val(section->clHash, iter);
2671c459fbc1SJed Brown   if (!new_entry) {
26729566063dSJacob Faibussowitsch     PetscCall(PetscFree(val->perm));
26739566063dSJacob Faibussowitsch     PetscCall(PetscFree(val->invPerm));
2674c459fbc1SJed Brown   }
2675ea844a1aSMatthew Knepley   if (mode == PETSC_COPY_VALUES) {
26769566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(clSize, &val->perm));
26779566063dSJacob Faibussowitsch     PetscCall(PetscLogObjectMemory((PetscObject) obj, clSize*sizeof(PetscInt)));
26789566063dSJacob Faibussowitsch     PetscCall(PetscArraycpy(val->perm, clPerm, clSize));
2679ea844a1aSMatthew Knepley   } else if (mode == PETSC_OWN_POINTER) {
2680c459fbc1SJed Brown     val->perm = clPerm;
2681ea844a1aSMatthew Knepley   } else SETERRQ(PetscObjectComm(obj), PETSC_ERR_SUP, "Do not support borrowed arrays");
26829566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(clSize, &val->invPerm));
2683c459fbc1SJed Brown   for (i = 0; i < clSize; ++i) val->invPerm[clPerm[i]] = i;
2684ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2685ea844a1aSMatthew Knepley }
2686ea844a1aSMatthew Knepley 
2687ea844a1aSMatthew Knepley /*@
2688c459fbc1SJed Brown   PetscSectionSetClosurePermutation - Set the dof permutation for the closure of each cell in the section, meaning clPerm[newIndex] = oldIndex.
2689ea844a1aSMatthew Knepley 
2690ea844a1aSMatthew Knepley   Not Collective
2691ea844a1aSMatthew Knepley 
2692ea844a1aSMatthew Knepley   Input Parameters:
2693ea844a1aSMatthew Knepley + section - The PetscSection
2694c459fbc1SJed Brown . obj     - A PetscObject which serves as the key for this index (usually a DM)
2695c459fbc1SJed Brown . depth   - Depth of points on which to apply the given permutation
2696ea844a1aSMatthew Knepley - perm    - Permutation of the cell dof closure
2697ea844a1aSMatthew Knepley 
2698c459fbc1SJed Brown   Note:
2699c459fbc1SJed Brown   The specified permutation will only be applied to points at depth whose closure size matches the length of perm.  In a
2700c459fbc1SJed Brown   mixed-topology or variable-degree finite element space, this function can be called multiple times at each depth for
2701c459fbc1SJed Brown   each topology and degree.
2702c459fbc1SJed Brown 
2703c459fbc1SJed Brown   This approach assumes that (depth, len(perm)) uniquely identifies the desired permutation; this might not be true for
2704c459fbc1SJed Brown   exotic/enriched spaces on mixed topology meshes.
2705ea844a1aSMatthew Knepley 
2706ea844a1aSMatthew Knepley   Level: intermediate
2707ea844a1aSMatthew Knepley 
2708ea844a1aSMatthew Knepley .seealso: PetscSectionGetClosurePermutation(), PetscSectionGetClosureIndex(), DMPlexCreateClosureIndex(), PetscCopyMode
2709ea844a1aSMatthew Knepley @*/
2710c459fbc1SJed Brown PetscErrorCode PetscSectionSetClosurePermutation(PetscSection section, PetscObject obj, PetscInt depth, IS perm)
2711ea844a1aSMatthew Knepley {
2712ea844a1aSMatthew Knepley   const PetscInt *clPerm = NULL;
2713ea844a1aSMatthew Knepley   PetscInt        clSize = 0;
2714ea844a1aSMatthew Knepley 
2715ea844a1aSMatthew Knepley   PetscFunctionBegin;
2716ea844a1aSMatthew Knepley   if (perm) {
27179566063dSJacob Faibussowitsch     PetscCall(ISGetLocalSize(perm, &clSize));
27189566063dSJacob Faibussowitsch     PetscCall(ISGetIndices(perm, &clPerm));
2719ea844a1aSMatthew Knepley   }
27209566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetClosurePermutation_Internal(section, obj, depth, clSize, PETSC_COPY_VALUES, (PetscInt *) clPerm));
27219566063dSJacob Faibussowitsch   if (perm) PetscCall(ISRestoreIndices(perm, &clPerm));
2722ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2723ea844a1aSMatthew Knepley }
2724ea844a1aSMatthew Knepley 
2725c459fbc1SJed Brown PetscErrorCode PetscSectionGetClosurePermutation_Internal(PetscSection section, PetscObject obj, PetscInt depth, PetscInt size, const PetscInt *perm[])
2726ea844a1aSMatthew Knepley {
2727ea844a1aSMatthew Knepley   PetscFunctionBegin;
2728ea844a1aSMatthew Knepley   if (section->clObj == obj) {
2729c459fbc1SJed Brown     PetscSectionClosurePermKey k = {depth, size};
2730c459fbc1SJed Brown     PetscSectionClosurePermVal v;
27319566063dSJacob Faibussowitsch     PetscCall(PetscClPermGet(section->clHash, k, &v));
2732c459fbc1SJed Brown     if (perm) *perm = v.perm;
2733ea844a1aSMatthew Knepley   } else {
2734ea844a1aSMatthew Knepley     if (perm) *perm = NULL;
2735ea844a1aSMatthew Knepley   }
2736ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2737ea844a1aSMatthew Knepley }
2738ea844a1aSMatthew Knepley 
2739ea844a1aSMatthew Knepley /*@
2740ea844a1aSMatthew Knepley   PetscSectionGetClosurePermutation - Get the dof permutation for the closure of each cell in the section, meaning clPerm[newIndex] = oldIndex.
2741ea844a1aSMatthew Knepley 
274240750d41SVaclav Hapla   Not Collective
2743ea844a1aSMatthew Knepley 
2744ea844a1aSMatthew Knepley   Input Parameters:
2745ea844a1aSMatthew Knepley + section   - The PetscSection
2746c459fbc1SJed Brown . obj       - A PetscObject which serves as the key for this index (usually a DM)
2747c459fbc1SJed Brown . depth     - Depth stratum on which to obtain closure permutation
2748c459fbc1SJed Brown - clSize    - Closure size to be permuted (e.g., may vary with element topology and degree)
2749ea844a1aSMatthew Knepley 
2750ea844a1aSMatthew Knepley   Output Parameter:
2751ea844a1aSMatthew Knepley . perm - The dof closure permutation
2752ea844a1aSMatthew Knepley 
2753c459fbc1SJed Brown   Note:
2754ea844a1aSMatthew Knepley   The user must destroy the IS that is returned.
2755ea844a1aSMatthew Knepley 
2756ea844a1aSMatthew Knepley   Level: intermediate
2757ea844a1aSMatthew Knepley 
2758ea844a1aSMatthew Knepley .seealso: PetscSectionSetClosurePermutation(), PetscSectionGetClosureInversePermutation(), PetscSectionGetClosureIndex(), PetscSectionSetClosureIndex(), DMPlexCreateClosureIndex()
2759ea844a1aSMatthew Knepley @*/
2760c459fbc1SJed Brown PetscErrorCode PetscSectionGetClosurePermutation(PetscSection section, PetscObject obj, PetscInt depth, PetscInt clSize, IS *perm)
2761ea844a1aSMatthew Knepley {
2762ea844a1aSMatthew Knepley   const PetscInt *clPerm;
2763ea844a1aSMatthew Knepley 
2764ea844a1aSMatthew Knepley   PetscFunctionBegin;
27659566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetClosurePermutation_Internal(section, obj, depth, clSize, &clPerm));
27669566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(PETSC_COMM_SELF, clSize, clPerm, PETSC_USE_POINTER, perm));
2767ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2768ea844a1aSMatthew Knepley }
2769ea844a1aSMatthew Knepley 
2770c459fbc1SJed Brown PetscErrorCode PetscSectionGetClosureInversePermutation_Internal(PetscSection section, PetscObject obj, PetscInt depth, PetscInt size, const PetscInt *perm[])
2771ea844a1aSMatthew Knepley {
2772ea844a1aSMatthew Knepley   PetscFunctionBegin;
2773c459fbc1SJed Brown   if (section->clObj == obj && section->clHash) {
2774c459fbc1SJed Brown     PetscSectionClosurePermKey k = {depth, size};
2775c459fbc1SJed Brown     PetscSectionClosurePermVal v;
27769566063dSJacob Faibussowitsch     PetscCall(PetscClPermGet(section->clHash, k, &v));
2777c459fbc1SJed Brown     if (perm) *perm = v.invPerm;
2778ea844a1aSMatthew Knepley   } else {
2779ea844a1aSMatthew Knepley     if (perm) *perm = NULL;
2780ea844a1aSMatthew Knepley   }
2781ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2782ea844a1aSMatthew Knepley }
2783ea844a1aSMatthew Knepley 
2784ea844a1aSMatthew Knepley /*@
2785ea844a1aSMatthew Knepley   PetscSectionGetClosureInversePermutation - Get the inverse dof permutation for the closure of each cell in the section, meaning clPerm[oldIndex] = newIndex.
2786ea844a1aSMatthew Knepley 
278740750d41SVaclav Hapla   Not Collective
2788ea844a1aSMatthew Knepley 
2789ea844a1aSMatthew Knepley   Input Parameters:
2790ea844a1aSMatthew Knepley + section   - The PetscSection
2791c459fbc1SJed Brown . obj       - A PetscObject which serves as the key for this index (usually a DM)
2792c459fbc1SJed Brown . depth     - Depth stratum on which to obtain closure permutation
2793c459fbc1SJed Brown - clSize    - Closure size to be permuted (e.g., may vary with element topology and degree)
2794ea844a1aSMatthew Knepley 
2795ea844a1aSMatthew Knepley   Output Parameters:
2796c459fbc1SJed Brown . perm - The dof closure permutation
2797ea844a1aSMatthew Knepley 
2798c459fbc1SJed Brown   Note:
2799ea844a1aSMatthew Knepley   The user must destroy the IS that is returned.
2800ea844a1aSMatthew Knepley 
2801ea844a1aSMatthew Knepley   Level: intermediate
2802ea844a1aSMatthew Knepley 
2803ea844a1aSMatthew Knepley .seealso: PetscSectionSetClosurePermutation(), PetscSectionGetClosureIndex(), PetscSectionSetClosureIndex(), DMPlexCreateClosureIndex()
2804ea844a1aSMatthew Knepley @*/
2805c459fbc1SJed Brown PetscErrorCode PetscSectionGetClosureInversePermutation(PetscSection section, PetscObject obj, PetscInt depth, PetscInt clSize, IS *perm)
2806ea844a1aSMatthew Knepley {
2807ea844a1aSMatthew Knepley   const PetscInt *clPerm;
2808ea844a1aSMatthew Knepley 
2809ea844a1aSMatthew Knepley   PetscFunctionBegin;
28109566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetClosureInversePermutation_Internal(section, obj, depth, clSize, &clPerm));
28119566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(PETSC_COMM_SELF, clSize, clPerm, PETSC_USE_POINTER, perm));
2812ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2813ea844a1aSMatthew Knepley }
2814ea844a1aSMatthew Knepley 
2815ea844a1aSMatthew Knepley /*@
2816ea844a1aSMatthew Knepley   PetscSectionGetField - Get the subsection associated with a single field
2817ea844a1aSMatthew Knepley 
2818ea844a1aSMatthew Knepley   Input Parameters:
2819ea844a1aSMatthew Knepley + s     - The PetscSection
2820ea844a1aSMatthew Knepley - field - The field number
2821ea844a1aSMatthew Knepley 
2822ea844a1aSMatthew Knepley   Output Parameter:
2823ea844a1aSMatthew Knepley . subs  - The subsection for the given field
2824ea844a1aSMatthew Knepley 
2825ea844a1aSMatthew Knepley   Level: intermediate
2826ea844a1aSMatthew Knepley 
2827ea844a1aSMatthew Knepley .seealso: PetscSectionSetNumFields()
2828ea844a1aSMatthew Knepley @*/
2829ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetField(PetscSection s, PetscInt field, PetscSection *subs)
2830ea844a1aSMatthew Knepley {
2831ea844a1aSMatthew Knepley   PetscFunctionBegin;
2832ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s,PETSC_SECTION_CLASSID,1);
2833ea844a1aSMatthew Knepley   PetscValidPointer(subs,3);
28342abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,s->numFields);
2835ea844a1aSMatthew Knepley   *subs = s->field[field];
2836ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2837ea844a1aSMatthew Knepley }
2838ea844a1aSMatthew Knepley 
2839ea844a1aSMatthew Knepley PetscClassId      PETSC_SECTION_SYM_CLASSID;
2840ea844a1aSMatthew Knepley PetscFunctionList PetscSectionSymList = NULL;
2841ea844a1aSMatthew Knepley 
2842ea844a1aSMatthew Knepley /*@
2843ea844a1aSMatthew Knepley   PetscSectionSymCreate - Creates an empty PetscSectionSym object.
2844ea844a1aSMatthew Knepley 
2845ea844a1aSMatthew Knepley   Collective
2846ea844a1aSMatthew Knepley 
2847ea844a1aSMatthew Knepley   Input Parameter:
2848ea844a1aSMatthew Knepley . comm - the MPI communicator
2849ea844a1aSMatthew Knepley 
2850ea844a1aSMatthew Knepley   Output Parameter:
2851ea844a1aSMatthew Knepley . sym - pointer to the new set of symmetries
2852ea844a1aSMatthew Knepley 
2853ea844a1aSMatthew Knepley   Level: developer
2854ea844a1aSMatthew Knepley 
2855ea844a1aSMatthew Knepley .seealso: PetscSectionSym, PetscSectionSymDestroy()
2856ea844a1aSMatthew Knepley @*/
2857ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSymCreate(MPI_Comm comm, PetscSectionSym *sym)
2858ea844a1aSMatthew Knepley {
2859ea844a1aSMatthew Knepley   PetscFunctionBegin;
2860ea844a1aSMatthew Knepley   PetscValidPointer(sym,2);
28619566063dSJacob Faibussowitsch   PetscCall(ISInitializePackage());
28629566063dSJacob Faibussowitsch   PetscCall(PetscHeaderCreate(*sym,PETSC_SECTION_SYM_CLASSID,"PetscSectionSym","Section Symmetry","IS",comm,PetscSectionSymDestroy,PetscSectionSymView));
2863ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2864ea844a1aSMatthew Knepley }
2865ea844a1aSMatthew Knepley 
2866ea844a1aSMatthew Knepley /*@C
2867ea844a1aSMatthew Knepley   PetscSectionSymSetType - Builds a PetscSection symmetry, for a particular implementation.
2868ea844a1aSMatthew Knepley 
286940750d41SVaclav Hapla   Collective
2870ea844a1aSMatthew Knepley 
2871ea844a1aSMatthew Knepley   Input Parameters:
2872ea844a1aSMatthew Knepley + sym    - The section symmetry object
2873ea844a1aSMatthew Knepley - method - The name of the section symmetry type
2874ea844a1aSMatthew Knepley 
2875ea844a1aSMatthew Knepley   Level: developer
2876ea844a1aSMatthew Knepley 
2877ea844a1aSMatthew Knepley .seealso: PetscSectionSymGetType(), PetscSectionSymCreate()
2878ea844a1aSMatthew Knepley @*/
2879ea844a1aSMatthew Knepley PetscErrorCode  PetscSectionSymSetType(PetscSectionSym sym, PetscSectionSymType method)
2880ea844a1aSMatthew Knepley {
2881ea844a1aSMatthew Knepley   PetscErrorCode (*r)(PetscSectionSym);
2882ea844a1aSMatthew Knepley   PetscBool      match;
2883ea844a1aSMatthew Knepley 
2884ea844a1aSMatthew Knepley   PetscFunctionBegin;
2885ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID,1);
28869566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject) sym, method, &match));
2887ea844a1aSMatthew Knepley   if (match) PetscFunctionReturn(0);
2888ea844a1aSMatthew Knepley 
28899566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListFind(PetscSectionSymList,method,&r));
289028b400f6SJacob Faibussowitsch   PetscCheck(r,PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown PetscSectionSym type: %s", method);
2891ea844a1aSMatthew Knepley   if (sym->ops->destroy) {
28929566063dSJacob Faibussowitsch     PetscCall((*sym->ops->destroy)(sym));
2893ea844a1aSMatthew Knepley     sym->ops->destroy = NULL;
2894ea844a1aSMatthew Knepley   }
28959566063dSJacob Faibussowitsch   PetscCall((*r)(sym));
28969566063dSJacob Faibussowitsch   PetscCall(PetscObjectChangeTypeName((PetscObject)sym,method));
2897ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2898ea844a1aSMatthew Knepley }
2899ea844a1aSMatthew Knepley 
2900ea844a1aSMatthew Knepley /*@C
2901ea844a1aSMatthew Knepley   PetscSectionSymGetType - Gets the section symmetry type name (as a string) from the PetscSectionSym.
2902ea844a1aSMatthew Knepley 
2903ea844a1aSMatthew Knepley   Not Collective
2904ea844a1aSMatthew Knepley 
2905ea844a1aSMatthew Knepley   Input Parameter:
2906ea844a1aSMatthew Knepley . sym  - The section symmetry
2907ea844a1aSMatthew Knepley 
2908ea844a1aSMatthew Knepley   Output Parameter:
2909ea844a1aSMatthew Knepley . type - The index set type name
2910ea844a1aSMatthew Knepley 
2911ea844a1aSMatthew Knepley   Level: developer
2912ea844a1aSMatthew Knepley 
2913ea844a1aSMatthew Knepley .seealso: PetscSectionSymSetType(), PetscSectionSymCreate()
2914ea844a1aSMatthew Knepley @*/
2915ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSymGetType(PetscSectionSym sym, PetscSectionSymType *type)
2916ea844a1aSMatthew Knepley {
2917ea844a1aSMatthew Knepley   PetscFunctionBegin;
2918ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID,1);
2919dadcf809SJacob Faibussowitsch   PetscValidPointer(type,2);
2920ea844a1aSMatthew Knepley   *type = ((PetscObject)sym)->type_name;
2921ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2922ea844a1aSMatthew Knepley }
2923ea844a1aSMatthew Knepley 
2924ea844a1aSMatthew Knepley /*@C
2925ea844a1aSMatthew Knepley   PetscSectionSymRegister - Adds a new section symmetry implementation
2926ea844a1aSMatthew Knepley 
2927ea844a1aSMatthew Knepley   Not Collective
2928ea844a1aSMatthew Knepley 
2929ea844a1aSMatthew Knepley   Input Parameters:
2930ea844a1aSMatthew Knepley + name        - The name of a new user-defined creation routine
2931ea844a1aSMatthew Knepley - create_func - The creation routine itself
2932ea844a1aSMatthew Knepley 
2933ea844a1aSMatthew Knepley   Notes:
2934ea844a1aSMatthew Knepley   PetscSectionSymRegister() may be called multiple times to add several user-defined vectors
2935ea844a1aSMatthew Knepley 
2936ea844a1aSMatthew Knepley   Level: developer
2937ea844a1aSMatthew Knepley 
2938ea844a1aSMatthew Knepley .seealso: PetscSectionSymCreate(), PetscSectionSymSetType()
2939ea844a1aSMatthew Knepley @*/
2940ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSymRegister(const char sname[], PetscErrorCode (*function)(PetscSectionSym))
2941ea844a1aSMatthew Knepley {
2942ea844a1aSMatthew Knepley   PetscFunctionBegin;
29439566063dSJacob Faibussowitsch   PetscCall(ISInitializePackage());
29449566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListAdd(&PetscSectionSymList,sname,function));
2945ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2946ea844a1aSMatthew Knepley }
2947ea844a1aSMatthew Knepley 
2948ea844a1aSMatthew Knepley /*@
2949ea844a1aSMatthew Knepley    PetscSectionSymDestroy - Destroys a section symmetry.
2950ea844a1aSMatthew Knepley 
295140750d41SVaclav Hapla    Collective
2952ea844a1aSMatthew Knepley 
2953ea844a1aSMatthew Knepley    Input Parameters:
2954ea844a1aSMatthew Knepley .  sym - the section symmetry
2955ea844a1aSMatthew Knepley 
2956ea844a1aSMatthew Knepley    Level: developer
2957ea844a1aSMatthew Knepley 
2958ea844a1aSMatthew Knepley .seealso: PetscSectionSymCreate(), PetscSectionSymDestroy()
2959ea844a1aSMatthew Knepley @*/
2960ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSymDestroy(PetscSectionSym *sym)
2961ea844a1aSMatthew Knepley {
2962ea844a1aSMatthew Knepley   SymWorkLink    link,next;
2963ea844a1aSMatthew Knepley 
2964ea844a1aSMatthew Knepley   PetscFunctionBegin;
2965ea844a1aSMatthew Knepley   if (!*sym) PetscFunctionReturn(0);
2966ea844a1aSMatthew Knepley   PetscValidHeaderSpecific((*sym),PETSC_SECTION_SYM_CLASSID,1);
29674c8fdceaSLisandro Dalcin   if (--((PetscObject)(*sym))->refct > 0) {*sym = NULL; PetscFunctionReturn(0);}
2968ea844a1aSMatthew Knepley   if ((*sym)->ops->destroy) {
29699566063dSJacob Faibussowitsch     PetscCall((*(*sym)->ops->destroy)(*sym));
2970ea844a1aSMatthew Knepley   }
29712c71b3e2SJacob Faibussowitsch   PetscCheckFalse((*sym)->workout,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Work array still checked out");
2972ea844a1aSMatthew Knepley   for (link=(*sym)->workin; link; link=next) {
2973ea844a1aSMatthew Knepley     next = link->next;
29749566063dSJacob Faibussowitsch     PetscCall(PetscFree2(link->perms,link->rots));
29759566063dSJacob Faibussowitsch     PetscCall(PetscFree(link));
2976ea844a1aSMatthew Knepley   }
2977ea844a1aSMatthew Knepley   (*sym)->workin = NULL;
29789566063dSJacob Faibussowitsch   PetscCall(PetscHeaderDestroy(sym));
2979ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2980ea844a1aSMatthew Knepley }
2981ea844a1aSMatthew Knepley 
2982ea844a1aSMatthew Knepley /*@C
2983ea844a1aSMatthew Knepley    PetscSectionSymView - Displays a section symmetry
2984ea844a1aSMatthew Knepley 
298540750d41SVaclav Hapla    Collective
2986ea844a1aSMatthew Knepley 
2987ea844a1aSMatthew Knepley    Input Parameters:
2988ea844a1aSMatthew Knepley +  sym - the index set
2989ea844a1aSMatthew Knepley -  viewer - viewer used to display the set, for example PETSC_VIEWER_STDOUT_SELF.
2990ea844a1aSMatthew Knepley 
2991ea844a1aSMatthew Knepley    Level: developer
2992ea844a1aSMatthew Knepley 
2993ea844a1aSMatthew Knepley .seealso: PetscViewerASCIIOpen()
2994ea844a1aSMatthew Knepley @*/
2995ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSymView(PetscSectionSym sym,PetscViewer viewer)
2996ea844a1aSMatthew Knepley {
2997ea844a1aSMatthew Knepley   PetscFunctionBegin;
2998ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(sym,PETSC_SECTION_SYM_CLASSID,1);
2999ea844a1aSMatthew Knepley   if (!viewer) {
30009566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)sym),&viewer));
3001ea844a1aSMatthew Knepley   }
3002ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
3003ea844a1aSMatthew Knepley   PetscCheckSameComm(sym,1,viewer,2);
30049566063dSJacob Faibussowitsch   PetscCall(PetscObjectPrintClassNamePrefixType((PetscObject)sym,viewer));
3005ea844a1aSMatthew Knepley   if (sym->ops->view) {
30069566063dSJacob Faibussowitsch     PetscCall((*sym->ops->view)(sym,viewer));
3007ea844a1aSMatthew Knepley   }
3008ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3009ea844a1aSMatthew Knepley }
3010ea844a1aSMatthew Knepley 
3011ea844a1aSMatthew Knepley /*@
3012ea844a1aSMatthew Knepley   PetscSectionSetSym - Set the symmetries for the data referred to by the section
3013ea844a1aSMatthew Knepley 
301440750d41SVaclav Hapla   Collective
3015ea844a1aSMatthew Knepley 
3016ea844a1aSMatthew Knepley   Input Parameters:
3017ea844a1aSMatthew Knepley + section - the section describing data layout
3018ea844a1aSMatthew Knepley - sym - the symmetry describing the affect of orientation on the access of the data
3019ea844a1aSMatthew Knepley 
3020ea844a1aSMatthew Knepley   Level: developer
3021ea844a1aSMatthew Knepley 
3022ea844a1aSMatthew Knepley .seealso: PetscSectionGetSym(), PetscSectionSymCreate()
3023ea844a1aSMatthew Knepley @*/
3024ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetSym(PetscSection section, PetscSectionSym sym)
3025ea844a1aSMatthew Knepley {
3026ea844a1aSMatthew Knepley   PetscFunctionBegin;
3027ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,1);
30289566063dSJacob Faibussowitsch   PetscCall(PetscSectionSymDestroy(&(section->sym)));
3029ea844a1aSMatthew Knepley   if (sym) {
3030ea844a1aSMatthew Knepley     PetscValidHeaderSpecific(sym,PETSC_SECTION_SYM_CLASSID,2);
3031ea844a1aSMatthew Knepley     PetscCheckSameComm(section,1,sym,2);
30329566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject) sym));
3033ea844a1aSMatthew Knepley   }
3034ea844a1aSMatthew Knepley   section->sym = sym;
3035ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3036ea844a1aSMatthew Knepley }
3037ea844a1aSMatthew Knepley 
3038ea844a1aSMatthew Knepley /*@
3039ea844a1aSMatthew Knepley   PetscSectionGetSym - Get the symmetries for the data referred to by the section
3040ea844a1aSMatthew Knepley 
304140750d41SVaclav Hapla   Not Collective
3042ea844a1aSMatthew Knepley 
3043ea844a1aSMatthew Knepley   Input Parameters:
3044ea844a1aSMatthew Knepley . section - the section describing data layout
3045ea844a1aSMatthew Knepley 
3046ea844a1aSMatthew Knepley   Output Parameters:
3047ea844a1aSMatthew Knepley . sym - the symmetry describing the affect of orientation on the access of the data
3048ea844a1aSMatthew Knepley 
3049ea844a1aSMatthew Knepley   Level: developer
3050ea844a1aSMatthew Knepley 
3051ea844a1aSMatthew Knepley .seealso: PetscSectionSetSym(), PetscSectionSymCreate()
3052ea844a1aSMatthew Knepley @*/
3053ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetSym(PetscSection section, PetscSectionSym *sym)
3054ea844a1aSMatthew Knepley {
3055ea844a1aSMatthew Knepley   PetscFunctionBegin;
3056ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,1);
3057ea844a1aSMatthew Knepley   *sym = section->sym;
3058ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3059ea844a1aSMatthew Knepley }
3060ea844a1aSMatthew Knepley 
3061ea844a1aSMatthew Knepley /*@
3062ea844a1aSMatthew Knepley   PetscSectionSetFieldSym - Set the symmetries for the data referred to by a field of the section
3063ea844a1aSMatthew Knepley 
306440750d41SVaclav Hapla   Collective
3065ea844a1aSMatthew Knepley 
3066ea844a1aSMatthew Knepley   Input Parameters:
3067ea844a1aSMatthew Knepley + section - the section describing data layout
3068ea844a1aSMatthew Knepley . field - the field number
3069ea844a1aSMatthew Knepley - sym - the symmetry describing the affect of orientation on the access of the data
3070ea844a1aSMatthew Knepley 
3071ea844a1aSMatthew Knepley   Level: developer
3072ea844a1aSMatthew Knepley 
3073ea844a1aSMatthew Knepley .seealso: PetscSectionGetFieldSym(), PetscSectionSymCreate()
3074ea844a1aSMatthew Knepley @*/
3075ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetFieldSym(PetscSection section, PetscInt field, PetscSectionSym sym)
3076ea844a1aSMatthew Knepley {
3077ea844a1aSMatthew Knepley   PetscFunctionBegin;
3078ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,1);
30792abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,section->numFields);
30809566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetSym(section->field[field],sym));
3081ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3082ea844a1aSMatthew Knepley }
3083ea844a1aSMatthew Knepley 
3084ea844a1aSMatthew Knepley /*@
3085ea844a1aSMatthew Knepley   PetscSectionGetFieldSym - Get the symmetries for the data referred to by a field of the section
3086ea844a1aSMatthew Knepley 
308740750d41SVaclav Hapla   Collective
3088ea844a1aSMatthew Knepley 
3089ea844a1aSMatthew Knepley   Input Parameters:
3090ea844a1aSMatthew Knepley + section - the section describing data layout
3091ea844a1aSMatthew Knepley - field - the field number
3092ea844a1aSMatthew Knepley 
3093ea844a1aSMatthew Knepley   Output Parameters:
3094ea844a1aSMatthew Knepley . sym - the symmetry describing the affect of orientation on the access of the data
3095ea844a1aSMatthew Knepley 
3096ea844a1aSMatthew Knepley   Level: developer
3097ea844a1aSMatthew Knepley 
3098ea844a1aSMatthew Knepley .seealso: PetscSectionSetFieldSym(), PetscSectionSymCreate()
3099ea844a1aSMatthew Knepley @*/
3100ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetFieldSym(PetscSection section, PetscInt field, PetscSectionSym *sym)
3101ea844a1aSMatthew Knepley {
3102ea844a1aSMatthew Knepley   PetscFunctionBegin;
3103ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,1);
31042abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field,section->numFields);
3105ea844a1aSMatthew Knepley   *sym = section->field[field]->sym;
3106ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3107ea844a1aSMatthew Knepley }
3108ea844a1aSMatthew Knepley 
3109ea844a1aSMatthew Knepley /*@C
3110ea844a1aSMatthew Knepley   PetscSectionGetPointSyms - Get the symmetries for a set of points in a PetscSection under specific orientations.
3111ea844a1aSMatthew Knepley 
311240750d41SVaclav Hapla   Not Collective
3113ea844a1aSMatthew Knepley 
3114ea844a1aSMatthew Knepley   Input Parameters:
3115ea844a1aSMatthew Knepley + section - the section
3116ea844a1aSMatthew Knepley . numPoints - the number of points
3117ea844a1aSMatthew Knepley - points - an array of size 2 * numPoints, containing a list of (point, orientation) pairs. (An orientation is an
3118ea844a1aSMatthew Knepley     arbitrary integer: its interpretation is up to sym.  Orientations are used by DM: for their interpretation in that
3119ea844a1aSMatthew Knepley     context, see DMPlexGetConeOrientation()).
3120ea844a1aSMatthew Knepley 
3121d8d19677SJose E. Roman   Output Parameters:
3122ea844a1aSMatthew Knepley + perms - The permutations for the given orientations (or NULL if there is no symmetry or the permutation is the identity).
3123ea844a1aSMatthew Knepley - rots - The field rotations symmetries for the given orientations (or NULL if there is no symmetry or the rotations are all
3124ea844a1aSMatthew Knepley     identity).
3125ea844a1aSMatthew Knepley 
3126ea844a1aSMatthew Knepley   Example of usage, gathering dofs into a local array (lArray) from a section array (sArray):
3127ea844a1aSMatthew Knepley .vb
3128ea844a1aSMatthew Knepley      const PetscInt    **perms;
3129ea844a1aSMatthew Knepley      const PetscScalar **rots;
3130ea844a1aSMatthew Knepley      PetscInt            lOffset;
3131ea844a1aSMatthew Knepley 
3132ea844a1aSMatthew Knepley      PetscSectionGetPointSyms(section,numPoints,points,&perms,&rots);
3133ea844a1aSMatthew Knepley      for (i = 0, lOffset = 0; i < numPoints; i++) {
3134ea844a1aSMatthew Knepley        PetscInt           point = points[2*i], dof, sOffset;
3135ea844a1aSMatthew Knepley        const PetscInt    *perm  = perms ? perms[i] : NULL;
3136ea844a1aSMatthew Knepley        const PetscScalar *rot   = rots  ? rots[i]  : NULL;
3137ea844a1aSMatthew Knepley 
3138ea844a1aSMatthew Knepley        PetscSectionGetDof(section,point,&dof);
3139ea844a1aSMatthew Knepley        PetscSectionGetOffset(section,point,&sOffset);
3140ea844a1aSMatthew Knepley 
3141ea844a1aSMatthew Knepley        if (perm) {for (j = 0; j < dof; j++) {lArray[lOffset + perm[j]]  = sArray[sOffset + j];}}
3142ea844a1aSMatthew Knepley        else      {for (j = 0; j < dof; j++) {lArray[lOffset +      j ]  = sArray[sOffset + j];}}
3143ea844a1aSMatthew Knepley        if (rot)  {for (j = 0; j < dof; j++) {lArray[lOffset +      j ] *= rot[j];             }}
3144ea844a1aSMatthew Knepley        lOffset += dof;
3145ea844a1aSMatthew Knepley      }
3146ea844a1aSMatthew Knepley      PetscSectionRestorePointSyms(section,numPoints,points,&perms,&rots);
3147ea844a1aSMatthew Knepley .ve
3148ea844a1aSMatthew Knepley 
3149ea844a1aSMatthew Knepley   Example of usage, adding dofs into a section array (sArray) from a local array (lArray):
3150ea844a1aSMatthew Knepley .vb
3151ea844a1aSMatthew Knepley      const PetscInt    **perms;
3152ea844a1aSMatthew Knepley      const PetscScalar **rots;
3153ea844a1aSMatthew Knepley      PetscInt            lOffset;
3154ea844a1aSMatthew Knepley 
3155ea844a1aSMatthew Knepley      PetscSectionGetPointSyms(section,numPoints,points,&perms,&rots);
3156ea844a1aSMatthew Knepley      for (i = 0, lOffset = 0; i < numPoints; i++) {
3157ea844a1aSMatthew Knepley        PetscInt           point = points[2*i], dof, sOffset;
3158ea844a1aSMatthew Knepley        const PetscInt    *perm  = perms ? perms[i] : NULL;
3159ea844a1aSMatthew Knepley        const PetscScalar *rot   = rots  ? rots[i]  : NULL;
3160ea844a1aSMatthew Knepley 
3161ea844a1aSMatthew Knepley        PetscSectionGetDof(section,point,&dof);
3162ea844a1aSMatthew Knepley        PetscSectionGetOffset(section,point,&sOff);
3163ea844a1aSMatthew Knepley 
3164ea844a1aSMatthew Knepley        if (perm) {for (j = 0; j < dof; j++) {sArray[sOffset + j] += lArray[lOffset + perm[j]] * (rot ? PetscConj(rot[perm[j]]) : 1.);}}
3165ea844a1aSMatthew Knepley        else      {for (j = 0; j < dof; j++) {sArray[sOffset + j] += lArray[lOffset +      j ] * (rot ? PetscConj(rot[     j ]) : 1.);}}
3166ea844a1aSMatthew Knepley        offset += dof;
3167ea844a1aSMatthew Knepley      }
3168ea844a1aSMatthew Knepley      PetscSectionRestorePointSyms(section,numPoints,points,&perms,&rots);
3169ea844a1aSMatthew Knepley .ve
3170ea844a1aSMatthew Knepley 
3171ea844a1aSMatthew Knepley   Level: developer
3172ea844a1aSMatthew Knepley 
3173ea844a1aSMatthew Knepley .seealso: PetscSectionRestorePointSyms(), PetscSectionSymCreate(), PetscSectionSetSym(), PetscSectionGetSym()
3174ea844a1aSMatthew Knepley @*/
3175ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetPointSyms(PetscSection section, PetscInt numPoints, const PetscInt *points, const PetscInt ***perms, const PetscScalar ***rots)
3176ea844a1aSMatthew Knepley {
3177ea844a1aSMatthew Knepley   PetscSectionSym sym;
3178ea844a1aSMatthew Knepley 
3179ea844a1aSMatthew Knepley   PetscFunctionBegin;
3180ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,1);
3181ea844a1aSMatthew Knepley   if (numPoints) PetscValidIntPointer(points,3);
3182ea844a1aSMatthew Knepley   if (perms) *perms = NULL;
3183ea844a1aSMatthew Knepley   if (rots)  *rots  = NULL;
3184ea844a1aSMatthew Knepley   sym = section->sym;
3185ea844a1aSMatthew Knepley   if (sym && (perms || rots)) {
3186ea844a1aSMatthew Knepley     SymWorkLink link;
3187ea844a1aSMatthew Knepley 
3188ea844a1aSMatthew Knepley     if (sym->workin) {
3189ea844a1aSMatthew Knepley       link        = sym->workin;
3190ea844a1aSMatthew Knepley       sym->workin = sym->workin->next;
3191ea844a1aSMatthew Knepley     } else {
31929566063dSJacob Faibussowitsch       PetscCall(PetscNewLog(sym,&link));
3193ea844a1aSMatthew Knepley     }
3194ea844a1aSMatthew Knepley     if (numPoints > link->numPoints) {
31959566063dSJacob Faibussowitsch       PetscCall(PetscFree2(link->perms,link->rots));
31969566063dSJacob Faibussowitsch       PetscCall(PetscMalloc2(numPoints,&link->perms,numPoints,&link->rots));
3197ea844a1aSMatthew Knepley       link->numPoints = numPoints;
3198ea844a1aSMatthew Knepley     }
3199ea844a1aSMatthew Knepley     link->next   = sym->workout;
3200ea844a1aSMatthew Knepley     sym->workout = link;
32019566063dSJacob Faibussowitsch     PetscCall(PetscArrayzero((PetscInt**)link->perms,numPoints));
32029566063dSJacob Faibussowitsch     PetscCall(PetscArrayzero((PetscInt**)link->rots,numPoints));
32039566063dSJacob Faibussowitsch     PetscCall((*sym->ops->getpoints) (sym, section, numPoints, points, link->perms, link->rots));
3204ea844a1aSMatthew Knepley     if (perms) *perms = link->perms;
3205ea844a1aSMatthew Knepley     if (rots)  *rots  = link->rots;
3206ea844a1aSMatthew Knepley   }
3207ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3208ea844a1aSMatthew Knepley }
3209ea844a1aSMatthew Knepley 
3210ea844a1aSMatthew Knepley /*@C
3211ea844a1aSMatthew Knepley   PetscSectionRestorePointSyms - Restore the symmetries returned by PetscSectionGetPointSyms()
3212ea844a1aSMatthew Knepley 
321340750d41SVaclav Hapla   Not Collective
3214ea844a1aSMatthew Knepley 
3215ea844a1aSMatthew Knepley   Input Parameters:
3216ea844a1aSMatthew Knepley + section - the section
3217ea844a1aSMatthew Knepley . numPoints - the number of points
3218ea844a1aSMatthew Knepley - points - an array of size 2 * numPoints, containing a list of (point, orientation) pairs. (An orientation is an
3219ea844a1aSMatthew Knepley     arbitrary integer: its interpretation is up to sym.  Orientations are used by DM: for their interpretation in that
3220ea844a1aSMatthew Knepley     context, see DMPlexGetConeOrientation()).
3221ea844a1aSMatthew Knepley 
3222d8d19677SJose E. Roman   Output Parameters:
3223ea844a1aSMatthew Knepley + perms - The permutations for the given orientations: set to NULL at conclusion
3224ea844a1aSMatthew Knepley - rots - The field rotations symmetries for the given orientations: set to NULL at conclusion
3225ea844a1aSMatthew Knepley 
3226ea844a1aSMatthew Knepley   Level: developer
3227ea844a1aSMatthew Knepley 
3228ea844a1aSMatthew Knepley .seealso: PetscSectionGetPointSyms(), PetscSectionSymCreate(), PetscSectionSetSym(), PetscSectionGetSym()
3229ea844a1aSMatthew Knepley @*/
3230ea844a1aSMatthew Knepley PetscErrorCode PetscSectionRestorePointSyms(PetscSection section, PetscInt numPoints, const PetscInt *points, const PetscInt ***perms, const PetscScalar ***rots)
3231ea844a1aSMatthew Knepley {
3232ea844a1aSMatthew Knepley   PetscSectionSym sym;
3233ea844a1aSMatthew Knepley 
3234ea844a1aSMatthew Knepley   PetscFunctionBegin;
3235ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,1);
3236ea844a1aSMatthew Knepley   sym = section->sym;
3237ea844a1aSMatthew Knepley   if (sym && (perms || rots)) {
3238ea844a1aSMatthew Knepley     SymWorkLink *p,link;
3239ea844a1aSMatthew Knepley 
3240ea844a1aSMatthew Knepley     for (p=&sym->workout; (link=*p); p=&link->next) {
3241ea844a1aSMatthew Knepley       if ((perms && link->perms == *perms) || (rots && link->rots == *rots)) {
3242ea844a1aSMatthew Knepley         *p          = link->next;
3243ea844a1aSMatthew Knepley         link->next  = sym->workin;
3244ea844a1aSMatthew Knepley         sym->workin = link;
3245ea844a1aSMatthew Knepley         if (perms) *perms = NULL;
3246ea844a1aSMatthew Knepley         if (rots)  *rots  = NULL;
3247ea844a1aSMatthew Knepley         PetscFunctionReturn(0);
3248ea844a1aSMatthew Knepley       }
3249ea844a1aSMatthew Knepley     }
3250ea844a1aSMatthew Knepley     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Array was not checked out");
3251ea844a1aSMatthew Knepley   }
3252ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3253ea844a1aSMatthew Knepley }
3254ea844a1aSMatthew Knepley 
3255ea844a1aSMatthew Knepley /*@C
3256ea844a1aSMatthew Knepley   PetscSectionGetFieldPointSyms - Get the symmetries for a set of points in a field of a PetscSection under specific orientations.
3257ea844a1aSMatthew Knepley 
325840750d41SVaclav Hapla   Not Collective
3259ea844a1aSMatthew Knepley 
3260ea844a1aSMatthew Knepley   Input Parameters:
3261ea844a1aSMatthew Knepley + section - the section
3262ea844a1aSMatthew Knepley . field - the field of the section
3263ea844a1aSMatthew Knepley . numPoints - the number of points
3264ea844a1aSMatthew Knepley - points - an array of size 2 * numPoints, containing a list of (point, orientation) pairs. (An orientation is an
3265ea844a1aSMatthew Knepley     arbitrary integer: its interpretation is up to sym.  Orientations are used by DM: for their interpretation in that
3266ea844a1aSMatthew Knepley     context, see DMPlexGetConeOrientation()).
3267ea844a1aSMatthew Knepley 
3268d8d19677SJose E. Roman   Output Parameters:
3269ea844a1aSMatthew Knepley + perms - The permutations for the given orientations (or NULL if there is no symmetry or the permutation is the identity).
3270ea844a1aSMatthew Knepley - rots - The field rotations symmetries for the given orientations (or NULL if there is no symmetry or the rotations are all
3271ea844a1aSMatthew Knepley     identity).
3272ea844a1aSMatthew Knepley 
3273ea844a1aSMatthew Knepley   Level: developer
3274ea844a1aSMatthew Knepley 
3275ea844a1aSMatthew Knepley .seealso: PetscSectionGetPointSyms(), PetscSectionRestoreFieldPointSyms()
3276ea844a1aSMatthew Knepley @*/
3277ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetFieldPointSyms(PetscSection section, PetscInt field, PetscInt numPoints, const PetscInt *points, const PetscInt ***perms, const PetscScalar ***rots)
3278ea844a1aSMatthew Knepley {
3279ea844a1aSMatthew Knepley   PetscFunctionBegin;
3280ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,1);
32812c71b3e2SJacob 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);
32829566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetPointSyms(section->field[field],numPoints,points,perms,rots));
3283ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3284ea844a1aSMatthew Knepley }
3285ea844a1aSMatthew Knepley 
3286ea844a1aSMatthew Knepley /*@C
3287ea844a1aSMatthew Knepley   PetscSectionRestoreFieldPointSyms - Restore the symmetries returned by PetscSectionGetFieldPointSyms()
3288ea844a1aSMatthew Knepley 
328940750d41SVaclav Hapla   Not Collective
3290ea844a1aSMatthew Knepley 
3291ea844a1aSMatthew Knepley   Input Parameters:
3292ea844a1aSMatthew Knepley + section - the section
3293ea844a1aSMatthew Knepley . field - the field number
3294ea844a1aSMatthew Knepley . numPoints - the number of points
3295ea844a1aSMatthew Knepley - points - an array of size 2 * numPoints, containing a list of (point, orientation) pairs. (An orientation is an
3296ea844a1aSMatthew Knepley     arbitrary integer: its interpretation is up to sym.  Orientations are used by DM: for their interpretation in that
3297ea844a1aSMatthew Knepley     context, see DMPlexGetConeOrientation()).
3298ea844a1aSMatthew Knepley 
3299d8d19677SJose E. Roman   Output Parameters:
3300ea844a1aSMatthew Knepley + perms - The permutations for the given orientations: set to NULL at conclusion
3301ea844a1aSMatthew Knepley - rots - The field rotations symmetries for the given orientations: set to NULL at conclusion
3302ea844a1aSMatthew Knepley 
3303ea844a1aSMatthew Knepley   Level: developer
3304ea844a1aSMatthew Knepley 
3305ea844a1aSMatthew Knepley .seealso: PetscSectionRestorePointSyms(), petscSectionGetFieldPointSyms(), PetscSectionSymCreate(), PetscSectionSetSym(), PetscSectionGetSym()
3306ea844a1aSMatthew Knepley @*/
3307ea844a1aSMatthew Knepley PetscErrorCode PetscSectionRestoreFieldPointSyms(PetscSection section, PetscInt field, PetscInt numPoints, const PetscInt *points, const PetscInt ***perms, const PetscScalar ***rots)
3308ea844a1aSMatthew Knepley {
3309ea844a1aSMatthew Knepley   PetscFunctionBegin;
3310ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,1);
33112c71b3e2SJacob 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);
33129566063dSJacob Faibussowitsch   PetscCall(PetscSectionRestorePointSyms(section->field[field],numPoints,points,perms,rots));
3313ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3314ea844a1aSMatthew Knepley }
3315ea844a1aSMatthew Knepley 
3316ea844a1aSMatthew Knepley /*@
3317b004864fSMatthew G. Knepley   PetscSectionSymCopy - Copy the symmetries, assuming that the point structure is compatible
3318b004864fSMatthew G. Knepley 
331940750d41SVaclav Hapla   Not Collective
3320b004864fSMatthew G. Knepley 
3321b004864fSMatthew G. Knepley   Input Parameter:
3322b004864fSMatthew G. Knepley . sym - the PetscSectionSym
3323b004864fSMatthew G. Knepley 
3324b004864fSMatthew G. Knepley   Output Parameter:
3325b004864fSMatthew G. Knepley . nsym - the equivalent symmetries
3326b004864fSMatthew G. Knepley 
3327b004864fSMatthew G. Knepley   Level: developer
3328b004864fSMatthew G. Knepley 
3329b004864fSMatthew G. Knepley .seealso: PetscSectionSymCreate(), PetscSectionSetSym(), PetscSectionGetSym(), PetscSectionSymLabelSetStratum(), PetscSectionGetPointSyms()
3330b004864fSMatthew G. Knepley @*/
3331b004864fSMatthew G. Knepley PetscErrorCode PetscSectionSymCopy(PetscSectionSym sym, PetscSectionSym nsym)
3332b004864fSMatthew G. Knepley {
3333b004864fSMatthew G. Knepley   PetscFunctionBegin;
3334b004864fSMatthew G. Knepley   PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID, 1);
3335b004864fSMatthew G. Knepley   PetscValidHeaderSpecific(nsym, PETSC_SECTION_SYM_CLASSID, 2);
33369566063dSJacob Faibussowitsch   if (sym->ops->copy) PetscCall((*sym->ops->copy)(sym, nsym));
3337b004864fSMatthew G. Knepley   PetscFunctionReturn(0);
3338b004864fSMatthew G. Knepley }
3339b004864fSMatthew G. Knepley 
3340b004864fSMatthew G. Knepley /*@
3341b004864fSMatthew G. Knepley   PetscSectionSymDistribute - Distribute the symmetries in accordance with the input SF
3342b004864fSMatthew G. Knepley 
3343b004864fSMatthew G. Knepley   Collective
3344b004864fSMatthew G. Knepley 
3345b004864fSMatthew G. Knepley   Input Parameters:
3346b004864fSMatthew G. Knepley + sym - the PetscSectionSym
3347b004864fSMatthew G. Knepley - migrationSF - the distribution map from roots to leaves
3348b004864fSMatthew G. Knepley 
3349b004864fSMatthew G. Knepley   Output Parameters:
3350b004864fSMatthew G. Knepley . dsym - the redistributed symmetries
3351b004864fSMatthew G. Knepley 
3352b004864fSMatthew G. Knepley   Level: developer
3353b004864fSMatthew G. Knepley 
3354b004864fSMatthew G. Knepley .seealso: PetscSectionSymCreate(), PetscSectionSetSym(), PetscSectionGetSym(), PetscSectionSymLabelSetStratum(), PetscSectionGetPointSyms()
3355b004864fSMatthew G. Knepley @*/
3356b004864fSMatthew G. Knepley PetscErrorCode PetscSectionSymDistribute(PetscSectionSym sym, PetscSF migrationSF, PetscSectionSym *dsym)
3357b004864fSMatthew G. Knepley {
3358b004864fSMatthew G. Knepley   PetscFunctionBegin;
3359b004864fSMatthew G. Knepley   PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID, 1);
3360b004864fSMatthew G. Knepley   PetscValidHeaderSpecific(migrationSF, PETSCSF_CLASSID, 2);
3361b004864fSMatthew G. Knepley   PetscValidPointer(dsym, 3);
33629566063dSJacob Faibussowitsch   if (sym->ops->distribute) PetscCall((*sym->ops->distribute)(sym, migrationSF, dsym));
3363b004864fSMatthew G. Knepley   PetscFunctionReturn(0);
3364b004864fSMatthew G. Knepley }
3365b004864fSMatthew G. Knepley 
3366b004864fSMatthew G. Knepley /*@
3367ea844a1aSMatthew Knepley   PetscSectionGetUseFieldOffsets - Get the flag to use field offsets directly in a global section, rather than just the point offset
3368ea844a1aSMatthew Knepley 
336940750d41SVaclav Hapla   Not Collective
3370ea844a1aSMatthew Knepley 
3371ea844a1aSMatthew Knepley   Input Parameter:
3372ea844a1aSMatthew Knepley . s - the global PetscSection
3373ea844a1aSMatthew Knepley 
3374ea844a1aSMatthew Knepley   Output Parameters:
3375ea844a1aSMatthew Knepley . flg - the flag
3376ea844a1aSMatthew Knepley 
3377ea844a1aSMatthew Knepley   Level: developer
3378ea844a1aSMatthew Knepley 
3379ea844a1aSMatthew Knepley .seealso: PetscSectionSetChart(), PetscSectionCreate()
3380ea844a1aSMatthew Knepley @*/
3381ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetUseFieldOffsets(PetscSection s, PetscBool *flg)
3382ea844a1aSMatthew Knepley {
3383ea844a1aSMatthew Knepley   PetscFunctionBegin;
3384ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
3385ea844a1aSMatthew Knepley   *flg = s->useFieldOff;
3386ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3387ea844a1aSMatthew Knepley }
3388ea844a1aSMatthew Knepley 
3389ea844a1aSMatthew Knepley /*@
3390ea844a1aSMatthew Knepley   PetscSectionSetUseFieldOffsets - Set the flag to use field offsets directly in a global section, rather than just the point offset
3391ea844a1aSMatthew Knepley 
339240750d41SVaclav Hapla   Not Collective
3393ea844a1aSMatthew Knepley 
3394ea844a1aSMatthew Knepley   Input Parameters:
3395ea844a1aSMatthew Knepley + s   - the global PetscSection
3396ea844a1aSMatthew Knepley - flg - the flag
3397ea844a1aSMatthew Knepley 
3398ea844a1aSMatthew Knepley   Level: developer
3399ea844a1aSMatthew Knepley 
3400ea844a1aSMatthew Knepley .seealso: PetscSectionGetUseFieldOffsets(), PetscSectionSetChart(), PetscSectionCreate()
3401ea844a1aSMatthew Knepley @*/
3402ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetUseFieldOffsets(PetscSection s, PetscBool flg)
3403ea844a1aSMatthew Knepley {
3404ea844a1aSMatthew Knepley   PetscFunctionBegin;
3405ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
3406ea844a1aSMatthew Knepley   s->useFieldOff = flg;
3407ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3408ea844a1aSMatthew Knepley }
3409ea844a1aSMatthew Knepley 
3410ea844a1aSMatthew Knepley #define PetscSectionExpandPoints_Loop(TYPE) \
3411ea844a1aSMatthew Knepley { \
3412ea844a1aSMatthew Knepley   PetscInt i, n, o0, o1, size; \
3413ea844a1aSMatthew Knepley   TYPE *a0 = (TYPE*)origArray, *a1; \
34149566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetStorageSize(s, &size)); \
34159566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(size, &a1)); \
3416ea844a1aSMatthew Knepley   for (i=0; i<npoints; i++) { \
34179566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(origSection, points_[i], &o0)); \
34189566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(s, i, &o1)); \
34199566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s, i, &n)); \
34209566063dSJacob Faibussowitsch     PetscCall(PetscMemcpy(&a1[o1], &a0[o0], n*unitsize)); \
3421ea844a1aSMatthew Knepley   } \
3422ea844a1aSMatthew Knepley   *newArray = (void*)a1; \
3423ea844a1aSMatthew Knepley }
3424ea844a1aSMatthew Knepley 
3425ea844a1aSMatthew Knepley /*@
3426ea844a1aSMatthew Knepley   PetscSectionExtractDofsFromArray - Extracts elements of an array corresponding to DOFs of specified points.
3427ea844a1aSMatthew Knepley 
342840750d41SVaclav Hapla   Not Collective
3429ea844a1aSMatthew Knepley 
3430ea844a1aSMatthew Knepley   Input Parameters:
3431ea844a1aSMatthew Knepley + origSection - the PetscSection describing the layout of the array
3432ea844a1aSMatthew Knepley . dataType - MPI_Datatype describing the data type of the array (currently only MPIU_INT, MPIU_SCALAR, MPIU_REAL)
3433ea844a1aSMatthew Knepley . origArray - the array; its size must be equal to the storage size of origSection
3434ea844a1aSMatthew Knepley - points - IS with points to extract; its indices must lie in the chart of origSection
3435ea844a1aSMatthew Knepley 
3436ea844a1aSMatthew Knepley   Output Parameters:
3437ea844a1aSMatthew Knepley + newSection - the new PetscSection desribing the layout of the new array (with points renumbered 0,1,... but preserving numbers of DOFs)
3438ea844a1aSMatthew Knepley - newArray - the array of the extracted DOFs; its size is the storage size of newSection
3439ea844a1aSMatthew Knepley 
3440ea844a1aSMatthew Knepley   Level: developer
3441ea844a1aSMatthew Knepley 
3442ea844a1aSMatthew Knepley .seealso: PetscSectionGetChart(), PetscSectionGetDof(), PetscSectionGetStorageSize(), PetscSectionCreate()
3443ea844a1aSMatthew Knepley @*/
3444ea844a1aSMatthew Knepley PetscErrorCode PetscSectionExtractDofsFromArray(PetscSection origSection, MPI_Datatype dataType, const void *origArray, IS points, PetscSection *newSection, void *newArray[])
3445ea844a1aSMatthew Knepley {
3446ea844a1aSMatthew Knepley   PetscSection        s;
3447ea844a1aSMatthew Knepley   const PetscInt      *points_;
3448ea844a1aSMatthew Knepley   PetscInt            i, n, npoints, pStart, pEnd;
3449ea844a1aSMatthew Knepley   PetscMPIInt         unitsize;
3450ea844a1aSMatthew Knepley 
3451ea844a1aSMatthew Knepley   PetscFunctionBegin;
3452ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(origSection, PETSC_SECTION_CLASSID, 1);
3453ea844a1aSMatthew Knepley   PetscValidPointer(origArray, 3);
3454ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(points, IS_CLASSID, 4);
3455ea844a1aSMatthew Knepley   if (newSection) PetscValidPointer(newSection, 5);
3456ea844a1aSMatthew Knepley   if (newArray) PetscValidPointer(newArray, 6);
34579566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Type_size(dataType, &unitsize));
34589566063dSJacob Faibussowitsch   PetscCall(ISGetLocalSize(points, &npoints));
34599566063dSJacob Faibussowitsch   PetscCall(ISGetIndices(points, &points_));
34609566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(origSection, &pStart, &pEnd));
34619566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PETSC_COMM_SELF, &s));
34629566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(s, 0, npoints));
3463ea844a1aSMatthew Knepley   for (i=0; i<npoints; i++) {
34642c71b3e2SJacob 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);
34659566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(origSection, points_[i], &n));
34669566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(s, i, n));
3467ea844a1aSMatthew Knepley   }
34689566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(s));
3469ea844a1aSMatthew Knepley   if (newArray) {
3470ea844a1aSMatthew Knepley     if (dataType == MPIU_INT)           {PetscSectionExpandPoints_Loop(PetscInt);}
3471ea844a1aSMatthew Knepley     else if (dataType == MPIU_SCALAR)   {PetscSectionExpandPoints_Loop(PetscScalar);}
3472ea844a1aSMatthew Knepley     else if (dataType == MPIU_REAL)     {PetscSectionExpandPoints_Loop(PetscReal);}
3473ea844a1aSMatthew Knepley     else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP, "not implemented for this MPI_Datatype");
3474ea844a1aSMatthew Knepley   }
3475ea844a1aSMatthew Knepley   if (newSection) {
3476ea844a1aSMatthew Knepley     *newSection = s;
3477ea844a1aSMatthew Knepley   } else {
34789566063dSJacob Faibussowitsch     PetscCall(PetscSectionDestroy(&s));
3479ea844a1aSMatthew Knepley   }
34809566063dSJacob Faibussowitsch   PetscCall(ISRestoreIndices(points, &points_));
3481ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3482ea844a1aSMatthew Knepley }
3483