Face Neighbors

Functions
FaceNeighbor_pa	TecUtilDataFaceNbrGetRef (EntIndex_t Zone)
FaceNeighborMode_e	TecUtilDataFaceNbrGetModeByRef (FaceNeighbor_pa FaceNeighbor)
	Returns the FaceNeigborMode_e value for the referenced face neighbor.
LgIndex_t	TecUtilDataFaceNbrGetNumNByRef (FaceNeighbor_pa FaceNeighbor, LgIndex_t Element, LgIndex_t Face)
	Gets the number of face neighbors for the elements's face.
void	TecUtilDataFaceNbrGetNbrByRef (FaceNeighbor_pa FaceNeighbor, LgIndex_t Element, LgIndex_t Face, LgIndex_t NeighborNumber, LgIndex_t *NeighborElem, EntIndex_t *NeighborZone)
	Get the cell index of the element the is a neighbor of the specified Element and Face.
Boolean_t	TecUtilDataFaceNbrBeginAssignX (ArgList_pa ArgList)
Boolean_t	TecUtilDataFaceNbrBeginAssign (EntIndex_t Zone)
Boolean_t	TecUtilDataFaceNbrAssign (LgIndex_t Element, LgIndex_t Face, Boolean_t NeighborsCompletelyObscure, LgIndex_t NumNeighbors, LgIndex_t *NeighborElems, EntIndex_t *NeighborZones)
void	TecUtilDataFaceNbrArrayAssign (LgIndex_t DestOffset, LgIndex_t DestCount, LgIndex_t *NeighborElems)
Boolean_t	TecUtilDataFaceNbrEndAssign (void)

---

Function Documentation

void TecUtilDataFaceNbrArrayAssign	(	LgIndex_t	DestOffset,
		LgIndex_t	DestCount,
		LgIndex_t *	NeighborElems
	)

Deprecated:

Use TecUtilDataFaceNbrAssignArrayByRef() instead.

Python Syntax:

  Results = TecUtil.DataFaceNbrArrayAssign(DestOffset, DestCount, NeighborElems)

  Input:
                  DestOffset           int
                  DestCount            int
                  NeighborElems        list of ints
  Output:
    Results[0]    ReturnVal            NONE

Boolean_t TecUtilDataFaceNbrAssign	(	LgIndex_t	Element,
		LgIndex_t	Face,
		Boolean_t	NeighborsCompletelyObscure,
		LgIndex_t	NumNeighbors,
		LgIndex_t *	NeighborElems,
		EntIndex_t *	NeighborZones
	)

Deprecated:

Use TecUtilDataFaceNbrAssignByRef() instead.

Python Syntax:

  Results = TecUtil.DataFaceNbrAssign(Element, Face, NeighborsCompletelyObscure, NumNeighbors, NeighborElems, NeighborZones)

  Input:
                  Element              int
                  Face                 int
                  NeighborsCompletelyObscure boolean
                  NumNeighbors         int
                  NeighborElems        list of ints
                  NeighborZones        list of ints
  Output:
    Results[0]    ReturnVal            boolean

Boolean_t TecUtilDataFaceNbrBeginAssign

(

EntIndex_t

Zone

)

Deprecated:

Python Syntax:

  Results = TecUtil.DataFaceNbrBeginAssign(Zone)

  Input:
                  Zone                 int
  Output:
    Results[0]    ReturnVal            boolean

Boolean_t TecUtilDataFaceNbrBeginAssignX

(

ArgList_pa

ArgList

)

Deprecated:

Python Syntax:

  Results = TecUtil.DataFaceNbrBeginAssignX(ArgList)

  Input:
                  ArgList              dictionary
  Output:
    Results[0]    ReturnVal            boolean

Boolean_t TecUtilDataFaceNbrEndAssign

(

void

)

Deprecated:

Use TecUtilDataFaceNbrCustomLOD() instead.

Python Syntax:

  Results = TecUtil.DataFaceNbrEndAssign()

  Output:
    Results[0]    ReturnVal            boolean

FaceNeighborMode_e TecUtilDataFaceNbrGetModeByRef

(

FaceNeighbor_pa

FaceNeighbor

)

Returns the FaceNeigborMode_e value for the referenced face neighbor.

This function is Thread Safe.

Parameters:

FaceNeighbor

The face neighbor handle to the specified zone in the data set attached to the current frame

Returns:

Mode of the face neighbor.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilDataFaceNbrGetModeByRef(FaceNeighborPtr)
    POINTER (FaceNeighborPtr, FaceNeighbor)

Python Syntax:

  Results = TecUtil.DataFaceNbrGetModeByRef(FaceNeighbor)

  Input:
                  FaceNeighbor         opaque pointer
  Output:
    Results[0]    ReturnVal            FaceNeighborMode_e  (defined in TecVals.py)

void TecUtilDataFaceNbrGetNbrByRef	(	FaceNeighbor_pa	FaceNeighbor,
		LgIndex_t	Element,
		LgIndex_t	Face,
		LgIndex_t	NeighborNumber,
		LgIndex_t *	NeighborElem,
		EntIndex_t *	NeighborZone
	)

Get the cell index of the element the is a neighbor of the specified Element and Face.

To use this function you must have already obtained a handle to face neighbors. This function is Thread Safe.

Parameters:

	FaceNeighbor	Handle to the face neighbors. Use TecUtilDataFaceNbrGetReadableRef() to get handles to the face neighbors.
	Element	The element number (starts at one).
	Face	The face number of the element. Different element types have different number of faces. Use TecUtilZoneGetType() to get the element type for a particular zone. Face numbers start at one. ZoneType_FETriangle: has three faces. ZoneType_FEQuad has four faces. ZoneType_FETetra has four faces. ZoneType_FEBrick has six faces. Please look for "Face Neighbors" in the Tecplot User's Manual for a description of how nodes and faces map to each other.
	NeighborNumber	Specify which neighbor to retrieve. Use TecUtilDataFaceNbrGetNumNByRef() to get the number of neighbors
	NeighborElem	Pointer that gives the value of the neighboring element number
	NeighborZone	Pointer that gives the value of the neighboring zone number

Precondition:

NeighborElem Pointer must be a valid address and non-NULL.

NeighborZone Pointer must be a valid address and non-NULL.

Fortran Syntax:

    SUBROUTINE TecUtilDataFaceNbrGetNbrByRef(
   &           FaceNeighborPtr,
   &           Element,
   &           Face,
   &           NeighborNumber,
   &           NeighborElem,
   &           NeighborZone)
    POINTER         (FaceNeighborPtr, FaceNeighbor)
    INTEGER*4       Element
    INTEGER*4       Face
    INTEGER*4       NeighborNumber
    INTEGER*4       NeighborElem
    INTEGER*4       NeighborZone

Python Syntax:

  Results = TecUtil.DataFaceNbrGetNbrByRef(FaceNeighbor, Element, Face, NeighborNumber)

  Input:
                  FaceNeighbor         opaque pointer
                  Element              int
                  Face                 int
                  NeighborNumber       int
  Output:
    Results[0]    NeighborElem         int
    Results[1]    NeighborZone         int

Get the cell index of the cell next to face 5 of element 23 in zone 2. It is assumed that zone 2 is of type ZoneType_FEBrick.

   FaceNeighbor_pa FNPtr = TecUtilDataFaceNbrGetReadableRef(2);
   if (FNPtr != NULL)
     {
       LgIndex_t  NeighborElem;
       EntIndex_t NeighborZone;
       TecUtilDataFaceNbrGetNbrByRef(FNPtr, 23, 5, 1,
                                     &NeighborElem,
                                     &NeighborZone);

       // Do something with NeighborElem and NeighborZone.
    }

LgIndex_t TecUtilDataFaceNbrGetNumNByRef	(	FaceNeighbor_pa	FaceNeighbor,
		LgIndex_t	Element,
		LgIndex_t	Face
	)

Gets the number of face neighbors for the elements's face.

This function is Thread Safe.

Parameters:

	FaceNeighbor	Handle to the face neighbors. Use TecUtilDataFaceNbrGetReadableRef() to get handles to the face neighbors.
	Element	The element number (starts at one)
	Face	The face number of the element. Different element types have different number of faces. Use TecUtilZoneGetType() to get the element type for a particular zone. Face numbers start at one.ZoneType_FETriangle: Three faces.ZoneType_FEQuad: Four faces.ZoneType_FETetra: Four faces.ZoneType_FEBrick: Six faces

Returns:

Number of neighbors for the element's face.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilDataFaceNbrGetNumNByRef(
   &                   FaceNeighborPtr,
   &                   Element,
   &                   Face)
    POINTER         (FaceNeighborPtr, FaceNeighbor)
    INTEGER*4       Element
    INTEGER*4       Face

Python Syntax:

  Results = TecUtil.DataFaceNbrGetNumNByRef(FaceNeighbor, Element, Face)

  Input:
                  FaceNeighbor         opaque pointer
                  Element              int
                  Face                 int
  Output:
    Results[0]    ReturnVal            int

Get the number of neighbors for face 5 of element 23 of zone 2. It is assumed that zone 2 is of type ZoneType_FEBrick.

   LgIndex_t NumNeighbors;
   FaceNeighbor_pa FNbr;
   FNbr = TecUtilDataFaceNbrGetReadableRef(2);
   NumNeighbors = TecUtilDataFaceNbrGetNumNByRef(FNbr, 23, 5);

FaceNeighbor_pa TecUtilDataFaceNbrGetRef

(

EntIndex_t

Zone

)

Deprecated:

Please use TecUtilDataFaceNbrGetReadableRef() instead.

Python Syntax:

  Results = TecUtil.DataFaceNbrGetRef(Zone)

  Input:
                  Zone                 int
  Output:
    Results[0]    ReturnVal            opaque pointer