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
66
67
68
69

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

use nalgebra::Vector3;

use crate::crate_utils::define_source;

define_source! {
    /// Magnetic dipole source.
    ///
    /// # References
    ///
    /// - Ortner, Michael, and Lucas Gabriel Coliado Bandeira. “Magpylib: A Free Python Package for Magnetic Field Computation.” SoftwareX 11 (January 1, 2020): 100466. <https://doi.org/10.1016/j.softx.2020.100466>.
    Dipole
    field_fn: dipole_B
    args: { moment:Vector3<T> = Vector3::z() }
    arg_display: "m={}";
    arg_fmt: [format_vector3]
    docs: {
        new: {
            /// Construct a magnetic [Dipole].
            ///
            /// # Examples
            ///
            /// ```
            /// # use magba::magnets::Dipole;
            /// # use nalgebra::UnitQuaternion;
            /// let dipole = Dipole::new(
            ///     [0.0, 0.0, 0.0],              // position (m)
            ///     UnitQuaternion::identity(),   // orientation as unit quaternion
            ///     [0.0, 0.0, 1.0],              // moment: Magnetic dipole moment vector (A·m²)
            /// );
            /// ```
        }
    }
}

#[cfg(all(test, feature = "std"))]
crate::testing_util::generate_tests! {
    Dipole
    filename: dipole
    params: { moment: vector![1.0, 2.0, 3.0] }
    rtols: {
        static: 2e-10,
        static_small: 2e-10,
        translate: 2e-10,
        rotate: 2e-10,
    }
    p95_rtols: {
        static: 2e-10,
        static_small: 2e-10,
        translate: 2e-10,
        rotate: 2e-10,
    }
    f32_rtols: {
        static: 1e-6,
        static_small: 1e-6,
        translate: 1e-6,
        rotate: 1e-6,
    }
    f32_p95_rtols: {
        static: 1e-6,
        static_small: 1e-6,
        translate: 1e-6,
        rotate: 1e-6,
    }
}