NAME

cxCoordCoordType - return the representation type of lattice coordinates

C SPECIFICATION

#include <cx/DataAccess.h>

typedef enum { cx_coord_uniform, cx_coord_perimeter, cx_coord_curvilinear } cxCoordType;

cxCoordType cxCoordCoordType(cxCoord *coord)

FORTRAN SPECIFICATION

integer cx_coord_uniform
integer cx_coord_perimeter
integer cx_coord_curvilinear

parameter (cx_coord_uniform = 0) parameter (cx_coord_perimeter = 1) parameter (cx_coord_curvilinear = 2)

integer function cxCoordCoordType(coord) integer coord

PARAMETERS

coord
Coordinate data structure.

FUNCTION RETURN VALUE

Returns the coordinate type of coord as one of the enumerated constants listed above.

DESCRIPTION

cxCoordCoordType returns a cxCoordType enumerated type indicating the form of the coordinates stored in coord. cxCoordCoordType returns an integer value [0..2], indicating the form of the coordinates stored in coord. Uniform, perimeter and curvilinear coordinates are described in more detail in cxCoordNew(3E).

SEE ALSO

cxCoordNew(3E), cxLatNew(3E), cxLatCoordNew(3E)
Last modified: May 26 11:59 1999
[ Documentation Home ]
© The Numerical Algorithms Group Ltd, Oxford UK. 1999