Function
Returns the neighbors Array of a Field.
Syntax
#include <dx/dx.h>
Array DXNeighbors(Field f)
Functional Details
For a Field with irregular connections, returns the "neighbors" component of Field f. If it does not exist, it is computed and added to the Field before returning. Neighbors are not computed for connections with element type "lines."
For connections with element type "cubes", neighbors may be generated differently if the field has the attribute "neighbors hint" set to "degenerate cubes". This will cause the neighbors to be generated such that more internal cancelation of faces take place if cubes have been decomposed into other shapes such as pyramids and tetrahedra. It may cause triangles to be a neighbor to a quad.
For a Field with regular connections, returns NULL without setting the error code because neighbors in a regular grid can be implicitly determined without using additional memory. DXQueryGridConnections can be used to determine if the connections are regular or irregular.
The "neighbors" Array is used to indicate which connection elements share faces. For additional details on neighbors, see Chapter 3. "Understanding the Data Model" in IBM Visualization Data Explorer User's Guide.
Return Value
Returns the "neighbors" Array or returns NULL and sets an error code (unless the Field has regular or "line" connections., in which case no error code is set.
See Also