xref: /petsc/src/dm/label/dmlabel.c (revision ffeef943c8ee50edff320d8a3135bb0c94853e4c)
15fdea053SToby Isaac #include <petscdm.h>
2c58f1c22SToby Isaac #include <petsc/private/dmlabelimpl.h> /*I      "petscdmlabel.h"   I*/
3ea844a1aSMatthew Knepley #include <petsc/private/sectionimpl.h> /*I      "petscsection.h"   I*/
4c58f1c22SToby Isaac #include <petscsf.h>
5ea844a1aSMatthew Knepley #include <petscsection.h>
6c58f1c22SToby Isaac 
79f6c5813SMatthew G. Knepley PetscFunctionList DMLabelList              = NULL;
89f6c5813SMatthew G. Knepley PetscBool         DMLabelRegisterAllCalled = PETSC_FALSE;
99f6c5813SMatthew G. Knepley 
10cc4c1da9SBarry Smith /*@
1120f4b53cSBarry Smith   DMLabelCreate - Create a `DMLabel` object, which is a multimap
12c58f1c22SToby Isaac 
135b5e7992SMatthew G. Knepley   Collective
145b5e7992SMatthew G. Knepley 
1560225df5SJacob Faibussowitsch   Input Parameters:
1620f4b53cSBarry Smith + comm - The communicator, usually `PETSC_COMM_SELF`
17d67d17b1SMatthew G. Knepley - name - The label name
18c58f1c22SToby Isaac 
1960225df5SJacob Faibussowitsch   Output Parameter:
2020f4b53cSBarry Smith . label - The `DMLabel`
21c58f1c22SToby Isaac 
22c58f1c22SToby Isaac   Level: beginner
23c58f1c22SToby Isaac 
2405ab7a9fSVaclav Hapla   Notes:
2520f4b53cSBarry Smith   The label name is actually usually the `PetscObject` name.
2620f4b53cSBarry Smith   One can get/set it with `PetscObjectGetName()`/`PetscObjectSetName()`.
2705ab7a9fSVaclav Hapla 
2820f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelDestroy()`
29c58f1c22SToby Isaac @*/
30d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelCreate(MPI_Comm comm, const char name[], DMLabel *label)
31d71ae5a4SJacob Faibussowitsch {
32c58f1c22SToby Isaac   PetscFunctionBegin;
334f572ea9SToby Isaac   PetscAssertPointer(label, 3);
349566063dSJacob Faibussowitsch   PetscCall(DMInitializePackage());
35c58f1c22SToby Isaac 
369566063dSJacob Faibussowitsch   PetscCall(PetscHeaderCreate(*label, DMLABEL_CLASSID, "DMLabel", "DMLabel", "DM", comm, DMLabelDestroy, DMLabelView));
37d67d17b1SMatthew G. Knepley 
38c58f1c22SToby Isaac   (*label)->numStrata     = 0;
395aa44df4SToby Isaac   (*label)->defaultValue  = -1;
40c58f1c22SToby Isaac   (*label)->stratumValues = NULL;
41ad8374ffSToby Isaac   (*label)->validIS       = NULL;
42c58f1c22SToby Isaac   (*label)->stratumSizes  = NULL;
43c58f1c22SToby Isaac   (*label)->points        = NULL;
44c58f1c22SToby Isaac   (*label)->ht            = NULL;
45c58f1c22SToby Isaac   (*label)->pStart        = -1;
46c58f1c22SToby Isaac   (*label)->pEnd          = -1;
47c58f1c22SToby Isaac   (*label)->bt            = NULL;
489566063dSJacob Faibussowitsch   PetscCall(PetscHMapICreate(&(*label)->hmap));
499566063dSJacob Faibussowitsch   PetscCall(PetscObjectSetName((PetscObject)*label, name));
509f6c5813SMatthew G. Knepley   PetscCall(DMLabelSetType(*label, DMLABELCONCRETE));
513ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
529f6c5813SMatthew G. Knepley }
539f6c5813SMatthew G. Knepley 
54cc4c1da9SBarry Smith /*@
559f6c5813SMatthew G. Knepley   DMLabelSetUp - SetUp a `DMLabel` object
569f6c5813SMatthew G. Knepley 
579f6c5813SMatthew G. Knepley   Collective
589f6c5813SMatthew G. Knepley 
5960225df5SJacob Faibussowitsch   Input Parameters:
609f6c5813SMatthew G. Knepley . label - The `DMLabel`
619f6c5813SMatthew G. Knepley 
629f6c5813SMatthew G. Knepley   Level: intermediate
639f6c5813SMatthew G. Knepley 
6420f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`, `DMLabelDestroy()`
659f6c5813SMatthew G. Knepley @*/
669f6c5813SMatthew G. Knepley PetscErrorCode DMLabelSetUp(DMLabel label)
679f6c5813SMatthew G. Knepley {
689f6c5813SMatthew G. Knepley   PetscFunctionBegin;
699f6c5813SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
709f6c5813SMatthew G. Knepley   PetscTryTypeMethod(label, setup);
713ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
72c58f1c22SToby Isaac }
73c58f1c22SToby Isaac 
74c58f1c22SToby Isaac /*
75c58f1c22SToby Isaac   DMLabelMakeValid_Private - Transfer stratum data from the hash format to the sorted list format
76c58f1c22SToby Isaac 
775b5e7992SMatthew G. Knepley   Not collective
785b5e7992SMatthew G. Knepley 
79c58f1c22SToby Isaac   Input parameter:
8020f4b53cSBarry Smith + label - The `DMLabel`
81c58f1c22SToby Isaac - v - The stratum value
82c58f1c22SToby Isaac 
83c58f1c22SToby Isaac   Output parameter:
8420f4b53cSBarry Smith . label - The `DMLabel` with stratum in sorted list format
85c58f1c22SToby Isaac 
86c58f1c22SToby Isaac   Level: developer
87c58f1c22SToby Isaac 
8820f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`
89c58f1c22SToby Isaac */
90d71ae5a4SJacob Faibussowitsch static PetscErrorCode DMLabelMakeValid_Private(DMLabel label, PetscInt v)
91d71ae5a4SJacob Faibussowitsch {
92277ea44aSLisandro Dalcin   IS       is;
93b9907514SLisandro Dalcin   PetscInt off = 0, *pointArray, p;
94c58f1c22SToby Isaac 
95c58f1c22SToby Isaac   PetscFunctionBegin;
964d86920dSPierre Jolivet   if ((PetscLikely(v >= 0 && v < label->numStrata) && label->validIS[v]) || label->readonly) PetscFunctionReturn(PETSC_SUCCESS);
971dca8a05SBarry Smith   PetscCheck(v >= 0 && v < label->numStrata, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Trying to access invalid stratum %" PetscInt_FMT " in DMLabelMakeValid_Private", v);
989566063dSJacob Faibussowitsch   PetscCall(PetscHSetIGetSize(label->ht[v], &label->stratumSizes[v]));
999566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(label->stratumSizes[v], &pointArray));
1009566063dSJacob Faibussowitsch   PetscCall(PetscHSetIGetElems(label->ht[v], &off, pointArray));
1019566063dSJacob Faibussowitsch   PetscCall(PetscHSetIClear(label->ht[v]));
1029566063dSJacob Faibussowitsch   PetscCall(PetscSortInt(label->stratumSizes[v], pointArray));
103c58f1c22SToby Isaac   if (label->bt) {
104c58f1c22SToby Isaac     for (p = 0; p < label->stratumSizes[v]; ++p) {
105ad8374ffSToby Isaac       const PetscInt point = pointArray[p];
10663a3b9bcSJacob Faibussowitsch       PetscCheck(!(point < label->pStart) && !(point >= label->pEnd), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label point %" PetscInt_FMT " is not in [%" PetscInt_FMT ", %" PetscInt_FMT ")", point, label->pStart, label->pEnd);
1079566063dSJacob Faibussowitsch       PetscCall(PetscBTSet(label->bt, point - label->pStart));
108c58f1c22SToby Isaac     }
109c58f1c22SToby Isaac   }
110ba2698f1SMatthew G. Knepley   if (label->stratumSizes[v] > 0 && pointArray[label->stratumSizes[v] - 1] == pointArray[0] + label->stratumSizes[v] - 1) {
1119566063dSJacob Faibussowitsch     PetscCall(ISCreateStride(PETSC_COMM_SELF, label->stratumSizes[v], pointArray[0], 1, &is));
1129566063dSJacob Faibussowitsch     PetscCall(PetscFree(pointArray));
113ba2698f1SMatthew G. Knepley   } else {
1149566063dSJacob Faibussowitsch     PetscCall(ISCreateGeneral(PETSC_COMM_SELF, label->stratumSizes[v], pointArray, PETSC_OWN_POINTER, &is));
115ba2698f1SMatthew G. Knepley   }
1169566063dSJacob Faibussowitsch   PetscCall(PetscObjectSetName((PetscObject)is, "indices"));
117277ea44aSLisandro Dalcin   label->points[v]  = is;
118ad8374ffSToby Isaac   label->validIS[v] = PETSC_TRUE;
1199566063dSJacob Faibussowitsch   PetscCall(PetscObjectStateIncrease((PetscObject)label));
1203ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
121c58f1c22SToby Isaac }
122c58f1c22SToby Isaac 
123c58f1c22SToby Isaac /*
124c58f1c22SToby Isaac   DMLabelMakeAllValid_Private - Transfer all strata from the hash format to the sorted list format
125c58f1c22SToby Isaac 
12620f4b53cSBarry Smith   Not Collective
1275b5e7992SMatthew G. Knepley 
128c58f1c22SToby Isaac   Input parameter:
12920f4b53cSBarry Smith . label - The `DMLabel`
130c58f1c22SToby Isaac 
131c58f1c22SToby Isaac   Output parameter:
13220f4b53cSBarry Smith . label - The `DMLabel` with all strata in sorted list format
133c58f1c22SToby Isaac 
134c58f1c22SToby Isaac   Level: developer
135c58f1c22SToby Isaac 
13620f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`
137c58f1c22SToby Isaac */
138d71ae5a4SJacob Faibussowitsch static PetscErrorCode DMLabelMakeAllValid_Private(DMLabel label)
139d71ae5a4SJacob Faibussowitsch {
140c58f1c22SToby Isaac   PetscInt v;
141c58f1c22SToby Isaac 
142c58f1c22SToby Isaac   PetscFunctionBegin;
14348a46eb9SPierre Jolivet   for (v = 0; v < label->numStrata; v++) PetscCall(DMLabelMakeValid_Private(label, v));
1443ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
145c58f1c22SToby Isaac }
146c58f1c22SToby Isaac 
147c58f1c22SToby Isaac /*
148c58f1c22SToby Isaac   DMLabelMakeInvalid_Private - Transfer stratum data from the sorted list format to the hash format
149c58f1c22SToby Isaac 
15020f4b53cSBarry Smith   Not Collective
1515b5e7992SMatthew G. Knepley 
152c58f1c22SToby Isaac   Input parameter:
15320f4b53cSBarry Smith + label - The `DMLabel`
154c58f1c22SToby Isaac - v - The stratum value
155c58f1c22SToby Isaac 
156c58f1c22SToby Isaac   Output parameter:
15720f4b53cSBarry Smith . label - The `DMLabel` with stratum in hash format
158c58f1c22SToby Isaac 
159c58f1c22SToby Isaac   Level: developer
160c58f1c22SToby Isaac 
16120f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`
162c58f1c22SToby Isaac */
163d71ae5a4SJacob Faibussowitsch static PetscErrorCode DMLabelMakeInvalid_Private(DMLabel label, PetscInt v)
164d71ae5a4SJacob Faibussowitsch {
165c58f1c22SToby Isaac   PetscInt        p;
166ad8374ffSToby Isaac   const PetscInt *points;
167c58f1c22SToby Isaac 
168c58f1c22SToby Isaac   PetscFunctionBegin;
1694d86920dSPierre Jolivet   if ((PetscLikely(v >= 0 && v < label->numStrata) && !label->validIS[v]) || label->readonly) PetscFunctionReturn(PETSC_SUCCESS);
1701dca8a05SBarry Smith   PetscCheck(v >= 0 && v < label->numStrata, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Trying to access invalid stratum %" PetscInt_FMT " in DMLabelMakeInvalid_Private", v);
171ad8374ffSToby Isaac   if (label->points[v]) {
1729566063dSJacob Faibussowitsch     PetscCall(ISGetIndices(label->points[v], &points));
17348a46eb9SPierre Jolivet     for (p = 0; p < label->stratumSizes[v]; ++p) PetscCall(PetscHSetIAdd(label->ht[v], points[p]));
1749566063dSJacob Faibussowitsch     PetscCall(ISRestoreIndices(label->points[v], &points));
175f4f49eeaSPierre Jolivet     PetscCall(ISDestroy(&label->points[v]));
176ad8374ffSToby Isaac   }
177ad8374ffSToby Isaac   label->validIS[v] = PETSC_FALSE;
1783ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
179c58f1c22SToby Isaac }
180c58f1c22SToby Isaac 
181d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelMakeAllInvalid_Internal(DMLabel label)
182d71ae5a4SJacob Faibussowitsch {
183695799ffSMatthew G. Knepley   PetscInt v;
184695799ffSMatthew G. Knepley 
185695799ffSMatthew G. Knepley   PetscFunctionBegin;
18648a46eb9SPierre Jolivet   for (v = 0; v < label->numStrata; v++) PetscCall(DMLabelMakeInvalid_Private(label, v));
1873ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
188695799ffSMatthew G. Knepley }
189695799ffSMatthew G. Knepley 
190b9907514SLisandro Dalcin #if !defined(DMLABEL_LOOKUP_THRESHOLD)
191b9907514SLisandro Dalcin   #define DMLABEL_LOOKUP_THRESHOLD 16
192b9907514SLisandro Dalcin #endif
193b9907514SLisandro Dalcin 
1949f6c5813SMatthew G. Knepley PetscErrorCode DMLabelLookupStratum(DMLabel label, PetscInt value, PetscInt *index)
195d71ae5a4SJacob Faibussowitsch {
1960c3c4a36SLisandro Dalcin   PetscInt v;
1970e79e033SBarry Smith 
1980c3c4a36SLisandro Dalcin   PetscFunctionBegin;
1990e79e033SBarry Smith   *index = -1;
2009f6c5813SMatthew G. Knepley   if (label->numStrata <= DMLABEL_LOOKUP_THRESHOLD || label->readonly) {
201b9907514SLisandro Dalcin     for (v = 0; v < label->numStrata; ++v)
2029371c9d4SSatish Balay       if (label->stratumValues[v] == value) {
2039371c9d4SSatish Balay         *index = v;
2049371c9d4SSatish Balay         break;
2059371c9d4SSatish Balay       }
206b9907514SLisandro Dalcin   } else {
2079566063dSJacob Faibussowitsch     PetscCall(PetscHMapIGet(label->hmap, value, index));
2080e79e033SBarry Smith   }
2099f6c5813SMatthew G. Knepley   if (PetscDefined(USE_DEBUG) && !label->readonly) { /* Check strata hash map consistency */
21090e9b2aeSLisandro Dalcin     PetscInt len, loc = -1;
2119566063dSJacob Faibussowitsch     PetscCall(PetscHMapIGetSize(label->hmap, &len));
21208401ef6SPierre Jolivet     PetscCheck(len == label->numStrata, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Inconsistent strata hash map size");
21390e9b2aeSLisandro Dalcin     if (label->numStrata <= DMLABEL_LOOKUP_THRESHOLD) {
2149566063dSJacob Faibussowitsch       PetscCall(PetscHMapIGet(label->hmap, value, &loc));
21590e9b2aeSLisandro Dalcin     } else {
21690e9b2aeSLisandro Dalcin       for (v = 0; v < label->numStrata; ++v)
2179371c9d4SSatish Balay         if (label->stratumValues[v] == value) {
2189371c9d4SSatish Balay           loc = v;
2199371c9d4SSatish Balay           break;
2209371c9d4SSatish Balay         }
22190e9b2aeSLisandro Dalcin     }
22208401ef6SPierre Jolivet     PetscCheck(loc == *index, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Inconsistent strata hash map lookup");
22390e9b2aeSLisandro Dalcin   }
2243ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2250c3c4a36SLisandro Dalcin }
2260c3c4a36SLisandro Dalcin 
227d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode DMLabelNewStratum(DMLabel label, PetscInt value, PetscInt *index)
228d71ae5a4SJacob Faibussowitsch {
229b9907514SLisandro Dalcin   PetscInt    v;
230b9907514SLisandro Dalcin   PetscInt   *tmpV;
231b9907514SLisandro Dalcin   PetscInt   *tmpS;
232b9907514SLisandro Dalcin   PetscHSetI *tmpH, ht;
233b9907514SLisandro Dalcin   IS         *tmpP, is;
234c58f1c22SToby Isaac   PetscBool  *tmpB;
235b9907514SLisandro Dalcin   PetscHMapI  hmap = label->hmap;
236c58f1c22SToby Isaac 
237c58f1c22SToby Isaac   PetscFunctionBegin;
238b9907514SLisandro Dalcin   v    = label->numStrata;
239b9907514SLisandro Dalcin   tmpV = label->stratumValues;
240b9907514SLisandro Dalcin   tmpS = label->stratumSizes;
241b9907514SLisandro Dalcin   tmpH = label->ht;
242b9907514SLisandro Dalcin   tmpP = label->points;
243b9907514SLisandro Dalcin   tmpB = label->validIS;
2448e1f8cf0SLisandro Dalcin   { /* TODO: PetscRealloc() is broken, use malloc+memcpy+free  */
2458e1f8cf0SLisandro Dalcin     PetscInt   *oldV = tmpV;
2468e1f8cf0SLisandro Dalcin     PetscInt   *oldS = tmpS;
2478e1f8cf0SLisandro Dalcin     PetscHSetI *oldH = tmpH;
2488e1f8cf0SLisandro Dalcin     IS         *oldP = tmpP;
2498e1f8cf0SLisandro Dalcin     PetscBool  *oldB = tmpB;
2509566063dSJacob Faibussowitsch     PetscCall(PetscMalloc((v + 1) * sizeof(*tmpV), &tmpV));
2519566063dSJacob Faibussowitsch     PetscCall(PetscMalloc((v + 1) * sizeof(*tmpS), &tmpS));
2529f6c5813SMatthew G. Knepley     PetscCall(PetscCalloc((v + 1) * sizeof(*tmpH), &tmpH));
2539f6c5813SMatthew G. Knepley     PetscCall(PetscCalloc((v + 1) * sizeof(*tmpP), &tmpP));
2549566063dSJacob Faibussowitsch     PetscCall(PetscMalloc((v + 1) * sizeof(*tmpB), &tmpB));
2559566063dSJacob Faibussowitsch     PetscCall(PetscArraycpy(tmpV, oldV, v));
2569566063dSJacob Faibussowitsch     PetscCall(PetscArraycpy(tmpS, oldS, v));
2579566063dSJacob Faibussowitsch     PetscCall(PetscArraycpy(tmpH, oldH, v));
2589566063dSJacob Faibussowitsch     PetscCall(PetscArraycpy(tmpP, oldP, v));
2599566063dSJacob Faibussowitsch     PetscCall(PetscArraycpy(tmpB, oldB, v));
2609566063dSJacob Faibussowitsch     PetscCall(PetscFree(oldV));
2619566063dSJacob Faibussowitsch     PetscCall(PetscFree(oldS));
2629566063dSJacob Faibussowitsch     PetscCall(PetscFree(oldH));
2639566063dSJacob Faibussowitsch     PetscCall(PetscFree(oldP));
2649566063dSJacob Faibussowitsch     PetscCall(PetscFree(oldB));
2658e1f8cf0SLisandro Dalcin   }
266b9907514SLisandro Dalcin   label->numStrata     = v + 1;
267c58f1c22SToby Isaac   label->stratumValues = tmpV;
268c58f1c22SToby Isaac   label->stratumSizes  = tmpS;
269c58f1c22SToby Isaac   label->ht            = tmpH;
270c58f1c22SToby Isaac   label->points        = tmpP;
271ad8374ffSToby Isaac   label->validIS       = tmpB;
2729566063dSJacob Faibussowitsch   PetscCall(PetscHSetICreate(&ht));
2739566063dSJacob Faibussowitsch   PetscCall(ISCreateStride(PETSC_COMM_SELF, 0, 0, 1, &is));
2749566063dSJacob Faibussowitsch   PetscCall(PetscHMapISet(hmap, value, v));
275b9907514SLisandro Dalcin   tmpV[v] = value;
276b9907514SLisandro Dalcin   tmpS[v] = 0;
277b9907514SLisandro Dalcin   tmpH[v] = ht;
278b9907514SLisandro Dalcin   tmpP[v] = is;
279b9907514SLisandro Dalcin   tmpB[v] = PETSC_TRUE;
2809566063dSJacob Faibussowitsch   PetscCall(PetscObjectStateIncrease((PetscObject)label));
2810c3c4a36SLisandro Dalcin   *index = v;
2823ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2830c3c4a36SLisandro Dalcin }
2840c3c4a36SLisandro Dalcin 
285d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode DMLabelLookupAddStratum(DMLabel label, PetscInt value, PetscInt *index)
286d71ae5a4SJacob Faibussowitsch {
287b9907514SLisandro Dalcin   PetscFunctionBegin;
2889566063dSJacob Faibussowitsch   PetscCall(DMLabelLookupStratum(label, value, index));
2899566063dSJacob Faibussowitsch   if (*index < 0) PetscCall(DMLabelNewStratum(label, value, index));
2903ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
291b9907514SLisandro Dalcin }
292b9907514SLisandro Dalcin 
2939f6c5813SMatthew G. Knepley PetscErrorCode DMLabelGetStratumSize_Private(DMLabel label, PetscInt v, PetscInt *size)
294d71ae5a4SJacob Faibussowitsch {
2959e63cc69SVaclav Hapla   PetscFunctionBegin;
2969e63cc69SVaclav Hapla   *size = 0;
2973ba16761SJacob Faibussowitsch   if (v < 0) PetscFunctionReturn(PETSC_SUCCESS);
2989f6c5813SMatthew G. Knepley   if (label->readonly || label->validIS[v]) {
2999e63cc69SVaclav Hapla     *size = label->stratumSizes[v];
3009e63cc69SVaclav Hapla   } else {
3019566063dSJacob Faibussowitsch     PetscCall(PetscHSetIGetSize(label->ht[v], size));
3029e63cc69SVaclav Hapla   }
3033ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3049e63cc69SVaclav Hapla }
3059e63cc69SVaclav Hapla 
306b9907514SLisandro Dalcin /*@
30720f4b53cSBarry Smith   DMLabelAddStratum - Adds a new stratum value in a `DMLabel`
308b9907514SLisandro Dalcin 
309d8d19677SJose E. Roman   Input Parameters:
31020f4b53cSBarry Smith + label - The `DMLabel`
311b9907514SLisandro Dalcin - value - The stratum value
312b9907514SLisandro Dalcin 
313b9907514SLisandro Dalcin   Level: beginner
314b9907514SLisandro Dalcin 
31520f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`, `DMLabelDestroy()`
316b9907514SLisandro Dalcin @*/
317d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelAddStratum(DMLabel label, PetscInt value)
318d71ae5a4SJacob Faibussowitsch {
3190c3c4a36SLisandro Dalcin   PetscInt v;
3200c3c4a36SLisandro Dalcin 
3210c3c4a36SLisandro Dalcin   PetscFunctionBegin;
322d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
3239f6c5813SMatthew G. Knepley   PetscCheck(!label->readonly, PetscObjectComm((PetscObject)label), PETSC_ERR_ARG_WRONG, "Read-only labels cannot be altered");
3249566063dSJacob Faibussowitsch   PetscCall(DMLabelLookupAddStratum(label, value, &v));
3253ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
326b9907514SLisandro Dalcin }
327b9907514SLisandro Dalcin 
328b9907514SLisandro Dalcin /*@
32920f4b53cSBarry Smith   DMLabelAddStrata - Adds new stratum values in a `DMLabel`
330b9907514SLisandro Dalcin 
33120f4b53cSBarry Smith   Not Collective
3325b5e7992SMatthew G. Knepley 
333d8d19677SJose E. Roman   Input Parameters:
33420f4b53cSBarry Smith + label         - The `DMLabel`
335b9907514SLisandro Dalcin . numStrata     - The number of stratum values
336b9907514SLisandro Dalcin - stratumValues - The stratum values
337b9907514SLisandro Dalcin 
338b9907514SLisandro Dalcin   Level: beginner
339b9907514SLisandro Dalcin 
34020f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`, `DMLabelDestroy()`
341b9907514SLisandro Dalcin @*/
342d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelAddStrata(DMLabel label, PetscInt numStrata, const PetscInt stratumValues[])
343d71ae5a4SJacob Faibussowitsch {
344b9907514SLisandro Dalcin   PetscInt *values, v;
345b9907514SLisandro Dalcin 
346b9907514SLisandro Dalcin   PetscFunctionBegin;
347b9907514SLisandro Dalcin   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
3484f572ea9SToby Isaac   if (numStrata) PetscAssertPointer(stratumValues, 3);
3499f6c5813SMatthew G. Knepley   PetscCheck(!label->readonly, PetscObjectComm((PetscObject)label), PETSC_ERR_ARG_WRONG, "Read-only labels cannot be altered");
3509566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(numStrata, &values));
3519566063dSJacob Faibussowitsch   PetscCall(PetscArraycpy(values, stratumValues, numStrata));
3529566063dSJacob Faibussowitsch   PetscCall(PetscSortRemoveDupsInt(&numStrata, values));
353b9907514SLisandro Dalcin   if (!label->numStrata) { /* Fast preallocation */
354b9907514SLisandro Dalcin     PetscInt   *tmpV;
355b9907514SLisandro Dalcin     PetscInt   *tmpS;
356b9907514SLisandro Dalcin     PetscHSetI *tmpH, ht;
357b9907514SLisandro Dalcin     IS         *tmpP, is;
358b9907514SLisandro Dalcin     PetscBool  *tmpB;
359b9907514SLisandro Dalcin     PetscHMapI  hmap = label->hmap;
360b9907514SLisandro Dalcin 
3619566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(numStrata, &tmpV));
3629566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(numStrata, &tmpS));
3639f6c5813SMatthew G. Knepley     PetscCall(PetscCalloc1(numStrata, &tmpH));
3649f6c5813SMatthew G. Knepley     PetscCall(PetscCalloc1(numStrata, &tmpP));
3659566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(numStrata, &tmpB));
366b9907514SLisandro Dalcin     label->numStrata     = numStrata;
367b9907514SLisandro Dalcin     label->stratumValues = tmpV;
368b9907514SLisandro Dalcin     label->stratumSizes  = tmpS;
369b9907514SLisandro Dalcin     label->ht            = tmpH;
370b9907514SLisandro Dalcin     label->points        = tmpP;
371b9907514SLisandro Dalcin     label->validIS       = tmpB;
372b9907514SLisandro Dalcin     for (v = 0; v < numStrata; ++v) {
3739566063dSJacob Faibussowitsch       PetscCall(PetscHSetICreate(&ht));
3749566063dSJacob Faibussowitsch       PetscCall(ISCreateStride(PETSC_COMM_SELF, 0, 0, 1, &is));
3759566063dSJacob Faibussowitsch       PetscCall(PetscHMapISet(hmap, values[v], v));
376b9907514SLisandro Dalcin       tmpV[v] = values[v];
377b9907514SLisandro Dalcin       tmpS[v] = 0;
378b9907514SLisandro Dalcin       tmpH[v] = ht;
379b9907514SLisandro Dalcin       tmpP[v] = is;
380b9907514SLisandro Dalcin       tmpB[v] = PETSC_TRUE;
381b9907514SLisandro Dalcin     }
3829566063dSJacob Faibussowitsch     PetscCall(PetscObjectStateIncrease((PetscObject)label));
383b9907514SLisandro Dalcin   } else {
38448a46eb9SPierre Jolivet     for (v = 0; v < numStrata; ++v) PetscCall(DMLabelAddStratum(label, values[v]));
385b9907514SLisandro Dalcin   }
3869566063dSJacob Faibussowitsch   PetscCall(PetscFree(values));
3873ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
388b9907514SLisandro Dalcin }
389b9907514SLisandro Dalcin 
390b9907514SLisandro Dalcin /*@
39120f4b53cSBarry Smith   DMLabelAddStrataIS - Adds new stratum values in a `DMLabel`
392b9907514SLisandro Dalcin 
39320f4b53cSBarry Smith   Not Collective
3945b5e7992SMatthew G. Knepley 
395d8d19677SJose E. Roman   Input Parameters:
39620f4b53cSBarry Smith + label   - The `DMLabel`
397b9907514SLisandro Dalcin - valueIS - Index set with stratum values
398b9907514SLisandro Dalcin 
399b9907514SLisandro Dalcin   Level: beginner
400b9907514SLisandro Dalcin 
40120f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`, `DMLabelDestroy()`
402b9907514SLisandro Dalcin @*/
403d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelAddStrataIS(DMLabel label, IS valueIS)
404d71ae5a4SJacob Faibussowitsch {
405b9907514SLisandro Dalcin   PetscInt        numStrata;
406b9907514SLisandro Dalcin   const PetscInt *stratumValues;
407b9907514SLisandro Dalcin 
408b9907514SLisandro Dalcin   PetscFunctionBegin;
409b9907514SLisandro Dalcin   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
410b9907514SLisandro Dalcin   PetscValidHeaderSpecific(valueIS, IS_CLASSID, 2);
4119f6c5813SMatthew G. Knepley   PetscCheck(!label->readonly, PetscObjectComm((PetscObject)label), PETSC_ERR_ARG_WRONG, "Read-only labels cannot be altered");
4129566063dSJacob Faibussowitsch   PetscCall(ISGetLocalSize(valueIS, &numStrata));
4139566063dSJacob Faibussowitsch   PetscCall(ISGetIndices(valueIS, &stratumValues));
4149566063dSJacob Faibussowitsch   PetscCall(DMLabelAddStrata(label, numStrata, stratumValues));
4153ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
416c58f1c22SToby Isaac }
417c58f1c22SToby Isaac 
4189f6c5813SMatthew G. Knepley static PetscErrorCode DMLabelView_Concrete_Ascii(DMLabel label, PetscViewer viewer)
419d71ae5a4SJacob Faibussowitsch {
420c58f1c22SToby Isaac   PetscInt    v;
421c58f1c22SToby Isaac   PetscMPIInt rank;
422c58f1c22SToby Isaac 
423c58f1c22SToby Isaac   PetscFunctionBegin;
4249566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(PetscObjectComm((PetscObject)viewer), &rank));
4259566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPushSynchronized(viewer));
426c58f1c22SToby Isaac   if (label) {
427d67d17b1SMatthew G. Knepley     const char *name;
428d67d17b1SMatthew G. Knepley 
4299566063dSJacob Faibussowitsch     PetscCall(PetscObjectGetName((PetscObject)label, &name));
4309566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer, "Label '%s':\n", name));
43163a3b9bcSJacob Faibussowitsch     if (label->bt) PetscCall(PetscViewerASCIIPrintf(viewer, "  Index has been calculated in [%" PetscInt_FMT ", %" PetscInt_FMT ")\n", label->pStart, label->pEnd));
432c58f1c22SToby Isaac     for (v = 0; v < label->numStrata; ++v) {
433c58f1c22SToby Isaac       const PetscInt  value = label->stratumValues[v];
434ad8374ffSToby Isaac       const PetscInt *points;
435c58f1c22SToby Isaac       PetscInt        p;
436c58f1c22SToby Isaac 
4379566063dSJacob Faibussowitsch       PetscCall(ISGetIndices(label->points[v], &points));
43848a46eb9SPierre Jolivet       for (p = 0; p < label->stratumSizes[v]; ++p) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "[%d]: %" PetscInt_FMT " (%" PetscInt_FMT ")\n", rank, points[p], value));
4399566063dSJacob Faibussowitsch       PetscCall(ISRestoreIndices(label->points[v], &points));
440c58f1c22SToby Isaac     }
441c58f1c22SToby Isaac   }
4429566063dSJacob Faibussowitsch   PetscCall(PetscViewerFlush(viewer));
4439566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPopSynchronized(viewer));
4443ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
445c58f1c22SToby Isaac }
446c58f1c22SToby Isaac 
44766976f2fSJacob Faibussowitsch static PetscErrorCode DMLabelView_Concrete(DMLabel label, PetscViewer viewer)
4489f6c5813SMatthew G. Knepley {
4499f6c5813SMatthew G. Knepley   PetscBool iascii;
4509f6c5813SMatthew G. Knepley 
4519f6c5813SMatthew G. Knepley   PetscFunctionBegin;
4529f6c5813SMatthew G. Knepley   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii));
4539f6c5813SMatthew G. Knepley   if (iascii) PetscCall(DMLabelView_Concrete_Ascii(label, viewer));
4543ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
4559f6c5813SMatthew G. Knepley }
4569f6c5813SMatthew G. Knepley 
457*ffeef943SBarry Smith /*@
458c58f1c22SToby Isaac   DMLabelView - View the label
459c58f1c22SToby Isaac 
46020f4b53cSBarry Smith   Collective
4615b5e7992SMatthew G. Knepley 
462c58f1c22SToby Isaac   Input Parameters:
46320f4b53cSBarry Smith + label  - The `DMLabel`
46420f4b53cSBarry Smith - viewer - The `PetscViewer`
465c58f1c22SToby Isaac 
466c58f1c22SToby Isaac   Level: intermediate
467c58f1c22SToby Isaac 
46820f4b53cSBarry Smith .seealso: `DMLabel`, `PetscViewer`, `DM`, `DMLabelCreate()`, `DMLabelDestroy()`
469c58f1c22SToby Isaac @*/
470d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelView(DMLabel label, PetscViewer viewer)
471d71ae5a4SJacob Faibussowitsch {
472c58f1c22SToby Isaac   PetscFunctionBegin;
473d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
4749566063dSJacob Faibussowitsch   if (!viewer) PetscCall(PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)label), &viewer));
475c58f1c22SToby Isaac   PetscValidHeaderSpecific(viewer, PETSC_VIEWER_CLASSID, 2);
4769f6c5813SMatthew G. Knepley   PetscCall(DMLabelMakeAllValid_Private(label));
4779f6c5813SMatthew G. Knepley   PetscUseTypeMethod(label, view, viewer);
4783ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
479c58f1c22SToby Isaac }
480c58f1c22SToby Isaac 
48184f0b6dfSMatthew G. Knepley /*@
48220f4b53cSBarry Smith   DMLabelReset - Destroys internal data structures in a `DMLabel`
483d67d17b1SMatthew G. Knepley 
48420f4b53cSBarry Smith   Not Collective
4855b5e7992SMatthew G. Knepley 
486d67d17b1SMatthew G. Knepley   Input Parameter:
48720f4b53cSBarry Smith . label - The `DMLabel`
488d67d17b1SMatthew G. Knepley 
489d67d17b1SMatthew G. Knepley   Level: beginner
490d67d17b1SMatthew G. Knepley 
49120f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelDestroy()`, `DMLabelCreate()`
492d67d17b1SMatthew G. Knepley @*/
493d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelReset(DMLabel label)
494d71ae5a4SJacob Faibussowitsch {
495d67d17b1SMatthew G. Knepley   PetscInt v;
496d67d17b1SMatthew G. Knepley 
497d67d17b1SMatthew G. Knepley   PetscFunctionBegin;
498d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
499d67d17b1SMatthew G. Knepley   for (v = 0; v < label->numStrata; ++v) {
5009f6c5813SMatthew G. Knepley     if (label->ht[v]) PetscCall(PetscHSetIDestroy(&label->ht[v]));
5019566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&label->points[v]));
502d67d17b1SMatthew G. Knepley   }
503b9907514SLisandro Dalcin   label->numStrata = 0;
5049566063dSJacob Faibussowitsch   PetscCall(PetscFree(label->stratumValues));
5059566063dSJacob Faibussowitsch   PetscCall(PetscFree(label->stratumSizes));
5069566063dSJacob Faibussowitsch   PetscCall(PetscFree(label->ht));
5079566063dSJacob Faibussowitsch   PetscCall(PetscFree(label->points));
5089566063dSJacob Faibussowitsch   PetscCall(PetscFree(label->validIS));
5099566063dSJacob Faibussowitsch   PetscCall(PetscHMapIReset(label->hmap));
510b9907514SLisandro Dalcin   label->pStart = -1;
511b9907514SLisandro Dalcin   label->pEnd   = -1;
5129566063dSJacob Faibussowitsch   PetscCall(PetscBTDestroy(&label->bt));
5133ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
514d67d17b1SMatthew G. Knepley }
515d67d17b1SMatthew G. Knepley 
516d67d17b1SMatthew G. Knepley /*@
51720f4b53cSBarry Smith   DMLabelDestroy - Destroys a `DMLabel`
51884f0b6dfSMatthew G. Knepley 
51920f4b53cSBarry Smith   Collective
5205b5e7992SMatthew G. Knepley 
52184f0b6dfSMatthew G. Knepley   Input Parameter:
52220f4b53cSBarry Smith . label - The `DMLabel`
52384f0b6dfSMatthew G. Knepley 
52484f0b6dfSMatthew G. Knepley   Level: beginner
52584f0b6dfSMatthew G. Knepley 
52620f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelReset()`, `DMLabelCreate()`
52784f0b6dfSMatthew G. Knepley @*/
528d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelDestroy(DMLabel *label)
529d71ae5a4SJacob Faibussowitsch {
530c58f1c22SToby Isaac   PetscFunctionBegin;
5313ba16761SJacob Faibussowitsch   if (!*label) PetscFunctionReturn(PETSC_SUCCESS);
532f4f49eeaSPierre Jolivet   PetscValidHeaderSpecific(*label, DMLABEL_CLASSID, 1);
533f4f49eeaSPierre Jolivet   if (--((PetscObject)*label)->refct > 0) {
5349371c9d4SSatish Balay     *label = NULL;
5353ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
5369371c9d4SSatish Balay   }
5379566063dSJacob Faibussowitsch   PetscCall(DMLabelReset(*label));
5389566063dSJacob Faibussowitsch   PetscCall(PetscHMapIDestroy(&(*label)->hmap));
5399566063dSJacob Faibussowitsch   PetscCall(PetscHeaderDestroy(label));
5403ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
541c58f1c22SToby Isaac }
542c58f1c22SToby Isaac 
54366976f2fSJacob Faibussowitsch static PetscErrorCode DMLabelDuplicate_Concrete(DMLabel label, DMLabel *labelnew)
5449f6c5813SMatthew G. Knepley {
5459f6c5813SMatthew G. Knepley   PetscFunctionBegin;
5469f6c5813SMatthew G. Knepley   for (PetscInt v = 0; v < label->numStrata; ++v) {
5479f6c5813SMatthew G. Knepley     PetscCall(PetscHSetICreate(&(*labelnew)->ht[v]));
548f4f49eeaSPierre Jolivet     PetscCall(PetscObjectReference((PetscObject)label->points[v]));
5499f6c5813SMatthew G. Knepley     (*labelnew)->points[v] = label->points[v];
5509f6c5813SMatthew G. Knepley   }
5519f6c5813SMatthew G. Knepley   PetscCall(PetscHMapIDestroy(&(*labelnew)->hmap));
5529f6c5813SMatthew G. Knepley   PetscCall(PetscHMapIDuplicate(label->hmap, &(*labelnew)->hmap));
5533ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
5549f6c5813SMatthew G. Knepley }
5559f6c5813SMatthew G. Knepley 
55684f0b6dfSMatthew G. Knepley /*@
55720f4b53cSBarry Smith   DMLabelDuplicate - Duplicates a `DMLabel`
55884f0b6dfSMatthew G. Knepley 
55920f4b53cSBarry Smith   Collective
5605b5e7992SMatthew G. Knepley 
56184f0b6dfSMatthew G. Knepley   Input Parameter:
56220f4b53cSBarry Smith . label - The `DMLabel`
56384f0b6dfSMatthew G. Knepley 
56484f0b6dfSMatthew G. Knepley   Output Parameter:
56520f4b53cSBarry Smith . labelnew - new label
56684f0b6dfSMatthew G. Knepley 
56784f0b6dfSMatthew G. Knepley   Level: intermediate
56884f0b6dfSMatthew G. Knepley 
56920f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`, `DMLabelDestroy()`
57084f0b6dfSMatthew G. Knepley @*/
571d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelDuplicate(DMLabel label, DMLabel *labelnew)
572d71ae5a4SJacob Faibussowitsch {
573d67d17b1SMatthew G. Knepley   const char *name;
574c58f1c22SToby Isaac 
575c58f1c22SToby Isaac   PetscFunctionBegin;
576d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
5779566063dSJacob Faibussowitsch   PetscCall(DMLabelMakeAllValid_Private(label));
5789566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetName((PetscObject)label, &name));
5799566063dSJacob Faibussowitsch   PetscCall(DMLabelCreate(PetscObjectComm((PetscObject)label), name, labelnew));
580c58f1c22SToby Isaac 
581c58f1c22SToby Isaac   (*labelnew)->numStrata    = label->numStrata;
5825aa44df4SToby Isaac   (*labelnew)->defaultValue = label->defaultValue;
5838dcf10e8SMatthew G. Knepley   (*labelnew)->readonly     = label->readonly;
5849566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(label->numStrata, &(*labelnew)->stratumValues));
5859566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(label->numStrata, &(*labelnew)->stratumSizes));
5869f6c5813SMatthew G. Knepley   PetscCall(PetscCalloc1(label->numStrata, &(*labelnew)->ht));
5879f6c5813SMatthew G. Knepley   PetscCall(PetscCalloc1(label->numStrata, &(*labelnew)->points));
5889566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(label->numStrata, &(*labelnew)->validIS));
5899f6c5813SMatthew G. Knepley   for (PetscInt v = 0; v < label->numStrata; ++v) {
590c58f1c22SToby Isaac     (*labelnew)->stratumValues[v] = label->stratumValues[v];
591c58f1c22SToby Isaac     (*labelnew)->stratumSizes[v]  = label->stratumSizes[v];
592b9907514SLisandro Dalcin     (*labelnew)->validIS[v]       = PETSC_TRUE;
593c58f1c22SToby Isaac   }
594c58f1c22SToby Isaac   (*labelnew)->pStart = -1;
595c58f1c22SToby Isaac   (*labelnew)->pEnd   = -1;
596c58f1c22SToby Isaac   (*labelnew)->bt     = NULL;
5979f6c5813SMatthew G. Knepley   PetscUseTypeMethod(label, duplicate, labelnew);
5983ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
599c58f1c22SToby Isaac }
600c58f1c22SToby Isaac 
601609dae6eSVaclav Hapla /*@C
60220f4b53cSBarry Smith   DMLabelCompare - Compare two `DMLabel` objects
603609dae6eSVaclav Hapla 
60420f4b53cSBarry Smith   Collective; No Fortran Support
605609dae6eSVaclav Hapla 
606609dae6eSVaclav Hapla   Input Parameters:
607f1a722f8SMatthew G. Knepley + comm - Comm over which to compare labels
60820f4b53cSBarry Smith . l0   - First `DMLabel`
60920f4b53cSBarry Smith - l1   - Second `DMLabel`
610609dae6eSVaclav Hapla 
611a4e35b19SJacob Faibussowitsch   Output Parameters:
6125efe38ccSVaclav Hapla + equal   - (Optional) Flag whether the two labels are equal
6135efe38ccSVaclav Hapla - message - (Optional) Message describing the difference
614609dae6eSVaclav Hapla 
615609dae6eSVaclav Hapla   Level: intermediate
616609dae6eSVaclav Hapla 
617609dae6eSVaclav Hapla   Notes:
6185efe38ccSVaclav Hapla   The output flag equal is the same on all processes.
61920f4b53cSBarry Smith   If it is passed as `NULL` and difference is found, an error is thrown on all processes.
62020f4b53cSBarry Smith   Make sure to pass `NULL` on all processes.
621609dae6eSVaclav Hapla 
6225efe38ccSVaclav Hapla   The output message is set independently on each rank.
62320f4b53cSBarry Smith   It is set to `NULL` if no difference was found on the current rank. It must be freed by user.
62420f4b53cSBarry Smith   If message is passed as `NULL` and difference is found, the difference description is printed to stderr in synchronized manner.
62520f4b53cSBarry Smith   Make sure to pass `NULL` on all processes.
626609dae6eSVaclav Hapla 
627609dae6eSVaclav Hapla   For the comparison, we ignore the order of stratum values, and strata with no points.
628609dae6eSVaclav Hapla 
62920f4b53cSBarry Smith   The communicator needs to be specified because currently `DMLabel` can live on `PETSC_COMM_SELF` even if the underlying `DM` is parallel.
6305efe38ccSVaclav Hapla 
631a3b724e8SBarry Smith   Developer Note:
632a3b724e8SBarry Smith   Fortran stub cannot be generated automatically because `message` must be freed with `PetscFree()`
633a3b724e8SBarry Smith 
63420f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMCompareLabels()`, `DMLabelGetNumValues()`, `DMLabelGetDefaultValue()`, `DMLabelGetNonEmptyStratumValuesIS()`, `DMLabelGetStratumIS()`
635609dae6eSVaclav Hapla @*/
636d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelCompare(MPI_Comm comm, DMLabel l0, DMLabel l1, PetscBool *equal, char **message)
637d71ae5a4SJacob Faibussowitsch {
638609dae6eSVaclav Hapla   const char *name0, *name1;
639609dae6eSVaclav Hapla   char        msg[PETSC_MAX_PATH_LEN] = "";
6405efe38ccSVaclav Hapla   PetscBool   eq;
6415efe38ccSVaclav Hapla   PetscMPIInt rank;
642609dae6eSVaclav Hapla 
643609dae6eSVaclav Hapla   PetscFunctionBegin;
6445efe38ccSVaclav Hapla   PetscValidHeaderSpecific(l0, DMLABEL_CLASSID, 2);
6455efe38ccSVaclav Hapla   PetscValidHeaderSpecific(l1, DMLABEL_CLASSID, 3);
6464f572ea9SToby Isaac   if (equal) PetscAssertPointer(equal, 4);
6474f572ea9SToby Isaac   if (message) PetscAssertPointer(message, 5);
6489566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(comm, &rank));
6499566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetName((PetscObject)l0, &name0));
6509566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetName((PetscObject)l1, &name1));
651609dae6eSVaclav Hapla   {
652609dae6eSVaclav Hapla     PetscInt v0, v1;
653609dae6eSVaclav Hapla 
6549566063dSJacob Faibussowitsch     PetscCall(DMLabelGetDefaultValue(l0, &v0));
6559566063dSJacob Faibussowitsch     PetscCall(DMLabelGetDefaultValue(l1, &v1));
6565efe38ccSVaclav Hapla     eq = (PetscBool)(v0 == v1);
65748a46eb9SPierre Jolivet     if (!eq) PetscCall(PetscSNPrintf(msg, sizeof(msg), "Default value of DMLabel l0 \"%s\" = %" PetscInt_FMT " != %" PetscInt_FMT " = Default value of DMLabel l1 \"%s\"", name0, v0, v1, name1));
658712fec58SPierre Jolivet     PetscCall(MPIU_Allreduce(MPI_IN_PLACE, &eq, 1, MPIU_BOOL, MPI_LAND, comm));
6595efe38ccSVaclav Hapla     if (!eq) goto finish;
660609dae6eSVaclav Hapla   }
661609dae6eSVaclav Hapla   {
662609dae6eSVaclav Hapla     IS is0, is1;
663609dae6eSVaclav Hapla 
6649566063dSJacob Faibussowitsch     PetscCall(DMLabelGetNonEmptyStratumValuesIS(l0, &is0));
6659566063dSJacob Faibussowitsch     PetscCall(DMLabelGetNonEmptyStratumValuesIS(l1, &is1));
6669566063dSJacob Faibussowitsch     PetscCall(ISEqual(is0, is1, &eq));
6679566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&is0));
6689566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&is1));
66948a46eb9SPierre Jolivet     if (!eq) PetscCall(PetscSNPrintf(msg, sizeof(msg), "Stratum values in DMLabel l0 \"%s\" are different than in DMLabel l1 \"%s\"", name0, name1));
670712fec58SPierre Jolivet     PetscCall(MPIU_Allreduce(MPI_IN_PLACE, &eq, 1, MPIU_BOOL, MPI_LAND, comm));
6715efe38ccSVaclav Hapla     if (!eq) goto finish;
672609dae6eSVaclav Hapla   }
673609dae6eSVaclav Hapla   {
674609dae6eSVaclav Hapla     PetscInt i, nValues;
675609dae6eSVaclav Hapla 
6769566063dSJacob Faibussowitsch     PetscCall(DMLabelGetNumValues(l0, &nValues));
677609dae6eSVaclav Hapla     for (i = 0; i < nValues; i++) {
678609dae6eSVaclav Hapla       const PetscInt v = l0->stratumValues[i];
679609dae6eSVaclav Hapla       PetscInt       n;
680609dae6eSVaclav Hapla       IS             is0, is1;
681609dae6eSVaclav Hapla 
6829566063dSJacob Faibussowitsch       PetscCall(DMLabelGetStratumSize_Private(l0, i, &n));
683609dae6eSVaclav Hapla       if (!n) continue;
6849566063dSJacob Faibussowitsch       PetscCall(DMLabelGetStratumIS(l0, v, &is0));
6859566063dSJacob Faibussowitsch       PetscCall(DMLabelGetStratumIS(l1, v, &is1));
6869566063dSJacob Faibussowitsch       PetscCall(ISEqualUnsorted(is0, is1, &eq));
6879566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&is0));
6889566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&is1));
6895efe38ccSVaclav Hapla       if (!eq) {
69063a3b9bcSJacob Faibussowitsch         PetscCall(PetscSNPrintf(msg, sizeof(msg), "Stratum #%" PetscInt_FMT " with value %" PetscInt_FMT " contains different points in DMLabel l0 \"%s\" and DMLabel l1 \"%s\"", i, v, name0, name1));
6915efe38ccSVaclav Hapla         break;
692609dae6eSVaclav Hapla       }
693609dae6eSVaclav Hapla     }
694712fec58SPierre Jolivet     PetscCall(MPIU_Allreduce(MPI_IN_PLACE, &eq, 1, MPIU_BOOL, MPI_LAND, comm));
695609dae6eSVaclav Hapla   }
696609dae6eSVaclav Hapla finish:
6975efe38ccSVaclav Hapla   /* If message output arg not set, print to stderr */
698609dae6eSVaclav Hapla   if (message) {
699609dae6eSVaclav Hapla     *message = NULL;
70048a46eb9SPierre Jolivet     if (msg[0]) PetscCall(PetscStrallocpy(msg, message));
7015efe38ccSVaclav Hapla   } else {
70248a46eb9SPierre Jolivet     if (msg[0]) PetscCall(PetscSynchronizedFPrintf(comm, PETSC_STDERR, "[%d] %s\n", rank, msg));
7039566063dSJacob Faibussowitsch     PetscCall(PetscSynchronizedFlush(comm, PETSC_STDERR));
7045efe38ccSVaclav Hapla   }
7055efe38ccSVaclav Hapla   /* If same output arg not ser and labels are not equal, throw error */
7065efe38ccSVaclav Hapla   if (equal) *equal = eq;
70763a3b9bcSJacob Faibussowitsch   else PetscCheck(eq, comm, PETSC_ERR_ARG_INCOMP, "DMLabels l0 \"%s\" and l1 \"%s\" are not equal", name0, name1);
7083ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
709609dae6eSVaclav Hapla }
710609dae6eSVaclav Hapla 
711c6a43d28SMatthew G. Knepley /*@
712c6a43d28SMatthew G. Knepley   DMLabelComputeIndex - Create an index structure for membership determination, automatically determining the bounds
713c6a43d28SMatthew G. Knepley 
71420f4b53cSBarry Smith   Not Collective
7155b5e7992SMatthew G. Knepley 
716c6a43d28SMatthew G. Knepley   Input Parameter:
71720f4b53cSBarry Smith . label - The `DMLabel`
718c6a43d28SMatthew G. Knepley 
719c6a43d28SMatthew G. Knepley   Level: intermediate
720c6a43d28SMatthew G. Knepley 
72120f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelHasPoint()`, `DMLabelCreateIndex()`, `DMLabelDestroyIndex()`, `DMLabelGetValue()`, `DMLabelSetValue()`
722c6a43d28SMatthew G. Knepley @*/
723d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelComputeIndex(DMLabel label)
724d71ae5a4SJacob Faibussowitsch {
725c6a43d28SMatthew G. Knepley   PetscInt pStart = PETSC_MAX_INT, pEnd = -1, v;
726c6a43d28SMatthew G. Knepley 
727c6a43d28SMatthew G. Knepley   PetscFunctionBegin;
728c6a43d28SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
7299566063dSJacob Faibussowitsch   PetscCall(DMLabelMakeAllValid_Private(label));
730c6a43d28SMatthew G. Knepley   for (v = 0; v < label->numStrata; ++v) {
731c6a43d28SMatthew G. Knepley     const PetscInt *points;
732c6a43d28SMatthew G. Knepley     PetscInt        i;
733c6a43d28SMatthew G. Knepley 
7349566063dSJacob Faibussowitsch     PetscCall(ISGetIndices(label->points[v], &points));
735c6a43d28SMatthew G. Knepley     for (i = 0; i < label->stratumSizes[v]; ++i) {
736c6a43d28SMatthew G. Knepley       const PetscInt point = points[i];
737c6a43d28SMatthew G. Knepley 
738c6a43d28SMatthew G. Knepley       pStart = PetscMin(point, pStart);
739c6a43d28SMatthew G. Knepley       pEnd   = PetscMax(point + 1, pEnd);
740c6a43d28SMatthew G. Knepley     }
7419566063dSJacob Faibussowitsch     PetscCall(ISRestoreIndices(label->points[v], &points));
742c6a43d28SMatthew G. Knepley   }
743c6a43d28SMatthew G. Knepley   label->pStart = pStart == PETSC_MAX_INT ? -1 : pStart;
744c6a43d28SMatthew G. Knepley   label->pEnd   = pEnd;
7459566063dSJacob Faibussowitsch   PetscCall(DMLabelCreateIndex(label, label->pStart, label->pEnd));
7463ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
747c6a43d28SMatthew G. Knepley }
748c6a43d28SMatthew G. Knepley 
749c6a43d28SMatthew G. Knepley /*@
750c6a43d28SMatthew G. Knepley   DMLabelCreateIndex - Create an index structure for membership determination
751c6a43d28SMatthew G. Knepley 
75220f4b53cSBarry Smith   Not Collective
7535b5e7992SMatthew G. Knepley 
754c6a43d28SMatthew G. Knepley   Input Parameters:
75520f4b53cSBarry Smith + label  - The `DMLabel`
756c6a43d28SMatthew G. Knepley . pStart - The smallest point
757c6a43d28SMatthew G. Knepley - pEnd   - The largest point + 1
758c6a43d28SMatthew G. Knepley 
759c6a43d28SMatthew G. Knepley   Level: intermediate
760c6a43d28SMatthew G. Knepley 
76120f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelHasPoint()`, `DMLabelComputeIndex()`, `DMLabelDestroyIndex()`, `DMLabelGetValue()`, `DMLabelSetValue()`
762c6a43d28SMatthew G. Knepley @*/
763d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelCreateIndex(DMLabel label, PetscInt pStart, PetscInt pEnd)
764d71ae5a4SJacob Faibussowitsch {
765c58f1c22SToby Isaac   PetscInt v;
766c58f1c22SToby Isaac 
767c58f1c22SToby Isaac   PetscFunctionBegin;
768d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
7699566063dSJacob Faibussowitsch   PetscCall(DMLabelDestroyIndex(label));
7709566063dSJacob Faibussowitsch   PetscCall(DMLabelMakeAllValid_Private(label));
771c58f1c22SToby Isaac   label->pStart = pStart;
772c58f1c22SToby Isaac   label->pEnd   = pEnd;
773c6a43d28SMatthew G. Knepley   /* This can be hooked into SetValue(),  ClearValue(), etc. for updating */
7749566063dSJacob Faibussowitsch   PetscCall(PetscBTCreate(pEnd - pStart, &label->bt));
775c58f1c22SToby Isaac   for (v = 0; v < label->numStrata; ++v) {
7769f6c5813SMatthew G. Knepley     IS              pointIS;
777ad8374ffSToby Isaac     const PetscInt *points;
778c58f1c22SToby Isaac     PetscInt        i;
779c58f1c22SToby Isaac 
7809f6c5813SMatthew G. Knepley     PetscUseTypeMethod(label, getstratumis, v, &pointIS);
7819f6c5813SMatthew G. Knepley     PetscCall(ISGetIndices(pointIS, &points));
782c58f1c22SToby Isaac     for (i = 0; i < label->stratumSizes[v]; ++i) {
783ad8374ffSToby Isaac       const PetscInt point = points[i];
784c58f1c22SToby Isaac 
7859f6c5813SMatthew G. Knepley       PetscCheck(!(point < pStart) && !(point >= pEnd), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label point %" PetscInt_FMT " in stratum %" PetscInt_FMT " is not in [%" PetscInt_FMT ", %" PetscInt_FMT ")", point, label->stratumValues[v], pStart, pEnd);
7869566063dSJacob Faibussowitsch       PetscCall(PetscBTSet(label->bt, point - pStart));
787c58f1c22SToby Isaac     }
7889566063dSJacob Faibussowitsch     PetscCall(ISRestoreIndices(label->points[v], &points));
7899f6c5813SMatthew G. Knepley     PetscCall(ISDestroy(&pointIS));
790c58f1c22SToby Isaac   }
7913ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
792c58f1c22SToby Isaac }
793c58f1c22SToby Isaac 
794c6a43d28SMatthew G. Knepley /*@
795c6a43d28SMatthew G. Knepley   DMLabelDestroyIndex - Destroy the index structure
796c6a43d28SMatthew G. Knepley 
79720f4b53cSBarry Smith   Not Collective
7985b5e7992SMatthew G. Knepley 
799c6a43d28SMatthew G. Knepley   Input Parameter:
80020f4b53cSBarry Smith . label - the `DMLabel`
801c6a43d28SMatthew G. Knepley 
802c6a43d28SMatthew G. Knepley   Level: intermediate
803c6a43d28SMatthew G. Knepley 
80420f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelHasPoint()`, `DMLabelCreateIndex()`, `DMLabelGetValue()`, `DMLabelSetValue()`
805c6a43d28SMatthew G. Knepley @*/
806d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelDestroyIndex(DMLabel label)
807d71ae5a4SJacob Faibussowitsch {
808c58f1c22SToby Isaac   PetscFunctionBegin;
809d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
810c58f1c22SToby Isaac   label->pStart = -1;
811c58f1c22SToby Isaac   label->pEnd   = -1;
8129566063dSJacob Faibussowitsch   PetscCall(PetscBTDestroy(&label->bt));
8133ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
814c58f1c22SToby Isaac }
815c58f1c22SToby Isaac 
816c58f1c22SToby Isaac /*@
817c6a43d28SMatthew G. Knepley   DMLabelGetBounds - Return the smallest and largest point in the label
818c6a43d28SMatthew G. Knepley 
81920f4b53cSBarry Smith   Not Collective
8205b5e7992SMatthew G. Knepley 
821c6a43d28SMatthew G. Knepley   Input Parameter:
82220f4b53cSBarry Smith . label - the `DMLabel`
823c6a43d28SMatthew G. Knepley 
824c6a43d28SMatthew G. Knepley   Output Parameters:
825c6a43d28SMatthew G. Knepley + pStart - The smallest point
826c6a43d28SMatthew G. Knepley - pEnd   - The largest point + 1
827c6a43d28SMatthew G. Knepley 
828c6a43d28SMatthew G. Knepley   Level: intermediate
829c6a43d28SMatthew G. Knepley 
83020f4b53cSBarry Smith   Note:
83120f4b53cSBarry Smith   This will compute an index for the label if one does not exist.
83220f4b53cSBarry Smith 
83320f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelHasPoint()`, `DMLabelCreateIndex()`, `DMLabelGetValue()`, `DMLabelSetValue()`
834c6a43d28SMatthew G. Knepley @*/
835d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelGetBounds(DMLabel label, PetscInt *pStart, PetscInt *pEnd)
836d71ae5a4SJacob Faibussowitsch {
837c6a43d28SMatthew G. Knepley   PetscFunctionBegin;
838c6a43d28SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
8399566063dSJacob Faibussowitsch   if ((label->pStart == -1) && (label->pEnd == -1)) PetscCall(DMLabelComputeIndex(label));
840c6a43d28SMatthew G. Knepley   if (pStart) {
8414f572ea9SToby Isaac     PetscAssertPointer(pStart, 2);
842c6a43d28SMatthew G. Knepley     *pStart = label->pStart;
843c6a43d28SMatthew G. Knepley   }
844c6a43d28SMatthew G. Knepley   if (pEnd) {
8454f572ea9SToby Isaac     PetscAssertPointer(pEnd, 3);
846c6a43d28SMatthew G. Knepley     *pEnd = label->pEnd;
847c6a43d28SMatthew G. Knepley   }
8483ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
849c6a43d28SMatthew G. Knepley }
850c6a43d28SMatthew G. Knepley 
851c6a43d28SMatthew G. Knepley /*@
852c58f1c22SToby Isaac   DMLabelHasValue - Determine whether a label assigns the value to any point
853c58f1c22SToby Isaac 
85420f4b53cSBarry Smith   Not Collective
8555b5e7992SMatthew G. Knepley 
856c58f1c22SToby Isaac   Input Parameters:
85720f4b53cSBarry Smith + label - the `DMLabel`
858c58f1c22SToby Isaac - value - the value
859c58f1c22SToby Isaac 
860c58f1c22SToby Isaac   Output Parameter:
861c58f1c22SToby Isaac . contains - Flag indicating whether the label maps this value to any point
862c58f1c22SToby Isaac 
863c58f1c22SToby Isaac   Level: developer
864c58f1c22SToby Isaac 
86520f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelHasPoint()`, `DMLabelGetValue()`, `DMLabelSetValue()`
866c58f1c22SToby Isaac @*/
867d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelHasValue(DMLabel label, PetscInt value, PetscBool *contains)
868d71ae5a4SJacob Faibussowitsch {
869c58f1c22SToby Isaac   PetscInt v;
870c58f1c22SToby Isaac 
871c58f1c22SToby Isaac   PetscFunctionBegin;
872d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
8734f572ea9SToby Isaac   PetscAssertPointer(contains, 3);
8749566063dSJacob Faibussowitsch   PetscCall(DMLabelLookupStratum(label, value, &v));
8750c3c4a36SLisandro Dalcin   *contains = v < 0 ? PETSC_FALSE : PETSC_TRUE;
8763ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
877c58f1c22SToby Isaac }
878c58f1c22SToby Isaac 
879c58f1c22SToby Isaac /*@
880c58f1c22SToby Isaac   DMLabelHasPoint - Determine whether a label assigns a value to a point
881c58f1c22SToby Isaac 
88220f4b53cSBarry Smith   Not Collective
8835b5e7992SMatthew G. Knepley 
884c58f1c22SToby Isaac   Input Parameters:
88520f4b53cSBarry Smith + label - the `DMLabel`
886c58f1c22SToby Isaac - point - the point
887c58f1c22SToby Isaac 
888c58f1c22SToby Isaac   Output Parameter:
889c58f1c22SToby Isaac . contains - Flag indicating whether the label maps this point to a value
890c58f1c22SToby Isaac 
891c58f1c22SToby Isaac   Level: developer
892c58f1c22SToby Isaac 
89320f4b53cSBarry Smith   Note:
89420f4b53cSBarry Smith   The user must call `DMLabelCreateIndex()` before this function.
89520f4b53cSBarry Smith 
89620f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreateIndex()`, `DMLabelGetValue()`, `DMLabelSetValue()`
897c58f1c22SToby Isaac @*/
898d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelHasPoint(DMLabel label, PetscInt point, PetscBool *contains)
899d71ae5a4SJacob Faibussowitsch {
900c58f1c22SToby Isaac   PetscFunctionBeginHot;
901d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
9024f572ea9SToby Isaac   PetscAssertPointer(contains, 3);
9039566063dSJacob Faibussowitsch   PetscCall(DMLabelMakeAllValid_Private(label));
90476bd3646SJed Brown   if (PetscDefined(USE_DEBUG)) {
90528b400f6SJacob Faibussowitsch     PetscCheck(label->bt, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "Must call DMLabelCreateIndex() before DMLabelHasPoint()");
90663a3b9bcSJacob Faibussowitsch     PetscCheck(!(point < label->pStart) && !(point >= label->pEnd), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label point %" PetscInt_FMT " is not in [%" PetscInt_FMT ", %" PetscInt_FMT ")", point, label->pStart, label->pEnd);
90776bd3646SJed Brown   }
908c58f1c22SToby Isaac   *contains = PetscBTLookup(label->bt, point - label->pStart) ? PETSC_TRUE : PETSC_FALSE;
9093ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
910c58f1c22SToby Isaac }
911c58f1c22SToby Isaac 
912c58f1c22SToby Isaac /*@
913c58f1c22SToby Isaac   DMLabelStratumHasPoint - Return true if the stratum contains a point
914c58f1c22SToby Isaac 
91520f4b53cSBarry Smith   Not Collective
9165b5e7992SMatthew G. Knepley 
917c58f1c22SToby Isaac   Input Parameters:
91820f4b53cSBarry Smith + label - the `DMLabel`
919c58f1c22SToby Isaac . value - the stratum value
920c58f1c22SToby Isaac - point - the point
921c58f1c22SToby Isaac 
922c58f1c22SToby Isaac   Output Parameter:
923c58f1c22SToby Isaac . contains - true if the stratum contains the point
924c58f1c22SToby Isaac 
925c58f1c22SToby Isaac   Level: intermediate
926c58f1c22SToby Isaac 
92720f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`, `DMLabelSetValue()`, `DMLabelClearValue()`
928c58f1c22SToby Isaac @*/
929d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelStratumHasPoint(DMLabel label, PetscInt value, PetscInt point, PetscBool *contains)
930d71ae5a4SJacob Faibussowitsch {
9310c3c4a36SLisandro Dalcin   PetscFunctionBeginHot;
932d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
9334f572ea9SToby Isaac   PetscAssertPointer(contains, 4);
934cffad2c9SToby Isaac   if (value == label->defaultValue) {
935cffad2c9SToby Isaac     PetscInt pointVal;
9360c3c4a36SLisandro Dalcin 
937cffad2c9SToby Isaac     PetscCall(DMLabelGetValue(label, point, &pointVal));
938cffad2c9SToby Isaac     *contains = (PetscBool)(pointVal == value);
939cffad2c9SToby Isaac   } else {
940cffad2c9SToby Isaac     PetscInt v;
941cffad2c9SToby Isaac 
942cffad2c9SToby Isaac     PetscCall(DMLabelLookupStratum(label, value, &v));
943cffad2c9SToby Isaac     if (v >= 0) {
9449f6c5813SMatthew G. Knepley       if (label->validIS[v] || label->readonly) {
9459f6c5813SMatthew G. Knepley         IS       is;
946c58f1c22SToby Isaac         PetscInt i;
947c58f1c22SToby Isaac 
9489f6c5813SMatthew G. Knepley         PetscUseTypeMethod(label, getstratumis, v, &is);
9499f6c5813SMatthew G. Knepley         PetscCall(ISLocate(is, point, &i));
9509f6c5813SMatthew G. Knepley         PetscCall(ISDestroy(&is));
951cffad2c9SToby Isaac         *contains = (PetscBool)(i >= 0);
952c58f1c22SToby Isaac       } else {
953cffad2c9SToby Isaac         PetscCall(PetscHSetIHas(label->ht[v], point, contains));
954cffad2c9SToby Isaac       }
955cffad2c9SToby Isaac     } else { // value is not present
956cffad2c9SToby Isaac       *contains = PETSC_FALSE;
957cffad2c9SToby Isaac     }
958c58f1c22SToby Isaac   }
9593ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
960c58f1c22SToby Isaac }
961c58f1c22SToby Isaac 
96284f0b6dfSMatthew G. Knepley /*@
96320f4b53cSBarry Smith   DMLabelGetDefaultValue - Get the default value returned by `DMLabelGetValue()` if a point has not been explicitly given a value.
9645aa44df4SToby Isaac   When a label is created, it is initialized to -1.
9655aa44df4SToby Isaac 
96620f4b53cSBarry Smith   Not Collective
9675b5e7992SMatthew G. Knepley 
96860225df5SJacob Faibussowitsch   Input Parameter:
96920f4b53cSBarry Smith . label - a `DMLabel` object
9705aa44df4SToby Isaac 
97160225df5SJacob Faibussowitsch   Output Parameter:
9725aa44df4SToby Isaac . defaultValue - the default value
9735aa44df4SToby Isaac 
9745aa44df4SToby Isaac   Level: beginner
9755aa44df4SToby Isaac 
97620f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelSetDefaultValue()`, `DMLabelGetValue()`, `DMLabelSetValue()`
97784f0b6dfSMatthew G. Knepley @*/
978d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelGetDefaultValue(DMLabel label, PetscInt *defaultValue)
979d71ae5a4SJacob Faibussowitsch {
9805aa44df4SToby Isaac   PetscFunctionBegin;
981d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
9825aa44df4SToby Isaac   *defaultValue = label->defaultValue;
9833ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
9845aa44df4SToby Isaac }
9855aa44df4SToby Isaac 
98684f0b6dfSMatthew G. Knepley /*@
98720f4b53cSBarry Smith   DMLabelSetDefaultValue - Set the default value returned by `DMLabelGetValue()` if a point has not been explicitly given a value.
9885aa44df4SToby Isaac   When a label is created, it is initialized to -1.
9895aa44df4SToby Isaac 
99020f4b53cSBarry Smith   Not Collective
9915b5e7992SMatthew G. Knepley 
99260225df5SJacob Faibussowitsch   Input Parameter:
99320f4b53cSBarry Smith . label - a `DMLabel` object
9945aa44df4SToby Isaac 
99560225df5SJacob Faibussowitsch   Output Parameter:
9965aa44df4SToby Isaac . defaultValue - the default value
9975aa44df4SToby Isaac 
9985aa44df4SToby Isaac   Level: beginner
9995aa44df4SToby Isaac 
100020f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelGetDefaultValue()`, `DMLabelGetValue()`, `DMLabelSetValue()`
100184f0b6dfSMatthew G. Knepley @*/
1002d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelSetDefaultValue(DMLabel label, PetscInt defaultValue)
1003d71ae5a4SJacob Faibussowitsch {
10045aa44df4SToby Isaac   PetscFunctionBegin;
1005d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
10065aa44df4SToby Isaac   label->defaultValue = defaultValue;
10073ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
10085aa44df4SToby Isaac }
10095aa44df4SToby Isaac 
1010c58f1c22SToby Isaac /*@
101120f4b53cSBarry Smith   DMLabelGetValue - Return the value a label assigns to a point, or the label's default value (which is initially -1, and can be changed with
101220f4b53cSBarry Smith   `DMLabelSetDefaultValue()`)
1013c58f1c22SToby Isaac 
101420f4b53cSBarry Smith   Not Collective
10155b5e7992SMatthew G. Knepley 
1016c58f1c22SToby Isaac   Input Parameters:
101720f4b53cSBarry Smith + label - the `DMLabel`
1018c58f1c22SToby Isaac - point - the point
1019c58f1c22SToby Isaac 
1020c58f1c22SToby Isaac   Output Parameter:
10218e68afcfSMatthew G. Knepley . value - The point value, or the default value (-1 by default)
1022c58f1c22SToby Isaac 
1023c58f1c22SToby Isaac   Level: intermediate
1024c58f1c22SToby Isaac 
102520f4b53cSBarry Smith   Note:
102620f4b53cSBarry Smith   A label may assign multiple values to a point.  No guarantees are made about which value is returned in that case.
102720f4b53cSBarry Smith   Use `DMLabelStratumHasPoint()` to check for inclusion in a specific value stratum.
102820f4b53cSBarry Smith 
102920f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`, `DMLabelSetValue()`, `DMLabelClearValue()`, `DMLabelGetDefaultValue()`, `DMLabelSetDefaultValue()`
1030c58f1c22SToby Isaac @*/
1031d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelGetValue(DMLabel label, PetscInt point, PetscInt *value)
1032d71ae5a4SJacob Faibussowitsch {
1033c58f1c22SToby Isaac   PetscInt v;
1034c58f1c22SToby Isaac 
10350c3c4a36SLisandro Dalcin   PetscFunctionBeginHot;
1036d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
10374f572ea9SToby Isaac   PetscAssertPointer(value, 3);
10385aa44df4SToby Isaac   *value = label->defaultValue;
1039c58f1c22SToby Isaac   for (v = 0; v < label->numStrata; ++v) {
10409f6c5813SMatthew G. Knepley     if (label->validIS[v] || label->readonly) {
10419f6c5813SMatthew G. Knepley       IS       is;
1042c58f1c22SToby Isaac       PetscInt i;
1043c58f1c22SToby Isaac 
10449f6c5813SMatthew G. Knepley       PetscUseTypeMethod(label, getstratumis, v, &is);
10459566063dSJacob Faibussowitsch       PetscCall(ISLocate(label->points[v], point, &i));
10469f6c5813SMatthew G. Knepley       PetscCall(ISDestroy(&is));
1047c58f1c22SToby Isaac       if (i >= 0) {
1048c58f1c22SToby Isaac         *value = label->stratumValues[v];
1049c58f1c22SToby Isaac         break;
1050c58f1c22SToby Isaac       }
1051c58f1c22SToby Isaac     } else {
1052c58f1c22SToby Isaac       PetscBool has;
1053c58f1c22SToby Isaac 
10549566063dSJacob Faibussowitsch       PetscCall(PetscHSetIHas(label->ht[v], point, &has));
1055c58f1c22SToby Isaac       if (has) {
1056c58f1c22SToby Isaac         *value = label->stratumValues[v];
1057c58f1c22SToby Isaac         break;
1058c58f1c22SToby Isaac       }
1059c58f1c22SToby Isaac     }
1060c58f1c22SToby Isaac   }
10613ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1062c58f1c22SToby Isaac }
1063c58f1c22SToby Isaac 
1064c58f1c22SToby Isaac /*@
106520f4b53cSBarry Smith   DMLabelSetValue - Set the value a label assigns to a point.  If the value is the same as the label's default value (which is initially -1, and can
106620f4b53cSBarry Smith   be changed with `DMLabelSetDefaultValue()` to something different), then this function will do nothing.
1067c58f1c22SToby Isaac 
106820f4b53cSBarry Smith   Not Collective
10695b5e7992SMatthew G. Knepley 
1070c58f1c22SToby Isaac   Input Parameters:
107120f4b53cSBarry Smith + label - the `DMLabel`
1072c58f1c22SToby Isaac . point - the point
1073c58f1c22SToby Isaac - value - The point value
1074c58f1c22SToby Isaac 
1075c58f1c22SToby Isaac   Level: intermediate
1076c58f1c22SToby Isaac 
107720f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`, `DMLabelGetValue()`, `DMLabelClearValue()`, `DMLabelGetDefaultValue()`, `DMLabelSetDefaultValue()`
1078c58f1c22SToby Isaac @*/
1079d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelSetValue(DMLabel label, PetscInt point, PetscInt value)
1080d71ae5a4SJacob Faibussowitsch {
1081c58f1c22SToby Isaac   PetscInt v;
1082c58f1c22SToby Isaac 
1083c58f1c22SToby Isaac   PetscFunctionBegin;
1084d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
10850c3c4a36SLisandro Dalcin   /* Find label value, add new entry if needed */
10863ba16761SJacob Faibussowitsch   if (value == label->defaultValue) PetscFunctionReturn(PETSC_SUCCESS);
10879f6c5813SMatthew G. Knepley   PetscCheck(!label->readonly, PetscObjectComm((PetscObject)label), PETSC_ERR_ARG_WRONG, "Read-only labels cannot be altered");
10889566063dSJacob Faibussowitsch   PetscCall(DMLabelLookupAddStratum(label, value, &v));
1089c58f1c22SToby Isaac   /* Set key */
10909566063dSJacob Faibussowitsch   PetscCall(DMLabelMakeInvalid_Private(label, v));
10919566063dSJacob Faibussowitsch   PetscCall(PetscHSetIAdd(label->ht[v], point));
10923ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1093c58f1c22SToby Isaac }
1094c58f1c22SToby Isaac 
1095c58f1c22SToby Isaac /*@
1096c58f1c22SToby Isaac   DMLabelClearValue - Clear the value a label assigns to a point
1097c58f1c22SToby Isaac 
109820f4b53cSBarry Smith   Not Collective
10995b5e7992SMatthew G. Knepley 
1100c58f1c22SToby Isaac   Input Parameters:
110120f4b53cSBarry Smith + label - the `DMLabel`
1102c58f1c22SToby Isaac . point - the point
1103c58f1c22SToby Isaac - value - The point value
1104c58f1c22SToby Isaac 
1105c58f1c22SToby Isaac   Level: intermediate
1106c58f1c22SToby Isaac 
110720f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`, `DMLabelGetValue()`, `DMLabelSetValue()`
1108c58f1c22SToby Isaac @*/
1109d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelClearValue(DMLabel label, PetscInt point, PetscInt value)
1110d71ae5a4SJacob Faibussowitsch {
1111ad8374ffSToby Isaac   PetscInt v;
1112c58f1c22SToby Isaac 
1113c58f1c22SToby Isaac   PetscFunctionBegin;
1114d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
11159f6c5813SMatthew G. Knepley   PetscCheck(!label->readonly, PetscObjectComm((PetscObject)label), PETSC_ERR_ARG_WRONG, "Read-only labels cannot be altered");
1116c58f1c22SToby Isaac   /* Find label value */
11179566063dSJacob Faibussowitsch   PetscCall(DMLabelLookupStratum(label, value, &v));
11183ba16761SJacob Faibussowitsch   if (v < 0) PetscFunctionReturn(PETSC_SUCCESS);
11190c3c4a36SLisandro Dalcin 
1120eeed21e7SToby Isaac   if (label->bt) {
112163a3b9bcSJacob Faibussowitsch     PetscCheck(!(point < label->pStart) && !(point >= label->pEnd), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label point %" PetscInt_FMT " is not in [%" PetscInt_FMT ", %" PetscInt_FMT ")", point, label->pStart, label->pEnd);
11229566063dSJacob Faibussowitsch     PetscCall(PetscBTClear(label->bt, point - label->pStart));
1123eeed21e7SToby Isaac   }
11240c3c4a36SLisandro Dalcin 
11250c3c4a36SLisandro Dalcin   /* Delete key */
11269566063dSJacob Faibussowitsch   PetscCall(DMLabelMakeInvalid_Private(label, v));
11279566063dSJacob Faibussowitsch   PetscCall(PetscHSetIDel(label->ht[v], point));
11283ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1129c58f1c22SToby Isaac }
1130c58f1c22SToby Isaac 
1131c58f1c22SToby Isaac /*@
113220f4b53cSBarry Smith   DMLabelInsertIS - Set all points in the `IS` to a value
1133c58f1c22SToby Isaac 
113420f4b53cSBarry Smith   Not Collective
11355b5e7992SMatthew G. Knepley 
1136c58f1c22SToby Isaac   Input Parameters:
113720f4b53cSBarry Smith + label - the `DMLabel`
11382fe279fdSBarry Smith . is    - the point `IS`
1139c58f1c22SToby Isaac - value - The point value
1140c58f1c22SToby Isaac 
1141c58f1c22SToby Isaac   Level: intermediate
1142c58f1c22SToby Isaac 
114320f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`, `DMLabelGetValue()`, `DMLabelSetValue()`, `DMLabelClearValue()`
1144c58f1c22SToby Isaac @*/
1145d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelInsertIS(DMLabel label, IS is, PetscInt value)
1146d71ae5a4SJacob Faibussowitsch {
11470c3c4a36SLisandro Dalcin   PetscInt        v, n, p;
1148c58f1c22SToby Isaac   const PetscInt *points;
1149c58f1c22SToby Isaac 
1150c58f1c22SToby Isaac   PetscFunctionBegin;
1151d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
1152c58f1c22SToby Isaac   PetscValidHeaderSpecific(is, IS_CLASSID, 2);
11530c3c4a36SLisandro Dalcin   /* Find label value, add new entry if needed */
11543ba16761SJacob Faibussowitsch   if (value == label->defaultValue) PetscFunctionReturn(PETSC_SUCCESS);
11559f6c5813SMatthew G. Knepley   PetscCheck(!label->readonly, PetscObjectComm((PetscObject)label), PETSC_ERR_ARG_WRONG, "Read-only labels cannot be altered");
11569566063dSJacob Faibussowitsch   PetscCall(DMLabelLookupAddStratum(label, value, &v));
11570c3c4a36SLisandro Dalcin   /* Set keys */
11589566063dSJacob Faibussowitsch   PetscCall(DMLabelMakeInvalid_Private(label, v));
11599566063dSJacob Faibussowitsch   PetscCall(ISGetLocalSize(is, &n));
11609566063dSJacob Faibussowitsch   PetscCall(ISGetIndices(is, &points));
11619566063dSJacob Faibussowitsch   for (p = 0; p < n; ++p) PetscCall(PetscHSetIAdd(label->ht[v], points[p]));
11629566063dSJacob Faibussowitsch   PetscCall(ISRestoreIndices(is, &points));
11633ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1164c58f1c22SToby Isaac }
1165c58f1c22SToby Isaac 
116684f0b6dfSMatthew G. Knepley /*@
116720f4b53cSBarry Smith   DMLabelGetNumValues - Get the number of values that the `DMLabel` takes
116884f0b6dfSMatthew G. Knepley 
116920f4b53cSBarry Smith   Not Collective
11705b5e7992SMatthew G. Knepley 
117184f0b6dfSMatthew G. Knepley   Input Parameter:
117220f4b53cSBarry Smith . label - the `DMLabel`
117384f0b6dfSMatthew G. Knepley 
117401d2d390SJose E. Roman   Output Parameter:
117584f0b6dfSMatthew G. Knepley . numValues - the number of values
117684f0b6dfSMatthew G. Knepley 
117784f0b6dfSMatthew G. Knepley   Level: intermediate
117884f0b6dfSMatthew G. Knepley 
117920f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`, `DMLabelGetValue()`, `DMLabelSetValue()`, `DMLabelClearValue()`
118084f0b6dfSMatthew G. Knepley @*/
1181d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelGetNumValues(DMLabel label, PetscInt *numValues)
1182d71ae5a4SJacob Faibussowitsch {
1183c58f1c22SToby Isaac   PetscFunctionBegin;
1184d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
11854f572ea9SToby Isaac   PetscAssertPointer(numValues, 2);
1186c58f1c22SToby Isaac   *numValues = label->numStrata;
11873ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1188c58f1c22SToby Isaac }
1189c58f1c22SToby Isaac 
119084f0b6dfSMatthew G. Knepley /*@
119120f4b53cSBarry Smith   DMLabelGetValueIS - Get an `IS` of all values that the `DMlabel` takes
119284f0b6dfSMatthew G. Knepley 
119320f4b53cSBarry Smith   Not Collective
11945b5e7992SMatthew G. Knepley 
119584f0b6dfSMatthew G. Knepley   Input Parameter:
119620f4b53cSBarry Smith . label - the `DMLabel`
119784f0b6dfSMatthew G. Knepley 
119801d2d390SJose E. Roman   Output Parameter:
119960225df5SJacob Faibussowitsch . values - the value `IS`
120084f0b6dfSMatthew G. Knepley 
120184f0b6dfSMatthew G. Knepley   Level: intermediate
120284f0b6dfSMatthew G. Knepley 
12031d04cbbeSVaclav Hapla   Notes:
120420f4b53cSBarry Smith   The output `IS` should be destroyed when no longer needed.
120520f4b53cSBarry Smith   Strata which are allocated but empty [`DMLabelGetStratumSize()` yields 0] are counted.
120620f4b53cSBarry Smith   If you need to count only nonempty strata, use `DMLabelGetNonEmptyStratumValuesIS()`.
12071d04cbbeSVaclav Hapla 
120820f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelGetNonEmptyStratumValuesIS()`, `DMLabelCreate()`, `DMLabelGetValue()`, `DMLabelSetValue()`, `DMLabelClearValue()`
120984f0b6dfSMatthew G. Knepley @*/
1210d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelGetValueIS(DMLabel label, IS *values)
1211d71ae5a4SJacob Faibussowitsch {
1212c58f1c22SToby Isaac   PetscFunctionBegin;
1213d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
12144f572ea9SToby Isaac   PetscAssertPointer(values, 2);
12159566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(PETSC_COMM_SELF, label->numStrata, label->stratumValues, PETSC_USE_POINTER, values));
12163ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1217c58f1c22SToby Isaac }
1218c58f1c22SToby Isaac 
121984f0b6dfSMatthew G. Knepley /*@
12208696263dSMatthew G. Knepley   DMLabelGetValueBounds - Return the smallest and largest value in the label
12218696263dSMatthew G. Knepley 
12228696263dSMatthew G. Knepley   Not Collective
12238696263dSMatthew G. Knepley 
12248696263dSMatthew G. Knepley   Input Parameter:
12258696263dSMatthew G. Knepley . label - the `DMLabel`
12268696263dSMatthew G. Knepley 
12278696263dSMatthew G. Knepley   Output Parameters:
12288696263dSMatthew G. Knepley + minValue - The smallest value
12298696263dSMatthew G. Knepley - maxValue - The largest value
12308696263dSMatthew G. Knepley 
12318696263dSMatthew G. Knepley   Level: intermediate
12328696263dSMatthew G. Knepley 
12338696263dSMatthew G. Knepley .seealso: `DMLabel`, `DM`, `DMLabelGetBounds()`, `DMLabelGetValue()`, `DMLabelSetValue()`
12348696263dSMatthew G. Knepley @*/
12358696263dSMatthew G. Knepley PetscErrorCode DMLabelGetValueBounds(DMLabel label, PetscInt *minValue, PetscInt *maxValue)
12368696263dSMatthew G. Knepley {
12378696263dSMatthew G. Knepley   PetscInt min = PETSC_MAX_INT, max = PETSC_MIN_INT;
12388696263dSMatthew G. Knepley 
12398696263dSMatthew G. Knepley   PetscFunctionBegin;
12408696263dSMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
12418696263dSMatthew G. Knepley   for (PetscInt v = 0; v < label->numStrata; ++v) {
12428696263dSMatthew G. Knepley     min = PetscMin(min, label->stratumValues[v]);
12438696263dSMatthew G. Knepley     max = PetscMax(max, label->stratumValues[v]);
12448696263dSMatthew G. Knepley   }
12458696263dSMatthew G. Knepley   if (minValue) {
12468696263dSMatthew G. Knepley     PetscAssertPointer(minValue, 2);
12478696263dSMatthew G. Knepley     *minValue = min;
12488696263dSMatthew G. Knepley   }
12498696263dSMatthew G. Knepley   if (maxValue) {
12508696263dSMatthew G. Knepley     PetscAssertPointer(maxValue, 3);
12518696263dSMatthew G. Knepley     *maxValue = max;
12528696263dSMatthew G. Knepley   }
12538696263dSMatthew G. Knepley   PetscFunctionReturn(PETSC_SUCCESS);
12548696263dSMatthew G. Knepley }
12558696263dSMatthew G. Knepley 
12568696263dSMatthew G. Knepley /*@
125720f4b53cSBarry Smith   DMLabelGetNonEmptyStratumValuesIS - Get an `IS` of all values that the `DMlabel` takes
12581d04cbbeSVaclav Hapla 
125920f4b53cSBarry Smith   Not Collective
12601d04cbbeSVaclav Hapla 
12611d04cbbeSVaclav Hapla   Input Parameter:
126220f4b53cSBarry Smith . label - the `DMLabel`
12631d04cbbeSVaclav Hapla 
1264d5b43468SJose E. Roman   Output Parameter:
126560225df5SJacob Faibussowitsch . values - the value `IS`
12661d04cbbeSVaclav Hapla 
12671d04cbbeSVaclav Hapla   Level: intermediate
12681d04cbbeSVaclav Hapla 
12691d04cbbeSVaclav Hapla   Notes:
127020f4b53cSBarry Smith   The output `IS` should be destroyed when no longer needed.
127120f4b53cSBarry Smith   This is similar to `DMLabelGetValueIS()` but counts only nonempty strata.
12721d04cbbeSVaclav Hapla 
127320f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelGetValueIS()`, `DMLabelCreate()`, `DMLabelGetValue()`, `DMLabelSetValue()`, `DMLabelClearValue()`
12741d04cbbeSVaclav Hapla @*/
1275d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelGetNonEmptyStratumValuesIS(DMLabel label, IS *values)
1276d71ae5a4SJacob Faibussowitsch {
12771d04cbbeSVaclav Hapla   PetscInt  i, j;
12781d04cbbeSVaclav Hapla   PetscInt *valuesArr;
12791d04cbbeSVaclav Hapla 
12801d04cbbeSVaclav Hapla   PetscFunctionBegin;
12811d04cbbeSVaclav Hapla   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
12824f572ea9SToby Isaac   PetscAssertPointer(values, 2);
12839566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(label->numStrata, &valuesArr));
12841d04cbbeSVaclav Hapla   for (i = 0, j = 0; i < label->numStrata; i++) {
12851d04cbbeSVaclav Hapla     PetscInt n;
12861d04cbbeSVaclav Hapla 
12879566063dSJacob Faibussowitsch     PetscCall(DMLabelGetStratumSize_Private(label, i, &n));
12881d04cbbeSVaclav Hapla     if (n) valuesArr[j++] = label->stratumValues[i];
12891d04cbbeSVaclav Hapla   }
12901d04cbbeSVaclav Hapla   if (j == label->numStrata) {
12919566063dSJacob Faibussowitsch     PetscCall(ISCreateGeneral(PETSC_COMM_SELF, label->numStrata, label->stratumValues, PETSC_USE_POINTER, values));
12921d04cbbeSVaclav Hapla   } else {
12939566063dSJacob Faibussowitsch     PetscCall(ISCreateGeneral(PETSC_COMM_SELF, j, valuesArr, PETSC_COPY_VALUES, values));
12941d04cbbeSVaclav Hapla   }
12959566063dSJacob Faibussowitsch   PetscCall(PetscFree(valuesArr));
12963ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
12971d04cbbeSVaclav Hapla }
12981d04cbbeSVaclav Hapla 
12991d04cbbeSVaclav Hapla /*@
130020f4b53cSBarry Smith   DMLabelGetValueIndex - Get the index of a given value in the list of values for the `DMlabel`, or -1 if it is not present
1301d123abd9SMatthew G. Knepley 
130220f4b53cSBarry Smith   Not Collective
1303d123abd9SMatthew G. Knepley 
1304d123abd9SMatthew G. Knepley   Input Parameters:
130520f4b53cSBarry Smith + label - the `DMLabel`
130697bb3fdcSJose E. Roman - value - the value
1307d123abd9SMatthew G. Knepley 
130801d2d390SJose E. Roman   Output Parameter:
1309d123abd9SMatthew G. Knepley . index - the index of value in the list of values
1310d123abd9SMatthew G. Knepley 
1311d123abd9SMatthew G. Knepley   Level: intermediate
1312d123abd9SMatthew G. Knepley 
131320f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelGetValueIS()`, `DMLabelCreate()`, `DMLabelGetValue()`, `DMLabelSetValue()`, `DMLabelClearValue()`
1314d123abd9SMatthew G. Knepley @*/
1315d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelGetValueIndex(DMLabel label, PetscInt value, PetscInt *index)
1316d71ae5a4SJacob Faibussowitsch {
1317d123abd9SMatthew G. Knepley   PetscInt v;
1318d123abd9SMatthew G. Knepley 
1319d123abd9SMatthew G. Knepley   PetscFunctionBegin;
1320d123abd9SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
13214f572ea9SToby Isaac   PetscAssertPointer(index, 3);
1322d123abd9SMatthew G. Knepley   /* Do not assume they are sorted */
13239371c9d4SSatish Balay   for (v = 0; v < label->numStrata; ++v)
13249371c9d4SSatish Balay     if (label->stratumValues[v] == value) break;
1325d123abd9SMatthew G. Knepley   if (v >= label->numStrata) *index = -1;
1326d123abd9SMatthew G. Knepley   else *index = v;
13273ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1328d123abd9SMatthew G. Knepley }
1329d123abd9SMatthew G. Knepley 
1330d123abd9SMatthew G. Knepley /*@
133184f0b6dfSMatthew G. Knepley   DMLabelHasStratum - Determine whether points exist with the given value
133284f0b6dfSMatthew G. Knepley 
133320f4b53cSBarry Smith   Not Collective
13345b5e7992SMatthew G. Knepley 
133584f0b6dfSMatthew G. Knepley   Input Parameters:
133620f4b53cSBarry Smith + label - the `DMLabel`
133784f0b6dfSMatthew G. Knepley - value - the stratum value
133884f0b6dfSMatthew G. Knepley 
133901d2d390SJose E. Roman   Output Parameter:
134084f0b6dfSMatthew G. Knepley . exists - Flag saying whether points exist
134184f0b6dfSMatthew G. Knepley 
134284f0b6dfSMatthew G. Knepley   Level: intermediate
134384f0b6dfSMatthew G. Knepley 
134420f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`, `DMLabelGetValue()`, `DMLabelSetValue()`, `DMLabelClearValue()`
134584f0b6dfSMatthew G. Knepley @*/
1346d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelHasStratum(DMLabel label, PetscInt value, PetscBool *exists)
1347d71ae5a4SJacob Faibussowitsch {
1348fada774cSMatthew G. Knepley   PetscInt v;
1349fada774cSMatthew G. Knepley 
1350fada774cSMatthew G. Knepley   PetscFunctionBegin;
1351d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
13524f572ea9SToby Isaac   PetscAssertPointer(exists, 3);
13539566063dSJacob Faibussowitsch   PetscCall(DMLabelLookupStratum(label, value, &v));
13540c3c4a36SLisandro Dalcin   *exists = v < 0 ? PETSC_FALSE : PETSC_TRUE;
13553ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1356fada774cSMatthew G. Knepley }
1357fada774cSMatthew G. Knepley 
135884f0b6dfSMatthew G. Knepley /*@
135984f0b6dfSMatthew G. Knepley   DMLabelGetStratumSize - Get the size of a stratum
136084f0b6dfSMatthew G. Knepley 
136120f4b53cSBarry Smith   Not Collective
13625b5e7992SMatthew G. Knepley 
136384f0b6dfSMatthew G. Knepley   Input Parameters:
136420f4b53cSBarry Smith + label - the `DMLabel`
136584f0b6dfSMatthew G. Knepley - value - the stratum value
136684f0b6dfSMatthew G. Knepley 
136701d2d390SJose E. Roman   Output Parameter:
136884f0b6dfSMatthew G. Knepley . size - The number of points in the stratum
136984f0b6dfSMatthew G. Knepley 
137084f0b6dfSMatthew G. Knepley   Level: intermediate
137184f0b6dfSMatthew G. Knepley 
137220f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`, `DMLabelGetValue()`, `DMLabelSetValue()`, `DMLabelClearValue()`
137384f0b6dfSMatthew G. Knepley @*/
1374d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelGetStratumSize(DMLabel label, PetscInt value, PetscInt *size)
1375d71ae5a4SJacob Faibussowitsch {
1376c58f1c22SToby Isaac   PetscInt v;
1377c58f1c22SToby Isaac 
1378c58f1c22SToby Isaac   PetscFunctionBegin;
1379d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
13804f572ea9SToby Isaac   PetscAssertPointer(size, 3);
13819566063dSJacob Faibussowitsch   PetscCall(DMLabelLookupStratum(label, value, &v));
13829566063dSJacob Faibussowitsch   PetscCall(DMLabelGetStratumSize_Private(label, v, size));
13833ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1384c58f1c22SToby Isaac }
1385c58f1c22SToby Isaac 
138684f0b6dfSMatthew G. Knepley /*@
138784f0b6dfSMatthew G. Knepley   DMLabelGetStratumBounds - Get the largest and smallest point of a stratum
138884f0b6dfSMatthew G. Knepley 
138920f4b53cSBarry Smith   Not Collective
13905b5e7992SMatthew G. Knepley 
139184f0b6dfSMatthew G. Knepley   Input Parameters:
139220f4b53cSBarry Smith + label - the `DMLabel`
139384f0b6dfSMatthew G. Knepley - value - the stratum value
139484f0b6dfSMatthew G. Knepley 
139501d2d390SJose E. Roman   Output Parameters:
139684f0b6dfSMatthew G. Knepley + start - the smallest point in the stratum
139784f0b6dfSMatthew G. Knepley - end   - the largest point in the stratum
139884f0b6dfSMatthew G. Knepley 
139984f0b6dfSMatthew G. Knepley   Level: intermediate
140084f0b6dfSMatthew G. Knepley 
140120f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`, `DMLabelGetValue()`, `DMLabelSetValue()`, `DMLabelClearValue()`
140284f0b6dfSMatthew G. Knepley @*/
1403d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelGetStratumBounds(DMLabel label, PetscInt value, PetscInt *start, PetscInt *end)
1404d71ae5a4SJacob Faibussowitsch {
14059f6c5813SMatthew G. Knepley   IS       is;
14060c3c4a36SLisandro Dalcin   PetscInt v, min, max;
1407c58f1c22SToby Isaac 
1408c58f1c22SToby Isaac   PetscFunctionBegin;
1409d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
14109371c9d4SSatish Balay   if (start) {
14114f572ea9SToby Isaac     PetscAssertPointer(start, 3);
14129371c9d4SSatish Balay     *start = -1;
14139371c9d4SSatish Balay   }
14149371c9d4SSatish Balay   if (end) {
14154f572ea9SToby Isaac     PetscAssertPointer(end, 4);
14169371c9d4SSatish Balay     *end = -1;
14179371c9d4SSatish Balay   }
14189566063dSJacob Faibussowitsch   PetscCall(DMLabelLookupStratum(label, value, &v));
14193ba16761SJacob Faibussowitsch   if (v < 0) PetscFunctionReturn(PETSC_SUCCESS);
14209566063dSJacob Faibussowitsch   PetscCall(DMLabelMakeValid_Private(label, v));
14213ba16761SJacob Faibussowitsch   if (label->stratumSizes[v] <= 0) PetscFunctionReturn(PETSC_SUCCESS);
14229f6c5813SMatthew G. Knepley   PetscUseTypeMethod(label, getstratumis, v, &is);
14239f6c5813SMatthew G. Knepley   PetscCall(ISGetMinMax(is, &min, &max));
14249f6c5813SMatthew G. Knepley   PetscCall(ISDestroy(&is));
1425d6cb179aSToby Isaac   if (start) *start = min;
1426d6cb179aSToby Isaac   if (end) *end = max + 1;
14273ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1428c58f1c22SToby Isaac }
1429c58f1c22SToby Isaac 
143066976f2fSJacob Faibussowitsch static PetscErrorCode DMLabelGetStratumIS_Concrete(DMLabel label, PetscInt v, IS *pointIS)
14319f6c5813SMatthew G. Knepley {
14329f6c5813SMatthew G. Knepley   PetscFunctionBegin;
14339f6c5813SMatthew G. Knepley   PetscCall(PetscObjectReference((PetscObject)label->points[v]));
14349f6c5813SMatthew G. Knepley   *pointIS = label->points[v];
14353ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
14369f6c5813SMatthew G. Knepley }
14379f6c5813SMatthew G. Knepley 
143884f0b6dfSMatthew G. Knepley /*@
143920f4b53cSBarry Smith   DMLabelGetStratumIS - Get an `IS` with the stratum points
144084f0b6dfSMatthew G. Knepley 
144120f4b53cSBarry Smith   Not Collective
14425b5e7992SMatthew G. Knepley 
144384f0b6dfSMatthew G. Knepley   Input Parameters:
144420f4b53cSBarry Smith + label - the `DMLabel`
144584f0b6dfSMatthew G. Knepley - value - the stratum value
144684f0b6dfSMatthew G. Knepley 
144701d2d390SJose E. Roman   Output Parameter:
144884f0b6dfSMatthew G. Knepley . points - The stratum points
144984f0b6dfSMatthew G. Knepley 
145084f0b6dfSMatthew G. Knepley   Level: intermediate
145184f0b6dfSMatthew G. Knepley 
1452593ce467SVaclav Hapla   Notes:
145320f4b53cSBarry Smith   The output `IS` should be destroyed when no longer needed.
145420f4b53cSBarry Smith   Returns `NULL` if the stratum is empty.
1455593ce467SVaclav Hapla 
145620f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`, `DMLabelGetValue()`, `DMLabelSetValue()`, `DMLabelClearValue()`
145784f0b6dfSMatthew G. Knepley @*/
1458d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelGetStratumIS(DMLabel label, PetscInt value, IS *points)
1459d71ae5a4SJacob Faibussowitsch {
1460c58f1c22SToby Isaac   PetscInt v;
1461c58f1c22SToby Isaac 
1462c58f1c22SToby Isaac   PetscFunctionBegin;
1463d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
14644f572ea9SToby Isaac   PetscAssertPointer(points, 3);
1465c58f1c22SToby Isaac   *points = NULL;
14669566063dSJacob Faibussowitsch   PetscCall(DMLabelLookupStratum(label, value, &v));
14673ba16761SJacob Faibussowitsch   if (v < 0) PetscFunctionReturn(PETSC_SUCCESS);
14689566063dSJacob Faibussowitsch   PetscCall(DMLabelMakeValid_Private(label, v));
14699f6c5813SMatthew G. Knepley   PetscUseTypeMethod(label, getstratumis, v, points);
14703ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1471c58f1c22SToby Isaac }
1472c58f1c22SToby Isaac 
147384f0b6dfSMatthew G. Knepley /*@
147420f4b53cSBarry Smith   DMLabelSetStratumIS - Set the stratum points using an `IS`
147584f0b6dfSMatthew G. Knepley 
147620f4b53cSBarry Smith   Not Collective
14775b5e7992SMatthew G. Knepley 
147884f0b6dfSMatthew G. Knepley   Input Parameters:
147920f4b53cSBarry Smith + label - the `DMLabel`
148084f0b6dfSMatthew G. Knepley . value - the stratum value
148160225df5SJacob Faibussowitsch - is    - The stratum points
148284f0b6dfSMatthew G. Knepley 
148384f0b6dfSMatthew G. Knepley   Level: intermediate
148484f0b6dfSMatthew G. Knepley 
148520f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`, `DMLabelGetValue()`, `DMLabelSetValue()`, `DMLabelClearValue()`
148684f0b6dfSMatthew G. Knepley @*/
1487d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelSetStratumIS(DMLabel label, PetscInt value, IS is)
1488d71ae5a4SJacob Faibussowitsch {
14890c3c4a36SLisandro Dalcin   PetscInt v;
14904de306b1SToby Isaac 
14914de306b1SToby Isaac   PetscFunctionBegin;
1492d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
1493d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(is, IS_CLASSID, 3);
14949f6c5813SMatthew G. Knepley   PetscCheck(!label->readonly, PetscObjectComm((PetscObject)label), PETSC_ERR_ARG_WRONG, "Read-only labels cannot be altered");
14959566063dSJacob Faibussowitsch   PetscCall(DMLabelLookupAddStratum(label, value, &v));
14963ba16761SJacob Faibussowitsch   if (is == label->points[v]) PetscFunctionReturn(PETSC_SUCCESS);
14979566063dSJacob Faibussowitsch   PetscCall(DMLabelClearStratum(label, value));
1498f4f49eeaSPierre Jolivet   PetscCall(ISGetLocalSize(is, &label->stratumSizes[v]));
14999566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)is));
1500f4f49eeaSPierre Jolivet   PetscCall(ISDestroy(&label->points[v]));
15010c3c4a36SLisandro Dalcin   label->points[v]  = is;
15020c3c4a36SLisandro Dalcin   label->validIS[v] = PETSC_TRUE;
15039566063dSJacob Faibussowitsch   PetscCall(PetscObjectStateIncrease((PetscObject)label));
15044de306b1SToby Isaac   if (label->bt) {
15054de306b1SToby Isaac     const PetscInt *points;
15064de306b1SToby Isaac     PetscInt        p;
15074de306b1SToby Isaac 
15089566063dSJacob Faibussowitsch     PetscCall(ISGetIndices(is, &points));
15094de306b1SToby Isaac     for (p = 0; p < label->stratumSizes[v]; ++p) {
15104de306b1SToby Isaac       const PetscInt point = points[p];
15114de306b1SToby Isaac 
151263a3b9bcSJacob Faibussowitsch       PetscCheck(!(point < label->pStart) && !(point >= label->pEnd), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label point %" PetscInt_FMT " is not in [%" PetscInt_FMT ", %" PetscInt_FMT ")", point, label->pStart, label->pEnd);
15139566063dSJacob Faibussowitsch       PetscCall(PetscBTSet(label->bt, point - label->pStart));
15144de306b1SToby Isaac     }
15154de306b1SToby Isaac   }
15163ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
15174de306b1SToby Isaac }
15184de306b1SToby Isaac 
151984f0b6dfSMatthew G. Knepley /*@
152084f0b6dfSMatthew G. Knepley   DMLabelClearStratum - Remove a stratum
15214de306b1SToby Isaac 
152220f4b53cSBarry Smith   Not Collective
15235b5e7992SMatthew G. Knepley 
152484f0b6dfSMatthew G. Knepley   Input Parameters:
152520f4b53cSBarry Smith + label - the `DMLabel`
152684f0b6dfSMatthew G. Knepley - value - the stratum value
152784f0b6dfSMatthew G. Knepley 
152884f0b6dfSMatthew G. Knepley   Level: intermediate
152984f0b6dfSMatthew G. Knepley 
153020f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`, `DMLabelGetValue()`, `DMLabelSetValue()`, `DMLabelClearValue()`
153184f0b6dfSMatthew G. Knepley @*/
1532d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelClearStratum(DMLabel label, PetscInt value)
1533d71ae5a4SJacob Faibussowitsch {
1534c58f1c22SToby Isaac   PetscInt v;
1535c58f1c22SToby Isaac 
1536c58f1c22SToby Isaac   PetscFunctionBegin;
1537d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
15389f6c5813SMatthew G. Knepley   PetscCheck(!label->readonly, PetscObjectComm((PetscObject)label), PETSC_ERR_ARG_WRONG, "Read-only labels cannot be altered");
15399566063dSJacob Faibussowitsch   PetscCall(DMLabelLookupStratum(label, value, &v));
15403ba16761SJacob Faibussowitsch   if (v < 0) PetscFunctionReturn(PETSC_SUCCESS);
15414de306b1SToby Isaac   if (label->validIS[v]) {
15424de306b1SToby Isaac     if (label->bt) {
1543c58f1c22SToby Isaac       PetscInt        i;
1544ad8374ffSToby Isaac       const PetscInt *points;
1545c58f1c22SToby Isaac 
15469566063dSJacob Faibussowitsch       PetscCall(ISGetIndices(label->points[v], &points));
1547c58f1c22SToby Isaac       for (i = 0; i < label->stratumSizes[v]; ++i) {
1548ad8374ffSToby Isaac         const PetscInt point = points[i];
1549c58f1c22SToby Isaac 
155063a3b9bcSJacob Faibussowitsch         PetscCheck(!(point < label->pStart) && !(point >= label->pEnd), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label point %" PetscInt_FMT " is not in [%" PetscInt_FMT ", %" PetscInt_FMT ")", point, label->pStart, label->pEnd);
15519566063dSJacob Faibussowitsch         PetscCall(PetscBTClear(label->bt, point - label->pStart));
1552c58f1c22SToby Isaac       }
15539566063dSJacob Faibussowitsch       PetscCall(ISRestoreIndices(label->points[v], &points));
1554c58f1c22SToby Isaac     }
1555c58f1c22SToby Isaac     label->stratumSizes[v] = 0;
15569566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&label->points[v]));
15579566063dSJacob Faibussowitsch     PetscCall(ISCreateStride(PETSC_COMM_SELF, 0, 0, 1, &label->points[v]));
15589566063dSJacob Faibussowitsch     PetscCall(PetscObjectSetName((PetscObject)label->points[v], "indices"));
15599566063dSJacob Faibussowitsch     PetscCall(PetscObjectStateIncrease((PetscObject)label));
1560c58f1c22SToby Isaac   } else {
15619566063dSJacob Faibussowitsch     PetscCall(PetscHSetIClear(label->ht[v]));
1562c58f1c22SToby Isaac   }
15633ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1564c58f1c22SToby Isaac }
1565c58f1c22SToby Isaac 
156684f0b6dfSMatthew G. Knepley /*@
1567412e9a14SMatthew G. Knepley   DMLabelSetStratumBounds - Efficiently give a contiguous set of points a given label value
1568412e9a14SMatthew G. Knepley 
156920f4b53cSBarry Smith   Not Collective
1570412e9a14SMatthew G. Knepley 
1571412e9a14SMatthew G. Knepley   Input Parameters:
157220f4b53cSBarry Smith + label  - The `DMLabel`
1573412e9a14SMatthew G. Knepley . value  - The label value for all points
1574412e9a14SMatthew G. Knepley . pStart - The first point
1575412e9a14SMatthew G. Knepley - pEnd   - A point beyond all marked points
1576412e9a14SMatthew G. Knepley 
1577412e9a14SMatthew G. Knepley   Level: intermediate
1578412e9a14SMatthew G. Knepley 
157920f4b53cSBarry Smith   Note:
158020f4b53cSBarry Smith   The marks points are [`pStart`, `pEnd`), and only the bounds are stored.
158120f4b53cSBarry Smith 
158220f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`, `DMLabelSetStratumIS()`, `DMLabelGetStratumIS()`
1583412e9a14SMatthew G. Knepley @*/
1584d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelSetStratumBounds(DMLabel label, PetscInt value, PetscInt pStart, PetscInt pEnd)
1585d71ae5a4SJacob Faibussowitsch {
1586412e9a14SMatthew G. Knepley   IS pIS;
1587412e9a14SMatthew G. Knepley 
1588412e9a14SMatthew G. Knepley   PetscFunctionBegin;
15899566063dSJacob Faibussowitsch   PetscCall(ISCreateStride(PETSC_COMM_SELF, pEnd - pStart, pStart, 1, &pIS));
15909566063dSJacob Faibussowitsch   PetscCall(DMLabelSetStratumIS(label, value, pIS));
15919566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&pIS));
15923ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1593412e9a14SMatthew G. Knepley }
1594412e9a14SMatthew G. Knepley 
1595412e9a14SMatthew G. Knepley /*@
1596d123abd9SMatthew G. Knepley   DMLabelGetStratumPointIndex - Get the index of a point in a given stratum
1597d123abd9SMatthew G. Knepley 
159820f4b53cSBarry Smith   Not Collective
1599d123abd9SMatthew G. Knepley 
1600d123abd9SMatthew G. Knepley   Input Parameters:
160120f4b53cSBarry Smith + label - The `DMLabel`
1602d123abd9SMatthew G. Knepley . value - The label value
1603d123abd9SMatthew G. Knepley - p     - A point with this value
1604d123abd9SMatthew G. Knepley 
1605d123abd9SMatthew G. Knepley   Output Parameter:
1606d123abd9SMatthew G. Knepley . index - The index of this point in the stratum, or -1 if the point is not in the stratum or the stratum does not exist
1607d123abd9SMatthew G. Knepley 
1608d123abd9SMatthew G. Knepley   Level: intermediate
1609d123abd9SMatthew G. Knepley 
161020f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelGetValueIndex()`, `DMLabelGetStratumIS()`, `DMLabelCreate()`
1611d123abd9SMatthew G. Knepley @*/
1612d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelGetStratumPointIndex(DMLabel label, PetscInt value, PetscInt p, PetscInt *index)
1613d71ae5a4SJacob Faibussowitsch {
16149f6c5813SMatthew G. Knepley   IS              pointIS;
1615d123abd9SMatthew G. Knepley   const PetscInt *indices;
1616d123abd9SMatthew G. Knepley   PetscInt        v;
1617d123abd9SMatthew G. Knepley 
1618d123abd9SMatthew G. Knepley   PetscFunctionBegin;
1619d123abd9SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
16204f572ea9SToby Isaac   PetscAssertPointer(index, 4);
1621d123abd9SMatthew G. Knepley   *index = -1;
16229566063dSJacob Faibussowitsch   PetscCall(DMLabelLookupStratum(label, value, &v));
16233ba16761SJacob Faibussowitsch   if (v < 0) PetscFunctionReturn(PETSC_SUCCESS);
16249566063dSJacob Faibussowitsch   PetscCall(DMLabelMakeValid_Private(label, v));
16259f6c5813SMatthew G. Knepley   PetscUseTypeMethod(label, getstratumis, v, &pointIS);
16269f6c5813SMatthew G. Knepley   PetscCall(ISGetIndices(pointIS, &indices));
16279566063dSJacob Faibussowitsch   PetscCall(PetscFindInt(p, label->stratumSizes[v], indices, index));
16289f6c5813SMatthew G. Knepley   PetscCall(ISRestoreIndices(pointIS, &indices));
16299f6c5813SMatthew G. Knepley   PetscCall(ISDestroy(&pointIS));
16303ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1631d123abd9SMatthew G. Knepley }
1632d123abd9SMatthew G. Knepley 
1633d123abd9SMatthew G. Knepley /*@
163420f4b53cSBarry Smith   DMLabelFilter - Remove all points outside of [`start`, `end`)
163584f0b6dfSMatthew G. Knepley 
163620f4b53cSBarry Smith   Not Collective
16375b5e7992SMatthew G. Knepley 
163884f0b6dfSMatthew G. Knepley   Input Parameters:
163920f4b53cSBarry Smith + label - the `DMLabel`
164022cd2cdaSVaclav Hapla . start - the first point kept
164122cd2cdaSVaclav Hapla - end   - one more than the last point kept
164284f0b6dfSMatthew G. Knepley 
164384f0b6dfSMatthew G. Knepley   Level: intermediate
164484f0b6dfSMatthew G. Knepley 
164520f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`, `DMLabelGetValue()`, `DMLabelSetValue()`, `DMLabelClearValue()`
164684f0b6dfSMatthew G. Knepley @*/
1647d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelFilter(DMLabel label, PetscInt start, PetscInt end)
1648d71ae5a4SJacob Faibussowitsch {
1649c58f1c22SToby Isaac   PetscInt v;
1650c58f1c22SToby Isaac 
1651c58f1c22SToby Isaac   PetscFunctionBegin;
1652d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
16539f6c5813SMatthew G. Knepley   PetscCheck(!label->readonly, PetscObjectComm((PetscObject)label), PETSC_ERR_ARG_WRONG, "Read-only labels cannot be altered");
16549566063dSJacob Faibussowitsch   PetscCall(DMLabelDestroyIndex(label));
16559566063dSJacob Faibussowitsch   PetscCall(DMLabelMakeAllValid_Private(label));
16569f6c5813SMatthew G. Knepley   for (v = 0; v < label->numStrata; ++v) {
16579f6c5813SMatthew G. Knepley     PetscCall(ISGeneralFilter(label->points[v], start, end));
16589f6c5813SMatthew G. Knepley     PetscCall(ISGetLocalSize(label->points[v], &label->stratumSizes[v]));
16599f6c5813SMatthew G. Knepley   }
16609566063dSJacob Faibussowitsch   PetscCall(DMLabelCreateIndex(label, start, end));
16613ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1662c58f1c22SToby Isaac }
1663c58f1c22SToby Isaac 
166484f0b6dfSMatthew G. Knepley /*@
166584f0b6dfSMatthew G. Knepley   DMLabelPermute - Create a new label with permuted points
166684f0b6dfSMatthew G. Knepley 
166720f4b53cSBarry Smith   Not Collective
16685b5e7992SMatthew G. Knepley 
166984f0b6dfSMatthew G. Knepley   Input Parameters:
167020f4b53cSBarry Smith + label       - the `DMLabel`
167184f0b6dfSMatthew G. Knepley - permutation - the point permutation
167284f0b6dfSMatthew G. Knepley 
167384f0b6dfSMatthew G. Knepley   Output Parameter:
167460225df5SJacob Faibussowitsch . labelNew - the new label containing the permuted points
167584f0b6dfSMatthew G. Knepley 
167684f0b6dfSMatthew G. Knepley   Level: intermediate
167784f0b6dfSMatthew G. Knepley 
167820f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`, `DMLabelGetValue()`, `DMLabelSetValue()`, `DMLabelClearValue()`
167984f0b6dfSMatthew G. Knepley @*/
1680d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelPermute(DMLabel label, IS permutation, DMLabel *labelNew)
1681d71ae5a4SJacob Faibussowitsch {
1682c58f1c22SToby Isaac   const PetscInt *perm;
1683c58f1c22SToby Isaac   PetscInt        numValues, numPoints, v, q;
1684c58f1c22SToby Isaac 
1685c58f1c22SToby Isaac   PetscFunctionBegin;
1686d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
1687d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(permutation, IS_CLASSID, 2);
16889f6c5813SMatthew G. Knepley   PetscCheck(!label->readonly, PetscObjectComm((PetscObject)label), PETSC_ERR_ARG_WRONG, "Read-only labels cannot be altered");
16899566063dSJacob Faibussowitsch   PetscCall(DMLabelMakeAllValid_Private(label));
16909566063dSJacob Faibussowitsch   PetscCall(DMLabelDuplicate(label, labelNew));
16919566063dSJacob Faibussowitsch   PetscCall(DMLabelGetNumValues(*labelNew, &numValues));
16929566063dSJacob Faibussowitsch   PetscCall(ISGetLocalSize(permutation, &numPoints));
16939566063dSJacob Faibussowitsch   PetscCall(ISGetIndices(permutation, &perm));
1694c58f1c22SToby Isaac   for (v = 0; v < numValues; ++v) {
1695c58f1c22SToby Isaac     const PetscInt  size = (*labelNew)->stratumSizes[v];
1696ad8374ffSToby Isaac     const PetscInt *points;
1697ad8374ffSToby Isaac     PetscInt       *pointsNew;
1698c58f1c22SToby Isaac 
16999566063dSJacob Faibussowitsch     PetscCall(ISGetIndices((*labelNew)->points[v], &points));
17009f6c5813SMatthew G. Knepley     PetscCall(PetscCalloc1(size, &pointsNew));
1701c58f1c22SToby Isaac     for (q = 0; q < size; ++q) {
1702ad8374ffSToby Isaac       const PetscInt point = points[q];
1703c58f1c22SToby Isaac 
170463a3b9bcSJacob Faibussowitsch       PetscCheck(!(point < 0) && !(point >= numPoints), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label point %" PetscInt_FMT " is not in [0, %" PetscInt_FMT ") for the remapping", point, numPoints);
1705ad8374ffSToby Isaac       pointsNew[q] = perm[point];
1706c58f1c22SToby Isaac     }
17079566063dSJacob Faibussowitsch     PetscCall(ISRestoreIndices((*labelNew)->points[v], &points));
17089566063dSJacob Faibussowitsch     PetscCall(PetscSortInt(size, pointsNew));
17099566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&((*labelNew)->points[v])));
1710fa8e8ae5SToby Isaac     if (size > 0 && pointsNew[size - 1] == pointsNew[0] + size - 1) {
17119566063dSJacob Faibussowitsch       PetscCall(ISCreateStride(PETSC_COMM_SELF, size, pointsNew[0], 1, &((*labelNew)->points[v])));
17129566063dSJacob Faibussowitsch       PetscCall(PetscFree(pointsNew));
1713fa8e8ae5SToby Isaac     } else {
17149566063dSJacob Faibussowitsch       PetscCall(ISCreateGeneral(PETSC_COMM_SELF, size, pointsNew, PETSC_OWN_POINTER, &((*labelNew)->points[v])));
1715fa8e8ae5SToby Isaac     }
17169566063dSJacob Faibussowitsch     PetscCall(PetscObjectSetName((PetscObject)((*labelNew)->points[v]), "indices"));
1717c58f1c22SToby Isaac   }
17189566063dSJacob Faibussowitsch   PetscCall(ISRestoreIndices(permutation, &perm));
1719c58f1c22SToby Isaac   if (label->bt) {
17209566063dSJacob Faibussowitsch     PetscCall(PetscBTDestroy(&label->bt));
17219566063dSJacob Faibussowitsch     PetscCall(DMLabelCreateIndex(label, label->pStart, label->pEnd));
1722c58f1c22SToby Isaac   }
17233ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1724c58f1c22SToby Isaac }
1725c58f1c22SToby Isaac 
172666976f2fSJacob Faibussowitsch static PetscErrorCode DMLabelDistribute_Internal(DMLabel label, PetscSF sf, PetscSection *leafSection, PetscInt **leafStrata)
1727d71ae5a4SJacob Faibussowitsch {
172826c55118SMichael Lange   MPI_Comm     comm;
1729eb30be1eSVaclav Hapla   PetscInt     s, l, nroots, nleaves, offset, size;
173026c55118SMichael Lange   PetscInt    *remoteOffsets, *rootStrata, *rootIdx;
173126c55118SMichael Lange   PetscSection rootSection;
173226c55118SMichael Lange   PetscSF      labelSF;
173326c55118SMichael Lange 
173426c55118SMichael Lange   PetscFunctionBegin;
17359566063dSJacob Faibussowitsch   if (label) PetscCall(DMLabelMakeAllValid_Private(label));
17369566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)sf, &comm));
173726c55118SMichael Lange   /* Build a section of stratum values per point, generate the according SF
173826c55118SMichael Lange      and distribute point-wise stratum values to leaves. */
17399566063dSJacob Faibussowitsch   PetscCall(PetscSFGetGraph(sf, &nroots, &nleaves, NULL, NULL));
17409566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(comm, &rootSection));
17419566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(rootSection, 0, nroots));
174226c55118SMichael Lange   if (label) {
174326c55118SMichael Lange     for (s = 0; s < label->numStrata; ++s) {
1744ad8374ffSToby Isaac       const PetscInt *points;
1745ad8374ffSToby Isaac 
17469566063dSJacob Faibussowitsch       PetscCall(ISGetIndices(label->points[s], &points));
174748a46eb9SPierre Jolivet       for (l = 0; l < label->stratumSizes[s]; l++) PetscCall(PetscSectionAddDof(rootSection, points[l], 1));
17489566063dSJacob Faibussowitsch       PetscCall(ISRestoreIndices(label->points[s], &points));
174926c55118SMichael Lange     }
175026c55118SMichael Lange   }
17519566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(rootSection));
175226c55118SMichael Lange   /* Create a point-wise array of stratum values */
17539566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetStorageSize(rootSection, &size));
17549566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(size, &rootStrata));
17559566063dSJacob Faibussowitsch   PetscCall(PetscCalloc1(nroots, &rootIdx));
175626c55118SMichael Lange   if (label) {
175726c55118SMichael Lange     for (s = 0; s < label->numStrata; ++s) {
1758ad8374ffSToby Isaac       const PetscInt *points;
1759ad8374ffSToby Isaac 
17609566063dSJacob Faibussowitsch       PetscCall(ISGetIndices(label->points[s], &points));
176126c55118SMichael Lange       for (l = 0; l < label->stratumSizes[s]; l++) {
1762ad8374ffSToby Isaac         const PetscInt p = points[l];
17639566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetOffset(rootSection, p, &offset));
176426c55118SMichael Lange         rootStrata[offset + rootIdx[p]++] = label->stratumValues[s];
176526c55118SMichael Lange       }
17669566063dSJacob Faibussowitsch       PetscCall(ISRestoreIndices(label->points[s], &points));
176726c55118SMichael Lange     }
176826c55118SMichael Lange   }
176926c55118SMichael Lange   /* Build SF that maps label points to remote processes */
17709566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(comm, leafSection));
17719566063dSJacob Faibussowitsch   PetscCall(PetscSFDistributeSection(sf, rootSection, &remoteOffsets, *leafSection));
17729566063dSJacob Faibussowitsch   PetscCall(PetscSFCreateSectionSF(sf, rootSection, remoteOffsets, *leafSection, &labelSF));
17739566063dSJacob Faibussowitsch   PetscCall(PetscFree(remoteOffsets));
177426c55118SMichael Lange   /* Send the strata for each point over the derived SF */
17759566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetStorageSize(*leafSection, &size));
17769566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(size, leafStrata));
17779566063dSJacob Faibussowitsch   PetscCall(PetscSFBcastBegin(labelSF, MPIU_INT, rootStrata, *leafStrata, MPI_REPLACE));
17789566063dSJacob Faibussowitsch   PetscCall(PetscSFBcastEnd(labelSF, MPIU_INT, rootStrata, *leafStrata, MPI_REPLACE));
177926c55118SMichael Lange   /* Clean up */
17809566063dSJacob Faibussowitsch   PetscCall(PetscFree(rootStrata));
17819566063dSJacob Faibussowitsch   PetscCall(PetscFree(rootIdx));
17829566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&rootSection));
17839566063dSJacob Faibussowitsch   PetscCall(PetscSFDestroy(&labelSF));
17843ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
178526c55118SMichael Lange }
178626c55118SMichael Lange 
178784f0b6dfSMatthew G. Knepley /*@
178820f4b53cSBarry Smith   DMLabelDistribute - Create a new label pushed forward over the `PetscSF`
178984f0b6dfSMatthew G. Knepley 
179020f4b53cSBarry Smith   Collective
17915b5e7992SMatthew G. Knepley 
179284f0b6dfSMatthew G. Knepley   Input Parameters:
179320f4b53cSBarry Smith + label - the `DMLabel`
179484f0b6dfSMatthew G. Knepley - sf    - the map from old to new distribution
179584f0b6dfSMatthew G. Knepley 
179684f0b6dfSMatthew G. Knepley   Output Parameter:
179760225df5SJacob Faibussowitsch . labelNew - the new redistributed label
179884f0b6dfSMatthew G. Knepley 
179984f0b6dfSMatthew G. Knepley   Level: intermediate
180084f0b6dfSMatthew G. Knepley 
180120f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`, `DMLabelGetValue()`, `DMLabelSetValue()`, `DMLabelClearValue()`
180284f0b6dfSMatthew G. Knepley @*/
1803d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelDistribute(DMLabel label, PetscSF sf, DMLabel *labelNew)
1804d71ae5a4SJacob Faibussowitsch {
1805c58f1c22SToby Isaac   MPI_Comm     comm;
180626c55118SMichael Lange   PetscSection leafSection;
180726c55118SMichael Lange   PetscInt     p, pStart, pEnd, s, size, dof, offset, stratum;
180826c55118SMichael Lange   PetscInt    *leafStrata, *strataIdx;
1809ad8374ffSToby Isaac   PetscInt   **points;
1810d67d17b1SMatthew G. Knepley   const char  *lname = NULL;
1811c58f1c22SToby Isaac   char        *name;
1812c58f1c22SToby Isaac   PetscInt     nameSize;
1813e8f14785SLisandro Dalcin   PetscHSetI   stratumHash;
1814c58f1c22SToby Isaac   size_t       len = 0;
181526c55118SMichael Lange   PetscMPIInt  rank;
1816c58f1c22SToby Isaac 
1817c58f1c22SToby Isaac   PetscFunctionBegin;
1818d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
1819f018e600SMatthew G. Knepley   if (label) {
1820f018e600SMatthew G. Knepley     PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
18219f6c5813SMatthew G. Knepley     PetscCheck(!label->readonly, PetscObjectComm((PetscObject)label), PETSC_ERR_ARG_WRONG, "Read-only labels cannot be altered");
18229566063dSJacob Faibussowitsch     PetscCall(DMLabelMakeAllValid_Private(label));
1823f018e600SMatthew G. Knepley   }
18249566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)sf, &comm));
18259566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(comm, &rank));
1826c58f1c22SToby Isaac   /* Bcast name */
1827dd400576SPatrick Sanan   if (rank == 0) {
18289566063dSJacob Faibussowitsch     PetscCall(PetscObjectGetName((PetscObject)label, &lname));
18299566063dSJacob Faibussowitsch     PetscCall(PetscStrlen(lname, &len));
1830d67d17b1SMatthew G. Knepley   }
1831c58f1c22SToby Isaac   nameSize = len;
18329566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Bcast(&nameSize, 1, MPIU_INT, 0, comm));
18339566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nameSize + 1, &name));
18349566063dSJacob Faibussowitsch   if (rank == 0) PetscCall(PetscArraycpy(name, lname, nameSize + 1));
18359566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Bcast(name, nameSize + 1, MPI_CHAR, 0, comm));
18369566063dSJacob Faibussowitsch   PetscCall(DMLabelCreate(PETSC_COMM_SELF, name, labelNew));
18379566063dSJacob Faibussowitsch   PetscCall(PetscFree(name));
183877d236dfSMichael Lange   /* Bcast defaultValue */
1839dd400576SPatrick Sanan   if (rank == 0) (*labelNew)->defaultValue = label->defaultValue;
18409566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Bcast(&(*labelNew)->defaultValue, 1, MPIU_INT, 0, comm));
184126c55118SMichael Lange   /* Distribute stratum values over the SF and get the point mapping on the receiver */
18429566063dSJacob Faibussowitsch   PetscCall(DMLabelDistribute_Internal(label, sf, &leafSection, &leafStrata));
18435cbdf6fcSMichael Lange   /* Determine received stratum values and initialise new label*/
18449566063dSJacob Faibussowitsch   PetscCall(PetscHSetICreate(&stratumHash));
18459566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetStorageSize(leafSection, &size));
18469566063dSJacob Faibussowitsch   for (p = 0; p < size; ++p) PetscCall(PetscHSetIAdd(stratumHash, leafStrata[p]));
18479566063dSJacob Faibussowitsch   PetscCall(PetscHSetIGetSize(stratumHash, &(*labelNew)->numStrata));
18489566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1((*labelNew)->numStrata, &(*labelNew)->validIS));
1849ad8374ffSToby Isaac   for (s = 0; s < (*labelNew)->numStrata; ++s) (*labelNew)->validIS[s] = PETSC_TRUE;
18509566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1((*labelNew)->numStrata, &(*labelNew)->stratumValues));
18515cbdf6fcSMichael Lange   /* Turn leafStrata into indices rather than stratum values */
18525cbdf6fcSMichael Lange   offset = 0;
18539566063dSJacob Faibussowitsch   PetscCall(PetscHSetIGetElems(stratumHash, &offset, (*labelNew)->stratumValues));
18549566063dSJacob Faibussowitsch   PetscCall(PetscSortInt((*labelNew)->numStrata, (*labelNew)->stratumValues));
185548a46eb9SPierre Jolivet   for (s = 0; s < (*labelNew)->numStrata; ++s) PetscCall(PetscHMapISet((*labelNew)->hmap, (*labelNew)->stratumValues[s], s));
18565cbdf6fcSMichael Lange   for (p = 0; p < size; ++p) {
1857231b9e6fSMatthew G. Knepley     for (s = 0; s < (*labelNew)->numStrata; ++s) {
18589371c9d4SSatish Balay       if (leafStrata[p] == (*labelNew)->stratumValues[s]) {
18599371c9d4SSatish Balay         leafStrata[p] = s;
18609371c9d4SSatish Balay         break;
18619371c9d4SSatish Balay       }
18625cbdf6fcSMichael Lange     }
18635cbdf6fcSMichael Lange   }
1864c58f1c22SToby Isaac   /* Rebuild the point strata on the receiver */
18659566063dSJacob Faibussowitsch   PetscCall(PetscCalloc1((*labelNew)->numStrata, &(*labelNew)->stratumSizes));
18669566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(leafSection, &pStart, &pEnd));
1867c58f1c22SToby Isaac   for (p = pStart; p < pEnd; p++) {
18689566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(leafSection, p, &dof));
18699566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(leafSection, p, &offset));
1870ad540459SPierre Jolivet     for (s = 0; s < dof; s++) (*labelNew)->stratumSizes[leafStrata[offset + s]]++;
1871c58f1c22SToby Isaac   }
18729566063dSJacob Faibussowitsch   PetscCall(PetscCalloc1((*labelNew)->numStrata, &(*labelNew)->ht));
18739f6c5813SMatthew G. Knepley   PetscCall(PetscCalloc1((*labelNew)->numStrata, &(*labelNew)->points));
18749f6c5813SMatthew G. Knepley   PetscCall(PetscCalloc1((*labelNew)->numStrata, &points));
1875c58f1c22SToby Isaac   for (s = 0; s < (*labelNew)->numStrata; ++s) {
18769566063dSJacob Faibussowitsch     PetscCall(PetscHSetICreate(&(*labelNew)->ht[s]));
1877f4f49eeaSPierre Jolivet     PetscCall(PetscMalloc1((*labelNew)->stratumSizes[s], &points[s]));
1878c58f1c22SToby Isaac   }
1879c58f1c22SToby Isaac   /* Insert points into new strata */
18809566063dSJacob Faibussowitsch   PetscCall(PetscCalloc1((*labelNew)->numStrata, &strataIdx));
18819566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(leafSection, &pStart, &pEnd));
1882c58f1c22SToby Isaac   for (p = pStart; p < pEnd; p++) {
18839566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(leafSection, p, &dof));
18849566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(leafSection, p, &offset));
1885c58f1c22SToby Isaac     for (s = 0; s < dof; s++) {
1886c58f1c22SToby Isaac       stratum                               = leafStrata[offset + s];
1887ad8374ffSToby Isaac       points[stratum][strataIdx[stratum]++] = p;
1888c58f1c22SToby Isaac     }
1889c58f1c22SToby Isaac   }
1890ad8374ffSToby Isaac   for (s = 0; s < (*labelNew)->numStrata; s++) {
1891f4f49eeaSPierre Jolivet     PetscCall(ISCreateGeneral(PETSC_COMM_SELF, (*labelNew)->stratumSizes[s], &points[s][0], PETSC_OWN_POINTER, &((*labelNew)->points[s])));
18929566063dSJacob Faibussowitsch     PetscCall(PetscObjectSetName((PetscObject)((*labelNew)->points[s]), "indices"));
1893ad8374ffSToby Isaac   }
18949566063dSJacob Faibussowitsch   PetscCall(PetscFree(points));
18959566063dSJacob Faibussowitsch   PetscCall(PetscHSetIDestroy(&stratumHash));
18969566063dSJacob Faibussowitsch   PetscCall(PetscFree(leafStrata));
18979566063dSJacob Faibussowitsch   PetscCall(PetscFree(strataIdx));
18989566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&leafSection));
18993ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1900c58f1c22SToby Isaac }
1901c58f1c22SToby Isaac 
19027937d9ceSMichael Lange /*@
19037937d9ceSMichael Lange   DMLabelGather - Gather all label values from leafs into roots
19047937d9ceSMichael Lange 
190520f4b53cSBarry Smith   Collective
19065b5e7992SMatthew G. Knepley 
19077937d9ceSMichael Lange   Input Parameters:
190820f4b53cSBarry Smith + label - the `DMLabel`
190920f4b53cSBarry Smith - sf    - the `PetscSF` communication map
19107937d9ceSMichael Lange 
19112fe279fdSBarry Smith   Output Parameter:
191220f4b53cSBarry Smith . labelNew - the new `DMLabel` with localised leaf values
19137937d9ceSMichael Lange 
19147937d9ceSMichael Lange   Level: developer
19157937d9ceSMichael Lange 
191620f4b53cSBarry Smith   Note:
191720f4b53cSBarry Smith   This is the inverse operation to `DMLabelDistribute()`.
19187937d9ceSMichael Lange 
191920f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelDistribute()`
19207937d9ceSMichael Lange @*/
1921d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelGather(DMLabel label, PetscSF sf, DMLabel *labelNew)
1922d71ae5a4SJacob Faibussowitsch {
19237937d9ceSMichael Lange   MPI_Comm        comm;
19247937d9ceSMichael Lange   PetscSection    rootSection;
19257937d9ceSMichael Lange   PetscSF         sfLabel;
19267937d9ceSMichael Lange   PetscSFNode    *rootPoints, *leafPoints;
19277937d9ceSMichael Lange   PetscInt        p, s, d, nroots, nleaves, nmultiroots, idx, dof, offset;
19287937d9ceSMichael Lange   const PetscInt *rootDegree, *ilocal;
19297937d9ceSMichael Lange   PetscInt       *rootStrata;
1930d67d17b1SMatthew G. Knepley   const char     *lname;
19317937d9ceSMichael Lange   char           *name;
19327937d9ceSMichael Lange   PetscInt        nameSize;
19337937d9ceSMichael Lange   size_t          len = 0;
19349852e123SBarry Smith   PetscMPIInt     rank, size;
19357937d9ceSMichael Lange 
19367937d9ceSMichael Lange   PetscFunctionBegin;
1937d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
1938d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
19399f6c5813SMatthew G. Knepley   PetscCheck(!label->readonly, PetscObjectComm((PetscObject)label), PETSC_ERR_ARG_WRONG, "Read-only labels cannot be altered");
19409566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)sf, &comm));
19419566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(comm, &rank));
19429566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
19437937d9ceSMichael Lange   /* Bcast name */
1944dd400576SPatrick Sanan   if (rank == 0) {
19459566063dSJacob Faibussowitsch     PetscCall(PetscObjectGetName((PetscObject)label, &lname));
19469566063dSJacob Faibussowitsch     PetscCall(PetscStrlen(lname, &len));
1947d67d17b1SMatthew G. Knepley   }
19487937d9ceSMichael Lange   nameSize = len;
19499566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Bcast(&nameSize, 1, MPIU_INT, 0, comm));
19509566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nameSize + 1, &name));
19519566063dSJacob Faibussowitsch   if (rank == 0) PetscCall(PetscArraycpy(name, lname, nameSize + 1));
19529566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Bcast(name, nameSize + 1, MPI_CHAR, 0, comm));
19539566063dSJacob Faibussowitsch   PetscCall(DMLabelCreate(PETSC_COMM_SELF, name, labelNew));
19549566063dSJacob Faibussowitsch   PetscCall(PetscFree(name));
19557937d9ceSMichael Lange   /* Gather rank/index pairs of leaves into local roots to build
19567937d9ceSMichael Lange      an inverse, multi-rooted SF. Note that this ignores local leaf
19577937d9ceSMichael Lange      indexing due to the use of the multiSF in PetscSFGather. */
19589566063dSJacob Faibussowitsch   PetscCall(PetscSFGetGraph(sf, &nroots, &nleaves, &ilocal, NULL));
19599566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nroots, &leafPoints));
1960dc53bc9bSMatthew G. Knepley   for (p = 0; p < nroots; ++p) leafPoints[p].rank = leafPoints[p].index = -1;
19617937d9ceSMichael Lange   for (p = 0; p < nleaves; p++) {
19628212dd46SStefano Zampini     PetscInt ilp = ilocal ? ilocal[p] : p;
19638212dd46SStefano Zampini 
19648212dd46SStefano Zampini     leafPoints[ilp].index = ilp;
19658212dd46SStefano Zampini     leafPoints[ilp].rank  = rank;
19667937d9ceSMichael Lange   }
19679566063dSJacob Faibussowitsch   PetscCall(PetscSFComputeDegreeBegin(sf, &rootDegree));
19689566063dSJacob Faibussowitsch   PetscCall(PetscSFComputeDegreeEnd(sf, &rootDegree));
19697937d9ceSMichael Lange   for (p = 0, nmultiroots = 0; p < nroots; ++p) nmultiroots += rootDegree[p];
19709566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nmultiroots, &rootPoints));
19719566063dSJacob Faibussowitsch   PetscCall(PetscSFGatherBegin(sf, MPIU_2INT, leafPoints, rootPoints));
19729566063dSJacob Faibussowitsch   PetscCall(PetscSFGatherEnd(sf, MPIU_2INT, leafPoints, rootPoints));
19739566063dSJacob Faibussowitsch   PetscCall(PetscSFCreate(comm, &sfLabel));
19749566063dSJacob Faibussowitsch   PetscCall(PetscSFSetGraph(sfLabel, nroots, nmultiroots, NULL, PETSC_OWN_POINTER, rootPoints, PETSC_OWN_POINTER));
19757937d9ceSMichael Lange   /* Migrate label over inverted SF to pull stratum values at leaves into roots. */
19769566063dSJacob Faibussowitsch   PetscCall(DMLabelDistribute_Internal(label, sfLabel, &rootSection, &rootStrata));
19777937d9ceSMichael Lange   /* Rebuild the point strata on the receiver */
19787937d9ceSMichael Lange   for (p = 0, idx = 0; p < nroots; p++) {
19797937d9ceSMichael Lange     for (d = 0; d < rootDegree[p]; d++) {
19809566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(rootSection, idx + d, &dof));
19819566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetOffset(rootSection, idx + d, &offset));
19829566063dSJacob Faibussowitsch       for (s = 0; s < dof; s++) PetscCall(DMLabelSetValue(*labelNew, p, rootStrata[offset + s]));
19837937d9ceSMichael Lange     }
19847937d9ceSMichael Lange     idx += rootDegree[p];
19857937d9ceSMichael Lange   }
19869566063dSJacob Faibussowitsch   PetscCall(PetscFree(leafPoints));
19879566063dSJacob Faibussowitsch   PetscCall(PetscFree(rootStrata));
19889566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&rootSection));
19899566063dSJacob Faibussowitsch   PetscCall(PetscSFDestroy(&sfLabel));
19903ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
19917937d9ceSMichael Lange }
19927937d9ceSMichael Lange 
1993d71ae5a4SJacob Faibussowitsch static PetscErrorCode DMLabelPropagateInit_Internal(DMLabel label, PetscSF pointSF, PetscInt valArray[])
1994d71ae5a4SJacob Faibussowitsch {
1995d42890abSMatthew G. Knepley   const PetscInt *degree;
1996d42890abSMatthew G. Knepley   const PetscInt *points;
1997d42890abSMatthew G. Knepley   PetscInt        Nr, r, Nl, l, val, defVal;
1998d42890abSMatthew G. Knepley 
1999d42890abSMatthew G. Knepley   PetscFunctionBegin;
2000d42890abSMatthew G. Knepley   PetscCall(DMLabelGetDefaultValue(label, &defVal));
2001d42890abSMatthew G. Knepley   /* Add in leaves */
2002d42890abSMatthew G. Knepley   PetscCall(PetscSFGetGraph(pointSF, &Nr, &Nl, &points, NULL));
2003d42890abSMatthew G. Knepley   for (l = 0; l < Nl; ++l) {
2004d42890abSMatthew G. Knepley     PetscCall(DMLabelGetValue(label, points[l], &val));
2005d42890abSMatthew G. Knepley     if (val != defVal) valArray[points[l]] = val;
2006d42890abSMatthew G. Knepley   }
2007d42890abSMatthew G. Knepley   /* Add in shared roots */
2008d42890abSMatthew G. Knepley   PetscCall(PetscSFComputeDegreeBegin(pointSF, &degree));
2009d42890abSMatthew G. Knepley   PetscCall(PetscSFComputeDegreeEnd(pointSF, &degree));
2010d42890abSMatthew G. Knepley   for (r = 0; r < Nr; ++r) {
2011d42890abSMatthew G. Knepley     if (degree[r]) {
2012d42890abSMatthew G. Knepley       PetscCall(DMLabelGetValue(label, r, &val));
2013d42890abSMatthew G. Knepley       if (val != defVal) valArray[r] = val;
2014d42890abSMatthew G. Knepley     }
2015d42890abSMatthew G. Knepley   }
20163ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2017d42890abSMatthew G. Knepley }
2018d42890abSMatthew G. Knepley 
2019d71ae5a4SJacob Faibussowitsch static PetscErrorCode DMLabelPropagateFini_Internal(DMLabel label, PetscSF pointSF, PetscInt valArray[], PetscErrorCode (*markPoint)(DMLabel, PetscInt, PetscInt, void *), void *ctx)
2020d71ae5a4SJacob Faibussowitsch {
2021d42890abSMatthew G. Knepley   const PetscInt *degree;
2022d42890abSMatthew G. Knepley   const PetscInt *points;
2023d42890abSMatthew G. Knepley   PetscInt        Nr, r, Nl, l, val, defVal;
2024d42890abSMatthew G. Knepley 
2025d42890abSMatthew G. Knepley   PetscFunctionBegin;
2026d42890abSMatthew G. Knepley   PetscCall(DMLabelGetDefaultValue(label, &defVal));
2027d42890abSMatthew G. Knepley   /* Read out leaves */
2028d42890abSMatthew G. Knepley   PetscCall(PetscSFGetGraph(pointSF, &Nr, &Nl, &points, NULL));
2029d42890abSMatthew G. Knepley   for (l = 0; l < Nl; ++l) {
2030d42890abSMatthew G. Knepley     const PetscInt p    = points[l];
2031d42890abSMatthew G. Knepley     const PetscInt cval = valArray[p];
2032d42890abSMatthew G. Knepley 
2033d42890abSMatthew G. Knepley     if (cval != defVal) {
2034d42890abSMatthew G. Knepley       PetscCall(DMLabelGetValue(label, p, &val));
2035d42890abSMatthew G. Knepley       if (val == defVal) {
2036d42890abSMatthew G. Knepley         PetscCall(DMLabelSetValue(label, p, cval));
203748a46eb9SPierre Jolivet         if (markPoint) PetscCall((*markPoint)(label, p, cval, ctx));
2038d42890abSMatthew G. Knepley       }
2039d42890abSMatthew G. Knepley     }
2040d42890abSMatthew G. Knepley   }
2041d42890abSMatthew G. Knepley   /* Read out shared roots */
2042d42890abSMatthew G. Knepley   PetscCall(PetscSFComputeDegreeBegin(pointSF, &degree));
2043d42890abSMatthew G. Knepley   PetscCall(PetscSFComputeDegreeEnd(pointSF, &degree));
2044d42890abSMatthew G. Knepley   for (r = 0; r < Nr; ++r) {
2045d42890abSMatthew G. Knepley     if (degree[r]) {
2046d42890abSMatthew G. Knepley       const PetscInt cval = valArray[r];
2047d42890abSMatthew G. Knepley 
2048d42890abSMatthew G. Knepley       if (cval != defVal) {
2049d42890abSMatthew G. Knepley         PetscCall(DMLabelGetValue(label, r, &val));
2050d42890abSMatthew G. Knepley         if (val == defVal) {
2051d42890abSMatthew G. Knepley           PetscCall(DMLabelSetValue(label, r, cval));
205248a46eb9SPierre Jolivet           if (markPoint) PetscCall((*markPoint)(label, r, cval, ctx));
2053d42890abSMatthew G. Knepley         }
2054d42890abSMatthew G. Knepley       }
2055d42890abSMatthew G. Knepley     }
2056d42890abSMatthew G. Knepley   }
20573ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2058d42890abSMatthew G. Knepley }
2059d42890abSMatthew G. Knepley 
2060d42890abSMatthew G. Knepley /*@
2061d42890abSMatthew G. Knepley   DMLabelPropagateBegin - Setup a cycle of label propagation
2062d42890abSMatthew G. Knepley 
206320f4b53cSBarry Smith   Collective
2064d42890abSMatthew G. Knepley 
2065d42890abSMatthew G. Knepley   Input Parameters:
206620f4b53cSBarry Smith + label - The `DMLabel` to propagate across processes
206720f4b53cSBarry Smith - sf    - The `PetscSF` describing parallel layout of the label points
2068d42890abSMatthew G. Knepley 
2069d42890abSMatthew G. Knepley   Level: intermediate
2070d42890abSMatthew G. Knepley 
207120f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelPropagateEnd()`, `DMLabelPropagatePush()`
2072d42890abSMatthew G. Knepley @*/
2073d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelPropagateBegin(DMLabel label, PetscSF sf)
2074d71ae5a4SJacob Faibussowitsch {
2075d42890abSMatthew G. Knepley   PetscInt    Nr, r, defVal;
2076d42890abSMatthew G. Knepley   PetscMPIInt size;
2077d42890abSMatthew G. Knepley 
2078d42890abSMatthew G. Knepley   PetscFunctionBegin;
20799f6c5813SMatthew G. Knepley   PetscCheck(!label->readonly, PetscObjectComm((PetscObject)label), PETSC_ERR_ARG_WRONG, "Read-only labels cannot be altered");
2080d42890abSMatthew G. Knepley   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)sf), &size));
2081d42890abSMatthew G. Knepley   if (size > 1) {
2082d42890abSMatthew G. Knepley     PetscCall(DMLabelGetDefaultValue(label, &defVal));
2083d42890abSMatthew G. Knepley     PetscCall(PetscSFGetGraph(sf, &Nr, NULL, NULL, NULL));
2084d42890abSMatthew G. Knepley     if (Nr >= 0) PetscCall(PetscMalloc1(Nr, &label->propArray));
2085d42890abSMatthew G. Knepley     for (r = 0; r < Nr; ++r) label->propArray[r] = defVal;
2086d42890abSMatthew G. Knepley   }
20873ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2088d42890abSMatthew G. Knepley }
2089d42890abSMatthew G. Knepley 
2090d42890abSMatthew G. Knepley /*@
2091d42890abSMatthew G. Knepley   DMLabelPropagateEnd - Tear down a cycle of label propagation
2092d42890abSMatthew G. Knepley 
209320f4b53cSBarry Smith   Collective
2094d42890abSMatthew G. Knepley 
2095d42890abSMatthew G. Knepley   Input Parameters:
209620f4b53cSBarry Smith + label   - The `DMLabel` to propagate across processes
209760225df5SJacob Faibussowitsch - pointSF - The `PetscSF` describing parallel layout of the label points
2098d42890abSMatthew G. Knepley 
2099d42890abSMatthew G. Knepley   Level: intermediate
2100d42890abSMatthew G. Knepley 
210120f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelPropagateBegin()`, `DMLabelPropagatePush()`
2102d42890abSMatthew G. Knepley @*/
2103d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelPropagateEnd(DMLabel label, PetscSF pointSF)
2104d71ae5a4SJacob Faibussowitsch {
2105d42890abSMatthew G. Knepley   PetscFunctionBegin;
21069f6c5813SMatthew G. Knepley   PetscCheck(!label->readonly, PetscObjectComm((PetscObject)label), PETSC_ERR_ARG_WRONG, "Read-only labels cannot be altered");
2107d42890abSMatthew G. Knepley   PetscCall(PetscFree(label->propArray));
2108d42890abSMatthew G. Knepley   label->propArray = NULL;
21093ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2110d42890abSMatthew G. Knepley }
2111d42890abSMatthew G. Knepley 
2112d42890abSMatthew G. Knepley /*@C
2113d42890abSMatthew G. Knepley   DMLabelPropagatePush - Tear down a cycle of label propagation
2114d42890abSMatthew G. Knepley 
211520f4b53cSBarry Smith   Collective
2116d42890abSMatthew G. Knepley 
2117d42890abSMatthew G. Knepley   Input Parameters:
211820f4b53cSBarry Smith + label     - The `DMLabel` to propagate across processes
2119a4e35b19SJacob Faibussowitsch . pointSF   - The `PetscSF` describing parallel layout of the label points
212020f4b53cSBarry Smith . markPoint - An optional callback that is called when a point is marked, or `NULL`
212120f4b53cSBarry Smith - ctx       - An optional user context for the callback, or `NULL`
2122d42890abSMatthew G. Knepley 
212320f4b53cSBarry Smith   Calling sequence of `markPoint`:
212420f4b53cSBarry Smith + label - The `DMLabel`
2125d42890abSMatthew G. Knepley . p     - The point being marked
2126a4e35b19SJacob Faibussowitsch . val   - The label value for `p`
2127d42890abSMatthew G. Knepley - ctx   - An optional user context
2128d42890abSMatthew G. Knepley 
2129d42890abSMatthew G. Knepley   Level: intermediate
2130d42890abSMatthew G. Knepley 
213120f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelPropagateBegin()`, `DMLabelPropagateEnd()`
2132d42890abSMatthew G. Knepley @*/
2133a4e35b19SJacob Faibussowitsch PetscErrorCode DMLabelPropagatePush(DMLabel label, PetscSF pointSF, PetscErrorCode (*markPoint)(DMLabel label, PetscInt p, PetscInt val, void *ctx), void *ctx)
2134d71ae5a4SJacob Faibussowitsch {
2135c50b2d26SMatthew G. Knepley   PetscInt   *valArray = label->propArray, Nr;
2136d42890abSMatthew G. Knepley   PetscMPIInt size;
2137d42890abSMatthew G. Knepley 
2138d42890abSMatthew G. Knepley   PetscFunctionBegin;
21399f6c5813SMatthew G. Knepley   PetscCheck(!label->readonly, PetscObjectComm((PetscObject)label), PETSC_ERR_ARG_WRONG, "Read-only labels cannot be altered");
2140d42890abSMatthew G. Knepley   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)pointSF), &size));
2141c50b2d26SMatthew G. Knepley   PetscCall(PetscSFGetGraph(pointSF, &Nr, NULL, NULL, NULL));
2142c50b2d26SMatthew G. Knepley   if (size > 1 && Nr >= 0) {
2143d42890abSMatthew G. Knepley     /* Communicate marked edges
2144d42890abSMatthew G. Knepley        The current implementation allocates an array the size of the number of root. We put the label values into the
2145d42890abSMatthew G. Knepley        array, and then call PetscSFReduce()+PetscSFBcast() to make the marks consistent.
2146d42890abSMatthew G. Knepley 
2147d42890abSMatthew G. Knepley        TODO: We could use in-place communication with a different SF
2148d42890abSMatthew G. Knepley        We use MPI_SUM for the Reduce, and check the result against the rootdegree. If sum >= rootdegree+1, then the edge has
2149d42890abSMatthew G. Knepley        already been marked. If not, it might have been handled on the process in this round, but we add it anyway.
2150d42890abSMatthew G. Knepley 
2151d42890abSMatthew G. Knepley        In order to update the queue with the new edges from the label communication, we use BcastAnOp(MPI_SUM), so that new
2152d42890abSMatthew G. Knepley        values will have 1+0=1 and old values will have 1+1=2. Loop over these, resetting the values to 1, and adding any new
2153d42890abSMatthew G. Knepley        edge to the queue.
2154d42890abSMatthew G. Knepley     */
2155d42890abSMatthew G. Knepley     PetscCall(DMLabelPropagateInit_Internal(label, pointSF, valArray));
2156d42890abSMatthew G. Knepley     PetscCall(PetscSFReduceBegin(pointSF, MPIU_INT, valArray, valArray, MPI_MAX));
2157d42890abSMatthew G. Knepley     PetscCall(PetscSFReduceEnd(pointSF, MPIU_INT, valArray, valArray, MPI_MAX));
2158d42890abSMatthew G. Knepley     PetscCall(PetscSFBcastBegin(pointSF, MPIU_INT, valArray, valArray, MPI_REPLACE));
2159d42890abSMatthew G. Knepley     PetscCall(PetscSFBcastEnd(pointSF, MPIU_INT, valArray, valArray, MPI_REPLACE));
2160d42890abSMatthew G. Knepley     PetscCall(DMLabelPropagateFini_Internal(label, pointSF, valArray, markPoint, ctx));
2161d42890abSMatthew G. Knepley   }
21623ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2163d42890abSMatthew G. Knepley }
2164d42890abSMatthew G. Knepley 
216584f0b6dfSMatthew G. Knepley /*@
216620f4b53cSBarry Smith   DMLabelConvertToSection - Make a `PetscSection`/`IS` pair that encodes the label
216784f0b6dfSMatthew G. Knepley 
216820f4b53cSBarry Smith   Not Collective
21695b5e7992SMatthew G. Knepley 
217084f0b6dfSMatthew G. Knepley   Input Parameter:
217120f4b53cSBarry Smith . label - the `DMLabel`
217284f0b6dfSMatthew G. Knepley 
217384f0b6dfSMatthew G. Knepley   Output Parameters:
217484f0b6dfSMatthew G. Knepley + section - the section giving offsets for each stratum
217520f4b53cSBarry Smith - is      - An `IS` containing all the label points
217684f0b6dfSMatthew G. Knepley 
217784f0b6dfSMatthew G. Knepley   Level: developer
217884f0b6dfSMatthew G. Knepley 
217920f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelDistribute()`
218084f0b6dfSMatthew G. Knepley @*/
2181d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelConvertToSection(DMLabel label, PetscSection *section, IS *is)
2182d71ae5a4SJacob Faibussowitsch {
2183c58f1c22SToby Isaac   IS              vIS;
2184c58f1c22SToby Isaac   const PetscInt *values;
2185c58f1c22SToby Isaac   PetscInt       *points;
2186c58f1c22SToby Isaac   PetscInt        nV, vS = 0, vE = 0, v, N;
2187c58f1c22SToby Isaac 
2188c58f1c22SToby Isaac   PetscFunctionBegin;
2189d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
21909566063dSJacob Faibussowitsch   PetscCall(DMLabelGetNumValues(label, &nV));
21919566063dSJacob Faibussowitsch   PetscCall(DMLabelGetValueIS(label, &vIS));
21929566063dSJacob Faibussowitsch   PetscCall(ISGetIndices(vIS, &values));
21939371c9d4SSatish Balay   if (nV) {
21949371c9d4SSatish Balay     vS = values[0];
21959371c9d4SSatish Balay     vE = values[0] + 1;
21969371c9d4SSatish Balay   }
2197c58f1c22SToby Isaac   for (v = 1; v < nV; ++v) {
2198c58f1c22SToby Isaac     vS = PetscMin(vS, values[v]);
2199c58f1c22SToby Isaac     vE = PetscMax(vE, values[v] + 1);
2200c58f1c22SToby Isaac   }
22019566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PETSC_COMM_SELF, section));
22029566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(*section, vS, vE));
2203c58f1c22SToby Isaac   for (v = 0; v < nV; ++v) {
2204c58f1c22SToby Isaac     PetscInt n;
2205c58f1c22SToby Isaac 
22069566063dSJacob Faibussowitsch     PetscCall(DMLabelGetStratumSize(label, values[v], &n));
22079566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(*section, values[v], n));
2208c58f1c22SToby Isaac   }
22099566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(*section));
22109566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetStorageSize(*section, &N));
22119566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(N, &points));
2212c58f1c22SToby Isaac   for (v = 0; v < nV; ++v) {
2213c58f1c22SToby Isaac     IS              is;
2214c58f1c22SToby Isaac     const PetscInt *spoints;
2215c58f1c22SToby Isaac     PetscInt        dof, off, p;
2216c58f1c22SToby Isaac 
22179566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(*section, values[v], &dof));
22189566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(*section, values[v], &off));
22199566063dSJacob Faibussowitsch     PetscCall(DMLabelGetStratumIS(label, values[v], &is));
22209566063dSJacob Faibussowitsch     PetscCall(ISGetIndices(is, &spoints));
2221c58f1c22SToby Isaac     for (p = 0; p < dof; ++p) points[off + p] = spoints[p];
22229566063dSJacob Faibussowitsch     PetscCall(ISRestoreIndices(is, &spoints));
22239566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&is));
2224c58f1c22SToby Isaac   }
22259566063dSJacob Faibussowitsch   PetscCall(ISRestoreIndices(vIS, &values));
22269566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&vIS));
22279566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(PETSC_COMM_SELF, N, points, PETSC_OWN_POINTER, is));
22283ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2229c58f1c22SToby Isaac }
2230c58f1c22SToby Isaac 
22319f6c5813SMatthew G. Knepley /*@C
22329f6c5813SMatthew G. Knepley   DMLabelRegister - Adds a new label component implementation
22339f6c5813SMatthew G. Knepley 
22349f6c5813SMatthew G. Knepley   Not Collective
22359f6c5813SMatthew G. Knepley 
22369f6c5813SMatthew G. Knepley   Input Parameters:
22379f6c5813SMatthew G. Knepley + name        - The name of a new user-defined creation routine
22389f6c5813SMatthew G. Knepley - create_func - The creation routine itself
22399f6c5813SMatthew G. Knepley 
22409f6c5813SMatthew G. Knepley   Notes:
22419f6c5813SMatthew G. Knepley   `DMLabelRegister()` may be called multiple times to add several user-defined labels
22429f6c5813SMatthew G. Knepley 
224360225df5SJacob Faibussowitsch   Example Usage:
22449f6c5813SMatthew G. Knepley .vb
22459f6c5813SMatthew G. Knepley   DMLabelRegister("my_label", MyLabelCreate);
22469f6c5813SMatthew G. Knepley .ve
22479f6c5813SMatthew G. Knepley 
22489f6c5813SMatthew G. Knepley   Then, your label type can be chosen with the procedural interface via
22499f6c5813SMatthew G. Knepley .vb
22509f6c5813SMatthew G. Knepley   DMLabelCreate(MPI_Comm, DMLabel *);
22519f6c5813SMatthew G. Knepley   DMLabelSetType(DMLabel, "my_label");
22529f6c5813SMatthew G. Knepley .ve
22539f6c5813SMatthew G. Knepley   or at runtime via the option
22549f6c5813SMatthew G. Knepley .vb
22559f6c5813SMatthew G. Knepley   -dm_label_type my_label
22569f6c5813SMatthew G. Knepley .ve
22579f6c5813SMatthew G. Knepley 
22589f6c5813SMatthew G. Knepley   Level: advanced
22599f6c5813SMatthew G. Knepley 
226060225df5SJacob Faibussowitsch .seealso: `DMLabel`, `DM`, `DMLabelType`, `DMLabelRegisterAll()`, `DMLabelRegisterDestroy()`
22619f6c5813SMatthew G. Knepley @*/
22629f6c5813SMatthew G. Knepley PetscErrorCode DMLabelRegister(const char name[], PetscErrorCode (*create_func)(DMLabel))
22639f6c5813SMatthew G. Knepley {
22649f6c5813SMatthew G. Knepley   PetscFunctionBegin;
22659f6c5813SMatthew G. Knepley   PetscCall(DMInitializePackage());
22669f6c5813SMatthew G. Knepley   PetscCall(PetscFunctionListAdd(&DMLabelList, name, create_func));
22673ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
22689f6c5813SMatthew G. Knepley }
22699f6c5813SMatthew G. Knepley 
22709f6c5813SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelCreate_Concrete(DMLabel);
22719f6c5813SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelCreate_Ephemeral(DMLabel);
22729f6c5813SMatthew G. Knepley 
22739f6c5813SMatthew G. Knepley /*@C
22749f6c5813SMatthew G. Knepley   DMLabelRegisterAll - Registers all of the `DMLabel` implementations in the `DM` package.
22759f6c5813SMatthew G. Knepley 
22769f6c5813SMatthew G. Knepley   Not Collective
22779f6c5813SMatthew G. Knepley 
22789f6c5813SMatthew G. Knepley   Level: advanced
22799f6c5813SMatthew G. Knepley 
228020f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMRegisterAll()`, `DMLabelRegisterDestroy()`
22819f6c5813SMatthew G. Knepley @*/
22829f6c5813SMatthew G. Knepley PetscErrorCode DMLabelRegisterAll(void)
22839f6c5813SMatthew G. Knepley {
22849f6c5813SMatthew G. Knepley   PetscFunctionBegin;
22853ba16761SJacob Faibussowitsch   if (DMLabelRegisterAllCalled) PetscFunctionReturn(PETSC_SUCCESS);
22869f6c5813SMatthew G. Knepley   DMLabelRegisterAllCalled = PETSC_TRUE;
22879f6c5813SMatthew G. Knepley 
22889f6c5813SMatthew G. Knepley   PetscCall(DMLabelRegister(DMLABELCONCRETE, DMLabelCreate_Concrete));
22899f6c5813SMatthew G. Knepley   PetscCall(DMLabelRegister(DMLABELEPHEMERAL, DMLabelCreate_Ephemeral));
22903ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
22919f6c5813SMatthew G. Knepley }
22929f6c5813SMatthew G. Knepley 
22939f6c5813SMatthew G. Knepley /*@C
22949f6c5813SMatthew G. Knepley   DMLabelRegisterDestroy - This function destroys the `DMLabel` registry. It is called from `PetscFinalize()`.
22959f6c5813SMatthew G. Knepley 
22969f6c5813SMatthew G. Knepley   Level: developer
22979f6c5813SMatthew G. Knepley 
229820f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `PetscInitialize()`
22999f6c5813SMatthew G. Knepley @*/
23009f6c5813SMatthew G. Knepley PetscErrorCode DMLabelRegisterDestroy(void)
23019f6c5813SMatthew G. Knepley {
23029f6c5813SMatthew G. Knepley   PetscFunctionBegin;
23039f6c5813SMatthew G. Knepley   PetscCall(PetscFunctionListDestroy(&DMLabelList));
23049f6c5813SMatthew G. Knepley   DMLabelRegisterAllCalled = PETSC_FALSE;
23053ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23069f6c5813SMatthew G. Knepley }
23079f6c5813SMatthew G. Knepley 
2308cc4c1da9SBarry Smith /*@
23099f6c5813SMatthew G. Knepley   DMLabelSetType - Sets the particular implementation for a label.
23109f6c5813SMatthew G. Knepley 
231120f4b53cSBarry Smith   Collective
23129f6c5813SMatthew G. Knepley 
23139f6c5813SMatthew G. Knepley   Input Parameters:
23149f6c5813SMatthew G. Knepley + label  - The label
23159f6c5813SMatthew G. Knepley - method - The name of the label type
23169f6c5813SMatthew G. Knepley 
23179f6c5813SMatthew G. Knepley   Options Database Key:
231820f4b53cSBarry Smith . -dm_label_type <type> - Sets the label type; use -help for a list of available types or see `DMLabelType`
23199f6c5813SMatthew G. Knepley 
23209f6c5813SMatthew G. Knepley   Level: intermediate
23219f6c5813SMatthew G. Knepley 
232220f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelGetType()`, `DMLabelCreate()`
23239f6c5813SMatthew G. Knepley @*/
23249f6c5813SMatthew G. Knepley PetscErrorCode DMLabelSetType(DMLabel label, DMLabelType method)
23259f6c5813SMatthew G. Knepley {
23269f6c5813SMatthew G. Knepley   PetscErrorCode (*r)(DMLabel);
23279f6c5813SMatthew G. Knepley   PetscBool match;
23289f6c5813SMatthew G. Knepley 
23299f6c5813SMatthew G. Knepley   PetscFunctionBegin;
23309f6c5813SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
23319f6c5813SMatthew G. Knepley   PetscCall(PetscObjectTypeCompare((PetscObject)label, method, &match));
23323ba16761SJacob Faibussowitsch   if (match) PetscFunctionReturn(PETSC_SUCCESS);
23339f6c5813SMatthew G. Knepley 
23349f6c5813SMatthew G. Knepley   PetscCall(DMLabelRegisterAll());
23359f6c5813SMatthew G. Knepley   PetscCall(PetscFunctionListFind(DMLabelList, method, &r));
23369f6c5813SMatthew G. Knepley   PetscCheck(r, PetscObjectComm((PetscObject)label), PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown DMLabel type: %s", method);
23379f6c5813SMatthew G. Knepley 
23389f6c5813SMatthew G. Knepley   PetscTryTypeMethod(label, destroy);
23399f6c5813SMatthew G. Knepley   PetscCall(PetscMemzero(label->ops, sizeof(*label->ops)));
23409f6c5813SMatthew G. Knepley   PetscCall(PetscObjectChangeTypeName((PetscObject)label, method));
23419f6c5813SMatthew G. Knepley   PetscCall((*r)(label));
23423ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23439f6c5813SMatthew G. Knepley }
23449f6c5813SMatthew G. Knepley 
2345cc4c1da9SBarry Smith /*@
23469f6c5813SMatthew G. Knepley   DMLabelGetType - Gets the type name (as a string) from the label.
23479f6c5813SMatthew G. Knepley 
23489f6c5813SMatthew G. Knepley   Not Collective
23499f6c5813SMatthew G. Knepley 
23509f6c5813SMatthew G. Knepley   Input Parameter:
235120f4b53cSBarry Smith . label - The `DMLabel`
23529f6c5813SMatthew G. Knepley 
23539f6c5813SMatthew G. Knepley   Output Parameter:
235420f4b53cSBarry Smith . type - The `DMLabel` type name
23559f6c5813SMatthew G. Knepley 
23569f6c5813SMatthew G. Knepley   Level: intermediate
23579f6c5813SMatthew G. Knepley 
235820f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelSetType()`, `DMLabelCreate()`
23599f6c5813SMatthew G. Knepley @*/
23609f6c5813SMatthew G. Knepley PetscErrorCode DMLabelGetType(DMLabel label, DMLabelType *type)
23619f6c5813SMatthew G. Knepley {
23629f6c5813SMatthew G. Knepley   PetscFunctionBegin;
23639f6c5813SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
23644f572ea9SToby Isaac   PetscAssertPointer(type, 2);
23659f6c5813SMatthew G. Knepley   PetscCall(DMLabelRegisterAll());
23669f6c5813SMatthew G. Knepley   *type = ((PetscObject)label)->type_name;
23673ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23689f6c5813SMatthew G. Knepley }
23699f6c5813SMatthew G. Knepley 
23709f6c5813SMatthew G. Knepley static PetscErrorCode DMLabelInitialize_Concrete(DMLabel label)
23719f6c5813SMatthew G. Knepley {
23729f6c5813SMatthew G. Knepley   PetscFunctionBegin;
23739f6c5813SMatthew G. Knepley   label->ops->view         = DMLabelView_Concrete;
23749f6c5813SMatthew G. Knepley   label->ops->setup        = NULL;
23759f6c5813SMatthew G. Knepley   label->ops->duplicate    = DMLabelDuplicate_Concrete;
23769f6c5813SMatthew G. Knepley   label->ops->getstratumis = DMLabelGetStratumIS_Concrete;
23773ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23789f6c5813SMatthew G. Knepley }
23799f6c5813SMatthew G. Knepley 
23809f6c5813SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelCreate_Concrete(DMLabel label)
23819f6c5813SMatthew G. Knepley {
23829f6c5813SMatthew G. Knepley   PetscFunctionBegin;
23839f6c5813SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
23849f6c5813SMatthew G. Knepley   PetscCall(DMLabelInitialize_Concrete(label));
23853ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23869f6c5813SMatthew G. Knepley }
23879f6c5813SMatthew G. Knepley 
238884f0b6dfSMatthew G. Knepley /*@
2389c58f1c22SToby Isaac   PetscSectionCreateGlobalSectionLabel - Create a section describing the global field layout using
239020f4b53cSBarry Smith   the local section and an `PetscSF` describing the section point overlap.
2391c58f1c22SToby Isaac 
239220f4b53cSBarry Smith   Collective
23935b5e7992SMatthew G. Knepley 
2394c58f1c22SToby Isaac   Input Parameters:
239520f4b53cSBarry Smith + s                  - The `PetscSection` for the local field layout
239620f4b53cSBarry Smith . sf                 - The `PetscSF` describing parallel layout of the section points
239720f4b53cSBarry Smith . includeConstraints - By default this is `PETSC_FALSE`, meaning that the global field vector will not possess constrained dofs
2398c58f1c22SToby Isaac . label              - The label specifying the points
2399c58f1c22SToby Isaac - labelValue         - The label stratum specifying the points
2400c58f1c22SToby Isaac 
2401c58f1c22SToby Isaac   Output Parameter:
240220f4b53cSBarry Smith . gsection - The `PetscSection` for the global field layout
2403c58f1c22SToby Isaac 
2404c58f1c22SToby Isaac   Level: developer
2405c58f1c22SToby Isaac 
240620f4b53cSBarry Smith   Note:
240720f4b53cSBarry Smith   This gives negative sizes and offsets to points not owned by this process
240820f4b53cSBarry Smith 
240920f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `PetscSectionCreate()`
2410c58f1c22SToby Isaac @*/
2411d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionCreateGlobalSectionLabel(PetscSection s, PetscSF sf, PetscBool includeConstraints, DMLabel label, PetscInt labelValue, PetscSection *gsection)
2412d71ae5a4SJacob Faibussowitsch {
2413c58f1c22SToby Isaac   PetscInt *neg = NULL, *tmpOff = NULL;
2414c58f1c22SToby Isaac   PetscInt  pStart, pEnd, p, dof, cdof, off, globalOff = 0, nroots;
2415c58f1c22SToby Isaac 
2416c58f1c22SToby Isaac   PetscFunctionBegin;
2417d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2418d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
2419d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 4);
24209566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject)s), gsection));
24219566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
24229566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(*gsection, pStart, pEnd));
24239566063dSJacob Faibussowitsch   PetscCall(PetscSFGetGraph(sf, &nroots, NULL, NULL, NULL));
2424c58f1c22SToby Isaac   if (nroots >= 0) {
242563a3b9bcSJacob Faibussowitsch     PetscCheck(nroots >= pEnd - pStart, PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "PetscSF nroots %" PetscInt_FMT " < %" PetscInt_FMT " section size", nroots, pEnd - pStart);
24269566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(nroots, &neg));
2427c58f1c22SToby Isaac     if (nroots > pEnd - pStart) {
24289566063dSJacob Faibussowitsch       PetscCall(PetscCalloc1(nroots, &tmpOff));
2429c58f1c22SToby Isaac     } else {
2430c58f1c22SToby Isaac       tmpOff = &(*gsection)->atlasDof[-pStart];
2431c58f1c22SToby Isaac     }
2432c58f1c22SToby Isaac   }
2433c58f1c22SToby Isaac   /* Mark ghost points with negative dof */
2434c58f1c22SToby Isaac   for (p = pStart; p < pEnd; ++p) {
2435c58f1c22SToby Isaac     PetscInt value;
2436c58f1c22SToby Isaac 
24379566063dSJacob Faibussowitsch     PetscCall(DMLabelGetValue(label, p, &value));
2438c58f1c22SToby Isaac     if (value != labelValue) continue;
24399566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s, p, &dof));
24409566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(*gsection, p, dof));
24419566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s, p, &cdof));
24429566063dSJacob Faibussowitsch     if (!includeConstraints && cdof > 0) PetscCall(PetscSectionSetConstraintDof(*gsection, p, cdof));
2443c58f1c22SToby Isaac     if (neg) neg[p] = -(dof + 1);
2444c58f1c22SToby Isaac   }
24459566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUpBC(*gsection));
2446c58f1c22SToby Isaac   if (nroots >= 0) {
24479566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastBegin(sf, MPIU_INT, neg, tmpOff, MPI_REPLACE));
24489566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastEnd(sf, MPIU_INT, neg, tmpOff, MPI_REPLACE));
2449c58f1c22SToby Isaac     if (nroots > pEnd - pStart) {
24509371c9d4SSatish Balay       for (p = pStart; p < pEnd; ++p) {
24519371c9d4SSatish Balay         if (tmpOff[p] < 0) (*gsection)->atlasDof[p - pStart] = tmpOff[p];
24529371c9d4SSatish Balay       }
2453c58f1c22SToby Isaac     }
2454c58f1c22SToby Isaac   }
245535cb6cd3SPierre Jolivet   /* Calculate new sizes, get process offset, and calculate point offsets */
2456c58f1c22SToby Isaac   for (p = 0, off = 0; p < pEnd - pStart; ++p) {
2457c58f1c22SToby Isaac     cdof                     = (!includeConstraints && s->bc) ? s->bc->atlasDof[p] : 0;
2458c58f1c22SToby Isaac     (*gsection)->atlasOff[p] = off;
2459c58f1c22SToby Isaac     off += (*gsection)->atlasDof[p] > 0 ? (*gsection)->atlasDof[p] - cdof : 0;
2460c58f1c22SToby Isaac   }
24619566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Scan(&off, &globalOff, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject)s)));
2462c58f1c22SToby Isaac   globalOff -= off;
2463c58f1c22SToby Isaac   for (p = 0, off = 0; p < pEnd - pStart; ++p) {
2464c58f1c22SToby Isaac     (*gsection)->atlasOff[p] += globalOff;
2465c58f1c22SToby Isaac     if (neg) neg[p] = -((*gsection)->atlasOff[p] + 1);
2466c58f1c22SToby Isaac   }
2467c58f1c22SToby Isaac   /* Put in negative offsets for ghost points */
2468c58f1c22SToby Isaac   if (nroots >= 0) {
24699566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastBegin(sf, MPIU_INT, neg, tmpOff, MPI_REPLACE));
24709566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastEnd(sf, MPIU_INT, neg, tmpOff, MPI_REPLACE));
2471c58f1c22SToby Isaac     if (nroots > pEnd - pStart) {
24729371c9d4SSatish Balay       for (p = pStart; p < pEnd; ++p) {
24739371c9d4SSatish Balay         if (tmpOff[p] < 0) (*gsection)->atlasOff[p - pStart] = tmpOff[p];
24749371c9d4SSatish Balay       }
2475c58f1c22SToby Isaac     }
2476c58f1c22SToby Isaac   }
24779566063dSJacob Faibussowitsch   if (nroots >= 0 && nroots > pEnd - pStart) PetscCall(PetscFree(tmpOff));
24789566063dSJacob Faibussowitsch   PetscCall(PetscFree(neg));
24793ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2480c58f1c22SToby Isaac }
2481c58f1c22SToby Isaac 
24829371c9d4SSatish Balay typedef struct _n_PetscSectionSym_Label {
24835fdea053SToby Isaac   DMLabel              label;
24845fdea053SToby Isaac   PetscCopyMode       *modes;
24855fdea053SToby Isaac   PetscInt            *sizes;
24865fdea053SToby Isaac   const PetscInt    ***perms;
24875fdea053SToby Isaac   const PetscScalar ***rots;
24885fdea053SToby Isaac   PetscInt (*minMaxOrients)[2];
24895fdea053SToby Isaac   PetscInt numStrata; /* numStrata is only increasing, functions as a state */
24905fdea053SToby Isaac } PetscSectionSym_Label;
24915fdea053SToby Isaac 
2492d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscSectionSymLabelReset(PetscSectionSym sym)
2493d71ae5a4SJacob Faibussowitsch {
24945fdea053SToby Isaac   PetscInt               i, j;
24955fdea053SToby Isaac   PetscSectionSym_Label *sl = (PetscSectionSym_Label *)sym->data;
24965fdea053SToby Isaac 
24975fdea053SToby Isaac   PetscFunctionBegin;
24985fdea053SToby Isaac   for (i = 0; i <= sl->numStrata; i++) {
24995fdea053SToby Isaac     if (sl->modes[i] == PETSC_OWN_POINTER || sl->modes[i] == PETSC_COPY_VALUES) {
25005fdea053SToby Isaac       for (j = sl->minMaxOrients[i][0]; j < sl->minMaxOrients[i][1]; j++) {
25019566063dSJacob Faibussowitsch         if (sl->perms[i]) PetscCall(PetscFree(sl->perms[i][j]));
25029566063dSJacob Faibussowitsch         if (sl->rots[i]) PetscCall(PetscFree(sl->rots[i][j]));
25035fdea053SToby Isaac       }
25045fdea053SToby Isaac       if (sl->perms[i]) {
25055fdea053SToby Isaac         const PetscInt **perms = &sl->perms[i][sl->minMaxOrients[i][0]];
25065fdea053SToby Isaac 
25079566063dSJacob Faibussowitsch         PetscCall(PetscFree(perms));
25085fdea053SToby Isaac       }
25095fdea053SToby Isaac       if (sl->rots[i]) {
25105fdea053SToby Isaac         const PetscScalar **rots = &sl->rots[i][sl->minMaxOrients[i][0]];
25115fdea053SToby Isaac 
25129566063dSJacob Faibussowitsch         PetscCall(PetscFree(rots));
25135fdea053SToby Isaac       }
25145fdea053SToby Isaac     }
25155fdea053SToby Isaac   }
25169566063dSJacob Faibussowitsch   PetscCall(PetscFree5(sl->modes, sl->sizes, sl->perms, sl->rots, sl->minMaxOrients));
25179566063dSJacob Faibussowitsch   PetscCall(DMLabelDestroy(&sl->label));
25185fdea053SToby Isaac   sl->numStrata = 0;
25193ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
25205fdea053SToby Isaac }
25215fdea053SToby Isaac 
2522d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscSectionSymDestroy_Label(PetscSectionSym sym)
2523d71ae5a4SJacob Faibussowitsch {
25245fdea053SToby Isaac   PetscFunctionBegin;
25259566063dSJacob Faibussowitsch   PetscCall(PetscSectionSymLabelReset(sym));
25269566063dSJacob Faibussowitsch   PetscCall(PetscFree(sym->data));
25273ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
25285fdea053SToby Isaac }
25295fdea053SToby Isaac 
2530d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscSectionSymView_Label(PetscSectionSym sym, PetscViewer viewer)
2531d71ae5a4SJacob Faibussowitsch {
25325fdea053SToby Isaac   PetscSectionSym_Label *sl = (PetscSectionSym_Label *)sym->data;
25335fdea053SToby Isaac   PetscBool              isAscii;
25345fdea053SToby Isaac   DMLabel                label = sl->label;
2535d67d17b1SMatthew G. Knepley   const char            *name;
25365fdea053SToby Isaac 
25375fdea053SToby Isaac   PetscFunctionBegin;
25389566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &isAscii));
25395fdea053SToby Isaac   if (isAscii) {
25405fdea053SToby Isaac     PetscInt          i, j, k;
25415fdea053SToby Isaac     PetscViewerFormat format;
25425fdea053SToby Isaac 
25439566063dSJacob Faibussowitsch     PetscCall(PetscViewerGetFormat(viewer, &format));
25445fdea053SToby Isaac     if (label) {
25459566063dSJacob Faibussowitsch       PetscCall(PetscViewerGetFormat(viewer, &format));
25465fdea053SToby Isaac       if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
25479566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPushTab(viewer));
25489566063dSJacob Faibussowitsch         PetscCall(DMLabelView(label, viewer));
25499566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPopTab(viewer));
25505fdea053SToby Isaac       } else {
25519566063dSJacob Faibussowitsch         PetscCall(PetscObjectGetName((PetscObject)sl->label, &name));
25529566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  Label '%s'\n", name));
25535fdea053SToby Isaac       }
25545fdea053SToby Isaac     } else {
25559566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "No label given\n"));
25565fdea053SToby Isaac     }
25579566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPushTab(viewer));
25585fdea053SToby Isaac     for (i = 0; i <= sl->numStrata; i++) {
25595fdea053SToby Isaac       PetscInt value = i < sl->numStrata ? label->stratumValues[i] : label->defaultValue;
25605fdea053SToby Isaac 
25615fdea053SToby Isaac       if (!(sl->perms[i] || sl->rots[i])) {
256263a3b9bcSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "Symmetry for stratum value %" PetscInt_FMT " (%" PetscInt_FMT " dofs per point): no symmetries\n", value, sl->sizes[i]));
25635fdea053SToby Isaac       } else {
256463a3b9bcSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "Symmetry for stratum value %" PetscInt_FMT " (%" PetscInt_FMT " dofs per point):\n", value, sl->sizes[i]));
25659566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPushTab(viewer));
256663a3b9bcSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "Orientation range: [%" PetscInt_FMT ", %" PetscInt_FMT ")\n", sl->minMaxOrients[i][0], sl->minMaxOrients[i][1]));
25675fdea053SToby Isaac         if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
25689566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPushTab(viewer));
25695fdea053SToby Isaac           for (j = sl->minMaxOrients[i][0]; j < sl->minMaxOrients[i][1]; j++) {
25705fdea053SToby Isaac             if (!((sl->perms[i] && sl->perms[i][j]) || (sl->rots[i] && sl->rots[i][j]))) {
257163a3b9bcSJacob Faibussowitsch               PetscCall(PetscViewerASCIIPrintf(viewer, "Orientation %" PetscInt_FMT ": identity\n", j));
25725fdea053SToby Isaac             } else {
25735fdea053SToby Isaac               PetscInt tab;
25745fdea053SToby Isaac 
257563a3b9bcSJacob Faibussowitsch               PetscCall(PetscViewerASCIIPrintf(viewer, "Orientation %" PetscInt_FMT ":\n", j));
25769566063dSJacob Faibussowitsch               PetscCall(PetscViewerASCIIPushTab(viewer));
25779566063dSJacob Faibussowitsch               PetscCall(PetscViewerASCIIGetTab(viewer, &tab));
25785fdea053SToby Isaac               if (sl->perms[i] && sl->perms[i][j]) {
25799566063dSJacob Faibussowitsch                 PetscCall(PetscViewerASCIIPrintf(viewer, "Permutation:"));
25809566063dSJacob Faibussowitsch                 PetscCall(PetscViewerASCIISetTab(viewer, 0));
258163a3b9bcSJacob Faibussowitsch                 for (k = 0; k < sl->sizes[i]; k++) PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT, sl->perms[i][j][k]));
25829566063dSJacob Faibussowitsch                 PetscCall(PetscViewerASCIIPrintf(viewer, "\n"));
25839566063dSJacob Faibussowitsch                 PetscCall(PetscViewerASCIISetTab(viewer, tab));
25845fdea053SToby Isaac               }
25855fdea053SToby Isaac               if (sl->rots[i] && sl->rots[i][j]) {
25869566063dSJacob Faibussowitsch                 PetscCall(PetscViewerASCIIPrintf(viewer, "Rotations:  "));
25879566063dSJacob Faibussowitsch                 PetscCall(PetscViewerASCIISetTab(viewer, 0));
25885fdea053SToby Isaac #if defined(PETSC_USE_COMPLEX)
258963a3b9bcSJacob Faibussowitsch                 for (k = 0; k < sl->sizes[i]; k++) PetscCall(PetscViewerASCIIPrintf(viewer, " %+g+i*%+g", (double)PetscRealPart(sl->rots[i][j][k]), (double)PetscImaginaryPart(sl->rots[i][j][k])));
25905fdea053SToby Isaac #else
259163a3b9bcSJacob Faibussowitsch                 for (k = 0; k < sl->sizes[i]; k++) PetscCall(PetscViewerASCIIPrintf(viewer, " %+g", (double)sl->rots[i][j][k]));
25925fdea053SToby Isaac #endif
25939566063dSJacob Faibussowitsch                 PetscCall(PetscViewerASCIIPrintf(viewer, "\n"));
25949566063dSJacob Faibussowitsch                 PetscCall(PetscViewerASCIISetTab(viewer, tab));
25955fdea053SToby Isaac               }
25969566063dSJacob Faibussowitsch               PetscCall(PetscViewerASCIIPopTab(viewer));
25975fdea053SToby Isaac             }
25985fdea053SToby Isaac           }
25999566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPopTab(viewer));
26005fdea053SToby Isaac         }
26019566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPopTab(viewer));
26025fdea053SToby Isaac       }
26035fdea053SToby Isaac     }
26049566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopTab(viewer));
26055fdea053SToby Isaac   }
26063ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
26075fdea053SToby Isaac }
26085fdea053SToby Isaac 
26095fdea053SToby Isaac /*@
26105fdea053SToby Isaac   PetscSectionSymLabelSetLabel - set the label whose strata will define the points that receive symmetries
26115fdea053SToby Isaac 
261220f4b53cSBarry Smith   Logically
26135fdea053SToby Isaac 
261460225df5SJacob Faibussowitsch   Input Parameters:
26155fdea053SToby Isaac + sym   - the section symmetries
261620f4b53cSBarry Smith - label - the `DMLabel` describing the types of points
26175fdea053SToby Isaac 
26185fdea053SToby Isaac   Level: developer:
26195fdea053SToby Isaac 
262020f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `PetscSectionSymLabelSetStratum()`, `PetscSectionSymCreateLabel()`, `PetscSectionGetPointSyms()`
26215fdea053SToby Isaac @*/
2622d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSymLabelSetLabel(PetscSectionSym sym, DMLabel label)
2623d71ae5a4SJacob Faibussowitsch {
26245fdea053SToby Isaac   PetscSectionSym_Label *sl;
26255fdea053SToby Isaac 
26265fdea053SToby Isaac   PetscFunctionBegin;
26275fdea053SToby Isaac   PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID, 1);
26285fdea053SToby Isaac   sl = (PetscSectionSym_Label *)sym->data;
26299566063dSJacob Faibussowitsch   if (sl->label && sl->label != label) PetscCall(PetscSectionSymLabelReset(sym));
26305fdea053SToby Isaac   if (label) {
26315fdea053SToby Isaac     sl->label = label;
26329566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject)label));
26339566063dSJacob Faibussowitsch     PetscCall(DMLabelGetNumValues(label, &sl->numStrata));
26349566063dSJacob Faibussowitsch     PetscCall(PetscMalloc5(sl->numStrata + 1, &sl->modes, sl->numStrata + 1, &sl->sizes, sl->numStrata + 1, &sl->perms, sl->numStrata + 1, &sl->rots, sl->numStrata + 1, &sl->minMaxOrients));
26359566063dSJacob Faibussowitsch     PetscCall(PetscMemzero((void *)sl->modes, (sl->numStrata + 1) * sizeof(PetscCopyMode)));
26369566063dSJacob Faibussowitsch     PetscCall(PetscMemzero((void *)sl->sizes, (sl->numStrata + 1) * sizeof(PetscInt)));
26379566063dSJacob Faibussowitsch     PetscCall(PetscMemzero((void *)sl->perms, (sl->numStrata + 1) * sizeof(const PetscInt **)));
26389566063dSJacob Faibussowitsch     PetscCall(PetscMemzero((void *)sl->rots, (sl->numStrata + 1) * sizeof(const PetscScalar **)));
26399566063dSJacob Faibussowitsch     PetscCall(PetscMemzero((void *)sl->minMaxOrients, (sl->numStrata + 1) * sizeof(PetscInt[2])));
26405fdea053SToby Isaac   }
26413ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
26425fdea053SToby Isaac }
26435fdea053SToby Isaac 
26445fdea053SToby Isaac /*@C
2645b004864fSMatthew G. Knepley   PetscSectionSymLabelGetStratum - get the symmetries for the orientations of a stratum
2646b004864fSMatthew G. Knepley 
264720f4b53cSBarry Smith   Logically Collective
2648b004864fSMatthew G. Knepley 
2649b004864fSMatthew G. Knepley   Input Parameters:
2650b004864fSMatthew G. Knepley + sym     - the section symmetries
2651b004864fSMatthew G. Knepley - stratum - the stratum value in the label that we are assigning symmetries for
2652b004864fSMatthew G. Knepley 
2653b004864fSMatthew G. Knepley   Output Parameters:
265420f4b53cSBarry Smith + size      - the number of dofs for points in the `stratum` of the label
265520f4b53cSBarry Smith . minOrient - the smallest orientation for a point in this `stratum`
265620f4b53cSBarry Smith . maxOrient - one greater than the largest orientation for a ppoint in this `stratum` (i.e., orientations are in the range [`minOrient`, `maxOrient`))
265720f4b53cSBarry Smith . perms     - `NULL` if there are no permutations, or (`maxOrient` - `minOrient`) permutations, one for each orientation.  A `NULL` permutation is the identity
265820f4b53cSBarry Smith - rots      - `NULL` if there are no rotations, or (`maxOrient` - `minOrient`) sets of rotations, one for each orientation.  A `NULL` set of orientations is the identity
2659b004864fSMatthew G. Knepley 
2660b004864fSMatthew G. Knepley   Level: developer
2661b004864fSMatthew G. Knepley 
266220f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `PetscSectionSymLabelSetStratum()`, `PetscSectionSymCreate()`, `PetscSectionSetSym()`, `PetscSectionGetPointSyms()`, `PetscSectionSymCreateLabel()`
2663b004864fSMatthew G. Knepley @*/
2664d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSymLabelGetStratum(PetscSectionSym sym, PetscInt stratum, PetscInt *size, PetscInt *minOrient, PetscInt *maxOrient, const PetscInt ***perms, const PetscScalar ***rots)
2665d71ae5a4SJacob Faibussowitsch {
2666b004864fSMatthew G. Knepley   PetscSectionSym_Label *sl;
2667b004864fSMatthew G. Knepley   const char            *name;
2668b004864fSMatthew G. Knepley   PetscInt               i;
2669b004864fSMatthew G. Knepley 
2670b004864fSMatthew G. Knepley   PetscFunctionBegin;
2671b004864fSMatthew G. Knepley   PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID, 1);
2672b004864fSMatthew G. Knepley   sl = (PetscSectionSym_Label *)sym->data;
2673b004864fSMatthew G. Knepley   PetscCheck(sl->label, PetscObjectComm((PetscObject)sym), PETSC_ERR_ARG_WRONGSTATE, "No label set yet");
2674b004864fSMatthew G. Knepley   for (i = 0; i <= sl->numStrata; i++) {
2675b004864fSMatthew G. Knepley     PetscInt value = (i < sl->numStrata) ? sl->label->stratumValues[i] : sl->label->defaultValue;
2676b004864fSMatthew G. Knepley 
2677b004864fSMatthew G. Knepley     if (stratum == value) break;
2678b004864fSMatthew G. Knepley   }
26799566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetName((PetscObject)sl->label, &name));
2680b004864fSMatthew G. Knepley   PetscCheck(i <= sl->numStrata, PetscObjectComm((PetscObject)sym), PETSC_ERR_ARG_OUTOFRANGE, "Stratum %" PetscInt_FMT " not found in label %s", stratum, name);
26819371c9d4SSatish Balay   if (size) {
26824f572ea9SToby Isaac     PetscAssertPointer(size, 3);
26839371c9d4SSatish Balay     *size = sl->sizes[i];
26849371c9d4SSatish Balay   }
26859371c9d4SSatish Balay   if (minOrient) {
26864f572ea9SToby Isaac     PetscAssertPointer(minOrient, 4);
26879371c9d4SSatish Balay     *minOrient = sl->minMaxOrients[i][0];
26889371c9d4SSatish Balay   }
26899371c9d4SSatish Balay   if (maxOrient) {
26904f572ea9SToby Isaac     PetscAssertPointer(maxOrient, 5);
26919371c9d4SSatish Balay     *maxOrient = sl->minMaxOrients[i][1];
26929371c9d4SSatish Balay   }
26939371c9d4SSatish Balay   if (perms) {
26944f572ea9SToby Isaac     PetscAssertPointer(perms, 6);
26958e3a54c0SPierre Jolivet     *perms = PetscSafePointerPlusOffset(sl->perms[i], sl->minMaxOrients[i][0]);
26969371c9d4SSatish Balay   }
26979371c9d4SSatish Balay   if (rots) {
26984f572ea9SToby Isaac     PetscAssertPointer(rots, 7);
26998e3a54c0SPierre Jolivet     *rots = PetscSafePointerPlusOffset(sl->rots[i], sl->minMaxOrients[i][0]);
27009371c9d4SSatish Balay   }
27013ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2702b004864fSMatthew G. Knepley }
2703b004864fSMatthew G. Knepley 
2704b004864fSMatthew G. Knepley /*@C
27055fdea053SToby Isaac   PetscSectionSymLabelSetStratum - set the symmetries for the orientations of a stratum
27065fdea053SToby Isaac 
270720f4b53cSBarry Smith   Logically
27085fdea053SToby Isaac 
27095fdea053SToby Isaac   Input Parameters:
27105b5e7992SMatthew G. Knepley + sym       - the section symmetries
27115fdea053SToby Isaac . stratum   - the stratum value in the label that we are assigning symmetries for
271220f4b53cSBarry Smith . size      - the number of dofs for points in the `stratum` of the label
271320f4b53cSBarry Smith . minOrient - the smallest orientation for a point in this `stratum`
271420f4b53cSBarry Smith . maxOrient - one greater than the largest orientation for a point in this `stratum` (i.e., orientations are in the range [`minOrient`, `maxOrient`))
271520f4b53cSBarry Smith . mode      - how `sym` should copy the `perms` and `rots` arrays
271620f4b53cSBarry Smith . perms     - `NULL` if there are no permutations, or (`maxOrient` - `minOrient`) permutations, one for each orientation.  A `NULL` permutation is the identity
271720f4b53cSBarry Smith - rots      - `NULL` if there are no rotations, or (`maxOrient` - `minOrient`) sets of rotations, one for each orientation.  A `NULL` set of orientations is the identity
27185fdea053SToby Isaac 
27195fdea053SToby Isaac   Level: developer
27205fdea053SToby Isaac 
272120f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `PetscSectionSymLabelGetStratum()`, `PetscSectionSymCreate()`, `PetscSectionSetSym()`, `PetscSectionGetPointSyms()`, `PetscSectionSymCreateLabel()`
27225fdea053SToby Isaac @*/
2723d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSymLabelSetStratum(PetscSectionSym sym, PetscInt stratum, PetscInt size, PetscInt minOrient, PetscInt maxOrient, PetscCopyMode mode, const PetscInt **perms, const PetscScalar **rots)
2724d71ae5a4SJacob Faibussowitsch {
27255fdea053SToby Isaac   PetscSectionSym_Label *sl;
2726d67d17b1SMatthew G. Knepley   const char            *name;
2727d67d17b1SMatthew G. Knepley   PetscInt               i, j, k;
27285fdea053SToby Isaac 
27295fdea053SToby Isaac   PetscFunctionBegin;
27305fdea053SToby Isaac   PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID, 1);
27315fdea053SToby Isaac   sl = (PetscSectionSym_Label *)sym->data;
2732b004864fSMatthew G. Knepley   PetscCheck(sl->label, PetscObjectComm((PetscObject)sym), PETSC_ERR_ARG_WRONGSTATE, "No label set yet");
27335fdea053SToby Isaac   for (i = 0; i <= sl->numStrata; i++) {
27345fdea053SToby Isaac     PetscInt value = (i < sl->numStrata) ? sl->label->stratumValues[i] : sl->label->defaultValue;
27355fdea053SToby Isaac 
27365fdea053SToby Isaac     if (stratum == value) break;
27375fdea053SToby Isaac   }
27389566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetName((PetscObject)sl->label, &name));
273963a3b9bcSJacob Faibussowitsch   PetscCheck(i <= sl->numStrata, PetscObjectComm((PetscObject)sym), PETSC_ERR_ARG_OUTOFRANGE, "Stratum %" PetscInt_FMT " not found in label %s", stratum, name);
27405fdea053SToby Isaac   sl->sizes[i]            = size;
27415fdea053SToby Isaac   sl->modes[i]            = mode;
27425fdea053SToby Isaac   sl->minMaxOrients[i][0] = minOrient;
27435fdea053SToby Isaac   sl->minMaxOrients[i][1] = maxOrient;
27445fdea053SToby Isaac   if (mode == PETSC_COPY_VALUES) {
27455fdea053SToby Isaac     if (perms) {
27465fdea053SToby Isaac       PetscInt **ownPerms;
27475fdea053SToby Isaac 
27489566063dSJacob Faibussowitsch       PetscCall(PetscCalloc1(maxOrient - minOrient, &ownPerms));
27495fdea053SToby Isaac       for (j = 0; j < maxOrient - minOrient; j++) {
27505fdea053SToby Isaac         if (perms[j]) {
27519566063dSJacob Faibussowitsch           PetscCall(PetscMalloc1(size, &ownPerms[j]));
2752ad540459SPierre Jolivet           for (k = 0; k < size; k++) ownPerms[j][k] = perms[j][k];
27535fdea053SToby Isaac         }
27545fdea053SToby Isaac       }
27555fdea053SToby Isaac       sl->perms[i] = (const PetscInt **)&ownPerms[-minOrient];
27565fdea053SToby Isaac     }
27575fdea053SToby Isaac     if (rots) {
27585fdea053SToby Isaac       PetscScalar **ownRots;
27595fdea053SToby Isaac 
27609566063dSJacob Faibussowitsch       PetscCall(PetscCalloc1(maxOrient - minOrient, &ownRots));
27615fdea053SToby Isaac       for (j = 0; j < maxOrient - minOrient; j++) {
27625fdea053SToby Isaac         if (rots[j]) {
27639566063dSJacob Faibussowitsch           PetscCall(PetscMalloc1(size, &ownRots[j]));
2764ad540459SPierre Jolivet           for (k = 0; k < size; k++) ownRots[j][k] = rots[j][k];
27655fdea053SToby Isaac         }
27665fdea053SToby Isaac       }
27675fdea053SToby Isaac       sl->rots[i] = (const PetscScalar **)&ownRots[-minOrient];
27685fdea053SToby Isaac     }
27695fdea053SToby Isaac   } else {
27708e3a54c0SPierre Jolivet     sl->perms[i] = PetscSafePointerPlusOffset(perms, -minOrient);
27718e3a54c0SPierre Jolivet     sl->rots[i]  = PetscSafePointerPlusOffset(rots, -minOrient);
27725fdea053SToby Isaac   }
27733ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
27745fdea053SToby Isaac }
27755fdea053SToby Isaac 
2776d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscSectionSymGetPoints_Label(PetscSectionSym sym, PetscSection section, PetscInt numPoints, const PetscInt *points, const PetscInt **perms, const PetscScalar **rots)
2777d71ae5a4SJacob Faibussowitsch {
27785fdea053SToby Isaac   PetscInt               i, j, numStrata;
27795fdea053SToby Isaac   PetscSectionSym_Label *sl;
27805fdea053SToby Isaac   DMLabel                label;
27815fdea053SToby Isaac 
27825fdea053SToby Isaac   PetscFunctionBegin;
27835fdea053SToby Isaac   sl        = (PetscSectionSym_Label *)sym->data;
27845fdea053SToby Isaac   numStrata = sl->numStrata;
27855fdea053SToby Isaac   label     = sl->label;
27865fdea053SToby Isaac   for (i = 0; i < numPoints; i++) {
27875fdea053SToby Isaac     PetscInt point = points[2 * i];
27885fdea053SToby Isaac     PetscInt ornt  = points[2 * i + 1];
27895fdea053SToby Isaac 
27905fdea053SToby Isaac     for (j = 0; j < numStrata; j++) {
27915fdea053SToby Isaac       if (label->validIS[j]) {
27925fdea053SToby Isaac         PetscInt k;
27935fdea053SToby Isaac 
27949566063dSJacob Faibussowitsch         PetscCall(ISLocate(label->points[j], point, &k));
27955fdea053SToby Isaac         if (k >= 0) break;
27965fdea053SToby Isaac       } else {
27975fdea053SToby Isaac         PetscBool has;
27985fdea053SToby Isaac 
27999566063dSJacob Faibussowitsch         PetscCall(PetscHSetIHas(label->ht[j], point, &has));
28005fdea053SToby Isaac         if (has) break;
28015fdea053SToby Isaac       }
28025fdea053SToby Isaac     }
28039371c9d4SSatish Balay     PetscCheck(!(sl->minMaxOrients[j][1] > sl->minMaxOrients[j][0]) || !(ornt < sl->minMaxOrients[j][0] || ornt >= sl->minMaxOrients[j][1]), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "point %" PetscInt_FMT " orientation %" PetscInt_FMT " not in range [%" PetscInt_FMT ", %" PetscInt_FMT ") for stratum %" PetscInt_FMT, point, ornt, sl->minMaxOrients[j][0], sl->minMaxOrients[j][1],
28049371c9d4SSatish Balay                j < numStrata ? label->stratumValues[j] : label->defaultValue);
2805ad540459SPierre Jolivet     if (perms) perms[i] = sl->perms[j] ? sl->perms[j][ornt] : NULL;
2806ad540459SPierre Jolivet     if (rots) rots[i] = sl->rots[j] ? sl->rots[j][ornt] : NULL;
28075fdea053SToby Isaac   }
28083ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28095fdea053SToby Isaac }
28105fdea053SToby Isaac 
2811d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscSectionSymCopy_Label(PetscSectionSym sym, PetscSectionSym nsym)
2812d71ae5a4SJacob Faibussowitsch {
2813b004864fSMatthew G. Knepley   PetscSectionSym_Label *sl = (PetscSectionSym_Label *)nsym->data;
2814b004864fSMatthew G. Knepley   IS                     valIS;
2815b004864fSMatthew G. Knepley   const PetscInt        *values;
2816b004864fSMatthew G. Knepley   PetscInt               Nv, v;
2817b004864fSMatthew G. Knepley 
2818b004864fSMatthew G. Knepley   PetscFunctionBegin;
28199566063dSJacob Faibussowitsch   PetscCall(DMLabelGetNumValues(sl->label, &Nv));
28209566063dSJacob Faibussowitsch   PetscCall(DMLabelGetValueIS(sl->label, &valIS));
28219566063dSJacob Faibussowitsch   PetscCall(ISGetIndices(valIS, &values));
2822b004864fSMatthew G. Knepley   for (v = 0; v < Nv; ++v) {
2823b004864fSMatthew G. Knepley     const PetscInt      val = values[v];
2824b004864fSMatthew G. Knepley     PetscInt            size, minOrient, maxOrient;
2825b004864fSMatthew G. Knepley     const PetscInt    **perms;
2826b004864fSMatthew G. Knepley     const PetscScalar **rots;
2827b004864fSMatthew G. Knepley 
28289566063dSJacob Faibussowitsch     PetscCall(PetscSectionSymLabelGetStratum(sym, val, &size, &minOrient, &maxOrient, &perms, &rots));
28299566063dSJacob Faibussowitsch     PetscCall(PetscSectionSymLabelSetStratum(nsym, val, size, minOrient, maxOrient, PETSC_COPY_VALUES, perms, rots));
2830b004864fSMatthew G. Knepley   }
28319566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&valIS));
28323ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2833b004864fSMatthew G. Knepley }
2834b004864fSMatthew G. Knepley 
2835d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscSectionSymDistribute_Label(PetscSectionSym sym, PetscSF migrationSF, PetscSectionSym *dsym)
2836d71ae5a4SJacob Faibussowitsch {
2837b004864fSMatthew G. Knepley   PetscSectionSym_Label *sl = (PetscSectionSym_Label *)sym->data;
2838b004864fSMatthew G. Knepley   DMLabel                dlabel;
2839b004864fSMatthew G. Knepley 
2840b004864fSMatthew G. Knepley   PetscFunctionBegin;
28419566063dSJacob Faibussowitsch   PetscCall(DMLabelDistribute(sl->label, migrationSF, &dlabel));
28429566063dSJacob Faibussowitsch   PetscCall(PetscSectionSymCreateLabel(PetscObjectComm((PetscObject)sym), dlabel, dsym));
28439566063dSJacob Faibussowitsch   PetscCall(DMLabelDestroy(&dlabel));
28449566063dSJacob Faibussowitsch   PetscCall(PetscSectionSymCopy(sym, *dsym));
28453ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2846b004864fSMatthew G. Knepley }
2847b004864fSMatthew G. Knepley 
2848d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSymCreate_Label(PetscSectionSym sym)
2849d71ae5a4SJacob Faibussowitsch {
28505fdea053SToby Isaac   PetscSectionSym_Label *sl;
28515fdea053SToby Isaac 
28525fdea053SToby Isaac   PetscFunctionBegin;
28534dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&sl));
28545fdea053SToby Isaac   sym->ops->getpoints  = PetscSectionSymGetPoints_Label;
2855b004864fSMatthew G. Knepley   sym->ops->distribute = PetscSectionSymDistribute_Label;
2856b004864fSMatthew G. Knepley   sym->ops->copy       = PetscSectionSymCopy_Label;
28575fdea053SToby Isaac   sym->ops->view       = PetscSectionSymView_Label;
28585fdea053SToby Isaac   sym->ops->destroy    = PetscSectionSymDestroy_Label;
28595fdea053SToby Isaac   sym->data            = (void *)sl;
28603ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28615fdea053SToby Isaac }
28625fdea053SToby Isaac 
28635fdea053SToby Isaac /*@
28645fdea053SToby Isaac   PetscSectionSymCreateLabel - Create a section symmetry that assigns one symmetry to each stratum of a label
28655fdea053SToby Isaac 
28665fdea053SToby Isaac   Collective
28675fdea053SToby Isaac 
28685fdea053SToby Isaac   Input Parameters:
28695fdea053SToby Isaac + comm  - the MPI communicator for the new symmetry
28705fdea053SToby Isaac - label - the label defining the strata
28715fdea053SToby Isaac 
28722fe279fdSBarry Smith   Output Parameter:
28735fdea053SToby Isaac . sym - the section symmetries
28745fdea053SToby Isaac 
28755fdea053SToby Isaac   Level: developer
28765fdea053SToby Isaac 
287720f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `PetscSectionSymCreate()`, `PetscSectionSetSym()`, `PetscSectionGetSym()`, `PetscSectionSymLabelSetStratum()`, `PetscSectionGetPointSyms()`
28785fdea053SToby Isaac @*/
2879d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSymCreateLabel(MPI_Comm comm, DMLabel label, PetscSectionSym *sym)
2880d71ae5a4SJacob Faibussowitsch {
28815fdea053SToby Isaac   PetscFunctionBegin;
28829566063dSJacob Faibussowitsch   PetscCall(DMInitializePackage());
28839566063dSJacob Faibussowitsch   PetscCall(PetscSectionSymCreate(comm, sym));
28849566063dSJacob Faibussowitsch   PetscCall(PetscSectionSymSetType(*sym, PETSCSECTIONSYMLABEL));
28859566063dSJacob Faibussowitsch   PetscCall(PetscSectionSymLabelSetLabel(*sym, label));
28863ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28875fdea053SToby Isaac }
2888