petekio 0.3.14

Subsurface data ingestion + structure layer: surfaces, wells, points, polygons with loading, interpolation, and statistics.
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

//! Cross-level surface conversions.
//!
//! **Up is free and lossless** (node identity preserved; every attribute lane
//! carries over 1:1): `Surface → StructuredMeshSurface → TriSurface`.
//! **Down is a resample** onto a target [`GridGeometry`] through the shared
//! gridding kernels (the same path `to_points().to_surface(...)` takes), one
//! lane at a time — primary plus all attributes.
//!
//! The shell-level counterparts (`GridGeometry::to_structured_shell` /
//! `to_mesh_shell`, `StructuredShell::to_mesh_shell`, `infer_grid`) live in
//! [`core::shell`](crate::core::shell); this module lifts them to full
//! surfaces (shell + property lanes).

use crate::core::value_layer::grid_lane_on_mesh;
use crate::core::{GridMethod, PointSet, StructuredMeshSurface, Surface, TriSurface};
use crate::foundation::{GridGeometry, HasHistory, Result};
use std::sync::Arc;

impl Surface {
    /// Lift to a level-2 [`StructuredMeshSurface`]: explicit per-node XY
    /// computed from the grid, `nominal_geometry` = this grid, all attribute
    /// lanes carried 1:1. Lossless.
    pub fn to_structured_mesh(&self) -> Result<StructuredMeshSurface> {
        let shell = Arc::new(self.geom.to_structured_shell());
        let mut out = StructuredMeshSurface::from_shell(shell, self.values().clone())?;
        for name in self.attr_names() {
            let lane = self.attr(name).expect("listed attribute exists").clone();
            out.set_attr(name, lane)?;
        }
        out.set_history(self.history_with("surface.to_structured_mesh()"));
        Ok(out)
    }

    /// Lift to a level-3 [`TriSurface`]: the grid quad-splits along a
    /// consistent diagonal, every lane maps per node through the shell's
    /// `(i, j)` labels. Lossless (node identity preserved).
    pub fn to_tri_surface(&self) -> Result<TriSurface> {
        let shell = Arc::new(self.geom.to_mesh_shell()?);
        let values = grid_lane_on_mesh(&shell, self.values());
        let mut out = TriSurface::from_shell(Arc::clone(&shell), values)?;
        for name in self.attr_names() {
            let lane = grid_lane_on_mesh(&shell, self.attr(name).expect("listed attribute exists"));
            out.set_attr(name, lane)?;
        }
        out.set_history(self.history_with("surface.to_tri_surface()"));
        Ok(out)
    }
}

impl StructuredMeshSurface {
    /// Lift to a level-3 [`TriSurface`]: the shell quad-splits (explicit XY
    /// honoured exactly), every lane maps per node through the `(i, j)`
    /// labels. Lossless for every node that carries finite XY.
    pub fn to_tri_surface(&self) -> Result<TriSurface> {
        let mesh = Arc::new(self.shell().to_mesh_shell()?);
        let values = grid_lane_on_mesh(&mesh, self.values());
        let mut out = TriSurface::from_shell(Arc::clone(&mesh), values)?;
        for name in self.attr_names() {
            let lane = grid_lane_on_mesh(&mesh, self.attr(name).expect("listed attribute exists"));
            out.set_attr(name, lane)?;
        }
        out.set_history(
            self.operation_history()
                .with_entry("structured_surface.to_tri_surface()"),
        );
        Ok(out)
    }

    /// Resample primary **and all attribute lanes** onto a target regular
    /// geometry through the shared gridding kernels (the lossy downward
    /// conversion; same kernels as [`PointSet::to_surface`]).
    pub fn resample(&self, target: &GridGeometry, method: GridMethod) -> Result<Surface> {
        let (x, y) = (self.x(), self.y());
        let lane_coords = |lane: &ndarray::Array2<f64>| -> Vec<[f64; 3]> {
            let mut coords = Vec::new();
            for j in 0..self.nrow() {
                for i in 0..self.ncol() {
                    let (px, py, pz) = (x[[i, j]], y[[i, j]], lane[[i, j]]);
                    if px.is_finite() && py.is_finite() && pz.is_finite() {
                        coords.push([px, py, pz]);
                    }
                }
            }
            coords
        };
        let lanes: Vec<(&str, Vec<[f64; 3]>)> = self
            .attr_names()
            .into_iter()
            .map(|name| (name, lane_coords(self.attr(name).expect("listed"))))
            .collect();
        let mut out = grid_lanes(lane_coords(self.values()), lanes, target, method)?;
        out.set_history(self.operation_history().with_entry(format!(
            "structured_surface.resample(ncol={}, nrow={}, method={method:?})",
            target.ncol, target.nrow
        )));
        Ok(out)
    }
}

impl TriSurface {
    /// Resample primary **and all attribute lanes** onto a target regular
    /// geometry through the shared gridding kernels (the lossy downward
    /// conversion; same kernels as [`PointSet::to_surface`]).
    pub fn resample(&self, target: &GridGeometry, method: GridMethod) -> Result<Surface> {
        let nodes = self.shell().nodes();
        let lane_coords = |lane: &[f64]| -> Vec<[f64; 3]> {
            nodes
                .iter()
                .zip(lane)
                .filter(|(_, z)| z.is_finite())
                .map(|(n, z)| [n[0], n[1], *z])
                .collect()
        };
        let lanes: Vec<(&str, Vec<[f64; 3]>)> = self
            .attr_names()
            .into_iter()
            .map(|name| (name, lane_coords(self.attr(name).expect("listed"))))
            .collect();
        let mut out = grid_lanes(lane_coords(self.values()), lanes, target, method)?;
        out.set_history(self.operation_history().with_entry(format!(
            "tri_surface.resample(ncol={}, nrow={}, method={method:?})",
            target.ncol, target.nrow
        )));
        Ok(out)
    }
}

/// Grid the primary lane onto `target`, then each attribute lane, reusing the
/// existing gridding kernels through [`PointSet::to_surface`].
fn grid_lanes(
    primary: Vec<[f64; 3]>,
    lanes: Vec<(&str, Vec<[f64; 3]>)>,
    target: &GridGeometry,
    method: GridMethod,
) -> Result<Surface> {
    let mut out = PointSet::from_coords(primary).to_surface(target.clone(), method)?;
    for (name, coords) in lanes {
        let lane = PointSet::from_coords(coords)
            .to_surface(target.clone(), method)?
            .values()
            .clone();
        out.set_attr(name, lane)?;
    }
    Ok(out)
}

#[cfg(test)]
mod tests {
    use super::*;
    use approx::assert_relative_eq;
    use ndarray::Array2;

    fn geom() -> GridGeometry {
        GridGeometry {
            xori: 100.0,
            yori: 200.0,
            xinc: 10.0,
            yinc: 10.0,
            ncol: 6,
            nrow: 5,
            rotation_deg: 0.0,
            yflip: false,
        }
    }

    /// z = x + 2y; attribute "amp" = x - y (both affine → exact under bilinear
    /// and preserved exactly under node-identity lifts).
    fn surface() -> Surface {
        let g = geom();
        let mut v = Array2::zeros((g.ncol, g.nrow));
        let mut a = Array2::zeros((g.ncol, g.nrow));
        for j in 0..g.nrow {
            for i in 0..g.ncol {
                let (x, y) = g.node_xy(i, j);
                v[[i, j]] = x + 2.0 * y;
                a[[i, j]] = x - y;
            }
        }
        let mut s = Surface::new(g, v).unwrap();
        s.set_attr("amp", a).unwrap();
        s
    }

    #[test]
    fn upward_conversions_carry_all_attributes_node_for_node() {
        let s = surface();
        let g = geom();

        // Level 1 → 2: values and attrs are bit-identical per (i, j).
        let sm = s.to_structured_mesh().unwrap();
        assert_eq!(sm.values(), s.values());
        assert_eq!(sm.attr("amp").unwrap(), s.attr("amp").unwrap());
        assert_eq!(sm.nominal_geometry(), Some(&g));

        // Level 1 → 3 and 2 → 3 agree, and every node keeps its lane values.
        for tri in [s.to_tri_surface().unwrap(), sm.to_tri_surface().unwrap()] {
            assert_eq!(tri.points().len(), g.ncol * g.nrow);
            assert_eq!(tri.attr_names(), vec!["amp"]);
            for (k, p) in tri.points().iter().enumerate() {
                assert_relative_eq!(p[2], p[0] + 2.0 * p[1], epsilon = 1e-9);
                assert_relative_eq!(tri.attr("amp").unwrap()[k], p[0] - p[1], epsilon = 1e-9);
            }
        }
    }

    #[test]
    fn nan_values_survive_the_lift_as_properties_not_holes() {
        // The shell is value-independent: a NaN node stays a node.
        let mut v = surface().values().clone();
        v[[2, 2]] = f64::NAN;
        let mut s = Surface::new(geom(), v).unwrap();
        s.set_attr("amp", surface().attr("amp").unwrap().clone())
            .unwrap();
        let tri = s.to_tri_surface().unwrap();
        assert_eq!(tri.points().len(), geom().ncol * geom().nrow);
        assert_eq!(tri.values().iter().filter(|z| z.is_nan()).count(), 1);
        // The attribute at that node is still defined.
        assert!(tri.attr("amp").unwrap().iter().all(|a| a.is_finite()));
    }

    #[test]
    fn downward_resample_carries_primary_and_attributes() {
        let s = surface();
        // A sub-lattice of the source: every target node coincides with a data
        // node, so `Nearest` must reproduce both lanes exactly.
        let target = GridGeometry {
            xori: 110.0,
            yori: 210.0,
            xinc: 10.0,
            yinc: 10.0,
            ncol: 3,
            nrow: 3,
            rotation_deg: 0.0,
            yflip: false,
        };

        let sm = s.to_structured_mesh().unwrap();
        let tri = s.to_tri_surface().unwrap();
        for down in [
            sm.resample(&target, GridMethod::Nearest).unwrap(),
            tri.resample(&target, GridMethod::Nearest).unwrap(),
        ] {
            assert_eq!(down.geom, target);
            assert_eq!(down.attr_names(), vec!["amp"]);
            for j in 0..target.nrow {
                for i in 0..target.ncol {
                    let (x, y) = target.node_xy(i, j);
                    assert_relative_eq!(down.values()[[i, j]], x + 2.0 * y, epsilon = 1e-9);
                    assert_relative_eq!(down.attr("amp").unwrap()[[i, j]], x - y, epsilon = 1e-9);
                }
            }
        }
    }

    #[test]
    fn round_trip_grid_to_tri_and_back_via_infer_grid() {
        let s = surface();
        let tri = s.to_tri_surface().unwrap();
        let g = tri.infer_grid(1e-6).unwrap();
        assert_relative_eq!(g.xori, s.geom.xori, epsilon = 1e-6);
        assert_relative_eq!(g.xinc, s.geom.xinc, epsilon = 1e-9);
        assert_eq!((g.ncol, g.nrow), (s.geom.ncol, s.geom.nrow));

        let sm = s.to_structured_mesh().unwrap();
        let g2 = sm.infer_grid(1e-6).unwrap();
        assert_eq!((g2.ncol, g2.nrow), (s.geom.ncol, s.geom.nrow));
    }
}