Skip to content

Commit f38fd8b

Browse files
author
davidcorteso
committed
Added comment about sk number calculations working only for 2D samples
1 parent 6f94498 commit f38fd8b

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

fidimag/atomistic/llg.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -300,6 +300,9 @@ def skyrmion_number(self, method='FiniteSpinChirality'):
300300
Calling this function will fill the _skx_number array with the skyrmion
301301
number density per lattice site.
302302
303+
It is important to mention that this calculation only works for a
304+
2D layer in the XY plane.
305+
303306
See the corresponding C code at fidimag/atomistic/lib/util.c for a
304307
detailed documentation about the methods.
305308

0 commit comments

Comments
 (0)