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

//! Mesh I/O helpers for sieve topology and sections.
//!
//! This module provides trait-based readers and writers for loading and
//! saving `Sieve` topologies together with associated `Section` data.

pub mod bundle;
pub mod cgns;
pub mod exodus;
pub mod fluent;
pub mod gmsh;
pub mod hdf5;
pub mod partitioned;
pub mod petsc_hdf5;
pub mod ply;
pub mod vtk;
pub mod xdmf;

use crate::data::coordinates::Coordinates;
use crate::data::discretization::Discretization;
use crate::data::mixed_section::MixedSectionStore;
use crate::data::section::Section;
use crate::data::storage::Storage;
use crate::mesh_error::MeshSieveError;
use crate::topology::cell_type::CellType;
use crate::topology::labels::LabelSet;
use crate::topology::sieve::Sieve;
use std::collections::BTreeMap;
use std::io::{Read, Write};

pub use bundle::MeshBundle;
pub use partitioned::{
    GatherPolicy, NeighborLinks, OverlapLink, OverlapMetadata, PartitionedMeshData,
    PartitionedMeshMetadata, PartitionedMeshWriteOutcome, read_partitioned_mesh,
    write_local_piece_with_metadata, write_partitioned_mesh,
};

/// Combined sieve and section data returned by I/O readers.
#[derive(Debug)]
pub struct MeshData<S, V, St, CtSt>
where
    St: Storage<V>,
    CtSt: Storage<CellType>,
{
    /// The mesh topology as a sieve.
    pub sieve: S,
    /// Optional coordinate section wrapper.
    pub coordinates: Option<Coordinates<V, St>>,
    /// Named sections keyed by user-provided identifiers.
    pub sections: BTreeMap<String, Section<V, St>>,
    /// Tagged sections with mixed scalar types.
    pub mixed_sections: MixedSectionStore,
    /// Optional integer labels associated with mesh points.
    pub labels: Option<LabelSet>,
    /// Optional cell type section over mesh points.
    pub cell_types: Option<Section<CellType, CtSt>>,
    /// Optional discretization metadata keyed by regions.
    pub discretization: Option<Discretization>,
}

impl<S, V, St, CtSt> MeshData<S, V, St, CtSt>
where
    St: Storage<V>,
    CtSt: Storage<CellType>,
{
    /// Create an empty container with a sieve and no sections.
    pub fn new(sieve: S) -> Self {
        Self {
            sieve,
            coordinates: None,
            sections: BTreeMap::new(),
            mixed_sections: MixedSectionStore::default(),
            labels: None,
            cell_types: None,
            discretization: None,
        }
    }
}

/// Trait for mesh readers that produce sieve + section data.
pub trait SieveSectionReader {
    /// Sieve implementation returned by the reader.
    type Sieve: Sieve;
    /// Scalar value stored in sections.
    type Value;
    /// Storage backend for section data.
    type Storage: Storage<Self::Value>;
    /// Storage backend for cell type data.
    type CellStorage: Storage<CellType>;

    /// Parse mesh data from a reader.
    fn read<R: Read>(
        &self,
        reader: R,
    ) -> Result<MeshData<Self::Sieve, Self::Value, Self::Storage, Self::CellStorage>, MeshSieveError>;
}

/// Trait for mesh writers that serialize sieve + section data.
pub trait SieveSectionWriter {
    /// Sieve implementation expected by the writer.
    type Sieve: Sieve;
    /// Scalar value stored in sections.
    type Value;
    /// Storage backend for section data.
    type Storage: Storage<Self::Value>;
    /// Storage backend for cell type data.
    type CellStorage: Storage<CellType>;

    /// Write mesh data to a writer.
    fn write<W: Write>(
        &self,
        writer: W,
        mesh: &MeshData<Self::Sieve, Self::Value, Self::Storage, Self::CellStorage>,
    ) -> Result<(), MeshSieveError>;
}