FLDget_cell_data_units, FLDset_cell_data_units


Synopsis

get the units from within one Cell_Data cell_set Data_Array component


int FLDget_cell_data_units (
           OMobj_id cell_set,
           int comp,
           char *units,
           int size);

int FLDset_cell_data_units (
           OMobj_id cell_set,
           int comp,
           const char *label);

 

FLDget_cell_data_units gets the units string within one component of a Cell_Data cell_set cell_data Data_Array.

Parameters

OMobj_id cell_set

The OMobj_id of one Cell_Data cell_set array element, such as that returned by FLDget_cell_set.

int comp

An integer that specifies which component's [0-n] units to get.

char *units

A character string in which the string will be returned.

int size

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

Example

modules/cellnode.c
modules/ext_face.c
modules/write.c

Related routines