Tecplotsv Ug

Tecplot SV User Guide
Version H-2013.03, March 2013

Copyright and Proprietary Information Notice
Copyright © 2013 Synopsys, Inc. All rights reserved. This software and documentation contain confidential and proprietary
information that is the property of Synopsys, Inc. The software and documentation are furnished under a license agreement and
may be used or copied only in accordance with the terms of the license agreement. No part of the software and documentation may
be reproduced, transmitted, or translated, in any form or by any means, electronic, mechanical, manual, optical, or otherwise, without
prior written permission of Synopsys, Inc., or as expressly provided by the license agreement.
Destination Control Statement
All technical data contained in this publication is subject to the export control laws of the United States of America.
Disclosure to nationals of other countries contrary to United States law is prohibited. It is the reader’s responsibility to
determine the applicable regulations and to comply with them.
Disclaimer
SYNOPSYS, INC., AND ITS LICENSORS MAKE NO WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, WITH
REGARD TO THIS MATERIAL, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
Trademarks
Synopsys and certain Synopsys product names are trademarks of Synopsys, as set forth at
http://www.synopsys.com/Company/Pages/Trademarks.aspx.
All other product or company names may be trademarks of their respective owners.
Synopsys, Inc.
700 E. Middlefield Road
Mountain View, CA 94043
www.synopsys.com
ii Tecplot SV User Guide

H-2013.03
Contents
About This Guide vii
Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii
Related Publications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii
Typographic Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii
Customer Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
Accessing SolvNet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
Contacting Synopsys Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
Contacting Your Local TCAD Support Team Directly. . . . . . . . . . . . . . . . . . . . . . . . . x
Chapter 1 Getting Started 1

Main Tecplot Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Starting Tecplot SV from the Command Prompt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Starting Tecplot SV from Sentaurus Workbench . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
General Recommendations for Effective Use of Tecplot SV . . . . . . . . . . . . . . . . . . . . . . . 2
Chapter 2 Loading Files 3

File Loader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Mapping Coordinates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Mapping Datasets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Chapter 3 Synopsys Sidebar 5

Displaying Tecplot Sidebar. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Common Components of Synopsys Sidebar. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Sidebar in 2D/3D Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Sidebar in XY Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Chapter 4 Generating Cuts 11

Cutting Tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Cut Destination Frame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Tecplot SV User Guide iii

H-2013.03
Contents
Chapter 5 Interface to Sentaurus Process or Sentaurus Interconnect 13

Launching or Connecting to Tecplot SV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Valid Host and Port Specification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Controlling Sentaurus Process or Sentaurus Interconnect from Tecplot SV . . . . . . . . . . 14
Chapter 6 Measuring Distances 15

Measure Distance Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Using the Measure Distance Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Chapter 7 Utilities and Preferences 17

Updating Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Customizing Contour Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
GUI Preferences. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
List Display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Syntax of Name Templates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Load Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Advanced: Load DF–ISE Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Advanced: Load TDF/TIF Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Layout Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Frame Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Plot Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Advanced: Plot 2D Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Advanced: Plot Contour Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Advanced: Plot XY Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Slice Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Miscellaneous Preferences. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Chapter 8 Automating Tasks 35

Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Macro Language Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
EXPORT_INSPECT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
EXTRACT_CONTOUR_TO_FILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
EXTRACT_DATA_POINT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
GET_COLOR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
GET_VARNUM_BY_TDR_NAME. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
GET_VARNUM_BY_TDR_QUANTITY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
GET_ZONENUM_BY_TDR_REGION_NAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
iv Tecplot SV User Guide

H-2013.03
Contents
INTEGRATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
INTEGRATE_CURVE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
ORTHOSLICE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
SET_CONTOUR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
SET_PREFERENCE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
SLICEMODE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
UPDATE_DATA. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Appendix A Command Options 45

Command Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
General Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Launcher Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Loader Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Tecplot Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Environment Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Glossary 49
Tecplot SV User Guide v

H-2013.03
Contents
vi Tecplot SV User Guide

H-2013.03
About This Guide
Tecplot SV is part of Sentaurus Workbench Visualization. It is plotting software with extensive
2D and 3D capabilities for visualizing data from simulations and experiments.
This user guide describes the Sentaurus Workbench add-on to Tecplot1. Tecplot is a dedicated
software for scientific visualization that Synopsys has extended to accommodate the special
requirements of the Synopsys simulation environment. This user guide only covers the use of
the add-on. Tecplot has its own set of documentation. If you cannot find information in this user
guide, consult the Tecplot 360™ User’s Manual and Tecplot 360™ Scripting Guide. It is
recommended that you go to http://www.tecplot.com for more information about Tecplot.
The main chapters are:

■ Chapter 1 presents the two methods of starting Tecplot SV.
■ Chapter 2 describes how to load grid and data files.
■ Chapter 3 sets out the key features of the Synopsys sidebar.
■ Chapter 4 describes how to generate various cut types.
■ Chapter 5 describes how to use the interface to Sentaurus Process or Sentaurus
Interconnect.
■ Chapter 6 describes how to measure distances.
■ Chapter 7 presents various utilities and the options available from the Preferences dialog
box.
■ Chapter 8 describes how tasks can be automatized using the Tecplot macro language.
Audience
This user guide is intended for users of the Tecplot SV software package.
1. Tecplot is a registered trademark of Tecplot, Inc., Bellevue, WA, U.S.A.
Tecplot SV User Guide vii

H-2013.03
About This Guide
Related Publications
Related Publications
For additional information about Tecplot SV, see:
■ The documentation installed with the Tecplot SV software and available through the
Tecplot SV Help menu.
■ The TCAD Sentaurus release notes, available on SolvNet (see Accessing SolvNet on
page ix).
■ Documentation available through SolvNet at https://solvnet.synopsys.com/DocsOnWeb.
Typographic Conventions
Convention Explanation
Blue text Identifies a cross-reference (only on the screen).
Bold text Identifies a selectable icon, button, menu, or tab. It also indicates the name of a field or an
option.
Courier font Identifies text that is displayed on the screen or that the user must type. It identifies the
names of files, directories, paths, parameters, keywords, and variables.
Italicized text Used for emphasis, the titles of books and journals, and non-English words. It also
identifies components of an equation or a formula, a placeholder, or an identifier.
Key+Key Indicates keyboard actions, for example, Ctrl+I (press the I key while pressing the Control
key).
Menu > Command Indicates a menu command, for example, File > New (from the File menu, select New).
NOTE Identifies important information.
viii Tecplot SV User Guide

H-2013.03
About This Guide
Customer Support
Customer Support
Customer support is available through SolvNet online customer support and through
contacting the Synopsys support center.
Accessing SolvNet
SolvNet includes an electronic knowledge base of technical articles and answers to frequently
asked questions about Synopsys tools. SolvNet also gives you access to a wide range of
Synopsys online services, which include downloading software, viewing documentation, and
entering a call to the Synopsys support center.
To access SolvNet:
1. Go to the SolvNet Web page at https://solvnet.synopsys.com.
2. If prompted, enter your user name and password. (If you do not have a Synopsys user name
and password, follow the instructions to register with SolvNet.)
If you need help using SolvNet, click Help on the SolvNet menu bar.
Contacting Synopsys Support

If you have problems, questions, or suggestions, you can contact Synopsys support in the
following ways:
■ Go to the Synopsys Global Support Centers site on www.synopsys.com. There you can find
e-mail addresses and telephone numbers for Synopsys support centers throughout the
world.
■ Go to either the Synopsys SolvNet site or the Synopsys Global Support Centers site and
open a case online (Synopsys user name and password required).
Tecplot SV User Guide ix

H-2013.03
About This Guide
Customer Support
Contacting Your Local TCAD Support Team Directly

Send an e-mail message to:
■ [email protected] from within North America and South America.
■ [email protected] from within Europe.
■ [email protected] from within Asia Pacific (China, Taiwan, Singapore,
Malaysia, India, Australia).
■ [email protected] from Korea.
■ [email protected] from Japan.
x Tecplot SV User Guide

H-2013.03
CHAPTER 1 Getting Started
This chapter presents basic information about starting Tecplot SV.
Synopsys provides an original equipment manufacturer (OEM) distribution of Tecplot that

includes the original Tecplot distribution by Tecplot, Inc., the Synopsys TCAD add-on, and the
Synopsys tecplot_sv launcher, which starts Tecplot in a special Synopsys configuration
mode. The complete package consisting of these three components is called Tecplot SV.
Main Tecplot Window

The main Tecplot window consists of the Synopsys menu bar and sidebar, the status line, and
the Tecplot workspace, which contains a page with frames.
Menu Bar
Workspace
Page
Frame
Sidebar
Status Line
Figure 1 Tecplot main window (detail)
Tecplot SV User Guide 1

H-2013.03
1: Getting Started
Starting Tecplot SV from the Command Prompt
Starting Tecplot SV from the Command Prompt

The command tecplot_sv is used to start Tecplot from the command prompt, for example:
tecplot_sv n2_fps.tdr
and it is a program that launches the actual Tecplot executable. Most of the original Tecplot
command-line options pass to Tecplot by tecplot_sv. In addition to those, tecplot_sv has
its own command-line options (see Appendix A on page 45).
Starting Tecplot SV from Sentaurus Workbench

The command tecplot_sv is integrated in Sentaurus Workbench so that it can be started by
clicking the Tecplot icon, it can receive node data and it can be inserted into tool flows.
NOTE Tecplot can run in batch mode (-b option), which is especially useful
when used within tool flows. In this context, the use of macro files and
style files is also of interest. Refer to the Tecplot documentation for
more information about the macro language and batch processing.
General Recommendations for Effective Use of Tecplot SV

The following points should be remembered when using Tecplot SV:
■ Pay attention to the status line at the bottom of the Tecplot main window. It often displays
helpful instructions.
■ Use the Tecplot online help from the Help menu, and the Help buttons in dialog boxes.
■ As an alternative to vector display, which is often unsatisfactory on finite-element grids, it
is recommended that the Tecplot streamtrace feature is used. Streamtraces are superior to
vectors for visualizing quantities such as the current density field. For detailed information
on streamtraces, refer to the Tecplot 360™ User’s Manual.
■ The middle and the right mouse buttons, combined with keys, provide easy access to zoom,
pan, and rotate operations. Use Help > Keyboard Shortcuts for more information on
useful shortcut keys.
■ Use the keyboard shortcuts, which are available for some frequently used menu commands.
2 Tecplot SV User Guide

H-2013.03
CHAPTER 2 Loading Files
This chapter describes how to load files.
File Loader
To load files in various formats:
■ File > Load, or click the Load button on the Synopsys sidebar, or specify the files in the
tecplot_sv command line (see Appendix A on page 45).
The loader tries to identify the file types and ignores any files that are not in one of the
recognized formats. The loader recognizes the following file formats:
■ TDR (this is the standard TCAD Sentaurus format)
■ TDF
■ TIF
■ IVL
■ PLX
The loader detects matching grid and data files automatically even if they are not specified in
the correct order. Data files are ignored if they do not match any of the loaded grid files.
For more information about the TDR format, refer to the Sentaurus Data Explorer User Guide.
Mapping Coordinates
Some file types contain a transformation matrix and a translation vector that define a mapping
from the local coordinates specified in the file to a global coordinate system. By default, the
loader does not apply this transformation, so that, for example, a 2D grid is displayed in 2D
frame mode with its local x-coordinates and y-coordinates. The tecplot_sv launcher
provides a pair of options, -s:lc and -s:gc, which allows the user to switch between local
and global coordinate modes. These options can be specified any number of times to switch
between the two modes.

H-2013.03
2: Loading Files
Mapping Datasets
Mapping Datasets
While loading a data file, the loader creates a Tecplot variable for each dataset. For vector
datasets, the loader creates an additional variable called Abs(var-name) and initializes it
with the magnitude of the vector field. The variables corresponding to the vector field
components are still available in Tecplot, but they are not displayed in the list of variables on
the Synopsys sidebar.

H-2013.03
CHAPTER 3 Synopsys Sidebar
This chapter discusses the different available sidebars.
The sidebar is the main tool area containing buttons, shortcuts, and convenient functionality for
users. The sidebar layout changes depending on the plot type of the current frame. Users who
are familiar with the native Tecplot version may also want to use the native Tecplot sidebar.
Displaying Tecplot Sidebar

To display the standard Tecplot sidebar:
■ View > Tecplot Sidebar.
The available sidebar layouts are displayed in Figure 2.

2D/3D Mode XY Mode Native Tecplot
Figure 2 Available sidebar layouts

H-2013.03
3: Synopsys Sidebar
Common Components of Synopsys Sidebar
Common Components of Synopsys Sidebar

Table 1 lists the common components of the sidebar.
Table 1 Common elements of Synopsys sidebar

Icon Name Explanation
Load Loads files.
Update Data Updates the variables in the active frame from the data file.
Reset Resets display properties.
Redraw Redraws the active frame. The equivalent keyboard shortcut is Ctrl+R.
Last View Returns to a previous view. The previous 16 views of each plot type for each
frame are maintained in a view stack. By clicking Last View, users can recover
one of their previous 16 views. The equivalent keyboard shortcut is Ctrl+L.
Previous Frame Activates the previous frame.
Next Frame Activates the next frame.
Arrange Toggles between side-by-side layout and stack layout, and rearranges the frames
on the page.
Fit Fits contents to the full size of the frame.
Zoom Zooms into or away from the plot. To zoom, drag the magnifying glass pointer
and draw a box around the region that is to fit in the frame. The selected region
will be resized to fit into the frame.
Measure Enables the distance measuring mode.
Integrate Integrates the selected variable over the selected zones.
Data Probe Enables probing to examine variable values, or zone and cell information, for any
point in the dataset.
Rotate Enables one of the six available 3D rotation modes (spherical, roller-ball, twist, x,
y, and z). Use the keys indicated in the status line to switch between the rotation
modes.

H-2013.03
3: Synopsys Sidebar
Sidebar in 2D/3D Mode
Table 1 Common elements of Synopsys sidebar

Insert Text Enables or disables the text insert mode for adding text to plots.
Draw Lines Enables or disables the line drawing mode for adding lines and arrows to plots.
Draw Rectangle Enables or disables the rectangle drawing mode for adding rectangular boxes to
plots.
Draw Ellipse Enables or disables the ellipse drawing mode for adding circles and ellipses to
plots.
Select Tool Enables or disables the select tool for selecting objects inside the plot.
Adjuster Tool Enables or disables the adjuster tool for selecting and adjusting objects inside the
plot.

The 2D/3D part of the sidebar (see Figure 2 on page 5) contains the items listed in Table 2.
Table 2 Synopsys sidebar in 2D and 3D mode

Variable list The selected variable is used for contouring.

To obtain a shade plot with zones that are colored according to their material
property, disable the contours using the Contours Off button.
Contour Range Displays and sets the minimum and maximum values for the contour range,
which determines the valid interval for the calculation of contour levels.
Contour Mode Selects the Lin (linear), Log (logarithmic), or Ash (Asinh) contour mode. The
default is according to the definitions in the DATEX file.
The contour mode is only used for computing the contour level distribution. It
does not affect the interpolation of data between nodes of the grid (which is
always linear).
Range Reset Selects between various options regarding the calculation of the contour range.
Contour Legend Enables or disables the display of the contour legend.
List Mode Selects between displaying the regions or materials in the list box.

H-2013.03
3: Synopsys Sidebar

Region list Selects a set of regions that becomes the active set for subsequent operations. The
list can display either regions or properties. The list allows multiple selections
using the Shift and Ctrl keys.
Grid On Displays the grid lines of the selected regions.
Grid Off Hides the grid lines of the selected regions.
Boundary On Displays the boundary of the selected regions.
Boundary Off Hides the boundary of the selected regions.
Vectors On Displays the vectors of the selected regions.
Vectors Off Hides the vectors of the selected regions.
Contour Fill and Displays the contour fill and the contour lines of the selected regions.
Lines
Contour Fill Displays the contour fill of the selected regions.
Contour Lines Displays the contour lines of the selected regions.
Contours Off Hides the contour fill and the contour lines of the selected regions.
Region Display Displays the selected regions exclusively.

Exclusive
Region Display Displays the selected regions.

On
Region Display Hides the selected regions.

Off
X Cut Generates an orthogonal x-cut. To finish the cut, click at the required cut position.
Y Cut Generates an orthogonal y-cut. To finish the cut, click at the required cut position.
Z Cut Generates an orthogonal z-cut. To finish the cut, click at the required cut position.

H-2013.03
3: Synopsys Sidebar
Sidebar in XY Mode

Interactive Enables 3D dynamic slicing.

Slicer
Cut Along Enables cuts along a 2D boundary.

Boundary
Value Blanking Enables value blanking.
PN-Junction Changes the display of junction lines.
Depletion Changes the display of the contours of the depletion region.

Region
Amorphous Changes the display of the amorphous–crystalline interface.

Interface
Translucency Displays translucency of the selected regions.

On
Translucency Hides translucency of the selected regions.

Off
Sidebar in XY Mode
The XY part of the sidebar (see Figure 2 on page 5) contains the items listed in Table 3.
Table 3 The Synopsys sidebar in XY mode

X-Axis Variable Assigns a variable to the current x-axis.
Variable list Assigns the selected variables to the current y-axis and displays temporary
curves.
Current X-Axis Selects the current x-axis.
Current Y-Axis Selects the current y-axis.
Axis Mode Switches between linear and logarithmic modes of the current x-axis or y-axis.
Range Lock Locks or unlocks the range of the current x-axis or y-axis.

H-2013.03
3: Synopsys Sidebar
Sidebar in XY Mode
Table 3 The Synopsys sidebar in XY mode

Create Curves Creates permanent curves from all temporary curves.
Region list Lists the regions.
Region Display Displays the selected regions exclusively.

Exclusive
Region Display Displays the selected regions.

On
Region Display Hides the selected regions.

Off
Curve Legend Displays or hides the curve legend.
List Mode Selects between displaying the regions or materials in the list box.
Curve list Lists the permanent curves.
Assign Colors Assigns different colors to the selected curves.
Assign Symbols Assigns different symbols to the selected curves.
Assign Line Assigns different line styles to the selected curves.

Styles
Edit Curves Opens the curve editor.
Delete Curves Deletes the selected curves.

H-2013.03
CHAPTER 4 Generating Cuts
This chapter describes how to generate various cut types.
Cutting Tools
Tecplot SV provides the following tools for generating 1D and 2D cuts:
■ The orthogonal slicer, which generates 1D and 2D cuts that are perpendicular to one of the
coordinate axes. This feature is accessed from the menu Slicer > Orthogonal Cut, or from
the corresponding buttons on the sidebar.
■ The interactive slicer, which is used to drag a 2D slice plane through a 3D volume. This
feature is accessed from the menu Slicer > Interactive Slicer, or from the corresponding
button on the sidebar.
■ The cut along boundary tool, which generates 1D cuts along boundaries of 2D regions. This
feature is accessed from the menu Slicer > Cut Along Boundary, or from the
corresponding button on the sidebar.
■ The cut along streamtrace tool, which generates 1D cuts along streamtraces. This feature
is accessed from the menu Slicer > Cut Along Streamtrace.
■ The tools to extract data on arbitrary points or along polylines. These features are accessed
from the menu Data > Extract.
Cut Destination Frame

Two-dimensional cuts are always displayed in a new frame. To display 1D cuts, Tecplot
searches a frame that is in XY mode and that has the appropriate variable assigned to the x-
axis. If such a frame is found, it is used to display the cut. Otherwise, a new frame is generated
for the cut.

H-2013.03
4: Generating Cuts
Cut Destination Frame

H-2013.03
CHAPTER 5 Interface to Sentaurus Process or
Sentaurus Interconnect
This chapter describes the interface to Sentaurus Process or

Sentaurus Interconnect.
The Sentaurus Workbench add-on to Tecplot can communicate directly with Sentaurus Process
or Sentaurus Interconnect. The communication is based on sockets and, therefore, works also
for processes that run on different machines and architectures. In its simplest form, the
interface to either tool transforms Tecplot SV into a visualization back-end for that tool. In its
more advanced use, Tecplot SV also acts as a user interface. A process of Sentaurus Process or
Sentaurus Interconnect is always associated with one Tecplot SV frame. Several processes of
either tool can be attached to a single Tecplot SV process, displaying their data in separate
frames.
Launching or Connecting to Tecplot SV

On the Sentaurus Process or Sentaurus Interconnect side, several commands are related to the
Tecplot interface such as those for starting Tecplot SV, and updating grid and dataset
information. Refer to the Sentaurus Process or Sentaurus Interconnect documentation for a
complete list of commands.
When Tecplot SV is started by either tool, the following occurs:

1. If the environment variable TECPLOT_DISPLAY is set and contains a valid host and port
specification (see Valid Host and Port Specification on page 14), the tool tries to connect
to a running Tecplot process on the specified host and port.
2. If the file .tecplot_display exists in the home directory of the user and if it contains a
valid host and port specification (see Valid Host and Port Specification), the tool tries to
connect to a running Tecplot process on the specified host and port. The
file .tecplot_display is created automatically by Tecplot when it is started with the
command-line option -s:ipc, so that when a Tecplot process is running, all subsequently
started processes of Sentaurus Process or Sentaurus Interconnect connect to this Tecplot
process.
3. If the environment variable TECPLOT_DISPLAY is set and contains a valid host and port
specification, the tool tries to launch a Tecplot process on the specified host and port.

H-2013.03
5: Interface to Sentaurus Process or Sentaurus Interconnect
Controlling Sentaurus Process or Sentaurus Interconnect from Tecplot SV
4. Sentaurus Process or Sentaurus Interconnect tries to connect to a running Tecplot process

on the default host and port. The default host is the local host and the default port is 2203.
The default host and port can be changed in the command file of the tool.
5. Sentaurus Process or Sentaurus Interconnect tries to launch a running Tecplot process on
the default host and port.
Valid Host and Port Specification

The socket connection requires a host name and a port to be specified. Valid port numbers are
integers greater than 1023. The upper limit for the port number is system dependent, but port
numbers up to 5000 are safe.
When Sentaurus Process or Sentaurus Interconnect checks the environment variable

TECPLOT_DISPLAY or the file .tecplot_display, it expects the host name and port
specification in one of the following forms:
■ host:port
■ host (the default port 2203 is used)
■ :port (the default localhost is used)
Controlling Sentaurus Process or Sentaurus Interconnect

from Tecplot SV
When a connection between Tecplot SV and Sentaurus Process or Sentaurus Interconnect has
been established successfully, a dialog box, which is displayed by selecting View > Sentaurus
Interface (see Figure 3), allows you to:
■ Stop and continue a simulation.
■ Single-step through a simulation.
■ Send commands to be executed by the tool (only while the tool is stopped).
■ Detach from and reattach to a process of Sentaurus Process or Sentaurus Interconnect.
Figure 3 Sentaurus Process dialog box

H-2013.03
CHAPTER 6 Measuring Distances
This chapter describes the measuring tool available in Tecplot SV.
Measure Distance Option

The Sentaurus Workbench add-on to Tecplot provides a measuring tool that is available from
the Synopsys sidebar (see Figure 2 on page 5). The tool allows distance to be measured along
a polygonal path, which is entered by using a mouse operation. As an option, the dataset values
and the cumulative distance along the path can be written to a plot file in XY format, for
loading into Inspect.
Measure...
Figure 4 Measure button (left) and output dialog box showing total measured distance
(right)
Using the Measure Distance Option

To use the measure distance option to measure a distance and, optionally, to write extracted
data along the entered path:
1. From the Synopsys sidebar, click the Measure button.
2. Click a start point in the grid.
To enable snap-to-vertex mode, hold the Ctrl key and click.
3. Select another location in the grid as per Step 2.
Optional: Repeat Step 3 to enter a polygonal path.

H-2013.03
6: Measuring Distances
Using the Measure Distance Option
4. Use either the Esc key or the middle mouse button to close the entered path.
The dialog box in Figure 4 (right) is displayed, which indicates the total measured distance
along the entered path.
5. Click OK to finish or Cancel to write the dataset values along the entered path to a file.
This file can be loaded into Inspect.
By default, the measuring tool is disabled after a measurement has been made, that is, the
standard Selector tool is reactivated. This behavior can be changed by a global preference
setting, so that the measuring tool remains active after a measurement (see Preferences on
page 19).

H-2013.03
CHAPTER 7 Utilities and Preferences
This chapter presents the various utilities and the options available
from the Preferences dialog box.
Updating Data
The Sentaurus Workbench add-on to Tecplot allows for manual or automatic updating of data
on grids that are already loaded into a frame. This functionality is available from the Synopsys
menu bar (see Figure 5).
File > Auto Update
Figure 5 Updating of data dialog box
Under the File menu, the available options are:
Quick Data Update Rereads the most recently loaded data file.
Update Data Displays a file selection dialog box to update from a user-specified
data file.
Auto Update Displays a dialog box that allows users to select a time interval (in
seconds) at which the most recently loaded data file is reread
automatically.
Customizing Contour Levels

Contour levels are used to generate contour plots. Usually, the contour levels are calculated
automatically so that they are evenly distributed within the value range of the active variable.
The ‘Custom Contour Level’ feature adds the possibility to specify user-defined contour levels
for particular variables.

H-2013.03
7: Utilities and Preferences
Customizing Contour Levels
The dialog box shown in Figure 6 is used to create and edit custom contour levels.
1 4
2 5
3 6
Figure 6 Custom Contour Levels dialog box
The following items are key parts of the Custom Contour Levels dialog box:
1. Variables list
Displays the names of the variables having custom contour levels.
2. Input field for variables.
3. Buttons related to variables:
Add: The name in the input field is added as a new custom contouring variable.
Change: The name of the selected variable is changed to the name specified in the input
field.
Dup: Duplicates the selected variable with its custom contour levels. The name of the
copied variable is changed to name.x, where x is a number starting at 1.
Remove: Deletes the selected variable.
4. Values list
Displays the custom contour levels of the selected variables. If more than one variable is
selected, only the values that are common to all selected variables are displayed.
5. Input field for contour levels.
6. Buttons related to contour levels:
Add: A new contour level is added for the selected variable.
Change: The selected contour level is given the value of the input field.
Remove: Deletes the selected contour levels.

H-2013.03
Preferences
Preferences
Many options for customizing Tecplot SV can be set in the Preferences dialog box (Edit >
Preferences) (see Figure 7). These options are saved to the file tecswb.pref in the home
directory of the user. They are restored from this file when Tecplot SV is started.
Edit > Preferences
Figure 7 GUI preferences tab
GUI Preferences
The available options are:
Reset Mouse Mode After

Selects whether the mouse mode is reset to the Initial Mouse Mode
after an operation is finished.
List Display
List coordinate variables

Lists the coordinate variables in the Variables list.
List vector components
Lists the vector components in the Variables list.

H-2013.03
Preferences
List complex components

Lists the real and imaginary parts of complex, valued datasets in the
Variables list.
Sort variables alphabetically
Sorts the Variables list alphabetically.
List variables of selected regions
Lists only variables that are valid in the selected regions.
List regions by properties
Lists the material properties in the Region list.
Initial Mouse Mode Sets the initial mouse mode.
Rotation Mode Sets the rotation mode.
Zone Name Sets the zone name template. Refer to Syntax of Name Templates
for more information.
Variable Name Sets the variable name template. Refer to Syntax of Name
Templates for more information.
Curve Name Sets the curve name template. Refer to Syntax of Name Templates
for more information.
Syntax of Name Templates

A name template is a rule that defines how Tecplot SV composes a name. This is especially
useful for naming xy curves, because many curves are often plotted on top of each other and
need to be distinguished by name. A name template can contain:
■ Normal text, that is, text that appears in the name as it is.
■ Auxiliary data patterns, that is, placeholders that are replaced with actual values. Auxiliary
data is a set of key = value pairs that is associated with curves and other Tecplot objects.
An auxiliary data pattern is a key enclosed in braces. The key can be followed by a set of
formatting parameters enclosed in parentheses.
■ Special control strings: A single question mark means that the value of the following
pattern will be used only if it is not contained in the value of the previous pattern. Two
question marks mean that the value of the following pattern will be used only if it is not
contained in the preceding part of the name. The string “?^” means that the following
pattern is used only if the previous pattern resulted in an empty string.

H-2013.03
Preferences
NOTE To find out which auxiliary data is available, select from the menu Data
> Data Set Info, then click the Aux Data tab.
Examples
1. Assuming that the auxiliary data Tdr.Dataset.Quantity is available:
Name template: Quantity: {Tdr.Dataset.Quantity}
Curve name: Quantity: eQuasiFermiPotential
2. Compose names using several auxiliary data items:

Name template: {Tdr.Dataset.Quantity} [{Tdr.Dataset.Unit}]
Curve name: eQuasiFermiPotential [V]
3. Use parameters to format the name (refer to a list of available parameters):

Name template: {Tdr.Dataset.Quantity(abbreviate, begin=5, mid=3)
Curve name: eQuasFerPot
Table 4 Parameters for auxiliary data patterns

Parameter Comment Example
abbreviate Enables abbreviation of the string {Tdr.Dataset.Quantity(abbreviate)}

using the parameters begin, Result: eQuasFerPot
mid, and end.
alter Alternate string that is displayed Tdr.Dataset.Whatever(alter="NoName")
if the auxiliary data does not Result: NoName
exist. Default: Empty string.
append String that is appended to the {Tp.Slice.Normal(append=" = "}

result if the auxiliary data exists. {Tp.Slice.Position(begin=4)}
Default: Empty string. Result: X = 3.215
begin Number of characters taken for {Tdr.Dataset.Quantity(abbreviate, begin=1)}

the beginning of the string. Result: eFermiPotential
Default: 5.
end Number of characters taken for {Tdr.Dataset.Quantity(abbreviate, end=3)}

the end of the string. Default: 0. Result: eQuasFerPot..ial
end-separator String that separates the end part. {Tdr.Dataset.Quantity(abbreviate, end=3,

Default: “..”. end-separator="-")}
Result: eQuasFerPot-ial
mid Number of characters taken for {Tdr.Dataset.Quantity(abbreviate, mid=1)}

intermediate parts of the string. Result: eQuasFP
Default: 3.
mid-separator String that separates intermediate {Tdr.Dataset.Quantity(abbreviate,

parts. Default: Empty string. mid-separator="'")}
Result: eQuas’Fer’Pot

H-2013.03
Preferences
Table 4 Parameters for auxiliary data patterns

Parameter Comment Example
prepend String that is prepended to the {Tdr.Dataset.Quantity(abbreviate,

result if the auxiliary data exists. prepend="Quantity: ")}
Default: Empty string. Result: Quantity: eQuasFerPot
Load Preferences
Figure 8 Load preferences tab
General Options
Load in local coordinates

Loads grid files in local coordinates, that is, does not apply any
coordinate transform that can be defined in the file. The command-
line options -s:lc and -s:gc override this setting (see Loader
Options on page 47).
Allow .lpk files on command line
Loads Tecplot package files from the command line. The
command-line option -s:lpk overrides this setting (see Loader
Options on page 47).
Reset range after loading
Resets the contour range after a file is loaded.

H-2013.03
Preferences
Create Variables
Vector components Selects whether variables are created for each component of a
vector dataset.
Vector norm Selects whether a variable is created and initialized with the vector
norm for a vector dataset.
Complex components Selects whether variables are created for the real and imaginary
parts of a complex dataset.
Complex norm Selects whether a variable is created and initialized with the
complex norm for a complex dataset.
Data Type Size
Coordinates Selects which Tecplot data type is used to represent coordinates:

Small: Single precision.
Big: Double precision.
Automatic: Same precision as in file.
Variables Selects which Tecplot data type is used to represent variables:
Small: Single precision.
Big: Double precision.
Automatic: Same precision as in file.
Other Options
Particle expansion level

Sets the expansion level when reading particles from a kinetic
Monte Carlo simulation. Large values cause more zones to be
generated for individual particle types.
Advanced Opens a preference dialog box with advanced options for specific
data loaders (see Advanced: Load DF–ISE Preferences on page 24
and Advanced: Load TDF/TIF Preferences on page 25).

H-2013.03
Preferences
Advanced: Load DF–ISE Preferences
Figure 9 Load DF–ISE preferences tab
Do not load extra grid files without data

Loads grid files that have been specified twice or more on the
command line only once.
Ignore mismatching validity regions in data files
Allows data files with validity regions that do not match the regions
of the grid file.
Skip validity region checks in data file (speed-up)
Omits checking of validity regions in data files, which causes
significantly faster loading.
Load data in single precision
Loads data variables in single precision. This option applies only if
the original DF–ISE loader is used.
Use original DF–ISE loader (no TDR conversion)
Selects the original DF–ISE loader for loading DF–ISE files. Even
though this loads faster than other loaders, it is not recommended to
use the original DF–ISE loader1.
1. The original DF–ISE loader reads data into separate Tecplot datasets, which cause some restrictions. Separate
datasets cannot be merged, and it is not possible to operate on data from different datasets using the Tecplot
equation editor.

H-2013.03
Preferences
Advanced: Load TDF/TIF Preferences
Figure 10 Load TDF/TIF preferences tab
Ignore ambient regions

Ignores ambient regions.
Ignore conductor regions

Ignores conductor regions.
Ignore non-datex quantities
Ignores quantities that are not defined in the datexcodes.txt
file.
Split rectangles Splits rectangles into triangles while loading.

H-2013.03
Preferences
Layout Preferences
Figure 11 Layout preferences tab
Page Borders Sets the page borders in centimeters.

Space Between Frames
Sets the space between frames in centimeters.
Rearrange layout after frame deletion
Rearranges the layout after a frame is deleted.
Rearrange layout after loading
Rearranges the layout after a file is loaded.
Fit view after rearranging the layout
Fits the frame view after the layout has been rearranged.
Enable interactive swapping of frames
Enables the swapping of frames by selecting a frame and moving it
over a second frame.

H-2013.03
Preferences
Frame Preferences
Figure 12 Frame preferences tab
New Frames
Transparent Makes new frames transparent.

With borders Displays new frames with borders.
With headers Displays new frames with headers.
Frame Linking
View Links the view properties after loading data.

Contour levels Links the contour levels after loading data.
Display link state Displays the link state icon in each frame.
Other Options
Propagate Style Changes

Propagates style changes that would usually apply only to the
current frame. For example, disabling the frame header would
usually affect only the current frame. With the Propagate Style
Changes option selected, the same operation disables the header for
all frames.

H-2013.03
Preferences
Plot Preferences
Figure 13 Plot preferences tab
Initial Display
Grid Displays grid lines initially.

Contacts Displays contacts initially.
Interfaces Displays interfaces initially.
Junction Displays junctions initially.
Depletion Region Displays depletion regions initially.
Amorphous Interface Displays amorphous–crystalline interfaces initially.
Line Width [% of Frame]
Grid Sets the width of grid lines.

Contact Sets the width of contact lines.
Interface Sets the width of interface lines.
Junction Sets the width of junction lines.
Depletion Region Sets the width of depletion region contours.
Amorphous Interface Sets the width of amorphous–crystalline interfaces.

H-2013.03
Preferences
Other Options
Translucency value Sets the translucency value.

Specular reflection in 3D plots
Enables specular reflection in 3D plots.
Advanced Opens a preference dialog box with advanced options for specific
plots (see Advanced: Plot 2D Preferences, Advanced: Plot Contour
Preferences on page 30, and Advanced: Plot XY Preferences on
page 31).
Advanced: Plot 2D Preferences
Figure 14 Plot 2D preferences tab
Display boundaries Displays boundaries initially.

Invert Y-Axis Inverts the y-axis.
Line Width [% of Frame]
Grid Sets the width of grid lines.

Boundary Sets the width of boundary lines.

H-2013.03
Preferences
Advanced: Plot Contour Preferences
Figure 15 Plot Contour preferences tab
Initial Display
Contour lines Displays contour lines.

Contour flood Displays contour flood.
Contour legend Displays the contour legend.
Other Options
Number of contours Sets the number of contour levels.

Include min and max contours
Sets contour levels for the minimum and maximum values of the
contour variable.
Use custom contour levels
Enables or disables the custom contour level feature (see
Customizing Contour Levels on page 17).

H-2013.03
Preferences
Advanced: Plot XY Preferences
Figure 16 Plot XY preferences tab
Initial Display
Legend Displays the curve legend.

Major grid lines Displays major grid lines.
Minor grid lines Displays minor grid lines.
Symbols Displays symbols on curves.
X-Axis title Displays the title on x-axes.
Y-Axis title Displays the title on y-axes.
Other Options
Symbol size Sets the size of symbols on curves.

Line width Sets the line width of curves.
Group curves Groups curves that have the same y-axis variable and the same cut
position.

H-2013.03
Preferences
Slice Preferences
Figure 17 Slice preferences tab
Orthogonal Slicer
Merge zones in 1D cuts

Merges zones in 1D cuts.
Merge zones in 2D cuts
Merges zones in 2D cuts.
Cut active zones only Cuts only the active zones.
Cut Along Boundary
Initial direction clockwise

Sets the initial cut path direction.
Initial arrow length Sets the initial length of the cut path.
Arrow line width Sets the line width of the cut path.

H-2013.03
Preferences
Dynamic 2D Slicer
Normal direction Sets the normal direction of the slicer.

Automatically open slicer dialog
Opens the slicer dialog box when the slicer is activated.
Enable translucency while slicing
Makes all displayed zones translucent when the slicer is activated.
Disable translucency after slicing
Disables translucency for all zones after slicing.
Miscellaneous Preferences
Figure 18 Miscellaneous preferences tab
Export for Inspect
Confirm overwrite of files

Displays a warning before a file is overwritten.
Start Inspect Starts Inspect with the exported data.
Choose how variables are grouped
Selects how variables are grouped when exported to Inspect.

H-2013.03
Preferences
Export Frame Movie
File type Selects the type of export file.

Image width Sets the width of the movie.
Animation speed Sets the animation speed in frames per second.
Antialiasing Enables antialiasing for exported images.
Image type Selects the image type (only for Flash export files).
Quality Sets the image quality (only for JPEG image types).
Optimize for speed Sets the file compression type (only for True Color image types).
Optimize for size Sets the image quality (only for True Color image types).

H-2013.03
CHAPTER 8 Automating Tasks
This chapter presents the macro language and the macro commands
that can be used in Tecplot.
Example
Tecplot provides a powerful macro language, which is described in the Tecplot 360™ Scripting
Guide.
The following example demonstrates how multiple data files are loaded consecutively to
generate a sequence of pictures for a movie:
#!MC 900
$!INTERFACE AUTOREDRAWISACTIVE = NO
$!VARSET |FIRSTFRAME| = 1
$!LOOP 20
$!VARSET |NUM| = (|Loop|-1)
$!VARSET |FNAME| = "data_|NUM%04d|.dat"
$!FRAMECONTROL DELETETOP
$!DRAWGRAPHICS FALSE
$!READDATASET '"./mesh.grd" "./|FNAME|"'
DATASETREADER = 'SWB-Loader'
$!READSTYLESHEET "./movie.sty"
INCLUDEPLOTSTYLE = YES
INCLUDETEXT = NO
INCLUDEGEOM = NO
INCLUDESTREAMPOSITIONS = NO
INCLUDECONTOURLEVELS = YES
MERGE = NO
INCLUDEFRAMESIZEANDPOSITION = YES
$!DRAWGRAPHICS TRUE
$!REDRAWALL
$!IF |FIRSTFRAME| == 1
$!EXPORTSETUP
EXPORTFORMAT = AVI
EXPORTFNAME = './movie.avi'
IMAGEWIDTH = 800
$!EXPORTSTART
$!VARSET |FIRSTFRAME| = 0
$!ENDIF
$!IF |FIRSTFRAME| == 0

H-2013.03
8: Automating Tasks
Macro Language Extensions
$!EXPORTNEXTFRAME
$!ENDIF
$!ENDLOOP
$!EXPORTFINISH
In this example, the files data_0001.dat...data_0019.dat are loaded consecutively

with the grid file mesh.grd. Each time a new file is loaded, the graphic styles are read from
the style file movie.sty to enforce the same display settings for all pictures. Style files can be
generated by using File > Export > Frame Style.
A macro such as the one shown here is best generated by using File > Macro > Record. After
the main steps have been recorded, the generated macro file can be edited and complemented
with programming constructs. After a macro file has been created, the macro file can be either
executed from within the Tecplot GUI or specified in the command line:
tecplot_sv -p test.mcr
NOTE Certain macro commands (such as exporting raster graphics) work in

batch mode only if Tecplot SV is started with the option -mesa.

The Sentaurus Workbench add-on to Tecplot defines several additional macro commands.
These are described in the following sections. The common syntax for all add-on-specific
macros is:
$!ADDONCOMMAND
ADDONID = 'Sentaurus Workbench Add-on'
COMMAND = '<Macro Name> <Macro Arguments>'
EXPORT_INSPECT
Exports xy curves for loading with Inspect.
Syntax
EXPORT_INSPECT <file-basename>
Arguments
file-basename Base name of the output file. Tecplot creates a separate file for
each region and appends the region and material names to the base
name.

H-2013.03
8: Automating Tasks
EXTRACT_CONTOUR_TO_FILE
Extracts the isoline for a specified value of a variable and writes the resulting polygon to a file.
Syntax
EXTRACT_CONTOUR_TO_FILE <variable-name> <isovalue> <filename>
Arguments
variable-name Name of Tecplot variable.

isovalue Value for which the contour line is produced.
filename Name of the output file.
EXTRACT_DATA_POINT
Extracts the value of a variable at a specified point. The result is printed and stored in the macro
variable EXTRACTED_DATA_VALUE.
Syntax
EXTRACT_DATA_POINT <variable-name> <x> <y> <z> [snap]
Arguments
variable-name Tecplot variable name.

x, y, z Coordinate values.
snap Optional argument. If it is specified, the value of the nearest grid
point is extracted.

H-2013.03
8: Automating Tasks
GET_COLOR
Finds or creates the specified color and writes its index into the specified macro variable.
Syntax
GET_COLOR <color-specification> <macro-variable>
Arguments
color-specification Color name or RGB value in hexadecimal notation, for example,

#FF2A00.
macro-variable Name of the macro variable that holds the result.
GET_VARNUM_BY_TDR_NAME
Obtains the variable number associated with the specified name of the TDR dataset and assigns
it to a Tecplot macro variable.
Syntax
GET_VARNUM_BY_TDR_NAME <dataset-name> <macro-variable>
Arguments
dataset-name Name of TDR dataset.

macro-variable Tecplot macro variable.

H-2013.03
8: Automating Tasks
GET_VARNUM_BY_TDR_QUANTITY
Obtains the variable number associated with the specified TDR quantity name and assigns it to
a Tecplot macro variable.
Syntax
GET_VARNUM_BY_TDR_QUANTITY <dataset-quantity> <macro-variable>
Arguments
dataset-quantity TDR dataset quantity.

GET_ZONENUM_BY_TDR_REGION_NAME
Obtains the zone number associated with the specified TDR region name and assigns it to a
Tecplot macro variable.
Syntax
GET_ZONENUM_BY_TDR_REGION_NAME <region-name> <macro-variable>
Arguments
region-name Name of TDR region.


H-2013.03
8: Automating Tasks
INTEGRATE
Calculates the integral of a variable over a specified set of zones. The results are printed. The
total integral is also stored in the macro variable INTEGRAL.
Syntax
INTEGRATE <variable-name> [<zone-set>] [NAME = <user-string>]
Arguments
variable-name Name of the integration variable.

zone-set Optional zone specification in the standard Tecplot notation, for
example, [1, 2, 4-7, 10]. If the zone specification is missing,
the integral is evaluated for all zones.
user-string Optional string that is appended to the DOE output.
INTEGRATE_CURVE
Calculates the integral of an X-Y mapping f(x) over a specified range of the independent
variable. The results are printed. The total integral is also stored in the macro variable
INTEGRAL.
Syntax
INTEGRATE_CURVE <integration-variable> <independent-variable>
[ZONES = <zone-set>]
[RANGE_MIN = <range-min>]
[RANGE_MAX = <range-max>]
[NAME = <user-string>]
Arguments
integration-variable Name of the integration variable.

independent-variable Name of the independent variable.
zone-set Optional zone specification in the standard Tecplot notation, for
example, [1, 2, 4-7, 10]. If the zone specification is missing,
the integral is evaluated for all zones.

H-2013.03
8: Automating Tasks
range-min Optional lower limit of the independent variable. The default value
is -1E300.
range-max Optional upper limit of the independent variable. The default value
is +1E300.
user-string Optional string that is appended to the DOE output.
ORTHOSLICE
Creates an orthogonal slice at a specific location in one or several frames.
Syntax
ORTHOSLICE <normal-direction> <location> <frame-names>
Arguments
normal-direction Specifies X, Y, or Z to define the direction normal to the slice

plane.
location The coordinate value along the normal direction axis.
frame-names Comma-separated list of frame names. The special names
‘Active,’ ‘All2D,’ and ‘All3D’ can be used to specify the current
frame, all two-dimensional frames, or all three-dimensional
frames, respectively.
SET_CONTOUR
Sets the contour options.
Syntax
SET_CONTOUR VAR_NUM=<variable-number> | VAR_NAME=<variable-name>
RANGE_MIN=<lower-limit>
RANGE_MAX=<upper-limit>
NUM_LEVELS=<number-of-levels>
SCALE=<lin | log | asinh>

H-2013.03
8: Automating Tasks
Arguments
VAR_NUM Number of the contour variable.

VAR_NAME Name of the contour variable.
RANGE_MIN Lower limit of the contour range.
RANGE_MAX Upper limit of the contour range.
NUM_LEVELS Number of contour levels.
SCALE Scale used to calculate contour levels.
SET_PREFERENCE
Sets a preference option.
Syntax
SET_PREFERENCE <name> <value>
Arguments
name Name of the preference option. Valid names can be found in the
preferences file tecswb.pref, which is stored in the home
directory of the user.
value Value of the preference option.
SLICEMODE
Specifies whether the orthogonal slicer merges zones or keeps the zone structure of the original
grid.
Syntax
SLICEMODE MergedZones | SeparateZones

H-2013.03
8: Automating Tasks
UPDATE_DATA
Updates Tecplot internal data by reading from the specified file.
Syntax
UPDATE_DATA <file-name>
Arguments
file-name Name of the file to be read.

H-2013.03
8: Automating Tasks

H-2013.03
APPENDIX A Command Options
This appendix provides information about command options.
Command Line
tecplot_sv [-v] [-h] [-s:...] [tecplot-options] list-of-files
General Options
-h Prints help information.
-v Prints program version information.
Launcher Options
-batch Runs in batch mode (same as Tecplot option -b).
-s:addon_version <x.y.z> Specifies the version of the add-on that should be loaded.
-s:archoslib <path> Specifies the path to the add-on library.
-s:env <NAME=value> Sets the specified environment variable before launching
Tecplot.
-s:home <dirname> Specifies the Tecplot home directory, overriding the value of
$TECHOME. This is a replacement for the Tecplot command-
line option -h.
-s:ipc Enables interprocess communication (IPC), which is required
if Tecplot accepts connection requests from Sentaurus Process.
-s:no_addons Does not load the Synopsys TCAD add-ons by default.
Usually, the add-ons are loaded automatically using
-loadaddon options in the Tecplot command line.

H-2013.03
A: Command Options
Launcher Options
-s:no_appdef Does not use the app-defaults file specific to Synopsys by

default. Usually, the tecplot_sv launcher modifies the
environment in such a way that the version of the Tecplot
app-defaults file specific to Synopsys is loaded instead of
the standard app-defaults file from the Tecplot installation
directory.
-s:no_config Does not load the configuration file specific to Synopsys by
default. Usually, the tecplot_sv launcher adds a -c option to
the Tecplot command line, such that the version of the
tecplot.cfg file specific to Synopsys is loaded instead of
the standard config file from the Tecplot installation
directory.
-s:no_reader Does not use the Sentaurus Workbench loader (SWB-Loader)
by default. Usually, the tecplot_sv launcher adds a
-datasetreader option to the Tecplot command line, such
that all specified files are loaded using the Sentaurus
Workbench loader.
-s:rootlib <path> Specifies the path to the root library.
-s:stdaddons Allows for the loading of standard Tecplot add-ons as defined
in the tecplot.add file in the Tecplot home directory
$TECHOME.
-s:stdphyfile Enables the standard mechanism for the tecplot.phy file
location.
-s:us_config Uses U.S. versions of config and app-defaults files. This
sets a different default paper size (U.S. letter).
-s:wait_dialogs Enables display of transient dialog boxes in Tecplot. Such
dialog boxes are used to indicate progress during some
operations. The configuration specific to Synopsys disables
transient dialog boxes because, on some platforms and with
some window managers, they can cause windows to remain
locked on the screen.

H-2013.03
A: Command Options
Loader Options
Loader Options
-s:append Appends file to the previous frame.
-s:f <Inspect cmd file> Runs the specified Inspect command file.
-s:fast_scan Disables expensive grid file–matching or data file–matching
tests.
-s:g <geometry index or Selects only the specified geometries from the TDR file.
name>
-s:gc Reads files in global coordinate mode. This option can be

specified any number of times in the command line so as to
enable switching from local coordinate mode to global
coordinate mode.
-s:ignore_regions_mismatch Allows data files to be paired with grid files even if the number
of regions does not correspond in both files.
-s:lc Reads geometry and grid files in local coordinate mode. This is
the default. This option can be specified any number of times in
the command line so as to enable switching from global
coordinate mode to local coordinate mode.
-s:lpk Accepts Tecplot package files.
-s:multi_load Does not suppress extra grid files; loads them without data.
-s:nc Reads native coordinates from a TDR file (this is the default).
-s:new Creates a new frame for each file.
-s:nu Reads datasets in native units from a TDR file.
-s:psf <particle skip> Globally overrides the particle selection factor when reading
kinetic Monte Carlo (KMC) data.
-s:rc Transforms grids to reference coordinates when reading from a
TDR file.
-s:ru Transforms datasets to reference units when reading from a
TDR file (this is the default).
-s:s <state index or name> Selects only the specified states from the TDR file.

H-2013.03
A: Command Options
Tecplot Options
Tecplot Options
Any option that is not identified as a tecplot_sv option is transferred to Tecplot. Refer to the
Tecplot 360™ User’s Manual for an explanation of all Tecplot options.
Environment Variables
TEC_GRID_DEBUGGING If set, this causes an additional variable named VertexIndex to
be created and initialized with the global vertex number. This is
useful for debugging purposes. To look up a vertex index, use
the Data Probe tool or switch on the Tecplot data-labeling
feature:
1. Plot > Label Points and Cells.
2. Select the Show Node Labels option.
3. Select the Show Variable Value option, choosing the
variable VertexIndex for labeling.
TP_CLIENT_WAIT_TIMEOUT Sets the time (in seconds) that a client waits for Tecplot to start
up and establish a connection. The default value is 40.
TP_CLIENT_CONNECT_TIMEOUT Sets the time (in seconds) that a client waits when trying to
connect to a running Tecplot server.

H-2013.03
Glossary
Some important terms are used in other Synopsys TCAD documents, which have different
meanings in the context of Tecplot, as Tecplot is not a Synopsys tool. These are explained here.
D
dataset versus variable
‘Dataset’ in TDR format corresponds to a ‘variable’ in Tecplot. In Tecplot language, the
‘dataset’ is the top-level data structure that contains the complete information on the grid
with its associated data.
R
region versus zone
‘Region’ in Synopsys language corresponds in most cases to a ‘zone’ in Tecplot language.
Tecplot can display each zone with its individual graphic styles. The TDR loader maps
parts to zones.

H-2013.03
Glossary
R

H-2013.03

Tecplotsv Ug

Uploaded by

Copyright:

Available Formats

Tecplotsv Ug

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Tecplotsv Ug

Uploaded by

Copyright:

Available Formats

Tecplot SV User Guide

Version H-2013.03, March 2013

ii Tecplot SV User Guide

Chapter 1 Getting Started 1

Chapter 2 Loading Files 3

Chapter 3 Synopsys Sidebar 5

Chapter 4 Generating Cuts 11

Tecplot SV User Guide iii

Chapter 5 Interface to Sentaurus Process or Sentaurus Interconnect 13

Chapter 6 Measuring Distances 15

Chapter 7 Utilities and Preferences 17

Chapter 8 Automating Tasks 35

iv Tecplot SV User Guide

Appendix A Command Options 45

Tecplot SV User Guide v

vi Tecplot SV User Guide

The main chapters are:

1. Tecplot is a registered trademark of Tecplot, Inc., Bellevue, WA, U.S.A.

Tecplot SV User Guide vii

Blue text Identifies a cross-reference (only on the screen).

NOTE Identifies important information.

viii Tecplot SV User Guide

Contacting Synopsys Support

Tecplot SV User Guide ix

Contacting Your Local TCAD Support Team Directly

x Tecplot SV User Guide

This chapter presents basic information about starting Tecplot SV.

Synopsys provides an original equipment manufacturer (OEM) distribution of Tecplot that

Main Tecplot Window

Figure 1 Tecplot main window (detail)

Tecplot SV User Guide 1

Starting Tecplot SV from the Command Prompt

Starting Tecplot SV from Sentaurus Workbench

General Recommendations for Effective Use of Tecplot SV

2 Tecplot SV User Guide

This chapter describes how to load files.

Tecplot SV User Guide 3

4 Tecplot SV User Guide

This chapter discusses the different available sidebars.

Displaying Tecplot Sidebar

The available sidebar layouts are displayed in Figure 2.

Figure 2 Available sidebar layouts

Tecplot SV User Guide 5

Common Components of Synopsys Sidebar

Table 1 Common elements of Synopsys sidebar

Load Loads files.

Reset Resets display properties.

Previous Frame Activates the previous frame.

Next Frame Activates the next frame.

Fit Fits contents to the full size of the frame.

Measure Enables the distance measuring mode.

Integrate Integrates the selected variable over the selected zones.

6 Tecplot SV User Guide

Table 1 Common elements of Synopsys sidebar

Sidebar in 2D/3D Mode

Table 2 Synopsys sidebar in 2D and 3D mode

Variable list The selected variable is used for contouring.

Contour Legend Enables or disables the display of the contour legend.

Tecplot SV User Guide 7

Table 2 Synopsys sidebar in 2D and 3D mode