magba 0.5.0

Magnetic computation library for Rust
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

/*
 * Magba is licensed under The 3-Clause BSD, see LICENSE.
 * Copyright 2025 Sira Pornsiriprasert <code@psira.me>
 */

#[cfg(feature = "std")]
use derive_more::Display;

use enum_dispatch::enum_dispatch;

use crate::{
    base::{Float, Pose, Source, Transform},
    magnets::{
        CuboidMagnet, CylinderMagnet, Dipole, SphereMagnet, TetrahedronMagnet, TriangleMagnet,
    },
};

#[cfg(feature = "mesh")]
use crate::magnets::MeshMagnet;

use nalgebra::{Point3, Vector3};

/// Magnetic source variants.
///
/// The Magnet enum is useful for wrapping different magnet structs before using them
/// in stack-allocated composites. See [SourceArray](crate::collections::SourceArray#examples).
///
/// # Examples
///
/// ```
/// # use magba::prelude::*;
/// # use nalgebra::{point, vector};
/// # use approx::assert_relative_eq;
/// let magnet: Magnet = CylinderMagnet::default().into();
/// let b_field = magnet.compute_B(point![0.1, 0.2, 0.3]);
/// assert_relative_eq!(b_field, vector![0.03358623061457353, 0.06717246122914705, 0.6376649834015807]);
/// ```
#[derive(Clone, Debug, PartialEq, Eq)]
#[cfg_attr(feature = "std", derive(Display))]
#[enum_dispatch(Source<T>, Transform<T>,)]
pub enum Magnet<T: Float = f64> {
    Cylinder(CylinderMagnet<T>),
    Cuboid(CuboidMagnet<T>),
    Dipole(Dipole<T>),
    Sphere(SphereMagnet<T>),
    Tetrahedron(TetrahedronMagnet<T>),
    Triangle(TriangleMagnet<T>),

    #[cfg(feature = "mesh")]
    Mesh(MeshMagnet<T>),
}

#[cfg(all(test, feature = "std"))]
mod tests {
    use super::*;

    #[test]
    fn test_display() {
        let magnet: Magnet = CylinderMagnet::default().into();
        assert_eq!(
            format!("{}", magnet),
            "CylinderMagnet (pol=[0.0, 0.0, 1.0], d=1.0, h=1.0) at pos=[0.0, 0.0, 0.0], rot=[0.0, 0.0, 0.0]"
        );
    }
}