lodestone_core 0.2.3

User friendly magnetic field calculations in 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

/* This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at https://mozilla.org/MPL/2.0/.
Copyright 2021 Peter Dunne */
//! # Magnet2D - Field calculations in 2D
//! This consists of modules for calculating magnetic fields due to magnetic
//! objects in 2D, including:
//!

mod circle;
mod field_loop_2d;
mod line;
mod line_field;
mod polygon;
mod rectangle;

mod circle_field;
mod rectangle_field;

pub use circle::*;
pub use field_loop_2d::*;
pub use line::*;
pub use line_field::*;
pub use polygon::*;
pub use rectangle::*;

use crate::magnets::MagnetTrait;
use crate::parse::{magnet2d_to_toml, MagnetKind};
use crate::MagnetError;

use serde_derive::{Deserialize, Serialize};

/// Magnet2D Traits
pub trait MagnetTrait2D<POINT, CENTER, SIZE, MAG>: MagnetTrait<POINT, CENTER, SIZE, MAG> {}
/// Enum to store the different 2D magnet types.
///
/// This allows us to create a Vec<MagnetType2D>, and access the fields of the magnet
/// struct with a match routine.
///
#[derive(Debug, Deserialize, Serialize, PartialEq)]
pub enum Magnet2D {
    /// 2D rectangular magnet
    Rectangle(Rectangle),
    /// 2D circular magnet
    Circle(Circle),
    /// 2D Arbitrary Polygon
    Polygon(Polygon),
}

impl Magnet2D {
    /// Returns serialisable struct for saving to a TOML file
    pub fn to_toml_struct(&self) -> Result<MagnetKind, MagnetError> {
        magnet2d_to_toml(self)
    }
}