-
Notifications
You must be signed in to change notification settings - Fork 106
/
plmindex.1
36 lines (36 loc) · 1.16 KB
/
plmindex.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
.\" Automatically generated by Pandoc 2.10
.\"
.TH "plmindex" "1" "2020-04-07" "Fortran 95" "SHTOOLS 4.7"
.hy
.SH PlmIndex
.PP
Compute the index of an array corresponding to degree \f[C]l\f[R] and
angular order \f[C]m\f[R].
.SH Usage
.PP
\f[C]index\f[R] = PlmIndex (\f[C]l\f[R], \f[C]m\f[R])
.SH Parameters
.TP
\f[B]\f[CB]index\f[B]\f[R] : function output, integer
Index of an array of associated Legendre functions corresponding to
degree \f[C]l\f[R] and angular order \f[C]m\f[R].
.TP
\f[B]\f[CB]l\f[B]\f[R] : input, integer
The spherical harmonic degree.
.TP
\f[B]\f[CB]m\f[B]\f[R] : input, integer
The angular order.
.SH Description
.PP
\f[C]PlmIndex\f[R] will calculate the index of an array of associated
Legendre functions corresponding to degree \f[C]l\f[R] and angular order
\f[C]m\f[R].
The input arrays are generated by routines such as \f[C]PlmBar\f[R],
\f[C]PlmBar_d1\f[R], \f[C]PlmSchmidt\f[R], \f[C]PlmSchmidt_d1\f[R],
\f[C]PlmON\f[R], \f[C]PlmON_d1\f[R], \f[C]PLegendreA\f[R], and
\f[C]PLegendreA_d1\f[R].
The array index is equal to \f[C]l*(l+1)/2+m+1\f[R].
.SH See also
.PP
plmbar, plmbar_d1, plmschmidt, plmschmidt_d1, plmon, plmon_d1,
\f[C]plegendrea\f[R], plegendrea_d1