NAME

cxCoordNew - create new coordinate data structure

C SPECIFICATION

#include <cx/DataAccess.h>

typedef enum {
 cx_coord_uniform,
 cx_coord_perimeter,
 cx_coord_curvilinear
} cxCoordType;

cxCoord *cxCoordNew(long nDim, long dims[],
  long nCoordVar, cxCoordType coordType)

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 cxCoordNew(nDim, dims, nCoordVar, coordType)
integer nDim, dims(nDim), nCoordVar, coordType

PARAMETERS

nDim: Number of dimensions of the data space.
dims: Array specifying length in each dimension of the data space.
nCoordVar: Number of elements per coordinate point.
coordType: Representation of coordinate information.

FUNCTION RETURN VALUE

Returns pointer to the new coordinate structure, or NULL if a memory allocation error occurred or any parameters are invalid.

DESCRIPTION

cxCoordNew allocates the coordinate portion of the lattice. Coordinates of the type given by coordType will be created, with nCoordVar floating point elements per coordinate. For uniform and perimeter lattices, the values nDim and nCoordVar must be equal.