plmschmidt(1)

PlmSchmidt

Compute all the Schmidt semi-normalized associated Legendre functions.

Usage

call PlmSchmidt (p, lmax, z, csphase, cnorm, exitstatus)

Parameters

p : output, real(dp), dimension ((lmax+1)*(lmax+2)/2)
    An array of Schmidt-normalized associated Legendre functions up to degree lmax. The index corresponds to l*(l+1)/2+m+1, which can be calculated by a call to PlmIndex.

lmax : input, integer(int32)
    The maximum degree of the associated Legendre functions to be computed. If lmax is -1, allocated memory will be deallocated.

z : input, real(dp)
    The argument of the associated Legendre functions.

csphase : input, optional, integer(int32), default = 1
    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.

cnorm : input, optional, integer(int32), default = 0
    If 1, the complex normalization of the associated Legendre functions will be used. The default is to use the real normalization.

exitstatus : 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.

Description

PlmSchmidt will calculate all of the Schmidt semi-normalized associated Legendre functions up to degree lmax 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 corresponds to l*(l+1)/2+m+1, which can be calculated by a call to PlmIndex.

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 cnorm 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 csphase to -1.

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 lmax, these will not be recomputed. If you wish to deallocate this memory, which is an array of length (lmax+1)*(lmax+2), recall this routine with lmax=-1.

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, J. Geodesy, 76, 279- 299, 2002.

See also

plbar, plbar_d1, plmbar, plmbar_d1, plon, plon_d1, plmon, plmon_d1, plschmidt, plschmidt_d1, plmschmidt_d1, plegendre, plegendre_d1, plegendrea, plegendrea_d1, plmindex