FLDget_dims

Synopsis

get/set the dims array in a Grid_Struct Grid

int FLDget_dims (
OMobj_id field,
xp_long **dims,
xp_long *ndim);

int FLDset_dims (
OMobj_id field,
xp_long *dims);

int FLDget_dims_n(
OMobj_id field,
int **dims,
int *ndim);

int FLDset_dims_n (
OMobj_id field,
int *dims);

Description

These routines get/set the dims array (number of coordinates in each of the X, Y, and Z axes) in a Grid_Struct Grid. Grid_Structs include Grid_Unif and Grid_Rect data.

Parameters

OMobj_id field

The OMobj_id of a field that contains a Grid_Struct.

xp_long **dims
xp_long *dims
int **dims
int *dims

In FLDget_dims, pointer to a pointer to integers; on return, *dims is filled in with a pointer to the dims array. You must call ARRfree() on the result when you are done with it.

In FLDset_dims, address of an integer array from which the dims are copied into the field.

xp_long *size
int *size

FLDget_dims only. A pointer to an integer in which the number of values in the dims array (effectively, the ndim) is returned.

number_of_elements

The size of the array, in terms of number of elements.

number_of_elements

The size of the array, in terms of number of elements.

Examples

modules/bounds.c
modules/crop.c
modules/down.c
modules/exc_brk3.c
modules/orthoslc.c
modules/slicestr.c

Files