NSOFT - read.pudn.comread.pudn.com/downloads106/ebook/438459/ANSOFT... · macro.bk : front.fm iii...

macro.bk : title.fm 1 Mon Jan 15 11:41:10 2001

NSOFTNSOFT

Maxwell 3D

Introduction to the AnsoftMacro Language

January 2001

macro.bk : front.fm ii Mon Jan 15 11:41:10 2001

ii

NoticeThe information contained in this document is subject to change withoutnotice.Ansoft makes no warranty of any kind with regard to this material, including,but not limited to, the implied warranties of merchantability and fitness for aparticular purpose. Ansoft shall not be liable for errors contained herein or forincidental or consequential damages in connection with the furnishing,performance, or use of this material.This document contains proprietary information which is protected bycopyright. All rights are reserved.Ansoft CorporationFour Station SquareSuite 200Pittsburgh, PA 15219(412) 261 - 3200

Motif is a trademark of the Open Software Foundation, Inc.UNIX is a registered trademark of UNIX Systems Laboratories, Inc.Windows is a trademark of Microsoft® CorporationOpenWindows is a trademark of Sun Microsystems, Inc.

© Copyright 1994 - 2001 Ansoft Corporation

macro.bk : front.fm iii Mon Jan 15 11:41:10 2001

iii

Printing HistoryNew editions of this manual will incorporate all material updated since theprevious edition. The manual printing date, which indicates the manual’scurrent edition, changes when a new edition is printed. Minor corrections andupdates which are incorporated at reprint do not cause the date to change.Update packages may be issued between editions and contain additionaland/or replacement pages to be merged into the manual by the user. Notethat pages which are rearranged due to changes on a previous page are notconsidered to be revised.

Welcome!This manual is a user’s reference for using the Ansoft Macro Language inMaxwell 3D.

Installation GuideBefore you use Maxwell 3D, you must:1. Set up your system’s graphical windowing system.2. Install the Maxwell software, using the directions in the installation

guide.

If you have not yet done these steps, refer to the installation guides and thedocumentation that came with your computer system, or ask your systemadministrator for help.

Other ReferencesFor detailed information on the Maxwell 3D commands, refer to the onlinehelp provided with Maxwell 3D.For detailed information on the Control Panel commands, refer to the onlinehelp for the Maxwell Control Panel.

Edition Date Software Revision

1 November 1999 5.0

2 January 2001 6.0

macro.bk : macro.toc 1 Mon Jan 15 11:41:10 2001

Contents-1

Table of Contents

1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1Macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2

Recording a Macro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2Executing a Macro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3

Script Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4Command Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4Entering a Script Command from the Command Prompt . . . . . . . 1-5Script Command Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6

The name of the script command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6Syntax Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6

Script Control Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8Command Constructs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8

IF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8REPEAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8WHILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9

Mathematical Conditions and Expressions . . . . . . . . . . . . . . . . . . . . 1-10Conditionals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-10Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11

Macro Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-12Defining Macros in the Macro Editor . . . . . . . . . . . . . . . . . . . . . . . . . 1-12Tool Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-13Macro Editor Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-13

2. Macro Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13D Modeler Macro Example — Current Rings . . . . . . . . . . . . . . . . . . 2-2

Simplified Macro Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6


Contents-2

Complete Current Ring Macro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7Post Processing Macro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-10

3. Default Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1Default Module Script Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2

Add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2Assign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2ClearAll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2ClearFunctions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2ClearVars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3ComplexFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3ComponentCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3DatabaseAddRow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4DatabaseGetColumns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4DatabaseGetField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4DatabaseGetRows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5DatabaseSetField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5DeleteDatabase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5Div . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5DoubleListSetComponent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6DumpDatabase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6Echo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6EQ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6Error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7EvaluateExpression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7ExportDatabase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7FileClose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7FileExec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-8FileExecErrExitIf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-8FileExecPause . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-8FileExists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-8FileOpen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-8FileRead . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-9FileRecord . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-10FileRecordAppend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-10FileRecStop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-11FileWrite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-11FuncDef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-11FuncHelp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-11FuncSave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-12FuncUndef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-12GE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-12GetDateAndTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-12


Contents-3

GetFileList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-12GetFileName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13GetMacroPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13GetMacroPathList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13GetProductId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13GetUserOption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13GetVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13Global . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-14GlobalAssign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-14GT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-14Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-14ImportDatabase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-14ImportRawDatabase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-15IsCommandEnabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-15LE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-15Log10 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-15LT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-15Minus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-16Mul . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-16NE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-16NewDatabase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-16OR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-17ParametricFileExec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-17Pos2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-18Pos3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-18Pos3Dist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-18PrependMacroPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-18PrintHelp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-18PrivateAssign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-18ProtectedAssign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-19RandomFraction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-19RemoveMacroPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-19SetEchoEnabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-19SetMacroPathList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-19SetRecordingEnabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-19SetUnitsOfQuant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-19SetUserOption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-20Sleep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-20StrConcat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-20String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-21StringListSetComponent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-21Strlen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-21Strstr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-21Sub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-21


Contents-4

Substring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-22Unassign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-22Vec2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-22Vec3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-22XOR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-22

4. Generic Script Commands . . . . . . . . . . . . . . . . . . . . . . 4-1Generic Module Script Commands . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2

CascadeAll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2CascadeProjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2CascadeViews . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2CloseWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2ModuleIsPromptVisible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2ModulePrefsRevert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2ModuleSavePrefs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2ModuleSidewinLeft . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3ModuleSidewinRight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3ModuleToggleMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3ModuleTogglePrompt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3ModuleToolbar(direction) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3ModuleToolbarHide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3NewWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3PrintEntire . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3PrintProj . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4PrintRect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4PrintSubwin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4PrintView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4TileAllGrid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4TileAllHrz . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4TileAllVrt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4TileProjectsGrid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4TileProjectsHrz . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5TileProjectsVrt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5TileViewsGrid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5TileViewsHrz . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5TileViewsVrt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5

mod3proj Script Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6AbortTimeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6ActivateView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6CheckOverlap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6DeleteCS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6DeSelect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6DispShaded . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7DispWire . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7


Contents-5

FlushEvents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7GetCurPos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7GetDouble “Prompt” . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7GetLong “Prompt” . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8GetNumObjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8GetNumViews . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8GetObjectName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8GetOrigin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8GetPosition “Prompt” . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9GetString “Prompt” . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9GetUnitConv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9GetUnitName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9GetVector “Prompt” . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10GlobalCS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10Hide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10HideOrient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10HideRegion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10HideSel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-11LocalCS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-11Lorigin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-11ObjectCS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-11ObjectExists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-11Origin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12Origin? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12PrintProj . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12PrintView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12Recolor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12RestoreCS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12RotateCS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13RotatedCS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13SaveCmdWin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13SaveCS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13SaveWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-14Select . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-14SelInBox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-14SetCurPos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15SetObjectCS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15Show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15ShowAll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15ShowOrient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15ShowRegion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15ToggleRegion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16UnrotatedCS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16


Contents-6

VerifyRegion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16VisByItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16XAxisAboutTo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16XAxisTo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16XUnitVec? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17YAxisAboutTo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17YAxisTo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17YUnitVec? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17ZAxisAboutTo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17ZAxisTo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17ZUnitVec? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17

mod3view Script Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18AutoGrid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18FitAll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18FitAllViews . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18FitSel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18Lookat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18Ortho . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18Persp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19PolarGrid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19RectGrid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19ResetViews . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19RotView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19Shaded . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-20Viewpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-20WireFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-20

5. Executive Script Commands . . . . . . . . . . . . . . . . . . . . 5-1M3DFS Script Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2

GetCurrSolnFileset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2GetForceOnGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2GetLastSolveInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2GetLorentzForceOnObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3GetMatrixCellValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3GetTorqueOnGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3LaunchBoundaries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3ProjDir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3ProjName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3

Executive Parameters Module Script Commands . . . . . . . . . . . . . . 5-4AddObjectGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4DeleteObjectGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4ExcludeObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4IncludeObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4SetCurrentObjectGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4


Contents-7

SetCurrentSetupType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5SetTorqueAxisAnchorPoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5SetTorqueAxisEndPoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5

Solution Setup Script Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6SaveSetup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6SetAdaptiveInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6SetCondResidual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6SetCondSAdaptiveInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7SetCondSolutionType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7SetCurrentSolnPrmsType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7SetFrequency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7SetMeshType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-8SetNonLinResidual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-8SetNop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-8SetResidual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-8SetSolveFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9SetSolvePrms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9SetSolver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9SetSolveType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9SolnPrmsDone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-10

6. 3D Modeler Script Commands . . . . . . . . . . . . . . . . . . . 6-1Modeler3 Script Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2

Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2Circle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2Close3d . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2ColorFaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2ColorSel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2Connect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3CoverOutl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3CoverSheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3CreateArc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3Cyl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4DefColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4DefColor? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4DeSelect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4DetachFaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5DisablePlineStitch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5DupAxis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5DupLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5DupMirror . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5EditPline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6EditPline - AddVert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6


Contents-8

EditPline - AddVert3D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6EditPline - Arc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6EditPline - CancelPline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6EditPline - ClosePline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6EditPline - DelEdge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-7EditPline - DelVert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-7EditPline - EdgeGeom . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-7EditPline - EdgeMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-7EditPline - EndPline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-7EditPline - EndTangent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8EditPline - FindPlineVertNo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8EditPline - GetPlineVert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8EditPline - Insvert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8EditPline - JoinSplines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8EditPline - MoveArcMidPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-9EditPline - MoveVert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-9EditPline - OpenPline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-9EditPline - SetArcAngle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-9EditPline - SetArcRadius . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-9EditPline - SetArcToFillet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-10EditPline - SplitSpline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-10EditPline - StartTangent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-10EnablePlineStitch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-10Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-10ExpAssign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-11ExpClear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-11ExpDel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-11ExpEval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-11ExpInc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-11ExpLoad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-12ExpSave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-12FitRegion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-12FitSel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-12HealAllObjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-12Helix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-13HideRegion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-13Import3D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-13Intersect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-13LaunchScaleDialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-13Mirror . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-14ModelerModifyFunction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-14Move . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-14New3d . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-14Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-14


Contents-9

ProjPrefs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-15Read2d . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-15Read3d . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-15Recolor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-15Rectangle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-16Redo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-16Region . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-16Rename . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-16ResetViews . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-17Rotate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-17Save2d . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-17Save3d . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-17SaveSAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-17SaveSLD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-17Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-18Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-18SelClear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-18SelColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-18SelCopy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-18SelCut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-18SelPaste . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-19SetModel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-19SetNonModel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-19SetSldTol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-19SetUnits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-19ShowRegion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-19Split . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-20Stitch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-20Subtract . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-20SweepAxis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-20SweepPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-21SweepTwist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-21SweepVec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-21Uncover . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-21UnDel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-21Undo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-22Unite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-22

7. Material Manager Script Commands . . . . . . . . . . . . . . 7-1Materials Script Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2

EditBHCurve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2MaterialKernel Script Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2

GetSelectedMaterial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2MaterialAccept . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2


Contents-10

MaterialAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2MaterialAssign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3MaterialClear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3MaterialDerive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4MaterialModifyFunction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4MaterialRevert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4MaterialSelect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4MaterialSetProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5MaterialSetType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5MaterialUnderive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6SaveMaterialDatabase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6

8. Boundary Manager Script Commands . . . . . . . . . . . . 8-1Boundary Module Script Commands . . . . . . . . . . . . . . . . . . . . . . . . 8-2

AssignBoundary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2DefineBndFuncs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2ExitBnds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2SaveBnds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2SelectByName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2SelectFacesIntersection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2SetDefaultUnits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2SetEddyEffect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3ShowConductionPaths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3ToggleViewBndVis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3VerifyCondPaths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3

Boundary Kernel Script Commands . . . . . . . . . . . . . . . . . . . . . . . . . 8-4AssignCurrDenTerm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4BoundaryModifyFunction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4BuildCondPaths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4CheckTerminals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4ClearAllBnds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4ClearCurrDenTerms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-5ClearSelBoundary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-5ClearSelection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-5CreateTerminals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-5PickFaceById . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-5PickFaceByRay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-5ReprioritizeSelBoundary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-6SelectObjByName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-6SelectObjFaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-6SetAllBndUnitsToCurrent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-6SetBndName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-6SetBndUnitsToCurrent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-6SetBoolean . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-7


Contents-11

SetBoundary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-7SetEndpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-7SetMSRelation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-8SetOrigin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-8SetScalar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-8SetScalarFor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-8SetStartPoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-9SetStringFor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-9SetUpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-9SetVector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-9SetVpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-10SwapBoolean . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-10SwapStrandedBoolean . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-10ToggleDispCurrent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-10ToggleEddyEffect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-10TogglePickBndByName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-10TogglePickBndByRay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-11TogglePickObjByName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-11TogglePickObjByRay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-11TogglePickObjObjInt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-11UndoClear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-11UseSuggestedEddyEffectVals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-11

9. Meshmaker Script Commands . . . . . . . . . . . . . . . . . . . 9-1Mesh3D Script Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2

CloseProject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2DeleteAllSeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2DeleteAllSeedNonInteractively . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2DeleteMesh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2DelSelFaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2DeSelBodies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2DoModelAnalysis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-3FurtherImproveQuality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-3GExit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-3GWriteMesh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-3HiddenLineOff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-3HiddenLineOn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-3HiddenLineOnOff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-3HideAll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-3HideMesh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-4ImproveQuality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-4ImproveSurfTri . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-4InteractiveDeleteMesh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-4


Contents-12

InteractiveMakeInitMesh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-4MakeInitialMesh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-4MeshDisplayMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-5MeshInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-5ModelAlone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-5NewProject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-5NonInteractiveDeleteMesh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-5OpenProject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-5PullPointsToTrueSurfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-5RefreshView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-5SaveSeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-6SaveWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-6SeedingInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-6SeedRefineCommandToKernel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-7SelectOneFace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-8SelFaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-8SetBoxScope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-8SetDisplayOn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-8SetFaceterRefinements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-9SetMeshDisplayMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-9SetTriScope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-9SetViewKindWireFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-9ShadedMesh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-9ShowHideMesh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-10ShowMesh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-10ShowPoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-10ShowSurfTri . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-10ShowTets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-10SmoothenMesh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-10WriteMesh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-10WriteMeshAs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-10

10. Post Processor Script Commands . . . . . . . . . . . . . . 10-13D Post Processor Command Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2

PostProcessor3D Script Commands . . . . . . . . . . . . . . . . . . . . . . . . . 10-2ArrowPlotOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2CalcVisToggle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2CascadeAll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2CascadeProjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2CascadeViews . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2CHelp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2CloseProject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-3CloseWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-3DeleteGeometry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-3


Contents-13

DeletePlot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-3DisablePlineStitch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-3EditBoundDisplay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-3EditFunctions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-3EditPline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-4EditPline - AddVert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-4EditPline - AddVert3D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-4EditPline - Arc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-4EditPline-CancelPline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-4EditPline - Closepline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-5EditPline - DelEdge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-5EditPline - DelVert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-5EditPline - EdgeGeom . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-5EditPline - EdgeMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-5EditPline - EndPline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-6EditPline - EndTangent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-6EditPline - FindPlineVertNo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-6EditPline - GetPlineVert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-6EditPline - Insvert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-6EditPline - JoinSplines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-7EditPline - MoveArcMidPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-7EditPline - MoveVert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-7EditPline - OpenPline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-7EditPline - RenameCurPline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-7EditPline - SetArcAngle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-7EditPline - SetArcRadius . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-8EditPline - SetArcToFillet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-8EditPline - SplitSpline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-8EditPline - StartTangent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-8EnablePlineStitch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-8Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-9FormatPlotAxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-9FormatPlotGraphs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-9GeneralPlotOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-9LinePlotOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-9ListPlotsProject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-9ListPlotsView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-9LoadCartesian3DPlot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-10MarkerPlotOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-10ModifyPlot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-10ModifyVariables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-11NewWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-11OpenProject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-11PanelPlotDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-11


Contents-14

PanelPlotVisibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-11PostProcessorOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-11SaveDefinitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-11ShowCalc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-12ShowPlotCoordinates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-12ShowSolutionInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-12TileAllGrid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-12TileProjectsGrid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-12TileViewsGrid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-12TogglePlotVisibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-12

Plot 3D Script Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-13Graph3dSetColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-13Graph3dSetFilled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-13Graph3dSetLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-13Graph3dSetOutline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-13Graph3dSetRefinement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-13Graph3dSetShade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-14Graph3DSetToneShaded . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-14Graph3dUpdateGraph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-14Plot3dDrawAxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-14Plot3dDrawGrid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-14Plot3dSetAxesLabelSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-14Plot3dSetColorMap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-15Plot3dSetHeadExtrusion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-15Plot3dSetHeading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-15Plot3dSetHeadingColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-15Plot3dSetHeadingFont . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-15Plot3dSetHeadingSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-15Plot3dSetLighting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-16Plot3dSetScale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-16Plot3dShowColorKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-16Plot3dUpdatePlots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-16

FieldCalculator Script Commands . . . . . . . . . . . . . . . . . . . . . . . . . . 10-17* (Multiply) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-17+ (Add) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-17– (Subtract) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-17/ (Divide) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-171/ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-17Abs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-17AddFaceAtPos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-17AddFaceWithId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-18AddObjectToList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-18AnimationAddFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-18AnimationDeleteFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-18


Contents-15

AnimationMoveFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-19AnimationPlay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-19AnimationPlot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-19AnimationSaveFrames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-19AnimationSavePlot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-20AnimationSetDeltaVal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-20AnimationSetPlayTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-20AnimationSetRefinement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-20AnimationSetStartVal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-21AnimationSetStopVal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-21AnimationSetStoreFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-21AnimationSetVarName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-21AnimationShowFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-21ArcCreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-22AtPhase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-22BHPlot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-22BuildPlotInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-22Clear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-22CmplxI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-23CmplxMag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-23CmplxR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-23Conj . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-23CreateAnimation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-23CreateBHPlot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-23CreateFacesList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-23CreatePlot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-24Cross . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-24Curl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-24CutPlaneCreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-24CutPlaneModify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-24D/Dx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-24D/Dy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-24D/Dz . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-24DefineCutPlane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-25DefineExternalFace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-25DefineFacesList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-25DefineFunction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-25DefineObjectList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-25DefinePoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-25DeleteLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-26DeletePlot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-26DeletePoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-26DeleteSurface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-26DeleteVolume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-26


Contents-16

DeltaModifyCutPlane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-26DeltaModifyPoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-27Divg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-27Domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-27Dot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-27Draw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-27DrawLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-27DrawSurface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-28DrawVolume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-28Enter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-28EnterComplex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-28EnterComplexVector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-28EnterFrequency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-28EnterLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-28EnterPoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-29EnterScalar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-29EnterScalarFunction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-29EnterSurface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-29EnterVector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-29EnterVectorFunction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-29EnterVolume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-29Evaluate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-30Exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-30ExportToFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-30ExportToVolumeGrid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-30FacesListModify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-30FunctionValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-31GetTopEntryValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-31Grad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-31Imag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-31Integrate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-31IsoSurface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-31LineCreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-31LineModify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-32LinePlot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-32LinePlot2D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-33LineRecalculate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-34Ln . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-34Load2DPlot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-34LoadPlot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-34LockCutPlaneNormal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-34LockCutPlaneOrigin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-34LockVolume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-34Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-35


Contents-17

Mag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-35Material . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-35MathFunc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-35Maximum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-36MaxPos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-36Minimum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-36MinPos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-36ModelMax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-36ModelMin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-36ModifyCutPlane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-37ModifyPlot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-37ModifyPoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-37Neg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-37Normal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-37NormalComponent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-37ObjectListCreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-38ObjectListModify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-38OrphanPlots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-38Phase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-38Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-38PlotMesh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-38PlotModifyFunction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-38PointCreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-39PointModify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-39PointValuePlot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-39Pop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-39Pow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-39Push . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-39ReadSolutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-39Real . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-39RemoveFaceAtPos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-40RemoveFaceWithId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-40RemoveObjectFromList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-40RenameEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-40RenameLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-40RenamePlot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-40RenamePoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-41RenameSurface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-41RenameVolume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-41RollDn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-41RollUp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-41Save2DPlot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-41SavePlot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-41ScalarX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-42


Contents-18

ScalarY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-42ScalarZ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-42SetArrow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-42SetColormap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-42SetFilled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-43SetGridSpacing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-43SetHiddenLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-43SetLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-44SetMarker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-44SetMeshExternal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-45SetMeshScale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-45SetNumPoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-45SetPlotAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-45SetRefinement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-45SetScale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-46SetTextMarker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-46SetTransparency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-46ShowColorKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-46Smooth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-46SolutionName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-46Sqrt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-47StoreComputations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-47SurfacePlot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-47Tangent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-47TangentComponent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-47Top . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-47Undo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-47UpdatePlots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-48Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-48VecX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-48VecY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-48VecZ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-48VolumeBoxCreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-48VolumePlot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-48WriteSolutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-49

11. Wizard Script Commands . . . . . . . . . . . . . . . . . . . . . . 11-1Wizard Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-2

Information Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-2Mathematical Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-3User Menu Additions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-5

AddHelpSelboxItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-5AddMenuItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-5AddMenuSeparator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-6


Contents-19

DebugFileExec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-6DeleteHelpSelboxItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-6DeleteMenuItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-6DisableMenuItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-7MacroDebugger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-7SetMenuItemHotkey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-7

Wizard Script Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-8AddWizardButtons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-8AddWizardField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-9AddWizardHelp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-9AddWizardSelbox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-10AddWizardSelboxItems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-10AddWizardText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-10AddWizardValidatorExpr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-11CreateWizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-11DeleteWizardValidatorExpr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-11DestroyWizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-12ExecWizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-12GetWizardRunResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-12GetWizardSelboxIndex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-12GetWizardSelboxText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-12IsWizardControlChecked . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-13RunWizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-13SetWizardControlState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-14SetWizardControlText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-14SetWizardFieldChoices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-15SetWizardFieldDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-15SetWizardFieldPrompt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-15SetWizardFieldRange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-16SetWizardSelboxIndex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-16SetWizardTitle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-16StopWizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-16

A. Module Script Commands . . . . . . . . . . . . . . . . . . . . . . A-1


Contents-20

macro.bk : intro.fm 1 Mon Jan 15 11:41:10 2001

Introduction 1-1

1

Introduction

Macros are fast, effective ways to accomplish tasks you wish to repeat. Amacro is built from Ansoft-specific script commands, much like the scriptingcapabilities of UNIX workstations. When you execute a macro from Maxwell3D, the software executes the script commands. With macros you can:● Quickly perform repetitive actions.● Create and solve projects whose properties vary, such as the

dimensions of the model or the values of boundaries and sources.Macros can be designed to prompt you for the necessary informationwhen they need it.

● Export values and results to a database file.

☞Note: In the Maxwell 3D Modeler, a macro is automatically created from your

entered steps, saving you the effort of creating a new one. This macro canbe edited at will, using the Ansoft Macro Editor.

This feature does not exist in any other module.


Macros

1-2 Introduction

MacrosMacros are built from both script commands and script control commands. Inmost cases, the starting point for building a macro is using the interface torecord the initial commands. Once you have recorded the script commands tothe macro, you can edit the macro with any text editor.The macro language in Maxwell 3D can be, like most programminglanguages, complex and it requires strict adherence to syntax. If you haveprogramming experience, editing a macro and the idiosyncrasies of the macrolanguage will be similar to other programming languages. If the Maxwell 3Dmacro language represents your first experience with programming, ahandbook for beginning programmers may be useful in understanding theintricacies of programming in the macro language.

Recording a MacroAfter you have started to record the macro, your subsequent actions arewritten to the macro. Each interface command has one or more associatedscript commands that are recorded to the macro.

➤ To create a macro:1. Choose View/Command Prompt. The command prompt window

appears below the project window.

2. At the command prompt, enter FileRecord “Filename.mac”, whereFilename.mac is the name of the macro you wish to create. From thispoint forward, every step will be recorded into the macro.

3. Step through that part of the project you wish to record. You can dothis with the mouse or by entering the commands into the commandprompt.

4. When you have finished creating the macro, enter FileRecStop. Themacro is now finished and the steps have been saved to the text fileFilename.mac.

☞Note: You may also use the hotkey Ctrl+F4 to access the command prompt.


Macros

Introduction 1-3

Executing a MacroYou can execute the macro in any project.

➤ To execute a macro, do one of the following:● Choose File/Macro/Execute from the menu bar, and select the file to

execute.● To execute a macro from the command line, do one of the following:

■ If you want to execute the macro and remain in Maxwell 3D,enter the following from the project directory containing themacro:

m3dfs -macexec macro_name project.pjt

Maxwell 3D starts and immediately executes the macro. Once themacro has finished, Maxwell 3D remains open, allowing you toperform other tasks.

■ If you want to execute the macro and exit Maxwell 3D after it isfinished, enter the following directly from the directly containingthe macro:

m3dfs -macandexit macro_name project.pjt

Maxwell 3D starts and immediately executes the macro. Once themacro has finished, Maxwell 3D exits.

● To execute a macro using a hotkey:a. Press Ctrl+F3. The following window appears:

b. Enter the name of the macro to execute in the field provided.c. Choose OK.

● To execute a macro using the command prompt:a. Choose View/Command Prompt from the menu bar. The

command prompt window appears below the project window.b. At the command prompt, enter FileExec Filename.mac where

Filename.mac is the name of the macro you wish to execute.


Script Commands

1-4 Introduction

Script CommandsScript commands are the basic components of macros. You can enter thesecommands at the command prompt window, or record them in a macro.

Command SetsScript commands are organized into command sets. A command set is simplya grouping of related script commands. Different command sets are useddepending on the Maxwell 3D module currently in use. The followingcommand sets are available in Maxwell 3D:

Default The Default command set is unlike the others in that itsscript commands for the basis for the macro language. Noscript commands from the Default command set can berecorded using the interface. This command set is availablein every module.

Generic Module The Generic Module command set contains generic scriptcommands. This set is available in every module.

Mod3proj The Mod3proj command set contains script commandsthat manipulate Maxwell 3D projects. Some of the scriptcommands from this command set, like the Default com-mand set, can not be recorded to a macro. This commandset is available in every module with a model display win-dow.

Mod3view The Mod3view command set contains script commandsthat manipulate the view of the projects. This command setis available in every module with a model display win-dow.

Modeler3 The Modeler3 command set contains script commandsspecific to the 3D Modeler.

Materials The Materials command set contains script commandsspecific to the BH-curves in the Material Manager.

MaterialsKernel The MaterialsKernel command set contains script com-mands specific to the Material Manager.

Boundary Module The Boundary Module command set contains script com-mands specific to the 3D Boundary Manager.

Boundary Kernel The Boundary Kernel command set also contains scriptcommands specific to the 3D Boundary Manager.

Mesh3D The Meshmaker module command set contains commandsspecific to the 3D Meshmaker.

Executive Para-meters Module

The Executive Parameters commands set contains scriptsspecific to the Executive Parameters modules.


Script Commands

Introduction 1-5

Entering a Script Command from the Command PromptTo enter individual script commands, rather than from a macro, use thecommand prompt available in the current module.

➤ To enter a script command:1. Choose View/Command Prompt. The command prompt window

appears at the bottom of the window.2. Enter the script command at the command prompt. You may enter

more than one script command with any associated arguments at theprompt. For example, to create a box, use the box script commandand its arguments of base vertex, size in the x-, y-, and z-direction,and the name of the box you want to create. To create a box whosebase vertex was at the origin, you would enter:

box [0,0,0] 20 40 20 “openbox”

3. Choose Enter. This creates a 20x40x20 box named openbox whosebase vertex is at the origin.

➤ To see a list of script commands:● Enter help commands at the command prompt. A list of all available

commands appears with a brief explanation.● Enter help command_name for an explanation of a specific command.

M3DFS The M3DFS command set contains script commands spe-cific to Maxwell 3D.

Solution Setup The Solution Setup command set contains script com-mands specific to Solve Setup.

PostProcessor3D The Post3D command set contains script commands spe-cific to the 3D Post Processor.

Plot 3D The Plot3D command set contains script commands spe-cific the 3D Post Processor plotting functions.

FieldCalculator The FieldCalculator command set contains script com-mands specific 3D Post Processor Field Calculator.

➥Warning: When you activate a module window in Maxwell 3D, only the command

sets for that module are available. If a macro is currently running one mod-ule, selecting a second module may cause errors when the system tries toaccess the script commands from the first module.

For example, if you are running a macro and it is currently defining bound-aries in the 3D Boundary Manager, do not select the Executive module. Thecommand sets in the Executive module will be activated and when themacro tries to execute a script command from the 3D Boundary Manager, itwill fail.


Script Commands

1-6 Introduction

Script Command LayoutThe majority of this guide deals with individual script commands. Thefollowing layout is used in describing them:

Syntax Conventions

Script commands are case-insensitive and are often followed with case-sensitive arguments that further define their functions. These arguments fallinto one of the following eight categories:

☞Note: Many script commands are associated with interface commands. For infor-

mation on the what the command does, refer to the interface command’sonline documentation.

LONG An integer. Integer numbers require no brackets whenentering these values in a script command.

DOUBLE A double precision floating point number. Again, noquotes are required for these values.

“string” A string is a character sequence that must be enclosedin quotation marks. File names, object names, andexpressions are always entered with quotationmarks.You may use either single or double-pairedquotes when defining strings.

The name of the script command

Use: Describes the function of the script command.Command: Lists the associated interface commands. If there are too many

or none at all, “none” will be listed.Syntax: Demonstrates the proper syntax for the command.

The type of syntax used for the switches oroptions indicates what type of informationneeds to be entered for that option.

Note: Explains any switches or options used in the syntax.Example: Provides a working example of the script command.

The results of the example are explained here.


Script Commands

Introduction 1-7

<vectors> Vectors must be entered in carat brackets. The compo-nents in the brackets must be separated with commas.

[positions] Positions must be entered in square brackets. The com-ponents in the brackets must be separated with com-mas.

{“string list”} Braces are used to enclose a series of strings or doublesin the script commands. A string list will resemble{“String1” “String2” “String3”}. No commas separatethe strings.

☞Note: If a script command will not easily fit on a line, you may continue to the

next line by means of a backslash character at the end of a line to be contin-ued.


Script Control Commands

1-8 Introduction

Script Control CommandsMaxwell 3D also provides enhanced script control commands that are notgenerated when using the interface in FileRecord mode. These commandscontrol the macro execution by letting you set variable values, test variableand expression values, conditionally execute portions of the macro, and useloop control within your macro.

Command ConstructsThree constructs are available in Maxwell 3D.

IF

IF is used to create a conditional argument. If a condition is true, the contentsof the IF statement are executed. Otherwise, the IF statement is skipped.There are two types of IF statements you can create. The first type usesconditionals and executes only if the condition is true. For example:

Assign test 5

IF EQ test2 test

Assign test2 6

END

This IF statement executes as long as the value of the variable test is equal tothe value of the variable test2.The second type does not use conditionals; instead, it depends on theexistence of something. For example:

IF test

Assign test2 6

END

This IF statement executes as long as a variable called test exists, and has anon-zero value.Unlike the REPEAT and WHILE statements, an IF statement is only executedonce before continuing with the macro.

REPEAT

REPEAT is used to execute the contents of the REPEAT loop the number oftimes specified. For example:

REPEAT 4

echo “This is a test”

End

This repeats This is a test four times. You may also use variables orcommands that return integers, such as GetNumObjects, to specify the



Introduction 1-9

number of times to repeat the loop.

WHILE

WHILE is used to create a concurrent action. While a condition is true, thecontents of the WHILE loop keep executing. If the condition changes in themiddle of the block, the full block will execute.

Like an IF statement, there are two types of WHILE statements you cancreate. The first type uses conditionals and executes only while the conditionis true. For example:

ASSIGN count 5

WHILE EQ count 5

ASSIGN count SUB count 1

ECHO “count is “ count

END

This only executes while the value of the variable count is equal to 5.The second type does not use conditionals; instead, it executes while thevariable values remains non-zero. For example:

ASSIGN count 5

WHILE count

ASSIGN count SUB count 1

ECHO “count is “ count

END

Executing these commands will display Count is 4, Count is 3, and so forthuntil the decreasing value reaches zero. It stops at zero because the WHILEcondition becomes false. You could also have used a negative number andincreased the value until it reached zero.

➥Warning: Because a WHILE statement can create an infinite loop, make sure the

means of ending the WHILE statement are present in the statement itself.Otherwise the WHILE statement will continue to execute without stop-ping. If you accidentally create an infinite loop condition, use the Esc keyto break out of the loop.



1-10 Introduction

Mathematical Conditions and ExpressionsThe following conditions and expressions can be used in macro language.

Conditionals

IF and WHILE statements frequently use conditional arguments as part oftheir syntax. The following conditionals are available:

The proper syntax for conditionals is:EQ Y 5

which means Y = 5.In addition to the mathematical conditions, there are three booleanconditionals you may use.

AND

AND is used to evaluate the values of two variables or conditions. If neithervalue is equal to zero, a value of one is returned to the macro. If one of thevalues is equal to zero, zero is returned to the macro. For example:

Assign temp1 (AND variable1 variable2)

If EQ temp1 1

Assign width 4

End

In this example, a width of 4 is assigned to temp1 only when variable1 isequal to variable2. The temp1 variable may then be used in otherconstructions, such as the IF statement, used in this example.

Conditional Function

EQ Equal to

NE Not equal to

GT Greater than

LT Less than

GE Greater than or equal to

LE Less than or equal to

☞Note: If the arguments are numeric, numeric comparisons are executed. If the

arguments are strings, case-sensitive string comparisons are used.



Introduction 1-11

OR

Like AND, OR also examines the values of two variables or conditions. Ifeither value is non-zero, a value of one is returned to the macro. If both valuesare equal to zero, a value of zero is returned to the macro.XOR

For the XOR command, if one of the values is equal to zero while the other isnon-zero, a value of one is returned to the macro. If both values are equal tozero or both are non-zero, a value of zero is returned to the macro.

Expressions

Often you will need to mathematically manipulate variables in your macro.Maxwell 3D provides the following mathematical expressions:

The proper syntax for these expressions is:add varname 1

which means varname + 1.You may also group arguments together using parentheses, for example:

add varname (mul 0.5 X)

which means varname + 0.5X. The parentheses are only returned if theexpression would be ambiguous without them.

Expression Function

add Adds two arguments together.

sub Subtracts two arguments.

mul Multiplies two arguments.

div Divides the first argument by the second.

minus Reverses the sign of an argument.

☞Note: The arithmetic operations are done with floating point logic.


Macro Editor

1-12 Introduction

Macro EditorThe Ansoft Macro Editor allows you to create and edit macros, and will putcommand parameters in the correct syntax.When you choose File/Macro/Edit Macro from the File menu of whatevermodule you are in, the following window appears:

Defining Macros in the Macro Editor➤ To create or edit a macro:

1. Choose File/Macro/Edit Macro to access the Macro Editor.2. Choose File/New or File/Open to create or edit a macro file. Macro files

have a .mac file extension.When you create a new file, the Macro Editor automatically entersparameter assignment mode and displays the Create New Macro Filewindow. This is the window in which the macro is written. You can alsoenter this mode using View/Assign Parameter Mode, which allows youto review macros and define any parameters.

3. Do any of the following:■ Choose Edit/All Parameters to specify the parameters of the macro.■ Choose View/Edit Mode to enter edit mode and enter new text for

the macro file.■ Place the cursor on the macro statement for which to specify the

parameters and choose Edit/Command Parameters to specify the


Macro Editor

Introduction 1-13

parameters for the selected item. If you select a line with a statementthat has no parameterized values, this command does nothing.

■ Choose Edit/Add Database Export Macro to generate macro codethat creates a database and writes it to a disk file.

4. Choose File/Save to save the macroThe macro is now defined.

Tool BarUse the tool bar in the Macro Editor as a shortcut to executing commands:

● To execute a command, click on the appropriate button.● To display a brief description of the command in the message bar,

move the cursor to the toolbar icon and hold down the mouse button.

Macro Editor CommandsYou can access the following menus from the Macro Editor:

Refer to the online documentation for more information on these commands.

☞Note: If a tool bar icon appears to do nothing when you click on it, the command

may not be available at the time.

File Creates, opens, saves, and closes macros.

Edit Edits and defines command parameters, and adds database exportmacros.

Search Finds and replaces expressions used in the macros.

View Defines the viewing modes, allowing you to assign parameters oredit the macro file. Also displays the parameters of the macro.

Help Accesses the online documentation for the product.


Macro Editor

1-14 Introduction

macro.bk : examples.fm 1 Mon Jan 15 11:41:10 2001

Macro Examples 2-1

2

Macro Examples

This chapter describes, in detail, two macros: a modeler macro and asimplified version of the modeler macro.


3D Modeler Macro Example — Current Rings

2-2 Macro Examples

3D Modeler Macro Example — Current RingsThis following example demonstrates how a macro can be used to create aconduction device. In this example, the conduction device consists of a pair ofcurrent rings in which terminals reside.

# This is a comment line. A # symbol should precede all comments.## The macro requires the following information:## 1) radius of the conduction rings# 2) height of the conduction rings# 3) separation distance of the rings# 4) the presence of a terminal whose dimensions coincide exactly with the# cross-section of the rings.## This macro should be considered a base for users to develop their own macros.# Note the syntax used for some commands.## This macro requires Maxwell 3D v 6.0 or later## At the beginning of every macro, the Command Sets need to be loaded. The# Command Sets are groupings of similar script commands. For an explanation on# the script commands in the different Command Sets, refer to Chapter 3 through# Appendix A.

UseCommandSet "m3dfs"UseCommandSet "Default"UseCommandSet "mod3view"UseCommandSet "mod3proj"UseCommandSet "Modeler3"UseCommandSet "Generic Module"

# Clear all previously defined variables, functions, and expressions. Do this to# prevent previously defined variables from conflicting with variables you# define in this macro.

ClearAllClearFunctionsExpClear

# This defines the default colors to use in the macro.

DefColor 255 255 0

# This defines the units to use in the macro without rescaling the model.

SetUnits mm n



Macro Examples 2-3

# The following IF statement tests to see if the Command Prompt window is on or# off. If it is off, it turns it on. If it is on, it leaves it on. This is important in any# macro that prompts the user for input. If the Command Prompt is not visible# and the user is being prompted for input, the system appears to hang while# waiting for input.## Notice the syntax of the IF statement. Not Equal to (NE) precedes both# ModuleIsPromptVisible and 1. This means, “If ModuleIsPromptVisible is not# equal to 1.”

If NE ModuleIsPromptVisible 1ModuleTogglePrompt

End

# Now, create the first ring. Each ring is composed of two cylinders which are# subtracted from each other. The cylinders have a height of 1 mm, and are# composed of 24 segments per cylinder. The first cylinder has a radius of 51 mm,# while the second one has a radius of 49 mm. By subtracting the smaller cylinder# from the larger one, you are left with a narrow ring.

Cyl [0,50,0] 1 51 1 “cyl1” 24 [51,-49,0]Cyl [0,50,0] 1 49 1 “cyl2” 24 [49,-49,0]Subtract “cyl1” “cyl2”

# The smaller cylinder vanishes, leaving only one ring. Now create the second ring,# this time using polylines. Polylines are more easily added to the macro using the# Lines/Polyline command, though if you know the coordinates of the vertices that# compose the inner surface of the ring, you can enter each polyline vertex# coordinate in the macro. This will allow greater precision in which you can later# modify the position of a vertex. Call this inner ring pline1.

EditPline “pline1”AddVert [-24.5, -50, 42.4352447854375]AddVert [-34.6482322781408, -50, 34.6482322781408]AddVert [-42.4352447854375, -50, 24.5]AddVert [-47.3303654881643, -50, 12.6821332100235]AddVert [-49, -50, 0]AddVert [-47.3303654881643, -50, -12.68213321000235]AddVert [-42.4352447854375, -50, -24.5]AddVert [-34.6482322781408, -50, -34.6482322781408]AddVert [-24.5, -50, -42.4352447854375]AddVert [-12.6821332100235, -50, -47.3303654881643]AddVert [0, -50, -49]AddVert [12.6821332100235, -50, -47.3303654881643]AddVert [24.5, -50, -42.4352447854375]AddVert [34.6482322781408, -50, -34.6482322781408]AddVert [42.4352447854375, -50, -24.5]



2-4 Macro Examples

AddVert [47.3303654881643, -50, -12.6821332100235]AddVert [49, -50, 0]AddVert [47.3303654881643, -50, 12.6821332100235]AddVert [42.4352447854375, -50, 24.5]AddVert [34.6482322781408, -50, 34.6482322781408]AddVert [24.5, -50, 42.4352447854375]AddVert [12.6821332100235, -50, 47.3303654881643]AddVert [0, -50, 49]AddVert [-12.6821332100235, -50, 47.3303654881643]

ClosePlineEndPline

# The inner ring is now a closed circle. Construct the outer ring in a similar way.

EditPline “pline2”Addvert [-13.1997713002286, -50, 49.2622171407425]Addvert [0, -50, 51]Addvert [13.1997713002286, -50, 49.2622171407425]Addvert [25.5, -50, 44.1672955930064]Addvert [36, -50, 36]Addvert [44.1672955930064, -50, 25.5]Addvert [49.2622171407425, -50, 13.1997713002286]Addvert [51, -50, 0]Addvert [49.2622171407425, -50, -13.1997713002286]Addvert [44.1672955930064, -50, -25.5]Addvert [36, -50, -36]Addvert [25.5, -50, -44.1672955930064]Addvert [13.1997713002286, -50, -49.2622171407425]Addvert [0, -50, 51]Addvert [-13.1997713002286, -50, 49.2622171407425]Addvert [-25.5, -50, -44.1672955930064]Addvert [-36, -50, -36]Addvert [-44.1672955930064, -50, -25.5]Addvert [-49.2622171407425, -50, -13.1997713002286]Addvert [-51, -50, 0]Addvert [-49.2622171407425, -50, 13.1997713002286]Addvert [-44.1672955930064, -50, 25.5]Addvert [-36, -50, 36]Addvert [-25.5, -50, 44.1672955930064]Addvert [-13.1997713002286, -50, 49.2622171407425]

ClosePlineEndPline

# The outer ring, pline2, is complete. Now you must move the rings to the correct# location and cover them to form sheet objects. This allows the rings to become 2D# solids, or disks, which can be subtracted from each other to form the new 2D# object that will become the basis for the second conduction ring.#



Macro Examples 2-5

# First, you must select the objects before moving them to their new position and# sweeping them to form the second ring.

Select “+pline1” “+pline2”Move 0, 100, 0

# The rings move in the positive y-direction 100 mm. Now cover the selected rings# to make them sheet objects.

CoverSheets “pline1”CoverSheets “pline2”

# The rings are now circular disks. Sweep the disks 1 mm in the negative y-# direction to form 3D objects and subtract them.

SweepVec “pline1” 0, -1, 0SweepVec “pline2” 0, -1, 0Subtract “pline2” “pline1”

# The objects are subtracted, leaving only pline2 as a 3D solid ring. With the 3D# objects complete, you can now use the Section command to cut “slices” in the# XY plane of each ring and create the coil terminals needed to cause the# conduction currents. Because the rings are circular, four cross-sections will be# cut from the model: slice, slice1, slice2, and slice3. You will only be interested in# two of those in which to create terminals, so delete slice and slice2.

Section 2 “cyl1” “pline2”Select “+slice” “+slice2”SelCut

# The 2 refers to the XY plane (or along the z-axis) in which the slices were cut.## Now rename the object of the model to more appropriately label their functions.

ReName “cyl1” “ring1”ReName “pline2” “ring2”ReName “slice1” “terminal1”ReName “slice3” “terminal2”

# The model is now complete.



2-6 Macro Examples

Simplified Macro ExampleThe previous macro shows the different methods in which to create theobjects of the model and with what precision you can have control over themodel’s components.For optimization purposes, the macro can be simplified to concentrate onlyon the rings and their respective radii, thicknesses, and distance from eachother.

# The following shows the simplified conduction ring macro to more easily# discern the objects and their properties.

Cyl [0, -50, 0] 1 51 1 “cyl1” 24Cyl [0, -50, 0] 1 49 1 “cyl2” 24Subtract “cyl1” “cyl2”Cyl [0, 50, 0] 1 51 1 “cyl3” 24Cyl [0, 50, 0] 1 49 1 “cyl4” 24Subtract “cyl3” “cyl4”Section 2 {“cyl1” “cyl3”}Select {“+slice” “+slice2”}SelCutReName “cyl1” “ring1”ReName “cyl3” “ring2”ReName “slice1” “terminal1”ReName “slice3” “terminal2”CoverOutl {“terminal1” “terminal2”}


Complete Current Ring Macro

Macro Examples 2-7

Complete Current Ring MacroUsing the previously simplified macro as a foundation, the following macrocreates the two current rings and assign them material properties andboundaries. Once these values are assigned, the solution can be generatedand a parametric analysis can be performed.

# This macro creates the complete model of two current rings.## The first step is to load all the command sets that will be used in the model.# Load the command sets:

UseCommandSet "Solution Setup"UseCommandSet "m3dfs"UseCommandSet "MaterialsKernel"UseCommandSet "Boundary Kernel"UseCommandSet "Default"UseCommandSet "mod3proj"UseCommandSet "Modeler3"UseCommandSet "mod3view"UseCommandSet "Generic Module"

# This establishes the full range of command sets. Now prepare the 3D modeler.# Delete all existing and previously defined objects before proceeding.

Select “*”SelClear

# Now assign the model parameters. These values define the radius of the rings# and the distance of separation between them.

Assign distance 100Assign radius 20

# Define the auxiliary parameters such as the radii and the size of the ring bases.

Assign inner_radius (Sub radius 1)Assign outer_radius (Add radius 2)Assign base_ring1 (Div distance 2)Assign base_ring2 (Sub 0 base_ring1)

# Now define the geometry itself.

Cyl Pos3(0 base_ring2 0) 1 outer_radius 1 “cyl1” 24Cyl Pos3(0 base_ring2 0) 1 inner_radius 1 “cyl2” 24Subtract “cyl1” “cyl2”Cyl Pos3(0 base_ring1 0) 1 outer_radius 1 “cyl3” 24Cyl Pos3(0 base_ring1 0) 1 inner_radius 1 “cyl4” 24



2-8 Macro Examples

Subtract “cyl3” “cyl4”Section 2 “cyl1” “cyl3”Select “+slice” “+slice2”SelCutReName “cyl1” “ring1”ReName “cyl3” “ring2”ReName “slice1” “terminal1”ReName “slice3” “terminal2”

# Now cover the terminals to make them sheet objects.

CoverOutl {“terminal1” “terminal2”}

# The physical model is now complete. Now it is time to define the material# properties. First assign copper to both rings, then assign a vacuum to the# background.

Select ring1Select ring2MaterialSelect copperMaterialAssign {“ring1” “ring2”} “OCS” {“0.0” “0.0” “0.0”}{“0.0” “0.0” “0.0”}Select backgroundMaterialSelect vacuumMaterialAssign {“background”} “OCS” {“0.0” “0.0” “0.0”}{“0.0” “0.0” “0.0”}

# The material properties are now assigned and model is ready to have the# boundaries and sources defined. For this model, each terminal carries a current of# 1 ampere.

Select terminal1SetBoundary “current”SetBndName “current1”SetScalar “1”AssignBoundary

Select terminal2SetBoundary “current”SetBndName “current2”SetScalar “1”AssignBoundary

# The current sources are now assigned to each terminal. Save the terminals and# exit.

SaveBnds



Macro Examples 2-9

# With the model complete, you can set up the solution parameters. For this# model, you will want to specify both a magnetic field solution and a conduction# solution. First set up the nominal magnetic field solution.

SetCurrentSolnPrmsType “solnoptnsetup”SetMeshType “initial”SetNonLinResidual .0001SetSolveFieldsSetSolvePrmsSetSolveType 1SetAdaptiveInfo 5 30 2 2SolnPrmsDone

# Now set up the conduction solution.

SetCondResidual .0001SetCondSAdaptiveInfo 4 30 2 2

# Generate the solution.

SolveNominal

# The solution is generated for the nominal problem.



2-10 Macro Examples

Post Processing MacroWith the solution complete, you can now create a macro to extract the Lorentzforce on one of the rings and save it to a file. The following macro describesthis process:

# First you must create the new database in which the data will be stored.

Assign dbaseid Newdatabase 2

# Add a row to the database.

DatabaseAddRow dbaseid

# Put “force” into 0th column.

DatabaseSetField dbase 0 0 “force”

# Get the value of force.

Assign force_val GetLorentzForceOnObject “group1” “cyl1” 2

# Put the value of force into the first column.

DatabaseSetField dbaseid 0 1 force_val

# Now write out the database into a file.

ExportDatabase dbaseid “force.dat” “yes”

# Now access the 3D Post Processor and execute this macro to create force.dat,# the datafile in which the force results are stored.

Force.dat should have the form:B_HEADERFileSign UNKN FormVers 0.000 CreaSign ANS0 CreaVers 3.000E_HEADER1 2force 5.715261E-08.

macro.bk : defaulcs.fm 1 Mon Jan 15 11:41:10 2001

Default Command Set 3-1

3

Default Command Set

This chapter describes the programming script commands, the Defaultcommand set. These commands are available in every module.


Default Command Set

3-2 Default Command Set

Default Module Script CommandsThe following commands are listed under the Default command set.

Add

Use: Adds two values together and echoes them on the screen. If applied tostrings, this command performs a string concatenation. If applied to Pos2,Vec2, Pos3, or Vec3, it combines the components by component addition.

Command: none

Syntax: add VALUE1 VALUE2

Note: The values can be entered as strings and are used in a macro to combinetwo values.

Example: add sheet1 sheet2

This example adds the existing values of sheet1 and sheet2 in themacro.

Assign

Use: Assigns a value to a variable. Use the Help script command to view anydefined variables.

Command: none

Syntax: assign variable value

Note: The value can be any data type, but it is saved in string form.Example: Assign NAME Getstring “Enter a name for the object”

This example echoes the character string “Enter the name for theobject” and then awaits input from the keyboard. The entered text isassigned to the variable NAME.

ClearAll

Use: Clears the variables and functions defined in the command language.Command: none

syntax: clearall

ClearFunctions

Use: Deletes any functions defined in the command language.Command: none

syntax: clearfunctions

☞Note: When using variable names with other script commands, do not put the

variable name in quotes as you would most string values.


Default Command Set


ClearVars

Use: Deletes all the variables defined in the command language.Command: none

syntax: clearvars

ComplexFormat

Use: Formats a complex number to magnitude-phase (radians or degrees) orreal-imaginary.

Command: none

Syntax: complexformat “input format” “output format”<xval,yval>

Note: “input format” and “output format”:MPR=magnitude-phase (radians)MPD=magnitude-phase (degrees)RI=real-imaginary

Example: complexformat “ri” “mpd” <1,1>

This example formats the complex number with real and imaginarycomponents of 1 to magnitude-phase (degrees).

Component

Use: Extracts a vector or position component or member of a list from thegiven position.

Command: none

Syntax: component WHICH_COMPONENT “position/vector”

Note: which_component: 1=x, 2=y, 3=z, number=position

Example: component 3 [5,10,15]

This example extracts the z-component from a point, which would be 15.component 2 {“oak” “maple” “beech” “sycamore”}

This example extracts the second component from a string list, whosevalue would be maple.

ComponentCount

Use: Returns the number of components in a position, vector, or list.Command: none

Syntax: componentcount [position_vector_or_list]

Example: componentcount [5,10,15]

This example returns the value of 3.


Default Command Set


DatabaseAddRow

Use: Adds a row to the specified database. This does not affect the databasefile stored on the hard disk. Use this after creating a new database filewith NewDatabase, or after importing a database file withImportDatabase.

Command: none

Syntax: databaseaddrow “database name”

DatabaseGetColumns

Use: Returns the number of columns in the specified database.Command: none

Syntax: databasegetcolumns “database name”

Example: newdatabase 6 “tmp”databasegetcolumns “tmp”

This example creates a new database with 6 column. The examplethen returns the number of columns in the database (which should be6).

The two expressions in the example would normally be separated byintervening expressions, since it wouldn’t make sense to create thenumber of columns, then ask what that number is in the nextstatement.

DatabaseGetField

Use: Returns the value of the specified field from database file.Command: none

Syntax: databasegetfield “dbase name” ROW COLUMN

Note: row and column: Numbering begins at zero.Example: newdatabase 6 “tmp”

databasegetfield “tmp” 5 2

This creates a new database with 6 columns. It then returns the valuefrom the sixth row and third column of the database.

The two expressions in the example would normally be separated byintervening expressions, since it wouldn’t make sense to create anew, empty database, then ask what that the value of a field is in thenext statement.

☞Note: The first two lines of the database file must be the number of rows followed

by the number of columns. For example, if a database file contains 16 rowsand 3 columns, the first line of the database file must be:

16 3


Default Command Set


DatabaseGetRows

Use: Returns the number of rows in the specified database.Command: none

Syntax: databasegetrows “dbase name”

Example: newdatabase 6 “tmp”databasegetrows “tmp”

This example creates a new database with 6 columns. The examplethen returns the number of rows in the database (which should be 0).

The two expressions in the example would normally be separated byintervening expressions, since it wouldn’t make sense to create anew, empty database, then ask how many rows it has in the nextstatement.

DatabaseSetField

Use: Replaces a value in a database with the value you specify. This exampleonly affects databases currently in memory. To save the database, use theExportDatabase command.

Command: none

Syntax: databasesetfield dbaseid ROW COLUMN “New value”

Note: Rows and columns start at 0, not at 1.Example: assign idnum newdatabase 6

...databasesetfield dbaseid 0 0 “force”

This example creates a new database with 6 columns, and assigns its IDnumber (provided by the software) to the variable dbaseid. The examplethen replaces the value in the first row, first column of the database withthe new value of force.

DeleteDatabase

Use: Deletes the database currently stored in memory. This does not affect thedatabase file stored on your hard disk.

Command: none

Syntax: deletedatabase “dbase name”

Div

Use: Divides two defined values in a macro.Command: none

Syntax: div VALUE1 VALUE2


Default Command Set


DoubleListSetComponent

Use: Returns a new list of double-precision floating-point numbers, using apreviously existing list, a specified value, and a position in the list. If thevalue of component is – 1, the value is appended to the new list. Addedcomponents may be literal values or variables which evaluate to literalvalues.

Command: none

Syntax: doublelistsetcomponent LIST VALUE COMPONENT

Note: list is a double list: {DOUBLE1 DOUBLE2...}

DumpDatabase

Use: Dumps the contents of a user database.Command: none

Syntax: dumpdatabase “dbase name” END_ROW START_COL END_COL

Example: dumpdatabase “tmp” 2 1 2 1 2

This example dumps the first two rows and columns of the seconddatabase named tmp.

Echo

Use: Echoes text or the results of script commands to the command promptwindow. Use the echo command to view the results calculated by otherscript commands. Otherwise they do not appear.

Command: none

Syntax: echo [“Text” or script_command_result]

Example: echo component 3 [5,10,15]

This example displays the results of the component command, 15, inthe command prompt window.

EQ

Use: Allows you to determine if two entered values are equal. This can applyto strings or numerical values.

Command: none

Syntax: EQ VALUE1 VALUE2

The software will return a 1 of the arguments are equal.


Default Command Set


Error

Use: Stops the execution with the error message you specify.Command: none

Syntax: error “Message”

Example: error “The length of the box has exceeded 20”

This example prints out the string, “The length of the box hasexceeded 20” to the command prompt window and stops the macroexecution.

EvaluateExpression

Use: Evaluates the defined expression. The default persistent setting is 0 (thus,the value is not persistent). If the value is persistent and the expressiontakes the form “x=value”, x will be entered as a variable in the persistenttable and is usable when evaluating subsequent persistent expressions. Asubsequent expression may then have the form “value +x”.

Command: none

Syntax: evaluateexpression “expression” persistent?(Y/N)

Note: Persistent: 0 (not persistent) or 1 (persistent)Example: evaluateexpression “x=5” 1

This takes the persistent value of x=5, and allows x to be treated as avariable in subsequent expressions.

ExportDatabase

Use: Saves the specified database to a disk file.Command: none

Syntax: exportdatabase “dbase name” “File name and location”“Overwrite?”

Note: overwrite: “yes” or “no”Example: exportdatabase “tmp” “/hfss/macros/wgdata.dat” “yes”

This example saves the database tmp currently stored in memory tothe disk file wgdata.dat in the /hfss/macros/ directory. The system isinstructed to overwrite the old file.

FileClose

Use: Closes a file that was open for formatted reading.Command: none

Syntax: fileclose “file name”


Default Command Set


FileExec

Use: Executes a macro or commands from a file.Command: none

Syntax: fileexec “File name”

FileExecErrExitIf

Use: Verifies the preconditions in an executing macro file.Command: none

Syntax: FileExecErrExitIf “condition command” “error message”

Note: condition command: any conditional statement such as if.Example: fileexecerrexitif “IF EQ test2 test” “The test values

are equal and will produce a linear curve.”

In this example, if the two test values are equal in this hypotheticalpost processing macro, the error message “The test values are equaland will produce a linear curve.” appears and ends the macro.

FileExecPause

Use: Displays an informational message during macro execution. The usermust choose OK from the message window to continue with the macro.Message can have multiple lines if you use “\n” as a newline character.

Command: none

Syntax: fileexecpause “text message”

Example: fileexecpause “First part of macro finished.\n Continuing.”

FileExists

Use: Returns whether a given file exists in the current directory.Command: none

Syntax: fileexists “filename”

Example: fileexists “Iverify.mac”

This example determines and returns whether Iverify.mac exists.

FileOpen

Use: Opens a file for formatted reading. This command will produce an error ifit is executed directly from the command line, and will work only fromwithin an executing macro file. If the file cannot be opened, an errorcondition will be set. The file will remain open until you explicitly close itor until the executing macro file terminates. This command may only beused for formatted reading from files.

Command: none

Syntax: fileopen “filename”


Default Command Set


FileRead

Use: Performs a formatted read from a file. The format_string is an fscanf stylestring, but with different variable format indicators, intended forcommand language usage. Regular characters require an exact match.Variables are indicated by the “$$”. When reading in a variable, the fileposition moves forward to the first non-blank character before attemptingthe variable read. After the variable is read, the file position steps forwardto the first character following the variable. For delimited strings, this isthe first character after the terminating double quote or whitespacecharacter (the next line if no terminating delimiter is found). For doublevalues, formats like 12.345e-02 are recognized.

Command: none

Syntax: FileRead “filename” “format string”

Note: The return value is a string list.Specific formats supported are as follows:

$$l Long value.

$$d Double value.

$$mmm String value, using exactly mmm literal characters, countingwhite space as characters. For example, $$12.

$$s Character delimited string value with a maximum length of1024: if starts with double quote ends at either end of line or first double quote else ends at first white space character (or end of line)

$$[xxx] Skip any number of characters denoted by x. If x is a blank, thiswill denote any white space (tab, blank, newline, carriagereturn). For example, $$[ab].

$$[^xxx] Skip any number of characters until first of xxx encountered.

$$”xxx” Skip until directly after first occurrence of literal substring, or tothe end of the file if not found. To use this format specifier, youwill have to enclose the entire format string in single quotes, sothat the double quotes are not interpreted as the end of the for-mat string.


Default Command Set


FileRecord

Use: Starts recording the subsequent commands to a macro file. If the filealready exists, you will be asked whether to overwrite it.

Command: none

Syntax: filerecord “File name”

Example: filerecord “Iverify.mac”

This example records your subsequent actions to the file Iverify.mac.

FileRecordAppend

Use: Starts recording the subsequent commands and appends them to a macrofile. If the macro file doesn’t exist, it will be created.

Command: none

Syntax: filerecordappend “File name”

Example: filerecordappend “Iverify.mac”

This example appends your subsequent actions to the macro fileIverify.mac.

☞Note: In all literal character specifiers, comparisons will be sensitive to upper/

lower case exact match. In the [xxx] and [^xxx] formats, you may useranges of characters, such as [a-hm-z]. For example:

The $$s$$L$$[a-z ]$$d$$s$$s.

when applied to the following input string:

The brown 4 foot high dog ate 2.5 pounds “of meat”.

will produce the following output:

variable 1 (string): “brown”

variable 2 (long): 4

skipped string: “foot high dog ate “

variable 3 (double): 2.5

variable 4 (string): “pounds”

variable 5 (string): “of meat”

All values to be read will be converted to string format, and the commandwill store them into a return string list. The number of values successfullyread will be indicated by the number of components in the returned stringlist.


Default Command Set


FileRecStop

Use: Stops recording to a macro file.Command: none

syntax: filerecstop

FileWrite

Use: Performs a formatted write to a file. For formatted write, the file isopened, the data written, and the file is then closed on each writeoperation.

Command: none

Syntax: FileWrite “filename” “write_mode” “format” [arg_list]

Note: filename is a STRING containing the name of the formatted filewrite_mode is a STRING; either w (overwrite) or a (append)format is a STRING with literal contents plus $$ variable insertionindicators. When defining the format, use \n for new lines.arg_list is a STRING_LIST containing the arguments to be matchedagainst the variable insertion indicators in order.

FuncDef

Use: Defines a function. The function definition can reference arguments thatwill be input from the command prompt if they are not supported on theend line, when the macro is run.

Command: none

Syntax: funcdef function_name [Text or script_command_results]

Example: funcdef IncrVar assign $1 (add $1 1)

This example defines the function IncrVar, which takes a variablename from the command prompt and adds 1 to its value. Thus, toadd 1 to a variable named year:assign year 1999incrvar year

The value of newyear is 2000.

FuncHelp

Use: Adds help strings to an existing function.Command: none

Syntax: funchelp “function name” “Help strings”

Example: funchelp “t” “This is the sum of the variables u and v”

This example defines the help for function t. When you use helpfunctions, this description will appear for the function t.


Default Command Set


FuncSave

Use: Saves all functions to a file readable by FileExec.Command: none

Syntax: funcsave “File name”

Example: funcsave “t.mac”

This example saves the defined functions to a file named t.mac. If youexecute this file using the FileExec command, the functions saved inthe file are defined for the current project.

FuncUndef

Use: Removes a function definition.Command: none

Syntax: funcundef “function name”

Example: funcundef “t”

This example undefines the function t.

GE

Use: Returns a value of 1 if the first argument is greater than or equal to thesecond argument.

Command: none

Syntax: GE argument1 argument2

Note: GE arguments can be strings or numerical values.If argument1 is greater than argument2, the software returns a valueof 1 in the command prompt window.

GetDateAndTime

Use: Returns the current date and time.Command: none

Syntax: getdateandtime

GetFileList

Use: Returns a list of files that match a specified search pattern.Command: none

Syntax: GetFileList “search_pattern”


Default Command Set


GetFileName

Use: Opens a file dialog to get a filename from the user.Command: none

Syntax: GetFileName “rw” “prompt” “filter” “title”

Note: RW is either “r” for read or “w” for write.Prompt is the file prompt.Filter is the file filter.Title is the dialog title set to “Select file” by default.

GetMacroPath

Use: Returns the full path of a macro file.Command: none

Syntax: getmacropath “file name”

GetMacroPathList

Use: Returns the macro path list.Command: none

Syntax: getmacropathlist

GetProductId

Use: Returns the product ID number for the project. For Maxwell 3D, theproduct ID number is 11.

Command: none

Syntax: getproductid

GetUserOption

Use: Returns the value of a defined user option.Command: none

Syntax: getuseroption “category” “option name”

Note: category: The category of the user optionoption name: The name of the user option.

GetVersion

Use: Returns the version number of the software for the project.Command: none

Syntax: getversion


Default Command Set


Global

Use: Returns the value of a global variable.Command: none

Syntax: global “variable name”

GlobalAssign

Use: Assigns a value to a global variable.Command: none

Syntax: globalassign “variable name” “value”

Note: The assigned value is a string.Example: globalassign “path1” “x”

This example assigns the value of x to path1.

GT

Use: Returns a value of 1 if the first argument is greater than the secondargument.

Command: none

Syntax: gt argument1 argument2

Note: GT arguments can be either strings or numerical values.

Help

Use: Provides help about an available item or list.Command: none

Syntax: help “Item name, commands, functions, or variables”

Example: help functions

This example lists all the functions defined for the current project.

ImportDatabase

Use: Imports a user database file. The first line of the database file mustcontain the number of rows and the number of columns.

Command: none

Syntax: importdatabase “File name” “dbase name”

Example: importdatabase “c:/hfss/wgdatabase.dat” “tmp”

This example imports the database wgdatabase.dat. The database cannow be referred to by the name “tmp.”


Default Command Set


ImportRawDatabase

Use: Imports a user database file. The information must be organized intorows and columns, and each row must occupy a single line. TheImportRawDatabase command computes the number of rows andcolumns and stores it in memory. (Unlike the ImportDatabase command,the first row should not contain the number of rows and columns.)

Command: none

Syntax: importrawdatabase “File name” “dbase name”

Example: importrawdatabase “c:/hfss/rawdatabase.dat” “tmp”

This example imports the database rawdatabase.dat. The databasecan now be referred to by the name “tmp.”

IsCommandEnabled

Use: Returns whether a command is enabled in the current context. The returnvalue is either a 1 (true) or a 0 (false).

Command: none

Syntax: iscommandenabled “command name”

Example: iscommandenabled “help”

If the help command is enabled, this value is 1, otherwise, it is 0.

LE

Use: Returns a value of 1 if the first argument is less than or equal to thesecond argument.

Command: none

Syntax: le argument1 argument2

Note: LE arguments can be either strings or numerical values.

Log10

Use: Returns the log base 10 value of the entered number.Command: none

Syntax: log10 VALUE

Example: log10 300

This returns a value of 2.4771212.

LT

Use: Returns a value of 1 if the first argument is less than or equal to thesecond argument.

Command: none

Syntax: lt argument1 argument2

Note: LT arguments can be strings or numerical values.


Default Command Set


Minus

Use: Negates the given value.Command: none

Syntax: minus VALUE

Mul

Use: Multiplies two values together.Command: none

Syntax: mul argument1 argument2

Note: Mul arguments can be strings or numerical values.Example: mul line1 base1

In this example, the values of line1 and base1 are multipliedtogether.

NE

Use: Returns a value 1 of in the command prompt window if the two namedvalues are not equal.

Command: none

Syntax: ne argument1 argument2

Note: NE arguments can be strings or numerical values.

Example: ne line1 line2

In this example, if line1 is 15 and line2 is 25, the command promptwindow will display a 1.

NewDatabase

Use: Creates a new database with the number of columns you specify. Use theDatabaseAddRow and DatabaseSetField commands to add rows andvalues to the new database. Save the database to a disk file using theExportDatabase command.

Command: none

Syntax: newdatabase NUMBER_OF_COLUMNS “dbase name”

Example: newdatabase “database.dat” 6 “tmp”

This example creates the new database database.dat with 6 columns.The database can now be referred to by the name “tmp.”


Default Command Set


OR

Use: Returns a value 1 of in the command prompt window if either of the twonamed values is non-zero.

Command: none

Syntax: or argument1 argument2

Note: OR arguments can be strings or numerical values.

ParametricFileExec

Use: Executes parameterized commands from a file. Support is also providedfor parameterized macro files.

Command: none

Syntax: ParametricFileExec “filename” {variable/value pairs}

Note: variable/value pairs: a string list containing pairs of strings forvariable name and variable value.

Example: ParametricFileExec “3dmodel.mac” {“pair1” “pair2”}

This example executes the 3dmodel.mac file using the pair1 andpair2 value pairs.

You can also control whether you record the contents of a file as itexecutes, and whether commands echo to the command window as afile executes, using the following: SetRecordingEnabled state SetEchoEnabled state where state is a LONG value of 1 for enabled or 0 for disabled.

When using this command, default values can be indicated in themacro file to be executed. Variables that are in variable/valuepairs will be set as indicated. Other variables indicated in thedefault list will receive those values. Both type of assignments will beprivate and will be removed automatically when the file finishesexecution. The macro file default values should be in a commentedheader as follows: # BeginParameters # Assign varname1 value1 # Assign varname2 value2 . . # EndParameters


Default Command Set


Pos2

Use: Specifies the x- and y-coordinates of a 2D position. This is typically usedas part of a drawing command.

Command: none

Syntax: pos2 X_ARGUMENT Y_ARGUMENT

Example: pos2 2 4

This example defines a position x = 2 and y = 4.

Pos3

Use: Specifies the coordinates of a 3D position; you must specify values for x,y, and z.

Command: none

Syntax: pos3 X_ARGUMENT Y_ARGUMENT Z_ARGUMENT

Example: pos3 2 4 8

This example defines a 2D position with an x-coordinate of 2, a y-coordinate of 4, and a z coordinate of 8.

Pos3Dist

Use: Returns the Euclidean distance between two 3D positions.Command: none

Syntax: pos3dist [position1] [position2]

Example: pos3dist [2,2,2] [2,2,4]

This example calculates the distance between the point (2,2,2) and thepoint (2,2,4), which is 2.

PrependMacroPath

Use: Adds a directory to the front of the macro path list.Command: none

Syntax: prependmacropath “directory name”

PrintHelp

Use: Prints all the commands to a text file.Command: none

Syntax: printhelp “File name”

PrivateAssign

Use: Assigns a value to a private variable.Command: none

Syntax: privateassign variable_name “value”


Default Command Set


ProtectedAssign

Use: Assigns a value to a protected variable.Command: none

Syntax: protectedassign variable_name “value”

RandomFraction

Use: Generates and displays a pseudo-random number between 0 and 1,displaying it to the fifteenth decimal place.

Command: none

Syntax: randomfraction

RemoveMacroPath

Use: Removes a directory from the macro path list.Command: none

Syntax: removemacropath “directory name”

SetEchoEnabled

Use: Regulates the command window printer within the current macro file.Command: none

Syntax: SetEchoEnabled enabled

Note: enabled: 0 for disabled, 1 for enabled

SetMacroPathList

Use: Sets the macro path list.Command: none

Syntax: setmacropathlist “directory list”

SetRecordingEnabled

Use: Regulates recording within the current macro file.Command: none

Syntax: setrecordingenabled enabled?

Note: enabled?: 0 for disabled, 1 for enabled

SetUnitsOfQuant

Use: Changes the units of a quantity.Command: none

Syntax: setunitsofquant “Quantity” “Units”

Example: setunitsofquant “Current” “A”

This example sets the units for the current source being defined in the3D Boundary Manager to amperes.


Default Command Set


SetUserOption

Use: Defines the user option value.Command: none

Syntax: SetUserOption “category” “option name” “option value”

Note: category: The category of the user option.option name: The name of the option.option value: The value of the user option.

Example: setuseroption “hfss” “min_adaptive_passes” “0”

This example sets the minimum number of adaptive passes to 0 forthe HFSS project.

Sleep

Use: Sleeps (pauses) the module for a given number of seconds. No activityoccurs during a sleep.

Command: none

Syntax: sleep SECONDS

Example: sleep 10 filerecord “Iverify.mac”

This example pauses the system for 10 seconds and then beginsrecording a macro to the file Iverify.mac.

StrConcat

Use: Concatenate two strings.Command: none

Syntax: strconcat “string1” “string2”

Example: assign framenum 5

assign framelist {}

WHILE framenum

assign newstring (StrConcat “Frame“ framenum)assign framenum SUB framenum 1assign framelist stringlistsetcomponent framelist\

newstring -1

END

This example joins together the text string “Frame” with the variableframenum. As the frame number is reduced, each new text string isadded to the list of frames, so the final list is {“Frame5”, “Frame4”,“Frame3”, “Frame2”, “Frame1”}.


Default Command Set


String

Use: Converts arguments to a string.Command: none

Syntax: string arguments

StringListSetComponent

Use: Sets a string list entry. The modified list is the return value of thecommand. If the component has a value of -1, the new value is appendedto the list. The string list may be an empty list if you are creating a newstring list by adding the first component. Added components may bestring data, variables with string contents, or anything convertible tostrings.

Command: none

Syntax: stringlistsetcomponent {LIST} “STRING” COMPONENT

Note: LIST is a string list: {“string1” “string2” ...}Example: Assign new_list StringListSetComponent new_list

“entry2” “boxdims”

This defines string list entry2 with the component of boxdims.

Strlen

Use: Returns the length of a string.Command: none

Syntax: strlen “string name”

Strstr

Use: Finds a substring within a string.Command: none

Syntax: strstr “string” “substring” starting_position

Note: starting position: the position from which to begin the search. Bydefault this is set to 0 to search at the beginning of the string. The returnvalue is 0-based index or - 1 if not found.

Sub

Use: Subtracts two values.Command: none

Syntax: sub argument1 argument2

Note: Subtracted arguments can be either string or numerical values.


Default Command Set


Substring

Use: Extracts a substring from a string.Command: none

Syntax: Substring “string” START_POSITION END_POSITION

Note: START_POSITION: The numerical start position of the string.END_POSITION: The numerical end position of the string.

Unassign

Use: Removes a variable definition.Command: none

Syntax: unassign variable name

Example: unassign xlength

This example removes the variable xlength.

Vec2

Use: Converts scalar values to a 2D vector (x- and y-components) which can beused for another command.

Command: none

Syntax: vec2 X_COMPONENT Y_COMPONENT

Example: vec2 2 2

This example creates the vector <2,2>.

Vec3

Use: Converts scalar values to a 3D vector (x-, y-, and z-components).Command: none

Syntax: vec3 X_COMPONENT Y_COMPONENT Z_COMPONENT

XOR

Use: Returns a value of 1 if exactly one of the entered arguments is non-zero.Command: none

Syntax: xor argument1 argument2

Note: Arguments can be either string or numerical values.Example: xor line1 point1

If line1 is 10 mm and point1 is 0mm, the command prompt windowwill return a value of 1.

macro.bk : generics.fm 1 Mon Jan 15 11:41:10 2001

Generic Script Commands 4-1

4

Generic Script Commands

This chapter describes the generic script commands that aren’t specific to anyone module. They are generally loaded in every module; however, since someof the commands are not applicable to some modules, those commands willnot be available. Refer to Appendix A, “Module Script Commands,” for acomplete list of the commands available in each module.The generic script commands include the following command sets:● Generic module● mod3proj● mod3view


Generic Module Script Commands

4-2 Generic Script Commands

Generic Module Script CommandsThe following script commands are classified as Generic Module scriptcommands.

CascadeAll

Use: Cascades all view and project windows.Command: Window/Cascade

Syntax: cascadeall

CascadeProjects

Use: Cascades all project windows.Command: none

Syntax: cascadeprojects

CascadeViews

Use: Cascades all view windows.Command: none

Syntax: cascadeviews

CloseWindow

Use: Closes the active view window.Command: Window/Close

Syntax: closewindow

ModuleIsPromptVisible

Use: Tests if the command prompt window is visible.Command: none

Syntax: moduleispromptvisible

ModulePrefsRevert

Use: Reverts preferences set for the current module to their default values.Command: none

Syntax: moduleprefsrevert

ModuleSavePrefs

Use: Saves the currently defined user preferences for the current module.Command: View/Save Module Preferences

Syntax: modulesaveprefs




ModuleSidewinLeft

Use: Moves the side window to the left of the screen.Command: View/Side Window/Left

Syntax: modulesidewinleft

ModuleSidewinRight

Use: Moves the side window to the right of the screen.Command: View/Side Window/Right

Syntax: modulesidewinright

ModuleToggleMessage

Use: Toggles the status bar on and off.Command: View/Status Bar

Syntax: moduletogglemessage

ModuleTogglePrompt

Use: Toggles the command prompt window on and off.Command: View/Command Prompt

Syntax: moduletoggleprompt

ModuleToolbar(direction)

Use: Moves the tool bar to either the top, bottom, left, or right of the window.Command: View/Tool bar

Syntax: moduletoolbarbottom, moduletoolbartop,moduletoolbarleft, moduletoolbarright

ModuleToolbarHide

Use: Hides the tool bar.Command: View/Tool bar

Syntax: moduletoolbarhide

NewWindow

Use: Creates a new view window.Command: Window/New

Syntax: newwindow

PrintEntire

Use: Prints contents of entire module window.Command: none

Syntax: printentire




PrintProj

Use: Prints all the view windows for the current project.Command: none

Syntax: printproj

PrintRect

Use: Prints a rectangular area you select using the mouse.Command: none

Syntax: printrect

PrintSubwin

Use: Prints the view window you select using the mouse.Command: none

Syntax: printsubwin

PrintView

Use: Prints all the view windows for the current project.Command: none

Syntax: printview

TileAllGrid

Use: Tiles all view and project windows in a grid.Command: Window/Tile

Syntax: tileallgrid

TileAllHrz

Use: Tiles all view windows horizontally.Command: none

Syntax: tileallhrz

TileAllVrt

Use: Tiles all view windows vertically.Command: none

Syntax: tileallvrt

TileProjectsGrid

Use: Tiles all projects in a grid.Command: none

Syntax: tileprojectsgrid




TileProjectsHrz

Use: Tiles all project windows horizontally.Command: none

Syntax: tileprojectshrz

TileProjectsVrt

Use: Tiles all project windows vertically.Command: none

Syntax: tileprojectsvrt

TileViewsGrid

Use: Tiles all view windows in a grid.Command: none

Syntax: tileviewsgrid

TileViewsHrz

Use: Tiles all view windows horizontally.Command: none

Syntax: tileviewshrz

TileViewsVrt

Use: Tiles all view windows vertically.Command: none

syntax: tileviewsvrt


mod3proj Script Commands


mod3proj Script CommandsThe following script commands are classified as mod3proj script commands.

AbortTimeout

Use: Sets the time-out, in milliseconds, for aborting a refresh of a 3D viewwindow. When the software is refreshing a window, the user is not ableto move (rotate, pan, and so forth) the object in the window. Setting theabort time-out sets the amount of time that the software will spendrefreshing a window before allowing the user to move the object.

Command: none

Syntax: aborttimeout TIME

ActivateView

Use: Activates the specified window.Command: none

Syntax: activateview nn

Example: activateview 2

This activates the second view window.

CheckOverlap

Use: Checks for overlapping solids or 2D objects.Command: Options/Check Overlap

Syntax: checkoverlap

DeleteCS

Use: Deletes a saved coordinate system.Command: Coordinates/Delete

Syntax: deletecs “Coordinate system name”

Example: deletecs “coord1”

This deletes the coordinate system coord1.

DeSelect

Use: Deselects the named selected objects.Command: Edit/Deselect All

Syntax: deselect “OBJECT_NAME1” “OBJECT_NAME2” ...

Example: deselect “terminal” “coil”

This deselects the selected objects terminal and coil in the model.




DispShaded

Use: Displays an object in flat shaded mode.Command: none

Syntax: dispshaded “Object name”

Example: dispshaded “box1”

This example displays the object box1 in flat shaded mode.

DispWire

Use: Displays an object in wire frame mode.Command: none

Syntax: dispwire “Object name”

Example: dispwire “box1”

This displays the object box1 as a wire frame.

FlushEvents

Use: Forces the 3D Post Processor to display all calculated plots. Normally, thecalculated plots are not displayed until the script has finished running orthere is a pause in the macro (such as the sleep command).

Command: none

Syntax: flushevents

GetCurPos

Use: Returns the current position (the blinking marker in the active viewwindow) in local coordinates.

Command: none

Syntax: getcurpos

GetDouble “Prompt”

Use: Prompts the user for a real value with the specified prompt and returns itto the script.

Command: none

Syntax: getdouble “Prompt name”

Example: animationsetstartvalue getdouble “Enter the startvalue for the animation plot:”

This example prompts the user for a value and assigns it as the start valuefor the variable of the animation plot. The text to the left of the promptwill read “Enter the start value for the animation plot:”.




GetLong “Prompt”

Use: Prompts the user for an integer value with the specified prompt andreturns it to the script.

Command: none

Syntax: getlong “Prompt name”

Example: assign IntVal getlong “Enter an Integer:”

This example prompts the user for a value and assigns IntVal the enteredvalue. The text left of the prompt will read “Enter an Integer:”.

GetNumObjects

Use: Returns the total number of objects in the project including invisibleobjects and background objects.

Command: none

Syntax: getnumobjects

GetNumViews

Use: Returns the total number of view windows.Command: none

Syntax: getnumviews

GetObjectName

Use: Returns a string that uses this object name.Command: none

Syntax: getobjectname OBJECT_NUMBER

Note: OBJECT_NUMBER: A sequential number from one to the GetNumObjectsvalue. If the OBJECT_NUMBER is out of range, an empty string is returned.

Example: echo getobjectname 1

This example displays the object name for the first object.

GetOrigin

Use: Returns the coordinate system origin in global coordinates.Command: none

Syntax: getorigin




GetPosition “Prompt”

Use: Prompts the user for a 3D position with the specified prompt and returnsit to the script. You may enter the position at the command prompt orclick the left mouse button on the point in the active view window.

Command: none

Syntax: getposition “Prompt name”

Example: assign vertex1 getposition “Enter the position for thefirst vertex:”

This example prompts the user for a 3D position and assigns it to thevariable vertex1. The text left of the prompt will read “Enter theposition for the first vertex:”.

GetString “Prompt”

Use: Prompts the user for a string with the specified prompt and returns it tothe script.

Command: none

Syntax: getstring “Prompt name”

Example: assign NAME GetString “Enter a name for the object:”

This example prompts the user to enter a name and assigns thatstring value to the variable NAME.

GetUnitConv

Use: Gets the unit conversion factor from meters. For example if you are inmillimeters, the unit conversion factor returned is 1000.

Command: none

syntax: getunitconv

GetUnitName

Use: Gets the name of the current units.Command: none

syntax: getunitname




GetVector “Prompt”

Use: Prompts you for an integer value with the specified prompt and returns itto the script. You may enter the vector at the command prompt or clickthe left mouse button in the active view window to choose the vectorpoints.

Command: none

Syntax: getvector “Prompt name”

Example: assign vector1 getvector “Enter the vector:”

This example prompts you for a vector and assigns it to the variablevector1.

GlobalCS

Use: Switches to a global (absolute [0,0,0]) coordinate system.Command: Coordinates/Global

Syntax: globalcs

Hide

Use: Makes the specified object invisible.Command: none

Syntax: hide “Object name”

Example: hide “box1”

This example hides the object called box1.

HideOrient

Use: Hides an object’s orientation (the object’s local XYZ system).Command: none

Syntax: hideorient “Object name”

Example: hideorient “box1”

This example hides the object coordinate system of the object box1.

HideRegion

Use: Hides the problem region in the view windows.Command: Edit/Visibility/Toggle Region

Syntax: hideregion

HideSel

Use: Hides the selected objects in the view windows.Command: Edit/Visibility/HideSelection

Syntax: hidesel




List

Use: Lists the objects in the modeler database.Command: none

Syntax: list

LocalCS

Use: Switches to the local coordinate system.Command: Coordinates/Local

Syntax: localcs

Lorigin

Use: Moves the local coordinate system’s origin to a new location.Command: none

Syntax: lorigin [Local coordinates]

Example: lorigin [10,10,10]

This example moves the local coordinate system’s origin to [10, 10,10] of the local coordinate system.

ObjectCS

Use: Makes the local coordinate system of an object the same as the localcoordinate system.

Command: Coordinates/Show ObjectCS

Syntax: objectcs “Object name”

ObjectExists

Use: Checks for the existence of an object in the model.Command: none

Syntax: objectexists “object name”

Example: if objectexists “coil”dispshaded “coil”

This example checks to see if the object named coil exists and if itdoes, fills the object with a solid shading to make it more easilydiscernible in the model. The objectexists command is used primarilyin creating macros with conditions.




Origin

Use: Moves the global coordinate system’s origin to a new location.Command: Coordinates/Move Origin

Syntax: origin [Global coordinates]

Example: origin [10,10,10]

This example moves the global coordinate system’s origin to [10, 10,10] of the global coordinate system.

Origin?

Use: Displays the coordinates of the current global origin.Command: none

Syntax: origin?

PrintProj

Use: Prints all the view windows for the current project. (PC only)Command: none

Syntax: printproj

PrintView

Use: Prints the active view window. (PC only)Command: none

Syntax: printview

Recolor

Use: Changes the colors of objects.Command: Edit/Attributes

Syntax: recolor “object name” <red(0-255)><green(0-255)><blue(0-255)>

Example: recolor “coil” 255 0 255

This example recolors coil to a deep violet shade.

RestoreCS

Use: Restores a saved local coordinate system.Command: none

Syntax: restorecs “coordinate system name”




RotateCS

Use: Rotates the local coordinate system about a vector by the specified angleof rotation.

Command: none

Syntax: rotatecs <Vector to rotate about> ANGLE

Example: rotatecs <0,0,10> 45

This example rotates the local coordinate system 45 degrees aroundthe z-axis.

RotatedCS

Use: Switches to latest rotated coordinate system, preserving the origin.Command: Coordinates/Rotated

Syntax: rotatedcs

SaveCmdWin

Use: Saves the contents of command window to a text file. This is extremelyuseful when you wish to have a hardcopy of the contents of the commandwindow.

Command: none

Syntax: savecmdwin “File name”

SaveCS

Use: Saves the current local coordinate system’s definition.Command: Coordinates/Save

Syntax: savecs “coordinate system name”




SaveWindow

Use: Saves the current active view window to a file.Command: none

Syntax: savewindow “File name” FILE_TYPE

Note: FILE_TYPE: Select from the following.

Example: savewindow “plot1.gif” 2

This saves the plot to a .gif file called plot1.gif.

Select

Use: Selects objects for further operations.Command: Edit/Select

Syntax: select “Object names”

Example: select { “layer1” “layer2” “layer3” }

This example selects the three objects called layer1, layer2, and layer3.You don’t need the brackets if you are only selecting one object.

SelInBox

Use: Selects objects located within a box.Command: none

Syntax: selinbox [Base vertex] SIZEX SIZEY SIZEZ

Example: selinbox [0,0,0] 10 10 10

This example selects all objects in a box starting at the origin andextending 10 units in the positive x, y, and z directions.

Number File type

0 bmp

1 ppm

2 gif

3 pict

4 rgb

5 tiff

6 ps




SetCurPos

Use: Sets the position of the cursor.Command: none

Syntax: setcurpos [X,Y,Z]

Example: setcurpos [0,0,0]

This example defines the position of the cursor at the origin.

SetObjectCS

Use: Makes an object coordinate system the same as the local coordinatesystem.

Command: Coordinates/Set Object CS

Syntax: setobjectcs “object name”

Example: setobjectcs “box1”

This example sets the object coordinate system for the object box1 tothe local coordinate system.

Show

Use: Shows a hidden object.Command: Edit/Visibility/By Item

Syntax: show “Hidden object name”

Example: show “box1”

This example displays the object box1.

ShowAll

Use: Shows all hidden objects.Command: Edit/Show All

Syntax: showall

ShowOrient

Use: Shows the object’s coordinate system.Command: none

Syntax: showorient “object name”

ShowRegion

Use: Shows the problem region.Command: Options/Region/Show

Syntax: showregion




ToggleRegion

Use: Toggles the visibility of the problem region.Command: none

Syntax: toggleregion

UnrotatedCS

Use: Switches to an unrotated coordinate system (that is parallel to the globalcoordinate system), preserving the origin.

Command: Coordinates/Unrotated CS

Syntax: unrotatedcs

VerifyRegion

Use: Verifies that region encompasses all objects and that no objects overlap.Command: Options/Region/Verify

Syntax: verifyregion

VisByItem

Use: Sets the visibility of individual objects. Select the items from the windowthat appears.

Command: Edit/Visibility/By Item

Syntax: visbyitem

XAxisAboutTo

Use: Rotates the local coordinate system’s x-axis about a vector so that thespecified point lies on a plane defined by the vector and the x-axis.

Command: Coordinates/Rotate X

Syntax: xaxisaboutto <Vector to rotate about> [Point to rotateto]

Example: xaxisaboutto zunitvec? [5,5,0]

This example rotates the local coordinate system’s x-axis about theunit vector on the z-axis so that the point [5,5,0] lies on the planedefined by the unit vector and the x-axis.

XAxisTo

Use: Rotates the local coordinate system’s x-axis so that it goes through thegiven point.

Command: none

Syntax: xaxisto [Point to rotate to]

Example: xaxisto [5,5,5]

This example rotates the x-axis until the point at [5,5,5] lies on it.




XUnitVec?

Use: Creates a unit vector along the x-axis.Command: none

Syntax: xunitvec?

YAxisAboutTo

Use: Rotates the local coordinate system’s y-axis about a vector so that thespecified point lies on a plane defined by the vector and the y-axis.

Command: Coordinates/Rotate Y

Syntax: yaxisaboutto <Vector to rotate about> [Point to rotateto]

YAxisTo

Use: Moves the local coordinate system’s y-axis so that the specified point lieson the axis.

Command: none

Syntax: yaxisto [Point to rotate to]

YUnitVec?

Use: Creates a unit vector along the y-axis.Command: none

Syntax: yunitvec?

ZAxisAboutTo

Use: Rotates the local coordinate system’s z-axis about a vector so that thespecified point lies on a plane defined by the vector and the z-axis.

Command: Coordinates/Rotate Z

Syntax: zaxisaboutto <Vector to rotate about> [Point to rotateto]

ZAxisTo

Use: Moves the local coordinate system’s z-axis so that the specified point lieson the axis.

Command: none

Syntax: zaxisto [Point to rotate to]

ZUnitVec?

Use: Creates a unit vector along the z-axis.Command: none

Syntax: zunitvec?


mod3view Script Commands


mod3view Script CommandsThe following script commands are classified as mod3view script commands.

AutoGrid

Use: Automatically sets the grid size to a specified number of pixels.Command: none

Syntax: autogrid GRID_DENSITY

Example: autogrid 20

This example places each grid point at 20 pixel intervals.

FitAll

Use: Displays all objects in the geometric model in the active view window.Command: View/Fit All/Active View

Syntax: fitall

FitAllViews

Use: Displays all objects in the geometric model in all view windows.Command: View/Fit All/All Views

Syntax: fitallviews

FitSel

Use: Displays the selected objects in the model in all view windows.Command: View/Fit Selection

Syntax: fitsel

Lookat

Use: Defines the center point of the view window.Command: none

Syntax: lookat <vector>

Example: lookat <20,20,10>

This example moves the center of the view window to the newreference point [20,20,10].

Ortho

Use: Selects the orthogonal projection of the active view window. The greaterthe view width, the smaller the objects in the view window appear.

Command: none

Syntax: ortho VIEW_WIDTH




Persp

Use: Selects the perspective projection.Command: none

Syntax: persp VIEW_ANGLE

PolarGrid

Use: Displays a polar grid. Choose a radius large enough to be displayed inthe active window. Otherwise the grid will not be visible.

Command: none

Syntax: polargrid ANGLE RADIUS

Example: polargrid 10 10

This example displays a polar grid with grid points spaced every 10units along the radius and in 10 degree increments around the origin.

RectGrid

Use: Sets up grid type and spacing.Command: none

Syntax: rectgrid <Grid size>

Example: rectgrid <2,2,2>

This example displays a rectangular grid with grid points evenlyspaced every 2 units in each direction.

ResetViews

Use: Resets the windows to the original standard view.Command: none

Syntax: resetviews

RotView

Use: Rotates the viewpoint.Command: none

Syntax: rotview <Vector to rotate about> ANGLE

Example: rotview zunitvec? 45

This example rotates the view 45 degrees around the z unit vector.




Shaded

Use: Shows the active view window in a flat or smooth shaded view.Command: View/Render/Flat Shaded, View/Render/Smooth Shaded

Syntax: shaded “flat/smooth”

Example: shaded “flat”

This example displays a flat shaded view of all the objects in theactive view window.

Viewpoint

Use: Defines a viewpoint.Command: none

Syntax: viewpoint <View point>

Example: viewpoint <0,0,0>

This moves the viewpoint to the origin.

WireFrame

Use: Sets current view to wire frame mode.Command: View/Render/Wireframe

Syntax: wireframe

macro.bk : executcs.fm 1 Mon Jan 15 11:41:10 2001

Executive Script Commands 5-1

5

Executive Script Commands

This chapter describes the script commands specific to the Executive andExecutive Parameters modules. Refer to Appendix A, “Module ScriptCommands,” for a complete list of the commands available in the Executivemodule.The Executive module uses the following command sets:● Generic module● mod3proj● mod3view● Default● M3DFS● Executive Parameters Module● Solution Setup

The Generic module, mod3proj, mod3view, and Default command sets aredescribed in Chapter 3 and Chapter 4. This chapter describes the M3DFS,Executive Parameters, and Solution Setup command sets.


5-2 Executive Script Commands

M3DFS Script CommandsThe following script commands are classified as M3DFS script commands.

GetCurrSolnFileset

Use: Returns either fileset1 or fileset2 depending on the name of the currentsolution fileset.

Command: none

Syntax: getcurrsolnfileset

GetForceOnGroup

Use: Displays the virtual or Lorentz force on the selected group.Command: Solutions/Force

Syntax: getforceongroup “which force”“group name” COMPONENT

Note: which force = VF (virtual) or LF (Lorentz)COMPONENT: 1=x, 2=y, 3=z

Example: getforceongroup “VF” “magnet” 3

This example displays the virtual force on the z-component of themagnet.

GetLastSolveInfo

Use: Displays the solution information on the last performed solution.Command: none

Syntax: echo getlastsolveinfo “solution info type”

Note: The available solution information types are as follows:

Example: echo getlastsolveinfo “MESHSIZE”

This example displays the mesh size for the model at the time of thelast completed pass.

ERRENERGY The energy error.ENERGY The energy of the solution.MESHSIZE The size of the mesh.



GetLorentzForceOnObject

Use: Displays the Lorentz force on the object.Command: Solutions/Force

Syntax: getlorentzforceonobject “group name”“object name”COMPONENT

Note: COMPONENT: 1=x, 2=y, 3=z

Example: getlorentzforceonobject “core” “coil” 2

This example displays the Lorentz force on the y-component of coil inthe group named core.

GetMatrixCellValue

Use: Displays the matrix element corresponding to the selected objects.Command: Solutions/Matrix

Syntax: getmatrixcellvalue “row obj name” “column obj name”

Example: getmatrixcellvalue “coil” “core”

This displays to the coil row and the core column matrix values.

GetTorqueOnGroup

Use: Displays the virtual or Lorentz torque on the selected group.Command: Solutions/Torque

Syntax: gettorqueongroup “which torque”“group name” COMPONENT

Note: which torque = VT (virtual) or LT (Lorentz)COMPONENT: 1=x, 2=y, 3=z

Example: getforceongroup “VT” “magnet” 3

This displays the virtual torque on the z-component of the magnet.

LaunchBoundaries

Use: Opens the 3D Boundary/Source Manager.Command: Setup Boundaries/Sources

Syntax: launchboundaries

ProjDir

Use: Returns the path of the current project directory.Command: none

Syntax: projdir

ProjName

Use: Returns the name of the active project.Command: none

Syntax: projname



Executive Parameters Module Script CommandsThe following script commands are classified as Executive Parameters Modulescript commands.

AddObjectGroup

Use: Adds a group to the current setup.Command: Create

Syntax: addobjectgroup “group name”

Example: addobjectgroup “magnet”

This adds the group named magnet to the Groups list.

DeleteObjectGroup

Use: Deletes a group from the current setup.Command: Delete

Syntax: deleteobjectgroup “group name”

Example: deleteobjectgroup “magnet”

This deletes the object group named magnet from the Groups list.

ExcludeObject

Use: Removes an object from the active group.Command: none

Syntax: excludeobject {“object names”}

Example: excludeobject {“coil” “terminal”}

This excludes both coil and object from the current group.

IncludeObject

Use: Adds an object to the current group.Command: none

Syntax: includeobject {“object names”}

Example: includeobject {“coil” “terminal”}

This adds both coil and terminal to the current group.

SetCurrentObjectGroup

Use: Sets the group name to which objects will be added.Command: none

Syntax: setcurrentobjectgroup “group name”

Example: setcurrentobjectgroup “magnet”

This sets magnet as the active group, which selected objects can nowbe assigned.



SetCurrentSetupType

Use: Defines the current setup type as either virtual or Lorentz.Command: Virtual Force, Virtual Torque, Lorentz Force, Lorentz Torque

Syntax: setcurrentsetuptype “setup name”

Example: setcurrentsetuptype “virtualforce”

This defines the setup as one for virtual force.

SetTorqueAxisAnchorPoint

Use: Sets the anchor point of the torque axis.Command: Set Anchor Point

Syntax: SetTorqueAxisAnchorPoint <x,y,z>

Example: SetTorqueAxisAnchorPoint <3,6,10>

This sets the anchor point of the torque axis at [3,6,10].

SetTorqueAxisEndPoint

Use: Sets the end point of the torque axis.Command: Set End Point

Syntax: SetTorqueAxisEndPoint <x,y,z>

Example: SetTorqueAxisEndPoint <6,9,10>

This defines the endpoint of the torque axis at [6,9,10].



Solution Setup Script CommandsThe following script commands are classified as Solution Setup scriptcommands.

SaveSetup

Use: Saves the Solution Setup parameters.Command: none

Syntax: savesetup

SetAdaptiveInfo

Use: Sets the adaptive solution criteria.Command: Adaptive

Syntax: setadaptiveinfo PASSES PERCENT_REFINEMENTPERCENT_ERROR DELTA_ERROR

Note: PASSES: Enter the number of passes.PERCENT_REFINEMENT: Enter the percentage for the tet refinement.PERCENT_ERROR: Enter the value at which the error is acceptable.DELTA_ERROR: Enter the value at which change in error from the lastpass is acceptable.

Example: setadaptiveinfo 3 30 2 2

This example defines an adaptive solution that refines the mesh at arate of 30% of growth. The refinement stops when either three passesare complete or the solution drops below an error of 2% with a deltavalue of 2% from its previous pass.

SetCondResidual

Use: Defines the solver residual values for the conduction solution.Command: Residual

Syntax: setcondresidual RESIDUAL

Example: setcondresidual .0001

This example sets the values of the solver residual to 1e-4.



SetCondSAdaptiveInfo

Use: Sets the adaptive conduction solution criteria.Command: Conduction Solve

Syntax: setcondsadaptiveinfo PASSES PERCENT_REFINEMENTPERCENT_ERROR DELTA_ERROR

Note: PASSES: Enter the number of passes.PERCENT_REFINEMENT: Enter the percentage for the tet refinement.PERCENT_ERROR: Enter the value at which the error is acceptable.DELTA_ERROR: Enter the value at which change in error from the lastpass is acceptable.

Example: setadaptiveinfo 4 30 2 2

This example defines an adaptive conduction solution that refines themesh at a rate of 30% of growth. The refinement stops when eitherfour passes are complete or the solution drops below an error of 2%with a delta value of 2% from its previous pass.

SetCondSolutionType

Use: Defines the conduction solution as either a non-adaptive or an adaptivesolution.

Command: none

Syntax: setcondsolutiontype TYPE

Note: TYPE: 0=Nonadaptive, 1=AdaptiveExample: setcondsolutiontype 1

This example sets the conduction solution as an adaptive solution.

SetCurrentSolnPrmsType

Use: Defines the type of solution parameters for the project. At this time, onlythe nominal solution options setup is available.

Command: none

Syntax: setcurrentsolnprmstype “Type”

Note: Type: solnoptnsetupExample: setcurrentsolnprmstype “solnoptnsetup”

This example defines the solution parameters as those for thenominal solution.

SetFrequency

Use: Specifies the Single Frequency for the problem. Enter the frequency inhertz.

Command: Single Frequency

Syntax: setfrequency FREQUENCY



SetMeshType

Use: Sets the starting mesh.Command: Starting Mesh

Syntax: setmeshtype “Mesh type”

Note: Select from the following for Mesh type:initialcurrentpreviousmanual

Example: setmeshtype “initial”

This sets the starting mesh to the initial mesh.

SetNonLinResidual

Use: Defines the nonlinear residual values for the adaptive solution.Command: Residual

Syntax: setnonlinresidual RESIDUAL

Example: setnonlinresidual .0001

This sets the values of the solver residual to 1e-4.

SetNop

Use: Instructs the software whether to solve the problem type or to become anon-operation.

Command: Magnetic Field Solve

Syntax: setnop NOP

Note: NOP: 0 (solve this problem) or 1 (do not solve this problem).Example: setnop 1

This tells the software not to generate a solution for the problem type.This command is used only in rare instances where a macro calls for asolution not to be generated for the current type.

SetResidual

Use: Defines the residual values for the adaptive solution.Command: Residual

Syntax: setresidual RESIDUAL

Example: setresidual .0001

This sets the values of the solver residual to 1e-4.



SetSolveFields

Use: Defines whether to solve the fields on the model.Command: Solve For: Fields

Syntax: setsolvefields SET

Note: SET: 0 = No, 1 = YesExample: setsolvefields 0

This example prevents the software from generating solutions for thefields.

SetSolvePrms

Use: Defines whether to solve for parameters in the model.Command: Solve For: Parameters

Syntax: setsolvefields SET

Note: SET: 0 = No, 1 = YesExample: setsolvefields 0

This example prevents the software from generating solutions for theexecutive parameters.

SetSolver

Use: Instructs the software to use the ICCG solver.Command: none

Syntax: setsolver SET

Note: SET: 0 = No, 1 = YesExample: setsolver 1

This example instructs the Maxwell 3D Field Simulator to invoke theICCG solver to generate the solutions for the problem.

SetSolveType

Use: Defines the nominal solution as either a non-adaptive or adaptivesolution.

Command: none

Syntax: setsolvetype TYPE

Note: TYPE: 0=Non-adaptive, 1=AdaptiveExample: setsolvetype 1

This example instructs the Maxwell 3D Field Simulator to generate anadaptive nominal solution.



SolnPrmsDone

Use: Defines whether the solution parameters are finished.Command: none

Syntax: solnprmsdone “done”

Note: done: OK if finished and to accept setup parameters, Cancel to abort.Example: solnprmsdone “OK”

This tells the software that the solution setup is complete and to closethe Solve Setup window if it is open.

macro.bk : 3dmodcs.fm 1 Mon Jan 15 11:41:10 2001

3D Modeler Script Commands 6-1

6

3D Modeler Script Commands

This chapter describes the script commands specific to the 3D Modelermodule. Refer to Appendix A, “Module Script Commands,” for a completelist of the commands available in the 3D Modeler module.The 3D Modeler module uses the following command sets:● Generic module● mod3proj● mod3view● Default● Modeler3

The Generic module, mod3proj, mod3view, and Default command sets aredescribed in Chapter 3 and Chapter 4. This chapter describes the Modeler3command set.



6-2 3D Modeler Script Commands

Modeler3 Script CommandsThe following script commands are classified as Modeler3 script commands.

Box

Use: Draws a rectangular box.Command: Solids/Box

Syntax: box [Base vertex] SIZEX SIZEY SIZEZ “Object name”

Example: box [0,0,0] 20 40 20 “openbox”

This example creates a 20x40x20 box named openbox whose basevertex is at the origin. You cannot use variables for the base vertexusing this syntax. Use the Pos3 command to specify the base usingvariables.

Circle

Use: Creates a circle.Command: Lines/Circle

Syntax: circle [Circle center] AXIS RADIUS “Object name”COVERED NUMBER_OF_SEGMENTS [facetted start position]

Note: AXIS: 0=X, 1=Y, 2=ZCOVERED: 0=No, 1=YesNUMBER_OF_SEGMENTS: 0=True Surface

Example: circle [0,0,0] 2 20 “closecir” 1 8 [20,0,0]

This example creates a covered circle named closecir on the z-axiswhose radius is 20 from the origin. The circle is made from eight linesegments that start at the point [20,0,0].

Close3d

Use: Closes the current active window.Command: File/Close

Syntax: close3d

ColorFaces

Use: Changes the color of selected faces.Command: none

Syntax: colorfaces

ColorSel

Use: Changes the color of all selected objects to the current default color.Command: Edit/Attributes/Recolor

Syntax: colorsel




Connect

Use: Connects multiple profiles or faces to form a surface.Command: Surfaces/Connect

Syntax: connect “Profile1” “Profile2”

Example: connect “Pline1” “Pline3”

This creates a new surface from the polylines Pline1 and Pline3.

CoverOutl

Use: Covers closed polylines with faces to make sheet objects.Command: Surfaces/Cover Lines

Syntax: coveroutl {“Polyline1” “Polyline2”...}

CoverSheets

Use: Covers all open edges of sheet objects to create solids.Command: Solids/Cover Sheets

Syntax: coversheets {“Sheet1” “Sheet2”...}

CreateArc

Use: Draws an arc.Command: Lines/Arc

Syntax: createarc [Base center] ARC_AXIS RADIUS HEIGHT [RadiusVector] [Clockwise? Y/N] [Angle or end position]NUMBER_OF_SEGMENTS “Object name”

Note: AXIS: 0=X, 1=Y, 2=ZNUMBER_OF_SEGMENTS: 0=True Surface

Example: createarc [0,0,0] 2 20 50 [10,10,20] Y [20,20,25] 12“arc1”

This example creates a clockwise arc made up of 12 segments namedarc1 that begins at [10,10,20] and ends at [20,20,25].




Cyl

Use: Draws a cylinder.Command: Solids/Cylinder

Syntax: cyl [Base center] AXIS RADIUS HEIGHT “Object name”NUMBER_OF_SEGMENTS

Note: AXIS: 0=X, 1=Y, 2=ZNUMBER_OF_SEGMENTS: 0=True Surface

Example: cyl [0,0,0] 2 20 50 “CopperCyl” 8

This example creates a cylinder made up of eight segments (or facets)named Coppercyl whose base is centered at the origin and whoseheight is 50 along the z-axis, with a radius of 20.

DefColor

Use: Defines the default color for new objects.Command: Edit/Attributes/Recolor

Syntax: defcolor REDVALUE GREENVALUE BLUEVALUE

Note: REDVALUE: 0-255GREENVALUE: 0-255BLUEVALUE: 0-255

Example: defcolor 0 0 140

This example makes the default color pale blue.

DefColor?

Use: Displays the default object color.Command: none

Syntax: defcolor?

Delete

Use: Deletes the specified object or objects. You may use wildcards in theobject name to delete multiple objects.

Command: none

Syntax: delete “Object name”

DeSelect

Use: Deselects the specified object or objects. You may use wildcards in theobject name to delete multiple objects.

Command: Edit/Deselect All or Select from the right mouse button menu

Syntax: deselect “Object name”

Example: deselect *

This example deselects all objects.




DetachFaces

Use: Detaches faces from objects.Command: Surfaces/Detach Faces

Syntax: detachfaces “face1” “face2” ... “facen”

Example: detachfaces “topside” “leftface”

This example detaches faces topside and leftface from their respectiveobjects.

DisablePlineStitch

Use: Disables stitching of polylines. Once disabled, you cannot stitch polylinestogether to form objects. Use EnablePlineStitch to enable the stitching.

Command: none

Syntax: disableplinestitch

DupAxis

Use: Copies the selected objects around the current view axis.Command: Edit/Duplicate/Around Axis

Syntax: dupaxis AXIS ANGLE TOTAL_NUMBER

Note: AXIS: 0=X, 1=Y, 2=Z

Example: dupaxis 0 90 2

This example duplicates the selected object 90 degrees around the x-axis. The number of objects after the duplication is two (this includesthe original).

DupLine

Use: Copies the selected objects along a line.Command: Edit/Duplicate/Along Line

Syntax: dupline VECTOR TOTAL_NUMBER

Example: dupline <0,20,0> 2

This example creates a duplicate of the selected objects a distance of20 units along the y-axis. The number of objects after the duplicationis two (this includes the original).

DupMirror

Use: Copies the selected objects by mirroring them across the selected plane.Command: Edit/Duplicate/Mirror

Syntax: dupmirror [Point on mirror plane] [Point normal tomirror plane]

Example: dupmirror [0,0,0] [0,10,0]

This example creates a duplicate of the objects about the xz plane.




EditPline

Use: Creates or edits a planar or 3D polyline.Command: Lines/Polyline

Syntax: editpline “Polyline/sheet object”

Example: editpline “Line1”

This example creates (or edits, if a line already exists with that name)a polyline named Line1. You then enter Edit Pline mode, and willneed to use the EditPline script commands to create the polyline.

EditPline - AddVert

Use: Adds a vertex to the end of an edited polyline for an optimized problem.Command: Lines/Polyline

Syntax: addvert [xval,yval,zval]

Example: addvert [0,0,0]

This example adds a vertex at the origin.

EditPline - AddVert3D

Use: Adds a vertex to the polyline.Command: Lines/Polyline

Syntax: addvert3d X Y Z

Example: addvert3d 0 0 0


EditPline - Arc

Use: Creates an arc.Command: Lines/Polyline

Syntax: arc ANGLE

Example: arc 45

This example creates an arc of 45 degrees on the end of the polyline.

EditPline - CancelPline

Use: Exits polyline or sheet edit modeCommand: Lines/Polyline

Syntax: cancelpline

EditPline - ClosePline

Use: Connects the last vertex entered with the first vertex, creating a closedloop.

Command: Lines/Polyline

Syntax: closepline




EditPline - DelEdge

Use: Deletes an edge of the polyline.Command: Lines/Polyline

Syntax: deledge EDGE_NUMBER

Example: deledge 0

This example deletes the first line segment created. The line segmentnumbering begins at 0 with the first segment created. When youdelete an edge, the segments created after that edge are renumbered.

EditPline - DelVert

Use: Deletes the specified vertex.Command: Lines/Polyline

Syntax: delvert [x,y,z]

Example: delvert [0,0,0]

This example deletes the vertex at the origin.

EditPline - EdgeGeom

Use: Changes the Edge Geometry of a segment.Command: Lines/Polyline

Syntax: edgegeom EDGE_NUMBER EDGE_GEOMETRY

Note: EDGEGEOMETRY: 0=Straight, 1=Arc, 2=Spline

Example: edgegeom 1 1

This example changes the second line segment to an arc segment. Theline segment numbering begins at 0 with the first segment created.

EditPline - EdgeMode

Use: Sets the edge mode for the polyline object.Command: Lines/Polyline

Syntax: edgemode EDGEMODE

Note: EDGEMODE: 0=Straight, 1=Arc, 2=Spline

Example: edgemode 1

This example sets the edge of the polyline to an arc. All subsequentpolylines will be created as arcs until the edge mode changes.

EditPline - EndPline

Use: Use this when you have finished creating or editing the polyline and youwish to save it.


Syntax: endpline




EditPline - EndTangent

Use: Makes an edge of the arc end tangent to the next edge.Command: Lines/Polyline

Syntax: endtangent EDGE_NUMBER

Example: endtangent 2

This example makes the edge of the arc (edge number 1) end tangentto the next edge (edge number 2).

EditPline - FindPlineVertNo

Use: Finds the vertex number for a vertex at the specified position.Command: Lines/Polyline

Syntax: findplinevertno [x,y,z]

Example: findplinevertno [2,4,0]

This example finds the vertex number of the vertex at [2,4,0].

EditPline - GetPlineVert

Use: The opposite of findplinevertno. This finds the position of the specifiedvertex number.


Syntax: getplinevert VERTEX_NUMBER

Example: getplinevert 3

This example returns the position of the third vertex.

EditPline - Insvert

Use: Inserts a vertex in the middle of a polyline.Command: Lines/Polyline

Syntax: insvert [vertex to insert before] [new position]

Example: insvert [2,4,0] [2,2,0]

This example inserts a new vertex at [2,2,0], before the vertex at[2,4,0].

EditPline - JoinSplines

Use: Joins two splines that share a vertex.Command: Lines/Polyline

Syntax: joinsplines VERTEX_NUMBER

Example: joinsplines 3

This example joins the two polylines that share the third vertex.




EditPline - MoveArcMidPt

Use: Moves the midpoint of an arc to create a new arc that passes throughthree points.


Syntax: movearcmidpt EDGE_NUMBER [x,y,z]

Example: movearcmidpt 1 [2,2,0]

This example moves the midpoint of the arc (edge number 1) to[2,2,0].

EditPline - MoveVert

Use: Moves a vertex to the specified position.Command: Lines/Polyline

Syntax: movevert [vertex position] [new position]

Example: movevert [2,4,0] [2,2,0]

This example moves the vertex at [2,4,0] to [2,2,0].

EditPline - OpenPline

Use: The opposite of closepline. This creates an opening in a closed polyline byremoving the segment that closed the loop.


Syntax: openpline

EditPline - SetArcAngle

Use: Sets the angle of a polyline arc.Command: Lines/Polyline

Syntax: setarcangle EDGE_NUMBER ANGLE

Example: setarcangle 1 60

This sets the angle of the arc (edge number 1) to 60 degrees.

EditPline - SetArcRadius

Use: Sets the radius of a polyline arc to the specified value.Command: Lines/Polyline

Syntax: setarcradius EDGE_NUMBER RADIUS

Example: setarcradius 1 10

This example sets the radius of the arc (edge number 1) to 10. Theunits of the radius are the units you specified in the 3D Modeler.




EditPline - SetArcToFillet

Use: Sets the radius of the polyline arc to a fillet with a specified radius.Command: Lines/Polyline

Syntax: setarctofillet EDGE_NUMBER RADIUS

Example: setarctofillet 1 10

This sets the radius of the arc (edge number 1) to 10 and selects Fillet.

EditPline - SplitSpline

Use: Splits a spline in two at a specified vertex.Command: Lines/Polyline

Syntax: splitspline VERTEX_NUMBER

Example: splitspline 3

This splits the splines at the third vertex.

EditPline - StartTangent

Use: Makes an edge of the arc start tangent to the previous edge.Command: Lines/Polyline

Syntax: starttangent EDGE_NUMBER

Example: starttangent 2

This makes the edge of the arc (edge number 1) start tangent to theprevious edge (edge number 0).

EnablePlineStitch

Use: Enables stitch mode for polylines so that polylines are stitched together asthey are created. By default, this mode is active in the 3D Modeler. UseDisablePlineStitch to disable stitching for polylines.

Command: none

Syntax: enableplinestitch

Exit

Use: Exits the current module.Command: File/Exit

Syntax: exit




ExpAssign

Use: Assigns an expression to a variable. The variable and its related definitionare used in the Symbol Table.

Command: Options/Expressions

Syntax: expassign “variable name” EXPRESSION

Example: expassign “x” xcomponent my_vector

This example assigns the x-component of my_vector to the variable x.

ExpClear

Use: Clears all entries in the Symbol Table.Command: none

Syntax: expclear

ExpDel

Use: Deletes the specified variable from the Symbol Table.Command: Options/Expressions

Syntax: expdel “Variable name”

ExpEval

Use: Evaluates the expression specified from the Symbol Table.Command: none

Syntax: expeval “Expression name”

Example: expeval “t=5+x”

This example calculates the value for t based on the variable x.

ExpInc

Use: Increments an evaluator variable by a specified value.Command: none

Syntax: expinc “Expression” INCREMENT_VALUE

Example: expinc “t” 2

This example increments the defined expression t by two. Theexpression must be a previously defined variable.

☞Note: This script command is unlike the script command assign. The variable

defined here is used by the software itself, whereas the variable definedwith assign is used by the scripting language.




ExpLoad

Use: Loads expressions from a file into the Symbol Table.Command: none

Syntax: expload “File name”

Example: expload “expvar”

This example loads the expressions and variables defined in the fileexpvar into the Symbol Table.

ExpSave

Use: Saves expressions and variables in the Symbol Table to a file.Command: none

Syntax: expsave “File name”

Example: expsave “expvar”

This example saves the Symbol Table to the file expvar.

FitRegion

Use: Fits the entire modeling region in the view window.Command: Options/Region/Fit All

Syntax: fitregion PADDING_PERCENT “roundoff y/n?”

Note: roundoff: yes=selected, no=deselected

Example: fitregion 20 “y”

This example fits the entire problem region in the active viewwindow with 20% empty space between the edge of the problemregion and the edge of the active view window.

FitSel

Use: Fits selected items in the current view window.Command: View/Fit Selection

Syntax: fitsel

HealAllObjects

Use: Automatically corrects geometric errors in the model.Command: none

Syntax: healallobjects




Helix

Use: Draws a helix.Command: Solids/Helix

Syntax: helix “Polyline” AXIS PITCH Number_of_TURNSNumber_of_SEGMENTS RADIUS_CHANGE “Object name”

Note: axis: The axis of the helix. 0=X, 1=Y, 2=Zpitch: The end-to-end distance of the helix.radius_change: The change in the radius for each turn.

Example: helix “pline1” 0 20 3 12 5 “helix1”

This example creates a three-turn helix about the x-axis called helix1 fromthe object pline1. The helix has a pitch of 20, 12 segments per turn, and theradius increases by 5 per turn.

HideRegion

Use: Hides the problem region.Command: Edit/Visibility/Toggle Region

Syntax: hideregion

Import3D

Use: Reads in objects from a 3D model or ACIS file (.sm3 or .sat) into thecurrent project.

Command: File/Import/3D Modeler/ACIS File

Syntax: Import3D /Directory/Filename

Example: import3d /draw/eddycur.sm3

This example imports the file eddycur.sm3 into the current file.

Intersect

Use: Creates an object by taking the intersecting parts of two or more objects.Command: Solids/Intersect

Syntax: intersect {“Object1” “Object2” “Objectx”}

LaunchScaleDialog

Use: Accesses the Scale Factors window to redefine object scaling.Command: none

Syntax: launchscaledialog




Mirror

Use: Mirrors the selected objects across the selected plane.Command: Arrange/Mirror

Syntax: mirror [Point on mirror plane] [Point normal to mirrorplane]

Example: mirror [0,0,0] [0,10,0]

This example mirrors the selected objects about the xz plane.

ModelerModifyFunction

Use: Adds, updates, or deletes a function.Command: Functions

Syntax: modelermodifyfunction OPERATION “function name”“function expression”

Note: OPERATION: 0=add/update, 1=delete

Example: modelermodifyfunction 0 “Mat1” “X+5”

This example adds the new function Mat1 and defines it as X+5.

Move

Use: Moves the selected objects the distance (length) and direction of thespecified vector.

Command: Arrange/Move

Syntax: move VECTOR

Example: move <0,20,0>

This example moves the selected objects a distance of 20 units alongthe y-axis.

New3d

Use: Creates a new 3D Modeler project.Command: File/New

Syntax: new3d “Unit name”

Example: new3d “meters”

This example creates a new project with units of meters.

Point

Use: Creates a 3D point object.Command: Lines/Point

Syntax: point [Position] “Point name”

Example: point [5,5,0] “point1”

This example creates a point called point1 at [5,5,0].




ProjPrefs

Use: Sets preferences for new projects.Command: Options/Project Preferences

Syntax: projprefs

Read2d

Use: Reads in objects from a 2D model file (.sm2).Command: File/Import/2D Modeler File

Syntax: read2d “File name” “Polygon approximation?”

Note: Polygon approximation: y=selected, n=deselected

Example: read2d “box.sm2” “y”

This example reads in the objects from the file box.sm2 and convertsthe objects into a polygon approximation, such as sheet objects orpolylines.

Read3d

Use: Opens a 3D modeler project (.sm3).Command: File/Open

Syntax: read3d “File name”

Recolor

Use: Changes the color of an object to a newly defined color.Command: none

Syntax: recolor “Object name” REDVALUE GREENVALUE BLUEVALUE


Example: recolor “box1” 255 0 0

This example changes the color of the object box1 to red.




Rectangle

Use: Creates a rectangle.Command: Lines/Rectangle

Syntax: rectangle [first point] NORMAL WIDTH HEIGHT “Objectname” COVERED

Note: NORMAL: The axis normal to the rectangle. (0=X, 1=Y, 2=Z)WIDTH: The width along the lower numbered axis.HEIGHT: The height along the higher numbered axis.COVERED: 0=uncovered, 1=covered

Example: rectangle [0,0,0] 0 10 20 “rect1” 1

This example creates a 10x20 rectangle, rect1, whose base vertex is atthe origin and is normal to the x-axis. This rectangle is covered,meaning it is considered a sheet object.

Redo

Use: Repeats previous commands undone by the Undo or Edit/Undocommand.

Command: Edit/Undo

Syntax: redo NUMBER_STEPS

Example: redo 1

This example repeats the last action affected by the Undo command.

Region

Use: Defines the problem region.Command: Options/Region/Define

Syntax: region [First vertex] SIZE_X SIZE_Y SIZE_Z

Example: Region [0,0,0] 200 200 200

This example defines the region as a 200x200x200 cube whose basevertex is at [0, 0, 0].

Rename

Use: Renames an object.Command: Edit/Attributes/By Clicking

Syntax: rename “Old name” “New name”




ResetViews

Use: Resets the view windows to the four standard views.Command: View/Reset Standard Views

Syntax: resetviews

Rotate

Use: Rotates the selected objects around an axis.Command: Arrange/Rotate

Syntax: rotate AXIS ANGLE

Note: AXIS: 0=X, 1=Y, 2=Z

Example: rotate 0 90

This example rotates the objects 90 degrees around the x-axis.

Save2d

Use: Saves the xy plane of the model to a 2D Modeler (.sm2) file.Command: File/Export/2D Modeler File

Syntax: save2d “File name”

Save3d

Use: Saves the current model.Command: File/Save As

Syntax: save3d “File name” “format”

Note: format: b=binary, a=ASCII

SaveSAT

Use: Saves the model to the specified version of an ACIS (.sat) file.Command: File/Save As

Syntax: savesat “File name” [Format] MAJOR_VERSIONMINOR_VERSION

Note: Format: bin or ASCII

Example: savesat “model1” bin 1 7

This example saves the file model1 as an ACIS 1.7 file.

SaveSLD

Use: Saves the model in .sld format.Command: File/Export/Old 3D Modeler

Syntax: savesld “File name”




Scale

Use: Changes the scale of an object’s dimensions.Command: Arrange/Scale

Syntax: scale SCALE_FACTOR

Example: scale 2

This example scales the object so that it is twice as large.

Section

Use: Generates sheet objects from cross-sections of objects.Command: Surfaces/Section

Syntax: section NORMAL {“object1” “object2” ...}

Note: NORMAL: Section plane normal to. 0=X,1=Y,2=Z

Example: section 1 “box1”

This example creates a 2D object from a cross-section of box1. The y-axis is normal to the plane of the new 2D object.

SelClear

Use: Clears the selected objects.Command: Edit/Clear

Syntax: selclear

SelColor

Use: Changes the selection highlight color.Command: Options/Selection Color

Syntax: selcolor REDVALUE GREENVALUE BLUEVALUE


SelCopy

Use: Copies the selected objects to the clipboard.Command: Edit/Copy

Syntax: selcopy

SelCut

Use: Cuts the selected objects and saves them to the clipboard for futurepasting.

Command: Edit/Cut

Syntax: selcut




SelPaste

Use: Pastes objects from the clipboard to the current project.Command: Edit/Paste

Syntax: selpaste

SetModel

Use: Includes an object into the model to solve.Command: Edit/Attributes/By Clicking

Syntax: setmodel “Object name”

SetNonModel

Use: Excludes an object from the model solution.Command: Edit/Attributes/By Clicking

Syntax: setnonmodel “Object name”

SetSldTol

Use: Sets the tolerance parameters for translation into .sld format.Command: none

Syntax: setsld DISTANCE_TOL NORMAL_TOL

Example: setsld 1e-3 1e-4

This example sets the model tolerance to 1e-3 for the distancetolerance and 1e-4 for the standard tolerance in the .sld translation.

SetUnits

Use: Defines and sets current units relative to meters.Command: Options/Units

Syntax: setunits “unit name” “Rescale? (Y/N)”

Example: setunits “mm” “y”

This example defines the new units as mm and rescales the model tothe new units.

ShowRegion

Use: Displays the problem region.Command: Edit/Visibility/Toggle Region

Syntax: showregion

Note: Make the region invisible with HideRegion.




Split

Use: Splits an object into sections.Command: Solids/Split

Syntax: split PLANE_NORMAL FRAGMENTS_TO_KEEP “object name”

Note: PLANE_NORMAL: 0=X, 1=Y, 2=ZFRAGMENTS_TO_KEEP: 0=above, 1=below, 2=both

Example: split 2 1 “box1”

This example splits the object box1 into two sections, keeping thefragments below the split plane.

Stitch

Use: Stitches selected surfaces among common edges.Command: Surfaces/Stitch

Syntax: stitch {“Sheet1” “Sheet2” Sheetx”}

Example: stitch {“Sheet1” “Pline1” “Redsheet”}

This example stitches the sheet objects Sheet1, Pline1, and Redsheetinto a single surface.

Subtract

Use: Subtracts overlapping objects to form a single non-overlapping object.Command: Solids/Subtract

Syntax: subtract “First object name” “Second object name”

Example: subtract “cyl1” “box1”

This example subtracts the object cyl1 from box2.

SweepAxis

Use: Sweeps a face, profile, or polyline around the view axis to create 3Dsolids.

Command: Solids/Sweep/Around Axis

Syntax: sweepaxis {“Profile to sweep”} AXIS SWEEP_ANGLE STEPSDRAFT_ANGLE DRAFT_TYPE

Note: AXIS: 0=X, 1=Y, 2=ZSWEEP_ANGLE: Angle to sweep through. (-360 to 360)STEPS: Number of segments to sweep through. (0=circular)DRAFT_TYPE: 0=extended, 1=round

Example: sweepaxis “rect1” 2 60 0 10 0

This example sweeps the object rect1 60 degrees about the z-axis in asmooth, circular manner. The profile expands by 10 degrees as it isswept and maintains its sharp corners as it does so.




SweepPath

Use: Sweeps a closed profile along a polyline path to create 3D solid.Command: Solids/Sweep/Along Path

Syntax: sweeppath {“Profiles to sweep”} “Sweep path polyline”DRAFT_ANGLE DRAFT_TYPE

Note: DRAFT_TYPE: 0=extended, 1=round

Example: sweeppath “blueface” “pline1” 10 0

This example sweeps the object blueface along the polyline pline1,expanding by 10 degrees as it does so. The object retains its sharpcorners as it is swept.

SweepTwist

Use: Sweeps a closed profile along a polyline path with a twist.Command: Solids/Sweep/Along Path with Twist

Syntax: sweeptwist {“Closed profile to sweep”} “Sweep path”TWIST_ANGLE

Example: sweeptwist “blueface” “pline1” 20

This example sweeps the object blueface along the polyline pline1while twisting the object by 20 degrees.

SweepVec

Use: Sweeps a closed profile along a vector to create a new 3D solid.Command: Solids/Sweep/Along Vector

Syntax: sweepvec {“Closed polyline”} <Vector>

Uncover

Use: Uncovers the selected faces of objects.Command: Surfaces/Uncover Faces

Syntax: uncover “Face name”

UnDel

Use: Undeletes previously deleted (cleared) objects.Command: Edit/Undelete

Syntax: undel NUMBER_OF_OBJECTS

Example: undel 2

This example undeletes the last two objects that were deleted.




Undo

Use: Undo the previous operations.Command: Edit/Undo

Syntax: undo NUMBER_OF_STEPS

Unite

Use: Adds (unites) 3D objects.Command: Solids/Unite

Syntax: unite {“Object1” “Object2” “Objectx”}

macro.bk : matmancs.fm 1 Mon Jan 15 11:41:10 2001

Material Manager Script Commands 7-1

7

Material Manager Script Commands

This chapter describes the script commands specific to the Material Managermodule. Refer to Appendix A, “Module Script Commands,” for a completelist of the commands available in the Material Manager module.The Material Manager module uses the following command sets:● Generic module● mod3proj● mod3view● Default● MaterialKernel

The Generic module, mod3proj, mod3view, and Default command sets aredescribed in Chapter 3 and Chapter 4. This chapter describes theMaterialKernel command set.


7-2 Material Manager Script Commands

Materials Script CommandsThe following command is classified as a Materials command.

EditBHCurve

Use: Accesses the BH-Curve Entry window, allowing you to create or modifyBH-curves.

Command: BH-Curve

Syntax: editbhcurve

MaterialKernel Script CommandsThe following script commands are classified as MaterialKernel commands.

GetSelectedMaterial

Use: Returns the material name of the selected object.Command: none

Syntax: getselectedmaterial

MaterialAccept

Use: Saves the changes to the selected material and assigns a name to thematerial.

Command: none

Syntax: materialaccept “material name”

MaterialAdd

Use: Adds a material to the database. The material is derived from the vacuummaterial. Use the MaterialSetProperty and MaterialSetType commands todefine the material. Use the MaterialAccept command to save thematerial.

Command: Material/Add

Syntax: materialadd



MaterialAssign

Use: Assign a selected material to one or more objects. Select the material firstwith the MaterialSelect command.

Command: Assign

Syntax: materialassign {“object1” “object2” ...} “coordinatesystem” {“About X” “About Y” “About Z”} {“X” “Y” “Z”}

Note: coordinate system: ocs=object CS, abs=absolute CS

Example: materialassign “stuff1” “ocs” {“0.0” “0.0” “0.0”{“0.0” “0.0” “0.0”}

This example assigns the selected material to the object stuff1. Theangles and coordinates are both set to zero. Set the coordinate systemto ocs and the angles and coordinates to zero if you are assigning anisotropic, nonlinear, or perfectly conducting material to an object. Ifyou are assigning an anisotropic material to an object, follow theguidelines given in the previous note.

MaterialClear

Use: Removes the selected material from the local material database. Select thematerial first with the MaterialSelect command.

Command: Material/Clear

Syntax: materialclear

Example: materialselect “testmat” materialclear

This example selects the material testmat and deletes it.

☞Note: Use ocs to select either Align material with object’s orientation or Align

material relative to object’s orientation when assigning an anisotropic mate-rial to an object. If you are using ocs to select Align material with object’sorientation, set the angles (About X, About Y, and About Z) and coordinates(X, Y, Z) to zero.

Use abs to select Align material with a given direction. For further informa-tion on assigning materials with anisotropic properties, refer to the onlinedocumentation.



MaterialDerive

Use: Adds new materials with the material properties of the selected materialto the local material database. Use either the MaterialSetProperty orMaterialSetType commands to define materials. Use the MaterialAcceptcommand to save materials.

Command: Material/Derive

Syntax: materialderive “new material”

MaterialModifyFunction


Syntax: materialmodifyfunction OPERATION “function name”“function expression”


Example: materialmodifyfunction 0 “Mat1” “X+5”

This example adds the new function Mat1 and defines it as X+5.

MaterialRevert

Use: Deletes any changes for the selected material and reverts back to thematerial’s original properties. If the original material properties dependon functions that have been deleted, any references to that function willnot be updated.

Command: Revert

Syntax: MaterialRevert

MaterialSelect

Use: Selects a material.Command: none

Syntax: materialselect “material name”

Example: materialselect “NdFe35”

This example selects the material NdFe35.



MaterialSetProperty

Use: Defines the specified material properties for the selected material. Aftersetting the material property, be sure to use the MaterialAccept commandto save your changes.

Command: none

Syntax: materialsetproperty “property” VECFUNC {“value”}

Note: “property” must be one of the following:

conductivity or sigmapermittivity or epsimag_permittivity or eps2elec_losstanpermeability or muimag_permeability or mu2mag_losstanperm_magnetization or Mpperm_polarization or Ppmag_coercivity or Hcmag_retentivity or Brelec_coercivity or Ecelec_retentivity or Drsaturation_maglande_gdelta_hvecfunc

Example: materialsetproperty “permittivity” 0 {“9.6e+00”}

This example sets the material property permittivity to a value of 9.6.

MaterialSetType

Use: Specify the type of material — isotropic, anisotropic, nonlinear, or perfectconductor.

Command: none

Syntax: materialsettype “material type”

Example: materialsettype “anisotropic”

This example sets the material type to anisotropic for the selectedmaterial.

☞Note: If you are defining an anisotropic material, the “value” string list should

correspond to the diagonal values in the associated material propertymatrix, {“diag1” “diag2” “diag3”}. For other material types, thevalue of the material property is all that is required.



MaterialUnderive

Use: Underives the selected, derived material. Changes made to an originalmaterial are reflected in any material derived from the original.Therefore, if you do not wish to change the derived materials when youchange the original, underive the derived materials before making anychanges.

Command: Material/Underive

Syntax: materialunderive

Example: materialselect “Material88” materialunderive

This example selects the material Material88 and disassociates it fromthe material it was derived from.

SaveMaterialDatabase

Use: Saves the local material database.Command: none

Syntax: savematerialdatabase “warning”

Note: warning: warn=don’t save if there are inconsistenciesnowarn=save despite inconsistencies

Example: savematerialdatabase “warn”

This example saves the local material database. If there are anyinconsistencies or problems in the material setup, no save will occurdone because the warning setting was set to warn.

macro.bk : bmancs.fm 1 Mon Jan 15 11:41:10 2001

Boundary Manager Script Commands 8-1

8

Boundary Manager Script Commands

This chapter describes the script commands specific to the BoundaryManager module. Refer to Appendix A, “Module Script Commands,” for acomplete list of the commands available in the Boundary Manager module.The Boundary Manager module uses the following command sets:● Generic module● mod3proj● mod3view● Default● Boundary module● Boundary Kernel

The Generic module, mod3proj, mod3view, and Default command sets aredescribed in Chapter 3 and Chapter 4. This chapter describes the Boundarymodule and Boundary Kernel command sets.


8-2 Boundary Manager Script Commands

Boundary Module Script CommandsThe following script commands are classified as Boundary Module scriptcommands.

AssignBoundary

Use: Creates or changes the boundary using the current selection values.Command: Assign

Syntax: assignboundary

DefineBndFuncs

Use: Displays the Symbol Table allowing you to define functions to be usedwith the 3D Boundary Manager.

Command: Model/Functions

Syntax: definebndfuncs

ExitBnds

Use: Exits the Boundary Manager.Command: File/Exit

Syntax: exitbnds

SaveBnds

Use: Saves the boundary settings.Command: File/Save

Syntax: savebnds

SelectByName

Use: Accesses the Select By Name window.Command: Edit/Select/By Name

Syntax: selectbyname

SelectFacesIntersection

Use: Accesses the Select faces intersection window.Command: Edit/Select/Faces Intersection

Syntax: selectfacesintersection

SetDefaultUnits

Use: Accesses the Select Unit Preferences window.Command: Model/Units

Syntax: setdefaultunits



SetEddyEffect

Use: Sets the eddy effect on an object in an eddy current model.Command: Model/Set Eddy Effect

Syntax: seteddyeffect

ShowConductionPaths

Use: Shows the available conduction paths for current flow.Command: Model/Show Conduction Paths

Syntax: showconductionpaths

ToggleViewBndVis

Use: Toggles the boundary visualization of the active window.Command: View/Toggle Boundary Visualization

syntax: toggleviewbndvis

VerifyCondPaths

Use: Verifies the sources assigned to the conduction paths.Command: Model/Verify Conduction Paths

Syntax: verifycondpaths



Boundary Kernel Script CommandsThe following script commands are classified as Boundary Kernel scriptcommands.

AssignCurrDenTerm

Use: Assigns the current density terminal.Command: none

Syntax: assigncurrdenterm “Terminal name”

Example: assigncurrdenterm “term1”

This example defines a 2D object as the terminal, term1.

BoundaryModifyFunction

Use: Modifies or deletes the boundary functions.Command: none

Syntax: boundarymodifyfunction[operation]”function””expression”

Note: operation: 0=modify, 1=delete

Example: boundarymodifyfunction 0 “x”“Z+10”

This example changes the value of x as z+10.

BuildCondPaths

Use: Creates the conduction paths for the selected objects.Command: none

Syntax: buildcondpaths [objects]

Note: objects: 0=all objects, 1=selected object

Example: buildcondpaths 1

This example creates conduction paths on only the selected object.

CheckTerminals

Use: Verifies the terminals.Command: none

Syntax: checkterminals

ClearAllBnds

Use: Clears all boundaries in the model.Command: none

Syntax: clearallbnds



ClearCurrDenTerms

Use: Clears all existing current density terminals.Command: Model/Clear Current Density Terminals

Syntax: clearcurrdenterms

ClearSelBoundary

Use: Deselects the selected boundary or source.Command: none

Syntax: clearselboundary

ClearSelection

Use: Deselects the selected objects.Command: Edit/Deselect All

Syntax: clearselection

CreateTerminals

Use: Creates terminals on the conduction path of the selected objects.Command: Model/Pick Terminal

Syntax: createterminals <only 2d objects?> “terminal type”

Note: only 2d objects: Y or N.Terminal types: branch or outer

Example: createterminals Y “branch”

This example creates a branch terminal on the selected 2D object.

PickFaceById

Use: Selects or deselects the specified face of an object.Command: Edit/Select

Syntax: pickfacebyid “Object name” FACE_ID

Example: pickfacebyid “box1” 1

This example selects the first face on the object box1. If the first facewere already selected, this would deselect it.

PickFaceByRay

Use: Selects the face of an object intersecting a ray. This corresponds toselecting a face using the mouse (Graphical Pick should be set to Face).

Command: none

Syntax: pickfacebyray [ray start coordinates]

Example: pickfacebyray [2,4,6]

This example selects the face that intersects the path of a ray startingat [2,4,6] and moving towards the object.



ReprioritizeSelBoundary

Use: Changes the order of the selected boundary in the Boundary list. Youmust select a boundary before using this command.

Command: Edit/Reprioritize Boundary/Source

Syntax: reprioritizeselboundary

SelectObjByName

Use: Selects an object by name.Command: none

Syntax: selectobjbyname “Object Name”

Example: selectobjbyname “box1”

This selects the object box1.

SelectObjFaces

Use: Selects all faces on the specified object.Command: none

Syntax: selectobjfaces “Object Name”

SetAllBndUnitsToCurrent

Use: Sets all boundary units to the units being used in the model. Use this afteryou have used the command setunitsofquant (from the Default commandset) to select the new units.

Command: none

Syntax: setallbndunitstocurrent

SetBndName

Use: Assigns a name to the boundary.Command: All boundaries and sources

Syntax: setbndname “Boundary Name”

SetBndUnitsToCurrent

Use: Sets boundary units of the selected boundary to the current units. Usethis after you have used the command setunitsofquant (from the Defaultcommand set) to select the new units.

Command: Units

Syntax: setbndunitstocurrent



SetBoolean

Use: Sets the symmetry boundary as odd or even.Command: Symmetry

Syntax: setboolean TOGGLE

Note: TOGGLE: 0=odd, 1=even

Example: setboolean 1

This example defines the boundary as having even symmetry.

SetBoundary

Use: Sets the boundary to the specified boundary condition.Command: All boundaries and sources

Syntax: setboundary “Boundary type”

Note: Select one of the following for “Boundary type:”voltagevoltage_dropcurrentcurrent_densitymagnetic_fieldinsulatingsymmetrymasterslave

Example: setboundary “symmetry”

This example defines the boundary for the selected surface as asymmetry. You will still need to use the other commands listed inthis chapter to define the port settings.

SetEndpoint

Use: Defines the end point of the vectors that define the direction of current orvoltage sources. Use this in conjunction with setstartpoint.

Command: Voltage drop, Current

Syntax: setendpoint [end point]

Example: setendpoint [0,1,2]

This example specifies the end point of the vector defining thedirection of the source (voltage or current) as [0,1,2].



SetMSRelation

Use: Defines the master-slave relation between two boundaries.Command: Relation

Syntax: setmsrelation TOGGLE

Note: TOGGLE: 0:Es=Em, 1=Es=-EmExample: setmsrelation 0

This example sets the master-slave relationship as Es=Em.

SetOrigin

Use: Defines the origin of the coordinate system on the master and slaveboundaries.

Command: Master, Slave

Syntax: setorigin [Origin Coordinates]

Example: setorigin [2,2,2]

This example places the origin of the coordinate system at [2,2,2] (ofthe global coordinate system) for the boundary you are currentlydefining.

SetScalar

Use: Defines the scalar value for a current or voltage source in amperes orvolts.


Syntax: setscalar “value”

Example: setscalar “2”

This example sets the value for the source (current or voltage) you arecurrently defining to 2.

SetScalarFor

Use: Sets the scalar value of the defined parameter.Command: Impedance

Syntax: setscalarfor “parameter” “value”

Note: The following parameters are supported: x, y, z, phase,conductivity, and permeability.

example: setscalarfor “conductivity” “100”

This example defines the scalar value of the conductivity as 100.



SetStartPoint

Use: Defines the start point of the vectors that define the direction of current orvoltage sources. Use this in conjunction with setendpoint.


Syntax: setstartpoint [end point]

Example: setstartpoint [0,1,2]

This example specifies the start point of the vector defining thedirection of the source (voltage or current) as [0,1,2].

SetStringFor

Use: Sets the value for the defined parameter. For example, when you aredefining a slave boundary, you must specify the master boundaryassociated with the slave boundary.

Command: Slave

Syntax: setstringfor “Parameter“ “string value”

Note: Currently, master_name is the only parameter. Its string value is themaster boundary name.

Example: setstringfor “master_name” “master”

This example defines the master boundary to be of type master.

SetUpoint

Use: Defines the u-axis of the coordinate system on the master and slaveboundaries by specifying a point on the axis. This is used in conjunctionwith setorigin and setvpoint.


Syntax: setupoint [Point Coordinates]

Example: setupoint [4,2,2]

This example places the u-axis of the coordinate system such that itpasses through the point [4,2,2] of the global coordinate system.

SetVector

Use: Defines a vector on the existing magnetic field boundary.Command: H Field

Syntax: setvector <x,y,z>

Example: setvector <10,10,20>

This example defines a vector to [10,10,20] on the magnetic field.



SetVpoint

Use: Defines the v-axis of the coordinate system on the master and slaveboundaries by specifying a point on the axis. This is used in conjunctionwith setorigin and setupoint.


Syntax: setvpoint [Origin Coordinates]

Example: setvpoint [2,4,2]

This example places the v-axis of the coordinate system such that itpasses through the point [4,2,2] of the global coordinate system.

SwapBoolean

Use: Swaps the symmetry boundary type between odd and even.Command: Symmetry

syntax: swapboolean

SwapStrandedBoolean

Use: Swaps the boolean value for the current boundary.Command: Symmetry

Syntax: swapstrandedboolean

ToggleDispCurrent

Use: Toggles the displacement current settings for an object.Command: Model/Set Eddy Effect

Syntax: toggledispcurrent “object name”

Example: toggledispcurrent “coil”

This example toggles the displacement current setting for coil.

ToggleEddyEffect

Use: Toggles the eddy effect settings for an object.Command: Model/Set Eddy Effect

Syntax: toggleeddyeffect “object name”

Example: toggleeddyeffect “coil”

This example toggles the eddy effect for coil.

TogglePickBndByName

Use: Selects the specified boundary.Command: none

Syntax: togglepickbndbyname “boundary name”



TogglePickBndByRay

Use: Selects the boundary that intersects a ray. This corresponds to selecting aboundary using the mouse (Graphical Pick should be set to Boundary).

Command: none

Syntax: togglepickbndbyray [ray start coordinates]

Example: togglepickbndbyray [2,4,6]

This example selects the boundary that intersects the path of a raystarting at [2,4,6] and moving towards the boundary.

TogglePickObjByName

Use: Selects the specified object.Command: Edit/Select/By Name

Syntax: togglepickobjbyname “Object name”

TogglePickObjByRay

Use: Selects the object that intersects a ray. This corresponds to selecting anobject using the mouse (Graphical Pick should be set to Object).

Command: none

Syntax: togglepickobjbyray [ray start coordinates]

Example: togglepickobjbyray [2,4,6]

This example selects the object that intersects the path of a raystarting at [2,4,6] and moving towards the object.

TogglePickObjObjInt

Use: Selects the intersecting faces of two 3D objects.Command: Edit/Select/Faces Intersection

Syntax: togglepickobjobjint “First object” “Second object”

UndoClear

Use: Restores the values of the last boundary or source clear operation.Command: Edit/Undo Clear

Syntax: undoclear

UseSuggestedEddyEffectVals

Use: Uses the default values for the eddy effect on objects.Command: Model/Set Eddy Effect (Use suggested values)

Syntax: usesuggestededdyeffectvals



macro.bk : mesh.fm 1 Mon Jan 15 11:41:10 2001

Meshmaker Script Commands 9-1

9

Meshmaker Script Commands

This chapter describes the script commands specific to the Meshmaker. Referto Appendix A, “Module Script Commands,” for a complete list of thecommands available in the Executive module.The Meshmaker module uses the following command sets:● Generic module● mod3proj● mod3view● Default● mesh3d

The Generic module, mod3proj, mod3view, and Default command sets aredescribed in Chapter 3 and Chapter 4. This chapter describes the mesh3dcommand sets.


9-2 Meshmaker Script Commands

Mesh3D Script CommandsThe following script commands are classified as Mesh3D script commands.

CloseProject

Use: Closes the project window.Command: none

Syntax: closeproject

DeleteAllSeed

Use: Deletes all seeding operations in the mesh.Command: Seed/Delete All

Syntax: deleteallseed

DeleteAllSeedNonInteractively

Use: Deletes all mesh seeding non-interactively, without warnings or dialogs.Command: none

Syntax: deleteallseednoninteractively

DeleteMesh

Use: Deletes the mesh.Command: Mesh/Delete

Syntax: deletemesh

DelSelFaces

Use: Deselects all selected faces in the model.Command: Edit/Deselect All Faces

Syntax: delselfaces

DeSelBodies

Use: Deselects all objects in the model.Command: Edit/Deselect All Bodies

Syntax: deselbodies “objects to deselect”

DoModelAnalysis

Use: Performs the model analysis. The command assumes that a proximityanalysis has already been done.

Command: none

Syntax: domodelanalysis



Exit

Use: Exits the Meshmaker, without checks or warnings.Command: none

Syntax: exit

FurtherImproveQuality

Use: Improves the mesh quality by combination swaps.Command: none

Syntax: furtherimprovequality

GExit

Use: Exits the 3D Meshmaker.Command: File/Exit

Syntax: gexit

GWriteMesh

Use: Saves the mesh.Command: File/Save

Syntax: gwritemesh

HiddenLineOff

Use: Displays the lines of the mesh in wireframe mode.Command: none

Syntax: hiddenlineoff

HiddenLineOn

Use: Displays the mesh in hidden line mode.Command: none

Syntax: hiddenlineon

HiddenLineOnOff

Use: Toggles hidden line elimination mode.Command: none

Syntax: hiddenlineonoff

HideAll

Use: Marks all objects in the model as invisible.Command: none

Syntax: hideall



HideMesh

Use: Hides the mesh from view, leaving only the model.Command: Mesh/Show Mesh

Syntax: hidemesh

ImproveQuality

Use: Improves the mesh quality.Command: none

Syntax: improvequality

ImproveSurfTri

Use: Improves the surface triangulation.Command: none

Syntax: improvesurftri <pt addition limit (0.1 = 10% ofcurrent npts)> <give desired min angle in deg:> <givedesired max angle in deg:>

Note: pt addition limit: a value of 0.1 = 10% of current npts.Example: ImproveSurfTri 0.1 15 45

This reads the surface triangulation and improves it using 10% of itscurrent node points, with triangles having base angles in the range of15 to 45 degrees.

InteractiveDeleteMesh

Use: Deletes the current mesh.Command: Mesh/Delete

Syntax: interactivedeletemesh

InteractiveMakeInitMesh

Use: Makes the initial mesh, displaying a progress window and Abort button.Command: Mesh/Make

Syntax: interactivemakeinitmesh

MakeInitialMesh

Use: Generates the initial mesh, with no progress window or Abort button.Command: Mesh/Make

Syntax: makeinitialmesh



MeshDisplayMode

Use: Defines the display mode of the mesh.Command: Mesh/Display Parameters

Syntax: meshdisplaymode “display mode”

Note: display mode: shaded, none, wireframe, or hidden_line.

MeshInfo

Use: Displays mesh information.Command: Mesh/Mesh Info

Syntax: meshinfo

ModelAlone

Use: Turns off the mesh display, leaving only the model.Command: none

Syntax: modelalone

NewProject

Use: Creates a project.Command: File/New

Syntax: newproject “project name”

NonInteractiveDeleteMesh

Use: Deletes the mesh without warnings or dialogs.Command: Mesh/Delete

Syntax: noninteractivedeletemesh

OpenProject

Use: Opens a project and read in mesh files.Command: File/Open

Syntax: openproject “project name”

PullPointsToTrueSurfaces

Use: Moves the points that should be on the true surfaces to the true surfaces.Command: none

Syntax: pullpointstotruesurfaces

RefreshView

Use: Refreshes the view in the mesh window.Command: none

Syntax: refreshview



SaveSeed

Use: Saves all seeding operations to a file.Command: File/Save

Syntax: saveseed

SaveWindow

Use: Saves the current view window to a graphics file. Currently, only bmp isfunctional.

Command: none

Syntax: savewindow “filename” type

Note: type: Choose from one of the following:

SeedingInfo

Use: Displays seeding information.Command: Seed/Seeding Info

Syntax: seedinginfo

Number File type

0 bmp

1 ppm

2 gif

3 pict

4 rgb

5 tiff

6 ps



SeedRefineCommandToKernel

Use: Defines the type of seeding and refinement non-graphically.Command: none

Syntax: seedrefinecommandtokernel “type of refinement/seeding”“tagging criterion” “gather scope” <refine elements tothis value (floating point 10)> <limit growth to thisnumber of elements (integer 1000)> <skin depth tau(floating point 10)> <skin depth epsilon (floatingpoint 10)> <skin depth growth ratio (floating point10)> <skin depth (integer 10)> <number of layers forskin depth refinement (integer 3) > <x coordinate oflower left corner of box for box-refinement floatingpoint -1.0> <y coordinate of lower left corner of boxfor box-refinement floating point -1.0> <z coordinateof lower left corner of box for box-refinementfloating point -1.0> <x coordinate of upper rightcorner of box for box-refinement floating point 1.0><y coordinate of upper right corner of box for box-refinement floating point 1.0> <z coordinate of upperright corner of box for box-refinement floating point1.0>

Note: type of refinement/seeding:

face_seed, obj_surf_seed, obj_seed, box_seed,sphere_seed, cylinder_seed, face_refine, obj_surf_refine,obj_refine, box_refine, sphere_refine, cylinder_refine,

tagging criterion:tag_by_size=0, tag_by_shape, tag_by_tri_area,tag_by_lensqr, tag_by_shape_over_size,tag_by_needle_factor, tag_undefined

gather scope:gather_by_solid_id=0, gather_in_a_box,gather_in_a_cylinder, gather_near_solid_surfaces,gather_near_faces, gather_all_tets,gather_all_non_background_tets

Limit growth to this number of element: LONGSkin depth tau: DOUBLE



SelectOneFace

Use: Selects a face of an object by its id number non-graphically.Command: Edit/Select Faces

Syntax: selectoneface face_id_number

SelFaces

Use: Select faces for seeding or refinement graphically, using the mouse.Command: Edit/Select Faces

Syntax: selfaces

SetBoxScope

Use: Defines the mesh display scope.Command: none

Syntax: setboxscope <mesh display scope> <x coordinate oflower left corner of box for box-refinement floatingpoint -1.0> <y coordinate of lower left corner of boxfor box-refinement floating point -1.0> <z coordinateof lower left corner of box for box-refinementfloating point -1.0> <x coordinate of upper rightcorner of box for box-refinement floating point 1.0><y coordinate of upper right corner of box for box-refinement floating point 1.0> <z coordinate of upperright corner of box for box-refinement floating point1.0>

Note: Mesh display scope: 0=all_mesh, 5=inside_sel_boxExample: SetBoxScope 0 <0 0 0> <100 100 100>

This example displays the mesh on the entire object in the regionfrom the origin to [100,100,100].

SetDisplayOn

Use: Turns on the model display.Command: none

Syntax: setdisplayon state

Note: state: TRUE=1, FALSE = 0



SetFaceterRefinements

Use: Defines the refinement settings for ACIS facetting.Command: Mesh/Make

Syntax: setfaceterrefinements “type of surface” “type ofsetting” <value to be set>

Note: type of surface: plane, cone, sphere, torus or splinetype of setting: aspect_ratio, normal_deviation, orsurface_deviationvalue to be set: normal deviation in degrees, surface deviation inmodel units

SetMeshDisplayMode

Use: Defines the mesh display mode.Command: none

Syntax: setmeshdisplaymode mode_number

Note: mode_number:

■ 1 for shaded mesh■ 2 for wireframe mesh■ 3 for hidden line mesh

SetTriScope

Use: Defines which faces get plotted and which are skipped during theplotting process.

Command: none

Syntax: settriscope scope_number

Note: Mesh display scope:

■ 2 for plotting on all faces.■ 3 for plotting only on selected faces.■ 4 for plotting only on unselected faces.

SetViewKindWireFrame

Use: Sets the window to display wireframe meshes.Command: none

Syntax: setviewkindwireframe

ShadedMesh

Use: Displays the mesh in shaded form in the window.Command: none

Syntax: shadedmesh



ShowHideMesh

Use: Toggles by displaying or hiding the mesh.Command: Mesh/Show Mesh

Syntax: showhidemesh

ShowMesh

Use: Displays the mesh in the 3D Meshmaker window.Command: Mesh/Show Mesh

Syntax: showmesh

ShowPoints

Use: Displays the points of the mesh.Command: none

Syntax: showpoints

ShowSurfTri

Use: Displays the surface triangles of the initial mesh.Command: Mesh/Display Parameters

Syntax: showsurftri

ShowTets

Use: Displays the tetrahedra of the mesh.Command: Mesh/Display Parameters

Syntax: showtets

SmoothenMesh

Use: Applies a LaPlacian smoothing to the mesh. This command moves thenodes of the mesh to create a smoother point distribution.

Command: none

Syntax: smoothenmesh num_passes

WriteMesh

Use: Writes out the mesh to set of files.Command: none

Syntax: writemesh

WriteMeshAs

Use: Opens a file browser, allowing you to save the mesh file sets under a newname.

Command: File/Save As

Syntax: writemeshas

macro.bk : postcs.fm 1 Mon Jan 15 11:41:10 2001

Post Processor Script Commands 10-1

10

Post Processor Script Commands

This chapter describes the script commands specific to the three post-processing modules available in Maxwell 3D. Refer to Appendix A, “ModuleScript Commands,” for a complete list of the commands available in thesemodules.Each post-processing module uses the following generic command setsdescribed in Chapter 3 and Chapter 4:● Generic module● mod3proj● mod3view● Default

The 3D Post Processor has these additional command sets:● PostProcessor3D● Plot 3D● FieldCalculator

This chapter describes the post-processing modules’ command sets.


3D Post Processor Command Sets

10-2 Post Processor Script Commands

3D Post Processor Command SetsThe PostProcessor3D, Plot 3D, and FieldCalculator command sets areavailable in the 3D Post Processor.

PostProcessor3D Script CommandsThe following script commands are classified as PostProcessor3D scriptcommands.

ArrowPlotOptions

Use: Opens the Arrow Plot Options window, allowing you to specify the typeand size of arrows in a plot.

Command: none

Syntax: arrowplotoptions

CalcVisToggle

Use: Opens the calculator.Command: Data/Calculator

Syntax: calcvistoggle

CascadeAll

Use: Cascades all the open windows, stacking them.Command: Window/Cascade

Syntax: cascadeall

CascadeProjects

Use: Cascades all open project windows, stacking them.Command: Windows/Cascade

Syntax: cascadeprojects

CascadeViews

Use: Cascades all open view windows, stacking them.Command: Windows/Cascade

Syntax: cascadeviews

CHelp

Use: Displays context-sensitive help.Command: Help/On Context

Syntax: chelp




CloseProject

Use: Closes the active project.Command: File/Close

Syntax: closeproject

CloseWindow

Use: Closes the active view window.Command: Window/Close

Syntax: closewindow

DeleteGeometry

Use: Allows you to select a geometry to delete from the window that appears.Command: Geometry/Delete

syntax: deletegeometry

DeletePlot

Use: Deletes a plot.Command: Plot/Delete

Syntax: deleteplot “plot_name”

Example: deleteplot “plot1”

This deleted plot1 from the active plots.

DisablePlineStitch

Use: Disables polyline stitching.Command: none

Syntax: disableplinestitch

EditBoundDisplay

Use: Opens the boundary display window and allows you to display theboundaries that were defined in the 3D Boundary Manager.

Command: Edit/Boundary Display

Syntax: editbounddisplay

EditFunctions

Use: Edits the function table.Command: Data/Functions/Edit

Syntax: editfunctions




EditPline

Use: Creates or edits a planar or 3D polyline.Command: none

Syntax: editpline “Polyline/sheet object”

Example: editpline “Line1”

This example creates (or edits, if it already exists) a polyline, Line1.You then enter Edit Pline mode, and will need to use the EditPlinescript commands to create the polyline.

EditPline - AddVert

Use: Adds a vertex to the polyline.Command: Geometry/Create/Line

Syntax: addvert [x,y,z]

Example: addvert [0,0,0]


EditPline - AddVert3D

Use: Adds a vertex to the polyline.Command: Geometry/Create/Line

Syntax: addvert3d X Y Z

Example: addvert3d 0 0 0


EditPline - Arc

Use: Creates an arc.Command: Geometry/Create/Line

Syntax: Arc ARC_ANGLE

Example: Arc 90

This example adds a 90-degree arc to the current polyline.

EditPline-CancelPline

Use: Cancels polyline edit or sheet edit mode.Command: none

Syntax: cancelpline




EditPline - Closepline

Use: Connects the last vertex entered with the first vertex entered, creating aclosed loop.

Command: Geometry/Create/Line

Syntax: closepline

EditPline - DelEdge

Use: Deletes an edge of the polyline.Command: Geometry/Create/Line

Syntax: deledge EDGENUMBER

Example: deledge 0

This example deletes the first line segment created. The segmentnumbering begins at 0 with the first segment created. When youdelete an edge, the segments created after that edge are renumbered.

EditPline - DelVert

Use: Deletes the specified vertex.Command: Geometry/Create/Line

Syntax: delvert [x,y,z]

Example: delvert [0,0,0]

This example deletes the vertex at the origin.

EditPline - EdgeGeom

Use: Changes the Edge Geometry of a segment.Command: Geometry/Create/Line

Syntax: edgegeom EDGE_NUMBER EDGE_GEOMETRY

Note: EDGE_GEOMETRY: 0=Straight, 1=Arc, 2=Spline

Example: edgegeom 1 1

This example changes the second line segment to an arc segment. Theline segment numbering begins at 0 with the first segment created.

EditPline - EdgeMode

Use: Specifies the Edge Geometry mode.Command: Geometry/Create/Line

Syntax: edgemode EDGE_GEOMETRY

Note: EDGE_GEOMETRY: 0=Straight, 1=Arc, 2=Spline

Example: edgemode 1

This example specifies the Edge Geometry mode as Arc. All segmentscreated after this will be arc segments.




EditPline - EndPline

Use: Use this when you have finished creating or editing the polyline and youwish to save it.


Syntax: endpline

EditPline - EndTangent

Use: Makes an edge of the arc end tangent to the next edge.Command: Geometry/Create/Line

Syntax: endtangent EDGE_NUMBER

Example: endtangent 2

This example makes the edge of the arc (edge number 1) end tangentto the next edge (edge number 2).

EditPline - FindPlineVertNo

Use: Finds the vertex number for the specified vertex.Command: Geometry/Create/Line

Syntax: findplinevertno [x,y,z]

Example: findplinevertno [2,4,0]

This example finds the vertex number of the vertex at [2,4,0].

EditPline - GetPlineVert

Use: Finds the position of the specified vertex number.Command: Geometry/Create/Line

Syntax: getplinevert VERTEX_NUMBER

Example: getplinevert 3

This example returns the position of the third vertex.

EditPline - Insvert

Use: Inserts a vertex in the middle of a polyline.Command: Geometry/Create/Line

Syntax: insvert [vertex to insert before] [new position]

Example: insvert [2,4,0] [2,2,0]

This example inserts a new vertex at [2,2,0], before the vertex at[2,4,0].




EditPline - JoinSplines

Use: Joins two splines that share a vertex.Command: Geometry/Create/Line

Syntax: joinsplines VERTEX_NUMBER

Example: joinsplines 3

This example joins the two polylines that share the third vertex.

EditPline - MoveArcMidPt

Use: Moves the midpoint of an arc.Command: Geometry/Create/Line

Syntax: movearcmidpt EDGE_NUMBER [x,y,z]

Example: movearcmidpt 1 [2,2,0]

This example moves the midpoint of the arc (edge number 1) to[2,2,0].

EditPline - MoveVert

Use: Moves a vertex to the specified position.Command: Geometry/Create/Line

Syntax: movevert [vertex position] [new position]

Example: movevert [2,4,0] [2,2,0]

This example moves the vertex at [2,4,0] to [2,2,0].

EditPline - OpenPline

Use: The opposite of closepline. This creates an opening in a closed polyline byremoving the segment that closed the loop.

Command: none

Syntax: openpline

EditPline - RenameCurPline

Use: Renames the polyline currently being edited.Command: Geometry/Modify/Line

Syntax: RenameCurPline “new name”

EditPline - SetArcAngle

Use: Sets the angle of a polyline arc.Command: Geometry/Create/Line

Syntax: setarcangle EDGE_NUMBER ANGLE

Example: setarcangle 1 60

This example sets the angle of the arc (edge number 1) to 60 degrees.




EditPline - SetArcRadius

Use: Sets the radius of the polyline arc.Command: Geometry/Create/Line

Syntax: setarcradius EDGE_NUMBER RADIUS

Example: setarcradius 1 10

This example sets the radius of the arc (edge number 1) to 10. Theunits of the radius are the units you specified in the 3D Modeler.

EditPline - SetArcToFillet

Use: Sets a polyline arc to be a fillet with the specified radius.Command: Geometry/Create/Line

Syntax: setarctofillet EDGE_NUMBER RADIUS

Example: setarctofillet 1 10

This example sets the radius of the arc (edge number 1) to 10 andselects Fillet.

EditPline - SplitSpline

Use: Splits a spline in two at the specified vertex.Command: Geometry/Create/Line

Syntax: splitspline VERTEX_NUMBER

Example: splitspline 3

This splits the splines at the third vertex.

EditPline - StartTangent

Use: Makes an edge of the arc start tangent to the previous edge.Command: Geometry/Create/Line

Syntax: starttangent EDGE_NUMBER

Example: starttangent 2

This makes the edge of the arc (edge number 1) start tangent to theprevious edge (edge number 0).

EnablePlineStitch

Use: Enables polyline stitching, allowing you to stitch polyline objects togetherwith the stitch commands.

Command: none

Syntax: enableplinestitch




Exit

Use: Exits the current module.Command: File/Exit

Syntax: exit

FormatPlotAxes

Use: Formats the axis labels and formats in the active plot.Command: Plot/Format/Axes

Syntax: formatplotaxes

FormatPlotGraphs

Use: Formats the graphs in the active plot.Command: Plot/Format/Graphs

Syntax: formatplotgraphs

GeneralPlotOptions

Use: Displays the General Plot Options window, allowing you to specify thecolor and scaling preferences for the plot.

Command: none

Syntax: generalplotoptions

LinePlotOptions

Use: Displays the Line Plot Options window, allowing you to specify the colorand sizing preferences for a line plot.

Command: none

Syntax: lineplotoptions

ListPlotsProject

Use: Lists all plots in the current project.Command: none

Syntax: listplotsproject

ListPlotsView

Use: Lists all plots in the current view.Command: none

syntax: listplotsview




LoadCartesian3DPlot

Use: Loads and displays a 3D Cartesian plot in the plot window. You musthave created a plot prior to using this command.

Command: none

Syntax: LoadCartesian3DPlot “filename”

Note: You cannot add more than one trace to the plot.The input file has to be of the following format:

B_PLOT3D {[cartesian]} Heading str B_TRACE3D TraceName str B_LINES numlines num_points_on_line B_LINE x y z ... E_LINE ... E_LINES E_TRACE3DE_PLOT3D

Example: loadcartesian3dplot “plotlines”

This example loads the plotlines file and displays its associated plot on inthe plot window.

MarkerPlotOptions

Use: Displays the Plot Marker Options window, allowing you to specify thetype and size of the markers in the plot.

Command: none

Syntax: markerplotoptions

ModifyPlot

Use: Displays a window to allow you to modify an existing plot.Command: Plot/Modify

Syntax: modifyplot “plot name”

Example: modifyplot “plot1”

This example accesses a window that allows you to modify the name,scale, and color map of plot1.




ModifyVariables

Use: Modifies the variables in the function table.Command: Data/Functions/Modify

Syntax: modifyvariables

NewWindow

Use: Creates a new view window.Command: Window/News

Syntax: newwindow

OpenProject

Use: Opens a solved project.Command: File/Open

Syntax: openproject “Project name” “Solution name”

Example: openproject “magnet” “magnet”

This example opens the solutions file in the project magnet. Thesolutions file has the same name as the project.

PanelPlotDelete

Use: Deletes the existing plots.Command: Plot/Delete

Syntax: panelplotdelete

PanelPlotVisibility

Use: Edits the visibility of active plots.Command: Plot/Visibility

Syntax: panelplotvisibility

PostProcessorOptions

Use: Defines the user preferences for the settings of the 3D Post Processor.Command: Options/Preferences

Syntax: postprocessoroptions

SaveDefinitions

Use: Saves the post-processing information to a file. The file has the samename as the project.

Command: File/Save

Syntax: savedefinitions




ShowCalc

Use: Displays the field calculator. This command is identical to CalcVisToggle.Command: Data/Calculator

Syntax: showcalc

ShowPlotCoordinates

Use: Displays the coordinates of the active point.Command: Plot/Show Coordinates

Syntax: showplotcoordinates

ShowSolutionInfo

Use: Displays solution and mesh information.Command: Data/Solution Info

syntax: showsolutioninfo

TileAllGrid

Use: Tiles all active windows.Command: Window/Tile

Syntax: tileallgrid

TileProjectsGrid

Use: Tiles the active project windows.Command: Window/Tile

Syntax: tileprojectsgrid

TileViewsGrid

Use: Tiles the active view windows.Command: Window/Tile

Syntax: tileviewsgrid

TogglePlotVisibility

Use: Toggles the visibility of the specified plots.Command: none

Syntax: toggleplotvisibility “Plot name”

Example: toggleplotvisibility “plot1”

This toggles off the visible plot, plot1.




Plot 3D Script CommandsThe following script commands are classified as Plot 3D script commands.

Graph3dSetColor

Use: Sets the color of the lines on a graph. Select the color from the windowthat appears.

Command: none

Syntax: graph3dsetcolor

Graph3dSetFilled

Use: Displays the 3D graph as a shaded graph or a contour graph.Command: none

Syntax: graph3dsetfilled “Filled Yes/No”

Example: graph3dsetfilled “yes”

This example displays the 3D graph as a shaded graph.

Graph3dSetLine

Use: Defines the line attributes for graphs. Select the line attributes from thewindow that appears.

Command: none

Syntax: graph3dlineset

Graph3dSetOutline

Use: Displays the outline of the 3d graph.Command: none

Syntax: Graph3dSetOutline draw_outline

Note: draw_outline: the LONG value of the outline.

Graph3dSetRefinement

Use: Sets refinement levels for graphs, providing a smoother variation ofcolors.

Command: none

Syntax: graph3dsetrefinement LEVEL

Note: LEVEL: 0=Low, 1=Medium, 2=High

☞Note: The Plot 3D script commands require that a plot be present.




Graph3dSetShade

Use: Turns lighting effects on or off.Command: none

Syntax: graph3dsetshade ON/OFF

Note: ON/OFF: 0=On, 1=Off

Graph3DSetToneShaded

Use: Displays the 3d graph in tone shaded colors.Command: none

Syntax: Graph3DSetToneShaded TONE

Note: tone: number corresponds to a defined colormap shade.

Graph3dUpdateGraph

Use: Updates the graph to incorporate any changes (such as changing the lineattributes with the Graph3dSetLine command).

Command: none

Syntax: graph3dupdategraph

Plot3dDrawAxes

Use: Turns the axes on or off.Command: none

Syntax: plot3ddrawaxes ON/OFF


Plot3dDrawGrid

Use: Turns the grid on or off.Command: none

Syntax: plot3ddrawgrid ON/OFF


Plot3dSetAxesLabelSize

Use: Sets the size of the axis labels.Command: none

Syntax: plot3dsetaxeslabelsize SIZE

Example: plot3dsetaxeslabelsize 0.025

This example sets the size of the label for each axis to 0.025 points.




Plot3dSetColorMap

Use: Sets the type of color map to use for the graph. Select the type from thewindow that appears.

Command: none

Syntax: plot3dsetcolormap

Plot3dSetHeadExtrusion

Use: Extrudes the plot heading by the specified distance in the current units.Command: none

Syntax: plot3dsetheadextrusion DISTANCE

Plot3dSetHeading

Use: Sets the heading of the plot.Command: none

Syntax: plot3dsetheading “Heading”

Plot3dSetHeadingColor

Use: Sets the color of the heading.Command: none

Syntax: plot3dsetheadingcolor COLOR

Note: Due to the wide variety of colors, they are not listed here. Experimentwith various numbers to find a color you like.

Example: plot3dsetheadingcolor 1

This example changes the color of the heading to white.

Plot3dSetHeadingFont

Use: Sets the font of the heading.Command: none

Syntax: plot3dsetheadingfont FONT

Note: Due to the wide variety of fonts, they are not listed here. Experiment withvarious numbers to find a font you like.

Example: plot3dsetheadingfont 4

This example changes the font of the heading to Times Roman.

Plot3dSetHeadingSize

Use: Sets the size of the heading.Command: none

Syntax: plot3dsetheadingsize SIZE




Plot3dSetLighting

Use: Toggles the lighting effect on or off for 3D plots.Command: none

Syntax: plot3dsetlighting ON/OFF


Plot3dSetScale

Use: Allows you to change the scale of the plot.Command: none

Syntax: plot3dsetscale AUTO MIN MAX DIVISIONS LINEAR/LOG

Note: AUTO: 0=Use min/max settings, 1=Use autoscaleLINEAR/LOG: 0=Linear, 1=Logarithmic

Example: plot3dsetscale 0 0 10 10 0

This example defines a linear scale using the minimum setting of 0, amaximum setting of 10, and 10 divisions.

Plot3dShowColorKey

Use: Toggles the color key on or off.Command: none

Syntax: plot3dshowcolorkey ON/OFF

Note: ON/OFF: 0=Off, 1=On

Plot3dUpdatePlots

Use: Updates the plots in the active window.Command: none

Syntax: plot3dupdateplots




FieldCalculator Script CommandsThe following script commands are classified as FieldCalculator scriptcommands.

* (Multiply)

Use: Multiplies the contents of the top two registers on the stack.Command: Field Calculator

Syntax: *

+ (Add)

Use: Adds the contents of the top two registers on the stack.Command: Field Calculator

Syntax: +

– (Subtract)

Use: Subtracts the contents of the top two registers on the stack.Command: Field Calculator

Syntax: –

/ (Divide)

Use: Divides the top of the stack by the next entry.Command: Field Calculator

Syntax: /

1/

Use: Computes the inverse value of the top register of the calculator stack.Command: Field Calculator

Syntax: 1/

Abs

Use: Calculates the absolute value of the top of the stack.Command: Field Calculator

Syntax: Abs

AddFaceAtPos

Use: Adds the face at the specified position to a faces list.Command: none

Syntax: addfaceatpos “Faces list” “Object” [Face position]

Example: addfaceatpos “faces1” “abc” [10,5,0]

This adds the face at [10,5,0] on the object abc to the list faces1.




AddFaceWithId

Use: Adds a face with the specified ID to a faces list.Command: Geometry/Create/Faces List

Syntax: addfacewithid “Face list” “Object” ID

Example: addfacewithid “faces1” “abc” 1

This example adds the face with the ID number 1 to the list namedfaces1. The face ID number is unique for every face in the model; thenumber begins at 1 for the first object listed and increases with eachfollowing object. For example, if you have two boxes, the first box inthe list would have faces 1-6, and the second box in the list wouldhave faces 7-12.

AddObjectToList

Use: Adds an object to an existing list.Command: Geometry/Create/Object List

Syntax: addobjecttolist “List name” “Object name”

Example: addobjecttolist “condlist” “coppercyl”

This example adds the object coppercyl to the object list condlist.

AnimationAddFrame

Use: Adds a frame in the current window to an animation.Command: Plot/Animation

Syntax: animationaddframe “Plot name” “Frame name” POSITION

Note: POSITION refers to the frame’s position in the frame list. For example:-1=Add to end of list 0=Add to beginning of list 1=Add after first frame 2=Add after second frame

Example: animationaddframe “Animation1” “Frame1” -1

This example adds the frame Frame1 to the animation plotAnimation1 at the end of the frame list.

AnimationDeleteFrame

Use: Removes a frame from the animation. Note that the frame numberingbegins at zero.

Command: Plot/Animation

Syntax: animationdeleteframe “Plot name” FRAME_NUMBER

Example: animationdeleteframe “Animation1” 0

This example deletes the first frame from the animation plotAnimation1.




AnimationMoveFrame

Use: Moves a frame to a new position in the animation.Command: Plot/Animation

Syntax: animationmoveframe “Plot name” FRAME_NUMBER POSITION

Note: POSITION refers to the frame’s position in the frame list. For example:-1=Add to end of list 0=Add to beginning of list 1=Add after first frame 2=Add after second frame

Example: animationmoveframe “Animation1” 1 0

This example moves the second frame in the frame list to thebeginning of the list in the animation plot Animation1.

AnimationPlay

Use: Plays an animation plot.Command: Plot/Animation

Syntax: animationplay “Plot name” NUMBER_OF_FRAMES

Example: animationplay “magplot” 4

This example plays the next four frames of the animation namedmagplot.

AnimationPlot

Use: Creates an animation plot with the specified name.Command: Plot/Animation

Syntax: animationplot “Plot name” NUMBER_OF_FRAMES

Example: animationplot “Plot1” 10

This creates a 10-frame animation plot called Plot1.

AnimationSaveFrames

Use: Saves the frame of the selected animation to files with the given filenameprefix.

Command: none

Syntax: AnimationSaveFrames “plot name” “file’s base name”“format”

Note: format: bmp, gif, pict, tiff, or sgiExample: animationsaveframes “mag H” “antenna” “gif”

This example saves the magnetic field frames for the antenna file in .gifformat.




AnimationSavePlot

Use: Saves the contents of the selected animation to a file. AVI output isavailable only on the PC.

Command: none

Syntax: animationsaveplot “plot name” “filename” “format”DELAY GRAYSCALE [image_size] LOOPS BRIGHTNESS CONTRAST“avi compression” AVI_COMPRESSION_FACTOR

Note: format: GIF or AVIDELAY: time delay between frames, in seconds.GRAYSCALE: 0 for no, 1 for yes.image_size: [xval, yval]. Defaults to [0,0].LOOPS: number of loops in the animation.BRIGHTNESS: the brightness from -0.5 to 0.5. Defaults to 0.CONTRAST: 0.5 to 2.avi_compression: None, Inelindeo, Cinepak, MSVideo.AVI_COMPRESSION_FACTOR: 0 to 100. Default is 50.

Example: animationsaveplot “magH” “antenna” “avi” 3 0 [100,100]8 0 0 “none” 65

This example saves the magH for the antenna file as an AVI file whoseframes are spaced at 3-second intervals. The image size is 100x100 in fullcolor, with no compression or adjustments to the contrast or brightness.

AnimationSetDeltaVal

Use: Sets the value by which the animation variable changes between eachframe of animation. Use this command in conjunction withAnimationSetStartVal and AnimationSetStopVal.

Command: none

Syntax: animationsetdeltaval VALUE

AnimationSetPlayTime

Use: Plays the animation for the specified time, in milliseconds.Command: none

Syntax: AnimationSetPlayTime TIME

AnimationSetRefinement

Use: Sets the refinement value for animation plots.Command: none

Syntax: AnimationSetRefinement LEVEL

Note: LEVEL: 0 to 2




AnimationSetStartVal

Use: Sets the value at which the animation variable starts.Command: none

Syntax: animationsetstartval VALUE

AnimationSetStopVal

Use: Sets the value at which the animation variable stops.Command: none

Syntax: animationsetstopval VALUE

AnimationSetStoreFrame

Use: Sets whether you want to store the frames in memory for later use.Command: none

Syntax: AnimationSetStoreFrame STORE_FRAMES?

Example: STORE_FRAMES: 0 for no, 1 for yes.

AnimationSetVarName

Use: Sets the variable to vary to create an animation plot.Command: none

Syntax: animationsetvarname “Variable name”

Example: animationsetvarname “PHASE”

This example creates an animation plot by varying the phase of theselected quantity.

AnimationShowFrame

Use: Displays the specified frame of an animation plot.Command: Plot/Animation

Syntax: animationshowframe “Plot name” FRAME_NUMBER




ArcCreate

Use: Defines an arc geometry.Command: Geometry/Create/Arc

Syntax: arccreate [center] ARC_AXIS RADIUS <radius vector>CLOCKWISE? “angle/end_pos” SEGMENTS “object name”

Note: center: [xval, yval, zval]ARC_AXIS: 0 for X, 1 for Y, 2 for Z.radius_vector: <xval, yval, zval>CLOCKWISE?: 0 for counterclockwise, 1 for clockwise.angle/end_pos: angle or end position.

Example: arccreate [0,0,0] 0 10 <50,50,0> 1 “angle” 15 “arc1”

This example creates a clockwise arc named arc1 from the origin to[50,50,0] with 15 segments.

AtPhase

Use: Evaluates the complex quantity of the constant scalar and complex scalaror vector at the top of the stack at phase. The constant scalar needs to beat the top of the stack.

Command: Field Calculator

Syntax: atphase

BHPlot

Use: Plots the BH-curve for an object with nonlinear materials.Command: none

Syntax: bhplot “object name”

Example: bhplot “magnet1”

This example plots the BH-curve for the object, magnet1.

BuildPlotInfo

Use: Updates plots on the specified geometry.Command: none

Syntax: buildplotinfo “Geometry name”

Example: buildplotinfo “faces1”

This example updates the plot on the faces list faces1.

Clear

Use: Clears the stack contents in the Field Calculator.Command: Field Calculator

Syntax: clear




CmplxI

Use: Makes a scalar or vector into a complex quantity using the scalar orvector as the imaginary part.


Syntax: cmplxi

CmplxMag

Use: Calculates the complex magnitude of the top register of the stack.Command: Field Calculator

Syntax: cmplxmag

CmplxR

Use: Makes a scalar or vector into a complex quantity using the scalar orvector in the top register as the real part.


Syntax: cmplxr

Conj

Use: Calculates the conjugate of the top register of the stack.Command: Field Calculator

Syntax: conj

CreateAnimation

Use: Creates a new animation plot with a default name.Command: Plot/Animation

Syntax: createanimation NUMBER_OF_FRAMES

CreateBHPlot

Use: Accesses the BH Plot panel, allowing you to select the object for which toplot the BH-curve.

Command: Plot/BH curves

Syntax: createbhplot

CreateFacesList

Use: Creates a list of faces. Use the AddFaceWithId command to add faces tothe list.

Command: Geometry/Create/Faces List

Syntax: createfaceslist




CreatePlot

Use: Creates a new field plot.Command: Plot/Field

Syntax: createplot

Cross

Use: Calculates the cross product of the top two registers of the stack.Command: Field Calculator

Syntax: cross

Curl

Use: Calculates the curl of the top register of the stack.Command: Field Calculator

Syntax: curl

CutPlaneCreate

Use: Creates a cutplane. Use ModifyCutPlane and DeltaModifyCutPlane todefine the geometry of the cutplane.

Command: Geometry/Create/Cutplane

Syntax: cutplanecreate

CutPlaneModify

Use: Modifies cutplane definitions.Command: Geometry/Modify/Cutplane

Syntax: cutplanemodify

D/Dx

Use: Calculates the derivative of the top register with respect to x.Command: Field Calculator

Syntax: d/dx

D/Dy

Use: Calculates the derivative of the top register with respect to y.Command: Field Calculator

Syntax: d/dy

D/Dz

Use: Calculates the derivative of the top register with respect to z.Command: Field Calculator

Syntax: d/dz




DefineCutPlane

Use: Defines a cutplane geometry.Command: none

Syntax: definecutplane “Plane name” [Position] <Normal>

Example: definecutplane “plane1” [0,0,0] <0,0,10>

This example defines the cutplane named plane1 whose position restsat the origin and whose normal plane extends from [0,0,10].

DefineExternalFace

Use: Creates a list of surfaces from the object or object list you specify.Command: Geometry/Create/Surface List

Syntax: defineexternalface “Plane name” “Object/list name”

Example: DefineExternalFace “surf1” “obj1”

This example defines the faces of obj1 as the surface list surf1.

DefineFacesList

Use: Creates an object list. Add faces to the list using the AddFaceWithId orAddFaceAtPos commands.

Command: none

Syntax: definefaceslist “List name”

DefineFunction

Use: Defines a function. The new function is listed in the Functions table.Command: none

Syntax: definefunction “Function definition”

Example: definefunction “f=sin(x)”

This example defines f as sin(x).

DefineObjectList

Use: Creates an object list. Add objects to the list using the AddObjectToListcommand.

Command: none

Syntax: defineobjectlist “List name”

DefinePoint

Use: Defines a point.Command: none

Syntax: definepoint “Name” [px,py,pz]

Example: DefinePoint “pointsource“ [100,50,50]

This example defines a point named pointsource at [100,50,50].




DeleteLine

Use: Deletes a line.Command: none

Syntax: deleteline “Name”

DeletePlot

Use: Deletes an existing plot.Command: none

Syntax: deleteplot “Plot name”

DeletePoint

Use: Deletes a point.Command: none

Syntax: deletepoint “Name”

DeleteSurface

Use: Deletes a surface geometry.Command: none

Syntax: deletesurface “Name”

DeleteVolume

Use: Deletes a volume geometry.Command: none

Syntax: deletevolume “Name”

DeltaModifyCutPlane

Use: Changes the cutplane’s origin by a specified incremental position.Command: Geometry/Create/Cutplane

Syntax: deltamodifycutplane “Name” [Incremental position]<Normal>

Example: deltamodifycutplane “plane1” [0,0,1] <0,0,20>

This example modifies the origin of the cutplane plane1 by 1 unit inthe positive z-direction. If the origin had been at [0,0,2] it would nowbe at [0,0,3]. The normal of the plane is <0,0,20>.




DeltaModifyPoint

Use: Changes the point’s position by a specified incremental position.Command: Geometry/Create/Point

Syntax: deltamodifypoint “Name” [px,py,pz]

Example: deltamodifypoint “point1” [0,0,1]

This example moves the point point1 by 1 unit in the positive z-direction. If the point had been at [0,0,2] it would now be at [0,0,3].

Divg

Use: Calculates the divergence of the top of the stack.Command: Field Calculator

Syntax: divg

Domain

Use: Restricts a field quantity to a volume. The two top entries of the stackmust be a volume geometry and numeric quantity. The volume must beon the top of the stack


Syntax: domain

Dot

Use: Calculates the dot product of the top two stack registers.Command: Field Calculator

Syntax: dot

Draw

Use: Opens a drawing window, which allows you to draw a geometry (onlylines and surfaces) from the top stack register.


Syntax: draw

DrawLine

Use: Draws the line contained in the top register of the stack. This command islike the Draw command, except it does not access the Line Drawingwindow.


Syntax: drawline “Plot name”




DrawSurface

Use: Creates a plot of a surface.Command: Field Calculator

Syntax: drawsurface “Plot name”

DrawVolume

Use: Creates a volume box.Command: Field Calculator

Syntax: drawvolume “Plot name”

Enter

Use: Enters a solved field quantity in the top register of the stack.Command: Field Calculator

Syntax: enter “Quantity name”

Example: enter “E”

This example enters the complex E-field vector in the top register ofthe stack.

EnterComplex

Use: Enters a complex constant in the top register of the stack. The quantitymust be in the form [Real, Imag].


Syntax: entercomplex [Real, Imaginary]

EnterComplexVector

Use: Enters a complex vector quantity. Enter the real and imaginary parts foreach component of the vector.


Syntax: entercomplexvector [X_real, X_imag] [Y_real, Y_imag][Z_real, Z_imag]

EnterFrequency

Use: Enters the frequency in the top register of the stack.Command: Field Calculator

Syntax: enterfrequency

EnterLine

Use: Enters a specified line in the top register of the stack.Command: Field Calculator

Syntax: enterline “Name”




EnterPoint

Use: Enters a 3D point in the top register of the stack.Command: Field Calculator

Syntax: enterpoint “Name”

EnterScalar

Use: Enters a scalar constant in the top register of the stack.Command: Field Calculator

Syntax: enterscalar VALUE

EnterScalarFunction

Use: Enters a scalar function in the top register of the stack.Command: Field Calculator

Syntax: enterscalarfunction “Function name”

EnterSurface

Use: Enters a surface in the top register of the stack.Command: Field Calculator

Syntax: entersurface “Name”

EnterVector

Use: Enters a vector constant in the top register of the stack.Command: Field Calculator

Syntax: entervector <x,y,z>

EnterVectorFunction

Use: Enters a previously defined vector function in the top register of thestack.


Syntax: entervectorfunction “X function” “Y function” “Zfunction”

Example: entervectorfunction “PHI” “YPOS” “XANGLE”

This example enters the vector function <PHI, YPOS, XANGLE> onthe calculator stack.

EnterVolume

Use: Enters a volume in the top register of the stack.Command: Field Calculator

Syntax: entervolume “Name”




Evaluate

Use: Evaluates the operation in the top register of the stack.Command: Field Calculator

Syntax: evaluate

Exchange

Use: Exchanges the top two stack entries in the 3D Post Processor FieldCalculator. For example, if the top entry in the stack is a vector quantityand the second entry is a scalar quantity, this command exchanges thosetwo values so the top entry is now a scalar quantity and the second entryis a vector quantity.


Syntax: exchange

ExportToFile

Use: Exports the field quantity in the top register to a file, mapping it to a gridof points. Use this command to save field quantities in a format that canbe read by other modeling or post-processing software packages. Beforeusing this command, you must create a file containing the points.


Syntax: exporttofile “Points file name” “Export file name”

ExportToVolumeGrid

Use: Exports field values to locations on a grid.Command: Field Calculator

Syntax: exporttovolumegrid [Base vertex] [Box size] [Gridsize] “Export file name”

Example: exporttovolumegrid [-10,-10,-10] [20,20,20] [5,5,5]export1.dat

This example creates a 20x20x20 box that starts at the point [-10,-10,-10] and has grid points every 5 units. The values are saved in the fileeport1.dat.

FacesListModify

Use: Allows you to modify any faces list. Add faces to or remove faces fromthe list using the AddFaceWithId or RemoveFaceWithId commands.

Command: Geometry/Modify/Faces List

Syntax: faceslistmodify




FunctionValue

Use: Returns the value of the specified function.Command: none

Syntax: functionvalue “Name of function”

GetTopEntryValue

Use: Returns the value of the top register of the stack. The top register must bea constant and should be a real scalar or real vector. This information canthen be saved to a file or assigned to variables and used by other scriptcommands.


Syntax: gettopentryvalue

Grad

Use: Calculates the gradient of the top register of the stack.Command: Field Calculator

Syntax: grad

Imag

Use: Calculates the imaginary part of the top register of the stack.Command: Field Calculator

Syntax: imag

Integrate

Use: Integrates a field on a geometry. The contents of the top two registers ofthe stack need to be a geometry (other than a point or volume box)followed by a scalar.


Syntax: integrate

IsoSurface

Use: Generates an iso-value surface of the field.Command: Field Calculator

Syntax: isosurface

LineCreate

Use: Creates a polyline. Use the EditPline commands to create the points onthe line.


Syntax: linecreate




LineModify

Use: Selects a line to modify. After you select a line to modify, use theEditPline commands to modify the line.

Command: Geometry/Modify/Line

Syntax: linemodify “Line to modify”

LinePlot

Use: Creates a 3D line plot from the contents of the top two registers of thestack. The top of the stack must be a line geometry followed by a scalarquantity. Note that when you select a quantity and a surface using Plot/Field, they are loaded into the Field Calculator.

Command: Plot/Field

Syntax: lineplot “Plot name”




LinePlot2D

Use: Creates a 2D line plot from the contents of the top two registers of thestack. The top of the stack must be a line geometry followed by a scalarquantity.

Command: Plot/Field, Field Calculator

Syntax: lineplot “Plot name” COLOR WIDTH MARKER_STYLELINE_STYLE DRAW_MARKER? DRAW_LINE? NEW_WINDOW?

Note: color: Select a value between 0 and 255.width: The higher the number the thicker the line.marker_style: Select from the following types.

line_style: Select from the following types.

draw_marker?: 0=No Markers, 1=Draw Markersdraw_line?: 0=No lines, 1=Draw linesnew_window?: 0=Add to current window, 1=New window

Example: lineplot2d “graph2” 11 1 0 1 0 1 1

This creates a plot called graph2 in a new window. The graph usesthin, solid lines and does not have any markers displayed.

Type Marker Type Marker

0 no marker 6 Triangle

1 . 7 Circle

2 x 8 Solid Square

3 + 9 Solid Diamond

4 Square 10 Solid Triangle

5 Diamond 11 Solid Circle

Style Line Form

1 Solid line.

2 Dashed line.

3 Dotted line.

4 Dash-dot line.

5 Dash-dot-dot line.




LineRecalculate

Use: Updates all plots that depend on the line that is currently being modified.Command: Geometry/Modify/Line

Syntax: linerecalculate

Ln

Use: Takes the logarithm of the top of the stack.Command: Field Calculator

Syntax: ln

Load2DPlot

Use: Reads in a 2D plot (.dat file).Command: Plot/Open/2D Plot

Syntax: load2dplot “File name”

LoadPlot

Use: Reads in a 3D plot (.dsp file).Command: Plot/Open3D Plot

Syntax: loadplot “File name”

LockCutPlaneNormal

Use: Locks and unlocks the normal for a cutplane. Locked normals cannot bemodified

Command: none

Syntax: lockcutplanenormal “Plane name” LOCK

Note: LOCK: 0=Unlocked, 1=Locked

LockCutPlaneOrigin

Use: Locks and unlocks the origin of a cutplane. Locked origins cannot bemodified

Command: none

Syntax: lockcutplaneorigin “Plane name” LOCK


LockVolume

Use: Locks and unlocks the geometry. Locked geometries cannot be modified.Command: none

Syntax: lockvolume “Volume Name” LOCK





Log

Use: Takes the log base 10 value of the top register of the calculator stack.Command: Field Calculator

Syntax: log

Mag

Use: Computes the magnitude of the top of the stack.Command: Field Calculator

Syntax: mag

Material

Use: Multiplies or divides the vector in the top of the stack by the selectedmaterial property. At each tetrahedron, the field quantity is multiplied ordivided by the value of the selected material property — taking thedifferent material attributes of each object into account.


Syntax: material “Material” “Operation”

Note: Material: mu, epsi, omega, condOperation: mult=multiply, divd=divide

Example: material “mu” “mult”

This example multiplies the vector in the top of the stack by thepermeability.

MathFunc

Use: Evaluates the specified function using the value in the top of the stack asthe operand.


Syntax: mathfunc “Function”

Note: The following functions are available:SinCosTanAsinAcosAtanAtan2

Example: mathfunc “Sin”

This takes the sine of the quantity in the top of the stack.




Maximum

Use: Finds the maximum value of a field in a geometry. The top of the stackmust be a geometry (other than a point) followed by a numeric quantity.


Syntax: maximum

MaxPos

Use: Finds the position in a geometry where the field is at a maximum. The topof the stack must be a geometry (other than a point) followed by anumeric quantity.


Syntax: maxpos

Minimum

Use: Finds the minimum value of a scalar field in a geometry. The top of thestack must be a geometry (other than a point) followed by a numericquantity.


Syntax: minimum

MinPos

Use: Finds the position in a geometry where the field is at a minimum. The topvalue of the stack must be a geometry (other than a point) followed by anumeric quantity.


Syntax: minpos

ModelMax

Use: Displays the bounding box maximums.Command: none

Syntax: modelmax

ModelMin

Use: Displays the bounding box minimums.Command: none

Syntax: modelmin




ModifyCutPlane

Use: Sets a cutplane’s origin and normal.Command: Geometry/Create/Cutplane, Geometry/Modify/Cutplane

Syntax: modifycutplane “Name” [Position] <Normal>

Example: ModifyCutPlane “plane1” [0,0,0] <0,0,1>

This sets the origin of the cutplane plane1 to [0,0,0] and its normal tothe [0,0,1].

ModifyPlot

Use: Allows you to modify an existing plot from the window that appears. Thewindow that appears depends on the type of plot.

Command: Plot/Modify

Syntax: modifyplot “Plot name”

ModifyPoint

Use: Changes the position of a point.Command: Geometry/Create/Point, Geometry/Modify/Point

Syntax: modifypoint “Point name” [x,y,z]

Example: modifypoint “point1” [1,0,10]

This example changes the position of the point point1 to [1,0,10].

Neg

Use: Takes the negative of the value in the top register of the stack.Command: Field Calculator

Syntax: neg

Normal

Use: Returns the unit vector normal to the surface in the top register of thestack.


Syntax: normal

NormalComponent

Use: Computes the normal component of a vector quantity on a surface suchas a cutplane or object surface. This is the equivalent of taking the dotproduct of the quantity with the surface’s unit normal vector.


Syntax: normalcomponent




ObjectListCreate

Use: Displays a window which allows you to create an object list.Command: Geometry/Create/Object List

Syntax: objectlistcreate

ObjectListModify

Use: Displays a window which allows you to modify object lists.Command: Geometry/Modify/Object List

Syntax: objectlistmodify

OrphanPlots

Use: Makes all plots independent of the geometry on which they were createdand the numeric quantity they display.

Command: none

Syntax: orphanplots

Phase

Use: Calculates the phase of the top register of the stack.Command: Field Calculator

Syntax: phase

Plot

Use: Plots the field (second item on the stack) on a geometry (top of the stack).Command: Field Calculator

Syntax: plot

PlotMesh

Use: Draws a mesh for the current selection.Command: Plot/Mesh

Syntax: plotmesh

PlotModifyFunction


Syntax: plotmodifyfunction OPERATION “function name” “functionexpression”


Example: plotmodifyfunction 0 “Mat1” “X+5”

This adds the new function Mat1 and defines it as X+5.




PointCreate

Use: Displays a window which allows you to create a point.Command: Geometry/Create/Point

Syntax: pointcreate

PointModify

Use: Displays a window which allows you to modify points.Command: Geometry/Modify/Point

Syntax: pointmodify

PointValuePlot

Use: Creates a point value plot.Command: Field Calculator, Plot/Field

Syntax: pointvalueplot “Plot name”

Pop

Use: Deletes the top register of the stack.Command: Field Calculator

Syntax: pop

Pow

Use: Calculates the power of the top two stack contents. The number in the topregister is raised to the number in the second register of the stack.


Syntax: pow

Push

Use: Duplicates the top register of the stack.Command: Field Calculator

Syntax: push

ReadSolutions

Use: Reads a register into the calculator from a disk file.Command: Field Calculator

Syntax: readsolutions “File name”

Real

Use: Calculates the real part of the top register of the stack.Command: Field Calculator

Syntax: real




RemoveFaceAtPos

Use: Removes an object face at the specified position from a faces list.Command: none

Syntax: removefaceatpos “List name” “Object name” [Position]

Example: removefaceatpos “faces1” “abc” [10,2,5]

This example removes the face at [10,2,5] of the object abc from thefaces list faces1.

RemoveFaceWithId

Use: Removes a face with the specified ID from a faces list.Command: Geometry/Create/Faces List, Geometry/Modify/Faces List

Syntax: removefacewithid “Face list” “Object” ID

Example: removefacewithid “faces1” “abc” 1

This example removes the face with the ID number 1 from the faceslist faces1. The face is removed from the object abc. The face IDnumber is unique for every face in the model; the number begins atone for the first object listed and increases with each following object.For example, if you create two boxes, the first box in the list wouldhave faces 1-6, and the second box in the list would have faces 7-12.

RemoveObjectFromList

Use: Removes an object from a list.Command: Geometry/Create/Object List, Geometry/Modify/Object List

Syntax: removeobjectfromlist “List name” “Object name”

RenameEntry

Use: Renames the top of the stack.Command: Field Calculator

Syntax: renameentry “New name”

RenameLine

Use: Renames a polyline.Command: none

Syntax: renameline “Polyline name” “New name”

RenamePlot

Use: Renames a plot.Command: none

Syntax: renameplot “Plot name” “New name”




RenamePoint

Use: Renames a point.Command: none

Syntax: renameplot “Point name” “New name”

RenameSurface

Use: Renames a surface geometry.Command: none

Syntax: renamesurface “Surface name” “New name”

RenameVolume

Use: Renames a volume geometry.Command: none

Syntax: renamevolume “Volume name” “New name”

RollDn

Use: Rolls the bottom register to the top of the stack, moving the otherregisters down the stack.


Syntax: rolldn

RollUp

Use: Rolls the top register to the bottom of the stack, moving the otherregisters up the stack.


Syntax: rollup

Save2DPlot

Use: Saves a 2D Plot to a .dat file.Command: Plot/Save As/2D Plot

Syntax: save2dplot “filename”

SavePlot

Use: Saves a 3D plot to a .dsp file.Command: Plot/Save As/3D Plot

Syntax: saveplot “plotname” “filename” BINARY

Note: BINARY = 0 (save in binary format) or 1 (do not save inbinary format)

Example: saveplot “plot1” “magplots” 0

This example saves plot1 in the magplots.dsp file in binary format.




ScalarX

Use: Converts a vector to a scalar, using the x-component only.Command: Field Calculator

Syntax: scalarx

ScalarY

Use: Converts a vector to a scalar, using the y-component only.Command: Field Calculator

Syntax: scalary

ScalarZ

Use: Converts a vector to a scalar, using the z-component only.Command: Field Calculator

Syntax: scalarz

SetArrow

Use: Sets up arrow attributes.Command: none

Syntax: setarrow TYPE MAP_SIZE? MAP_COLOR? SIZE

Note: TYPE: 0=2D, 1=3DMAP_SIZE: 0=Off, 1=OnMAP_COLOR: 0=Off, 1=On

SetColormap

Use: Selects the color to use for the plot.Command: none

Syntax: setcolormap COLOR

Note: Enter one of the following COLOR parameters:

Parameter Color

0 Spectrum, Rainbow

1 Spectrum, Temperature

2 Spectrum, Magenta

3 Spectrum, Grayscale

8-23 Ramp color. The numbering begins in theupper left corner of the color map square andcounts down each column.




SetFilled

Use: Displays the graph as a shaded graph or a contour graph. Use this inconjunction with the SetPlotAttributes and UpdatePlots commands.

Command: none

Syntax: setfilled FILLED?

Note: FILLED?: 0=Contour, 1=Shaded

Example: setfilled 1

This example displays the graph as a shaded graph.

SetGridSpacing

Use: Sets up grid spacing. Use this in conjunction with the SetPlotAttributesand UpdatePlots commands.

Command: none

Syntax: setgridspacing SPACING

Example: setgridspacing 2

This example sets the space between grid points to 2.

SetHiddenLine

Use: Toggles between two types of wire frame view. One view allows you tosee the wire frame lines of every tetrahedron. The second view allowsyou to see only the wire frame lines of the tetrahedra on top. In otherwords, if a tetrahedron is “behind” another tetrahedron, it is not visible.Use this in conjunction with the SetPlotAttributes and UpdatePlotscommands.

Command: none

Syntax: sethiddenline TOGGLE

Note: TOGGLE: 0=All lines visible, 1=Hidden lines invisible

Example: sethiddenline 0

This example sets the view to one in which all lines are visible.

☞Note: To set the view to a shaded one, use the SetFilled command.




SetLine

Use: Sets up line attributes.Command: none

Syntax: setline WIDTH LINE_STYLE

Note: WIDTH: The higher the number the thicker the line.LINE_STYLE:

SetMarker

Use: Sets up a scalar marker.Command: none

Syntax: setmarker MARKER_STYLE MAP_SIZE? MAP_COLOR? SIZE

Note: MARKER_STYLE: Select from the following types.

MAP_SIZE: 0=Off, 1=OnMAP_COLOR: 0=Off, 1=OnMAP_COLOR: Enter one of the following parameters.

Style Line Form

1 Solid line.

2 Dashed line.

3 Dotted line.

4 Dash-dot line.

5 Dash-dot-dot line.

Type Marker

10 Sphere

11 Box

12 Tetrahedron

13 Octahedron

Parameter Color

0 Spectrum, Rainbow

1 Spectrum, Temperature

2 Spectrum, Magenta

3 Spectrum, Grayscale

8-23 Ramp color. The numbering begins in theupper left corner of the color map square andcounts down each column.




SetMeshExternal

Use: Selects whether tetrahedra are drawn on the surface of objects or insidethe objects.

Command: none

Syntax: setmeshexternal TOGGLE

Note: TOGGLE: 0=Inside object, 1=Object surfaces only

Example: setmeshexternal 1

This example displays the mesh tetrahedra only on the surfaces ofobjects.

SetMeshScale

Use: Sets the percentage of their original size at which mesh tetrahedra aredrawn.

Command: none

Syntax: setmeshscale SCALE_FACTOR

Example: setmeshscale 80

This example draws the tetrahedra at 80% of their original size.

SetNumPoints

Use: Sets up the number of points for line plots.Command: Geometry/Create/Line, Geometry/Modify/Line

Syntax: setnumpoints NUMBER

SetPlotAttributes

Use: Updates the plot attributes to the current settings. Use this commandafter setting the attributes and before updating the plot with UpdatePlots.

Command: none

Syntax: setplotattributes “Plot name”

SetRefinement

Use: Sets refinement levels for plots, providing a smoother variation of colors.Command: none

Syntax: setrefinement LEVEL

Note: LEVEL: 0=Low, 1=Medium, 2=High




SetScale

Use: Sets up a plot scale.Command: none

Syntax: setscale AUTOSCALE? MIN MAX LEVELS LOG?

Note: AUTOSCALE: 0=Use manual scale, 1=Use autoscaleLOG: 0=Linear, 1=Logarithmic

Example: setscale 0 0 10 12 0

This example creates a linear plot scale whose values range between 0and 10 units with 12 divisions.

SetTextMarker

Use: Selects text or markers for point value plots. If you select text, the value ofthe field at that point is displayed.

Command: none

Syntax: settextmarker SHOW_TEXT?

Note: SHOW_TEXT: 0=User markers, 1=Show text

Example: settextmarker 1

This example toggles markers to be the display type. Use theSetMarker command to set the marker parameters.

SetTransparency

Use: Sets the transparency of the plotted mesh on a percentage scale (0-100).Command: Plot/Mesh

Syntax: settransparency PERCENTAGE

ShowColorKey

Use: Shows or hides the color key for a plot.Command: none

Syntax: showcolorkey “Plot name” SHOW_FLAG?

Note: SHOW_FLAG: 0=Hide color key, 1=Show color key

Smooth

Use: Smooths the data in the top register of the stack.Command: Field Calculator

syntax: smooth

SolutionName

Use: Displays the name of the solution file.Command: none

Syntax: solutionname




Sqrt

Use: Compute the square root of the top register of the stack.Command: Field Calculator

Syntax: sqrt

StoreComputations

Use: Stores the values in the top register of the stack in memory for later use.Command: Field Calculator

Syntax: storecomputations STORE

Note: STORE: 0=No, 1=Yes (store)

SurfacePlot

Use: Creates a surface plot from the contents of the top two registers of thestack. The top register must be a surface geometry and the next registermust be scalar quantity. Note that when you select a quantity and asurface using Plot/Field, they are loaded into the Field Calculator.

Command: Plot/Field

Syntax: surfaceplot “Plot name”

Tangent

Use: Returns the unit vector tangential to the line in the top register of thestack.


Syntax: tangent

TangentComponent

Use: Computes the tangential component of a vector along a line.Command: Field Calculator

Syntax: tangentcomponent

Top

Use: Displays the top register of the stack.Command: Field Calculator

Syntax: top

Undo

Use: Undoes the previous specified number of operations. Replaces the top ofthe stack with its components in the Field Calculator.


Syntax: undo NUMBER_OF_STEPS




UpdatePlots

Use: Refreshes all plots, regenerating those that were modified.Command: none

Syntax: updateplots

Value

Use: Evaluates the value of the stack at a specified point. The top register mustbe a geometry and the next register must be a numeric quantity.


Syntax: value

VecX

Use: Converts a scalar value to a vector using only the x-component.Command: Field Calculator

Syntax: vecx

VecY

Use: Converts a scalar value to a vector using only the y-component.Command: Field Calculator

Syntax: vecy

VecZ

Use: Converts a scalar value to a vector using only the z-component.Command: Field Calculator

Syntax: vecz

VolumeBoxCreate

Use: Defines a volume box geometry.Command: Geometry/Create/Volume Box

Syntax: volumeboxcreate [Base vertex] SIZE_X SIZE_Y SIZE_Z“Object name”

Example: volumeboxcreate [0,0,0] 10 10 10 “lgbox”

This creates a 10x10x10 box, lgbox, whose base vertex is at the origin.

VolumePlot

Use: Creates a volume plot from the top two contents of the calculator stack.The top two entries of the stack must be a volume geometry followed by ascalar quantity. Note that when you select a quantity and a volume usingPlot/Field, they are loaded into the Field Calculator.

Command: Plot/Field

Syntax: surfaceplot “Plot name”




WriteSolutions

Use: Writes field values to a file.Command: Field Calculator

Syntax: writesolutions “File name”




macro.bk : wizardcs.fm 1 Mon Jan 15 11:41:10 2001

Wizard Script Commands 11-1

11

Wizard Script Commands

This chapter describes the script commands that allow you to create wizards.A wizard is a graphical interface that prompts the user for the necessaryinformation to complete a task.


Wizard Arguments

11-2 Wizard Script Commands

Wizard ArgumentsSeveral wizard script commands require complex arguments that areexplained in detail in this section, rather than in the Default commands listsin which they reside.

Information TypesWhen creating a wizard field using the AddWizardField command, you mustspecify the type of information the wizard expects the user to enter. There arenine types of information:

LONG An integer.DOUBLE A double precision floating point number.DOUBLE LIST A list of double precision floating point numbers. The user

must enter the data in the following form: {# # #}.STRING A character sequence. The user does not need to enclose

the character sequence in quotes unless it contains embed-ded blanks or punctuation.

STRING LIST A list of strings. The user must enter the data in the fol-lowing form: {“string1” “string2” “string3”}.

VEC2 A 2D vector, with an x- and y-component. The user mustenter the data in the following form: <x, y>.

VEC3 A 3D vector, with an x-, y-, and z-component. The usermust enter the data in the following form: <x, y, z>.

POS2 A 2D position, with an x- and y-component. The usermust enter the data in the following form: [x, y].

POS3 A 3D position, with an x-, y-, and z-component. The usermust enter the data in the following form: [x, y, z].


Wizard Arguments


Mathematical FunctionsWhen creating a validating expression to test the contents entered in thewizards fields with the AddWizardValidatorExpr command, use theappropriate syntax for the mathematical functions. The following legalfunctions may be used to define mathematical expressions:

/ Divide.+ Add.- Subtraction and unary minus.* Multiply.% Modulus.** Exponentiation.<< Left shift.>> Right shift.= Assign.== Equal to.!= Not equal to.> Greater than.< Less than.>= Greater than or equal to.<= Less than or equal to.& Bitwise AND.| Bitwise OR.^ Bitwise XOR.~ 1’s compliment.&& Logical AND.II Logical OR.! Factorial.if IF statement.sign Returns the sign of an argument. Syntax: sign (x)abs Absolute value. Syntax: abs (x)exp Exponential. Syntax: exp (x) = ex.pow Raises the specified value to the specified power. Syntax: pow

(x, y) = xy.ln Natural log. Syntax: ln (x)log Log base 10. Syntax: log (x)lg Log base 2. Syntax: lg (x)sqrt Square root. Syntax: sqrt (x)floor Round down. Syntax: floor (x)


Wizard Arguments


All trigonometric expressions expect their arguments to be in degrees, and theinverse trigonometric functions’ return values are in degrees. These functionnames are reserved and may not be used as variable names.

ceil Round up. Syntax: ceil (x)round Round to nearest x. Syntax: round (x)rand Generate a random number between 0 and 1. Syntax: rand ()deg Convert radians to degrees. Syntax: deg (x)rad Convert degrees to radians. Syntax: rad (x)sin Sine. Syntax: sin (x)cos Cosine. Syntax: cos (x)tan Tangent. Syntax: tan (x)asin Arc sine. Syntax: asin (x)acos Arc cosine. Syntax: acos (x)atan Arc tangent. Syntax: atan (x)atan2 Arc tangent (in the range of -n/2 to n/2). Syntax: atan2 (x)sinh Hyperbolic sine. Syntax: sinh (x)cosh Hyperbolic cosine. Syntax: cosh (x)tanh Hyperbolic tangent. Syntax: tanh (x)


Wizard Arguments


User Menu AdditionsThe following commands are classified as Default commands in the interface,but are part of the commands referred to as User Menu Additions, and are nottruly part of any module.

AddHelpSelboxItem

Use: Adds an item to the active module help selection box.Command: none

Syntax: addhelpselboxitem {item hierarchy} “Description”“macro filename”

Note: The acceptable values are as follows:Item hierarchy is a string list.Description is a string that describes the help item.Macro filename is a string containing the name of the macro file.

Example: addhelpselboxitem {“sketch” “fill”} “Fills the currentsketch with color” “sketch3d.mac”

This example adds the description to the Sketch/Fill commandwhich uses the sketch3d.mac macro file to complete the step wheninvoked.

AddMenuItem

Use: Adds a menu item to the end of the menu bar or to the end of an existingmenu. The macro file is executed when the menu item is selected.

Command: none

Syntax: addmenuitem {item hierarchy} “Description” “macrofilename”

Note: The acceptable values are as follows:Item hierarchy is a string list.Description is a string that describes the help item.Macro filename is a string containing the name of the macro file.

Example: addmenuitem {“sketch” “fill”} “Fills the currentsketch with color” “sketch3d.mac”

This adds the Sketch/Fill command to the menu and invokes thesketch3d.mac to execute the command.


Wizard Arguments


AddMenuSeparator

Use: Adds a user menu separator.Command: none

Syntax: addmenuseparator <menu hierarchy>

Note: Menu hierarchy is a string list.Example: Addmenuseparator <“sketch” “fill”>

This adds a separator after Sketch/Fill in the user-defined menu.

DebugFileExec

Use: Accesses the Macro Debugger to allow you to monitor the execution andmodify values in a running macro. Refer to the online documentation formore information on the Macro Debugger.

Command: none

Syntax: debugfileexec “macro file”

Note: The macro file can include the path and filename of the macro.Example: debugfileexec “c:\Maxwell\antenna.pjt\modelant.mac”

This example loads the modelant.mac file in the Macro Debuggerand raises the debugger window.

DeleteHelpSelboxItem

Use: Deletes a help selection box item.Command: none

Syntax: deletehelpselboxitem {Item hierarchy}

Note: Item hierarchy is a string list.Example: deletehelpselboxitem {“sketch” “fill”}

This example deletes the item for the Sketch/Fill hierarchy.

DeleteMenuItem

Use: Deletes a menu item from the hierarchy. You may delete an intermediatelayer of the hierarchy, provided it is a user-defined addition.

Command: none

Syntax: deletemenuitem {Item hierarchy}

Note: Item hierarchy is a string list.Example: deletemenuitem {“sketch” “fill”}

This example removes the user-defined item Sketch/Fill from themenu.


Wizard Arguments


DisableMenuItem

Use: Disables a user-defined menu item.Command: none

Syntax: disablemenuitem {Item hierarchy}

Note: Item hierarchy is a string list.Example: disablemenuitem {“sketch”}

This example disables the user-defined Sketch menu item.

MacroDebugger

Use: Accesses the Ansoft Macro Debugger.Command: none

Syntax: macrodebugger “macro filename”

Note: The macro filename must include the path to the macro.SetMenuItemHotkey

Use: Defines the hotkey for a user-defined menu item.Command: none

Syntax: SetMenuItemHotkey {hierarchy} “hotkey”

Note: hierarchy: This is a string list identifying the menu item to which toassign the hotkey.

Example: SetMenuItemHotkey {“sketch” “fill”} “ctrl-f4”

This example sets Control-F4 as the hotkey for the user-definedmenu item “Sketch/Fill.”


Wizard Arguments


Wizard Script CommandsThe following script commands are classified as Wizard script commands.

AddWizardButtons

Use: Adds a push, checkbox, or radio button or buttons to the wizard. Eachbutton is assigned a variable that allows the software to track whether thebutton was selected or not. In addition, several wizard script commandsuse the variables assigned to buttons to manipulate them.

Command: none

Syntax: addwizardbuttons “Wizard name” “Button type”BUTTON_WIDTH {“Variable names”} {“Button labels”}{“Command actions”} “Orientation” {pixmap files}

Note: Button type: Enter one of the following:

BUTTON_WIDTH: Enter the width, in characters, of the buttons.Variable names: The variables used to identify the buttons.Button labels: The text labels of the buttons.command actions: Command to execute when button is pressed. Usethe FileExec command to execute multiple commands for each button.Orientation: vert=vertical, horiz=horizontalpixmap files: A string list where optional contents are used only forPUSH buttons and specifies the files containing the pixmap definitions

Example: AddWizardButtons "input_geo" "push" 20 {"var1" "var2""var3"} {"Box 1" "Box 2" "Box 3" } {"FileExec'geo.mac" "Box [0, 100, 100] 100 100 100 'box2'" "Box[0, 100, 100] -100 -100 -100 'box3'"} "vertical"

This creates three buttons labeled Box 1, Box 2, Box 3 in a verticalformation. The buttons are identified by the variables var1, var2,var3. The first button executes the script command geo.mac, whichcould contain a second wizard that acts as a subwindow. The secondand third buttons draw boxes named box2 and box3, respectively.

☞Note: For checkboxes and radio buttons, the variables associated with these but-

tons have two possible values: 1 indicates that the button is selected, 0 indi-cates that the button is unselected.

Type Description

push A push button.

check A checkbox. Allows you to turn an option on and off.

radio A radio button. Allows you to select from among several.


Wizard Arguments


AddWizardField

Use: Creates the fields in which values are entered from the wizard window.Each field is given a variable name which is assigned the value the userenters. When you create a field, you must specify the variable type of thevalue entered. The variable types are listed in detail at the beginning ofthis chapter.

Command: none

Syntax: addwizardfield “Wizard name” “Variable name” “Variabletype” “Prompt”

Note: Variable name: The variable to which the value entered is assigned.Variable type: Enter one of the following:

Prompt: The name or prompt for the field.Example: addwizardfield “input_geo” “width” “DBL” “Enter the

width:”

This example creates a field labeled “Enter the width:” for the wizardinput_geo. The value entered in this field is a double precisionfloating point number and is assigned to the variable width.

AddWizardHelp

Use: Adds a help button to the wizard with the specified help text. Whenspecifying the help text, use \n to indicate a carriage return.

Command: none

Syntax: addwizardhelp “Wizard name” “Help text”

Example: addwizardhelp “wizard1” “You must enter a value \ngreater than zero.”

This example creates a help button in the wizard wizard1 with thetext, “You must enter a value greater than zero.” The text takes uptwo lines, with the second line starting with “greater.”

LONGDOUBLE or DBLDOUBLE_LIST or DLISTSTRING or STRSTRING_LIST, STRLIST, or LISTPOS2POS3VEC2VEC3


Wizard Arguments


AddWizardSelbox

Use: Adds a selection box to a wizard panel.Command: none

Syntax: addwizardselbox “wizard name” “field name” “fieldprompt” “initial text” WIDTH “onselect macro”

Note: WIDTH is 20 characters by default.Onselect macro defaults to “‘’“.

AddWizardSelboxItems

Use: Adds items to an existing wizard selection box.Command: none

Syntax: addwizardselboxitems “wizard name” “field name” {itemlist} POSITION

Note: Item list is a string list.Position defaults to a value of -1.

AddWizardText

Use: Adds text to the wizard. When specifying the text, use \n to indicate acarriage return or to cause an open space between controls.

Command: none

Syntax: addwizardtext “Wizard name” “Text”

Example: addwizardtext “wizard1” “Select one of the following:”

This example displays the text, “Select one of the following:” on thewizard1.


Wizard Arguments


AddWizardValidatorExpr

Use: Evaluates the specified expression when OK is chosen from the wizardpanel. This allows you to use a mathematical expression to test the valuesentered in the wizard’s fields. The expression may use variables definedby the wizard fields or buttons. Use the mathematical functions listed atthe beginning of this chapter for the expression. If the expression is valid,the wizard continues running. If the expression is invalid, an errormessage appears and the wizard remains displayed. An invalid state isindicated when the expression evaluates to zero.

Command: none

Syntax: addwizardvalidatorexpr “Wizard name” “Validator ID”“Expression”

Example: addwizardvalidatorexpr “wizard1” “val1” “log (y)/2” ==0.5

This evaluates the expression (log y)/2 = 0.5. If the expression is valid(y = 10) then the wizard panel disappears and the macro continuesrunning. If the expression is invalid (y does not equal 10), an errormessage appears and the wizard remains displayed.

CreateWizard

Use: Creates a new wizard with the name you specify. This name is used bythe system to identify the wizard.

Command: none

Syntax: createwizard “Wizard name”

DeleteWizardValidatorExpr

Use: Deletes the validator expression created with the AddWizard-ValidatorExpr command from the wizard definition.

Command: none

Syntax: deletewizardvalidatorexpr “Wizard name” “Validator ID”

☞Note: If the variable y is not defined, the expression cannot be evaluated and will

always display an error message.


Wizard Arguments


DestroyWizard

Use: Removes the wizards definition from memory. A running wizard by firstbe stopped. A wizard still runs while its panel is displayed and duringthe time between when the user chooses OK to start the wizard and theStopWizard command is executed.

Command: none

Syntax: destroywizard “Wizard Name”

ExecWizard

Use: Executes the RunWizard, FileExec, and StopWizard commands. Themacro file can make use of any defined variable which remain defineduntil the macro files completes its execution.

Command: none

Syntax: ExecWizard “Wizard name” “Macro name”

GetWizardRunResult

Use: Returns the result of the most recent RunWizard command for thespecified wizard.

Command: none

Syntax: GetWizardRunResult “wizard name”

GetWizardSelboxIndex

Use: Returns the selection index from a wizard selection box.Command: none

Syntax: GetWizardSelboxIndex “wizard name” “variable name”

Example: GetWizardSelboxIndex “modelcolor” “red”

In this example, the software returns the index number assigned tored in the modelcolor wizard. The index value is set using theSetWizardSelboxIndex command.

GetWizardSelboxText

Use: Returns the text label from a wizard selection box.Command: none

Syntax: GetWizardSelboxText “wizard name” “field name”


Wizard Arguments


IsWizardControlChecked

Use: Checks the status of the variables that identify a button defined by thewizard. This command returns a value of 0 if the variable is anythingother than a radio button or checkbox. For a radio button or checkbox, itreturns a 1 if checked, 0 if unchecked. This command works only when awizard panel is displayed.

Command: none

Syntax: iswizardcontrolchecked “Wizard name” “Variable name”

RunWizard

Use: Starts the wizard window using the interface features defined for thespecified wizard and sets the initial state of the buttons or fields in thewizard. The script commands that create the interface features and thewizard must precede this command.

Command: none

Syntax: runwizard “wizard name” {“variable:state”}“optional initalizer command”

Note: variable: The variable of the state initializer.state: These are state initializers. Use check, disable, or hide as thestate.

Example: assign status runwizard “setup1” {“num_passes:disable”“n_modes:disable”} “setwizardcontrolstate” “wizard1”“box” 0 1 0

This example the wizard setup1 and initially disables the fields orbuttons associated with the variables num_passes and n_modes. Italso invokes the SetWizardControlState which disables the buttonidentified by the variable name box in the wizard named wizard1command upon initialization. The variable status indicates whetherthe user chose OK or Cancel.

☞Note: The wizard is still considered to be running after the user chooses OK from

the window displayed by the wizard. The return value from the wizardindicates whether the user has selected OK (return value = 1) or Cancel(return value =0).

Once OK is selected, the wizard variables are automatically assigned. Ifvariables are currently defined that match variables the wizard is trying tocreate, the macro stops with an error.

You do not need to use StopWizard when Cancel is selected.


Wizard Arguments


SetWizardControlState

Use: Changes the state of a button. For example you can make a buttondisabled or enabled, visible or invisible, or (for checkboxes and radiobuttons) checked or unchecked. This command can only be used whenthe wizard’s interface is displayed. Because of this, it can only be used asa command action in the AddWizardButtons command or in a RunWizardinitializer.

Command: none

Syntax: setwizardcontrolstate “Wizard name” “Variable name”ENABLED VISIBLE CHECKED

Note: ENABLED: 0=disabled, 1=enabledVISIBLE: 0=invisible, 1=visibleCHECKED: 0=unchecked, 1=checked

Example: setwizardcontrolstate “wizard1” “box” 0 1 0

This example disables the button identified by the variable name boxin the wizard wizard1. The variable name must match the variablename of a button or field created with the AddWizardButtons orAddWizardField commands.

SetWizardControlText

Use: Changes the text of a button. This command can only be used when thewizard’s interface is displayed. Because of this, it can only be used as acommand action in the AddWizardButtons command or in an aRunWizard initializer.

Command: none

Syntax: setwizardcontroltext “Wizard name” “Variable name”“Text”

Example: addwizardbuttons "input_geo" "push" 20 {"variable1"}{"Box"} {"setwizardcontroltext ‘input_geo’ ‘variable1’‘Button Pressed’"} "horizontal"

This example creates a horizontal push button labeled Box in thewizard’s interface. When pressed, the button label changes to ButtonPressed. This example is only meant as a demonstration of thecommand.


Wizard Arguments


SetWizardFieldChoices

Use: Sets the acceptable values that a user may enter in a field. These values donot appear in the interface. You can use the SetWizardFieldDefaultcommand to visually indicate the acceptable values for a field. If the userenters a value that is not specified by SetWizardFieldChoices, an errormessage appears.

Command: none

Syntax: setwizardfieldchoices “Wizard name” “Variable name”{“Choice1” “Choice2” ... }

Example: setwizardfieldchoices “input_geo” “x_size” {“10” “20”“30”}

This defines the acceptable values for the field assigned the variablex_size as 10, 20, and 30 in the wizard input_geo.

SetWizardFieldDefault

Use: Initializes the value for a specified field. The default value will appear inthe edit box in the wizard panel.

Command: none

Syntax: setwizardfielddefault “Wizard name” “Variable name”“Command expression”

Note: Command expression: The command expression can be a value orany single script command. The results of the script command aredisplayed as the initial value for the field.

Example: setwizardfielddefault “input_geo” “width” “(sub temp110)”

This example sets the default value for the field identified by thevariable width to the results in a value of temp1-10.

SetWizardFieldPrompt

Use: Changes the runtime prompt text for edit controls in a wizard panel.Command: none

Syntax: SetWizardFieldPrompt “wizard name” “field name”“prompt”

Example: SetWizardFieldPrompt “inputcur” “current” “enter thecurrent value.”

This example prompt the user to enter the current value in thecurrent field name for the wizard named inputcur.


Wizard Arguments


SetWizardFieldRange

Use: Sets the acceptable range of values that a user may enter in a field. Thesevalues do not appear in the interface. You can use the SetWizardField-Default command to visually indicate the acceptable values for a field. Ifthe user enters a value that is not in the range specified bySetWizardFieldRange, an error message appears.

Command: none

Syntax: setwizardfieldrange “Wizard name” “Variable name”MIN_VALUE MAX_VALUE

Example: setwizardfieldrange “input_geo” “x_size” 10 50

This example defines an acceptable range of values between 10 and50 for the field assigned the variable x_size in the wizard input_geo.

SetWizardSelboxIndex

Use: Defines the selection by index for a wizard selection box.Command: none

Syntax: SetWizardSelboxIndex “wizard name” “variable name”ITEM_INDEX

Note: ITEM_INDEX: Starting at 0, this value corresponds to an item in theselection box.

Example: SetWizardSelboxIndex “modelcolor” “red” 2

This example assigns an index number of 2 to correspond to red in theselection box for the modelcolor wizard.

SetWizardTitle

Use: Sets the title of the window that appears when the wizard is invoked.Command: none

Syntax: setwizardtitle “Wizard name” “Title”

StopWizard

Use: Deletes the variables created by the wizard. It does not delete wizarddefinition, based on the commands that created the wizard, so you canuse RunWizard again after using this command.

Command: none

Syntax: StopWizard “Wizard name”

macro.bk : commands.fm 1 Mon Jan 15 11:41:10 2001

A-1

A

Module Script Commands

This appendix lists the script commands available in each module.

macro.bk : com

mands.fm

2 Mon Jan 15 11:41:10 2001

Mo

du

le Scrip

t Co

mm

nad

s

A-2 Executive Module Script Commands

The following script commands are available from the Executive Commands window:

Generic Module mod3proj mod3view Default M3DFS

CascadeAllCascadeProjectsCascadeViewsCloseWindowModuleIsPromptVisibleModulePrefsRevertModuleSavePrefsModuleSidewinLeftModuleSidewinRightModuleToggleMessageModuleTogglePromptModuleToolbar(direction)ModuleToolbarHideNewWindowPrintEntirePrintProjPrintRectPrintSubwinPrintViewTileAllGridTileAllHrzTileAllVrtTileProjectsGridTileProjectsHrzTileProjectsVrtTileViewsGridTileViewsHrzTileViewsVrt

AbortTimeoutActivateViewCheckOverlapDeleteCSDeselectDispShadedDispWireFlushEventsGetCurPosGetDouble “Prompt”GetLong “Prompt”GetNumObjectsGetNumViewsGetObjectNameGetOriginGetPosition “Prompt”GetString “Prompt”GetUnitConvGetUnitNameGetVector “Prompt”GlobalCSHideHideOrientHideRegionHideSelListLocalCSLoriginObjectCS

ObjectExistsOriginOrigin?PrintProjPrintViewRecolorRestoreCSRotateCSRotatedCSSaveCmdWinSaveCSSaveWindowSelectSelInBoxSetCurPosSetObjectCSShowShowAllShowOrientShowRegionToggleRegionUnrotatedCSVerifyRegionVisByItemXAxisAboutToXAxisToXUnitVec?YAxisAboutToYAxisToYUnitVec?ZAxisAboutToZAxisToZUnitVec?

AutoGridFitAllFitAllViewsFitSelLookatOrthoPerspPolarGridRectGridResetViewsRotViewShadedViewpointWireframe

AddAssignClearAllClearFunctionsClearVarsComplexFormatComponentComponentCountDatabaseAddRowDatabaseGetColumnsDatabaseGetFieldDatabaseGetRowsDatabaseSetFieldDeleteDatabaseDivDoubleListSetComponentDumpDatabaseEchoEQErrorEvaluateExpressionExportDatabaseFileCloseFileExecFileExecErrExitIfFileExecPauseFileExistsFileOpenFileReadFileRecordFileRecordAppendFileRecStopFileWriteFuncDefFuncHelpFuncSaveFuncUndefGEGetDateAndTimeGetFileListGetFileNameGetMacroPathGetMacroPathListGetProductId

GetUserOptionGetVersionGlobalGlobalAssignGTHelpImportDatabaseImportRawDatabaseIsCommandEnabledLELog10LTMinusMulNENewDatabaseORParametricFileExecPos2Pos3Pos3DistPrependMacroPathPrintHelpPrivateAssignProtectedAssignRandomFractionRemoveMacroPathSetEchoEnabledSetMacroPathListSetRecordingEnabledSetUnitsOfQuantSetUserOptionSleepStrConcatStringStringListSetComponentStrlenStrstrSubSubstringUnassignVec2Vec3XOR

GetForceOnGroupGetLastSolveInfoGetLorentzForceOnObjectGetMatrixCellValueGetTorqueOnGroupLaunchBoundariesProjDirProjName

macro.bk : com

mands.fm

3 Mon Jan 15 11:41:10 2001

Mo

du

le Scrip

t Co

mm

and

s

A-3

3D Modeler Script Commands(continued on next page)

The following script commands are available from the 3D Modeler:

Default Modeler3



AddVertAddVert3DArcBoxCancelPlineCircleClose3dClosePlineColorFacesColorSelConnectCoverOutlCoverSheetsCreateArcCylDefColordefcolor?DelEdgeDeleteDelVertDetachFacesDisablePlineStitchDupAxisDupLineDupMirrorEdgeGeomEdgeModeEditPlineEnablePlineStitchEndPlineEndTangentExitExpAssign

ExpClearExpDelExpEvalExpIncExpLoadExpSaveFindPlineVertNoFitRegionGetPlineVertNoHelixHideRegionImport3dInsVertIntersectJoinSplinesMirrorMoveMoveArcMidPtMoveVertNew3dOpenPlinePointProjPrefsRead2dRead3dReColorRectangleRedoRegionReNameResetViewsRotate

Save2dSave3dSaveSATSaveSLDScaleSectionSelClearSelColorSelCopySelCutSelPasteSetArcAngleSetArcRadiusSetArctoFilletSetModelSetNonModelSetSldTolSetUnitsShowRegionSplitSplitSplineStartTangentStitchSubtractSweepAxisSweepPathSweepTwistSweepVecUncoverUnDelUndoUnite

macro.bk : com

mands.fm

4 Mon Jan 15 11:41:10 2001

Mo

du

le Scrip

t Co

mm

nad

s

A-4 3D Modeler Script Commands

(continued)

Generic Module mod3proj mod3view


AbortTimeoutActivateViewCheckOverlapDeleteCSDeselectDispShadedDispWireFlushEventsGetCurPosGetDouble “Prompt”GetLong “Prompt”GetNumObjectsGetNumViewsGetObjectNameGetOriginGetPosition “Prompt”GetString “Prompt”GetUnitConvGetUnitNameGetVector “Prompt”GlobalCSHideHideOrientHideRegionHideSelListLocalCSLoriginObjectCSObjectExistsOriginOrigin?

PrintProjPrintViewRecolorRestoreCSRotateCSRotatedCSSaveCmdWinSaveCSSaveWindowSelectSelInBoxSetCurPosSetObjectCSShowShowAllShowOrientShowRegionToggleRegionUnrotatedCSVerifyRegionVisByItemXAxisAboutToXAxisToXUnitVec?YAxisAboutToYAxisToYUnitVec?ZAxisAboutToZAxisToZUnitVec?


macro.bk : com

mands.fm

5 Mon Jan 15 11:41:10 2001

Mo

du

le Scrip

t Co

mm

and

s

A-5

Material Manager Script Commands(continued on next page)

The following commands are available from the Material Manager:

Default Materials and MaterialKernel

AddAssignClearAllClearFunctionsClearVarsComplexFormatComponentComponentCountDatabaseAddRowDatabaseGetColumnsDatabaseGetFieldDatabaseGetRowsDatabaseSetFieldDeleteDatabaseDivDoubleListSetComponentDumpDatabaseEchoEQErrorEvaluateExpressionExportDatabaseFileCloseFileExecFileExecErrExitIfFileExecPauseFileExistsFileOpenFileReadFileRecordFileRecordAppendFileRecStop

FileWriteFuncDefFuncHelpFuncSaveFuncUndefGEGetDateAndTimeGetFileListGetFileNameGetMacroPathGetMacroPathListGetProductIdGetUserOptionGetVersionGlobalGlobalAssignGTHelpImportDatabaseImportRawDatabaseIsCommandEnabledLELog10LTMinusMulNENewDatabase

ORParametricFileExecPos2Pos3Pos3DistPrependMacroPathPrintHelpPrivateAssignProtectedAssignRandomFractionRemoveMacroPathSetEchoEnabledSetMacroPathListSetRecordingEnabledSetUnitsOfQuantSetUserOptionSleepStrConcatStringStringListSetComponentStrlenStrstrSubSubstringUnassignVec2Vec3XOR

EditBHCurveGetSelectedMaterialMaterialAcceptMaterialAddMaterialAssignMaterialClearMaterialDeriveMaterialModifyFunctionMaterialRevertMaterialSelectMaterialSetPropertyMaterialSetTypeMaterialUnderiveSaveMaterialDatabase

macro.bk : com

mands.fm

6 Mon Jan 15 11:41:10 2001

Mo

du

le Scrip

t Co

mm

nad

s

A-6 Material Manager Script Commands

(continued)



AbortTimeoutActivateViewCheckOverlapDeleteCSDeselectDispShadedDispWireFlushEventsGetCurPosGetDouble “Prompt”GetLong “Prompt”GetNumObjectsGetNumViewsGetObjectNameGetOriginGetPosition “Prompt”GetString “Prompt”GetUnitConvGetUnitNameGetVector “Prompt”GlobalCSHideHideOrientHideRegionHideSelListLocalCSLoriginObjectCSObjectExistsOrigin

Origin?PrintProjPrintViewRecolorRestoreCSRotateCSRotatedCSSaveCmdWinSaveCSSaveWindowSelectSelInBoxSetCurPosSetObjectCSShowShowAllShowOrientShowRegionToggleRegionUnrotatedCSVerifyRegionVisByItemXAxisAboutToXAxisToXUnitVec?YAxisAboutToYAxisToYUnitVec?ZAxisAboutToZAxisToZUnitVec?


macro.bk : com

mands.fm

7 Mon Jan 15 11:41:10 2001

Mo

du

le Scrip

t Co

mm

and

s

A-7

Boundary Module Script Commands(continued on next page)

The following script commands are available from the 3D Boundary Manager:

Default Boundary Module Boundary Kernel

AddAssignClearAllClearFunctionsClearVarsComplexFormatComponentComponentCountDatabaseAddRowDatabaseGetColumnsDatabaseGetFieldDatabaseGetRowsDatabaseSetFieldDeleteDatabaseDivDoubleListSetComponentDumpDatabaseEchoEQErrorEvaluateExpressionExportDatabaseFileCloseFileExecFileExecErrExitIfFileExecPauseFileExistsFileOpenFileReadFileRecordFileRecordAppendFileRecStop

FileWriteFuncDefFuncHelpFuncSaveFuncUndefGEGetDateAndTimeGetFileListGetFileNameGetMacroPathGetMacroPathListGetProductIdGetUserOptionGetVersionGlobalGlobalAssignGTHelpImportDatabaseImportRawDatabaseIsCommandEnabledLELog10LTMinusMulNENewDatabaseORParametricFileExecPos2Pos3

Pos3DistPrependMacroPathPrintHelpPrivateAssignProtectedAssignRandomFractionRemoveMacroPathSetEchoEnabledSetMacroPathListSetRecordingEnabledSetUnitsOfQuantSetUserOptionSleepStrConcatStringStringListSetComponentStrlenStrstrSubSubstringUnassignVec2Vec3XOR

AssignBoundaryDefineBndFuncsExitBndsSaveBndsSelectByNameSelectFacesIntersectionSetDefaultUnitsSetEddyEffectShowConductionPathsToggleViewBndVisVerifyCondPaths

AssignCurrDenTermBoundaryModifyFunctionBuildCondPathsCheckTerminalsClearAllBndsClearCurrDenTermsClearSelBoundaryClearSelectionCreateTerminalsPickFaceByIdPickFaceByRayReprioritizeSelBoundarySelectObjByNameSelectObjFacesSetAllBndUnitsToCurrentSetBndNameSetBndUnitsToCurrentSetBooleanSetBoundarySetEndpointSetMSRelationSetOriginSetScalarSetScalarForSetStartPointSetStringForSetUpointSetVectorSetVpointSwapBooleanToggleDispCurrentToggleEddyEffectTogglePickBndByNameTogglePickBndByRayTogglePickObjByNameTogglePickObjByRayTogglePickObjObjIntUndoClearUseSuggestedEddyEffectVals

macro.bk : com

mands.fm

8 Mon Jan 15 11:41:10 2001

Mo

du

le Scrip

t Co

mm

nad

s

A-8 3D Boundary Manager Script Commands

(continued)






macro.bk : com

mands.fm

9 Mon Jan 15 11:41:10 2001

Mo

du

le Scrip

t Co

mm

and

s

A-9

Meshmaker Script CommandsThe following commands are available from the Meshmaker:

Mesh3D Generic Module mod3proj mod3view

CloseProjectDeleteAllSeedDeleteAllSeedNonInteractivelyDeleteMeshDelSelFacesDeSelBodiesDoModelAnalysisExitFurtherImproveQualityGExitGWriteMeshHiddenLineOffHiddenLineOnHiddenLineOnOffHideAllHideMeshImproveQualityImproveSurfTriInteractiveDeleteMeshInteractiveMakeInitMeshMakeInitialMeshMeshDisplayModeMeshInfoModelAloneNewProject

NonInteractiveDeleteMeshOpenProjectPullPointsToTrueSurfacesRefreshViewSaveSeedSaveWindowSeedingInfoSeedRefineCommandToKernelSelectOneFaceSelFacesSetBoxScopeSetDisplayOnSetFaceterRefinementsSetMeshDisplayModeSetTriScopeSetViewKindWireFrameShadedMeshShowHideMeshShowMeshShowPointsShowSurfTriShowTetsSmoothenMeshWriteMeshWriteMeshAs





macro.bk : com

mands.fm

10 Mon Jan 15 11:41:10 2001

Mo

du

le Scrip

t Co

mm

nad

s

A-10

3D Executive Parameters Script CommandsThe following script commands are available from the 3D Executive Parameters module:

Generic Module mod3proj mod3view Default Executive ParametersCascadeAllCascadeProjectsCascadeViewsCloseWindowModuleIsPromptVisibleModulePrefsRevertModuleSavePrefsModuleSidewinLeftModuleSidewinRightModuleToggleMessageModuleTogglePromptModuleToolbar(direction)ModuleToolbarHideNewWindowPrintEntirePrintProjPrintRectPrintSubwinPrintViewTileAllGridTileAllHrzTileAllVrtTileProjectsGridTileProjectsHrzTileProjectsVrtTileViewsGridTileViewsHrzTileViewsVrt






AddObjectGroupDeleteObjectGroupExcludeObjectIncludeObjectSetCurrentObjectGroupSetCurrentSetupTypeSetTorqueAxisAnchorPointSetTorqueAxisEndPoint

macro.bk : com

mands.fm

11 Mon Jan 15 11:41:10 2001

Mo

du

le Scrip

t Co

mm

and

s

A-11

3D Solution Setup Script Commands(continued on next page)

The Solution Setup script commands are available once the Solve Setup window is active. These commands are accessedthrough the Executive Command window’s command prompt window:

Default M3DFS Solution Setup




SaveSetupSetAdaptiveInfoSetCondResidualSetCondSAdaptiveInfoSetCondSolutionTypeSetCurrentSolnPrmsTypeSetFrequencySetMeshTypeSetNonLinResidualSetNopSetResidualSetSolveFieldsSetSolvePrmsSetSolverSetSolveTypeSolnPrmsDone

macro.bk : com

mands.fm

12 Mon Jan 15 11:41:10 2001

Mo

du

le Scrip

t Co

mm

nad

s

A-12

3D Solution Setup Script Commands )(Continued)






macro.bk : com

mands.fm

13 Mon Jan 15 11:41:10 2001

Mo

du

le Scrip

t Co

mm

and

s

A-13

3D Solution Variables Script CommandsThe following script commands are available from the parameteric tables in both the Solve Setup and Post Processor

modules:

Generic Module mod3proj mod3view Default M3DFS








macro.bk : com

mands.fm

14 Mon Jan 15 11:41:10 2001

Mo

du

le Scrip

t Co

mm

nad

s

A-14

3D Post Processor Script Commands(continued on next page)

The following script commands are available from the 3D Post Processor:

Generic Module mod3proj mod3view Default Plot3D







Graph3dSetColorGraph3dSetFilledGraph3dSetLineGraph3dSetRefinementGraph3dSetShadeGraph3dUpdateGraphPlot3dDrawAxesPlot3dDrawGridPlot3dSetAxesLabelSizePlot3dSetColorMapPlot3dSetHeadExtrusionPlot3dSetHeadingPlot3dSetHeadingColorPlot3dSetHeadingFontPlot3dSetHeadingSizePlot3dSetLightingPlot3dSetScalePlot3dShowColorKeyPlot3dUpdatePlots

macro.bk : com

mands.fm

15 Mon Jan 15 11:41:10 2001

Mo

du

le Scrip

t Co

mm

and

s

A-15

3D Post Processor Script Commands(continued)

PostProcessor3D FieldCalculator

ArrowPlotOptionsCalcVisToggleCancelPlineCascadeAllCascadeProjectsCascadeViewsCHelpCloseProjectCloseWindowDeleteGeometryDeletePlotDisablePlineStitchEditBoundDisplayEditFunctionsEditPlineEnablePlineStitchExitFormatPlotAxesFormatPlotGraphsGeneralPlotOptionsLinePlotOptionsListPlotsProjectListPlotsViewMarkerPlotOptionsModifyPlotModifyVariablesNewWindowOpenProjectPanelPlotDeletePanelPlotVisibilitySaveDefinitionsShowCalcShowPlotCoordinatesShowSolutionInfoTileAllGridTileProjectsGridTileViewsGridTogglePlotVisibility

* (Multiply)+ (Add)– (Subtract)/ (Divide)1/AbsAddFaceAtPosAddFaceWithIdAddObjectToListAnimationAddFrameAnimationDeleteFrameAnimationMoveFrameAnimationPlayAnimationPlotAnimationSaveFramesAnimationSavePlotAnimationSetDeltaValAnimationSetPlayTimeAnimationSetRefinementAnimationSetStartValAnimationSetStopValAnimationSetStoreFrameAnimationSetVarNameAnimationShowFrameArcCreateAtPhaseBHPlotBuildPlotInfoClearCmplxICmplxMagCmplxRConjCreateAnimationCreateFacesListCreateBHPlotCreatePlotCrossCurlCutPlaneCreateCutPlaneModifyD/DxD/DyD/DzDefineCutPlaneDefineExternalFaceDefineFacesList

DefineFunctionDefineObjectListDefinePointDeleteLineDeletePlotDeletePointDeleteSurfaceDeleteVolumeDeltaModifyCut-PlaneDeltaModifyPointDivgDomainDotDrawDrawLineDrawSurfaceDrawVolumeEnterEnterComplexEnterComplexVectorEnterFrequencyEnterLineEnterPointEnterScalarEnterScalarFunctionEnterSurfaceEnterVectorEnterVectorFunctionEnterVolumeEvaluateExchangeExportToFileExportToVolume-GridFacesListModifyFunctionValueGetTopEntryValueGradImagIntegrateIsoSurfaceLineCreateLineModifyLinePlotLinePlot2DLineRecalculate

LnLoad2DPlotLoadPlotLockCutPlaneNormalLockCutPlaneOriginLockVolumeLogMagMaterialMathFuncMaximumMaxPosMinimumMinPosModelMaxModelMinModifyCutPlaneModifyPlotModifyPointNegNormalNormalComponentObjectListCreateObjectListModifyOrphanPlotsPhasePlotPlotMeshPlotModifyFunctionPointCreatePointModifyPointValuePlotPopPowPushReadSolutionsRealRemoveFaceAtPosRemoveFaceWithIdRemoveObjectFromListRenameEntryRenameLineRenamePlotRenamePointRenameSurfaceRenameVolumeRollDn

RollUpSave2DPlotSavePlotScalarXScalarYScalarZSetArrowSetColormapSetFilledSetGridSpacingSetHiddenLineSetLineSetMarkerSetMeshExternalSetMeshScaleSetNumPointsSetPlotAttributesSetRefinementSetScaleSetTextMarkerSetTransparencyShowColorKeySmoothSolutionNameSqrtStoreComputationsSurfacePlotTangentTangentComponentTopUndoUpdatePlotsValueVecXVecYVecZVolumeBoxCreateVolumePlotWriteSolutions

macro.bk : commands.fm 16 Mon Jan 15 11:41:10 2001

Module Script Commnads

A-16

macro.bk : macro.ix 1 Mon Jan 15 11:41:10 2001

Index-1

Index

- (Subtract) 10-17

Symbols* (Multiply) 10-17+ (Add) 10-17/ (Divide) 10-17

Numerics1/ 10-173D Modeler macro example 2-2

AAbortTimeout 4-6Abs 10-17ActivateView nn 4-6ADD expression 1-11AddFaceAtPos 10-17AddFaceWithId 10-18AddHelpSelBoxItem 11-5AddMenuItem 11-5AddMenuSeparator 11-6AddObjectGroup 5-4AddObjectToList 10-18AddWizardSelbox 11-10

AddWizardSelboxItems 11-10AnimationAddFrame 10-18AnimationDeleteFrame 10-18AnimationMoveFrame 10-19AnimationPlay 10-19AnimationPlot 10-19AnimationSaveFrames 10-19AnimationSavePlot 10-20AnimationSetDeltaVal 10-20AnimationSetPlayTime 10-20AnimationSetRefinement 10-20AnimationSetStartVal 10-21AnimationSetStopVal 10-21AnimationSetStoreFrame 10-21AnimationSetVarName 10-21AnimationShowFrame 10-21Ansoft Macro Editor 1-12ArcCreate 10-22ArrowPlotOptions 10-2Assign 3-2AssignBoundary 8-2AutoGrid 4-18

BBHPlot 10-22Boundary module Command Set

AssignBoundary 8-2


Index-2

DefineBndFuncs 8-2, 11-8, 11-9, 11-10, 11-11, 11-12, 11-13, 11-14, 11-15, 11-16

ExitBnds 8-2SaveBndss 8-2SelectByName 8-2SelectFacesIntersection 8-2SetDefaultUnits 8-2SetEddyEffect 8-3ShowConductionPaths 8-3ToggleViewBndVis 8-3VerifyCondPaths 8-3

BoundaryKernel Command SetBoundaryModifyFunction 8-4BuildCondPaths 8-4CheckTerminals 8-4ClearAllBnds 8-4ClearCurrDenTerms 8-5ClearSelBoundary 8-5ClearSelection 8-5CreateTerminals 8-5PickFaceById 8-5PickFaceByRay 8-5PlotModifyFunction 10-38ReprioritizeSelBoundary 8-6SelectObjByName 8-6SelectObjFaces 8-6SetAllBndUnitsToCurrent 8-6SetBndName 8-6SetBndUnitsToCurrent 8-6SetBoolean 8-7SetBoundary 8-7SetEndpoint 8-7SetMSRelation 8-8SetOrigin 8-8SetScalar 8-8SetScalarFor 8-8SetStartPoint 8-9SetStringFor 8-9SetUpoint 8-9SetVector 8-9SetVpoint 8-10SwapBoolean 8-10SwapStrandedBoolean 8-10ToggleDispCurrent 8-10

ToggleEddyEffect 8-10TogglePickBndByName 8-10TogglePickBndByRay 8-11TogglePickObjByName 8-11TogglePickObjByRay 8-11TogglePickObjObjInt 8-11UndoClear 8-11UseSuggestedEddyEffectVals 8-11

BoundaryModifyFunction 8-4Box 6-2BuildCondPaths 8-4BuildPlotInfo 10-22

CCacsadeAll 10-2CalcVisToggle 10-2CancelPline 10-4CascadeAll 4-2CascadeProjects 4-2, 10-2CascadeViews 4-2, 10-2CheckOverlap 4-6CHelp 10-2Circle 6-2Clear 10-22ClearAll 3-2ClearAllBnds 8-4ClearCurrDenTerms 8-5ClearFunctions 3-2ClearSelBoundary 8-5ClearSelection 8-5ClearVars 3-3Close3d 6-2CloseProject 9-2, 10-3CloseWindow 4-2, 10-3CmplxI 10-23CmplxMag 10-23CmplxR 10-23ColorFaces 6-2ColorSel 6-2command sets 1-4ComplexFormat 3-3Component 3-3ComponentCount 3-3


Index-3

conditionals 1-10EQ 1-10GE 1-10GT 1-10LE 1-10LT 1-10NE 1-10

Conj 10-23Connect 6-3CoverOutl 6-3CoverSheets 6-3CreateAnimation 10-23CreateArc 6-3CreateBHPlot 10-23CreateFacesList 10-23CreatePlot 10-24CreateTerminals 8-5Cross 10-24Curl 10-24CutPlaneCreate 10-24CutPlaneModify 10-24Cyl 6-4

DD/Dx 10-24D/Dy 10-24D/Dz 10-24DatabaseAddRow 3-4DatabaseGetColumns 3-4DatabaseGetField 3-4DatabaseGetRows 3-5DatabaseSetField 3-5DebugFileExec 11-6Default Command Set

Assign 3-2ClearAll 3-2ClearFunctions 3-2ClearVars 3-3ComplexFormat 3-3Component 3-3ComponentCount 3-3DatabaseAddRow 3-4DatabaseGetColumns 3-4

DatabaseGetField 3-4DatabaseGetRows 3-5DatabaseSetField 3-5DeleteDatabase 3-5Div 3-5DoubleListSetComponent 3-6DumpDatabase 3-6Echo 3-6Error 3-7ExportDatabase 3-7FileExec 3-8FileExecErrExitIf 3-8FileExecPause 3-8FileExists 3-8FileOpen 3-8FileRead 3-9FileRecord 3-10FileRecordAppend 3-10FileRecStop 3-11FileWrite 3-11FuncDef 3-11FuncHelp 3-11FuncSave 3-12FuncUndef 3-12GE 3-12GetDateAndTime 3-12GetFileList 3-12GetFileName 3-13GetMacroPath 3-13GetMacroPathList 3-13GetProductId 3-13GetUserOption 3-13GetVersion 3-13Global 3-14GlobalAssign 3-14GT 3-14Help 3-14ImportDatabase 3-14ImportRawDatabase 3-15IsCommandEnabled 3-15LE 3-15Log10 3-15LT 3-15Minus 3-16


Index-4

Mul 3-16NE 3-16NewDatabase 3-16OR 3-17ParametricFileExec 3-17Pos2 3-18Pos3 3-18Pos3Dist 3-18PrependMacroPath 3-18PrintHelp 3-18PrivateAssign 3-18ProtectedAssign 3-19RandomFraction 3-19RemoveMacroPath 3-19SetEchoEnabled 3-19SetMacroPathList 3-19SetRecordingEnabled 3-19SetUnitsOfQuant 3-19Sleep 3-20StrConcat 3-20String 3-21StringListSetComponent 3-21Strlen 3-21Strstr 3-21Sub 3-21Substring 3-22Unassign 3-22Vec2 3-22Vec3 3-22XOR 3-22

DefColor 6-4DefColor? 6-4DefineBndFuncs 8-2, 11-8, 11-9, 11-10, 11-11,

11-12, 11-13, 11-14, 11-15, 11-16DefineCutPlane 10-25DefineExternalFace 10-25DefineFacesList 10-25DefineFunction 10-25DefineObjectList 10-25DefinePoint 10-25Delete 6-4DeleteAllSeed 9-2DeleteAllSeedNonInteractively 9-2DeleteCS 4-6

DeleteDatabase 3-5DeleteGeometry 10-3DeleteHelpSelboxItem 11-6DeleteLine 10-26DeleteMenuItem 11-6DeleteMesh 9-2DeleteObjectGroup 5-4DeletePlot 10-3, 10-26DeletePoint 10-26DeleteSurface 10-26DeleteVolume 10-26DelSelFaces 9-2DeltaModifyCutPlane 10-26DeltaModifyPoint 10-27DeSelBodies 9-2DeSelect 4-6, 6-4DetachFaces 6-5DisableMenuItem 11-7DisablePlineStitch 6-5, 10-3DispShaded 4-7DispWire 4-7Div 3-5DIV expression 1-11Divg 10-27Domain 10-27DoModelAnalysis 9-2Dot 10-27DoubleListSetComponent 3-6Draw 10-27DrawLine 10-27DrawSurface 10-28DrawVolume 10-28DumpDatabase 3-6DupAxis 6-5DupLine 6-5DupMirror 6-5

EEcho 3-6EditBHCurve 7-2EditBoundDisplay 10-3EditFunctions 10-3EditPline 6-6, 10-4


Index-5

EditPline - AddVert 6-6, 10-4EditPline - AddVert3D 6-6, 10-4EditPline - Arc 10-4EditPline - CancelPline 6-6EditPline - Closepline 6-6, 10-5EditPline - DelEdge 6-7, 10-5EditPline - DelVert 6-7, 10-5EditPline - EdgeGeom 6-7, 10-5EditPline - EdgeMode 6-7, 10-5EditPline - EndPline 6-7, 10-6EditPline - EndTangent 6-8, 10-6EditPline - FindPlineVertNo 6-8, 10-6EditPline - GetPlineVert 6-8, 10-6EditPline - Insvert 6-8, 10-6EditPline - JoinSplines 6-8, 10-7EditPline - MoveArcMidPt 6-9, 10-7EditPline - MoveVert 6-9, 10-7EditPline - OpenPline 6-9, 10-7EditPline - RenameCurPline 10-7EditPline - SetArcAngle 6-9, 10-7EditPline - SetArcRadius 6-9, 10-8EditPline - SetArcToFillet 6-10, 10-8EditPline - SplitSpline 6-10, 10-8EditPline - StartTangent 6-10, 10-8EnablePlineStitch 6-10, 10-8Enter 10-28EnterComplex 10-28EnterComplexVector 10-28EnterFrequency 10-28EnterLine 10-28EnterPoint 10-29EnterScalar 10-29EnterScalarFunction 10-29EnterSurface 10-29EnterVector 10-29EnterVectorFunction 10-29EnterVolume 10-29EQ conditional 1-10Error 3-7Evaluate 10-30examples, 3D Modeler macro 2-2Exchange 10-30ExcludeObject 5-4executing a macro 1-3

Executive Parameters Command SetAddObjectGroup 5-4DeleteObjectGroup 5-4ExcludeObject 5-4IncludeObject 5-4SetCurrentObjectGroup 5-4SetCurrentSetupType 5-5SetTorqueAxisAnchorPoint 5-5SetTorqueAxisEndPoint 5-5

Exit 6-10, 9-3, 10-9ExitBnds 8-2ExpAssign 6-11ExpClear 6-11ExpDel 6-11ExpEval 6-11ExpInc 6-11ExpLoad 6-12ExportDatabase 3-7ExportToFile 10-30ExportToVolumeGrid 10-30expressions

ADD 1-11DIV 1-11MINUS 1-11MUL 1-11SUB 1-11

ExpSave 6-12

FFacesListModify 10-30FieldCalculator Command Set

- (Subtract) 10-17* (Multiply) 10-17+ (Add) 10-17/ (Divide) 10-171/ 10-17Abs 10-17AddFaceAtPos 10-17AddFaceWithId 10-18AddObjectToList 10-18AnimationAddFrame 10-18AnimationDeleteFrame 10-18AnimationMoveFrame 10-19


Index-6

AnimationPlay 10-19AnimationPlot 10-19AnimationSaveFrames 10-19AnimationSavePlot 10-20AnimationSetDeltaVal 10-20AnimationSetPlayTime 10-20AnimationSetRefinement 10-20AnimationSetStartVal 10-21AnimationSetStopVal 10-21AnimationSetStoreFrame 10-21AnimationSetVarName 10-21AnimationShowFrame 10-21ArcCreate 10-22BHPlot 10-22BuildPlotInfo 10-22Clear 10-22CmplxI 10-23CmplxMag 10-23CmplxR 10-23Conj 10-23CreateAnimation 10-23CreateBHPlot 10-23CreateFacesList 10-23CreatePlot 10-24Cross 10-24Curl 10-24CutPlaneCreate 10-24CutPlaneModify 10-24D/Dx 10-24D/Dy 10-24D/Dz 10-24DefineCutPlane 10-25DefineExternalFace 10-25DefineFacesList 10-25DefineFunction 10-25DefineObjectList 10-25DefinePoint 10-25DeleteLine 10-26DeletePlot 10-26DeletePoint 10-26DeleteSurface 10-26DeleteVolume 10-26DeltaModifyCutPlane 10-26DeltaModifyPoint 10-27

Divg 10-27Domain 10-27Dot 10-27Draw 10-27DrawLine 10-27DrawSurface 10-28DrawVolume 10-28Enter 10-28EnterComplex 10-28EnterComplexVector 10-28EnterFrequency 10-28EnterLine 10-28EnterPoint 10-29EnterScalar 10-29EnterScalarFunction 10-29EnterSurface 10-29EnterVector 10-29EnterVectorFunction 10-29EnterVolume 10-29Evaluate 10-30Exchange 10-30ExportToFile 10-30ExportToVolumeGrid 10-30FacesListModify 10-30FunctionValue 10-31GetTopEntryValue 10-31Grad 10-31Imag 10-31Integrate 10-31IsoSurface 10-31LineCreate 10-31LineModify 10-32LinePlot 10-32LinePlot2D 10-33LineRecalculate 10-34Ln 10-34Load2DPlot 10-34LoadPlot 10-34LockCutPlaneNormal 10-34LockCutPlaneOrigin 10-34LockVolume 10-34Log 10-35Mag 10-35Material 10-35


Index-7

MathFunc 10-35Maximum 10-36MaxPos 10-36Minimum 10-36MinPos 10-36ModelMax 10-36ModelMin 10-36ModifyCutPlane 10-37ModifyPlot 10-37ModifyPoint 10-37Neg 10-37Normal 10-37NormalComponent 10-37ObjectListCreate 10-38ObjectListModify 10-38OrphanPlots 10-38Phase 10-38Plot 10-38PlotMesh 10-38PointCreate 10-39PointModify 10-39PointValuePlot 10-39Pop 10-39Pow 10-39Push 10-39ReadSolutions 10-39Real 10-39RemoveFaceAtPos 10-40RemoveFaceWithId 10-40RemoveObjectFromList 10-40RenameEntry 10-40RenameLine 10-40RenamePlot 10-40RenamePoint 10-41RenameSurface 10-41RenameVolume 10-41RollDn 10-41RollUp 10-41Save2DPlot 10-41SavePlot 10-41ScalarX 10-42ScalarY 10-42ScalarZ 10-42SetArrow 10-42

SetColormap 10-42SetFilled 10-43SetGridSpacing 10-43SetHiddenLine 10-43SetLine 10-44SetMarker 10-44SetMeshExternal 10-45SetMeshScale 10-45SetNumPoints 10-45SetPlotAttributes 10-45SetRefinement 10-45SetScale 10-46SetTextMarker 10-46SetTransparency 10-46ShowColorKey 10-46Smooth 10-46SolutionName 10-46Sqrt 10-47StoreComputations 10-47SurfacePlot 10-47Tangent 10-47TangentComponent 10-47Top 10-47Undo 10-47UpdatePlots 10-48Value 10-48VecX 10-48VecY 10-48VecZ 10-48VolumeBoxCreate 10-48VolumePlot 10-48WriteSolutions 10-49

FileExec 3-8FileExecErrExitIf 3-8FileExecPause 3-8FileExists 3-8FileOpen 3-8FileRead 3-9FileRecord 3-10FileRecordAppend 3-10FileRecStop 3-11FileWrite 3-11FitAll 4-18FitAllViews 4-18


Index-8

FitRegion 6-12FitSel 4-18, 6-12FlushEvents 4-7FormatPlotAxes 10-9FormatPlotGraphs 10-9FuncDef 3-11FuncHelp 3-11FuncSave 3-12FunctionValue 10-31FuncUndef 3-12FurtherImproveQuality 9-3

GGE 3-12GE conditional 1-10GeneralPlotOptions 10-9Generic Module Command Set

CascadeAll 4-2CascadeProjects 4-2CascadeViews 4-2CloseWindow 4-2ModuleIsPromptVisible 4-2ModulePrefsRevert 4-2ModuleSavePrefs 4-2ModuleSidewinLeft 4-3ModuleSidewinRight 4-3ModuleToggleMessage 4-3ModuleTogglePrompt 4-3ModuleToolbar(direction) 4-3ModuleToolbarHide 4-3NewWindow 4-3PrintEntire 4-3PrintProj 4-4PrintRect 4-4PrintSubwin 4-4PrintView 4-4TileAllGrid 4-4TileAllHrz 4-4TileAllVrt 4-4TileProjectsGrid 4-4TileProjectsHrz 4-5TileProjectsVrt 4-5TileViewsGrid 4-5

TileViewsHrz 4-5TileViewsVrt 4-5

GetCurPos 4-7GetCurrSolnFileset 5-2GetDateAndTime 3-12GetDouble “Prompt” 4-7GetFileList 3-12GetFileName 3-13GetForceOnGround 5-2GetLastSolveInfo 5-2GetLong “Prompt” 4-8GetLorentzForceOnObject 5-3GetMacroPath 3-13GetMacroPathList 3-13GetMatrixCellValue 5-3GetNumObjects 4-8GetNumVIews 4-8GetObjectName 4-8GetOrigin 4-8GetPosition “Prompt” 4-9GetProductId 3-13GetSelectedMaterial 7-2GetString “Prompt” 4-9GetTopEntryValue 10-31GetTorqueOnGroup 5-3GetUnitConv 4-9GetUnitName 4-9GetUserOption 3-13GetVector “Prompt” 4-10GetVersion 3-13GetWizardRunResult 11-12GetWizardSelboxIndex 11-12GExit 9-3Global 3-14GlobalAssign 3-14GlobalCS 4-10Grad 10-31Graph3dSetColor 10-13Graph3dSetFilled 10-13Graph3dSetLine 10-13Graph3dSetOutline 10-13Graph3dSetRefinement 10-13Graph3dSetShade 10-14Graph3dSetToneShaded 10-14


Index-9

Graph3dUpdateGraph 10-14GT 3-14GT conditional 1-10GWriteMesh 9-3

HHealAllObjects 6-12Helix 6-13Help 3-14HiddenLineOff 9-3HiddenLineOn 9-3HiddenLineOnOff 9-3Hide 4-10HideAll 9-3HideMesh 9-4HideOrient 4-10HideRegion 4-10, 6-13HideSel 4-10

IIF statement 1-8Imag 10-31Import3D 6-13ImportDatabase 3-14ImportRawDatabase 3-15ImproveQuality 9-4ImproveSurfTri 9-4IncludeObject 5-4Installing Maxwell software iiiIntegrate 10-31InteractiveDeleteMesh 9-4InteractiveMakeInitMesh 9-4Intersect 6-13IsCommandEnabled 3-15IsoSurface 10-31IsWizardControlChecked 11-12

LLaunchBoundaries 5-3LaunchScaleDialog 6-13LE 3-15

LE conditional 1-10LineCreate 10-31LineModify 10-32LinePlot 10-32LinePlot2D 10-33LinePlotOptions 10-9LineRecalculate 10-34List 4-11ListPlotsProject 10-9ListPlotsView 10-9Ln 10-34Load2DPlot 10-34LoadCartesian3DPlot 10-10LoadPlot 10-34LocalCS 4-11LockCutPlaneNormal 10-34LockCutPlaneOrigin 10-34LockVolume 10-34Log 10-35Log10 3-15Lookat 4-18Lorigin 4-11LT 3-15LT conditional 1-10

MM3DFS Command Set

GetCurrSolnFileset 5-2GetForceOnGround 5-2GetLastSolveInfo 5-2GetLorentzForceOnObject 5-3GetMatrixCellValue 5-3GetTorqueOnGroup 5-3LaunchBoundaries 5-3ProjDir 5-3ProjName 5-3

macro editordefining macros 1-12tool bar 1-13

macro editor commands 1-13MacroDebugger 11-7macros 1-2

3D Modeler example 2-2


Index-10

command prompt hotkey 1-2executing a macro 1-3executing from the command line 1-3executing from the command prompt 1-3executing with a hotkey 1-3recording a macro 1-2

Mag 10-35MakeInitialMesh 9-4MarkerPlotOptions 10-10Material 10-35MaterialAccept 7-2MaterialAdd 7-2MaterialAssign 7-3MaterialClear 7-3MaterialDerive 7-4MaterialKernel Command Set

GetSelectedMaterial 7-2MaterialAccept 7-2MaterialAdd 7-2MaterialAssign 7-3MaterialClear 7-3MaterialDerive 7-4MaterialModifyFunction 7-4MaterialRevert 7-4MaterialSelect 7-4MaterialSetProperty 7-5MaterialSetType 7-5MaterialUnderive 7-6SaveMaterialDatabase 7-6

MaterialModifyFunction 7-4MaterialRevert 7-4Materials Command Set, EditBHCurve 7-2MaterialSelect 7-4MaterialSetProperty 7-5MaterialSetType 7-5MaterialUnderive 7-6MathFunc 10-35Maximum 10-36MaxPos 10-36Maxwell 3D, installing iiiMesh3D Command Set

CloseProject 9-2DeleteAllSeed 9-2DeleteAllSeedNonInteractively 9-2

DeleteMesh 9-2DelSelFaces 9-2DeSelBodies 9-2DoModelAnalysis 9-2Exit 9-3FurtherImproveQuality 9-3GExit 9-3GWriteMesh 9-3HiddenLineOff 9-3HiddenLineOn 9-3HiddenLineOnOff 9-3HideAll 9-3HideMesh 9-4ImproveQuality 9-4ImproveSurfTri 9-4InteractiveDeleteMesh 9-4InteractiveMakeInitMesh 9-4MakeInitialMesh 9-4MeshDisplayMode 9-5MeshInfo 9-5ModelAlone 9-5NewProject 9-5NonInteractiveDeleteMesh 9-5OpenProject 9-5PullPointsToTrueSurfaces 9-5RefeshView 9-5SaveSeed 9-6SaveWindow 9-6SeedingInfo 9-6SeedRefineCommandToKernel 9-7SelectOneFace 9-8SelFaces 9-8SetBoxScope 9-8SetDisplayOn 9-8SetFaceterRefinements 9-9SetMeshDisplayMode 9-9SetTriScope 9-9SetViewKindWireFrame 9-9ShadedMesh 9-9ShowHideMesh 9-10ShowMesh 9-10ShowPoints 9-10ShowSurfTri 9-10ShowTets 9-10


Index-11

SmoothenMesh 9-10WriteMesh 9-10WriteMeshAs 9-10

MeshDisplayMode 9-5MeshInfo 9-5Minimum 10-36MinPos 10-36Minus 3-16MINUS expression 1-11Mirror 6-14Mod3proj Command Set

AbortTimeout 4-6ActivateView nn 4-6CheckOverlap 4-6DeleteCS 4-6DeSelect 4-6DispShaded 4-7DispWire 4-7FlushEvents 4-7GetCurPos 4-7GetDouble “Prompt” 4-7GetLong “Prompt” 4-8GetNumObjects 4-8GetNumVIews 4-8GetObjectName 4-8GetOrigin 4-8GetPosition “Prompt” 4-9GetString “Prompt” 4-9GetUnitConv 4-9GetUnitName 4-9GetVector “Prompt” 4-10GlobalCS 4-10Hide 4-10HideOrient 4-10HideRegion 4-10HideSel 4-10List 4-11LocalCS 4-11Lorigin 4-11ObjectCS 4-11ObjectExists 4-11Origin 4-12Origin? 4-12PrintProj 4-12

PrintView 4-12Recolor 4-12RestoreCS 4-12RotateCS 4-13RotatedCS 4-13SaveCmdWin 4-13SaveCS 4-13SaveWindow 4-14Select 4-14SelInBox 4-14SetCurPos 4-15SetObjectCS 4-15Show 4-15ShowAll 4-15ShowOrient 4-15ShowRegion 4-15ToggleRegion 4-16UnrotatedCS 4-16VerifyRegion 4-16VisByItem 4-16XAxisAboutTo 4-16XAxisTo 4-16XUnitVec? 4-17YAxisAboutTo 4-17YAxisTo 4-17YUnitVec? 4-17ZAxisAboutTo 4-17ZAxisTo 4-17ZUnitVec? 4-17

Mod3view Command SetAutoGrid 4-18FitAll 4-18FitAllViews 4-18FitSel 4-18Lookat 4-18Ortho 4-18Persp 4-19PolarGrid 4-19RectGrid 4-19ResetViews 4-19RotView 4-19Shaded 4-20Viewpoint 4-20Wireframe 4-20


Index-12

ModelAlone 9-5Modeler3 Command Set

Box 6-2Circle 6-2Close3d 6-2ColorFaces 6-2ColorSel 6-2Connect 6-3CoverOutl 6-3CoverSheets 6-3CreateArc 6-3Cyl 6-4DefColor 6-4DefColor? 6-4Delete 6-4DeSelect 6-4DetachFaces 6-5DisablePlineStitch 6-5DupAxis 6-5DupLine 6-5DupMirror 6-5EditPline 6-6EditPline - AddVert 6-6EditPline - AddVert3D 6-6EditPline - CancelPline 6-6EditPline - Closepline 6-6EditPline - DelEdge 6-7EditPline - DelVert 6-7EditPline - EdgeGeom 6-7EditPline - EdgeMode 6-7EditPline - EndPline 6-7EditPline - EndTangent 6-8EditPline - FindPlineVertNo 6-8EditPline - GetPlineVert 6-8EditPline - Insvert 6-8EditPline - JoinSplines 6-8EditPline - MoveArcMidPt 6-9EditPline - MoveVert 6-9EditPline - OpenPline 6-9EditPline - SetArcAngle 6-9EditPline - SetArcRadius 6-9EditPline - SetArcToFillet 6-10EditPline - SplitSpline 6-10EditPline - StartTangent 6-10

EnablePlineStitch 6-10Exit 6-10ExpAssign 6-11ExpClear 6-11ExpDel 6-11ExpEval 6-11ExpInc 6-11ExpLoad 6-12ExpSave 6-12FitRegion 6-12FitSel 6-12HealAllObjects 6-12Helix 6-13HideRegion 6-13Import3D 6-13Intersect 6-13LaunchScaleDialog 6-13Mirror 6-14ModelerModifyFunction 6-14Move 6-14New3d 6-14Point 6-14ProjPrefs 6-15Read2d 6-15Read3d 6-15Recolor 6-15Rectangle 6-16Redo 6-16Region 6-16Rename 6-16ResetViews 6-17Rotate 6-17Save2d 6-17Save3d 6-17SaveSAT 6-17SaveSLD 6-17Scale 6-18Section 6-18SelClear 6-18SelColor 6-18SelCopy 6-18SelCut 6-18SelPaste 6-19SetModel 6-19


Index-13

SetNonModel 6-19SetSldTol 6-19SetUnits 6-19ShowRegion 6-19Split 6-20Stitch 6-20Subtract 6-20SweepAxis 6-20SweepPath 6-21SweepTwist 6-21SweepVec 6-21Uncover 6-21Undel 6-21Undo 6-22Unite 6-22

ModelerModifyFunction 6-14ModelMax 10-36ModelMin 10-36ModifyCutPlane 10-37ModifyPlot 10-10, 10-37ModifyPoint 10-37ModifyVariables 10-11ModuleIsPromptVisible 4-2ModulePrefsRevert 4-2ModuleSavePrefs 4-2ModuleSidewinLeft 4-3ModuleSidewinRight 4-3ModuleToggleMessage 4-3ModuleTogglePrompt 4-3ModuleToolbar(direction) 4-3ModuleToolbarHide 4-3Move 6-14Mul 3-16MUL expression 1-11

NNE 3-16NE conditional 1-10Neg 10-37New3d 6-14NewDatabase 3-16NewProject 9-5NewWindow 4-3, 10-11

NonInteractiveDeleteMesh 9-5Normal 10-37NormalComponent 10-37

OObjectCS 4-11ObjectExists 4-11ObjectListCreate 10-38ObjectListModify 10-38OpenProject 9-5, 10-11OR 3-17Origin 4-12Origin? 4-12OrphanPlots 10-38Ortho 4-18

PPanelPlotDelete 10-11PanelPlotVisibility 10-11ParametricFileExec 3-17Persp 4-19Phase 10-38PickFaceById 8-5PickFaceByRay 8-5Plot 10-38Plot3D Command Set

Graph3dSetColor 10-13Graph3dSetFilled 10-13Graph3dSetLine 10-13Graph3dSetOutline 10-13Graph3dSetRefinement 10-13Graph3dSetShade 10-14Graph3dSetToneShaded 10-14Graph3dUpdateGraph 10-14Plot3dDrawAxes 10-14Plot3dDrawGrid 10-14Plot3dSetAxesLabelSize 10-14Plot3dSetColorMap 10-15Plot3dSetHeadExtrusion 10-15Plot3dSetHeading 10-15Plot3dSetHeadingColor 10-15Plot3dSetHeadingFont 10-15


Index-14

Plot3dSetHeadingSize 10-15Plot3dSetLighting 10-16Plot3dSetScale 10-16Plot3dShowColorKey 10-16Plot3dUpdatePlots 10-16

Plot3dDrawAxes 10-14Plot3dDrawGrid 10-14Plot3dSetAxesLabelSize 10-14Plot3dSetColorMap 10-15Plot3dSetHeadExtrusion 10-15Plot3dSetHeading 10-15Plot3dSetHeadingColor 10-15Plot3dSetHeadingFont 10-15Plot3dSetHeadingSize 10-15Plot3dSetLighting 10-16Plot3dSetScale 10-16Plot3dShowColorKey 10-16Plot3dUpdatePlots 10-16PlotMesh 10-38PlotModifyFunction 10-38Point 6-14PointCreate 10-39PointModify 10-39PointValuePlot 10-39PolarGrid 4-19Pop 10-39Pos2 3-18Pos3 3-18Pos3Dist 3-18PostProcessor3D Command Set

ArrowPlotOptions 10-2CacsadeAll 10-2CalcVisToggle 10-2CancelPline 10-4CascadeProjects 10-2CascadeViews 10-2CHelp 10-2CloseProject 10-3CloseWindow 10-3DeleteGeometry 10-3DeletePlot 10-3DisablePlineStitch 10-3EditBoundDisplay 10-3EditFunctions 10-3

EditPline 10-4EditPline - AddVert 10-4EditPline - AddVert3D 10-4EditPline - Arc 10-4EditPline - Closepline 10-5EditPline - DelEdge 10-5EditPline - DelVert 10-5EditPline - EdgeGeom 10-5EditPline - EdgeMode 10-5EditPline - EndPline 10-6EditPline - EndTangent 10-6EditPline - FindPlineVertNo 10-6EditPline - GetPlineVert 10-6EditPline - Insvert 10-6EditPline - JoinSplines 10-7EditPline - MoveArcMidPt 10-7EditPline - MoveVert 10-7EditPline - OpenPline 10-7EditPline - RenameCurPline 10-7EditPline - SetArcAngle 10-7EditPline - SetArcRadius 10-8EditPline - SetArcToFillet 10-8EditPline - SplitSpline 10-8EditPline - StartTangent 10-8EnablePlineStitch 10-8Exit 10-9FormatPlotAxes 10-9FormatPlotGraphs 10-9GeneralPlotOptions 10-9LinePlotOptions 10-9ListPlotsProject 10-9ListPlotsView 10-9LoadCartesian3DPlot 10-10MarkerPlotOptions 10-10ModifyPlot 10-10ModifyVariables 10-11NewWindow 10-11OpenProject 10-11PanelPlotDelete 10-11PanelPlotVisibility 10-11PostProcessorOptions 10-11SaveDefinitions 10-11ShowCalc 10-12ShowPlotCoordinates 10-12


Index-15

ShowSolutionInfo 10-12TileAllGrid 10-12TilePlotVisibility 10-12TileProjectsGrid 10-12TileViewsGrid 10-12

PostProcessorOptions 10-11Pow 10-39PrependMacroPath 3-18PrintEntire 4-3PrintHelp 3-18PrintProj 4-4, 4-12PrintRect 4-4PrintSubwin 4-4PrintView 4-4, 4-12PrivateAssign 3-18ProjDir 5-3ProjName 5-3ProjPrefs 6-15ProtectedAssign 3-19PullPointsToTrueSurfaces 9-5Push 10-39

RRandomFraction 3-19Read2d 6-15Read3d 6-15ReadSolutions 10-39Real 10-39Recolor 4-12, 6-15recording a macro 1-2Rectangle 6-16RectGrid 4-19Redo 6-16RefreshView 9-5Region 6-16RemoveFaceAtPos 10-40RemoveFaceWithId 10-40RemoveMacroPath 3-19RemoveObjectFromList 10-40Rename 6-16RenameEntry 10-40RenameLine 10-40RenamePlot 10-40

RenamePoint 10-41RenameSurface 10-41RenameVolume 10-41REPEAT statement 1-8ReprioritizeSelBoundary 8-6ResetViews 4-19, 6-17RestoreCS 4-12RollDn 10-41RollUp 10-41Rotate 6-17RotateCS 4-13RotatedCS 4-13RotView 4-19

SSave2d 6-17Save2DPlot 10-41Save3d 6-17SaveBnds 8-2SaveCmdWin 4-13SaveCS 4-13SaveDefinitions 10-11SaveMaterialDatabase 7-6SavePlot 10-41SaveSAT 6-17SaveSeed 9-6SaveSetup 5-6SaveSLD 6-17SaveWindow 4-14, 9-6ScalarX 10-42ScalarY 10-42ScalarZ 10-42Scale 6-18script commands 1-4

- (Subtract) 10-17* (Multiply) 10-17+ (Add) 10-17/ (Divide) 10-171/ 10-17AbortTimeout 4-6Abs 10-17ActivateView nn 4-6AddFaceAtPos 10-17


Index-16

AddFaceWithId 10-18AddObjectGroup 5-4AddObjectToList 10-18AnimationAddFrame 10-18AnimationDeleteFrame 10-18AnimationMoveFrame 10-19AnimationPlay 10-19AnimationPlot 10-19AnimationSetDeltaVal 10-20AnimationSetStartVal 10-21AnimationSetStopVal 10-21AnimationSetVarName 10-21AnimationShowFrame 10-21ArrowPlotOptions 10-2AssignBoundary 8-2AutoGrid 4-18BHPlot 10-22BoundaryModifyFunction 8-4Box 6-2BuildCondPaths 8-4BuildPlotInfo 10-22CacsadeAll 10-2CalcVisToggle 10-2CancelPline 10-4CascadeAll 4-2CascadeProjects 4-2, 10-2CascadeViews 4-2, 10-2CheckOverlap 4-6CheckTerminals 8-4CHelp 10-2ChowConductionPathst 8-3Circle 6-2Clear 10-22ClearAllBnds 8-4ClearCurrDenTerms 8-5ClearSelBoundary 8-5ClearSelection 8-5Close3d 6-2CloseProject 10-3CloseWindow 4-2CloseWindowt 10-3CmplxI 10-23CmplxMag 10-23CmplxR 10-23

ColorFaces 6-2ColorSel 6-2command sets 1-4Conj 10-23Connect 6-3CoverOutl 6-3CoverSheets 6-3CreateAnimation 10-23CreateArc 6-3CreateBHPlot 10-23CreatePlot 10-24CreateTerminals 8-5Cross 10-24Curl 10-24CutPlaneCreate 10-24CutPlaneModify 10-24Cyl 6-4D/Dx 10-24D/Dy 10-24D/Dz 10-24DefColor 6-4DefColor? 6-4DefineBndFuncs 8-2, 11-8, 11-9, 11-10, 11-

11, 11-12, 11-13, 11-14, 11-15, 11-16DefineCutPlane 10-25DefineExternalFace 10-25DefineFacesList 10-25DefineFunction 10-25DefineObjectList 10-25DefinePoint 10-25Delete 6-4DeleteCS 4-6DeleteGeometry 10-3DeleteLine 10-26DeleteObjectGroup 5-4DeletePlot 10-3, 10-26DeletePoint 10-26DeleteSurface 10-26DeleteVolume 10-26DeltaModifyCutPlane 10-26DeltaModifyPoint 10-27DeSelect 4-6DetachFaces 6-5DisablePlineStitch 6-5, 10-3


Index-17

DispShaded 4-7DispWire 4-7Divg 10-27Domain 10-27Dot 10-27Draw 10-27DrawLine 10-27DrawSurface 10-28DrawVolume 10-28DupAxis 6-5DupLine 6-5DupMirror 6-5EditBHCurve 7-2EditBoundDisplay 10-3EditFunctions 10-3EditPline 6-6, 10-4EditPline - AddVert 6-6, 10-4EditPline - AddVert3D 6-6, 10-4EditPline - Arc 10-4EditPline - Closepline 6-6, 10-5EditPline - DelEdge 6-7, 10-5EditPline - DelVert 6-7, 10-5EditPline - EdgeGeom 6-7, 10-5EditPline - EdgeMode 6-7, 10-5EditPline - EndPline 6-7, 10-6EditPline - EndTangent 6-8, 10-6EditPline - FindPlineVertNo 6-8, 10-6EditPline - GetPlineVert 6-8, 10-6EditPline - Insvert 6-8, 10-6EditPline - JoinSplines 6-8, 10-7EditPline - MoveArcMidPt 6-9, 10-7EditPline - MoveVert 6-9, 10-7EditPline - OpenPline 6-9, 10-7EditPline - SetArcAngle 6-9, 10-7EditPline - SetArcRadius 6-9, 10-8EditPline - SetArcToFillet 6-10, 10-8EditPline - SplitSpline 6-10, 10-8EditPline - StartTangent 6-10, 10-8EditPline -CancelPline 6-6EnablePlineStitch 6-10, 10-8Enter 10-28EnterComplex 10-28EnterComplexVector 10-28EnterFrequency 10-28

entering from the command prompt 1-5EnterLine 10-28EnterPoint 10-29EnterScalar 10-29EnterScalarFunction 10-29EnterSurface 10-29EnterVector 10-29EnterVectorFunction 10-29EnterVolume 10-29Evaluate 10-30Exchange 10-30ExcludeObject 5-4Exit 6-10, 10-9ExitBnds 8-2ExpAssign 6-11ExpClear 6-11ExpDel 6-11ExpEval 6-11ExpInc 6-11ExpLoad 6-12ExportToFile 10-30ExportToVolumeGrid 10-30ExpSave 6-12FacesListModify 10-30FitAll 4-18FitAllViews 4-18FitRegion 6-12FitSel 4-18FlushEvents 4-7FormatPlotAxes 10-9FormatPlotGraphs 10-9FunctionValue 10-31GeneralPlotOptions 10-9GetCurPos 4-7GetCurrSolnFileset 5-2GetDouble “Prompt” 4-7GetForceOnGround 5-2GetLastSolveInfo 5-2GetLong “Prompt” 4-8GetLorentzForceOnObject 5-3GetMatrixCellValue 5-3GetNumObjects 4-8GetNumVIews 4-8GetObjectName 4-8


Index-18

GetOrigin 4-8GetPosition “Prompt” 4-9GetSelectedMaterial 7-2GetTopEntryValue 10-31GetTorqueOnGroup 5-3GetVector “Prompt” 4-10GlobalCS 4-10Grad 10-31Graph3dSetColor 10-13Graph3dSetFilled 10-13Graph3dSetLine 10-13Graph3dSetRefinement 10-13Graph3dSetShade 10-14Graph3dUpdateGraph 10-14Helix 6-13Hide 4-10HideOrient 4-10HideRegion 4-10HideSel 4-10Imag 10-31Import3D 6-13IncludeObject 5-4Integrate 10-31Intersect 6-13IsoSurface 10-31LaunchBoundaries 5-3layout 1-6LineCreate 10-31LineModify 10-32LinePlot 10-32LinePlot2D 10-33LinePlotOptions 10-9LineRecalculate 10-34List 4-11ListPlotsProject 10-9ListPlotsView 10-9Load2DPlot 10-34LoadPlot 10-34LocalCS 4-11LockCutPlaneNormal 10-34LockCutPlaneOrigin 10-34LockVolume 10-34Lookat 4-18Lorigin 4-11

Mag 10-35MarkerPlotOptions 10-10Material 10-35MaterialAccept 7-2MaterialAdd 7-2MaterialAssign 7-3MaterialClear 7-3MaterialDerive 7-4MaterialModifyFunction 7-4MaterialRevert 7-4MaterialSelect 7-4MaterialSetProperty 7-5MaterialSetType 7-5MaterialUnderive 7-6MathFunc 10-35Maximum 10-36MaxPos 10-36Minimum 10-36MinPos 10-36Mirror 6-14ModelerModifyFunction 6-14ModelMax 10-36ModelMin 10-36ModifyCutPlane 10-37ModifyPlot 10-10, 10-37ModifyPoint 10-37ModifyVariables 10-11ModuleIsPromptVisible 4-2ModulePrefsRevert 4-2ModuleSavePrefs 4-2ModuleSidewinLeft 4-3ModuleSidewinRight 4-3ModuleToggleMessage 4-3ModuleTogglePrompt 4-3ModuleToolbar(direction) 4-3ModuleToolbarHide 4-3Move 6-14Neg 10-37New3d 6-14NewWindow 4-3, 10-11Normal 10-37NormalComponent 10-37ObjectCS 4-11ObjectExists 4-11


Index-19

ObjectListCreate 10-38ObjectListModify 10-38OpenProject 10-11Origin 4-12Origin? 4-12OrphanPlots 10-38Ortho 4-18PanelPlotDelete 10-11PanelPlotVisibility 10-11Persp 4-19Phase 10-38PickFaceById 8-5PickFaceByRay 8-5Plot 10-38Plot3dDrawAxes 10-14Plot3dDrawGrid 10-14Plot3dSetAxesLabelSize 10-14Plot3dSetColorMap 10-15Plot3dSetHeadExtrusion 10-15Plot3dSetHeading 10-15Plot3dSetHeadingColor 10-15Plot3dSetHeadingFont 10-15Plot3dSetHeadingSize 10-15Plot3dSetLighting 10-16Plot3dSetScale 10-16Plot3dShowColorKey 10-16Plot3dUpdatePlots 10-16PlotMesh 10-38PlotModifyFunction 10-38Point 6-14PointCreate 10-39PointModify 10-39PointValuePlot 10-39PolarGrid 4-19Pop 10-39Pow 10-39PrintEntire 4-3PrintProj 4-4, 4-12PrintRect 4-4PrintSubwin 4-4PrintView 4-4, 4-12ProjDir 5-3ProjName 5-3ProjPrefs 6-15

Push 10-39Read2d 6-15Read3d 6-15ReadSolutions 10-39Real 10-39Recolor 4-12, 6-15Rectangle 6-16RectGrid 4-19Redo 6-16Region 6-16RemoveFaceAtPos 10-40RemoveFaceWithId 10-40RemoveObjectFromList 10-40Rename 6-16RenameEntry 10-40RenameLine 10-40RenamePlot 10-40RenamePoint 10-41RenameSurface 10-41RenameVolume 10-41ReprioritizeSelBoundary 8-6ResetViews 4-19RestoreCS 4-12RollDn 10-41RollUp 10-41Rotate 6-17RotateCS 4-13RotatedCS 4-13RotView 4-19Save2d 6-17Save2DPlot 10-41Save3d 6-17SaveBnds 8-2SaveCmdWin 4-13SaveCS 4-13SaveDefinitions 10-11SaveMaterialDatabase 7-6SavePlot 10-41SaveSAT 6-17SaveSetup 5-6SaveSLD 6-17SaveWindow 4-14ScalarX 10-42ScalarY 10-42


Index-20

ScalarZ 10-42Scale 6-18Section 6-18SelClear 6-18SelColor 6-18SelCopy 6-18SelCut 6-18Select 4-14SelectByName 8-2SelectFacesIntersection 8-2SelectObjByName 8-6SelectObjFaces 8-6SelInBox 4-14SelPaste 6-19SetAdaptiveInfo 5-6SetAllBndUnitsToCurrent 8-6SetArrow 10-42SetBndName 8-6SetBndUnitsToCurrent 8-6SetBoolean 8-7SetBoundary 8-7SetColormap 10-42SetCondResidual 5-6SetCondSAdaptiveInfo 5-7SetCondSolutionType 5-7SetCurPos 4-15SetCurrentObjectGroup 5-4SetCurrentSetupType 5-5SetCurrentSolnPrmsType 5-7SetDefaultUnits 8-2SetEddyEffect 8-3SetEndpoint 8-7SetFilled 10-43SetFrequency 5-7SetGridSpacing 10-43SetHiddenLine 10-43SetLine 10-44SetMarker 10-44SetMeshExternal 10-45SetMeshScale 10-45SetMeshType 5-8SetModel 6-19SetMSRelation 8-8SetNonLinResidual 5-8

SetNonModel 6-19SetNop 5-8SetNumPoints 10-45SetObjectCS 4-15SetOrigin 8-8SetPlotAttributes 10-45SetRefinement 10-45SetResiduall 5-8SetScalar 8-8SetScalarFor 8-8SetScale 10-46SetSldTol 6-19SetSolveFields 5-9SetSolvePrms 5-9SetSolver 5-9SetSolveType 5-9SetStartPoint 8-9SetStringFor 8-9SetTextMarker 10-46SetTorqueAxisAnchorPoint 5-5SetTorqueAxisEndPoint 5-5SetTransparency 10-46SetUnits 6-19SetUpoint 8-9SetVector 8-9SetVpoint 8-10Shaded 4-20Show 4-15ShowAll 4-15ShowCalc 10-12ShowColorKey 10-46ShowOrient 4-15ShowPlotCoordinates 10-12ShowRegion 4-15ShowSolutionInfo 10-12Smooth 10-46SolnPrmsDone 5-10SolutionName 10-46Split 6-20Sqrt 10-47Stitch 6-20StoreComputations 10-47Subtract 6-20SurfacePlot 10-47


Index-21

SwapBoolean 8-10SwapStrandedBoolean 8-10SweepAxis 6-20SweepPath 6-21SweepTwist 6-21SweepVec 6-21syntax conventions 1-6Tangent 10-47TangentComponent 10-47TileAllGrid 4-4, 10-12TileAllHrz 4-4TileAllVrt 4-4TilePlotVisibility 10-12TileProjectsGrid 4-4, 10-12TileProjectsHrz 4-5TileProjectsVrt 4-5TileViewsGrid 4-5, 10-12TileViewsHrz 4-5TileViewsVrt 4-5ToggleDispCurrent 8-10ToggleEddyEffect 8-10TogglePickBndByName 8-10TogglePickBndByRay 8-11TogglePickObjByName 8-11TogglePickObjByRay 8-11TogglePickObjObjInt 8-11ToggleRegion 4-16ToggleViewBndVis 8-3Top 10-47Uncover 6-21Undel 6-21Undo 6-22, 10-47UndoClear 8-11Unite 6-22UnrotatedCS 4-16UpdatePlots 10-48UseSuggestedEddyEffectVals 8-11Value 10-48VecX 10-48VecY 10-48VecZ 10-48VerifyCondPaths 8-3VerifyRegion 4-16Viewpoint 4-20

VisByItem 4-16VolumeBoxCreate 10-48VolumePlot 10-48Wireframe 4-20WriteSolutions 10-49XAxisAboutTo 4-16XAxisTo 4-16XUnitVec? 4-17YAxisAboutTo 4-17YAxisTo 4-17YUnitVec? 4-17ZAxisAboutTo 4-17ZAxisTo 4-17ZUnitVec? 4-17

script control commands 1-8conditionals 1-10expressions 1-11IF 1-8REPEAT 1-8WHILE 1-9

Section 6-18SeedingInfo 9-6SeedRefineCommandToKernel 9-7SelClear 6-18SelColor 6-18SelCopy 6-18SelCut 6-18Select 4-14SelectByName 8-2SelectFacesIntersection 8-2SelectObjByName 8-6SelectObjFaces 8-6SelectOneFace 9-8SelFaces 9-8SelInBox 4-14SelPaste 6-19SeNop 5-8SetAdaptiveInfo 5-6SetAllBndUnitsToCurrent 8-6SetArrow 10-42SetBndName 8-6SetBndUnitsToCurrent 8-6SetBoolean 8-7SetBoundary 8-7


Index-22

SetBoxScope 9-8SetColormap 10-42SetCondResidual 5-6SetCondSAdaptiveInfo 5-7SetCondSolutionType 5-7SetCurPos 4-15SetCurrentObjectGroup 5-4SetCurrentSetupType 5-5SetCurrentSolnPrmsType 5-7SetDefaultUnits 8-2SetDisplayOn 9-8SetEchoEnabled 3-19SetEddyEffect 8-3SetEndpoint 8-7SetFaceterRefinements 9-9SetFilled 10-43SetFrequency 5-7SetGridSpacing 10-43SetHiddenLine 10-43SetLine 10-44SetMacroPathList 3-19SetMarker 10-44SetMenuItemHotkey 11-7SetMeshDisplayMode 9-9SetMeshExternal 10-45SetMeshScale 10-45SetMeshType 5-8SetModel 6-19SetMSRelation 8-8SetNonLinResidual 5-8SetNonModel 6-19SetNumPoints 10-45SetObjectCS 4-15SetOrigin 8-8SetPlotAttributes 10-45SetRecordingEnabled 3-19SetRefinement 10-45SetResidual 5-8SetScalar 8-8SetScalarFor 8-8SetScale 10-46SetSldTol 6-19SetSolveFields 5-9SetSolvePrms 5-9

SetSolver 5-9SetSolveType 5-9SetStartPoint 8-9SetStringFor 8-9SetTextMarker 10-46SetTorqueAxisAnchorPoint 5-5SetTorqueAxisEndPoint 5-5SetTransparency 10-46SetTriScope 9-9SetUnits 6-19SetUnitsOfQuant 3-19SetUpoint 8-9SetVector 8-9SetViewKindWireFrame 9-9SetVpoint 8-10SetWizardFieldPrompt 11-15SetWizardSelboxIndex 11-16Shaded 4-20ShadedMesh 9-9Show 4-15ShowAll 4-15ShowCalc 10-12ShowColorKey 10-46ShowConductionPaths 8-3ShowHideMesh 9-10ShowMesh 9-10ShowOrient 4-15ShowPlotCoordinates 10-12ShowPoints 9-10ShowRegion 4-15, 6-19ShowSolutionInfo 10-12ShowSurfTri 9-10ShowTets 9-10Sleep 3-20Smooth 10-46SmoothenMesh 9-10SolnPrmsDone 5-10Solution Setup Command Set

SaveSetup 5-6SetAdaptiveInfo 5-6SetCondResidual 5-6SetCondSAdaptiveInfo 5-7SetCondSolutionType 5-7SetCurrentSolnPrmsType 5-7


Index-23

SetFrequency 5-7SetMeshType 5-8SetNonLinResidual 5-8SetNop 5-8SetResidual 5-8SetSolveFields 5-9SetSolvePrms 5-9SetSolver 5-9SetSolveType 5-9SolnPrmsDone 5-10

SolutionName 10-46Split 6-20Sqrt 10-47Stitch 6-20StoreComputations 10-47StrConcat 3-20String 3-21StringListSetComponent 3-21Strlen 3-21Strstr 3-21Sub 3-21SUB expression 1-11Substring 3-22Subtract 6-20SurfacePlot 10-47SwapBoolean 8-10SwapStrandedBoolean 8-10SweepAxis 6-20SweepPath 6-21SweepTwist 6-21SweepVec 6-21

TTangent 10-47TangentComponent 10-47TileAllGrid 4-4, 10-12TileAllHrz 4-4TileAllVrt 4-4TilePlotVisibility 10-12TileProjectsGrid 4-4, 10-12TileProjectsHrz 4-5TileProjectsVrt 4-5TileViewsGrid 4-5, 10-12

TileViewsHrz 4-5TileViewsVrt 4-5ToggleDispCurrent 8-10ToggleEddyEffect 8-10TogglePickBndByName 8-10TogglePickBndByRay 8-11TogglePickObjByName 8-11TogglePickObjByRay 8-11TogglePickObjObjInt 8-11ToggleRegion 4-16ToggleViewBndVis 8-3tool bar, about 1-13Top 10-47

UUnassign 3-22Uncover 6-21Undel 6-21Undo 6-22, 10-47UndoClear 8-11Unite 6-22UnrotatedCS 4-16UpdatePlots 10-48User menu Additions

AddHelpSelboxItem 11-5User menu additions

AddMenuItem 11-5AddMenuSeparator 11-6DebugFileExec 11-6DeleteHelpSelboxItem 11-6DeleteMenuItem 11-6DisableMenuItem 11-7MacroDebugger 11-7SetMenuItemHotkey 11-7

UseSuggestedEddyEffectVals 8-11

VValue 10-48Vec2 3-22Vec3 3-22VecX 10-48VecY 10-48


Index-24

VecZ 10-48VerifyCondPaths 8-3VerifyRegion 4-16Viewpoint 4-20VisByItem 4-16VolumeBoxCreate 10-48VolumePlot 10-48

WWHILE statement 1-9Wireframe 4-20Wizard Command Set

AddWizardSelbox 11-10AddWizardSelboxItems 11-10GetWizardRunResult 11-12GetWizardSelboxIndex 11-12IsWizardControlChecked 11-12SetWizardFieldPrompt 11-15SetWizardSelboxIndex 11-16

WriteMesh 9-10WriteMeshAs 9-10WriteSolutions 10-49

XXAxisAboutTo 4-16XAxisTo 4-16XOR 3-22XUnitVec? 4-17

YYAxisAboutTo 4-17YAxisTo 4-17YUnitVec? 4-17

ZZAxisAboutTo 4-17ZAxisTo 4-17ZUnitVec? 4-17

Date post:	20-Aug-2018
Category:	Documents
Upload:	vannhi
View:	213 times
Download:	0 times

NSOFT - read.pudn.comread.pudn.com/downloads106/ebook/438459/ANSOFT... · macro.bk : front.fm iii...

Documents