s21bf: FL CL CPP AD PY MB

NAG CL Interface
s21bfc (ellipint_legendre_2)

Keyword Search:

NAG Library Manual, Mark 30.1

Interfaces: FL CL CPP AD PY MB

NAG CL Interface Introduction

S (Specfun) Chapter Contents

S (Specfun) Chapter Introduction

s21bf: 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

Settings help

CL Name Style:
Short (a00aac)
Long (impl_details)
Full (nag_info_impl_details)

1 Purpose

s21bfc returns a value of the classical (Legendre) form of the incomplete elliptic integral of the second kind.

2 Specification

#include <nag.h>

double

s21bfc (double phi, double dm, NagError *fail)

The function may be called by the names: s21bfc, nag_specfun_ellipint_legendre_2 or nag_elliptic_integral_e.

3 Description

s21bfc calculates an approximation to the integral

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

where

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

and

m \sin^{2} ϕ \leq 1

The integral is computed using the symmetrised elliptic integrals of Carlson (Carlson (1979) and Carlson (1988)). The relevant identity is

E (ϕ ∣ m) = \sin ϕ R_{F} (q, r, 1) - \frac{1}{3} m \sin^{3} ϕ R_{D} (q, r, 1),

where

q = \cos^{2} ϕ

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

R_{F}

is the Carlson symmetrised incomplete elliptic integral of the first kind (see s21bbc) and

R_{D}

is the Carlson symmetrised incomplete elliptic integral of the second kind (see s21bcc).

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$ – double Input

2: $dm$ – double 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$ .

3: $fail$ – NagError * Input/Output

The NAG error argument (see Section 7 in the Introduction to the NAG Library CL Interface).

6 Error Indicators and Warnings

NE_ALLOC_FAIL: Dynamic memory allocation failed.
See Section 3.1.2 in the Introduction to the NAG Library CL Interface for further information.
NE_INTERNAL_ERROR: An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact NAG for assistance.
See Section 7.5 in the Introduction to the NAG Library CL Interface for further information.
NE_NO_LICENCE: Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library CL Interface for further information.
NE_REAL: On entry, $phi = ⟨ value ⟩$ .
Constraint: $0 \leq phi \leq \frac{π}{2}$ .
NE_REAL_2: On entry, $phi = ⟨ value ⟩$ and $dm = ⟨ value ⟩$ ; the integral is undefined.
Constraint: $dm \times \sin^{2} (phi) \leq 1.0$ .

7 Accuracy

In principle s21bfc 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.

s21bfc is not threaded in any implementation.

9 Further Comments

You should consult the S Chapter Introduction, which shows the relationship between this function 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 algorithms used to compute

R_{F}

and

R_{D}

, see the function documents for s21bbc and s21bcc, respectively.

If you wish to input a value of phi outside the range allowed by this function you should refer to Section 17.4 of Abramowitz and Stegun (1972) for useful identities. For example,