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

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

use crate::crate_utils::define_source;

define_source! {
    /// Circular current 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>.
    CircularCurrent
    field_fn: circular_B
    args: {
        diameter: T = T::one();
            validate diameter > T::zero();
            error "Diameter must be positive.",
        current: T = T::one(),
    }
    arg_display: "d={}, I={}";
    arg_fmt: [format_float, format_float]

    docs: {
        new: {
            /// Create a new circular current source.
            ///
            /// # Parameters
            ///
            /// - `position`: Position in units (m)
            /// - `orientation`: Orientation as unit quaternion
            /// - `diameter`: Loop diameter (m)
            /// - `current`: Electrical current (A)
        }
    }
}

#[cfg(all(test, feature = "std"))]
crate::testing_util::generate_tests! {
    CircularCurrent
    filename: circularcurrent
    params: { diameter: 1.0, current: 1.0 }
    rtols: {
        static: 2e-10,
        static_small: 2e-10,
        translate: 2e-10,
        rotate: 2e-10,
    }
}

#[cfg(test)]
mod tests {
    use crate::currents::CircularCurrent;
    use nalgebra::UnitQuaternion;

    #[test]
    #[should_panic]
    fn test_input_validation() {
        let _ = CircularCurrent::new([0.0; 3], UnitQuaternion::identity(), -1.0, 1.0);
    }
}