mesh-sieve 4.0.1

Modular, high-performance Rust library for mesh and data management, designed for scientific computing and PDE codes.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
//! Point label storage for topology metadata.
//!
//! Labels map `PointId` → integer tags, grouped by label name.
//! This is useful for boundary conditions, material IDs, or other
//! integer annotations on mesh points.

use std::collections::{BTreeMap, HashMap, HashSet};
use std::ops::RangeBounds;

use crate::algs::submesh::{SubmeshMaps, SubmeshSelection, extract_by_label};
use crate::data::storage::Storage;
use crate::io::MeshData;
use crate::mesh_error::MeshSieveError;
use crate::topology::cell_type::CellType;
use crate::topology::point::PointId;
use crate::topology::sieve::{OrientedMeshSieve, OrientedSieve, Sieve};

/// Named integer labels for mesh points.
#[derive(Clone, Debug, Default)]
pub struct LabelSet {
    labels: HashMap<String, HashMap<PointId, i32>>,
}

/// Deterministic iteration order contract for label strata.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum LabelIterationOrder {
    /// Sort by `PointId` only.
    PointAscending,
    /// Sort by label value ascending, then `PointId`.
    ValueThenPointAscending,
}

impl LabelSet {
    /// Creates an empty label set.
    pub fn new() -> Self {
        Self::default()
    }

    /// Assigns `value` for `point` under label `name`.
    ///
    /// Returns the previous value, if any.
    pub fn set_label(&mut self, point: PointId, name: &str, value: i32) -> Option<i32> {
        self.labels
            .entry(name.to_string())
            .or_default()
            .insert(point, value)
    }

    /// Returns the label value for `point` under `name`.
    pub fn get_label(&self, point: PointId, name: &str) -> Option<i32> {
        self.labels
            .get(name)
            .and_then(|map| map.get(&point).copied())
    }

    /// Returns all points with label `name == value`.
    pub fn points_with_label<'a>(
        &'a self,
        name: &'a str,
        value: i32,
    ) -> impl Iterator<Item = PointId> + 'a {
        self.labels.get(name).into_iter().flat_map(move |map| {
            map.iter()
                .filter_map(move |(&point, &label_value)| (label_value == value).then_some(point))
        })
    }

    /// Returns the number of points with label `name == value`.
    pub fn stratum_size(&self, name: &str, value: i32) -> usize {
        self.labels.get(name).map_or(0, |map| {
            map.values()
                .filter(|&&label_value| label_value == value)
                .count()
        })
    }

    /// Returns all points with label `name == value` in deterministic order.
    pub fn stratum_points(&self, name: &str, value: i32) -> Vec<PointId> {
        let mut points: Vec<_> = self.points_with_label(name, value).collect();
        points.sort_unstable();
        points
    }

    /// Returns all distinct values stored for label `name`, sorted ascending.
    pub fn stratum_values(&self, name: &str) -> Vec<i32> {
        let mut values: Vec<i32> = self
            .labels
            .get(name)
            .map_or_else(Vec::new, |map| map.values().copied().collect());
        values.sort_unstable();
        values.dedup();
        values
    }

    /// Backwards-compatible alias for [`LabelSet::stratum_values`].
    pub fn values(&self, name: &str) -> Vec<i32> {
        self.stratum_values(name)
    }

    /// Builds a value-indexed view of the label stratum for efficient range queries.
    pub fn strata_by_value(&self, name: &str) -> BTreeMap<i32, Vec<PointId>> {
        let Some(map) = self.labels.get(name) else {
            return BTreeMap::new();
        };
        let mut strata: BTreeMap<i32, Vec<PointId>> = BTreeMap::new();
        for (&point, &value) in map {
            strata.entry(value).or_default().push(point);
        }
        for points in strata.values_mut() {
            points.sort_unstable();
        }
        strata
    }

    /// Returns points with `name` values inside the provided range.
    ///
    /// Points are ordered by value, then by point ID.
    pub fn stratum_points_in_range<R>(&self, name: &str, range: R) -> Vec<PointId>
    where
        R: RangeBounds<i32>,
    {
        let strata = self.strata_by_value(name);
        let mut points = Vec::new();
        for (_, stratum_points) in strata.range(range) {
            points.extend(stratum_points.iter().copied());
        }
        points
    }

    /// Returns the union of two label strata, sorted deterministically.
    pub fn stratum_union(&self, other: &LabelSet, name: &str, value: i32) -> Vec<PointId> {
        let mut union: HashSet<PointId> = self.points_with_label(name, value).collect();
        union.extend(other.points_with_label(name, value));
        let mut points: Vec<_> = union.into_iter().collect();
        points.sort_unstable();
        points
    }

    /// Returns the intersection of two label strata, sorted deterministically.
    pub fn stratum_intersection(&self, other: &LabelSet, name: &str, value: i32) -> Vec<PointId> {
        let other_points: HashSet<PointId> = other.points_with_label(name, value).collect();
        let mut points: Vec<_> = self
            .points_with_label(name, value)
            .filter(|point| other_points.contains(point))
            .collect();
        points.sort_unstable();
        points
    }

    /// Returns the difference between two label strata, sorted deterministically.
    ///
    /// Points returned are those in `self` that are not in `other`.
    pub fn stratum_difference(&self, other: &LabelSet, name: &str, value: i32) -> Vec<PointId> {
        let other_points: HashSet<PointId> = other.points_with_label(name, value).collect();
        let mut points: Vec<_> = self
            .points_with_label(name, value)
            .filter(|point| !other_points.contains(point))
            .collect();
        points.sort_unstable();
        points
    }

    /// Removes all points with label `name == value`.
    ///
    /// Returns the number of removed points.
    pub fn clear_label_value(&mut self, name: &str, value: i32) -> usize {
        let Some(map) = self.labels.get_mut(name) else {
            return 0;
        };

        let before = map.len();
        map.retain(|_, label_value| *label_value != value);
        let removed = before - map.len();
        if map.is_empty() {
            self.labels.remove(name);
        }
        removed
    }

    /// Returns a new label set containing only labels on the provided points.
    pub fn filtered_to_points<I>(&self, points: I) -> Self
    where
        I: IntoIterator<Item = PointId>,
    {
        let keep: HashSet<PointId> = points.into_iter().collect();
        if keep.is_empty() {
            return Self::default();
        }

        let mut out = LabelSet::new();
        for (name, values) in &self.labels {
            for (&point, &value) in values {
                if keep.contains(&point) {
                    out.set_label(point, name, value);
                }
            }
        }
        out
    }

    /// Returns true when the label set has no entries.
    pub fn is_empty(&self) -> bool {
        self.labels.is_empty()
    }

    /// Remove all label entries for the provided points.
    pub fn clear_points<I>(&mut self, points: I)
    where
        I: IntoIterator<Item = PointId>,
    {
        let targets: HashSet<PointId> = points.into_iter().collect();
        if targets.is_empty() {
            return;
        }
        let mut empty_labels = Vec::new();
        for (name, map) in &mut self.labels {
            map.retain(|point, _| !targets.contains(point));
            if map.is_empty() {
                empty_labels.push(name.clone());
            }
        }
        for name in empty_labels {
            self.labels.remove(&name);
        }
    }

    /// Iterate over all labels as `(name, point, value)`.
    pub fn iter(&self) -> impl Iterator<Item = (&str, PointId, i32)> + '_ {
        self.labels.iter().flat_map(|(name, map)| {
            map.iter()
                .map(move |(&point, &value)| (name.as_str(), point, value))
        })
    }

    /// Apply a label to the closure of a set of seed points.
    pub fn apply_to_closure<S>(
        &mut self,
        sieve: &S,
        name: &str,
        value: i32,
        seeds: impl IntoIterator<Item = PointId>,
    ) where
        S: Sieve<Point = PointId>,
    {
        for point in sieve.closure_iter(seeds) {
            self.set_label(point, name, value);
        }
    }

    /// Apply a label to the star/support of a set of seed points.
    pub fn apply_to_star<S>(
        &mut self,
        sieve: &S,
        name: &str,
        value: i32,
        seeds: impl IntoIterator<Item = PointId>,
    ) where
        S: Sieve<Point = PointId>,
    {
        for point in sieve.star_iter(seeds) {
            self.set_label(point, name, value);
        }
    }

    /// Copy all points in `src_name/src_value` into `dst_name/dst_value`.
    pub fn union_into(
        &mut self,
        other: &LabelSet,
        src_name: &str,
        src_value: i32,
        dst_name: &str,
        dst_value: i32,
    ) {
        for point in other.stratum_points(src_name, src_value) {
            self.set_label(point, dst_name, dst_value);
        }
    }

    /// Intersect current `dst_name/dst_value` with `other/src_name/src_value`.
    pub fn intersect_with(
        &mut self,
        other: &LabelSet,
        src_name: &str,
        src_value: i32,
        dst_name: &str,
        dst_value: i32,
    ) {
        let keep: HashSet<PointId> = other
            .stratum_points(src_name, src_value)
            .into_iter()
            .collect();
        let to_remove: Vec<PointId> = self
            .stratum_points(dst_name, dst_value)
            .into_iter()
            .filter(|p| !keep.contains(p))
            .collect();
        for p in to_remove {
            if let Some(map) = self.labels.get_mut(dst_name) {
                map.remove(&p);
            }
        }
    }

    /// Subtract points in `other/src_name/src_value` from `dst_name/dst_value`.
    pub fn subtract(
        &mut self,
        other: &LabelSet,
        src_name: &str,
        src_value: i32,
        dst_name: &str,
        dst_value: i32,
    ) {
        let remove: HashSet<PointId> = other
            .stratum_points(src_name, src_value)
            .into_iter()
            .collect();
        for p in remove {
            if self.get_label(p, dst_name) == Some(dst_value)
                && let Some(map) = self.labels.get_mut(dst_name)
            {
                map.remove(&p);
            }
        }
    }

    /// Remap all points in one stratum value to another.
    pub fn remap_value(&mut self, name: &str, from: i32, to: i32) {
        for p in self.stratum_points(name, from) {
            self.set_label(p, name, to);
        }
    }
}

/// Expand a label stratum to include the closure of its points.
///
/// This mirrors the behavior of DMPlexLabelComplete for a single label value by applying
/// the label to every point in the closure of each labeled point.
pub fn complete_label_value<S>(sieve: &S, labels: &LabelSet, name: &str, value: i32) -> LabelSet
where
    S: Sieve<Point = PointId>,
{
    propagate_label_value_closure(sieve, labels, name, value)
}

/// Expand all labels to include the closure of their points.
pub fn complete_label_set<S>(sieve: &S, labels: &LabelSet) -> LabelSet
where
    S: Sieve<Point = PointId>,
{
    propagate_label_set_closure(sieve, labels)
}

/// Propagate a label stratum through the closure of its points.
pub fn propagate_label_value_closure<S>(
    sieve: &S,
    labels: &LabelSet,
    name: &str,
    value: i32,
) -> LabelSet
where
    S: Sieve<Point = PointId>,
{
    let mut out = labels.clone();
    let seeds: Vec<PointId> = labels.points_with_label(name, value).collect();
    if seeds.is_empty() {
        return out;
    }
    for point in sieve.closure_iter(seeds) {
        out.set_label(point, name, value);
    }
    out
}

/// Propagate a label stratum through the star of its points.
pub fn propagate_label_value_star<S>(
    sieve: &S,
    labels: &LabelSet,
    name: &str,
    value: i32,
) -> LabelSet
where
    S: Sieve<Point = PointId>,
{
    let mut out = labels.clone();
    let seeds: Vec<PointId> = labels.points_with_label(name, value).collect();
    if seeds.is_empty() {
        return out;
    }
    for point in sieve.star_iter(seeds) {
        out.set_label(point, name, value);
    }
    out
}

/// Propagate all labels through the closure of their points.
pub fn propagate_label_set_closure<S>(sieve: &S, labels: &LabelSet) -> LabelSet
where
    S: Sieve<Point = PointId>,
{
    let mut out = labels.clone();
    let mut names: HashSet<String> = HashSet::new();
    for (name, _, _) in labels.iter() {
        names.insert(name.to_string());
    }
    for name in names {
        for value in labels.stratum_values(&name) {
            out = propagate_label_value_closure(sieve, &out, &name, value);
        }
    }
    out
}

/// Propagate all labels through the star of their points.
pub fn propagate_label_set_star<S>(sieve: &S, labels: &LabelSet) -> LabelSet
where
    S: Sieve<Point = PointId>,
{
    let mut out = labels.clone();
    let mut names: HashSet<String> = HashSet::new();
    for (name, _, _) in labels.iter() {
        names.insert(name.to_string());
    }
    for name in names {
        for value in labels.stratum_values(&name) {
            out = propagate_label_value_star(sieve, &out, &name, value);
        }
    }
    out
}

/// Extract a submesh from points tagged by a label, including the full closure.
pub fn extract_submesh_from_label<S, V, St, CtSt>(
    mesh: &MeshData<S, V, St, CtSt>,
    labels: &LabelSet,
    label_name: &str,
    label_value: i32,
) -> Result<
    (
        MeshData<OrientedMeshSieve<PointId, S::Payload>, V, St, CtSt>,
        SubmeshMaps,
    ),
    MeshSieveError,
>
where
    S: OrientedSieve<Point = PointId, Orient = i32>,
    S::Payload: Clone,
    V: Clone + Default,
    St: Storage<V> + Clone,
    CtSt: Storage<CellType> + Clone,
{
    let completed = complete_label_value(&mesh.sieve, labels, label_name, label_value);
    extract_by_label(
        mesh,
        &completed,
        label_name,
        label_value,
        SubmeshSelection::FullClosure,
    )
}