honeycomb-kernels 0.11.0

//! geometrical anchoring code

use honeycomb_core::{
    attributes::{AttrSparseVec, AttributeBind, AttributeError, AttributeUpdate},
    cmap::{EdgeIdType, FaceIdType, OrbitPolicy, VertexIdType},
};

/// Geometrical 0-cell identifier type.
pub type NodeIdType = u32;
/// Geometrical 1-cell identifier type.
pub type CurveIdType = u32;
/// Geometrical 2-cell identifier type.
pub type SurfaceIdType = u32;
/// Geometrical 3-cell identifier type.
pub type BodyIdType = u32;

// --- Vertex anchors

/// Geometrical mesh anchor.
///
/// This enum is used as an attribute to link mesh vertices to entities of the represented geometry.
///
/// The `AttributeUpdate` implementation is used to enforce the dimensional conditions required to
/// merge two anchors. The merge-ability of two anchors also depends on their intersection; we
/// expect this to be handled outside of the merge functor, as doing it inside would require leaking
/// map data into the trait's methods.
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub enum VertexAnchor {
    /// Vertex is linked to a node.
    Node(NodeIdType),
    /// Vertex is linked to a curve.
    Curve(CurveIdType),
    /// Vertex is linked to a surface.
    Surface(SurfaceIdType),
    /// Vertex is linked to a 3D body.
    Body(BodyIdType),
}

impl VertexAnchor {
    /// Return the dimension of the associated anchor.
    #[must_use = "unused return value"]
    pub const fn anchor_dim(&self) -> u8 {
        match self {
            Self::Node(_) => 0,
            Self::Curve(_) => 1,
            Self::Surface(_) => 2,
            Self::Body(_) => 3,
        }
    }
}

impl AttributeBind for VertexAnchor {
    type StorageType = AttrSparseVec<Self>;
    type IdentifierType = VertexIdType;
    const BIND_POLICY: OrbitPolicy = OrbitPolicy::Vertex;
}

impl AttributeUpdate for VertexAnchor {
    fn merge(attr1: Self, attr2: Self) -> Result<Self, AttributeError> {
        match (attr1, attr2) {
            (Self::Node(id1), Self::Node(id2)) => {
                if id1 == id2 {
                    Ok(Self::Node(id1))
                } else {
                    Err(AttributeError::FailedMerge(
                        std::any::type_name::<Self>(),
                        "anchors have the same dimension but different IDs",
                    ))
                }
            }
            (Self::Node(id), _) | (_, Self::Node(id)) => Ok(Self::Node(id)),
            (Self::Curve(id1), Self::Curve(id2)) => {
                if id1 == id2 {
                    Ok(Self::Curve(id1))
                } else {
                    Err(AttributeError::FailedMerge(
                        std::any::type_name::<Self>(),
                        "anchors have the same dimension but different IDs",
                    ))
                }
            }
            (Self::Curve(id), _) | (_, Self::Curve(id)) => Ok(Self::Curve(id)),
            (Self::Surface(id1), Self::Surface(id2)) => {
                if id1 == id2 {
                    Ok(Self::Surface(id1))
                } else {
                    Err(AttributeError::FailedMerge(
                        std::any::type_name::<Self>(),
                        "anchors have the same dimension but different IDs",
                    ))
                }
            }
            (Self::Surface(id), _) | (_, Self::Surface(id)) => Ok(Self::Surface(id)),
            (Self::Body(id1), Self::Body(id2)) => {
                if id1 == id2 {
                    Ok(Self::Body(id1))
                } else {
                    Err(AttributeError::FailedMerge(
                        std::any::type_name::<Self>(),
                        "anchors have the same dimension but different IDs",
                    ))
                }
            }
        }
    }

    fn split(attr: Self) -> Result<(Self, Self), AttributeError> {
        Ok((attr, attr))
    }

    fn merge_incomplete(val: Self) -> Result<Self, AttributeError> {
        Ok(val)
    }
}

impl From<EdgeAnchor> for VertexAnchor {
    fn from(value: EdgeAnchor) -> Self {
        match value {
            EdgeAnchor::Curve(i) => VertexAnchor::Curve(i),
            EdgeAnchor::Surface(i) => VertexAnchor::Surface(i),
            EdgeAnchor::Body(i) => VertexAnchor::Body(i),
        }
    }
}

impl From<FaceAnchor> for VertexAnchor {
    fn from(value: FaceAnchor) -> Self {
        match value {
            FaceAnchor::Surface(i) => VertexAnchor::Surface(i),
            FaceAnchor::Body(i) => VertexAnchor::Body(i),
        }
    }
}

// --- Edge anchors

/// Geometrical mesh anchor.
///
/// This enum is used as an attribute to link mesh edges to entities of the represented geometry..
///
/// The `AttributeUpdate` implementation is used to enforce the dimensional conditions required to
/// merge two anchors. The merge-ability of two anchors also depends on their intersection; we
/// expect this to be handled outside of the merge functor, as doing it inside would require leaking
/// map data into the trait's methods.
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub enum EdgeAnchor {
    /// Vertex is linked to a curve.
    Curve(CurveIdType),
    /// Vertex is linked to a surface.
    Surface(SurfaceIdType),
    /// Vertex is linked to a 3D body.
    Body(BodyIdType),
}

impl EdgeAnchor {
    /// Return the dimension of the associated anchor.
    #[must_use = "unused return value"]
    pub const fn anchor_dim(&self) -> u8 {
        match self {
            Self::Curve(_) => 1,
            Self::Surface(_) => 2,
            Self::Body(_) => 3,
        }
    }
}

impl AttributeBind for EdgeAnchor {
    type StorageType = AttrSparseVec<Self>;
    type IdentifierType = EdgeIdType;
    const BIND_POLICY: OrbitPolicy = OrbitPolicy::Edge;
}

impl AttributeUpdate for EdgeAnchor {
    fn merge(attr1: Self, attr2: Self) -> Result<Self, AttributeError> {
        match (attr1, attr2) {
            (Self::Curve(id1), Self::Curve(id2)) => {
                if id1 == id2 {
                    Ok(Self::Curve(id1))
                } else {
                    Err(AttributeError::FailedMerge(
                        std::any::type_name::<Self>(),
                        "anchors have the same dimension but different IDs",
                    ))
                }
            }
            (Self::Curve(id), _) | (_, Self::Curve(id)) => Ok(Self::Curve(id)),
            (Self::Surface(id1), Self::Surface(id2)) => {
                if id1 == id2 {
                    Ok(Self::Surface(id1))
                } else {
                    Err(AttributeError::FailedMerge(
                        std::any::type_name::<Self>(),
                        "anchors have the same dimension but different IDs",
                    ))
                }
            }
            (Self::Surface(id), _) | (_, Self::Surface(id)) => Ok(Self::Surface(id)),
            (Self::Body(id1), Self::Body(id2)) => {
                if id1 == id2 {
                    Ok(Self::Body(id1))
                } else {
                    Err(AttributeError::FailedMerge(
                        std::any::type_name::<Self>(),
                        "anchors have the same dimension but different IDs",
                    ))
                }
            }
        }
    }

    fn split(attr: Self) -> Result<(Self, Self), AttributeError> {
        Ok((attr, attr))
    }

    fn merge_incomplete(val: Self) -> Result<Self, AttributeError> {
        Ok(val)
    }
}

impl From<FaceAnchor> for EdgeAnchor {
    fn from(value: FaceAnchor) -> Self {
        match value {
            FaceAnchor::Surface(i) => EdgeAnchor::Surface(i),
            FaceAnchor::Body(i) => EdgeAnchor::Body(i),
        }
    }
}

// --- Face anchors

/// Geometrical mesh anchor.
///
/// This enum is used as an attribute to link mesh faces to entities of the represented geometry..
///
/// The `AttributeUpdate` implementation is used to enforce the dimensional conditions required to
/// merge two anchors. The merge-ability of two anchors also depends on their intersection; we
/// expect this to be handled outside of the merge functor, as doing it inside would require leaking
/// map data into the trait's methods.
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub enum FaceAnchor {
    /// Vertex is linked to a surface.
    Surface(SurfaceIdType),
    /// Vertex is linked to a 3D body.
    Body(BodyIdType),
}

impl FaceAnchor {
    /// Return the dimension of the associated anchor.
    #[must_use = "unused return value"]
    pub const fn anchor_dim(&self) -> u8 {
        match self {
            Self::Surface(_) => 2,
            Self::Body(_) => 3,
        }
    }
}

impl AttributeBind for FaceAnchor {
    type StorageType = AttrSparseVec<Self>;
    type IdentifierType = FaceIdType;
    const BIND_POLICY: OrbitPolicy = OrbitPolicy::Face;
}

impl AttributeUpdate for FaceAnchor {
    fn merge(attr1: Self, attr2: Self) -> Result<Self, AttributeError> {
        match (attr1, attr2) {
            (Self::Surface(id1), Self::Surface(id2)) => {
                if id1 == id2 {
                    Ok(Self::Surface(id1))
                } else {
                    Err(AttributeError::FailedMerge(
                        std::any::type_name::<Self>(),
                        "anchors have the same dimension but different IDs",
                    ))
                }
            }
            (Self::Surface(id), _) | (_, Self::Surface(id)) => Ok(Self::Surface(id)),
            (Self::Body(id1), Self::Body(id2)) => {
                if id1 == id2 {
                    Ok(Self::Body(id1))
                } else {
                    Err(AttributeError::FailedMerge(
                        std::any::type_name::<Self>(),
                        "anchors have the same dimension but different IDs",
                    ))
                }
            }
        }
    }

    fn split(attr: Self) -> Result<(Self, Self), AttributeError> {
        Ok((attr, attr))
    }

    fn merge_incomplete(val: Self) -> Result<Self, AttributeError> {
        Ok(val)
    }
}