Struct SourceCollection

pub struct SourceCollection<S: Source<T>, T: Float> { /* private fields */ }

Stack-allocated collection of a single source type.

Fields

• position: Center of the collection (m), where the children reference.
• orientation: Orientation of the collection, where the children reference.
• children: An ordered-vec of homogeneous magnetic sources.

Example

use magba::sources::*;
use nalgebra::*;

let magnet = CylinderMagnet::<f64>::default();
let mut collection = SourceCollection::default();
collection.add(magnet);

Implementations

impl<S: Source<T>, T: Float> SourceCollection<S, T>

pub fn new( position: Point3<T>, orientation: UnitQuaternion<T>, sources: Vec<S>, ) -> Self

Initialize SourceCollection.

pub fn from_sources(sources: Vec<S>) -> Self

Initialize SourceCollection from a vec of homogeneous Source.

pub fn add(&mut self, source: S)

Add Source to the collection.

pub fn add_sources(&mut self, source: &mut Vec<S>)

Add multiple Source to the collection.

Trait Implementations

impl<S: Debug + Source<T>, T: Debug + Float> Debug for SourceCollection<S, T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<S: Source<T>, T: Float> Default for SourceCollection<S, T>

fn default() -> Self

Returns the “default value” for a type.

impl<S: Source<T>, T: Float> Display for SourceCollection<S, T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<S: Source<T>, T: Float> Field<T> for SourceCollection<S, T>

fn get_B(&self, points: &[Point3<T>]) -> Vec<Vector3<T>>

Compute the magnetic field (B) at the given points.

impl<S: Source<T> + PartialEq, T: Float> PartialEq for SourceCollection<S, T>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<S: Source<T>, T: Float> Transform<T> for SourceCollection<S, T>

fn position(&self) -> Point3<T>

Get the object position.

fn orientation(&self) -> UnitQuaternion<T>

Get the object orientation.

fn set_position(&mut self, position: Point3<T>)

Set the object position.

fn set_orientation(&mut self, orientation: UnitQuaternion<T>)

Set the object orientation.

fn translate(&mut self, translation: &Translation3<T>)

Translate the object.

fn rotate(&mut self, rotation: &UnitQuaternion<T>)

Rotate the object.

fn rotate_anchor(&mut self, rotation: &UnitQuaternion<T>, anchor: &Point3<T>)

Rotate the object using the anchor point as the center of rotation.

impl<S: Source<T>, T: Float> Source<T> for SourceCollection<S, T>