Fieldmap Commands


Functions

Boolean_t TecUtilFieldLayerIsActive (const char *LayerShowFlag)
  Indicates if the field layer of interest is active or not.
ArbParam_t TecUtilFieldStyleGetArbValue (EntIndex_t Zone, const char *S1, const char *S2, const char *S3)
  Queries a zone attribute.
double TecUtilFieldStyleGetDoubleValue (EntIndex_t Zone, const char *S1, const char *S2, const char *S3)
  Queries a zone attribute.
EntIndex_t TecUtilFieldMapGetCount (void)
  Returns the number of Field-maps.
Boolean_t TecUtilFieldMapGetActive (Set_pa *ActiveFieldMaps)
  Obtain the set of active Field-maps.
Boolean_t TecUtilFieldMapIsActive (EntIndex_t FieldMap)
  Determine if an Field-map is active.
FieldMapMode_e TecUtilFieldMapGetMode (EntIndex_t FieldMap)
  Returns the mode of a fieldmap.
Boolean_t TecUtilFieldMapGetZones (EntIndex_t FieldMap, Set_pa *Zones)
  Get the set of zones for the fieldmap.
EntIndex_t TecUtilFieldMapGetCandidateZone (EntIndex_t FieldMap)
  Returns the number of the candidate zone for the fieldmap.
Boolean_t TecUtilFieldMapIsRelevant (EntIndex_t FieldMap)
  Determines if the fieldmap is relevant for the current time step.
Boolean_t TecUtilFieldMapHasOrderedZones (EntIndex_t FieldMap)
  Determines if the fieldmap contains any ordered zones.
Boolean_t TecUtilFieldMapHasIJKOrderedZones (EntIndex_t FieldMap)
  Determines if the fieldmap contains any IJK ordered zones.
Boolean_t TecUtilFieldMapHasFEZones (EntIndex_t FieldMap)
  Determines if the fieldmap contains any FE zones.
Boolean_t TecUtilFieldMapHasVolumeZones (EntIndex_t FieldMap)
  Determines if the fieldmap contains any Volume zones.
Boolean_t TecUtilFieldMapHasSurfaceZones (EntIndex_t FieldMap)
  Determines if the fieldmap contains any Surface zones.
Boolean_t TecUtilFieldMapHasLinearZones (EntIndex_t FieldMap)
  Determines if the fieldmap contains any Linear zones.
SetValueReturnCode_e TecUtilFieldMapSetActive (Set_pa FieldMapSet, AssignOp_e AssignModifier)
  Assign which field maps are active.
SetValueReturnCode_e TecUtilFieldSetLayer (const char *LayerShowFlag, Boolean_t TurnOnFieldLayer)
 
SetValueReturnCode_e TecUtilFieldLayerSetIsActive (const char *LayerShowFlag, Boolean_t TurnOnFieldLayer)
  Instructs Tecplot to turn the specified layer on or off.

Function Documentation

Boolean_t TecUtilFieldLayerIsActive ( const char *  LayerShowFlag  ) 

Indicates if the field layer of interest is active or not.

Parameters:
LayerShowFlag The show flag for the field layer of interest. Possible values are: 
     SV_SHOWMESH
     SV_SHOWCONTOUR
     SV_SHOWVECTOR
     SV_SHOWSCATTER
     SV_SHOWSHADE
     SV_SHOWEDGE
     SV_USELIGHTINGEFFECT
     SV_USETRANSLUCENCY
Returns:
TRUE if the specified field layer is active.
Precondition:
Must have one or more frames.

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

Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilFieldLayerIsActive(LayerShowFlag)
    CHARACTER*(*) LayerShowFlag

Python Syntax:

  Results = TecUtil.FieldLayerIsActive(LayerShowFlag)

  Input:
                  LayerShowFlag        string
  Output:
    Results[0]    ReturnVal            boolean

Determine if the field's contour layer is on:

   if (TecUtilFieldLayerIsActive(SV_SHOWCONTOUR))
     {
       // do something with the field's contour level

     }

SetValueReturnCode_e TecUtilFieldLayerSetIsActive ( const char *  LayerShowFlag,
Boolean_t  TurnOnFieldLayer 
)

Instructs Tecplot to turn the specified layer on or off.

Parameters:
LayerShowFlag The show flag for the field layer of interest. Possible values are: 
     SV_SHOWMESH
     SV_SHOWCONTOUR
     SV_SHOWVECTOR
     SV_SHOWSCATTER
     SV_SHOWSHADE
     SV_SHOWEDGE
     SV_USELIGHTINGEFFECT
     SV_USETRANSLUCENCY
TurnOnFieldLayer If TRUE, Tecplot will turn on the layer, otherwise it will turn the layer off
Returns:
The setvalue return code (of type SetValueReturnCode_e).
Precondition:
LayerShowFlag Pointer must be a valid address and non-NULL.
Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilFieldLayerSetIsActive(
   &                   LayerShowFlag,
   &                   TurnOnFieldLayer)
    CHARACTER*(*)   LayerShowFlag
    INTEGER*4       TurnOnFieldLayer

Python Syntax:

  Results = TecUtil.FieldLayerSetIsActive(LayerShowFlag, TurnOnFieldLayer)

  Input:
                  LayerShowFlag        string
                  TurnOnFieldLayer     boolean
  Output:
    Results[0]    ReturnVal            SetValueReturnCode_e  (defined in TecVals.py)

Turn on the field's contour layer:

   SetValueReturnCode_e SVRC;
   SVRC = TecUtilFieldLayerSetIsActive(SV_SHOWCONTOUR, TRUE);

Boolean_t TecUtilFieldMapGetActive ( Set_pa *  ActiveFieldMaps  ) 

Obtain the set of active Field-maps.

Since:
11.2-0-131
Parameters:
ActiveFieldMaps Receives the set of active Field-maps. You must call TecUtilSetDealloc() when you are through using the set. It must not be NULL.
Returns:
TRUE if successful.
Precondition:
Must have one or more frames.

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

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

Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilFieldMapGetActive(ActiveFieldMapsPtr)
    POINTER (ActiveFieldMapsPtr, ActiveFieldMaps)

Python Syntax:

  Results = TecUtil.FieldMapGetActive()

  Output:
    Results[0]    ReturnVal            boolean
    Results[1]    ActiveFieldMaps      sequence of ints

Get the set of active Line-maps:

   Set_pa s = NULL;
   if (TecUtiFieldMapGetActive(&s))
   {
    // maps are now in s
    TecUtilSetDealloc(&s);
   }

EntIndex_t TecUtilFieldMapGetCandidateZone ( EntIndex_t  FieldMap  ) 

Returns the number of the candidate zone for the fieldmap.

Returns:
Zone number.
Precondition:
Must have one or more frames.

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

Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilFieldMapGetCandidateZone(FieldMap)
    INTEGER*4 FieldMap

Python Syntax:

  Results = TecUtil.FieldMapGetCandidateZone(FieldMap)

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

EntIndex_t TecUtilFieldMapGetCount ( void   ) 

Returns the number of Field-maps.

Returns:
The number of Field-maps.
Precondition:
Must have one or more frames.

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

Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilFieldMapGetCount()

Python Syntax:

  Results = TecUtil.FieldMapGetCount()

  Output:
    Results[0]    ReturnVal            int

FieldMapMode_e TecUtilFieldMapGetMode ( EntIndex_t  FieldMap  ) 

Returns the mode of a fieldmap.

Returns:
The mode for a fieldmap.
Precondition:
Must have one or more frames.

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

Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilFieldMapGetMode(FieldMap)
    INTEGER*4 FieldMap

Python Syntax:

  Results = TecUtil.FieldMapGetMode(FieldMap)

  Input:
                  FieldMap             int
  Output:
    Results[0]    ReturnVal            FieldMapMode_e  (defined in TecVals.py)

Boolean_t TecUtilFieldMapGetZones ( EntIndex_t  FieldMap,
Set_pa *  Zones 
)

Get the set of zones for the fieldmap.

Since:
12.1.1.8018
Parameters:
FieldMap Indicates which field map to query.
Zones Receives the set of zones. You must free this pointer by calling TecUtilSetDealloc().
Returns:
TRUE if successful, FALSE otherwise
Precondition:
Must have one or more frames.

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

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

Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilFieldMapGetZones(FieldMap, ZonesPtr)
    INTEGER*4 FieldMap
    POINTER (ZonesPtr, Zones)

Python Syntax:

  Results = TecUtil.FieldMapGetZones(FieldMap)

  Input:
                  FieldMap             int
  Output:
    Results[0]    ReturnVal            boolean
    Results[1]    Zones                sequence of ints

Get the set of zones in field map 2:

   Set_pa set = NULL;
   if (TecUtilFieldMapGetZones(2, &set))
   {
    // do something with the set here
    TecUtilSetDealloc(&set);
   }

Boolean_t TecUtilFieldMapHasFEZones ( EntIndex_t  FieldMap  ) 

Determines if the fieldmap contains any FE zones.

Since:
11.2-0-161
Returns:
TRUE if the field map contains an FE zone. FALSE 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 TecUtilFieldMapHasFEZones(FieldMap)
    INTEGER*4 FieldMap

Python Syntax:

  Results = TecUtil.FieldMapHasFEZones(FieldMap)

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

Boolean_t TecUtilFieldMapHasIJKOrderedZones ( EntIndex_t  FieldMap  ) 

Determines if the fieldmap contains any IJK ordered zones.

Since:
11.2-0-161
Returns:
TRUE if the field map contains a zone that is IJK ordered. FALSE 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 TecUtilFieldMapHasIJKOrderedZones(FieldMap)
    INTEGER*4 FieldMap

Python Syntax:

  Results = TecUtil.FieldMapHasIJKOrderedZones(FieldMap)

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

Boolean_t TecUtilFieldMapHasLinearZones ( EntIndex_t  FieldMap  ) 

Determines if the fieldmap contains any Linear zones.

Since:
11.2-0-161
Returns:
TRUE if the field map contains a linear zone. FALSE 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 TecUtilFieldMapHasLinearZones(FieldMap)
    INTEGER*4 FieldMap

Python Syntax:

  Results = TecUtil.FieldMapHasLinearZones(FieldMap)

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

Boolean_t TecUtilFieldMapHasOrderedZones ( EntIndex_t  FieldMap  ) 

Determines if the fieldmap contains any ordered zones.

Since:
11.2-0-161
Returns:
TRUE if the field map contains a zone that is ordered. FALSE 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 TecUtilFieldMapHasOrderedZones(FieldMap)
    INTEGER*4 FieldMap

Python Syntax:

  Results = TecUtil.FieldMapHasOrderedZones(FieldMap)

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

Boolean_t TecUtilFieldMapHasSurfaceZones ( EntIndex_t  FieldMap  ) 

Determines if the fieldmap contains any Surface zones.

Since:
11.2-0-161
Returns:
TRUE if the field map contains a surface zone. FALSE 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 TecUtilFieldMapHasSurfaceZones(FieldMap)
    INTEGER*4 FieldMap

Python Syntax:

  Results = TecUtil.FieldMapHasSurfaceZones(FieldMap)

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

Boolean_t TecUtilFieldMapHasVolumeZones ( EntIndex_t  FieldMap  ) 

Determines if the fieldmap contains any Volume zones.

Since:
11.2-0-161
Returns:
TRUE if the field map contains a volume zone. FALSE 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 TecUtilFieldMapHasVolumeZones(FieldMap)
    INTEGER*4 FieldMap

Python Syntax:

  Results = TecUtil.FieldMapHasVolumeZones(FieldMap)

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

Boolean_t TecUtilFieldMapIsActive ( EntIndex_t  FieldMap  ) 

Determine if an Field-map is active.

Since:
11.2-0-131
Parameters:
FieldMap number of the field map.
Returns:
Returns TRUE if the Line-map is active, FALSE 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 TecUtilFieldMapIsActive(FieldMap)
    INTEGER*4 FieldMap

Python Syntax:

  Results = TecUtil.FieldMapIsActive(FieldMap)

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

Boolean_t TecUtilFieldMapIsRelevant ( EntIndex_t  FieldMap  ) 

Determines if the fieldmap is relevant for the current time step.

Returns:
TRUE if the field map is relevant. FALSE 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 TecUtilFieldMapIsRelevant(FieldMap)
    INTEGER*4 FieldMap

Python Syntax:

  Results = TecUtil.FieldMapIsRelevant(FieldMap)

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

SetValueReturnCode_e TecUtilFieldMapSetActive ( Set_pa  FieldMapSet,
AssignOp_e  AssignModifier 
)

Assign which field maps are active.

Parameters:
FieldMapSet Set of field maps used to change the set of active field maps. The way in which the active field maps are changed is based on the AssignModifier. Must not be NULL.
AssignModifier The possible values are: AssignOp_Equals, AssignOp_PlusEquals, AssignOp_MinusEquals
Returns:
The setvalue return code (of type SetValueReturnCode_e).
Precondition:
FieldMapSet Pointer must be a valid address or NULL.
Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilFieldMapSetActive(
   &                   FieldMapSetPtr,
   &                   AssignModifier)
    POINTER         (FieldMapSetPtr, FieldMapSet)
    INTEGER*4       AssignModifier

Python Syntax:

  Results = TecUtil.FieldMapSetActive(FieldMapSet, AssignModifier)

  Input:
                  FieldMapSet          sequence of ints
                  AssignModifier       AssignOp_e  (defined in TecVals.py)
  Output:
    Results[0]    ReturnVal            SetValueReturnCode_e  (defined in TecVals.py)

Activate field map 3:

   Set_pa FieldMapSet = TecUtilSetAlloc(TRUE);
   TecUtilSetAddMember(FieldMapSet, 3,TRUE);
   TecUtilFieldMapSetActive(FieldMapSet, AssignOp_PlusEquals);
   TecUtilSetDealloc(&FieldMapSet);

SetValueReturnCode_e TecUtilFieldSetLayer ( const char *  LayerShowFlag,
Boolean_t  TurnOnFieldLayer 
)

Deprecated:
Please use TecUtilFieldLayerSetIsActive() instead.

Python Syntax:

  Results = TecUtil.FieldSetLayer(LayerShowFlag, TurnOnFieldLayer)

  Input:
                  LayerShowFlag        string
                  TurnOnFieldLayer     boolean
  Output:
    Results[0]    ReturnVal            SetValueReturnCode_e  (defined in TecVals.py)

ArbParam_t TecUtilFieldStyleGetArbValue ( EntIndex_t  Zone,
const char *  S1,
const char *  S2,
const char *  S3 
)

Queries a zone attribute.

You can use this function to query any plot attribute that is not a floating point value. To query a floating point plot attribute, use TecUtilFieldStyleGetDoubleValue().

Returns:
The queried attribute. This must be cast to the appropriate type.
Parameters:
Zone Zone number to query
S1 First parameter that defines the attribute to query. The parameters follow the same order that you would use when constructing a set value macro command. If a parameter is not used, then it must be NULL. If you are not sure of the possible values for an enumerated type, you can find the definitions in the Include/GLOBAL.h directory, below the Tecplot home directory. These parameters are actually strings, but you can use the supplied SV_ constants from the SV.h include file. Using the SV_ constants will help prevent misspellings and other errors.
S2 Second parameter that defines the attribute to query. See S1.
S3 Third parameter that defines the attribute to query. See S1.
Precondition:
Must have one or more frames.

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

Fortran Syntax:
    SUBROUTINE TecUtilFieldStyleGetArbValue(
   &           Zone,
   &           S1,
   &           S2,
   &           S3,
   &           ResultPtr)
    INTEGER*4       Zone
    CHARACTER*(*)   S1
    CHARACTER*(*)   S2
    CHARACTER*(*)   S3
    POINTER         (ResultPtr, Result)

Python Syntax:

    This function is not supported in Python.

Query the mesh color for zone 2.

   {
     // Equivalent macro command to set the color is:
     // $!FIELD [2] MESH {Color = ...}

     ColorIndex_t MeshColor;
     ArbParam_t   Result;

     TecUtilLockStart(AddOnID);

     MeshColor = (ColorIndex_t)
     TecUtilFieldStyleGetArbValue(2,SV_MESH,SV_COLOR,NULL);

     TecUtilLockFinish(AddOnID);
   }

double TecUtilFieldStyleGetDoubleValue ( EntIndex_t  Zone,
const char *  S1,
const char *  S2,
const char *  S3 
)

Queries a zone attribute.

You can use this function to query any plot attribute that is a floating point value. To query a non-floating point plot attribute, use TecUtilFieldStyleGetArbValue().

Parameters:
Zone Zone number to query.
S1 First parameter used to define the attribute to query. The parameters follow the same order that you would use when constructing the $!FIELD macro command.
S2 Second parameter used to define the attribute to query. See S1.
S3 Third parameter used to define the attribute to query. See S1.
Returns:
The queried attribute.
Precondition:
Must have one or more frames.

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

Fortran Syntax:
    REAL*8 FUNCTION TecUtilFieldStyleGetDoubleValue(
   &                   Zone,
   &                   S1,
   &                   S2,
   &                   S3)
    INTEGER*4       Zone
    CHARACTER*(*)   S1
    CHARACTER*(*)   S2
    CHARACTER*(*)   S3

Python Syntax:

  Results = TecUtil.FieldStyleGetDoubleValue(Zone, S1, S2, S3)

  Input:
                  Zone                 int
                  S1                   string
                  S2                   string
                  S3                   string
  Output:
    Results[0]    ReturnVal            double

Query the mesh pattern length for for zone 2.

   {
     // Equivalent macro command to set the color is:
     //   $!FIELD [2] MESH {P  ATTERNLENGTH = ... }
     double  MeshPatternLength;

     TecUtilLockStart(AddOnID);

     MeshPatternLength = TecUtilFieldStyleGetDoubleValue(2,SV_MESH,
                                                         SV_PATTERNLENGTH,NULL);
     TecUtilLockFinish(AddOnID);
   }

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