Tecplot 360 Scripting Guide

Scripting Guide
Tecplot, Inc.
Bellevue, WA
2010
COPYRIGHTNOTICE
Tecplot360TMScriptingGuideisforusewithTecplot360TMVersion2010.
Copyright19882010Tecplot,Inc.Allrightsreservedworldwide.Exceptforpersonaluse,thismanualmaynotbereproduced,transmitted,transcribed,storedinaretrievalsystem,ortranslatedinanyform,inwholeorinpart,withouttheexpresswritten
permissionofTecplot,Inc.,3535FactoriaBlvd,Ste.550;Bellevue,WA98006U.S.A.
Thesoftwarediscussedinthisdocumentationandthedocumentationitselfarefurnishedunderlicenseforutilizationandduplicationonlyaccordingtothelicenseterms.ThecopyrightforthesoftwareisheldbyTecplot,Inc.Documentationisprovidedfor
informationonly.Itissubjecttochangewithoutnotice.ItshouldnotbeinterpretedasacommitmentbyTecplot,Inc.Tecplot,Inc.assumesnoliabilityorresponsibilityfordocumentationerrorsorinaccuracies.
Tecplot,Inc.
PostOfficeBox52708
Bellevue,WA980152708U.S.A.
Tel:1.800.763.7005(withintheU.S.orCanada),001(425)6531200(internationally)
email:sales@tecplot.com,support@tecplot.com
Questions,commentsorconcernsregardingthisdocument:documentation@tecplot.com
Formoreinformation,visithttp://www.tecplot.com
THIRDPARTYSOFTWARECOPYRIGHTNOTICES
SciPy20012009Enthought.Inc.AllRightsReserved.NumPy2005NumPyDevelopers.AllRightsReserved.VisToolsandVdmTools19922009VisualKinematics,Inc.AllRightsReserved.NCSAHDF&HDF5(HierarchicalDataFormat)SoftwareLibraryand
UtilitiesContributors:NationalCenterforSupercomputingApplications(NCSA)attheUniversityofIllinois,FortnerSoftware,UnidataProgramCenter(netCDF),TheIndependentJPEGGroup(JPEG),JeanloupGaillyandMarkAdler(gzip),andDigital
EquipmentCorporation(DEC).ConditionsofRedistribution:1.Redistributionsofsourcecodemustretaintheabovecopyrightnotice,thislistofconditions,andthefollowingdisclaimer.2.Redistributionsinbinaryformmustreproducetheabovecopyright
notice,thislistofconditions,andthefollowingdisclaimerinthedocumentationand/ormaterialsprovidedwiththedistribution.3.Inaddition,redistributionsofmodifiedformsofthesourceorbinarycodemustcarryprominentnoticesstatingthattheorigi
nalcodewaschangedandthedateofthechange.4.Allpublicationsoradvertisingmaterialsmentioningfeaturesoruseofthissoftwareareasked,butnotrequired,toacknowledgethatitwasdevelopedbyTheHDFGroupandbytheNationalCenterfor
SupercomputingApplicationsattheUniversityofIllinoisatUrbanaChampaignandcreditthecontributors.5.NeitherthenameofTheHDFGroup,thenameoftheUniversity,northenameofanyContributormaybeusedtoendorseorpromoteproducts
derivedfromthissoftwarewithoutspecificpriorwrittenpermissionfromtheUniversity,THG,ortheContributor,respectively.DISCLAIMER:THISSOFTWAREISPROVIDEDBYTHEHDFGROUP(THG)ANDTHECONTRIBUTORSASISWITHNO
WARRANTYOFANYKIND,EITHEREXPRESSEDORIMPLIED.InnoeventshallTHGortheContributorsbeliableforanydamagessufferedbytheusersarisingoutoftheuseofthissoftware,evenifadvisedofthepossibilityofsuchdamage.Copyright
19982006TheBoardofTrusteesoftheUniversityofIllinois,Copyright20062008TheHDFGroup(THG).AllRightsReserved.PNGReferenceLibraryCopyright1995,1996GuyEricSchalnat,Group42,Inc.,Copyright1996,1997AndreasDilger,Copy
right1998,1999GlennRandersPehrson.AllRightsReserved.Tcl19891994TheRegentsoftheUniversityofCalifornia.Copyright1994TheAustralianNationalUniversity.Copyright19941998SunMicrosystems,Inc.Copyright19981999Scriptics
Corporation.AllRightsReserved.bmptopnm1992DavidW.Sanderson.AllRightsReserved.Netpbm1988JefPoskanzer.AllRightsReserved.Mesa19992003BrianPaul.AllRightsReserved.W3CIPR19951998WorldWideWebConsortium,(Massachu
settsInstituteofTechnology,InstitutNationaldeRechercheenInformatiqueetenAutomatique,KeioUniversity).AllRightsReserved.Ppmtopict1990KenYap.AllRightsReserved.JPEG19911998ThomasG.Lane.AllRightsReserved.DirentAPIforMicro
softVisualStudio(dirent.h)20062006Copyright2006ToniRonkko.Permissionisherebygranted,freeofcharge,toanypersonobtainingacopyofthissoftwareandassociateddocumentationfiles(the``Software),todealintheSoftwarewithoutrestriction,
includingwithoutlimitationtherightstouse,copy,modify,merge,publish,distribute,sublicense,and/orsellcopiesoftheSoftware,andtopermitpersonstowhomtheSoftwareisfurnishedtodoso.ToniRonkko.AllRightsReserved.ICU19952009Copy
right19952009InternationalBusinessMachinesCorporationandothers.Allrightsreserved.Permissionisherebygranted,freeofcharge,toanypersonobtainingacopyofthissoftwareandassociateddocumentationfiles(theSoftware),todealintheSoft
warewithoutrestriction,includingwithoutlimitationtherightstouse,copy,modify,merge,publish,distribute,and/orsellcopiesoftheSoftware,andtopermitpersonstowhomtheSoftwareisfurnishedtodoso,providedthattheabovecopyrightnotice(s)
andthispermissionnoticeappearinallcopiesoftheSoftwareandthatboththeabovecopyrightnotice(s)andthispermissionnoticeappearinsupportingdocumentation.InternationalBusinessMachinesCorporationandothers.AllRightsReserved.
TRADEMARKS
Tecplot,Tecplot360TM,theTecplot360TMlogo,PreplotTM,EnjoytheViewTM,andFramerTMareregisteredtrademarksortrademarksofTecplot,Inc.intheUnitedStatesandothercountries.
3DSystemsisaregisteredtrademarkortrademarkof3DSystemsCorporationintheU.S.and/orothercountries.MacintoshOSisaregisteredtrademarkortrademarkofApple,IncorporatedintheU.S.and/orothercountries.ReflectionXisaregisteredtrade
markortrademarkofAttachmateCorporationintheU.S.and/orothercountries.EnSightisaregisteredtrademarkortrademarkofComputationEngineeringInternation(CEI),IncorporatedintheU.S.and/orothercountries.EDEMisaregisteredtrademark
ortrademarkofDEMSolutionsLtdintheU.S.and/orothercountries.Exceed3D,Hummingbird,andExceedareregisteredtrademarksortrademarksofHummingbirdLimitedintheU.S.and/orothercountries.Konquerorisaregisteredtrademarkortrade
markofKDEe.V.intheU.S.and/orothercountries.VIPandVDBareregisteredtrademarksortrademarksofHalliburtonintheU.S.and/orothercountries.ECLIPSEFrontSimisaregisteredtrademarkortrademarkofSchlumbergerInformationSolutions
(SIS)intheU.S.and/orothercountries.DebianisaregisteredtrademarkortrademarkofSoftwareinthePublicInterest,IncorporatedintheU.S.and/orothercountries.X3DisaregisteredtrademarkortrademarkofWeb3DConsortiumintheU.S.and/orother
countries.XWindowSystemisaregisteredtrademarkortrademarkofXConsortium,IncorporatedintheU.S.and/orothercountries.ANSYS,FluentandanyandallANSYS,Inc.brand,product,serviceandfeaturenames,logosandslogansareregistered
trademarksortrademarksofANSYSIncorporatedoritssubsidiariesintheU.S.and/orothercountries.PAMCRASHisaregisteredtrademarkortrademarkofESIGroupintheU.S.and/orothercountries.LSDYNAisaregisteredtrademarkortrademarkof
LivermoreSoftwareTechnologyCoroporationintheU.S.and/orothercountries.MSC/NASTRANisaregisteredtrademarkortrademarkofMSC.SoftwareCorporationintheU.S.and/orothercountries.NASTRANisaregisteredtrademarkortrademarkof
NationalAeronauticsSpaceAdministrationintheU.S.and/orothercountries.3DSLisaregisteredtrademarkortrademarkofStreamSimTechnologies,IncorporatedintheU.S.and/orothercountries.SDRC/IDEASUniversalisaregisteredtrademarkortrade
markofUGSPLMSolutionsIncorporatedoritssubsidiariesintheU.S.and/orothercountries.StarCCM+isaregisteredtrademarkortrademarkofCDadapcointheU.S.and/orothercountries.RepriseLicenseManagerisaregisteredtrademarkortrade
markofRepriseSoftware,Inc.intheU.S.and/orothercountries.PythonisaregisteredtrademarkortrademarkofPythonSoftwareFoundationintheU.S.and/orothercountries.Abaqus,the3DSlogo,SIMULIAandCATIAareregisteredtrademarksor
trademarksofDassaultSystmesoritssubsidiariesintheU.S.and/orothercountries.TheAbaqusruntimelibrariesareaproductofDassaultSystmesSimuliaCorp.,Providence,RI,USA.DassaultSystmes,2007FLOW3Disaregisteredtrademarkor
trademarkofFlowScience,IncorporatedintheU.S.and/orothercountries.Adobe,Flash,FlashPlayer,PremierandPostScriptareregisteredtrademarksortrademarksofAdobeSystems,IncorporatedintheU.S.and/orothercountries.AutoCADandDXFare
registeredtrademarksortrademarksofAutodesk,IncorporatedintheU.S.and/orothercountries.UbuntuisaregisteredtrademarkortrademarkofCanonicalLimitedintheU.S.and/orothercountries.HP,LaserJetandPaintJetareregisteredtrademarksor
trademarksofHewlettPackardDevelopmentCompany,LimitedPartnershipintheU.S.and/orothercountries.IBM,RS/6000andAIXareregisteredtrademarksortrademarksofInternationalBusinessMachinesCorporationintheU.S.and/orothercountries.
HelveticaFontFamilyandTimesFontFamilyareregisteredtrademarksortrademarksofLinotypeGmbHintheU.S.and/orothercountries.LinuxisaregisteredtrademarkortrademarkofLinusTorvaldsintheU.S.and/orothercountries.ActiveX,Excel,
Microsoft,VisualC++,VisualStudio,Windows,WindowsMetafile,WindowsXP,WindowsVista,Windows2000andPowerPointareregisteredtrademarksortrademarksofMicrosoftCorporationintheU.S.and/orothercountries.Firefoxisaregisteredtrade
markortrademarkofTheMozillaFoundationintheU.S.and/orothercountries.NetscapeisaregisteredtrademarkortrademarkofNetscapeCommunicationsCorporationintheU.S.and/orothercountries.SUSEisaregisteredtrademarkortrademarkof
Novell,IncorporatedintheU.S.and/orothercountries.RedHatisaregisteredtrademarkortrademarkofRedHat,IncorporatedintheU.S.and/orothercountries.SPARCisaregisteredtrademarkortrademarkofSPARCInternational,Incorporatedinthe
U.S.and/orothercountries.ProductsbearingSPARCtrademarksarebasedonanarchitecturedevelopedbySunMicrosystems,Inc.Solaris,SunandSunRasterareregisteredtrademarksortrademarksofSunMicroSystems,IncorporatedintheU.S.and/or
othercountries.CourierisaregisteredtrademarkortrademarkofMonotypeImagingIncorporatedintheU.S.and/orothercountries.UNIXandMotifareregisteredtrademarksortrademarksofTheOpenGroupintheU.S.and/orothercountries.Qtisareg
isteredtrademarkortrademarkofTrolltechintheU.S.and/orothercountries.ZlibisaregisteredtrademarkortrademarkofJeanloupGaillyandMarkAdlerintheU.S.and/orothercountries.OpenGLisaregisteredtrademarkortrademarkofSiliconGraph
ics,IncorporatedintheU.S.and/orothercountries.JPEGisaregisteredtrademarkortrademarkofThomasG.LaneintheU.S.and/orothercountries.SENSORisaregisteredtrademarkortrademarkofCoatsEngineeringintheU.S.and/orothercountries.
SENSORislicensedanddistributedonlybyCoatsEngineeringandbyJOAOilandGas,aworldwideauthorizedreseller.Allotherproductnamesmentionedhereinaretrademarksorregisteredtrademarksoftheirrespectiveowners.
NOTICETOU.S.GOVERNMENTENDUSERS
Use,duplication,ordisclosurebytheU.S.Governmentissubjecttorestrictionsassetforthinsubparagraphs(a)through(d)oftheCommercialComputerRestrictedRightsclauseatFAR52.22719whenapplicable,orinsubparagraph(c)(1)(ii)oftheRightsin
TechnicalDataandComputerSoftwareclauseatDFARS252.2277013,and/orinsimilarorsuccessorclausesintheDODorNASAFARSupplement.Contractor/manufacturerisTecplot,Inc.,3535FactoriaBlvd,Ste.550;Bellevue,WA98006U.S.A.
10360071
Rev04/2010
Table of Contents
Introduction ......................................................................................................5
Tecplot 360 Macro Commands

2
Introduction to Macro Commands ...................................................9
Managing Macros ........................................................................................11

Macrosvs.MacroFunctionsvs.MacroCommands.............................................11
RunningMacrosfromtheCommandLine..............................................................11
RunningMacrosfromtheTecplot360Interface ....................................................11
RunningMacrosfromtheQuickMacroPanel .......................................................12
Writing Forward Compatible Macros ............................................13
Debugging Macros................................................. 15
Macro Command Syntax .......................................................................17
Macro Variables ............................................................................................19

InternalVariables .............................................................................................................19
SystemEnvironmentVariables ....................................................................................22
AssigningValuestoMacroVariables ........................................................................22
AssigningaStringtoaMacroVariable.....................................................................23
ReplacementTextUse .....................................................................................................23
MacroFunctionVariables ..............................................................................................23
UsingFormatsinMacroVariables .............................................................................24
Macro Command Summary ................................................................ 27
Macro Commands ....................................................................................... 55
10
Macro Commands for the Analyze Menu ................................ 213

SummaryofAnalyzeMacroCommands...............................................................213
MacroCommandDescription ...................................................................................214
ParameterAssignmentValues ...................................................................................228
11
Parameter Subcommands .................................................................. 229
12
Parameter Assignment Values, Expressions, and

Operators ........................................................................................................ 251
AssignmentValueTable...............................................................................................251
AssignmentValueExpressions .................................................................................260
13
Raw Data ......................................................................................................... 263
14
Macro Language Limitations ............................................................ 267
Python Scripting
15
Using Tecplot 360s Python Interpreter .................................. 271

UsingPythonScriptswithTecplot360 ...................................................................271
InstallationandSetup ...................................................................................................271
16
Python Syntax Rules .............................................................................. 273

ImportModules ..............................................................................................................273
BasicSyntaxRules .........................................................................................................274
InputTypes.......................................................................................................................275
OutputTypes ...................................................................................................................279
ExceptionstotheRules ................................................................................................280
ConvenienceFunctions ................................................................................................280
Tecplot360MacroCommandsforPythonModules ..........................................284
NotesforNovicePythonUsers .................................................................................285
Index
...................................................................................................................................... 287
1
Introduction
Tecplot360isapowerfultoolforvisualizingawiderangeoftechnicaldata.Itofferslineplotting,2Dand
3Dsurfaceplotsinavarietyofformats,and3Dvolumetricvisualization.Theuserdocumentationfor
Tecplot360isdividedintoninebooks:
ScriptingGuide(thisdocument)ProvidesMacroandPythoncommandsyntaxand
informationonworkingwithMacroandPythonfilesandcommands.
UsersManualProvidesacompletedescriptionofworkingwithTecplot360features.
GettingStartedManualNewTecplot360usersareencouragedtoworkthroughthetutorials
providedintheGettingStartedManual.Thetutorialshighlightworkingwithkeyfeaturesin
Tecplot360.
QuickReferenceGuideProvidessyntaxforzoneheaderfiles,macrovariables,keyboard
shortcuts,andmore.
DataFormatGuideProvidesinformationonoutputtingyoursimulatordataintoTecplot360
fileformat.
AddonDevelopersKitUsersManualProvidesinstructionsandexamplesforcreating
addonsforTecplot360.
AddonDevelopersKitReferenceManualProvidesthesyntaxforthefunctionsincludedin
thekit.
InstallationInstructionsProvidesdetailedinstructionsonhowtoinstallTecplot360onyour
machine.
ReleaseNotesProvidesinformationaboutnewand/orupdatedTecplot360features.
Introduction
ThereareseveralmethodsavailabletoextendorautomateTecplot360functionality,including:macros,
scriptingwithPython anddevelopingaddons.Chooseyourmethodbaseduponyourendgoalandlevel
oftechnicalexperience:
Method
Macros
Python
scripting
GeneralUsage
CommonUse
Case
Limitations
automateTecplot360
processes
batchprocessing
cannotadd
functionalityto
Tecplot360
automateTecplot360
processesandextend
capabilities
fastfourier
transforms
notallofTecplot
360sfunctionalityis
accessible
extendTecplot360s
capability
writinganewdata
loader
requiresacompiler
anddevelopment
experience
Addons
MacroprocessingcapabilitiesareincludedinyourTecplot360distribution.Macrolanguagesyntaxand
usageareprovidedinScriptingGuide.MacroscanbeaccessedloadedviatheScriptingmenuandfrom
theQuickMacroPanel(alsoaccessedviatheScriptingmenu).
YourTecplot360installationincludes:aPythoninterpreteralongwithaninterfaceconnection,anda
Pythonlibrary(version2.5.1),aswellassupportingPythonfiles.InformationonworkingwithTecplot360
andPythonisprovidedinChapter30:WorkingWithPythonScriptsintheUsersManual.Thesyntax
forthePythoncommandscanbefoundusingthesyntaxrulesprovidedinChapter16:PythonSyntax
RulesalongwiththeADKReferenceManual.
TocreateaddonsforTecplot360,youneedtohaveacompilerforC,C++orFORTRAN.RefertotheADK
UsersManualforinstructionsforcreatingaddons,alongwithsampleaddons.
Part 1 Tecplot 360

Macro Commands
2
Introduction to Macro Commands
ATecplot360macroisasetofinstructions,calledmacrocommands,whichperformactionsinTecplot360.
MacrocommandscanbeusedtoaccomplishvirtuallyanytaskthatcanbedoneviatheTecplot360
interface,offeringaneasywaytoautomateTecplot360processes.Theonlythingsyoucandointeractively
thatcannotbedonewithmacrocommandsarethoseactionsthathavenoeffectonafinal,printedplot
(suchasresizingtheTecplot360processwindow).Toaugmentthisability,therearemacrocommands
whichhavenocorrespondinginteractivecontrol,suchasloopingandconditionalcommands.These
commandstypicallygohandinhandwiththeexecutionofamacro.
YoucancreatemacrosbyrecordingthemfromtheTecplot360interfaceusingtheMacroRecorder
(accessedviatheScripting>RecordMacromenu),orcreatethemfromscratchusinganyASCIItexteditor.
Inmostcases,themosteffectiveapproachtocreatingamacroisthefollowinghybridapproach:
1. RunTecplot360andchoosetorecordamacrotoafile.Performtaskssimilartothoseyouare
tryingtocaptureinthefinalmacro.
2. Closetherecordingsessionandexaminethemacrofile.ThecommandsgeneratedbyTecplot
360shouldbefairlyreadableandeasytounderstand.
3. Makeminormodificationstotherecordedmacro.Typicalmodificationsinvolveadding
loops,addingvariables,oraddingcommandsthat,forexample,prompttheusertoenterafile
name.
Oneofthemainreasonsforusingtheapproachaboveisthelargenumberofcommandsandpermutations
ofparameters.Thismanualprovidesanexhaustivelistingoftheavailablemacrocommands.However,it
isofteneasiertohaveTecplot360performtheactionandrecordtherelevantcommandthanlookup
individualcommandsandtheirrequiredparameters.
AnimportantfeatureofTecplot360smacrocommandlanguageisitsViewer/Debugger.Often,youwill
haveawelldevelopedmacrothatneedssomemodification.YoucanusetheDebuggertostepthroughthe
macrotothepointwhereyouwantthechangetobemadeandthenstartrecordingtoanewfile.Usinga
texteditor,youcaninsertmacrocommandsfromanewfileintoanexistingmacrofile.
Introduction to Macro Commands
10
3
Managing Macros
Tecplot360macrosarestoredinfiles.ThesefilesareprocessedbyloadingthemintoTecplot360and
runningthem.
3-1
Macros vs. Macro Functions vs. Macro Commands
ATecplot360macroisafilecontainingoneormoremacrocommands.Thesefilesstartwiththefollowing
specialcommentlinetonotifyTecplot360thatwhatfollowsisaTecplot360macro:
#!MC1120
Anynumberofmacrocommandsorcommentsmayfollow.
Tecplot360macrofunctionsaredefinedinTecplot360macrosbyusingthe$!MACROFUNCTION
$!ENDMACROFUNCTIONcommands.Betweenthe$!MACROFUNCTIONand$!ENDMACROFUNCTIONcommandsyoumay
useanyvalidmacrocommand(except$!MACROFUNCTION).WhenaTecplot360macroisloaded,allmacro
functionsareextractedandtheattachedcommandsarenotexecuteduntila$!RUNMACROFUNCTIONcommand
isencountered.
Macrofunctionsmayberetainedifdesired.AretainedmacrofunctionremainsdefinedinTecplot360
evenifthemacroinwhichitwasdefinedisreplacedbyanothermacro.Retainedmacrofunctionsmaybe
calledbyothermacrosthatareloadedatalatertime.
3-2
Running Macros from the Command Line
AsimplewaytorunaTecplot360macroistoincludeitinthecommandlinewiththepflag.The
followingcommandrunsTecplot360andplaysamacrocalleda.mcr:
tecplotpa.mcr
Ifyouusethe.mcrextensionforthemacrofilename,thenthepflagisoptional.Ifyouwanttodebugthe
macro,includethezflagaswell.
3-3
Running Macros from the Tecplot 360 Interface
YoucanrunamacrofilebygoingtoScripting>PlayMacro/Script.Adialogappears;choosethemacroto
play.
11
Managing Macros
Ifyouwanttodebugamacrofile,gototheScriptingmenuandselecttheView/DebugMacrooption.
TheMacroViewerdialogappearssoyoucanloadinamacro.Whenthemacroisloaded,Tecplot360
waitsatthefirstmacrocommandforyoutostepthroughthecommands.SeeSection283Macro
DebuggingintheUsersManualforcompletedetailsonhowtousetheMacroViewer.
3-4
Running Macros from the Quick Macro Panel
Macrosthatyouusefrequentlyorwantrapidaccesstomaybedefinedasmacrofunctionswithinaspecial
filecalledtecplot.mcrineitherthecurrentdirectory,yourhomedirectory,ortheTecplot360home
directory.WhenTecplot360startsitlooksforthisfileineachofthosedirectoriesinturn.IfTecplot360
findsthefile,itloadsthemacrodefinitionsandassociatesfunctionstobuttonsontheQuickMacroPanel
dialog(intheScriptingmenu).YoucanhaveTecplot360loadyourownmacrofunctionfilebyusingthe
qmflagonthecommandline.ThefollowingcommandrunsTecplot360andinstallsthemacrofunctionsin
thefilemyteccmd.mcrintotheQuickMacroPanel:
tec360qmmyteccmd.mcr
YoucanhaveamacrofunctionaddabuttontotheQuickMacroPaneldialog.Bydefault,allmacro
functionsdefinedinthetecplot.mcrfilewilladdabuttontotheQuickMacroPanel,thosedefined
elsewherewillnot.Seethe$!MACROFUNCTION...$!ENDMACROFUNCTIONcommandformore
information.
If the macro file does not contain any function definitions, it will not be loaded into the
Quick Macro Panel.
IfyouwantTecplot360todisplaytheQuickMacroPanelatstartingincludetheshowpanelflagonthe
commandline.
Toseeanexampleofamacrofunctionfile,lookatthefiletecplot.mcrlocatedintheexamples/mcrsub
directorybelowtheTecplot360homedirectory.IfthisfileismovedtotheTecplot360homedirectory,the
QuickMacroPanelwillhaveoptionsthatinclude3DRotationAnimationandResetCenterofRotation.
12
4
Writing Forward Compatible Macros
Inordertoensureforwardcompatibilityofyourmacrocommands,pleasekeepthefollowingguidelines
inmind.Theseguidelineswillallowyoutocreatemacrosthatwillworkforyears,onmanymachinesand
platforms.
1. Beginyourmacrobyopeningalayout.
ThiswillensurethatthefinalplotisconsistentbetweenversionsofTecplot360(evenifthe
defaultstylesettingsforTecplot360havechanged).
An alternative to using a layout is to load data and then paste a frame style file in each
frame.
Ifyourmacrowillbeusedformorethanonelayout,youcanensureforwardcompatibilityby:
Usingthe$!PromptForFileNamecommand.Thiswillallowtheusertointeractively
specifythelayoutfile.
or
LaunchingTecplot360fromthecommandline,specifyingthelayoutandthemacro:
tecplotmylayout.laymydatafilemymacro.mcr
2. Storeassociatedfilesandgraphicsinthesamefolderasthemacrofile.
Ifyourmacroloadsfilesorinsertsimageswithoutallowingtheusertochoosethem,itisa
goodpracticetostoretheminthesamefolderasthemacrofilethatusesthem.After
recording,editthemacro,andreplacethepathtothefilewiththeintrinsicmacrovariable
|macrofilepath|.
Example:
$!OpenLayout"|macrofilepath|\Density.lpk"
Thisallowsthemacrotoworkwithouteditinginanylocationaslongastheentirefolderof
fileswascopiedthere.
3. Avoidusinga$!Pickcommandinyourmacro.
13
Writing Forward Compatible Macros
Changestotheaspectratiocancausearecorded$!Pickcommandtofailwhenthemacrois
runonanothermachineorinanotherversionofTecplot360.
Inaplotwithmultipleframes,youcannotuse$!Picktochangetheactiveframe.
Instead,giveeachframeameaningfulnamesuchasFullViewandZoomFramein
thelayout.Thenusethecommand:
$!FrameControlActivateByNameName=FullView
toaccesstheframeyouwant.Thiswillalsosimplifylaterchangestothemacro.
Ifyoumustpickanitem,makethepickaspreciseaspossible.Forexample,clickingon
thecenter,nottheedge,ofazoneorslicewillincreasethechancesthatthepickwillbe
successfulwhenthemacroisreplayed.
Whenselectingtextorgeometrieswhilerecordingamacro,clickanddraginthewidest
possibleareaaroundtheobjectstoselect.Thecommandwillberecordedas
$!PICKADDALLINRECT
SELECTTEXT=YES
X1=1.56075949367
X2=3.97088607595
Y1=2.29556962025
Y2=3.91582278481
Thexandyrangescanbeexpandedifneeded.
4. Useplentyofcommentsinyourmacro.
14
5
Debugging Macros
Ingeneral,thebestwaytodebugamacroistousetheMacroViewer,andfindwhichcommandiscausing
theproblem.Herearesometipsforspecificproblems:
Problem:ThemacrowascreatedwithapreviousversionofTecplot360tomaketheplotneeded.Withanewer
versionofTecplot360,themacrowillrunwithouterror,buttheplotlooksdifferent.
Solution:RunthemacrowiththeoldversionofTecplot360,thensaveaframestyletoafile.Beginyour
macrobyloadingthedata,thenpastingtheframestylefromafile.Thiswillensurethatthefinalplot
willbeconsistentfromoneversionofTecplot360tothenext,evenifthedefaultstylesettingsfor
Tecplot360havebeenchanged.
Problem:ThemacrogivesyouerrorssuchasFiledoesnotexistorCannotopenfile,butyoucanlocatethefile.
Solution:Copythefiletothesamefolderasthemacrofilethatusesthefile.Editthemacro,andreplace
thepathtothefilewiththeintrinsicmacrovariable|macrofilepath|.
Example:$!Openlayout"|macrofilepath|\Density.lpk"
Thisallowsthemacrotoworkwithouteditinginanylocationaslongastheentirefolderoffileswas
copiedthere.
Problem:Runningthemacrocausesunusualerrormessages,suchas:Noobjectstocutortheobjects
selectednotallowedtobecutorNotallowedtoadjustzonesormappingswhenthemousemodeis
settoSELECTOR.WhenyourunthemacrointheMacroViewer,youseethattheproblemoccurswith
whena$!Pickcommandisrun.
Solution:Avoidusinga$!Pickcommandinyourmacro.Changestotheaspectratiocancausea
recorded$!Pickcommandtofailwhenthemacroisrunonanothermachineorinanotherversionof
Tecplot360.
Tofixtheprobleminanexistingmacro,followthesestepstomakethecoordinatesmoreprecise:
1. Runthemacroonthemachinewheretheerrormessageisgenerated.
15
Debugging Macros
2. Viathemacrovieweroreditor,identifythepreceding$!PICKCHECKTOADDorsimilarselecttype
pickcommand.NotetheX,Ycoordinatesofthecommand.Agoodwaytodothisis:
a. RunthemacrountilyougettheNoObjectstoShifterrormessage.
b. ClickOkonthedialog.
c. Bringupthemacroviewer:Scripting>View/DebugMacro.
d. Findthenearest $!PICK CHECKTOADDcommandabovethecurrentcommandandputa
breakpointonthatcommand.
e. PressResettoresetthemacroandthenrunthemacro.
If the problem only occurs when running in batch mode then try to determine the macro
command by examining the batch.log file.
f. Insert a $!Pause command in your macro just before the $!Pick Add command that
precedestheoffendingcommand.NowrunTecplot360interactivelyfromthemacro
viewer.Youcanthenseethelinenumberwhereyouneedtoputthebreak.
3. BackinTecplot360,selectthezoomtool.
4. Holdtheshiftkeydownandnoticethattherunningcoordinatesinthelowerrightcornernow
showPX=xxxxxPY=yyyyyy.xxxxxxandyyyyyyarethepapercoordinatesofthehot
spotofthezoomtool.(IfyouseeXandYforgridcoordinates,orFXandFYforframe
coordinates,youneedtoholddowntheShiftkey.Pickcommandsalwaysusepaper
coordinates.)
5. Movethezoomtooluntilxxxxxandyyyyyareclosetothecoordinatesnotedinstep2.
6. Notewherethepickoccurred.Itislikelythepickoccurredsomedistanceawayfromthe
actualedgeoftheobjecttopick.Movethezoomtooltoabetterlocationforthepickand
notethecoordinates.
EditthemacrofileandreplacetheoldX,Ypickcoordinateswiththosedeterminedinstep6.
16
6
Macro Command Syntax
Amacrofileconsistsofoneormoremacrocommands.Commentsmaybeinsertedanywhereinthefile,
exceptwithinacharacterstring.Commentsstartwithan#(octothorp)andextendtotheendoftheline.
Thefirstlineofamacrofilecontainsaspecialcommentthatidentifiestheversionnumberofthemacro
file.ForTecplot360,thislineis:#!MC1120.
ATecplot360macrofilehastheform:
#!MC1120
<macrocommand>
<macrocommand>
...
Eachmacrocommand,inturn,hastheform:
$!commandname[commandspecificmodifiers]
[mandatoryparameters]
[optionalparameters]
where
commandspecificmodifiers
Theseareoptionalcommandspecificmodifiers.Anexampleofacommandthatusesthisisthe
$!FIELDMAPcommand.The$!FIELDMAPcommandcanbefollowedbyaset.Ifitisnot
followedbyaset,the$!FIELDMAPcommandappliestoallenabledzones.Asuppliedsetinthis
caseisusedtolimitthezonestowhichthe$!FIELDMAPcommandapplies.
mandatoryparameters
commandparametercommandparameter...
optionalparameters
commandparametercommandparameter...
commandparameter
parameterassignmentorparametersubcommand.
parameterassignment
parameternameopvalue.
op
=or=or+=or*=or/=.
parametersubcommand
parametername{optionalparameters}.
commandname
Thenameofamajorcommand,suchasREDRAW.
17
Macro Command Syntax
parametername
Thenameofavalidparameterforthepreviouslynamedmajorcommand.Forexample,the
$!REDRAWmajorcommandhasanoptionalparametercalledDOFULLDRAWING.
value
number,expression,orenumeratedvalue.
number
Anyvalidintegerordoublevaluerepresentation.
expression
Anyvalidinfixnotationexpression.Theentireexpressionmustitselfbeenclosedinparenthesis.
Forexample(3+5).
enumeratedvalue
Akeywordthatisuniquetothevariablebeingassignedavalue.Forexample,ifthevariablebeing
assignedavalueisabasiccolorthentheenumeratedvaluecanbeoneofthefollowing:BLACK,
RED,GREEN,BLUE,CYAN,YELLOW,PURPLE,WHITE,CUSTOM1throughCUSTOM56.
Spacingandcapitalizationformacrocommandsare,forthemostpart,notimportant.Thefollowing
examplesshowdifferentwaystoenterthesamemacrocommandtosetthewidthandheightforthe
custom1paper:
Example 1:
$!PAGE
PAPERSIZEINFO
{
CUSTOM1
{
WIDTH=3
}
}
Example 2:
$!PAGEPAPERSIZEINFO
{CUSTOM1
{WIDTH=3}
}
Example 3:
$!PAGEpapersizeinfo{custom1{width=3}}
18
7
Macro Variables
Macrovariablesareidentifiedbyasequenceofcharacterssurroundedbyverticalbars(|).Some
examplesare:
|myvariable|
|loop|
|1|
|$HOME|
Macrovariablescanbeplacedanywherewithinamacrocommand.Uppercaseandlowercasecharacters
aretreatedthesame.Forexample |ABC| and |aBc| representthesamevariable.
Macrovariableswillbeexpandedtotheirvalueatthetimethemacrostatementisprocessed.
Example:
ThefollowingmacrocommandswillresultinarotationofthedataabouttheXaxisby10degrees:
$!VARSET|a1|=10
$!ROTATEX
ANGLE=|a1|
7-1
Internal Variables
ThefollowingtablelistsvariablesmaintainedbyTecplot360thatmaybereferencedbymacrocommands.
SincethesevariablesaremaintanedbyTecplot360,youcannotassignvaluestothem.
ForinternalvariablesthatrepresentanattributeofaTecplot360objectofwhichTecplot360supports
multipleinstances(suchasaframe,adataset,orazone),thevariablebydefaultreferstothecurrentor
activeinstance:forexample,totheactiveframeifthevariablereferstoanattributeofframes.Ifthereisno
obviousdefaultinstance,thevariablenamebyitselfusuallyreferstothefirstinstance.
Forsuchvariables,youmayspecifythedesiredinstanceofthereferencedtypeofobjectbyenclosingan
indexinsquarebracketsimmediatelyfollowingthevariablename.Forexample,|AUXZONE[3]:BC|refersto
thezoneauxiliarydatanamedBCinthethirdzone.
19
Macro Variables
Inmostcases,theindexmayalsobewrittenasACTIVEOFFSET=ntospecifythenthactiveinstanceofanobject
type.Forexample,|ENDSLICEPOS[ACTIVEOFFSET=2]|referstotheendpositionofthesecondactiveslicegroup.
Variables
Notes
|AUXDATASET:Auxname|
RetrievesauxiliarydatanamedAuxnamefromadatasetForexample,
|AUXDATASET:Reynolds|retrievesauxiliarydataReynolds.
|AUXFRAME:Auxname|
RetrievesauxiliarydatanamedAuxnamefromaframe.Forexample,
|AUXFRAME:MyFrame|retrievesauxiliarydataMyFramefromtheactive
frame.
|AUXZONE:Auxname|
RetrievesauxiliarydatanamedAuxnamefromaspecificzone.Forexample,
|AUXZONE[3]:BC|retrievesauxiliarydataBCfromzone3.
|AXISMAXn|
Maximumvalueofthenaxisrange,wherenisoneof:Aa,R,X,YorZ.
|AXISMINn|
Minimumvalueofthenaxisrange,wherenisoneof:Aa,R,X,YorZ.
|BYTEORDERING|
Returnsthebyteordering(INTELorMOTOROLA).
|DATASETFNAME|
Returnsthedatasetfilename.
|DATASETTITLE|
Returnsthetitleofthedataset,orNoDataSetifadatasetdoesnotexist.
|DATE|
ReturnsthedateintheformofddMmmyyyy.
|ENDSLICEPOS|
Returnsthepositionoftheendslice.
|EXPORTISRECORDING|
ReturnsYES/NOtohelpmacroscompleterecordcommandsintheproperorder.
|FRAMENAME|
Returnsthenameoftheactiveframe.
|INBATCHMODE|
Returns1ifinbatchmode,0ifininteractivemode.
|ISDATASETAVAILABLE|
Returns1ifadatasetexists,and0otherwise.
|ISOSURFACELEVEL|
Returnsthecurrentisosurfacesisovalue.
|LAYOUTFNAME|
Returnsthecurrentlayoutfilename.
|LOOP|
Innermostloopcounter.
|MACROFILEPATH|
Returnsthepathtothedirectorycontainingthemostrecentlyopenedmacrofile.
|MAXB|
Maximumvalueoftheblankingvariable.
|MAXC|
Maximumvalueofthecontourvariable.
|MAXI|,|MAXJ|,|MAXK|
[I,JorK]dimensionofthefirstactivezone(2Dor3DCartesianplotsonly).For
finiteelementzones,MAXIreturnsthetotalnumberofnodes,MAXJreturnsthe
totalnumberofelementsandMAXKreturnsthenumberofnodesperface
(cellbased)ortotalnumberoffaces(facebased).
|MAXn|
Maximumvalueofthevariableassignedtothenaxis,wherenisoneof:Aa,R,X,Y,
orZ.
|MAXS|
Maximumvalueofthescattersizingvariableintheactivezones.
|MAXU|,|MAXV|,
|MAXW|
Maximumvalueofthevariableassignedtothe[X,Y,Z]vectorcomponentofthe
activezones.
|MAXVAR[nnn]|
Maximumvalueofthevariablennn.
20
Internal Variables
Variables
Notes
|MINB|
Minimumvalueoftheblankingvariable.
|MINC|
Minimumvalueofthecontourvariable.
|MINS|
Minimumvalueofthescattersizingvariablefortheactivezones.
|MINU|,|MINV|,
|MINW|
Minimumvalueofthevariableassignedtothe[X,Y,Z]vectorcomponentforthe
activezones.
|MINVAR[nnn]|
Minimumvalueofthevariablennn.
|MINn|
Minimumvalueofthevariableassignedtothenaxis,wherenisoneof:Aa,R,X,Y,
orZ.
|NUMFRAMES|
Numberofframes.
|NUMFIELDMAPS|
Numberoffieldmapsassignedtotheactiveframe.
|NUMLINEMAPS|
Numberoflinemapsassignedtotheactiveframe.
|NUMPROCESSORSUSED|
NumberofprocessorsthatTecplot360uses.Thismaydifferfromthetotalnumber
inthemachineifthe$!LimitsMaxAvailableProcessorsconfiguresusagedifferently.
Bydefault,Tecplot360usesallavailableprocessorsinthemachine.
|NUMVARS|
Numberofvariablesinthecurrentdataset.
|NUMZONES|
Numberofzonesinthecurrentdataset.
|OPSYS|
Returns1=UNIX/Linux/Macintosh,2=Windows.
|PAPERHEIGHT|
Theheightofthepaper(ininches).
|PAPERSIZE|
Thesizeofthepaper(e.g.LetterorA4).
|PAPERWIDTH|
Thewidthofthepaper(ininches).
|PLATFORMNAME|
Returnsthetypeofplatform(e.g.SGIorWindows).
|PLOTTYPE|
Returnstheplottypeofaframe.0=Sketch,1=XYLine,2=2D,3=3D,4=Polar
Line.
|PRINTFNAME|
Returnsthefilenameofthelastfilesentforprinting.
|SLICEPLANETYPE|
Planetypetowhichslicesareassigned.
|SOLUTIONTIME|
Thecurrentsolutiontimeforthespecifiedzone,fieldmap,orlinemap.
|STARTSLICEPOS|
Positionofthefirstsliceinagroup.
|STREAMSTARTPOS|[nnn]
IndicatesthestartingpositioninX,Y,Zcoordinatesofstreamtracenumbernnn.For
example,toindicatethestartingpositionofthefirststreamtrace,use
|STREAMSTARTPOS[1]|.
|STREAMTYPE|
Returnsstreamtracetype,suchasSurfaceLineorSurfaceRibbon.
|TECHOME|
Pathtothehomedirectory.
|TECPLOTVERSION|
TheversionnumberoftheTecplotproduct.
|TIME|
Thecurrenttimeintheformofhh:mm:ss.
|VARNAME|
Thenameofavariablespecifiedbyindex.
21
Macro Variables
Variables
Notes
|ZONEMESHCOLOR[nnn]
|
Returnsthecolorofthemeshforzonennn.
|ZONENAME[nnn]|
Returnsthenameofzonennn.
a. where A represents the theta (or angle) axis variable in Polar Line plots.
7-2
System Environment Variables
SystemenvironmentvariablescanbeaccesseddirectlyfromwithinTecplot360byprecedingan
environmentvariablenamewitha$andsurroundingitwithverticalbars(|).Usingenvironment
variableswithinTecplot360addsanotherdegreeofflexibilitytomacrosbytakingadvantageofeach
userscustomizedenvironment.
Ifanenvironmentvariableismissing,anerrorisgeneratedandmacroprocessingisterminated.
7 - 2.1
Example 1
Tocompareamacrovariablewithanenvironmentvariable:
$!IF|SESSION_COEFF|==|$DEFAULT_COEFF|
#(performsomedefaultprocessinghere)
$!ENDIF
WheretheDEFAULT_COEFFenvironmentvariablewassettosomespecifiedvalueoftypedoublebefore
startingTecplot360.
7 - 2.2
Example 2
Tocreateastringfromanenvironmentvariable:
UserDefinedVariables
$!VARSET|AUTHOR|="Author:|$LOGNAME|"
Userdefinedvariablesarewrittenusingthemacrovariablenamesurroundedbyverticalbars(|).The
variablenamecanbeupto32charactersinlength.Ifamacrovariableisdefined(usingthe$!VARSET
command)anditisnamedthesameasanexistinginternalmacrovariable,thentheuserdefinedvariable
takesprecedenceandtheinternalvalueisnoteffected.Theinternalmacrovariablecanberecoveredifyou
removetheuserdefinedvariableusing$!REMOVEVAR.
7-3
Assigning Values to Macro Variables
The$!VARSETcommandisusedtoassignavaluetoamacrovariable.The$!VARSETcommandhasthe
followingsyntax:
$!VARSET<macrovar><op><double>
where<op>canbeoneof=,=,+=,*=,or/=.
22
Assigning a String to a Macro Variable
Examples:
Example 1:
Add2tothemacrovariable|ABC|:
$!VARSET|ABC|+=2
Example 2:
Set|ABC|tobeequalto37:
$!VARSET|ABC|=37
Example 3:
Multiply|ABC|by1.5:
$!VARSET|ABC|*=1.5
7-4
Assigning a String to a Macro Variable
Macrovariablescanbeassignedtostringsaswellastovalues.Whenusingstrings,onlythe=operator
maybeused.
Example:
Assignthestringmyfile.plttothevariable|FNAME|.Use|FNAME|inthe$!READDATASETcommand:
$!VARSET|FNAME|="myfile.plt"
$!READDATASET"|FNAME|"
Notethatdoublequotes(")hadtobeusedinthe$!READDATASETcommandeventhough|FNAME|repre
sentsastring.
7-5
Replacement Text Use
Youcanassignreplacementtexttoamacrovariable.Thisisusefulforhandlingcaseswhereamacro
variablemaynotbeinitialized.Amacrovariablewith|AAAA:=XXXXX|willproduceXXXXXifAAAAisnot
defined.Thisdoesnotworkwithintrinsicvariables.
Example:
ReadinadatafileassignedtothevariableFNAME.IfFNAMEisunassigned,readin"t.dat":
$!READDATASET"|FNAME:=t.dat|"
"|FNAME:=t.dat|"
7-6
Macro Function Variables
Macrofunctionvariablesarewrittenusinganumbern,surroundedbyverticalbars(|).Thenumber
representsthenthparameterfromthe$!RUNMACROFUNCTIONcommand.
23
Macro Variables
Examples:
Example 1:
Thefollowingcommandsdefineamacrofunctionthatusestwoparametersandacommandtorun
themacrofunction.ThefirstparametertothemacrofunctionistheamounttorotateabouttheXaxis
andthesecondparameteristheamounttorotateabouttheYaxis:
Thecommandtorunthemacrofunctionwillcausearotationof10degreesabouttheXaxisand20
degreesabouttheYaxis.
#!MC1120
$!MACROFUNCTIONNAME="3DRotationAnimation"
$!EXPORTSETUPEXPORTFORMAT=AVI
$!EXPORTSETUPIMAGEWIDTH=546
$!EXPORTSETUPEXPORTFNAME="|1|AxisRotation.avi"
$!EXPORTSTART
$!LOOP|2|
ANGLE=3
ROTATEORIGINLOCATION=DEFINEDORIGIN
$!REDRAW
$!EXPORTNEXTFRAME
$!ENDLOOP
$!EXPORTFINISH
$!ENDMACROFUNCTION
$!RUNMACTOFUNCTION"3DRotationAnimation"(Theta",6,30)
Example 2:
Thefollowingcommandsdefineamacrofunctionthatopenstwolayoutfiles:
$!MACROFUNCTION
NAME="OL2"
$!OPENLAYOUT"|1|"
$!OPENLAYOUT"|2|"
APPEND=TRUE
$!ENDMACROFUNCTION
.
.
.
$!RUNMACROFUNCTION"OL2"("g1.lay","g2.lay")
7-7
Using Formats in Macro Variables
Whenamacrovariableisexpandedandthemacrovariableisanumericvalue,itisexpandedusingabest
floatformat.Ittriestomakethenumberlookassimpleaspossiblewhilestillretainingasmuchaccuracy
aspossible.IfyouwantthenumbertobeformattedinaspecificwaythenyoucanincludeCstylenumber
formattingstringsinthemacrovariablespecification.
Thesyntaxforincludingaformatstringis:
|macrovariable%formatstring|
Thefollowingformatsareavailable:
sstringofcharacters
dsignedinteger
escientificnotationwithalowercasee
EscientificnotationwithanuppercaseE
24
Using Formats in Macro Variables
ffloatingpoint
guse%eor%f,whicheverisshorter
Guse%Eor%f,whicheverisshorter
uunsignedinteger,writtenoutindecimalformat
ounsignedinteger,writtenoutinoctalformat
xunsignedinteger,writtenoutinhexadecimal(whereafarelowercase)
Xunsignedinteger,writtenoutinhexadecimal(whereAFareuppercase)
Example 1:
Supposeyouwanttopauseamacroanddisplaythemessage "Maximumcontourvalueis: xxxxxx"
wherexxxxxxonlyhastwodigitstotherightofthedecimalplace.Youwoulduse:
$!Pause"Maximumcontourvalueis:|MAXC%.2f|"
If|MAXC|currentlyhasavalueof356.84206thenthedialogwouldshow:
"Maximumcontourvalueis:356.84"
Example 2:
If,intheaboveexample,youwantedtouseexponentialformatyoucoulduse:
$!Pause"Maximumcontourvalueis:|MAXC%12.6e|"
Heretheresultwouldbe:
"Maximumcontourvalueis:3.568421e+02"
25
Macro Variables
26
8
Macro Command Summary
ThischapterpresentsabrieflistofthemajormacrocommandsinTecplot360.Allmajormacrocommands
areprecededby$!(dollarsign,exclamationmark).
$!ACTIVEFIELDMAPS.........................................................................................................................................55
ASetValuecommandthatchangesthesetofactivefieldmaps(thuschangingtheactivezones)considered
forplotting.
$!ACTIVELINEMAPS ...........................................................................................................................................56
ASetValuecommandthatchangesthesetoflinemappingsconsideredforplotting.
$!ADDMACROPANELTITLE..............................................................................................................................56
AddatitletotheQuickMacroPanel.
$!ALTERDATA........................................................................................................................................................56
TheALTERDATAfunctionoperatesonadatasetwithinTecplot360usingFORTRANlikeequations.SeeSec
tion211DataAlterationthroughEquationsintheUsersManualformoreinformationonusingequa
tions in Tecplot 360. The <zonelist> parameter specifies the set of zones on which to operate, where
zonelist is a list of zones or zone ranges separated by a comma (,). Zone ranges are separated by a
hyphen().If<zonelist>isomitted,allzonesareaffected.NOTE:thevaluesforthe<zonelist> parameter
mustbeenclosedinsquarebrackets.(Forexample,use $!ALTERDATA [1,3]toapply ALTERDATAtozones1
and3).
$!ANIMATECONTOURLEVELS........................................................................................................................58
Produce an animation of a contour line plot by showing a single level at a time. The animation varies
accordingtothecurrentlydefinedcontourlevelsandislimitedbythevaluesinthe START, END,and SKIP
parameters.TocreateanAVIorRMfile,add$!EXPORTSETUPcommandsbeforethiscommand.
27
$!ANIMATEIJKBLANKING................................................................................................................................ 59
ProduceananimationofdifferentIJKblankingsinyourplot.TheanimationstartsatoneIJKblankingset
ting and marches through intermediate steps to a second setting. To create an AVI or RM file, add
$!EXPORTSETUPcommandsbeforethiscommand.
$!ANIMATEIJKPLANES ...................................................................................................................................... 60
ProduceananimationthatcyclesthroughI,J,orKplanesinanIJKordereddataset.TocreateanAVIor
RMfile,add$!EXPORTSETUPcommandsbeforethiscommand.
$!ANIMATEISOSURFACES................................................................................................................................ 61
The macro command $!ANIMATEISOSURFACES produces an animation of a series of isosurfaces beginning
withtheisosurfacedefinedby STARTVALUEandendingwiththeisosurfacedefinedby ENDVALUE.Tocreate
anAVIorRMfile,add$!EXPORTSETUPcommandsbeforethiscommand.
$!ANIMATELINEMAPS....................................................................................................................................... 62
ProduceananimationofoneLinemappingatatime.TocreateanAVIorRMfile,add$!EXPORTSETUPcom
mandsbeforethiscommand.
$!ANIMATESLICES .............................................................................................................................................. 63
Themacrocommand$!ANIMATESLICESusesthecurrentlydefinedstartandendsliceposition.Use$!SLICE
ATTRIBUTES tosetthesepositions; $!ANIMATESLICESthenredefineshowmanyintermediateslicesaretobe
used,thenanimatesasubsetofthoseslices.TocreateanAVIorRMfile,add $!EXPORTSETUPcommands
beforethiscommand.
$!ANIMATESTREAM ........................................................................................................................................... 64
Produceananimationofstreammarkersordashes,movingalongthecurrentlydefinedstreamtracepaths.
TocreateanAVIorRMfile,add$!EXPORTSETUPcommandsbeforethiscommand.
$!ANIMATETIME.................................................................................................................................................. 64
Produceananimationoftransientdata.TocreateanAVIorRMfile,add$!EXPORTSETUPcommandsbefore
thiscommand.
$!ANIMATEZONES .............................................................................................................................................. 65
Produceananimationshowingonezoneatatime.TocreateanAVIorRMfile,add $!EXPORTSETUPcom
mandsbeforethiscommand.Thiscommandwillnotworkiftheactiveframecontainsatransientdataset.
$!ATTACHDATASET ............................................................................................................................................ 66
Attachtheactiveframetothedatasetofanotherframe.UsePAGENUM,iftheotherframeisonadiffer
ence page. This command is usually found only in layout files generated by Tecplot 360. Note that the
$!PLOTTYPEcommandautomaticallyexecutesan$!ATTACHDATASETcommandifaframemodeisrequestedin
aframethatdoesnothaveanattacheddataset.Tecplot360attachesthedatasetfromtheclosestframe(in
drawingorder)havinganattacheddataset.
$!ATTACHGEOM .................................................................................................................................................. 67
Attachageometrytotheactiveframe.
28
$!ATTACHTEXT .....................................................................................................................................................69
Attachtexttotheactiveframe
$!BASICCOLOR .....................................................................................................................................................71
ASetValuecommandthatsetsthered,greenandbluecomponentsforanyofthebasiccolorsinTecplot
360.
$!BASICSIZE...........................................................................................................................................................72
ASetValuecommandthatsetssizesofvariousobjectslikelinethicknesses,linepatternlength,fontheight,
andsoforth.SizescanbeassignedwheninteractingwithTecplot360byeitherenteringanexactvalueor
bychoosingfromapresetlistofvalues.The$!BASICSIZEcommandallowsyoutochangethevaluesinthe
presetlists.
$!BLANKING..........................................................................................................................................................73
ASetValuecommandthatchangessettingsforIJKorvalueblanking.
$!BRANCHCONNECTIVITY..............................................................................................................................75
Forzoneswhereconnectivityisshared,thiscommandallowsforbranchingofconnectivityinformation
fromthespecifiedzone.
$!BRANCHFIELDDATAVAR...............................................................................................................................76
Allowsforbranchingofspecifiedvariableinthespecifiedzoneforzonesthatsharevariables.
$!BREAK ..................................................................................................................................................................76
Jumpoutofthecurrent$!LOOPENDLOOPor$!WHILE$!ENDWHILE.
$!COLORMAPCONTROL[<groupnumber>][RequiredControlOption] ................................................76
ThedifferentcommandsintheCOLORMAPCONTROLcompoundfunctionfamilyaredescribedseparatelyinthe
followingsections.Groupnumberisanoptionalparameterrangingfrom1to8,whichdefaultsto1when
omitted.
$!COLORMAPCONTROL[<groupnumber>]REDISTRIBUTECONTROLPOINTS ..............................77
Redistributethecontrolpointsforthecurrentlyactivecolormapsotheyareevenlyspacedacrossthecolor
map. This is equivalent to clicking Redistribute Control Points in the Color Map dialog. This does not
changetheRGBvaluesassignedateachcontrolpoint.Groupnumberisanoptionalparameterranging
from1to8,whichdefaultsto1whenomitted.
$!COLORMAPCONTROL[<groupnumber>]COPYSTANDARD ..............................................................77
Preseteithertheuserdefinedcolormaportherawuserdefinedcolormaptobeacopyofoneofthestan
dardcolormaps.Tecplot360mustcurrentlybeusingeithertheuserdefinedcolormaportherawuser
definedcolormapinordertousethisfunction.Groupnumberisanoptionalparameterrangingfrom1to
8,whichdefaultsto1whenomitted.
29
$!COLORMAPCONTROL[<groupnumber>]RESETTOFACTORY ........................................................... 77
RedistributethecontrolpointsandresettheRGBvaluesforthecurrentlyactivecolormap.Thisisequiva
lenttoclickingResetontheColorMapdialog.Groupnumberisanoptionalparameterrangingfrom1to
8,whichdefaultsto1whenomitted.
$!COMPATIBILITY ............................................................................................................................................... 77
Allowdatasharingaccessandsetting,withoutwarning.
$!CONTINUE.......................................................................................................................................................... 78
Transfercontrolbacktonearest$!LOOPor$!WHILE.
$!CONTOURLABELS[RequiredControlOption] ......................................................................................... 78
Thedifferentcommandsinthe CONTOURLABELScompoundfunctionfamilyaredescribedseparatelyinthe
followingsections.
$!CONTOURLABELSADD................................................................................................................................. 78
Addcontourlabelstoyourplot.
$!CONTOURLABELSDELETEALL................................................................................................................... 79
Deleteallcurrentlydefinedcontourlabels.
$!CONTOURLEVELS[RequiredControlOption] ......................................................................................... 79
Thedifferentcommandsinthe CONTOURLEVELScompoundfunctionfamilyaredescribedseparatelyinthe
followingsections.
$!CONTOURLEVELSADD................................................................................................................................. 80
Addanewsetofcontourlevelstotheexistingsetofcontourlevels.
$!CONTOURLEVELSDELETENEAREST........................................................................................................ 80
DeletethecontourlevelwhosevalueisnearestthevaluesuppliedintheRANGEMINparameter.
$!CONTOURLEVELSDELETERANGE............................................................................................................ 81
Deleteallcontourlevelsbetweenaminimumandmaximumcontourvalue(inclusive).
$!CONTOURLEVELSNEW................................................................................................................................. 81
Replacethecurrentsetofcontourlevelswithanewset.
$!CONTOURLEVELSRESET.............................................................................................................................. 82
Resetthe contour levels toasetofevenly distributedvalues spanningthe entirerangeofthe currently
selectedcontouringvariable.
$!CONTOURLEVELSRESETTONICE.............................................................................................................. 82
Resetthecontourlevelstoasetofevenlydistributed,nicevaluesspanningtheentirerangeofthecur
rentlyselectedcontouringvariable,withaspecifiednumberofentries.
30
$!CREATECIRCULARZONE ...............................................................................................................................83
Createacircular(orcylindrical)IJorIJKorderedzone.
$!CREATEBOUNDARYZONES ..........................................................................................................................83
WhenYES,boundaryzonesarecreated.UsethiscommandwhenworkingwithStarCCMdatatopreserve
backwardcompatibility.(StarCCMLoaderONLY)
$!CREATECONTOURLINEZONES ...................................................................................................................84
Createzonesfromthecurrentlydefinedcontourlines.Onezonecanbecreatedfromeachcontourlevelin
thatplot,oronezoneforeverypolylinecanbegenerated.
$!CREATEFEBOUNDARY....................................................................................................................................85
ZoneedgesforfiniteelementdatacannotbeturnedonoroffusingtheedgeplotlayerinTecplot360.You
can,however,createaseparatezonewhichistheboundaryofafiniteelementzone.Thisnewzonecan
thenbeturnedonoroff.
$!CREATEFESURFACEFROMIORDERED ......................................................................................................85
AFESurfacezonecanbegeneratedfromtwoormoreIOrderedzones.Togetthebestpossibleoutput,it
isrecommendedthatthesourcezonesshouldhavetheirnodesarrangedinasimilarmannersothatthe
connectinglinesbetweenpointsareasstraightforwardaspossible.Forthisreason,indicesfromsource
zonesshouldincreaseinthesamedirection.
$!CREATEISOZONES ...........................................................................................................................................86
Createzonesfromthecurrentlydefinedisosurfaces.Onezonewillbecreatedfromeachdefinedisosur
face.Theisosurfacesmustbeactiveandyoumusthaveatleastoneactivevolumezone.
$!CREATELINEMAP .............................................................................................................................................86
CreateanewLinemapping.
$!CREATEMIRRORZONES.................................................................................................................................86
Createnewzonesthataremirrorimagesofthesourcezones
$!CREATENEWFRAME ........................................................................................................................................87
Createsanewframe.
$!CREATERECTANGULARZONE .....................................................................................................................88
Createarectangularzone.Ifnodatasetexistswhenthiscommandisexecuted,adatasetiscreatedwith
variablesX,Y(andZ,ifKMax>1).Ifadatasetexistspriortothiscommand,thenoncoordinatevariables
forthezonecreatedareinitializedtozero.
$!CREATESIMPLEZONE .....................................................................................................................................88
CreateanewzonebyspecifyingonlyalistofXYpairsofdata.Ifotherzonesexistpriortousingthisfunc
tionandtherearemorethan2variables,thentheadditionalvariablesarealsocreatedandsettozero.
31
$!CREATESLICEZONEFROMPLANE............................................................................................................... 89
Createanewzoneasaslicethroughexisting3Dvolumezones.Use$!GLOBALTHREEDtodefinetheslic
ingplaneorientation.
$!CREATESLICEZONES ...................................................................................................................................... 89
CreateanewzoneforeachslicedefinedontheSliceDetailsdialog.Onlycreatesslicesfromvolumezones.
$!CREATESPHERICALZONE ............................................................................................................................. 90
CreateasphericalIJKorderedzone.
$!CREATESTREAMZONES................................................................................................................................. 91
Createoneormorezonesoutofthecurrentlydefinedstreamtraces.Thenewzoneshavethesamenumber
ofvariablesperdatapointastheotherzonesinthedatasetwithallnoncoordinatevariablesinterpolated
atthepositionsalongthestreamtrace.
$!DATASETUP........................................................................................................................................................ 91
ASetValuecommandthatsetsmiscellaneousparametersrelatedtodata.
$!DEFAULTGEOM ................................................................................................................................................ 92
ASetValuecommandthatsetstheattributesforthedefaultgeometry.Whenageometryiscreatedinterac
tively,itscolor,linethickness,andsoforth,arepresetbasedonthedefaultgeometry.Thiscommandis
usuallyusedonlyintheTecplot360configurationfile.
$!DEFAULTTEXT ................................................................................................................................................... 92
ASetValuecommandthatsetstheattributesforthedefaulttext.Whentextisaddedtoaplotinteractively,
itsfont,color,size,andsoforth,arebasedonthedefaulttext.Thiscommandisusuallyusedonlyinthe
Tecplot360configurationfile.
$!DELAY................................................................................................................................................................... 93
DelayTecplot360executionfor<integer>seconds.
$!DELETEAUXDATA ............................................................................................................................................ 93
DeleteAuxiliaryDataintheformofname/valuepairsfromzones,framesordatasets.
$!DELETELINEMAPS ........................................................................................................................................... 94
DeleteoneormoreLinemappings.If<set>isomittedthenallLinemappingsaredeleted.
$!DELETEVARS...................................................................................................................................................... 94
Deleteoneormorevariables.
$!DELETEZONES .................................................................................................................................................. 94
Deleteoneormorezones.
32
$!DOUBLEBUFFER[RequiredControlOption] .............................................................................................95
ThedifferentcommandsintheDOUBLEBUFFERcompoundfunctionfamilyaredescribedseparatelyinthefol
lowingsections.
$!DOUBLEBUFFEROFF.......................................................................................................................................95
Turnoffdoublebuffering;usethiscommandonceattheendofasequenceofusingthedoublebuffer.
$!DOUBLEBUFFERON ........................................................................................................................................95
Turnondoublebuffering;usethiscommandonceatthebeginningofasequenceofusingthedoublebuf
fer.Whiledoublebufferingisturnedonalldrawingissenttothebackbuffer.
$!DOUBLEBUFFERSWAP ...................................................................................................................................95
Swapthebackbuffertothefront.Inotherwords,copytheimageinthebackbuffertothefront.
$!DRAWGRAPHICS..............................................................................................................................................96
Turnonoroffallgraphicsdrawing.Turningoffallgraphicsduringpreliminaryportionsofamacrofile
cangreatlyincreasetheefficiencyofthemacro.
$!DROPDIALOG ...................................................................................................................................................96
DropaTecplot360interfacedialog.ThiscommandismainlyusefulfortheTecplot360demo.Tolauncha
dialoguse$!LAUNCHDIALOG.
$!DUPLICATELINEMAP......................................................................................................................................96
CopyattributesfromanexistingLinemappingtoanother.
$!DUPLICATEZONE .............................................................................................................................................96
Makeacopyofanexistingzone.Youcanassignindexrangestocreateanewzonewhichisasubsetofthe
sourcezone.
$!ELSE.......................................................................................................................................................................97
Conditionallyhandlemacrocommands.Usedwhenan$!IFstatementisFALSE.
$!ELSEIF ...................................................................................................................................................................98
Conditionally handle macro commands. Used to create multiple options for statements should an $!IF
statementbeFALSE.
$!EXPORT ................................................................................................................................................................99
ExportanimagefilefromTecplot360.Seethe$!EXPORTSETUPcommandfordetailsonsettingupthe
exportedimagetype.The$!EXPORTcommandisnotvalidforanimationformats.(AVIandRasterMetafile.)
$!EXPORTCANCEL ...............................................................................................................................................99
Canceloutofthecurrentexportanimationsequence.Theanimationfilebeinggeneratedisremoved.
33
$!EXPORTFINISH.................................................................................................................................................. 99
Signalsthecompletionofananimationsequenceandcausestheanimationfiletobecreated.Youmustcall
$!EXPORTSTARTpriortousing $!EXPORTFINISH.Thiscommandisonlyvalidforanimationformats.(AVIand
RasterMetafile.)Youmayusethe |EXPORTISRECORDING|intrinsicvariabletomakesurethatananimation
sequencehasbeeninitiated.
$!EXPORTNEXTFRAME .................................................................................................................................... 100
Records the next frameof an animation. You must call $!EXPORTSTARTprior to calling $!EXPORTNEXTFRAME.
Thiscommandisonlyvalidforanimationformats.(AVIandRasterMetafile.Youmayusethe|EXPORTIS
RECORDING|intrinsicvariabletomakesurethatananimationsequencehasbeeninitiated.)
$!EXPORTSETUP ................................................................................................................................................. 100
ASetValuecommandthatsetstheattributesforexportingimagefilesfromTecplot360.Exportingisusu
allyintendedasa meanstotransferimagesfromTecplot360tobeimportedbyotherapplications.See
$!PRINTSETUPand$!PRINTforgeneratingoutputintendedforprintersandplotters.
$!EXPORTSTART ................................................................................................................................................. 101
Signalsthestartofananimationsequenceandrecordsthefirstframeoftheanimation.Thiscommandis
onlyvalidforanimationformats.(AVIandRasterMetafile.)
$!EXTENDEDCOMMAND................................................................................................................................ 102
Sendacommandtoanaddon.Theaddonregistersthenameofafunctionthatwillbecalledwhenan
$!EXTENDEDCOMMANDisprocessed.Tecplot360knowswhichregisteredfunctiontocallbasedontheCOMMAND
PROCESSORIDstring.SeethefunctionTecUtilMacroExtCommandCallbackintheADKReferenceManual.
$!EXTRACTFROMGEOM.................................................................................................................................. 102
Extractdatafroma2or3Dfieldplot.Thelocationsatwhichtoextractthedatacomefromapolyline
geometrythatmustbepickedpriortoissuingthiscommand.
$!EXTRACTFROMPOLYLINE .......................................................................................................................... 103
Extractdatafroma2or3Dfieldplot.Thelocationsofwheretoextractthedatafromcomefromasup
pliedpolylineintheformof<xyzrawdata>.
$!FIELDLAYERS ................................................................................................................................................... 104
ASetValuecommandthatturnsfieldplotlayersonoroff,orsetsthe2Ddraworder.
$!FIELDMAP......................................................................................................................................................... 104
ASetValuecommandthatassignszoneattributesforfieldplots.The<set>parameterimmediatelyfollow
ingthe $!FIELDMAP commandisoptional.If<set>isomittedthentheassignmentisappliedtoallzones.
Otherwisetheassignmentisappliedonlytothezonesspecifiedin<set>.
$!FILECONFIG ..................................................................................................................................................... 107
ASetValuecommandthatsetsfilepathinformationinTecplot360.
34
$!FONTADJUST ...................................................................................................................................................110
A SetValue command that sets character spacing and sizing for fonts in Tecplot 360. These parameters
rarelychange.
$!FRAMECONTROL[RequiredControlOption].........................................................................................110
ThedifferentcommandsintheFRAMECONTROLcompoundfunctionfamilyaredescribedseparatelyinthefol
lowingsections.Whenworkingwiththe FRAMECONTROLcommands,itmayhelptorealizethatacommand
containingActivatechangestheactiveframe;acommandcontainingMoveTochangestheframedraw
ingorder.
$!FRAMECONTROLACTIVATETOP.............................................................................................................110
Changestheactiveframetotheframethatistopmostintheframedrawingorder.
$!FRAMECONTROLACTIVATENEXT ..........................................................................................................111
Changes the active frame to the next one up in the frame drawing order, or to the bottom frame if the
activeframeisatthetop.
$!FRAMECONTROLACTIVATEPREVIOUS ................................................................................................111
Changestheactiveframetothenextonedownintheframedrawingorder,ortothetopframeiftheactive
frameisatthebottom.
$!FRAMECONTROLACTIVATEATPOSITION ...........................................................................................111
Activatesthetopmostframeatthespecifiedposition.XandYareinpapercoordinates.
$!FRAMECONTROLACTIVATEBYNAME ...................................................................................................111
Changestheactiveframetothespecifiedframe.Ifnoframenameisgiven,thiswillactivatethebottom
frame.
$!FRAMECONTROLACTIVATEBYNUMBER..............................................................................................112
Changestheactiveframetothespecifiedframe.
$!FRAMECONTROLMOVETOTOPACTIVE ...............................................................................................112
Movestheactiveframetothetopofthedrawingorder.
$!FRAMECONTROLMOVETOTOPBYNAME ............................................................................................112
Movestheframespecifiedbynametothetopoftheframedrawingorder.
$!FRAMECONTROLMOVETOTOPBYNUMBER .......................................................................................113
Movestheframespecifiedbynumbertothetopoftheframedrawingorder.Ifnoframenumberisspeci
fied,thiscommandwillmovethebottomframetothetopoftheframedrawingorder.
$!FRAMECONTROLMOVETOBOTTOMACTIVE.....................................................................................113
Movestheactiveframetothetopoftheframedrawingorder.
35
$!FRAMECONTROLMOVETOBOTTOMBYNAME .................................................................................. 113

Movestheframespecifiedbynametothebottomoftheframedrawingorder.
$!FRAMECONTROLMOVETOBOTTOMBYNUMBER............................................................................. 113
Movestheframespecifiedbynumbertothebottomoftheframedrawingorder.
$!FRAMECONTROLDELETEACTIVE .......................................................................................................... 114
Deletetheactiveframe.
$!FRAMECONTROLFITALLTOPAPER ......................................................................................................... 114
Resizeallframessothattheyfitinsidethehardcliplimitsofthepaper.
$!FRAMELAYOUT............................................................................................................................................... 114
ASetValuecommandthatsetstheposition,border,andbackgroundattributesfortheactiveframe.Use
the$!FRAMECONTROLactioncommandtopushandpopframesifyouwanttochangethesettingsforaframe
otherthantheactiveframe.
$!FRAMENAME................................................................................................................................................... 115
Setthenamefortheactiveframe(Default=Frame001).
$!FRAMESETUP................................................................................................................................................... 115
ASetValuecommandthatsetsparametersusedtopresetdynamicframeattributeswhenaframeisinitial
ized.
$!GETAUXDATA .................................................................................................................................................. 116
RetrieveAuxiliaryDataintheformofname/valuepairsandsaveittothemacrovariable.
$!GETCONNECTIVITYREFCOUNT............................................................................................................... 117
Fetchthecountofhowmanyzonesshareconnectivitywiththespecifiedzone.Countincludesspecified
zone.
$!GETCURFRAMENAME.................................................................................................................................. 117
Query Tecplot 360 for the name of the active frame. The <macrovar> represents the macro variable to receive the
results.
$!GETFIELDVALUE ............................................................................................................................................ 118
Fetchthefieldvalue(datasetvalue)atthespecifiedpointindexandassignthevalueto<macrovar>.Ifthe
zonereferencedisIJorIJKordered,thenthepointindexiscalculatedbytreatingthe2or3Dimensional
arrayasa1Darray.
$!GETFIELDVALUEREFCOUNT ..................................................................................................................... 118
Getthecountofhowmanyzonessharetheindicatedvariablewiththespecifiedzone.Countincludesthe
specifiedzone.
36
$!GETNODEINDEX ............................................................................................................................................119
Thisfunctiononlyworksforfiniteelementzones.Queryforthenodeindexinthespecifiedlocationas
describedbytheZONE,ELEMENT,andCORNERparameters.
$!GETVARLOCATION .......................................................................................................................................119
ReturnsthelocationofthevariableinthezoneaseitherCELLCENTEREDorNODALandsavesinthe
macrovariable.
$!GETVARNUMBYNAME.................................................................................................................................120
Givenavariablename,getthenumberforthatvariable.Thisvariablenumbercanthenbeusedtoassign
attributes,suchaswhatvariabletouseforcontouring.
$!GETZONETYPE ................................................................................................................................................120
Queryforthezonetypeofthespecifiedzone.Thezonetypewillbeassignedto<macrovar>.
$!GLOBALCOLORMAP.....................................................................................................................................121
A SetValue command that changes the settings for the global contour color map and the global light
source shading color map in Tecplot 360. Changes here affect all frames using these color maps. See
$!GLOBALCONTOUR COLORMAPFILTER for additional settings that can be applied on a frameby
framebasis.
$!GLOBALCONTOUR........................................................................................................................................122
ASetValuecommandthatchangesglobalattributesassociatedwithcontourplotsorcontourlevels.The
optionalparameter<contourgroup>referstothedefinedcontourgroups,18,allowedinTecplot360,and
takesan integer value ofonethrough eight.The<contourgroup>parameterisoptional,andif omitted,
Tecplot 360 will use contour group 1. If you would like the settings in these commands to persist, add
themtoyourtecplot.cfgfile,locatedinyourinstallationdirectory.The NUMBERFORMATsettingfor LABELSalso
controlsthenumberformatinthelegend.
$!GLOBALEDGE..................................................................................................................................................125
ASetValuecommandthatsetsattributeswhichsetstheminimumcreaseangleforedges.
$!GLOBALFRAME...............................................................................................................................................125
ASetValuecommandthatsetsattributeswhichapplytoallframes.Ifyouwouldlikethesettingsinthis
commandtopersist,addittoyourtecplot.cfgfile,locatedinyourinstallationdirectory.
$!GLOBALLINEPLOT.........................................................................................................................................126
ASetValuecommandthatchangesglobalattributesassociatedwithLineplots.Ifyouwouldliketheset
tingsinthesecommandstopersist,addittoyourtecplot.cfgfile,locatedinyourinstallationdirectory.
$!GLOBALLINKING...........................................................................................................................................127
SettoYEStotieallcolormapstogether.Ifyouwouldlikethesettingsinthiscommandtopersist,additto
yourtecplot.cfgfile,locatedinyourinstallationdirectory.
37
$!GLOBALPAPER ................................................................................................................................................ 127

ASetValuecommandthatsetsthepapersizecharacteristics.Ifyouwouldlikethesettingsinthiscom
mandtopersist,addittoyourtecplot.cfgfile,locatedinyourinstallationdirectory.
$!GLOBALPOLAR ............................................................................................................................................... 128
AllowspolarplotstohavecurvedlinesthatareinterpolatedalongtheRAxisbetweendatapoints.
$!GLOBALRGB .................................................................................................................................................... 128
Allows RGB coloring for plots which have RGB values specified at each vertex. This coloring option is
valuable for plots with entities such as Gas, Oil and Water. RGB Coloring can be assigned to field plot
objectssuchaszones,isosurfacesandslices
$!GLOBALSCATTER .......................................................................................................................................... 129
ASetValuecommandthatchangesglobalattributesassociatedwithscatterplots.
$!GLOBALTHREED ............................................................................................................................................ 131
ASetValuecommandthatchangesglobalattributesassociatedwith3Dplots.
$!GLOBALTHREEDVECTOR ........................................................................................................................... 133
ASetValuecommandthatchangesglobalattributesassociatedwith3Dvectorplots.
$!GLOBALTIME................................................................................................................................................... 134
ASetValuecommandforframes(2Dand3DONLY).Differentframescanhavedifferentvaluesof$!GLO
BALTIME.Ifyouwouldlikethesettingsinthiscommandtopersist,addthemtoyourtecplot.cfgfile(located
inyourinstallationdirectory).
$!GLOBALTWODVECTOR............................................................................................................................... 134
ASetValuecommandthatchangesglobalattributesassociatedwith2Dvectorplots.
$!IF...$!ENDIF ........................................................................................................................................................ 136
Conditionallyprocessmacrocommands.
$!INCLUDEMACRO ........................................................................................................................................... 136
Insertthecommandsfromanothermacrofile.Becausethe$!INCLUDEMACROcommandisprocessedwhenthe
macroisloadedandnotwhenthemacroisexecuted,youarenotallowedtoreferencemacrovariables
withinthe<string>parameter.
$!INTERFACE ....................................................................................................................................................... 136
ASetValuecommandthatsetsattributesrelatedtotheTecplot360interface.
$!INVERSEDISTINTERPOLATE ..................................................................................................................... 145
Interpolateselectedvariablesfromoneormorezonesontoadestinationzoneusingtheinversedistance
method.
38
$!ISOSURFACEATTRIBUTES ..........................................................................................................................146
ASetValuecommandwhichchangesattributesassociatedwithisosurfaces.Theoptionalgroupparameter
canrangefrom18anddefaultsto1whenabsent.
$!ISOSURFACELAYERS.....................................................................................................................................148
Turnisosurfacesonoroff.
$!KRIG....................................................................................................................................................................148
Interpolateselectedvariablesfromasetofsourcezonestoadestinationzoneusingthekrigingmethod.
$!LAUNCHDIALOG ...........................................................................................................................................149
LaunchaTecplot360interfacedialog;ThiscommandismainlyusefulfortheTecplot360demo.
$!LIMITS................................................................................................................................................................149
ASetValuecommandthatsetssomeoftheinternallimitsinTecplot360.SeeChapterF:LimitsofTecplot
360intheUsersManualforadditionalinformation.The$!LIMITScommandcanonlybeusedintheTec
plot360configurationfile.
$!LINEARINTERPOLATE..................................................................................................................................150
Interpolateselectedvariablesfromasetofsourcezonestoadestinationzoneusinglinearinterpolation.
ThesourcezonescannotbeIordered.Valuesassignedtothedestinationzoneareequivalenttotheresults
ofusingtheprobetoolinTecplot360.
$!LINEMAP ...........................................................................................................................................................151
ASetValuecommandthatassignsattributesforindividualLinemappings.The<set>parameterimmedi
atelyfollowingthe$!LINEMAPcommandisoptional.If<set>isomittedthentheassignmentisappliedtoall
Linemappings,otherwisetheassignmentisappliedonlytotheLinemappingsspecifiedin<set>.
$!LINEPLOTLAYERS ..........................................................................................................................................154
ASetValuecommandthatturnsonoroffLineplotlayers.
$!LINKING............................................................................................................................................................154
Linkattributesintwoormoreframessothatchangestoattributesofoneframeeffectalllinkedframes.
$!LOADADDON..................................................................................................................................................155
LoadanaddonintoTecplot360.The<string>isthenameoftheaddontoload.SeeSection331Addon
LoadingintheUsersManualforinstructionsonhowtospecifytheaddon.
$!LOADCOLORMAP..........................................................................................................................................156
Loadacolormapfile.The<string>isthenameofthefiletoload.
$!LOOP...$!ENDLOOP.........................................................................................................................................156
Processmacrocommandsinaloop.Withintheloopyoumayaccessthecurrentloopcounterusingthe
internalmacrovariable|Loop|.Loopsmaybenestedupto10levelsdeep.
39
$!MACROFUNCTION...$!ENDMACROFUNCTION.................................................................................. 156
Defineamacrofunction.Allcommandsbetweena$!MACROFUNCTIONandthe$!ENDMACROFUNCTIONareassoci
atedwiththemacrofunction NAME.Thesecommandsarenotexecutedwhentheyaredefinedbutareexe
cutedwhena $!RUNMACROFUNCTIONcommandisprocessed.Parameterscanbepassedtoamacrofunction.
Use |n|toreferencethenthparameter.(See$!RUNMACROFUNCTION).Intheuserinterface,[Crtl]M
mustbepressed,beforeusingthekeyboardshortcutspecifiedbytheKEYSTROKEoption.Forexample,ifthe
KEYSTROKEoptionissettoP,theusermustpress[CTRL]MP.
$!NEWLAYOUT.................................................................................................................................................... 157
Clearthecurrentlayoutandstartagain.
$!OPENLAYOUT .................................................................................................................................................. 157
Openandreadinanewlayoutfile.The<string>isthenameofthefiletoopen.
$!PAGE ................................................................................................................................................................... 158
ASetValuecommandthatsetsthepapercharacteristics.
$!PAGECONTROL[RequiredControlOption] ............................................................................................ 159
ThedifferentcommandsinthePAGECONTROLcompoundfunctionfamilyaredescribedseparatelyinthefol
lowingsections.
$!PAGECONTROLCREATE ............................................................................................................................. 160
Createanewpage.Thecreatedpagewillincludeaninitialframe.
$!PAGECONTROLSETCURRENTTONEXT................................................................................................. 160
Setthenextpagetobethecurrentpage.
$!PAGECONTROLSETCURRENTTOPREVIOUS....................................................................................... 160
Setthepreviouspagetobethecurrentpage.
$!PAGECONTROLSETCURRENTBYNAME................................................................................................ 160
Setthecurrentpagetothepagespecified.
$!PAGECONTROLDELETE.............................................................................................................................. 160
Deletethecurrentpage.Ifthecommandisoperatedontheonlypage,thenaninitialpageiscreatedwith
aninitialframe.
$!PAGECONTROLCLEAR................................................................................................................................ 160
Clearsallframesinthecurrentpageandcreatesadefaultinitialframe.
$!PAGEGETNAME .............................................................................................................................................. 161
Actioncommandtogetthenameofthecurrentpage.
40
$!PAGENAME.......................................................................................................................................................161
Setthenameofthepage.
$!PAUSE .................................................................................................................................................................161
Stopexecutionofamacroandoptionallydisplayadialogwithamessage.If<string>issetto ""thenno
dialogisdisplayedandtheusermustclickintheworkareatocontinue.
PauseanddisplaythemessageThisisthefirstexampleplot:
$!PICK[RequiredControlOption] ..................................................................................................................161
Thedifferentcommandsinthe PICKcompoundfunctionfamilyaredescribedseparatelyinthefollowing
sections.
$!PICKADDATPOSITION................................................................................................................................161
Attempttopickanobjectataspecificlocationonthepaper.Doesnotpoporactivateframes.
$!PICKADDALL..................................................................................................................................................162
Addallobjectsofacertaintypetothelistofpickedobjects.
$!PICKADDALLINRECT ..................................................................................................................................162
Addobjectsdefinedwithinaspecifiedregiontothelistofpickedobjects.Theregionisdefinedintermsof
the paper coordinate system. Optional filters can be used to restrict the objects selected. The region is
definedbythetwocornerpoints(X1,Y1)and(X2,Y2).
$!PICKCLEAR......................................................................................................................................................164
Deleteallobjectsthatarecurrentlypicked.(Theseobjectscannotberetrieved.)
$!PICKCOPY ........................................................................................................................................................164
Copyallobjectsthatarecurrentlypickedtothepastebuffer.
$!PICKCUT...........................................................................................................................................................164
Copyallobjectsthatarecurrentlypickedtothepastebufferandthendeletethem.
$!PICKEDIT .........................................................................................................................................................164
Performaglobaleditoperation onthecurrentlypickedobjects.Onlyoneeditoperation isallowedper
$!PICKEDITcommand.Objectsareeditedonlyifthesuppliedparameterisrelevant.Actionstakenusing
theQuickEditdialoginTecplot360generatethesecommands.
$!PICKMAGNIFY ...............................................................................................................................................166
Magnifyallpickedobjects.Theobjectswillalsobetranslatedproportionaltothedistancebetweentheir
anchorpositionandtheanchorpositionofthefirstobjectpicked.
$!PICKPASTE.......................................................................................................................................................167
Pastethecurrentlypickedobjectsfromthepastebuffertotheworkarea.
41
$!PICKPOP ........................................................................................................................................................... 167

Changetheorderinwhichobjectsaredrawnbypoppingthecurrentlypickedobjectstothefront.Only
frames,text,geometries,andthegridareafor2Dplotsareallowed.
$!PICKPUSH ........................................................................................................................................................ 167
Changetheorderinwhichobjectsaredrawnbypushingthecurrentlypickedobjectsback.Onlyframes,
text,geometries,andthegridareafor2Dplotsareallowed.
$!PICKSETMOUSEMODE ............................................................................................................................... 167
PreparetopickobjectsbysettingthemousemodetoSELECTorADJUST.Thiscommandalsoclearsthelistof
pickedobjects(thatis,unpicksallpickedobjects).
$!PICKSHIFT ....................................................................................................................................................... 168
Shift the currently picked objects. Objects are shifted relative to their starting position. X and Y shift
amountsareinpaperunits(inches).IfsnappingisineffectthenitisappliedaftershiftinginXandY.(See
theSetValuecommands$!GLOBALFRAMESNAPTOGRIDand$!GLOBALFRAMESNAPTOPAPER.)
$!PLOTOPTIONS ................................................................................................................................................ 168
Changetheplotoptionbetweensubdividingallcells,orusingaquickeralgorithm.
$!PLOTTYPE ......................................................................................................................................................... 168
Changes plot types between valid Tecplot 360 modes such as XYLine and Cartesian2D. Valid options
shownbelow.
$!POLARAXIS ...................................................................................................................................................... 169
ASetValuecommandthatassignsattributesforaxesinapolarframe.
$!POLARTORECTANGULAR........................................................................................................................... 169
TreatthevariablescurrentlyassignedtoXandYasreferringtoRandqandconvertthemtoXandY.In
3D, X, Y and Z refer to R, q, and y. Tecplot 360 has addition capabilities for transforming coordinates,
pleasesee$!TRANSFORMCOORDINATES.
$!POLARVIEW ..................................................................................................................................................... 170
Setstheviewingstyleforpolarplotsinalayout.
$!PRINT ................................................................................................................................................................. 170
Printthecurrentlayouttoaprinterorsendtheprintinstructionstoafile.Usethe $!PRINTSETUPSetValue
commandtoconfigureprinting.
$!PRINTSETUP .................................................................................................................................................... 170
A SetValue command that sets the attributes for printing. Use $!PRINT to do the actual printing. See
$!EXPORTSETUPand$!EXPORTifyouintendtocreateimagefilesdestinedfordesktoppublishingpro
grams.
42
$!PROMPTFORFILENAME...............................................................................................................................172
InstructTecplot360tolaunchafileselectiondialog.Theresultingfilenamewillbeplacedin<macrovar>.
Iftheusercancelsoutofthedialogthen<macrovar>willbeempty(seetheexamplebelow).
$!PROMPTFORTEXTSTRING ..........................................................................................................................172
InstructTecplot360tolaunchadialogcontainingasinglelinetextfieldandoptionalinstructions.Theuser
enterstextintothetextfieldandtheresultingstringisassignedto<macrovar>.
$!PROMPTFORYESNO ......................................................................................................................................173
Instruct Tecplot 360 to launch a dialog containing two buttons, one labeled Yes and the other No. The
<macrovar>isassignedthestringYesorNodependingontheselection.
$!PROPAGATELINKING...................................................................................................................................173
Linkmultipleframes,eitherwithinframeorbetweenframes.
$!PUBLISH ............................................................................................................................................................173
Create an HTML file displaying one or more images. A linked layout with packaged data may be
included.Youmustprovidethefilename.
$!QUIT....................................................................................................................................................................174
TerminatetheexecutionoftheTecplot360program.
$!RAWCOLORMAP ............................................................................................................................................174
AssigntheRGBvaluesthatdefinetheRawuserdefinedcolormap.Thisdoesnotsetthecolormaptouse
theRawuserdefinedcolormap.Use$!COLORMAPtosetthecurrentcolormap.
$!READDATASET................................................................................................................................................175
The $!READDATASET macro command has two separate uses. The parameters available for the com
mandaredependentupontheintendeduse.ItmayeitherbeusedtoloaddatainTecplot360sfileformat
(*.pltor*.dat)orinaforeigndatafileformat.ToloaddatainTecplot360sfileformat,usetheparameters
listedinTable92.Toloaddatainaforeignfileformat,usetheparameterslistedinTable91alongwith
asetofname/valuepairs.Thename/valuepairsarespecifictothedataloaderanddescribedinChapter4:
DataLoadersintheUsersManual.
$!READSTYLESHEET.........................................................................................................................................177
Readinastylesheetfile.The<string>isthenameofthefiletoread.
$!REDRAW ............................................................................................................................................................177
Redrawtheactiveframe.
$!REDRAWALL.....................................................................................................................................................178
Redrawallframes.
43
$!REMOVEVAR.................................................................................................................................................... 178
Removeauserdefinedmacrovariable.Thisfreesupspacesoanotheruserdefinedmacrovariablecanbe
defined.
$!RENAMEDATASETVAR................................................................................................................................. 178
RenameadatasetvariableinTecplot360.
$!RENAMEDATASETZONE ............................................................................................................................. 179
RenameadatasetzoneinTecplot360.
$!RESET3DAXES.................................................................................................................................................. 179
Resettherangesonthe3Daxes.
$!RESET3DORIGIN ............................................................................................................................................ 179
Repositiontherotationoriginin3Dtobeatthespecifiedlocation.
$!RESET3DSCALEFACTORS............................................................................................................................ 180
Recalculatethescalefactorsforthe3Daxes.Aspectratiolimitsaretakenintoaccount.
$!RESETVECTORLENGTH............................................................................................................................... 180
Resetthelengthofthevectors.Tecplot360willfindthevectorwiththelargestmagnitudeandsetthescal
ingfactorsoitwillappearonthescreenusingthelengthspecifiedby$!FRAMESETUPVECTDEFLEN.
$!ROTATE2DDATA ............................................................................................................................................. 180
Rotatefielddatain2Daboutanypoint.
$!ROTATE3DVIEW.............................................................................................................................................. 181
Doa3Drotationaboutagivenaxis.The<rotateaxis>mustbesupplied.
$!RUNMACROFUNCTION .............................................................................................................................. 181
Executecommandsdefinedinamacrofunction.The<string>referencesthenameofthemacrofunctionto
run.Ifthemacrocommandrequiresparameters,thenincludethem(withinparentheses)afterthemacro
commandname.
$!SAVELAYOUT ................................................................................................................................................... 182
Savethecurrentlayouttoafile.Youmustsupplythefilename.
$!SET3DEYEDISTANCE..................................................................................................................................... 182
Setsthedistancefromtheviewertotheplaneofthecurrentcenterofrotation.
$!SETAUXDATA................................................................................................................................................... 182
AddAuxiliaryDataintheformofname/valuepairstozones,framesordatasets.Thenamemustbegin
withanunderscoreorletter,andmaybefollowedbyoneormoreunderscore,period,letter,ordigitchar
acters.
44
$!SETDATASETTITLE ........................................................................................................................................183
Setthetitleforthecurrentdataset.
$!SETFIELDVALUE .............................................................................................................................................183
Specifyafieldvalue(datasetvalue)ataspecifiedpointindex.IfthezonereferencedisIJorIJKordered
thenthepointindexiscalculatedbytreatingthe2or3Darrayasa1Darray.
NotethattheINDEXvaluewascalculatedusing:
$!SETFRAMEBACKGROUNDCOLOR ..........................................................................................................184
SetstheframebackgroundtothespecifiedcolorandsurveysallbasiccolorassignmentsinTecplot360,
convertingtheallbasiccolorsusingthefollowingrulestoachievethebestcontrast:
$!SETSTYLEBASE................................................................................................................................................184
InstructTecplot360onhowtoinitializeframestylevalueswhenanewframeiscreated.Duringnormal
operation,Tecplot360basesthestyleofanewframeonthefactorydefaultsplusanychangesassignedin
the Tecplot 360 configuration file. Layout files and stylesheet files, however, rely on Tecplot 360 basing
newframesonlyonthefactorydefaults.Thiscommandistypicallynotusedbythecasualuser.
$!SHARECONNECTIVITY................................................................................................................................185
Sharethenodemapbetweenthesourceanddestinationzones,presumingthatthezonesareFEandhave
thesameelementtypeandnumberofnodes.
$!SHAREFIELDDATAVAR.................................................................................................................................185
Allowssharingofthespecifiedvariablefromthesourcezonetothedestinationzone.Zonemustbeofthe
sametype(orderedorFE)anddimensions.CellcenteredvariablesinFEmusthavethesamenumberof
cells.Sharingisnotallowedifeitherzonehasglobalfaceneighbors.
$!SHIFTLINEMAPSTOBOTTOM....................................................................................................................186
ShiftalistofLinemappingstothebottomoftheLinemappinglist.ThisineffectcausestheselectedLine
mappingstobedrawnlast.
$!SHIFTLINEMAPSTOTOP ..............................................................................................................................186
ShiftalistofLinemapstothetopoftheLinemaplist.ThisineffectcausestheselectedLinemapstobe
drawnfirst.
$!SHOWMOUSEPOINTER ...............................................................................................................................186
Themouseiconmaybedeactivatedwithinamacrotoenhancetheonscreenanimation.Itmustbereacti
vatedbeforeexitingthemacro.
$!SKETCHAXIS....................................................................................................................................................186
A SetValue command that assigns attributes for axes in a sketch mode frame. Axes are rarely used in
sketchframes.
45
$!SLICEATTRIBUTES......................................................................................................................................... 187
ASetValuecommandthatchangesglobalattributesassociatedwithslices.
$!SLICELAYERS ................................................................................................................................................... 190
Turnslicingonoroff.
$!SMOOTH ........................................................................................................................................................... 190
Smoothdata(reducethespikes)forselectedvariablesinselectedzones.
$!STREAMATTRIBUTES ................................................................................................................................... 191
ASetValuecommandthatchangesglobalattributesassociatedwithstreamtraces.
$!STREAMTRACE[RequiredControlOption]............................................................................................. 193
ThedifferentcommandsintheSTREAMTRACEcompoundfunctionfamilyaredescribedseparatelyin
thefollowingsections.
$!STREAMTRACEADD .................................................................................................................................... 193
Addasinglestreamtraceorarakeofstreamtracestotheactiveframe.Theframemustbea2Dor3Dfield
plot.
$!STREAMTRACEDELETEALL ...................................................................................................................... 195
Deletesallstreamtracesintheactiveframe.Iftheframemodeis2D,all2Dstreamtracesaredeleted.Ifthe
framemodeis3D,all3Dstreamtracesaredeleted.
$!STREAMTRACEDELETERANGE ............................................................................................................... 195
Deletearangeofstreamtraces.Streamtracesarenumberedsequentiallyintheordertheywerecreated.
$!STREAMTRACERESETDELTATIME.......................................................................................................... 195
Resetthetimedeltafordashedstreamtraces.Thedeltatimeisresetsuchthatastreamdashinthevicinity
of the maximum vector magnitude will have a length approximately equal to 10 percent of the frame
width.
$!STREAMTRACESETTERMINATIONLINE .............................................................................................. 196
Setthepositionoftheterminationlineforstreamtraces.
$!STREAMTRACELAYERS ............................................................................................................................... 196
Turnstreamtracesonoroff.
$!SYSTEM.............................................................................................................................................................. 196
InstructTecplot360tosubmitacommandtotheoperatingsystem.Forsecurityreasons,executionofthe
$!SYSTEMcommandcanbedisabledtopreventunauthorizedexecutionofsystemcommandsviamacros.
UsetheOKTOEXECUTESYSTEMCOMMANDoptiontothe$!INTERFACEmacrocommand.
46
$!THREEDAXIS....................................................................................................................................................197
ASetValuecommandthatassignsattributesforaxesina3Dframe.
$!THREEDVIEW ..................................................................................................................................................198
ASetValuecommandthatchangesglobalattributesassociatedwiththe3Dview.
$!TRANSFORMCOORDINATES.....................................................................................................................199
Transformsallpointsinoneormorezonesfromonecoordinatesystemtoanother.
$!TRIANGULATE ................................................................................................................................................200
Createanewzonebyformingtrianglesfromdatapointsinexistingzones.
$!TWODAXIS .......................................................................................................................................................201
ASetValuecommandthatassignsattributesforaxesina2Dframe.
$!VARSET ..............................................................................................................................................................202
Assignavaluetoamacrovariable.Ifthemacrovariabledidnotexistpriortothiscommand,thenitis
definedhere.Amacrovariablecanbeassignedavalueorastring.
$!VIEW[RequiredControlOption] .................................................................................................................202
Thedifferentcommandsinthe VIEWcompoundfunctionfamilyaredescribedseparatelyinthefollowing
sections.
$!VIEWAXISFIT ..................................................................................................................................................203
Resettherangeonaspecificaxissothatitequalstheminimumandmaximumofthedatabeingplotted.If
theaxisdependencyisnotindependentthenthisactionmayalsoaffecttherangeonanotheraxis.
$!VIEWAXISMAKECURRENTAXISVALUESNICE ....................................................................................203
Resettheaxislinelabelvaluessuchthatallcurrentlydisplayedvaluesaresettohavethesmallestnumber
ofsignificantdigitspossible.
$!VIEWAXISNICEFIT ........................................................................................................................................203
Resettherangeonaspecificaxissothatitequalstheminimumandmaximumofthedatabeingplotted,
butmakestheaxisvaluesnicebysettinglabelstohavethesmallestnumberofsignificantdigitspossi
ble.Iftheaxisdependencyisnotindependentthenthisactionmayalsoaffecttherangeonanotheraxis.
$!VIEWCENTER..................................................................................................................................................204
Centerthedatawithintheaxisgridarea.
$!VIEWCOPY .......................................................................................................................................................204
Copythecurrentviewtotheviewpastebuffer.Seealso$!VIEWPASTE.
47
$!VIEWDATAFIT ................................................................................................................................................ 204

Fitthecurrentsetofdatazonesorlinemappingsbeingplottedwithinthegridarea.Thisdoesnottake
intoconsiderationtextorgeometries.
$!VIEWFIT............................................................................................................................................................ 204
Fittheentireplottothegridarea.Thisalsotakesintoconsiderationtextandgeometriesthatareplotted
usingthegridcoordinatesystem.In3D,thisalsoincludestheaxes.
$!VIEWFITSURFACES....................................................................................................................................... 205
Fitsactiveplotsurfacestothegridarea.3Dvolumezonesareexcludedwhensurfacestoplotaresetto
none.See$!FIELDMAPformoreinformationonsettingsurfacestoplot.
$!VIEWLAST........................................................................................................................................................ 205
Retrievethepreviousviewfromtheviewstack.Eachframemodewithineachframemaintainsitsown
viewstack.$!VIEWLASTwillnotreversealterationstodata.
$!VIEWMAKECURRENTVIEWNICE ............................................................................................................ 205
Shifts axis to make axisline values nice without changing the extents of the window. Only works in
Sketch/XY/2D.
$!VIEWNICEFIT.................................................................................................................................................. 205
Changeviewtomaketheextentsoftheframeneatlyholdtheplotwithintegervaluesforaxislabels.Only
worksinSketch/XY/2D.
$!VIEWPASTE ..................................................................................................................................................... 205
Retrievetheviewfromtheviewpastebufferandassignittotheactiveframe.
$!VIEWPUSH ....................................................................................................................................................... 205
InstructTecplot360topushthecurrentviewontotheviewstack.Aviewwillnotbepushedifthecurrent
view is the same as the top view on the stack. Note that commands VIEW AXISFIT, VIEW CENTER, VIEW
DATAFIT, VIEW FIT, and VIEW ZOOM automatically push a view onto the stack. Tecplot 360 automatically
pushesthecurrentviewontothestackwhena$!REDRAWcommandisissuedandthecurrentviewisdiffer
entfromthetopviewontheviewstack.
$!VIEWRESETTOENTIRECIRCLE ................................................................................................................. 206
ResettheThetaRAxistoinitialsettings.ForPolarplotsonly.
$!VIEWSETMAGNIFICATION ....................................................................................................................... 206
Setthemagnificationforthedatabeingplotted.Amagnificationof1willsizetheplotsoitcanfitwithin
thegridarea.
$!VIEWTRANSLATE.......................................................................................................................................... 206
ShiftthedatabeingplottedintheXand/orYdirection.Theamounttranslatedisinframeunits.
48
$!VIEWZOOM .....................................................................................................................................................206
Changetheviewbyzoomingintothedata.InSketch,XY,and2Dframemodeplots,Tecplot360will
adjusttherangesontheaxistoviewtheregiondefinedbytherectanglewithcornersat(X1,Y1)and(X2,
Y2).For3Dorthographicplots,theviewistranslatedandscaledtofittheregion.For3Dperspectiveplots,
theviewisrotatedabouttheviewerandscaledtofittheregion.X1andsofortharemeasuredingridcoor
dinates.
$!WHILE...$!ENDWHILE....................................................................................................................................207
ContinuetoexecuteasetofcommandsuntilaconditionalexpressionisNO.
$!WORKSPACEVIEW[RequiredControlOption].......................................................................................207
Thedifferentcommandsinthe WORKSPACEVIEWcompoundfunctionfamilyaredescribedseparatelyinthe
followingsections.
$!WORKSPACEVIEWFITALLFRAMES .........................................................................................................208
Changetheviewintheworkspacesoallframesarefitjustinsidetheedgesoftheworkspace.
$!WORKSPACEVIEWFITPAPER.....................................................................................................................208
Changetheviewintheworkspacesotheentirepaperisfitjustinsidetheedgesoftheworkspace.
$!WORKSPACEVIEWFITSELECTEDFRAMES............................................................................................208
Changetheviewintheworkspacesothecurrentlyselectedframes(thatis,theframeswithpickhandles)
arefitjustinsidetheedgesoftheworkspace.
$!WORKSPACEVIEWLASTVIEW ..................................................................................................................208
Returntothepreviousworkspaceview.
$!WORKSPACEVIEWMAXIMIZE ..................................................................................................................208
Temporarilyexpandtheworkareaaslargeaspossible.ThemaximizedworkareaoccupiestheentireTec
plot360processwindow.
$!WORKSPACEVIEWTRANSLATE ...............................................................................................................208
Shifttheviewoftheworkspace.Thishasnoeffectonthelocalviewwithinanyframeinyourlayout.
$!WORKSPACEVIEWUNMAXIMIZE............................................................................................................209
Returnstheworkspacetoitsnormalsizeafterithasbeenexpandedafter $!WORKSPACEMAXIMIZEhasbeen
used.
$!WORKSPACEVIEWZOOM...........................................................................................................................209
Changetheviewintotheworkarea.Thishasnoeffectonthelocalviewwithinanyframeinyourlayout.
$!WRITECOLORMAP.........................................................................................................................................210
Writethecurrentcolormaptoafile.The<string>isthenameofthefiletowriteto.
49
$!WRITECURVEINFO ........................................................................................................................................ 210

Writeoutthecurvedetailsorthecalculateddatapointsfortheequation(s)usedtodrawthecurvefora
selectedlinemapping.The<string>isthenameofthefiletowriteto.
$!WRITEDATASET.............................................................................................................................................. 210
Writethedatasetattachedtotheactiveframetoafile.The<string>isthenameofthefiletowriteto.
$!WRITESTYLESHEET ....................................................................................................................................... 211
Writethestylefortheactiveframetoafile.The<string>isthenameofthefiletowriteto.
$!XYLINEAXIS ..................................................................................................................................................... 212
ASetValuecommandthatassignsattributesforaxesinanXYLineplot.
SettheaxismodetobeindependentfortheXYaxes(notethatthisaffectsonlyX1versusY1):
ANIMATESTREAKLINES................................................................................................................................. 214
Animatespreviouslycalculatedstreaklinestothescreenortoafile.
ATTACHINTEGRATIONRESULTS................................................................................................................. 215
Attachthetextresultsofthepreviousintegrationasatextfieldintheactiveframe.
CALCPARTICLEPATH ....................................................................................................................................... 215
Calculateparticlepathsorstreaklines,startingfromexistingTecplot360streamtraces.
CALCTURBULENCEFUNCTION.................................................................................................................... 218
Calculateaturbulencerelatedfunctionfromtwovariablesinthecurrentdataset.Addtheresulttothe
datasetasanewvariableusingthefunctionsname,oroverwritethevariableifitalreadyexists.
CALCULATE......................................................................................................................................................... 218
CalculateaTecplot360variableusingthespecifiedfunctionandaddittothecurrentdataset.Ifthevari
ablealreadyexistsinthecurrentdataset,itwillberecalculated.
CALCULATEACCURACY ................................................................................................................................. 219
Calculatetheorderaccuracyofthesolutioncontainedinthelistedzones.Optionally,plottheoverallaccu
racyversusgridspacingandplottheaccuracyateachgridnode.
DISPLAYBOUNDARIES.................................................................................................................................... 220
Displaysboundariescorrespondingtoageometryandboundariesspecificationwithoutactuallysetting
the geometry and boundaries. This macro is generally not useful for those writing macro files, but is
recordedwhentheuserclickstheDisplayBoundariesbuttonintheGeometryandBoundariesdialogin
ordertoduplicatetheactionsofTecplot360thathappeninresponsetothataction.SeeSectionSETGE
OMETRYANDBOUNDARIESonpage 226foradescriptionoftheparametersforthismacro.
50
EXTRACTFLOWFEATURE................................................................................................................................220
Extractanddisplayshocksurfaces,vortexcores,orseparationandattachmentlines.Shocksurfacesare
displayedasisosurfacesofanewvariable,ShockSurface,whilevortexcoresandseparationandattach
mentlinesaredisplayedasnewzones.
EXTRAPOLATESOLUTION..............................................................................................................................221
PerformRichardsonextrapolationtoestimatethetruesolutionfromthreeinputsolutionsongridsofsuc
cessivelyfinerresolution.Twonewzonesareaddedtothecurrentdataset.Thefirstcontainstheextrapo
latedsolution,whilethesecondcontainstheestimatederror.
INTEGRATE..........................................................................................................................................................221
Performanintegrationoverthespecifiedzones.If<set>isnotspecified,theintegrationwillbeperformed
overallzones.IfPLOTASissettoTRUE,theintegrationresultswillbeplottedinanewframe.
SAVEINTEGRATIONRESULTS .......................................................................................................................223
Savesthemostrecentlycalculatedintegrationresultstoatextfile.
SETFIELDVARIABLES.......................................................................................................................................224
Identifiesvariablesinyourdata,suchasvelocity,pressureandtemperature,foruseinanalysis.
SETFLUIDPROPERTIES ....................................................................................................................................224
Setthefluidpropertiesforusebyothercommands.
SETGEOMETRYANDBOUNDARIES.............................................................................................................226
Specifywhetherthedatarepresentanaxisymmetricflowsolution(2DCartesianplotsonly),whetheradja
cent zones should be considered to be connected at coincident faces, and specify zone boundaries and
theircorrespondingboundaryconditions.EachlineoftheRAWDATAdescribesoneboundary,andappearsin
thesameformatasontheGeometryandBoundariesdialog.Forallboundaries,listtheboundarycondi
tionand the setof zones, separated by a comma.The index rangetype boundary followsthiswith the
boundaryface,thefirst startingindex,the first ending index, thesecond starting indexandthe second
endingindex.Allentriesareseparatedbycommas.TheboundaryconditionisoneofINFLOW,OUTFLOW,WALL,
SLIPWALL,SYMMETRY,EXTRAPOLATED.TheboundaryfaceisoneofI=1,I=IMAX,J=1,J=JMAX,K=1,andK=KMAX.Refer
toSection224SettingGeometryandBoundaryOptionsintheUsersManualformoreinformationon
boundaries.
SETREFERENCEVALUES ..................................................................................................................................226
Specifythereference(freestream)propertiesofthesolution,identifytwovariablesinthecurrentdataset
forusewithothercommands.
SETUNSTEADYFLOWOPTIONS....................................................................................................................227
Identifies time levels for unsteady flow, or specifies that the solution is steadystate. If the flow is
unsteady,thesolutiontimelevelsarespecifiedinthe RAWDATAsection.Thefirstlineofthe RAWDATAsection
mustconsistofasingleintegerindicatingthenumberofsolutiontimelevels.Thismustbefollowedbythe
time levels themselves. Each time level must be on a separate line and must consist of a floatingpoint
number(thesolutiontime),aswellasoneormoreintegers(thezonenumbersforthatsolutiontime).
51
<<anchorpos>>....................................................................................................................................................... 229
Assignattributesforpositioningofobjects.
<<areastyle>> ......................................................................................................................................................... 230
Changesettingsfortheaxisgridarea.
<<axisdetail>> ........................................................................................................................................................ 230
Assignattributesforaxes.
<<axisline>> ........................................................................................................................................................... 231
Assignattributesforaxislines.
<<axistitle>> ........................................................................................................................................................... 232
Assignattributesfortitles.
<<basicsizelist>> ................................................................................................................................................... 233
Assignbasicsizes.Theunitsforthevaluesassignedherearedependentontheparentcommand.Assign
mentsheredonotaffecttheplot.Theseassignmentsareusedonlytoconfiguredropdownmenusinthe
interfacesotheusercanmakequickselections.
<<colormapcontrolpoints>> ................................................................................................................................ 233
AllcontourcolormapsexcepttheRawuserdefinedcolormapmakeuseofcontrolpointstodetermine
thecolordistribution.Eachcontrolpointhasapositionandaleftandrightcolor.The<<colormapcontrolpoints>>subcommandcancontainmorethanoneCONTROLPOINTsubcommand.
<<colormapoverride>> ......................................................................................................................................... 234
Changesettingsforacolormapoverride.Colormapoverridesareusedtoreplaceaspecificbandinacon
tourcolormapwithoneofthe16basiccolors.
<<continuouscolor>> ............................................................................................................................................ 235
Changesettingsforcontinuouscolor.
<<dialogplacement>> ........................................................................................................................................... 235
Describestheplacementforadialog.
<<gridarea>> .......................................................................................................................................................... 236
Changesettingsfortheaxisgridarea.
<<gridlinedetail>> ................................................................................................................................................ 237
Changesettingsforaxisgridlines.
<<ijk>> .................................................................................................................................................................... 238
SetanI,J,orKindex.
52
<<indexrange>> .....................................................................................................................................................238
Setanindexrange.
<<numberformat>>...............................................................................................................................................239
Settheformatusedtodrawanumber.
<<papersize>> ........................................................................................................................................................239
ChangedimensionsorhardclipoffsetsforLETTER,DOUBLE,A3,A4,CUSTOM1andCUSTOM2papersizes.
<<precisegrid>> .....................................................................................................................................................240
Changesettingsfortheprecisedotgrid.
<<rect>>...................................................................................................................................................................240
Changesettingsforarectangle.Therectangleisdefinedusingtwopoints(X1,Y1)and(X2,Y2).
<<refscatsymbol>> ................................................................................................................................................241
Settheattributesforthereferencescattersymbol.
<<renderconfig>> ..................................................................................................................................................242
SettheattributesforOpenGLrendering.
<<rgb>> ...................................................................................................................................................................243
Setacolorvaluebyassigningvaluestoitsred,green,andbluecomponents.
<<shademap>>.......................................................................................................................................................243
Mapcolorsonthescreentoshadesofgrayformonochromehardcopyoutput.
<<symbolshape>> .................................................................................................................................................244
Setasymbolshape.Symbolscanbeageometricshape(circle,square,andsoforth)oranASCIIcharacter.
<<textbox>> ............................................................................................................................................................245
Changesettingsfortheoptionalboxaroundatextlabel.
<<textshape>> ........................................................................................................................................................245
Changesettingsrelatedtotextfontandcharacterheight.
<<ticklabeldetail>> ...............................................................................................................................................246
Changesettingsforthetextusedtolabelaxistickmarks.
<<tickmarkdetail>>...............................................................................................................................................247
Assignattributesforaxistickmarks.
53
<<volumeobjectstoplot>> .................................................................................................................................... 248

Specifieswhatvolumeobjectsaretobedisplayed.
<<xy>> ..................................................................................................................................................................... 249
Changesettingsforan(X,Y)position.
<<xyz>> ................................................................................................................................................................... 249
Changesettingsforan(X,Y,Z)triplet.
<<zebrashade>>..................................................................................................................................................... 249
Changezebrashadingattributes.
LOADPYFILENAME.......................................................................................................................................... 284
UsethisfunctiontoloadaPythonmoduleviaamacrofile.
MODIFYPYPATH ................................................................................................................................................ 284
UsethiscommandtotemporarilymodifyyourPYTHONPATHvariable.Thevariablewillbesetforthe
durationoftheTecplot360sessionusingthemacrocommand/file.
RUNPYFUNCTION............................................................................................................................................. 285
UsethiscommandtoexecuteaPythonfunctionviaamacrofile.NOTE:BeforeexecutingaPythonfunc
tion,youmustfirstloadthemodulethatcontainsitviatheLOADPYFILENAMEcommand.
54
9
Macro Commands
ThischapterlistsTecplot360smacrocommandsalphabetically.Optionalparametersareenclosedwithin
squarebrackets([]).Itemswithindoubleanglebrackets(<<>>)representparametersubcommands
listedanddescribedinChapter11:ParameterSubcommands.
A
$!ACTIVEFIELDMAPS
Syntax:
$!ACTIVEFIELDMAPS<op> <set>
[nooptionalparameters]
Description:ASetValuecommandthatchangesthesetofactivefieldmaps(thuschangingtheactivezones)
consideredforplotting.
Examples:
Example 1:
Makeonlyfieldmaps1,3,4and5activeforplotting:
$!ACTIVEFIELDMAPS=[1,35]
Example 2:
Addzones33,34,35,and36tothesetofactivefieldmaps:
$!ACTIVEFIELDMAPS+=[3336]
55
$!ACTIVELINEMAPS
Example 3:
Removezones1,2,3,9,10and11fromthesetofactivefieldmaps:
$!ACTIVEFIELDMAPS=[13,911]
$!ACTIVELINEMAPS
Syntax:
$!ACTIVELINEMAPS<op> <set>
Description:ASetValuecommandthatchangesthesetoflinemappingsconsideredforplotting.
Examples:
Example 1:
Makeonlylinemappings1,3,4and5activeforplotting:
$!ACTIVELINEMAPS=[1,35]
Example 2:
Addlinemaps33,34,35and36tothesetofactivelinemappings:
$!ACTIVELINEMAPS+=[3336]
Example 3:
Removelinemaps1,2,3,9,10and11fromthesetofactivelinemappings:
$!ACTIVELINEMAPS=[13,911]
$!ADDMACROPANELTITLE
Syntax:
$!ADDMACROPANELTITLE<string>
Description:AddatitletotheQuickMacroPanel.
Example: ThefollowingexampleaddsthetitleBarChartstotheQuickMacroPanel.
$!ADDMACROPANELTITLE"BarCharts"
$!ALTERDATA
Syntax:
$!ALTERDATA[zonelist]
EQUATION=<string>
Description:TheALTERDATAfunctionoperatesonadatasetwithinTecplot360usingFORTRANlike
equations.SeeSection211DataAlterationthroughEquationsintheUsersManualformore
informationonusingequationsinTecplot360.The<zonelist>parameterspecifiesthesetofzones
56
$!ALTERDATA
onwhichtooperate,wherezonelistisalistofzonesorzonerangesseparatedbyacomma(,).
Zonerangesareseparatedbyahyphen().If<zonelist>isomitted,allzonesareaffected.NOTE:
thevaluesforthe<zonelist>parametermustbeenclosedinsquarebrackets.(Forexample,use
$!ALTERDATA[1,3]toapplyALTERDATAtozones1and3).
Required Parameters
Parameter
EQUATION
Syntax
Default
=<string>
Notes
Thisassignstheequationtousetooperateonthedata.
Optional Parameters
Parameter
DATATYPE
Syntax
=<datatype>
Default
SINGLE
IRANGE
Notes
Assigntheprecisiongiventothedestinationvariable(thatis,
thevariableonthelefthandsideoftheequation).Thisonly
appliesiftheequationcreatesanewvariable.(SeeExample2:)
SeeRangeParameters,following,forinformationon
specifyingrangeindexvalues.
{
MIN
=<integer>
MAX
=<integer>
SKIP
=<integer>
}
JRANGE
{
MIN
=<integer>
MAX
=<integer>
SKIP
=<integer>
}
KRANGE
{
MIN
=<integer>
MAX
=<integer>
SKIP
=<integer>
=
<valuelocation>
AUTO
}
VALUELOCATION
Assignthelocationtodestinationvariable.
Range Parameters
TheIRANGE,JRANGE,andKRANGEparameterslimitthedataalteredbytheequation.Thespecificationof
rangeindicesfollowtheserules:
Allindicesstartwith1andgotosomemaximumindexm.
Thenumber0canbeusedtorepresentthemaximumindexm.Ifthemaximumindexm =15,
specifying0setstherangeindexto15.
Negativevaluesrepresenttheoffsetfromthemaximumindex.Ifavalueof2isspecified,and
themaximumindexmis14,thevalueusedis142,or12.
Examples:
Example 1:
ThefollowingexampleaddsonetoXforzones1and3foreverydatapoint:
$!ALTERDATA[1,3]
EQUATION="x=x+1"
57
$!ANIMATECONTOURLEVELS
Example 2:
Thefollowingexamplecreatesanew,doubleprecisionvariablecalledDIST:
$!ALTERDATA
EQUATION="{DIST}=SQRT(X**2+Y**2)"
DATATYPE=DOUBLE
Example 3:
ThefollowingequationssetavariablecalledPtozeroalongtheboundaryofanIJorderedzone:
$!ALTERDATA
EQUATION="{P}=0"
IRANGE{MAX=1}
$!ALTERDATA
EQUATION="{P}=0"
IRANGE{MIN=0}
$!ALTERDATA
EQUATION="{P}=0"
JRANGE{MAX=1}
$!ALTERDATA
EQUATION="{P}=0"
JRANGE{MIN=0}
Example 4:
Byfollowingavariablereferencewithbrackets[and]youmaydesignateaspecificzonefromwhich
togetthevariablevalue.Forexample:
V3=V3V3[1]
X=(X[1]+X[2]+X[3])/3
{TempAdj}={Temp}[7]{Adj}
V7=V1[19]2*C[21]+{R/T}[18]
Thezonenumbermustbeapositiveintegerconstantlessthanorequaltothenumberofzones.Thezone
designatedmusthavethesamestructure(finiteelement,I,IJ,orIJKordered)anddimensions(number
ofnodesandsoforth)
Syntax:
START=<integer>
END=<integer>
Description:Produceananimationofacontourlineplotbyshowingasinglelevelatatime.Theanimation
variesaccordingtothecurrentlydefinedcontourlevelsandislimitedbythevaluesintheSTART,
END,andSKIPparameters.TocreateanAVIorRMfile,add$!EXPORTSETUPcommandsbeforethis
command.
58
$!ANIMATEIJKBLANKING
Required Parameters
Parameter
Syntax
Default
Notes
START
=<integer>
Startingcontourlevelnumbertoanimate.
END
=<integer>
Endingcontourlevelnumbertoanimate.
Optional Parameters
Parameter
Syntax
Default
Notes
CREATEMOVIEFILE
=<boolean>
NO
IfYES,mustbeprecededby$!EXPORTSETUPcommands.
SKIP
=<integer>
Levelskip.
Example: ThefollowingcommandanimatesthefirstfourcontourlevelstoanAVIfile:
$!EXPORTSETUPEXPORTFORMAT=AVI
$!EXPORTSETUPEXPORTFNAME="contourlevels.avi"
START=1
END=4
CREATEMOVIEFILE=YES
Syntax:
NUMSTEPS=<integer>
Description:ProduceananimationofdifferentIJKblankingsinyourplot.TheanimationstartsatoneIJK
blankingsettingandmarchesthroughintermediatestepstoasecondsetting.TocreateanAVIor
RMfile,add$!EXPORTSETUPcommandsbeforethiscommand.
59
$!ANIMATEIJKPLANES
Required Parameter
Parameter
NUMSTEPS
Syntax
Default
=<integer>
Notes
Numberofintermediatestepsfortheanimation.
Optional Parameters
Parameter
Syntax
Default
Notes
IMINFRACT
=<dexp>
0.1
Minimumfractionforblankingatthestartofanimationforthe
Iindex.ActualIindexisequaltoIMINFRACT*IMAX.
JMINFRACT
=<dexp>
0.1
Jindex.ActualJindexisequaltoJMINFRACT*JMAX.
KMINFRACT
=<dexp>
0.1
Kindex.ActualKindexisequaltoKMINFRACT*KMAX.
IMAXFRACT
=<dexp>
1.0
Maximumfractionforblankingatthestartofanimationforthe
Iindex.ActualIindexisequaltoIMAXFRACT*IMAX.
JMAXFRACT
=<dexp>
1.0
Jindex.ActualJindexisequaltoJMAXFRACT*JMAX.
KMAXFRACT
=<dexp>
1.0
Kindex.ActualKindexisequaltoKMAXFRACT*KMAX.
IMINFRACT2
=<dexp>
0.8
Minimumfractionforblankingattheendofanimationforthe
Iindex.ActualIindexisequaltoIMINFRACT*IMAX.
JMINFRACT2
=<dexp>
0.8
Jindex.ActualJindexisequaltoJMINFRACT*JMAX.
KMINFRACT2
=<dexp>
0.8
Kindex.ActualKindexisequaltoKMINFRACT*KMAX.
IMAXFRACT2
=<dexp>
1.0
Maximumfractionforblankingattheendofanimationforthe
Iindex.ActualIindexisequaltoIMAXFRACT*IMAX.
JMAXFRACT2
=<dexp>
1.0
Jindex.ActualJindexisequaltoJMAXFRACT*JMAX.
KMAXFRACT2
=<dexp>
1.0
Kindex.ActualKindexisequaltoKMAXFRACT*KMAX.
CREATEMOVIEFILE
=<boolean>
NO
Example:
ThefollowingexampleproducesananimationshowingabandofIplanestraversingtheentiredatafield:
NUMSTEPS=6
IMINFRACT=0.1
JMINFRACT=0.0
KMINFRACT=0.0
IMAXFRACT=1.0
JMAXFRACT=1.0
KMAXFRACT=1.0
IMINFRACT2=1.0
JMINFRACT2=0.0
KMINFRACT2=0.0
IMAXFRACT2=1.0
JMAXFRACT2=1.0
KMAXFRACT2=1.0
$!ANIMATEIJKPLANES
Syntax:
60
$!ANIMATEIJKPLANES
$!ANIMATEISOSURFACES
START=<integer>
END=<integer>
Description:ProduceananimationthatcyclesthroughI,J,orKplanesinanIJKordereddataset.Tocreate
anAVIorRMfile,add$!EXPORTSETUPcommandsbeforethiscommand.
Required Parameters
Parameter
Syntax
Default
Notes
START
=<integer>
Startingplaneindex
END
=<integer>
Endingplaneindex
Optional Parameters
Parameter
Syntax
Default
Notes
CREATEMOVIEFILE
=<boolean>
NO
IfYES,mustbeprecededby$!EXPORTSETUPcommands
PLANES
=<ijkplane>
SpecifyI,JorK
SKIP
=<integer>
Indexskip
Example: ThefollowingexamplegeneratesananimationoftheIplanes1,3,5,7,and9:
$!ANIMATEIJKPLANES
PLANES=I
START=1
END=9
SKIP=2
Syntax:
STARTVALUE=<double>
ENDVALUE=<double>
Description:Themacrocommand$!ANIMATEISOSURFACESproducesananimationofaseriesofisosurfaces
beginningwiththeisosurfacedefinedbySTARTVALUEandendingwiththeisosurfacedefinedby
ENDVALUE.TocreateanAVIorRMfile,add$!EXPORTSETUPcommandsbeforethiscommand.
61
$!ANIMATELINEMAPS
Required Parameters
Parameter
Syntax
ENDVALUE
=<integer>
NUMSTEPS
=<integer>
STARTVALUE
=<integer>
Default
Notes
ENDVALUEisthevalueofthecontourvariableforthelastiso
surfaceintheanimation.
Numberofisosurfacestodistributebetweenthestartandend
isosurfacesvalues.
STARTVALUEisthevalueofthecontourvariableforthefirst
isosurfaceintheanimation.
Optional Parameters
Parameter
Syntax
Default
Notes
CREATEMOVIEFILE
=<boolean>
NO
GROUP
=<integer>
values18
LIMITSCREENSPEED
=<boolean>
No
MAXSCREENSPEED
=<double>
Youmayneedtoreducethevaluetocorrelatewiththespeed
ofyourcomputer.
GoTo,Loop,Bounce,Forward,andBackwardareonlyusedbytheinterface.ForwardandBackwardcanbe
simulatedusingappropriatevaluesSTARTVALUEandENDVALUE.IfENDVALUE<STARTVALUE,
theanimationgoesbackward.IfENDVALUE>STARTVALUE,theanimationgoesforward.Gotocanbe
simulatedifENDVALUE==STARTVALUE.Thatis,itcanbesimulatediftheanimationgoesonestep.
LoopandBouncecanbeaccomplishedbycallingthefilemultipletimes.
When recording, the macro recorded contains exactly the animation done in the
interface. So if you bounce three times through the data, you will record three sets of
forward and backwards commands. Similarly, if you use the "one step" options a lot,
you will record a lot of individual macro commands. If you interrupt part way through an
animation, you will record a partial animation macro of those steps you did animate
through.
Example: Thefollowingexamplecreatesananimationofisosurfaces:
STARTVALUE=1
ENDVALUE=30
NUMSTEPS=30
$!ANIMATELINEMAPS
Syntax:
$!ANIMATELINEMAPS
START=<integer>
END=<integer>
Description:ProduceananimationofoneLinemappingatatime.TocreateanAVIorRMfile,add
$!EXPORTSETUPcommandsbeforethiscommand.
62
$!ANIMATESLICES
Required Parameters
Parameter
Syntax
Default
Notes
START
=<integer>
StartingLinemapnumber
END
=<integer>
EndingLinemapnumber
Optional Parameters
Parameter
Syntax
Default
Notes
SKIP
=<integer>
Linemapskip
CREATEMOVIEFILE
=<boolean>
NO
Example:
ThefollowingexamplecreatesananimationshowingplotsofLinemaps2,4,6,8and10:
$!ANIMATELINEMAPS
START=2
END=10
SKIP=2
$!ANIMATESLICES
Syntax:
$!ANIMATESLICES[Group]
START=<integer>
END=<integer>
Description:Themacrocommand$!ANIMATESLICESusesthecurrentlydefinedstartandendsliceposition.
Use$!SLICEATTRIBUTEStosetthesepositions;$!ANIMATESLICESthenredefineshowmany
intermediateslicesaretobeused,thenanimatesasubsetofthoseslices.TocreateanAVIorRM
file,add$!EXPORTSETUPcommandsbeforethiscommand.
Required Parameters
Parameter
Syntax
Default
Notes
START
=<integer>
STARTandENDaremeasuredinstepsbasedonNUMSLICES
betweentheslicegroupsstartslicevalue(atstep=1)andend
slicevalues(atstep=NumSlices).
END
=<integer>
STARTandENDaremeasuredinstepsbasedonNUMSLICES
betweentheslicegroupsstartslicevalue(atstep=1)andend
slicevalues(atstep=NumSlices).
NUMSLICES
=<integer>
Numberofslicestodistributebetweenthestartandendslice
locationsasdefinedbySTARTandENDin
$!SLICEATTRIBUTES.
Optional Parameters
Parameter
GROUP
Syntax
Default
Notes
=<integer>
values18
NO
CREATEMOVIEFILE
=<boolean>
LIMITSCREENSPEED
=<boolean>
MAXSCREENSPEED
=<double>
simulatedusingappropriatevaluesSTARTVALUEandENDVALUE.IfENDVALUE<STARTVALUE,
theanimationgoesbackward.IfENDVALUE>STARTVALUE,theanimationgoesforward.Gotocanbe
63
$!ANIMATESTREAM
simulatedifENDVALUE==STARTVALUE,i.e.theanimationgoesonestep.LoopandBouncecanbe
accomplishedbycallingthefilemultipletimes.
When recording, the macro recorded contains exactly the animation done in the
interface. So if you bounce three times through the data, you will record three sets of
forward and backwards commands. Similarly, if you use the "one step" options a lot,
you will record a lot of individual macro commands. If you interrupt part way through an
animation, you will record a partial animation macro of those steps you did animate
through.
Example: Thefollowingexamplecreatesananimationof3Dslices:
$!ANIMATESLICES
START=1
END=30
NUMSLICES=30
$!ANIMATESTREAM
Syntax:
$!ANIMATESTREAM
Description:Produceananimationofstreammarkersordashes,movingalongthecurrentlydefined
streamtracepaths.TocreateanAVIorRMfile,add$!EXPORTSETUPcommandsbeforethis
command.
Optional Parameters
Parameter
Syntax
Default
Notes
STEPSPERCYCLE
=<integer>
20
Numberofstepstouseforeachcycleoftheanimation.
Increasethisnumbertoproduceasmootheranimation.
CREATEMOVIEFILE
=<boolean>
NO
NUMCYCLES
=<integer>
Numberofcyclesintheanimation.Eachcycleshowsstream
markersordashes,movingalongastreamtracepath.IfDTis
thestreamtracedeltatime,thenattheendofthecycle,the
markersordasheswillhavemoved
(2*DT*(STEPSPERCYCLE1))/(STEPSPERCYCLE)intime.
Example:
Thefollowingexampleanimatesstreamtracesforfivecycleswitheachcycleusingtensteps:
$!ANIMATESTREAM
STEPSPERCYCLE=10
NUMCYCLES=5
$!ANIMATETIME
Syntax:
$!ANIMATETIME
Description:Produceananimationoftransientdata.TocreateanAVIorRMfile,add$!EXPORTSETUP
commandsbeforethiscommand.
64
$!ANIMATEZONES
Optional Parameters:
Parameter
Syntax
Default
Notes
CREATEMOVIEFILE
=<boolean>
NO
ENDTIME
=<double>
Thelasttimestep
asdefinedbythe
currentlyactive
strands
IftheSolutionTimeentereddoesnotexist,thenearest
SolutionTimelessthantheenteredtimeisused.
LIMITSCREENSPEED
=<boolean>
NO
MAXSCREENSPEED
=<double>
12
SKIP
=<integer>
STARTTIME
=<double>
firsttimestepas
definedbythe
currentlyactive
strands
onlyworksifLIMITSCREENSPEEDisYES
IftheSolutionTimeentereddoesnotexist,thenearest
SolutionTimelessthantheenteredtimeisused.
simulatedusingappropriatevaluesSTARTVALUEandENDVALUE.IfENDVALUE<STARTVALUE,theanimationgoes
backward.IfENDVALUE>STARTVALUE,theanimationgoesforward.GotocanbesimulatedifENDVALUE==
STARTVALUE,i.e.theanimationgoesonestep.LoopandBouncecanbeaccomplishedbycallingthefile
multipletimes.
When recording a macro, that macro animates exactly as done in the interface. So if
you bounce three times through the data, you will record three sets of forward and
backwards commands. Similarly, if you use the "one step" options a lot, you will record
a lot of individual macro commands. If you interrupt part way through an animation,
you will record a partial animation macro of those steps you did animate through.
$!ANIMATEZONES
Syntax:
$!ANIMATEZONES
START=<integer>
END=<integer>
Description:Produceananimationshowingonezoneatatime.TocreateanAVIorRMfile,add
$!EXPORTSETUPcommandsbeforethiscommand.Thiscommandwillnotworkiftheactiveframe
containsatransientdataset.
65
$!ATTACHDATASET
Required Parameters
Parameter
Syntax
Default
Notes
START
=<integer>
Startingzonenumber
END
=<integer>
Endingzonenumber
Optional Parameters
Parameter
Syntax
Default
Notes
ZONEANIMATIONMODE
=
[STEPBYNUMB
ER,
GROUPSTEPBY
NUMBER,
STEPBYTIME]
STEPBYNUMBE
R
CREATEMOVIEFILE
=<boolean>
NO
SKIP
=<integer>
Zoneskip.
Example: Thefollowingexampleanimatesjustthefirstfivezones:
$!ANIMATEZONES
START=1
END=5
$!ATTACHDATASET
Syntax:
$!ATTACHDATASET
[optionalparameter]
Description:Attachtheactiveframetothedatasetofanotherframe.UsePAGENUM,iftheotherframeison
adifferencepage.ThiscommandisusuallyfoundonlyinlayoutfilesgeneratedbyTecplot360.
Notethatthe$!PLOTTYPEcommandautomaticallyexecutesan$!ATTACHDATASETcommandifa
framemodeisrequestedinaframethatdoesnothaveanattacheddataset.Tecplot360attaches
thedatasetfromtheclosestframe(indrawingorder)havinganattacheddataset.
Optional Parameter
Default
Notes
FRAME
Parameter
=<integer>
Syntax
Firstframewith
adataset
Withinthepagespecifiedorimplied,ifFRAMEisnot
supplied,Tecplot360searchesforadatasetinaframebelow
thetopmostframeofthepagetoattach.
PAGENUM
=<integer>
currentpage
IfPAGENUMisnotsuppliedthecurrentpageisused.
Examples:
Example 1:
Thefollowingexampleattachestotheactiveframethedatasetfromthesecondframedrawnwhendoing
aRedrawAll:
$!ATTACHDATASET
FRAME=2
66
$!ATTACHGEOM
Example 2:
Thefollowingexampleattachestotheactiveframethedatasetfromtheframedrawnnexttolastwhen
doingaRedrawAll:
$!ATTACHDATASET
$!ATTACHGEOM
Syntax:
$!ATTACHGEOM
<geometryrawdata>
Description:Attachageometrytotheactiveframe.
67
$!ATTACHGEOM
Required Parameter
Parameter
Syntax
Default
Notes
<geometryrawdata>
Thisisthedatawhichdefinesthesizeandrelativeshapeofthe
geometry.Thismustbeattheendofthecommandafterany
otherparameters.
Optional Parameters
Parameter
Syntax
Default
ANCHORPOS
<<anchorpos>>
ARROWHEADANGLE
=<dexp>
=
<arrowheadattachment>
12
=<dexp>
= <arrowheadstyle>
5%
ARROWHEADATTACHMENT
ARROWHEADSIZE
ARROWHEADSTYLE
Notes
Thisassignstheanchorpositionofthe
geometry.
Settheangleforarrowheads(indegrees).
NONE
SetthearrowheadsizeinYframeunits(0100).
PLAIN
ATTACHTOZONE
=<boolean>
NO
CLIPPING
=<clipping>
CLIPTTOVIEWPORT
COLOR
=<color>
BLACK
DATATYPE
=<fielddatatype>
FLOAT
DRAWORDER
=<draworder>
AFTERDATA
FILLCOLOR
=<color>
WHITE
GEOMTYPE
=<geomtype>
LINESEGS
IMAGEFILENAME
=<string>
ISFILLED
=<boolean>
LINEPATTERN
=<linepattern>
SOLID
LINETHICKNESS
=<dexp>
0.1%
SetthelinethicknessinYframeunits(0100).
MACROFUNCTIONCOMMAND
=<string>
Null
Setthemacrocommandtoexecutewhenyou
hoveroverthegeometryandpressCtrlright
click.Forsecurityreasonsthiscommandcan
onlybeusedintheTecplot360configuration
file.
MAINTAINASPECTRATIO
=<boolean>
YES
NUMELLIPSEPTS
=<integer>
72
Numbersofpointstousewhendrawing
ellipsesandcircles.
SetthepatternlengthinYframeunits(0100).
PATTERNLENGTH
=<dexp>
2%
POSITIONCOORDSYS
=<coordsys>
GRID
RESIZEFILTER
=<resizefilter>
SCOPE
=<scope>
TEXTUREFILTER
ZONE
LOCAL
IfYES,mustincludeZONE.
SetthescopetoGLOBALtodrawthis
geometryinalllikeframes.
CUBIC
=<integer>
ThisisonlyusedifATTACHTOZONE=YES.
Thisgeometryisdisabledifthezoneassigned
hereisinactive.
Examples:
Example 1:
Thefollowingexamplecreatesaredcircle,witharadiusequalto25percentoftheheightoftheframe,in
thecenteroftheframe:
$!ATTACHGEOM
POSITIONCOORDSYS=FRAME
ANCHORPOS
{
X=50
Y=50
68
$!ATTACHTEXT
}
GEOMTYPE=CIRCLE
COLOR=RED
RAWDATA
25
Example 2:
ThefollowingexamplecreatesanLshapedpolylinewithanarrowheadattheend:
$!ATTACHGEOM
ANCHORPOS
{
X=20
Y=80
}
GEOMTYPE=LINESEGS
ARROWHEADATTACHMENT=ATEND
RAWDATA
1
3
00
060
400
$!ATTACHTEXT
Syntax:
$!ATTACHTEXT
TEXT=<string>
Description:Attachtexttotheactiveframe
69
$!ATTACHTEXT
Required Parameter
Parameter
TEXT
Syntax
Default
=<string>
Notes
Textstringtodraw.
Optional Parameters
Parameter
ANCHOR
ANCHORPOS
Syntax
=<textanchor>
<<anchorpos>>
Default
LEFT
Notes
Specifieswhatpartofthetexttoanchortotheframe.
Thisassignstheanchorpositionforthetext.Unitsare
dependentonPOSITIONCOORDSYS.
ANGLE
=<dexp>
0.0
Textangle(indegrees).
ATTACHTOZONE
=<boolean>
NO
IfYES,mustincludeZONE.
BOX
{
BOXTYPE
=<boxtype>
NONE
COLOR
=<color>
BLACK
FILLCOLOR
=<color>
WHITE
LINETHICKNESS
=<dexp>
0.1%
MARGIN
=<dexp>
20
CLIPPING
=<clipping>
CLIPTOVIEWP
ORT
COLOR
=<color>
BLACK
LINESPACING
=<dexp>
1.0
Linespacingtouseiftextcontainsmultiplelines.
MACROFUNCTION
=<string>
NULL
Setthemacrocommandtoexecutewhenyouhoveroverthe
geometryandpressCtrlrightclick.
=<coordsys>
FRAME
values=FRAME,GRIDorGRID3D
Themarginisthespacebetweenthetextandbox.Themargin
ismeasuredintermsofthepercentageofthetextheight.
COMMAND
POSITIONCOORDSYS
TEXTSHAPE
{
FONTFAMILY
=<string>
Helvetica
ISBOLD
=<boolean>
YES
ISITALIC
=<boolean>
NO
HEIGHT
=<dexp>
14
SIZEUNITS
=<sizeunits>
POINT
ThefollowingcombinationsofSIZEUNITSand
POSITIONCOORDSYSareallowed:FRAME/FRAME,POINT
SCOPE
=<scope>
LOCAL
SetthescopetoGLOBALtoincludethistextinalllikeframes.
ZONE
=<integer>
ThisisonlyusedifATTACHZONE=YES.Thistextisdisabledif
thezoneassignedhereisinactive.
Examples:
Example 1:
ThefollowingexamplecreatesthetextABCandpositionsitinthelowerleftcorneroftheframe:
$!ATTACHTEXT
TEXT="ABC"
70
$!BASICCOLOR
Example 2:
ThefollowingexamplecreatesthetextTEXTATANANGLEandplacesitinthecenteroftheframe.The
textisdrawnatanangleof45degrees:
$!ATTACHTEXT
TEXT="TEXTATANANGLE"
ANGLE=45
ANCHORPOS{X=50Y=50}
Example 3:
ThefollowingexamplecreatesthetextTIMESROMANusingtheTimesRomanfont.Thistextincludesa
textbox:
$!ATTACHTEXT
TEXT="TIMESROMAN"
TEXTSHAPE
{
FONTFAMILY="Times"
ISBOLD=NO
ISITALIC=NO
}
BOX
{
BOXTYPE=PLAIN
MARGIN=20
}
ANCHORPOS{X=20Y=20}
B
$!BASICCOLOR
Syntax:$!BASICCOLOR
Description:ASetValuecommandthatsetsthered,greenandbluecomponentsforanyofthebasiccolorsin
Tecplot360.
71
$!BASICSIZE
Optional Parameters
Parameter
Syntax
Default
BLACK
<<rgb>>
SeeNotes
BLUE
<<rgb>>
SeeNotes
CUSTOM1...
<<rgb>>
Notes
R=0,G=0,B=0
R=45,G=45,B=255
Thedefaultvaries.
CUSTOM56
CYAN
<<rgb>>
SeeNotes
R=0,G=255,B=255
GREEN
<<rgb>>
SeeNotes
R=0,G=210,B=0
PURPLE
<<rgb>>
SeeNotes
R=255,G=0,B=0
RED
<<rgb>>
SeeNotes
R=210,G=0,B=0
WHITE
<<rgb>>
SeeNotes
R=255,G=255,B=255
YELLOW
<<rgb>>
SeeNotes
R=255,G=255,B=45
Example: SettheCUSTOM8colortobebrown:
$!BASICCOLOR
CUSTOM8
{
R=165
G=42
B=42
}
$!BASICSIZE
Syntax:
$!BASICSIZE
Description:ASetValuecommandthatsetssizesofvariousobjectslikelinethicknesses,linepatternlength,
fontheight,andsoforth.SizescanbeassignedwheninteractingwithTecplot360byeither
enteringanexactvalueorbychoosingfromapresetlistofvalues.The$!BASICSIZEcommand
allowsyoutochangethevaluesinthepresetlists.
Optional Parameters
Parameter
Syntax
Default
Notes
ARROWHEADSIZES
<<basicsizelist>>
SeeNotes
Tiny=1.0,Small=3.0,Medium=5.0,Large=8.0,Huge=12.0
FRAMETEXTSIZES
<<basicsizelist>>
SeeNotes
LINEPATLENGTHS
<<basicsizelist>>
SeeNotes
LINETHICKNESSES
<<basicsizelist>>
SeeNotes
POINTTEXTSIZES
<<basicsizelist>>
SeeNotes
Tiny=8,Small=11,Medium=14,Large=28,Huge=50
SYMBOLSIZES
<<basicsizelist>>
SeeNotes
TICKLENGTHS
<<basicsizelist>>
SeeNotes
Example: Changethemediumlinepatternlengthtobe2.5percent:
$!BASICSIZE
LINEPATLENGTHS
{
MEDIUM=2.5
}
72
$!BLANKING
$!BLANKING
Syntax:
$!BLANKING
Description:ASetValuecommandthatchangessettingsforIJKorvalueblanking.
73
$!BLANKING
Optional Parameters
Parameter
Syntax
Default
Notes
DEPTH
{
INCLUDE
=<boolean>
NO
IfYES,drawsonlythoseportionsattheplotwithdepthvalues
withintheFROMFRONTandFROMBACKlimits.
FROMFRONT
=<double>
FROMFRONTandFROMBACKareexpressedaspercentages
oftheoverall3Ddepth.
FROMBACK
=<double>
FROMFRONTandFROMBACKareexpressedaspercentages
oftheoverall3Ddepth.
INCLUDE
=<boolean>
NO
IJKBLANKMODE
<op><boolean>
IMINFRACT
=
<ijkblankmode>
JMINFRACT
<op><dexp>
=0
KMINFRACT
<op><dexp>
=0
IMAXFRACT
<op><dexp>
=50
JMAXFRACT
<op><dexp>
=50
KMAXFRACT
<op><dexp>
=50
ZONE
=<integer>
OnlyonezonecanbeassignedtouseIJKblanking.
BLANKENTIRECELL
=<boolean>
YES
SettoNOtogetprecisionblanking.
CONSTRAINTnnn
nnn=<integer>
Use<integer>tospecifywhichconstrainttomodify.
COLOR
=<color>
BLACK
CONSTRAIN
TOP2MODE
=
<constrainintop2
mode>
USECONSTAN
T
INCLUDE
=<boolean>
NO
LINEPATTERN
=<linepattern>
SOLID
LINETHICKNESS
=<double>
0.4
PATTERNLENGTH
=<dexp>
RELOP
=
<valueblankrelo
p>
LESSTHANORE
QUAL
SHOW
=<boolean>
NO
VALUECUTOFF
=<double>
VARA
=<integer>
None
VARB
=<integer>
None
INCLUDE
=<boolean>
NO
VALUEBLANKCELLMO
DE
=
<valueblankcell
mode>
ANY
CORNER
}
IJK
{
Minimumandmaximumfractionsareintermsofpercentages
(0100).Zerorepresentsanindexofoneand100themaximum
index.
}
VALUE
{
Examples:
74
SettoNOtoturnoffallvalueblanking.
$!BRANCHCONNECTIVITY
Example 1:
SetIJKblankingtocutawaytheminimumindexcorner:
$!BLANKING
IJK
{
INCLUDE=YES
IMINFRACT=0
JMINFRACT=0
KMINFRACT=0
IMAXFRACT=50
JMAXFRACT=50
KMAXFRACT=50
}
Example 2:
Usevalueblankingtocutawayallcellsthathaveatleastonenodewherevariable3islessthanorequalto
7.5:
$!BLANKING
VALUE
{
INCLUDE=YES
CONSTRAINT1
{
INCLUDE=YES
VARA=3
RELOP=LESSTHANOREQUAL
VALUECUTOFF=7.5
}
}
Syntax:
ZONE=<integer>
Description:Forzoneswhereconnectivityisshared,thiscommandallowsforbranchingofconnectivity
informationfromthespecifiedzone.
Required Parameters
Parameter
ZONE
Syntax
Default
Notes
=<integer>
Example:
SupposeZones2,3and4shareconnectivity.Thiscommandbranchestheconnectivityofthesecondzone.
Zones3and4willstillshareconnectivity.
ZONE=2
75
$!BRANCHFIELDDATAVAR
Syntax:
ZONE=<integer>
VAR=<integer>
Description:Allowsforbranchingofspecifiedvariableinthespecifiedzoneforzonesthatsharevariables.
Required Parameters
Parameter
Syntax
VAR
=<integer>
ZONE
=<integer>
Default
Syntax
Example:
AssumeZones1,2and4sharevariables3and5.Thiscommandbranchesthethirdvariablefromthe
secondzone.Variable3willstillbesharedbyzones1and4,whilevariable5willstillbesharedbyall
threezones.:
ZONE=2
VAR=3
$!BREAK
Syntax:
$!BREAK
[noparameters]
Description:Jumpoutofthecurrent$!LOOPENDLOOPor$!WHILE$!ENDWHILE.
Example:
$!LOOP5
$!BREAK
$!ENDLOOP
C
$!COLORMAPCONTROL [<groupnumber>] [Required-Control Option]
Description:ThedifferentcommandsintheCOLORMAPCONTROLcompoundfunctionfamilyaredescribed
separatelyinthefollowingsections.Groupnumberisanoptionalparameterrangingfrom1to8,
whichdefaultsto1whenomitted.
TheCOLORMAPCONTROLcompoundfunctionsare:
$!COLORMAPCONTROL[<groupnumber>]REDISTRIBUTECONTROLPOINTS
$!COLORMAPCONTROL[<groupnumber>]COPYSTANDARD
$!COLORMAPCONTROL[<groupnumber>]RESETTOFACTORY
76
$!COLORMAPCONTROL [<groupnumber>] REDISTRIBUTECONTROLPOINTS
$!COLORMAPCONTROL [<groupnumber>] REDISTRIBUTECONTROLPOINTS
Syntax:
$!COLORMAPCONTROL[<groupnumber>]REDISTRIBUTECONTROLPOINTS
[noparameters]
Description:Redistributethecontrolpointsforthecurrentlyactivecolormapsotheyareevenlyspaced
acrossthecolormap.ThisisequivalenttoclickingRedistributeControlPointsintheColorMap
dialog.ThisdoesnotchangetheRGBvaluesassignedateachcontrolpoint.Groupnumberisan
optionalparameterrangingfrom1to8,whichdefaultsto1whenomitted.
Example:
$!COLORMAPCONTROLREDISTRIBUTECONTROLPOINTS
$!COLORMAPCONTROL [<groupnumber>] COPYSTANDARD
Syntax:
$!COLORMAPCONTROL[<groupnumber>]COPYSTANDARD
CONTOURCOLORMAP=<standardcolormap>
Description:Preseteithertheuserdefinedcolormaportherawuserdefinedcolormaptobeacopyofoneof
thestandardcolormaps.Tecplot360mustcurrentlybeusingeithertheuserdefinedcolormapor
therawuserdefinedcolormapinordertousethisfunction.Groupnumberisanoptional
parameterrangingfrom1to8,whichdefaultsto1whenomitted.
Required Parameter
Parameter
CONTOURCOLORMAP
Syntax
=
<standardcolormap>
Default
LGRAINBOW
Notes
Thecolormaptocopy.
Example:
Thefollowingexamplesetsthecurrentcolormaptobeacopyofthesmallrainbowcolormap:
$!COLORMAPCONTROLCOPYSTANDARD
CONTOURCOLORMAP=SMRAINBOW
$!COLORMAPCONTROL [<groupnumber>] RESETTOFACTORY
Syntax:
$!COLORMAPCONTROL[<groupnumber>]RESETTOFACTORY
[noparameters]
Description:RedistributethecontrolpointsandresettheRGBvaluesforthecurrentlyactivecolormap.This
isequivalenttoclickingResetontheColorMapdialog.Groupnumberisanoptionalparameter
rangingfrom1to8,whichdefaultsto1whenomitted.
Example:
$!COLORMAPCONTROLRESETTOFACTORY
$!COMPATIBILITY
Syntax:
$!COMPATIBILITY
77
$!CONTINUE
Description:Allowdatasharingaccessandsetting,withoutwarning.
Optional Parameters
Parameter
Syntax
Default
Notes
ALLOWDATASHARING
=<boolean>
YES
IfNO,Tecplot360willnotallowdatasharing.Thismaybe
necessarytouseolderaddonsthatcannothandleshareddata.
ALLOWOLDTEXT
=<boolean>
NO
IfNO,allowsTecplot360todisplaytextsubscriptsand
superscriptscreatedwitholderTecplot360versionswithout
automaticallyconvertingthetexttothenewformatting.
FORMATTING
Example: Thefollowingcommandsturnondatasharing:
$!COMPATIBILITYALLOWDATASHARING=YES
$!CONTINUE
Syntax: $!CONTINUE
Description:Transfercontrolbacktonearest$!LOOPor$!WHILE.
Example:
$!LOOP10
$!CONTINUE
$!ENDLOOP
$!CONTOURLABELS [Required-Control Option]
Description:ThedifferentcommandsintheCONTOURLABELScompoundfunctionfamilyaredescribed
separatelyinthefollowingsections.
TheCONTOURLABELScompoundfunctionsare:
$!CONTOURLABELSADD
$!CONTOURLABELSDELETEALL
$!CONTOURLABELS ADD
Syntax:
$!CONTOURLABELSADD
Description:Addcontourlabelstoyourplot.
78
$!CONTOURLABELS DELETEALL
Optional Parameters
Parameter
Syntax
Default
Notes
CONTOURGROUP
=<integer>
Defineswhichcontourgroupischanged.
ISALIGNED
=<boolean>
YES
IfYESthenalignthecontourlabelalongthecontourline;if
NO,drawthelabelhorizontally.
=<dexp>
0.0
Xpositionforcontourlabel.
=<dexp>
0.0
Ypositionforcontourlabel.
=<dexp>
0.0
Zpositionforcontourlabel(useZonlyfor3Dplots).
XYZPOS
{
Example:
Thefollowingcommandsaddlabelsat(0.5,0.25)and(0.73,0.17)ina2Dfieldplot.
##Thelabelswillbealigned:
$!CONTOURLABELSADD
CONTOURGROUP=2
XYZPOS
{
X=0.5
Y=0.25
}
$!CONTOURLABELSADD
XYZPOS
{
X=0.73
Y=0.17
}
$!CONTOURLABELS DELETEALL
Syntax:
Description:Deleteallcurrentlydefinedcontourlabels.
Optional Parameters
Parameter
CONTOURGROUP
Syntax
=<integer>
Default
1
Notes
Example:
CONTOURGROUP=3
$!CONTOURLEVELS [Required-Control Option]
Description:ThedifferentcommandsintheCONTOURLEVELScompoundfunctionfamilyaredescribed
TheCONTOURLEVELScompoundfunctionsare:
79
$!CONTOURLEVELS ADD
$!CONTOURLEVELSADD
$!CONTOURLEVELSNEW
$!CONTOURLEVELSDELETENEAREST
$!CONTOURLEVELSDELETERANGE
$!CONTOURLEVELSRESET
$!CONTOURLEVELSRESETTONICE
$!CONTOURLEVELS ADD
Syntax:
$!CONTOURLEVELSADD
<contourlevelrawdata>
Description:Addanewsetofcontourlevelstotheexistingsetofcontourlevels.
Required Parameter
Parameter
Syntax
Default
<contourlevelrawdata
>
Notes
Supplyalistofcontourlevelstoadd.
Optional Parameters
Parameter
CONTOURGROUP
Syntax
=<integer>
Default
1
Notes
Example: Addcontourlevels1.7,3.4and2.9totheplot:
$!CONTOURLEVELSADD
RAWDATA
3
1.7
3.4
2.9
$!CONTOURLEVELS DELETENEAREST
Syntax:
RANGEMIN=<dexp>
Description:DeletethecontourlevelwhosevalueisnearestthevaluesuppliedintheRANGEMINparameter.
80
$!CONTOURLEVELS DELETERANGE
Required Parameter
Parameter
RANGEMIN
Syntax
Default
=<dexp>
Notes
Deletethecontourlevelwhosevalueisnearesttothisvalue.
Optional Parameters
Parameter
CONTOURGROUP
Syntax
=<integer>
Default
1
Notes
Example: Deletethecontourlevelwhosevalueisnearestto3.4:
RANGEMIN=3.4
$!CONTOURLEVELS DELETERANGE
Syntax:
RANGEMIN=<dexp>
RANGEMAX=<dexp>
Description:Deleteallcontourlevelsbetweenaminimumandmaximumcontourvalue(inclusive).
Required Parameters
Parameter
Syntax
Default
Notes
RANGEMIN
=<dexp>
Minimumcontourleveltodelete.
RANGEMAX
=<dexp>
Maximumcontourleveltodelete.
Optional Parameters
Parameter
CONTOURGROUP
Syntax
=<integer>
Default
1
Notes
Example: Deleteallcontourlevelsbetween0.1and0.7:
RANGEMIN=0.1
RANGEMAX=0.7
$!CONTOURLEVELS NEW
Syntax:
$!CONTOURLEVELSNEW
[optional parameters]
Description:Replacethecurrentsetofcontourlevelswithanewset.
81
$!CONTOURLEVELS RESET
Required Parameter
Parameter
Syntax
Default
<contourlevelrawdata
>
Notes
Supplyalistofcontourlevelstoadd.
Optional Parameters
Parameter
CONTOURGROUP
Syntax
=<integer>
Default
1
Notes
Example: Replacethecurrentsetofcontourlevelswiththelevels0.5,0.75and1.0:
$!CONTOURLEVELSNEW
RAWDATA
3
0.5
0.75
1.0
$!CONTOURLEVELS RESET
Syntax:
NUMVALUES=<integer>
Description:Resetthecontourlevelstoasetofevenlydistributedvaluesspanningtheentirerangeofthe
currentlyselectedcontouringvariable.
Required Parameter
Parameter
NUMVALUES
Syntax
Default
=<integer>
Notes
Newnumberofcontourlevels.
Optional Parameters
Parameter
CONTOURGROUP
Syntax
=<integer>
Default
1
Notes
Example: Resetthecontourlevelstouse150levels:
NUMVALUES=150
$!CONTOURLEVELS RESETTONICE
Syntax:
APPROXNUMVALUES=<integer>
Description:Resetthecontourlevelstoasetofevenlydistributed,nicevaluesspanningtheentirerangeof
thecurrentlyselectedcontouringvariable,withaspecifiednumberofentries.
82
$!CREATECIRCULARZONE
Required Parameter
Parameter
APPROXNUMVALUES
Syntax
Default
=<integer>
Notes
Approximatenumberofcontourlevelsdesired.Actualvalue
maybedifferent.
Optional Parameters
Parameter
CONTOURGROUP
Syntax
=<integer>
Default
1
Notes
Example: Resetthecontourlevelstouse150levels:
APPROXNUMVALUES=10
Syntax:
IMAX= <integer>
JMAX=<integer>
Description:Createacircular(orcylindrical)IJorIJKorderedzone.
$!CREATEBOUNDARYZONES
Syntax:
$!CREATEBOUNDARYZONES<boolean>
Description:WhenYES,boundaryzonesarecreated.UsethiscommandwhenworkingwithStarCCMdatato
preservebackwardcompatibility.(StarCCMLoaderONLY)
83
$!CREATECONTOURLINEZONES
Required Parameters
Parameter
Syntax
Default
Notes
IMax
=<integer>
Radialdirection.
JMax
=<integer>
Circumferentialdirection,mustbegreaterthan3.
Optional Parameters
Parameter
Syntax
Default
DATATYPE
=<datatype>
SINGLE
KMax
=<integer>
RADIUS
=<dexp>
Notes
Bottomtotopdirection
=<dexp>
Xcoordinateforcenter.
XVAR
=<integer>
Auto
Onlyneededwhenprocessingjournalinstructions.
=<dexp>
Ycoordinateforcenter.
YVAR
=<integer>
Auto
Z1
=<dexp>
Zminimumifacylinderiscreated.
Z2
=<dexp>
Zmaximumifacylinderiscreated.
ZVAR
=<integer>
Auto
Examples:
Example 1:
Createacircular10by20IJorderedzonecenteredat(5,5)witharadiusof2:
IMax=10
JMax=20
X=5
Y=5
RADIUS=2
Example 2:
Createacylindrical5by6by8IJKorderedzonewiththebottomcenteredat(4,4,0)andthetopcentered
at(4,4,7)andaradiusof3:
IMax=5
JMax=6
KMax=8
X=4
Y=4
Z1=0
Z2=7
RADIUS=3
Syntax:
$!CREATECONTOURLINEZONES[group]
Description:Createzonesfromthecurrentlydefinedcontourlines.Onezonecanbecreatedfromeach
contourlevelinthatplot,oronezoneforeverypolylinecanbegenerated.
84
$!CREATEFEBOUNDARY
Optional Parameter
Parameter
CONTLINECREATE
MODE
Syntax
Default
=
[ONEZONEPER
CONTOURLEVE
Lor
ONEZONEPERI
NDEPENDENT
POLYLINE
Notes
Selectwhetheronezonepercontourleverwillbecreatedor
whethertherewillbeazoneforeachpolyline.
Example: Createanewzoneforeachcontourlineonanexistingcontourplot.
CONTLINECREATEMODE=ONEZONEPERCONTOURLEVEL
$!CREATEFEBOUNDARY
Syntax:
$!CREATEFEBOUNDARY
SOURCEZONE=<integer>
Description:ZoneedgesforfiniteelementdatacannotbeturnedonoroffusingtheedgeplotlayerinTecplot
360.Youcan,however,createaseparatezonewhichistheboundaryofafiniteelementzone.This
newzonecanthenbeturnedonoroff.
Required Parameter
Parameter
SOURCEZONE
Syntax
Default
=<integer>
Notes
Zonetoextracttheboundaryfrom.
Optional Parameter
Parameter
REMOVEBLANKED
Syntax
=<boolean>
Default
NO
SURFACES
Notes
SettoYESifyouwanttheresultingzonetoincludeonlythe
boundaryadjacenttononblankedcells.
Example: CreateanFEboundaryzonefromzone3:
$!CREATEFEBOUNDARY
SOURCEZONE=3
$!CREATEFESURFACEFROMIORDERED
Syntax:
SOURCEZONES=<set>
Description:AFESurfacezonecanbegeneratedfromtwoormoreIOrderedzones.Togetthebestpossible
output,itisrecommendedthatthesourcezonesshouldhavetheirnodesarrangedinasimilar
mannersothattheconnectinglinesbetweenpointsareasstraightforwardaspossible.Forthis
reason,indicesfromsourcezonesshouldincreaseinthesamedirection.
85
$!CREATEISOZONES
Required Parameter
Parameter
Syntax
SOURCEZONES
Default
=<set>
Notes
Zoneswhosepointswillbeusedtocreatethenewsurface.
Optional Parameter
Parameter
Syntax
CONNECTSTARTTOEND
=<boolean>
Default
NO
Notes
YESallowsforclosedsurfaces.
Example: CreateanFESurfacezonefromzones3and4:
SOURCEZONES=[34]
$!CREATEISOZONES
Syntax:
$!CREATEISOZONES
[noparameters]
Description:Createzonesfromthecurrentlydefinedisosurfaces.Onezonewillbecreatedfromeachdefined
isosurface.Theisosurfacesmustbeactiveandyoumusthaveatleastoneactivevolumezone.
Example:
$!CREATEISOZONES
$!CREATELINEMAP
Syntax:
$!CREATELINEMAP
[noparameters]
Description:CreateanewLinemapping.
Example:
$!CREATELINEMAP
$!CREATEMIRRORZONES
Syntax:
$!CREATEMIRRORZONES
SOURCEZONES=<set>
Description:Createnewzonesthataremirrorimagesofthesourcezones
86
$!CREATENEWFRAME
Required Parameter
Parameter
SOURCEZONES
Syntax
Default
=<set>
Notes
Zone(s)tocreatemirrorzone(s)from.
Optional Parameter
Parameter
MIRRORVAR
Syntax
=<mirrorvar>
Default
X
Notes
Thisvariableinthenewzoneismultipliedby1afterthezone
iscopied.
Example:
Createamirrorofzones24acrosstheYaxis(thatis,mirrortheXvariable)in2Dframemode:
$!CREATEMIRRORZONES
SOURCEZONES=[24]
MIRRORVAR=X
$!CREATENEWFRAME
Syntax:
$!CREATENEWFRAME
Description:Createsanewframe.
Optional Parameters
Parameter
HEIGHT
Syntax
Default
Notes
=<dexp>
Unitsareininches.
XYPOS
{
X
=<dexp>
1.0
Xposition(inches)relativetotheleftedgeofthepaper.
=<dexp>
0.25
Yposition(inches)relativetothetopedgeofthepaper.
WIDTH
=<dexp>
Unitsareininches.
ThedefaultpositionandsizeoftheinitialframecreatedwhenTecplot360startsupcanbechangedinthe
Example:
Thefollowingexamplecreatesa5by5inchframewiththeupperlefthandcorneroftheframe
positioned2inchesfromtheleftedgeofthepaperand1inchfromthetop:
$!CREATENEWFRAME
XYPOS
{
X=2
Y=1
}
WIDTH=5
HEIGHT=5
87
$!CREATERECTANGULARZONE
Syntax:
Description:Createarectangularzone.Ifnodatasetexistswhenthiscommandisexecuted,adatasetis
createdwithvariablesX,Y(andZ,ifKMax>1).Ifadatasetexistspriortothiscommand,thenon
coordinatevariablesforthezonecreatedareinitializedtozero.
Optional Parameters
Parameter
Syntax
Default
Notes
IMax
=<integer>
Idimension.
JMax
=<integer>
Jdimension.
KMax
=<integer>
Kdimension.
X1
=<dexp>
Xminimum.
Y1
=<dexp>
Yminimum.
Z1
=<dexp>
Zminimum.
X2
=<dexp>
Xmaximum.
Y2
=<dexp>
Ymaximum.
Z2
=<dexp>
Zmaximum.
XVAR
=<integer>
Auto
YVAR
=<integer>
Auto
ZVAR
=<integer>
Auto
DATATYPE
=<datatype>
SINGLE
Example:
CreatearectangularIJorderedzonedimensioned20by30whereXrangesfrom0to3andYfrom3to9:
IMax=20
JMax=30
X1=0
Y1=3
X2=3
Y2=9
$!CREATESIMPLEZONE
Syntax:
$!CREATESIMPLEZONE<xyrawdata>
Description:CreateanewzonebyspecifyingonlyalistofXYpairsofdata.Ifotherzonesexistpriortousing
thisfunctionandtherearemorethan2variables,thentheadditionalvariablesarealsocreatedand
settozero.
88
$!CREATESLICEZONEFROMPLANE
Required Parameter
Parameter
Syntax
Default
Notes
<xyrawdata>
SeeChapter13:RawDatafordetails.
Optional Parameter
Parameter
Syntax
DATATYPE
Default
=<datatype>
Notes
SINGLE
Example: CreateasimpleXYzonethathastheXYpairs(1,0),(2,1),(3,7)and(59):
$!CREATESIMPLEZONE
RAWDATA
4
10
21
37
59
Syntax:
Description:Createanewzoneasaslicethroughexisting3Dvolumezones.Use$!GLOBALTHREEDto
definetheslicingplaneorientation.
Optional Parameters
Parameter
FORCEEXTRACTIONTO
Syntax
Default
=<boolean>
YES
=<slicesource>
VOLUMEZONES
Notes
SINGLEZONE
SLICESOURCE
Example: CreateaslicezoneatX=0:
$!GLOBALTHREED
SLICE
{
ORIGIN{X=0}
NORMAL
{
X=1
Y=0
Z=0
}
}
SLICESOURCE=VOLUMEZONES
$!CREATESLICEZONES
Syntax:
$!CREATESLICEZONES
[noparameters]
89
$!CREATESPHERICALZONE
Description:CreateanewzoneforeachslicedefinedontheSliceDetailsdialog.Onlycreatesslicesfrom
volumezones.
Example:
$!GLOBALCONTOURVAR=4
$!SLICEATTRIBUTESENDPOSITION{X=1}
$!SLICEATTRIBUTESSTARTPOSITION{X=6}
$!SLICEATTRIBUTESNUMITERMEDIATESLICES=6
$!SLICEATTRIBUTESSHOWBEGINENDSLICE=YES
$!SLICEATTRIBUTESSHOWINTERMEDIATESLICES=YES
$!REDRAW
$!CREATESLICEZONES
Syntax:
IMAX=<integer>
JMAX=<integer>
Description:CreateasphericalIJKorderedzone.
Required Parameters
Parameter
Syntax
Default
Notes
IMax
=<integer>
Psidirection.
JMax
=<integer>
Thetadirection.
Optional Parameters
Parameter
Syntax
Default
Notes
DATATYPE
=<datatype>
SINGLE
RADIUS
=<dexp>
=<dexp>
Xcoordinateforcenter.
XVAR
=<integer>
Auto
=<dexp>
Ycoordinateforcenter.
YVAR
=<integer>
Auto
=<dexp>
Zcoordinateforcenter.
ZVAR
=<integer>
Auto
Examples:
Example 1:
Createaspherical10by20IJorderedzonecenteredat(5,5)witharadiusof2:
IMax=10
JMax=20
X=5
Y=5
RADIUS=2
90
$!CREATESTREAMZONES
$!CREATESTREAMZONES
Syntax:
$!CREATESTREAMZONES
Description:Createoneormorezonesoutofthecurrentlydefinedstreamtraces.Thenewzoneshavethe
samenumberofvariablesperdatapointastheotherzonesinthedatasetwithallnoncoordinate
variablesinterpolatedatthepositionsalongthestreamtrace.
Optional Parameter
Parameter
CONCATENATE
Syntax
Default
=<boolean>
Notes
NO
SettoYEStocreateasinglezoneoutofallcommon
streamtraces.Thecellthatconnectstheendofonestreamtrace
withthebeginningofthenextcanlaterbeturnedoffusing
valueblanking.
Example: Createasinglezoneoutofallcommonstreamzones:
$!CREATESTREAMZONES
CONCATENATE=YES
D
$!DATASETUP
Syntax:
$!DATASETUP
Description:ASetValuecommandthatsetsmiscellaneousparametersrelatedtodata.
Optional Parameters
Parameter
Syntax
Default
Notes
COMMANDLINE
{
AutoStrandDataFiles
=<boolean>
YES
Thisoptionallowsyoutoauto
stranddatafilesinTecplot360.This
canbesettoNOorcommentedout
oftheconfigurationfile(tecplot.cfg)
toretaintheTecplot10compatibility
SCRATCHDATAFIELDTYPE
=<datatype>
Setthedatatypeforscratcharrays
usedforgeometrieslinesegments
andotherlines.Thedefaultis
SINGLEforWindowsandDOUBLE
forUNIX.Thisparametercanonly
beusedintheTecplot360
configurationfile.
PREPLOTARGS
=<string>
Argumentsusedtoruntheincluded
Preplotexecutable.Preplotisusedto
convertASCIIdatafileswhenthey
arereaddirectlyintoTecplot360.See
SectionB4PreplotintheUsers
Manualformoreinformationon
Preplotanditsoptions.
Example:
91
$!DEFAULTGEOM
ChangetheargumentsusedtoPreplotASCIIfilessoonlyzones1,2,and3areprocessed:
$!DATASETUP
PREPLOTARGS="zonelist1:3"
$!DEFAULTGEOM
Syntax:
$!DEFAULTGEOM
Description:ASetValuecommandthatsetstheattributesforthedefaultgeometry.Whenageometryis
createdinteractively,itscolor,linethickness,andsoforth,arepresetbasedonthedefault
geometry.ThiscommandisusuallyusedonlyintheTecplot360configurationfile.
Optional Parameters
Parameter
Syntax
ANCHORPOS
<<xyz>>
ARROWHEADANGLE
<op><dexp>
ARROWHEADATTACHMENT
ARROWHEADSIZE
<op><dexp>
ARROWHEADSTYLE
<arrowheadstyle>
ATTACHTOZONE
=<boolean>
COLOR
=<color>
DATATYPE
=<fielddatatype>
Default
DRAWORDER
=<draworder>
AFTERDATA
DRAWORDER
=<draworder>
AFTERDATA
FILLCOLOR
=<color>
ISFILLED
=<boolean>
LINEPATTERN
=<linepattern>
LINETHICKNESS
<op><dexp>
MACROFUNCTIONCOMMAND
=<string>
MAINTAINASPECTRATIO
=<boolean>
NUMELLIPSEPTS
<op><integer>
PATTERNLENGTH
<op><dexp>
PIXELASPECTRATIO
=<double>
POSITIONCOORDSYS
=<coordsys>
SCOPE
=<scope>
ZONE
=<integer>
Notes
Setthemacrocommandtoexecute
whenyouhoveroverthegeometry
andpressCtrlrightclick.
YES
Avalueof0allowsTecplot360to
selecttheaspectratio.Useonlyif
yourcirclesorsquaresduetothe
aspectratioofyourmonitor.
Example: Makethedefaultgeometrylinethickness0.2percent:
$!DEFAULTGEOM
LINETHICKNESS=0.2
$!DEFAULTTEXT
Syntax:
92
$!DEFAULTTEXT
$!DELAY
Description:ASetValuecommandthatsetstheattributesforthedefaulttext.Whentextisaddedtoaplot
interactively,itsfont,color,size,andsoforth,arebasedonthedefaulttext.Thiscommandis
usuallyusedonlyintheTecplot360configurationfile.
Optional Parameters
Parameter
ANCHOR
Syntax
Default
Notes
= <textanchor>
ANCHORPOS
<<xy>>
ANGLE
<op><dexp>
ATTACHTOZONE
=<boolean>
BOX
<<textbox>>
CLIPPING
=<clipping>
COLOR
=<color>
LINESPACING
<op><dexp>
MACROFUNCTION
=<string>
COMMAND
POSITIONCOORDSYS
=<coordsys>
SCOPE
=<scope>
TEXTSHAPE
<<textshape>>
ZONE
<op><integer>
Setthemacrocommandtoexecutewhenyouhoveroverthe
geometryandpressCtrlrightclick.
Example: MakethedefaulttextfontTimesboldwithacharacterheightof14points:
$!DEFAULTTEXT
TEXTSHAPE
{
FONTFAMILY="Times"
ISBOLD=YES
ISITALIC=NO
SIZEUNITS=POINT
HEIGHT=14
}
$!DELAY
Syntax:
$!DELAY<integer>
[noparameters]
Description:DelayTecplot360executionfor<integer>seconds.
Example: PauseTecplot360for3seconds:
$!DELAY3
$!DELETEAUXDATA
Syntax:
$!DELETEAUXDATA
AUXDATALOCATION=[zone/var/dataset/frame/linemap|page]
Description:DeleteAuxiliaryDataintheformofname/valuepairsfromzones,framesordatasets.
93
$!DELETELINEMAPS
Required Parameters
Parameter
AUXDATALOCATION
Syntax
Default
Notes
Default
Notes
=[zone/var/
dataset/frame/
linemap|page]
Optional Parameters
Parameter
Syntax
NAME
=<string>
NUM
=<integer>
VAR
=<integer>
ZONE
=<integer>
OnlyrequiredifAUXDATALOCATION =zone
Example: DeletetheselectedAuxiliaryDatafromZone2.:
$!DELETEAUXDATA
AUXDATALOCATION=zone
ZONE=2
NAME=VARIABLEDATA
$!DELETELINEMAPS
Syntax:
$!DELETEMAPS<set>
[noparameters]
Description:DeleteoneormoreLinemappings.If<set>isomittedthenallLinemappingsaredeleted.
Example: DeleteLinemappings2,3,4and8:
$!DELETELINEMAPS[24,8]
$!DELETEVARS
Syntax:
$!DELETEVARS<set>
[noparameters]
Description:Deleteoneormorevariables.
Example: Deletevariables4and10:
$!DELETEVARS[4,10]
$!DELETEZONES
Syntax:
$!DELETEZONES<set>
[noparameters]
Description:Deleteoneormorezones.
94
$!DOUBLEBUFFER [Required-Control Option]
Example: Deletezones3,7,8,9and11:
$!DELETEZONES[3,79,11]
$!DOUBLEBUFFER [Required-Control Option]
Description:ThedifferentcommandsintheDOUBLEBUFFERcompoundfunctionfamilyaredescribed
TheDOUBLEBUFFERcompoundfunctionsare:
$!DOUBLEBUFFEROFF
$!DOUBLEBUFFERON
$!DOUBLEBUFFERSWAP
$!DOUBLEBUFFER OFF
Syntax:
$!DOUBLEBUFFEROFF
[noparameters]
Description:Turnoffdoublebuffering;usethiscommandonceattheendofasequenceofusingthedouble
buffer.
Example: See$!DOUBLEBUFFERSWAP
$!DOUBLEBUFFER ON
Syntax:
$!DOUBLEBUFFERON
[noparameters]
Description:Turnondoublebuffering;usethiscommandonceatthebeginningofasequenceofusingthe
doublebuffer.Whiledoublebufferingisturnedonalldrawingissenttothebackbuffer.
Example: See$!DOUBLEBUFFERSWAP
$!DOUBLEBUFFER SWAP
Syntax:
$!DOUBLEBUFFERSWAP
[noparameters]
Description:Swapthebackbuffertothefront.Inotherwords,copytheimageinthebackbuffertothefront.
Example:
Thefollowingexampleusesthedoublebuffertoshowtherotationofa3Dobject:
$!DOUBLEBUFFERON
$!LOOP10
$!ROTATE3DVIEWX
ANGLE=5
$!REDRAW
$!DOUBLEBUFFERSWAP
$!ENDLOOP
$!DOUBLEBUFFEROFF
95
$!DRAWGRAPHICS
$!DRAWGRAPHICS
Syntax:
$!DRAWGRAPHICS<boolean>
[noparameters]
Description:Turnonoroffallgraphicsdrawing.Turningoffallgraphicsduringpreliminaryportionsofa
macrofilecangreatlyincreasetheefficiencyofthemacro.
Example: Turnoffallgraphicsdrawing:
$!DRAWGRAPHICSNO
$!DROPDIALOG
Syntax:
$!DROPDIALOG<dialogname>
[noparameters]
Description:DropaTecplot360interfacedialog.ThiscommandismainlyusefulfortheTecplot360demo.To
launchadialoguse$!LAUNCHDIALOG.
Example:
$!DROPDIALOGMACROVIEWER
$!DUPLICATELINEMAP
Syntax:
$!DUPLICATELINEMAP
SOURCEMAP=<integer>
DESTINATIONMAP=<integer>
Description:CopyattributesfromanexistingLinemappingtoanother.
Required Parameters
Parameter
Syntax
Default
Notes
DESTINATIONMAP
=<integer>
Thedestinationcaneitherbethenumberofanexistingmapor
1greaterthanthecurrentnumberofmaps.Ifyouchoosethe
latter,anewLinemappingwillbecreated.
SOURCEMAP
=<integer>
Linemappingfromwhichtocopy.
Example: CopyattributesofLinemapping3toLinemapping7:
$!DUPLICATELINEMAP
SOURCEMAP=3
DESTINATIONMAP=7
$!DUPLICATEZONE
Syntax:
$!DUPLICATEZONE
Description:Makeacopyofanexistingzone.Youcanassignindexrangestocreateanewzonewhichisa
subsetofthesourcezone.
96
$!ELSE
Required Parameter
Parameters
SOURCEZONE
Syntax
Default
Notes
=<integer>
Zonetoduplicate(thesourcezone).
Optional Parameters
Parameters
Syntax
Default
Notes
IRANGE
SeenotesRangeParametersfor$!ALTERDATAaction
command.
{
MIN
=<integer>
MAX
=<integer>
SKIP
=<integer>
}
JRANGE
command.
{
MIN
=<integer>
MAX
=<integer>
SKIP
=<integer>
}
KRANGE
command.
{
MIN
=<integer>
MAX
=<integer>
SKIP
=<integer>
Examples:
Example 1:
Makeacompletecopyofzone2:
$!DUPLICATEZONE
SOURCEZONE=2
Example 2:
Duplicatezone3creatingazonewhichusesonlytheIindexrangefrom2to7fromthesourcezone:
$!DUPLICATEZONE
SOURCEZONE=3
IRANGE
{
MIN=2
MAX=7
}
E
$!ELSE
Syntax:
$!ELSE
97
$!ELSEIF
[noparameters]
Description:Conditionallyhandlemacrocommands.Usedwhenan$!IFstatementisFALSE.
Example:
$!VARSET|C|=2
$!IF|C|==5
$!CREATENEWFRAME
XYPOS
{
X=2.5
Y=1.5
}
WIDTH=4
HEIGHT=4
$!ELSE
$!CREATENEWFRAME
XYPOS
{
X=3
Y=2
}
WIDTH=3
HEIGHT=3
$!ENDIF
$!ELSEIF
Syntax: $!ELSEIF<conditionalexp>
Description:Conditionallyhandlemacrocommands.Usedtocreatemultipleoptionsforstatementsshould
an$!IFstatementbeFALSE.
Example:
$!VARSET|A|=2
$!IF|A|<5
$!CREATENEWFRAME
XYPOS
{
X=1
Y=1
}
WIDTH=3
HEIGHT=3
$!ELSEIF|A|>5
$!CREATENEWFRAME
XYPOS
{
X=2
Y=1
}
WIDTH=5
HEIGHT=5
$!ELSE
98
$!EXPORT
$!CREATENEWFRAME
XYPOS
{
X=3
Y=3
}
WIDTH=9
HEIGHT=9
$!ENDIF
$!EXPORT
Syntax:
$!EXPORT
[noparameters]
Description:ExportanimagefilefromTecplot360.Seethe$!EXPORTSETUPcommandfordetailsonsetting
uptheexportedimagetype.The$!EXPORTcommandisnotvalidforanimationformats.(AVIand
RasterMetafile.)
Example:
$!EXPORTSETUPEXPORTFORMAT=PNG
$!EXPORT
$!EXPORTCANCEL
Syntax:
$!EXPORTCANCEL
[noparameters]
Description:Canceloutofthecurrentexportanimationsequence.Theanimationfilebeinggeneratedis
removed.
Example:
$!EXPORTCANCEL
$!EXPORTFINISH
Syntax:
$!EXPORTFINISH
[noparameters]
Description:Signalsthecompletionofananimationsequenceandcausestheanimationfiletobecreated.You
mustcall$!EXPORTSTARTpriortousing$!EXPORTFINISH.Thiscommandisonlyvalidforanimation
formats.(AVIandRasterMetafile.)Youmayusethe|EXPORTISRECORDING|intrinsicvariableto
makesurethatananimationsequencehasbeeninitiated.
Example:
$!EXPORTSETUP
EXPORTFNAME="rotate.avi"
EXPORTFORMAT=AVI
$!EXPORTSTART
$!LOOP5
$!ROTATE3DVIEWX
99
$!EXPORTNEXTFRAME
ANGLE=5
$!EXPORTNEXTFRAME
$!ENDLOOP
$!IF"|EXPORTISRECORDING|"=="YES"
$!EXPORTFINISH
$!ENDIF
$!EXPORTNEXTFRAME
Syntax:
$!EXPORTNEXTFRAME
[noparameters]
Description:Recordsthenextframeofananimation.Youmustcall$!EXPORTSTARTpriortocalling
$!EXPORTNEXTFRAME.Thiscommandisonlyvalidforanimationformats.(AVIandRasterMetafile.
Youmayusethe|EXPORTISRECORDING|intrinsicvariabletomakesurethatananimationsequence
hasbeeninitiated.)
Example:
$!EXPORTSETUP
EXPORTFORMAT=AVI
$!EXPORTSTART
$!LOOP5
$!ROTATE3DVIEWX
ANGLE=5
$!EXPORTNEXTFRAME
$!ENDLOOP
$!EXPORTFINISH
$!EXPORTSETUP
Syntax:
$!EXPORTSETUP
Description:ASetValuecommandthatsetstheattributesforexportingimagefilesfromTecplot360.
ExportingisusuallyintendedasameanstotransferimagesfromTecplot360tobeimportedby
otherapplications.See$!PRINTSETUPand$!PRINTforgeneratingoutputintendedforprinters
andplotters.
100
$!EXPORTSTART
Optional Parameters
Parameter
Syntax
Default
Notes
ANIMATIONSPEED
=<double>
10
AppliestoAVIonly.Setstheanimationspeedinframesper
second.
AVICOMPRESSION
=<string>
COLOR
PRESERVING
AvailablevaluesareLINEPRESERVING,COLORPRESERVING
(Windowsonly),orLOSSLESSUNCOMPRESSED
NO
UsedforTIFF,BMP,andPNGformats.
CONVERTTO256COLORS
=<boolean>
EXPORTFNAME
=<string>
EXPORTFORMAT
=<exportformat>
WINDOWS
METAFILE
EXPORTREGION
=
<bitdumpregion>
CURRENTFRAM
E
FLASHCOMPRESSION
TYPE
SMALLESTSIZE
=
<compressiontype
>
FLASHIMAGETYPE
=<imagetype>
LOSSLESS
IMAGEWIDTH
<op> <integer>
=512
JPEGENCODING
=STANDARDor
PROGRESSIVE
STANDARD
PRINTRENDERTYPE
VECTOR
=
<printrendertype>
QUALITY
=<integer>
SUNRASTERFORMAT
STANDARD
=
<sunrasterformat>
OnlyappliesifEXPORTFORMATisSUNRASTER.
SUPERSAMPLEFACTOR
=<integer>
Thisisthefactorusedinantialiasingwhilereducingthesizeof
anexportedimage.Alargersizecanimprovethequalityofthe
image,butslowsperformance.
TIFFBYTEORDER
=<tiffbyteorder>
INTEL
USEMULTIPLE
=<boolean>
NO
=<boolean>
NO
75
Rangeisfrom1100
AppliestoAVIandRasterMetafileonly.
COLORTABLES
USESUPERSAMPLE
ANTIALIASING
Example: SetupTecplot360toexportaRasterMetafileimagetothefilemovie.rm:
$!EXPORTSETUP
EXPORTFNAME="movie.rm"
EXPORTFORMAT=RASTERMETAFILE
$!EXPORTSTART
Syntax:
$!EXPORTSTART
[optionalparameter]
Description:Signalsthestartofananimationsequenceandrecordsthefirstframeoftheanimation.This
commandisonlyvalidforanimationformats.(AVIandRasterMetafile.)
Optional Parameters
Parameter
EXPORTREGION
Syntax
Default
Notes
=<bitdumpregion>
Example:
$!EXPORTSETUP
EXPORTFORMAT=AVI
101
$!EXTENDEDCOMMAND
EXPORTREGION=CURRENTFRAME
$!EXPORTSTART
$!LOOP5
$!ROTATE3DVIEWX
ANGLE=5
$!EXPORTNEXTFRAME
$!ENDLOOP
$!EXPORTFINISH
$!EXTENDEDCOMMAND
Syntax:
$!EXTENDEDCOMMAND
COMMANDPROCESSORID=<string>
COMMAND=<string>
Description:Sendacommandtoanaddon.Theaddonregistersthenameofafunctionthatwillbecalled
whenan$!EXTENDEDCOMMANDisprocessed.Tecplot360knowswhichregisteredfunctiontocall
basedontheCOMMANDPROCESSORIDstring.SeethefunctionTecUtilMacroExtCommandCallbackinthe
ADKReferenceManual.
Required Parameters
Parameter
Syntax
COMMANDPROCESSOR
Default
Stringthatidentifiestheaddon.Thismustmatchthe
publishedIDstringfortheaddon.
=<string>
Thecommandtobesenttotheaddon.
ID
COMMAND
Notes
=<string>
Optional Parameters
Parameter
Syntax
<extendedcommandr
awdata>
Default
NULL
Notes
IftheRAWDATAsectionissuppliedtheneachlineofthe
RAWDATAsectionisappendedtotheCOMMANDstring.A
leadingnewlinecharacterisappendedfirst,andeachlinein
theRAWDATAsectionwillalsobeterminatedwithanewline
(exceptforthelastline).
Example:
SendthecommandGOtotheaddonthathasregisteredacommandprocessorwithanCOMMANDPROCESSORID
ofXPROC:
$!EXTENDEDCOMMAND
COMMANDPROCESSORID="XPROC"
COMMAND="GO"
$!EXTRACTFROMGEOM
Syntax:
$!EXTRACTFROMGEOM
Description:
Extractdatafroma2or3Dfieldplot.Thelocationsatwhichtoextractthedatacomefroma
polylinegeometrythatmustbepickedpriortoissuingthiscommand.
102
$!EXTRACTFROMPOLYLINE
Optional Parameters
Parameters
Syntax
EXTRACTLINEPOINTS
ONLY
Default
NO
IfNO,mustincludeNUMPTS.
NO
IfNO,azoneiscreated.IfYES,mustincludeFNAME.
EXTRACTTOFILE
=<boolean>
FNAME
=<string>
INCLUDEDISTANCE
=<boolean>
Filenameforextractedfile.Requiredif
EXTRACTTOFILEisYES.
NO
VAR
NUMPTS
Notes
=<boolean>
IfYES,thenTecplot360includesanextravariableintheresult
whichisthedistancealongthelineofpointsextractedand
EXTRACTTOFILEmustalsobeYES.
RequiredifEXTRACTLINEPOINTSONLYisNO.
=<integer>
Example:
Extract20pointsfromalongthecurrentlypickedgeometry.Sendtheresulttoafilecalledextract.dat:
$!EXTRACTFROMGEOM
NUMPTS=20
EXTRACTTOFILE=YES
FNAME="extract.dat"
Syntax:
<xyrawdata>
Description:Extractdatafroma2or3Dfieldplot.Thelocationsofwheretoextractthedatafromcomefrom
asuppliedpolylineintheformof<xyzrawdata>.
Optional Parameters
Parameters
Syntax
Default
Notes
EXTRACTLINEPOINTS
ONLY
=<boolean>
NO
IfNO,mustincludeNUMPTS.
EXTRACTTHROUGH
=<boolean>
NO
IfYES,dataisextractedfromXYZcoordinatesinthepolyline.
IfNO,dataisextractedfromthesurface.
EXTRACTTOFILE
=<boolean>
NO
IfNO,azoneiscreated.IfYES,youmustincludeFNAME.
FNAME
=<string>
INCLUDEDISTANCE
=<boolean>
VOLUME
VAR
NUMPTS
=<integer>
Filenameforextractedfile.RequiredifEXTRACTTOFILEis
YES.
NO
IfYES,Tecplot360includesanextravariableintheresult
whichisthedistancealongthelineofpointsextractedand
EXTRACTOFILEmustalsobeYES.
RequiredifEXTRACTLINEPOINTSONLYisNO.
Example:
Extract10pointsfromspecificlocationsinafieldplot.Createazonewiththeextracteddata:
EXTRACTLINEPOINTSONLY=YES
RAWDATA
10
000
120
240
320
340
103
$!FIELDLAYERS
440
450
460
570
690
F
$!FIELDLAYERS
Syntax:
$!FIELDLAYERS
Description:ASetValuecommandthatturnsfieldplotlayersonoroff,orsetsthe2Ddraworder.
Optional Parameters
Parameter
Syntax
Default
SHOWCONTOUR
=<boolean>
NO
SHOWEDGE
=<boolean>
YES
SHOWISOSURFACES
=<boolean>
NO
SHOWMESH
=<boolean>
NO
SHOWSCATTER
=<boolean>
NO
SHOWSHADE
=<boolean>
YES
SHOWSLICES
=<boolean>
NO
SHOWVECTOR
=<boolean>
NO
TWODDRAWORDER
=
<twoddraworde
r>
BYLAYER
USELIGHTINGEFFECT
=<boolean>
YES
USETRANSLUCENCY
=<boolean>
YES
Notes
Vectorvariablesmustbedefined.See
$!GLOBALTWODVECTORor$!GLOBALTHREEDVECTOR.
Example: Turnonthescatterlayer:
$!FIELDLAYERS
SHOWSCATTER=YES
$!FIELDMAP
Syntax:
$!FIELDMAP[<set>]
Description:ASetValuecommandthatassignszoneattributesforfieldplots.The<set>parameter
immediatelyfollowingthe$!FIELDMAPcommandisoptional.If<set>isomittedthenthe
assignmentisappliedtoallzones.Otherwisetheassignmentisappliedonlytothezonesspecified
in<set>.
104
$!FIELDMAP
Optional Parameters
Parameter
Syntax
Default
Notes
CONTOUR
{
COLOR
=<color>
BLACK
CONTOURTYPE
=<contourtype>
FLOOD
FLOODCOLORING
=<contourcoloring>
GROUP1
LINECONTOURGROUP
=<integer>
LINEPATTERN
=<linepattern>
SOLID
LINETHICKNESS
=0.1
PATTERNLENGTH
<op> <dexp>
<op> <dexp>
SHOW
=<boolean>
YES
USELIGHTINGEFFECT
=<boolean>
YES
COLOR
=<color>
BLACK
EDGETYPE
=<edgetype>
BORDERSAND
CREASES
IEDGE
=<borderlocation>
BOTH
AppliesforIJ,IK,andIJKordered
zones.
JEDGE
=<borderlocation>
BOTH
zones.
KEDGE
=<borderlocation>
BOTH
zones.
LINETHICKNESS
=<dexp>
0.1
SHOW
=<boolean>
YES
USEBLANKING
=<boolean>
=2
}
EDGELAYER
{
}
EFFECTS
{
LIGHTINGEFFECT
=<lightingeffect>
GOURAUD
SURFACETRANSLUCENCY
<translucency>
50
USETRANSLUCENCY
=<boolean>
YES
USEVALUEBLANKING
=<boolean>
YES
SettoYEStoincludevalueblanking
inthespecifiedzones
USECLIPPLANES
=<set>
[16]
Useclippingplanesspecifiedtoclip
zonesspecifiedinsetforFIELDMAP,
orallzonesifnonespecified.Possible
valuesinclude[](none),orany
combinationofthenumbers16,
enclosedinbrackets.
COLOR
=<color>
BLACK
LINEPATTERN
=<linepattern>
SOLID
LINETHICKNESS
<op> <dexp>
=0.1
MESHTYPE
=<meshtype>
OVERLAY
PATTERNLENGTH
<op> <dexp>
=2
SHOW
=<boolean>
YES
<<ijk>>
I=1,J=1,K=1
SURFACETRANSLUCENCYrange
isoneto99.
}
MESH
{
}
POINTS
{
IJKSKIP
Limitsthenumberofvectorsor
scattersymbolsdrawn.
105
$!FIELDMAP
Parameter
POINTSTOPLOT
Syntax
Default
Notes
<pointstoplot>
SURFACENODES
COLOR
=<color>
BLACK
FILLCOLOR
=<color>
WHITE
FILLMODE
=<fillmode>
NONE
FRAMESIZE
<op> <dexp>
2.5
LINETHICKNESS
<op> <dexp>
0.1
SHOW
=<boolean>
YES
SIZEBYVARIABLE
=<boolean>
NO
Scattersizingvariablemustbe
definedbeforethiscanbesettoYES.
Seethe$!GLOBALSCATTER
command.
SYMBOLSHAPE
<<symbolshape>>
SeeNotes
ISASCII=NO,GEOMSHAPE=
SQUARE
}
SCATTER
{
Sizeofsymbolswhen
SIZEBYVARIABLEisNO.
}
SHADE
{
COLOR
=<color>
WHITE
SHOW
=<boolean>
YES
USELIGHTINGEFFECT
=<boolean>
YES
IRANGE
<<indexrange>>
SeeNotes
MIN=1,Max=0,Skip=1
JRANGE
<<indexrange>>
SeeNotes
MIN=1,Max=1,Skip=1
KRANGE
<<indexrange>>
SeeNotes
MIN=1,Max=1,Skip=1
SURFACESTOPLOT
=<surfacestoplot>
NONE
ARROWHEADSTYLE
<arrowheadstyle>
PLAIN
COLOR
=<color>
BLACK
ISTANGENT
=<boolean>
NO
LINEPATTERN
=<linepattern>
SOLID
LINETHICKNESS
=<dexp>
0.1
PATTERNLENGTH
=<dexp>
SHOW
=<boolean>
YES
VECTORTYPE
=<vectortype>
TAILATPOINT
}
SURFACES
{
}
VECTOR
{
}
VOLUMEMODE
{
VOLUMEOBJECTSTOPLOT
<<volumeobjectstoplot>>
SHOWISOSURFACES=YE
S,SHOWSLICES=YES,
SHOWSTREAMTRACES=
YES
=<integer>
VOLUMEMODEappliestovolume
zones,withtheexceptionthat
POINTSTOPLOTalsoappliesto
finiteelementsurfacezones.
}
GROUP
Examples:
106
Assignagroupnumbertothe
suppliedsetofzones.
$!FILECONFIG
Example 1:
Changethecontourplottypetofloodforzones112:
$!FIELDMAP[112]
CONTOUR
{
CONTOURTYPE=FLOOD
}
Example 2:
Changethemeshcolortoredforallzones(defaultmeshcolorisblack):
$!FIELDMAP
MESH
{
COLOR=RED
}
$!FILECONFIG
Syntax:
$!FILECONFIG
Description:ASetValuecommandthatsetsfilepathinformationinTecplot360.
107
$!FILECONFIG
Optional Parameters
Parameter
ADDZONESTOEXISTING
Syntax
Default
Notes
=<boolean>
NO
IfYES,Tecplot360willaddthezones
fromtheappendeddatatoany
existingstrandsinthedataset.IfNO,
Tecplot360willappendthestrands
fromthenewdatatoanyexisting
strandsinthedataset.
ASSIGNSTRANDID
=<boolean>
YES
IfYES,Tecplot360willassignstrand
IDstozones(iftimeissuppliedfor
thezonesbutnotstrandIDs).IfNO,
Tecplot360willnotassociatethese
zoneswithanystrands.
DATAFILEVARLOADMODE
=<varloadmode>
BYNAME
Setthedefaultloadingmodefor
variables.BYNAMEloadsvariables
basedontheirname.Ifsetto
BYNAME,thenVARNAMELIST
mustbesuppliedaswell.
BYPOSITIONloadsvariablesbased
ontheirpositioninthefile.Toget
TecplotVersion7.0behavior,use
BYPOSITION.
DOAUTOFNAMEEXTENSION
=<boolean>
DOAUTOFNAMEEXTENSIONW
ARNING
=<boolean>
IfYESawarningisdisplayedwhen
attemptingtosavewithanextension
otherthanthedefaultextension.
COLORMAPFILE
=<string>
Defaultextensionforcolormapfiles.
EQUATIONFILE
=<string>
Defaultextensionforequationfiles.
IMPORTIMAGEFILE
=<string>
Defaultextensionforimagefiles.
INPUTDATAFILE
=<string>
DefaultextensionforTecplot360
inputdatafiles.
INPUTLAYOUTFILE
=<string>
Defaultextensionforloadinglayout
files.
MACROFILE
=<string>
Defaultextensionformacrofiles.
OUTPUTASCIIDATAFILE
=<string>
DefaultextensionforASCIIoutput
datafiles.
OUTPUTBINARYDATAFILE
=<string>
Defaultextensionforbinaryoutput
datafiles.
OUTPUTLAYOUTFILE
=<string>
Defaultextensionforsavinglinked
layoutfiles.
OUTPUTLAYOUTPACKAGEF
ILE
=<string>
Defaultextensionforsavinglayout
packagefiles.
STYLEFILE
=<string>
Defaultextensionforstylefiles.
STRANDS
FNAMEFILTER
{
}
LAYOUTCONFIG
{
INCLUDEDATA
=<boolean>
NO
IfYES,layoutpackagesarethe
defaultformatforlayouts
INCLUDEPREVIEW
=<boolean>
NO
IfYES,previewimagesaresaved
withlayoutpackages.
USERELATIVEPATHS
=<boolean>
YES
IfYES,fileswillbereferencedusing
relativepathsinlayoutfiles.
=<boolean>
YES
IfYES,Tecplot360willuseitsload
ondemandfeaturesforloadingand
unloadingvariables.
}
LOADONDEMAND
{
ALLOW
108
$!FILECONFIG
Parameter
Syntax
Default
Notes
DATASTORESTATEGY
=<dataloadstrategy>
AUTO
Setthedatastorestrategyforload
ondemand.IfsettoAUTO,Tecplot
360willusestorelargeallocationsin
thetemporarydirectoryanduse
memorymappedI/Otoreadand
writetotheregionswhenpossible
otherwiseitwillusethememory
heap(usuallythisprovidesbetter
performanceforlargedata).Ifsetto
HEAPTecplot360willnotusethe
temporarydirectoryforlarge
allocations(thisoptionisusually
slowerwhenworkingwithlarge
data).
UNLOADSTRATEGY
=<unloadstrategy>
AUTO
Settheunloadstrategyforloadon
demand.IfsettoAUTOTecplot360
willunloadunusedvariableswhen
theamountneededRAMbeginsto
reachthemaximumamountofRAM.
IfsettoNEVERUNLOADTecplot360
willloadvariablesondemandbut
willneverattempttounloadthem
evenifitisrunninglowonmemory.
IfsettoMINIMIZEMEMORYUSE
Tecplot360willaggressivelyunload
variablesassoonastheyarenot
neededregardlessoftheamountof
memoryavailableorinuse.
}
TEMPFILEPATH
Setthedirectorywhereyouwant
Tecplot360tostoreitstemporary
files.
=<string>
File Name Filters:ValidcharactersareupperorlowercaseAZ,and09.Eachfiltershouldbe

precededby(*),oritwillnotfilterproperly.OnWindows operatingsystems,toallowmorethanone
extension,separatethemwithasemicolon(;).OnUNIX platformsmultipleextensionswillnotfilter
correctlyunlesstheyfollowthestandardUNIXshellfilterformat.
Windows Example:Thisexamplefiltersallfourextensionswhenopeningalayoutfile.
$!FILECONFIGFNAMEFILTER{INPUTLAYOUTFILE="*.wsf;*.dwr;*.lay;*.lpk"}
Windows Example:Thisexamplefiltersbothextensionswhenwritingalayoutfile.Thedefault
extensionis.wsfbecauseitisthefirstextensionpresentedinthelist.
$!FILECONFIGFNAMEFILTER{OUPUTLAYOUTFILE=".wsf;*.lay"}
Motif Example:Thisexamplefilters.aek,.plt,andmore.
$!FILECONFIGFNAMEFILTER{INPUTDATAFILE="*.[ae][el][kt]"}
Motif Example:Thisexamplefilters.dat,.cam,andmore.Thedefaultextensionis.datbecauseD
andTarethefirstletterspresentedwithinthebrackets.
$!FILECONFIGFNAMEFILTER{OUTPUTASCIIDATAFILE="*.[dc]a[tm]"}
Example: SetthedirectorywhereTecplot360storestemporaryfilestobe/usr/tmp:
$!FILECONFIG
DATAFILEVARLOADMODE=BYPOSITION
TEMPFILEPATH="/usr/tmp"
LAYOUTCONFIG{USERELATIVEPATHS=YES}
FNAMEFILTER
{
INPUTDATAFILE="*.[pd][la]t"
COLORMAPFILE="*.clr"
}
109
$!FONTADJUST
$!FONTADJUST
Syntax:
$!FONTADJUST
Description:ASetValuecommandthatsetscharacterspacingandsizingforfontsinTecplot360.These
parametersrarelychange.
Optional Parameters
Parameter
Syntax
BOLDFACTOR
Default
Notes
Thicknessofboldcharactersrelativetonormal.
INTERCHARSPACING
<op> <double>
<op> <integer>
STROKEFONTLINE
<op> <double>
Thickness(inframeunits)oflinesusedtodrawstrokefonts.
<op> <double>
Sizeofsubscriptandsuperscriptcharactersrelativetothefont
height.
Increaseordecreaseintercharacterspacing.Unitsareinpixels
onthescreen.
THICKNESS
SUBSUPFRACTION
Example: Makesuperscriptandsubscriptcharacters1/3thefontheight:
$!FONTADJUST
SUBSUPFRACTION=0.333
$!FRAMECONTROL [Required-Control Option]
Description:ThedifferentcommandsintheFRAMECONTROLcompoundfunctionfamilyaredescribed
separatelyinthefollowingsections.WhenworkingwiththeFRAMECONTROLcommands,itmayhelp
torealizethatacommandcontainingActivatechangestheactiveframe;acommandcontaining
MoveTochangestheframedrawingorder.
TheFRAMECONTROLcompoundfunctionsfollowingare:
$!FRAMECONTROLActivateTop
$!FRAMECONTROLActivateNext
$!FRAMECONTROLActivatePrevious
$!FRAMECONTROLActivateAtPosition
$!FRAMECONTROLActivateByName
$!FRAMECONTROLActivateByNumber
$!FRAMECONTROLMoveToTopActive
$!FRAMECONTROLMoveToTopByName
$!FRAMECONTROLMoveToTopByNumber
$!FRAMECONTROLMoveToBottomActive
$!FRAMECONTROLMoveToBottomByName
$!FRAMECONTROLMoveToBottomByNumber
$!FRAMECONTROLDeleteActive
$!FRAMECONTROLFitAllToPaper
$!FRAMECONTROL ACTIVATETOP
Syntax:
$!FRAMECONTROLACTIVATETOP
[noparameters]
Description:Changestheactiveframetotheframethatistopmostintheframedrawingorder.
Example:
$!FRAMECONTROLACTIVATETOP
110
$!FRAMECONTROL ACTIVATENEXT
$!FRAMECONTROL ACTIVATENEXT
Syntax:
$!FRAMECONTROLACTIVATENEXT
[noparameters]
Description:Changestheactiveframetothenextoneupintheframedrawingorder,ortothebottomframe
iftheactiveframeisatthetop.
Example:
$!FRAMECONTROLACTIVATENEXT
$!FRAMECONTROL ACTIVATEPREVIOUS
Syntax:
$!FRAMECONTROLACTIVATEPREVIOUS
[noparameters]
Description:Changestheactiveframetothenextonedownintheframedrawingorder,ortothetopframeif
theactiveframeisatthebottom.
Example:
$!FRAMECONTROLACTIVATEPREVIOUS
$!FRAMECONTROL ACTIVATEATPOSITION
Syntax:
$!FRAMECONTROLACTIVATEATPOSITION
X = <xpos> Y = <ypos>
Description:Activatesthetopmostframeatthespecifiedposition.XandYareinpapercoordinates.
Required Parameters
Parameter
Syntax
Default
Notes
xpos
=<dexp>
SpecifyXcoordinateofposition.
ypos
=<dexp>
SpecifyYcoordinateofposition.
Example:
$!FRAMECONTROLACTIVATEATPOSITIONX=0Y=0
$!FRAMECONTROL ACTIVATEBYNAME
Syntax:
$!FRAMECONTROLACTIVATEBYNAME
Name=<name>
Description:Changestheactiveframetothespecifiedframe.Ifnoframenameisgiven,thiswillactivatethe
bottomframe.
111
$!FRAMECONTROL ACTIVATEBYNUMBER
Required Parameter
Parameter
Name
Syntax
Default
Notes
=<string>
Specifynameoftheframetoactivate.
Example: ActivateaframenamedTopography.
$!FRAMECONTROLACTIVATEBYNAMENAME="Topography"
$!FRAMECONTROL ACTIVATEBYNUMBER
Syntax:
$!FRAMECONTROLACTIVATEBYNUMBER
Frame=<number>
Description:Changestheactiveframetothespecifiedframe.
Required Parameter
Parameter
Frame
Syntax
=<integer>
Default
1
Notes
Specifynumberoftheframetoactivate.
Example: ActivateFrame4.
$!FRAMECONTROLACTIVATEBYNUMBERFRAME=4
$!FRAMECONTROL MOVETOTOPACTIVE
Syntax:
$!FRAMECONTROLMOVETOTOPACTIVE
[noparameters]
Description:Movestheactiveframetothetopofthedrawingorder.
Example:
$!FRAMECONTROLMOVETOTOPACTIVE
$!FRAMECONTROL MOVETOTOPBYNAME
Syntax:
$!FRAMECONTROLMOVETOTOPBYNAME
NAME=<name>
Description:Movestheframespecifiedbynametothetopoftheframedrawingorder.
Required Parameter
Parameter
Name
Syntax
=<string>
Default
Notes
Specifynameoftheframetomovetothetopofthedrawing
order.
Example: MovestheframenamedTopographytothetopofthedrawingorder.
$!FRAMECONTROLMOVETOTOPBYNAMENAME="TOPOGRAPHY"
112
$!FRAMECONTROL MOVETOTOPBYNUMBER
$!FRAMECONTROL MOVETOTOPBYNUMBER
Syntax:
$!FRAMECONTROLMOVETOTOPBYNUMBER
FRAME=<number>
Description:Movestheframespecifiedbynumbertothetopoftheframedrawingorder.Ifnoframenumber
isspecified,thiscommandwillmovethebottomframetothetopoftheframedrawingorder.
Required Parameter
Parameter
Frame
Syntax
Default
=<integer>
Notes
Specifynumberoftheframetomovetothetopofthedrawing
order.
Example:Movesframe4tothetopofthedrawingorder.
$!FRAMECONTROLMOVETOTOPBYNUMBERFRAME=4
$!FRAMECONTROL MOVETOBOTTOMACTIVE
Syntax:
$!FRAMECONTROLMOVETOBOTTOMACTIVE
[noparameters]
Description:Movestheactiveframetothetopoftheframedrawingorder.
Example:
$!FRAMECONTROLMOVETOBOTTOMACTIVE
$!FRAMECONTROL MOVETOBOTTOMBYNAME
Syntax:
$!FRAMECONTROLMOVETOBOTTOMBYNAME
FRAME=<name>
Description:Movestheframespecifiedbynametothebottomoftheframedrawingorder.
Required Parameter
Parameter
Name
Syntax
Default
=<string>
Notes
Specifynameoftheframetomovetothebottom.
Example:
$!FRAMECONTROLMOVETOBOTTOMBYNAMENAME=<name>
$!FRAMECONTROL MOVETOBOTTOMBYNUMBER
Syntax:
$!FRAMECONTROLMOVETOBOTTOMBYNUMBER
FRAME=<number>
Description:Movestheframespecifiedbynumbertothebottomoftheframedrawingorder.
113
$!FRAMECONTROL DELETEACTIVE
Required Parameter
Parameter
Frame
Syntax
Default
=<integer>
Notes
Specifynumberoftheframetomovetothebottom.
Example: MoveFrame003tothebottom.
$!FRAMECONTROLMOVETOBOTTOMBYNUMBERFRAME=003
$!FRAMECONTROL DELETEACTIVE
Syntax:
$!FRAMECONTROLDELETEACTIVE
[noparameters]
Description:Deletetheactiveframe.
Example:
$!FRAMECONTROLDELETEACTIVE
$!FRAMECONTROL FITALLTOPAPER
Syntax:
$!FRAMECONTROLFITALLTOPAPER
[noparameters]
Description:Resizeallframessothattheyfitinsidethehardcliplimitsofthepaper.
Example:
$!FRAMECONTROLFITALLTOPAPER
$!FRAMELAYOUT
Syntax:
$!FRAMELAYOUT
Description:ASetValuecommandthatsetstheposition,border,andbackgroundattributesfortheactive
frame.Usethe$!FRAMECONTROLactioncommandtopushandpopframesifyouwanttochangethe
settingsforaframeotherthantheactiveframe.
114
$!FRAMENAME
Optional Parameters
Parameter
Syntax
BACKGROUNDCOLOR
Default
Notes
=<color>
WHITE
OnlyappliesifISTRANSPARENT=NO.
BORDERTHICKNESS
<op> <dexp>
=0.1
ValueisinYframeunits.
HEADERCOLOR
=<color>
RED
OnlyappliesifSHOWHEADER=YES.
HEADERFONTAMILY
=<string>
Helvetica
HEIGHT
<op> <dexp>
=8
HEADERFONTISBOLD
=<boolean>
YES
HEADERFONTIS
=<boolean>
NO
ISTRANSPARENT
=<boolean>
NO
SHOWBORDER
=<boolean>
YES
SHOWHEADER
=<boolean>
NO
WIDTH
<op> <dexp>
=9
Valueisininches.
XYPOS
<<xy>>
X=1,Y=0.25
Positionofupperleftcorneroftheframeininchesfromleft
andtopedgeofthepaper.
Valueisininches.
ITALIC
Example:
Placetheactiveframeintheupperleftcornerofthepaper(offset0.5inchesfromthetopandleftedges),
maketheframedimensions3by4inches,andturnofftheframeborder:
$!FRAMELAYOUT
SHOWBORDER=NO
XYPOS
{
X=0.5
Y=0.5
}
WIDTH=3
HEIGHT=4
$!FRAMENAME
Syntax:
$!FRAMENAME=<string>
[noparameters]
Description:Setthenamefortheactiveframe(Default=Frame001).
Example:
$!FRAMENAME="PressureContoursforwell33"
$!FRAMESETUP
Syntax:
$!FRAMESETUP
Description:ASetValuecommandthatsetsparametersusedtopresetdynamicframeattributeswhena
frameisinitialized.
115
$!GETAUXDATA
Optional Parameters
Parameter
ALIGNINGCONTOUR
Syntax
Default
Notes
=<boolean>
YES
IfYES,thenextinteractivelyplacedcontourlabelisalignedto
thecontourline.
=<boolean>
NO
IfsettoYES,thevaluessetvia$!FIELDMAP[nnn]
MESHLAYER{COLOR=<color>}areusedfordefaultzone
meshcolors(similarlyforEdgecolors).
FITINITIALFRAMETO
WORKSPACE
=<boolean>
YES
IfsettoNO,thenewlayoutisshownasinV10withtheentire
paperfittotheworkarea.IfsettoYES,thenewlayoutis
shownwiththeactiveframefittotheworkarea.
ThiscommandchangesthebehaviorofTecplot360asitfirst
appearsduringasessionandasitappearsafteranewlayout
command.Ithasnoeffectonthecurrentplot,butitcanbe
usedinamacrotosetthevalueforfuturenewplots.Itis
typicallyfoundinthetecplot.cfgfile.
INITIAL3DFITTO
=<boolean>
YES
IfYES,initial3Dplotshowsaviewequivalenttousing
$!ViewFitSurfacesortheView>FitSurfacemenuitem,and
ignoresthe$!FrameSetupInitial3DScaleparameter.
IfNO,initial3Dplotisequivalenttousingthevalueof
$!FrameSetupInitial3DScaleintheView>Translate/Magnify
dialogorusingthe$!ViewScale=<double>command.
ThisvaluedefaultstoYESfor360andNOforFocus.
<op> <dexp>
<op> <integer>
=1.1
Initialscalefor3Dplots.
=10
Numberofpointstoplacealongstreamtracerakes.
RODRIBBONDEFLEN
<op> <dexp>
=0.06
Defaultwidth(inframeunits)ofastreamtraceorribbon
SHOWAPPENDEDZONES
=<boolean>
YES
IfsettoNO,zonesaddedviaanappenddataoperationwillbe
turnedoffinitially.
SHOWNONWALL
=<boolean>
NO
IfsettoYES,anynewzonethathasanonwall
BOUNDARYCONDITIONdefinedwillbeturnedoffinitially.
VECTDEFLEN
<op> <dexp>
=0.06
Whenavectorplotisdrawnforthefirsttimethevector
magnitudeisadjustedsothelongestvectoris
VECTDEFLENunitslong.VECDEFLENisinframeunits.
VECTMINLEN
<op> <dexp>
=0.0005
Minimumlengthincentimeters.Vectorsshorterthanthis
lengtharenotdrawn.
LABELS
ASSIGNSEQUENCED
ZONECOLORS
SURFACES
INITIAL3DSCALE
NUMSTREAMRAKE
POINTS
BOUNDARYZONES
USECOMMON
YES
SORTSTACK
DEFAULT2D
BOTH
STREAMTRACESTREAM
DIRECTION
DEFAULT3D
BOTH
STREAMTRACESTREAM
DIRECTION
Example: Makethedefaultlengthforthelongestvectorfivepercent:
$!FRAMESETUP
VECTDEFLEN=5
G
$!GETAUXDATA
Syntax:
116
$!GETAUXDATA<macrovar>
AUXDATALOCATION=[zone/var/dataset/frame/linemap|page]
NAME=<string>
$!GETCONNECTIVITYREFCOUNT
Description:RetrieveAuxiliaryDataintheformofname/valuepairsandsaveittothemacrovariable.
Required Parameters
Parameter
Syntax
AUXDATALOCATION
=[zone/var/
dataset/frame/
linemap|page]
NAME
=<string>
Default
Notes
Nameofexistingauxiliarydata
Optional Parameters
Parameter
Syntax
Default
Notes
MAP
=<integer>
OnlyrequiredifAUXDATALOCATION=linemap
VAR
=<integer>
OnlyrequiredifAUXDATALOCATION=var
ZONE
=<integer>
OnlyrequiredifAUXDATALOCATION=zone
Example: GettheAuxiliaryDatafromZone2,andstoreitinthemacrovariable|ABC|:
$!GETAUXDATA|ABC|
NAME=ABC.Aux.Data
ZONE=2
$!GETCONNECTIVITYREFCOUNT
Syntax:
$!GETCONNECTIVITYREFCOUNT<macrovar>
ZONE=<integer>
Description:Fetchthecountofhowmanyzonesshareconnectivitywiththespecifiedzone.Countincludes
specifiedzone.
Required Parameters
Parameter
ZONE
Syntax
Default
Notes
=<integer>
Example:
FetchtheconnectivitycountfromZone2,andstoreitinthemacrovariable|ABC|. Ifzones2,5and6share
connectivity,|ABC|=3.:
$!GETCONNECTIVITYREFCOUNT|ABC|
ZONE=2
$!GETCURFRAMENAME
Syntax:
$!GETCURFRAMENAME<macrovar>
[noparameters]
Description:QueryTecplot360forthenameoftheactiveframe.The<macrovar>representsthemacro
variabletoreceivetheresults.
117
$!GETFIELDVALUE
Example: Putthenameoftheactiveframeintothemacrovariable|CFRAME|.
$!GETCURFRAMENAME|CFRAME|
$!GETFIELDVALUE
Syntax:
$!GETFIELDVALUE<macrovar>
ZONE=<integer>
VAR=<integer>
INDEX=<integer>
Description:Fetchthefieldvalue(datasetvalue)atthespecifiedpointindexandassignthevalueto
<macrovar>.IfthezonereferencedisIJorIJKordered,thenthepointindexiscalculatedby
treatingthe2or3Dimensionalarrayasa1Darray.
Required Parameters
Parameter
Syntax
INDEX
=<integer>
VAR
=<integer>
ZONE
=<integer>
Default
Notes
Example:
Adatasetcontains2zonesand3variables.Zone2isdimensioned5by3.Fetchthevaluefromvariable3
atIJlocation(2,2),andstoreitinthemacrovariable|ABC|:
$!GETFIELDVALUE|ABC|
ZONE=2
VAR=3
INDEX=7
Note:INDEXwascalculatedusing:
INDEX=I+(J1)*|MAXI|+(K1)*|MAXI|*|MAXJ|
=5*(21)+2
=7
$!GETFIELDVALUEREFCOUNT
Syntax:
$!GETFIELDVALUEREFCOUNT<macrovar>
ZONE=<integer>
VAR=<integer>
Description:Getthecountofhowmanyzonessharetheindicatedvariablewiththespecifiedzone.Count
includesthespecifiedzone.
Required Parameters
Parameter
Syntax
VAR
=<integer>
ZONE
=<integer>
Example:
118
Default
Notes
$!GETNODEINDEX
Adatasetcontains5zonesand3variables.Zones1,2and4sharevariable3,andzones3and5share
variable3.
$!GETFIELDVALUEREFCOUNT|ABC|
ZONE=2
VAR=3
Thisreturns|ABC|=3,while
$!GETFIELDVALUEREFCOUNT|DEF|
ZONE=5
VAR=3
returns|DEF|=2becausethevariableisnotsharedacrossallfivezones.
$!GETNODEINDEX
Syntax:
$!GETNODEINDEX=<macrovar>
ZONE=<integer>
ELEMENT=<integer>
CORNER=<integer>
Description:Thisfunctiononlyworksforfiniteelementzones.Queryforthenodeindexinthespecified
locationasdescribedbytheZONE,ELEMENT,andCORNERparameters.
Required Parameter
Parameter
Syntax
Default
Notes
ZONE
=<integer>
Zonemustbegreaterthanorequaltoone.
CORNER
=<integer>
Possiblevaluesare13,14,or18,dependingupontheelement
type.
ELEMENT
=<integer>
Mustbegreaterthanorequaltooneandlessthanorequalto
|MAXJ|.
Example: Gettheindexforthenodeatcorner3ofthelastelementinzonenumber1.
$!GETZONETYPE|ZONETYPE|
ZONE=1
$!IF"|ZONETYPE|"="FEBRICK"
$!GETNODEINDEX|INDEX|
ZONE=1
ELEMENT=|MAXJ|
CORNER=3
...Dosomethingwith|INDEX|...
$!ENDIF
$!GETVARLOCATION
Syntax:
$!GETVARLOCATION<macrovar>
ZONE=<integer>
VAR=<integer>
Description:ReturnsthelocationofthevariableinthezoneaseitherCELLCENTEREDorNODALandsaves
inthemacrovariable.
119
$!GETVARNUMBYNAME
Required Parameter
Parameter
Syntax
VAR
=<integer>
ZONE
=<integer>
Default
Notes
Example: Getthevariablelocationforthethirdvariableinzone1.
$!GETVARLOCATION|ABC|
ZONE=1
VAR=3
$!GETVARNUMBYNAME
Syntax:
$!GETVARNUMBYNAME<macrovar>
NAME=<string>
Description:Givenavariablename,getthenumberforthatvariable.Thisvariablenumbercanthenbeused
toassignattributes,suchaswhatvariabletouseforcontouring.
Required Parameter
Parameter
NAME
Syntax
=<string>
Default
Notes
Nameofthevariable.Ifavariablehasaliases,thenamemust
correspondtooneofthealiases.
Example:
GetthevariablenumberforthevariablenamedPRESSUREandmakeitthecontouringvariable.
$!GETVARNUMBYNAME|PVARNUM|
NAME="PRESSURE"
$!GLOBALCONTOUR
VAR=|PVARNUM|
$!GETZONETYPE
Syntax:
$!GETZONETYPE|<macrovar>|
ZONE=<integer>
Description:Queryforthezonetypeofthespecifiedzone.Thezonetypewillbeassignedto<macrovar>.
Thepossiblereturnvaluesare:
"ORDERED"
"FELINESEG"
"FETRIANGLE"
"FEQUAD"
"FETETRA"
"FEBRICK"
"FEPOLYGON"
"FEPOLYHEDRON"
120
$!GLOBALCOLORMAP
Required Parameter
Parameter
Syntax
ZONE
Default
Notes
=<integer>
Zonemustbegreaterthanorequaltoone.
Example:
$!GETZONETYPE|ZONETYPE|
ZONE=1
$!IF"|ZONETYPE|"=="FETRIANGLE"
$!PAUSE"ThezoneisFETriangle."
$!ENDIF
$!GLOBALCOLORMAP
Syntax:
$!GLOBALCOLORMAP[<groupnumbers>]
Description:ASetValuecommandthatchangesthesettingsfortheglobalcontourcolormapandtheglobal
lightsourceshadingcolormapinTecplot360.Changeshereaffectallframesusingthesecolor
maps.See$!GLOBALCONTOURCOLORMAPFILTERforadditionalsettingsthatcanbeappliedona
framebyframebasis.
Optional Parameters
Ifyouwouldlikethesettingsinthesecommandstopersist,addthemtoyourtecplot.cfgfile(locatedin
yourinstallationdirectory).I
Parameter
CONTOURCOLORMAP
Syntax
Default
SMRAINBOW
GRAYSCALE
=<colormap>
<<colormapcontrolpoints>>
GROUPNUMBER
=<integer>
LGRAINBOW
MODERN
SMRAINBOW
TWOCOLOR
USERDEFINED
USERDEFINED
NUMCONTROLPOINTS
=<integer>
Notes
Groupnumbermustbebetween1and
8.
Example:
Makethethirdcontrolpointforthesmallrainbowcolormapforthe4thColorMapgrouptobepositioned
0.44ofthewayacrossthecolormap.SettheleadingandtrailingRGBredvalueto90:
$!GLOBALCOLORMAP4
SMRAINBOW
{
CONTROLPOINT3
{
COLORMAPFRACTION=0.44
LEADRGB
{R=90}
TRAILRGB
{R=90}
}
}
121
$!GLOBALCONTOUR
$!GLOBALCONTOUR
Syntax:$!GLOBALCONTOUR<contourgroup>
Description:ASetValuecommandthatchangesglobalattributesassociatedwithcontourplotsorcontour
levels.Theoptionalparameter<contourgroup>referstothedefinedcontourgroups,18,allowed
inTecplot360,andtakesanintegervalueofonethrougheight.The<contourgroup>parameteris
optional,andifomitted,Tecplot360willusecontourgroup1.Ifyouwouldlikethesettingsin
thesecommandstopersist,addthemtoyourtecplot.cfgfile,locatedinyourinstallationdirectory.
TheNUMBERFORMATsettingforLABELSalsocontrolsthenumberformatinthelegend.
Optional Parameters
Ifyouwouldlikethesettingsinthesecommandstopersist,addthemtoyourtecplot.cfgfile(locatedinyour
installationdirectory).
Parameter
Syntax
Default
CONTOURLINESTYLE
Notes
Thisisusedtoassignaspecialline
patternschemeforcontourlineplots.
{
CONTOURLINEMODE
=<contourlinemode>
LINESKIP
<op> <integer>
<op> <dexp>
PATTERNLENGTH
}
COLORCUTOFF
{
INCLUDEMAX
=<boolean>
YES
INCLUDEMIN
=<boolean>
YES
RANGEMAX
<op><dexp>
<op><dexp>
=0.75
RANGEMIN
=0.25
}
COLORMAPFILTER
Theglobalcolormapisdefinedusing
the$!COLORMAPcommand.
COLORMAPFILTERallowseachframe
tomakeadjustmentstotheglobalcolor
mapthatwillonlyapplytotheactive
frame.
{
COLORMAPCYCLES
<op> <integer>
COLORMAPDISTRIBUTION
<colormapdistribution>
COLORMAPOVERRIDE
<integer>
<<colormapoverride>>
COLORMAPOVERRIDEACTIVE =<boolean>
<<continuouscolor>>
CONTINUOUSCOLOR
REVERSECOLORMAP
Use<integer>tochoosewhichoverride
tooperateon.
NO
CMIN=0,CMAX=1
=<boolean>
USEFASTAPPROXCONTINUOU =<boolean>
SFLOOD
<<zebrashade>>
ZEBRA
}
DEFNUMLEVELS
LABELS
{
122
=<integer>
15
Setsthetargetnumberofcontourlevels
forsituationswherecontourlevelsare
automaticallyreset.Tecplot360will
attempttocreatelevelswherethestart,
endandincrementvaluesareall
clippedfloatingpointvalues.
$!GLOBALCONTOUR
Parameter
Syntax
Default
ALIGNAUTOLABELS
=<boolean>
YES
AUTOLABELSPACING
<op> <dexp>
<op> <integer>
=30
AUTOLEVELSKIP
COLOR
=<color>
BLACK
FILLCOLOR
=<color>
WHITE
GENERATEAUTOLABELS
=<boolean>
YES
ISFILLED
=<boolean>
YES
LABELWITHVALUE
=<boolean>
YES
MARGIN
<op> <dexp>
=5
NUMFORMAT
<<numberformat>>
SeeNotes
SHOW
=<boolean>
NO
TEXTSHAPE
<<textshape>>
FONTFAMILY=
Helevetica,ISBOLD=NO,
ISITALIC=NO
SIZEUNITS=FRAME,
HEIGHT=1.5
ANCHORALIGNMENT
anchoralignment>
TOPRIGHT
AUTORESIZE
=<boolean>
NO
AUTOSIZEMAXLIMIT
=<double>
0.5
BOX
<<textbox>>
SeeNotes
HEADERTEXTSHAPE
<<textshape>>
FONTFAMILY=
Helvetica,ISBOLD=NO,
ISITALIC=NO,
SIZEUNITS=FRAME,
HEIGHT=2.5
INCLUDECUTOFFLEVELS
=<boolean>
NO
ISVERTICAL
=<boolean>
YES
LABELINCREMENT
=<double>
LABELLOCATION
=<contourlabellocation>
CONTOURLEVELS
NUMBERTEXTSHAPE
<<textshape>>
FONTFAMILY=
ISITALIC=NO,
SIZEUNITS=FRAME,
HEIGHT=2.5
OVERLAYBARGRID
=<boolean>
YES
=1
Notes
IfYES,automaticlabelsarealigned
withthecontourlines,otherwisethey
arehorizontal.
IfYES,automaticlabelsare
repositionedoneachredraw.
IfYES,automaticlabelsshowthe
contourvalueotherwisetheyshowthe
contourlevelnumber.
FORMATTING=
BESTFLOAT,CUSTOMLABEL=1,
PRECISION=4,SHOWDECIMALSON
WHOLENUMBERS=NO,
REMOVELEADINGZEROS=NO,
SHOWNEGATIVESIGN=
YES,TIMEDATEFORMAT=
yyyymmddhh:mm:ss.00
Notallowedtochangesizeunits
parameter.
}
LEGEND
{
ROWSPACING
<op> <dexp>
=1.2
SHOW
=<boolean>
NO
SHOWHEADER
=<boolean>
YES
TEXTCOLOR
=<color>
BLACK
XYPOS
<<xy>>
X=95,Y=80
=<integer>
BOXTYPE=HOLLOW,MARGIN=10,
LINETHICKNESS=0.1,
COLOR=BLACK,
FILLCOLOR=WHITE
Thinlinearoundeachbandinthecolor
bar.
}
VAR
Variableusedforcontourlevels.
123
$!GLOBALCONTOUR
Parameter
Syntax
Default
Notes
COLORCUTOFF
{
RANGEMIN
=<double>
1x10150
RANGEMAX
=<double>
1x10150
INCLUDEMIN
=<boolean>
NO
INCLUDEMAX
=<boolean>
NO
=<integer>
}
COLORMAPFILTER
{
GROUP
COLORMAPDISTRIBUTION
BANDED
CONTINUOUSCOLOR
{
CMIN
=<integer>
CMAX
=<integer>
=<boolean>
NO
INCLUDE
=<boolean>
NO
ISTRANSPARENT
=<boolean>
NO
COLOR
=<color>
BLACK
=<integer>
}
REVERSECOLORMAP
ZEBRA
{
}
COLORMAPCYCLES
USEFASTAPPROXCONTINUOU =<boolean>
SFLOOD
NO
COLORMAPOVERRIDEACTIVE =<boolean>
NO
COLORMAPOVERRIDE
=<boolean>
NO
}
CONTOURLINESTYLE
{
CONTOURLINEMODE
=<contourlinemode>
USEZONELINETYPE
LINESKIP
=<integer>
PATTERNLENGTH
=<dexp>
Example:
Thisexampledoesthefollowing:Turnsonthecontourlegend;Setsthefloodcutofftogofrom3to5;
Reversesthecolormap;Insertsacolormapoverrideofyellowbetweencontourlevelnumber7andlevel
number9.
$!GLOBALCONTOUR1
LEGEND
{
SHOW=YES
}
COLORCUTOFF
{
RANGEMIN=3
RANGEMAX=5
INCLUDEMIN=YES
INCLUDEMAX=YES
}
COLORMAPFILTER
124
$!GLOBALEDGE
{
REVERSECOLORMAP=YES
COLORMAPOVERRIDEACTIVE=YES
COLORMAPOVERRIDE1
{
INCLUDE=YES
COLOR=YELLOW
STARTLEVEL=7
ENDLEVEL=9
}
}
$!GLOBALEDGE
Syntax: $!GLOBALEDGE
Description:ASetValuecommandthatsetsattributeswhichsetstheminimumcreaseangleforedges.
Optional Parameters
Ifyouwouldlikethesettingsinthiscommandtopersist,addthemtoyourtecplot.cfgfile(locatedinyourinstallation
directory).
Parameter
Syntax
MINCREASEANGLE
=<double>
Default
Notes
135
$!GLOBALFRAME
Syntax:
$!GLOBALFRAME
Description:ASetValuecommandthatsetsattributeswhichapplytoallframes.Ifyouwouldlikethe
settingsinthiscommandtopersist,addittoyourtecplot.cfgfile,locatedinyourinstallation
directory.
Optional Parameters
Ifyouwouldlikethesettingsinthiscommandtopersist,addthemtoyourtecplot.cfgfile(locatedinyourinstallation
directory).
Parameter
FRAMEHEADERFORMAT
Syntax
Default
=<string>
Notes
The<string>containsthetextthatappearsineachofTecplot
360sframeheaders.Thisstringtypicallycontainsdynamic
text.SeealsoSection181.5DynamicTextintheUsers
Manual.Thedefaultstringis:
&(FRAMENAME)|&(DATE)|&(DATASETTITLE).
FRAMEHEADERHEIGHT
<op> <dexp>
=0.2
Valueisininches.
SNAPTOGRID
=<boolean>
NO
EvenifsettoYES,Tecplot360maynotallowsnappinginsome
situations.
SNAPTOPAPER
=<boolean>
NO
EvenifsettoYES,Tecplot360maynotallowsnappinginsome
situations.
USETHICKERACTIVE
=<boolean>
YES
WhensettoYES(whichisthedefaultbehavior),theactive
framedisplaysintheworkareawithaborderonepixelwider
thanspecified,tomaketheactiveframemorevisible.Setthis
toNOtokeeptheactiveframethesamesizeasspecified(but
stillblackwhileinactiveframesaregray).Thiswillnotaffect
printedorexportedmaterialunlesstheimageisexported
directlyfromtheworkspace.
FRAMEBORDERON
SREEN
125
$!GLOBALLINEPLOT
Example:
Customizetheframeheadertext,andsettheframeheaderheighttobe0.25inches:
$!GLOBALFRAME
FRAMEHEADERFORMAT="Myframe,thecurrentdateis&(Date),&(Time)"
FRAMEHEADERHEIGHT=0.25
$!GLOBALLINEPLOT
Syntax:
$!GLOBALLINEPLOT
Description:ASetValuecommandthatchangesglobalattributesassociatedwithLineplots.Ifyouwouldlike
thesettingsinthesecommandstopersist,addittoyourtecplot.cfgfile,locatedinyourinstallation
directory.
Optional Parameters
yourinstallationdirectory).
Parameter
Syntax
Default
DATALABELS
Notes
Thesearetextvaluesthatcanbeaddedtoaplottoshowthe
indicesorvaluesforthedatapoints.
{
COLOR
=<color>
BLACK
COLORBYZONEMAP
=<boolean>
NO
DISTANCESKIP
<op> <dexp>
=5
INCLUDEBOX
=<boolean>
YES
INDEXSKIP
<op> <integer>
=1
NODELABELTYPE
=<labeltype>
INDEX
NUMFORMAT
<<numberformat
>>
SHOWNODELABELS
=<boolean>
NO
SKIPMODE
=<skipmode>
BYINDEX
TEXTSHAPE
<<textshape>>
SeeNotes
CELLLABELTYPE
=<labeltype>
INDEX
Notallowedtochangesizeunitsparameter.
FONTFAMILY=Helvetica,ISBOLD=NO,ISITALIC=NO,
SIZEUNITS=FRAME,HEIGHT=3
}
LEGEND
AttributesforanoptionallegendaddedtoaLineplot.Entries
inthelegendaredetermineddynamicallybyTecplot360
dependingonwhichmappingsareturnedon.
{
ANCHORALIGNMENT
=
anchoralignmen
t>
TOPRIGHT
BOX
<<textbox>>
SeeNotes
ROWSPACING
<op> <dexp>
=1.2
SHOW
=<boolean>
NO
SHOWTEXT
=<boolean>
YES
TEXTCOLOR
=<color>
<<textshape>>
BLACK
TEXTSHAPE
126
SeeNotes
BOXTYPE=HOLLOW,MARGIN=10,LINETHICKNESS=0.1,
COLOR=BLACK,FILLCOLOR=WHITE
Notallowedtochangesizeunits.
FONTFAMILY=Helvetica,ISBOLD=YES,ISITALIC=NO,
$!GLOBALLINKING
Parameter
Syntax
<<xy>>
XYPOS
Default
Notes
X=95,Y=80
Example:
TurnonthedatalabelsandshowtheLinelegend.UseboldfaceTimesfontinthelegend:
$!GLOBALLINEPLOT
DATALABELS
{
SHOWNODELABELS=YES
}
LEGEND
{
SHOW=YES
TEXTSHAPE
{
FONTFAMILY="Times"
ISBOLD=YES
ISITALIC=NO
}
}
}
$!GLOBALLINKING
Syntax:$!GLOBALLINKGLINKCOLORMAPS=<boolean>
Description:SettoYEStotieallcolormapstogether.Ifyouwouldlikethesettingsinthiscommandtopersist,
addittoyourtecplot.cfgfile,locatedinyourinstallationdirectory.
Required Parameters
Ifyouwouldlikethesettingsinthiscommandtopersist,addthemtoyourtecplot.cfgfile(locatedinyour
Parameter
LINKCOLORMAPS
Syntax
=<boolean>
Default
Notes
YES
$!GLOBALPAPER
Syntax:
$!GLOBALPAPER
Description:ASetValuecommandthatsetsthepapersizecharacteristics.Ifyouwouldlikethesettingsinthis
commandtopersist,addittoyourtecplot.cfgfile,locatedinyourinstallationdirectory.
Optional Parameters
Parameter
Syntax
Default
Notes
PAPERSIZEINFO
{
127
$!GLOBALPOLAR
Parameter
Syntax
Default
Notes
LETTER
<<papersize>>
DOUBLE
<<papersize>>
A3
<<papersize>>
WIDTH=11.693,HEIGHT=16.535,
LEFTHARDCLIPOFFSET=0.125,
RIGHTHARDCLIPOFFSET=0.125,
TOPHARDCLIPOFFSET=0.125,
BOTTOMHARDCLIPOFFSET=0.125
A4
<<papersize>>
WIDTH=8.2677,HEIGHT=11.693,
LEFTHARDCLIPOFFSET=0.125,
CUSTOM1
<<papersize>>
CUSTOM2
<<papersize>>
WIDTH=8.5,HEIGHT=11,LEFTHARDCLIPOFFSET=0.125,
Seealso:Section$!PAGEonpage 158.
$!GLOBALPOLAR
Syntax:
$!GLOBALPOLAR
Description:AllowspolarplotstohavecurvedlinesthatareinterpolatedalongtheRAxisbetweendata
points.
Optional Parameters
Ifyouwouldlikethesettingsinthiscommandtopersist,addthemtoyourtecplot.cfgfile(locatedinyour
Parameter
Syntax
Default
Notes
ANGLE
=<double>
Determinestheangleforwhichlineswillbeapproximatedas
curves.
DRAWSTRAIGHTLINES
=<boolean>
YES
Alternatesbetweenstraightandcurvedinterpolatedlinesfor
polarplots.
Example:
Thisexampleturnsoncurvedlinesanddefinesthemaximumangletobeapproximatedasacurvedlineto
be2.0degrees.
$!GLOBALPOLAR
DRAWSTRAIGHTLINES=NO
ANGLE=2.0
$!GLOBALRGB
Syntax:
$!GLOBALRGB
RGBMode=<rgbmode>
Description:AllowsRGBcoloringforplotswhichhaveRGBvaluesspecifiedateachvertex.Thiscoloring
optionisvaluableforplotswithentitiessuchasGas,OilandWater.RGBColoringcanbeassigned
tofieldplotobjectssuchaszones,isosurfacesandslices
128
$!GLOBALSCATTER
Required Parameter
Parameter
RGBMODE
Syntax
Default
=<specifyrgb>
Notes
SPECIFY
RGB
SetswhethertheuserspecifiesallthreecolorvariablesforRGB
Coloring,orifTecplot360calculatesonevariablewhiletheuser
specifiestwo.
Optional Parameters
Parameter
Syntax
Default
Notes
REDCHANNELVAR
=<integer>
Setsvariablefortheredchannel.
GREENCHANNELVAR
=<integer>
Setsvariableforthegreenchannel.
BLUECHANNELVAR
=<integer>
RANGEMIN
=<double>
0.0
RANGEMAX
=<double>
1.0
TOPCENTER
Setsvariableforthebluechannel.
LEGEND
{
ANCHORALIGNMENT
=anchoralignment>
BLUECHANNELLABEL
=<string>
BOX
<<textbox>>
GREENCHANNELLABEL
=<string>
HEIGHT
=<double>
REDCHANNELLABEL
=<string>
RGBLEGENDORIENTATION
=<rgblegendorientation>
RGB
SHOW
=<boolean>
NO
SHOWLABELS
=<boolean>
YES
TEXTCOLOR
=<color>
BLACK
TEXTSHAPE
<<textshape>>
SeeNotes
USEBLUEVARNAME
=<boolean>
YES
USEGREENVARNAME
=<boolean>
YES
USEREDVARNAME
=<boolean>
YES
XYPOS
<<xy>>
X=80,Y=80
SeeNotes
BOXTYPE=NONE,MARGIN=10,
LINETHICKNESS=0.1,
COLOR=BLACK,
FILLCOLOR=WHITE
10
FONTFAMILY=Helvetica,
ISBOLD=NO,ISITALIC=NO,
SIZEUNITS=FRAME,HEIGHT=2.5
Example:
ThisexampleturnsonRGBColoringanddefinesvariablesfortheRedandGreenChannel,leaving
Tecplot360tocalculatetheBlueChannelvalues.
$!GLOBALRGB
RGBMODE=SPECIFYRG
REDCHANNELVAR=1
GREENCHANNELVAR=4
$!GLOBALSCATTER
Syntax:
$!GLOBALSCATTER
129
$!GLOBALSCATTER
Description:ASetValuecommandthatchangesglobalattributesassociatedwithscatterplots.
Optional Parameters
Parameter
BASEFONTFAMILY
Syntax
=<string>
Default
Notes
Helvetica
DATALABELS
Thesearetextlabelsthatcanbeadded
toaplottoshownodeorcellvalues.
{
CELLLABELTYPE
=<labeltype>
CELLLABELVAR
=<integer>
COLOR
=<color>
BLACK
COLORBYZONEMAP
=<boolean>
NO
DISTANCESKIP
<op> <dexp>
INCLUDEBOX
=<boolean>
YES
INDEXSKIP
<op> <integer>
NODELABELTYPE
=<labeltype>
INDEX
NODELABELVAR
<op> <integer>
NUMFORMAT
<<numberformat>>
SeeNotes
SHOWCELLLABELS
=<boolean>
NO
SHOWNODELABELS
=<boolean>
NO
SKIPMODE
=<skipmode>
<<textshape>>
TEXTSHAPE
INDEX
FONTFAMILY=
ISITALIC=NO,
SIZEUNITS=FRAME,
HEIGHT=3
FORMATTING=BESTFLOAT,
CUSTOMLABEL=1,PRECISION=4,
SHOWDECIMALSONWHOLENUMBE
RS=NO,
REMOVELEADINGZEROS=NO,
SHOWNEGATIVESIGN=YES,
TIMEDATEFORMAT=yyyymmdd
hh:mm:ss.00
parameter
}
ISBOLD
=<boolean>
YES
ISITALIC
=<boolean>
NO
ANCHORALIGNMENT
<<anchorpos>>
TOPRIGHT
BOX
<<textbox>>
SeeNotes
ROWSPACING
<op> <dexp>
=1.2
SHOW
=<boolean>
NO
SHOWTEXT
=<boolean>
YES
TEXTCOLOR
=<color>
BLACK
TEXTSHAPE
<<textshape>>
FONTFAMILY=
Helvetica,ISBOLD=YES,
ISITALIC=NO,
SIZEUNITS=FRAME,
HEIGHT=3
XYPOS
<<xy>>
X=95,Y=80
LEGEND
{
}
REFSCATSYMBOL
{
130
BOXTYPE=HOLLOW,MARGIN=10,
LINETHICKNESS=0.1,
COLOR=BLACK,FILLCOLOR=WHITE
parameter.
$!GLOBALTHREED
Parameter
Syntax
Default
Notes
COLOR
=<color>
RED
FILLCOLOR
=<color>
RED
ISFILLED
=<boolean>
NO
LINETHICKNESS
=0.1
MAGNITUDE
<op> <dexp>
<op> <dexp>
SHOW
=<boolean>
NO
SYMBOLSHAPE
<<symbolshape>>
SeeNotes
XYPOS
<<xy>>
X=80,Y=80
RELATIVESIZE
<op> <dexp>
=0
Scalingfactorforscattersymbolssized
ByVariable.
RELATIVESIZEING
=<boolean>
YES
IfYES,scattersizingByVariableisin
gridunits/magnitudeotherwise
centimeters/magnitude.
=1
ISASCII=NO,GEOMSHAPE=SQUARE
RIDUNITS
SPHERESCATTERRENDER
QUALITY
VAR
HIGH
=
<spherescatterrenderquality>
Configfileandstylesheetonlyoption.
=<integer>
Scattersizingvariable.
Example:
Thisexampledoesthefollowing:
Increasestherelativesizeofscattersymbolsthataresizedbyvariablebytenpercent.
Turnsonthescattersizinglegend.
Turnsonthereferencescattersymbolandmakesitred.
Turnsondatalabelsfornodes.
$!GLOBALSCATTER
RELATIVESIZE*=1.1
LEGEND
{
SHOW=YES
}
REFSCATSYMBOL
{
SHOW=YES
COLOR=RED
}
DATALABELS
{
SHOWNODELABELS=YES
}
$!GLOBALTHREED
Syntax:
$!GLOBALTHREED
Description:ASetValuecommandthatchangesglobalattributesassociatedwith3Dplots.
131
$!GLOBALTHREED
Optional Parameters
Parameter
AXISBOXPADDING
AXISSCALEFACT
Syntax
Default
<op> <dexp>
<<xyz>>
=5
X=1,Y=1,Z=1
Notes
The3DaxismustbeINDEPENDENTforthisoptiontowork
properly.See$!THREEDAXIS.
LIGHTSOURCE
{
BACKGROUNDLIGHT
=<double>
25
INCLUDESPECULAR
=<boolean>
YES
INTENSITY
=<double>
75
SPECULARINTENSIT
Y
=<integer>
40
Range=1100
SPECULARSHININES
S
=<integer>
60
Range=1100
SURFACECOLORCONT
RAST
=<double>
100
XYZDIRECTION
<<xyz>>
X=0.2,Y=0.2,
Z=0.959...
FORCEGOURADFOR3D
CONTFLOOD
=<boolean>
YES
= <boolean>
YES
LINELIFTFRACTION
<op> <dexp>
=0.2
NEARPLANEFRACTION
<dexp>
0.1
PERFORMEXTRA3D
<boolean>
NO
FORCEPANELED
FOR3DCELLFLOOD
Alwaysspecifyallthreecomponentshere.Tecplot360
normalizesX,YandZafterprocessingtheZcomponent.
X,YandZrepresentavectorintheeyecoordinatesystem.
}
Specifythepositionofthenearplane.Ina3Dplot,thenear
planeactsasawindshield:anythinginfrontofthisplanedoes
notdisplay.
SORTING
PLACEMENTPLANE
Specifythecoordinateoftheplacementplane.
POSITION
{
X
=<double>
=<double>
=<double>
}
ROTATEORIGIN
<<xyz>>
X=0.5,Y=0.5,
Z=0.5
ORIGIN
<<xyz>>
X=0,Y=0,Z=0
NORMAL
<<xyz>>
X=0,Y=0,Z=1
<op> <dexp>
=0.6
<op> <dexp>
=0.7
SLICE
{
}
SYMBOLLIFT
FRACTION
VECTORLIFT
FRACTION
132
$!GLOBALTHREEDVECTOR
Example:
$!GLOBALTHREEDROTATEORIGIN{X=4.36052333891}
$!GLOBALTHREED
LIGHTSOURCE
{
XYZDIRECTION
{
X=0.398226616447
Y=0.435028248588
Z=0.807567944438
}
}
$!GLOBALTHREEDLIGHTSOURCE{INTENSITY=80}
$!GLOBALTHREEDLIGHTSOURCE{BACKGROUNDLIGHT=25}
$!GLOBALTHREEDLIGHTSOURCE{SURFACECOLORCONTRAST=85}
$!GLOBALTHREEDLINELIFTFRACTION=7
$!GLOBALTHREEDSYMBOLLIFTFRACTION=0.5
$!GLOBALTHREEDVECTORLIFTFRACTION=6
$!GLOBALTHREEDPERFORMEXTRA3DSORTING=YES
Syntax:
Description:ASetValuecommandthatchangesglobalattributesassociatedwith3Dvectorplots.
Optional Parameters
yourininstallationdirectory).
Parameter
ARROWHEADANGLE
HEADSIZEASFRACTIO
N
HEADSIZEINFRAMEUN
ITS
Syntax
Default
Notes
<op> <dexp>
<op> <dexp>
=18
Angleisindegrees.
=0.2
Headissizedasafractionofthestemlength.
<op> <dexp>
=2
REFVECTOR
{
SHOW
=<boolean>
NO
COLOR
=<color>
BLACK
MAGNITUDE
=1
ANGLE
<op> <dexp>
<op> <dexp>
<op> <dexp>
XYPOS
<<xy>>
X=80,Y=80
SHOW
=<boolean>
NO
TEXTCOLOR
=<color>
<<textshape>>
BLACK
LINETHICKNESS
=0.1
=0
MAGNITUDELABEL
{
TEXTSHAPE
FONTFAMILY=
Helvetica,
ISBOLD=YES,
ISITALIC=NO,
SIZEUNITS=FR
AME,
HEIGHT=3
133
$!GLOBALTIME
Parameter
Syntax
Default
Notes
NUMFORMAT
<<numberformat>
>
OFFSET
=<double>
RELATIVELENGTH
<op><dexp>
=0
RELATIVELENGTHIN
=<boolean>
YES
IfYESandUSERELATIVEisYESthenvectorsaresizedinGrid
Units/Magnitude.IfNOandUSERELATIVEisYESthen
vectorsaresizedincm/magnitude.
=<boolean>
YES
IfYES,HEADSIZEASFRACTIONisusedtosizearrowheads
otherwiseHEADSIZEINFRAMEUNITSisused.
UNIFORMLENGTH
<op> <dexp>
=2
USERELATIVE
=<boolean>
YES
UVAR
=<integer>
VariablenumberfortheXvectorcomponent.
VVAR
=<integer>
VariablenumberfortheYvectorcomponent.
WVAR
=<integer>
VariablenumberfortheZvectorcomponent.
}
}
GRIDUNITS
SIZEHEADBY
FRACTION
IfNO,vectorsareallthesamesize(UNIFORMLENGTH).
Example:
Makesallvectorsbeuniforminsize;5percentinYframeunits.
Makesthearrowheads0.2timesthesizeofthestems.
Turnsoffthereferencevector.
USERELATIVE=NO
UNIFORMLENGTH=5
HEADSIZEASFRACTION=.2
REFVECTOR
{
SHOW=NO
}
$!GLOBALTIME
Syntax: $!GLOBALTIMESolutionTime
Description:ASetValuecommandforframes(2Dand3DONLY).Differentframescanhavedifferentvalues
of$!GLOBALTIME.Ifyouwouldlikethesettingsinthiscommandtopersist,addthemtoyour
tecplot.cfgfile(locatedinyourinstallationdirectory).
Parameter
SOLUTIONTIME
Syntax
=<double>
Default
0
Notes
IfSolutionTimeisnotsettoasolutiontimeinsetofsolution
timesfromallzonesoftheactivestrandfieldmaps,
SolutionTimeisadjustedtotheclosestvalueinthatset.
$!GLOBALTWODVECTOR
Syntax:
$!GLOBALTWODVECTOR
Description:ASetValuecommandthatchangesglobalattributesassociatedwith2Dvectorplots.
134
$!GLOBALTWODVECTOR
Optional Parameters
Parameter
ARROWHEADANGLE
HEADSIZEAS
Syntax
Default
Notes
<op> <dexp>
<op> <dexp>
=18
Angleisindegrees.
=0.2
Headissizedasafractionofthestemlength.
<op> <dexp>
=2
FRACTION
HEADSIZEINFRAME
UNITS
REFVECTOR
{
SHOW
=<boolean>
NO
COLOR
=<color>
BLACK
MAGNITUDE
=1
ANGLE
<op> <dexp>
<op> <dexp>
<op> <dexp>
XYPOS
<<xy>>
X=80,Y=80
SHOW
=<boolean>
NO
TEXTCOLOR
=<color>
<<textshape>>
BLACK
LINETHICKNESS
=0.1
=0
MAGNITUDELABEL
{
TEXTSHAPE
SeeNotes
FONTFAMILY=Helvetica,ISBOLD=YES,ISITALIC=NO,
NUMFORMAT
<<numberformat>
>
OFFSET
=<double>
RELATIVELENGTH
<op> <dexp>
=0
RELATIVELENGTH
=<boolean>
YES
IfYESandUSERELATIVEisYESthenvectorsaresizedinGrid
Units/Magnitude.IfNOandUSERELATIVEisYESthen
vectorsaresizedincm/magnitude.
=<boolean>
YES
IfYES,HEADSIZEASFRACTIONisusedtosizearrowheads
otherwiseHEADSIZEINFRAMEUNITSisused.
<op> <dexp>
=2
YES
}
}
INGRIDUNITS
SIZEHEADBY
FRACTION
UNIFORMLENGTH
USERELATIVE
=<boolean>
UVAR
=<integer>
VariablenumberfortheXvectorcomponent.
VVAR
=<integer>
VariablenumberfortheYvectorcomponent.
IfNO,vectorsareallthesamesize(UNIFORMLENGTH).
Example:
Doublesthevectorlength(assumevectorscurrentlydrawnusingrelativelength).
Makethevectorheadsuniforminsize;2percentinframeunits.
Maketheheadangle15degrees.
$!GLOBALTWODVECTOR
RELATIVELENGTH*=2
SIZEHEADBYFRACTION=NO
HEADSIZEINFRAMEUNITS=2
HEADANGLE=15
135
$!IF...$!ENDIF
I
$!IF...$!ENDIF
Syntax:
$!IF<conditionalexp>
$!ENDIF
Description:Conditionallyprocessmacrocommands.
Examples:
Example 1:
Processmacrocommandsifthemacrovariable|myvar|islessthan73.2:
$!IF|myvar|<73.2
$!ENDIF
Example 2:
Processmacrocommandsifthemacrovariable|response|isYES:
$!IF"|response|"=="YES"
.
.
.
$!ENDIF
$!INCLUDEMACRO
Syntax: $!INCLUDEMACRO<string>
Description:Insertthecommandsfromanothermacrofile.Becausethe$!INCLUDEMACROcommandis
processedwhenthemacroisloadedandnotwhenthemacroisexecuted,youarenotallowedto
referencemacrovariableswithinthe<string>parameter.
Example: Includethemacrofilem2.mcr:
$!INCLUDEMACRO"m2.mcr"
$!INTERFACE
Syntax:
$!INTERFACE
Description:ASetValuecommandthatsetsattributesrelatedtotheTecplot360interface.
136
$!INTERFACE
Optional Parameters
Parameter
Syntax
Default
Notes
ALLOWDATAPOINTSELECT
=<boolean>
YES
ALLOWDATAPOINTADJUST
=<boolean>
YES
ALWAYSPOPACTIVEFRAME
=<boolean>
NO
IfYES,whenevertheactiveframe
changesintheinterface,Tecplot360
movestheactiveframetothetopof
thedraworder.ThismakesTecplot
360runlikev.11.3andearlier
versions,andmayhelpolderaddon
andmacrostoruncorrectly.Default
isNO.
AUTOREDRAWISACTIVE
=<boolean>
YES
SettoNOtoturnAutoRedrawoff.
BACKINGSTOREMODE
=<backingstoremode>
REALTIMEUPDATE
BEEPONFRAMEINTERRUPT
=<boolean>
NO
CACHELIGHTDISPLAY
=<boolean>
NO
LISTSONLY
CONSERVEDERIVED
IfYES,Tecplot360allowsyoutouse
theAdjustortooltoselectandmove
datapoints.
Whencachinggraphicsindisplay
lists,onlycachethoseobjectswhich
uselittlememory.Whenthisison,
onlyapproximatedplotsaresaved.
Fullplotsarenotsaved.Thisonly
hasaneffectifUSEDISPLAYLISTSis
settoYES,andif
USEAPPROXIMATEPLOTSisYES.
=<boolean>
VARIABLESPACE
COLLECTTIME
=<boolean>
NO
SMOOTHBNDRYCOND
=<boundarycondition>
FIXED
NUMSMOOTHPASSES
=1
LINEARINTERPCONST
<op><integer>
<op><dexp>
<op><dexp>
<op><dexp>
<op><dexp>
LINEARINTERPMODE
=<linearinterpmode>
SETTOCONST
INTERPPTSELECTION
=<pointselection>
OCTANTNPOINTS
INTERPNPOINTS
=8
KRIGZEROVALUE
<op><integer>
<op><dexp>
<op><dexp>
KRIGDRIFT
=<krigdrift>
LINEAR
DERIVATIVEBOUNDARY
=<derivpos>
SIMPLE
TRIANGLEKEEPFACTOR
<op><dexp>
=0.25
VARIABLEDERIVATIONME
THOD
=[ACCURATEorFAST]
FAST
VOLUMECELLINTERPOLAT
IONMODE
=[TRILINEARor
PIECEWISELINEAR]
PIECEWISELINEAR
EXTRACTSLICEFROMPLAN
ECOPYCELLCENTERS
=<boolean>
NO
STATISTICS
DATA
{
SMOOTHWEIGHT
INVDISTEXPONENT
INVDISTMINRADIUS
KRIGRANGE
=0.5
=3.5
=0
=0
=0.3
=0
Bydefault,volumeinterpolationis
piecewiselinearandcalculatesfor
firstorderaccuracy.Thistrilinear
interpolationoptioncalculatesfor
secondorderaccuracy.
137
$!INTERFACE
Parameter
Syntax
Default
CONTLINECREATEMODE
=
[ONEZONEPERCONTOU
RLEVEL,
ONEZONEPERINDEPEN
DENTPOLYLINE]
ONEZONEPERCONTOU
RLEVEL
POLYCELLINTERPOLATIO
NMODE
=[USECCVALUE,
AVERAGENODES]
AVERAGENODES
Notes
Thisparameteronlyappearsinthe
tecplotconfigfile.Whenusing
contourflooding,contourlines,or
precisevalueblankingforpolyhedral
andpolygonaldata,itchooses
betweenusingthecellcenteredvalue
orusingtheaverageofthenodes.
Thisparameteralsoappliestothe
creationofisosurfacesforcell
centeredvaluesinapolyhedralzone.
ItdoesnotapplytoPrimaryValue
contourflooding.
}
DIALOGPLACEMENT
{
ADVANCED3DCONTROLDIA
LOG
<<dialogplacement>>
AXISEDITDIALOG
<<dialogplacement>>
COLORMAPDIALOG
<<dialogplacement>>
CONTOURDIALOG
<<dialogplacement>>
CREATE1DLINEDIALOG
<<dialogplacement>>
CREATECIRCULARZONEDI
ALOG
<<dialogplacement>>
CREATERECTANGULARZON
EDIALOG
<<dialogplacement>>
CREATEZONEFROM
POLYLINESDIALOG
<<dialogplacement>>
CREATEZONEFROMVALUES
DIALOG
<<dialogplacement>>
CURVEINFODIALOG
<<dialogplacement>>
DATAINFODIALOG
<<dialogplacement>>
DATALABELSDIALOG
<<dialogplacement>>
DATASPREADSHEETDIALO
G
<<dialogplacement>>
DELETEVARIABLESDIALO
G
<<dialogplacement>>
DELETEZONESDIALOG
<<dialogplacement>>
DEPTHBLANKINGDIALOG
<<dialogplacement>>
DUPLICATEZONEDIALOG
<<dialogplacement>>
EQUATIONDIALOG
<<dialogplacement>>
EXPORTDIALOG
<<dialogplacement>>
EXTRACTCONTOURLINESD
IALOG
<<dialogplacement>>
EXTRACTDISCRETEPOINT
SDIALOG
<<dialogplacement>>
EXTRACTFEBOUNDARYDIA
LOG
<<dialogplacement>>
EXTRACTISOSURFACESDI
ALOG
<<dialogplacement>>
EXTRACTPOINTSFROMGEO
METRYDIALOG
<<dialogplacement>>
138
TheDIALOGPLACMENTparameter
mayonlyappearinthetecplotconfig
file.Youmayspecifytheplacement
oftheindicateddialogs.Dialog
placementisrelativetothemain
Tecplot360window.
$!INTERFACE
Parameter
Syntax
EXTRACTPOINTSFROMPOL
YLINEDIALOG
<<dialogplacement>>
EXTRACTSLICEFROMPLAN
EDIALOG
<<dialogplacement>>
EXTRACTSLICESDIALOG
<<dialogplacement>>
EXTRACTSTREAMTRACESD
IALOG
<<dialogplacement>>
EXTRACTSUBZONEDIALOG
<<dialogplacement>>
IJKBLANKINGDIALOG
<<dialogplacement>>
IMPORTDIALOG
<<dialogplacement>>
INVERSEDISTANCEINTER
POLATIONDIALOG
<<dialogplacement>>
IOFFSET
<<dialogplacement>>
JOFFSET
<<dialogplacement>>
ISOSURFACESDIALOG
<<dialogplacement>>
KRIGINGINTERPOLATION
DIALOG
<<dialogplacement>>
LIGHTSOURCEDIALOG
<<dialogplacement>>
LINEARINTERPOLATIOND
IALOG
<<dialogplacement>>
LINEMAPLEGENDDIALOG
<<dialogplacement>>
LOADDATADIALOG
<<dialogplacement>>
MACROPLAYDIALOG
<<dialogplacement>>
MACRORECORDDIALOG
<<dialogplacement>>
MACROVIEWERDIALOG
<<dialogplacement>>
MIRRORZONEDIALOG
<<dialogplacement>>
NEWLAYOUTDIALOG
<<dialogplacement>>
OPENLAYOUTDIALOG
<<dialogplacement>>
ORDERFRAMESDIALOG
<<dialogplacement>>
PAPERSETUPDIALOG
<<dialogplacement>>
POLARDRAWINGOPTIONSD
IALOG
<<dialogplacement>>
PRINTDIALOG
<<dialogplacement>>
RULERGRIDDIALOG
<<dialogplacement>>
SAVEASDIALOG
<<dialogplacement>>
SAVEDIALOG
<<dialogplacement>>
SCATTERLEGENDDIALOG
<<dialogplacement>>
SCATTERREFERENCESYMB
OLDIALOG
<<dialogplacement>>
SCATTERSIZEANDFONTDI
ALOG
<<dialogplacement>>
SLICESDIALOG
<<dialogplacement>>
SMOOTHDIALOG
<<dialogplacement>>
SPATIALVARSDIALOG
<<dialogplacement>>
STREAMTRACESDIALOG
<<dialogplacement>>
STYLELINKINGDIALOG
<<dialogplacement>>
THREEDAXISLIMITSDIAL
OG
<<dialogplacement>>
THREEDORIENTATIONAXI
SDIALOG
<<dialogplacement>>
THREEDVIEWDETAILSDIA
LOG
<<dialogplacement>>
THREEDVIEWROTATEDIAL
OG
<<dialogplacement>>
Default
Notes
139
$!INTERFACE
Parameter
Syntax
TRANSFORMCOORDINATES
DIALOG
<<dialogplacement>>
TRANSLATEMAGNIFYDIAL
OG
<<dialogplacement>>
TRIANGULATEDIALOG
<<dialogplacement>>
TWODDRAWORDERDIALOG
<<dialogplacement>>
VALUEBLANKINGDIALOG
<<dialogplacement>>
VECTORARROWHEADSDIAL
OG
<<dialogplacement>>
VECTORLENGTHDIALOG
<<dialogplacement>>
VECTORREFERENCEVECTO
RDIALOG
<<dialogplacement>>
VECTORVARSDIALOG
<<dialogplacement>>
WRITEDATADIALOG
<<dialogplacement>>
ZONEMAPSTYLEDIALOG
<<dialogplacement>>
Default
Notes
}
ENABLEDELAYS
=<boolean>
YES
Enableordisabledelaysinmacro
commands.
ENABLEINTERRUPTS
=<boolean>
YES
Enableordisableuserinterrupts.
ENABLEPAUSES
=<boolean>
YES
Enableordisablepause.
ENABLEWARNINGS
=<boolean>
YES
GLOBALPLACEMENTPLANE
Enableordisablewarningdialogs.
Useaplacementplane.
{
SHOW
Turntheplacementplaneon/off.
PLACEMENTPLANEORIENT
ATION
Specifytheaxisorientationofthe
placementplane.
FONTPATH
<string>
IDOTSPERSQUAREINCH
=<double>
INTIALFIELDPROBE
=[NODALVALUES,
ZONECELLINFO,
CELLCENTEREDVALUES,
orFACENEIGHBORS]
NODALVALUES
INITIALPLOTFIRSTZONEO
NLY
=<boolean>
NO
INITIALPLOTTYPE
=<plottype>
AUTOMATIC
INTERRUPTCHECKING
=<integer>
Setthenumberofmilliseconds
betweenchecksforakeyorbutton
pressbytheusertointerrupt
processinginTecplot360.
JDOTSPERSQUAREINCH
=<double>
Thisalongwith
IDOTSPERSQUAREINCHsetthe
sizeandaspectofthescreen.Ifleft
unspecified,Tecplot360will
determinethevalueforyou.
LISTCOMMANDSINMACRO
=<boolean>
IfNO,macrocommandsare
displayedinfulloneatatime.
DIALOGPAGE
Theoperatingsystems
fontfolder(s)
Thisalongwith
JDOTSPERSQUAREINCHsetthe
sizeandaspectofthescreen.Ifleft
unspecified,Tecplot360will
determinethevalueforyou.
FREQUENCY
VIEWER
LOADADDONSUSING
LAZYRELOCATE
140
=<boolean>
Oneormoredirectorieswhere
TrueTypefontscanbefound,e.g.
PATH1PATH2PATH3.Note
useofdoublequotesaroundeach
pathandsinglequotesaroundthe
eniterstring.
YES
IfYES,onlythefirstenabledzoneis
activated.Defaultshowsallzones
(exceptfromwithinalayout).
IfsettoNO,alladdonsymbolsare
loadedimmediately.
$!INTERFACE
Parameter
MAXCUSTOMCOLORSIN
Syntax
Default
=<integer>
56
MAXNUMUNDOLEVELS
=<integer>
50
MINPIXELSFORDRAG
=<integer>
BUTTONCLICK
=<mousebuttonclick>
REDRAW
SIMPLEDRAG
=<mousebuttondrag>
ZOOMDATA
CONTROLLEDDRAG
=<mousebuttondrag>
ZOOMDATA
ALTEDDRAG
=<mousebuttondrag>
ZOOMVIEWER
SHIFTEDDRAG
=<mousebuttondrag>
ZOOMPAPER
CONTROLALTEDDRAG
=<mousebuttondrag>
ZOOMVIEWER
CONTROLSHIFTEDDRAG
=<mousebuttondrag>
ZOOMPAPER
ALTSHIFTEDDRAG
=<mousebuttondrag>
ZOOMVIEWER
CONTROLALTSHIFTEDDRA
G
=<mousebuttondrag>
ZOOMPAPER
BUTTONCLICK
=<mousebuttonclick>
REVERTTOSELECT
SIMPLEDRAG
=<mousebuttondrag>
TRANSLATEDATA
CONTROLLEDDRAG
=<mousebuttondrag>
ROLLERBALL
ROTATEDATA
ALTEDDRAG
=<mousebuttondrag>
TRANSLATE
VIEWER
SHIFTEDDRAG
=<mousebuttondrag>
TRANSLATEPAPER
CONTROLALTEDDRAG
=<mousebuttondrag>
ZOOMVIEWER
CONTROLSHIFTEDDRAG
=<mousebuttondrag>
ROLLERBALL
ROTATEDATA
ALTSHIFTEDDRAG
=<mousebuttondrag>
TRANSLATEPAPER
CONTROLALTSHIFTEDDRA
G
=<mousebuttondrag>
ZOOMVIEWER
=<integer>
10
INTERFACE
Notes
UNIXonly.Validvaluesare1to56.
SomeUNIXdisplayscannotallocate
enoughcolorsfortheTecplot360
interface.Usethisoptiontolimitthe
numberofcustomcolorsdisplayed
intheTecplot360interface.
Numberofpixelstomovethe
pointerbeforeitisconsideredadrag.
MOUSEACTIONS
{
MIDDLEBUTTON
{
}
RIGHTBUTTON
{
}
}
NUMCOLORCELL
STORETURN
NUMMOUSEBUTTONS
=<integer>
NUMPTSALLOWEDBEFORE
=<integer>
APPROX
ThisoptionisonlyforUNIXusers
whoareusing
MIDDLEMOUSEBUTTONMODEor
RIGHTMOUSEBUTTONMODE.
500,000
Whenaframesactivezonescontain
thismanypointsorless,theframeis
notapproximated,butalwaysdrawn
infull.Thisappliestoallframes
when
PLOTAPPROXIMATIONMODEis
AUTOMATIC,andtotheactive
frameonlywhen
NONCURRENTALWAYSAPPROX.
Thissettinghasnoeffectwhen
setto
ALLFRAMESALWAYSAPPROX.
141
$!INTERFACE
Parameter
OKTOEXECUTESYSTEM
Syntax
Default
Notes
=<boolean>
YES
Allowuseof$!SYSTEMcommands
inmacros.Thisisasecurityissue.If
settoNOandthemacroisrun
intermittentlyyouwillbeaskedfor
permissiontoexecutethe$!SYSTEM
command.IfTecplot360isrunin
batchmodeandthisisNOanerror
willbegeneratedandthemacrowill
terminate.
RUNDISPLAYLISTSAFTER
BUILDING
=<boolean>
YES
Tecplot360defaultstobuildingand
runningdisplaylistssimultaneously.
TurnRunDisplayListsAfterBuilding
onifyouwanttorunthedisplaylists
aftertheyarebuilt.Thismayincrease
displaylistperformanceonsome
machines.Thedifferenceisoften
timesnegligible.
ALLOWHWACCELERATION
=<boolean>
YES
Windowsonly.Thiswilldisable
hardwareaccelerationforTecplot360
withouthavingtochangethe
WindowsDisplayProperties.
Setting
ALLOWHWACCELERATIONtoNO
mayfixerrorscausedbyhardware
accelerationonbuggygraphicscard
drivers.
SCREENRENDERING
<<renderconfig>>
Setsoptionsforscreenrendering.
IMAGERENDERING
<<renderconfig>>
Setsoptionsforoffscreenrendering
(forimageexportsorrasterprinting).
MAXFILTERMAGNIFICATI
ON
=<integer>
INCLUDEBACKBUFFERDUR
INGFRONTBUFFERDRAWS
=<boolean>
NO
=<integer>
10
PICKHANDLEWIDTH
<op><dexp>
=0.1
Valueisininchesonthescreen.
PLOTAPPROXIMATION
=
<plotapproximationmode>
AUTOMATIC
Specifiesthemodeinwhichyou
PRINTDEBUG
=<boolean>
NO
IfYES,debugginginformationissent
tothestandardoutput.
QUICKCOLORMODE
=<quickcolormode>
LINECOLOR
Chooseobjectsforcolorchanges
madeusingtheQuickEditdialog
COMMAND
OPENGLCONFIG
{
Setsthemaximummagnificationby
nontextureresizefilterbefore
texturesareused.ThiskeepsTecplot
360fromcreatingtextureswhichare
toolarge.Settingthisabovethreeis
notrecommended.Settingbelow1.0
willresultintheuseofafaster
texturealgorithm.
}
PERCENTAGEOFPOINTS
TOKEEP
MODE
wanttheplotstobeapproximated.
SeeSectionPlotApproximationin
theUsersManualforacomplete
descriptionofeachmode.
ROTATION
Settingsforinteractiverotationsin
3D.
{
ROTATIONMODE
=<rotationmode>
XYAXIS
CURRENTANGLE
<op><dexp>
=5
SMALLANGLE
<op><dexp>
=1
MEDIUMANGLE
<op><dexp>
<op><dexp>
=5
LARGEANGLE
142
Setsthepercentageofpointstokeep
inaframewhenaframeis
approximated.SeealsoSectionBest
PracticesForRendering
PerformanceintheUsersManual.
=15
$!INTERFACE
Parameter
Syntax
ROTATEDEGPERFRAMEUNI
T
=<integer>
SHOWGEOMS
=<boolean>
Default
Notes
YES
}
ROTATEDEGPERFRAME
=<integer>
UNIT
RULERPADDING
<op><dexp>
=0.05
Distancebetweenworkarearulerand
clippingedgeforthepaperand
frames.Unitsareinches.
RULERTHICKNESS
<op><dexp>
=0.15
Valueisininchesonthescreen.
SCALE
Settingsforinteractivescaling.
{
STEPSIZE
SMALLSTEP
MEDIUMSTEP
LARGESTEP
ZOOMSCALEPERFRAMEUNI
T
<op><dexp>
<op><dexp>
<op><dexp>
<op><dexp>
<op><double>
=10
=1
=10
=20
=4
}
SCRBACKGROUNDCOLOR
=<color>
SECURESPOOLCOMMANDS
=<boolean>
YES
SHOWCONTINUOUSSTATUS
=<boolean>
YES
SHOWCOORDINATES
=<boolean>
YES
SHOWCOORDINATESWITH
=<boolean>
NO
Settheworkspacebackgroundcolor.
SELECTORADJUSTOR
SettoNOtoallow$!SPOOLER
commandsoutsidetheconfiguration
file.
WhenYES,runningcoordinatesfor
bothX&Yaredisplayedingrid
coordinatesinthestatuslineforall
plottypesexcept3D.If
$!INTERFACE
SHOWCOORDINATESisoff,the
valueof
SHOWCOORDINATESWITHSELEC
TORADJUSTORisignored.
Thiscommandisavailableviathe
configfile(tecplot.cfg)only.
SHOWFRAMEBORDERS
=<boolean>
NO
SHOWSTATUSLINE
=<boolean>
YES
SHOWTEXTGEOMSIN
=<boolean>
YES
SHOWTOOLTIPS
=<boolean>
YES
SHOWWAITDIALOGS
=<boolean>
YES
SIDEBARSIZING
=<sidebarsizing>
MAXOFALL
WHENOFF
APPROXVIEWS
TRANSLATION
IfYES,framebordersaredrawn
usingadashedlinewhentheyare
turnedoff.Thisappliesonlytothe
screenanddoesnoteffectthe
hardcopy.
SettoYESifyouwanttextand
geometriestoshowupinframes
usingapproximatedplots
IfNO,allPleaseWaitandPercent
Donedialogswillbedisabled.
Settingsforinteractivetranslation.
{
STEPSIZE
<op><dexp>
=10
SMALLSTEP
<op><dexp>
=5
MEDIUMSTEP
<op><dexp>
=10
LARGESTEP
<op><dexp>
=20
ZOOMSCALEPERFRAMEUNI
T
=<double>
143
$!INTERFACE
Parameter
TRUETYPEMINOUTLINE
Syntax
Default
Notes
=<integer>
POINTSIZE
USEMOD2MASKFORALT
=<boolean>
NO
Certainplatformshaveaproblem
withtheALTkey.SettoYESto
bypasstheproblem.
UNIXHELPBROWSERCMD
=<string>
$TECHOME/bin/
LaunchBrowser/
Setsthecommandusedtolauncha
browserforaddonsthatuseHTML
fortheirhelpfile(UNIXonly;the
Windowsoperatingsystem
automaticallyconnectstoprimary
browser).Forsecurityreasonsthis
commandcanonlybeusedinthe
TRYTOUSEDOUBLEBUFFER
=<boolean>
YES
USEINITIALPLOTDIALOG
=<boolean>
YES
UNIXTRUETYPEFONTPATH
=<string>
USEAPPROXIMATEPLOTS
=<boolean>
NO
YES
DETECTION
USEDISPLAYLISTS
=<boolean>
USEDOUBLEBUFFERING
=<boolean>
USEDOUBLEFORDISPLAY
=<boolean>
PathtowhereTrueTypefontsare
stored.
Set to YES to use approximate plots. See
Section Plot Approximationinthe
UsersManual for further details.
YES
LISTS
USEFASTAPPROX
=<boolean>
CONTINUOUSFLOOD
USEDISPLAYLISTS
=<boolean>
USEOFFSCREENBITMAP
=<boolean>
YES
USEOPENGL
=<boolean>
YES
USESTROKEFONTSFOR3D
=<boolean>
YES
Usestrokefontsfordatalabelsand
ASCIIscattersymbolsin3Dplots.
TEXT
USESTROKEFONTSFOR
=<boolean>
NO
=<boolean>
NO
XORCOLOR
<op><integer>
=0
XPGONFILLOFFSET
=<integer>
YPGONFILLOFFSET
=<integer>
ZONEMAPNAMECOLUMN
=<double>
SCREEN
USETECPLOTPRINT
SettoYEStouseTecplot360s
internalstrokefonts,settoNOtouse
TrueTypefonts.Thisoptionisonly
availableonWindowsplatforms.
WhenusingTrueTypefonts,switch
tostrokefontsforsmallcharacters.
=<boolean>
SMALLSCREENTEXT
USESTROKEFONTSON
SettoYEStorenderimagesoff
screen.
SettoYEStouseTecplot360sprinter
drivers.SettoNOtouseyourdefault
printerdriver.
DRIVERS
WIDTH
ColorindextouseforXORedlines.
Setto0tomakeTecplot360calculate.
Rangeis101000.Setsthewidthof
theZone/MapNamecolumnunder
PlotAttributes.
Example:
Makestheframebordersshowonthescreenwhentheyareturnedoff.
MakesthemiddlemousebuttonbeRedraw.
MakestherightmousebuttonreverttoSelector.
Makesthedefaultnumberofpassesforsmoothing20.
144
$!INVERSEDISTINTERPOLATE
Turnsoffthestatusline.
$!INTERFACE
SHOWFRAMEBORDERSWHENOFF=YES
MOUSEACTIONS
{
MIDDLEBUTTON
{
BUTTONCLICK=REDRAW
}
RIGHTBUTTON
{
BUTTONCLICK=REVERTTOSELECT
}
}
DATA
{
NUMSMOOTHPASSES=20
}
SHOWSTATUSLINE=NO
Syntax:
DESTINATIONZONE=<integer>
Description:Interpolateselectedvariablesfromoneormorezonesontoadestinationzoneusingtheinverse
distancemethod.
Required Parameter
Parameters
DESTINATIONZONE
Syntax
Default
Notes
=<integer>
Zonetowhichtointerpolate.
Optional Parameters
Parameters
Syntax
Default
INTERPNPOINTS
=<integer>
INTERPPTSELECTION
=<interpptselection>
OCTANTNPOINTS
INVDISTEXPONENT
=<dexp>
3.5
INVDISTMINRADIUS
=<dexp>
0.0
SOURCEZONES
=<set>
Allzonesexcept
destinationzone.
VARLIST
=<set>
Allvariablesexceptspatial
variables.
Notes
Choosethevariablestointerpolate.
Thespatialvariables(X,YandZif
3D)arenotallowed.
Example: Interpolatevariables710fromzone4tozone2:
SOURCEZONES=[4]
DESTINATIONZONE=2
VARLIST=[710]
145
$!ISOSURFACEATTRIBUTES
Syntax:
$!ISOSURFACEATTRIBUTES[<group>]
Description:ASetValuecommandwhichchangesattributesassociatedwithisosurfaces.Theoptionalgroup
parametercanrangefrom18anddefaultsto1whenabsent.
146
Optional Parameters
Parameter
Syntax
Default
SHOWGROUP
=<boolean>
YES
ISOSURFACESELECTION
=<isosurfacesselection>
ONESPECIFIC
VALUE
ISOVALUE1
=<double>
1x10150
ISOVALUE2
=<double>
1x10150
ISOVALUE3
=<double>
1x10150
Notes
MESH
{
LINEPATTERN
=<linepattern>
SOLID
PATTERNLENGTH
=<dexp>
SHOW
=<boolean>
NO
COLOR
=<color>
LINETHICKNESS
=<double>
0.1
MESHTYPE
=<meshtype>
OVERLAY
PATTERNLENGTH
=<dexp>
SHOW
=<boolean>
YES
USELIGHTINGEFFECT
=<boolean>
YES
CONTOURTYPE
=<contourtype>
FLOOD
FLOODCOLORING
=<contourcoloring>
GROUP1
LINECONTOURGROUP
=<integer>
COLOR
=<color>
LINETHICKNESS
=<double>
0.1
LINEPATTERN
=<linepattern>
SOLID
USEVALUEBLANKING
=<boolean>
YES
LIGHTINGEFFECT
=<lightingeffect>
GOURAUD
SURFACETRANSLUCENCY
=<translucency>
50
USETRANSLUCENCY
=<boolean>
NO
USECLIPPLANES
=<set>
[16]
=<integer>
=[classicorclassicplus]
CLASSICPLUS
=<boolean>
NO
=<boolean>
YES
}
CONTOUR
{
PRIMARYVALUEand
AVERAGECELLnotallowed.
}
EFFECTS
{
}
DEFINITIONCONTOUR
GROUP
MARCHINGCUBE
Contourgroupfromwhichiso
surfacesarebased.
ALGORITHM
OBEYSOURCEZONE
BLANKING
OBEYCLIPPLANES
Cliptheisosurfacebyanyclipping
planesthatintersecttheisosurface.
SHADE
{
COLOR
=<color>
SHOW
=<boolean>
NO
USELIGHTINGEFFECT
=<boolean>
YES
147
$!ISOSURFACELAYERS
Example:
$!ISOSURFACEATTRIBUTE
ISOSURFACESELECTION=ONESPECIFICVALUE
ISOVALUE1=113.626812744
MESH{SHOW=YES}
MESH{COLOR=BLUE}
MESH{LINETHICKNESS=0.4}
CONTOUR{SHOW=YES}
SURFACEEFFECTS{LIGHTINGEFFECT=PANELED}
SURFACEEFFECTS{SURFACETRANSLUCENCY=60}
$!ISOSURFACELAYERS
Syntax: $!ISOSURFACELAYERSSHOW=<boolean>
Description:Turnisosurfacesonoroff.
Required Parameters
Parameter
Syntax
Default
SHOW
=<boolean>
NO
SHOWMESH
=<boolean>
YES
SHOWCONTOUR
=<boolean>
YES
SHOWSHADE
=<boolean>
YES
USETRANSLUCENCY
=<boolean>
YES
USELIGHTINGEFFECT
=<boolean>
YES
Notes
Note
Whenisosurfacesareactivated,theyarecoloredusingthecontourvariablebydefault.Whenyouactivate
isosurfacesviathemacrolanguageyoumustperformoneofthefollowingstepsinorderfortheiso
surfacestobevisibleinyourfinalplot:
Setthecontourvariablebyaddingthefollowingcommandtoyourmacrofile(priortocalling
$!ISOSURFACELAYERS).
$!GLOBALCONTOURnVAR=m
wherenisthecontourgroupnumberandmisthenumberofthevariabletousefor
contouring.
or
SetCONTOURSHOW=NOviathe$!ISOSURFACEATTRIBUTEScommand.Ifyouchoose
thisoption,youmaywanttoturnonshadingtoimprovethevisibilityofyourslice.
K-O
$!KRIG
Syntax:
$!KRIG
Description:Interpolateselectedvariablesfromasetofsourcezonestoadestinationzoneusingthekriging
148
$!LAUNCHDIALOG
method.
Required Parameter
Parameters
Syntax
DESTINATIONZONE
Default
Notes
=<integer>
Zonetointerpolateto.
Optional Parameters
Parameters
Syntax
Default
INTERPNPOINTS
=<integer>
INTERPPTSELECTION
=<interpptselection>
OCTANTNPOINTS
KRIGDRIFT
=<krigdrift>
LINEAR
KRIGRANGE
=<dexp>
0.3
KRIGZEROVALUE
=<dexp>
0.0
SOURCEZONES
=<set>
Allzonesexceptthe
destinationzone.
VARLIST
=<set>
Allvariablesexceptspatial
variables.
Notes
Choosethevariablestointerpolate.
Thespatialvariables(X,YandZif
3D)arenotallowed.
Example: Krigfromzones3and4ontozone2.Onlyinterpolatevariable7:
$!KRIG
SOURCEZONES =[3,4]
DESTINATIONZONE=2
VARLIST
=[7]
$!LAUNCHDIALOG
Syntax:
$!LAUNCHDIALOG<dialogname>
[noparameters]
Description:LaunchaTecplot360interfacedialog;ThiscommandismainlyusefulfortheTecplot360demo.
Example: LaunchTecplot360sMacroViewerdialog:
$!LAUNCHDIALOGMACROVIEWER
$!LIMITS
Syntax:
$!LIMITS
Description:ASetValuecommandthatsetssomeoftheinternallimitsinTecplot360.SeeChapterF:Limits
ofTecplot360intheUsersManualforadditionalinformation.The$!LIMITScommandcanonly
beusedintheTecplot360configurationfile.
149
$!LINEARINTERPOLATE
Optional Parameters
Parameter
Syntax
LODTHRESHOLDMIN
Default
<op><double>
=0.3
<op><double>
=0.7
<op><integer>
=0
FRACT
LODTHRESHOLD
MAXFRACT
MAXAVAILABLE
PROCESSORS
MAXPTSINALINE
Notes
WhenLoadondemandissettoautounload,settheminimum
andmaximummemorythresholds.Thevaluesmaybefrom0
to1,where.5correspondstoathresholdof50%.IfTecplot
360smemoryusageexceedsthemaximumthreshold,it
continuestounloadvariablesuntiliteitherrunsoutof
variablesorreachestheminimumthreshold.Thesevaluesmay
alsobesetinteractivelyviathePerformancedialog.Referto
Section322.3MiscellaneousPreferencesdialoginthe
UsersManualforadditionalinformation.
SetsthemaximumnumberofprocessorsusedbyTecplot360.
Sometaskscanbeperformedinparallel,sousingallavailable
processorsgreatlyincreasesperformanceofthosetasks.By
default,Tecplot360usesallprocessorsavailableonthe
machinetoprovidethebestperformanceinmostcases.Assign
avaluelessthanthetotalnumberofavailableprocessorsto
limitthenumberofprocessorsusedbyTecplot360tothe
assignednumber.
<op><integer>
<op><integer>
Maximumnumberofpointsforgeometrypolylines.
<op><integer>
Maximumnumberofcontourlevels.
<op><integer>
<op><integer>
Maximumnumberofobjectstopick.
MAXUSABLEMEMORY
PRELOADDATATIME
<integer>
MAXCHRSINTEXT
Maximumnumberofcharactersintextlabels.
LABELS
MAXNUMCONTOUR
LEVELS
MAXNUMPICKOBJECTS
THRESHOLDINMS
LimittheamountofmemoryusedbyTecplot360(unitsof
MB).
Setsthemaximumtimeinmillisecondstospendpreloading
data.
Example: Increasethemaximumnumberofcontourlevelsallowedto1,000:
$!LIMITS
MAXNUMCONTOURLEVELS=1000
$!LINEARINTERPOLATE
Syntax:
$!LINEARINTERPOLATE
Description:Interpolateselectedvariablesfromasetofsourcezonestoadestinationzoneusinglinear
interpolation.ThesourcezonescannotbeIordered.Valuesassignedtothedestinationzoneare
equivalenttotheresultsofusingtheprobetoolinTecplot360.
150
$!LINEMAP
Required Parameter
Parameters
Syntax
DESTINATIONZONE
Default
=<integer>
Notes
Zonetointerpolateto.
Optional Parameters
Parameters
Syntax
Default
SOURCEZONES
=<set>
Allzonesexcept
thedestination
zone.
VARLIST
=<set>
Allvariables
exceptspatial
variables.
Notes
Choosethevariablestointerpolate.Thespatialvariables(X,Y
andZif3D)arenotallowed.
Example:
Dolinearinterpolationfromzones2,3and4ontozone7.Interpolateonlyvariables37:
$!LINEARINTERPOLATE
SOURCEZONES=[24]
DESTINATIONZONE=7
VARLIST=[37]
$!LINEMAP
Syntax:
$!LINEMAP[<set>]
Description:ASetValuecommandthatassignsattributesforindividualLinemappings.The<set>parameter
immediatelyfollowingthe$!LINEMAPcommandisoptional.If<set>isomittedthentheassignment
isappliedtoallLinemappings,otherwisetheassignmentisappliedonlytotheLinemappings
specifiedin<set>.
151
$!LINEMAP
Optional Parameters
Parameter
Syntax
Default
Notes
ASSIGN
{
ZONE
=<integer>
XAXISVAR
=1
YAXIS
<op><integer>
<op><integer>
<op><integer>
<op><integer>
<op><integer>
<op><integer>
FUNCTIONDEPENDENCY
=<functiondependency>
XINDEPENDENT
SHOWINLEGEND
=[ALWAYS,NEVER,
AUTO]
AUTO
SORT
<sortby>
NONE
SORTVAR
=<integer>
YAXISVAR
THETAAXISVAR
RAXISVAR
XAXIS
=2
=1
=1
}
BARCHARTS
{
SHOW
=<boolean>
YES
COLOR
=<color>
RED
FILLMODE
=<fillmode>
USESPECIFICCOLOR
FILLCOLOR
=<color>
RED
SIZE
<op><dexp>
<op><dexp>
=2.5
CURVETYPE
=<curvetype>
LINESEG
EXTENDEDNAME
=<string>
OnlyusedbytheExtendedCurvefit
Addon.
EXTENDEDSETTINGS
=<string>
OnlyusedbytheExtendedCurvefit
Addon.
USEWEIGHTVAR
=<boolean>
NO
NUMPTS
=200
POLYORDER
<op><integer>
<op><integer>
WEIGHTVAR
=<integer>
INDVARMIN
<op><dexp>
1x10150
INDVARMAX
<op><dexp>
1x10150
USEINDVARRANGE
=<boolean>
NO
CLAMPSPLINE
=<boolean>
NO
SPLINEDERIVATIVEATST
ART
<op><dexp>
=0
SPLINEDERIVATIVEATEN
D
<op><dexp>
=0
SHOW
=<boolean>
NO
VAR
=<integer>
BARTYPE
=<errorbartype>
VERT
COLOR
=<color>
RED
LINETHICKNESS
<op><dexp>
=0.1
LINETHICKNESS
=0.4
}
CURVES
{
=3
}
ERRORBARS
{
152
$!LINEMAP
Parameter
Syntax
Default
SKIPPING
<op><dexp>
=1
SKIPMODE
=<skipmode>
BYINDEX
SIZE
<op><dexp>
=2.5
Notes
Skipcanbebyindexordistance
dependingonSKIPMODE.
}
INDICES
{
IJKLINES
=<ijklines>
IRANGE
<<indexrange>>
JRANGE
<<indexrange>>
KRANGE
<<indexrange>>
Theindicesparameterisusedto
restricttherangeofdataplotted(and
whichlinesareplottedifthedatais
IJorIJKordered).
MIN=1,MAX=0,SKIP=1
MIN=1,MAX=0,SKIP=1
MIN=1,MAX=0,SKIP=1
}
LINES
{
SHOW
=<boolean>
YES
COLOR
=<color>
RED
LINEPATTERN
=<linepattern>
SOLID
PATTERNLENGTH
<op><dexp>
<op><dexp>
=2
=<string>
&DV&
SHOW
=<boolean>
YES
COLOR
=<color>
RED
FILLMODE
=<fillmode>
NONE
FILLCOLOR
=<color>
RED
SIZE
<op><dexp>
<op><dexp>
<op><dexp>
=2.5
=<skipmode>
<<symbolshape>>
BYINDEX
LINETHICKNESS
=0.1
}
NAME
SYMBOLS
{
LINETHICKNESS
SKIPPING
SKIPMODE
SYMBOLSHAPE
=0.1
=1
Skipcanbebyindexordistance
dependingonSKIPMODE.
ISASCII=NO,
GEOMSHAPE=SQUARE
Examples:
Example 1:
Assignvariable1tobeontheXaxisandvariable4tobeontheYaxisforLinemappingnumber7:
$!LINEMAP[7]
ASSIGN
{
XAXISVAR=1
YAXISVAR=4
}
153
$!LINEPLOTLAYERS
Example 2:
MakeErrorBarsredforallLinemappings:
$!LINEMAP
ERRORBARS
{
COLOR=RED
}
Example 3:
SetLinemappings35todrawapolynomialcurvefitoforder5:
$!LINEMAP[35]
CURVES
{
POLYORDER=5
CURVETYPE=CURVFIT
}
LINES
{
SHOW=YES
}
$!LINEPLOTLAYERS
Syntax:
$!LINEPLOTLAYERS
Description:ASetValuecommandthatturnsonoroffLineplotlayers.
Parameter
Syntax
Default
SHOWLINES
=<boolean>
YES
SHOWSYMBOLS
=<boolean>
NO
SHOWBARCHARTS
=<boolean>
NO
SHOWERRORBARS
=<boolean>
NO
Notes
Linemappingmusthaveanerrorbarvariableassignedforthis
tohaveaneffect.
Example: Turnonthesymbolslayerforlineplots:
$!LINEPLOTLAYERS
SHOWSYMBOLS=YES
$!LINKING
Syntax:
$!LINKING
Description:Linkattributesintwoormoreframessothatchangestoattributesofoneframeeffectalllinked
frames.
154
$!LOADADDON
Optional Parameters
Parameter
Syntax
Default
Notes
BETWEENFRAMES
{
LINKCONTOURLEVELS
=<boolean>
NO
LINKFRAMESIZEANDPOSI
TION
=<boolean>
NO
LINKXAXISRANGE
=<boolean>
NO
LINKYAXISRANGE
=<boolean>
NO
LINKPOLARVIEW
=<boolean>
NO
LINK3DVIEW
=<boolean>
NO
LINKGROUP
=<integer>
LINKAXISPOSITION
=<boolean>
NO
LINKVALUEBLANKING
=<boolean>
NO
LINKSLICEPOSITIONS
=<boolean>
NO
LINKISOSURFACEVALUES
=<boolean>
NO
LINKAXISSTYLE
=<boolean>
NO
LINKGRIDLINESTYLE
=<boolean>
NO
LINKLAYERLINECOLOR
=<boolean>
NO
LINKLAYERLINEPATTERN
=<boolean>
NO
}
WITHINFRAME
{
Example:
ThefollowingexamplewillsetthelinkattributeforallframesinthelayouttoLINK3DVIEW.:
$!LOOP|NUMFRAMES|
$!LINKINGBETWEENFRAMESLINK3DVIEW=YES
$!FRAMECONTROLMOVETOBOTTOMBYNUMBER
$!FRAMECONTROLATIVATETOP
$!ENDLOOP
$!LOADADDON
Syntax:
$!LOADADDON<string>
ADDONSTYLE=<addonstyle>
Description:LoadanaddonintoTecplot360.The<string>isthenameoftheaddontoload.SeeSection331
AddonLoadingintheUsersManualforinstructionsonhowtospecifytheaddon.
Optional Parameters
Parameters
ADDONSTYLE
Syntax
=<string>
Default
V7Standard
Notes
Styleoftheaddontoload.Thiscan
beeitherV7STANDARDor
V7ACTIVEX.
Example:
LoadtheCircleStreamaddon.ItisaV7STANDARDaddonstoredinalibrarynamedcstream.:
$!LOADADDON"cstream"
155
$!LOADCOLORMAP
$!LOADCOLORMAP
Syntax:
$!LOADCOLORMAP<string>
[noparameters]
Description:Loadacolormapfile.The<string>isthenameofthefiletoload.
Example:
$!LOADCOLORMAP"mycolors.map"
$!LOOP...$!ENDLOOP
Syntax:$!LOOP<integer>
$!ENDLOOP
Description:Processmacrocommandsinaloop.Withintheloopyoumayaccessthecurrentloopcounter
usingtheinternalmacrovariable|Loop|.Loopsmaybenestedupto10levelsdeep.
Example: Processmacrocommands3timesover:
$!LOOP3
$!ENDLOOP
$!MACROFUNCTION...$!ENDMACROFUNCTION
Syntax:
$!MACROFUNCTION
NAME=<string>
$!ENDMACROFUNCTION
Description:Defineamacrofunction.Allcommandsbetweena$!MACROFUNCTIONandthe
$!ENDMACROFUNCTIONareassociatedwiththemacrofunctionNAME.Thesecommandsarenot
executedwhentheyaredefinedbutareexecutedwhena$!RUNMACROFUNCTIONcommandis
processed.Parameterscanbepassedtoamacrofunction.Use|n|toreferencethenthparameter.
(See$!RUNMACROFUNCTION).Intheuserinterface,[Crtl]Mmustbepressed,beforeusingthe
keyboardshortcutspecifiedbytheKEYSTROKEoption.Forexample,iftheKEYSTROKEoptionissetto
P,theusermustpress[CTRL]MP.
156
$!NEWLAYOUT
Required Parameter
Parameter
NAME
Syntax
Default
=<string>
Notes
Nameofthemacrofunction.
Optional Parameter
Parameter
Syntax
Default
Notes
KEYSTROKE
=<string>
RETAIN
=<boolean>
NO
SetthistoYESifyouwantTecplot360toretainthismacro
functionwhenthemacroinwhichthismacrofunctionwas
definedterminates.Ifthemacrofunctionisretainedthenitcan
becalledwhenanothermacroisloadedatalatertime.
SHOWINMACROPANEL
=<boolean>
YES
Usedonlyformacrofunctionswithinthetecplot.mcrfile.Set
thistoNOifyoudonotwantTecplot360toincludethemacro
functioninTecplot360sQuickMacroPanel.
Allowskeyboardshortcuts
Example:
Defineamacrofunctionthatredrawstheactiveframentimeswhen<Ctrl>+MishitandthentheRkeyis
pressed,wherenispassedtothemacrofunction:
$!MACROFUNCTION
NAME="ABC"
KEYSTROKE="R"
$!LOOP|n|
$!REDRAW
$!ENDLOOP
$!ENDMACROFUNCTION
$!NEWLAYOUT
Syntax:
$!NEWLAYOUT
[noparameters]
Description:Clearthecurrentlayoutandstartagain.
Whenanewlayoutiscreated,thefollowingstepsoccur:
1. Allpagesaredeleted.
2. Anewpageiscreated.
3. Anewframeisaddedtothepage.
$!OPENLAYOUT
Syntax:
$!OPENLAYOUT<string>
Description:Openandreadinanewlayoutfile.The<string>isthenameofthefiletoopen.
157
$!PAGE
Optional Parameters
Parameter
ALTDATALOAD
Syntax
Default
Null
Specifyalternatedataloadinstructions.
Tecplot360datafiles:Thisisalistoffilenamestouseas
replacementsfordatafilesreferencedinthelayoutfile.Useto
enclosefilenamesthatcontainspacesorthe+symbol.By
default,separatefilenameslistedinthe
ALTDATALOADINSTRUCTIONSareassignedtosuccessive
datasetsthatarereferencedwithinalayoutfile.Ifyouhavea
datasetthatreferencesmultipledatafiles,usetheplussymbol,
+,togroupfilenames.
NonTecplot360formats(includingdatabeinginputviaadata
loaderaddon):Thisisalistofinstructionsthatarepassedon
totheloader.
=<boolean>
NO
SettoNOifyouwantTecplot360todeletethecurrentlayout
priortoreadinginthenewone.
INSTRUCTIONS
APPEND
Notes
=<string>
Examples:
Example 1:
Openanewlayoutfilecalledabc.layandreplacethedatafilereferencedinthelayoutfilewitht.plt:
$!OPENLAYOUT"abc.lay"
ALTDATALOADINSTRUCTIONS="t.plt"
Example 2:
Openanewlayoutfilecalledmultiframe.layandreplacethefirstdatasetwitht.pltandtheseconddata
setwiththetwofiles,a.pltandb.plt:
$!OPENLAYOUT"multiframe.lay"
ALTDATALOADINSTRUCTIONS='"t.plt""a.plt"+"b.plt"'
P-Q
$!PAGE
Syntax:
$!PAGE
Description:ASetValuecommandthatsetsthepapercharacteristics.
158
$!PAGECONTROL [Required-Control Option]
Optional Parameters
Parameter
Syntax
Default
Notes
PAPERATTRIBUTES
{
BACKGROUNDCOLOR
=<color>
WHITE
ISTRANSPARENT
=<boolean>
YES
ORIENTPORTRAIT
=<boolean>
NO
PAPERGRIDSPACING
=<papergridspacing>
HALFINCH
PAPERSIZE
=<papersize>
<<rect>>
LETTER
REGIONINWORKAREA
RULERSPACING
=<paperrulerspacing>
ONEINCH
SHOWGRID
=<boolean>
YES
SHOWPAPER
=<boolean>
NO
SHOWRULER
=<boolean>
NO
X1=1,Y1=0.25,X2=10,
Y2=8.25
Setthespacingforthetickmarkson
thepaper.
Specifyrectanglethatmustfitwithin
theworkarea.Unitsareininches
(thatis,inthepapercoordinate
system).
}
USESOFTWARERENDERING
=<boolean>
Usethepaintersalgorithm
(meaning,displaygraphicscellby
cellfromfronttoback),insteadof
usingOpenGL.
NAME
=<string>
Nameparameterisemptyuntil
specified.
Example:
Turnsoffthepapergrid.
MakesthepapersizeCUSTOM1.
MakesthedimensionsforCUSTOM1tobe4by5inches.
$!PAGE
PAPERATTRIBUTES
{
SHOWGRID=NO
PAPERSIZE=CUSTOM1
PAPERSIZEINFO
{
CUSTOM1
{
WIDTH=4
HEIGHT=5
}
}
}
Seealso:Section$!GLOBALPAPERonpage 127.
$!PAGECONTROL [Required-Control Option]
Description:ThedifferentcommandsinthePAGECONTROLcompoundfunctionfamilyaredescribed
ThePAGECONTROLcompoundfunctionsare:
$!PAGECONTROLCREATE
159
$!PAGECONTROL CREATE
$!PAGECONTROLSETCURRENTTONEXT
$!PAGECONTROLSETCURRENTTOPREVIOUS
$!PAGECONTROLSETCURRENTBYNAME
$!PAGECONTROLDELETE
$!PAGECONTROLCLEAR
$!PAGECONTROL CREATE
Syntax:
$!PAGECONTROLCREATE
[noparameters]
Description:Createanewpage.Thecreatedpagewillincludeaninitialframe.
$!PAGECONTROL SETCURRENTTONEXT
Syntax:
$!PAGECONTROLSETCURRENTTONEXT
[noparameters]
Description:Setthenextpagetobethecurrentpage.
$!PAGECONTROL SETCURRENTTOPREVIOUS
Syntax:
$!PAGECONTROLSETCURRENTTOPREVIOUS
[noparameters]
Description:Setthepreviouspagetobethecurrentpage.
$!PAGECONTROL SETCURRENTBYNAME
Syntax:
NAME=<string>
Description:Setthecurrentpagetothepagespecified.
Example:
NAME="BANANA"
$!PAGECONTROL DELETE
Syntax: $!PAGECONTROLDELETE
Description:Deletethecurrentpage.Ifthecommandisoperatedontheonlypage,thenaninitialpageis
createdwithaninitialframe.
$!PAGECONTROL CLEAR
Syntax: $!PAGECONTROLCLEAR
Description:Clearsallframesinthecurrentpageandcreatesadefaultinitialframe.
160
$!PAGEGETNAME
$!PAGEGETNAME
Syntax: $!PAGEGETNAME|MACROVAR|
Description:Actioncommandtogetthenameofthecurrentpage.
$!PAGENAME
Syntax:
$!PAGENAME<string>
[noparameters]
Description:Setthenameofthepage.
$!PAUSE
Syntax:
$!PAUSE<string>
[noparameters]
Description:Stopexecutionofamacroandoptionallydisplayadialogwithamessage.If<string>issetto""
thennodialogisdisplayedandtheusermustclickintheworkareatocontinue.
Example:
PauseanddisplaythemessageThisisthefirstexampleplot:
$!PAUSE"Thisisthefirstexampleplot."
$!PICK [Required-Control Option]
Description:ThedifferentcommandsinthePICKcompoundfunctionfamilyaredescribedseparatelyinthe
followingsections.
ThePICKcompoundfunctionsare:
$!PICKADDATPOSITION
$!PICKADDALL
$!PICKADDALLINRECT
$!PICKCLEAR
$!PICKCOPY
$!PICKCUT
$!PICKEDIT
$!PICKMAGNIFY
$!PICKPASTE
$!PICKPOP
$!PICKPUSH
$!PICKSETMOUSEMODE
$!PICKSHIFT
$!PICK ADDATPOSITION
Syntax:
$!PICKCHECKTOADD
X=<dexp>
Y=<dexp>
Description:Attempttopickanobjectataspecificlocationonthepaper.Doesnotpoporactivateframes.
161
$!PICK ADDALL
Required Parameters
Parameters
Syntax
Default
Notes
=<dexp>
Xlocation(ininches)relativetotheleftedgeofthepaper.
=<dexp>
Ylocation(ininches)relativetothetopedgeofthepaper.
Optional Parameters
Parameters
Syntax
Default
Notes
COLLECTINGOBJECTS
=<boolean>
NO
CONSIDERSTYLE
=<boolean>
NO
DIGGINGFOROBJECTS
=<boolean>
NO
IfYES,attempttopickobjectsbelowanycurrentlypicked
objectsatthislocation.
IGNOREZONEOBJECTS
=<boolean>
NO
IfYES,pickoperationswillignorezonesandpickobjectssuch
asslices,isosurfacesandstreamtraces.
IfNO,thelistofpickedobjectsisclearedbeforetheattemptis
madetoaddanewobject.
Example:
Attempttoaddtothelistofpickedobjectsbypickingatpaperlocation(1.0,7.0).Donotclearthelistof
pickedobjectsbeforepicking:
$!PICKCHECKTOADD
X=1.0
Y=7.0
COLLECTINGOBJECTS=YES
$!PICK ADDALL
Syntax:
$!PICKADDALL
Description:Addallobjectsofacertaintypetothelistofpickedobjects.
Optional Parameters
Parameters
Syntax
Default
Notes
SELECTTEXT
=<boolean>
NO
Selectalltextobjectsintheactiveframe.
SELECTGEOMS
=<boolean>
NO
Selectallgeometryobjectsintheactiveframe.
SELECTFRAMES
=<boolean>
NO
Selectallframes.
SELECT
=<boolean>
NO
Selectallstreamtraceobjectsintheactiveframe.
SELECTMAPS
=<boolean>
NO
Selectalllinemapobjectsintheactiveframe.
SELECTZONES
=<boolean>
NO
Selectallzoneobjectsintheactiveframe.
STREAMTRACES
Example: Addalltextandgeometriesintheactiveframetothelistofpickedobjects:
$!PICKADDALL
SELECTTEXT=YES
SELECTGEOMS=YES
$!PICK ADDALLINRECT
Syntax:
162
$!PICKADDALLINRECT
X1=<dexp>
$!PICK ADDALLINRECT
Y1=<dexp>
X2=<dexp>
Y2=<dexp>
Description:Addobjectsdefinedwithinaspecifiedregiontothelistofpickedobjects.Theregionisdefined
intermsofthepapercoordinatesystem.Optionalfilterscanbeusedtorestricttheobjectsselected.
Theregionisdefinedbythetwocornerpoints(X1,Y1)and(X2,Y2).
Required Parameters
Parameters
X1
Syntax
Default
Notes
=<dexp>
Y1
=<dexp>
X2
=<dexp>
Y2
=<dexp>
Optional Parameters
Parameters
Syntax
Default
Notes
COLORFILTER
=<color>
FONTFAMILYFILTER
=<string>
Notused.
Onlytextobjectswiththisfontwillbeselected.
ISBOLD
=<boolean>
NO
Onlyboldfacetextobjectswillbeselected.
ISITALIC
=<boolean>
NO
Onlyitalicizedtextobjectswillbeselected.
GEOMFILTER
=<geomtype>
Notused.a
Onlygeometryobjectsofthistypewillbeselected.
LINEPATTERNFILTER
=<linepattern>
Notused.a
Onlygeometryobjectswiththislinepatternwillbeselected.
SELECTCONTOUR
=<boolean>
NO
Selectallcontourlabelsinspecifiedregion
Onlyobjectsofthiscolorwillbeselected.
Notused.
LABELS
SELECTFRAMES
=<boolean>
NO
Selectallframeobjectsinthespecifiedregion.
SELECTGEOMS
=<boolean>
NO
Selectallgeometryobjectsinthespecifiedregion.
SELECTGRIDAREA
=<boolean>
NO
Selectthegridareainspecifiedregion
SELECTMAPS
=<boolean>
NO
Selectalllinemapobjectsinthespecifiedregion.
SELECT
=<boolean>
NO
Selectallstreamtraceobjectsinthespecifiedregion.
SELECTTEXT
=<boolean>
NO
Selectalltextobjectsinthespecifiedregion.
SELECTZONES
=<boolean>
NO
Selectallzoneobjectsinthespecifiedregion.
STREAMTRACES
a. There is no default for this parameter. If this parameter is omitted then the corresponding filter is not
used.
Example:
Pickallcirclesusingadashedlinepatternwithintherectangleboundedbythepoints(0,0)and(3,5):
$!PICKADDALLINRECT
SELECTGEOMS =YES
LINEPATTERNFILTER=DASHED
GEOMFILTER
=CIRCLE
X1
=0
Y1
=0
X2
=3
Y2
=5
163
$!PICK CLEAR
$!PICK CLEAR
Syntax:
$!PICKCLEAR
[noparameters]
Description:Deleteallobjectsthatarecurrentlypicked.(Theseobjectscannotberetrieved.)
Example:
$!PICKCLEAR
$!PICK COPY
Syntax:
$!PICKCOPY
[noparameters]
Description:Copyallobjectsthatarecurrentlypickedtothepastebuffer.
Example:
$!PICKCOPY
$!PICK CUT
Syntax:
$!PICKCUT
[noparameters]
Description:Copyallobjectsthatarecurrentlypickedtothepastebufferandthendeletethem.
Example:
$!PICKCUT
$!PICK EDIT
Syntax:
$!PICKEDIT
[parameters]
Description:Performaglobaleditoperationonthecurrentlypickedobjects.Onlyoneeditoperationis
allowedper$!PICKEDITcommand.Objectsareeditedonlyifthesuppliedparameterisrelevant.
ActionstakenusingtheQuickEditdialoginTecplot360generatethesecommands.
Parameters
Mustselectonefromthistable.
Parameters
Syntax
ARROWHEADANGLE
=<dexp>
ARROWHEADATTACHMENT
=<arrowheadattachment>
ARROWHEADSIZE
=<dexp>
ARROWHEADSTYLE
<arrowheadstyle>
ASCIICHAR
=<string>
BARCHARTS
{
164
Default
Notes
Angleisindegrees.
ValueisinYframeunits(0100).
OnlyoperatesonXYlinemapping
objects.
$!PICK EDIT
Parameters
Syntax
SHOW
=<boolean>
ISFILLED
=<boolean>
Default
Notes
}
COLOR
=<color>
CONTOUR
Onlyoperateson2Dor3Dzone
objects.
{
SHOW
=<boolean>
CONTOURTYPE
=<contourtype>
}
CURVES
objects.
{
CURVETYPE
=<curvetype>
}
EDGELAYER
objects.
{
SHOW
=<boolean>
SUBBOUNDARY
=<subboundary>
}
ERRORBARS
objects.
{
SHOW
=<boolean>
BARTYPE
=<errorbartype>
}
FILLCOLOR
=<color>
FONTFAMILY
=<string>
GEOMSHAPE
=<geomshape>
ISBOLD
=<boolean>
ISITALIC
=<boolean>
LINEPATTERN
=<linepattern>
LINES
Appliesonlytoscattersymbolsor
XYplotsymbols.
objects.
{
SHOW
=<boolean>
}
LINETHICKNESS
=<dexp>
MESH
objects.
{
SHOW
=<boolean>
MESHTYPE
=<meshtype>
objects.
OBJECTALIGN
=<objectalign>
Onlyallowedifselectedobjectsare
alltextand/orgeometries.
PATTERNLENGTH
=<dexp>
SCATTER
objects.
{
SHOW
=<boolean>
FILLMODE
=<fillmode>
165
$!PICK MAGNIFY
Parameters
Syntax
Default
Notes
}
SHADE
objects.
{
SHOW
=<boolean>
SHADETYPE
=<shadetype>
}
SHOWBORDER
=<boolean>
Onlyoperatesonframeobjects.
SIZE
=<dexp>
ValueisinYframeunits.This
appliestothingslikesymbols.
SYMBOLS
Onlyoperatesonlinemapping
objects.
{
SHOW
=<boolean>
ISFILLED
=<boolean>
}
TEXTCOLOR
=<color>
TEXTHEIGHTBYPERCENT
=<dexp>
TEXTHEIGHTBYPOINTS
=<dexp>
VECTOR
Valueisinpoints.
objects.
{
SHOW
=<boolean>
VECTORTYPE
=<vectortype>
Examples:
Example 1:
Setallpickedobjectstousethecoloryellow:
$!PICKEDIT
COLOR=YELLOW
Example 2:
Setallpickedobjectstousethedashedlinepattern:
$!PICKEDIT
LINEPATTERN=DASHED
Example 3:
Setallpickedobjects(whicharezones)tousethecontourplottypeofflooding:
$!PICKEDIT
CONTOUR{CONTOURTYPE=FLOOD}
$!PICK MAGNIFY
Syntax:
166
$!PICKMAGNIFY
MAG = <dexp>
$!PICK PASTE
Description:Magnifyallpickedobjects.Theobjectswillalsobetranslatedproportionaltothedistance
betweentheiranchorpositionandtheanchorpositionofthefirstobjectpicked.
Example: Magnifyallobjectsby1.5:
$!PICKMAGNIFY
MAG=1.5
$!PICK PASTE
Syntax:
$!PICKPASTE
[noparameters]
Description:Pastethecurrentlypickedobjectsfromthepastebuffertotheworkarea.
$!PICK POP
Syntax:
$!PICKPOP
[noparameters]
Description:Changetheorderinwhichobjectsaredrawnbypoppingthecurrentlypickedobjectstothe
front.Onlyframes,text,geometries,andthegridareafor2Dplotsareallowed.
$!PICK PUSH
Syntax:
$!PICKPUSH
[noparameters]
Description:Changetheorderinwhichobjectsaredrawnbypushingthecurrentlypickedobjectsback.Only
frames,text,geometries,andthegridareafor2Dplotsareallowed.
$!PICK SETMOUSEMODE
Syntax:
$!PICKSETMOUSEMODE
MOUSEMODE = <mousemode>
Description:PreparetopickobjectsbysettingthemousemodetoSELECTorADJUST.Thiscommandalso
clearsthelistofpickedobjects(thatis,unpicksallpickedobjects).
Required Parameter
Parameter
MOUSEMODE
Syntax
=<mousemode>
Default
Notes
SettoSELECTorADJUST.
Example: Setthemousemodesopickedobjectsareadjusted:
$!PICKSETMOUSEMODE
MOUSEMODE=ADJUST
167
$!PICK SHIFT
$!PICK SHIFT
Syntax:
$!PICKSHIFT
X=<dexp>
Y=<dexp>
Description:Shiftthecurrentlypickedobjects.Objectsareshiftedrelativetotheirstartingposition.XandY
shiftamountsareinpaperunits(inches).IfsnappingisineffectthenitisappliedaftershiftinginX
andY.(SeetheSetValuecommands$!GLOBALFRAMESNAPTOGRIDand$!GLOBALFRAME
SNAPTOPAPER.)
Required Parameters
Parameters
Syntax
Default
Notes
=<dexp>
ShiftamountintheXdirection.Unitsareinches.
=<dexp>
ShiftamountintheYdirection.Unitsareinches.
Optional Parameter
Parameters
POINTERSTYLE
Syntax
=<pointerstyle>
Default
ALLDIRECTIO
NS
Notes
Onlyframesandnon3Dgridareaobjectscanuseapointer
stylethatisnotALLDIRECTIONS.
Example: Shiftthecurrentlypickedobjects1inchtotherightand2inchesdown:
$!PICKSHIFT
X=1
Y=2
$!PLOTOPTIONS
Syntax: $!PLOTOPTIONS=<boolean>
Description:Changetheplotoptionbetweensubdividingallcells,orusingaquickeralgorithm.
Optional Parameters
Parameters
SUBDIVIDEALLCELLS
Syntax
=<boolean>
Default
NO
Notes
IfYES,dividesallnontriangular,nontetrahedralcellsofall
zonetypeswhencontouring,probingandcreatingisosurfaces
andslices.ThisoptiononlyaffectsIJandIJKorderedplots.
IfNO,usesquickermarchingcubesstylealgorithm,but
generatesholesintheisosurfacesatcertainsaddlepoints.
Example: Usethefollowingcommandtosubdivideallvolumecells:
$!PLOTOPTIONS
SUBDIVIDEALLCELLS=YES
$!PLOTTYPE
Syntax:
$!PLOTTYPE=<plottype>
[noparameters]
Description:ChangesplottypesbetweenvalidTecplot360modessuchasXYLineandCartesian2D.Valid
168
$!POLARAXIS
optionsshownbelow.
Required Parameters
Parameter
Syntax
PLOTTYPE
=<plottype>
Default
Notes
CARTESIAN3D
Example: Changetheplotstyletoshowapolarplot:
$!PLOTTYPE=POLARLINE
$!POLARAXIS
Syntax:
$!POLARAXIS
Description:ASetValuecommandthatassignsattributesforaxesinapolarframe.
Optional Parameters
Parameter
Syntax
GRIDAREA
<<areastyle>>
PRECISEGRID
<<precisegrid>>
PRESERVEAXISSCALE
<boolean>
RDETAIL
<<axisdetail>>
THETADETAIL
<<axisdetail>>
Default
SeeNotes
Notes
DRAWBORDER=YES,ISFILLED=NO,FILLCOLOR=WHITE,
DRAWGRIDLAST=NO
INCLUDE=NO,SIZE=0.0045,COLOR=BLACK
YES
THETAMODE
=<thetamode>
DEGREES
THETAPERIOD
=<double>
360
VIEWPORTPOSITION
<<rect>>
SeeNotes
X1=0,Y1=0,X2=100,Y2=100
VIEWPORTSTYLE
<<areastyle>>
SeeNotes
DRAWBORDER=NO,COLOR=BLACK,
LINETHICKNESS=0.4,ISFILLED=NO,FILLCOLOR=WHITE
Example: SettheThetarange,inRadians,fromPitoPi.
$!POLARAXISTHETAMODE=RADIANS
$!POLARAXISTHETAPERIOD=6.28318530718
$!POLARAXISTHETADETAIL{VALUEATORIGIN=0}
$!POLARAXISTHETADETAIL{RANGEMIN=3.14159265359}
$!POLARTORECTANGULAR
Syntax:
$!POLARTORECTANGULAR<set>
[noparameters]
Description:TreatthevariablescurrentlyassignedtoXandYasreferringtoRandandconvertthemtoX
andY.In3D,X,YandZrefertoR,,and.Tecplot360hasadditioncapabilitiesfortransforming
coordinates,pleasesee$!TRANSFORMCOORDINATES.
Example: Convertzones1,2and3frompolartorectangular:
$!POLARTORECTANGULAR[13]
169
$!POLARVIEW
$!POLARVIEW
Syntax:
$!POLARVIEW
Description:Setstheviewingstyleforpolarplotsinalayout.
Required Parameters
Parameter
Syntax
<<rect>>
EXTENTS
Default
X1=1.29771,
Y1=1.15352,
X2=1.29771,
Y2=1.15352
Notes
ViewextentsoftransformedX&Yinpolarplots.Numbers
listedareintheformofgridunits.
Example: Settheviewofthepolarplottoviewthefullextentsoftheplotarea.
$!POLARVIEW
EXTENTS
{
X1=10
Y1=10
X2=90
Y2=90
}
$!PRINT
Syntax:
$!PRINT
[noparameters]
Description:Printthecurrentlayouttoaprinterorsendtheprintinstructionstoafile.Usethe$!PRINTSETUP
SetValuecommandtoconfigureprinting.
Example:
$!PRINT
$!PRINTSETUP
Syntax:
$!PRINTSETUP
Description:ASetValuecommandthatsetstheattributesforprinting.Use$!PRINTtodotheactualprinting.
See$!EXPORTSETUPand$!EXPORTifyouintendtocreateimagefilesdestinedfordesktop
publishingprograms.
170
$!PRINTSETUP
Optional Parameters
Parameter
DRIVER
Syntax
Default
FORCEEXTRA3D
Notes
OnlyappliesifusingtheTecplot360printerdrivers.See
=
<printerdriver>
$!INTERFACEUSETECPLOTPRINT.
=<boolean>
SORTING
JOBCONTROL
Thesestringscontaincharacterstobesentatthebeginningand
endingofaprintfile.Thesestringsmostoftencontainescape
sequencesusedtoswitchmodesontheprinter.Nonprintable
characterscanbeinserted.Use^nnntoinsertacharacterwith
ordinalvaluennn.Use\toforcethecharacterafterthe\tobe
inserted.Use$BforaBackspace,$EforEsc,$Cforacarriage
return,and$XfortheDeletekey.
{
POSTMOPUPSTR
=<string>
LGMOPUPSTR
=<string>
POSTSETUPSTR
=<string>
LGSETUPSTR
=<string>
}
IMAGERESOLUTION
=<integer>
NUMHARDCOPYCOPIES
<op> <integer>
NUMLIGHTSOURCESHA
DES
=<integer>
AppliesonlywhenDRIVER=PS.
PALETTE
=<palette>
MustchooseoptionsvalidforcurrentDRIVERsetting.
PRECISION
<op> <integer>
AppliesonlyifEXPORTFORMATisPS,EPS,or
RASTERMETAFILE.
NameofthefiletowritetoifSENDPRINTTOFILEisYES.
PRINTFNAME
=<string>
PRINTRENDERTYPE
=
<printrendertyp
e>
RGBLEGENDOUTPUT
=<integer>
RESOLUTION
SENDPRINTTOFILE
50
Determinesthenumberoftriangleswhichcomposethebottom
layeroftheRGBLegend.Thisoptionisonlyavailablethrough
macrolanguage(forexample,theconfigfile)
=<boolean>
IfYESthenPRINTFNAMEisnameoffiletowriteto.
PSMONOSPOOLCMD
=<string>
PSCOLORSPOOLCMD
=<string>
LGSPOOLCMD
=<string>
Thesestringscontainthesystemcommandneededtosenda
filetotheprintspooleronyourcomputer.Usethe@symbolas
aplaceholderforwhereyounormallyinsertthenameofthe
filetobeprinted.
Forsecurityreasonsthesecommandscanonlybeusedinthe
SPOOLER
{
}
USEISOLATIN1FONTS
INPS
=<boolean>
UseextendedISOLatin1fontswhengeneratingPostScript
outputusingTecplot360sinternalPostScriptdriver.
Example:
InstructTecplot360tosendprintoutputtotheprintspooler.
SetsthespoolercommandformonochromePostScripttobelpr@.
SetstheprintdrivertobemonochromePostScript.
$!PRINTSETUP
SENDPRINTTOFILE=NO
DRIVER=PS
PALETTE=MONOCHROME
SPOOLER
{
PSMONOSPOOLCMD="lpr@"
}
171
$!PROMPTFORFILENAME
$!PROMPTFORFILENAME
Syntax:
$!PROMPTFORFILENAME<macrovar>
DIALOGTITLE=<string>
DEFAULTFNAME=<string>
FILEFILTER=<string>
Description:InstructTecplot360tolaunchafileselectiondialog.Theresultingfilenamewillbeplacedin
<macrovar>.Iftheusercancelsoutofthedialogthen<macrovar>willbeempty(seetheexample
below).
Optional Parameter
Parameter
DIALOGTITLE
Syntax
Default
Notes
=<string>
Null
Includeatitleatthetopofthedialog.
DEFAULTFNAME
=<string>
Null
Makethedialogcomeupwithadefaultfilename.
FILEFILTER
=<string>
Null
Setthefilterforthefileselectiondialog.
FILEMUSTEXIST
=<string>
YES
Example: Prompttheuserforthenameofafiletodelete:
$!PROMPTFORFILENAME|filetodelete|
DIALOGTITLE="DeleteFile"
FILEFILTER="*.*"
$!IF"|filetodelete|"!=""
$!IF|OPSys|=1#UNIX/Mac
$!System"rm|filetodelete|"
$!Endif
$!IF|OPSys|=2#Windows
$!System"cmd/cdel|filetodelete|"
$!Endif
$!Endif
$!PROMPTFORTEXTSTRING
Syntax:
$!PROMPTFORTEXTSTRING<macrovar>
INSTRUCTIONS=<string>
Description:InstructTecplot360tolaunchadialogcontainingasinglelinetextfieldandoptional
instructions.Theuserenterstextintothetextfieldandtheresultingstringisassignedto
<macrovar>.
Optional Parameter
Parameter
INSTRUCTIONS
Syntax
=<string>
Default
Null
Notes
Includetextatthetopofthedialogtoinstructtheuser
regardingthevaluetoenter.OnWindowsplatforms,thisis
limitedtothreelinesoftext.
Example:
$!PROMPTFORTEXTSTRING|timestring|
INSTRUCTIONS="Enterthetimeoftheexperiment"
172
$!PROMPTFORYESNO
$!PROMPTFORYESNO
Syntax:
$!PROMPTFORYESNO<macrovar>
INSTRUCTIONS=<string>
Description:InstructTecplot360tolaunchadialogcontainingtwobuttons,onelabeledYesandtheotherNo.
The<macrovar>isassignedthestringYesorNodependingontheselection.
Optional Parameter
Parameter
Syntax
INSTRUCTIONS
Default
=<string>
Null
Notes
Includetextatthetopofthedialogwithinstructions.
Example:
$!PROMPTFORYESNO|goforit|
INSTRUCTIONS="Doyouwanttogoforit?"
$!IF"|goforit|"=="YES"
...codethatgoesforit....
$!ENDIF
$!PROPAGATELINKING
Syntax:
$!PROPAGATELINKING
Description:Linkmultipleframes,eitherwithinframeorbetweenframes.
Optional Parameter
Parameter
Syntax
FRAMECOLLECTION
=[ALL,PICKED]
LINKTYPE
=[WITHINFRAME,
BETWEENFRAMES]
Default
Notes
Example:
$!PROPAGATELINKING
LINKTYPE=BETWEENFRAMES
FRAMECOLLECTION=ALL
$!PUBLISH
Syntax: $!PUBLISH<string>
Description:CreateanHTMLfiledisplayingoneormoreimages.Alinkedlayoutwithpackageddatamay
beincluded.Youmustprovidethefilename.
173
$!QUIT
Optional Parameter
Parameter
Syntax
Default
Notes
IMAGESELECTION
=<imagestyle>
ONEPERFRAME
ChoosingONEPERFRAMEwill
createoneimageperframe,selecting
WORKSPACEONLYcreatesone
imagewhichincludesallyour
frames.
INCLUDELAYOUTPACKAGE
=<boolean>
No
ChooseYEStocreatealinkedlayout
file.
Example:
$!PUBLISH"C:\TEC360\separate.html"
INCLUDELAYOUTPACKAGE=NO
IMAGESELECTION=ONEPERFRAME
$!QUIT
Syntax:$!QUIT
Description:TerminatetheexecutionoftheTecplot360program.
Example:
$!QUIT
R
$!RAWCOLORMAP
Syntax:
$!RAWCOLORMAP
<colormaprawdata>
Description:AssigntheRGBvaluesthatdefinetheRawuserdefinedcolormap.Thisdoesnotsetthecolor
maptousetheRawuserdefinedcolormap.Use$!COLORMAPtosetthecurrentcolormap.
Required Parameter
Parameter
Syntax
<colormaprawdata>
Default
Notes
ThisisalistofRGBvalues.
Example: AssigntheRawuserdefinedcolormaptoagrayscaleusing11colors:
$!RAWCOLORMAP
RAWDATA
11
0
0
0
25
25
25
50
50
50
75
75
75
100 100
100
125
125
125
150
150
150
175
175
175
174
$!READDATASET
200
225
255
200
225
255
200
225
255
$!READDATASET
Syntax:
$!READDATASET<string>
Description:The$!READDATASETmacrocommandhastwoseparateuses.Theparametersavailableforthe
commandaredependentupontheintendeduse.ItmayeitherbeusedtoloaddatainTecplot360s
fileformat(*.pltor*.dat)orinaforeigndatafileformat.ToloaddatainTecplot360sfileformat,
usetheparameterslistedinTable92.Toloaddatainaforeignfileformat,usetheparameters
listedinTable91alongwithasetofname/valuepairs.Thename/valuepairsarespecifictothe
dataloaderanddescribedinChapter4:DataLoadersintheUsersManual.
Examples:
FLUENT Loader Example:
ThefollowingexampleloadsonecasefileandonedatafilewiththeFLUENTfileloader.Notethatthe
DATASETREADERparameterisattheendofthecommandcall.
$!READDATASET
'"STANDARDSYNTAX""1.0"
"LoadOption""MultipleCaseAndData"
"FILELIST_Files""2""triangular.cas""triangular.dat"
"UnsteadyOption""ReadTimeFromDataFiles"
"AssignStrandIDs""Yes"
"GridZones""CellsAndBoundaries"
"IncludeParticleData""Yes"
"AverageToNodes""Yes"
"AveragingMethod""Arithmetic"'
DATASETREADER='FluentDataLoader'
Ensight Loader Example

ThefollowingexampleloadsoneEnsightcasefile.NotethattheDATASETREADERparameterisatthe
endofthecommandcall.
$!READDATASET
'"STANDARDSYNTAX""1.0"
"FILENAME_CASEFILE""wing.case"
"ISkip""1"
"JSkip""1"
"KSkip""1"'
DATASETREADER='EnSightLoader'
Table 9 - 1: Parameters for loading data in a foreign file format
Parameters
DATASETREADER
Syntax
=<string>
Default
Notes
UsedtospecifyanalternatedatareaderforTecplot360.
175
$!READDATASET
Table 9 - 2: Parameters for loading data in Tecplot 360 format
Parameters
ADDZONETOEXISTING
Syntax
Default
=<boolean>
NO
IfYES,Tecplot360willaddthezonesfromtheappendeddata
toanyexistingstrandsinthedataset.IfNO,Tecplot360will
appendthestrandsfromtheappendeddatatoanyexisting
strandsinthedataset.
=<boolean>
NO
IfYES,Tecplot360willassignstrandIDstozonesiftimeis
suppliedforthezonesbutstrandIDsarenot.IfNO,Tecplot
360willnotassociatethesezoneswithanystrands.
STRANDS
ASSIGNSTRANDID
Notes
IJKSKIP
Usevaluesgreaterthan1toskipdatapoints.
{
I
=<integer>
=<integer>
=<integer>
=<boolean>
NO
Renumberzonesandvariablesifzonesorvariablesare
disabled.
=<boolean>
YES
SettoYEStoloadinanycustomlabelsinthedatafiles.
INCLUDEDATA
=<boolean>
YES
SettoYEStoloadinanyfielddatainthedatafiles.
INCLUDEGEOM
=<boolean>
YES
SettoYEStoloadinanygeometriesinthedatafiles.
INCLUDETEXT
=<boolean>
YES
SettoYEStoloadinanytextinthedatafiles.
INITIALPLOTFIRST
=<boolean>
}
COLLAPSEZONESAND
VARS
INCLUDECUSTOM
LABELS
Allowsfasterperformanceforfileswithmultiplezones.
ZONEONLY
INITIALPLOTTYPE
=<plottype>
READDATAOPTION
=
<readdataoption
>
NEW
SettoAPPENDtoappendthenewzonestothezonesinthe
datasetthatexistedpriortousingthiscommand.SettoNEW
toremovethedatasetfromtheactiveframepriortoreadingin
thenewdataset.Ifotherframesusethesamedatasettheywill
continuetousetheoldone.SettoREPLACEtoreplacethe
datasetattachedtotheactiveframeandtoallotherframes
thatusethesamedataset,withthenewdataset.
RESETSTYLE
=<boolean>
YES
SettoNOifyouwantTecplot360tokeepthecurrentstyle.
ThisonlyappliesifREADDATAOPTIONisnotAPPEND.
VARLOADMODE
=
<varloadmode>
BYPOSITION
SettoBYPOSITIONtoloadvariablesbasedontheirpositionin
thefile.SettoBYNAMEtoloadvariablesbasedontheirname.
IfsettoBYNAME,thenVARNAMELISTmustbesuppliedas
well.
VARNAMELIST
=<string>
UsethistolistthenamesofthevariablestoloadintoTecplot
360.Namesseparatedbya;ora+arejoinedtogethertoforma
setofaliasesforagivenvariable.
VARPOSITIONLIST
=<set>
Allvars.
Usethistoreducethenumberofvariablesloaded.
ZONELIST
=<set>
Allzones.
Usethistoreducethenumberofzonesloaded.
Example 1:
Readinthedatafilest1.pltandt2.plttoformasingledatasetinTecplot360:
$!READDATASET"t1.pltt2.plt"
Example 2:
Readinthedatafilet1.plt.Onlyreadinzones1and4.SkipovereveryotherIindex:
$!READDATASET"t1.plt"
ZONELIST=[1,4]
IJKSKIP
{
I=2
}
176
$!READSTYLESHEET
Example 3:
Readinthedatafilest1.plt,t2.plt,andt3.plt.Appendthenewdatasettothecurrentone:
$!READDATASET"t1.pltt2.pltt3.plt"
READDATAOPTION=APPEND
Example 4:
Readinthedatafilest1.pltandt2.pltfromdirectory,/users/john/testrun7/runb:
$!VARSET|BASEDIR|="/users/john/testrun7/runb"
$!READDATASET"|basedir|/t1.plt|basedir|/t2.plt"
$!READSTYLESHEET
Syntax:
$!READSTYLESHEET<string>
Description:Readinastylesheetfile.The<string>isthenameofthefiletoread.
Optional Parameters
Parameters
Syntax
Default
Notes
INCLUDEAUXDATA
=<boolean>
YES
SettoYEStoreadauxiliarydata.
INCLUDECONTOUR
=<boolean>
YES
SettoYEStoreadinallcontourlevels.
=<boolean>
NO
SettoYESifyouwanttheactiveframetobesizedand
positionedexactlyliketheframeusedtocreatethestylesheet.
INCLUDEGEOM
=<boolean>
YES
SettoYEStoloadinanygeometriesinthestylesheetfile.
INCLUDEPLOTSTYLE
=<boolean>
YES
SettoYEStoprocesscommandsrelatedtoplotstyle(mesh
color,vectortype,andsoon).
INCLUDESTREAM
=<boolean>
YES
SettoYEStoreadinstreamtracestartingpositions.
INCLUDETEXT
=<boolean>
YES
SettoYEStoloadinanytextinthestylesheetfile.
MERGE
=<boolean>
NO
SettoNOtoresetallframeattributesbacktotheirfactory
defaultspriortoreadinginthestylesheet.
LEVELS
INCLUDEFRAMESIZE
ANDPOSITION
POSITIONS
Example: Readthestylesheetfilet.sty.Donotreadinanytextorgeometries:
$!READSTYLESHEET"t.sty"
INCLUDETEXT=NO
INCLUDEGEOM=NO
$!REDRAW
Syntax:
$!REDRAW
Description:Redrawtheactiveframe.
177
$!REDRAWALL
Optional Parameter
Parameter
Syntax
DOFULLDRAWING
=<boolean>
Default
YES
Notes
SettoNOtodrawonlyatraceofthedataintheframe.
Example:
$!REDRAW
$!REDRAWALL
Syntax:
$!REDRAWALL
Description:Redrawallframes.
Optional Parameter
Parameter
Syntax
DOFULLDRAWING
=<boolean>
Default
YES
Notes
SettoNOtodrawonlyatraceofthedataineachframe.
Example:
$!REDRAWALL
$!REMOVEVAR
Syntax: $!REMOVEVAR<macrouserdefvar>
Description:Removeauserdefinedmacrovariable.Thisfreesupspacesoanotheruserdefinedmacro
variablecanbedefined.
Example: Removethemacrovariable |ABC|:

$!REMOVEVAR|ABC|
$!RENAMEDATASETVAR
Syntax:
$!RENAMEDATASETVAR
VAR=<integer>
NAME=<string>
Description:RenameadatasetvariableinTecplot360.
178
$!RENAMEDATASETZONE
Required Parameters
Parameter
Syntax
Default
Notes
VAR
=<integer>
Specifythevariablenumber.
NAME
=<string>
Specifythenewvariablename.
Example: Renamevariable1tobeBanana:
$!RENAMEDATASETVAR
VAR=1
NAME="Banana"
$!RENAMEDATASETZONE
Syntax:
$!RENAMEDATASETZONE
ZONE=<integer>
NAME=<string>
Description:RenameadatasetzoneinTecplot360.
Required Parameters
Parameter
Syntax
Default
Notes
ZONE
=<integer>
Specifythezonenumber.
NAME
=<string>
Specifythenewzonename.
Example: Renamezone1tobeBanana:
$!RENAMEDATASETZONE
ZONE=1
NAME="Banana"
$!RESET3DAXES
Syntax:
$!RESET3DAXES
[noparameters]
Description:Resettherangesonthe3Daxes.
Example:
$!RESET3DAXES
$!RESET3DORIGIN
Syntax:
$!RESET3DORIGIN
Description:Repositiontherotationoriginin3Dtobeatthespecifiedlocation.
179
$!RESET3DSCALEFACTORS
Optional Parameter
Parameter
ORIGINRESETLOCATION
Syntax
Default
Notes
=<originresetlocation>
Example:
$!RESET3DORIGIN
ORIGINRESETLOCATION=DATACENTER
Syntax:
[noparameters]
Description:Recalculatethescalefactorsforthe3Daxes.Aspectratiolimitsaretakenintoaccount.
Example:
$!RESETVECTORLENGTH
Syntax:
$!RESETVECTORLENGTH
[noparameters]
Description:Resetthelengthofthevectors.Tecplot360willfindthevectorwiththelargestmagnitudeand
setthescalingfactorsoitwillappearonthescreenusingthelengthspecifiedby$!FRAMESETUP
VECTDEFLEN.
Example:
$!RESETVECTORLENGTH
$!ROTATE2DDATA
Syntax:
$!ROTATE2DDATA
ANGLE=<dexp>
Description:Rotatefielddatain2Daboutanypoint.
180
$!ROTATE3DVIEW
Required Parameter
Parameter
ANGLE
Syntax
Default
=<dexp>
Notes
Specifyangleofrotationindegrees.
Optional Parameters
Parameter
Syntax
Default
Notes
ZONELIST
=<set>
Allzones.
Zonestorotate.
=<dexp>
Xorigintorotateabout.
=<dexp>
Yorigintorotateabout.
Example: Rotatezone330degreesaboutthepoint(7,2):
$!ROTATE2DDATA
ANGLE=30
ZONELIST=[3]
X=7
Y=2
$!ROTATE3DVIEW
Syntax:
$!ROTATE3DVIEW<rotateaxis>
ANGLE=<dexp>
Description:Doa3Drotationaboutagivenaxis.The<rotateaxis>mustbesupplied.
Required Parameter
Parameter
ANGLE
Syntax
Default
=<dexp>
Notes
Angletorotate(indegrees).
Optional Parameter
Parameter
ROTATEORIGIN
LOCATION
Syntax
Default
Notes
=
<rotateoriginloc
ation>
VECTORX
=<dexp>
RequiredwhenrotateaxisisABOUTVECTOR.
VECTORY
=<dexp>
VECTORZ
=<dexp>
Example:
$!ROTATE3DVIEWPSI
ANGLE=10
$!RUNMACROFUNCTION
Syntax: $!RUNMACROFUNCTION<string>[<macroparameterlist>]
Description:Executecommandsdefinedinamacrofunction.The<string>referencesthenameofthemacro
functiontorun.Ifthemacrocommandrequiresparameters,thenincludethem(within
parentheses)afterthemacrocommandname.
181
$!SAVELAYOUT
Example:
RunmacrofunctionXYZandpassthevalue7asthefirstparameterandthevalue3.5asthesecond
parameter:
$!RUNMACROFUNCTION"XYZ"(7,3.5)
S
$!SAVELAYOUT
Syntax:
$!SAVELAYOUT<string>
Description:Savethecurrentlayouttoafile.Youmustsupplythefilename.
Optional Parameter
Parameters
Syntax
INCLUDEDATA
Default
Notes
=<boolean>
NO
IfYES,alayoutpackagefilewillbecreated.Theextension.lpk
isrecommended.
INCLUDEPREVIEW
=<boolean>
YES
AppliesonlyifINCLUDEDATAisYES.
USERELATIVEPATHS
=<boolean>
NO
IfYES,allfilesreferencedinthelayoutfilewilluserelative
paths.
Example: Savethecurrentlayouttoafilecalledex1.lay:
$!SAVELAYOUT"ex1.lay"
$!SET3DEYEDISTANCE
Syntax:
$!SET3DEYEDISTANCE
EYEDISTANCE = <dexp>
Description:Setsthedistancefromtheviewertotheplaneofthecurrentcenterofrotation.
Example:
$!SET3DEYEDISTANCE
EYEDISTANCE=13.5
$!SETAUXDATA
Syntax:
$!SETAUXDATA
AUXDATALOCATION=[zone/var/dataset/frame/linemap]
NAME=<string>
VALUESTRING=<string>
Description:AddAuxiliaryDataintheformofname/valuepairstozones,framesordatasets.Thenamemust
beginwithanunderscoreorletter,andmaybefollowedbyoneormoreunderscore,period,letter,
ordigitcharacters.
182
$!SETDATASETTITLE
Required Parameters
Parameter
Syntax
AUXDATALOCATION
=[zone/var/
dataset/frame/
linemap|page]
NAME
=<string>
VALUESTRING
=<string>
Default
Notes
Default
Notes
Optional Parameters
Parameter
Syntax
MAP
=<integer>
OnlyrequiredifAUXDATALOCATION=linemap
VAR
=<integer>
OnlyrequiredifAUXDATALOCATION=var
ZONE
=<integer>
OnlyrequiredifAUXDATALOCATION=zone
Example: SettheselectedAuxiliaryDatatoZone2:
$!SETAUXDATA
ZONE=2
NAME="VARIABLE.DATA"
VALUESTRING="WESTSECTOR"
$!SETDATASETTITLE
Syntax:
$!SETDATASETTITLE<string>
Description:Setthetitleforthecurrentdataset.
Example:
$!SETDATASETTITLE"Mydataset"
$!SETFIELDVALUE
Syntax:
$!SETFIELDVALUE
ZONE=<integer>
VAR=<integer>
INDEX=<integer>
FIELDVALUE=<dexp>
AUTOBRANCH=<boolean>
Description:Specifyafieldvalue(datasetvalue)ataspecifiedpointindex.IfthezonereferencedisIJor
IJKorderedthenthepointindexiscalculatedbytreatingthe2or3Darrayasa1Darray.
183
$!SETFRAMEBACKGROUNDCOLOR
Required Parameters
Parameters
Syntax
AUTOBRANCH
=<boolean>
FIELDVALUE
=<dexp>
INDEX
=<integer>
VAR
=<integer>
ZONE
=<integer>
Default
Notes
Affectssharedvariablesonly.IfYES,thespecifiedzonewillno
longersharethatvariablewiththeotherzones.IfNO,the
variablewillstillbeshared,andthechangetothevariablewill
beshownforallzoneswhereitisshared.
Example:
Adatasetcontains2zonesand3variables.Zone2isdimensioned5by3.Setthevalueforvariable3atIJ
location(2,2)tobe37.5:
$!SETFIELDVALUE
ZONE=2
VAR=3
INDEX=7
FIELDVALUE=37.5
AUTOBRANCH=YES
NotethattheINDEXvaluewascalculatedusing:
INDEX=I+(J1)*|MAXI|+(K1)*|MAXI|*|MAXJ|
=5*(21)+2
=7
$!SETFRAMEBACKGROUNDCOLOR
Syntax: $!SETFRAMEBACKGROUNDCOLOR<color>
Description:Setstheframebackgroundtothespecifiedcolorandsurveysallbasiccolorassignmentsin
Tecplot360,convertingtheallbasiccolorsusingthefollowingrulestoachievethebestcontrast:
1. Foralllinetypebasiccolorsthatmatchthenewbasicframecolor,setthebasiclinecolortothe
bestshowcolorofthebasicframecolor.
2. Forallfilltypebasiccolorsthatmatchthebestshowcolorofthenewbasicframecolor,setthe
fillcolortothenewframecolor.
Exceptions:
1. Forgeometriesandtextboxesifthelineandfillcolorsarethesameandfillingisactivethen
bothlinesandfillfollowthefillrulesabove.
2. Forzone,slice,isosurface,andstreamtraceobjecttypesthebasiccolorshading(i.e.fill)only
followsthefillrulesaboveiflightingeffectsarenotbeingused.
$!SETSTYLEBASE
Syntax:
$!SETSTYLEBASE<stylebase>
[noparameters]
Description:InstructTecplot360onhowtoinitializeframestylevalueswhenanewframeiscreated.During
normaloperation,Tecplot360basesthestyleofanewframeonthefactorydefaultsplusany
changesassignedintheTecplot360configurationfile.Layoutfilesandstylesheetfiles,however,
relyonTecplot360basingnewframesonlyonthefactorydefaults.Thiscommandistypicallynot
184
$!SHARECONNECTIVITY
usedbythecasualuser.
Example: Setthestylebaseforframestousethefactorydefaults:
$!SETSTYLEBASEFACTORY
$!SHARECONNECTIVITY
Syntax:
$!SHARECONNECTIVITY
DESTINATIONZONE= <integer>
Description:Sharethenodemapbetweenthesourceanddestinationzones,presumingthatthezonesareFE
andhavethesameelementtypeandnumberofnodes.
Required Parameters
Parameter
Syntax
DESTINATIONZONE
=<integer>
SOURCEZONE
=<integer>
Default
Notes
Example: Sharestheconnectivityofthesecondzonewiththesixthzone:
$!SHARECONNECTIVITY
SOURCEZONE=2
DESTINATIONZONE=6
$!SHAREFIELDDATAVAR
Syntax:
$!SHAREFIELDDATAVAR
VAR=<integer>
Description:Allowssharingofthespecifiedvariablefromthesourcezonetothedestinationzone.Zonemust
beofthesametype(orderedorFE)anddimensions.CellcenteredvariablesinFEmusthavethe
samenumberofcells.Sharingisnotallowedifeitherzonehasglobalfaceneighbors.
Required Parameters
Parameter
Syntax
DESTINATIONZONE
=<integer>
SOURCEZONE
=<integer>
VAR
=<integer>
Default
Notes
Example: Sharesthethirdvariablefromthesecondzone,withthefifthzone:
$!SHAREFIELDDATAVAR
SOURCEZONE=2
VAR=3
DESTINATIONZONE=5
185
$!SHIFTLINEMAPSTOBOTTOM
$!SHIFTLINEMAPSTOBOTTOM
Syntax:
$!SHIFTLINEMAPSTOBOTTOM<set>
[noparameters]
Description:ShiftalistofLinemappingstothebottomoftheLinemappinglist.Thisineffectcausesthe
selectedLinemappingstobedrawnlast.
Example: ShiftLinemappings2and4tothebottom:
$!SHIFTLINEMAPSTOBOTTOM[2,4]
$!SHIFTLINEMAPSTOTOP
Syntax:
$!SHIFTLINEMAPSTOTOP<set>
[noparameters]
Description:ShiftalistofLinemapstothetopoftheLinemaplist.ThisineffectcausestheselectedLine
mapstobedrawnfirst.
Example: ShiftLinemaps2and4tothetop:
$!SHIFTLINEMAPSTOTOP[2,4]
$!SHOWMOUSEPOINTER
Syntax:
$!SHOWMOUSEPOINTER<boolean>
Description:Themouseiconmaybedeactivatedwithinamacrotoenhancetheonscreenanimation.Itmust
bereactivatedbeforeexitingthemacro.
Example:
$!SHOWMOUSEPOINTERNO
$!LOOP36
$!ROTATE3DVIEWX
ANGLE=5
$!REDRAW
$!ENDLOOP
$!SHOWMOUSEPOINTERYES
$!SKETCHAXIS
Syntax:
$!SKETCHAXIS
Description:ASetValuecommandthatassignsattributesforaxesinasketchmodeframe.Axesarerarely
usedinsketchframes.
186
$!SLICEATTRIBUTES
Optional Parameters
Parameter
AUTOADJUSTRANGES
Syntax
Default
Notes
=<boolean>
NO
AXISMODE
=<axismode>
XYDEPENDENT
SettoINDEPENDENTor
XYDEPENDENT.
DEPXTOYRATIO
<op> <dexp>
=1
AXISMODEmustbeXYDEPENDENT
tousethis.
GRIDAREA
<<gridarea>>
DRAWBORDER=NO,
COLOR=BLACK,
LINETHICKNESS=0.4
PRECISEGRID
<<precisegrid>>
INCLUDE=NO,
SIZE=0.0045,
COLOR=BLACK,
ISFILLED=NO,
FILLCOLOR=WHITE,
DRAWGRIDLAST=
NO
PRESERVEAXISSCALE
=<boolean>
NO
VIEWPORTNICEFIT
=<double>
TONICEVALEUS
BUFFER
VIEWPORTPOSITION
<<rect>>
X1=0,Y1=0,X2=100,Y2=100
VIEWPORTTOPSNAP
=<double>
100
=<double>
10
TARGET
VIEWPORTTOPSNAP
TOLERANCE
XDETAIL
<<axisdetail>>
YDETAIL
<<axisdetail>>
Example: ChangetheaxismodetobeINDEPENDENTforsketchmodeintheactiveframe:
$!SKETCHAXIS
AXISMODE=INDEPENDENT
$!SLICEATTRIBUTES
Syntax:
$!SLICEATTRIBUTES[<slicegroup>]
Description:ASetValuecommandthatchangesglobalattributesassociatedwithslices.
187
$!SLICEATTRIBUTES
Optional Parameters
Parameter
Syntax
Default
Notes
CONTOUR
{
LINEPATTERN
=<linepattern>
SOLID
SHOW
=<boolean>
YES
CONTOURTYPE
=<contourtype>
FLOOD
COLOR
=<color>
SMRAINBOW
LINETHICKNESS
=<double>
0.1
USELIGHTINGEFFECT
=<boolean>
NO
FLOODCOLORING
=<contourcoloring>
GROUP1
LINECONTOURGROUP
=<integer>
PATTERNLENGTH
=<dexp>
}
EDGELAYER
{
EDGETYPE
BORDERS
SHOW
=<boolean>
NO
COLOR
=<color>
BLACK
LINETHICKNESS
<op><double>
=0.4
IBORDER
BOTH
JBORDER
BOTH
KBORDER
BOTH
}
EFFECTS
{
LIGHTINGEFFECT
GOURAUD
SURFACETRANSLUCENCY
=<integer>
10
USETRANSLUCENCY
=<boolean>
YES
USEVALUEBLANKING
=<boolean>
YES
USECLIPPLANES
=<set>
[16]
=<double>
0.95
=<double>
0.95
=<double>
0.95
=<integer>
10
=<integer>
10
=<integer>
10
LINEPATTERN
=<linepattern>
SOLID
PATTERNLENGTH
=<dexp>
SHOW
=<boolean>
NO
COLOR
=<color>
LINETHICKNESS
=<double>
0.1
MESHTYPE
=<meshtype>
OVERLAY
}
ENDPOSITION
{
}
MESH
{
188
CORNERCELLandAVERAGECELL
optionsnotallowedfor
CONTOURTYPE.
$!SLICEATTRIBUTES
Parameter
NUMINTERMEDIATE
Syntax
Default
Notes
=<integer>
OBEYSOURCEBLANKING
=<boolean>
NO
CLIPPLANE
=<clipplane>
NONE
Usesliceasaclippingplane,with
oneoftheclipplanetypes.
OBEYCLIPPLANES
=<boolean>
YES
Clipslicebyanyclippingplanesthat
intersectit.
SLICES
PRIMARYPOSITION
{
X
=<double>
0.5
=<double>
0.5
=<double>
0.5
=<integer>
=<integer>
=<integer>
SHOW
=<boolean>
NO
COLOR
=<color>
BLACK
USELIGHTINGEFFECT
=<boolean>
YES
SHOWGROUP
=<boolean>
YES
SHOWINTERMEDIATE
=<boolean>
NO
SHOWPRIMARYSLICE
=<boolean>
YES
SHOWSTARTENDSLICE
=<boolean>
NO
SLICESURFACE
=<slicesurface>
XPLANES
=<double>
0.05
=<double>
0.05
=<double>
0.05
=<integer>
=<integer>
=<integer>
}
SHADE
{
SLICES
STARTPOSITION
{
}
SURFACEEFFECTS
{
LIGHTINGEFFECT
=<lightingeffect>
SURFACETRANSLUCENCY
=<translucency>
USETRANSLUCENCY
=<boolean>
}
VECTOR
{
SHOW
=<boolean>
NO
COLOR
=<color>
BLACK
ISTANGENT
=<boolean>
NO
LINETHICKNESS
=<double>
0.1
VECTORTYPE
=<vectortype>
TAILATPOINT
ARROWHEADSTYLE
=<arrowheadstyle>
PLAIN
PATTERNLENGTH
=<dexp>
189
$!SLICELAYERS
Parameter
Syntax
LINEPATTERN
Default
=<linepattern>
Notes
SOLID
Example:
$!SLICEATTRIBUTESENDPOSITION{X=1}
$!SLICEATTRIBUTESSTARTPOSITION{X=6}
$!SLICEATTRIBUTESNUMINTERMEDIATESLICES=6
$!SLICEATTRIBUTESSHOWSTARTENDSLICE=YES
$!SLICEATTRIBUTESSHOWINTERMEDIATESLICES=YES
$!REDRAW
$!CREATESLICEZONES
$!SLICELAYERS
Syntax: $!SLICELAYERSHOW=<boolean>
Description:Turnslicingonoroff.
Required Parameters
Parameter
Syntax
Default
SHOW
=<boolean>
NO
SHOWMESH
=<boolean>
YES
SHOWCONTOUR
=<boolean>
YES
SHOWVECTOR
=<boolean>
YES
SHOWSHADE
=<boolean>
YES
SHOWEDGE
=<boolean>
YES
USETRANSLUCENCY
=<boolean>
YES
USELIGHTINGEFFECT
=<boolean>
YES
Notes
Note:
Whenslicesareactivated,theyarecoloredusingthecontourvariablebydefault.Whenyouactivateslices
viathemacrolanguageyoumustperformoneofthefollowingstepsinorderfortheslicestobevisiblein
yourfinalplot:
Setthecontourvariablebyaddingthefollowingcommandtoyourmacrofile(priortocalling
$!SLICELAYER).
$!GLOBALCONTOURnVAR=m
wherenisthecontourgroupnumberandmisthenumberofthevariabletousefor
contouring.
or
SetCONTOURSHOW=NOviathe$!SLICEATTRIBUTEScommand.Ifyouchoosethis
option,youmaywanttoturnonshadingtoimprovethevisibilityofyourslice.
$!SMOOTH
Syntax:
190
$!SMOOTH
ZONE=<set>
$!STREAMATTRIBUTES
VAR=<set>
Description:Smoothdata(reducethespikes)forselectedvariablesinselectedzones.
Required Parameters
Parameter
Syntax
Default
Notes
ZONE
=<set>
Zonestosmooth.
VAR
=<set>
Variablestosmooth.ThesecannotbeXorYifin2DorZifin
3DandtheymustbeadependentvariableinXYplots.
Optional Parameters
Parameter
Syntax
Default
NUMSMOOTHPASSES
=<integer>
SMOOTHWEIGHT
=<dexp>
0.8
SMOOTHBNDRYCOND
=
<boundarycondi
tion>
FIXED
Notes
Example: Smoothvariable3inzone2:
$!SMOOTH
ZONE=2
VAR=3
NUMSMOOTHPASSES=5
SMOOTHBNDRYCOND=ZERO2ND
$!STREAMATTRIBUTES
Syntax:
$!STREAMATTRIBUTES
Description:ASetValuecommandthatchangesglobalattributesassociatedwithstreamtraces.
191
$!STREAMATTRIBUTES
Optional Parameters
Parameter
Syntax
Default
ADDARROWS
=<boolean>
YES
Notes
ARROWHEADSIZE
<op><dexp>
=1.2
ARROWHEADSPACING
<op><double>
=10
Distancebetweenarrowheadsin
frameunits.
CELLFRACTION
<op><dexp>
=0.25
Maximumfractionofthedistance
acrossacellastreamtracemovesin
onestep.Astreamtraceadjustsits
stepsizebetweenCELLFRACTION
andMINCELLFRACTION
dependingonlocalcurvatureofthe
streamtrace.
COLOR
=<color>
BLACK
LINETHICKNESS
=0.1
MAXSTEPS
<op><dexp>
<op><integer>
MINCELLFRACTION
<op><dexp>
=1x10005
OBEYSOURCEZONE
=<boolean>
NO
=<boolean>
NO
Clipstreamtracesbyanyclipping
planesthatintersectthestreamtraces.
<op><dexp>
<op><integer>
=0.01
Valueisgridunits.
=3
Numberofpointsusedtodefinethe
streamrodcrosssection.
SHOW
=<boolean>
NO
COLOR
=<color>
=10,000
Minimumfractionofthedistance
acrossacellastreamtracemovesin
onestep.
BLANKING
OBEYCLIPPLANES
RODRIBBON
{
WIDTH
NUMRODPOINTS
MESH
{
LINETHICKNESS
<op><dexp>
=0.1
MESHTYPE
=<meshtype>
OVERLAY
LINEPATTERN
=<linepattern>
SOLID
PATTERNLENGTH
=<dexp>
SHOW
=<boolean>
NO
USELIGHTINGEFFECT
=<boolean>
YES
FLOODCOLORING
=<contourcoloring>
GROUP1
CONTOURTYPE
=<contourtype>
FLOOD
LINECONTOURGROUP
=<integer>
LINEPATTERN
=<linepattern>
SOLID
PATTERNLENGTH
=<dexp>
LINETHICKNESS
=<dexp>
0.1
SHOW
=<boolean>
YES
COLOR
=<color>
USELIGHTINGEFFECT
=<boolean>
}
CONTOUR
{
}
SHADE
{
}
EFFECTS
{
192
YES
$!STREAMTRACE [Required-Control Option]
Parameter
Syntax
Default
LIGHTINGEFFECT
=<lightingeffect>
GOURAUD
SURFACETRANSLUCENCY
=<translucency>
50
USETRANSLUCENCY
=<boolean>
NO
USEVALUEBLANKING
=<boolean>
YES
USECLIPPLANES
=<set>
[16]
=<boolean>
YES
SHOWDASHES
=<boolean>
NO
SHOWMARKERS
=<boolean>
NO
MARKCOLOR
=<color>
BLACK
MARKSIZE
<op><dexp>
=1
DASHSKIP
<op><integer>
=1
MARKSYMBOL
<<symbolshape>>
ISASCII=NO,
GEOMSHAPE=
SQUARE
TIMESTART
=<double>
1x10150
TIMEEND
=<double>
1x10150
TIMEANCHOR
=<double>
TIMEDELTA
=<double>
1x10150
Notes
}
}
SHOWPATHS
STREAMTIMING
{
}
TERMLINE
{
ISACTIVE
=<boolean>
NO
SHOW
=<boolean>
YES
COLOR
=<color>
BLACK
LINEPATTERN
=<linepattern>
SOLID
PATTERNLENGTH
<op> <dexp>
<op> <dexp>
=2
LINETHICKNESS
=0.1
$!STREAMTRACE [Required-Control Option]
Description:ThedifferentcommandsintheSTREAMTRACEcompoundfunctionfamilyaredescribed
TheSTREAMTRACEcompoundfunctionfamilyis:
$!STREAMTRACEADD
$!STREAMTRACEDELETALL
$!STREAMTRACEDELETERANGE
$!STREAMTRACERESETDELTATIME
$!STREAMTRACESETTERMINATIONLINE
$!STREAMTRACE ADD
Syntax:
$!STREAMTRACEADD
Description:Addasinglestreamtraceorarakeofstreamtracestotheactiveframe.Theframemustbea2Dor
193
$!STREAMTRACE ADD
3Dfieldplot.
Optional Parameters
Parameters
Syntax
Default
ALTSTARTPOS
Notes
ThisisrequiredifNUMPTSisgreaterthan1orifthe
streamtypeisavolumerodorvolumeribbon.
{
X
=<dexp>
0.0
=<dexp>
0.0
=<dexp>
0.0
DIRECTION
=
<streamdirection
>
FORWARD
NUMPTS
=<integer>
STARTPOS
Use1toaddasinglestreamtrace.Usen,n>1forarakeof
streamtraces.
Zisnecessaryonlyifdealingwitha3Dstreamtrace.
{
X
=<dexp>
0.0
=<dexp>
0.0
=<dexp>
0.0
=<streamtype>
}
STREAMTYPE
a. Tecplot 360 determines the default streamtype based on a number of factors. It is best to always supply this
parameter.
Example 1:
Addarakeof5streamtracesina2Dfieldplot:
$!STREAMTRACEADD
NUMPTS=5
STREAMTYPE=TWODLINE
STARTPOS
{
X=0.5
Y=0.5
}
ALTSTARTPOS
{
X=0.5
Y=1.5
}
Example 2:
Addasinglevolumeribbon.StarttheribbonorientedparalleltotheZaxis:
$!STREAMTRACEADD
STREAMTYPE=VOLUMERIBBON
STARTPOS
{
X=3.0
Y=4.0
Z=1.0
}
ALTSTARTPOS
194
$!STREAMTRACE DELETEALL
{
X=3.0
Y=4.0
Z=8.0
}
$!STREAMTRACE DELETEALL
Syntax:
$!STREAMTRACEDELETEALL
[noparameters]
Description:Deletesallstreamtracesintheactiveframe.Iftheframemodeis2D,all2Dstreamtracesare
deleted.Iftheframemodeis3D,all3Dstreamtracesaredeleted.
Example:
$!STREAMTRACEDELETEALL
$!STREAMTRACE DELETERANGE
Syntax:
Description:Deletearangeofstreamtraces.Streamtracesarenumberedsequentiallyintheordertheywere
created.
Optional Parameters
Parameters
Syntax
Default
RANGESTART
=<integer>
RANGEEND
=<integer>
Notes
Example: Deletestreamtraces35:
RANGESTART=3
RANGEEND=5
$!STREAMTRACE RESETDELTATIME
Syntax:
[noparameters]
Description:Resetthetimedeltafordashedstreamtraces.Thedeltatimeisresetsuchthatastreamdashin
thevicinityofthemaximumvectormagnitudewillhavealengthapproximatelyequalto10
percentoftheframewidth.
Example:
195
$!STREAMTRACE SETTERMINATIONLINE
$!STREAMTRACE SETTERMINATIONLINE
Syntax:
<xyrawdata>
Description:Setthepositionoftheterminationlineforstreamtraces.
Required Parameter
Parameters
Syntax
Default
<xyrawdata>
Notes
In3D,theterminationlineisdefinedintheeyecoordinate
system.
Example: Settheterminationlineusing3points:
RAWDATA
3
40 70
50 90
50 30
$!STREAMTRACELAYERS
Syntax: $!STREAMTRACELAYERSSHOW=<boolean>
Description:Turnstreamtracesonoroff.
Required Parameters
Parameter
Syntax
Default
SHOW
=<boolean>
NO
SHOWPATHS
=<boolean>
YES
SHOWDASHES
=<boolean>
YES
SHOWARROWHEADS
=<boolean>
YES
SHOWMESH
=<boolean>
YES
SHOWCONTOUR
=<boolean>
YES
SHOWSHADE
=<boolean>
YES
SHOWMARKERS
=<boolean>
YES
USETRANSLUCENCY
=<boolean>
YES
USELIGHTINGEFFECT
=<boolean>
YES
Notes
$!SYSTEM
Syntax:
$!SYSTEM<string>
Description:InstructTecplot360tosubmitacommandtotheoperatingsystem.Forsecurityreasons,
executionofthe$!SYSTEMcommandcanbedisabledtopreventunauthorizedexecutionofsystem
commandsviamacros.UsetheOKTOEXECUTESYSTEMCOMMANDoptiontothe$!INTERFACEmacro
command.
196
$!THREEDAXIS
Example: Submitthesystemcommandtocopythefilet7.plttoxxx.plt(UNIX):
$!SYSTEM"cpt7.pltxxx.plt"
Example: Submitthesystemcommandtocopythefilet7.plttoxxx.plt(WINDOWS):
$!SYSTEM"cmd/ct7.pltxxx.plt"
Optional Parameters
Parameter
WAIT
Syntax
=<boolean>
Default
Notes
YES
IfYES,Tecplot360willwaituntiltheexecutionofthesystem
commandhascompletedbeforecontinuing.
T
$!THREEDAXIS
Syntax:
$!THREEDAXIS
Description:ASetValuecommandthatassignsattributesforaxesina3Dframe.
197
$!THREEDVIEW
Optional Parameters
Parameter
ASPECTRATIOLIMIT
Syntax
Default
Notes
=25
Restricttheaspectratioofthedata.
=2
Setaspectratioforthedatatothis
valuewhen
ASPECTRATIOLIMITisexceeded.
ASPECTRATIORESET
<op><dexp>
<op><dexp>
AXISMODE
=<axismode>
BOXASPECTRATIOLIMIT
<op><dexp>
=25
Restricttheaspectratiooftheaxis
box.
BOXASPECTRATIORESET
<op><dexp>
=2
Setaspectratiofortheaxisboxtothis
valuewhenASPECTRATIOLIMITis
exceeded.
DEPXTOYRATIO
<op><dexp>
AXISMODEmustbeDEPENDENT
tousethis.
DEPXTOZRATIO
<op><dexp>
AXISMODEmustbeDEPENDENT
tousethis.
EDGEAUTORESET
=<boolean>
MakeTecplot360automatically
chooseedgestolabel.
SettoINDEPENDENT,
XYDEPENDENT,or
XYZDEPENDENT.
FRAMEAXIS
{
SHOW
=<boolean>
SIZE
<op><dexp>
<op><dexp>
LINETHICKNESS
COLOR
=<color>
<<xy>>
XYPOS
}
GRIDAREA
<<gridarea>>
PRESERVEAXISSCALE
=<boolean>
WHENRANGEISCHANGED
XDETAIL
<<axisdetail>>
XYDEPXTOYRATIO
<op><dexp>
YDETAIL
<<axisdetail>>
ZDETAIL
<<axisdetail>>
AXISMODEmustbe
XYDEPENDENTtousethis.
Example:
ChangesthevariableassignedtotheZaxistobevariablenumber2.
TurnsoffautoedgeassignmentandmakeaxislabelingfortheYaxisoccuronedge2.
$!THREEDAXIS
ZVAR=2
EDGEAUTORESET=NO
YEDGE=2
$!THREEDVIEW
Syntax:
$!THREEDVIEW
Description:ASetValuecommandthatchangesglobalattributesassociatedwiththe3Dview.
198
$!TRANSFORMCOORDINATES
Optional Parameters
Parameter
Syntax
Default
ALPHAANGLE
<op><dexp>
=0
NO
DRAWINPERSPECTIVE
=<boolean>
FIELDOFVIEW
<op><dexp>
Notes
Angleisindegrees.
PSIANGLE
<op><dexp>
=60
Angleisindegrees.
THETAANGLE
<op><dexp>
=240
Angleisindegrees.
VIEWERPOSITION
<<xyz>>
SeeNotes
X=8.073,Y=4.873,Z=5.549
VIEWWIDTH
<op><dexp>
=1.74267
Example:
Switchestoperspective.
Changesthefieldofview.
Rotatesaroundpsiby20degrees.
Changestheviewerposition.
$!THREEDVIEW
DRAWNINPERSPECTIVE=YES
FIELDOFVIEW=100
PSIANGLE+=20
VIEWERPOSITION
{
X=1.26
Y=1.25
Z=0.74
}
Syntax:
TRANSFORMATION=<transformation>
Description:Transformsallpointsinoneormorezonesfromonecoordinatesystemtoanother.
Tecplot 360 versions 2006 R2 and earlier incorrectly recorded the
$!TRANSFORMCOORDINATES command. In these versions, the variable number options
in this command were recorded as zero-based values instead of one-based values.
Macros or layout files created with any of these versions and containing
$!TRANSFORMCOORDINATES should increment each variable sub-command option by
one in order to operate correctly with Tecplot 360 versions 2008 and newer.
199
$!TRIANGULATE
Required Parameter
Parameters
TRANSFORMATION
Syntax
Default
=<transformation>
Notes
Transformation.
Optional Parameters
Parameter
Syntax
Default
Notes
ANGLESPEC
=<anglespec>
RADIANS
Specifieswhetherdataisindegreesorradians
CREATENEW
=<boolean>
NO
IfYES,thennewvariablesX,Y,Zwillbecreatedifconvertingto
rectangularcoordinates,orR,THETA,PHIifconvertingto
spherical.IfNO,thenyoumustspecifytheoutputvariables.
VARIABLES
PSIVAR
=<integer>
PSIvariablenumber.REQUIREDifthetransformationis
sphericaltorectangularorifCREATENEWVARIABLESisNO.
RVAR
=<integer>
Rvariablenumber.REQUIREDifthetransformationispolarto
rectangularorsphericaltorectangularorif
CREATENEWVARIABLESisNO.
THETAVAR
=<integer>
XVAR
=<integer>
Xvariablenumber.REQUIREDifthetransformationis
rectangulartopolarorrectangulartosphericalor
YVAR
=<integer>
Yvariablenumber.REQUIREDifthetransformationis
rectangulartopolarorrectangulartosphericalor
ZONELIST
=<set>
ZVAR
=<integer>
NONE
allzones
Thetavariablenumber.REQUIREDifthetransformationis
polartorectangularorsphericaltorectangularorif
Setofzonestooperateon.
Zvariablenumber.REQUIREDifthetransformationor
rectangulartosphericalorCREATENEWVARIABLESisNO.
Example:
Transformdatafromrectangularcoordinatestopolarcoordinatesspecifyinganglesindegreesand
creatingnewvariables.
TRANSFORMATION=RECTTOPOLAR
ANGLESPEC=DEGREES
CREATENEWVARIABLES=YES
XVAR=2
YVAR=3
$!TRIANGULATE
Syntax:
$!TRIANGULATE
Description:Createanewzonebyformingtrianglesfromdatapointsinexistingzones.
200
$!TWODAXIS
Parameters
Syntax
Default
BOUNDARYZONES
=<set>
INCLUDEBOUNDARY
=<boolean>
NO
SOURCEZONES
=<set>
Allzones.
TRIANGLEKEEP
=<dexp>
0.25
=<boolean>
NO
Notes
RequiredifUSEBOUNDARYisYES.
SettoYESifyoualsowanttheboundarypointstobeusedto
createtriangles.
PTS
FACTOR
USEBOUNDARY
SpecifyoneormoreIorderedzonesthatdefineboundaries
acrosswhichnotrianglescanbecreated.
Example: Createazonebytriangulatingdatapointsfromzones1and2:
$!TRIANGULATE
SOURCEZONES=[1,2]
$!TWODAXIS
Syntax:
$!TWODAXIS
Description:ASetValuecommandthatassignsattributesforaxesina2Dframe.
Optional Parameters
Parameter
AUTOADJUSTRANGES
Syntax
Default
Notes
=<boolean>
TONICEVALUES
AXISMODE
<axismode>
SettoINDEPENDENTor
XYDEPENDENT
DEPXTOYRATIO
<op> <dexp>
AXISMODEmustbe
XYDEPENDENTtousethis.
GRIDAREA
<<gridarea>>
PRECISEGRID
<<precisegrid>>
PRESERVEAXISSCALE
=<boolean>
WHENRANGEISCHANGED
VIEWPORTNICEFIT
=<double>
BUFFER
VIEWPORTPOSTITION
<<rect>>
VIEWPORTTOPSNAP
=<integer>
100
=<integer>
10
XDETAIL
<<axisdetail>>
VARNUM=1
YDETAIL
<<axisdetail>>
VARNUM=2
TARGET
VIEWPORTTOPSNAP
TOLERANCE
Example: SettheXaxistousevariable3fora2Dplot:
$!TWODAXIS
XDETAIL{VARNUM=3}
201
$!VARSET
V
$!VARSET
Syntax:
$!VARSET<macrovar><op><dexp>
[noparameters]
or
$!VARSET<macrovar>=<string>
[noparameters]
Description:Assignavaluetoamacrovariable.Ifthemacrovariabledidnotexistpriortothiscommand,
thenitisdefinedhere.Amacrovariablecanbeassignedavalueorastring.
Examples:
Example 1:
Setthemacrovariable|myvar|to3:
$!VARSET|myvar|=3
Example 2:
Add2tothemacrovariable|myvar|:
$!VARSET|myvar|+=2
Example 3:
Setthemacrovariable|File1|tobemyfile.plt:
$!VARSET|File1|="myfile.plt"
Example 4:
Setthemacrovariable|F1|toequal|V2|+|V3|,where|V2|and|V3|arepredefinedvariables:
$!VARSET|V2|=4
$!VARSET|V3|=5
$!VARSET|F1|=(|V2|+|V3|)
$!VIEW [Required-Control Option]
Description:
ThedifferentcommandsintheVIEWcompoundfunctionfamilyaredescribedseparatelyinthe
followingsections.
TheVIEWcompoundfunctionfamilyis:
$!VIEWAXISFIT
$!VIEWAXISMAKECURRENTVALUESNICE
$!VIEWAXISNICEFIT
$!VIEWCENTER
$!VIEWCOPY
$!VIEWDATAFIT
$!VIEWFIT
202
$!VIEW AXISFIT
$!VIEWFITSURFACES
$!VIEWLAST
$!VIEWMAKECURRENTVIEWNICE
$!VIEWNICEFIT
$!VIEWPASTE
$!VIEWPUSH
$!VIEWRESETTOENTIRECIRCLE
$!VIEWSETMAGNIFICATION
$!VIEWTRANSLATE
$!VIEWZOOM
$!VIEW AXISFIT
Syntax:
$!VIEWAXISFIT
Description:Resettherangeonaspecificaxissothatitequalstheminimumandmaximumofthedatabeing
plotted.Iftheaxisdependencyisnotindependentthenthisactionmayalsoaffecttherangeon
anotheraxis.
Optional Parameters
Parameter
Syntax
Default
Notes
AXIS
=<xyaxis>
DefaultisTforpolarplottype.
AXISNUM
=<integer>
OnlyXYframemodeallowsforthistobeanumbergreater
than1.
Example: ResettherangeontheYaxistofitthedatabeingplotted:
$!VIEWAXISFIT
AXIS=Y
$!VIEW AXISMAKECURRENTAXISVALUESNICE
Syntax:
$!VIEWAXISMAKECURRENTAXISVALUESNICE
Description:Resettheaxislinelabelvaluessuchthatallcurrentlydisplayedvaluesaresettohavethe
smallestnumberofsignificantdigitspossible.
Optional Parameters
Parameter
Syntax
Default
Notes
AXIS
=<xyaxis>
AXISNUM
=<integer>
OnlyXYlineplotsallowforthistobeanumbergreaterthan1.
Example: SettherangeontheZaxistohavenicevaluesfortheaxislabels:
$!VIEWAXISMAKECURRENTAXISVALUESNICE
AXIS=Z
$!VIEW AXISNICEFIT
Syntax:
$!VIEWAXISNICEFIT
203
$!VIEW CENTER
Description:Resettherangeonaspecificaxissothatitequalstheminimumandmaximumofthedatabeing
plotted,butmakestheaxisvaluesnicebysettinglabelstohavethesmallestnumberof
significantdigitspossible.Iftheaxisdependencyisnotindependentthenthisactionmayalso
affecttherangeonanotheraxis.
Parameter
Syntax
Default
Notes
AXIS
=<xyaxis>
AXISNUM
=<integer>
OnlyXYframemodeallowsforthistobeanumbergreater
than1.
Example:
ResettherangeontheYaxistofitthedatabeingplotted,withnicevaluesontheaxisline:
$!VIEWAXISNICEFIT
AXIS=Y
$!VIEW CENTER
Syntax:
$!VIEWCENTER
[noparameters]
Description:Centerthedatawithintheaxisgridarea.
$!VIEW COPY
Syntax:
$!VIEWCOPY
[noparameters]
Description:Copythecurrentviewtotheviewpastebuffer.Seealso$!VIEWPASTE.
$!VIEW DATAFIT
Syntax:
$!VIEWDATAFIT
[noparameters]
Description:Fitthecurrentsetofdatazonesorlinemappingsbeingplottedwithinthegridarea.Thisdoes
nottakeintoconsiderationtextorgeometries.
$!VIEW FIT
Syntax:
$!VIEWFIT
[noparameters]
Description:Fittheentireplottothegridarea.Thisalsotakesintoconsiderationtextandgeometriesthatare
plottedusingthegridcoordinatesystem.In3D,thisalsoincludestheaxes.
204
$!VIEW FITSURFACES
$!VIEW FITSURFACES
Syntax:
$!VIEWFITSURFACES
[noparameters]
Description:Fitsactiveplotsurfacestothegridarea.3Dvolumezonesareexcludedwhensurfacestoplotare
settonone.See$!FIELDMAPformoreinformationonsettingsurfacestoplot.
$!VIEW LAST
Syntax:
$!VIEWLAST
[noparameters]
Description:Retrievethepreviousviewfromtheviewstack.Eachframemodewithineachframemaintains
itsownviewstack.$!VIEWLASTwillnotreversealterationstodata.
$!VIEW MAKECURRENTVIEWNICE
Syntax:
$!VIEWMAKECURRENTVIEWNICE
[noparameters]
Description:Shiftsaxistomakeaxislinevaluesnicewithoutchangingtheextentsofthewindow.Only
worksinSketch/XY/2D.
$!VIEW NICEFIT
Syntax:
$!VIEWNICEFIT
[noparameters]
Description:Changeviewtomaketheextentsoftheframeneatlyholdtheplotwithintegervaluesforaxis
labels.OnlyworksinSketch/XY/2D.
$!VIEW PASTE
Syntax:
$!VIEWPASTE
[noparameters]
Description:Retrievetheviewfromtheviewpastebufferandassignittotheactiveframe.
$!VIEW PUSH
Syntax:
$!VIEWPUSH
[noparameters]
Description:InstructTecplot360topushthecurrentviewontotheviewstack.Aviewwillnotbepushedif
thecurrentviewisthesameasthetopviewonthestack.NotethatcommandsVIEWAXISFIT,
VIEWCENTER,VIEWDATAFIT,VIEWFIT,andVIEWZOOMautomaticallypushaviewontothestack.
Tecplot360automaticallypushesthecurrentviewontothestackwhena$!REDRAWcommandis
issuedandthecurrentviewisdifferentfromthetopviewontheviewstack.
205
$!VIEW RESETTOENTIRECIRCLE
$!VIEW RESETTOENTIRECIRCLE
Syntax:
$!VIEWRESETTOENTIRECIRCLE
[noparameters]
Description:ResettheThetaRAxistoinitialsettings.ForPolarplotsonly.
$!VIEW SETMAGNIFICATION
Syntax:
MAGNIFICATION=<dexp>
Description:Setthemagnificationforthedatabeingplotted.Amagnificationof1willsizetheplotsoitcan
fitwithinthegridarea.
Required Parameter
Parameter
MAGNIFICATION
Syntax
Default
Notes
=<dexp>
Example: Maketheplottobedrawnonehalfasbigaswhenitfitswithinthegridarea:
MAGNIFICATION=0.5
$!VIEW TRANSLATE
Syntax:
$!VIEWTRANSLATE
X=<dexp>
Y=<dexp>
Description:ShiftthedatabeingplottedintheXand/orYdirection.Theamounttranslatedisinframeunits.
Required Parameters
Parameter
Syntax
Default
Notes
=<dexp>
0.0
AmounttotranslateinXframeunits.
=<dexp>
0.0
AmounttotranslateinYframeunits.
Example: Translatetheview10percentoftheframewidthtotheright:
$!VIEWTRANSLATE
X=10
Y=0
$!VIEW ZOOM
Syntax:
206
$!VIEWZOOM
X1=<dexp>
Y1=<dexp>
X2=<dexp>
Y2=<dexp>
$!WHILE...$!ENDWHILE
Description:Changetheviewbyzoomingintothedata.InSketch,XY,and2Dframemodeplots,Tecplot
360willadjusttherangesontheaxistoviewtheregiondefinedbytherectanglewithcornersat
(X1,Y1)and(X2,Y2).For3Dorthographicplots,theviewistranslatedandscaledtofittheregion.
For3Dperspectiveplots,theviewisrotatedabouttheviewerandscaledtofittheregion.X1and
sofortharemeasuredingridcoordinates.
Required Parameters
Parameter
Syntax
X1
=<dexp>
Y1
=<dexp>
X2
=<dexp>
Y2
=<dexp>
Default
Notes
Example: Zoomsotherectangularregionwithcornersat(1,0)and(7,9)areinview:
$!VIEWZOOM
X1=1
Y1=0
X2=7
Y2=9
W-X
$!WHILE...$!ENDWHILE
Syntax:$!WHILE<conditionalexp>
.$!ENDWHILE
Description:ContinuetoexecuteasetofcommandsuntilaconditionalexpressionisNO.
Example: Executeasetofcommandsuntilthemacrovariable|myvar|isgreaterthan1.0:
$!VARSET|myvar|=0.0
$!WHILE|myvar|<1.0
$!VARSET|myvar|+=0.01
$!ENDWHILE
$!WORKSPACEVIEW [Required-Control Option]
Description:ThedifferentcommandsintheWORKSPACEVIEWcompoundfunctionfamilyaredescribed
TheWORKSPACEVIEWcompoundfunctionsare:
$!WORKSPACEVIEWFITALLFRAMES
$!WORKSPACEVIEWFITPAPER
$!WORKSPACEVIEWFITSELECTEDFRAMES
$!WORKSPACEVIEWLASTVIEW
$!WORKSPACEVIEWMAXIMIZE
$!WORKSPACEVIEWTRANSLATE
$!WORKSPACEVIEWUNMAXIMIZE
$!WORKSPACEVIEWZOOM
207
$!WORKSPACEVIEW FITALLFRAMES
$!WORKSPACEVIEW FITALLFRAMES
Syntax:
$!WORKSPACEVIEWFITALLFRAMES
[noparameters]
Description:Changetheviewintheworkspacesoallframesarefitjustinsidetheedgesoftheworkspace.
$!WORKSPACEVIEW FITPAPER
Syntax:
$!WORKSPACEVIEWFITPAPER
[noparameters]
Description:Changetheviewintheworkspacesotheentirepaperisfitjustinsidetheedgesofthe
workspace.
$!WORKSPACEVIEW FITSELECTEDFRAMES
Syntax:
$!WORKSPACEVIEWFITSELECTEDFRAMES
[noparameters]
Description:Changetheviewintheworkspacesothecurrentlyselectedframes(thatis,theframeswithpick
handles)arefitjustinsidetheedgesoftheworkspace.
$!WORKSPACEVIEW LASTVIEW
Syntax:
$!WORKSPACEVIEWLASTVIEW
[noparameters]
Description:Returntothepreviousworkspaceview.
$!WORKSPACEVIEW MAXIMIZE
Syntax:
$!WORKSPACEVIEWMAXIMIZE
[noparameters]
Description:Temporarilyexpandtheworkareaaslargeaspossible.Themaximizedworkareaoccupiesthe
entireTecplot360processwindow.
$!WORKSPACEVIEW TRANSLATE
Syntax:
X=<dexp>
Y=<dexp>
Description:Shifttheviewoftheworkspace.Thishasnoeffectonthelocalviewwithinanyframeinyour
layout.
208
$!WORKSPACEVIEW UNMAXIMIZE
Required Parameters
Parameter
Syntax
Default
Notes
=<dexp>
Valueisininches.
=<dexp>
Valueisininches.
Example:
Shifttheworkspaceviewtotheleftby2inches(asmeasuredbytheworkspaceruler):
X=2
Y=0
$!WORKSPACEVIEW UNMAXIMIZE
Syntax:
$!WORKSPACEVIEWUNMAXIMIZE
[noparameters]
Description:Returnstheworkspacetoitsnormalsizeafterithasbeenexpandedafter$!WORKSPACEMAXIMIZE
hasbeenused.
$!WORKSPACEVIEW ZOOM
Syntax:
$!WORKSPACEVIEWZOOM
X1=<dexp>
Y1=<dexp>
X2=<dexp>
Y2=<dexp>
Description:Changetheviewintotheworkarea.Thishasnoeffectonthelocalviewwithinanyframein
yourlayout.
Required Parameters
Parameter
Syntax
X1
=<dexp>
Y1
=<dexp>
X2
=<dexp>
Y2
=<dexp>
Default
Notes
Example:
Maketheregioninthelowerleftcornerofan8.5by11paperbeviewableintheworkarea.Thepaperisin
portraitorientation:
$!WORKSPACEVIEWZOOM
X1=0
Y1=5.5
X2=4.25
Y2=9.75
209
$!WRITECOLORMAP
$!WRITECOLORMAP
Syntax:
$!WRITECOLORMAP<string>
[noparameters]
Description:Writethecurrentcolormaptoafile.The<string>isthenameofthefiletowriteto.
Example:
$!WRITECOLORMAP"mycolors.map"
$!WRITECURVEINFO
Syntax:
$!WRITECURVEINFO<string>
SOURCEMAP=<integer>
Description:Writeoutthecurvedetailsorthecalculateddatapointsfortheequation(s)usedtodrawthe
curveforaselectedlinemapping.The<string>isthenameofthefiletowriteto.
Required Parameter
Parameter
Syntax
SOURCEMAP
Default
=<integer>
Notes
Thismustbethenumberofalinemappingthatdoessome
typeofcurvefitorspline.
Optional Parameter
Parameters
Syntax
CURVEINFOMODE
=
<curveinfomode
>
Default
CURVE
DETAILS
Notes
UseCURVEDETAILSorCURVEPOINTS.
Example: WriteoutthecoefficientsforXYlinemappingnumber3tomap3.out:
$!WRITECURVEINFO"map3.out"
SOURCEMAP=3
CURVEINFOMODE=CURVEDETAILS
$!WRITEDATASET
Syntax:
$!WRITEDATASET<string>
Description:Writethedatasetattachedtotheactiveframetoafile.The<string>isthenameofthefiletowrite
to.
210
$!WRITESTYLESHEET
Optional Parameters
Parameters
ASSOCIATELAYOUT
Syntax
Default
Notes
=<boolean>
YES
BINARY
=<boolean>
YES
INCLUDEAUTOGEN
=<boolean>
NO
=<boolean>
YES
INCLUDEDATA
=<boolean>
YES
INCLUDEDATASHAREL
INKAGE
=<boolean>
NO
INCLUDEGEOM
=<boolean>
YES
INCLUDETEXT
=<boolean>
YES
PRECISION
=<integer>
12
OnlyusedifASCII(thatis,BINARYisNO).
TECPLOTVERSION
=<string>
TecplotCurrent
Optionaldesignationofbinaryfileversion.Possiblevaluesare
TecplotCurrent,Tecplot2009,Tecplot2008,andTecplot2006.
OnlyusedifASCII(thatis,BINARYisNO).
WITHDATAFILE
IfNO,youcanincludePRECISIONandUSEPOINTFORMAT.
FACENEIGHBORS
INCLUDECUSTOM
LABELS
TOWRITE
USEPOINTFORMAT
=<boolean>
NO
VARPOSITIONLIST
=<set>
Allvars.
Usethistolimitthenumberofvariableswrittenout.
ZONELIST
=<set>
Allzones.
Usethistolimitthenumberofzoneswrittenout.
Example: Writeoutonlyzone3toafilecalledzone3.plt:
$!WRITEDATASET"zone3.plt"
INCLUDETEXT=NO
INCLUDEGEOM=NO
INCLUDECUSTOMLABELS=NO
ZONELIST=[3]
$!WRITESTYLESHEET
Syntax:
$!WRITESTYLESHEET<string>
Description:Writethestylefortheactiveframetoafile.The<string>isthenameofthefiletowriteto.
211
$!XYLINEAXIS
Optional Parameters
Parameters
Syntax
INCLUDECONTOUR
Default
=<boolean>
YES
INCLUDETEXT
=<boolean>
YES
INCLUDEGEOM
=<boolean>
YES
INCLUDEPLOTSTYLE
=<boolean>
YES
INCLUDESTREAMPOSI
TIONS
=<boolean>
YES
INCLUDEFACTORY
=<boolean>
NO
Notes
LEVELS
DEFAULTS
USERELATIVEPATHS
=<boolean>
INCLUDEAUXDATA
=<boolean>
YES
Example: Writeoutastylesheetfortheactiveframetof1.sty:
$!WRITESTYLESHEET"f1.sty"
INCLUDEFACTORYDEFAULTS=YES
$!XYLINEAXIS
Syntax:
$!XYLINEAXIS
Description:ASetValuecommandthatassignsattributesforaxesinanXYLineplot.
Optional Parameters
Parameter
Syntax
AUTOADJUSTRANGES
Default
Notes
=<boolean>
NO
AXISMODE
<axismode>
INDEPENDENT
SettoINDEPENDENTorXYDEPENDENT.
DEPXTOYRATIO
<op><dexp>
=1
AXISMODEmustbeXYDEPENDENTtousethis.Thisapplies
onlytotheX1andY1axes.
GRIDAREA
<<gridarea>>
<<precisegrid>>
SeeNotes
DRAWBORDER=N0,COLOR=BLACK,LINETHICKNESS=0.4
PRECISEGRID
SeeNotes
INCLUDE=NO,SIZE=0.0045,COLOR=BLACK,
ISFILLED=NO,FILLCOLOR=WHITE,DRAWGRIDLAST=NO
PRESERVEAXISSCALE
=<boolean>
NO
VIEWPORTNICEFIT
=<double>
TONICEVALUES
Between1and100.
BUFFER
VIEWPORTPOSITION
VIEWPORTTOPSNAP
SeeNotes
=<integer>
100
=<integer>
10
X1=13,Y1=11,X2=8,Y=88
TARGET
VIEWPORTTOPSNAP
TOLERANCE
XDETAIL
<integer>
<<axisdetail>>
The<integer>optionspecifieswhichaxistooperateon,1n
5.
YDETAIL
<integer>
<<axisdetail>>
The<integer>optionspecifieswhichaxistooperateon,1n
5.
Example:
SettheaxismodetobeindependentfortheXYaxes(notethatthisaffectsonlyX1versusY1):
$!XYLINEAXIS
AXISMODE=INDEPENDENT
212
10
Macro Commands for the Analyze
Menu
AllofthemacrocommandsassociatedwiththeAnalyzemenuareembeddedwithinTecplot360s
EXTENDEDCOMMANDmacro.Thesyntaxofthismacroisshownbelow:
$!EXTENDEDCOMMAND
COMMANDPROCESSORID=<string>
COMMAND=<string>
Thefirst<string>isatextstringshouldbesettoCFDAnalyzer3.Thesecondstringissenttooneoftheaddons
listedbelow.
10 - 1
Summary of Analyze Macro Commands
ANIMATESTREAKLINESmaybeusedfollowingastreaklinecalculationtoanimatethestreaklines,eithertothe
screenortoafile.
ATTACHINTEGRATIONRESULTSisusedfollowinganintegrationtocreateatextfieldandattachittothecurrent
Tecplot360frame.ThismacrohasthesameeffectasclickingMakeTextontheIntegrationResultstext
dialog.
Note:ItisnotnecessarytodirectthemacrotodisplaytheIntegrationResultsdialoginordertoattachor
savetheresults.
CALCPARTICLEPATHcalculatesparticlepathsorstreaklinesforsteadyorunsteadyflowsolutions,usingthe
locationofanyexistingstreamtracesasstartinglocationsfortheparticles.Particlesmayhavemassorbe
massless.
CALCTURBULENCEFUNCTIONcalculatesanyoffourturbulencerelatedfunctions,givenanytwoinyourdataset.
CALCULATEcalculatesaPLOT3Dfunction.Thenameofthisfunctionmustbespecifiedintheshortened
formlistedinSection103ParameterAssignmentValues.
CALCULATEACCURACYusesRichardsonextrapolationtoestimatetheorderaccuracyofthesolution,giventhe
solutiononthreegridsofsuccessivelyfinerresolution.IfeitheroftheplottingoptionsaresettoTRUE,the
resultingTecplot360frameswillbeinfrontafterexecutingthiscommand.
213
ANIMATESTREAKLINES
DISPLAYBOUNDARIESdisplayszoneboundariesinanewframeaccordingtosettingsmadebythe
SETGEOMETRYANDBOUNDARIESmacro.Eachboundaryofeach3Dzone(in3DCartesianplots)or2Dzone(in2D
Cartesianplots)isdisplayedandnamedaccordingtotheboundaryconditionappliedtoit.Boundaries
thatareconnectedtotheboundariesofadjacentzonesarenamedassuch.
EXTRACTFLOWFEATUREdisplaysshocksurfaces,vortexcores,orseparationandattachmentlinesfor3Dflow
solutions.Separationandattachmentlinesareonlycalculatedonnoslipwallboundariesidentifiedbythe
SETGEOMETRYANDBOUNDARIESmacro.Shocksurfacesaredisplayedasisosurfacesofanewvariable,
ShockFeature,whiletheremainingfeaturesaredisplayedasnewzones.
EXTRAPOLATESOLUTIONperformsRichardsonextrapolationtoestimatethetruesolutionfromthreeinput
solutionsongridsofsuccessivelyfinerresolution.Itsavestheextrapolatedsolutionasanewzoneinthe
currentdataset.Italsosavesanadditionalzonecontainingthedifferencebetweenthissolutionandthe
originalsolution.
INTEGRATEperformsanintegration.AllIntegratedialogoptionsareavailabletothismacro,includingthe
displayoptions.IfthePLOTRESULTSparameterissettoTRUE,thentheTecplot360frameshowingthe
integrationresultsistheactiveframefollowingthiscommand.
SAVEINTEGRATIONRESULTShasthesameeffectasclickingSaveontheIntegrationResultsdialogandselecting
afile.TheresultsaresavedtothefilenamedbytheFILEparameter.
SETFIELDVARIABLESidentifiesvariablesinyourdata,suchasvelocity,pressureandtemperature,forusein
analysis.
SETFLUIDPROPERTIESsetsthepropertiesofthefluid,suchasviscosity.Theseareusedbysomeactionsofthe
CALCULATEandINTEGRATEcommands.
SETGEOMETRYANDBOUNDARIESidentifiesboundariesofzonesinaflowsolutionandtheboundaryconditions
appliedtothem.Italsospecifieswhetherzoneswithcoincidentboundarynodesshouldbeconsidered
connectedatthosepoints,aswellaswhether2Dsolutionsshouldberegardedasaxisymmetric.
SETREFERENCEVALUESsetsthereference(freestream)propertiesofthesolution.Thisinformationisusedby
othercalculations.
SETUNSTEADYFLOWOPTIONSidentifiessolutiontimelevelsforunsteadyflowsolutions.Thisinformationisused
forparticlepathandstreaklinecalculations.
10 - 2
Macro Command Description
Thesyntax,mandatoryandoptionalparametersforeachofthemacrocommandslistedinSection101
aredescribedbelow.Itemswithinsingleanglebrackets(<>)aredefinedinSection103.
The COMMAND strings below must be contained on a single line in your macro command
file, although they appear on multiple lines below.
ANIMATESTREAKLINES
Syntax:$!EXTENDEDCOMMAND
COMMANDPROCESSORID=CFDANALYZER3
COMMAND=ANIMATESTREAKLINES
Description:Animatespreviouslycalculatedstreaklinestothescreenortoafile.
214
ATTACHINTEGRATIONRESULTS
Parameter
Syntax
Default
DESTINATION
=<string>
SCREEN
FILENAME
=<string>
WIDTH
SPEED
=<integer>
=<double>
300
10.0
USEMULTIPLECOLO
R
=<boolean>
FALSE
=<boolean>
FALSE
Notes
Specifiesthedestinationoftheanimation.MaybeSCREEN,
AVIFILEorRASTERMETAFILE.
Thenameofthefiletowhichtosavetheanimation.Mustbe
specifiedforDESTINATIONvaluesofAVIFILEor
RASTERMETAFILE.
Thewidthoftheanimationwhensavedtoafile.
Thespeedinframespersecondoftheanimation.Onlyused
foranimationssavedtoanAVIfile.
Specifieswhetheranimationssavedtoafileshouldinclude
onecolortableforeachframe.Thedefaultistouseasingle
colortable.
TABLES
INCLUDEZONE
ANIMATION
Syntax:
$!EXTENDEDCOMMAND
COMMANDPROCESSORID=CFDAnalyzer3
COMMAND=ATTACHINTEGRATIONRESULTS
Description:Attachthetextresultsofthepreviousintegrationasatextfieldintheactiveframe.
CALCPARTICLEPATH
Syntax:
$!EXTENDEDCOMMAND
COMMAND=CALCPARTICLEPATH
Description:Calculateparticlepathsorstreaklines,startingfromexistingTecplot360streamtraces.
215
CALCPARTICLEPATH
Parameter
Syntax
Default
=<particlefunction>
TIMESTEP
=<double>
Theintegrationtimestepforthe
calculation.
MAXTIMESTEPS
RELEASEFREQ
=<integer>
1000
1
Forsteadystatecalculationsonly.
RELEASEOPTION
=<releaseoption>
HAVEMASS
=<double>
PARTICLEPATH
Notes
FUNCTION
CanbePARTICLEPATHor
STREAKLINE.
ForFUNCTION=STREAKLINE.
Indicatesthenumberofparticlesto
releaseintheindicatedtimeperiod
(seethenextparameter).
TIMELEVEL
ForFUNCTION=STREAKLINE.If
TIMELEVEL,indicatesthat
RELEASEFREQparticlesshouldbe
releasedeverysolutiontimelevel.If
UNITTIME,indicatesthatthis
numberofparticlesshouldbe
releasedinaunitamountofsolution
time.
=<boolean>
FALSE
IfTRUE,particleshavemass;specify
theparticlemassoptionsbelow.
CREATESINGLEZONE
=<boolean>
FALSE
ForFUNCTION=PARTICLEPATH
only,specifiesthatallparticlepaths
shouldbecombinedintoasingleIJ
orderedzone.
STOREOPTION
=<storeoption>
PARTICLEVALUES
IfPARTICLEVALUES,theparticles
velocity,massandtemperature(if
calculated)willbestoredinplaceof
appropriatefluidvaluesinthe
particlepathszone.If
FLUIDVALUES,allfluidvaluesthe
particlepassedthroughwillbe
storedinthezone.
COEFFS
=<coeffsoption>
GENERAL
IfGENERAL,specify
BALLISTICCOEFF,plus
TEMPTIMECONSTifcalculating
particletemperature.IfDETAILED,
specifyMASS,RADIUS,and
DRAGCOEFF,plusSPECIFICHEAT
andNUSSELTifcalculating
temperature.Onlyappliesif
HAVEMASS=TRUE.
CALCTEMPERATURE
=<boolean>
FALSE
IfTRUE,particletemperaturewillbe
calculated.Onlyappliesif
HAVEMASS=TRUE.
GRAVITYCONSTANT
=<double>
0.0
Theaccelerationduetogravity.Only
appliesifHAVEMASS=TRUE.
GRAVITYDIRECTION
=<gravitydirection>
INITIALVELOCITYOPTI
ON
=<initialvelocityoption>
BALLISTICCOEFF
TEMPTIMECONST
MINUSX
Theaxisdirectioninwhichgravity
acts.OnlyappliesifHAVEMASS=
TRUE.
LOCALFLUIDVELOCITY
Theinitialvelocityofparticles.
OptionsareLOCALFLUIDVELOCITY
andZEROVELOCITY.Onlyappliesif
HAVEMASS=TRUE.
=<double>
1.0
ForGENERALcoefficientsonly,the
ballisticcoefficientoftheparticle.
OnlyappliesifHAVEMASS=TRUE.
=<double>
1.0
ForGENERALcoefficientswith
CALCTEMPERATURE=TRUEonly,
thetemperaturerelaxationfactorof
theparticle.Onlyappliesif
HAVEMASS=TRUE.
MASS
=<double>
1.0
ForDETAILEDcoefficientsonly,the
particlemass.Onlyappliesif
HAVEMASS=TRUE.
RADIUS
=<double>
1.0
ForDETAILEDcoefficientsonly,the
particleinitialradius.Onlyappliesif
HAVEMASS=TRUE.
216
CALCPARTICLEPATH
Parameter
Syntax
Default
DRAGCOEFFOPTION
=<specifyoption>
SPECIFY
DRAGCOEFF
=<double>
1.0
Notes
ForDETAILEDcoefficientsonly.If
SPECIFY,specifyDRAGCOEFF.If
CALCULATE,Tecplot360will
calculatethedragcoefficient.Only
ForDETAILEDcoefficientsonly,with
DRAGCOEFFOPTION=SPECIFY,the
particledragcoefficient.Onlyapplies
ifHAVEMASS=TRUE.
SPECIFICHEAT
=<double>
1.0
ForDETAILEDcoefficientswith
CALCTEMPERATURE=TRUEonly,
theparticlespecificheat.Only
NUSSELTOPTION
=<specifyoption>
NUSSELT
=<double>
SPECIFY
CALCTEMPERATURE=TRUEonly.If
SPECIFY,specifyNUSSELT.If
CALCULATE,Tecplot360will
calculatetheNusseltnumber.Only
1.0
CALCTEMPERATURE=TRUEand
NUSSELTOPTION=SPECIFYonly,
theparticleNusseltnumber.Only
TERMOPTION
=<terminationoption>
TEMPERATURE
CALCTEMPERATURE=TRUEonly(is
alwaysTEMPERATUREforgeneral
coefficients),theparticletermination
option.MaybeTEMPERATUREor
ABLATE.OnlyappliesifHAVEMASS=
TRUE.
TEMPERATURE
=<double>
1.0
IfTERMOPTION=TEMPERATURE,the
particleterminationtemperature.If
TERMOPTION=ABLATE,the
ablationtemperature.Onlyappliesif
HAVEMASS=TRUE.
LATENTHEAT
=<double>
1.0
ForTERMOPTION=ABLATEonly,
thelatentheatoftheablativeprocess.
OnlyappliesifHAVEMASS=TRUE.
Example 1:Calculatestreaklineswithanintegrationtimestepof0.1,releasingeightparticlesper
unitsolutiontime:
$!EXTENDEDCOMMAND
FUNCTION=STREAKLINE
TIMESTEP=0.1 RELEASEFREQ=8
RELEASEOPTION=UNITTIME
Example 2:Calculateparticlepaths,includingtemperaturewithablation,inasteadystateflowfor
particleswithaninitialmassof3E14,aninitialradiusof1.5E6andaspecificheatof703.Use
atimestepof1E6.HaveTecplot360calculatethedragcoefficientandtheNusseltnumber.
Useanablationtemperatureof2,250andalatentheatof1.5E5:
$!EXTENDEDCOMMAND
TIMESTEP=1.0e6
HAVEMASS=TRUE
COEFFS=DETAILED
CALCTEMPERATURE=TRUE
MASS=3e14
217
CALCTURBULENCEFUNCTION
RADIUS=1.5e6
DRAGCOEFFOPTION=CALCULATE
SPECIFICHEAT=703
NUSSELTOPTION=CALCULATE
TERMOPTION=ABLATE
TEMPERATURE=2250
LATENTHEAT=1.5e5
Syntax:
$!EXTENDEDCOMMAND
COMMAND=CALCTURBULENCEFUNCTION
Description:Calculateaturbulencerelatedfunctionfromtwovariablesinthecurrentdataset.Addtheresult
tothedatasetasanewvariableusingthefunctionsname,oroverwritethevariableifitalready
exists.
Parameter
Syntax
Default
Notes
CALCULATEONDEMAND
=<boolean>
FUNCTION
=<turbulencefunction>
FREQUENCY
MaybeENERGY,DISSIPATIONRATE,
FREQUENCY,orVISCOSITY.
ID1
ENERGY
Theturbulencequantitythefirstdata
setvariablerepresents.
VARIABLE1
=<integer>
ID2
VARIABLE2
=<integer>
VALUELOCATION
=<valuelocation>
FALSE
Thenumberofthefirstdataset
variable.
DISSIPATIONRATE
Theturbulencequantitythesecond
datasetvariablerepresents.
Thenumberoftheseconddataset
variable.
NODAL
Thelocationofnewvariablesadded
tothedataset.CanbeNODALor
CELLCENTERED.
Example:Calculateturbulentkinematicviscosityfromturbulentkineticenergy,variable5,and
turbulentfrequency,variable6:
$!EXTENDEDCOMMAND
COMMAND=CALCTURBULENCEFUNCTION
FUNCTION=VISCOSITY
VARIABLE1=5
ID2=FREQUENCYVARIABLE2=6
CALCULATE
Syntax:
$!EXTENDEDCOMMAND
COMMAND=CALCULATEFUNCTION=<functionname>
Description:CalculateaTecplot360variableusingthespecifiedfunctionandaddittothecurrentdataset.If
thevariablealreadyexistsinthecurrentdataset,itwillberecalculated.
218
CALCULATEACCURACY
Required Parameter:
Parameter
Syntax
FUNCTION
Default
=
<functionname>
Notes
Indicatesthefunctiontobeusedtocalculatethevariable.Ifitis
avectorfunction,thecomponentswillbestoredasXname,Y
name,andZname,wherenameisthefunctionname
appearingintheinterface.
Optional Parameter:
Parameter
Syntax
Default
NORMALIZATION
=
<normalizationo
ption>
NONE
VALUELOCATION
=<valuelocation>
NODAL
CALCULATEONDEMAND
=<boolean>
Notes
MaybeNONE,MAXIMUMMAGNITUDEorREFERENCEVALUES.
Thelocationofnewvariablesaddedtothedataset.Canbe
NODALorCELLCENTERED.
FALSE
Example 1:CalculatetheJacobianforthegridofthecurrentdataset:
$!EXTENDEDCOMMAND
COMMAND=CALCULATEFUNCTION=JACOBIAN
Example 2:Calculatethepressurecoefficientforthecurrentdataset.Thefreestreamdensityand
speedofsoundare1.0(thedefaults):
$!EXTENDEDCOMMAND
COMMAND=CALCULATE
FUNCTION=PRESSURECOEF
CALCULATEACCURACY
Syntax:
$!EXTENDEDCOMMAND
COMMAND=CALCULATEACCURACYZONES=[<set>]
Description:Calculatetheorderaccuracyofthesolutioncontainedinthelistedzones.Optionally,plotthe
overallaccuracyversusgridspacingandplottheaccuracyateachgridnode.
219
DISPLAYBOUNDARIES
Required Parameter:
Parameter
Syntax
ZONES
Default
=<set>
Notes
Indicatesthethreezonesfromwhichtoperformtheaccuracy
calculation.
ParameterSyn
tax
Syntax
Default
Notes
MAXACCURACY
=<double>
2.0
DATASETVAR
=<integer>
PLOTDETAILED
=<boolean>
FALSE
ACCURACY
PLOTOVERALL
IfTRUE,anewframewillbecreatedcontainingtheaccuracy
calculatedateachgridnode.
=<boolean>
FALSE
IfTRUE,anewframewillbecreatedcontainingthe1normand
maxnormoftheestimatederrorforeachsolutionzoneplotted
versusgridresolution.
ACCURACY
Themaximumtheoreticalaccuracyofthesolverwhich
generatedthesolution.Usedtolimitthecalculatedaccuracy.
Thedatasetvariablewithwhichtoperformtheaccuracy
calculation.
Example:Calculatetheaccuracyusingzones3,4and5,alongwithdatasetvariable7,plottingthe
overallaccuracy:
$!EXTENDEDCOMMAND
COMMAND=CALCULATEACCURACY ZONES=[35]
DATASETVAR=7
PLOTOVERALLACCURACY=TRUE
DISPLAYBOUNDARIES
Syntax:
$!EXTENDEDCOMMAND
COMMAND=DISPLAYBOUNDARIES
[RAWDATA
<boundaryrawdata>]
Description:Displaysboundariescorrespondingtoageometryandboundariesspecificationwithoutactually
settingthegeometryandboundaries.Thismacroisgenerallynotusefulforthosewritingmacro
files,butisrecordedwhentheuserclickstheDisplayBoundariesbuttonintheGeometryand
BoundariesdialoginordertoduplicatetheactionsofTecplot360thathappeninresponsetothat
action.SeeSectionSETGEOMETRYANDBOUNDARIESonpage 226foradescriptionof
theparametersforthismacro.
EXTRACTFLOWFEATURE
Syntax:
$!EXTENDEDCOMMAND
COMMAND=EXTRACTFLOWFEATURE
Description:Extractanddisplayshocksurfaces,vortexcores,orseparationandattachmentlines.Shock
surfacesaredisplayedasisosurfacesofanewvariable,ShockSurface,whilevortexcoresand
separationandattachmentlinesaredisplayedasnewzones.
220
EXTRAPOLATESOLUTION
Parameter
Syntax
Feature
=<flowfeature>
VCOREMETHOD
=<vcoremethod>
EXCLUDEBLANKED
=<boolean>
Default
SHOCKSURFACE
S
EIGENMODES
FALSE
Notes
CanbeSHOCKSURFACES,VORTEXCORES,orSEPATTACHLINES.
Thevortexcoreextractionmethod.CanbeVORTICITYor
EIGENMODES.
IfTRUE,vortexcoresandseparation/attachmentlineswillnot
becalculatedinblankedregions.
Example:Extractvortexcoresusingtheeigenmodesmethod:
$!EXTENDEDCOMMAND
COMMAND=EXTRACTFLOWFEATURE
FEATURE=VORTEXCORES
VCOREMETHOD=EIGENMODES
EXTRAPOLATESOLUTION
Syntax:
$!EXTENDEDCOMMAND
COMMAND=EXTRAPOLATESOLUTIONZONES=<set>
[MAXACCURACY=<double>]
Description:PerformRichardsonextrapolationtoestimatethetruesolutionfromthreeinputsolutionson
gridsofsuccessivelyfinerresolution.Twonewzonesareaddedtothecurrentdataset.Thefirst
containstheextrapolatedsolution,whilethesecondcontainstheestimatederror.
Required Parameter:
Parameter
ZONES
Syntax
Default
=<set>
Notes
Indicatesthethreezonesfromwhichtoperformtheaccuracy
calculation.
Optional Parameter:
Parameter
MAXACCURACY
Syntax
=<double>
Default
2.0
Notes
Themaximumtheoreticalaccuracyofthesolverwhich
generatedthesolution.Usedtolimitthecalculatedaccuracy.
Example:Extrapolatezones3,4,and5,whichwerecalculatedwithasecondorderaccuratesolver:
$!EXTENDEDCOMMAND
COMMAND=EXTRAPOLATESOLUTION
ZONES=[35]
MAXACCURACY=2
INTEGRATE
Syntax:
$!EXTENDEDCOMMAND
COMMAND=INTEGRATE[<set>][optionalparameters]
Description:Performanintegrationoverthespecifiedzones.If<set>isnotspecified,theintegrationwillbe
performedoverallzones.IfPLOTASissettoTRUE,theintegrationresultswillbeplottedinanew
221
INTEGRATE
frame.
Syntax
Default
VARIABLEOPTION
Parameter
=
<variableoption>
SCALAR
XORIGIN
=<double>
0.0
ForVARIABLEOPTION=FORCESANDMOMENTS,indicatestheorigin
Xlocationformomentcalculations.
YORIGIN
=<double>
0.0
Ylocationformomentcalculations.
ZORIGIN
=<double>
0.0
Zlocationformomentcalculations.
SCALARVAR
=<integer>
ForwhenVARIABLEOPTION=AVERAGE,MASSWEIGHTEDAVERAGE,
WEIGHTEDAVERAGE,MASSFLOWWEIGHTEDAVERAGE,or
VECTORAVERAGE.Indicateswhichvariablesaveragewillbe
calculated.
ABSOLUTE
=<boolean>
FALSE
IfTRUE,theabsolutevalueofcellvolumeswillbeusedfor
integration.
EXCLUDEBLANKED
XVARIABLE
=<boolean>
IfTRUE,integrationwillonlyincludenonblankedregions.
=<integer>
FALSE
0
YVARIABLE
=<integer>
Onlyrequiredforvectorintegrations.IndicatestheY
componentofthevectorvariabletobeintegrated.
ZVARIABLE
=<integer>
Onlyrequiredforvectorintegrations.IndicatestheZ
componentofthevectorvariabletobeintegrated.
INTEGRATEOVER
=
<integrationopti
on>
CELLVOLUMES
Notes
DatasetpositionofthescalarvariableorXcomponentofthe
vectorvariabletobeintegrated.
Specifiescellvolumes,planes,orlines.
IRANGE
{
MIN
=<integer>
MAX
=<integer>
SKIP
=<integer>
0
1
=<integer>
=<integer>
0
1
}
JRANGE
{
MIN
MAX
SKIP
}
KRANGE
{
MIN
MAX
SKIP
}
PLOTRESULTS
PLOTAS
=<integer>
=<integer>
=<integer>
=<integer>
0
1
=<boolean>
FALSE
Indicatedwhethertheresultsoftheintegrationwillbeplotted
inaTecplot360frame.
Results
Thevariablenameusedtoplotintegrationresults.Ifitcontains
spaces,surrounditwithquotesprecededbyabackslash(\).
Ignoredforforcesandmoments.
=<string>
Range Parameters: TheIrange,JrangeandKrangeparametersareusedtolimitthedata

alteredbytheequation.Thespecificationofrangeindicesfollowtherulesbelow.
Allindicesstartwithoneandgotosomemaximumindexm.
222
SAVEINTEGRATIONRESULTS
Zerocanbeusedtorepresentthemaximumindexm;specifyingzerotellsthecommandtogo
totheverylastpositionoftherange,thatis,themaximumindexvaluem.Ifthemaximum
indexm =15,specifyingzerosetstherangeindexto15.
Negativevaluesrepresenttheoffsetfromthemaximumindex.Ifavalueof2isspecified,and
themaximumindexmis14,thevalueusedis142,or12.
You can access your integration results in macros through a variety of specific
environment variables. For a list of the variables and how to access them, refer to
Section 22 - 7.2 Accessing Integration Results in Macros in the Users Manual
Examples:
Example 1:
Thefollowingcommandcalculatesthemassforallzonesbyintegratingdensity(variable4)overcell
volumes:
$!EXTENDEDCOMMAND
COMMAND=INTEGRATESCALARVAR=4
Example 2:
CalculatethemassfluxacrossaseriesofI=constantplanesforzones1,2,and3andplotstheresults
asMassFlux.Sincethe COMMANDstringissurroundedbysinglequotationmarks(),thequotessur
roundingthePLOTASparametermustbeprecededbyabackslashtoavoidasyntaxerror:
$!EXTENDEDCOMMAND
COMMAND=INTEGRATE[13]VARIABLEOPTION=MASSFLOWRATEINTEGRATEOVER=
IPLANESPLOTRESULTS=TRUEPLOTAS=\MassFlux\
Example 3:
Calculatethemassweightedaverage(actuallythemassflowweightedaverage)oftotalpressure,
variable7:
$!EXTENDEDCOMMAND
COMMAND=INTEGRATE [13] VARIABLEOPTION=MASSFLOWWEIGHTEDAVERAGE
SCALARVAR=7INTEGRATEOVER=IPLANESPLOTRESULTS=TRUEPLOTAS=\Mass
WeightedAvgPt\
Syntax:
$!EXTENDEDCOMMAND
COMMAND=SAVEINTEGRATIONRESULTS
FILENAME=<string>
Description:Savesthemostrecentlycalculatedintegrationresultstoatextfile.
223
SETFIELDVARIABLES
Required parameter:
Parameter
FILENAME
Syntax
Notes
=<string>
Indicatesthenameofthefiletowhichtosavetheresults.It
maybeaneworexistingfile.
Example:SavethemostrecentintegrationresultstofileE:\users\dave\results.txt.Thebackslash
characters(\)mustbeescapedwithasecondbackslashcharacter,andthefilenameis
surroundedbyquotes():
$!EXTENDEDCOMMAND
COMMAND=SAVEINTEGRATIONRESULTS
FILENAME=E:\\users\\dave\\results.txt
SETFIELDVARIABLES
Syntax:
$!EXTENDEDCOMMAND
COMMAND=SETFIELDVARIABLES
Description:Identifiesvariablesinyourdata,suchasvelocity,pressureandtemperature,foruseinanalysis.
Parameter
Default
Notes
CONVECTIONVARSA
REMOMENTUM
=<boolean>
Syntax
TRUE
IndicateswhetherthevariablesdesignatedforTecplot360
vectorplotsaremomentumvariables(density*velocity).If
FALSE,thenthevectorvariablesmustrepresentvelocityvalues.
UVar
=<integer>
Specifythevariable(bynumber)touseforthefirstVector/
Momentumvariable.
VVar
=<integer>
Specifythevariable(bynumber)touseforthesecondVector/
Momentumvariable.
WVar
=<integer>
Specifythevariable(bynumber)touseforthesecondVector/
Momentumvariable.
ID1
=<varid>
NOTUSED
Identificationofthefirstdatasetvariablefromwhichthe
functionwillbecalculated.
ID2
=<varid>
NOTUSED
Identificationoftheseconddatasetvariablefromwhichthe
functionwillbecalculated.
VARIABLE1
=<integer>
Positionofthefirstvariableinthedataset.
VARIABLE2
=<integer>
Positionofthesecondvariableinthedataset.
SETFLUIDPROPERTIES
Syntax:
$!EXTENDEDCOMMAND
COMMAND=SETFLUIDPROPERTIES[optionalparameters]
Description:Setthefluidpropertiesforusebyothercommands.
224
SETFLUIDPROPERTIES
Parameter
Syntax
Default
INCOMPRESSIBLE
DENSITY
=<boolean>
=<double>
FALSE
1.0
SPECIFICHEAT
=<double>
2.5
USESPECIFICHEAT
=<boolean>
VAR
SPECIFICHEATVAR
=<integer>
GASCONSTANT
=<double>
1.0
USEGASCONSTANTV
AR
GASCONSTANTVAR
=<boolean>
FALSE
=<integer>
GAMMA
=<double>
1.4
USEGAMMAVAR
GAMMAVAR
=<boolean>
FALSE
1
VISCOSITY
USEVISCOSITYVAR
VISCOSITYVAR
=<double>
CONDUCTIVITY
USECONDUCTIVITY
=<double>
=<integer>
FALSE
Notes
IfTRUE,indicatesanincompressiblefluid.
ForINCOMPRESSIBLE=TRUE,indicatesthedensityofthe
fluid.
ForINCOMPRESSIBLE=TRUE.Thevalueofthefluids
specificheat.
ForINCOMPRESSIBLE=TRUE.
ForINCOMPRESSIBLE=TRUEand
USESPECIFICHEATVAR=TRUE.Thedatasetvariablethat
holdsthefluidsspecificheat.
ForINCOMPRESSIBLE=FALSE.Thevalueofthefluids
specificgasconstant.
ForINCOMPRESSIBLE=FALSE.
ForINCOMPRESSIBLE=FALSEand
USEGASCONSTANTVAR=TRUE.Thedatasetvariablewhich
holdsthefluidsspecificgasconstant.
ForINCOMPRESSIBLE=FALSE.Thevalueofthefluids
ratioofspecificheats.Mustbebetween1and5/3.
ForINCOMPRESSIBLE=FALSE.
ForINCOMPRESSIBLE=FALSEandUSEGAMMAVAR=
TRUE.Thedatasetvariablethatholdsthefluidsratioof
specificheats.
VAR
CONDUCTIVITYVAR
=<boolean>
=<integer>
1.0
FALSE
1
=<boolean>
1.0
FALSE
=<integer>
Thevalueofthefluidsdynamicviscosity.
ForUSEVISCOSITYVAR=TRUE.Thedatasetvariablewhich
holdsthefluidsdynamicviscosity.
Thevalueofthefluidsconductivity.
ForUSECONDUCTIVITYVAR=TRUE.Thedatasetvariable
whichholdsthefluidsconductivity.
Example 1:Setthefluidpropertiestostandardairvaluesinmeters/kilograms/secondsunits:
$!EXTENDEDCOMMAND
COMMAND=SETFLUIDPROPERTIES
GASCONSTANT=287
VISCOSITY=17.8E6
CONDUCTIVITY=2.48E2
Example 2:Setthefluidpropertiestoincompressiblewithdensityequalto1.0(thedefault)and
specificheat,viscosityandconductivitytakenfromdatasetvariables5,6,and7:
$!EXTENDEDCOMMAND
COMMAND=SETFLUIDPROPERTIES
INCOMPRESSIBLE=TRUE
SPECIFICHEATOPTION=DATASETVAR
SPECIFICHEATVAR=5
VISCOSITYOPTION=DATASETVAR
VISCOSITYVAR=6
CONDUCTIVITYOPTION=DATASETVAR
CONDUCTIVITYVAR=7
225
SETGEOMETRYANDBOUNDARIES
Syntax:
$!EXTENDEDCOMMAND
COMMAND=SETGEOMETRYANDBOUNDARIES
[RAWDATA
<boundaryrawdata>]
Description:Specifywhetherthedatarepresentanaxisymmetricflowsolution(2DCartesianplotsonly),
whetheradjacentzonesshouldbeconsideredtobeconnectedatcoincidentfaces,andspecifyzone
boundariesandtheircorrespondingboundaryconditions.EachlineoftheRAWDATAdescribesone
boundary,andappearsinthesameformatasontheGeometryandBoundariesdialog.Forall
boundaries,listtheboundaryconditionandthesetofzones,separatedbyacomma.Theindex
rangetypeboundaryfollowsthiswiththeboundaryface,thefirststartingindex,thefirstending
index,thesecondstartingindexandthesecondendingindex.Allentriesareseparatedbycommas.
TheboundaryconditionisoneofINFLOW,OUTFLOW,WALL,SLIPWALL,SYMMETRY,EXTRAPOLATED.The
boundaryfaceisoneofI=1,I=IMAX,J=1,J=JMAX,K=1,andK=KMAX.RefertoSection224Setting
GeometryandBoundaryOptionsintheUsersManualformoreinformationonboundaries.
Parameter
Syntax
Default
FALSE
Notes
AXISYMMETRIC
=<boolean>
SYMMETRYVAR
=<XorY>
SYMMETRYVALUE
=<double>
0.0
CONNECTZONES
=<boolean>
TRUE
NODETOLERANCE
=<double>
1.0E6
Indicateshowclosetwonodesmustbebeforetheywillbe
consideredcoincidentforthepurposeofmatchingzonefaces.
DEFAULTBC
=<string>
EXTRAPOLATED
Indicatestheboundaryconditionthatwillbeappliedtoall
zoneboundaryfacesnotconnectedtoadjacentzonesor
coveredbyzoneboundariesdefinedbytheRAWDATAsection.
CanonlybeTRUEifthecurrentplottypeis2DCartesian.If
TRUE,indicatesthatthedatarepresentsanaxisymmetric
solution.
ForAXISYMMETRIC=TRUE.CanbeXorY.Indicateswhich
axisvariableisconstantalongtheaxisofsymmetry.
ForAXISYMMETRIC=TRUE.Indicatesthevalueofthe
SYMMETRYVARalongtheaxisofsymmetry.
IfTRUE,indicatesthatadjacentzonesshouldbeconnected
whereboundaryfacescoincide.
Example:SpecifythatthesolutiondatarepresentsanaxisymmetricsolutionaboutX=1.Donot
allowadjacentzonestobeconnected.Identifytwozonetypeboundariesandonezone,face
andindexrangetypeboundary:
$!EXTENDEDCOMMAND
COMMAND=SETGEOMETRYANDBOUNDARIES
AXISYMMETRIC=TRUE
SYMMETRYVAR=X
SYMMETRYVALUE=1
CONNECTZONES=FALSE
RAWDATA
WALL,[23]
INFLOW,[4]
OUTFLOW,[1],I=IMAX,1,10,1,20
SETREFERENCEVALUES
Syntax:
226
$!EXTENDEDCOMMAND
SETUNSTEADYFLOWOPTIONS
COMMAND=SETREFERENCEVALUES
Description:Specifythereference(freestream)propertiesofthesolution,identifytwovariablesinthe
currentdatasetforusewithothercommands.
Default
Notes
RVELOCITY1ID
Parameter
=<string>
Syntax
MACHNUMBER
Identificationofthefirstfreestreamvelocitycomponent.May
beUVELOCITYor
MACHNUMBER.
RVELOCITY1
RVELOCITY2ID
=<double>
=<string>
0.0
ANGLEOFATTAC
K
RVELOCITY2
=<double>
0.0
RTHERMO1ID
=<string>
DENSITY
RTHERMO1
RTHERMO2ID
=<double>
=<string>
1.0
SPEEDOFSOUND
RTHERMO2
=<double>
1.0
Thevalueofthefirstfreestreamvelocitycomponent.
Identificationofthesecondfreestreamvelocitycomponent.
MaybeVVELOCITYor
ANGLEOFATTACK.
Thevalueofthesecondfreestreamvelocitycomponent.
NOTE:RVELOCITY1mustbedefinedbeforeusing
RVELOCITY2.
Identificationofthefirstfreestreamthermodynamicvariable.
MaybePRESSUREor
DENSITY.
Thevalueofthefirstfreestreamthermodynamicvariable.
Identificationofthesecondfreestreamthermodynamic
variable.MaybeTEMPERATUREorSPEEDOFSOUND.
Thevalueofthesecondfreestreamthermodynamicvariable.
Syntax:
$!EXTENDEDCOMMAND
COMMANDPROCESSORID=CFDANALYZER3
COMMAND=SETUNSTEADYFLOWOPTIONS
[SteadyState=<boolean>]
[RAWDATA
<timelevelrawdata>]
Description:Identifiestimelevelsforunsteadyflow,orspecifiesthatthesolutionissteadystate.Iftheflow
isunsteady,thesolutiontimelevelsarespecifiedintheRAWDATAsection.Thefirstlineofthe
RAWDATAsectionmustconsistofasingleintegerindicatingthenumberofsolutiontimelevels.This
mustbefollowedbythetimelevelsthemselves.Eachtimelevelmustbeonaseparatelineand
mustconsistofafloatingpointnumber(thesolutiontime),aswellasoneormoreintegers(the
zonenumbersforthatsolutiontime).
Parameter
STEADYSTATE
Syntax
=<boolean>
Default
TRUE
Notes
IfTRUE,indicatesthatthesolutionissteadystate,andthe
RAWDATA,ifany,isignored.IfFALSE,indicatesthatthe
solutionisunsteady,withtimelevelsidentifiedinthe
RAWDATAsection.
Example:Theunsteadysolutioncontainsthreesolutiontimelevelsoftwozoneseach,representing
solutiontimes0.5,1.0and1.5:
$!EXTENDEDCOMMAND
COMMAND=SETUNSTEADYFLOWOPTIONS
STEADYSTATE=FALSE
RAWDATA
227
3
.5 1
2
1.0 3 4
1.5 5 6
10 - 3
Parameter Assignment Values
Parameterassignmentsreferencedintheprevioussectionusingsingleanglebrackets(<>)notdefinedin
the12,aredefinedhere.Notethatcaseisnotimportant.
ValueIdentifier
<coeffsoption>
<functionname>
AllowableValues
GENERAL,DETAILED
IASPECTRATIO,JASPECTRATIO,KASPECTRATIO,ISTRETCHRATIO,JSTRETCHRATIO,
KSTRETCHRATIO,IFACESKEWNESS,JFACESKEWNESS,KFACESKEWNESS,
CELLDIAGONAL1SKEWNESS,CELLDIAGONAL2SKEWNESS,IJNORMALSSKEWNESS,
JKNORMALSSKEWNESS,KINORMALSSKEWNESS,MAXNORMALSSKEWNESS,IORTHOGONALITY,
JORTHOGONALITY,KORTHOGONALITY,MINORTHOGONALITY,INONPLANARITY,
JNONPLANARITY,KNONPLANARITY,MINNOPLANARITY,JACOBIAN,CELLVOLUME,
GRIDIUNITNORMAL,GRIDJUNITNORMAL,GRIDKUNITNORMAL,DENSITY,STAGDENSITY,
PRESSURE,STAGPRESSURE,PRESSURECOEF,STAGPRESSURECOEF,PITOTPRESSURE,
PITOTPRESSURERATIO,DYNAMICPRESSURE,TEMPERATURE,STAGTEMPERATURE,
ENTHALPY,STAGENTHALPY,INTERNALENERGY,STAGENERGY,STAGENERGYPERUNITVOL,
KINETICENERGY,UVELOCITY,VVELOCITY,WVELOCITY,VELOCITYMAG,MACHNUMBER,
SPEEDOFSOUND,CROSSFLOWVELOCITY,EQUIVALENTPOTENTIALVELRAT,XMOMENTUM,
YMOMENTUM,ZMOMENTUM,ENTROPY,ENTROPYMEASURES1,XVORTICITY,YVORTICITY,
ZVORTICITY,VORTICITYMAG,SWIRL,VELOCITYCROSSVORTICITYMAG,HELICITY,
RELATIVEHELICITY,FILTEREDRELATIVEHELICITY,SHOCK,FILTEREDSHOCK,
PRESSUREGRADIENTMAG,DENSITYGRADIENTMAG,XDENSITYGRADIENT,
YDENSITYGRADIENT,ZDENSITYGRADIENT,SHADOWGRAPH,DIVERGENCEOFVELOCITY,
SUTHERLANDSLAW,ISENTROPICDENSRAT,ISENTROPICPRESRAT,ISENTROPICTEMPRAT,
VELOCITY,VORTICITY,MOMENTUM,PERTURBATIONVELOCITY,
VELOCITYCROSSVORTICITY,PRESSUREGRADIENT,DENSITYGRADIENT,
VELOCITYGRADIENT
<gravitydirection>
MINUSX,MINUSY,MINUSZ,PLUSX,PLUSY,PLUSZ
<integrationoption>
CELLVOLUMES,IPLANES,JPLANES,KPLANES,ILINES,JLINES,KLINES
NONE,MAXIMUMMAGNITUDE,REFERENCEVALUES
PARTICLEPATH,STREAKLINE
TIMELEVEL,UNITTIME
SPECIFY,CALCULATE
PARTICLEVALUES,FLUIDVALUES
TEMPERATURE,ABLATE
ENERGY,DISSIPATIONRATE,DYNAMICVISCOSITY,FREQUENCY,VISCOSITY
LENGTHAREAVOLUME,SCALAR,AVERAGE,MASSWEIGHTEDSCALAR,
MASSWEIGHTEDAVERAGE,WEIGHTEDAVERAGE,SCALARFLOWRATE,MASSFLOWRATE,
MASSWEIGHTEDFLOWRATE,MASSFLOWWEIGHTEDAVERAGE,FORCESANDMOMENTS,
VECTORDOTNORMAL,VECTORAVERAGE,VECTORDOTTANGENTIAL
PRESSURE,TEMPERATURE,DENSITY,
STAGNATIONENERGY,MACHNUMBER,NOTUSED
X,Y
<normalizationoption>
<particlefunction>
<releaseoption>
<specifyoption>
<storeoption>
<terminationoption>
<turbulencefunction>
<variableoption>
<varid>
<XorY>
228
11
Parameter Subcommands
ThischapterdetailssecondaryorcommonmacroparametersubcommandsinTecplot360.These
subcommandsprovideameanstoaccessthelowerlevelvariablesofcommandsdefinedintheprevious
chapterofthismanual.Eachsubcommandcanexpandtocontainoneormoreparametersor
subcommands.Allparameterswithinasubcommandareoptional.
Itemswithinsingleanglebrackets(<>)aredefinedin12.
<<anchorpos>>
Description:Assignattributesforpositioningofobjects.
Expands to:
Parameter
Syntax
Default
Notes
{
X
Y
Z
THETA
R
=<double>
=<double>
=<double>
=<double>
=<double>
SetsXvalue(andTHETAvalue)
SetsYvalue(andRvalue)
SetsZvalue
SetsTHETAvalue(andXvalue)
SetsRvalue(andYvalue)
Example:
MakeasquaregeometryandplaceitatacertainXYlocation:
$!ATTACHGEOM
GEOMTYPE=SQUARE
ANCHORPOS
{
X=2.89124668435
229
<<areastyle>>
Y=88.7359084881
}
RAWDATA
5.23430593312
<<areastyle>>
Description:Changesettingsfortheaxisgridarea.
Expands to:
Parameter
Syntax
Default
Notes
{
DRAWGRIDLAST
=<boolean>
DRAWBORDER
=<boolean>
LINETHICKNESS
<op><dexp>
COLOR
=<color>
ISFILLED
=<boolean>
FILLCOLOR
=<color>
USELIGHTSOURCETO
FIL
=<boolean>
Onlyavailablefor3Dframemode.
Notavailablein3Dframemode.
Example:Turnonthegridareaborderfora2Dplotandchangethelinethicknesstobe2percent:
$!TWODAXIS
AREASTYLE
{
DRAWBORDER=YES
LINETHICKNESS=2
}
<<axisdetail>>
Description:Assignattributesforaxes.
230
<<axisline>>
Expands to:
Parameter
Syntax
Default
Notes
{
SHOWAXIS
AUTOGRID
ISREVERSED
GRANCHOR
GRSPACING
RANGEMIN
RANGEMAX
COORDSCALE
CLIPDATA
VALUEATORIGIN
VARNUM
=<boolean>
=<boolean>
=<boolean>
=<double>
=<double>
=<double>
=<double>
=<coordscale>
=<boolean>
=<double>
=<integer>
TITLE
<<ticklabeldetail>
>
<<gridlinedetail>
>
<<gridlinedetail>
>
<<ticklabeldetail>
>
<<axistitle>>
AXISLINE
<<axisline>>
TICKLABEL
GRIDLINES
MINORGRIDLINES
TICKS
XYandPolarLineplotsonly.
Availablefor2Dand3Dplottypesonly.Referto
$!LINEMAPonpage 151forinformationonreferencing
variablenumberforXYandPolarLineplots.
Example:Turnontheaxisline,reversetheaxisdirection,andsettherangetogofrom0.5to1.5for
theXaxisina2Dplot:
$!TWODAXIS
SHOWAXISLINE=TRUE
XDETAIL
{
ISREVERSED=TRUE
RANGEMIN=0.5
RANGEMAX=1.5
}
<<axisline>>
Description:Assignattributesforaxislines.
231
<<axistitle>>
Expands to:
Parameter
Syntax
Default
Notes
{
SHOW
=<boolean>
SHOWBOTHDIRECTIONS
=<boolean>
FALSE
Non3Donly.
SHOWPERPENDICULAR
=<boolean>
FALSE
Non3Donly.
SHOWOPPOSITEEDGE
=<boolean>
FALSE
3Donly
COLOR
=<color>
LINETHICKNESS
ALIGNMENT
=<double>
<axisalignment>
OPPOSINGAXISVALUE
=<double>
POSITION
=<double>
ANGLE
=<double>
OFFSET
=<double>
EDGE
=<integer>
Example:ChangethethicknessoftheThetaaxislineto0.8andthecolortored.:
$!POLARAXISTHETADETAIL{AXISLINE{COLOR=RED}}
$!POLARAXISTHETADETAIL{AXISLINE{LINETHICKNESS=0.8}}
<<axistitle>>
Description:Assignattributesfortitles.
Expands to:
Parameter
Syntax
Default
Notes
{
SHOWONAXISLINE
=<boolean>
TRUE
SHOWONGRIDBORDERMIN
=<boolean>
FALSE
Non3Donly.
SHOWONGRIDBORDERMAX
=<boolean>
FALSE
Non3Donly.
SHOWONOPPOSITEEDGE
=<boolean>
FALSE
3Donly.
SHOWONALLAXES
=<boolean>
TRUE
PolarRonly.
SHOWONVIEWPORTTOP
=<boolean>
TRUE
Polaronly.
SHOWONVIEWPORTBOTTOM
=<boolean>
TRUE
Polaronly.
SHOWONVIEWPORTLEFT
=<boolean>
TRUE
Polaronly.
SHOWONVIEWPORTRIGHT
=<boolean>
TRUE
Polaronly.
TITLEMODE
=<axistitlemode>
TEXT
=<string>
COLOR
TEXTSHAPE
=<color>
<<textshape>>
OFFSET
=<double>
PERCENTALONGLINE
=<double>
50%
Example:CreateaRaxistitle,sayingHarmonicMotioninred,times,size6font.:
$!POLARAXISRDETAIL{TITLE{TEXT=HarmonicMotion}}
$!POLARAXISRDETAIL{TITLE{OFFSET=4}}
$!POLARAXISRDETAIL{TITLE{COLOR=RED}}
232
<<basicsizelist>>
$!POLARAXISRDETAIL{TITLE{TEXTSHAPE{FONTFAMILY=Times}}}
$!POLARAXISRDETAIL{TITLE{TEXTSHAPE{ISBOLD=NO}}}
$!POLARAXISRDETAIL{TITLE{TEXTSHAPE{ISITALIC=NO}}}
$!POLARAXISRDETAIL{TITLE{TEXTSHAPE{HEIGHT=6}}}
<<basicsizelist>>
Description:Assignbasicsizes.Theunitsforthevaluesassignedherearedependentontheparentcommand.
Assignmentsheredonotaffecttheplot.Theseassignmentsareusedonlytoconfiguredropdown
menusintheinterfacesotheusercanmakequickselections.
Expands to:
Parameter
Syntax
Default
Notes
{
TINY
<op> <dexp>
SMALL
<op> <dexp>
MEDIUM
<op> <dexp>
LARGE
<op> <dexp>
HUGE
<op> <dexp>
Example:Changethemediumlinepatternlengthfordropdownmenusintheinterfacetobefive
percent:
$!BASICSIZE
LINEPATLENGTHS
{
MEDIUM=5
}
Description:AllcontourcolormapsexcepttheRawuserdefinedcolormapmakeuseofcontrolpointsto
determinethecolordistribution.Eachcontrolpointhasapositionandaleftandrightcolor.The
<<colormapcontrolpoints>>subcommandcancontainmorethanoneCONTROLPOINTsubcommand.
233
Expands to:
Parameter
Syntax
Default
Notes
{
CONTROLPOINT
<integer>
Use<integer>tospecifywhichcontrolpointtomodify.
COLORMAPFRACTION
<op> <dexp>
Positionsthecontrolpoint;0setsthepositiontothelowest
indexand1tothehighestindexinthecolormap.
LEADRGB
<<rgb>>
TRAILRGB
<<rgb>>
}
}
Example:ChangetheleadRGBvaluesforcontrolpoint2inthesmallrainbowcolormaptobe
100, 0, 0:
$!COLORMAP
SMRAINBOW
{
CONTROLPOINT2
{
LEADRGB
{
R=100
G=0
B=0
}
}
}
Description:Changesettingsforacolormapoverride.Colormapoverridesareusedtoreplaceaspecific
bandinacontourcolormapwithoneofthe16basiccolors.
Expands to:
Parameter
Syntax
Default
Notes
{
INCLUDE
=<boolean>
COLOR
=<color>
STARTLEVEL
<op><integer>
ENDLEVEL
<op><integer>
Example:Setthecolorusedbetweencontourlevelnumber1tonumber3tobepurple.Usecolor
mapoverridenumber3:
$!GLOBALCONTOUR
COLORMAPFILTER
{
COLORMAPOVERRIDEACTIVE=YES
COLORMAPOVERRIDE3
{
INCLUDE=YES
234
<<continuouscolor>>
COLOR=PURPLE
STARTLEVEL=1
ENDLEVEL=3
}
}
<<continuouscolor>>
Description:Changesettingsforcontinuouscolor.
Expands to:
Parameter
Syntax
CMIN
=<double>
CMAX
=<double>
Default
Notes
Example:Setthecontinuouscolor.
$!FIELDLAYERSSHOWCONTOUR=YES
$!GLOBALCONTOURCOLORMAPFILTER
{COLORMAPDISTRIBUTION=CONTINUOUS}
$!GLOBALCONTOURCOLORMAPFILTER
{
CONTINUOUSCOLOR
{
CMIN=0.5
CMAX=2
}
}
<<dialogplacement>>
Description:Describestheplacementforadialog.
235
<<gridarea>>
Expands to:
Parameter
Syntax
Default
Notes
ANCHORALIGNMENT
=
anchoralignmen
t>
ANCHORHORIZONTAL
INSIDE
=<boolean>
ANCHORVERTICALIN
SIDE
=<boolean>
MINVISIBILITYPER
CENTAGE
=<integer>
TheMINVISIBILITYPERCENTAGEspecifiestheminimum
percentageofthedialog,between1and100,thatmustbe
visiblewithinthedesktop.Thispreventsadialogfrombeing
placedoutsideofthevisibledesktop.Notethatnotallwindow
managersallowdialogstobeplacedsothattheportionsofthe
dialogarenotvisibleandineffectenforceavalueof100.
ANCHORHORIZONTALINSIDEand
ANCHORVERTICALINSIDEcontrolhowthedialogwindow
isanchoredinboththehorizontalandverticaldirections
relativetotheTecplot360mainwindow.
IOFFSET
=<integer>
JOFFSET
=<integer>
IOFFSETandJOFFSETareinpixels.Theymaybenegative,but
willbetruncatedtotheboundingrectangleoftheTecplot360
mainwindow.
POSITIONATANCHOR
=
<positionatanch
or>
POSITIONATANCHORspecifieswhentoplaceitatthe
anchor,NEVER,ONCE(initiallaunch),orALWAYS.
Example:SetthepositionoftheColormapdialogtoalwayslaunch10pixelsfromTecplot360s
bottomrightcorner:
$!INTERFACE
DIALOGPLACEMENT
{
COLORMAPDIALOG
{
ANCHORALIGNMENT=BOTTOMRIGHT
IOFFSET=100
JOFFSET=100
POSITIONATANCHOR=ALWAYS
}
}
<<gridarea>>
Description:Changesettingsfortheaxisgridarea.
236
<<gridlinedetail>>
Expands to:
Parameter
Syntax
Default
Notes
{
DRAWGRIDLAST
=<boolean>
DRAWBORDER
=<boolean>
LINETHICKNESS
<op><dexp>
COLOR
=<color>
ISFILLED
=<boolean>
FILLCOLOR
=<color>
USELIGHTSOURCETO
FILL
=<boolean>
LABELSALLSIDES
=<boolean>
TICKSALLSIDES
=<boolean>
EXTENTS
<<rect>>
Notavailablein3D.
Notavailablefor3DorPolarLine.
Onlyavailablefor3D.
Notavailablein3D.
Example:Turnonthegridareaborderfora2Dplotandchangethelinethicknesstobe2percent:
$!TWODAXIS
GRIDAREA
{
DRAWBORDER=YES
LINETHICKNESS=2
}
<<gridlinedetail>>
Description:Changesettingsforaxisgridlines.
Expands to:
Parameter
Syntax
Default
Notes
{
COLOR
=<color>
SHOW
=<boolean>
LINEPATTERN
=<linepattern>
PATTERNLENGTH
<op><dexp>
LINETHICKNESS
<op><dexp>
CUTOFF
=<double>
Thetaonly.
Example:SetthelinepatternforminorgridlinesfortheXaxisina3Dplottobedashed:
$!THREEDAXIS
XDETAIL
{
MINORGRIDLINES
{
LINEPATTERN=DASHED
}
}
237
<<ijk>>
<<ijk>>
Description:SetanI,J,orKindex.
Expands to:
Parameter
Syntax
Default
Notes
{
I
<op><integer>
<op><integer>
<op><integer>
Example:SettheIandJindexskipforvectorsto2forallzones:
$!FIELDMAP
VECTOR
{
IJKSKIP
{
I=2
J=2
}
}
<<indexrange>>
Description:Setanindexrange.
Expands to:
Parameter
Syntax
Default
Notes
{
MIN
<op><integer>
MAX
<op><integer>
SKIP
<op><integer>
Example:ChangetheplotsothedatasetshowsIplanes3,5,and7forzones1to3:
$!FIELDMAP[13]
SURFACES
{
SURFACESTOPLOT=IPLANES
IRANGE
{
MIN=3
MAX=7
SKIP=2
}
}
238
<<numberformat>>
<<numberformat>>
Description:Settheformatusedtodrawanumber.
Expands to:
Parameter
Syntax
Default
Notes
{
FORMATTING
=<valueformat>
CUSTOMLABEL
=<integer>
DYNAMICLABELNAME
=<string>
PRECISION
<op><integer>
SHOWDECIMALSONWH
OLENUMBERS
=<boolean>
FALSE
=<boolean>
FALSE
SHOWNEGATIVESIGN
=<boolean>
TRUE
POSITIVEPREFIX
=<string>
POSITIVESUFFIX
=<string>
NEGATIVEPREFIX
=<string>
NEGATIVESUFFIX
=<string>
TIMEDATEFORMAT
=<string>
ZEROPREFIX
=<string>
ZEROSUFFIX
=<string>
REMOVELEADING
ZEROS
Nameofthedynamiclabelgeneratortousewhen
FormattingissettoDynamicLabel
Example:SetthenumberformatforaxislabelsontheXaxisina2Dfieldplottousethefloat
formatwithaprecisionof3,andaddthephraseDAYSWITHOUTRAINafterevery
positivevalue:
$!TWODAXIS
XDETAIL
{
TICKLABEL
{
NUMFORMAT
{
FORMATTING=FIXEDFLOAT
PRECISION=3
POSITIVESUFFIX=DAYSWITHOUTRAIN
}
}
}
Example:SetthenumberformatforaxislabelsontheXaxisina2Dfieldplottousethe
Time/Dateformat.Addthetimeanddateinformat
<<papersize>>
Description:ChangedimensionsorhardclipoffsetsforLETTER,DOUBLE,A3,A4,CUSTOM1andCUSTOM2
papersizes.
239
<<precisegrid>>
Expands to:
Parameter
Syntax
Default
Notes
Allvaluesareininches.
WIDTH
<op><dexp>
HEIGHT
<op><dexp>
LEFTHARDCLIPOFFSET
<op><dexp>
RIGHTHARDCLIPOFFSET
<op><dexp>
TOPHARDCLIPOFFSET
<op><dexp>
BOTTOMHARDCLIPOFFSET
<op><dexp>
Example:ChangethelefthardclipoffsetforLETTERsizepapertobe0.25inches:
$!PAGE
PAPERSIZEINFO
{
LETTER
{
LEFTHARDCLIPOFFSET=0.25
}
}
<<precisegrid>>
Description:Changesettingsfortheprecisedotgrid.
Expands to:
Parameter
Syntax
Default
Notes
{
INCLUDE
=<boolean>
COLOR
=<color>
SIZE
=<double>
Sizeisincentimeters.
Example:TurnontheprecisedotgridinanXYplot:
$!XYAXIS
PRECISEGRID
{
INCLUDE=YES
}
<<rect>>
Description:Changesettingsforarectangle.Therectangleisdefinedusingtwopoints(X1,Y1)and(X2,Y2).
240
<<refscatsymbol>>
Expands to:
Parameter
Syntax
Default
Notes
Unitsarebasedontheparentcommand.
X1
<op><dexp>
Y1
<op><dexp>
X2
<op><dexp>
Y2
<op><dexp>
Example:Setthe2Daxisgridareatobepositioned10percentfromalledgesoftheframe:
$!TWODAXIS
AREASTYLE
{
EXTENTS
{
X1=10
Y1=10
X2=90
Y2=90
}
}
<<refscatsymbol>>
Description:Settheattributesforthereferencescattersymbol.
Expands to:
Parameter
Syntax
Default
Notes
{
SHOW
=<boolean>
COLOR
=<color>
LINETHICKNESS
=<dexp>
ISFILLED
=<boolean>
FILLCOLOR
=<color>
MAGNITUDE
XYPOS
=<dexp>
<<xyz>>
SYMBOLSHAPE
<<symbolshape>>
Example:Changethefillcolorofthereferencescattersymboltobegreen:
$!GLOBALSCATTER
REFSCATSYMBOL
{
FILLCOLOR=GREEN
}
241
<<renderconfig>>
<<renderconfig>>
Description:SettheattributesforOpenGLrendering.
Expands to:
Parameter
Syntax
Default
Notes
{
POLYGONOFFSET
EXTBIASFACTOR
=<double>
STIPPLEALLLINES
=<stipplemode>
Ifthinpatternedlinesarenotdrawncorrectly,set
STIPPLEALLLINEStoALL.
DEPTHBUFFERSIZE
=<integer>
Forlowmemorygraphicscards,thedepthbuffersizemay
needtobereduced.
MINBITSPERRGB
PLANE
=<integer>
Specifytheminimumnumberofbitsusedforeachofthe
planesintheimagebuffer.
DOEXTRADRAWFOR
LASTPIXEL
=<boolean>
Sometimesthelastpixelforstrokedfontcharactersisnot
drawnIfso,turnDOEXTRADRAWFORLASTPIXELon.
MAXMULTISAMPLES
=<integer>
Setsthenumberofmultisamplesusedforantialising.Default:
4forscreen,0foroffscreen.
MAXSTRIPLENGTH
=<integer>
Somegraphicscardshaveproblemswithlongstrips.Use
MAXSTRIPLENGTHtoreducethestriplength.
MAXPRIMATIVESPER
BLOCK
=<integer>
Somegraphicscardshaveproblemswithlargenumbersof
graphicsprimitivesinasingleblock.Use
MAXPRIMATIVESPERBLOCKtoreducethenumberof
primitivesdeliveredtothegraphicshardwareinasingleblock.
CONSTANTLYUSE
SCISSORING
=<boolean>
TurnConstantlyUseScissoringonifyouseelinesextending
outsidethebordersoftheframe.Thereisaslightperformance
penaltywhenusingthisoption.
USEQUADSTRIPS
=<boolean>
Ifsomeshadedorcontourfloodedquadsortrianglesdonot
appearorareblack,tryturningthisoff.
USETRIANGLE
STRIPS
=<boolean>
AswithUSEQUADSTRIPS,tryturningoffUSEQUADSTRIPS
beforeturningUSETRIANGLESTIPSoff.Turningoffboth
optionswillresultinreducedperformance,butmayhelpfix
errorscausedbybuggygraphicscarddrivers.
TRIANGULATE
FILLEDPOLYGONS
=<boolean>
AswithUSEQUADSTRIPS,tryturningon
TRIANGULATEFILLEDPOLYGONSifyouarestill
experiencingproblemsevenafterturningoff
USETRIANGLESTRIPSandUSEQUADSTRIPS.
USEGLCOLOR
MATERIALFUNCTION
=<boolean>
SomegraphicscardshaveproblemswithanOpenGLs
glColorMaterialfunction.Higherperformance(especially
forcontinuouscontourfloodedplots)canbeachievedwhenit
isused.However,itmayneedtobeturnedoffifyouare
experiencingproblems.
MAXTEXTURESIZE
=<integer>
FORCESMOOTHSHADI
NGFORLIGHTING
=<boolean>
ADJUSTRECTANGLE
RIGHTANDBOTTOM
=<boolean>
Example:Forcealllinedrawingtoincludethelastpointintheline.Also,makethesizeofthedepth
buffertobeatleast32bits.
$!INTERFACE
OPENGLCONFIG
{
SCREENRENDERING
{
DOEXTRADRAWFORLASTPIXEL=TRUE
DEPTHBUFFERSIZE=32
242
<<rgb>>
}
}
<<rgb>>
Description:Setacolorvaluebyassigningvaluestoitsred,green,andbluecomponents.
Expands to:
Parameter
Syntax
Default
Notes
{
R
<op><integer>
<op><integer>
<op><integer>
Example:ChangetheCUSTOM3basiccolortobelightgreen:
$!BASICCOLOR
CUSTOM3
{
R=80
G=255
B=80
}
<<shademap>>
Description:Mapcolorsonthescreentoshadesofgrayformonochromehardcopyoutput.
243
<<symbolshape>>
Expands to:
Parameter
Syntax
Default
Notes
Shadevaluescanrangefrom0(black)to100(white).
BLACKSHADE
=<dexp>
REDSHADE
=<dexp>
GREENSHADE
=<dexp>
BLUESHADE
=<dexp>
CYANSHADE
=<dexp>
YELLOWSHADE
=<dexp>
PURPLESHADE
=<dexp>
WHITESHADE
=<dexp>
CUSTOM1SHADE
=<dexp>
CUSTOM2SHADE
=<dexp>
CUSTOM3SHADE
=<dexp>
CUSTOM4SHADE
=<dexp>
CUSTOM5SHADE
=<dexp>
CUSTOM6SHADE
=<dexp>
CUSTOM7SHADE
=<dexp>
CUSTOM8SHADE
=<dexp>
Example:Makebluefloodedregionsmapto50percentgray:
$!PRINTSETUP
MONOFLOODMAP
{
BLUESHADE=50
}
<<symbolshape>>
Description:Setasymbolshape.Symbolscanbeageometricshape(circle,square,andsoforth)oranASCII
character.
244
<<textbox>>
Expands to:
Parameter
Syntax
Default
Notes
{
ISASCII
=<boolean>
ASCIISHAPE
{
USEBASEFONT
=<boolean>
FONTOVERRIDE
=<font>
ASCIICHAR
=<string>
}
GEOMSHAPE
=<geomshape>
Example:Changethesymbolshapeforsymbolsdrawnwithlinemap3tousecircles:
$!LINEMAP[3]
SYMBOLS
{
SYMBOLSHAPE
{
ISASCII=FALSE
GEOMSHAPE=CIRCLE
}
}
<<textbox>>
Description:Changesettingsfortheoptionalboxaroundatextlabel.
Expands to:
Parameter
Syntax
Default
Notes
{
BOXTYPE
=<textboxtype>
MARGIN
<op><dexp>
LINETHICKNESS
<op><dexp>
COLOR
=<color>
FILLCOLOR
=<color>
Example:Seeexamplefor<<textbox>>.
<<textshape>>
Description:Changesettingsrelatedtotextfontandcharacterheight.
245
<<ticklabeldetail>>
Expands to:
Parameter
Syntax
Default
Notes
{
FONTFAMILY
=<string>
ISBOLD
=<boolean>
ISITALIC
=<boolean>
SIZEUNITS
=<sizeunits>
HEIGHT
<op><dexp>
Example:AddatextlabelinthecenteroftheframeusingTimesRomanfont.Makethetextheight
12point.Includeaboxaroundthetextwithalinethicknessofonepercent:
$!ATTACHTEXT
XYPOS{
X=50
Y=50
}
TEXTSHAPE
{
FONTMFFAMILY=Times
ISBOLD=NO
ISITALIC=NO
}
BOX
{
BOXTYPE=HOLLOW
LINETHICKNESS=1
}
TEXT=HiMom
<<ticklabeldetail>>
Description:Changesettingsforthetextusedtolabelaxistickmarks.
246
<<tickmarkdetail>>
Expands to:
Parameter
Syntax
Default
Notes
{
SHOWONAXISLINE
=<boolean>
TRUE
SHOWONGRIDBORDERMIN
=<boolean>
FALSE
Non3Donly.
SHOWONGRIDBORDERMAX
=<boolean>
FALSE
Non3Donly.
SHOWONOPPOSITEEDGE
=<boolean>
FALSE
3Donly.
SHOWONALLAXES
=<boolean>
TRUE
PolarRonly.
SHOWATAXISINTER
SECTION
=<boolean>
SKIP
=<integer>
ERASEBEHINDLABELS
=<boolean>
NUMFORMAT
<<numberformat>>
TEXTSHAPE
<<textshape>>
OFFSET
<op><dexp>
LABELALIGNMENT
=<labelalignment>
ANGLE
<op><dexp>
COLOR
=<color>
parameter.
Example:ChangethecolorforXaxistickmarklabelsina2Dplottobered:
$!TWODAXIS
XDETAIL
{
TICKLABEL
{
COLOR=RED
}
}
<<tickmarkdetail>>
Description:Assignattributesforaxistickmarks.
247
Expands to:
Parameter
Syntax
Default
Notes
{
SHOWONAXISLINE
=<boolean>
TRUE
SHOWONGRIDBORDERMIN
=<boolean>
FALSE
Non3Donly.
SHOWONGRIDBORDERMAX
=<boolean>
FALSE
Non3Donly.
SHOWONOPPOSITEEDGE
=<boolean>
FALSE
3Donly.
SHOWONALLAXES
=<boolean>
TRUE
PolarRonly.
TICKDIRECTION
=<tickdirection>
LENGTH
<op> <dexp>
LINETHICKNESS
<op> <dexp>
NUMMINORTICKS
=<integer>
MINORLENGTH
=<double>
MINORLINETHICKNESS
=<double>
Example:Setthetickmarklengthto2percentforthesecondYaxisinanXYplot:
$!XYLINEAXIS
YDETAIL2
{
TICKS
{
LENGTH=2
SHOWONGRIDBORDERMIN=TRUE
}
}
Description:Specifieswhatvolumeobjectsaretobedisplayed.
Expands to:
Parameter
Syntax
{
SHOWISOSURFACES
=<boolean>
SHOWSLICES
=<boolean>
SHOWSTREAMTRACES
=<boolean>
Example:
$!FIELD
VOLUMEMODE
{
VOLUMEOBJECTSTOPLOT
{
SHOWISOSURFACES=NO
SHOWSLICES=YES
SHOWSTREAMTRACES=YES
}
}
248
Default
Notes
<<xy>>
<<xy>>
Description:Changesettingsforan(X,Y)position.
Expands to:
Parameter
Syntax
Default
Notes
{
X
<op><dexp>
<op><dexp>
Example:SeetheXYPOSparameterintheexamplefor<<textshape>>.
<<xyz>>
Description:Changesettingsforan(X,Y,Z)triplet.
Expands to:
Parameter
Syntax
Default
Notes
{
X
<op><dexp>
<op><dexp>
<op><dexp>
Example:ChangethescalefactorontheZaxistobe0.5:
$!GLOBALTHREED
AXISSCALEFACT
{
Z=0.5
}
<<zebrashade>>
Description:Changezebrashadingattributes.
249
<<zebrashade>>
Expands to:
Parameter
Syntax
Default
Notes
{
INCLUDE
=<boolean>
ISTRANSPARENT
=<boolean>
COLOR
=<color>
Example:Turnonzebrashadingandmakethezebrashadecolortobeblack:
$!GLOBALCONTOUR
COLORMAPFILTER
{
ZEBRA
{
INCLUDE=TRUE
COLOR=BLACK
}
}
250
12
Parameter Assignment Values,
Expressions, and Operators
12 - 1
Assignment Value Table
Parameterassignmentsreferencedinthepreviouschaptersusingsingleanglebrackets(<>)aredefined
here.(Caseisnotimportant.)
ValueIdentifier
AllowableValues
<altmousebuttonmode>
REDRAW
REVERTTOSELECT
<addonstyle>
V7STANDARD
V7ACTIVEX
anchoralignment>
TOPLEFT
TOPCENTER
TOPRIGHT
MIDDLELEFT
MIDDLECENTER
MIDDLERIGHT
BOTTOMLEFT
BOTTOMRIGHT
BOTTOMCENTER
<anglespec>
RADIANS
DEGREES
NONE
ATBEGINNING
ATEND
HOLLOW
ATBOTHENDS
<arrowheadstyle>
PLAIN
FILLED
<axisalignment>
WITHVIEWPORT
WITHSPECIFICANGLE
WITHGRIDMIN
WITHGRIDAREABOTTOM
WITHGRIDMAX
WITHGRIDAREARIGHT.
WITHGRIDAREATOP
WITHGRIDAREALEFT
WITHOPPOSINGAXISVALUE
<axismode>
INDEPENDENT
XYDEPENDENT
XYZDEPENDENT
<axistitlemode>
USEVARNAME
USETEXT
<axistitleposition>
LEFT
CENTER
RIGHT
<backingstoremode>
REALTIMEUPDATE
NOTUSED
PERIODICUPDATE
<bitdumpregion>
CURRENTFRAME
ALLFRAMES
WORKAREA
251
Pa ra m e t e r As s ig n m e n t Va lu e s , Ex pre s s io n s , a n d Ope ra t o rs
ValueIdentifier
<boolean>
AllowableValues
YES
NO
TRUE
FALSE
ON
OFF
<borderlocation>
IBORDER
JBORDER
KBORDER
<boundarycondition>
FIXED
ZEROGRADIENT
ZERO2ND
<boxtype>
NONE
FILLED
HOLLOW
<charactersequence>
Oneormoreprintablecharacters.
<clipping>
CLIPTOVIEWPORT
CLIPTOFRAME
<clipplane>
BELOWPRIMARYSLICE
ABOVEPRIMARYSLIC
E
NONE
<color>
BLACK
RED
GREEN
BLUE
CYAN
YELLOW
WHITE
CUSTOM1to
CUSTOM56
PURPLE
MULTI1toMULTI4
RGBCOLOR
<standardcolormap>
WILD
<colormap>
USERDEF
RAWUSERDEF
<colormapcontrol>
COPYSTANDARD
REDISTRIBUTECONTROLPOINTS
RESETTOFACTORY
<colormapdistribution>
BANDED
CONTINUOUS
<compressiontype>
BESTSPEED
SMALLESTSIZE
<conditionalexp>
<dexp><relop><dexp>
<string><relop><string>.
<constrainintop2mode>
USEVAR
USECONSTANT
<contourcoloring>
RGB
GROUP1toGROUP4
<contourlabelaction>
ADD
DELETEALL
<contourlabellocation>
COLORMAPDIVISIONS
INCREMENT
CONTOURLEVELS
<contourlevelaction>
ADD
NEW
DELETERANGE
DELETENEAREST
RESET
<contourlinemode>
USEZONELINETYPE
SKIPTOSOLID
DASHNEGATIVE
<contourtype>
LINES
FLOOD
AVERAGECELL
PRIMARYVALUE
BOTHLINESANDFLOOD
<coordscale>
LINEAR
LOG
<coordsys>
GRID
FRAME
<curveinfomode>
CURVEDETAILS
CURVEPOINTS
<curvetype>
LINESEG
CURVFIT
SPLINE
PARASPLINE
ETORFIT
POWERFIT
EXTENDED
POLYNOMIALFIT
SINGLE
DOUBLE
LONGINT
SHORTINT
BYTE
BIT
AUTO
HEAP
<datatype>
<dataloadstrategy>
252
GRID3D
ValueIdentifier
<derivpos>
AllowableValues
SIMPLE
ATPOINT
COMPLEX
ATPOINTB2
<dialogname>
AXISEDIT
ADVANCED3DCONTROL
COLORMAP
CONTOUR
CREATE1DLINE
CREATECIRCULARZONE
CURVEINFO
CREATERECTANGULARZONE
CREATEZONEFROMPOLYLINES
CREATEZONEFROMVALUES
DATAINFO
DATALABELS
DATASPREADSHEET
DELETEVARIABLES
DELETEZONES
DEPTHBLANKING
DUPLICATEZONE
EQUATION
EXPORT
EXTRAEXTRACTDISCRETEPOINTS
EXTRACTFEBOUNDAR
Y
EXTRACTISOSURFACES
EXTRACTPOINTSFROMGEOMETRY
EXTRACTPOINTSFROMPOLYLINE
EXTRACTSLICEFROMPLANE
EXTRACTSLICES
EXTRACTSTREAMTRACES
EXTRACTSUBZONE
EXTRACTCONTOURLINES
IJKBLANKING
IMPORT
LIGHTSOURCE
INVERSEDISTANCEINTERPOLATION
LINEARINTERPOLATION
KRIGINGINTERPOLATION
LINEMAPLEGEND
LOADDATA
MACROPLAY
MACRORECORD
MACROVIEWER
MIRRORZONE
NEWLAYOUT
OPENLAYOUT
ORDERFRAMES
PAPERSETUP
PERFORMANCEb
POLARDRAWINGOPTIONS
PRINT
PROBEAT
PROBE
QUICKEDIT
QUICKMACROPANEL
RESET3DAXES
RGBCOLORLEGEND
RGBCOLORVARSANDRANGE
ROTATE2DDATA
RULERGRID
SAVEAS
SAVE
SCATTERLEGEND
SCATTERSIZEANDFONT
SCATTERREFERENCESYMBOL
SLICES
SMOOTH
SPATIALVARS
STREAMTRACES
STYLELINKING
THREEDAXISLIMITS
THREEDVIEWDETAILS
THREEDORIENTATIONAXIS
THREEDVIEWROTATE
TRANSFORMCOORDINATES
TRANSLATEMAGNIFY
TRIANGULATE
VALUEBLANKING
VECTORLENGTH
TWODDRAWORDER
253
Parameter Assignment Values, Expressions, and Operators
ValueIdentifier
AllowableValues
VECTORARROWHEADS
VECTORREFERENCEVECTOR
VECTORVARS
WRITEDATA
ZONEMAPSTYLE
<derivpos>
SIMPLE
ATPOINT
COMPLEX
<dexp>
<double>((<expression>))
<double>
Validfloatingpointvalue.
<draworder>
BEFOREDATA
AFTERDATA
<drift>
NONE
LINEAR
QUAD
<edgesetting>
NONE
MIN
MAX
BOTH
<edgetype>
BORDERSANDCREASE
BORDERS
CREASES
<epspreviewimagetype>
NONE
TIFF
EPSIV2
FRAME
<errorbartype>
UP
DOWN
LEFT
RIGHT
VERT.
HORZ
CROSS
<exportformat>
RASTERMETAFILE
TIFF
SUNRASTER
XWINDOWS
PSIMAGE
PS
EPS
X3D
BMP
PNG
AVI
JPEG
WINDOWSMETAFILE
TECPLOTVIEWER
<expression>
SeeFigure122.
<fielddatatype>
FLOAT
DOUBLE
<fillmode>
NONE
USEBACKGROUNDCOLOR
USELINECOLOR
USESPECIFICCOLOR
HELV
HELVBOLD
TIMES
TIMESBOLD
TIMESITALIC
TIMESITALICBOLD
COURIER
COURIERBOLD
GREEK
MATH
USERDEF
DELETETOP
FITALLTOPAPER
POPATPOSITION
PUSHTOP
<framecollection>
ALL
PICKED
<framemode>
THREED
TWOD
XY
YINDEPENDENT
RINDEPENDENT
<font>
<frameaction>
POP
SKETCH
<functiondependency>
XINDEPENDENT
THETAINDEPENDENDT
254
ValueIdentifier
<geomshape>
<geomtype>
AllowableValues
SQUARE
DEL
GRAD
RTRI
LTRI
DIAMOND
CIRCLE
CUBE
OCTAHEDRON
SPHERE
POINT
GEOMIMAGE
LINESEGS
RECTANGLE
SQUARE
CIRCLE
ELLIPSE
LINESEGS3D
<ijkblankmode>
INTERIOR
EXTERIOR
<ijklines>
<ijkplane>
<imagestyle>
ONEPERFRAME
WORKSPACEONLY
<imagetype>
LOSSLESS
JPEG
<integer>
Integerconstantsorvariablescontaininganinteger.Expressionsthatlogicallyresult
inintegerarenotcurrentlysupported.
<interpptselection>
NEARESTNPOINTS
ALLPOINTS
<isosurfacesselection>
ALLCOUNTOURLEVELS
TWOSPECIFICVALUES
THREESPECIFICVALUES
ONESPECIFICVALUE
<krigdrift>
NONE
LINEAR
<labelalignment>
BYANGLE
ALONGAXIS
256COLOR
OCTANTNPOINTS
QUAD
PERPENDICULARTOAXIS
<labeltype>
INDEX
VARVALUE
<lightingeffect>
PANELED
GOURAUD
<linearinterpmode>
DONTCHANGE
SETTOCONST
<linepattern>
SOLID
DASHED
DASHDOT
DOTTED
LONGDASH
DASHDOTDOT
<linktype>
WITHINFRAME
BETWEENFRAMES
<macrofunctionvar>
|<integer>|
XANDYVARVALUEc
255
ValueIdentifier
<macrointrinsic>
AllowableValues
AXISMAXX
AXISMAXY
AXISMAXZ
AXISMINX
AXISMINY
AXISMINZ
COLORMAPDYNAMIC
ENDSLICEPOS
FRAMEMODE
IS3DV
LOOP
MACROFILEPATH
MAXB
MAXC
MAXI
MAXJ
MAXK
MAXS
MAXU
MAXV
MAXVnn
MAXW
MAXX
MAXY
MAXZ
MINB
MINC
MINS
MINU
MINV
MINVnn
MINW
MINX
MINY
MINZ
NUMFRAMES
NUMPLANES
NUMVARS
NUMWIN
NUMXYMAPS
NUMZONES
OPSYS
PLATFORMNAME
SOLUTIONTIME
SLICEPLANETYPE
STARTSLICEPOS
TECHOME
TECPLOTVERSION
<macrointrinsicvar>
|<macrointrinsic>|
<macroparameter>
<charactersequence><string>
<macroparameterlist>
(<macroparameter><macroparameter>...)
<macrouserdefvar>
|<charactersequence>|
<macrovar>
<macrointrinsicvar><macrouserdefvar><macrofunctionvar>
<meshtype>
WIREFRAME
OVERLAY
HIDDENLINE
<mirrorvar>
<mousebuttonclick>
REDRAW
REVERTTOSELECT
NOOP
<mousebuttondrag>
NOOP
ZOOMDATA
ZOOMPAPER
TRANSLATEDATA
TRANSLATEPAPER
SPHERICALROTATE
XROTATE
YROTATE
ROLLERBALLROTATE
ZROTATE
TWISTROTATE
<mousemode>
ADJUST
SELECT
<noncurrentframedrawlevel>
FULL
TRACE
<objectalign>
BOTTOM
CENTER
LEFTJUSTIFY
RIGHTJUSTIFY
*=
/=
<originresetlocation>
DATACENTER
VIEWCENTER
<palette>
MONOCHROME
PENPLOTTER
<op>
256
TOP
+=
COLOR
ValueIdentifier
<papergridspacing>
<paperrulerspacing>
<papersize>
<pickaction>
AllowableValues
HALFCENTIMETER
ONECENTIMETER
TWOCENTIMETERS
QUARTERINCH
HALFINCH
ONEINCH
TENPOINTS
TWENTYFOURPOINTS
THIRTYSIXPOINTS
FIFTYPOINTS
ONEINCH
FIFTYPOINTS
TWOCENTIMETERS
SEVENTYTWOPOINTS
LETTER
DOUBLE
A4
A3
CUSTOM1
CUSTOM2
ADD
ADDALL
ADDALLINREGION
CLEAR
COPY
CUT
EDIT
MAGNIFY
PASTE
POP
PUSH
SETMOUSEMODE
ONECENTIMETER
SHIFT
<placementplaneorientation>
<plotapproximationmode>
AUTOMATIC
NONCURRENTALWAYSAPPROX
ALLFRAMESALWAYSAPPROX
<plottype>
CARTESIAN3D
CARTESIAN2D
POLARLINE
SKETCH
ALLDIRECTIONS
BOTTOM
LEFT
LEFTRIGHT
LOWERLEFT
LOWERRIGHT
RIGHT
TOP
UPDOWN
UPPERLEFT
UPPERRIGHT
<pointselection>
NEARESTNPOINTS
ALLPOINTS
<pointstoplot>
SURFACESONLY
ALL
<positionatanchor>
ONCE
NEVER
<printerdriver>
PS
EPS
<printrendertype>
VECTOR
IMAGE
<quickcolormode>
LINECOLOR
FILLCOLOR
TEXTCOLOR
<readdataoption>
NEW
APPEND
REPLACE
<relop>
<
>
<=
>=
==
!=(notequalto)
<>(notequalto).
GREATERTHAN
LESSTHAN
EQUALTO
NOTEQUALTO
TEXTUREFILTER
BOXFILTER
LANCZOS3FILTER
LANCZOS2FILTER
BELLFILTER
TRIANGLEFILTER
BSPLINEFILTER
CUBICFILTER
MITCHELFILTER
RGB
GBR
BRG
RBG
BGR
GRB
<pointerstyle>
<resizefilter>
XYLINE
OCTANTNPOINTS
ALWAYS
GAUSSIANFILTER
<rgblegendorientation>
257
ValueIdentifier
<rgbmode>
AllowableValues
SPECIFYRGB
SPECIFYRG
SPECIFYRB
ALPHA
THETA
PSI
ABOUTVECTOR
TWIST
HORZROLLERBALL
SPECIFYGB
<rotateaxis>
VERTROLLERBALL
<rotateoriginlocation>
VIEWER
DEFINEDORIGIN
<rotationmode>
XYZAXIS
SPHERICAL
<scope>
LOCAL
GLOBAL
<set>
[<setspecifier><setspecifier>...]
<setspecifier>
<integer><integer><integer>[:<integer>]
<shadetype>
SOLIDCOLOR
PANELED
ROLLERBALL
GOURAUD
COLOREDPANELED
<sidebarsizing>
MAXOFALL
DYNAMIC
<sizeunits>
GRID
FRAME
<skipmode>
BYINDEX
BYFRAMEUNITS
<slicesource>
VOLUMEZONES
SURFACEZONES
POINT
LINEARZONES
SURFACESOFVOLUMEZONES
<slicesurface>
<sortby>
XPLANES
YPLANES
ZPLANES
IPLANES
JPLANES
KPLANES
NONE
BYSPECIFICVAR
BYDEPENDENDTVAR
SPECIFYRG
SPECIFYRB
BYINDEPENDENTVAR
<specifyrgb>
SPECIFYRGB
SPECIFYGB
<spherescatterrenderquality>
LOW
MEDIUM
HIGH.
<standardcolormap>
SMRAINBOW
LGRAINBOW
MODERN
GRAYSCALE
TWOCOLOR
<stipplemode>
ALL
CRITICAL
NONE
<streamdirection>
FORWARD
REVERSE
BOTH
<streamtype>
SURFACELINE
VOLUMELINE
VOLUMERIBBON
VOLUMEROD
TWODLINE
<string>
<charactersequence><charactersequence>d
<stylebase>
FACTORY
CONFIG
<subboundary>
ADD
ADDONLY
ALL
STANDARD
BYTEENCODED
REMOVE
<sunrasterformat>
258
OLDFORMAT
ValueIdentifier
<surfacestoplot>
AllowableValues
BOUNDARYFACES
ALL
IPLANES
JPLANES
KPLANES
IJPLANES
JKPLANES
IKPLANES
IJKPLANES
EXPOSEDCELLFACE
NONE
LEFT
CENTER
RIGHT
MIDLEFT
MIDCENTER
MIDRIGHT
HEADLEFT
HEADCENTER
HEADRIGHT
<textboxtype>
NONE
FILLED
HOLLOW
<threedviewchangedrawlevel>
FULL
TRACE
<thetamode>
DEGREES
RADIANS
ARBITRARY
<tickdirection>
IN
OUT
CENTERED
<tiffbyteorder>
INTEL
MOTOROLA
<transformation>
POLARTORECT
RECTTOPOLAR
<textanchor>
SPHERICALTORECT
RECTTOSPHERICAL
<translucency>
Validintegerfromoneto99.
<twoddraworder>
BYZONE
BYLAYER
<unloadstrategy>
MINIMIZEMEMORYUSE
NEVERUNLOAD
AUTO
<valueblankcellmode>
ALLCORNERS
ANYCORNER
PRIMARYVALUE
<valueblankrelop>
LESSTHANOREQUAL
NOTEQUALTO
GREATERTHAN
LESSTHAN
EQUALTO
GREATERTHANOREQUAL
<valueformat>
INTEGER
FLOAT
EXPONENT
BESTFLOAT
SUPERSCRIPT
RANGEBESTFLOAT
CUSTOMLABEL
TIMEDATE
<valuelocation>
AUTO
NODAL
<varloadmode>
BYNAME
BYPOSITION
<vectortype>
TAILATPOINT
HEADATPOINT
MIDATPOINT
FIT
ZOOM
DATAFIT
SETMAGNIFICATION
AXISFIT
CENTER
TRANSLATE
LAST
COPY
PASTE
PUSH
FITSELECTEDFRAMES
FITALLFRAMES
FITPAPER
MAXIMIZE
LASTVIEW
ZOOM
CELLCENTERED
HEADONLY
<viewmode>
<workspaceviewmode>
TRANSLATE
<xyaxis>
a. In order to color an object using one of the contour variable groups (i.e. assigning the color
to MULTI1, MULTI2, etc.), you must first set the contour variable via the $!GLOBALCONTOUR
command.
259
b. The performance dialog cannot be launched or dropped via the macro language on Windows
platforms.
c. Available in XY-plots only
d. The only difference in using single quotes vs. double quotes for strings is that single quotes prevent the processing of the backslash character \ (that is \n inserts a newline \\ inserts the
backslash itself).
12 - 2
Assignment Value Expressions
Simplevaluesareliteralconstantssuchas1,3,3.5,2.5e17.Complexexpressionsareidentifiedbyan
equationsurroundedby'('and')'delimiters.
Expressionscanbeusedwithinanylayoutormacrofileandsupportallofthecommonoperatorsand
functionsfamiliartomostCandFORTRANprogrammers.
Arithmeticoperatorsincludethecommonmultiply,divide,add,andsubtract(*,/,+and),aswellasa
fewothers(^and **)thatareworthnoting.Theraiseoperator(^,or**)returnstheresultofraisingthe
firstnumberbythesecond.
Expressionsmayalsocontainmacrovariablesandanassortmentofusefulfunctionsandconstants.
Followingaretablesofsupportedfunctionsandconstantsandashortexplanationforeach:
abs(x)
Absolutevalueofx.
acos(x)
Arccosineofxbetween1and1.Returnananglebetween0andpradians.
asin(x)
Arcsineofxbetween1and1.Returnananglebetweenp/2andp/2radians.
atan(x)
Arctangentofx.Returnananglebetweenpandpradians.
atan2(y,x)
Arctangentof y x .Returnananglebetweenpandpradians.
ceil(x)
Smallestintegerlargerthanorequaltox.
cos(x)
Cosineofxinradians.
cosh(x)
Hyperboliccosineofx.
exp(x)
Exponentialofx.
floor(x)
Largestintegersmallerthanorequaltox.
frac(x)
Fractionalpartofx.
int(x)
Integerpartofx.
log(x)
Naturallogarithmofx.
log10(x)
Logarithmtothebase10ofx.
max(x,y)
Largerofxory.
min(x,y)
Smallerofxory.
pow(x,y)
xy.
sin(x)
Sineofxinradians.
sinh(x)
Hyperbolicsineofx.
sqrt(x)
Squarerootofx.
tan(x)
Tangentofxinradians.
tanh(x)
Hyperbolictangentofx.
Constantsarealsosupported,aslistedinthefollowingtable.
BASEe
Naturallogarithmbasee.
DEG
Degreesperradian.
260
Assignment Value Expressions
GAMMA
EulerMascheroniconstant.
PHI
Goldenratio: ( 5 + 1 ) 2 .
PI
p.
RAD
Radiansperdegree.
Thefollowingtableshowstheoperatorprecedenceandassociativityforassignmentvalueexpressions.
Operatorswithhigherprecedencearelistedinthehigherrowsofthetable,whileoperatorsthatareinthe
samerowhavethesameprecedence.Theassociativitydescribeshowanoperatorassociateswithits
operand.
OperatorType
Operators
Expression
()
Power
^**
Unary
+!
Multiplicative
*/
Additive
Relational
>>=<<===!=
LogicalAND
&&
LogicalOR
||
Conditional
?:
Associativity
Left to right.
Right to left.
Right to left.
Left to right.
Left to right.
Left to right.
Left to right.
Left to right.
Right to left.
UnlikeC,relationalexpressionsdonotevaluateto0or1,instead,theyevaluatetotrueorfalse.Assuch,
theymayonlybeusedwithotherlogicaloperators,orwiththeconditionaloperator.
ExamplesofcommonexpressionsusedintheTecplot360macrolanguagefollow(notethatallexpressions
evaluatetoasimple,<dexp>,value):
Inadditiontothemorecommonoperatorsmentionedabove,somerelationalandlogicaloperatorsare
$!If(|b|^2)>(4*|a|*|c|)
$!If|a|>0.0
$!VarSet|root1|=(|b|+sqrt(|b|^24*|a|*|c|)/(2*|a|))
$!VarSet|root2|=(|b|sqrt(|b|^24*|a|*|c|)/(2*|a|))
$!EndIf
$!EndIf
$!VarSet|area|=(PI*|r|**2)
providedtoformcompoundexpressions.Arelation,<relation>,maybeconstructedandusedin
conjunctionwiththeconditionaloperator(?and:)toformcompoundexpressions.Theconditional
operator(?and:)hasthefollowingsyntax:
<relation>?<expressioniftrue>:<expressioniffalse>
where:
<relation>isaconditionalstatementthatevaluatestotrueorfalse,andisformedbyanytwo
subexpressionswhicharecomparedtooneanotherwithoneoftherelationaloperators(>, >=,
<, <=, ==, !=)incombinationwithzeroormoreofthelogicaloperators:logicalNot(!),logical
And(&&),andlogicalOr(||).
<expressioniftrue>isthe<expression>thatisevaluatedifthe<relation>conditionevaluatesto
TRUE.
261
<expressioniffalse>isthe<expression>thatisevaluatedifthe<relation>conditionevaluatesto
FALSE.
ExamplesofcompoundexpressionsusedintheTecplot360macrolanguagefollow(notethatall
compoundexpressionsevaluatetoasimple,<dexp>,value):
$!VarSet|value|=(|stress|>|cutoff|?|cutoff|:|stress|)
$!VarSet|value|=(|x|<1.5&&|y|<=5.5?|x|^6:(|x|+|y|)^3.2)
$!VarSet|root|=(|b|^2>4*|a|*|c|&&|a|>0.0?|b|+sqrt(|b|^2
4*|a|*|c|)/(2*|a|):0)
Itisimportantnottoconfuseanexpressionsrelation,<relation>,thatcontrolstheevaluationofa
compoundexpression,withtheconditionalexpression,<conditionalexp>,thatcontrolstheexecutionof
controlcommandssuchas$!IFand$!WHILE.
Forexample,thefollowingisavalidmacrocommandsinceithasavalidexpressionsyntaxandavalid
controlcommandsyntax:
$!If|a|>(PI*|r|^2)
...
$!EndIf
Thefollowingisalsoavalidmacrocommandbecause,likethelastexample,ithasavalidexpression
syntaxandavalidcontrolcommandsyntax:
$!If(|a|^2)==(|b|>5?1:0)
...
$!EndIf
Thefollowingisnotavalidmacrocommandsinceithasaninvalidexpressionsyntaxandconsequentlyan
invalidcontrolcommandsyntax:
$!If(|a|>PI*|r|^2)
...
$!EndIf
Aswiththeinvalidexampleabove,ifTecplot360encountersarelation,<relation>,withinanexpression,
<expression>(enclosedwithin(and)delimiters),itexpectstofindtheconditionaloperator(?and:)and
thetworequiredexpressionsfollowingthespecifiedrelation.
262
13
Raw Data
Somemacrocommandscontainarawdatasection.Arawdatasectionisdefinedbyusingthekeyword
RAWDATAfollowedbytherawdatavaluesuniquetothemacrocommand.Mostrawdatasectionsstartwith
asinglecountvaluewhichrepresentsthenumberofblocksofrawdatafollowedbytheblocksofrawdata
themselves.ThefollowingtableliststherawdatasectionsfoundinTecplot360macros.
RawDataName
ValueType(s)
perBlock
Notes
<arbfielddata>
NM
p11p12p13...p1M
p21p22p23....p2M
...
pN1pN2pN3...pNM
Where:
Nisthenumberofpoints
Misthenumberofvariablesperdatapoint.
<colormaprawdata>
<integer>
<integer>
<integer>
Red.
Green.
Blue.
<dexp>
Contourlevel.
<extendedcommandrawdata>
<string>
EachlineoftheRAWDATAsectioncontainsanarbitrarytextstring.
Theonlyrequirementisthatthecharactersequence$!(adollar
signfollowedbyanexclamationmark)cannotappearanywherein
thesection.Commentscanbeinsertedbyusing#(theoctothorp).If
encountered,everythingtotherightofthe#(includingthe#itself)
willbeignored.
<geometryrawdata>
(Linesegmentgeometry)
<xyrawdata>
Eachblockcontainsablockof<xyrawdata>,whichformsasingle
polylinewithinthegeometry.
<geometryrawdata>
(3DLinesegment)
<xyzrawdata>
Eachblockcontainsablockof<xyzrawdata>,whichformsasingle
polylinewithinthegeometry.
<geometryrawdata>(circle)
<dexp>a
Onlyonevaluesupplied.Valueistheradius.
<geometryrawdata>(ellipse)
<dexp>a
<dexp>a
Twovaluessupplied.ValuesareRXandRY.
<geometryrawdata>(rectangle)
<dexp>a
<dexp>a
Twovaluessupplied.Valuesarewidthandheight.
<geometryrawdata>(square)
<dexp>a
Onlyonevaluesupplied.Valueisthewidth.
263
Raw Data
RawDataName
ValueType(s)
perBlock
Notes
<xyrawdata>
<dexp>
<dexp>
X.
Y.
<xyzrawdata>
<dexp>
<dexp>
<dexp>
X.
Y.
Z.
a. A count value does not precede the raw data in this case.
Examples:
Example 1:
Rawdataforacirclewithradiusequalto1.7:
RAWDATA
1.7
Example 2:
Rawdataforalinesegmentgeometrywithtwosegments.Segment1has4pointsandsegment2has3
points:
RAWDATA
2
4
1.52.2
1.72.4
1.92.8
2.13.0
3
1.11.7
1.21.9
1.32.0
Example 3:
Rawdatatodefinefivecontourlevels:
RAWDATA
5
1.5
2.6
3.7
4.9
5.5
Example 4:
RawdatatodefinethreeRGBvalues:
RAWDATA
3
000
45100100
90200200
264
Example 5:
Forgreatercontrolofcontourlevelsinamacro,setthelevelswithRAWDATA.Thisexampleallows
youtochoosethenumberoflevels,thensetsnewlevelsbasedontheminimumandmaximumvalues
ofthecurrentcontourvariable.
$!FIELDLAYERSSHOWCONTOUR=YES
$!DrawgraphicsNo
$!GLOBALCONTOUR1VAR=4
$!PromptforTextString|numlevels|
Instructions="Enterthenumberofcontourlevels."
$!Varset|Delta|=((|maxc||minc|)/|numlevels|)
CONTOURGROUP=1
RANGEMIN=|minc|
RANGEMAX=|maxc|
$!Varset|newlevel|=(|minc|+|delta|/2)
$!Loop|numlevels|
$!CONTOURLEVELSADD
CONTOURGROUP=1
RAWDATA
1
|newlevel|
$!Varset|newlevel|+=|Delta|
$!Endloop
$!DrawgraphicsYes
$!REDRAW
265
Raw Data
266
14
Macro Language Limitations
Theonlymacrocontrolcommandsallowedinstylesheetsandlayoutfilesare:
$!VARSETand$!REMOVEVAR
TheonlySetValuecommandallowedincolormapfilesis:
$!COLORMAP
Layoutfiles,stylesheetfilesandcolormapfilescannotcontainanyofthefollowingcommands:
$!OPENLAYOUT
$!READSTYLESHEET
$!LOADCOLORMAP
OnlySetValuemacrocommandsareallowedintheTecplot360configurationfile.
The$!LIMITScommandcanbeusedonlyintheTecplot360configurationfile.
The$!FIELDMAPand$!LINEMAPcommandsmaybeusedintheconfigurationfilebuttheymaynotspecify
anindividualzoneorlinemap.Thisspecialuseof$!FIELDMAPand$!LINEMAPallowsyoutochangethe
defaultattributesforallzonesandlinemappingswhentheyareinitializedinTecplot360.
Thefilenamereferencedinthe$!INCLUDEMACROcommandcannotuseTecplot360macrovariables.
Size limitations:
Maximumnumberofnestedmacrofunctioncalls
10
Maximumnumberofnestedmacroloops
10
MaximumnumberofnestedWhileEndWhileloops
Unlimited.
MaximumnumberofnestedIfEndIfloops
Unlimited.
Maximumnumberofnestedmacroincludes
Maximumnumberofmacrocommands
200,000
Maximumnumberofparameterspermacrofunction
20
Maximumnumberofcharactersinmacrovariablename
31
267
Macro Language Limitations
Maximumnumberofcharactersinmacrofunctionname
Unlimited.
Maximumnumberofmacrovariables
400
268
Part 2 Python
Scripting
15
Using Tecplot 360s Python
Interpreter
15 - 1
Using Python Scripts with Tecplot 360
APythoninterpreterhasbeenaddedtoTecplot360toallowyoutoharnesstheautomationcapabilitiesof
macrosandextendTecplot360sfunctionalityusingstandardPythonlibraries(e.g.FFT)withoutwriting
anaddon.YoumayincorporatePythonscriptswithTecplot360inseveraldifferentways:
1. UsingamacrofilethatcallsPythonmodules.
2. UsingthePythonQuickScriptsdialog.
3. RunningstandalonePythonmoduleslaunchedviathePlayMacroorScriptdialog(accessed
viaScripting>PlayMacro/Script).
RefertoChapter30:WorkingWithPythonScriptsintheUsersManualfordetailsoneachoftheabove
scenarios.
15 - 2
Installation and Setup
WhenyouinstallTecplot360,aPythoninterpreterisincludedin$TEC_360_2010/python,where
$TEC_360_2010isthedirectoryofyourTecplot360installation.InordertoaccessyourPythonscriptsvia
theTecplot360interface,ensurethatthefollowinglineisincludedinyourtecplot.addfile(locatedatbase
directoryofyourTecplot360installation):
$!LoadAddonpythonutil
PythonscriptscanbeaccessedviaScripting>PlayMacro/Script.
It is imperative that your PYTHONHOME and PYTHONPATH environment variables be set
properly. Refer to the Section 30 - 5 Python Installation Notes in the Users Manual for
additional details. This is a Python requirement, not a Tecplot 360 requirement.
SeveralPythonscriptingsampleshavebeenincludedforyourreference.Thesescriptsarelocatedinyour
Tecplot360installationdirectoryandarealsoavailableatwww.tecplottalk.com/python.
271
Using Tecplot 360s Python Interpreter
272
16
Python Syntax Rules
Tecplot360sPythoncommandsarewrapperfunctionstotheTecUtilfunctionsincludedwiththeAddon
DevelopersKit(ADK).TheADKcontainsC/C++functionswhicharethoroughlydocumentedintheADK
ReferenceManual.Eachentryinthemanualincludesanindicatorforwhetherthefunctionisavailableto
thePythoninterpreter.ThesyntaxrequiredforusingTecplot360sPythoninterpreterisdescribedforeach
functionintheADKReferenceManualaswellastheremainderofthischapter.
Refer to www.tecplottalk.com/python for sample Python scripts that you may download
and execute.
16 - 1
Import Modules
YoumustincludethefollowingimportstatementsatthestartofeveryPythonscriptyouwishtousewith
Tecplot360:
importTecUtil
importTecVals
BothoftheabovemodulesareincludedinyourTecplot360distribution.TecUtilcontainstheTecUtil
libraryfunctioncalls.TecValscontainstheenumeratedvalues,setvalueconstantsanddefinesrequiredfor
theTecUtillibrary.
The TecUtil library will work properly only when you are running Tecplot 360. You can not
run Python scripts that use the TecUtil library outside of the Tecplot 360 environment.
YoumayalsoincludeotherPythonlibrariesthatyourscriptrequires,suchasNumPyorSciPy.NumPy
andSciPyarePythonlibrariescreatedforscientificcomputations,suchasFFTandlinearalgebra.You
mayfinditusefultoacquireandinstallthesemodules.Formoreinformation,pleasevisitwww.scipy.org.
273
Python Syntax Rules
16 - 2
Basic Syntax Rules
ThePythonSyntaxforeachTecUtilcommandisprovidedforyouintheADKReferenceManual.Ifyou
arealreadyfamiliarwiththeCsyntaxforthefunctionsyouwishtocall,youmayapplythefollowing
syntaxrulestotheCsyntaxoftheTecUtilfunctions:
TecUtilfunctionInPython,aTecUtilfunctionisreferencedbyTecUtil.<BaseFunctionName>.
Forexample:
CSyntax
PythonSyntax
TecUtilExportCancal()
TecUtil.ExportCancel()
TecUtilFramePop(3)
TecUtil.FramePop(3)
EnumeratedTypeorDefinedValueInPython,prependtheenumeratedtypeordefined
valuewithTecVals..Forexample:
CSyntax
PythonSyntax
TecUtilFrameSetPlotType(Plot
Type_Cartesian3D)
TecUtil.FrameSetPlotType(TecVals.Plot
Type_Cartesian3D
TecUtilDialogLaunch(Dialog_P
robe)
TecUtil.DialogLaunch(TecVals.Dialog_
Probe)
If you will be working extensively with enumerated types, you can import the TecVals
library into your script by adding the following directive:
fromTecValsimport*
This will eliminate the need to append TecVals. However, you may encounter name
conflicts between your pre-existing values and items in the TecVals. These errors may
cause unexpected behavior.
In/OutparametersTheCsyntaxfortheTecUtilfunctionsincludesbothinputsandoutputs
intheargumentlist.ThePython/syntaxexplicitlysetstheoutsfromtheCsyntaxasthe
result(s)forthePythonversionofthefunction.Theinsremaininputparametersforthe
Pythonversionofthefunction.
GiventhefollowingCsyntax:
TecUtilMyFunction(intvar1,
intvar2,
intvar3,/*OUT*/
intvar4);/*OUT*/
ThePythonequivalentis:
Results=TecUtil.MyFunction(var1,var2)
where:
int
int
tuple
var1
var2
Results
intResults[0]var3
intResults[1]var4
Refertothefollowingsectionsforadditionalsyntaxrules,limitationsandexceptions.
274
Input Types
16 - 3
Input Types
VariablesinPythonarenottypedastheyareinC.Instead,allvariablesareeffectivelypointerstoPython
objects.WhenworkingwithTecUtilfunctions,notethatthevariableswillnotbecasttothetypeshownin
theADKReferenceManual,butwillbeequivalenttothePythonbuiltintype,asdescribedinthe
followingtable:
CType
Boolean_t,bool
Pythonbuiltintype
Boolean
int,short,
char(notchar*),
SetIndex_t,
ColorIndex_t,
EntIndex_t,
SmInteger_t,
Integer
LgIndex_t,
NodeMap_t,
Strand_t,
FaceNodeOffset_t,
ElemFaceOffset_t,
FaceBndryItemOffset_t
long,
UniqueID_t,
GeomID,
Text_ID,
Longinteger(unlimitedsize)
Int64_t,
UInt64_t,
FileOffset_t,
MemMapOffset_t
float,double
Float
char*
String
RefertothefollowingsectionsforadditionalinformationonvariabletypesinPython:
StringLists
Sets
NULLPointers
Sequences
ArgList_paTypes
275
Python Syntax Rules
InputParametersWithMixedTypes
OpaqueTypes
16 - 3.1
String Lists
IfavariableisofthetypeString_pa,performthefollowingstepsforthePythonsyntax:
1. Declarealist:
mylist=[val1,val2,...,valn]
2. Inthefunctionprototype,usemylistinlieuoftheStringList_pavariable.
Forexample,giventhefollowingCsyntax:
TecUtilMyFunction(BooleanIsTrue,
StringList_paVarList)
TheequivalentPythonsyntaxis:
mylist=[val1,val2,...,valn]
TecUtil.MyFunction(IsTrue,mylist)
where:
boolean
list
16 - 3.2
IsTrue
mylist
Sets
IfavariableisofthetypeSet_pa,performthefollowingstepsforthePythonsyntax:
1. Declarealistortuple:
mylist=[6,13,15]
or
nine=9.0
mytuple=(0,1,4,9,16,25)
2. Inthefunctionprototype,usemylistormytupleinlieuoftheSet_pavariable.
Forexample,giventhefollowingCsyntax:
TecUtilMyFunction(BooleanIsTrue,
Set_paVarSet)
TheequivalentPythonsyntaxis:
mylist=[1,4,9]
TecUtil.MyFunction(IsTrue,mylist)
where:
boolean
list
or
nine=9.0
276
IsTrue
mylist
Input Types
mytuple=(0,1,4,9,16,25)
TecUtil.MyFunction(IsTrue,mytuple)
where:
boolean
tuple
16 - 3.3
IsTrue
mytuple
NULL Pointers
UsetheNoneobjectinyourPythoncodewhereveraNULLpointerwouldhavebeenpassedinCcode.
Forexample:
success=TecUtil.LineMapSetAssignment(TecVals.SV_Zone,None,0,2)
16 - 3.4
Sequences
ArraysofvaluesinPythonaredefinedaseitheralistoratuple.TecUtilfunctionssupportbothformsof
inputarrays.Squarebracketsareusedtodenotelistsandparenthesesareusedtodenotetuples.Consider
thefollowingexamples:
four=4
nine=9.0
xVals=[0,1.0,2,3.0,4,5]#Okaytomixintegersanddoubles
yVals=(0,1,four,nine,16,25)#Thistuplereferencesother
#objects(fourandnine).
numPoints=len(xVals)
success=TecUtil.CreateSimpleZone(numPoints,xVals,yVals,
TecVals.FieldDataType_Double)
NotethatsomeofthevaluesbeingpassedtoCreateSimpleZoneareintegers,eventhoughthefunction
expectsdoubles.ThisisacceptablethevalueswillbepromotedtotheexpectedtypewithintheTecUtil
gluefunction.
AlsonotethatwhilelistsandtuplesinPythoncanpointtoobjectsofdifferenttypes,includingotherlists,
notallmixturesareacceptabletoTecplot360.Forexample,youcannotinputstringsorreferencesto
anotherlistinafunctionthatexpectsdoubles.
16 - 3.5
ArgList_pa Types
ArgList_patypesareusedinTecUtilfunctionsthatendwiththeletterX.TecUtilfunctionsthatendinthe
letterX(i.e.TecUtil*X)areTecUtilfunctionsthatrequireaflexible,orextended,argumentlistoravaried
numberofarguments.Whereappropriate,astandardargumentlistfunctionisprovidedalongwiththe
extendedversionsothatcommonusesofthefunctionarenotburdenedwiththeadditionalinstructions
requiredfortheextendedversion.
TheArgList_patypemapsnicelytoaPythondictionarynativetype.Dictionariesarelistsofkeyvalue
pairs.
ThefollowingcodesnippetillustrateshowthismightbeusedinacalltoTecUtilStyleSetLowLevelX.Note:
Forbrevity,wehaveomittedcreationofthezoneSetvariable.
TheCcode:
ArgList_paarglist1=TecUtilArgListAlloc();
TecUtilArgListAppendString(arglist1,SV_P1,SV_FIELDMAP);
TecUtilArgListAppendString(arglist1,SV_P2,SV_EDGELAYER);
TecUtilArgListAppendString(arglist1,SV_P3,SV_COLOR);
TecUtilArgListAppendSet(arglist1,SV_OBJECTSET,zoneSet);
TecUtilArgListAppendArbParam(arglist1,SV_IVALUE,(ArbParam_t)Blue_C);
TecUtilStyleSetLowLevelX(arglist1);
277
Python Syntax Rules
TecUtilArgListDealloc(&argList1);:
TheequivalentcodeinPython:
argList=dict()
argList[TecVals.SV_P1]=(TecVals.AppendString,TecVals.SV_FIELDMAP)
argList[TecVals.SV_P2]=(TecVals.AppendString,TecVals.SV_EDGELAYER)
argList[TecVals.SV_P3]=(TecVals.AppendString,TecVals.SV_COLOR)
argList[TecVals.SV_OBJECTSET]=(TecVals.AppendSet,[2])
argList[TecVals.SV_IVALUE]=(TecVals.AppendArbParam,TecVals.Blue_C)
TecUtil.StyleSetLowLevelX(argList)
Notethatthenamestring(secondparameterintheCversionoftheTecUtilArgListAppend*functions)
becomesthekeystringinthePythondictionary.
Thevalueportionofthedictionarymustbeatuple.Thefirstiteminthetupleidentifiesthetypeofdata
usingconstantsfoundintheTecValsmodule.ThetypeidentifierscorrespondtotheArgListAppend*
functionthatyouwouldnormallycallinC:
TecVals.AppendArbParam
TecVals.AppendInt
TecVals.AppendDouble
TecVals.AppendSet
TecVals.AppendStringList
TecVals.AppendArray
Theseconditeminthevaluetupleholdstheactualdata(whatisusuallythethirdparameterintheC
versionoftheTecUtilArgListAppend*function).WhenthedataareintheformofaSet,StringList,or
Array,thenagainthenativePythonlistscanbeused.
Any TecUtil*X function that requires a parameter that is a pointer is not supported by the
Python interpreter.
16 - 3.6
Input Parameters With Mixed Types
IntheADK,ArbParam_tisusedtocastinputparameterswhenthedatabeingpassedmaytakedifferent
forms(integer,double,list,etc.).
WhenaninputparameterisanArbParam_tintheCsyntax,theADKReferenceManualwillindicatethe
typeofdataactuallyexpected(usuallydependingonotherinputparameters).InthePythoncall,simply
usetheappropriatebuiltintype(seealso:Section163InputTypes).
Forexample,whencallingTecUtilStateChangedforZonesAdded,theArbParam_tparameterreferencesa
Set_pa.SinceSet_pamapstoaPythonlist,thecallwouldsimplybe:
TecUtil.StateChanged(TecVals.StateChange_ZonesAdded,[1,2,3])
16 - 3.7
Opaque Types
Somefunctionsreturnapointertoanopaquetype.Thesearereferencesthatcannotbemanipulatedin
thePythoncodetheyareusedonlyasinputparametersforsubsequentcallstootherTecUtilfunctions.In
thesecases,youdonotneedtobeconcernedwiththedatatypethatisreturned.Simplyassignthereturn
objecttoavariableandpassthatvariablebackintothefunctionsthatneedit.
Forexample:
textId=TecUtil.TextCreate(TecVals.CoordSys_Frame,50,50,
TecVals.Units_Frame,3.5,"Hello
World")
TecUtil.TextSetFont(textId,TecVals.Font_Helvetica)
278
Output Types
Opaquetypesinclude:
Menu_pa
AddOn_pa
NodeMap_pa
FaceNeighbor_pa
FaceMap_pa
ElemToFaceMap_pa
FieldData_pa
AuxData_pa
ViewState_pa
UniqueID_t
Geom_ID
Text_ID
16 - 4
Output Types
MostTecUtilfunctionsthatsenddataorsetstylesreturnasinglevalueornoneatall.Ingeneral,these
maptothePythonbooleanorintegertypesshowninSection163InputTypes.Allsuccessfulcallsto
theTecUtilfunctionsreturnanobjectpointer.InthecasewheretheCversionoftheTecUtilfunctionis
void,thereturninPythonpointstoaspecialNONEobject.Seealso:Section163.3NULLPointers.
16 - 4.1
Output Parameters
BecauseofthewaydataarehandledinPython,mostobjectsareimmutable.Argumentstofunctionsare
typicallypassedbyvalueandnotbyreference.Listsaretheprimaryexceptiontothisrule.
Forexample,considerthefollowingCcode:
doublexPos;
doubleyPos;
doubleheight;
doublewidth;
TecUtilFrameGetPosAndSize(&xPos,&yPos,&width,&height);
Pythonwillnotallowustodeclareavariablewithoutanassignment.Italsodoesnothaveanequivalent
tothe&(addressof)operatorinC.
WhentheCversionofaTecUtilfunctionincludesoutputparameters,theyarenotincludedinthe
argumentlist.Thedesiredvaluesarepackedintoatuplewhichbecomesreturnvalue.
returnVals=TecUtil.FrameGetPosAndSize()
print'Xposis',returnVals[0]
print'heightis',returnVals[3]
Notethatthefunctioncalldidnotincludeanyarguments,sincealltheparametersinthisfunctionwere
outputvalues.IftheCfunctionincludedbothinputandoutputparameters,onlytheinputvalueswould
beincludedintheargumentlist.Theoutputvalueswouldbeinthereturnedtupleinthesameorderthat
theyappearedintheoriginalfunction:
#CSyntaxis"voidTecUtilTextGetAnchorPos(Text_IDtextId,double*
xPos,double*yPos,double*zPos)"
returnVals=TecUtil.TextGetAnchorPos(textId)#onlytheText_IDvalue
isincludedinthearguments
print'XPosis',returnVals[0]
print'YPosis',returnVals[1]
Inthisexample,theoriginalfunctionisvoidsothereturnparametersbeginatthefirstiteminthetuple
(index0).Ifthefunctionhadbothareturnvalueandoutputparameters,thenthereturnvaluewouldbein
index0andtheoutputparameterswouldbeginatindex1.
279
Python Syntax Rules
16 - 4.2
Reference Counts
ALLreturnsfromTecUtilfunctionsarenewreferences.ThePythoncodeisthereforetheownerofthese
objects,andisresponsibleforperformingDECREFs(decrementthereferencecount)whentheobjectsare
nolongerneeded.
16 - 5
Exceptions to the Rules
Asmallnumberoffunctionsuseslightvariationstotherulesshownabove.
ViewDealloc
TheCsyntaxindicatesthattheaddressof(&)operatorbeprependedtothevariablename.
SincethisisnotavalidPythonoperator,theopaquepointerispassedinasis.
ContourGetLevels
Thelistoflevelsisreturnedasthethirditeminthereturntuple.InPython,donotcall
TecUtilArrayDeallocasnotedintheinstructions,althoughthereturntupleshouldbede
referencedwhenitisnolongerneeded.
16 - 6
Convenience Functions
Tecplot360sPythoninterpreterincludesasmalllibraryofconveniencefunctionsforreadingandwriting
data.Thefollowingfunctionsareprovided:
ZoneGetDimensions
IOrderedDataValuesGet
IOrderedDataValuesSet
IJOrderedDataValuesGet
IJOrderedDataValuesSet
IJKOrderedDataValuesGet
IJKOrderedDataValuesSet
16 - 6.1
ZoneGetDimensions
ZoneGetDimensionsisanabbreviatedversionofZoneGetInfothatskipsalltheFieldData_pareturns.Ithasthe
followingsyntax:
dims=TecUtil.ZoneGetDimensions(zoneNum)
Onreturn,dimswillreferenceatuplewiththefollowingvalues:
dims[0]
Idimensionforordereddata,ornumberofdatapointsforFEdata.
dims[1]
Jdimensionforordereddata,ornumberofelementsforFEdata.
dims[2]
Kdimensionforordereddata,orthenumberofnodespercellforcellbasedFEdata(triangles,
bricks,tetrahedra,andquadrilaterals),orthenumberoffacesforfacebasedFEdata(polygonsand
polyhedrons).
16 - 6.2
IOrderedDataValuesGet
TheIOrderedDataValuesGetfunctionreadsdatafromtheactiveframeinTecplot360.Thedataare
returnedinalistobjectina1dimensionalformat.ThisfunctioncanbeusedwhetherthedatainTecplot
360areXY,2D,or3D.TheIOrderreferstotheformatofthereturnedlistobject,nottheformatofthe
data.
280
Thefunctionhasthefollowingsyntax:
ptList=TecUtil.IOrderedDataValuesGet(zoneNum,varNum,start,end)
Variable
Type
Optional/
Default/
Return
Notes
zoneNum
Integer
Required
1basedvalueofthezonecontainingdatatoberead.
varNum
Integer
Required
1basedindexofthevariabletoberead.
Start
Integer
Optional/1
1basedindexofthefirstpointtoberead.Ifnot
included,readwillstartatthefirstdatapoint.
End
Integer
Optional/
Lastpoint
1basedindexofthelastpointtoberead(inclusive).If
notspecified,thereadwillgotothelastdatapoint.
ptList
List
Returnobject
Newreference.Listcontainingtherequestedvalues.
Note:ifthestartvalueissetat8,thenptList[0]containsthevaluefortheeighthdatapointinthezone.
16 - 6.3
IOrderedDataValuesSet
TheIOrderedDataValuesSetfunctionupdatesdataintheactiveframeinTecplot360.Thezoneand
variablemustalreadyexistthissimplypopulatesthevalues.Thevaluesarepassedusingalistobjectina
1dimensionalformat.ThisfunctioncanbeusedwhetherthedatainTecplot360areXY,2D,or3D,and
orderedorFEdata.TheIOrderreferstotheformatoftheinputlistobject,nottheformatofthedatain
theframe.
returnVal=TecUtil.IOrderedDataValuesSet(zoneNum,varNum,ptList,start)
Variable
Type
Optional/
Default/
Return
Notes
zoneNum
Integer
Required
1basedvalueofthezonetobemodified.
varNum
Integer
Required
1basedindexofthevariabletobemodified.
ptList
List
Required
Listcontainingthedatavalues.Mustbe1dimensional
(noreferencestootherlists).
Start
Integer
Optional/1
1basedindexofthefirstpointtobeoutput.Pointswill
bewrittentotheendofthelistortheendofthezone
size,whichevercomesfirst.
returnVal
None
Returnobject
16 - 6.4
IJOrderedDataValuesGet
TheIJOrderedDataValuesGetfunctionreadsdatafromtheactiveframeinTecplot360.Theframemust
containordereddata(notFEdata).Thevaluesarereturnedinalistobjectina2dimensionalformat(i.e.a
listoflists).
281
Python Syntax Rules
ptList=TecUtil.IJOrderedDataValuesGet(zoneNum,varNum,startI,endI,
startJ,endJ)
Variable
Type
Optional/
Default/
Return
Notes
zoneNum
Integer
Required
varNum
Integer
Required
startI
Integer
Optional/1
1basedvalueforthestartingIindex.
endI
Integer
Optional/Max
dataI
dimension
1basedvalueofthelastIindex(inclusive).
startJ
Integer
Optional/1
1basedvalueofthefirstJindex.
endJ
Integer
Optional/Max
dataJ
dimension
1basedvalueofthelastJindex.
ptList
List
Returnobject
Newreference.2dimensionallistcontainingthe
requestedvalues.
16 - 6.5
IJOrderedDataValuesSet
TheIJOrderedDataValuesSetfunctionupdatesdataintheactiveframeinTecplot360.Thezoneand
2dimensionalformat(alistofJlists,eachcontainingalistofIvalues).Thedataintheframemustbe
ordereddatainatleast2dimensions.
ptList=TecUtil.IJOrderedDataValuesSet(zoneNum,varNum,ptList,
startI,startJ)
Variable
Type
Optional/
Default/
Return
Notes
zoneNum
Integer
Required
varNum
Integer
Required
ptList
List
Required
(listoflists).
startI
Integer
Optional/1
startJ
Integer
Optional/1
returnVal
None
Returnobject
282
16 - 6.6
IJKOrderedDataValuesGet
TheIJKOrderedDataValuesGetfunctionreadsdatafromtheactiveframeinTecplot360.Theframemust
containordereddata(notFEdata).Thevaluesarereturnedinalistobjectina3dimensionalformat.
ptList=TecUtil.IJKOrderedDataValuesGet(zoneNum,varNum,startI,endI,
startJ,endJ,startK,endK)
Variable
Type
Optional/
Default/
Return
Notes
zoneNum
Integer
Required
varNum
Integer
Required
startI
Integer
Optional/1
endI
Integer
Optional/Max
dataI
dimension
1basedvalueofthelastIindex(inclusive).
startJ
Integer
Optional/1
endJ
Integer
Optional/Max
dataJ
dimension
1basedvalueofthelastJindex.
startK
Integer
Optional/1
1basedvalueofthefirstKindex.
endK
Integer
Optional/Max
dataJ
dimension
1basedvalueofthelastKindex.
ptList
List
Returnobject
Newreference.3dimensionallistcontainingKMaxlists
ofJMaxlistsofIMaxvalues.
16 - 6.7
IJKOrderedDataValuesSet
TheIJKOrderedDataValuesSetfunctionupdatesdataintheactiveframeinTecplot360.Thezoneand
3dimensionalformat(foreachKthereisalistofJlists,eachcontainingalistofIvalues).Thedatainthe
framemustbeordereddatainatleast3dimensions.
ptList=TecUtil.IJOrderedDataValuesSet(zoneNum,varNum,ptList,
startI,startJ,startK)
Variable
zoneNum
Type
Integer
Optional/
Default/
Return
Required
Notes
283
LOADPYFILE NAME
varNum
Integer
Required
ptList
List
Required
lists.
startI
Integer
Optional/1
startJ
Integer
Optional/1
startK
Integer
Optional/1
1basedvalueofthefirstKindex.
returnVal
None
Returnobject
16 - 7
Tecplot 360 Macro Commands for Python Modules
OneofthebestmethodsforworkingwithPythonscriptsinTecplot360istocombinethescriptswith
Tecplot360macrocommands.RefertoSection301CombiningPythonscriptswithmacrocommands
intheUsersManualfordetailsonthisprocedure.Thesyntaxforthemacrocommandsthatworkdirectly
withthePythoninterpreteraddonisdescribedbelow.
LOADPYFILE NAME
Description:UsethisfunctiontoloadaPythonmoduleviaamacrofile.
Syntax:
$!EXTENDEDCOMMAND
COMMANDPROCESSORID='PythonUtility'
COMMAND='LOADPYFILENAME="<string>"
Parameter
NAME
Type
=<string>
Required
Notes
NameofPythonmoduletoload/reload.Donotincludethe
pathorextension.NOTE:thefilemustresideinadirectory
includedinyourPYTHONPATHdefinition.RefertoSection15
2InstallationandSetupfordetails.
MODIFYPYPATH
Description:UsethiscommandtotemporarilymodifyyourPYTHONPATHvariable.Thevariablewillbeset
forthedurationoftheTecplot360sessionusingthemacrocommand/file.
Syntax:
$!EXTENDEDCOMMAND
COMMAND='MODIFYPYPATHFOLDER="<string>"
Parameter
FOLDER
284
Type
=<string>
Required
Y
Notes
NameoffoldertobeaddedtothePythonsearchpath.
RUNPYFUNCTION
RUNPYFUNCTION
Description:UsethiscommandtoexecuteaPythonfunctionviaamacrofile.NOTE:Beforeexecutinga
Pythonfunction,youmustfirstloadthemodulethatcontainsitviatheLOADPYFILENAME
command.
Syntax:
$!EXTENDEDCOMMAND
COMMAND='RUNPYFUNCTIONMODULE="<string>"FUNCTION="<string>"
ARGUMENTS="<arg1>,<arg2>,..."'
Parameter
MODULE
Type
=<string>
Required
Notes
Nameofmodulecontainingthedesiredfunction(donot
includepathorextensions).NOTE:themodulemustalready
beloadedusingtheLOADPYFILENAMEcommand.
FUNCTION
=<string>
ARGUMENTS
=<arg1>,
<arg2>,...
Y,forany
functionthat
requiresinput
parameters.
16 - 8
Nameofquickmacrofunctiontoexecute.
InputargumentsfortheFunction,enteredascommaseparated
valuesinaquotedstring.Thenumberofindividualarguments
andtheargumenttypesdependonfunction.
Notes for Novice Python Users
IfyouarenewtoPythonscripting,pleasebeawareofthefollowingconcepts:
TherearenotanyPythonequivalentsforTecUtilAlloc,Deallocormanipulationfunctions.Use
thebuiltinPythonfunctions.
ThecommentsymbolinPythonis#.
285
RUNPYFUNCTION
286
251, 252, 253, 254, 255, 256, 257, 258, 259
Index
Symbols
251, 252, 253, 254, 255, 256, 257, 258, 259
<anglespec> 251
<axisalignment> 251
<bitdumpregion> 251
<boolean> 252
<borderlocation> 252
<clipping> 252
<compressiontype> 252
<conditionalexp> 252
<constraintop2mode> 252
<contourcoloring> 252
<contourlabellocation> 252
<curveinfomode> 252
<dataloadstrategy> 252
<dialogname> 253
<draworder> 254
<edgetype> 254
<fielddatatype> 254
<fillmode> 254
<framecollection> 254
<ijklines> 255
<interpptselection> 255
<isosurfaceselection> 255
<linktype> 255
<macrofunctionvar> 255
<macrointrinsicvar> 256
<macroparameter> 256
<macroparameterlist> 256
<macrouserdefvar> 256
<macrovar> 256
<mirrorvar> 256
<mousebuttonclick> 256
<mousebuttondrag> 256
<mousemode> 256
<noncurrentframedrawlevel> 256
<op> 256
<originresetlocation> 256
<pickaction> 257
<plotapproximationmode> 257
<plottype> 257
<positionatanchor> 257
<printrendertype> 257
<relop> 257
<resizefilter> 257
<rgblegendorientation> 257
<rgbmode> 258
<scope> 258
<set> 258
<setspecifier> 258
<sortby> 258
<string> 258
<stylebase> 258
<subboundary> 258
<thetamode> 259
<threedviewchangedrawlevel> 259
<transformation> 259
<translucency> 259
<valueblankrelop> 259
<valuelocation> 259
<varloadmode> 259
<xyaxis> 259
$!ACTIVEFIELDFILEMAPS 55
$!ACTIVELINEMAPS 56
$!ADDMACROPANELTITLE 56
$!ALTERDATA 56, 57, 58
$!ANIMATECONTOURLEVELS 58
$!ANIMATEIJKBLANKING 59
$!ANIMATEIJKPLANES 60, 61
$!ANIMATELINEMAPS 62, 63
$!ANIMATESLICES 61, 63
$!ANIMATESTREAM 62, 64
$!ANIMATETIME 64
$!ANIMATEZONES 64, 65
$!ATTACHDATASET 66
$!ATTACHGEOM 67, 68, 69
$!ATTACHTEXT 69, 70, 246
$!BASICCOLOR 71, 72, 243
$!BASICSIZE 72, 233
$!BLANKING 73, 75
$!BRANCHCONNECTIVITY 75
$!BRANCHFIELDDATAVAR 76
$!BREAK 76
$!COLORMAP 121
incolormapfiles 267
$!COLORMAPCONTROLCOPYSTANDARD 77
$!COLORMAPCONTROL
REDISTRIBUTECONTROLPOINTS 77
$!COLORMAPCONTROLRESETTOFACTORY 77
$!COMPATIBILITY 77
$!CONTINUE 78
$!CONTOURLABELS 78
$!CONTOURLABELSADD 78, 79
$!CONTOURLABELSDELETEALL 79
$!CONTOURLEVELSADD 80
$!CONTOURLEVELSDELETENEAREST 80, 81
$!CONTOURLEVELSDELETERANGE 81
$!CONTOURLEVELSNEW 81
$!CONTOURLEVELSRESET 82
$!CONTOURLEVELSRESETTONICE 82, 83
$!CREATEBOUNDARYZONE 83
$!CREATECIRCULARZONE 83
$!CREATECONTOURLINEZONES 84
$!CREATEFEBOUNDARY 85
$!CREATEFESURFACEFROMIORDERED 85
$!CREATEISOZONES 86
$!CREATELINEMAP 86
$!CREATEMIRRORZONES 86, 87
$!CREATENEWFRAME 87
$!CREATERECTANGULARZONE 88
$!CREATESIMPLEZONE 88, 89
$!CREATESLICEZONEFROMPLANE 89
$!CREATESLICEZONES 89
$!CREATESPHERICALZONE 90
$!CREATESTREAMZONES 91
$!DATASETUP 91
$!DEFAULTGEOM 92
$!DEFAULTTEXT 92
$!DELAY 93
$!DELETEAUXDATA 93
$!DELETELINEMAPS 94
$!DELETEZONES 94, 95
$!DOUBLEBUFFEROFF 95
$!DOUBLEBUFFERON 95
$!DOUBLEBUFFERSWAP 95
287
INDEX
$!DRAWGRAPHICS 96
$!DROPDIALOG 96
$!DUPLICATELINEMAP 96
$!DUPLICATEZONE 96
$!ELSE 97
$!ELSEIF 98
$!ENDIF 136
$!ENDLOOP 156
$!ENDWHILE 207
$!EXPORT 99
$!EXPORTCANCEL 99
$!EXPORTFINISH 99
$!EXPORTNEXTFRAME 100
$!EXPORTSETUP 100, 101
$!EXPORTSTART 101
$!EXTENDEDCOMMAND 102
$!EXTRACTFROMGEOM 102, 103
$!EXTRACTFROMPOLYLINE 103
$!FIELDLAYERS 104
$!FIELDMAP 104, 238
restrictionsonusing 267
$!FILECONFIG 107
$!FONTADJUST 110
$!FRAMECONTROLACTIVATEATPOSITION 111
$!FRAMECONTROLACTIVATEBYNAME 111, 112
$!FRAMECONTROLACTIVATEBYNUMBER 112
$!FRAMECONTROLACTIVATENEXT 111
$!FRAMECONTROLACTIVATEPREVIOUS 111
$!FRAMECONTROLACTIVATETOP 110
$!FRAMECONTROLDELETEACTIVE 114
$!FRAMECONTROLFITALLTOPAPER 114
$!FRAMECONTROLMOVETOBOTTOMACTIVE 113
$!FRAMECONTROLMOVETOBOTTOMBYNAME 113
$!FRAMECONTROL
MOVETOBOTTOMBYNUMBER 113, 114
$!FRAMECONTROLMOVETOTOPACTIVE 112
$!FRAMECONTROLMOVETOTOPBYNAME 112
$!FRAMECONTROLMOVETOTOPBYNUMBER 113
$!FRAMENAME 115
$!FRAMESETUP 115
$!GETAUXDATA 116
$!GETCONNECTIVITYREFCOUNT 117
$!GETCURFRAMENAME 117
$!GETFIELDVALUE 118
$!GETFIELDVALUEREFCOUNT 118
$!GETNODEINDEX 119
$!GETUSERINPUT
replacedby$!PROMPTFORTEXTSTRING 172
$!GETVARLOCATION 119
$!GETVARNUMBYNAME 120
$!GLOABLPAPER 127
$!GLOBALCOLORMAP 121
$!GLOBALCONTOUR 122, 124, 234, 250
$!GLOBALEDGE 125
$!GLOBALFRAME 125
$!GLOBALLINEPLOT 126
$!GLOBALLINKING 127
$!GLOBALPOLAR 128
$!GLOBALRGB 128
$!GLOBALSCATTER 129, 241
$!GLOBALTHREED 131, 249
$!GLOBALTHREEDVECTOR 133
$!GLOBALTIME 134
$!GLOBALTWODVECTOR 134
288
$!IF 136
$!INCLUDEMACRO 136
$!INTERFACE 136
$!INVERSEDISTINTERPOLATE 145
$!ISOSURFACEATTRIBUTES 146
$!ISOSURFACELAYERS 148
$!KRIG 148
$!LAUNCHDIALOG 149
$!LIMITS 149, 267
$!LINEARINTERPOLATE 150
$!LINEMAP 151, 245
$!LINEPLOTLAYERS 154
$!LINKING 154
$!LOADADDON 155
$!LOADCOLORMAP 156
$!LOOP 156
$!LOOPENDLOOP 76
$!MACROFUNCTION 24, 156
$!NEWLAYOUT 157
$!OPENLAYOUT 157
$!PAGE 18, 158, 240
$!PAGECONTROLallfunctions 159
$!PAGECONTROLCREATE 160
$!PAGECONTROLSETCURRENTBYNAME 160
$!PAGECONTROLSETCURRENTTONEXT 160
$!PAGECONTROLSETCURRENTTOPREVIOUS 160
$!PAGENAME 161
$!PAGENAME 161
$!PAUSE 161
$!PICKADD 161
$!PICKADDALL 162
$!PICKADDALLINRECT 162
$!PICKCLEAR 164
$!PICKCOPY 164
$!PICKCUT 164
$!PICKEDIT 164
$!PICKMAGNIFY 166
$!PICKPASTE 167
$!PICKPOP 167
$!PICKPUSH 167
$!PICKSETMOUSEMODE 167
$!PICKSHIFT 168
$!PLOTTYPE 168
$!POLARDAXIS 169
$!POLARTORECTANGULAR 169
$!POLARVIEW 170
$!PRINT 170
$!PRINTSETUP 170, 244
$!PROMPTFORFILENAME 172
$!PROMPTFORTEXTSTRING 172
$!PROMPTFORYESNO 173
$!PROPAGATELINKING 173
$!PUBLISH 173
$!QUIT 174
$!RAWCOLORMAP 174
$!READDATASET 175
$!READSTYLESHEET 177
$!REDRAW 177
$!REDRAWALL 178
$!REMOVEVAR 178
$!REMOVEVAR 178
instylesheetsandlayoutfiles 267
$!RENAMEDATASETVAR 178
$!RENAMEDATASETZONE 179
$!RESET3DAXES 179
$!RESET3DORIGIN 179
$!RESET3DSCALEFACTORS 180
$!RESETVECTORLENGTH 180
$!ROTATE2DDATA 180
$!ROTATE3DVIEW 181
$!RUNMACROFUNCTION 181
$!SAVELAYOUT 182
$!SET3DEYEDISTANCE 182
$!SETAUXDATA 182
$!SETDATASETTITLE 183
$!SETFIELDVALUE 183
$!SETFRAMEBACKGROUNDCOLOR 184
$!SETSTYLEBASE 184
$!SHARECONNECTIVITY 185
$!SHAREFIELDDATAVAR 185
$!SHIFTLINEMAPSTOBOTTOM 186
$!SHIFTLINEMAPSTOTOP 186
$!SHOWMOUSEPOINTER 186
$!SKETCHAXIS 186
$!SLICEATRRIBUTES 187
$!SMOOTH 190
$!STREAMATTRIBUTES 191
$!STREAMTRACEADD 193, 194
$!STREAMTRACEDELETEALL 195
$!STREAMTRACEDELETERANGE 195
$!STREAMTRACERESETDELTATIME 195
$!STREAMTRACESETTERMINATIONLINE 196
$!SYSTEM 196
$!THREEDAXIS 197, 236, 237
$!THREEDVIEW 198
$!TRANFORMCOORDINATES 199
$!TRIANGULATE 200
$!TWODAXIS 201, 229, 230, 231, 232, 237, 239, 241, 247
$!VARSET 19, 23, 202
instylesheetsandlayoutfiles 267
$!VIEWAXISFIT 203
$!VIEWAXISNICEFIT 203
$!VIEWCENTER 204
$!VIEWCOPY 204
$!VIEWDATAFIT 204
$!VIEWFIT 204, 205
$!VIEWLAST 205
$!VIEWMAKECURRENTVIEWNICE 205
$!VIEWNICEFIT 205
$!VIEWPASTE 205
$!VIEWPUSH 205
$!VIEWRESETTOENTIRECIRCLE 206
$!VIEWSETMAGNIFICATION 206
$!VIEWTRANSLATE 206
$!VIEWZOOM 206
$!WHILE 207
$!WHILE$!ENDWHILE 76
$!WORKSPACEVIEW 207
$!WORKSPACEVIEWFITALLFRAMES 208
$!WORKSPACEVIEWFITPAPER 208
$!WORKSPACEVIEWFITSELECTEDFRAMES 208
$!WORKSPACEVIEWLASTVIEW 208
$!WORKSPACEVIEWMAXIMIZE 208
$!WORKSPACEVIEWTRANSLATE 208
$!WORKSPACEVIEWUNMAXIMIZE 209
$!WORKSPACEVIEWZOOM 209
$!WRITECOLORMAP 210
$!WRITECURVEINFO 210
$!WRITEDATASET 210
$!WRITESTYLESHEET 211
$!XYLINEAXIS 212, 248
Numerics
2Daxes
settings 201
2Ddraworder 259
2Dfieldplots 79
vectorplots 134
3Daxes
attributes 197
reset 179
3Dplots
globalattributes 131, 198
3Drotation 258
3Dvectorplotattributes 133
A
Actioncommands 55
Activeplanes 255
Activezones 55
Addon
loading 155
Addoncommands
sendtoaddon 102
Addonstyle 251
ALIGNINGCONTOURLABELS 116
Alignment 256
axis 251
ALLOWDATAPOINTADJUST 137
ALLOWDATAPOINTSELECT 137
ALLOWHWACCELERATION 142
Alterdatacommand 56
ALWAYSPOPACTIVEFRAME 137
Anchor 229
text 70
Angle
rotate3D 131, 181, 198
Angleunits 251
Animatecommands 5866
ANIMATESTREAKLINESmacrocommand 213, 214
Animation
contourlevels 58
frames 63
IJKblanking 59
IJKplanes 60, 61
isosurface 61
linemappings 62
slice 63
streammarkers 64
streamtraces 64
Time 64
zone 64, 65
zones 65
Areastyle 230
Arrays
forPython 277
Arrowhead
angle 68
289
INDEX
attachment 68, 251

size 68
style 68, 251
ARROWHEADSIZES 72
macrocommand 213, 215
AUTOREDRAWISACTIVE 137
Auxiliarydata 116
delete 93
macrovariables 20
setting 182
Axes 203, 204, 230, 231, 232
2Dsettings 201
3Dattributes 197
adjusttocenterdata 204
adjusttonicefit 205
adjusttoniceview 205
assignvariables 169, 197, 201
attributes 229, 230, 231, 232, 247
dependentmode 251
fittodata 203
gridarea 230, 236
gridareas 236
gridlines 237
inSketchframemode 186
labels 239
nicefit 203
number 203, 204
polar
attributes 169
reset 179
resetscalefactors 180
tickmarks 247
attributes 247
labelformatting 246
labels 247
titlemode 251
titleposition 251
variables 198
XYLineattributesassignments 212
Axisalignment 251
B
Backbuffer
swaptofront 95
Backingstore 251
BACKINGSTOREMODE 137
basicsizelistsubcommand 233
BEEPONFRAMEINTERRUPT 137
Blanking 73, 75
animate 59
IJK 73
Value 259
value 73
BOLDFACTOR 110
Boundarycondition 252
Boxtype 252
Breakoutcommand 76
Buffercommands 95
C
CACHELIGHTDISPLAYLISTSONLY 137
CALCPARTICLEPATHmacrocommand 213, 215
290

CALCULATEmacrocommand 213, 218
CALCULATEACCURACYmacrocommand 213, 219
Caseofcharacters 19
Celllabels 130
Center
view 204
Charactersequence 252
Circle
rawdata 263
Circularzone 83, 90
Clipping 68
Color
fillcolor 68
flooding 235
palette 256
rgb 71
text 70
Colormap 76, 121, 252
active 77
assignmentvalueoptions 258
colorspectrum 121
contour 233
override 234
control 76, 252
controlcommands 7678
controlpoints 77, 233
distribution 233, 252
files 267
grayscaleoutput 243
loading 156
override 234, 235
rawdata 263
rawuserdefined 233
resettodefault 121
RGBvalues 174
standard 77
userdefined 77
writetofile 210
Colorpalette 256
Colortext 70
COLORMAPFILE 108
Colors 68, 71, 252
assigningRGBvalues 243
quickedit 257
RGB 128, 243
setcommandinmacros 71
shading 243
zebrashading 249
CommandLine 11
Commandparameters 17
Conditionalexecute 207
Conditionalexpressions 252
Configuration
OpenGL 242
Configurationfile
SetValuemacrocommands 267
Configuringdropdownmenus 233
Continuecommand 78
Continuetoexecuteasetofcommands 207
Contour
colormap 233
override 234
zebrashading 249
Contour color map 77
linemode 252
plottype 252
Contourcolormap 77
Contourcommands 7883
Contourlabels 78, 122, 252
Contourlevels 81, 252
animate 58
animation 59
delete 80
new 81
rawdata 263
Contourplot
animation 58
attributes 105
colormap 77, 121
globalchanges 122
label 78
labels 122
levels 58
add 80
copytoanotherframe 212
delete 80, 81
reset 82
show 104
variable 122
Controlcommands
If...Endif 136, 262
Controlpoints 77
contourcolormaps 233
Conveniencefunctions
Pythonscripting 280284
Coordinates
convertpolartorectangular 169
Copypickedobjects 164
Curvedetails
writetofile 210
Curveequations
write 210
Cut
deletepickedobjects 164
Cutawayviews
blanking 73
D
Data 137
adjustaxestofit 203
centerinview 204
fittoaxisgridarea 204, 205
read 175
reading 257
rotate 180
rotating 19
smooth 190
Dataalteration 56
Dataextraction 102
Datafit 204
Datalabels 130
Datamanipulation 56
polartorectangularcoordinates 169
Dataoperations
zonenumberspecification 58
Datapoint
adjust 137
moving 137
select 137
Dataset
attachtoframecommand 66
naming 183
variable 118
write 210
Datasetvariables
setvalue(frommacrovariable) 183
Datasharing
branchingconnectivity 75
branchingvariables 76
connectivity 185
fieldvariables 185
referencecount 118
Datatype 88, 252
DATAFILEVARLOADMODE 108
Debuggingmacrofiles 12
Debuggingmacros 11
Delay 93
Delete
objects 164
Deletepickedobjects 164
Derivativeposition 253
DERIVATIVEBOUNDARY 137
Destination
map 96
zone 145
Dialog
dropaTecplotdialog 96
Display
render 144
Displaymessage 161
DISPLAYBOUNDARIES
DOAUTOFNAMEEXTENSION 108
Double 254
Doublebuffer
compoundfunctions 95
turningoff 95
turningon 95
Doubleexpression 254
Draworder 259
Linemappings 186
sortlevel 131, 198
Dropdownmenus 233
Duplicatezones 96
Duralabels
labelingnode 255
E
Edgeattributes 105
Edgeplot
show 104
Edgesetting 254
Edit
globaleditonpickedobjects 164
Ellipse
rawdata 263
ENABLEDELAYS 140
ENABLEINTERRUPTS 140
ENABLEPAUSES 140
ENABLEWARNINGS 140
EncapsulatedPostScript
previewimage 254
291
INDEX
EndLoopcommand 156
Environmentvariables 22
EQUATIONFILE 108
Equations 57
Errorbars
plottypes 254
Examples
2Daxesattributes 169, 201
3Daxisattributes 198
activatingfieldzonesforplotting 55
Addingcontourlevels 80
addingLinemaps 56
addingzonestothesetofactivezones 55
assigningattributesforfieldplots 107
assigningaxesattributes 231
assigningcontrolpointforsmallrainbowcolor
map 121
assigningthemediumlinepatternlength 72
attributesappliedtoallframes 126
attributesfordefaultgeometry 92
attributesforexportingimagefiles 101
axisgridareaborders 230, 237
axisgridlinessettings 237
axismodes 187
axistickmarkattributes 248
axistickmarklabels 247
basicsizevalues 233
circlerawdata 264
colormapcontrolpoints 234
contourattributes 124
contourlevelsrawdata 264
Createanewzoneforeachcontourlineonanexisting
contourplot. 85
Creatingmirrorzones 87
Deletingcontourlevels 81
editpickedobjects 158, 166
inversedistanceinterpolation 145
Linelegendanddatalabels 127
linemappingsattributes 153
lineplotlayersonoroff 154
linesegmentgeometryrawdata 264
macrofunctionfile 12
makingLinemapsactiveforplotting 56
makinglinemapsactiveforplotting 56
makingzonesactiveforplotting 55
mappingmonochromehardcopyoutput 244
papercharacteristics 159
papersizedimensions 240
pathinformation 109
pickallinrectangle 163
positioningframeonthepaper 115
Preplotlaunchcommand 92
printattributes 171
rectanglesettings 241
removingLinemaps 56
removingzonesfromthesetofactivezones 56
RGBvaluesrawdata 264
setparametersfordynamicframeattributes 116
setting(X,Y,Z)triplets 249
setting(X,Y)positions 249
setting3Dglobalattributes 133
settingattributesof2Dvectorplots 135
settingattributesof3Dvectorplots 134
settingattributesofdefaultfont 93
292
settingattributesofTecplotinterface 144
settingcharacterspacingandsizingforfonts 110
settingcolormapoverrides 234
settingcolorvalues 243
settinggridareaborders 230, 237
settingIJandKindices 238
settingIJKblankings 75
settingnumbersformats 239
settingreferencescattersymbolsattributes 241
settingscatterattributes 131
settingsomeTecplotlimits 150
settingsymbolshapes 245
settingtextshapes 246
settingthered,green,andbluecomponents 72
textbox 245
turningonscatterlayers 104
Usingvalueblankings 75
XYLineaxisattributes 212
zebrashadingattributes 250
Examplesofmacros 219, 223
Exitcommand 174
Export 99
image
attributes 100
Exporting
layouttopaperorfile 170
Exportingimages
filetypes 254
formats 254
Expression 254
EXTENDEDCOMMANDmacro 213
Extract
3Dslice 89
isosurfaces 86
EXTRACTFLOWFEATURE
EXTRAPOLATESOLUTION
Eyedistance 182
F
FEboundary 85
FEsurfaces 86
Fieldmappings
numberoffieldmappings 21
Fieldplots 104
contourattributes 122
plotlayers 104
scatterattributes 130
Fieldvalue
setting 183
Fieldvariablequery 118
Fieldmaps
setactivezonescommand 55
specify 55
File
opendataset 175
openlayout 157
savedataset 210
savelayout 182
Filename
promptfor 172
Filenames 103
Filepaths
Finite-element
configuration 107
Finiteelement
createFEsurfacezones 86
Finiteelementdata
zoneboundarycreation 85
Firstlineofmacrofile 17
Floodedcontourplots 252
FNAMEFILTER 108
Font 93, 254
Fonts 70
spacing 110
Formats
inmacrovariables 24
Formattingnumbers 239
FORTRANlikeequations 56
Frame 66
activateframebyname 111
activateframebynumber 112
activateframebyposition 111
activatenextframe 111
activatepreviousframe 111
activatetopframe 110
alwayspopactiveframe 137
attachtodatasetcommand 66
create 87
delete 160
deleteactiveframe 114
dynamicattributes 115
fitframestopaper 114
getname 117
invisibleborders 143
moveactiveframetotop 112
moveframetobottombyname 113
moveframetobottombynumber 113
moveframetotopbynumber 113
movetotopbyname 112
movesactiveframetobottom 113
text(attach) 69
viewlast 205
Framecontrolcommands 110114
Framecoordinates 252
Framemanipulating 254
Framemodes 195, 254
Framestyle
attributes 184
FRAMEHEADERFORMAT 125
FRAMEHEADERHEIGHT 125
Frames
fitallintoworkspaceview 208
fitselectedframesinview 208
numberofframes 21
settingglobalattributes 125
Frameswithpickhandles 208
FRAMETEXTSIZES 72
G
Geometries
defaultattributes 92
Geometry
attachcommand 67
attachtoframe 67
attributes 92
color 68
defaults 92
extractdata 102
Geometryattributes 67
Geometryrawdata 263
Geometrytype 68, 255
circle 255
ellipse 255
rectangle 255
square 255
Globalattributes 121127
Globaledit
onpickedobjects 164
Graphics
turndrawingonoroff 96
Grayscaleoutput 243
Grid
precisedot 240
Gridarea 236
Gridareaborder 230, 237
Gridareaexample 241
Gridcoordinates 252
Gridlines 237
gridareasubcommand 236
gridlinedetailsubcommand 237
Gridlines 237
I
I,J,orKindices
setting 238
Ifcommand 136
IJKBlanking 75
IJKblanking 73
animation 59
blankingdomain 255
IJKindex 238
ijksubcommand 238
IJKindices
minimum/maximumasvariables 20
IJKplanes
animation 60
Image
export 99
attributes 100
Imagestyle 255
IMAGERENDERING 142
ImportModules 273
Indexranges 238
setting 238
indexrangesubcommand 238
Infinite
seeLoop
Initialdialogplacement 235
INITIAL3DSCALE 116
initialdialogplacementsubcommand 235
INITIALPLOTFIRSTZONEONLY 140
INPUTDATAFILE 108
INPUTLAYOUTFILE 108
Integer 255
INTEGRATEmacrocommand 214, 221
Integration
accessingresults 223
Interface
Data 137
launchdialog 149
293
INDEX
render 144
setattributes 136
Internalmacrovariables 22
INTERPNPOINTS 137
Interpolation
inversedistancemethod 145
kriging 148
linearmethod 150
pointerselection 257
INTERPPTSELECTION 137
INTERRUPTCHECKINGFREQUENCY 140
Intrinsicvalues 256
INVDISTEXPONENT 137
INVDISTMINRADIUS 137
Inversedistanceinterpolation 145
Iorderedzones 201
ISFILLED 68
Isosurface
animate 61
Isosurfaces 146
Isosurfaces
zonecreation 86
J
Jacobian
macroexample 219
K
Krigdrift 255
KRIGDRIFT 137
Kriging 148
KrigingDrift 254
KRIGRANGE 137
KRIGZEROVALUE 137
L
Label
contour 78
Labels
tickmarks 246
LARGESTEP 143
Layout
clear 157
new 157
printingtopaperorfile 170
saving 182
Layoutfiles
macrocontrolcommands 267
Layouts
attachdatasetofanotherframe 66
opening 157
Lightsourceshading 131, 198
changesettings 121
Lightingeffects 255
Limitations 267
Limits
setinTecplot 149
Linemappings 56, 62, 96
animation 62
attributes 151
create 86
delete 94
draworder 186
duplicate 96
294
numberoflinemappings 21
setactivemappingscommand 56
shifttobottomoflist 186
shifttotopoflist 186
writecoefficients 210
writecurveinformation 210
linemappings
showsymbols 154
Linemaps
activate 56
attributes 267
defaults 267
see Line mappings 94
specify 56
Linepattern 68
Linepatterns 255
Lineplotlayers 154
Lineplots 63
settingglobalattributes 126
showlines 154
Linespace
text 70
Linethickness 68
Linearinterpolation 150
actiononoutsidepoints 255
LINEARINTERPCONST 137
LINEARINTERPMODE 137
LINEPATLENGTHS 72
Lines
lineplots 154
LINETHICKNESSES 72
Loaddata 175
Loadingyourownmacrofunctionfile 12
Logaxes 252
Loop
SeealsoInfinite
Loopcommand 156
M
Macrocommandsummary 27
Macrocommandsyntax 17
Macrocommands 9, 11, 17
ANIMATESTREAKLINES 213, 214
ATTACHINTEGRATIONRESULTS 213, 215
CALCPARTICLEPATH 213, 215
CALCTURBULENCEFUNCTION 213, 218
CALCULATE 213, 218
CALCULATEACCURACY 213, 219
conditionallyprocessing 136
DISPLAYBOUNDARIES 214, 220
EXTRACTFLOWFEATURE 214, 220
EXTRAPOLATESOLUTION 214, 221
INTEGRATE 214, 221
macrovariables 19
major 27
SAVEINTEGRATIONRESULTS 214, 223
SETFIELDVARIABLES 214, 224
SETFLUIDPROPERTIES 214, 224
SETGEOMETRYANDBOUNDARIES 214, 226
SETREFERENCEANDFIELDVARIABLES 226
SETREFERENCEVALUES 214
SETUNSTEADYFLOWOPTIONS 214, 227
spacing 18
Macrocontrolcommands 55
Macro definitions 12
allowedinstylesheetsandlayouts 267
Break 76
Continue 78
Delay 93
includemacro 136
Loop...Endloop 156
pause 161
runmacrofunction 181
stopexecution 161
systemcommands 196
While...Endwhile 207
Macrodefinitions 12
Macrofiles 17
debugging 12
firstline 17
nestingonefilewithinanother 136
Macrofunction
execute 181
Macrofunctionfiles
example 12
loadingyourown 12
Macrofunctions 11, 12
definition 156
retaining 11
runcommand 23
Macrolanguage
restrictionsandlimitations 267
MacroPanel 12
Macropanel 157
title 56
Macrosyntax
examples 262
Macrovariable
setfieldvalue 183
values 22
Macrovariables
assigningstrings 23
assigningvalueorstring 202
assigningvalues 22
function 23
getactiveframename 117
getfieldvalue 118
name 22
removeuserdefined 178
selectvariable(byname) 120
strings 23
usingformats 24
Macroviewer 12
MACROFILE 108
Macros 9, 11, 12
debugging 11
runningfromthecommandline 11
runningfromtheQuickMacroPanel 12
runningfromtheTecplotinterface 11
Macrosvs.macrofunctionsvs.macrocommands 11
Magnification
setforview 206
zoom 206
Magnifypickedobjects 166
Majormacrocommands 27
ManagingTecplotmacros 11
Mandatoryparameters 17
Mappings
delete 94
duplicate 96
Masscalculationexample 223
Massfluxexample 223
Massweightedaverageexample 223
MAXCHRSINTEXTLABELS 150
MAXCUSTOMCOLORSININTERFACE 141
Maximumindex 223
Maximumvalues
asvariables 20
MAXNUMCONTOURLEVELS 150
MAXPTSINALINE 150
MEDIUMSTEP 143
Meshattributes 105
Meshplot
show 104
Meshplots
plottypes 256
Message
display 161
Minimumvalues
asvariables 21
MINPIXELSFORDRAG 141
Mirrorzones
create 86
Moderncolormaps 121
Modifiers
commandspecific 17
Modules
Pythonimport 273
Monochromehardcopy 243
Mousebuttonassignments 251
Mousemode
setforpicking 167
Mousepointer 257
Movepickedobjects 168
Moviefiles 59, 61, 62, 63, 64, 65, 66
N
Name
getframename 117
Negativevalues 57, 223
NULLPointers 277
Numberformat 239
Numberformats 259
Numberofcyclesforanimation 62, 63, 64
Numberofellipsepoints 68
numberofzones 21
numberformatsubcommand 239
Numbers
formattinginmacrovariables 24
NUMPTSALLOWEDBEFOREAPPROX 141
NUMSMOOTHPASSES 137
NUMSTREAMRAKE 116
NUMSTREAMRAKEPOINTS 116
O
Object
size 72
OKTOEXECUTESYSTEMCOMMAND 142
Opaquetypes 278
OpenGL
renderingsettings 242
OpenGLrendering 242
OPENGLCONFIG 142
295
INDEX
Operatingsystem
usingasvariable 21
Operatingsysteminstructions 196
Optionalboxsettings 245
Optionalparameters 17
Output
fileconfiguration 107
OUTPUTASCIIDATAFILE 108
OUTPUTBINARYDATAFILE 108
OUTPUTLAYOUTFILE 108
OUTPUTLAYOUTPACKAGEFILE 108
Overrides
colormap 234
P
Page
color 158
createpage 160
namethecurrentpage 161
setnextpagetoactive 160
setpreviouspagetocurrent 160
setspecifications 158
showgrid 158
showruler 158
Pagecontrolcommands 159161
Paper 239
color 158
fitwithinworkspaceview 208
gridspacing 257
setspecifications 127, 158
showgrid 158
showruler 158
size 127, 239
Paperrulerspacing 257
Papersize 257
papersizesubcommand 239
Parameter
assignment 17
ParameterAssignmentValues 251
Parameterassignmentvalues 228
Parameterassignments 17, 251
Parametersubcommands 17, 229
Parameters
datasetupcommand 91
forCFDAnalyzermacrocommands 214
Parametersfordynamicframeattributes 115
Paste 167
fromviewpastebuffer 205
Paths
configuringforoutput 107
Patternlength 68
Pausemacroexecution 161
PERCENTAGEOFPOINTSTOKEEP 142
Pick
copypickedobjects 164
deletepickedobjects 164
globaleditonpickedobjects 164
magnifypickedobjects 166
mousemodeset 167
movepickedobjects 168
objectatgivenlocation 161
objectsinrectangle 162
objectsoftype 162
objectstodelete 164
296
pastepickedobjectsfrombuffer 167
poppickedobjects 167
pushpickedobjectsback 167
Pickcommands 161168
PICKHANDLEWIDTH 142
Planes
animate 60
PlotApproximation 257
Plotlayers 104, 154
fieldplots 104
PlotType 257
PlotTypes
Vector 259
PLOTAPPROXIMATIONMODE 142
Plottingpoints 257
Points
writetofile 210
Pointstoplot 257
POINTTEXTSIZES 72
Polaraxes
attributes 169
Polarcoordinates
converttorectangular 169
Polyline
extractingdata 103
rawdata 263
Popping
pickedobjects 167
Position
textexample 246
Precisedotgrid 240
precisegridsubcommand 240
Preferences
basiccolor 71
basicsize 72
showcoordinates 136
PREPLOTARGS 91
Print
lastfilenameprinted 21
PRINTDEBUG 142
Printers 257
rendering 257
Printing
attributes 170
topaperorfile 170
Promptcommands 172173
Push
pickedobjects 167
viewstack 205
Pythonscripting 271??
arrays 277
conveniencefunctions 280284
importmodules 273
inputtypes 275279
NULLpointers 277
opaquetypes 278
outputtypes 279
Q
Querydialogs 172
Queryfunctions 117121
QuickEdit
colors 257
QuickMacroPanel 12, 157
QUICKCOLORMODE 142
title 56
QUICKCOLORMODE 142
Quitcommand 174
R
RangeParameters 57, 222
RasterMetafile 101
Rawdata 89, 103, 196
circle 264
colormap 263
contourlevel 263
contourlevels 264
geometry 263
linesegmentgeometry 264
RGBvalues 264
sectionofmacrocommands 263
square 263
values 263
XY 264
XYZ 264
RawUserDefinedcolormaps 233
RAWDATA
example 264
Readdata 175
rectsubcommand 240
Rectangle 240
rawdata 263
Rectangles 240
settings 240
Rectangularzones
create 88
Redraw 177
RedrawAll 178
Referencescattersymbol 130
attributes 241
Referencescattersymbols 241
refscatsymbolsubcommand 241
Removeuserdefinedmacrovariable 178
rendconfigsubcommand 242
Rendering
offscreen 144
withOpenGL 242
Retainingmacrofunction 11
RGB 243
components 71
rgbsubcommand 243
Rotate
2Dplot 180
3Dplots 131, 181, 198
Rotatea3Dplot
example 19
ROTATION
details 142
Rotation 258
axis 258
originlocation 258
resetrotationorigin 179
rotationorigin 179
Ruler 158, 257
RULERPADDING 143
RULERTHICKNESS 143
RUNDISPLAYLISTSAFTERBUILDING 142
Running
macrofunction 23
Runningmacros
fromthecommandline 11
fromtheQuickMacroPanel 12
fromthetecplotinterface 11
Tecplot 11
S
Save
colormap 210
curveinformation 210
dataset 210
stylesheet 211
SCALE 143
Scalefactors
reset 180
Scatter
legend 130, 147
sizingbyvariable 130, 147
Scatterattributes 106
Scatterplot
show 104
Scatterplots 106
setglobalattributes 129
Scattersymbolattributes 241
Scattersymbols 241
Scopeoftext 68
Scratchdatatype 91
SCRATCHDATAFIELDTYPE 91
SCRBACKGROUNDCOLOR 143
SCREENRENDERING 142
Scripting
Python 271??
Selectobjects 161
SETFIELDVARIABLES
SETFLUIDPROPERTIES
SETREFERENCEANDFIELDVARIABLES
macrocommand 226
SETREFERENCEVALUES
macrocommand 214
Setting(X,Y,Z)triplets 249
Setting(X,Y)positions 249
Settingattributes
referencescattersymbols 241, 242
Settingcolorvalues 243
SettingI,J,orKindices 238
Settingindexranges 238
Settingnumberformats 239
Settingsymbolshapes 244
Settingzebrashadingattributes 249
Settings
OpenGLrendering 242
SetValuecommands
incolormapfiles 267
macroconfigurationfiles 267
Shadeattributes 106
Shademaps 243
297
INDEX
shademapsubcommand 243
Shading 243
Shiftpickedobjects 168
SHOWCONTINUOUSSTATUS 143
SHOWCOORDINATES 143
SHOWCOORDINATESWITHSELECTORADJUSTOR 1
43
SHOWFRAMEBORDERSWHENOFF 143
showpanelflag 12
SHOWSTATUSLINE 143
SHOWTEXTGEOMSINAPPROXVIEW 143
SHOWWAITDIALOGS 143
Simplezone
create 88
Singleanglebrackets 229, 251
Size 233
object 72
paper 127
preference 72
setcommandinmacros 72
Sizelimitations
Sizelists 233
Sizepreferences 72
Sizeunits 258
Sketch
axis 186
Skipmode 258
Slice
animate 63
createslicezonecommand 89
Planetypeassigned 21
positioning 21
Slicesource 258
Slices 258
createzones 89
globalsettings 187
Slicing 258
SmallRainbowcolormaps 77
SMALLSTEP 143
SMOOTHBNDRYCOND 137
Smoothing
data 190
SMOOTHWEIGHT 137
SNAPTOGRID 125
SNAPTOPAPER 125
Solutiontime 21
Sourcemaps 96
Sourcezones 85, 86, 87
Specify
fieldmaps 55
linemaps 56
STARTSLICEPOS 21
Stepspercycleinanimation 64
STEPSIZE 143
Stipple 258
Stopmacroexecution 161
Streamdashes
animation 64
Streammarkers
animation 64
STREAMSTARTPOS 21
Streamtrace
positioning 21
298
Streamtracecommands 191196
add 193
deleteall 195
deleterange 195
resettimeincrements 195
setterminationline 196
Streamtracepaths 64
Streamtraces
animate 64
animation
dashesormarkers 64
createzones 91
deleteall 195
direction 258
globalsettings 191
type 258
STREAMTYPE 21
Strings
assigning 23
STROKEFONTLINETHICKNESS 110
STYLEFILE 108
Stylesheet
read 177
writetofile 211
Stylesheets
Subscript 110
SUBSUPFRACTION 110
SunRasterformatoptions 258
Superscript 110
SurfaceEffects 105
Surfacestoplot 259
Symbolshape 244, 255
Symbolshapes
setting 244
Symbols
lineplots 154
symbolshapesubcommand 244
SYMBOLSIZES 72
Syntax
examplemacros 262
forCFDAnalyzermacrocommands 214
Systemcommandinstructions 196
Systemenvironmentvariables 22
T
TECHOME
usingasvariable 21
Tecplot
starting 5
TecplotInterface 11
Tecplotinterface
setattributes 136
Tecplotmacro 9
tecplot.mcr 12
TEMPFILEPATH 109
Text 245
anchor 70, 259
angle 70
attachcommand 69
attributes 69, 93
box 70
centering 71
characterheight 245
Text box 70
color 70
default 93
defaults 92, 93
display 161
fonts 70, 246, 254
frame 69
height 246
labelbox 245
labeldetails 246
linespacing 70
promptfor 172, 173
settingfontandposition 246
settingfonts 245
shape 245
spacing 110
subscript 110
superscript 110
textbox 70
thickness 246
zone(attach) 70
Textbox 70
Textboxes 245, 259
Textshape 70
Textbox 70
textboxsubcommand 245
textshapesubcommand 245
Tickmarks 247
attributes 247
axis 247
directions 259
labelformatting 246
labels 246, 247
settingattributes 248
ticklabeldetailsubcommand 246
TICKLENGTHS 72
Tickmarklabels
alignment 255
tickmarkdetailsubcommand 247
TIFFbyteorder 259
Time
Animation 64
Title
dataset 183
Transform
coordinates 199
polartorectangularcoordinates 169
Translate
view 206
workspaceview 208
Translatepickedobjects 168
TRANSLATION 143
Translucency 259
TRIANGLEKEEPFACTOR 137
U
Undo
viewonly 205
UNIXHELPBROWSERCMD 144
USEAPPROXIMATEPLOTS 144
USEDISPLAYLISTS 144
USEDOUBLEBUFFERING 144
Userinputdialogs 172
Userinterface
launchdialog 149
setattributes 136
Userdefinedvariables 22
USETECPLOTPRINTDRIVERS 144
V
Valueblanking 73, 259
cellmode 259
Values
display 130
macrovariables 19
setfieldvalue 183
Variablelists 155
Variables
3Daxis 198
assignto2Daxis 169, 201
assignto3Daxes 197
assigningvalues 202
contours 122
environment 22
initializing 202
internal 19
location 119
macrofunctions 23
removeuserdefinedmacrovariable 178
renaming 178
scattersymbolsizing 130, 147
variablenumber 120
vector 134, 135
VECTDEFLEN 116
VECTMINLEN 116
Vectorplot
attributes 133
Vectorplots 259
variables 134
vectorformat 106
Vectorvariables 135
minimum/maximumasvariables 20
Vectors
lengthreset 180
referencevector 133, 135
Vectorsplot
show 104
Verticalbars(|s) 19
View
axisfit 203
axisnicefit 203
center 204
copy 204
datafit 204
fit 204, 205
fitallframes 208
fitpaperinworkspace 208
fitselectedframes 208
last 205
magnify 206
maximize 209
maximizeworkspaceview 208
nicefit 205
paste 205
returntolastview 208
rotate 181
shiftworkspace 208
translate 206
299
INDEX
zoomworkspace 209
Viewcommands 202207, 207209
Viewcompoundfunctionfamily 202
Viewmode 259
Viewstack 205
retrievelastview 205
Viewer/Debugger 9
volumeattributes 106
Volumeobjects 248
Volumesurfaces
createFEsurfaces 86
VOLUMEMODE 106
volumeobjectstoplotsubcommand 248
W
Whilecommand 207
Workspace
colormapdialog 77
view 208
translate 208
unmaximize 209
viewmode 259
Workspacecommands 207209
Write
colormap 210
dataset 210
stylesheet 211
X
Xaxisgridlines 237
XORCOLOR 144
XY
rawdata 264
XYLineaxesattributes
assign 212
XYlineplots
coordinatescale 252
curveinformation 252
curvetype 252
errorbars 254
XYmapping
functiondependency 254
xysubcommand 249
XYvectors 249
XYZ
rawdata 264
vectors 249
xyzsubcommand 249
Z
Zclip 131, 198
Zebrashading 249
attributes 249
zebrashadesubcommand 249
Zone
animation 64, 65
attachgeometry 68
attributes 104
Zoneboundaries
finiteelementdata 85
forfiniteelementdata 85
Zonenumbers
specify 58
Zones 21, 68
300
animate 64, 65
attributes 267
concatenate 91
create 8384, 9091
createisozonescommand 86
createmirrors 86
createrectangular 88
defaults 267
delete 94
duplicate 96
FEsurface 86
new 88
streamtraces 90
renaming 179
specifynumber 58
triangulate 200
Zoom
pickedobjects 166
view 206
workspaceview 209

Tecplot 360 Scripting Guide

Uploaded by

Document Information

Original Title

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

Tecplot 360 Scripting Guide

Uploaded by

Copyright:

Available Formats

Scripting Guide

Tecplot 360 Macro Commands

Introduction to Macro Commands ...................................................9

Managing Macros ........................................................................................11

Writing Forward Compatible Macros ............................................13

Macro Command Syntax .......................................................................17

Macro Variables ............................................................................................19

Macro Command Summary ................................................................ 27

Macro Commands ....................................................................................... 55

Macro Commands for the Analyze Menu ................................ 213

Parameter Subcommands .................................................................. 229

Parameter Assignment Values, Expressions, and

Raw Data ......................................................................................................... 263

Macro Language Limitations ............................................................ 267

Using Tecplot 360s Python Interpreter .................................. 271

Python Syntax Rules .............................................................................. 273

Part 1 Tecplot 360

Introduction to Macro Commands

Macros vs. Macro Functions vs. Macro Commands

Running Macros from the Command Line

Running Macros from the Tecplot 360 Interface

Running Macros from the Quick Macro Panel

Writing Forward Compatible Macros

Macro Command Syntax

System Environment Variables

Assigning Values to Macro Variables

Assigning a String to a Macro Variable

Assigning a String to a Macro Variable

Replacement Text Use

Macro Function Variables

Using Formats in Macro Variables

Using Formats in Macro Variables

Macro Command Summary

Macro Command Summary

Macro Command Summary

Macro Command Summary

Macro Command Summary

$!FRAMECONTROLMOVETOBOTTOMBYNAME .................................................................................. 113

Macro Command Summary

$!GLOBALPAPER ................................................................................................................................................ 127

Macro Command Summary

Macro Command Summary

$!PICKPOP ........................................................................................................................................................... 167

Macro Command Summary

Macro Command Summary

Macro Command Summary

$!VIEWDATAFIT ................................................................................................................................................ 204

Macro Command Summary

$!WRITECURVEINFO ........................................................................................................................................ 210

Macro Command Summary

Macro Command Summary

<<volumeobjectstoplot>> .................................................................................................................................... 248

$!COLORMAPCONTROL [<groupnumber>] REDISTRIBUTECONTROLPOINTS

$!COLORMAPCONTROL [<groupnumber>] REDISTRIBUTECONTROLPOINTS

$!COLORMAPCONTROL [<groupnumber>] COPYSTANDARD

$!COLORMAPCONTROL [<groupnumber>] RESETTOFACTORY

$!CONTOURLABELS [Required-Control Option]

$!CONTOURLEVELS [Required-Control Option]

$!DOUBLEBUFFER [Required-Control Option]

$!DOUBLEBUFFER [Required-Control Option]

File Name Filters:ValidcharactersareupperorlowercaseAZ,and09.Eachfiltershouldbe

$!FRAMECONTROL [Required-Control Option]

$!PAGECONTROL [Required-Control Option]