devela 0.27.0

A development layer of coherence.
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

// devela::geom::dir::boundary
//
//! Defines: [`Boundary1d`], [`Boundary2d`], [`Boundary3d`].
//!
//! Orientations relative to a bounded region along one or more axes.
//!
//! A boundary orientation identifies a side or face of a bounded region,
//! without implying motion, comparison, or violation.
//!
//! They are: discrete, region-relative, non-cyclic, without magnitude.
//!
//! In one dimension, boundary orientation corresponds to the two extrema
//! of a totally ordered extent.
//

#[cfg(doc)]
use crate::Extent;
use crate::{_impl_init, Sign};

_impl_init![ConstInit: Self::Left => Boundary1d, Boundary2d, Boundary3d];

#[doc = crate::_tags!(geom_dir)]
/// Orientation relative to a one-dimensional boundary.
#[doc = crate::_doc_location!("geom/dir")]
///
/// Identifies the lower or upper side of a bounded [`Extent<T, 1>`] or other one-dimensional
/// bounded domains, corresponding to the extrema of a totally ordered domain.
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum Boundary1d {
    /// The lower boundary side.
    Lower,
    /// The upper boundary side.
    Upper,
}
#[allow(missing_docs, non_upper_case_globals)]
impl Boundary1d {
    pub const Left: Self = Self::Lower;
    pub const Right: Self = Self::Upper;
    pub const Start: Self = Self::Lower;
    pub const End: Self = Self::Upper;
    pub const Before: Self = Self::Lower;
    pub const After: Self = Self::Upper;

    /// Returns the opposite boundary.
    pub const fn opposite(self) -> Self {
        match self {
            Self::Lower => Self::Upper,
            Self::Upper => Self::Lower,
        }
    }

    /// Converts the boundary into a numeric sign.
    ///
    /// This is meaningful only in ordered numeric contexts.
    pub const fn sign(self) -> Sign {
        match self {
            Self::Lower => Sign::Negative,
            Self::Upper => Sign::Positive,
        }
    }
}

#[doc = crate::_tags!(geom_dir)]
/// Orientation relative to a two-dimensional rectangular boundary.
#[doc = crate::_doc_location!("geom/dir")]
///
/// Identifies a side of a bounded [`Extent<T, 2>`], or other two-dimensional bounded domains.
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum Boundary2d {
    /// Left boundary face.
    Left,
    /// Right boundary face.
    Right,
    /// Bottom boundary face.
    Bottom,
    /// Top boundary face.
    Top,
}
#[allow(missing_docs, non_upper_case_globals)]
impl Boundary2d {
    pub const Above: Self = Self::Top;
    pub const Below: Self = Self::Bottom;

    /// Returns the opposite boundary.
    pub const fn opposite(self) -> Self {
        match self {
            Self::Left => Self::Right,
            Self::Right => Self::Left,
            Self::Bottom => Self::Top,
            Self::Top => Self::Bottom,
        }
    }
}

#[doc = crate::_tags!(geom_dir)]
/// Orientation relative to a three-dimensional bounding volume.
#[doc = crate::_doc_location!("geom/dir")]
///
/// Identifies a face of a bounded [`Extent<T, 3>`], or other three-dimensional bounded domains.
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum Boundary3d {
    /// Left boundary face.
    Left,
    /// Right boundary face.
    Right,
    /// Bottom boundary face.
    Bottom,
    /// Top boundary face.
    Top,
    /// Front boundary face.
    Front,
    /// Back boundary face.
    Back,
}
#[allow(missing_docs, non_upper_case_globals)]
impl Boundary3d {
    pub const Above: Self = Self::Top;
    pub const Below: Self = Self::Bottom;
    pub const Near: Self = Self::Front;
    pub const Far: Self = Self::Back;

    /// Returns the opposite boundary.
    pub const fn opposite(self) -> Self {
        match self {
            Self::Left => Self::Right,
            Self::Right => Self::Left,
            Self::Bottom => Self::Top,
            Self::Top => Self::Bottom,
            Self::Front => Self::Back,
            Self::Back => Self::Front,
        }
    }
}