xref: /petsc/src/vec/is/section/interface/section.c (revision 377f809a66ddb103acb624d65d678901d378fe03)
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 /*@
1120662ed9SBarry Smith   PetscSectionCreate - Allocates a `PetscSection` 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
23cab54364SBarry Smith .vb
24cab54364SBarry Smith        PetscSectionCreate(MPI_Comm,PetscSection *);!
25cab54364SBarry Smith        PetscSectionSetNumFields(PetscSection, numFields);
26cab54364SBarry Smith        PetscSectionSetChart(PetscSection,low,high);
27cab54364SBarry Smith        PetscSectionSetDof(PetscSection,point,numdof);
28cab54364SBarry Smith        PetscSectionSetUp(PetscSection);
29cab54364SBarry Smith        PetscSectionGetOffset(PetscSection,point,PetscInt *);
30cab54364SBarry Smith        PetscSectionDestroy(PetscSection);
31cab54364SBarry Smith .ve
32ea844a1aSMatthew Knepley 
3335cb6cd3SPierre Jolivet   The `PetscSection` object and methods are intended to be used in the PETSc `Vec` and `Mat` implementations. The indices returned by the `PetscSection` are appropriate for the kind of `Vec` it is associated with. For example, if the vector being indexed is a local vector, we call the section a local section. If the section indexes a global vector, we call it a global section. For parallel vectors, like global vectors, we use negative indices to indicate dofs owned by other processes.
34ea844a1aSMatthew Knepley 
35583308b6SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionSetChart()`, `PetscSectionDestroy()`, `PetscSectionCreateGlobalSection()`
36ea844a1aSMatthew Knepley @*/
37d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionCreate(MPI_Comm comm, PetscSection *s)
38d71ae5a4SJacob Faibussowitsch {
39ea844a1aSMatthew Knepley   PetscFunctionBegin;
404f572ea9SToby Isaac   PetscAssertPointer(s, 2);
419566063dSJacob Faibussowitsch   PetscCall(ISInitializePackage());
42ea844a1aSMatthew Knepley 
439566063dSJacob Faibussowitsch   PetscCall(PetscHeaderCreate(*s, PETSC_SECTION_CLASSID, "PetscSection", "Section", "IS", comm, PetscSectionDestroy, PetscSectionView));
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));
643ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
65ea844a1aSMatthew Knepley }
66ea844a1aSMatthew Knepley 
67ea844a1aSMatthew Knepley /*@
68cab54364SBarry Smith   PetscSectionCopy - Creates a shallow (if possible) copy of the `PetscSection`
69ea844a1aSMatthew Knepley 
70ea844a1aSMatthew Knepley   Collective
71ea844a1aSMatthew Knepley 
72ea844a1aSMatthew Knepley   Input Parameter:
73cab54364SBarry Smith . section - the `PetscSection`
74ea844a1aSMatthew Knepley 
75ea844a1aSMatthew Knepley   Output Parameter:
76ea844a1aSMatthew Knepley . newSection - the copy
77ea844a1aSMatthew Knepley 
78ea844a1aSMatthew Knepley   Level: intermediate
79ea844a1aSMatthew Knepley 
8038b5cf2dSJacob Faibussowitsch   Developer Notes:
81cab54364SBarry Smith   What exactly does shallow mean in this context?
82cab54364SBarry Smith 
83cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreate()`, `PetscSectionDestroy()`
84ea844a1aSMatthew Knepley @*/
85d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionCopy(PetscSection section, PetscSection newSection)
86d71ae5a4SJacob Faibussowitsch {
873857f682SStefano Zampini   PetscFunctionBegin;
883857f682SStefano Zampini   PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1);
893857f682SStefano Zampini   PetscValidHeaderSpecific(newSection, PETSC_SECTION_CLASSID, 2);
903857f682SStefano Zampini   PetscCall(PetscSectionCopy_Internal(section, newSection, NULL));
913857f682SStefano Zampini   PetscFunctionReturn(PETSC_SUCCESS);
923857f682SStefano Zampini }
933857f682SStefano Zampini 
943857f682SStefano Zampini PetscErrorCode PetscSectionCopy_Internal(PetscSection section, PetscSection newSection, PetscBT constrained_dofs)
953857f682SStefano Zampini {
96ea844a1aSMatthew Knepley   PetscSectionSym sym;
97ea844a1aSMatthew Knepley   IS              perm;
98b778fa18SValeria Barra   PetscInt        numFields, f, c, pStart, pEnd, p;
99ea844a1aSMatthew Knepley 
100ea844a1aSMatthew Knepley   PetscFunctionBegin;
101ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1);
102ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(newSection, PETSC_SECTION_CLASSID, 2);
1039566063dSJacob Faibussowitsch   PetscCall(PetscSectionReset(newSection));
1049566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetNumFields(section, &numFields));
1059566063dSJacob Faibussowitsch   if (numFields) PetscCall(PetscSectionSetNumFields(newSection, numFields));
106ea844a1aSMatthew Knepley   for (f = 0; f < numFields; ++f) {
107b778fa18SValeria Barra     const char *fieldName = NULL, *compName = NULL;
108ea844a1aSMatthew Knepley     PetscInt    numComp = 0;
109ea844a1aSMatthew Knepley 
1109566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldName(section, f, &fieldName));
1119566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldName(newSection, f, fieldName));
1129566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldComponents(section, f, &numComp));
1139566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldComponents(newSection, f, numComp));
114b778fa18SValeria Barra     for (c = 0; c < numComp; ++c) {
1159566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetComponentName(section, f, c, &compName));
1169566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetComponentName(newSection, f, c, compName));
117b778fa18SValeria Barra     }
1189566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldSym(section, f, &sym));
1199566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldSym(newSection, f, sym));
120ea844a1aSMatthew Knepley   }
1219566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(section, &pStart, &pEnd));
1229566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(newSection, pStart, pEnd));
1239566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetPermutation(section, &perm));
1249566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetPermutation(newSection, perm));
1259566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetSym(section, &sym));
1269566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetSym(newSection, sym));
127ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
128ea844a1aSMatthew Knepley     PetscInt  dof, cdof, fcdof = 0;
1293857f682SStefano Zampini     PetscBool force_constrained = (PetscBool)(constrained_dofs && PetscBTLookup(constrained_dofs, p - pStart));
130ea844a1aSMatthew Knepley 
1319566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(section, p, &dof));
1329566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(newSection, p, dof));
1333857f682SStefano Zampini     if (force_constrained) cdof = dof;
1343857f682SStefano Zampini     else PetscCall(PetscSectionGetConstraintDof(section, p, &cdof));
1359566063dSJacob Faibussowitsch     if (cdof) PetscCall(PetscSectionSetConstraintDof(newSection, p, cdof));
136ea844a1aSMatthew Knepley     for (f = 0; f < numFields; ++f) {
1379566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldDof(section, p, f, &dof));
1389566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldDof(newSection, p, f, dof));
139ea844a1aSMatthew Knepley       if (cdof) {
1403857f682SStefano Zampini         if (force_constrained) fcdof = dof;
1413857f682SStefano Zampini         else PetscCall(PetscSectionGetFieldConstraintDof(section, p, f, &fcdof));
1429566063dSJacob Faibussowitsch         if (fcdof) PetscCall(PetscSectionSetFieldConstraintDof(newSection, p, f, fcdof));
143ea844a1aSMatthew Knepley       }
144ea844a1aSMatthew Knepley     }
145ea844a1aSMatthew Knepley   }
1469566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(newSection));
147ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
148ea844a1aSMatthew Knepley     PetscInt        off, cdof, fcdof = 0;
149ea844a1aSMatthew Knepley     const PetscInt *cInd;
1503857f682SStefano Zampini     PetscBool       force_constrained = (PetscBool)(constrained_dofs && PetscBTLookup(constrained_dofs, p - pStart));
151ea844a1aSMatthew Knepley 
152ea844a1aSMatthew Knepley     /* Must set offsets in case they do not agree with the prefix sums */
1539566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(section, p, &off));
1549566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetOffset(newSection, p, off));
1553857f682SStefano Zampini     PetscCall(PetscSectionGetConstraintDof(newSection, p, &cdof));
156ea844a1aSMatthew Knepley     if (cdof) {
1573857f682SStefano Zampini       if (force_constrained) cInd = NULL;
1583857f682SStefano Zampini       else PetscCall(PetscSectionGetConstraintIndices(section, p, &cInd));
1599566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetConstraintIndices(newSection, p, cInd));
160ea844a1aSMatthew Knepley       for (f = 0; f < numFields; ++f) {
1613857f682SStefano Zampini         PetscCall(PetscSectionGetFieldOffset(section, p, f, &off));
1623857f682SStefano Zampini         PetscCall(PetscSectionSetFieldOffset(newSection, p, f, off));
1633857f682SStefano Zampini         PetscCall(PetscSectionGetFieldConstraintDof(newSection, p, f, &fcdof));
164ea844a1aSMatthew Knepley         if (fcdof) {
1653857f682SStefano Zampini           if (force_constrained) cInd = NULL;
1663857f682SStefano Zampini           else PetscCall(PetscSectionGetFieldConstraintIndices(section, p, f, &cInd));
1679566063dSJacob Faibussowitsch           PetscCall(PetscSectionSetFieldConstraintIndices(newSection, p, f, cInd));
168ea844a1aSMatthew Knepley         }
169ea844a1aSMatthew Knepley       }
170ea844a1aSMatthew Knepley     }
171ea844a1aSMatthew Knepley   }
1723ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
173ea844a1aSMatthew Knepley }
174ea844a1aSMatthew Knepley 
175ea844a1aSMatthew Knepley /*@
176cab54364SBarry Smith   PetscSectionClone - Creates a shallow (if possible) copy of the `PetscSection`
177ea844a1aSMatthew Knepley 
178ea844a1aSMatthew Knepley   Collective
179ea844a1aSMatthew Knepley 
180ea844a1aSMatthew Knepley   Input Parameter:
181cab54364SBarry Smith . section - the `PetscSection`
182ea844a1aSMatthew Knepley 
183ea844a1aSMatthew Knepley   Output Parameter:
184ea844a1aSMatthew Knepley . newSection - the copy
185ea844a1aSMatthew Knepley 
186ea844a1aSMatthew Knepley   Level: beginner
187ea844a1aSMatthew Knepley 
18838b5cf2dSJacob Faibussowitsch   Developer Notes:
189cab54364SBarry Smith   With standard PETSc terminology this should be called `PetscSectionDuplicate()`
190cab54364SBarry Smith 
191cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreate()`, `PetscSectionDestroy()`, `PetscSectionCopy()`
192ea844a1aSMatthew Knepley @*/
193d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionClone(PetscSection section, PetscSection *newSection)
194d71ae5a4SJacob Faibussowitsch {
195ea844a1aSMatthew Knepley   PetscFunctionBegin;
196ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1);
1974f572ea9SToby Isaac   PetscAssertPointer(newSection, 2);
1989566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject)section), newSection));
1999566063dSJacob Faibussowitsch   PetscCall(PetscSectionCopy(section, *newSection));
2003ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
201ea844a1aSMatthew Knepley }
202ea844a1aSMatthew Knepley 
203ea844a1aSMatthew Knepley /*@
204cab54364SBarry Smith   PetscSectionSetFromOptions - sets parameters in a `PetscSection` from the options database
205ea844a1aSMatthew Knepley 
20640750d41SVaclav Hapla   Collective
207ea844a1aSMatthew Knepley 
208ea844a1aSMatthew Knepley   Input Parameter:
20938b5cf2dSJacob Faibussowitsch . s - the `PetscSection`
210ea844a1aSMatthew Knepley 
21120662ed9SBarry Smith   Options Database Key:
212cab54364SBarry Smith . -petscsection_point_major - `PETSC_TRUE` for point-major order
213ea844a1aSMatthew Knepley 
214ea844a1aSMatthew Knepley   Level: intermediate
215ea844a1aSMatthew Knepley 
216cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreate()`, `PetscSectionDestroy()`
217ea844a1aSMatthew Knepley @*/
218d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetFromOptions(PetscSection s)
219d71ae5a4SJacob Faibussowitsch {
220ea844a1aSMatthew Knepley   PetscFunctionBegin;
221ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
222d0609cedSBarry Smith   PetscObjectOptionsBegin((PetscObject)s);
2239566063dSJacob Faibussowitsch   PetscCall(PetscOptionsBool("-petscsection_point_major", "The for ordering, either point major or field major", "PetscSectionSetPointMajor", s->pointMajor, &s->pointMajor, NULL));
224ea844a1aSMatthew Knepley   /* process any options handlers added with PetscObjectAddOptionsHandler() */
225dbbe0bcdSBarry Smith   PetscCall(PetscObjectProcessOptionsHandlers((PetscObject)s, PetscOptionsObject));
226d0609cedSBarry Smith   PetscOptionsEnd();
2279566063dSJacob Faibussowitsch   PetscCall(PetscObjectViewFromOptions((PetscObject)s, NULL, "-petscsection_view"));
2283ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
229ea844a1aSMatthew Knepley }
230ea844a1aSMatthew Knepley 
231ea844a1aSMatthew Knepley /*@
232ea844a1aSMatthew Knepley   PetscSectionCompare - Compares two sections
233ea844a1aSMatthew Knepley 
23440750d41SVaclav Hapla   Collective
235ea844a1aSMatthew Knepley 
2367a7aea1fSJed Brown   Input Parameters:
237cab54364SBarry Smith + s1 - the first `PetscSection`
238cab54364SBarry Smith - s2 - the second `PetscSection`
239ea844a1aSMatthew Knepley 
240ea844a1aSMatthew Knepley   Output Parameter:
241cab54364SBarry Smith . congruent - `PETSC_TRUE` if the two sections are congruent, `PETSC_FALSE` otherwise
242ea844a1aSMatthew Knepley 
243ea844a1aSMatthew Knepley   Level: intermediate
244ea844a1aSMatthew Knepley 
245cab54364SBarry Smith   Note:
246ea844a1aSMatthew Knepley   Field names are disregarded.
247ea844a1aSMatthew Knepley 
248cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreate()`, `PetscSectionCopy()`, `PetscSectionClone()`
249ea844a1aSMatthew Knepley @*/
250d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionCompare(PetscSection s1, PetscSection s2, PetscBool *congruent)
251d71ae5a4SJacob Faibussowitsch {
252ea844a1aSMatthew Knepley   PetscInt        pStart, pEnd, nfields, ncdof, nfcdof, p, f, n1, n2;
253ea844a1aSMatthew Knepley   const PetscInt *idx1, *idx2;
254ea844a1aSMatthew Knepley   IS              perm1, perm2;
255ea844a1aSMatthew Knepley   PetscBool       flg;
256ea844a1aSMatthew Knepley   PetscMPIInt     mflg;
257ea844a1aSMatthew Knepley 
258ea844a1aSMatthew Knepley   PetscFunctionBegin;
259ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s1, PETSC_SECTION_CLASSID, 1);
260ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s2, PETSC_SECTION_CLASSID, 2);
2614f572ea9SToby Isaac   PetscAssertPointer(congruent, 3);
262ea844a1aSMatthew Knepley   flg = PETSC_FALSE;
263ea844a1aSMatthew Knepley 
2649566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_compare(PetscObjectComm((PetscObject)s1), PetscObjectComm((PetscObject)s2), &mflg));
265ea844a1aSMatthew Knepley   if (mflg != MPI_CONGRUENT && mflg != MPI_IDENT) {
266ea844a1aSMatthew Knepley     *congruent = PETSC_FALSE;
2673ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
268ea844a1aSMatthew Knepley   }
269ea844a1aSMatthew Knepley 
2709566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s1, &pStart, &pEnd));
2719566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s2, &n1, &n2));
272ea844a1aSMatthew Knepley   if (pStart != n1 || pEnd != n2) goto not_congruent;
273ea844a1aSMatthew Knepley 
2749566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetPermutation(s1, &perm1));
2759566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetPermutation(s2, &perm2));
276ea844a1aSMatthew Knepley   if (perm1 && perm2) {
2779566063dSJacob Faibussowitsch     PetscCall(ISEqual(perm1, perm2, congruent));
2784ad8454bSPierre Jolivet     if (!*congruent) goto not_congruent;
279ea844a1aSMatthew Knepley   } else if (perm1 != perm2) goto not_congruent;
280ea844a1aSMatthew Knepley 
281ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
2829566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(s1, p, &n1));
2839566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(s2, p, &n2));
284ea844a1aSMatthew Knepley     if (n1 != n2) goto not_congruent;
285ea844a1aSMatthew Knepley 
2869566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s1, p, &n1));
2879566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s2, p, &n2));
288ea844a1aSMatthew Knepley     if (n1 != n2) goto not_congruent;
289ea844a1aSMatthew Knepley 
2909566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s1, p, &ncdof));
2919566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s2, p, &n2));
292ea844a1aSMatthew Knepley     if (ncdof != n2) goto not_congruent;
293ea844a1aSMatthew Knepley 
2949566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintIndices(s1, p, &idx1));
2959566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintIndices(s2, p, &idx2));
2969566063dSJacob Faibussowitsch     PetscCall(PetscArraycmp(idx1, idx2, ncdof, congruent));
2974ad8454bSPierre Jolivet     if (!*congruent) goto not_congruent;
298ea844a1aSMatthew Knepley   }
299ea844a1aSMatthew Knepley 
3009566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetNumFields(s1, &nfields));
3019566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetNumFields(s2, &n2));
302ea844a1aSMatthew Knepley   if (nfields != n2) goto not_congruent;
303ea844a1aSMatthew Knepley 
304ea844a1aSMatthew Knepley   for (f = 0; f < nfields; ++f) {
3059566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldComponents(s1, f, &n1));
3069566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldComponents(s2, f, &n2));
307ea844a1aSMatthew Knepley     if (n1 != n2) goto not_congruent;
308ea844a1aSMatthew Knepley 
309ea844a1aSMatthew Knepley     for (p = pStart; p < pEnd; ++p) {
3109566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldOffset(s1, p, f, &n1));
3119566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldOffset(s2, p, f, &n2));
312ea844a1aSMatthew Knepley       if (n1 != n2) goto not_congruent;
313ea844a1aSMatthew Knepley 
3149566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldDof(s1, p, f, &n1));
3159566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldDof(s2, p, f, &n2));
316ea844a1aSMatthew Knepley       if (n1 != n2) goto not_congruent;
317ea844a1aSMatthew Knepley 
3189566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintDof(s1, p, f, &nfcdof));
3199566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintDof(s2, p, f, &n2));
320ea844a1aSMatthew Knepley       if (nfcdof != n2) goto not_congruent;
321ea844a1aSMatthew Knepley 
3229566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintIndices(s1, p, f, &idx1));
3239566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintIndices(s2, p, f, &idx2));
3249566063dSJacob Faibussowitsch       PetscCall(PetscArraycmp(idx1, idx2, nfcdof, congruent));
3254ad8454bSPierre Jolivet       if (!*congruent) goto not_congruent;
326ea844a1aSMatthew Knepley     }
327ea844a1aSMatthew Knepley   }
328ea844a1aSMatthew Knepley 
329ea844a1aSMatthew Knepley   flg = PETSC_TRUE;
330ea844a1aSMatthew Knepley not_congruent:
3311c2dc1cbSBarry Smith   PetscCall(MPIU_Allreduce(&flg, congruent, 1, MPIU_BOOL, MPI_LAND, PetscObjectComm((PetscObject)s1)));
3323ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
333ea844a1aSMatthew Knepley }
334ea844a1aSMatthew Knepley 
335ea844a1aSMatthew Knepley /*@
336cab54364SBarry Smith   PetscSectionGetNumFields - Returns the number of fields in a `PetscSection`, or 0 if no fields were defined.
337ea844a1aSMatthew Knepley 
33840750d41SVaclav Hapla   Not Collective
339ea844a1aSMatthew Knepley 
340ea844a1aSMatthew Knepley   Input Parameter:
341cab54364SBarry Smith . s - the `PetscSection`
342ea844a1aSMatthew Knepley 
343ea844a1aSMatthew Knepley   Output Parameter:
344ea844a1aSMatthew Knepley . numFields - the number of fields defined, or 0 if none were defined
345ea844a1aSMatthew Knepley 
346ea844a1aSMatthew Knepley   Level: intermediate
347ea844a1aSMatthew Knepley 
348cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionSetNumFields()`
349ea844a1aSMatthew Knepley @*/
350d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetNumFields(PetscSection s, PetscInt *numFields)
351d71ae5a4SJacob Faibussowitsch {
352ea844a1aSMatthew Knepley   PetscFunctionBegin;
353ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
3544f572ea9SToby Isaac   PetscAssertPointer(numFields, 2);
355ea844a1aSMatthew Knepley   *numFields = s->numFields;
3563ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
357ea844a1aSMatthew Knepley }
358ea844a1aSMatthew Knepley 
359ea844a1aSMatthew Knepley /*@
360cab54364SBarry Smith   PetscSectionSetNumFields - Sets the number of fields in a `PetscSection`
361ea844a1aSMatthew Knepley 
36240750d41SVaclav Hapla   Not Collective
363ea844a1aSMatthew Knepley 
364ea844a1aSMatthew Knepley   Input Parameters:
36520662ed9SBarry Smith + s         - the `PetscSection`
366ea844a1aSMatthew Knepley - numFields - the number of fields
367ea844a1aSMatthew Knepley 
368ea844a1aSMatthew Knepley   Level: intermediate
369ea844a1aSMatthew Knepley 
370583308b6SBarry Smith   Notes:
371583308b6SBarry Smith   Calling this destroys all the information in the `PetscSection` including the chart.
372583308b6SBarry Smith 
373583308b6SBarry Smith   You must call `PetscSectionSetChart()` after calling this.
374583308b6SBarry Smith 
375583308b6SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetNumFields()`, `PetscSectionSetChart()`, `PetscSectionReset()`
376ea844a1aSMatthew Knepley @*/
377d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetNumFields(PetscSection s, PetscInt numFields)
378d71ae5a4SJacob Faibussowitsch {
379ea844a1aSMatthew Knepley   PetscInt f;
380ea844a1aSMatthew Knepley 
381ea844a1aSMatthew Knepley   PetscFunctionBegin;
382ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
38308401ef6SPierre Jolivet   PetscCheck(numFields > 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "The number of fields %" PetscInt_FMT " must be positive", numFields);
3849566063dSJacob Faibussowitsch   PetscCall(PetscSectionReset(s));
385ea844a1aSMatthew Knepley 
386ea844a1aSMatthew Knepley   s->numFields = numFields;
3879566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(s->numFields, &s->numFieldComponents));
3889566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(s->numFields, &s->fieldNames));
3899566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(s->numFields, &s->compNames));
3909566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(s->numFields, &s->field));
391ea844a1aSMatthew Knepley   for (f = 0; f < s->numFields; ++f) {
392ea844a1aSMatthew Knepley     char name[64];
393ea844a1aSMatthew Knepley 
394ea844a1aSMatthew Knepley     s->numFieldComponents[f] = 1;
395ea844a1aSMatthew Knepley 
3969566063dSJacob Faibussowitsch     PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject)s), &s->field[f]));
3979566063dSJacob Faibussowitsch     PetscCall(PetscSNPrintf(name, 64, "Field_%" PetscInt_FMT, f));
3989566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(name, (char **)&s->fieldNames[f]));
3999566063dSJacob Faibussowitsch     PetscCall(PetscSNPrintf(name, 64, "Component_0"));
4009566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(s->numFieldComponents[f], &s->compNames[f]));
4019566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(name, (char **)&s->compNames[f][0]));
402ea844a1aSMatthew Knepley   }
4033ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
404ea844a1aSMatthew Knepley }
405ea844a1aSMatthew Knepley 
406cc4c1da9SBarry Smith /*@
407cab54364SBarry Smith   PetscSectionGetFieldName - Returns the name of a field in the `PetscSection`
408ea844a1aSMatthew Knepley 
409ea844a1aSMatthew Knepley   Not Collective
410ea844a1aSMatthew Knepley 
411ea844a1aSMatthew Knepley   Input Parameters:
412cab54364SBarry Smith + s     - the `PetscSection`
413ea844a1aSMatthew Knepley - field - the field number
414ea844a1aSMatthew Knepley 
415ea844a1aSMatthew Knepley   Output Parameter:
416ea844a1aSMatthew Knepley . fieldName - the field name
417ea844a1aSMatthew Knepley 
418ea844a1aSMatthew Knepley   Level: intermediate
419ea844a1aSMatthew Knepley 
420cab54364SBarry Smith   Note:
421cab54364SBarry Smith   Will error if the field number is out of range
422cab54364SBarry Smith 
423cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionSetFieldName()`, `PetscSectionSetNumFields()`, `PetscSectionGetNumFields()`
424ea844a1aSMatthew Knepley @*/
425d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetFieldName(PetscSection s, PetscInt field, const char *fieldName[])
426d71ae5a4SJacob Faibussowitsch {
427ea844a1aSMatthew Knepley   PetscFunctionBegin;
428ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
4294f572ea9SToby Isaac   PetscAssertPointer(fieldName, 3);
4302abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field, s->numFields);
431ea844a1aSMatthew Knepley   *fieldName = s->fieldNames[field];
4323ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
433ea844a1aSMatthew Knepley }
434ea844a1aSMatthew Knepley 
435cc4c1da9SBarry Smith /*@
436cab54364SBarry Smith   PetscSectionSetFieldName - Sets the name of a field in the `PetscSection`
437ea844a1aSMatthew Knepley 
438ea844a1aSMatthew Knepley   Not Collective
439ea844a1aSMatthew Knepley 
440ea844a1aSMatthew Knepley   Input Parameters:
441cab54364SBarry Smith + s         - the `PetscSection`
442ea844a1aSMatthew Knepley . field     - the field number
443ea844a1aSMatthew Knepley - fieldName - the field name
444ea844a1aSMatthew Knepley 
445ea844a1aSMatthew Knepley   Level: intermediate
446ea844a1aSMatthew Knepley 
447cab54364SBarry Smith   Note:
448cab54364SBarry Smith   Will error if the field number is out of range
449cab54364SBarry Smith 
450cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionGetFieldName()`, `PetscSectionSetNumFields()`, `PetscSectionGetNumFields()`
451ea844a1aSMatthew Knepley @*/
452d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetFieldName(PetscSection s, PetscInt field, const char fieldName[])
453d71ae5a4SJacob Faibussowitsch {
454ea844a1aSMatthew Knepley   PetscFunctionBegin;
455ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
4564f572ea9SToby Isaac   if (fieldName) PetscAssertPointer(fieldName, 3);
4572abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field, s->numFields);
4589566063dSJacob Faibussowitsch   PetscCall(PetscFree(s->fieldNames[field]));
4599566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(fieldName, (char **)&s->fieldNames[field]));
4603ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
461ea844a1aSMatthew Knepley }
462ea844a1aSMatthew Knepley 
463cc4c1da9SBarry Smith /*@
464cab54364SBarry Smith   PetscSectionGetComponentName - Gets the name of a field component in the `PetscSection`
465b778fa18SValeria Barra 
466b778fa18SValeria Barra   Not Collective
467b778fa18SValeria Barra 
468b778fa18SValeria Barra   Input Parameters:
469cab54364SBarry Smith + s     - the `PetscSection`
470b778fa18SValeria Barra . field - the field number
471cab54364SBarry Smith - comp  - the component number
472cab54364SBarry Smith 
473d5b43468SJose E. Roman   Output Parameter:
474cab54364SBarry Smith . compName - the component name
475b778fa18SValeria Barra 
476b778fa18SValeria Barra   Level: intermediate
477b778fa18SValeria Barra 
478cab54364SBarry Smith   Note:
479cab54364SBarry Smith   Will error if the field or component number do not exist
480cab54364SBarry Smith 
48138b5cf2dSJacob Faibussowitsch   Developer Notes:
482583308b6SBarry Smith   The function name should have Field in it since they are field components.
483583308b6SBarry Smith 
484cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetFieldName()`, `PetscSectionSetNumFields()`, `PetscSectionGetNumFields()`,
485cab54364SBarry Smith           `PetscSectionSetComponentName()`, `PetscSectionSetFieldName()`, `PetscSectionGetFieldComponents()`, `PetscSectionSetFieldComponents()`
486b778fa18SValeria Barra @*/
487d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetComponentName(PetscSection s, PetscInt field, PetscInt comp, const char *compName[])
488d71ae5a4SJacob Faibussowitsch {
489b778fa18SValeria Barra   PetscFunctionBegin;
490b778fa18SValeria Barra   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
4914f572ea9SToby Isaac   PetscAssertPointer(compName, 4);
4922abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field, s->numFields);
4932abc8c78SJacob Faibussowitsch   PetscSectionCheckValidFieldComponent(comp, s->numFieldComponents[field]);
494b778fa18SValeria Barra   *compName = s->compNames[field][comp];
4953ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
496b778fa18SValeria Barra }
497b778fa18SValeria Barra 
498cc4c1da9SBarry Smith /*@
499cab54364SBarry Smith   PetscSectionSetComponentName - Sets the name of a field component in the `PetscSection`
500b778fa18SValeria Barra 
501b778fa18SValeria Barra   Not Collective
502b778fa18SValeria Barra 
503b778fa18SValeria Barra   Input Parameters:
50420662ed9SBarry Smith + s        - the `PetscSection`
505b778fa18SValeria Barra . field    - the field number
506b778fa18SValeria Barra . comp     - the component number
507b778fa18SValeria Barra - compName - the component name
508b778fa18SValeria Barra 
509583308b6SBarry Smith   Level: advanced
510b778fa18SValeria Barra 
511cab54364SBarry Smith   Note:
512cab54364SBarry Smith   Will error if the field or component number do not exist
513cab54364SBarry Smith 
51438b5cf2dSJacob Faibussowitsch   Developer Notes:
515583308b6SBarry Smith   The function name should have Field in it since they are field components.
516583308b6SBarry Smith 
517cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetComponentName()`, `PetscSectionSetNumFields()`, `PetscSectionGetNumFields()`,
51842747ad1SJacob Faibussowitsch           `PetscSectionSetFieldName()`, `PetscSectionGetFieldComponents()`, `PetscSectionSetFieldComponents()`
519b778fa18SValeria Barra @*/
520d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetComponentName(PetscSection s, PetscInt field, PetscInt comp, const char compName[])
521d71ae5a4SJacob Faibussowitsch {
522b778fa18SValeria Barra   PetscFunctionBegin;
523b778fa18SValeria Barra   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
5244f572ea9SToby Isaac   if (compName) PetscAssertPointer(compName, 4);
5252abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field, s->numFields);
5262abc8c78SJacob Faibussowitsch   PetscSectionCheckValidFieldComponent(comp, s->numFieldComponents[field]);
5279566063dSJacob Faibussowitsch   PetscCall(PetscFree(s->compNames[field][comp]));
5289566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(compName, (char **)&s->compNames[field][comp]));
5293ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
530b778fa18SValeria Barra }
531b778fa18SValeria Barra 
532ea844a1aSMatthew Knepley /*@
533ea844a1aSMatthew Knepley   PetscSectionGetFieldComponents - Returns the number of field components for the given field.
534ea844a1aSMatthew Knepley 
53540750d41SVaclav Hapla   Not Collective
536ea844a1aSMatthew Knepley 
537ea844a1aSMatthew Knepley   Input Parameters:
538cab54364SBarry Smith + s     - the `PetscSection`
539ea844a1aSMatthew Knepley - field - the field number
540ea844a1aSMatthew Knepley 
541ea844a1aSMatthew Knepley   Output Parameter:
542ea844a1aSMatthew Knepley . numComp - the number of field components
543ea844a1aSMatthew Knepley 
544583308b6SBarry Smith   Level: advanced
545ea844a1aSMatthew Knepley 
54638b5cf2dSJacob Faibussowitsch   Developer Notes:
547cab54364SBarry Smith   This function is misnamed. There is a Num in `PetscSectionGetNumFields()` but not in this name
548cab54364SBarry Smith 
549583308b6SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionSetFieldComponents()`, `PetscSectionGetNumFields()`,
550583308b6SBarry Smith           `PetscSectionSetComponentName()`, `PetscSectionGetComponentName()`
551ea844a1aSMatthew Knepley @*/
552d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetFieldComponents(PetscSection s, PetscInt field, PetscInt *numComp)
553d71ae5a4SJacob Faibussowitsch {
554ea844a1aSMatthew Knepley   PetscFunctionBegin;
555ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
5564f572ea9SToby Isaac   PetscAssertPointer(numComp, 3);
5572abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field, s->numFields);
558ea844a1aSMatthew Knepley   *numComp = s->numFieldComponents[field];
5593ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
560ea844a1aSMatthew Knepley }
561ea844a1aSMatthew Knepley 
562ea844a1aSMatthew Knepley /*@
563ea844a1aSMatthew Knepley   PetscSectionSetFieldComponents - Sets the number of field components for the given field.
564ea844a1aSMatthew Knepley 
56540750d41SVaclav Hapla   Not Collective
566ea844a1aSMatthew Knepley 
567ea844a1aSMatthew Knepley   Input Parameters:
56820662ed9SBarry Smith + s       - the `PetscSection`
569ea844a1aSMatthew Knepley . field   - the field number
570ea844a1aSMatthew Knepley - numComp - the number of field components
571ea844a1aSMatthew Knepley 
572583308b6SBarry Smith   Level: advanced
573ea844a1aSMatthew Knepley 
574583308b6SBarry Smith   Note:
575583308b6SBarry Smith   This number can be different than the values set with `PetscSectionSetFieldDof()`. It can be used to indicate the number of
576583308b6SBarry Smith   components in the field of the underlying physical model which may be different than the number of degrees of freedom needed
577583308b6SBarry Smith   at a point in a discretization. For example, if in three dimensions the field is velocity, it will have 3 components, u, v, and w but
578583308b6SBarry Smith   an face based model for velocity (where the velocity normal to the face is stored) there is only 1 dof for each face point.
579583308b6SBarry Smith 
580583308b6SBarry Smith   The value set with this function are not needed or used in `PetscSectionSetUp()`.
581583308b6SBarry Smith 
58238b5cf2dSJacob Faibussowitsch   Developer Notes:
583583308b6SBarry Smith   This function is misnamed. There is a Num in `PetscSectionSetNumFields()` but not in this name
584583308b6SBarry Smith 
585583308b6SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetFieldComponents()`, `PetscSectionSetComponentName()`,
586583308b6SBarry Smith           `PetscSectionGetComponentName()`, `PetscSectionGetNumFields()`
587ea844a1aSMatthew Knepley @*/
588d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetFieldComponents(PetscSection s, PetscInt field, PetscInt numComp)
589d71ae5a4SJacob Faibussowitsch {
590b778fa18SValeria Barra   PetscInt c;
591b778fa18SValeria Barra 
592ea844a1aSMatthew Knepley   PetscFunctionBegin;
593ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
5942abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field, s->numFields);
595b778fa18SValeria Barra   if (s->compNames) {
59648a46eb9SPierre Jolivet     for (c = 0; c < s->numFieldComponents[field]; ++c) PetscCall(PetscFree(s->compNames[field][c]));
5979566063dSJacob Faibussowitsch     PetscCall(PetscFree(s->compNames[field]));
598b778fa18SValeria Barra   }
599b778fa18SValeria Barra 
600ea844a1aSMatthew Knepley   s->numFieldComponents[field] = numComp;
601b778fa18SValeria Barra   if (numComp) {
6029566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(numComp, (char ***)&s->compNames[field]));
603b778fa18SValeria Barra     for (c = 0; c < numComp; ++c) {
6042abc8c78SJacob Faibussowitsch       char name[64];
6052abc8c78SJacob Faibussowitsch 
6069566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(name, 64, "%" PetscInt_FMT, c));
6079566063dSJacob Faibussowitsch       PetscCall(PetscStrallocpy(name, (char **)&s->compNames[field][c]));
608b778fa18SValeria Barra     }
609b778fa18SValeria Barra   }
6103ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
611ea844a1aSMatthew Knepley }
612ea844a1aSMatthew Knepley 
613ea844a1aSMatthew Knepley /*@
614583308b6SBarry Smith   PetscSectionGetChart - Returns the range [`pStart`, `pEnd`) in which points (indices) lie for this `PetscSection` on this MPI process
615ea844a1aSMatthew Knepley 
61640750d41SVaclav Hapla   Not Collective
617ea844a1aSMatthew Knepley 
618ea844a1aSMatthew Knepley   Input Parameter:
619cab54364SBarry Smith . s - the `PetscSection`
620ea844a1aSMatthew Knepley 
621ea844a1aSMatthew Knepley   Output Parameters:
622ea844a1aSMatthew Knepley + pStart - the first point
623ea844a1aSMatthew Knepley - pEnd   - one past the last point
624ea844a1aSMatthew Knepley 
625ea844a1aSMatthew Knepley   Level: intermediate
626ea844a1aSMatthew Knepley 
627cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionSetChart()`, `PetscSectionCreate()`
628ea844a1aSMatthew Knepley @*/
629d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetChart(PetscSection s, PetscInt *pStart, PetscInt *pEnd)
630d71ae5a4SJacob Faibussowitsch {
631ea844a1aSMatthew Knepley   PetscFunctionBegin;
632ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
633ea844a1aSMatthew Knepley   if (pStart) *pStart = s->pStart;
634ea844a1aSMatthew Knepley   if (pEnd) *pEnd = s->pEnd;
6353ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
636ea844a1aSMatthew Knepley }
637ea844a1aSMatthew Knepley 
638ea844a1aSMatthew Knepley /*@
639583308b6SBarry Smith   PetscSectionSetChart - Sets the range [`pStart`, `pEnd`) in which points (indices) lie for this `PetscSection` on this MPI process
640ea844a1aSMatthew Knepley 
64140750d41SVaclav Hapla   Not Collective
642ea844a1aSMatthew Knepley 
643ea844a1aSMatthew Knepley   Input Parameters:
64420662ed9SBarry Smith + s      - the `PetscSection`
645ea844a1aSMatthew Knepley . pStart - the first point
646376335faSBarry Smith - pEnd   - one past the last point, `pStart` $ \le $ `pEnd`
647ea844a1aSMatthew Knepley 
648ea844a1aSMatthew Knepley   Level: intermediate
649ea844a1aSMatthew Knepley 
650583308b6SBarry Smith   Notes:
651583308b6SBarry Smith   The charts on different MPI processes may (and often do) overlap
652583308b6SBarry Smith 
653583308b6SBarry Smith   If you intend to use `PetscSectionSetNumFields()` it must be called before this call.
654583308b6SBarry Smith 
655583308b6SBarry Smith   The chart for all fields created with `PetscSectionSetNumFields()` is the same as this chart.
656583308b6SBarry Smith 
657583308b6SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetChart()`, `PetscSectionCreate()`, `PetscSectionSetNumFields()`
658ea844a1aSMatthew Knepley @*/
659d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetChart(PetscSection s, PetscInt pStart, PetscInt pEnd)
660d71ae5a4SJacob Faibussowitsch {
661ea844a1aSMatthew Knepley   PetscInt f;
662ea844a1aSMatthew Knepley 
663ea844a1aSMatthew Knepley   PetscFunctionBegin;
664ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
66540196513SBarry Smith   PetscCheck(pEnd >= pStart, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Chart pEnd %" PetscInt_FMT " cannot be smaller than chart pStart %" PetscInt_FMT, pEnd, pStart);
6663ba16761SJacob Faibussowitsch   if (pStart == s->pStart && pEnd == s->pEnd) PetscFunctionReturn(PETSC_SUCCESS);
667ea844a1aSMatthew Knepley   /* Cannot Reset() because it destroys field information */
668ea844a1aSMatthew Knepley   s->setup = PETSC_FALSE;
6699566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&s->bc));
6709566063dSJacob Faibussowitsch   PetscCall(PetscFree(s->bcIndices));
6719566063dSJacob Faibussowitsch   PetscCall(PetscFree2(s->atlasDof, s->atlasOff));
672ea844a1aSMatthew Knepley 
673ea844a1aSMatthew Knepley   s->pStart = pStart;
674ea844a1aSMatthew Knepley   s->pEnd   = pEnd;
6759566063dSJacob Faibussowitsch   PetscCall(PetscMalloc2((pEnd - pStart), &s->atlasDof, (pEnd - pStart), &s->atlasOff));
6769566063dSJacob Faibussowitsch   PetscCall(PetscArrayzero(s->atlasDof, pEnd - pStart));
67748a46eb9SPierre Jolivet   for (f = 0; f < s->numFields; ++f) PetscCall(PetscSectionSetChart(s->field[f], pStart, pEnd));
6783ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
679ea844a1aSMatthew Knepley }
680ea844a1aSMatthew Knepley 
681ea844a1aSMatthew Knepley /*@
68220662ed9SBarry Smith   PetscSectionGetPermutation - Returns the permutation of [0, `pEnd` - `pStart`) or `NULL` that was set with `PetscSectionSetPermutation()`
683ea844a1aSMatthew Knepley 
68440750d41SVaclav Hapla   Not Collective
685ea844a1aSMatthew Knepley 
686ea844a1aSMatthew Knepley   Input Parameter:
687cab54364SBarry Smith . s - the `PetscSection`
688ea844a1aSMatthew Knepley 
6892fe279fdSBarry Smith   Output Parameter:
690cab54364SBarry Smith . perm - The permutation as an `IS`
691ea844a1aSMatthew Knepley 
692ea844a1aSMatthew Knepley   Level: intermediate
693ea844a1aSMatthew Knepley 
694cab54364SBarry Smith .seealso: [](sec_scatter), `IS`, `PetscSection`, `PetscSectionSetPermutation()`, `PetscSectionCreate()`
695ea844a1aSMatthew Knepley @*/
696d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetPermutation(PetscSection s, IS *perm)
697d71ae5a4SJacob Faibussowitsch {
698ea844a1aSMatthew Knepley   PetscFunctionBegin;
699ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
7009371c9d4SSatish Balay   if (perm) {
7014f572ea9SToby Isaac     PetscAssertPointer(perm, 2);
7029371c9d4SSatish Balay     *perm = s->perm;
7039371c9d4SSatish Balay   }
7043ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
705ea844a1aSMatthew Knepley }
706ea844a1aSMatthew Knepley 
707ea844a1aSMatthew Knepley /*@
708583308b6SBarry Smith   PetscSectionSetPermutation - Sets a permutation of the chart for this section, [0, `pEnd` - `pStart`), which determines the order to store the `PetscSection` information
709ea844a1aSMatthew Knepley 
71040750d41SVaclav Hapla   Not Collective
711ea844a1aSMatthew Knepley 
712ea844a1aSMatthew Knepley   Input Parameters:
71320662ed9SBarry Smith + s    - the `PetscSection`
714ea844a1aSMatthew Knepley - perm - the permutation of points
715ea844a1aSMatthew Knepley 
716ea844a1aSMatthew Knepley   Level: intermediate
717ea844a1aSMatthew Knepley 
718583308b6SBarry Smith   Notes:
719583308b6SBarry Smith   The permutation must be provided before `PetscSectionSetUp()`.
720cab54364SBarry Smith 
721583308b6SBarry Smith   The data in the `PetscSection` are permuted but the access via `PetscSectionGetFieldOffset()` and `PetscSectionGetOffset()` is not changed
722583308b6SBarry Smith 
7233ec46b7bSMatthew G. Knepley   Compare to `PetscSectionPermute()`
724583308b6SBarry Smith 
725583308b6SBarry Smith .seealso: [](sec_scatter), `IS`, `PetscSection`, `PetscSectionSetUp()`, `PetscSectionGetPermutation()`, `PetscSectionPermute()`, `PetscSectionCreate()`
726ea844a1aSMatthew Knepley @*/
727d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetPermutation(PetscSection s, IS perm)
728d71ae5a4SJacob Faibussowitsch {
729ea844a1aSMatthew Knepley   PetscFunctionBegin;
730ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
731ea844a1aSMatthew Knepley   if (perm) PetscValidHeaderSpecific(perm, IS_CLASSID, 2);
73228b400f6SJacob Faibussowitsch   PetscCheck(!s->setup, PetscObjectComm((PetscObject)s), PETSC_ERR_ARG_WRONGSTATE, "Cannot set a permutation after the section is setup");
733ea844a1aSMatthew Knepley   if (s->perm != perm) {
7349566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&s->perm));
735ea844a1aSMatthew Knepley     if (perm) {
736ea844a1aSMatthew Knepley       s->perm = perm;
7379566063dSJacob Faibussowitsch       PetscCall(PetscObjectReference((PetscObject)s->perm));
738ea844a1aSMatthew Knepley     }
739ea844a1aSMatthew Knepley   }
7403ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
741ea844a1aSMatthew Knepley }
742ea844a1aSMatthew Knepley 
7433ec46b7bSMatthew G. Knepley /*@C
7443ec46b7bSMatthew G. Knepley   PetscSectionGetBlockStarts - Returns a table indicating which points start new blocks
7453ec46b7bSMatthew G. Knepley 
746cc4c1da9SBarry Smith   Not Collective, No Fortran Support
7473ec46b7bSMatthew G. Knepley 
7483ec46b7bSMatthew G. Knepley   Input Parameter:
7493ec46b7bSMatthew G. Knepley . s - the `PetscSection`
7503ec46b7bSMatthew G. Knepley 
7513ec46b7bSMatthew G. Knepley   Output Parameter:
7523ec46b7bSMatthew G. Knepley . blockStarts - The `PetscBT` with a 1 for each point that begins a block
7533ec46b7bSMatthew G. Knepley 
7543ec46b7bSMatthew G. Knepley   Notes:
7553ec46b7bSMatthew G. Knepley   The table is on [0, `pEnd` - `pStart`).
7563ec46b7bSMatthew G. Knepley 
7573ec46b7bSMatthew G. Knepley   This information is used by `DMCreateMatrix()` to create a variable block size description which is set using `MatSetVariableBlockSizes()`.
7583ec46b7bSMatthew G. Knepley 
7593ec46b7bSMatthew G. Knepley   Level: intermediate
7603ec46b7bSMatthew G. Knepley 
7613ec46b7bSMatthew G. Knepley .seealso: [](sec_scatter), `IS`, `PetscSection`, `PetscSectionSetBlockStarts()`, `PetscSectionCreate()`, `DMCreateMatrix()`, `MatSetVariableBlockSizes()`
7623ec46b7bSMatthew G. Knepley @*/
7633ec46b7bSMatthew G. Knepley PetscErrorCode PetscSectionGetBlockStarts(PetscSection s, PetscBT *blockStarts)
7643ec46b7bSMatthew G. Knepley {
7653ec46b7bSMatthew G. Knepley   PetscFunctionBegin;
7663ec46b7bSMatthew G. Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
7673ec46b7bSMatthew G. Knepley   if (blockStarts) {
7683ec46b7bSMatthew G. Knepley     PetscAssertPointer(blockStarts, 2);
7693ec46b7bSMatthew G. Knepley     *blockStarts = s->blockStarts;
7703ec46b7bSMatthew G. Knepley   }
7713ec46b7bSMatthew G. Knepley   PetscFunctionReturn(PETSC_SUCCESS);
7723ec46b7bSMatthew G. Knepley }
7733ec46b7bSMatthew G. Knepley 
7743ec46b7bSMatthew G. Knepley /*@C
7753ec46b7bSMatthew G. Knepley   PetscSectionSetBlockStarts - Sets a table indicating which points start new blocks
7763ec46b7bSMatthew G. Knepley 
777cc4c1da9SBarry Smith   Not Collective, No Fortran Support
7783ec46b7bSMatthew G. Knepley 
7793ec46b7bSMatthew G. Knepley   Input Parameters:
7803ec46b7bSMatthew G. Knepley + s           - the `PetscSection`
7813ec46b7bSMatthew G. Knepley - blockStarts - The `PetscBT` with a 1 for each point that begins a block
7823ec46b7bSMatthew G. Knepley 
7833ec46b7bSMatthew G. Knepley   Level: intermediate
7843ec46b7bSMatthew G. Knepley 
7853ec46b7bSMatthew G. Knepley   Notes:
7863ec46b7bSMatthew G. Knepley   The table is on [0, `pEnd` - `pStart`). PETSc takes ownership of the `PetscBT` when it is passed in and will destroy it. The user should not destroy it.
7873ec46b7bSMatthew G. Knepley 
7883ec46b7bSMatthew G. Knepley   This information is used by `DMCreateMatrix()` to create a variable block size description which is set using `MatSetVariableBlockSizes()`.
7893ec46b7bSMatthew G. Knepley 
7903ec46b7bSMatthew G. Knepley .seealso: [](sec_scatter), `IS`, `PetscSection`, `PetscSectionGetBlockStarts()`, `PetscSectionCreate()`, `DMCreateMatrix()`, `MatSetVariableBlockSizes()`
7913ec46b7bSMatthew G. Knepley @*/
7923ec46b7bSMatthew G. Knepley PetscErrorCode PetscSectionSetBlockStarts(PetscSection s, PetscBT blockStarts)
7933ec46b7bSMatthew G. Knepley {
7943ec46b7bSMatthew G. Knepley   PetscFunctionBegin;
7953ec46b7bSMatthew G. Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
7963ec46b7bSMatthew G. Knepley   if (s->blockStarts != blockStarts) {
7973ec46b7bSMatthew G. Knepley     PetscCall(PetscBTDestroy(&s->blockStarts));
7983ec46b7bSMatthew G. Knepley     s->blockStarts = blockStarts;
7993ec46b7bSMatthew G. Knepley   }
8003ec46b7bSMatthew G. Knepley   PetscFunctionReturn(PETSC_SUCCESS);
8013ec46b7bSMatthew G. Knepley }
8023ec46b7bSMatthew G. Knepley 
803ea844a1aSMatthew Knepley /*@
804cab54364SBarry Smith   PetscSectionGetPointMajor - Returns the flag for dof ordering, `PETSC_TRUE` if it is point major, `PETSC_FALSE` if it is field major
805ea844a1aSMatthew Knepley 
80640750d41SVaclav Hapla   Not Collective
807ea844a1aSMatthew Knepley 
808ea844a1aSMatthew Knepley   Input Parameter:
809cab54364SBarry Smith . s - the `PetscSection`
810ea844a1aSMatthew Knepley 
811ea844a1aSMatthew Knepley   Output Parameter:
812ea844a1aSMatthew Knepley . pm - the flag for point major ordering
813ea844a1aSMatthew Knepley 
814ea844a1aSMatthew Knepley   Level: intermediate
815ea844a1aSMatthew Knepley 
81638b5cf2dSJacob Faibussowitsch .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionSetPointMajor()`
817ea844a1aSMatthew Knepley @*/
818d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetPointMajor(PetscSection s, PetscBool *pm)
819d71ae5a4SJacob Faibussowitsch {
820ea844a1aSMatthew Knepley   PetscFunctionBegin;
821ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
8224f572ea9SToby Isaac   PetscAssertPointer(pm, 2);
823ea844a1aSMatthew Knepley   *pm = s->pointMajor;
8243ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
825ea844a1aSMatthew Knepley }
826ea844a1aSMatthew Knepley 
827ea844a1aSMatthew Knepley /*@
828cab54364SBarry Smith   PetscSectionSetPointMajor - Sets the flag for dof ordering, `PETSC_TRUE` for point major, otherwise it will be field major
829ea844a1aSMatthew Knepley 
83040750d41SVaclav Hapla   Not Collective
831ea844a1aSMatthew Knepley 
832ea844a1aSMatthew Knepley   Input Parameters:
833cab54364SBarry Smith + s  - the `PetscSection`
834ea844a1aSMatthew Knepley - pm - the flag for point major ordering
835ea844a1aSMatthew Knepley 
836ea844a1aSMatthew Knepley   Level: intermediate
837ea844a1aSMatthew Knepley 
838583308b6SBarry Smith   Note:
839583308b6SBarry Smith   Field-major order is not recommended unless you are managing the entire problem yourself, since many higher-level functions in PETSc depend on point-major order.
840583308b6SBarry Smith 
841583308b6SBarry Smith   Point major order means the degrees of freedom are stored as follows
842583308b6SBarry Smith .vb
84311e840c0SPierre Jolivet     all the degrees of freedom for each point are stored contiguously, one point after another (respecting a permutation set with `PetscSectionSetPermutation()`)
844583308b6SBarry Smith     for each point
845583308b6SBarry Smith        the degrees of freedom for each field (starting with the unnamed default field) are listed in order by field
846583308b6SBarry Smith .ve
847583308b6SBarry Smith 
848583308b6SBarry Smith   Field major order means the degrees of freedom are stored as follows
849583308b6SBarry Smith .vb
85011e840c0SPierre Jolivet     all degrees of freedom for each field (including the unnamed default field) are stored contiguously, one field after another
851583308b6SBarry Smith     for each field (started with unnamed default field)
852583308b6SBarry Smith       the degrees of freedom for each point are listed in order by point (respecting a permutation set with `PetscSectionSetPermutation()`)
853583308b6SBarry Smith .ve
854583308b6SBarry Smith 
855583308b6SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetPointMajor()`, `PetscSectionSetPermutation()`
856ea844a1aSMatthew Knepley @*/
857d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetPointMajor(PetscSection s, PetscBool pm)
858d71ae5a4SJacob Faibussowitsch {
859ea844a1aSMatthew Knepley   PetscFunctionBegin;
860ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
86128b400f6SJacob Faibussowitsch   PetscCheck(!s->setup, PetscObjectComm((PetscObject)s), PETSC_ERR_ARG_WRONGSTATE, "Cannot set the dof ordering after the section is setup");
862ea844a1aSMatthew Knepley   s->pointMajor = pm;
8633ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
864ea844a1aSMatthew Knepley }
865ea844a1aSMatthew Knepley 
866ea844a1aSMatthew Knepley /*@
867cab54364SBarry Smith   PetscSectionGetIncludesConstraints - Returns the flag indicating if constrained dofs were included when computing offsets in the `PetscSection`.
868cab54364SBarry Smith   The value is set with `PetscSectionSetIncludesConstraints()`
86987e637c6Sksagiyam 
87040750d41SVaclav Hapla   Not Collective
87187e637c6Sksagiyam 
87287e637c6Sksagiyam   Input Parameter:
873cab54364SBarry Smith . s - the `PetscSection`
87487e637c6Sksagiyam 
87587e637c6Sksagiyam   Output Parameter:
87687e637c6Sksagiyam . includesConstraints - the flag indicating if constrained dofs were included when computing offsets
87787e637c6Sksagiyam 
87887e637c6Sksagiyam   Level: intermediate
87987e637c6Sksagiyam 
880cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionSetIncludesConstraints()`
88187e637c6Sksagiyam @*/
882d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetIncludesConstraints(PetscSection s, PetscBool *includesConstraints)
883d71ae5a4SJacob Faibussowitsch {
88487e637c6Sksagiyam   PetscFunctionBegin;
88587e637c6Sksagiyam   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
8864f572ea9SToby Isaac   PetscAssertPointer(includesConstraints, 2);
88787e637c6Sksagiyam   *includesConstraints = s->includesConstraints;
8883ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
88987e637c6Sksagiyam }
89087e637c6Sksagiyam 
89187e637c6Sksagiyam /*@
89287e637c6Sksagiyam   PetscSectionSetIncludesConstraints - Sets the flag indicating if constrained dofs are to be included when computing offsets
89387e637c6Sksagiyam 
89440750d41SVaclav Hapla   Not Collective
89587e637c6Sksagiyam 
89687e637c6Sksagiyam   Input Parameters:
89720662ed9SBarry Smith + s                   - the `PetscSection`
89887e637c6Sksagiyam - includesConstraints - the flag indicating if constrained dofs are to be included when computing offsets
89987e637c6Sksagiyam 
90087e637c6Sksagiyam   Level: intermediate
90187e637c6Sksagiyam 
902cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetIncludesConstraints()`
90387e637c6Sksagiyam @*/
904d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetIncludesConstraints(PetscSection s, PetscBool includesConstraints)
905d71ae5a4SJacob Faibussowitsch {
90687e637c6Sksagiyam   PetscFunctionBegin;
90787e637c6Sksagiyam   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
90828b400f6SJacob Faibussowitsch   PetscCheck(!s->setup, PetscObjectComm((PetscObject)s), PETSC_ERR_ARG_WRONGSTATE, "Cannot set includesConstraints after the section is set up");
90987e637c6Sksagiyam   s->includesConstraints = includesConstraints;
9103ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
91187e637c6Sksagiyam }
91287e637c6Sksagiyam 
91387e637c6Sksagiyam /*@
914583308b6SBarry Smith   PetscSectionGetDof - Return the total number of degrees of freedom associated with a given point.
915ea844a1aSMatthew Knepley 
91640750d41SVaclav Hapla   Not Collective
917ea844a1aSMatthew Knepley 
918ea844a1aSMatthew Knepley   Input Parameters:
919cab54364SBarry Smith + s     - the `PetscSection`
920ea844a1aSMatthew Knepley - point - the point
921ea844a1aSMatthew Knepley 
922ea844a1aSMatthew Knepley   Output Parameter:
923ea844a1aSMatthew Knepley . numDof - the number of dof
924ea844a1aSMatthew Knepley 
925583308b6SBarry Smith   Level: intermediate
926583308b6SBarry Smith 
927583308b6SBarry Smith   Notes:
928db527f05SMatthew G. Knepley   In a global section, this size will be negative for points not owned by this process.
929db527f05SMatthew G. Knepley 
930583308b6SBarry Smith   This number is for the unnamed default field at the given point plus all degrees of freedom associated with all fields at that point
931ea844a1aSMatthew Knepley 
932cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionSetDof()`, `PetscSectionCreate()`
933ea844a1aSMatthew Knepley @*/
934d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetDof(PetscSection s, PetscInt point, PetscInt *numDof)
935d71ae5a4SJacob Faibussowitsch {
93676bd3646SJed Brown   PetscFunctionBeginHot;
937ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
9384f572ea9SToby Isaac   PetscAssertPointer(numDof, 3);
939b498ca8aSPierre Jolivet   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);
940ea844a1aSMatthew Knepley   *numDof = s->atlasDof[point - s->pStart];
9413ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
942ea844a1aSMatthew Knepley }
943ea844a1aSMatthew Knepley 
944ea844a1aSMatthew Knepley /*@
945583308b6SBarry Smith   PetscSectionSetDof - Sets the total number of degrees of freedom associated with a given point.
946ea844a1aSMatthew Knepley 
94740750d41SVaclav Hapla   Not Collective
948ea844a1aSMatthew Knepley 
949ea844a1aSMatthew Knepley   Input Parameters:
950cab54364SBarry Smith + s      - the `PetscSection`
951ea844a1aSMatthew Knepley . point  - the point
952376335faSBarry Smith - numDof - the number of dof, these values may be negative -(dof+1) to indicate they are off process
953ea844a1aSMatthew Knepley 
954ea844a1aSMatthew Knepley   Level: intermediate
955ea844a1aSMatthew Knepley 
956583308b6SBarry Smith   Note:
957583308b6SBarry Smith   This number is for the unnamed default field at the given point plus all degrees of freedom associated with all fields at that point
958583308b6SBarry Smith 
959cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetDof()`, `PetscSectionAddDof()`, `PetscSectionCreate()`
960ea844a1aSMatthew Knepley @*/
961d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetDof(PetscSection s, PetscInt point, PetscInt numDof)
962d71ae5a4SJacob Faibussowitsch {
963ea844a1aSMatthew Knepley   PetscFunctionBegin;
964ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
965c8bf3acbSVaclav 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);
966ea844a1aSMatthew Knepley   s->atlasDof[point - s->pStart] = numDof;
96769c11d05SVaclav Hapla   PetscCall(PetscSectionInvalidateMaxDof_Internal(s));
9683ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
969ea844a1aSMatthew Knepley }
970ea844a1aSMatthew Knepley 
971ea844a1aSMatthew Knepley /*@
972583308b6SBarry Smith   PetscSectionAddDof - Adds to the total number of degrees of freedom associated with a given point.
973ea844a1aSMatthew Knepley 
97440750d41SVaclav Hapla   Not Collective
975ea844a1aSMatthew Knepley 
976ea844a1aSMatthew Knepley   Input Parameters:
977cab54364SBarry Smith + s      - the `PetscSection`
978ea844a1aSMatthew Knepley . point  - the point
979ea844a1aSMatthew Knepley - numDof - the number of additional dof
980ea844a1aSMatthew Knepley 
981ea844a1aSMatthew Knepley   Level: intermediate
982ea844a1aSMatthew Knepley 
983583308b6SBarry Smith   Note:
984583308b6SBarry Smith   This number is for the unnamed default field at the given point plus all degrees of freedom associated with all fields at that point
985583308b6SBarry Smith 
986cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetDof()`, `PetscSectionSetDof()`, `PetscSectionCreate()`
987ea844a1aSMatthew Knepley @*/
988d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionAddDof(PetscSection s, PetscInt point, PetscInt numDof)
989d71ae5a4SJacob Faibussowitsch {
99076bd3646SJed Brown   PetscFunctionBeginHot;
991ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
992b498ca8aSPierre Jolivet   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);
99340196513SBarry Smith   PetscCheck(numDof >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "numDof %" PetscInt_FMT " should not be negative", numDof);
994ea844a1aSMatthew Knepley   s->atlasDof[point - s->pStart] += numDof;
99569c11d05SVaclav Hapla   PetscCall(PetscSectionInvalidateMaxDof_Internal(s));
9963ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
997ea844a1aSMatthew Knepley }
998ea844a1aSMatthew Knepley 
999ea844a1aSMatthew Knepley /*@
1000ea844a1aSMatthew Knepley   PetscSectionGetFieldDof - Return the number of degrees of freedom associated with a field on a given point.
1001ea844a1aSMatthew Knepley 
100240750d41SVaclav Hapla   Not Collective
1003ea844a1aSMatthew Knepley 
1004ea844a1aSMatthew Knepley   Input Parameters:
1005cab54364SBarry Smith + s     - the `PetscSection`
1006ea844a1aSMatthew Knepley . point - the point
1007ea844a1aSMatthew Knepley - field - the field
1008ea844a1aSMatthew Knepley 
1009ea844a1aSMatthew Knepley   Output Parameter:
1010ea844a1aSMatthew Knepley . numDof - the number of dof
1011ea844a1aSMatthew Knepley 
1012ea844a1aSMatthew Knepley   Level: intermediate
1013ea844a1aSMatthew Knepley 
1014cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionSetFieldDof()`, `PetscSectionCreate()`
1015ea844a1aSMatthew Knepley @*/
1016d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetFieldDof(PetscSection s, PetscInt point, PetscInt field, PetscInt *numDof)
1017d71ae5a4SJacob Faibussowitsch {
1018ea844a1aSMatthew Knepley   PetscFunctionBegin;
1019ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
10204f572ea9SToby Isaac   PetscAssertPointer(numDof, 4);
10212abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field, s->numFields);
10229566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetDof(s->field[field], point, numDof));
10233ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1024ea844a1aSMatthew Knepley }
1025ea844a1aSMatthew Knepley 
1026ea844a1aSMatthew Knepley /*@
1027ea844a1aSMatthew Knepley   PetscSectionSetFieldDof - Sets the number of degrees of freedom associated with a field on a given point.
1028ea844a1aSMatthew Knepley 
102940750d41SVaclav Hapla   Not Collective
1030ea844a1aSMatthew Knepley 
1031ea844a1aSMatthew Knepley   Input Parameters:
1032cab54364SBarry Smith + s      - the `PetscSection`
1033ea844a1aSMatthew Knepley . point  - the point
1034ea844a1aSMatthew Knepley . field  - the field
1035376335faSBarry Smith - numDof - the number of dof, these values may be negative -(dof+1) to indicate they are off process
1036ea844a1aSMatthew Knepley 
1037ea844a1aSMatthew Knepley   Level: intermediate
1038ea844a1aSMatthew Knepley 
1039583308b6SBarry Smith   Note:
1040583308b6SBarry Smith   When setting the number of dof for a field at a point one must also ensure the count of the total number of dof at the point (summed over
1041583308b6SBarry Smith   the fields and the unnamed default field) is correct by also calling `PetscSectionAddDof()` or `PetscSectionSetDof()`
1042583308b6SBarry Smith 
1043583308b6SBarry Smith   This is equivalent to
1044583308b6SBarry Smith .vb
1045583308b6SBarry Smith      PetscSection fs;
1046583308b6SBarry Smith      PetscSectionGetField(s,field,&fs)
1047583308b6SBarry Smith      PetscSectionSetDof(fs,numDof)
1048583308b6SBarry Smith .ve
1049583308b6SBarry Smith 
1050583308b6SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetFieldDof()`, `PetscSectionCreate()`, `PetscSectionAddDof()`, `PetscSectionSetDof()`
1051ea844a1aSMatthew Knepley @*/
1052d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetFieldDof(PetscSection s, PetscInt point, PetscInt field, PetscInt numDof)
1053d71ae5a4SJacob Faibussowitsch {
1054ea844a1aSMatthew Knepley   PetscFunctionBegin;
1055ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
10562abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field, s->numFields);
10579566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetDof(s->field[field], point, numDof));
10583ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1059ea844a1aSMatthew Knepley }
1060ea844a1aSMatthew Knepley 
1061ea844a1aSMatthew Knepley /*@
1062ea844a1aSMatthew Knepley   PetscSectionAddFieldDof - Adds a number of degrees of freedom associated with a field on a given point.
1063ea844a1aSMatthew Knepley 
106440750d41SVaclav Hapla   Not Collective
1065ea844a1aSMatthew Knepley 
1066ea844a1aSMatthew Knepley   Input Parameters:
1067cab54364SBarry Smith + s      - the `PetscSection`
1068ea844a1aSMatthew Knepley . point  - the point
1069ea844a1aSMatthew Knepley . field  - the field
1070ea844a1aSMatthew Knepley - numDof - the number of dof
1071ea844a1aSMatthew Knepley 
1072ea844a1aSMatthew Knepley   Level: intermediate
1073ea844a1aSMatthew Knepley 
1074583308b6SBarry Smith   Notes:
1075583308b6SBarry Smith   When adding to the number of dof for a field at a point one must also ensure the count of the total number of dof at the point (summed over
1076583308b6SBarry Smith   the fields and the unnamed default field) is correct by also calling `PetscSectionAddDof()` or `PetscSectionSetDof()`
1077583308b6SBarry Smith 
1078583308b6SBarry Smith   This is equivalent to
1079583308b6SBarry Smith .vb
1080583308b6SBarry Smith      PetscSection fs;
1081583308b6SBarry Smith      PetscSectionGetField(s,field,&fs)
1082583308b6SBarry Smith      PetscSectionAddDof(fs,numDof)
1083583308b6SBarry Smith .ve
1084583308b6SBarry Smith 
1085cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionSetFieldDof()`, `PetscSectionGetFieldDof()`, `PetscSectionCreate()`
1086ea844a1aSMatthew Knepley @*/
1087d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionAddFieldDof(PetscSection s, PetscInt point, PetscInt field, PetscInt numDof)
1088d71ae5a4SJacob Faibussowitsch {
1089ea844a1aSMatthew Knepley   PetscFunctionBegin;
1090ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
10912abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field, s->numFields);
10929566063dSJacob Faibussowitsch   PetscCall(PetscSectionAddDof(s->field[field], point, numDof));
10933ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1094ea844a1aSMatthew Knepley }
1095ea844a1aSMatthew Knepley 
1096ea844a1aSMatthew Knepley /*@
1097ea844a1aSMatthew Knepley   PetscSectionGetConstraintDof - Return the number of constrained degrees of freedom associated with a given point.
1098ea844a1aSMatthew Knepley 
109940750d41SVaclav Hapla   Not Collective
1100ea844a1aSMatthew Knepley 
1101ea844a1aSMatthew Knepley   Input Parameters:
1102cab54364SBarry Smith + s     - the `PetscSection`
1103ea844a1aSMatthew Knepley - point - the point
1104ea844a1aSMatthew Knepley 
1105ea844a1aSMatthew Knepley   Output Parameter:
1106ea844a1aSMatthew Knepley . numDof - the number of dof which are fixed by constraints
1107ea844a1aSMatthew Knepley 
1108ea844a1aSMatthew Knepley   Level: intermediate
1109ea844a1aSMatthew Knepley 
1110cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetDof()`, `PetscSectionSetConstraintDof()`, `PetscSectionCreate()`
1111ea844a1aSMatthew Knepley @*/
1112d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetConstraintDof(PetscSection s, PetscInt point, PetscInt *numDof)
1113d71ae5a4SJacob Faibussowitsch {
1114ea844a1aSMatthew Knepley   PetscFunctionBegin;
1115ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
11164f572ea9SToby Isaac   PetscAssertPointer(numDof, 3);
1117ea844a1aSMatthew Knepley   if (s->bc) {
11189566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s->bc, point, numDof));
1119ea844a1aSMatthew Knepley   } else *numDof = 0;
11203ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1121ea844a1aSMatthew Knepley }
1122ea844a1aSMatthew Knepley 
1123ea844a1aSMatthew Knepley /*@
1124ea844a1aSMatthew Knepley   PetscSectionSetConstraintDof - Set the number of constrained degrees of freedom associated with a given point.
1125ea844a1aSMatthew Knepley 
112640750d41SVaclav Hapla   Not Collective
1127ea844a1aSMatthew Knepley 
1128ea844a1aSMatthew Knepley   Input Parameters:
1129cab54364SBarry Smith + s      - the `PetscSection`
1130ea844a1aSMatthew Knepley . point  - the point
1131ea844a1aSMatthew Knepley - numDof - the number of dof which are fixed by constraints
1132ea844a1aSMatthew Knepley 
1133ea844a1aSMatthew Knepley   Level: intermediate
1134ea844a1aSMatthew Knepley 
1135cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionSetDof()`, `PetscSectionGetConstraintDof()`, `PetscSectionCreate()`
1136ea844a1aSMatthew Knepley @*/
1137d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetConstraintDof(PetscSection s, PetscInt point, PetscInt numDof)
1138d71ae5a4SJacob Faibussowitsch {
1139ea844a1aSMatthew Knepley   PetscFunctionBegin;
1140ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1141ea844a1aSMatthew Knepley   if (numDof) {
11427c0883d5SVaclav Hapla     PetscCall(PetscSectionCheckConstraints_Private(s));
11439566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(s->bc, point, numDof));
1144ea844a1aSMatthew Knepley   }
11453ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1146ea844a1aSMatthew Knepley }
1147ea844a1aSMatthew Knepley 
1148ea844a1aSMatthew Knepley /*@
1149ea844a1aSMatthew Knepley   PetscSectionAddConstraintDof - Increment the number of constrained degrees of freedom associated with a given point.
1150ea844a1aSMatthew Knepley 
115140750d41SVaclav Hapla   Not Collective
1152ea844a1aSMatthew Knepley 
1153ea844a1aSMatthew Knepley   Input Parameters:
1154cab54364SBarry Smith + s      - the `PetscSection`
1155ea844a1aSMatthew Knepley . point  - the point
1156ea844a1aSMatthew Knepley - numDof - the number of additional dof which are fixed by constraints
1157ea844a1aSMatthew Knepley 
1158ea844a1aSMatthew Knepley   Level: intermediate
1159ea844a1aSMatthew Knepley 
1160cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionAddDof()`, `PetscSectionGetConstraintDof()`, `PetscSectionCreate()`
1161ea844a1aSMatthew Knepley @*/
1162d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionAddConstraintDof(PetscSection s, PetscInt point, PetscInt numDof)
1163d71ae5a4SJacob Faibussowitsch {
1164ea844a1aSMatthew Knepley   PetscFunctionBegin;
1165ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1166ea844a1aSMatthew Knepley   if (numDof) {
11677c0883d5SVaclav Hapla     PetscCall(PetscSectionCheckConstraints_Private(s));
11689566063dSJacob Faibussowitsch     PetscCall(PetscSectionAddDof(s->bc, point, numDof));
1169ea844a1aSMatthew Knepley   }
11703ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1171ea844a1aSMatthew Knepley }
1172ea844a1aSMatthew Knepley 
1173ea844a1aSMatthew Knepley /*@
1174ea844a1aSMatthew Knepley   PetscSectionGetFieldConstraintDof - Return the number of constrained degrees of freedom associated with a given field on a point.
1175ea844a1aSMatthew Knepley 
117640750d41SVaclav Hapla   Not Collective
1177ea844a1aSMatthew Knepley 
1178ea844a1aSMatthew Knepley   Input Parameters:
1179cab54364SBarry Smith + s     - the `PetscSection`
1180ea844a1aSMatthew Knepley . point - the point
1181ea844a1aSMatthew Knepley - field - the field
1182ea844a1aSMatthew Knepley 
1183ea844a1aSMatthew Knepley   Output Parameter:
1184ea844a1aSMatthew Knepley . numDof - the number of dof which are fixed by constraints
1185ea844a1aSMatthew Knepley 
1186ea844a1aSMatthew Knepley   Level: intermediate
1187ea844a1aSMatthew Knepley 
1188cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetDof()`, `PetscSectionSetFieldConstraintDof()`, `PetscSectionCreate()`
1189ea844a1aSMatthew Knepley @*/
1190d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetFieldConstraintDof(PetscSection s, PetscInt point, PetscInt field, PetscInt *numDof)
1191d71ae5a4SJacob Faibussowitsch {
1192ea844a1aSMatthew Knepley   PetscFunctionBegin;
1193ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
11944f572ea9SToby Isaac   PetscAssertPointer(numDof, 4);
11952abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field, s->numFields);
11969566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstraintDof(s->field[field], point, numDof));
11973ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1198ea844a1aSMatthew Knepley }
1199ea844a1aSMatthew Knepley 
1200ea844a1aSMatthew Knepley /*@
1201ea844a1aSMatthew Knepley   PetscSectionSetFieldConstraintDof - Set the number of constrained degrees of freedom associated with a given field on a point.
1202ea844a1aSMatthew Knepley 
120340750d41SVaclav Hapla   Not Collective
1204ea844a1aSMatthew Knepley 
1205ea844a1aSMatthew Knepley   Input Parameters:
1206cab54364SBarry Smith + s      - the `PetscSection`
1207ea844a1aSMatthew Knepley . point  - the point
1208ea844a1aSMatthew Knepley . field  - the field
1209ea844a1aSMatthew Knepley - numDof - the number of dof which are fixed by constraints
1210ea844a1aSMatthew Knepley 
1211ea844a1aSMatthew Knepley   Level: intermediate
1212ea844a1aSMatthew Knepley 
1213cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionSetDof()`, `PetscSectionGetFieldConstraintDof()`, `PetscSectionCreate()`
1214ea844a1aSMatthew Knepley @*/
1215d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetFieldConstraintDof(PetscSection s, PetscInt point, PetscInt field, PetscInt numDof)
1216d71ae5a4SJacob Faibussowitsch {
1217ea844a1aSMatthew Knepley   PetscFunctionBegin;
1218ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
12192abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field, s->numFields);
12209566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetConstraintDof(s->field[field], point, numDof));
12213ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1222ea844a1aSMatthew Knepley }
1223ea844a1aSMatthew Knepley 
1224ea844a1aSMatthew Knepley /*@
1225ea844a1aSMatthew Knepley   PetscSectionAddFieldConstraintDof - Increment the number of constrained degrees of freedom associated with a given field on a point.
1226ea844a1aSMatthew Knepley 
122740750d41SVaclav Hapla   Not Collective
1228ea844a1aSMatthew Knepley 
1229ea844a1aSMatthew Knepley   Input Parameters:
1230cab54364SBarry Smith + s      - the `PetscSection`
1231ea844a1aSMatthew Knepley . point  - the point
1232ea844a1aSMatthew Knepley . field  - the field
1233ea844a1aSMatthew Knepley - numDof - the number of additional dof which are fixed by constraints
1234ea844a1aSMatthew Knepley 
1235ea844a1aSMatthew Knepley   Level: intermediate
1236ea844a1aSMatthew Knepley 
1237cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionAddDof()`, `PetscSectionGetFieldConstraintDof()`, `PetscSectionCreate()`
1238ea844a1aSMatthew Knepley @*/
1239d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionAddFieldConstraintDof(PetscSection s, PetscInt point, PetscInt field, PetscInt numDof)
1240d71ae5a4SJacob Faibussowitsch {
1241ea844a1aSMatthew Knepley   PetscFunctionBegin;
1242ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
12432abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field, s->numFields);
12449566063dSJacob Faibussowitsch   PetscCall(PetscSectionAddConstraintDof(s->field[field], point, numDof));
12453ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1246ea844a1aSMatthew Knepley }
1247ea844a1aSMatthew Knepley 
1248ea844a1aSMatthew Knepley /*@
1249ea844a1aSMatthew Knepley   PetscSectionSetUpBC - Setup the subsections describing boundary conditions.
1250ea844a1aSMatthew Knepley 
125140750d41SVaclav Hapla   Not Collective
1252ea844a1aSMatthew Knepley 
1253ea844a1aSMatthew Knepley   Input Parameter:
1254cab54364SBarry Smith . s - the `PetscSection`
1255ea844a1aSMatthew Knepley 
1256ea844a1aSMatthew Knepley   Level: advanced
1257ea844a1aSMatthew Knepley 
1258cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionSetUp()`, `PetscSectionCreate()`
1259ea844a1aSMatthew Knepley @*/
1260d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetUpBC(PetscSection s)
1261d71ae5a4SJacob Faibussowitsch {
1262ea844a1aSMatthew Knepley   PetscFunctionBegin;
1263ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1264ea844a1aSMatthew Knepley   if (s->bc) {
1265ea844a1aSMatthew Knepley     const PetscInt last = (s->bc->pEnd - s->bc->pStart) - 1;
1266ea844a1aSMatthew Knepley 
12679566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetUp(s->bc));
12688da24d32SBarry Smith     PetscCall(PetscMalloc1((last >= 0 ? s->bc->atlasOff[last] + s->bc->atlasDof[last] : 0), &s->bcIndices));
1269ea844a1aSMatthew Knepley   }
12703ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1271ea844a1aSMatthew Knepley }
1272ea844a1aSMatthew Knepley 
1273ea844a1aSMatthew Knepley /*@
1274583308b6SBarry Smith   PetscSectionSetUp - Calculate offsets based upon the number of degrees of freedom for each point in preparation for use of the `PetscSection`
1275ea844a1aSMatthew Knepley 
127640750d41SVaclav Hapla   Not Collective
1277ea844a1aSMatthew Knepley 
1278ea844a1aSMatthew Knepley   Input Parameter:
1279cab54364SBarry Smith . s - the `PetscSection`
1280ea844a1aSMatthew Knepley 
1281ea844a1aSMatthew Knepley   Level: intermediate
1282ea844a1aSMatthew Knepley 
1283583308b6SBarry Smith   Notes:
1284583308b6SBarry Smith   If used, `PetscSectionSetPermutation()` must be called before this routine.
1285583308b6SBarry Smith 
1286583308b6SBarry Smith   `PetscSectionSetPointMajor()`, cannot be called after this routine.
1287583308b6SBarry Smith 
1288583308b6SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreate()`, `PetscSectionSetPermutation()`
1289ea844a1aSMatthew Knepley @*/
1290d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetUp(PetscSection s)
1291d71ae5a4SJacob Faibussowitsch {
1292ea844a1aSMatthew Knepley   const PetscInt *pind   = NULL;
1293ea844a1aSMatthew Knepley   PetscInt        offset = 0, foff, p, f;
1294ea844a1aSMatthew Knepley 
1295ea844a1aSMatthew Knepley   PetscFunctionBegin;
1296ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
12973ba16761SJacob Faibussowitsch   if (s->setup) PetscFunctionReturn(PETSC_SUCCESS);
1298ea844a1aSMatthew Knepley   s->setup = PETSC_TRUE;
1299ea844a1aSMatthew Knepley   /* Set offsets and field offsets for all points */
1300ea844a1aSMatthew Knepley   /*   Assume that all fields have the same chart */
130128b400f6SJacob Faibussowitsch   PetscCheck(s->includesConstraints, PETSC_COMM_SELF, PETSC_ERR_SUP, "PetscSectionSetUp is currently unsupported for includesConstraints = PETSC_TRUE");
13029566063dSJacob Faibussowitsch   if (s->perm) PetscCall(ISGetIndices(s->perm, &pind));
1303ea844a1aSMatthew Knepley   if (s->pointMajor) {
1304ea844a1aSMatthew Knepley     for (p = 0; p < s->pEnd - s->pStart; ++p) {
1305ea844a1aSMatthew Knepley       const PetscInt q = pind ? pind[p] : p;
1306ea844a1aSMatthew Knepley 
1307ea844a1aSMatthew Knepley       /* Set point offset */
1308ea844a1aSMatthew Knepley       s->atlasOff[q] = offset;
1309ea844a1aSMatthew Knepley       offset += s->atlasDof[q];
1310ea844a1aSMatthew Knepley       /* Set field offset */
1311ea844a1aSMatthew Knepley       for (f = 0, foff = s->atlasOff[q]; f < s->numFields; ++f) {
1312ea844a1aSMatthew Knepley         PetscSection sf = s->field[f];
1313ea844a1aSMatthew Knepley 
1314ea844a1aSMatthew Knepley         sf->atlasOff[q] = foff;
1315ea844a1aSMatthew Knepley         foff += sf->atlasDof[q];
1316ea844a1aSMatthew Knepley       }
1317ea844a1aSMatthew Knepley     }
1318ea844a1aSMatthew Knepley   } else {
1319ea844a1aSMatthew Knepley     /* Set field offsets for all points */
1320ea844a1aSMatthew Knepley     for (f = 0; f < s->numFields; ++f) {
1321ea844a1aSMatthew Knepley       PetscSection sf = s->field[f];
1322ea844a1aSMatthew Knepley 
1323ea844a1aSMatthew Knepley       for (p = 0; p < s->pEnd - s->pStart; ++p) {
1324ea844a1aSMatthew Knepley         const PetscInt q = pind ? pind[p] : p;
1325ea844a1aSMatthew Knepley 
1326ea844a1aSMatthew Knepley         sf->atlasOff[q] = offset;
1327ea844a1aSMatthew Knepley         offset += sf->atlasDof[q];
1328ea844a1aSMatthew Knepley       }
1329ea844a1aSMatthew Knepley     }
1330ea844a1aSMatthew Knepley     /* Disable point offsets since these are unused */
1331ad540459SPierre Jolivet     for (p = 0; p < s->pEnd - s->pStart; ++p) s->atlasOff[p] = -1;
1332ea844a1aSMatthew Knepley   }
13339566063dSJacob Faibussowitsch   if (s->perm) PetscCall(ISRestoreIndices(s->perm, &pind));
1334ea844a1aSMatthew Knepley   /* Setup BC sections */
13359566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUpBC(s));
13369566063dSJacob Faibussowitsch   for (f = 0; f < s->numFields; ++f) PetscCall(PetscSectionSetUpBC(s->field[f]));
13373ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1338ea844a1aSMatthew Knepley }
1339ea844a1aSMatthew Knepley 
1340ea844a1aSMatthew Knepley /*@
134120662ed9SBarry Smith   PetscSectionGetMaxDof - Return the maximum number of degrees of freedom on any point in the `PetscSection`
1342ea844a1aSMatthew Knepley 
134340750d41SVaclav Hapla   Not Collective
1344ea844a1aSMatthew Knepley 
13452fe279fdSBarry Smith   Input Parameter:
1346cab54364SBarry Smith . s - the `PetscSection`
1347ea844a1aSMatthew Knepley 
1348ea844a1aSMatthew Knepley   Output Parameter:
1349ea844a1aSMatthew Knepley . maxDof - the maximum dof
1350ea844a1aSMatthew Knepley 
1351ea844a1aSMatthew Knepley   Level: intermediate
1352ea844a1aSMatthew Knepley 
1353583308b6SBarry Smith   Notes:
1354cab54364SBarry Smith   The returned number is up-to-date without need for `PetscSectionSetUp()`.
135569c11d05SVaclav Hapla 
1356583308b6SBarry Smith   This is the maximum over all points of the sum of the number of dof in the unnamed default field plus all named fields. This is equivalent to
1357583308b6SBarry Smith   the maximum over all points of the value returned by `PetscSectionGetDof()` on this MPI process
1358583308b6SBarry Smith 
1359583308b6SBarry Smith   Developer Notes:
136069c11d05SVaclav Hapla   The returned number is calculated lazily and stashed.
1361cab54364SBarry Smith 
1362cab54364SBarry Smith   A call to `PetscSectionInvalidateMaxDof_Internal()` invalidates the stashed value.
1363cab54364SBarry Smith 
1364cab54364SBarry Smith   `PetscSectionInvalidateMaxDof_Internal()` is called in `PetscSectionSetDof()`, `PetscSectionAddDof()` and `PetscSectionReset()`
1365cab54364SBarry Smith 
136620662ed9SBarry Smith   It should also be called every time `atlasDof` is modified directly.
136769c11d05SVaclav Hapla 
1368cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetDof()`, `PetscSectionSetDof()`, `PetscSectionAddDof()`, `PetscSectionCreate()`
1369ea844a1aSMatthew Knepley @*/
1370d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetMaxDof(PetscSection s, PetscInt *maxDof)
1371d71ae5a4SJacob Faibussowitsch {
137269c11d05SVaclav Hapla   PetscInt p;
137369c11d05SVaclav Hapla 
1374ea844a1aSMatthew Knepley   PetscFunctionBegin;
1375ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
13764f572ea9SToby Isaac   PetscAssertPointer(maxDof, 2);
137769c11d05SVaclav Hapla   if (s->maxDof == PETSC_MIN_INT) {
137869c11d05SVaclav Hapla     s->maxDof = 0;
1379ad540459SPierre Jolivet     for (p = 0; p < s->pEnd - s->pStart; ++p) s->maxDof = PetscMax(s->maxDof, s->atlasDof[p]);
138069c11d05SVaclav Hapla   }
1381ea844a1aSMatthew Knepley   *maxDof = s->maxDof;
13823ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1383ea844a1aSMatthew Knepley }
1384ea844a1aSMatthew Knepley 
1385ea844a1aSMatthew Knepley /*@
138620662ed9SBarry Smith   PetscSectionGetStorageSize - Return the size of an array or local `Vec` capable of holding all the degrees of freedom defined in a `PetscSection`
1387ea844a1aSMatthew Knepley 
138840750d41SVaclav Hapla   Not Collective
1389ea844a1aSMatthew Knepley 
1390ea844a1aSMatthew Knepley   Input Parameter:
1391cab54364SBarry Smith . s - the `PetscSection`
1392ea844a1aSMatthew Knepley 
1393ea844a1aSMatthew Knepley   Output Parameter:
1394ea844a1aSMatthew Knepley . size - the size of an array which can hold all the dofs
1395ea844a1aSMatthew Knepley 
1396ea844a1aSMatthew Knepley   Level: intermediate
1397ea844a1aSMatthew Knepley 
1398cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetOffset()`, `PetscSectionGetConstrainedStorageSize()`, `PetscSectionCreate()`
1399ea844a1aSMatthew Knepley @*/
1400d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetStorageSize(PetscSection s, PetscInt *size)
1401d71ae5a4SJacob Faibussowitsch {
1402ea844a1aSMatthew Knepley   PetscInt p, n = 0;
1403ea844a1aSMatthew Knepley 
1404ea844a1aSMatthew Knepley   PetscFunctionBegin;
1405ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
14064f572ea9SToby Isaac   PetscAssertPointer(size, 2);
1407ea844a1aSMatthew Knepley   for (p = 0; p < s->pEnd - s->pStart; ++p) n += s->atlasDof[p] > 0 ? s->atlasDof[p] : 0;
1408ea844a1aSMatthew Knepley   *size = n;
14093ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1410ea844a1aSMatthew Knepley }
1411ea844a1aSMatthew Knepley 
1412ea844a1aSMatthew Knepley /*@
141320662ed9SBarry Smith   PetscSectionGetConstrainedStorageSize - Return the size of an array or local `Vec` capable of holding all unconstrained degrees of freedom in a `PetscSection`
1414ea844a1aSMatthew Knepley 
141540750d41SVaclav Hapla   Not Collective
1416ea844a1aSMatthew Knepley 
1417064ec1f3Sprj-   Input Parameter:
1418cab54364SBarry Smith . s - the `PetscSection`
1419ea844a1aSMatthew Knepley 
1420ea844a1aSMatthew Knepley   Output Parameter:
1421ea844a1aSMatthew Knepley . size - the size of an array which can hold all unconstrained dofs
1422ea844a1aSMatthew Knepley 
1423ea844a1aSMatthew Knepley   Level: intermediate
1424ea844a1aSMatthew Knepley 
1425cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetStorageSize()`, `PetscSectionGetOffset()`, `PetscSectionCreate()`
1426ea844a1aSMatthew Knepley @*/
1427d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetConstrainedStorageSize(PetscSection s, PetscInt *size)
1428d71ae5a4SJacob Faibussowitsch {
1429ea844a1aSMatthew Knepley   PetscInt p, n = 0;
1430ea844a1aSMatthew Knepley 
1431ea844a1aSMatthew Knepley   PetscFunctionBegin;
1432ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
14334f572ea9SToby Isaac   PetscAssertPointer(size, 2);
1434ea844a1aSMatthew Knepley   for (p = 0; p < s->pEnd - s->pStart; ++p) {
1435ea844a1aSMatthew Knepley     const PetscInt cdof = s->bc ? s->bc->atlasDof[p] : 0;
1436ea844a1aSMatthew Knepley     n += s->atlasDof[p] > 0 ? s->atlasDof[p] - cdof : 0;
1437ea844a1aSMatthew Knepley   }
1438ea844a1aSMatthew Knepley   *size = n;
14393ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1440ea844a1aSMatthew Knepley }
1441ea844a1aSMatthew Knepley 
1442ea844a1aSMatthew Knepley /*@
1443583308b6SBarry Smith   PetscSectionCreateGlobalSection - Create a parallel section describing the global layout using
1444583308b6SBarry Smith   a local (sequential) `PetscSection` on each MPI process and a `PetscSF` describing the section point overlap.
1445ea844a1aSMatthew Knepley 
1446ea844a1aSMatthew Knepley   Input Parameters:
1447cab54364SBarry Smith + s                  - The `PetscSection` for the local field layout
1448cab54364SBarry Smith . sf                 - The `PetscSF` describing parallel layout of the section points (leaves are unowned local points)
1449eb9d3e4dSMatthew G. Knepley . usePermutation     - By default this is `PETSC_TRUE`, meaning any permutation of the local section is transferred to the global section
1450cab54364SBarry Smith . includeConstraints - By default this is `PETSC_FALSE`, meaning that the global field vector will not possess constrained dofs
1451cab54364SBarry Smith - localOffsets       - If `PETSC_TRUE`, use local rather than global offsets for the points
1452ea844a1aSMatthew Knepley 
1453ea844a1aSMatthew Knepley   Output Parameter:
1454cab54364SBarry Smith . gsection - The `PetscSection` for the global field layout
1455ea844a1aSMatthew Knepley 
1456ea844a1aSMatthew Knepley   Level: intermediate
1457ea844a1aSMatthew Knepley 
1458db527f05SMatthew G. Knepley   Notes:
1459583308b6SBarry Smith   On each MPI process `gsection` inherits the chart of the `s` on that process.
1460db527f05SMatthew G. Knepley 
1461583308b6SBarry Smith   This sets negative sizes and offsets to points not owned by this process as defined by `sf` but that are within the local value of the chart of `gsection`.
1462583308b6SBarry Smith   In those locations the value of size is -(size+1) and the value of the offset on the remote process is -(off+1).
1463cab54364SBarry Smith 
146420662ed9SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreate()`, `PetscSectionCreateGlobalSectionCensored()`
1465ea844a1aSMatthew Knepley @*/
1466eb9d3e4dSMatthew G. Knepley PetscErrorCode PetscSectionCreateGlobalSection(PetscSection s, PetscSF sf, PetscBool usePermutation, PetscBool includeConstraints, PetscBool localOffsets, PetscSection *gsection)
1467d71ae5a4SJacob Faibussowitsch {
1468ea844a1aSMatthew Knepley   PetscSection    gs;
1469ea844a1aSMatthew Knepley   const PetscInt *pind = NULL;
1470ea844a1aSMatthew Knepley   PetscInt       *recv = NULL, *neg = NULL;
1471046d2115Sksagiyam   PetscInt        pStart, pEnd, p, dof, cdof, off, foff, globalOff = 0, nroots, nlocal, maxleaf;
1472046d2115Sksagiyam   PetscInt        numFields, f, numComponents;
1473ea844a1aSMatthew Knepley 
1474ea844a1aSMatthew Knepley   PetscFunctionBegin;
1475ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1476ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
1477eb9d3e4dSMatthew G. Knepley   PetscValidLogicalCollectiveBool(s, usePermutation, 3);
1478eb9d3e4dSMatthew G. Knepley   PetscValidLogicalCollectiveBool(s, includeConstraints, 4);
1479eb9d3e4dSMatthew G. Knepley   PetscValidLogicalCollectiveBool(s, localOffsets, 5);
1480eb9d3e4dSMatthew G. Knepley   PetscAssertPointer(gsection, 6);
148128b400f6SJacob Faibussowitsch   PetscCheck(s->pointMajor, PETSC_COMM_SELF, PETSC_ERR_SUP, "No support for field major ordering");
14829566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject)s), &gs));
14839566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetNumFields(s, &numFields));
14849566063dSJacob Faibussowitsch   if (numFields > 0) PetscCall(PetscSectionSetNumFields(gs, numFields));
14859566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
14869566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(gs, pStart, pEnd));
148787e637c6Sksagiyam   gs->includesConstraints = includeConstraints;
14889566063dSJacob Faibussowitsch   PetscCall(PetscSFGetGraph(sf, &nroots, NULL, NULL, NULL));
1489ea844a1aSMatthew Knepley   nlocal = nroots; /* The local/leaf space matches global/root space */
1490ea844a1aSMatthew Knepley   /* Must allocate for all points visible to SF, which may be more than this section */
1491ea844a1aSMatthew Knepley   if (nroots >= 0) { /* nroots < 0 means that the graph has not been set, only happens in serial */
14929566063dSJacob Faibussowitsch     PetscCall(PetscSFGetLeafRange(sf, NULL, &maxleaf));
149308401ef6SPierre Jolivet     PetscCheck(nroots >= pEnd, PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "SF roots %" PetscInt_FMT " < pEnd %" PetscInt_FMT, nroots, pEnd);
149408401ef6SPierre Jolivet     PetscCheck(maxleaf < nroots, PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "Max local leaf %" PetscInt_FMT " >= nroots %" PetscInt_FMT, maxleaf, nroots);
14959566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nroots, &neg, nlocal, &recv));
14969566063dSJacob Faibussowitsch     PetscCall(PetscArrayzero(neg, nroots));
1497ea844a1aSMatthew Knepley   }
1498ea844a1aSMatthew Knepley   /* Mark all local points with negative dof */
1499ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
15009566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s, p, &dof));
15019566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(gs, p, dof));
15029566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s, p, &cdof));
15039566063dSJacob Faibussowitsch     if (!includeConstraints && cdof > 0) PetscCall(PetscSectionSetConstraintDof(gs, p, cdof));
1504ea844a1aSMatthew Knepley     if (neg) neg[p] = -(dof + 1);
1505ea844a1aSMatthew Knepley   }
15069566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUpBC(gs));
15079566063dSJacob 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]));
1508ea844a1aSMatthew Knepley   if (nroots >= 0) {
15099566063dSJacob Faibussowitsch     PetscCall(PetscArrayzero(recv, nlocal));
15109566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastBegin(sf, MPIU_INT, neg, recv, MPI_REPLACE));
15119566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastEnd(sf, MPIU_INT, neg, recv, MPI_REPLACE));
1512ea844a1aSMatthew Knepley     for (p = pStart; p < pEnd; ++p) {
1513ea844a1aSMatthew Knepley       if (recv[p] < 0) {
1514ea844a1aSMatthew Knepley         gs->atlasDof[p - pStart] = recv[p];
15159566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetDof(s, p, &dof));
151608401ef6SPierre Jolivet         PetscCheck(-(recv[p] + 1) == dof, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Global dof %" PetscInt_FMT " for point %" PetscInt_FMT " is not the unconstrained %" PetscInt_FMT, -(recv[p] + 1), p, dof);
1517ea844a1aSMatthew Knepley       }
1518ea844a1aSMatthew Knepley     }
1519ea844a1aSMatthew Knepley   }
1520ea844a1aSMatthew Knepley   /* Calculate new sizes, get process offset, and calculate point offsets */
1521eb9d3e4dSMatthew G. Knepley   if (usePermutation && s->perm) PetscCall(ISGetIndices(s->perm, &pind));
1522ea844a1aSMatthew Knepley   for (p = 0, off = 0; p < pEnd - pStart; ++p) {
1523ea844a1aSMatthew Knepley     const PetscInt q = pind ? pind[p] : p;
1524ea844a1aSMatthew Knepley 
1525ea844a1aSMatthew Knepley     cdof            = (!includeConstraints && s->bc) ? s->bc->atlasDof[q] : 0;
1526ea844a1aSMatthew Knepley     gs->atlasOff[q] = off;
1527ea844a1aSMatthew Knepley     off += gs->atlasDof[q] > 0 ? gs->atlasDof[q] - cdof : 0;
1528ea844a1aSMatthew Knepley   }
1529ea844a1aSMatthew Knepley   if (!localOffsets) {
15309566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Scan(&off, &globalOff, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject)s)));
1531ea844a1aSMatthew Knepley     globalOff -= off;
1532ea844a1aSMatthew Knepley   }
1533ea844a1aSMatthew Knepley   for (p = pStart, off = 0; p < pEnd; ++p) {
1534ea844a1aSMatthew Knepley     gs->atlasOff[p - pStart] += globalOff;
1535ea844a1aSMatthew Knepley     if (neg) neg[p] = -(gs->atlasOff[p - pStart] + 1);
1536ea844a1aSMatthew Knepley   }
1537eb9d3e4dSMatthew G. Knepley   if (usePermutation && s->perm) PetscCall(ISRestoreIndices(s->perm, &pind));
1538ea844a1aSMatthew Knepley   /* Put in negative offsets for ghost points */
1539ea844a1aSMatthew Knepley   if (nroots >= 0) {
15409566063dSJacob Faibussowitsch     PetscCall(PetscArrayzero(recv, nlocal));
15419566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastBegin(sf, MPIU_INT, neg, recv, MPI_REPLACE));
15429566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastEnd(sf, MPIU_INT, neg, recv, MPI_REPLACE));
1543ea844a1aSMatthew Knepley     for (p = pStart; p < pEnd; ++p) {
1544ea844a1aSMatthew Knepley       if (recv[p] < 0) gs->atlasOff[p - pStart] = recv[p];
1545ea844a1aSMatthew Knepley     }
1546ea844a1aSMatthew Knepley   }
15479566063dSJacob Faibussowitsch   PetscCall(PetscFree2(neg, recv));
1548046d2115Sksagiyam   /* Set field dofs/offsets/constraints */
1549046d2115Sksagiyam   for (f = 0; f < numFields; ++f) {
15504cd8913cSStefano Zampini     const char *name;
15514cd8913cSStefano Zampini 
1552046d2115Sksagiyam     gs->field[f]->includesConstraints = includeConstraints;
15539566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldComponents(s, f, &numComponents));
15549566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldComponents(gs, f, numComponents));
15554cd8913cSStefano Zampini     PetscCall(PetscSectionGetFieldName(s, f, &name));
15564cd8913cSStefano Zampini     PetscCall(PetscSectionSetFieldName(gs, f, name));
1557046d2115Sksagiyam   }
1558046d2115Sksagiyam   for (p = pStart; p < pEnd; ++p) {
15599566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(gs, p, &off));
1560046d2115Sksagiyam     for (f = 0, foff = off; f < numFields; ++f) {
15619566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintDof(s, p, f, &cdof));
15629566063dSJacob Faibussowitsch       if (!includeConstraints && cdof > 0) PetscCall(PetscSectionSetFieldConstraintDof(gs, p, f, cdof));
15639566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldDof(s, p, f, &dof));
15649566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldDof(gs, p, f, off < 0 ? -(dof + 1) : dof));
15659566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldOffset(gs, p, f, foff));
15669566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintDof(gs, p, f, &cdof));
1567046d2115Sksagiyam       foff = off < 0 ? foff - (dof - cdof) : foff + (dof - cdof);
1568046d2115Sksagiyam     }
1569046d2115Sksagiyam   }
1570046d2115Sksagiyam   for (f = 0; f < numFields; ++f) {
1571046d2115Sksagiyam     PetscSection gfs = gs->field[f];
1572046d2115Sksagiyam 
15739566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetUpBC(gfs));
15749566063dSJacob 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]));
1575046d2115Sksagiyam   }
1576046d2115Sksagiyam   gs->setup = PETSC_TRUE;
15779566063dSJacob Faibussowitsch   PetscCall(PetscSectionViewFromOptions(gs, NULL, "-global_section_view"));
1578ea844a1aSMatthew Knepley   *gsection = gs;
15793ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1580ea844a1aSMatthew Knepley }
1581ea844a1aSMatthew Knepley 
1582ea844a1aSMatthew Knepley /*@
1583583308b6SBarry Smith   PetscSectionCreateGlobalSectionCensored - Create a `PetscSection` describing the globallayout using
1584583308b6SBarry Smith   a local (sequential) `PetscSection` on each MPI process and an `PetscSF` describing the section point overlap.
1585ea844a1aSMatthew Knepley 
1586ea844a1aSMatthew Knepley   Input Parameters:
1587cab54364SBarry Smith + s                  - The `PetscSection` for the local field layout
1588cab54364SBarry Smith . sf                 - The `PetscSF` describing parallel layout of the section points
1589583308b6SBarry Smith . includeConstraints - By default this is `PETSC_FALSE`, meaning that the global vector will not possess constrained dofs
1590583308b6SBarry Smith . numExcludes        - The number of exclusion ranges, this must have the same value on all MPI processes
1591583308b6SBarry Smith - excludes           - An array [start_0, end_0, start_1, end_1, ...] where there are `numExcludes` pairs and must have the same values on all MPI processes
1592ea844a1aSMatthew Knepley 
1593ea844a1aSMatthew Knepley   Output Parameter:
1594cab54364SBarry Smith . gsection - The `PetscSection` for the global field layout
1595ea844a1aSMatthew Knepley 
1596ea844a1aSMatthew Knepley   Level: advanced
1597ea844a1aSMatthew Knepley 
1598583308b6SBarry Smith   Notes:
1599583308b6SBarry Smith   On each MPI process `gsection` inherits the chart of the `s` on that process.
160020662ed9SBarry Smith 
1601583308b6SBarry Smith   This sets negative sizes and offsets to points not owned by this process as defined by `sf` but that are within the local value of the chart of `gsection`.
1602583308b6SBarry Smith   In those locations the value of size is -(size+1) and the value of the offset on the remote process is -(off+1).
1603583308b6SBarry Smith 
1604583308b6SBarry Smith   This routine augments `PetscSectionCreateGlobalSection()` by allowing one to exclude certain ranges in the chart of the `PetscSection`
1605cab54364SBarry Smith 
160638b5cf2dSJacob Faibussowitsch   Developer Notes:
160720662ed9SBarry Smith   This is a terrible function name
160820662ed9SBarry Smith 
160942747ad1SJacob Faibussowitsch .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreate()`
1610ea844a1aSMatthew Knepley @*/
1611d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionCreateGlobalSectionCensored(PetscSection s, PetscSF sf, PetscBool includeConstraints, PetscInt numExcludes, const PetscInt excludes[], PetscSection *gsection)
1612d71ae5a4SJacob Faibussowitsch {
1613ea844a1aSMatthew Knepley   const PetscInt *pind = NULL;
1614ea844a1aSMatthew Knepley   PetscInt       *neg = NULL, *tmpOff = NULL;
1615ea844a1aSMatthew Knepley   PetscInt        pStart, pEnd, p, e, dof, cdof, off, globalOff = 0, nroots;
1616ea844a1aSMatthew Knepley 
1617ea844a1aSMatthew Knepley   PetscFunctionBegin;
1618ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1619ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
16204f572ea9SToby Isaac   PetscAssertPointer(gsection, 6);
16219566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject)s), gsection));
16229566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
16239566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(*gsection, pStart, pEnd));
16249566063dSJacob Faibussowitsch   PetscCall(PetscSFGetGraph(sf, &nroots, NULL, NULL, NULL));
1625ea844a1aSMatthew Knepley   if (nroots >= 0) {
162608401ef6SPierre Jolivet     PetscCheck(nroots >= pEnd - pStart, PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "PetscSF nroots %" PetscInt_FMT " < %" PetscInt_FMT " section size", nroots, pEnd - pStart);
16279566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(nroots, &neg));
1628ea844a1aSMatthew Knepley     if (nroots > pEnd - pStart) {
16299566063dSJacob Faibussowitsch       PetscCall(PetscCalloc1(nroots, &tmpOff));
1630ea844a1aSMatthew Knepley     } else {
1631ea844a1aSMatthew Knepley       tmpOff = &(*gsection)->atlasDof[-pStart];
1632ea844a1aSMatthew Knepley     }
1633ea844a1aSMatthew Knepley   }
1634ea844a1aSMatthew Knepley   /* Mark ghost points with negative dof */
1635ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
1636ea844a1aSMatthew Knepley     for (e = 0; e < numExcludes; ++e) {
1637ea844a1aSMatthew Knepley       if ((p >= excludes[e * 2 + 0]) && (p < excludes[e * 2 + 1])) {
16389566063dSJacob Faibussowitsch         PetscCall(PetscSectionSetDof(*gsection, p, 0));
1639ea844a1aSMatthew Knepley         break;
1640ea844a1aSMatthew Knepley       }
1641ea844a1aSMatthew Knepley     }
1642ea844a1aSMatthew Knepley     if (e < numExcludes) continue;
16439566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s, p, &dof));
16449566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(*gsection, p, dof));
16459566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s, p, &cdof));
16469566063dSJacob Faibussowitsch     if (!includeConstraints && cdof > 0) PetscCall(PetscSectionSetConstraintDof(*gsection, p, cdof));
1647ea844a1aSMatthew Knepley     if (neg) neg[p] = -(dof + 1);
1648ea844a1aSMatthew Knepley   }
16499566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUpBC(*gsection));
1650ea844a1aSMatthew Knepley   if (nroots >= 0) {
16519566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastBegin(sf, MPIU_INT, neg, tmpOff, MPI_REPLACE));
16529566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastEnd(sf, MPIU_INT, neg, tmpOff, MPI_REPLACE));
1653ea844a1aSMatthew Knepley     if (nroots > pEnd - pStart) {
16549371c9d4SSatish Balay       for (p = pStart; p < pEnd; ++p) {
16559371c9d4SSatish Balay         if (tmpOff[p] < 0) (*gsection)->atlasDof[p - pStart] = tmpOff[p];
16569371c9d4SSatish Balay       }
1657ea844a1aSMatthew Knepley     }
1658ea844a1aSMatthew Knepley   }
165935cb6cd3SPierre Jolivet   /* Calculate new sizes, get process offset, and calculate point offsets */
16609566063dSJacob Faibussowitsch   if (s->perm) PetscCall(ISGetIndices(s->perm, &pind));
1661ea844a1aSMatthew Knepley   for (p = 0, off = 0; p < pEnd - pStart; ++p) {
1662ea844a1aSMatthew Knepley     const PetscInt q = pind ? pind[p] : p;
1663ea844a1aSMatthew Knepley 
1664ea844a1aSMatthew Knepley     cdof                     = (!includeConstraints && s->bc) ? s->bc->atlasDof[q] : 0;
1665ea844a1aSMatthew Knepley     (*gsection)->atlasOff[q] = off;
1666ea844a1aSMatthew Knepley     off += (*gsection)->atlasDof[q] > 0 ? (*gsection)->atlasDof[q] - cdof : 0;
1667ea844a1aSMatthew Knepley   }
16689566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Scan(&off, &globalOff, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject)s)));
1669ea844a1aSMatthew Knepley   globalOff -= off;
1670ea844a1aSMatthew Knepley   for (p = 0, off = 0; p < pEnd - pStart; ++p) {
1671ea844a1aSMatthew Knepley     (*gsection)->atlasOff[p] += globalOff;
1672ea844a1aSMatthew Knepley     if (neg) neg[p + pStart] = -((*gsection)->atlasOff[p] + 1);
1673ea844a1aSMatthew Knepley   }
16749566063dSJacob Faibussowitsch   if (s->perm) PetscCall(ISRestoreIndices(s->perm, &pind));
1675ea844a1aSMatthew Knepley   /* Put in negative offsets for ghost points */
1676ea844a1aSMatthew Knepley   if (nroots >= 0) {
1677ea844a1aSMatthew Knepley     if (nroots == pEnd - pStart) tmpOff = &(*gsection)->atlasOff[-pStart];
16789566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastBegin(sf, MPIU_INT, neg, tmpOff, MPI_REPLACE));
16799566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastEnd(sf, MPIU_INT, neg, tmpOff, MPI_REPLACE));
1680ea844a1aSMatthew Knepley     if (nroots > pEnd - pStart) {
16819371c9d4SSatish Balay       for (p = pStart; p < pEnd; ++p) {
16829371c9d4SSatish Balay         if (tmpOff[p] < 0) (*gsection)->atlasOff[p - pStart] = tmpOff[p];
16839371c9d4SSatish Balay       }
1684ea844a1aSMatthew Knepley     }
1685ea844a1aSMatthew Knepley   }
16869566063dSJacob Faibussowitsch   if (nroots >= 0 && nroots > pEnd - pStart) PetscCall(PetscFree(tmpOff));
16879566063dSJacob Faibussowitsch   PetscCall(PetscFree(neg));
16883ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1689ea844a1aSMatthew Knepley }
1690ea844a1aSMatthew Knepley 
1691ea844a1aSMatthew Knepley /*@
1692583308b6SBarry Smith   PetscSectionGetPointLayout - Get a `PetscLayout` for the points with nonzero dof counts of the unnamed default field within this `PetscSection`s local chart
1693ea844a1aSMatthew Knepley 
1694cab54364SBarry Smith   Collective
1695ea844a1aSMatthew Knepley 
1696ea844a1aSMatthew Knepley   Input Parameters:
1697cab54364SBarry Smith + comm - The `MPI_Comm`
1698cab54364SBarry Smith - s    - The `PetscSection`
1699ea844a1aSMatthew Knepley 
1700ea844a1aSMatthew Knepley   Output Parameter:
170120662ed9SBarry Smith . layout - The point layout for the data that defines the section
1702ea844a1aSMatthew Knepley 
1703ea844a1aSMatthew Knepley   Level: advanced
1704ea844a1aSMatthew Knepley 
170520662ed9SBarry Smith   Notes:
1706583308b6SBarry Smith   `PetscSectionGetValueLayout()` provides similar information but counting the total number of degrees of freedom on the MPI process (excluding constrained
1707583308b6SBarry Smith   degrees of freedom).
170820662ed9SBarry Smith 
1709583308b6SBarry Smith   This count includes constrained degrees of freedom
1710583308b6SBarry Smith 
1711583308b6SBarry Smith   This is usually called on the default global section.
1712583308b6SBarry Smith 
1713583308b6SBarry Smith   Example:
1714583308b6SBarry Smith .vb
1715583308b6SBarry Smith      The chart is [2,5), point 2 has 2 dof, point 3 has 0 dof, point 4 has 1 dof
1716583308b6SBarry Smith      The local size of the `PetscLayout` is 2 since 2 points have a non-zero number of dof
1717583308b6SBarry Smith .ve
1718583308b6SBarry Smith 
171938b5cf2dSJacob Faibussowitsch   Developer Notes:
1720583308b6SBarry Smith   I find the names of these two functions extremely non-informative
1721cab54364SBarry Smith 
1722cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetValueLayout()`, `PetscSectionCreate()`
1723ea844a1aSMatthew Knepley @*/
1724d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetPointLayout(MPI_Comm comm, PetscSection s, PetscLayout *layout)
1725d71ae5a4SJacob Faibussowitsch {
1726ea844a1aSMatthew Knepley   PetscInt pStart, pEnd, p, localSize = 0;
1727ea844a1aSMatthew Knepley 
1728ea844a1aSMatthew Knepley   PetscFunctionBegin;
17299566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
1730ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
1731ea844a1aSMatthew Knepley     PetscInt dof;
1732ea844a1aSMatthew Knepley 
17339566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s, p, &dof));
17349120ba30SVaclav Hapla     if (dof >= 0) ++localSize;
1735ea844a1aSMatthew Knepley   }
17369566063dSJacob Faibussowitsch   PetscCall(PetscLayoutCreate(comm, layout));
17379566063dSJacob Faibussowitsch   PetscCall(PetscLayoutSetLocalSize(*layout, localSize));
17389566063dSJacob Faibussowitsch   PetscCall(PetscLayoutSetBlockSize(*layout, 1));
17399566063dSJacob Faibussowitsch   PetscCall(PetscLayoutSetUp(*layout));
17403ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1741ea844a1aSMatthew Knepley }
1742ea844a1aSMatthew Knepley 
1743ea844a1aSMatthew Knepley /*@
174420662ed9SBarry Smith   PetscSectionGetValueLayout - Get the `PetscLayout` associated with the section dofs of a `PetscSection`
1745ea844a1aSMatthew Knepley 
1746cab54364SBarry Smith   Collective
1747ea844a1aSMatthew Knepley 
1748ea844a1aSMatthew Knepley   Input Parameters:
1749cab54364SBarry Smith + comm - The `MPI_Comm`
1750cab54364SBarry Smith - s    - The `PetscSection`
1751ea844a1aSMatthew Knepley 
1752ea844a1aSMatthew Knepley   Output Parameter:
1753ea844a1aSMatthew Knepley . layout - The dof layout for the section
1754ea844a1aSMatthew Knepley 
1755ea844a1aSMatthew Knepley   Level: advanced
1756ea844a1aSMatthew Knepley 
175720662ed9SBarry Smith   Notes:
1758583308b6SBarry Smith   `PetscSectionGetPointLayout()` provides similar information but only counting the number of points with nonzero degrees of freedom and
1759583308b6SBarry Smith   including the constrained degrees of freedom
176020662ed9SBarry Smith 
1761cab54364SBarry Smith   This is usually called for the default global section.
1762cab54364SBarry Smith 
1763583308b6SBarry Smith   Example:
1764583308b6SBarry Smith .vb
1765583308b6SBarry Smith      The chart is [2,5), point 2 has 4 dof (2 constrained), point 3 has 0 dof, point 4 has 1 dof (not constrained)
1766583308b6SBarry Smith      The local size of the `PetscLayout` is 3 since there are 3 unconstrained degrees of freedom on this MPI process
1767583308b6SBarry Smith .ve
1768583308b6SBarry Smith 
1769cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetPointLayout()`, `PetscSectionCreate()`
1770ea844a1aSMatthew Knepley @*/
1771d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetValueLayout(MPI_Comm comm, PetscSection s, PetscLayout *layout)
1772d71ae5a4SJacob Faibussowitsch {
1773ea844a1aSMatthew Knepley   PetscInt pStart, pEnd, p, localSize = 0;
1774ea844a1aSMatthew Knepley 
1775ea844a1aSMatthew Knepley   PetscFunctionBegin;
1776ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 2);
17774f572ea9SToby Isaac   PetscAssertPointer(layout, 3);
17789566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
1779ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
1780ea844a1aSMatthew Knepley     PetscInt dof, cdof;
1781ea844a1aSMatthew Knepley 
17829566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s, p, &dof));
17839566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s, p, &cdof));
1784ea844a1aSMatthew Knepley     if (dof - cdof > 0) localSize += dof - cdof;
1785ea844a1aSMatthew Knepley   }
17869566063dSJacob Faibussowitsch   PetscCall(PetscLayoutCreate(comm, layout));
17879566063dSJacob Faibussowitsch   PetscCall(PetscLayoutSetLocalSize(*layout, localSize));
17889566063dSJacob Faibussowitsch   PetscCall(PetscLayoutSetBlockSize(*layout, 1));
17899566063dSJacob Faibussowitsch   PetscCall(PetscLayoutSetUp(*layout));
17903ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1791ea844a1aSMatthew Knepley }
1792ea844a1aSMatthew Knepley 
1793ea844a1aSMatthew Knepley /*@
1794db527f05SMatthew G. Knepley   PetscSectionGetOffset - Return the offset into an array or `Vec` for the dof associated with the given point.
1795ea844a1aSMatthew Knepley 
179640750d41SVaclav Hapla   Not Collective
1797ea844a1aSMatthew Knepley 
1798ea844a1aSMatthew Knepley   Input Parameters:
1799cab54364SBarry Smith + s     - the `PetscSection`
1800ea844a1aSMatthew Knepley - point - the point
1801ea844a1aSMatthew Knepley 
1802ea844a1aSMatthew Knepley   Output Parameter:
1803ea844a1aSMatthew Knepley . offset - the offset
1804ea844a1aSMatthew Knepley 
1805ea844a1aSMatthew Knepley   Level: intermediate
1806ea844a1aSMatthew Knepley 
1807583308b6SBarry Smith   Notes:
1808376335faSBarry Smith   In a global section, `offset` will be negative for points not owned by this process.
1809583308b6SBarry Smith 
1810583308b6SBarry Smith   This is for the unnamed default field in the `PetscSection` not the named fields
1811583308b6SBarry Smith 
1812583308b6SBarry Smith   The `offset` values are different depending on a value set with `PetscSectionSetPointMajor()`
1813583308b6SBarry Smith 
1814583308b6SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetFieldOffset()`, `PetscSectionCreate()`, `PetscSectionSetPointMajor()`
1815ea844a1aSMatthew Knepley @*/
1816d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetOffset(PetscSection s, PetscInt point, PetscInt *offset)
1817d71ae5a4SJacob Faibussowitsch {
1818ea844a1aSMatthew Knepley   PetscFunctionBegin;
1819ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
18204f572ea9SToby Isaac   PetscAssertPointer(offset, 3);
1821b498ca8aSPierre Jolivet   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);
1822ea844a1aSMatthew Knepley   *offset = s->atlasOff[point - s->pStart];
18233ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1824ea844a1aSMatthew Knepley }
1825ea844a1aSMatthew Knepley 
1826ea844a1aSMatthew Knepley /*@
1827db527f05SMatthew G. Knepley   PetscSectionSetOffset - Set the offset into an array or `Vec` for the dof associated with the given point.
1828ea844a1aSMatthew Knepley 
182940750d41SVaclav Hapla   Not Collective
1830ea844a1aSMatthew Knepley 
1831ea844a1aSMatthew Knepley   Input Parameters:
1832cab54364SBarry Smith + s      - the `PetscSection`
1833ea844a1aSMatthew Knepley . point  - the point
1834376335faSBarry Smith - offset - the offset, these values may be negative indicating the values are off process
1835ea844a1aSMatthew Knepley 
1836583308b6SBarry Smith   Level: developer
1837ea844a1aSMatthew Knepley 
1838cab54364SBarry Smith   Note:
1839cab54364SBarry Smith   The user usually does not call this function, but uses `PetscSectionSetUp()`
1840cab54364SBarry Smith 
1841cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetFieldOffset()`, `PetscSectionCreate()`, `PetscSectionSetUp()`
1842ea844a1aSMatthew Knepley @*/
1843d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetOffset(PetscSection s, PetscInt point, PetscInt offset)
1844d71ae5a4SJacob Faibussowitsch {
1845ea844a1aSMatthew Knepley   PetscFunctionBegin;
1846ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
184708401ef6SPierre Jolivet   PetscCheck(!(point < s->pStart) && !(point >= s->pEnd), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Section point %" PetscInt_FMT " should be in [%" PetscInt_FMT ", %" PetscInt_FMT ")", point, s->pStart, s->pEnd);
1848ea844a1aSMatthew Knepley   s->atlasOff[point - s->pStart] = offset;
18493ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1850ea844a1aSMatthew Knepley }
1851ea844a1aSMatthew Knepley 
1852ea844a1aSMatthew Knepley /*@
1853db527f05SMatthew G. Knepley   PetscSectionGetFieldOffset - Return the offset into an array or `Vec` for the field dof associated with the given point.
1854ea844a1aSMatthew Knepley 
185540750d41SVaclav Hapla   Not Collective
1856ea844a1aSMatthew Knepley 
1857ea844a1aSMatthew Knepley   Input Parameters:
1858cab54364SBarry Smith + s     - the `PetscSection`
1859ea844a1aSMatthew Knepley . point - the point
1860ea844a1aSMatthew Knepley - field - the field
1861ea844a1aSMatthew Knepley 
1862ea844a1aSMatthew Knepley   Output Parameter:
1863ea844a1aSMatthew Knepley . offset - the offset
1864ea844a1aSMatthew Knepley 
1865ea844a1aSMatthew Knepley   Level: intermediate
1866ea844a1aSMatthew Knepley 
1867583308b6SBarry Smith   Notes:
1868376335faSBarry Smith   In a global section, `offset` will be negative for points not owned by this process.
1869583308b6SBarry Smith 
1870583308b6SBarry Smith   The `offset` values are different depending on a value set with `PetscSectionSetPointMajor()`
1871583308b6SBarry Smith 
1872583308b6SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetOffset()`, `PetscSectionCreate()`, `PetscSectionGetFieldPointOffset()`
1873ea844a1aSMatthew Knepley @*/
1874d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetFieldOffset(PetscSection s, PetscInt point, PetscInt field, PetscInt *offset)
1875d71ae5a4SJacob Faibussowitsch {
1876ea844a1aSMatthew Knepley   PetscFunctionBegin;
1877ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
18784f572ea9SToby Isaac   PetscAssertPointer(offset, 4);
18792abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field, s->numFields);
18809566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(s->field[field], point, offset));
18813ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1882ea844a1aSMatthew Knepley }
1883ea844a1aSMatthew Knepley 
1884ea844a1aSMatthew Knepley /*@
1885db527f05SMatthew G. Knepley   PetscSectionSetFieldOffset - Set the offset into an array or `Vec` for the dof associated with the given field at a point.
1886ea844a1aSMatthew Knepley 
188740750d41SVaclav Hapla   Not Collective
1888ea844a1aSMatthew Knepley 
1889ea844a1aSMatthew Knepley   Input Parameters:
189020662ed9SBarry Smith + s      - the `PetscSection`
1891ea844a1aSMatthew Knepley . point  - the point
1892ea844a1aSMatthew Knepley . field  - the field
1893376335faSBarry Smith - offset - the offset, these values may be negative indicating the values are off process
1894ea844a1aSMatthew Knepley 
1895cab54364SBarry Smith   Level: developer
1896ea844a1aSMatthew Knepley 
1897cab54364SBarry Smith   Note:
1898cab54364SBarry Smith   The user usually does not call this function, but uses `PetscSectionSetUp()`
1899ea844a1aSMatthew Knepley 
1900cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetFieldOffset()`, `PetscSectionSetOffset()`, `PetscSectionCreate()`, `PetscSectionSetUp()`
1901ea844a1aSMatthew Knepley @*/
1902d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetFieldOffset(PetscSection s, PetscInt point, PetscInt field, PetscInt offset)
1903d71ae5a4SJacob Faibussowitsch {
1904ea844a1aSMatthew Knepley   PetscFunctionBegin;
1905ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
19062abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field, s->numFields);
19079566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetOffset(s->field[field], point, offset));
19083ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1909ea844a1aSMatthew Knepley }
1910ea844a1aSMatthew Knepley 
1911ea844a1aSMatthew Knepley /*@
1912583308b6SBarry Smith   PetscSectionGetFieldPointOffset - Return the offset for the first field dof associated with the given point relative to the offset for that point for the
1913583308b6SBarry Smith   unnamed default field's first dof
1914ea844a1aSMatthew Knepley 
191540750d41SVaclav Hapla   Not Collective
1916ea844a1aSMatthew Knepley 
1917ea844a1aSMatthew Knepley   Input Parameters:
1918cab54364SBarry Smith + s     - the `PetscSection`
1919ea844a1aSMatthew Knepley . point - the point
1920ea844a1aSMatthew Knepley - field - the field
1921ea844a1aSMatthew Knepley 
1922ea844a1aSMatthew Knepley   Output Parameter:
1923ea844a1aSMatthew Knepley . offset - the offset
1924ea844a1aSMatthew Knepley 
1925ea844a1aSMatthew Knepley   Level: advanced
1926ea844a1aSMatthew Knepley 
1927cab54364SBarry Smith   Note:
1928583308b6SBarry Smith   This ignores constraints
1929cab54364SBarry Smith 
1930583308b6SBarry Smith   Example:
1931583308b6SBarry Smith .vb
1932583308b6SBarry Smith   if PetscSectionSetPointMajor(s,PETSC_TRUE)
1933583308b6SBarry Smith   The unnamed default field has 3 dof at `point`
1934583308b6SBarry Smith   Field 0 has 2 dof at `point`
1935583308b6SBarry Smith   Then PetscSectionGetFieldPointOffset(s,point,1,&offset) returns and offset of 5
1936583308b6SBarry Smith .ve
1937583308b6SBarry Smith 
1938583308b6SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetOffset()`, `PetscSectionCreate()`, `PetscSectionGetFieldOffset()`
1939ea844a1aSMatthew Knepley @*/
1940d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetFieldPointOffset(PetscSection s, PetscInt point, PetscInt field, PetscInt *offset)
1941d71ae5a4SJacob Faibussowitsch {
1942ea844a1aSMatthew Knepley   PetscInt off, foff;
1943ea844a1aSMatthew Knepley 
1944ea844a1aSMatthew Knepley   PetscFunctionBegin;
1945ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
19464f572ea9SToby Isaac   PetscAssertPointer(offset, 4);
19472abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field, s->numFields);
19489566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(s, point, &off));
19499566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(s->field[field], point, &foff));
1950ea844a1aSMatthew Knepley   *offset = foff - off;
19513ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1952ea844a1aSMatthew Knepley }
1953ea844a1aSMatthew Knepley 
1954ea844a1aSMatthew Knepley /*@
195520662ed9SBarry Smith   PetscSectionGetOffsetRange - Return the full range of offsets [`start`, `end`) for a `PetscSection`
1956ea844a1aSMatthew Knepley 
195740750d41SVaclav Hapla   Not Collective
1958ea844a1aSMatthew Knepley 
1959ea844a1aSMatthew Knepley   Input Parameter:
1960cab54364SBarry Smith . s - the `PetscSection`
1961ea844a1aSMatthew Knepley 
1962ea844a1aSMatthew Knepley   Output Parameters:
1963ea844a1aSMatthew Knepley + start - the minimum offset
1964ea844a1aSMatthew Knepley - end   - one more than the maximum offset
1965ea844a1aSMatthew Knepley 
1966ea844a1aSMatthew Knepley   Level: intermediate
1967ea844a1aSMatthew Knepley 
1968cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetOffset()`, `PetscSectionCreate()`
1969ea844a1aSMatthew Knepley @*/
1970d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetOffsetRange(PetscSection s, PetscInt *start, PetscInt *end)
1971d71ae5a4SJacob Faibussowitsch {
1972ea844a1aSMatthew Knepley   PetscInt os = 0, oe = 0, pStart, pEnd, p;
1973ea844a1aSMatthew Knepley 
1974ea844a1aSMatthew Knepley   PetscFunctionBegin;
1975ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
19769371c9d4SSatish Balay   if (s->atlasOff) {
19779371c9d4SSatish Balay     os = s->atlasOff[0];
19789371c9d4SSatish Balay     oe = s->atlasOff[0];
19799371c9d4SSatish Balay   }
19809566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
1981ea844a1aSMatthew Knepley   for (p = 0; p < pEnd - pStart; ++p) {
1982ea844a1aSMatthew Knepley     PetscInt dof = s->atlasDof[p], off = s->atlasOff[p];
1983ea844a1aSMatthew Knepley 
1984ea844a1aSMatthew Knepley     if (off >= 0) {
1985ea844a1aSMatthew Knepley       os = PetscMin(os, off);
1986ea844a1aSMatthew Knepley       oe = PetscMax(oe, off + dof);
1987ea844a1aSMatthew Knepley     }
1988ea844a1aSMatthew Knepley   }
1989ea844a1aSMatthew Knepley   if (start) *start = os;
1990ea844a1aSMatthew Knepley   if (end) *end = oe;
19913ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1992ea844a1aSMatthew Knepley }
1993ea844a1aSMatthew Knepley 
1994ea844a1aSMatthew Knepley /*@
1995583308b6SBarry Smith   PetscSectionCreateSubsection - Create a new, smaller `PetscSection` composed of only selected fields
1996ea844a1aSMatthew Knepley 
199740750d41SVaclav Hapla   Collective
1998ea844a1aSMatthew Knepley 
1999d8d19677SJose E. Roman   Input Parameters:
2000cab54364SBarry Smith + s      - the `PetscSection`
2001ea844a1aSMatthew Knepley . len    - the number of subfields
2002ea844a1aSMatthew Knepley - fields - the subfield numbers
2003ea844a1aSMatthew Knepley 
2004ea844a1aSMatthew Knepley   Output Parameter:
2005ea844a1aSMatthew Knepley . subs - the subsection
2006ea844a1aSMatthew Knepley 
2007ea844a1aSMatthew Knepley   Level: advanced
2008ea844a1aSMatthew Knepley 
2009cab54364SBarry Smith   Notes:
2010583308b6SBarry Smith   The chart of `subs` is the same as the chart of `s`
2011cab54364SBarry Smith 
2012cab54364SBarry Smith   This will error if a fieldnumber is out of range
2013cab54364SBarry Smith 
2014cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreateSupersection()`, `PetscSectionCreate()`
2015ea844a1aSMatthew Knepley @*/
2016d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionCreateSubsection(PetscSection s, PetscInt len, const PetscInt fields[], PetscSection *subs)
2017d71ae5a4SJacob Faibussowitsch {
2018b778fa18SValeria Barra   PetscInt nF, f, c, pStart, pEnd, p, maxCdof = 0;
2019ea844a1aSMatthew Knepley 
2020ea844a1aSMatthew Knepley   PetscFunctionBegin;
20213ba16761SJacob Faibussowitsch   if (!len) PetscFunctionReturn(PETSC_SUCCESS);
2022ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
20234f572ea9SToby Isaac   PetscAssertPointer(fields, 3);
20244f572ea9SToby Isaac   PetscAssertPointer(subs, 4);
20259566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetNumFields(s, &nF));
202608401ef6SPierre Jolivet   PetscCheck(len <= nF, PetscObjectComm((PetscObject)s), PETSC_ERR_ARG_WRONG, "Number of requested fields %" PetscInt_FMT " greater than number of fields %" PetscInt_FMT, len, nF);
20279566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject)s), subs));
20289566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetNumFields(*subs, len));
2029ea844a1aSMatthew Knepley   for (f = 0; f < len; ++f) {
2030ea844a1aSMatthew Knepley     const char     *name    = NULL;
2031ea844a1aSMatthew Knepley     PetscInt        numComp = 0;
203242a52479SJed Brown     PetscSectionSym sym;
2033ea844a1aSMatthew Knepley 
20349566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldName(s, fields[f], &name));
20359566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldName(*subs, f, name));
20369566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldComponents(s, fields[f], &numComp));
20379566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldComponents(*subs, f, numComp));
2038b778fa18SValeria Barra     for (c = 0; c < s->numFieldComponents[fields[f]]; ++c) {
20399566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetComponentName(s, fields[f], c, &name));
20409566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetComponentName(*subs, f, c, name));
2041b778fa18SValeria Barra     }
204242a52479SJed Brown     PetscCall(PetscSectionGetFieldSym(s, fields[f], &sym));
204342a52479SJed Brown     PetscCall(PetscSectionSetFieldSym(*subs, f, sym));
2044ea844a1aSMatthew Knepley   }
20459566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
20469566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(*subs, pStart, pEnd));
2047ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
2048ea844a1aSMatthew Knepley     PetscInt dof = 0, cdof = 0, fdof = 0, cfdof = 0;
2049ea844a1aSMatthew Knepley 
2050ea844a1aSMatthew Knepley     for (f = 0; f < len; ++f) {
20519566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldDof(s, p, fields[f], &fdof));
20529566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldDof(*subs, p, f, fdof));
20539566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintDof(s, p, fields[f], &cfdof));
20549566063dSJacob Faibussowitsch       if (cfdof) PetscCall(PetscSectionSetFieldConstraintDof(*subs, p, f, cfdof));
2055ea844a1aSMatthew Knepley       dof += fdof;
2056ea844a1aSMatthew Knepley       cdof += cfdof;
2057ea844a1aSMatthew Knepley     }
20589566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(*subs, p, dof));
20599566063dSJacob Faibussowitsch     if (cdof) PetscCall(PetscSectionSetConstraintDof(*subs, p, cdof));
2060ea844a1aSMatthew Knepley     maxCdof = PetscMax(cdof, maxCdof);
2061ea844a1aSMatthew Knepley   }
20629566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(*subs));
2063ea844a1aSMatthew Knepley   if (maxCdof) {
2064ea844a1aSMatthew Knepley     PetscInt *indices;
2065ea844a1aSMatthew Knepley 
20669566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(maxCdof, &indices));
2067ea844a1aSMatthew Knepley     for (p = pStart; p < pEnd; ++p) {
2068ea844a1aSMatthew Knepley       PetscInt cdof;
2069ea844a1aSMatthew Knepley 
20709566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetConstraintDof(*subs, p, &cdof));
2071ea844a1aSMatthew Knepley       if (cdof) {
2072ea844a1aSMatthew Knepley         const PetscInt *oldIndices = NULL;
2073ea844a1aSMatthew Knepley         PetscInt        fdof = 0, cfdof = 0, fc, numConst = 0, fOff = 0;
2074ea844a1aSMatthew Knepley 
2075ea844a1aSMatthew Knepley         for (f = 0; f < len; ++f) {
20769566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetFieldDof(s, p, fields[f], &fdof));
20779566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetFieldConstraintDof(s, p, fields[f], &cfdof));
20789566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetFieldConstraintIndices(s, p, fields[f], &oldIndices));
20799566063dSJacob Faibussowitsch           PetscCall(PetscSectionSetFieldConstraintIndices(*subs, p, f, oldIndices));
20809574d0f0SMatthew G. Knepley           for (fc = 0; fc < cfdof; ++fc) indices[numConst + fc] = oldIndices[fc] + fOff;
2081ea844a1aSMatthew Knepley           numConst += cfdof;
2082ea844a1aSMatthew Knepley           fOff += fdof;
2083ea844a1aSMatthew Knepley         }
20849566063dSJacob Faibussowitsch         PetscCall(PetscSectionSetConstraintIndices(*subs, p, indices));
2085ea844a1aSMatthew Knepley       }
2086ea844a1aSMatthew Knepley     }
20879566063dSJacob Faibussowitsch     PetscCall(PetscFree(indices));
2088ea844a1aSMatthew Knepley   }
20893ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2090ea844a1aSMatthew Knepley }
2091ea844a1aSMatthew Knepley 
2092ea844a1aSMatthew Knepley /*@
20935becf6f4SMatthew G. Knepley   PetscSectionCreateComponentSubsection - Create a new, smaller `PetscSection` composed of only selected components
20945becf6f4SMatthew G. Knepley 
20955becf6f4SMatthew G. Knepley   Collective
20965becf6f4SMatthew G. Knepley 
20975becf6f4SMatthew G. Knepley   Input Parameters:
20985becf6f4SMatthew G. Knepley + s     - the `PetscSection`
20995becf6f4SMatthew G. Knepley . len   - the number of components
21005becf6f4SMatthew G. Knepley - comps - the component numbers
21015becf6f4SMatthew G. Knepley 
21025becf6f4SMatthew G. Knepley   Output Parameter:
21035becf6f4SMatthew G. Knepley . subs - the subsection
21045becf6f4SMatthew G. Knepley 
21055becf6f4SMatthew G. Knepley   Level: advanced
21065becf6f4SMatthew G. Knepley 
21075becf6f4SMatthew G. Knepley   Notes:
21085becf6f4SMatthew G. Knepley   The chart of `subs` is the same as the chart of `s`
21095becf6f4SMatthew G. Knepley 
21105becf6f4SMatthew G. Knepley   This will error if the section has more than one field, or if a component number is out of range
21115becf6f4SMatthew G. Knepley 
21125becf6f4SMatthew G. Knepley .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreateSupersection()`, `PetscSectionCreate()`
21135becf6f4SMatthew G. Knepley @*/
21145becf6f4SMatthew G. Knepley PetscErrorCode PetscSectionCreateComponentSubsection(PetscSection s, PetscInt len, const PetscInt comps[], PetscSection *subs)
21155becf6f4SMatthew G. Knepley {
21165becf6f4SMatthew G. Knepley   PetscSectionSym sym;
21175becf6f4SMatthew G. Knepley   const char     *name = NULL;
21185becf6f4SMatthew G. Knepley   PetscInt        Nf, pStart, pEnd;
21195becf6f4SMatthew G. Knepley 
21205becf6f4SMatthew G. Knepley   PetscFunctionBegin;
21215becf6f4SMatthew G. Knepley   if (!len) PetscFunctionReturn(PETSC_SUCCESS);
21225becf6f4SMatthew G. Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
21235becf6f4SMatthew G. Knepley   PetscAssertPointer(comps, 3);
21245becf6f4SMatthew G. Knepley   PetscAssertPointer(subs, 4);
21255becf6f4SMatthew G. Knepley   PetscCall(PetscSectionGetNumFields(s, &Nf));
21265becf6f4SMatthew G. Knepley   PetscCheck(Nf == 1, PetscObjectComm((PetscObject)s), PETSC_ERR_ARG_WRONG, "This method can only handle one field, not %" PetscInt_FMT, Nf);
21275becf6f4SMatthew G. Knepley   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject)s), subs));
21285becf6f4SMatthew G. Knepley   PetscCall(PetscSectionSetNumFields(*subs, 1));
21295becf6f4SMatthew G. Knepley   PetscCall(PetscSectionGetFieldName(s, 0, &name));
21305becf6f4SMatthew G. Knepley   PetscCall(PetscSectionSetFieldName(*subs, 0, name));
21315becf6f4SMatthew G. Knepley   PetscCall(PetscSectionSetFieldComponents(*subs, 0, len));
21325becf6f4SMatthew G. Knepley   PetscCall(PetscSectionGetFieldSym(s, 0, &sym));
21335becf6f4SMatthew G. Knepley   PetscCall(PetscSectionSetFieldSym(*subs, 0, sym));
21345becf6f4SMatthew G. Knepley   for (PetscInt c = 0; c < len; ++c) {
21355becf6f4SMatthew G. Knepley     PetscCall(PetscSectionGetComponentName(s, 0, comps[c], &name));
21365becf6f4SMatthew G. Knepley     PetscCall(PetscSectionSetComponentName(*subs, 0, c, name));
21375becf6f4SMatthew G. Knepley   }
21385becf6f4SMatthew G. Knepley   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
21395becf6f4SMatthew G. Knepley   PetscCall(PetscSectionSetChart(*subs, pStart, pEnd));
21405becf6f4SMatthew G. Knepley   for (PetscInt p = pStart; p < pEnd; ++p) {
21415becf6f4SMatthew G. Knepley     PetscInt dof, cdof, cfdof;
21425becf6f4SMatthew G. Knepley 
21435becf6f4SMatthew G. Knepley     PetscCall(PetscSectionGetDof(s, p, &dof));
21445becf6f4SMatthew G. Knepley     if (!dof) continue;
21455becf6f4SMatthew G. Knepley     PetscCall(PetscSectionGetFieldConstraintDof(s, p, 0, &cfdof));
21465becf6f4SMatthew G. Knepley     PetscCall(PetscSectionGetConstraintDof(s, p, &cdof));
21475becf6f4SMatthew G. Knepley     PetscCheck(!cdof && !cfdof, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Component selection does not work with constraints");
21485becf6f4SMatthew G. Knepley     PetscCall(PetscSectionSetFieldDof(*subs, p, 0, len));
21495becf6f4SMatthew G. Knepley     PetscCall(PetscSectionSetDof(*subs, p, len));
21505becf6f4SMatthew G. Knepley   }
21515becf6f4SMatthew G. Knepley   PetscCall(PetscSectionSetUp(*subs));
21525becf6f4SMatthew G. Knepley   PetscFunctionReturn(PETSC_SUCCESS);
21535becf6f4SMatthew G. Knepley }
21545becf6f4SMatthew G. Knepley 
21555becf6f4SMatthew G. Knepley /*@
2156583308b6SBarry Smith   PetscSectionCreateSupersection - Create a new, larger section composed of multiple `PetscSection`s
2157ea844a1aSMatthew Knepley 
215840750d41SVaclav Hapla   Collective
2159ea844a1aSMatthew Knepley 
2160ea844a1aSMatthew Knepley   Input Parameters:
2161ea844a1aSMatthew Knepley + s   - the input sections
2162ea844a1aSMatthew Knepley - len - the number of input sections
2163ea844a1aSMatthew Knepley 
2164ea844a1aSMatthew Knepley   Output Parameter:
2165ea844a1aSMatthew Knepley . supers - the supersection
2166ea844a1aSMatthew Knepley 
2167ea844a1aSMatthew Knepley   Level: advanced
2168ea844a1aSMatthew Knepley 
2169583308b6SBarry Smith   Notes:
2170cab54364SBarry Smith   The section offsets now refer to a new, larger vector.
2171cab54364SBarry Smith 
217238b5cf2dSJacob Faibussowitsch   Developer Notes:
2173cab54364SBarry Smith   Needs to explain how the sections are composed
2174cab54364SBarry Smith 
2175cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreateSubsection()`, `PetscSectionCreate()`
2176ea844a1aSMatthew Knepley @*/
2177d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionCreateSupersection(PetscSection s[], PetscInt len, PetscSection *supers)
2178d71ae5a4SJacob Faibussowitsch {
2179ea844a1aSMatthew Knepley   PetscInt Nf = 0, f, pStart = PETSC_MAX_INT, pEnd = 0, p, maxCdof = 0, i;
2180ea844a1aSMatthew Knepley 
2181ea844a1aSMatthew Knepley   PetscFunctionBegin;
21823ba16761SJacob Faibussowitsch   if (!len) PetscFunctionReturn(PETSC_SUCCESS);
2183ea844a1aSMatthew Knepley   for (i = 0; i < len; ++i) {
2184ea844a1aSMatthew Knepley     PetscInt nf, pStarti, pEndi;
2185ea844a1aSMatthew Knepley 
21869566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetNumFields(s[i], &nf));
21879566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetChart(s[i], &pStarti, &pEndi));
2188ea844a1aSMatthew Knepley     pStart = PetscMin(pStart, pStarti);
2189ea844a1aSMatthew Knepley     pEnd   = PetscMax(pEnd, pEndi);
2190ea844a1aSMatthew Knepley     Nf += nf;
2191ea844a1aSMatthew Knepley   }
21929566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject)s[0]), supers));
21939566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetNumFields(*supers, Nf));
2194ea844a1aSMatthew Knepley   for (i = 0, f = 0; i < len; ++i) {
2195b778fa18SValeria Barra     PetscInt nf, fi, ci;
2196ea844a1aSMatthew Knepley 
21979566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetNumFields(s[i], &nf));
2198ea844a1aSMatthew Knepley     for (fi = 0; fi < nf; ++fi, ++f) {
2199ea844a1aSMatthew Knepley       const char *name    = NULL;
2200ea844a1aSMatthew Knepley       PetscInt    numComp = 0;
2201ea844a1aSMatthew Knepley 
22029566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldName(s[i], fi, &name));
22039566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldName(*supers, f, name));
22049566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldComponents(s[i], fi, &numComp));
22059566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldComponents(*supers, f, numComp));
2206b778fa18SValeria Barra       for (ci = 0; ci < s[i]->numFieldComponents[fi]; ++ci) {
22079566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetComponentName(s[i], fi, ci, &name));
22089566063dSJacob Faibussowitsch         PetscCall(PetscSectionSetComponentName(*supers, f, ci, name));
2209b778fa18SValeria Barra       }
2210ea844a1aSMatthew Knepley     }
2211ea844a1aSMatthew Knepley   }
22129566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(*supers, pStart, pEnd));
2213ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
2214ea844a1aSMatthew Knepley     PetscInt dof = 0, cdof = 0;
2215ea844a1aSMatthew Knepley 
2216ea844a1aSMatthew Knepley     for (i = 0, f = 0; i < len; ++i) {
2217ea844a1aSMatthew Knepley       PetscInt nf, fi, pStarti, pEndi;
2218ea844a1aSMatthew Knepley       PetscInt fdof = 0, cfdof = 0;
2219ea844a1aSMatthew Knepley 
22209566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetNumFields(s[i], &nf));
22219566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetChart(s[i], &pStarti, &pEndi));
2222ea844a1aSMatthew Knepley       if ((p < pStarti) || (p >= pEndi)) continue;
2223ea844a1aSMatthew Knepley       for (fi = 0; fi < nf; ++fi, ++f) {
22249566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetFieldDof(s[i], p, fi, &fdof));
22259566063dSJacob Faibussowitsch         PetscCall(PetscSectionAddFieldDof(*supers, p, f, fdof));
22269566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetFieldConstraintDof(s[i], p, fi, &cfdof));
22279566063dSJacob Faibussowitsch         if (cfdof) PetscCall(PetscSectionAddFieldConstraintDof(*supers, p, f, cfdof));
2228ea844a1aSMatthew Knepley         dof += fdof;
2229ea844a1aSMatthew Knepley         cdof += cfdof;
2230ea844a1aSMatthew Knepley       }
2231ea844a1aSMatthew Knepley     }
22329566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(*supers, p, dof));
22339566063dSJacob Faibussowitsch     if (cdof) PetscCall(PetscSectionSetConstraintDof(*supers, p, cdof));
2234ea844a1aSMatthew Knepley     maxCdof = PetscMax(cdof, maxCdof);
2235ea844a1aSMatthew Knepley   }
22369566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(*supers));
2237ea844a1aSMatthew Knepley   if (maxCdof) {
2238ea844a1aSMatthew Knepley     PetscInt *indices;
2239ea844a1aSMatthew Knepley 
22409566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(maxCdof, &indices));
2241ea844a1aSMatthew Knepley     for (p = pStart; p < pEnd; ++p) {
2242ea844a1aSMatthew Knepley       PetscInt cdof;
2243ea844a1aSMatthew Knepley 
22449566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetConstraintDof(*supers, p, &cdof));
2245ea844a1aSMatthew Knepley       if (cdof) {
2246ea844a1aSMatthew Knepley         PetscInt dof, numConst = 0, fOff = 0;
2247ea844a1aSMatthew Knepley 
2248ea844a1aSMatthew Knepley         for (i = 0, f = 0; i < len; ++i) {
2249ea844a1aSMatthew Knepley           const PetscInt *oldIndices = NULL;
2250ea844a1aSMatthew Knepley           PetscInt        nf, fi, pStarti, pEndi, fdof, cfdof, fc;
2251ea844a1aSMatthew Knepley 
22529566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetNumFields(s[i], &nf));
22539566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetChart(s[i], &pStarti, &pEndi));
2254ea844a1aSMatthew Knepley           if ((p < pStarti) || (p >= pEndi)) continue;
2255ea844a1aSMatthew Knepley           for (fi = 0; fi < nf; ++fi, ++f) {
22569566063dSJacob Faibussowitsch             PetscCall(PetscSectionGetFieldDof(s[i], p, fi, &fdof));
22579566063dSJacob Faibussowitsch             PetscCall(PetscSectionGetFieldConstraintDof(s[i], p, fi, &cfdof));
22589566063dSJacob Faibussowitsch             PetscCall(PetscSectionGetFieldConstraintIndices(s[i], p, fi, &oldIndices));
2259fcd2503dSMatthew G. Knepley             for (fc = 0; fc < cfdof; ++fc) indices[numConst + fc] = oldIndices[fc];
22609566063dSJacob Faibussowitsch             PetscCall(PetscSectionSetFieldConstraintIndices(*supers, p, f, &indices[numConst]));
2261fcd2503dSMatthew G. Knepley             for (fc = 0; fc < cfdof; ++fc) indices[numConst + fc] += fOff;
2262ea844a1aSMatthew Knepley             numConst += cfdof;
2263ea844a1aSMatthew Knepley           }
22649566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetDof(s[i], p, &dof));
2265ea844a1aSMatthew Knepley           fOff += dof;
2266ea844a1aSMatthew Knepley         }
22679566063dSJacob Faibussowitsch         PetscCall(PetscSectionSetConstraintIndices(*supers, p, indices));
2268ea844a1aSMatthew Knepley       }
2269ea844a1aSMatthew Knepley     }
22709566063dSJacob Faibussowitsch     PetscCall(PetscFree(indices));
2271ea844a1aSMatthew Knepley   }
22723ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2273ea844a1aSMatthew Knepley }
2274ea844a1aSMatthew Knepley 
2275da8c939bSJacob Faibussowitsch static PetscErrorCode PetscSectionCreateSubplexSection_Private(PetscSection s, IS subpointMap, PetscBool renumberPoints, PetscSection *subs)
2276d71ae5a4SJacob Faibussowitsch {
2277ea844a1aSMatthew Knepley   const PetscInt *points = NULL, *indices = NULL;
227841f23ed0SMatthew G. Knepley   PetscInt        numFields, f, c, numSubpoints = 0, pStart, pEnd, p, spStart, spEnd, subp;
2279ea844a1aSMatthew Knepley 
2280ea844a1aSMatthew Knepley   PetscFunctionBegin;
2281ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2282ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(subpointMap, IS_CLASSID, 2);
22834f572ea9SToby Isaac   PetscAssertPointer(subs, 4);
22849566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetNumFields(s, &numFields));
22859566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject)s), subs));
22869566063dSJacob Faibussowitsch   if (numFields) PetscCall(PetscSectionSetNumFields(*subs, numFields));
2287ea844a1aSMatthew Knepley   for (f = 0; f < numFields; ++f) {
2288ea844a1aSMatthew Knepley     const char *name    = NULL;
2289ea844a1aSMatthew Knepley     PetscInt    numComp = 0;
2290ea844a1aSMatthew Knepley 
22919566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldName(s, f, &name));
22929566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldName(*subs, f, name));
22939566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldComponents(s, f, &numComp));
22949566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldComponents(*subs, f, numComp));
2295b778fa18SValeria Barra     for (c = 0; c < s->numFieldComponents[f]; ++c) {
22969566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetComponentName(s, f, c, &name));
22979566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetComponentName(*subs, f, c, name));
2298b778fa18SValeria Barra     }
2299ea844a1aSMatthew Knepley   }
2300ea844a1aSMatthew Knepley   /* For right now, we do not try to squeeze the subchart */
2301ea844a1aSMatthew Knepley   if (subpointMap) {
23029566063dSJacob Faibussowitsch     PetscCall(ISGetSize(subpointMap, &numSubpoints));
23039566063dSJacob Faibussowitsch     PetscCall(ISGetIndices(subpointMap, &points));
2304ea844a1aSMatthew Knepley   }
23059566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
230641f23ed0SMatthew G. Knepley   if (renumberPoints) {
230741f23ed0SMatthew G. Knepley     spStart = 0;
230841f23ed0SMatthew G. Knepley     spEnd   = numSubpoints;
230941f23ed0SMatthew G. Knepley   } else {
231041f23ed0SMatthew G. Knepley     PetscCall(ISGetMinMax(subpointMap, &spStart, &spEnd));
231141f23ed0SMatthew G. Knepley     ++spEnd;
231241f23ed0SMatthew G. Knepley   }
231341f23ed0SMatthew G. Knepley   PetscCall(PetscSectionSetChart(*subs, spStart, spEnd));
2314ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
2315ea844a1aSMatthew Knepley     PetscInt dof, cdof, fdof = 0, cfdof = 0;
2316ea844a1aSMatthew Knepley 
23179566063dSJacob Faibussowitsch     PetscCall(PetscFindInt(p, numSubpoints, points, &subp));
2318ea844a1aSMatthew Knepley     if (subp < 0) continue;
231941f23ed0SMatthew G. Knepley     if (!renumberPoints) subp = p;
2320ea844a1aSMatthew Knepley     for (f = 0; f < numFields; ++f) {
23219566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldDof(s, p, f, &fdof));
23229566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldDof(*subs, subp, f, fdof));
23239566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintDof(s, p, f, &cfdof));
23249566063dSJacob Faibussowitsch       if (cfdof) PetscCall(PetscSectionSetFieldConstraintDof(*subs, subp, f, cfdof));
2325ea844a1aSMatthew Knepley     }
23269566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s, p, &dof));
23279566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(*subs, subp, dof));
23289566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s, p, &cdof));
23299566063dSJacob Faibussowitsch     if (cdof) PetscCall(PetscSectionSetConstraintDof(*subs, subp, cdof));
2330ea844a1aSMatthew Knepley   }
23319566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(*subs));
2332ea844a1aSMatthew Knepley   /* Change offsets to original offsets */
2333ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
2334ea844a1aSMatthew Knepley     PetscInt off, foff = 0;
2335ea844a1aSMatthew Knepley 
23369566063dSJacob Faibussowitsch     PetscCall(PetscFindInt(p, numSubpoints, points, &subp));
2337ea844a1aSMatthew Knepley     if (subp < 0) continue;
233841f23ed0SMatthew G. Knepley     if (!renumberPoints) subp = p;
2339ea844a1aSMatthew Knepley     for (f = 0; f < numFields; ++f) {
23409566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldOffset(s, p, f, &foff));
23419566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldOffset(*subs, subp, f, foff));
2342ea844a1aSMatthew Knepley     }
23439566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(s, p, &off));
23449566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetOffset(*subs, subp, off));
2345ea844a1aSMatthew Knepley   }
2346ea844a1aSMatthew Knepley   /* Copy constraint indices */
234741f23ed0SMatthew G. Knepley   for (subp = spStart; subp < spEnd; ++subp) {
2348ea844a1aSMatthew Knepley     PetscInt cdof;
2349ea844a1aSMatthew Knepley 
23509566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(*subs, subp, &cdof));
2351ea844a1aSMatthew Knepley     if (cdof) {
2352ea844a1aSMatthew Knepley       for (f = 0; f < numFields; ++f) {
235341f23ed0SMatthew G. Knepley         PetscCall(PetscSectionGetFieldConstraintIndices(s, points[subp - spStart], f, &indices));
23549566063dSJacob Faibussowitsch         PetscCall(PetscSectionSetFieldConstraintIndices(*subs, subp, f, indices));
2355ea844a1aSMatthew Knepley       }
235641f23ed0SMatthew G. Knepley       PetscCall(PetscSectionGetConstraintIndices(s, points[subp - spStart], &indices));
23579566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetConstraintIndices(*subs, subp, indices));
2358ea844a1aSMatthew Knepley     }
2359ea844a1aSMatthew Knepley   }
23609566063dSJacob Faibussowitsch   if (subpointMap) PetscCall(ISRestoreIndices(subpointMap, &points));
23613ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2362ea844a1aSMatthew Knepley }
2363ea844a1aSMatthew Knepley 
236441f23ed0SMatthew G. Knepley /*@
236541f23ed0SMatthew G. Knepley   PetscSectionCreateSubmeshSection - Create a new, smaller section with support on the submesh
236641f23ed0SMatthew G. Knepley 
2367c3339decSBarry Smith   Collective
236841f23ed0SMatthew G. Knepley 
236941f23ed0SMatthew G. Knepley   Input Parameters:
2370cab54364SBarry Smith + s           - the `PetscSection`
237141f23ed0SMatthew G. Knepley - subpointMap - a sorted list of points in the original mesh which are in the submesh
237241f23ed0SMatthew G. Knepley 
237341f23ed0SMatthew G. Knepley   Output Parameter:
237441f23ed0SMatthew G. Knepley . subs - the subsection
237541f23ed0SMatthew G. Knepley 
2376cab54364SBarry Smith   Level: advanced
2377cab54364SBarry Smith 
2378583308b6SBarry Smith   Notes:
2379583308b6SBarry Smith   The points are renumbered from 0, and the section offsets now refer to a new, smaller vector. That is the chart of `subs` is `[0,sizeof(subpointmap))`
2380583308b6SBarry Smith 
238120662ed9SBarry Smith   Compare this with `PetscSectionCreateSubdomainSection()` that does not map the points numbers to start at zero but leaves them as before
238241f23ed0SMatthew G. Knepley 
238338b5cf2dSJacob Faibussowitsch   Developer Notes:
238420662ed9SBarry Smith   The use of the term Submesh is confusing and needs clarification, it is not specific to meshes. It appears to be just a subset of the chart of the original `PetscSection`
238541f23ed0SMatthew G. Knepley 
2386cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreateSubdomainSection()`, `PetscSectionCreateSubsection()`, `DMPlexGetSubpointMap()`, `PetscSectionCreate()`
238741f23ed0SMatthew G. Knepley @*/
2388d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionCreateSubmeshSection(PetscSection s, IS subpointMap, PetscSection *subs)
2389d71ae5a4SJacob Faibussowitsch {
239041f23ed0SMatthew G. Knepley   PetscFunctionBegin;
2391da8c939bSJacob Faibussowitsch   PetscCall(PetscSectionCreateSubplexSection_Private(s, subpointMap, PETSC_TRUE, subs));
23923ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
239341f23ed0SMatthew G. Knepley }
239441f23ed0SMatthew G. Knepley 
239541f23ed0SMatthew G. Knepley /*@
239641f23ed0SMatthew G. Knepley   PetscSectionCreateSubdomainSection - Create a new, smaller section with support on a subdomain of the mesh
239741f23ed0SMatthew G. Knepley 
2398c3339decSBarry Smith   Collective
239941f23ed0SMatthew G. Knepley 
240041f23ed0SMatthew G. Knepley   Input Parameters:
2401cab54364SBarry Smith + s           - the `PetscSection`
240241f23ed0SMatthew G. Knepley - subpointMap - a sorted list of points in the original mesh which are in the subdomain
240341f23ed0SMatthew G. Knepley 
240441f23ed0SMatthew G. Knepley   Output Parameter:
240541f23ed0SMatthew G. Knepley . subs - the subsection
240641f23ed0SMatthew G. Knepley 
2407cab54364SBarry Smith   Level: advanced
2408cab54364SBarry Smith 
2409583308b6SBarry Smith   Notes:
2410583308b6SBarry Smith   The point numbers remain the same as in the larger `PetscSection`, but the section offsets now refer to a new, smaller vector. The chart of `subs`
2411583308b6SBarry Smith   is `[min(subpointMap),max(subpointMap)+1)`
2412583308b6SBarry Smith 
241320662ed9SBarry Smith   Compare this with `PetscSectionCreateSubmeshSection()` that maps the point numbers to start at zero
241441f23ed0SMatthew G. Knepley 
2415cab54364SBarry Smith   Developer Notes:
241620662ed9SBarry Smith   The use of the term Subdomain is unneeded and needs clarification, it is not specific to meshes. It appears to be just a subset of the chart of the original `PetscSection`
2417cab54364SBarry Smith 
2418cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreateSubmeshSection()`, `PetscSectionCreateSubsection()`, `DMPlexGetSubpointMap()`, `PetscSectionCreate()`
241941f23ed0SMatthew G. Knepley @*/
2420d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionCreateSubdomainSection(PetscSection s, IS subpointMap, PetscSection *subs)
2421d71ae5a4SJacob Faibussowitsch {
242241f23ed0SMatthew G. Knepley   PetscFunctionBegin;
2423da8c939bSJacob Faibussowitsch   PetscCall(PetscSectionCreateSubplexSection_Private(s, subpointMap, PETSC_FALSE, subs));
24243ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
242541f23ed0SMatthew G. Knepley }
242641f23ed0SMatthew G. Knepley 
2427d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscSectionView_ASCII(PetscSection s, PetscViewer viewer)
2428d71ae5a4SJacob Faibussowitsch {
2429ea844a1aSMatthew Knepley   PetscInt    p;
2430ea844a1aSMatthew Knepley   PetscMPIInt rank;
2431ea844a1aSMatthew Knepley 
2432ea844a1aSMatthew Knepley   PetscFunctionBegin;
24339566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(PetscObjectComm((PetscObject)viewer), &rank));
24349566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPushSynchronized(viewer));
24359566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "Process %d:\n", rank));
2436ea844a1aSMatthew Knepley   for (p = 0; p < s->pEnd - s->pStart; ++p) {
24373857f682SStefano Zampini     if (s->bc && s->bc->atlasDof[p] > 0) {
2438ea844a1aSMatthew Knepley       PetscInt b;
24399566063dSJacob 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]));
2440083401c6SMatthew G. Knepley       if (s->bcIndices) {
244148a46eb9SPierre Jolivet         for (b = 0; b < s->bc->atlasDof[p]; ++b) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, " %" PetscInt_FMT, s->bcIndices[s->bc->atlasOff[p] + b]));
2442083401c6SMatthew G. Knepley       }
24439566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "\n"));
2444ea844a1aSMatthew Knepley     } else {
24459566063dSJacob 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]));
2446ea844a1aSMatthew Knepley     }
2447ea844a1aSMatthew Knepley   }
24489566063dSJacob Faibussowitsch   PetscCall(PetscViewerFlush(viewer));
24499566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPopSynchronized(viewer));
2450ea844a1aSMatthew Knepley   if (s->sym) {
24519566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPushTab(viewer));
24529566063dSJacob Faibussowitsch     PetscCall(PetscSectionSymView(s->sym, viewer));
24539566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopTab(viewer));
2454ea844a1aSMatthew Knepley   }
24553ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2456ea844a1aSMatthew Knepley }
2457ea844a1aSMatthew Knepley 
2458ffeef943SBarry Smith /*@
2459cab54364SBarry Smith   PetscSectionViewFromOptions - View the `PetscSection` based on values in the options database
2460fe2efc57SMark 
246140750d41SVaclav Hapla   Collective
2462fe2efc57SMark 
2463fe2efc57SMark   Input Parameters:
246420662ed9SBarry Smith + A    - the `PetscSection` object to view
2465cab54364SBarry Smith . obj  - Optional object that provides the options prefix used for the options
2466736c3998SJose E. Roman - name - command line option
2467fe2efc57SMark 
2468fe2efc57SMark   Level: intermediate
2469cab54364SBarry Smith 
247020662ed9SBarry Smith   Note:
247120662ed9SBarry Smith   See `PetscObjectViewFromOptions()` for available values of `PetscViewer` and `PetscViewerFormat`
247220662ed9SBarry Smith 
2473cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionView`, `PetscObjectViewFromOptions()`, `PetscSectionCreate()`, `PetscSectionView()`
2474fe2efc57SMark @*/
2475d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionViewFromOptions(PetscSection A, PetscObject obj, const char name[])
2476d71ae5a4SJacob Faibussowitsch {
2477fe2efc57SMark   PetscFunctionBegin;
2478fe2efc57SMark   PetscValidHeaderSpecific(A, PETSC_SECTION_CLASSID, 1);
24799566063dSJacob Faibussowitsch   PetscCall(PetscObjectViewFromOptions((PetscObject)A, obj, name));
24803ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2481fe2efc57SMark }
2482fe2efc57SMark 
2483ffeef943SBarry Smith /*@
2484cab54364SBarry Smith   PetscSectionView - Views a `PetscSection`
2485ea844a1aSMatthew Knepley 
248640750d41SVaclav Hapla   Collective
2487ea844a1aSMatthew Knepley 
2488ea844a1aSMatthew Knepley   Input Parameters:
2489cab54364SBarry Smith + s      - the `PetscSection` object to view
249038b5cf2dSJacob Faibussowitsch - viewer - the viewer
2491ea844a1aSMatthew Knepley 
2492cab54364SBarry Smith   Level: beginner
2493cab54364SBarry Smith 
24941ddd528eSksagiyam   Note:
2495cab54364SBarry Smith   `PetscSectionView()`, when viewer is of type `PETSCVIEWERHDF5`, only saves
24961ddd528eSksagiyam   distribution independent data, such as dofs, offsets, constraint dofs,
24971ddd528eSksagiyam   and constraint indices. Points that have negative dofs, for instance,
24981ddd528eSksagiyam   are not saved as they represent points owned by other processes.
24991ddd528eSksagiyam   Point numbering and rank assignment is currently not stored.
2500cab54364SBarry Smith   The saved section can be loaded with `PetscSectionLoad()`.
25011ddd528eSksagiyam 
2502cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreate()`, `PetscSectionDestroy()`, `PetscSectionLoad()`, `PetscViewer`
2503ea844a1aSMatthew Knepley @*/
2504d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionView(PetscSection s, PetscViewer viewer)
2505d71ae5a4SJacob Faibussowitsch {
25061ddd528eSksagiyam   PetscBool isascii, ishdf5;
2507ea844a1aSMatthew Knepley   PetscInt  f;
2508ea844a1aSMatthew Knepley 
2509ea844a1aSMatthew Knepley   PetscFunctionBegin;
2510ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
25119566063dSJacob Faibussowitsch   if (!viewer) PetscCall(PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)s), &viewer));
2512ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(viewer, PETSC_VIEWER_CLASSID, 2);
25139566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &isascii));
25149566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERHDF5, &ishdf5));
2515ea844a1aSMatthew Knepley   if (isascii) {
25169566063dSJacob Faibussowitsch     PetscCall(PetscObjectPrintClassNamePrefixType((PetscObject)s, viewer));
2517ea844a1aSMatthew Knepley     if (s->numFields) {
25189566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "%" PetscInt_FMT " fields\n", s->numFields));
2519ea844a1aSMatthew Knepley       for (f = 0; f < s->numFields; ++f) {
25204cd8913cSStefano Zampini         PetscCall(PetscViewerASCIIPrintf(viewer, "  field %" PetscInt_FMT " \"%s\" with %" PetscInt_FMT " components\n", f, s->fieldNames[f], s->numFieldComponents[f]));
25219566063dSJacob Faibussowitsch         PetscCall(PetscSectionView_ASCII(s->field[f], viewer));
2522ea844a1aSMatthew Knepley       }
2523ea844a1aSMatthew Knepley     } else {
25249566063dSJacob Faibussowitsch       PetscCall(PetscSectionView_ASCII(s, viewer));
2525ea844a1aSMatthew Knepley     }
25261ddd528eSksagiyam   } else if (ishdf5) {
25271ddd528eSksagiyam #if PetscDefined(HAVE_HDF5)
25289566063dSJacob Faibussowitsch     PetscCall(PetscSectionView_HDF5_Internal(s, viewer));
25291ddd528eSksagiyam #else
25301ddd528eSksagiyam     SETERRQ(PetscObjectComm((PetscObject)s), PETSC_ERR_SUP, "HDF5 not supported in this build.\nPlease reconfigure using --download-hdf5");
25311ddd528eSksagiyam #endif
2532ea844a1aSMatthew Knepley   }
25333ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2534ea844a1aSMatthew Knepley }
2535ea844a1aSMatthew Knepley 
2536ffeef943SBarry Smith /*@
2537cab54364SBarry Smith   PetscSectionLoad - Loads a `PetscSection`
2538fde5e3acSksagiyam 
253940750d41SVaclav Hapla   Collective
2540fde5e3acSksagiyam 
2541fde5e3acSksagiyam   Input Parameters:
2542cab54364SBarry Smith + s      - the `PetscSection` object to load
254338b5cf2dSJacob Faibussowitsch - viewer - the viewer
2544fde5e3acSksagiyam 
2545cab54364SBarry Smith   Level: beginner
2546cab54364SBarry Smith 
2547fde5e3acSksagiyam   Note:
2548cab54364SBarry Smith   `PetscSectionLoad()`, when viewer is of type `PETSCVIEWERHDF5`, loads
2549cab54364SBarry Smith   a section saved with `PetscSectionView()`. The number of processes
2550fde5e3acSksagiyam   used here (N) does not need to be the same as that used when saving.
2551fde5e3acSksagiyam   After calling this function, the chart of s on rank i will be set
2552fde5e3acSksagiyam   to [0, E_i), where \sum_{i=0}^{N-1}E_i equals to the total number of
2553fde5e3acSksagiyam   saved section points.
2554fde5e3acSksagiyam 
2555cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreate()`, `PetscSectionDestroy()`, `PetscSectionView()`
2556fde5e3acSksagiyam @*/
2557d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionLoad(PetscSection s, PetscViewer viewer)
2558d71ae5a4SJacob Faibussowitsch {
2559fde5e3acSksagiyam   PetscBool ishdf5;
2560fde5e3acSksagiyam 
2561fde5e3acSksagiyam   PetscFunctionBegin;
2562fde5e3acSksagiyam   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2563fde5e3acSksagiyam   PetscValidHeaderSpecific(viewer, PETSC_VIEWER_CLASSID, 2);
25649566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERHDF5, &ishdf5));
2565fde5e3acSksagiyam   if (ishdf5) {
2566fde5e3acSksagiyam #if PetscDefined(HAVE_HDF5)
25679566063dSJacob Faibussowitsch     PetscCall(PetscSectionLoad_HDF5_Internal(s, viewer));
25683ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
2569fde5e3acSksagiyam #else
2570fde5e3acSksagiyam     SETERRQ(PetscObjectComm((PetscObject)s), PETSC_ERR_SUP, "HDF5 not supported in this build.\nPlease reconfigure using --download-hdf5");
2571fde5e3acSksagiyam #endif
257298921bdaSJacob Faibussowitsch   } else SETERRQ(PetscObjectComm((PetscObject)s), PETSC_ERR_SUP, "Viewer type %s not yet supported for PetscSection loading", ((PetscObject)viewer)->type_name);
2573fde5e3acSksagiyam }
2574fde5e3acSksagiyam 
2575d4a1ad33SMatthew G. Knepley /*@
2576d4a1ad33SMatthew G. Knepley   PetscSectionResetClosurePermutation - Remove any existing closure permutation
2577d4a1ad33SMatthew G. Knepley 
2578d4a1ad33SMatthew G. Knepley   Input Parameter:
2579e8e188d2SZach Atkins . section - The `PetscSection`
2580d4a1ad33SMatthew G. Knepley 
2581d4a1ad33SMatthew G. Knepley   Level: intermediate
2582d4a1ad33SMatthew G. Knepley 
2583e8e188d2SZach Atkins .seealso: `PetscSectionSetClosurePermutation()`, `PetscSectionSetClosureIndex()`, `PetscSectionReset()`
2584d4a1ad33SMatthew G. Knepley @*/
2585d4a1ad33SMatthew G. Knepley PetscErrorCode PetscSectionResetClosurePermutation(PetscSection section)
2586d71ae5a4SJacob Faibussowitsch {
2587c459fbc1SJed Brown   PetscSectionClosurePermVal clVal;
2588c459fbc1SJed Brown 
2589c459fbc1SJed Brown   PetscFunctionBegin;
25903ba16761SJacob Faibussowitsch   if (!section->clHash) PetscFunctionReturn(PETSC_SUCCESS);
2591c459fbc1SJed Brown   kh_foreach_value(section->clHash, clVal, {
25929566063dSJacob Faibussowitsch     PetscCall(PetscFree(clVal.perm));
25939566063dSJacob Faibussowitsch     PetscCall(PetscFree(clVal.invPerm));
2594c459fbc1SJed Brown   });
2595c459fbc1SJed Brown   kh_destroy(ClPerm, section->clHash);
2596c459fbc1SJed Brown   section->clHash = NULL;
25973ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2598c459fbc1SJed Brown }
2599c459fbc1SJed Brown 
2600ea844a1aSMatthew Knepley /*@
2601583308b6SBarry Smith   PetscSectionReset - Frees all section data, the section is then as if `PetscSectionCreate()` had just been called.
2602ea844a1aSMatthew Knepley 
260340750d41SVaclav Hapla   Not Collective
2604ea844a1aSMatthew Knepley 
26052fe279fdSBarry Smith   Input Parameter:
2606cab54364SBarry Smith . s - the `PetscSection`
2607ea844a1aSMatthew Knepley 
2608ea844a1aSMatthew Knepley   Level: beginner
2609ea844a1aSMatthew Knepley 
2610cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreate()`
2611ea844a1aSMatthew Knepley @*/
2612d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionReset(PetscSection s)
2613d71ae5a4SJacob Faibussowitsch {
2614b778fa18SValeria Barra   PetscInt f, c;
2615ea844a1aSMatthew Knepley 
2616ea844a1aSMatthew Knepley   PetscFunctionBegin;
2617ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2618ea844a1aSMatthew Knepley   for (f = 0; f < s->numFields; ++f) {
26199566063dSJacob Faibussowitsch     PetscCall(PetscSectionDestroy(&s->field[f]));
26209566063dSJacob Faibussowitsch     PetscCall(PetscFree(s->fieldNames[f]));
262148a46eb9SPierre Jolivet     for (c = 0; c < s->numFieldComponents[f]; ++c) PetscCall(PetscFree(s->compNames[f][c]));
26229566063dSJacob Faibussowitsch     PetscCall(PetscFree(s->compNames[f]));
2623ea844a1aSMatthew Knepley   }
26249566063dSJacob Faibussowitsch   PetscCall(PetscFree(s->numFieldComponents));
26259566063dSJacob Faibussowitsch   PetscCall(PetscFree(s->fieldNames));
26269566063dSJacob Faibussowitsch   PetscCall(PetscFree(s->compNames));
26279566063dSJacob Faibussowitsch   PetscCall(PetscFree(s->field));
26289566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&s->bc));
26299566063dSJacob Faibussowitsch   PetscCall(PetscFree(s->bcIndices));
26309566063dSJacob Faibussowitsch   PetscCall(PetscFree2(s->atlasDof, s->atlasOff));
26319566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&s->clSection));
26329566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&s->clPoints));
26339566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&s->perm));
26343ec46b7bSMatthew G. Knepley   PetscCall(PetscBTDestroy(&s->blockStarts));
2635d4a1ad33SMatthew G. Knepley   PetscCall(PetscSectionResetClosurePermutation(s));
26369566063dSJacob Faibussowitsch   PetscCall(PetscSectionSymDestroy(&s->sym));
26379566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&s->clSection));
26389566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&s->clPoints));
263969c11d05SVaclav Hapla   PetscCall(PetscSectionInvalidateMaxDof_Internal(s));
2640ea844a1aSMatthew Knepley   s->pStart    = -1;
2641ea844a1aSMatthew Knepley   s->pEnd      = -1;
2642ea844a1aSMatthew Knepley   s->maxDof    = 0;
2643ea844a1aSMatthew Knepley   s->setup     = PETSC_FALSE;
2644ea844a1aSMatthew Knepley   s->numFields = 0;
2645ea844a1aSMatthew Knepley   s->clObj     = NULL;
26463ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2647ea844a1aSMatthew Knepley }
2648ea844a1aSMatthew Knepley 
2649ea844a1aSMatthew Knepley /*@
2650583308b6SBarry Smith   PetscSectionDestroy - Frees a `PetscSection`
2651ea844a1aSMatthew Knepley 
265240750d41SVaclav Hapla   Not Collective
2653ea844a1aSMatthew Knepley 
26542fe279fdSBarry Smith   Input Parameter:
2655cab54364SBarry Smith . s - the `PetscSection`
2656ea844a1aSMatthew Knepley 
2657ea844a1aSMatthew Knepley   Level: beginner
2658ea844a1aSMatthew Knepley 
2659cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreate()`, `PetscSectionReset()`
2660ea844a1aSMatthew Knepley @*/
2661d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionDestroy(PetscSection *s)
2662d71ae5a4SJacob Faibussowitsch {
2663ea844a1aSMatthew Knepley   PetscFunctionBegin;
26643ba16761SJacob Faibussowitsch   if (!*s) PetscFunctionReturn(PETSC_SUCCESS);
266562f17a49SStefano Zampini   PetscValidHeaderSpecific(*s, PETSC_SECTION_CLASSID, 1);
2666f4f49eeaSPierre Jolivet   if (--((PetscObject)*s)->refct > 0) {
2667ea844a1aSMatthew Knepley     *s = NULL;
26683ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
2669ea844a1aSMatthew Knepley   }
26709566063dSJacob Faibussowitsch   PetscCall(PetscSectionReset(*s));
26719566063dSJacob Faibussowitsch   PetscCall(PetscHeaderDestroy(s));
26723ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2673ea844a1aSMatthew Knepley }
2674ea844a1aSMatthew Knepley 
2675da8c939bSJacob Faibussowitsch static PetscErrorCode VecIntGetValuesSection_Private(const PetscInt *baseArray, PetscSection s, PetscInt point, const PetscInt **values)
2676d71ae5a4SJacob Faibussowitsch {
2677ea844a1aSMatthew Knepley   const PetscInt p = point - s->pStart;
2678ea844a1aSMatthew Knepley 
2679ea844a1aSMatthew Knepley   PetscFunctionBegin;
2680ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 2);
2681ea844a1aSMatthew Knepley   *values = &baseArray[s->atlasOff[p]];
26823ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2683ea844a1aSMatthew Knepley }
2684ea844a1aSMatthew Knepley 
2685da8c939bSJacob Faibussowitsch static PetscErrorCode VecIntSetValuesSection_Private(PetscInt *baseArray, PetscSection s, PetscInt point, const PetscInt values[], InsertMode mode)
2686d71ae5a4SJacob Faibussowitsch {
2687ea844a1aSMatthew Knepley   PetscInt      *array;
2688ea844a1aSMatthew Knepley   const PetscInt p           = point - s->pStart;
2689ea844a1aSMatthew Knepley   const PetscInt orientation = 0; /* Needs to be included for use in closure operations */
2690ea844a1aSMatthew Knepley   PetscInt       cDim        = 0;
2691ea844a1aSMatthew Knepley 
2692ea844a1aSMatthew Knepley   PetscFunctionBegin;
2693ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 2);
26949566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstraintDof(s, p, &cDim));
2695ea844a1aSMatthew Knepley   array = &baseArray[s->atlasOff[p]];
2696ea844a1aSMatthew Knepley   if (!cDim) {
2697ea844a1aSMatthew Knepley     if (orientation >= 0) {
2698ea844a1aSMatthew Knepley       const PetscInt dim = s->atlasDof[p];
2699ea844a1aSMatthew Knepley       PetscInt       i;
2700ea844a1aSMatthew Knepley 
2701ea844a1aSMatthew Knepley       if (mode == INSERT_VALUES) {
2702ad716f99SStefano Zampini         for (i = 0; i < dim; ++i) array[i] = values ? values[i] : i;
2703ea844a1aSMatthew Knepley       } else {
2704ea844a1aSMatthew Knepley         for (i = 0; i < dim; ++i) array[i] += values[i];
2705ea844a1aSMatthew Knepley       }
2706ea844a1aSMatthew Knepley     } else {
2707ea844a1aSMatthew Knepley       PetscInt offset = 0;
2708ea844a1aSMatthew Knepley       PetscInt j      = -1, field, i;
2709ea844a1aSMatthew Knepley 
2710ea844a1aSMatthew Knepley       for (field = 0; field < s->numFields; ++field) {
2711ea844a1aSMatthew Knepley         const PetscInt dim = s->field[field]->atlasDof[p];
2712ea844a1aSMatthew Knepley 
2713ad716f99SStefano Zampini         for (i = dim - 1; i >= 0; --i) array[++j] = values ? values[i + offset] : i + offset;
2714ea844a1aSMatthew Knepley         offset += dim;
2715ea844a1aSMatthew Knepley       }
2716ea844a1aSMatthew Knepley     }
2717ea844a1aSMatthew Knepley   } else {
2718ea844a1aSMatthew Knepley     if (orientation >= 0) {
2719ea844a1aSMatthew Knepley       const PetscInt  dim  = s->atlasDof[p];
2720ea844a1aSMatthew Knepley       PetscInt        cInd = 0, i;
2721ea844a1aSMatthew Knepley       const PetscInt *cDof;
2722ea844a1aSMatthew Knepley 
27239566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetConstraintIndices(s, point, &cDof));
2724ea844a1aSMatthew Knepley       if (mode == INSERT_VALUES) {
2725ea844a1aSMatthew Knepley         for (i = 0; i < dim; ++i) {
27269371c9d4SSatish Balay           if ((cInd < cDim) && (i == cDof[cInd])) {
27279371c9d4SSatish Balay             ++cInd;
27289371c9d4SSatish Balay             continue;
27299371c9d4SSatish Balay           }
2730ad716f99SStefano Zampini           array[i] = values ? values[i] : i;
2731ea844a1aSMatthew Knepley         }
2732ea844a1aSMatthew Knepley       } else {
2733ea844a1aSMatthew Knepley         for (i = 0; i < dim; ++i) {
27349371c9d4SSatish Balay           if ((cInd < cDim) && (i == cDof[cInd])) {
27359371c9d4SSatish Balay             ++cInd;
27369371c9d4SSatish Balay             continue;
27379371c9d4SSatish Balay           }
2738ea844a1aSMatthew Knepley           array[i] += values[i];
2739ea844a1aSMatthew Knepley         }
2740ea844a1aSMatthew Knepley       }
2741ea844a1aSMatthew Knepley     } else {
2742ea844a1aSMatthew Knepley       const PetscInt *cDof;
2743ea844a1aSMatthew Knepley       PetscInt        offset  = 0;
2744ea844a1aSMatthew Knepley       PetscInt        cOffset = 0;
2745ea844a1aSMatthew Knepley       PetscInt        j       = 0, field;
2746ea844a1aSMatthew Knepley 
27479566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetConstraintIndices(s, point, &cDof));
2748ea844a1aSMatthew Knepley       for (field = 0; field < s->numFields; ++field) {
2749ea844a1aSMatthew Knepley         const PetscInt dim  = s->field[field]->atlasDof[p];     /* PetscSectionGetFieldDof() */
2750ea844a1aSMatthew Knepley         const PetscInt tDim = s->field[field]->bc->atlasDof[p]; /* PetscSectionGetFieldConstraintDof() */
2751ea844a1aSMatthew Knepley         const PetscInt sDim = dim - tDim;
2752ea844a1aSMatthew Knepley         PetscInt       cInd = 0, i, k;
2753ea844a1aSMatthew Knepley 
2754ea844a1aSMatthew Knepley         for (i = 0, k = dim + offset - 1; i < dim; ++i, ++j, --k) {
27559371c9d4SSatish Balay           if ((cInd < sDim) && (j == cDof[cInd + cOffset])) {
27569371c9d4SSatish Balay             ++cInd;
27579371c9d4SSatish Balay             continue;
27589371c9d4SSatish Balay           }
2759ad716f99SStefano Zampini           array[j] = values ? values[k] : k;
2760ea844a1aSMatthew Knepley         }
2761ea844a1aSMatthew Knepley         offset += dim;
2762ea844a1aSMatthew Knepley         cOffset += dim - tDim;
2763ea844a1aSMatthew Knepley       }
2764ea844a1aSMatthew Knepley     }
2765ea844a1aSMatthew Knepley   }
27663ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2767ea844a1aSMatthew Knepley }
2768ea844a1aSMatthew Knepley 
2769cc4c1da9SBarry Smith /*@
277020662ed9SBarry Smith   PetscSectionHasConstraints - Determine whether a `PetscSection` has constrained dofs
2771ea844a1aSMatthew Knepley 
277240750d41SVaclav Hapla   Not Collective
2773ea844a1aSMatthew Knepley 
2774ea844a1aSMatthew Knepley   Input Parameter:
2775cab54364SBarry Smith . s - The `PetscSection`
2776ea844a1aSMatthew Knepley 
2777ea844a1aSMatthew Knepley   Output Parameter:
2778ea844a1aSMatthew Knepley . hasConstraints - flag indicating that the section has constrained dofs
2779ea844a1aSMatthew Knepley 
2780ea844a1aSMatthew Knepley   Level: intermediate
2781ea844a1aSMatthew Knepley 
2782cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSetConstraintIndices()`, `PetscSectionGetConstraintDof()`, `PetscSection`
2783ea844a1aSMatthew Knepley @*/
2784d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionHasConstraints(PetscSection s, PetscBool *hasConstraints)
2785d71ae5a4SJacob Faibussowitsch {
2786ea844a1aSMatthew Knepley   PetscFunctionBegin;
2787ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
27884f572ea9SToby Isaac   PetscAssertPointer(hasConstraints, 2);
2789ea844a1aSMatthew Knepley   *hasConstraints = s->bc ? PETSC_TRUE : PETSC_FALSE;
27903ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2791ea844a1aSMatthew Knepley }
2792ea844a1aSMatthew Knepley 
2793ea844a1aSMatthew Knepley /*@C
279420662ed9SBarry Smith   PetscSectionGetConstraintIndices - Get the point dof numbers, in [0, dof), which are constrained for a given point
2795ea844a1aSMatthew Knepley 
279640750d41SVaclav Hapla   Not Collective
2797ea844a1aSMatthew Knepley 
2798ea844a1aSMatthew Knepley   Input Parameters:
2799cab54364SBarry Smith + s     - The `PetscSection`
2800ea844a1aSMatthew Knepley - point - The point
2801ea844a1aSMatthew Knepley 
2802ea844a1aSMatthew Knepley   Output Parameter:
2803ea844a1aSMatthew Knepley . indices - The constrained dofs
2804ea844a1aSMatthew Knepley 
2805ea844a1aSMatthew Knepley   Level: intermediate
2806ea844a1aSMatthew Knepley 
280738b5cf2dSJacob Faibussowitsch   Fortran Notes:
280820662ed9SBarry Smith   Use `PetscSectionGetConstraintIndicesF90()` and `PetscSectionRestoreConstraintIndicesF90()`
2809cab54364SBarry Smith 
2810cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSetConstraintIndices()`, `PetscSectionGetConstraintDof()`, `PetscSection`
2811ea844a1aSMatthew Knepley @*/
2812cc4c1da9SBarry Smith PetscErrorCode PetscSectionGetConstraintIndices(PetscSection s, PetscInt point, const PetscInt *indices[])
2813d71ae5a4SJacob Faibussowitsch {
2814ea844a1aSMatthew Knepley   PetscFunctionBegin;
2815ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2816ea844a1aSMatthew Knepley   if (s->bc) {
2817da8c939bSJacob Faibussowitsch     PetscCall(VecIntGetValuesSection_Private(s->bcIndices, s->bc, point, indices));
2818ea844a1aSMatthew Knepley   } else *indices = NULL;
28193ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2820ea844a1aSMatthew Knepley }
2821ea844a1aSMatthew Knepley 
2822cc4c1da9SBarry Smith /*@
2823ea844a1aSMatthew Knepley   PetscSectionSetConstraintIndices - Set the point dof numbers, in [0, dof), which are constrained
2824ea844a1aSMatthew Knepley 
282540750d41SVaclav Hapla   Not Collective
2826ea844a1aSMatthew Knepley 
2827ea844a1aSMatthew Knepley   Input Parameters:
2828cab54364SBarry Smith + s       - The `PetscSection`
2829ea844a1aSMatthew Knepley . point   - The point
2830ea844a1aSMatthew Knepley - indices - The constrained dofs
2831ea844a1aSMatthew Knepley 
2832ea844a1aSMatthew Knepley   Level: intermediate
2833ea844a1aSMatthew Knepley 
283438b5cf2dSJacob Faibussowitsch   Fortran Notes:
2835cab54364SBarry Smith   Use `PetscSectionSetConstraintIndicesF90()`
2836cab54364SBarry Smith 
2837cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionGetConstraintIndices()`, `PetscSectionGetConstraintDof()`, `PetscSection`
2838ea844a1aSMatthew Knepley @*/
2839d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetConstraintIndices(PetscSection s, PetscInt point, const PetscInt indices[])
2840d71ae5a4SJacob Faibussowitsch {
2841ea844a1aSMatthew Knepley   PetscFunctionBegin;
2842ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2843ea844a1aSMatthew Knepley   if (s->bc) {
2844d57bb9dbSMatthew G. Knepley     const PetscInt dof  = s->atlasDof[point];
2845d57bb9dbSMatthew G. Knepley     const PetscInt cdof = s->bc->atlasDof[point];
2846d57bb9dbSMatthew G. Knepley     PetscInt       d;
2847d57bb9dbSMatthew G. Knepley 
2848ad716f99SStefano Zampini     if (indices)
2849ad540459SPierre Jolivet       for (d = 0; d < cdof; ++d) 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]);
2850da8c939bSJacob Faibussowitsch     PetscCall(VecIntSetValuesSection_Private(s->bcIndices, s->bc, point, indices, INSERT_VALUES));
2851ea844a1aSMatthew Knepley   }
28523ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2853ea844a1aSMatthew Knepley }
2854ea844a1aSMatthew Knepley 
2855ea844a1aSMatthew Knepley /*@C
2856ea844a1aSMatthew Knepley   PetscSectionGetFieldConstraintIndices - Get the field dof numbers, in [0, fdof), which are constrained
2857ea844a1aSMatthew Knepley 
285840750d41SVaclav Hapla   Not Collective
2859ea844a1aSMatthew Knepley 
2860ea844a1aSMatthew Knepley   Input Parameters:
2861cab54364SBarry Smith + s     - The `PetscSection`
2862ea844a1aSMatthew Knepley . field - The field number
2863ea844a1aSMatthew Knepley - point - The point
2864ea844a1aSMatthew Knepley 
2865ea844a1aSMatthew Knepley   Output Parameter:
28669759eb26SJed Brown . indices - The constrained dofs sorted in ascending order
2867ea844a1aSMatthew Knepley 
2868ea844a1aSMatthew Knepley   Level: intermediate
2869ea844a1aSMatthew Knepley 
2870cab54364SBarry Smith   Note:
2871cab54364SBarry Smith   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()`.
2872cab54364SBarry Smith 
287338b5cf2dSJacob Faibussowitsch   Fortran Notes:
287420662ed9SBarry Smith   Use `PetscSectionGetFieldConstraintIndicesF90()` and `PetscSectionRestoreFieldConstraintIndicesF90()`
2875cab54364SBarry Smith 
2876cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSetFieldConstraintIndices()`, `PetscSectionGetConstraintIndices()`, `PetscSectionGetConstraintDof()`, `PetscSection`
2877ea844a1aSMatthew Knepley @*/
2878d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetFieldConstraintIndices(PetscSection s, PetscInt point, PetscInt field, const PetscInt **indices)
2879d71ae5a4SJacob Faibussowitsch {
2880ea844a1aSMatthew Knepley   PetscFunctionBegin;
2881ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
28824f572ea9SToby Isaac   PetscAssertPointer(indices, 4);
28832abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field, s->numFields);
28849566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstraintIndices(s->field[field], point, indices));
28853ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2886ea844a1aSMatthew Knepley }
2887ea844a1aSMatthew Knepley 
2888ea844a1aSMatthew Knepley /*@C
2889ea844a1aSMatthew Knepley   PetscSectionSetFieldConstraintIndices - Set the field dof numbers, in [0, fdof), which are constrained
2890ea844a1aSMatthew Knepley 
289140750d41SVaclav Hapla   Not Collective
2892ea844a1aSMatthew Knepley 
2893ea844a1aSMatthew Knepley   Input Parameters:
2894cab54364SBarry Smith + s       - The `PetscSection`
2895ea844a1aSMatthew Knepley . point   - The point
2896ea844a1aSMatthew Knepley . field   - The field number
2897ea844a1aSMatthew Knepley - indices - The constrained dofs
2898ea844a1aSMatthew Knepley 
2899ea844a1aSMatthew Knepley   Level: intermediate
2900ea844a1aSMatthew Knepley 
290138b5cf2dSJacob Faibussowitsch   Fortran Notes:
2902cab54364SBarry Smith   Use `PetscSectionSetFieldConstraintIndicesF90()`
2903cab54364SBarry Smith 
2904cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSetConstraintIndices()`, `PetscSectionGetFieldConstraintIndices()`, `PetscSectionGetConstraintDof()`, `PetscSection`
2905ea844a1aSMatthew Knepley @*/
2906d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetFieldConstraintIndices(PetscSection s, PetscInt point, PetscInt field, const PetscInt indices[])
2907d71ae5a4SJacob Faibussowitsch {
2908ea844a1aSMatthew Knepley   PetscFunctionBegin;
2909ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
29102abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field, s->numFields);
29119566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetConstraintIndices(s->field[field], point, indices));
29123ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2913ea844a1aSMatthew Knepley }
2914ea844a1aSMatthew Knepley 
2915ea844a1aSMatthew Knepley /*@
2916ea844a1aSMatthew Knepley   PetscSectionPermute - Reorder the section according to the input point permutation
2917ea844a1aSMatthew Knepley 
291840750d41SVaclav Hapla   Collective
2919ea844a1aSMatthew Knepley 
2920d8d19677SJose E. Roman   Input Parameters:
2921cab54364SBarry Smith + section     - The `PetscSection` object
292238b5cf2dSJacob Faibussowitsch - permutation - The point permutation, old point p becomes new point perm[p]
2923ea844a1aSMatthew Knepley 
2924ea844a1aSMatthew Knepley   Output Parameter:
2925cab54364SBarry Smith . sectionNew - The permuted `PetscSection`
2926ea844a1aSMatthew Knepley 
2927ea844a1aSMatthew Knepley   Level: intermediate
2928ea844a1aSMatthew Knepley 
2929583308b6SBarry Smith   Note:
2930583308b6SBarry Smith   The data and the access to the data via `PetscSectionGetFieldOffset()` and `PetscSectionGetOffset()` are both changed in `sectionNew`
2931583308b6SBarry Smith 
2932583308b6SBarry Smith   Compare to `PetscSectionSetPermutation()`
2933583308b6SBarry Smith 
2934583308b6SBarry Smith .seealso: [PetscSection](sec_petscsection), `IS`, `PetscSection`, `MatPermute()`, `PetscSectionSetPermutation()`
2935ea844a1aSMatthew Knepley @*/
2936d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionPermute(PetscSection section, IS permutation, PetscSection *sectionNew)
2937d71ae5a4SJacob Faibussowitsch {
2938ea844a1aSMatthew Knepley   PetscSection    s = section, sNew;
2939ea844a1aSMatthew Knepley   const PetscInt *perm;
2940b778fa18SValeria Barra   PetscInt        numFields, f, c, numPoints, pStart, pEnd, p;
2941ea844a1aSMatthew Knepley 
2942ea844a1aSMatthew Knepley   PetscFunctionBegin;
2943ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1);
2944ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(permutation, IS_CLASSID, 2);
29454f572ea9SToby Isaac   PetscAssertPointer(sectionNew, 3);
29469566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject)s), &sNew));
29479566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetNumFields(s, &numFields));
29489566063dSJacob Faibussowitsch   if (numFields) PetscCall(PetscSectionSetNumFields(sNew, numFields));
2949ea844a1aSMatthew Knepley   for (f = 0; f < numFields; ++f) {
2950ea844a1aSMatthew Knepley     const char *name;
2951ea844a1aSMatthew Knepley     PetscInt    numComp;
2952ea844a1aSMatthew Knepley 
29539566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldName(s, f, &name));
29549566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldName(sNew, f, name));
29559566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldComponents(s, f, &numComp));
29569566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldComponents(sNew, f, numComp));
2957b778fa18SValeria Barra     for (c = 0; c < s->numFieldComponents[f]; ++c) {
29589566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetComponentName(s, f, c, &name));
29599566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetComponentName(sNew, f, c, name));
2960b778fa18SValeria Barra     }
2961ea844a1aSMatthew Knepley   }
29629566063dSJacob Faibussowitsch   PetscCall(ISGetLocalSize(permutation, &numPoints));
29639566063dSJacob Faibussowitsch   PetscCall(ISGetIndices(permutation, &perm));
29649566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
29659566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(sNew, pStart, pEnd));
296608401ef6SPierre Jolivet   PetscCheck(numPoints >= pEnd, PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "Permutation size %" PetscInt_FMT " is less than largest Section point %" PetscInt_FMT, numPoints, pEnd);
2967ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
2968ea844a1aSMatthew Knepley     PetscInt dof, cdof;
2969ea844a1aSMatthew Knepley 
29709566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s, p, &dof));
29719566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(sNew, perm[p], dof));
29729566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s, p, &cdof));
29739566063dSJacob Faibussowitsch     if (cdof) PetscCall(PetscSectionSetConstraintDof(sNew, perm[p], cdof));
2974ea844a1aSMatthew Knepley     for (f = 0; f < numFields; ++f) {
29759566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldDof(s, p, f, &dof));
29769566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldDof(sNew, perm[p], f, dof));
29779566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintDof(s, p, f, &cdof));
29789566063dSJacob Faibussowitsch       if (cdof) PetscCall(PetscSectionSetFieldConstraintDof(sNew, perm[p], f, cdof));
2979ea844a1aSMatthew Knepley     }
2980ea844a1aSMatthew Knepley   }
29819566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(sNew));
2982ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
2983ea844a1aSMatthew Knepley     const PetscInt *cind;
2984ea844a1aSMatthew Knepley     PetscInt        cdof;
2985ea844a1aSMatthew Knepley 
29869566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s, p, &cdof));
2987ea844a1aSMatthew Knepley     if (cdof) {
29889566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetConstraintIndices(s, p, &cind));
29899566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetConstraintIndices(sNew, perm[p], cind));
2990ea844a1aSMatthew Knepley     }
2991ea844a1aSMatthew Knepley     for (f = 0; f < numFields; ++f) {
29929566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintDof(s, p, f, &cdof));
2993ea844a1aSMatthew Knepley       if (cdof) {
29949566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetFieldConstraintIndices(s, p, f, &cind));
29959566063dSJacob Faibussowitsch         PetscCall(PetscSectionSetFieldConstraintIndices(sNew, perm[p], f, cind));
2996ea844a1aSMatthew Knepley       }
2997ea844a1aSMatthew Knepley     }
2998ea844a1aSMatthew Knepley   }
29999566063dSJacob Faibussowitsch   PetscCall(ISRestoreIndices(permutation, &perm));
3000ea844a1aSMatthew Knepley   *sectionNew = sNew;
30013ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3002ea844a1aSMatthew Knepley }
3003ea844a1aSMatthew Knepley 
3004ea844a1aSMatthew Knepley /*@
300520662ed9SBarry Smith   PetscSectionSetClosureIndex - Create an internal data structure to speed up closure queries.
3006ea844a1aSMatthew Knepley 
300740750d41SVaclav Hapla   Collective
3008ea844a1aSMatthew Knepley 
3009ea844a1aSMatthew Knepley   Input Parameters:
3010cab54364SBarry Smith + section   - The `PetscSection`
3011cab54364SBarry Smith . obj       - A `PetscObject` which serves as the key for this index
3012cab54364SBarry Smith . clSection - `PetscSection` giving the size of the closure of each point
3013cab54364SBarry Smith - clPoints  - `IS` giving the points in each closure
3014ea844a1aSMatthew Knepley 
3015ea844a1aSMatthew Knepley   Level: advanced
3016ea844a1aSMatthew Knepley 
3017cab54364SBarry Smith   Note:
301820662ed9SBarry Smith   This function creates an internal map from each point to its closure. We compress out closure points with no dofs in this section.
301920662ed9SBarry Smith 
302038b5cf2dSJacob Faibussowitsch   Developer Notes:
302120662ed9SBarry Smith   The information provided here is completely opaque
3022cab54364SBarry Smith 
3023cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetClosureIndex()`, `DMPlexCreateClosureIndex()`
3024ea844a1aSMatthew Knepley @*/
3025d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetClosureIndex(PetscSection section, PetscObject obj, PetscSection clSection, IS clPoints)
3026d71ae5a4SJacob Faibussowitsch {
3027ea844a1aSMatthew Knepley   PetscFunctionBegin;
30283e03ebd8SStefano Zampini   PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1);
30293e03ebd8SStefano Zampini   PetscValidHeaderSpecific(clSection, PETSC_SECTION_CLASSID, 3);
30303e03ebd8SStefano Zampini   PetscValidHeaderSpecific(clPoints, IS_CLASSID, 4);
3031d4a1ad33SMatthew G. Knepley   if (section->clObj != obj) PetscCall(PetscSectionResetClosurePermutation(section));
3032ea844a1aSMatthew Knepley   section->clObj = obj;
30339566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)clSection));
30349566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)clPoints));
30359566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&section->clSection));
30369566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&section->clPoints));
3037ea844a1aSMatthew Knepley   section->clSection = clSection;
3038ea844a1aSMatthew Knepley   section->clPoints  = clPoints;
30393ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3040ea844a1aSMatthew Knepley }
3041ea844a1aSMatthew Knepley 
3042ea844a1aSMatthew Knepley /*@
3043cab54364SBarry Smith   PetscSectionGetClosureIndex - Get the cache of points in the closure of each point in the section set with `PetscSectionSetClosureIndex()`
3044ea844a1aSMatthew Knepley 
304540750d41SVaclav Hapla   Collective
3046ea844a1aSMatthew Knepley 
3047ea844a1aSMatthew Knepley   Input Parameters:
3048cab54364SBarry Smith + section - The `PetscSection`
3049cab54364SBarry Smith - obj     - A `PetscObject` which serves as the key for this index
3050ea844a1aSMatthew Knepley 
3051ea844a1aSMatthew Knepley   Output Parameters:
3052cab54364SBarry Smith + clSection - `PetscSection` giving the size of the closure of each point
3053cab54364SBarry Smith - clPoints  - `IS` giving the points in each closure
3054ea844a1aSMatthew Knepley 
3055ea844a1aSMatthew Knepley   Level: advanced
3056ea844a1aSMatthew Knepley 
3057cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSetClosureIndex()`, `DMPlexCreateClosureIndex()`
3058ea844a1aSMatthew Knepley @*/
3059d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetClosureIndex(PetscSection section, PetscObject obj, PetscSection *clSection, IS *clPoints)
3060d71ae5a4SJacob Faibussowitsch {
3061ea844a1aSMatthew Knepley   PetscFunctionBegin;
3062ea844a1aSMatthew Knepley   if (section->clObj == obj) {
3063ea844a1aSMatthew Knepley     if (clSection) *clSection = section->clSection;
3064ea844a1aSMatthew Knepley     if (clPoints) *clPoints = section->clPoints;
3065ea844a1aSMatthew Knepley   } else {
3066ea844a1aSMatthew Knepley     if (clSection) *clSection = NULL;
3067ea844a1aSMatthew Knepley     if (clPoints) *clPoints = NULL;
3068ea844a1aSMatthew Knepley   }
30693ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3070ea844a1aSMatthew Knepley }
3071ea844a1aSMatthew Knepley 
3072d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetClosurePermutation_Internal(PetscSection section, PetscObject obj, PetscInt depth, PetscInt clSize, PetscCopyMode mode, PetscInt *clPerm)
3073d71ae5a4SJacob Faibussowitsch {
3074ea844a1aSMatthew Knepley   PetscInt                    i;
3075c459fbc1SJed Brown   khiter_t                    iter;
3076c459fbc1SJed Brown   int                         new_entry;
3077c459fbc1SJed Brown   PetscSectionClosurePermKey  key = {depth, clSize};
3078c459fbc1SJed Brown   PetscSectionClosurePermVal *val;
3079ea844a1aSMatthew Knepley 
3080ea844a1aSMatthew Knepley   PetscFunctionBegin;
3081ea844a1aSMatthew Knepley   if (section->clObj != obj) {
30829566063dSJacob Faibussowitsch     PetscCall(PetscSectionDestroy(&section->clSection));
30839566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&section->clPoints));
3084ea844a1aSMatthew Knepley   }
3085ea844a1aSMatthew Knepley   section->clObj = obj;
30869566063dSJacob Faibussowitsch   if (!section->clHash) PetscCall(PetscClPermCreate(&section->clHash));
3087c459fbc1SJed Brown   iter = kh_put(ClPerm, section->clHash, key, &new_entry);
3088c459fbc1SJed Brown   val  = &kh_val(section->clHash, iter);
3089c459fbc1SJed Brown   if (!new_entry) {
30909566063dSJacob Faibussowitsch     PetscCall(PetscFree(val->perm));
30919566063dSJacob Faibussowitsch     PetscCall(PetscFree(val->invPerm));
3092c459fbc1SJed Brown   }
3093ea844a1aSMatthew Knepley   if (mode == PETSC_COPY_VALUES) {
30949566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(clSize, &val->perm));
30959566063dSJacob Faibussowitsch     PetscCall(PetscArraycpy(val->perm, clPerm, clSize));
3096ea844a1aSMatthew Knepley   } else if (mode == PETSC_OWN_POINTER) {
3097c459fbc1SJed Brown     val->perm = clPerm;
3098ea844a1aSMatthew Knepley   } else SETERRQ(PetscObjectComm(obj), PETSC_ERR_SUP, "Do not support borrowed arrays");
30999566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(clSize, &val->invPerm));
3100c459fbc1SJed Brown   for (i = 0; i < clSize; ++i) val->invPerm[clPerm[i]] = i;
31013ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3102ea844a1aSMatthew Knepley }
3103ea844a1aSMatthew Knepley 
3104ea844a1aSMatthew Knepley /*@
3105c459fbc1SJed Brown   PetscSectionSetClosurePermutation - Set the dof permutation for the closure of each cell in the section, meaning clPerm[newIndex] = oldIndex.
3106ea844a1aSMatthew Knepley 
3107ea844a1aSMatthew Knepley   Not Collective
3108ea844a1aSMatthew Knepley 
3109ea844a1aSMatthew Knepley   Input Parameters:
3110cab54364SBarry Smith + section - The `PetscSection`
3111cab54364SBarry Smith . obj     - A `PetscObject` which serves as the key for this index (usually a `DM`)
3112c459fbc1SJed Brown . depth   - Depth of points on which to apply the given permutation
3113ea844a1aSMatthew Knepley - perm    - Permutation of the cell dof closure
3114ea844a1aSMatthew Knepley 
3115cab54364SBarry Smith   Level: intermediate
3116cab54364SBarry Smith 
3117cab54364SBarry Smith   Notes:
3118c459fbc1SJed Brown   The specified permutation will only be applied to points at depth whose closure size matches the length of perm.  In a
3119c459fbc1SJed Brown   mixed-topology or variable-degree finite element space, this function can be called multiple times at each depth for
3120c459fbc1SJed Brown   each topology and degree.
3121c459fbc1SJed Brown 
3122c459fbc1SJed Brown   This approach assumes that (depth, len(perm)) uniquely identifies the desired permutation; this might not be true for
3123c459fbc1SJed Brown   exotic/enriched spaces on mixed topology meshes.
3124ea844a1aSMatthew Knepley 
3125cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `IS`, `PetscSectionGetClosurePermutation()`, `PetscSectionGetClosureIndex()`, `DMPlexCreateClosureIndex()`, `PetscCopyMode`
3126ea844a1aSMatthew Knepley @*/
3127d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetClosurePermutation(PetscSection section, PetscObject obj, PetscInt depth, IS perm)
3128d71ae5a4SJacob Faibussowitsch {
3129ea844a1aSMatthew Knepley   const PetscInt *clPerm = NULL;
3130ea844a1aSMatthew Knepley   PetscInt        clSize = 0;
3131ea844a1aSMatthew Knepley 
3132ea844a1aSMatthew Knepley   PetscFunctionBegin;
3133ea844a1aSMatthew Knepley   if (perm) {
31349566063dSJacob Faibussowitsch     PetscCall(ISGetLocalSize(perm, &clSize));
31359566063dSJacob Faibussowitsch     PetscCall(ISGetIndices(perm, &clPerm));
3136ea844a1aSMatthew Knepley   }
31379566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetClosurePermutation_Internal(section, obj, depth, clSize, PETSC_COPY_VALUES, (PetscInt *)clPerm));
31389566063dSJacob Faibussowitsch   if (perm) PetscCall(ISRestoreIndices(perm, &clPerm));
31393ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3140ea844a1aSMatthew Knepley }
3141ea844a1aSMatthew Knepley 
3142da8c939bSJacob Faibussowitsch static PetscErrorCode PetscSectionGetClosurePermutation_Private(PetscSection section, PetscObject obj, PetscInt depth, PetscInt size, const PetscInt *perm[])
3143d71ae5a4SJacob Faibussowitsch {
3144ea844a1aSMatthew Knepley   PetscFunctionBegin;
3145ea844a1aSMatthew Knepley   if (section->clObj == obj) {
3146c459fbc1SJed Brown     PetscSectionClosurePermKey k = {depth, size};
3147c459fbc1SJed Brown     PetscSectionClosurePermVal v;
3148da8c939bSJacob Faibussowitsch 
31499566063dSJacob Faibussowitsch     PetscCall(PetscClPermGet(section->clHash, k, &v));
3150c459fbc1SJed Brown     if (perm) *perm = v.perm;
3151ea844a1aSMatthew Knepley   } else {
3152ea844a1aSMatthew Knepley     if (perm) *perm = NULL;
3153ea844a1aSMatthew Knepley   }
31543ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3155ea844a1aSMatthew Knepley }
3156ea844a1aSMatthew Knepley 
3157ea844a1aSMatthew Knepley /*@
3158ea844a1aSMatthew Knepley   PetscSectionGetClosurePermutation - Get the dof permutation for the closure of each cell in the section, meaning clPerm[newIndex] = oldIndex.
3159ea844a1aSMatthew Knepley 
316040750d41SVaclav Hapla   Not Collective
3161ea844a1aSMatthew Knepley 
3162ea844a1aSMatthew Knepley   Input Parameters:
3163cab54364SBarry Smith + section - The `PetscSection`
3164cab54364SBarry Smith . obj     - A `PetscObject` which serves as the key for this index (usually a DM)
3165c459fbc1SJed Brown . depth   - Depth stratum on which to obtain closure permutation
3166c459fbc1SJed Brown - clSize  - Closure size to be permuted (e.g., may vary with element topology and degree)
3167ea844a1aSMatthew Knepley 
3168ea844a1aSMatthew Knepley   Output Parameter:
3169ea844a1aSMatthew Knepley . perm - The dof closure permutation
3170ea844a1aSMatthew Knepley 
3171ea844a1aSMatthew Knepley   Level: intermediate
3172ea844a1aSMatthew Knepley 
3173cab54364SBarry Smith   Note:
3174cab54364SBarry Smith   The user must destroy the `IS` that is returned.
3175cab54364SBarry Smith 
3176cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `IS`, `PetscSectionSetClosurePermutation()`, `PetscSectionGetClosureInversePermutation()`, `PetscSectionGetClosureIndex()`, `PetscSectionSetClosureIndex()`, `DMPlexCreateClosureIndex()`
3177ea844a1aSMatthew Knepley @*/
3178d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetClosurePermutation(PetscSection section, PetscObject obj, PetscInt depth, PetscInt clSize, IS *perm)
3179d71ae5a4SJacob Faibussowitsch {
3180da8c939bSJacob Faibussowitsch   const PetscInt *clPerm = NULL;
3181ea844a1aSMatthew Knepley 
3182ea844a1aSMatthew Knepley   PetscFunctionBegin;
3183da8c939bSJacob Faibussowitsch   PetscCall(PetscSectionGetClosurePermutation_Private(section, obj, depth, clSize, &clPerm));
31845f82726aSMatthew G. Knepley   PetscCheck(clPerm, PetscObjectComm((PetscObject)obj), PETSC_ERR_ARG_WRONG, "There is no closure permutation associated with this object for depth %" PetscInt_FMT " of size %" PetscInt_FMT, depth, clSize);
31859566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(PETSC_COMM_SELF, clSize, clPerm, PETSC_USE_POINTER, perm));
31863ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3187ea844a1aSMatthew Knepley }
3188ea844a1aSMatthew Knepley 
3189d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetClosureInversePermutation_Internal(PetscSection section, PetscObject obj, PetscInt depth, PetscInt size, const PetscInt *perm[])
3190d71ae5a4SJacob Faibussowitsch {
3191ea844a1aSMatthew Knepley   PetscFunctionBegin;
3192c459fbc1SJed Brown   if (section->clObj == obj && section->clHash) {
3193c459fbc1SJed Brown     PetscSectionClosurePermKey k = {depth, size};
3194c459fbc1SJed Brown     PetscSectionClosurePermVal v;
31959566063dSJacob Faibussowitsch     PetscCall(PetscClPermGet(section->clHash, k, &v));
3196c459fbc1SJed Brown     if (perm) *perm = v.invPerm;
3197ea844a1aSMatthew Knepley   } else {
3198ea844a1aSMatthew Knepley     if (perm) *perm = NULL;
3199ea844a1aSMatthew Knepley   }
32003ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3201ea844a1aSMatthew Knepley }
3202ea844a1aSMatthew Knepley 
3203ea844a1aSMatthew Knepley /*@
3204ea844a1aSMatthew Knepley   PetscSectionGetClosureInversePermutation - Get the inverse dof permutation for the closure of each cell in the section, meaning clPerm[oldIndex] = newIndex.
3205ea844a1aSMatthew Knepley 
320640750d41SVaclav Hapla   Not Collective
3207ea844a1aSMatthew Knepley 
3208ea844a1aSMatthew Knepley   Input Parameters:
3209cab54364SBarry Smith + section - The `PetscSection`
3210cab54364SBarry Smith . obj     - A `PetscObject` which serves as the key for this index (usually a `DM`)
3211c459fbc1SJed Brown . depth   - Depth stratum on which to obtain closure permutation
3212c459fbc1SJed Brown - clSize  - Closure size to be permuted (e.g., may vary with element topology and degree)
3213ea844a1aSMatthew Knepley 
32142fe279fdSBarry Smith   Output Parameter:
3215c459fbc1SJed Brown . perm - The dof closure permutation
3216ea844a1aSMatthew Knepley 
3217ea844a1aSMatthew Knepley   Level: intermediate
3218ea844a1aSMatthew Knepley 
3219cab54364SBarry Smith   Note:
3220cab54364SBarry Smith   The user must destroy the `IS` that is returned.
3221cab54364SBarry Smith 
3222cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `IS`, `PetscSectionSetClosurePermutation()`, `PetscSectionGetClosureIndex()`, `PetscSectionSetClosureIndex()`, `DMPlexCreateClosureIndex()`
3223ea844a1aSMatthew Knepley @*/
3224d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetClosureInversePermutation(PetscSection section, PetscObject obj, PetscInt depth, PetscInt clSize, IS *perm)
3225d71ae5a4SJacob Faibussowitsch {
3226da8c939bSJacob Faibussowitsch   const PetscInt *clPerm = NULL;
3227ea844a1aSMatthew Knepley 
3228ea844a1aSMatthew Knepley   PetscFunctionBegin;
32299566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetClosureInversePermutation_Internal(section, obj, depth, clSize, &clPerm));
32309566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(PETSC_COMM_SELF, clSize, clPerm, PETSC_USE_POINTER, perm));
32313ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3232ea844a1aSMatthew Knepley }
3233ea844a1aSMatthew Knepley 
3234ea844a1aSMatthew Knepley /*@
3235583308b6SBarry Smith   PetscSectionGetField - Get the `PetscSection` associated with a single field
3236ea844a1aSMatthew Knepley 
3237ea844a1aSMatthew Knepley   Input Parameters:
3238cab54364SBarry Smith + s     - The `PetscSection`
3239ea844a1aSMatthew Knepley - field - The field number
3240ea844a1aSMatthew Knepley 
3241ea844a1aSMatthew Knepley   Output Parameter:
3242583308b6SBarry Smith . subs - The `PetscSection` for the given field, note the chart of `subs` is not set
3243ea844a1aSMatthew Knepley 
3244ea844a1aSMatthew Knepley   Level: intermediate
3245ea844a1aSMatthew Knepley 
3246cab54364SBarry Smith   Note:
3247cab54364SBarry Smith   Does not increase the reference count of the selected sub-section. There is no matching `PetscSectionRestoreField()`
3248cab54364SBarry Smith 
3249cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `IS`, `PetscSectionSetNumFields()`
3250ea844a1aSMatthew Knepley @*/
3251d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetField(PetscSection s, PetscInt field, PetscSection *subs)
3252d71ae5a4SJacob Faibussowitsch {
3253ea844a1aSMatthew Knepley   PetscFunctionBegin;
3254ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
32554f572ea9SToby Isaac   PetscAssertPointer(subs, 3);
32562abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field, s->numFields);
3257ea844a1aSMatthew Knepley   *subs = s->field[field];
32583ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3259ea844a1aSMatthew Knepley }
3260ea844a1aSMatthew Knepley 
3261ea844a1aSMatthew Knepley PetscClassId      PETSC_SECTION_SYM_CLASSID;
3262ea844a1aSMatthew Knepley PetscFunctionList PetscSectionSymList = NULL;
3263ea844a1aSMatthew Knepley 
3264ea844a1aSMatthew Knepley /*@
3265cab54364SBarry Smith   PetscSectionSymCreate - Creates an empty `PetscSectionSym` object.
3266ea844a1aSMatthew Knepley 
3267ea844a1aSMatthew Knepley   Collective
3268ea844a1aSMatthew Knepley 
3269ea844a1aSMatthew Knepley   Input Parameter:
3270ea844a1aSMatthew Knepley . comm - the MPI communicator
3271ea844a1aSMatthew Knepley 
3272ea844a1aSMatthew Knepley   Output Parameter:
3273ea844a1aSMatthew Knepley . sym - pointer to the new set of symmetries
3274ea844a1aSMatthew Knepley 
3275ea844a1aSMatthew Knepley   Level: developer
3276ea844a1aSMatthew Knepley 
3277cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionSym`, `PetscSectionSymDestroy()`
3278ea844a1aSMatthew Knepley @*/
3279d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSymCreate(MPI_Comm comm, PetscSectionSym *sym)
3280d71ae5a4SJacob Faibussowitsch {
3281ea844a1aSMatthew Knepley   PetscFunctionBegin;
32824f572ea9SToby Isaac   PetscAssertPointer(sym, 2);
32839566063dSJacob Faibussowitsch   PetscCall(ISInitializePackage());
3284*377f809aSBarry Smith 
32859566063dSJacob Faibussowitsch   PetscCall(PetscHeaderCreate(*sym, PETSC_SECTION_SYM_CLASSID, "PetscSectionSym", "Section Symmetry", "IS", comm, PetscSectionSymDestroy, PetscSectionSymView));
32863ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3287ea844a1aSMatthew Knepley }
3288ea844a1aSMatthew Knepley 
3289cc4c1da9SBarry Smith /*@
3290cab54364SBarry Smith   PetscSectionSymSetType - Builds a `PetscSectionSym`, for a particular implementation.
3291ea844a1aSMatthew Knepley 
329240750d41SVaclav Hapla   Collective
3293ea844a1aSMatthew Knepley 
3294ea844a1aSMatthew Knepley   Input Parameters:
3295ea844a1aSMatthew Knepley + sym    - The section symmetry object
3296ea844a1aSMatthew Knepley - method - The name of the section symmetry type
3297ea844a1aSMatthew Knepley 
3298ea844a1aSMatthew Knepley   Level: developer
3299ea844a1aSMatthew Knepley 
3300cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionSymType`, `PetscSectionSymGetType()`, `PetscSectionSymCreate()`
3301ea844a1aSMatthew Knepley @*/
3302d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSymSetType(PetscSectionSym sym, PetscSectionSymType method)
3303d71ae5a4SJacob Faibussowitsch {
3304ea844a1aSMatthew Knepley   PetscErrorCode (*r)(PetscSectionSym);
3305ea844a1aSMatthew Knepley   PetscBool match;
3306ea844a1aSMatthew Knepley 
3307ea844a1aSMatthew Knepley   PetscFunctionBegin;
3308ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID, 1);
33099566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)sym, method, &match));
33103ba16761SJacob Faibussowitsch   if (match) PetscFunctionReturn(PETSC_SUCCESS);
3311ea844a1aSMatthew Knepley 
33129566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListFind(PetscSectionSymList, method, &r));
33136adde796SStefano Zampini   PetscCheck(r, PetscObjectComm((PetscObject)sym), PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown PetscSectionSym type: %s", method);
3314dbbe0bcdSBarry Smith   PetscTryTypeMethod(sym, destroy);
3315ea844a1aSMatthew Knepley   sym->ops->destroy = NULL;
3316dbbe0bcdSBarry Smith 
33179566063dSJacob Faibussowitsch   PetscCall((*r)(sym));
33189566063dSJacob Faibussowitsch   PetscCall(PetscObjectChangeTypeName((PetscObject)sym, method));
33193ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3320ea844a1aSMatthew Knepley }
3321ea844a1aSMatthew Knepley 
3322cc4c1da9SBarry Smith /*@
3323cab54364SBarry Smith   PetscSectionSymGetType - Gets the section symmetry type name (as a string) from the `PetscSectionSym`.
3324ea844a1aSMatthew Knepley 
3325ea844a1aSMatthew Knepley   Not Collective
3326ea844a1aSMatthew Knepley 
3327ea844a1aSMatthew Knepley   Input Parameter:
3328ea844a1aSMatthew Knepley . sym - The section symmetry
3329ea844a1aSMatthew Knepley 
3330ea844a1aSMatthew Knepley   Output Parameter:
3331ea844a1aSMatthew Knepley . type - The index set type name
3332ea844a1aSMatthew Knepley 
3333ea844a1aSMatthew Knepley   Level: developer
3334ea844a1aSMatthew Knepley 
3335cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionSymType`, `PetscSectionSymSetType()`, `PetscSectionSymCreate()`
3336ea844a1aSMatthew Knepley @*/
3337d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSymGetType(PetscSectionSym sym, PetscSectionSymType *type)
3338d71ae5a4SJacob Faibussowitsch {
3339ea844a1aSMatthew Knepley   PetscFunctionBegin;
3340ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID, 1);
33414f572ea9SToby Isaac   PetscAssertPointer(type, 2);
3342ea844a1aSMatthew Knepley   *type = ((PetscObject)sym)->type_name;
33433ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3344ea844a1aSMatthew Knepley }
3345ea844a1aSMatthew Knepley 
3346ea844a1aSMatthew Knepley /*@C
3347cab54364SBarry Smith   PetscSectionSymRegister - Registers a new section symmetry implementation
3348ea844a1aSMatthew Knepley 
3349cc4c1da9SBarry Smith   Not Collective, No Fortran Support
3350ea844a1aSMatthew Knepley 
3351ea844a1aSMatthew Knepley   Input Parameters:
33522fe279fdSBarry Smith + sname    - The name of a new user-defined creation routine
33532fe279fdSBarry Smith - function - The creation routine itself
3354ea844a1aSMatthew Knepley 
3355ea844a1aSMatthew Knepley   Level: developer
3356ea844a1aSMatthew Knepley 
3357cab54364SBarry Smith   Notes:
3358cab54364SBarry Smith   `PetscSectionSymRegister()` may be called multiple times to add several user-defined vectors
3359cab54364SBarry Smith 
3360cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionSymType`, `PetscSectionSymCreate()`, `PetscSectionSymSetType()`
3361ea844a1aSMatthew Knepley @*/
3362d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSymRegister(const char sname[], PetscErrorCode (*function)(PetscSectionSym))
3363d71ae5a4SJacob Faibussowitsch {
3364ea844a1aSMatthew Knepley   PetscFunctionBegin;
33659566063dSJacob Faibussowitsch   PetscCall(ISInitializePackage());
33669566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListAdd(&PetscSectionSymList, sname, function));
33673ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3368ea844a1aSMatthew Knepley }
3369ea844a1aSMatthew Knepley 
3370ea844a1aSMatthew Knepley /*@
3371ea844a1aSMatthew Knepley   PetscSectionSymDestroy - Destroys a section symmetry.
3372ea844a1aSMatthew Knepley 
337340750d41SVaclav Hapla   Collective
3374ea844a1aSMatthew Knepley 
33752fe279fdSBarry Smith   Input Parameter:
3376ea844a1aSMatthew Knepley . sym - the section symmetry
3377ea844a1aSMatthew Knepley 
3378ea844a1aSMatthew Knepley   Level: developer
3379ea844a1aSMatthew Knepley 
338042747ad1SJacob Faibussowitsch .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionSymCreate()`
3381ea844a1aSMatthew Knepley @*/
3382d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSymDestroy(PetscSectionSym *sym)
3383d71ae5a4SJacob Faibussowitsch {
3384ea844a1aSMatthew Knepley   SymWorkLink link, next;
3385ea844a1aSMatthew Knepley 
3386ea844a1aSMatthew Knepley   PetscFunctionBegin;
33873ba16761SJacob Faibussowitsch   if (!*sym) PetscFunctionReturn(PETSC_SUCCESS);
3388f4f49eeaSPierre Jolivet   PetscValidHeaderSpecific(*sym, PETSC_SECTION_SYM_CLASSID, 1);
3389f4f49eeaSPierre Jolivet   if (--((PetscObject)*sym)->refct > 0) {
33909371c9d4SSatish Balay     *sym = NULL;
33913ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
3392ea844a1aSMatthew Knepley   }
3393213acdd3SPierre Jolivet   PetscTryTypeMethod(*sym, destroy);
3394c9cc58a2SBarry Smith   PetscCheck(!(*sym)->workout, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "Work array still checked out");
3395ea844a1aSMatthew Knepley   for (link = (*sym)->workin; link; link = next) {
33960c99d500SBarry Smith     PetscInt    **perms = (PetscInt **)link->perms;
33970c99d500SBarry Smith     PetscScalar **rots  = (PetscScalar **)link->rots;
33980c99d500SBarry Smith     PetscCall(PetscFree2(perms, rots));
3399ea844a1aSMatthew Knepley     next = link->next;
34009566063dSJacob Faibussowitsch     PetscCall(PetscFree(link));
3401ea844a1aSMatthew Knepley   }
3402ea844a1aSMatthew Knepley   (*sym)->workin = NULL;
34039566063dSJacob Faibussowitsch   PetscCall(PetscHeaderDestroy(sym));
34043ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3405ea844a1aSMatthew Knepley }
3406ea844a1aSMatthew Knepley 
3407ffeef943SBarry Smith /*@
3408ea844a1aSMatthew Knepley   PetscSectionSymView - Displays a section symmetry
3409ea844a1aSMatthew Knepley 
341040750d41SVaclav Hapla   Collective
3411ea844a1aSMatthew Knepley 
3412ea844a1aSMatthew Knepley   Input Parameters:
3413ea844a1aSMatthew Knepley + sym    - the index set
3414cab54364SBarry Smith - viewer - viewer used to display the set, for example `PETSC_VIEWER_STDOUT_SELF`.
3415ea844a1aSMatthew Knepley 
3416ea844a1aSMatthew Knepley   Level: developer
3417ea844a1aSMatthew Knepley 
3418cab54364SBarry Smith .seealso: `PetscSectionSym`, `PetscViewer`, `PetscViewerASCIIOpen()`
3419ea844a1aSMatthew Knepley @*/
3420d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSymView(PetscSectionSym sym, PetscViewer viewer)
3421d71ae5a4SJacob Faibussowitsch {
3422ea844a1aSMatthew Knepley   PetscFunctionBegin;
3423ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID, 1);
342448a46eb9SPierre Jolivet   if (!viewer) PetscCall(PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)sym), &viewer));
3425ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(viewer, PETSC_VIEWER_CLASSID, 2);
3426ea844a1aSMatthew Knepley   PetscCheckSameComm(sym, 1, viewer, 2);
34279566063dSJacob Faibussowitsch   PetscCall(PetscObjectPrintClassNamePrefixType((PetscObject)sym, viewer));
3428dbbe0bcdSBarry Smith   PetscTryTypeMethod(sym, view, viewer);
34293ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3430ea844a1aSMatthew Knepley }
3431ea844a1aSMatthew Knepley 
3432ea844a1aSMatthew Knepley /*@
3433ea844a1aSMatthew Knepley   PetscSectionSetSym - Set the symmetries for the data referred to by the section
3434ea844a1aSMatthew Knepley 
343540750d41SVaclav Hapla   Collective
3436ea844a1aSMatthew Knepley 
3437ea844a1aSMatthew Knepley   Input Parameters:
3438ea844a1aSMatthew Knepley + section - the section describing data layout
3439ea844a1aSMatthew Knepley - sym     - the symmetry describing the affect of orientation on the access of the data
3440ea844a1aSMatthew Knepley 
3441ea844a1aSMatthew Knepley   Level: developer
3442ea844a1aSMatthew Knepley 
3443cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionGetSym()`, `PetscSectionSymCreate()`
3444ea844a1aSMatthew Knepley @*/
3445d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetSym(PetscSection section, PetscSectionSym sym)
3446d71ae5a4SJacob Faibussowitsch {
3447ea844a1aSMatthew Knepley   PetscFunctionBegin;
3448ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1);
3449f4f49eeaSPierre Jolivet   PetscCall(PetscSectionSymDestroy(&section->sym));
3450ea844a1aSMatthew Knepley   if (sym) {
3451ea844a1aSMatthew Knepley     PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID, 2);
3452ea844a1aSMatthew Knepley     PetscCheckSameComm(section, 1, sym, 2);
34539566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject)sym));
3454ea844a1aSMatthew Knepley   }
3455ea844a1aSMatthew Knepley   section->sym = sym;
34563ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3457ea844a1aSMatthew Knepley }
3458ea844a1aSMatthew Knepley 
3459ea844a1aSMatthew Knepley /*@
3460ea844a1aSMatthew Knepley   PetscSectionGetSym - Get the symmetries for the data referred to by the section
3461ea844a1aSMatthew Knepley 
346240750d41SVaclav Hapla   Not Collective
3463ea844a1aSMatthew Knepley 
34642fe279fdSBarry Smith   Input Parameter:
3465ea844a1aSMatthew Knepley . section - the section describing data layout
3466ea844a1aSMatthew Knepley 
34672fe279fdSBarry Smith   Output Parameter:
346820662ed9SBarry Smith . sym - the symmetry describing the affect of orientation on the access of the data, provided previously by `PetscSectionSetSym()`
3469ea844a1aSMatthew Knepley 
3470ea844a1aSMatthew Knepley   Level: developer
3471ea844a1aSMatthew Knepley 
3472cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionSetSym()`, `PetscSectionSymCreate()`
3473ea844a1aSMatthew Knepley @*/
3474d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetSym(PetscSection section, PetscSectionSym *sym)
3475d71ae5a4SJacob Faibussowitsch {
3476ea844a1aSMatthew Knepley   PetscFunctionBegin;
3477ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1);
3478ea844a1aSMatthew Knepley   *sym = section->sym;
34793ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3480ea844a1aSMatthew Knepley }
3481ea844a1aSMatthew Knepley 
3482ea844a1aSMatthew Knepley /*@
3483ea844a1aSMatthew Knepley   PetscSectionSetFieldSym - Set the symmetries for the data referred to by a field of the section
3484ea844a1aSMatthew Knepley 
348540750d41SVaclav Hapla   Collective
3486ea844a1aSMatthew Knepley 
3487ea844a1aSMatthew Knepley   Input Parameters:
3488ea844a1aSMatthew Knepley + section - the section describing data layout
3489ea844a1aSMatthew Knepley . field   - the field number
3490ea844a1aSMatthew Knepley - sym     - the symmetry describing the affect of orientation on the access of the data
3491ea844a1aSMatthew Knepley 
3492ea844a1aSMatthew Knepley   Level: developer
3493ea844a1aSMatthew Knepley 
3494cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionGetFieldSym()`, `PetscSectionSymCreate()`
3495ea844a1aSMatthew Knepley @*/
3496d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetFieldSym(PetscSection section, PetscInt field, PetscSectionSym sym)
3497d71ae5a4SJacob Faibussowitsch {
3498ea844a1aSMatthew Knepley   PetscFunctionBegin;
3499ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1);
35002abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field, section->numFields);
35019566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetSym(section->field[field], sym));
35023ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3503ea844a1aSMatthew Knepley }
3504ea844a1aSMatthew Knepley 
3505ea844a1aSMatthew Knepley /*@
3506ea844a1aSMatthew Knepley   PetscSectionGetFieldSym - Get the symmetries for the data referred to by a field of the section
3507ea844a1aSMatthew Knepley 
350840750d41SVaclav Hapla   Collective
3509ea844a1aSMatthew Knepley 
3510ea844a1aSMatthew Knepley   Input Parameters:
3511ea844a1aSMatthew Knepley + section - the section describing data layout
3512ea844a1aSMatthew Knepley - field   - the field number
3513ea844a1aSMatthew Knepley 
35142fe279fdSBarry Smith   Output Parameter:
3515ea844a1aSMatthew Knepley . sym - the symmetry describing the affect of orientation on the access of the data
3516ea844a1aSMatthew Knepley 
3517ea844a1aSMatthew Knepley   Level: developer
3518ea844a1aSMatthew Knepley 
3519cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionSetFieldSym()`, `PetscSectionSymCreate()`
3520ea844a1aSMatthew Knepley @*/
3521d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetFieldSym(PetscSection section, PetscInt field, PetscSectionSym *sym)
3522d71ae5a4SJacob Faibussowitsch {
3523ea844a1aSMatthew Knepley   PetscFunctionBegin;
3524ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1);
35252abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field, section->numFields);
3526ea844a1aSMatthew Knepley   *sym = section->field[field]->sym;
35273ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3528ea844a1aSMatthew Knepley }
3529ea844a1aSMatthew Knepley 
3530ea844a1aSMatthew Knepley /*@C
3531cab54364SBarry Smith   PetscSectionGetPointSyms - Get the symmetries for a set of points in a `PetscSection` under specific orientations.
3532ea844a1aSMatthew Knepley 
353340750d41SVaclav Hapla   Not Collective
3534ea844a1aSMatthew Knepley 
3535ea844a1aSMatthew Knepley   Input Parameters:
3536ea844a1aSMatthew Knepley + section   - the section
3537ea844a1aSMatthew Knepley . numPoints - the number of points
353820662ed9SBarry Smith - points    - an array of size 2 * `numPoints`, containing a list of (point, orientation) pairs. (An orientation is an
353920662ed9SBarry Smith               arbitrary integer: its interpretation is up to sym.  Orientations are used by `DM`: for their interpretation in that
354020662ed9SBarry Smith               context, see `DMPlexGetConeOrientation()`).
3541ea844a1aSMatthew Knepley 
3542d8d19677SJose E. Roman   Output Parameters:
354320662ed9SBarry Smith + perms - The permutations for the given orientations (or `NULL` if there is no symmetry or the permutation is the identity).
354420662ed9SBarry Smith - rots  - The field rotations symmetries for the given orientations (or `NULL` if there is no symmetry or the rotations are all
3545ea844a1aSMatthew Knepley     identity).
3546ea844a1aSMatthew Knepley 
3547ea844a1aSMatthew Knepley   Example of usage, gathering dofs into a local array (lArray) from a section array (sArray):
3548ea844a1aSMatthew Knepley .vb
3549ea844a1aSMatthew Knepley      const PetscInt    **perms;
3550ea844a1aSMatthew Knepley      const PetscScalar **rots;
3551ea844a1aSMatthew Knepley      PetscInt            lOffset;
3552ea844a1aSMatthew Knepley 
3553ea844a1aSMatthew Knepley      PetscSectionGetPointSyms(section,numPoints,points,&perms,&rots);
3554ea844a1aSMatthew Knepley      for (i = 0, lOffset = 0; i < numPoints; i++) {
3555ea844a1aSMatthew Knepley        PetscInt           point = points[2*i], dof, sOffset;
3556ea844a1aSMatthew Knepley        const PetscInt    *perm  = perms ? perms[i] : NULL;
3557ea844a1aSMatthew Knepley        const PetscScalar *rot   = rots  ? rots[i]  : NULL;
3558ea844a1aSMatthew Knepley 
3559ea844a1aSMatthew Knepley        PetscSectionGetDof(section,point,&dof);
3560ea844a1aSMatthew Knepley        PetscSectionGetOffset(section,point,&sOffset);
3561ea844a1aSMatthew Knepley 
3562ea844a1aSMatthew Knepley        if (perm) {for (j = 0; j < dof; j++) {lArray[lOffset + perm[j]]  = sArray[sOffset + j];}}
3563ea844a1aSMatthew Knepley        else      {for (j = 0; j < dof; j++) {lArray[lOffset +      j ]  = sArray[sOffset + j];}}
3564ea844a1aSMatthew Knepley        if (rot)  {for (j = 0; j < dof; j++) {lArray[lOffset +      j ] *= rot[j];             }}
3565ea844a1aSMatthew Knepley        lOffset += dof;
3566ea844a1aSMatthew Knepley      }
3567ea844a1aSMatthew Knepley      PetscSectionRestorePointSyms(section,numPoints,points,&perms,&rots);
3568ea844a1aSMatthew Knepley .ve
3569ea844a1aSMatthew Knepley 
3570ea844a1aSMatthew Knepley   Example of usage, adding dofs into a section array (sArray) from a local array (lArray):
3571ea844a1aSMatthew Knepley .vb
3572ea844a1aSMatthew Knepley      const PetscInt    **perms;
3573ea844a1aSMatthew Knepley      const PetscScalar **rots;
3574ea844a1aSMatthew Knepley      PetscInt            lOffset;
3575ea844a1aSMatthew Knepley 
3576ea844a1aSMatthew Knepley      PetscSectionGetPointSyms(section,numPoints,points,&perms,&rots);
3577ea844a1aSMatthew Knepley      for (i = 0, lOffset = 0; i < numPoints; i++) {
3578ea844a1aSMatthew Knepley        PetscInt           point = points[2*i], dof, sOffset;
3579ea844a1aSMatthew Knepley        const PetscInt    *perm  = perms ? perms[i] : NULL;
3580ea844a1aSMatthew Knepley        const PetscScalar *rot   = rots  ? rots[i]  : NULL;
3581ea844a1aSMatthew Knepley 
3582ea844a1aSMatthew Knepley        PetscSectionGetDof(section,point,&dof);
3583ea844a1aSMatthew Knepley        PetscSectionGetOffset(section,point,&sOff);
3584ea844a1aSMatthew Knepley 
3585ea844a1aSMatthew Knepley        if (perm) {for (j = 0; j < dof; j++) {sArray[sOffset + j] += lArray[lOffset + perm[j]] * (rot ? PetscConj(rot[perm[j]]) : 1.);}}
3586ea844a1aSMatthew Knepley        else      {for (j = 0; j < dof; j++) {sArray[sOffset + j] += lArray[lOffset +      j ] * (rot ? PetscConj(rot[     j ]) : 1.);}}
3587ea844a1aSMatthew Knepley        offset += dof;
3588ea844a1aSMatthew Knepley      }
3589ea844a1aSMatthew Knepley      PetscSectionRestorePointSyms(section,numPoints,points,&perms,&rots);
3590ea844a1aSMatthew Knepley .ve
3591ea844a1aSMatthew Knepley 
3592ea844a1aSMatthew Knepley   Level: developer
3593ea844a1aSMatthew Knepley 
3594583308b6SBarry Smith   Notes:
359520662ed9SBarry Smith   `PetscSectionSetSym()` must have been previously called to provide the symmetries to the `PetscSection`
359620662ed9SBarry Smith 
359720662ed9SBarry Smith   Use `PetscSectionRestorePointSyms()` when finished with the data
359820662ed9SBarry Smith 
3599cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionRestorePointSyms()`, `PetscSectionSymCreate()`, `PetscSectionSetSym()`, `PetscSectionGetSym()`
3600ea844a1aSMatthew Knepley @*/
3601d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetPointSyms(PetscSection section, PetscInt numPoints, const PetscInt *points, const PetscInt ***perms, const PetscScalar ***rots)
3602d71ae5a4SJacob Faibussowitsch {
3603ea844a1aSMatthew Knepley   PetscSectionSym sym;
3604ea844a1aSMatthew Knepley 
3605ea844a1aSMatthew Knepley   PetscFunctionBegin;
3606ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1);
36074f572ea9SToby Isaac   if (numPoints) PetscAssertPointer(points, 3);
3608ea844a1aSMatthew Knepley   if (perms) *perms = NULL;
3609ea844a1aSMatthew Knepley   if (rots) *rots = NULL;
3610ea844a1aSMatthew Knepley   sym = section->sym;
3611ea844a1aSMatthew Knepley   if (sym && (perms || rots)) {
3612ea844a1aSMatthew Knepley     SymWorkLink link;
3613ea844a1aSMatthew Knepley 
3614ea844a1aSMatthew Knepley     if (sym->workin) {
3615ea844a1aSMatthew Knepley       link        = sym->workin;
3616ea844a1aSMatthew Knepley       sym->workin = sym->workin->next;
3617ea844a1aSMatthew Knepley     } else {
36184dfa11a4SJacob Faibussowitsch       PetscCall(PetscNew(&link));
3619ea844a1aSMatthew Knepley     }
3620ea844a1aSMatthew Knepley     if (numPoints > link->numPoints) {
36210c99d500SBarry Smith       PetscInt    **perms = (PetscInt **)link->perms;
36220c99d500SBarry Smith       PetscScalar **rots  = (PetscScalar **)link->rots;
36230c99d500SBarry Smith       PetscCall(PetscFree2(perms, rots));
36240c99d500SBarry Smith       PetscCall(PetscMalloc2(numPoints, (PetscInt ***)&link->perms, numPoints, (PetscScalar ***)&link->rots));
3625ea844a1aSMatthew Knepley       link->numPoints = numPoints;
3626ea844a1aSMatthew Knepley     }
3627ea844a1aSMatthew Knepley     link->next   = sym->workout;
3628ea844a1aSMatthew Knepley     sym->workout = link;
36299566063dSJacob Faibussowitsch     PetscCall(PetscArrayzero((PetscInt **)link->perms, numPoints));
36309566063dSJacob Faibussowitsch     PetscCall(PetscArrayzero((PetscInt **)link->rots, numPoints));
36319927e4dfSBarry Smith     PetscUseTypeMethod(sym, getpoints, section, numPoints, points, link->perms, link->rots);
3632ea844a1aSMatthew Knepley     if (perms) *perms = link->perms;
3633ea844a1aSMatthew Knepley     if (rots) *rots = link->rots;
3634ea844a1aSMatthew Knepley   }
36353ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3636ea844a1aSMatthew Knepley }
3637ea844a1aSMatthew Knepley 
3638ea844a1aSMatthew Knepley /*@C
3639cab54364SBarry Smith   PetscSectionRestorePointSyms - Restore the symmetries returned by `PetscSectionGetPointSyms()`
3640ea844a1aSMatthew Knepley 
364140750d41SVaclav Hapla   Not Collective
3642ea844a1aSMatthew Knepley 
3643ea844a1aSMatthew Knepley   Input Parameters:
3644ea844a1aSMatthew Knepley + section   - the section
3645ea844a1aSMatthew Knepley . numPoints - the number of points
364638b5cf2dSJacob Faibussowitsch . points    - an array of size 2 * `numPoints`, containing a list of (point, orientation) pairs. (An orientation is an
3647cab54364SBarry Smith               arbitrary integer: its interpretation is up to sym.  Orientations are used by `DM`: for their interpretation in that
3648cab54364SBarry Smith               context, see `DMPlexGetConeOrientation()`).
364920662ed9SBarry Smith . perms     - The permutations for the given orientations: set to `NULL` at conclusion
365020662ed9SBarry Smith - rots      - The field rotations symmetries for the given orientations: set to `NULL` at conclusion
3651ea844a1aSMatthew Knepley 
3652ea844a1aSMatthew Knepley   Level: developer
3653ea844a1aSMatthew Knepley 
3654cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionGetPointSyms()`, `PetscSectionSymCreate()`, `PetscSectionSetSym()`, `PetscSectionGetSym()`
3655ea844a1aSMatthew Knepley @*/
3656d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionRestorePointSyms(PetscSection section, PetscInt numPoints, const PetscInt *points, const PetscInt ***perms, const PetscScalar ***rots)
3657d71ae5a4SJacob Faibussowitsch {
3658ea844a1aSMatthew Knepley   PetscSectionSym sym;
3659ea844a1aSMatthew Knepley 
3660ea844a1aSMatthew Knepley   PetscFunctionBegin;
3661ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1);
3662ea844a1aSMatthew Knepley   sym = section->sym;
3663ea844a1aSMatthew Knepley   if (sym && (perms || rots)) {
3664ea844a1aSMatthew Knepley     SymWorkLink *p, link;
3665ea844a1aSMatthew Knepley 
3666ea844a1aSMatthew Knepley     for (p = &sym->workout; (link = *p); p = &link->next) {
3667ea844a1aSMatthew Knepley       if ((perms && link->perms == *perms) || (rots && link->rots == *rots)) {
3668ea844a1aSMatthew Knepley         *p          = link->next;
3669ea844a1aSMatthew Knepley         link->next  = sym->workin;
3670ea844a1aSMatthew Knepley         sym->workin = link;
3671ea844a1aSMatthew Knepley         if (perms) *perms = NULL;
3672ea844a1aSMatthew Knepley         if (rots) *rots = NULL;
36733ba16761SJacob Faibussowitsch         PetscFunctionReturn(PETSC_SUCCESS);
3674ea844a1aSMatthew Knepley       }
3675ea844a1aSMatthew Knepley     }
3676ea844a1aSMatthew Knepley     SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "Array was not checked out");
3677ea844a1aSMatthew Knepley   }
36783ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3679ea844a1aSMatthew Knepley }
3680ea844a1aSMatthew Knepley 
3681ea844a1aSMatthew Knepley /*@C
3682cab54364SBarry Smith   PetscSectionGetFieldPointSyms - Get the symmetries for a set of points in a field of a `PetscSection` under specific orientations.
3683ea844a1aSMatthew Knepley 
368440750d41SVaclav Hapla   Not Collective
3685ea844a1aSMatthew Knepley 
3686ea844a1aSMatthew Knepley   Input Parameters:
3687ea844a1aSMatthew Knepley + section   - the section
3688ea844a1aSMatthew Knepley . field     - the field of the section
3689ea844a1aSMatthew Knepley . numPoints - the number of points
369020662ed9SBarry Smith - points    - an array of size 2 * `numPoints`, containing a list of (point, orientation) pairs. (An orientation is an
3691cab54364SBarry Smith     arbitrary integer: its interpretation is up to sym.  Orientations are used by `DM`: for their interpretation in that
3692cab54364SBarry Smith     context, see `DMPlexGetConeOrientation()`).
3693ea844a1aSMatthew Knepley 
3694d8d19677SJose E. Roman   Output Parameters:
369520662ed9SBarry Smith + perms - The permutations for the given orientations (or `NULL` if there is no symmetry or the permutation is the identity).
369620662ed9SBarry Smith - rots  - The field rotations symmetries for the given orientations (or `NULL` if there is no symmetry or the rotations are all
3697ea844a1aSMatthew Knepley     identity).
3698ea844a1aSMatthew Knepley 
3699ea844a1aSMatthew Knepley   Level: developer
3700ea844a1aSMatthew Knepley 
370120662ed9SBarry Smith   Notes:
370220662ed9SBarry Smith   `PetscSectionSetFieldSym()` must have been previously called to provide the symmetries to the `PetscSection`
370320662ed9SBarry Smith 
370420662ed9SBarry Smith   Use `PetscSectionRestoreFieldPointSyms()` when finished with the data
370520662ed9SBarry Smith 
3706cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionGetPointSyms()`, `PetscSectionRestoreFieldPointSyms()`
3707ea844a1aSMatthew Knepley @*/
3708d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetFieldPointSyms(PetscSection section, PetscInt field, PetscInt numPoints, const PetscInt *points, const PetscInt ***perms, const PetscScalar ***rots)
3709d71ae5a4SJacob Faibussowitsch {
3710ea844a1aSMatthew Knepley   PetscFunctionBegin;
3711ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1);
371208401ef6SPierre Jolivet   PetscCheck(field <= section->numFields, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "field %" PetscInt_FMT " greater than number of fields (%" PetscInt_FMT ") in section", field, section->numFields);
37139566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetPointSyms(section->field[field], numPoints, points, perms, rots));
37143ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3715ea844a1aSMatthew Knepley }
3716ea844a1aSMatthew Knepley 
3717ea844a1aSMatthew Knepley /*@C
3718cab54364SBarry Smith   PetscSectionRestoreFieldPointSyms - Restore the symmetries returned by `PetscSectionGetFieldPointSyms()`
3719ea844a1aSMatthew Knepley 
372040750d41SVaclav Hapla   Not Collective
3721ea844a1aSMatthew Knepley 
3722ea844a1aSMatthew Knepley   Input Parameters:
3723ea844a1aSMatthew Knepley + section   - the section
3724ea844a1aSMatthew Knepley . field     - the field number
3725ea844a1aSMatthew Knepley . numPoints - the number of points
372638b5cf2dSJacob Faibussowitsch . points    - an array of size 2 * `numPoints`, containing a list of (point, orientation) pairs. (An orientation is an
3727cab54364SBarry Smith     arbitrary integer: its interpretation is up to sym.  Orientations are used by `DM`: for their interpretation in that
3728cab54364SBarry Smith     context, see `DMPlexGetConeOrientation()`).
372920662ed9SBarry Smith . perms     - The permutations for the given orientations: set to NULL at conclusion
3730ea844a1aSMatthew Knepley - rots      - The field rotations symmetries for the given orientations: set to NULL at conclusion
3731ea844a1aSMatthew Knepley 
3732ea844a1aSMatthew Knepley   Level: developer
3733ea844a1aSMatthew Knepley 
3734cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionRestorePointSyms()`, `petscSectionGetFieldPointSyms()`, `PetscSectionSymCreate()`, `PetscSectionSetSym()`, `PetscSectionGetSym()`
3735ea844a1aSMatthew Knepley @*/
3736d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionRestoreFieldPointSyms(PetscSection section, PetscInt field, PetscInt numPoints, const PetscInt *points, const PetscInt ***perms, const PetscScalar ***rots)
3737d71ae5a4SJacob Faibussowitsch {
3738ea844a1aSMatthew Knepley   PetscFunctionBegin;
3739ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1);
374008401ef6SPierre Jolivet   PetscCheck(field <= section->numFields, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "field %" PetscInt_FMT " greater than number of fields (%" PetscInt_FMT ") in section", field, section->numFields);
37419566063dSJacob Faibussowitsch   PetscCall(PetscSectionRestorePointSyms(section->field[field], numPoints, points, perms, rots));
37423ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3743ea844a1aSMatthew Knepley }
3744ea844a1aSMatthew Knepley 
3745ea844a1aSMatthew Knepley /*@
3746b004864fSMatthew G. Knepley   PetscSectionSymCopy - Copy the symmetries, assuming that the point structure is compatible
3747b004864fSMatthew G. Knepley 
374840750d41SVaclav Hapla   Not Collective
3749b004864fSMatthew G. Knepley 
3750b004864fSMatthew G. Knepley   Input Parameter:
3751cab54364SBarry Smith . sym - the `PetscSectionSym`
3752b004864fSMatthew G. Knepley 
3753b004864fSMatthew G. Knepley   Output Parameter:
3754b004864fSMatthew G. Knepley . nsym - the equivalent symmetries
3755b004864fSMatthew G. Knepley 
3756b004864fSMatthew G. Knepley   Level: developer
3757b004864fSMatthew G. Knepley 
3758cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionSymCreate()`, `PetscSectionSetSym()`, `PetscSectionGetSym()`, `PetscSectionSymLabelSetStratum()`, `PetscSectionGetPointSyms()`
3759b004864fSMatthew G. Knepley @*/
3760d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSymCopy(PetscSectionSym sym, PetscSectionSym nsym)
3761d71ae5a4SJacob Faibussowitsch {
3762b004864fSMatthew G. Knepley   PetscFunctionBegin;
3763b004864fSMatthew G. Knepley   PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID, 1);
3764b004864fSMatthew G. Knepley   PetscValidHeaderSpecific(nsym, PETSC_SECTION_SYM_CLASSID, 2);
3765dbbe0bcdSBarry Smith   PetscTryTypeMethod(sym, copy, nsym);
37663ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3767b004864fSMatthew G. Knepley }
3768b004864fSMatthew G. Knepley 
3769b004864fSMatthew G. Knepley /*@
3770cab54364SBarry Smith   PetscSectionSymDistribute - Distribute the symmetries in accordance with the input `PetscSF`
3771b004864fSMatthew G. Knepley 
3772b004864fSMatthew G. Knepley   Collective
3773b004864fSMatthew G. Knepley 
3774b004864fSMatthew G. Knepley   Input Parameters:
3775cab54364SBarry Smith + sym         - the `PetscSectionSym`
3776b004864fSMatthew G. Knepley - migrationSF - the distribution map from roots to leaves
3777b004864fSMatthew G. Knepley 
37782fe279fdSBarry Smith   Output Parameter:
3779b004864fSMatthew G. Knepley . dsym - the redistributed symmetries
3780b004864fSMatthew G. Knepley 
3781b004864fSMatthew G. Knepley   Level: developer
3782b004864fSMatthew G. Knepley 
3783cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionSymCreate()`, `PetscSectionSetSym()`, `PetscSectionGetSym()`, `PetscSectionSymLabelSetStratum()`, `PetscSectionGetPointSyms()`
3784b004864fSMatthew G. Knepley @*/
3785d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSymDistribute(PetscSectionSym sym, PetscSF migrationSF, PetscSectionSym *dsym)
3786d71ae5a4SJacob Faibussowitsch {
3787b004864fSMatthew G. Knepley   PetscFunctionBegin;
3788b004864fSMatthew G. Knepley   PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID, 1);
3789b004864fSMatthew G. Knepley   PetscValidHeaderSpecific(migrationSF, PETSCSF_CLASSID, 2);
37904f572ea9SToby Isaac   PetscAssertPointer(dsym, 3);
3791dbbe0bcdSBarry Smith   PetscTryTypeMethod(sym, distribute, migrationSF, dsym);
37923ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3793b004864fSMatthew G. Knepley }
3794b004864fSMatthew G. Knepley 
3795b004864fSMatthew G. Knepley /*@
379620662ed9SBarry Smith   PetscSectionGetUseFieldOffsets - Get the flag indicating if field offsets are used directly in a global section, rather than just the point offset
3797ea844a1aSMatthew Knepley 
379840750d41SVaclav Hapla   Not Collective
3799ea844a1aSMatthew Knepley 
3800ea844a1aSMatthew Knepley   Input Parameter:
3801cab54364SBarry Smith . s - the global `PetscSection`
3802ea844a1aSMatthew Knepley 
38032fe279fdSBarry Smith   Output Parameter:
3804ea844a1aSMatthew Knepley . flg - the flag
3805ea844a1aSMatthew Knepley 
3806ea844a1aSMatthew Knepley   Level: developer
3807ea844a1aSMatthew Knepley 
3808cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionSetChart()`, `PetscSectionCreate()`
3809ea844a1aSMatthew Knepley @*/
3810d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetUseFieldOffsets(PetscSection s, PetscBool *flg)
3811d71ae5a4SJacob Faibussowitsch {
3812ea844a1aSMatthew Knepley   PetscFunctionBegin;
3813ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
3814ea844a1aSMatthew Knepley   *flg = s->useFieldOff;
38153ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3816ea844a1aSMatthew Knepley }
3817ea844a1aSMatthew Knepley 
3818ea844a1aSMatthew Knepley /*@
3819ea844a1aSMatthew Knepley   PetscSectionSetUseFieldOffsets - Set the flag to use field offsets directly in a global section, rather than just the point offset
3820ea844a1aSMatthew Knepley 
382140750d41SVaclav Hapla   Not Collective
3822ea844a1aSMatthew Knepley 
3823ea844a1aSMatthew Knepley   Input Parameters:
3824cab54364SBarry Smith + s   - the global `PetscSection`
3825ea844a1aSMatthew Knepley - flg - the flag
3826ea844a1aSMatthew Knepley 
3827ea844a1aSMatthew Knepley   Level: developer
3828ea844a1aSMatthew Knepley 
3829cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionGetUseFieldOffsets()`, `PetscSectionSetChart()`, `PetscSectionCreate()`
3830ea844a1aSMatthew Knepley @*/
3831d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetUseFieldOffsets(PetscSection s, PetscBool flg)
3832d71ae5a4SJacob Faibussowitsch {
3833ea844a1aSMatthew Knepley   PetscFunctionBegin;
3834ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
3835ea844a1aSMatthew Knepley   s->useFieldOff = flg;
38363ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3837ea844a1aSMatthew Knepley }
3838ea844a1aSMatthew Knepley 
3839ea844a1aSMatthew Knepley #define PetscSectionExpandPoints_Loop(TYPE) \
3840a8f51744SPierre Jolivet   do { \
3841ea844a1aSMatthew Knepley     PetscInt i, n, o0, o1, size; \
3842ea844a1aSMatthew Knepley     TYPE    *a0 = (TYPE *)origArray, *a1; \
38439566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetStorageSize(s, &size)); \
38449566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(size, &a1)); \
3845ea844a1aSMatthew Knepley     for (i = 0; i < npoints; i++) { \
38469566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetOffset(origSection, points_[i], &o0)); \
38479566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetOffset(s, i, &o1)); \
38489566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(s, i, &n)); \
38499566063dSJacob Faibussowitsch       PetscCall(PetscMemcpy(&a1[o1], &a0[o0], n *unitsize)); \
3850ea844a1aSMatthew Knepley     } \
3851ea844a1aSMatthew Knepley     *newArray = (void *)a1; \
3852a8f51744SPierre Jolivet   } while (0)
3853ea844a1aSMatthew Knepley 
3854ea844a1aSMatthew Knepley /*@
3855ea844a1aSMatthew Knepley   PetscSectionExtractDofsFromArray - Extracts elements of an array corresponding to DOFs of specified points.
3856ea844a1aSMatthew Knepley 
385740750d41SVaclav Hapla   Not Collective
3858ea844a1aSMatthew Knepley 
3859ea844a1aSMatthew Knepley   Input Parameters:
3860cab54364SBarry Smith + origSection - the `PetscSection` describing the layout of the array
3861cab54364SBarry Smith . dataType    - `MPI_Datatype` describing the data type of the array (currently only `MPIU_INT`, `MPIU_SCALAR`, `MPIU_REAL`)
386220662ed9SBarry Smith . origArray   - the array; its size must be equal to the storage size of `origSection`
386320662ed9SBarry Smith - points      - `IS` with points to extract; its indices must lie in the chart of `origSection`
3864ea844a1aSMatthew Knepley 
3865ea844a1aSMatthew Knepley   Output Parameters:
3866da81f932SPierre Jolivet + newSection - the new `PetscSection` describing the layout of the new array (with points renumbered 0,1,... but preserving numbers of DOFs)
386720662ed9SBarry Smith - newArray   - the array of the extracted DOFs; its size is the storage size of `newSection`
3868ea844a1aSMatthew Knepley 
3869ea844a1aSMatthew Knepley   Level: developer
3870ea844a1aSMatthew Knepley 
3871cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionGetChart()`, `PetscSectionGetDof()`, `PetscSectionGetStorageSize()`, `PetscSectionCreate()`
3872ea844a1aSMatthew Knepley @*/
3873d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionExtractDofsFromArray(PetscSection origSection, MPI_Datatype dataType, const void *origArray, IS points, PetscSection *newSection, void *newArray[])
3874d71ae5a4SJacob Faibussowitsch {
3875ea844a1aSMatthew Knepley   PetscSection    s;
3876ea844a1aSMatthew Knepley   const PetscInt *points_;
3877ea844a1aSMatthew Knepley   PetscInt        i, n, npoints, pStart, pEnd;
3878ea844a1aSMatthew Knepley   PetscMPIInt     unitsize;
3879ea844a1aSMatthew Knepley 
3880ea844a1aSMatthew Knepley   PetscFunctionBegin;
3881ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(origSection, PETSC_SECTION_CLASSID, 1);
38824f572ea9SToby Isaac   PetscAssertPointer(origArray, 3);
3883ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(points, IS_CLASSID, 4);
38844f572ea9SToby Isaac   if (newSection) PetscAssertPointer(newSection, 5);
38854f572ea9SToby Isaac   if (newArray) PetscAssertPointer(newArray, 6);
38869566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Type_size(dataType, &unitsize));
38879566063dSJacob Faibussowitsch   PetscCall(ISGetLocalSize(points, &npoints));
38889566063dSJacob Faibussowitsch   PetscCall(ISGetIndices(points, &points_));
38899566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(origSection, &pStart, &pEnd));
38909566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PETSC_COMM_SELF, &s));
38919566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(s, 0, npoints));
3892ea844a1aSMatthew Knepley   for (i = 0; i < npoints; i++) {
3893c9cc58a2SBarry Smith     PetscCheck(points_[i] >= pStart && points_[i] < pEnd, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "point %" PetscInt_FMT " (index %" PetscInt_FMT ") in input IS out of input section's chart", points_[i], i);
38949566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(origSection, points_[i], &n));
38959566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(s, i, n));
3896ea844a1aSMatthew Knepley   }
38979566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(s));
3898ea844a1aSMatthew Knepley   if (newArray) {
38999371c9d4SSatish Balay     if (dataType == MPIU_INT) {
39009371c9d4SSatish Balay       PetscSectionExpandPoints_Loop(PetscInt);
39019371c9d4SSatish Balay     } else if (dataType == MPIU_SCALAR) {
39029371c9d4SSatish Balay       PetscSectionExpandPoints_Loop(PetscScalar);
39039371c9d4SSatish Balay     } else if (dataType == MPIU_REAL) {
39049371c9d4SSatish Balay       PetscSectionExpandPoints_Loop(PetscReal);
39059371c9d4SSatish Balay     } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP, "not implemented for this MPI_Datatype");
3906ea844a1aSMatthew Knepley   }
3907ea844a1aSMatthew Knepley   if (newSection) {
3908ea844a1aSMatthew Knepley     *newSection = s;
3909ea844a1aSMatthew Knepley   } else {
39109566063dSJacob Faibussowitsch     PetscCall(PetscSectionDestroy(&s));
3911ea844a1aSMatthew Knepley   }
39129566063dSJacob Faibussowitsch   PetscCall(ISRestoreIndices(points, &points_));
39133ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3914ea844a1aSMatthew Knepley }
3915