yilmindexvector.1

.\" Automatically generated by Pandoc 2.17.1.1
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "yilmindexvector" "1" "2021-02-15" "Fortran 95" "SHTOOLS 4.10"
.hy
.SH YilmIndexVector
.PP
Compute the index of an 1D array of spherical harmonic coefficients
corresponding to \f[V]i\f[R], \f[V]l\f[R], and \f[V]m\f[R].
.SH Usage
.PP
\f[V]index\f[R] = YilmIndexVector (\f[V]i\f[R], \f[V]l\f[R],
\f[V]m\f[R])
.SH Parameters
.TP
\f[V]index\f[R] : output, integer(int32)
Index of an 1D array of spherical harmonic coefficients corresponding to
\f[V]i\f[R], \f[V]l\f[R], and \f[V]m\f[R].
.TP
\f[V]i\f[R] : input, integer(int32)
1 corresponds to the cosine coefficient \f[V]cilm(1,:,:)\f[R], and 2
corresponds to the sine coefficient \f[V]cilm(2,:,:)\f[R].
.TP
\f[V]l\f[R] : input, integer(int32)
The spherical harmonic degree.
.TP
\f[V]m\f[R] : input, integer(int32)
The angular order.
.SH Description
.PP
\f[V]YilmIndexVector\f[R] will calculate the index of a 1D vector of
spherical harmonic coefficients corresponding to degree \f[V]l\f[R],
angular order \f[V]m\f[R] and \f[V]i\f[R] (1 = cosine, 2 = sine).
The elements of the 1D vector array are packed by successive degrees,
where each degree lists the l+1 cosine terms and then the l cosine
terms.
The index is given explicitly by \f[V]l**2+(i-1)*l+m+1\f[R].
.SH See also
.PP
shcilmtovector, shvectortocilm