FLDget_ndim


Synopsis

get/set the ndim in a Grid_Struct Grid


int FLDget_ndim (
OMobj_id field,
int *ndim);

int FLDset_ndim (
OMobj_id field,
int ndim);

Description

These routines get/set the number of dimensions (ndim: 1D, 2D, 3D, etc.) in a Grid_Struct Grid. Grid_Structs include Grid_Unif and Grid_Rect fields.

Parameters

OMobj_id field

The OMobj_id of a field that contains a Grid_Struct.

int *ndim
int ndim

In FLDget_ndim, ndim is a pointer to an integer variable in which the ndim is returned.

In FLDset_ndim, ndim is an integer variable from which the ndim is copied to the field.

Example

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

Related routines