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

/* 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 */
//! # Magnet3D - Field calculations in 3D
/// This consists of modules for calculating magnetic fields due to
///
use serde_derive::{Deserialize, Serialize};

use super::MagnetTrait;

pub mod bulirsch;
mod prism;
mod solenoid;

pub use prism::*;
pub use solenoid::*;

/// Enum to store the different 3D 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 Magnet3D {
    Prism(Prism),
    Cylinder,
    Sphere,
    Custom,
}

/// Magnet2D Traits
pub trait MagnetTrait3D<POINT, CENTER, SIZE, MAG>: MagnetTrait<POINT, CENTER, SIZE, MAG> {}