cxPyrDictDefault - create default finite element pyramid dictionary
#include <cx/Pyramid.h>

cxPyramidDictionary * cxPyrDictDefault( long layer )
integer function cxPyrDictDefault( layer )
integer layer
Input layer or spatial dimension of the dictionary elements.
Returns a pointer to a pyramid dictionary structure for the specified level. Returns a NULL if its input is malformed or if an allocation error occurs. cxPyrDictDefault creates a default pyramid dictionary of standard finite elements for use with the compressed pyramid representation. In the compressed form, each pyramid stores elements, vertices, indices identifying the element types, and a dictionary of reference elements, but omits the internal faces and edges.

The default dictionary contains a subset of the finite elements point, line, triangle, quadrilateral, tetrahedron, pyramid, prism, wedge, and hexahedron, depending on the specified layer; the dictionary includes each element for which the spatial dimension is not greater than layer. The dictionary contains an array table of cxPyramid structures, one for each dictionary element. The elements are indexed by the enumerated constants cx_pyramid_dict_point, etc., derived from the elements' names. Each of the constituent structures is a fully populated pyramid with faces, edges, and vertices (as necessary depending on layer).

The dictionary is a reference-counted structure which is owned by the caller.

The user may augment a pyramid dictionary structure by incrementing the numEntries counter and adding a new pyramid to the table array.

There also exist other automatically generated interface routines for dealing with the cxPyramidDictionary structure. They have names beginning with cxPyramidDictionary and are documented separately. See also the IRIS Explorer Module Writer's Guide section on User Defined Types.

cxPyramid(3E), cxPyrDictLookup(3E), cxPyramidDictionaryDup(3E), cxDataRefDec(3E), cxDataRefInc(3E).
Last modified: Mon Nov 6 16:33:44 GMT 2000
[ Documentation Home ]
© The Numerical Algorithms Group Ltd, Oxford UK. 1999