-
Notifications
You must be signed in to change notification settings - Fork 104
/
plegendre.3
56 lines (56 loc) · 1.7 KB
/
plegendre.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
53
54
55
56
.\" 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 "plegendre" "1" "2021-02-15" "Fortran 95" "SHTOOLS 4.11"
.hy
.SH PLegendre
.PP
Compute all the unnormalized Legendre polynomials.
.SH Usage
.PP
call PLegendre (\f[V]p\f[R], \f[V]lmax\f[R], \f[V]z\f[R],
\f[V]exitstatus\f[R])
.SH Parameters
.TP
\f[V]p\f[R] : output, real(dp), dimension (\f[V]lmax\f[R]+1)
An array of unnormalized Legendre polynomials up to degree
\f[V]lmax\f[R].
Degree \f[V]l\f[R] corresponds to array index \f[V]l\f[R]+1.
.TP
\f[V]lmax\f[R] : input, integer(int32)
The maximum degree of the Legendre polynomials to be computed.
.TP
\f[V]z\f[R] : input, real(dp)
The argument of the Legendre polynomial.
.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]PLegendre\f[R] will calculate all of the unnormalized Legendre
polynomials up to degree \f[V]lmax\f[R] for a given argument.
These are calculated using a standard three-term recursion formula.
The integral of the Legendre polynomials over the interval [-1, 1] is
\f[V]2/(2l+1)\f[R].
.SH See also
.PP
plbar, plbar_d1, plmbar, plmbar_d1, plon, plon_d1, plmon, plmon_d1,
plschmidt, plschmidt_d1, plmschmidt, plmschmidt_d1, plegendre_d1,
plegendrea, plegendrea_d1