# NAG FL Interfacee01thf (dim3_​scat_​shep_​eval)

## 1Purpose

e01thf evaluates the three-dimensional interpolating function generated by e01tgf and its first partial derivatives.

## 2Specification

Fortran Interface
 Subroutine e01thf ( m, x, y, z, f, iq, liq, rq, lrq, n, u, v, w, q, qx, qy, qz,
 Integer, Intent (In) :: m, iq(liq), liq, lrq, n Integer, Intent (Inout) :: ifail Real (Kind=nag_wp), Intent (In) :: x(m), y(m), z(m), f(m), rq(lrq), u(n), v(n), w(n) Real (Kind=nag_wp), Intent (Out) :: q(n), qx(n), qy(n), qz(n)
#include <nag.h>
 void e01thf_ (const Integer *m, const double x[], const double y[], const double z[], const double f[], const Integer iq[], const Integer *liq, const double rq[], const Integer *lrq, const Integer *n, const double u[], const double v[], const double w[], double q[], double qx[], double qy[], double qz[], Integer *ifail)
The routine may be called by the names e01thf or nagf_interp_dim3_scat_shep_eval.

## 3Description

e01thf takes as input the interpolant $Q\left(x,y,z\right)$ of a set of scattered data points $\left({x}_{r},{y}_{r},{z}_{r},{f}_{r}\right)$, for $\mathit{r}=1,2,\dots ,m$, as computed by e01tgf, and evaluates the interpolant and its first partial derivatives at the set of points $\left({u}_{i},{v}_{i},{w}_{i}\right)$, for $\mathit{i}=1,2,\dots ,n$.
e01thf must only be called after a call to e01tgf.
This routine is derived from the routine QS3GRD described by Renka (1988).

## 4References

Renka R J (1988) Algorithm 661: QSHEP3D: Quadratic Shepard method for trivariate interpolation of scattered data ACM Trans. Math. Software 14 151–152

## 5Arguments

1: $\mathbf{m}$Integer Input
2: $\mathbf{x}\left({\mathbf{m}}\right)$Real (Kind=nag_wp) array Input
3: $\mathbf{y}\left({\mathbf{m}}\right)$Real (Kind=nag_wp) array Input
4: $\mathbf{z}\left({\mathbf{m}}\right)$Real (Kind=nag_wp) array Input
5: $\mathbf{f}\left({\mathbf{m}}\right)$Real (Kind=nag_wp) array Input
On entry: m, x, y, z and f must be the same values as were supplied in the preceding call to e01tgf.
6: $\mathbf{iq}\left({\mathbf{liq}}\right)$Integer array Input
On entry: must be unchanged from the value returned from a previous call to e01tgf.
7: $\mathbf{liq}$Integer Input
On entry: the dimension of the array iq as declared in the (sub)program from which e01thf is called.
Constraint: ${\mathbf{liq}}\ge 2×{\mathbf{m}}+1$.
8: $\mathbf{rq}\left({\mathbf{lrq}}\right)$Real (Kind=nag_wp) array Input
On entry: must be unchanged from the value returned from a previous call to e01tgf.
9: $\mathbf{lrq}$Integer Input
On entry: the dimension of the array rq as declared in the (sub)program from which e01thf is called.
Constraint: ${\mathbf{lrq}}\ge 10×{\mathbf{m}}+7$.
10: $\mathbf{n}$Integer Input
On entry: $n$, the number of evaluation points.
Constraint: ${\mathbf{n}}\ge 1$.
11: $\mathbf{u}\left({\mathbf{n}}\right)$Real (Kind=nag_wp) array Input
12: $\mathbf{v}\left({\mathbf{n}}\right)$Real (Kind=nag_wp) array Input
13: $\mathbf{w}\left({\mathbf{n}}\right)$Real (Kind=nag_wp) array Input
On entry: ${\mathbf{u}}\left(\mathit{i}\right)$, ${\mathbf{v}}\left(\mathit{i}\right)$, ${\mathbf{w}}\left(\mathit{i}\right)$ must be set to the evaluation point $\left({u}_{\mathit{i}},{v}_{\mathit{i}},{w}_{\mathit{i}}\right)$, for $\mathit{i}=1,2,\dots ,n$.
14: $\mathbf{q}\left({\mathbf{n}}\right)$Real (Kind=nag_wp) array Output
On exit: ${\mathbf{q}}\left(\mathit{i}\right)$ contains the value of the interpolant, at $\left({u}_{\mathit{i}},{v}_{\mathit{i}},{w}_{\mathit{i}}\right)$, for $\mathit{i}=1,2,\dots ,n$. If any of these evaluation points lie outside the region of definition of the interpolant the corresponding entries in q are set to the largest machine representable number (see x02alf), and e01thf returns with ${\mathbf{ifail}}={\mathbf{3}}$.
15: $\mathbf{qx}\left({\mathbf{n}}\right)$Real (Kind=nag_wp) array Output
16: $\mathbf{qy}\left({\mathbf{n}}\right)$Real (Kind=nag_wp) array Output
17: $\mathbf{qz}\left({\mathbf{n}}\right)$Real (Kind=nag_wp) array Output
On exit: ${\mathbf{qx}}\left(\mathit{i}\right)$, ${\mathbf{qy}}\left(\mathit{i}\right)$, ${\mathbf{qz}}\left(\mathit{i}\right)$ contains the value of the partial derivatives of the interpolant $Q\left(x,y,z\right)$ at $\left({u}_{\mathit{i}},{v}_{\mathit{i}},{w}_{\mathit{i}}\right)$, for $\mathit{i}=1,2,\dots ,n$. If any of these evaluation points lie outside the region of definition of the interpolant, the corresponding entries in qx, qy and qz are set to the largest machine representable number (see x02alf), and e01thf returns with ${\mathbf{ifail}}={\mathbf{3}}$.
18: $\mathbf{ifail}$Integer Input/Output
On entry: ifail must be set to $0$, $-1$ or $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$ or $1$ is recommended. If message printing is undesirable, then the value $1$ is recommended. Otherwise, the value $0$ is recommended. When the value $-\mathbf{1}$ 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).

## 6Error Indicators and Warnings

If on entry ${\mathbf{ifail}}=0$ or $-1$, explanatory error messages are output on the current error message unit (as defined by x04aaf).
Errors or warnings detected by the routine:
${\mathbf{ifail}}=1$
On entry, liq is too small: ${\mathbf{liq}}=〈\mathit{\text{value}}〉$.
On entry, lrq is too small: ${\mathbf{lrq}}=〈\mathit{\text{value}}〉$.
On entry, ${\mathbf{m}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{m}}\ge 10$.
On entry, ${\mathbf{n}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{n}}\ge 1$.
${\mathbf{ifail}}=2$
On entry, values in iq appear to be invalid. Check that iq has not been corrupted between calls to e01tgf and e01thf.
On entry, values in rq appear to be invalid. Check that rq has not been corrupted between calls to e01tgf and e01thf.
${\mathbf{ifail}}=3$
On entry, at least one evaluation point lies outside the region of definition of the interpolant. At such points the corresponding values in q and qx contain extrapolated approximations. Points should be evaluated one by one to identify extrapolated values.
${\mathbf{ifail}}=-99$
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.

## 7Accuracy

Computational errors should be negligible in most practical situations.

## 8Parallelism and Performance

e01thf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
e01thf makes calls to BLAS and/or LAPACK routines, which may be threaded within the vendor library used by this implementation. Consult the documentation for the vendor library for further information.
Please consult the X06 Chapter Introduction for information on how to control and interrogate the OpenMP environment used within this routine. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

The time taken for a call to e01thf will depend in general on the distribution of the data points. If x, y and z are approximately uniformly distributed, then the time taken should be only $\mathit{O}\left({\mathbf{n}}\right)$. At worst $\mathit{O}\left({\mathbf{m}}{\mathbf{n}}\right)$ time will be required.