vtk-pure-rs 0.2.0

Pure Rust visualization toolkit — data structures, filters, I/O, rendering
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
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
//! Discontinuous Galerkin / high-order cell grid representation.
//!
//! `CellGrid` is VTK 9.3+'s new data model for discontinuous fields on
//! high-order cells. Unlike `UnstructuredGrid` where cells share nodes,
//! in a `CellGrid` each cell has its own set of DOF (degrees of freedom)
//! nodes, enabling discontinuous field representations.
//!
//! # Design
//!
//! - Each cell type has its own `CellSpec` defining the reference element
//! - DOFs are stored per-cell, not shared between cells
//! - Fields can be discontinuous across cell boundaries
//! - Supports Lagrange and Bezier basis functions via `crate::types::higher_order`

use std::collections::HashMap;
use crate::data::FieldData;
use crate::types::{BoundingBox, CellType};

/// Reference element specification for a cell type.
#[derive(Debug, Clone)]
pub struct CellSpec {
    /// VTK cell type.
    pub cell_type: CellType,
    /// Polynomial order of the basis.
    pub order: usize,
    /// Number of DOF nodes per cell.
    pub dofs_per_cell: usize,
    /// Parametric coordinates of DOF nodes in reference space.
    /// Each entry is [xi, eta, zeta] in [0,1]^dim.
    pub reference_points: Vec<[f64; 3]>,
    /// Topological dimension (1=curve, 2=surface, 3=volume).
    pub dimension: usize,
}

impl CellSpec {
    /// Create a Lagrange triangle spec of given order.
    pub fn lagrange_triangle(order: usize) -> Self {
        let n = (order + 1) * (order + 2) / 2;
        let mut ref_pts = Vec::with_capacity(n);
        for j in 0..=order {
            for i in 0..=(order - j) {
                ref_pts.push([
                    i as f64 / order as f64,
                    j as f64 / order as f64,
                    0.0,
                ]);
            }
        }
        Self {
            cell_type: CellType::LagrangeTriangle,
            order,
            dofs_per_cell: n,
            reference_points: ref_pts,
            dimension: 2,
        }
    }

    /// Create a Lagrange quadrilateral spec of given order.
    pub fn lagrange_quad(order: usize) -> Self {
        let n = (order + 1) * (order + 1);
        let mut ref_pts = Vec::with_capacity(n);
        for j in 0..=order {
            for i in 0..=order {
                ref_pts.push([
                    i as f64 / order as f64,
                    j as f64 / order as f64,
                    0.0,
                ]);
            }
        }
        Self {
            cell_type: CellType::LagrangeQuadrilateral,
            order,
            dofs_per_cell: n,
            reference_points: ref_pts,
            dimension: 2,
        }
    }

    /// Create a Lagrange tetrahedron spec of given order.
    pub fn lagrange_tet(order: usize) -> Self {
        let mut ref_pts = Vec::new();
        for k in 0..=order {
            for j in 0..=(order - k) {
                for i in 0..=(order - j - k) {
                    ref_pts.push([
                        i as f64 / order as f64,
                        j as f64 / order as f64,
                        k as f64 / order as f64,
                    ]);
                }
            }
        }
        Self {
            cell_type: CellType::LagrangeTetrahedron,
            order,
            dofs_per_cell: ref_pts.len(),
            dimension: 3,
            reference_points: ref_pts,
        }
    }

    /// Create a Lagrange hexahedron spec of given order.
    pub fn lagrange_hex(order: usize) -> Self {
        let n = (order + 1).pow(3);
        let mut ref_pts = Vec::with_capacity(n);
        for k in 0..=order {
            for j in 0..=order {
                for i in 0..=order {
                    ref_pts.push([
                        i as f64 / order as f64,
                        j as f64 / order as f64,
                        k as f64 / order as f64,
                    ]);
                }
            }
        }
        Self {
            cell_type: CellType::LagrangeHexahedron,
            order,
            dofs_per_cell: n,
            reference_points: ref_pts,
            dimension: 3,
        }
    }

    /// Create a Lagrange curve spec of given order.
    pub fn lagrange_curve(order: usize) -> Self {
        let n = order + 1;
        let ref_pts: Vec<[f64; 3]> = (0..n)
            .map(|i| [i as f64 / order as f64, 0.0, 0.0])
            .collect();
        Self {
            cell_type: CellType::LagrangeCurve,
            order,
            dofs_per_cell: n,
            reference_points: ref_pts,
            dimension: 1,
        }
    }

    /// Evaluate Lagrange basis functions at a parametric point.
    /// Returns `dofs_per_cell` weights that sum to 1.
    pub fn evaluate_basis(&self, xi: [f64; 3]) -> Vec<f64> {
        match self.dimension {
            1 => crate::types::higher_order::lagrange_1d(self.order, xi[0]),
            2 => self.evaluate_basis_2d(xi[0], xi[1]),
            3 => self.evaluate_basis_3d(xi[0], xi[1], xi[2]),
            _ => vec![1.0],
        }
    }

    fn evaluate_basis_2d(&self, xi: f64, eta: f64) -> Vec<f64> {
        // Tensor-product for quads, special handling for triangles
        if self.cell_type == CellType::LagrangeQuadrilateral {
            let bx = crate::types::higher_order::lagrange_1d(self.order, xi);
            let by = crate::types::higher_order::lagrange_1d(self.order, eta);
            let mut result = Vec::with_capacity(self.dofs_per_cell);
            for j in 0..=self.order {
                for i in 0..=self.order {
                    result.push(bx[i] * by[j]);
                }
            }
            result
        } else {
            // Triangle: evaluate at each reference point
            let mut basis = vec![0.0; self.dofs_per_cell];
            for (k, rp) in self.reference_points.iter().enumerate() {
                let mut val = 1.0;
                for (j, rq) in self.reference_points.iter().enumerate() {
                    if j != k {
                        let dx = rp[0] - rq[0];
                        let dy = rp[1] - rq[1];
                        let d2 = dx * dx + dy * dy;
                        if d2 > 1e-30 {
                            let px = xi - rq[0];
                            let py = eta - rq[1];
                            val *= (px * dx + py * dy) / d2;
                        }
                    }
                }
                basis[k] = val;
            }
            basis
        }
    }

    fn evaluate_basis_3d(&self, xi: f64, eta: f64, zeta: f64) -> Vec<f64> {
        if self.cell_type == CellType::LagrangeHexahedron {
            let bx = crate::types::higher_order::lagrange_1d(self.order, xi);
            let by = crate::types::higher_order::lagrange_1d(self.order, eta);
            let bz = crate::types::higher_order::lagrange_1d(self.order, zeta);
            let mut result = Vec::with_capacity(self.dofs_per_cell);
            for k in 0..=self.order {
                for j in 0..=self.order {
                    for i in 0..=self.order {
                        result.push(bx[i] * by[j] * bz[k]);
                    }
                }
            }
            result
        } else {
            // Generic: identity at reference points
            vec![1.0 / self.dofs_per_cell as f64; self.dofs_per_cell]
        }
    }
}

/// A single DG cell with its own DOF coordinates and field data.
#[derive(Debug, Clone)]
pub struct DGCell {
    /// Physical coordinates of DOF nodes: dofs_per_cell × 3.
    pub coordinates: Vec<[f64; 3]>,
    /// Scalar/vector fields at DOF nodes. Key = field name, Value = flat f64 data.
    pub fields: HashMap<String, Vec<f64>>,
}

/// A grid of discontinuous Galerkin cells.
///
/// Each cell has its own DOF nodes (not shared), enabling
/// discontinuous field representations across cell boundaries.
#[derive(Debug, Clone)]
pub struct CellGrid {
    /// Cell specification (shared by all cells of the same type).
    pub spec: CellSpec,
    /// Individual cells with their DOF data.
    pub cells: Vec<DGCell>,
    /// Global field data (not per-DOF).
    pub field_data: FieldData,
}

impl CellGrid {
    /// Create an empty CellGrid with the given cell spec.
    pub fn new(spec: CellSpec) -> Self {
        Self {
            spec,
            cells: Vec::new(),
            field_data: FieldData::new(),
        }
    }

    /// Add a cell with its DOF coordinates.
    pub fn add_cell(&mut self, coordinates: Vec<[f64; 3]>) {
        assert_eq!(coordinates.len(), self.spec.dofs_per_cell,
            "expected {} DOF coordinates, got {}", self.spec.dofs_per_cell, coordinates.len());
        self.cells.push(DGCell {
            coordinates,
            fields: HashMap::new(),
        });
    }

    /// Add a cell with coordinates and a scalar field.
    pub fn add_cell_with_field(
        &mut self,
        coordinates: Vec<[f64; 3]>,
        field_name: &str,
        field_values: Vec<f64>,
    ) {
        assert_eq!(coordinates.len(), self.spec.dofs_per_cell);
        assert_eq!(field_values.len(), self.spec.dofs_per_cell);
        let mut fields = HashMap::new();
        fields.insert(field_name.to_string(), field_values);
        self.cells.push(DGCell { coordinates, fields });
    }

    /// Set a field on all cells. `values` must have length `num_cells * dofs_per_cell`.
    pub fn set_field(&mut self, name: &str, values: &[f64]) {
        let dpn = self.spec.dofs_per_cell;
        assert_eq!(values.len(), self.cells.len() * dpn);
        for (i, cell) in self.cells.iter_mut().enumerate() {
            cell.fields.insert(
                name.to_string(),
                values[i * dpn..(i + 1) * dpn].to_vec(),
            );
        }
    }

    /// Evaluate a field at a parametric point within a cell.
    pub fn evaluate_field(&self, cell_idx: usize, field_name: &str, xi: [f64; 3]) -> Option<f64> {
        let cell = self.cells.get(cell_idx)?;
        let values = cell.fields.get(field_name)?;
        let basis = self.spec.evaluate_basis(xi);
        let mut result = 0.0;
        for (b, v) in basis.iter().zip(values.iter()) {
            result += b * v;
        }
        Some(result)
    }

    /// Evaluate physical coordinates at a parametric point within a cell.
    pub fn evaluate_position(&self, cell_idx: usize, xi: [f64; 3]) -> Option<[f64; 3]> {
        let cell = self.cells.get(cell_idx)?;
        let basis = self.spec.evaluate_basis(xi);
        let mut pos = [0.0; 3];
        for (b, coord) in basis.iter().zip(cell.coordinates.iter()) {
            pos[0] += b * coord[0];
            pos[1] += b * coord[1];
            pos[2] += b * coord[2];
        }
        Some(pos)
    }

    /// Number of cells.
    pub fn num_cells(&self) -> usize {
        self.cells.len()
    }

    /// Total number of DOF nodes across all cells.
    pub fn total_dofs(&self) -> usize {
        self.cells.len() * self.spec.dofs_per_cell
    }

    /// Polynomial order.
    pub fn order(&self) -> usize {
        self.spec.order
    }

    /// Bounding box of all DOF coordinates.
    pub fn bounds(&self) -> BoundingBox {
        let mut bb = BoundingBox::empty();
        for cell in &self.cells {
            for p in &cell.coordinates {
                bb.expand(*p);
            }
        }
        bb
    }

    /// Convert to linear mesh by sampling at reference vertices only.
    /// Returns (points, cell_connectivity) suitable for PolyData/UnstructuredGrid.
    pub fn to_linear_mesh(&self) -> (Vec<[f64; 3]>, Vec<Vec<usize>>) {
        let mut points = Vec::new();
        let mut cells = Vec::new();

        // For each cell, take only the corner DOFs (first dim+1 or 2^dim)
        let corners = match self.spec.dimension {
            1 => vec![0, self.spec.order], // first and last
            2 => {
                if self.spec.cell_type == CellType::LagrangeTriangle {
                    vec![0, self.spec.order, self.spec.dofs_per_cell - 1]
                } else {
                    vec![0, self.spec.order, self.spec.dofs_per_cell - self.spec.order - 1, self.spec.dofs_per_cell - 1]
                }
            }
            3 => {
                // Just take first 4 (tet) or 8 (hex) nodes
                let n = if self.spec.cell_type == CellType::LagrangeTetrahedron { 4 } else { 8 };
                (0..n.min(self.spec.dofs_per_cell)).collect()
            }
            _ => vec![0],
        };

        for cell in &self.cells {
            let base = points.len();
            let mut conn = Vec::new();
            for &ci in &corners {
                if ci < cell.coordinates.len() {
                    points.push(cell.coordinates[ci]);
                    conn.push(base + conn.len());
                }
            }
            cells.push(conn);
        }

        (points, cells)
    }

    /// Tessellate each cell into linear sub-cells for visualization.
    /// Subdivides each parametric cell into `subdivisions^dim` sub-cells.
    pub fn tessellate(&self, subdivisions: usize) -> (Vec<[f64; 3]>, Vec<[usize; 3]>) {
        let mut points = Vec::new();
        let mut triangles = Vec::new();
        let n = subdivisions;

        for cell_idx in 0..self.cells.len() {
            match self.spec.dimension {
                2 => {
                    // Tessellate as a grid of triangles in parametric space
                    let base = points.len();
                    for j in 0..=n {
                        for i in 0..=n {
                            let xi = [i as f64 / n as f64, j as f64 / n as f64, 0.0];
                            if let Some(pos) = self.evaluate_position(cell_idx, xi) {
                                points.push(pos);
                            }
                        }
                    }
                    for j in 0..n {
                        for i in 0..n {
                            let v00 = base + j * (n + 1) + i;
                            let v10 = v00 + 1;
                            let v01 = v00 + (n + 1);
                            let v11 = v01 + 1;
                            triangles.push([v00, v10, v11]);
                            triangles.push([v00, v11, v01]);
                        }
                    }
                }
                _ => {
                    // For 1D/3D, just add corner points
                    if let Some(pos) = self.evaluate_position(cell_idx, [0.0, 0.0, 0.0]) {
                        points.push(pos);
                    }
                }
            }
        }

        (points, triangles)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn lagrange_triangle_p1() {
        let spec = CellSpec::lagrange_triangle(1);
        assert_eq!(spec.dofs_per_cell, 3);
        assert_eq!(spec.order, 1);
        assert_eq!(spec.dimension, 2);
    }

    #[test]
    fn lagrange_triangle_p2() {
        let spec = CellSpec::lagrange_triangle(2);
        assert_eq!(spec.dofs_per_cell, 6); // (2+1)(2+2)/2 = 6
    }

    #[test]
    fn lagrange_hex_p1() {
        let spec = CellSpec::lagrange_hex(1);
        assert_eq!(spec.dofs_per_cell, 8);
    }

    #[test]
    fn lagrange_hex_p2() {
        let spec = CellSpec::lagrange_hex(2);
        assert_eq!(spec.dofs_per_cell, 27); // 3^3
    }

    #[test]
    fn cell_grid_add_and_evaluate() {
        let spec = CellSpec::lagrange_quad(1);
        let mut grid = CellGrid::new(spec);

        // Unit square with linear field f(x,y) = x + y
        let coords = vec![
            [0.0, 0.0, 0.0], [1.0, 0.0, 0.0],
            [0.0, 1.0, 0.0], [1.0, 1.0, 0.0],
        ];
        let field = vec![0.0, 1.0, 1.0, 2.0]; // f = x + y at corners
        grid.add_cell_with_field(coords, "f", field);

        assert_eq!(grid.num_cells(), 1);
        assert_eq!(grid.total_dofs(), 4);

        // Evaluate at center: f(0.5, 0.5) should be ~1.0
        let val = grid.evaluate_field(0, "f", [0.5, 0.5, 0.0]).unwrap();
        assert!((val - 1.0).abs() < 1e-10, "f(0.5,0.5) = {val}, expected 1.0");

        // Evaluate position at center
        let pos = grid.evaluate_position(0, [0.5, 0.5, 0.0]).unwrap();
        assert!((pos[0] - 0.5).abs() < 1e-10);
        assert!((pos[1] - 0.5).abs() < 1e-10);
    }

    #[test]
    fn cell_grid_set_field() {
        let spec = CellSpec::lagrange_curve(2);
        let mut grid = CellGrid::new(spec);
        grid.add_cell(vec![[0.0,0.0,0.0], [0.5,0.0,0.0], [1.0,0.0,0.0]]);
        grid.add_cell(vec![[1.0,0.0,0.0], [1.5,0.0,0.0], [2.0,0.0,0.0]]);

        grid.set_field("u", &[0.0, 0.25, 1.0, 1.0, 2.25, 4.0]); // u = x^2

        let v0 = grid.evaluate_field(0, "u", [0.5, 0.0, 0.0]).unwrap();
        assert!((v0 - 0.25).abs() < 0.1, "u(0.5) ≈ 0.25, got {v0}");
    }

    #[test]
    fn cell_grid_bounds() {
        let spec = CellSpec::lagrange_triangle(1);
        let mut grid = CellGrid::new(spec);
        grid.add_cell(vec![[0.0,0.0,0.0], [1.0,0.0,0.0], [0.0,1.0,0.0]]);

        let bb = grid.bounds();
        assert!((bb.size()[0] - 1.0).abs() < 1e-10);
        assert!((bb.size()[1] - 1.0).abs() < 1e-10);
    }

    #[test]
    fn tessellate_quad() {
        let spec = CellSpec::lagrange_quad(1);
        let mut grid = CellGrid::new(spec);
        grid.add_cell(vec![
            [0.0,0.0,0.0], [1.0,0.0,0.0],
            [0.0,1.0,0.0], [1.0,1.0,0.0],
        ]);

        let (pts, tris) = grid.tessellate(4);
        assert_eq!(pts.len(), 25); // (4+1)^2
        assert_eq!(tris.len(), 32); // 4*4*2
    }

    #[test]
    fn to_linear_mesh() {
        let spec = CellSpec::lagrange_quad(2);
        let mut grid = CellGrid::new(spec);
        // 9-node biquadratic quad
        let mut coords = Vec::new();
        for j in 0..=2 {
            for i in 0..=2 {
                coords.push([i as f64, j as f64, 0.0]);
            }
        }
        grid.add_cell(coords);

        let (pts, cells) = grid.to_linear_mesh();
        assert_eq!(cells.len(), 1);
        assert_eq!(cells[0].len(), 4); // extracted 4 corners from 9-node quad
    }
}