petekstatic 0.1.2

petekStatic — the GEOMODEL layer: structural framework, grid construction, property modelling, volumetrics and static uncertainty, consolidated into one crate.
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

//! A single cell: its 8 corners and the geometric quantities volumetrics needs
//! (volume, centroid, top/bottom depth). Built on demand from the grid geometry.
//! All lengths in metres; depth is positive-down.

use crate::grid::index::Ijk;
use crate::grid::point::Point3;
use crate::grid::volume::hexahedron_volume;

/// A cell view: its index and 8 corners (order `di + 2*dj + 4*dk`).
#[derive(Debug, Clone, Copy)]
pub struct Cell {
    pub ijk: Ijk,
    pub corners: [Point3; 8],
}

impl Cell {
    /// Bulk (gross) volume in m³.
    #[must_use]
    #[inline]
    pub fn volume(&self) -> f64 {
        hexahedron_volume(&self.corners)
    }

    /// Geometric centroid (mean of the 8 corners).
    #[must_use]
    #[inline]
    pub fn centroid(&self) -> Point3 {
        let s = self
            .corners
            .iter()
            .fold(Point3::new(0.0, 0.0, 0.0), |a, &c| a + c);
        Point3::new(s.x / 8.0, s.y / 8.0, s.z / 8.0)
    }

    /// Mean depth of the four top corners (k face, smaller z).
    #[must_use]
    #[inline]
    pub fn top_depth(&self) -> f64 {
        (self.corners[0].z + self.corners[1].z + self.corners[2].z + self.corners[3].z) / 4.0
    }

    /// Mean depth of the four bottom corners (k+1 face, larger z).
    #[must_use]
    #[inline]
    pub fn bottom_depth(&self) -> f64 {
        (self.corners[4].z + self.corners[5].z + self.corners[6].z + self.corners[7].z) / 4.0
    }

    /// Mean vertical thickness (bottom - top depth).
    #[must_use]
    #[inline]
    pub fn dz(&self) -> f64 {
        self.bottom_depth() - self.top_depth()
    }
}