Crate spintronics

Expand description

§spintronics

Version 0.3.2 - DemagField optimizations, doc/link cleanup, Garello 2013 + Boona 2014 validations, GPU device abstraction (CPU + CUDA stub), 7 landmark-paper validation suite

A pure Rust library for simulating spin dynamics, spin current generation, and conversion phenomena in magnetic materials and topological materials.

Licensed under Apache-2.0

§Overview

This library implements physical models established by Prof. Eiji Saitoh’s research group (Univ. Tokyo/RIKEN) and the broader spintronics community:

§Core Physics Effects

Spin Pumping: Generation of spin current from magnetization precession
Inverse Spin Hall Effect (ISHE): Conversion of spin current to charge current
Spin Seebeck Effect (SSE): Thermal generation of spin current
Spin-Orbit Torque (SOT): Current-driven magnetization switching
Dzyaloshinskii-Moriya Interaction (DMI): Skyrmion stabilization
Topological Hall Effect: Berry phase from skyrmion textures
Rashba Effect: 2DEG spin splitting and spin-momentum locking
Edelstein Effect: Spin-to-charge conversion in non-centrosymmetric systems
Spin Nernst Effect: Thermal gradient → transverse spin current

§Key Features

✅ 1829 lib + 111 doctests passing (v0.3.2)
✅ ML Phase 4 - Graph NN message-passing potentials (equivariant aggregation over arbitrary lattice topology), Bayesian optimization with Gaussian Process surrogate + Expected Improvement (v0.3.1)
✅ GPU device abstraction - Device trait with CPU baseline (CpuDevice) + CUDA skeleton (CudaDevice, feature-gated, ~92 ns/spin/step on CPU) (v0.3.1)
✅ 7 landmark-paper validations - Demidov 2006, Saitoh 2006, Uchida 2008, Mosendz 2010, Liu 2012, Garello 2013, Boona 2014 with quantitative pass/fail metrics (v0.3.1)
✅ Stochastic methods - Heun adaptive (Euler-Heun embedded pair, PI controller), Implicit-Milstein (Newton + multiplicative noise), Path-Integral MC for finite-T Heisenberg chains (v0.3.1)
✅ Advanced ML Phase 3 - O(3)-equivariant NN (Cartesian-tensor formulation, rotation-invariant energy by construction), active learning with uncertainty sampling / query-by-committee (v0.3.1)
✅ Property-based testing - proptest integration suite (27 properties × 32 cases) for conservation laws, SO(3) symmetries, time-reversal (v0.3.1)
✅ 5 landmark-paper validations - Demidov 2006, Saitoh 2006, Uchida 2008, Mosendz 2010, Liu 2012 with quantitative pass/fail metrics (v0.3.1)
✅ ML Phase 2 - Neural network exchange/anisotropy potentials, physics-informed NN for LLG, gradient-based magnetic structure optimization (v0.3.1)
✅ Advanced spin waves - Nanodisk Bessel + Kalinikos-Slavin modes, 1D/2D magnonic crystals (plane-wave band structure), semi-infinite Damon-Eshbach (v0.3.1)
✅ Stiff/diffusion integrators - Implicit midpoint with Newton + finite-diff Jacobian (A-stable LLG), Crank-Nicolson with Thomas algorithm for spin diffusion (v0.3.1)
✅ Experimental validation - Demidov 2006 (DE BLS), Saitoh 2006 (ISHE in Pt/Py), Uchida 2008 (LSSE) with embedded reference data and quantitative relative-error metrics (v0.3.1)
✅ 56 examples organized by difficulty (v0.3.1)
✅ Spin wave extensions - Damon-Eshbach non-reciprocity, BVMSW negative v_g, surface spin waves, spectral magnon solver (v0.3.1)
✅ Higher-order topological insulators - BBH model, breathing kagome, corner states, nested Wilson loops (v0.3.1)
✅ Axion electrodynamics - 3D Berry-curvature θ-term, axion magnon-photon coupling, topological ME polarizability (v0.3.1)
✅ Data export - VTI, XDMF, pure-Rust NetCDF3 Classic, Zarr v2 writers (v0.3.1)
✅ ML autodiff - Reverse-mode AD tape, SGD/Adam/L-BFGS optimizers, differentiable physics functions (v0.3.1)
✅ Non-collinear magnetism - Spin spirals (cycloidal/helical/conical), Luttinger-Tisza ground state (v0.3.1)
✅ Multiferroics - Magnetoelectric tensor, KNB mechanism, DM polarization, toroidal moments (v0.3.1)
✅ Kane-Mele QSH - Z2 topological invariant, Rashba/staggered potential, helical edge states (v0.3.1)
✅ Nonlinear magnon physics - Four-magnon scattering, Suhl instability, parametric amplification (v0.3.1)
✅ Quantum magnonics - Holstein-Primakoff, Bogoliubov transform, zero-point fluctuations (v0.3.1)
✅ NEGF transport - Keldysh formalism, Landauer-Büttiker, shot noise, spin accumulation (v0.3.1)
✅ Topological magnon bands - Haldane model, Chern numbers, Berry curvature, edge modes (v0.3.1)
✅ Cavity extensions - Tavis-Cummings, polaritons, optomagnonics, frequency combs (v0.3.1)
✅ Random anisotropy - Imry-Ma disorder, Harris criterion, LLG coupling (v0.3.1)
✅ Math primitives - Complex, CMatrix with Gauss-Jordan inverse + TQLI eigendecomposition (v0.3.1)
✅ Advanced integrators - Dormand-Prince RK5(4)/RK8(7), symplectic methods (v0.3.0)
✅ New physics modules - Altermagnets, Orbitronics, Frustrated magnets, Hopfions, Magnon BEC, Magnetoelastics (v0.3.0)
✅ Interactive web demo - Axum + HTMX subcrate with 4 physics simulations (v0.2.0)
✅ 5 experimental validations against landmark papers
✅ WebAssembly support for browser-based simulations
✅ FEM solver with advanced iterative methods
✅ Performance optimized - 21 inline attributes on hot-path functions (v0.2.0)
✅ Memory optimized - Pool allocator reduces allocations by 99% (v0.2.0)
✅ Python bindings via PyO3 (v0.2.0)
✅ Serde serialization for data interchange (v0.2.0)
✅ HDF5 export for large datasets (v0.2.0)
✅ Unit validation - 14 validators for physical quantities (v0.2.0)
✅ Zero warnings - production-quality code

§Key References

E. Saitoh et al., “Conversion of spin current into charge current at room temperature: Inverse spin-Hall effect”, Appl. Phys. Lett. 88, 182509 (2006)
K. Uchida et al., “Observation of the spin Seebeck effect”, Nature 455, 778-781 (2008)
I. M. Miron et al., “Perpendicular switching of a single ferromagnetic layer induced by in-plane current injection”, Nature 476, 189 (2011)
S. Woo et al., “Observation of room-temperature magnetic skyrmions”, Nat. Mater. 15, 501 (2016)

§Architecture

The library is organized into ~28 physics-focused modules:

§Core Infrastructure

constants: Physical constants (ℏ, γ, e, μ_B, k_B, 20+ NIST-validated values)
math: Math primitives — Complex, CMatrix (Gauss-Jordan + TQLI eigendecomposition, v0.3.1)
vector3: Optimized 3D vector operations for spin/magnetization
units: Unit validation - 14 validators for physical quantities (v0.2.0)
error: Error handling and result types

§Materials & Properties

material: Material properties (ferromagnets, interfaces, 2D magnets, topological insulators, Weyl semimetals)

§Dynamics & Transport

dynamics: Time evolution solvers (LLG, RK4, Heun, adaptive, Dormand-Prince, symplectic, implicit-midpoint Newton, Crank-Nicolson diffusion) (v0.1.0–v0.3.1)
transport: Spin transport phenomena (spin pumping, diffusion)

§Physical Effects

effect: Spin-charge conversion (ISHE, SSE, SOT, Rashba, Edelstein, Spin Nernst, Topological Hall)
magnon: Magnon propagation and spin wave dynamics
thermo: Thermoelectric effects (ANE, thermal magnon transport, multilayers)
texture: Magnetic textures (skyrmions, domain walls, DMI, topological charge)
spinwave: Spin wave theory — dispersion, modes, Damon-Eshbach, BVMSW, surface waves, nanodisk/magnonic-crystal/semi-infinite-DE (v0.3.1)

§Specialized Physics

afm: Antiferromagnetic dynamics for THz spintronics
stochastic: Thermal fluctuations and finite-T effects — FDT noise, Euler-Maruyama, Heun adaptive, Implicit-Milstein, path-integral MC (v0.1.0–v0.3.1)
cavity: Cavity magnonics - Tavis-Cummings, polaritons, optomagnonics (v0.3.0/v0.3.1)
altermagnet: Altermagnetic materials (RuO2, CrSb, MnTe; spin-splitter effect, v0.3.0)
orbitronics: Orbital Hall effect, orbital torques (v0.3.0)
frustrated: Frustrated magnets, spin ice, kagome (v0.3.0)
quantum: Quantum magnonics — Holstein-Primakoff, Bogoliubov, zero-point fluctuations (v0.3.1)
negf: Non-equilibrium transport — Keldysh, Landauer-Büttiker, shot noise (v0.3.1)
topomagnon: Topological magnon bands, HOTI corner states, nested Wilson loops, axion electrodynamics (v0.3.1)
noncollinear: Non-collinear magnetism — spin spirals, Luttinger-Tisza method (v0.3.1)
multiferroic: Magnetoelectric coupling — ME tensor, KNB mechanism, DM polarization (v0.3.1)
[autodiff]: Reverse-mode autodiff — tape, SGD/Adam/L-BFGS optimizers, differentiable physics, neural-net potentials, PINN, structure optimization, O(3)-equivariant NN, active learning, graph NN message passing, Bayesian optimization with Gaussian Processes (v0.3.1, feature-gated)

§Coupled Systems

circuit: Spin circuit elements (resistors, networks, spin accumulation)
fluid: Spin-vorticity coupling in liquid metals (Barnett effect)
mech: Nanomechanical spintronics (Barnett, Einstein-de Haas, cantilever coupling)
ai: Physical reservoir computing with magnon dynamics

§Computational Tools

fem: Finite element method (Delaunay mesh, iterative solvers, micromagnetics)
memory: Memory pool allocator for high-performance simulations (v0.2.0)
simd: SIMD-friendly batch processing for vector operations (v0.3.0)
[parallel]: Domain decomposition and parallel sweeps (v0.3.0, feature-gated)
builder: Type-state SimulationBuilder for validated construction (v0.3.0)

§Data & Validation

visualization: Data export (VTK, CSV, JSON, HDF5, VTI, XDMF, NetCDF3, Zarr v2, v0.3.1)
validation: Parameter checks + experimental validation against landmark papers — Demidov 2006, Saitoh 2006, Uchida 2008, Mosendz 2010, Liu 2012, Garello 2013, Boona 2014 (v0.3.1)
gpu: Device trait abstraction for portable LLG; CpuDevice baseline + CudaDevice skeleton, feature-gated (v0.3.1)
python: Python bindings via PyO3 (v0.2.0, optional feature)

§Quick Start

use spintronics::prelude::*;

// Setup materials (YIG/Pt system)
let yig = Ferromagnet::yig();
let interface = SpinInterface::yig_pt();
let pt_strip = InverseSpinHall::platinum();

// Initialize magnetization state
let m = Vector3::new(1.0, 0.0, 0.0);
let h_ext = Vector3::new(0.0, 0.0, 1.0);

// Solve LLG equation
let dm_dt = calc_dm_dt(m, h_ext, GAMMA, yig.alpha);

// Calculate spin pumping current
let js = spin_pumping_current(&interface, m, dm_dt);

// Validate physical quantities (v0.2.0)
assert!(is_valid_magnetization(yig.ms));
assert!(is_valid_damping(yig.alpha));

// Convert to electric field via ISHE
let e_field = pt_strip.convert(interface.normal, js);

Re-exports§

pub use vector3::Vector3;

Modules§

afm: Antiferromagnetic Spintronics - THz Dynamics
ai: Physical Reservoir Computing with Spintronics
altermagnet: Altermagnetic spintronics
benchmark: Experimental Benchmarks and Validation
builder: Type-state simulation builder for spintronics simulations
caloritronics: Spin Caloritronics: Unified module for thermoelectric and spin-caloritronic effects.
cavity: Cavity Magnonics - Hybrid Quantum Systems
circuit: Spin circuit elements and networks
constants: Physical constants for spintronics simulations
dynamics: Magnetization dynamics solvers
effect: Spin-charge conversion effects
error: Error Types for Spintronics Library
fem: Finite Element Method (FEM) for Micromagnetic Simulations
fluid: Fluid spintronics and spin-vorticity coupling
frustrated: Frustrated magnets module
gpu: GPU acceleration foundation for spintronics (v0.9.0).
io: Input/Output Module
llg: Landau-Lifshitz-Gilbert (LLG) equation solver
magnon: Magnon propagation and spin wave dynamics
material: Material properties for spintronics simulations
math: Mathematical primitives for spintronics quantum calculations.
mech: Nanomechanical spintronics
memory: Memory Pool Allocator for High-Performance Simulations
micromagnetics: Finite-difference micromagnetics solver
multiferroic: Multiferroic Materials and Magnetoelectric Coupling
negf: Non-equilibrium Green’s functions (NEGF) for mesoscopic spintronics.
noncollinear: Noncollinear magnetic order — spiral structures and the Luttinger-Tisza method
orbitronics: Orbitronics Module
prelude: Commonly used types and functions
quantum: Quantum magnonics — Holstein-Primakoff, Bogoliubov, and zero-point fluctuations.
simd: SIMD-friendly batch processing for Vector3 arrays
spinwave: Spin wave theory module
stochastic: Stochastic Magnetization Dynamics - Finite Temperature Effects
texture: Magnetic textures and topological structures
thermo: Thermoelectric and thermomagnetic effects in spintronics
topomagnon: Topological magnon bands — bosonic analogues of electronic Chern insulators.
transport: Spin transport phenomena
units: Unit consistency checks for physical quantities
validation: Physical Validity Checks and Experimental Validation
vector3: Simple 3D vector implementation for spintronics
visualization: Visualization and Data Export