-
Notifications
You must be signed in to change notification settings - Fork 104
/
shvectortocilm.3
52 lines (52 loc) · 1.67 KB
/
shvectortocilm.3
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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
.\" Automatically generated by Pandoc 3.1.3
.\"
.\" 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 "shvectortocilm" "1" "2021-02-15" "Fortran 95" "SHTOOLS 4.11"
.hy
.SH SHVectorToCilm
.PP
Convert a 1-dimensional indexed vector of real spherical harmonic
coefficients to a three-dimensional array.
.SH Usage
.PP
call SHVectorToCilm (\f[V]vector\f[R], \f[V]cilm\f[R], \f[V]lmax\f[R],
\f[V]exitstatus\f[R])
.SH Parameters
.TP
\f[V]vector\f[R] : input, real(dp), dimension ( (\f[V]lmax\f[R]+1)**2 )
The input 1-D indexed array of real spherical harmonic coefficients.
.TP
\f[V]cilm\f[R] : output, real(dp), dimension (2, \f[V]lmax\f[R]+1, \f[V]lmax\f[R]+1)
The 3-D arrary of output real spherical harmonic coefficients.
.TP
\f[V]lmax\f[R] : input, integer(int32)
The maximum degree of the output coefficients.
.TP
\f[V]exitstatus\f[R] : output, optional, integer(int32)
If present, instead of executing a STOP when an error is encountered,
the variable exitstatus will be returned describing the error.
0 = No errors; 1 = Improper dimensions of input array; 2 = Improper
bounds for input variable; 3 = Error allocating memory; 4 = File IO
error.
.SH Description
.PP
\f[V]SHVectorToCilm\f[R] will convert a 1-dimensional indexed vector of
real spherical harmonic coefficients to a three-dimensional array.
The degree \f[V]l\f[R], order \f[V]m\f[R], and \f[V]i\f[R] (1 = cosine,
2 = sine) corresponds to the index \[ga]l**2+(i-1)*l+m+1.
.SH See also
.PP
shvectortocilm, yilmindexvector, shcilmtocindex, shcindextocilm