NAG FL Interface
d01jaf (md_​sphere_​bad)

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

1: $\mathbf{f}$ – real (Kind=nag_wp) Function, supplied by the user. External Procedure

f must return the value of the integrand $f$ at a given point.

The specification of f is:

Fortran Interface

Function f ( ndim, x) Real (Kind=nag_wp) :: f Integer, Intent (In) :: ndim Real (Kind=nag_wp), Intent (In) :: x(ndim)

C Header Interface

double  f_ (const Integer *ndim, const double x[])

C++ Header Interface

#include <nag.h> extern "C" { double  f_ (const Integer &ndim, const double x[]) }

1: $\mathbf{ndim}$ – Integer Input

On entry: $n$, the number of dimensions of the integral.

2: $\mathbf{x}\left(\mathbf{ndim}\right)$ – Real (Kind=nag_wp) array Input

On entry: the coordinates of the point at which the integrand $f$ must be evaluated. These coordinates are given in Cartesian or spherical polar form according to the value of icoord.

f must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which d01jaf is called. Arguments denoted as Input must not be changed by this procedure.

Note: f should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by d01jaf. If your code inadvertently does return any NaNs or infinities, d01jaf is likely to produce unexpected results.

See also Section 9.

2: $\mathbf{ndim}$ – Integer Input

On entry: $n$, the dimension of the sphere.

Constraint: $2\le \mathbf{ndim}\le 4$.

3: $\mathbf{radius}$ – Real (Kind=nag_wp) Input

On entry: $\alpha$, the radius of the sphere.

Constraint: $\mathbf{radius}\ge 0.0$.

4: $\mathbf{epsa}$ – Real (Kind=nag_wp) Input

On entry: the requested absolute tolerance. If $\mathbf{epsa}<0.0$, its absolute value is used. See Section 7.

5: $\mathbf{epsr}$ – Real (Kind=nag_wp) Input

On entry: the requested relative tolerance.

$\mathbf{epsr}<0.0$

Its absolute value is used.

$\mathbf{epsr}<10\times \left(\mathit{machine precision}\right)$

The latter value is used as epsr by the routine. See Section 7.

6: $\mathbf{method}$ – Integer Input

On entry: must specify the transformation to be used by the routine. The choice depends on the behaviour of the integrand and on the required accuracy.

For well-behaved functions and functions with mild singularities on the surface of the sphere only:

$\mathbf{method}=1$

Low accuracy required.

$\mathbf{method}=2$

High accuracy required.

For functions with severe singularities on the surface of the sphere only:

$\mathbf{method}=3$

Low accuracy required.

$\mathbf{method}=4$

High accuracy required.

(in this case icoord must be set to $\mathbf{icoord}=2$, and the function defined in special spherical coordinates).

For functions with a singularity at the centre of the sphere (and possibly with singularities on the surface as well):

$\mathbf{method}=5$

Low accuracy required.

$\mathbf{method}=6$

High accuracy required.

$\mathbf{method}=0$ can be used as a default value and is equivalent to:

• $\mathbf{method}=1$ if $\mathbf{epsr}>{10}^{-6}$, and
• $\mathbf{method}=2$ if $\mathbf{epsr}\le {10}^{-6}$.

The distinction between low and high required accuracies, as mentioned above, depends also on the behaviour of the function. Roughly one may assume the critical value of epsa and epsr to be ${10}^{-6}$, but the critical value will be smaller for a well-behaved integrand and larger for an integrand with severe singularities.

Suggested value: $\mathbf{method}=0$.

Constraint: $\mathbf{method}=0$, $1$, $2$, $3$, $4$, $5$ or $6$.

If $\mathbf{icoord}=2$, $\mathbf{method}=3$ or $4$

7: $\mathbf{icoord}$ – Integer Input

On entry: must specify which kind of coordinates are used in f.

$\mathbf{icoord}=0$

Cartesian coordinates $x_{\mathit{i}}$, for $\mathit{i}=1,2,\dots ,n$.

$\mathbf{icoord}=1$

Spherical coordinates (see Section 9.2): $\mathbf{x}\left(1\right)=\rho$; $\mathbf{x}\left(\mathit{i}\right)={\theta }_{\mathit{i}-1}$, for $\mathit{i}=2,3,\dots ,n$.

$\mathbf{icoord}=2$,

Special spherical polar coordinates (see Section 9.3), with the additional transformation $\rho =\alpha -\lambda$: $\mathbf{x}\left(1\right)=\lambda =\alpha -\rho$; $\mathbf{x}\left(\mathit{i}\right)={\theta }_{\mathit{i}-1}$, for $\mathit{i}=2,3,\dots ,n$.

Constraint: $\mathbf{icoord}=0$, $1$ or $2$.

If $\mathbf{method}=3$ or $4$, $\mathbf{icoord}=2$

8: $\mathbf{result}$ – Real (Kind=nag_wp) Output

On exit: the approximation to the integral $I$.

9: $\mathbf{esterr}$ – Real (Kind=nag_wp) Output

On exit: an estimate of the modulus of the absolute error.

10: $\mathbf{nevals}$ – Integer Output

On exit: the number of function evaluations used.

11: $\mathbf{ifail}$ – Integer Input/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 4 in the Introduction to the NAG Library FL Interface 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, because for this routine the values of the output arguments may be useful even if $\mathbf{ifail}\ne \mathbf{0}$ on exit, the recommended value is $-1$. When the value $-\mathbf{1}\text{ or }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$

The required accuracy could not be achieved.

$\mathbf{ifail}=2$

The required accuracy could not be achieved.

$\mathbf{ifail}=3$

The required accuracy could not be achieved.
If $\mathbf{method}=0$, $1$ or $2$, setting $\mathbf{method}=3$ or $4$ may help.

$\mathbf{ifail}=4$

On entry, $\mathbf{icoord}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{icoord}\le 2$.

On entry, $\mathbf{icoord}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{icoord}\ge 0$.

On entry, $\mathbf{icoord}=2$ and $\mathbf{method}=〈\mathit{\text{value}}〉$.
Constraint: when $\mathbf{icoord}=2$, $\mathbf{method}=3$ or $4$.

On entry, $\mathbf{method}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{method}\le 6$.

On entry, $\mathbf{method}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{method}\ge 0$.

On entry, $\mathbf{method}=3$ and $\mathbf{icoord}=〈\mathit{\text{value}}〉$.
Constraint: when $\mathbf{method}=3$, $\mathbf{icoord}=2$.

On entry, $\mathbf{method}=4$ and $\mathbf{icoord}=〈\mathit{\text{value}}〉$.
Constraint: when $\mathbf{method}=4$, $\mathbf{icoord}=2$.

On entry, $\mathbf{ndim}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{ndim}\le 4$.

On entry, $\mathbf{ndim}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{ndim}\ge 2$.

On entry, $\mathbf{radius}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{radius}\ge 0.0$.

$\mathbf{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.

$\mathbf{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.

$\mathbf{ifail}=-999$

Dynamic memory allocation failed.

See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7 Accuracy

8 Parallelism and Performance

9 Further Comments

9.1 Timing

9.2 Spherical Polar Coordinates

9.3 Machine Dependencies

• suppose the function

  $$f\left(\rho \right)={\left(1-{\rho }^2\right)}^{-0.7}$$

  is to be integrated over the unit sphere, with $\mathbf{method}=3$ or $4$. Then icoord should be set to 2; the transformation $\rho =1-\lambda$ gives $f\left(\rho \right)={\left(2\lambda -{\lambda }^2\right)}^{-0.7}$; and f could be coded thus:

  f = 1.0
  a = x(1)
  If (a.gt.0.0) f = 1.0/(a*(2.0-a))**0.7
  Return

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results