Data Files (Tecplot Format)


Functions

Boolean_t TecUtilReadDataSet (ReadDataOption_e ReadDataOption, Boolean_t ResetStyle, StringList_pa FileNamesOrInstructions, const char *DataSetReader, PlotType_e InitialPlotType, Boolean_t IncludeText, Boolean_t IncludeGeom, Boolean_t IncludeCustomLabels, Boolean_t IncludeData, Boolean_t CollapseZonesAndVars, Set_pa ZonesToRead, VarLoadMode_e VarLoadMode, Set_pa VarPositionList, StringList_pa VarNameList, LgIndex_t ISkip, LgIndex_t JSkip, LgIndex_t KSkip)
  Read one or more data files into Tecplot to form a new data set in the current frame.
Boolean_t TecUtilDataSetWriteX (ArgList_pa ArgList)
  Write the specified components of the current frame's data set to a file.
Boolean_t TecUtilWriteDataSet (const char *FName, Boolean_t IncludeText, Boolean_t IncludeGeom, Boolean_t IncludeCustomLabels, Boolean_t IncludeData, Set_pa ZonesToWrite, Set_pa VarsToWrite, Boolean_t WriteBinary, Boolean_t UsePointFormat, SmInteger_t AsciiPrecision)
  Write the data set attached to the current frame to a file.
void TecUtilTecForeign (LgIndex_t *OutputForeignByteOrder)
  Sets the byte ordering request for subsequent calls to TecUtilTecIni().
LgIndex_t TecUtilTecIni (const char *Title, const char *Variables, const char *FName, const char *ScratchDir, LgIndex_t *Debug, LgIndex_t *VIsDouble)
  Initializes the process of writing a binary data file.
LgIndex_t TecUtilTecIniX (ArgList_pa ArgList)
  Initializes the process of writing a binary data file.
LgIndex_t TecUtilTecZne (const char *ZoneTitle, LgIndex_t *IMx, LgIndex_t *JMx, LgIndex_t *KMx, const char *ZFormat, const char *DupList)
  Writes header information about the next zone to be added to the data file.
LgIndex_t TecUtilTecZneX (ArgList_pa ArgList)
  Writes the zone to the data file.
LgIndex_t TecUtilTecDat (LgIndex_t *N, void *FieldData_Array, LgIndex_t *IsDouble)
  Writes an array of data to the data file.
LgIndex_t TecUtilTecNod (LgIndex_t *NData_Array)
  Writes an array of node data to the binary data file.
LgIndex_t TecUtilTecNode (LgIndex_t *N, LgIndex_t *NData_Array)
  Writes an array of node data to the binary data file.
LgIndex_t TecUtilTecEnd (void)
  Must be called to close out the current data file.
LgIndex_t TecUtilTecLab (const char *S)
  Write a set of custom labels to the data file.
LgIndex_t TecUtilTecUsr (const char *S)
  Add a user-defined record, in the form of a character string, to the Tecplot data file.
LgIndex_t TecUtilTecFil (LgIndex_t *F)
  Switch output context to a different file.
LgIndex_t TecUtilTecTxt (double *XPos, double *YPos, LgIndex_t *PosCoordMode, LgIndex_t *AttachToZone, LgIndex_t *Zone, LgIndex_t *Font, LgIndex_t *FontHeightUnits, double *FontHeight, LgIndex_t *BoxType, double *BoxMargin, double *BoxLineThickness, LgIndex_t *BoxColor, LgIndex_t *BoxFillColor, double *Angle, LgIndex_t *Anchor, double *LineSpacing, LgIndex_t *TextColor, LgIndex_t *Scope, const char *Text, const char *MacroFunctionCommand)
  Write a text label to a binary tecplot data file.
LgIndex_t TecUtilTecTxtX (ArgList_pa ArgList)
  Writes the text item to the data file.
LgIndex_t TecUtilTecGeo (double *XPos, double *YPos, double *ZPos, LgIndex_t *PosCoordMode, LgIndex_t *AttachToZone, LgIndex_t *Zone, LgIndex_t *Color, LgIndex_t *FillColor, LgIndex_t *IsFilled, LgIndex_t *GeomType, LgIndex_t *LinePattern, double *PatternLength, double *LineThickness, LgIndex_t *NumEllipsePts, LgIndex_t *ArrowheadStyle, LgIndex_t *ArrowheadAttachment, double *ArrowheadSize, double *ArrowheadAngle, LgIndex_t *Scope, LgIndex_t *NumSegments, LgIndex_t *NumSegPts, float *XGeomData, float *YGeomData, float *ZGeomData, const char *MacroFunctionCommand)
  Write a geometry to a binary tecplot datafile.
LgIndex_t TecUtilTecGeoX (ArgList_pa ArgList)
  Writes the geometry item to the data file.
LgIndex_t TecUtilTecAux (char *Name, char *Value)
  Writes the name/value data set auxiliary data pair to the data file.
LgIndex_t TecUtilTecZAux (char *Name, char *Value)
  Writes the name/value zone auxiliary data pair to the data file.
LgIndex_t TecUtilTecVAux (LgIndex_t *Var, char *Name, char *Value)
  Writes the name/value variable auxiliary data pair to the data file.
LgIndex_t TecUtilTecFace (LgIndex_t *FaceConnections)
  Writes the face neighbor connections to the data file.
LgIndex_t TecUtilTecPoly (LgIndex_t *FaceNodeCounts, LgIndex_t *FaceNodes, LgIndex_t *FaceLeftElems, LgIndex_t *FaceRightElems, LgIndex_t *FaceBndryConnectionCounts, LgIndex_t *FaceBndryConnectionElems, SmInteger_t *FaceBndryConnectionZones)
 

Function Documentation

Boolean_t TecUtilDataSetWriteX ( ArgList_pa  ArgList  ) 

Write the specified components of the current frame's data set to a file.

Parameters:
ArgList Set of Arglist entries. This is built using calls to TecUtilArgListAppendXXXX functions.

Arglist Values

SV_FNAME
Type: char *
Arg Function: TecUtilArgListAppendString()
Required: Yes
Notes: Name of the data file to write.

SV_INCLUDETEXT
Type: Boolean_t
Arg Function: TecUtilArgListAppendInt()
Default: TRUE
Required: No
Notes: Set to TRUE to write any text, geometries, or custom labels to the data files.

SV_INCLUDEGEOM
Type: Boolean_t
Arg Function: TecUtilArgListAppendInt()
Default: TRUE
Required: No

SV_INCLUDEDATA
Type: Boolean_t
Arg Function: TecUtilArgListAppendInt()
Default: TRUE
Required: No
Notes: Set to TRUE to write the data to the data files. Set to FALSE to only write text and geometries, depending on SV_INCLUDETEXT and SV_INCLUDEGEOM

SV_INCLUDEDATASHARELINKAGE
Type: Boolean_t
Arg Function: TecUtilArgListAppendInt()
Default: TRUE
Required: No
Notes: Set to TRUE to conserve space and write the variable and connectivity linkage to the data file wherever possible. Set to FALSE to write all the data to the data file and lose the variable and connectivity sharing linkage for future dataset reads of the file.

SV_INCLUDEAUTOGENFACENEIGHBORS
Type: Boolean_t
Arg Function: TecUtilArgListAppendInt()
Default: FALSE
Required: No
Notes: Set to TRUE to save the face neighbor connectivity to the data file. This may produce very large data files.

SV_USEPOINTFORMAT
Type: Boolean_t
Arg Function: TecUtilArgListAppendInt()
Default: FALSE
Required: No
Notes: Set to TRUE to write the data file in point format and FALSE for block format. For binary files, only block format is supported, and this parameter will be ignored.

SV_BINARY
Type: Boolean_t
Arg Function: TecUtilArgListAppendInt()
Default: TRUE
Required: No
Notes: Set to TRUE to write the data in binary format and FALSE for ASCII.

SV_ASSOCIATELAYOUTWITHDATAFILE
Type: Boolean_t
Arg Function: TecUtilArgListAppendInt()
Default: TRUE
Required: No
Notes: Set to TRUE to associate this data file with the current layout. Set to FALSE to write the datafile without modifying Tecplot's current data file to layout association. If SV_TECPLOTVERSIONTOWRITE is set to anything other than BinaryFileVersion_Current, this association is not possible, and this parameter will be ignored.

SV_ZONELIST
Type: Set_pa
Arg Function: TecUtilArgListAppendSet()
Default: NULL
Required: No
Notes: Set of zones to write to the data file. Use NULL to write all zones.

SV_VARLIST
Type: Set_pa
Arg Function: TecUtilArgListAppendSet()
Default: NULL
Required: No
Notes: Set of variables to write to the data file. Use NULL to write all variables.

SV_TECPLOTVERSIONTOWRITE
Type: BinaryFileVersion_e
Arg Function: TecUtilArgListAppendInt()
Default: BinaryFileVersion_Current
Required: No
Notes: Specifies the file version to write. This is only applicable to binary files; for ASCII files, the parameter is ignored. Note that some data may be excluded from the file if it cannot be supported in the specified version.


Returns:
TRUE if the input parameters are valid and the data was successfully written, FALSE otherwise.
Precondition:
ArgList Argument list must be valid.
Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilDataSetWriteX(ArgListPtr)
    POINTER (ArgListPtr, ArgList)

Python Syntax:

  Results = TecUtil.DataSetWriteX(ArgList)

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

Boolean_t TecUtilReadDataSet ( ReadDataOption_e  ReadDataOption,
Boolean_t  ResetStyle,
StringList_pa  FileNamesOrInstructions,
const char *  DataSetReader,
PlotType_e  InitialPlotType,
Boolean_t  IncludeText,
Boolean_t  IncludeGeom,
Boolean_t  IncludeCustomLabels,
Boolean_t  IncludeData,
Boolean_t  CollapseZonesAndVars,
Set_pa  ZonesToRead,
VarLoadMode_e  VarLoadMode,
Set_pa  VarPositionList,
StringList_pa  VarNameList,
LgIndex_t  ISkip,
LgIndex_t  JSkip,
LgIndex_t  KSkip 
)

Read one or more data files into Tecplot to form a new data set in the current frame.

Parameters:
ReadDataOption Determine how to handle the situation where a data set already exists in the current frame. The possible values are: ReadDataOption_NewData (Remove the data set from the current frame before loading the new data set), ReadDataOption_AppendData (Append the new data to the current data set), and ReadDataOption_ReplaceData (Replace the data set in the current frame and in all frames which share the data set with the new data).
ResetStyle TRUE if you want to reset the style of the current frame, FALSE if you want to keep the same style. Only used if ReadDataOption is ReadDataOption_NewData or ReadDataOption_ReplaceData.FileNamesOr
FileNamesOrInstructions A string list containing the file names to load or the instructions to send to the data set reader (converter or loader)
DataSetReader Name of the data set reader (converter or loader). To let Tecplot load the data, use "TECPLOT."
InitialPlotType Initial PlotType for the data. Only used if ResetStyle is TRUE. To have Tecplot determine the most appropriate frame mode for the data, use Frame_Empty. The possible values are: PlotType_Automatic: PlotType_Cartesian3D, PlotType_Cartesian2D, PlotType_XYLine, PlotType_PolarLine, and PlotType_Sketch. PlotType_Automatic instructs Tecplot to choose the best frame mode.
IncludeText Set to TRUE to load any text in the data files.
IncludeGeom Set to TRUE to load any geometries in the data files.
IncludeCustomLabels Set to TRUE to load any custom labels in the data files
IncludeData Set to TRUE to load the data from the data files. Set to FALSE to only load text, geometries and/or custom labels, depending on IncludeText, IncludeGeom, and IncludeCustomLabels
CollapseZonesAndVars Set to TRUE to renumber zones and variables if any are disabled. For more information on collapsing zones and variables, see Section 5.1.1.7, "Zone and Variable List Collapsing," in the Tecplot User's Manual
ZonesToRead Set of zones to load from the data files. Use NULL to load all zones
VarLoadMode Choose to load variables by name or by their position in the data file. See Section 5.1.1.6, "Variable Loading by Position," in the Tecplot User's Manual for more information about loading variables by name or by position. If ReadDataOption is ReadDataOption_AppendData, this must be same as the mode of the data set in the current frame. Use TecUtilDataSetGetVarLoadMode() to get this information. The possible values are: VarLoadMode_ByName and VarLoadMode_ByPosition.
VarPositionList Set of variables to load from the data files. Use NULL to load all variables. Ignored if VarLoadMode is VarLoadMode_ByName
VarNameList Set of variable names to load from the data files. Use NULL to load only variable names common to all data files. Must be NULL if VarLoadMode is VarLoadMode_ByPosition. When appending to the existing data set you must supply a new VarNameList where the new VarNameList is a superset of the existing one. A VarNameList that is a superset is one that contains all the variable names currently in use Tecplot. They must be in the same position. You can add new names either at the end of the list, or as aliases in the already established positions. Use a newline character to separate aliased names.If you do not create a VarNameList that is a superset then it is indeterminant which variable is in which position for the original data
ISkip Set to 1 to load every data point in the I-direction; 2 to load every other data point, and so forth.
JSkip Same as ISkip but for J-direction.
KSkip Same as ISkip but for K-direction.
Returns:
TRUE if the input parameters are valid and the data was successfully loaded, FALSE otherwise.
Precondition:
Must have one or more frames.

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

ZonesToRead Pointer must be a valid address or NULL.

VarPositionList Pointer must be a valid address or NULL.

Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilReadDataSet(
   &                   ReadDataOption,
   &                   ResetStyle,
   &                   FileNamesOrInstructionsPtr,
   &                   DataSetReader,
   &                   InitialPlotType,
   &                   IncludeText,
   &                   IncludeGeom,
   &                   IncludeCustomLabels,
   &                   IncludeData,
   &                   CollapseZonesAndVars,
   &                   ZonesToReadPtr,
   &                   VarLoadMode,
   &                   VarPositionListPtr,
   &                   VarNameListPtr,
   &                   ISkip,
   &                   JSkip,
   &                   KSkip)
    INTEGER*4       ReadDataOption
    INTEGER*4       ResetStyle
    POINTER         (FileNamesOrInstructionsPtr, FileNamesOrInstructions)
    CHARACTER*(*)   DataSetReader
    INTEGER*4       InitialPlotType
    INTEGER*4       IncludeText
    INTEGER*4       IncludeGeom
    INTEGER*4       IncludeCustomLabels
    INTEGER*4       IncludeData
    INTEGER*4       CollapseZonesAndVars
    POINTER         (ZonesToReadPtr, ZonesToRead)
    INTEGER*4       VarLoadMode
    POINTER         (VarPositionListPtr, VarPositionList)
    POINTER         (VarNameListPtr, VarNameList)
    INTEGER*4       ISkip
    INTEGER*4       JSkip
    INTEGER*4       KSkip

Python Syntax:

  Results = TecUtil.ReadDataSet(ReadDataOption, ResetStyle, FileNamesOrInstructions, DataSetReader, InitialPlotType, IncludeText, IncludeGeom, IncludeCustomLabels, IncludeData, CollapseZonesAndVars, ZonesToRead, VarLoadMode, VarPositionList, VarNameList, ISkip, JSkip, KSkip)

  Input:
                  ReadDataOption       ReadDataOption_e  (defined in TecVals.py)
                  ResetStyle           boolean
                  FileNamesOrInstructions sequence of strings
                  DataSetReader        string
                  InitialPlotType      PlotType_e  (defined in TecVals.py)
                  IncludeText          boolean
                  IncludeGeom          boolean
                  IncludeCustomLabels  boolean
                  IncludeData          boolean
                  CollapseZonesAndVars boolean
                  ZonesToRead          sequence of ints
                  VarLoadMode          VarLoadMode_e  (defined in TecVals.py)
                  VarPositionList      sequence of ints
                  VarNameList          sequence of strings
                  ISkip                int
                  JSkip                int
                  KSkip                int
  Output:
    Results[0]    ReturnVal            boolean

Good: Var names currently in Tecplot = "A" "B" "C" VarNameList is appended to read = "A" "B\nR" "C" "D"

Bad: Var names currently in Tecplot = "A" "B" "C" VarNameList is appended to read "A" "C" "B" "D"

In the good example the integrity of the original data is always maintained, that is, the new VarNameList works for the original data as well as the new data. Variable 2 can be either "B" or "R".

In the bad example, the new VarNameList states that variable 2 must contain "C" but "C" has already been assigned to variable 3 with the original data. Keep in mind that once variables are in Tecplot all style assignements are made based on variable position and not by name. Thus the variable positioning is important.

   StringList_pa FileNames, VarNames;
   FileNames = TecUtilStringListAlloc();
   TecUtilStringListAppendString(FileNames, "file1.plt");
   TecUtilStringListAppendString(FileNames, "file2.plt");
   VarNames  = TecUtilStringListAlloc();
   TecUtilStringListAppendString(VarNames,  "X");
   TecUtilStringListAppendString(VarNames,  "Y");
   TecUtilStringListAppendString(VarNames,  "P\nPress");
   IsOk = TecUtilReadDataSet(ReadDataOption_NewData,
                             TRUE,
                             FileNames,
                             "TECPLOT",
                             PlotType_Automatic,
                             TRUE, TRUE, TRUE, TRUE,
                             FALSE,
                             (Set_pa)NULL,
                             VarLoadMode_ByName,
                             (Set_pa)NULL,
                             VarNames,
                             1, 1, 1))
   TecUtilStringListDealloc(&FileNames);
   TecUtilStringListDealloc(&VarNames);

Read a data set consisting of file1.plt and file2.plt. Load the variables named "X", "Y", and either "P" or "Press."

   StringList_pa FileNames, VarNames;
   FileNames = TecUtilStringListAlloc();
   TecUtilStringListAppendString(FileNames, "file1.plt");
   TecUtilStringListAppendString(FileNames, "file2.plt");
   VarNames  = TecUtilStringListAlloc();
   TecUtilStringListAppendString(VarNames,  "X");
   TecUtilStringListAppendString(VarNames,  "Y");
   TecUtilStringListAppendString(VarNames,  "P\nPress");
   IsOk = TecUtilReadDataSet(ReadDataOption_NewData,
                             TRUE,
                             FileNames,
                             "TECPLOT",
                             PlotType_Automatic,
                             TRUE, TRUE, TRUE, TRUE,
                             FALSE,
                             (Set_pa)NULL,
                             VarLoadMode_ByName,
                             (Set_pa)NULL,
                             VarNames,
                             1, 1, 1))
   TecUtilStringListDealloc(&FileNames);
   TecUtilStringListDealloc(&VarNames);

LgIndex_t TecUtilTecAux ( char *  Name,
char *  Value 
)

Writes the name/value data set auxiliary data pair to the data file.

Parameters:
Name Name of the data set auxiliary item
Value The value associates with the named data set auxiliary data item
Returns:
0 if successful, -1 if unsuccessful.
Precondition:
Value Pointer must be a valid address and non-NULL.
Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilTecAux(
   &                   Name,
   &                   Value)
    CHARACTER*(*)   Name
    CHARACTER*(*)   Value

Python Syntax:

  Results = TecUtil.TecAux(Name, Value)

  Input:
                  Name                 string
                  Value                string
  Output:
    Results[0]    ReturnVal            int

LgIndex_t TecUtilTecDat ( LgIndex_t *  N,
void *  FieldData_Array,
LgIndex_t *  IsDouble 
)

Writes an array of data to the data file.

If the ZoneFormat specified in TecUtilTecZneX() or TecUtilTecZne() is BLOCK, the array must be dimensioned (IMax, JMax, KMax, NumVars) (FORTRAN syntax, where the first element moves the fastest).

If the ZoneFormat is POINT, the data must be dimensioned (NumVars, IMax, JMax, KMax).

If the ZoneFormat is FEBLOCK, then the data must be dimensioned (NumPts, NumVars).

If the ZoneFormat is FEPOINT, then the data must be dimensioned (NumVars,NumPts).

TecUtilTecDat() allows you to write your data in a piecemeal fashion in case it is not contained in one contiguous block in your program. Enough calls to TECDAT must be made that the correct number of values are written for each zone and that the aggregate order for the data is correct.

In the above summary, NumVars is based on the number of variable names supplied in a previous call to TecUtilTecIni() or TecUtilTecIniX().

Parameters:
N Handle to an integer value specifying number of values to write
FieldData_Array Array of single or double precision data values
IsDouble Handle to the integer flag stating whether the array Data is single (0) or double (1) precision.
Returns:
0 if successful, -1 if unsuccessful.
Precondition:
N Pointer must be a valid address and non-NULL.

VALID_REF(FieldData) Pointer must be a valid address and non-NULL.

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

Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilTecDat(
   &                   N,
   &                   FieldData_Array,
   &                   IsDouble)
    INTEGER*4       N
    POINTER         (FieldData_ArrayPtr, FieldData_Array)
    INTEGER*4       IsDouble

Python Syntax:

    This function is not supported in Python.

LgIndex_t TecUtilTecEnd ( void   ) 

Must be called to close out the current data file.

There must be a corresponding TecUtilTecEnd() for each TecUtilTecIni() or TecUtilTecIniX().

Returns:
0 if successful, -1 if unsuccessful.
Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilTecEnd()

Python Syntax:

  Results = TecUtil.TecEnd()

  Output:
    Results[0]    ReturnVal            int

LgIndex_t TecUtilTecFace ( LgIndex_t *  FaceConnections  ) 

Writes the face neighbor connections to the data file.

For polygonal and polyhedral zones, use TecUtilTecPoly().

Parameters:
FaceConnections Array of face connections dimensioned by the number of face neighbor connections (supplied in the call to TecUtilTecZneX()) multiplied by the number of values needed for each connection. See the ADK reference manual for details.
Returns:
0 if successful, -1 if unsuccessful.
Precondition:
FaceConnections Pointer must be a valid address and non-NULL.
Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilTecFace(FaceConnections)
    INTEGER*4 FaceConnections

Python Syntax:

  Results = TecUtil.TecFace(FaceConnections)

  Input:
                  FaceConnections      list of ints
  Output:
    Results[0]    ReturnVal            int

LgIndex_t TecUtilTecFil ( LgIndex_t *  F  ) 

Switch output context to a different file.

Each time TecUtilTecIni() or TecUtilTecIniX() iscalled, a new file "context" is switched to. This allows you to write multiple data files at the same time.

Parameters:
F Handle to integer specifying file number to switch to
Returns:
0 if successful, -1 if unsuccessful.
Precondition:
F Pointer must be a valid address and non-NULL.
Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilTecFil(F)
    INTEGER*4 F

Python Syntax:

    This function is not supported in Python.

void TecUtilTecForeign ( LgIndex_t *  OutputForeignByteOrder  ) 

Sets the byte ordering request for subsequent calls to TecUtilTecIni().

The byte ordering request will remain in effect until changed by another call to this function. Calling this function after a call to TecUtilTecIni() has no effect on any files opened by previous calls to TecUtilTecIni() and only effects future files created by TecUtilTecIni().

Since:
10.0-3-129
Parameters:
OutputForeignByteOrder Reference to a boolean value indicating if subsequent calls to TecUtilTecIni() should create files with foreign or native byte ordering.
Precondition:
OutputForeignByteOrder Pointer must be a valid address and non-NULL.
Fortran Syntax:
    SUBROUTINE TecUtilTecForeign(
   &                   OutputForeignByteOrder)
    INTEGER*4       OutputForeignByteOrder

Python Syntax:

    This function is not supported in Python.

LgIndex_t TecUtilTecGeo ( double *  XPos,
double *  YPos,
double *  ZPos,
LgIndex_t *  PosCoordMode,
LgIndex_t *  AttachToZone,
LgIndex_t *  Zone,
LgIndex_t *  Color,
LgIndex_t *  FillColor,
LgIndex_t *  IsFilled,
LgIndex_t *  GeomType,
LgIndex_t *  LinePattern,
double *  PatternLength,
double *  LineThickness,
LgIndex_t *  NumEllipsePts,
LgIndex_t *  ArrowheadStyle,
LgIndex_t *  ArrowheadAttachment,
double *  ArrowheadSize,
double *  ArrowheadAngle,
LgIndex_t *  Scope,
LgIndex_t *  NumSegments,
LgIndex_t *  NumSegPts,
float *  XGeomData,
float *  YGeomData,
float *  ZGeomData,
const char *  MacroFunctionCommand 
)

Write a geometry to a binary tecplot datafile.

This function mimicks the TecGeo function that is part of the TecIO library.

Parameters:
MacroFunctionCommand Macro command to execute when user cntrl-clicks on the geometry. Set to NULL to not use
XPos X-Anchor position of the geometry
YPos Y-Anchor position of the geometry
ZPos Z-Anchor position of the geometry
PosCoordMode Position coordinate mode of the geometry. Zero=Grid, 1=Frame, 6=Grid3D
AttachToZone Flag specifying whether or not to attach the geometry to a zone. Zero=Attach, one=Don't attach
Zone Zone to attach to
Color Color of the geometry. (0-63)
FillColor Fill Color of the geometry. (0-63)
IsFilled Flag specifying whether or not to fill the geometry. 1=Fill Zero=Don't fill
GeomType Type of geometry. Zero=2D line segments, 1=Rectangle, 2=Square, 3=Circle, 4=Ellipse, 5=3D line segments
LinePattern Line pattern. Zero=Solid, 1=Dashed, 2=DashDot, 3=Dotted, 4=LongDash, 5=DashDotDot
PatternLength Line Pattern Length in frame units (0 < L <= 100.0).
LineThickness Line thickness in frame units (0 < L <= 100.0)
NumEllipsePts Number of points to use to draw ellipses or circles
ArrowheadStyle Style of arrowhead. Zero=Plain, 1=Filled, 2=Hollow
ArrowheadAttachment How to attach the arrowhead(s). Zero=None, 1=Beginning, 2=End, 3=Both.
ArrowheadSize Size of the arrowhead in frame units
ArrowheadAngle Angle of the arrowhead in degrees
Scope Scope for the geometry. Zero=Global, 1=Local
NumSegments Number of polyline segments in the geometry
NumSegPts Array of the number of points in each polyline segment
XGeomData Array of X-values for the geometry
YGeomData Array of Y-values for the geometry
ZGeomData Array of Z-values for the geometry
Returns:
Returns 0 if successful, -1 if not.
Precondition:
XPos Pointer must be a valid address and non-NULL.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

MacroFunctionCommand Pointer must be a valid address or NULL.

Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilTecGeo(
   &                   XPos,
   &                   YPos,
   &                   ZPos,
   &                   PosCoordMode,
   &                   AttachToZone,
   &                   Zone,
   &                   Color,
   &                   FillColor,
   &                   IsFilled,
   &                   GeomType,
   &                   LinePattern,
   &                   PatternLength,
   &                   LineThickness,
   &                   NumEllipsePts,
   &                   ArrowheadStyle,
   &                   ArrowheadAttachment,
   &                   ArrowheadSize,
   &                   ArrowheadAngle,
   &                   Scope,
   &                   NumSegments,
   &                   NumSegPts,
   &                   XGeomData,
   &                   YGeomData,
   &                   ZGeomData,
   &                   MacroFunctionCommand)
    REAL*8          XPos
    REAL*8          YPos
    REAL*8          ZPos
    INTEGER*4       PosCoordMode
    INTEGER*4       AttachToZone
    INTEGER*4       Zone
    INTEGER*4       Color
    INTEGER*4       FillColor
    INTEGER*4       IsFilled
    INTEGER*4       GeomType
    INTEGER*4       LinePattern
    REAL*8          PatternLength
    REAL*8          LineThickness
    INTEGER*4       NumEllipsePts
    INTEGER*4       ArrowheadStyle
    INTEGER*4       ArrowheadAttachment
    REAL*8          ArrowheadSize
    REAL*8          ArrowheadAngle
    INTEGER*4       Scope
    INTEGER*4       NumSegments
    INTEGER*4       NumSegPts
    REAL*4(*)       XGeomData
    REAL*4(*)       YGeomData
    REAL*4(*)       ZGeomData
    CHARACTER*(*)   MacroFunctionCommand

Python Syntax:

    This function is not supported in Python.

LgIndex_t TecUtilTecGeoX ( ArgList_pa  ArgList  ) 

Writes the geometry item to the data file.

Parameters:
ArgList Set of Arglist entries. This is built using calls to TecUtilArgListAppendXXXX functions.

Arglist Values

SV_GEOMTYPE
Type: GeomType_e
Arg Function: TecUtilArgListAppendInt()
Required: Yes
Notes: Geometry type may have any of the following values: GeomType_LineSegs, GeomType_Rectangle, GeomType_Square, GeomType_Circle, GeomType_Ellipse, GeomType_LineSegs3D,

SV_NUMGEOSEGMENTS
Type: LgIndex_t
Arg Function: TecUtilArgListAppendInt()
Required: Yes
Notes: Only applies to a geometry of type GeomType_LineSegs and is the number of geometry line segments. The value must be greater than or equal to 1

SV_NUMSEGPTS
Type: LgIndex_t *
Arg Function: TecUtilArgListAppendArray()
Required: Yes
Notes: Only applies to a geometry of type GeomType_LineSegs and is an array dimensioned by the number of geometry segments where each member of the array holds the number of points defining each geometry segment

SV_ARROWHEADSTYLE
Type: ArrowheadStyle_e
Arg Function: TecUtilArgListAppendInt()
Default: ArrowheadStyle_Plain
Required: No
Notes: Only applies to a geometry of type GeomType_LineSegs and is the arrowhead style may have any of the following values: ArrowheadStyle_Plain, ArrowheadStyle_Filled, ArrowheadStyle_Hollow.

SV_ARROHEADATTACHMENT
Type: ArroheadAttachment_e
Arg Function: TecUtilArgListAppendInt()
Default: ArrowheadAttachment_None
Required: No
Notes: Only applies to a geometry of type GeomType_LineSegs and is the arrowhead attachment may have any of the following values: ArrowheadAttachment_None, ArrowheadAttachment_AtBeginning, ArrowheadAttachment_AtEnd, ArrowheadAttachment_AtBothEnds,

SV_ARROWHEADSIZE
Type: double
Arg Function: TecUtilArgListAppendDouble()
Default: 5.0
Required: No
Notes: Only applies to a geometry of type GeomType_LineSegs and is the arrowhead size if assigned. The value must be greater than or equal to zero and less than or equal to 50

SV_ARROWHEADANGLE
Type: double
Arg Function: TecUtilArgListAppendDouble()
Default: 12.0
Required: No
Notes: Only applies to a geometry of type GeomType_LineSegs and is the arrowhead angle must be greater than or equal to 1 and less than or equal to 90

SV_NUMELLIPSEPTS
Type: LgIndex_t
Arg Function: TecUtilArgListAppendInt()
Default: 72.0
Required: No
Notes: Only applies to a geometry of type GeomType_Ellipse and is the number of points used to define an ellipse. The value must be greater than or equal to 3 and less than or equal to 720

SV_XGEOMDATA
Type: float *
Arg Function: TecUtilArgListAppendArray()
Required: Yes
Notes: Floating point arrays containing the point data for the specific geometry

SV_YGEOMDATA
Type: float *
Arg Function: TecUtilArgListAppendArray()
Required: Yes

SV_ZGEOMDATA
Type: float *
Arg Function: TecUtilArgListAppendArray()
Required: Yes

SV_XPOS
Type: double
Arg Function: TecUtilArgListAppendDouble()
Default: 0.0
Required: No
Notes: Anchor position for the geometry

SV_YPOS
Type: double
Arg Function: TecUtilArgListAppendDouble()
Default: 0.0
Required: No

SV_ZPOS
Type: double
Arg Function: TecUtilArgListAppendDouble()
Default: 0.0
Required: No

SV_POSITIONCOORDSYS
Type: CoordSys_e
Arg Function: TecUtilArgListAppendInt()
Default: CoordSys_Grid
Required: No
Notes: Coordinate system to which the geometry belongs and may have any of the following values: CoordSys_Grid, CoordSys_Frame, CoordSys_Grid3D,

SV_ATTACHTOZONE
Type: Boolean_t
Arg Function: TecUtilArgListAppendInt()
Default: FALSE
Required: No
Notes: A value of TRUE indicates that the geometry is attached to the specified zone or map. A value of FALSE indicates that the geometry is not attached to a specific zone or map

SV_ZONE
Type: EntIndex_t
Arg Function: TecUtilArgListAppendInt()
Default: 1
Required: No
Notes: Zone or map number to which the geometry is attached

SV_COLOR
Type: ColorIndex_t
Arg Function: TecUtilArgListAppendInt()
Default: Black_C
Required: No
Notes: Line color for the geometry may be a value greater than or equal to zero

SV_FILLCOLOR
Type: ColorIndex_t
Arg Function: TecUtilArgListAppendInt()
Default: White_C
Required: No
Notes: Fill color for the geometry may be a value greater than or equal to zero

SV_ISFILLED
Type: Boolean_t
Arg Function: TecUtilArgListAppendInt()
Default: FALSE
Required: No
Notes: If applicable a value of TRUE indicates the geometry is filled.

SV_LINEPATTERN
Type: LinePattern_e
Arg Function: TecUtilArgListAppendInt()
Default: LinePattern_Solid
Required: No
Notes: Line pattern to use for the drawing the lines and may have any ofthe following values: LinePattern_Solid, LinePattern_Dashed, LinePattern_DashDot, LinePattern_Dotted, LinePattern_LongDash, LinePattern_DashDotDot.

SV_PATTERNLENGTH
Type: double
Arg Function: TecUtilArgListAppendDouble()
Default: 2.0
Required: No
Notes: Pattern length may be a value greater than or equal to zero and less than or equal to 100

SV_LINETHICKNESS
Type: double
Arg Function: TecUtilArgListAppendDouble()
Default: 0.1
Required: No
Notes: Line thickness may be a value greater than or equal to zero and less than or equal to 100

SV_SCOPE
Type: Scope_e
Arg Function: TecUtilArgListAppendInt()
Default: Scope_Local
Required: No
Notes: A geometry with local scope is displayed only in the frame in which it is created. If the geometry is defined as having global scope it will appear in all "like" frames, that is, those frames using the same data set as the one in which the geometry was created. Scope may be either Scope_Global or Scope_Local.

SV_CLIPPING
Type: Clipping_e
Arg Function: TecUtilArgListAppendInt()
Default: Clipping_ClipToViewport
Required: No
Notes: Clipping applied to the geometry may be either Clipping_ClipToViewport or Clipping_ClipToFrame.

SV_MACROFUNCTIONCOMMAND
Type: char *
Arg Function: TecUtilArgListAppendString()
Default: NULL
Required: No
Notes: Macro function command associated with the geometry


Returns:
0 if successful, -1 if unsuccessful.
Precondition:
ArgList Argument list must be valid.
Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilTecGeoX(ArgListPtr)
    POINTER (ArgListPtr, ArgList)

Python Syntax:

  Results = TecUtil.TecGeoX(ArgList)

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

LgIndex_t TecUtilTecIni ( const char *  Title,
const char *  Variables,
const char *  FName,
const char *  ScratchDir,
LgIndex_t *  Debug,
LgIndex_t *  VIsDouble 
)

Initializes the process of writing a binary data file.

This must be called first before any other TecUtilTecXxx calls are made. You may write to multiple files by calling TecUtilTecIni() more than once. Each time TecUtilTecIni() is called, a new file is opened. Use TecUtilTecFil() to switch between files.

Parameters:
Title Title of the data set. Must be NULL terminated
Variables List of variable names. Separate variable names with a newline, comma or space. If a newline is detected anywhere in the string it is used as the separator otherwise if a comma is detected then the comma is the separator otherwise a space is used. The string must be NULL terminated
FName Name of the file to create. Must be NULL terminated
ScratchDir Name of the directory to put the scratch file. Must be NULL terminated
Debug Handle to the integer flag for debugging. Set to 0 for no debugging or 1 to debug
VIsDouble Handle to the integer flag for specifying whether field data generated in future calls to TecUtilTecIni() are to be written in single or double precision. Set to 0 for single precision or 1 for double
Returns:
0 if successful, -1 if unsuccessful.
Precondition:
Title Pointer must be a valid address and non-NULL.

Variables String must have a valid address and non-zero length.

FName String must have a valid address and non-zero length.

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

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

Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilTecIni(
   &                   Title,
   &                   Variables,
   &                   FName,
   &                   ScratchDir,
   &                   Debug,
   &                   VIsDouble)
    CHARACTER*(*)   Title
    CHARACTER*(*)   Variables
    CHARACTER*(*)   FName
    CHARACTER*(*)   ScratchDir
    INTEGER*4       FileType
    INTEGER*4       Debug
    INTEGER*4       VIsDouble

Python Syntax:

    This function is not supported in Python.

LgIndex_t TecUtilTecIniX ( ArgList_pa  ArgList  ) 

Initializes the process of writing a binary data file.

This must be called first before any other TecUtilTecXxx calls are made. You may write to multiple files by calling TecUtilTecIniX() more than once. Each time TecUtilTecIniX() is called, a new file is opened. Use TecUtilTecFil() to switch between files.

Parameters:
ArgList Set of Arglist entries. This is built using calls to TecUtilArgListAppendXXXX functions.

Arglist Values

SV_DATASETTITLE
Type: char *
Arg Function: TecUtilArgListAppendString()
Default: ""
Required: No
Notes: Data set title

SV_VARIABLES
Type: char *
Arg Function: TecUtilArgListAppendString()
Default: ""
Required: No
Notes: Only optional for files with DataFileType_Grid file type. Required for file types DataFileType_Full and DataFileType_Solution. See TecUtilTecIni() for more details

SV_FILENAME
Type: char *
Arg Function: TecUtilArgListAppendString()
Required: Yes
Notes: Name of the file to create. Must be NULL terminated

SV_SCRATCHDIR
Type: char *
Arg Function: TecUtilArgListAppendString()
Default: NULL
Required: No
Notes: Name of the directory to put the scratch file. Must be NULL terminated

SV_DATAFILETYPE
Type: DataFileType_e
Arg Function: TecUtilArgListAppendInt()
Default: DataFileType_Full
Required: No
Notes: Must be set to one of DataFileType_Full, DataFileType_Grid, or DataFileType_Solution. Use DataFileType_Full for a classic Tecplot data file. Use DataFileType_Grid for data files that will share all data with files marked DataFileType_Solution to make complete zones

SV_DEBUG
Type: Boolean_t
Arg Function: TecUtilArgListAppendInt()
Default: FALSE
Required: No
Notes: Handle to the integer flag for debugging. Set to 0 for no debugging or 1 to debug

SV_VISDOUBLE
Type: Boolean_t
Arg Function: TecUtilArgListAppendInt()
Default: FALSE
Required: No
Notes: Handle to the integer flag for specifying whether field data generated in future calls to TecUtilTecIni() or TecUtilTecIniX() are to be written in single or double precision. Set to 0 for single precision or 1 for double.


Returns:
0 if successful, -1 if unsuccessful.
Precondition:
ArgList Argument list must be valid.
Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilTecIniX(ArgListPtr)
    POINTER (ArgListPtr, ArgList)

Python Syntax:

  Results = TecUtil.TecIniX(ArgList)

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

LgIndex_t TecUtilTecLab ( const char *  S  ) 

Write a set of custom labels to the data file.

Parameters:
S Character string of custom labels. Separate labels by a comma or space. For example, a set of custom labels for each day of the week is:"Sun Mon Tue Wed Thu Fri Sat."
Returns:
0 if successful, -1 if unsuccessful.
Precondition:
S Pointer must be a valid address and non-NULL.
Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilTecLab(S)
    CHARACTER*(*) S

Python Syntax:

  Results = TecUtil.TecLab(S)

  Input:
                  S                    string
  Output:
    Results[0]    ReturnVal            int

LgIndex_t TecUtilTecNod ( LgIndex_t *  NData_Array  ) 

Writes an array of node data to the binary data file.

This is the connectivity list for finite element zones. For polygonal and polyhedral zones, use TecUtilTecPoly().

Parameters:
NData_Array Array of integers. This is the connectivity list, dimensioned (m,JMax) (m moving fastest), where m is 3 for triangles, 4 for quads and tets, and 8 for bricks.
Returns:
0 if successful, -1 if unsuccessful.
Precondition:
VALID_REF(NData) Pointer must be a valid address and non-NULL.
Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilTecNod(NData_Array)
    INTEGER*4 NData_Array

Python Syntax:

  Results = TecUtil.TecNod(NData_Array)

  Input:
                  NData_Array          list of ints
  Output:
    Results[0]    ReturnVal            int

LgIndex_t TecUtilTecNode ( LgIndex_t *  N,
LgIndex_t *  NData_Array 
)

Writes an array of node data to the binary data file.

This is a chunk of the connectivity list for finite element zones. For polygonal and polyhedral zones, use TecUtilTecPoly().

Parameters:
N Handle to an integer value specifying number of values to write
NData_Array Array of integers. This is the connectivity list, dimensioned (m,N) (m moving fastest), where m is 3 for triangles, 4 for quads and tets, and 8 for bricks.
Returns:
0 if successful, -1 if unsuccessful.
Precondition:
N Pointer must be a valid address and non-NULL.

VALID_REF(NData) Pointer must be a valid address and non-NULL.

Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilTecNod(
   &                   N,
   &                   NData_Array)
    INTEGER*4 N
    INTEGER*4 NData_Array

Python Syntax:

  Results = TecUtil.TecNode(N, NData_Array)

  Input:
                  N                    list of ints
                  NData_Array          list of ints
  Output:
    Results[0]    ReturnVal            int

Since:
13.4.0.24291

LgIndex_t TecUtilTecPoly ( LgIndex_t *  FaceNodeCounts,
LgIndex_t *  FaceNodes,
LgIndex_t *  FaceLeftElems,
LgIndex_t *  FaceRightElems,
LgIndex_t *  FaceBndryConnectionCounts,
LgIndex_t *  FaceBndryConnectionElems,
SmInteger_t *  FaceBndryConnectionZones 
)

Deprecated:
Please use TecUtilTecPolyX() instead.

Python Syntax:

  Results = TecUtil.TecPoly(FaceNodeCounts, FaceNodes, FaceLeftElems, FaceRightElems, FaceBndryConnectionCounts, FaceBndryConnectionElems, FaceBndryConnectionZones)

  Input:
                  FaceNodeCounts       list of ints
                  FaceNodes            list of ints
                  FaceLeftElems        list of ints
                  FaceRightElems       list of ints
                  FaceBndryConnectionCounts list of ints
                  FaceBndryConnectionElems list of ints
                  FaceBndryConnectionZones list of ints
  Output:
    Results[0]    ReturnVal            int

LgIndex_t TecUtilTecTxt ( double *  XPos,
double *  YPos,
LgIndex_t *  PosCoordMode,
LgIndex_t *  AttachToZone,
LgIndex_t *  Zone,
LgIndex_t *  Font,
LgIndex_t *  FontHeightUnits,
double *  FontHeight,
LgIndex_t *  BoxType,
double *  BoxMargin,
double *  BoxLineThickness,
LgIndex_t *  BoxColor,
LgIndex_t *  BoxFillColor,
double *  Angle,
LgIndex_t *  Anchor,
double *  LineSpacing,
LgIndex_t *  TextColor,
LgIndex_t *  Scope,
const char *  Text,
const char *  MacroFunctionCommand 
)

Write a text label to a binary tecplot data file.

This function mimicks the TECTXT function that is part of the TecIO library.

Parameters:
XPos X-Anchor position of the text
YPos Y-Anchor position of the text
PosCoordMode Coordinate system used by the anchor position 0=Grid, 1=Frame, 6=Grid3D
AttachToZone Flag specifying whether or not to attach the text to a zone. One=Attach 0=Don't attach
Zone Zone to attach to
Font Font to use. Zero=Helv, 1=HelvBold, 2=Greek, 3=Math, 4=UserDef, 5=Times, 6=TimesItalic, 7=TimesBold, 8=TimesItalicBold, 9=Courier, 10=CourierBold
FontHeightUnits Units for the font height. Zero=Grid, 1=Frame, 2=Point
FontHeight Height of the text
BoxType Type of box to use. Zero=None, 1=Filled, 2=Hollow
BoxMargin Box Margin in percentage of the font height
BoxLineThickness Line thickness of the box in frame units.
TextColor Color of the text, 0=Black, 1=Red, 2=Green, 3=Blue, 4=Cyan, 5=Yellow, 6=Purple, 7=White, 8-64 are Custom colors.
BoxColor Color of the text box outline. 0=Black, 1=Red, 2=Green, 3=Blue, 4=Cyan, 5=Yellow, 6=Purple, 7=White, 8-64 are Custom colors.
BoxFillColor Color of the text box interior. 0=Black, 1=Red, 2=Green, 3=Blue, 4=Cyan, 5=Yellow, 6=Purple, 7=White, 8-64 are Custom colors.
Angle Angle of the text in degrees
Anchor Anchor position of the text. Zero=Left, 1=Center, 2=Right, 3=MidLeft, 4=MidCenter, 5=MidRight, 6=HeadLeft, 7=HeadCenter, 8=HeadRight
LineSpacing Line spacing of the text
Scope Scope for the text. Zero=Global, 1=Local
Text Actual text string
MacroFunctionCommand Macro command to execute when user cntrl-clicks on the text label. Set to NULL to not use.
Returns:
Returns 0 if successful, -1 if not.
Precondition:
XPos Pointer must be a valid address and non-NULL.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Text String must have a valid address and non-zero length.

MacroFunctionCommand Pointer must be a valid address or NULL.

Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilTecTxt(
   &                   XPos,
   &                   YPos,
   &                   PosCoordMode,
   &                   AttachToZone,
   &                   Zone,
   &                   Font,
   &                   FontHeightUnits,
   &                   FontHeight,
   &                   BoxType,
   &                   BoxMargin,
   &                   BoxLineThickness,
   &                   BoxColor,
   &                   BoxFillColor,
   &                   Angle,
   &                   Anchor,
   &                   LineSpacing,
   &                   TextColor,
   &                   Scope,
   &                   Text,
   &                   MacroFunctionCommand)
    REAL*8          XPos
    REAL*8          YPos
    INTEGER*4       PosCoordMode
    INTEGER*4       AttachToZone
    INTEGER*4       Zone
    INTEGER*4       Font
    INTEGER*4       FontHeightUnits
    REAL*8          FontHeight
    INTEGER*4       BoxType
    REAL*8          BoxMargin
    REAL*8          BoxLineThickness
    INTEGER*4       BoxColor
    INTEGER*4       BoxFillColor
    REAL*8          Angle
    INTEGER*4       Anchor
    REAL*8          LineSpacing
    INTEGER*4       TextColor
    INTEGER*4       Scope
    CHARACTER*(*)   Text
    CHARACTER*(*)   MacroFunctionCommand

Python Syntax:

    This function is not supported in Python.

LgIndex_t TecUtilTecTxtX ( ArgList_pa  ArgList  ) 

Writes the text item to the data file.

Parameters:
ArgList Set of Arglist entries. This is built using calls to TecUtilArgListAppendXXXX functions.

Arglist Values

SV_TEXT
Type: char *
Arg Function: TecUtilArgListAppendString()
Required: Yes

SV_XPOS
Type: double
Arg Function: TecUtilArgListAppendDouble()
Default: 0.0
Required: No
Notes: Anchor position for the text

SV_YPOS
Type: double
Arg Function: TecUtilArgListAppendDouble()
Default: 0.0
Required: No

SV_ZPOS
Type: double
Arg Function: TecUtilArgListAppendDouble()
Default: 0.0
Required: No

SV_POSITIONCOORDSYS
Type: CoordSys_e
Arg Function: TecUtilArgListAppendInt()
Default: CoordSys_Grid
Required: No
Notes: Coordinate system to which the text belongs and may have any of the following values: CoordSys_Grid, CoordSys_Frame, CoordSys_Grid3D.

SV_ATTACHZONE
Type: Boolean_t
Arg Function: TecUtilArgListAppendInt()
Default: FALSE
Required: No
Notes: A value of TRUE intedictates that the text is attached to the specified zone or map. A value of FALSE indicates that the text is not attached to a specific zone or map

SV_ZONE
Type: EntIndex_t
Arg Function: TecUtilArgListAppendInt()
Default: 1
Required: No
Notes: Zone or map number to which the text is attached

SV_FONT
Type: Font_e
Arg Function: TecUtilArgListAppendInt()
Default: Font_HelveticaBold
Required: No
Notes: Font used to render the text may have any of the following values: Font_Helvetica, Font_HelveticaBold Font_Greek, Font_Math, Font_UserDefined, Font_Times, Font_TimesItalic, Font_TimesBold, Font_TimesItalicBold, Font_Courier, Font_CourierBold

SV_SIZEUNITS
Type: Units_e
Arg Function: TecUtilArgListAppendInt()
Default: Units_Point
Required: No
Notes: Text sizing untis may have any of the following values: Untis_Grid, Units_Frame or Untis_Point

SV_HEIGHT
Type: double
Arg Function: TecUtilArgListAppendDouble()
Default: 14.0
Required: No
Notes: Text height in the specified units

SV_BOXTYPE
Type: TextBox_e
Arg Function: TecUtilArgListAppendInt()
Default: TextBox_None
Required: No
Notes: Text box type may have any of the following values: TextBox_None, TextBox_Filled, or TextBox_Hollow

SV_MARGIN
Type: double
Arg Function: TecUtilArgListAppendDouble()
Default: 20.0
Required: No
Notes: Margin between the text and the text box may be a value greater than or equal to zero and less than or equal to 2000

SV_LINETHICKNESS
Type: double
Arg Function: TecUtilArgListAppendDouble()
Default: 0.1
Required: No
Notes: Text box line thickness may be a value greater than or equal to 0.001 or less than or equal to 100

SV_COLOR
Type: ColorIndex_t
Arg Function: TecUtilArgListAppendInt()
Default: Black_C
Required: No
Notes: Text box line color may be a value greater or equal to zero.

SV_FILLCOLOR
Type: ColorIndex_t
Arg Function: TecUtilArgListAppendInt()
Default: White_C
Required: No
Notes: Text box fill color may be a value greater or equal to zero

SV_ANGLE
Type: double
Arg Function: TecUtilArgListAppendDouble()
Default: 0.0
Required: No
Notes: Text angle may have a value greater than or equal to -360 and less than or equal to 360

SV_ANCHOR
Type: TextAnchor_e
Arg Function: TecUtilArgListAppendInt()
Default: TextAnchor_Left
Required: No
Notes: Text anchor may have any of the following values: TextAnchor_Left, TextAnchor_Center, TextAnchor_Right, TextAnchor_MidLeft, TextAnchor_MidCenter, TextAnchor_MidRight, TextAnchor_HeadLeft, TextAnchor_HeadCenter, TextAnchor_HeadRight, TextAnchor_OnSide,

SV_LINESPACING
Type: double
Arg Function: TecUtilArgListAppendDouble()
Default: 1.0
Required: No
Notes: Line spacing may have a value greater that or equal to zero and less than or equal to 50

SV_TEXTCOLOR
Type: ColorIndex_t
Arg Function: TecUtilArgListAppendInt()
Default: Black_C
Required: No
Notes: Text color may be a value greater than or equal to zero

SV_SCOPE
Type: Scope_e
Arg Function: TecUtilArgListAppendInt()
Default: Scope_Local
Required: No
Notes: Text with local scope is displayed onlu in the frame in which it is created. If the text is defined as having global scope, it will appear in all "like" frames, that is, those frames using the same data set as the one in which the text was created. Scope may have any of the following values: Scope_Global or Scope_Local.

SV_CLIPPING
Type: Clipping_e
Arg Function: TecUtilArgListAppendInt()
Default: Clipping_ClipToViewport
Required: No
Notes: Clipping applied to the text may have any of the following values: Clipping_ClipToViewport or Clipping_ClipToFrame

SV_MACROFUNCTIONCOMMAND
Type: char *
Arg Function: TecUtilArgListAppendString()
Default: NULL
Required: No
Notes: Macro function command associated with the text


Returns:
0 if successful, -1 if unsuccessful.
Precondition:
ArgList Argument list must be valid.
Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilTecTxtX(ArgListPtr)
    POINTER (ArgListPtr, ArgList)

Python Syntax:

  Results = TecUtil.TecTxtX(ArgList)

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

LgIndex_t TecUtilTecUsr ( const char *  S  ) 

Add a user-defined record, in the form of a character string, to the Tecplot data file.

Tecplot currently ignores this record when reading Tecplot data files.

Parameters:
S String used in the user-defined record
Returns:
0 if successful, -1 if unsuccessful.
Precondition:
S Pointer must be a valid address and non-NULL.
Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilTecUsr(S)
    CHARACTER*(*) S

Python Syntax:

  Results = TecUtil.TecUsr(S)

  Input:
                  S                    string
  Output:
    Results[0]    ReturnVal            int

This function is comparable to $!TECUSR, a Tecplot macro command. Please refer to the examples given for $!TECUSR in the Tecplot Reference Manual.

   Insert a user-defined record with the string "Hi Mom" into the data file.
   TecUtilTecUsr("Hi Mom");

LgIndex_t TecUtilTecVAux ( LgIndex_t *  Var,
char *  Name,
char *  Value 
)

Writes the name/value variable auxiliary data pair to the data file.

Since:
10.0-3-129
Parameters:
Var Variable number assoicated with the auxiliary data.
Name Name of the variable auxiliary data item.
Value The value associated with the named variable auxiliary data item.
Returns:
0 if successful, -1 if unsuccessful.
Precondition:
Value Pointer must be a valid address and non-NULL.
Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilTecVAux(
   &                   Var,
   &                   Name,
   &                   Value)
    INTEGER*4       Var
    CHARACTER*(*)   Name
    CHARACTER*(*)   Value

Python Syntax:

    This function is not supported in Python.

LgIndex_t TecUtilTecZAux ( char *  Name,
char *  Value 
)

Writes the name/value zone auxiliary data pair to the data file.

Parameters:
Name Name of the zone auxiliary data item.
Value The value associated with the named zone auxiliary data item
Returns:
0 if successful, -1 if unsuccessful.
Precondition:
Value Pointer must be a valid address and non-NULL.
Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilTecZAux(
   &                   Name,
   &                   Value)
    CHARACTER*(*)   Name
    CHARACTER*(*)   Value

Python Syntax:

  Results = TecUtil.TecZAux(Name, Value)

  Input:
                  Name                 string
                  Value                string
  Output:
    Results[0]    ReturnVal            int

LgIndex_t TecUtilTecZne ( const char *  ZoneTitle,
LgIndex_t *  IMx,
LgIndex_t *  JMx,
LgIndex_t *  KMx,
const char *  ZFormat,
const char *  DupList 
)

Writes header information about the next zone to be added to the data file.

After TECZNE is called, you must call TECDAT one or more times (and then call TECNOD if the data format is FEBLOCK or FEPOINT).

Parameters:
ZoneTitle Title of the zone. Must be NULL terminated.
IMx Pointer to integer specifying I-Dimension of the zone. If the data is finite-element then IMx is the number of data points.
JMx Pointer to integer specifying J-Dimension of the zone if ordered otherwise the number of elements if finite element.
KMx Pointer to integer specifying K-Dimension of the zone if ordered otherwise is set according to the following: KMx for triangles is 0, quads is 1, tets is 2, and bricks is 3. Use TecUtilTecZneX() for polygonal and polyhedral zones.
ZFormat Must be set to one of BLOCK, POINT, FEBLOCK, or FEPOINT. Must be NULL terminated.
DupList This parameter specifies a list of variables to duplicate from the preceding zone. For a complete explination of the DupList parameter, see the Tecplot User's Manual. The DupList parameter is a string of the following form: "[n1,n2,...,nn][,FECONNECT]"where n1...nn are the numbers of the variables to duplicate. If the zone is finite element, you may optionally include FECONNECT, which will duplicate the connectivity list from the last zone. Notes for using the DupList parameter:1. You cannot use the DupList parameter for the first zone, since in that case there is nothing to duplicate.2. If you use FECONNECT, you cannot call TECNOD for this zone, since FECONNECT specifies that the entire connectivity list from the previous zone will be duplicated.3. For finite-element zones, you can pass "FECONNECT" to duplicate only the connectivity list.4. You may pass either NULL or a zero length string if you are not using this parameter.
Returns:
0 if successful, -1 if unsuccessful.
Precondition:
ZoneTitle Pointer must be a valid address or NULL.

DupList Pointer must be a valid address or NULL.

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

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

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

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

Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilTecZne(
   &                   ZoneTitle,
   &                   IMx,
   &                   JMx,
   &                   KMx,
   &                   ZFormat,
   &                   DupList)
    CHARACTER*(*)   ZoneTitle
    INTEGER*4       IMx
    INTEGER*4       JMx
    INTEGER*4       KMx
    CHARACTER*(*)   ZFormat
    CHARACTER*(*)   DupList

Python Syntax:

    This function is not supported in Python.

LgIndex_t TecUtilTecZneX ( ArgList_pa  ArgList  ) 

Writes the zone to the data file.

Parameters:
ArgList Set of Arglist entries. This is built using calls to TecUtilArgListAppendXXXX functions.

Arglist Values

SV_TITLE
Type: char *
Arg Function: TecUtilArgListAppendString()
Default: Zone
Required: No
Notes: Zone title

SV_ZONETYPE
Type: ZoneType_e
Arg Function: TecUtilArgListAppendInt()
Required: Yes
Notes: Zone type may be any of the following values: ZoneType_Ordered, ZoneType_FETriangle, ZoneType_FEQuad, ZoneType_FETetra, ZoneType_FEBrick, ZoneType_FELineSeg, ZoneType_FEPolygon, ZoneType_FEPolyhedron.

SV_IMAX
Type: LgIndex_t
Arg Function: TecUtilArgListAppendInt()
Required: Yes
Notes: Number of points for the zone. The values must each be greater than or equal to 1. For ordered zones these are the I,J, and K index dimensions. For finite-element zones IMax is the number of nodes.

SV_JMAX
Type: LgIndex_t
Arg Function: TecUtilArgListAppendInt()
Required: Yes
Notes: JMax. For finite-element zones JMax is the number of elements.

SV_KMAX
Type: LgIndex_t
Arg Function: TecUtilArgListAppendInt()
Required: Yes
Notes: KMax. For polygonal or polyhedral zones, KMax is the number of faces.

SV_SOLUTIONTIME
Type: double
Arg Function: TecUtilArgListAppendDouble()
Default: 0.0
Required: No
Notes: Solution Time for the zone.

SV_STRANDID
Type: LgIndex_t
Arg Function: TecUtilArgListAppendInt()
Default: 0
Required: No
Notes: If the zone is static (not transient) then set the strand ID to zero, otherwise values greater than zero are used to assoicated zones with a particular strand. If the strand ID is given a value of -1 Tecplot can perform auto-stranding based upon the solution time given for each zone.

SV_PARENTZONE
Type: LgIndex_t
Arg Function: TecUtilArgListAppendInt()
Default: 0
Required: No
Notes: A value of zero indicates that this zone is not associated with a parent zone otherwise a value greater than zero is considered this zone's parent. A zone may not specify itself as its own parent. With a parent zone association, Tecplot can generate surface-restricted streamtraces.

SV_ISBLOCK
Type: Boolean_t
Arg Function: TecUtilArgListAppendInt()
Required: Yes
Notes: If TRUE the variables are written in block formate otherwise the less efficient point format is used.

SV_NUMFACECONNECTIONS
Type: LgIndex_t
Arg Function: TecUtilArgListAppendInt()
Default: 0
Required: No
Notes: Indicates the number of user defined face neighbor connections that will be supplied. The value must be greater than or equal to zero

SV_FACENEIGHBORMODE
Type: FaceNeighborMode_e
Arg Function: TecUtilArgListAppendInt()
Default: FaceNeighborMode_LocalOneToOne
Required: No
Notes: None

SV_NUMFACENODES
Type: LgIndex_t
Arg Function: TecUtilArgListAppendInt()
Required: Yes
Notes: Total number of face nodes equivalent to the sum of the values in the FaceNodeCounts array supplied to TecUtilTecPoly(). For polyhedron zones this value is required. For polygonal zones this value is optional but if specified must be equivalent to 2*NumFaces, where NumFaces equals the total number of faces in the zone. This argument is only applicable to polytope zones.

SV_NUMFACEBNDRYFACES
Type: LgIndex_t
Arg Function: TecUtilArgListAppendInt()
Default: 0
Required: No
Notes: Total number of boundary faces - faces that either have more than one neighboring cell on a side or have a neighboring cell from another zone. If there are boundary faces and any faces don't have a neighboring element, then include at least one boundary face to represent it. This argument is only applicable to polytope zones.

SV_NUMFACEBNDRYCONNS
Type: LgIndex_t
Arg Function: TecUtilArgListAppendInt()
Default: 0
Required: No
Notes: The dimension of the FaceBndryConnectionElems and FaceBndryConnectionZones arrays supplied to TecUtilTecPoly(), representing the total number of boundary element-zone tuples listed in the arrays. This argument is only applicable to polytope zones.

SV_PASSIVEVARLIST
Type: LgIndex_t *
Arg Function: TecUtilArgListAppendArray()
Default: NULL (all variables are active)
Required: No
Notes: Array dimensioned by the number of variables where each member contains a value of 0 or 1. A value of 1 indicates that the variable is passive while a value of 0 indicates the variable is active. TecUtilTecDat() assumes that you will not supply values for variables marked as passive. Passive variables do not consume any space in Tecplot and always return a value of zero for every point. Additionally, they are not considered when Tecplot is calculating the min/max values for the dataset.

SV_VALUELOCATION
Type: ValueLocation_e *
Arg Function: TecUtilArgListAppendArray()
Default: NULL (all nodal)
Required: No
Notes: Array dimensioned by the number of variables where each member contains the value location for the associated variable. Each member may have any of the following values: ValueLocation_CellCentered or ValueLocation_Nodal

SV_VARSHAREZONELIST
Type: LgIndex_t *
Arg Function: TecUtilArgListAppendArray()
Default: NULL (no sharing)
Required: No
Notes: Array dimensioned by the number of variables where each member contains the zone which the variable shares its data from or specified zero if it doesn't share with any zone. If a zone number is specified it must always be less than the current zone number.

SV_CONNECTSHAREZONE
Type: LgIndex_t
Arg Function: TecUtilArgListAppendInt()
Default: 0 (no sharing)
Required: No
Notes: Zone number with which the connectivity shares its data from or zero if it doesn't share with any zone. If a zone number is specidied it must always be less than the current zone number


Returns:
0 if successful, -1 if unsuccessful.
Precondition:
ArgList Argument list must be valid.
Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilTecZneX(ArgListPtr)
    POINTER (ArgListPtr, ArgList)

Python Syntax:

  Results = TecUtil.TecZneX(ArgList)

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

Boolean_t TecUtilWriteDataSet ( const char *  FName,
Boolean_t  IncludeText,
Boolean_t  IncludeGeom,
Boolean_t  IncludeCustomLabels,
Boolean_t  IncludeData,
Set_pa  ZonesToWrite,
Set_pa  VarsToWrite,
Boolean_t  WriteBinary,
Boolean_t  UsePointFormat,
SmInteger_t  AsciiPrecision 
)

Write the data set attached to the current frame to a file.

Parameters:
FName File name. Must not be NULL
IncludeText Set to TRUE to include text.
IncludeGeom Set to TRUE to include geometries
IncludeCustomLabels Set to TRUE to include custom labels
IncludeData Set to TRUE to include data
ZonesToWrite Set of zones to write. Pass NULL to write all zones
VarsToWrite Set of vars to write. Pass NULL to write all variables
WriteBinary Set to TRUE to write a binary file, FALSE to write an ASCII file
UsePointFormat Valid only if WriteBinary is FALSE, ignored otherwise
AsciiPrecision Valid only if WriteBinary is FALSE, ignored otherwise
Precondition:
FName String must have a valid address and non-zero length.

ZonesToWrite Pointer must be a valid address or NULL.

VarsToWrite Pointer must be a valid address or NULL.

Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilWriteDataSet(
   &                   FName,
   &                   IncludeText,
   &                   IncludeGeom,
   &                   IncludeCustomLabels,
   &                   IncludeData,
   &                   ZonesToWritePtr,
   &                   VarsToWritePtr,
   &                   WriteBinary,
   &                   UsePointFormat,
   &                   AsciiPrecision)
    CHARACTER*(*)   FName
    INTEGER*4       IncludeText
    INTEGER*4       IncludeGeom
    INTEGER*4       IncludeCustomLabels
    INTEGER*4       IncludeData
    POINTER         (ZonesToWritePtr, ZonesToWrite)
    POINTER         (VarsToWritePtr, VarsToWrite)
    INTEGER*4       WriteBinary
    INTEGER*4       UsePointFormat
    INTEGER*4       AsciiPrecision

Python Syntax:

  Results = TecUtil.WriteDataSet(FName, IncludeText, IncludeGeom, IncludeCustomLabels, IncludeData, ZonesToWrite, VarsToWrite, WriteBinary, UsePointFormat, AsciiPrecision)

  Input:
                  FName                string
                  IncludeText          boolean
                  IncludeGeom          boolean
                  IncludeCustomLabels  boolean
                  IncludeData          boolean
                  ZonesToWrite         sequence of ints
                  VarsToWrite          sequence of ints
                  WriteBinary          boolean
                  UsePointFormat       boolean
                  AsciiPrecision       int
  Output:
    Results[0]    ReturnVal            boolean

Write out only zone 3 to a file called zone3.plt:

   Set_pa set = TecUtilSetAlloc(FALSE);
   TecUtilSetAddMember(set,3,FALSE);
   TecUtilWriteDataSet("zone3.plt",FALSE,FALSE,FALSE,TRUE,set,NULL,
                       TRUE,FALSE,0);
   TecUtilSetDealloc(&set);

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