FLDFget_cell_props

Synopsis

get or set the user defined properties array in a cell_set

INTEGER FLDFget_cell_props (cell_set, props, size, mode)
INTEGER cell_set(OIDSIZ)
INTEGER props(*)
INTEGER size
INTEGER mode

Description

FLDFget_cell_props gets or sets the user defined properties array (props) in a specified cell set. A properties can be material id, cell thickness, etc.

The FLDFget_cell_props routine can be used for both getting and setting the props array. When setting with a "get" routine (mode = OM_GET_ARRAY_WR or OM_GET_ARRAY_RW), this routine returns an integer representing a pointer to a pre-allocated array, and the developer just needs to fill in the values.

Parameter

cell_set

The integer id of cell_set, as returned by the OMget_cell_set routine.

props

An integer representing a pointer to a float array in which the props array is returned. To access data array you will need to use ARRFoffset function described in the OM reference pages. Call ARRFfree() on this an integer representing a pointer when you are done using it.

On 64-bit platforms dims_ptr is actually an INTEGER*8.

size

An integer in which the size of the props array is returned.

mode

mode sets the access mode for the array. The choices are:

Mode	Value	Meaning
OM_GET_ARRAY_RD	0	The program reads the array, but does not write to it.
OM_GET_ARRAY_WR	1	The program writes to the array, completely replacing it.
OM_GET_ARRAY_RW	2	The program reads from and writes to the array.
OM_GET_ARRAY_RD_ COPY	3	The program requires a copy of the array for its own, private use (reading or writing).

number_of_elements

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

Returned value

A pointer to the array, or NULL if ARRalloc failed.

Examples

none.

Examples

none.

Files

v/fld.v.

See Also

none.