rustycoils/lib.rs
1//! # RustyCoils
2//!
3//! Off-axis magnetic fields for systems with cyclindrical symmetry.
4//!
5//! This crate impliments a fast approximate method for finding off axis magnetic fields
6//! of systems with cylindrical symmetry. Using a power series decomposition of the on-axis
7//! magentic field the full magentic field for "basic" primitive shapes can be determined.
8//! These can then be combined within an object with a given orientation and location in order
9//! to build up a larger system.
10//!
11//! The method used in this crate comes directly from "Off-Axis Expansion Solution of Laplace's
12//! Equation: Application to Accurate and Rapid Calculation of Coil Magentic Fields" by Robert H.
13//! Jackson. The author sums up the utility of this method with the sentance "The simplicity,
14//! compactness and speed of this method make it a good adjunct to other techniques and ideal as
15//! a module for incorporation into more general programs". Near the axis of symmetry the method
16//! can give very accurate fields at a much faster speed than other methods (Author of paper
17//! determines that out to about 70% the error is less than 0.1% of the exact elliptical integral
18//! solution for an ideal current loop.
19
20#[warn(missing_docs)]
21mod axialobject;
22mod fieldcalc;
23
24#[cfg(feature = "parallel")]
25mod parallel;
26
27pub use axialobject::{AxialError, AxialSystem};
28
29#[cfg(feature = "parallel")]
30pub use parallel::get_b_ndarray;
31#[cfg(feature = "parallel")]
32pub use parallel::get_b_vec;