-
Notifications
You must be signed in to change notification settings - Fork 106
/
plbar.1
42 lines (42 loc) · 1.48 KB
/
plbar.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
.\" Automatically generated by Pandoc 2.5
.\"
.TH "plbar" "1" "2018\-01\-30" "Fortran 95" "SHTOOLS 4.4"
.hy
.SH PlBar
.PP
Compute all the 4\-pi (geodesy) normalized Legendre polynomials.
.SH Usage
.PP
call PlBar (\f[C]p\f[R], \f[C]lmax\f[R], \f[C]z\f[R],
\f[C]exitstatus\f[R])
.SH Parameters
.TP
.B \f[C]p\f[R] : output, real/*8, dimension (\f[C]lmax\f[R]+1)
An array of geodesy\-normalized Legendre polynomials up to degree
\f[C]lmax\f[R].
Degree \f[C]l\f[R] corresponds to array index \f[C]l+1\f[R].
.TP
.B \f[C]lmax\f[R] : input, integer
The maximum degree of the Legendre polynomials to be computed.
.TP
.B \f[C]z\f[R] : input, real/*8
The argument of the Legendre polynomial.
.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]PlBar\f[R] will calculate all of the 4\-pi (geodesy) normalized
Legendre polynomials up to degree \f[C]lmax\f[R] for a given argument.
These are calculated using a standard three\-term recursion formula.
The integral of the geodesy\-normalized Legendre polynomials over the
interval [\-1, 1] is 2.
.SH See also
.PP
plbar_d1, plmbar, plmbar_d1, plon, plon_d1, plmon, plmon_d1, plschmidt,
plschmidt_d1, plmschmidt, plmschmidt_d1, plegendre, plegendre_d1,
plegendrea, plegendrea_d1