pyplmschmidt.1

.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "PLMSCHMIDT 1"
.TH PLMSCHMIDT 1 "2014-09-12" "SHTOOLS 3.0" "SHTOOLS 3.0"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "PlmSchmidt"
.IX Header "PlmSchmidt"
.IP "PlmSchmidt \-" 13
.IX Item "PlmSchmidt -"
Compute all the Schmidt semi-normalized associated Legendre functions.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.IP "\s-1SUBROUTINE\s0 PlmSchmidt (" 24
.IX Item "SUBROUTINE PlmSchmidt ("
P, \s-1LMAX\s0, Z, \s-1CSPHASE\s0, \s-1CNORM\s0 )
.RS 4
.IP "REAL*8" 20
.IX Item "REAL*8"
P((\s-1LMAX+1\s0)*(\s-1LMAX+2\s0)/2), Z
.IP "\s-1INTEGER\s0" 20
.IX Item "INTEGER"
\&\s-1LMAX\s0
.IP "\s-1INTEGER\s0, \s-1OPTIONAL\s0" 20
.IX Item "INTEGER, OPTIONAL"
\&\s-1CSPHASE\s0, \s-1CNORM\s0
.RE
.RS 4
.RE
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fIPlmSchmidt\fR will calculate all of the Schmidt semi-normalized associated Legendre functions up to degree \s-1LMAX\s0 for a given argument. These are calculated using a standard three-term recursion formula, and in order to prevent overflows, the scaling approach of Holmes and Featherstone (2002) is utilized. These functions are accurate to about degree 2800. The index of the array corresponding to a given degree L and angular order M can be computed by a call to \fIPlmIndex\fR.
.PP
The integral of the squared Legendre functions over the interval [\-1, 1] is 2 * (2 \- delta(0,m))/(2L+1), where delta is the Kronecker delta function. If the optional parameter \s-1CNORM\s0 is set equal to 1, the complex normalization will be used where the integral of the squared Legendre functions over the interval [\-1, 1] is 2/(2L+1). The default is to exclude the Condon-Shortley phase, but this can be modified by setting the optional argument \s-1CSPHASE\s0 to \-1.
.SH "ARGUMENTS"
.IX Header "ARGUMENTS"
.IP "P" 10
.IX Item "P"
(output) REAL*8, \s-1DIMENSION\s0 ((\s-1LMAX+1\s0)*(\s-1LMAX+2\s0)/2)
.Sp
An array of Schmidt-normalized associated Legendre functions up to degree \s-1LMAX\s0. The index corresponds to L*(L+1)/2 + M + 1, which can be calculated by a call to \fIPlmIndex\fR.
.IP "\s-1LMAX\s0" 10
.IX Item "LMAX"
(input) \s-1INTEGER\s0
.Sp
The maximum degree of the associated Legendre functions to be computed. If \s-1LMAX\s0 is \-1, allocated memory will be deallocated (see notes below).
.IP "Z" 10
.IX Item "Z"
(input) REAL*8
.Sp
The argument of the associated Legendre functions.
.IP "\s-1CSPHASE\s0" 10
.IX Item "CSPHASE"
(input) \s-1INTEGER\s0, \s-1OPTIONAL\s0
.Sp
If 1 (default), the Condon-Shortley phase will be excluded. If \-1, the Condon-Shortley phase of (\-1)^m will be appended to the associated Legendre functions.
.IP "\s-1CNORM\s0" 10
.IX Item "CNORM"
(input) \s-1INTEGER\s0, \s-1OPTIONAL\s0
.Sp
If 1, the complex normalization of the associated Legendre functions will be used. The default is to use the real normalization.
.SH "NOTES"
.IX Header "NOTES"
This routine saves the three-term recursion factors and square roots of the integers the first time being called. If subsequent calls possess the same value of \s-1LMAX\s0, these will not be recomputed. If you wish to deallocate this memory, which is an array of length (\s-1LMAX+1\s0)*(\s-1LMAX+2\s0), recall this routine with LMAX=\-1.
.SH "REFERENCES"
.IX Header "REFERENCES"
Holmes, S. A., and W. E. Featherstone, A unified approach to the Clenshaw
summation and the recursive computation of very high degree and
order normalised associated Legendre functions, \fIJ. Geodesy\fR, 76, 279\-
299, 2002.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIplbar\fR\|(1), \fIplbar_d1\fR\|(1), \fIplmbar\fR\|(1), \fIplmbar_d1\fR\|(1), \fIplon\fR\|(1), \fIplon_d1\fR\|(1), \fIplmon\fR\|(1), \fIplmon_d1\fR\|(1), \fIplschmidt\fR\|(1), \fIplschmidt_d1\fR\|(1), \fIplmschmidt_d1\fR\|(1), \fIplegendre\fR\|(1), \fIplegendre_d1\fR\|(1), \fIplegendrea\fR\|(1), \fIplegendrea_d1\fR\|(1), \fIplmindex\fR\|(1)
.PP
<http://shtools.ipgp.fr/>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2012 by Mark Wieczorek <wieczor@ipgp.fr>.
.PP
This is free software; you can distribute and modify it under the terms of the revised \s-1BSD\s0 license.