NAME

cxPyrLayerSkip - returns a cxConnection structure relating two non-adjacent pyramid layers

C SPECIFICATION

#include <cx/Pyramid.h>

cxConnection *cxPyrLayerSkip(cxPyramid *pyr,
 int src, int dst, int flag)

FORTRAN SPECIFICATION

integer function cxPyrLayerSkip(pyr,src,dst,flag)
integer pyr
integer src
integer dst
integer flag

PARAMETERS

pyr: Input pyramid data structure.
src: Input index of the source layer.
dst: Input index of the destination layer.
flag: Input Boolean indicating the action to take when src equals dst.

FUNCTION RETURN VALUE

The return value for this function is a pointer to a cxConnection structure that relates elements of two non-adjacent layers.

DESCRIPTION

cxPyrLayerSkip returns a cxConnection structure that relates the elements of layer src to the connections of layer dst. Equivalently, the returned cxConnection structure relates the elements of layer src to the elements of layer dst - 1, or to the base lattice, if dst is zero. cxPyrLayerSkip is useful for extracting from a fully populated pyramid a reduced structure that skips over unnecessary, intermediate layers. However, this does not change the restriction that all pyramids are expected to have fully formed intermediate layers. Thus cxPyrLayerSkip is only used when manipulating a pyramid within a module. The following C code example produces the connections from 3-D elements to 0-D nodes in a finite element pyramid:

	conn = cxPyrLayerSkip( pyr, 2, 0, 1 );

If src and dst are equal (and if flag is zero), the returned value is a copy of

	pyr->layer[src].relation.