xref: /petsc/src/dm/label/dmlabel.c (revision f1d0ab6d209eb362b4079e947dc02fcea0d695b8)
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));
37c58f1c22SToby Isaac   (*label)->numStrata     = 0;
385aa44df4SToby Isaac   (*label)->defaultValue  = -1;
39c58f1c22SToby Isaac   (*label)->stratumValues = NULL;
40ad8374ffSToby Isaac   (*label)->validIS       = NULL;
41c58f1c22SToby Isaac   (*label)->stratumSizes  = NULL;
42c58f1c22SToby Isaac   (*label)->points        = NULL;
43c58f1c22SToby Isaac   (*label)->ht            = NULL;
44c58f1c22SToby Isaac   (*label)->pStart        = -1;
45c58f1c22SToby Isaac   (*label)->pEnd          = -1;
46c58f1c22SToby Isaac   (*label)->bt            = NULL;
479566063dSJacob Faibussowitsch   PetscCall(PetscHMapICreate(&(*label)->hmap));
489566063dSJacob Faibussowitsch   PetscCall(PetscObjectSetName((PetscObject)*label, name));
499f6c5813SMatthew G. Knepley   PetscCall(DMLabelSetType(*label, DMLABELCONCRETE));
503ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
519f6c5813SMatthew G. Knepley }
529f6c5813SMatthew G. Knepley 
53cc4c1da9SBarry Smith /*@
549f6c5813SMatthew G. Knepley   DMLabelSetUp - SetUp a `DMLabel` object
559f6c5813SMatthew G. Knepley 
569f6c5813SMatthew G. Knepley   Collective
579f6c5813SMatthew G. Knepley 
5860225df5SJacob Faibussowitsch   Input Parameters:
599f6c5813SMatthew G. Knepley . label - The `DMLabel`
609f6c5813SMatthew G. Knepley 
619f6c5813SMatthew G. Knepley   Level: intermediate
629f6c5813SMatthew G. Knepley 
6320f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`, `DMLabelDestroy()`
649f6c5813SMatthew G. Knepley @*/
659f6c5813SMatthew G. Knepley PetscErrorCode DMLabelSetUp(DMLabel label)
669f6c5813SMatthew G. Knepley {
679f6c5813SMatthew G. Knepley   PetscFunctionBegin;
689f6c5813SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
699f6c5813SMatthew G. Knepley   PetscTryTypeMethod(label, setup);
703ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
71c58f1c22SToby Isaac }
72c58f1c22SToby Isaac 
73c58f1c22SToby Isaac /*
74c58f1c22SToby Isaac   DMLabelMakeValid_Private - Transfer stratum data from the hash format to the sorted list format
75c58f1c22SToby Isaac 
765b5e7992SMatthew G. Knepley   Not collective
775b5e7992SMatthew G. Knepley 
78c58f1c22SToby Isaac   Input parameter:
7920f4b53cSBarry Smith + label - The `DMLabel`
80c58f1c22SToby Isaac - v - The stratum value
81c58f1c22SToby Isaac 
82c58f1c22SToby Isaac   Output parameter:
8320f4b53cSBarry Smith . label - The `DMLabel` with stratum in sorted list format
84c58f1c22SToby Isaac 
85c58f1c22SToby Isaac   Level: developer
86c58f1c22SToby Isaac 
8720f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`
88c58f1c22SToby Isaac */
89d71ae5a4SJacob Faibussowitsch static PetscErrorCode DMLabelMakeValid_Private(DMLabel label, PetscInt v)
90d71ae5a4SJacob Faibussowitsch {
91277ea44aSLisandro Dalcin   IS       is;
92b9907514SLisandro Dalcin   PetscInt off = 0, *pointArray, p;
93c58f1c22SToby Isaac 
94c58f1c22SToby Isaac   PetscFunctionBegin;
954d86920dSPierre Jolivet   if ((PetscLikely(v >= 0 && v < label->numStrata) && label->validIS[v]) || label->readonly) PetscFunctionReturn(PETSC_SUCCESS);
961dca8a05SBarry 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);
979566063dSJacob Faibussowitsch   PetscCall(PetscHSetIGetSize(label->ht[v], &label->stratumSizes[v]));
989566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(label->stratumSizes[v], &pointArray));
999566063dSJacob Faibussowitsch   PetscCall(PetscHSetIGetElems(label->ht[v], &off, pointArray));
1009566063dSJacob Faibussowitsch   PetscCall(PetscHSetIClear(label->ht[v]));
1019566063dSJacob Faibussowitsch   PetscCall(PetscSortInt(label->stratumSizes[v], pointArray));
102c58f1c22SToby Isaac   if (label->bt) {
103c58f1c22SToby Isaac     for (p = 0; p < label->stratumSizes[v]; ++p) {
104ad8374ffSToby Isaac       const PetscInt point = pointArray[p];
10563a3b9bcSJacob 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);
1069566063dSJacob Faibussowitsch       PetscCall(PetscBTSet(label->bt, point - label->pStart));
107c58f1c22SToby Isaac     }
108c58f1c22SToby Isaac   }
109ba2698f1SMatthew G. Knepley   if (label->stratumSizes[v] > 0 && pointArray[label->stratumSizes[v] - 1] == pointArray[0] + label->stratumSizes[v] - 1) {
1109566063dSJacob Faibussowitsch     PetscCall(ISCreateStride(PETSC_COMM_SELF, label->stratumSizes[v], pointArray[0], 1, &is));
1119566063dSJacob Faibussowitsch     PetscCall(PetscFree(pointArray));
112ba2698f1SMatthew G. Knepley   } else {
1139566063dSJacob Faibussowitsch     PetscCall(ISCreateGeneral(PETSC_COMM_SELF, label->stratumSizes[v], pointArray, PETSC_OWN_POINTER, &is));
114ba2698f1SMatthew G. Knepley   }
115f622de60SMatthew G. Knepley   PetscCall(ISSetInfo(is, IS_SORTED, IS_LOCAL, PETSC_TRUE, PETSC_TRUE));
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 {
4499f196a02SMartin Diehl   PetscBool isascii;
4509f6c5813SMatthew G. Knepley 
4519f6c5813SMatthew G. Knepley   PetscFunctionBegin;
4529f196a02SMartin Diehl   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &isascii));
4539f196a02SMartin Diehl   if (isascii) PetscCall(DMLabelView_Concrete_Ascii(label, viewer));
4543ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
4559f6c5813SMatthew G. Knepley }
4569f6c5813SMatthew G. Knepley 
457ffeef943SBarry 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));
6585440e5dcSBarry Smith     PetscCallMPI(MPIU_Allreduce(MPI_IN_PLACE, &eq, 1, MPI_C_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));
6705440e5dcSBarry Smith     PetscCallMPI(MPIU_Allreduce(MPI_IN_PLACE, &eq, 1, MPI_C_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     }
6945440e5dcSBarry Smith     PetscCallMPI(MPIU_Allreduce(MPI_IN_PLACE, &eq, 1, MPI_C_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 {
7251690c2aeSBarry Smith   PetscInt pStart = PETSC_INT_MAX, 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   }
7431690c2aeSBarry Smith   label->pStart = pStart == PETSC_INT_MAX ? -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 {
900*f1d0ab6dSZach Atkins   PetscInt pStart, pEnd;
901*f1d0ab6dSZach Atkins 
902c58f1c22SToby Isaac   PetscFunctionBeginHot;
903d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
9044f572ea9SToby Isaac   PetscAssertPointer(contains, 3);
905*f1d0ab6dSZach Atkins   /* DMLabelGetBounds() calls DMLabelCreateIndex() only if needed */
906*f1d0ab6dSZach Atkins   PetscCall(DMLabelGetBounds(label, &pStart, &pEnd));
9079566063dSJacob Faibussowitsch   PetscCall(DMLabelMakeAllValid_Private(label));
908*f1d0ab6dSZach Atkins   *contains = point >= pStart && point < pEnd && (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);
9492b4d18a0SMatthew 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);
10452b4d18a0SMatthew G. Knepley       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 
1120*f1d0ab6dSZach Atkins   if (label->bt && point >= label->pStart && point < label->pEnd) PetscCall(PetscBTClear(label->bt, point - label->pStart));
11210c3c4a36SLisandro Dalcin 
11220c3c4a36SLisandro Dalcin   /* Delete key */
11239566063dSJacob Faibussowitsch   PetscCall(DMLabelMakeInvalid_Private(label, v));
11249566063dSJacob Faibussowitsch   PetscCall(PetscHSetIDel(label->ht[v], point));
11253ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1126c58f1c22SToby Isaac }
1127c58f1c22SToby Isaac 
1128c58f1c22SToby Isaac /*@
112920f4b53cSBarry Smith   DMLabelInsertIS - Set all points in the `IS` to a value
1130c58f1c22SToby Isaac 
113120f4b53cSBarry Smith   Not Collective
11325b5e7992SMatthew G. Knepley 
1133c58f1c22SToby Isaac   Input Parameters:
113420f4b53cSBarry Smith + label - the `DMLabel`
11352fe279fdSBarry Smith . is    - the point `IS`
1136c58f1c22SToby Isaac - value - The point value
1137c58f1c22SToby Isaac 
1138c58f1c22SToby Isaac   Level: intermediate
1139c58f1c22SToby Isaac 
114020f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`, `DMLabelGetValue()`, `DMLabelSetValue()`, `DMLabelClearValue()`
1141c58f1c22SToby Isaac @*/
1142d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelInsertIS(DMLabel label, IS is, PetscInt value)
1143d71ae5a4SJacob Faibussowitsch {
11440c3c4a36SLisandro Dalcin   PetscInt        v, n, p;
1145c58f1c22SToby Isaac   const PetscInt *points;
1146c58f1c22SToby Isaac 
1147c58f1c22SToby Isaac   PetscFunctionBegin;
1148d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
1149c58f1c22SToby Isaac   PetscValidHeaderSpecific(is, IS_CLASSID, 2);
11500c3c4a36SLisandro Dalcin   /* Find label value, add new entry if needed */
11513ba16761SJacob Faibussowitsch   if (value == label->defaultValue) PetscFunctionReturn(PETSC_SUCCESS);
11529f6c5813SMatthew G. Knepley   PetscCheck(!label->readonly, PetscObjectComm((PetscObject)label), PETSC_ERR_ARG_WRONG, "Read-only labels cannot be altered");
11539566063dSJacob Faibussowitsch   PetscCall(DMLabelLookupAddStratum(label, value, &v));
11540c3c4a36SLisandro Dalcin   /* Set keys */
11559566063dSJacob Faibussowitsch   PetscCall(DMLabelMakeInvalid_Private(label, v));
11569566063dSJacob Faibussowitsch   PetscCall(ISGetLocalSize(is, &n));
11579566063dSJacob Faibussowitsch   PetscCall(ISGetIndices(is, &points));
11589566063dSJacob Faibussowitsch   for (p = 0; p < n; ++p) PetscCall(PetscHSetIAdd(label->ht[v], points[p]));
11599566063dSJacob Faibussowitsch   PetscCall(ISRestoreIndices(is, &points));
11603ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1161c58f1c22SToby Isaac }
1162c58f1c22SToby Isaac 
116384f0b6dfSMatthew G. Knepley /*@
116420f4b53cSBarry Smith   DMLabelGetNumValues - Get the number of values that the `DMLabel` takes
116584f0b6dfSMatthew G. Knepley 
116620f4b53cSBarry Smith   Not Collective
11675b5e7992SMatthew G. Knepley 
116884f0b6dfSMatthew G. Knepley   Input Parameter:
116920f4b53cSBarry Smith . label - the `DMLabel`
117084f0b6dfSMatthew G. Knepley 
117101d2d390SJose E. Roman   Output Parameter:
117284f0b6dfSMatthew G. Knepley . numValues - the number of values
117384f0b6dfSMatthew G. Knepley 
117484f0b6dfSMatthew G. Knepley   Level: intermediate
117584f0b6dfSMatthew G. Knepley 
117620f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`, `DMLabelGetValue()`, `DMLabelSetValue()`, `DMLabelClearValue()`
117784f0b6dfSMatthew G. Knepley @*/
1178d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelGetNumValues(DMLabel label, PetscInt *numValues)
1179d71ae5a4SJacob Faibussowitsch {
1180c58f1c22SToby Isaac   PetscFunctionBegin;
1181d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
11824f572ea9SToby Isaac   PetscAssertPointer(numValues, 2);
1183c58f1c22SToby Isaac   *numValues = label->numStrata;
11843ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1185c58f1c22SToby Isaac }
1186c58f1c22SToby Isaac 
118784f0b6dfSMatthew G. Knepley /*@
118820f4b53cSBarry Smith   DMLabelGetValueIS - Get an `IS` of all values that the `DMlabel` takes
118984f0b6dfSMatthew G. Knepley 
119020f4b53cSBarry Smith   Not Collective
11915b5e7992SMatthew G. Knepley 
119284f0b6dfSMatthew G. Knepley   Input Parameter:
119320f4b53cSBarry Smith . label - the `DMLabel`
119484f0b6dfSMatthew G. Knepley 
119501d2d390SJose E. Roman   Output Parameter:
119660225df5SJacob Faibussowitsch . values - the value `IS`
119784f0b6dfSMatthew G. Knepley 
119884f0b6dfSMatthew G. Knepley   Level: intermediate
119984f0b6dfSMatthew G. Knepley 
12001d04cbbeSVaclav Hapla   Notes:
120120f4b53cSBarry Smith   The output `IS` should be destroyed when no longer needed.
120220f4b53cSBarry Smith   Strata which are allocated but empty [`DMLabelGetStratumSize()` yields 0] are counted.
120320f4b53cSBarry Smith   If you need to count only nonempty strata, use `DMLabelGetNonEmptyStratumValuesIS()`.
12041d04cbbeSVaclav Hapla 
120520f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelGetNonEmptyStratumValuesIS()`, `DMLabelCreate()`, `DMLabelGetValue()`, `DMLabelSetValue()`, `DMLabelClearValue()`
120684f0b6dfSMatthew G. Knepley @*/
1207d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelGetValueIS(DMLabel label, IS *values)
1208d71ae5a4SJacob Faibussowitsch {
1209c58f1c22SToby Isaac   PetscFunctionBegin;
1210d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
12114f572ea9SToby Isaac   PetscAssertPointer(values, 2);
12129566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(PETSC_COMM_SELF, label->numStrata, label->stratumValues, PETSC_USE_POINTER, values));
12133ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1214c58f1c22SToby Isaac }
1215c58f1c22SToby Isaac 
121684f0b6dfSMatthew G. Knepley /*@
12178696263dSMatthew G. Knepley   DMLabelGetValueBounds - Return the smallest and largest value in the label
12188696263dSMatthew G. Knepley 
12198696263dSMatthew G. Knepley   Not Collective
12208696263dSMatthew G. Knepley 
12218696263dSMatthew G. Knepley   Input Parameter:
12228696263dSMatthew G. Knepley . label - the `DMLabel`
12238696263dSMatthew G. Knepley 
12248696263dSMatthew G. Knepley   Output Parameters:
12258696263dSMatthew G. Knepley + minValue - The smallest value
12268696263dSMatthew G. Knepley - maxValue - The largest value
12278696263dSMatthew G. Knepley 
12288696263dSMatthew G. Knepley   Level: intermediate
12298696263dSMatthew G. Knepley 
12308696263dSMatthew G. Knepley .seealso: `DMLabel`, `DM`, `DMLabelGetBounds()`, `DMLabelGetValue()`, `DMLabelSetValue()`
12318696263dSMatthew G. Knepley @*/
12328696263dSMatthew G. Knepley PetscErrorCode DMLabelGetValueBounds(DMLabel label, PetscInt *minValue, PetscInt *maxValue)
12338696263dSMatthew G. Knepley {
12341690c2aeSBarry Smith   PetscInt min = PETSC_INT_MAX, max = PETSC_INT_MIN;
12358696263dSMatthew G. Knepley 
12368696263dSMatthew G. Knepley   PetscFunctionBegin;
12378696263dSMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
12388696263dSMatthew G. Knepley   for (PetscInt v = 0; v < label->numStrata; ++v) {
12398696263dSMatthew G. Knepley     min = PetscMin(min, label->stratumValues[v]);
12408696263dSMatthew G. Knepley     max = PetscMax(max, label->stratumValues[v]);
12418696263dSMatthew G. Knepley   }
12428696263dSMatthew G. Knepley   if (minValue) {
12438696263dSMatthew G. Knepley     PetscAssertPointer(minValue, 2);
12448696263dSMatthew G. Knepley     *minValue = min;
12458696263dSMatthew G. Knepley   }
12468696263dSMatthew G. Knepley   if (maxValue) {
12478696263dSMatthew G. Knepley     PetscAssertPointer(maxValue, 3);
12488696263dSMatthew G. Knepley     *maxValue = max;
12498696263dSMatthew G. Knepley   }
12508696263dSMatthew G. Knepley   PetscFunctionReturn(PETSC_SUCCESS);
12518696263dSMatthew G. Knepley }
12528696263dSMatthew G. Knepley 
12538696263dSMatthew G. Knepley /*@
125420f4b53cSBarry Smith   DMLabelGetNonEmptyStratumValuesIS - Get an `IS` of all values that the `DMlabel` takes
12551d04cbbeSVaclav Hapla 
125620f4b53cSBarry Smith   Not Collective
12571d04cbbeSVaclav Hapla 
12581d04cbbeSVaclav Hapla   Input Parameter:
125920f4b53cSBarry Smith . label - the `DMLabel`
12601d04cbbeSVaclav Hapla 
1261d5b43468SJose E. Roman   Output Parameter:
126260225df5SJacob Faibussowitsch . values - the value `IS`
12631d04cbbeSVaclav Hapla 
12641d04cbbeSVaclav Hapla   Level: intermediate
12651d04cbbeSVaclav Hapla 
12661d04cbbeSVaclav Hapla   Notes:
126720f4b53cSBarry Smith   The output `IS` should be destroyed when no longer needed.
126820f4b53cSBarry Smith   This is similar to `DMLabelGetValueIS()` but counts only nonempty strata.
12691d04cbbeSVaclav Hapla 
127020f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelGetValueIS()`, `DMLabelCreate()`, `DMLabelGetValue()`, `DMLabelSetValue()`, `DMLabelClearValue()`
12711d04cbbeSVaclav Hapla @*/
1272d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelGetNonEmptyStratumValuesIS(DMLabel label, IS *values)
1273d71ae5a4SJacob Faibussowitsch {
12741d04cbbeSVaclav Hapla   PetscInt  i, j;
12751d04cbbeSVaclav Hapla   PetscInt *valuesArr;
12761d04cbbeSVaclav Hapla 
12771d04cbbeSVaclav Hapla   PetscFunctionBegin;
12781d04cbbeSVaclav Hapla   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
12794f572ea9SToby Isaac   PetscAssertPointer(values, 2);
12809566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(label->numStrata, &valuesArr));
12811d04cbbeSVaclav Hapla   for (i = 0, j = 0; i < label->numStrata; i++) {
12821d04cbbeSVaclav Hapla     PetscInt n;
12831d04cbbeSVaclav Hapla 
12849566063dSJacob Faibussowitsch     PetscCall(DMLabelGetStratumSize_Private(label, i, &n));
12851d04cbbeSVaclav Hapla     if (n) valuesArr[j++] = label->stratumValues[i];
12861d04cbbeSVaclav Hapla   }
12871d04cbbeSVaclav Hapla   if (j == label->numStrata) {
12889566063dSJacob Faibussowitsch     PetscCall(ISCreateGeneral(PETSC_COMM_SELF, label->numStrata, label->stratumValues, PETSC_USE_POINTER, values));
12891d04cbbeSVaclav Hapla   } else {
12909566063dSJacob Faibussowitsch     PetscCall(ISCreateGeneral(PETSC_COMM_SELF, j, valuesArr, PETSC_COPY_VALUES, values));
12911d04cbbeSVaclav Hapla   }
12929566063dSJacob Faibussowitsch   PetscCall(PetscFree(valuesArr));
12933ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
12941d04cbbeSVaclav Hapla }
12951d04cbbeSVaclav Hapla 
12961d04cbbeSVaclav Hapla /*@
129720f4b53cSBarry Smith   DMLabelGetValueIndex - Get the index of a given value in the list of values for the `DMlabel`, or -1 if it is not present
1298d123abd9SMatthew G. Knepley 
129920f4b53cSBarry Smith   Not Collective
1300d123abd9SMatthew G. Knepley 
1301d123abd9SMatthew G. Knepley   Input Parameters:
130220f4b53cSBarry Smith + label - the `DMLabel`
130397bb3fdcSJose E. Roman - value - the value
1304d123abd9SMatthew G. Knepley 
130501d2d390SJose E. Roman   Output Parameter:
1306d123abd9SMatthew G. Knepley . index - the index of value in the list of values
1307d123abd9SMatthew G. Knepley 
1308d123abd9SMatthew G. Knepley   Level: intermediate
1309d123abd9SMatthew G. Knepley 
131020f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelGetValueIS()`, `DMLabelCreate()`, `DMLabelGetValue()`, `DMLabelSetValue()`, `DMLabelClearValue()`
1311d123abd9SMatthew G. Knepley @*/
1312d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelGetValueIndex(DMLabel label, PetscInt value, PetscInt *index)
1313d71ae5a4SJacob Faibussowitsch {
1314d123abd9SMatthew G. Knepley   PetscInt v;
1315d123abd9SMatthew G. Knepley 
1316d123abd9SMatthew G. Knepley   PetscFunctionBegin;
1317d123abd9SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
13184f572ea9SToby Isaac   PetscAssertPointer(index, 3);
1319d123abd9SMatthew G. Knepley   /* Do not assume they are sorted */
13209371c9d4SSatish Balay   for (v = 0; v < label->numStrata; ++v)
13219371c9d4SSatish Balay     if (label->stratumValues[v] == value) break;
1322d123abd9SMatthew G. Knepley   if (v >= label->numStrata) *index = -1;
1323d123abd9SMatthew G. Knepley   else *index = v;
13243ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1325d123abd9SMatthew G. Knepley }
1326d123abd9SMatthew G. Knepley 
1327d123abd9SMatthew G. Knepley /*@
132884f0b6dfSMatthew G. Knepley   DMLabelHasStratum - Determine whether points exist with the given value
132984f0b6dfSMatthew G. Knepley 
133020f4b53cSBarry Smith   Not Collective
13315b5e7992SMatthew G. Knepley 
133284f0b6dfSMatthew G. Knepley   Input Parameters:
133320f4b53cSBarry Smith + label - the `DMLabel`
133484f0b6dfSMatthew G. Knepley - value - the stratum value
133584f0b6dfSMatthew G. Knepley 
133601d2d390SJose E. Roman   Output Parameter:
133784f0b6dfSMatthew G. Knepley . exists - Flag saying whether points exist
133884f0b6dfSMatthew G. Knepley 
133984f0b6dfSMatthew G. Knepley   Level: intermediate
134084f0b6dfSMatthew G. Knepley 
134120f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`, `DMLabelGetValue()`, `DMLabelSetValue()`, `DMLabelClearValue()`
134284f0b6dfSMatthew G. Knepley @*/
1343d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelHasStratum(DMLabel label, PetscInt value, PetscBool *exists)
1344d71ae5a4SJacob Faibussowitsch {
1345fada774cSMatthew G. Knepley   PetscInt v;
1346fada774cSMatthew G. Knepley 
1347fada774cSMatthew G. Knepley   PetscFunctionBegin;
1348d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
13494f572ea9SToby Isaac   PetscAssertPointer(exists, 3);
13509566063dSJacob Faibussowitsch   PetscCall(DMLabelLookupStratum(label, value, &v));
13510c3c4a36SLisandro Dalcin   *exists = v < 0 ? PETSC_FALSE : PETSC_TRUE;
13523ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1353fada774cSMatthew G. Knepley }
1354fada774cSMatthew G. Knepley 
135584f0b6dfSMatthew G. Knepley /*@
135684f0b6dfSMatthew G. Knepley   DMLabelGetStratumSize - Get the size of a stratum
135784f0b6dfSMatthew G. Knepley 
135820f4b53cSBarry Smith   Not Collective
13595b5e7992SMatthew G. Knepley 
136084f0b6dfSMatthew G. Knepley   Input Parameters:
136120f4b53cSBarry Smith + label - the `DMLabel`
136284f0b6dfSMatthew G. Knepley - value - the stratum value
136384f0b6dfSMatthew G. Knepley 
136401d2d390SJose E. Roman   Output Parameter:
136584f0b6dfSMatthew G. Knepley . size - The number of points in the stratum
136684f0b6dfSMatthew G. Knepley 
136784f0b6dfSMatthew G. Knepley   Level: intermediate
136884f0b6dfSMatthew G. Knepley 
136920f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`, `DMLabelGetValue()`, `DMLabelSetValue()`, `DMLabelClearValue()`
137084f0b6dfSMatthew G. Knepley @*/
1371d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelGetStratumSize(DMLabel label, PetscInt value, PetscInt *size)
1372d71ae5a4SJacob Faibussowitsch {
1373c58f1c22SToby Isaac   PetscInt v;
1374c58f1c22SToby Isaac 
1375c58f1c22SToby Isaac   PetscFunctionBegin;
1376d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
13774f572ea9SToby Isaac   PetscAssertPointer(size, 3);
13789566063dSJacob Faibussowitsch   PetscCall(DMLabelLookupStratum(label, value, &v));
13799566063dSJacob Faibussowitsch   PetscCall(DMLabelGetStratumSize_Private(label, v, size));
13803ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1381c58f1c22SToby Isaac }
1382c58f1c22SToby Isaac 
138384f0b6dfSMatthew G. Knepley /*@
138484f0b6dfSMatthew G. Knepley   DMLabelGetStratumBounds - Get the largest and smallest point of a stratum
138584f0b6dfSMatthew G. Knepley 
138620f4b53cSBarry Smith   Not Collective
13875b5e7992SMatthew G. Knepley 
138884f0b6dfSMatthew G. Knepley   Input Parameters:
138920f4b53cSBarry Smith + label - the `DMLabel`
139084f0b6dfSMatthew G. Knepley - value - the stratum value
139184f0b6dfSMatthew G. Knepley 
139201d2d390SJose E. Roman   Output Parameters:
139384f0b6dfSMatthew G. Knepley + start - the smallest point in the stratum
139484f0b6dfSMatthew G. Knepley - end   - the largest point in the stratum
139584f0b6dfSMatthew G. Knepley 
139684f0b6dfSMatthew G. Knepley   Level: intermediate
139784f0b6dfSMatthew G. Knepley 
139820f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`, `DMLabelGetValue()`, `DMLabelSetValue()`, `DMLabelClearValue()`
139984f0b6dfSMatthew G. Knepley @*/
1400d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelGetStratumBounds(DMLabel label, PetscInt value, PetscInt *start, PetscInt *end)
1401d71ae5a4SJacob Faibussowitsch {
14029f6c5813SMatthew G. Knepley   IS       is;
14030c3c4a36SLisandro Dalcin   PetscInt v, min, max;
1404c58f1c22SToby Isaac 
1405c58f1c22SToby Isaac   PetscFunctionBegin;
1406d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
14079371c9d4SSatish Balay   if (start) {
14084f572ea9SToby Isaac     PetscAssertPointer(start, 3);
14099371c9d4SSatish Balay     *start = -1;
14109371c9d4SSatish Balay   }
14119371c9d4SSatish Balay   if (end) {
14124f572ea9SToby Isaac     PetscAssertPointer(end, 4);
14139371c9d4SSatish Balay     *end = -1;
14149371c9d4SSatish Balay   }
14159566063dSJacob Faibussowitsch   PetscCall(DMLabelLookupStratum(label, value, &v));
14163ba16761SJacob Faibussowitsch   if (v < 0) PetscFunctionReturn(PETSC_SUCCESS);
14179566063dSJacob Faibussowitsch   PetscCall(DMLabelMakeValid_Private(label, v));
14183ba16761SJacob Faibussowitsch   if (label->stratumSizes[v] <= 0) PetscFunctionReturn(PETSC_SUCCESS);
14199f6c5813SMatthew G. Knepley   PetscUseTypeMethod(label, getstratumis, v, &is);
14209f6c5813SMatthew G. Knepley   PetscCall(ISGetMinMax(is, &min, &max));
14219f6c5813SMatthew G. Knepley   PetscCall(ISDestroy(&is));
1422d6cb179aSToby Isaac   if (start) *start = min;
1423d6cb179aSToby Isaac   if (end) *end = max + 1;
14243ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1425c58f1c22SToby Isaac }
1426c58f1c22SToby Isaac 
142766976f2fSJacob Faibussowitsch static PetscErrorCode DMLabelGetStratumIS_Concrete(DMLabel label, PetscInt v, IS *pointIS)
14289f6c5813SMatthew G. Knepley {
14299f6c5813SMatthew G. Knepley   PetscFunctionBegin;
14309f6c5813SMatthew G. Knepley   PetscCall(PetscObjectReference((PetscObject)label->points[v]));
14319f6c5813SMatthew G. Knepley   *pointIS = label->points[v];
14323ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
14339f6c5813SMatthew G. Knepley }
14349f6c5813SMatthew G. Knepley 
143584f0b6dfSMatthew G. Knepley /*@
143620f4b53cSBarry Smith   DMLabelGetStratumIS - Get an `IS` with the stratum points
143784f0b6dfSMatthew G. Knepley 
143820f4b53cSBarry Smith   Not Collective
14395b5e7992SMatthew G. Knepley 
144084f0b6dfSMatthew G. Knepley   Input Parameters:
144120f4b53cSBarry Smith + label - the `DMLabel`
144284f0b6dfSMatthew G. Knepley - value - the stratum value
144384f0b6dfSMatthew G. Knepley 
144401d2d390SJose E. Roman   Output Parameter:
144584f0b6dfSMatthew G. Knepley . points - The stratum points
144684f0b6dfSMatthew G. Knepley 
144784f0b6dfSMatthew G. Knepley   Level: intermediate
144884f0b6dfSMatthew G. Knepley 
1449593ce467SVaclav Hapla   Notes:
145020f4b53cSBarry Smith   The output `IS` should be destroyed when no longer needed.
145120f4b53cSBarry Smith   Returns `NULL` if the stratum is empty.
1452593ce467SVaclav Hapla 
145320f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`, `DMLabelGetValue()`, `DMLabelSetValue()`, `DMLabelClearValue()`
145484f0b6dfSMatthew G. Knepley @*/
1455d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelGetStratumIS(DMLabel label, PetscInt value, IS *points)
1456d71ae5a4SJacob Faibussowitsch {
1457c58f1c22SToby Isaac   PetscInt v;
1458c58f1c22SToby Isaac 
1459c58f1c22SToby Isaac   PetscFunctionBegin;
1460d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
14614f572ea9SToby Isaac   PetscAssertPointer(points, 3);
1462c58f1c22SToby Isaac   *points = NULL;
14639566063dSJacob Faibussowitsch   PetscCall(DMLabelLookupStratum(label, value, &v));
14643ba16761SJacob Faibussowitsch   if (v < 0) PetscFunctionReturn(PETSC_SUCCESS);
14659566063dSJacob Faibussowitsch   PetscCall(DMLabelMakeValid_Private(label, v));
14669f6c5813SMatthew G. Knepley   PetscUseTypeMethod(label, getstratumis, v, points);
14673ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1468c58f1c22SToby Isaac }
1469c58f1c22SToby Isaac 
147084f0b6dfSMatthew G. Knepley /*@
147120f4b53cSBarry Smith   DMLabelSetStratumIS - Set the stratum points using an `IS`
147284f0b6dfSMatthew G. Knepley 
147320f4b53cSBarry Smith   Not Collective
14745b5e7992SMatthew G. Knepley 
147584f0b6dfSMatthew G. Knepley   Input Parameters:
147620f4b53cSBarry Smith + label - the `DMLabel`
147784f0b6dfSMatthew G. Knepley . value - the stratum value
147860225df5SJacob Faibussowitsch - is    - The stratum points
147984f0b6dfSMatthew G. Knepley 
148084f0b6dfSMatthew G. Knepley   Level: intermediate
148184f0b6dfSMatthew G. Knepley 
148220f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`, `DMLabelGetValue()`, `DMLabelSetValue()`, `DMLabelClearValue()`
148384f0b6dfSMatthew G. Knepley @*/
1484d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelSetStratumIS(DMLabel label, PetscInt value, IS is)
1485d71ae5a4SJacob Faibussowitsch {
14860c3c4a36SLisandro Dalcin   PetscInt v;
14874de306b1SToby Isaac 
14884de306b1SToby Isaac   PetscFunctionBegin;
1489d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
1490d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(is, IS_CLASSID, 3);
14919f6c5813SMatthew G. Knepley   PetscCheck(!label->readonly, PetscObjectComm((PetscObject)label), PETSC_ERR_ARG_WRONG, "Read-only labels cannot be altered");
14929566063dSJacob Faibussowitsch   PetscCall(DMLabelLookupAddStratum(label, value, &v));
14933ba16761SJacob Faibussowitsch   if (is == label->points[v]) PetscFunctionReturn(PETSC_SUCCESS);
14949566063dSJacob Faibussowitsch   PetscCall(DMLabelClearStratum(label, value));
1495f4f49eeaSPierre Jolivet   PetscCall(ISGetLocalSize(is, &label->stratumSizes[v]));
14969566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)is));
1497f4f49eeaSPierre Jolivet   PetscCall(ISDestroy(&label->points[v]));
14980c3c4a36SLisandro Dalcin   label->points[v]  = is;
14990c3c4a36SLisandro Dalcin   label->validIS[v] = PETSC_TRUE;
15009566063dSJacob Faibussowitsch   PetscCall(PetscObjectStateIncrease((PetscObject)label));
15014de306b1SToby Isaac   if (label->bt) {
15024de306b1SToby Isaac     const PetscInt *points;
15034de306b1SToby Isaac     PetscInt        p;
15044de306b1SToby Isaac 
15059566063dSJacob Faibussowitsch     PetscCall(ISGetIndices(is, &points));
15064de306b1SToby Isaac     for (p = 0; p < label->stratumSizes[v]; ++p) {
15074de306b1SToby Isaac       const PetscInt point = points[p];
15084de306b1SToby Isaac 
150963a3b9bcSJacob 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);
15109566063dSJacob Faibussowitsch       PetscCall(PetscBTSet(label->bt, point - label->pStart));
15114de306b1SToby Isaac     }
15124de306b1SToby Isaac   }
15133ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
15144de306b1SToby Isaac }
15154de306b1SToby Isaac 
151684f0b6dfSMatthew G. Knepley /*@
151784f0b6dfSMatthew G. Knepley   DMLabelClearStratum - Remove a stratum
15184de306b1SToby Isaac 
151920f4b53cSBarry Smith   Not Collective
15205b5e7992SMatthew G. Knepley 
152184f0b6dfSMatthew G. Knepley   Input Parameters:
152220f4b53cSBarry Smith + label - the `DMLabel`
152384f0b6dfSMatthew G. Knepley - value - the stratum value
152484f0b6dfSMatthew G. Knepley 
152584f0b6dfSMatthew G. Knepley   Level: intermediate
152684f0b6dfSMatthew G. Knepley 
152720f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`, `DMLabelGetValue()`, `DMLabelSetValue()`, `DMLabelClearValue()`
152884f0b6dfSMatthew G. Knepley @*/
1529d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelClearStratum(DMLabel label, PetscInt value)
1530d71ae5a4SJacob Faibussowitsch {
1531c58f1c22SToby Isaac   PetscInt v;
1532c58f1c22SToby Isaac 
1533c58f1c22SToby Isaac   PetscFunctionBegin;
1534d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
15359f6c5813SMatthew G. Knepley   PetscCheck(!label->readonly, PetscObjectComm((PetscObject)label), PETSC_ERR_ARG_WRONG, "Read-only labels cannot be altered");
15369566063dSJacob Faibussowitsch   PetscCall(DMLabelLookupStratum(label, value, &v));
15373ba16761SJacob Faibussowitsch   if (v < 0) PetscFunctionReturn(PETSC_SUCCESS);
15384de306b1SToby Isaac   if (label->validIS[v]) {
15394de306b1SToby Isaac     if (label->bt) {
1540c58f1c22SToby Isaac       PetscInt        i;
1541ad8374ffSToby Isaac       const PetscInt *points;
1542c58f1c22SToby Isaac 
15439566063dSJacob Faibussowitsch       PetscCall(ISGetIndices(label->points[v], &points));
1544c58f1c22SToby Isaac       for (i = 0; i < label->stratumSizes[v]; ++i) {
1545ad8374ffSToby Isaac         const PetscInt point = points[i];
1546c58f1c22SToby Isaac 
1547*f1d0ab6dSZach Atkins         if (point >= label->pStart && point < label->pEnd) PetscCall(PetscBTClear(label->bt, point - label->pStart));
1548c58f1c22SToby Isaac       }
15499566063dSJacob Faibussowitsch       PetscCall(ISRestoreIndices(label->points[v], &points));
1550c58f1c22SToby Isaac     }
1551c58f1c22SToby Isaac     label->stratumSizes[v] = 0;
15529566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&label->points[v]));
15539566063dSJacob Faibussowitsch     PetscCall(ISCreateStride(PETSC_COMM_SELF, 0, 0, 1, &label->points[v]));
15549566063dSJacob Faibussowitsch     PetscCall(PetscObjectSetName((PetscObject)label->points[v], "indices"));
15559566063dSJacob Faibussowitsch     PetscCall(PetscObjectStateIncrease((PetscObject)label));
1556c58f1c22SToby Isaac   } else {
15579566063dSJacob Faibussowitsch     PetscCall(PetscHSetIClear(label->ht[v]));
1558c58f1c22SToby Isaac   }
15593ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1560c58f1c22SToby Isaac }
1561c58f1c22SToby Isaac 
156284f0b6dfSMatthew G. Knepley /*@
1563412e9a14SMatthew G. Knepley   DMLabelSetStratumBounds - Efficiently give a contiguous set of points a given label value
1564412e9a14SMatthew G. Knepley 
156520f4b53cSBarry Smith   Not Collective
1566412e9a14SMatthew G. Knepley 
1567412e9a14SMatthew G. Knepley   Input Parameters:
156820f4b53cSBarry Smith + label  - The `DMLabel`
1569412e9a14SMatthew G. Knepley . value  - The label value for all points
1570412e9a14SMatthew G. Knepley . pStart - The first point
1571412e9a14SMatthew G. Knepley - pEnd   - A point beyond all marked points
1572412e9a14SMatthew G. Knepley 
1573412e9a14SMatthew G. Knepley   Level: intermediate
1574412e9a14SMatthew G. Knepley 
157520f4b53cSBarry Smith   Note:
157620f4b53cSBarry Smith   The marks points are [`pStart`, `pEnd`), and only the bounds are stored.
157720f4b53cSBarry Smith 
157820f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`, `DMLabelSetStratumIS()`, `DMLabelGetStratumIS()`
1579412e9a14SMatthew G. Knepley @*/
1580d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelSetStratumBounds(DMLabel label, PetscInt value, PetscInt pStart, PetscInt pEnd)
1581d71ae5a4SJacob Faibussowitsch {
1582412e9a14SMatthew G. Knepley   IS pIS;
1583412e9a14SMatthew G. Knepley 
1584412e9a14SMatthew G. Knepley   PetscFunctionBegin;
15859566063dSJacob Faibussowitsch   PetscCall(ISCreateStride(PETSC_COMM_SELF, pEnd - pStart, pStart, 1, &pIS));
15869566063dSJacob Faibussowitsch   PetscCall(DMLabelSetStratumIS(label, value, pIS));
15879566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&pIS));
15883ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1589412e9a14SMatthew G. Knepley }
1590412e9a14SMatthew G. Knepley 
1591412e9a14SMatthew G. Knepley /*@
1592d123abd9SMatthew G. Knepley   DMLabelGetStratumPointIndex - Get the index of a point in a given stratum
1593d123abd9SMatthew G. Knepley 
159420f4b53cSBarry Smith   Not Collective
1595d123abd9SMatthew G. Knepley 
1596d123abd9SMatthew G. Knepley   Input Parameters:
159720f4b53cSBarry Smith + label - The `DMLabel`
1598d123abd9SMatthew G. Knepley . value - The label value
1599d123abd9SMatthew G. Knepley - p     - A point with this value
1600d123abd9SMatthew G. Knepley 
1601d123abd9SMatthew G. Knepley   Output Parameter:
1602d123abd9SMatthew 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
1603d123abd9SMatthew G. Knepley 
1604d123abd9SMatthew G. Knepley   Level: intermediate
1605d123abd9SMatthew G. Knepley 
160620f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelGetValueIndex()`, `DMLabelGetStratumIS()`, `DMLabelCreate()`
1607d123abd9SMatthew G. Knepley @*/
1608d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelGetStratumPointIndex(DMLabel label, PetscInt value, PetscInt p, PetscInt *index)
1609d71ae5a4SJacob Faibussowitsch {
16109f6c5813SMatthew G. Knepley   IS       pointIS;
1611d123abd9SMatthew G. Knepley   PetscInt v;
1612d123abd9SMatthew G. Knepley 
1613d123abd9SMatthew G. Knepley   PetscFunctionBegin;
1614d123abd9SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
16154f572ea9SToby Isaac   PetscAssertPointer(index, 4);
1616d123abd9SMatthew G. Knepley   *index = -1;
16179566063dSJacob Faibussowitsch   PetscCall(DMLabelLookupStratum(label, value, &v));
16183ba16761SJacob Faibussowitsch   if (v < 0) PetscFunctionReturn(PETSC_SUCCESS);
16199566063dSJacob Faibussowitsch   PetscCall(DMLabelMakeValid_Private(label, v));
16209f6c5813SMatthew G. Knepley   PetscUseTypeMethod(label, getstratumis, v, &pointIS);
1621f622de60SMatthew G. Knepley   PetscCall(ISLocate(pointIS, p, index));
16229f6c5813SMatthew G. Knepley   PetscCall(ISDestroy(&pointIS));
16233ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1624d123abd9SMatthew G. Knepley }
1625d123abd9SMatthew G. Knepley 
1626d123abd9SMatthew G. Knepley /*@
162720f4b53cSBarry Smith   DMLabelFilter - Remove all points outside of [`start`, `end`)
162884f0b6dfSMatthew G. Knepley 
162920f4b53cSBarry Smith   Not Collective
16305b5e7992SMatthew G. Knepley 
163184f0b6dfSMatthew G. Knepley   Input Parameters:
163220f4b53cSBarry Smith + label - the `DMLabel`
163322cd2cdaSVaclav Hapla . start - the first point kept
163422cd2cdaSVaclav Hapla - end   - one more than the last point kept
163584f0b6dfSMatthew G. Knepley 
163684f0b6dfSMatthew G. Knepley   Level: intermediate
163784f0b6dfSMatthew G. Knepley 
163820f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`, `DMLabelGetValue()`, `DMLabelSetValue()`, `DMLabelClearValue()`
163984f0b6dfSMatthew G. Knepley @*/
1640d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelFilter(DMLabel label, PetscInt start, PetscInt end)
1641d71ae5a4SJacob Faibussowitsch {
1642c58f1c22SToby Isaac   PetscInt v;
1643c58f1c22SToby Isaac 
1644c58f1c22SToby Isaac   PetscFunctionBegin;
1645d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
16469f6c5813SMatthew G. Knepley   PetscCheck(!label->readonly, PetscObjectComm((PetscObject)label), PETSC_ERR_ARG_WRONG, "Read-only labels cannot be altered");
16479566063dSJacob Faibussowitsch   PetscCall(DMLabelDestroyIndex(label));
16489566063dSJacob Faibussowitsch   PetscCall(DMLabelMakeAllValid_Private(label));
16499f6c5813SMatthew G. Knepley   for (v = 0; v < label->numStrata; ++v) {
16509f6c5813SMatthew G. Knepley     PetscCall(ISGeneralFilter(label->points[v], start, end));
16519f6c5813SMatthew G. Knepley     PetscCall(ISGetLocalSize(label->points[v], &label->stratumSizes[v]));
16529f6c5813SMatthew G. Knepley   }
16539566063dSJacob Faibussowitsch   PetscCall(DMLabelCreateIndex(label, start, end));
16543ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1655c58f1c22SToby Isaac }
1656c58f1c22SToby Isaac 
165784f0b6dfSMatthew G. Knepley /*@
165884f0b6dfSMatthew G. Knepley   DMLabelPermute - Create a new label with permuted points
165984f0b6dfSMatthew G. Knepley 
166020f4b53cSBarry Smith   Not Collective
16615b5e7992SMatthew G. Knepley 
166284f0b6dfSMatthew G. Knepley   Input Parameters:
166320f4b53cSBarry Smith + label       - the `DMLabel`
166484f0b6dfSMatthew G. Knepley - permutation - the point permutation
166584f0b6dfSMatthew G. Knepley 
166684f0b6dfSMatthew G. Knepley   Output Parameter:
166760225df5SJacob Faibussowitsch . labelNew - the new label containing the permuted points
166884f0b6dfSMatthew G. Knepley 
166984f0b6dfSMatthew G. Knepley   Level: intermediate
167084f0b6dfSMatthew G. Knepley 
167120f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`, `DMLabelGetValue()`, `DMLabelSetValue()`, `DMLabelClearValue()`
167284f0b6dfSMatthew G. Knepley @*/
1673d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelPermute(DMLabel label, IS permutation, DMLabel *labelNew)
1674d71ae5a4SJacob Faibussowitsch {
1675c58f1c22SToby Isaac   const PetscInt *perm;
1676c58f1c22SToby Isaac   PetscInt        numValues, numPoints, v, q;
1677c58f1c22SToby Isaac 
1678c58f1c22SToby Isaac   PetscFunctionBegin;
1679d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
1680d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(permutation, IS_CLASSID, 2);
16819f6c5813SMatthew G. Knepley   PetscCheck(!label->readonly, PetscObjectComm((PetscObject)label), PETSC_ERR_ARG_WRONG, "Read-only labels cannot be altered");
16829566063dSJacob Faibussowitsch   PetscCall(DMLabelMakeAllValid_Private(label));
16839566063dSJacob Faibussowitsch   PetscCall(DMLabelDuplicate(label, labelNew));
16849566063dSJacob Faibussowitsch   PetscCall(DMLabelGetNumValues(*labelNew, &numValues));
16859566063dSJacob Faibussowitsch   PetscCall(ISGetLocalSize(permutation, &numPoints));
16869566063dSJacob Faibussowitsch   PetscCall(ISGetIndices(permutation, &perm));
1687c58f1c22SToby Isaac   for (v = 0; v < numValues; ++v) {
1688c58f1c22SToby Isaac     const PetscInt  size = (*labelNew)->stratumSizes[v];
1689ad8374ffSToby Isaac     const PetscInt *points;
1690ad8374ffSToby Isaac     PetscInt       *pointsNew;
1691c58f1c22SToby Isaac 
16929566063dSJacob Faibussowitsch     PetscCall(ISGetIndices((*labelNew)->points[v], &points));
16939f6c5813SMatthew G. Knepley     PetscCall(PetscCalloc1(size, &pointsNew));
1694c58f1c22SToby Isaac     for (q = 0; q < size; ++q) {
1695ad8374ffSToby Isaac       const PetscInt point = points[q];
1696c58f1c22SToby Isaac 
169763a3b9bcSJacob 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);
1698ad8374ffSToby Isaac       pointsNew[q] = perm[point];
1699c58f1c22SToby Isaac     }
17009566063dSJacob Faibussowitsch     PetscCall(ISRestoreIndices((*labelNew)->points[v], &points));
17019566063dSJacob Faibussowitsch     PetscCall(PetscSortInt(size, pointsNew));
170257508eceSPierre Jolivet     PetscCall(ISDestroy(&(*labelNew)->points[v]));
1703fa8e8ae5SToby Isaac     if (size > 0 && pointsNew[size - 1] == pointsNew[0] + size - 1) {
17049566063dSJacob Faibussowitsch       PetscCall(ISCreateStride(PETSC_COMM_SELF, size, pointsNew[0], 1, &((*labelNew)->points[v])));
17059566063dSJacob Faibussowitsch       PetscCall(PetscFree(pointsNew));
1706fa8e8ae5SToby Isaac     } else {
17079566063dSJacob Faibussowitsch       PetscCall(ISCreateGeneral(PETSC_COMM_SELF, size, pointsNew, PETSC_OWN_POINTER, &((*labelNew)->points[v])));
1708fa8e8ae5SToby Isaac     }
17099566063dSJacob Faibussowitsch     PetscCall(PetscObjectSetName((PetscObject)((*labelNew)->points[v]), "indices"));
1710c58f1c22SToby Isaac   }
17119566063dSJacob Faibussowitsch   PetscCall(ISRestoreIndices(permutation, &perm));
1712c58f1c22SToby Isaac   if (label->bt) {
17139566063dSJacob Faibussowitsch     PetscCall(PetscBTDestroy(&label->bt));
17149566063dSJacob Faibussowitsch     PetscCall(DMLabelCreateIndex(label, label->pStart, label->pEnd));
1715c58f1c22SToby Isaac   }
17163ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1717c58f1c22SToby Isaac }
1718c58f1c22SToby Isaac 
17195552b385SBrandon /*@
17205552b385SBrandon   DMLabelPermuteValues - Permute the values in a label
17215552b385SBrandon 
17225552b385SBrandon   Not collective
17235552b385SBrandon 
17245552b385SBrandon   Input Parameters:
17255552b385SBrandon + label       - the `DMLabel`
17265552b385SBrandon - permutation - the value permutation, permutation[old value] = new value
17275552b385SBrandon 
17285552b385SBrandon   Output Parameter:
17295552b385SBrandon . label - the `DMLabel` now with permuted values
17305552b385SBrandon 
17315552b385SBrandon   Note:
17325552b385SBrandon   The modification is done in-place
17335552b385SBrandon 
17345552b385SBrandon   Level: intermediate
17355552b385SBrandon 
17365552b385SBrandon .seealso: `DMLabelRewriteValues()`, `DMLabel`, `DM`, `DMLabelPermute()`, `DMLabelCreate()`, `DMLabelGetValue()`, `DMLabelSetValue()`, `DMLabelClearValue()`
17375552b385SBrandon @*/
17385552b385SBrandon PetscErrorCode DMLabelPermuteValues(DMLabel label, IS permutation)
17395552b385SBrandon {
17405552b385SBrandon   PetscInt Nv, Np;
17415552b385SBrandon 
17425552b385SBrandon   PetscFunctionBegin;
17435552b385SBrandon   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
17445552b385SBrandon   PetscValidHeaderSpecific(permutation, IS_CLASSID, 2);
17455552b385SBrandon   PetscCall(DMLabelGetNumValues(label, &Nv));
17465552b385SBrandon   PetscCall(ISGetLocalSize(permutation, &Np));
17475552b385SBrandon   PetscCheck(Np == Nv, PetscObjectComm((PetscObject)label), PETSC_ERR_ARG_SIZ, "Permutation has size %" PetscInt_FMT " != %" PetscInt_FMT " number of label values", Np, Nv);
17485552b385SBrandon   if (PetscDefined(USE_DEBUG)) {
17495552b385SBrandon     PetscBool flg;
17505552b385SBrandon     PetscCall(ISGetInfo(permutation, IS_PERMUTATION, IS_LOCAL, PETSC_TRUE, &flg));
17515552b385SBrandon     PetscCheck(flg, PetscObjectComm((PetscObject)label), PETSC_ERR_ARG_WRONG, "IS is not a permutation");
17525552b385SBrandon   }
17535552b385SBrandon   PetscCall(DMLabelRewriteValues(label, permutation));
17545552b385SBrandon   PetscFunctionReturn(PETSC_SUCCESS);
17555552b385SBrandon }
17565552b385SBrandon 
17575552b385SBrandon /*@
17585552b385SBrandon   DMLabelRewriteValues - Permute the values in a label, but some may be omitted
17595552b385SBrandon 
17605552b385SBrandon   Not collective
17615552b385SBrandon 
17625552b385SBrandon   Input Parameters:
17635552b385SBrandon + label       - the `DMLabel`
17645552b385SBrandon - permutation - the value permutation, permutation[old value] = new value, but some maybe omitted
17655552b385SBrandon 
17665552b385SBrandon   Output Parameter:
17675552b385SBrandon . label - the `DMLabel` now with permuted values
17685552b385SBrandon 
17695552b385SBrandon   Note:
17705552b385SBrandon   The modification is done in-place
17715552b385SBrandon 
17725552b385SBrandon   Level: intermediate
17735552b385SBrandon 
17745552b385SBrandon .seealso: `DMLabelPermuteValues()`, `DMLabel`, `DM`, `DMLabelPermute()`, `DMLabelCreate()`, `DMLabelGetValue()`, `DMLabelSetValue()`, `DMLabelClearValue()`
17755552b385SBrandon @*/
17765552b385SBrandon PetscErrorCode DMLabelRewriteValues(DMLabel label, IS permutation)
17775552b385SBrandon {
17785552b385SBrandon   const PetscInt *perm;
17795552b385SBrandon   PetscInt        Nv, Np;
17805552b385SBrandon 
17815552b385SBrandon   PetscFunctionBegin;
17825552b385SBrandon   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
17835552b385SBrandon   PetscValidHeaderSpecific(permutation, IS_CLASSID, 2);
17845552b385SBrandon   PetscCall(DMLabelMakeAllValid_Private(label));
17855552b385SBrandon   PetscCall(DMLabelGetNumValues(label, &Nv));
17865552b385SBrandon   PetscCall(ISGetLocalSize(permutation, &Np));
17875552b385SBrandon   PetscCheck(Np >= Nv, PetscObjectComm((PetscObject)label), PETSC_ERR_ARG_SIZ, "Permutation has size %" PetscInt_FMT " < %" PetscInt_FMT " number of label values", Np, Nv);
17885552b385SBrandon   PetscCall(ISGetIndices(permutation, &perm));
17895552b385SBrandon   for (PetscInt v = 0; v < Nv; ++v) label->stratumValues[v] = perm[label->stratumValues[v]];
17905552b385SBrandon   PetscCall(ISRestoreIndices(permutation, &perm));
17915552b385SBrandon   PetscFunctionReturn(PETSC_SUCCESS);
17925552b385SBrandon }
17935552b385SBrandon 
179466976f2fSJacob Faibussowitsch static PetscErrorCode DMLabelDistribute_Internal(DMLabel label, PetscSF sf, PetscSection *leafSection, PetscInt **leafStrata)
1795d71ae5a4SJacob Faibussowitsch {
179626c55118SMichael Lange   MPI_Comm     comm;
1797eb30be1eSVaclav Hapla   PetscInt     s, l, nroots, nleaves, offset, size;
179826c55118SMichael Lange   PetscInt    *remoteOffsets, *rootStrata, *rootIdx;
179926c55118SMichael Lange   PetscSection rootSection;
180026c55118SMichael Lange   PetscSF      labelSF;
180126c55118SMichael Lange 
180226c55118SMichael Lange   PetscFunctionBegin;
18039566063dSJacob Faibussowitsch   if (label) PetscCall(DMLabelMakeAllValid_Private(label));
18049566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)sf, &comm));
180526c55118SMichael Lange   /* Build a section of stratum values per point, generate the according SF
180626c55118SMichael Lange      and distribute point-wise stratum values to leaves. */
18079566063dSJacob Faibussowitsch   PetscCall(PetscSFGetGraph(sf, &nroots, &nleaves, NULL, NULL));
18089566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(comm, &rootSection));
18099566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(rootSection, 0, nroots));
181026c55118SMichael Lange   if (label) {
181126c55118SMichael Lange     for (s = 0; s < label->numStrata; ++s) {
1812ad8374ffSToby Isaac       const PetscInt *points;
1813ad8374ffSToby Isaac 
18149566063dSJacob Faibussowitsch       PetscCall(ISGetIndices(label->points[s], &points));
181548a46eb9SPierre Jolivet       for (l = 0; l < label->stratumSizes[s]; l++) PetscCall(PetscSectionAddDof(rootSection, points[l], 1));
18169566063dSJacob Faibussowitsch       PetscCall(ISRestoreIndices(label->points[s], &points));
181726c55118SMichael Lange     }
181826c55118SMichael Lange   }
18199566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(rootSection));
182026c55118SMichael Lange   /* Create a point-wise array of stratum values */
18219566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetStorageSize(rootSection, &size));
18229566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(size, &rootStrata));
18239566063dSJacob Faibussowitsch   PetscCall(PetscCalloc1(nroots, &rootIdx));
182426c55118SMichael Lange   if (label) {
182526c55118SMichael Lange     for (s = 0; s < label->numStrata; ++s) {
1826ad8374ffSToby Isaac       const PetscInt *points;
1827ad8374ffSToby Isaac 
18289566063dSJacob Faibussowitsch       PetscCall(ISGetIndices(label->points[s], &points));
182926c55118SMichael Lange       for (l = 0; l < label->stratumSizes[s]; l++) {
1830ad8374ffSToby Isaac         const PetscInt p = points[l];
18319566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetOffset(rootSection, p, &offset));
183226c55118SMichael Lange         rootStrata[offset + rootIdx[p]++] = label->stratumValues[s];
183326c55118SMichael Lange       }
18349566063dSJacob Faibussowitsch       PetscCall(ISRestoreIndices(label->points[s], &points));
183526c55118SMichael Lange     }
183626c55118SMichael Lange   }
183726c55118SMichael Lange   /* Build SF that maps label points to remote processes */
18389566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(comm, leafSection));
18399566063dSJacob Faibussowitsch   PetscCall(PetscSFDistributeSection(sf, rootSection, &remoteOffsets, *leafSection));
18409566063dSJacob Faibussowitsch   PetscCall(PetscSFCreateSectionSF(sf, rootSection, remoteOffsets, *leafSection, &labelSF));
18419566063dSJacob Faibussowitsch   PetscCall(PetscFree(remoteOffsets));
184226c55118SMichael Lange   /* Send the strata for each point over the derived SF */
18439566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetStorageSize(*leafSection, &size));
18449566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(size, leafStrata));
18459566063dSJacob Faibussowitsch   PetscCall(PetscSFBcastBegin(labelSF, MPIU_INT, rootStrata, *leafStrata, MPI_REPLACE));
18469566063dSJacob Faibussowitsch   PetscCall(PetscSFBcastEnd(labelSF, MPIU_INT, rootStrata, *leafStrata, MPI_REPLACE));
184726c55118SMichael Lange   /* Clean up */
18489566063dSJacob Faibussowitsch   PetscCall(PetscFree(rootStrata));
18499566063dSJacob Faibussowitsch   PetscCall(PetscFree(rootIdx));
18509566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&rootSection));
18519566063dSJacob Faibussowitsch   PetscCall(PetscSFDestroy(&labelSF));
18523ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
185326c55118SMichael Lange }
185426c55118SMichael Lange 
185584f0b6dfSMatthew G. Knepley /*@
185620f4b53cSBarry Smith   DMLabelDistribute - Create a new label pushed forward over the `PetscSF`
185784f0b6dfSMatthew G. Knepley 
185820f4b53cSBarry Smith   Collective
18595b5e7992SMatthew G. Knepley 
186084f0b6dfSMatthew G. Knepley   Input Parameters:
186120f4b53cSBarry Smith + label - the `DMLabel`
186284f0b6dfSMatthew G. Knepley - sf    - the map from old to new distribution
186384f0b6dfSMatthew G. Knepley 
186484f0b6dfSMatthew G. Knepley   Output Parameter:
186560225df5SJacob Faibussowitsch . labelNew - the new redistributed label
186684f0b6dfSMatthew G. Knepley 
186784f0b6dfSMatthew G. Knepley   Level: intermediate
186884f0b6dfSMatthew G. Knepley 
186920f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelCreate()`, `DMLabelGetValue()`, `DMLabelSetValue()`, `DMLabelClearValue()`
187084f0b6dfSMatthew G. Knepley @*/
1871d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelDistribute(DMLabel label, PetscSF sf, DMLabel *labelNew)
1872d71ae5a4SJacob Faibussowitsch {
1873c58f1c22SToby Isaac   MPI_Comm     comm;
187426c55118SMichael Lange   PetscSection leafSection;
187526c55118SMichael Lange   PetscInt     p, pStart, pEnd, s, size, dof, offset, stratum;
187626c55118SMichael Lange   PetscInt    *leafStrata, *strataIdx;
1877ad8374ffSToby Isaac   PetscInt   **points;
1878d67d17b1SMatthew G. Knepley   const char  *lname = NULL;
1879c58f1c22SToby Isaac   char        *name;
1880835f2295SStefano Zampini   PetscMPIInt  nameSize;
1881e8f14785SLisandro Dalcin   PetscHSetI   stratumHash;
1882c58f1c22SToby Isaac   size_t       len = 0;
188326c55118SMichael Lange   PetscMPIInt  rank;
1884c58f1c22SToby Isaac 
1885c58f1c22SToby Isaac   PetscFunctionBegin;
1886d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
1887f018e600SMatthew G. Knepley   if (label) {
1888f018e600SMatthew G. Knepley     PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
18899f6c5813SMatthew G. Knepley     PetscCheck(!label->readonly, PetscObjectComm((PetscObject)label), PETSC_ERR_ARG_WRONG, "Read-only labels cannot be altered");
18909566063dSJacob Faibussowitsch     PetscCall(DMLabelMakeAllValid_Private(label));
1891f018e600SMatthew G. Knepley   }
18929566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)sf, &comm));
18939566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(comm, &rank));
1894c58f1c22SToby Isaac   /* Bcast name */
1895dd400576SPatrick Sanan   if (rank == 0) {
18969566063dSJacob Faibussowitsch     PetscCall(PetscObjectGetName((PetscObject)label, &lname));
18979566063dSJacob Faibussowitsch     PetscCall(PetscStrlen(lname, &len));
1898d67d17b1SMatthew G. Knepley   }
1899835f2295SStefano Zampini   PetscCall(PetscMPIIntCast(len, &nameSize));
1900835f2295SStefano Zampini   PetscCallMPI(MPI_Bcast(&nameSize, 1, MPI_INT, 0, comm));
19019566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nameSize + 1, &name));
19029566063dSJacob Faibussowitsch   if (rank == 0) PetscCall(PetscArraycpy(name, lname, nameSize + 1));
1903835f2295SStefano Zampini   PetscCallMPI(MPI_Bcast(name, nameSize + 1, MPI_CHAR, 0, comm));
19049566063dSJacob Faibussowitsch   PetscCall(DMLabelCreate(PETSC_COMM_SELF, name, labelNew));
19059566063dSJacob Faibussowitsch   PetscCall(PetscFree(name));
190677d236dfSMichael Lange   /* Bcast defaultValue */
1907dd400576SPatrick Sanan   if (rank == 0) (*labelNew)->defaultValue = label->defaultValue;
19089566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Bcast(&(*labelNew)->defaultValue, 1, MPIU_INT, 0, comm));
190926c55118SMichael Lange   /* Distribute stratum values over the SF and get the point mapping on the receiver */
19109566063dSJacob Faibussowitsch   PetscCall(DMLabelDistribute_Internal(label, sf, &leafSection, &leafStrata));
19115cbdf6fcSMichael Lange   /* Determine received stratum values and initialise new label*/
19129566063dSJacob Faibussowitsch   PetscCall(PetscHSetICreate(&stratumHash));
19139566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetStorageSize(leafSection, &size));
19149566063dSJacob Faibussowitsch   for (p = 0; p < size; ++p) PetscCall(PetscHSetIAdd(stratumHash, leafStrata[p]));
19159566063dSJacob Faibussowitsch   PetscCall(PetscHSetIGetSize(stratumHash, &(*labelNew)->numStrata));
19169566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1((*labelNew)->numStrata, &(*labelNew)->validIS));
1917ad8374ffSToby Isaac   for (s = 0; s < (*labelNew)->numStrata; ++s) (*labelNew)->validIS[s] = PETSC_TRUE;
19189566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1((*labelNew)->numStrata, &(*labelNew)->stratumValues));
19195cbdf6fcSMichael Lange   /* Turn leafStrata into indices rather than stratum values */
19205cbdf6fcSMichael Lange   offset = 0;
19219566063dSJacob Faibussowitsch   PetscCall(PetscHSetIGetElems(stratumHash, &offset, (*labelNew)->stratumValues));
19229566063dSJacob Faibussowitsch   PetscCall(PetscSortInt((*labelNew)->numStrata, (*labelNew)->stratumValues));
192348a46eb9SPierre Jolivet   for (s = 0; s < (*labelNew)->numStrata; ++s) PetscCall(PetscHMapISet((*labelNew)->hmap, (*labelNew)->stratumValues[s], s));
19245cbdf6fcSMichael Lange   for (p = 0; p < size; ++p) {
1925231b9e6fSMatthew G. Knepley     for (s = 0; s < (*labelNew)->numStrata; ++s) {
19269371c9d4SSatish Balay       if (leafStrata[p] == (*labelNew)->stratumValues[s]) {
19279371c9d4SSatish Balay         leafStrata[p] = s;
19289371c9d4SSatish Balay         break;
19299371c9d4SSatish Balay       }
19305cbdf6fcSMichael Lange     }
19315cbdf6fcSMichael Lange   }
1932c58f1c22SToby Isaac   /* Rebuild the point strata on the receiver */
19339566063dSJacob Faibussowitsch   PetscCall(PetscCalloc1((*labelNew)->numStrata, &(*labelNew)->stratumSizes));
19349566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(leafSection, &pStart, &pEnd));
1935c58f1c22SToby Isaac   for (p = pStart; p < pEnd; p++) {
19369566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(leafSection, p, &dof));
19379566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(leafSection, p, &offset));
1938ad540459SPierre Jolivet     for (s = 0; s < dof; s++) (*labelNew)->stratumSizes[leafStrata[offset + s]]++;
1939c58f1c22SToby Isaac   }
19409566063dSJacob Faibussowitsch   PetscCall(PetscCalloc1((*labelNew)->numStrata, &(*labelNew)->ht));
19419f6c5813SMatthew G. Knepley   PetscCall(PetscCalloc1((*labelNew)->numStrata, &(*labelNew)->points));
19429f6c5813SMatthew G. Knepley   PetscCall(PetscCalloc1((*labelNew)->numStrata, &points));
1943c58f1c22SToby Isaac   for (s = 0; s < (*labelNew)->numStrata; ++s) {
19449566063dSJacob Faibussowitsch     PetscCall(PetscHSetICreate(&(*labelNew)->ht[s]));
1945f4f49eeaSPierre Jolivet     PetscCall(PetscMalloc1((*labelNew)->stratumSizes[s], &points[s]));
1946c58f1c22SToby Isaac   }
1947c58f1c22SToby Isaac   /* Insert points into new strata */
19489566063dSJacob Faibussowitsch   PetscCall(PetscCalloc1((*labelNew)->numStrata, &strataIdx));
19499566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(leafSection, &pStart, &pEnd));
1950c58f1c22SToby Isaac   for (p = pStart; p < pEnd; p++) {
19519566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(leafSection, p, &dof));
19529566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(leafSection, p, &offset));
1953c58f1c22SToby Isaac     for (s = 0; s < dof; s++) {
1954c58f1c22SToby Isaac       stratum                               = leafStrata[offset + s];
1955ad8374ffSToby Isaac       points[stratum][strataIdx[stratum]++] = p;
1956c58f1c22SToby Isaac     }
1957c58f1c22SToby Isaac   }
1958ad8374ffSToby Isaac   for (s = 0; s < (*labelNew)->numStrata; s++) {
1959f4f49eeaSPierre Jolivet     PetscCall(ISCreateGeneral(PETSC_COMM_SELF, (*labelNew)->stratumSizes[s], &points[s][0], PETSC_OWN_POINTER, &((*labelNew)->points[s])));
19609566063dSJacob Faibussowitsch     PetscCall(PetscObjectSetName((PetscObject)((*labelNew)->points[s]), "indices"));
1961ad8374ffSToby Isaac   }
19629566063dSJacob Faibussowitsch   PetscCall(PetscFree(points));
19639566063dSJacob Faibussowitsch   PetscCall(PetscHSetIDestroy(&stratumHash));
19649566063dSJacob Faibussowitsch   PetscCall(PetscFree(leafStrata));
19659566063dSJacob Faibussowitsch   PetscCall(PetscFree(strataIdx));
19669566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&leafSection));
19673ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1968c58f1c22SToby Isaac }
1969c58f1c22SToby Isaac 
19707937d9ceSMichael Lange /*@
19717937d9ceSMichael Lange   DMLabelGather - Gather all label values from leafs into roots
19727937d9ceSMichael Lange 
197320f4b53cSBarry Smith   Collective
19745b5e7992SMatthew G. Knepley 
19757937d9ceSMichael Lange   Input Parameters:
197620f4b53cSBarry Smith + label - the `DMLabel`
197720f4b53cSBarry Smith - sf    - the `PetscSF` communication map
19787937d9ceSMichael Lange 
19792fe279fdSBarry Smith   Output Parameter:
198020f4b53cSBarry Smith . labelNew - the new `DMLabel` with localised leaf values
19817937d9ceSMichael Lange 
19827937d9ceSMichael Lange   Level: developer
19837937d9ceSMichael Lange 
198420f4b53cSBarry Smith   Note:
198520f4b53cSBarry Smith   This is the inverse operation to `DMLabelDistribute()`.
19867937d9ceSMichael Lange 
198720f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelDistribute()`
19887937d9ceSMichael Lange @*/
1989d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelGather(DMLabel label, PetscSF sf, DMLabel *labelNew)
1990d71ae5a4SJacob Faibussowitsch {
19917937d9ceSMichael Lange   MPI_Comm        comm;
19927937d9ceSMichael Lange   PetscSection    rootSection;
19937937d9ceSMichael Lange   PetscSF         sfLabel;
19947937d9ceSMichael Lange   PetscSFNode    *rootPoints, *leafPoints;
19957937d9ceSMichael Lange   PetscInt        p, s, d, nroots, nleaves, nmultiroots, idx, dof, offset;
19967937d9ceSMichael Lange   const PetscInt *rootDegree, *ilocal;
19977937d9ceSMichael Lange   PetscInt       *rootStrata;
1998d67d17b1SMatthew G. Knepley   const char     *lname;
19997937d9ceSMichael Lange   char           *name;
2000835f2295SStefano Zampini   PetscMPIInt     nameSize;
20017937d9ceSMichael Lange   size_t          len = 0;
20029852e123SBarry Smith   PetscMPIInt     rank, size;
20037937d9ceSMichael Lange 
20047937d9ceSMichael Lange   PetscFunctionBegin;
2005d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
2006d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
20079f6c5813SMatthew G. Knepley   PetscCheck(!label->readonly, PetscObjectComm((PetscObject)label), PETSC_ERR_ARG_WRONG, "Read-only labels cannot be altered");
20089566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)sf, &comm));
20099566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(comm, &rank));
20109566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
20117937d9ceSMichael Lange   /* Bcast name */
2012dd400576SPatrick Sanan   if (rank == 0) {
20139566063dSJacob Faibussowitsch     PetscCall(PetscObjectGetName((PetscObject)label, &lname));
20149566063dSJacob Faibussowitsch     PetscCall(PetscStrlen(lname, &len));
2015d67d17b1SMatthew G. Knepley   }
2016835f2295SStefano Zampini   PetscCall(PetscMPIIntCast(len, &nameSize));
2017835f2295SStefano Zampini   PetscCallMPI(MPI_Bcast(&nameSize, 1, MPI_INT, 0, comm));
20189566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nameSize + 1, &name));
20199566063dSJacob Faibussowitsch   if (rank == 0) PetscCall(PetscArraycpy(name, lname, nameSize + 1));
2020835f2295SStefano Zampini   PetscCallMPI(MPI_Bcast(name, nameSize + 1, MPI_CHAR, 0, comm));
20219566063dSJacob Faibussowitsch   PetscCall(DMLabelCreate(PETSC_COMM_SELF, name, labelNew));
20229566063dSJacob Faibussowitsch   PetscCall(PetscFree(name));
20237937d9ceSMichael Lange   /* Gather rank/index pairs of leaves into local roots to build
20247937d9ceSMichael Lange      an inverse, multi-rooted SF. Note that this ignores local leaf
20257937d9ceSMichael Lange      indexing due to the use of the multiSF in PetscSFGather. */
20269566063dSJacob Faibussowitsch   PetscCall(PetscSFGetGraph(sf, &nroots, &nleaves, &ilocal, NULL));
20279566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nroots, &leafPoints));
2028dc53bc9bSMatthew G. Knepley   for (p = 0; p < nroots; ++p) leafPoints[p].rank = leafPoints[p].index = -1;
20297937d9ceSMichael Lange   for (p = 0; p < nleaves; p++) {
20308212dd46SStefano Zampini     PetscInt ilp = ilocal ? ilocal[p] : p;
20318212dd46SStefano Zampini 
20328212dd46SStefano Zampini     leafPoints[ilp].index = ilp;
20338212dd46SStefano Zampini     leafPoints[ilp].rank  = rank;
20347937d9ceSMichael Lange   }
20359566063dSJacob Faibussowitsch   PetscCall(PetscSFComputeDegreeBegin(sf, &rootDegree));
20369566063dSJacob Faibussowitsch   PetscCall(PetscSFComputeDegreeEnd(sf, &rootDegree));
20377937d9ceSMichael Lange   for (p = 0, nmultiroots = 0; p < nroots; ++p) nmultiroots += rootDegree[p];
20389566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nmultiroots, &rootPoints));
20396497c311SBarry Smith   PetscCall(PetscSFGatherBegin(sf, MPIU_SF_NODE, leafPoints, rootPoints));
20406497c311SBarry Smith   PetscCall(PetscSFGatherEnd(sf, MPIU_SF_NODE, leafPoints, rootPoints));
20419566063dSJacob Faibussowitsch   PetscCall(PetscSFCreate(comm, &sfLabel));
20429566063dSJacob Faibussowitsch   PetscCall(PetscSFSetGraph(sfLabel, nroots, nmultiroots, NULL, PETSC_OWN_POINTER, rootPoints, PETSC_OWN_POINTER));
20437937d9ceSMichael Lange   /* Migrate label over inverted SF to pull stratum values at leaves into roots. */
20449566063dSJacob Faibussowitsch   PetscCall(DMLabelDistribute_Internal(label, sfLabel, &rootSection, &rootStrata));
20457937d9ceSMichael Lange   /* Rebuild the point strata on the receiver */
20467937d9ceSMichael Lange   for (p = 0, idx = 0; p < nroots; p++) {
20477937d9ceSMichael Lange     for (d = 0; d < rootDegree[p]; d++) {
20489566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(rootSection, idx + d, &dof));
20499566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetOffset(rootSection, idx + d, &offset));
20509566063dSJacob Faibussowitsch       for (s = 0; s < dof; s++) PetscCall(DMLabelSetValue(*labelNew, p, rootStrata[offset + s]));
20517937d9ceSMichael Lange     }
20527937d9ceSMichael Lange     idx += rootDegree[p];
20537937d9ceSMichael Lange   }
20549566063dSJacob Faibussowitsch   PetscCall(PetscFree(leafPoints));
20559566063dSJacob Faibussowitsch   PetscCall(PetscFree(rootStrata));
20569566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&rootSection));
20579566063dSJacob Faibussowitsch   PetscCall(PetscSFDestroy(&sfLabel));
20583ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
20597937d9ceSMichael Lange }
20607937d9ceSMichael Lange 
2061d71ae5a4SJacob Faibussowitsch static PetscErrorCode DMLabelPropagateInit_Internal(DMLabel label, PetscSF pointSF, PetscInt valArray[])
2062d71ae5a4SJacob Faibussowitsch {
2063d42890abSMatthew G. Knepley   const PetscInt *degree;
2064d42890abSMatthew G. Knepley   const PetscInt *points;
2065d42890abSMatthew G. Knepley   PetscInt        Nr, r, Nl, l, val, defVal;
2066d42890abSMatthew G. Knepley 
2067d42890abSMatthew G. Knepley   PetscFunctionBegin;
2068d42890abSMatthew G. Knepley   PetscCall(DMLabelGetDefaultValue(label, &defVal));
2069d42890abSMatthew G. Knepley   /* Add in leaves */
2070d42890abSMatthew G. Knepley   PetscCall(PetscSFGetGraph(pointSF, &Nr, &Nl, &points, NULL));
2071d42890abSMatthew G. Knepley   for (l = 0; l < Nl; ++l) {
2072d42890abSMatthew G. Knepley     PetscCall(DMLabelGetValue(label, points[l], &val));
2073d42890abSMatthew G. Knepley     if (val != defVal) valArray[points[l]] = val;
2074d42890abSMatthew G. Knepley   }
2075d42890abSMatthew G. Knepley   /* Add in shared roots */
2076d42890abSMatthew G. Knepley   PetscCall(PetscSFComputeDegreeBegin(pointSF, &degree));
2077d42890abSMatthew G. Knepley   PetscCall(PetscSFComputeDegreeEnd(pointSF, &degree));
2078d42890abSMatthew G. Knepley   for (r = 0; r < Nr; ++r) {
2079d42890abSMatthew G. Knepley     if (degree[r]) {
2080d42890abSMatthew G. Knepley       PetscCall(DMLabelGetValue(label, r, &val));
2081d42890abSMatthew G. Knepley       if (val != defVal) valArray[r] = val;
2082d42890abSMatthew G. Knepley     }
2083d42890abSMatthew G. Knepley   }
20843ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2085d42890abSMatthew G. Knepley }
2086d42890abSMatthew G. Knepley 
2087d71ae5a4SJacob Faibussowitsch static PetscErrorCode DMLabelPropagateFini_Internal(DMLabel label, PetscSF pointSF, PetscInt valArray[], PetscErrorCode (*markPoint)(DMLabel, PetscInt, PetscInt, void *), void *ctx)
2088d71ae5a4SJacob Faibussowitsch {
2089d42890abSMatthew G. Knepley   const PetscInt *degree;
2090d42890abSMatthew G. Knepley   const PetscInt *points;
2091d42890abSMatthew G. Knepley   PetscInt        Nr, r, Nl, l, val, defVal;
2092d42890abSMatthew G. Knepley 
2093d42890abSMatthew G. Knepley   PetscFunctionBegin;
2094d42890abSMatthew G. Knepley   PetscCall(DMLabelGetDefaultValue(label, &defVal));
2095d42890abSMatthew G. Knepley   /* Read out leaves */
2096d42890abSMatthew G. Knepley   PetscCall(PetscSFGetGraph(pointSF, &Nr, &Nl, &points, NULL));
2097d42890abSMatthew G. Knepley   for (l = 0; l < Nl; ++l) {
2098d42890abSMatthew G. Knepley     const PetscInt p    = points[l];
2099d42890abSMatthew G. Knepley     const PetscInt cval = valArray[p];
2100d42890abSMatthew G. Knepley 
2101d42890abSMatthew G. Knepley     if (cval != defVal) {
2102d42890abSMatthew G. Knepley       PetscCall(DMLabelGetValue(label, p, &val));
2103d42890abSMatthew G. Knepley       if (val == defVal) {
2104d42890abSMatthew G. Knepley         PetscCall(DMLabelSetValue(label, p, cval));
210548a46eb9SPierre Jolivet         if (markPoint) PetscCall((*markPoint)(label, p, cval, ctx));
2106d42890abSMatthew G. Knepley       }
2107d42890abSMatthew G. Knepley     }
2108d42890abSMatthew G. Knepley   }
2109d42890abSMatthew G. Knepley   /* Read out shared roots */
2110d42890abSMatthew G. Knepley   PetscCall(PetscSFComputeDegreeBegin(pointSF, &degree));
2111d42890abSMatthew G. Knepley   PetscCall(PetscSFComputeDegreeEnd(pointSF, &degree));
2112d42890abSMatthew G. Knepley   for (r = 0; r < Nr; ++r) {
2113d42890abSMatthew G. Knepley     if (degree[r]) {
2114d42890abSMatthew G. Knepley       const PetscInt cval = valArray[r];
2115d42890abSMatthew G. Knepley 
2116d42890abSMatthew G. Knepley       if (cval != defVal) {
2117d42890abSMatthew G. Knepley         PetscCall(DMLabelGetValue(label, r, &val));
2118d42890abSMatthew G. Knepley         if (val == defVal) {
2119d42890abSMatthew G. Knepley           PetscCall(DMLabelSetValue(label, r, cval));
212048a46eb9SPierre Jolivet           if (markPoint) PetscCall((*markPoint)(label, r, cval, ctx));
2121d42890abSMatthew G. Knepley         }
2122d42890abSMatthew G. Knepley       }
2123d42890abSMatthew G. Knepley     }
2124d42890abSMatthew G. Knepley   }
21253ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2126d42890abSMatthew G. Knepley }
2127d42890abSMatthew G. Knepley 
2128d42890abSMatthew G. Knepley /*@
2129d42890abSMatthew G. Knepley   DMLabelPropagateBegin - Setup a cycle of label propagation
2130d42890abSMatthew G. Knepley 
213120f4b53cSBarry Smith   Collective
2132d42890abSMatthew G. Knepley 
2133d42890abSMatthew G. Knepley   Input Parameters:
213420f4b53cSBarry Smith + label - The `DMLabel` to propagate across processes
213520f4b53cSBarry Smith - sf    - The `PetscSF` describing parallel layout of the label points
2136d42890abSMatthew G. Knepley 
2137d42890abSMatthew G. Knepley   Level: intermediate
2138d42890abSMatthew G. Knepley 
213920f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelPropagateEnd()`, `DMLabelPropagatePush()`
2140d42890abSMatthew G. Knepley @*/
2141d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelPropagateBegin(DMLabel label, PetscSF sf)
2142d71ae5a4SJacob Faibussowitsch {
2143d42890abSMatthew G. Knepley   PetscInt    Nr, r, defVal;
2144d42890abSMatthew G. Knepley   PetscMPIInt size;
2145d42890abSMatthew G. Knepley 
2146d42890abSMatthew G. Knepley   PetscFunctionBegin;
21479f6c5813SMatthew G. Knepley   PetscCheck(!label->readonly, PetscObjectComm((PetscObject)label), PETSC_ERR_ARG_WRONG, "Read-only labels cannot be altered");
2148d42890abSMatthew G. Knepley   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)sf), &size));
2149d42890abSMatthew G. Knepley   if (size > 1) {
2150d42890abSMatthew G. Knepley     PetscCall(DMLabelGetDefaultValue(label, &defVal));
2151d42890abSMatthew G. Knepley     PetscCall(PetscSFGetGraph(sf, &Nr, NULL, NULL, NULL));
2152d42890abSMatthew G. Knepley     if (Nr >= 0) PetscCall(PetscMalloc1(Nr, &label->propArray));
2153d42890abSMatthew G. Knepley     for (r = 0; r < Nr; ++r) label->propArray[r] = defVal;
2154d42890abSMatthew G. Knepley   }
21553ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2156d42890abSMatthew G. Knepley }
2157d42890abSMatthew G. Knepley 
2158d42890abSMatthew G. Knepley /*@
2159d42890abSMatthew G. Knepley   DMLabelPropagateEnd - Tear down a cycle of label propagation
2160d42890abSMatthew G. Knepley 
216120f4b53cSBarry Smith   Collective
2162d42890abSMatthew G. Knepley 
2163d42890abSMatthew G. Knepley   Input Parameters:
216420f4b53cSBarry Smith + label   - The `DMLabel` to propagate across processes
216560225df5SJacob Faibussowitsch - pointSF - The `PetscSF` describing parallel layout of the label points
2166d42890abSMatthew G. Knepley 
2167d42890abSMatthew G. Knepley   Level: intermediate
2168d42890abSMatthew G. Knepley 
216920f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelPropagateBegin()`, `DMLabelPropagatePush()`
2170d42890abSMatthew G. Knepley @*/
2171d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelPropagateEnd(DMLabel label, PetscSF pointSF)
2172d71ae5a4SJacob Faibussowitsch {
2173d42890abSMatthew G. Knepley   PetscFunctionBegin;
21749f6c5813SMatthew G. Knepley   PetscCheck(!label->readonly, PetscObjectComm((PetscObject)label), PETSC_ERR_ARG_WRONG, "Read-only labels cannot be altered");
2175d42890abSMatthew G. Knepley   PetscCall(PetscFree(label->propArray));
2176d42890abSMatthew G. Knepley   label->propArray = NULL;
21773ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2178d42890abSMatthew G. Knepley }
2179d42890abSMatthew G. Knepley 
2180d42890abSMatthew G. Knepley /*@C
2181d42890abSMatthew G. Knepley   DMLabelPropagatePush - Tear down a cycle of label propagation
2182d42890abSMatthew G. Knepley 
218320f4b53cSBarry Smith   Collective
2184d42890abSMatthew G. Knepley 
2185d42890abSMatthew G. Knepley   Input Parameters:
218620f4b53cSBarry Smith + label     - The `DMLabel` to propagate across processes
2187a4e35b19SJacob Faibussowitsch . pointSF   - The `PetscSF` describing parallel layout of the label points
218820f4b53cSBarry Smith . markPoint - An optional callback that is called when a point is marked, or `NULL`
218920f4b53cSBarry Smith - ctx       - An optional user context for the callback, or `NULL`
2190d42890abSMatthew G. Knepley 
219120f4b53cSBarry Smith   Calling sequence of `markPoint`:
219220f4b53cSBarry Smith + label - The `DMLabel`
2193d42890abSMatthew G. Knepley . p     - The point being marked
2194a4e35b19SJacob Faibussowitsch . val   - The label value for `p`
2195d42890abSMatthew G. Knepley - ctx   - An optional user context
2196d42890abSMatthew G. Knepley 
2197d42890abSMatthew G. Knepley   Level: intermediate
2198d42890abSMatthew G. Knepley 
219920f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelPropagateBegin()`, `DMLabelPropagateEnd()`
2200d42890abSMatthew G. Knepley @*/
2201a4e35b19SJacob Faibussowitsch PetscErrorCode DMLabelPropagatePush(DMLabel label, PetscSF pointSF, PetscErrorCode (*markPoint)(DMLabel label, PetscInt p, PetscInt val, void *ctx), void *ctx)
2202d71ae5a4SJacob Faibussowitsch {
2203c50b2d26SMatthew G. Knepley   PetscInt   *valArray = label->propArray, Nr;
2204d42890abSMatthew G. Knepley   PetscMPIInt size;
2205d42890abSMatthew G. Knepley 
2206d42890abSMatthew G. Knepley   PetscFunctionBegin;
22079f6c5813SMatthew G. Knepley   PetscCheck(!label->readonly, PetscObjectComm((PetscObject)label), PETSC_ERR_ARG_WRONG, "Read-only labels cannot be altered");
2208d42890abSMatthew G. Knepley   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)pointSF), &size));
2209c50b2d26SMatthew G. Knepley   PetscCall(PetscSFGetGraph(pointSF, &Nr, NULL, NULL, NULL));
2210c50b2d26SMatthew G. Knepley   if (size > 1 && Nr >= 0) {
2211d42890abSMatthew G. Knepley     /* Communicate marked edges
2212d42890abSMatthew G. Knepley        The current implementation allocates an array the size of the number of root. We put the label values into the
2213d42890abSMatthew G. Knepley        array, and then call PetscSFReduce()+PetscSFBcast() to make the marks consistent.
2214d42890abSMatthew G. Knepley 
2215d42890abSMatthew G. Knepley        TODO: We could use in-place communication with a different SF
2216d42890abSMatthew G. Knepley        We use MPI_SUM for the Reduce, and check the result against the rootdegree. If sum >= rootdegree+1, then the edge has
2217d42890abSMatthew G. Knepley        already been marked. If not, it might have been handled on the process in this round, but we add it anyway.
2218d42890abSMatthew G. Knepley 
2219d42890abSMatthew G. Knepley        In order to update the queue with the new edges from the label communication, we use BcastAnOp(MPI_SUM), so that new
2220d42890abSMatthew 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
2221d42890abSMatthew G. Knepley        edge to the queue.
2222d42890abSMatthew G. Knepley     */
2223d42890abSMatthew G. Knepley     PetscCall(DMLabelPropagateInit_Internal(label, pointSF, valArray));
2224d42890abSMatthew G. Knepley     PetscCall(PetscSFReduceBegin(pointSF, MPIU_INT, valArray, valArray, MPI_MAX));
2225d42890abSMatthew G. Knepley     PetscCall(PetscSFReduceEnd(pointSF, MPIU_INT, valArray, valArray, MPI_MAX));
2226d42890abSMatthew G. Knepley     PetscCall(PetscSFBcastBegin(pointSF, MPIU_INT, valArray, valArray, MPI_REPLACE));
2227d42890abSMatthew G. Knepley     PetscCall(PetscSFBcastEnd(pointSF, MPIU_INT, valArray, valArray, MPI_REPLACE));
2228d42890abSMatthew G. Knepley     PetscCall(DMLabelPropagateFini_Internal(label, pointSF, valArray, markPoint, ctx));
2229d42890abSMatthew G. Knepley   }
22303ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2231d42890abSMatthew G. Knepley }
2232d42890abSMatthew G. Knepley 
223384f0b6dfSMatthew G. Knepley /*@
223420f4b53cSBarry Smith   DMLabelConvertToSection - Make a `PetscSection`/`IS` pair that encodes the label
223584f0b6dfSMatthew G. Knepley 
223620f4b53cSBarry Smith   Not Collective
22375b5e7992SMatthew G. Knepley 
223884f0b6dfSMatthew G. Knepley   Input Parameter:
223920f4b53cSBarry Smith . label - the `DMLabel`
224084f0b6dfSMatthew G. Knepley 
224184f0b6dfSMatthew G. Knepley   Output Parameters:
224284f0b6dfSMatthew G. Knepley + section - the section giving offsets for each stratum
224320f4b53cSBarry Smith - is      - An `IS` containing all the label points
224484f0b6dfSMatthew G. Knepley 
224584f0b6dfSMatthew G. Knepley   Level: developer
224684f0b6dfSMatthew G. Knepley 
224720f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelDistribute()`
224884f0b6dfSMatthew G. Knepley @*/
2249d71ae5a4SJacob Faibussowitsch PetscErrorCode DMLabelConvertToSection(DMLabel label, PetscSection *section, IS *is)
2250d71ae5a4SJacob Faibussowitsch {
2251c58f1c22SToby Isaac   IS              vIS;
2252c58f1c22SToby Isaac   const PetscInt *values;
2253c58f1c22SToby Isaac   PetscInt       *points;
2254c58f1c22SToby Isaac   PetscInt        nV, vS = 0, vE = 0, v, N;
2255c58f1c22SToby Isaac 
2256c58f1c22SToby Isaac   PetscFunctionBegin;
2257d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
22589566063dSJacob Faibussowitsch   PetscCall(DMLabelGetNumValues(label, &nV));
22599566063dSJacob Faibussowitsch   PetscCall(DMLabelGetValueIS(label, &vIS));
22609566063dSJacob Faibussowitsch   PetscCall(ISGetIndices(vIS, &values));
22619371c9d4SSatish Balay   if (nV) {
22629371c9d4SSatish Balay     vS = values[0];
22639371c9d4SSatish Balay     vE = values[0] + 1;
22649371c9d4SSatish Balay   }
2265c58f1c22SToby Isaac   for (v = 1; v < nV; ++v) {
2266c58f1c22SToby Isaac     vS = PetscMin(vS, values[v]);
2267c58f1c22SToby Isaac     vE = PetscMax(vE, values[v] + 1);
2268c58f1c22SToby Isaac   }
22699566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PETSC_COMM_SELF, section));
22709566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(*section, vS, vE));
2271c58f1c22SToby Isaac   for (v = 0; v < nV; ++v) {
2272c58f1c22SToby Isaac     PetscInt n;
2273c58f1c22SToby Isaac 
22749566063dSJacob Faibussowitsch     PetscCall(DMLabelGetStratumSize(label, values[v], &n));
22759566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(*section, values[v], n));
2276c58f1c22SToby Isaac   }
22779566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(*section));
22789566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetStorageSize(*section, &N));
22799566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(N, &points));
2280c58f1c22SToby Isaac   for (v = 0; v < nV; ++v) {
2281c58f1c22SToby Isaac     IS              is;
2282c58f1c22SToby Isaac     const PetscInt *spoints;
2283c58f1c22SToby Isaac     PetscInt        dof, off, p;
2284c58f1c22SToby Isaac 
22859566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(*section, values[v], &dof));
22869566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(*section, values[v], &off));
22879566063dSJacob Faibussowitsch     PetscCall(DMLabelGetStratumIS(label, values[v], &is));
22889566063dSJacob Faibussowitsch     PetscCall(ISGetIndices(is, &spoints));
2289c58f1c22SToby Isaac     for (p = 0; p < dof; ++p) points[off + p] = spoints[p];
22909566063dSJacob Faibussowitsch     PetscCall(ISRestoreIndices(is, &spoints));
22919566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&is));
2292c58f1c22SToby Isaac   }
22939566063dSJacob Faibussowitsch   PetscCall(ISRestoreIndices(vIS, &values));
22949566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&vIS));
22959566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(PETSC_COMM_SELF, N, points, PETSC_OWN_POINTER, is));
22963ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2297c58f1c22SToby Isaac }
2298c58f1c22SToby Isaac 
22999f6c5813SMatthew G. Knepley /*@C
23009f6c5813SMatthew G. Knepley   DMLabelRegister - Adds a new label component implementation
23019f6c5813SMatthew G. Knepley 
23029f6c5813SMatthew G. Knepley   Not Collective
23039f6c5813SMatthew G. Knepley 
23049f6c5813SMatthew G. Knepley   Input Parameters:
23059f6c5813SMatthew G. Knepley + name        - The name of a new user-defined creation routine
23069f6c5813SMatthew G. Knepley - create_func - The creation routine itself
23079f6c5813SMatthew G. Knepley 
23089f6c5813SMatthew G. Knepley   Notes:
23099f6c5813SMatthew G. Knepley   `DMLabelRegister()` may be called multiple times to add several user-defined labels
23109f6c5813SMatthew G. Knepley 
231160225df5SJacob Faibussowitsch   Example Usage:
23129f6c5813SMatthew G. Knepley .vb
23139f6c5813SMatthew G. Knepley   DMLabelRegister("my_label", MyLabelCreate);
23149f6c5813SMatthew G. Knepley .ve
23159f6c5813SMatthew G. Knepley 
23169f6c5813SMatthew G. Knepley   Then, your label type can be chosen with the procedural interface via
23179f6c5813SMatthew G. Knepley .vb
23189f6c5813SMatthew G. Knepley   DMLabelCreate(MPI_Comm, DMLabel *);
23199f6c5813SMatthew G. Knepley   DMLabelSetType(DMLabel, "my_label");
23209f6c5813SMatthew G. Knepley .ve
23219f6c5813SMatthew G. Knepley   or at runtime via the option
23229f6c5813SMatthew G. Knepley .vb
23239f6c5813SMatthew G. Knepley   -dm_label_type my_label
23249f6c5813SMatthew G. Knepley .ve
23259f6c5813SMatthew G. Knepley 
23269f6c5813SMatthew G. Knepley   Level: advanced
23279f6c5813SMatthew G. Knepley 
232860225df5SJacob Faibussowitsch .seealso: `DMLabel`, `DM`, `DMLabelType`, `DMLabelRegisterAll()`, `DMLabelRegisterDestroy()`
23299f6c5813SMatthew G. Knepley @*/
23309f6c5813SMatthew G. Knepley PetscErrorCode DMLabelRegister(const char name[], PetscErrorCode (*create_func)(DMLabel))
23319f6c5813SMatthew G. Knepley {
23329f6c5813SMatthew G. Knepley   PetscFunctionBegin;
23339f6c5813SMatthew G. Knepley   PetscCall(DMInitializePackage());
23349f6c5813SMatthew G. Knepley   PetscCall(PetscFunctionListAdd(&DMLabelList, name, create_func));
23353ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23369f6c5813SMatthew G. Knepley }
23379f6c5813SMatthew G. Knepley 
23389f6c5813SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelCreate_Concrete(DMLabel);
23399f6c5813SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelCreate_Ephemeral(DMLabel);
23409f6c5813SMatthew G. Knepley 
23419f6c5813SMatthew G. Knepley /*@C
23429f6c5813SMatthew G. Knepley   DMLabelRegisterAll - Registers all of the `DMLabel` implementations in the `DM` package.
23439f6c5813SMatthew G. Knepley 
23449f6c5813SMatthew G. Knepley   Not Collective
23459f6c5813SMatthew G. Knepley 
23469f6c5813SMatthew G. Knepley   Level: advanced
23479f6c5813SMatthew G. Knepley 
234820f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMRegisterAll()`, `DMLabelRegisterDestroy()`
23499f6c5813SMatthew G. Knepley @*/
23509f6c5813SMatthew G. Knepley PetscErrorCode DMLabelRegisterAll(void)
23519f6c5813SMatthew G. Knepley {
23529f6c5813SMatthew G. Knepley   PetscFunctionBegin;
23533ba16761SJacob Faibussowitsch   if (DMLabelRegisterAllCalled) PetscFunctionReturn(PETSC_SUCCESS);
23549f6c5813SMatthew G. Knepley   DMLabelRegisterAllCalled = PETSC_TRUE;
23559f6c5813SMatthew G. Knepley 
23569f6c5813SMatthew G. Knepley   PetscCall(DMLabelRegister(DMLABELCONCRETE, DMLabelCreate_Concrete));
23579f6c5813SMatthew G. Knepley   PetscCall(DMLabelRegister(DMLABELEPHEMERAL, DMLabelCreate_Ephemeral));
23583ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23599f6c5813SMatthew G. Knepley }
23609f6c5813SMatthew G. Knepley 
23619f6c5813SMatthew G. Knepley /*@C
23629f6c5813SMatthew G. Knepley   DMLabelRegisterDestroy - This function destroys the `DMLabel` registry. It is called from `PetscFinalize()`.
23639f6c5813SMatthew G. Knepley 
23649f6c5813SMatthew G. Knepley   Level: developer
23659f6c5813SMatthew G. Knepley 
236620f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `PetscInitialize()`
23679f6c5813SMatthew G. Knepley @*/
23689f6c5813SMatthew G. Knepley PetscErrorCode DMLabelRegisterDestroy(void)
23699f6c5813SMatthew G. Knepley {
23709f6c5813SMatthew G. Knepley   PetscFunctionBegin;
23719f6c5813SMatthew G. Knepley   PetscCall(PetscFunctionListDestroy(&DMLabelList));
23729f6c5813SMatthew G. Knepley   DMLabelRegisterAllCalled = PETSC_FALSE;
23733ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23749f6c5813SMatthew G. Knepley }
23759f6c5813SMatthew G. Knepley 
2376cc4c1da9SBarry Smith /*@
23779f6c5813SMatthew G. Knepley   DMLabelSetType - Sets the particular implementation for a label.
23789f6c5813SMatthew G. Knepley 
237920f4b53cSBarry Smith   Collective
23809f6c5813SMatthew G. Knepley 
23819f6c5813SMatthew G. Knepley   Input Parameters:
23829f6c5813SMatthew G. Knepley + label  - The label
23839f6c5813SMatthew G. Knepley - method - The name of the label type
23849f6c5813SMatthew G. Knepley 
23859f6c5813SMatthew G. Knepley   Options Database Key:
238620f4b53cSBarry Smith . -dm_label_type <type> - Sets the label type; use -help for a list of available types or see `DMLabelType`
23879f6c5813SMatthew G. Knepley 
23889f6c5813SMatthew G. Knepley   Level: intermediate
23899f6c5813SMatthew G. Knepley 
239020f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelGetType()`, `DMLabelCreate()`
23919f6c5813SMatthew G. Knepley @*/
23929f6c5813SMatthew G. Knepley PetscErrorCode DMLabelSetType(DMLabel label, DMLabelType method)
23939f6c5813SMatthew G. Knepley {
23949f6c5813SMatthew G. Knepley   PetscErrorCode (*r)(DMLabel);
23959f6c5813SMatthew G. Knepley   PetscBool match;
23969f6c5813SMatthew G. Knepley 
23979f6c5813SMatthew G. Knepley   PetscFunctionBegin;
23989f6c5813SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
23999f6c5813SMatthew G. Knepley   PetscCall(PetscObjectTypeCompare((PetscObject)label, method, &match));
24003ba16761SJacob Faibussowitsch   if (match) PetscFunctionReturn(PETSC_SUCCESS);
24019f6c5813SMatthew G. Knepley 
24029f6c5813SMatthew G. Knepley   PetscCall(DMLabelRegisterAll());
24039f6c5813SMatthew G. Knepley   PetscCall(PetscFunctionListFind(DMLabelList, method, &r));
24049f6c5813SMatthew G. Knepley   PetscCheck(r, PetscObjectComm((PetscObject)label), PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown DMLabel type: %s", method);
24059f6c5813SMatthew G. Knepley 
24069f6c5813SMatthew G. Knepley   PetscTryTypeMethod(label, destroy);
24079f6c5813SMatthew G. Knepley   PetscCall(PetscMemzero(label->ops, sizeof(*label->ops)));
24089f6c5813SMatthew G. Knepley   PetscCall(PetscObjectChangeTypeName((PetscObject)label, method));
24099f6c5813SMatthew G. Knepley   PetscCall((*r)(label));
24103ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
24119f6c5813SMatthew G. Knepley }
24129f6c5813SMatthew G. Knepley 
2413cc4c1da9SBarry Smith /*@
24149f6c5813SMatthew G. Knepley   DMLabelGetType - Gets the type name (as a string) from the label.
24159f6c5813SMatthew G. Knepley 
24169f6c5813SMatthew G. Knepley   Not Collective
24179f6c5813SMatthew G. Knepley 
24189f6c5813SMatthew G. Knepley   Input Parameter:
241920f4b53cSBarry Smith . label - The `DMLabel`
24209f6c5813SMatthew G. Knepley 
24219f6c5813SMatthew G. Knepley   Output Parameter:
242220f4b53cSBarry Smith . type - The `DMLabel` type name
24239f6c5813SMatthew G. Knepley 
24249f6c5813SMatthew G. Knepley   Level: intermediate
24259f6c5813SMatthew G. Knepley 
242620f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `DMLabelSetType()`, `DMLabelCreate()`
24279f6c5813SMatthew G. Knepley @*/
24289f6c5813SMatthew G. Knepley PetscErrorCode DMLabelGetType(DMLabel label, DMLabelType *type)
24299f6c5813SMatthew G. Knepley {
24309f6c5813SMatthew G. Knepley   PetscFunctionBegin;
24319f6c5813SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
24324f572ea9SToby Isaac   PetscAssertPointer(type, 2);
24339f6c5813SMatthew G. Knepley   PetscCall(DMLabelRegisterAll());
24349f6c5813SMatthew G. Knepley   *type = ((PetscObject)label)->type_name;
24353ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
24369f6c5813SMatthew G. Knepley }
24379f6c5813SMatthew G. Knepley 
24389f6c5813SMatthew G. Knepley static PetscErrorCode DMLabelInitialize_Concrete(DMLabel label)
24399f6c5813SMatthew G. Knepley {
24409f6c5813SMatthew G. Knepley   PetscFunctionBegin;
24419f6c5813SMatthew G. Knepley   label->ops->view         = DMLabelView_Concrete;
24429f6c5813SMatthew G. Knepley   label->ops->setup        = NULL;
24439f6c5813SMatthew G. Knepley   label->ops->duplicate    = DMLabelDuplicate_Concrete;
24449f6c5813SMatthew G. Knepley   label->ops->getstratumis = DMLabelGetStratumIS_Concrete;
24453ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
24469f6c5813SMatthew G. Knepley }
24479f6c5813SMatthew G. Knepley 
24489f6c5813SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelCreate_Concrete(DMLabel label)
24499f6c5813SMatthew G. Knepley {
24509f6c5813SMatthew G. Knepley   PetscFunctionBegin;
24519f6c5813SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 1);
24529f6c5813SMatthew G. Knepley   PetscCall(DMLabelInitialize_Concrete(label));
24533ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
24549f6c5813SMatthew G. Knepley }
24559f6c5813SMatthew G. Knepley 
245684f0b6dfSMatthew G. Knepley /*@
2457c58f1c22SToby Isaac   PetscSectionCreateGlobalSectionLabel - Create a section describing the global field layout using
245820f4b53cSBarry Smith   the local section and an `PetscSF` describing the section point overlap.
2459c58f1c22SToby Isaac 
246020f4b53cSBarry Smith   Collective
24615b5e7992SMatthew G. Knepley 
2462c58f1c22SToby Isaac   Input Parameters:
246320f4b53cSBarry Smith + s                  - The `PetscSection` for the local field layout
246420f4b53cSBarry Smith . sf                 - The `PetscSF` describing parallel layout of the section points
246520f4b53cSBarry Smith . includeConstraints - By default this is `PETSC_FALSE`, meaning that the global field vector will not possess constrained dofs
2466c58f1c22SToby Isaac . label              - The label specifying the points
2467c58f1c22SToby Isaac - labelValue         - The label stratum specifying the points
2468c58f1c22SToby Isaac 
2469c58f1c22SToby Isaac   Output Parameter:
247020f4b53cSBarry Smith . gsection - The `PetscSection` for the global field layout
2471c58f1c22SToby Isaac 
2472c58f1c22SToby Isaac   Level: developer
2473c58f1c22SToby Isaac 
247420f4b53cSBarry Smith   Note:
247520f4b53cSBarry Smith   This gives negative sizes and offsets to points not owned by this process
247620f4b53cSBarry Smith 
247720f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `PetscSectionCreate()`
2478c58f1c22SToby Isaac @*/
2479d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionCreateGlobalSectionLabel(PetscSection s, PetscSF sf, PetscBool includeConstraints, DMLabel label, PetscInt labelValue, PetscSection *gsection)
2480d71ae5a4SJacob Faibussowitsch {
2481c58f1c22SToby Isaac   PetscInt *neg = NULL, *tmpOff = NULL;
2482c58f1c22SToby Isaac   PetscInt  pStart, pEnd, p, dof, cdof, off, globalOff = 0, nroots;
2483c58f1c22SToby Isaac 
2484c58f1c22SToby Isaac   PetscFunctionBegin;
2485d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1);
2486d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
2487d67d17b1SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 4);
24889566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject)s), gsection));
24899566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
24909566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(*gsection, pStart, pEnd));
24919566063dSJacob Faibussowitsch   PetscCall(PetscSFGetGraph(sf, &nroots, NULL, NULL, NULL));
2492c58f1c22SToby Isaac   if (nroots >= 0) {
249363a3b9bcSJacob Faibussowitsch     PetscCheck(nroots >= pEnd - pStart, PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "PetscSF nroots %" PetscInt_FMT " < %" PetscInt_FMT " section size", nroots, pEnd - pStart);
24949566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(nroots, &neg));
2495c58f1c22SToby Isaac     if (nroots > pEnd - pStart) {
24969566063dSJacob Faibussowitsch       PetscCall(PetscCalloc1(nroots, &tmpOff));
2497c58f1c22SToby Isaac     } else {
2498c58f1c22SToby Isaac       tmpOff = &(*gsection)->atlasDof[-pStart];
2499c58f1c22SToby Isaac     }
2500c58f1c22SToby Isaac   }
2501c58f1c22SToby Isaac   /* Mark ghost points with negative dof */
2502c58f1c22SToby Isaac   for (p = pStart; p < pEnd; ++p) {
2503c58f1c22SToby Isaac     PetscInt value;
2504c58f1c22SToby Isaac 
25059566063dSJacob Faibussowitsch     PetscCall(DMLabelGetValue(label, p, &value));
2506c58f1c22SToby Isaac     if (value != labelValue) continue;
25079566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(s, p, &dof));
25089566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(*gsection, p, dof));
25099566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(s, p, &cdof));
25109566063dSJacob Faibussowitsch     if (!includeConstraints && cdof > 0) PetscCall(PetscSectionSetConstraintDof(*gsection, p, cdof));
2511c58f1c22SToby Isaac     if (neg) neg[p] = -(dof + 1);
2512c58f1c22SToby Isaac   }
25139566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUpBC(*gsection));
2514c58f1c22SToby Isaac   if (nroots >= 0) {
25159566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastBegin(sf, MPIU_INT, neg, tmpOff, MPI_REPLACE));
25169566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastEnd(sf, MPIU_INT, neg, tmpOff, MPI_REPLACE));
2517c58f1c22SToby Isaac     if (nroots > pEnd - pStart) {
25189371c9d4SSatish Balay       for (p = pStart; p < pEnd; ++p) {
25199371c9d4SSatish Balay         if (tmpOff[p] < 0) (*gsection)->atlasDof[p - pStart] = tmpOff[p];
25209371c9d4SSatish Balay       }
2521c58f1c22SToby Isaac     }
2522c58f1c22SToby Isaac   }
252335cb6cd3SPierre Jolivet   /* Calculate new sizes, get process offset, and calculate point offsets */
2524c58f1c22SToby Isaac   for (p = 0, off = 0; p < pEnd - pStart; ++p) {
2525c58f1c22SToby Isaac     cdof                     = (!includeConstraints && s->bc) ? s->bc->atlasDof[p] : 0;
2526c58f1c22SToby Isaac     (*gsection)->atlasOff[p] = off;
2527c58f1c22SToby Isaac     off += (*gsection)->atlasDof[p] > 0 ? (*gsection)->atlasDof[p] - cdof : 0;
2528c58f1c22SToby Isaac   }
25299566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Scan(&off, &globalOff, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject)s)));
2530c58f1c22SToby Isaac   globalOff -= off;
2531c58f1c22SToby Isaac   for (p = 0, off = 0; p < pEnd - pStart; ++p) {
2532c58f1c22SToby Isaac     (*gsection)->atlasOff[p] += globalOff;
2533c58f1c22SToby Isaac     if (neg) neg[p] = -((*gsection)->atlasOff[p] + 1);
2534c58f1c22SToby Isaac   }
2535c58f1c22SToby Isaac   /* Put in negative offsets for ghost points */
2536c58f1c22SToby Isaac   if (nroots >= 0) {
25379566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastBegin(sf, MPIU_INT, neg, tmpOff, MPI_REPLACE));
25389566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastEnd(sf, MPIU_INT, neg, tmpOff, MPI_REPLACE));
2539c58f1c22SToby Isaac     if (nroots > pEnd - pStart) {
25409371c9d4SSatish Balay       for (p = pStart; p < pEnd; ++p) {
25419371c9d4SSatish Balay         if (tmpOff[p] < 0) (*gsection)->atlasOff[p - pStart] = tmpOff[p];
25429371c9d4SSatish Balay       }
2543c58f1c22SToby Isaac     }
2544c58f1c22SToby Isaac   }
25459566063dSJacob Faibussowitsch   if (nroots >= 0 && nroots > pEnd - pStart) PetscCall(PetscFree(tmpOff));
25469566063dSJacob Faibussowitsch   PetscCall(PetscFree(neg));
25473ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2548c58f1c22SToby Isaac }
2549c58f1c22SToby Isaac 
25509371c9d4SSatish Balay typedef struct _n_PetscSectionSym_Label {
25515fdea053SToby Isaac   DMLabel              label;
25525fdea053SToby Isaac   PetscCopyMode       *modes;
25535fdea053SToby Isaac   PetscInt            *sizes;
25545fdea053SToby Isaac   const PetscInt    ***perms;
25555fdea053SToby Isaac   const PetscScalar ***rots;
25565fdea053SToby Isaac   PetscInt (*minMaxOrients)[2];
25575fdea053SToby Isaac   PetscInt numStrata; /* numStrata is only increasing, functions as a state */
25585fdea053SToby Isaac } PetscSectionSym_Label;
25595fdea053SToby Isaac 
2560d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscSectionSymLabelReset(PetscSectionSym sym)
2561d71ae5a4SJacob Faibussowitsch {
25625fdea053SToby Isaac   PetscInt               i, j;
25635fdea053SToby Isaac   PetscSectionSym_Label *sl = (PetscSectionSym_Label *)sym->data;
25645fdea053SToby Isaac 
25655fdea053SToby Isaac   PetscFunctionBegin;
25665fdea053SToby Isaac   for (i = 0; i <= sl->numStrata; i++) {
25675fdea053SToby Isaac     if (sl->modes[i] == PETSC_OWN_POINTER || sl->modes[i] == PETSC_COPY_VALUES) {
25685fdea053SToby Isaac       for (j = sl->minMaxOrients[i][0]; j < sl->minMaxOrients[i][1]; j++) {
25699566063dSJacob Faibussowitsch         if (sl->perms[i]) PetscCall(PetscFree(sl->perms[i][j]));
25709566063dSJacob Faibussowitsch         if (sl->rots[i]) PetscCall(PetscFree(sl->rots[i][j]));
25715fdea053SToby Isaac       }
25725fdea053SToby Isaac       if (sl->perms[i]) {
25735fdea053SToby Isaac         const PetscInt **perms = &sl->perms[i][sl->minMaxOrients[i][0]];
25745fdea053SToby Isaac 
25759566063dSJacob Faibussowitsch         PetscCall(PetscFree(perms));
25765fdea053SToby Isaac       }
25775fdea053SToby Isaac       if (sl->rots[i]) {
25785fdea053SToby Isaac         const PetscScalar **rots = &sl->rots[i][sl->minMaxOrients[i][0]];
25795fdea053SToby Isaac 
25809566063dSJacob Faibussowitsch         PetscCall(PetscFree(rots));
25815fdea053SToby Isaac       }
25825fdea053SToby Isaac     }
25835fdea053SToby Isaac   }
25849566063dSJacob Faibussowitsch   PetscCall(PetscFree5(sl->modes, sl->sizes, sl->perms, sl->rots, sl->minMaxOrients));
25859566063dSJacob Faibussowitsch   PetscCall(DMLabelDestroy(&sl->label));
25865fdea053SToby Isaac   sl->numStrata = 0;
25873ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
25885fdea053SToby Isaac }
25895fdea053SToby Isaac 
2590d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscSectionSymDestroy_Label(PetscSectionSym sym)
2591d71ae5a4SJacob Faibussowitsch {
25925fdea053SToby Isaac   PetscFunctionBegin;
25939566063dSJacob Faibussowitsch   PetscCall(PetscSectionSymLabelReset(sym));
25949566063dSJacob Faibussowitsch   PetscCall(PetscFree(sym->data));
25953ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
25965fdea053SToby Isaac }
25975fdea053SToby Isaac 
2598d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscSectionSymView_Label(PetscSectionSym sym, PetscViewer viewer)
2599d71ae5a4SJacob Faibussowitsch {
26005fdea053SToby Isaac   PetscSectionSym_Label *sl = (PetscSectionSym_Label *)sym->data;
26015fdea053SToby Isaac   PetscBool              isAscii;
26025fdea053SToby Isaac   DMLabel                label = sl->label;
2603d67d17b1SMatthew G. Knepley   const char            *name;
26045fdea053SToby Isaac 
26055fdea053SToby Isaac   PetscFunctionBegin;
26069566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &isAscii));
26075fdea053SToby Isaac   if (isAscii) {
26085fdea053SToby Isaac     PetscInt          i, j, k;
26095fdea053SToby Isaac     PetscViewerFormat format;
26105fdea053SToby Isaac 
26119566063dSJacob Faibussowitsch     PetscCall(PetscViewerGetFormat(viewer, &format));
26125fdea053SToby Isaac     if (label) {
26139566063dSJacob Faibussowitsch       PetscCall(PetscViewerGetFormat(viewer, &format));
26145fdea053SToby Isaac       if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
26159566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPushTab(viewer));
26169566063dSJacob Faibussowitsch         PetscCall(DMLabelView(label, viewer));
26179566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPopTab(viewer));
26185fdea053SToby Isaac       } else {
26199566063dSJacob Faibussowitsch         PetscCall(PetscObjectGetName((PetscObject)sl->label, &name));
26209566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  Label '%s'\n", name));
26215fdea053SToby Isaac       }
26225fdea053SToby Isaac     } else {
26239566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "No label given\n"));
26245fdea053SToby Isaac     }
26259566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPushTab(viewer));
26265fdea053SToby Isaac     for (i = 0; i <= sl->numStrata; i++) {
26275fdea053SToby Isaac       PetscInt value = i < sl->numStrata ? label->stratumValues[i] : label->defaultValue;
26285fdea053SToby Isaac 
26295fdea053SToby Isaac       if (!(sl->perms[i] || sl->rots[i])) {
263063a3b9bcSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "Symmetry for stratum value %" PetscInt_FMT " (%" PetscInt_FMT " dofs per point): no symmetries\n", value, sl->sizes[i]));
26315fdea053SToby Isaac       } else {
263263a3b9bcSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "Symmetry for stratum value %" PetscInt_FMT " (%" PetscInt_FMT " dofs per point):\n", value, sl->sizes[i]));
26339566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPushTab(viewer));
263463a3b9bcSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "Orientation range: [%" PetscInt_FMT ", %" PetscInt_FMT ")\n", sl->minMaxOrients[i][0], sl->minMaxOrients[i][1]));
26355fdea053SToby Isaac         if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
26369566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPushTab(viewer));
26375fdea053SToby Isaac           for (j = sl->minMaxOrients[i][0]; j < sl->minMaxOrients[i][1]; j++) {
26385fdea053SToby Isaac             if (!((sl->perms[i] && sl->perms[i][j]) || (sl->rots[i] && sl->rots[i][j]))) {
263963a3b9bcSJacob Faibussowitsch               PetscCall(PetscViewerASCIIPrintf(viewer, "Orientation %" PetscInt_FMT ": identity\n", j));
26405fdea053SToby Isaac             } else {
26415fdea053SToby Isaac               PetscInt tab;
26425fdea053SToby Isaac 
264363a3b9bcSJacob Faibussowitsch               PetscCall(PetscViewerASCIIPrintf(viewer, "Orientation %" PetscInt_FMT ":\n", j));
26449566063dSJacob Faibussowitsch               PetscCall(PetscViewerASCIIPushTab(viewer));
26459566063dSJacob Faibussowitsch               PetscCall(PetscViewerASCIIGetTab(viewer, &tab));
26465fdea053SToby Isaac               if (sl->perms[i] && sl->perms[i][j]) {
26479566063dSJacob Faibussowitsch                 PetscCall(PetscViewerASCIIPrintf(viewer, "Permutation:"));
26489566063dSJacob Faibussowitsch                 PetscCall(PetscViewerASCIISetTab(viewer, 0));
264963a3b9bcSJacob Faibussowitsch                 for (k = 0; k < sl->sizes[i]; k++) PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT, sl->perms[i][j][k]));
26509566063dSJacob Faibussowitsch                 PetscCall(PetscViewerASCIIPrintf(viewer, "\n"));
26519566063dSJacob Faibussowitsch                 PetscCall(PetscViewerASCIISetTab(viewer, tab));
26525fdea053SToby Isaac               }
26535fdea053SToby Isaac               if (sl->rots[i] && sl->rots[i][j]) {
26549566063dSJacob Faibussowitsch                 PetscCall(PetscViewerASCIIPrintf(viewer, "Rotations:  "));
26559566063dSJacob Faibussowitsch                 PetscCall(PetscViewerASCIISetTab(viewer, 0));
26565fdea053SToby Isaac #if defined(PETSC_USE_COMPLEX)
265763a3b9bcSJacob 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])));
26585fdea053SToby Isaac #else
265963a3b9bcSJacob Faibussowitsch                 for (k = 0; k < sl->sizes[i]; k++) PetscCall(PetscViewerASCIIPrintf(viewer, " %+g", (double)sl->rots[i][j][k]));
26605fdea053SToby Isaac #endif
26619566063dSJacob Faibussowitsch                 PetscCall(PetscViewerASCIIPrintf(viewer, "\n"));
26629566063dSJacob Faibussowitsch                 PetscCall(PetscViewerASCIISetTab(viewer, tab));
26635fdea053SToby Isaac               }
26649566063dSJacob Faibussowitsch               PetscCall(PetscViewerASCIIPopTab(viewer));
26655fdea053SToby Isaac             }
26665fdea053SToby Isaac           }
26679566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPopTab(viewer));
26685fdea053SToby Isaac         }
26699566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPopTab(viewer));
26705fdea053SToby Isaac       }
26715fdea053SToby Isaac     }
26729566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopTab(viewer));
26735fdea053SToby Isaac   }
26743ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
26755fdea053SToby Isaac }
26765fdea053SToby Isaac 
26775fdea053SToby Isaac /*@
26785fdea053SToby Isaac   PetscSectionSymLabelSetLabel - set the label whose strata will define the points that receive symmetries
26795fdea053SToby Isaac 
268020f4b53cSBarry Smith   Logically
26815fdea053SToby Isaac 
268260225df5SJacob Faibussowitsch   Input Parameters:
26835fdea053SToby Isaac + sym   - the section symmetries
268420f4b53cSBarry Smith - label - the `DMLabel` describing the types of points
26855fdea053SToby Isaac 
26865fdea053SToby Isaac   Level: developer:
26875fdea053SToby Isaac 
268820f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `PetscSectionSymLabelSetStratum()`, `PetscSectionSymCreateLabel()`, `PetscSectionGetPointSyms()`
26895fdea053SToby Isaac @*/
2690d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSymLabelSetLabel(PetscSectionSym sym, DMLabel label)
2691d71ae5a4SJacob Faibussowitsch {
26925fdea053SToby Isaac   PetscSectionSym_Label *sl;
26935fdea053SToby Isaac 
26945fdea053SToby Isaac   PetscFunctionBegin;
26955fdea053SToby Isaac   PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID, 1);
26965fdea053SToby Isaac   sl = (PetscSectionSym_Label *)sym->data;
26979566063dSJacob Faibussowitsch   if (sl->label && sl->label != label) PetscCall(PetscSectionSymLabelReset(sym));
26985fdea053SToby Isaac   if (label) {
26995fdea053SToby Isaac     sl->label = label;
27009566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject)label));
27019566063dSJacob Faibussowitsch     PetscCall(DMLabelGetNumValues(label, &sl->numStrata));
27029566063dSJacob 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));
27039566063dSJacob Faibussowitsch     PetscCall(PetscMemzero((void *)sl->modes, (sl->numStrata + 1) * sizeof(PetscCopyMode)));
27049566063dSJacob Faibussowitsch     PetscCall(PetscMemzero((void *)sl->sizes, (sl->numStrata + 1) * sizeof(PetscInt)));
27059566063dSJacob Faibussowitsch     PetscCall(PetscMemzero((void *)sl->perms, (sl->numStrata + 1) * sizeof(const PetscInt **)));
27069566063dSJacob Faibussowitsch     PetscCall(PetscMemzero((void *)sl->rots, (sl->numStrata + 1) * sizeof(const PetscScalar **)));
27079566063dSJacob Faibussowitsch     PetscCall(PetscMemzero((void *)sl->minMaxOrients, (sl->numStrata + 1) * sizeof(PetscInt[2])));
27085fdea053SToby Isaac   }
27093ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
27105fdea053SToby Isaac }
27115fdea053SToby Isaac 
27125fdea053SToby Isaac /*@C
2713b004864fSMatthew G. Knepley   PetscSectionSymLabelGetStratum - get the symmetries for the orientations of a stratum
2714b004864fSMatthew G. Knepley 
271520f4b53cSBarry Smith   Logically Collective
2716b004864fSMatthew G. Knepley 
2717b004864fSMatthew G. Knepley   Input Parameters:
2718b004864fSMatthew G. Knepley + sym     - the section symmetries
2719b004864fSMatthew G. Knepley - stratum - the stratum value in the label that we are assigning symmetries for
2720b004864fSMatthew G. Knepley 
2721b004864fSMatthew G. Knepley   Output Parameters:
272220f4b53cSBarry Smith + size      - the number of dofs for points in the `stratum` of the label
272320f4b53cSBarry Smith . minOrient - the smallest orientation for a point in this `stratum`
272420f4b53cSBarry Smith . maxOrient - one greater than the largest orientation for a ppoint in this `stratum` (i.e., orientations are in the range [`minOrient`, `maxOrient`))
272520f4b53cSBarry Smith . perms     - `NULL` if there are no permutations, or (`maxOrient` - `minOrient`) permutations, one for each orientation.  A `NULL` permutation is the identity
272620f4b53cSBarry 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
2727b004864fSMatthew G. Knepley 
2728b004864fSMatthew G. Knepley   Level: developer
2729b004864fSMatthew G. Knepley 
273020f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `PetscSectionSymLabelSetStratum()`, `PetscSectionSymCreate()`, `PetscSectionSetSym()`, `PetscSectionGetPointSyms()`, `PetscSectionSymCreateLabel()`
2731b004864fSMatthew G. Knepley @*/
2732d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSymLabelGetStratum(PetscSectionSym sym, PetscInt stratum, PetscInt *size, PetscInt *minOrient, PetscInt *maxOrient, const PetscInt ***perms, const PetscScalar ***rots)
2733d71ae5a4SJacob Faibussowitsch {
2734b004864fSMatthew G. Knepley   PetscSectionSym_Label *sl;
2735b004864fSMatthew G. Knepley   const char            *name;
2736b004864fSMatthew G. Knepley   PetscInt               i;
2737b004864fSMatthew G. Knepley 
2738b004864fSMatthew G. Knepley   PetscFunctionBegin;
2739b004864fSMatthew G. Knepley   PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID, 1);
2740b004864fSMatthew G. Knepley   sl = (PetscSectionSym_Label *)sym->data;
2741b004864fSMatthew G. Knepley   PetscCheck(sl->label, PetscObjectComm((PetscObject)sym), PETSC_ERR_ARG_WRONGSTATE, "No label set yet");
2742b004864fSMatthew G. Knepley   for (i = 0; i <= sl->numStrata; i++) {
2743b004864fSMatthew G. Knepley     PetscInt value = (i < sl->numStrata) ? sl->label->stratumValues[i] : sl->label->defaultValue;
2744b004864fSMatthew G. Knepley 
2745b004864fSMatthew G. Knepley     if (stratum == value) break;
2746b004864fSMatthew G. Knepley   }
27479566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetName((PetscObject)sl->label, &name));
2748b004864fSMatthew G. Knepley   PetscCheck(i <= sl->numStrata, PetscObjectComm((PetscObject)sym), PETSC_ERR_ARG_OUTOFRANGE, "Stratum %" PetscInt_FMT " not found in label %s", stratum, name);
27499371c9d4SSatish Balay   if (size) {
27504f572ea9SToby Isaac     PetscAssertPointer(size, 3);
27519371c9d4SSatish Balay     *size = sl->sizes[i];
27529371c9d4SSatish Balay   }
27539371c9d4SSatish Balay   if (minOrient) {
27544f572ea9SToby Isaac     PetscAssertPointer(minOrient, 4);
27559371c9d4SSatish Balay     *minOrient = sl->minMaxOrients[i][0];
27569371c9d4SSatish Balay   }
27579371c9d4SSatish Balay   if (maxOrient) {
27584f572ea9SToby Isaac     PetscAssertPointer(maxOrient, 5);
27599371c9d4SSatish Balay     *maxOrient = sl->minMaxOrients[i][1];
27609371c9d4SSatish Balay   }
27619371c9d4SSatish Balay   if (perms) {
27624f572ea9SToby Isaac     PetscAssertPointer(perms, 6);
27638e3a54c0SPierre Jolivet     *perms = PetscSafePointerPlusOffset(sl->perms[i], sl->minMaxOrients[i][0]);
27649371c9d4SSatish Balay   }
27659371c9d4SSatish Balay   if (rots) {
27664f572ea9SToby Isaac     PetscAssertPointer(rots, 7);
27678e3a54c0SPierre Jolivet     *rots = PetscSafePointerPlusOffset(sl->rots[i], sl->minMaxOrients[i][0]);
27689371c9d4SSatish Balay   }
27693ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2770b004864fSMatthew G. Knepley }
2771b004864fSMatthew G. Knepley 
2772b004864fSMatthew G. Knepley /*@C
27735fdea053SToby Isaac   PetscSectionSymLabelSetStratum - set the symmetries for the orientations of a stratum
27745fdea053SToby Isaac 
277520f4b53cSBarry Smith   Logically
27765fdea053SToby Isaac 
27775fdea053SToby Isaac   Input Parameters:
27785b5e7992SMatthew G. Knepley + sym       - the section symmetries
27795fdea053SToby Isaac . stratum   - the stratum value in the label that we are assigning symmetries for
278020f4b53cSBarry Smith . size      - the number of dofs for points in the `stratum` of the label
278120f4b53cSBarry Smith . minOrient - the smallest orientation for a point in this `stratum`
278220f4b53cSBarry Smith . maxOrient - one greater than the largest orientation for a point in this `stratum` (i.e., orientations are in the range [`minOrient`, `maxOrient`))
278320f4b53cSBarry Smith . mode      - how `sym` should copy the `perms` and `rots` arrays
278420f4b53cSBarry Smith . perms     - `NULL` if there are no permutations, or (`maxOrient` - `minOrient`) permutations, one for each orientation.  A `NULL` permutation is the identity
278520f4b53cSBarry 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
27865fdea053SToby Isaac 
27875fdea053SToby Isaac   Level: developer
27885fdea053SToby Isaac 
278920f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `PetscSectionSymLabelGetStratum()`, `PetscSectionSymCreate()`, `PetscSectionSetSym()`, `PetscSectionGetPointSyms()`, `PetscSectionSymCreateLabel()`
27905fdea053SToby Isaac @*/
2791d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSymLabelSetStratum(PetscSectionSym sym, PetscInt stratum, PetscInt size, PetscInt minOrient, PetscInt maxOrient, PetscCopyMode mode, const PetscInt **perms, const PetscScalar **rots)
2792d71ae5a4SJacob Faibussowitsch {
27935fdea053SToby Isaac   PetscSectionSym_Label *sl;
2794d67d17b1SMatthew G. Knepley   const char            *name;
2795d67d17b1SMatthew G. Knepley   PetscInt               i, j, k;
27965fdea053SToby Isaac 
27975fdea053SToby Isaac   PetscFunctionBegin;
27985fdea053SToby Isaac   PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID, 1);
27995fdea053SToby Isaac   sl = (PetscSectionSym_Label *)sym->data;
2800b004864fSMatthew G. Knepley   PetscCheck(sl->label, PetscObjectComm((PetscObject)sym), PETSC_ERR_ARG_WRONGSTATE, "No label set yet");
28015fdea053SToby Isaac   for (i = 0; i <= sl->numStrata; i++) {
28025fdea053SToby Isaac     PetscInt value = (i < sl->numStrata) ? sl->label->stratumValues[i] : sl->label->defaultValue;
28035fdea053SToby Isaac 
28045fdea053SToby Isaac     if (stratum == value) break;
28055fdea053SToby Isaac   }
28069566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetName((PetscObject)sl->label, &name));
280763a3b9bcSJacob Faibussowitsch   PetscCheck(i <= sl->numStrata, PetscObjectComm((PetscObject)sym), PETSC_ERR_ARG_OUTOFRANGE, "Stratum %" PetscInt_FMT " not found in label %s", stratum, name);
28085fdea053SToby Isaac   sl->sizes[i]            = size;
28095fdea053SToby Isaac   sl->modes[i]            = mode;
28105fdea053SToby Isaac   sl->minMaxOrients[i][0] = minOrient;
28115fdea053SToby Isaac   sl->minMaxOrients[i][1] = maxOrient;
28125fdea053SToby Isaac   if (mode == PETSC_COPY_VALUES) {
28135fdea053SToby Isaac     if (perms) {
28145fdea053SToby Isaac       PetscInt **ownPerms;
28155fdea053SToby Isaac 
28169566063dSJacob Faibussowitsch       PetscCall(PetscCalloc1(maxOrient - minOrient, &ownPerms));
28175fdea053SToby Isaac       for (j = 0; j < maxOrient - minOrient; j++) {
28185fdea053SToby Isaac         if (perms[j]) {
28199566063dSJacob Faibussowitsch           PetscCall(PetscMalloc1(size, &ownPerms[j]));
2820ad540459SPierre Jolivet           for (k = 0; k < size; k++) ownPerms[j][k] = perms[j][k];
28215fdea053SToby Isaac         }
28225fdea053SToby Isaac       }
28235fdea053SToby Isaac       sl->perms[i] = (const PetscInt **)&ownPerms[-minOrient];
28245fdea053SToby Isaac     }
28255fdea053SToby Isaac     if (rots) {
28265fdea053SToby Isaac       PetscScalar **ownRots;
28275fdea053SToby Isaac 
28289566063dSJacob Faibussowitsch       PetscCall(PetscCalloc1(maxOrient - minOrient, &ownRots));
28295fdea053SToby Isaac       for (j = 0; j < maxOrient - minOrient; j++) {
28305fdea053SToby Isaac         if (rots[j]) {
28319566063dSJacob Faibussowitsch           PetscCall(PetscMalloc1(size, &ownRots[j]));
2832ad540459SPierre Jolivet           for (k = 0; k < size; k++) ownRots[j][k] = rots[j][k];
28335fdea053SToby Isaac         }
28345fdea053SToby Isaac       }
28355fdea053SToby Isaac       sl->rots[i] = (const PetscScalar **)&ownRots[-minOrient];
28365fdea053SToby Isaac     }
28375fdea053SToby Isaac   } else {
28388e3a54c0SPierre Jolivet     sl->perms[i] = PetscSafePointerPlusOffset(perms, -minOrient);
28398e3a54c0SPierre Jolivet     sl->rots[i]  = PetscSafePointerPlusOffset(rots, -minOrient);
28405fdea053SToby Isaac   }
28413ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28425fdea053SToby Isaac }
28435fdea053SToby Isaac 
2844d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscSectionSymGetPoints_Label(PetscSectionSym sym, PetscSection section, PetscInt numPoints, const PetscInt *points, const PetscInt **perms, const PetscScalar **rots)
2845d71ae5a4SJacob Faibussowitsch {
28465fdea053SToby Isaac   PetscInt               i, j, numStrata;
28475fdea053SToby Isaac   PetscSectionSym_Label *sl;
28485fdea053SToby Isaac   DMLabel                label;
28495fdea053SToby Isaac 
28505fdea053SToby Isaac   PetscFunctionBegin;
28515fdea053SToby Isaac   sl        = (PetscSectionSym_Label *)sym->data;
28525fdea053SToby Isaac   numStrata = sl->numStrata;
28535fdea053SToby Isaac   label     = sl->label;
28545fdea053SToby Isaac   for (i = 0; i < numPoints; i++) {
28555fdea053SToby Isaac     PetscInt point = points[2 * i];
28565fdea053SToby Isaac     PetscInt ornt  = points[2 * i + 1];
28575fdea053SToby Isaac 
28585fdea053SToby Isaac     for (j = 0; j < numStrata; j++) {
28595fdea053SToby Isaac       if (label->validIS[j]) {
28605fdea053SToby Isaac         PetscInt k;
28615fdea053SToby Isaac 
28622b4d18a0SMatthew G. Knepley         PetscCall(ISLocate(label->points[j], point, &k));
28635fdea053SToby Isaac         if (k >= 0) break;
28645fdea053SToby Isaac       } else {
28655fdea053SToby Isaac         PetscBool has;
28665fdea053SToby Isaac 
28679566063dSJacob Faibussowitsch         PetscCall(PetscHSetIHas(label->ht[j], point, &has));
28685fdea053SToby Isaac         if (has) break;
28695fdea053SToby Isaac       }
28705fdea053SToby Isaac     }
28719371c9d4SSatish 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],
28729371c9d4SSatish Balay                j < numStrata ? label->stratumValues[j] : label->defaultValue);
2873ad540459SPierre Jolivet     if (perms) perms[i] = sl->perms[j] ? sl->perms[j][ornt] : NULL;
2874ad540459SPierre Jolivet     if (rots) rots[i] = sl->rots[j] ? sl->rots[j][ornt] : NULL;
28755fdea053SToby Isaac   }
28763ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28775fdea053SToby Isaac }
28785fdea053SToby Isaac 
2879d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscSectionSymCopy_Label(PetscSectionSym sym, PetscSectionSym nsym)
2880d71ae5a4SJacob Faibussowitsch {
2881b004864fSMatthew G. Knepley   PetscSectionSym_Label *sl = (PetscSectionSym_Label *)nsym->data;
2882b004864fSMatthew G. Knepley   IS                     valIS;
2883b004864fSMatthew G. Knepley   const PetscInt        *values;
2884b004864fSMatthew G. Knepley   PetscInt               Nv, v;
2885b004864fSMatthew G. Knepley 
2886b004864fSMatthew G. Knepley   PetscFunctionBegin;
28879566063dSJacob Faibussowitsch   PetscCall(DMLabelGetNumValues(sl->label, &Nv));
28889566063dSJacob Faibussowitsch   PetscCall(DMLabelGetValueIS(sl->label, &valIS));
28899566063dSJacob Faibussowitsch   PetscCall(ISGetIndices(valIS, &values));
2890b004864fSMatthew G. Knepley   for (v = 0; v < Nv; ++v) {
2891b004864fSMatthew G. Knepley     const PetscInt      val = values[v];
2892b004864fSMatthew G. Knepley     PetscInt            size, minOrient, maxOrient;
2893b004864fSMatthew G. Knepley     const PetscInt    **perms;
2894b004864fSMatthew G. Knepley     const PetscScalar **rots;
2895b004864fSMatthew G. Knepley 
28969566063dSJacob Faibussowitsch     PetscCall(PetscSectionSymLabelGetStratum(sym, val, &size, &minOrient, &maxOrient, &perms, &rots));
28979566063dSJacob Faibussowitsch     PetscCall(PetscSectionSymLabelSetStratum(nsym, val, size, minOrient, maxOrient, PETSC_COPY_VALUES, perms, rots));
2898b004864fSMatthew G. Knepley   }
28999566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&valIS));
29003ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2901b004864fSMatthew G. Knepley }
2902b004864fSMatthew G. Knepley 
2903d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscSectionSymDistribute_Label(PetscSectionSym sym, PetscSF migrationSF, PetscSectionSym *dsym)
2904d71ae5a4SJacob Faibussowitsch {
2905b004864fSMatthew G. Knepley   PetscSectionSym_Label *sl = (PetscSectionSym_Label *)sym->data;
2906b004864fSMatthew G. Knepley   DMLabel                dlabel;
2907b004864fSMatthew G. Knepley 
2908b004864fSMatthew G. Knepley   PetscFunctionBegin;
29099566063dSJacob Faibussowitsch   PetscCall(DMLabelDistribute(sl->label, migrationSF, &dlabel));
29109566063dSJacob Faibussowitsch   PetscCall(PetscSectionSymCreateLabel(PetscObjectComm((PetscObject)sym), dlabel, dsym));
29119566063dSJacob Faibussowitsch   PetscCall(DMLabelDestroy(&dlabel));
29129566063dSJacob Faibussowitsch   PetscCall(PetscSectionSymCopy(sym, *dsym));
29133ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2914b004864fSMatthew G. Knepley }
2915b004864fSMatthew G. Knepley 
2916d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSymCreate_Label(PetscSectionSym sym)
2917d71ae5a4SJacob Faibussowitsch {
29185fdea053SToby Isaac   PetscSectionSym_Label *sl;
29195fdea053SToby Isaac 
29205fdea053SToby Isaac   PetscFunctionBegin;
29214dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&sl));
29225fdea053SToby Isaac   sym->ops->getpoints  = PetscSectionSymGetPoints_Label;
2923b004864fSMatthew G. Knepley   sym->ops->distribute = PetscSectionSymDistribute_Label;
2924b004864fSMatthew G. Knepley   sym->ops->copy       = PetscSectionSymCopy_Label;
29255fdea053SToby Isaac   sym->ops->view       = PetscSectionSymView_Label;
29265fdea053SToby Isaac   sym->ops->destroy    = PetscSectionSymDestroy_Label;
29275fdea053SToby Isaac   sym->data            = (void *)sl;
29283ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
29295fdea053SToby Isaac }
29305fdea053SToby Isaac 
29315fdea053SToby Isaac /*@
29325fdea053SToby Isaac   PetscSectionSymCreateLabel - Create a section symmetry that assigns one symmetry to each stratum of a label
29335fdea053SToby Isaac 
29345fdea053SToby Isaac   Collective
29355fdea053SToby Isaac 
29365fdea053SToby Isaac   Input Parameters:
29375fdea053SToby Isaac + comm  - the MPI communicator for the new symmetry
29385fdea053SToby Isaac - label - the label defining the strata
29395fdea053SToby Isaac 
29402fe279fdSBarry Smith   Output Parameter:
29415fdea053SToby Isaac . sym - the section symmetries
29425fdea053SToby Isaac 
29435fdea053SToby Isaac   Level: developer
29445fdea053SToby Isaac 
294520f4b53cSBarry Smith .seealso: `DMLabel`, `DM`, `PetscSectionSymCreate()`, `PetscSectionSetSym()`, `PetscSectionGetSym()`, `PetscSectionSymLabelSetStratum()`, `PetscSectionGetPointSyms()`
29465fdea053SToby Isaac @*/
2947d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSymCreateLabel(MPI_Comm comm, DMLabel label, PetscSectionSym *sym)
2948d71ae5a4SJacob Faibussowitsch {
29495fdea053SToby Isaac   PetscFunctionBegin;
29509566063dSJacob Faibussowitsch   PetscCall(DMInitializePackage());
29519566063dSJacob Faibussowitsch   PetscCall(PetscSectionSymCreate(comm, sym));
29529566063dSJacob Faibussowitsch   PetscCall(PetscSectionSymSetType(*sym, PETSCSECTIONSYMLABEL));
29539566063dSJacob Faibussowitsch   PetscCall(PetscSectionSymLabelSetLabel(*sym, label));
29543ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
29555fdea053SToby Isaac }
2956