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
70
71
72
73
74
75
76
77
78
79
80
81
82

/*
 * 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! {
    /// Tetrahedron with homogeneous magnetic surface charge.
    TetrahedronMagnet
    field_fn: tetrahedron_B
    args: {
        polarization: Vector3<T> = Vector3::z(),
        vertices: @val [Vector3<T>; 4] = [Vector3::zeros(), Vector3::x(), Vector3::y(), Vector3::z()],
    }
    arg_display: "pol={}, vertices={}";
    arg_fmt: [format_vector3, format_vertices_4]
    docs: {
        new: {
            /// Construct a [TetrahedronMagnet].
            ///
            /// # Examples
            ///
            /// ```
            /// # use magba::magnets::TetrahedronMagnet;
            /// # use nalgebra::{UnitQuaternion, vector};
            /// let magnet = TetrahedronMagnet::new(
            ///     [0.0, 0.0, 0.0],              // position (m)
            ///     UnitQuaternion::identity(),   // orientation
            ///     [0.0, 0.0, 1.0],              // polarization (T)
            ///     [                             // vertices (m)
            ///         vector![-0.1, -0.1, -0.1],
            ///         vector![0.1, -0.1, -0.1],
            ///         vector![0.0, 0.1, -0.1],
            ///         vector![0.0, 0.0, 0.1],
            ///     ],
            /// );
            /// ```
        }
    }
}

#[cfg(all(test, feature = "std"))]
crate::testing_util::generate_tests! {
    TetrahedronMagnet
    filename: tetrahedron
    params: {
        polarization: vector![1.0, 2.0, 3.0],
        vertices: [
            vector![-0.1, -0.1, -0.1],
            vector![0.1, -0.1, -0.1],
            vector![0.0, 0.1, -0.1],
            vector![0.0, 0.0, 0.1]
        ]
    }
    rtols: {
        static: 2e-9,
        static_small: 2e-9,
        translate: 2e-9,
        rotate: 2e-9,
    }
    p95_rtols: {
        static: 2e-9,
        static_small: 2e-9,
        translate: 2e-9,
        rotate: 2e-9,
    }
    f32_rtols: {
        static: 5e-2,
        static_small: 2e-1,
        translate: 5e-2,
        rotate: 5e-2,
    }
    f32_p95_rtols: {
        static: 1e-3,
        static_small: 1e-3,
        translate: 1e-3,
        rotate: 1e-3,
    }
}