s21da: FL CL CPP AD

NAG FL Interface
s21daf (ellipint_general_2)

Keyword Search:

NAG Library Manual, Mark 28.3

Interfaces: FL CL CPP AD

NAG FL Interface Introduction

S (Specfun) Chapter Contents

S (Specfun) Chapter Introduction

s21da: FL CL CPP AD

▸▿ 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

s21daf returns the value of the general elliptic integral of the second kind

F (z, k^{'}, a, b)

for a complex argument

z

, via the function name.

2 Specification

Fortran Interface

Function s21daf (

z, akp, a, b, ifail)

Complex (Kind=nag_wp)	::	s21daf
Integer, Intent (Inout)	::	ifail
Real (Kind=nag_wp), Intent (In)	::	akp, a, b
Complex (Kind=nag_wp), Intent (In)	::	z

C Header Interface

#include <nag.h>

Complex

s21daf_ (const Complex *z, const double *akp, const double *a, const double *b, Integer *ifail)

The routine may be called by the names s21daf or nagf_specfun_ellipint_general_2.

3 Description

s21daf evaluates an approximation to the general elliptic integral of the second kind

F (z, k^{'}, a, b)

given by

F (z, k^{'}, a, b) = \int_{0}^{z} \frac{a + b ζ^{2}}{(1 + ζ^{2}) \sqrt{(1 + ζ^{2}) (1 + {k^{'}}^{2} ζ^{2})}} d ζ,

where

a

and

b

are real arguments,

z

is a complex argument whose real part is non-negative and

k^{'}

is a real argument (the complementary modulus). The evaluation of

F

is based on the Gauss transformation. Further details, in particular for the conformal mapping provided by

F

, can be found in Bulirsch (1960).

Special values include

F (z, k^{'}, 1, 1) = \int_{0}^{z} \frac{d ζ}{\sqrt{(1 + ζ^{2}) (1 + k^{'} 2 ζ^{2})}},

F_{1} (z, k^{'})

(the elliptic integral of the first kind) and

F (z, k^{'}, 1, {k^{'}}^{2}) = \int_{0}^{z} \frac{\sqrt{1 + {k^{'}}^{2} ζ^{2}}}{(1 + ζ^{2}) \sqrt{1 + ζ^{2}}} d ζ,

F_{2} (z, k^{'})

(the elliptic integral of the second kind). Note that the values of

F_{1} (z, k^{'})

and

F_{2} (z, k^{'})

are equal to

\tan^{- 1} (z)

in the trivial case

k^{'} = 1

s21daf is derived from an Algol 60 procedure given by Bulirsch (1960). Constraints are placed on the values of

z

and

k^{'}

in order to avoid the possibility of machine overflow.

4 References

Bulirsch R (1960) Numerical calculation of elliptic integrals and elliptic functions Numer. Math. 7 76–90

5 Arguments

1: $z$ – Complex (Kind=nag_wp) Input

On entry: the argument

z

of the function.

Constraints:

$0.0 \leq Re (z) \leq λ$ ;
$abs (Im (z)) \leq λ$ , where $λ^{6} = 1 / x02amf$ .

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

On entry: the argument

k^{'}

of the function.

Constraint:

abs (akp) \leq λ

3: $a$ – Real (Kind=nag_wp) Input

On entry: the argument

a

of the function.

4: $b$ – Real (Kind=nag_wp) Input

On entry: the argument

b

of the function.

5: $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, $| akp |$ is too large: $| akp | = ⟨ value ⟩$ . It must not exceed $⟨ value ⟩$ .

On entry, $| Im (z) |$ is too large: $| Im (z) | = ⟨ value ⟩$ . It must not exceed $⟨ value ⟩$ .

On entry, $Re (z) < 0.0$ : $Re (z) = ⟨ value ⟩$ .

On entry, $Re (z)$ is too large: $Re (z) = ⟨ value ⟩$ . It must not exceed $⟨ value ⟩$ .

$ifail = 2$: The iterative procedure used to evaluate the integral has failed to converge.

$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 the routine is capable of achieving full relative precision in the computed values. However, the accuracy obtainable in practice depends on the accuracy of the standard elementary functions such as atan2 and log.

8 Parallelism and Performance

s21daf is not threaded in any implementation.

9 Further Comments

None.

10 Example

This example evaluates the elliptic integral of the first kind

F_{1} (z, k^{'})

given by

F_{1} (z, k^{'}) = \int_{0}^{z} \frac{d ζ}{\sqrt{(1 + ζ^{2}) (1 + {k^{'}}^{2} ζ^{2})}},

where

z = 1.2 + 3.7 i

and

k^{'} = 0.5

, and prints the results.

s21da: FL CL CPP AD

NAG FL Interfaces21daf (ellipint_​general_​2)

▸▿ 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

NAG FL Interface
s21daf (ellipint_general_2)