S21BEF (PDF version)
S Chapter Contents
S Chapter Introduction
NAG Library Manual

NAG Library Routine Document


Note:  before using this routine, please read the Users' Note for your implementation to check the interpretation of bold italicised terms and other implementation-dependent details.

+ Contents

    1  Purpose
    7  Accuracy

1  Purpose

S21BEF returns a value of the classical (Legendre) form of the incomplete elliptic integral of the first kind, via the function name.

2  Specification

REAL (KIND=nag_wp) S21BEF
REAL (KIND=nag_wp)  PHI, DM

3  Description

S21BEF calculates an approximation to the integral
Fϕm = 0ϕ 1-m sin2θ -12 dθ ,
where 0ϕ π2 , msin2ϕ1  and m  and sinϕ  may not both equal one.
The integral is computed using the symmetrised elliptic integrals of Carlson (Carlson (1979) and Carlson (1988)). The relevant identity is
Fϕm = RF q,r,1 sinϕ ,
where q=cos2ϕ , r=1-m sin2ϕ  and RF  is the Carlson symmetrised incomplete elliptic integral of the first kind (see S21BBF).

4  References

Abramowitz M and Stegun I A (1972) Handbook of Mathematical Functions (3rd Edition) Dover Publications
Carlson B C (1979) Computing elliptic integrals by duplication Numerische Mathematik 33 1–16
Carlson B C (1988) A table of elliptic integrals of the third kind Math. Comput. 51 267–280

5  Parameters

1:     PHI – REAL (KIND=nag_wp)Input
2:     DM – REAL (KIND=nag_wp)Input
On entry: the arguments ϕ and m of the function.
  • 0.0PHI π2;
  • DM× sin2PHI 1.0 ;
  • Only one of sinPHI  and DM may be 1.0.
Note that DM × sin2PHI = 1.0  is allowable, as long as DM1.0 .
3:     IFAIL – INTEGERInput/Output
On entry: IFAIL must be set to 0, -1​ or ​1. If you are unfamiliar with this parameter you should refer to Section 3.3 in the Essential Introduction for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value -1​ or ​1 is recommended. If the output of error messages is undesirable, then the value 1 is recommended. Otherwise, if you are not familiar with this parameter, the recommended value is 0. When the value -1​ or ​1 is used it is essential to test the value of IFAIL on exit.
On exit: IFAIL=0 unless the routine detects an error or a warning has been flagged (see Section 6).

6  Error Indicators and Warnings

If on entry IFAIL=0 or -1, explanatory error messages are output on the current error message unit (as defined by X04AAF).
Errors or warnings detected by the routine:
PHI lies outside the range 0,π2 . On soft failure, the routine returns zero.
On entry, DM × sin2PHI > 1.0 ; the function is undefined. On soft failure, the routine returns zero.
On entry, sinPHI = 1.0  and DM=1.0 ; the function is infinite. On soft failure, the routine returns the largest machine number (see X02ALF).

7  Accuracy

In principle S21BEF is capable of producing full machine precision. However round-off errors in internal arithmetic will result in slight loss of accuracy. This loss should never be excessive as the algorithm does not involve any significant amplification of round-off error. It is reasonable to assume that the result is accurate to within a small multiple of the machine precision.

8  Further Comments

You should consult the S Chapter Introduction, which shows the relationship between this routine and the Carlson definitions of the elliptic integrals. In particular, the relationship between the argument-constraints for both forms becomes clear.
For more information on the algorithm used to compute RF , see the routine document for S21BBF.
If you wish to input a value of PHI outside the range allowed by this routine you should refer to Section 17.4 of Abramowitz and Stegun (1972) for useful identities. For example, F-ϕ|m=-Fϕ|m and Fsπ±ϕ|m=2sKm±Fϕ|m where s is an integer and Km is the complete elliptic integral given by S21BHF.
A parameter m>1 can be replaced by one less than unity using Fϕ|m=1mFθ|1m, sinθ=msinϕ.

9  Example

This example simply generates a small set of nonextreme arguments that are used with the routine to produce the table of results.

9.1  Program Text

Program Text (s21befe.f90)

9.2  Program Data


9.3  Program Results

Program Results (s21befe.r)

S21BEF (PDF version)
S Chapter Contents
S Chapter Introduction
NAG Library Manual

© The Numerical Algorithms Group Ltd, Oxford, UK. 2012