xref: /petsc/src/vec/is/section/interface/section.c (revision 1690c2ae071c7584458d4e437df7b47bc4686b3c)
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 {
1292357d8704SBarry Smith   PetscInt        f;
1293ea844a1aSMatthew Knepley   const PetscInt *pind   = NULL;
12946497c311SBarry Smith   PetscCount      offset = 0;
1295ea844a1aSMatthew Knepley 
1296ea844a1aSMatthew Knepley   PetscFunctionBegin;
1297ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
12983ba16761SJacob Faibussowitsch   if (s->setup) PetscFunctionReturn(PETSC_SUCCESS);
1299ea844a1aSMatthew Knepley   s->setup = PETSC_TRUE;
1300ea844a1aSMatthew Knepley   /* Set offsets and field offsets for all points */
1301ea844a1aSMatthew Knepley   /*   Assume that all fields have the same chart */
130228b400f6SJacob Faibussowitsch   PetscCheck(s->includesConstraints, PETSC_COMM_SELF, PETSC_ERR_SUP, "PetscSectionSetUp is currently unsupported for includesConstraints = PETSC_TRUE");
13039566063dSJacob Faibussowitsch   if (s->perm) PetscCall(ISGetIndices(s->perm, &pind));
1304ea844a1aSMatthew Knepley   if (s->pointMajor) {
13056497c311SBarry Smith     PetscCount foff;
1306357d8704SBarry Smith     for (PetscInt p = 0; p < s->pEnd - s->pStart; ++p) {
1307ea844a1aSMatthew Knepley       const PetscInt q = pind ? pind[p] : p;
1308ea844a1aSMatthew Knepley 
1309ea844a1aSMatthew Knepley       /* Set point offset */
1310357d8704SBarry Smith       PetscCall(PetscIntCast(offset, &s->atlasOff[q]));
1311ea844a1aSMatthew Knepley       offset += s->atlasDof[q];
1312ea844a1aSMatthew Knepley       /* Set field offset */
1313ea844a1aSMatthew Knepley       for (f = 0, foff = s->atlasOff[q]; f < s->numFields; ++f) {
1314ea844a1aSMatthew Knepley         PetscSection sf = s->field[f];
1315ea844a1aSMatthew Knepley 
1316357d8704SBarry Smith         PetscCall(PetscIntCast(foff, &sf->atlasOff[q]));
1317ea844a1aSMatthew Knepley         foff += sf->atlasDof[q];
1318ea844a1aSMatthew Knepley       }
1319ea844a1aSMatthew Knepley     }
1320ea844a1aSMatthew Knepley   } else {
1321ea844a1aSMatthew Knepley     /* Set field offsets for all points */
1322ea844a1aSMatthew Knepley     for (f = 0; f < s->numFields; ++f) {
1323ea844a1aSMatthew Knepley       PetscSection sf = s->field[f];
1324ea844a1aSMatthew Knepley 
1325357d8704SBarry Smith       for (PetscInt p = 0; p < s->pEnd - s->pStart; ++p) {
1326ea844a1aSMatthew Knepley         const PetscInt q = pind ? pind[p] : p;
1327ea844a1aSMatthew Knepley 
1328357d8704SBarry Smith         PetscCall(PetscIntCast(offset, &sf->atlasOff[q]));
1329ea844a1aSMatthew Knepley         offset += sf->atlasDof[q];
1330ea844a1aSMatthew Knepley       }
1331ea844a1aSMatthew Knepley     }
1332ea844a1aSMatthew Knepley     /* Disable point offsets since these are unused */
1333357d8704SBarry Smith     for (PetscInt p = 0; p < s->pEnd - s->pStart; ++p) s->atlasOff[p] = -1;
1334ea844a1aSMatthew Knepley   }
13359566063dSJacob Faibussowitsch   if (s->perm) PetscCall(ISRestoreIndices(s->perm, &pind));
1336ea844a1aSMatthew Knepley   /* Setup BC sections */
13379566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUpBC(s));
13389566063dSJacob Faibussowitsch   for (f = 0; f < s->numFields; ++f) PetscCall(PetscSectionSetUpBC(s->field[f]));
13393ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1340ea844a1aSMatthew Knepley }
1341ea844a1aSMatthew Knepley 
1342ea844a1aSMatthew Knepley /*@
134320662ed9SBarry Smith   PetscSectionGetMaxDof - Return the maximum number of degrees of freedom on any point in the `PetscSection`
1344ea844a1aSMatthew Knepley 
134540750d41SVaclav Hapla   Not Collective
1346ea844a1aSMatthew Knepley 
13472fe279fdSBarry Smith   Input Parameter:
1348cab54364SBarry Smith . s - the `PetscSection`
1349ea844a1aSMatthew Knepley 
1350ea844a1aSMatthew Knepley   Output Parameter:
1351ea844a1aSMatthew Knepley . maxDof - the maximum dof
1352ea844a1aSMatthew Knepley 
1353ea844a1aSMatthew Knepley   Level: intermediate
1354ea844a1aSMatthew Knepley 
1355583308b6SBarry Smith   Notes:
1356cab54364SBarry Smith   The returned number is up-to-date without need for `PetscSectionSetUp()`.
135769c11d05SVaclav Hapla 
1358583308b6SBarry 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
1359583308b6SBarry Smith   the maximum over all points of the value returned by `PetscSectionGetDof()` on this MPI process
1360583308b6SBarry Smith 
1361583308b6SBarry Smith   Developer Notes:
136269c11d05SVaclav Hapla   The returned number is calculated lazily and stashed.
1363cab54364SBarry Smith 
1364cab54364SBarry Smith   A call to `PetscSectionInvalidateMaxDof_Internal()` invalidates the stashed value.
1365cab54364SBarry Smith 
1366cab54364SBarry Smith   `PetscSectionInvalidateMaxDof_Internal()` is called in `PetscSectionSetDof()`, `PetscSectionAddDof()` and `PetscSectionReset()`
1367cab54364SBarry Smith 
136820662ed9SBarry Smith   It should also be called every time `atlasDof` is modified directly.
136969c11d05SVaclav Hapla 
1370cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetDof()`, `PetscSectionSetDof()`, `PetscSectionAddDof()`, `PetscSectionCreate()`
1371ea844a1aSMatthew Knepley @*/
1372d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetMaxDof(PetscSection s, PetscInt *maxDof)
1373d71ae5a4SJacob Faibussowitsch {
137469c11d05SVaclav Hapla   PetscInt p;
137569c11d05SVaclav Hapla 
1376ea844a1aSMatthew Knepley   PetscFunctionBegin;
1377ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
13784f572ea9SToby Isaac   PetscAssertPointer(maxDof, 2);
1379*1690c2aeSBarry Smith   if (s->maxDof == PETSC_INT_MIN) {
138069c11d05SVaclav Hapla     s->maxDof = 0;
1381ad540459SPierre Jolivet     for (p = 0; p < s->pEnd - s->pStart; ++p) s->maxDof = PetscMax(s->maxDof, s->atlasDof[p]);
138269c11d05SVaclav Hapla   }
1383ea844a1aSMatthew Knepley   *maxDof = s->maxDof;
13843ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1385ea844a1aSMatthew Knepley }
1386ea844a1aSMatthew Knepley 
1387ea844a1aSMatthew Knepley /*@
138820662ed9SBarry Smith   PetscSectionGetStorageSize - Return the size of an array or local `Vec` capable of holding all the degrees of freedom defined in a `PetscSection`
1389ea844a1aSMatthew Knepley 
139040750d41SVaclav Hapla   Not Collective
1391ea844a1aSMatthew Knepley 
1392ea844a1aSMatthew Knepley   Input Parameter:
1393cab54364SBarry Smith . s - the `PetscSection`
1394ea844a1aSMatthew Knepley 
1395ea844a1aSMatthew Knepley   Output Parameter:
1396ea844a1aSMatthew Knepley . size - the size of an array which can hold all the dofs
1397ea844a1aSMatthew Knepley 
1398ea844a1aSMatthew Knepley   Level: intermediate
1399ea844a1aSMatthew Knepley 
1400cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetOffset()`, `PetscSectionGetConstrainedStorageSize()`, `PetscSectionCreate()`
1401ea844a1aSMatthew Knepley @*/
1402d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetStorageSize(PetscSection s, PetscInt *size)
1403d71ae5a4SJacob Faibussowitsch {
1404357d8704SBarry Smith   PetscInt64 n = 0;
1405ea844a1aSMatthew Knepley 
1406ea844a1aSMatthew Knepley   PetscFunctionBegin;
1407ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
14084f572ea9SToby Isaac   PetscAssertPointer(size, 2);
1409357d8704SBarry Smith   for (PetscInt p = 0; p < s->pEnd - s->pStart; ++p) n += s->atlasDof[p] > 0 ? s->atlasDof[p] : 0;
1410357d8704SBarry Smith   PetscCall(PetscIntCast(n, size));
14113ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1412ea844a1aSMatthew Knepley }
1413ea844a1aSMatthew Knepley 
1414ea844a1aSMatthew Knepley /*@
141520662ed9SBarry Smith   PetscSectionGetConstrainedStorageSize - Return the size of an array or local `Vec` capable of holding all unconstrained degrees of freedom in a `PetscSection`
1416ea844a1aSMatthew Knepley 
141740750d41SVaclav Hapla   Not Collective
1418ea844a1aSMatthew Knepley 
1419064ec1f3Sprj-   Input Parameter:
1420cab54364SBarry Smith . s - the `PetscSection`
1421ea844a1aSMatthew Knepley 
1422ea844a1aSMatthew Knepley   Output Parameter:
1423ea844a1aSMatthew Knepley . size - the size of an array which can hold all unconstrained dofs
1424ea844a1aSMatthew Knepley 
1425ea844a1aSMatthew Knepley   Level: intermediate
1426ea844a1aSMatthew Knepley 
1427cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetStorageSize()`, `PetscSectionGetOffset()`, `PetscSectionCreate()`
1428ea844a1aSMatthew Knepley @*/
1429d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetConstrainedStorageSize(PetscSection s, PetscInt *size)
1430d71ae5a4SJacob Faibussowitsch {
1431357d8704SBarry Smith   PetscInt64 n = 0;
1432ea844a1aSMatthew Knepley 
1433ea844a1aSMatthew Knepley   PetscFunctionBegin;
1434ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
14354f572ea9SToby Isaac   PetscAssertPointer(size, 2);
1436357d8704SBarry Smith   for (PetscInt p = 0; p < s->pEnd - s->pStart; ++p) {
1437ea844a1aSMatthew Knepley     const PetscInt cdof = s->bc ? s->bc->atlasDof[p] : 0;
1438ea844a1aSMatthew Knepley     n += s->atlasDof[p] > 0 ? s->atlasDof[p] - cdof : 0;
1439ea844a1aSMatthew Knepley   }
1440357d8704SBarry Smith   PetscCall(PetscIntCast(n, size));
14413ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1442ea844a1aSMatthew Knepley }
1443ea844a1aSMatthew Knepley 
1444ea844a1aSMatthew Knepley /*@
1445583308b6SBarry Smith   PetscSectionCreateGlobalSection - Create a parallel section describing the global layout using
1446583308b6SBarry Smith   a local (sequential) `PetscSection` on each MPI process and a `PetscSF` describing the section point overlap.
1447ea844a1aSMatthew Knepley 
1448ea844a1aSMatthew Knepley   Input Parameters:
1449cab54364SBarry Smith + s                  - The `PetscSection` for the local field layout
1450cab54364SBarry Smith . sf                 - The `PetscSF` describing parallel layout of the section points (leaves are unowned local points)
1451eb9d3e4dSMatthew G. Knepley . usePermutation     - By default this is `PETSC_TRUE`, meaning any permutation of the local section is transferred to the global section
1452cab54364SBarry Smith . includeConstraints - By default this is `PETSC_FALSE`, meaning that the global field vector will not possess constrained dofs
1453cab54364SBarry Smith - localOffsets       - If `PETSC_TRUE`, use local rather than global offsets for the points
1454ea844a1aSMatthew Knepley 
1455ea844a1aSMatthew Knepley   Output Parameter:
1456cab54364SBarry Smith . gsection - The `PetscSection` for the global field layout
1457ea844a1aSMatthew Knepley 
1458ea844a1aSMatthew Knepley   Level: intermediate
1459ea844a1aSMatthew Knepley 
1460db527f05SMatthew G. Knepley   Notes:
1461583308b6SBarry Smith   On each MPI process `gsection` inherits the chart of the `s` on that process.
1462db527f05SMatthew G. Knepley 
1463583308b6SBarry 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`.
1464583308b6SBarry Smith   In those locations the value of size is -(size+1) and the value of the offset on the remote process is -(off+1).
1465cab54364SBarry Smith 
146620662ed9SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreate()`, `PetscSectionCreateGlobalSectionCensored()`
1467ea844a1aSMatthew Knepley @*/
1468eb9d3e4dSMatthew G. Knepley PetscErrorCode PetscSectionCreateGlobalSection(PetscSection s, PetscSF sf, PetscBool usePermutation, PetscBool includeConstraints, PetscBool localOffsets, PetscSection *gsection)
1469d71ae5a4SJacob Faibussowitsch {
1470ea844a1aSMatthew Knepley   PetscSection    gs;
1471ea844a1aSMatthew Knepley   const PetscInt *pind = NULL;
1472ea844a1aSMatthew Knepley   PetscInt       *recv = NULL, *neg = NULL;
1473357d8704SBarry Smith   PetscInt        pStart, pEnd, p, dof, cdof, off, globalOff = 0, nroots, nlocal, maxleaf;
1474046d2115Sksagiyam   PetscInt        numFields, f, numComponents;
14756497c311SBarry Smith   PetscCount      foff;
1476ea844a1aSMatthew Knepley 
1477ea844a1aSMatthew Knepley   PetscFunctionBegin;
1478ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1479ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
1480eb9d3e4dSMatthew G. Knepley   PetscValidLogicalCollectiveBool(s, usePermutation, 3);
1481eb9d3e4dSMatthew G. Knepley   PetscValidLogicalCollectiveBool(s, includeConstraints, 4);
1482eb9d3e4dSMatthew G. Knepley   PetscValidLogicalCollectiveBool(s, localOffsets, 5);
1483eb9d3e4dSMatthew G. Knepley   PetscAssertPointer(gsection, 6);
148428b400f6SJacob Faibussowitsch   PetscCheck(s->pointMajor, PETSC_COMM_SELF, PETSC_ERR_SUP, "No support for field major ordering");
14859566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject)s), &gs));
14869566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetNumFields(s, &numFields));
14879566063dSJacob Faibussowitsch   if (numFields > 0) PetscCall(PetscSectionSetNumFields(gs, numFields));
14889566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
14899566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(gs, pStart, pEnd));
149087e637c6Sksagiyam   gs->includesConstraints = includeConstraints;
14919566063dSJacob Faibussowitsch   PetscCall(PetscSFGetGraph(sf, &nroots, NULL, NULL, NULL));
1492ea844a1aSMatthew Knepley   nlocal = nroots; /* The local/leaf space matches global/root space */
1493ea844a1aSMatthew Knepley   /* Must allocate for all points visible to SF, which may be more than this section */
1494ea844a1aSMatthew Knepley   if (nroots >= 0) { /* nroots < 0 means that the graph has not been set, only happens in serial */
14959566063dSJacob Faibussowitsch     PetscCall(PetscSFGetLeafRange(sf, NULL, &maxleaf));
149608401ef6SPierre Jolivet     PetscCheck(nroots >= pEnd, PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "SF roots %" PetscInt_FMT " < pEnd %" PetscInt_FMT, nroots, pEnd);
149708401ef6SPierre Jolivet     PetscCheck(maxleaf < nroots, PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "Max local leaf %" PetscInt_FMT " >= nroots %" PetscInt_FMT, maxleaf, nroots);
14989566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nroots, &neg, nlocal, &recv));
14999566063dSJacob Faibussowitsch     PetscCall(PetscArrayzero(neg, nroots));
1500ea844a1aSMatthew Knepley   }
1501ea844a1aSMatthew Knepley   /* Mark all local points with negative dof */
1502ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
15039566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s, p, &dof));
15049566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(gs, p, dof));
15059566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s, p, &cdof));
15069566063dSJacob Faibussowitsch     if (!includeConstraints && cdof > 0) PetscCall(PetscSectionSetConstraintDof(gs, p, cdof));
1507ea844a1aSMatthew Knepley     if (neg) neg[p] = -(dof + 1);
1508ea844a1aSMatthew Knepley   }
15099566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUpBC(gs));
15109566063dSJacob 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]));
1511ea844a1aSMatthew Knepley   if (nroots >= 0) {
15129566063dSJacob Faibussowitsch     PetscCall(PetscArrayzero(recv, nlocal));
15139566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastBegin(sf, MPIU_INT, neg, recv, MPI_REPLACE));
15149566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastEnd(sf, MPIU_INT, neg, recv, MPI_REPLACE));
1515ea844a1aSMatthew Knepley     for (p = pStart; p < pEnd; ++p) {
1516ea844a1aSMatthew Knepley       if (recv[p] < 0) {
1517ea844a1aSMatthew Knepley         gs->atlasDof[p - pStart] = recv[p];
15189566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetDof(s, p, &dof));
151908401ef6SPierre 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);
1520ea844a1aSMatthew Knepley       }
1521ea844a1aSMatthew Knepley     }
1522ea844a1aSMatthew Knepley   }
1523ea844a1aSMatthew Knepley   /* Calculate new sizes, get process offset, and calculate point offsets */
1524eb9d3e4dSMatthew G. Knepley   if (usePermutation && s->perm) PetscCall(ISGetIndices(s->perm, &pind));
1525ea844a1aSMatthew Knepley   for (p = 0, off = 0; p < pEnd - pStart; ++p) {
1526ea844a1aSMatthew Knepley     const PetscInt q = pind ? pind[p] : p;
1527ea844a1aSMatthew Knepley 
1528ea844a1aSMatthew Knepley     cdof            = (!includeConstraints && s->bc) ? s->bc->atlasDof[q] : 0;
1529ea844a1aSMatthew Knepley     gs->atlasOff[q] = off;
1530ea844a1aSMatthew Knepley     off += gs->atlasDof[q] > 0 ? gs->atlasDof[q] - cdof : 0;
1531ea844a1aSMatthew Knepley   }
1532ea844a1aSMatthew Knepley   if (!localOffsets) {
15339566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Scan(&off, &globalOff, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject)s)));
1534ea844a1aSMatthew Knepley     globalOff -= off;
1535ea844a1aSMatthew Knepley   }
1536ea844a1aSMatthew Knepley   for (p = pStart, off = 0; p < pEnd; ++p) {
1537ea844a1aSMatthew Knepley     gs->atlasOff[p - pStart] += globalOff;
1538ea844a1aSMatthew Knepley     if (neg) neg[p] = -(gs->atlasOff[p - pStart] + 1);
1539ea844a1aSMatthew Knepley   }
1540eb9d3e4dSMatthew G. Knepley   if (usePermutation && s->perm) PetscCall(ISRestoreIndices(s->perm, &pind));
1541ea844a1aSMatthew Knepley   /* Put in negative offsets for ghost points */
1542ea844a1aSMatthew Knepley   if (nroots >= 0) {
15439566063dSJacob Faibussowitsch     PetscCall(PetscArrayzero(recv, nlocal));
15449566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastBegin(sf, MPIU_INT, neg, recv, MPI_REPLACE));
15459566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastEnd(sf, MPIU_INT, neg, recv, MPI_REPLACE));
1546ea844a1aSMatthew Knepley     for (p = pStart; p < pEnd; ++p) {
1547ea844a1aSMatthew Knepley       if (recv[p] < 0) gs->atlasOff[p - pStart] = recv[p];
1548ea844a1aSMatthew Knepley     }
1549ea844a1aSMatthew Knepley   }
15509566063dSJacob Faibussowitsch   PetscCall(PetscFree2(neg, recv));
1551046d2115Sksagiyam   /* Set field dofs/offsets/constraints */
1552046d2115Sksagiyam   for (f = 0; f < numFields; ++f) {
15534cd8913cSStefano Zampini     const char *name;
15544cd8913cSStefano Zampini 
1555046d2115Sksagiyam     gs->field[f]->includesConstraints = includeConstraints;
15569566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldComponents(s, f, &numComponents));
15579566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldComponents(gs, f, numComponents));
15584cd8913cSStefano Zampini     PetscCall(PetscSectionGetFieldName(s, f, &name));
15594cd8913cSStefano Zampini     PetscCall(PetscSectionSetFieldName(gs, f, name));
1560046d2115Sksagiyam   }
1561046d2115Sksagiyam   for (p = pStart; p < pEnd; ++p) {
15629566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(gs, p, &off));
1563046d2115Sksagiyam     for (f = 0, foff = off; f < numFields; ++f) {
15649566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintDof(s, p, f, &cdof));
15659566063dSJacob Faibussowitsch       if (!includeConstraints && cdof > 0) PetscCall(PetscSectionSetFieldConstraintDof(gs, p, f, cdof));
15669566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldDof(s, p, f, &dof));
15679566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldDof(gs, p, f, off < 0 ? -(dof + 1) : dof));
15686497c311SBarry Smith       PetscCall(PetscSectionSetFieldOffset(gs, p, f, (PetscInt)foff));
15699566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintDof(gs, p, f, &cdof));
1570046d2115Sksagiyam       foff = off < 0 ? foff - (dof - cdof) : foff + (dof - cdof);
1571357d8704SBarry Smith       PetscCheck(foff < PETSC_INT_MAX, PETSC_COMM_SELF, PETSC_ERR_INT_OVERFLOW, "Offsets too large for 32 bit indices");
1572046d2115Sksagiyam     }
1573046d2115Sksagiyam   }
1574046d2115Sksagiyam   for (f = 0; f < numFields; ++f) {
1575046d2115Sksagiyam     PetscSection gfs = gs->field[f];
1576046d2115Sksagiyam 
15779566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetUpBC(gfs));
15789566063dSJacob 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]));
1579046d2115Sksagiyam   }
1580046d2115Sksagiyam   gs->setup = PETSC_TRUE;
15819566063dSJacob Faibussowitsch   PetscCall(PetscSectionViewFromOptions(gs, NULL, "-global_section_view"));
1582ea844a1aSMatthew Knepley   *gsection = gs;
15833ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1584ea844a1aSMatthew Knepley }
1585ea844a1aSMatthew Knepley 
1586ea844a1aSMatthew Knepley /*@
1587583308b6SBarry Smith   PetscSectionCreateGlobalSectionCensored - Create a `PetscSection` describing the globallayout using
1588583308b6SBarry Smith   a local (sequential) `PetscSection` on each MPI process and an `PetscSF` describing the section point overlap.
1589ea844a1aSMatthew Knepley 
1590ea844a1aSMatthew Knepley   Input Parameters:
1591cab54364SBarry Smith + s                  - The `PetscSection` for the local field layout
1592cab54364SBarry Smith . sf                 - The `PetscSF` describing parallel layout of the section points
1593583308b6SBarry Smith . includeConstraints - By default this is `PETSC_FALSE`, meaning that the global vector will not possess constrained dofs
1594583308b6SBarry Smith . numExcludes        - The number of exclusion ranges, this must have the same value on all MPI processes
1595583308b6SBarry 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
1596ea844a1aSMatthew Knepley 
1597ea844a1aSMatthew Knepley   Output Parameter:
1598cab54364SBarry Smith . gsection - The `PetscSection` for the global field layout
1599ea844a1aSMatthew Knepley 
1600ea844a1aSMatthew Knepley   Level: advanced
1601ea844a1aSMatthew Knepley 
1602583308b6SBarry Smith   Notes:
1603583308b6SBarry Smith   On each MPI process `gsection` inherits the chart of the `s` on that process.
160420662ed9SBarry Smith 
1605583308b6SBarry 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`.
1606583308b6SBarry Smith   In those locations the value of size is -(size+1) and the value of the offset on the remote process is -(off+1).
1607583308b6SBarry Smith 
1608583308b6SBarry Smith   This routine augments `PetscSectionCreateGlobalSection()` by allowing one to exclude certain ranges in the chart of the `PetscSection`
1609cab54364SBarry Smith 
161038b5cf2dSJacob Faibussowitsch   Developer Notes:
161120662ed9SBarry Smith   This is a terrible function name
161220662ed9SBarry Smith 
161342747ad1SJacob Faibussowitsch .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreate()`
1614ea844a1aSMatthew Knepley @*/
1615d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionCreateGlobalSectionCensored(PetscSection s, PetscSF sf, PetscBool includeConstraints, PetscInt numExcludes, const PetscInt excludes[], PetscSection *gsection)
1616d71ae5a4SJacob Faibussowitsch {
1617ea844a1aSMatthew Knepley   const PetscInt *pind = NULL;
1618ea844a1aSMatthew Knepley   PetscInt       *neg = NULL, *tmpOff = NULL;
1619357d8704SBarry Smith   PetscInt        pStart, pEnd, p, e, dof, cdof, globalOff = 0, nroots;
16206497c311SBarry Smith   PetscCount      off;
1621ea844a1aSMatthew Knepley 
1622ea844a1aSMatthew Knepley   PetscFunctionBegin;
1623ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1624ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
16254f572ea9SToby Isaac   PetscAssertPointer(gsection, 6);
16269566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject)s), gsection));
16279566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
16289566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(*gsection, pStart, pEnd));
16299566063dSJacob Faibussowitsch   PetscCall(PetscSFGetGraph(sf, &nroots, NULL, NULL, NULL));
1630ea844a1aSMatthew Knepley   if (nroots >= 0) {
163108401ef6SPierre Jolivet     PetscCheck(nroots >= pEnd - pStart, PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "PetscSF nroots %" PetscInt_FMT " < %" PetscInt_FMT " section size", nroots, pEnd - pStart);
16329566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(nroots, &neg));
1633ea844a1aSMatthew Knepley     if (nroots > pEnd - pStart) {
16349566063dSJacob Faibussowitsch       PetscCall(PetscCalloc1(nroots, &tmpOff));
1635ea844a1aSMatthew Knepley     } else {
1636ea844a1aSMatthew Knepley       tmpOff = &(*gsection)->atlasDof[-pStart];
1637ea844a1aSMatthew Knepley     }
1638ea844a1aSMatthew Knepley   }
1639ea844a1aSMatthew Knepley   /* Mark ghost points with negative dof */
1640ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
1641ea844a1aSMatthew Knepley     for (e = 0; e < numExcludes; ++e) {
1642ea844a1aSMatthew Knepley       if ((p >= excludes[e * 2 + 0]) && (p < excludes[e * 2 + 1])) {
16439566063dSJacob Faibussowitsch         PetscCall(PetscSectionSetDof(*gsection, p, 0));
1644ea844a1aSMatthew Knepley         break;
1645ea844a1aSMatthew Knepley       }
1646ea844a1aSMatthew Knepley     }
1647ea844a1aSMatthew Knepley     if (e < numExcludes) continue;
16489566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s, p, &dof));
16499566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(*gsection, p, dof));
16509566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s, p, &cdof));
16519566063dSJacob Faibussowitsch     if (!includeConstraints && cdof > 0) PetscCall(PetscSectionSetConstraintDof(*gsection, p, cdof));
1652ea844a1aSMatthew Knepley     if (neg) neg[p] = -(dof + 1);
1653ea844a1aSMatthew Knepley   }
16549566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUpBC(*gsection));
1655ea844a1aSMatthew Knepley   if (nroots >= 0) {
16569566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastBegin(sf, MPIU_INT, neg, tmpOff, MPI_REPLACE));
16579566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastEnd(sf, MPIU_INT, neg, tmpOff, MPI_REPLACE));
1658ea844a1aSMatthew Knepley     if (nroots > pEnd - pStart) {
16599371c9d4SSatish Balay       for (p = pStart; p < pEnd; ++p) {
16609371c9d4SSatish Balay         if (tmpOff[p] < 0) (*gsection)->atlasDof[p - pStart] = tmpOff[p];
16619371c9d4SSatish Balay       }
1662ea844a1aSMatthew Knepley     }
1663ea844a1aSMatthew Knepley   }
166435cb6cd3SPierre Jolivet   /* Calculate new sizes, get process offset, and calculate point offsets */
16659566063dSJacob Faibussowitsch   if (s->perm) PetscCall(ISGetIndices(s->perm, &pind));
1666ea844a1aSMatthew Knepley   for (p = 0, off = 0; p < pEnd - pStart; ++p) {
1667ea844a1aSMatthew Knepley     const PetscInt q = pind ? pind[p] : p;
1668ea844a1aSMatthew Knepley 
1669ea844a1aSMatthew Knepley     cdof                     = (!includeConstraints && s->bc) ? s->bc->atlasDof[q] : 0;
16706497c311SBarry Smith     (*gsection)->atlasOff[q] = (PetscInt)off;
1671ea844a1aSMatthew Knepley     off += (*gsection)->atlasDof[q] > 0 ? (*gsection)->atlasDof[q] - cdof : 0;
1672357d8704SBarry Smith     PetscCheck(off < PETSC_INT_MAX, PETSC_COMM_SELF, PETSC_ERR_INT_OVERFLOW, "Offsets too large for 32 bit indices");
16736497c311SBarry Smith   }
16749566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Scan(&off, &globalOff, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject)s)));
1675ea844a1aSMatthew Knepley   globalOff -= off;
1676ea844a1aSMatthew Knepley   for (p = 0, off = 0; p < pEnd - pStart; ++p) {
1677ea844a1aSMatthew Knepley     (*gsection)->atlasOff[p] += globalOff;
1678ea844a1aSMatthew Knepley     if (neg) neg[p + pStart] = -((*gsection)->atlasOff[p] + 1);
1679ea844a1aSMatthew Knepley   }
16809566063dSJacob Faibussowitsch   if (s->perm) PetscCall(ISRestoreIndices(s->perm, &pind));
1681ea844a1aSMatthew Knepley   /* Put in negative offsets for ghost points */
1682ea844a1aSMatthew Knepley   if (nroots >= 0) {
1683ea844a1aSMatthew Knepley     if (nroots == pEnd - pStart) tmpOff = &(*gsection)->atlasOff[-pStart];
16849566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastBegin(sf, MPIU_INT, neg, tmpOff, MPI_REPLACE));
16859566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastEnd(sf, MPIU_INT, neg, tmpOff, MPI_REPLACE));
1686ea844a1aSMatthew Knepley     if (nroots > pEnd - pStart) {
16879371c9d4SSatish Balay       for (p = pStart; p < pEnd; ++p) {
16889371c9d4SSatish Balay         if (tmpOff[p] < 0) (*gsection)->atlasOff[p - pStart] = tmpOff[p];
16899371c9d4SSatish Balay       }
1690ea844a1aSMatthew Knepley     }
1691ea844a1aSMatthew Knepley   }
16929566063dSJacob Faibussowitsch   if (nroots >= 0 && nroots > pEnd - pStart) PetscCall(PetscFree(tmpOff));
16939566063dSJacob Faibussowitsch   PetscCall(PetscFree(neg));
16943ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1695ea844a1aSMatthew Knepley }
1696ea844a1aSMatthew Knepley 
1697ea844a1aSMatthew Knepley /*@
1698583308b6SBarry Smith   PetscSectionGetPointLayout - Get a `PetscLayout` for the points with nonzero dof counts of the unnamed default field within this `PetscSection`s local chart
1699ea844a1aSMatthew Knepley 
1700cab54364SBarry Smith   Collective
1701ea844a1aSMatthew Knepley 
1702ea844a1aSMatthew Knepley   Input Parameters:
1703cab54364SBarry Smith + comm - The `MPI_Comm`
1704cab54364SBarry Smith - s    - The `PetscSection`
1705ea844a1aSMatthew Knepley 
1706ea844a1aSMatthew Knepley   Output Parameter:
170720662ed9SBarry Smith . layout - The point layout for the data that defines the section
1708ea844a1aSMatthew Knepley 
1709ea844a1aSMatthew Knepley   Level: advanced
1710ea844a1aSMatthew Knepley 
171120662ed9SBarry Smith   Notes:
1712583308b6SBarry Smith   `PetscSectionGetValueLayout()` provides similar information but counting the total number of degrees of freedom on the MPI process (excluding constrained
1713583308b6SBarry Smith   degrees of freedom).
171420662ed9SBarry Smith 
1715583308b6SBarry Smith   This count includes constrained degrees of freedom
1716583308b6SBarry Smith 
1717583308b6SBarry Smith   This is usually called on the default global section.
1718583308b6SBarry Smith 
1719583308b6SBarry Smith   Example:
1720583308b6SBarry Smith .vb
1721583308b6SBarry Smith      The chart is [2,5), point 2 has 2 dof, point 3 has 0 dof, point 4 has 1 dof
1722583308b6SBarry Smith      The local size of the `PetscLayout` is 2 since 2 points have a non-zero number of dof
1723583308b6SBarry Smith .ve
1724583308b6SBarry Smith 
172538b5cf2dSJacob Faibussowitsch   Developer Notes:
1726583308b6SBarry Smith   I find the names of these two functions extremely non-informative
1727cab54364SBarry Smith 
1728cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetValueLayout()`, `PetscSectionCreate()`
1729ea844a1aSMatthew Knepley @*/
1730d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetPointLayout(MPI_Comm comm, PetscSection s, PetscLayout *layout)
1731d71ae5a4SJacob Faibussowitsch {
1732ea844a1aSMatthew Knepley   PetscInt pStart, pEnd, p, localSize = 0;
1733ea844a1aSMatthew Knepley 
1734ea844a1aSMatthew Knepley   PetscFunctionBegin;
17359566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
1736ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
1737ea844a1aSMatthew Knepley     PetscInt dof;
1738ea844a1aSMatthew Knepley 
17399566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s, p, &dof));
17409120ba30SVaclav Hapla     if (dof >= 0) ++localSize;
1741ea844a1aSMatthew Knepley   }
17429566063dSJacob Faibussowitsch   PetscCall(PetscLayoutCreate(comm, layout));
17439566063dSJacob Faibussowitsch   PetscCall(PetscLayoutSetLocalSize(*layout, localSize));
17449566063dSJacob Faibussowitsch   PetscCall(PetscLayoutSetBlockSize(*layout, 1));
17459566063dSJacob Faibussowitsch   PetscCall(PetscLayoutSetUp(*layout));
17463ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1747ea844a1aSMatthew Knepley }
1748ea844a1aSMatthew Knepley 
1749ea844a1aSMatthew Knepley /*@
175020662ed9SBarry Smith   PetscSectionGetValueLayout - Get the `PetscLayout` associated with the section dofs of a `PetscSection`
1751ea844a1aSMatthew Knepley 
1752cab54364SBarry Smith   Collective
1753ea844a1aSMatthew Knepley 
1754ea844a1aSMatthew Knepley   Input Parameters:
1755cab54364SBarry Smith + comm - The `MPI_Comm`
1756cab54364SBarry Smith - s    - The `PetscSection`
1757ea844a1aSMatthew Knepley 
1758ea844a1aSMatthew Knepley   Output Parameter:
1759ea844a1aSMatthew Knepley . layout - The dof layout for the section
1760ea844a1aSMatthew Knepley 
1761ea844a1aSMatthew Knepley   Level: advanced
1762ea844a1aSMatthew Knepley 
176320662ed9SBarry Smith   Notes:
1764583308b6SBarry Smith   `PetscSectionGetPointLayout()` provides similar information but only counting the number of points with nonzero degrees of freedom and
1765583308b6SBarry Smith   including the constrained degrees of freedom
176620662ed9SBarry Smith 
1767cab54364SBarry Smith   This is usually called for the default global section.
1768cab54364SBarry Smith 
1769583308b6SBarry Smith   Example:
1770583308b6SBarry Smith .vb
1771583308b6SBarry 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)
1772583308b6SBarry Smith      The local size of the `PetscLayout` is 3 since there are 3 unconstrained degrees of freedom on this MPI process
1773583308b6SBarry Smith .ve
1774583308b6SBarry Smith 
1775cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetPointLayout()`, `PetscSectionCreate()`
1776ea844a1aSMatthew Knepley @*/
1777d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetValueLayout(MPI_Comm comm, PetscSection s, PetscLayout *layout)
1778d71ae5a4SJacob Faibussowitsch {
1779ea844a1aSMatthew Knepley   PetscInt pStart, pEnd, p, localSize = 0;
1780ea844a1aSMatthew Knepley 
1781ea844a1aSMatthew Knepley   PetscFunctionBegin;
1782ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 2);
17834f572ea9SToby Isaac   PetscAssertPointer(layout, 3);
17849566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
1785ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
1786ea844a1aSMatthew Knepley     PetscInt dof, cdof;
1787ea844a1aSMatthew Knepley 
17889566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s, p, &dof));
17899566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s, p, &cdof));
1790ea844a1aSMatthew Knepley     if (dof - cdof > 0) localSize += dof - cdof;
1791ea844a1aSMatthew Knepley   }
17929566063dSJacob Faibussowitsch   PetscCall(PetscLayoutCreate(comm, layout));
17939566063dSJacob Faibussowitsch   PetscCall(PetscLayoutSetLocalSize(*layout, localSize));
17949566063dSJacob Faibussowitsch   PetscCall(PetscLayoutSetBlockSize(*layout, 1));
17959566063dSJacob Faibussowitsch   PetscCall(PetscLayoutSetUp(*layout));
17963ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1797ea844a1aSMatthew Knepley }
1798ea844a1aSMatthew Knepley 
1799ea844a1aSMatthew Knepley /*@
1800db527f05SMatthew G. Knepley   PetscSectionGetOffset - Return the offset into an array or `Vec` for the dof associated with the given point.
1801ea844a1aSMatthew Knepley 
180240750d41SVaclav Hapla   Not Collective
1803ea844a1aSMatthew Knepley 
1804ea844a1aSMatthew Knepley   Input Parameters:
1805cab54364SBarry Smith + s     - the `PetscSection`
1806ea844a1aSMatthew Knepley - point - the point
1807ea844a1aSMatthew Knepley 
1808ea844a1aSMatthew Knepley   Output Parameter:
1809ea844a1aSMatthew Knepley . offset - the offset
1810ea844a1aSMatthew Knepley 
1811ea844a1aSMatthew Knepley   Level: intermediate
1812ea844a1aSMatthew Knepley 
1813583308b6SBarry Smith   Notes:
1814376335faSBarry Smith   In a global section, `offset` will be negative for points not owned by this process.
1815583308b6SBarry Smith 
1816583308b6SBarry Smith   This is for the unnamed default field in the `PetscSection` not the named fields
1817583308b6SBarry Smith 
1818583308b6SBarry Smith   The `offset` values are different depending on a value set with `PetscSectionSetPointMajor()`
1819583308b6SBarry Smith 
1820583308b6SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetFieldOffset()`, `PetscSectionCreate()`, `PetscSectionSetPointMajor()`
1821ea844a1aSMatthew Knepley @*/
1822d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetOffset(PetscSection s, PetscInt point, PetscInt *offset)
1823d71ae5a4SJacob Faibussowitsch {
1824ea844a1aSMatthew Knepley   PetscFunctionBegin;
1825ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
18264f572ea9SToby Isaac   PetscAssertPointer(offset, 3);
1827b498ca8aSPierre 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);
1828ea844a1aSMatthew Knepley   *offset = s->atlasOff[point - s->pStart];
18293ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1830ea844a1aSMatthew Knepley }
1831ea844a1aSMatthew Knepley 
1832ea844a1aSMatthew Knepley /*@
1833db527f05SMatthew G. Knepley   PetscSectionSetOffset - Set the offset into an array or `Vec` for the dof associated with the given point.
1834ea844a1aSMatthew Knepley 
183540750d41SVaclav Hapla   Not Collective
1836ea844a1aSMatthew Knepley 
1837ea844a1aSMatthew Knepley   Input Parameters:
1838cab54364SBarry Smith + s      - the `PetscSection`
1839ea844a1aSMatthew Knepley . point  - the point
1840376335faSBarry Smith - offset - the offset, these values may be negative indicating the values are off process
1841ea844a1aSMatthew Knepley 
1842583308b6SBarry Smith   Level: developer
1843ea844a1aSMatthew Knepley 
1844cab54364SBarry Smith   Note:
1845cab54364SBarry Smith   The user usually does not call this function, but uses `PetscSectionSetUp()`
1846cab54364SBarry Smith 
1847cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetFieldOffset()`, `PetscSectionCreate()`, `PetscSectionSetUp()`
1848ea844a1aSMatthew Knepley @*/
1849d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetOffset(PetscSection s, PetscInt point, PetscInt offset)
1850d71ae5a4SJacob Faibussowitsch {
1851ea844a1aSMatthew Knepley   PetscFunctionBegin;
1852ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
185308401ef6SPierre 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);
1854ea844a1aSMatthew Knepley   s->atlasOff[point - s->pStart] = offset;
18553ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1856ea844a1aSMatthew Knepley }
1857ea844a1aSMatthew Knepley 
1858ea844a1aSMatthew Knepley /*@
1859db527f05SMatthew G. Knepley   PetscSectionGetFieldOffset - Return the offset into an array or `Vec` for the field dof associated with the given point.
1860ea844a1aSMatthew Knepley 
186140750d41SVaclav Hapla   Not Collective
1862ea844a1aSMatthew Knepley 
1863ea844a1aSMatthew Knepley   Input Parameters:
1864cab54364SBarry Smith + s     - the `PetscSection`
1865ea844a1aSMatthew Knepley . point - the point
1866ea844a1aSMatthew Knepley - field - the field
1867ea844a1aSMatthew Knepley 
1868ea844a1aSMatthew Knepley   Output Parameter:
1869ea844a1aSMatthew Knepley . offset - the offset
1870ea844a1aSMatthew Knepley 
1871ea844a1aSMatthew Knepley   Level: intermediate
1872ea844a1aSMatthew Knepley 
1873583308b6SBarry Smith   Notes:
1874376335faSBarry Smith   In a global section, `offset` will be negative for points not owned by this process.
1875583308b6SBarry Smith 
1876583308b6SBarry Smith   The `offset` values are different depending on a value set with `PetscSectionSetPointMajor()`
1877583308b6SBarry Smith 
1878583308b6SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetOffset()`, `PetscSectionCreate()`, `PetscSectionGetFieldPointOffset()`
1879ea844a1aSMatthew Knepley @*/
1880d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetFieldOffset(PetscSection s, PetscInt point, PetscInt field, PetscInt *offset)
1881d71ae5a4SJacob Faibussowitsch {
1882ea844a1aSMatthew Knepley   PetscFunctionBegin;
1883ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
18844f572ea9SToby Isaac   PetscAssertPointer(offset, 4);
18852abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field, s->numFields);
18869566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(s->field[field], point, offset));
18873ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1888ea844a1aSMatthew Knepley }
1889ea844a1aSMatthew Knepley 
1890ea844a1aSMatthew Knepley /*@
1891db527f05SMatthew G. Knepley   PetscSectionSetFieldOffset - Set the offset into an array or `Vec` for the dof associated with the given field at a point.
1892ea844a1aSMatthew Knepley 
189340750d41SVaclav Hapla   Not Collective
1894ea844a1aSMatthew Knepley 
1895ea844a1aSMatthew Knepley   Input Parameters:
189620662ed9SBarry Smith + s      - the `PetscSection`
1897ea844a1aSMatthew Knepley . point  - the point
1898ea844a1aSMatthew Knepley . field  - the field
1899376335faSBarry Smith - offset - the offset, these values may be negative indicating the values are off process
1900ea844a1aSMatthew Knepley 
1901cab54364SBarry Smith   Level: developer
1902ea844a1aSMatthew Knepley 
1903cab54364SBarry Smith   Note:
1904cab54364SBarry Smith   The user usually does not call this function, but uses `PetscSectionSetUp()`
1905ea844a1aSMatthew Knepley 
1906cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetFieldOffset()`, `PetscSectionSetOffset()`, `PetscSectionCreate()`, `PetscSectionSetUp()`
1907ea844a1aSMatthew Knepley @*/
1908d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetFieldOffset(PetscSection s, PetscInt point, PetscInt field, PetscInt offset)
1909d71ae5a4SJacob Faibussowitsch {
1910ea844a1aSMatthew Knepley   PetscFunctionBegin;
1911ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
19122abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field, s->numFields);
19139566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetOffset(s->field[field], point, offset));
19143ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1915ea844a1aSMatthew Knepley }
1916ea844a1aSMatthew Knepley 
1917ea844a1aSMatthew Knepley /*@
1918583308b6SBarry Smith   PetscSectionGetFieldPointOffset - Return the offset for the first field dof associated with the given point relative to the offset for that point for the
1919583308b6SBarry Smith   unnamed default field's first dof
1920ea844a1aSMatthew Knepley 
192140750d41SVaclav Hapla   Not Collective
1922ea844a1aSMatthew Knepley 
1923ea844a1aSMatthew Knepley   Input Parameters:
1924cab54364SBarry Smith + s     - the `PetscSection`
1925ea844a1aSMatthew Knepley . point - the point
1926ea844a1aSMatthew Knepley - field - the field
1927ea844a1aSMatthew Knepley 
1928ea844a1aSMatthew Knepley   Output Parameter:
1929ea844a1aSMatthew Knepley . offset - the offset
1930ea844a1aSMatthew Knepley 
1931ea844a1aSMatthew Knepley   Level: advanced
1932ea844a1aSMatthew Knepley 
1933cab54364SBarry Smith   Note:
1934583308b6SBarry Smith   This ignores constraints
1935cab54364SBarry Smith 
1936583308b6SBarry Smith   Example:
1937583308b6SBarry Smith .vb
1938583308b6SBarry Smith   if PetscSectionSetPointMajor(s,PETSC_TRUE)
1939583308b6SBarry Smith   The unnamed default field has 3 dof at `point`
1940583308b6SBarry Smith   Field 0 has 2 dof at `point`
1941583308b6SBarry Smith   Then PetscSectionGetFieldPointOffset(s,point,1,&offset) returns and offset of 5
1942583308b6SBarry Smith .ve
1943583308b6SBarry Smith 
1944583308b6SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetOffset()`, `PetscSectionCreate()`, `PetscSectionGetFieldOffset()`
1945ea844a1aSMatthew Knepley @*/
1946d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetFieldPointOffset(PetscSection s, PetscInt point, PetscInt field, PetscInt *offset)
1947d71ae5a4SJacob Faibussowitsch {
1948ea844a1aSMatthew Knepley   PetscInt off, foff;
1949ea844a1aSMatthew Knepley 
1950ea844a1aSMatthew Knepley   PetscFunctionBegin;
1951ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
19524f572ea9SToby Isaac   PetscAssertPointer(offset, 4);
19532abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field, s->numFields);
19549566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(s, point, &off));
19559566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetOffset(s->field[field], point, &foff));
1956ea844a1aSMatthew Knepley   *offset = foff - off;
19573ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1958ea844a1aSMatthew Knepley }
1959ea844a1aSMatthew Knepley 
1960ea844a1aSMatthew Knepley /*@
196120662ed9SBarry Smith   PetscSectionGetOffsetRange - Return the full range of offsets [`start`, `end`) for a `PetscSection`
1962ea844a1aSMatthew Knepley 
196340750d41SVaclav Hapla   Not Collective
1964ea844a1aSMatthew Knepley 
1965ea844a1aSMatthew Knepley   Input Parameter:
1966cab54364SBarry Smith . s - the `PetscSection`
1967ea844a1aSMatthew Knepley 
1968ea844a1aSMatthew Knepley   Output Parameters:
1969ea844a1aSMatthew Knepley + start - the minimum offset
1970ea844a1aSMatthew Knepley - end   - one more than the maximum offset
1971ea844a1aSMatthew Knepley 
1972ea844a1aSMatthew Knepley   Level: intermediate
1973ea844a1aSMatthew Knepley 
1974cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetOffset()`, `PetscSectionCreate()`
1975ea844a1aSMatthew Knepley @*/
1976d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetOffsetRange(PetscSection s, PetscInt *start, PetscInt *end)
1977d71ae5a4SJacob Faibussowitsch {
1978ea844a1aSMatthew Knepley   PetscInt os = 0, oe = 0, pStart, pEnd, p;
1979ea844a1aSMatthew Knepley 
1980ea844a1aSMatthew Knepley   PetscFunctionBegin;
1981ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
19829371c9d4SSatish Balay   if (s->atlasOff) {
19839371c9d4SSatish Balay     os = s->atlasOff[0];
19849371c9d4SSatish Balay     oe = s->atlasOff[0];
19859371c9d4SSatish Balay   }
19869566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
1987ea844a1aSMatthew Knepley   for (p = 0; p < pEnd - pStart; ++p) {
1988ea844a1aSMatthew Knepley     PetscInt dof = s->atlasDof[p], off = s->atlasOff[p];
1989ea844a1aSMatthew Knepley 
1990ea844a1aSMatthew Knepley     if (off >= 0) {
1991ea844a1aSMatthew Knepley       os = PetscMin(os, off);
1992ea844a1aSMatthew Knepley       oe = PetscMax(oe, off + dof);
1993ea844a1aSMatthew Knepley     }
1994ea844a1aSMatthew Knepley   }
1995ea844a1aSMatthew Knepley   if (start) *start = os;
1996ea844a1aSMatthew Knepley   if (end) *end = oe;
19973ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1998ea844a1aSMatthew Knepley }
1999ea844a1aSMatthew Knepley 
2000ea844a1aSMatthew Knepley /*@
2001583308b6SBarry Smith   PetscSectionCreateSubsection - Create a new, smaller `PetscSection` composed of only selected fields
2002ea844a1aSMatthew Knepley 
200340750d41SVaclav Hapla   Collective
2004ea844a1aSMatthew Knepley 
2005d8d19677SJose E. Roman   Input Parameters:
2006cab54364SBarry Smith + s      - the `PetscSection`
2007ea844a1aSMatthew Knepley . len    - the number of subfields
2008ea844a1aSMatthew Knepley - fields - the subfield numbers
2009ea844a1aSMatthew Knepley 
2010ea844a1aSMatthew Knepley   Output Parameter:
2011ea844a1aSMatthew Knepley . subs - the subsection
2012ea844a1aSMatthew Knepley 
2013ea844a1aSMatthew Knepley   Level: advanced
2014ea844a1aSMatthew Knepley 
2015cab54364SBarry Smith   Notes:
2016583308b6SBarry Smith   The chart of `subs` is the same as the chart of `s`
2017cab54364SBarry Smith 
2018cab54364SBarry Smith   This will error if a fieldnumber is out of range
2019cab54364SBarry Smith 
2020cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreateSupersection()`, `PetscSectionCreate()`
2021ea844a1aSMatthew Knepley @*/
2022d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionCreateSubsection(PetscSection s, PetscInt len, const PetscInt fields[], PetscSection *subs)
2023d71ae5a4SJacob Faibussowitsch {
2024b778fa18SValeria Barra   PetscInt nF, f, c, pStart, pEnd, p, maxCdof = 0;
2025ea844a1aSMatthew Knepley 
2026ea844a1aSMatthew Knepley   PetscFunctionBegin;
20273ba16761SJacob Faibussowitsch   if (!len) PetscFunctionReturn(PETSC_SUCCESS);
2028ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
20294f572ea9SToby Isaac   PetscAssertPointer(fields, 3);
20304f572ea9SToby Isaac   PetscAssertPointer(subs, 4);
20319566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetNumFields(s, &nF));
203208401ef6SPierre 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);
20339566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject)s), subs));
20349566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetNumFields(*subs, len));
2035ea844a1aSMatthew Knepley   for (f = 0; f < len; ++f) {
2036ea844a1aSMatthew Knepley     const char     *name    = NULL;
2037ea844a1aSMatthew Knepley     PetscInt        numComp = 0;
203842a52479SJed Brown     PetscSectionSym sym;
2039ea844a1aSMatthew Knepley 
20409566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldName(s, fields[f], &name));
20419566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldName(*subs, f, name));
20429566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldComponents(s, fields[f], &numComp));
20439566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldComponents(*subs, f, numComp));
2044b778fa18SValeria Barra     for (c = 0; c < s->numFieldComponents[fields[f]]; ++c) {
20459566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetComponentName(s, fields[f], c, &name));
20469566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetComponentName(*subs, f, c, name));
2047b778fa18SValeria Barra     }
204842a52479SJed Brown     PetscCall(PetscSectionGetFieldSym(s, fields[f], &sym));
204942a52479SJed Brown     PetscCall(PetscSectionSetFieldSym(*subs, f, sym));
2050ea844a1aSMatthew Knepley   }
20519566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
20529566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(*subs, pStart, pEnd));
2053ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
2054ea844a1aSMatthew Knepley     PetscInt dof = 0, cdof = 0, fdof = 0, cfdof = 0;
2055ea844a1aSMatthew Knepley 
2056ea844a1aSMatthew Knepley     for (f = 0; f < len; ++f) {
20579566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldDof(s, p, fields[f], &fdof));
20589566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldDof(*subs, p, f, fdof));
20599566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintDof(s, p, fields[f], &cfdof));
20609566063dSJacob Faibussowitsch       if (cfdof) PetscCall(PetscSectionSetFieldConstraintDof(*subs, p, f, cfdof));
2061ea844a1aSMatthew Knepley       dof += fdof;
2062ea844a1aSMatthew Knepley       cdof += cfdof;
2063ea844a1aSMatthew Knepley     }
20649566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(*subs, p, dof));
20659566063dSJacob Faibussowitsch     if (cdof) PetscCall(PetscSectionSetConstraintDof(*subs, p, cdof));
2066ea844a1aSMatthew Knepley     maxCdof = PetscMax(cdof, maxCdof);
2067ea844a1aSMatthew Knepley   }
20689566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(*subs));
2069ea844a1aSMatthew Knepley   if (maxCdof) {
2070ea844a1aSMatthew Knepley     PetscInt *indices;
2071ea844a1aSMatthew Knepley 
20729566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(maxCdof, &indices));
2073ea844a1aSMatthew Knepley     for (p = pStart; p < pEnd; ++p) {
2074ea844a1aSMatthew Knepley       PetscInt cdof;
2075ea844a1aSMatthew Knepley 
20769566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetConstraintDof(*subs, p, &cdof));
2077ea844a1aSMatthew Knepley       if (cdof) {
2078ea844a1aSMatthew Knepley         const PetscInt *oldIndices = NULL;
2079ea844a1aSMatthew Knepley         PetscInt        fdof = 0, cfdof = 0, fc, numConst = 0, fOff = 0;
2080ea844a1aSMatthew Knepley 
2081ea844a1aSMatthew Knepley         for (f = 0; f < len; ++f) {
20829566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetFieldDof(s, p, fields[f], &fdof));
20839566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetFieldConstraintDof(s, p, fields[f], &cfdof));
20849566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetFieldConstraintIndices(s, p, fields[f], &oldIndices));
20859566063dSJacob Faibussowitsch           PetscCall(PetscSectionSetFieldConstraintIndices(*subs, p, f, oldIndices));
20869574d0f0SMatthew G. Knepley           for (fc = 0; fc < cfdof; ++fc) indices[numConst + fc] = oldIndices[fc] + fOff;
2087ea844a1aSMatthew Knepley           numConst += cfdof;
2088ea844a1aSMatthew Knepley           fOff += fdof;
2089ea844a1aSMatthew Knepley         }
20909566063dSJacob Faibussowitsch         PetscCall(PetscSectionSetConstraintIndices(*subs, p, indices));
2091ea844a1aSMatthew Knepley       }
2092ea844a1aSMatthew Knepley     }
20939566063dSJacob Faibussowitsch     PetscCall(PetscFree(indices));
2094ea844a1aSMatthew Knepley   }
20953ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2096ea844a1aSMatthew Knepley }
2097ea844a1aSMatthew Knepley 
2098ea844a1aSMatthew Knepley /*@
20995becf6f4SMatthew G. Knepley   PetscSectionCreateComponentSubsection - Create a new, smaller `PetscSection` composed of only selected components
21005becf6f4SMatthew G. Knepley 
21015becf6f4SMatthew G. Knepley   Collective
21025becf6f4SMatthew G. Knepley 
21035becf6f4SMatthew G. Knepley   Input Parameters:
21045becf6f4SMatthew G. Knepley + s     - the `PetscSection`
21055becf6f4SMatthew G. Knepley . len   - the number of components
21065becf6f4SMatthew G. Knepley - comps - the component numbers
21075becf6f4SMatthew G. Knepley 
21085becf6f4SMatthew G. Knepley   Output Parameter:
21095becf6f4SMatthew G. Knepley . subs - the subsection
21105becf6f4SMatthew G. Knepley 
21115becf6f4SMatthew G. Knepley   Level: advanced
21125becf6f4SMatthew G. Knepley 
21135becf6f4SMatthew G. Knepley   Notes:
21145becf6f4SMatthew G. Knepley   The chart of `subs` is the same as the chart of `s`
21155becf6f4SMatthew G. Knepley 
21165becf6f4SMatthew G. Knepley   This will error if the section has more than one field, or if a component number is out of range
21175becf6f4SMatthew G. Knepley 
21185becf6f4SMatthew G. Knepley .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreateSupersection()`, `PetscSectionCreate()`
21195becf6f4SMatthew G. Knepley @*/
21205becf6f4SMatthew G. Knepley PetscErrorCode PetscSectionCreateComponentSubsection(PetscSection s, PetscInt len, const PetscInt comps[], PetscSection *subs)
21215becf6f4SMatthew G. Knepley {
21225becf6f4SMatthew G. Knepley   PetscSectionSym sym;
21235becf6f4SMatthew G. Knepley   const char     *name = NULL;
21245becf6f4SMatthew G. Knepley   PetscInt        Nf, pStart, pEnd;
21255becf6f4SMatthew G. Knepley 
21265becf6f4SMatthew G. Knepley   PetscFunctionBegin;
21275becf6f4SMatthew G. Knepley   if (!len) PetscFunctionReturn(PETSC_SUCCESS);
21285becf6f4SMatthew G. Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
21295becf6f4SMatthew G. Knepley   PetscAssertPointer(comps, 3);
21305becf6f4SMatthew G. Knepley   PetscAssertPointer(subs, 4);
21315becf6f4SMatthew G. Knepley   PetscCall(PetscSectionGetNumFields(s, &Nf));
21325becf6f4SMatthew G. Knepley   PetscCheck(Nf == 1, PetscObjectComm((PetscObject)s), PETSC_ERR_ARG_WRONG, "This method can only handle one field, not %" PetscInt_FMT, Nf);
21335becf6f4SMatthew G. Knepley   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject)s), subs));
21345becf6f4SMatthew G. Knepley   PetscCall(PetscSectionSetNumFields(*subs, 1));
21355becf6f4SMatthew G. Knepley   PetscCall(PetscSectionGetFieldName(s, 0, &name));
21365becf6f4SMatthew G. Knepley   PetscCall(PetscSectionSetFieldName(*subs, 0, name));
21375becf6f4SMatthew G. Knepley   PetscCall(PetscSectionSetFieldComponents(*subs, 0, len));
21385becf6f4SMatthew G. Knepley   PetscCall(PetscSectionGetFieldSym(s, 0, &sym));
21395becf6f4SMatthew G. Knepley   PetscCall(PetscSectionSetFieldSym(*subs, 0, sym));
21405becf6f4SMatthew G. Knepley   for (PetscInt c = 0; c < len; ++c) {
21415becf6f4SMatthew G. Knepley     PetscCall(PetscSectionGetComponentName(s, 0, comps[c], &name));
21425becf6f4SMatthew G. Knepley     PetscCall(PetscSectionSetComponentName(*subs, 0, c, name));
21435becf6f4SMatthew G. Knepley   }
21445becf6f4SMatthew G. Knepley   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
21455becf6f4SMatthew G. Knepley   PetscCall(PetscSectionSetChart(*subs, pStart, pEnd));
21465becf6f4SMatthew G. Knepley   for (PetscInt p = pStart; p < pEnd; ++p) {
21475becf6f4SMatthew G. Knepley     PetscInt dof, cdof, cfdof;
21485becf6f4SMatthew G. Knepley 
21495becf6f4SMatthew G. Knepley     PetscCall(PetscSectionGetDof(s, p, &dof));
21505becf6f4SMatthew G. Knepley     if (!dof) continue;
21515becf6f4SMatthew G. Knepley     PetscCall(PetscSectionGetFieldConstraintDof(s, p, 0, &cfdof));
21525becf6f4SMatthew G. Knepley     PetscCall(PetscSectionGetConstraintDof(s, p, &cdof));
21535becf6f4SMatthew G. Knepley     PetscCheck(!cdof && !cfdof, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Component selection does not work with constraints");
21545becf6f4SMatthew G. Knepley     PetscCall(PetscSectionSetFieldDof(*subs, p, 0, len));
21555becf6f4SMatthew G. Knepley     PetscCall(PetscSectionSetDof(*subs, p, len));
21565becf6f4SMatthew G. Knepley   }
21575becf6f4SMatthew G. Knepley   PetscCall(PetscSectionSetUp(*subs));
21585becf6f4SMatthew G. Knepley   PetscFunctionReturn(PETSC_SUCCESS);
21595becf6f4SMatthew G. Knepley }
21605becf6f4SMatthew G. Knepley 
21615becf6f4SMatthew G. Knepley /*@
2162583308b6SBarry Smith   PetscSectionCreateSupersection - Create a new, larger section composed of multiple `PetscSection`s
2163ea844a1aSMatthew Knepley 
216440750d41SVaclav Hapla   Collective
2165ea844a1aSMatthew Knepley 
2166ea844a1aSMatthew Knepley   Input Parameters:
2167ea844a1aSMatthew Knepley + s   - the input sections
2168ea844a1aSMatthew Knepley - len - the number of input sections
2169ea844a1aSMatthew Knepley 
2170ea844a1aSMatthew Knepley   Output Parameter:
2171ea844a1aSMatthew Knepley . supers - the supersection
2172ea844a1aSMatthew Knepley 
2173ea844a1aSMatthew Knepley   Level: advanced
2174ea844a1aSMatthew Knepley 
2175583308b6SBarry Smith   Notes:
2176cab54364SBarry Smith   The section offsets now refer to a new, larger vector.
2177cab54364SBarry Smith 
217838b5cf2dSJacob Faibussowitsch   Developer Notes:
2179cab54364SBarry Smith   Needs to explain how the sections are composed
2180cab54364SBarry Smith 
2181cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreateSubsection()`, `PetscSectionCreate()`
2182ea844a1aSMatthew Knepley @*/
2183d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionCreateSupersection(PetscSection s[], PetscInt len, PetscSection *supers)
2184d71ae5a4SJacob Faibussowitsch {
2185*1690c2aeSBarry Smith   PetscInt Nf = 0, f, pStart = PETSC_INT_MAX, pEnd = 0, p, maxCdof = 0, i;
2186ea844a1aSMatthew Knepley 
2187ea844a1aSMatthew Knepley   PetscFunctionBegin;
21883ba16761SJacob Faibussowitsch   if (!len) PetscFunctionReturn(PETSC_SUCCESS);
2189ea844a1aSMatthew Knepley   for (i = 0; i < len; ++i) {
2190ea844a1aSMatthew Knepley     PetscInt nf, pStarti, pEndi;
2191ea844a1aSMatthew Knepley 
21929566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetNumFields(s[i], &nf));
21939566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetChart(s[i], &pStarti, &pEndi));
2194ea844a1aSMatthew Knepley     pStart = PetscMin(pStart, pStarti);
2195ea844a1aSMatthew Knepley     pEnd   = PetscMax(pEnd, pEndi);
2196ea844a1aSMatthew Knepley     Nf += nf;
2197ea844a1aSMatthew Knepley   }
21989566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject)s[0]), supers));
21999566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetNumFields(*supers, Nf));
2200ea844a1aSMatthew Knepley   for (i = 0, f = 0; i < len; ++i) {
2201b778fa18SValeria Barra     PetscInt nf, fi, ci;
2202ea844a1aSMatthew Knepley 
22039566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetNumFields(s[i], &nf));
2204ea844a1aSMatthew Knepley     for (fi = 0; fi < nf; ++fi, ++f) {
2205ea844a1aSMatthew Knepley       const char *name    = NULL;
2206ea844a1aSMatthew Knepley       PetscInt    numComp = 0;
2207ea844a1aSMatthew Knepley 
22089566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldName(s[i], fi, &name));
22099566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldName(*supers, f, name));
22109566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldComponents(s[i], fi, &numComp));
22119566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldComponents(*supers, f, numComp));
2212b778fa18SValeria Barra       for (ci = 0; ci < s[i]->numFieldComponents[fi]; ++ci) {
22139566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetComponentName(s[i], fi, ci, &name));
22149566063dSJacob Faibussowitsch         PetscCall(PetscSectionSetComponentName(*supers, f, ci, name));
2215b778fa18SValeria Barra       }
2216ea844a1aSMatthew Knepley     }
2217ea844a1aSMatthew Knepley   }
22189566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(*supers, pStart, pEnd));
2219ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
2220ea844a1aSMatthew Knepley     PetscInt dof = 0, cdof = 0;
2221ea844a1aSMatthew Knepley 
2222ea844a1aSMatthew Knepley     for (i = 0, f = 0; i < len; ++i) {
2223ea844a1aSMatthew Knepley       PetscInt nf, fi, pStarti, pEndi;
2224ea844a1aSMatthew Knepley       PetscInt fdof = 0, cfdof = 0;
2225ea844a1aSMatthew Knepley 
22269566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetNumFields(s[i], &nf));
22279566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetChart(s[i], &pStarti, &pEndi));
2228ea844a1aSMatthew Knepley       if ((p < pStarti) || (p >= pEndi)) continue;
2229ea844a1aSMatthew Knepley       for (fi = 0; fi < nf; ++fi, ++f) {
22309566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetFieldDof(s[i], p, fi, &fdof));
22319566063dSJacob Faibussowitsch         PetscCall(PetscSectionAddFieldDof(*supers, p, f, fdof));
22329566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetFieldConstraintDof(s[i], p, fi, &cfdof));
22339566063dSJacob Faibussowitsch         if (cfdof) PetscCall(PetscSectionAddFieldConstraintDof(*supers, p, f, cfdof));
2234ea844a1aSMatthew Knepley         dof += fdof;
2235ea844a1aSMatthew Knepley         cdof += cfdof;
2236ea844a1aSMatthew Knepley       }
2237ea844a1aSMatthew Knepley     }
22389566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(*supers, p, dof));
22399566063dSJacob Faibussowitsch     if (cdof) PetscCall(PetscSectionSetConstraintDof(*supers, p, cdof));
2240ea844a1aSMatthew Knepley     maxCdof = PetscMax(cdof, maxCdof);
2241ea844a1aSMatthew Knepley   }
22429566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(*supers));
2243ea844a1aSMatthew Knepley   if (maxCdof) {
2244ea844a1aSMatthew Knepley     PetscInt *indices;
2245ea844a1aSMatthew Knepley 
22469566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(maxCdof, &indices));
2247ea844a1aSMatthew Knepley     for (p = pStart; p < pEnd; ++p) {
2248ea844a1aSMatthew Knepley       PetscInt cdof;
2249ea844a1aSMatthew Knepley 
22509566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetConstraintDof(*supers, p, &cdof));
2251ea844a1aSMatthew Knepley       if (cdof) {
2252ea844a1aSMatthew Knepley         PetscInt dof, numConst = 0, fOff = 0;
2253ea844a1aSMatthew Knepley 
2254ea844a1aSMatthew Knepley         for (i = 0, f = 0; i < len; ++i) {
2255ea844a1aSMatthew Knepley           const PetscInt *oldIndices = NULL;
2256ea844a1aSMatthew Knepley           PetscInt        nf, fi, pStarti, pEndi, fdof, cfdof, fc;
2257ea844a1aSMatthew Knepley 
22589566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetNumFields(s[i], &nf));
22599566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetChart(s[i], &pStarti, &pEndi));
2260ea844a1aSMatthew Knepley           if ((p < pStarti) || (p >= pEndi)) continue;
2261ea844a1aSMatthew Knepley           for (fi = 0; fi < nf; ++fi, ++f) {
22629566063dSJacob Faibussowitsch             PetscCall(PetscSectionGetFieldDof(s[i], p, fi, &fdof));
22639566063dSJacob Faibussowitsch             PetscCall(PetscSectionGetFieldConstraintDof(s[i], p, fi, &cfdof));
22649566063dSJacob Faibussowitsch             PetscCall(PetscSectionGetFieldConstraintIndices(s[i], p, fi, &oldIndices));
2265fcd2503dSMatthew G. Knepley             for (fc = 0; fc < cfdof; ++fc) indices[numConst + fc] = oldIndices[fc];
22669566063dSJacob Faibussowitsch             PetscCall(PetscSectionSetFieldConstraintIndices(*supers, p, f, &indices[numConst]));
2267fcd2503dSMatthew G. Knepley             for (fc = 0; fc < cfdof; ++fc) indices[numConst + fc] += fOff;
2268ea844a1aSMatthew Knepley             numConst += cfdof;
2269ea844a1aSMatthew Knepley           }
22709566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetDof(s[i], p, &dof));
2271ea844a1aSMatthew Knepley           fOff += dof;
2272ea844a1aSMatthew Knepley         }
22739566063dSJacob Faibussowitsch         PetscCall(PetscSectionSetConstraintIndices(*supers, p, indices));
2274ea844a1aSMatthew Knepley       }
2275ea844a1aSMatthew Knepley     }
22769566063dSJacob Faibussowitsch     PetscCall(PetscFree(indices));
2277ea844a1aSMatthew Knepley   }
22783ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2279ea844a1aSMatthew Knepley }
2280ea844a1aSMatthew Knepley 
228129d2e75bSMatthew G. Knepley static PetscErrorCode PetscSectionCreateSubplexSection_Private(PetscSection s, IS subpointIS, PetscBool renumberPoints, PetscSection *subs)
2282d71ae5a4SJacob Faibussowitsch {
2283ea844a1aSMatthew Knepley   const PetscInt *points = NULL, *indices = NULL;
228429d2e75bSMatthew G. Knepley   PetscInt       *spoints = NULL, *order = NULL;
228541f23ed0SMatthew G. Knepley   PetscInt        numFields, f, c, numSubpoints = 0, pStart, pEnd, p, spStart, spEnd, subp;
2286ea844a1aSMatthew Knepley 
2287ea844a1aSMatthew Knepley   PetscFunctionBegin;
2288ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
228929d2e75bSMatthew G. Knepley   PetscValidHeaderSpecific(subpointIS, IS_CLASSID, 2);
22904f572ea9SToby Isaac   PetscAssertPointer(subs, 4);
22919566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetNumFields(s, &numFields));
22929566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject)s), subs));
22939566063dSJacob Faibussowitsch   if (numFields) PetscCall(PetscSectionSetNumFields(*subs, numFields));
2294ea844a1aSMatthew Knepley   for (f = 0; f < numFields; ++f) {
2295ea844a1aSMatthew Knepley     const char *name    = NULL;
2296ea844a1aSMatthew Knepley     PetscInt    numComp = 0;
2297ea844a1aSMatthew Knepley 
22989566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldName(s, f, &name));
22999566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldName(*subs, f, name));
23009566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldComponents(s, f, &numComp));
23019566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldComponents(*subs, f, numComp));
2302b778fa18SValeria Barra     for (c = 0; c < s->numFieldComponents[f]; ++c) {
23039566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetComponentName(s, f, c, &name));
23049566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetComponentName(*subs, f, c, name));
2305b778fa18SValeria Barra     }
2306ea844a1aSMatthew Knepley   }
2307ea844a1aSMatthew Knepley   /* For right now, we do not try to squeeze the subchart */
230829d2e75bSMatthew G. Knepley   if (subpointIS) {
230929d2e75bSMatthew G. Knepley     PetscCall(ISGetLocalSize(subpointIS, &numSubpoints));
231029d2e75bSMatthew G. Knepley     PetscCall(ISGetIndices(subpointIS, &points));
2311ea844a1aSMatthew Knepley   }
23129566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
231341f23ed0SMatthew G. Knepley   if (renumberPoints) {
231429d2e75bSMatthew G. Knepley     PetscBool sorted;
231529d2e75bSMatthew G. Knepley 
231641f23ed0SMatthew G. Knepley     spStart = 0;
231741f23ed0SMatthew G. Knepley     spEnd   = numSubpoints;
231829d2e75bSMatthew G. Knepley     PetscCall(ISSorted(subpointIS, &sorted));
231929d2e75bSMatthew G. Knepley     if (!sorted) {
232029d2e75bSMatthew G. Knepley       PetscCall(PetscMalloc2(numSubpoints, &spoints, numSubpoints, &order));
232129d2e75bSMatthew G. Knepley       PetscCall(PetscArraycpy(spoints, points, numSubpoints));
232229d2e75bSMatthew G. Knepley       for (PetscInt i = 0; i < numSubpoints; ++i) order[i] = i;
232329d2e75bSMatthew G. Knepley       PetscCall(PetscSortIntWithArray(numSubpoints, spoints, order));
232429d2e75bSMatthew G. Knepley     }
232541f23ed0SMatthew G. Knepley   } else {
232629d2e75bSMatthew G. Knepley     PetscCall(ISGetMinMax(subpointIS, &spStart, &spEnd));
232741f23ed0SMatthew G. Knepley     ++spEnd;
232841f23ed0SMatthew G. Knepley   }
232941f23ed0SMatthew G. Knepley   PetscCall(PetscSectionSetChart(*subs, spStart, spEnd));
2330ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
2331ea844a1aSMatthew Knepley     PetscInt dof, cdof, fdof = 0, cfdof = 0;
2332ea844a1aSMatthew Knepley 
233329d2e75bSMatthew G. Knepley     PetscCall(PetscFindInt(p, numSubpoints, spoints ? spoints : points, &subp));
2334ea844a1aSMatthew Knepley     if (subp < 0) continue;
233541f23ed0SMatthew G. Knepley     if (!renumberPoints) subp = p;
233629d2e75bSMatthew G. Knepley     else subp = order ? order[subp] : subp;
2337ea844a1aSMatthew Knepley     for (f = 0; f < numFields; ++f) {
23389566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldDof(s, p, f, &fdof));
23399566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldDof(*subs, subp, f, fdof));
23409566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintDof(s, p, f, &cfdof));
23419566063dSJacob Faibussowitsch       if (cfdof) PetscCall(PetscSectionSetFieldConstraintDof(*subs, subp, f, cfdof));
2342ea844a1aSMatthew Knepley     }
23439566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s, p, &dof));
23449566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(*subs, subp, dof));
23459566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s, p, &cdof));
23469566063dSJacob Faibussowitsch     if (cdof) PetscCall(PetscSectionSetConstraintDof(*subs, subp, cdof));
2347ea844a1aSMatthew Knepley   }
23489566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(*subs));
2349ea844a1aSMatthew Knepley   /* Change offsets to original offsets */
2350ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
2351ea844a1aSMatthew Knepley     PetscInt off, foff = 0;
2352ea844a1aSMatthew Knepley 
235329d2e75bSMatthew G. Knepley     PetscCall(PetscFindInt(p, numSubpoints, spoints ? spoints : points, &subp));
2354ea844a1aSMatthew Knepley     if (subp < 0) continue;
235541f23ed0SMatthew G. Knepley     if (!renumberPoints) subp = p;
235629d2e75bSMatthew G. Knepley     else subp = order ? order[subp] : subp;
2357ea844a1aSMatthew Knepley     for (f = 0; f < numFields; ++f) {
23589566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldOffset(s, p, f, &foff));
23599566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldOffset(*subs, subp, f, foff));
2360ea844a1aSMatthew Knepley     }
23619566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(s, p, &off));
23629566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetOffset(*subs, subp, off));
2363ea844a1aSMatthew Knepley   }
2364ea844a1aSMatthew Knepley   /* Copy constraint indices */
236541f23ed0SMatthew G. Knepley   for (subp = spStart; subp < spEnd; ++subp) {
2366ea844a1aSMatthew Knepley     PetscInt cdof;
2367ea844a1aSMatthew Knepley 
23689566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(*subs, subp, &cdof));
2369ea844a1aSMatthew Knepley     if (cdof) {
2370ea844a1aSMatthew Knepley       for (f = 0; f < numFields; ++f) {
237141f23ed0SMatthew G. Knepley         PetscCall(PetscSectionGetFieldConstraintIndices(s, points[subp - spStart], f, &indices));
23729566063dSJacob Faibussowitsch         PetscCall(PetscSectionSetFieldConstraintIndices(*subs, subp, f, indices));
2373ea844a1aSMatthew Knepley       }
237441f23ed0SMatthew G. Knepley       PetscCall(PetscSectionGetConstraintIndices(s, points[subp - spStart], &indices));
23759566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetConstraintIndices(*subs, subp, indices));
2376ea844a1aSMatthew Knepley     }
2377ea844a1aSMatthew Knepley   }
237829d2e75bSMatthew G. Knepley   if (subpointIS) PetscCall(ISRestoreIndices(subpointIS, &points));
237929d2e75bSMatthew G. Knepley   PetscCall(PetscFree2(spoints, order));
23803ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2381ea844a1aSMatthew Knepley }
2382ea844a1aSMatthew Knepley 
238341f23ed0SMatthew G. Knepley /*@
238441f23ed0SMatthew G. Knepley   PetscSectionCreateSubmeshSection - Create a new, smaller section with support on the submesh
238541f23ed0SMatthew G. Knepley 
2386c3339decSBarry Smith   Collective
238741f23ed0SMatthew G. Knepley 
238841f23ed0SMatthew G. Knepley   Input Parameters:
2389cab54364SBarry Smith + s          - the `PetscSection`
239029d2e75bSMatthew G. Knepley - subpointIS - a sorted list of points in the original mesh which are in the submesh
239141f23ed0SMatthew G. Knepley 
239241f23ed0SMatthew G. Knepley   Output Parameter:
239341f23ed0SMatthew G. Knepley . subs - the subsection
239441f23ed0SMatthew G. Knepley 
2395cab54364SBarry Smith   Level: advanced
2396cab54364SBarry Smith 
2397583308b6SBarry Smith   Notes:
2398583308b6SBarry 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))`
2399583308b6SBarry Smith 
240020662ed9SBarry Smith   Compare this with `PetscSectionCreateSubdomainSection()` that does not map the points numbers to start at zero but leaves them as before
240141f23ed0SMatthew G. Knepley 
240238b5cf2dSJacob Faibussowitsch   Developer Notes:
240320662ed9SBarry 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`
240441f23ed0SMatthew G. Knepley 
2405cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreateSubdomainSection()`, `PetscSectionCreateSubsection()`, `DMPlexGetSubpointMap()`, `PetscSectionCreate()`
240641f23ed0SMatthew G. Knepley @*/
240729d2e75bSMatthew G. Knepley PetscErrorCode PetscSectionCreateSubmeshSection(PetscSection s, IS subpointIS, PetscSection *subs)
2408d71ae5a4SJacob Faibussowitsch {
240941f23ed0SMatthew G. Knepley   PetscFunctionBegin;
241029d2e75bSMatthew G. Knepley   PetscCall(PetscSectionCreateSubplexSection_Private(s, subpointIS, PETSC_TRUE, subs));
24113ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
241241f23ed0SMatthew G. Knepley }
241341f23ed0SMatthew G. Knepley 
241441f23ed0SMatthew G. Knepley /*@
241541f23ed0SMatthew G. Knepley   PetscSectionCreateSubdomainSection - Create a new, smaller section with support on a subdomain of the mesh
241641f23ed0SMatthew G. Knepley 
2417c3339decSBarry Smith   Collective
241841f23ed0SMatthew G. Knepley 
241941f23ed0SMatthew G. Knepley   Input Parameters:
2420cab54364SBarry Smith + s           - the `PetscSection`
242141f23ed0SMatthew G. Knepley - subpointMap - a sorted list of points in the original mesh which are in the subdomain
242241f23ed0SMatthew G. Knepley 
242341f23ed0SMatthew G. Knepley   Output Parameter:
242441f23ed0SMatthew G. Knepley . subs - the subsection
242541f23ed0SMatthew G. Knepley 
2426cab54364SBarry Smith   Level: advanced
2427cab54364SBarry Smith 
2428583308b6SBarry Smith   Notes:
2429583308b6SBarry 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`
2430583308b6SBarry Smith   is `[min(subpointMap),max(subpointMap)+1)`
2431583308b6SBarry Smith 
243220662ed9SBarry Smith   Compare this with `PetscSectionCreateSubmeshSection()` that maps the point numbers to start at zero
243341f23ed0SMatthew G. Knepley 
2434cab54364SBarry Smith   Developer Notes:
243520662ed9SBarry 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`
2436cab54364SBarry Smith 
2437cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreateSubmeshSection()`, `PetscSectionCreateSubsection()`, `DMPlexGetSubpointMap()`, `PetscSectionCreate()`
243841f23ed0SMatthew G. Knepley @*/
2439d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionCreateSubdomainSection(PetscSection s, IS subpointMap, PetscSection *subs)
2440d71ae5a4SJacob Faibussowitsch {
244141f23ed0SMatthew G. Knepley   PetscFunctionBegin;
2442da8c939bSJacob Faibussowitsch   PetscCall(PetscSectionCreateSubplexSection_Private(s, subpointMap, PETSC_FALSE, subs));
24433ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
244441f23ed0SMatthew G. Knepley }
244541f23ed0SMatthew G. Knepley 
2446d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscSectionView_ASCII(PetscSection s, PetscViewer viewer)
2447d71ae5a4SJacob Faibussowitsch {
2448ea844a1aSMatthew Knepley   PetscInt    p;
2449ea844a1aSMatthew Knepley   PetscMPIInt rank;
2450ea844a1aSMatthew Knepley 
2451ea844a1aSMatthew Knepley   PetscFunctionBegin;
24529566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(PetscObjectComm((PetscObject)viewer), &rank));
24539566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPushSynchronized(viewer));
24549566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "Process %d:\n", rank));
2455ea844a1aSMatthew Knepley   for (p = 0; p < s->pEnd - s->pStart; ++p) {
24563857f682SStefano Zampini     if (s->bc && s->bc->atlasDof[p] > 0) {
2457ea844a1aSMatthew Knepley       PetscInt b;
24586497c311SBarry Smith       PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "  (%4" PetscInt_FMT ") dof %2" PetscInt_FMT " offset %3" PetscInt_FMT " constrained", p + s->pStart, s->atlasDof[p], s->atlasOff[p]));
2459083401c6SMatthew G. Knepley       if (s->bcIndices) {
246048a46eb9SPierre Jolivet         for (b = 0; b < s->bc->atlasDof[p]; ++b) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, " %" PetscInt_FMT, s->bcIndices[s->bc->atlasOff[p] + b]));
2461083401c6SMatthew G. Knepley       }
24629566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "\n"));
2463ea844a1aSMatthew Knepley     } else {
24646497c311SBarry Smith       PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "  (%4" PetscInt_FMT ") dof %2" PetscInt_FMT " offset %3" PetscInt_FMT "\n", p + s->pStart, s->atlasDof[p], s->atlasOff[p]));
2465ea844a1aSMatthew Knepley     }
2466ea844a1aSMatthew Knepley   }
24679566063dSJacob Faibussowitsch   PetscCall(PetscViewerFlush(viewer));
24689566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPopSynchronized(viewer));
2469ea844a1aSMatthew Knepley   if (s->sym) {
24709566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPushTab(viewer));
24719566063dSJacob Faibussowitsch     PetscCall(PetscSectionSymView(s->sym, viewer));
24729566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopTab(viewer));
2473ea844a1aSMatthew Knepley   }
24743ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2475ea844a1aSMatthew Knepley }
2476ea844a1aSMatthew Knepley 
2477ffeef943SBarry Smith /*@
2478cab54364SBarry Smith   PetscSectionViewFromOptions - View the `PetscSection` based on values in the options database
2479fe2efc57SMark 
248040750d41SVaclav Hapla   Collective
2481fe2efc57SMark 
2482fe2efc57SMark   Input Parameters:
248320662ed9SBarry Smith + A    - the `PetscSection` object to view
2484cab54364SBarry Smith . obj  - Optional object that provides the options prefix used for the options
2485736c3998SJose E. Roman - name - command line option
2486fe2efc57SMark 
2487fe2efc57SMark   Level: intermediate
2488cab54364SBarry Smith 
248920662ed9SBarry Smith   Note:
249020662ed9SBarry Smith   See `PetscObjectViewFromOptions()` for available values of `PetscViewer` and `PetscViewerFormat`
249120662ed9SBarry Smith 
2492cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionView`, `PetscObjectViewFromOptions()`, `PetscSectionCreate()`, `PetscSectionView()`
2493fe2efc57SMark @*/
2494d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionViewFromOptions(PetscSection A, PetscObject obj, const char name[])
2495d71ae5a4SJacob Faibussowitsch {
2496fe2efc57SMark   PetscFunctionBegin;
2497fe2efc57SMark   PetscValidHeaderSpecific(A, PETSC_SECTION_CLASSID, 1);
24989566063dSJacob Faibussowitsch   PetscCall(PetscObjectViewFromOptions((PetscObject)A, obj, name));
24993ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2500fe2efc57SMark }
2501fe2efc57SMark 
2502ffeef943SBarry Smith /*@
2503cab54364SBarry Smith   PetscSectionView - Views a `PetscSection`
2504ea844a1aSMatthew Knepley 
250540750d41SVaclav Hapla   Collective
2506ea844a1aSMatthew Knepley 
2507ea844a1aSMatthew Knepley   Input Parameters:
2508cab54364SBarry Smith + s      - the `PetscSection` object to view
250938b5cf2dSJacob Faibussowitsch - viewer - the viewer
2510ea844a1aSMatthew Knepley 
2511cab54364SBarry Smith   Level: beginner
2512cab54364SBarry Smith 
25131ddd528eSksagiyam   Note:
2514cab54364SBarry Smith   `PetscSectionView()`, when viewer is of type `PETSCVIEWERHDF5`, only saves
25151ddd528eSksagiyam   distribution independent data, such as dofs, offsets, constraint dofs,
25161ddd528eSksagiyam   and constraint indices. Points that have negative dofs, for instance,
25171ddd528eSksagiyam   are not saved as they represent points owned by other processes.
25181ddd528eSksagiyam   Point numbering and rank assignment is currently not stored.
2519cab54364SBarry Smith   The saved section can be loaded with `PetscSectionLoad()`.
25201ddd528eSksagiyam 
2521cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreate()`, `PetscSectionDestroy()`, `PetscSectionLoad()`, `PetscViewer`
2522ea844a1aSMatthew Knepley @*/
2523d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionView(PetscSection s, PetscViewer viewer)
2524d71ae5a4SJacob Faibussowitsch {
25251ddd528eSksagiyam   PetscBool isascii, ishdf5;
2526ea844a1aSMatthew Knepley   PetscInt  f;
2527ea844a1aSMatthew Knepley 
2528ea844a1aSMatthew Knepley   PetscFunctionBegin;
2529ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
25309566063dSJacob Faibussowitsch   if (!viewer) PetscCall(PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)s), &viewer));
2531ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(viewer, PETSC_VIEWER_CLASSID, 2);
25329566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &isascii));
25339566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERHDF5, &ishdf5));
2534ea844a1aSMatthew Knepley   if (isascii) {
25359566063dSJacob Faibussowitsch     PetscCall(PetscObjectPrintClassNamePrefixType((PetscObject)s, viewer));
2536ea844a1aSMatthew Knepley     if (s->numFields) {
25379566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "%" PetscInt_FMT " fields\n", s->numFields));
2538ea844a1aSMatthew Knepley       for (f = 0; f < s->numFields; ++f) {
25394cd8913cSStefano Zampini         PetscCall(PetscViewerASCIIPrintf(viewer, "  field %" PetscInt_FMT " \"%s\" with %" PetscInt_FMT " components\n", f, s->fieldNames[f], s->numFieldComponents[f]));
25409566063dSJacob Faibussowitsch         PetscCall(PetscSectionView_ASCII(s->field[f], viewer));
2541ea844a1aSMatthew Knepley       }
2542ea844a1aSMatthew Knepley     } else {
25439566063dSJacob Faibussowitsch       PetscCall(PetscSectionView_ASCII(s, viewer));
2544ea844a1aSMatthew Knepley     }
25451ddd528eSksagiyam   } else if (ishdf5) {
25461ddd528eSksagiyam #if PetscDefined(HAVE_HDF5)
25479566063dSJacob Faibussowitsch     PetscCall(PetscSectionView_HDF5_Internal(s, viewer));
25481ddd528eSksagiyam #else
25491ddd528eSksagiyam     SETERRQ(PetscObjectComm((PetscObject)s), PETSC_ERR_SUP, "HDF5 not supported in this build.\nPlease reconfigure using --download-hdf5");
25501ddd528eSksagiyam #endif
2551ea844a1aSMatthew Knepley   }
25523ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2553ea844a1aSMatthew Knepley }
2554ea844a1aSMatthew Knepley 
2555ffeef943SBarry Smith /*@
2556cab54364SBarry Smith   PetscSectionLoad - Loads a `PetscSection`
2557fde5e3acSksagiyam 
255840750d41SVaclav Hapla   Collective
2559fde5e3acSksagiyam 
2560fde5e3acSksagiyam   Input Parameters:
2561cab54364SBarry Smith + s      - the `PetscSection` object to load
256238b5cf2dSJacob Faibussowitsch - viewer - the viewer
2563fde5e3acSksagiyam 
2564cab54364SBarry Smith   Level: beginner
2565cab54364SBarry Smith 
2566fde5e3acSksagiyam   Note:
2567cab54364SBarry Smith   `PetscSectionLoad()`, when viewer is of type `PETSCVIEWERHDF5`, loads
2568cab54364SBarry Smith   a section saved with `PetscSectionView()`. The number of processes
2569fde5e3acSksagiyam   used here (N) does not need to be the same as that used when saving.
2570fde5e3acSksagiyam   After calling this function, the chart of s on rank i will be set
2571fde5e3acSksagiyam   to [0, E_i), where \sum_{i=0}^{N-1}E_i equals to the total number of
2572fde5e3acSksagiyam   saved section points.
2573fde5e3acSksagiyam 
2574cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreate()`, `PetscSectionDestroy()`, `PetscSectionView()`
2575fde5e3acSksagiyam @*/
2576d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionLoad(PetscSection s, PetscViewer viewer)
2577d71ae5a4SJacob Faibussowitsch {
2578fde5e3acSksagiyam   PetscBool ishdf5;
2579fde5e3acSksagiyam 
2580fde5e3acSksagiyam   PetscFunctionBegin;
2581fde5e3acSksagiyam   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2582fde5e3acSksagiyam   PetscValidHeaderSpecific(viewer, PETSC_VIEWER_CLASSID, 2);
25839566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERHDF5, &ishdf5));
2584fde5e3acSksagiyam   if (ishdf5) {
2585fde5e3acSksagiyam #if PetscDefined(HAVE_HDF5)
25869566063dSJacob Faibussowitsch     PetscCall(PetscSectionLoad_HDF5_Internal(s, viewer));
25873ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
2588fde5e3acSksagiyam #else
2589fde5e3acSksagiyam     SETERRQ(PetscObjectComm((PetscObject)s), PETSC_ERR_SUP, "HDF5 not supported in this build.\nPlease reconfigure using --download-hdf5");
2590fde5e3acSksagiyam #endif
259198921bdaSJacob Faibussowitsch   } else SETERRQ(PetscObjectComm((PetscObject)s), PETSC_ERR_SUP, "Viewer type %s not yet supported for PetscSection loading", ((PetscObject)viewer)->type_name);
2592fde5e3acSksagiyam }
2593fde5e3acSksagiyam 
2594d4a1ad33SMatthew G. Knepley /*@
2595d4a1ad33SMatthew G. Knepley   PetscSectionResetClosurePermutation - Remove any existing closure permutation
2596d4a1ad33SMatthew G. Knepley 
2597d4a1ad33SMatthew G. Knepley   Input Parameter:
2598e8e188d2SZach Atkins . section - The `PetscSection`
2599d4a1ad33SMatthew G. Knepley 
2600d4a1ad33SMatthew G. Knepley   Level: intermediate
2601d4a1ad33SMatthew G. Knepley 
2602e8e188d2SZach Atkins .seealso: `PetscSectionSetClosurePermutation()`, `PetscSectionSetClosureIndex()`, `PetscSectionReset()`
2603d4a1ad33SMatthew G. Knepley @*/
2604d4a1ad33SMatthew G. Knepley PetscErrorCode PetscSectionResetClosurePermutation(PetscSection section)
2605d71ae5a4SJacob Faibussowitsch {
2606c459fbc1SJed Brown   PetscSectionClosurePermVal clVal;
2607c459fbc1SJed Brown 
2608c459fbc1SJed Brown   PetscFunctionBegin;
26093ba16761SJacob Faibussowitsch   if (!section->clHash) PetscFunctionReturn(PETSC_SUCCESS);
2610c459fbc1SJed Brown   kh_foreach_value(section->clHash, clVal, {
26119566063dSJacob Faibussowitsch     PetscCall(PetscFree(clVal.perm));
26129566063dSJacob Faibussowitsch     PetscCall(PetscFree(clVal.invPerm));
2613c459fbc1SJed Brown   });
2614c459fbc1SJed Brown   kh_destroy(ClPerm, section->clHash);
2615c459fbc1SJed Brown   section->clHash = NULL;
26163ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2617c459fbc1SJed Brown }
2618c459fbc1SJed Brown 
2619ea844a1aSMatthew Knepley /*@
2620583308b6SBarry Smith   PetscSectionReset - Frees all section data, the section is then as if `PetscSectionCreate()` had just been called.
2621ea844a1aSMatthew Knepley 
262240750d41SVaclav Hapla   Not Collective
2623ea844a1aSMatthew Knepley 
26242fe279fdSBarry Smith   Input Parameter:
2625cab54364SBarry Smith . s - the `PetscSection`
2626ea844a1aSMatthew Knepley 
2627ea844a1aSMatthew Knepley   Level: beginner
2628ea844a1aSMatthew Knepley 
2629cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreate()`
2630ea844a1aSMatthew Knepley @*/
2631d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionReset(PetscSection s)
2632d71ae5a4SJacob Faibussowitsch {
2633b778fa18SValeria Barra   PetscInt f, c;
2634ea844a1aSMatthew Knepley 
2635ea844a1aSMatthew Knepley   PetscFunctionBegin;
2636ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2637ea844a1aSMatthew Knepley   for (f = 0; f < s->numFields; ++f) {
26389566063dSJacob Faibussowitsch     PetscCall(PetscSectionDestroy(&s->field[f]));
26399566063dSJacob Faibussowitsch     PetscCall(PetscFree(s->fieldNames[f]));
264048a46eb9SPierre Jolivet     for (c = 0; c < s->numFieldComponents[f]; ++c) PetscCall(PetscFree(s->compNames[f][c]));
26419566063dSJacob Faibussowitsch     PetscCall(PetscFree(s->compNames[f]));
2642ea844a1aSMatthew Knepley   }
26439566063dSJacob Faibussowitsch   PetscCall(PetscFree(s->numFieldComponents));
26449566063dSJacob Faibussowitsch   PetscCall(PetscFree(s->fieldNames));
26459566063dSJacob Faibussowitsch   PetscCall(PetscFree(s->compNames));
26469566063dSJacob Faibussowitsch   PetscCall(PetscFree(s->field));
26479566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&s->bc));
26489566063dSJacob Faibussowitsch   PetscCall(PetscFree(s->bcIndices));
26499566063dSJacob Faibussowitsch   PetscCall(PetscFree2(s->atlasDof, s->atlasOff));
26509566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&s->clSection));
26519566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&s->clPoints));
26529566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&s->perm));
26533ec46b7bSMatthew G. Knepley   PetscCall(PetscBTDestroy(&s->blockStarts));
2654d4a1ad33SMatthew G. Knepley   PetscCall(PetscSectionResetClosurePermutation(s));
26559566063dSJacob Faibussowitsch   PetscCall(PetscSectionSymDestroy(&s->sym));
26569566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&s->clSection));
26579566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&s->clPoints));
265869c11d05SVaclav Hapla   PetscCall(PetscSectionInvalidateMaxDof_Internal(s));
2659ea844a1aSMatthew Knepley   s->pStart    = -1;
2660ea844a1aSMatthew Knepley   s->pEnd      = -1;
2661ea844a1aSMatthew Knepley   s->maxDof    = 0;
2662ea844a1aSMatthew Knepley   s->setup     = PETSC_FALSE;
2663ea844a1aSMatthew Knepley   s->numFields = 0;
2664ea844a1aSMatthew Knepley   s->clObj     = NULL;
26653ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2666ea844a1aSMatthew Knepley }
2667ea844a1aSMatthew Knepley 
2668ea844a1aSMatthew Knepley /*@
2669583308b6SBarry Smith   PetscSectionDestroy - Frees a `PetscSection`
2670ea844a1aSMatthew Knepley 
267140750d41SVaclav Hapla   Not Collective
2672ea844a1aSMatthew Knepley 
26732fe279fdSBarry Smith   Input Parameter:
2674cab54364SBarry Smith . s - the `PetscSection`
2675ea844a1aSMatthew Knepley 
2676ea844a1aSMatthew Knepley   Level: beginner
2677ea844a1aSMatthew Knepley 
2678cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreate()`, `PetscSectionReset()`
2679ea844a1aSMatthew Knepley @*/
2680d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionDestroy(PetscSection *s)
2681d71ae5a4SJacob Faibussowitsch {
2682ea844a1aSMatthew Knepley   PetscFunctionBegin;
26833ba16761SJacob Faibussowitsch   if (!*s) PetscFunctionReturn(PETSC_SUCCESS);
268462f17a49SStefano Zampini   PetscValidHeaderSpecific(*s, PETSC_SECTION_CLASSID, 1);
2685f4f49eeaSPierre Jolivet   if (--((PetscObject)*s)->refct > 0) {
2686ea844a1aSMatthew Knepley     *s = NULL;
26873ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
2688ea844a1aSMatthew Knepley   }
26899566063dSJacob Faibussowitsch   PetscCall(PetscSectionReset(*s));
26909566063dSJacob Faibussowitsch   PetscCall(PetscHeaderDestroy(s));
26913ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2692ea844a1aSMatthew Knepley }
2693ea844a1aSMatthew Knepley 
2694da8c939bSJacob Faibussowitsch static PetscErrorCode VecIntGetValuesSection_Private(const PetscInt *baseArray, PetscSection s, PetscInt point, const PetscInt **values)
2695d71ae5a4SJacob Faibussowitsch {
2696ea844a1aSMatthew Knepley   const PetscInt p = point - s->pStart;
2697ea844a1aSMatthew Knepley 
2698ea844a1aSMatthew Knepley   PetscFunctionBegin;
2699ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 2);
2700ea844a1aSMatthew Knepley   *values = &baseArray[s->atlasOff[p]];
27013ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2702ea844a1aSMatthew Knepley }
2703ea844a1aSMatthew Knepley 
2704da8c939bSJacob Faibussowitsch static PetscErrorCode VecIntSetValuesSection_Private(PetscInt *baseArray, PetscSection s, PetscInt point, const PetscInt values[], InsertMode mode)
2705d71ae5a4SJacob Faibussowitsch {
2706ea844a1aSMatthew Knepley   PetscInt      *array;
2707ea844a1aSMatthew Knepley   const PetscInt p           = point - s->pStart;
2708ea844a1aSMatthew Knepley   const PetscInt orientation = 0; /* Needs to be included for use in closure operations */
2709ea844a1aSMatthew Knepley   PetscInt       cDim        = 0;
2710ea844a1aSMatthew Knepley 
2711ea844a1aSMatthew Knepley   PetscFunctionBegin;
2712ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 2);
27139566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstraintDof(s, p, &cDim));
2714ea844a1aSMatthew Knepley   array = &baseArray[s->atlasOff[p]];
2715ea844a1aSMatthew Knepley   if (!cDim) {
2716ea844a1aSMatthew Knepley     if (orientation >= 0) {
2717ea844a1aSMatthew Knepley       const PetscInt dim = s->atlasDof[p];
2718ea844a1aSMatthew Knepley       PetscInt       i;
2719ea844a1aSMatthew Knepley 
2720ea844a1aSMatthew Knepley       if (mode == INSERT_VALUES) {
2721ad716f99SStefano Zampini         for (i = 0; i < dim; ++i) array[i] = values ? values[i] : i;
2722ea844a1aSMatthew Knepley       } else {
2723ea844a1aSMatthew Knepley         for (i = 0; i < dim; ++i) array[i] += values[i];
2724ea844a1aSMatthew Knepley       }
2725ea844a1aSMatthew Knepley     } else {
2726ea844a1aSMatthew Knepley       PetscInt offset = 0;
2727ea844a1aSMatthew Knepley       PetscInt j      = -1, field, i;
2728ea844a1aSMatthew Knepley 
2729ea844a1aSMatthew Knepley       for (field = 0; field < s->numFields; ++field) {
2730ea844a1aSMatthew Knepley         const PetscInt dim = s->field[field]->atlasDof[p];
2731ea844a1aSMatthew Knepley 
2732ad716f99SStefano Zampini         for (i = dim - 1; i >= 0; --i) array[++j] = values ? values[i + offset] : i + offset;
2733ea844a1aSMatthew Knepley         offset += dim;
2734ea844a1aSMatthew Knepley       }
2735ea844a1aSMatthew Knepley     }
2736ea844a1aSMatthew Knepley   } else {
2737ea844a1aSMatthew Knepley     if (orientation >= 0) {
2738ea844a1aSMatthew Knepley       const PetscInt  dim  = s->atlasDof[p];
2739ea844a1aSMatthew Knepley       PetscInt        cInd = 0, i;
2740ea844a1aSMatthew Knepley       const PetscInt *cDof;
2741ea844a1aSMatthew Knepley 
27429566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetConstraintIndices(s, point, &cDof));
2743ea844a1aSMatthew Knepley       if (mode == INSERT_VALUES) {
2744ea844a1aSMatthew Knepley         for (i = 0; i < dim; ++i) {
27459371c9d4SSatish Balay           if ((cInd < cDim) && (i == cDof[cInd])) {
27469371c9d4SSatish Balay             ++cInd;
27479371c9d4SSatish Balay             continue;
27489371c9d4SSatish Balay           }
2749ad716f99SStefano Zampini           array[i] = values ? values[i] : i;
2750ea844a1aSMatthew Knepley         }
2751ea844a1aSMatthew Knepley       } else {
2752ea844a1aSMatthew Knepley         for (i = 0; i < dim; ++i) {
27539371c9d4SSatish Balay           if ((cInd < cDim) && (i == cDof[cInd])) {
27549371c9d4SSatish Balay             ++cInd;
27559371c9d4SSatish Balay             continue;
27569371c9d4SSatish Balay           }
2757ea844a1aSMatthew Knepley           array[i] += values[i];
2758ea844a1aSMatthew Knepley         }
2759ea844a1aSMatthew Knepley       }
2760ea844a1aSMatthew Knepley     } else {
2761ea844a1aSMatthew Knepley       const PetscInt *cDof;
2762ea844a1aSMatthew Knepley       PetscInt        offset  = 0;
2763ea844a1aSMatthew Knepley       PetscInt        cOffset = 0;
2764ea844a1aSMatthew Knepley       PetscInt        j       = 0, field;
2765ea844a1aSMatthew Knepley 
27669566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetConstraintIndices(s, point, &cDof));
2767ea844a1aSMatthew Knepley       for (field = 0; field < s->numFields; ++field) {
2768ea844a1aSMatthew Knepley         const PetscInt dim  = s->field[field]->atlasDof[p];     /* PetscSectionGetFieldDof() */
2769ea844a1aSMatthew Knepley         const PetscInt tDim = s->field[field]->bc->atlasDof[p]; /* PetscSectionGetFieldConstraintDof() */
2770ea844a1aSMatthew Knepley         const PetscInt sDim = dim - tDim;
2771ea844a1aSMatthew Knepley         PetscInt       cInd = 0, i, k;
2772ea844a1aSMatthew Knepley 
2773ea844a1aSMatthew Knepley         for (i = 0, k = dim + offset - 1; i < dim; ++i, ++j, --k) {
27749371c9d4SSatish Balay           if ((cInd < sDim) && (j == cDof[cInd + cOffset])) {
27759371c9d4SSatish Balay             ++cInd;
27769371c9d4SSatish Balay             continue;
27779371c9d4SSatish Balay           }
2778ad716f99SStefano Zampini           array[j] = values ? values[k] : k;
2779ea844a1aSMatthew Knepley         }
2780ea844a1aSMatthew Knepley         offset += dim;
2781ea844a1aSMatthew Knepley         cOffset += dim - tDim;
2782ea844a1aSMatthew Knepley       }
2783ea844a1aSMatthew Knepley     }
2784ea844a1aSMatthew Knepley   }
27853ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2786ea844a1aSMatthew Knepley }
2787ea844a1aSMatthew Knepley 
2788cc4c1da9SBarry Smith /*@
278920662ed9SBarry Smith   PetscSectionHasConstraints - Determine whether a `PetscSection` has constrained dofs
2790ea844a1aSMatthew Knepley 
279140750d41SVaclav Hapla   Not Collective
2792ea844a1aSMatthew Knepley 
2793ea844a1aSMatthew Knepley   Input Parameter:
2794cab54364SBarry Smith . s - The `PetscSection`
2795ea844a1aSMatthew Knepley 
2796ea844a1aSMatthew Knepley   Output Parameter:
2797ea844a1aSMatthew Knepley . hasConstraints - flag indicating that the section has constrained dofs
2798ea844a1aSMatthew Knepley 
2799ea844a1aSMatthew Knepley   Level: intermediate
2800ea844a1aSMatthew Knepley 
2801cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSetConstraintIndices()`, `PetscSectionGetConstraintDof()`, `PetscSection`
2802ea844a1aSMatthew Knepley @*/
2803d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionHasConstraints(PetscSection s, PetscBool *hasConstraints)
2804d71ae5a4SJacob Faibussowitsch {
2805ea844a1aSMatthew Knepley   PetscFunctionBegin;
2806ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
28074f572ea9SToby Isaac   PetscAssertPointer(hasConstraints, 2);
2808ea844a1aSMatthew Knepley   *hasConstraints = s->bc ? PETSC_TRUE : PETSC_FALSE;
28093ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2810ea844a1aSMatthew Knepley }
2811ea844a1aSMatthew Knepley 
2812ea844a1aSMatthew Knepley /*@C
281320662ed9SBarry Smith   PetscSectionGetConstraintIndices - Get the point dof numbers, in [0, dof), which are constrained for a given point
2814ea844a1aSMatthew Knepley 
281540750d41SVaclav Hapla   Not Collective
2816ea844a1aSMatthew Knepley 
2817ea844a1aSMatthew Knepley   Input Parameters:
2818cab54364SBarry Smith + s     - The `PetscSection`
2819ea844a1aSMatthew Knepley - point - The point
2820ea844a1aSMatthew Knepley 
2821ea844a1aSMatthew Knepley   Output Parameter:
2822ea844a1aSMatthew Knepley . indices - The constrained dofs
2823ea844a1aSMatthew Knepley 
2824ea844a1aSMatthew Knepley   Level: intermediate
2825ea844a1aSMatthew Knepley 
282638b5cf2dSJacob Faibussowitsch   Fortran Notes:
282720662ed9SBarry Smith   Use `PetscSectionGetConstraintIndicesF90()` and `PetscSectionRestoreConstraintIndicesF90()`
2828cab54364SBarry Smith 
2829cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSetConstraintIndices()`, `PetscSectionGetConstraintDof()`, `PetscSection`
2830ea844a1aSMatthew Knepley @*/
2831cc4c1da9SBarry Smith PetscErrorCode PetscSectionGetConstraintIndices(PetscSection s, PetscInt point, const PetscInt *indices[])
2832d71ae5a4SJacob Faibussowitsch {
2833ea844a1aSMatthew Knepley   PetscFunctionBegin;
2834ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2835ea844a1aSMatthew Knepley   if (s->bc) {
2836da8c939bSJacob Faibussowitsch     PetscCall(VecIntGetValuesSection_Private(s->bcIndices, s->bc, point, indices));
2837ea844a1aSMatthew Knepley   } else *indices = NULL;
28383ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2839ea844a1aSMatthew Knepley }
2840ea844a1aSMatthew Knepley 
2841cc4c1da9SBarry Smith /*@
2842ea844a1aSMatthew Knepley   PetscSectionSetConstraintIndices - Set the point dof numbers, in [0, dof), which are constrained
2843ea844a1aSMatthew Knepley 
284440750d41SVaclav Hapla   Not Collective
2845ea844a1aSMatthew Knepley 
2846ea844a1aSMatthew Knepley   Input Parameters:
2847cab54364SBarry Smith + s       - The `PetscSection`
2848ea844a1aSMatthew Knepley . point   - The point
2849ea844a1aSMatthew Knepley - indices - The constrained dofs
2850ea844a1aSMatthew Knepley 
2851ea844a1aSMatthew Knepley   Level: intermediate
2852ea844a1aSMatthew Knepley 
285338b5cf2dSJacob Faibussowitsch   Fortran Notes:
2854cab54364SBarry Smith   Use `PetscSectionSetConstraintIndicesF90()`
2855cab54364SBarry Smith 
2856cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionGetConstraintIndices()`, `PetscSectionGetConstraintDof()`, `PetscSection`
2857ea844a1aSMatthew Knepley @*/
2858d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetConstraintIndices(PetscSection s, PetscInt point, const PetscInt indices[])
2859d71ae5a4SJacob Faibussowitsch {
2860ea844a1aSMatthew Knepley   PetscFunctionBegin;
2861ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2862ea844a1aSMatthew Knepley   if (s->bc) {
2863d57bb9dbSMatthew G. Knepley     const PetscInt dof  = s->atlasDof[point];
2864d57bb9dbSMatthew G. Knepley     const PetscInt cdof = s->bc->atlasDof[point];
2865d57bb9dbSMatthew G. Knepley     PetscInt       d;
2866d57bb9dbSMatthew G. Knepley 
2867ad716f99SStefano Zampini     if (indices)
2868ad540459SPierre 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]);
2869da8c939bSJacob Faibussowitsch     PetscCall(VecIntSetValuesSection_Private(s->bcIndices, s->bc, point, indices, INSERT_VALUES));
2870ea844a1aSMatthew Knepley   }
28713ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2872ea844a1aSMatthew Knepley }
2873ea844a1aSMatthew Knepley 
2874ea844a1aSMatthew Knepley /*@C
2875ea844a1aSMatthew Knepley   PetscSectionGetFieldConstraintIndices - Get the field dof numbers, in [0, fdof), which are constrained
2876ea844a1aSMatthew Knepley 
287740750d41SVaclav Hapla   Not Collective
2878ea844a1aSMatthew Knepley 
2879ea844a1aSMatthew Knepley   Input Parameters:
2880cab54364SBarry Smith + s     - The `PetscSection`
2881ea844a1aSMatthew Knepley . field - The field number
2882ea844a1aSMatthew Knepley - point - The point
2883ea844a1aSMatthew Knepley 
2884ea844a1aSMatthew Knepley   Output Parameter:
28859759eb26SJed Brown . indices - The constrained dofs sorted in ascending order
2886ea844a1aSMatthew Knepley 
2887ea844a1aSMatthew Knepley   Level: intermediate
2888ea844a1aSMatthew Knepley 
2889cab54364SBarry Smith   Note:
2890cab54364SBarry 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()`.
2891cab54364SBarry Smith 
289238b5cf2dSJacob Faibussowitsch   Fortran Notes:
289320662ed9SBarry Smith   Use `PetscSectionGetFieldConstraintIndicesF90()` and `PetscSectionRestoreFieldConstraintIndicesF90()`
2894cab54364SBarry Smith 
2895cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSetFieldConstraintIndices()`, `PetscSectionGetConstraintIndices()`, `PetscSectionGetConstraintDof()`, `PetscSection`
2896ea844a1aSMatthew Knepley @*/
2897d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetFieldConstraintIndices(PetscSection s, PetscInt point, PetscInt field, const PetscInt **indices)
2898d71ae5a4SJacob Faibussowitsch {
2899ea844a1aSMatthew Knepley   PetscFunctionBegin;
2900ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
29014f572ea9SToby Isaac   PetscAssertPointer(indices, 4);
29022abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field, s->numFields);
29039566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstraintIndices(s->field[field], point, indices));
29043ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2905ea844a1aSMatthew Knepley }
2906ea844a1aSMatthew Knepley 
2907ea844a1aSMatthew Knepley /*@C
2908ea844a1aSMatthew Knepley   PetscSectionSetFieldConstraintIndices - Set the field dof numbers, in [0, fdof), which are constrained
2909ea844a1aSMatthew Knepley 
291040750d41SVaclav Hapla   Not Collective
2911ea844a1aSMatthew Knepley 
2912ea844a1aSMatthew Knepley   Input Parameters:
2913cab54364SBarry Smith + s       - The `PetscSection`
2914ea844a1aSMatthew Knepley . point   - The point
2915ea844a1aSMatthew Knepley . field   - The field number
2916ea844a1aSMatthew Knepley - indices - The constrained dofs
2917ea844a1aSMatthew Knepley 
2918ea844a1aSMatthew Knepley   Level: intermediate
2919ea844a1aSMatthew Knepley 
292038b5cf2dSJacob Faibussowitsch   Fortran Notes:
2921cab54364SBarry Smith   Use `PetscSectionSetFieldConstraintIndicesF90()`
2922cab54364SBarry Smith 
2923cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSetConstraintIndices()`, `PetscSectionGetFieldConstraintIndices()`, `PetscSectionGetConstraintDof()`, `PetscSection`
2924ea844a1aSMatthew Knepley @*/
2925d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetFieldConstraintIndices(PetscSection s, PetscInt point, PetscInt field, const PetscInt indices[])
2926d71ae5a4SJacob Faibussowitsch {
2927ea844a1aSMatthew Knepley   PetscFunctionBegin;
2928ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
29292abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field, s->numFields);
29309566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetConstraintIndices(s->field[field], point, indices));
29313ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2932ea844a1aSMatthew Knepley }
2933ea844a1aSMatthew Knepley 
2934ea844a1aSMatthew Knepley /*@
2935ea844a1aSMatthew Knepley   PetscSectionPermute - Reorder the section according to the input point permutation
2936ea844a1aSMatthew Knepley 
293740750d41SVaclav Hapla   Collective
2938ea844a1aSMatthew Knepley 
2939d8d19677SJose E. Roman   Input Parameters:
2940cab54364SBarry Smith + section     - The `PetscSection` object
294138b5cf2dSJacob Faibussowitsch - permutation - The point permutation, old point p becomes new point perm[p]
2942ea844a1aSMatthew Knepley 
2943ea844a1aSMatthew Knepley   Output Parameter:
2944cab54364SBarry Smith . sectionNew - The permuted `PetscSection`
2945ea844a1aSMatthew Knepley 
2946ea844a1aSMatthew Knepley   Level: intermediate
2947ea844a1aSMatthew Knepley 
2948583308b6SBarry Smith   Note:
2949583308b6SBarry Smith   The data and the access to the data via `PetscSectionGetFieldOffset()` and `PetscSectionGetOffset()` are both changed in `sectionNew`
2950583308b6SBarry Smith 
2951583308b6SBarry Smith   Compare to `PetscSectionSetPermutation()`
2952583308b6SBarry Smith 
2953583308b6SBarry Smith .seealso: [PetscSection](sec_petscsection), `IS`, `PetscSection`, `MatPermute()`, `PetscSectionSetPermutation()`
2954ea844a1aSMatthew Knepley @*/
2955d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionPermute(PetscSection section, IS permutation, PetscSection *sectionNew)
2956d71ae5a4SJacob Faibussowitsch {
2957ea844a1aSMatthew Knepley   PetscSection    s = section, sNew;
2958ea844a1aSMatthew Knepley   const PetscInt *perm;
2959b778fa18SValeria Barra   PetscInt        numFields, f, c, numPoints, pStart, pEnd, p;
2960ea844a1aSMatthew Knepley 
2961ea844a1aSMatthew Knepley   PetscFunctionBegin;
2962ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1);
2963ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(permutation, IS_CLASSID, 2);
29644f572ea9SToby Isaac   PetscAssertPointer(sectionNew, 3);
29659566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject)s), &sNew));
29669566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetNumFields(s, &numFields));
29679566063dSJacob Faibussowitsch   if (numFields) PetscCall(PetscSectionSetNumFields(sNew, numFields));
2968ea844a1aSMatthew Knepley   for (f = 0; f < numFields; ++f) {
2969ea844a1aSMatthew Knepley     const char *name;
2970ea844a1aSMatthew Knepley     PetscInt    numComp;
2971ea844a1aSMatthew Knepley 
29729566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldName(s, f, &name));
29739566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldName(sNew, f, name));
29749566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldComponents(s, f, &numComp));
29759566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldComponents(sNew, f, numComp));
2976b778fa18SValeria Barra     for (c = 0; c < s->numFieldComponents[f]; ++c) {
29779566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetComponentName(s, f, c, &name));
29789566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetComponentName(sNew, f, c, name));
2979b778fa18SValeria Barra     }
2980ea844a1aSMatthew Knepley   }
29819566063dSJacob Faibussowitsch   PetscCall(ISGetLocalSize(permutation, &numPoints));
29829566063dSJacob Faibussowitsch   PetscCall(ISGetIndices(permutation, &perm));
29839566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
29849566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(sNew, pStart, pEnd));
298508401ef6SPierre 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);
2986ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
2987ea844a1aSMatthew Knepley     PetscInt dof, cdof;
2988ea844a1aSMatthew Knepley 
29899566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s, p, &dof));
29909566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(sNew, perm[p], dof));
29919566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s, p, &cdof));
29929566063dSJacob Faibussowitsch     if (cdof) PetscCall(PetscSectionSetConstraintDof(sNew, perm[p], cdof));
2993ea844a1aSMatthew Knepley     for (f = 0; f < numFields; ++f) {
29949566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldDof(s, p, f, &dof));
29959566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldDof(sNew, perm[p], f, dof));
29969566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintDof(s, p, f, &cdof));
29979566063dSJacob Faibussowitsch       if (cdof) PetscCall(PetscSectionSetFieldConstraintDof(sNew, perm[p], f, cdof));
2998ea844a1aSMatthew Knepley     }
2999ea844a1aSMatthew Knepley   }
30009566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(sNew));
3001ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
3002ea844a1aSMatthew Knepley     const PetscInt *cind;
3003ea844a1aSMatthew Knepley     PetscInt        cdof;
3004ea844a1aSMatthew Knepley 
30059566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s, p, &cdof));
3006ea844a1aSMatthew Knepley     if (cdof) {
30079566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetConstraintIndices(s, p, &cind));
30089566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetConstraintIndices(sNew, perm[p], cind));
3009ea844a1aSMatthew Knepley     }
3010ea844a1aSMatthew Knepley     for (f = 0; f < numFields; ++f) {
30119566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldConstraintDof(s, p, f, &cdof));
3012ea844a1aSMatthew Knepley       if (cdof) {
30139566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetFieldConstraintIndices(s, p, f, &cind));
30149566063dSJacob Faibussowitsch         PetscCall(PetscSectionSetFieldConstraintIndices(sNew, perm[p], f, cind));
3015ea844a1aSMatthew Knepley       }
3016ea844a1aSMatthew Knepley     }
3017ea844a1aSMatthew Knepley   }
30189566063dSJacob Faibussowitsch   PetscCall(ISRestoreIndices(permutation, &perm));
3019ea844a1aSMatthew Knepley   *sectionNew = sNew;
30203ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3021ea844a1aSMatthew Knepley }
3022ea844a1aSMatthew Knepley 
3023ea844a1aSMatthew Knepley /*@
302420662ed9SBarry Smith   PetscSectionSetClosureIndex - Create an internal data structure to speed up closure queries.
3025ea844a1aSMatthew Knepley 
302640750d41SVaclav Hapla   Collective
3027ea844a1aSMatthew Knepley 
3028ea844a1aSMatthew Knepley   Input Parameters:
3029cab54364SBarry Smith + section   - The `PetscSection`
3030cab54364SBarry Smith . obj       - A `PetscObject` which serves as the key for this index
3031cab54364SBarry Smith . clSection - `PetscSection` giving the size of the closure of each point
3032cab54364SBarry Smith - clPoints  - `IS` giving the points in each closure
3033ea844a1aSMatthew Knepley 
3034ea844a1aSMatthew Knepley   Level: advanced
3035ea844a1aSMatthew Knepley 
3036cab54364SBarry Smith   Note:
303720662ed9SBarry Smith   This function creates an internal map from each point to its closure. We compress out closure points with no dofs in this section.
303820662ed9SBarry Smith 
303938b5cf2dSJacob Faibussowitsch   Developer Notes:
304020662ed9SBarry Smith   The information provided here is completely opaque
3041cab54364SBarry Smith 
3042cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetClosureIndex()`, `DMPlexCreateClosureIndex()`
3043ea844a1aSMatthew Knepley @*/
3044d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetClosureIndex(PetscSection section, PetscObject obj, PetscSection clSection, IS clPoints)
3045d71ae5a4SJacob Faibussowitsch {
3046ea844a1aSMatthew Knepley   PetscFunctionBegin;
30473e03ebd8SStefano Zampini   PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1);
30483e03ebd8SStefano Zampini   PetscValidHeaderSpecific(clSection, PETSC_SECTION_CLASSID, 3);
30493e03ebd8SStefano Zampini   PetscValidHeaderSpecific(clPoints, IS_CLASSID, 4);
3050d4a1ad33SMatthew G. Knepley   if (section->clObj != obj) PetscCall(PetscSectionResetClosurePermutation(section));
3051ea844a1aSMatthew Knepley   section->clObj = obj;
30529566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)clSection));
30539566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)clPoints));
30549566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&section->clSection));
30559566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&section->clPoints));
3056ea844a1aSMatthew Knepley   section->clSection = clSection;
3057ea844a1aSMatthew Knepley   section->clPoints  = clPoints;
30583ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3059ea844a1aSMatthew Knepley }
3060ea844a1aSMatthew Knepley 
3061ea844a1aSMatthew Knepley /*@
3062cab54364SBarry Smith   PetscSectionGetClosureIndex - Get the cache of points in the closure of each point in the section set with `PetscSectionSetClosureIndex()`
3063ea844a1aSMatthew Knepley 
306440750d41SVaclav Hapla   Collective
3065ea844a1aSMatthew Knepley 
3066ea844a1aSMatthew Knepley   Input Parameters:
3067cab54364SBarry Smith + section - The `PetscSection`
3068cab54364SBarry Smith - obj     - A `PetscObject` which serves as the key for this index
3069ea844a1aSMatthew Knepley 
3070ea844a1aSMatthew Knepley   Output Parameters:
3071cab54364SBarry Smith + clSection - `PetscSection` giving the size of the closure of each point
3072cab54364SBarry Smith - clPoints  - `IS` giving the points in each closure
3073ea844a1aSMatthew Knepley 
3074ea844a1aSMatthew Knepley   Level: advanced
3075ea844a1aSMatthew Knepley 
3076cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSetClosureIndex()`, `DMPlexCreateClosureIndex()`
3077ea844a1aSMatthew Knepley @*/
3078d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetClosureIndex(PetscSection section, PetscObject obj, PetscSection *clSection, IS *clPoints)
3079d71ae5a4SJacob Faibussowitsch {
3080ea844a1aSMatthew Knepley   PetscFunctionBegin;
3081ea844a1aSMatthew Knepley   if (section->clObj == obj) {
3082ea844a1aSMatthew Knepley     if (clSection) *clSection = section->clSection;
3083ea844a1aSMatthew Knepley     if (clPoints) *clPoints = section->clPoints;
3084ea844a1aSMatthew Knepley   } else {
3085ea844a1aSMatthew Knepley     if (clSection) *clSection = NULL;
3086ea844a1aSMatthew Knepley     if (clPoints) *clPoints = NULL;
3087ea844a1aSMatthew Knepley   }
30883ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3089ea844a1aSMatthew Knepley }
3090ea844a1aSMatthew Knepley 
3091d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetClosurePermutation_Internal(PetscSection section, PetscObject obj, PetscInt depth, PetscInt clSize, PetscCopyMode mode, PetscInt *clPerm)
3092d71ae5a4SJacob Faibussowitsch {
3093ea844a1aSMatthew Knepley   PetscInt                    i;
3094c459fbc1SJed Brown   khiter_t                    iter;
3095c459fbc1SJed Brown   int                         new_entry;
3096c459fbc1SJed Brown   PetscSectionClosurePermKey  key = {depth, clSize};
3097c459fbc1SJed Brown   PetscSectionClosurePermVal *val;
3098ea844a1aSMatthew Knepley 
3099ea844a1aSMatthew Knepley   PetscFunctionBegin;
3100ea844a1aSMatthew Knepley   if (section->clObj != obj) {
31019566063dSJacob Faibussowitsch     PetscCall(PetscSectionDestroy(&section->clSection));
31029566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&section->clPoints));
3103ea844a1aSMatthew Knepley   }
3104ea844a1aSMatthew Knepley   section->clObj = obj;
31059566063dSJacob Faibussowitsch   if (!section->clHash) PetscCall(PetscClPermCreate(&section->clHash));
3106c459fbc1SJed Brown   iter = kh_put(ClPerm, section->clHash, key, &new_entry);
3107c459fbc1SJed Brown   val  = &kh_val(section->clHash, iter);
3108c459fbc1SJed Brown   if (!new_entry) {
31099566063dSJacob Faibussowitsch     PetscCall(PetscFree(val->perm));
31109566063dSJacob Faibussowitsch     PetscCall(PetscFree(val->invPerm));
3111c459fbc1SJed Brown   }
3112ea844a1aSMatthew Knepley   if (mode == PETSC_COPY_VALUES) {
31139566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(clSize, &val->perm));
31149566063dSJacob Faibussowitsch     PetscCall(PetscArraycpy(val->perm, clPerm, clSize));
3115ea844a1aSMatthew Knepley   } else if (mode == PETSC_OWN_POINTER) {
3116c459fbc1SJed Brown     val->perm = clPerm;
3117ea844a1aSMatthew Knepley   } else SETERRQ(PetscObjectComm(obj), PETSC_ERR_SUP, "Do not support borrowed arrays");
31189566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(clSize, &val->invPerm));
3119c459fbc1SJed Brown   for (i = 0; i < clSize; ++i) val->invPerm[clPerm[i]] = i;
31203ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3121ea844a1aSMatthew Knepley }
3122ea844a1aSMatthew Knepley 
3123ea844a1aSMatthew Knepley /*@
3124c459fbc1SJed Brown   PetscSectionSetClosurePermutation - Set the dof permutation for the closure of each cell in the section, meaning clPerm[newIndex] = oldIndex.
3125ea844a1aSMatthew Knepley 
3126ea844a1aSMatthew Knepley   Not Collective
3127ea844a1aSMatthew Knepley 
3128ea844a1aSMatthew Knepley   Input Parameters:
3129cab54364SBarry Smith + section - The `PetscSection`
3130cab54364SBarry Smith . obj     - A `PetscObject` which serves as the key for this index (usually a `DM`)
3131c459fbc1SJed Brown . depth   - Depth of points on which to apply the given permutation
3132ea844a1aSMatthew Knepley - perm    - Permutation of the cell dof closure
3133ea844a1aSMatthew Knepley 
3134cab54364SBarry Smith   Level: intermediate
3135cab54364SBarry Smith 
3136cab54364SBarry Smith   Notes:
3137c459fbc1SJed Brown   The specified permutation will only be applied to points at depth whose closure size matches the length of perm.  In a
3138c459fbc1SJed Brown   mixed-topology or variable-degree finite element space, this function can be called multiple times at each depth for
3139c459fbc1SJed Brown   each topology and degree.
3140c459fbc1SJed Brown 
3141c459fbc1SJed Brown   This approach assumes that (depth, len(perm)) uniquely identifies the desired permutation; this might not be true for
3142c459fbc1SJed Brown   exotic/enriched spaces on mixed topology meshes.
3143ea844a1aSMatthew Knepley 
3144cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `IS`, `PetscSectionGetClosurePermutation()`, `PetscSectionGetClosureIndex()`, `DMPlexCreateClosureIndex()`, `PetscCopyMode`
3145ea844a1aSMatthew Knepley @*/
3146d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetClosurePermutation(PetscSection section, PetscObject obj, PetscInt depth, IS perm)
3147d71ae5a4SJacob Faibussowitsch {
3148ea844a1aSMatthew Knepley   const PetscInt *clPerm = NULL;
3149ea844a1aSMatthew Knepley   PetscInt        clSize = 0;
3150ea844a1aSMatthew Knepley 
3151ea844a1aSMatthew Knepley   PetscFunctionBegin;
3152ea844a1aSMatthew Knepley   if (perm) {
31539566063dSJacob Faibussowitsch     PetscCall(ISGetLocalSize(perm, &clSize));
31549566063dSJacob Faibussowitsch     PetscCall(ISGetIndices(perm, &clPerm));
3155ea844a1aSMatthew Knepley   }
31569566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetClosurePermutation_Internal(section, obj, depth, clSize, PETSC_COPY_VALUES, (PetscInt *)clPerm));
31579566063dSJacob Faibussowitsch   if (perm) PetscCall(ISRestoreIndices(perm, &clPerm));
31583ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3159ea844a1aSMatthew Knepley }
3160ea844a1aSMatthew Knepley 
3161da8c939bSJacob Faibussowitsch static PetscErrorCode PetscSectionGetClosurePermutation_Private(PetscSection section, PetscObject obj, PetscInt depth, PetscInt size, const PetscInt *perm[])
3162d71ae5a4SJacob Faibussowitsch {
3163ea844a1aSMatthew Knepley   PetscFunctionBegin;
3164ea844a1aSMatthew Knepley   if (section->clObj == obj) {
3165c459fbc1SJed Brown     PetscSectionClosurePermKey k = {depth, size};
3166c459fbc1SJed Brown     PetscSectionClosurePermVal v;
3167da8c939bSJacob Faibussowitsch 
31689566063dSJacob Faibussowitsch     PetscCall(PetscClPermGet(section->clHash, k, &v));
3169c459fbc1SJed Brown     if (perm) *perm = v.perm;
3170ea844a1aSMatthew Knepley   } else {
3171ea844a1aSMatthew Knepley     if (perm) *perm = NULL;
3172ea844a1aSMatthew Knepley   }
31733ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3174ea844a1aSMatthew Knepley }
3175ea844a1aSMatthew Knepley 
3176ea844a1aSMatthew Knepley /*@
3177ea844a1aSMatthew Knepley   PetscSectionGetClosurePermutation - Get the dof permutation for the closure of each cell in the section, meaning clPerm[newIndex] = oldIndex.
3178ea844a1aSMatthew Knepley 
317940750d41SVaclav Hapla   Not Collective
3180ea844a1aSMatthew Knepley 
3181ea844a1aSMatthew Knepley   Input Parameters:
3182cab54364SBarry Smith + section - The `PetscSection`
3183cab54364SBarry Smith . obj     - A `PetscObject` which serves as the key for this index (usually a DM)
3184c459fbc1SJed Brown . depth   - Depth stratum on which to obtain closure permutation
3185c459fbc1SJed Brown - clSize  - Closure size to be permuted (e.g., may vary with element topology and degree)
3186ea844a1aSMatthew Knepley 
3187ea844a1aSMatthew Knepley   Output Parameter:
3188ea844a1aSMatthew Knepley . perm - The dof closure permutation
3189ea844a1aSMatthew Knepley 
3190ea844a1aSMatthew Knepley   Level: intermediate
3191ea844a1aSMatthew Knepley 
3192cab54364SBarry Smith   Note:
3193cab54364SBarry Smith   The user must destroy the `IS` that is returned.
3194cab54364SBarry Smith 
3195cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `IS`, `PetscSectionSetClosurePermutation()`, `PetscSectionGetClosureInversePermutation()`, `PetscSectionGetClosureIndex()`, `PetscSectionSetClosureIndex()`, `DMPlexCreateClosureIndex()`
3196ea844a1aSMatthew Knepley @*/
3197d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetClosurePermutation(PetscSection section, PetscObject obj, PetscInt depth, PetscInt clSize, IS *perm)
3198d71ae5a4SJacob Faibussowitsch {
3199da8c939bSJacob Faibussowitsch   const PetscInt *clPerm = NULL;
3200ea844a1aSMatthew Knepley 
3201ea844a1aSMatthew Knepley   PetscFunctionBegin;
3202da8c939bSJacob Faibussowitsch   PetscCall(PetscSectionGetClosurePermutation_Private(section, obj, depth, clSize, &clPerm));
32035f82726aSMatthew 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);
32049566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(PETSC_COMM_SELF, clSize, clPerm, PETSC_USE_POINTER, perm));
32053ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3206ea844a1aSMatthew Knepley }
3207ea844a1aSMatthew Knepley 
3208d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetClosureInversePermutation_Internal(PetscSection section, PetscObject obj, PetscInt depth, PetscInt size, const PetscInt *perm[])
3209d71ae5a4SJacob Faibussowitsch {
3210ea844a1aSMatthew Knepley   PetscFunctionBegin;
3211c459fbc1SJed Brown   if (section->clObj == obj && section->clHash) {
3212c459fbc1SJed Brown     PetscSectionClosurePermKey k = {depth, size};
3213c459fbc1SJed Brown     PetscSectionClosurePermVal v;
32149566063dSJacob Faibussowitsch     PetscCall(PetscClPermGet(section->clHash, k, &v));
3215c459fbc1SJed Brown     if (perm) *perm = v.invPerm;
3216ea844a1aSMatthew Knepley   } else {
3217ea844a1aSMatthew Knepley     if (perm) *perm = NULL;
3218ea844a1aSMatthew Knepley   }
32193ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3220ea844a1aSMatthew Knepley }
3221ea844a1aSMatthew Knepley 
3222ea844a1aSMatthew Knepley /*@
3223ea844a1aSMatthew Knepley   PetscSectionGetClosureInversePermutation - Get the inverse dof permutation for the closure of each cell in the section, meaning clPerm[oldIndex] = newIndex.
3224ea844a1aSMatthew Knepley 
322540750d41SVaclav Hapla   Not Collective
3226ea844a1aSMatthew Knepley 
3227ea844a1aSMatthew Knepley   Input Parameters:
3228cab54364SBarry Smith + section - The `PetscSection`
3229cab54364SBarry Smith . obj     - A `PetscObject` which serves as the key for this index (usually a `DM`)
3230c459fbc1SJed Brown . depth   - Depth stratum on which to obtain closure permutation
3231c459fbc1SJed Brown - clSize  - Closure size to be permuted (e.g., may vary with element topology and degree)
3232ea844a1aSMatthew Knepley 
32332fe279fdSBarry Smith   Output Parameter:
3234c459fbc1SJed Brown . perm - The dof closure permutation
3235ea844a1aSMatthew Knepley 
3236ea844a1aSMatthew Knepley   Level: intermediate
3237ea844a1aSMatthew Knepley 
3238cab54364SBarry Smith   Note:
3239cab54364SBarry Smith   The user must destroy the `IS` that is returned.
3240cab54364SBarry Smith 
3241cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `IS`, `PetscSectionSetClosurePermutation()`, `PetscSectionGetClosureIndex()`, `PetscSectionSetClosureIndex()`, `DMPlexCreateClosureIndex()`
3242ea844a1aSMatthew Knepley @*/
3243d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetClosureInversePermutation(PetscSection section, PetscObject obj, PetscInt depth, PetscInt clSize, IS *perm)
3244d71ae5a4SJacob Faibussowitsch {
3245da8c939bSJacob Faibussowitsch   const PetscInt *clPerm = NULL;
3246ea844a1aSMatthew Knepley 
3247ea844a1aSMatthew Knepley   PetscFunctionBegin;
32489566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetClosureInversePermutation_Internal(section, obj, depth, clSize, &clPerm));
32499566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(PETSC_COMM_SELF, clSize, clPerm, PETSC_USE_POINTER, perm));
32503ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3251ea844a1aSMatthew Knepley }
3252ea844a1aSMatthew Knepley 
3253ea844a1aSMatthew Knepley /*@
3254583308b6SBarry Smith   PetscSectionGetField - Get the `PetscSection` associated with a single field
3255ea844a1aSMatthew Knepley 
3256ea844a1aSMatthew Knepley   Input Parameters:
3257cab54364SBarry Smith + s     - The `PetscSection`
3258ea844a1aSMatthew Knepley - field - The field number
3259ea844a1aSMatthew Knepley 
3260ea844a1aSMatthew Knepley   Output Parameter:
3261583308b6SBarry Smith . subs - The `PetscSection` for the given field, note the chart of `subs` is not set
3262ea844a1aSMatthew Knepley 
3263ea844a1aSMatthew Knepley   Level: intermediate
3264ea844a1aSMatthew Knepley 
3265cab54364SBarry Smith   Note:
3266cab54364SBarry Smith   Does not increase the reference count of the selected sub-section. There is no matching `PetscSectionRestoreField()`
3267cab54364SBarry Smith 
3268cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `IS`, `PetscSectionSetNumFields()`
3269ea844a1aSMatthew Knepley @*/
3270d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetField(PetscSection s, PetscInt field, PetscSection *subs)
3271d71ae5a4SJacob Faibussowitsch {
3272ea844a1aSMatthew Knepley   PetscFunctionBegin;
3273ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
32744f572ea9SToby Isaac   PetscAssertPointer(subs, 3);
32752abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field, s->numFields);
3276ea844a1aSMatthew Knepley   *subs = s->field[field];
32773ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3278ea844a1aSMatthew Knepley }
3279ea844a1aSMatthew Knepley 
3280ea844a1aSMatthew Knepley PetscClassId      PETSC_SECTION_SYM_CLASSID;
3281ea844a1aSMatthew Knepley PetscFunctionList PetscSectionSymList = NULL;
3282ea844a1aSMatthew Knepley 
3283ea844a1aSMatthew Knepley /*@
3284cab54364SBarry Smith   PetscSectionSymCreate - Creates an empty `PetscSectionSym` object.
3285ea844a1aSMatthew Knepley 
3286ea844a1aSMatthew Knepley   Collective
3287ea844a1aSMatthew Knepley 
3288ea844a1aSMatthew Knepley   Input Parameter:
3289ea844a1aSMatthew Knepley . comm - the MPI communicator
3290ea844a1aSMatthew Knepley 
3291ea844a1aSMatthew Knepley   Output Parameter:
3292ea844a1aSMatthew Knepley . sym - pointer to the new set of symmetries
3293ea844a1aSMatthew Knepley 
3294ea844a1aSMatthew Knepley   Level: developer
3295ea844a1aSMatthew Knepley 
3296cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionSym`, `PetscSectionSymDestroy()`
3297ea844a1aSMatthew Knepley @*/
3298d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSymCreate(MPI_Comm comm, PetscSectionSym *sym)
3299d71ae5a4SJacob Faibussowitsch {
3300ea844a1aSMatthew Knepley   PetscFunctionBegin;
33014f572ea9SToby Isaac   PetscAssertPointer(sym, 2);
33029566063dSJacob Faibussowitsch   PetscCall(ISInitializePackage());
3303377f809aSBarry Smith 
33049566063dSJacob Faibussowitsch   PetscCall(PetscHeaderCreate(*sym, PETSC_SECTION_SYM_CLASSID, "PetscSectionSym", "Section Symmetry", "IS", comm, PetscSectionSymDestroy, PetscSectionSymView));
33053ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3306ea844a1aSMatthew Knepley }
3307ea844a1aSMatthew Knepley 
3308cc4c1da9SBarry Smith /*@
3309cab54364SBarry Smith   PetscSectionSymSetType - Builds a `PetscSectionSym`, for a particular implementation.
3310ea844a1aSMatthew Knepley 
331140750d41SVaclav Hapla   Collective
3312ea844a1aSMatthew Knepley 
3313ea844a1aSMatthew Knepley   Input Parameters:
3314ea844a1aSMatthew Knepley + sym    - The section symmetry object
3315ea844a1aSMatthew Knepley - method - The name of the section symmetry type
3316ea844a1aSMatthew Knepley 
3317ea844a1aSMatthew Knepley   Level: developer
3318ea844a1aSMatthew Knepley 
3319cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionSymType`, `PetscSectionSymGetType()`, `PetscSectionSymCreate()`
3320ea844a1aSMatthew Knepley @*/
3321d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSymSetType(PetscSectionSym sym, PetscSectionSymType method)
3322d71ae5a4SJacob Faibussowitsch {
3323ea844a1aSMatthew Knepley   PetscErrorCode (*r)(PetscSectionSym);
3324ea844a1aSMatthew Knepley   PetscBool match;
3325ea844a1aSMatthew Knepley 
3326ea844a1aSMatthew Knepley   PetscFunctionBegin;
3327ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID, 1);
33289566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)sym, method, &match));
33293ba16761SJacob Faibussowitsch   if (match) PetscFunctionReturn(PETSC_SUCCESS);
3330ea844a1aSMatthew Knepley 
33319566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListFind(PetscSectionSymList, method, &r));
33326adde796SStefano Zampini   PetscCheck(r, PetscObjectComm((PetscObject)sym), PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown PetscSectionSym type: %s", method);
3333dbbe0bcdSBarry Smith   PetscTryTypeMethod(sym, destroy);
3334ea844a1aSMatthew Knepley   sym->ops->destroy = NULL;
3335dbbe0bcdSBarry Smith 
33369566063dSJacob Faibussowitsch   PetscCall((*r)(sym));
33379566063dSJacob Faibussowitsch   PetscCall(PetscObjectChangeTypeName((PetscObject)sym, method));
33383ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3339ea844a1aSMatthew Knepley }
3340ea844a1aSMatthew Knepley 
3341cc4c1da9SBarry Smith /*@
3342cab54364SBarry Smith   PetscSectionSymGetType - Gets the section symmetry type name (as a string) from the `PetscSectionSym`.
3343ea844a1aSMatthew Knepley 
3344ea844a1aSMatthew Knepley   Not Collective
3345ea844a1aSMatthew Knepley 
3346ea844a1aSMatthew Knepley   Input Parameter:
3347ea844a1aSMatthew Knepley . sym - The section symmetry
3348ea844a1aSMatthew Knepley 
3349ea844a1aSMatthew Knepley   Output Parameter:
3350ea844a1aSMatthew Knepley . type - The index set type name
3351ea844a1aSMatthew Knepley 
3352ea844a1aSMatthew Knepley   Level: developer
3353ea844a1aSMatthew Knepley 
3354cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionSymType`, `PetscSectionSymSetType()`, `PetscSectionSymCreate()`
3355ea844a1aSMatthew Knepley @*/
3356d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSymGetType(PetscSectionSym sym, PetscSectionSymType *type)
3357d71ae5a4SJacob Faibussowitsch {
3358ea844a1aSMatthew Knepley   PetscFunctionBegin;
3359ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID, 1);
33604f572ea9SToby Isaac   PetscAssertPointer(type, 2);
3361ea844a1aSMatthew Knepley   *type = ((PetscObject)sym)->type_name;
33623ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3363ea844a1aSMatthew Knepley }
3364ea844a1aSMatthew Knepley 
3365ea844a1aSMatthew Knepley /*@C
3366cab54364SBarry Smith   PetscSectionSymRegister - Registers a new section symmetry implementation
3367ea844a1aSMatthew Knepley 
3368cc4c1da9SBarry Smith   Not Collective, No Fortran Support
3369ea844a1aSMatthew Knepley 
3370ea844a1aSMatthew Knepley   Input Parameters:
33712fe279fdSBarry Smith + sname    - The name of a new user-defined creation routine
33722fe279fdSBarry Smith - function - The creation routine itself
3373ea844a1aSMatthew Knepley 
3374ea844a1aSMatthew Knepley   Level: developer
3375ea844a1aSMatthew Knepley 
3376cab54364SBarry Smith   Notes:
3377cab54364SBarry Smith   `PetscSectionSymRegister()` may be called multiple times to add several user-defined vectors
3378cab54364SBarry Smith 
3379cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionSymType`, `PetscSectionSymCreate()`, `PetscSectionSymSetType()`
3380ea844a1aSMatthew Knepley @*/
3381d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSymRegister(const char sname[], PetscErrorCode (*function)(PetscSectionSym))
3382d71ae5a4SJacob Faibussowitsch {
3383ea844a1aSMatthew Knepley   PetscFunctionBegin;
33849566063dSJacob Faibussowitsch   PetscCall(ISInitializePackage());
33859566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListAdd(&PetscSectionSymList, sname, function));
33863ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3387ea844a1aSMatthew Knepley }
3388ea844a1aSMatthew Knepley 
3389ea844a1aSMatthew Knepley /*@
3390ea844a1aSMatthew Knepley   PetscSectionSymDestroy - Destroys a section symmetry.
3391ea844a1aSMatthew Knepley 
339240750d41SVaclav Hapla   Collective
3393ea844a1aSMatthew Knepley 
33942fe279fdSBarry Smith   Input Parameter:
3395ea844a1aSMatthew Knepley . sym - the section symmetry
3396ea844a1aSMatthew Knepley 
3397ea844a1aSMatthew Knepley   Level: developer
3398ea844a1aSMatthew Knepley 
339942747ad1SJacob Faibussowitsch .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionSymCreate()`
3400ea844a1aSMatthew Knepley @*/
3401d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSymDestroy(PetscSectionSym *sym)
3402d71ae5a4SJacob Faibussowitsch {
3403ea844a1aSMatthew Knepley   SymWorkLink link, next;
3404ea844a1aSMatthew Knepley 
3405ea844a1aSMatthew Knepley   PetscFunctionBegin;
34063ba16761SJacob Faibussowitsch   if (!*sym) PetscFunctionReturn(PETSC_SUCCESS);
3407f4f49eeaSPierre Jolivet   PetscValidHeaderSpecific(*sym, PETSC_SECTION_SYM_CLASSID, 1);
3408f4f49eeaSPierre Jolivet   if (--((PetscObject)*sym)->refct > 0) {
34099371c9d4SSatish Balay     *sym = NULL;
34103ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
3411ea844a1aSMatthew Knepley   }
3412213acdd3SPierre Jolivet   PetscTryTypeMethod(*sym, destroy);
3413c9cc58a2SBarry Smith   PetscCheck(!(*sym)->workout, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "Work array still checked out");
3414ea844a1aSMatthew Knepley   for (link = (*sym)->workin; link; link = next) {
34150c99d500SBarry Smith     PetscInt    **perms = (PetscInt **)link->perms;
34160c99d500SBarry Smith     PetscScalar **rots  = (PetscScalar **)link->rots;
34170c99d500SBarry Smith     PetscCall(PetscFree2(perms, rots));
3418ea844a1aSMatthew Knepley     next = link->next;
34199566063dSJacob Faibussowitsch     PetscCall(PetscFree(link));
3420ea844a1aSMatthew Knepley   }
3421ea844a1aSMatthew Knepley   (*sym)->workin = NULL;
34229566063dSJacob Faibussowitsch   PetscCall(PetscHeaderDestroy(sym));
34233ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3424ea844a1aSMatthew Knepley }
3425ea844a1aSMatthew Knepley 
3426ffeef943SBarry Smith /*@
3427ea844a1aSMatthew Knepley   PetscSectionSymView - Displays a section symmetry
3428ea844a1aSMatthew Knepley 
342940750d41SVaclav Hapla   Collective
3430ea844a1aSMatthew Knepley 
3431ea844a1aSMatthew Knepley   Input Parameters:
3432ea844a1aSMatthew Knepley + sym    - the index set
3433cab54364SBarry Smith - viewer - viewer used to display the set, for example `PETSC_VIEWER_STDOUT_SELF`.
3434ea844a1aSMatthew Knepley 
3435ea844a1aSMatthew Knepley   Level: developer
3436ea844a1aSMatthew Knepley 
3437cab54364SBarry Smith .seealso: `PetscSectionSym`, `PetscViewer`, `PetscViewerASCIIOpen()`
3438ea844a1aSMatthew Knepley @*/
3439d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSymView(PetscSectionSym sym, PetscViewer viewer)
3440d71ae5a4SJacob Faibussowitsch {
3441ea844a1aSMatthew Knepley   PetscFunctionBegin;
3442ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID, 1);
344348a46eb9SPierre Jolivet   if (!viewer) PetscCall(PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)sym), &viewer));
3444ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(viewer, PETSC_VIEWER_CLASSID, 2);
3445ea844a1aSMatthew Knepley   PetscCheckSameComm(sym, 1, viewer, 2);
34469566063dSJacob Faibussowitsch   PetscCall(PetscObjectPrintClassNamePrefixType((PetscObject)sym, viewer));
3447dbbe0bcdSBarry Smith   PetscTryTypeMethod(sym, view, viewer);
34483ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3449ea844a1aSMatthew Knepley }
3450ea844a1aSMatthew Knepley 
3451ea844a1aSMatthew Knepley /*@
3452ea844a1aSMatthew Knepley   PetscSectionSetSym - Set the symmetries for the data referred to by the section
3453ea844a1aSMatthew Knepley 
345440750d41SVaclav Hapla   Collective
3455ea844a1aSMatthew Knepley 
3456ea844a1aSMatthew Knepley   Input Parameters:
3457ea844a1aSMatthew Knepley + section - the section describing data layout
3458ea844a1aSMatthew Knepley - sym     - the symmetry describing the affect of orientation on the access of the data
3459ea844a1aSMatthew Knepley 
3460ea844a1aSMatthew Knepley   Level: developer
3461ea844a1aSMatthew Knepley 
3462cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionGetSym()`, `PetscSectionSymCreate()`
3463ea844a1aSMatthew Knepley @*/
3464d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetSym(PetscSection section, PetscSectionSym sym)
3465d71ae5a4SJacob Faibussowitsch {
3466ea844a1aSMatthew Knepley   PetscFunctionBegin;
3467ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1);
3468f4f49eeaSPierre Jolivet   PetscCall(PetscSectionSymDestroy(&section->sym));
3469ea844a1aSMatthew Knepley   if (sym) {
3470ea844a1aSMatthew Knepley     PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID, 2);
3471ea844a1aSMatthew Knepley     PetscCheckSameComm(section, 1, sym, 2);
34729566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject)sym));
3473ea844a1aSMatthew Knepley   }
3474ea844a1aSMatthew Knepley   section->sym = sym;
34753ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3476ea844a1aSMatthew Knepley }
3477ea844a1aSMatthew Knepley 
3478ea844a1aSMatthew Knepley /*@
3479ea844a1aSMatthew Knepley   PetscSectionGetSym - Get the symmetries for the data referred to by the section
3480ea844a1aSMatthew Knepley 
348140750d41SVaclav Hapla   Not Collective
3482ea844a1aSMatthew Knepley 
34832fe279fdSBarry Smith   Input Parameter:
3484ea844a1aSMatthew Knepley . section - the section describing data layout
3485ea844a1aSMatthew Knepley 
34862fe279fdSBarry Smith   Output Parameter:
348720662ed9SBarry Smith . sym - the symmetry describing the affect of orientation on the access of the data, provided previously by `PetscSectionSetSym()`
3488ea844a1aSMatthew Knepley 
3489ea844a1aSMatthew Knepley   Level: developer
3490ea844a1aSMatthew Knepley 
3491cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionSetSym()`, `PetscSectionSymCreate()`
3492ea844a1aSMatthew Knepley @*/
3493d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetSym(PetscSection section, PetscSectionSym *sym)
3494d71ae5a4SJacob Faibussowitsch {
3495ea844a1aSMatthew Knepley   PetscFunctionBegin;
3496ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1);
3497ea844a1aSMatthew Knepley   *sym = section->sym;
34983ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3499ea844a1aSMatthew Knepley }
3500ea844a1aSMatthew Knepley 
3501ea844a1aSMatthew Knepley /*@
3502ea844a1aSMatthew Knepley   PetscSectionSetFieldSym - Set the symmetries for the data referred to by a field of the section
3503ea844a1aSMatthew Knepley 
350440750d41SVaclav Hapla   Collective
3505ea844a1aSMatthew Knepley 
3506ea844a1aSMatthew Knepley   Input Parameters:
3507ea844a1aSMatthew Knepley + section - the section describing data layout
3508ea844a1aSMatthew Knepley . field   - the field number
3509ea844a1aSMatthew Knepley - sym     - the symmetry describing the affect of orientation on the access of the data
3510ea844a1aSMatthew Knepley 
3511ea844a1aSMatthew Knepley   Level: developer
3512ea844a1aSMatthew Knepley 
3513cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionGetFieldSym()`, `PetscSectionSymCreate()`
3514ea844a1aSMatthew Knepley @*/
3515d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetFieldSym(PetscSection section, PetscInt field, PetscSectionSym sym)
3516d71ae5a4SJacob Faibussowitsch {
3517ea844a1aSMatthew Knepley   PetscFunctionBegin;
3518ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1);
35192abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field, section->numFields);
35209566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetSym(section->field[field], sym));
35213ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3522ea844a1aSMatthew Knepley }
3523ea844a1aSMatthew Knepley 
3524ea844a1aSMatthew Knepley /*@
3525ea844a1aSMatthew Knepley   PetscSectionGetFieldSym - Get the symmetries for the data referred to by a field of the section
3526ea844a1aSMatthew Knepley 
352740750d41SVaclav Hapla   Collective
3528ea844a1aSMatthew Knepley 
3529ea844a1aSMatthew Knepley   Input Parameters:
3530ea844a1aSMatthew Knepley + section - the section describing data layout
3531ea844a1aSMatthew Knepley - field   - the field number
3532ea844a1aSMatthew Knepley 
35332fe279fdSBarry Smith   Output Parameter:
3534ea844a1aSMatthew Knepley . sym - the symmetry describing the affect of orientation on the access of the data
3535ea844a1aSMatthew Knepley 
3536ea844a1aSMatthew Knepley   Level: developer
3537ea844a1aSMatthew Knepley 
3538cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionSetFieldSym()`, `PetscSectionSymCreate()`
3539ea844a1aSMatthew Knepley @*/
3540d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetFieldSym(PetscSection section, PetscInt field, PetscSectionSym *sym)
3541d71ae5a4SJacob Faibussowitsch {
3542ea844a1aSMatthew Knepley   PetscFunctionBegin;
3543ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1);
35442abc8c78SJacob Faibussowitsch   PetscSectionCheckValidField(field, section->numFields);
3545ea844a1aSMatthew Knepley   *sym = section->field[field]->sym;
35463ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3547ea844a1aSMatthew Knepley }
3548ea844a1aSMatthew Knepley 
3549ea844a1aSMatthew Knepley /*@C
3550cab54364SBarry Smith   PetscSectionGetPointSyms - Get the symmetries for a set of points in a `PetscSection` under specific orientations.
3551ea844a1aSMatthew Knepley 
355240750d41SVaclav Hapla   Not Collective
3553ea844a1aSMatthew Knepley 
3554ea844a1aSMatthew Knepley   Input Parameters:
3555ea844a1aSMatthew Knepley + section   - the section
3556ea844a1aSMatthew Knepley . numPoints - the number of points
355720662ed9SBarry Smith - points    - an array of size 2 * `numPoints`, containing a list of (point, orientation) pairs. (An orientation is an
355820662ed9SBarry Smith               arbitrary integer: its interpretation is up to sym.  Orientations are used by `DM`: for their interpretation in that
355920662ed9SBarry Smith               context, see `DMPlexGetConeOrientation()`).
3560ea844a1aSMatthew Knepley 
3561d8d19677SJose E. Roman   Output Parameters:
356220662ed9SBarry Smith + perms - The permutations for the given orientations (or `NULL` if there is no symmetry or the permutation is the identity).
356320662ed9SBarry Smith - rots  - The field rotations symmetries for the given orientations (or `NULL` if there is no symmetry or the rotations are all
3564ea844a1aSMatthew Knepley     identity).
3565ea844a1aSMatthew Knepley 
3566ea844a1aSMatthew Knepley   Example of usage, gathering dofs into a local array (lArray) from a section array (sArray):
3567ea844a1aSMatthew Knepley .vb
3568ea844a1aSMatthew Knepley      const PetscInt    **perms;
3569ea844a1aSMatthew Knepley      const PetscScalar **rots;
3570ea844a1aSMatthew Knepley      PetscInt            lOffset;
3571ea844a1aSMatthew Knepley 
3572ea844a1aSMatthew Knepley      PetscSectionGetPointSyms(section,numPoints,points,&perms,&rots);
3573ea844a1aSMatthew Knepley      for (i = 0, lOffset = 0; i < numPoints; i++) {
3574ea844a1aSMatthew Knepley        PetscInt           point = points[2*i], dof, sOffset;
3575ea844a1aSMatthew Knepley        const PetscInt    *perm  = perms ? perms[i] : NULL;
3576ea844a1aSMatthew Knepley        const PetscScalar *rot   = rots  ? rots[i]  : NULL;
3577ea844a1aSMatthew Knepley 
3578ea844a1aSMatthew Knepley        PetscSectionGetDof(section,point,&dof);
3579ea844a1aSMatthew Knepley        PetscSectionGetOffset(section,point,&sOffset);
3580ea844a1aSMatthew Knepley 
3581ea844a1aSMatthew Knepley        if (perm) {for (j = 0; j < dof; j++) {lArray[lOffset + perm[j]]  = sArray[sOffset + j];}}
3582ea844a1aSMatthew Knepley        else      {for (j = 0; j < dof; j++) {lArray[lOffset +      j ]  = sArray[sOffset + j];}}
3583ea844a1aSMatthew Knepley        if (rot)  {for (j = 0; j < dof; j++) {lArray[lOffset +      j ] *= rot[j];             }}
3584ea844a1aSMatthew Knepley        lOffset += dof;
3585ea844a1aSMatthew Knepley      }
3586ea844a1aSMatthew Knepley      PetscSectionRestorePointSyms(section,numPoints,points,&perms,&rots);
3587ea844a1aSMatthew Knepley .ve
3588ea844a1aSMatthew Knepley 
3589ea844a1aSMatthew Knepley   Example of usage, adding dofs into a section array (sArray) from a local array (lArray):
3590ea844a1aSMatthew Knepley .vb
3591ea844a1aSMatthew Knepley      const PetscInt    **perms;
3592ea844a1aSMatthew Knepley      const PetscScalar **rots;
3593ea844a1aSMatthew Knepley      PetscInt            lOffset;
3594ea844a1aSMatthew Knepley 
3595ea844a1aSMatthew Knepley      PetscSectionGetPointSyms(section,numPoints,points,&perms,&rots);
3596ea844a1aSMatthew Knepley      for (i = 0, lOffset = 0; i < numPoints; i++) {
3597ea844a1aSMatthew Knepley        PetscInt           point = points[2*i], dof, sOffset;
3598ea844a1aSMatthew Knepley        const PetscInt    *perm  = perms ? perms[i] : NULL;
3599ea844a1aSMatthew Knepley        const PetscScalar *rot   = rots  ? rots[i]  : NULL;
3600ea844a1aSMatthew Knepley 
3601ea844a1aSMatthew Knepley        PetscSectionGetDof(section,point,&dof);
3602ea844a1aSMatthew Knepley        PetscSectionGetOffset(section,point,&sOff);
3603ea844a1aSMatthew Knepley 
3604ea844a1aSMatthew Knepley        if (perm) {for (j = 0; j < dof; j++) {sArray[sOffset + j] += lArray[lOffset + perm[j]] * (rot ? PetscConj(rot[perm[j]]) : 1.);}}
3605ea844a1aSMatthew Knepley        else      {for (j = 0; j < dof; j++) {sArray[sOffset + j] += lArray[lOffset +      j ] * (rot ? PetscConj(rot[     j ]) : 1.);}}
3606ea844a1aSMatthew Knepley        offset += dof;
3607ea844a1aSMatthew Knepley      }
3608ea844a1aSMatthew Knepley      PetscSectionRestorePointSyms(section,numPoints,points,&perms,&rots);
3609ea844a1aSMatthew Knepley .ve
3610ea844a1aSMatthew Knepley 
3611ea844a1aSMatthew Knepley   Level: developer
3612ea844a1aSMatthew Knepley 
3613583308b6SBarry Smith   Notes:
361420662ed9SBarry Smith   `PetscSectionSetSym()` must have been previously called to provide the symmetries to the `PetscSection`
361520662ed9SBarry Smith 
361620662ed9SBarry Smith   Use `PetscSectionRestorePointSyms()` when finished with the data
361720662ed9SBarry Smith 
3618cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionRestorePointSyms()`, `PetscSectionSymCreate()`, `PetscSectionSetSym()`, `PetscSectionGetSym()`
3619ea844a1aSMatthew Knepley @*/
3620d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetPointSyms(PetscSection section, PetscInt numPoints, const PetscInt *points, const PetscInt ***perms, const PetscScalar ***rots)
3621d71ae5a4SJacob Faibussowitsch {
3622ea844a1aSMatthew Knepley   PetscSectionSym sym;
3623ea844a1aSMatthew Knepley 
3624ea844a1aSMatthew Knepley   PetscFunctionBegin;
3625ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1);
36264f572ea9SToby Isaac   if (numPoints) PetscAssertPointer(points, 3);
3627ea844a1aSMatthew Knepley   if (perms) *perms = NULL;
3628ea844a1aSMatthew Knepley   if (rots) *rots = NULL;
3629ea844a1aSMatthew Knepley   sym = section->sym;
3630ea844a1aSMatthew Knepley   if (sym && (perms || rots)) {
3631ea844a1aSMatthew Knepley     SymWorkLink link;
3632ea844a1aSMatthew Knepley 
3633ea844a1aSMatthew Knepley     if (sym->workin) {
3634ea844a1aSMatthew Knepley       link        = sym->workin;
3635ea844a1aSMatthew Knepley       sym->workin = sym->workin->next;
3636ea844a1aSMatthew Knepley     } else {
36374dfa11a4SJacob Faibussowitsch       PetscCall(PetscNew(&link));
3638ea844a1aSMatthew Knepley     }
3639ea844a1aSMatthew Knepley     if (numPoints > link->numPoints) {
36400c99d500SBarry Smith       PetscInt    **perms = (PetscInt **)link->perms;
36410c99d500SBarry Smith       PetscScalar **rots  = (PetscScalar **)link->rots;
36420c99d500SBarry Smith       PetscCall(PetscFree2(perms, rots));
36430c99d500SBarry Smith       PetscCall(PetscMalloc2(numPoints, (PetscInt ***)&link->perms, numPoints, (PetscScalar ***)&link->rots));
3644ea844a1aSMatthew Knepley       link->numPoints = numPoints;
3645ea844a1aSMatthew Knepley     }
3646ea844a1aSMatthew Knepley     link->next   = sym->workout;
3647ea844a1aSMatthew Knepley     sym->workout = link;
36489566063dSJacob Faibussowitsch     PetscCall(PetscArrayzero((PetscInt **)link->perms, numPoints));
36499566063dSJacob Faibussowitsch     PetscCall(PetscArrayzero((PetscInt **)link->rots, numPoints));
36509927e4dfSBarry Smith     PetscUseTypeMethod(sym, getpoints, section, numPoints, points, link->perms, link->rots);
3651ea844a1aSMatthew Knepley     if (perms) *perms = link->perms;
3652ea844a1aSMatthew Knepley     if (rots) *rots = link->rots;
3653ea844a1aSMatthew Knepley   }
36543ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3655ea844a1aSMatthew Knepley }
3656ea844a1aSMatthew Knepley 
3657ea844a1aSMatthew Knepley /*@C
3658cab54364SBarry Smith   PetscSectionRestorePointSyms - Restore the symmetries returned by `PetscSectionGetPointSyms()`
3659ea844a1aSMatthew Knepley 
366040750d41SVaclav Hapla   Not Collective
3661ea844a1aSMatthew Knepley 
3662ea844a1aSMatthew Knepley   Input Parameters:
3663ea844a1aSMatthew Knepley + section   - the section
3664ea844a1aSMatthew Knepley . numPoints - the number of points
366538b5cf2dSJacob Faibussowitsch . points    - an array of size 2 * `numPoints`, containing a list of (point, orientation) pairs. (An orientation is an
3666cab54364SBarry Smith               arbitrary integer: its interpretation is up to sym.  Orientations are used by `DM`: for their interpretation in that
3667cab54364SBarry Smith               context, see `DMPlexGetConeOrientation()`).
366820662ed9SBarry Smith . perms     - The permutations for the given orientations: set to `NULL` at conclusion
366920662ed9SBarry Smith - rots      - The field rotations symmetries for the given orientations: set to `NULL` at conclusion
3670ea844a1aSMatthew Knepley 
3671ea844a1aSMatthew Knepley   Level: developer
3672ea844a1aSMatthew Knepley 
3673cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionGetPointSyms()`, `PetscSectionSymCreate()`, `PetscSectionSetSym()`, `PetscSectionGetSym()`
3674ea844a1aSMatthew Knepley @*/
3675d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionRestorePointSyms(PetscSection section, PetscInt numPoints, const PetscInt *points, const PetscInt ***perms, const PetscScalar ***rots)
3676d71ae5a4SJacob Faibussowitsch {
3677ea844a1aSMatthew Knepley   PetscSectionSym sym;
3678ea844a1aSMatthew Knepley 
3679ea844a1aSMatthew Knepley   PetscFunctionBegin;
3680ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1);
3681ea844a1aSMatthew Knepley   sym = section->sym;
3682ea844a1aSMatthew Knepley   if (sym && (perms || rots)) {
3683ea844a1aSMatthew Knepley     SymWorkLink *p, link;
3684ea844a1aSMatthew Knepley 
3685ea844a1aSMatthew Knepley     for (p = &sym->workout; (link = *p); p = &link->next) {
3686ea844a1aSMatthew Knepley       if ((perms && link->perms == *perms) || (rots && link->rots == *rots)) {
3687ea844a1aSMatthew Knepley         *p          = link->next;
3688ea844a1aSMatthew Knepley         link->next  = sym->workin;
3689ea844a1aSMatthew Knepley         sym->workin = link;
3690ea844a1aSMatthew Knepley         if (perms) *perms = NULL;
3691ea844a1aSMatthew Knepley         if (rots) *rots = NULL;
36923ba16761SJacob Faibussowitsch         PetscFunctionReturn(PETSC_SUCCESS);
3693ea844a1aSMatthew Knepley       }
3694ea844a1aSMatthew Knepley     }
3695ea844a1aSMatthew Knepley     SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "Array was not checked out");
3696ea844a1aSMatthew Knepley   }
36973ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3698ea844a1aSMatthew Knepley }
3699ea844a1aSMatthew Knepley 
3700ea844a1aSMatthew Knepley /*@C
3701cab54364SBarry Smith   PetscSectionGetFieldPointSyms - Get the symmetries for a set of points in a field of a `PetscSection` under specific orientations.
3702ea844a1aSMatthew Knepley 
370340750d41SVaclav Hapla   Not Collective
3704ea844a1aSMatthew Knepley 
3705ea844a1aSMatthew Knepley   Input Parameters:
3706ea844a1aSMatthew Knepley + section   - the section
3707ea844a1aSMatthew Knepley . field     - the field of the section
3708ea844a1aSMatthew Knepley . numPoints - the number of points
370920662ed9SBarry Smith - points    - an array of size 2 * `numPoints`, containing a list of (point, orientation) pairs. (An orientation is an
3710cab54364SBarry Smith     arbitrary integer: its interpretation is up to sym.  Orientations are used by `DM`: for their interpretation in that
3711cab54364SBarry Smith     context, see `DMPlexGetConeOrientation()`).
3712ea844a1aSMatthew Knepley 
3713d8d19677SJose E. Roman   Output Parameters:
371420662ed9SBarry Smith + perms - The permutations for the given orientations (or `NULL` if there is no symmetry or the permutation is the identity).
371520662ed9SBarry Smith - rots  - The field rotations symmetries for the given orientations (or `NULL` if there is no symmetry or the rotations are all
3716ea844a1aSMatthew Knepley     identity).
3717ea844a1aSMatthew Knepley 
3718ea844a1aSMatthew Knepley   Level: developer
3719ea844a1aSMatthew Knepley 
372020662ed9SBarry Smith   Notes:
372120662ed9SBarry Smith   `PetscSectionSetFieldSym()` must have been previously called to provide the symmetries to the `PetscSection`
372220662ed9SBarry Smith 
372320662ed9SBarry Smith   Use `PetscSectionRestoreFieldPointSyms()` when finished with the data
372420662ed9SBarry Smith 
3725cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionGetPointSyms()`, `PetscSectionRestoreFieldPointSyms()`
3726ea844a1aSMatthew Knepley @*/
3727d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetFieldPointSyms(PetscSection section, PetscInt field, PetscInt numPoints, const PetscInt *points, const PetscInt ***perms, const PetscScalar ***rots)
3728d71ae5a4SJacob Faibussowitsch {
3729ea844a1aSMatthew Knepley   PetscFunctionBegin;
3730ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1);
373108401ef6SPierre 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);
37329566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetPointSyms(section->field[field], numPoints, points, perms, rots));
37333ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3734ea844a1aSMatthew Knepley }
3735ea844a1aSMatthew Knepley 
3736ea844a1aSMatthew Knepley /*@C
3737cab54364SBarry Smith   PetscSectionRestoreFieldPointSyms - Restore the symmetries returned by `PetscSectionGetFieldPointSyms()`
3738ea844a1aSMatthew Knepley 
373940750d41SVaclav Hapla   Not Collective
3740ea844a1aSMatthew Knepley 
3741ea844a1aSMatthew Knepley   Input Parameters:
3742ea844a1aSMatthew Knepley + section   - the section
3743ea844a1aSMatthew Knepley . field     - the field number
3744ea844a1aSMatthew Knepley . numPoints - the number of points
374538b5cf2dSJacob Faibussowitsch . points    - an array of size 2 * `numPoints`, containing a list of (point, orientation) pairs. (An orientation is an
3746cab54364SBarry Smith     arbitrary integer: its interpretation is up to sym.  Orientations are used by `DM`: for their interpretation in that
3747cab54364SBarry Smith     context, see `DMPlexGetConeOrientation()`).
374820662ed9SBarry Smith . perms     - The permutations for the given orientations: set to NULL at conclusion
3749ea844a1aSMatthew Knepley - rots      - The field rotations symmetries for the given orientations: set to NULL at conclusion
3750ea844a1aSMatthew Knepley 
3751ea844a1aSMatthew Knepley   Level: developer
3752ea844a1aSMatthew Knepley 
3753cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionRestorePointSyms()`, `petscSectionGetFieldPointSyms()`, `PetscSectionSymCreate()`, `PetscSectionSetSym()`, `PetscSectionGetSym()`
3754ea844a1aSMatthew Knepley @*/
3755d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionRestoreFieldPointSyms(PetscSection section, PetscInt field, PetscInt numPoints, const PetscInt *points, const PetscInt ***perms, const PetscScalar ***rots)
3756d71ae5a4SJacob Faibussowitsch {
3757ea844a1aSMatthew Knepley   PetscFunctionBegin;
3758ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1);
375908401ef6SPierre 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);
37609566063dSJacob Faibussowitsch   PetscCall(PetscSectionRestorePointSyms(section->field[field], numPoints, points, perms, rots));
37613ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3762ea844a1aSMatthew Knepley }
3763ea844a1aSMatthew Knepley 
3764ea844a1aSMatthew Knepley /*@
3765b004864fSMatthew G. Knepley   PetscSectionSymCopy - Copy the symmetries, assuming that the point structure is compatible
3766b004864fSMatthew G. Knepley 
376740750d41SVaclav Hapla   Not Collective
3768b004864fSMatthew G. Knepley 
3769b004864fSMatthew G. Knepley   Input Parameter:
3770cab54364SBarry Smith . sym - the `PetscSectionSym`
3771b004864fSMatthew G. Knepley 
3772b004864fSMatthew G. Knepley   Output Parameter:
3773b004864fSMatthew G. Knepley . nsym - the equivalent symmetries
3774b004864fSMatthew G. Knepley 
3775b004864fSMatthew G. Knepley   Level: developer
3776b004864fSMatthew G. Knepley 
3777cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionSymCreate()`, `PetscSectionSetSym()`, `PetscSectionGetSym()`, `PetscSectionSymLabelSetStratum()`, `PetscSectionGetPointSyms()`
3778b004864fSMatthew G. Knepley @*/
3779d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSymCopy(PetscSectionSym sym, PetscSectionSym nsym)
3780d71ae5a4SJacob Faibussowitsch {
3781b004864fSMatthew G. Knepley   PetscFunctionBegin;
3782b004864fSMatthew G. Knepley   PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID, 1);
3783b004864fSMatthew G. Knepley   PetscValidHeaderSpecific(nsym, PETSC_SECTION_SYM_CLASSID, 2);
3784dbbe0bcdSBarry Smith   PetscTryTypeMethod(sym, copy, nsym);
37853ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3786b004864fSMatthew G. Knepley }
3787b004864fSMatthew G. Knepley 
3788b004864fSMatthew G. Knepley /*@
3789cab54364SBarry Smith   PetscSectionSymDistribute - Distribute the symmetries in accordance with the input `PetscSF`
3790b004864fSMatthew G. Knepley 
3791b004864fSMatthew G. Knepley   Collective
3792b004864fSMatthew G. Knepley 
3793b004864fSMatthew G. Knepley   Input Parameters:
3794cab54364SBarry Smith + sym         - the `PetscSectionSym`
3795b004864fSMatthew G. Knepley - migrationSF - the distribution map from roots to leaves
3796b004864fSMatthew G. Knepley 
37972fe279fdSBarry Smith   Output Parameter:
3798b004864fSMatthew G. Knepley . dsym - the redistributed symmetries
3799b004864fSMatthew G. Knepley 
3800b004864fSMatthew G. Knepley   Level: developer
3801b004864fSMatthew G. Knepley 
3802cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionSymCreate()`, `PetscSectionSetSym()`, `PetscSectionGetSym()`, `PetscSectionSymLabelSetStratum()`, `PetscSectionGetPointSyms()`
3803b004864fSMatthew G. Knepley @*/
3804d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSymDistribute(PetscSectionSym sym, PetscSF migrationSF, PetscSectionSym *dsym)
3805d71ae5a4SJacob Faibussowitsch {
3806b004864fSMatthew G. Knepley   PetscFunctionBegin;
3807b004864fSMatthew G. Knepley   PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID, 1);
3808b004864fSMatthew G. Knepley   PetscValidHeaderSpecific(migrationSF, PETSCSF_CLASSID, 2);
38094f572ea9SToby Isaac   PetscAssertPointer(dsym, 3);
3810dbbe0bcdSBarry Smith   PetscTryTypeMethod(sym, distribute, migrationSF, dsym);
38113ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3812b004864fSMatthew G. Knepley }
3813b004864fSMatthew G. Knepley 
3814b004864fSMatthew G. Knepley /*@
381520662ed9SBarry Smith   PetscSectionGetUseFieldOffsets - Get the flag indicating if field offsets are used directly in a global section, rather than just the point offset
3816ea844a1aSMatthew Knepley 
381740750d41SVaclav Hapla   Not Collective
3818ea844a1aSMatthew Knepley 
3819ea844a1aSMatthew Knepley   Input Parameter:
3820cab54364SBarry Smith . s - the global `PetscSection`
3821ea844a1aSMatthew Knepley 
38222fe279fdSBarry Smith   Output Parameter:
3823ea844a1aSMatthew Knepley . flg - the flag
3824ea844a1aSMatthew Knepley 
3825ea844a1aSMatthew Knepley   Level: developer
3826ea844a1aSMatthew Knepley 
3827cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionSetChart()`, `PetscSectionCreate()`
3828ea844a1aSMatthew Knepley @*/
3829d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetUseFieldOffsets(PetscSection s, PetscBool *flg)
3830d71ae5a4SJacob Faibussowitsch {
3831ea844a1aSMatthew Knepley   PetscFunctionBegin;
3832ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
3833ea844a1aSMatthew Knepley   *flg = s->useFieldOff;
38343ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3835ea844a1aSMatthew Knepley }
3836ea844a1aSMatthew Knepley 
3837ea844a1aSMatthew Knepley /*@
3838ea844a1aSMatthew Knepley   PetscSectionSetUseFieldOffsets - Set the flag to use field offsets directly in a global section, rather than just the point offset
3839ea844a1aSMatthew Knepley 
384040750d41SVaclav Hapla   Not Collective
3841ea844a1aSMatthew Knepley 
3842ea844a1aSMatthew Knepley   Input Parameters:
3843cab54364SBarry Smith + s   - the global `PetscSection`
3844ea844a1aSMatthew Knepley - flg - the flag
3845ea844a1aSMatthew Knepley 
3846ea844a1aSMatthew Knepley   Level: developer
3847ea844a1aSMatthew Knepley 
3848cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionGetUseFieldOffsets()`, `PetscSectionSetChart()`, `PetscSectionCreate()`
3849ea844a1aSMatthew Knepley @*/
3850d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetUseFieldOffsets(PetscSection s, PetscBool flg)
3851d71ae5a4SJacob Faibussowitsch {
3852ea844a1aSMatthew Knepley   PetscFunctionBegin;
3853ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
3854ea844a1aSMatthew Knepley   s->useFieldOff = flg;
38553ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3856ea844a1aSMatthew Knepley }
3857ea844a1aSMatthew Knepley 
3858ea844a1aSMatthew Knepley #define PetscSectionExpandPoints_Loop(TYPE) \
3859a8f51744SPierre Jolivet   do { \
3860ea844a1aSMatthew Knepley     PetscInt i, n, o0, o1, size; \
3861ea844a1aSMatthew Knepley     TYPE    *a0 = (TYPE *)origArray, *a1; \
38629566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetStorageSize(s, &size)); \
38639566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(size, &a1)); \
3864ea844a1aSMatthew Knepley     for (i = 0; i < npoints; i++) { \
38659566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetOffset(origSection, points_[i], &o0)); \
38669566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetOffset(s, i, &o1)); \
38679566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(s, i, &n)); \
38689566063dSJacob Faibussowitsch       PetscCall(PetscMemcpy(&a1[o1], &a0[o0], n *unitsize)); \
3869ea844a1aSMatthew Knepley     } \
3870ea844a1aSMatthew Knepley     *newArray = (void *)a1; \
3871a8f51744SPierre Jolivet   } while (0)
3872ea844a1aSMatthew Knepley 
3873ea844a1aSMatthew Knepley /*@
3874ea844a1aSMatthew Knepley   PetscSectionExtractDofsFromArray - Extracts elements of an array corresponding to DOFs of specified points.
3875ea844a1aSMatthew Knepley 
387640750d41SVaclav Hapla   Not Collective
3877ea844a1aSMatthew Knepley 
3878ea844a1aSMatthew Knepley   Input Parameters:
3879cab54364SBarry Smith + origSection - the `PetscSection` describing the layout of the array
3880cab54364SBarry Smith . dataType    - `MPI_Datatype` describing the data type of the array (currently only `MPIU_INT`, `MPIU_SCALAR`, `MPIU_REAL`)
388120662ed9SBarry Smith . origArray   - the array; its size must be equal to the storage size of `origSection`
388220662ed9SBarry Smith - points      - `IS` with points to extract; its indices must lie in the chart of `origSection`
3883ea844a1aSMatthew Knepley 
3884ea844a1aSMatthew Knepley   Output Parameters:
3885da81f932SPierre Jolivet + newSection - the new `PetscSection` describing the layout of the new array (with points renumbered 0,1,... but preserving numbers of DOFs)
388620662ed9SBarry Smith - newArray   - the array of the extracted DOFs; its size is the storage size of `newSection`
3887ea844a1aSMatthew Knepley 
3888ea844a1aSMatthew Knepley   Level: developer
3889ea844a1aSMatthew Knepley 
3890cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionGetChart()`, `PetscSectionGetDof()`, `PetscSectionGetStorageSize()`, `PetscSectionCreate()`
3891ea844a1aSMatthew Knepley @*/
3892d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionExtractDofsFromArray(PetscSection origSection, MPI_Datatype dataType, const void *origArray, IS points, PetscSection *newSection, void *newArray[])
3893d71ae5a4SJacob Faibussowitsch {
3894ea844a1aSMatthew Knepley   PetscSection    s;
3895ea844a1aSMatthew Knepley   const PetscInt *points_;
3896ea844a1aSMatthew Knepley   PetscInt        i, n, npoints, pStart, pEnd;
3897ea844a1aSMatthew Knepley   PetscMPIInt     unitsize;
3898ea844a1aSMatthew Knepley 
3899ea844a1aSMatthew Knepley   PetscFunctionBegin;
3900ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(origSection, PETSC_SECTION_CLASSID, 1);
39014f572ea9SToby Isaac   PetscAssertPointer(origArray, 3);
3902ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(points, IS_CLASSID, 4);
39034f572ea9SToby Isaac   if (newSection) PetscAssertPointer(newSection, 5);
39044f572ea9SToby Isaac   if (newArray) PetscAssertPointer(newArray, 6);
39059566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Type_size(dataType, &unitsize));
39069566063dSJacob Faibussowitsch   PetscCall(ISGetLocalSize(points, &npoints));
39079566063dSJacob Faibussowitsch   PetscCall(ISGetIndices(points, &points_));
39089566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(origSection, &pStart, &pEnd));
39099566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PETSC_COMM_SELF, &s));
39109566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(s, 0, npoints));
3911ea844a1aSMatthew Knepley   for (i = 0; i < npoints; i++) {
3912c9cc58a2SBarry 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);
39139566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(origSection, points_[i], &n));
39149566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(s, i, n));
3915ea844a1aSMatthew Knepley   }
39169566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(s));
3917ea844a1aSMatthew Knepley   if (newArray) {
39189371c9d4SSatish Balay     if (dataType == MPIU_INT) {
39199371c9d4SSatish Balay       PetscSectionExpandPoints_Loop(PetscInt);
39209371c9d4SSatish Balay     } else if (dataType == MPIU_SCALAR) {
39219371c9d4SSatish Balay       PetscSectionExpandPoints_Loop(PetscScalar);
39229371c9d4SSatish Balay     } else if (dataType == MPIU_REAL) {
39239371c9d4SSatish Balay       PetscSectionExpandPoints_Loop(PetscReal);
39249371c9d4SSatish Balay     } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP, "not implemented for this MPI_Datatype");
3925ea844a1aSMatthew Knepley   }
3926ea844a1aSMatthew Knepley   if (newSection) {
3927ea844a1aSMatthew Knepley     *newSection = s;
3928ea844a1aSMatthew Knepley   } else {
39299566063dSJacob Faibussowitsch     PetscCall(PetscSectionDestroy(&s));
3930ea844a1aSMatthew Knepley   }
39319566063dSJacob Faibussowitsch   PetscCall(ISRestoreIndices(points, &points_));
39323ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3933ea844a1aSMatthew Knepley }
3934