360 Scripting Guide2017
360 Scripting Guide2017
Copyright © 1988-2017 Tecplot, Inc. All rights reserved worldwide. Except for personal use, this manual may not be reproduced, transmitted, transcribed,
stored in a retrieval system, or translated in any form, in whole or in part, without the express written permission of Tecplot, Inc., 3535 Factoria Blvd, Ste. 550;
Bellevue, WA 98006 U.S.A.
The software discussed in this documentation and the documentation itself are furnished under license for utilization and duplication only according to the
license terms. The copyright for the software is held by Tecplot, Inc. Documentation is provided for information only. It is subject to change without notice. It
should not be interpreted as a commitment by Tecplot, Inc. Tecplot, Inc. assumes no liability or responsibility for documentation errors or inaccuracies.
Tecplot, Inc.
Post Office Box 52708
Bellevue, WA 98015-2708 U.S.A.
Tecplot®, Tecplot 360,™ Tecplot 360 EX,™ Tecplot Focus, the Tecplot product logos, Preplot,™ Enjoy the View,™ Master the View,™ SZL,™ Sizzle,™ and
Framer™ are registered trademarks or trademarks of Tecplot, Inc. in the United States and other countries. All other product names mentioned herein are
trademarks or registered trademarks of their respective owners.
Use, duplication, or disclosure by the U.S. Government is subject to restrictions as set forth in subparagraphs (a) through (d) of the Commercial Computer-
Restricted Rights clause at FAR 52.227-19 when applicable, or in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at
DFARS 252.227-7013, and/or in similar or successor clauses in the DOD or NASA FAR Supplement. Contractor/manufacturer is Tecplot, Inc., 3535 Factoria
Blvd, Ste. 550; Bellevue, WA 98006 U.S.A.
For third-party trademark and copyright information, see the Tecplot 360 EX User’s Manual.
Table of Contents
1 Introduction ...................................................................................................... 5
5 Debugging Macros................................................. 13
3
8 Macro Command Summary ................................................................ 25
4
1
Introduction
Tecplot 360 is a powerful tool for visualizing a wide range of technical data. It offers line plotting, 2D and
3D surface plots in a variety of formats, and 3D volumetric visualization. The user documentation for
Tecplot 360 is divided into the following books:
• Scripting Guide (this document) - Provides Tecplot macro command syntax and information
on working with macro files and commands.
• User’s Manual - Provides a complete description of working with Tecplot 360 features.
• Getting Started Manual - New users are encouraged to work through the tutorial provided in
the Getting Started Manual to learn how to work with key product features.
• Quick Reference Guide - Provides syntax for zone header files, macro variables, keyboard
shortcuts, and more.
• Data Format Guide - Provides information on outputting your simulator data into Tecplot 360
file format.
• Installation Instructions - Provides detailed instructions on how to install Tecplot 360 on your
machine.
• Release Notes - Provides information about new and/or updated Tecplot 360 features.
Macro programming capabilities are included in your Tecplot 360 distribution. Macro language syntax
and usage are provided in this Scripting Guide. Macros can be accessed via the Scripting menu and from
the Quick Macro Panel (also accessed via the Scripting menu).
5
6
2
A Tecplot 360 macro is a set of instructions, called macro commands, which perform actions in Tecplot 360.
Macro commands can be used to accomplish virtually any task that can be done via the Tecplot 360
interface, offering an easy way to automate Tecplot 360 processes. The only things you can do interactively
that cannot be done with macro commands are those actions that have no effect on a final, printed plot
(such as resizing the Tecplot 360 process window). To augment this ability, there are macro commands
which have no corresponding interactive control, such as looping and conditional commands. These
commands typically go hand in hand with the execution of a macro.
You can create macros by recording them from the Tecplot 360 interface using the Macro Recorder
(accessed via the Scripting>Record Macro menu), or create them from scratch using any ASCII text editor.
In most cases, the most effective approach to creating a macro is the following hybrid approach:
1. Run Tecplot 360 and choose to record a macro to a file. Perform tasks similar to those you are
trying to capture in the final macro.
2. Close the recording session and examine the macro file. The commands generated by Tecplot
360 should be fairly readable and easy to understand.
3. Make minor modifications to the recorded macro. Typical modifications involve adding
loops, adding variables, or adding commands that, for example, prompt the user to enter a file
name.
One of the main reasons for using the approach above is the large number of commands and permutations
of parameters. This manual provides an exhaustive listing of the available macro commands. However, it
is often easier to have Tecplot 360 perform the action and record the relevant command than look up
individual commands and their required parameters.
7
8
3
Managing Macros
Tecplot 360 macros are stored in files. These files are processed by loading them into Tecplot 360 and
running them.
9
If you want to debug a macro file, go to the Scripting menu and select the "View/Debug Macro" option.
The Macro Debugger dialog appears so you can load in a macro. When the macro is loaded, Tecplot 360
waits at the first macro command for you to step through the commands. See Section 26 - 3 “Macro
Debugger” in the User’s Manual for complete details on how to use the Macro Debugger.
If tecplot.mcr does not contain any function definitions, nothing will appear the Quick
Macro Panel.
If you want Tecplot 360 to display the Quick Macro Panel at startup, include the -showpanel flag on the
command line.
To see an example of a macro function file, look at the file tecplot.mcr located in the Tecplot 360 home
directory. This is where the default Quick Macro Panel entries are stored, for example 3D Rotation
Animation and Reset Center of Rotation.
10
4
In order to ensure forward compatibility of your macro commands, please keep the following guidelines
in mind. These guidelines will allow you to create macros that will work for years, on many machines and
platforms.
1. Begin your macro by opening a layout.
This will ensure that the final plot is consistent between versions of Tecplot 360 (even if the
default style settings for Tecplot 360 have changed).
An alternative to using a layout is to load data and then load a frame style file into each
frame.
If your macro will be used for more than one layout, you can ensure forward compatibility by:
• Using the $!PromptForFileName command. This will allow the user to interactively
specify the layout file.
-or-
• Launching Tecplot 360 from the command line, specifying the layout and the macro:
tecplot mylayout.lay mydatafile mymacro.mcr
2. Store associated files and graphics in the same folder as the macro file.
If your macro loads files or inserts images without allowing the user to choose them, it is a
good practice to store them in the same folder as the macro file that uses them. After
recording, edit the macro, and replace the path to the file with the intrinsic macro variable
|macrofilepath|.
Example:
$!OpenLayout "|macrofilepath|\Density.lpk"
This allows the macro to work without editing in any location as long as the entire folder of
files was copied there.
3. Avoid using a $!Pick command in your macro.
11
Changes to the aspect ratio can cause a recorded $!Pick command to fail when the macro is
run on another machine or in another version of Tecplot 360.
• In a plot with multiple frames, you cannot use $!Pick to change the active frame.
Instead, give each frame a meaningful name such as “Full View” and “Zoom Frame” in
the layout. Then use the command:
$!FrameControl ActivateByName Name = “Full View”
to access the frame you want. This will also simplify later changes to the macro.
• If you must pick an item, make the pick as precise as possible. For example, clicking on
the center, not the edge, of a zone or slice will increase the chances that the pick will be
successful when the macro is replayed.
When selecting text or geometries while recording a macro, click and drag in the widest
possible area around the objects to select. The command will be recorded as
$!PICK ADDALLINRECT
SELECTTEXT = YES
X1 = 1.56075949367
X2 = 3.97088607595
Y1 = 2.29556962025
Y2 = 3.91582278481
The x and y ranges can be expanded if needed.
4. Use plenty of comments in your macro so that when you need to modify it, you understand
what it does.
12
5
Debugging Macros
In general, the best way to debug a macro is to use the Macro Debugger, and find which command is
causing the problem. Here are some tips for specific problems:
Problem: The macro was created with an earlier version of Tecplot 360, Tecplot 360 EX, or Tecplot Focus to make the
plot needed. With a newer version, the macro runs without error, but the plot looks different.
Solution: Run the macro with the old version of the product, then save a frame style to a file. Begin your
macro by loading the data, then pasting the frame style from a file. This will ensure that the final plot
will be consistent from one version to the next, even if the default style settings have changed.
Problem: The macro gives you errors such as “File does not exist” or “Cannot open file”, but you can locate the file.
Solution: Copy the file to the same folder as the macro file that uses the file. Edit the macro, and replace
the path to the file with the intrinsic macro variable |macrofilepath|.
Example: $!Openlayout "|macrofilepath|\Density.lpk"
This allows the macro to work without editing in any location as long as the entire folder of files was
copied there.
Problem: Running the macro causes unusual error messages, such as: “No objects to cut or the objects
selected not allowed to be cut” or “Not allowed to adjust zones or mappings when the mouse mode is
set to SELECTOR”. When you run the macro in the Macro Debugger, you see that the problem occurs
with when a $!Pick command is run.
Solution: Avoid using the $!Pick command in your macro. Changes to the aspect ratio can cause a
recorded $!Pick command to fail when the macro is run on another machine or in another version of
Tecplot 360 EX.
To fix the problem in an existing macro, follow these steps to make the coordinates more precise:
1. Run the macro on the machine where the error message is generated.
2. Via the Macro Debugger or editor, identify the preceding $!PICK CHECKTOADD or similar select
type pick command. Note the X,Y coordinates of the command. A good way to do this is:
13
a. Run the macro until you get the “No Objects to Shift” error message.
b. Click Ok on the dialog.
c. Bring up the Macro Debugger: Scripting>View/Debug Macro.
d. Find the nearest $!PICK CHECKTOADD command above the current command and put a
break point on that command.
e. Press “Reset” to reset the macro and then run the macro.
If the problem only occurs when running in batch mode, try to determine the macro
command by examining the batch.log file.
f. Insert a $!Pause command in your macro just before the $!Pick Add command that
precedes the offending command. Now run Tecplot 360 interactively from the Macro
Debugger. You can then see the line number where you need to put the break.
3. Back in Tecplot 360 EX, select the zoom tool.
4. Hold the shift key down and notice that the running coordinates in the lower right corner now
show “PX = xxxxx PY = yyyyyy". xxxxxx and yyyyyy are the paper coordinates of the hot
spot of the zoom tool. (If you see X and Y for grid coordinates, or FX and FY for frame
coordinates, you need to hold down the Shift key. Pick commands always use paper
coordinates.)
5. Move the zoom tool until xxxxx and yyyyy are close to the coordinates noted in step 2.
6. Note where the pick occurred. It is likely the pick occurred some distance away from the
actual edge of the object to pick. Move the zoom tool to a “better” location for the pick and
note the coordinates.
Edit the macro file and replace the old X,Y pick coordinates with those determined in step 6.
14
6
A macro file consists of one or more macro commands. Comments may be inserted anywhere in the file,
except within a character string. Comments start with an “#” (octothorp) and extend to the end of the line.
The first line of a macro file contains a special comment that identifies the version number of the macro
file. For Tecplot 360, this line is: #!MC 1410.
A Tecplot 360 macro file has the form:
#!MC 1410
<macrocommand>
<macrocommand>
...
Each macrocommand, in turn, has the form:
$!commandname [commandspecificmodifiers]
[mandatoryparameters]
[optionalparameters]
where
commandspecificmodifiers These are optional command-specific modifiers. An example of a command that uses this is the
$!FIELDMAP command. The $!FIELDMAP command can be followed by a “set.” If it is not
followed by a set, the $!FIELDMAP command applies to all enabled zones. A supplied set in this
case is used to limit the zones to which the $!FIELDMAP command applies.
op = or -= or += or *= or /=.
parametersubcommand parametername {optionalparameters}.
15
parametername The name of a valid parameter for the previously named major command. For example, the
$!REDRAW major command has an optional parameter called DOFULLDRAWING.
expression Any valid infix notation expression. The entire expression must itself be enclosed in parenthesis.
For example (3+5).
enumeratedvalue A key word that is unique to the variable being assigned a value. For example, if the variable being
assigned a value is a basic color then the enumerated value can be one of the following: BLACK,
RED, GREEN, BLUE, CYAN, YELLOW, PURPLE, WHITE, CUSTOM1 through CUSTOM56.
Spacing and capitalization for macro commands are, for the most part, not important. The following
examples show different ways to enter the same macro command to set the width and height for the
custom1 paper:
Example 1:
$!PAGE
PAPERSIZEINFO
{
CUSTOM1
{
WIDTH = 3
}
}
Example 2:
$!PAGE PAPERSIZEINFO
{CUSTOM1
{WIDTH = 3}
}
Example 3:
16
7
Macro Variables
Macro variables are identified by a sequence of characters surrounded by vertical bars (“|”). Some
examples are:
|myvariable|
|loop|
|1|
|$HOME|
Macro variables can be placed anywhere within a macro command. Upper case and lower case characters
are treated the same. For example |ABC| and |aBc| represent the same variable.
Macro variables will be expanded to their value at the time the macro statement is processed. The value of
the variable is substituted into the command in place of the variable identifier. The result must be a
syntactically valid Tecplot macro expression or command.
Examples:
The following macro commands will result in a rotation of the data about the X-axis by 10 degrees:
$!VARSET |a1| = 10
$!ROTATE X
ANGLE = |a1|
In the following macro command, the variable |message| contains a string (text). To produce a valid
Tecplot macro command when the variable’s value is substituted in, the variable reference must be
surrounded by quote marks.
$!ATTACHTEXT
TEXT = |message|
When the value of |message| is substituted into the command, it reads TEXT = Hello World, which is an
error because it lacks the quote marks required for a string parameter.
17
7-1 Intrinsic Variables
The following table lists variables maintained by Tecplot 360 that may be referenced by macro commands.
Since these variables are maintained by Tecplot 360, you cannot assign values to them.
For intrinsic variables that represent an attribute of a Tecplot 360 object of which Tecplot 360 supports
multiple instances (such as a frame, a dataset, or a zone), the variable by default refers to the current or
active instance: for example, to the active frame if the variable refers to an attribute of frames. If there is no
obvious default instance, the variable name by itself usually refers to the first instance.
For such variables, you may specify the desired instance of the referenced type of object by enclosing an
index in square brackets immediately following the variable name. For example, |AUXZONE[3]:BC| refers to
the zone auxiliary data named BC in the third zone.
In most cases, the index may also be written as ACTIVEOFFSET=n to specify the nth active instance of an object
type. For example, |ENDSLICEPOS[ACTIVEOFFSET=2]| refers to the end position of the second active slice group.
Variables Notes
Retrieves auxiliary data named Auxname from a dataset For example,
|AUXDATASET:Auxname|
|AUXDATASET:Reynolds| retrieves auxiliary data “Reynolds”.
Retrieves auxiliary data named Auxname from a specific zone. For example,
|AUXZONE:Auxname|
|AUXZONE[3]:BC| retrieves auxiliary data "BC" from zone 3.
|AXISMAXn| Maximum value of the n-axis range, where n is one of: Aa, R, X, Y or Z.
|AXISMINn| Minimum value of the n-axis range, where n is one of: Aa, R, X, Y or Z.
Contains full path to loaded data file. If multiple data files have been loaded, use
|DATASETFNAME|
e.g. |DATASETFNAME[2]| to specify the desired path (indexing by load order).
|DATASETTITLE| Returns the title of the dataset, or “No Data Set” if a dataset does not exist.
|ENDSLICEPOS| Returns the position of the last slice in a group. (Not available for arbitrary slices.)
|EXPORTISRECORDING| Returns YES/NO to help macros complete record commands in the proper order.
|MACROFILEPATH| Returns the path to the directory containing the most recently opened macro file.
18
Intrinsic Variables
Variables Notes
[I, J, K]-dimension of the first active zone. For finite-element zones, MAXI is the
|MAXI|, |MAXJ|, |MAXK| number of nodes, MAXJ is the number of elements, and MAXK is the number of
nodes per element (cell-based) or total number of faces (face-based).
|MAXn| Maximum value of the variable assigned to the n-axis, where n is one of: Aa, R, X, Y,
or Z.
|MAXS| Maximum value of the scatter sizing variable in the active zones.
|MAXU|, |MAXV|, Maximum value of the variable assigned to the [X, Y, Z]-vector component of the
|MAXW| active zones.
|MINS| Minimum value of the scatter sizing variable in the active zones.
|MINU|, |MINV|, Minimum value of the variable assigned to the [X, Y, Z]-vector component in the
|MINW| active zones.
Minimum value of the variable assigned to the n-axis, where n is one of: Aa, R, X, Y,
|MINn|
or Z.
Number of processors that Tecplot 360 uses. This may differ from the total number
|NUMPROCESSORSUSED| in the machine if the $!Limits MaxAvailableProcessors configures usage differently.
By default, Tecplot 360 uses all available processors in the machine.
Returns the plot type of a frame. 0 = Sketch, 1 = XY Line, 2 = 2D, 3 = 3D, 4 = Polar
|PLOTTYPE|
Line.
|PRIMARYSLICEPOS| Returns the position of the primary slice. (Not available for arbitrary slices.)
|PRINTFNAME| Returns the file name of the last file sent for printing.
|SOLUTIONTIME| The current solution time for the specified zone, fieldmap, or linemap.
19
Variables Notes
|STARTSLICEPOS| Returns the position of the first slice in a group. (Not available for arbitrary slices.)
|ZONEMESHCOLOR[nnn]
Returns the color of the mesh for zone nnn.
|
7 - 2.1 Example 1
To compare a macro variable with an environment variable:
7 - 2.2 Example 2
To create a string from an environment variable:
User Defined Variables
20
Assigning Values to Macro Variables
Examples:
Example 1:
Add 2 to the macro variable |ABC|:
$!VARSET |ABC| += 2
Example 2:
Set |ABC| to be equal to 37:
$!VARSET |ABC| = 37
Example 3:
Multiply |ABC| by 1.5:
Example 4:
Set |ABC| to the result of an expression involving other variables and a constant; the expression must
be enclosed in parentheses:
Example:
Assign the string “myfile.plt” to the variable |FNAME|. Use |FNAME| in the $!READDATASET command:
Note that double quotes (") had to be used in the $!READDATASET command even though |FNAME| repre-
sents a string.
21
7-5 Replacement Text Use
You can assign replacement text to a macro variable. This is useful for handling cases where a macro
variable may not be initialized. A macro variable with |AAAA:=XXXXX| will produce XXXXX if AAAA is not
defined. This does not work with intrinsic variables.
Example:
Read in a data file assigned to the variable FNAME. If FNAME is unassigned, read in "t.dat":
$!READDATASET "|FNAME:=t.dat|"
"|FNAME:=t.dat|"
Examples:
Example 1:
The following commands define a macro function that uses two parameters and a command to run
the macro function. The first parameter to the macro function is the amount to rotate about the X-axis
and the second parameter is the amount to rotate about the Y-axis:
The command to run the macro function will cause a rotation of 10 degrees about the X-axis and 20
degrees about the Y-axis.
#!MC 1410
$!MACROFUNCTION NAME = "3D Rotation Animation"
$!EXPORTSETUP EXPORTFORMAT = AVI
$!EXPORTSETUP IMAGEWIDTH = 546
$!EXPORTSETUP EXPORTFNAME = "|1|AxisRotation.avi"
$!EXPORTSTART
$!LOOP |2|
$!ROTATE3DVIEW PSI
ANGLE = |3|
$!REDRAW
$!EXPORTNEXTFRAME
$!ENDLOOP
$!EXPORTFINISH
$!ENDMACROFUNCTION
$!RUNMACROFUNCTION "3D Rotation Animation" ("Theta", 6, 30)
Example 2:
The following commands define a macro function that opens two layout files:
$!MACROFUNCTION
NAME = "OL2"
$!OPENLAYOUT "|1|"
$!OPENLAYOUT "|2|"
APPEND = TRUE
$!ENDMACROFUNCTION
.
.
22
Using Formats in Macro Variables
.
$!RUNMACROFUNCTION "OL2" ("g1.lay","g2.lay")
Example 1:
Suppose you want to pause a macro and display the message "Maximum contour value is: xxxxxx"
where xxxxxx only has two digits to the right of the decimal place. You would use:
If |MAXC| currently has a value of 356.84206 then the dialog would show:
Example 2:
If, in the above example, you wanted to use exponential format you could use:
23
24
8
This chapter presents a brief list of the major macro commands in Tecplot 360. All major macro commands
are preceded by “$!” (dollar sign, exclamation mark).
$!ACTIVEFIELDMAPS.........................................................................................................................................55
A SetValue command that changes the set of active field maps (thus changing the active zones) considered
for plotting.
$!ACTIVELINEMAPS ...........................................................................................................................................56
A SetValue command that changes the set of line mappings considered for plotting.
$!ADDMACROPANELTITLE..............................................................................................................................56
Add a title to the Quick Macro Panel.
$!ALTERDATA........................................................................................................................................................56
The ALTERDATA function operates on a data set within Tecplot 360 using FORTRAN-like equations. See Sec-
tion 20 - 1 “Data Alteration through Equations” in the User’s Manual for more information on using equa-
tions in Tecplot 360. The <zonelist> parameter specifies the set of zones on which to operate, where
zonelist is a list of zones or zone ranges separated by a comma (“,”). Zone ranges are separated by a
hyphen (“-”). If <zonelist> is omitted, all zones are affected. NOTE: the values for the <zonelist> parameter
must be enclosed in square brackets. (For example, use $!ALTERDATA [1,3] to apply ALTERDATA to zones 1
and 3).
$!ANIMATECONTOURLEVELS........................................................................................................................58
Produce an animation of a contour line plot by showing a single level at a time. The animation varies
according to the currently defined contour levels and is limited by the values in the START, END, and SKIP
parameters. To create a movie file, add $!EXPORTSETUP commands before this command.
25
$!ANIMATEIJKBLANKING................................................................................................................................ 59
Produce an animation of different IJK-blankings in your plot. The animation starts at one IJK-blanking set-
ting and marches through intermediate steps to a second setting. To create a movie file, add $!EXPORTSETUP
commands before this command.
$!ANIMATEIJKPLANES ...................................................................................................................................... 61
Produce an animation that cycles through I-, J-, or K-planes in an IJK-ordered data set. To create a movie
file, add $!EXPORTSETUP commands before this command.
$!ANIMATEISOSURFACES................................................................................................................................ 61
The macro command $!ANIMATEISOSURFACES produces an animation of a series of iso-surfaces beginning
with the iso-surface defined by STARTVALUE and ending with the iso-surface defined by ENDVALUE. To create a
movie file, add $!EXPORTSETUP commands before this command.
$!ANIMATELINEMAPS....................................................................................................................................... 62
Produce an animation of one Line-mapping at a time. To create a movie file, add $!EXPORTSETUP commands
before this command.
$!ANIMATESLICES .............................................................................................................................................. 63
The macro command $!ANIMATESLICES uses the currently defined start and end slice position. Use $!SLICE-
ATTRIBUTES to set these positions; $!ANIMATESLICES then redefines how many intermediate slices are to be
used, then animates a sub-set of those slices. To create a movie file, add $!EXPORTSETUP commands before
this command.
$!ANIMATESTREAM ........................................................................................................................................... 64
Produce an animation of stream markers or dashes, moving along the currently defined streamtrace paths.
To create a movie file, add $!EXPORTSETUP commands before this command.
$!ANIMATETIME.................................................................................................................................................. 65
Produce an animation of transient data. To create a movie file, add $!EXPORTSETUP commands before this
command.
$!ANIMATEZONES .............................................................................................................................................. 66
Produce an animation showing one zone at a time. To create a movie file, add $!EXPORTSETUP commands
before this command. This command will not work if the active frame contains a transient data set.
$!ATTACHDATASET ............................................................................................................................................ 66
Attach the active frame to the data set of another frame. Use PAGENUM, if the other frame is on a differ-
ence page. This command is usually found only in layout files generated by Tecplot 360. Note that the
$!PLOTTYPE command automatically executes an $!ATTACHDATASET command if a frame mode is requested in
a frame that does not have an attached data set. Tecplot 360 attaches the data set from the closest frame (in
drawing order) having an attached data set.
$!ATTACHGEOM .................................................................................................................................................. 67
Attach a geometry to the active frame.
26
$!ATTACHTEXT .....................................................................................................................................................69
Attach text to the active frame
$!AXIALDUPLICATE ............................................................................................................................................71
$!BASICCOLOR .....................................................................................................................................................72
A SetValue command that sets the red, green and blue components for any of the basic colors in Tecplot
360.
$!BASICCOLORLEGEND....................................................................................................................................73
A SetValue command that allows you to create and set the style of a legend for the basic colors in Tecplot
360. The legend can be used to display any attribute of the plot represented by a basic color (for example,
materials). Each frame maintains a mapping of basic colors to names. Each basic color actually used in
selected layers of the plot appears in the legend unless it is excluded.
$!BASICSIZE...........................................................................................................................................................75
A SetValue command that sets sizes of various objects like line thicknesses, line pattern length, font height,
and so forth. Sizes can be assigned when interacting with Tecplot 360 by either entering an exact value or
by choosing from a preset list of values. The $!BASICSIZE command allows you to change the values in the
preset lists.
$!BLANKING..........................................................................................................................................................76
A SetValue command that changes settings for IJK- or value-blanking.
$!BRANCHCONNECTIVITY..............................................................................................................................78
For zones where connectivity is shared, this command allows for branching of connectivity information
from the specified zone.
$!BRANCHFIELDDATAVAR...............................................................................................................................79
Allows for branching of specified variable in the specified zone for zones that share variables.
$!BREAK ..................................................................................................................................................................79
Jump out of the current $!LOOP-ENDLOOP or $!WHILE-$!ENDWHILE.
$!COLORMAPATTRIBUTES...............................................................................................................................79
Sets the control point attributes of a custom color map. The named color map must exist and be a custom
color map.
$!COMPATIBILITY................................................................................................................................................80
Allow datasharing access and setting, without warning.
$!CONTINUE..........................................................................................................................................................80
Transfer control back to nearest $!LOOP or $!WHILE.
27
$!CONTOURLABELS [Required-Control Option] ......................................................................................... 80
The different commands in the CONTOURLABELS compound function family are described separately in the
following sections.
$!CONTOURLABELS ADD................................................................................................................................. 81
Add contour labels to your plot.
$!CONTOURLABELS DELETEALL................................................................................................................... 81
Delete all currently defined contour labels.
$!CONTOURLEVELS ADD................................................................................................................................. 82
Add a new set of contour levels to the existing set of contour levels.
$!CONTOURLEVELS DELETENEAREST........................................................................................................ 82
Delete the contour level whose value is nearest the value supplied in the RANGEMIN parameter.
$!CONTOURLEVELS DELETERANGE............................................................................................................ 83
Delete all contour levels between a minimum and maximum contour value (inclusive).
$!CONTOURLEVELS NEW................................................................................................................................. 83
Replace the current set of contour levels with a new set.
$!CONTOURLEVELS RESET.............................................................................................................................. 84
Reset the contour levels to a set of evenly distributed values spanning the entire range of the currently
selected contouring variable.
$!CONTOURLEVELS RESETTONICE.............................................................................................................. 84
Reset the contour levels to a set of evenly distributed, nice values spanning the entire range of the cur-
rently selected contouring variable, with a specified number of entries.
$!CREATECIRCULARZONE ............................................................................................................................... 85
Create a circular (or cylindrical) IJ- or IJK-ordered zone.
$!CREATEBOUNDARYZONES .......................................................................................................................... 85
When YES, boundary zones are created. Use this command when working with StarCCM data to preserve
backward compatibility. (StarCCM Loader ONLY)
28
$!CREATECOLORMAP ........................................................................................................................................86
Defines a color map. Only the name is required; it must be a valid non-zero-length string.
Color map names are case-insensitive, although the case used when creating the color map is retained for
display. Leading and trailing spaces are stripped.
If the named color map does not exist, it is created and initialized to SOURCECOLORMAP if provided;
otherwise to "Small Rainbow." If the named colormap exists, and is not a built-in colormap, it will be over-
written by SOURCECOLORMAP, or by "Small Rainbow" if SORURCECOLORMAP is not provided.
$!CREATECONTOURLINEZONES ...................................................................................................................87
Create zones from the currently-defined contour lines. One zone can be created from each contour level in
that plot, or one zone for every polyline can be generated.
$!CREATEFEBOUNDARY....................................................................................................................................88
Zone edges for finite element data cannot be turned on or off using the edge plot layer in Tecplot 360. You
can, however, create a separate zone which is the boundary of a finite element zone. This new zone can
then be turned on or off.
$!CREATEFESURFACEFROMIORDERED ......................................................................................................88
A FE-Surface zone can be generated from two or more I-Ordered zones. To get the best possible output, it
is recommended that the source zones should have their nodes arranged in a similar manner so that the
connecting lines between points are as straightforward as possible. For this reason, indices from source
zones should increase in the same direction.
$!CREATEISOZONES ...........................................................................................................................................89
Create zones from the currently defined iso-surfaces. One zone will be created from each defined iso-sur-
face. The iso-surfaces must be active and you must have at least one active volume zone.
$!CREATELINEMAP .............................................................................................................................................89
Create a new Line-mapping.
$!CREATEMIRRORZONES.................................................................................................................................89
Create new zones that are mirror images of the source zones
$!CREATENEWFRAME ........................................................................................................................................90
Creates a new frame.
$!CREATERECTANGULARZONE .....................................................................................................................90
Create a rectangular zone. If no data set exists when this command is executed, a data set is created with
variables X, Y (and Z, if KMax > 1). If a data set exists prior to this command, the non-coordinate variables
for the zone created are initialized to zero.
29
$!CREATESIMPLEZONE ..................................................................................................................................... 91
Create a new zone by specifying only a list of data. Rows represent the individual data points and col-
umns the variables at each point.
You cannot specify more variables than the dataset already contains.
$!CREATESLICEZONEFROMPLANE............................................................................................................... 92
Create a new zone as a slice through existing 3D volume zones. Use $!GLOBALTHREED to define the slic-
ing plane orientation.
$!CREATESLICEZONES ...................................................................................................................................... 93
Create a new zone for each slice defined on the Slice Details dialog. Only creates slices from volume zones.
$!CREATESPHERICALZONE ............................................................................................................................. 93
Create a spherical IJK-ordered zone.
$!CREATESTREAMZONES................................................................................................................................. 94
Create one or more zones out of the currently defined streamtraces. The new zones have the same number
of variables per data point as the other zones in the data set with all non-coordinate variables interpolated
at the positions along the streamtrace.
$!DATASETUP........................................................................................................................................................ 95
A SetValue command that sets miscellaneous parameters related to data.
$!DEFAULTGEOM ................................................................................................................................................ 95
A SetValue command that sets the attributes for the default geometry. When a geometry is created interac-
tively, its color, line thickness, and so forth, are preset based on the default geometry. This command is
usually used only in the Tecplot 360 configuration file.
$!DEFAULTTEXT ................................................................................................................................................... 96
A SetValue command that sets the attributes for the default text. When text is added to a plot interactively,
its font, color, size, and so forth, are based on the default text. This command is usually used only in the
Tecplot 360 configuration file.
$!DELAY................................................................................................................................................................... 97
Delay Tecplot 360 execution for <integer> seconds.
$!DELETEAUXDATA ............................................................................................................................................ 97
Delete Auxiliary Data in the form of name/value pairs from zones, frames or datasets.
$!DELETECOLORMAP ........................................................................................................................................ 98
Deletes the specified custom color map, which must exist.
30
$!DELETELINEMAPS ...........................................................................................................................................98
Delete one or more line mappings. If <set> is omitted then all line mappings are deleted.
$!DELETEVARS......................................................................................................................................................98
Delete one or more variables.
$!DELETEZONES...................................................................................................................................................99
Delete one or more zones.
$!DOUBLEBUFFER OFF.......................................................................................................................................99
Turn off double buffering; use this command once at the end of a sequence of using the double buffer.
$!DOUBLEBUFFER ON ........................................................................................................................................99
Turn on double buffering; use this command once at the beginning of a sequence of using the double buf-
fer. While double buffering is turned on all drawing is sent to the back buffer.
$!DRAWGRAPHICS............................................................................................................................................100
Turn on or off all graphics drawing. Turning off all graphics during preliminary portions of a macro file
can greatly increase the efficiency of the macro.
$!DROPDIALOG .................................................................................................................................................100
Drop a Tecplot 360 interface dialog. To launch a dialog, use $!LAUNCHDIALOG.
$!DUPLICATELINEMAP....................................................................................................................................100
Copy attributes from an existing line mapping to another.
31
$!DUPLICATEZONES......................................................................................................................................... 101
Make a copy of an existing zone or zones. You can use index ranges to create new zone(s) from a subset of
the source zone(s). You may also specify a destination zone to overwrite existing zone(s).
Initially, the duplicate zone shares all variables with the source zone. To branch some or all variables in the
destination zone(s), use $!BRANCHFIELDDATAVAR.
$!ELSE..................................................................................................................................................................... 102
Conditionally handle macro commands. Used when an $!IF statement is FALSE.
$!ELSEIF................................................................................................................................................................. 102
Conditionally handle macro commands. Used to create multiple options for statements should an $!IF
statement be FALSE.
$!EXPORTFINISH................................................................................................................................................ 104
Signals the completion of an animation sequence and causes the animation file to be created. You must call
$!EXPORTSTART prior to using $!EXPORTFINISH. This command is only valid for animation formats. You may
use the |EXPORTISRECORDING| intrinsic variable to make sure that an animation sequence has been initiated.
$!EXTENDEDCOMMAND................................................................................................................................ 106
Send a command to an add-on. The add-on registers the name of a function that will be called when an
$!EXTENDEDCOMMAND is processed. Tecplot 360 knows which registered function to call based on the COMMAND-
PROCESSORID string.
32
$!EXTRACTFROMGEOM..................................................................................................................................107
Extract data from a 2- or 3D field plot. The locations at which to extract the data come from a polyline
geometry that must be picked prior to issuing this command.
$!EXTRACTFROMPOLYLINE ..........................................................................................................................107
Extract data from a 2- or 3D field plot. The locations of where to extract the data from come from a sup-
plied polyline in the form of <xyzrawdata>.
$!FIELDLAYERS ...................................................................................................................................................108
A SetValue command that turns field plot layers on or off, or sets the 2D draw order.
$!FIELDMAP .........................................................................................................................................................109
A SetValue command that assigns zone attributes for field plots. The <set> parameter immediately follow-
ing the $!FIELDMAP command is optional. If <set> is omitted then the assignment is applied to all zones.
Otherwise the assignment is applied only to the zones specified in <set>.
$!FILECONFIG .....................................................................................................................................................112
A SetValue command that sets file path information in Tecplot 360.
$!FONTADJUST ...................................................................................................................................................114
A SetValue command that sets character spacing and sizing for fonts in Tecplot 360. These parameters
rarely change.
$!FOURIERTRANSFORM .................................................................................................................................115
Performs a Fourier transform for each dependent variable for each source zone. A new zone containing the
resulting frequency, amplitude, and phase variables (three for each dependent variable) is created for each
source zone. If the independent variable is non-uniform, the resulting frequency is a modification of the
original data (see discussion below for the INDEPENDENTVAR and OBEYSOURCEZONEBLANKING
parameters). Resulting zones are assigned new time strands using the same groupings as the source zones
if they belong to time stands; otherwise, the resulting zones are static.
Fourier transform result zones are named "Fourier Transform" followed by a mixture of text indicating the
source zone, independent variable, and window function used. Similarly, the three variables created are
given the names "Frequency", "Amplitude", and "Phase" followed by the dependent variable used. Newly-
created zones are assigned passive variables for all variables that previously existed in the data set, and all
previously-existing zones are assigned passive variables for all new variables created by the Fourier trans-
form.
Perform a Fourier transform on variables 2 through 11 of zones 1 through 10 obeying source zone blank-
ing, applying the Hann window function and excluding conjugates from the output.
33
$!FRAMECONTROL ACTIVATETOP............................................................................................................. 117
Changes the active frame to the frame that is topmost in the frame drawing order.
34
$!FRAMECONTROL FITALLTOPAPER .........................................................................................................120
Resize all frames so that they fit inside the hardclip limits of the paper.
$!FRAMELAYOUT ...............................................................................................................................................120
A SetValue command that sets the position, border, and background attributes for the active frame. Use
the $!FRAMECONTROL action command to push and pop frames if you want to change the settings for a frame
other than the active frame.
$!FRAMENAME ...................................................................................................................................................121
Set the name for the active frame.
$!FRAMESETUP...................................................................................................................................................121
A SetValue command that sets parameters used to preset dynamic frame attributes when a frame is initial-
ized.
$!GETAUXDATA ..................................................................................................................................................122
Retrieve Auxiliary Data in the form of name/value pairs from the given location and store it in the macro
variable.
$!GETCONNECTIVITYREFCOUNT...............................................................................................................123
Fetch the count of how many zones share connectivity with the specified zone. Count includes specified
zone.
$!GETCURFRAMENAME..................................................................................................................................123
Query Tecplot 360 for the name of the active frame. The <macrovar> represents the macro variable to receive the
results.
$!GETFIELDVALUE ............................................................................................................................................124
Fetch the field value (data set value) at the specified point index and assign the value to <macrovar>. If the
zone referenced is IJ- or IJK-ordered, then the point index is calculated by treating the 2- or 3Dimensional
array as a 1-D array.
$!GETFIELDVALUEREFCOUNT......................................................................................................................124
Get the count of how many zones share the indicated variable with the specified zone. Count includes the
specified zone.
$!GETNODEINDEX ............................................................................................................................................125
This function only works for finite-element zones. Query for the node index in the specified location as
described by the ZONE, ELEMENT, and CORNER parameters.
$!GETVARLOCATION .......................................................................................................................................125
Returns the location of the variable in the zone as either CELLCENTERED or NODAL and saves in the
macro variable.
35
$!GETVARNUMBYNAME................................................................................................................................. 126
Given a variable name, get the number for that variable. This variable number can then be used to assign
attributes, such as what variable to use for contouring.
$!GLOBALCONTOUR........................................................................................................................................ 127
A SetValue command that changes global attributes associated with contour plots or contour levels. The
optional parameter <contourgroup> refers to the defined contour groups, 1-8, allowed in Tecplot 360, and
takes an integer value of one through eight. The <contourgroup> parameter is optional, and if omitted,
Tecplot 360 will use contour group 1. If you would like the settings in these commands to persist, add
them to your tecplot.cfg file, located in your installation directory. The NUMBERFORMAT setting for LABELS also
controls the number format in the legend.
$!GLOBALEDGE.................................................................................................................................................. 130
A SetValue command that sets attributes which sets the minimum crease angle for edges.
36
$!GLOBALTHREEDVECTOR ...........................................................................................................................137
A SetValue command that changes global attributes associated with 3D vector plots.
$!GLOBALTIME...................................................................................................................................................138
A SetValue command for frames (2D and 3D ONLY). Different frames can have different values of $!GLO-
BALTIME. If you would like the settings in this command to persist, add them to your tecplot.cfg file (located
in your installation directory).
$!GLOBALTWODVECTOR...............................................................................................................................138
A SetValue command that changes global attributes associated with 2D vector plots.
$!IF...$!ENDIF ........................................................................................................................................................140
Conditionally process macro commands.
$!INCLUDEMACRO ...........................................................................................................................................140
Insert the commands from another macro file. Because the $!INCLUDEMACRO command is processed when the
macro is loaded and not when the macro is executed, you are not allowed to reference macro variables
within the <string> parameter.
$!INTERFACE .......................................................................................................................................................140
A SetValue command that sets attributes related to the Tecplot 360 interface.
$!INVERSEDISTINTERPOLATE .....................................................................................................................147
Interpolate selected variables from one or more zones onto a destination zone using the inverse distance
method.
$!ISOSURFACEATTRIBUTES ..........................................................................................................................147
A SetValue command which changes attributes associated with iso-surfaces. The optional group parame-
ter can range from 1-8 and defaults to 1 when absent.
$!ISOSURFACELAYERS.....................................................................................................................................149
Turn iso-surfaces on or off.
$!KRIG....................................................................................................................................................................149
Interpolate selected variables from a set of source zones to a destination zone using the kriging method.
$!LAUNCHDIALOG ...........................................................................................................................................150
Launch a Tecplot 360 interface dialog.
$!LIMITS................................................................................................................................................................150
A SetValue command that sets some of the internal limits in Tecplot 360. See Appendix G: “Functional
Limits” in the User’s Manual for additional information. The $!LIMITS command can only be used in the
Tecplot 360 configuration file.
37
$!LINEARINTERPOLATE.................................................................................................................................. 151
Interpolate selected variables from a set of source zones to a destination zone using linear interpolation.
The source zones cannot be I-ordered. Values assigned to the destination zone are equivalent to the results
of using the probe tool in Tecplot 360.
$!LINKING............................................................................................................................................................ 155
Link attributes in two or more frames so that changes to attributes of one frame effect all linked frames.
$!LOADADDON.................................................................................................................................................. 156
Load an add-on into Tecplot 360. The <string> is the library name of the add-on to load. See Section 30 - 1
“Add-on Loading” in the User’s Manual for instructions on how to specify the add-on’s library name ("lib-
name").
$!LOADCOLORMAP.......................................................................................................................................... 157
Load a color map file. The <string> is the name of the file to load.
$!LOOP...$!ENDLOOP......................................................................................................................................... 157
Process macro commands in a loop. Within the loop you may access the current loop counter using the
intrinsic macro variable |Loop|. Loops may be nested up to 10 levels deep.
$!MACROFUNCTION...$!ENDMACROFUNCTION.................................................................................. 157
Define a macro function. All commands between a $!MACROFUNCTION and the $!ENDMACROFUNCTION are associ-
ated with the macro function NAME. These commands are not executed when they are defined but are exe-
cuted when a $!RUNMACROFUNCTION command is processed. Parameters can be passed to a macro function.
Use |n| to reference the nth parameter. (See $!RUNMACROFUNCTION). In the user-interface, [Crtl]-M
must be pressed, before using the keyboard shortcut specified by the KEYSTROKE option. For example, if the
KEYSTROKE option is set to "P", the user must press [CTRL]-M-P.
$!NEWLAYOUT.................................................................................................................................................... 158
Clear the current layout and start again.
38
$!PAGECONTROL [Required-Control Option] ............................................................................................160
The different commands in the PAGECONTROL compound function family are described separately in the fol-
lowing sections.
$!PAGECONTROL CREATE..............................................................................................................................161
Create a new page. The created page will include an initial frame.
$!PAGECONTROL SETCURRENTTONEXT.................................................................................................161
Set the next page to be the current page.
$!PAGECONTROL SETCURRENTBYNAME................................................................................................161
Set the current page to the page specified.
$!PAGECONTROL DELETE..............................................................................................................................161
Delete the current page. If the command is operated on the only page, then an initial page is created with
an initial frame.
$!PAGECONTROL CLEAR................................................................................................................................161
Clears all frames in the current page and creates a default initial frame.
$!PAGEGETNAME ..............................................................................................................................................162
Action command to get the name of the current page.
$!PAGENAME.......................................................................................................................................................162
Set the name of the page.
$!PAUSE .................................................................................................................................................................162
Stop execution of a macro and optionally display a dialog with a message. If <string> is set to "" then no
dialog is displayed and the user must click in the work area to continue.
Pause and display the message This is the first example plot:
$!PICK ADDATPOSITION................................................................................................................................162
Attempt to pick an object at a specific location on the paper. Does not pop or activate frames.
$!PICK ADDALL..................................................................................................................................................163
Add all objects of a certain type to the list of picked objects.
39
$!PICK ADDALLINRECT .................................................................................................................................. 164
Add objects defined within a specified region to the list of picked objects. The region is defined in terms of
the paper coordinate system. Optional filters can be used to restrict the objects selected. The region is
defined by the two corner points (X1, Y1) and (X2, Y2).
40
$!PLOTTYPE .........................................................................................................................................................169
Changes plot types between valid Tecplot 360 modes such as XYLine and Cartesian2D. Valid options
shown below.
$!POLARAXIS ......................................................................................................................................................169
A SetValue command that assigns attributes for axes in a polar frame.
$!POLARTORECTANGULAR...........................................................................................................................170
Treat the variables currently assigned to X and Y as referring to R and q and convert them to X and Y. In
3D, X, Y and Z refer to R, q, and y. Tecplot 360 has addition capabilities for transforming coordinates,
please see $!TRANSFORMCOORDINATES.
$!POLARVIEW .....................................................................................................................................................170
Sets the viewing style for polar plots in a layout.
$!PRINT..................................................................................................................................................................171
Print the current layout to a printer or send the print instructions to a file. Use the $!PRINTSETUP SetValue
command to configure printing.
$!PRINTSETUP ....................................................................................................................................................171
A SetValue command that sets the attributes for printing. Use $!PRINT to do the actual printing. See
$!EXPORTSETUP and $!EXPORT if you intend to create image files destined for desktop publishing pro-
grams.
$!PROMPTFORFILENAME...............................................................................................................................173
Instruct Tecplot 360 to launch a file selection dialog. The resulting file name will be placed in <macrovar>.
If the user cancels out of the dialog then <macrovar> will be empty (see the example below).
$!PROMPTFORTEXTSTRING ..........................................................................................................................173
Instruct Tecplot 360 to launch a dialog containing a single line text field and optional instructions. The user
enters text into the text field and the resulting string is assigned to <macrovar>.
$!PROMPTFORYESNO ......................................................................................................................................174
Instruct Tecplot 360 to launch a dialog containing two buttons, one labeled Yes and the other No. The
<macrovar> is assigned the string Yes or No depending on the selection.
$!PROPAGATELINKING...................................................................................................................................174
Link multiple frames, either within frame or between frames.
$!PUBLISH ............................................................................................................................................................174
Create an HTML file displaying one or more images. A linked layout with packaged data may be
included. You must provide the file name.
41
$!QUIT.................................................................................................................................................................... 175
Terminate the execution of the Tecplot 360 program.
$!READDATASET................................................................................................................................................ 176
The $!READDATASET macro command has two separate uses. The parameters available for the com-
mand are dependent upon the intended use. It may either be used to load data in Tecplot 360’s file format
(*.plt or *.dat) or in a foreign data file format. To load data in Tecplot 360’s file format, use the parameters
listed in Table 9 - 2. To load data in a foreign file format, use the parameters listed in Table 9 - 1 along with
a set of name/value pairs. The name/value pairs are specific to the data loader and described in Chapter 4:
“Loading Data” in the User’s Manual.
$!READSTYLESHEET......................................................................................................................................... 178
Read in a stylesheet file. The <string> is the name of the file to read.
$!REDISTRIBUTECOLORMAPCONTROLPOINTS................................................................................... 178
Redistributes control points for the named color map, which must exist and must be a custom color map
(not a built-in color map such as "Small Rainbow").
$!REDRAWALL..................................................................................................................................................... 179
Redraw all frames.
$!REMOVEVAR.................................................................................................................................................... 179
Remove a user-defined macro variable. This frees up space so another user-defined macro variable can be
defined.
$!RENAMECOLORMAP.................................................................................................................................... 179
Renames a custom color map.
$!RENAMEDATASETVAR................................................................................................................................. 180
Rename a data set variable in Tecplot 360.
$!RESET3DAXES.................................................................................................................................................. 181
Reset the ranges on the 3D axes.
42
$!RESET3DORIGIN ............................................................................................................................................181
Reposition the rotation origin in 3D to be at the specified location.
$!RESET3DSCALEFACTORS............................................................................................................................181
Recalculate the scale factors for the 3D axes. Aspect ratio limits are taken into account.
$!RESETRAWUSERDEFINEDCOLORMAP ..................................................................................................181
Resets the raw user-defined color map to the color map named by SOURCECOLORMAP.
$!RESETVECTORLENGTH...............................................................................................................................182
Reset the length of the vectors. Tecplot 360 will find the vector with the largest magnitude and set the scal-
ing factor so it will appear on the screen using the length specified by $!FRAMESETUP VECTDEFLEN.
$!ROTATE2DDATA .............................................................................................................................................182
Rotate field data in 2D about any point. See also $!ROTATEDATA.
$!ROTATE3DVIEW..............................................................................................................................................182
Do a 3D rotation about a given axis. The <rotateaxis> must be supplied.
$!ROTATEDATA...................................................................................................................................................183
$!RUNMACROFUNCTION ..............................................................................................................................184
Execute commands defined in a macro function. The <string> references the name of the macro function to
run. If the macro command requires parameters, then include them (within parentheses) after the macro
command name.
$!SAVELAYOUT ...................................................................................................................................................184
Save the current layout to a file. You must supply the file name.
$!SET3DEYEDISTANCE.....................................................................................................................................185
Sets the distance from the viewer to the plane of the current center of rotation.
$!SETARBITRARYSLICEUSINGTHREEPOINTS ........................................................................................185
Set the orientation of an arbitrarily-oriented slice by specifying the X, Y, and Z coordinates of three points
on a plane. The three points must not be coincident or collinear. The slice’s origin is set to the third point
and its normal is recalculated such that the cutting plane passes through all three points.
$!SETAUXDATA ...................................................................................................................................................186
Add Auxiliary Data in the form of name/value pairs to layouts, zones, frames or datasets. The name must
begin with an underscore or letter, and may be followed by one or more underscore, period, letter, or digit
characters.
$!SETDATASETTITLE ........................................................................................................................................187
Set the title for the current data set.
43
$!SETFIELDVALUE ............................................................................................................................................. 187
Specify a field value (data set value) at a specified point index. If the zone referenced is IJ- or IJK-ordered
then the point index is calculated by treating the 2- or 3D array as a 1-D array.
$!SETSTYLEBASE................................................................................................................................................ 188
Instruct Tecplot 360 on how to initialize frame style values when a new frame is created. During normal
operation, Tecplot 360 bases the style of a new frame on the factory defaults plus any changes assigned in
the Tecplot 360 configuration file. Layout files and stylesheet files, however, rely on Tecplot 360 basing
new frames only on the factory defaults. This command is typically not used by the casual user.
$!SHARECONNECTIVITY................................................................................................................................ 188
Share the nodemap between the source and destination zones, presuming that the zones are FE and have
the same element type and number of nodes.
$!SHAREFIELDDATAVAR................................................................................................................................. 189
Allows sharing of the specified variable from the source zone to the destination zone. Zone must be of the
same type (ordered or FE) and dimensions. Cell centered variables in FE must have the same number of
cells. Sharing is not allowed if either zone has global face neighbors.
$!SHIFTLINEMAPSTOBOTTOM.................................................................................................................... 189
Shift a list of Line-mappings to the bottom of the Line-mapping list. This in effect causes the selected Line-
mappings to be drawn last.
$!SKETCHAXIS.................................................................................................................................................... 190
A SetValue command that assigns attributes for axes in a sketch mode frame. Axes are rarely used in
sketch frames.
$!SLICEATTRIBUTES......................................................................................................................................... 190
A SetValue command that changes global attributes associated with slices.
44
$!SLICELAYERS ...................................................................................................................................................193
Turn slicing on or off.
$!SMOOTH ...........................................................................................................................................................193
Smooth data (reduce the spikes) for selected variables in selected zones.
$!STREAMATTRIBUTES ...................................................................................................................................194
A SetValue command that changes global attributes associated with streamtraces.
$!STREAMTRACE RESETDELTATIME..........................................................................................................198
Reset the time delta for dashed streamtraces. The delta time is reset such that a stream dash in the vicinity
of the maximum vector magnitude will have a length approximately equal to 10 percent of the frame
width.
$!STREAMTRACELAYERS ...............................................................................................................................199
Turn streamtraces on or off.
$!SYSTEM..............................................................................................................................................................199
Instruct Tecplot 360 to submit a command to the operating system. For security reasons, execution of the
$!SYSTEM command can be disabled to prevent unauthorized execution of system commands via macros.
Use the OKTOEXECUTESYSTEMCOMMAND option to the $!INTERFACE macro command.
$!THREEDAXIS....................................................................................................................................................200
A SetValue command that assigns attributes for axes in a 3D frame.
45
$!THREEDVIEW .................................................................................................................................................. 201
A SetValue command that changes global attributes associated with the 3D view.
$!TRANSFORMCOORDINATES..................................................................................................................... 201
Transforms all points in one or more zones from one coordinate system to another.
46
$!VIEW FIT ............................................................................................................................................................207
Fit the entire plot to the grid area. This also takes into consideration text and geometries that are plotted
using the grid coordinate system. In 3D, this also includes the axes.
$!VIEW FITSURFACES.......................................................................................................................................207
Fits active plot surfaces to the grid area. 3D volume zones are excluded when surfaces to plot are set to
none. See $!FIELDMAP for more information on setting surfaces to plot.
$!VIEW LAST........................................................................................................................................................207
Retrieve the previous view from the view stack. Each frame mode within each frame maintains its own
view stack. $!VIEW LAST will not reverse alterations to data.
$!VIEW NICEFIT..................................................................................................................................................208
Change view to make the extents of the frame neatly hold the plot with integer values for axis labels. Only
works in Sketch/XY/2D.
$!VIEW PASTE......................................................................................................................................................208
Retrieve the view from the view paste buffer and assign it to the active frame.
$!VIEW TRANSLATE..........................................................................................................................................209
Shift the data being plotted in the X- and/or Y-direction. The amount translated is in frame units.
47
the view is rotated about the viewer and scaled to fit the region. X1 and so forth are measured in grid coor-
dinates.
$!WHILE...$!ENDWHILE.................................................................................................................................... 210
Continue to execute a set of commands until a conditional expression is NO.
48
$!WRITEDATASET ..............................................................................................................................................213
Write the data set attached to the active frame to a file. The <string> is the name of the file to write to.
$!WRITESTYLESHEET .......................................................................................................................................214
Write the style for the active frame to a file. The <string> is the name of the file to write to.
$!XYLINEAXIS......................................................................................................................................................215
A SetValue command that assigns attributes for axes in an XY Line plot.
Set the axis mode to be independent for the XY-axes (note that this affects only X1 versus Y1):
ANIMATESTREAKLINES .................................................................................................................................219
Animates previously calculated streaklines to the screen or to a file.
ATTACHINTEGRATIONRESULTS.................................................................................................................219
Attach the text results of the previous integration as a text field in the active frame.
CALCPARTICLEPATH .......................................................................................................................................219
Calculate particle paths or streaklines, starting from existing Tecplot 360 streamtraces.
CALCTURBULENCEFUNCTION....................................................................................................................222
Calculate a turbulence-related function from two variables in the current data set. Add the result to the
data set as a new variable using the function’s name, or overwrite the variable if it already exists.
CALCULATE.........................................................................................................................................................222
Calculate a Tecplot 360 variable using the specified function and add it to the current data set. If the vari-
able already exists in the current data set, it will be recalculated.
CALCULATEACCURACY .................................................................................................................................223
Calculate the order accuracy of the solution contained in the listed zones. Optionally, plot the overall accu-
racy versus grid spacing and plot the accuracy at each grid node.
DISPLAYBOUNDARIES....................................................................................................................................224
Displays boundaries corresponding to a geometry and boundaries specification without actually setting
the geometry and boundaries. This macro is generally not useful for those writing macro files, but is
recorded when the user clicks the Display Boundaries button in the Geometry and Boundaries dialog in
order to duplicate the actions of Tecplot 360 that happen in response to that action. See Section “SETGE-
OMETRYANDBOUNDARIES” on page 230 for a description of the parameters for this macro.
EXTRACTFLOWFEATURE................................................................................................................................224
Extract and display shock surfaces, vortex cores, or separation and attachment lines. Shock surfaces are
displayed as iso-surfaces of a new variable, ShockSurface, while vortex cores and separation and attach-
ment lines are displayed as new zones.
49
EXTRAPOLATESOLUTION ............................................................................................................................. 225
Perform Richardson extrapolation to estimate the true solution from three input solutions on grids of suc-
cessively finer resolution. Two new zones are added to the current data set. The first contains the extrapo-
lated solution, while the second contains the estimated error.
SETFIELDVARIABLES....................................................................................................................................... 228
Identifies variables in your data, such as velocity, pressure and temperature, for use in analysis.
SETGEOMETRYANDBOUNDARIES............................................................................................................. 230
Specify whether the data represent an axisymmetric flow solution (2D Cartesian plots only), whether adja-
cent zones should be considered to be connected at coincident faces, and specify zone boundaries and
their corresponding boundary conditions. Each line of the RAWDATA describes one boundary, and appears in
the same format as on the Geometry and Boundaries dialog. For all boundaries, list the boundary condi-
tion and the set of zones, separated by a comma. The index range-type boundary follows this with the
boundary face, the first starting index, the first ending index, the second starting index and the second
ending index. All entries are separated by commas. The boundary condition is one of INFLOW, OUTFLOW, WALL,
SLIPWALL, SYMMETRY, EXTRAPOLATED. The boundary face is one of I=1, I=IMAX, J=1, J=JMAX, K=1, and K=KMAX. Refer
to Section 21 - 4 “Setting Geometry and Boundary Options” in the User’s Manual for more information on
boundaries.
SETUNSTEADYFLOWOPTIONS.................................................................................................................... 231
Identifies time levels for unsteady flow, or specifies that the solution is steady-state. If the flow is
unsteady, the solution time levels are specified in the RAWDATA section. The first line of the RAWDATA section
must consist of a single integer indicating the number of solution time levels. This must be followed by the
time levels themselves. Each time level must be on a separate line and must consist of a floating-point
number (the solution time), as well as one or more integers (the zone numbers for that solution time).
<<anchorpos>>....................................................................................................................................................... 237
Assign attributes for positioning of objects.
50
<<areastyle>> .........................................................................................................................................................238
Change settings for the axis grid area.
<<axisdetail>> ........................................................................................................................................................238
Assign attributes for axes.
<<axisline>> ...........................................................................................................................................................239
Assign attributes for axis lines.
<<axistitle>> ...........................................................................................................................................................240
Assign attributes for titles.
<<basiccolorcontrol>> ..........................................................................................................................................241
Assign name to a basic color.
<<basicsizelist>> ...................................................................................................................................................241
Assign basic sizes. The units for the values assigned here are dependent on the parent command. Assign-
ments here do not affect the plot. These assignments are used only to configure drop-down menus in the
interface so the user can make quick selections.
<<colormapcontrolpoints>> ................................................................................................................................242
All contour color maps except the Raw user-defined color map make use of control points to determine
the color distribution. Each control point has a position and a left and right color. The <<colormapcontrol-
points>> subcommand can contain more than one CONTROLPOINT subcommand.
<<colormapoverride>> .........................................................................................................................................242
Change settings for a color map override. Color map overrides are used to replace a specific band in a con-
tour color map with one of the 16 basic colors.
<<continuouscolor>> ............................................................................................................................................243
Change settings for continuous color.
<<dialogplacement>> ...........................................................................................................................................243
Describes the placement for a dialog.
<<gridarea>> ..........................................................................................................................................................244
Change settings for the axis grid area.
<<gridlinedetail>> ................................................................................................................................................245
Change settings for axis gridlines.
<<ijk>> ....................................................................................................................................................................246
Set an I-, J-, or K-index.
51
<<indexrange>> ..................................................................................................................................................... 246
Set an index range.
<<numberformat>>............................................................................................................................................... 247
Set the format used to draw a number.
<<rect>>................................................................................................................................................................... 248
Change settings for a rectangle. The rectangle is defined using two points (X1,Y1) and (X2,Y2).
<<shademap>>....................................................................................................................................................... 251
Map colors on the screen to shades of gray for monochrome hardcopy output.
<<tickmarkdetail>>............................................................................................................................................... 255
Assign attributes for axis tick marks.
52
<<volumeobjectstoplot>> ....................................................................................................................................256
Specifies what volume objects are to be displayed.
<<xy>> .....................................................................................................................................................................257
Change settings for an (X,Y) position.
<<xyz>> ...................................................................................................................................................................257
Change settings for an (X, Y, Z) triplet.
<<zebrashade>>.....................................................................................................................................................257
Change zebra shading attributes.
53
54
9
Macro Commands
This chapter lists Tecplot 360’s macro commands alphabetically. Optional parameters are enclosed within
square brackets ( [ ] ). Items within double angle brackets (<< >>) represent parameter sub-commands
listed and described in Chapter 11: “Parameter Subcommands”.
$!ACTIVEFIELDMAPS
Examples:
Example 1:
Make only field maps 1, 3, 4 and 5 active for plotting:
$!ACTIVEFIELDMAPS = [1,3-5]
Example 2:
Add zones 33, 34, 35, and 36 to the set of active field maps:
$!ACTIVEFIELDMAPS += [33-36]
55
Example 3:
Remove zones 1, 2, 3, 9, 10 and 11 from the set of active field maps:
$!ACTIVEFIELDMAPS -= [1-3,9-11]
$!ACTIVELINEMAPS
Example 1:
Make only line-mappings 1, 3, 4 and 5 active for plotting:
$!ACTIVELINEMAPS = [1,3-5]
Example 2:
Add line-maps 33, 34, 35 and 36 to the set of active line-mappings:
$!ACTIVELINEMAPS += [33-36]
Example 3:
Remove line-maps 1, 2, 3, 9, 10 and 11 from the set of active line-mappings:
$!ACTIVELINEMAPS -= [1-3,9-11]
$!ADDMACROPANELTITLE
$!ALTERDATA
56
on which to operate, where zonelist is a list of zones or zone ranges separated by a comma (“,”).
Zone ranges are separated by a hyphen (“-”). If <zonelist> is omitted, all zones are affected. NOTE:
the values for the <zonelist> parameter must be enclosed in square brackets. (For example, use
$!ALTERDATA [1,3] to apply ALTERDATA to zones 1 and 3).
Required Parameters
Parameter Syntax Default Notes
EQUATION = <string> This assigns the equation to use to operate on the data.
Optional Parameters
Parameter Syntax Default Notes
DATATYPE = <datatype> SINGLE Assign the precision given to the destination variable (that is,
the variable on the left hand side of the equation). This only
applies if the equation creates a new variable. (See Example 2:)
IGNOREDIVIDEBYZERO = <boolean> NO If YES, the equation will be processed even if it includes a
division by zero. 0/0 will result in 0, while other divisions will
return the largest or smallest possible result depending on the
sign of the dividend. If NO, an equation with a division by
zero will not be processed at all.
IRANGE See Range Parameters, following, for information on
specifying range index values.
{
MIN = <integer> 1
MAX = <integer> 0
SKIP = <integer> 1
}
JRANGE See Range Parameters, following, for information on
specifying range index values.
{
MIN = <integer> 1
MAX = <integer> 0
SKIP = <integer> 1
}
KRANGE See Range Parameters, following, for information on
specifying range index values.
{
MIN = <integer> 1
MAX = <integer> 0
SKIP = <integer> 1
}
VALUELOCATION = <valuelocation> AUTO Assign the location to destination variable.
Range Parameters
The IRANGE, JRANGE, and KRANGE parameters limit the data altered by the equation. The specification of
range indices follow these rules:
• All indices start with 1 and go to some maximum index m.
• The number 0 can be used to represent the maximum index m. If the maximum index m = 15,
specifying 0 sets the range index to 15.
• Negative values represent the offset from the maximum index. If a value of -2 is specified, and
the maximum index m is 14, the value used is 14-2, or 12.
57
Examples:
Example 1:
The following example adds one to X for zones 1 and 3 for every data point:
$!ALTERDATA [1,3]
EQUATION = "x = x+1"
Example 2:
The following example creates a new, double precision variable called DIST:
$!ALTERDATA
EQUATION = "{DIST} = SQRT(X**2 + Y**2)"
DATATYPE = DOUBLE
Example 3:
The following equations set a variable called P to zero along the boundary of an IJ-ordered zone:
$!ALTERDATA
EQUATION = "{P} = 0"
IRANGE {MAX = 1}
$!ALTERDATA
EQUATION = "{P} = 0"
IRANGE {MIN = 0}
$!ALTERDATA
EQUATION = "{P} = 0"
JRANGE {MAX = 1}
$!ALTERDATA
EQUATION = "{P} = 0"
JRANGE {MIN = 0}
Example 4:
By following a variable reference with brackets “[” and “]” you may designate a specific zone from which
to get the variable value. For example:
V3 = V3 -V3[1]
X = (X[1] + X[2] + X[3]) / 3
{TempAdj} = {Temp}[7] - {Adj}
V7 = V1[19] - 2*C[21] + {R/T}[18]
The zone number must be a positive integer constant less than or equal to the number of zones. The zone
designated must have the same structure (finite-element, I-, IJ-, or IJK-ordered) and dimensions (number
of nodes and so forth)
$!ANIMATECONTOURLEVELS
Syntax: $!ANIMATECONTOURLEVELS
START = <integer>
END = <integer>
[optional parameters]
Description:Produce an animation of a contour line plot by showing a single level at a time. The animation
varies according to the currently defined contour levels and is limited by the values in the START,
END, and SKIP parameters. To create a movie file, add $!EXPORTSETUP commands before this
58
command.
Required Parameters
Parameter Syntax Default Notes
START = <integer> Starting contour level number to animate.
END = <integer> Ending contour level number to animate.
Optional Parameters
Parameter Syntax Default Notes
CREATEMOVIEFILE = <boolean> NO If YES, must be preceded by $!EXPORTSETUP commands.
SKIP = <integer> 1 Level skip.
Example: The following command animates the first four contour levels to an AVI file:
$!ANIMATEIJKBLANKING
Syntax: $!ANIMATEIJKBLANKING
NUMSTEPS = <integer>
[optional parameters]
Description:Produce an animation of different IJK-blankings in your plot. The animation starts at one IJK-
blanking setting and marches through intermediate steps to a second setting. To create a movie file,
add $!EXPORTSETUP commands before this command.
59
Required Parameter
Parameter Syntax Default Notes
NUMSTEPS = <integer> Number of intermediate steps for the animation.
Optional Parameters
Parameter Syntax Default Notes
IMINFRACT = <dexp> 0.1 Minimum fraction for blanking at the start of animation for the
I-index. Actual I-index is equal to IMINFRACT*IMAX.
JMINFRACT = <dexp> 0.1 Minimum fraction for blanking at the start of animation for the
J-index. Actual J-index is equal to JMINFRACT*JMAX.
KMINFRACT = <dexp> 0.1 Minimum fraction for blanking at the start of animation for the
K-index. Actual K-index is equal to KMINFRACT*KMAX.
IMAXFRACT = <dexp> 1.0 Maximum fraction for blanking at the start of animation for the
I-index. Actual I-index is equal to IMAXFRACT*IMAX.
JMAXFRACT = <dexp> 1.0 Maximum fraction for blanking at the start of animation for the
J-index. Actual J-index is equal to JMAXFRACT*JMAX.
KMAXFRACT = <dexp> 1.0 Maximum fraction for blanking at the start of animation for the
K-index. Actual K-index is equal to KMAXFRACT*KMAX.
IMINFRACT2 = <dexp> 0.8 Minimum fraction for blanking at the end of animation for the
I-index. Actual I-index is equal to IMINFRACT*IMAX.
JMINFRACT2 = <dexp> 0.8 Minimum fraction for blanking at the end of animation for the
J-index. Actual J-index is equal to JMINFRACT*JMAX.
KMINFRACT2 = <dexp> 0.8 Minimum fraction for blanking at the end of animation for the
K-index. Actual K-index is equal to KMINFRACT*KMAX.
IMAXFRACT2 = <dexp> 1.0 Maximum fraction for blanking at the end of animation for the
I-index. Actual I-index is equal to IMAXFRACT*IMAX.
JMAXFRACT2 = <dexp> 1.0 Maximum fraction for blanking at the end of animation for the
J-index. Actual J-index is equal to JMAXFRACT*JMAX.
KMAXFRACT2 = <dexp> 1.0 Maximum fraction for blanking at the end of animation for the
K-index. Actual K-index is equal to KMAXFRACT*KMAX.
CREATEMOVIEFILE = <boolean> NO If YES, must be preceded by $!EXPORTSETUP commands.
LIMITSCREENSPEED = <boolean> NO Whether to limit the maximum number of frames per second
for animations displayed on the screen. See
MAXSCREENSPEED.
MAXSCREENSPEED = <double> If LIMITSCREENSPEED is true, sets the maximum number of
frames per second for animations displayed on the screen. If
CREATEMOVIEFILE is true, this setting is ignored.
Example:
The following example produces an animation showing a band of I-planes traversing the entire data field:
$!ANIMATEIJKBLANKING
NUMSTEPS = 6
IMINFRACT = 0.1
JMINFRACT = 0.0
KMINFRACT = 0.0
IMAXFRACT = 1.0
JMAXFRACT = 1.0
KMAXFRACT = 1.0
IMINFRACT2 = 1.0
JMINFRACT2 = 0.0
KMINFRACT2 = 0.0
IMAXFRACT2 = 1.0
JMAXFRACT2 = 1.0
KMAXFRACT2 = 1.0
60
$!ANIMATEIJKPLANES
Syntax: $!ANIMATEIJKPLANES
START = <integer>
END = <integer>
[optional parameters]
Description:Produce an animation that cycles through I-, J-, or K-planes in an IJK-ordered data set. To create
a movie file, add $!EXPORTSETUP commands before this command.
Required Parameters
Parameter Syntax Default Notes
START = <integer> Starting plane index
END = <integer> Ending plane index
Optional Parameters
Parameter Syntax Default Notes
CREATEMOVIEFILE = <boolean> NO If YES, must be preceded by $!EXPORTSETUP commands
LIMITSCREENSPEED = <boolean> NO Whether to limit the maximum number of frames per second
for animations displayed on the screen. See
MAXSCREENSPEED.
MAXSCREENSPEED = <double> If LIMITSCREENSPEED is true, sets the maximum number of
frames per second for animations displayed on the screen. If
CREATEMOVIEFILE is true, this setting is ignored.
PLANES = <ijkplane> I Specify I, J or K
SKIP = <integer> 1 Index skip
$!ANIMATEIJKPLANES
PLANES = I
START = 1
END = 9
SKIP = 2
$!ANIMATEISOSURFACES
Syntax: $!ANIMATEISOSURFACES
STARTVALUE = <double>
ENDVALUE = <double>
[optional parameters]
Description:The macro command $!ANIMATEISOSURFACES produces an animation of a series of iso-surfaces
beginning with the iso-surface defined by STARTVALUE and ending with the iso-surface defined by
ENDVALUE. To create a movie file, add $!EXPORTSETUP commands before this command.
61
Required Parameters
Parameter Syntax Default Notes
ENDVALUE = <integer> ENDVALUE is the value of the contour variable for the last iso-
surface in the animation.
NUMSTEPS = <integer> 2 Number of iso-surfaces to distribute between the start and end
iso-surfaces values.
STARTVALUE = <integer> STARTVALUE is the value of the contour variable for the first
iso-surface in the animation.
Optional Parameters
Parameter Syntax Default Notes
CREATEMOVIEFILE = <boolean> NO If YES, must be preceded by $!EXPORTSETUP commands.
GROUP = <integer> 1 values 1- 8
LIMITSCREENSPEED = <boolean> NO Whether to limit the maximum number of frames per second
for animations displayed on the screen. See
MAXSCREENSPEED.
MAXSCREENSPEED = <double> If LIMITSCREENSPEED is true, sets the maximum number of
frames per second for animations displayed on the screen. If
CREATEMOVIEFILE is true, this setting is ignored.
Go To, Loop, Bounce, Forward, and Backward are only used by the interface. Forward and Backward can be
simulated using appropriate values STARTVALUE and ENDVALUE. If ENDVALUE < STARTVALUE,
the animation goes 'backward'. If ENDVALUE > STARTVALUE, the animation goes 'forward'. Goto can be
simulated if ENDVALUE == STARTVALUE. That is, it can be simulated if the animation goes 'one step'.
Loop and Bounce can be accomplished by animating the file multiple times.
When recording, the macro recorded contains exactly the animation done in the
interface. So if you bounce three times through the data, you will record three sets of
forward and backwards commands. Similarly, if you use the "one step" options a lot,
you will record a lot of individual macro commands. If you interrupt part way through an
animation, you will record a partial animation macro of those steps you did animate
through.
$!ANIMATEISOSURFACES
STARTVALUE = 1
ENDVALUE = 30
NUMSTEPS = 30
$!ANIMATELINEMAPS
Syntax: $!ANIMATELINEMAPS
START = <integer>
END = <integer>
[optional parameters]
Description:Produce an animation of one Line-mapping at a time. To create a movie file, add $!EXPORTSETUP
commands before this command.
62
Required Parameters
Parameter Syntax Default Notes
START = <integer> Starting Line-map number
END = <integer> Ending Line-map number
Optional Parameters
Parameter Syntax Default Notes
CREATEMOVIEFILE = <boolean> NO If YES, must be preceded by $!EXPORTSETUP commands
LIMITSCREENSPEED = <boolean> NO Whether to limit the maximum number of frames per second
for animations displayed on the screen. See
MAXSCREENSPEED.
MAXSCREENSPEED = <integer> If LIMITSCREENSPEED is true, sets the maximum number of
frames per second for animations displayed on the screen. If
CREATEMOVIEFILE is true, this setting is ignored.
SKIP = <integer> 1 Line-map skip
Example:
The following example creates an animation showing plots of Line-maps 2, 4, 6, 8 and 10:
$!ANIMATELINEMAPS
START = 2
END = 10
SKIP = 2
$!ANIMATESLICES
63
Required Parameters
Parameter Syntax Default Notes
START = <integer> START and END are measured in steps based on NUMSLICES
between the slice group's start slice value (at step=1) and end
slice values (at step = NumSlices).
END = <integer> START and END are measured in steps based on NUMSLICES
between the slice group's start slice value (at step=1) and end
slice values (at step = NumSlices).
NUMSLICES = <integer> Number of slices to distribute between the start and end slice
locations as defined by START and END in
$!SLICEATTRIBUTES.
Optional Parameters
Parameter Syntax Default Notes
GROUP = <integer> 1 values 1- 8
CREATEMOVIEFILE = <boolean> NO If YES, must be preceded by $!EXPORTSETUP commands.
LIMITSCREENSPEED = <boolean> Whether to limit the maximum number of frames per second
for animations displayed on the screen. See
MAXSCREENSPEED.
MAXSCREENSPEED = <double> If LIMITSCREENSPEED is true, sets the maximum number of
frames per second for animations displayed on the screen. If
CREATEMOVIEFILE is true, this setting is ignored.
Go To, Loop, Bounce, Forward, and Backward are only used by the interface. Forward and Backward can be
simulated using appropriate values STARTVALUE and ENDVALUE. If ENDVALUE < STARTVALUE,
the animation goes 'backward'. If ENDVALUE > STARTVALUE, the animation goes 'forward'. Goto can be
simulated if ENDVALUE == STARTVALUE, i.e. the animation goes 'one step'. Loop and Bounce can be
accomplished by calling the file multiple times.
When recording, the macro recorded contains exactly the animation done in the
interface. So if you bounce three times through the data, you will record three sets of
forward and backwards commands. Similarly, if you use the "one step" options a lot,
you will record a lot of individual macro commands. If you interrupt part way through an
animation, you will record a partial animation macro of those steps you did animate
through.
$!ANIMATESLICES
START = 1
END = 30
NUMSLICES = 30
$!ANIMATESTREAM
Syntax: $!ANIMATESTREAM
[optional parameters]
Description:Produce an animation of stream markers or dashes, moving along the currently defined
streamtrace paths. To create a movie file, add $!EXPORTSETUP commands before this command.
64
Optional Parameters
Parameter Syntax Default Notes
CREATEMOVIEFILE = <boolean> NO If YES, must be preceded by $!EXPORTSETUP commands
NUMCYCLES = <integer> 3 Number of cycles in the animation. Each cycle shows stream
markers or dashes, moving along a streamtrace path. If DT is
the streamtrace delta time, then at the end of the cycle, the
markers or dashes will have moved
(2*DT*(STEPSPERCYCLE-1))/(STEPSPERCYCLE) in time.
STEPSPERCYCLE = <integer> 20 Number of steps to use for each cycle of the animation.
Increase this number to produce a smoother animation.
Example:
The following example animates streamtraces for five cycles with each cycle using ten steps:
$!ANIMATESTREAM
STEPSPERCYCLE = 10
NUMCYCLES = 5
$!ANIMATETIME
Syntax: $!ANIMATETIME
[optional parameters]
Description:Produce an animation of transient data. To create a movie file, add $!EXPORTSETUP commands
before this command.
Optional Parameters:
Parameter Syntax Default Notes
CREATEMOVIEFILE = <boolean> NO If YES, must be preceded by $!EXPORTSETUP commands.
ENDTIME = <double> The last timestep If the SolutionTime entered does not exist, the nearest
as defined by the SolutionTime less than the entered time is used.
currently active
strands
LIMITSCREENSPEED = <boolean> NO Whether to limit the maximum number of frames per second
for animations displayed on the screen. See
MAXSCREENSPEED.
MAXSCREENSPEED = <double> 12 If LIMITSCREENSPEED is true, sets the maximum number of
frames per second for animations displayed on the screen. If
CREATEMOVIEFILE is true, this setting is ignored.
SKIP = <integer> 1
STARTTIME = <double> first time step as If the SolutionTime entered does not exist, the nearest
defined by the SolutionTime less than the entered time is used.
currently active
strands
Go To, Loop, Bounce, Forward, and Backward are only used by the interface. Forward and Backward can be
simulated using appropriate values STARTVALUE and ENDVALUE. If ENDVALUE < STARTVALUE, the animation goes
'backward'. If ENDVALUE > STARTVALUE, the animation goes 'forward'. Goto can be simulated if ENDVALUE ==
65
STARTVALUE, i.e. the animation goes 'one step'. Loop and Bounce can be accomplished by calling the file
multiple times.
When recording a macro, that macro animates exactly as done in the interface. So if
you bounce three times through the data, you will record three sets of forward and
backwards commands. Similarly, if you use the "one step" options a lot, you will record
a lot of individual macro commands. If you interrupt part way through an animation,
you will record a partial animation macro of those steps you did animate through.
$!ANIMATEZONES
Syntax: $!ANIMATEZONES
START = <integer>
END = <integer>
[optional parameters]
Description:Produce an animation showing one zone at a time. To create a movie file, add $!EXPORTSETUP
commands before this command. This command will not work if the active frame contains a
transient data set.
Required Parameters
Parameter Syntax Default Notes
START = <integer> Starting zone number
END = <integer> Ending zone number
Optional Parameters
Parameter Syntax Default Notes
CREATEMOVIEFILE = <boolean> NO If YES, must be preceded by $!EXPORTSETUP
commands.
LIMITSCREENSPEED = <boolean> NO Whether to limit the maximum number of frames
per second for animations displayed on the screen.
See MAXSCREENSPEED.
MAXSCREENSPEED = <integer> If LIMITSCREENSPEED is true, sets the maximum
number of frames per second for animations
displayed on the screen. If CREATEMOVIEFILE is
true, this setting is ignored.
SKIP = <integer> 1 Zone skip.
ZONEANIMATIONMODE = [STEPBYNUMBER, STEPBYNUMBER
GROUPSTEPBYNUMBER,
STEPBYTIME]
Example: The following example animates just the first five zones:
$!ANIMATEZONES
START = 1
END = 5
$!ATTACHDATASET
Syntax: $!ATTACHDATASET
[optional parameter]
Description:Attach the active frame to the data set of another frame. Use PAGENUM, if the other frame is on
a difference page. This command is usually found only in layout files generated by Tecplot 360.
66
Note that the $!PLOTTYPE command automatically executes an $!ATTACHDATASET command if a
frame mode is requested in a frame that does not have an attached data set. Tecplot 360 attaches
the data set from the closest frame (in drawing order) having an attached data set.
Optional Parameter
Parameter Syntax Default Notes
FRAME = <integer> First frame with Within the page specified or implied, if FRAME is not
a data set supplied, Tecplot 360 searches for a data set in a frame below
the topmost frame of the page to attach.
PAGENUM = <integer> current page If PAGENUM is not supplied the current page is used.
Examples:
Example 1:
The following example attaches to the active frame the data set from the second frame drawn when doing
a Redraw All:
$!ATTACHDATASET
FRAME = 2
Example 2:
The following example attaches to the active frame the data set from the frame drawn next-to-last when
doing a Redraw All:
$!ATTACHDATASET
$!ATTACHGEOM
Syntax: $!ATTACHGEOM
[optional parameters]
<geometryrawdata>
Description:Attach a geometry to the active frame.
67
Required Parameter
Parameter Syntax Default Notes
<geometryrawdata> This is the data which defines the size and relative shape of the
geometry. This must be at the end of the command after any
other parameters.
Optional Parameters
Parameter Syntax Default Notes
ANCHORPOS <<anchorpos>> This assigns the anchor position of the
geometry.
ARROWHEADANGLE = <dexp> 12 Set the angle for arrowheads (in degrees).
ARROWHEADATTACHMENT = <arrowheadattachment> NONE
ARROWHEADSIZE = <dexp> 5% Set the arrowhead size in Y-frame units (0-100).
ARROWHEADSTYLE = <arrowheadstyle> PLAIN
ATTACHTOZONE = <boolean> NO If YES, must include ZONE.
CLIPPING = <clipping> CLIPTTOVIEWPORT
COLOR = <color> BLACK
DATATYPE = <fielddatatype> FLOAT
DRAWORDER = <draworder> AFTERDATA
FILLCOLOR = <color> WHITE
GEOMTYPE = <geomtype> LINESEGS
IMAGEFILENAME = <string>
ISFILLED = <boolean>
LINEPATTERN = <linepattern> SOLID
LINETHICKNESS = <dexp> 0.1% Set the line thickness in Y-frame units (0-100).
MACROFUNCTIONCOMMAND = <string> Null Set the macro command to execute when you
hover over the geometry and press Ctrl-right-
click. For security reasons this command can
only be used in the Tecplot 360 configuration
file.
MAINTAINASPECTRATIO = <boolean> YES
NUMELLIPSEPTS = <integer> 72 Numbers of points to use when drawing
ellipses and circles.
PATTERNLENGTH = <dexp> 2% Set the pattern length in Y-frame units (0-100).
POSITIONCOORDSYS = <coordsys> GRID
RESIZEFILTER = <resizefilter>
SCOPE = <scope> LOCAL Set the scope to GLOBAL to draw this
geometry in all “like” frames.
TEXTUREFILTER CUBIC
ZONE = <integer> 1 This is only used if ATTACHTOZONE = YES.
This geometry is disabled if the zone assigned
here is inactive.
Examples:
Example 1:
The following example creates a red circle, with a radius equal to 25 percent of the height of the frame, in
the center of the frame:
$!ATTACHGEOM
POSITIONCOORDSYS = FRAME
ANCHORPOS
{
X = 50
Y = 50
68
}
GEOMTYPE = CIRCLE
COLOR = RED
RAWDATA
25
Example 2:
The following example creates an L-shaped polyline with an arrowhead at the end:
$!ATTACHGEOM
POSITIONCOORDSYS = FRAME
ANCHORPOS
{
X = 20
Y = 80
}
GEOMTYPE = LINESEGS
ARROWHEADATTACHMENT = ATEND
RAWDATA
1
3
0 0
0 -60
40 0
$!ATTACHTEXT
Syntax: $!ATTACHTEXT
TEXT = <string>
[optional parameters]
Description:Attach text to the active frame
69
Required Parameter
Parameter Syntax Default Notes
TEXT = <string> Text string to draw.
Optional Parameters
Parameter Syntax Default Notes
ANCHOR = <textanchor> LEFT Specifies what part of the text to anchor to the frame.
ANCHORPOS <<anchorpos>> This assigns the anchor position for the text. Units are
dependent on POSITIONCOORDSYS.
ANGLE = <dexp> 0.0 Text angle (in degrees).
ATTACHTOZONE = <boolean> NO If YES, must include ZONE.
BOX
{
BOXTYPE = <boxtype> NONE
COLOR = <color> BLACK
FILLCOLOR = <color> WHITE
LINETHICKNESS = <dexp> 0.1%
MARGIN = <dexp> 20 The margin is the space between the text and box. The margin
is measured in terms of the percentage of the text height.
}
CLIPPING = <clipping> CLIPTOVIEWPORT
COLOR = <color> BLACK
LINESPACING = <dexp> 1.0 Line spacing to use if text contains multiple lines.
MACROFUNCTION = <string> NULL Set the macro command to execute when you hover over the
geometry and press Ctrl-right-click.
COMMAND
POSITIONCOORDSYS = <coordsys> FRAME values = FRAME, GRID or GRID3D
TEXTSHAPE
{
FONTFAMILY = <string> "Helvetica"
ISBOLD = <boolean> YES
ISITALIC = <boolean> NO
HEIGHT = <dexp> 14
SIZEUNITS = <sizeunits> POINT The following combinations of SIZEUNITS and
POSITIONCOORDSYS are allowed: FRAME/FRAME, POINT
}
SCOPE = <scope> LOCAL Set the scope to GLOBAL to include this text in all “like” frames.
ZONE = <integer> 1 This is only used if ATTACHZONE = YES. This text is disabled if
the zone assigned here is inactive.
Examples:
Example 1:
The following example creates the text ABC and positions it in the lower left corner of the frame:
$!ATTACHTEXT
TEXT = "ABC"
70
Example 2:
The following example creates the text TEXT AT AN ANGLE and places it in the center of the frame. The
text is drawn at an angle of 45 degrees:
$!ATTACHTEXT
TEXT = "TEXT AT AN ANGLE"
ANGLE = 45
ANCHORPOS {X=50 Y=50}
Example 3:
The following example creates the text TIMES-ROMAN using the Times Roman font. This text includes a
text box:
$!ATTACHTEXT
TEXT = "TIMES-ROMAN"
TEXTSHAPE
{
FONTFAMILY = "Times"
ISBOLD = NO
ISITALIC = NO
}
BOX
{
BOXTYPE = PLAIN
MARGIN = 20
}
ANCHORPOS {X=20 Y=20}
$!AXIALDUPLICATE
Syntax: $!AXIALDUPLICATE
ANGLE = <dexp>
IS3D = <boolean>
NUMDUPLICATES = = <integer>
[optional parameters]
Description:Using the right-hand rule, make the specified number of duplicates of the specified set
of zones, rotating the specified axis variables and/or vector variables successively by the given angle. You
may optionally specify the origin and axis of rotation.
The parameters XVAR, YVAR, and ZVAR specify the X, Y, and Z grid variables to be rotated. ZVAR
applies only in 3D rotation and must be omitted for 2D rotation. If only vector variables are to be rotated,
all of these may be omitted; however, if any is specified, all must be.
The parameters UVARLIST, VVARLIST, and WVARLIST are sets consisting of the vector variables to be
rotated for each vector component. WVARLIST applies only in 3D rotation and must be omitted for 2D
rotation. The number of variables in each set must match the number specified by the NUMVECTORS
parameter, which must also be specified. If no vector variables are to be rotated, the NUMVECTORS
parameter may be omitted, along with UVARLIST, VVARLIST, and WVARLIST.
Acenter of rotation other than the grid origin may be specified using the optional ORIGINX, ORIGINY,
and ORIGINZ parameters. The origin specified by these parameters is subtracted from the values of the X,
Y, and Z axis variables specified before rotation, then added back in afterward.
Rotation occurs around the Z axis by default. To specify a different axis of rotation in 3D rotation, specify
the coordinates of a second point (i.e., a point other than the origin) on the axis of rotation using the
NORMALX, NORMALY, and NORMALZ parameters. These may not be specified with 2D rotation.
71
See also $!ROTATEDATA.
Required Parameters
Parameter Syntax Notes
ANGLE = <dexp> Angle to rotate between each new set of zones (in degrees).
IS3DROTATION = <boolean> If true, rotate in 3D. If false, rotate in 2D.
NUMDUPLICATES = <integer> Number of duplicate sets of zones to create
Optional Parameters
Parameter Syntax Default Notes
ADDZONESTOEXISTINGSTRANDS = <boolean> YES If true, the new zones become a part of the time strands that the
original zones belong to. If false, new zones are assigned new
strand IDs if the soruce zones belonged to strands, otherwise they
are made static.
OFFSETANGLE = <dexp> 0.0 The rotation, in degrees, to be added to the first rotated duplicate.
For example, if ANGLE is 20, and OFFSETANGLE is 40, the first
duplicate is made at 60°.
NORMALX = <dexp> 0.0 For 3D rotation, the X component of a point other than the origin
on the axis of rotation. Invalid for 2D rotation.
NORMALY = <dexp> 0.0 For 3D rotation, the Y component of a point other than the origin
on the axis of rotation. Invalid for 2D rotation.
NORMALZ = <dexp> 1.0 For 3D rotation, the Z component of a point other than the origin
on the axis of rotation. Invalid for 2D rotation.
NUMVECTORS = <integer> 0 Number of vector variables to be rotated, which must be specified
in UVARLIST, YVARLIST, and (if 3D) WVARLIST.
ORIGINX = <dexp> 0.0 X coordinate of the origin.
ORIGINY = <dexp> 0.0 Y coordinate of the origin.
ORIGINZ = <dexp> 0.0 Z coordinate of the origin (for 3D rotation only).
UVARLIST = <set> The U vector variables to be rotated, if any. Must contain the
number of variables specified by NUMVECTORS.
VVARLIST = <set> The V vector variables to be rotated, if any. Must contain the
number of variables specified by NUMVECTORS.
WVARLIST = <set> The W vector variables to be rotated, if any. Must contain the
number of variables number specified by NUMVECTORS. For
3D rotation only.
XVAR = <integer> The X axis variable to be rotated. If specifed, other axis variables
must also be specified..
YVAR = <integer> The Y axis variable to be rotated. If specifed, other axis variables
must also be specified..
ZVAR = <integer> The Z axis variable to be rotated (for 3D rotation only). If specifed,
other axis variables must also be specified..
ZONELIST = <set> All zones Set specifying the zones to be duplicated. If omitted, duplicate all
zones.
$!BASICCOLOR
Syntax:$!BASICCOLOR
[optional parameters]
Description:A SetValue command that sets the red, green and blue components for any of the basic colors in
Tecplot 360.
72
Optional Parameters
Parameter Syntax Default Notes
BLACK <<rgb>> See Notes R=0, G=0, B=0
BLUE <<rgb>> See Notes R=45, G=45, B=255
CUSTOM1... <<rgb>>
CUSTOM56
CYAN <<rgb>> See Notes R=0, G=255, B=255
GREEN <<rgb>> See Notes R=0, G=210, B=0
PURPLE <<rgb>> See Notes R=255, G=0, B=0
RED <<rgb>> See Notes R=210, G=0, B=0
WHITE <<rgb>> See Notes R=255, G=255, B=255
YELLOW <<rgb>> See Notes R=255, G=255, B=45
$!BASICCOLOR
CUSTOM8
{
R = 165
G = 42
B = 42
}
$!BASICCOLORLEGEND
Syntax: $!BASICCOLORLEGEND
[optional parameters]
Description:A SetValue command that allows you to create and set the style of a legend for the basic colors in
Tecplot 360. The legend can be used to display any attribute of the plot represented by a basic color
(for example, materials). Each frame maintains a mapping of basic colors to names. Each basic color
actually used in selected layers of the plot appears in the legend unless it is excluded.
73
Optional Parameters
Parameter Syntax Default Notes
ANCHORALIGNMENT = <anchoralignment> TOPRIGHT
BASICCOLORCONTROL Name may include dynamic text variables (for example, to
incorporate auxiliary data)
{
BLACK <<basiccolorcontrol>> See notes NAME = ’’, SHOW = YES
BLUE <<basiccolorcontrol>> See notes NAME = ’’, SHOW = YES
CUSTOM1... <<basiccolorcontrol>> See notes NAME = ’’, SHOW = YES
CUSTOM56
CYAN <<basiccolorcontrol>> See notes NAME = ’’, SHOW = YES
GREEN <<basiccolorcontrol>> See notes NAME = ’’, SHOW = YES
PURPLE <<basiccolorcontrol>> See notes NAME = ’’, SHOW = YES
RED <<basiccolorcontrol>> See notes NAME = ’’, SHOW = YES
WHITE <<basiccolorcontrol>> See notes NAME = ’’, SHOW = YES
YELLOW <<basiccolorcontrol>> See notes NAME = ’’, SHOW = YES
}
BOX <<textbox>> See notes BOXTYPE = HOLLOW, MARGIN = 10, LINETHICKNESS =
0.1, COLOR = BLACK, FILLCOLOR = WHITE
FIELDLAYERCONTROL Determines which field layers’ colors are included in legend
{
USEMESH = <boolean> NO
USECONTOUR = <boolean> NO
USEVECTOR = <boolean> NO
USESCATTER = <boolean> NO
USESHADE = <boolean> NO
USEEDGE = <boolean> NO
}
HEADERTEXT = <string> May include dynamic text variables
HEADERTEXTCOLOR = <color> BLACK
HEADERTEXTSHAPE <<textshape>> See notes FONTFAMILY = ’Helvetica’, ISBOLD = YES, ISITALIC = NO,
SIZEUNITS = FRAME, HEIGHT = 2.5
LABELTEXTCOLOR = <color> BLACK
LABELTEXTSHAPE <<textshape>> See notes FONTFAMILY = ’Helvetica’, ISBOLD = NO, ISITALIC = NO,
SIZEUNITS = FRAME, HEIGHT =2.5
LINELAYERCONTROL Determines which line layers’ colors are included in legend
{
USELINES = <boolean> NO
USESYMBOLS = <boolean> NO
USEBARS = <boolean> NO
USEERRORBARS = <boolean> NO
}
ROWSPACING <op> <dexp> = 1.2
SHOW = <boolean> NO
SHOWSYMBOLOUTLINE = <boolean> YES
SORTBYLABELTEXT = <boolean> YES
SYMBOLHEIGHT = <dexp> 2.5
SYMBOLLINETHICKNESS = <dexp> 0.1
SYMBOLWIDTH = <dexp> 2.5
XYPOS <<xy>> X = 95, Y = 75
$!BASICCOLORLEGEND
SHOW = YES
74
LINELAYERCONTROL
{
USELINES = YES
}
XYPOS
{
X = 70
Y = 80
}
HEADERTEXT = '&(ZoneName[1])'
BOX
{
BOXTYPE = FILLED
}
BASICCOLORCONTROL
{
BLACK
{
SHOW = NO
}
RED
{
NAME = 'Apple'
}
GREEN
{
NAME = 'Bean'
}
BLUE
{
NAME = 'Blueberry'
}
CYAN
{
NAME = 'Kiwi'
}
YELLOW
{
NAME = 'Banana'
}
PURPLE
{
NAME = 'Grape'
}
}
$!BASICSIZE
Syntax: $!BASICSIZE
[optional parameters]
Description:A SetValue command that sets sizes of various objects like line thicknesses, line pattern length,
font height, and so forth. Sizes can be assigned when interacting with Tecplot 360 by either
entering an exact value or by choosing from a preset list of values. The $!BASICSIZE command
allows you to change the values in the preset lists.
75
Optional Parameters
Parameter Syntax Default Notes
ARROWHEADSIZES <<basicsizelist>> See Notes Tiny=1.0, Small=3.0, Medium=5.0, Large=8.0, Huge=12.0
FRAMETEXTSIZES <<basicsizelist>> See Notes Tiny=1.5, Small=2.0, Medium=3.0, Large=6.0, Huge=10.0
LINEPATLENGTHS <<basicsizelist>> See Notes Tiny=0.5, Small=0.8, Medium=2.0, Large=3.0, Huge=5.0
LINETHICKNESSES <<basicsizelist>> See Notes Tiny=0.02, Small=0.1, Medium=0.4, Large=0.8, Huge=1.5
POINTTEXTSIZES <<basicsizelist>> See Notes Tiny=8, Small=11, Medium=14, Large=28, Huge=50
SYMBOLSIZES <<basicsizelist>> See Notes Tiny=0.5, Small=1.0, Medium=2.5, Large=4.0, Huge=8.0
TICKLENGTHS <<basicsizelist>> See Notes Tiny=0.5, Small=1.2, Medium=2.0, Large=3.0, Huge=5.0
$!BASICSIZE
LINEPATLENGTHS
{
MEDIUM = 2.5
}
$!BLANKING
Syntax: $!BLANKING
[optional parameters]
Description:A SetValue command that changes settings for IJK- or value-blanking.
76
Optional Parameters
Parameter Syntax Default Notes
DEPTH
{
INCLUDE = <boolean> NO If YES, draws only those portions at the plot
with depth values within the FROMFRONT
and FROMBACK limits.
FROMFRONT = <double> 0 FROMFRONT and FROMBACK are
expressed as percentages of the overall 3D
depth.
FROMBACK = <double> 0 FROMFRONT and FROMBACK are
expressed as percentages of the overall 3D
depth.
}
IJK
{
INCLUDE = <boolean> NO
IJKBLANKMODE = <ijkblankmode>
IMINFRACT <op> <dexp> =0 Minimum and maximum fractions are in
terms of percentages (0-100). Zero represents
JMINFRACT <op> <dexp> =0 an index of one and 100 the maximum index.
KMINFRACT <op> <dexp> =0
IMAXFRACT <op> <dexp> = 50
JMAXFRACT <op> <dexp> = 50
KMAXFRACT <op> <dexp> = 50
ZONE = <integer> 0 Only one zone can be assigned to use IJK-
blanking.
}
VALUE
{
BLANKENTIRECELL = <boolean> YES Set to NO to get precision blanking.
CONSTRAINT nnn nnn = <integer> 1 Use <integer> to specify which constraint to
modify.
{
COLOR = <color> BLACK
CONSTRAINTOP2MODE = <constrainintop2mode> USECONSTANT
INCLUDE = <boolean> NO
LINEPATTERN = <linepattern> SOLID
LINETHICKNESS = <double> 0.4
PATTERNLENGTH = <dexp> 2
RELOP = <valueblankrelop> LESSTHANOREQUAL
SHOW = <boolean> NO
VALUECUTOFF = <double> 0
VARA = <integer> None
VARB = <integer> None
}
INCLUDE = <boolean> NO Set to NO to turn off all value-blanking.
VALUEBLANKCELLMODE = <valueblankcellmode> ANYCORNER
}
Examples:
77
Example 1:
Set IJK-blanking to cut away the minimum index corner:
$!BLANKING
IJK
{
INCLUDE = YES
IMINFRACT = 0
JMINFRACT = 0
KMINFRACT = 0
IMAXFRACT = 50
JMAXFRACT = 50
KMAXFRACT = 50
}
Example 2:
Use value blanking to cut away all cells that have at least one node where variable 3 is less than or equal to
7.5:
$!BLANKING
VALUE
{
INCLUDE = YES
CONSTRAINT 1
{
INCLUDE = YES
VARA = 3
RELOP = LESSTHANOREQUAL
VALUECUTOFF = 7.5
}
}
$!BRANCHCONNECTIVITY
Syntax: $!BRANCHCONNECTIVITY
ZONE = <integer>
[no optional parameters]
Description:For zones where connectivity is shared, this command allows for branching of connectivity
information from the specified zone.
Required Parameters
Parameter Syntax Default Notes
ZONE = <integer>
Example:
Suppose Zones 2, 3 and 4 share connectivity. This command branches the connectivity of the second zone.
Zones 3 and 4 will still share connectivity.
$!BRANCHCONNECTIVITY
ZONE = 2
78
$!BRANCHFIELDDATAVAR
Syntax: $!BRANCHFIELDDATAVAR
ZONE = <integer>
VAR = <integer>
[no optional parameters]
Description:Allows for branching of specified variable in the specified zone for zones that share variables.
Required Parameters
Parameter Syntax Default Syntax
VAR = <integer>
ZONE = <integer>
Example:
Assume Zones 1, 2 and 4 share variables 3 and 5. This command branches the third variable from the
second zone. Variable 3 will still be shared by zones 1 and 4, while variable 5 will still be shared by all
three zones.:
$!BRANCHFIELDDATAVAR
ZONE = 2
VAR = 3
$!BREAK
Syntax: $!BREAK
[no parameters]
Description:Jump out of the current $!LOOP-ENDLOOP or $!WHILE-$!ENDWHILE.
Example:
$!LOOP 5
$!BREAK
$!ENDLOOP
$!COLORMAPATTRIBUTES
79
Required Parameters
Parameter Syntax Default Notes
CONTROLPOINT <<colormapcontrolpoints>> Defines a control point. Multiple control points for a
given color map may set in a COLORMAPATTRIBUTES
command.
Example: Move the third control point for the custom colormap "My Small Rainbow" to 44% of the
way across the colormap, setting the leading and trailing red values of this point to 90. :
$!COMPATIBILITY
Syntax: $!COMPATIBILITY
[optional parameters]
Description:Allow datasharing access and setting, without warning.
Optional Parameters
Parameter Syntax Default Notes
ALLOWDATASHARING = <boolean> YES If NO, Tecplot 360 will not allow data sharing. This may be necessary
to use older add-ons that cannot handle shared data.
ALLOWOLDTEXTFORMATTING = <boolean> NO If NO, allows Tecplot 360 to display text subscripts and superscripts
created with older Tecplot 360 versions without automatically
converting the text to the new formatting.
$!COMPATIBILITY ALLOWDATASHARING=YES
$!CONTINUE
Syntax: $!CONTINUE
Description:Transfer control back to nearest $!LOOP or $!WHILE.
Example:
$!LOOP 10
$!CONTINUE
$!ENDLOOP
Description:The different commands in the CONTOURLABELS compound function family are described
separately in the following sections.
The CONTOURLABELS compound functions are:
$!CONTOURLABELS ADD
$!CONTOURLABELS DELETEALL
80
$!CONTOURLABELS ADD
Optional Parameters
Parameter Syntax Default Notes
CONTOURGROUP = <integer> 1 Defines which contour group is changed.
ISALIGNED = <boolean> YES If YES then align the contour label along the contour line; if
NO, draw the label horizontally.
XYZPOS
{
X = <dexp> 0.0 X-position for contour label.
Y = <dexp> 0.0 Y-position for contour label.
Z = <dexp> 0.0 Z-position for contour label (use Z only for 3D plots).
}
Example:
The following commands add labels at (0.5, 0.25) and (0.73, 0.17) in a 2-D field plot.
$!CONTOURLABELS DELETEALL
Optional Parameters
Parameter Syntax Default Notes
CONTOURGROUP = <integer> 1 Defines which contour group is changed.
Example:
$!CONTOURLABELS DELETEALL
CONTOURGROUP = 3
81
$!CONTOURLEVELS [Required-Control Option]
Description:The different commands in the CONTOURLEVELS compound function family are described
separately in the following sections.
The CONTOURLEVELS compound functions are:
$!CONTOURLEVELS ADD
$!CONTOURLEVELS NEW
$!CONTOURLEVELS DELETENEAREST
$!CONTOURLEVELS DELETERANGE
$!CONTOURLEVELS RESET
$!CONTOURLEVELS RESETTONICE
$!CONTOURLEVELS ADD
Required Parameter
Parameter Syntax Default Notes
<contourlevelrawdata> Supply a list of contour levels to add.
Optional Parameters
Parameter Syntax Default Notes
CONTOURGROUP = <integer> 1 Defines which contour group is changed.
Example: Add contour levels 1.7, 3.4 and 2.9 to the plot:
$!CONTOURLEVELS ADD
RAWDATA
3
1.7
3.4
2.9
$!CONTOURLEVELS DELETENEAREST
82
Required Parameter
Parameter Syntax Default Notes
RANGEMIN = <dexp> Delete the contour level whose value is nearest to this value.
Optional Parameters
Parameter Syntax Default Notes
CONTOURGROUP = <integer> 1 Defines which contour group is changed.
$!CONTOURLEVELS DELETENEAREST
RANGEMIN = 3.4
$!CONTOURLEVELS DELETERANGE
Required Parameters
Parameter Syntax Default Notes
RANGEMIN = <dexp> Minimum contour level to delete.
RANGEMAX = <dexp> Maximum contour level to delete.
Optional Parameters
Parameter Syntax Default Notes
CONTOURGROUP = <integer> 1 Defines which contour group is changed.
$!CONTOURLEVELS DELETERANGE
RANGEMIN = 0.1
RANGEMAX = 0.7
$!CONTOURLEVELS NEW
83
Required Parameter
Parameter Syntax Default Notes
<contourlevelrawdata> Supply a list of contour levels to add.
Optional Parameters
Parameter Syntax Default Notes
CONTOURGROUP = <integer> 1 Defines which contour group is changed.
Example: Replace the current set of contour levels with the levels 0.5, 0.75 and 1.0:
$!CONTOURLEVELS NEW
RAWDATA
3
0.5
0.75
1.0
$!CONTOURLEVELS RESET
Required Parameter
Parameter Syntax Default Notes
NUMVALUES = <integer> New number of contour levels.
Optional Parameters
Parameter Syntax Default Notes
CONTOURGROUP = <integer> 1 Defines which contour group is changed.
$!CONTOURLEVELS RESET
NUMVALUES = 150
$!CONTOURLEVELS RESETTONICE
84
Required Parameter
Parameter Syntax Default Notes
APPROXNUMVALUES = <integer> Approximate number of contour levels desired. Actual value
may be different.
Optional Parameters
Parameter Syntax Default Notes
CONTOURGROUP = <integer> 1 Defines which contour group is changed.
$!CONTOURLEVELS RESETTONICE
APPROXNUMVALUES = 10
$!CREATECIRCULARZONE
Syntax: $!CREATECIRCULARZONE
IMAX = <integer>
JMAX = <integer>
[optional parameters]
$!CREATEBOUNDARYZONES
85
Required Parameters
Parameter Syntax Default Notes
IMAX = <integer> Radial direction.
JMAX = <integer> Circumferential direction, must be greater than 3.
Optional Parameters
Parameter Syntax Default Notes
DATATYPE = <datatype> SINGLE
KMAX = <integer> 1 Bottom to top direction
RADIUS = <dexp> 1
X = <dexp> 0 X-coordinate for center.
XVAR = <integer> Auto Only needed when processing journal instructions.
Y = <dexp> 0 Y-coordinate for center.
YVAR = <integer> Auto Only needed when processing journal instructions.
Z1 = <dexp> 0 Z-minimum if a cylinder is created.
Z2 = <dexp> 1 Z-maximum if a cylinder is created.
ZVAR = <integer> Auto Only needed when processing journal instructions.
Examples:
Example 1:
Create a circular 10 by 20 IJ-ordered zone centered at (5, 5) with a radius of 2:
$!CREATECIRCULARZONE
IMAX = 10
JMAX = 20
X = 5
Y = 5
RADIUS = 2
Example 2:
Create a cylindrical 5 by 6 by 8 IJK-ordered zone with the bottom centered at (4, 4, 0) and the top centered
at (4, 4, 7) and a radius of 3:
$!CREATECIRCULARZONE
IMAX = 5
JMAX = 6
KMAX = 8
X = 4
Y = 4
Z1 = 0
Z2 = 7
RADIUS = 3
$!CREATECOLORMAP
Syntax: $!CREATECOLORMAP
NAME= <string>
[optional parameters]
Description:Defines a color map. Only the name is required; it must be a valid non-zero-length string.
Color map names are case-insensitive, although the case used when creating the color map is
86
retained for display. Leading and trailing spaces are stripped.
If the named color map does not exist, it is created and initialized to SOURCECOLORMAP if
provided; otherwise to "Small Rainbow." If the named colormap exists, and is not a built-in
colormap, it will be overwritten by SOURCECOLORMAP, or by "Small Rainbow" if
SORURCECOLORMAP is not provided.
Required Parameters
Parameter Syntax Default Notes
NAME = <string> Name of the new color map. May not be the name of any
existing color map, including built-in color maps.
Optional Parameters
Parameter Syntax Default Notes
SOURCECOLORMAP = <string> "Small If specified, the color map is initialized to the color map
Rainbow" with this name. The source color map must exist, and
may be the name of either a built-in or custom color
map. May not be used with NUMCONTROLPOINTS.
NUMCONTROLPOINTS = <integer> Number of control points in color map. May not be used
if SOURCECOLORMAP is used.
CONTROLPOINT <<colormapcontrolpoints>> Defines a control point. Multiple control points for a new
color map may set in a CREATECOLORMAP command.
Example: Create a custom color map initialized from the built-in "Small Rainbow" color map. :
$!CREATECOLORMAP
NAME="My Small Rainbow Colormap"
SOURCECOLORMAP="Small Rainbow
$!CREATECONTOURLINEZONES
Optional Parameters
Parameter Syntax Default Notes
AUTOSTRANDTRANSIENTDATA = <boolean> YES If set to YES, time strands are
automatically created for transient
data in the new zone.
CONTLINECREATEMODE = ONEZONEPERCONTOURLEVEL or Select whether one zone per contour
ONEZONEPERINDEPENDENTPOLYLINE lever will be created or whether there
will be a zone for each polyline.
Example: Create a new zone for each contour line on an existing contour plot.
$!CREATECONTOURLINEZONES
CONTLINECREATEMODE = ONEZONEPERCONTOURLEVEL
87
$!CREATEFEBOUNDARY
Syntax: $!CREATEFEBOUNDARY
SOURCEZONE = <integer>
[optional parameters]
Description:Zone edges for finite element data cannot be turned on or off using the edge plot layer in Tecplot
360. You can, however, create a separate zone which is the boundary of a finite element zone. This
new zone can then be turned on or off.
Required Parameter
Parameter Syntax Default Notes
SOURCEZONE = <integer> Zone to extract the boundary from.
Optional Parameters
Parameter Syntax Default Notes
AUTOSTRANDTRANSIENTDATA = <boolean> YES If set to YES, time strands are automatically created for transient
data in the new zone.
REMOVEBLANKEDSURFACES = <boolean> NO Set to YES if you want the resulting zone to include only the
boundary adjacent to non-blanked cells.
$!CREATEFEBOUNDARY
SOURCEZONE = 3
$!CREATEFESURFACEFROMIORDERED
Syntax: $!CREATEFESURFACEFROMIORDERED
SOURCEZONES = <set>
[optional parameters]
Description:A FE-Surface zone can be generated from two or more I-Ordered zones. To get the best possible
output, it is recommended that the source zones should have their nodes arranged in a similar
manner so that the connecting lines between points are as straightforward as possible. For this
reason, indices from source zones should increase in the same direction.
Required Parameter
Parameter Syntax Default Notes
SOURCEZONES = <set> Zones whose points will be used to create the new surface.
Optional Parameters
Parameter Syntax Default Notes
AUTOSTRANDTRANSIENTDATA = <boolean> YES If set to YES, time strands are automatically created for transient
data in the new zone.
CONNECTSTARTTOEND = <boolean> NO YES allows for closed surfaces.
$!CREATEFESURFACEFROMIORDERED
SOURCEZONES = [3-4]
88
$!CREATEISOZONES
Syntax: $!CREATEISOZONES
[optional parameters]
Description:Create zones from the currently defined iso-surfaces. One zone will be created from each defined
iso-surface. The iso-surfaces must be active and you must have at least one active volume zone.
Optional Parameter
Parameter Syntax Default Notes
AUTOSTRANDTRANSIENTDATA = <boolean> YES If set to YES, time strands are automatically created for transient
data in the new zone.
Example:
$!CREATEISOZONES
$!CREATELINEMAP
Syntax: $!CREATELINEMAP
[no parameters]
Description:Create a new Line-mapping.
Example:
$!CREATELINEMAP
$!CREATEMIRRORZONES
Syntax: $!CREATEMIRRORZONES
SOURCEZONES = <set>
[optional parameters]
Description:Create new zones that are mirror images of the source zones
Required Parameter
Parameter Syntax Default Notes
SOURCEZONES = <set> Zone(s) to create mirror zone(s) from.
Optional Parameter
Parameter Syntax Default Notes
MIRRORVAR = <mirrorvar> ‘X’ This variable in the new zone is multiplied by -1 after the zone
is copied. (Mutually exclusive with MIRRORVARS.)
MIRRORVARS = <set> Set of variables in the new zone to be multiplied by -1 after the
zone is copied. (Mutually exclusive with MIRRORVAR.)
Example:
Create a mirror of zones 2-4 across the Y-axis (that is, mirror the X-variable) in 2D frame mode:
$!CREATEMIRRORZONES
89
SOURCEZONES = [2-4]
MIRRORVAR = ’X’
$!CREATENEWFRAME
Syntax: $!CREATENEWFRAME
[optional parameters]
Description:Creates a new frame.
Optional Parameters
Parameter Syntax Default Notes
HEIGHT = <dexp> 8 Units are in inches.
WIDTH = <dexp> 9 Units are in inches.
XYPOS <<xy>> X = 1.02 Y = 0.25 Units are in inches; relative to the top left edge of the paper
The default position and size of the initial frame created when Tecplot 360 starts up can be changed in the
Tecplot 360 configuration file.
Example:
The following example creates a 5- by 5-inch frame with the upper left hand corner of the frame
positioned 2 inches from the left edge of the paper and 1 inch from the top:
$!CREATENEWFRAME
XYPOS
{
X = 2
Y = 1
}
WIDTH = 5
HEIGHT = 5
$!CREATERECTANGULARZONE
Syntax: $!CREATERECTANGULARZONE
[optional parameters]
Description:Create a rectangular zone. If no data set exists when this command is executed, a data set is
created with variables X, Y (and Z, if KMax > 1). If a data set exists prior to this command, the non-
coordinate variables for the zone created are initialized to zero.
90
Optional Parameters
Parameter Syntax Default Notes
IMAX = <integer> 1 I-dimension.
JMAX = <integer> 1 J-dimension.
KMAX = <integer> 1 K-dimension.
X1 = <dexp> 0 X-minimum.
Y1 = <dexp> 0 Y-minimum.
Z1 = <dexp> 0 Z-minimum.
X2 = <dexp> 1 X-maximum.
Y2 = <dexp> 1 Y-maximum.
Z2 = <dexp> 1 Z-maximum.
XVAR = <integer> Auto Only needed when processing journal instructions.
YVAR = <integer> Auto Only needed when processing journal instructions.
ZVAR = <integer> Auto Only needed when processing journal instructions.
DATATYPE = <datatype> SINGLE
Example:
Create a rectangular IJ-ordered zone dimensioned 20 by 30 where X ranges from 0 to 3 and Y from 3 to 9:
$!CREATERECTANGULARZONE
IMAX = 20
JMAX = 30
X1 = 0
Y1 = 3
X2 = 3
Y2 = 9
$!CREATESIMPLEZONE
Required Parameter
Parameter Syntax Default Notes
RAWDATA May contain row and column counts or just a row count. If only a row count is
specified, the number of columns is assumed to be 2, for XY data. See Chapter
13: “Raw Data” for details.
Optional Parameter
Parameter Syntax Default Notes
DATATYPE = <datatype> SINGLE
Example: Create a simple XY-zone that has the XY-pairs (1, 0), (2, 1), (3, 7) and (5 9):
$!CREATESIMPLEZONE
RAWDATA
4
1 0
91
2 1
3 7
5 9
Create a simple XYZ zone.
$!CREATESIMPLEZONE
RAWDATA
2 3 # Two rows of data with three columns each
1 2 3
4 5 6
The following is invalid, since the second CREATESIMPLEZONE is trying to set more variables than exist in the
data set (assuming it was initially empty and created with the first CREATESIMPLEZONE).
$!CREATESIMPLEZONE
RAWDATA
2 3
1 2 3
4 5 6
$!CREATESIMPLEZONE
RAWDATA
2 6 # Doesn't work since there are only 3 variables
1 2 3 4 5 6
7 8 9 8 7 4
$!CREATESLICEZONEFROMPLANE
Syntax: $!CREATESLICEZONEFROMPLANE
[optional parameters]
Description:Create a new zone as a slice through existing 3D volume zones. Use $!GLOBALTHREED to
define the slicing plane orientation.
Optional Parameters
Parameter Syntax Default Notes
AUTOSTRANDTRANSIENTDATA = <boolean> YES If set to YES, time strands are automatically created
for transient data in the new zone.
COPYCELLCENTEREDVALUES = <boolean> NO If YES, and if the zones for all cell-centered variables
used to construct the slice are cell-centered, copies
the cell-centered values from the source zones’ cell-
centered variables to the extracted slice. Otherwise
the values are interpolated to the source nodes, and
the nodal values are extracted to the slice.
FORCEEXTRACTIONTOSINGLEZONE = <boolean> YES
SLICESOURCE = <slicesource> VOLUMEZONES
$!GLOBALTHREED
SLICE
{
ORIGIN {X=0}
NORMAL
{
X=1
Y=0
Z=0
}
}
92
$!CREATESLICEZONEFROMPLANE
SLICESOURCE=VOLUMEZONES
$!CREATESLICEZONES
Syntax: $!CREATESLICEZONES
[optional parameter]
Description:Create a new zone for each slice defined on the Slice Details dialog. Only creates slices from
volume zones.
Optional Parameter
Parameter Syntax Default Notes
AUTOSTRANDTRANSIENTDATA = <boolean> YES If set to YES, time strands are automatically created for transient
data in the new zone.
Example:
$!GLOBALCONTOUR VAR = 4
$!SLICEATTRIBUTES ENDPOSITION {X = 1}
$!SLICEATTRIBUTES STARTPOSITION {X = 6}
$!SLICEATTRIBUTES NUMITERMEDIATESLICES = 6
$!SLICEATTRIBUTES SHOWBEGINENDSLICE = YES
$!SLICEATTRIBUTES SHOWINTERMEDIATESLICES = YES
$!REDRAW
$!CREATESLICEZONES
$!CREATESPHERICALZONE
Syntax: $!CREATECIRCULARZONE
IMAX = <integer>
JMAX = <integer>
[optional parameters]
Description:Create a spherical IJK-ordered zone.
93
Required Parameters
Parameter Syntax Default Notes
IMax = <integer> Psi direction.
JMax = <integer> Theta direction.
Optional Parameters
Parameter Syntax Default Notes
DATATYPE = <datatype> SINGLE
RADIUS = <dexp> 1
X = <dexp> 0 X-coordinate for center.
XVAR = <integer> Auto Only needed when processing journal instructions.
Y = <dexp> 0 Y-coordinate for center.
YVAR = <integer> Auto Only needed when processing journal instructions.
Z = <dexp> 0 Z-coordinate for center.
ZVAR = <integer> Auto Only needed when processing journal instructions.
Examples:
Example 1:
Create a spherical 10 by 20 IJ-ordered zone centered at (5, 5) with a radius of 2:
$!CREATESPHERICALZONE
IMax = 10
JMax = 20
X = 5
Y = 5
RADIUS = 2
$!CREATESTREAMZONES
Syntax: $!CREATESTREAMZONES
[optional parameters]
Description:Create one or more zones out of the currently defined streamtraces. The new zones have the
same number of variables per data point as the other zones in the data set with all non-coordinate
variables interpolated at the positions along the streamtrace.
Optional Parameters
Parameter Syntax Default Notes
AUTOSTRANDTRANSIENTDATA = <boolean> YES If set to YES, time strands are automatically created for transient
data in the new zone.
CONCATENATE = <boolean> NO Set to YES to create a single zone out of all common streamtraces.
The cell that connects the end of one streamtrace with the beginning
of the next can later be turned off using value-blanking.
$!CREATESTREAMZONES
CONCATENATE = YES
94
D
$!DATASETUP
Syntax: $!DATASETUP
[optional parameters]
Description:A SetValue command that sets miscellaneous parameters related to data.
Optional Parameters
Parameter Syntax Default Notes
COMMANDLINE
{ This option allows you to auto-strand data files in Tecplot 360. This
AUTOSTRANDDATAFILES = <boolean> YES can be set to NO or commented-out of the configuration file
(tecplot.cfg) to retain the Tecplot 10 compatibility
}
SCRATCHDATAFIELDTYPE = <datatype> Set the data type for scratch arrays used for geometries line segments
and other lines. The default is SINGLE for Windows and DOUBLE for
other platforms. This parameter can only be used in the Tecplot 360
configuration file.
Example:
Change the arguments used to Preplot ASCII files so only zones 1, 2, and 3 are processed:
$!DATASETUP
PREPLOTARGS = "-zonelist 1:3"
$!DEFAULTGEOM
Syntax: $!DEFAULTGEOM
[optional parameters]
Description:A SetValue command that sets the attributes for the default geometry. When a geometry is
created interactively, its color, line thickness, and so forth, are preset based on the default
geometry. This command is usually used only in the Tecplot 360 configuration file.
95
Optional Parameters
Parameter Syntax Default Notes
ANCHORPOS <<xyz>>
ARROWHEADANGLE <op> <dexp>
ARROWHEADATTACHMENT <arrowheadattachment>
ARROWHEADSIZE <op> <dexp>
ARROWHEADSTYLE <arrowheadstyle>
ATTACHTOZONE = <boolean>
COLOR = <color>
DATATYPE = <fielddatatype>
DRAWORDER = <draworder> AFTERDATA
DRAWORDER = <draworder> AFTERDATA
FILLCOLOR = <color>
ISFILLED = <boolean>
LINEPATTERN = <linepattern>
LINETHICKNESS <op> <dexp>
MACROFUNCTIONCOMMAND = <string> Set the macro command to execute when you hover
over the geometry and press Ctrl-right-click.
MAINTAINASPECTRATIO = <boolean> YES
NUMELLIPSEPTS <op> <integer>
PATTERNLENGTH <op> <dexp>
PIXELASPECTRATIO = <double> 0 A value of 0 allows Tecplot 360 to select the aspect ratio.
Use only if your circles or squares appear distorted due
to the aspect ratio of your monitor.
POSITIONCOORDSYS = <coordsys>
SCOPE = <scope>
ZONE = <integer>
$!DEFAULTGEOM
LINETHICKNESS = 0.2
$!DEFAULTTEXT
Syntax: $!DEFAULTTEXT
[optional parameters]
Description:A SetValue command that sets the attributes for the default text. When text is added to a plot
interactively, its font, color, size, and so forth, are based on the default text. This command is
usually used only in the Tecplot 360 configuration file.
96
Optional Parameters
Parameter Syntax Default Notes
ANCHOR = <textanchor>
ANCHORPOS <<xy>>
ANGLE <op><dexp>
ATTACHTOZONE = <boolean>
BOX <<textbox>>
CLIPPING = <clipping>
COLOR = <color>
LINESPACING <op><dexp>
MACROFUNCTIONCOMMAND = <string> Set the macro command to execute when you hover over the
geometry and press Ctrl-right-click.
POSITIONCOORDSYS = <coordsys>
SCOPE = <scope>
TEXTSHAPE <<textshape>>
ZONE <op><integer>
Example: Make the default text font Times bold with a character height of 14 points:
$!DEFAULTTEXT
TEXTSHAPE
{
FONTFAMILY = "Times"
ISBOLD = YES
ISITALIC = NO
SIZEUNITS = POINT
HEIGHT = 14
}
$!DELAY
$!DELAY 3
$!DELETEAUXDATA
Syntax: $!DELETEAUXDATA
AUXDATALOCATION = [zone/var/dataset/frame/linemap|page]
[optional parameters]
Description:Delete Auxiliary Data in the form of name/value pairs from zones, frames or datasets.
97
Required Parameters
Parameter Syntax Default Notes
AUXDATALOCATION = [zone/var/
dataset/frame/
linemap|page]
Optional Parameters
Parameter Syntax Default Notes
NAME = <string>
NUM = <integer>
VAR = <integer>
ZONE = <integer> Only required if AUXDATALOCATION = zone
$!DELETEAUXDATA
AUXDATALOCATION = zone
ZONE = 2
NAME = VARIABLE DATA
$!DELETECOLORMAP
$!DELETELINEMAPS
$!DELETELINEMAPS [2-4,8]
$!DELETEVARS
$!DELETEVARS [4,10]
98
$!DELETEZONES
$!DELETEZONES [3,7-9,11]
Description:The different commands in the DOUBLEBUFFER compound function family are described
separately in the following sections.
The DOUBLEBUFFER compound functions are:
$!DOUBLEBUFFER OFF
$!DOUBLEBUFFER ON
$!DOUBLEBUFFER SWAP
$!DOUBLEBUFFER OFF
$!DOUBLEBUFFER ON
Syntax: $!DOUBLEBUFFER ON
[no parameters]
Description:Turn on double buffering; use this command once at the beginning of a sequence of using the
double buffer. While double buffering is turned on all drawing is sent to the back buffer.
$!DOUBLEBUFFER SWAP
99
The following example uses the double buffer to show the rotation of a 3-D object:
$!DOUBLEBUFFER ON
$!LOOP 10
$!ROTATE3DVIEW X
ANGLE = 5
$!REDRAW
$!DOUBLEBUFFER SWAP
$!ENDLOOP
$!DOUBLEBUFFER OFF
$!DRAWGRAPHICS
$!DRAWGRAPHICS NO
$!DROPDIALOG
$!DROPDIALOG MACROVIEWER
$!DUPLICATELINEMAP
Syntax: $!DUPLICATELINEMAP
SOURCEMAP = <integer>
DESTINATIONMAP = <integer>
[no optional parameters]
Description:Copy attributes from an existing line mapping to another.
Required Parameters
Parameter Syntax Default Notes
DESTINATIONMAP = <integer> The destination can either be the number of an existing map or
1 greater than the current number of maps. If you choose the
latter, a new line mapping will be created.
SOURCEMAP = <integer> Line mapping from which to copy.
$!DUPLICATELINEMAP
SOURCEMAP = 3
DESTINATIONMAP = 7
100
$!DUPLICATEZONES
Syntax: $!DUPLICATEZONES
SOURCEZONE = <integer> or SOURCEZONES = <set>
[optional parameters]
Description:Make a copy of an existing zone or zones. You can use index ranges to create new zone(s) from a
subset of the source zone(s). You may also specify a destination zone to overwrite existing zone(s).
Initially, the duplicate zone shares all variables with the source zone. To branch some or all
variables in the destination zone(s), use $!BRANCHFIELDDATAVAR.
Required Parameter
Either SOURCEZONE or SOURCEZONES must be specified, but not both.
Optional Parameters
Parameters Syntax Default Notes
DESTINATIONZONE = <integer> If specified, the existing zone into which the copy is made,
overwriting the zone. May not be a source zone. If not
specified, a new zone is created.
Examples:
Example 1:
Make a complete copy of zone 2 to a new zone:
$!DUPLICATEZONES
SOURCEZONE = 2
101
Example 2:
Copy zone 3 and 4 to zone 5 and 6, using only the I-index range from 2 to 7 from the source zones:
$!DUPLICATEZONES
SOURCEZONES = [3-4]
DESTINATIONZONE = 5
IRANGE
{
MIN = 2
MAX = 7
}
$!ELSE
Syntax: $!ELSE
[no parameters]
Description:Conditionally handle macro commands. Used when an $!IF statement is FALSE.
Example:
$!VARSET |C| = 2
$!IF |C| == 5
$!CREATENEWFRAME
XYPOS
{
X = 2.5
Y = 1.5
}
WIDTH = 4
HEIGHT = 4
$!ELSE
$!CREATENEWFRAME
XYPOS
{
X = 3
Y = 2
}
WIDTH = 3
HEIGHT = 3
$!ENDIF
$!ELSEIF
Example:
$!VARSET |A| = 2
$!IF |A| < 5
102
$!CREATENEWFRAME
XYPOS
{
X = 1
Y = 1
}
WIDTH = 3
HEIGHT = 3
$!ELSEIF |A| > 5
$!CREATENEWFRAME
XYPOS
{
X = 2
Y = 1
}
WIDTH = 5
HEIGHT = 5
$!ELSE
$!CREATENEWFRAME
XYPOS
{
X = 3
Y = 3
}
WIDTH = 9
HEIGHT = 9
$!ENDIF
$!EXPORT
Syntax: $!EXPORT
[no parameters]
Description:Export an image file from Tecplot 360. See the $!EXPORTSETUP command for details on setting
up the exported image type. The $!EXPORT command is not valid for animation formats.
Example:
$!EXPORTCANCEL
Syntax: $!EXPORTCANCEL
[no parameters]
Description:Cancel out of the current export animation sequence. The animation file being generated is
removed.
103
Example:
$!EXPORTCANCEL
$!EXPORTFINISH
Syntax: $!EXPORTFINISH
[no parameters]
Description:Signals the completion of an animation sequence and causes the animation file to be created. You
must call $!EXPORTSTART prior to using $!EXPORTFINISH. This command is only valid for animation
formats. You may use the |EXPORTISRECORDING| intrinsic variable to make sure that an animation
sequence has been initiated.
Example:
$!EXPORTSETUP
EXPORTFNAME="rotate.avi"
EXPORTFORMAT=AVI
$!EXPORTSTART
$!LOOP 5
$!ROTATE3DVIEW X
ANGLE=5
$!EXPORTNEXTFRAME
$!ENDLOOP
$!IF "|EXPORTISRECORDING|" =="YES"
$!EXPORTFINISH
$!ENDIF
$!EXPORTNEXTFRAME
Syntax: $!EXPORTNEXTFRAME
[no parameters]
Description:Records the next frame of an animation. You must call $!EXPORTSTART prior to calling
$!EXPORTNEXTFRAME. This command is only valid for animation formats. You may use the
|EXPORTISRECORDING| intrinsic variable to make sure that an animation sequence has been
initiated.)
Example:
$!EXPORTSETUP
EXPORTFNAME="rotate.avi"
EXPORTFORMAT=AVI
$!EXPORTSTART
$!LOOP 5
$!ROTATE3DVIEW X
ANGLE=5
$!EXPORTNEXTFRAME
$!ENDLOOP
$!EXPORTFINISH
$!EXPORTSETUP
Syntax: $!EXPORTSETUP
[optional parameters]
104
Description:A SetValue command that sets the attributes for exporting image files from Tecplot 360.
Exporting is usually intended as a means to transfer images from Tecplot 360 to be imported by
other applications. See $!PRINTSETUP and $!PRINT for generating output intended for printers
and plotters.
Optional Parameters
Parameter Syntax Default Notes
ANIMATIONSPEED = <double> 10 Sets the animation speed in frames per second.
AVICOMPRESSION = <string> COLORPRESERVING Available values are LINEPRESERVING,
COLORPRESERVING (Windows only), or
LOSSLESSUNCOMPRESSED
CONVERTTO256COLORS = <boolean> NO Used for TIFF, BMP, and PNG formats.
EXPORTFNAME = <string>
EXPORTFORMAT = <exportformat> WINDOWS
METAFILE
EXPORTREGION = <bitdumpregion> CURRENTFRAME
FFMPEGQSCALE = <integer> 4 -qscale parameter used by ffmpeg encoder when
creating MP4 files. Ranges from 1 (best quality)
to 31 (worst quality)
FLASHCOMPRESSION = <compressiontype> SMALLESTSIZE
TYPE
FLASHIMAGETYPE = <imagetype> LOSSLESS
IMAGEWIDTH <op> <integer> = 512
JPEGENCODING = STANDARD or STANDARD
PROGRESSIVE
PRINTRENDERTYPE = <printrendertype> VECTOR
QUALITY = <integer> 75 Range is from 1-100
SUNRASTERFORMAT = <sunrasterformat> STANDARD Only applies if EXPORTFORMAT is
SUNRASTER
SUPERSAMPLEFACTOR = <integer> 3 The factor used in antialiasing while reducing the
size of an exported image. A larger size can
improve the quality of the image, but slows
performance.
TIFFBYTEORDER = <tiffbyteorder> INTEL
USEMULTIPLECOLORTABLES = <boolean> NO Applies to AVI and Raster Metafile only.
USESUPERSAMPLEANTIALIASING = <boolean> NO
Example: Set up Tecplot 360 to export a Raster Metafile image to the file movie.rm:
$!EXPORTSETUP
EXPORTFNAME = "movie.rm"
EXPORTFORMAT = RASTERMETAFILE
$!EXPORTSTART
Syntax: $!EXPORTSTART
[optional parameter]
Description:Signals the start of an animation sequence and records the first frame of the animation. This
command is only valid for animation formats.
105
Optional Parameters
Parameter Syntax Default Notes
EXPORTREGION = <bitdumpregion>
Example:
$!EXPORTSETUP
EXPORTFNAME="rotate.avi"
EXPORTFORMAT=AVI
EXPORTREGION = CURRENTFRAME
$!EXPORTSTART
$!LOOP 5
$!ROTATE3DVIEW X
ANGLE=5
$!EXPORTNEXTFRAME
$!ENDLOOP
$!EXPORTFINISH
$!EXTENDEDCOMMAND
Syntax: $!EXTENDEDCOMMAND
COMMANDPROCESSORID = <string>
COMMAND = <string>
[optional parameters]
Description:Send a command to an add-on. The add-on registers the name of a function that will be called
when an $!EXTENDEDCOMMAND is processed. Tecplot 360 knows which registered function to call
based on the COMMANDPROCESSORID string.
Required Parameters
Parameter Syntax Default Notes
COMMANDPROCESSOR = <string> String that identifies the add-on. This must match the
published ID string for the add-on.
ID
COMMAND = <string> The command to be sent to the add-on.
Optional Parameters
Parameter Syntax Default Notes
<extendedcommandrawdata> NULL If the RAWDATA section is supplied then each line of the RAWDATA
section is appended to the COMMAND string. A leading new line
character is appended first, and each line in the RAWDATA section
will also be terminated with a new line (except for the last line).
Example:
Send the command GO to the add-on that has registered a command processor with an COMMANDPROCESSORID
of XPROC:
$!EXTENDEDCOMMAND
COMMANDPROCESSORID = "XPROC"
COMMAND = "GO"
106
$!EXTRACTFROMGEOM
Syntax: $!EXTRACTFROMGEOM
[optional parameters]
Description: Extract data from a 2- or 3D field plot. The locations at which to extract the data come from a
polyline geometry that must be picked prior to issuing this command.
Optional Parameters
Parameters Syntax Default Notes
EXTRACTLINEPOINTSONLY = <boolean> NO If NO, must include NUMPTS.
EXTRACTTOFILE = <boolean> NO If NO, a zone is created. If YES, must include FNAME.
FNAME = <string> File name for extracted file. Required if
EXTRACTTOFILE is YES.
INCLUDEDISTANCE = <boolean> NO If YES, then Tecplot 360 EX includes an extra variable in the result
which is the distance along the line of points extracted and
VAR EXTRACTTOFILE must also be YES.
NUMPTS = <integer> Required if EXTRACTLINEPOINTSONLY is NO.
Example:
Extract 20 points from along the currently picked geometry. Send the result to a file called extract.dat:
$!EXTRACTFROMGEOM
NUMPTS = 20
EXTRACTTOFILE = YES
FNAME = "extract.dat"
$!EXTRACTFROMPOLYLINE
Syntax: $!EXTRACTFROMPOLYLINE
[optional parameters]
<xyrawdata>
Description:Extract data from a 2- or 3D field plot. The locations of where to extract the data from come from
a supplied polyline in the form of <xyzrawdata>.
The coordinate system used is determined by the following rules:
• In 2D, the coordinates are the grid (same as used on the X and Y axis). Note that Z must
still be supplied; use zero.
• In 3D with EXTRACTTHROUGHVOLUME set to TRUE, the coordinates are in the world
coordinate system (same as used on the X, Y, and Z axes).
• In 3D with EXTRACTTHROUGHVOLUME set to FALSE, the coordinates are in the eye
coordinate system (same as used for grid mode geometries). (As in 2D, Z must still be
supplied; use zero.) Each point is projected down to the surface closest to the viewer to
determine the final world coordinate location for the extraction.
107
Optional Parameters
Parameters Syntax Default Notes
EXTRACTLINEPOINTSONLY = <boolean> NO If NO, must include NUMPTS.
EXTRACTTHROUGHVOLUME = <boolean> NO If YES, data is extracted from XYZ-coordinates in the polyline. If
NO, data is extracted from the surface.
EXTRACTTOFILE = <boolean> NO If NO, a zone is created. If YES, you must include FNAME.
FNAME = <string> File name for extracted file. Required if EXTRACTTOFILE is YES.
INCLUDEDISTANCEVAR = <boolean> NO If YES, Tecplot 360 includes an extra variable in the result which is
the distance along the line of points extracted and
EXTRACTOFILE must also be YES.
NUMPTS = <integer> Required if EXTRACTLINEPOINTSONLY is NO.
Example:
Extract 10 points from specific locations in a field plot. Create a zone with the extracted data:
$!EXTRACTFROMPOLYLINE
EXTRACTLINEPOINTSONLY = YES
RAWDATA
10
0 0 0
1 2 0
2 4 0
3 2 0
3 4 0
4 4 0
4 5 0
4 6 0
5 7 0
6 9 0
$!FIELDLAYERS
Syntax: $!FIELDLAYERS
[optional parameters]
Description:A SetValue command that turns field plot layers on or off, or sets the 2D draw order.
108
Optional Parameters
Parameter Syntax Default Notes
SHOWCONTOUR = <boolean> NO
SHOWEDGE = <boolean> YES
SHOWISOSURFACES = <boolean> NO
SHOWMESH = <boolean> NO
SHOWSCATTER = <boolean> NO
SHOWSHADE = <boolean> YES
SHOWSLICES = <boolean> NO
SHOWVECTOR = <boolean> NO Vector variables must be defined. See
$!GLOBALTWODVECTOR or $!GLOBALTHREEDVECTOR.
TWODDRAWORDER = BYLAYER
<twoddraworde
r>
USELIGHTINGEFFECT = <boolean> YES
USETRANSLUCENCY = <boolean> YES
$!FIELDLAYERS
SHOWSCATTER = YES
$!FIELDMAP
109
in <set>.
Optional Parameters
Parameter Syntax Default Notes
CONTOUR
{
COLOR = <color> BLACK
CONTOURTYPE = <contourtype> FLOOD
FLOODCOLORING = <contourcoloring> GROUP1
LINECONTOURGROUP = <integer> 1
LINEPATTERN = <linepattern> SOLID
LINETHICKNESS <op> <dexp> = 0.1
PATTERNLENGTH <op> <dexp> =2
SHOW = <boolean> YES
USELIGHTINGEFFECT = <boolean> YES
}
EDGELAYER
{
COLOR = <color> BLACK
EDGETYPE = <edgetype> BORDERSANDCREASES
IEDGE = <borderlocation> BOTH For IJ-, IK-, and IJK-ordered zones.
JEDGE = <borderlocation> BOTH For IJ-, IK-, and IJK-ordered zones.
KEDGE = <borderlocation> BOTH For IJ-, IK-, and IJK-ordered zones.
LINETHICKNESS = <dexp> 0.1
SHOW = <boolean> YES
USEBLANKING = <boolean>
}
EFFECTS
{
LIGHTINGEFFECT = <lightingeffect> GOURAUD
SURFACETRANSLUCENCY <translucency> 50 SURFACETRANSLUCENCY range
is one to 99.
USETRANSLUCENCY = <boolean> YES
USEVALUEBLANKING = <boolean> YES Set to YES to include value blanking
in the specified zones
USECLIPPLANES = <set> [1-6] Use clipping planes specified to clip
zones specified in set for FIELDMAP,
or all zones if none specified. Possible
values include [ ] (none), or any
combination of the numbers 1 - 6,
enclosed in brackets.
}
MESH
{
COLOR = <color> BLACK
LINEPATTERN = <linepattern> SOLID
LINETHICKNESS <op> <dexp> = 0.1
MESHTYPE = <meshtype> OVERLAY
PATTERNLENGTH <op> <dexp> =2
SHOW = <boolean> YES
}
POINTS
{
IJKSKIP <<ijk>> I = 1, J = 1, K = 1 Limits the number of vectors or
scatter symbols drawn.
110
Parameter Syntax Default Notes
POINTSTOPLOT <pointstoplot> SURFACENODES
}
SCATTER
{
COLOR = <color> BLACK
FILLCOLOR = <color> WHITE
FILLMODE = <fillmode> NONE
FRAMESIZE <op> <dexp> 2.5 Size of symbols when
SIZEBYVARIABLE is NO.
LINETHICKNESS <op> <dexp> 0.1
SHOW = <boolean> YES
SIZEBYVARIABLE = <boolean> NO Scatter sizing variable must be
defined before this can be set to YES.
See the $!GLOBALSCATTER
command.
SYMBOLSHAPE <<symbolshape>> See Notes ISASCII = NO, GEOMSHAPE =
SQUARE
}
SHADE
{
COLOR = <color> WHITE
SHOW = <boolean> YES
USELIGHTINGEFFECT = <boolean> YES
}
SURFACES
{
IRANGE <<indexrange>> See Notes MIN=1, Max=0, Skip=1
JRANGE <<indexrange>> See Notes MIN=1, Max=1, Skip=1
KRANGE <<indexrange>> See Notes MIN=1, Max=1, Skip=1
SURFACESTOPLOT = <surfacestoplot> NONE
}
VECTOR
{
ARROWHEADSTYLE <arrowheadstyle> PLAIN
COLOR = <color> BLACK
ISTANGENT = <boolean> NO
LINEPATTERN = <linepattern> SOLID
LINETHICKNESS = <dexp> 0.1
PATTERNLENGTH = <dexp> 2
SHOW = <boolean> YES
VECTORTYPE = <vectortype> TAILATPOINT
}
VOLUMEMODE VOLUMEMODE applies to volume
zones, with the exception that
{ POINTSTOPLOT also applies to
VOLUMEOBJECTSTOPLOT <<volumeobjectstoplot>> SHOWISOSURFACES=YE finite-element surface zones.
S, SHOWSLICES=YES,
SHOWSTREAMTRACES=
YES
}
GROUP = <integer> 1 Assign a group number to the
supplied set of zones.
Examples:
111
Example 1:
Change the contour plot type to flood for zones 1-12:
$!FIELDMAP [1-12]
CONTOUR
{
CONTOURTYPE = FLOOD
}
Example 2:
Change the mesh color to red for all zones (default mesh color is black):
$!FIELDMAP
MESH
{
COLOR = RED
}
$!FILECONFIG
Syntax: $!FILECONFIG
[optional parameters]
Description:A SetValue command that sets file path information in Tecplot 360.
112
Optional Parameters
Parameter Syntax Default Notes
ADDZONESTOEXISTINGSTRANDS = <boolean> NO If YES, Tecplot 360 will add the zones from the
appended data to any existing strands in the dataset.
If NO, Tecplot 360 will append the strands from the
new data to any existing strands in the dataset.
ASSIGNSTRANDIDS = <boolean> NO If YES, Tecplot 360 will assign strand ID's to zones (if
time is supplied for the zones but not strand ID's). If
NO, Tecplot 360 will not associate these zones with
any strands.
DATAFILEVARLOADMODE = <varloadmode> BYNAME Set the default loading mode for variables. BYNAME
loads variables based on their name. If set to
BYNAME, then VARNAMELIST must be supplied as
well.
BYPOSITION loads variables based on their position
in the file. To get Tecplot Version 7.0 behavior, use
BYPOSITION.
DOAUTOFNAMEEXTENSION = <boolean>
DOAUTOFNAMEEXTENSIONWARNING = <boolean> If YES a warning is displayed when attempting to
save with an extension other than the default
extension.
FNAMEFILTER
{
COLORMAPFILE = <string> Default extension for color map files.
EQUATIONFILE = <string> Default extension for equation files.
IMPORTIMAGEFILE = <string> Default extension for image files.
INPUTDATAFILE = <string> Default extension for Tecplot 360 input data files.
INPUTLAYOUTFILE = <string> Default extension for loading layout files.
MACROFILE = <string> Default extension for macro files.
OUTPUTASCIIDATAFILE = <string> Default extension for ASCII output data files.
OUTPUTBINARYDATAFILE = <string> Default extension for binary output data files.
OUTPUTLAYOUTFILE = <string> Default extension for saving linked layout files.
OUTPUTLAYOUTPACKAGEFILE = <string> Default extension for saving layout package files.
STYLEFILE = <string> Default extension for style files.
}
LAYOUTCONFIG
{
INCLUDEDATA = <boolean> NO If YES, layout packages are the default format for
layouts
INCLUDEPREVIEW = <boolean> NO If YES, preview images are saved with layout
packages.
USERELATIVEPATHS = <boolean> YES If YES, files will be referenced using relative paths in
layout files.
}
LOADONDEMAND
{
ALLOW = <boolean> YES If YES, Tecplot 360 EX will use its load-on-demand
features for loading and unloading variables.
DATASTORESTATEGY = <dataloadstrategy> AUTO Set the data store strategy for load-on-demand. If set
to AUTO, Tecplot 360 EX will use store large allocations
in the temporary directory and use memory mapped
I/O to read and write to the regions when possible
otherwise it will use the memory heap (usually this
provides better performance for large data). If set to
HEAP Tecplot 360 will not use the temporary directory
for large allocations (this option is usually slower
when working with large data).
113
Parameter Syntax Default Notes
UNLOADSTRATEGY = <unloadstrategy> AUTO Set the unload strategy for load-on-demand. If set to
AUTO Tecplot 360 will unload unused variables when
the amount needed RAM begins to reach the
maximum amount of RAM. If set to NEVERUNLOAD
Tecplot 360 will load variables on demand but will
never attempt to unload them even if it is running low
on memory. If set to MINIMIZEMEMORYUSE Tecplot
360 will aggressively unload variables as soon as they
are not needed regardless of the amount of memory
available or in use.
}
TEMPFILEPATH = <string> Set the directory where you want Tecplot 360 to store
its temporary files.
File Name Filters:Valid characters are upper or lowercase A-Z, and 0-9. Each filter should be
preceded by (*), or it will not filter properly. On Windows operating systems, to allow more than one
®
extension, separate them with a semicolon (;). On Linux and Mac platforms, multiple extensions will not
filter correctly unless they follow the standard shell filter format.
Windows Example:This example filters all four extensions when opening a layout file.
$!FILECONFIG FNAMEFILTER {INPUTLAYOUTFILE = "*.wsf;*.dwr;*.lay;*.lpk"}
Windows Example:This example filters both extensions when writing a layout file. The default
extension is .wsf because it is the first extension presented in the list.
$!FILECONFIG FNAMEFILTER {OUPUTLAYOUTFILE = ".wsf;*.lay"}
Linux Example:This example filters .aek, .plt, and more.
$!FILECONFIG FNAMEFILTER {INPUTDATAFILE = "*.[ae][el][kt]"}
Linux Example:This example filters .dat, .cam, and more. The default extension is .dat because D
and T are the first letters presented within the brackets.
$!FILECONFIG FNAMEFILTER {OUTPUTASCIIDATAFILE = "*.[dc]a[tm]"}
Example: Set the directory where Tecplot 360 stores temporary files to be /usr/tmp:
$!FILECONFIG
DATAFILEVARLOADMODE = BYPOSITION
TEMPFILEPATH = "/usr/tmp"
LAYOUTCONFIG {USERELATIVEPATHS = YES}
FNAMEFILTER
{
INPUTDATAFILE = "*.[pd][la]t"
COLORMAPFILE = "*.clr"
}
$!FONTADJUST
Syntax: $!FONTADJUST
[optional parameters]
Description:A SetValue command that sets character spacing and sizing for fonts in Tecplot 360. These
parameters rarely change.
114
Optional Parameters
Parameter Syntax Default Notes
BOLDFACTOR <op> <double> Thickness of bold characters relative to normal.
INTERCHARSPACING <op> <integer> Increase or decrease inter-character spacing. Units are in pixels
on the screen.
STROKEFONTLINETHICKNESS <op> <double> Thickness (in frame units) of lines used to draw stroke fonts.
SUBSUPFRACTION <op> <double> Size of subscript and superscript characters relative to the font
height.
Example: Make superscript and subscript characters 1/3 the font height:
$!FONTADJUST
SUBSUPFRACTION = 0.333
$!FOURIERTRANSFORM
Syntax: $!FOURIERTRANSFORM
INDEPENDENTVAR = <integer>
WINDOWFUNCTION = <windowfunction>
DEPENDENTVARS = <set>
SOURCEZONES = <set>
INCLUDECONJUGATES = <boolean>
OBEYSOURCEZONEBLANKING = <boolean>
[no optional parameters]
Description:Performs a Fourier transform for each dependent variable for each source zone. A new zone
containing the resulting frequency, amplitude, and phase variables (three for each dependent
variable) is created for each source zone. If the independent variable is non-uniform, the resulting
frequency is a modification of the original data (see discussion below for the INDEPENDENTVAR
and OBEYSOURCEZONEBLANKING parameters). Resulting zones are assigned new time strands
using the same groupings as the source zones if they belong to time stands; otherwise, the resulting
zones are static.
Fourier transform result zones are named "Fourier Transform" followed by a mixture of text
indicating the source zone, independent variable, and window function used. Similarly, the three
variables created are given the names "Frequency", "Amplitude", and "Phase" followed by the
dependent variable used. Newly-created zones are assigned passive variables for all variables that
previously existed in the data set, and all previously-existing zones are assigned passive variables
for all new variables created by the Fourier transform.
115
Required Parameters
Parameter Syntax Notes
INDEPENDENTVAR = <integer> Independent variable used for the frequency domain. If the spacing is
non-uniform, this variable is used in conjunction with each dependent
variable for interpolation to create a uniform frequency domain for the
transform.
WINDOWFUNCTION = <windowfunction> Window function or tapering function applied to the dependent variables
before performing the transform but after performing the non-uniform
interpolation. For details, see https://en.wikipedia.org/wiki/
Window_function
DEPENDENTVARS = <set> Set of dependent variables on which to perform a Fourier transform. The
variables must not be the same as the independent variable. This must not
be NULL or an empty set and must be a subset of the variables in the
source zones.
SOURCEZONES = <set> Set of source zones containing the dependent variables on which to
perform the Fourier transform. This must not be NULL or an empty set
and must be a subset of the data set’s available zones.
INCLUDECONJUGATES = <boolean> For purely real numbers, the Fourier transform output satisfies the
Hermitian redundancy where out[i] is the conjugate of out[n-i]. If this
parameter is YES, the conjugates are included, otherwise they are not, and
approximately half of the output values, n/2+1, are computed.
OBEYSOURCEZONEBLANKING = <boolean> If value blanking is active and this value is YES, value blanking is applied
to the data values of both the independent and dependent variables before
the data is interpolated for non-uniformity. If data values eliminated from
the independent or dependent variables cause the data to be non-uniform,
the values are interpolated appropriately. Additionally, all blanked data
values up to the first non-blanked data value and all blanked data values
after the last non-blanked data value are ignored, providing a mechanism
to constrain the domain over which the Fourier transformation is
performed.
Optional Parameters
Parameter Syntax Default Notes
REPLACEMATCHINGRESULTZONES = <boolean> NO If YES, any existing result zones for the specified
combination of source zone, independent variable, and
window function are re-used. If NO, new result zones are
created.
REPLACEMATCHINGRESULTVARIABLES = <boolean> NO If YES, any existing result variables for the specified
dependent variables are re-used. If NO, new result
variables are created.
Example: Perform a Fourier transform on variables 2 through 11 of zones 1 through 10 obeying source zone
blanking, applying the Hann window function and excluding conjugates from the output.
$!FOURIERTRANSFORM
INDEPENDENTVAR = 1
WINDOWFUNCTION = HANN
DEPENDENTVARS = [2-11]
SOURCEZONES = [1-10]
INCLUDECONJUGATES = NO
OBEYSOURCEZONEBLANKING = YES
Description:The different commands in the FRAMECONTROL compound function family are described
separately in the following sections. When working with the FRAMECONTROL commands, it may help
to realize that a command containing "Activate" changes the active frame; a command containing
"MoveTo" changes the frame drawing order.
The FRAMECONTROL compound functions following are:
$!FRAMECONTROL ActivateTop
$!FRAMECONTROL ActivateNext
116
$!FRAMECONTROL ActivatePrevious
$!FRAMECONTROL ActivateAtPosition
$!FRAMECONTROL ActivateByName
$!FRAMECONTROL ActivateByNumber
$!FRAMECONTROL MoveToTopActive
$!FRAMECONTROL MoveToTopByName
$!FRAMECONTROL MoveToTopByNumber
$!FRAMECONTROL MoveToBottomActive
$!FRAMECONTROL MoveToBottomByName
$!FRAMECONTROL MoveToBottomByNumber
$!FRAMECONTROL DeleteActive
$!FRAMECONTROL FitAllToPaper
$!FRAMECONTROL ACTIVATETOP
$!FRAMECONTROL ACTIVATETOP
$!FRAMECONTROL ACTIVATENEXT
Example:
$!FRAMECONTROL ACTIVATENEXT
$!FRAMECONTROL ACTIVATEPREVIOUS
Example:
$!FRAMECONTROL ACTIVATEPREVIOUS
$!FRAMECONTROL ACTIVATEATPOSITION
117
Required Parameters
Parameter Syntax Notes
X = <dexp> Specify X-coordinate of position.
Y = <dexp> Specify Y-coordinate of position.
Example:
$!FRAMECONTROL ACTIVATEBYNAME
Required Parameter
Parameter Syntax Notes
NAME = <string> Specify name of the frame to activate.
$!FRAMECONTROL ACTIVATEBYNUMBER
Required Parameter
Parameter Syntax Notes
FRAME = <integer> Specify number of the frame to activate.
$!FRAMECONTROL MOVETOTOPACTIVE
$!FRAMECONTROL MOVETOTOPACTIVE
118
$!FRAMECONTROL MOVETOTOPBYNAME
Required Parameter
Parameter Syntax Notes
NAME = <string> Specify name of the frame to move to the top of the drawing order.
Example: Moves the frame named Topography to the top of the drawing order.
$!FRAMECONTROL MOVETOTOPBYNUMBER
Required Parameter
Parameter Syntax Notes
FRAME = <integer> Specify number of the frame to move to the top of the drawing order.
$!FRAMECONTROL MOVETOBOTTOMACTIVE
$!FRAMECONTROL MOVETOBOTTOMACTIVE
$!FRAMECONTROL MOVETOBOTTOMBYNAME
119
Required Parameter
Parameter Syntax Notes
NAME = <string> Specify name of the frame to move to the bottom.
Example:
$!FRAMECONTROL MOVETOBOTTOMBYNUMBER
Required Parameter
Parameter Syntax Notes
FRAME = <integer> Specify number of the frame to move to the bottom.
$!FRAMECONTROL DELETEACTIVE
$!FRAMECONTROL DELETEACTIVE
$!FRAMECONTROL FITALLTOPAPER
$!FRAMECONTROL FITALLTOPAPER
$!FRAMELAYOUT
Syntax: $!FRAMELAYOUT
[optional parameters]
Description:A SetValue command that sets the position, border, and background attributes for the active
120
frame. Use the $!FRAMECONTROL action command to push and pop frames if you want to change the
settings for a frame other than the active frame.
Optional Parameters
Parameter Syntax Default Notes
BACKGROUNDCOLOR = <color> WHITE Only applies if ISTRANSPARENT = NO.
BORDERTHICKNESS <op> <dexp> = 0.1 Value is in Y-frame units.
FRAMESIZEPOSUNITS = <framecoordmode> Whether frame sizes and positions are in absolute units
(paper) or relative screen units from 0 to 1 (workspace)
HEADERCOLOR = <color> RED Only applies if SHOWHEADER = YES.
HEADERFONTAMILY = <string> "Helvetica"
HEIGHT <op> <dexp> =8 Value is in inches.
HEADERFONTISBOLD = <boolean> YES
HEADERFONTISITALIC = <boolean> NO
ISTRANSPARENT = <boolean> NO
SHOWBORDER = <boolean> YES
SHOWHEADER = <boolean> NO
WIDTH <op> <dexp> =9 Value is in inches.
XYPOS <<xy>> X=1, Y=0.25 Position of upper left corner of the frame in inches from
left and top edge of the paper.
Example:
Place the active frame in the upper left corner of the paper (offset 0.5 inches from the top and left edges),
make the frame dimensions 3 by 4 inches, and turn off the frame border:
$!FRAMELAYOUT
SHOWBORDER = NO
XYPOS
{
X = 0.5
Y = 0.5
}
WIDTH = 3
HEIGHT = 4
$!FRAMENAME
$!FRAMESETUP
Syntax: $!FRAMESETUP
[optional parameters]
Description:A SetValue command that sets parameters used to preset dynamic frame attributes when a
frame is initialized.
121
Optional Parameters
Parameter Syntax Default Notes
ALIGNINGCONTOURLABELS = <boolean> YES If YES, the next interactively placed contour label
is aligned to the contour line.
ASSIGNSEQUENCEDZONECOLORS = <boolean> NO If set to YES, the values set via $!FIELDMAP
[nnn] MESHLAYER {COLOR = <color>} are used
for default zone mesh colors (similarly for Edge
colors).
FITINITIALFRAMETOWORKSPACE = <boolean> YES If set to NO, the new layout is shown as in V10
with the entire paper fit to the work area. If set to
YES, the new layout is shown with the active
frame fit to the work area.
This command changes the behavior of Tecplot
360 as it first appears during a session and as it
appears after a new layout command. It has no
effect on the current plot, but it can be used in a
macro to set the value for future new plots. It is
typically found in the tecplot.cfg file.
INITIAL3DFITTOSURFACES = <boolean> YES If YES, initial 3D plot shows a view equivalent to
using “$!View FitSurfaces” or the View->Fit
Surface menu item, and ignores the "
$!FrameSetup Initial3DScale" parameter.
If NO, initial 3D plot is equivalent to using the
value of "$!FrameSetup Initial3DScale" in the
View->Translate/Magnify dialog or using the "
$!View Scale=<double>" command. This value
defaults to YES for 360 EX and NO for Focus.
INITIAL3DSCALE <op> <dexp> = 1.1 Initial scale for 3D plots.
NUMSTREAMRAKEPOINTS <op> <integer> = 10 Number of points to place along streamtrace
rakes.
NUMSTREAMSURFACEPOINTS <op> <integer> =1 Number of points to place when seeding
streamtraces on surfaces.
RODRIBBONDEFLEN <op> <dexp> = 0.06 Default width (in frame units) of a streamtrace or
ribbon
SHOWAPPENDEDZONES = <boolean> YES If set to NO, zones added via an append data
operation will be turned off initially.
SHOWNONWALLBOUNDARYZONES = <boolean> NO If set to YES, any new zone that has a non-wall
BOUNDARYCONDITION defined will be turned
off initially.
VECTDEFLEN <op> <dexp> = 0.06 When a vector plot is drawn for the first time the
vector magnitude is adjusted so the longest
vector is VECTDEFLEN units long. VECDEFLEN
is in frame units.
VECTMINLEN <op> <dexp> = 0.0005 Minimum length in centimeters. Vectors shorter
than this length are not drawn.
USECOMMONSORTSTACK YES
DEFAULT2DSTREAMTRACESTREAMDIRECTION BOTH
DEFAULT3DSTREAMTRACESTREAMDIRECTION BOTH
Example: Make the default length for the longest vector five percent:
$!FRAMESETUP
VECTDEFLEN = 5
$!GETAUXDATA
122
[optional parameters]
Description:Retrieve Auxiliary Data in the form of name/value pairs from the given location and store it in
the macro variable.
Required Parameters
Parameter Syntax Notes
AUXDATALOCATION = [layout/zone/var/dataset/frame/linemap|page]
NAME = <string> Name of existing auxiliary data
Optional Parameters
Parameter Syntax Default Notes
MAP = <integer> Only required if AUXDATALOCATION = linemap
VAR = <integer> Only required if AUXDATALOCATION = var
ZONE = <integer> Only required if AUXDATALOCATION = zone
Example: Get the Auxiliary Data from Zone 2, and store it in the macro variable |ABC|:
$!GETAUXDATA |ABC|
AUXDATALOCATION = zone
NAME = ’ABC.Aux.Data’
ZONE = 2
$!GETCONNECTIVITYREFCOUNT
Required Parameters
Parameter Syntax Default Notes
ZONE = <integer>
Example:
Fetch the connectivity count from Zone 2, and store it in the macro variable |ABC|. If zones 2, 5 and 6 share
connectivity, |ABC| = 3.:
$!GETCONNECTIVITYREFCOUNT |ABC|
ZONE = 2
$!GETCURFRAMENAME
123
Example: Put the name of the active frame into the macro variable |CFRAME|.
$!GETCURFRAMENAME |CFRAME|
$!GETFIELDVALUE
Required Parameters
Parameter Syntax Notes
INDEX = <integer>
VAR = <integer>
ZONE = <integer>
Example:
A data set contains 2 zones and 3 variables. Zone 2 is dimensioned 5 by 3. Fetch the value from variable 3
at IJ-location (2, 2), and store it in the macro variable |ABC|:
$!GETFIELDVALUE |ABC|
ZONE = 2
VAR = 3
INDEX = 7
Note: INDEX was calculated using:
INDEX = I + (J-1)*|MAXI| + (K-1) * |MAXI| * |MAXJ|
= 5*(2-1)+2
= 7
$!GETFIELDVALUEREFCOUNT
Required Parameters
Parameter Syntax Notes
VAR = <integer>
ZONE = <integer>
Example:
124
A data set contains 5 zones and 3 variables. Zones 1, 2 and 4 share variable 3, and zones 3 and 5 share
variable 3.
$!GETFIELDVALUEREFCOUNT |ABC|
ZONE = 2
VAR = 3
This returns |ABC| = 3, while
$!GETFIELDVALUEREFCOUNT |DEF|
ZONE = 5
VAR = 3
returns |DEF| = 2 because the variable is not shared across all five zones.
$!GETNODEINDEX
Required Parameter
Parameter Syntax Default Notes
ZONE = <integer> Zone must be greater than or equal to one.
CORNER = <integer> Possible values are 1-3, 1-4, or 1-8, depending upon the element
type.
ELEMENT = <integer> Must be greater than or equal to one and less than or equal to
|MAXJ|.
Example: Get the index for the node at corner 3 of the last element in zone number 1.
$!GETZONETYPE |ZONETYPE|
ZONE = 1
$!IF "|ZONETYPE|" = "FE BRICK"
$!GETNODEINDEX |INDEX|
ZONE = 1
ELEMENT = |MAXJ|
CORNER = 3
... Do something with |INDEX|...
$!ENDIF
$!GETVARLOCATION
125
Required Parameter
Parameter Syntax Notes
VAR = <integer>
ZONE = <integer>
Example: Get the variable location for the third variable in zone 1.
$!GETVARLOCATION |ABC|
ZONE = 1
VAR = 3
$!GETVARNUMBYNAME
Required Parameter
Parameter Syntax Notes
NAME = <string> Name of the variable. If a variable has aliases, the name must correspond to one of
the aliases.
Example:
Get the variable number for the variable named PRESSURE and make it the contouring variable.
$!GETVARNUMBYNAME |PVARNUM|
NAME = "PRESSURE"
$!GLOBALCONTOUR
VAR = |PVARNUM|
$!GETZONETYPE
126
Required Parameter
Parameter Syntax Notes
ZONE = <integer> Zone must be greater than or equal to one.
Example:
$!GETZONETYPE |ZONETYPE|
ZONE = 1
$!IF "|ZONETYPE|" == "FETRIANGLE"
$!PAUSE "The zone is FE-Triangle."
$!ENDIF
$!GLOBALCONTOUR
Syntax:$!GLOBALCONTOUR <contourgroup>
[optional parameters]
Description:A SetValue command that changes global attributes associated with contour plots or contour
levels. The optional parameter <contourgroup> refers to the defined contour groups, 1-8, allowed
in Tecplot 360, and takes an integer value of one through eight. The <contourgroup> parameter is
optional, and if omitted, Tecplot 360 will use contour group 1. If you would like the settings in
these commands to persist, add them to your tecplot.cfg file, located in your installation directory.
The NUMBERFORMAT setting for LABELS also controls the number format in the legend.
Optional Parameters
If you would like the settings in these commands to persist, add them to your tecplot.cfg file (located in your
installation directory).
127
Parameter Syntax Default Notes
COLORMAPOVERRIDEACTIVE = <boolean> NO
CONTINUOUSCOLOR <<continuouscolor>> CMIN=0, CMAX=1
REVERSECOLORMAP = <boolean>
USEFASTAPPROXCONTINUOUSFLOOD = <boolean>
ZEBRA <<zebrashade>>
}
DEFNUMLEVELS = <integer> 15 Sets the target number of
contour levels for situations
where contour levels are
automatically reset. Tecplot
360 will attempt to create
levels where the start, end and
increment values are all
clipped floating point values.
LABELS
{
ALIGNAUTOLABELS = <boolean> YES If YES, automatic labels are
aligned with the contour lines,
otherwise they are horizontal.
AUTOLABELSPACING <op> <dexp> = 30
AUTOLEVELSKIP <op> <integer> =1 Value is in Y-frame units.
COLOR = <color> BLACK
FILLCOLOR = <color> WHITE
GENERATEAUTOLABELS = <boolean> YES If YES, automatic labels are
repositioned on each redraw.
ISFILLED = <boolean> YES
LABELWITHVALUE = <boolean> YES If YES, automatic labels show
the contour value otherwise
they show the contour level
number.
MARGIN <op> <dexp> =5
NUMFORMAT <<numberformat>> See Notes FORMATTING=BESTFLOAT,
CUSTOMLABEL=1,
PRECISION=4,
SHOWDECIMALSON
WHOLENUMBERS=NO,
REMOVELEADINGZEROS=
NO, SHOWNEGATIVESIGN=
YES, TIMEDATEFORMAT=
’yyyy-mm-dd hh:mm:ss.00’
SHOW = <boolean> NO
TEXTSHAPE <<textshape>> FONTFAMILY="Helevetica", Not allowed to change size
ISBOLD=NO, ISITALIC=NO, units parameter.
SIZEUNITS=FRAME, HEIGHT=1.5
}
LEGEND
{
ANCHORALIGNMENT <anchoralignment> TOPRIGHT
AUTORESIZE = <boolean> NO
AUTOSIZEMAXLIMIT = <double> 0.5
BOX <<textbox>> See Notes BOXTYPE=HOLLOW,
MARGIN=10,
LINETHICKNESS=0.1,
COLOR=BLACK,
FILLCOLOR=WHITE
HEADERTEXTSHAPE <<textshape>> FONTFAMILY="Helvetica",
ISBOLD=NO, ISITALIC=NO,
SIZEUNITS=FRAME, HEIGHT=2.5
INCLUDECUTOFFLEVELS = <boolean> NO
ISVERTICAL = <boolean> YES
LABELINCREMENT = <double> 1
LABELLOCATION = <contourlabellocation> CONTOURLEVELS
128
Parameter Syntax Default Notes
NUMBERTEXTSHAPE <<textshape>> FONTFAMILY="Helvetica",
ISBOLD=NO, ISITALIC=NO,
SIZEUNITS=FRAME, HEIGHT=2.5
OVERLAYBARGRID = <boolean> YES Thin line around each band in
the color bar.
ROWSPACING <op> <dexp> = 1.2
SHOW = <boolean> NO
SHOWHEADER = <boolean> YES
TEXTCOLOR = <color> BLACK
XYPOS <<xy>> X = 95, Y = 80
}
VAR = <integer> 3 Var used for contour levels.
COLORCUTOFF
{
RANGEMIN = <double> -1 x 10150
RANGEMAX = <double> -1 x 10150
INCLUDEMIN = <boolean> NO
INCLUDEMAX = <boolean> NO
INVERTCUTOFF = <boolean> NO
}
CONTOURLINESTYLE
{
CONTOURLINEMODE = <contourlinemode> USEZONELINETYPE
LINESKIP = <integer> 4
PATTERNLENGTH = <dexp> 2
}
Example:
This example does the following: Turns on the contour legend; Sets the flood cutoff to go from 3 to 5;
Reverses the color map; Inserts a color map override of yellow between contour level number 7 and level
number 9.
$!GLOBALCONTOUR 1
LEGEND
{
SHOW = YES
}
COLORCUTOFF
{
RANGEMIN = 3
RANGEMAX = 5
INCLUDEMIN = YES
INCLUDEMAX = YES
}
COLORMAPFILTER
{
REVERSECOLORMAP = YES
COLORMAPOVERRIDEACTIVE = YES
COLORMAPOVERRIDE 1
{
INCLUDE = YES
COLOR = YELLOW
STARTLEVEL = 7
ENDLEVEL = 9
}
}
129
$!GLOBALEDGE
Syntax: $!GLOBALEDGE
Description:A SetValue command that sets attributes which sets the minimum crease angle for edges.
Optional Parameters
If you would like the settings in this command to persist, add them to your tecplot.cfg file (located in your installation
directory).
$!GLOBALFRAME
Syntax: $!GLOBALFRAME
[optional parameters]
Description:A SetValue command that sets attributes which apply to all frames. If you would like the
settings in this command to persist, add it to your tecplot.cfg file, located in your installation
directory.
Optional Parameters
If you would like the settings in this command to persist, add them to your tecplot.cfg file (located in your installation
directory).
Example:
Customize the frame header text, and set the frame header height to be 0.25 inches:
$!GLOBALFRAME
FRAMEHEADERFORMAT = "My frame, the current date is &(Date), &(Time)"
FRAMEHEADERHEIGHT = 0.25
130
$!GLOBALLINEPLOT
Syntax: $!GLOBALLINEPLOT
[optional parameters]
Description:A SetValue command that changes global attributes associated with Line-plots. If you would like
the settings in these commands to persist, add it to your tecplot.cfg file, located in your installation
directory.
Optional Parameters
If you would like the settings in these commands to persist, add them to your tecplot.cfg file (located in
your installation directory).
Example:
Turn on the data labels and show the line legend. Use boldface Times font in the legend:
$!GLOBALLINEPLOT
DATALABELS
{
SHOWNODELABELS = YES
131
}
LEGEND
{
SHOW = YES
TEXTSHAPE
{
FONTFAMILY = "Times"
ISBOLD = YES
ISITALIC = NO
}
}
}
$!GLOBALPAPER
Syntax: $!GLOBALPAPER
[optional parameters]
Description:A SetValue command that sets the paper size characteristics. If you would like the settings in this
command to persist, add it to your tecplot.cfg file, located in your installation directory.
Optional Parameters
If you would like the settings in these commands to persist, add them to your tecplot.cfg file (located in
your installation directory).
$!GLOBALPOLAR
Syntax: $!GLOBALPOLAR
[optional parameters]
Description:Allows polar plots to have curved lines that are interpolated along the R-Axis between data
points.
132
Optional Parameters
If you would like the settings in this command to persist, add them to your tecplot.cfg file (located in your
installation directory).
Example:
This example turns on curved lines and defines the maximum angle to be approximated as a curved line to
be 2.0 degrees.
$!GLOBALPOLAR
DRAWSTRAIGHTLINES = NO
ANGLE = 2.0
$!GLOBALRGB
Syntax: $!GLOBALRGB
RGBMode = <rgbmode>
[optional parameters]
Description:Allows RGB coloring for plots which have RGB values specified at each vertex. This coloring
option is valuable for plots with entities such as Gas, Oil and Water. RGB Coloring can be assigned
to field plot objects such as zones, iso-surfaces and slices
Required Parameter
Parameter Syntax Default Notes
RGBMODE = <specifyrgb> SPECIFYRGB Sets whether the user specifies all three color variables for RGB
Coloring, or if Tecplot 360 calculates one variable while the user
specifies two.
Optional Parameters
If you would like the settings in these commands to persist, add them to your tecplot.cfg file (located in
your installation directory).
133
Parameter Syntax Default Notes
REDCHANNELLABEL = <string>
RGBLEGENDORIENTATION = <rgblegendorientation> RGB
SHOW = <boolean> NO
SHOWLABELS = <boolean> YES
TEXTCOLOR = <color> BLACK
TEXTSHAPE <<textshape>> See Notes FONTFAMILY="Helvetica", ISBOLD=NO,
ISITALIC=NO, SIZEUNITS=FRAME, HEIGHT=2.5
USEBLUEVARNAME = <boolean> YES
USEGREENVARNAME = <boolean> YES
USEREDVARNAME = <boolean> YES
XYPOS <<xy>> X = 80, Y = 80
}
Example:
This example turns on RGB Coloring and defines variables for the Red and Green Channel, leaving
Tecplot 360 to calculate the Blue Channel values.
$!GLOBALRGB
RGBMODE = SPECIFYRG
REDCHANNELVAR = 1
GREENCHANNELVAR = 4
$!GLOBALSCATTER
Syntax: $!GLOBALSCATTER
[optional parameters]
Description:A SetValue command that changes global attributes associated with scatter plots.
Optional Parameters
If you would like the settings in these commands to persist, add them to your tecplot.cfg file (located in
your installation directory).
134
Parameter Syntax Default Notes
SHOWNODELABELS = <boolean> NO
SKIPMODE = <skipmode>
TEXTSHAPE <<textshape>> See Notes Not allowed to change size units parameter.
FONTFAMILY="Helvetica", ISBOLD=NO,
ISITALIC=NO, SIZEUNITS=FRAME, HEIGHT=3
}
ISBOLD = <boolean> YES
ISITALIC = <boolean> NO
LEGEND
{
ANCHORALIGNMENT <<anchorpos>> TOPRIGHT
BOX <<textbox>> See Notes BOXTYPE=HOLLOW,MARGIN=10,
LINETHICKNESS=0.1, COLOR=BLACK,
FILLCOLOR=WHITE
ROWSPACING <op> <dexp> = 1.2
SHOW = <boolean> NO
SHOWTEXT = <boolean> YES
TEXTCOLOR = <color> BLACK
TEXTSHAPE <<textshape>> See Notes Not allowed to change size units parameter.
FONTFAMILY="Helvetica", ISBOLD=YES,
ISITALIC=NO, SIZEUNITS=FRAME, HEIGHT=3
XYPOS <<xy>> X=95, Y=80
}
NUMCIRCLEPOINTS = <integer> 12 Number of points used to draw circle scatter symbols.
Range 12-360.
REFSCATSYMBOL
{
COLOR = <color> RED
FILLCOLOR = <color> RED
ISFILLED = <boolean> NO
LINETHICKNESS <op> <dexp> = 0.1
MAGNITUDE <op> <dexp> =1
SHOW = <boolean> NO
SYMBOLSHAPE <<symbolshape>> See Notes ISASCII=NO, GEOMSHAPE=SQUARE
XYPOS <<xy>> X=80, Y=80
}
RELATIVESIZE <op> <dexp> =0 Scaling factor for scatter symbols sized “By Variable.”
RELATIVESIZEINGRIDUNITS = <boolean> YES If YES, scatter sizing “By Variable” is in grid units /
magnitude otherwise centimeters/magnitude.
SPHERESCATTERRENDERQUALITY = <spherescatterrenderquality> HIGH Config file and stylesheet only option.
VAR = <integer> Scatter sizing variable.
Example:
This example does the following:
• Increases the relative size of scatter symbols that are sized by variable by ten percent.
• Turns on the scatter sizing legend.
• Turns on the reference scatter symbol and makes it red.
• Turns on data labels for nodes.
$!GLOBALSCATTER
RELATIVESIZE * = 1.1
LEGEND
{
SHOW = YES
135
}
REFSCATSYMBOL
{
SHOW = YES
COLOR = RED
}
DATALABELS
{
SHOWNODELABELS = YES
}
$!GLOBALTHREED
Syntax: $!GLOBALTHREED
[optional parameters]
Description:A SetValue command that changes global attributes associated with 3D plots.
Optional Parameters
If you would like the settings in these commands to persist, add them to your tecplot.cfg file (located in
your installation directory).
136
Parameter Syntax Default Notes
NORMAL <<xyz>> X=0, Y=0, Z=1
}
SYMBOLLIFTFRACTION <op> <dexp> = 0.6
VECTORLIFTFRACTION <op> <dexp> = 0.7
Example:
$!GLOBALTHREEDVECTOR
Syntax: $!GLOBALTHREEDVECTOR
[optional parameters]
Description:A SetValue command that changes global attributes associated with 3D vector plots.
Optional Parameters
If you would like the settings in these commands to persist, add them to your tecplot.cfg file (located in
your in installation directory).
137
Parameter Syntax Default Notes
NUMFORMAT <<numberformat>> See Notes FONTFAMILY="Helvetica", ISBOLD=YES, ISITALIC=NO,
SIZEUNITS=FRAME, HEIGHT=3
OFFSET = <double> 2
}
}
RELATIVELENGTH <op> <dexp> =0
RELATIVELENGTHIN = <boolean> YES If YES and USERELATIVE is YES then vectors are sized in Grid
Units/Magnitude. If NO and USERELATIVE is YES then vectors
GRIDUNITS are sized in cm/magnitude.
SIZEHEADBY = <boolean> YES If YES, HEADSIZEASFRACTION is used to size arrowheads
otherwise HEADSIZEINFRAMEUNITS is used.
FRACTION
UNIFORMLENGTH <op> <dexp> =2 Value is in Y-frame units.
USERELATIVE = <boolean> YES If NO, vectors are all the same size (UNIFORMLENGTH).
UVAR = <integer> Variable number for the X-vector component.
VVAR = <integer> Variable number for the Y-vector component.
WVAR = <integer> Variable number for the Z-vector component.
Example:
This example does the following:
• Makes all vectors be uniform in size; 5 percent in Y-frame units.
• Makes the arrowheads 0.2 times the size of the stems.
• Turns off the reference vector.
$!GLOBALTHREEDVECTOR
USERELATIVE = NO
UNIFORMLENGTH = 5
HEADSIZEASFRACTION = .2
REFVECTOR
{
SHOW = NO
}
$!GLOBALTIME
$!GLOBALTWODVECTOR
Syntax: $!GLOBALTWODVECTOR
[optional parameters]
Description:A SetValue command that changes global attributes associated with 2D vector plots.
138
Optional Parameters
If you would like the settings in these commands to persist, add them to your tecplot.cfg file (located in
your installation directory).
Example:
This example does the following:
• Doubles the vector length (assume vectors currently drawn using relative length).
• Make the vector heads uniform in size; 2 percent in frame units.
• Make the head angle 15 degrees.
$!GLOBALTWODVECTOR
RELATIVELENGTH *= 2
SIZEHEADBYFRACTION = NO
HEADSIZEINFRAMEUNITS = 2
HEADANGLE = 15
139
I
$!IF...$!ENDIF
Example 1:
Process macro commands if the macro variable |myvar| is less than 73.2:
Example 2:
Process macro commands if the macro variable |response| is YES:
$!INCLUDEMACRO
$!INCLUDEMACRO "m2.mcr"
$!INTERFACE
Syntax: $!INTERFACE
[optional parameters]
Description:A SetValue command that sets attributes related to the Tecplot 360 interface.
140
Optional Parameters
If you would like the settings in these commands to persist, add them to your tecplot.cfg file (located in
your installation directory). Some can be used only in tecplot.cfg.
141
Parameter Syntax Default Notes
POLYCELL = [USECCVALUE, AVERAGENODES This parameter only appears in the
INTERPOLATIONMODE AVERAGENODES] tecplot config file. When using
contour flooding, contour lines, or
precise value blanking for polyhedral
and polygonal data, it chooses
between using the cell-centered value
or using the average of the nodes.
This parameter also applies to the
creation of iso-surfaces for cell-
centered values in a polyhedral zone.
It does not apply to Primary Value
contour flooding.
}
ENABLEDELAYS = <boolean> YES Enable or disable delays in macro
commands.
ENABLEERRORS = <boolean> YES If NO, no error message dialogs are
displayed.
ENABLEINTERRUPTS = <boolean> YES Enable or disable user interrupts.
ENABLEPAUSES = <boolean> YES Enable or disable pause.
ENABLEWARNINGS = <boolean> YES Enable or disable warning dialogs.
GLOBALPLACEMENTPLANE Use a placement plane.
{
SHOW Turn the placement plane on/off.
PLACEMENTPLANE Specify the axis orientation of the
ORIENTATION placement plane.
FONTPATH <string> The OS font One or more directories where
folder(s) TrueType fonts can be found, e.g. ’"
PATH1" "PATH2" "PATH3"’. Note
use of double quotes around each
path and single quotes around the
entire string.
IDOTSPERSQUAREINCH = <double> This along with
JDOTSPERSQUAREINCH set the
size and aspect of the screen. If left
unspecified, Tecplot 360 will
determine the value for you.
INTIALFIELDPROBE = [NODALVALUES, NODALVALUES
DIALOGPAGE ZONECELLINFO,
CELLCENTEREDVALUES,
or FACENEIGHBORS]
INITIALPLOT = <boolean> NO If YES, only the first enabled zone is
FIRSTZONEONLY activated. Default shows all zones
(except from within a layout).
INITIALPLOTTYPE = <plottype> AUTOMATIC
INTERRUPTCHECKING = <integer> Set the number of milliseconds
FREQUENCY between checks for a key- or button-
press by the user to interrupt
processing in Tecplot 360.
JDOTSPERSQUAREINCH = <double> This along with
IDOTSPERSQUAREINCH set the
size and aspect of the screen. If left
unspecified, Tecplot 360 will
determine the value for you.
LISTCOMMANDSIN = <boolean> If NO, macro commands are
MACROVIEWER displayed in full one at a time.
LOADADDONSUSING = <boolean> YES If set to NO, all add-on symbols are
LAZYRELOCATE loaded immediately.
MAXNUMUNDOLEVELS = <integer> 50
MINPIXELSFORDRAG = <integer> 1 Number of pixels to move the
pointer before it is considered a drag.
MOUSEACTIONS
{
MIDDLEBUTTON
{
142
Parameter Syntax Default Notes
BUTTONCLICK = <mousebuttonclick> REDRAW
SIMPLEDRAG = <mousebuttondrag> ZOOMDATA
CONTROLLEDDRAG = <mousebuttondrag> ZOOMDATA
ALTEDDRAG = <mousebuttondrag> ZOOMVIEWER
SHIFTEDDRAG = <mousebuttondrag> ZOOMPAPER
CONTROLALTEDDRAG = <mousebuttondrag> ZOOMVIEWER
CONTROLSHIFTEDDRAG = <mousebuttondrag> ZOOMPAPER
ALTSHIFTEDDRAG = <mousebuttondrag> ZOOMVIEWER
CONTROLALTSHIFTED = <mousebuttondrag> ZOOMPAPER
DRAG
}
RIGHTBUTTON
{
BUTTONCLICK = <mousebuttonclick> REVERTTOSELECT
SIMPLEDRAG = <mousebuttondrag> TRANSLATEDATA
CONTROLLEDDRAG = <mousebuttondrag> ROLLERBALL
ROTATEDATA
ALTEDDRAG = <mousebuttondrag> TRANSLATE
VIEWER
SHIFTEDDRAG = <mousebuttondrag> TRANSLATEPAPER
CONTROLALTEDDRAG = <mousebuttondrag> ZOOMVIEWER
CONTROLSHIFTEDDRAG = <mousebuttondrag> ROLLERBALL
ROTATEDATA
ALTSHIFTEDDRAG = <mousebuttondrag> TRANSLATEPAPER
CONTROLALTSHIFTEDDRAG = <mousebuttondrag> ZOOMVIEWER
}
}
NUMCOLORCELLSTORETURN = <integer> 10
NUMMOUSEBUTTONS = <integer> Only for Linux users who are using
MIDDLEMOUSEBUTTONMODE or
RIGHTMOUSEBUTTONMODE.
NUMPTSALLOWED = <integer> 500,000 When a frame’s active zones contain
BEFOREAPPROX this many points or less, the frame is
not approximated, but always drawn
in full. Applies to all frames when
PLOTAPPROXIMATIONMODE is
AUTOMATIC, and the active frame
if PLOTAPPROXIMATIONMODE is
NONCURRENTALWAYSAPPROX.
This setting has no effect when
PLOTAPPROXIMATIONMODE is
ALLFRAMESALWAYSAPPROX.
OKTOEXECUTES = <boolean> YES Allow use of $!SYSTEM commands
YSTEMCOMMAND in macros. This is a security issue. If
set to NO and the macro is run
interactively, you will be asked for
permission to execute the $!SYSTEM
command. If Tecplot 360 is run in
batch mode and this is NO an error
will be generated and the macro will
terminate.
OPENGLCONFIG
{
RUNDISPLAYLIST = <boolean> YES Tecplot 360 defaults to building and
SAFTERBUILDING running display lists simultaneously.
Turn RunDisplayListsAfterBuilding
on if you want to run the display lists
after they are built. This may increase
display list performance on some
machines. The difference is often
times negligible.
143
Parameter Syntax Default Notes
ALLOWHWACCELERATION = <boolean> YES Windows only. Disables hardware
acceleration in Tecplot 360 EX
without having to change the
Windows Display properties. Setting
ALLOWHWACCELERATION to NO
may fix errors caused by hardware
acceleration on buggy graphics card
drivers.
SCREENRENDERING <<renderconfig>> Sets options for screen rendering.
IMAGERENDERING <<renderconfig>> Sets options for offscreen rendering
(for image exports or raster printing).
MAXFILTERMAGNIFICATION = <integer> 2 Sets the maximum magnification by
non-texture resize filter before
textures are used. This keeps Tecplot
360 EX from creating textures which
are too large. Setting this above three
is not recommended. Setting below
1.0 will result in the use of a faster
texture algorithm.
INCLUDEBACKBUFFER = <boolean> NO
DURINGFRONTBUFFERDRAWS
PRETRANSLATEDATA = <pretranslatemode> AUTO Pre-translation may be used to solve
jitter issues with data that is far from
zero but has small deltas. On data
surrounding zero it is better to turn it
off. AUTO turns the setting on when
necessary based on your data.
USEADVANCED = <boolean> YES If YES, activate Tecplot’s advanced
VIUSUALCHOOSER OpenGL visual chooser, which will
attempt to choose a reasonable visual
based on your system capabilities. If
NO, the Qt visual chooser is used;
this may choose a different visual.
Also allows a fixed visual mode to be
specified using VISUALID (next).
Available in tecplot.cfg only and has
effect only on Linux.
VISUALID = <integer> 0 Specify the OpenGL visual. If 0, the
system automatically chooses a
visual based on your system
capabilities. Other values may be
obtained using the glxinfo tool. (The
visual IDs displayed in glxinfo are in
hexadecimal and must be converted
to decimal for use here.)
USEADVANCEDVISUALCHOOSER
must be YES. Available in tecplot.cfg
only and has effect only on Linux.
}
PERCENTAGEOFPOINTSTOKEEP = <integer> 10 Sets the percentage of points to keep
in a frame when a frame is
approximated. See also Section “Best
Practices For Rendering
Performance” in the User’s Manual.
PICKHANDLEWIDTH <op> <dexp> = 0.1 Value is in inches on the screen.
PLOTAPPROXIMATIONMODE = <plotapproximationmode> AUTOMATIC Specifies the mode in which you
want the plots to be approximated.
See Section “Plot Approximation” in
the User’s Manual for a complete
description of each mode.
PRINTDEBUG = <boolean> NO If YES, debugging information is sent
to the standard output.
ROTATION Settings for interactive rotations in
3D.
{
ARBSLICESTEPANGLE = <double> 0.5 Step value for orienting arbitrary
slice using +/- buttons (degrees).
ROTATIONMODE = <rotationmode> XYAXIS
CURRENTANGLE <op> <dexp> =5
144
Parameter Syntax Default Notes
SMALLANGLE <op> <dexp> =1
MEDIUMANGLE <op> <dexp> =5
LARGEANGLE <op> <dexp> = 15
ROTATEDEGPERFRAMEUNIT = <integer>
SHOWGEOMS = <boolean> YES
}
ROTATEDEGPERFRAMEUNIT = <integer>
RULERPADDING <op> <dexp> = 0.05 Distance between workarea ruler and
clipping edge for the paper and
frames. Units are inches.
RULERTHICKNESS <op> <dexp> = 0.15 Value is in inches on the screen.
SCALE Settings for interactive scaling.
{
STEPSIZE <op> <dexp> = 10
SMALLSTEP <op> <dexp> =1
MEDIUMSTEP <op> <dexp> = 10
LARGESTEP <op> <dexp> = 20
ZOOMSCALEPERFRAMEUNIT <op> <double> =4
}
SCRBACKGROUNDCOLOR = <color> Set the workspace background color.
SECURESPOOLCOMMANDS = <boolean> YES Set to NO to allow $!SPOOLER
commands outside the configuration
file.
SHOWCONTINUOUSSTATUS = <boolean> YES
SHOWCOORDINATES = <boolean> YES
SHOWCOORDINATES = <boolean> NO When YES, running coordinates for
WITHSELECTORADJUSTOR both X&Y are displayed in grid
coordinates in the status line for all
plot types but 3D. If $!INTERFACE
SHOWCOORDINATES is off, value
of SHOWCOORDINATESWITH
SELECTORADJUSTOR is ignored.
This command is available via the
config file (tecplot.cfg) only.
SHOWFRAMEBORDERSWHENOFF = <boolean> NO If YES, frame borders are drawn
using a dashed line when they are
turned off. This applies only to the
screen and does not effect the
hardcopy.
SHOWSTATUSLINE = <boolean> YES
SHOWTEXTGEOMS = <boolean> YES Set to YES if you want text and
INAPPROXVIEWS geometries to show up in frames
using approximated plots
SHOWTOOLTIPS = <boolean> YES
SHOWWAITDIALOGS = <boolean> YES If NO, all "Please Wait" and "Percent
Done" dialogs will be disabled.
SIDEBARSIZING = <sidebarsizing> MAXOFALL
TRANSLATION Settings for interactive translation.
{
STEPSIZE <op> <dexp> = 10
SMALLSTEP <op> <dexp> =5
MEDIUMSTEP <op> <dexp> = 10
LARGESTEP <op> <dexp> = 20
ZOOMSCALEPERFRAMEUNIT = <double>
}
TRUETYPEMIN = <integer> 19 on Windows Tecplot 360 EX will use a bitmap font
OUTLINEPOINTSIZE 16 on other for text smaller than this size.
platforms
145
Parameter Syntax Default Notes
USEMOD2MASKFOR = <boolean> NO Certain platforms have a problem
ALTDETECTION with the ALT key. Set to YES to
bypass the problem.
USECLASSICADJUSTORTOOL = <boolean> NO If set to YES, uses the old-style
adjustor tool that selects the closest
control point, rather than the whole
object, when clicking.
TRYTOUSEDOUBLEBUFFER = <boolean> YES
USEINITIALPLOTDIALOG = <boolean> YES
USEAPPROXIMATEPLOTS = <boolean> NO Set to YES to use approximate plots. See
Section “Plot Approximation” in the
User’s Manual for further details.
USEDISPLAYLISTS = <boolean> YES
USEDOUBLEBUFFERING = <boolean>
USEDOUBLEFOR = <boolean> YES
DISPLAYLISTS
USEFASTAPPROX = <boolean>
CONTINUOUSFLOOD
USEOFFSCREENBITMAP = <boolean> YES Set to YES to render images off-
screen.
USEOPENGL = <boolean> YES
USESTROKEFONTSFOR3DTEXT = <boolean> YES Set to YES to use Tecplot 360’s
internal stroke fonts, set to NO to use
True Type fonts. This option is only
available on Windows platforms.
USESTROKEFONTS = <boolean> See above
FORSMALLSCREENTEXT
USESTROKEFONTSONSCREEN = <boolean> NO See above
USETECPLOTPRINTDRIVERS = <boolean> NO Set to YES to use Tecplot 360’s printer
drivers. Set to NO to use your default
printer driver.
XORCOLOR <op> <integer> =0 Color index to use for XORed lines.
Set to 0 to make Tecplot 360 calculate.
XPGONFILLOFFSET = <integer> 0
YPGONFILLOFFSET = <integer> 0
ZONEBOUNDINGBOXMODE = <boundingboxmode> AUTO Corresponds to Show Bounding
Boxes for Enabled Volume Zones
with No Style on Option menu.
Example:
This example does the following:
• Makes the frame borders show on the screen when they are turned off.
• Makes the middle mouse button be Redraw.
• Makes the right mouse button revert to Selector.
• Makes the default number of passes for smoothing 20.
• Turns off the status line.
$!INTERFACE
SHOWFRAMEBORDERSWHENOFF = YES
MOUSEACTIONS
{
MIDDLEBUTTON
{
BUTTONCLICK = REDRAW
}
RIGHTBUTTON
{
BUTTONCLICK = REVERTTOSELECT
146
}
}
DATA
{
NUMSMOOTHPASSES = 20
}
SHOWSTATUSLINE = NO
$!INVERSEDISTINTERPOLATE
Syntax: $!INVERSEDISTINTERPOLATE
DESTINATIONZONE = <integer>
[optional parameters]
Description:Interpolate selected variables from one or more zones onto a destination zone using the inverse
distance method.
Required Parameter
Parameters Syntax Notes
DESTINATIONZONE = <integer> Zone to which to interpolate.
Optional Parameters
Parameters Syntax Default Notes
INTERPNPOINTS = <integer> 8
INTERPPTSELECTION = <interpptselection> OCTANTNPOINTS
INVDISTEXPONENT = <dexp> 3.5
INVDISTMINRADIUS = <dexp> 0.0
SOURCEZONES = <set> All zones except destination zone.
VARLIST = <set> All variables except spatial variables. Choose the variables to interpolate. The
spatial variables (X, Y and Z if 3D) are
not allowed.
$!INVERSEDISTINTERPOLATE
SOURCEZONES = [4]
DESTINATIONZONE = 2
VARLIST = [7-10]
$!ISOSURFACEATTRIBUTES
147
Optional Parameters
Parameter Syntax Default Notes
SHOWGROUP = <boolean> YES
ISOSURFACESELECTION = <isosurfacesselection> ONESPECIFICVALUE
ISOVALUE1 = <double> 1 x 10150
ISOVALUE2 = <double> 1 x 10150
ISOVALUE3 = <double> 1 x 10150
MESH
{
SHOW = <boolean> NO
COLOR = <color>
MESHTYPE = <meshtype> OVERLAY
}
CONTOUR
{
SHOW = <boolean> YES
CONTOURTYPE = <contourtype> FLOOD PRIMARYVALUE and
AVERAGECELL not allowed.
FLOODCOLORING = <contourcoloring> GROUP1
LINECONTOURGROUP = <integer> 1
COLOR = <color>
LINETHICKNESS = <double> 0.1
}
EFFECTS
{
USEVALUEBLANKING = <boolean> YES
LIGHTINGEFFECT = <lightingeffect> GOURAUD
SURFACETRANSLUCENCY = <translucency> 50
USETRANSLUCENCY = <boolean> NO
USECLIPPLANES = <set> [1-6]
}
DEFINITIONCONTOURGROUP = <integer> 1 Contour group from which iso-
surfaces are based.
OBEYSOURCEZONEBLANKING = <boolean> NO
OBEYCLIPPLANES = <boolean> YES Clip the iso-surface by any clipping
planes that intersect the iso-surface.
SHADE
{
COLOR = <color>
SHOW = <boolean> NO
USELIGHTINGEFFECT = <boolean> YES
}
SURFACEGENERATIONMETHOD = <surfacegenerationmethod> ALLTRIANGLES ALLTRIANGLES avoids holes;
ALLOWQUADS may produce
smoother surfaces
Example:
$!ISOSURFACEATTRIBUTE
ISOSURFACESELECTION = ONESPECIFICVALUE
ISOVALUE1 = 113.626812744
MESH{SHOW = YES}
MESH{COLOR = BLUE}
MESH{LINETHICKNESS = 0.4}
CONTOUR{SHOW = YES}
148
SURFACEEFFECTS{LIGHTINGEFFECT = PANELED}
SURFACEEFFECTS{SURFACETRANSLUCENCY = 60}
$!ISOSURFACELAYERS
Required Parameters
Parameter Syntax Default Notes
SHOW = <boolean> NO
Note
When iso-surfaces are activated, they are colored using the contour variable by default. When you activate
iso-surfaces via the macro language you must perform one of the following steps in order for the iso-
surfaces to be visible in your final plot:
• Set the contour variable by adding the following command to your macro file (prior to calling
$!ISOSURFACELAYERS).
$!GLOBALCONTOUR n VAR=m
where n is the contour group number and m is the number of the variable to use for
contouring.
or
• Set CONTOURSHOW = NO via the $!ISOSURFACEATTRIBUTES command. If you choose
this option, you may want to turn on shading to improve the visibility of your slice.
K-O
$!KRIG
Syntax: $!KRIG
DESTINATIONZONE = <integer>
[optional parameters]
Description:Interpolate selected variables from a set of source zones to a destination zone using the kriging
method.
149
Required Parameter
Parameters Syntax Default Notes
DESTINATIONZONE = <integer> Zone to interpolate to.
Optional Parameters
Parameters Syntax Default Notes
INTERPNPOINTS = <integer> 8
INTERPPTSELECTION = <interpptselection> OCTANTNPOINTS
KRIGDRIFT = <krigdrift> LINEAR
KRIGRANGE = <dexp> 0.3
KRIGZEROVALUE = <dexp> 0.0
SOURCEZONES = <set> All zones except the destination zone.
VARLIST = <set> All variables except spatial variables. Choose the variables to interpolate.
The spatial variables (X, Y and Z if 3D)
are not allowed.
Example: Krig from zones 3 and 4 onto zone 2. Only interpolate variable 7:
$!KRIG
SOURCEZONES = [3, 4]
DESTINATIONZONE= 2
VARLIST = [7]
$!LAUNCHDIALOG
$!LAUNCHDIALOG MACROVIEWER
$!LIMITS
Syntax: $!LIMITS
[optional parameters]
Description:A SetValue command that sets some of the internal limits in Tecplot 360. See Appendix G:
“Functional Limits” in the User’s Manual for additional information. The $!LIMITS command can
only be used in the Tecplot 360 configuration file.
150
Optional Parameters
Parameter Syntax Default Notes
LODTHRESHOLDMINFRACT <op><double> = 0.3 When Load on demand is set to auto-unload, set the
minimum and maximum memory thresholds. The values
LODTHRESHOLDMAXFRACT <op><double> = 0.7 may be from 0 to 1, where .5 corresponds to a threshold of
50%. If Tecplot 360’s memory usage exceeds the
maximum threshold, it continues to unload variables
until it either runs out of variables or reaches the
minimum threshold. These values may also be set
interactively via the Performance dialog. Refer to Section
29 - 2.2 “Miscellaneous Settings” in the User’s Manual for
additional information.
MAXAVAILABLEPROCESSORS <op><integer> =0 Sets the maximum number of processors used by Tecplot
360. Some tasks can be performed in parallel, so using all
available processors greatly increases performance of
those tasks. By default, Tecplot 360 uses all processors
available on the machine to provide the best performance
in most cases. Assign a value less than the total number of
available processors to limit the number of processors
used by Tecplot 360 to the assigned number.
MAXPTSINALINE <op><integer> Maximum number of points for geometry polylines.
MAXCHRSINTEXTLABELS <op><integer> Maximum number of characters in text labels.
MAXNUMCONTOURLEVELS <op><integer> Maximum number of contour levels.
MAXNUMPICKOBJECTS <op><integer> Maximum number of objects to pick.
MAXUSABLEMEMORY <op><integer> Limit the amount of memory used by Tecplot 360 (units of
MB).
PRELOADDATATIMETHRESHOLDINMS <integer> Sets the maximum time in milliseconds to spend pre-
loading data.
$!LIMITS
MAXNUMCONTOURLEVELS = 1000
$!LINEARINTERPOLATE
Syntax: $!LINEARINTERPOLATE
DESTINATIONZONE = <integer>
[optional parameters]
Description:Interpolate selected variables from a set of source zones to a destination zone using linear
interpolation. The source zones cannot be I-ordered. Values assigned to the destination zone are
equivalent to the results of using the probe tool in Tecplot 360.
Required Parameter
Parameters Syntax Default Notes
DESTINATIONZONE = <integer> Zone to interpolate to.
Optional Parameters
Parameters Syntax Default Notes
SOURCEZONES = <set> All zones except the destination zone.
VARLIST = <set> All variables except spatial variables. Choose the variables to interpolate. The spatial variables
(X, Y and Z if 3D) are not allowed.
Example:
151
Do linear interpolation from zones 2, 3 and 4 onto zone 7. Interpolate only variables 3-7:
$!LINEARINTERPOLATE
SOURCEZONES = [2-4]
DESTINATIONZONE = 7
VARLIST = [3-7]
$!LINEMAP
152
Optional Parameters
Parameter Syntax Default Notes
ASSIGN
{
ZONE = <integer> 1
XAXISVAR <op> <integer> =1
YAXISVAR <op> <integer> =2
THETAAXISVAR <op> <integer>
RAXISVAR <op> <integer>
XAXIS <op> <integer> =1
YAXIS <op> <integer> =1
FUNCTIONDEPENDENCY = <functiondependency> XINDEPENDENT
SHOWINLEGEND = [ALWAYS,NEVER, AUTO] AUTO
SORT <sortby> NONE
SORTVAR = <integer>
}
BARCHARTS
{
SHOW = <boolean> YES
COLOR = <color> RED
FILLMODE = <fillmode> USESPECIFICCOLOR
FILLCOLOR = <color> RED
SIZE <op> <dexp> = 2.5
LINETHICKNESS <op> <dexp> = 0.4
}
CURVES
{
CURVETYPE = <curvetype> LINESEG
EXTENDEDNAME = <string> Only used by the Extended
Curve-fit Add-on.
EXTENDEDSETTINGS = <string> Only used by the Extended
Curve-fit Add-on.
USEWEIGHTVAR = <boolean> NO
NUMPTS <op> <integer> = 200
POLYORDER <op> <integer> =3
WEIGHTVAR = <integer> 0
INDVARMIN <op> <dexp> -1 x 10150
INDVARMAX <op> <dexp> 1 x 10150
USEINDVARRANGE = <boolean> NO
CLAMPSPLINE = <boolean> NO
SPLINEDERIVATIVEATSTART <op> <dexp> =0
SPLINEDERIVATIVEATEND <op> <dexp> =0
}
ERRORBARS
{
SHOW = <boolean> NO
VAR = <integer>
BARTYPE = <errorbartype> VERT
COLOR = <color> RED
LINETHICKNESS <op> <dexp> = 0.1
SKIPPING <op> <dexp> =1 Skip can be by index or distance
depending on SKIPMODE.
SKIPMODE = <skipmode> BYINDEX
153
Parameter Syntax Default Notes
SIZE <op> <dexp> = 2.5
}
INDICES The indices parameter is used to
restrict the range of data plotted
{ (and which lines are plotted if
IJKLINES = <ijklines> the data is IJ- or IJK-ordered).
I
IRANGE <<indexrange>>
MIN=1, MAX=0,SKIP=1
JRANGE <<indexrange>>
MIN=1, MAX=0, SKIP=1
KRANGE <<indexrange>>
MIN=1, MAX=0, SKIP=1
}
LINES
{
SHOW = <boolean> YES
COLOR = <color> RED
LINEPATTERN = <linepattern> SOLID
PATTERNLENGTH <op> <dexp> =2
LINETHICKNESS <op> <dexp> = 0.1
}
NAME = <string> ’&DV&’
SYMBOLS
{
SHOW = <boolean> YES
COLOR = <color> RED
FILLMODE = <fillmode> NONE
FILLCOLOR = <color> RED
SIZE <op> <dexp> = 2.5
LINETHICKNESS <op> <dexp> = 0.1
SKIPPING <op> <dexp> =1 Skip can be by index or distance
depending on SKIPMODE.
SKIPMODE = <skipmode> BYINDEX
SYMBOLSHAPE <<symbolshape>> ISASCII = NO,
GEOMSHAPE = SQUARE
}
Examples:
Example 1:
Assign variable 1 to be on the X-axis and variable 4 to be on the Y-axis for Line-mapping number 7:
$!LINEMAP [7]
ASSIGN
{
XAXISVAR = 1
YAXISVAR = 4
}
Example 2:
Make Error Bars red for all Line-mappings:
$!LINEMAP
ERRORBARS
154
{
COLOR = RED
}
Example 3:
Set Line-mappings 3-5 to draw a polynomial curve fit of order 5:
$!LINEMAP [3-5]
CURVES
{
POLYORDER = 5
CURVETYPE = CURVFIT
}
LINES
{
SHOW = YES
}
$!LINEPLOTLAYERS
Syntax: $!LINEPLOTLAYERS
[optional parameters]
Description:A SetValue command that turns on or off Line-plot layers.
Optional Parameters:
Parameter Syntax Default Notes
SHOWLINES = <boolean> YES
SHOWSYMBOLS = <boolean> NO
SHOWBARCHARTS = <boolean> NO
SHOWERRORBARS = <boolean> NO Line-mapping must have an error bar variable assigned for this
to have an effect.
$!LINEPLOTLAYERS
SHOWSYMBOLS = YES
$!LINKING
Syntax: $!LINKING
[optional parameters]
Description:Link attributes in two or more frames so that changes to attributes of one frame effect all linked
frames.
155
Optional Parameters
Parameter Syntax Default Notes
BETWEENFRAMES
{
LINKCONTOURLEVELS = <boolean> NO
LINKFRAMESIZEANDPOSI = <boolean> NO
TION
LINKXAXISRANGE = <boolean> NO
LINKYAXISRANGE = <boolean> NO
LINKPOLARVIEW = <boolean> NO
LINK3DVIEW = <boolean> NO
LINKGROUP = <integer> 1
LINKAXISPOSITION = <boolean> NO
LINKVALUEBLANKING = <boolean> NO
LINKSLICEPOSITIONS = <boolean> NO
LINKISOSURFACEVALUES = <boolean> NO
LINKSOLUTIONTIME = <boolean> NO
}
WITHINFRAME
{
LINKAXISSTYLE = <boolean> NO
LINKGRIDLINESTYLE = <boolean> NO
LINKLAYERLINECOLOR = <boolean> NO
LINKLAYERLINEPATTERN = <boolean> NO
}
Example:
The following example will set the link attribute for all frames in the layout to LINK3DVIEW.:
$!LOOP |NUMFRAMES|
$!LINKING BETWEENFRAMES LINK3DVIEW = YES
$!FRAMECONTROL MOVETOBOTTOMBYNUMBER
$!FRAMECONTROL ATIVATETOP
$!ENDLOOP
$!LOADADDON
Optional Parameters
Parameters Syntax Default Notes
ADDONSTYLE = <string> V7Standard Style of the add-on to load. This can be either V7STANDARD or V7ACTIVEX.
Usually not needed; applies to Windows only
Example:
156
Load the Key Frame Animation add-on, stored in a library named tecutiltools_keyframe.:
$!LOADADDON "tecutiltools_keyframe"
$!LOADCOLORMAP
$!LOADCOLORMAP "mycolors.map"
$!LOOP...$!ENDLOOP
Syntax:$!LOOP <integer>
$!ENDLOOP
Description:Process macro commands in a loop. Within the loop you may access the current loop counter
using the intrinsic macro variable |Loop|. Loops may be nested up to 10 levels deep.
$!LOOP 3
$!ENDLOOP
$!MACROFUNCTION...$!ENDMACROFUNCTION
Syntax: $!MACROFUNCTION
NAME = <string>
[optional parameters]
$!ENDMACROFUNCTION
Description:Define a macro function. All commands between a $!MACROFUNCTION and the
$!ENDMACROFUNCTION are associated with the macro function NAME. These commands are not
executed when they are defined but are executed when a $!RUNMACROFUNCTION command is
processed. Parameters can be passed to a macro function. Use |n| to reference the nth parameter.
(See $!RUNMACROFUNCTION). In the user-interface, [Crtl]-M must be pressed, before using the
keyboard shortcut specified by the KEYSTROKE option. For example, if the KEYSTROKE option is set to
"P", the user must press [CTRL]-M-P.
157
Required Parameter
Parameter Syntax Notes
NAME = <string> Name of the macro function.
Optional Parameter
Parameter Syntax Default Notes
KEYSTROKE = <string> Allows keyboard shortcuts
RETAIN = <boolean> NO Set this to YES if you want Tecplot 360 to retain this macro function when the
macro in which this macro function was defined terminates. If the macro
function is retained then it can be called when another macro is loaded at a
later time.
SHOWINMACROPANEL = <boolean> YES Used only for macro functions within the tecplot.mcr file. Set this to NO if
you do not want Tecplot 360 to include the macro function in Tecplot 360’s
Quick Macro Panel.
Example:
Define a macro function that redraws the active frame n times when <Ctrl>+M is hit and then the ‘R’ key is
pressed, where n is passed to the macro function:
$!MACROFUNCTION
NAME = "ABC"
KEYSTROKE = "R"
$!LOOP |n|
$!REDRAW
$!ENDLOOP
$!ENDMACROFUNCTION
$!NEWLAYOUT
Syntax: $!NEWLAYOUT
[no parameters]
Description:Clear the current layout and start again.
When a new layout is created, the following steps occur:
1. All pages are deleted.
2. A new page is created.
3. A new frame is added to the page.
$!OPENLAYOUT
158
Optional Parameters
Parameter Syntax Default Notes
ALTDATALOADINSTRUCTIONS = <string> Null Specify alternate data load instructions.
Examples:
Example 1:
Open a new layout file called abc.lay and replace the data file referenced in the layout file with t.plt:
$!OPENLAYOUT "abc.lay"
ALTDATALOADINSTRUCTIONS = "t.plt"
Example 2:
Open a new layout file called multiframe.lay and replace the first data set with t.plt and the second data set
with the two files, a.plt and b.plt:
$!OPENLAYOUT "multiframe.lay"
ALTDATALOADINSTRUCTIONS = '"t.plt" "a.plt"+"b.plt"'
P-Q
$!PAGE
Syntax: $!PAGE
[optional parameters]
Description:A SetValue command that sets the paper characteristics.
159
Optional Parameters
Parameter Syntax Default Notes
PAPERATTRIBUTES
{
BACKGROUNDCOLOR = <color> WHITE
ISTRANSPARENT = <boolean> YES
ORIENTPORTRAIT = <boolean> NO
PAPERGRIDSPACING = <papergridspacing> HALFINCH Set the spacing for the tick marks on the
paper.
PAPERSIZE = <papersize> LETTER
REGIONINWORKAREA <<rect>> X1=1, Y1=0.25, X2=10, Y2=8.25 Specify rectangle that must fit within the
workarea. Units are in inches (that is, in
the paper coordinate system).
RULERSPACING = <paperrulerspacing> ONEINCH
SHOWGRID = <boolean> YES
SHOWPAPER = <boolean> NO
SHOWRULER = <boolean> NO
}
USESOFTWARERENDERING = <boolean> Use the painter’s algorithm (meaning,
display graphics cell-by-cell from front-
to-back), instead of using OpenGL.
NAME = <string> Pages are unnamed by default.
Example:
This example does the following:
• Turns off the paper grid.
• Makes the paper size CUSTOM1.
• Makes the dimensions for CUSTOM1 to be 4 by 5 inches.
$!PAGE
PAPERATTRIBUTES
{
SHOWGRID = NO
PAPERSIZE = CUSTOM1
PAPERSIZEINFO
{
CUSTOM1
{
WIDTH = 4
HEIGHT = 5
}
}
}
See also: Section “$!GLOBALPAPER” on page 132.
Description:The different commands in the PAGECONTROL compound function family are described
separately in the following sections.
The PAGECONTROL compound functions are:
$!PAGECONTROL CREATE
$!PAGECONTROL SETCURRENTTONEXT
$!PAGECONTROL SETCURRENTTOPREV
160
$!PAGECONTROL SETCURRENTBYNAME
$!PAGECONTROL DELETE
$!PAGECONTROL CLEAR
$!PAGECONTROL CREATE
$!PAGECONTROL SETCURRENTTONEXT
$!PAGECONTROL SETCURRENTTOPREV
$!PAGECONTROL SETCURRENTBYNAME
$!PAGECONTROL SETCURRENTBYNAME
NAME = "BANANA"
$!PAGECONTROL DELETE
$!PAGECONTROL CLEAR
161
$!PAGEGETNAME
$!PAGENAME
$!PAUSE
Example: Pause and display the message This is the first example plot:
Description:The different commands in the PICK compound function family are described separately in the
following sections.
The PICK compound functions are:
$!PICK ADDATPOSITION
$!PICK ADDALL
$!PICK ADDALLINRECT
$!PICK CLEAR
$!PICK COPY
$!PICK CUT
$!PICK EDIT
$!PICK MAGNIFY
$!PICK PASTE
$!PICK POP
$!PICK PUSH
$!PICK SETMOUSEMODE
$!PICK SHIFT
$!PICK ADDATPOSITION
162
Required Parameters
Parameters Syntax Default Notes
X = <dexp> X-location (in inches) relative to the left edge of the paper.
Y = <dexp> Y-location (in inches) relative to the top edge of the paper.
Optional Parameters
Parameters Syntax Default Notes
COLLECTINGOBJECTS = <boolean> NO If NO, the list of picked objects is cleared before the attempt is
made to add a new object.
CONSIDERSTYLE = <boolean> NO If YES, objects that are not being drawn, or which are styled
such that they are not visible, are ignored.
DIGGINGFOROBJECTS = <boolean> NO If YES, attempt to pick objects below any currently picked
objects at this location.
IGNOREZONEOBJECTS = <boolean> NO If YES, pick operations will ignore zones and pick objects such
as slices, iso-surfaces and streamtraces.
Example:
Attempt to add to the list of picked objects by picking at paper location (1.0, 7.0). Do not clear the list of
picked objects before picking:
$!PICK CHECKTOADD
X = 1.0
Y = 7.0
COLLECTINGOBJECTS = YES
$!PICK ADDALL
Optional Parameters
Parameters Syntax Default Notes
CONSIDERSTYLE = <boolean> NO If YES, objects that are not being drawn, or which are styled such that they
are not visible, are ignored.
SELECTTEXT = <boolean> NO Select all text objects in the active frame.
SELECTGEOMS = <boolean> NO Select all geometry objects in the active frame.
SELECTFRAMES = <boolean> NO Select all frames.
SELECTSTREAMTRACES = <boolean> NO Select all streamtrace objects in the active frame.
SELECTMAPS = <boolean> NO Select all line map objects in the active frame.
SELECTZONES = <boolean> NO Select all zone objects in the active frame.
Example: Add all text and geometries in the active frame to the list of picked objects:
$!PICK ADDALL
SELECTTEXT = YES
SELECTGEOMS = YES
163
$!PICK ADDALLINRECT
Required Parameters
Parameters Syntax Default Notes
X1 = <dexp> X-location (in inches) relative to the left edge of the paper.
Y1 = <dexp> Y-location (in inches) relative to the top edge of the paper.
X2 = <dexp> X-location (in inches) relative to the left edge of the paper.
Y2 = <dexp> Y-location (in inches) relative to the top edge of the paper.
Optional Parameters
Parameters Syntax Default Notes
COLORFILTER = <color> Not used. a Only objects of this color will be selected.
CONSIDERSTYLE = <boolean> NO If YES, objects that are not being drawn, or which are styled such that
they are not visible, are ignored.
FONTFAMILYFILTER = <string> Not used.a Only text objects with this font will be selected.
ISBOLD = <boolean> NO Only boldface text objects will be selected.
ISITALIC = <boolean> NO Only italicized text objects will be selected.
GEOMFILTER = <geomtype> Not used.a Only geometry objects of this type will be selected.
LINEPATTERNFILTER = <linepattern> Not used.a Only geometry objects with this line pattern will be selected.
SELECTCONTOURLABELS = <boolean> NO Select all contour labels in specified region
SELECTFRAMES = <boolean> NO Select all frame objects in the specified region.
SELECTGEOMS = <boolean> NO Select all geometry objects in the specified region.
SELECTGRIDAREA = <boolean> NO Select the grid area in specified region
SELECTMAPS = <boolean> NO Select all line map objects in the specified region.
SELECT = <boolean> NO Select all streamtrace objects in the specified region.
STREAMTRACES
SELECTTEXT = <boolean> NO Select all text objects in the specified region.
SELECTZONES = <boolean> NO Select all zone objects in the specified region.
a. There is no default for this parameter. If this parameter is omitted then the corresponding filter is not
used.
Example:
Pick all circles using a dashed line pattern within the rectangle bounded by the points (0, 0) and (3, 5):
$!PICK ADDALLINRECT
SELECTGEOMS = YES
LINEPATTERNFILTER= DASHED
GEOMFILTER = CIRCLE
X1 = 0
Y1 = 0
X2 = 3
Y2 = 5
164
$!PICK CLEAR
$!PICK CLEAR
$!PICK COPY
$!PICK COPY
$!PICK CUT
$!PICK CUT
$!PICK EDIT
Parameters
Must select one from this table.
165
Parameters Syntax Default Notes
SHOW = <boolean>
ISFILLED = <boolean>
}
COLOR = <color>
CONTOUR Only operates on 2D or 3D zone objects.
{
SHOW = <boolean>
CONTOURTYPE = <contourtype>
}
CURVES Only operates on XY line mapping objects.
{
CURVETYPE = <curvetype>
}
EDGELAYER Only operates on 2D or 3D zone objects.
{
SHOW = <boolean>
SUBBOUNDARY = <subboundary>
}
ERRORBARS Only operates on XY line mapping objects.
{
SHOW = <boolean>
BARTYPE = <errorbartype>
}
FILLCOLOR = <color>
FONTFAMILY = <string>
GEOMSHAPE = <geomshape> Applies only to scatter symbols or XY-plot symbols.
ISBOLD = <boolean>
ISITALIC = <boolean>
LINEPATTERN = <linepattern>
LINES Only operates on XY line mapping objects.
{
SHOW = <boolean>
}
LINETHICKNESS = <dexp> Value is in Y-frame units (0-100).
MESH Only operates on 2D or 3D zone objects.
{
SHOW = <boolean>
MESHTYPE = <meshtype> Only operates on 2D or 3D zone objects.
}
OBJECTALIGN = <objectalign> Only allowed if selected objects are all text and/or
geometries.
PATTERNLENGTH = <dexp> Value is in Y-frame units (0-100).
SCATTER Only operates on 2D or 3D zone objects.
{
SHOW = <boolean>
FILLMODE = <fillmode>
}
SHADE Only operates on 2D or 3D zone objects.
{
SHOW = <boolean>
SHADETYPE = <shadetype>
}
166
Parameters Syntax Default Notes
SHOWBORDER = <boolean> Only operates on frame objects.
SIZE = <dexp> Value is in Y-frame units. This applies to things like
symbols.
SYMBOLS Only operates on line mapping objects.
{
SHOW = <boolean>
ISFILLED = <boolean>
}
TEXTCOLOR = <color>
TEXTHEIGHTBYPERCENT = <dexp> Value is in Y-frame units (0-100).
TEXTHEIGHTBYPOINTS = <dexp> Value is in points.
VECTOR Only operates on 2D or 3D zone objects.
{
SHOW = <boolean>
VECTORTYPE = <vectortype>
}
Examples:
Example 1:
Set all picked objects to use the color yellow:
$!PICK EDIT
COLOR = YELLOW
Example 2:
Set all picked objects to use the dashed line pattern:
$!PICK EDIT
LINEPATTERN = DASHED
Example 3:
Set all picked objects (which are zones) to use the contour plot type of flooding:
$!PICK EDIT
CONTOUR {CONTOURTYPE = FLOOD}
$!PICK MAGNIFY
$!PICK MAGNIFY
MAG = 1.5
167
$!PICK PASTE
$!PICK POP
$!PICK PUSH
$!PICK SETMOUSEMODE
Required Parameter
Parameter Syntax Default Notes
MOUSEMODE = <mousemode> Set to SELECT or ADJUST.
$!PICK SETMOUSEMODE
MOUSEMODE = ADJUST
$!PICK SHIFT
168
SNAPTOPAPER.)
Required Parameters
Parameters Syntax Default Notes
X = <dexp> Shift amount in the X-direction. Units are inches.
Y = <dexp> Shift amount in the Y-direction. Units are inches.
Optional Parameter
Parameters Syntax Default Notes
POINTERSTYLE = <pointerstyle> ALLDIRECTIONS Only frames and non-3D grid area objects can use a pointer style that
is not ALLDIRECTIONS.
Example: Shift the currently picked objects 1 inch to the right and 2 inches down:
$!PICK SHIFT
X = 1
Y = 2
$!PLOTTYPE
Required Parameters
Parameter Syntax Default Notes
PLOTTYPE = <plottype> CARTESIAN3D
$!PLOTTYPE = POLARLINE
$!POLARAXIS
Syntax: $!POLARAXIS
[optional parameters]
Description:A SetValue command that assigns attributes for axes in a polar frame.
169
Optional Parameters
Parameter Syntax Default Notes
GRIDAREA <<areastyle>> See Notes DRAWBORDER=YES, ISFILLED=NO, FILLCOLOR=WHITE,
DRAWGRIDLAST=NO
PRECISEGRID <<precisegrid>> INCLUDE=NO, SIZE=0.0045, COLOR=BLACK
PRESERVEAXISSCALE <boolean> YES
RDETAIL <<axisdetail>>
THETADETAIL <<axisdetail>>
THETAMODE = <thetamode> DEGREES
THETAPERIOD = <double> 360
VIEWPORTPOSITION <<rect>> See Notes X1=0, Y1=0, X2=100, Y2=100
VIEWPORTSTYLE <<areastyle>> See Notes DRAWBORDER=NO, COLOR=BLACK,
LINETHICKNESS=0.4, ISFILLED=NO, FILLCOLOR=WHITE
$!POLARTORECTANGULAR
$!POLARTORECTANGULAR [1-3]
$!POLARVIEW
Syntax: $!POLARVIEW
[optional parameters]
Description: Sets the viewing style for polar plots in a layout.
Required Parameters
Parameter Syntax Default Notes
EXTENTS <<rect>> X1=-1.29771, View extents of transformed X & Y in polar plots. Numbers
Y1=-1.15352, listed are in the form of grid units.
X2=1.29771,
Y2=1.15352
Example: Set the view of the polar plot to view the full extents of the plot area.
$!POLARVIEW
EXTENTS
{
X1=10
170
Y1=10
X2=90
Y2=90
}
Syntax: $!PRINT
[no parameters]
Description:Print the current layout to a printer or send the print instructions to a file. Use the $!PRINTSETUP
SetValue command to configure printing.
Example:
$!PRINTSETUP
Syntax: $!PRINTSETUP
[optional parameters]
Description:A SetValue command that sets the attributes for printing. Use $!PRINT to do the actual printing.
See $!EXPORTSETUP and $!EXPORT if you intend to create image files destined for desktop
publishing programs.
171
Optional Parameters
Parameter Syntax Default Notes
DRIVER = <printerdriver> Only applies if using the Tecplot 360 printer drivers. See
$!INTERFACE USETECPLOTPRINTDRIVERS.
FORCEEXTRA3D = <boolean>
SORTING
JOBCONTROL These strings contain characters to be sent at the
beginning and ending of a print file. These strings most
{ often contain escape sequences used to switch modes on
POSTMOPUPSTR = <string> the printer. Non-printable characters can be inserted. Use
^nnn to insert a character with ordinal value nnn. Use \ to
LGMOPUPSTR = <string> force the character after the \ to be inserted. Use $B for a
POSTSETUPSTR = <string> Backspace, $E for Esc, $C for a carriage return, and $X for
the Delete key.
LGSETUPSTR = <string>
}
IMAGERESOLUTION = <integer>
NUMHARDCOPYCOPIES <op> <integer> Applies only when DRIVER = PS.
NUMLIGHTSOURCESHADES = <integer>
PALETTE = <palette> Must choose options valid for current DRIVER setting.
PRECISION <op> <integer> Applies only if EXPORTFORMAT is PS, EPS, or
RASTERMETAFILE.
PRINTFNAME = <string> Name of the file to write to if SENDPRINTTOFILE is YES.
PRINTRENDERTYPE = <printrendertype>
RGBLEGENDOUTPUTRESOLUTION = <integer> 50 Determines the number of triangles which compose the
bottom layer of the RGB Legend. This option is only
available through macro language (for example, the
config file)
SENDPRINTTOFILE = <boolean> If YES then PRINTFNAME is name of file to write to.
SPOOLER These strings contain the system command needed to
send a file to the print spooler on your computer. Use the
{
@ symbol as a place holder for where you normally insert
PSMONOSPOOLCMD = <string> the name of the file to be printed.
For security reasons these commands can only be used in
PSCOLORSPOOLCMD = <string>
the Tecplot 360 configuration file.
LGSPOOLCMD = <string>
}
USEISOLATIN1FONTSINPS = <boolean> Use extended ISO-Latin1 fonts when generating
PostScript® output using Tecplot 360’s internal PostScript
driver.
Example:
This example does the following:
• Instruct Tecplot 360 to send print output to the print spooler.
• Sets the spooler command for monochrome PostScript to be lpr @.
• Sets the print driver to be monochrome PostScript.
$!PRINTSETUP
SENDPRINTTOFILE = NO
DRIVER = PS
PALETTE = MONOCHROME
SPOOLER
{
PSMONOSPOOLCMD = "lpr @"
}
172
$!PROMPTFORFILENAME
Optional Parameter
Parameter Syntax Default Notes
DIALOGTITLE = <string> "" Include a title at the top of the dialog.
DEFAULTFNAME = <string> "" Make the dialog come up with a default file name.
FILEFILTER = <string> "" Set the filter for the file selection dialog.
FILEMUSTEXIST = <string> YES
$!PROMPTFORFILENAME|filetodelete|
DIALOGTITLE = "Delete File"
FILEFILTER = "*.*"
$!IF "|filetodelete|" != ""
$!IF |OPSys| = 1 # Linux/Mac
$!System "rm |filetodelete|"
$!Endif
$!IF |OPSys| = 2 # Windows
$!System "cmd /c del |filetodelete|"
$!Endif
$!Endif
$!PROMPTFORTEXTSTRING
Optional Parameter
Parameter Syntax Default Notes
INSTRUCTIONS = <string> "" Include text at the top of the dialog to instruct the user
regarding the value to enter. On Windows platforms, this is
limited to three lines of text.
Example:
$!PROMPTFORTEXTSTRING |timestring|
INSTRUCTIONS = "Enter the time of the experiment"
173
$!PROMPTFORYESNO
Optional Parameter
Parameter Syntax Default Notes
INSTRUCTIONS = <string> "" Include text at the top of the dialog with instructions.
Example:
$!PROMPTFORYESNO |goforit|
INSTRUCTIONS = "Do you want to go for it?"
$!IF "|goforit|" == "YES"
... code that goes for it....
$!ENDIF
$!PROPAGATELINKING
Syntax: $!PROPAGATELINKING
[optional parameters]
Description: Link multiple frames, either within frame or between frames.
Optional Parameter
Parameter Syntax Default Notes
FRAMECOLLECTION = [ALL, PICKED]
LINKTYPE = [WITHINFRAME,
BETWEENFRAMES]
Example:
$!PROPAGATELINKING
LINKTYPE = BETWEENFRAMES
FRAMECOLLECTION = ALL
$!PUBLISH
174
Optional Parameter
Parameter Syntax Default Notes
IMAGESELECTION = <imagestyle> ONEPERFRAME Choosing ONEPERFRAME will create one image per frame,
selecting WORKSPACEONLY creates one image which
includes all your frames.
INCLUDELAYOUTPACKAGE = <boolean> No Choose YES to create a linked layout file.
Example:
$!PUBLISH "C:\TEC360\separate.html"
INCLUDELAYOUTPACKAGE = NO
IMAGESELECTION = ONEPERFRAME
$!QUIT
Syntax:$!QUIT
Description:Terminate the execution of the Tecplot 360 program.
Example:
$!QUIT
$!RAWCOLORMAP
Syntax: $!RAWCOLORMAP
<colormaprawdata>
Description:Assign the RGB values that define the Raw user-defined color map. This does not choose the
Raw user-defined color map for use in a contour group. Use $!GLOBALCONTOUR COLORMAPNAME to set
the color map used by a contour group.
Required Parameter
Parameter Syntax Default Notes
<colormaprawdata> This is a list of RGB values.
Example: Assign the Raw user-defined color map to a gray scale using 11 colors:
$!RAWCOLORMAP
RAWDATA
11
0 0 0
25 25 25
50 50 50
75 75 75
100 100 100
125 125 125
150 150 150
175 175 175
200 200 200
175
225 225 225
255 255 255
$!READDATASET
Examples:
The following example loads one case file and one data file with the FLUENT file loader. Note that the
DATASETREADER parameter is at the end of the command call.
$!READDATASET
'"STANDARDSYNTAX" "1.0"
"LoadOption" "MultipleCaseAndData"
"FILELIST_Files" "2" "triangular.cas" "triangular.dat"
"UnsteadyOption" "ReadTimeFromDataFiles"
"AssignStrandIDs" "Yes"
"GridZones" "CellsAndBoundaries"
"IncludeParticleData" "Yes"
"AverageToNodes" "Yes"
"AveragingMethod" "Arithmetic"'
DATASETREADER = 'Fluent Data Loader'
176
Table 9 - 2: Parameters for loading data in Tecplot format
Parameters Syntax Default Notes
IJKSKIP Use values greater than 1 to skip data points.
{
I = <integer> 1
J = <integer> 1
K = <integer> 1
}
COLLAPSEZONESANDVARS = <boolean> NO Renumber zones and variables if zones or variables are
disabled.
INCLUDECUSTOMLABELS = <boolean> YES Set to YES to load in any custom labels in the data files.
INCLUDEDATA = <boolean> YES Set to YES to load in any field data in the data files.
INCLUDEGEOM = <boolean> YES Set to YES to load in any geometries in the data files.
INCLUDETEXT = <boolean> YES Set to YES to load in any text in the data files.
INITIALPLOTFIRSTZONEONLY = <boolean> Allows faster performance for files with multiple zones.
INITIALPLOTTYPE = <plottype>
READDATAOPTION = <readdataoption> NEW Set to APPEND to append the new zones to the zones in
the data set that existed prior to using this command.
Set to NEW to remove the data set from the active frame
prior to reading in the new data set. If other frames use
the same data set they will continue to use the old one.
Set to REPLACE to replace the data set attached to the
active frame and to all other frames that use the same
data set, with the new data set.
RESETSTYLE = <boolean> YES Set to NO if you want Tecplot 360 to keep the current
style. This only applies if READDATA OPTION is not
APPEND.
VARLOADMODE = <varloadmode> BYPOSITION Set to BYPOSITION to load variables based on their
position in the file. Set to BYNAME to load variables
based on their name. If set to BYNAME, then
VARNAMELIST must be supplied as well.
VARNAMELIST = <string> Use this to list the names of the variables to load into
Tecplot 360. Names separated by a ; or a + are joined
together to form a set of aliases for a given variable.
VARPOSITIONLIST = <set> All vars. Use this to reduce the number of variables loaded.
ZONELIST = <set> All zones. Use this to reduce the number of zones loaded.
Example 1:
Read in the data files t1.plt and t2.plt to form a single data set in Tecplot 360:
Example 2:
Read in the datafile t1.plt. Only read in zones 1 and 4. Skip over every other I-index:
$!READDATASET "t1.plt"
ZONELIST = [1,4]
IJKSKIP
{
I = 2
}
Example 3:
Read in the data files t1.plt, t2.plt, and t3.plt. Append the new data set to the current one:
177
Example 4:
Read in the data files t1.plt and t2.plt from directory, /users/john/testrun7/runb:
$!READSTYLESHEET
Optional Parameters
Parameters Syntax Default Notes
INCLUDEAUXDATA = <boolean> YES Set to YES to read auxiliary data.
INCLUDECONTOURLEVELS = <boolean> YES Set to YES to read in all contour levels.
INCLUDEFRAMESIZEANDPOSITION = <boolean> NO Set to YES if you want the active frame to be sized and
positioned exactly like the frame used to create the stylesheet.
INCLUDEGEOM = <boolean> YES Set to YES to load in any geometries in the stylesheet file.
INCLUDEPLOTSTYLE = <boolean> YES Set to YES to process commands related to plot style (mesh
color, vector type, and so on).
INCLUDESTREAMPOSITIONS = <boolean> YES Set to YES to read in streamtrace starting positions.
INCLUDETEXT = <boolean> YES Set to YES to load in any text in the stylesheet file.
MERGE = <boolean> NO Set to NO to reset all frame attributes back to their factory
defaults prior to reading in the stylesheet.
Example: Read the stylesheet file t.sty. Do not read in any text or geometries:
$!READSTYLESHEET "t.sty"
INCLUDETEXT = NO
INCLUDEGEOM = NO
$!REDISTRIBUTECOLORMAPCONTROLPOINTS
Syntax:$!REDISTRIBUTECOLORMAPCONTROLPOINTS <string>
Description:Redistributes control points for the named color map, which must exist and must be a custom
color map (not a built-in color map such as "Small Rainbow").
$!REDRAW
Syntax: $!REDRAW
[optional parameters]
Description:Redraw the active frame.
178
Optional Parameter
Parameter Syntax Default Notes
DOFULLDRAWING = <boolean> YES Set to NO to draw only a “trace” of the data in the frame.
Example:
$!REDRAW
$!REDRAWALL
Syntax: $!REDRAWALL
[optional parameters]
Description:Redraw all frames.
Optional Parameter
Parameter Syntax Default Notes
DOFULLDRAWING = <boolean> YES Set to NO to draw only a “trace” of the data in each frame.
Example:
$!REDRAWALL
$!REMOVEVAR
$!REMOVEVAR |ABC|
$!RENAMECOLORMAP
Syntax: $!RENAMECOLORMAP
OLDNAME = <string>
NAME = <string>
[no optional parameters]
Description:Renames a custom color map.
179
Required Parameters
Parameter Syntax Default Notes
OLDNAME = <string> The name of the color map to be renamed. The named color map must exist.
NAME = <string> The new name for the color map. May not be the same as an existing color map name
(including built-in color maps).
$!RENAMECOLORMAP
OLDNAME = "My Small Rainbow"
NAME = "My New Small Rainbow"
$!RENAMEDATASETVAR
Syntax: $!RENAMEDATASETVAR
VAR = <integer>
NAME = <string>
[no optional parameters]
Description:Rename a data set variable in Tecplot 360.
Required Parameters
Parameter Syntax Default Notes
VAR = <integer> Specify the variable number.
NAME = <string> Specify the new variable name.
$!RENAMEDATASETVAR
VAR = 1
NAME = "Banana"
$!RENAMEDATASETZONE
Syntax: $!RENAMEDATASETZONE
ZONE = <integer>
NAME = <string>
[no optional parameters]
Description:Rename a data set zone in Tecplot 360.
Required Parameters
Parameter Syntax Default Notes
ZONE = <integer> Specify the zone number.
NAME = <string> Specify the new zone name.
$!RENAMEDATASETZONE
ZONE = 1
NAME = "Banana"
180
$!RESET3DAXES
Syntax: $!RESET3DAXES
[no parameters]
Description:Reset the ranges on the 3D axes.
Example:
$!RESET3DAXES
$!RESET3DORIGIN
Syntax: $!RESET3DORIGIN
[optional parameters]
Description:Reposition the rotation origin in 3D to be at the specified location.
Optional Parameter
Parameter Syntax Default Notes
ORIGINRESETLOCATION = <originresetlocation>
Example:
$!RESET3DORIGIN
ORIGINRESETLOCATION = DATACENTER
$!RESET3DSCALEFACTORS
Syntax: $!RESET3DSCALEFACTORS
[no parameters]
Description:Recalculate the scale factors for the 3D axes. Aspect ratio limits are taken into account.
Example:
$!RESET3DSCALEFACTORS
$!RESETRAWUSERDEFINEDCOLORMAP
Syntax: $!RESETRAWUSERDEFINEDCOLORMAP
SOURCECOLORMAP = <string>
Description:Resets the raw user-defined color map to the color map named by SOURCECOLORMAP.
181
Required Parameter
Parameter Syntax Default Notes
SOURCECOLORMAP = <string> The color map named must exist and may be either a built-in or custom color
map.
$!RESETVECTORLENGTH
Syntax: $!RESETVECTORLENGTH
[no parameters]
Description:Reset the length of the vectors. Tecplot 360 will find the vector with the largest magnitude and
set the scaling factor so it will appear on the screen using the length specified by $!FRAMESETUP
VECTDEFLEN.
Example:
$!RESETVECTORLENGTH
$!ROTATE2DDATA
Syntax: $!ROTATE2DDATA
ANGLE = <dexp>
[optional parameters]
Description:Rotate field data in 2D about any point. See also $!ROTATEDATA.
Required Parameter
Parameter Syntax Default Notes
ANGLE = <dexp> Specify angle of rotation in degrees.
Optional Parameters
Parameter Syntax Default Notes
ZONELIST = <set> All zones. Zones to rotate.
X = <dexp> 0 X-origin to rotate about.
Y = <dexp> 0 Y-origin to rotate about.
$!ROTATE2DDATA
ANGLE = 30
ZONELIST = [3]
X = 7
Y = 2
$!ROTATE3DVIEW
182
Required Parameter
Parameter Syntax Default Notes
ANGLE = <dexp> Angle to rotate (in degrees).
Optional Parameters
Parameter Syntax Default Notes
ROTATEORIGIN = <rotateoriginlocation>
LOCATION
VECTORX = <dexp> Required when rotate axis is ABOUTVECTOR.
VECTORY = <dexp> Required when rotate axis is ABOUTVECTOR.
VECTORZ = <dexp> Required when rotate axis is ABOUTVECTOR.
Example:
$!ROTATE3DVIEW PSI
ANGLE = 10
$!ROTATEDATA
Syntax: $!ROTATEDATA
ANGLE = <dexp>
XUVARLIST = = <set>
YVVARLIST = = <set>
[optional parameters]
Description:Using the right-hand rule, rotate the axis variables and/or vector variables in the
specified set of zones. You may optionally specify the origin and axis of rotation.
The parameters XVAR, YVAR, and ZVAR specify the X, Y, and Z grid variables to be rotated. ZVAR
applies only in 3D rotation and must be omitted for 2D rotation. If only vector variables are to be rotated,
all of these may be omitted; however, if any is specified, all must be.
The parameters UVARLIST, VVARLIST, and WVARLIST are sets consisting of the vector variables to be
rotated for each vector component. WVARLIST applies only in 3D rotation and must be omitted for 2D
rotation. The number of variables in each set must match the number specified by the NUMVECTORS
parameter, which must also be specified. If no vector variables are to be rotated, the NUMVECTORS
parameter may be omitted, along with UVARLIST, VVARLIST, and WVARLIST.
Acenter of rotation other than the grid origin may be specified using the optional ORIGINX, ORIGINY,
and ORIGINZ parameters. The origin specified by these parameters is subtracted from the values of the X,
Y, and Z axis variables specified before rotation, then added back in afterward.
Rotation occurs around the Z axis by default. To specify a different axis of rotation in 3D rotation, specify
the coordinates of a second point (i.e., a point other than the origin) on the axis of rotation using the
NORMALX, NORMALY, and NORMALZ parameters. These may not be specified with 2D rotation.
See also $!ROTATE2DDATA and $!AXIALDUPLICATE.
183
Required Parameters
Parameter Syntax Notes
ANGLE = <dexp> Angle to rotate (in degrees).
IS3DROTATION = <boolean> If true, rotate in 3D. If false, rotate in 2D.
Optional Parameters
Parameter Syntax Default Notes
NORMALX = <dexp> 0.0 For 3D rotation, the X component of the axis of rotation
NORMALY = <dexp> 0.0 For 3D rotation, the Y component of the axis of rotation
NORMALZ = <dexp> 1.0 For 3D rotation, the Z component of the axis of rotation
NUMVECTORS = <integer> 0 Number of vector variables to be rotated, which must be specified in UVARLIST,
YVARLIST, and (if 3D) WVARLIST.
ORIGINX = <dexp> 0.0 X coordinate of the origin.
ORIGINY = <dexp> 0.0 Y coordinate of the origin.
ORIGINZ = <dexp> 0.0 Z coordinate of the origin. (3D only)
UVARLIST = <set> The U vector variables to be rotated, if any. Must contain the number of variables
specified by NUMVECTORS.
VVARLIST = <set> The V vector variables to be rotated, if any. Must contain the number of variables
specified by NUMVECTORS.
WVARLIST = <set> The W vector variables to be rotated, if any. Must contain the number of variables
number specified by NUMVECTORS. For 3D rotation only.
XVAR = <integer> The X axis variable to be rotated. If specifed, other axis variables must also be
specified..
YVAR = <integer> The Y axis variable to be rotated. If specifed, other axis variables must also be
specified..
ZVAR = <integer> The Z axis variable to be rotated (for 3D rotation only). If specifed, other axis
variables must also be specified..
ZONELIST = <set> All zones Set specifying the zones to be rotated. If omitted, rotate all zones.
$!RUNMACROFUNCTION
Example:
Run macro function XYZ and pass the value 7 as the first parameter and the value 3.5 as the second
parameter:
$!SAVELAYOUT
184
Optional Parameter
Parameters Syntax Default Notes
INCLUDEDATA = <boolean> NO If YES, a layout package file will be created. The extension .lpk is
recommended.
INCLUDEPREVIEW = <boolean> YES Applies only if INCLUDEDATA is YES.
USERELATIVEPATHS = <boolean> NO If YES, all files referenced in the layout file will use relative paths.
$!SAVELAYOUT "ex1.lay"
$!SET3DEYEDISTANCE
Syntax: $!SET3DEYEDISTANCE
EYEDISTANCE = <dexp>
Description:Sets the distance from the viewer to the plane of the current center of rotation.
Example:
$!SET3DEYEDISTANCE
EYEDISTANCE = 13.5
$!SETARBITRARYSLICEUSINGTHREEPOINTS
Syntax: $!SETARBITRARYSLICEUSINGTHREEPOINTS
GROUP = <integer>
X1 = <dexp>
Y1 = <dexp>
Z1 = <dexp>
X2 = <dexp>
Y2 = <dexp>
Z2 = <dexp>
X3 = <dexp>
Y3 = <dexp>
Z3 = <dexp>
Description:Set the orientation of an arbitrarily-oriented slice by specifying the X, Y, and Z coordinates of
three points on a plane. The three points must not be coincident or collinear. The slice’s origin is set
to the third point and its normal is recalculated such that the cutting plane passes through all three
points.
185
Required Parameters
Parameter Syntax Default Notes
GROUP = <integer> The slice group.
X1 = <dexp> Coordinates of the first point on the cutting plane.
Y1 = <dexp>
Z1 = <dexp>
X2 = <dexp> Coordinates of the second point on the cutting plane.
Y2 = <dexp>
Z2 = <dexp>
X3 = <dexp> Coordinates of the third point on the cutting plane. This point
Y3 = <dexp> is used as the origin of the slice.
Z3 = <dexp>
$!SETAUXDATA
Syntax: $!SETAUXDATA
AUXDATALOCATION = [layout/zone/var/dataset/frame/linemap]
NAME = <string>
VALUESTRING = <string>
[optional parameters]
Description:Add Auxiliary Data in the form of name/value pairs to layouts, zones, frames or datasets. The
name must begin with an underscore or letter, and may be followed by one or more underscore,
period, letter, or digit characters.
Required Parameters
Parameter Syntax Default Notes
AUXDATALOCATION = [layout/zone/
var/dataset/frame/
linemap|page]
NAME = <string>
RETAIN = <boolean> NO Set this to YES to have this auxiliary data item saved when
exporting a data file or layout.
VALUESTRING = <string>
Optional Parameters
Parameter Syntax Default Notes
MAP = <integer> Only required if AUXDATALOCATION = linemap
VAR = <integer> Only required if AUXDATALOCATION = var
ZONE = <integer> Only required if AUXDATALOCATION = zone
$!SETAUXDATA
AUXDATALOCATION = zone
ZONE = 2
NAME = "VARIABLE.DATA"
VALUESTRING = "WEST SECTOR"
186
$!SETDATASETTITLE
$!SETFIELDVALUE
Syntax: $!SETFIELDVALUE
ZONE = <integer>
VAR = <integer>
INDEX = <integer>
FIELDVALUE = <dexp>
AUTOBRANCH = <boolean>
[no optional parameters]
Description:Specify a field value (data set value) at a specified point index. If the zone referenced is IJ- or IJK-
ordered then the point index is calculated by treating the 2- or 3D array as a 1-D array.
Required Parameters
Parameters Syntax Default Notes
AUTOBRANCH = <boolean> Affects shared variables only. If YES, the specified zone will no
longer share that variable with the other zones. If NO, the
variable will still be shared, and the change to the variable will
be shown for all zones where it is shared.
FIELDVALUE = <dexp>
INDEX = <integer>
VAR = <integer>
ZONE = <integer>
Example:
A data set contains 2 zones and 3 variables. Zone 2 is dimensioned 5 by 3. Set the value for variable 3 at IJ-
location (2, 2) to be 37.5:
$!SETFIELDVALUE
ZONE = 2
VAR = 3
INDEX = 7
FIELDVALUE = 37.5
AUTOBRANCH = YES
Note that the INDEX value was calculated using:
INDEX = I + (J-1)*|MAXI| + (K-1) * |MAXI| * |MAXJ|
= 5*(2-1)+2
= 7
$!SETFRAMEBACKGROUNDCOLOR
187
Tecplot 360, converting the all basic colors using the following rules to achieve the best contrast:
1. For all line type basic colors that match the new basic frame color, set the basic line color to the
best show color of the basic frame color.
2. For all fill type basic colors that match the best show color of the new basic frame color, set the
fill color to the new frame color.
Exceptions:
1. For geometries and text boxes if the line and fill colors are the same and filling is active then
both lines and fill follow the fill rules above.
2. For zone, slice, iso-surface, and streamtrace object types the basic color shading (i.e. fill) only
follows the fill rules above if lighting effects are not being used.
$!SETSTYLEBASE
Example: Set the style base for frames to use the factory defaults:
$!SETSTYLEBASE FACTORY
$!SHARECONNECTIVITY
Syntax: $!SHARECONNECTIVITY
SOURCEZONE = <integer>
DESTINATIONZONE = <integer>
[no optional parameters]
Description:Share the nodemap between the source and destination zones, presuming that the zones are FE
and have the same element type and number of nodes.
Required Parameters
Parameter Syntax Default Notes
DESTINATIONZONE = <integer>
SOURCEZONE = <integer>
Example: Shares the connectivity of the second zone with the sixth zone:
$!SHARECONNECTIVITY
SOURCEZONE = 2
DESTINATIONZONE = 6
188
$!SHAREFIELDDATAVAR
Syntax: $!SHAREFIELDDATAVAR
SOURCEZONE = <integer>
VAR = <integer>
DESTINATIONZONE = <integer>
[no optional parameters]
Description:Allows sharing of the specified variable from the source zone to the destination zone. Zone must
be of the same type (ordered or FE) and dimensions. Cell centered variables in FE must have the
same number of cells. Sharing is not allowed if either zone has global face neighbors.
Required Parameters
Parameter Syntax Default Notes
DESTINATIONZONE = <integer>
SOURCEZONE = <integer>
VAR = <integer>
Example: Shares the third variable from the second zone, with the fifth zone:
$!SHAREFIELDDATAVAR
SOURCEZONE = 2
VAR = 3
DESTINATIONZONE = 5
$!SHIFTLINEMAPSTOBOTTOM
$!SHIFTLINEMAPSTOBOTTOM [2,4]
$!SHIFTLINEMAPSTOTOP
$!SHIFTLINEMAPSTOTOP [2,4]
$!SHOWMOUSEPOINTER
189
Description:The mouse icon may be deactivated within a macro to enhance the on-screen animation. It must
be reactivated before exiting the macro.
Example:
$!SHOWMOUSEPOINTER NO
$!LOOP 36
$!ROTATE3DVIEW X
ANGLE = 5
$!REDRAW
$!ENDLOOP
$!SHOWMOUSEPOINTER YES
$!SKETCHAXIS
Syntax: $!SKETCHAXIS
[optional parameters]
Description:A SetValue command that assigns attributes for axes in a sketch mode frame. Axes are rarely
used in sketch frames.
Optional Parameters
Parameter Syntax Default Notes
AUTOADJUSTRANGESTONICEVALEUS = <boolean> NO
AXISMODE = <axismode> XYDEPENDENT Set to INDEPENDENT or XYDEPENDENT.
DEPXTOYRATIO <op> <dexp> =1 AXISMODE must be XYDEPENDENT to use this.
GRIDAREA <<gridarea>> DRAWBORDER=NO,
COLOR=BLACK,
LINETHICKNESS=0.4
PRECISEGRID <<precisegrid>> INCLUDE=NO,
SIZE=0.0045,
COLOR=BLACK,
ISFILLED=NO,
FILLCOLOR=WHITE,
DRAWGRIDLAST=NO
PRESERVEAXISSCALE = <boolean> NO
VIEWPORTNICEFIT = <double>
BUFFER
VIEWPORTPOSITION <<rect>> X1=0, Y1=0,
X2=100, Y2=100
VIEWPORTTOPSNAPTARGET = <double> 100
VIEWPORTTOPSNAPTOLERANCE = <double> 10
XDETAIL <<axisdetail>>
YDETAIL <<axisdetail>>
Example: Change the axis mode to be INDEPENDENT for sketch mode in the active frame:
$!SKETCHAXIS
AXISMODE = INDEPENDENT
$!SLICEATTRIBUTES
190
Optional Parameters
Parameter Syntax Default Notes
CONTOUR
{
SHOW = <boolean> YES
CONTOURTYPE = <contourtype> FLOOD CORNERCELL and AVERAGECELL
options not allowed for CONTOURTYPE.
COLOR = <color> BLACK
LINETHICKNESS = <double> 0.1
USELIGHTINGEFFECT = <boolean> NO
FLOODCOLORING = <contourcoloring> GROUP1
LINECONTOURGROUP = <integer> 1
}
EDGELAYER
{
EDGETYPE BORDERS
SHOW = <boolean> NO
COLOR = <color> BLACK
LINETHICKNESS <op> <double> = 0.4
}
EFFECTS
{
LIGHTINGEFFECT GOURAUD
SURFACETRANSLUCENCY = <integer> 10
USETRANSLUCENCY = <boolean> YES
USEVALUEBLANKING = <boolean> YES
USECLIPPLANES = <set> [1-6]
}
ENDPOSITION
{
X = <double> 0.95
Y = <double> 0.95
Z = <double> 0.95
I = <integer> 10
J = <integer> 10
K = <integer> 10
}
MESH
{
SHOW = <boolean> NO
COLOR = <color>
LINETHICKNESS = <double> 0.1
}
NUMINTERMEDIATE = <integer> 1
SLICES
NORMAL Used for defining arbitrary slice
orientation
{
X = <double>
Y = <double>
Z = <double>
}
OBEYSOURCEBLANKING = <boolean> NO
191
Parameter Syntax Default Notes
CLIPPLANE = <clipplane> NONE Use slice as a clipping plane with one of
the clip plane types.
OBEYCLIPPLANES = <boolean> YES Clip slice by any clipping planes that
intersect it.
PRIMARYPOSITION XYZ are used as the origin when
SLICESURFACE = ARBITRARY
{
X = <double> 0.5
Y = <double> 0.5
Z = <double> 0.5
I = <integer> 5
J = <integer> 5
K = <integer> 5
}
SHADE
{
SHOW = <boolean> NO
COLOR = <color> BLACK
USELIGHTINGEFFECT = <boolean> YES
}
SHOWGROUP = <boolean> YES
SHOWINTERMEDIATE = <boolean> NO
SLICES
SHOWPRIMARYSLICE = <boolean> YES
SHOWSTARTENDSLICE = <boolean> NO
SLICECONSTRAINT
{
INCLUDE = <boolean>
BOXDIMENSION <<xyz>>
ORIGIN <<xyz>>
}
SLICESOURCE = <slicesource> VOLUMEZONES
SLICESURFACE = <slicesurface> XPLANES
STARTPOSITION
{
X = <double> 0.05
Y = <double> 0.05
Z = <double> 0.05
I = <integer> 0
J = <integer> 0
K = <integer> 0
}
VECTOR
{
SHOW = <boolean> NO
COLOR = <color> BLACK
ISTANGENT = <boolean> NO
LINETHICKNESS = <double> 0.1
VECTORTYPE = <vectortype> TAILATPOINT
ARROWHEADSTYLE = <arrowheadstyle> PLAIN
}
SURFACEGENERATIONMETHOD = <surfacegenerationmethod> ALLOWQUADS ALLTRIANGLES avoids holes;
ALLOWQUADS may produce smoother
surfaces
192
Example:
$!GLOBALCONTOUR VAR = 4
$!SLICEATTRIBUTES ENDPOSITION {X = 1}
$!SLICEATTRIBUTES STARTPOSITION {X = 6}
$!SLICEATTRIBUTES NUMINTERMEDIATESLICES = 6
$!SLICEATTRIBUTES SHOWSTARTENDSLICE = YES
$!SLICEATTRIBUTES SHOWINTERMEDIATESLICES = YES
$!REDRAW
$!CREATESLICEZONES
$!SLICELAYERS
Required Parameters
Parameter Syntax Default Notes
SHOW = <boolean> NO
SHOWMESH = <boolean> YES
SHOWCONTOUR = <boolean> YES
SHOWVECTOR = <boolean> YES
SHOWSHADE = <boolean> YES
SHOWEDGE = <boolean> YES
USETRANSLUCENCY = <boolean> YES
USELIGHTINGEFFECT = <boolean> YES
Note:
When slices are activated, they are colored using the contour variable by default. When you activate slices
via the macro language you must perform one of the following steps in order for the slices to be visible in
your final plot:
• Set the contour variable by adding the following command to your macro file (prior to calling
$!SLICELAYER).
$!GLOBALCONTOUR n VAR=m
where n is the contour group number and m is the number of the variable to use for
contouring.
or
• Set CONTOUR SHOW = NO via the $!SLICEATTRIBUTES command. If you choose this
option, you may want to turn on shading to improve the visibility of your slice.
$!SMOOTH
Syntax: $!SMOOTH
ZONE = <set>
VAR = <set>
[optional parameters]
Description:Smooth data (reduce the spikes) for selected variables in selected zones.
193
Required Parameters
Parameter Syntax Default Notes
ZONE = <set> Zones to smooth.
VAR = <set> Variables to smooth. These cannot be X or Y if in 2D or Z if in
3D and they must be a dependent variable in XY-plots.
Optional Parameters
Parameter Syntax Default Notes
NUMSMOOTHPASSES = <integer> 1
SMOOTHWEIGHT = <dexp> 0.8
SMOOTHBNDRYCOND = <boundarycondition> FIXED
$!SMOOTH
ZONE = 2
VAR = 3
NUMSMOOTHPASSES = 5
SMOOTHBNDRYCOND = ZERO2ND
$!STREAMATTRIBUTES
Syntax: $!STREAMATTRIBUTES
[optional parameters]
Description:A SetValue command that changes global attributes associated with streamtraces.
194
Optional Parameters
Parameter Syntax Default Notes
ADDARROWS = <boolean> YES
ARROWHEADSIZE <op> <dexp> = 1.2
ARROWHEADSPACING <op> <double> = 10 Distance between arrowheads in frame units.
CELLFRACTION <op> <dexp> = 0.25 Maximum fraction of the distance across a cell a
streamtrace moves in one step. A streamtrace adjusts its
step-size between CELLFRACTION and
MINCELLFRACTION depending on local curvature of
the streamtrace.
COLOR = <color> BLACK
LINETHICKNESS <op> <dexp> = 0.1
MAXSTEPS <op> <integer> = 10,000
MINCELLFRACTION <op> <dexp> = 1 x 10-005 Minimum fraction of the distance across a cell a
streamtrace moves in one step.
OBEYSOURCEZONEBLANKING = <boolean> NO
OBEYCLIPPLANES = <boolean> NO Clip streamtraces by any clipping planes that intersect
the streamtraces.
RODRIBBON
{
WIDTH <op><dexp> = 0.01 Value is grid units.
NUMRODPOINTS <op> <integer> =3 Number of points defining the streamrod cross-section
MESH
{
SHOW = <boolean> NO
}
CONTOUR
{
SHOW = <boolean> NO
USELIGHTINGEFFECT = <boolean> YES
FLOODCOLORING = <contourcoloring> GROUP1
}
SHADE
{
SHOW = <boolean> YES
COLOR = <color>
USELIGHTINGEFFECT = <boolean> YES
}
EFFECTS
{
LIGHTINGEFFECT = <lightingeffect> GOURAUD
SURFACETRANSLUCENCY = <translucency> 50
USETRANSLUCENCY = <boolean> NO
}
}
SHOWPATHS = <boolean> YES
STREAMTIMING
{
SHOWDASHES = <boolean> NO
SHOWMARKERS = <boolean> NO
MARKCOLOR = <color> BLACK
MARKSIZE <op> <dexp> =1
DASHSKIP <op> <integer> =1
195
Parameter Syntax Default Notes
MARKSYMBOL <<symbolshape>> ISASCII=NO,
GEOMSHAPE=
SQUARE
TIMESTART = <double> -1 x 10150
TIMEEND = <double> 1 x 10150
TIMEANCHOR = <double> 0
TIMEDELTA = <double> 1 x 10150
}
TERMLINE
{
ISACTIVE = <boolean> NO
SHOW = <boolean> YES
COLOR = <color> BLACK
LINEPATTERN = <linepattern> SOLID
PATTERNLENGTH <op> <dexp> =2
LINETHICKNESS <op> <dexp> = 0.1
}
Description: The different commands in the STREAMTRACE compound function family are described
separately in the following sections.
$!STREAMTRACE ADD
196
Optional Parameters
Parameters Syntax Default Notes
ALTSTARTPOS This is required if NUMPTS is greater than 1 or if the
{ streamtype is a volume rod or volume ribbon.
X = <dexp> 0.0
Y = <dexp> 0.0
Z = <dexp> 0.0
}
DIRECTION = <streamdirection> FORWARD
DISTRIBUTIONREGION = <streamdistributionregion> If not present, use NUMPTS to decide whether to add
a single streamtrace or a rake of streamtraces.
NUMPTS = <integer> 1 Use 1 to add a single streamtrace. Use n, n>1 for a rake
of streamtraces.
STARTPOS Z is necessary only if dealing with a 3D streamtrace.
{
X = <dexp> 0.0
Y = <dexp> 0.0
Z = <dexp> 0.0
}
STREAMTYPE =<streamtype> Tecplot 360 determines the default STREAMTYPE
based on a number of factors. It is best to always
specify this parameter explicitly.
Example 1:
Add a rake of 5 streamtraces in a 2D field plot:
$!STREAMTRACE ADD
NUMPTS = 5
STREAMTYPE = TWODLINE
STARTPOS
{
X = 0.5
Y = 0.5
}
ALTSTARTPOS
{
X = 0.5
Y = 1.5
}
Example 2:
Add a single volume ribbon. Start the ribbon oriented parallel to the Z-axis:
$!STREAMTRACE ADD
STREAMTYPE = VOLUMERIBBON
STARTPOS
{
X = 3.0
Y = 4.0
Z = 1.0
}
ALTSTARTPOS
{
X = 3.0
Y = 4.0
197
Z = 8.0
}
$!STREAMTRACE DELETEALL
Example:
$!STREAMTRACE DELETEALL
$!STREAMTRACE DELETERANGE
Optional Parameters
Parameters Syntax Default Notes
RANGESTART = <integer> 1
RANGEEND = <integer> 1
$!STREAMTRACE DELETERANGE
RANGESTART = 3
RANGEEND = 5
$!STREAMTRACE RESETDELTATIME
Example:
$!STREAMTRACE RESETDELTATIME
$!STREAMTRACE SETTERMINATIONLINE
198
Description:Set the position of the termination line for streamtraces.
Required Parameter
Parameters Syntax Default Notes
<xyrawdata> In 3D, the termination line is defined in the eye coordinate system.
$!STREAMTRACE SETTERMINATIONLINE
RAWDATA
3
4 0 7 0
5 0 9 0
5 0 3 0
$!STREAMTRACELAYERS
Required Parameters
Parameter Syntax Default Notes
SHOW = <boolean> NO
$!SYSTEM
Example: Submit the system command to copy the file t7.plt to xxx.plt (Linux/Mac):
Example: Submit the system command to copy the file t7.plt to xxx.plt (Windows):
199
Optional Parameters
Parameter Syntax Default Notes
WAIT = <boolean> YES If YES, Tecplot 360 will wait until the execution of the system
command has completed before continuing.
$!THREEDAXIS
Syntax: $!THREEDAXIS
[optional parameters]
Description:A SetValue command that assigns attributes for axes in a 3D frame.
Optional Parameters
Parameter Syntax Default Notes
ASPECTRATIOLIMIT <op> <dexp> = 25 Restrict the aspect ratio of the data.
ASPECTRATIORESET <op> <dexp> =2 Set aspect ratio for the data to this value when
ASPECTRATIOLIMIT is exceeded.
AXISMODE = <axismode> Set to INDEPENDENT, XYDEPENDENT, or
XYZDEPENDENT.
BOXASPECTRATIOLIMIT <op> <dexp> = 25 Restrict the aspect ratio of the axis box.
BOXASPECTRATIORESET <op> <dexp> =2 Set aspect ratio for the axis box to this value when
ASPECTRATIOLIMIT is exceeded.
DEPXTOYRATIO <op> <dexp> AXISMODE must be DEPENDENT to use this.
DEPXTOZRATIO <op> <dexp> AXISMODE must be DEPENDENT to use this.
EDGEAUTORESET = <boolean> Make Tecplot 360 automatically choose edges to
label.
FRAMEAXIS
{
SHOW = <boolean>
SHOWVARIABLENAME = <boolean> Shows variable name instead of axis name on the
orientation axis
SIZE <op> <dexp>
LINETHICKNESS <op> <dexp>
COLOR = <color>
XYPOS <<xy>>
}
GRIDAREA <<gridarea>>
PRESERVEAXISSCALEWHENRANGEISCHANGED = <boolean>
XDETAIL <<axisdetail>>
XYDEPXTOYRATIO <op> <dexp> AXISMODE must be XYDEPENDENT to use this.
YDETAIL <<axisdetail>>
ZDETAIL <<axisdetail>>
Example:
This example does the following:
• Changes the variable assigned to the Z-axis to be variable number 2.
200
• Turns off auto edge assignment and make axis labeling for the Y-axis occur on edge 2.
$!THREEDAXIS
ZVAR = 2
EDGEAUTORESET = NO
YEDGE = 2
$!THREEDVIEW
Syntax: $!THREEDVIEW
[optional parameters]
Description:A SetValue command that changes global attributes associated with the 3D view.
Optional Parameters
Parameter Syntax Default Notes
ALPHAANGLE <op> <dexp> =0 Angle is in degrees.
DRAWINPERSPECTIVE = <boolean> NO
FIELDOFVIEW <op> <dexp>
PSIANGLE <op> <dexp> = 60 Angle is in degrees.
THETAANGLE <op> <dexp> = 240 Angle is in degrees.
VIEWERPOSITION <<xyz>> See Notes X = 8.073, Y = 4.873, Z = 5.549
VIEWWIDTH <op> <dexp> = 1.74267
Example:
This example does the following:
• Switches to perspective.
• Changes the field of view.
• Rotates around psi by 20 degrees.
• Changes the viewer position.
$!THREEDVIEW
DRAWNINPERSPECTIVE = YES
FIELDOFVIEW = 100
PSIANGLE += 20
VIEWERPOSITION
{
X = 1.26
Y = 1.25
Z = 0.74
}
$!TRANSFORMCOORDINATES
Syntax: $!TRANSFORMCOORDINATES
TRANSFORMATION = <transformation>
[optional parameters]
201
Description:Transforms all points in one or more zones from one coordinate system to another.
Required Parameter
Parameters Syntax Default Notes
TRANSFORMATION = <transformation> Transformation.
Optional Parameters
Parameter Syntax Default Notes
ANGLESPEC = <anglespec> RADIANS Specifies whether data is in degrees or radians
CREATENEW = <boolean> NO If YES, then new variables X,Y,Z will be created if converting to
rectangular coordinates, or R,THETA,PHI if converting to
VARIABLES spherical. If NO, then you must specify the output variables.
PSIVAR = <integer> PSI variable number. REQUIRED if the transformation is
spherical to rectangular or if CREATENEWVARIABLES is NO.
RVAR = <integer> R variable number. REQUIRED if the transformation is polar to
rectangular or spherical to rectangular or if
CREATENEWVARIABLES is NO.
THETAVAR = <integer> NONE Theta variable number. REQUIRED if the transformation is
polar to rectangular or spherical to rectangular or if
CREATENEWVARIABLES is NO.
XVAR = <integer> X variable number. REQUIRED if the transformation is
rectangular to polar or rectangular to spherical or
CREATENEWVARIABLES is NO.
YVAR = <integer> Y variable number. REQUIRED if the transformation is
rectangular to polar or rectangular to spherical or
CREATENEWVARIABLES is NO.
ZONELIST = <set> all zones Set of zones to operate on.
ZVAR = <integer> Z variable number. REQUIRED if the transformation or
rectangular to spherical or CREATENEWVARIABLES is NO.
Example:
Transform data from rectangular coordinates to polar coordinates specifying angles in degrees and
creating new variables.
$!TRANSFORMCOORDINATES
TRANSFORMATION = RECTTOPOLAR
ANGLESPEC = DEGREES
CREATENEWVARIABLES = YES
XVAR = 2
YVAR = 3
$!TRIANGULATE
Syntax: $!TRIANGULATE
[optional parameters]
Description:Create a new zone by forming triangles from data points in existing zones.
202
Optional Parameters:
Parameters Syntax Default Notes
AUTOSTRANDTRANSIENTDATA = <boolean> YES If set to YES, time strands are automatically created for transient
data in the new zone.
BOUNDARYZONES = <set> Required if USEBOUNDARY is YES.
INCLUDEBOUNDARY = <boolean> NO Set to YES if you also want the boundary points to be used to create
triangles.
PTS
SOURCEZONES = <set> All zones.
TRIANGLEKEEP = <dexp> 0.25
FACTOR
USEBOUNDARY = <boolean> NO Specify one or more I-ordered zones that define boundaries across
which no triangles can be created.
$!TRIANGULATE
SOURCEZONES= [1,2]
$!TWODAXIS
Syntax: $!TWODAXIS
[optional parameters]
Description:A SetValue command that assigns attributes for axes in a 2D frame.
Optional Parameters
Parameter Syntax Default Notes
AUTOADJUSTRANGESTONICEVALUES = <boolean>
AXISMODE <axismode> Set to INDEPENDENT or XYDEPENDENT
DEPXTOYRATIO <op> <dexp> AXISMODE must be XYDEPENDENT to use.
GRIDAREA <<gridarea>>
PRECISEGRID <<precisegrid>>
PRESERVEAXISSCALEWHENRANGEISCHANGED = <boolean>
VIEWPORTNICEFIT = <double>
BUFFER
VIEWPORTPOSTITION <<rect>>
VIEWPORTTOPSNAP = <integer> 100
TARGET
VIEWPORTTOPSNAP = <integer> 10
TOLERANCE
XDETAIL <<axisdetail>> VARNUM = 1
YDETAIL <<axisdetail>> VARNUM = 2
$!TWODAXIS
XDETAIL {VARNUM = 3}
203
V
$!VARSET
Examples:
Example 1:
Set the macro variable |myvar| to 3:
$!VARSET |myvar| = 3
Example 2:
Add 2 to the macro variable |myvar|:
$!VARSET |myvar| += 2
Example 3:
Set the macro variable |File1| to be myfile.plt:
Example 4:
Set the macro variable |F1| to equal |V2| + |V3|, where |V2| and |V3| are predefined variables:
$!VARSET|V2| = 4
$!VARSET|V3| = 5
$!VARSET|F1| = (|V2| + |V3|)
Description: The different commands in the VIEW compound function family are described separately in the
following sections.
The VIEW compound function family is:
$!VIEW AXISFIT
$!VIEW AXISMAKECURRENTVALUESNICE
$!VIEW AXISNICEFIT
$!VIEW CENTER
$!VIEW COPY
$!VIEW DATAFIT
$!VIEW FIT
204
$!VIEW FITSURFACES
$!VIEW LAST
$!VIEW MAKECURRENTVIEWNICE
$!VIEW NICEFIT
$!VIEW PASTE
$!VIEW PUSH
$!VIEW RESETTOENTIRECIRCLE
$!VIEW SETMAGNIFICATION
$!VIEW TRANSLATE
$!VIEW ZOOM
$!VIEW AXISFIT
Optional Parameters
Parameter Syntax Default Notes
AXIS = <xyaxis> ‘X’ Default is ‘T’ for polar plot type.
AXISNUM = <integer> 1 Only XY frame mode allows for this to be a number greater than 1.
CONSIDERBLANKING = <boolean> NO If CONSIDERBLANKING is YES, and blanking is enabled, the resulting
view excludes blanked cells at the edges of the plot.
Example: Reset the range on the Y-axis to fit the data being plotted:
$!VIEW AXISFIT
AXIS =’Y’
$!VIEW AXISMAKECURRENTAXISVALUESNICE
Optional Parameters
Parameter Syntax Default Notes
AXIS = <xyaxis> ‘X’ Default is ‘T’ for polar plot type.
AXISNUM = <integer> 1 Only XY line plots allow for this to be a number greater than 1.
Example: Set the range on the Z-axis to have nice values for the axis labels:
$!VIEW AXISMAKECURRENTAXISVALUESNICE
AXIS = ’Z’
205
$!VIEW AXISNICEFIT
Optional Parameters:
Parameter Syntax Default Notes
AXIS = <xyaxis> ‘X’ Default is ‘T’ for polar plot type.
AXISNUM = <integer> 1 Only XY frame mode allows for this to be a number greater than 1.
CONSIDERBLANKING = <boolean> NO If CONSIDERBLANKING is YES, and blanking is enabled, the resulting
view excludes blanked cells at the edges of the plot.
Example:
Reset the range on the Y-axis to fit the data being plotted, with nice values on the axis-line:
$!VIEW AXISNICEFIT
AXIS =’Y’
$!VIEW CENTER
Optional Parameter:
Parameter Syntax Default Notes
CONSIDERBLANKING = <boolean> NO If CONSIDERBLANKING is YES, and blanking is enabled, the
resulting view excludes blanked cells at the edges of the plot.
$!VIEW COPY
$!VIEW DATAFIT
206
Optional Parameter:
Parameter Syntax Default Notes
CONSIDERBLANKING = <boolean> NO If CONSIDERBLANKING is YES, and blanking is enabled, the
resulting view excludes blanked cells at the edges of the plot.
$!VIEW FIT
Optional Parameter:
Parameter Syntax Default Notes
CONSIDERBLANKING = <boolean> NO If CONSIDERBLANKING is YES, and blanking is enabled, the
resulting view excludes blanked cells at the edges of the plot.
$!VIEW FITSURFACES
Optional Parameter:
Parameter Syntax Default Notes
CONSIDERBLANKING = <boolean> NO If CONSIDERBLANKING is YES, and blanking is enabled, the
resulting view excludes blanked cells at the edges of the plot.
$!VIEW LAST
$!VIEW MAKECURRENTVIEWNICE
207
$!VIEW NICEFIT
Optional Parameter:
Parameter Syntax Default Notes
CONSIDERBLANKING = <boolean> NO If CONSIDERBLANKING is YES, and blanking is enabled, the
resulting view excludes blanked cells at the edges of the plot.
$!VIEW PASTE
$!VIEW PUSH
$!VIEW RESETTOENTIRECIRCLE
$!VIEW SETMAGNIFICATION
208
Required Parameter
Parameter Syntax Default Notes
MAGNIFICATION = <dexp>
Example: Make the plot to be drawn one-half as big as when it fits within the grid area:
$!VIEW SETMAGNIFICATION
MAGNIFICATION = 0.5
$!VIEW TRANSLATE
Required Parameters
Parameter Syntax Default Notes
X = <dexp> 0.0 Amount to translate in X-frame units.
Y = <dexp> 0.0 Amount to translate in Y-frame units.
Example: Translate the view 10 percent of the frame width to the right:
$!VIEW TRANSLATE
X = 10
Y = 0
$!VIEW ZOOM
209
Required Parameters
Parameter Syntax Default Notes
X1 = <dexp>
Y1 = <dexp>
X2 = <dexp>
Y2 = <dexp>
Example: Zoom so the rectangular region with corners at (1, 0) and (7, 9) are in view:
$!VIEW ZOOM
X1 = 1
Y1 = 0
X2 = 7
Y2 = 9
W-X
$!WHILE...$!ENDWHILE
Syntax:$!WHILE <conditionalexp>
.$!ENDWHILE
Description:Continue to execute a set of commands until a conditional expression is NO.
Example: Execute a set of commands until the macro variable |myvar| is greater than 1.0:
Description:The different commands in the WORKSPACEVIEW compound function family are described
separately in the following sections.
The WORKSPACEVIEW compound functions are:
$!WORKSPACEVIEW FITALLFRAMES
$!WORKSPACEVIEW FITPAPER
$!WORKSPACEVIEW FITSELECTEDFRAMES
$!WORKSPACEVIEW LASTVIEW
$!WORKSPACEVIEW MAXIMIZE
$!WORKSPACEVIEW TRANSLATE
$!WORKSPACEVIEW UNMAXIMIZE
$!WORKSPACEVIEW ZOOM
$!WORKSPACEVIEW FITALLFRAMES
210
$!WORKSPACEVIEW FITPAPER
$!WORKSPACEVIEW FITSELECTEDFRAMES
$!WORKSPACEVIEW LASTVIEW
$!WORKSPACEVIEW MAXIMIZE
$!WORKSPACEVIEW TRANSLATE
Required Parameters
Parameter Syntax Default Notes
X = <dexp> 0 Value is in inches.
Y = <dexp> 0 Value is in inches.
Example:
Shift the workspace view to the left by 2 inches (as measured by the workspace ruler):
$!WORKSPACEVIEW TRANSLATE
211
X = -2
Y = 0
$!WORKSPACEVIEW UNMAXIMIZE
$!WORKSPACEVIEW ZOOM
Required Parameters
Parameter Syntax Default Notes
X1 = <dexp>
Y1 = <dexp>
X2 = <dexp>
Y2 = <dexp>
Example:
Make the region in the lower left corner of an 8.5 by 11 paper be viewable in the work area. The paper is in
portrait orientation:
$!WORKSPACEVIEW ZOOM
X1 = 0
Y1 = 5.5
X2 = 4.25
Y2 = 9.75
$!WRITECOLORMAP
$!WRITECOLORMAP "mycolors.map"
212
$!WRITECURVEINFO
Required Parameter
Parameter Syntax Default Notes
SOURCEMAP = <integer> This must be the number of a line mapping that does some
type of curve fit or spline.
Optional Parameter
Parameters Syntax Default Notes
CURVEINFOMODE = <curveinfomode> CURVEDETAILS Use CURVE DETAILS or CURVEPOINTS.
Example: Write out the coefficients for XY line mapping number 3 to map3.out:
$!WRITECURVEINFO "map3.out"
SOURCEMAP = 3
CURVEINFOMODE = CURVE DETAILS
$!WRITEDATASET
213
Optional Parameters
Parameters Syntax Default Notes
ASSOCIATELAYOUTWITHDATAFILE = <boolean> YES
BINARY = <boolean> YES If NO, can use PRECISION and USEPOINTFORMAT.
INCLUDEAUTOGEN = <boolean> NO
FACENEIGHBORS
INCLUDECUSTOM = <boolean> YES
LABELS
INCLUDEDATA = <boolean> YES
INCLUDEDATASHARELINKAGE = <boolean> NO
INCLUDEGEOM = <boolean> YES
INCLUDETEXT = <boolean> YES
PRECISION = <integer> 12 Only used if ASCII (that is, BINARY is NO).
TECPLOTVERSIONTOWRITE = <string> TecplotCurrent Optional designation of binary file version. Possible
values are TecplotCurrent, Tecplot2009, Tecplot2008, and
Tecplot2006.
USEPOINTFORMAT = <boolean> NO Only used if ASCII (that is, BINARY is NO).
VARPOSITIONLIST = <set> All vars. Use this to limit the number of variables written out.
ZONELIST = <set> All zones. Use this to limit the number of zones written out.
$!WRITEDATASET "zones.plt"
INCLUDETEXT = NO
INCLUDEGEOM = NO
INCLUDECUSTOMLABELS = NO
ZONELIST = [1-3, 6]
$!WRITESTYLESHEET
Optional Parameters
Parameters Syntax Default Notes
INCLUDECONTOURLEVELS = <boolean> YES
INCLUDETEXT = <boolean> YES
INCLUDEGEOM = <boolean> YES
INCLUDEPLOTSTYLE = <boolean> YES
INCLUDESTREAMPOSITIONS = <boolean> YES
INCLUDEFACTORYDEFAULTS = <boolean> NO
USERELATIVEPATHS = <boolean>
INCLUDEAUXDATA = <boolean> YES
$!WRITESTYLESHEET "f1.sty"
INCLUDEFACTORYDEFAULTS = YES
214
$!XYLINEAXIS
Syntax: $!XYLINEAXIS
[optional parameters]
Description:A SetValue command that assigns attributes for axes in an XY Line plot.
Optional Parameters
Parameter Syntax Default Notes
AUTOADJUSTRANGESTONICEVALUES = <boolean> NO
AXISMODE <axismode> INDEPENDENT INDEPENDENT or XYDEPENDENT.
DEPXTOYRATIO <op> <dexp> =1 AXISMODE must be XYDEPENDENT to
use this. This applies only to the X1- and
Y1-axes.
GRIDAREA <<gridarea>> See Notes DRAWBORDER=N0, COLOR=BLACK,
LINE THICKNESS=0.4
PRECISEGRID <<precisegrid>> See Notes INCLUDE=NO, SIZE=0.0045,
COLOR=BLACK, ISFILLED=NO,
FILLCOLOR=WHITE,
DRAWGRIDLAST=NO
PRESERVEAXISSCALE = <boolean> NO
VIEWPORTNICEFITBUFFER = <double> Between 1 and 100.
VIEWPORTPOSITION See Notes X1 = 13, Y1 = 11, X2 = 8, Y = 88
VIEWPORTTOPSNAPTARGET = <integer> 100
VIEWPORTTOPSNAPTOLERANCE = <integer> 10
XDETAIL <integer> <<axisdetail>> The <integer> option specifies which axis
to operate on, 1 n 5.
YDETAIL <integer> <<axisdetail>> The <integer> option specifies which axis
to operate on, 1 n 5.
Example: Set the axis mode to be independent for the XY-axes (note that this affects only X1 versus Y1):
$!XYLINEAXIS
AXISMODE = INDEPENDENT
215
216
10
Tecplot 360 add-ons can and often do extend the Tecplot macro language. Macro commands associated
with add-ons are exposed to the macro language using Tecplot 360’s EXTENDEDCOMMAND command, which
delegates the processing of the command to a named add-on. The syntax of this command is shown
below:
$!EXTENDEDCOMMAND
COMMANDPROCESSORID = <string>
COMMAND = <string>
The COMMANDPROCESSORID is set to a string that identifies the add-on, while the COMMAND is a string that is
passed to the add-on for processing.
Documentation for the macro commands supported by most add-ons can be found in Chapter 30: “Add-
ons” in the User’s Manual. Two add-ons are also documented here:
• CFD Analyzer, which provides the Analyze menu in Tecplot 360
• Extend Macro, which provides additional functionality useful for scripting
10 - 1 CFD Analyzer
The Analyze menu is technically implemented as an add-on. Its COMMANDPROCESSORID is CFDAnalyzer3. The
command string is set to one of the commands listed below.
217
CALCPARTICLEPATH calculates particle paths or streaklines for steady or unsteady flow solutions, using the
location of any existing streamtraces as starting locations for the particles. Particles may have mass or be
massless.
CALCTURBULENCEFUNCTION calculates any of four turbulence-related functions, given any two in your data set.
CALCULATE calculates a PLOT3D function. The name of this function must be specified in the shortened
form listed in Section 10 - 1.3 “Parameter Assignment Values”.
CALCULATEACCURACY uses Richardson extrapolation to estimate the order accuracy of the solution, given the
solution on three grids of successively finer resolution. If either of the plotting options are set to TRUE, the
resulting Tecplot 360 frames will be in front after executing this command.
DISPLAYBOUNDARIES displays zone boundaries in a new frame according to settings made by the
SETGEOMETRYANDBOUNDARIES macro. Each boundary of each 3D zone (in 3D Cartesian plots) or 2D zone (in 2D
Cartesian plots) is displayed and named according to the boundary condition applied to it. Boundaries
that are connected to the boundaries of adjacent zones are named as such.
EXTRACTFLOWFEATURE displays shock surfaces, vortex cores, or separation and attachment lines for 3D flow
solutions. Separation and attachment lines are only calculated on no-slip wall boundaries identified by the
SETGEOMETRYANDBOUNDARIES macro. Shock surfaces are displayed as iso-surfaces of a new variable,
ShockFeature, while the remaining features are displayed as new zones.
EXTRAPOLATESOLUTION performs Richardson extrapolation to estimate the true solution from three input
solutions on grids of successively finer resolution. It saves the extrapolated solution as a new zone in the
current data set. It also saves an additional zone containing the difference between this solution and the
original solution.
INTEGRATE performs an integration. All Integrate dialog options are available to this macro, including the
display options. If the PLOTRESULTS parameter is set to TRUE, then the Tecplot 360 frame showing the
integration results is the active frame following this command.
SAVEINTEGRATIONRESULTS has the same effect as clicking Save on the Integration Results dialog and selecting
a file. The results are saved to the file named by the FILE parameter.
SETFIELDVARIABLES identifies variables in your data, such as velocity, pressure and temperature, for use in
analysis.
SETFLUIDPROPERTIES sets the properties of the fluid, such as viscosity. These are used by some actions of the
CALCULATE and INTEGRATE commands.
SETGEOMETRYANDBOUNDARIES identifies boundaries of zones in a flow solution and the boundary conditions
applied to them. It also specifies whether zones with coincident boundary nodes should be considered
connected at those points, as well as whether 2D solutions should be regarded as axisymmetric.
SETREFERENCEVALUES sets the reference (free-stream) properties of the solution. This information is used by
other calculations.
SETUNSTEADYFLOWOPTIONS identifies solution time levels for unsteady flow solutions. This information is used
for particle path and streakline calculations.
The COMMAND strings below must be contained on a single line in your macro command
file, although they appear on multiple lines below.
218
CFD Analyzer
ANIMATESTREAKLINES
Syntax:$!EXTENDEDCOMMAND
COMMANDPROCESSORID = ‘CFDANALYZER3’
COMMAND = ‘ANIMATESTREAKLINES
[optional parameters]’
Description: Animates previously calculated streaklines to the screen or to a file.
Optional Parameters:
Parameter Syntax Default Notes
DESTINATION = <string> SCREEN Specifies the destination of the animation. May be SCREEN,
AVIFILE or RASTERMETAFILE.
FILENAME = <string> ““ The name of the file to which to save the animation. Must be
specified for DESTINATION values of AVIFILE or
RASTERMETAFILE.
WIDTH = <integer> 300 The width of the animation when saved to a file.
SPEED = <double> 10.0 The speed in frames per second of the animation. Only used
for animations saved to an AVI file.
USEMULTIPLECOLO = <boolean> FALSE Specifies whether animations saved to a file should include
R one color table for each frame. The default is to use a single
color table.
TABLES
INCLUDEZONE = <boolean> FALSE
ANIMATION
ATTACHINTEGRATIONRESULTS
Syntax: $!EXTENDEDCOMMAND
COMMANDPROCESSORID = ‘CFDAnalyzer3’
COMMAND = ‘ATTACHINTEGRATIONRESULTS’
Description:Attach the text results of the previous integration as a text field in the active frame.
CALCPARTICLEPATH
Syntax: $!EXTENDEDCOMMAND
COMMANDPROCESSORID = ‘CFDAnalyzer3’
COMMAND = ‘CALCPARTICLEPATH
[optional parameters]’
Description:Calculate particle paths or streaklines, starting from existing Tecplot 360 streamtraces.
219
Optional Parameters:
Parameter Syntax Default Notes
FUNCTION = <particlefunction> PARTICLEPATH Can be PARTICLEPATH or
STREAKLINE.
TIMESTEP = <double> 1 The integration time step for the
calculation.
MAXTIMESTEPS = <integer> 1000 For steady-state calculations only.
RELEASEFREQ = <double> 1 For FUNCTION = STREAKLINE.
Indicates the number of particles to
release in the indicated time period
(see the next parameter).
RELEASEOPTION = <releaseoption> TIMELEVEL For FUNCTION = STREAKLINE. If
TIMELEVEL, indicates that
RELEASEFREQ particles should be
released every solution time level. If
UNITTIME, indicates that this
number of particles should be
released in a unit amount of solution
time.
HAVEMASS = <boolean> FALSE If TRUE, particles have mass; specify
the particle mass options below.
CREATESINGLEZONE = <boolean> FALSE For FUNCTION = PARTICLEPATH
only, specifies that all particle paths
should be combined into a single I-J
ordered zone.
STOREOPTION = <storeoption> PARTICLEVALUES If PARTICLEVALUES, the particle’s
velocity, mass and temperature (if
calculated) will be stored in place of
appropriate fluid values in the
particle path’s zone. If
FLUIDVALUES, all fluid values the
particle passed through will be
stored in the zone.
COEFFS = <coeffsoption> GENERAL If GENERAL, specify
BALLISTICCOEFF, plus
TEMPTIMECONST if calculating
particle temperature. If DETAILED,
specify MASS, RADIUS, and
DRAGCOEFF, plus SPECIFICHEAT
and NUSSELT if calculating
temperature. Only applies if
HAVEMASS = TRUE.
CALCTEMPERATURE = <boolean> FALSE If TRUE, particle temperature will be
calculated. Only applies if
HAVEMASS = TRUE.
GRAVITYCONSTANT = <double> 0.0 The acceleration due to gravity. Only
applies if HAVEMASS = TRUE.
GRAVITYDIRECTION = <gravitydirection> MINUSX The axis direction in which gravity
acts. Only applies if HAVEMASS =
TRUE.
INITIALVELOCITYOPTI = <initialvelocityoption> LOCALFLUIDVELOCITY The initial velocity of particles.
ON Options are LOCALFLUIDVELOCITY
and ZEROVELOCITY. Only applies if
HAVEMASS = TRUE.
BALLISTICCOEFF = <double> 1.0 For GENERAL coefficients only, the
ballistic coefficient of the particle.
Only applies if HAVEMASS = TRUE.
TEMPTIMECONST = <double> 1.0 For GENERAL coefficients with
CALCTEMPERATURE = TRUE only,
the temperature relaxation factor of
the particle. Only applies if
HAVEMASS = TRUE.
MASS = <double> 1.0 For DETAILED coefficients only, the
particle mass. Only applies if
HAVEMASS = TRUE.
RADIUS = <double> 1.0 For DETAILED coefficients only, the
particle initial radius. Only applies if
HAVEMASS = TRUE.
220
CFD Analyzer
Example 1:Calculate streaklines with an integration time step of 0.1, releasing eight particles per
unit solution time:
$!EXTENDEDCOMMAND
COMMANDPROCESSORID = CFDAnalyzer3
COMMAND = ‘CALCPARTICLEPATH
FUNCTION=STREAKLINE
TIMESTEP=0.1 RELEASEFREQ=8
RELEASEOPTION=UNITTIME’
Example 2:Calculate particle paths, including temperature with ablation, in a steady-state flow for
particles with an initial mass of 3E-14, an initial radius of 1.5E-6 and a specific heat of 703. Use
a time step of 1E-6. Have Tecplot 360 calculate the drag coefficient and the Nusselt number.
Use an ablation temperature of 2,250 and a latent heat of 1.5E5:
$!EXTENDEDCOMMAND
COMMANDPROCESSORID = CFDAnalyzer3
COMMAND = ‘CALCPARTICLEPATH
TIMESTEP = 1.0e-6
HAVEMASS = TRUE
COEFFS = DETAILED
CALCTEMPERATURE = TRUE
MASS = 3e-14
221
RADIUS = 1.5e-6
DRAGCOEFFOPTION = CALCULATE
SPECIFICHEAT = 703
NUSSELTOPTION = CALCULATE
TERMOPTION = ABLATE
TEMPERATURE = 2250
LATENTHEAT = 1.5e5’
CALCTURBULENCEFUNCTION
Syntax: $!EXTENDEDCOMMAND
COMMANDPROCESSORID = ‘CFDAnalyzer3’
COMMAND = ‘CALCTURBULENCEFUNCTION’
[optional parameters]
Description:Calculate a turbulence-related function from two variables in the current data set. Add the result
to the data set as a new variable using the function’s name, or overwrite the variable if it already
exists.
Optional Parameters:
Parameter Syntax Default Notes
CALCULATEONDEMAND = <boolean> FALSE
FUNCTION = <turbulencefunction> FREQUENCY May be ENERGY, DISSIPATIONRATE,
FREQUENCY, or VISCOSITY.
ID1 = <turbulencefunction> ENERGY The turbulence quantity the first data
set variable represents.
VARIABLE1 = <integer> 1 The number of the first data set
variable.
ID2 = <turbulencefunction> DISSIPATIONRATE The turbulence quantity the second
data set variable represents.
VARIABLE2 = <integer> 2 The number of the second data set
variable.
VALUELOCATION = <valuelocation> NODAL The location of new variables added
to the data set. Can be NODAL or
CELLCENTERED.
Example:Calculate turbulent kinematic viscosity from turbulent kinetic energy, variable 5, and
turbulent frequency, variable 6:
$!EXTENDEDCOMMAND
COMMANDPROCESSORID = CFDAnalyzer3
COMMAND = ‘CALCTURBULENCEFUNCTION
FUNCTION=VISCOSITY
VARIABLE1=5
ID2=FREQUENCY VARIABLE2=6’
CALCULATE
Syntax: $!EXTENDEDCOMMAND
COMMANDPROCESSORID = ‘CFDAnalyzer3’
COMMAND = ‘CALCULATE FUNCTION = <functionname>
[optional parameters]’
Description:Calculate a Tecplot 360 variable using the specified function and add it to the current data set. If
the variable already exists in the current data set, it will be recalculated.
222
CFD Analyzer
Required Parameter:
Parameter Syntax Default Notes
FUNCTION = Indicates the function to be used to calculate the variable. If it is
<functionname> a vector function, the components will be stored as X name, Y
name, and Z name, where name is the function name
appearing in the interface.
Optional Parameter:
Parameter Syntax Default Notes
NORMALIZATION = NONE May be NONE, MAXIMUMMAGNITUDE or REFERENCEVALUES.
<normalizationo
ption>
VALUELOCATION = <valuelocation> NODAL The location of new variables added to the data set. Can be
NODAL or CELLCENTERED.
CALCULATEONDEMAND = <boolean> FALSE
Example 1:Calculate the Jacobian for the grid of the current data set:
$!EXTENDEDCOMMAND
COMMANDPROCESSORID = CFDAnalyzer3
COMMAND = ‘CALCULATE FUNCTION = JACOBIAN’
Example 2:Calculate the pressure coefficient for the current data set. The freestream density and
speed of sound are 1.0 (the defaults):
$!EXTENDEDCOMMAND
COMMANDPROCESSORID = CFDAnalyzer3
COMMAND = ‘CALCULATE
FUNCTION = PRESSURECOEF’
CALCULATEACCURACY
Syntax: $!EXTENDEDCOMMAND
COMMANDPROCESSORID = ‘CFDAnalyzer3’
COMMAND = ‘CALCULATEACCURACY ZONES = [<set>]
[optional parameters]’
Description:Calculate the order accuracy of the solution contained in the listed zones. Optionally, plot the
overall accuracy versus grid spacing and plot the accuracy at each grid node.
223
Required Parameter:
Parameter Syntax Default Notes
ZONES = <set> Indicates the three zones from which to perform the accuracy
calculation.
Optional Parameters:
Parameter Syn- Syntax Default Notes
tax
MAXACCURACY = <double> 2.0 The maximum theoretical accuracy of the solver which
generated the solution. Used to limit the calculated accuracy.
DATASETVAR = <integer> 1 The data set variable with which to perform the accuracy
calculation.
PLOTDETAILED = <boolean> FALSE If TRUE, a new frame will be created containing the accuracy
calculated at each grid node.
ACCURACY
PLOTOVERALL = <boolean> FALSE If TRUE, a new frame will be created containing the 1-norm and
max-norm of the estimated error for each solution zone plotted
ACCURACY versus grid resolution.
Example:Calculate the accuracy using zones 3, 4 and 5, along with data set variable 7, plotting the
overall accuracy:
$!EXTENDEDCOMMAND
COMMANDPROCESSORID = CFDAnalyzer3
COMMAND = ‘CALCULATEACCURACY ZONES=[3-5]
DATASETVAR=7
PLOTOVERALLACCURACY=TRUE’
DISPLAYBOUNDARIES
Syntax: $!EXTENDEDCOMMAND
COMMANDPROCESSORID = ‘CFDAnalyzer3’
COMMAND = ‘DISPLAYBOUNDARIES
[optional parameters]
[RAWDATA
<boundaryrawdata>]’
Description:Displays boundaries corresponding to a geometry and boundaries specification without actually
setting the geometry and boundaries. This macro is generally not useful for those writing macro
files, but is recorded when the user clicks the Display Boundaries button in the Geometry and
Boundaries dialog in order to duplicate the actions of Tecplot 360 that happen in response to that
action. See Section “SETGEOMETRYANDBOUNDARIES” on page 230 for a description of
the parameters for this macro.
EXTRACTFLOWFEATURE
Syntax: $!EXTENDEDCOMMAND
COMMANDPROCESSORID = CFDAnalyzer3
COMMAND = ‘EXTRACTFLOWFEATURE
[optional parameters]’
Description:Extract and display shock surfaces, vortex cores, or separation and attachment lines. Shock
surfaces are displayed as iso-surfaces of a new variable, ShockSurface, while vortex cores and
separation and attachment lines are displayed as new zones.
224
CFD Analyzer
Optional Parameters:
Parameter Syntax Default Notes
Feature = <flowfeature> SHOCKSURFACE Can be SHOCKSURFACES, VORTEXCORES, or SEPATTACHLINES.
S
VCOREMETHOD = <vcoremethod> EIGENMODES The vortex core extraction method. Can be VORTICITY or
EIGENMODES.
EXCLUDEBLANKED = <boolean> FALSE If TRUE, vortex cores and separation/attachment lines will not
be calculated in blanked regions.
$!EXTENDEDCOMMAND
COMMANDPROCESSORID = CFDAnalyzer3
COMMAND = ‘EXTRACTFLOWFEATURE
FEATURE = VORTEXCORES
VCOREMETHOD = EIGENMODES’
EXTRAPOLATESOLUTION
Syntax: $!EXTENDEDCOMMAND
COMMANDPROCESSORID = CFDAnalyzer3
COMMAND = ‘EXTRAPOLATESOLUTION ZONES = <set>
[MAXACCURACY = <double>]’
Description:Perform Richardson extrapolation to estimate the true solution from three input solutions on
grids of successively finer resolution. Two new zones are added to the current data set. The first
contains the extrapolated solution, while the second contains the estimated error.
Required Parameter:
Parameter Syntax Default Notes
ZONES = <set> Indicates the three zones from which to perform the accuracy
calculation.
Optional Parameter:
Parameter Syntax Default Notes
MAXACCURACY = <double> 2.0 The maximum theoretical accuracy of the solver which
generated the solution. Used to limit the calculated accuracy.
Example:Extrapolate zones 3, 4, and 5, which were calculated with a second order accurate solver:
$!EXTENDEDCOMMAND
COMMANDPROCESSORID = CFDAnalyzer3
COMMAND = ‘EXTRAPOLATESOLUTION ZONES=[3-5]
MAXACCURACY = 2
INTEGRATE
Syntax: $!EXTENDEDCOMMAND
COMMANDPROCESSORID = CFDAnalyzer3
COMMAND = ‘INTEGRATE [<set>] [optional parameters]’
Description:Perform an integration over the specified zones (or time strands, if INTEGRATEBY is set to
TIMESTRANDS). If <set> is not specified, the integration will be performed over all zones (or time
225
strands). If PLOTAS is set to TRUE, the integration results will be plotted in a new frame.
Optional Parameters:
Parameter Syntax Default Notes
VARIABLEOPTION = SCALAR
<variableoption>
XORIGIN = <double> 0.0 For VARIABLEOPTION = FORCESANDMOMENTS, indicates the origin
X-location for moment calculations.
YORIGIN = <double> 0.0 For VARIABLEOPTION = FORCESANDMOMENTS, indicates the origin
Y-location for moment calculations.
ZORIGIN = <double> 0.0 For VARIABLEOPTION = FORCESANDMOMENTS, indicates the origin
Z-location for moment calculations.
SCALARVAR = <integer> 1 For when VARIABLEOPTION = AVERAGE, MASSWEIGHTEDAVERAGE,
WEIGHTEDAVERAGE, MASSFLOWWEIGHTEDAVERAGE, or
VECTORAVERAGE. Indicates which variable’s average will be
calculated.
ABSOLUTE = <boolean> FALSE If TRUE, the absolute value of cell volumes will be used for
integration.
EXCLUDEBLANKED = <boolean> FALSE If TRUE, integration will only include non-blanked regions.
XVARIABLE = <integer> 0 Data set position of the scalar variable or X-component of the
vector variable to be integrated.
YVARIABLE = <integer> 0 Only required for vector integrations. Indicates the Y-
component of the vector variable to be integrated.
ZVARIABLE = <integer> 0 Only required for vector integrations. Indicates the Z-
component of the vector variable to be integrated.
INTEGRATEBY = ZONES Indicates whether the integration is performed by zones or by
<integratebyopti time strands.
on>
INTEGRATEOVER = CELLS Specifies cell volumes, planes, or lines.
<integrateovero
ption>
IRANGE
{
MIN = <integer> 1
MAX = <integer> 0
SKIP = <integer> 1
}
JRANGE
{
MIN = <integer> 1
MAX = <integer> 0
SKIP = <integer> 1
}
KRANGE
{
MIN = <integer> 1
MAX = <integer> 0
SKIP = <integer> 1
}
PLOTRESULTS = <boolean> FALSE Indicated whether the results of the integration will be plotted
in a Tecplot 360 frame.
PLOTAS = <string> Results The variable name used to plot integration results. If it contains
spaces, surround it with quotes preceded by a backslash (\’).
Ignored for forces and moments.
Range Parameters: The I-range, J-range and K-range parameters are used to limit the data
altered by the equation. The specification of range indices follow the rules below.
226
CFD Analyzer
You can access your integration results in macros through a variety of specific
environment variables. For a list of the variables and how to access them, refer to
Section 21 - 7.2 “Accessing Integration Results in Macros” in the User’s Manual
Examples:
Example 1:
The following command calculates the mass for all zones by integrating density (variable 4) over cell
volumes:
$!EXTENDEDCOMMAND
COMMANDPROCESSORID = CFDAnalyzer3
COMMAND = ‘INTEGRATE SCALARVAR = 4’
Example 2:
Calculate the mass flux across a series of I = constant planes for zones 1, 2, and 3 and plots the results
as “Mass Flux.” Since the COMMAND string is surrounded by single quotation marks (‘), the quotes sur-
rounding the PLOTAS parameter must be preceded by a backslash to avoid a syntax error:
$!EXTENDEDCOMMAND
COMMANDPROCESSORID = CFDAnalyzer3
COMMAND = ‘INTEGRATE [1-3] VARIABLEOPTION = MASSFLOWRATE INTEGRATEOVER =
IPLANES PLOTRESULTS = TRUE PLOTAS = \‘Mass Flux\’ ’
Example 3:
Calculate the “mass-weighted average” (actually the mass flow-weighted average) of total pressure,
variable 7:
$!EXTENDEDCOMMAND
COMMANDPROCESSORID = CFDAnalyzer3
COMMAND = ‘INTEGRATE [1-3] VARIABLEOPTION = MASSFLOWWEIGHTEDAVERAGE
SCALARVAR = 7 INTEGRATEOVER = IPLANES PLOTRESULTS = TRUE PLOTAS = \‘Mass
Weighted Avg Pt\’ ’
SAVEINTEGRATIONRESULTS
Syntax: $!EXTENDEDCOMMAND
COMMANDPROCESSORID = CFDAnalyzer3
COMMAND = ‘SAVEINTEGRATIONRESULTS
FILENAME = <string>’
Description: Saves the most recently calculated integration results to a text file.
227
Required parameter:
Parameter Syntax Notes
FILENAME = <string> Indicates the name of the file to which to save the results. It
may be a new or existing file.
Example:Save the most recent integration results to file E:\users\dave\results.txt. The backslash
characters (\) must be escaped with a second backslash character, and the file name is
surrounded by quotes (“):
$!EXTENDEDCOMMAND
COMMANDPROCESSORID = CFDAnalyzer3
COMMAND = ‘SAVEINTEGRATIONRESULTS
FILENAME = “E:\\users\\dave\\results.txt”’
SETFIELDVARIABLES
Syntax: $!EXTENDEDCOMMAND
COMMANDPROCESSORID = CFDAnalyzer3
COMMAND = ‘SETFIELDVARIABLES
[optional parameters]’
Description:Identifies variables in your data, such as velocity, pressure and temperature, for use in analysis.
Optional Parameters:
Parameter Syntax Default Notes
CONVECTIONVARSA = <boolean> TRUE Indicates whether the variables designated for Tecplot 360
REMOMENTUM vector plots are momentum variables (density * velocity). If
FALSE, then the vector variables must represent velocity values.
UVar = <integer> 0 Specify the variable (by number) to use for the first Vector/
Momentum variable.
VVar = <integer> 0 Specify the variable (by number) to use for the second Vector/
Momentum variable.
WVar = <integer> 0 Specify the variable (by number) to use for the second Vector/
Momentum variable.
ID1 = <varid> NOTUSED Identification of the first data set variable from which the
function will be calculated.
ID2 = <varid> NOTUSED Identification of the second data set variable from which the
function will be calculated.
VARIABLE1 = <integer> 0 Position of the first variable in the data set.
VARIABLE2 = <integer> 0 Position of the second variable in the data set.
SETFLUIDPROPERTIES
Syntax: $!EXTENDEDCOMMAND
COMMANDPROCESSORID = CFDAnalyzer3
COMMAND = ‘SETFLUIDPROPERTIES’ [optional parameters]
Description:Set the fluid properties for use by other commands.
228
CFD Analyzer
Optional Parameters:
Parameter Syntax Default Notes
INCOMPRESSIBLE = <boolean> FALSE If TRUE, indicates an incompressible fluid.
DENSITY = <double> 1.0 For INCOMPRESSIBLE = TRUE, indicates the density of the
fluid.
SPECIFICHEAT = <double> 2.5 For INCOMPRESSIBLE = TRUE. The value of the fluid’s
specific heat.
USESPECIFICHEAT = <boolean> FALSE For INCOMPRESSIBLE = TRUE.
VAR
SPECIFICHEATVAR = <integer> 1 For INCOMPRESSIBLE = TRUE and
USESPECIFICHEATVAR = TRUE. The data set variable that
holds the fluid’s specific heat.
GASCONSTANT = <double> 1.0 For INCOMPRESSIBLE = FALSE. The value of the fluid’s
specific gas constant.
USEGASCONSTANTV = <boolean> FALSE For INCOMPRESSIBLE = FALSE.
AR
GASCONSTANTVAR = <integer> 1 For INCOMPRESSIBLE = FALSE and
USEGASCONSTANTVAR = TRUE. The data set variable which
holds the fluid’s specific gas constant.
GAMMA = <double> 1.4 For INCOMPRESSIBLE = FALSE. The value of the fluid’s
ratio of specific heats. Must be between 1 and 5/3.
USEGAMMAVAR = <boolean> FALSE For INCOMPRESSIBLE = FALSE.
GAMMAVAR = <integer> 1 For INCOMPRESSIBLE = FALSE and USEGAMMAVAR =
TRUE. The data set variable that holds the fluid’s ratio of
specific heats.
VISCOSITY = <double> 1.0 The value of the fluid’s dynamic viscosity.
USEVISCOSITYVAR = <boolean> FALSE
VISCOSITYVAR = <integer> 1 For USEVISCOSITYVAR = TRUE. The data set variable which
holds the fluid’s dynamic viscosity.
CONDUCTIVITY = <double> 1.0 The value of the fluid’s conductivity.
USECONDUCTIVITY = <boolean> FALSE
VAR
CONDUCTIVITYVAR = <integer> 1 For USECONDUCTIVITYVAR = TRUE. The data set variable
which holds the fluid’s conductivity.
Example 1:Set the fluid properties to standard air values in meters/kilograms/seconds units:
$!EXTENDEDCOMMAND
COMMANDPROCESSORID = CFDAnalyzer3
COMMAND = ‘SETFLUIDPROPERTIES
GASCONSTANT=287
VISCOSITY=17.8E-6’
CONDUCTIVITY=2.48E-2
Example 2:Set the fluid properties to incompressible with density equal to 1.0 (the default) and
specific heat, viscosity and conductivity taken from data set variables 5, 6, and 7:
$!EXTENDEDCOMMAND
COMMANDPROCESSORID = CFDAnalyzer3
COMMAND = ‘SETFLUIDPROPERTIES
INCOMPRESSIBLE=TRUE
SPECIFICHEATOPTION=DATASETVAR
SPECIFICHEATVAR=5
VISCOSITYOPTION=DATASETVAR
VISCOSITYVAR=6’
CONDUCTIVITYOPTION=DATASETVAR
CONDUCTIVITYVAR=7
229
SETGEOMETRYANDBOUNDARIES
Syntax: $!EXTENDEDCOMMAND
COMMANDPROCESSORID = ‘CFDAnalyzer3’
COMMAND = ‘SETGEOMETRYANDBOUNDARIES
[optional parameters]’
[RAWDATA
<boundaryrawdata>]
Description:Specify whether the data represent an axisymmetric flow solution (2D Cartesian plots only),
whether adjacent zones should be considered to be connected at coincident faces, and specify zone
boundaries and their corresponding boundary conditions. Each line of the RAWDATA describes one
boundary, and appears in the same format as on the Geometry and Boundaries dialog. For all
boundaries, list the boundary condition and the set of zones, separated by a comma. The index
range-type boundary follows this with the boundary face, the first starting index, the first ending
index, the second starting index and the second ending index. All entries are separated by commas.
The boundary condition is one of INFLOW, OUTFLOW, WALL, SLIPWALL, SYMMETRY, EXTRAPOLATED. The
boundary face is one of I=1, I=IMAX, J=1, J=JMAX, K=1, and K=KMAX. Refer to Section 21 - 4 “Setting
Geometry and Boundary Options” in the User’s Manual for more information on boundaries.
Optional Parameters:
Parameter Syntax Default Notes
AXISYMMETRIC = <boolean> FALSE Can only be TRUE if the current plot type is 2D Cartesian. If
TRUE, indicates that the data represents an axisymmetric
solution.
SYMMETRYVAR = <XorY> Y For AXISYMMETRIC = TRUE. Can be X or Y. Indicates which
axis variable is constant along the axis of symmetry.
SYMMETRYVALUE = <double> 0.0 For AXISYMMETRIC = TRUE. Indicates the value of the
SYMMETRYVAR along the axis of symmetry.
CONNECTZONES = <boolean> TRUE If TRUE, indicates that adjacent zones should be connected
where boundary faces coincide.
NODETOLERANCE = <double> 1.0E-6 Indicates how close two nodes must be before they will be
considered coincident for the purpose of matching zone faces.
DEFAULTBC = <string> EXTRAPOLATED Indicates the boundary condition that will be applied to all
zone boundary faces not connected to adjacent zones or
covered by zone boundaries defined by the RAWDATA section.
Example:Specify that the solution data represents an axisymmetric solution about X = 1. Do not
allow adjacent zones to be connected. Identify two zone-type boundaries and one zone, face
and index-range-type boundary:
$!EXTENDEDCOMMAND
COMMANDPROCESSORID = ‘CFDAnalyzer3’
COMMAND = ‘SETGEOMETRYANDBOUNDARIES
AXISYMMETRIC = TRUE
SYMMETRYVAR = X
SYMMETRYVALUE = 1
CONNECTZONES = FALSE’
RAWDATA
WALL,[2-3]
INFLOW,[4]
OUTFLOW,[1],I=IMAX,1,10,1,20
SETREFERENCEVALUES
Syntax: $!EXTENDEDCOMMAND
COMMANDPROCESSORID = CFDAnalyzer3
230
CFD Analyzer
COMMAND = ‘SETREFERENCEVALUES
[optional parameters]’
Description:Specify the reference (free-stream) properties of the solution, identify two variables in the
current data set for use with other commands.
Optional Parameters:
Parameter Syntax Default Notes
RVELOCITY1ID = <string> MACHNUMBER Identification of the first free-stream velocity component. May
be UVELOCITY or
MACHNUMBER.
RVELOCITY1 = <double> 0.0 The value of the first free-stream velocity component.
RVELOCITY2ID = <string> ANGLEOFATTAC Identification of the second free-stream velocity component.
K May be VVELOCITY or
ANGLEOFATTACK.
RVELOCITY2 = <double> 0.0 The value of the second free-stream velocity component.
NOTE: RVELOCITY1 must be defined before using
RVELOCITY2.
RTHERMO1ID = <string> DENSITY Identification of the first free-stream thermodynamic variable.
May be PRESSURE or
DENSITY.
RTHERMO1 = <double> 1.0 The value of the first free-stream thermodynamic variable.
RTHERMO2ID = <string> SPEEDOFSOUND Identification of the second free-stream thermodynamic
variable. May be TEMPERATURE or SPEEDOFSOUND.
RTHERMO2 = <double> 1.0 The value of the second free-stream thermodynamic variable.
SETUNSTEADYFLOWOPTIONS
Syntax: $!EXTENDEDCOMMAND
COMMANDPROCESSORID = ‘CFDANALYZER3’
COMMAND = ‘SETUNSTEADYFLOWOPTIONS
[SteadyState=<boolean>]
[RAWDATA
<timelevelrawdata>]’
Description: Identifies time levels for unsteady flow, or specifies that the solution is steady-state. If the flow
is unsteady, the solution time levels are specified in the RAWDATA section. The first line of the
RAWDATA section must consist of a single integer indicating the number of solution time levels. This
must be followed by the time levels themselves. Each time level must be on a separate line and
must consist of a floating-point number (the solution time), as well as one or more integers (the
zone numbers for that solution time).
Optional Parameters:
Parameter Syntax Default Notes
STEADYSTATE = <boolean> TRUE If TRUE, indicates that the solution is steady-state, and the
RAWDATA, if any, is ignored. If FALSE, indicates that the
solution is unsteady, with time levels identified in the
RAWDATA section.
Example:The unsteady solution contains three solution time levels of two zones each, representing
solution times 0.5, 1.0 and 1.5:
$!EXTENDEDCOMMAND
COMMANDPROCESSORID = CFDAnalyzer3
COMMAND = ‘SETUNSTEADYFLOWOPTIONS
STEADYSTATE = FALSE’
RAWDATA
231
3
.5 1 2
1.0 3 4
1.5 5 6
10 - 2 Extend Macro
The Extend Macro COMMANDPROCESSORID is extendmcr. The commands supported by the add-on are listed in
the following table
When specifying a macro variable name in an Extend Macro command, you should not
surround the variable name with vertical bars. For example, ZONENUM rather than
|ZONENUM|.
232
Extend Macro
Command Notes
QUERY.ZONENAMEBYNUM nnn VVV Get the string for zone nnn and assign to variable VVV.
233
For example:
QUERY.DATASETTITLE
The following example, uses the QUERY.DATASETITLE command to place the title of the dataset at a
specific position on the plot.
$!EXTENDEDCOMMAND COMMANDPROCESSORID='extendmcr'
COMMAND='QUERY.DATASETTITLE ZNUM'
$!ATTACHTEXT
XYPOS
{
X = 5
Y = 90
}
TEXT = "Title is: |ZNUM|"
QUERY.VARNAMEBYNUM
The following example uses QUERY.VARNAMEBYNUM to place the name of variable 2 at a specific
position on the plot.
$!ATTACHTEXT
XYPOS
{
X = 5
Y = 85
}
TEXT = "Var 2 is: |VNAME|"
QUERY.ZONENAMEBYNUM
The following example uses QUERY.ZONENAMEBYNUM to place the title of Zone 1 at a specific position
on the plot.QUERY.ACTIVEZONES
$!ATTACHTEXT
XYPOS
{
X = 5
Y = 80
234
Extend Macro
}
TEXT = "Zone is: |ZNAME|"
The follow example uses QUERY.ACTIVEZONES to display a list of the active zones.
$!EXTENDEDCOMMAND COMMANDPROCESSORID='extendmcr'
COMMAND='QUERY.ACTIVEZONES ZNUMS'
$!ATTACHTEXT
XYPOS
{
X = 5
Y = 70
}
TEXT = "Active zones are: |ZNUMS|"
235
236
11
Parameter Subcommands
This chapter details secondary or common macro parameter subcommands in Tecplot 360. These
subcommands provide a means to access the lower level variables of commands defined in the previous
chapter of this manual. Each subcommand can expand to contain one or more parameters or
subcommands. All parameters within a subcommand are optional.
Items within single angle brackets (< >) are defined in 12.
<<anchorpos>>
Expands to:
Parameter Syntax Default Notes
{
X = <double> Sets X-value (and THETA-value)
Y = <double> Sets Y-value (and R-value)
Z = <double> Sets Z-value
THETA = <double> Sets THETA-value (and X-value)
R = <double> Sets R-value (and Y-value)
}
Example:
Make a square geometry and place it at a certain XY location:
$!ATTACHGEOM
GEOMTYPE = SQUARE
POSITIONCOORDSYS = FRAME
ANCHORPOS
{
X = 2.89124668435
237
Y = 88.7359084881
}
RAWDATA
5.23430593312
<<areastyle>>
Example:Turn on the grid area border for a 2D plot and change the line thickness to be 2 percent:
$!TWODAXIS
AREASTYLE
{
DRAWBORDER = YES
LINETHICKNESS = 2
}
<<axisdetail>>
238
Expands to:
Parameter Syntax Default Notes
{
SHOWAXIS = <boolean>
AUTOGRID = <boolean>
ISREVERSED = <boolean>
GRANCHOR = <double>
GRSPACING = <double>
RANGEMIN = <double>
RANGEMAX = <double>
COORDSCALE = <coordscale> XY and Polar Line plots only.
CLIPDATA = <boolean>
VALUEATORIGIN = <double>
VARNUM = <integer> Available for 2D and 3D plot types only. Refer to
“$!LINEMAP” on page 152 for information on referencing
variable number for XY and Polar Line plots.
TICKLABEL <<ticklabeldetail>
>
GRIDLINES <<gridlinedetail>
>
MINORGRIDLINES <<gridlinedetail>
>
MARKERGRIDLINE <<gridlinedetail>
>
TICKS <<ticklabeldetail>
>
TITLE <<axistitle>>
AXISLINE <<axisline>>
}
Example:Turn on the axis line, reverse the axis direction, and set the range to go from 0.5 to 1.5 for
the X-axis in a 2D plot:
$!TWODAXIS
SHOWAXISLINE = TRUE
XDETAIL
{
ISREVERSED = TRUE
RANGEMIN = 0.5
RANGEMAX = 1.5
}
<<axisline>>
239
Expands to:
Parameter Syntax Default Notes
{
SHOW = <boolean>
SHOWBOTHDIRECTIONS = <boolean> FALSE Non-3D only.
SHOWPERPENDICULAR = <boolean> FALSE Non-3D only.
SHOWOPPOSITEEDGE = <boolean> FALSE 3D only
COLOR = <color>
LINETHICKNESS = <double>
ALIGNMENT <axisalignment>
OPPOSINGAXISVALUE = <double>
POSITION = <double>
ANGLE = <double>
OFFSET = <double>
EDGE = <integer>
}
Example:Change the thickness of the Theta-axis line to 0.8 and the color to red.:
<<axistitle>>
Example:Create a R-axis title, saying “Harmonic Motion” in red, times, size 6 font.:
240
$!POLARAXIS RDETAIL{TITLE{TEXTSHAPE{FONTFAMILY = “Times”}}}
$!POLARAXIS RDETAIL{TITLE{TEXTSHAPE{ISBOLD = NO}}}
$!POLARAXIS RDETAIL{TITLE{TEXTSHAPE{ISITALIC = NO}}}
$!POLARAXIS RDETAIL{TITLE{TEXTSHAPE{HEIGHT = 6}}}
<<basiccolorcontrol>>
Expands to:
Parameter Syntax Default Notes
{
NAME = <string> ‘’ May include dynamic text variables
SHOW = <boolean> YES Controls visibility of the basic color in a basic color legend.
}
Example:Hide Red from the basic color legend; if Blue is employed in the plot, label it “Water”:
$!BASICCOLORLEGEND
BASICCOLORCONTROL
{
RED
{
SHOW = NO
}
BLUE
{
SHOW = YES
NAME = “Water”
}
}
<<basicsizelist>>
Description:Assign basic sizes. The units for the values assigned here are dependent on the parent command.
Assignments here do not affect the plot. These assignments are used only to configure drop-down
menus in the interface so the user can make quick selections.
Expands to:
Parameter Syntax Default Notes
{
TINY <op> <dexp>
SMALL <op> <dexp>
MEDIUM <op> <dexp>
LARGE <op> <dexp>
HUGE <op> <dexp>
}
Example:Change the medium line pattern length for drop-down menus in the interface to be five
percent:
$!BASICSIZE
LINEPATLENGTHS
{
241
MEDIUM = 5
}
<<colormapcontrolpoints>>
Description:All contour color maps except the Raw user-defined color map make use of control points to
determine the color distribution. Each control point has a position and a left and right color. The
<<colormapcontrolpoints>> subcommand can contain more than one CONTROLPOINT subcommand.
Expands to:
Parameter Syntax Default Notes
{
CONTROLPOINT <integer> Use <integer> to specify which control point to modify.
{
COLORMAPFRACTION = <dexp> Positions the control point; 0 sets the position to the lowest
index and 1 to the highest index in the color map.
LEADRGB <<rgb>>
TRAILRGB <<rgb>>
}
}
<<colormapoverride>>
Description:Change settings for a color map override. Color map overrides are used to replace a specific
band in a contour color map with one of the 16 basic colors.
Expands to:
Parameter Syntax Default Notes
{
INCLUDE = <boolean>
COLOR = <color>
STARTLEVEL <op> <integer>
ENDLEVEL <op> <integer>
}
Example:Set the color used between contour level number 1 to number 3 to be purple. Use color
map override number 3:
$!GLOBALCONTOUR
COLORMAPFILTER
{
COLORMAPOVERRIDEACTIVE = YES
COLORMAPOVERRIDE 3
{
INCLUDE = YES
COLOR = PURPLE
STARTLEVEL = 1
ENDLEVEL = 3
}
}
242
<<continuouscolor>>
Expands to:
Parameter Syntax Default Notes
CMIN = <double>
CMAX = <double>
$!GLOBALCONTOUR VAR = 4
$!FIELDLAYERS SHOWCONTOUR = YES
$!GLOBALCONTOUR COLORMAPFILTER
{COLORMAPDISTRIBUTION = CONTINUOUS}
$!GLOBALCONTOUR COLORMAPFILTER
{
CONTINUOUSCOLOR
{
CMIN = 0.5
CMAX = 2
}
}
<<dialogplacement>>
243
Expands to:
Parameter Syntax Default Notes
{
ANCHORALIGNMENT =
<anchoralignme
nt>
ANCHORHORIZONTAL = <boolean> ANCHORHORIZONTALINSIDE and
INSIDE ANCHORVERTICALINSIDE control how the dialog window
is anchored in both the horizontal and vertical directions
ANCHORVERTICALIN = <boolean> relative to the Tecplot 360 main window.
SIDE
MINVISIBILITYPER = <integer> The MINVISIBILITYPERCENTAGE specifies the minimum
CENTAGE percentage of the dialog, between 1 and 100, that must be
visible within the desktop. This prevents a dialog from being
placed outside of the visible desktop. Note that not all window
managers allow dialogs to be placed so that the portions of the
dialog are not visible and in effect enforce a value of 100.
IOFFSET = <integer> IOFFSET and JOFFSET are in pixels. They may be negative, but
will be truncated to the bounding rectangle of the Tecplot 360
JOFFSET = <integer>
main window.
POSITIONATANCHOR = POSITIONATANCHOR specifies when to place it at the
<positionatanch anchor, NEVER, ONCE (initial launch), or ALWAYS.
or>
}
Example:Set the position of the Colormap dialog to always launch 10 pixels from Tecplot 360’s
bottom-right corner:
$!INTERFACE
DIALOGPLACEMENT
{
COLORMAPDIALOG
{
ANCHORALIGNMENT = BOTTOMRIGHT
IOFFSET = 100
JOFFSET = 100
POSITIONATANCHOR = ALWAYS
}
}
<<gridarea>>
244
Expands to:
Parameter Syntax Default Notes
{
DRAWBORDER = <boolean> Not available in 3D.
LINETHICKNESS <op> <dexp>
COLOR = <color> Not available for 3D or Polar Line.
ISFILLED = <boolean>
FILLCOLOR = <color>
USELIGHTSOURCETO = <boolean> Only available for 3D.
FILL
LABELSALLSIDES = <boolean>
TICKSALLSIDES = <boolean>
EXTENTS <<rect>> Not available in 3D.
}
Example:Turn on the grid area border for a 2D plot and change the line thickness to be 2 percent:
$!TWODAXIS
GRIDAREA
{
DRAWBORDER = YES
LINETHICKNESS = 2
}
<<gridlinedetail>>
Expands to:
Parameter Syntax Default Notes
{
COLOR = <color>
SHOW = <boolean>
LINEPATTERN = <linepattern>
PATTERNLENGTH <op> <dexp>
LINETHICKNESS <op> <dexp>
CUTOFF = <double> Theta only.
DRAWGRIDLAST = <boolean> Drawing last places the grid at the front of the plot; drawing
first places it in the back
POSITIONMARKERBY = <markerpos> Marker gridline only
CONSTANTVALUE = <double> Marker gridline only; valid only when POSITIONMARKERBY
is CONSTANT
}
Example:Set the line pattern for minor gridlines for the X-axis in a 3D plot to be dashed:
$!THREEDAXIS
XDETAIL
{
MINORGRIDLINES
{
LINEPATTERN = DASHED
245
}
}
<<ijk>>
Example:Set the I- and J-index skip for vectors to 2 for all zones:
$!FIELDMAP
VECTOR
{
IJKSKIP
{
I = 2
J = 2
}
}
<<indexrange>>
Expands to:
Parameter Syntax Default Notes
{
MIN <op> <integer>
MAX <op> <integer>
SKIP <op> <integer>
}
Example:Change the plot so the data set shows I-planes 3, 5, and 7 for zones 1 to 3:
$!FIELDMAP [1-3]
SURFACES
{
SURFACESTOPLOT = IPLANES
IRANGE
{
MIN = 3
MAX = 7
SKIP = 2
246
}
}
<<numberformat>>
Expands to:
Parameter Syntax Default Notes
{
FORMATTING = <valueformat>
CUSTOMLABEL = <integer>
DYNAMICLABELNAME = <string> Name of the dynamic label generator to use when
“Formatting” is set to “DynamicLabel”
PRECISION <op> <integer>
SHOWDECIMALSONWH = <boolean> FALSE
OLENUMBERS
REMOVELEADING = <boolean> FALSE
ZEROS
SHOWNEGATIVESIGN = <boolean> TRUE
POSITIVEPREFIX = <string>
POSITIVESUFFIX = <string>
NEGATIVEPREFIX = <string>
NEGATIVESUFFIX = <string>
TIMEDATEFORMAT = <string>
ZEROPREFIX = <string>
ZEROSUFFIX = <string>
}
Example:Set the number format for axis labels on the X-axis in a 2D field plot to use the “float”
format with a precision of 3, and add the phrase “DAYS WITHOUT RAIN” after every
positive value:
$!TWODAXIS
XDETAIL
{
TICKLABEL
{
NUMFORMAT
{
FORMATTING = FIXEDFLOAT
PRECISION = 3
POSITIVESUFFIX = “DAYS WITHOUT RAIN”
}
}
}
Example: Set the number format for axis labels on the X-axis in a 2D field plot to use the
Time/Date format. Add the time and date in format
247
<<papersize>>
Description:Change dimensions or hardclip offsets for LETTER, DOUBLE, A3, A4, CUSTOM1 and CUSTOM2
paper sizes.
Expands to:
Parameter Syntax Default Notes
{ All values are in inches.
WIDTH <op> <dexp>
HEIGHT <op> <dexp>
LEFTHARDCLIPOFFSET <op> <dexp>
RIGHTHARDCLIPOFFSET <op> <dexp>
TOPHARDCLIPOFFSET <op> <dexp>
BOTTOMHARDCLIPOFFSET <op> <dexp>
}
Example:Change the left hardclip offset for LETTER size paper to be 0.25 inches:
$!PAGE
PAPERSIZEINFO
{
LETTER
{
LEFTHARDCLIPOFFSET = 0.25
}
<<precisegrid>>
Expands to:
Parameter Syntax Default Notes
{
INCLUDE = <boolean>
COLOR = <color>
SIZE = <double> Size is in centimeters.
}
$!XYAXIS
PRECISEGRID
{
INCLUDE = YES
}
<<rect>>
Description:Change settings for a rectangle. The rectangle is defined using two points (X1,Y1) and (X2,Y2).
248
Expands to:
Parameter Syntax Default Notes
{ Units are based on the parent command.
X1 <op> <dexp>
Y1 <op> <dexp>
X2 <op> <dexp>
Y2 <op> <dexp>
}
Example:Set the 2D axis grid area to be positioned 10 percent from all edges of the frame:
$!TWODAXIS
AREASTYLE
{
EXTENTS
{
X1 = 10
Y1 = 10
X2 = 90
Y2 = 90
}
}
<<refscatsymbol>>
Expands to:
Parameter Syntax Default Notes
{
SHOW = <boolean>
COLOR = <color>
LINETHICKNESS = <dexp>
ISFILLED = <boolean>
FILLCOLOR = <color>
MAGNITUDE = <dexp>
XYPOS <<xyz>>
SYMBOLSHAPE <<symbolshape>>
}
$!GLOBALSCATTER
REFSCATSYMBOL
{
FILLCOLOR = GREEN
}
249
<<renderconfig>>
Expands to:
Parameter Syntax Default Notes
{
POLYGONOFFSET = <double>
EXTBIASFACTOR
STIPPLEALLLINES = <stipplemode> If thin patterned lines are not drawn correctly, set
STIPPLEALLLINES to ALL.
DEPTHBUFFERSIZE = <integer> For low memory graphics cards, the depth buffer size may
need to be reduced.
MINBITSPERRGB = <integer> Specify the minimum number of bits used for each of the
PLANE planes in the image buffer.
DOEXTRADRAWFOR = <boolean> Sometimes the last pixel for stroked font characters is not
LASTPIXEL drawn If so, turn DOEXTRADRAWFORLASTPIXEL on.
MAXMULTISAMPLES = <integer> Sets the number of multisamples used for antialiasing. Default:
4 for screen, 0 for offscreen.
MAXSTRIPLENGTH = <integer> Some graphics cards have problems with long strips. Use
MAXSTRIPLENGTH to reduce the strip length.
MAXPRIMATIVESPER = <integer> Some graphics cards have problems with large numbers of
BLOCK graphics primitives in a single block. Use
MAXPRIMATIVESPERBLOCK to reduce the number of
primitives delivered to the graphics hardware in a single block.
CONSTANTLYUSE = <boolean> Turn ConstantlyUseScissoring on if you see lines extending
SCISSORING outside the borders of the frame. There is a slight performance
penalty when using this option.
USEQUADSTRIPS = <boolean> If some shaded or contour flooded quads or triangles do not
appear or are black, try turning this off.
USETRIANGLE = <boolean> As with USEQUADSTRIPS, try turning off USEQUADSTRIPS
STRIPS before turning USETRIANGLESTIPS off. Turning off both
options will result in reduced performance, but may help fix
errors caused by buggy graphics card drivers.
TRIANGULATE = <boolean> As with USEQUADSTRIPS, try turning on
FILLEDPOLYGONS TRIANGULATEFILLEDPOLYGONS if you are still
experiencing problems even after turning off
USETRIANGLESTRIPS and USEQUADSTRIPS.
USEGLCOLOR = <boolean> Some graphics cards have problems with an OpenGL’s
MATERIALFUNCTION glColorMaterial function. Higher performance (especially
for continuous contour flooded plots) can be achieved when it
is used. However, it may need to be turned off if you are
experiencing problems.
MAXTEXTURESIZE = <integer>
FORCESMOOTHSHADI = <boolean>
NGFORLIGHTING
ADJUSTRECTANGLE = <boolean>
RIGHTANDBOTTOM
}
Example:Force all line drawing to include the last point in the line. Also, make the size of the depth
buffer to be at least 32 bits.
$!INTERFACE
OPENGLCONFIG
{
SCREENRENDERING
{
DOEXTRADRAWFORLASTPIXEL = TRUE
DEPTHBUFFERSIZE = 32
250
}
}
<<rgb>>
Description:Set a color value by assigning values to its red, green, and blue components.
Expands to:
Parameter Syntax Default Notes
{
R <op> <integer>
G <op> <integer>
B <op> <integer>
}
$!BASICCOLOR
CUSTOM 3
{
R = 80
G = 255
B = 80
}
<<shademap>>
Description:Map colors on the screen to shades of gray for monochrome hardcopy output.
251
Expands to:
Parameter Syntax Default Notes
{ Shade values can range from 0 (black) to 100 (white).
BLACKSHADE = <dexp>
REDSHADE = <dexp>
GREENSHADE = <dexp>
BLUESHADE = <dexp>
CYANSHADE = <dexp>
YELLOWSHADE = <dexp>
PURPLESHADE = <dexp>
WHITESHADE = <dexp>
CUSTOM1SHADE = <dexp>
CUSTOM2SHADE = <dexp>
CUSTOM3SHADE = <dexp>
CUSTOM4SHADE = <dexp>
CUSTOM5SHADE = <dexp>
CUSTOM6SHADE = <dexp>
CUSTOM7SHADE = <dexp>
CUSTOM8SHADE = <dexp>
}
$!PRINTSETUP
MONOFLOODMAP
{
BLUESHADE = 50
}
<<symbolshape>>
Description:Set a symbol shape. Symbols can be a geometric shape (circle, square, and so forth) or an ASCII
character.
252
Expands to:
Parameter Syntax Default Notes
{
ISASCII = <boolean>
ASCIISHAPE
{
USEBASEFONT = <boolean>
FONTOVERRIDE = <font>
ASCIICHAR = <string>
}
GEOMSHAPE = <geomshape>
}
Example:Change the symbol shape for symbols drawn with line map 3 to use circles:
$!LINEMAP[3]
SYMBOLS
{
SYMBOLSHAPE
{
ISASCII = FALSE
GEOMSHAPE = CIRCLE
}
}
<<textbox>>
Expands to:
Parameter Syntax Default Notes
{
BOXTYPE = <textboxtype>
MARGIN <op> <dexp>
LINETHICKNESS <op> <dexp>
COLOR = <color>
FILLCOLOR = <color>
}
<<textshape>>
253
Expands to:
Parameter Syntax Default Notes
{
FONTFAMILY = <string>
ISBOLD = <boolean>
ISITALIC = <boolean>
SIZEUNITS = <sizeunits>
HEIGHT <op> <dexp>
}
Example:Add a text label in the center of the frame using Times Roman font. Make the text height
12 point. Include a box around the text with a line thickness of one percent:
$!ATTACHTEXT
XYPOS {
X = 50
Y = 50
}
TEXTSHAPE
{
FONTMFFAMILY = “Times”
ISBOLD = NO
ISITALIC = NO
}
BOX
{
BOXTYPE = HOLLOW
LINETHICKNESS = 1
}
TEXT = ’Hi Mom’
<<ticklabeldetail>>
Description:Change settings for the text used to label axis tick marks.
254
Expands to:
Parameter Syntax Default Notes
{
SHOWONAXISLINE = <boolean> TRUE
SHOWONGRIDBORDERMIN = <boolean> FALSE Non-3D only.
SHOWONGRIDBORDERMAX = <boolean> FALSE Non-3D only.
SHOWONOPPOSITEEDGE = <boolean> FALSE 3D only.
SHOWONALLAXES = <boolean> TRUE Polar R only.
SHOWATAXISINTER = <boolean>
SECTION
SKIP = <integer>
ERASEBEHINDLABELS = <boolean>
NUMFORMAT <<numberformat>>
TEXTSHAPE <<textshape>> Not allowed to change size units
parameter.
OFFSET <op> <dexp>
LABELALIGNMENT = <labelalignment>
ANGLE <op> <dexp>
COLOR = <color>
}
Example:Change the color for X-axis tick mark labels in a 2D plot to be red:
$!TWODAXIS
XDETAIL
{
TICKLABEL
{
COLOR = RED
}
}
<<tickmarkdetail>>
255
Expands to:
Parameter Syntax Default Notes
{
SHOWONAXISLINE = <boolean> TRUE
SHOWONGRIDBORDERMIN = <boolean> FALSE Non-3D only.
SHOWONGRIDBORDERMAX = <boolean> FALSE Non-3D only.
SHOWONOPPOSITEEDGE = <boolean> FALSE 3D only.
SHOWONALLAXES = <boolean> TRUE Polar R only.
TICKDIRECTION = <tickdirection>
LENGTH <op> <dexp>
LINETHICKNESS <op> <dexp>
NUMMINORTICKS = <integer>
MINORLENGTH = <double>
MINORLINETHICKNESS = <double>
}
Example:Set the tick mark length to 2 percent for the second Y-axis in an XY-plot:
$!XYLINEAXIS
YDETAIL 2
{
TICKS
{
LENGTH = 2
SHOWONGRIDBORDERMIN = TRUE
}
}
<<volumeobjectstoplot>>
Expands to:
Parameter Syntax Default Notes
{
SHOWISOSURFACES = <boolean>
SHOWSLICES = <boolean>
SHOWSTREAMTRACES = <boolean>
}
Example:
$!FIELD
VOLUMEMODE
{
VOLUMEOBJECTSTOPLOT
{
SHOWISOSURFACES = NO
SHOWSLICES = YES
SHOWSTREAMTRACES = YES
}
}
256
<<xy>>
Expands to:
Parameter Syntax Default Notes
{
X <op> <dexp>
Y <op> <dexp>
}
<<xyz>>
Expands to:
Parameter Syntax Default Notes
{
X <op> <dexp>
Y <op> <dexp>
Z <op> <dexp>
}
$!GLOBALTHREED
AXISSCALEFACT
{
Z = 0.5
}
<<zebrashade>>
257
Expands to:
Parameter Syntax Default Notes
{
INCLUDE = <boolean>
ISTRANSPARENT = <boolean>
COLOR = <color>
}
Example:Turn on zebra shading and make the zebra shade color to be black:
$!GLOBALCONTOUR
COLORMAPFILTER
{
ZEBRA
{
INCLUDE = TRUE
COLOR = BLACK
}
}
258
12
Parameter Assignment Values,
Expressions, and Operators
ATBOTHENDS
WITHGRIDMIN WITHGRIDAREABOTTOM
WITHGRIDMAX WITHGRIDAREARIGHT.
WITHGRIDAREATOP WITHGRIDAREALEFT
WITHOPPOSINGAXISVALUE
259
Value Identifier Allowable Values
<boolean> YES NO
TRUE FALSE
ON OFF
RAWUSERDEF
RESETTOFACTORY
DELETENEAREST RESET
PRIMARYVALUE BOTHLINESANDFLOOD
EXTENDED POLYNOMIALFIT
260
Assignment Value Table
ATPOINTB2
CREATE1DLINE CREATECIRCULARZONE
CREATERECTANGULARZONE
CREATEZONEFROMPOLYLINES
CREATEZONEFROMVALUES
EXTRAEXTRACTDISCRETEPOINTS EXTRACTFEBOUNDAR
Y
EXTRACTISOSURFACES
EXTRACTPOINTSFROMGEOMETRY
EXTRACTPOINTSFROMPOLYLINE
EXTRACTSLICEFROMPLANE
EXTRACTSLICES EXTRACTSTREAMTRACES
EXTRACTSUBZONE EXTRACTCONTOURLINES
IJKBLANKING IMPORT LIGHTSOURCE
INVERSEDISTANCEINTERPOLATION
LINEARINTERPOLATION KRIGINGINTERPOLATION
LINEMAPLEGEND LOADDATA MACROPLAY
PAPERSETUP PERFORMANCEb
POLARDRAWINGOPTIONS PRINT
PROBEAT PROBE QUICKEDIT
RGBCOLORVARSANDRANGE ROTATE2DDATA
SCATTERLEGEND SCATTERSIZEANDFONT
SCATTERREFERENCESYMBOL SLICES
STYLELINKING THREEDAXISLIMITS
THREEDVIEWDETAILS THREEDORIENTATIONAXIS
THREEDVIEWROTATE TRANSFORMCOORDINATES
261
Value Identifier Allowable Values
VALUEBLANKING VECTORLENGTH
VECTORARROWHEADS VECTORREFERENCEVECTOR
BOTH
FRAME
<errorbartype> UP DOWN
LEFT RIGHT
VERT. HORZ
CROSS
XWINDOWS PSIMAGE PS
MPEG4 WMV
<expression> See Figure 12 - 2.
USELINECOLOR USESPECIFICCOLOR
MATH USERDEF
POPATPOSITION PUSHTOP
SKETCH
THETAINDEPENDENDT
262
Assignment Value Table
SPHERE POINT
LINESEGS3D
<ijkplane> I J K
<integer> Integer constants or variables containing an integer. Expressions that logically result
in integer are not currently supported.
THREESPECIFICVALUES ONESPECIFICVALUE
PERPENDICULARTOAXIS
<labeltype> INDEX VARVALUE XANDYVARVALUEc
<macrofunctionvar> |<integer>|
263
Value Identifier Allowable Values
<macrointrinsic> AXISMAXX AXISMAXY AXISMAXZ
<macrointrinsicvar> |<macrointrinsic>|
<macrouserdefvar> |<charactersequence>|
TRANSLATEDATA TRANSLATEPAPER
ROLLERBALLROTATE TWISTROTATE
LEFTJUSTIFY RIGHTJUSTIFY
<op> = -= +=
*= /=
264
Assignment Value Table
THIRTYSIXPOINTS FIFTYPOINTS
TWOCENTIMETERS SEVENTYTWOPOINTS
A3 CUSTOM1 CUSTOM2
<pickaction> ADD ADDALL ADDALLINREGION
SHIFT
<placementplaneorientation> X Y Z
ALLFRAMESALWAYSAPPROX
POLARLINE SKETCH
UPPERLEFT UPPERRIGHT
<printerdriver> PS EPS
<printrendertype> VECTOR IMAGE
GAUSSIANFILTER
265
Value Identifier Allowable Values
<rgblegendorientation> RGB GBR BRG
SPECIFYGB
<rotateaxis> X Y Z
VERTROLLERBALL
<rotateoriginlocation> VIEWER DEFINEDORIGIN
COLOREDPANELED
<sidebarsizing> MAXOFALL DYNAMIC
SURFACESOFVOLUMEZONES
ARBITRARY
BYINDEPENDENTVAR
SPECIFYGB
GRAYSCALE TWOCOLOR
SURFACESOFSELECTEDOBJECTS
VOLUMEROD TWODLINE
<string> "<charactersequence>" '<charactersequence>'d
266
Assignment Value Table
REMOVE
EXPOSEDCELLFACES NONE
<textanchor> LEFT CENTER RIGHT
RECTTOSPHERICAL
LESSTHAN EQUALTO
GREATERTHANOREQUAL
CUSTOMLABEL TIMEDATE
HEADONLY
PASTE PUSH
TRIANGULAR
267
Value Identifier Allowable Values
<workspaceviewmode> FITSELECTEDFRAMES FITALLFRAMES FITPAPER
TRANSLATE
a. In order to color an object using one of the contour variable groups (i.e. assigning the color
to MULTI1, MULTI2, etc.), you must first set the contour variable via the $!GLOBALCONTOUR
command.
b. The performance dialog cannot be launched or dropped via the macro language on Windows
platforms.
c. Available in XY-plots only
d. The only difference in using single quotes vs. double quotes for strings is that single quotes pre-
vent the processing of the backslash character “\” (that is \n inserts a newline \\ inserts the
backslash itself).
268
Assignment Value Expressions
PI p.
RAD Radians per degree.
The following table shows the operator precedence and associativity for assignment value expressions.
Operators with higher precedence are listed in the higher rows of the table, while operators that are in the
same row have the same precedence. The associativity describes how an operator associates with its
operand.
Operator Type Operators Associativity
Expression ()
Left to right.
Power ^ **
Right to left.
Unary -+!
Right to left.
Multiplicative */
Left to right.
Additive +-
Left to right.
Logical OR ||
Left to right.
Conditional ?:
Right to left.
Unlike C, relational expressions do not evaluate to 0 or 1, instead, they evaluate to true or false. As such,
they may only be used with other logical operators, or with the conditional operator.
Examples of common expressions used in the Tecplot 360 macro language follow (note that all expressions
evaluate to a simple, <dexp>, value):
In addition to the more common operators mentioned above, some relational and logical operators are
269
conjunction with the conditional operator (? and :) to form compound expressions. The conditional
operator (? and :) has the following syntax:
<relation> ? <expression if true> : <expression if false>
where:
• <relation> is a conditional statement that evaluates to true or false, and is formed by any two
subexpressions which are compared to one another with one of the relational operators (>, >=,
<, <=, ==, !=) in combination with zero or more of the logical operators: logical Not (!), logical
And (&&), and logical Or (||).
• <expression if true> is the <expression> that is evaluated if the <relation> condition evaluates to
TRUE.
• <expression if false> is the <expression> that is evaluated if the <relation> condition evaluates to
FALSE.
Examples of compound expressions used in the Tecplot 360 macro language follow (note that all
compound expressions evaluate to a simple, <dexp>, value):
270
13
Raw Data
Some macro commands contain a “raw data” section. A raw data section is defined by using the keyword
RAWDATA followed by the raw data values unique to the macro command. Most raw data sections start with
a single count value which represents the number of blocks of raw data followed by the blocks of raw data
themselves. The following table lists the raw data sections found in Tecplot 360 macros.
<extendedcommandrawdata> <string> Each line of the RAWDATA section contains an arbitrary text string.
The only requirement is that the character sequence “$!” (a dollar
sign followed by an exclamation mark) cannot appear anywhere in
the section. Comments can be inserted by using # (the octothorp). If
encountered, everything to the right of the # (including the # itself)
will be ignored.
<geometryrawdata> <xyrawdata> Each block contains a block of <xyrawdata>, which forms a single
(Line segment geometry) polyline within the geometry.
<geometryrawdata> <xyzrawdata> Each block contains a block of <xyzrawdata>, which forms a single
(3D Line segment) polyline within the geometry.
<geometryrawdata> (circle) <dexp>a Only one value supplied. Value is the radius.
<geometryrawdata> (ellipse) <dexp>a Two values supplied. Values are RX and RY.
<dexp>a
<geometryrawdata> (rectangle) <dexp>a Two values supplied. Values are width and height.
<dexp>a
<geometryrawdata> (square) <dexp>a Only one value supplied. Value is the width.
271
Raw Data Name Value Type(s) Notes
per Block
<xyrawdata> <dexp> X.
<dexp>
Y.
<xyzrawdata> <dexp> X.
<dexp>
<dexp> Y.
Z.
a. A count value does not precede the raw data in this case.
Examples:
Example 1:
Raw data for a circle with radius equal to 1.7:
RAWDATA
1.7
Example 2:
Raw data for a line segment geometry with two segments. Segment 1 has 4 points and segment 2 has 3
points:
RAWDATA
2
4
1.5 2.2
1.7 2.4
1.9 2.8
2.1 3.0
3
1.1 1.7
1.2 1.9
1.3 2.0
Example 3:
Raw data to define five contour levels:
RAWDATA
5
1.5
2.6
3.7
4.9
5.5
Example 4:
Raw data to define three RGB values:
RAWDATA
3
0 0 0
45 100 100
90 200 200
272
Example 5:
For greater control of contour levels in a macro, set the levels with RAWDATA. This example allows
you to choose the number of levels, then sets new levels based on the minimum and maximum values
of the current contour variable.
$!CONTOURLEVELS DELETERANGE
CONTOURGROUP = 1
RANGEMIN = |minc|
RANGEMAX = |maxc|
$!Varset |newlevel| = (|minc| + |delta|/2)
$!Loop |numlevels|
$!CONTOURLEVELS ADD
CONTOURGROUP = 1
RAWDATA
1
|newlevel|
273
274
14
The only macro control commands allowed in stylesheets and layout files are:
$!VARSET and $!REMOVEVAR
The only SetValue command allowed in color map files is:
$!CREATECOLORMAP
Layout files, stylesheet files and colormap files cannot contain any of the following commands:
$!OPENLAYOUT
$!READSTYLESHEET
$!LOADCOLORMAP
Only SetValue macro commands are allowed in the Tecplot 360 configuration file.
The $!LIMITS command can be used only in the Tecplot 360 configuration file.
The $!FIELDMAP and $!LINEMAP commands may be used in the configuration file but they may not specify
an individual zone or line map. This special use of $!FIELDMAP and $!LINEMAP allows you to change the
default attributes for all zones and line mappings when they are initialized in Tecplot 360.
The file name referenced in the $!INCLUDEMACRO command cannot use Tecplot 360 macro variables.
Size limitations:
Maximum number of nested macro function calls 10
Maximum number of nested macro loops 10
Maximum number of nested While-EndWhile loops Unlimited.
Maximum number of nested If-EndIf loops Unlimited.
Maximum number of nested macro includes 5
Maximum number of macro commands 200,000
Maximum number of parameters per macro function 20
Maximum number of characters in macro variable name 31
275
Maximum number of characters in macro function name Unlimited.
Maximum number of macro variables 400
276
Index <xyaxis> 268
$!ACTIVEFIELDFILEMAPS 55
$!ACTIVELINEMAPS 56
$!ADDMACROPANELTITLE 56
Symbols $!ALTERDATA 56, 58
259, 260, 261, 262, 263, 264, 265, 266, 267, 268 $!ANIMATECONTOURLEVELS 58
<anglespec> 259 $!ANIMATEIJKBLANKING 59
<axisalignment> 259 $!ANIMATEIJKPLANES 61
<bitdumpregion> 259 $!ANIMATELINEMAPS 62, 63
<boolean> 260 $!ANIMATESLICES 61, 63
<borderlocation> 260 $!ANIMATESTREAM 62, 64, 65
<clipping> 260 $!ANIMATETIME 65
<compressiontype> 260 $!ANIMATEZONES 65, 66
<conditionalexp> 260 $!ATTACHDATASET 66, 67
<constraintop2mode> 260 $!ATTACHGEOM 67, 68, 69
<contourcoloring> 260 $!ATTACHTEXT 69, 70, 254
<contourlabellocation> 260 $!BASICCOLOR 72, 73, 251
<curveinfomode> 260 $!BASICSIZE 73, 75, 76, 241
<dataloadstrategy> 261 $!BLANKING 76, 78
<dialogname> 261 $!BRANCHCONNECTIVITY 78
<draworder> 262 $!BRANCHFIELDDATAVAR 79
<edgetype> 262 $!BREAK 79
<fielddatatype> 262 $!COLORMAP
<fillmode> 262 in color map files 275
<framecollection> 262 $!COMPATIBILITY 80
<ijklines> 263 $!CONTINUE 80
<interpptselection> 263 $!CONTOURLABELS 80
<isosurfaceselection> 263 $!CONTOURLABELS ADD 81
<linktype> 263 $!CONTOURLABELS DELETEALL 81
<macrofunctionvar> 263 $!CONTOURLEVELS ADD 82
<macrointrinsicvar> 264 $!CONTOURLEVELS DELETENEAREST 82, 83
<macroparameter> 264 $!CONTOURLEVELS DELETERANGE 83
<macroparameterlist> 264 $!CONTOURLEVELS NEW 83
<macrouserdefvar> 264 $!CONTOURLEVELS RESET 84
<macrovar> 264 $!CONTOURLEVELS RESETTONICE 84, 85
<mirrorvar> 264 $!CREATEBOUNDARYZONE 85
<mousebuttonclick> 264 $!CREATECIRCULARZONE 85
<mousebuttondrag> 264 $!CREATECONTOURLINEZONES 87
<mousemode> 264 $!CREATEFEBOUNDARY 79, 86, 88
<noncurrentframedrawlevel> 264 $!CREATEFESURFACEFROMIORDERED 88
<op> 264 $!CREATEISOZONES 89
<originresetlocation> 264 $!CREATELINEMAP 89
<pickaction> 265 $!CREATEMIRRORZONES 89
<plotapproximationmode> 265 $!CREATENEWFRAME 90
<plottype> 265 $!CREATERECTANGULARZONE 90, 91
<positionatanchor> 265 $!CREATESIMPLEZONE 91
<printrendertype> 265 $!CREATESLICEZONEFROMPLANE 92, 93
<relop> 265 $!CREATESLICEZONES 93
<resizefilter> 265 $!CREATESPHERICALZONE 93
<rgblegendorientation> 266 $!CREATESTREAMZONES 94
<rgbmode> 266 $!DATASETUP 95
<scope> 266 $!DEFAULTGEOM 95, 96
<set> 266 $!DEFAULTTEXT 96
<setspecifier> 266 $!DELAY 97
<sortby> 266 $!DELETEAUXDATA 97
<string> 266 $!DELETELINEMAPS 98
<stylebase> 266 $!DELETEZONES 98, 99
<subboundary> 267 $!DOUBLEBUFFER OFF 99
<thetamode> 267 $!DOUBLEBUFFER ON 99, 100
<threedviewchangedrawlevel> 267 $!DOUBLEBUFFER SWAP 99
<transformation> 267 $!DRAWGRAPHICS 100
<translucency> 267 $!DROPDIALOG 100
<valueblankrelop> 267 $!DUPLICATELINEMAP 100
<valuelocation> 267 $!DUPLICATEZONE 101
<varloadmode> 267
277
INDEX
278
$!RESET3DAXES 181 $!WRITEDATASET 213
$!RESET3DORIGIN 181 $!WRITESTYLESHEET 214
$!RESET3DSCALEFACTORS 181 $!XYLINEAXIS 215, 256
$!RESETVECTORLENGTH 182
$!ROTATE2DDATA 182 Numerics
$!ROTATE3DVIEW 182 2D axes
$!RUNMACROFUNCTION 184 settings 203
$!SAVELAYOUT 184 2D draw order 267
$!SET3DEYEDISTANCE 185 2D field plots 81
$!SETAUXDATA 185, 186 vector plots 138
$!SETDATASETTITLE 187 3D axes
$!SETFIELDVALUE 187 attributes 200
$!SETFRAMEBACKGROUNDCOLOR 187 reset 181
$!SETSTYLEBASE 188 3D plots
$!SHARECONNECTIVITY 188 global attributes 136, 201
$!SHAREFIELDDATAVAR 189 3D rotation 266
$!SHIFTLINEMAPSTOBOTTOM 189 3D vector plot attributes 137
$!SHIFTLINEMAPSTOTOP 189
$!SHOWMOUSEPOINTER 189 A
$!SKETCHAXIS 190 Action commands 55
$!SLICEATRRIBUTES 190 Active planes 263
$!SMOOTH 193 Active zones 55
$!STREAMATTRIBUTES 194 Add-on
$!STREAMTRACE ADD 196, 197 loading 156
$!STREAMTRACE DELETEALL 198 Add-on commands
$!STREAMTRACE DELETERANGE 198 send to add-on 106
$!STREAMTRACE RESETDELTATIME 198 Add-on style 259
$!STREAMTRACE SETTERMINATIONLINE 198, 199 ALIGNINGCONTOURLABELS 122
$!SYSTEM 199 Alignment 264
$!THREEDAXIS 200, 244, 245 axis 259
$!THREEDVIEW 201 ALLOWDATAPOINTADJUST 141
$!TRANFORMCOORDINATES 201 ALLOWDATAPOINTSELECT 141
$!TRIANGULATE 202 ALLOWHWACCELERATION 144
$!TWODAXIS 203, 237, 238, 239, 240, 245, 247, 249, 255 Alter data command 56
$!VARSET 17, 21, 204 ALWAYSPOPACTIVEFRAME 141
in stylesheets and layout files 275 Anchor 237
$!VIEW AXISFIT 205 text 70
$!VIEW AXISNICEFIT 206 Angle
$!VIEW CENTER 206 rotate 3D 72, 136, 183, 184, 201
$!VIEW COPY 206 Angle units 259
$!VIEW DATAFIT 206 Animate commands 58–66
$!VIEW FIT 207 ANIMATESTREAKLINES macro command 217, 219
$!VIEW LAST 207 Animation
$!VIEW MAKECURRENTVIEWNICE 207 contour levels 58
$!VIEW NICEFIT 208 frames 63
$!VIEW PASTE 208 IJK blanking 59
$!VIEW PUSH 208 IJK planes 61
$!VIEW RESETTOENTIRECIRCLE 208 iso-surface 61
$!VIEW SETMAGNIFICATION 208 line mappings 62
$!VIEW TRANSLATE 209 slice 63
$!VIEW ZOOM 209 stream markers 64
$!WHILE 210 streamtraces 64, 65
$!WHILE-$!ENDWHILE 79 Time 65
$!WORKSPACEVIEW 210 zone 65, 66
$!WORKSPACEVIEW FITALLFRAMES 210 zones 66
$!WORKSPACEVIEW FITPAPER 211 Area style 238
$!WORKSPACEVIEW FITSELECTEDFRAMES 211 Arrowhead
$!WORKSPACEVIEW LASTVIEW 211 angle 68
$!WORKSPACEVIEW MAXIMIZE 211 attachment 68, 259
$!WORKSPACEVIEW TRANSLATE 211 size 68
$!WORKSPACEVIEW UNMAXIMIZE 212 style 68, 259
$!WORKSPACEVIEW ZOOM 212 ARROWHEADSIZES 76
$!WRITECOLORMAP 212 ATTACHINTEGRATIONRESULTS
$!WRITECURVEINFO 213 macro command 217, 219
279
INDEX
automatic stranding 87, 88, 94, 203 CALCULATEACCURACY macro command 218, 223
AUTOREDRAWISACTIVE 141 Case of characters 17
Auxiliary data 122 Cell labels 134
delete 97 Center
macro variables 18 view 206
setting 185, 186 Character sequence 260
Axes 205, 206, 238, 239, 240 Circle
2D settings 203 raw data 271
3D attributes 200 Circular zone 85, 93
adjust to center data 206 Clipping 68
adjust to nice fit 208 Color
adjust to nice view 207 fill color 68
assign variables 169, 200, 203 flooding 243
attributes 237, 238, 239, 240, 255 palette 264
dependent mode 259 rgb 72
fit to data 205 text 70
grid area 238, 244 Color map 260
grid areas 244 assignment value options 266
gridlines 245 contour 242
in Sketch frame mode 190 override 242
labels 247 control 260
nice fit 206 control points 242
number 205, 206 distribution 242, 260
polar files 275
attributes 169 gray scale output 251
reset 181 loading 157
reset scale factors 181 override 242, 243
tick marks 255 raw data 271
attributes 255 raw user-defined 242
label formatting 254 RGB values 175
labels 255 write to file 212
title mode 259 Color palette 264
title position 259 Color text 70
variables 200 COLORMAPFILE 113
XY Line attributes assignments 215 Colors 68, 72, 73, 260
Axis alignment 259 assigning RGB values 251
quickedit 265
B RGB 133, 251
Back buffer set command in macros 72
swap to front 99 shading 251
Backing store 259 zebra shading 257
BACKINGSTOREMODE 141 Command Line 9
basic colors Command parameters 15
naming 241 Conditional execute 210
basiccolorcontrol subcommand 241 Conditional expressions 260
basicsizelist subcommand 241 Configuration
BEEPONFRAMEINTERRUPT 141 OpenGL 250
Blanking 76, 78 Configuration file
animate 59 SetValue macro commands 275
IJK 76 Configuring dropdown menus 241
Value 267 Continue command 80
value 76 Continue to execute a set of commands 210
BOLDFACTOR 115 Contour
Boundary condition 260 color map 242
Box type 260 override 242
Break out command 79 zebra shading 257
Buffer commands 99–100 line mode 260
plot type 260
C Contour commands 80–85
CACHELIGHTDISPLAYLISTSONLY 141 Contour labels 81, 128, 260
CALCPARTICLEPATH macro command 218, 219 Contour levels 83, 260
CALCTURBULENCEFUNCTION animate 58
macro command 218, 222 animation 59
CALCULATE macro command 218, 222 delete 82
280
new 83 field variables 189
raw data 271 reference count 124
Contour plot Data type 91, 260
animation 58 DATAFILEVARLOADMODE 113
attributes 110 Debugging macro files 10
global changes 127 Delay 97
label 80, 81 Delete
labels 128 objects 165
levels 58 Delete picked objects 165
add 82 Derivative position 261
copy to another frame 214 DERIVATIVEBOUNDARY 141
delete 82, 83 Destination
reset 84 map 100
show 109 zone 147
variable 128 Dialog
Control commands drop a Tecplot dialog 100
If...Endif 140, 270 Display
Control points render 146
contour color maps 242 Display message 162
Coordinates DISPLAYBOUNDARIES
convert polar to rectangular 170 macro command 218, 224
Copy picked objects 165 DISTRIBUTIONREGION 197
Curve details DOAUTOFNAMEEXTENSION 113
write to file 213 Double 262
Curve equations Double buffer
write 213 compound functions 99
Cut turning off 99
delete picked objects 165 turning on 99
Cutaway views Double expression 262
blanking 76 Draw order 267
Line mappings 189
D sort level 136, 201
Data 141 Dropdown menus 241
adjust axes to fit 205, 206 Duplicate zones 101
center in view 206 Dura labels
fit to axis grid area 207 labeling node 263
read 176
reading 265 E
rotate 182 Edge attributes 110
rotating 17 Edge plot
smooth 193 show 109
Data alteration 56 Edge setting 262
Data extraction 107 Edit
Data fit 206 global edit on picked objects 165
Data labels 134 Ellipse
Data manipulation 56 raw data 271
polar to rectangular coordinates 170 ENABLEDELAYS 142
Data operations ENABLEINTERRUPTS 142
zone number specification 58 ENABLEPAUSES 142
Data point ENABLEWARNINGS 142
adjust 141 Encapsulated PostScript
moving 141 preview image 262
select 141 EndLoop command 157
Data set Environment variables 20
attach to frame command 66 EQUATIONFILE 113
naming 187 Equations 57
variable 124 Error bars
write 213 plot types 262
Data set variables Examples
set value (from macro variable) 187 2D axes attributes 170, 203
Data sharing 3D axis attributes 200
branching connectivity 78 activating field zones for plotting 55
branching variables 79 Adding contour levels 82
connectivity 188 adding Line maps 56
281
INDEX
282
FORTRAN-like equations 56 Gray scale output 251
Frame 67 Grid
activate frame by name 118 precise dot 248
activate frame by number 118 Grid area 244
activate frame by position 117 Grid area border 238, 245
activate next frame 117 Grid area example 249
activate previous frame 117 Grid coordinates 260
activate top frame 117 Grid lines 245
always pop active frame 141 gridarea subcommand 244
attach to data set command 66 gridlinedetail subcommand 245
create 90 Gridlines 245
delete 161
delete active frame 120 I
dynamic attributes 121 I-, J-, or K-indices
fit frames to paper 120 setting 246
get name 123 If command 140
invisible borders 145 IJK Blanking 78
move active frame to top 118 IJK blanking 76
move frame to bottom by name 119 animation 59
move frame to bottom by number 120 blanking domain 263
move frame to top by number 119 IJK index 246
move to top by name 119 ijk subcommand 246
moves active frame to bottom 119 IJK-indices
text (attach) 69 minimum/maximum as variables 19
view last 207 IJK-planes
Frame control commands 116–120 animation 61
Frame coordinates 260 Image
Frame manipulating 262 export 103, 104
Frame modes 198, 262 attributes 105
Frame style Image style 263
attributes 188 IMAGERENDERING 144
FRAMEHEADERFORMAT 130 Index ranges 246
FRAMEHEADERHEIGHT 130 setting 246
Frames indexrange subcommand 246
fit all into workspace view 210 Infinite
fit selected frames in view 211 see Loop
number of frames 19 Initial dialog placement 243
setting global attributes 130 INITIAL3DSCALE 122
Frames with pick handles 211 initialdialogplacement subcommand 243
FRAMETEXTSIZES 76 INITIALPLOTFIRSTZONEONLY 142
INPUTDATAFILE 113
G INPUTLAYOUTFILE 113
Geometries Integer 263
copy to another frame 214 INTEGRATE macro command 218, 225
default attributes 95 Integration
Geometry accessing results 227
attach command 67 Interface
attach to frame 67 Data 141
attributes 95 launch dialog 150
color 68 render 146
defaults 95 set attributes 140
extract data 107 Internal macro variables 20
Geometry attributes 67 INTERPNPOINTS 141
Geometry raw data 271 Interpolation
Geometry type 68, 263 inverse distance method 147
circle 263 kriging 149
ellipse 263 linear method 151
rectangle 263 pointer selection 265
square 263 INTERPPTSELECTION 141
Global attributes 127–139 INTERRUPTCHECKINGFREQUENCY 142
Global edit Intrinsic values 264
on picked objects 165 INVDISTEXPONENT 141
Graphics INVDISTMINRADIUS 141
turn drawing on or off 100 Inverse distance interpolation 147
283
INDEX
284
Macro function display 162
execute 184 Minimum values
Macro function files as variables 19
example 10 MINPIXELSFORDRAG 142
loading your own 10 Mirror zones
Macro functions 9, 10 create 89
definition 157 Modifiers
retaining 9 command-specific 15
run command 22 Monochrome hardcopy 251
Macro language Mouse button assignments 259
restrictions and limitations 275 Mouse mode
Macro Panel 10 set for picking 168
Macro panel 158 Mouse pointer 265
title 56 Move picked objects 168
Macro syntax Movie files 59, 61, 62, 63, 64, 65, 66
examples 270
Macro variable N
set field value 187 Name
values 21 get frame name 123
Macro variables Negative values 57, 227
assigning strings 21 Number format 247
assigning value or string 204 Number formats 267
assigning values 21 Number of cycles for animation 62, 64, 65
function 22 Number of ellipse points 68
get active frame name 123 number of zones 19
get field value 124 numberformat subcommand 247
name 20 Numbers
remove user-defined 179 formatting in macro variables 23
select variable (by name) 126 NUMPTSALLOWEDBEFOREAPPROX 143
strings 21 NUMSMOOTHPASSES 141
using formats 23 NUMSTREAMRAKEPOINTS 122
Macro viewer 10 NUMSTREAMSURFACEPOINTS 122
MACROFILE 113
Macros 7, 9, 10 O
running from the command line 9 Object
running from the Quick Macro Panel 10 size 73, 75
running from the Tecplot interface 9 OKTOEXECUTESYSTEMCOMMAND 143
Macros vs. macro functions vs. macro commands 9 OpenGL
Magnification rendering settings 250
set for view 208 OpenGL rendering 250
zoom 209 OPENGLCONFIG 143
Magnify picked objects 167 Operating system
Major macro commands 25 using as variable 19
Managing Tecplot macros 9 Operating system instructions 199
Mandatory parameters 15 Optional box settings 253
Mappings Optional parameters 15
delete 98 Output
duplicate 100 file configuration 112
Mass calculation example 227 OUTPUTASCIIDATAFILE 113
Mass flux example 227 OUTPUTBINARYDATAFILE 113
Mass-weighted average example 227 OUTPUTLAYOUTFILE 113
MAXCHRSINTEXTLABELS 151 OUTPUTLAYOUTPACKAGEFILE 113
Maximum index 227 Overrides
Maximum values color map 242
as variables 18
MAXNUMCONTOURLEVELS 151 P
MAXPTSINALINE 151 Page
MEDIUMSTEP 145 color 159
Mesh attributes 110 create page 161
Mesh plot name the current page 162
show 109 set next page to active 161
Mesh plots set previous page to current 161
plot types 264 set specifications 159
Message show grid 159
285
INDEX
286
Reference scatter symbol 135 SETFIELDVARIABLES
attributes 249 macro command 218, 228
Reference scatter symbols 249 SETFLUIDPROPERTIES
refscatsymbol subcommand 249 macro command 218, 228
Remove user-defined macro variable 179 SETGEOMETRYANDBOUNDARIES
rendconfig subcommand 250 macro command 218, 230
Rendering SETREFERENCEANDFIELDVARIABLES
off-screen 146 macro command 230
with OpenGL 250 SETREFERENCEVALUES
Retaining macro function 9 macro command 218
RGB 251 Setting (X,Y,Z) triplets 257
components 72 Setting (X,Y) positions 257
rgb subcommand 251 Setting attributes
Rotate reference scatter symbols 249, 250
2D plot 182 Setting color values 251
3D plots 136, 182, 201 Setting I-, J-, or K-indices 246
Rotate a 3D plot Setting index ranges 246
example 17 Setting number formats 247
ROTATION Setting symbol shapes 252
details 144 Setting zebra shading attributes 257
Rotation 266 Settings
axis 266 OpenGL rendering 250
origin location 266 SETUNSTEADYFLOWOPTIONS
reset rotation origin 181 macro command 218, 231
rotation origin 181 SetValue commands
Ruler 159, 265 in color map files 275
RULERPADDING 145 macro configuration files 275
RULERTHICKNESS 145 Shade attributes 111
RUNDISPLAYLISTSAFTERBUILDING 143 Shade maps 251
Running shademap subcommand 251
macro function 22 Shading 251
Running macros Shift picked objects 168
from the command line 9 SHOWCONTINUOUSSTATUS 145
from the Quick Macro Panel 10 SHOWCOORDINATES 145
from the tecplot interface 9 SHOWCOORDINATESWITHSELECTORADJUSTOR 1
Tecplot 9 45
SHOWFRAMEBORDERSWHENOFF 145
S -showpanel flag 10
Save SHOWSTATUSLINE 145
color map 212 SHOWTEXTGEOMSINAPPROXVIEW 145
curve information 213 SHOWWAITDIALOGS 145
data set 213 Simple zone
stylesheet 214 create 91
SAVEINTEGRATIONRESULTS Single angle brackets 237, 259
macro command 218, 227 Size 241
SCALE 145 object 73, 75
Scale factors paper 132
reset 181 preference 75
Scatter set command in macros 73, 75
legend 135, 148 Size limitations
sizing by variable 135, 148 macro control commands 275
Scatter attributes 111 Size lists 241
Scatter plot Size preferences 75
show 109 Size units 266
Scatter plots 111 Sketch
set global attributes 134 axis 190
Scatter symbol attributes 249 Skip mode 266
Scatter symbols 249 Slice
Scope of text 68 animate 63
Scratch data type 95 create slice zone command 92
SCRATCHDATAFIELDTYPE 95 Plane type assigned 19
SCRBACKGROUNDCOLOR 145 positioning 20
SCREENRENDERING 144 Slice source 266
Select objects 162 Slices 266
287
INDEX
288
Tickmark labels minimum/maximum as variables 19
alignment 263 Vectors
tickmarkdetail subcommand 255 length reset 182
TIFF byte order 267 reference vector 137, 139
Time Vectors plot
Animation 65 show 109
Title Vertical bars (’|’s) 17
data set 187 View
Transform axis fit 205
coordinates 201 axis nice fit 206
polar to rectangular coordinates 170 center 206
Translate copy 206
view 209 data fit 206
workspace view 211 fit 207
Translate picked objects 168 fit all frames 210
TRANSLATION 145 fit paper in workspace 211
Translucency 267 fit selected frames 211
TRIANGLEKEEPFACTOR 141 last 207
magnify 208
U maximize 212
Undo maximize workspace view 211
view only 207 nice fit 208
USEAPPROXIMATEPLOTS 146 paste 208
USEDISPLAYLISTS 146 return to last view 211
USEDOUBLEBUFFERING 146 rotate 182
User input dialogs 173 shift workspace 211
User interface translate 209
launch dialog 150 zoom workspace 212
set attributes 140 View commands 204–210, 210–212
User-defined variables 20 View compound function family 204
USETECPLOTPRINTDRIVERS 146 View mode 267
View stack 208
V retrieve last view 207
Value blanking 76, 267 volume attributes 111
cell mode 267 Volume objects 256
Values Volume surfaces
display 134, 135 create FE surfaces 89
macro variables 17 VOLUMEMODE 111
set field value 187 volumeobjectstoplot subcommand 256
Variable lists 156
Variables W
3D axis 200 While command 210
assign to 2D axis 169, 203 Workspace
assign to 3D axes 200 view 211
assigning values 204 translate 211
contours 128 unmaximize 212
environment 20 view mode 268
initializing 204 Workspace commands 210–212
internal 18 Write
location 125 color map 212
macro functions 22 data set 213
remove user-defined macro variable 179 stylesheet 214
renaming 179, 180
scatter symbol sizing 135, 148 X
variable number 126 X-axis gridlines 245
vector 138, 139 XORCOLOR 146
VECTDEFLEN 122 XY
VECTMINLEN 122 raw data 272
Vector plot XY Line axes attributes
attributes 137 assign 215
Vector plots 267 XY line plots
variables 138 coordinate scale 260
vector format 111 curve information 260
Vector variables 139 curve type 260
289
INDEX
Z
Z-clip 136, 201
Zebra shading 257
attributes 257
zebrashade subcommand 257
Zone
animation 65, 66
attach geometry 68
attributes 109
Zone boundaries
finite-element data 79, 86, 88
for finite element data 88
Zone numbers
specify 58
Zones 19, 68
animate 65, 66
attributes 275
concatenate 94
create 85–86, 93–94
create isozones command 89
create mirrors 89
create rectangular 90
defaults 275
delete 98, 99
duplicate 101
FE surface 89
new 91
streamtraces 93
renaming 180
specify number 58
triangulate 202
Zoom
picked objects 167
view 209
workspace view 212
290