Merge pull request #980 from lammps/spin-doc

added SPIN package to Section_packages doc
This commit is contained in:
Steve Plimpton 2018-06-29 15:26:36 -06:00 committed by GitHub
commit c63d77d0b8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 41 additions and 7 deletions

View File

@ -2911,14 +2911,15 @@ too close, which can cause numerical issues.
6.28 Magnetic spins :link(howto_28),h4
The magnetic spin simualtions are enabled by the SPIN package, whose
implementation is detailed in "Tranchida"_#Tranchida7.
Classical magnetic spin simualtions can be performed via the SPIN
package. The algrorithmic and implementation details are described in
"Tranchida"_#Tranchida7.
The model representents the simulation of atomic magnetic spins coupled
to lattice vibrations. The dynamics of those magnetic spins can be used
to simulate a broad range a phenomena related to magneto-elasticity, or
or to study the influence of defects on the magnetic properties of
materials.
The model representents the simulation of atomic magnetic spins
coupled to lattice vibrations. The dynamics of those magnetic spins
can be used to simulate a broad range a phenomena related to
magneto-elasticity, or or to study the influence of defects on the
magnetic properties of materials.
The magnetic spins are interacting with each others and with the
lattice via pair interactions. Typically, the magnetic exchange

View File

@ -114,6 +114,7 @@ Package, Description, Doc page, Example, Library
"RIGID"_#RIGID, rigid bodies and constraints, "fix rigid"_fix_rigid.html, rigid, -
"SHOCK"_#SHOCK, shock loading methods, "fix msst"_fix_msst.html, -, -
"SNAP"_#SNAP, quantum-fitted potential, "pair_style snap"_pair_snap.html, snap, -
"SPIN"_#SPIN, magnetic atomic spin dynamics, "Section 6.6.28"_Section_howto.html#howto_28, SPIN, -
"SRD"_#SRD, stochastic rotation dynamics, "fix srd"_fix_srd.html, srd, -
"VORONOI"_#VORONOI, Voronoi tesselation, "compute voronoi/atom"_compute_voronoi_atom.html, -, ext :tb(ea=c,ca1=l)
@ -1415,6 +1416,38 @@ examples/snap :ul
:line
SPIN package :link(SNAP),h4
[Contents:]
Model atomic magnetic spins classically, coupled to atoms moving in
the usual manner via MD. Various pair, fix, and compute styles.
[Author:] Julian Tranchida (Sandia).
[Install or un-install:]
make yes-spin
make machine :pre
make no-spin
make machine :pre
[Supporting info:]
src/SPIN: filenames -> commands
"Section 6.28"_Section_howto.html#howto_28
"pair_style spin/dmi"_pair_spin_dmi.html
"pair_style spin/exchange"_pair_spin_exchange.html
"pair_style spin/magelec"_pair_spin_magelec.html
"pair_style spin/neel"_pair_spin_neel.html
"fix nve/spin"_fix_nve_spin.html
"fix precession/spin"_fix_precession_spin.html
"compute spin"_compute_spin.html
examples/SPIN :ul
:line
SRD package :link(SRD),h4
[Contents:]