/
shrtoc.1
61 lines (61 loc) · 2.58 KB
/
shrtoc.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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
.\" Automatically generated by Pandoc 2.5
.\"
.TH "shrtoc" "1" "2017\-11\-28" "Fortran 95" "SHTOOLS 4.4"
.hy
.SH SHrtoc
.PP
Convert real spherical harmonics to complex form.
.SH Usage
.PP
call SHrtoc (\f[C]rcilm\f[R], \f[C]ccilm\f[R], \f[C]degmax\f[R],
\f[C]convention\f[R], \f[C]switchcs\f[R], \f[C]exitstatus\f[R])
.SH Parameters
.TP
.B \f[C]rcilm\f[R] : input, real*8, dimension (2, \f[C]lmaxin\f[R]+1, \f[C]lmaxin\f[R]+1)
The input real spherical harmonic coefficients.
\f[C]rcilm(1,:,:)\f[R] and \f[C]rcilm(2,:,:)\f[R] correspond to the
cosine and sine terms, respectively.
.TP
.B \f[C]ccilm\f[R] : output, real*8, dimension (2, \f[C]lmaxout\f[R]+1, \f[C]lmaxout\f[R]+1)
The output complex spherical harmonic coefficients.
\f[C]ccilm(1,:,:)\f[R] and \f[C]ccilm(2,:,:)\f[R] correspond to the real
and complex part of the coefficients, respectively.
Only the positive angular orders are output; the negative orders can be
calculated from the relation
\f[C]C_{l\-m}=(\-1)\[ha]m C_{lm}\[ha]*\f[R].
.TP
.B \f[C]degmax\f[R] : input, optional, integer, default = min(\f[C]lmaxin\f[R], \f[C]lmaxout\f[R])
The maximum degree of the output coefficients.
.TP
.B \f[C]convention\f[R] : input, optional, integer, default = 1
If 1 (default), the input and output coefficients will have the same
normalization.
If 2, real geodesy 4\-pi coefficients will be converted to complex
orthonormal form.
.TP
.B \f[C]swtichcs\f[R] : input, optional, integer, default = 0
If 0 (default), the input and output coefficients will possess the same
Condon\-Shortley phase convention.
If 1, the input coefficients will first be multiplied by (\-1)\[ha]m.
.TP
.B \f[C]exitstatus\f[R] : output, optional, integer
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[C]SHrtoc\f[R] will convert real spherical harmonics to complex form.
By default, the dimension of the output array is the minimum of
\f[C]rcilm\f[R] and \f[C]ccilm\f[R], though this can be changed by
specifying the optional parameter \f[C]degmax\f[R].
The normalization of the input and output coefficients are by default
the same, but if the optional argument \f[C]convention\f[R] is set to 2,
this routine will convert from geodesy 4\-pi normalized coefficients to
orthonormalized coefficients.
The Condon\-Shortley phase convention between the input an output
coefficients can be modified by the optional argument \f[C]switchs\f[R].
.SH See also
.PP
shctor