Struct MagneticField 

pub struct MagneticField { /* private fields */ }

Earth’s magnetic field at a point: north, east, down components in nT.

Derived quantities — declination, inclination, horizontal and total intensity — are computed from the components, not stored.

Implementations

impl MagneticField

pub fn from_ned_nanotesla(north: f64, east: f64, down: f64) -> Result<Self>

Field from north, east, down components in nT.

Errors

KernelError::NotFinite for a non-finite component; KernelError::OutOfRange beyond ±MAX_FIELD_NANOTESLA.

pub const fn north_nanotesla(&self) -> f64

North component, nT.

pub const fn east_nanotesla(&self) -> f64

East component, nT.

pub const fn down_nanotesla(&self) -> f64

Down component, nT; positive in the northern magnetic hemisphere.

pub fn horizontal_intensity_nanotesla(&self) -> f64

Horizontal intensity H, nT: the component that aligns a compass.

Small near the magnetic poles, where a compass becomes sluggish and then unusable.

pub fn total_intensity_nanotesla(&self) -> f64

Total intensity F, nT.

pub fn declination(&self) -> Variation

Declination D (magnetic variation), east positive.

Undefined where H is zero and reported as zero; check horizontal_intensity_nanotesla before relying on a compass there.

pub fn inclination(&self) -> Angle

Inclination I (dip): angle below the horizontal, positive down.

Trait Implementations

impl Clone for MagneticField

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for MagneticField

impl Debug for MagneticField

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

Formats the value using the given formatter.

impl Display for MagneticField

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

Formats the value using the given formatter.

impl PartialEq for MagneticField

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MagneticField