FLDget_cell_data_veclen


Synopsis

get/set the number of subcomponents within one component of a Cell_Data


int FLDget_cell_data_veclen (
OMobj_id cell_set,
int comp,
int *veclen);

Description

FLDget_cell_data_units gets the veclen (number of subcomponents) within one component of a Cell_Data cell_set Data_Array.

This veclen can be used to calculate the second index into the values[nvals][veclen] data array.

Note: veclens are usually set as part of the omnibus FLDset_cell_data_comp routine. Alternatively, you can use FLDget_cell_data_veclen to set the veclen pointer, then set the actual value later.

Parameters

OMobj_id cell_set

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

int comp

An integer that specifies which component [0-n] of the Data_Array to use.

int *veclen

A pointer to an integer in which the veclen (number of subcomponents) will be returned.

veclens are numbered from 1-n. Whether you actually need to set veclen if veclen=1 depends on how your functions are coded. AVS/Express modules and functions that manipulate Cell_Data Data_Arrays either assume veclen=1 or require that veclen be set.

Example

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

Related routines