s21be: FL CL CPP AD PY MB

NAG FL Interface
s21bef (ellipint_legendre_1)

Keyword Search:

NAG Library Manual, Mark 28.7

Interfaces: FL CL CPP AD PY MB

NAG FL Interface Introduction

S (Specfun) Chapter Contents

S (Specfun) Chapter Introduction

s21be: FL CL CPP AD PY MB

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

▸▿ 10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

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

Fortran Interface

Function s21bef (

phi, dm, ifail)

Real (Kind=nag_wp)	::	s21bef
Integer, Intent (Inout)	::	ifail
Real (Kind=nag_wp), Intent (In)	::	phi, dm

C Header Interface

#include <nag.h>

double

s21bef_ (const double *phi, const double *dm, Integer *ifail)

The routine may be called by the names s21bef or nagf_specfun_ellipint_legendre_1.

3 Description

s21bef calculates an approximation to the integral

F (ϕ ∣ m) = \int_{0}^{ϕ} {(1 - m \sin^{2} θ)}^{- \frac{1}{2}} d θ,

where

0 \leq ϕ \leq \frac{π}{2}

m \sin^{2} ϕ \leq 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) = R_{F} (q, r, 1) \sin ϕ,

where

q = \cos^{2} ϕ

r = 1 - m \sin^{2} ϕ

and

R_{F}

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 Arguments

1: $phi$ – Real (Kind=nag_wp) Input

2: $dm$ – Real (Kind=nag_wp) Input

On entry: the arguments

ϕ

and

m

of the function.

Constraints:

$0.0 \leq phi \leq \frac{π}{2}$ ;
$dm \times \sin^{2} (phi) \leq 1.0$ ;
Only one of $\sin (phi)$ and dm may be $1.0$ .

Note that

dm \times \sin^{2} (phi) = 1.0

is allowable, as long as

dm \neq 1.0

3: $ifail$ – Integer Input/Output

On entry: ifail must be set to

0

−1

1

to set behaviour on detection of an error; these values have no effect when no error is detected.

A value of

0

causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of

−1

means that an error message is printed while a value of

1

means that it is not.

If halting is not appropriate, the value

−1

1

is recommended. If message printing is undesirable, then the value

1

is recommended. Otherwise, the value

0

is recommended. 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

−1

, explanatory error messages are output on the current error message unit (as defined by x04aaf).

Errors or warnings detected by the routine:

$ifail = 1$: On entry, $phi = ⟨ value ⟩$ .
Constraint: $0 \leq phi \leq \frac{π}{2}$ .
On soft failure, the routine returns zero.

$ifail = 2$: On entry, $phi = ⟨ value ⟩$ and $dm = ⟨ value ⟩$ ; the integral is undefined.
Constraint: $dm \times \sin^{2} (phi) \leq 1.0$ .
On soft failure, the routine returns zero.

$ifail = 3$: On entry, $\sin (phi) = 1$ and $dm = 1.0$ ; the integral is infinite.
On soft failure, the routine returns the largest machine number (see x02alf).

$ifail = - 99$: An unexpected error has been triggered by this routine. Please contact NAG.
See Section 7 in the Introduction to the NAG Library FL Interface for further information.

$ifail = - 399$: Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.

$ifail = - 999$: Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

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 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.

s21bef is not threaded in any implementation.

9 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

R_{F}

, 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,