tecplot svjmbussat/physics290e/fall-2006/tcad_documentati… · convention explanation blue text...

Tecplot SVVersion Y-2006.06, June 2006

ii

Copyright Notice and Proprietary InformationCopyright © 2006 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.

Right to Copy DocumentationThe license agreement with Synopsys permits licensee to make copies of the documentation for its internal use only. Each copy shall include all copyrights, trademarks, service marks, and proprietary rights notices, if any. Licensee must assign sequential numbers to all copies. These copies shall contain the following legend on the cover page:

“This document is duplicated with the permission of Synopsys, Inc., for the exclusive use of __________________________________________ and its employees. This is copy number __________.”

Destination Control StatementAll 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.

DisclaimerSYNOPSYS, 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.

Registered Trademarks (®)Synopsys, AMPS, Arcadia, C Level Design, C2HDL, C2V, C2VHDL, Cadabra, Calaveras Algorithm, CATS, CRITIC, CSim, Design Compiler, DesignPower, DesignWare, EPIC, Formality, HSIM, HSPICE, Hypermodel, iN-Phase, in-Sync, Leda, MAST, Meta, Meta-Software, ModelTools, NanoSim, OpenVera, PathMill, Photolynx, Physical Compiler, PowerMill, PrimeTime, RailMill, RapidScript, Saber, SiVL, SNUG, SolvNet, Superlog, System Compiler, TetraMAX, TimeMill, TMA, VCS, Vera, and Virtual Stepper are registered trademarks of Synopsys, Inc.

Trademarks (™)Active Parasitics, AFGen, Apollo, Apollo II, Apollo-DPII, Apollo-GA, ApolloGAII, Astro, Astro-Rail, Astro-Xtalk, Aurora, AvanTestchip, AvanWaves, BCView, Behavioral Compiler, BOA, BRT, Cedar, ChipPlanner, Circuit Analysis, Columbia, Columbia-CE, Comet 3D, Cosmos, CosmosEnterprise, CosmosLE, CosmosScope, CosmosSE, Cyclelink, Davinci, DC Expert, DC Professional, DC Ultra, DC Ultra Plus, Design Advisor, Design Analyzer, Design Vision, DesignerHDL, DesignTime, DFM-Workbench, Direct RTL, Direct Silicon Access, Discovery, DW8051, DWPCI, Dynamic-Macromodeling, Dynamic Model Switcher, ECL Compiler, ECO Compiler, EDAnavigator, Encore, Encore PQ, Evaccess, ExpressModel, Floorplan Manager, Formal Model Checker, FoundryModel, FPGA Compiler II, FPGA Express, Frame Compiler, Galaxy, Gatran, HANEX, HDL Advisor, HDL Compiler, Hercules, Hercules-Explorer, Hercules-II, Hierarchical Optimization Technology, High Performance Option, HotPlace, HSIMplus, HSPICE-Link, iN-Tandem, Integrator, Interactive Waveform Viewer, i-Virtual Stepper, Jupiter, Jupiter-DP, JupiterXT, JupiterXT-ASIC, JVXtreme, Liberty, Libra-Passport, Library Compiler, Libra-Visa, Magellan, Mars, Mars-Rail, Mars-Xtalk, Medici, Metacapture, Metacircuit, Metamanager, Metamixsim, Milkyway, ModelSource, Module Compiler, MS-3200, MS-3400, Nova Product Family, Nova-ExploreRTL, Nova-Trans, Nova-VeriLint, Nova-VHDLlint, Optimum Silicon, Orion_ec, Parasitic View, Passport, Planet, Planet-PL, Planet-RTL, Polaris, Polaris-CBS, Polaris-MT, Power Compiler, PowerCODE, PowerGate, ProFPGA, ProGen, Prospector, Protocol Compiler, PSMGen, Raphael, Raphael-NES, RoadRunner, RTL Analyzer, Saturn, ScanBand, Schematic Compiler, Scirocco, Scirocco-i, Shadow Debugger, Silicon Blueprint, Silicon Early Access, SinglePass-SoC, Smart Extraction, SmartLicense, SmartModel Library, Softwire, Source-Level Design, Star, Star-DC, Star-MS, Star-MTB, Star-Power, Star-Rail, Star-RC, Star-RCXT, Star-Sim, Star-SimXT, Star-Time, Star-XP, SWIFT, Taurus, TimeSlice, TimeTracker, Timing Annotator, TopoPlace, TopoRoute, Trace-On-Demand, True-Hspice, TSUPREM-4, TymeWare, VCS Express, VCSi, Venus, Verification Portal, VFormal, VHDL Compiler, VHDL System Simulator, VirSim, and VMC are trademarks of Synopsys, Inc.

Service Marks (SM)MAP-in, SVP Café, and TAP-in are service marks of Synopsys, Inc.

SystemC is a trademark of the Open SystemC Initiative and is used under license.ARM and AMBA are registered trademarks of ARM Limited.All other product or company names may be trademarks of their respective owners.

Tecplot SV, Y-2006.06

TECPLOT SV CONTENTS

Tecplot SV

About this manual .................................................................................................................................vAudience ..............................................................................................................................................................vRelated publications.............................................................................................................................................vTypographic conventions .................................................................................................................................... viCustomer support................................................................................................................................................ vi

Chapter 1 Getting started .....................................................................................................................1Main Tecplot window............................................................................................................................................1Starting Tecplot SV from the command prompt ...................................................................................................2Starting Tecplot SV from Sentaurus Workbench .................................................................................................2General recommendations for effective use of Tecplot SV..................................................................................2

Chapter 2 Loading files.........................................................................................................................3File loader ............................................................................................................................................................3

Mapping coordinates ......................................................................................................................................3Mapping datasets.................................................................................................................................................4

Chapter 3 Synopsys sidebar ................................................................................................................5Displaying Tecplot sidebar ...................................................................................................................................5Common components of Synopsys sidebar.........................................................................................................6Sidebar in 2D/3D mode........................................................................................................................................7Sidebar in XY mode .............................................................................................................................................9

Chapter 4 Generating cuts .................................................................................................................11Cutting tools .......................................................................................................................................................11Cut destination frame.........................................................................................................................................11

Chapter 5 Interface of Sentaurus Process........................................................................................13Launching or connecting to Tecplot SV from Sentaurus Process......................................................................13

Valid host and port specification...................................................................................................................14Controlling Sentaurus Process from Tecplot SV................................................................................................14

Chapter 6 Measuring distances .........................................................................................................15Using the measure distance option....................................................................................................................15

Chapter 7 Utilities and preferences ...................................................................................................17Updating data.....................................................................................................................................................17Customizing contour levels ................................................................................................................................17Preferences........................................................................................................................................................19

GUI preferences ...........................................................................................................................................19Syntax of name templates.....................................................................................................................20

Load preferences .........................................................................................................................................21Advanced: Load DF–ISE preferences...................................................................................................23Advanced: Load TDF/TIF preferences..................................................................................................24

Layout preferences.......................................................................................................................................24Frame preferences .......................................................................................................................................25Plot preferences ...........................................................................................................................................26

Advanced: Plot 2D preferences ............................................................................................................27Advanced: Plot Contour preferences ....................................................................................................28Advanced: Plot XY preferences ............................................................................................................29

Slice preferences..........................................................................................................................................30Miscellaneous preferences...........................................................................................................................31

iii

TECPLOT SVCONTENTS

Chapter 8 Automating tasks...............................................................................................................33Macro language extensions ...............................................................................................................................34

EXTRACT_CONTOUR_TO_FILE................................................................................................................34EXTRACT_DATA_POINT ............................................................................................................................34GET_COLOR ...............................................................................................................................................35GET_VARNUM_BY_TDR_NAME................................................................................................................35GET_VARNUM_BY_TDR_QUANTITY ........................................................................................................35GET_ZONENUM_BY_TDR_REGION_NAME .............................................................................................36INTEGRATE.................................................................................................................................................36INTEGRATE_CURVE ..................................................................................................................................37ORTHOSLICE ..............................................................................................................................................37SET_PREFERENCE....................................................................................................................................38SLICEMODE ................................................................................................................................................38UPDATE_DATA ...........................................................................................................................................38

Appendix A Command options..........................................................................................................39General options..................................................................................................................................................39Launcher options................................................................................................................................................39Loader options ...................................................................................................................................................40Tecplot options...................................................................................................................................................40Environment variables........................................................................................................................................41

Glossary ...............................................................................................................................................43

iv

TECPLOT SV ABOUT THIS MANUAL

Tecplot SV

About this manual

Tecplot SV is part of Sentaurus Workbench Visualization. It is plotting software with extensive 2D and3D capabilities for visualizing data from simulations and experiments.

This manual describes the Sentaurus Workbench add-on to Tecplot1. Tecplot is a dedicated software forscientific visualization that Synopsys has extended to accommodate the special requirements of theSynopsys simulation environment. This manual only covers the use of the add-on. Tecplot has its ownset of documentation. If the user cannot find information in this manual, consult the Tecplot User’sManual and Tecplot Reference Manual. It is recommended to visit http://www.tecplot.com for furtherinformation 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 of Sentaurus Process.

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.

AudienceThis manual is intended for users of the Tecplot SV software package.

Related publicationsFor additional information about Tecplot SV, see:

The documentation installed with the Tecplot SV software and available through the Tecplot SVHelp menu.

The Tecplot SV release notes, available on SolvNet (see Accessing SolvNet on page vi).

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

v

TECPLOT SVABOUT THIS MANUAL

Documentation on the Web, which is available through SolvNet athttps://solvnet.synopsys.com/DocsOnWeb.

Synopsys Online Documentation (SOLD), which is included with the software for CD users or isavailable to download through the Synopsys Electronic Software Transfer (EST) system.

Typographic conventions

Customer supportCustomer support is available through SolvNet online customer support and through contacting theSynopsys Technical Support Center.

Accessing SolvNet

SolvNet includes an electronic knowledge base of technical articles and answers to frequently askedquestions about Synopsys tools. SolvNet also gives you access to a wide range of Synopsys onlineservices including software downloads, documentation on the Web, and “Enter a Call to the SupportCenter.”

To access SolvNet:

1. Go to the SolvNet Web page at http://solvnet.synopsys.com.

2. If prompted, enter your user name and password. (If you do not have a Synopsys user name andpassword, follow the instructions to register with SolvNet.)

If you need help using SolvNet, click HELP in the top-right menu bar or in the footer.

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, window, dialog box, or panel.

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.

vi

http://solvnet.synopsys.com/DocsOnWeb

http://solvnet.synopsys.com

TECPLOT SV ABOUT THIS MANUAL

Contacting the Synopsys Technical Support Center

If you have problems, questions, or suggestions, you can contact the Synopsys Technical Support Centerin the following ways:

Open a call to your local support center from the Web by going to http://solvnet.synopsys.com(Synopsys user name and password required), then clicking “Enter a Call to the Support Center.”

Send an e-mail message to your local support center:

• E-mail [email protected] from within North America.

• Find other local support center e-mail addresses at http://www.synopsys.com/support/support_ctr.

Telephone your local support center:

• Call (800) 245-8005 from within the continental United States.

• Call (650) 584-4200 from Canada.

• Find other local support center telephone numbers at http://www.synopsys.com/support/support_ctr.

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.

vii

http://solvnet.synopsys.com

http://www.synopsys.com/support/support_ctr

http://www.synopsys.com/support/support_ctr

TECPLOT SVABOUT THIS MANUAL

viii

TECPLOT SV CHAPTER 1 GETTING STARTED

Tecplot SV

CHAPTER 1 Getting started

Synopsys provides an original equipment manufacturer (OEM) distribution of Tecplot that includes theoriginal Tecplot distribution by Tecplot, Inc., the Synopsys TCAD add-on, and the Synopsys tecplot_svlauncher, which starts Tecplot in a special Synopsys configuration mode. The complete packageconsisting of these three components is called Tecplot SV.

Main Tecplot windowThe main Tecplot window consists of the Synopsys menu bar and sidebar, the status line, and the Tecplotworkspace, which contains a page with frames.

Figure 1 Tecplot main window (detail)

Menu Bar

Sidebar

Workspace

Page

Frame

Status Line

1

TECPLOT SVCHAPTER 1 GETTING STARTED

Starting Tecplot SV from the command promptThe command tecplot_sv is used to start Tecplot from the command prompt, for example:

tecplot_sv n2_dio.grd n2_dio.dat

tecplot_sv is a program that launches the actual Tecplot executable. Most of the original Tecplotcommand-line options pass to Tecplot by tecplot_sv. In addition to those, tecplot_sv has its owncommand-line options (see Appendix A on page 39).

Starting Tecplot SV from Sentaurus Workbenchtecplot_sv is integrated in Sentaurus Workbench so that it can be started by clicking the Tecplot icon, itcan 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 toolflows. In this context, the use of macro files and style files is also of interest. Refer to theTecplot manuals for more information about the macro language and batch processing.

General recommendations for effective use of Tecplot SVThe 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 helpfulinstructions.

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 isrecommended that the Tecplot streamtrace feature is used. Streamtraces are superior to vectors forvisualizing quantities such as the current density field. For detailed information on streamtraces,refer to the Tecplot User’s Manual.

The middle and the right mouse buttons, combined with keys, provide easy access to zoom, pan, androtate 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 CHAPTER 2 LOADING FILES

Tecplot SV

CHAPTER 2 Loading files

This chapter describes how to load grid and data files.

File loaderTo load files in various formats:

File > Load, or click the Load button on the Synopsys sidebar, or specify the files in the tecplot_svcommand line (see Appendix A on page 39).

The loader tries to identify the file types and ignores any files that are not in one of the recognizedformats. The loader recognizes the following file formats:

TDR (this is the new standard format)

DF–ISE

TDF

TIF

IVL

PLX

The loader detects matching grid and data files automatically even if they are not specified in the correctorder. 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 coordinatesSome file types contain a transformation matrix and a translation vector that define a mapping from thelocal coordinates specified in the file to a global coordinate system. By default, the loader does not applythis transformation, so that, for example, a 2D grid is displayed in 2D frame mode with its localx-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 bespecified any number of times to switch between the two modes.

3

TECPLOT SVCHAPTER 2 LOADING FILES

Mapping datasetsWhile loading a data file, the loader creates a Tecplot variable for each dataset. For vector datasets, theloader creates an additional variable called Abs(var-name) and initializes it with the magnitude of thevector 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.

4

TECPLOT SV CHAPTER 3 SYNOPSYS SIDEBAR

Tecplot SV

CHAPTER 3 Synopsys sidebar

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 withthe native Tecplot version may also want to use the native Tecplot sidebar.

Displaying Tecplot sidebarTo display the standard Tecplot sidebar:

View > Tecplot Sidebar.

The available sidebar layouts are displayed in Figure 2.

Figure 2 Available sidebar layouts

2D/3D Mode XY Mode Native Tecplot

5

TECPLOT SVCHAPTER 3 SYNOPSYS SIDEBAR

Common components of Synopsys sidebarTable 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.

Display Link Changes the display of the link state icon inside the frames.

Fit Fits contents to the full size of the frame.

Arrange Distributes frames on the page.

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.

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.

Insert Text Enables or disables the text insert mode for adding text to plots.

6


Sidebar in 2D/3D modeThe 2D/3D part of the sidebar (see Figure 2 on page 5) contains the items listed in Table 2.

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.

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.

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.

Table 1 Common elements of Synopsys sidebar


7


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 Lines

Displays the contour fill and the contour lines of the selected regions.

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 Exclusive

Displays the selected regions exclusively.

Region Display On

Displays the selected regions.

Region Display Off

Hides the selected regions.

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.

Interactive Slicer Enables 3D dynamic slicing.



8


Sidebar in XY modeThe XY part of the sidebar (see Figure 2 on page 5) contains the items listed in Table 3.

Cut Along Boundary

Enables cuts along a 2D boundary.

Value Blanking Enables value blanking.

PN-Junction Changes the display of junction lines.

Depletion Region Changes the display of the contours of the depletion region.

Translucency On Displays translucency of the selected regions.

Translucency Off Hides translucency of the selected regions.

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.

Create Curves Creates permanent curves from all temporary curves.

Region list Lists the regions.

Region Display Exclusive

Displays the selected regions exclusively.



9


Region Display On

Displays the selected regions.

Region Display Off

Hides the selected regions.

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 Styles

Assigns different line styles to the selected curves.

Edit Curves Opens the curve editor.

Delete Curves Deletes the selected curves.

Table 3 The Synopsys sidebar in XY mode


10

TECPLOT SV CHAPTER 4 GENERATING CUTS

Tecplot SV

CHAPTER 4 Generating cuts

This chapter describes how to generate various cut types.

Cutting toolsTecplot 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 thecoordinate axes. This feature is accessed from the menu Slicer > Orthogonal Cut, or from thecorresponding buttons on the sidebar.

The interactive slicer, which is used to drag a 2D slice plane through a 3D volume. This feature isaccessed from the menu Slicer > Interactive Slicer, or from the corresponding button on thesidebar.

The cut along boundary tool, which generates 1D cuts along boundaries of 2D regions. This featureis accessed from the menu Slicer > Cut Along Boundary, or from the corresponding button on thesidebar.

The cut along streamtrace tool, which generates 1D cuts along streamtraces. This feature is accessedfrom the menu Slicer > Cut Along Streamtrace.

The tools to extract data on arbitrary points or along polylines. These features are accessed from themenu Data > Extract.

Cut destination frameTwo-dimensional cuts are always displayed in a new frame. To display 1D cuts, Tecplot searches a framethat 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.

11

TECPLOT SVCHAPTER 4 GENERATING CUTS

12

TECPLOT SV CHAPTER 5 INTERFACE OF SENTAURUS PROCESS

Tecplot SV

CHAPTER 5 Interface of Sentaurus Process

The Sentaurus Workbench add-on to Tecplot can communicate directly with Sentaurus Process. Thecommunication is based on sockets and, therefore, works also for processes that run on differentmachines and architectures. In its simplest form, the interface of Sentaurus Process transformsTecplot SV into a visualization back-end for Sentaurus Process. In its more advanced use, Tecplot SValso acts as a user interface for Sentaurus Process. A process of Sentaurus Process is always associatedwith one Tecplot SV frame. Several processes of Sentaurus Process can be attached to a singleTecplot SV process, displaying their data in separate frames.

Launching or connecting to Tecplot SV from Sentaurus Process

On the Sentaurus Process side, several commands are related to the Tecplot interface such as those forstarting Tecplot SV, and updating grid and dataset information. Refer to the Sentaurus Processdocumentation for a complete list of commands.

When Tecplot SV is started by Sentaurus Process, 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), Sentaurus Process tries to connect to a runningTecplot 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 andport specification (see Valid host and port specification on page 14), Sentaurus Process tries toconnect to a running Tecplot process on the specified host and port. The file .tecplot_display iscreated automatically by Tecplot when it is started with the command-line option -s:ipc, so thatwhen a Tecplot process is running, all subsequently started processes of Sentaurus Process connectto this Tecplot process.

3. If the environment variable TECPLOT_DISPLAY is set and contains a valid host and port specification,Sentaurus Process tries to launch a Tecplot process on the specified host and port.

4. Sentaurus Process tries to connect to a running Tecplot process on the default host and port. Thedefault host is the local host and the default port is 2203. The default host and port can be changedin the command file of Sentaurus Process.

5. Sentaurus Process tries to launch a running Tecplot process on the default host and port.

13

TECPLOT SVCHAPTER 5 INTERFACE OF SENTAURUS PROCESS

Valid host and port specificationThe socket connection requires a host name and a port to be specified. Valid port numbers are integersgreater than 1023. The upper limit for the port number is system dependent, but port numbers up to 5000are safe.

When Sentaurus Process checks the environment variable TECPLOT_DISPLAY or the file .tecplot_display, itexpects 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 from Tecplot SVWhen a connection between Tecplot SV and Sentaurus Process has been established successfully, theSentaurus Process dialog box, which is displayed by using View > Sentaurus Process (see Figure 3),allows users to:

Stop and continue a Sentaurus Process simulation.

Single-step through a Sentaurus Process simulation.

Send commands to be executed by Sentaurus Process (only while Sentaurus Process is stopped).

Detach from and reattach to a process of Sentaurus Process.

Figure 3 Sentaurus Process dialog box

14

TECPLOT SV CHAPTER 6 MEASURING DISTANCES

Tecplot SV

CHAPTER 6 Measuring distances

The Sentaurus Workbench add-on to Tecplot provides a measuring tool that is available from theSynopsys sidebar (see Figure 2 on page 5). The tool allows distance to be measured along a polygonalpath, which is entered by using a mouse operation. As an option, the dataset values and the cumulativedistance along the path can be written to a plot file in XY format, for loading into Inspect.

Figure 4 Measure button (left) and output dialog box showing total measured distance (right)

Using the measure distance optionTo use the measure distance option to measure a distance and, optionally, to write extracted data alongthe 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.

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 alongthe entered path.

5. Click OK to finish or Cancel to write the dataset values along the entered path to a DF–ISE file.This file can be loaded into Inspect.

By default, the measuring tool is disabled after a measurement has been made, that is, the standardSelector tool is reactivated. This behavior can be changed by a global preference setting, so that themeasuring tool remains active after a measurement (see Preferences on page 19).

Measure...

15

TECPLOT SVCHAPTER 6 MEASURING DISTANCES

16

TECPLOT SV CHAPTER 7 UTILITIES AND PREFERENCES

Tecplot SV

CHAPTER 7 Utilities and preferences

This chapter presents the various utilities and the options available from the Preferences dialog box.

Updating dataThe Sentaurus Workbench add-on to Tecplot allows for manual or automatic updating of data on gridsthat are already loaded into a frame. This functionality is available from the Synopsys menu bar (seeFigure 5).

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) atwhich the most recently loaded data file is reread automatically.

Customizing contour levelsContour levels are used to generate contour plots. Usually, the contour levels are calculatedautomatically 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 particularvariables.

File > Auto Update

17

TECPLOT SVCHAPTER 7 UTILITIES AND PREFERENCES

The dialog box shown in Figure 6 is used to create and edit custom contour levels.

Figure 6 Custom Contour Levels dialog box

The following items are key parts of the Custom Contour Levels dialog box:

1. Variables listDisplays 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 copiedvariable is changed to name.x, where x is a number starting at 1.

Remove: Deletes the selected variable.

4. Values listDisplays 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.

1

2

3

4

5

6

18


PreferencesMany 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 arerestored from this file when Tecplot SV is started.

Figure 7 GUI preferences tab

GUI preferencesThe available options are:

Reset Mouse Mode AfterSelects whether the mouse mode is reset to the Initial Mouse Mode after anoperation is finished.

List Display

List coordinate variablesLists the coordinate variables in the Variables list.

List vector componentsLists the vector components in the Variables list.

List complex componentsLists the real and imaginary parts of complex, valued datasets in the Variableslist.

Sort variables alphabeticallySorts the Variables list alphabetically.

List variables of selected regionsLists only variables that are valid in the selected regions.

List regions by propertiesLists the material properties in the Region list.

Edit > Preferences

19


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 moreinformation.

Variable Name Sets the variable name template. Refer to Syntax of name templates for moreinformation.

Curve Name Sets the curve name template. Refer to Syntax of name templates for moreinformation.

Syntax of name templates

A name template is a rule that defines how Tecplot SV composes a name. This is especially useful fornaming XY curves, because many curves are often plotted on top of each other and need to bedistinguished 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 isa set of key = value pairs that is associated with curves and other Tecplot objects. An auxiliary datapattern is a key enclosed in braces. The key can be followed by a set of formatting parametersenclosed in parentheses.

One or two question marks preceding an auxiliary data pattern. A single question mark means thatthe value of the following pattern will be used only if it is not contained in the value of the previouspattern. Two question marks mean that the value of the following pattern will be used only if it isnot contained in the preceding part of the name.

NOTE To find out which auxiliary data is available, select from the menu Data > Data Set Info, thenclick 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(begin=5, mid=3)}

Curve name: eQuasFerPot

20


Load preferences

Figure 8 Load preferences tab

Table 4 Parameters for auxiliary data patterns

Parameter Comment Example

alter Alternate string that is displayed if the auxiliary data does not exist. Default: Empty string.

Tdr.Dataset.Whatever(alter="NoName")Result: NoName

append String that is appended to the result if the auxiliary data exists. Default: Empty string.

{Tp.Slice.Normal(append=" = "}{Tp.Slice.Position(begin=4)}Result: X = 3.215

begin Number of characters taken for the beginning of the string. Default: 5.

{Tdr.Dataset.Quantity(begin=1)}Result: eFermiPotential

end Number of characters taken for the end of the string. Default: 0.

{Tdr.Dataset.Quantity(end=3)}Result: eQuasFerPot..ial

end-separator

String that separates the end part. Default: “..”.

{Tdr.Dataset.Quantity(end=3, end-separator="-")}Result: eQuasFerPot-ial

mid Number of characters taken for intermediate parts of the string. Default: 3.

{Tdr.Dataset.Quantity(mid=1)}Result: eQuasFP

mid-separator

String that separates intermediate parts. Default: Empty string.

{Tdr.Dataset.Quantity(mid-separator="'")}Result: eQuas’Fer’Pot

prepend String that is prepended to the result if the auxiliary data exists. Default: Empty string.

{Tdr.Dataset.Quantity(prepend="Quantity: ")}Result: Quantity: eQuasFerPot

21


The available options are:

General Options

Load in local coordinatesLoads grid files in local coordinates, that is, does not apply any coordinatetransform that can be defined in the file. The command-line options -s:lc and-s:gc override this setting (see Loader options on page 40).

Allow .lpk files on command lineLoads Tecplot package files from the command line. The command-line option-s:lpk overrides this setting (see Loader options on page 40).

Reset range after loadingResets the contour range after a file is loaded.

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 avector dataset.

Complex components Selects whether variables are created for the real and imaginary parts of acomplex dataset.

Complex norm Selects whether a variable is created and initialized with the complex norm fora 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 levelSets the expansion level when reading particles from a kinetic Monte Carlosimulation. Large values cause more zones to be generated for individualparticle types.

Advanced Opens a preference dialog box with advanced options for specific data loaders(see Advanced: Load DF–ISE preferences on page 23 and Advanced: LoadTDF/TIF preferences on page 24).

22


Advanced: Load DF–ISE preferences

Figure 9 Load DF–ISE preferences tab


Do not load extra grid files without dataLoads grid files that have been specified twice or more on the command lineonly once.

Ignore mismatching validity regions in data filesAllows data files with validity regions that do not match the regions of the gridfile.

Skip validity region checks in data file (speed-up)Omits checking of validity regions in data files, which causes significantlyfaster loading.

Load data in single precisionLoads data variables in single precision. This option applies only if the originalDF–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 thisloads faster than other loaders, it is not recommended to use the originalDF–ISE loader1.

1. The original DF–ISE loader reads data into separate Tecplot datasets, which cause some restrictions. Separatedatasets cannot be merged, and it is not possible to operate on data from different datasets using the Tecplot equationeditor.

23


Advanced: Load TDF/TIF preferences

Figure 10 Load TDF/TIF preferences tab


Ignore ambient regionsIgnores ambient regions.

Ignore conductor regionsIgnores conductor regions.

Ignore non-datex quantitiesIgnores quantities that are not defined in the datexcodes.txt file.

Split rectangles Splits rectangles into triangles while loading.

Layout preferences

Figure 11 Layout preferences tab

24



Page Borders Sets the page borders in centimeters.

Space Between FramesSets the space between frames in centimeters.

Rearrange layout after frame deletionRearranges the layout after a frame is deleted.

Rearrange layout after loadingRearranges the layout after a file is loaded.

Fit view after rearranging the layoutFits the frame view after the layout has been rearranged.

Enable interactive swapping of framesEnables the swapping of frames by selecting a frame and moving it over asecond frame.

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.

25


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.

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.

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.

26


Other options

Translucency value Sets the translucency value.

Specular reflection in 3D plotsEnables specular reflection in 3D plots.

Advanced Opens a preference dialog box with advanced options for specific plots (seeAdvanced: Plot 2D preferences, Advanced: Plot Contour preferences onpage 28, and Advanced: Plot XY preferences on page 29).

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.

27


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 contoursSets contour levels for the minimum and maximum values of the contourvariable.

Use custom contour levelsEnables or disables the custom contour level feature (see Customizing contourlevels on page 17).

28


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.

29


Slice preferences

Figure 17 Slice preferences tab


Orthogonal Slicer

Merge zones in 1D cutsMerges zones in 1D cuts.

Merge zones in 2D cutsMerges zones in 2D cuts.

Cut active zones only Cuts only the active zones.

Cut Along Boundary

Initial direction clockwiseSets 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.

Dynamic 2D Slicer

Normal direction Sets the normal direction of the slicer.

Automatically open slicer dialogOpens the slicer dialog box when the slicer is activated.

Enable translucency while slicingMakes all displayed zones translucent when the slicer is activated.

Disable translucency after slicingDisables translucency for all zones after slicing.

30


Miscellaneous preferences

Figure 18 Miscellaneous preferences tab


Export for Inspect

Confirm overwrite of filesDisplays a warning before a file is overwritten.

Start Inspect Starts Inspect with the exported data.

Choose how variables are groupedSelects how variables are grouped when exported to Inspect.

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).

31


32

TECPLOT SV CHAPTER 8 AUTOMATING TASKS

Tecplot SV

CHAPTER 8 Automating tasks

Tecplot provides a powerful macro language, which is described in the Tecplot Reference Manual. Thefollowing example demonstrates how multiple data files are loaded consecutively to generate a sequenceof 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 = YESINCLUDETEXT = NOINCLUDEGEOM = NOINCLUDESTREAMPOSITIONS = NOINCLUDECONTOURLEVELS = YESMERGE = NOINCLUDEFRAMESIZEANDPOSITION = YES

$!DRAWGRAPHICS TRUE$!REDRAWALL$!IF |FIRSTFRAME| == 1$!EXPORTSETUP

EXPORTFORMAT = AVIEXPORTFNAME = './movie.avi'IMAGEWIDTH = 800

$!EXPORTSTART$!VARSET |FIRSTFRAME| = 0

$!ENDIF$!IF |FIRSTFRAME| == 0

$!EXPORTNEXTFRAME$!ENDIF$!ENDLOOP$!EXPORTFINISH

In this example, the files data_0001.dat...data_0019.dat are loaded consecutively with the grid filemesh.grd. Each time a new file is loaded, the graphic styles are read from the style file movie.sty to enforcethe same display settings for all pictures. Style files can be generated by using File > Export > FrameStyle.

33

TECPLOT SVCHAPTER 8 AUTOMATING TASKS

A macro such as the one shown here is best generated by using File > Macro > Record. After the mainsteps have been recorded, the generated macro file can be edited and complemented with programmingconstructs. After a macro file has been created, the macro file can be either executed from within theTecplot 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 ifTecplot SV is started with the option -mesa.

Macro language extensionsThe Sentaurus Workbench add-on to Tecplot defines several additional macro commands. These aredescribed in the following sections. The common syntax for all add-on-specific macros is:

$!ADDONCOMMANDADDONID = 'Sentaurus Workbench Add-on'COMMAND = '<Macro Name> <Macro Arguments>'

EXTRACT_CONTOUR_TO_FILEExtracts the isoline for a specified value of a variable and writes the resulting polygon to a file.

SyntaxEXTRACT_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_POINTExtracts the value of a variable at a specified point. The result is printed and stored in the macro variableEXTRACTED_DATA_VALUE.

SyntaxEXTRACT_DATA_POINT <variable-name> <x> <y> <z> [snap]

34


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 isextracted.

GET_COLORFinds or creates the specified color and writes its index into the specified macro variable.

SyntaxGET_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_NAMEObtains the variable number associated with the specified name of the TDR dataset and assigns it to aTecplot macro variable.

SyntaxGET_VARNUM_BY_TDR_NAME <dataset-name> <macro-variable>

Arguments

dataset-name Name of TDR dataset.

macro-variable Tecplot macro variable.

GET_VARNUM_BY_TDR_QUANTITYObtains the variable number associated with the specified TDR quantity name and assigns it to a Tecplotmacro variable.

SyntaxGET_VARNUM_BY_TDR_QUANTITY <dataset-quantity> <macro-variable>

35


Arguments

dataset-quantity TDR dataset quantity.


GET_ZONENUM_BY_TDR_REGION_NAMEObtains the zone number associated with the specified TDR region name and assigns it to a Tecplotmacro variable.

SyntaxGET_ZONENUM_BY_TDR_REGION_NAME <region-name> <macro-variable>

Arguments

region-name Name of TDR region.


INTEGRATECalculates the integral of a variable over a specified set of zones. The results are printed. The totalintegral is also stored in the macro variable INTEGRAL.

SyntaxINTEGRATE <variable-name> [<zone-set>]

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 forall zones.

36


INTEGRATE_CURVECalculates the integral of an X-Y mapping f(x) over a specified range of the independent variable. Theresults are printed. The total integral is also stored in the macro variable INTEGRAL.

SyntaxINTEGRATE_CURVE <integration-variable> <independent-variable>

[ZONES = <zone-set>][RANGE_MIN = <range-min>][RANGE_MAX = <range-max>]

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 forall zones.

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.

ORTHOSLICECreates an orthogonal slice at a specific location in one or several frames.

SyntaxORTHOSLICE <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-dimensionalframes, or all three-dimensional frames, respectively.

37


SET_PREFERENCESets a preference option.

SyntaxSET_PREFERENCE <name> <value>

Arguments

name Name of the preference option. Valid names can be found in the preferences filetecswb.pref, which is stored in the home directory of the user.

value Value of the preference option.

SLICEMODESpecifies whether the orthogonal slicer merges zones or keeps the zone structure of the original grid.

SyntaxSLICEMODE MergedZones | SeparateZones

UPDATE_DATAUpdates Tecplot internal data by reading from the specified file.

SyntaxUPDATE_DATA <file-name>

Arguments

file-name Name of the file to be read.

38

TECPLOT SV APPENDIX A COMMAND OPTIONS

Tecplot SV

APPENDIX A Command options

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 areplacement for the Tecplot command-line option -h.

-s:ipc Enables interprocess communication (IPC), which is required if Tecplot acceptsconnection requests from Sentaurus Process.

-s:no_addons Does not load the Synopsys TCAD add-ons by default. Usually, the add-ons areloaded automatically using -loadaddon options in the Tecplot command line.

-s:no_appdef Does not use the app-defaults file specific to Synopsys by default. Usually, thetecplot_sv launcher modifies the environment in such a way that the version ofthe Tecplot app-defaults file specific to Synopsys is loaded instead of thestandard 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 thatthe version of the tecplot.cfg file specific to Synopsys is loaded instead of thestandard 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 commandline, such that all specified files are loaded using the Sentaurus Workbenchloader.

-s:rootlib <path> Specifies the path to the root library.

39

TECPLOT SVAPPENDIX A COMMAND OPTIONS

-s:stdaddons Allows for the loading of standard Tecplot add-ons as defined in the tecplot.addfile 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 defaultpaper size (U.S. letter).

-s:wait_dialogs Enables display of transient dialog boxes in Tecplot. Such dialog boxes are usedto indicate progress during some operations. The configuration specific toSynopsys disables transient dialog boxes because, on some platforms and withsome window managers, they can cause windows to remain locked on thescreen.

Loader options-s:append Appends file to the previous frame.

-s:fast_scan Disables expensive grid file–matching or data file–matching tests.

-s:gc Reads files in global coordinate mode. This option can be specified any numberof times in the command line so as to enable switching from local coordinatemode to global coordinate mode.

-s:ignore_regions_mismatch

Allows data files to be paired with grid files even if the number of regions doesnot correspond in both files.

-s:lc Reads geometry and grid files in local coordinate mode. This is the default. Thisoption can be specified any number of times in the command line so as to enableswitching 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:new Creates a new frame for each file.

Tecplot optionsAny option that is not identified as a tecplot_sv option is transferred to Tecplot. Refer to the TecplotUser’s Manual for an explanation of all Tecplot options.

40

TECPLOT SV APPENDIX A COMMAND OPTIONS

Environment variablesTEC_GRID_DEBUGGING If set, this causes an additional variable named VertexIndex to be created and

initialized with the DF–ISE vertex number. This is useful for debuggingpurposes. To look up a vertex index, use the Data Probe tool or switch on theTecplot 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 forlabeling.

TP_CLIENT_WAIT_TIMEOUT Sets the time (in seconds) that a client waits for Tecplot to start up and establisha 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 runningTecplot server.

41

TECPLOT SVAPPENDIX A COMMAND OPTIONS

42

TECPLOT SV GLOSSARY

Tecplot SVTecplot SV

Glossary

Some important terms are used in other Synopsys TCAD documents, which have different meanings inthe context of Tecplot, as Tecplot is not a Synopsys tool. These are explained here.

dataset versus variable‘Dataset’ in TDR and DF–ISE 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 itsassociated data.

file name extensions .plt and .datTecplot uses the file extension .dat for its own data files in ASCII format and .plt for binary formatfiles. These files are loaded and written by using File > Import > Tecplot Data File and File > Export> Tecplot Data File. In DF–ISE terminology, the file extension .dat is used for dataset files and .plt isused for XY graph files.

region versus zone‘Region’ in Synopsys language corresponds in most cases to a ‘zone’ in Tecplot language. Tecplot candisplay each zone with its individual graphic styles. The DF–ISE loader maps regions to zones. TheTDR loader maps parts to zones.

43

TECPLOT SVGLOSSARY

44

tecplot svjmbussat/physics290e/fall-2006/tcad_documentati… · convention explanation blue text...

Documents