magneticScattering.structures.skyrmion

skyrmion(nx, ny, number=1, helicity=0, polarity=1, neel=False)

Creates a skyrmion state with dimensions (nx, ny) at the center of the array.

Parameters:

• nx (int) – x size.

• ny (int) – y size.

• number (int) – Skyrmion topological number.

• helicity (float) – Helicity offset.

• polarity (int) – mz magnetization at the center of the skyrmion.

• neel (bool) – True for Neel type skyrmion, False (default) for Bloch type.

Returns:

Skyrmion state with dimensions (3, x, y), where the first index runs over components.

Return type:

ndarray