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

Settings help

FL Name Style:


FL Specification Language:


1 Purpose

d03rzf is designed to be used in conjunction with d03rbf. It can be called from the monitr to obtain the number of grid points and their (x,y) coordinates on a solution grid.

2 Specification

Fortran Interface
Subroutine d03rzf ( level, nlev, xmin, ymin, dxb, dyb, lgrid, istruc, npts, x, y, lenxy, ifail)
Integer, Intent (In) :: level, nlev, lgrid(*), istruc(*), lenxy
Integer, Intent (Inout) :: ifail
Integer, Intent (Out) :: npts
Real (Kind=nag_wp), Intent (In) :: xmin, ymin, dxb, dyb
Real (Kind=nag_wp), Intent (Out) :: x(lenxy), y(lenxy)
C Header Interface
#include <nag.h>
void  d03rzf_ (const Integer *level, const Integer *nlev, const double *xmin, const double *ymin, const double *dxb, const double *dyb, const Integer lgrid[], const Integer istruc[], Integer *npts, double x[], double y[], const Integer *lenxy, Integer *ifail)
The routine may be called by the names d03rzf or nagf_pde_dim2_gen_order2_rectilinear_extractgrid.

3 Description

d03rzf extracts the number of grid points and their (x,y) coordinates on a specific solution grid produced by d03rbf. It must be called only from within the monitr. The arguments nlev, xmin, ymin, dxb, dyb, lgrid and istruc to monitr must be passed unchanged to d03rzf.

4 References

None.

5 Arguments

1: level Integer Input
On entry: the grid level at which the coordinates are required.
Constraint: 1levelnlev.
2: nlev Integer Input
3: xmin Real (Kind=nag_wp) Input
4: ymin Real (Kind=nag_wp) Input
5: dxb Real (Kind=nag_wp) Input
6: 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: lgrid(*) Integer array Input
Note: the dimension of the array lgrid must be at least nlev.
On entry: lgrid as supplied to monitr must be passed unchanged to d03rzf.
8: istruc(*) Integer array Input
Note: the dimension of the array istruc must be at least lgrid(nlev)+2×nrows+npts+1 where nrows is stored in istruc(lgrid(nlev)) 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: npts Integer Output
On exit: the number of grid points in the grid level level.
10: x(lenxy) Real (Kind=nag_wp) array Output
11: y(lenxy) Real (Kind=nag_wp) array Output
On exit: x(i) and y(i) contain the (x,y) coordinates respectively of the ith grid point, for i=1,2,,npts.
12: 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: lenxynpts.
13: 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 -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 or −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, level=value.
Constraint: level1.
On entry, level=value and nlev=value.
Constraint: levelnlev.
ifail=2
On entry, lenxy=value.
Constraint: lenxyvalue.
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.
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.
ifail=-999
Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7 Accuracy

Not applicable.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.
d03rzf is not threaded in any implementation.

9 Further Comments

None.

10 Example

See d03rbf.