FLDget_coord_units, FLDset_coord_units

Synopsis

get/set the coordinate units within a Grid

int FLDget_coord_units (
OMobj_id field,
char *units,
int size);

int FLDset_coord_units (
OMobj_id field,
const char *units);

Description

These routines get/set the units string within the Data_Array of a Grid.

Parameters

OMobj_id field

The OMobj_id of a field that contains a Grid subobject.

char *units

In FLDget_coord_units, units is a character string in which the string will be returned.

In FLDset_coord_units, units is a character string from which the string will be copied.

int size

FLDget_coord_units only. An integer that sets the maximum length that the units may have. In practice, this is always the same as the length declared for the units array. If the units returned happens to be longer than size, it is truncated to size.

Examples

modules/advect.c
modules/bounds.c
modules/glyph.c
modules/iso.c (and others)

Files

v/fld.v.

See Also

FLDget_cell_data_units

FLDget_node_data_units