Syntax

[s, k, n, name, pname, limit] = gm_planar(S0, x)

Description

[s, k, n, name, pname, limit] = gm_planar(S0, x) generates the parameters of arbitrary planar magnetic structure from angles (in radian), ordering wave vector (rlu) and spin plane normal vector ().

Input Arguments

x
Input parameters in the following order: .
S0
Spin quantum number in a row vector or scalar if all spins are equal.

Output Arguments

S
Matrix, containing the spin orientations with dimensions of . Every column contains the spin components of a magnetic atom in the coordinate system.
k
Magnetic ordering wavevector in rlu units in a row vector.
n
Normal vector around which the spins are rotating for non-zero propagation vector in a row vector.
name
String, storing the name of the function.
pname
Name of the input parameters in a cell: {'Phi1_rad', ...}.
limit
Limits on the input parameters in a matrix with dimensions of . Every column contains a lower and upper limit on the corresponding parameter.

See Also

gm_spherical3d | gm_planard