NAG FL Interface
d03rzf (dim2_​gen_​order2_​rectilinear_​extractgrid)

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

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

On entry: the grid level at which the coordinates are required.

Constraint: $1\le \mathbf{level}\le \mathbf{nlev}$.

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

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

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

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

6: $\mathbf{dyb}$ – Real (Kind=nag_wp) Input

On entry: nlev, xmin, ymin, dxb and dyb as supplied to monitr must be passed unchanged to d03rzf.

7: $\mathbf{lgrid}\left(*\right)$ – Integer array Input

Note: the dimension of the array lgrid must be at least $\mathbf{nlev}$.

On entry: lgrid as supplied to monitr must be passed unchanged to d03rzf.

8: $\mathbf{istruc}\left(*\right)$ – Integer array Input

Note: the dimension of the array istruc must be at least $\mathbf{lgrid}\left(\mathbf{nlev}\right)+2\times \mathit{nrows}+\mathbf{npts}+1$ where $\mathit{nrows}$ is stored in $\mathbf{istruc}\left(\mathbf{lgrid}\left(\mathbf{nlev}\right)\right)$ and is the number of rows in the grid at level nlev.

On entry: istruc as supplied to monitr must be passed unchanged to d03rzf.

9: $\mathbf{npts}$ – Integer Output

On exit: the number of grid points in the grid level level.

10: $\mathbf{x}\left(\mathbf{lenxy}\right)$ – Real (Kind=nag_wp) array Output

11: $\mathbf{y}\left(\mathbf{lenxy}\right)$ – Real (Kind=nag_wp) array Output

On exit: $\mathbf{x}\left(\mathit{i}\right)$ and $\mathbf{y}\left(\mathit{i}\right)$ contain the $\left(x,y\right)$ coordinates respectively of the $\mathit{i}$th grid point, for $\mathit{i}=1,2,\dots ,\mathbf{npts}$.

12: $\mathbf{lenxy}$ – Integer Input

On entry: the dimension of the arrays x and y as declared in the (sub)program from which d03rzf is called.

Constraint: $\mathbf{lenxy}\ge \mathbf{npts}$.

13: $\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).

6 Error Indicators and Warnings

$\mathbf{ifail}=1$

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

On entry, $\mathbf{level}=〈\mathit{\text{value}}〉$ and $\mathbf{nlev}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{level}\le \mathbf{nlev}$.

$\mathbf{ifail}=2$

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

$\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

10 Example