Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

gm_planar docstring normal vector unclear #192

Open
mducle opened this issue Jun 20, 2024 · 0 comments
Open

gm_planar docstring normal vector unclear #192

mducle opened this issue Jun 20, 2024 · 0 comments

Comments

@mducle
Copy link
Member

mducle commented Jun 20, 2024

The gm_planar docstring is slightly misleading. It says:

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

but actually the normal vector is not given as two angles n_theta and n_phi which are not clearly defined. It should be updated to say that these are spherical polar angles with respects to the crystal Cartesian coordinate system, where n_theta is the azimuthal angle away from the crystal Cartesian z axis, and n_phi is the angle in the x-y plane away from x. Thus x is specified as n_theta=90, n_phi=0 whilst z is n_theta=0, n_phi=0 and y is n_theta=90, n_phi=90.

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

No branches or pull requests

1 participant