spintronics 0.3.0

Pure Rust library for simulating spin dynamics, spin current generation, and conversion phenomena in magnetic and topological materials
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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

//! Python bindings for the spintronics library using PyO3
//!
//! This module provides Python bindings for the core spintronics functionality,
//! enabling Python users to access high-performance Rust simulations.
//!
//! ## Usage from Python
//!
//! ```python
//! import spintronics
//!
//! # Create a 3D vector
//! v = spintronics.Vector3(1.0, 0.0, 0.0)
//! print(f"Magnitude: {v.magnitude()}")
//!
//! # Create materials
//! yig = spintronics.Ferromagnet.yig()
//! pt = spintronics.InverseSpinHall.platinum()
//!
//! # Run LLG simulation
//! sim = spintronics.LlgSimulator(yig)
//! sim.set_external_field(0.0, 0.0, 0.1)
//! result = sim.evolve(1e-9, 1000)
//! ```

use pyo3::prelude::*;

mod batch;
mod caloritronics;
mod dynamics;
mod effects;
mod llb;
mod materials;
mod simulation;
mod vector;

pub use batch::{batch_rk4_multistep, batch_rk4_step};
pub use caloritronics::{PyOnsagerMatrix, PySpinCaloritronicsMaterial};
pub use dynamics::PyLlgSimulator;
pub use effects::PyInverseSpinHall;
pub use llb::{PyLlbMaterial, PyLlbSolver};
pub use materials::{PyFerromagnet, PySpinInterface};
pub use simulation::PySpinPumpingSimulation;
pub use vector::PyVector3;

/// Python module for spintronics simulations
#[pymodule]
pub fn spintronics(m: &Bound<'_, PyModule>) -> PyResult<()> {
    // Core types
    m.add_class::<PyVector3>()?;

    // Materials
    m.add_class::<PyFerromagnet>()?;
    m.add_class::<PySpinInterface>()?;

    // Effects
    m.add_class::<PyInverseSpinHall>()?;

    // Standard LLG dynamics
    m.add_class::<PyLlgSimulator>()?;

    // LLB finite-temperature dynamics (v0.3.0)
    m.add_class::<PyLlbMaterial>()?;
    m.add_class::<PyLlbSolver>()?;

    // Spin caloritronics (v0.3.0)
    m.add_class::<PyOnsagerMatrix>()?;
    m.add_class::<PySpinCaloritronicsMaterial>()?;

    // High-level simulations
    m.add_class::<PySpinPumpingSimulation>()?;

    // SIMD batch LLG functions (v0.3.0)
    m.add_function(wrap_pyfunction!(batch_rk4_step, m)?)?;
    m.add_function(wrap_pyfunction!(batch_rk4_multistep, m)?)?;

    // Physical constants
    m.add("HBAR", crate::constants::HBAR)?;
    m.add("GAMMA", crate::constants::GAMMA)?;
    m.add("E_CHARGE", crate::constants::E_CHARGE)?;
    m.add("MU_B", crate::constants::MU_B)?;
    m.add("KB", crate::constants::KB)?;

    Ok(())
}