Data Sharing


Functions

void TecUtilDataConnectShare (EntIndex_t SourceZone, EntIndex_t DestZone)
  Sets the properties of the connectivity so that it is shared between source and destination zones (using the source for values).
Boolean_t TecUtilDataConnectBranchShared (EntIndex_t Zone)
  Branch the connectivity information.
Boolean_t TecUtilDataConnectIsSharingOk (EntIndex_t SourceZone, EntIndex_t DestZone)
  Determine if it is ok to share the connectivity between zones.
Set_pa TecUtilConnectGetShareZoneSet (EntIndex_t Zone)
  Gets the set of zones that share the connectivity with the specified zone.
EntIndex_t TecUtilDataConnectGetShareCount (EntIndex_t Zone)
  Returns the share count for connectivity for the given zone.


Function Documentation

Set_pa TecUtilConnectGetShareZoneSet ( EntIndex_t  Zone  ) 

Gets the set of zones that share the connectivity with the specified zone.

If the specified zone's connectivity is shared then it is also a member of the resulting set otherwise an empty set is returned.

Parameters:
Zone Zone for which sharing information is desired.
Returns:
Allocated set of zones that share the connectivity with the specified zone.
Precondition:
Current frame must have a data set with at least one zone.
Fortran Syntax:
    SUBROUTINE TecUtilConnectGetShareZoneSet(
   &           Zone,
   &           ResultPtr)
    INTEGER*4       Zone
    POINTER         (ResultPtr, Result)

Python Syntax:

  Results = TecUtil.ConnectGetShareZoneSet(Zone)

  Input:
                  Zone                 int
  Output:
    Results[0]    ReturnVal            sequence of ints

Boolean_t TecUtilDataConnectBranchShared ( EntIndex_t  Zone  ) 

Branch the connectivity information.

Returns False if out of memory.

Parameters:
Zone Zone number where connectivity is to be branched.
Returns:
TRUE if connectivity is branched, FALSE if out of memory.
Precondition:
Must have one or more frames.

Current frame must have a data set with at least one zone.

Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilDataConnectBranchShared(Zone)
    INTEGER*4 Zone

Python Syntax:

  Results = TecUtil.DataConnectBranchShared(Zone)

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

EntIndex_t TecUtilDataConnectGetShareCount ( EntIndex_t  Zone  ) 

Returns the share count for connectivity for the given zone.

This is the number of times the connectivity is shared. 1 means not shared (shared once), 2 means two zones share it, etc.

Parameters:
Zone Zone number where connectivity is to be branched.
Returns:
Number of zones sharing connectivity.
Precondition:
Current frame must have a data set with at least one zone.
Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilDataConnectGetShareCount(Zone)
    INTEGER*4 Zone

Python Syntax:

  Results = TecUtil.DataConnectGetShareCount(Zone)

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

Boolean_t TecUtilDataConnectIsSharingOk ( EntIndex_t  SourceZone,
EntIndex_t  DestZone 
)

Determine if it is ok to share the connectivity between zones.

Parameters:
SourceZone The source zone (the zone where the values will be stored).
DestZone The destination zone (the zone acquiring the shared values).
Returns:
Returns TRUE if the specified connectivity sharing is allowed, FALSE if otherwise.
Precondition:
Must have one or more frames.

Current frame must have a data set with at least one zone.

Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilDataConnectIsSharingOk(
   &                   SourceZone,
   &                   DestZone)
    INTEGER*4       SourceZone
    INTEGER*4       DestZone

Python Syntax:

  Results = TecUtil.DataConnectIsSharingOk(SourceZone, DestZone)

  Input:
                  SourceZone           int
                  DestZone             int
  Output:
    Results[0]    ReturnVal            boolean

If sharing is ok for connectivity between zones 3 and 5 then share the connectivity.

See also:
TecUtilDataSetIsSharingAllowed() and TecUtilDataValueIsSharingOk().

void TecUtilDataConnectShare ( EntIndex_t  SourceZone,
EntIndex_t  DestZone 
)

Sets the properties of the connectivity so that it is shared between source and destination zones (using the source for values).

Both zones must have the same structure (both Ordered with the same I,J, and K values; or both are finite-elements with the same element type and same number of nodes). Both zones must also have the same local face neighbor mode.

Parameters:
SourceZone The zone number where the connectivity is based.
DestZone The zone number where the connectivity will be shared from the source zone.
Precondition:
Must have one or more frames.

Current frame must have a data set with at least one zone.

Fortran Syntax:
    SUBROUTINE TecUtilDataConnectShare(
   &           SourceZone,
   &           DestZone)
    INTEGER*4       SourceZone
    INTEGER*4       DestZone

Python Syntax:

  Results = TecUtil.DataConnectShare(SourceZone, DestZone)

  Input:
                  SourceZone           int
                  DestZone             int
  Output:
    Results[0]    ReturnVal            NONE

Set the connectivity in zone 3 to be shared with zone 2:


Generated on Tue Mar 12 02:24:41 2013 for Tecplot by  doxygen 1.5.5