NAG Library Routine Document

s21bef (ellipint_legendre_1)

1

Purpose

2

Specification

3

Description

4

References

5

Arguments

1:     $\mathbf{phi}$ – Real (Kind=nag_wp)Input

2:     $\mathbf{dm}$ – Real (Kind=nag_wp)Input

On entry: the arguments $\varphi$ and $m$ of the function.

Constraints:

• $0.0\le \mathbf{phi}\le \frac{\pi }{2}$;
• $\mathbf{dm}\times {\sin }^2\left(\mathbf{phi}\right)\le 1.0$;
• Only one of $\sin \left(\mathbf{phi}\right)$ and dm may be $1.0$.

Note that $\mathbf{dm}\times {\sin }^2\left(\mathbf{phi}\right)=1.0$ is allowable, as long as $\mathbf{dm}\ne 1.0$.

3:     $\mathbf{ifail}$ – IntegerInput/Output

On entry: ifail must be set to $0$, $-1\text{ or }1$. If you are unfamiliar with this argument you should refer to Section 3.4 in How to Use the NAG Library and its Documentation for details.

For environments where it might be inappropriate to halt program execution when an error is detected, the value $-1\text{ 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 argument, the recommended value is $0$. When the value $-\mathbf{1}\text{ or }\mathbf{1}$ is used it is essential to test the value of ifail on exit.

On exit: $\mathbf{ifail}=\mathbf{0}$ unless the routine detects an error or a warning has been flagged (see Section 6).

6

Error Indicators and Warnings

$\mathbf{ifail}=1$

On entry, $\mathbf{phi}=〈\mathit{\text{value}}〉$.
Constraint: $0\le \mathbf{phi}\le \frac{\pi }{2}$.
On soft failure, the routine returns zero.

$\mathbf{ifail}=2$

On entry, $\mathbf{phi}=〈\mathit{\text{value}}〉$ and $\mathbf{dm}=〈\mathit{\text{value}}〉$; the integral is undefined.
Constraint: $\mathbf{dm}\times {\sin }^2\left(\mathbf{phi}\right)\le 1.0$.
On soft failure, the routine returns zero.

$\mathbf{ifail}=3$

On entry, $\sin \left(\mathbf{phi}\right)=1$ and $\mathbf{dm}=1.0$; the integral is infinite.
On soft failure, the routine returns the largest machine number (see x02alf).

$\mathbf{ifail}=-99$

An unexpected error has been triggered by this routine. Please contact NAG.

See Section 3.9 in How to Use the NAG Library and its Documentation for further information.

$\mathbf{ifail}=-399$

Your licence key may have expired or may not have been installed correctly.

See Section 3.8 in How to Use the NAG Library and its Documentation for further information.

$\mathbf{ifail}=-999$

Dynamic memory allocation failed.

See Section 3.7 in How to Use the NAG Library and its Documentation for further information.

7

Accuracy

8

Parallelism and Performance

9

Further Comments

10

Example

10.1

Program Text

Program Text (s21befe.f90)

10.2

Program Data

10.3

Program Results

Program Results (s21befe.r)