Skip to content

[6/6] Add coupled Spin FIRE relaxation - #1856

Draft
aboys-cb wants to merge 12 commits into
brucefan1983:masterfrom
MagTheoryLab:codex/spin-6-fire
Draft

aboys-cb wants to merge 12 commits into
brucefan1983:masterfrom
MagTheoryLab:codex/spin-6-fire

Conversation

@aboys-cb

@aboys-cb aboys-cb commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor

Add energy minimization for spin coordinates using FIRE, with fixed or variable moment magnitudes and optional coupled atomic/cell relaxation. Validate input combinations and use the same NEP-spin energy, force, magnetic-force and virial evaluation as MD.

FIRE is a separate minimizer and does not modify the dynamics algorithms. The combined production source at the top of this series matches the previously reviewed complete Spin branch; fixture/test helpers are factored to keep earlier parts independently testable.

Series and review scope

Part 6 of six, split from #1849. Depends on #1855.

Incremental diff for this part: parent → this commit.

This draft currently targets upstream master, so GitHub's Files changed also includes the preceding parts. After this part's prerequisites merge, rebase it onto the updated master to expose only this part in GitHub.

  1. Add NEP-spin training and model IO
  2. Add the NEP-spin potential to GPUMD
  3. Add TSPIN and Spin lattice integration support
  4. Add fixed-magnitude SIB spin dynamics
  5. Add variable-magnitude GLSD spin dynamics
  6. Add coupled Spin FIRE relaxation

Validation

Validated production/test inputs for 96cfe29c7dbf40e35a4b5ac7a9b0c42b3336e3d8 on four NVIDIA V100 GPUs with CUDA 12.9.1; 1/2/4 GPUs where specified. Final documentation/ignore-only cleanup was checked separately. The publication base is c7e6340; its only change from the GPU-tested upstream base 04bd535 is doc/publications.bib, and documentation was rebuilt after adopting it. No numerical tolerance or oracle values were changed.

  • Fresh CUDA Make builds of gpumd and nep; 22 model-format tests.
  • Full upstream regression: 255/255 cases passed, 0 failed; 25/25 relations passed.
  • 56 integrator/FIRE/lifecycle pytest cases, including analytic and coupled atom/cell minimization and invalid-input checks; 24 frozen runtime oracles for each of legacy and block formats; 41 runtime cases on 1/2/4 GPUs. Independent CMake builds of both gpumd and nep also passed.
  • Strict Sphinx HTML build (-W --keep-going), Markdown links and git diff --check passed.

These are implementation/regression checks, not scientific fit-quality or performance claims. HIP, WPE and Windows execution are not covered by this validation.

The combined final src/ tree is byte-identical to the previously reviewed full Spin branch at b7d58c136fa63203bf74a2b5959b892593553d05. Ordinary NHC/MTTK sources remain identical to upstream throughout all six parts.

Train and predict a spin-dependent NEP using the existing SNES lifecycle. Add shared Spin3 descriptors and derivatives, magnetic-force parallel/perpendicular supervision, torque and grouped-response losses, input validation, reference scaling, prediction, restart and versioned model IO.

The shared descriptor headers are introduced here for both consumers. GPUMD force dispatch and spin dynamics are not enabled in this PR.
Load exported NEP-spin models and evaluate energy, atomic forces, magnetic forces and the full virial in GPUMD. Add single-process multi-GPU evaluation, per-atom spin input/output and replication, fixed-spin restart output, and group/region magnetic fields.

The spin coordinates remain fixed under ordinary supported lattice integration. No spin integrator, spin velocity, or lattice-thermostat checkpoint state is introduced. Runtime and training reuse the descriptor kernels from part 1.
Add Cartesian TSPIN dynamics with fixed-lattice and coupled NVT/NPT modes, element-wise spin masses, spin-velocity IO and lifecycle validation. Introduce the shared Spin integration hooks and Spin-specific NHC/MTTK lattice checkpoint classes.

Ordinary NHC/MTTK implementations remain byte-identical to upstream. The initial-temperature cache retains its upstream meaning while the per-step target is passed to Spin. No SIB or GLSD commands are accepted yet. Lattice checkpoints do not imply full TSPIN extended-state restart reproducibility.
Add deterministic and stochastic semi-implicit B integration for fixed-magnitude spins, with fixed-lattice and coupled NVT/NPT modes. Introduce the shared counter-based noise helper and endpoint force refresh used by predictor/corrector spin methods.

Refresh endpoint energy, force, virial and magnetic force before measurements, preserving the already-sampled mechanical-force increment. Reuse part 3's lattice drivers. This does not add stochastic SIB random-stream restart continuation.
Add Cartesian variable-magnitude GLSD with shared-noise Heun stepping, precession and longitudinal/transverse relaxation, dimensionless damping input and checked unit conversion. Add GLSD noise-counter/seed restart metadata and combine it with the Spin lattice checkpoint support.

Reuse the potential, noise helper, endpoint refresh and lattice drivers from preceding parts. Keep GLSD's Cartesian Boltzmann measure and zero-moment behavior separate from fixed-magnitude SIB.
Add energy minimization for spin coordinates using FIRE, with fixed or variable moment magnitudes and optional coupled atomic/cell relaxation. Validate input combinations and use the same NEP-spin energy, force, magnetic-force and virial evaluation as MD.

FIRE is a separate minimizer and does not modify the dynamics algorithms. The combined production source at the top of this series matches the previously reviewed complete Spin branch; fixture/test helpers are factored to keep earlier parts independently testable.
Reject flexible ZBL before parameter loading, retain universal ZBL,
and remove C++17-only syntax from the magnetic kernels and probes.
Consolidate overlapping training checks while retaining numerical,
restart, JIT and multi-GPU coverage.
Preserve the existing PR history while carrying prerequisite Spin fixes
and the reduced regression suites into this stage.
Preserve the existing PR history while carrying prerequisite Spin fixes
and the reduced regression suites into this stage.
Preserve the existing PR history while carrying prerequisite Spin fixes
and the reduced regression suites into this stage.
Preserve the existing PR history while carrying prerequisite Spin fixes
and the reduced regression suites into this stage.
Preserve the existing PR history while carrying prerequisite Spin fixes
and the reduced regression suites into this stage.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant