xref: /petsc/src/vec/is/section/interface/section.c (revision c459fbc129a860d8142359b407124cc9cd63430b)
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 <petscsection.h>
7ea844a1aSMatthew Knepley #include <petscsf.h>
8ea844a1aSMatthew Knepley #include <petscviewer.h>
9ea844a1aSMatthew Knepley 
10ea844a1aSMatthew Knepley PetscClassId PETSC_SECTION_CLASSID;
11ea844a1aSMatthew Knepley 
12ea844a1aSMatthew Knepley /*@
13ea844a1aSMatthew Knepley   PetscSectionCreate - Allocates PetscSection space and sets the map contents to the default.
14ea844a1aSMatthew Knepley 
15ea844a1aSMatthew Knepley   Collective
16ea844a1aSMatthew Knepley 
17ea844a1aSMatthew Knepley   Input Parameters:
18ea844a1aSMatthew Knepley + comm - the MPI communicator
19ea844a1aSMatthew Knepley - s    - pointer to the section
20ea844a1aSMatthew Knepley 
21ea844a1aSMatthew Knepley   Level: beginner
22ea844a1aSMatthew Knepley 
23ea844a1aSMatthew Knepley   Notes:
24ea844a1aSMatthew Knepley   Typical calling sequence
25ea844a1aSMatthew Knepley $       PetscSectionCreate(MPI_Comm,PetscSection *);
26ea844a1aSMatthew Knepley $       PetscSectionSetNumFields(PetscSection, numFields);
27ea844a1aSMatthew Knepley $       PetscSectionSetChart(PetscSection,low,high);
28ea844a1aSMatthew Knepley $       PetscSectionSetDof(PetscSection,point,numdof);
29ea844a1aSMatthew Knepley $       PetscSectionSetUp(PetscSection);
30ea844a1aSMatthew Knepley $       PetscSectionGetOffset(PetscSection,point,PetscInt *);
31ea844a1aSMatthew Knepley $       PetscSectionDestroy(PetscSection);
32ea844a1aSMatthew Knepley 
33ea844a1aSMatthew Knepley   The PetscSection object and methods are intended to be used in the PETSc Vec and Mat implementions; it is
34ea844a1aSMatthew Knepley   recommended they not be used in user codes unless you really gain something in their use.
35ea844a1aSMatthew Knepley 
36ea844a1aSMatthew Knepley .seealso: PetscSection, PetscSectionDestroy()
37ea844a1aSMatthew Knepley @*/
38ea844a1aSMatthew Knepley PetscErrorCode PetscSectionCreate(MPI_Comm comm, PetscSection *s)
39ea844a1aSMatthew Knepley {
40ea844a1aSMatthew Knepley   PetscErrorCode ierr;
41ea844a1aSMatthew Knepley 
42ea844a1aSMatthew Knepley   PetscFunctionBegin;
43ea844a1aSMatthew Knepley   PetscValidPointer(s,2);
44ea844a1aSMatthew Knepley   ierr = ISInitializePackage();CHKERRQ(ierr);
45ea844a1aSMatthew Knepley 
46ea844a1aSMatthew Knepley   ierr = PetscHeaderCreate(*s,PETSC_SECTION_CLASSID,"PetscSection","Section","IS",comm,PetscSectionDestroy,PetscSectionView);CHKERRQ(ierr);
47ea844a1aSMatthew Knepley 
48ea844a1aSMatthew Knepley   (*s)->pStart             = -1;
49ea844a1aSMatthew Knepley   (*s)->pEnd               = -1;
50ea844a1aSMatthew Knepley   (*s)->perm               = NULL;
51ea844a1aSMatthew Knepley   (*s)->pointMajor         = PETSC_TRUE;
52ea844a1aSMatthew Knepley   (*s)->maxDof             = 0;
53ea844a1aSMatthew Knepley   (*s)->atlasDof           = NULL;
54ea844a1aSMatthew Knepley   (*s)->atlasOff           = NULL;
55ea844a1aSMatthew Knepley   (*s)->bc                 = NULL;
56ea844a1aSMatthew Knepley   (*s)->bcIndices          = NULL;
57ea844a1aSMatthew Knepley   (*s)->setup              = PETSC_FALSE;
58ea844a1aSMatthew Knepley   (*s)->numFields          = 0;
59ea844a1aSMatthew Knepley   (*s)->fieldNames         = NULL;
60ea844a1aSMatthew Knepley   (*s)->field              = NULL;
61ea844a1aSMatthew Knepley   (*s)->useFieldOff        = PETSC_FALSE;
62b778fa18SValeria Barra   (*s)->compNames          = NULL;
63ea844a1aSMatthew Knepley   (*s)->clObj              = NULL;
64*c459fbc1SJed Brown   (*s)->clHash             = NULL;
65ea844a1aSMatthew Knepley   (*s)->clSection          = NULL;
66ea844a1aSMatthew Knepley   (*s)->clPoints           = NULL;
67ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
68ea844a1aSMatthew Knepley }
69ea844a1aSMatthew Knepley 
70ea844a1aSMatthew Knepley /*@
71ea844a1aSMatthew Knepley   PetscSectionCopy - Creates a shallow (if possible) copy of the PetscSection
72ea844a1aSMatthew Knepley 
73ea844a1aSMatthew Knepley   Collective
74ea844a1aSMatthew Knepley 
75ea844a1aSMatthew Knepley   Input Parameter:
76ea844a1aSMatthew Knepley . section - the PetscSection
77ea844a1aSMatthew Knepley 
78ea844a1aSMatthew Knepley   Output Parameter:
79ea844a1aSMatthew Knepley . newSection - the copy
80ea844a1aSMatthew Knepley 
81ea844a1aSMatthew Knepley   Level: intermediate
82ea844a1aSMatthew Knepley 
83ea844a1aSMatthew Knepley .seealso: PetscSection, PetscSectionCreate(), PetscSectionDestroy()
84ea844a1aSMatthew Knepley @*/
85ea844a1aSMatthew Knepley PetscErrorCode PetscSectionCopy(PetscSection section, PetscSection newSection)
86ea844a1aSMatthew Knepley {
87ea844a1aSMatthew Knepley   PetscSectionSym sym;
88ea844a1aSMatthew Knepley   IS              perm;
89b778fa18SValeria Barra   PetscInt        numFields, f, c, pStart, pEnd, p;
90ea844a1aSMatthew Knepley   PetscErrorCode  ierr;
91ea844a1aSMatthew Knepley 
92ea844a1aSMatthew Knepley   PetscFunctionBegin;
93ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1);
94ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(newSection, PETSC_SECTION_CLASSID, 2);
95124bfe34SStefano Zampini   ierr = PetscSectionReset(newSection);CHKERRQ(ierr);
96ea844a1aSMatthew Knepley   ierr = PetscSectionGetNumFields(section, &numFields);CHKERRQ(ierr);
97ea844a1aSMatthew Knepley   if (numFields) {ierr = PetscSectionSetNumFields(newSection, numFields);CHKERRQ(ierr);}
98ea844a1aSMatthew Knepley   for (f = 0; f < numFields; ++f) {
99b778fa18SValeria Barra     const char *fieldName = NULL, *compName = NULL;
100ea844a1aSMatthew Knepley     PetscInt   numComp = 0;
101ea844a1aSMatthew Knepley 
102b778fa18SValeria Barra     ierr = PetscSectionGetFieldName(section, f, &fieldName);CHKERRQ(ierr);
103b778fa18SValeria Barra     ierr = PetscSectionSetFieldName(newSection, f, fieldName);CHKERRQ(ierr);
104ea844a1aSMatthew Knepley     ierr = PetscSectionGetFieldComponents(section, f, &numComp);CHKERRQ(ierr);
105ea844a1aSMatthew Knepley     ierr = PetscSectionSetFieldComponents(newSection, f, numComp);CHKERRQ(ierr);
106b778fa18SValeria Barra     for (c = 0; c < numComp; ++c) {
107b778fa18SValeria Barra       ierr = PetscSectionGetComponentName(section, f, c, &compName);CHKERRQ(ierr);
108b778fa18SValeria Barra       ierr = PetscSectionSetComponentName(newSection, f, c, compName);CHKERRQ(ierr);
109b778fa18SValeria Barra     }
110ea844a1aSMatthew Knepley     ierr = PetscSectionGetFieldSym(section, f, &sym);CHKERRQ(ierr);
111ea844a1aSMatthew Knepley     ierr = PetscSectionSetFieldSym(newSection, f, sym);CHKERRQ(ierr);
112ea844a1aSMatthew Knepley   }
113ea844a1aSMatthew Knepley   ierr = PetscSectionGetChart(section, &pStart, &pEnd);CHKERRQ(ierr);
114ea844a1aSMatthew Knepley   ierr = PetscSectionSetChart(newSection, pStart, pEnd);CHKERRQ(ierr);
115ea844a1aSMatthew Knepley   ierr = PetscSectionGetPermutation(section, &perm);CHKERRQ(ierr);
116ea844a1aSMatthew Knepley   ierr = PetscSectionSetPermutation(newSection, perm);CHKERRQ(ierr);
117ea844a1aSMatthew Knepley   ierr = PetscSectionGetSym(section, &sym);CHKERRQ(ierr);
118ea844a1aSMatthew Knepley   ierr = PetscSectionSetSym(newSection, sym);CHKERRQ(ierr);
119ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
120ea844a1aSMatthew Knepley     PetscInt dof, cdof, fcdof = 0;
121ea844a1aSMatthew Knepley 
122ea844a1aSMatthew Knepley     ierr = PetscSectionGetDof(section, p, &dof);CHKERRQ(ierr);
123ea844a1aSMatthew Knepley     ierr = PetscSectionSetDof(newSection, p, dof);CHKERRQ(ierr);
124ea844a1aSMatthew Knepley     ierr = PetscSectionGetConstraintDof(section, p, &cdof);CHKERRQ(ierr);
125ea844a1aSMatthew Knepley     if (cdof) {ierr = PetscSectionSetConstraintDof(newSection, p, cdof);CHKERRQ(ierr);}
126ea844a1aSMatthew Knepley     for (f = 0; f < numFields; ++f) {
127ea844a1aSMatthew Knepley       ierr = PetscSectionGetFieldDof(section, p, f, &dof);CHKERRQ(ierr);
128ea844a1aSMatthew Knepley       ierr = PetscSectionSetFieldDof(newSection, p, f, dof);CHKERRQ(ierr);
129ea844a1aSMatthew Knepley       if (cdof) {
130ea844a1aSMatthew Knepley         ierr = PetscSectionGetFieldConstraintDof(section, p, f, &fcdof);CHKERRQ(ierr);
131ea844a1aSMatthew Knepley         if (fcdof) {ierr = PetscSectionSetFieldConstraintDof(newSection, p, f, fcdof);CHKERRQ(ierr);}
132ea844a1aSMatthew Knepley       }
133ea844a1aSMatthew Knepley     }
134ea844a1aSMatthew Knepley   }
135ea844a1aSMatthew Knepley   ierr = PetscSectionSetUp(newSection);CHKERRQ(ierr);
136ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
137ea844a1aSMatthew Knepley     PetscInt       off, cdof, fcdof = 0;
138ea844a1aSMatthew Knepley     const PetscInt *cInd;
139ea844a1aSMatthew Knepley 
140ea844a1aSMatthew Knepley     /* Must set offsets in case they do not agree with the prefix sums */
141ea844a1aSMatthew Knepley     ierr = PetscSectionGetOffset(section, p, &off);CHKERRQ(ierr);
142ea844a1aSMatthew Knepley     ierr = PetscSectionSetOffset(newSection, p, off);CHKERRQ(ierr);
143ea844a1aSMatthew Knepley     ierr = PetscSectionGetConstraintDof(section, p, &cdof);CHKERRQ(ierr);
144ea844a1aSMatthew Knepley     if (cdof) {
145ea844a1aSMatthew Knepley       ierr = PetscSectionGetConstraintIndices(section, p, &cInd);CHKERRQ(ierr);
146ea844a1aSMatthew Knepley       ierr = PetscSectionSetConstraintIndices(newSection, p, cInd);CHKERRQ(ierr);
147ea844a1aSMatthew Knepley       for (f = 0; f < numFields; ++f) {
148ea844a1aSMatthew Knepley         ierr = PetscSectionGetFieldConstraintDof(section, p, f, &fcdof);CHKERRQ(ierr);
149ea844a1aSMatthew Knepley         if (fcdof) {
150ea844a1aSMatthew Knepley           ierr = PetscSectionGetFieldConstraintIndices(section, p, f, &cInd);CHKERRQ(ierr);
151ea844a1aSMatthew Knepley           ierr = PetscSectionSetFieldConstraintIndices(newSection, p, f, cInd);CHKERRQ(ierr);
152ea844a1aSMatthew Knepley         }
153ea844a1aSMatthew Knepley       }
154ea844a1aSMatthew Knepley     }
155ea844a1aSMatthew Knepley   }
156ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
157ea844a1aSMatthew Knepley }
158ea844a1aSMatthew Knepley 
159ea844a1aSMatthew Knepley /*@
160ea844a1aSMatthew Knepley   PetscSectionClone - Creates a shallow (if possible) copy of the PetscSection
161ea844a1aSMatthew Knepley 
162ea844a1aSMatthew Knepley   Collective
163ea844a1aSMatthew Knepley 
164ea844a1aSMatthew Knepley   Input Parameter:
165ea844a1aSMatthew Knepley . section - the PetscSection
166ea844a1aSMatthew Knepley 
167ea844a1aSMatthew Knepley   Output Parameter:
168ea844a1aSMatthew Knepley . newSection - the copy
169ea844a1aSMatthew Knepley 
170ea844a1aSMatthew Knepley   Level: beginner
171ea844a1aSMatthew Knepley 
172ea844a1aSMatthew Knepley .seealso: PetscSection, PetscSectionCreate(), PetscSectionDestroy()
173ea844a1aSMatthew Knepley @*/
174ea844a1aSMatthew Knepley PetscErrorCode PetscSectionClone(PetscSection section, PetscSection *newSection)
175ea844a1aSMatthew Knepley {
176ea844a1aSMatthew Knepley   PetscErrorCode ierr;
177ea844a1aSMatthew Knepley 
178ea844a1aSMatthew Knepley   PetscFunctionBegin;
179ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1);
180ea844a1aSMatthew Knepley   PetscValidPointer(newSection, 2);
181ea844a1aSMatthew Knepley   ierr = PetscSectionCreate(PetscObjectComm((PetscObject) section), newSection);CHKERRQ(ierr);
182ea844a1aSMatthew Knepley   ierr = PetscSectionCopy(section, *newSection);CHKERRQ(ierr);
183ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
184ea844a1aSMatthew Knepley }
185ea844a1aSMatthew Knepley 
186ea844a1aSMatthew Knepley /*@
187ea844a1aSMatthew Knepley   PetscSectionSetFromOptions - sets parameters in a PetscSection from the options database
188ea844a1aSMatthew Knepley 
189ea844a1aSMatthew Knepley   Collective on PetscSection
190ea844a1aSMatthew Knepley 
191ea844a1aSMatthew Knepley   Input Parameter:
192ea844a1aSMatthew Knepley . section - the PetscSection
193ea844a1aSMatthew Knepley 
194ea844a1aSMatthew Knepley   Options Database:
195ea844a1aSMatthew Knepley . -petscsection_point_major the dof order
196ea844a1aSMatthew Knepley 
197ea844a1aSMatthew Knepley   Level: intermediate
198ea844a1aSMatthew Knepley 
199ea844a1aSMatthew Knepley .seealso: PetscSection, PetscSectionCreate(), PetscSectionDestroy()
200ea844a1aSMatthew Knepley @*/
201ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetFromOptions(PetscSection s)
202ea844a1aSMatthew Knepley {
203ea844a1aSMatthew Knepley   PetscErrorCode ierr;
204ea844a1aSMatthew Knepley 
205ea844a1aSMatthew Knepley   PetscFunctionBegin;
206ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
207ea844a1aSMatthew Knepley   ierr = PetscObjectOptionsBegin((PetscObject) s);CHKERRQ(ierr);
208ea844a1aSMatthew Knepley   ierr = PetscOptionsBool("-petscsection_point_major", "The for ordering, either point major or field major", "PetscSectionSetPointMajor", s->pointMajor, &s->pointMajor, NULL);CHKERRQ(ierr);
209ea844a1aSMatthew Knepley   /* process any options handlers added with PetscObjectAddOptionsHandler() */
210ea844a1aSMatthew Knepley   ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject) s);CHKERRQ(ierr);
211ea844a1aSMatthew Knepley   ierr = PetscOptionsEnd();CHKERRQ(ierr);
212ea844a1aSMatthew Knepley   ierr = PetscObjectViewFromOptions((PetscObject) s, NULL, "-petscsection_view");CHKERRQ(ierr);
213ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
214ea844a1aSMatthew Knepley }
215ea844a1aSMatthew Knepley 
216ea844a1aSMatthew Knepley /*@
217ea844a1aSMatthew Knepley   PetscSectionCompare - Compares two sections
218ea844a1aSMatthew Knepley 
219ea844a1aSMatthew Knepley   Collective on PetscSection
220ea844a1aSMatthew Knepley 
2217a7aea1fSJed Brown   Input Parameters:
222ea844a1aSMatthew Knepley + s1 - the first PetscSection
223ea844a1aSMatthew Knepley - s2 - the second PetscSection
224ea844a1aSMatthew Knepley 
225ea844a1aSMatthew Knepley   Output Parameter:
226ea844a1aSMatthew Knepley . congruent - PETSC_TRUE if the two sections are congruent, PETSC_FALSE otherwise
227ea844a1aSMatthew Knepley 
228ea844a1aSMatthew Knepley   Level: intermediate
229ea844a1aSMatthew Knepley 
230ea844a1aSMatthew Knepley   Notes:
231ea844a1aSMatthew Knepley   Field names are disregarded.
232ea844a1aSMatthew Knepley 
233ea844a1aSMatthew Knepley .seealso: PetscSection, PetscSectionCreate(), PetscSectionCopy(), PetscSectionClone()
234ea844a1aSMatthew Knepley @*/
235ea844a1aSMatthew Knepley PetscErrorCode PetscSectionCompare(PetscSection s1, PetscSection s2, PetscBool *congruent)
236ea844a1aSMatthew Knepley {
237ea844a1aSMatthew Knepley   PetscInt pStart, pEnd, nfields, ncdof, nfcdof, p, f, n1, n2;
238ea844a1aSMatthew Knepley   const PetscInt *idx1, *idx2;
239ea844a1aSMatthew Knepley   IS perm1, perm2;
240ea844a1aSMatthew Knepley   PetscBool flg;
241ea844a1aSMatthew Knepley   PetscMPIInt mflg;
242ea844a1aSMatthew Knepley   PetscErrorCode ierr;
243ea844a1aSMatthew Knepley 
244ea844a1aSMatthew Knepley   PetscFunctionBegin;
245ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s1, PETSC_SECTION_CLASSID, 1);
246ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s2, PETSC_SECTION_CLASSID, 2);
247ea844a1aSMatthew Knepley   PetscValidIntPointer(congruent,3);
248ea844a1aSMatthew Knepley   flg = PETSC_FALSE;
249ea844a1aSMatthew Knepley 
250ea844a1aSMatthew Knepley   ierr = MPI_Comm_compare(PetscObjectComm((PetscObject)s1),PetscObjectComm((PetscObject)s2),&mflg);CHKERRQ(ierr);
251ea844a1aSMatthew Knepley   if (mflg != MPI_CONGRUENT && mflg != MPI_IDENT) {
252ea844a1aSMatthew Knepley     *congruent = PETSC_FALSE;
253ea844a1aSMatthew Knepley     PetscFunctionReturn(0);
254ea844a1aSMatthew Knepley   }
255ea844a1aSMatthew Knepley 
256ea844a1aSMatthew Knepley   ierr = PetscSectionGetChart(s1, &pStart, &pEnd);CHKERRQ(ierr);
257ea844a1aSMatthew Knepley   ierr = PetscSectionGetChart(s2, &n1, &n2);CHKERRQ(ierr);
258ea844a1aSMatthew Knepley   if (pStart != n1 || pEnd != n2) goto not_congruent;
259ea844a1aSMatthew Knepley 
260ea844a1aSMatthew Knepley   ierr = PetscSectionGetPermutation(s1, &perm1);CHKERRQ(ierr);
261ea844a1aSMatthew Knepley   ierr = PetscSectionGetPermutation(s2, &perm2);CHKERRQ(ierr);
262ea844a1aSMatthew Knepley   if (perm1 && perm2) {
263ea844a1aSMatthew Knepley     ierr = ISEqual(perm1, perm2, congruent);CHKERRQ(ierr);
264ea844a1aSMatthew Knepley     if (!(*congruent)) goto not_congruent;
265ea844a1aSMatthew Knepley   } else if (perm1 != perm2) goto not_congruent;
266ea844a1aSMatthew Knepley 
267ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
268ea844a1aSMatthew Knepley     ierr = PetscSectionGetOffset(s1, p, &n1);CHKERRQ(ierr);
269ea844a1aSMatthew Knepley     ierr = PetscSectionGetOffset(s2, p, &n2);CHKERRQ(ierr);
270ea844a1aSMatthew Knepley     if (n1 != n2) goto not_congruent;
271ea844a1aSMatthew Knepley 
272ea844a1aSMatthew Knepley     ierr = PetscSectionGetDof(s1, p, &n1);CHKERRQ(ierr);
273ea844a1aSMatthew Knepley     ierr = PetscSectionGetDof(s2, p, &n2);CHKERRQ(ierr);
274ea844a1aSMatthew Knepley     if (n1 != n2) goto not_congruent;
275ea844a1aSMatthew Knepley 
276ea844a1aSMatthew Knepley     ierr = PetscSectionGetConstraintDof(s1, p, &ncdof);CHKERRQ(ierr);
277ea844a1aSMatthew Knepley     ierr = PetscSectionGetConstraintDof(s2, p, &n2);CHKERRQ(ierr);
278ea844a1aSMatthew Knepley     if (ncdof != n2) goto not_congruent;
279ea844a1aSMatthew Knepley 
280ea844a1aSMatthew Knepley     ierr = PetscSectionGetConstraintIndices(s1, p, &idx1);CHKERRQ(ierr);
281ea844a1aSMatthew Knepley     ierr = PetscSectionGetConstraintIndices(s2, p, &idx2);CHKERRQ(ierr);
282ea844a1aSMatthew Knepley     ierr = PetscArraycmp(idx1, idx2, ncdof, congruent);CHKERRQ(ierr);
283ea844a1aSMatthew Knepley     if (!(*congruent)) goto not_congruent;
284ea844a1aSMatthew Knepley   }
285ea844a1aSMatthew Knepley 
286ea844a1aSMatthew Knepley   ierr = PetscSectionGetNumFields(s1, &nfields);CHKERRQ(ierr);
287ea844a1aSMatthew Knepley   ierr = PetscSectionGetNumFields(s2, &n2);CHKERRQ(ierr);
288ea844a1aSMatthew Knepley   if (nfields != n2) goto not_congruent;
289ea844a1aSMatthew Knepley 
290ea844a1aSMatthew Knepley   for (f = 0; f < nfields; ++f) {
291ea844a1aSMatthew Knepley     ierr = PetscSectionGetFieldComponents(s1, f, &n1);CHKERRQ(ierr);
292ea844a1aSMatthew Knepley     ierr = PetscSectionGetFieldComponents(s2, f, &n2);CHKERRQ(ierr);
293ea844a1aSMatthew Knepley     if (n1 != n2) goto not_congruent;
294ea844a1aSMatthew Knepley 
295ea844a1aSMatthew Knepley     for (p = pStart; p < pEnd; ++p) {
296ea844a1aSMatthew Knepley       ierr = PetscSectionGetFieldOffset(s1, p, f, &n1);CHKERRQ(ierr);
297ea844a1aSMatthew Knepley       ierr = PetscSectionGetFieldOffset(s2, p, f, &n2);CHKERRQ(ierr);
298ea844a1aSMatthew Knepley       if (n1 != n2) goto not_congruent;
299ea844a1aSMatthew Knepley 
300ea844a1aSMatthew Knepley       ierr = PetscSectionGetFieldDof(s1, p, f, &n1);CHKERRQ(ierr);
301ea844a1aSMatthew Knepley       ierr = PetscSectionGetFieldDof(s2, p, f, &n2);CHKERRQ(ierr);
302ea844a1aSMatthew Knepley       if (n1 != n2) goto not_congruent;
303ea844a1aSMatthew Knepley 
304ea844a1aSMatthew Knepley       ierr = PetscSectionGetFieldConstraintDof(s1, p, f, &nfcdof);CHKERRQ(ierr);
305ea844a1aSMatthew Knepley       ierr = PetscSectionGetFieldConstraintDof(s2, p, f, &n2);CHKERRQ(ierr);
306ea844a1aSMatthew Knepley       if (nfcdof != n2) goto not_congruent;
307ea844a1aSMatthew Knepley 
308ea844a1aSMatthew Knepley       ierr = PetscSectionGetFieldConstraintIndices(s1, p, f, &idx1);CHKERRQ(ierr);
309ea844a1aSMatthew Knepley       ierr = PetscSectionGetFieldConstraintIndices(s2, p, f, &idx2);CHKERRQ(ierr);
310ea844a1aSMatthew Knepley       ierr = PetscArraycmp(idx1, idx2, nfcdof, congruent);CHKERRQ(ierr);
311ea844a1aSMatthew Knepley       if (!(*congruent)) goto not_congruent;
312ea844a1aSMatthew Knepley     }
313ea844a1aSMatthew Knepley   }
314ea844a1aSMatthew Knepley 
315ea844a1aSMatthew Knepley   flg = PETSC_TRUE;
316ea844a1aSMatthew Knepley not_congruent:
317ea844a1aSMatthew Knepley   ierr = MPIU_Allreduce(&flg,congruent,1,MPIU_BOOL,MPI_LAND,PetscObjectComm((PetscObject)s1));CHKERRQ(ierr);
318ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
319ea844a1aSMatthew Knepley }
320ea844a1aSMatthew Knepley 
321ea844a1aSMatthew Knepley /*@
322ea844a1aSMatthew Knepley   PetscSectionGetNumFields - Returns the number of fields, or 0 if no fields were defined.
323ea844a1aSMatthew Knepley 
324ea844a1aSMatthew Knepley   Not collective
325ea844a1aSMatthew Knepley 
326ea844a1aSMatthew Knepley   Input Parameter:
327ea844a1aSMatthew Knepley . s - the PetscSection
328ea844a1aSMatthew Knepley 
329ea844a1aSMatthew Knepley   Output Parameter:
330ea844a1aSMatthew Knepley . numFields - the number of fields defined, or 0 if none were defined
331ea844a1aSMatthew Knepley 
332ea844a1aSMatthew Knepley   Level: intermediate
333ea844a1aSMatthew Knepley 
334ea844a1aSMatthew Knepley .seealso: PetscSectionSetNumFields()
335ea844a1aSMatthew Knepley @*/
336ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetNumFields(PetscSection s, PetscInt *numFields)
337ea844a1aSMatthew Knepley {
338ea844a1aSMatthew Knepley   PetscFunctionBegin;
339ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
340ea844a1aSMatthew Knepley   PetscValidPointer(numFields,2);
341ea844a1aSMatthew Knepley   *numFields = s->numFields;
342ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
343ea844a1aSMatthew Knepley }
344ea844a1aSMatthew Knepley 
345ea844a1aSMatthew Knepley /*@
346ea844a1aSMatthew Knepley   PetscSectionSetNumFields - Sets the number of fields.
347ea844a1aSMatthew Knepley 
348ea844a1aSMatthew Knepley   Not collective
349ea844a1aSMatthew Knepley 
350ea844a1aSMatthew Knepley   Input Parameters:
351ea844a1aSMatthew Knepley + s - the PetscSection
352ea844a1aSMatthew Knepley - numFields - the number of fields
353ea844a1aSMatthew Knepley 
354ea844a1aSMatthew Knepley   Level: intermediate
355ea844a1aSMatthew Knepley 
356ea844a1aSMatthew Knepley .seealso: PetscSectionGetNumFields()
357ea844a1aSMatthew Knepley @*/
358ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetNumFields(PetscSection s, PetscInt numFields)
359ea844a1aSMatthew Knepley {
360ea844a1aSMatthew Knepley   PetscInt       f;
361ea844a1aSMatthew Knepley   PetscErrorCode ierr;
362ea844a1aSMatthew Knepley 
363ea844a1aSMatthew Knepley   PetscFunctionBegin;
364ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
365ea844a1aSMatthew Knepley   if (numFields <= 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "The number of fields %D must be positive", numFields);
366ea844a1aSMatthew Knepley   ierr = PetscSectionReset(s);CHKERRQ(ierr);
367ea844a1aSMatthew Knepley 
368ea844a1aSMatthew Knepley   s->numFields = numFields;
369ea844a1aSMatthew Knepley   ierr = PetscMalloc1(s->numFields, &s->numFieldComponents);CHKERRQ(ierr);
370ea844a1aSMatthew Knepley   ierr = PetscMalloc1(s->numFields, &s->fieldNames);CHKERRQ(ierr);
371b778fa18SValeria Barra   ierr = PetscMalloc1(s->numFields, &s->compNames);CHKERRQ(ierr);
372ea844a1aSMatthew Knepley   ierr = PetscMalloc1(s->numFields, &s->field);CHKERRQ(ierr);
373ea844a1aSMatthew Knepley   for (f = 0; f < s->numFields; ++f) {
374ea844a1aSMatthew Knepley     char name[64];
375ea844a1aSMatthew Knepley 
376ea844a1aSMatthew Knepley     s->numFieldComponents[f] = 1;
377ea844a1aSMatthew Knepley 
378ea844a1aSMatthew Knepley     ierr = PetscSectionCreate(PetscObjectComm((PetscObject) s), &s->field[f]);CHKERRQ(ierr);
379ea844a1aSMatthew Knepley     ierr = PetscSNPrintf(name, 64, "Field_%D", f);CHKERRQ(ierr);
380ea844a1aSMatthew Knepley     ierr = PetscStrallocpy(name, (char **) &s->fieldNames[f]);CHKERRQ(ierr);
381b778fa18SValeria Barra     ierr = PetscSNPrintf(name, 64, "Component_0");CHKERRQ(ierr);
382b778fa18SValeria Barra     ierr = PetscMalloc1(s->numFieldComponents[f], &s->compNames[f]);CHKERRQ(ierr);
383b778fa18SValeria Barra     ierr = PetscStrallocpy(name, (char **) &s->compNames[f][0]);CHKERRQ(ierr);
384ea844a1aSMatthew Knepley   }
385ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
386ea844a1aSMatthew Knepley }
387ea844a1aSMatthew Knepley 
388ea844a1aSMatthew Knepley /*@C
389ea844a1aSMatthew Knepley   PetscSectionGetFieldName - Returns the name of a field in the PetscSection
390ea844a1aSMatthew Knepley 
391ea844a1aSMatthew Knepley   Not Collective
392ea844a1aSMatthew Knepley 
393ea844a1aSMatthew Knepley   Input Parameters:
394ea844a1aSMatthew Knepley + s     - the PetscSection
395ea844a1aSMatthew Knepley - field - the field number
396ea844a1aSMatthew Knepley 
397ea844a1aSMatthew Knepley   Output Parameter:
398ea844a1aSMatthew Knepley . fieldName - the field name
399ea844a1aSMatthew Knepley 
400ea844a1aSMatthew Knepley   Level: intermediate
401ea844a1aSMatthew Knepley 
402ea844a1aSMatthew Knepley .seealso: PetscSectionSetFieldName()
403ea844a1aSMatthew Knepley @*/
404ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetFieldName(PetscSection s, PetscInt field, const char *fieldName[])
405ea844a1aSMatthew Knepley {
406ea844a1aSMatthew Knepley   PetscFunctionBegin;
407ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
408ea844a1aSMatthew Knepley   PetscValidPointer(fieldName, 3);
409ea844a1aSMatthew Knepley   if ((field < 0) || (field >= s->numFields)) SETERRQ3(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Section field %D should be in [%D, %D)", field, 0, s->numFields);
410ea844a1aSMatthew Knepley   *fieldName = s->fieldNames[field];
411ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
412ea844a1aSMatthew Knepley }
413ea844a1aSMatthew Knepley 
414ea844a1aSMatthew Knepley /*@C
415ea844a1aSMatthew Knepley   PetscSectionSetFieldName - Sets the name of a field in the PetscSection
416ea844a1aSMatthew Knepley 
417ea844a1aSMatthew Knepley   Not Collective
418ea844a1aSMatthew Knepley 
419ea844a1aSMatthew Knepley   Input Parameters:
420ea844a1aSMatthew Knepley + s     - the PetscSection
421ea844a1aSMatthew Knepley . field - the field number
422ea844a1aSMatthew Knepley - fieldName - the field name
423ea844a1aSMatthew Knepley 
424ea844a1aSMatthew Knepley   Level: intermediate
425ea844a1aSMatthew Knepley 
426ea844a1aSMatthew Knepley .seealso: PetscSectionGetFieldName()
427ea844a1aSMatthew Knepley @*/
428ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetFieldName(PetscSection s, PetscInt field, const char fieldName[])
429ea844a1aSMatthew Knepley {
430ea844a1aSMatthew Knepley   PetscErrorCode ierr;
431ea844a1aSMatthew Knepley 
432ea844a1aSMatthew Knepley   PetscFunctionBegin;
433ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
434ea844a1aSMatthew Knepley   if (fieldName) PetscValidCharPointer(fieldName, 3);
435ea844a1aSMatthew Knepley   if ((field < 0) || (field >= s->numFields)) SETERRQ3(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Section field %D should be in [%D, %D)", field, 0, s->numFields);
436ea844a1aSMatthew Knepley   ierr = PetscFree(s->fieldNames[field]);CHKERRQ(ierr);
437ea844a1aSMatthew Knepley   ierr = PetscStrallocpy(fieldName, (char**) &s->fieldNames[field]);CHKERRQ(ierr);
438ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
439ea844a1aSMatthew Knepley }
440ea844a1aSMatthew Knepley 
441b778fa18SValeria Barra /*@C
442b778fa18SValeria Barra   PetscSectionGetComponentName - Gets the name of a field component in the PetscSection
443b778fa18SValeria Barra 
444b778fa18SValeria Barra   Not Collective
445b778fa18SValeria Barra 
446b778fa18SValeria Barra   Input Parameters:
447b778fa18SValeria Barra + s     - the PetscSection
448b778fa18SValeria Barra . field - the field number
449b778fa18SValeria Barra . comp  - the component number
450b778fa18SValeria Barra - compName - the component name
451b778fa18SValeria Barra 
452b778fa18SValeria Barra   Level: intermediate
453b778fa18SValeria Barra 
454b778fa18SValeria Barra .seealso: PetscSectionSetComponentName()
455b778fa18SValeria Barra @*/
456b778fa18SValeria Barra PetscErrorCode PetscSectionGetComponentName(PetscSection s, PetscInt field, PetscInt comp, const char *compName[])
457b778fa18SValeria Barra {
458b778fa18SValeria Barra   PetscFunctionBegin;
459b778fa18SValeria Barra   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
460b778fa18SValeria Barra   PetscValidPointer(compName, 3);
461b778fa18SValeria Barra   if ((field < 0) || (field >= s->numFields)) SETERRQ3(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Section field %D should be in [%D, %D)", field, 0, s->numFields);
462b778fa18SValeria Barra   if ((comp < 0) || (comp >= s->numFieldComponents[field])) SETERRQ3(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Section field component %D should be in [%D, %D)", comp, 0, s->numFieldComponents[field]);
463b778fa18SValeria Barra   *compName = s->compNames[field][comp];
464b778fa18SValeria Barra   PetscFunctionReturn(0);
465b778fa18SValeria Barra }
466b778fa18SValeria Barra 
467b778fa18SValeria Barra /*@C
468b778fa18SValeria Barra   PetscSectionSetComponentName - Sets the name of a field component in the PetscSection
469b778fa18SValeria Barra 
470b778fa18SValeria Barra   Not Collective
471b778fa18SValeria Barra 
472b778fa18SValeria Barra   Input Parameters:
473b778fa18SValeria Barra + s     - the PetscSection
474b778fa18SValeria Barra . field - the field number
475b778fa18SValeria Barra . comp  - the component number
476b778fa18SValeria Barra - compName - the component name
477b778fa18SValeria Barra 
478b778fa18SValeria Barra   Level: intermediate
479b778fa18SValeria Barra 
480b778fa18SValeria Barra .seealso: PetscSectionGetComponentName()
481b778fa18SValeria Barra @*/
482b778fa18SValeria Barra PetscErrorCode PetscSectionSetComponentName(PetscSection s, PetscInt field, PetscInt comp, const char compName[])
483b778fa18SValeria Barra {
484b778fa18SValeria Barra   PetscErrorCode ierr;
485b778fa18SValeria Barra 
486b778fa18SValeria Barra   PetscFunctionBegin;
487b778fa18SValeria Barra   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
488b778fa18SValeria Barra   if (compName) PetscValidCharPointer(compName, 3);
489b778fa18SValeria Barra   if ((field < 0) || (field >= s->numFields)) SETERRQ3(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Section field %D should be in [%D, %D)", field, 0, s->numFields);
490b778fa18SValeria Barra   if ((comp < 0) || (comp >= s->numFieldComponents[field])) SETERRQ3(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Section field component %D should be in [%D, %D)", comp, 0, s->numFieldComponents[field]);
491b778fa18SValeria Barra   ierr = PetscFree(s->compNames[field][comp]);CHKERRQ(ierr);
492b778fa18SValeria Barra   ierr = PetscStrallocpy(compName, (char**) &s->compNames[field][comp]);CHKERRQ(ierr);
493b778fa18SValeria Barra   PetscFunctionReturn(0);
494b778fa18SValeria Barra }
495b778fa18SValeria Barra 
496ea844a1aSMatthew Knepley /*@
497ea844a1aSMatthew Knepley   PetscSectionGetFieldComponents - Returns the number of field components for the given field.
498ea844a1aSMatthew Knepley 
499ea844a1aSMatthew Knepley   Not collective
500ea844a1aSMatthew Knepley 
501ea844a1aSMatthew Knepley   Input Parameters:
502ea844a1aSMatthew Knepley + s - the PetscSection
503ea844a1aSMatthew Knepley - field - the field number
504ea844a1aSMatthew Knepley 
505ea844a1aSMatthew Knepley   Output Parameter:
506ea844a1aSMatthew Knepley . numComp - the number of field components
507ea844a1aSMatthew Knepley 
508ea844a1aSMatthew Knepley   Level: intermediate
509ea844a1aSMatthew Knepley 
510ea844a1aSMatthew Knepley .seealso: PetscSectionSetFieldComponents(), PetscSectionGetNumFields()
511ea844a1aSMatthew Knepley @*/
512ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetFieldComponents(PetscSection s, PetscInt field, PetscInt *numComp)
513ea844a1aSMatthew Knepley {
514ea844a1aSMatthew Knepley   PetscFunctionBegin;
515ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
516ea844a1aSMatthew Knepley   PetscValidPointer(numComp, 3);
517ea844a1aSMatthew Knepley   if ((field < 0) || (field >= s->numFields)) SETERRQ3(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Section field %D should be in [%D, %D)", field, 0, s->numFields);
518ea844a1aSMatthew Knepley   *numComp = s->numFieldComponents[field];
519ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
520ea844a1aSMatthew Knepley }
521ea844a1aSMatthew Knepley 
522ea844a1aSMatthew Knepley /*@
523ea844a1aSMatthew Knepley   PetscSectionSetFieldComponents - Sets the number of field components for the given field.
524ea844a1aSMatthew Knepley 
525ea844a1aSMatthew Knepley   Not collective
526ea844a1aSMatthew Knepley 
527ea844a1aSMatthew Knepley   Input Parameters:
528ea844a1aSMatthew Knepley + s - the PetscSection
529ea844a1aSMatthew Knepley . field - the field number
530ea844a1aSMatthew Knepley - numComp - the number of field components
531ea844a1aSMatthew Knepley 
532ea844a1aSMatthew Knepley   Level: intermediate
533ea844a1aSMatthew Knepley 
534245d9833Sprj- .seealso: PetscSectionGetFieldComponents(), PetscSectionGetNumFields()
535ea844a1aSMatthew Knepley @*/
536ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetFieldComponents(PetscSection s, PetscInt field, PetscInt numComp)
537ea844a1aSMatthew Knepley {
538b778fa18SValeria Barra   PetscErrorCode ierr;
539b778fa18SValeria Barra   PetscInt c;
540b778fa18SValeria Barra   char name[64];
541b778fa18SValeria Barra 
542ea844a1aSMatthew Knepley   PetscFunctionBegin;
543ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
544ea844a1aSMatthew Knepley   if ((field < 0) || (field >= s->numFields)) SETERRQ3(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Section field %D should be in [%D, %D)", field, 0, s->numFields);
545b778fa18SValeria Barra   if (s->compNames) {
546b778fa18SValeria Barra     for (c = 0; c < s->numFieldComponents[field]; ++c) {
547b778fa18SValeria Barra       ierr = PetscFree(s->compNames[field][c]);CHKERRQ(ierr);
548b778fa18SValeria Barra     }
549b778fa18SValeria Barra     ierr = PetscFree(s->compNames[field]);CHKERRQ(ierr);
550b778fa18SValeria Barra   }
551b778fa18SValeria Barra 
552ea844a1aSMatthew Knepley   s->numFieldComponents[field] = numComp;
553b778fa18SValeria Barra   if (numComp) {
554b778fa18SValeria Barra     ierr = PetscMalloc1(numComp, (char ***) &s->compNames[field]);CHKERRQ(ierr);
555b778fa18SValeria Barra     for (c = 0; c < numComp; ++c) {
556b778fa18SValeria Barra       ierr = PetscSNPrintf(name, 64, "%D", c);CHKERRQ(ierr);
557b778fa18SValeria Barra       ierr = PetscStrallocpy(name, (char **) &s->compNames[field][c]);CHKERRQ(ierr);
558b778fa18SValeria Barra     }
559b778fa18SValeria Barra   }
560ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
561ea844a1aSMatthew Knepley }
562ea844a1aSMatthew Knepley 
563ea844a1aSMatthew Knepley static PetscErrorCode PetscSectionCheckConstraints_Static(PetscSection s)
564ea844a1aSMatthew Knepley {
565ea844a1aSMatthew Knepley   PetscErrorCode ierr;
566ea844a1aSMatthew Knepley 
567ea844a1aSMatthew Knepley   PetscFunctionBegin;
568ea844a1aSMatthew Knepley   if (!s->bc) {
569ea844a1aSMatthew Knepley     ierr = PetscSectionCreate(PETSC_COMM_SELF, &s->bc);CHKERRQ(ierr);
570ea844a1aSMatthew Knepley     ierr = PetscSectionSetChart(s->bc, s->pStart, s->pEnd);CHKERRQ(ierr);
571ea844a1aSMatthew Knepley   }
572ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
573ea844a1aSMatthew Knepley }
574ea844a1aSMatthew Knepley 
575ea844a1aSMatthew Knepley /*@
576ea844a1aSMatthew Knepley   PetscSectionGetChart - Returns the range [pStart, pEnd) in which points lie.
577ea844a1aSMatthew Knepley 
578ea844a1aSMatthew Knepley   Not collective
579ea844a1aSMatthew Knepley 
580ea844a1aSMatthew Knepley   Input Parameter:
581ea844a1aSMatthew Knepley . s - the PetscSection
582ea844a1aSMatthew Knepley 
583ea844a1aSMatthew Knepley   Output Parameters:
584ea844a1aSMatthew Knepley + pStart - the first point
585ea844a1aSMatthew Knepley - pEnd - one past the last point
586ea844a1aSMatthew Knepley 
587ea844a1aSMatthew Knepley   Level: intermediate
588ea844a1aSMatthew Knepley 
589ea844a1aSMatthew Knepley .seealso: PetscSectionSetChart(), PetscSectionCreate()
590ea844a1aSMatthew Knepley @*/
591ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetChart(PetscSection s, PetscInt *pStart, PetscInt *pEnd)
592ea844a1aSMatthew Knepley {
593ea844a1aSMatthew Knepley   PetscFunctionBegin;
594ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
595ea844a1aSMatthew Knepley   if (pStart) *pStart = s->pStart;
596ea844a1aSMatthew Knepley   if (pEnd)   *pEnd   = s->pEnd;
597ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
598ea844a1aSMatthew Knepley }
599ea844a1aSMatthew Knepley 
600ea844a1aSMatthew Knepley /*@
601ea844a1aSMatthew Knepley   PetscSectionSetChart - Sets the range [pStart, pEnd) in which points lie.
602ea844a1aSMatthew Knepley 
603ea844a1aSMatthew Knepley   Not collective
604ea844a1aSMatthew Knepley 
605ea844a1aSMatthew Knepley   Input Parameters:
606ea844a1aSMatthew Knepley + s - the PetscSection
607ea844a1aSMatthew Knepley . pStart - the first point
608ea844a1aSMatthew Knepley - pEnd - one past the last point
609ea844a1aSMatthew Knepley 
610ea844a1aSMatthew Knepley   Level: intermediate
611ea844a1aSMatthew Knepley 
612ea844a1aSMatthew Knepley .seealso: PetscSectionGetChart(), PetscSectionCreate()
613ea844a1aSMatthew Knepley @*/
614ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetChart(PetscSection s, PetscInt pStart, PetscInt pEnd)
615ea844a1aSMatthew Knepley {
616ea844a1aSMatthew Knepley   PetscInt       f;
617ea844a1aSMatthew Knepley   PetscErrorCode ierr;
618ea844a1aSMatthew Knepley 
619ea844a1aSMatthew Knepley   PetscFunctionBegin;
620ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
621ea844a1aSMatthew Knepley   /* Cannot Reset() because it destroys field information */
622ea844a1aSMatthew Knepley   s->setup = PETSC_FALSE;
623ea844a1aSMatthew Knepley   ierr = PetscSectionDestroy(&s->bc);CHKERRQ(ierr);
624ea844a1aSMatthew Knepley   ierr = PetscFree(s->bcIndices);CHKERRQ(ierr);
625ea844a1aSMatthew Knepley   ierr = PetscFree2(s->atlasDof, s->atlasOff);CHKERRQ(ierr);
626ea844a1aSMatthew Knepley 
627ea844a1aSMatthew Knepley   s->pStart = pStart;
628ea844a1aSMatthew Knepley   s->pEnd   = pEnd;
629ea844a1aSMatthew Knepley   ierr = PetscMalloc2((pEnd - pStart), &s->atlasDof, (pEnd - pStart), &s->atlasOff);CHKERRQ(ierr);
630ea844a1aSMatthew Knepley   ierr = PetscArrayzero(s->atlasDof, pEnd - pStart);CHKERRQ(ierr);
631ea844a1aSMatthew Knepley   for (f = 0; f < s->numFields; ++f) {
632ea844a1aSMatthew Knepley     ierr = PetscSectionSetChart(s->field[f], pStart, pEnd);CHKERRQ(ierr);
633ea844a1aSMatthew Knepley   }
634ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
635ea844a1aSMatthew Knepley }
636ea844a1aSMatthew Knepley 
637ea844a1aSMatthew Knepley /*@
638ea844a1aSMatthew Knepley   PetscSectionGetPermutation - Returns the permutation of [0, pEnd-pStart) or NULL
639ea844a1aSMatthew Knepley 
640ea844a1aSMatthew Knepley   Not collective
641ea844a1aSMatthew Knepley 
642ea844a1aSMatthew Knepley   Input Parameter:
643ea844a1aSMatthew Knepley . s - the PetscSection
644ea844a1aSMatthew Knepley 
645ea844a1aSMatthew Knepley   Output Parameters:
646ea844a1aSMatthew Knepley . perm - The permutation as an IS
647ea844a1aSMatthew Knepley 
648ea844a1aSMatthew Knepley   Level: intermediate
649ea844a1aSMatthew Knepley 
650ea844a1aSMatthew Knepley .seealso: PetscSectionSetPermutation(), PetscSectionCreate()
651ea844a1aSMatthew Knepley @*/
652ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetPermutation(PetscSection s, IS *perm)
653ea844a1aSMatthew Knepley {
654ea844a1aSMatthew Knepley   PetscFunctionBegin;
655ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
656ea844a1aSMatthew Knepley   if (perm) {PetscValidPointer(perm, 2); *perm = s->perm;}
657ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
658ea844a1aSMatthew Knepley }
659ea844a1aSMatthew Knepley 
660ea844a1aSMatthew Knepley /*@
661ea844a1aSMatthew Knepley   PetscSectionSetPermutation - Sets the permutation for [0, pEnd-pStart)
662ea844a1aSMatthew Knepley 
663ea844a1aSMatthew Knepley   Not collective
664ea844a1aSMatthew Knepley 
665ea844a1aSMatthew Knepley   Input Parameters:
666ea844a1aSMatthew Knepley + s - the PetscSection
667ea844a1aSMatthew Knepley - perm - the permutation of points
668ea844a1aSMatthew Knepley 
669ea844a1aSMatthew Knepley   Level: intermediate
670ea844a1aSMatthew Knepley 
671ea844a1aSMatthew Knepley .seealso: PetscSectionGetPermutation(), PetscSectionCreate()
672ea844a1aSMatthew Knepley @*/
673ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetPermutation(PetscSection s, IS perm)
674ea844a1aSMatthew Knepley {
675ea844a1aSMatthew Knepley   PetscErrorCode ierr;
676ea844a1aSMatthew Knepley 
677ea844a1aSMatthew Knepley   PetscFunctionBegin;
678ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
679ea844a1aSMatthew Knepley   if (perm) PetscValidHeaderSpecific(perm, IS_CLASSID, 2);
680ea844a1aSMatthew Knepley   if (s->setup) SETERRQ(PetscObjectComm((PetscObject) s), PETSC_ERR_ARG_WRONGSTATE, "Cannot set a permutation after the section is setup");
681ea844a1aSMatthew Knepley   if (s->perm != perm) {
682ea844a1aSMatthew Knepley     ierr = ISDestroy(&s->perm);CHKERRQ(ierr);
683ea844a1aSMatthew Knepley     if (perm) {
684ea844a1aSMatthew Knepley       s->perm = perm;
685ea844a1aSMatthew Knepley       ierr = PetscObjectReference((PetscObject) s->perm);CHKERRQ(ierr);
686ea844a1aSMatthew Knepley     }
687ea844a1aSMatthew Knepley   }
688ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
689ea844a1aSMatthew Knepley }
690ea844a1aSMatthew Knepley 
691ea844a1aSMatthew Knepley /*@
692ea844a1aSMatthew Knepley   PetscSectionGetPointMajor - Returns the flag for dof ordering, true if it is point major, otherwise field major
693ea844a1aSMatthew Knepley 
694ea844a1aSMatthew Knepley   Not collective
695ea844a1aSMatthew Knepley 
696ea844a1aSMatthew Knepley   Input Parameter:
697ea844a1aSMatthew Knepley . s - the PetscSection
698ea844a1aSMatthew Knepley 
699ea844a1aSMatthew Knepley   Output Parameter:
700ea844a1aSMatthew Knepley . pm - the flag for point major ordering
701ea844a1aSMatthew Knepley 
702ea844a1aSMatthew Knepley   Level: intermediate
703ea844a1aSMatthew Knepley 
704ea844a1aSMatthew Knepley .seealso: PetscSectionSetPointMajor()
705ea844a1aSMatthew Knepley @*/
706ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetPointMajor(PetscSection s, PetscBool *pm)
707ea844a1aSMatthew Knepley {
708ea844a1aSMatthew Knepley   PetscFunctionBegin;
709ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
710ea844a1aSMatthew Knepley   PetscValidPointer(pm,2);
711ea844a1aSMatthew Knepley   *pm = s->pointMajor;
712ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
713ea844a1aSMatthew Knepley }
714ea844a1aSMatthew Knepley 
715ea844a1aSMatthew Knepley /*@
716ea844a1aSMatthew Knepley   PetscSectionSetPointMajor - Sets the flag for dof ordering, true if it is point major, otherwise field major
717ea844a1aSMatthew Knepley 
718ea844a1aSMatthew Knepley   Not collective
719ea844a1aSMatthew Knepley 
720ea844a1aSMatthew Knepley   Input Parameters:
721ea844a1aSMatthew Knepley + s  - the PetscSection
722ea844a1aSMatthew Knepley - pm - the flag for point major ordering
723ea844a1aSMatthew Knepley 
724ea844a1aSMatthew Knepley   Not collective
725ea844a1aSMatthew Knepley 
726ea844a1aSMatthew Knepley   Level: intermediate
727ea844a1aSMatthew Knepley 
728ea844a1aSMatthew Knepley .seealso: PetscSectionGetPointMajor()
729ea844a1aSMatthew Knepley @*/
730ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetPointMajor(PetscSection s, PetscBool pm)
731ea844a1aSMatthew Knepley {
732ea844a1aSMatthew Knepley   PetscFunctionBegin;
733ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
734ea844a1aSMatthew Knepley   if (s->setup) SETERRQ(PetscObjectComm((PetscObject) s), PETSC_ERR_ARG_WRONGSTATE, "Cannot set the dof ordering after the section is setup");
735ea844a1aSMatthew Knepley   s->pointMajor = pm;
736ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
737ea844a1aSMatthew Knepley }
738ea844a1aSMatthew Knepley 
739ea844a1aSMatthew Knepley /*@
740ea844a1aSMatthew Knepley   PetscSectionGetDof - Return the number of degrees of freedom associated with a given point.
741ea844a1aSMatthew Knepley 
742ea844a1aSMatthew Knepley   Not collective
743ea844a1aSMatthew Knepley 
744ea844a1aSMatthew Knepley   Input Parameters:
745ea844a1aSMatthew Knepley + s - the PetscSection
746ea844a1aSMatthew Knepley - point - the point
747ea844a1aSMatthew Knepley 
748ea844a1aSMatthew Knepley   Output Parameter:
749ea844a1aSMatthew Knepley . numDof - the number of dof
750ea844a1aSMatthew Knepley 
751ea844a1aSMatthew Knepley   Level: intermediate
752ea844a1aSMatthew Knepley 
753ea844a1aSMatthew Knepley .seealso: PetscSectionSetDof(), PetscSectionCreate()
754ea844a1aSMatthew Knepley @*/
755ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetDof(PetscSection s, PetscInt point, PetscInt *numDof)
756ea844a1aSMatthew Knepley {
75776bd3646SJed Brown   PetscFunctionBeginHot;
758ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
759ea844a1aSMatthew Knepley   PetscValidPointer(numDof, 3);
76076bd3646SJed Brown   if (PetscDefined(USE_DEBUG)) {
761ea844a1aSMatthew Knepley     if ((point < s->pStart) || (point >= s->pEnd)) SETERRQ3(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Section point %D should be in [%D, %D)", point, s->pStart, s->pEnd);
76276bd3646SJed Brown   }
763ea844a1aSMatthew Knepley   *numDof = s->atlasDof[point - s->pStart];
764ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
765ea844a1aSMatthew Knepley }
766ea844a1aSMatthew Knepley 
767ea844a1aSMatthew Knepley /*@
768ea844a1aSMatthew Knepley   PetscSectionSetDof - Sets the number of degrees of freedom associated with a given point.
769ea844a1aSMatthew Knepley 
770ea844a1aSMatthew Knepley   Not collective
771ea844a1aSMatthew Knepley 
772ea844a1aSMatthew Knepley   Input Parameters:
773ea844a1aSMatthew Knepley + s - the PetscSection
774ea844a1aSMatthew Knepley . point - the point
775ea844a1aSMatthew Knepley - numDof - the number of dof
776ea844a1aSMatthew Knepley 
777ea844a1aSMatthew Knepley   Level: intermediate
778ea844a1aSMatthew Knepley 
779ea844a1aSMatthew Knepley .seealso: PetscSectionGetDof(), PetscSectionAddDof(), PetscSectionCreate()
780ea844a1aSMatthew Knepley @*/
781ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetDof(PetscSection s, PetscInt point, PetscInt numDof)
782ea844a1aSMatthew Knepley {
783ea844a1aSMatthew Knepley   PetscFunctionBegin;
784ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
785ea844a1aSMatthew Knepley   if ((point < s->pStart) || (point >= s->pEnd)) SETERRQ3(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Section point %D should be in [%D, %D)", point, s->pStart, s->pEnd);
786ea844a1aSMatthew Knepley   s->atlasDof[point - s->pStart] = numDof;
787ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
788ea844a1aSMatthew Knepley }
789ea844a1aSMatthew Knepley 
790ea844a1aSMatthew Knepley /*@
791ea844a1aSMatthew Knepley   PetscSectionAddDof - Adds to the number of degrees of freedom associated with a given point.
792ea844a1aSMatthew Knepley 
793ea844a1aSMatthew Knepley   Not collective
794ea844a1aSMatthew Knepley 
795ea844a1aSMatthew Knepley   Input Parameters:
796ea844a1aSMatthew Knepley + s - the PetscSection
797ea844a1aSMatthew Knepley . point - the point
798ea844a1aSMatthew Knepley - numDof - the number of additional dof
799ea844a1aSMatthew Knepley 
800ea844a1aSMatthew Knepley   Level: intermediate
801ea844a1aSMatthew Knepley 
802ea844a1aSMatthew Knepley .seealso: PetscSectionGetDof(), PetscSectionSetDof(), PetscSectionCreate()
803ea844a1aSMatthew Knepley @*/
804ea844a1aSMatthew Knepley PetscErrorCode PetscSectionAddDof(PetscSection s, PetscInt point, PetscInt numDof)
805ea844a1aSMatthew Knepley {
80676bd3646SJed Brown   PetscFunctionBeginHot;
807ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
80876bd3646SJed Brown   if (PetscDefined(USE_DEBUG)) {
809ea844a1aSMatthew Knepley     if ((point < s->pStart) || (point >= s->pEnd)) SETERRQ3(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Section point %D should be in [%D, %D)", point, s->pStart, s->pEnd);
81076bd3646SJed Brown   }
811ea844a1aSMatthew Knepley   s->atlasDof[point - s->pStart] += numDof;
812ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
813ea844a1aSMatthew Knepley }
814ea844a1aSMatthew Knepley 
815ea844a1aSMatthew Knepley /*@
816ea844a1aSMatthew Knepley   PetscSectionGetFieldDof - Return the number of degrees of freedom associated with a field on a given point.
817ea844a1aSMatthew Knepley 
818ea844a1aSMatthew Knepley   Not collective
819ea844a1aSMatthew Knepley 
820ea844a1aSMatthew Knepley   Input Parameters:
821ea844a1aSMatthew Knepley + s - the PetscSection
822ea844a1aSMatthew Knepley . point - the point
823ea844a1aSMatthew Knepley - field - the field
824ea844a1aSMatthew Knepley 
825ea844a1aSMatthew Knepley   Output Parameter:
826ea844a1aSMatthew Knepley . numDof - the number of dof
827ea844a1aSMatthew Knepley 
828ea844a1aSMatthew Knepley   Level: intermediate
829ea844a1aSMatthew Knepley 
830ea844a1aSMatthew Knepley .seealso: PetscSectionSetFieldDof(), PetscSectionCreate()
831ea844a1aSMatthew Knepley @*/
832ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetFieldDof(PetscSection s, PetscInt point, PetscInt field, PetscInt *numDof)
833ea844a1aSMatthew Knepley {
834ea844a1aSMatthew Knepley   PetscErrorCode ierr;
835ea844a1aSMatthew Knepley 
836ea844a1aSMatthew Knepley   PetscFunctionBegin;
837ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
838ea844a1aSMatthew Knepley   if ((field < 0) || (field >= s->numFields)) SETERRQ3(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Section field %D should be in [%D, %D)", field, 0, s->numFields);
839ea844a1aSMatthew Knepley   ierr = PetscSectionGetDof(s->field[field], point, numDof);CHKERRQ(ierr);
840ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
841ea844a1aSMatthew Knepley }
842ea844a1aSMatthew Knepley 
843ea844a1aSMatthew Knepley /*@
844ea844a1aSMatthew Knepley   PetscSectionSetFieldDof - Sets the number of degrees of freedom associated with a field on a given point.
845ea844a1aSMatthew Knepley 
846ea844a1aSMatthew Knepley   Not collective
847ea844a1aSMatthew Knepley 
848ea844a1aSMatthew Knepley   Input Parameters:
849ea844a1aSMatthew Knepley + s - the PetscSection
850ea844a1aSMatthew Knepley . point - the point
851ea844a1aSMatthew Knepley . field - the field
852ea844a1aSMatthew Knepley - numDof - the number of dof
853ea844a1aSMatthew Knepley 
854ea844a1aSMatthew Knepley   Level: intermediate
855ea844a1aSMatthew Knepley 
856ea844a1aSMatthew Knepley .seealso: PetscSectionGetFieldDof(), PetscSectionCreate()
857ea844a1aSMatthew Knepley @*/
858ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetFieldDof(PetscSection s, PetscInt point, PetscInt field, PetscInt numDof)
859ea844a1aSMatthew Knepley {
860ea844a1aSMatthew Knepley   PetscErrorCode ierr;
861ea844a1aSMatthew Knepley 
862ea844a1aSMatthew Knepley   PetscFunctionBegin;
863ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
864ea844a1aSMatthew Knepley   if ((field < 0) || (field >= s->numFields)) SETERRQ3(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Section field %D should be in [%D, %D)", field, 0, s->numFields);
865ea844a1aSMatthew Knepley   ierr = PetscSectionSetDof(s->field[field], point, numDof);CHKERRQ(ierr);
866ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
867ea844a1aSMatthew Knepley }
868ea844a1aSMatthew Knepley 
869ea844a1aSMatthew Knepley /*@
870ea844a1aSMatthew Knepley   PetscSectionAddFieldDof - Adds a number of degrees of freedom associated with a field on a given point.
871ea844a1aSMatthew Knepley 
872ea844a1aSMatthew Knepley   Not collective
873ea844a1aSMatthew Knepley 
874ea844a1aSMatthew Knepley   Input Parameters:
875ea844a1aSMatthew Knepley + s - the PetscSection
876ea844a1aSMatthew Knepley . point - the point
877ea844a1aSMatthew Knepley . field - the field
878ea844a1aSMatthew Knepley - numDof - the number of dof
879ea844a1aSMatthew Knepley 
880ea844a1aSMatthew Knepley   Level: intermediate
881ea844a1aSMatthew Knepley 
882ea844a1aSMatthew Knepley .seealso: PetscSectionSetFieldDof(), PetscSectionGetFieldDof(), PetscSectionCreate()
883ea844a1aSMatthew Knepley @*/
884ea844a1aSMatthew Knepley PetscErrorCode PetscSectionAddFieldDof(PetscSection s, PetscInt point, PetscInt field, PetscInt numDof)
885ea844a1aSMatthew Knepley {
886ea844a1aSMatthew Knepley   PetscErrorCode ierr;
887ea844a1aSMatthew Knepley 
888ea844a1aSMatthew Knepley   PetscFunctionBegin;
889ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
890ea844a1aSMatthew Knepley   if ((field < 0) || (field >= s->numFields)) SETERRQ3(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Section field %D should be in [%D, %D)", field, 0, s->numFields);
891ea844a1aSMatthew Knepley   ierr = PetscSectionAddDof(s->field[field], point, numDof);CHKERRQ(ierr);
892ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
893ea844a1aSMatthew Knepley }
894ea844a1aSMatthew Knepley 
895ea844a1aSMatthew Knepley /*@
896ea844a1aSMatthew Knepley   PetscSectionGetConstraintDof - Return the number of constrained degrees of freedom associated with a given point.
897ea844a1aSMatthew Knepley 
898ea844a1aSMatthew Knepley   Not collective
899ea844a1aSMatthew Knepley 
900ea844a1aSMatthew Knepley   Input Parameters:
901ea844a1aSMatthew Knepley + s - the PetscSection
902ea844a1aSMatthew Knepley - point - the point
903ea844a1aSMatthew Knepley 
904ea844a1aSMatthew Knepley   Output Parameter:
905ea844a1aSMatthew Knepley . numDof - the number of dof which are fixed by constraints
906ea844a1aSMatthew Knepley 
907ea844a1aSMatthew Knepley   Level: intermediate
908ea844a1aSMatthew Knepley 
909ea844a1aSMatthew Knepley .seealso: PetscSectionGetDof(), PetscSectionSetConstraintDof(), PetscSectionCreate()
910ea844a1aSMatthew Knepley @*/
911ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetConstraintDof(PetscSection s, PetscInt point, PetscInt *numDof)
912ea844a1aSMatthew Knepley {
913ea844a1aSMatthew Knepley   PetscErrorCode ierr;
914ea844a1aSMatthew Knepley 
915ea844a1aSMatthew Knepley   PetscFunctionBegin;
916ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
917ea844a1aSMatthew Knepley   PetscValidPointer(numDof, 3);
918ea844a1aSMatthew Knepley   if (s->bc) {
919ea844a1aSMatthew Knepley     ierr = PetscSectionGetDof(s->bc, point, numDof);CHKERRQ(ierr);
920ea844a1aSMatthew Knepley   } else *numDof = 0;
921ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
922ea844a1aSMatthew Knepley }
923ea844a1aSMatthew Knepley 
924ea844a1aSMatthew Knepley /*@
925ea844a1aSMatthew Knepley   PetscSectionSetConstraintDof - Set the number of constrained degrees of freedom associated with a given point.
926ea844a1aSMatthew Knepley 
927ea844a1aSMatthew Knepley   Not collective
928ea844a1aSMatthew Knepley 
929ea844a1aSMatthew Knepley   Input Parameters:
930ea844a1aSMatthew Knepley + s - the PetscSection
931ea844a1aSMatthew Knepley . point - the point
932ea844a1aSMatthew Knepley - numDof - the number of dof which are fixed by constraints
933ea844a1aSMatthew Knepley 
934ea844a1aSMatthew Knepley   Level: intermediate
935ea844a1aSMatthew Knepley 
936ea844a1aSMatthew Knepley .seealso: PetscSectionSetDof(), PetscSectionGetConstraintDof(), PetscSectionCreate()
937ea844a1aSMatthew Knepley @*/
938ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetConstraintDof(PetscSection s, PetscInt point, PetscInt numDof)
939ea844a1aSMatthew Knepley {
940ea844a1aSMatthew Knepley   PetscErrorCode ierr;
941ea844a1aSMatthew Knepley 
942ea844a1aSMatthew Knepley   PetscFunctionBegin;
943ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
944ea844a1aSMatthew Knepley   if (numDof) {
945ea844a1aSMatthew Knepley     ierr = PetscSectionCheckConstraints_Static(s);CHKERRQ(ierr);
946ea844a1aSMatthew Knepley     ierr = PetscSectionSetDof(s->bc, point, numDof);CHKERRQ(ierr);
947ea844a1aSMatthew Knepley   }
948ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
949ea844a1aSMatthew Knepley }
950ea844a1aSMatthew Knepley 
951ea844a1aSMatthew Knepley /*@
952ea844a1aSMatthew Knepley   PetscSectionAddConstraintDof - Increment the number of constrained degrees of freedom associated with a given point.
953ea844a1aSMatthew Knepley 
954ea844a1aSMatthew Knepley   Not collective
955ea844a1aSMatthew Knepley 
956ea844a1aSMatthew Knepley   Input Parameters:
957ea844a1aSMatthew Knepley + s - the PetscSection
958ea844a1aSMatthew Knepley . point - the point
959ea844a1aSMatthew Knepley - numDof - the number of additional dof which are fixed by constraints
960ea844a1aSMatthew Knepley 
961ea844a1aSMatthew Knepley   Level: intermediate
962ea844a1aSMatthew Knepley 
963ea844a1aSMatthew Knepley .seealso: PetscSectionAddDof(), PetscSectionGetConstraintDof(), PetscSectionCreate()
964ea844a1aSMatthew Knepley @*/
965ea844a1aSMatthew Knepley PetscErrorCode PetscSectionAddConstraintDof(PetscSection s, PetscInt point, PetscInt numDof)
966ea844a1aSMatthew Knepley {
967ea844a1aSMatthew Knepley   PetscErrorCode ierr;
968ea844a1aSMatthew Knepley 
969ea844a1aSMatthew Knepley   PetscFunctionBegin;
970ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
971ea844a1aSMatthew Knepley   if (numDof) {
972ea844a1aSMatthew Knepley     ierr = PetscSectionCheckConstraints_Static(s);CHKERRQ(ierr);
973ea844a1aSMatthew Knepley     ierr = PetscSectionAddDof(s->bc, point, numDof);CHKERRQ(ierr);
974ea844a1aSMatthew Knepley   }
975ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
976ea844a1aSMatthew Knepley }
977ea844a1aSMatthew Knepley 
978ea844a1aSMatthew Knepley /*@
979ea844a1aSMatthew Knepley   PetscSectionGetFieldConstraintDof - Return the number of constrained degrees of freedom associated with a given field on a point.
980ea844a1aSMatthew Knepley 
981ea844a1aSMatthew Knepley   Not collective
982ea844a1aSMatthew Knepley 
983ea844a1aSMatthew Knepley   Input Parameters:
984ea844a1aSMatthew Knepley + s - the PetscSection
985ea844a1aSMatthew Knepley . point - the point
986ea844a1aSMatthew Knepley - field - the field
987ea844a1aSMatthew Knepley 
988ea844a1aSMatthew Knepley   Output Parameter:
989ea844a1aSMatthew Knepley . numDof - the number of dof which are fixed by constraints
990ea844a1aSMatthew Knepley 
991ea844a1aSMatthew Knepley   Level: intermediate
992ea844a1aSMatthew Knepley 
993ea844a1aSMatthew Knepley .seealso: PetscSectionGetDof(), PetscSectionSetFieldConstraintDof(), PetscSectionCreate()
994ea844a1aSMatthew Knepley @*/
995ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetFieldConstraintDof(PetscSection s, PetscInt point, PetscInt field, PetscInt *numDof)
996ea844a1aSMatthew Knepley {
997ea844a1aSMatthew Knepley   PetscErrorCode ierr;
998ea844a1aSMatthew Knepley 
999ea844a1aSMatthew Knepley   PetscFunctionBegin;
1000ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1001ea844a1aSMatthew Knepley   PetscValidPointer(numDof, 4);
1002ea844a1aSMatthew Knepley   if ((field < 0) || (field >= s->numFields)) SETERRQ3(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Section field %D should be in [%D, %D)", field, 0, s->numFields);
1003ea844a1aSMatthew Knepley   ierr = PetscSectionGetConstraintDof(s->field[field], point, numDof);CHKERRQ(ierr);
1004ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1005ea844a1aSMatthew Knepley }
1006ea844a1aSMatthew Knepley 
1007ea844a1aSMatthew Knepley /*@
1008ea844a1aSMatthew Knepley   PetscSectionSetFieldConstraintDof - Set the number of constrained degrees of freedom associated with a given field on a point.
1009ea844a1aSMatthew Knepley 
1010ea844a1aSMatthew Knepley   Not collective
1011ea844a1aSMatthew Knepley 
1012ea844a1aSMatthew Knepley   Input Parameters:
1013ea844a1aSMatthew Knepley + s - the PetscSection
1014ea844a1aSMatthew Knepley . point - the point
1015ea844a1aSMatthew Knepley . field - the field
1016ea844a1aSMatthew Knepley - numDof - the number of dof which are fixed by constraints
1017ea844a1aSMatthew Knepley 
1018ea844a1aSMatthew Knepley   Level: intermediate
1019ea844a1aSMatthew Knepley 
1020ea844a1aSMatthew Knepley .seealso: PetscSectionSetDof(), PetscSectionGetFieldConstraintDof(), PetscSectionCreate()
1021ea844a1aSMatthew Knepley @*/
1022ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetFieldConstraintDof(PetscSection s, PetscInt point, PetscInt field, PetscInt numDof)
1023ea844a1aSMatthew Knepley {
1024ea844a1aSMatthew Knepley   PetscErrorCode ierr;
1025ea844a1aSMatthew Knepley 
1026ea844a1aSMatthew Knepley   PetscFunctionBegin;
1027ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1028ea844a1aSMatthew Knepley   if ((field < 0) || (field >= s->numFields)) SETERRQ3(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Section field %D should be in [%D, %D)", field, 0, s->numFields);
1029ea844a1aSMatthew Knepley   ierr = PetscSectionSetConstraintDof(s->field[field], point, numDof);CHKERRQ(ierr);
1030ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1031ea844a1aSMatthew Knepley }
1032ea844a1aSMatthew Knepley 
1033ea844a1aSMatthew Knepley /*@
1034ea844a1aSMatthew Knepley   PetscSectionAddFieldConstraintDof - Increment the number of constrained degrees of freedom associated with a given field on a point.
1035ea844a1aSMatthew Knepley 
1036ea844a1aSMatthew Knepley   Not collective
1037ea844a1aSMatthew Knepley 
1038ea844a1aSMatthew Knepley   Input Parameters:
1039ea844a1aSMatthew Knepley + s - the PetscSection
1040ea844a1aSMatthew Knepley . point - the point
1041ea844a1aSMatthew Knepley . field - the field
1042ea844a1aSMatthew Knepley - numDof - the number of additional dof which are fixed by constraints
1043ea844a1aSMatthew Knepley 
1044ea844a1aSMatthew Knepley   Level: intermediate
1045ea844a1aSMatthew Knepley 
1046ea844a1aSMatthew Knepley .seealso: PetscSectionAddDof(), PetscSectionGetFieldConstraintDof(), PetscSectionCreate()
1047ea844a1aSMatthew Knepley @*/
1048ea844a1aSMatthew Knepley PetscErrorCode PetscSectionAddFieldConstraintDof(PetscSection s, PetscInt point, PetscInt field, PetscInt numDof)
1049ea844a1aSMatthew Knepley {
1050ea844a1aSMatthew Knepley   PetscErrorCode ierr;
1051ea844a1aSMatthew Knepley 
1052ea844a1aSMatthew Knepley   PetscFunctionBegin;
1053ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1054ea844a1aSMatthew Knepley   if ((field < 0) || (field >= s->numFields)) SETERRQ3(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Section field %D should be in [%D, %D)", field, 0, s->numFields);
1055ea844a1aSMatthew Knepley   ierr = PetscSectionAddConstraintDof(s->field[field], point, numDof);CHKERRQ(ierr);
1056ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1057ea844a1aSMatthew Knepley }
1058ea844a1aSMatthew Knepley 
1059ea844a1aSMatthew Knepley /*@
1060ea844a1aSMatthew Knepley   PetscSectionSetUpBC - Setup the subsections describing boundary conditions.
1061ea844a1aSMatthew Knepley 
1062ea844a1aSMatthew Knepley   Not collective
1063ea844a1aSMatthew Knepley 
1064ea844a1aSMatthew Knepley   Input Parameter:
1065ea844a1aSMatthew Knepley . s - the PetscSection
1066ea844a1aSMatthew Knepley 
1067ea844a1aSMatthew Knepley   Level: advanced
1068ea844a1aSMatthew Knepley 
1069ea844a1aSMatthew Knepley .seealso: PetscSectionSetUp(), PetscSectionCreate()
1070ea844a1aSMatthew Knepley @*/
1071ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetUpBC(PetscSection s)
1072ea844a1aSMatthew Knepley {
1073ea844a1aSMatthew Knepley   PetscErrorCode ierr;
1074ea844a1aSMatthew Knepley 
1075ea844a1aSMatthew Knepley   PetscFunctionBegin;
1076ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1077ea844a1aSMatthew Knepley   if (s->bc) {
1078ea844a1aSMatthew Knepley     const PetscInt last = (s->bc->pEnd-s->bc->pStart) - 1;
1079ea844a1aSMatthew Knepley 
1080ea844a1aSMatthew Knepley     ierr = PetscSectionSetUp(s->bc);CHKERRQ(ierr);
108128d58a37SPierre Jolivet     ierr = PetscMalloc1(last >= 0 ? s->bc->atlasOff[last] + s->bc->atlasDof[last] : 0, &s->bcIndices);CHKERRQ(ierr);
1082ea844a1aSMatthew Knepley   }
1083ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1084ea844a1aSMatthew Knepley }
1085ea844a1aSMatthew Knepley 
1086ea844a1aSMatthew Knepley /*@
1087ea844a1aSMatthew Knepley   PetscSectionSetUp - Calculate offsets based upon the number of degrees of freedom for each point.
1088ea844a1aSMatthew Knepley 
1089ea844a1aSMatthew Knepley   Not collective
1090ea844a1aSMatthew Knepley 
1091ea844a1aSMatthew Knepley   Input Parameter:
1092ea844a1aSMatthew Knepley . s - the PetscSection
1093ea844a1aSMatthew Knepley 
1094ea844a1aSMatthew Knepley   Level: intermediate
1095ea844a1aSMatthew Knepley 
1096ea844a1aSMatthew Knepley .seealso: PetscSectionCreate()
1097ea844a1aSMatthew Knepley @*/
1098ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetUp(PetscSection s)
1099ea844a1aSMatthew Knepley {
1100ea844a1aSMatthew Knepley   const PetscInt *pind   = NULL;
1101ea844a1aSMatthew Knepley   PetscInt        offset = 0, foff, p, f;
1102ea844a1aSMatthew Knepley   PetscErrorCode  ierr;
1103ea844a1aSMatthew Knepley 
1104ea844a1aSMatthew Knepley   PetscFunctionBegin;
1105ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1106ea844a1aSMatthew Knepley   if (s->setup) PetscFunctionReturn(0);
1107ea844a1aSMatthew Knepley   s->setup = PETSC_TRUE;
1108ea844a1aSMatthew Knepley   /* Set offsets and field offsets for all points */
1109ea844a1aSMatthew Knepley   /*   Assume that all fields have the same chart */
1110ea844a1aSMatthew Knepley   if (s->perm) {ierr = ISGetIndices(s->perm, &pind);CHKERRQ(ierr);}
1111ea844a1aSMatthew Knepley   if (s->pointMajor) {
1112ea844a1aSMatthew Knepley     for (p = 0; p < s->pEnd - s->pStart; ++p) {
1113ea844a1aSMatthew Knepley       const PetscInt q = pind ? pind[p] : p;
1114ea844a1aSMatthew Knepley 
1115ea844a1aSMatthew Knepley       /* Set point offset */
1116ea844a1aSMatthew Knepley       s->atlasOff[q] = offset;
1117ea844a1aSMatthew Knepley       offset        += s->atlasDof[q];
1118ea844a1aSMatthew Knepley       s->maxDof      = PetscMax(s->maxDof, s->atlasDof[q]);
1119ea844a1aSMatthew Knepley       /* Set field offset */
1120ea844a1aSMatthew Knepley       for (f = 0, foff = s->atlasOff[q]; f < s->numFields; ++f) {
1121ea844a1aSMatthew Knepley         PetscSection sf = s->field[f];
1122ea844a1aSMatthew Knepley 
1123ea844a1aSMatthew Knepley         sf->atlasOff[q] = foff;
1124ea844a1aSMatthew Knepley         foff += sf->atlasDof[q];
1125ea844a1aSMatthew Knepley       }
1126ea844a1aSMatthew Knepley     }
1127ea844a1aSMatthew Knepley   } else {
1128ea844a1aSMatthew Knepley     /* Set field offsets for all points */
1129ea844a1aSMatthew Knepley     for (f = 0; f < s->numFields; ++f) {
1130ea844a1aSMatthew Knepley       PetscSection sf = s->field[f];
1131ea844a1aSMatthew Knepley 
1132ea844a1aSMatthew Knepley       for (p = 0; p < s->pEnd - s->pStart; ++p) {
1133ea844a1aSMatthew Knepley         const PetscInt q = pind ? pind[p] : p;
1134ea844a1aSMatthew Knepley 
1135ea844a1aSMatthew Knepley         sf->atlasOff[q] = offset;
1136ea844a1aSMatthew Knepley         offset += sf->atlasDof[q];
1137ea844a1aSMatthew Knepley       }
1138ea844a1aSMatthew Knepley     }
1139ea844a1aSMatthew Knepley     /* Disable point offsets since these are unused */
1140ea844a1aSMatthew Knepley     for (p = 0; p < s->pEnd - s->pStart; ++p) {
1141ea844a1aSMatthew Knepley       s->atlasOff[p] = -1;
1142ea844a1aSMatthew Knepley       s->maxDof      = PetscMax(s->maxDof, s->atlasDof[p]);
1143ea844a1aSMatthew Knepley     }
1144ea844a1aSMatthew Knepley   }
1145ea844a1aSMatthew Knepley   if (s->perm) {ierr = ISRestoreIndices(s->perm, &pind);CHKERRQ(ierr);}
1146ea844a1aSMatthew Knepley   /* Setup BC sections */
1147ea844a1aSMatthew Knepley   ierr = PetscSectionSetUpBC(s);CHKERRQ(ierr);
1148ea844a1aSMatthew Knepley   for (f = 0; f < s->numFields; ++f) {ierr = PetscSectionSetUpBC(s->field[f]);CHKERRQ(ierr);}
1149ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1150ea844a1aSMatthew Knepley }
1151ea844a1aSMatthew Knepley 
1152ea844a1aSMatthew Knepley /*@
1153ea844a1aSMatthew Knepley   PetscSectionGetMaxDof - Return the maximum number of degrees of freedom on any point in the chart
1154ea844a1aSMatthew Knepley 
1155ea844a1aSMatthew Knepley   Not collective
1156ea844a1aSMatthew Knepley 
1157ea844a1aSMatthew Knepley   Input Parameters:
1158ea844a1aSMatthew Knepley . s - the PetscSection
1159ea844a1aSMatthew Knepley 
1160ea844a1aSMatthew Knepley   Output Parameter:
1161ea844a1aSMatthew Knepley . maxDof - the maximum dof
1162ea844a1aSMatthew Knepley 
1163ea844a1aSMatthew Knepley   Level: intermediate
1164ea844a1aSMatthew Knepley 
1165ea844a1aSMatthew Knepley .seealso: PetscSectionGetDof(), PetscSectionSetDof(), PetscSectionCreate()
1166ea844a1aSMatthew Knepley @*/
1167ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetMaxDof(PetscSection s, PetscInt *maxDof)
1168ea844a1aSMatthew Knepley {
1169ea844a1aSMatthew Knepley   PetscFunctionBegin;
1170ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1171ea844a1aSMatthew Knepley   PetscValidPointer(maxDof, 2);
1172ea844a1aSMatthew Knepley   *maxDof = s->maxDof;
1173ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1174ea844a1aSMatthew Knepley }
1175ea844a1aSMatthew Knepley 
1176ea844a1aSMatthew Knepley /*@
1177ea844a1aSMatthew Knepley   PetscSectionGetStorageSize - Return the size of an array or local Vec capable of holding all the degrees of freedom.
1178ea844a1aSMatthew Knepley 
1179ea844a1aSMatthew Knepley   Not collective
1180ea844a1aSMatthew Knepley 
1181ea844a1aSMatthew Knepley   Input Parameter:
1182ea844a1aSMatthew Knepley . s - the PetscSection
1183ea844a1aSMatthew Knepley 
1184ea844a1aSMatthew Knepley   Output Parameter:
1185ea844a1aSMatthew Knepley . size - the size of an array which can hold all the dofs
1186ea844a1aSMatthew Knepley 
1187ea844a1aSMatthew Knepley   Level: intermediate
1188ea844a1aSMatthew Knepley 
1189ea844a1aSMatthew Knepley .seealso: PetscSectionGetOffset(), PetscSectionGetConstrainedStorageSize(), PetscSectionCreate()
1190ea844a1aSMatthew Knepley @*/
1191ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetStorageSize(PetscSection s, PetscInt *size)
1192ea844a1aSMatthew Knepley {
1193ea844a1aSMatthew Knepley   PetscInt p, n = 0;
1194ea844a1aSMatthew Knepley 
1195ea844a1aSMatthew Knepley   PetscFunctionBegin;
1196ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1197ea844a1aSMatthew Knepley   PetscValidPointer(size, 2);
1198ea844a1aSMatthew Knepley   for (p = 0; p < s->pEnd - s->pStart; ++p) n += s->atlasDof[p] > 0 ? s->atlasDof[p] : 0;
1199ea844a1aSMatthew Knepley   *size = n;
1200ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1201ea844a1aSMatthew Knepley }
1202ea844a1aSMatthew Knepley 
1203ea844a1aSMatthew Knepley /*@
1204ea844a1aSMatthew Knepley   PetscSectionGetConstrainedStorageSize - Return the size of an array or local Vec capable of holding all unconstrained degrees of freedom.
1205ea844a1aSMatthew Knepley 
1206ea844a1aSMatthew Knepley   Not collective
1207ea844a1aSMatthew Knepley 
1208064ec1f3Sprj-   Input Parameter:
1209064ec1f3Sprj- . s - the PetscSection
1210ea844a1aSMatthew Knepley 
1211ea844a1aSMatthew Knepley   Output Parameter:
1212ea844a1aSMatthew Knepley . size - the size of an array which can hold all unconstrained dofs
1213ea844a1aSMatthew Knepley 
1214ea844a1aSMatthew Knepley   Level: intermediate
1215ea844a1aSMatthew Knepley 
1216ea844a1aSMatthew Knepley .seealso: PetscSectionGetStorageSize(), PetscSectionGetOffset(), PetscSectionCreate()
1217ea844a1aSMatthew Knepley @*/
1218ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetConstrainedStorageSize(PetscSection s, PetscInt *size)
1219ea844a1aSMatthew Knepley {
1220ea844a1aSMatthew Knepley   PetscInt p, n = 0;
1221ea844a1aSMatthew Knepley 
1222ea844a1aSMatthew Knepley   PetscFunctionBegin;
1223ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1224ea844a1aSMatthew Knepley   PetscValidPointer(size, 2);
1225ea844a1aSMatthew Knepley   for (p = 0; p < s->pEnd - s->pStart; ++p) {
1226ea844a1aSMatthew Knepley     const PetscInt cdof = s->bc ? s->bc->atlasDof[p] : 0;
1227ea844a1aSMatthew Knepley     n += s->atlasDof[p] > 0 ? s->atlasDof[p] - cdof : 0;
1228ea844a1aSMatthew Knepley   }
1229ea844a1aSMatthew Knepley   *size = n;
1230ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1231ea844a1aSMatthew Knepley }
1232ea844a1aSMatthew Knepley 
1233ea844a1aSMatthew Knepley /*@
1234ea844a1aSMatthew Knepley   PetscSectionCreateGlobalSection - Create a section describing the global field layout using
1235ea844a1aSMatthew Knepley   the local section and an SF describing the section point overlap.
1236ea844a1aSMatthew Knepley 
1237ea844a1aSMatthew Knepley   Input Parameters:
1238ea844a1aSMatthew Knepley + s - The PetscSection for the local field layout
1239ea844a1aSMatthew Knepley . sf - The SF describing parallel layout of the section points (leaves are unowned local points)
1240ea844a1aSMatthew Knepley . includeConstraints - By default this is PETSC_FALSE, meaning that the global field vector will not possess constrained dofs
1241ea844a1aSMatthew Knepley - localOffsets - If PETSC_TRUE, use local rather than global offsets for the points
1242ea844a1aSMatthew Knepley 
1243ea844a1aSMatthew Knepley   Output Parameter:
1244ea844a1aSMatthew Knepley . gsection - The PetscSection for the global field layout
1245ea844a1aSMatthew Knepley 
1246ea844a1aSMatthew Knepley   Note: This gives negative sizes and offsets to points not owned by this process
1247ea844a1aSMatthew Knepley 
1248ea844a1aSMatthew Knepley   Level: intermediate
1249ea844a1aSMatthew Knepley 
1250ea844a1aSMatthew Knepley .seealso: PetscSectionCreate()
1251ea844a1aSMatthew Knepley @*/
1252ea844a1aSMatthew Knepley PetscErrorCode PetscSectionCreateGlobalSection(PetscSection s, PetscSF sf, PetscBool includeConstraints, PetscBool localOffsets, PetscSection *gsection)
1253ea844a1aSMatthew Knepley {
1254ea844a1aSMatthew Knepley   PetscSection    gs;
1255ea844a1aSMatthew Knepley   const PetscInt *pind = NULL;
1256ea844a1aSMatthew Knepley   PetscInt       *recv = NULL, *neg = NULL;
1257ea844a1aSMatthew Knepley   PetscInt        pStart, pEnd, p, dof, cdof, off, globalOff = 0, nroots, nlocal, maxleaf;
1258ea844a1aSMatthew Knepley   PetscErrorCode  ierr;
1259ea844a1aSMatthew Knepley 
1260ea844a1aSMatthew Knepley   PetscFunctionBegin;
1261ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1262ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
1263ea844a1aSMatthew Knepley   PetscValidLogicalCollectiveBool(s, includeConstraints, 3);
1264ea844a1aSMatthew Knepley   PetscValidLogicalCollectiveBool(s, localOffsets, 4);
1265ea844a1aSMatthew Knepley   PetscValidPointer(gsection, 5);
1266ea844a1aSMatthew Knepley   ierr = PetscSectionCreate(PetscObjectComm((PetscObject) s), &gs);CHKERRQ(ierr);
1267ea844a1aSMatthew Knepley   ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr);
1268ea844a1aSMatthew Knepley   ierr = PetscSectionSetChart(gs, pStart, pEnd);CHKERRQ(ierr);
1269ea844a1aSMatthew Knepley   ierr = PetscSFGetGraph(sf, &nroots, NULL, NULL, NULL);CHKERRQ(ierr);
1270ea844a1aSMatthew Knepley   nlocal = nroots;              /* The local/leaf space matches global/root space */
1271ea844a1aSMatthew Knepley   /* Must allocate for all points visible to SF, which may be more than this section */
1272ea844a1aSMatthew Knepley   if (nroots >= 0) {             /* nroots < 0 means that the graph has not been set, only happens in serial */
1273ea844a1aSMatthew Knepley     ierr = PetscSFGetLeafRange(sf, NULL, &maxleaf);CHKERRQ(ierr);
1274ea844a1aSMatthew Knepley     if (nroots < pEnd) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "SF roots %D < pEnd %D", nroots, pEnd);
1275ea844a1aSMatthew Knepley     if (maxleaf >= nroots) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "Max local leaf %D >= nroots %D", maxleaf, nroots);
1276ea844a1aSMatthew Knepley     ierr = PetscMalloc2(nroots,&neg,nlocal,&recv);CHKERRQ(ierr);
1277ea844a1aSMatthew Knepley     ierr = PetscArrayzero(neg,nroots);CHKERRQ(ierr);
1278ea844a1aSMatthew Knepley   }
1279ea844a1aSMatthew Knepley   /* Mark all local points with negative dof */
1280ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
1281ea844a1aSMatthew Knepley     ierr = PetscSectionGetDof(s, p, &dof);CHKERRQ(ierr);
1282ea844a1aSMatthew Knepley     ierr = PetscSectionSetDof(gs, p, dof);CHKERRQ(ierr);
1283ea844a1aSMatthew Knepley     ierr = PetscSectionGetConstraintDof(s, p, &cdof);CHKERRQ(ierr);
1284ea844a1aSMatthew Knepley     if (!includeConstraints && cdof > 0) {ierr = PetscSectionSetConstraintDof(gs, p, cdof);CHKERRQ(ierr);}
1285ea844a1aSMatthew Knepley     if (neg) neg[p] = -(dof+1);
1286ea844a1aSMatthew Knepley   }
1287ea844a1aSMatthew Knepley   ierr = PetscSectionSetUpBC(gs);CHKERRQ(ierr);
1288ea844a1aSMatthew Knepley   if (gs->bcIndices) {ierr = 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]);CHKERRQ(ierr);}
1289ea844a1aSMatthew Knepley   if (nroots >= 0) {
1290ea844a1aSMatthew Knepley     ierr = PetscArrayzero(recv,nlocal);CHKERRQ(ierr);
1291ea844a1aSMatthew Knepley     ierr = PetscSFBcastBegin(sf, MPIU_INT, neg, recv);CHKERRQ(ierr);
1292ea844a1aSMatthew Knepley     ierr = PetscSFBcastEnd(sf, MPIU_INT, neg, recv);CHKERRQ(ierr);
1293ea844a1aSMatthew Knepley     for (p = pStart; p < pEnd; ++p) {
1294ea844a1aSMatthew Knepley       if (recv[p] < 0) {
1295ea844a1aSMatthew Knepley         gs->atlasDof[p-pStart] = recv[p];
1296ea844a1aSMatthew Knepley         ierr = PetscSectionGetDof(s, p, &dof);CHKERRQ(ierr);
1297ea844a1aSMatthew Knepley         if (-(recv[p]+1) != dof) SETERRQ3(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Global dof %D for point %D is not the unconstrained %D", -(recv[p]+1), p, dof);
1298ea844a1aSMatthew Knepley       }
1299ea844a1aSMatthew Knepley     }
1300ea844a1aSMatthew Knepley   }
1301ea844a1aSMatthew Knepley   /* Calculate new sizes, get process offset, and calculate point offsets */
1302ea844a1aSMatthew Knepley   if (s->perm) {ierr = ISGetIndices(s->perm, &pind);CHKERRQ(ierr);}
1303ea844a1aSMatthew Knepley   for (p = 0, off = 0; p < pEnd-pStart; ++p) {
1304ea844a1aSMatthew Knepley     const PetscInt q = pind ? pind[p] : p;
1305ea844a1aSMatthew Knepley 
1306ea844a1aSMatthew Knepley     cdof = (!includeConstraints && s->bc) ? s->bc->atlasDof[q] : 0;
1307ea844a1aSMatthew Knepley     gs->atlasOff[q] = off;
1308ea844a1aSMatthew Knepley     off += gs->atlasDof[q] > 0 ? gs->atlasDof[q]-cdof : 0;
1309ea844a1aSMatthew Knepley   }
1310ea844a1aSMatthew Knepley   if (!localOffsets) {
1311ea844a1aSMatthew Knepley     ierr = MPI_Scan(&off, &globalOff, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject) s));CHKERRQ(ierr);
1312ea844a1aSMatthew Knepley     globalOff -= off;
1313ea844a1aSMatthew Knepley   }
1314ea844a1aSMatthew Knepley   for (p = pStart, off = 0; p < pEnd; ++p) {
1315ea844a1aSMatthew Knepley     gs->atlasOff[p-pStart] += globalOff;
1316ea844a1aSMatthew Knepley     if (neg) neg[p] = -(gs->atlasOff[p-pStart]+1);
1317ea844a1aSMatthew Knepley   }
1318ea844a1aSMatthew Knepley   if (s->perm) {ierr = ISRestoreIndices(s->perm, &pind);CHKERRQ(ierr);}
1319ea844a1aSMatthew Knepley   /* Put in negative offsets for ghost points */
1320ea844a1aSMatthew Knepley   if (nroots >= 0) {
1321ea844a1aSMatthew Knepley     ierr = PetscArrayzero(recv,nlocal);CHKERRQ(ierr);
1322ea844a1aSMatthew Knepley     ierr = PetscSFBcastBegin(sf, MPIU_INT, neg, recv);CHKERRQ(ierr);
1323ea844a1aSMatthew Knepley     ierr = PetscSFBcastEnd(sf, MPIU_INT, neg, recv);CHKERRQ(ierr);
1324ea844a1aSMatthew Knepley     for (p = pStart; p < pEnd; ++p) {
1325ea844a1aSMatthew Knepley       if (recv[p] < 0) gs->atlasOff[p-pStart] = recv[p];
1326ea844a1aSMatthew Knepley     }
1327ea844a1aSMatthew Knepley   }
1328ea844a1aSMatthew Knepley   ierr = PetscFree2(neg,recv);CHKERRQ(ierr);
1329ea844a1aSMatthew Knepley   ierr = PetscSectionViewFromOptions(gs, NULL, "-global_section_view");CHKERRQ(ierr);
1330ea844a1aSMatthew Knepley   *gsection = gs;
1331ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1332ea844a1aSMatthew Knepley }
1333ea844a1aSMatthew Knepley 
1334ea844a1aSMatthew Knepley /*@
1335ea844a1aSMatthew Knepley   PetscSectionCreateGlobalSectionCensored - Create a section describing the global field layout using
1336ea844a1aSMatthew Knepley   the local section and an SF describing the section point overlap.
1337ea844a1aSMatthew Knepley 
1338ea844a1aSMatthew Knepley   Input Parameters:
1339ea844a1aSMatthew Knepley   + s - The PetscSection for the local field layout
1340ea844a1aSMatthew Knepley   . sf - The SF describing parallel layout of the section points
1341ea844a1aSMatthew Knepley   . includeConstraints - By default this is PETSC_FALSE, meaning that the global field vector will not possess constrained dofs
1342ea844a1aSMatthew Knepley   . numExcludes - The number of exclusion ranges
1343ea844a1aSMatthew Knepley   - excludes - An array [start_0, end_0, start_1, end_1, ...] where there are numExcludes pairs
1344ea844a1aSMatthew Knepley 
1345ea844a1aSMatthew Knepley   Output Parameter:
1346ea844a1aSMatthew Knepley   . gsection - The PetscSection for the global field layout
1347ea844a1aSMatthew Knepley 
1348ea844a1aSMatthew Knepley   Note: This gives negative sizes and offsets to points not owned by this process
1349ea844a1aSMatthew Knepley 
1350ea844a1aSMatthew Knepley   Level: advanced
1351ea844a1aSMatthew Knepley 
1352ea844a1aSMatthew Knepley .seealso: PetscSectionCreate()
1353ea844a1aSMatthew Knepley @*/
1354ea844a1aSMatthew Knepley PetscErrorCode PetscSectionCreateGlobalSectionCensored(PetscSection s, PetscSF sf, PetscBool includeConstraints, PetscInt numExcludes, const PetscInt excludes[], PetscSection *gsection)
1355ea844a1aSMatthew Knepley {
1356ea844a1aSMatthew Knepley   const PetscInt *pind = NULL;
1357ea844a1aSMatthew Knepley   PetscInt       *neg  = NULL, *tmpOff = NULL;
1358ea844a1aSMatthew Knepley   PetscInt        pStart, pEnd, p, e, dof, cdof, off, globalOff = 0, nroots;
1359ea844a1aSMatthew Knepley   PetscErrorCode  ierr;
1360ea844a1aSMatthew Knepley 
1361ea844a1aSMatthew Knepley   PetscFunctionBegin;
1362ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1363ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
1364ea844a1aSMatthew Knepley   PetscValidPointer(gsection, 6);
1365ea844a1aSMatthew Knepley   ierr = PetscSectionCreate(PetscObjectComm((PetscObject) s), gsection);CHKERRQ(ierr);
1366ea844a1aSMatthew Knepley   ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr);
1367ea844a1aSMatthew Knepley   ierr = PetscSectionSetChart(*gsection, pStart, pEnd);CHKERRQ(ierr);
1368ea844a1aSMatthew Knepley   ierr = PetscSFGetGraph(sf, &nroots, NULL, NULL, NULL);CHKERRQ(ierr);
1369ea844a1aSMatthew Knepley   if (nroots >= 0) {
1370ea844a1aSMatthew Knepley     if (nroots < pEnd-pStart) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "PetscSF nroots %D < %D section size", nroots, pEnd-pStart);
1371ea844a1aSMatthew Knepley     ierr = PetscCalloc1(nroots, &neg);CHKERRQ(ierr);
1372ea844a1aSMatthew Knepley     if (nroots > pEnd-pStart) {
1373ea844a1aSMatthew Knepley       ierr = PetscCalloc1(nroots, &tmpOff);CHKERRQ(ierr);
1374ea844a1aSMatthew Knepley     } else {
1375ea844a1aSMatthew Knepley       tmpOff = &(*gsection)->atlasDof[-pStart];
1376ea844a1aSMatthew Knepley     }
1377ea844a1aSMatthew Knepley   }
1378ea844a1aSMatthew Knepley   /* Mark ghost points with negative dof */
1379ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
1380ea844a1aSMatthew Knepley     for (e = 0; e < numExcludes; ++e) {
1381ea844a1aSMatthew Knepley       if ((p >= excludes[e*2+0]) && (p < excludes[e*2+1])) {
1382ea844a1aSMatthew Knepley         ierr = PetscSectionSetDof(*gsection, p, 0);CHKERRQ(ierr);
1383ea844a1aSMatthew Knepley         break;
1384ea844a1aSMatthew Knepley       }
1385ea844a1aSMatthew Knepley     }
1386ea844a1aSMatthew Knepley     if (e < numExcludes) continue;
1387ea844a1aSMatthew Knepley     ierr = PetscSectionGetDof(s, p, &dof);CHKERRQ(ierr);
1388ea844a1aSMatthew Knepley     ierr = PetscSectionSetDof(*gsection, p, dof);CHKERRQ(ierr);
1389ea844a1aSMatthew Knepley     ierr = PetscSectionGetConstraintDof(s, p, &cdof);CHKERRQ(ierr);
1390ea844a1aSMatthew Knepley     if (!includeConstraints && cdof > 0) {ierr = PetscSectionSetConstraintDof(*gsection, p, cdof);CHKERRQ(ierr);}
1391ea844a1aSMatthew Knepley     if (neg) neg[p] = -(dof+1);
1392ea844a1aSMatthew Knepley   }
1393ea844a1aSMatthew Knepley   ierr = PetscSectionSetUpBC(*gsection);CHKERRQ(ierr);
1394ea844a1aSMatthew Knepley   if (nroots >= 0) {
1395ea844a1aSMatthew Knepley     ierr = PetscSFBcastBegin(sf, MPIU_INT, neg, tmpOff);CHKERRQ(ierr);
1396ea844a1aSMatthew Knepley     ierr = PetscSFBcastEnd(sf, MPIU_INT, neg, tmpOff);CHKERRQ(ierr);
1397ea844a1aSMatthew Knepley     if (nroots > pEnd - pStart) {
1398ea844a1aSMatthew Knepley       for (p = pStart; p < pEnd; ++p) {if (tmpOff[p] < 0) (*gsection)->atlasDof[p-pStart] = tmpOff[p];}
1399ea844a1aSMatthew Knepley     }
1400ea844a1aSMatthew Knepley   }
1401ea844a1aSMatthew Knepley   /* Calculate new sizes, get proccess offset, and calculate point offsets */
1402ea844a1aSMatthew Knepley   if (s->perm) {ierr = ISGetIndices(s->perm, &pind);CHKERRQ(ierr);}
1403ea844a1aSMatthew Knepley   for (p = 0, off = 0; p < pEnd-pStart; ++p) {
1404ea844a1aSMatthew Knepley     const PetscInt q = pind ? pind[p] : p;
1405ea844a1aSMatthew Knepley 
1406ea844a1aSMatthew Knepley     cdof = (!includeConstraints && s->bc) ? s->bc->atlasDof[q] : 0;
1407ea844a1aSMatthew Knepley     (*gsection)->atlasOff[q] = off;
1408ea844a1aSMatthew Knepley     off += (*gsection)->atlasDof[q] > 0 ? (*gsection)->atlasDof[q]-cdof : 0;
1409ea844a1aSMatthew Knepley   }
1410ea844a1aSMatthew Knepley   ierr = MPI_Scan(&off, &globalOff, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject) s));CHKERRQ(ierr);
1411ea844a1aSMatthew Knepley   globalOff -= off;
1412ea844a1aSMatthew Knepley   for (p = 0, off = 0; p < pEnd-pStart; ++p) {
1413ea844a1aSMatthew Knepley     (*gsection)->atlasOff[p] += globalOff;
1414ea844a1aSMatthew Knepley     if (neg) neg[p+pStart] = -((*gsection)->atlasOff[p]+1);
1415ea844a1aSMatthew Knepley   }
1416ea844a1aSMatthew Knepley   if (s->perm) {ierr = ISRestoreIndices(s->perm, &pind);CHKERRQ(ierr);}
1417ea844a1aSMatthew Knepley   /* Put in negative offsets for ghost points */
1418ea844a1aSMatthew Knepley   if (nroots >= 0) {
1419ea844a1aSMatthew Knepley     if (nroots == pEnd-pStart) tmpOff = &(*gsection)->atlasOff[-pStart];
1420ea844a1aSMatthew Knepley     ierr = PetscSFBcastBegin(sf, MPIU_INT, neg, tmpOff);CHKERRQ(ierr);
1421ea844a1aSMatthew Knepley     ierr = PetscSFBcastEnd(sf, MPIU_INT, neg, tmpOff);CHKERRQ(ierr);
1422ea844a1aSMatthew Knepley     if (nroots > pEnd - pStart) {
1423ea844a1aSMatthew Knepley       for (p = pStart; p < pEnd; ++p) {if (tmpOff[p] < 0) (*gsection)->atlasOff[p-pStart] = tmpOff[p];}
1424ea844a1aSMatthew Knepley     }
1425ea844a1aSMatthew Knepley   }
1426ea844a1aSMatthew Knepley   if (nroots >= 0 && nroots > pEnd-pStart) {ierr = PetscFree(tmpOff);CHKERRQ(ierr);}
1427ea844a1aSMatthew Knepley   ierr = PetscFree(neg);CHKERRQ(ierr);
1428ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1429ea844a1aSMatthew Knepley }
1430ea844a1aSMatthew Knepley 
1431ea844a1aSMatthew Knepley /*@
1432ea844a1aSMatthew Knepley   PetscSectionGetPointLayout - Get the PetscLayout associated with the section points
1433ea844a1aSMatthew Knepley 
1434ea844a1aSMatthew Knepley   Collective on comm
1435ea844a1aSMatthew Knepley 
1436ea844a1aSMatthew Knepley   Input Parameters:
1437ea844a1aSMatthew Knepley + comm - The MPI_Comm
1438ea844a1aSMatthew Knepley - s    - The PetscSection
1439ea844a1aSMatthew Knepley 
1440ea844a1aSMatthew Knepley   Output Parameter:
1441ea844a1aSMatthew Knepley . layout - The point layout for the section
1442ea844a1aSMatthew Knepley 
1443ea844a1aSMatthew Knepley   Note: This is usually caleld for the default global section.
1444ea844a1aSMatthew Knepley 
1445ea844a1aSMatthew Knepley   Level: advanced
1446ea844a1aSMatthew Knepley 
1447ea844a1aSMatthew Knepley .seealso: PetscSectionGetValueLayout(), PetscSectionCreate()
1448ea844a1aSMatthew Knepley @*/
1449ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetPointLayout(MPI_Comm comm, PetscSection s, PetscLayout *layout)
1450ea844a1aSMatthew Knepley {
1451ea844a1aSMatthew Knepley   PetscInt       pStart, pEnd, p, localSize = 0;
1452ea844a1aSMatthew Knepley   PetscErrorCode ierr;
1453ea844a1aSMatthew Knepley 
1454ea844a1aSMatthew Knepley   PetscFunctionBegin;
1455ea844a1aSMatthew Knepley   ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr);
1456ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
1457ea844a1aSMatthew Knepley     PetscInt dof;
1458ea844a1aSMatthew Knepley 
1459ea844a1aSMatthew Knepley     ierr = PetscSectionGetDof(s, p, &dof);CHKERRQ(ierr);
1460ea844a1aSMatthew Knepley     if (dof > 0) ++localSize;
1461ea844a1aSMatthew Knepley   }
1462ea844a1aSMatthew Knepley   ierr = PetscLayoutCreate(comm, layout);CHKERRQ(ierr);
1463ea844a1aSMatthew Knepley   ierr = PetscLayoutSetLocalSize(*layout, localSize);CHKERRQ(ierr);
1464ea844a1aSMatthew Knepley   ierr = PetscLayoutSetBlockSize(*layout, 1);CHKERRQ(ierr);
1465ea844a1aSMatthew Knepley   ierr = PetscLayoutSetUp(*layout);CHKERRQ(ierr);
1466ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1467ea844a1aSMatthew Knepley }
1468ea844a1aSMatthew Knepley 
1469ea844a1aSMatthew Knepley /*@
1470ea844a1aSMatthew Knepley   PetscSectionGetValueLayout - Get the PetscLayout associated with the section dofs.
1471ea844a1aSMatthew Knepley 
1472ea844a1aSMatthew Knepley   Collective on comm
1473ea844a1aSMatthew Knepley 
1474ea844a1aSMatthew Knepley   Input Parameters:
1475ea844a1aSMatthew Knepley + comm - The MPI_Comm
1476ea844a1aSMatthew Knepley - s    - The PetscSection
1477ea844a1aSMatthew Knepley 
1478ea844a1aSMatthew Knepley   Output Parameter:
1479ea844a1aSMatthew Knepley . layout - The dof layout for the section
1480ea844a1aSMatthew Knepley 
1481ea844a1aSMatthew Knepley   Note: This is usually called for the default global section.
1482ea844a1aSMatthew Knepley 
1483ea844a1aSMatthew Knepley   Level: advanced
1484ea844a1aSMatthew Knepley 
1485ea844a1aSMatthew Knepley .seealso: PetscSectionGetPointLayout(), PetscSectionCreate()
1486ea844a1aSMatthew Knepley @*/
1487ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetValueLayout(MPI_Comm comm, PetscSection s, PetscLayout *layout)
1488ea844a1aSMatthew Knepley {
1489ea844a1aSMatthew Knepley   PetscInt       pStart, pEnd, p, localSize = 0;
1490ea844a1aSMatthew Knepley   PetscErrorCode ierr;
1491ea844a1aSMatthew Knepley 
1492ea844a1aSMatthew Knepley   PetscFunctionBegin;
1493ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 2);
1494ea844a1aSMatthew Knepley   PetscValidPointer(layout, 3);
1495ea844a1aSMatthew Knepley   ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr);
1496ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
1497ea844a1aSMatthew Knepley     PetscInt dof,cdof;
1498ea844a1aSMatthew Knepley 
1499ea844a1aSMatthew Knepley     ierr = PetscSectionGetDof(s, p, &dof);CHKERRQ(ierr);
1500ea844a1aSMatthew Knepley     ierr = PetscSectionGetConstraintDof(s, p, &cdof);CHKERRQ(ierr);
1501ea844a1aSMatthew Knepley     if (dof-cdof > 0) localSize += dof-cdof;
1502ea844a1aSMatthew Knepley   }
1503ea844a1aSMatthew Knepley   ierr = PetscLayoutCreate(comm, layout);CHKERRQ(ierr);
1504ea844a1aSMatthew Knepley   ierr = PetscLayoutSetLocalSize(*layout, localSize);CHKERRQ(ierr);
1505ea844a1aSMatthew Knepley   ierr = PetscLayoutSetBlockSize(*layout, 1);CHKERRQ(ierr);
1506ea844a1aSMatthew Knepley   ierr = PetscLayoutSetUp(*layout);CHKERRQ(ierr);
1507ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1508ea844a1aSMatthew Knepley }
1509ea844a1aSMatthew Knepley 
1510ea844a1aSMatthew Knepley /*@
1511ea844a1aSMatthew Knepley   PetscSectionGetOffset - Return the offset into an array or local Vec for the dof associated with the given point.
1512ea844a1aSMatthew Knepley 
1513ea844a1aSMatthew Knepley   Not collective
1514ea844a1aSMatthew Knepley 
1515ea844a1aSMatthew Knepley   Input Parameters:
1516ea844a1aSMatthew Knepley + s - the PetscSection
1517ea844a1aSMatthew Knepley - point - the point
1518ea844a1aSMatthew Knepley 
1519ea844a1aSMatthew Knepley   Output Parameter:
1520ea844a1aSMatthew Knepley . offset - the offset
1521ea844a1aSMatthew Knepley 
1522ea844a1aSMatthew Knepley   Level: intermediate
1523ea844a1aSMatthew Knepley 
1524ea844a1aSMatthew Knepley .seealso: PetscSectionGetFieldOffset(), PetscSectionCreate()
1525ea844a1aSMatthew Knepley @*/
1526ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetOffset(PetscSection s, PetscInt point, PetscInt *offset)
1527ea844a1aSMatthew Knepley {
1528ea844a1aSMatthew Knepley   PetscFunctionBegin;
1529ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1530ea844a1aSMatthew Knepley   PetscValidPointer(offset, 3);
153176bd3646SJed Brown   if (PetscDefined(USE_DEBUG)) {
1532ea844a1aSMatthew Knepley     if ((point < s->pStart) || (point >= s->pEnd)) SETERRQ3(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Section point %D should be in [%D, %D)", point, s->pStart, s->pEnd);
153376bd3646SJed Brown   }
1534ea844a1aSMatthew Knepley   *offset = s->atlasOff[point - s->pStart];
1535ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1536ea844a1aSMatthew Knepley }
1537ea844a1aSMatthew Knepley 
1538ea844a1aSMatthew Knepley /*@
1539ea844a1aSMatthew Knepley   PetscSectionSetOffset - Set the offset into an array or local Vec for the dof associated with the given point.
1540ea844a1aSMatthew Knepley 
1541ea844a1aSMatthew Knepley   Not collective
1542ea844a1aSMatthew Knepley 
1543ea844a1aSMatthew Knepley   Input Parameters:
1544ea844a1aSMatthew Knepley + s - the PetscSection
1545ea844a1aSMatthew Knepley . point - the point
1546ea844a1aSMatthew Knepley - offset - the offset
1547ea844a1aSMatthew Knepley 
1548ea844a1aSMatthew Knepley   Note: The user usually does not call this function, but uses PetscSectionSetUp()
1549ea844a1aSMatthew Knepley 
1550ea844a1aSMatthew Knepley   Level: intermediate
1551ea844a1aSMatthew Knepley 
1552ea844a1aSMatthew Knepley .seealso: PetscSectionGetFieldOffset(), PetscSectionCreate(), PetscSectionSetUp()
1553ea844a1aSMatthew Knepley @*/
1554ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetOffset(PetscSection s, PetscInt point, PetscInt offset)
1555ea844a1aSMatthew Knepley {
1556ea844a1aSMatthew Knepley   PetscFunctionBegin;
1557ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1558ea844a1aSMatthew Knepley   if ((point < s->pStart) || (point >= s->pEnd)) SETERRQ3(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Section point %D should be in [%D, %D)", point, s->pStart, s->pEnd);
1559ea844a1aSMatthew Knepley   s->atlasOff[point - s->pStart] = offset;
1560ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1561ea844a1aSMatthew Knepley }
1562ea844a1aSMatthew Knepley 
1563ea844a1aSMatthew Knepley /*@
1564ea844a1aSMatthew Knepley   PetscSectionGetFieldOffset - Return the offset into an array or local Vec for the dof associated with the given point.
1565ea844a1aSMatthew Knepley 
1566ea844a1aSMatthew Knepley   Not collective
1567ea844a1aSMatthew Knepley 
1568ea844a1aSMatthew Knepley   Input Parameters:
1569ea844a1aSMatthew Knepley + s - the PetscSection
1570ea844a1aSMatthew Knepley . point - the point
1571ea844a1aSMatthew Knepley - field - the field
1572ea844a1aSMatthew Knepley 
1573ea844a1aSMatthew Knepley   Output Parameter:
1574ea844a1aSMatthew Knepley . offset - the offset
1575ea844a1aSMatthew Knepley 
1576ea844a1aSMatthew Knepley   Level: intermediate
1577ea844a1aSMatthew Knepley 
1578ea844a1aSMatthew Knepley .seealso: PetscSectionGetOffset(), PetscSectionCreate()
1579ea844a1aSMatthew Knepley @*/
1580ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetFieldOffset(PetscSection s, PetscInt point, PetscInt field, PetscInt *offset)
1581ea844a1aSMatthew Knepley {
1582ea844a1aSMatthew Knepley   PetscErrorCode ierr;
1583ea844a1aSMatthew Knepley 
1584ea844a1aSMatthew Knepley   PetscFunctionBegin;
1585ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1586ea844a1aSMatthew Knepley   PetscValidPointer(offset, 4);
1587ea844a1aSMatthew Knepley   if ((field < 0) || (field >= s->numFields)) SETERRQ3(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Section field %D should be in [%D, %D)", field, 0, s->numFields);
1588ea844a1aSMatthew Knepley   ierr = PetscSectionGetOffset(s->field[field], point, offset);CHKERRQ(ierr);
1589ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1590ea844a1aSMatthew Knepley }
1591ea844a1aSMatthew Knepley 
1592ea844a1aSMatthew Knepley /*@
1593ea844a1aSMatthew Knepley   PetscSectionSetFieldOffset - Set the offset into an array or local Vec for the dof associated with the given point.
1594ea844a1aSMatthew Knepley 
1595ea844a1aSMatthew Knepley   Not collective
1596ea844a1aSMatthew Knepley 
1597ea844a1aSMatthew Knepley   Input Parameters:
1598ea844a1aSMatthew Knepley + s - the PetscSection
1599ea844a1aSMatthew Knepley . point - the point
1600ea844a1aSMatthew Knepley . field - the field
1601ea844a1aSMatthew Knepley - offset - the offset
1602ea844a1aSMatthew Knepley 
1603ea844a1aSMatthew Knepley   Note: The user usually does not call this function, but uses PetscSectionSetUp()
1604ea844a1aSMatthew Knepley 
1605ea844a1aSMatthew Knepley   Level: intermediate
1606ea844a1aSMatthew Knepley 
1607ea844a1aSMatthew Knepley .seealso: PetscSectionGetOffset(), PetscSectionCreate(), PetscSectionSetUp()
1608ea844a1aSMatthew Knepley @*/
1609ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetFieldOffset(PetscSection s, PetscInt point, PetscInt field, PetscInt offset)
1610ea844a1aSMatthew Knepley {
1611ea844a1aSMatthew Knepley   PetscErrorCode ierr;
1612ea844a1aSMatthew Knepley 
1613ea844a1aSMatthew Knepley   PetscFunctionBegin;
1614ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1615ea844a1aSMatthew Knepley   if ((field < 0) || (field >= s->numFields)) SETERRQ3(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Section field %D should be in [%D, %D)", field, 0, s->numFields);
1616ea844a1aSMatthew Knepley   ierr = PetscSectionSetOffset(s->field[field], point, offset);CHKERRQ(ierr);
1617ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1618ea844a1aSMatthew Knepley }
1619ea844a1aSMatthew Knepley 
1620ea844a1aSMatthew Knepley /*@
1621ea844a1aSMatthew Knepley   PetscSectionGetFieldPointOffset - Return the offset on the given point for the dof associated with the given point.
1622ea844a1aSMatthew Knepley 
1623ea844a1aSMatthew Knepley   Not collective
1624ea844a1aSMatthew Knepley 
1625ea844a1aSMatthew Knepley   Input Parameters:
1626ea844a1aSMatthew Knepley + s - the PetscSection
1627ea844a1aSMatthew Knepley . point - the point
1628ea844a1aSMatthew Knepley - field - the field
1629ea844a1aSMatthew Knepley 
1630ea844a1aSMatthew Knepley   Output Parameter:
1631ea844a1aSMatthew Knepley . offset - the offset
1632ea844a1aSMatthew Knepley 
1633ea844a1aSMatthew Knepley   Note: This gives the offset on a point of the field, ignoring constraints, meaning starting at the first dof for
1634ea844a1aSMatthew Knepley         this point, what number is the first dof with this field.
1635ea844a1aSMatthew Knepley 
1636ea844a1aSMatthew Knepley   Level: advanced
1637ea844a1aSMatthew Knepley 
1638ea844a1aSMatthew Knepley .seealso: PetscSectionGetOffset(), PetscSectionCreate()
1639ea844a1aSMatthew Knepley @*/
1640ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetFieldPointOffset(PetscSection s, PetscInt point, PetscInt field, PetscInt *offset)
1641ea844a1aSMatthew Knepley {
1642ea844a1aSMatthew Knepley   PetscInt       off, foff;
1643ea844a1aSMatthew Knepley   PetscErrorCode ierr;
1644ea844a1aSMatthew Knepley 
1645ea844a1aSMatthew Knepley   PetscFunctionBegin;
1646ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1647ea844a1aSMatthew Knepley   PetscValidPointer(offset, 4);
1648ea844a1aSMatthew Knepley   if ((field < 0) || (field >= s->numFields)) SETERRQ3(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Section field %D should be in [%D, %D)", field, 0, s->numFields);
1649ea844a1aSMatthew Knepley   ierr = PetscSectionGetOffset(s, point, &off);CHKERRQ(ierr);
1650ea844a1aSMatthew Knepley   ierr = PetscSectionGetOffset(s->field[field], point, &foff);CHKERRQ(ierr);
1651ea844a1aSMatthew Knepley   *offset = foff - off;
1652ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1653ea844a1aSMatthew Knepley }
1654ea844a1aSMatthew Knepley 
1655ea844a1aSMatthew Knepley /*@
1656ea844a1aSMatthew Knepley   PetscSectionGetOffsetRange - Return the full range of offsets [start, end)
1657ea844a1aSMatthew Knepley 
1658ea844a1aSMatthew Knepley   Not collective
1659ea844a1aSMatthew Knepley 
1660ea844a1aSMatthew Knepley   Input Parameter:
1661ea844a1aSMatthew Knepley . s - the PetscSection
1662ea844a1aSMatthew Knepley 
1663ea844a1aSMatthew Knepley   Output Parameters:
1664ea844a1aSMatthew Knepley + start - the minimum offset
1665ea844a1aSMatthew Knepley - end   - one more than the maximum offset
1666ea844a1aSMatthew Knepley 
1667ea844a1aSMatthew Knepley   Level: intermediate
1668ea844a1aSMatthew Knepley 
1669ea844a1aSMatthew Knepley .seealso: PetscSectionGetOffset(), PetscSectionCreate()
1670ea844a1aSMatthew Knepley @*/
1671ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetOffsetRange(PetscSection s, PetscInt *start, PetscInt *end)
1672ea844a1aSMatthew Knepley {
1673ea844a1aSMatthew Knepley   PetscInt       os = 0, oe = 0, pStart, pEnd, p;
1674ea844a1aSMatthew Knepley   PetscErrorCode ierr;
1675ea844a1aSMatthew Knepley 
1676ea844a1aSMatthew Knepley   PetscFunctionBegin;
1677ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1678ea844a1aSMatthew Knepley   if (s->atlasOff) {os = s->atlasOff[0]; oe = s->atlasOff[0];}
1679ea844a1aSMatthew Knepley   ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr);
1680ea844a1aSMatthew Knepley   for (p = 0; p < pEnd-pStart; ++p) {
1681ea844a1aSMatthew Knepley     PetscInt dof = s->atlasDof[p], off = s->atlasOff[p];
1682ea844a1aSMatthew Knepley 
1683ea844a1aSMatthew Knepley     if (off >= 0) {
1684ea844a1aSMatthew Knepley       os = PetscMin(os, off);
1685ea844a1aSMatthew Knepley       oe = PetscMax(oe, off+dof);
1686ea844a1aSMatthew Knepley     }
1687ea844a1aSMatthew Knepley   }
1688ea844a1aSMatthew Knepley   if (start) *start = os;
1689ea844a1aSMatthew Knepley   if (end)   *end   = oe;
1690ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1691ea844a1aSMatthew Knepley }
1692ea844a1aSMatthew Knepley 
1693ea844a1aSMatthew Knepley /*@
1694ea844a1aSMatthew Knepley   PetscSectionCreateSubsection - Create a new, smaller section composed of only the selected fields
1695ea844a1aSMatthew Knepley 
1696ea844a1aSMatthew Knepley   Collective on s
1697ea844a1aSMatthew Knepley 
1698ea844a1aSMatthew Knepley   Input Parameter:
1699ea844a1aSMatthew Knepley + s      - the PetscSection
1700ea844a1aSMatthew Knepley . len    - the number of subfields
1701ea844a1aSMatthew Knepley - fields - the subfield numbers
1702ea844a1aSMatthew Knepley 
1703ea844a1aSMatthew Knepley   Output Parameter:
1704ea844a1aSMatthew Knepley . subs   - the subsection
1705ea844a1aSMatthew Knepley 
1706ea844a1aSMatthew Knepley   Note: The section offsets now refer to a new, smaller vector.
1707ea844a1aSMatthew Knepley 
1708ea844a1aSMatthew Knepley   Level: advanced
1709ea844a1aSMatthew Knepley 
1710ea844a1aSMatthew Knepley .seealso: PetscSectionCreateSupersection(), PetscSectionCreate()
1711ea844a1aSMatthew Knepley @*/
1712ea844a1aSMatthew Knepley PetscErrorCode PetscSectionCreateSubsection(PetscSection s, PetscInt len, const PetscInt fields[], PetscSection *subs)
1713ea844a1aSMatthew Knepley {
1714b778fa18SValeria Barra   PetscInt       nF, f, c, pStart, pEnd, p, maxCdof = 0;
1715ea844a1aSMatthew Knepley   PetscErrorCode ierr;
1716ea844a1aSMatthew Knepley 
1717ea844a1aSMatthew Knepley   PetscFunctionBegin;
1718ea844a1aSMatthew Knepley   if (!len) PetscFunctionReturn(0);
1719ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1720ea844a1aSMatthew Knepley   PetscValidPointer(fields, 3);
1721ea844a1aSMatthew Knepley   PetscValidPointer(subs, 4);
1722ea844a1aSMatthew Knepley   ierr = PetscSectionGetNumFields(s, &nF);CHKERRQ(ierr);
1723ea844a1aSMatthew Knepley   if (len > nF) SETERRQ2(PetscObjectComm((PetscObject) s), PETSC_ERR_ARG_WRONG, "Number of requested fields %D greater than number of fields %D", len, nF);
1724ea844a1aSMatthew Knepley   ierr = PetscSectionCreate(PetscObjectComm((PetscObject) s), subs);CHKERRQ(ierr);
1725ea844a1aSMatthew Knepley   ierr = PetscSectionSetNumFields(*subs, len);CHKERRQ(ierr);
1726ea844a1aSMatthew Knepley   for (f = 0; f < len; ++f) {
1727ea844a1aSMatthew Knepley     const char *name   = NULL;
1728ea844a1aSMatthew Knepley     PetscInt   numComp = 0;
1729ea844a1aSMatthew Knepley 
1730ea844a1aSMatthew Knepley     ierr = PetscSectionGetFieldName(s, fields[f], &name);CHKERRQ(ierr);
1731ea844a1aSMatthew Knepley     ierr = PetscSectionSetFieldName(*subs, f, name);CHKERRQ(ierr);
1732ea844a1aSMatthew Knepley     ierr = PetscSectionGetFieldComponents(s, fields[f], &numComp);CHKERRQ(ierr);
1733ea844a1aSMatthew Knepley     ierr = PetscSectionSetFieldComponents(*subs, f, numComp);CHKERRQ(ierr);
1734b778fa18SValeria Barra     for (c = 0; c < s->numFieldComponents[fields[f]]; ++c) {
1735b778fa18SValeria Barra       ierr = PetscSectionGetComponentName(s, fields[f], c, &name);CHKERRQ(ierr);
1736b778fa18SValeria Barra       ierr = PetscSectionSetComponentName(*subs, f, c, name);CHKERRQ(ierr);
1737b778fa18SValeria Barra     }
1738ea844a1aSMatthew Knepley   }
1739ea844a1aSMatthew Knepley   ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr);
1740ea844a1aSMatthew Knepley   ierr = PetscSectionSetChart(*subs, pStart, pEnd);CHKERRQ(ierr);
1741ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
1742ea844a1aSMatthew Knepley     PetscInt dof = 0, cdof = 0, fdof = 0, cfdof = 0;
1743ea844a1aSMatthew Knepley 
1744ea844a1aSMatthew Knepley     for (f = 0; f < len; ++f) {
1745ea844a1aSMatthew Knepley       ierr = PetscSectionGetFieldDof(s, p, fields[f], &fdof);CHKERRQ(ierr);
1746ea844a1aSMatthew Knepley       ierr = PetscSectionSetFieldDof(*subs, p, f, fdof);CHKERRQ(ierr);
1747ea844a1aSMatthew Knepley       ierr = PetscSectionGetFieldConstraintDof(s, p, fields[f], &cfdof);CHKERRQ(ierr);
1748ea844a1aSMatthew Knepley       if (cfdof) {ierr = PetscSectionSetFieldConstraintDof(*subs, p, f, cfdof);CHKERRQ(ierr);}
1749ea844a1aSMatthew Knepley       dof  += fdof;
1750ea844a1aSMatthew Knepley       cdof += cfdof;
1751ea844a1aSMatthew Knepley     }
1752ea844a1aSMatthew Knepley     ierr = PetscSectionSetDof(*subs, p, dof);CHKERRQ(ierr);
1753ea844a1aSMatthew Knepley     if (cdof) {ierr = PetscSectionSetConstraintDof(*subs, p, cdof);CHKERRQ(ierr);}
1754ea844a1aSMatthew Knepley     maxCdof = PetscMax(cdof, maxCdof);
1755ea844a1aSMatthew Knepley   }
1756ea844a1aSMatthew Knepley   ierr = PetscSectionSetUp(*subs);CHKERRQ(ierr);
1757ea844a1aSMatthew Knepley   if (maxCdof) {
1758ea844a1aSMatthew Knepley     PetscInt *indices;
1759ea844a1aSMatthew Knepley 
1760ea844a1aSMatthew Knepley     ierr = PetscMalloc1(maxCdof, &indices);CHKERRQ(ierr);
1761ea844a1aSMatthew Knepley     for (p = pStart; p < pEnd; ++p) {
1762ea844a1aSMatthew Knepley       PetscInt cdof;
1763ea844a1aSMatthew Knepley 
1764ea844a1aSMatthew Knepley       ierr = PetscSectionGetConstraintDof(*subs, p, &cdof);CHKERRQ(ierr);
1765ea844a1aSMatthew Knepley       if (cdof) {
1766ea844a1aSMatthew Knepley         const PetscInt *oldIndices = NULL;
1767ea844a1aSMatthew Knepley         PetscInt       fdof = 0, cfdof = 0, fc, numConst = 0, fOff = 0;
1768ea844a1aSMatthew Knepley 
1769ea844a1aSMatthew Knepley         for (f = 0; f < len; ++f) {
1770ea844a1aSMatthew Knepley           PetscInt oldFoff = 0, oldf;
1771ea844a1aSMatthew Knepley 
1772ea844a1aSMatthew Knepley           ierr = PetscSectionGetFieldDof(s, p, fields[f], &fdof);CHKERRQ(ierr);
1773ea844a1aSMatthew Knepley           ierr = PetscSectionGetFieldConstraintDof(s, p, fields[f], &cfdof);CHKERRQ(ierr);
1774ea844a1aSMatthew Knepley           ierr = PetscSectionGetFieldConstraintIndices(s, p, fields[f], &oldIndices);CHKERRQ(ierr);
1775ea844a1aSMatthew Knepley           /* This can be sped up if we assume sorted fields */
1776ea844a1aSMatthew Knepley           for (oldf = 0; oldf < fields[f]; ++oldf) {
1777ea844a1aSMatthew Knepley             PetscInt oldfdof = 0;
1778ea844a1aSMatthew Knepley             ierr = PetscSectionGetFieldDof(s, p, oldf, &oldfdof);CHKERRQ(ierr);
1779ea844a1aSMatthew Knepley             oldFoff += oldfdof;
1780ea844a1aSMatthew Knepley           }
1781ea844a1aSMatthew Knepley           for (fc = 0; fc < cfdof; ++fc) indices[numConst+fc] = oldIndices[fc] + (fOff - oldFoff);
1782ea844a1aSMatthew Knepley           ierr = PetscSectionSetFieldConstraintIndices(*subs, p, f, &indices[numConst]);CHKERRQ(ierr);
1783ea844a1aSMatthew Knepley           numConst += cfdof;
1784ea844a1aSMatthew Knepley           fOff     += fdof;
1785ea844a1aSMatthew Knepley         }
1786ea844a1aSMatthew Knepley         ierr = PetscSectionSetConstraintIndices(*subs, p, indices);CHKERRQ(ierr);
1787ea844a1aSMatthew Knepley       }
1788ea844a1aSMatthew Knepley     }
1789ea844a1aSMatthew Knepley     ierr = PetscFree(indices);CHKERRQ(ierr);
1790ea844a1aSMatthew Knepley   }
1791ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1792ea844a1aSMatthew Knepley }
1793ea844a1aSMatthew Knepley 
1794ea844a1aSMatthew Knepley /*@
1795ea844a1aSMatthew Knepley   PetscSectionCreateSupersection - Create a new, larger section composed of the input sections
1796ea844a1aSMatthew Knepley 
1797ea844a1aSMatthew Knepley   Collective on s
1798ea844a1aSMatthew Knepley 
1799ea844a1aSMatthew Knepley   Input Parameters:
1800ea844a1aSMatthew Knepley + s     - the input sections
1801ea844a1aSMatthew Knepley - len   - the number of input sections
1802ea844a1aSMatthew Knepley 
1803ea844a1aSMatthew Knepley   Output Parameter:
1804ea844a1aSMatthew Knepley . supers - the supersection
1805ea844a1aSMatthew Knepley 
1806ea844a1aSMatthew Knepley   Note: The section offsets now refer to a new, larger vector.
1807ea844a1aSMatthew Knepley 
1808ea844a1aSMatthew Knepley   Level: advanced
1809ea844a1aSMatthew Knepley 
1810ea844a1aSMatthew Knepley .seealso: PetscSectionCreateSubsection(), PetscSectionCreate()
1811ea844a1aSMatthew Knepley @*/
1812ea844a1aSMatthew Knepley PetscErrorCode PetscSectionCreateSupersection(PetscSection s[], PetscInt len, PetscSection *supers)
1813ea844a1aSMatthew Knepley {
1814ea844a1aSMatthew Knepley   PetscInt       Nf = 0, f, pStart = PETSC_MAX_INT, pEnd = 0, p, maxCdof = 0, i;
1815ea844a1aSMatthew Knepley   PetscErrorCode ierr;
1816ea844a1aSMatthew Knepley 
1817ea844a1aSMatthew Knepley   PetscFunctionBegin;
1818ea844a1aSMatthew Knepley   if (!len) PetscFunctionReturn(0);
1819ea844a1aSMatthew Knepley   for (i = 0; i < len; ++i) {
1820ea844a1aSMatthew Knepley     PetscInt nf, pStarti, pEndi;
1821ea844a1aSMatthew Knepley 
1822ea844a1aSMatthew Knepley     ierr = PetscSectionGetNumFields(s[i], &nf);CHKERRQ(ierr);
1823ea844a1aSMatthew Knepley     ierr = PetscSectionGetChart(s[i], &pStarti, &pEndi);CHKERRQ(ierr);
1824ea844a1aSMatthew Knepley     pStart = PetscMin(pStart, pStarti);
1825ea844a1aSMatthew Knepley     pEnd   = PetscMax(pEnd,   pEndi);
1826ea844a1aSMatthew Knepley     Nf += nf;
1827ea844a1aSMatthew Knepley   }
1828ea844a1aSMatthew Knepley   ierr = PetscSectionCreate(PetscObjectComm((PetscObject) s[0]), supers);CHKERRQ(ierr);
1829ea844a1aSMatthew Knepley   ierr = PetscSectionSetNumFields(*supers, Nf);CHKERRQ(ierr);
1830ea844a1aSMatthew Knepley   for (i = 0, f = 0; i < len; ++i) {
1831b778fa18SValeria Barra     PetscInt nf, fi, ci;
1832ea844a1aSMatthew Knepley 
1833ea844a1aSMatthew Knepley     ierr = PetscSectionGetNumFields(s[i], &nf);CHKERRQ(ierr);
1834ea844a1aSMatthew Knepley     for (fi = 0; fi < nf; ++fi, ++f) {
1835ea844a1aSMatthew Knepley       const char *name   = NULL;
1836ea844a1aSMatthew Knepley       PetscInt   numComp = 0;
1837ea844a1aSMatthew Knepley 
1838ea844a1aSMatthew Knepley       ierr = PetscSectionGetFieldName(s[i], fi, &name);CHKERRQ(ierr);
1839ea844a1aSMatthew Knepley       ierr = PetscSectionSetFieldName(*supers, f, name);CHKERRQ(ierr);
1840ea844a1aSMatthew Knepley       ierr = PetscSectionGetFieldComponents(s[i], fi, &numComp);CHKERRQ(ierr);
1841ea844a1aSMatthew Knepley       ierr = PetscSectionSetFieldComponents(*supers, f, numComp);CHKERRQ(ierr);
1842b778fa18SValeria Barra       for (ci = 0; ci < s[i]->numFieldComponents[fi]; ++ci) {
1843b778fa18SValeria Barra         ierr = PetscSectionGetComponentName(s[i], fi, ci, &name);CHKERRQ(ierr);
1844b778fa18SValeria Barra         ierr = PetscSectionSetComponentName(*supers, f, ci, name);CHKERRQ(ierr);
1845b778fa18SValeria Barra       }
1846ea844a1aSMatthew Knepley     }
1847ea844a1aSMatthew Knepley   }
1848ea844a1aSMatthew Knepley   ierr = PetscSectionSetChart(*supers, pStart, pEnd);CHKERRQ(ierr);
1849ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
1850ea844a1aSMatthew Knepley     PetscInt dof = 0, cdof = 0;
1851ea844a1aSMatthew Knepley 
1852ea844a1aSMatthew Knepley     for (i = 0, f = 0; i < len; ++i) {
1853ea844a1aSMatthew Knepley       PetscInt nf, fi, pStarti, pEndi;
1854ea844a1aSMatthew Knepley       PetscInt fdof = 0, cfdof = 0;
1855ea844a1aSMatthew Knepley 
1856ea844a1aSMatthew Knepley       ierr = PetscSectionGetNumFields(s[i], &nf);CHKERRQ(ierr);
1857ea844a1aSMatthew Knepley       ierr = PetscSectionGetChart(s[i], &pStarti, &pEndi);CHKERRQ(ierr);
1858ea844a1aSMatthew Knepley       if ((p < pStarti) || (p >= pEndi)) continue;
1859ea844a1aSMatthew Knepley       for (fi = 0; fi < nf; ++fi, ++f) {
1860ea844a1aSMatthew Knepley         ierr = PetscSectionGetFieldDof(s[i], p, fi, &fdof);CHKERRQ(ierr);
1861ea844a1aSMatthew Knepley         ierr = PetscSectionAddFieldDof(*supers, p, f, fdof);CHKERRQ(ierr);
1862ea844a1aSMatthew Knepley         ierr = PetscSectionGetFieldConstraintDof(s[i], p, fi, &cfdof);CHKERRQ(ierr);
1863ea844a1aSMatthew Knepley         if (cfdof) {ierr = PetscSectionAddFieldConstraintDof(*supers, p, f, cfdof);CHKERRQ(ierr);}
1864ea844a1aSMatthew Knepley         dof  += fdof;
1865ea844a1aSMatthew Knepley         cdof += cfdof;
1866ea844a1aSMatthew Knepley       }
1867ea844a1aSMatthew Knepley     }
1868ea844a1aSMatthew Knepley     ierr = PetscSectionSetDof(*supers, p, dof);CHKERRQ(ierr);
1869ea844a1aSMatthew Knepley     if (cdof) {ierr = PetscSectionSetConstraintDof(*supers, p, cdof);CHKERRQ(ierr);}
1870ea844a1aSMatthew Knepley     maxCdof = PetscMax(cdof, maxCdof);
1871ea844a1aSMatthew Knepley   }
1872ea844a1aSMatthew Knepley   ierr = PetscSectionSetUp(*supers);CHKERRQ(ierr);
1873ea844a1aSMatthew Knepley   if (maxCdof) {
1874ea844a1aSMatthew Knepley     PetscInt *indices;
1875ea844a1aSMatthew Knepley 
1876ea844a1aSMatthew Knepley     ierr = PetscMalloc1(maxCdof, &indices);CHKERRQ(ierr);
1877ea844a1aSMatthew Knepley     for (p = pStart; p < pEnd; ++p) {
1878ea844a1aSMatthew Knepley       PetscInt cdof;
1879ea844a1aSMatthew Knepley 
1880ea844a1aSMatthew Knepley       ierr = PetscSectionGetConstraintDof(*supers, p, &cdof);CHKERRQ(ierr);
1881ea844a1aSMatthew Knepley       if (cdof) {
1882ea844a1aSMatthew Knepley         PetscInt dof, numConst = 0, fOff = 0;
1883ea844a1aSMatthew Knepley 
1884ea844a1aSMatthew Knepley         for (i = 0, f = 0; i < len; ++i) {
1885ea844a1aSMatthew Knepley           const PetscInt *oldIndices = NULL;
1886ea844a1aSMatthew Knepley           PetscInt        nf, fi, pStarti, pEndi, fdof, cfdof, fc;
1887ea844a1aSMatthew Knepley 
1888ea844a1aSMatthew Knepley           ierr = PetscSectionGetNumFields(s[i], &nf);CHKERRQ(ierr);
1889ea844a1aSMatthew Knepley           ierr = PetscSectionGetChart(s[i], &pStarti, &pEndi);CHKERRQ(ierr);
1890ea844a1aSMatthew Knepley           if ((p < pStarti) || (p >= pEndi)) continue;
1891ea844a1aSMatthew Knepley           for (fi = 0; fi < nf; ++fi, ++f) {
1892ea844a1aSMatthew Knepley             ierr = PetscSectionGetFieldDof(s[i], p, fi, &fdof);CHKERRQ(ierr);
1893ea844a1aSMatthew Knepley             ierr = PetscSectionGetFieldConstraintDof(s[i], p, fi, &cfdof);CHKERRQ(ierr);
1894ea844a1aSMatthew Knepley             ierr = PetscSectionGetFieldConstraintIndices(s[i], p, fi, &oldIndices);CHKERRQ(ierr);
1895ea844a1aSMatthew Knepley             for (fc = 0; fc < cfdof; ++fc) indices[numConst+fc] = oldIndices[fc] + fOff;
1896ea844a1aSMatthew Knepley             ierr = PetscSectionSetFieldConstraintIndices(*supers, p, f, &indices[numConst]);CHKERRQ(ierr);
1897ea844a1aSMatthew Knepley             numConst += cfdof;
1898ea844a1aSMatthew Knepley           }
1899ea844a1aSMatthew Knepley           ierr = PetscSectionGetDof(s[i], p, &dof);CHKERRQ(ierr);
1900ea844a1aSMatthew Knepley           fOff += dof;
1901ea844a1aSMatthew Knepley         }
1902ea844a1aSMatthew Knepley         ierr = PetscSectionSetConstraintIndices(*supers, p, indices);CHKERRQ(ierr);
1903ea844a1aSMatthew Knepley       }
1904ea844a1aSMatthew Knepley     }
1905ea844a1aSMatthew Knepley     ierr = PetscFree(indices);CHKERRQ(ierr);
1906ea844a1aSMatthew Knepley   }
1907ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
1908ea844a1aSMatthew Knepley }
1909ea844a1aSMatthew Knepley 
1910ea844a1aSMatthew Knepley /*@
1911ea844a1aSMatthew Knepley   PetscSectionCreateSubmeshSection - Create a new, smaller section with support on the submesh
1912ea844a1aSMatthew Knepley 
1913ea844a1aSMatthew Knepley   Collective on s
1914ea844a1aSMatthew Knepley 
1915ea844a1aSMatthew Knepley   Input Parameters:
1916ea844a1aSMatthew Knepley + s           - the PetscSection
1917ea844a1aSMatthew Knepley - subpointMap - a sorted list of points in the original mesh which are in the submesh
1918ea844a1aSMatthew Knepley 
1919ea844a1aSMatthew Knepley   Output Parameter:
1920ea844a1aSMatthew Knepley . subs - the subsection
1921ea844a1aSMatthew Knepley 
1922ea844a1aSMatthew Knepley   Note: The section offsets now refer to a new, smaller vector.
1923ea844a1aSMatthew Knepley 
1924ea844a1aSMatthew Knepley   Level: advanced
1925ea844a1aSMatthew Knepley 
1926ea844a1aSMatthew Knepley .seealso: PetscSectionCreateSubsection(), DMPlexGetSubpointMap(), PetscSectionCreate()
1927ea844a1aSMatthew Knepley @*/
1928ea844a1aSMatthew Knepley PetscErrorCode PetscSectionCreateSubmeshSection(PetscSection s, IS subpointMap, PetscSection *subs)
1929ea844a1aSMatthew Knepley {
1930ea844a1aSMatthew Knepley   const PetscInt *points = NULL, *indices = NULL;
1931b778fa18SValeria Barra   PetscInt       numFields, f, c, numSubpoints = 0, pStart, pEnd, p, subp;
1932ea844a1aSMatthew Knepley   PetscErrorCode ierr;
1933ea844a1aSMatthew Knepley 
1934ea844a1aSMatthew Knepley   PetscFunctionBegin;
1935ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
1936ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(subpointMap, IS_CLASSID, 2);
1937ea844a1aSMatthew Knepley   PetscValidPointer(subs, 3);
1938ea844a1aSMatthew Knepley   ierr = PetscSectionGetNumFields(s, &numFields);CHKERRQ(ierr);
1939ea844a1aSMatthew Knepley   ierr = PetscSectionCreate(PetscObjectComm((PetscObject) s), subs);CHKERRQ(ierr);
1940ea844a1aSMatthew Knepley   if (numFields) {ierr = PetscSectionSetNumFields(*subs, numFields);CHKERRQ(ierr);}
1941ea844a1aSMatthew Knepley   for (f = 0; f < numFields; ++f) {
1942ea844a1aSMatthew Knepley     const char *name   = NULL;
1943ea844a1aSMatthew Knepley     PetscInt   numComp = 0;
1944ea844a1aSMatthew Knepley 
1945ea844a1aSMatthew Knepley     ierr = PetscSectionGetFieldName(s, f, &name);CHKERRQ(ierr);
1946ea844a1aSMatthew Knepley     ierr = PetscSectionSetFieldName(*subs, f, name);CHKERRQ(ierr);
1947ea844a1aSMatthew Knepley     ierr = PetscSectionGetFieldComponents(s, f, &numComp);CHKERRQ(ierr);
1948ea844a1aSMatthew Knepley     ierr = PetscSectionSetFieldComponents(*subs, f, numComp);CHKERRQ(ierr);
1949b778fa18SValeria Barra     for (c = 0; c < s->numFieldComponents[f]; ++c) {
1950b778fa18SValeria Barra       ierr = PetscSectionGetComponentName(s, f, c, &name);CHKERRQ(ierr);
1951b778fa18SValeria Barra       ierr = PetscSectionSetComponentName(*subs, f, c, name);CHKERRQ(ierr);
1952b778fa18SValeria Barra     }
1953ea844a1aSMatthew Knepley   }
1954ea844a1aSMatthew Knepley   /* For right now, we do not try to squeeze the subchart */
1955ea844a1aSMatthew Knepley   if (subpointMap) {
1956ea844a1aSMatthew Knepley     ierr = ISGetSize(subpointMap, &numSubpoints);CHKERRQ(ierr);
1957ea844a1aSMatthew Knepley     ierr = ISGetIndices(subpointMap, &points);CHKERRQ(ierr);
1958ea844a1aSMatthew Knepley   }
1959ea844a1aSMatthew Knepley   ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr);
1960ea844a1aSMatthew Knepley   ierr = PetscSectionSetChart(*subs, 0, numSubpoints);CHKERRQ(ierr);
1961ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
1962ea844a1aSMatthew Knepley     PetscInt dof, cdof, fdof = 0, cfdof = 0;
1963ea844a1aSMatthew Knepley 
1964ea844a1aSMatthew Knepley     ierr = PetscFindInt(p, numSubpoints, points, &subp);CHKERRQ(ierr);
1965ea844a1aSMatthew Knepley     if (subp < 0) continue;
1966ea844a1aSMatthew Knepley     for (f = 0; f < numFields; ++f) {
1967ea844a1aSMatthew Knepley       ierr = PetscSectionGetFieldDof(s, p, f, &fdof);CHKERRQ(ierr);
1968ea844a1aSMatthew Knepley       ierr = PetscSectionSetFieldDof(*subs, subp, f, fdof);CHKERRQ(ierr);
1969ea844a1aSMatthew Knepley       ierr = PetscSectionGetFieldConstraintDof(s, p, f, &cfdof);CHKERRQ(ierr);
1970ea844a1aSMatthew Knepley       if (cfdof) {ierr = PetscSectionSetFieldConstraintDof(*subs, subp, f, cfdof);CHKERRQ(ierr);}
1971ea844a1aSMatthew Knepley     }
1972ea844a1aSMatthew Knepley     ierr = PetscSectionGetDof(s, p, &dof);CHKERRQ(ierr);
1973ea844a1aSMatthew Knepley     ierr = PetscSectionSetDof(*subs, subp, dof);CHKERRQ(ierr);
1974ea844a1aSMatthew Knepley     ierr = PetscSectionGetConstraintDof(s, p, &cdof);CHKERRQ(ierr);
1975ea844a1aSMatthew Knepley     if (cdof) {ierr = PetscSectionSetConstraintDof(*subs, subp, cdof);CHKERRQ(ierr);}
1976ea844a1aSMatthew Knepley   }
1977ea844a1aSMatthew Knepley   ierr = PetscSectionSetUp(*subs);CHKERRQ(ierr);
1978ea844a1aSMatthew Knepley   /* Change offsets to original offsets */
1979ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
1980ea844a1aSMatthew Knepley     PetscInt off, foff = 0;
1981ea844a1aSMatthew Knepley 
1982ea844a1aSMatthew Knepley     ierr = PetscFindInt(p, numSubpoints, points, &subp);CHKERRQ(ierr);
1983ea844a1aSMatthew Knepley     if (subp < 0) continue;
1984ea844a1aSMatthew Knepley     for (f = 0; f < numFields; ++f) {
1985ea844a1aSMatthew Knepley       ierr = PetscSectionGetFieldOffset(s, p, f, &foff);CHKERRQ(ierr);
1986ea844a1aSMatthew Knepley       ierr = PetscSectionSetFieldOffset(*subs, subp, f, foff);CHKERRQ(ierr);
1987ea844a1aSMatthew Knepley     }
1988ea844a1aSMatthew Knepley     ierr = PetscSectionGetOffset(s, p, &off);CHKERRQ(ierr);
1989ea844a1aSMatthew Knepley     ierr = PetscSectionSetOffset(*subs, subp, off);CHKERRQ(ierr);
1990ea844a1aSMatthew Knepley   }
1991ea844a1aSMatthew Knepley   /* Copy constraint indices */
1992ea844a1aSMatthew Knepley   for (subp = 0; subp < numSubpoints; ++subp) {
1993ea844a1aSMatthew Knepley     PetscInt cdof;
1994ea844a1aSMatthew Knepley 
1995ea844a1aSMatthew Knepley     ierr = PetscSectionGetConstraintDof(*subs, subp, &cdof);CHKERRQ(ierr);
1996ea844a1aSMatthew Knepley     if (cdof) {
1997ea844a1aSMatthew Knepley       for (f = 0; f < numFields; ++f) {
1998ea844a1aSMatthew Knepley         ierr = PetscSectionGetFieldConstraintIndices(s, points[subp], f, &indices);CHKERRQ(ierr);
1999ea844a1aSMatthew Knepley         ierr = PetscSectionSetFieldConstraintIndices(*subs, subp, f, indices);CHKERRQ(ierr);
2000ea844a1aSMatthew Knepley       }
2001ea844a1aSMatthew Knepley       ierr = PetscSectionGetConstraintIndices(s, points[subp], &indices);CHKERRQ(ierr);
2002ea844a1aSMatthew Knepley       ierr = PetscSectionSetConstraintIndices(*subs, subp, indices);CHKERRQ(ierr);
2003ea844a1aSMatthew Knepley     }
2004ea844a1aSMatthew Knepley   }
2005ea844a1aSMatthew Knepley   if (subpointMap) {ierr = ISRestoreIndices(subpointMap, &points);CHKERRQ(ierr);}
2006ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2007ea844a1aSMatthew Knepley }
2008ea844a1aSMatthew Knepley 
2009ea844a1aSMatthew Knepley static PetscErrorCode PetscSectionView_ASCII(PetscSection s, PetscViewer viewer)
2010ea844a1aSMatthew Knepley {
2011ea844a1aSMatthew Knepley   PetscInt       p;
2012ea844a1aSMatthew Knepley   PetscMPIInt    rank;
2013ea844a1aSMatthew Knepley   PetscErrorCode ierr;
2014ea844a1aSMatthew Knepley 
2015ea844a1aSMatthew Knepley   PetscFunctionBegin;
2016ea844a1aSMatthew Knepley   ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer), &rank);CHKERRQ(ierr);
2017ea844a1aSMatthew Knepley   ierr = PetscViewerASCIIPushSynchronized(viewer);CHKERRQ(ierr);
2018ea844a1aSMatthew Knepley   ierr = PetscViewerASCIISynchronizedPrintf(viewer, "Process %d:\n", rank);CHKERRQ(ierr);
2019ea844a1aSMatthew Knepley   for (p = 0; p < s->pEnd - s->pStart; ++p) {
2020ea844a1aSMatthew Knepley     if ((s->bc) && (s->bc->atlasDof[p] > 0)) {
2021ea844a1aSMatthew Knepley       PetscInt b;
2022ea844a1aSMatthew Knepley 
2023ea844a1aSMatthew Knepley       ierr = PetscViewerASCIISynchronizedPrintf(viewer, "  (%4D) dim %2D offset %3D constrained", p+s->pStart, s->atlasDof[p], s->atlasOff[p]);CHKERRQ(ierr);
2024083401c6SMatthew G. Knepley       if (s->bcIndices) {
2025ea844a1aSMatthew Knepley         for (b = 0; b < s->bc->atlasDof[p]; ++b) {
2026ea844a1aSMatthew Knepley           ierr = PetscViewerASCIISynchronizedPrintf(viewer, " %D", s->bcIndices[s->bc->atlasOff[p]+b]);CHKERRQ(ierr);
2027ea844a1aSMatthew Knepley         }
2028083401c6SMatthew G. Knepley       }
2029ea844a1aSMatthew Knepley       ierr = PetscViewerASCIISynchronizedPrintf(viewer, "\n");CHKERRQ(ierr);
2030ea844a1aSMatthew Knepley     } else {
2031ea844a1aSMatthew Knepley       ierr = PetscViewerASCIISynchronizedPrintf(viewer, "  (%4D) dim %2D offset %3D\n", p+s->pStart, s->atlasDof[p], s->atlasOff[p]);CHKERRQ(ierr);
2032ea844a1aSMatthew Knepley     }
2033ea844a1aSMatthew Knepley   }
2034ea844a1aSMatthew Knepley   ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
2035ea844a1aSMatthew Knepley   ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr);
2036ea844a1aSMatthew Knepley   if (s->sym) {
2037ea844a1aSMatthew Knepley     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
2038ea844a1aSMatthew Knepley     ierr = PetscSectionSymView(s->sym,viewer);CHKERRQ(ierr);
2039ea844a1aSMatthew Knepley     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2040ea844a1aSMatthew Knepley   }
2041ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2042ea844a1aSMatthew Knepley }
2043ea844a1aSMatthew Knepley 
2044ea844a1aSMatthew Knepley /*@C
2045fe2efc57SMark    PetscSectionViewFromOptions - View from Options
2046fe2efc57SMark 
2047fe2efc57SMark    Collective on PetscSection
2048fe2efc57SMark 
2049fe2efc57SMark    Input Parameters:
2050fe2efc57SMark +  A - the PetscSection object to view
2051736c3998SJose E. Roman .  obj - Optional object
2052736c3998SJose E. Roman -  name - command line option
2053fe2efc57SMark 
2054fe2efc57SMark    Level: intermediate
2055fe2efc57SMark .seealso:  PetscSection, PetscSectionView, PetscObjectViewFromOptions(), PetscSectionCreate()
2056fe2efc57SMark @*/
2057fe2efc57SMark PetscErrorCode  PetscSectionViewFromOptions(PetscSection A,PetscObject obj,const char name[])
2058fe2efc57SMark {
2059fe2efc57SMark   PetscErrorCode ierr;
2060fe2efc57SMark 
2061fe2efc57SMark   PetscFunctionBegin;
2062fe2efc57SMark   PetscValidHeaderSpecific(A,PETSC_SECTION_CLASSID,1);
2063fe2efc57SMark   ierr = PetscObjectViewFromOptions((PetscObject)A,obj,name);CHKERRQ(ierr);
2064fe2efc57SMark   PetscFunctionReturn(0);
2065fe2efc57SMark }
2066fe2efc57SMark 
2067fe2efc57SMark /*@C
2068ea844a1aSMatthew Knepley   PetscSectionView - Views a PetscSection
2069ea844a1aSMatthew Knepley 
2070ea844a1aSMatthew Knepley   Collective on PetscSection
2071ea844a1aSMatthew Knepley 
2072ea844a1aSMatthew Knepley   Input Parameters:
2073ea844a1aSMatthew Knepley + s - the PetscSection object to view
2074ea844a1aSMatthew Knepley - v - the viewer
2075ea844a1aSMatthew Knepley 
2076ea844a1aSMatthew Knepley   Level: beginner
2077ea844a1aSMatthew Knepley 
2078ea844a1aSMatthew Knepley .seealso PetscSectionCreate(), PetscSectionDestroy()
2079ea844a1aSMatthew Knepley @*/
2080ea844a1aSMatthew Knepley PetscErrorCode PetscSectionView(PetscSection s, PetscViewer viewer)
2081ea844a1aSMatthew Knepley {
2082ea844a1aSMatthew Knepley   PetscBool      isascii;
2083ea844a1aSMatthew Knepley   PetscInt       f;
2084ea844a1aSMatthew Knepley   PetscErrorCode ierr;
2085ea844a1aSMatthew Knepley 
2086ea844a1aSMatthew Knepley   PetscFunctionBegin;
2087ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2088ea844a1aSMatthew Knepley   if (!viewer) {ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)s), &viewer);CHKERRQ(ierr);}
2089ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(viewer, PETSC_VIEWER_CLASSID, 2);
2090ea844a1aSMatthew Knepley   ierr = PetscObjectTypeCompare((PetscObject) viewer, PETSCVIEWERASCII, &isascii);CHKERRQ(ierr);
2091ea844a1aSMatthew Knepley   if (isascii) {
2092ea844a1aSMatthew Knepley     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)s,viewer);CHKERRQ(ierr);
2093ea844a1aSMatthew Knepley     if (s->numFields) {
2094ea844a1aSMatthew Knepley       ierr = PetscViewerASCIIPrintf(viewer, "%D fields\n", s->numFields);CHKERRQ(ierr);
2095ea844a1aSMatthew Knepley       for (f = 0; f < s->numFields; ++f) {
2096ea844a1aSMatthew Knepley         ierr = PetscViewerASCIIPrintf(viewer, "  field %D with %D components\n", f, s->numFieldComponents[f]);CHKERRQ(ierr);
2097ea844a1aSMatthew Knepley         ierr = PetscSectionView_ASCII(s->field[f], viewer);CHKERRQ(ierr);
2098ea844a1aSMatthew Knepley       }
2099ea844a1aSMatthew Knepley     } else {
2100ea844a1aSMatthew Knepley       ierr = PetscSectionView_ASCII(s, viewer);CHKERRQ(ierr);
2101ea844a1aSMatthew Knepley     }
2102ea844a1aSMatthew Knepley   }
2103ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2104ea844a1aSMatthew Knepley }
2105ea844a1aSMatthew Knepley 
2106*c459fbc1SJed Brown static PetscErrorCode PetscSectionResetClosurePermutation(PetscSection section)
2107*c459fbc1SJed Brown {
2108*c459fbc1SJed Brown   PetscErrorCode ierr;
2109*c459fbc1SJed Brown   PetscSectionClosurePermVal clVal;
2110*c459fbc1SJed Brown 
2111*c459fbc1SJed Brown   PetscFunctionBegin;
2112*c459fbc1SJed Brown   if (!section->clHash) PetscFunctionReturn(0);
2113*c459fbc1SJed Brown   kh_foreach_value(section->clHash, clVal, {
2114*c459fbc1SJed Brown       ierr = PetscFree(clVal.perm);CHKERRQ(ierr);
2115*c459fbc1SJed Brown       ierr = PetscFree(clVal.invPerm);CHKERRQ(ierr);
2116*c459fbc1SJed Brown     });
2117*c459fbc1SJed Brown   kh_destroy(ClPerm, section->clHash);
2118*c459fbc1SJed Brown   section->clHash = NULL;
2119*c459fbc1SJed Brown   PetscFunctionReturn(0);
2120*c459fbc1SJed Brown }
2121*c459fbc1SJed Brown 
2122ea844a1aSMatthew Knepley /*@
2123ea844a1aSMatthew Knepley   PetscSectionReset - Frees all section data.
2124ea844a1aSMatthew Knepley 
2125ea844a1aSMatthew Knepley   Not collective
2126ea844a1aSMatthew Knepley 
2127ea844a1aSMatthew Knepley   Input Parameters:
2128ea844a1aSMatthew Knepley . s - the PetscSection
2129ea844a1aSMatthew Knepley 
2130ea844a1aSMatthew Knepley   Level: beginner
2131ea844a1aSMatthew Knepley 
2132ea844a1aSMatthew Knepley .seealso: PetscSection, PetscSectionCreate()
2133ea844a1aSMatthew Knepley @*/
2134ea844a1aSMatthew Knepley PetscErrorCode PetscSectionReset(PetscSection s)
2135ea844a1aSMatthew Knepley {
2136b778fa18SValeria Barra   PetscInt       f, c;
2137ea844a1aSMatthew Knepley   PetscErrorCode ierr;
2138ea844a1aSMatthew Knepley 
2139ea844a1aSMatthew Knepley   PetscFunctionBegin;
2140ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2141ea844a1aSMatthew Knepley   for (f = 0; f < s->numFields; ++f) {
2142ea844a1aSMatthew Knepley     ierr = PetscSectionDestroy(&s->field[f]);CHKERRQ(ierr);
2143ea844a1aSMatthew Knepley     ierr = PetscFree(s->fieldNames[f]);CHKERRQ(ierr);
2144b778fa18SValeria Barra     for (c = 0; c < s->numFieldComponents[f]; ++c)
2145b778fa18SValeria Barra       ierr = PetscFree(s->compNames[f][c]);CHKERRQ(ierr);
2146b778fa18SValeria Barra     ierr = PetscFree(s->compNames[f]);CHKERRQ(ierr);
2147ea844a1aSMatthew Knepley   }
2148b778fa18SValeria Barra   ierr = PetscFree(s->numFieldComponents);CHKERRQ(ierr);
2149ea844a1aSMatthew Knepley   ierr = PetscFree(s->fieldNames);CHKERRQ(ierr);
2150b778fa18SValeria Barra   ierr = PetscFree(s->compNames);CHKERRQ(ierr);
2151ea844a1aSMatthew Knepley   ierr = PetscFree(s->field);CHKERRQ(ierr);
2152ea844a1aSMatthew Knepley   ierr = PetscSectionDestroy(&s->bc);CHKERRQ(ierr);
2153ea844a1aSMatthew Knepley   ierr = PetscFree(s->bcIndices);CHKERRQ(ierr);
2154ea844a1aSMatthew Knepley   ierr = PetscFree2(s->atlasDof, s->atlasOff);CHKERRQ(ierr);
2155ea844a1aSMatthew Knepley   ierr = PetscSectionDestroy(&s->clSection);CHKERRQ(ierr);
2156ea844a1aSMatthew Knepley   ierr = ISDestroy(&s->clPoints);CHKERRQ(ierr);
2157ea844a1aSMatthew Knepley   ierr = ISDestroy(&s->perm);CHKERRQ(ierr);
2158*c459fbc1SJed Brown   ierr = PetscSectionResetClosurePermutation(s);CHKERRQ(ierr);
2159ea844a1aSMatthew Knepley   ierr = PetscSectionSymDestroy(&s->sym);CHKERRQ(ierr);
21603e03ebd8SStefano Zampini   ierr = PetscSectionDestroy(&s->clSection);CHKERRQ(ierr);
21613e03ebd8SStefano Zampini   ierr = ISDestroy(&s->clPoints);CHKERRQ(ierr);
2162ea844a1aSMatthew Knepley 
2163ea844a1aSMatthew Knepley   s->pStart    = -1;
2164ea844a1aSMatthew Knepley   s->pEnd      = -1;
2165ea844a1aSMatthew Knepley   s->maxDof    = 0;
2166ea844a1aSMatthew Knepley   s->setup     = PETSC_FALSE;
2167ea844a1aSMatthew Knepley   s->numFields = 0;
2168ea844a1aSMatthew Knepley   s->clObj     = NULL;
2169ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2170ea844a1aSMatthew Knepley }
2171ea844a1aSMatthew Knepley 
2172ea844a1aSMatthew Knepley /*@
2173ea844a1aSMatthew Knepley   PetscSectionDestroy - Frees a section object and frees its range if that exists.
2174ea844a1aSMatthew Knepley 
2175ea844a1aSMatthew Knepley   Not collective
2176ea844a1aSMatthew Knepley 
2177ea844a1aSMatthew Knepley   Input Parameters:
2178ea844a1aSMatthew Knepley . s - the PetscSection
2179ea844a1aSMatthew Knepley 
2180ea844a1aSMatthew Knepley   Level: beginner
2181ea844a1aSMatthew Knepley 
2182ea844a1aSMatthew Knepley .seealso: PetscSection, PetscSectionCreate()
2183ea844a1aSMatthew Knepley @*/
2184ea844a1aSMatthew Knepley PetscErrorCode PetscSectionDestroy(PetscSection *s)
2185ea844a1aSMatthew Knepley {
2186ea844a1aSMatthew Knepley   PetscErrorCode ierr;
2187ea844a1aSMatthew Knepley 
2188ea844a1aSMatthew Knepley   PetscFunctionBegin;
2189ea844a1aSMatthew Knepley   if (!*s) PetscFunctionReturn(0);
219062f17a49SStefano Zampini   PetscValidHeaderSpecific(*s,PETSC_SECTION_CLASSID,1);
2191ea844a1aSMatthew Knepley   if (--((PetscObject)(*s))->refct > 0) {
2192ea844a1aSMatthew Knepley     *s = NULL;
2193ea844a1aSMatthew Knepley     PetscFunctionReturn(0);
2194ea844a1aSMatthew Knepley   }
2195ea844a1aSMatthew Knepley   ierr = PetscSectionReset(*s);CHKERRQ(ierr);
2196ea844a1aSMatthew Knepley   ierr = PetscHeaderDestroy(s);CHKERRQ(ierr);
2197ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2198ea844a1aSMatthew Knepley }
2199ea844a1aSMatthew Knepley 
2200ea844a1aSMatthew Knepley PetscErrorCode VecIntGetValuesSection(PetscInt *baseArray, PetscSection s, PetscInt point, const PetscInt **values)
2201ea844a1aSMatthew Knepley {
2202ea844a1aSMatthew Knepley   const PetscInt p = point - s->pStart;
2203ea844a1aSMatthew Knepley 
2204ea844a1aSMatthew Knepley   PetscFunctionBegin;
2205ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 2);
2206ea844a1aSMatthew Knepley   *values = &baseArray[s->atlasOff[p]];
2207ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2208ea844a1aSMatthew Knepley }
2209ea844a1aSMatthew Knepley 
2210ea844a1aSMatthew Knepley PetscErrorCode VecIntSetValuesSection(PetscInt *baseArray, PetscSection s, PetscInt point, const PetscInt values[], InsertMode mode)
2211ea844a1aSMatthew Knepley {
2212ea844a1aSMatthew Knepley   PetscInt       *array;
2213ea844a1aSMatthew Knepley   const PetscInt p           = point - s->pStart;
2214ea844a1aSMatthew Knepley   const PetscInt orientation = 0; /* Needs to be included for use in closure operations */
2215ea844a1aSMatthew Knepley   PetscInt       cDim        = 0;
2216ea844a1aSMatthew Knepley   PetscErrorCode ierr;
2217ea844a1aSMatthew Knepley 
2218ea844a1aSMatthew Knepley   PetscFunctionBegin;
2219ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 2);
2220ea844a1aSMatthew Knepley   ierr  = PetscSectionGetConstraintDof(s, p, &cDim);CHKERRQ(ierr);
2221ea844a1aSMatthew Knepley   array = &baseArray[s->atlasOff[p]];
2222ea844a1aSMatthew Knepley   if (!cDim) {
2223ea844a1aSMatthew Knepley     if (orientation >= 0) {
2224ea844a1aSMatthew Knepley       const PetscInt dim = s->atlasDof[p];
2225ea844a1aSMatthew Knepley       PetscInt       i;
2226ea844a1aSMatthew Knepley 
2227ea844a1aSMatthew Knepley       if (mode == INSERT_VALUES) {
2228ea844a1aSMatthew Knepley         for (i = 0; i < dim; ++i) array[i] = values[i];
2229ea844a1aSMatthew Knepley       } else {
2230ea844a1aSMatthew Knepley         for (i = 0; i < dim; ++i) array[i] += values[i];
2231ea844a1aSMatthew Knepley       }
2232ea844a1aSMatthew Knepley     } else {
2233ea844a1aSMatthew Knepley       PetscInt offset = 0;
2234ea844a1aSMatthew Knepley       PetscInt j      = -1, field, i;
2235ea844a1aSMatthew Knepley 
2236ea844a1aSMatthew Knepley       for (field = 0; field < s->numFields; ++field) {
2237ea844a1aSMatthew Knepley         const PetscInt dim = s->field[field]->atlasDof[p];
2238ea844a1aSMatthew Knepley 
2239ea844a1aSMatthew Knepley         for (i = dim-1; i >= 0; --i) array[++j] = values[i+offset];
2240ea844a1aSMatthew Knepley         offset += dim;
2241ea844a1aSMatthew Knepley       }
2242ea844a1aSMatthew Knepley     }
2243ea844a1aSMatthew Knepley   } else {
2244ea844a1aSMatthew Knepley     if (orientation >= 0) {
2245ea844a1aSMatthew Knepley       const PetscInt dim  = s->atlasDof[p];
2246ea844a1aSMatthew Knepley       PetscInt       cInd = 0, i;
2247ea844a1aSMatthew Knepley       const PetscInt *cDof;
2248ea844a1aSMatthew Knepley 
2249ea844a1aSMatthew Knepley       ierr = PetscSectionGetConstraintIndices(s, point, &cDof);CHKERRQ(ierr);
2250ea844a1aSMatthew Knepley       if (mode == INSERT_VALUES) {
2251ea844a1aSMatthew Knepley         for (i = 0; i < dim; ++i) {
2252ea844a1aSMatthew Knepley           if ((cInd < cDim) && (i == cDof[cInd])) {++cInd; continue;}
2253ea844a1aSMatthew Knepley           array[i] = values[i];
2254ea844a1aSMatthew Knepley         }
2255ea844a1aSMatthew Knepley       } else {
2256ea844a1aSMatthew Knepley         for (i = 0; i < dim; ++i) {
2257ea844a1aSMatthew Knepley           if ((cInd < cDim) && (i == cDof[cInd])) {++cInd; continue;}
2258ea844a1aSMatthew Knepley           array[i] += values[i];
2259ea844a1aSMatthew Knepley         }
2260ea844a1aSMatthew Knepley       }
2261ea844a1aSMatthew Knepley     } else {
2262ea844a1aSMatthew Knepley       const PetscInt *cDof;
2263ea844a1aSMatthew Knepley       PetscInt       offset  = 0;
2264ea844a1aSMatthew Knepley       PetscInt       cOffset = 0;
2265ea844a1aSMatthew Knepley       PetscInt       j       = 0, field;
2266ea844a1aSMatthew Knepley 
2267ea844a1aSMatthew Knepley       ierr = PetscSectionGetConstraintIndices(s, point, &cDof);CHKERRQ(ierr);
2268ea844a1aSMatthew Knepley       for (field = 0; field < s->numFields; ++field) {
2269ea844a1aSMatthew Knepley         const PetscInt dim  = s->field[field]->atlasDof[p];     /* PetscSectionGetFieldDof() */
2270ea844a1aSMatthew Knepley         const PetscInt tDim = s->field[field]->bc->atlasDof[p]; /* PetscSectionGetFieldConstraintDof() */
2271ea844a1aSMatthew Knepley         const PetscInt sDim = dim - tDim;
2272ea844a1aSMatthew Knepley         PetscInt       cInd = 0, i,k;
2273ea844a1aSMatthew Knepley 
2274ea844a1aSMatthew Knepley         for (i = 0, k = dim+offset-1; i < dim; ++i, ++j, --k) {
2275ea844a1aSMatthew Knepley           if ((cInd < sDim) && (j == cDof[cInd+cOffset])) {++cInd; continue;}
2276ea844a1aSMatthew Knepley           array[j] = values[k];
2277ea844a1aSMatthew Knepley         }
2278ea844a1aSMatthew Knepley         offset  += dim;
2279ea844a1aSMatthew Knepley         cOffset += dim - tDim;
2280ea844a1aSMatthew Knepley       }
2281ea844a1aSMatthew Knepley     }
2282ea844a1aSMatthew Knepley   }
2283ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2284ea844a1aSMatthew Knepley }
2285ea844a1aSMatthew Knepley 
2286ea844a1aSMatthew Knepley /*@C
2287ea844a1aSMatthew Knepley   PetscSectionHasConstraints - Determine whether a section has constrained dofs
2288ea844a1aSMatthew Knepley 
2289ea844a1aSMatthew Knepley   Not collective
2290ea844a1aSMatthew Knepley 
2291ea844a1aSMatthew Knepley   Input Parameter:
2292ea844a1aSMatthew Knepley . s - The PetscSection
2293ea844a1aSMatthew Knepley 
2294ea844a1aSMatthew Knepley   Output Parameter:
2295ea844a1aSMatthew Knepley . hasConstraints - flag indicating that the section has constrained dofs
2296ea844a1aSMatthew Knepley 
2297ea844a1aSMatthew Knepley   Level: intermediate
2298ea844a1aSMatthew Knepley 
2299ea844a1aSMatthew Knepley .seealso: PetscSectionSetConstraintIndices(), PetscSectionGetConstraintDof(), PetscSection
2300ea844a1aSMatthew Knepley @*/
2301ea844a1aSMatthew Knepley PetscErrorCode PetscSectionHasConstraints(PetscSection s, PetscBool *hasConstraints)
2302ea844a1aSMatthew Knepley {
2303ea844a1aSMatthew Knepley   PetscFunctionBegin;
2304ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2305ea844a1aSMatthew Knepley   PetscValidPointer(hasConstraints, 2);
2306ea844a1aSMatthew Knepley   *hasConstraints = s->bc ? PETSC_TRUE : PETSC_FALSE;
2307ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2308ea844a1aSMatthew Knepley }
2309ea844a1aSMatthew Knepley 
2310ea844a1aSMatthew Knepley /*@C
2311ea844a1aSMatthew Knepley   PetscSectionGetConstraintIndices - Get the point dof numbers, in [0, dof), which are constrained
2312ea844a1aSMatthew Knepley 
2313ea844a1aSMatthew Knepley   Not collective
2314ea844a1aSMatthew Knepley 
2315ea844a1aSMatthew Knepley   Input Parameters:
2316ea844a1aSMatthew Knepley + s     - The PetscSection
2317ea844a1aSMatthew Knepley - point - The point
2318ea844a1aSMatthew Knepley 
2319ea844a1aSMatthew Knepley   Output Parameter:
2320ea844a1aSMatthew Knepley . indices - The constrained dofs
2321ea844a1aSMatthew Knepley 
2322ea844a1aSMatthew Knepley   Note: In Fortran, you call PetscSectionGetConstraintIndicesF90() and PetscSectionRestoreConstraintIndicesF90()
2323ea844a1aSMatthew Knepley 
2324ea844a1aSMatthew Knepley   Level: intermediate
2325ea844a1aSMatthew Knepley 
2326ea844a1aSMatthew Knepley .seealso: PetscSectionSetConstraintIndices(), PetscSectionGetConstraintDof(), PetscSection
2327ea844a1aSMatthew Knepley @*/
2328ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetConstraintIndices(PetscSection s, PetscInt point, const PetscInt **indices)
2329ea844a1aSMatthew Knepley {
2330ea844a1aSMatthew Knepley   PetscErrorCode ierr;
2331ea844a1aSMatthew Knepley 
2332ea844a1aSMatthew Knepley   PetscFunctionBegin;
2333ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2334ea844a1aSMatthew Knepley   if (s->bc) {
2335ea844a1aSMatthew Knepley     ierr = VecIntGetValuesSection(s->bcIndices, s->bc, point, indices);CHKERRQ(ierr);
2336ea844a1aSMatthew Knepley   } else *indices = NULL;
2337ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2338ea844a1aSMatthew Knepley }
2339ea844a1aSMatthew Knepley 
2340ea844a1aSMatthew Knepley /*@C
2341ea844a1aSMatthew Knepley   PetscSectionSetConstraintIndices - Set the point dof numbers, in [0, dof), which are constrained
2342ea844a1aSMatthew Knepley 
2343ea844a1aSMatthew Knepley   Not collective
2344ea844a1aSMatthew Knepley 
2345ea844a1aSMatthew Knepley   Input Parameters:
2346ea844a1aSMatthew Knepley + s     - The PetscSection
2347ea844a1aSMatthew Knepley . point - The point
2348ea844a1aSMatthew Knepley - indices - The constrained dofs
2349ea844a1aSMatthew Knepley 
2350ea844a1aSMatthew Knepley   Note: The Fortran is PetscSectionSetConstraintIndicesF90()
2351ea844a1aSMatthew Knepley 
2352ea844a1aSMatthew Knepley   Level: intermediate
2353ea844a1aSMatthew Knepley 
2354ea844a1aSMatthew Knepley .seealso: PetscSectionGetConstraintIndices(), PetscSectionGetConstraintDof(), PetscSection
2355ea844a1aSMatthew Knepley @*/
2356ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetConstraintIndices(PetscSection s, PetscInt point, const PetscInt indices[])
2357ea844a1aSMatthew Knepley {
2358ea844a1aSMatthew Knepley   PetscErrorCode ierr;
2359ea844a1aSMatthew Knepley 
2360ea844a1aSMatthew Knepley   PetscFunctionBegin;
2361ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2362ea844a1aSMatthew Knepley   if (s->bc) {
2363ea844a1aSMatthew Knepley     ierr = VecIntSetValuesSection(s->bcIndices, s->bc, point, indices, INSERT_VALUES);CHKERRQ(ierr);
2364ea844a1aSMatthew Knepley   }
2365ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2366ea844a1aSMatthew Knepley }
2367ea844a1aSMatthew Knepley 
2368ea844a1aSMatthew Knepley /*@C
2369ea844a1aSMatthew Knepley   PetscSectionGetFieldConstraintIndices - Get the field dof numbers, in [0, fdof), which are constrained
2370ea844a1aSMatthew Knepley 
2371ea844a1aSMatthew Knepley   Not collective
2372ea844a1aSMatthew Knepley 
2373ea844a1aSMatthew Knepley   Input Parameters:
2374ea844a1aSMatthew Knepley + s     - The PetscSection
2375ea844a1aSMatthew Knepley . field  - The field number
2376ea844a1aSMatthew Knepley - point - The point
2377ea844a1aSMatthew Knepley 
2378ea844a1aSMatthew Knepley   Output Parameter:
23799759eb26SJed Brown . indices - The constrained dofs sorted in ascending order
2380ea844a1aSMatthew Knepley 
23819759eb26SJed Brown   Notes:
23829759eb26SJed Brown   The indices array, which is provided by the caller, must have capacity to hold the number of constrained dofs, e.g., as returned by PetscSectionGetConstraintDof().
23839759eb26SJed Brown 
23849759eb26SJed Brown   Fortran Note:
23859759eb26SJed Brown   In Fortran, you call PetscSectionGetFieldConstraintIndicesF90() and PetscSectionRestoreFieldConstraintIndicesF90()
2386ea844a1aSMatthew Knepley 
2387ea844a1aSMatthew Knepley   Level: intermediate
2388ea844a1aSMatthew Knepley 
2389ea844a1aSMatthew Knepley .seealso: PetscSectionSetFieldConstraintIndices(), PetscSectionGetConstraintIndices(), PetscSectionGetConstraintDof(), PetscSection
2390ea844a1aSMatthew Knepley @*/
2391ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetFieldConstraintIndices(PetscSection s, PetscInt point, PetscInt field, const PetscInt **indices)
2392ea844a1aSMatthew Knepley {
2393ea844a1aSMatthew Knepley   PetscErrorCode ierr;
2394ea844a1aSMatthew Knepley 
2395ea844a1aSMatthew Knepley   PetscFunctionBegin;
2396ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2397ea844a1aSMatthew Knepley   if ((field < 0) || (field >= s->numFields)) SETERRQ3(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Section field %D should be in [%D, %D)", field, 0, s->numFields);
2398ea844a1aSMatthew Knepley   ierr = PetscSectionGetConstraintIndices(s->field[field], point, indices);CHKERRQ(ierr);
2399ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2400ea844a1aSMatthew Knepley }
2401ea844a1aSMatthew Knepley 
2402ea844a1aSMatthew Knepley /*@C
2403ea844a1aSMatthew Knepley   PetscSectionSetFieldConstraintIndices - Set the field dof numbers, in [0, fdof), which are constrained
2404ea844a1aSMatthew Knepley 
2405ea844a1aSMatthew Knepley   Not collective
2406ea844a1aSMatthew Knepley 
2407ea844a1aSMatthew Knepley   Input Parameters:
2408ea844a1aSMatthew Knepley + s       - The PetscSection
2409ea844a1aSMatthew Knepley . point   - The point
2410ea844a1aSMatthew Knepley . field   - The field number
2411ea844a1aSMatthew Knepley - indices - The constrained dofs
2412ea844a1aSMatthew Knepley 
2413ea844a1aSMatthew Knepley   Note: The Fortran is PetscSectionSetFieldConstraintIndicesF90()
2414ea844a1aSMatthew Knepley 
2415ea844a1aSMatthew Knepley   Level: intermediate
2416ea844a1aSMatthew Knepley 
2417ea844a1aSMatthew Knepley .seealso: PetscSectionSetConstraintIndices(), PetscSectionGetFieldConstraintIndices(), PetscSectionGetConstraintDof(), PetscSection
2418ea844a1aSMatthew Knepley @*/
2419ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetFieldConstraintIndices(PetscSection s, PetscInt point, PetscInt field, const PetscInt indices[])
2420ea844a1aSMatthew Knepley {
2421ea844a1aSMatthew Knepley   PetscErrorCode ierr;
2422ea844a1aSMatthew Knepley 
2423ea844a1aSMatthew Knepley   PetscFunctionBegin;
2424ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2425ea844a1aSMatthew Knepley   if ((field < 0) || (field >= s->numFields)) SETERRQ3(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Section field %D should be in [%D, %D)", field, 0, s->numFields);
2426ea844a1aSMatthew Knepley   ierr = PetscSectionSetConstraintIndices(s->field[field], point, indices);CHKERRQ(ierr);
2427ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2428ea844a1aSMatthew Knepley }
2429ea844a1aSMatthew Knepley 
2430ea844a1aSMatthew Knepley /*@
2431ea844a1aSMatthew Knepley   PetscSectionPermute - Reorder the section according to the input point permutation
2432ea844a1aSMatthew Knepley 
2433ea844a1aSMatthew Knepley   Collective on PetscSection
2434ea844a1aSMatthew Knepley 
2435ea844a1aSMatthew Knepley   Input Parameter:
2436ea844a1aSMatthew Knepley + section - The PetscSection object
2437ea844a1aSMatthew Knepley - perm - The point permutation, old point p becomes new point perm[p]
2438ea844a1aSMatthew Knepley 
2439ea844a1aSMatthew Knepley   Output Parameter:
2440ea844a1aSMatthew Knepley . sectionNew - The permuted PetscSection
2441ea844a1aSMatthew Knepley 
2442ea844a1aSMatthew Knepley   Level: intermediate
2443ea844a1aSMatthew Knepley 
2444ea844a1aSMatthew Knepley .seealso: MatPermute()
2445ea844a1aSMatthew Knepley @*/
2446ea844a1aSMatthew Knepley PetscErrorCode PetscSectionPermute(PetscSection section, IS permutation, PetscSection *sectionNew)
2447ea844a1aSMatthew Knepley {
2448ea844a1aSMatthew Knepley   PetscSection    s = section, sNew;
2449ea844a1aSMatthew Knepley   const PetscInt *perm;
2450b778fa18SValeria Barra   PetscInt        numFields, f, c, numPoints, pStart, pEnd, p;
2451ea844a1aSMatthew Knepley   PetscErrorCode  ierr;
2452ea844a1aSMatthew Knepley 
2453ea844a1aSMatthew Knepley   PetscFunctionBegin;
2454ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1);
2455ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(permutation, IS_CLASSID, 2);
2456ea844a1aSMatthew Knepley   PetscValidPointer(sectionNew, 3);
2457ea844a1aSMatthew Knepley   ierr = PetscSectionCreate(PetscObjectComm((PetscObject) s), &sNew);CHKERRQ(ierr);
2458ea844a1aSMatthew Knepley   ierr = PetscSectionGetNumFields(s, &numFields);CHKERRQ(ierr);
2459ea844a1aSMatthew Knepley   if (numFields) {ierr = PetscSectionSetNumFields(sNew, numFields);CHKERRQ(ierr);}
2460ea844a1aSMatthew Knepley   for (f = 0; f < numFields; ++f) {
2461ea844a1aSMatthew Knepley     const char *name;
2462ea844a1aSMatthew Knepley     PetscInt    numComp;
2463ea844a1aSMatthew Knepley 
2464ea844a1aSMatthew Knepley     ierr = PetscSectionGetFieldName(s, f, &name);CHKERRQ(ierr);
2465ea844a1aSMatthew Knepley     ierr = PetscSectionSetFieldName(sNew, f, name);CHKERRQ(ierr);
2466ea844a1aSMatthew Knepley     ierr = PetscSectionGetFieldComponents(s, f, &numComp);CHKERRQ(ierr);
2467ea844a1aSMatthew Knepley     ierr = PetscSectionSetFieldComponents(sNew, f, numComp);CHKERRQ(ierr);
2468b778fa18SValeria Barra     for (c = 0; c < s->numFieldComponents[f]; ++c) {
2469b778fa18SValeria Barra       ierr = PetscSectionGetComponentName(s, f, c, &name);CHKERRQ(ierr);
2470b778fa18SValeria Barra       ierr = PetscSectionSetComponentName(sNew, f, c, name);CHKERRQ(ierr);
2471b778fa18SValeria Barra     }
2472ea844a1aSMatthew Knepley   }
2473ea844a1aSMatthew Knepley   ierr = ISGetLocalSize(permutation, &numPoints);CHKERRQ(ierr);
2474ea844a1aSMatthew Knepley   ierr = ISGetIndices(permutation, &perm);CHKERRQ(ierr);
2475ea844a1aSMatthew Knepley   ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr);
2476ea844a1aSMatthew Knepley   ierr = PetscSectionSetChart(sNew, pStart, pEnd);CHKERRQ(ierr);
2477ea844a1aSMatthew Knepley   if (numPoints < pEnd) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "Permutation size %D is less than largest Section point %D", numPoints, pEnd);
2478ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
2479ea844a1aSMatthew Knepley     PetscInt dof, cdof;
2480ea844a1aSMatthew Knepley 
2481ea844a1aSMatthew Knepley     ierr = PetscSectionGetDof(s, p, &dof);CHKERRQ(ierr);
2482ea844a1aSMatthew Knepley     ierr = PetscSectionSetDof(sNew, perm[p], dof);CHKERRQ(ierr);
2483ea844a1aSMatthew Knepley     ierr = PetscSectionGetConstraintDof(s, p, &cdof);CHKERRQ(ierr);
2484ea844a1aSMatthew Knepley     if (cdof) {ierr = PetscSectionSetConstraintDof(sNew, perm[p], cdof);CHKERRQ(ierr);}
2485ea844a1aSMatthew Knepley     for (f = 0; f < numFields; ++f) {
2486ea844a1aSMatthew Knepley       ierr = PetscSectionGetFieldDof(s, p, f, &dof);CHKERRQ(ierr);
2487ea844a1aSMatthew Knepley       ierr = PetscSectionSetFieldDof(sNew, perm[p], f, dof);CHKERRQ(ierr);
2488ea844a1aSMatthew Knepley       ierr = PetscSectionGetFieldConstraintDof(s, p, f, &cdof);CHKERRQ(ierr);
2489ea844a1aSMatthew Knepley       if (cdof) {ierr = PetscSectionSetFieldConstraintDof(sNew, perm[p], f, cdof);CHKERRQ(ierr);}
2490ea844a1aSMatthew Knepley     }
2491ea844a1aSMatthew Knepley   }
2492ea844a1aSMatthew Knepley   ierr = PetscSectionSetUp(sNew);CHKERRQ(ierr);
2493ea844a1aSMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
2494ea844a1aSMatthew Knepley     const PetscInt *cind;
2495ea844a1aSMatthew Knepley     PetscInt        cdof;
2496ea844a1aSMatthew Knepley 
2497ea844a1aSMatthew Knepley     ierr = PetscSectionGetConstraintDof(s, p, &cdof);CHKERRQ(ierr);
2498ea844a1aSMatthew Knepley     if (cdof) {
2499ea844a1aSMatthew Knepley       ierr = PetscSectionGetConstraintIndices(s, p, &cind);CHKERRQ(ierr);
2500ea844a1aSMatthew Knepley       ierr = PetscSectionSetConstraintIndices(sNew, perm[p], cind);CHKERRQ(ierr);
2501ea844a1aSMatthew Knepley     }
2502ea844a1aSMatthew Knepley     for (f = 0; f < numFields; ++f) {
2503ea844a1aSMatthew Knepley       ierr = PetscSectionGetFieldConstraintDof(s, p, f, &cdof);CHKERRQ(ierr);
2504ea844a1aSMatthew Knepley       if (cdof) {
2505ea844a1aSMatthew Knepley         ierr = PetscSectionGetFieldConstraintIndices(s, p, f, &cind);CHKERRQ(ierr);
2506ea844a1aSMatthew Knepley         ierr = PetscSectionSetFieldConstraintIndices(sNew, perm[p], f, cind);CHKERRQ(ierr);
2507ea844a1aSMatthew Knepley       }
2508ea844a1aSMatthew Knepley     }
2509ea844a1aSMatthew Knepley   }
2510ea844a1aSMatthew Knepley   ierr = ISRestoreIndices(permutation, &perm);CHKERRQ(ierr);
2511ea844a1aSMatthew Knepley   *sectionNew = sNew;
2512ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2513ea844a1aSMatthew Knepley }
2514ea844a1aSMatthew Knepley 
2515ea844a1aSMatthew Knepley /* TODO: the next three functions should be moved to sf/utils */
2516ea844a1aSMatthew Knepley #include <petsc/private/sfimpl.h>
2517ea844a1aSMatthew Knepley 
2518ea844a1aSMatthew Knepley /*@C
2519ea844a1aSMatthew Knepley   PetscSFDistributeSection - Create a new PetscSection reorganized, moving from the root to the leaves of the SF
2520ea844a1aSMatthew Knepley 
2521ea844a1aSMatthew Knepley   Collective on sf
2522ea844a1aSMatthew Knepley 
2523ea844a1aSMatthew Knepley   Input Parameters:
2524ea844a1aSMatthew Knepley + sf - The SF
2525ea844a1aSMatthew Knepley - rootSection - Section defined on root space
2526ea844a1aSMatthew Knepley 
2527ea844a1aSMatthew Knepley   Output Parameters:
2528ea844a1aSMatthew Knepley + remoteOffsets - root offsets in leaf storage, or NULL
2529ea844a1aSMatthew Knepley - leafSection - Section defined on the leaf space
2530ea844a1aSMatthew Knepley 
2531ea844a1aSMatthew Knepley   Level: advanced
2532ea844a1aSMatthew Knepley 
2533ea844a1aSMatthew Knepley .seealso: PetscSFCreate()
2534ea844a1aSMatthew Knepley @*/
2535ea844a1aSMatthew Knepley PetscErrorCode PetscSFDistributeSection(PetscSF sf, PetscSection rootSection, PetscInt **remoteOffsets, PetscSection leafSection)
2536ea844a1aSMatthew Knepley {
2537ea844a1aSMatthew Knepley   PetscSF        embedSF;
2538ea844a1aSMatthew Knepley   const PetscInt *indices;
2539ea844a1aSMatthew Knepley   IS             selected;
2540b778fa18SValeria Barra   PetscInt       numFields, nroots, rpStart, rpEnd, lpStart = PETSC_MAX_INT, lpEnd = -1, f, c;
254128d58a37SPierre Jolivet   PetscBool      *sub, hasc;
2542ea844a1aSMatthew Knepley   PetscErrorCode ierr;
2543ea844a1aSMatthew Knepley 
2544ea844a1aSMatthew Knepley   PetscFunctionBegin;
2545ea844a1aSMatthew Knepley   ierr = PetscLogEventBegin(PETSCSF_DistSect,sf,0,0,0);CHKERRQ(ierr);
2546ea844a1aSMatthew Knepley   ierr = PetscSectionGetNumFields(rootSection, &numFields);CHKERRQ(ierr);
2547ea844a1aSMatthew Knepley   if (numFields) {ierr = PetscSectionSetNumFields(leafSection, numFields);CHKERRQ(ierr);}
254828d58a37SPierre Jolivet   ierr = PetscMalloc1(numFields+2, &sub);CHKERRQ(ierr);
254928d58a37SPierre Jolivet   sub[1] = rootSection->bc ? PETSC_TRUE : PETSC_FALSE;
2550ea844a1aSMatthew Knepley   for (f = 0; f < numFields; ++f) {
255128d58a37SPierre Jolivet     PetscSectionSym sym;
255228d58a37SPierre Jolivet     const char      *name   = NULL;
2553ea844a1aSMatthew Knepley     PetscInt        numComp = 0;
255428d58a37SPierre Jolivet 
255528d58a37SPierre Jolivet     sub[2 + f] = rootSection->field[f]->bc ? PETSC_TRUE : PETSC_FALSE;
2556ea844a1aSMatthew Knepley     ierr = PetscSectionGetFieldComponents(rootSection, f, &numComp);CHKERRQ(ierr);
255728d58a37SPierre Jolivet     ierr = PetscSectionGetFieldName(rootSection, f, &name);CHKERRQ(ierr);
255828d58a37SPierre Jolivet     ierr = PetscSectionGetFieldSym(rootSection, f, &sym);CHKERRQ(ierr);
2559ea844a1aSMatthew Knepley     ierr = PetscSectionSetFieldComponents(leafSection, f, numComp);CHKERRQ(ierr);
256028d58a37SPierre Jolivet     ierr = PetscSectionSetFieldName(leafSection, f, name);CHKERRQ(ierr);
256128d58a37SPierre Jolivet     ierr = PetscSectionSetFieldSym(leafSection, f, sym);CHKERRQ(ierr);
2562b778fa18SValeria Barra     for (c = 0; c < rootSection->numFieldComponents[f]; ++c) {
2563b778fa18SValeria Barra       ierr = PetscSectionGetComponentName(rootSection, f, c, &name);CHKERRQ(ierr);
2564b778fa18SValeria Barra       ierr = PetscSectionSetComponentName(leafSection, f, c, name);CHKERRQ(ierr);
2565b778fa18SValeria Barra     }
2566ea844a1aSMatthew Knepley   }
2567ea844a1aSMatthew Knepley   ierr = PetscSectionGetChart(rootSection, &rpStart, &rpEnd);CHKERRQ(ierr);
2568ea844a1aSMatthew Knepley   ierr = PetscSFGetGraph(sf,&nroots,NULL,NULL,NULL);CHKERRQ(ierr);
2569ea844a1aSMatthew Knepley   rpEnd = PetscMin(rpEnd,nroots);
2570ea844a1aSMatthew Knepley   rpEnd = PetscMax(rpStart,rpEnd);
2571ea844a1aSMatthew Knepley   /* see if we can avoid creating the embedded SF, since it can cost more than an allreduce */
257228d58a37SPierre Jolivet   sub[0] = (PetscBool)(nroots != rpEnd - rpStart);
257328d58a37SPierre Jolivet   ierr = MPIU_Allreduce(MPI_IN_PLACE, sub, 2+numFields, MPIU_BOOL, MPI_LOR, PetscObjectComm((PetscObject)sf));CHKERRQ(ierr);
257428d58a37SPierre Jolivet   if (sub[0]) {
2575ea844a1aSMatthew Knepley     ierr = ISCreateStride(PETSC_COMM_SELF, rpEnd - rpStart, rpStart, 1, &selected);CHKERRQ(ierr);
2576ea844a1aSMatthew Knepley     ierr = ISGetIndices(selected, &indices);CHKERRQ(ierr);
2577ea844a1aSMatthew Knepley     ierr = PetscSFCreateEmbeddedSF(sf, rpEnd - rpStart, indices, &embedSF);CHKERRQ(ierr);
2578ea844a1aSMatthew Knepley     ierr = ISRestoreIndices(selected, &indices);CHKERRQ(ierr);
2579ea844a1aSMatthew Knepley     ierr = ISDestroy(&selected);CHKERRQ(ierr);
2580ea844a1aSMatthew Knepley   } else {
2581ea844a1aSMatthew Knepley     ierr = PetscObjectReference((PetscObject)sf);CHKERRQ(ierr);
2582ea844a1aSMatthew Knepley     embedSF = sf;
2583ea844a1aSMatthew Knepley   }
2584ea844a1aSMatthew Knepley   ierr = PetscSFGetLeafRange(embedSF, &lpStart, &lpEnd);CHKERRQ(ierr);
2585ea844a1aSMatthew Knepley   lpEnd++;
2586ea844a1aSMatthew Knepley 
2587ea844a1aSMatthew Knepley   ierr = PetscSectionSetChart(leafSection, lpStart, lpEnd);CHKERRQ(ierr);
258828d58a37SPierre Jolivet 
258928d58a37SPierre Jolivet   /* Constrained dof section */
259028d58a37SPierre Jolivet   hasc = sub[1];
259128d58a37SPierre Jolivet   for (f = 0; f < numFields; ++f) hasc = (PetscBool)(hasc || sub[2+f]);
259228d58a37SPierre Jolivet 
259328d58a37SPierre Jolivet   /* Could fuse these at the cost of copies and extra allocation */
2594ea844a1aSMatthew Knepley   ierr = PetscSFBcastBegin(embedSF, MPIU_INT, &rootSection->atlasDof[-rpStart], &leafSection->atlasDof[-lpStart]);CHKERRQ(ierr);
2595ea844a1aSMatthew Knepley   ierr = PetscSFBcastEnd(embedSF, MPIU_INT, &rootSection->atlasDof[-rpStart], &leafSection->atlasDof[-lpStart]);CHKERRQ(ierr);
259628d58a37SPierre Jolivet   if (sub[1]) {
259728d58a37SPierre Jolivet     ierr = PetscSectionCheckConstraints_Static(rootSection);CHKERRQ(ierr);
259828d58a37SPierre Jolivet     ierr = PetscSectionCheckConstraints_Static(leafSection);CHKERRQ(ierr);
259928d58a37SPierre Jolivet     ierr = PetscSFBcastBegin(embedSF, MPIU_INT, &rootSection->bc->atlasDof[-rpStart], &leafSection->bc->atlasDof[-lpStart]);CHKERRQ(ierr);
260028d58a37SPierre Jolivet     ierr = PetscSFBcastEnd(embedSF, MPIU_INT, &rootSection->bc->atlasDof[-rpStart], &leafSection->bc->atlasDof[-lpStart]);CHKERRQ(ierr);
260128d58a37SPierre Jolivet   }
2602ea844a1aSMatthew Knepley   for (f = 0; f < numFields; ++f) {
2603ea844a1aSMatthew Knepley     ierr = PetscSFBcastBegin(embedSF, MPIU_INT, &rootSection->field[f]->atlasDof[-rpStart], &leafSection->field[f]->atlasDof[-lpStart]);CHKERRQ(ierr);
2604ea844a1aSMatthew Knepley     ierr = PetscSFBcastEnd(embedSF, MPIU_INT, &rootSection->field[f]->atlasDof[-rpStart], &leafSection->field[f]->atlasDof[-lpStart]);CHKERRQ(ierr);
260528d58a37SPierre Jolivet     if (sub[2+f]) {
260628d58a37SPierre Jolivet       ierr = PetscSectionCheckConstraints_Static(rootSection->field[f]);CHKERRQ(ierr);
260728d58a37SPierre Jolivet       ierr = PetscSectionCheckConstraints_Static(leafSection->field[f]);CHKERRQ(ierr);
260828d58a37SPierre Jolivet       ierr = PetscSFBcastBegin(embedSF, MPIU_INT, &rootSection->field[f]->bc->atlasDof[-rpStart], &leafSection->field[f]->bc->atlasDof[-lpStart]);CHKERRQ(ierr);
260928d58a37SPierre Jolivet       ierr = PetscSFBcastEnd(embedSF, MPIU_INT, &rootSection->field[f]->bc->atlasDof[-rpStart], &leafSection->field[f]->bc->atlasDof[-lpStart]);CHKERRQ(ierr);
261028d58a37SPierre Jolivet     }
2611ea844a1aSMatthew Knepley   }
2612ea844a1aSMatthew Knepley   if (remoteOffsets) {
2613ea844a1aSMatthew Knepley     ierr = PetscMalloc1(lpEnd - lpStart, remoteOffsets);CHKERRQ(ierr);
2614ea844a1aSMatthew Knepley     ierr = PetscSFBcastBegin(embedSF, MPIU_INT, &rootSection->atlasOff[-rpStart], &(*remoteOffsets)[-lpStart]);CHKERRQ(ierr);
2615ea844a1aSMatthew Knepley     ierr = PetscSFBcastEnd(embedSF, MPIU_INT, &rootSection->atlasOff[-rpStart], &(*remoteOffsets)[-lpStart]);CHKERRQ(ierr);
2616ea844a1aSMatthew Knepley   }
2617ea844a1aSMatthew Knepley   ierr = PetscSectionSetUp(leafSection);CHKERRQ(ierr);
261828d58a37SPierre Jolivet   if (hasc) { /* need to communicate bcIndices */
261928d58a37SPierre Jolivet     PetscSF  bcSF;
262028d58a37SPierre Jolivet     PetscInt *rOffBc;
262128d58a37SPierre Jolivet 
262228d58a37SPierre Jolivet     ierr = PetscMalloc1(lpEnd - lpStart, &rOffBc);CHKERRQ(ierr);
262328d58a37SPierre Jolivet     if (sub[1]) {
262428d58a37SPierre Jolivet       ierr = PetscSFBcastBegin(embedSF, MPIU_INT, &rootSection->bc->atlasOff[-rpStart], &rOffBc[-lpStart]);CHKERRQ(ierr);
262528d58a37SPierre Jolivet       ierr = PetscSFBcastEnd(embedSF, MPIU_INT, &rootSection->bc->atlasOff[-rpStart], &rOffBc[-lpStart]);CHKERRQ(ierr);
262628d58a37SPierre Jolivet       ierr = PetscSFCreateSectionSF(embedSF, rootSection->bc, rOffBc, leafSection->bc, &bcSF);CHKERRQ(ierr);
262728d58a37SPierre Jolivet       ierr = PetscSFBcastBegin(bcSF, MPIU_INT, rootSection->bcIndices, leafSection->bcIndices);CHKERRQ(ierr);
262828d58a37SPierre Jolivet       ierr = PetscSFBcastEnd(bcSF, MPIU_INT, rootSection->bcIndices, leafSection->bcIndices);CHKERRQ(ierr);
262928d58a37SPierre Jolivet       ierr = PetscSFDestroy(&bcSF);CHKERRQ(ierr);
263028d58a37SPierre Jolivet     }
263128d58a37SPierre Jolivet     for (f = 0; f < numFields; ++f) {
263228d58a37SPierre Jolivet       if (sub[2+f]) {
263328d58a37SPierre Jolivet         ierr = PetscSFBcastBegin(embedSF, MPIU_INT, &rootSection->field[f]->bc->atlasOff[-rpStart], &rOffBc[-lpStart]);CHKERRQ(ierr);
263428d58a37SPierre Jolivet         ierr = PetscSFBcastEnd(embedSF, MPIU_INT, &rootSection->field[f]->bc->atlasOff[-rpStart], &rOffBc[-lpStart]);CHKERRQ(ierr);
263528d58a37SPierre Jolivet         ierr = PetscSFCreateSectionSF(embedSF, rootSection->field[f]->bc, rOffBc, leafSection->field[f]->bc, &bcSF);CHKERRQ(ierr);
263628d58a37SPierre Jolivet         ierr = PetscSFBcastBegin(bcSF, MPIU_INT, rootSection->field[f]->bcIndices, leafSection->field[f]->bcIndices);CHKERRQ(ierr);
263728d58a37SPierre Jolivet         ierr = PetscSFBcastEnd(bcSF, MPIU_INT, rootSection->field[f]->bcIndices, leafSection->field[f]->bcIndices);CHKERRQ(ierr);
263828d58a37SPierre Jolivet         ierr = PetscSFDestroy(&bcSF);CHKERRQ(ierr);
263928d58a37SPierre Jolivet       }
264028d58a37SPierre Jolivet     }
264128d58a37SPierre Jolivet     ierr = PetscFree(rOffBc);CHKERRQ(ierr);
264228d58a37SPierre Jolivet   }
264328d58a37SPierre Jolivet   ierr = PetscSFDestroy(&embedSF);CHKERRQ(ierr);
264428d58a37SPierre Jolivet   ierr = PetscFree(sub);CHKERRQ(ierr);
2645ea844a1aSMatthew Knepley   ierr = PetscLogEventEnd(PETSCSF_DistSect,sf,0,0,0);CHKERRQ(ierr);
2646ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2647ea844a1aSMatthew Knepley }
2648ea844a1aSMatthew Knepley 
2649ea844a1aSMatthew Knepley /*@C
2650ea844a1aSMatthew Knepley   PetscSFCreateRemoteOffsets - Create offsets for point data on remote processes
2651ea844a1aSMatthew Knepley 
2652ea844a1aSMatthew Knepley   Collective on sf
2653ea844a1aSMatthew Knepley 
2654ea844a1aSMatthew Knepley   Input Parameters:
2655ea844a1aSMatthew Knepley + sf          - The SF
2656ea844a1aSMatthew Knepley . rootSection - Data layout of remote points for outgoing data (this is layout for SF roots)
2657ea844a1aSMatthew Knepley - leafSection - Data layout of local points for incoming data  (this is layout for SF leaves)
2658ea844a1aSMatthew Knepley 
2659ea844a1aSMatthew Knepley   Output Parameter:
2660ea844a1aSMatthew Knepley . remoteOffsets - Offsets for point data on remote processes (these are offsets from the root section), or NULL
2661ea844a1aSMatthew Knepley 
2662ea844a1aSMatthew Knepley   Level: developer
2663ea844a1aSMatthew Knepley 
2664ea844a1aSMatthew Knepley .seealso: PetscSFCreate()
2665ea844a1aSMatthew Knepley @*/
2666ea844a1aSMatthew Knepley PetscErrorCode PetscSFCreateRemoteOffsets(PetscSF sf, PetscSection rootSection, PetscSection leafSection, PetscInt **remoteOffsets)
2667ea844a1aSMatthew Knepley {
2668ea844a1aSMatthew Knepley   PetscSF         embedSF;
2669ea844a1aSMatthew Knepley   const PetscInt *indices;
2670ea844a1aSMatthew Knepley   IS              selected;
2671ea844a1aSMatthew Knepley   PetscInt        numRoots, rpStart = 0, rpEnd = 0, lpStart = 0, lpEnd = 0;
2672ea844a1aSMatthew Knepley   PetscErrorCode  ierr;
2673ea844a1aSMatthew Knepley 
2674ea844a1aSMatthew Knepley   PetscFunctionBegin;
2675ea844a1aSMatthew Knepley   *remoteOffsets = NULL;
2676ea844a1aSMatthew Knepley   ierr = PetscSFGetGraph(sf, &numRoots, NULL, NULL, NULL);CHKERRQ(ierr);
2677ea844a1aSMatthew Knepley   if (numRoots < 0) PetscFunctionReturn(0);
2678ea844a1aSMatthew Knepley   ierr = PetscLogEventBegin(PETSCSF_RemoteOff,sf,0,0,0);CHKERRQ(ierr);
2679ea844a1aSMatthew Knepley   ierr = PetscSectionGetChart(rootSection, &rpStart, &rpEnd);CHKERRQ(ierr);
2680ea844a1aSMatthew Knepley   ierr = PetscSectionGetChart(leafSection, &lpStart, &lpEnd);CHKERRQ(ierr);
2681ea844a1aSMatthew Knepley   ierr = ISCreateStride(PETSC_COMM_SELF, rpEnd - rpStart, rpStart, 1, &selected);CHKERRQ(ierr);
2682ea844a1aSMatthew Knepley   ierr = ISGetIndices(selected, &indices);CHKERRQ(ierr);
2683ea844a1aSMatthew Knepley   ierr = PetscSFCreateEmbeddedSF(sf, rpEnd - rpStart, indices, &embedSF);CHKERRQ(ierr);
2684ea844a1aSMatthew Knepley   ierr = ISRestoreIndices(selected, &indices);CHKERRQ(ierr);
2685ea844a1aSMatthew Knepley   ierr = ISDestroy(&selected);CHKERRQ(ierr);
2686ea844a1aSMatthew Knepley   ierr = PetscCalloc1(lpEnd - lpStart, remoteOffsets);CHKERRQ(ierr);
2687ea844a1aSMatthew Knepley   ierr = PetscSFBcastBegin(embedSF, MPIU_INT, &rootSection->atlasOff[-rpStart], &(*remoteOffsets)[-lpStart]);CHKERRQ(ierr);
2688ea844a1aSMatthew Knepley   ierr = PetscSFBcastEnd(embedSF, MPIU_INT, &rootSection->atlasOff[-rpStart], &(*remoteOffsets)[-lpStart]);CHKERRQ(ierr);
2689ea844a1aSMatthew Knepley   ierr = PetscSFDestroy(&embedSF);CHKERRQ(ierr);
2690ea844a1aSMatthew Knepley   ierr = PetscLogEventEnd(PETSCSF_RemoteOff,sf,0,0,0);CHKERRQ(ierr);
2691ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2692ea844a1aSMatthew Knepley }
2693ea844a1aSMatthew Knepley 
2694ea844a1aSMatthew Knepley /*@C
2695ea844a1aSMatthew Knepley   PetscSFCreateSectionSF - Create an expanded SF of dofs, assuming the input SF relates points
2696ea844a1aSMatthew Knepley 
2697ea844a1aSMatthew Knepley   Collective on sf
2698ea844a1aSMatthew Knepley 
2699ea844a1aSMatthew Knepley   Input Parameters:
2700ea844a1aSMatthew Knepley + sf - The SF
2701ea844a1aSMatthew Knepley . rootSection - Data layout of remote points for outgoing data (this is usually the serial section)
2702ea844a1aSMatthew Knepley . remoteOffsets - Offsets for point data on remote processes (these are offsets from the root section), or NULL
2703ea844a1aSMatthew Knepley - leafSection - Data layout of local points for incoming data  (this is the distributed section)
2704ea844a1aSMatthew Knepley 
2705ea844a1aSMatthew Knepley   Output Parameters:
2706ea844a1aSMatthew Knepley - sectionSF - The new SF
2707ea844a1aSMatthew Knepley 
2708ea844a1aSMatthew Knepley   Note: Either rootSection or remoteOffsets can be specified
2709ea844a1aSMatthew Knepley 
2710ea844a1aSMatthew Knepley   Level: advanced
2711ea844a1aSMatthew Knepley 
2712ea844a1aSMatthew Knepley .seealso: PetscSFCreate()
2713ea844a1aSMatthew Knepley @*/
2714ea844a1aSMatthew Knepley PetscErrorCode PetscSFCreateSectionSF(PetscSF sf, PetscSection rootSection, PetscInt remoteOffsets[], PetscSection leafSection, PetscSF *sectionSF)
2715ea844a1aSMatthew Knepley {
2716ea844a1aSMatthew Knepley   MPI_Comm          comm;
2717ea844a1aSMatthew Knepley   const PetscInt    *localPoints;
2718ea844a1aSMatthew Knepley   const PetscSFNode *remotePoints;
2719ea844a1aSMatthew Knepley   PetscInt          lpStart, lpEnd;
2720ea844a1aSMatthew Knepley   PetscInt          numRoots, numSectionRoots, numPoints, numIndices = 0;
2721ea844a1aSMatthew Knepley   PetscInt          *localIndices;
2722ea844a1aSMatthew Knepley   PetscSFNode       *remoteIndices;
2723ea844a1aSMatthew Knepley   PetscInt          i, ind;
2724ea844a1aSMatthew Knepley   PetscErrorCode    ierr;
2725ea844a1aSMatthew Knepley 
2726ea844a1aSMatthew Knepley   PetscFunctionBegin;
2727ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
2728ea844a1aSMatthew Knepley   PetscValidPointer(rootSection,2);
2729ea844a1aSMatthew Knepley   /* Cannot check PetscValidIntPointer(remoteOffsets,3) because it can be NULL if sf does not reference any points in leafSection */
2730ea844a1aSMatthew Knepley   PetscValidPointer(leafSection,4);
2731ea844a1aSMatthew Knepley   PetscValidPointer(sectionSF,5);
2732ea844a1aSMatthew Knepley   ierr = PetscObjectGetComm((PetscObject)sf,&comm);CHKERRQ(ierr);
2733ea844a1aSMatthew Knepley   ierr = PetscSFCreate(comm, sectionSF);CHKERRQ(ierr);
2734ea844a1aSMatthew Knepley   ierr = PetscSectionGetChart(leafSection, &lpStart, &lpEnd);CHKERRQ(ierr);
2735ea844a1aSMatthew Knepley   ierr = PetscSectionGetStorageSize(rootSection, &numSectionRoots);CHKERRQ(ierr);
2736ea844a1aSMatthew Knepley   ierr = PetscSFGetGraph(sf, &numRoots, &numPoints, &localPoints, &remotePoints);CHKERRQ(ierr);
2737ea844a1aSMatthew Knepley   if (numRoots < 0) PetscFunctionReturn(0);
2738ea844a1aSMatthew Knepley   ierr = PetscLogEventBegin(PETSCSF_SectSF,sf,0,0,0);CHKERRQ(ierr);
2739ea844a1aSMatthew Knepley   for (i = 0; i < numPoints; ++i) {
2740ea844a1aSMatthew Knepley     PetscInt localPoint = localPoints ? localPoints[i] : i;
2741ea844a1aSMatthew Knepley     PetscInt dof;
2742ea844a1aSMatthew Knepley 
2743ea844a1aSMatthew Knepley     if ((localPoint >= lpStart) && (localPoint < lpEnd)) {
2744ea844a1aSMatthew Knepley       ierr = PetscSectionGetDof(leafSection, localPoint, &dof);CHKERRQ(ierr);
2745ea844a1aSMatthew Knepley       numIndices += dof;
2746ea844a1aSMatthew Knepley     }
2747ea844a1aSMatthew Knepley   }
2748ea844a1aSMatthew Knepley   ierr = PetscMalloc1(numIndices, &localIndices);CHKERRQ(ierr);
2749ea844a1aSMatthew Knepley   ierr = PetscMalloc1(numIndices, &remoteIndices);CHKERRQ(ierr);
2750ea844a1aSMatthew Knepley   /* Create new index graph */
2751ea844a1aSMatthew Knepley   for (i = 0, ind = 0; i < numPoints; ++i) {
2752ea844a1aSMatthew Knepley     PetscInt localPoint = localPoints ? localPoints[i] : i;
2753ea844a1aSMatthew Knepley     PetscInt rank       = remotePoints[i].rank;
2754ea844a1aSMatthew Knepley 
2755ea844a1aSMatthew Knepley     if ((localPoint >= lpStart) && (localPoint < lpEnd)) {
2756ea844a1aSMatthew Knepley       PetscInt remoteOffset = remoteOffsets[localPoint-lpStart];
2757ea844a1aSMatthew Knepley       PetscInt loff, dof, d;
2758ea844a1aSMatthew Knepley 
2759ea844a1aSMatthew Knepley       ierr = PetscSectionGetOffset(leafSection, localPoint, &loff);CHKERRQ(ierr);
2760ea844a1aSMatthew Knepley       ierr = PetscSectionGetDof(leafSection, localPoint, &dof);CHKERRQ(ierr);
2761ea844a1aSMatthew Knepley       for (d = 0; d < dof; ++d, ++ind) {
2762ea844a1aSMatthew Knepley         localIndices[ind]        = loff+d;
2763ea844a1aSMatthew Knepley         remoteIndices[ind].rank  = rank;
2764ea844a1aSMatthew Knepley         remoteIndices[ind].index = remoteOffset+d;
2765ea844a1aSMatthew Knepley       }
2766ea844a1aSMatthew Knepley     }
2767ea844a1aSMatthew Knepley   }
2768ea844a1aSMatthew Knepley   if (numIndices != ind) SETERRQ2(comm, PETSC_ERR_PLIB, "Inconsistency in indices, %D should be %D", ind, numIndices);
2769ea844a1aSMatthew Knepley   ierr = PetscSFSetGraph(*sectionSF, numSectionRoots, numIndices, localIndices, PETSC_OWN_POINTER, remoteIndices, PETSC_OWN_POINTER);CHKERRQ(ierr);
2770ea844a1aSMatthew Knepley   ierr = PetscSFSetUp(*sectionSF);CHKERRQ(ierr);
2771ea844a1aSMatthew Knepley   ierr = PetscLogEventEnd(PETSCSF_SectSF,sf,0,0,0);CHKERRQ(ierr);
2772ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2773ea844a1aSMatthew Knepley }
2774ea844a1aSMatthew Knepley 
2775ea844a1aSMatthew Knepley /*@
2776ea844a1aSMatthew Knepley   PetscSectionSetClosureIndex - Set a cache of points in the closure of each point in the section
2777ea844a1aSMatthew Knepley 
2778ea844a1aSMatthew Knepley   Collective on section
2779ea844a1aSMatthew Knepley 
2780ea844a1aSMatthew Knepley   Input Parameters:
2781ea844a1aSMatthew Knepley + section   - The PetscSection
2782ea844a1aSMatthew Knepley . obj       - A PetscObject which serves as the key for this index
2783ea844a1aSMatthew Knepley . clSection - Section giving the size of the closure of each point
2784ea844a1aSMatthew Knepley - clPoints  - IS giving the points in each closure
2785ea844a1aSMatthew Knepley 
2786ea844a1aSMatthew Knepley   Note: We compress out closure points with no dofs in this section
2787ea844a1aSMatthew Knepley 
2788ea844a1aSMatthew Knepley   Level: advanced
2789ea844a1aSMatthew Knepley 
2790ea844a1aSMatthew Knepley .seealso: PetscSectionGetClosureIndex(), DMPlexCreateClosureIndex()
2791ea844a1aSMatthew Knepley @*/
2792ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetClosureIndex(PetscSection section, PetscObject obj, PetscSection clSection, IS clPoints)
2793ea844a1aSMatthew Knepley {
2794ea844a1aSMatthew Knepley   PetscErrorCode ierr;
2795ea844a1aSMatthew Knepley 
2796ea844a1aSMatthew Knepley   PetscFunctionBegin;
27973e03ebd8SStefano Zampini   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,1);
27983e03ebd8SStefano Zampini   PetscValidHeaderSpecific(clSection,PETSC_SECTION_CLASSID,3);
27993e03ebd8SStefano Zampini   PetscValidHeaderSpecific(clPoints,IS_CLASSID,4);
2800*c459fbc1SJed Brown   if (section->clObj != obj) {ierr = PetscSectionResetClosurePermutation(section);CHKERRQ(ierr);}
2801ea844a1aSMatthew Knepley   section->clObj     = obj;
28023e03ebd8SStefano Zampini   ierr = PetscObjectReference((PetscObject)clSection);CHKERRQ(ierr);
28033e03ebd8SStefano Zampini   ierr = PetscObjectReference((PetscObject)clPoints);CHKERRQ(ierr);
2804ea844a1aSMatthew Knepley   ierr = PetscSectionDestroy(&section->clSection);CHKERRQ(ierr);
2805ea844a1aSMatthew Knepley   ierr = ISDestroy(&section->clPoints);CHKERRQ(ierr);
2806ea844a1aSMatthew Knepley   section->clSection = clSection;
2807ea844a1aSMatthew Knepley   section->clPoints  = clPoints;
2808ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2809ea844a1aSMatthew Knepley }
2810ea844a1aSMatthew Knepley 
2811ea844a1aSMatthew Knepley /*@
2812ea844a1aSMatthew Knepley   PetscSectionGetClosureIndex - Get the cache of points in the closure of each point in the section
2813ea844a1aSMatthew Knepley 
2814ea844a1aSMatthew Knepley   Collective on section
2815ea844a1aSMatthew Knepley 
2816ea844a1aSMatthew Knepley   Input Parameters:
2817ea844a1aSMatthew Knepley + section   - The PetscSection
2818ea844a1aSMatthew Knepley - obj       - A PetscObject which serves as the key for this index
2819ea844a1aSMatthew Knepley 
2820ea844a1aSMatthew Knepley   Output Parameters:
2821ea844a1aSMatthew Knepley + clSection - Section giving the size of the closure of each point
2822ea844a1aSMatthew Knepley - clPoints  - IS giving the points in each closure
2823ea844a1aSMatthew Knepley 
2824ea844a1aSMatthew Knepley   Note: We compress out closure points with no dofs in this section
2825ea844a1aSMatthew Knepley 
2826ea844a1aSMatthew Knepley   Level: advanced
2827ea844a1aSMatthew Knepley 
2828ea844a1aSMatthew Knepley .seealso: PetscSectionSetClosureIndex(), DMPlexCreateClosureIndex()
2829ea844a1aSMatthew Knepley @*/
2830ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetClosureIndex(PetscSection section, PetscObject obj, PetscSection *clSection, IS *clPoints)
2831ea844a1aSMatthew Knepley {
2832ea844a1aSMatthew Knepley   PetscFunctionBegin;
2833ea844a1aSMatthew Knepley   if (section->clObj == obj) {
2834ea844a1aSMatthew Knepley     if (clSection) *clSection = section->clSection;
2835ea844a1aSMatthew Knepley     if (clPoints)  *clPoints  = section->clPoints;
2836ea844a1aSMatthew Knepley   } else {
2837ea844a1aSMatthew Knepley     if (clSection) *clSection = NULL;
2838ea844a1aSMatthew Knepley     if (clPoints)  *clPoints  = NULL;
2839ea844a1aSMatthew Knepley   }
2840ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2841ea844a1aSMatthew Knepley }
2842ea844a1aSMatthew Knepley 
2843*c459fbc1SJed Brown PetscErrorCode PetscSectionSetClosurePermutation_Internal(PetscSection section, PetscObject obj, PetscInt depth, PetscInt clSize, PetscCopyMode mode, PetscInt *clPerm)
2844ea844a1aSMatthew Knepley {
2845ea844a1aSMatthew Knepley   PetscInt       i;
2846*c459fbc1SJed Brown   khiter_t iter;
2847*c459fbc1SJed Brown   int new_entry;
2848*c459fbc1SJed Brown   PetscSectionClosurePermKey key = {depth, clSize};
2849*c459fbc1SJed Brown   PetscSectionClosurePermVal *val;
2850ea844a1aSMatthew Knepley   PetscErrorCode ierr;
2851ea844a1aSMatthew Knepley 
2852ea844a1aSMatthew Knepley   PetscFunctionBegin;
2853ea844a1aSMatthew Knepley   if (section->clObj != obj) {
2854ea844a1aSMatthew Knepley     ierr = PetscSectionDestroy(&section->clSection);CHKERRQ(ierr);
2855ea844a1aSMatthew Knepley     ierr = ISDestroy(&section->clPoints);CHKERRQ(ierr);
2856ea844a1aSMatthew Knepley   }
2857ea844a1aSMatthew Knepley   section->clObj = obj;
2858*c459fbc1SJed Brown   if (!section->clHash) {ierr = PetscClPermCreate(&section->clHash);CHKERRQ(ierr);}
2859*c459fbc1SJed Brown   iter = kh_put(ClPerm, section->clHash, key, &new_entry);
2860*c459fbc1SJed Brown   val = &kh_val(section->clHash, iter);
2861*c459fbc1SJed Brown   if (!new_entry) {
2862*c459fbc1SJed Brown     ierr = PetscFree(val->perm);CHKERRQ(ierr);
2863*c459fbc1SJed Brown     ierr = PetscFree(val->invPerm);CHKERRQ(ierr);
2864*c459fbc1SJed Brown   }
2865ea844a1aSMatthew Knepley   if (mode == PETSC_COPY_VALUES) {
2866*c459fbc1SJed Brown     ierr = PetscMalloc1(clSize, &val->perm);CHKERRQ(ierr);
2867ea844a1aSMatthew Knepley     ierr = PetscLogObjectMemory((PetscObject) obj, clSize*sizeof(PetscInt));CHKERRQ(ierr);
2868*c459fbc1SJed Brown     ierr = PetscArraycpy(val->perm, clPerm, clSize);CHKERRQ(ierr);
2869ea844a1aSMatthew Knepley   } else if (mode == PETSC_OWN_POINTER) {
2870*c459fbc1SJed Brown     val->perm = clPerm;
2871ea844a1aSMatthew Knepley   } else SETERRQ(PetscObjectComm(obj), PETSC_ERR_SUP, "Do not support borrowed arrays");
2872*c459fbc1SJed Brown   ierr = PetscMalloc1(clSize, &val->invPerm);CHKERRQ(ierr);
2873*c459fbc1SJed Brown   for (i = 0; i < clSize; ++i) val->invPerm[clPerm[i]] = i;
2874ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2875ea844a1aSMatthew Knepley }
2876ea844a1aSMatthew Knepley 
2877ea844a1aSMatthew Knepley /*@
2878*c459fbc1SJed Brown   PetscSectionSetClosurePermutation - Set the dof permutation for the closure of each cell in the section, meaning clPerm[newIndex] = oldIndex.
2879ea844a1aSMatthew Knepley 
2880ea844a1aSMatthew Knepley   Not Collective
2881ea844a1aSMatthew Knepley 
2882ea844a1aSMatthew Knepley   Input Parameters:
2883ea844a1aSMatthew Knepley + section - The PetscSection
2884*c459fbc1SJed Brown . obj     - A PetscObject which serves as the key for this index (usually a DM)
2885*c459fbc1SJed Brown . depth   - Depth of points on which to apply the given permutation
2886ea844a1aSMatthew Knepley - perm    - Permutation of the cell dof closure
2887ea844a1aSMatthew Knepley 
2888*c459fbc1SJed Brown   Note:
2889*c459fbc1SJed Brown   The specified permutation will only be applied to points at depth whose closure size matches the length of perm.  In a
2890*c459fbc1SJed Brown   mixed-topology or variable-degree finite element space, this function can be called multiple times at each depth for
2891*c459fbc1SJed Brown   each topology and degree.
2892*c459fbc1SJed Brown 
2893*c459fbc1SJed Brown   This approach assumes that (depth, len(perm)) uniquely identifies the desired permutation; this might not be true for
2894*c459fbc1SJed Brown   exotic/enriched spaces on mixed topology meshes.
2895ea844a1aSMatthew Knepley 
2896ea844a1aSMatthew Knepley   Level: intermediate
2897ea844a1aSMatthew Knepley 
2898ea844a1aSMatthew Knepley .seealso: PetscSectionGetClosurePermutation(), PetscSectionGetClosureIndex(), DMPlexCreateClosureIndex(), PetscCopyMode
2899ea844a1aSMatthew Knepley @*/
2900*c459fbc1SJed Brown PetscErrorCode PetscSectionSetClosurePermutation(PetscSection section, PetscObject obj, PetscInt depth, IS perm)
2901ea844a1aSMatthew Knepley {
2902ea844a1aSMatthew Knepley   const PetscInt *clPerm = NULL;
2903ea844a1aSMatthew Knepley   PetscInt        clSize = 0;
2904ea844a1aSMatthew Knepley   PetscErrorCode  ierr;
2905ea844a1aSMatthew Knepley 
2906ea844a1aSMatthew Knepley   PetscFunctionBegin;
2907ea844a1aSMatthew Knepley   if (perm) {
2908ea844a1aSMatthew Knepley     ierr = ISGetLocalSize(perm, &clSize);CHKERRQ(ierr);
2909ea844a1aSMatthew Knepley     ierr = ISGetIndices(perm, &clPerm);CHKERRQ(ierr);
2910ea844a1aSMatthew Knepley   }
2911*c459fbc1SJed Brown   ierr = PetscSectionSetClosurePermutation_Internal(section, obj, depth, clSize, PETSC_COPY_VALUES, (PetscInt *) clPerm);CHKERRQ(ierr);
2912ea844a1aSMatthew Knepley   if (perm) {ierr = ISRestoreIndices(perm, &clPerm);CHKERRQ(ierr);}
2913ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2914ea844a1aSMatthew Knepley }
2915ea844a1aSMatthew Knepley 
2916*c459fbc1SJed Brown PetscErrorCode PetscSectionGetClosurePermutation_Internal(PetscSection section, PetscObject obj, PetscInt depth, PetscInt size, const PetscInt *perm[])
2917ea844a1aSMatthew Knepley {
2918*c459fbc1SJed Brown   PetscErrorCode ierr;
2919*c459fbc1SJed Brown 
2920ea844a1aSMatthew Knepley   PetscFunctionBegin;
2921ea844a1aSMatthew Knepley   if (section->clObj == obj) {
2922*c459fbc1SJed Brown     PetscSectionClosurePermKey k = {depth, size};
2923*c459fbc1SJed Brown     PetscSectionClosurePermVal v;
2924*c459fbc1SJed Brown     ierr = PetscClPermGet(section->clHash, k, &v);CHKERRQ(ierr);
2925*c459fbc1SJed Brown     if (perm) *perm = v.perm;
2926ea844a1aSMatthew Knepley   } else {
2927ea844a1aSMatthew Knepley     if (perm) *perm = NULL;
2928ea844a1aSMatthew Knepley   }
2929ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2930ea844a1aSMatthew Knepley }
2931ea844a1aSMatthew Knepley 
2932ea844a1aSMatthew Knepley /*@
2933ea844a1aSMatthew Knepley   PetscSectionGetClosurePermutation - Get the dof permutation for the closure of each cell in the section, meaning clPerm[newIndex] = oldIndex.
2934ea844a1aSMatthew Knepley 
2935ea844a1aSMatthew Knepley   Not collective
2936ea844a1aSMatthew Knepley 
2937ea844a1aSMatthew Knepley   Input Parameters:
2938ea844a1aSMatthew Knepley + section   - The PetscSection
2939*c459fbc1SJed Brown . obj       - A PetscObject which serves as the key for this index (usually a DM)
2940*c459fbc1SJed Brown . depth     - Depth stratum on which to obtain closure permutation
2941*c459fbc1SJed Brown - clSize    - Closure size to be permuted (e.g., may vary with element topology and degree)
2942ea844a1aSMatthew Knepley 
2943ea844a1aSMatthew Knepley   Output Parameter:
2944ea844a1aSMatthew Knepley . perm - The dof closure permutation
2945ea844a1aSMatthew Knepley 
2946*c459fbc1SJed Brown   Note:
2947ea844a1aSMatthew Knepley   The user must destroy the IS that is returned.
2948ea844a1aSMatthew Knepley 
2949ea844a1aSMatthew Knepley   Level: intermediate
2950ea844a1aSMatthew Knepley 
2951ea844a1aSMatthew Knepley .seealso: PetscSectionSetClosurePermutation(), PetscSectionGetClosureInversePermutation(), PetscSectionGetClosureIndex(), PetscSectionSetClosureIndex(), DMPlexCreateClosureIndex()
2952ea844a1aSMatthew Knepley @*/
2953*c459fbc1SJed Brown PetscErrorCode PetscSectionGetClosurePermutation(PetscSection section, PetscObject obj, PetscInt depth, PetscInt clSize, IS *perm)
2954ea844a1aSMatthew Knepley {
2955ea844a1aSMatthew Knepley   const PetscInt *clPerm;
2956ea844a1aSMatthew Knepley   PetscErrorCode  ierr;
2957ea844a1aSMatthew Knepley 
2958ea844a1aSMatthew Knepley   PetscFunctionBegin;
2959*c459fbc1SJed Brown   ierr = PetscSectionGetClosurePermutation_Internal(section, obj, depth, clSize, &clPerm);CHKERRQ(ierr);
2960ea844a1aSMatthew Knepley   ierr = ISCreateGeneral(PETSC_COMM_SELF, clSize, clPerm, PETSC_USE_POINTER, perm);CHKERRQ(ierr);
2961ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2962ea844a1aSMatthew Knepley }
2963ea844a1aSMatthew Knepley 
2964*c459fbc1SJed Brown PetscErrorCode PetscSectionGetClosureInversePermutation_Internal(PetscSection section, PetscObject obj, PetscInt depth, PetscInt size, const PetscInt *perm[])
2965ea844a1aSMatthew Knepley {
2966*c459fbc1SJed Brown   PetscErrorCode ierr;
2967*c459fbc1SJed Brown 
2968ea844a1aSMatthew Knepley   PetscFunctionBegin;
2969*c459fbc1SJed Brown   if (section->clObj == obj && section->clHash) {
2970*c459fbc1SJed Brown     PetscSectionClosurePermKey k = {depth, size};
2971*c459fbc1SJed Brown     PetscSectionClosurePermVal v;
2972*c459fbc1SJed Brown     ierr = PetscClPermGet(section->clHash, k, &v);CHKERRQ(ierr);
2973*c459fbc1SJed Brown     if (perm) *perm = v.invPerm;
2974ea844a1aSMatthew Knepley   } else {
2975ea844a1aSMatthew Knepley     if (perm) *perm = NULL;
2976ea844a1aSMatthew Knepley   }
2977ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
2978ea844a1aSMatthew Knepley }
2979ea844a1aSMatthew Knepley 
2980ea844a1aSMatthew Knepley /*@
2981ea844a1aSMatthew Knepley   PetscSectionGetClosureInversePermutation - Get the inverse dof permutation for the closure of each cell in the section, meaning clPerm[oldIndex] = newIndex.
2982ea844a1aSMatthew Knepley 
2983ea844a1aSMatthew Knepley   Not collective
2984ea844a1aSMatthew Knepley 
2985ea844a1aSMatthew Knepley   Input Parameters:
2986ea844a1aSMatthew Knepley + section   - The PetscSection
2987*c459fbc1SJed Brown . obj       - A PetscObject which serves as the key for this index (usually a DM)
2988*c459fbc1SJed Brown . depth     - Depth stratum on which to obtain closure permutation
2989*c459fbc1SJed Brown - clSize    - Closure size to be permuted (e.g., may vary with element topology and degree)
2990ea844a1aSMatthew Knepley 
2991ea844a1aSMatthew Knepley   Output Parameters:
2992*c459fbc1SJed Brown . perm - The dof closure permutation
2993ea844a1aSMatthew Knepley 
2994*c459fbc1SJed Brown   Note:
2995ea844a1aSMatthew Knepley   The user must destroy the IS that is returned.
2996ea844a1aSMatthew Knepley 
2997ea844a1aSMatthew Knepley   Level: intermediate
2998ea844a1aSMatthew Knepley 
2999ea844a1aSMatthew Knepley .seealso: PetscSectionSetClosurePermutation(), PetscSectionGetClosureIndex(), PetscSectionSetClosureIndex(), DMPlexCreateClosureIndex()
3000ea844a1aSMatthew Knepley @*/
3001*c459fbc1SJed Brown PetscErrorCode PetscSectionGetClosureInversePermutation(PetscSection section, PetscObject obj, PetscInt depth, PetscInt clSize, IS *perm)
3002ea844a1aSMatthew Knepley {
3003ea844a1aSMatthew Knepley   const PetscInt *clPerm;
3004ea844a1aSMatthew Knepley   PetscErrorCode  ierr;
3005ea844a1aSMatthew Knepley 
3006ea844a1aSMatthew Knepley   PetscFunctionBegin;
3007*c459fbc1SJed Brown   ierr = PetscSectionGetClosureInversePermutation_Internal(section, obj, depth, clSize, &clPerm);CHKERRQ(ierr);
3008ea844a1aSMatthew Knepley   ierr = ISCreateGeneral(PETSC_COMM_SELF, clSize, clPerm, PETSC_USE_POINTER, perm);CHKERRQ(ierr);
3009ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3010ea844a1aSMatthew Knepley }
3011ea844a1aSMatthew Knepley 
3012ea844a1aSMatthew Knepley /*@
3013ea844a1aSMatthew Knepley   PetscSectionGetField - Get the subsection associated with a single field
3014ea844a1aSMatthew Knepley 
3015ea844a1aSMatthew Knepley   Input Parameters:
3016ea844a1aSMatthew Knepley + s     - The PetscSection
3017ea844a1aSMatthew Knepley - field - The field number
3018ea844a1aSMatthew Knepley 
3019ea844a1aSMatthew Knepley   Output Parameter:
3020ea844a1aSMatthew Knepley . subs  - The subsection for the given field
3021ea844a1aSMatthew Knepley 
3022ea844a1aSMatthew Knepley   Level: intermediate
3023ea844a1aSMatthew Knepley 
3024ea844a1aSMatthew Knepley .seealso: PetscSectionSetNumFields()
3025ea844a1aSMatthew Knepley @*/
3026ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetField(PetscSection s, PetscInt field, PetscSection *subs)
3027ea844a1aSMatthew Knepley {
3028ea844a1aSMatthew Knepley   PetscFunctionBegin;
3029ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s,PETSC_SECTION_CLASSID,1);
3030ea844a1aSMatthew Knepley   PetscValidPointer(subs,3);
3031ea844a1aSMatthew Knepley   if ((field < 0) || (field >= s->numFields)) SETERRQ3(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Section field %D should be in [%D, %D)", field, 0, s->numFields);
3032ea844a1aSMatthew Knepley   *subs = s->field[field];
3033ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3034ea844a1aSMatthew Knepley }
3035ea844a1aSMatthew Knepley 
3036ea844a1aSMatthew Knepley PetscClassId      PETSC_SECTION_SYM_CLASSID;
3037ea844a1aSMatthew Knepley PetscFunctionList PetscSectionSymList = NULL;
3038ea844a1aSMatthew Knepley 
3039ea844a1aSMatthew Knepley /*@
3040ea844a1aSMatthew Knepley   PetscSectionSymCreate - Creates an empty PetscSectionSym object.
3041ea844a1aSMatthew Knepley 
3042ea844a1aSMatthew Knepley   Collective
3043ea844a1aSMatthew Knepley 
3044ea844a1aSMatthew Knepley   Input Parameter:
3045ea844a1aSMatthew Knepley . comm - the MPI communicator
3046ea844a1aSMatthew Knepley 
3047ea844a1aSMatthew Knepley   Output Parameter:
3048ea844a1aSMatthew Knepley . sym - pointer to the new set of symmetries
3049ea844a1aSMatthew Knepley 
3050ea844a1aSMatthew Knepley   Level: developer
3051ea844a1aSMatthew Knepley 
3052ea844a1aSMatthew Knepley .seealso: PetscSectionSym, PetscSectionSymDestroy()
3053ea844a1aSMatthew Knepley @*/
3054ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSymCreate(MPI_Comm comm, PetscSectionSym *sym)
3055ea844a1aSMatthew Knepley {
3056ea844a1aSMatthew Knepley   PetscErrorCode ierr;
3057ea844a1aSMatthew Knepley 
3058ea844a1aSMatthew Knepley   PetscFunctionBegin;
3059ea844a1aSMatthew Knepley   PetscValidPointer(sym,2);
3060ea844a1aSMatthew Knepley   ierr = ISInitializePackage();CHKERRQ(ierr);
3061ea844a1aSMatthew Knepley   ierr = PetscHeaderCreate(*sym,PETSC_SECTION_SYM_CLASSID,"PetscSectionSym","Section Symmetry","IS",comm,PetscSectionSymDestroy,PetscSectionSymView);CHKERRQ(ierr);
3062ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3063ea844a1aSMatthew Knepley }
3064ea844a1aSMatthew Knepley 
3065ea844a1aSMatthew Knepley /*@C
3066ea844a1aSMatthew Knepley   PetscSectionSymSetType - Builds a PetscSection symmetry, for a particular implementation.
3067ea844a1aSMatthew Knepley 
3068ea844a1aSMatthew Knepley   Collective on PetscSectionSym
3069ea844a1aSMatthew Knepley 
3070ea844a1aSMatthew Knepley   Input Parameters:
3071ea844a1aSMatthew Knepley + sym    - The section symmetry object
3072ea844a1aSMatthew Knepley - method - The name of the section symmetry type
3073ea844a1aSMatthew Knepley 
3074ea844a1aSMatthew Knepley   Level: developer
3075ea844a1aSMatthew Knepley 
3076ea844a1aSMatthew Knepley .seealso: PetscSectionSymGetType(), PetscSectionSymCreate()
3077ea844a1aSMatthew Knepley @*/
3078ea844a1aSMatthew Knepley PetscErrorCode  PetscSectionSymSetType(PetscSectionSym sym, PetscSectionSymType method)
3079ea844a1aSMatthew Knepley {
3080ea844a1aSMatthew Knepley   PetscErrorCode (*r)(PetscSectionSym);
3081ea844a1aSMatthew Knepley   PetscBool      match;
3082ea844a1aSMatthew Knepley   PetscErrorCode ierr;
3083ea844a1aSMatthew Knepley 
3084ea844a1aSMatthew Knepley   PetscFunctionBegin;
3085ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID,1);
3086ea844a1aSMatthew Knepley   ierr = PetscObjectTypeCompare((PetscObject) sym, method, &match);CHKERRQ(ierr);
3087ea844a1aSMatthew Knepley   if (match) PetscFunctionReturn(0);
3088ea844a1aSMatthew Knepley 
3089ea844a1aSMatthew Knepley   ierr = PetscFunctionListFind(PetscSectionSymList,method,&r);CHKERRQ(ierr);
3090ea844a1aSMatthew Knepley   if (!r) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown PetscSectionSym type: %s", method);
3091ea844a1aSMatthew Knepley   if (sym->ops->destroy) {
3092ea844a1aSMatthew Knepley     ierr = (*sym->ops->destroy)(sym);CHKERRQ(ierr);
3093ea844a1aSMatthew Knepley     sym->ops->destroy = NULL;
3094ea844a1aSMatthew Knepley   }
3095ea844a1aSMatthew Knepley   ierr = (*r)(sym);CHKERRQ(ierr);
3096ea844a1aSMatthew Knepley   ierr = PetscObjectChangeTypeName((PetscObject)sym,method);CHKERRQ(ierr);
3097ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3098ea844a1aSMatthew Knepley }
3099ea844a1aSMatthew Knepley 
3100ea844a1aSMatthew Knepley 
3101ea844a1aSMatthew Knepley /*@C
3102ea844a1aSMatthew Knepley   PetscSectionSymGetType - Gets the section symmetry type name (as a string) from the PetscSectionSym.
3103ea844a1aSMatthew Knepley 
3104ea844a1aSMatthew Knepley   Not Collective
3105ea844a1aSMatthew Knepley 
3106ea844a1aSMatthew Knepley   Input Parameter:
3107ea844a1aSMatthew Knepley . sym  - The section symmetry
3108ea844a1aSMatthew Knepley 
3109ea844a1aSMatthew Knepley   Output Parameter:
3110ea844a1aSMatthew Knepley . type - The index set type name
3111ea844a1aSMatthew Knepley 
3112ea844a1aSMatthew Knepley   Level: developer
3113ea844a1aSMatthew Knepley 
3114ea844a1aSMatthew Knepley .seealso: PetscSectionSymSetType(), PetscSectionSymCreate()
3115ea844a1aSMatthew Knepley @*/
3116ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSymGetType(PetscSectionSym sym, PetscSectionSymType *type)
3117ea844a1aSMatthew Knepley {
3118ea844a1aSMatthew Knepley   PetscFunctionBegin;
3119ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID,1);
3120ea844a1aSMatthew Knepley   PetscValidCharPointer(type,2);
3121ea844a1aSMatthew Knepley   *type = ((PetscObject)sym)->type_name;
3122ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3123ea844a1aSMatthew Knepley }
3124ea844a1aSMatthew Knepley 
3125ea844a1aSMatthew Knepley /*@C
3126ea844a1aSMatthew Knepley   PetscSectionSymRegister - Adds a new section symmetry implementation
3127ea844a1aSMatthew Knepley 
3128ea844a1aSMatthew Knepley   Not Collective
3129ea844a1aSMatthew Knepley 
3130ea844a1aSMatthew Knepley   Input Parameters:
3131ea844a1aSMatthew Knepley + name        - The name of a new user-defined creation routine
3132ea844a1aSMatthew Knepley - create_func - The creation routine itself
3133ea844a1aSMatthew Knepley 
3134ea844a1aSMatthew Knepley   Notes:
3135ea844a1aSMatthew Knepley   PetscSectionSymRegister() may be called multiple times to add several user-defined vectors
3136ea844a1aSMatthew Knepley 
3137ea844a1aSMatthew Knepley   Level: developer
3138ea844a1aSMatthew Knepley 
3139ea844a1aSMatthew Knepley .seealso: PetscSectionSymCreate(), PetscSectionSymSetType()
3140ea844a1aSMatthew Knepley @*/
3141ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSymRegister(const char sname[], PetscErrorCode (*function)(PetscSectionSym))
3142ea844a1aSMatthew Knepley {
3143ea844a1aSMatthew Knepley   PetscErrorCode ierr;
3144ea844a1aSMatthew Knepley 
3145ea844a1aSMatthew Knepley   PetscFunctionBegin;
3146ea844a1aSMatthew Knepley   ierr = ISInitializePackage();CHKERRQ(ierr);
3147ea844a1aSMatthew Knepley   ierr = PetscFunctionListAdd(&PetscSectionSymList,sname,function);CHKERRQ(ierr);
3148ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3149ea844a1aSMatthew Knepley }
3150ea844a1aSMatthew Knepley 
3151ea844a1aSMatthew Knepley /*@
3152ea844a1aSMatthew Knepley    PetscSectionSymDestroy - Destroys a section symmetry.
3153ea844a1aSMatthew Knepley 
3154ea844a1aSMatthew Knepley    Collective on PetscSectionSym
3155ea844a1aSMatthew Knepley 
3156ea844a1aSMatthew Knepley    Input Parameters:
3157ea844a1aSMatthew Knepley .  sym - the section symmetry
3158ea844a1aSMatthew Knepley 
3159ea844a1aSMatthew Knepley    Level: developer
3160ea844a1aSMatthew Knepley 
3161ea844a1aSMatthew Knepley .seealso: PetscSectionSymCreate(), PetscSectionSymDestroy()
3162ea844a1aSMatthew Knepley @*/
3163ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSymDestroy(PetscSectionSym *sym)
3164ea844a1aSMatthew Knepley {
3165ea844a1aSMatthew Knepley   SymWorkLink    link,next;
3166ea844a1aSMatthew Knepley   PetscErrorCode ierr;
3167ea844a1aSMatthew Knepley 
3168ea844a1aSMatthew Knepley   PetscFunctionBegin;
3169ea844a1aSMatthew Knepley   if (!*sym) PetscFunctionReturn(0);
3170ea844a1aSMatthew Knepley   PetscValidHeaderSpecific((*sym),PETSC_SECTION_SYM_CLASSID,1);
3171ea844a1aSMatthew Knepley   if (--((PetscObject)(*sym))->refct > 0) {*sym = 0; PetscFunctionReturn(0);}
3172ea844a1aSMatthew Knepley   if ((*sym)->ops->destroy) {
3173ea844a1aSMatthew Knepley     ierr = (*(*sym)->ops->destroy)(*sym);CHKERRQ(ierr);
3174ea844a1aSMatthew Knepley   }
3175ea844a1aSMatthew Knepley   if ((*sym)->workout) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Work array still checked out");
3176ea844a1aSMatthew Knepley   for (link=(*sym)->workin; link; link=next) {
3177ea844a1aSMatthew Knepley     next = link->next;
3178ea844a1aSMatthew Knepley     ierr = PetscFree2(*(PetscInt***)&link->perms,*(PetscScalar***)&link->rots);CHKERRQ(ierr);
3179ea844a1aSMatthew Knepley     ierr = PetscFree(link);CHKERRQ(ierr);
3180ea844a1aSMatthew Knepley   }
3181ea844a1aSMatthew Knepley   (*sym)->workin = NULL;
3182ea844a1aSMatthew Knepley   ierr = PetscHeaderDestroy(sym);CHKERRQ(ierr);
3183ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3184ea844a1aSMatthew Knepley }
3185ea844a1aSMatthew Knepley 
3186ea844a1aSMatthew Knepley /*@C
3187ea844a1aSMatthew Knepley    PetscSectionSymView - Displays a section symmetry
3188ea844a1aSMatthew Knepley 
3189ea844a1aSMatthew Knepley    Collective on PetscSectionSym
3190ea844a1aSMatthew Knepley 
3191ea844a1aSMatthew Knepley    Input Parameters:
3192ea844a1aSMatthew Knepley +  sym - the index set
3193ea844a1aSMatthew Knepley -  viewer - viewer used to display the set, for example PETSC_VIEWER_STDOUT_SELF.
3194ea844a1aSMatthew Knepley 
3195ea844a1aSMatthew Knepley    Level: developer
3196ea844a1aSMatthew Knepley 
3197ea844a1aSMatthew Knepley .seealso: PetscViewerASCIIOpen()
3198ea844a1aSMatthew Knepley @*/
3199ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSymView(PetscSectionSym sym,PetscViewer viewer)
3200ea844a1aSMatthew Knepley {
3201ea844a1aSMatthew Knepley   PetscErrorCode ierr;
3202ea844a1aSMatthew Knepley 
3203ea844a1aSMatthew Knepley   PetscFunctionBegin;
3204ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(sym,PETSC_SECTION_SYM_CLASSID,1);
3205ea844a1aSMatthew Knepley   if (!viewer) {
3206ea844a1aSMatthew Knepley     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)sym),&viewer);CHKERRQ(ierr);
3207ea844a1aSMatthew Knepley   }
3208ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
3209ea844a1aSMatthew Knepley   PetscCheckSameComm(sym,1,viewer,2);
3210ea844a1aSMatthew Knepley   ierr = PetscObjectPrintClassNamePrefixType((PetscObject)sym,viewer);CHKERRQ(ierr);
3211ea844a1aSMatthew Knepley   if (sym->ops->view) {
3212ea844a1aSMatthew Knepley     ierr = (*sym->ops->view)(sym,viewer);CHKERRQ(ierr);
3213ea844a1aSMatthew Knepley   }
3214ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3215ea844a1aSMatthew Knepley }
3216ea844a1aSMatthew Knepley 
3217ea844a1aSMatthew Knepley /*@
3218ea844a1aSMatthew Knepley   PetscSectionSetSym - Set the symmetries for the data referred to by the section
3219ea844a1aSMatthew Knepley 
3220ea844a1aSMatthew Knepley   Collective on PetscSection
3221ea844a1aSMatthew Knepley 
3222ea844a1aSMatthew Knepley   Input Parameters:
3223ea844a1aSMatthew Knepley + section - the section describing data layout
3224ea844a1aSMatthew Knepley - sym - the symmetry describing the affect of orientation on the access of the data
3225ea844a1aSMatthew Knepley 
3226ea844a1aSMatthew Knepley   Level: developer
3227ea844a1aSMatthew Knepley 
3228ea844a1aSMatthew Knepley .seealso: PetscSectionGetSym(), PetscSectionSymCreate()
3229ea844a1aSMatthew Knepley @*/
3230ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetSym(PetscSection section, PetscSectionSym sym)
3231ea844a1aSMatthew Knepley {
3232ea844a1aSMatthew Knepley   PetscErrorCode ierr;
3233ea844a1aSMatthew Knepley 
3234ea844a1aSMatthew Knepley   PetscFunctionBegin;
3235ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,1);
3236ea844a1aSMatthew Knepley   ierr = PetscSectionSymDestroy(&(section->sym));CHKERRQ(ierr);
3237ea844a1aSMatthew Knepley   if (sym) {
3238ea844a1aSMatthew Knepley     PetscValidHeaderSpecific(sym,PETSC_SECTION_SYM_CLASSID,2);
3239ea844a1aSMatthew Knepley     PetscCheckSameComm(section,1,sym,2);
3240ea844a1aSMatthew Knepley     ierr = PetscObjectReference((PetscObject) sym);CHKERRQ(ierr);
3241ea844a1aSMatthew Knepley   }
3242ea844a1aSMatthew Knepley   section->sym = sym;
3243ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3244ea844a1aSMatthew Knepley }
3245ea844a1aSMatthew Knepley 
3246ea844a1aSMatthew Knepley /*@
3247ea844a1aSMatthew Knepley   PetscSectionGetSym - Get the symmetries for the data referred to by the section
3248ea844a1aSMatthew Knepley 
3249ea844a1aSMatthew Knepley   Not collective
3250ea844a1aSMatthew Knepley 
3251ea844a1aSMatthew Knepley   Input Parameters:
3252ea844a1aSMatthew Knepley . section - the section describing data layout
3253ea844a1aSMatthew Knepley 
3254ea844a1aSMatthew Knepley   Output Parameters:
3255ea844a1aSMatthew Knepley . sym - the symmetry describing the affect of orientation on the access of the data
3256ea844a1aSMatthew Knepley 
3257ea844a1aSMatthew Knepley   Level: developer
3258ea844a1aSMatthew Knepley 
3259ea844a1aSMatthew Knepley .seealso: PetscSectionSetSym(), PetscSectionSymCreate()
3260ea844a1aSMatthew Knepley @*/
3261ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetSym(PetscSection section, PetscSectionSym *sym)
3262ea844a1aSMatthew Knepley {
3263ea844a1aSMatthew Knepley   PetscFunctionBegin;
3264ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,1);
3265ea844a1aSMatthew Knepley   *sym = section->sym;
3266ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3267ea844a1aSMatthew Knepley }
3268ea844a1aSMatthew Knepley 
3269ea844a1aSMatthew Knepley /*@
3270ea844a1aSMatthew Knepley   PetscSectionSetFieldSym - Set the symmetries for the data referred to by a field of the section
3271ea844a1aSMatthew Knepley 
3272ea844a1aSMatthew Knepley   Collective on PetscSection
3273ea844a1aSMatthew Knepley 
3274ea844a1aSMatthew Knepley   Input Parameters:
3275ea844a1aSMatthew Knepley + section - the section describing data layout
3276ea844a1aSMatthew Knepley . field - the field number
3277ea844a1aSMatthew Knepley - sym - the symmetry describing the affect of orientation on the access of the data
3278ea844a1aSMatthew Knepley 
3279ea844a1aSMatthew Knepley   Level: developer
3280ea844a1aSMatthew Knepley 
3281ea844a1aSMatthew Knepley .seealso: PetscSectionGetFieldSym(), PetscSectionSymCreate()
3282ea844a1aSMatthew Knepley @*/
3283ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetFieldSym(PetscSection section, PetscInt field, PetscSectionSym sym)
3284ea844a1aSMatthew Knepley {
3285ea844a1aSMatthew Knepley   PetscErrorCode ierr;
3286ea844a1aSMatthew Knepley 
3287ea844a1aSMatthew Knepley   PetscFunctionBegin;
3288ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,1);
3289ea844a1aSMatthew Knepley   if (field < 0 || field >= section->numFields) SETERRQ2(PetscObjectComm((PetscObject)section),PETSC_ERR_ARG_OUTOFRANGE,"Invalid field number %D (not in [0,%D)", field, section->numFields);
3290ea844a1aSMatthew Knepley   ierr = PetscSectionSetSym(section->field[field],sym);CHKERRQ(ierr);
3291ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3292ea844a1aSMatthew Knepley }
3293ea844a1aSMatthew Knepley 
3294ea844a1aSMatthew Knepley /*@
3295ea844a1aSMatthew Knepley   PetscSectionGetFieldSym - Get the symmetries for the data referred to by a field of the section
3296ea844a1aSMatthew Knepley 
3297ea844a1aSMatthew Knepley   Collective on PetscSection
3298ea844a1aSMatthew Knepley 
3299ea844a1aSMatthew Knepley   Input Parameters:
3300ea844a1aSMatthew Knepley + section - the section describing data layout
3301ea844a1aSMatthew Knepley - field - the field number
3302ea844a1aSMatthew Knepley 
3303ea844a1aSMatthew Knepley   Output Parameters:
3304ea844a1aSMatthew Knepley . sym - the symmetry describing the affect of orientation on the access of the data
3305ea844a1aSMatthew Knepley 
3306ea844a1aSMatthew Knepley   Level: developer
3307ea844a1aSMatthew Knepley 
3308ea844a1aSMatthew Knepley .seealso: PetscSectionSetFieldSym(), PetscSectionSymCreate()
3309ea844a1aSMatthew Knepley @*/
3310ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetFieldSym(PetscSection section, PetscInt field, PetscSectionSym *sym)
3311ea844a1aSMatthew Knepley {
3312ea844a1aSMatthew Knepley   PetscFunctionBegin;
3313ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,1);
3314ea844a1aSMatthew Knepley   if (field < 0 || field >= section->numFields) SETERRQ2(PetscObjectComm((PetscObject)section),PETSC_ERR_ARG_OUTOFRANGE,"Invalid field number %D (not in [0,%D)", field, section->numFields);
3315ea844a1aSMatthew Knepley   *sym = section->field[field]->sym;
3316ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3317ea844a1aSMatthew Knepley }
3318ea844a1aSMatthew Knepley 
3319ea844a1aSMatthew Knepley /*@C
3320ea844a1aSMatthew Knepley   PetscSectionGetPointSyms - Get the symmetries for a set of points in a PetscSection under specific orientations.
3321ea844a1aSMatthew Knepley 
3322ea844a1aSMatthew Knepley   Not collective
3323ea844a1aSMatthew Knepley 
3324ea844a1aSMatthew Knepley   Input Parameters:
3325ea844a1aSMatthew Knepley + section - the section
3326ea844a1aSMatthew Knepley . numPoints - the number of points
3327ea844a1aSMatthew Knepley - points - an array of size 2 * numPoints, containing a list of (point, orientation) pairs. (An orientation is an
3328ea844a1aSMatthew Knepley     arbitrary integer: its interpretation is up to sym.  Orientations are used by DM: for their interpretation in that
3329ea844a1aSMatthew Knepley     context, see DMPlexGetConeOrientation()).
3330ea844a1aSMatthew Knepley 
3331ea844a1aSMatthew Knepley   Output Parameter:
3332ea844a1aSMatthew Knepley + perms - The permutations for the given orientations (or NULL if there is no symmetry or the permutation is the identity).
3333ea844a1aSMatthew Knepley - rots - The field rotations symmetries for the given orientations (or NULL if there is no symmetry or the rotations are all
3334ea844a1aSMatthew Knepley     identity).
3335ea844a1aSMatthew Knepley 
3336ea844a1aSMatthew Knepley   Example of usage, gathering dofs into a local array (lArray) from a section array (sArray):
3337ea844a1aSMatthew Knepley .vb
3338ea844a1aSMatthew Knepley      const PetscInt    **perms;
3339ea844a1aSMatthew Knepley      const PetscScalar **rots;
3340ea844a1aSMatthew Knepley      PetscInt            lOffset;
3341ea844a1aSMatthew Knepley 
3342ea844a1aSMatthew Knepley      PetscSectionGetPointSyms(section,numPoints,points,&perms,&rots);
3343ea844a1aSMatthew Knepley      for (i = 0, lOffset = 0; i < numPoints; i++) {
3344ea844a1aSMatthew Knepley        PetscInt           point = points[2*i], dof, sOffset;
3345ea844a1aSMatthew Knepley        const PetscInt    *perm  = perms ? perms[i] : NULL;
3346ea844a1aSMatthew Knepley        const PetscScalar *rot   = rots  ? rots[i]  : NULL;
3347ea844a1aSMatthew Knepley 
3348ea844a1aSMatthew Knepley        PetscSectionGetDof(section,point,&dof);
3349ea844a1aSMatthew Knepley        PetscSectionGetOffset(section,point,&sOffset);
3350ea844a1aSMatthew Knepley 
3351ea844a1aSMatthew Knepley        if (perm) {for (j = 0; j < dof; j++) {lArray[lOffset + perm[j]]  = sArray[sOffset + j];}}
3352ea844a1aSMatthew Knepley        else      {for (j = 0; j < dof; j++) {lArray[lOffset +      j ]  = sArray[sOffset + j];}}
3353ea844a1aSMatthew Knepley        if (rot)  {for (j = 0; j < dof; j++) {lArray[lOffset +      j ] *= rot[j];             }}
3354ea844a1aSMatthew Knepley        lOffset += dof;
3355ea844a1aSMatthew Knepley      }
3356ea844a1aSMatthew Knepley      PetscSectionRestorePointSyms(section,numPoints,points,&perms,&rots);
3357ea844a1aSMatthew Knepley .ve
3358ea844a1aSMatthew Knepley 
3359ea844a1aSMatthew Knepley   Example of usage, adding dofs into a section array (sArray) from a local array (lArray):
3360ea844a1aSMatthew Knepley .vb
3361ea844a1aSMatthew Knepley      const PetscInt    **perms;
3362ea844a1aSMatthew Knepley      const PetscScalar **rots;
3363ea844a1aSMatthew Knepley      PetscInt            lOffset;
3364ea844a1aSMatthew Knepley 
3365ea844a1aSMatthew Knepley      PetscSectionGetPointSyms(section,numPoints,points,&perms,&rots);
3366ea844a1aSMatthew Knepley      for (i = 0, lOffset = 0; i < numPoints; i++) {
3367ea844a1aSMatthew Knepley        PetscInt           point = points[2*i], dof, sOffset;
3368ea844a1aSMatthew Knepley        const PetscInt    *perm  = perms ? perms[i] : NULL;
3369ea844a1aSMatthew Knepley        const PetscScalar *rot   = rots  ? rots[i]  : NULL;
3370ea844a1aSMatthew Knepley 
3371ea844a1aSMatthew Knepley        PetscSectionGetDof(section,point,&dof);
3372ea844a1aSMatthew Knepley        PetscSectionGetOffset(section,point,&sOff);
3373ea844a1aSMatthew Knepley 
3374ea844a1aSMatthew Knepley        if (perm) {for (j = 0; j < dof; j++) {sArray[sOffset + j] += lArray[lOffset + perm[j]] * (rot ? PetscConj(rot[perm[j]]) : 1.);}}
3375ea844a1aSMatthew Knepley        else      {for (j = 0; j < dof; j++) {sArray[sOffset + j] += lArray[lOffset +      j ] * (rot ? PetscConj(rot[     j ]) : 1.);}}
3376ea844a1aSMatthew Knepley        offset += dof;
3377ea844a1aSMatthew Knepley      }
3378ea844a1aSMatthew Knepley      PetscSectionRestorePointSyms(section,numPoints,points,&perms,&rots);
3379ea844a1aSMatthew Knepley .ve
3380ea844a1aSMatthew Knepley 
3381ea844a1aSMatthew Knepley   Level: developer
3382ea844a1aSMatthew Knepley 
3383ea844a1aSMatthew Knepley .seealso: PetscSectionRestorePointSyms(), PetscSectionSymCreate(), PetscSectionSetSym(), PetscSectionGetSym()
3384ea844a1aSMatthew Knepley @*/
3385ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetPointSyms(PetscSection section, PetscInt numPoints, const PetscInt *points, const PetscInt ***perms, const PetscScalar ***rots)
3386ea844a1aSMatthew Knepley {
3387ea844a1aSMatthew Knepley   PetscSectionSym sym;
3388ea844a1aSMatthew Knepley   PetscErrorCode  ierr;
3389ea844a1aSMatthew Knepley 
3390ea844a1aSMatthew Knepley   PetscFunctionBegin;
3391ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,1);
3392ea844a1aSMatthew Knepley   if (numPoints) PetscValidIntPointer(points,3);
3393ea844a1aSMatthew Knepley   if (perms) *perms = NULL;
3394ea844a1aSMatthew Knepley   if (rots)  *rots  = NULL;
3395ea844a1aSMatthew Knepley   sym = section->sym;
3396ea844a1aSMatthew Knepley   if (sym && (perms || rots)) {
3397ea844a1aSMatthew Knepley     SymWorkLink link;
3398ea844a1aSMatthew Knepley 
3399ea844a1aSMatthew Knepley     if (sym->workin) {
3400ea844a1aSMatthew Knepley       link        = sym->workin;
3401ea844a1aSMatthew Knepley       sym->workin = sym->workin->next;
3402ea844a1aSMatthew Knepley     } else {
3403ea844a1aSMatthew Knepley       ierr = PetscNewLog(sym,&link);CHKERRQ(ierr);
3404ea844a1aSMatthew Knepley     }
3405ea844a1aSMatthew Knepley     if (numPoints > link->numPoints) {
3406ea844a1aSMatthew Knepley       ierr = PetscFree2(*(PetscInt***)&link->perms,*(PetscInt***)&link->rots);CHKERRQ(ierr);
3407ea844a1aSMatthew Knepley       ierr = PetscMalloc2(numPoints,(PetscInt***)&link->perms,numPoints,(PetscScalar***)&link->rots);CHKERRQ(ierr);
3408ea844a1aSMatthew Knepley       link->numPoints = numPoints;
3409ea844a1aSMatthew Knepley     }
3410ea844a1aSMatthew Knepley     link->next   = sym->workout;
3411ea844a1aSMatthew Knepley     sym->workout = link;
3412ea844a1aSMatthew Knepley     ierr = PetscArrayzero((PetscInt**)link->perms,numPoints);CHKERRQ(ierr);
3413ea844a1aSMatthew Knepley     ierr = PetscArrayzero((PetscInt**)link->rots,numPoints);CHKERRQ(ierr);
3414ea844a1aSMatthew Knepley     ierr = (*sym->ops->getpoints) (sym, section, numPoints, points, link->perms, link->rots);CHKERRQ(ierr);
3415ea844a1aSMatthew Knepley     if (perms) *perms = link->perms;
3416ea844a1aSMatthew Knepley     if (rots)  *rots  = link->rots;
3417ea844a1aSMatthew Knepley   }
3418ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3419ea844a1aSMatthew Knepley }
3420ea844a1aSMatthew Knepley 
3421ea844a1aSMatthew Knepley /*@C
3422ea844a1aSMatthew Knepley   PetscSectionRestorePointSyms - Restore the symmetries returned by PetscSectionGetPointSyms()
3423ea844a1aSMatthew Knepley 
3424ea844a1aSMatthew Knepley   Not collective
3425ea844a1aSMatthew Knepley 
3426ea844a1aSMatthew Knepley   Input Parameters:
3427ea844a1aSMatthew Knepley + section - the section
3428ea844a1aSMatthew Knepley . numPoints - the number of points
3429ea844a1aSMatthew Knepley - points - an array of size 2 * numPoints, containing a list of (point, orientation) pairs. (An orientation is an
3430ea844a1aSMatthew Knepley     arbitrary integer: its interpretation is up to sym.  Orientations are used by DM: for their interpretation in that
3431ea844a1aSMatthew Knepley     context, see DMPlexGetConeOrientation()).
3432ea844a1aSMatthew Knepley 
3433ea844a1aSMatthew Knepley   Output Parameter:
3434ea844a1aSMatthew Knepley + perms - The permutations for the given orientations: set to NULL at conclusion
3435ea844a1aSMatthew Knepley - rots - The field rotations symmetries for the given orientations: set to NULL at conclusion
3436ea844a1aSMatthew Knepley 
3437ea844a1aSMatthew Knepley   Level: developer
3438ea844a1aSMatthew Knepley 
3439ea844a1aSMatthew Knepley .seealso: PetscSectionGetPointSyms(), PetscSectionSymCreate(), PetscSectionSetSym(), PetscSectionGetSym()
3440ea844a1aSMatthew Knepley @*/
3441ea844a1aSMatthew Knepley PetscErrorCode PetscSectionRestorePointSyms(PetscSection section, PetscInt numPoints, const PetscInt *points, const PetscInt ***perms, const PetscScalar ***rots)
3442ea844a1aSMatthew Knepley {
3443ea844a1aSMatthew Knepley   PetscSectionSym sym;
3444ea844a1aSMatthew Knepley 
3445ea844a1aSMatthew Knepley   PetscFunctionBegin;
3446ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,1);
3447ea844a1aSMatthew Knepley   sym = section->sym;
3448ea844a1aSMatthew Knepley   if (sym && (perms || rots)) {
3449ea844a1aSMatthew Knepley     SymWorkLink *p,link;
3450ea844a1aSMatthew Knepley 
3451ea844a1aSMatthew Knepley     for (p=&sym->workout; (link=*p); p=&link->next) {
3452ea844a1aSMatthew Knepley       if ((perms && link->perms == *perms) || (rots && link->rots == *rots)) {
3453ea844a1aSMatthew Knepley         *p          = link->next;
3454ea844a1aSMatthew Knepley         link->next  = sym->workin;
3455ea844a1aSMatthew Knepley         sym->workin = link;
3456ea844a1aSMatthew Knepley         if (perms) *perms = NULL;
3457ea844a1aSMatthew Knepley         if (rots)  *rots  = NULL;
3458ea844a1aSMatthew Knepley         PetscFunctionReturn(0);
3459ea844a1aSMatthew Knepley       }
3460ea844a1aSMatthew Knepley     }
3461ea844a1aSMatthew Knepley     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Array was not checked out");
3462ea844a1aSMatthew Knepley   }
3463ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3464ea844a1aSMatthew Knepley }
3465ea844a1aSMatthew Knepley 
3466ea844a1aSMatthew Knepley /*@C
3467ea844a1aSMatthew Knepley   PetscSectionGetFieldPointSyms - Get the symmetries for a set of points in a field of a PetscSection under specific orientations.
3468ea844a1aSMatthew Knepley 
3469ea844a1aSMatthew Knepley   Not collective
3470ea844a1aSMatthew Knepley 
3471ea844a1aSMatthew Knepley   Input Parameters:
3472ea844a1aSMatthew Knepley + section - the section
3473ea844a1aSMatthew Knepley . field - the field of the section
3474ea844a1aSMatthew Knepley . numPoints - the number of points
3475ea844a1aSMatthew Knepley - points - an array of size 2 * numPoints, containing a list of (point, orientation) pairs. (An orientation is an
3476ea844a1aSMatthew Knepley     arbitrary integer: its interpretation is up to sym.  Orientations are used by DM: for their interpretation in that
3477ea844a1aSMatthew Knepley     context, see DMPlexGetConeOrientation()).
3478ea844a1aSMatthew Knepley 
3479ea844a1aSMatthew Knepley   Output Parameter:
3480ea844a1aSMatthew Knepley + perms - The permutations for the given orientations (or NULL if there is no symmetry or the permutation is the identity).
3481ea844a1aSMatthew Knepley - rots - The field rotations symmetries for the given orientations (or NULL if there is no symmetry or the rotations are all
3482ea844a1aSMatthew Knepley     identity).
3483ea844a1aSMatthew Knepley 
3484ea844a1aSMatthew Knepley   Level: developer
3485ea844a1aSMatthew Knepley 
3486ea844a1aSMatthew Knepley .seealso: PetscSectionGetPointSyms(), PetscSectionRestoreFieldPointSyms()
3487ea844a1aSMatthew Knepley @*/
3488ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetFieldPointSyms(PetscSection section, PetscInt field, PetscInt numPoints, const PetscInt *points, const PetscInt ***perms, const PetscScalar ***rots)
3489ea844a1aSMatthew Knepley {
3490ea844a1aSMatthew Knepley   PetscErrorCode ierr;
3491ea844a1aSMatthew Knepley 
3492ea844a1aSMatthew Knepley   PetscFunctionBegin;
3493ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,1);
3494ea844a1aSMatthew Knepley   if (field > section->numFields) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"field %D greater than number of fields (%D) in section",field,section->numFields);
3495ea844a1aSMatthew Knepley   ierr = PetscSectionGetPointSyms(section->field[field],numPoints,points,perms,rots);CHKERRQ(ierr);
3496ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3497ea844a1aSMatthew Knepley }
3498ea844a1aSMatthew Knepley 
3499ea844a1aSMatthew Knepley /*@C
3500ea844a1aSMatthew Knepley   PetscSectionRestoreFieldPointSyms - Restore the symmetries returned by PetscSectionGetFieldPointSyms()
3501ea844a1aSMatthew Knepley 
3502ea844a1aSMatthew Knepley   Not collective
3503ea844a1aSMatthew Knepley 
3504ea844a1aSMatthew Knepley   Input Parameters:
3505ea844a1aSMatthew Knepley + section - the section
3506ea844a1aSMatthew Knepley . field - the field number
3507ea844a1aSMatthew Knepley . numPoints - the number of points
3508ea844a1aSMatthew Knepley - points - an array of size 2 * numPoints, containing a list of (point, orientation) pairs. (An orientation is an
3509ea844a1aSMatthew Knepley     arbitrary integer: its interpretation is up to sym.  Orientations are used by DM: for their interpretation in that
3510ea844a1aSMatthew Knepley     context, see DMPlexGetConeOrientation()).
3511ea844a1aSMatthew Knepley 
3512ea844a1aSMatthew Knepley   Output Parameter:
3513ea844a1aSMatthew Knepley + perms - The permutations for the given orientations: set to NULL at conclusion
3514ea844a1aSMatthew Knepley - rots - The field rotations symmetries for the given orientations: set to NULL at conclusion
3515ea844a1aSMatthew Knepley 
3516ea844a1aSMatthew Knepley   Level: developer
3517ea844a1aSMatthew Knepley 
3518ea844a1aSMatthew Knepley .seealso: PetscSectionRestorePointSyms(), petscSectionGetFieldPointSyms(), PetscSectionSymCreate(), PetscSectionSetSym(), PetscSectionGetSym()
3519ea844a1aSMatthew Knepley @*/
3520ea844a1aSMatthew Knepley PetscErrorCode PetscSectionRestoreFieldPointSyms(PetscSection section, PetscInt field, PetscInt numPoints, const PetscInt *points, const PetscInt ***perms, const PetscScalar ***rots)
3521ea844a1aSMatthew Knepley {
3522ea844a1aSMatthew Knepley   PetscErrorCode ierr;
3523ea844a1aSMatthew Knepley 
3524ea844a1aSMatthew Knepley   PetscFunctionBegin;
3525ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,1);
3526ea844a1aSMatthew Knepley   if (field > section->numFields) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"field %D greater than number of fields (%D) in section",field,section->numFields);
3527ea844a1aSMatthew Knepley   ierr = PetscSectionRestorePointSyms(section->field[field],numPoints,points,perms,rots);CHKERRQ(ierr);
3528ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3529ea844a1aSMatthew Knepley }
3530ea844a1aSMatthew Knepley 
3531ea844a1aSMatthew Knepley /*@
3532ea844a1aSMatthew Knepley   PetscSectionGetUseFieldOffsets - Get the flag to use field offsets directly in a global section, rather than just the point offset
3533ea844a1aSMatthew Knepley 
3534ea844a1aSMatthew Knepley   Not collective
3535ea844a1aSMatthew Knepley 
3536ea844a1aSMatthew Knepley   Input Parameter:
3537ea844a1aSMatthew Knepley . s - the global PetscSection
3538ea844a1aSMatthew Knepley 
3539ea844a1aSMatthew Knepley   Output Parameters:
3540ea844a1aSMatthew Knepley . flg - the flag
3541ea844a1aSMatthew Knepley 
3542ea844a1aSMatthew Knepley   Level: developer
3543ea844a1aSMatthew Knepley 
3544ea844a1aSMatthew Knepley .seealso: PetscSectionSetChart(), PetscSectionCreate()
3545ea844a1aSMatthew Knepley @*/
3546ea844a1aSMatthew Knepley PetscErrorCode PetscSectionGetUseFieldOffsets(PetscSection s, PetscBool *flg)
3547ea844a1aSMatthew Knepley {
3548ea844a1aSMatthew Knepley   PetscFunctionBegin;
3549ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
3550ea844a1aSMatthew Knepley   *flg = s->useFieldOff;
3551ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3552ea844a1aSMatthew Knepley }
3553ea844a1aSMatthew Knepley 
3554ea844a1aSMatthew Knepley /*@
3555ea844a1aSMatthew Knepley   PetscSectionSetUseFieldOffsets - Set the flag to use field offsets directly in a global section, rather than just the point offset
3556ea844a1aSMatthew Knepley 
3557ea844a1aSMatthew Knepley   Not collective
3558ea844a1aSMatthew Knepley 
3559ea844a1aSMatthew Knepley   Input Parameters:
3560ea844a1aSMatthew Knepley + s   - the global PetscSection
3561ea844a1aSMatthew Knepley - flg - the flag
3562ea844a1aSMatthew Knepley 
3563ea844a1aSMatthew Knepley   Level: developer
3564ea844a1aSMatthew Knepley 
3565ea844a1aSMatthew Knepley .seealso: PetscSectionGetUseFieldOffsets(), PetscSectionSetChart(), PetscSectionCreate()
3566ea844a1aSMatthew Knepley @*/
3567ea844a1aSMatthew Knepley PetscErrorCode PetscSectionSetUseFieldOffsets(PetscSection s, PetscBool flg)
3568ea844a1aSMatthew Knepley {
3569ea844a1aSMatthew Knepley   PetscFunctionBegin;
3570ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
3571ea844a1aSMatthew Knepley   s->useFieldOff = flg;
3572ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3573ea844a1aSMatthew Knepley }
3574ea844a1aSMatthew Knepley 
3575ea844a1aSMatthew Knepley #define PetscSectionExpandPoints_Loop(TYPE) \
3576ea844a1aSMatthew Knepley { \
3577ea844a1aSMatthew Knepley   PetscInt i, n, o0, o1, size; \
3578ea844a1aSMatthew Knepley   TYPE *a0 = (TYPE*)origArray, *a1; \
3579ea844a1aSMatthew Knepley   ierr = PetscSectionGetStorageSize(s, &size);CHKERRQ(ierr); \
3580ea844a1aSMatthew Knepley   ierr = PetscMalloc1(size, &a1);CHKERRQ(ierr); \
3581ea844a1aSMatthew Knepley   for (i=0; i<npoints; i++) { \
3582ea844a1aSMatthew Knepley     ierr = PetscSectionGetOffset(origSection, points_[i], &o0);CHKERRQ(ierr); \
3583ea844a1aSMatthew Knepley     ierr = PetscSectionGetOffset(s, i, &o1);CHKERRQ(ierr); \
3584ea844a1aSMatthew Knepley     ierr = PetscSectionGetDof(s, i, &n);CHKERRQ(ierr); \
3585ea844a1aSMatthew Knepley     ierr = PetscMemcpy(&a1[o1], &a0[o0], n*unitsize);CHKERRQ(ierr); \
3586ea844a1aSMatthew Knepley   } \
3587ea844a1aSMatthew Knepley   *newArray = (void*)a1; \
3588ea844a1aSMatthew Knepley }
3589ea844a1aSMatthew Knepley 
3590ea844a1aSMatthew Knepley /*@
3591ea844a1aSMatthew Knepley   PetscSectionExtractDofsFromArray - Extracts elements of an array corresponding to DOFs of specified points.
3592ea844a1aSMatthew Knepley 
3593ea844a1aSMatthew Knepley   Not collective
3594ea844a1aSMatthew Knepley 
3595ea844a1aSMatthew Knepley   Input Parameters:
3596ea844a1aSMatthew Knepley + origSection - the PetscSection describing the layout of the array
3597ea844a1aSMatthew Knepley . dataType - MPI_Datatype describing the data type of the array (currently only MPIU_INT, MPIU_SCALAR, MPIU_REAL)
3598ea844a1aSMatthew Knepley . origArray - the array; its size must be equal to the storage size of origSection
3599ea844a1aSMatthew Knepley - points - IS with points to extract; its indices must lie in the chart of origSection
3600ea844a1aSMatthew Knepley 
3601ea844a1aSMatthew Knepley   Output Parameters:
3602ea844a1aSMatthew Knepley + newSection - the new PetscSection desribing the layout of the new array (with points renumbered 0,1,... but preserving numbers of DOFs)
3603ea844a1aSMatthew Knepley - newArray - the array of the extracted DOFs; its size is the storage size of newSection
3604ea844a1aSMatthew Knepley 
3605ea844a1aSMatthew Knepley   Level: developer
3606ea844a1aSMatthew Knepley 
3607ea844a1aSMatthew Knepley .seealso: PetscSectionGetChart(), PetscSectionGetDof(), PetscSectionGetStorageSize(), PetscSectionCreate()
3608ea844a1aSMatthew Knepley @*/
3609ea844a1aSMatthew Knepley PetscErrorCode PetscSectionExtractDofsFromArray(PetscSection origSection, MPI_Datatype dataType, const void *origArray, IS points, PetscSection *newSection, void *newArray[])
3610ea844a1aSMatthew Knepley {
3611ea844a1aSMatthew Knepley   PetscSection        s;
3612ea844a1aSMatthew Knepley   const PetscInt      *points_;
3613ea844a1aSMatthew Knepley   PetscInt            i, n, npoints, pStart, pEnd;
3614ea844a1aSMatthew Knepley   PetscMPIInt         unitsize;
3615ea844a1aSMatthew Knepley   PetscErrorCode      ierr;
3616ea844a1aSMatthew Knepley 
3617ea844a1aSMatthew Knepley   PetscFunctionBegin;
3618ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(origSection, PETSC_SECTION_CLASSID, 1);
3619ea844a1aSMatthew Knepley   PetscValidPointer(origArray, 3);
3620ea844a1aSMatthew Knepley   PetscValidHeaderSpecific(points, IS_CLASSID, 4);
3621ea844a1aSMatthew Knepley   if (newSection) PetscValidPointer(newSection, 5);
3622ea844a1aSMatthew Knepley   if (newArray) PetscValidPointer(newArray, 6);
3623ea844a1aSMatthew Knepley   ierr = MPI_Type_size(dataType, &unitsize);CHKERRQ(ierr);
3624ea844a1aSMatthew Knepley   ierr = ISGetLocalSize(points, &npoints);CHKERRQ(ierr);
3625ea844a1aSMatthew Knepley   ierr = ISGetIndices(points, &points_);CHKERRQ(ierr);
3626ea844a1aSMatthew Knepley   ierr = PetscSectionGetChart(origSection, &pStart, &pEnd);CHKERRQ(ierr);
3627ea844a1aSMatthew Knepley   ierr = PetscSectionCreate(PETSC_COMM_SELF, &s);CHKERRQ(ierr);
3628ea844a1aSMatthew Knepley   ierr = PetscSectionSetChart(s, 0, npoints);CHKERRQ(ierr);
3629ea844a1aSMatthew Knepley   for (i=0; i<npoints; i++) {
3630ea844a1aSMatthew Knepley     if (PetscUnlikely(points_[i] < pStart || points_[i] >= pEnd)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "point %d (index %d) in input IS out of input section's chart", points_[i], i);
3631ea844a1aSMatthew Knepley     ierr = PetscSectionGetDof(origSection, points_[i], &n);CHKERRQ(ierr);
3632ea844a1aSMatthew Knepley     ierr = PetscSectionSetDof(s, i, n);CHKERRQ(ierr);
3633ea844a1aSMatthew Knepley   }
3634ea844a1aSMatthew Knepley   ierr = PetscSectionSetUp(s);CHKERRQ(ierr);
3635ea844a1aSMatthew Knepley   if (newArray) {
3636ea844a1aSMatthew Knepley     if (dataType == MPIU_INT)           {PetscSectionExpandPoints_Loop(PetscInt);}
3637ea844a1aSMatthew Knepley     else if (dataType == MPIU_SCALAR)   {PetscSectionExpandPoints_Loop(PetscScalar);}
3638ea844a1aSMatthew Knepley     else if (dataType == MPIU_REAL)     {PetscSectionExpandPoints_Loop(PetscReal);}
3639ea844a1aSMatthew Knepley     else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP, "not implemented for this MPI_Datatype");
3640ea844a1aSMatthew Knepley   }
3641ea844a1aSMatthew Knepley   if (newSection) {
3642ea844a1aSMatthew Knepley     *newSection = s;
3643ea844a1aSMatthew Knepley   } else {
3644ea844a1aSMatthew Knepley     ierr = PetscSectionDestroy(&s);CHKERRQ(ierr);
3645ea844a1aSMatthew Knepley   }
3646ea844a1aSMatthew Knepley   PetscFunctionReturn(0);
3647ea844a1aSMatthew Knepley }
3648