NAG Library Routine Document

S19APF

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Parameters

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

S19APF returns an array of values for the Kelvin function

bei x

2 Specification

SUBROUTINE S19APF (

N, X, F, IVALID, IFAIL)

INTEGER	N, IVALID(N), IFAIL
REAL (KIND=nag_wp)	X(N), F(N)

3 Description

S19APF evaluates an approximation to the Kelvin function

bei x_{i}

for an array of arguments

x_{i}

, for

i = 1, 2, \dots, n

Note:

bei (- x) = bei x

, so the approximation need only consider

x \geq 0.0

The routine is based on several Chebyshev expansions:

For

0 \leq x \leq 5

bei x = \frac{x^{2}}{4} \underset{r = 0}{\sum^{'}} a_{r} T_{r} (t),   with ​ t = 2 {(\frac{x}{5})}^{4} - 1;

For

x > 5

bei x = \frac{e^{x / \sqrt{2}}}{\sqrt{2 π x}} [(1 + \frac{1}{x} a (t)) \sin α - \frac{1}{x} b (t) \cos α]

+ \frac{e^{x / \sqrt{2}}}{\sqrt{2 π x}} [(1 + \frac{1}{x} c (t)) \cos β - \frac{1}{x} d (t) \sin β]

where

α = \frac{x}{\sqrt{2}} - \frac{π}{8}

β = \frac{x}{\sqrt{2}} + \frac{π}{8}

and

a (t)

b (t)

c (t)

, and

d (t)

are expansions in the variable

t = \frac{10}{x} - 1

When

x

is sufficiently close to zero, the result is computed as

bei x = \frac{x^{2}}{4}

. If this result would underflow, the result returned is

bei x = 0.0

For large

x

, there is a danger of the result being totally inaccurate, as the error amplification factor grows in an essentially exponential manner; therefore the routine must fail.

4 References

Abramowitz M and Stegun I A (1972) Handbook of Mathematical Functions (3rd Edition) Dover Publications

5 Parameters

1: $N$ – INTEGERInput

On entry:

n

, the number of points.

Constraint:

N \geq 0

2: $X (N)$ – REAL (KIND=nag_wp) arrayInput

On entry: the argument

x_{i}

of the function, for

i = 1, 2, \dots, N

3: $F (N)$ – REAL (KIND=nag_wp) arrayOutput

On exit:

bei x_{i}

, the function values.

4: $IVALID (N)$ – INTEGER arrayOutput

On exit:

IVALID (i)

contains the error code for

x_{i}

, for

i = 1, 2, \dots, N

$IVALID (i) = 0$: No error.
$IVALID (i) = 1$: $abs (x_{i})$ is too large for an accurate result to be returned. $F (i)$ contains zero. The threshold value is the same as for $IFAIL = 1$ in S19ABF, as defined in the Users' Note for your implementation.

5: $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

- 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, at least one value of X was invalid.
Check IVALID for more information.

$IFAIL = 2$: On entry, $N = 〈value〉$ .
Constraint: $N \geq 0$ .

$IFAIL = - 99$: An unexpected error has been triggered by this routine. Please contact NAG.
See Section 3.8 in the Essential Introduction for further information.

$IFAIL = - 399$: Your licence key may have expired or may not have been installed correctly.
See Section 3.7 in the Essential Introduction for further information.

$IFAIL = - 999$: Dynamic memory allocation failed.
See Section 3.6 in the Essential Introduction for further information.

7 Accuracy

Since the function is oscillatory, the absolute error rather than the relative error is important. Let

E

be the absolute error in the function, and

δ

be the relative error in the argument. If

δ

is somewhat larger than the machine precision, then we have:

E ≃ |\frac{x}{\sqrt{2}} (- {ber}_{1} x + {bei}_{1} x)| δ

(provided

E

is within machine bounds).

For small

x

the error amplification is insignificant and thus the absolute error is effectively bounded by the machine precision.

For medium and large

x

, the error behaviour is oscillatory and its amplitude grows like

\sqrt{\frac{x}{2 π}} e^{x / \sqrt{2}}

. Therefore it is impossible to calculate the functions with any accuracy when

\sqrt{x} e^{x / \sqrt{2}} > \frac{\sqrt{2 π}}{δ}

. Note that this value of

x

is much smaller than the minimum value of

x

for which the function overflows.

8 Parallelism and Performance

Not applicable.

9 Further Comments

None.

10 Example

This example reads values of X from a file, evaluates the function at each value of

x_{i}

and prints the results.

NAG Library Routine DocumentS19APF

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Parameters

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 Library Routine Document

S19APF