FLDget_coord_extent, FLDset_coord

FLDget_coord_extent, FLDset_coord_extent

Synopsis

get/set the min_vec and max_vec coordinate extents in a Grid

int FLDget_coord_extent (
OMobj_id field,
float *min_extent,
float *max_extent);

int FLDset_coord_extent (
OMobj_id field,
float *min_extent,
float *max_extent,
int nspace);

Description

These routines get and set the min_vec and max_vec coordinate extents in a Grid.

By default, the min_vec and max_vec values are defined as functions:

float min_vec[veclen] = min_array(values, null_flag, null_value);
float max_vec[veclen] = max_array (values, null_flag, null_value);

Normally, there is no need to ever actively set these values.

FLDget_coord_extent returns the values of these functions. If the data in the values array changes, the value of the function automatically changes.

FLDset_coord_extent replaces the values produced by the function with the values you want to appear.

Parameters

OMobj_id field

The OMobj_id of a field that contains a Grid subobject.

float *min_extent
float *max_extent

In FLDget_coord_extent, addresses of arrays of type float into which the min_vec and max_vec for each nspace are copied.

In FLDset_coord_extent, addresses of arrays of type float from which the min_vec and max_vec for each nspace are copied into the field.

There must be room for nspace floats in each array.

nspace

FLDset_coord_extent only. An integer that specifies how many of the extents (veclen--just X, just X and Y, or X, Y, Z) you want to set or get with this call.

Examples

modules/cut_gen.c
modules/cut_pyr.c
modules/scat_tet.c

Files

v/fld.v.