ANSYS ACT Developers Guide PDF

ANSYS ACT Developer's Guide
ANSYS, Inc.
Southpointe
2600 ANSYS Drive
Canonsburg, PA 15317
[email protected]
http://www.ansys.com
(T) 724-746-3304
(F) 724-514-9494
Release 17.1
April 2016
ANSYS Customization ANSYS Customization Suite
ANSYS, Inc. is
certified to ISO
9001:2008.
Copyright and Trademark Information

2016 SAS IP, Inc. All rights reserved. Unauthorized use, distribution or duplication is prohibited.
ANSYS, ANSYS Workbench, Ansoft, AUTODYN, EKM, Engineering Knowledge Manager, CFX, FLUENT, HFSS, AIM
and any and all ANSYS, Inc. brand, product, service and feature names, logos and slogans are registered trademarks
or trademarks of ANSYS, Inc. or its subsidiaries in the United States or other countries. ICEM CFD is a trademark
used by ANSYS, Inc. under license. CFX is a trademark of Sony Corporation in Japan. All other brand, product,
service and feature names or trademarks are the property of their respective owners.
Disclaimer Notice
THIS ANSYS SOFTWARE PRODUCT AND PROGRAM DOCUMENTATION INCLUDE TRADE SECRETS AND ARE CONFIDENTIAL AND PROPRIETARY PRODUCTS OF ANSYS, INC., ITS SUBSIDIARIES, OR LICENSORS. The software products
and documentation are furnished by ANSYS, Inc., its subsidiaries, or affiliates under a software license agreement
that contains provisions concerning non-disclosure, copying, length and nature of use, compliance with exporting
laws, warranties, disclaimers, limitations of liability, and remedies, and other provisions. The software products
and documentation may be used, disclosed, transferred, or copied only in accordance with the terms and conditions
of that software license agreement.
ANSYS, Inc. is certified to ISO 9001:2008.
U.S. Government Rights

For U.S. Government users, except as specifically granted by the ANSYS, Inc. software license agreement, the use,
duplication, or disclosure by the United States Government is subject to restrictions stated in the ANSYS, Inc.
software license agreement and FAR 12.212 (for non-DOD licenses).
Third-Party Software
See the legal information in the product help files for the complete Legal Notice for ANSYS proprietary software
and third-party software. If you are unable to access the Legal Notice, Contact ANSYS, Inc.
Published in the U.S.A.
Table of Contents
Introduction ............................................................................................................................................... 1
Customizing ANSYS Products .................................................................................................................. 1
Direct Product Customization ........................................................................................................... 2
Process Compression and Automation .............................................................................................. 3
Licensing ................................................................................................................................................ 3
Migration Notes ..................................................................................................................................... 4
Changes to the Wizard API ................................................................................................................ 4
Changes to the Project API ............................................................................................................... 4
Known Issues and Limitations ................................................................................................................. 5
Defining Extensions ................................................................................................................................... 7
Creating a Scripted Extension ................................................................................................................. 7
ExtSample Extension: XML Extension Definition File .......................................................................... 8
ExtSample Extension: IronPython Script ............................................................................................ 9
ExtSample Extension: Directory Structure/File Hierarchy .................................................................... 9
ExtSample Extension: Exposure in the Application ........................................................................... 11
Extension Libraries ......................................................................................................................... 12
Building a Binary Extension ................................................................................................................... 13
Configuring Extension Options ............................................................................................................. 17
Additional Extension Folders Option ............................................................................................... 18
Save Binary Extensions with Project Option ..................................................................................... 18
Journal Wizard Actions Option ....................................................................................................... 18
Debug Mode Option ....................................................................................................................... 18
Using Extensions ...................................................................................................................................... 21
Using the ACT Start Page ...................................................................................................................... 21
Accessing the ACT Start Page .......................................................................................................... 21
ACT Start Page Interface ................................................................................................................. 22
Using the Extension Manager ............................................................................................................... 23
Extension Manager Accessed via the ACT Start Page ........................................................................ 24
Extension Manager Accessed via Extensions Menu .......................................................................... 25
Installing and Uninstalling Extensions ................................................................................................... 26
Installing a Scripted Extension ........................................................................................................ 26
Uninstalling a Scripted Extension .................................................................................................... 27
Installing a Binary Extension ........................................................................................................... 27
Uninstalling a Binary Extension ....................................................................................................... 28
Loading and Unloading Extensions ....................................................................................................... 29
Configuring Extensions to be Loaded by Default ............................................................................. 30
Extension Capabilities .............................................................................................................................. 33
Common Capabilities ........................................................................................................................... 33
Defining Toolbars and Toolbar Buttons ............................................................................................ 33
Binding Toolbar Buttons with ACT Objects ...................................................................................... 36
Defining Pop-up Dialogs ................................................................................................................. 37
Storing Data in Your Extension ........................................................................................................ 38
ACT-Based Properties ........................................................................................................................... 39
Creating Property Groups ............................................................................................................... 39
Using PropertyGroup and PropertyTable ................................................................................... 39
Using Templates to Create Property Groups ............................................................................... 43
Parameterizing Properties ............................................................................................................... 43
Common Property Parameterization Processes .......................................................................... 44
Parameterizing Properties in ANSYS Workbench ........................................................................ 45
Parameterizing Properties in ANSYS Mechanical ........................................................................ 46
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
iii
ACT Developer's Guide

Defining Input Parameters in ANSYS Mechanical ................................................................. 46
Defining Output Parameters in ANSYS Mechanical .............................................................. 47
Parameterizing Properties in ANSYS DesignModeler .................................................................. 48
Parameterizing Properties in a Third-Party Solver ....................................................................... 50
Defining Parameters under a Load in a Third-Party Solver .................................................... 50
Defining Parameters in Analysis Settings in a Third-Party Solver ........................................... 50
Defining Parameters under Results in a Third-Party Solver .................................................... 50
Defining DesignXplorer Properties .................................................................................................. 51
Properties in the DX Interface ................................................................................................... 51
Additional Attributes for DX Extensions ..................................................................................... 53
Advanced Usage Examples ....................................................................................................... 53
Managing Dependencies between Properties ..................................................................... 53
Controlling Property Visibility with a Callback ...................................................................... 53
DOE Example ................................................................................................................ 54
Optimization Example .................................................................................................. 54
Modifying an Attribute with a Callback ................................................................................ 54
DOE Example ................................................................................................................ 55
Optimization Example .................................................................................................. 55
Capabilities for ANSYS Mechanical ........................................................................................................ 55
Adding a Pre-Processing Feature in ANSYS Mechanical .................................................................... 56
Adding a Post-Processing Feature in ANSYS Mechanical .................................................................. 61
Creating Results with Imaginary Parts ............................................................................................. 67
Obsolete "OnStartEval" and GetValue" Callbacks ............................................................................. 67
Connecting to a Third-Party Solver .................................................................................................. 68
Third-Party Solver Connection Extension ................................................................................... 68
Post Processing ........................................................................................................................ 72
Load and Save Data .................................................................................................................. 73
Capabilities for ANSYS DesignModeler .................................................................................................. 76
Geometry Definition in the XML File ................................................................................................ 76
Geometry Definition in the Python File ........................................................................................... 78
Functions Associated with the <ongenerate> Callback .............................................................. 79
Functions Associated with the <onaftergenereate> Callback ..................................................... 81
Capabilities for ANSYS DesignXplorer .................................................................................................... 82
The Design Exploration Process ....................................................................................................... 83
The DX Component .................................................................................................................. 85
The DOE Component .......................................................................................................... 85
The Optimization Component ............................................................................................. 85
The DX Extension ..................................................................................................................... 86
Implementing a DX Extension ......................................................................................................... 86
Implementation Requirements ................................................................................................. 86
DX Extension Definition and Configuration ............................................................................... 87
DX Extension Capabilities ......................................................................................................... 89
Main Capabilities ................................................................................................................ 89
Optional Capabilities .......................................................................................................... 91
Notes on Method Class Implementation .......................................................................................... 91
Notes on Monitoring ................................................................................................................ 92
Notes on Results ....................................................................................................................... 92
Capabilities for Custom ACT Workflows in Workbench ........................................................................... 93
Exposing Custom Taskgroups and Tasks on the Project Schematic .................................................... 93
Using Global Callbacks to Invoke Custom Schematic Actions ........................................................... 94
The Custom Workflow Creation Process ........................................................................................... 95
Creating the Extension Definition XML File ...................................................................................... 96
iv

Defining a Global Callback ........................................................................................................ 99
Invoking Global Callbacks ................................................................................................... 99
Filtering Global Callbacks ................................................................................................... 99
Specifying Global Callback Execution Order ....................................................................... 100
Available Global Callbacks ................................................................................................. 100
Defining a Task ....................................................................................................................... 103
Defining Task-Level General Data Transfer ......................................................................... 105
Defining Task-Level Callbacks ............................................................................................ 106
Defining Task-Level Context Menus ................................................................................... 107
Defining Task-Level Property Groups and Properties .......................................................... 107
Defining Task-Level Property Callbacks ........................................................................ 108
Using Standardized Property Interaction ..................................................................... 111
Using Path-Based Property Control Support ................................................................ 112
Using String-Based and Option-Based Task Properties ................................................. 113
Specifying Property Default Values .............................................................................. 113
Defining Task-Level Parameters ................................................................................... 113
Defining Task-Level Inputs and Outputs ...................................................................... 114
Defining a Remote Job Execution Specification ........................................................... 115
Defining a Taskgroup .............................................................................................................. 116
Creating the IronPython Script ...................................................................................................... 116
Upstream Data Consumption (Input) ....................................................................................... 117
Data Generation (Output) ....................................................................................................... 117
Convenience APIs ................................................................................................................... 117
Capabilities for ANSYS AIM .................................................................................................................. 118
Adding a Pre-Processing Feature in ANSYS AIM Structural .............................................................. 118
Custom Load Definition in the XML File .................................................................................. 118
Custom Load Definition in the Python File .............................................................................. 119
Creating a Custom Object to Merge Existing AFD Features (Process Compression) .......................... 121
CFD System Definition in the XML File ..................................................................................... 121
CFD System Definition in the IronPython File ........................................................................... 122
ACT Simulation Wizards .......................................................................................................................... 125
Types of Wizards ................................................................................................................................. 125
Creating Wizards ................................................................................................................................. 126
Parts of a Wizard ........................................................................................................................... 126
XML Extension Definition File ....................................................................................................... 127
Example: XML Extension File ................................................................................................... 127
IronPython Script .......................................................................................................................... 131
Example: IronPython Script for a Project Wizard ....................................................................... 131
Custom Help for Wizards ............................................................................................................... 134
Creating Custom Help for Wizards ........................................................................................... 134
Viewing Custom Help for Wizards ............................................................................................ 135
Customizing the Layout of a Wizard .............................................................................................. 136
Installing and Loading Wizards ............................................................................................................ 139
Using Wizards ..................................................................................................................................... 139
Using a Workbench or Target Application Wizard ........................................................................... 139
Launching a Wizard from the Wizards Page ............................................................................. 139
The Wizard Interface ............................................................................................................... 141
Entering Data in a Wizard ........................................................................................................ 141
Exiting a Wizard or Project ....................................................................................................... 142
Using an AIM Custom Template ..................................................................................................... 142
APIs Description ..................................................................................................................................... 145
APIs for Custom Workflows in the Workbench Project Page .................................................................. 145

APIs for ANSYS Mechanical .................................................................................................................. 146
Directly Accessing an Object ......................................................................................................... 146
Handling Property Types ............................................................................................................... 147
API Examples: Model Object .......................................................................................................... 147
Geometry: Point Mass ............................................................................................................. 148
Mesh: Mesh Control ................................................................................................................ 148
Connections: Frictionless Contact and Beam ............................................................................ 149
Analysis: Load Magnitude ........................................................................................................ 149
Result: Total Deformation Maximum ........................................................................................ 151
API Examples: TraverseExtension ................................................................................................... 152
Traversing the Geometry ......................................................................................................... 152
Traversing the Mesh ................................................................................................................ 153
Traversing Results ................................................................................................................... 155
User Interface and Toolbars ........................................................................................................... 157
APIs for ANSYS Design Modeler ........................................................................................................... 157
Using the Selection Manager in DesignModeler ............................................................................ 157
Working with the Current Selection ........................................................................................ 157
Creating a New Selection and Adding Entities ......................................................................... 158
Creating Primitives ........................................................................................................................ 158
Creating a Sheet Body ............................................................................................................. 159
Creating a Wire Body .............................................................................................................. 160
Creating a Solid Body .............................................................................................................. 161
Applying Operations ..................................................................................................................... 162
Applying the Extrude Operation .............................................................................................. 163
Applying the Transform Edges to Wire Tool .............................................................................. 164
APIs for ANSYS DesignXplorer ............................................................................................................. 165
DOE APIs ...................................................................................................................................... 165
DOE Architecture .................................................................................................................... 165
The Sampling Process ............................................................................................................. 166
Optimization APIs ......................................................................................................................... 167
Optimization Architecture ....................................................................................................... 167
The Optimization Process ........................................................................................................ 168
Associated Libraries ................................................................................................................................ 171
Query to Material Properties ............................................................................................................... 171
Units Conversion ................................................................................................................................ 173
MAPDL Helpers ................................................................................................................................... 175
Journaling Helper ............................................................................................................................... 176
Development and Debugging ................................................................................................................ 179
ACT Console ....................................................................................................................................... 179
Using the Context Menu ............................................................................................................... 180
Using the Command Line Editor .................................................................................................... 180
Using the Command History Window ............................................................................................ 181
Using Auto-Completion ................................................................................................................ 182
Using Auto-Completion Tooltips ............................................................................................. 182
Interacting with Auto-Completion Suggestions ....................................................................... 184
Using Bookmarks .......................................................................................................................... 184
ACT Console Keyboard Shortcuts .................................................................................................. 187
Binary Extension Builder ..................................................................................................................... 188
Debug Mode ...................................................................................................................................... 190
Reload Extensions ......................................................................................................................... 192
Extensions Log File ....................................................................................................................... 192
Debugging with Microsoft Visual Studio ............................................................................................ 193
vi

Advanced Programming in C# ................................................................................................................ 195
Initialize the C# Project ........................................................................................................................ 195
C# Implementation for a Load ............................................................................................................. 195
C# Implementation for a Result ........................................................................................................... 196
Examples ................................................................................................................................................. 199
Mechanical Extension Examples .......................................................................................................... 199
Von-Mises Stress as a Custom Result .............................................................................................. 199
An Edge-Node Coupling Tool ........................................................................................................ 203
DesignXplorer Extension Examples ..................................................................................................... 208
DOE Extension Examples .............................................................................................................. 208
Optimization Extension Examples ................................................................................................. 208
Custom ACT Workflows in Workbench Examples .................................................................................. 209
Global Workflow Callbacks ............................................................................................................ 209
XML Definition File ................................................................................................................. 210
IronPython Script .................................................................................................................... 211
Custom User-Specified GUI Operation ........................................................................................... 212
Custom, Lightweight, External Application Integration with Parameter Definition ........................... 214
Custom, Lightweight, External Application Integration with Custom Data and Remote Job Execution .............................................................................................................................................. 217
Using RSM Job Submission Capabilities ................................................................................... 222
Generic Material Transfer .............................................................................................................. 225
Material File ............................................................................................................................ 228
Generic Mesh Transfer ................................................................................................................... 229
Custom Transfer ............................................................................................................................ 232
Parametric .................................................................................................................................... 235
Wizard Examples ................................................................................................................................ 236
Project Wizard (Workbench Project Tab)* ....................................................................................... 236
Project Wizard (AIM Project Tab) .................................................................................................... 242
Reviewing Wizard Results ........................................................................................................ 248
DesignModeler Wizard* ................................................................................................................ 251
Mechanical Wizard* ...................................................................................................................... 254
vii

Mixed Wizard* .............................................................................................................................. 258
Electronics Desktop Wizard ........................................................................................................... 265
Reviewing the Analysis ........................................................................................................... 268
SpaceClaim Wizard ....................................................................................................................... 270
AIM Custom Template (Single-Step) .............................................................................................. 278
Defining Custom Help for the Single-Step Custom Template .................................................... 282
AIM Custom Template (Multiple-Step) ........................................................................................... 283
XML Extension Definition File .................................................................................................. 283
Defining Custom Help for the Multiple-Step Custom Template ................................................. 289
Wizard Custom Layout Example .................................................................................................... 290
Exposure of the Wizard Layouts ............................................................................................... 291
XML Extension Definition ....................................................................................................................... 293
<extension> ....................................................................................................................................... 294
<Application> .............................................................................................................................. 295
<appStoreId> ............................................................................................................................... 296
<assembly> .................................................................................................................................. 296
<author> ...................................................................................................................................... 297
<description> ............................................................................................................................... 297
<Guid> ......................................................................................................................................... 297
<Interface> .................................................................................................................................. 298
<Licenses> ................................................................................................................................... 300
<script> ....................................................................................................................................... 300
<simdata> .................................................................................................................................... 301
<Templates> ................................................................................................................................ 303
<UIDefintion> .............................................................................................................................. 303
<Wizard> ..................................................................................................................................... 303
<Workflow> ................................................................................................................................. 304
A. Component Input and Output Tables ..................................................................................................... 309
B. ANSYS Workbench Internally Defined System Template and Component Names ..................................... 373
C. Data Transfer Types ................................................................................................................................ 389
D. Addin Data Types and Data Transfer Formats .......................................................................................... 395
E. Pre-Installed Custom Workflow Support ................................................................................................. 399
viii
Introduction
ANSYS ACT is the unified and consistent tool for the customization and expansion of ANSYS products.
Using ACT, you can create extensions to customize ANSYS Workbench, ANSYS AIM, or other supported
ANSYS applications (such as Mechanical, DesignModeler, Fluent, Electronics Desktop, and DesignXplorer).
This guide offers an introduction to ACT, discussing its capabilities and showing how to use them. It is
primarily intended for developers of ACT extensions, but also provides information for the end users
who will be managing and/or using the extensions.
Basic examples, each written and tested on all Windows platforms, are used to illustrate different types
of customization in each supported ANSYS product.
Note
The development of extensions requires some knowledge of IronPython and XML. For extensions that customize the ANSYS solver, knowledge of APDL is also required.
Related topics:
Customizing ANSYS Products
Licensing
Migration Notes
Known Issues and Limitations
Customizing ANSYS Products

ANSYS ACT enables customizations at the application level, providing internal mechanisms that allow
you to customize ANSYS Workbench, ANSYS AIM, or other ANSYS applications without needing to
compile external code or link with existing ANSYS libraries. Additionally, it enables you to manage the
interfaces between the standard application and the additional customization, ensuring that they interact
accurately.
ACT Customization Capabilities
ACT provides two types of customization:
Direct, API-driven product customization via standard extensions. For more information, see Direct
Product Customization (p. 2).
Process compression and automation via wizard extensions. For more information, see Process Compression and Automation (p. 3).
Using ACT customization capabilities, you can:
Create vertical apps or extensions to tailor ANSYS Workbench, ANSYS AIM, and other ANSYS products
(such as Mechanical, Fluent, Electronics Desktop, DesignXplorer) to meet your application-specific
and multi-physics simulation needs.
Introduction
Engage the ANSYS simulation ecosystem through integration and custom workflow techniques, enabling your business-specific elements to co-exist and interface with pre-built ANSYS solutions.
Encapsulate existing features and processeseither those native to ANSYS products or ones derived
from a third-party toolinto cohesive, automated simulation workflows.
Integrate third-party tools by creating new features based on the tool or by leveraging existing thirdparty functionality.
Where to Start
To begin developing extensions, start with the general instructions provided in Defining Extensions (p. 7).
To begin using an extension youve created, review the general information provided in Using Extensions (p. 21).
For general and application-specific information on direct product customization, see Extension Capabilities (p. 33).
For information on process compression and automation, see ACT Simulation Wizards (p. 125).
To review sample extensions for supported ANSYS products, see Examples (p. 199).
Direct Product Customization

ACT provides APIs for the creation of extensions to encapsulate and automate routine processes performed in ANSYS target applications. In addition to leveraging functionality already available in an application, an ACT extension allows you to add specialized functionality and operations of your own.
ACT target applications that support direct, API-driven feature customization are as follows:
Workbench: Customizations of the Project page include the creation of custom task groups (systems)
and tasks (components), supporting the integration of third-party applications. UI customization is also
supported. For more information, see Capabilities for Custom ACT Workflows in Workbench (p. 93).
AIM: Customizations include the addition of a custom load to a structural analysis and the exposure of
a complete CFD system with access to all available boundary conditions. For more information, see
Capabilities for ANSYS AIM (p. 118).
DesignModeler: Customizations include the creation of specialized geometries with custom properties
and the application of various operations to the geometries. For more information, see Capabilities for
ANSYS DesignModeler (p. 76).
Mechanical: Customizations include specialized loads, results, and post processing functionality. For
more information, see Capabilities for ANSYS Mechanical (p. 55).
DesignXplorer: Customizations include the ability to integrate external sampling methods and optimization algorithms. For more information, see Capabilities for ANSYS DesignXplorer (p. 82).
For information on generally-applicable customization options, such as the creation of toolbars and
pop-up dialogs, see Common Capabilities (p. 33).
For information on the creation of custom properties and property groups, see ACT-Based Properties (p. 39).
Licensing
Process Compression and Automation

ACT provides you with the tools to create wizard" extensions that allow you to leverage both the existing functionality of ANSYS target applications and the scripting capabilities of the Workbench/AIM
framework API. With a wizard, you can manipulate existing features and simulation components, organizing them as needed to produce a custom automated process. You can also customize the user interface
of a wizard, defining layouts both for the interface as a whole and for individual interface components.
Wizards can be applied to single application, or across several target applications. The degree of automation possible depends on the target application being customized.
ANSYS applications that support process compression and automation are as follows:
Workbench
AIM
SpaceClaim
DesignModeler
Mechanical
Electronics Desktop
For more information on using wizards in general, see ACT Simulation Wizards (p. 125).
For information on wizards for specific applications, see Wizard Examples (p. 236).
For information on customizing a wizards's interface, see Customizing the Layout of a Wizard (p. 136)
and the example Wizard Custom Layout Example (p. 290).
Licensing
ACT development is licensed, but binary extension usage is not. In other words, developers creating
new extensions must have a license. However, once the extension is built, a license is not required to
run it.
The ACT license enables two main capabilities, which are:
The ability to build an extension in the Binary Extension Builder. The ACT license is checked out when the
build is launched and is released once the build has been completed.
The ability to load a scripted extension. As a consequence, only the binary extensions can be loaded when
no ACT license is available. No matter the number of scripted extensions that are loaded, only one ACT license
is checked out. This license is released once all the scripted extensions have been unloaded from the Extension Manager.
Note
If an ACT license is already checked out by a loaded scripted extension, the build operation
will not require a second ACT license to run.
Introduction
Migration Notes
This section provides information you will need when migrating from version 17.0 to version 17.1.
Note
Additional items may be published in the "ANSYS ACT 17.1 Migration Notes" document. You
can access this document in the ANSYS ACT Application Store, accessed via the Downloads
tab of the ANSYS Customer Portal.
Changes to the Wizard API

In 17.1, there are changes to how to create a dialog in an ACT wizard.
Previously, you could create a dialog in a wizard as follows:
dlg = step.UserInterface.Panel.CreateDialog("MyDialog",
"okCancelDialog", "MyTitle", 400, 150)
comp = dlg.GetFirstOrDefaultComponent()
comp.SetOkButton("Ok")
Now, the method CreateDialog still exists, but the component okCancelDialog does not. In order
to create an OkCancelDialog, you must call CreateOkCancelDialog, as follows:
comp = step.UserInterface.Panel.CreateOKCancelDialog("MyDialog",
"MyTitle", 400, 150)
comp.SetOkButton("Ok")
Changes to the Project API

Project-Level ExtAPI Exposure
Starting at the 17.1 release, the following changes to the Project API (custom workflows in the Workbench
Project page) take effect:
Project-Level ExtAPI Exposure
Starting at the 17.1 release, there is project-level ExtAPI exposure available for the Project API . These
APIs provide access to items in the Workbench schematic, including the framework data model, interface
components, and user objects and their properties.
Users can access the following project-level ACT APIs off the master ExtAPI entry point:
Project
The top level of the project hierarchy is the framework-level Project. It provides additional entry points
to the Workbench data model, file manager, etc. and is accessed as follows:
project = ExtAPI.DataModel.Project
Context
This is the framework-level command context. It provides additional entry points to the session and project
utilities, and is accessed as follows:
context = ExtAPI.DataModel.Context

Tasks
This is all of the tasks within the schematic, both ACT-defined and pre-installed tasks. It does not include
the master task level (i.e. ACT and schematic template-like tasks). Only concrete tasks instances are included. It is accessed as follows:
tasks = ExtAPI.DataModel.Tasks
General Callback Argument Migration

To handle the 17.1 migration from existing callback arguments to task-based arguments, please refer
to the following conversion guide:
Argument / Variable
17.1 Replacement
container
container = task.InternalObject
context
For example, if youd created a custom task whose pre-17.1 update signature was:
def update(container, context):
In 17.1, you would change the signature and add the following two statements:
def update(task):

This section provides a listing of known issues and limitations in the ACT 17.1 release.
Linux Wizard Panel Display Issues in DesignModeler and Mechanical
For Linux, there may be issues with the docking of the Wizard panel in DesignModeler and Mechanical.
To avoid any display issues, it is recommended that you keep the application maximized. If for some
reason the wizard panel disappears or is not correctly positioned, maximizing the application should solve
the issue.
Localization Support Limitation
Localization of ACT is limited to the languages currently supported in ANSYS Workbench. This limitation
does not apply to the ability to manage various languages within the extension. For example, the property
names created by an extension do not have to be in the same language as the current activated language
in ANSYS Workbench.
There is no mechanism to integrate localization for the property names defined by an extension.
In order to manage different languages for your property names, you must develop localization
yourself. Both regional settings based on the "." or the "," decimal symbol are available. However,
the implementation of the extension should use the "." symbol for any value defined at the XML or
Python level.
Automatin API Methods and Properties Must be Called in the UI Thread
When you are using the ACT automation API, automation methods and properties must be called in the
UI thread; calls from outside UI thread will generate a COM object error similar to the following:
Introduction
[...] Unable to cast COM object of type 'System.__ComObject' to
interface type 'Ansys.Common.Interop.WBPropertyBrowsing.IAnsProperty'.
[...]
To ensure that a method call occurs from the thread, you must call the method with:
ExtAPI.Application.InvokeUIThread(f, a)
This will execute f with the argument a in the UI thread, enabling you to use the automation API.
Additionally, you should not use the automation API when you are implementing callbacks that are
not executed in the UI thread. If you receive an error, you can check whether your call is executed
in the UI thread as follows:
1. Use the following property in your callback implementation:
System.Threading.Thread.CurrentThread.ManagedThreadId
2. Call this in the ACT Console and verify that you get the same ID.
For your reference, the following callbacks are not executed in the UI thread:
onGenerate
onEndEvaluate
onStartEval
onStartPost
onEndEval
Defining Extensions
With ACT, you can define extensions in two different formats: scripted and binary.
Scripted extensions
Scripted extensions are comprised of an XML extension definition file and an IronPython script (and any
supporting files, such as help or input files). Callbacks in the XML file invoke the functions or methods
defined in the script.
Binary extensions
Binary extensions (also called "compiled extensions") result from the build of a scripted extension. Developers
create scripted extensions and then compile them into a binary extension (WBEX file). The binary extensions
can be shared with end-users, who will be able to apply the extension but will not be able to view or edit
its contents.
An ACT license is required to create and build an extension, but not required to execute extensions.
For more information, see Licensing (p. 3).
Note
When creating an extension, you will use the IronPython language to develop the functions
used to execute the extension. The following links provide documentation on the IronPython
language:
IronPython documentation
Python reference book
Related Topics:
Creating a Scripted Extension
Building a Binary Extension
Configuring Extension Options

An ACT scripted extension has two basic components:
XML extension definition file: used to define and configure the content of the extension.
IronPython script: used to define functions that respond to user/GUI interactions and implement the behavior of the extensions. Typically, the Python functions are invoked through the different events or callbacks
in the XML extension file.
An extension can potentially be created using additional components such as external Python libraries
or even C# code. However, the two components described above represent the basic definition for an
extension.
Defining Extensions
In this section, we'll use a very simple example to demonstrate how to define a scripted extension. We'll
use an extension called ExtSample to customize the ANSYS Mechanical application, adding a singlebutton toolbar to the interface of the Mechanical application. When this button is clicked, a dialog box
will appear and display the following message: High five! ExtSample1 is a success!
Note
Depending on the application to be customized, the content of the extension will differ, but
the basic organization of an ACT extension remains consistent with the example presented.
Related Topics:
ExtSample Extension: XML Extension Definition File
ExtSample Extension: IronPython Script
ExtSample Extension: Directory Structure/File Hierarchy
ExtSample Extension: Exposure in the Application
Extension Libraries
ExtSample Extension: XML Extension Definition File

The XML file used to configure the ExtSample1 extension is named ExtSample1.xml. The contents
of this file are listed below.
<extension version="1" name="ExtSample1">
<guid>e0e0f6c2-b50f-425e-a778-5b3e527f65c1</guid>

<script src="sample1.py" />
<interface context="Mechanical">
<images>images</images>
<callbacks>
<oninit>init</oninit>
</callbacks>
<toolbar name="ExtSample1" caption="ExtSample1">
<entry name="HighFive" icon="hand">
<callbacks>
<onclick>HighFiveOut</onclick>
</callbacks>
</entry>
</toolbar>
</interface>
</extension>
Key elements of the XML file include:

The extension name
The GUID of the extension
Unique identifier for the extension that enables you to change the extension name in a new
version without compromising the compatibility with projects that were saved with an older
version of the extension.
The Python script file name
The interface context
The oninit callback method name
The toolbar and toolbar button definition

The <entry> tags define the HighFive toolbar button, which uses the icon image from the file
hand.bmp. The <onclick> tags define the name of the callback function to invoke when the button
is selected. The next section addresses the Python script definition of the function HighFiveOut.
For more information on working with the XML extension definition file, see Using Extensions (p. 21).
ExtSample Extension: IronPython Script

The IronPython script is used to first, define Python script functions that will be invoked by user/GUI
interactions and then, implement the extension's behavior. The IronPython functions for ExtSample1
are defined in the sample1.py script. The contents of this script is shown below.
clr.AddReference("Ans.UI.Toolkit")
clr.AddReference("Ans.UI.Toolkit.Base")
from Ansys.UI.Toolkit import *
def init(context):
ExtAPI.Log.WriteMessage("Init ExtSample1...")
def HighFiveOut(analysis_obj):
MessageBox.Show("High five! ExtSample1 is a success!")
The script contains two functions:

The init() function: Called when the application (in this example, Mechanical) is opened. The argument
context contains the name of the application (Mechanical).
The HighFiveOut() function: Called when the user clicks the toolbar button HighFive. As with all <onclick> callback functions, the application passes an instance of the active Analysis object as an argument.
For any function, the global variable ExtAPI represents the main entry point for all the services provided
by ACT. As an example, the init() function uses the ILog interface of ACT to write one message in
the log file. For more information on the available interfaces, see the ANSYS ACT API Reference Guide.
ExtSample Extension: Directory Structure/File Hierarchy

The directory structure/file hierarchy for ExtSample1 is illustrated in Figure 1: Extension Directory
Structure/File Hierarchy (p. 10). Note that the XML extension file ExtSample1.xml and the extensions
folder ExtSample1 are at the same level in a parent directory. Note that the XML file and the extension
folder must have the same name.
Defining Extensions
Figure 1: Extension Directory Structure/File Hierarchy
Figure 2: Extension Folder Content (p. 10), shows the contents of the extension folder ExtSample1. The
IronPython script sample1.py contains the script needed to fulfill the behavior of the example extension; the images folder contains the icon file used by the GUI of the extension.
Figure 2: Extension Folder Content
Figure 3: Images Folder Content (p. 11) shows the contents of the images folder. The icon file hand.bmp
is used by the example extension to expose the specific button from the toolbar.
10

Figure 3: Images Folder Content
ExtSample Extension: Exposure in the Application

In our example, the context of the ExtSample1 was set to Mechanical, which will cause the extension
to be loaded with the Mechanical application. In the following figure, the ExtSample1 extension toolbar
and the HighFive button are now part of the ANSYS Mechanical user interface.
Figure 4: ExtSample1 Toolbar
The open extension log shown below shows that the ExtSample1 extension was initialized for the
Mechanical application context.
11
Defining Extensions
Figure 5: ExtSample1 Extension Log
Extension Libraries
As you develop extensions to integrate customizations in the application, you can use additional libraries
to share Python functions between extensions. Some libraries are installed by default with ACT to help
developers customize the application.
Supported libraries related to the Mechanical application are located in the following folder:
%ANSYSversion_DIR%\..\Addins\ACT\libraries\Mechanical
Supported libraries related to the AIM application are located in the following folder:
%ANSYSversion_DIR%\..\Addins\ACT\libraries\Study
The libraries included with ACT are described below:
ansys.py
Provides helpers to generate an APDL command block.
chart.py
Provides helpers to generate charts, such as curves and histograms.
units.py
Provides a set of generic functions to convert data from one unit system to another.
wbjn.py
Provides a tool to communicate data to and from the Workbench project page.
12

For more information, see Associated Libraries (p. 171).

Once youve created a scripted extension, you can turn it into a compiled binary extension to be shared
with end-users. A separate compiler is not necessary; ACT provides its own process for encapsulating
the scripted extension to a binary format unreadable by users.
The encapsulation of the scripted extension (also called "the building of the binary extension"), generates
a unique WBEX file. This file contains all the files or directories necessary for the extension.
Accessing the Binary Extension Builder

Access the Binary Extension Builder tool via either of the following ways:
Click the Extensions > Build Binary Extension menu option.
Figure 6: Accessing the Binary Extension Builder via the Extensions Menu
In the Extension Manager accessed via the ACT Start Page, select Build from an extension's drop-down
menu.
13
Defining Extensions
Figure 7: Accessing the Binary Extension Builder via the Extension Manager
The Binary Extension Builder opens, as shown below.

Figure 8: Binary Extension Builder Accessed via Extensions Menu or Extension Manager
14
Using the Binary Extension Builder

On the Binary Extension Builder dialog, fill out the parameters as follows:
1. If you have accessed the builder via the Extensions menu, select the scripted extension to be built into a
binary format. (If you accessed the builder via the Extension Manager, this is already specified.)
The Scripted Extension to Build drop-down menu is populated with a list of scripted extensions
from directories defined in the Extension tab of the Workbench/AIM Options dialog. Both the name
and the version are displayed in the list to avoid any confusion when multiple versions of one extension are present.
Figure 9: Contextual List of Scripted Extensions
2. Identify the directory where the binary extension will be stored.

3. Specify a security level for sharing the extension.
Your selection specifies whether the extension can be saved within an ANSYS Workbench project,
and thus, when that project is shared, if the extensions can be loaded with the shared project. This
security level enables the developer of the extension to control how the extension can be shared
along their use with various projects.
Select one of the following options:
Can copy extension to project: Each time a user asks to save this extension with a project, the
extension itself is copied into the project and consequently is available each time this project is
opened. This extension can also be used with other projects.
Can copy extension to project but locked to this one: The extension can be saved within a
project, as with the previous option, but the use of the extension is limited to the current project.
If a user opens a new project, this extension is not available.
15
Defining Extensions
Can't copy extension to project: The extension is not saved with the project and is not shared
with other users with the project.
Note
The extension can be sent in addition to the project. The process for saving extensions within
a project is described in Configuring Extensions to be Loaded by Default.
These security options only apply if the user wants to save the extension with the project,
and are otherwise not applicable.
When all parameters are defined, the Build button becomes enabled.
4. Click the Build button to launch the build.
While the build is in progress, the bottom part of the window displays build information, as illustrated
below.
Figure 10: Building a Binary Extension
Note
The appearance of the builder tool will vary according to how you have accessed it, but
the parameters are the same.
16

The Extensions tab of the Workbench/AIM Tools > Options menu allows you to define options for
ACT.
Figure 11: Options Menu
Figure 12: Extensions Options
The following configuration options are available:

Additional Extension Folders Option
Save Binary Extensions with Project Option
Journal Wizard Actions Option
Debug Mode Option
17
Defining Extensions
Additional Extension Folders Option

Define additional folders in which ACT will search for extensions to be exposed in the Extension
Manager. You can define several folder names, separated by a semi-colon (;).
Folders that you define here are added to the users ApplicationData folder (%APPDATA%\Ansys\<version>\ACT\extensions).
Because these folders are searched for extensions by default, the Extension Manager includes any extensions located in them.
Note
The default folders are not searched recursively, so store your extensions at the top level of
the directory; extensions stored in subdirectories will not be found.
During this process, warning messages are returned for any conflicts; these messages are also logged
in the ACT log file.
Save Binary Extensions with Project Option

Specify whether the extensions should be saved when the project is saved. Select one of the following
options:
Never: The current loaded extensions are not saved within the project.
Copied but locked to the project: Extensions are saved within the project but are limited to that
project.
Always: The extensions are saved within the project and no restriction exists as to their use in other
projects. This option represents what most users expect when the project is saved. However, note that
this behavior is dependent on the security options of the extension defined by the developer, as described in Building a Binary Extension (p. 13). In particular, the following scenarios can occur:
The extension was built with the security option set to Can't copy extension to project and the
user set the save option to Always or Copied but locked to the project. In this case, the security
option has the priority and the user will not have the extension saved in the project.
The extension was built with the security option set to Can copy extension to project but locked
to this one and the user set the save option to Always. Although the save option does not impose
any restriction for the extension, the security level will limit the use of the extension for the current
given project.
Journal Wizard Actions Option

Select this option to automatically create a journal file when a wizard, either a Workbench or applicationbased wizard or an AIM custom template, is run.
Debug Mode Option

This option allows you to enable Debug mode. When enabled, this mode allows the developer to debug
the scripted extension.
18

The Debug mode also exposes the following features, which will help you to debug the extension being
developed:
In Workbench and AIM, a Reload extension button is added to the toolbar.
In the ANSYS Mechanical or DesignModeler application, an ACT Development toolbar is added; it includes a Reload extension button and a View log file button.
For more information on Debug mode, see Debug Mode (p. 190).
19
20
Using Extensions
ACT can manage an entire set of extensions for different ANSYS applications. When extensions are used
for multiple target applications, each extension provides its own customization level. However, the end
user can define a personal configuration based on the extensions previously loaded in ANSYS Workbench,
ANSYS AIM, or the target application of choice. Consequently, the level of customization is directly dependent on the choices the end user makes prior to opening the customized application.
Once a project using an ACT extension has been created and saved, any further use of the project must
integrate any previously used extensions. If these extensions are available, then Workbench loads the
extensions automatically when the project is opened. If an expected extension has not been detected,
an error message is displayed. For more information about controlling the availability of extensions,
see Configuring Extension Options (p. 17).
Related topics:
Using the ACT Start Page
Using the Extension Manager
Installing and Uninstalling Extensions
Loading and Unloading Extensions
Using the ACT Start Page

The ACT Start Page is a single page that provides you with convenient access to ACT functionality.
From this page, you can access multiple tools that can be used in both the development and the execution of extensions. It is available in all ANSYS applications that support the use of extensions. This
includes:
Workbench and AIM
Applications opened within the Workbench or AIM environment, such as DesignXplorer or Mechanical
Applications opened independently as standalone applications, such as SpaceClaim or Electronics Desktop
Related Topics:
Accessing the ACT Start Page
ACT Start Page Interface
Accessing the ACT Start Page

In most cases, you will open the ACT Start Page from the Workbench or AIM interface. For standalone
applications that have been installed independently of Workbench or AIM, an alternate access method
is available.
Accessing the ACT Start Page from Workbench or AIM

In Workbench or AIM, you can access the ACT Start Page via the corresponding option in the Extensions
menu, as shown below:
21
Using Extensions
Figure 13: Accessing the ACT Start Page from Workbench or AIM
Accessing the ACT Start Page from a Standalone Application

To access the ACT Start Page from a standalone instance of SpaceClaim, click the ACT Start Page icon
in the Prepare toolbar.
Figure 14: Accessing the ACT Start Page from SpaceClaim
To access the ACT Start Page from a standalone instance of Electronics Desktop, click the View >
Wizards menu.
For more information, see the documentation of the standalone application.
Figure 15: Accessing the ACT Start Page from Electronics Desktop
ACT Start Page Interface

The ACT Start Page includes the following icons that enable you to access ACT functionality and tools:
22

the Wizards page (see Launching a Wizard from the Wizards Page (p. 139))
the Extension Manager (see Using the Extension Manager (p. 23))
the ACT Console (see ACT Console (p. 179))
the Log (see Extensions Log File (p. 192))
Figure 16: ACT Start Page Interface

The Extension Manager tool enables you to perform tasks like loading and unloading extensions and
setting certain extensions to be loaded by default. There are two versions of the Extension Manager:
one that is accessed from the ACT Start Page
one that is accessed from the Workbench/AIM Extensions menu (legacy version)
Note
Both versions offer the same capabilities.
The Extension Manager provides a list of all the extensions that have been installed and are available
to be loaded. For information on how the list is populated, see Additional Extension Folders Option (p. 18).
Both scripted and binary extensions are included in the list, but scripted extensions are listed only if
you have an ACT license. You can view the name, type, and version specified in the XML extension
definition file. When defined, an icon and description are also available.
The following sections address both versions of the Extension Manager tool:
23
Using Extensions
Extension Manager Accessed via the ACT Start Page
Extension Manager Accessed via Extensions Menu
Extension Manager Accessed via the ACT Start Page

To access the Extension Manager via the Customization start page:
1. Open the ACT Start Page as described in Using the ACT Start Page (p. 21).
2. Click the Extension Manager icon to open the Extension Manager.
The Extension Manager is displayed as shown below.
Figure 17: Extension Manager Accessed via the ACT Start Page
The Extension Manager shows all of the extensions that are currently installed (scripted extensions
are listed only if you have an ACT license). The green extensions are the ones that have already been
loaded. The following general functionality is available:
Click one of the "+" icons to install a new binary extension.
Click the gear icon to add a directory in which ACT will search for extensions, as described in Additional
Extension Folders Option (p. 18).
Click the ANSYS Application Store button to access extensions available for download on the ANSYS Customer Portal.
Click the arrow icon to return to the ACT Start Page.
24

Use the Search field to find a specific extension. The case-insensitive search tool looks for all strings entered
that are separated by a blank (serving as the AND operation) and performs a combined search for strings
separated by the OR operation. You can search by the following items:
Name, description, or author of an extension
Example: Enter "mydemowizards" to return all extensions of that name, or "authorname" to return all
extensions with author set to authorname.
Name of a context
Example: Enter "Mechanical" to return all extensions with a context set to Mechanical.
Extension object type
Example: Enter the object (e.g. "wizard", "workflow", or any simdata object (e.g. "load", "result", "solver",
or "geometry") to return all extensions containing at least one object of that type.
Extension object type and object name separated by a colon
Example: Enter "load:my_load") to return all extensions having a load named my_load.
You can also right-click an extension to open a context menu showing options for that extension. The
following options are available:
Load extension / Unload extension
Allows you to load or unload the extension.
Load as default / Do not load as default
Allows you indicate that the extension should or should not be loaded to the project by default. When
you specify that an extension should be loaded by default, it is automatically loaded to the project (either
existing or new) when ANSYS Workbench or the corresponding application is launched. For more information, see Configuring Extensions to be Loaded by Default (p. 30).
Uninstall
Available only for unloaded binary extensions. Allows you to uninstall a binary extension.
Build
Available only for scripted extensions. Opens the Build Binary Extension dialog as described in Building
a Binary Extension (p. 13).
About
Provides extension information such as version, format (xml or wbex), folder, context, and feature.
Extension Manager Accessed via Extensions Menu

To access the legacy version of the Extension Manager in AIM or Workbench, select the Extensions
> Manage Extensions menu option.
The Extension Manager is displayed as shown in Figure 18: Extension Manager Accessed via the Extension
Menu (p. 26).
25
Using Extensions
Figure 18: Extension Manager Accessed via the Extension Menu
The Extension Manager shows all of the extensions that are currently installed (scripted extensions
are listed only if you have an ACT license), along with the type and version for the extension. The following functionality is available:
Check or clear the Loaded check box to load or unload the extension.
Right-click an extension to open a context menu showing the options available for that extension.
Load / Unload
Allows you to load or unload the extension.
Load as Default / Do not Load as Default
Allows you indicate that the extension should or should not be loaded to the project by default. When
you specify that an extension should be loaded by default, it is automatically loaded to the project
(either existing or new) when ANSYS Workbench or the corresponding application is launched. For more
information, see Configuring Extensions to be Loaded by Default (p. 30).
Uninstall
Available only for unloaded binary extensions. Allows you to uninstall a binary extension.
Use the Search field to find a specific extension.

Once an extension has been created, it must be installed in order to be used. The installation process
differs for scripted and binary extensions.
Both are addressed in the following sections:
Installing a Scripted Extension
Uninstalling a Scripted Extension
Installing a Binary Extension
Uninstalling a Binary Extension
Installing a Scripted Extension

To install a scripted extension, save the extension and associated files in one of the following locations:
%ANSYSversion_DIR%\..\Addins\ACT\extensions
26

%APPDATA%\Ansys\v171\ACT\extensions
Any of the include directories defined in the Additional Extension Folders field on the Extensions
page of the Options dialog.
Any of the include directories specified by using the gear icon on the Extension Manager (accessed
via the ACT Start Page).
Uninstalling a Scripted Extension

To uninstall a scripted extension, simply remove the extension and its associated files and directories.
If you remove a scripted extension while the Extension Manager is open, it will continue to display
until the Extension Manager is closed and reopened.
Note
The Uninstall option on the Extension Manager is applicable only to binary extensions.
Installing a Binary Extension

A binary extension can be installed using either the Extensions menu or the version of the Extension
Manager accessed via the ACT Start Page.
To install a binary extension:
1. Access the install functionality using one of the following methods:
In the Workbench or AIM window, select Extensions > Install Extension.
Figure 19: Install Extension menu
In the Extension Manager (accessed via the ACT Start Page), click one of the "+" icons.
2. Browse to the binary extension () WBEXfile you want to install.
3. Select the WBEX file and click Open.
27
Using Extensions
Extensions installed this way are located in the current user's Application Data folder and are
available for loading in the Extension Manager.
Note
When a binary extension is installed, a new folder is created in addition to the WBEX file.
Both the folder and the WBEX file are necessary for compatibility with ACT. If you need
to move this new extension to a different folder, make sure that both the folder and the
WBEX file are copied at the same time to the same folder.
Uninstalling a Binary Extension

A binary extension can be uninstalled using either version of the Extension Manager.
To uninstall a binary extension:
1. Open the Extension Manager.
2. Right-click the binary extension to open its context menu. For the Extension Manager accessed via the
ACT Start Page, you can also open the context menu by clicking the down-arrow.
3. Select the Uninstall option.
28

Figure 20: Uninstalling an Extension
Note
This process for uninstalling extensions is only available for binary extensions.

Extensions can be loaded and unloaded using either version of the Extension Manager. When an extension is marked as loaded in the Extension Manager, it is loaded with the corresponding application
(as specified by the extension context attribute).
Note
The loading is automatic for extensions that have already been loaded and saved to the
project. Any extensions to be automatically loaded must be available to the Extension
Manager. If a required extension is not available, an error message is displayed.
Wizards that will be run in standalone instances of SpaceClaim or Electronics Desktop (i.e.
when Workbench and AIM are not installed) must be loaded via the Extension Manager
accessed on the ACT Start Page.
In the Extension Manager accessed via the ACT Start Page, you can also load or unload an extension
simply by clicking the extension.
29
Using Extensions
You can also load or unload an extension as follows:
2. Access the option to load or unload the extension in one of the following ways:
For either version of the Extension Manager, right-click the extension to open its context menu and
select Load or Unload.
3. For the legacy version (accessed via the Extensions menu), you can check or uncheck the check box to
the left of the extension.
Figure 21: Loading or Unloading an Extension
Configuring Extensions to be Loaded by Default

In either version of the Extension Manager, you can select a set of extensions to be loaded to the
project by default. These extensions are automatically loaded when the corresponding application is
launched. Both scripted and binary extensions are available for selection. There is no limitation on the
number of extensions that can be loaded by default.
To specify whether an extension should be loaded by default:
2. Right-click the extension to open its context menu.
30

3. Select the Load as Default or Do Not Load as Default option.
Figure 22: Load as Default Option
Extensions configured to be loaded by default are identified by the word "Default."
31
Using Extensions
Figure 23: Extensions to be Loaded by Default
32
Extension Capabilities
In the introductory chapter, the sample extension ExtSample1 was used to describe the fundamental
elements of an extension. The ExtSample1 extension demonstrated how to create a toolbar which
contains a button that responds by calling a Python scripted function. This chapter expands on this
description and introduces the main capabilities an extension can address.
This chapter divides extension capabilities in to the following categories:
Common Capabilities
ACT-Based Properties
Capabilities for ANSYS Mechanical
Capabilities for ANSYS DesignModeler
Capabilities for ANSYS DesignXplorer
Capabilities for Custom ACT Workflows in Workbench
Capabilities for ANSYS AIM
Common Capabilities
ACT provides customization capabilities that are common to all target applications: ANSYS Mechanical,
ANSYS DesignModeler, ANSYS DesignXplorer, ANSYS AIM, and ANSYS Workbench.
This section discusses the following common capabilities:
Defining Toolbars and Toolbar Buttons
Binding Toolbar Buttons with ACT Objects
Defining Pop-up Dialogs
Storing Data in Your Extension
Defining Toolbars and Toolbar Buttons

In this section, well focus on the customization of toolbars and toolbar buttons in applications that
expose their own toolbars. In addition to the target applications that provide support for ACT direct
customization (Workbench, AIM, Mechanical, DesignModeler, and DesignXplorer), toolbar customization
is also available for all applications that provide support for ACT wizards (Fluent, Electronic Desktop).
We will use the ANSYS Mechanical application for demonstration purposes.
A toolbar serves as a parent container for one or more toolbar buttons. Conceptually, the toolbar should
address a specific feature, with each toolbar button being associated with a function that supports the
feature. This relationship is reflected in the structure of the XML extension file used to define a toolbar
and its buttons.
The XML file for the ExtToolbarSample extension is shown below.
<extension version="1" minorversion="0" name="ExtToolbarSample">
<script src="toolbarsample.py" />
<callbacks>
</callbacks>
33
<toolbar name="ToolBar1" caption="ToolBar1">
<entry name="TB1Button1" icon="button1Red">
<callbacks>
<onclick>OnClickTB1Button1</onclick>
</callbacks>
</entry>
<callbacks>
</callbacks>
</entry>
<callbacks>
</callbacks>
</entry>
</toolbar>
<toolbar name="Toolbar2" caption="Toolbar2">
<entry name="TB2Button1" icon="button1Blue">
<callbacks>
</callbacks>
</entry>
<callbacks>
</callbacks>
</entry>
<callbacks>
</callbacks>
</entry>
</toolbar>
</interface>
</extension>
The ExtToolbarSample extension adds two toolbars, Toolbar1 and Toolbar2. Each toolbar has
three buttons, as shown in Figure 24: User-Defined Toolbars in Mechanical (p. 34).
Figure 24: User-Defined Toolbars in Mechanical
The XML example defines two toolbar elements. Each element starts with a begin tag <toolbar
name="..." caption="..."> and ends with a terminal tag </toolbar>. The toolbar element
has two attributes, name and caption. The name attribute is required and is used for internal references.
The caption attribute is the text displayed in the application.
34
Common Capabilities
The button entry elements define the buttons in the toolbar. Each button entry element starts with
a begin tag <entry name="..." icon="..."> and ends with a terminal tag </entry>. The
entry element has two attributes: name and icon. The name attribute is required and is used for
internal references. The name is also displayed as a tooltip. The icon attribute is the name of the icon
file mapped on to the button.
The entry element for each button is parent to a callbacks element. The <callbacks> element
encapsulates element(s), which are named on the basis of an event. For instance, the name specified
by the onclick element, <onclick>name</onclick>, provides the name of the Python function
to be called when the button is selected.
Referring again to the XML in the above code, the second line:
<script src="toolbarsample.py" />
defines the name of the Python script file for the ExtToolbarSample extension, toolbarsample.py,
the contents of which are shown below. By default, ACT will look for the Python script file in the directory
of the extension. If the Python script file is located in a different directory, an explicit path to the file
must be inserted into the extension XML file.
import os
import datetime
def init(context):
ExtAPI.Log.WriteMessage("Init ExtToolbarSample ...")
def OnClickTB1Button1(analysis):
LogButtonClicked(1, 1, analysis)
def LogButtonClicked(toolbarId, buttonId, analysis):
now = datetime.datetime.now()
outFile = SetUserOutput("ExtToolbarSample.log", analysis)
f = open(outFile,'a')
f.write("*.*.*.*.*.*.*.*\n")
f.write(str(now)+"\n")
f.write("Toolbar "+toolbarId.ToString()+" - Button "+buttonId.ToString()+" Clicked. \n")
f.write("*.*.*.*.*.*.*.*\n")
f.close()
MessageBox.Show("Toolbar "+toolbarId.ToString()+" - Button "+buttonId.ToString()+" Clicked.")
def SetUserOutput(filename, analysis):
solverDir = analysis.WorkingDir
return os.path.join(solverDir,filename)
Each button in ExtToolbarSample has a unique callback function. Each callback function passes the
toolbar ID and the ID of the button pressed to the function LogButtonClicked, which stores them
in the variables toolbarId and buttonId. These variables are referenced within the function where
35
their string values are written. The functions LogButtonClicked and SetUserOutput demonstrate
how to reduce redundant code in callbacks using utility functions. The Analysis object is passed to
each <entry> callback and then used in the SetUserOutput function to query for the working
directory of the analysis. The script in toolbarsample.py makes use of the datetime namespace
from the .NET framework. The datetime namespace exposes a class also called datetime. LogButtonClicked invokes datetime to query the current date and time and stores the result in the variable
name now. The str() utility is used to extract the string definition of the variable now to write out
the date and time.
Binding Toolbar Buttons with ACT Objects

ACT provides the ability to bind a button from the ACT toolbar with an ACT object created in the tree
of the application. This capability allows you to control the contextual availability of the buttons depending on the object selected in the tree. This method is similar to the control used for standard objects
in Mechanical. The connection between the ACT object and the ACT button is made using the userobject tag in the entry element of the interface definition in the XML file. The following code
demonstrates this type of connection for a result object:
<toolbar name="My_Toolbar" caption="My_Toolbar">
<entry name="Button_For_My_Result icon="result" userobject="My_Result">
</entry>
</toolbar>
</interface>
<simdata context="Mechanical">
<result name="My_Result" version="1" caption="My_Result" icon="result" location="elemnode"
type="scalar">
</result>
</simdata>
As an example, if the ACT button is bound with an ACT load in Mechanical, then this button is activated
only if the object is selected in the Mechanical environment; otherwise it is inactive.
In the same way, if the ACT button is bound with an ACT result in Mechanical, this button is active only
if the object is selected in the solution; otherwise it is inactive.
For any ACT object bound to a button, the <onclick> callback is not used.
Based on the above example, Figure 25: Selecting an Environment Object (p. 37) and Figure 26: Selecting
a Solution Object (p. 37) illustrate the GUI behavior based on selection of an object in the tree.
36
Common Capabilities
Figure 25: Selecting an Environment Object
Figure 26: Selecting a Solution Object
In addition to the control provided by the connection between the ACT button and the ACT object,
the <canadd> callback can be implemented to add new criteria to be considered for the activation
and deactivation of the button. If the <canadd> callback of the object returns false, the associated
button is deactivated. A typically example consists of filtering a particular analysis type to activate a
specific load.
Defining Pop-up Dialogs

This section discusses message dialogs using the ExtDialogSample extension as an example.
ExtDialogSample defines a new menu labeled DialogSample with one menu item labeled GetFilename. ExtDialogSample demonstrates how to open a file dialog and display a message window in
the user interface.
The XML for the ExtDialogSample extension, shown below, is similar to the XML used for the
ExtToolbarSample extension.
<extension version="1" minorversion="0" name="ExtDialogSample">
<script src="dialogsample.py" />
<callbacks>
</callbacks>
<toolbar name="DialogSample" caption="DialogSample">
37
<entry name="DialogSample1" caption="GetFilename">
<callbacks>
<onclick>GUIToolbarOpenFile</onclick>
</callbacks>
</entry>
</toolbar>
</interface>
</extension>
The callback function specified in the XML for the GetFilename menu button is GUIToolbarOpenFile.
Here is the Python script from the file dialogsample.py.
def init(context):
ExtAPI.Log.WriteMessage("Init ExtDialogSample ...")
def GUIToolbarOpenFile(analysis):
filters = "txt files (*.txt)|*.txt|All files (*.*)|*.*"
dir = "c:\\"
res = FileDialog.ShowOpenDialog(ExtAPI.UserInterface.MainWindow, dir, filters, 2,
"ExtDialogSample","")
if res[0]==DialogResult.OK:
message = str("OPEN selected -> Filename is "+res[1])
else:
message = "CANCEL selected -> No file"
MessageBox.Show(message)
When GUIToolbarOpenFile is invoked, an instance of a modal file-selection dialog is created by

calling FileDialog.ShowOpenDialog. The class FileDialog is provided by the UI Toolkit. The
user inputs the necessary information in this dialog. When the user clicks the Open or Cancel buttons,
the file-selection dialog closes and this information is returned to GUIToolbarOpenFile. The returned
information is then used to create a message-box dialog. The message displayed in the message-box
dialog validates the result returned from the file-selection dialog.
Storing Data in Your Extension

Two mechanisms are available to store data in your extension. These mechanisms are based on the
<onload>/<onsave> callbacks or on attributes. These mechanisms are available for any application
using ACT.
The <onsave> callback is called each time the target application saves the project. Consequently, this
callback allows the creation of dedicated files to store data, in addition to the standard ANSYS Workbench
project.
The <onload> callback is called each time the application loads the project. The process here is similar
to the previous <onsave> callback, but is now devoted to reading in additional data.
Attributes represent a very interesting way to store data, as this method does not require the creation
of new external files.
Attributes are defined by name and content. The content can be simply defined by a single value such
as an integer, or a double, or with more complex data. The content must be serializable. To accomplish
this, implement the serialization interface provided by .Net. Types such as integer, double, list,
and dictionary are serializable by default.
Attributes are automatically saved and resumed with the project. Attributes can be associated with an
extension, an ACT load or result, and a property.
38
Attributes are created or edited with the method:
Attributes["attribute_name"] = attribute_value
and the content can be retrieved with the method:

attribute_value = Attributes["attribute_name"]
Below is an example of an attribute associated with a property:

prop.Attributes["MyData"] = 2
val = prop.Attributes["MyData"]
Below is a similar example for an attribute associated with a load:

load.Attributes["MyData"] = 2
val = load.Attributes["MyData"]
Below is a similar example for an attribute associated with an extension:

ExtAPI.ExtensionMgr.CurrentExtension.Attributes["MyData"] = 2
v = ExtAPI.ExtensionMgr.CurrentExtension.Attributes["MyData"]
Note that an attribute associated with an extension can be shared between applications using the same
extension. For example, two Mechanical sessions can share data.
The command to store the attribute in a shared repository is as follows:
ExtAPI.ExtensionMgr.CurrentExtension.SetAttributeValueWithSync("MyData", 2.)
In the same way, the command to retrieve the content stored in a shared repository is:
ExtAPI.ExtensionMgr.CurrentExtension.UpdateAttributes()
v = ExtAPI.ExtensionMgr.CurrentExtension.Attributes["MyData"]
ACT has the ability to create customized objects that encapsulate ACT-based properties. This section
discusses how to use ACT to create properties.
The following capabilities are discussed:
Creating Property Groups
Parameterizing Properties
Defining DesignXplorer Properties
Creating Property Groups

This section focuses on the process of creating groups of properties.
The following methods are available:
Using PropertyGroup and PropertyTable
Using Templates to Create Property Groups
Using PropertyGroup and PropertyTable

This section focuses on the process of creating groups of properties via PropertyGroup and PropertyTable.
39
PropertyGroup and PropertyTable are special types of properties that can be used to create
groups of properties with a given caption. In this way, it is possible to manage dependencies between
properties and to create worksheet views from a property.
The PropertyGroup node of the XML file encapsulates a list of child properties under one group.
The PropertyTable node of the XML file encapsulates a list of child properties under one table. Each
child property creates a new column in the table and the user is able to control the line number of this
table.
These functionalities are demonstrated into the AdvancedProperties extension.
The first example shows how to create a group of properties with a caption. The group can be collapsed
or expanded by the user. The Simple group with caption group is shown below.
Figure 27: Details Pane with Group Definition
This group is created with the following XML code:

<propertygroup name="Group1" caption="Simple group with
<property name="Prop1" caption="Prop1" control="text"
</propertygroup>
caption" display="caption">
/>
/>
/>
The property group has a special attribute, display. In this case, this attribute is set to caption,
which means all the children properties are displayed under the caption. If the caption attribute is
omitted, then the display attribute is set to hidden and the property group is hidden.
The second example illustrates how to show or hide properties according to the value of another selected
property.
As shown in Figure 28: Contextual Content for Groups (p. 41), the visibility of the properties is dependent
on the value of the Group Select property as defined above.
40
Figure 28: Contextual Content for Groups
This group is created with the following XML code, which creates dependencies between properties:
<propertygroup name="Group2" caption="Another group" display="caption">
<propertygroup name="Group3" caption="Group Select" display="property" control="select"
default="Option 1">
<attributes options="Option 1,Option 2,Option 3" />
<property name="Prop1" caption="Prop For Option 1" visibleon="Option 1" control="text" />
<property name="Prop2" caption="Prop For Option 1 and Option 2"
visibleon="Option 1|Option 2" control="text" />
</propertygroup>
</propertygroup>
In this case, the attribute display is set to property. The PropertyGroup Group3 defines a
standard ACT property which provides additional capabilities for all the children properties.
Each child property can specify an attribute visibleon which can take a value or a set of values. If
the current value of the parent property fits with the visibleon attribute, then the property is displayed; otherwise, the property is hidden.
The example below demonstrates how to create properties that open a worksheet each time the user
needs access to the content of the properties. The PropertyTable type is used for such an application.
This type of property is of particular interest as it allows you to create a worksheet that exposes a set
of properties for your customization.
41
In order to facilitate the development, ACT already provides some predefined worksheets. Two different
types of worksheets are currently available:
Time-dependent worksheet: The row number of this worksheet is initialized with the number of steps
defined in the AnalysisSettings object. If the user of the extension adds or removes time steps
in the AnalysisSettings object, the worksheet is automatically updated. Consequently, this type
of worksheet represents an efficient way to manage time-dependent data within an extension.
Figure 29: Time-Dependent Worksheet
This worksheet is created with the following XML code:

<propertytable name="TimeDep" caption="TimeDependent" display="worksheet" control="applycancel"
class="Worksheet.TimeFreqTabularData.TFTabularData">
<property name="Step" caption="Step" control="integer" readonly="true" />
<property name="Time" caption="Time" control="float" readonly="true" />
<property name="Temperature" caption="Temperature" unit="Temperature" control="float"></property>
<property name="Pressure" caption="Pressure" unit="Pressure" control="float"></property>
</propertytable>
In this example, the display attribute is set to worksheet. In addition, the class attribute is used
to specify the name of the IronPython class that is used to manage the worksheet. For this given application, the TFTabularData class is used. This class is defined in the file TimeFreqTabularData.py
located into the libraries/Mechanical/Worksheet folder, which is part of the standard ACT
installation.
The properties Step and Time integrate a specific treatment, as they are automatically populated with
the information specified in the AnalysisSettings object. These two properties are optional.
Non-fixed row dimension worksheet: For the second type of worksheet, the array is empty by default.
The user can add a new line by clicking on the top left button as illustrated below.
Figure 30: Non-Fixed Row Dimension Worksheet
This worksheet is created with the following XML code:
42
<propertytable name="Worksheet" caption="Non-Fixed row count" display="worksheet" control="applycancel"
class="Worksheet.PropertyGroupEditor.PGEditor">
<propertygroup name="TempOrPres" caption="TempOrPres" display="property" control="select"
default="Temperature">
<attributes options="Temperature,Pressure" />
<property name="Temperature" caption="Temperature" unit="Temperature" control="float"
visibleon="Temperature"></property>
<property name="Pressure" caption="Pressure" unit="Pressure" control="float"
visibleon="Pressure"></property>
</propertygroup>
<property name="Scoping" caption="Scoping" control="scoping">
<attributes selection_filter="face|edge" />
</property>
<property name="FileName" caption="FileName" control="fileopen">
<attributes filters="Command files (*.bat)|*.bat|All files (*.*)|*.*" />
</property>
</propertytable>
In this example the PGEditor class is used. The PGEditor class is defined in the file PropertyGroupEditor.py, available in the /libraries/Mechanical/Worksheet folder.
You can access the content of the worksheet in the same manner as you do any other standard ACT
property.
Using Templates to Create Property Groups

A template represents a generic method for defining a group of properties with the associated callbacks
code. You can create a template to provide services that can be integrated into any extension. For example, you can build a template to generate a property that displays all the available coordinate systems
for the current model. The advanced user will find using templates to be beneficial--you can enrich the
templates currently integrated in ACT to customize the environment in a very efficient way.
The following template is defined in the file controltemplates.xml located in the templates folder.
The content of this file is presented below.

<controltemplate name="coordinatesystem_selection" version="1">
<property control="select" class="templates.select.SelectCoordinateSystem"></property>
</controltemplate>
First, a name is given to the template. The class SelectCoordinateSystem associated with this
template is defined in the file select.py, located in the /libraries/Mechanical/templates
folder. A template has to be made of one single property. If several properties need to be defined, then
they have to be integrated in a group. The template scoping illustrates a template definition with
different properties.
In order to link this template to a property, the user just needs to fill the control attribute of the
property with the name of the template.
Other examples are available in the file /templates/Mechanical/controltemplates.xml.
Parameterizing Properties
When defining ACT properties in ANSYS Workbench or the ANSYS Mechanical and DesignModeler applications, you can also define the property value as either an input or an output parameter (all ACT
parameters are inputs, unless you specify otherwise in the definition). Once parameterized, the property
is in added to the ANSYS Workbench Parameter Set, where it behaves and is treated as any other
parameter.
43
You can incorporate parameters in a variety of places in your analysis.
In ANSYS Workbench, parameters can be defined for custom task-level properties in the Project Schematic
workflow.
In ANSYS Mechanical, parameters can be defined for any ACT object, regardless of its location in the tree.
In ANSYS DesignModeler, parameters can be incorporated into a number of custom ACT-based features,
such as renaming selected bodies, specifying geometry generation details like as material, dimensions, etc.
In a third-party solver implemented by ACT, parameters can be incorporated into the load, analysis settings,
and result.
All combinations of ACT-based and standard parameters are supported:
ACT input(s) and standard output(s)
ACT input(s) and ACT output(s)
Standard input(s) and ACT output(s)
The following parameterization topics are discussed:
Common Property Parameterization Processes
Parameterizing Properties in ANSYS Workbench
Parameterizing Properties in ANSYS Mechanical
Parameterizing Properties in ANSYS DesignModeler
Parameterizing Properties in a Third-Party Solver
Common Property Parameterization Processes

To define a property as a parameter, you must add the tag isparameter to the XML file and set it
to true. By default, it will be created as an input parameter. To further specify that the property will
be an output parameter, you must also add the tag readonly and set it to true. The following sections
will use sample code segments to illustrate the creation of input and output parameters.
When you define a property as a parameter, keep in mind that it is not selected for parameterization
(i.e. it is not parameterized) by default. Defining a property as a parameter only makes parameterization
possible by adding a check box to the user interface. In order to actually parameterize the property,
the user must select the check box provided by the ACT tag.
Once a property has been selected for parameterization, it will automatically be sent to the Parameter
Set (accessed on the ANSYS Workbench Project Schematic), where it will be displayed in both the
Outline of All Parameters and the Table of Design Points. Output parameters are read-only, but these
two Parameter Set tables provide the same level of control over the definition of ACT input parameters
as is available for standard, non-ACT inputs. For example:
The user can change the unit of the parameterized input property; the unit proposed will respect the type
of unit specified in the XML file.
The user can add a design point for the input parameter by clicking in the bottom row of the Table of
Design Points.
The user can modify the value of a design point by selecting an input parameter and entering a new value.
However, the type of value must respect the one specified in the XML file. As such, design point values in
the previous value must be floats, and cannot be strings.
44
When the user has finished setting up the system and has finished working with parameters and design
point values (there should be at least one input and one output parameter), he can solve the problem
by updating the design points from the Parameter Set.
Parameterizing Properties in ANSYS Workbench

In ANSYS Workbench, you can define ACT-based task properties either as input parameters, output
parameters, or non-parameterized values. The following sections discuss how to implement input and
output parameters on ACT objects within an ANSYS Workbench Project Schematic workflow.
In order to define either an input parameter or an output parameter in your Workbench schematic
workflow, add the isparameter attribute to the XML definition of the task-level property you want
to parameterize. To illustrate, well use the DataSquares extension.
For example, the following code segment creates and parameterizes a task-level input property named
Input. Because it is an input, the readonlyattribute is set to False. The property will have a control
type of integer.
...
<propertygroup name="Inputs">
<property name="Input" caption="Input" control="integer" default="0" readonly="False"
needupdate="true" visible="True" persistent="True" isparameter="True" />
</propertygroup>
...
In the same way, the following code segment creates and enables parameterization for a task-level
output property named Output. Because it is an output property, the readonly attribute is set to
true. The property will also have a control type of integer.
...
<propertygroup name="Outputs">
<property name="Output" caption="Output" control="integer" default="0" readonly="True"
visible="True" persistent="True" isparameter="True" />
</propertygroup>
...
A custom DataSquares system is created on the Project Schematic. The new properties are shown in
the custom Inputs and Outputs sections (as defined by the taskgroups) exposed in the task properties.
45
When you select the Parameterize checkbox for the two properties, they are added to the Parameter
Set.
For a more detailed examination of this example, see Custom, Lightweight, External Application Integration with Custom Data and Remote Job Execution (p. 217).
Parameterizing Properties in ANSYS Mechanical

The following sections provide examples and methods for integrating ACT parameters into your ANSYS
Mechanical model.
In ANSYS Mechanical, it is possible to define ACT-based property values as either input parameters or
output parameters. This section addresses how to implement a parameter on an ACT object in the
ANSYS Mechanical applicationspecifically, how to parameterize loads, results, and user objects. ACT
objects in any of these categories will behave and interact with parameters in exactly the same way.
The following sections provide examples and methods for integrating ACT parameters into your ANSYS
Mechanical model.
Defining Input Parameters in ANSYS Mechanical
Defining Output Parameters in ANSYS Mechanical
Defining Input Parameters in ANSYS Mechanical

To define a property as a parameter, add the tag isparameter to the XML file and set it to true.
For example, the following code segment creates a property named float_unit. The property will
be a pressure and its value will be a float.
<property name="float_unit" caption="float_unit" control="float" unit="Pressure" isparameter="true"/>
Note
Other tags such as default, isload, etc. could be added, as well.
The isparameter tag adds a check box to the user interface, making it possible for the user to select
the property for parameterization.
Once the property has been selected for parameterization, it will automatically be displayed in both
Outline of All Parameters and the Table of Design Points in the Parameter Set.
46
The code sample below is extracted from the XML file of the extension used in the previous example.
You can see how the property definition of our float_unit property is incorporated into the file.
<load name="CustomPressure" version="1" caption="CustomPressure" icon="tload" support="false"
isload="true" color="#0000FF">
<callbacks>
<getsolvecommands order="1">writeNodeId</getsolvecommands>
</callbacks>
<property name="Geometry" caption="Geometry" control="scoping">
<attributes selection_filter="face"/>
</property>
<property name="float_unit" caption="float_unit" control="float" unit="Pressure" isparameter="true"/>
</load>
Defining Output Parameters in ANSYS Mechanical

It is also possible to define an ACT property as an output parameter.
The process for making a property available as a parameter is the same as for any input parameter (by
adding the isparameter tag and setting it to true); a check box allowing parameterization of the
property will become available. To specify that the property will be an output parameter, you must also
add the readonly tag to the XML file and set it to true.
For example, the following code segment creates a property named MyOutPutProperty. As in the
previous example, the property will be a pressure and its value will be a float. Because it includes the
readonly tag set to true, however, this property can be parameterized only as an output parameter.
<property name="MyOutPutProperty" caption="MyOutPutProperty" control="float" unit="Pressure"
readonly="true" isparameter="true"/>
Note
Other tags such as default, isload, etc. could be added, as well.
47
Again, the user must select the check box provided by the ACT tag to actually parameterize the property.
Once the property has been selected for parameterization, the corresponding output will automatically
be generated in the Outline of All Parameters table in the Parameter Set.
In addition, by default the minimum and maximum values of an ACT result object are available to become
output parameters. This capability is not managed by the ACT extension, but takes advantage of the
Mechanical environment.
Parameterizing Properties in ANSYS DesignModeler

In ANSYS DesignModeler, it is possible to define ACT-based property values only as input parameters.
This section addresses how to implement an input parameter on an ACT object in the ANSYS DesignModeler application.
As with any other input parameter, to add an input to ANSYS DesignModeler you must add the isparameter tag to the XML file and set it to true. (You will not be able to add output parameters; the
readonly tag is not available for ANSYS DesignModeler).
For example, in an ACT feature that generates a cylinder, you can add length as a parameter. The following XML code segment defines this Length parameter.
<geometry name="MyFeatureWithParameters" caption="MyFeatureWithParameters"
icon="Construction" version="1">
<callbacks>
<ongenerate>generateMyFeature</ongenerate>
</callbacks>
<property name="Length" caption="Length" control="float" isparameter="true"></property>
</geometry>
The resulting check box next to the Length property allows the user to parameterize Length as an input
parameter.
48
You could add a static structural analysis based on the previous Geometry template by adding an
output parameter in the Static Structural analysis. This results in the schematic workflow shown below:
The input parameter defined in ANSYS DesignModeler will be managed in exactly the same way as
other any other input parameter. In the Outline of All Parameters table in Parameter Set, the geometry
input parameter will be placed under the Geometry system.
49
Parameterizing Properties in a Third-Party Solver

When you have used ACT to deploy a third-party solver, it is possible to define ACT-based properties
as either input parameters or output parameters. This section addresses how to implement a parameter
on an ACT object in an external third-party solverspecifically, under a load, in the analysis settings,
and under results.
The definition of parameters for a third-party solver is no different than the process described in earlier
sections: To parameterize a property, in the property definition you must introduce the isparameter
tag and set it to true; by default, it will be an input parameter. To define it as an output parameter,
you must add the readonly tag and set it to true.
Defining Parameters under a Load in a Third-Party Solver

The process of defining parameters under a load in ANSYS DesignModeler is identical to the process
described in Defining Input Parameters in ANSYS Mechanical (p. 46).
Defining Parameters in Analysis Settings in a Third-Party Solver

It is possible to parameterize the Analysis Settings in a third-party external solver; the settings options
available depend on the definition of the third-party solver.
For example, you can opt to parameterize the maximum number of iterations under Analysis Settings:
The following code segment, placed under the solver section of the XML definition file, defines the
Max. Iterations parameter.
<solver
<property name="MaxIter" caption="Max. Iterations" control="integer" isparameter="true" default="10"/>
</solver>
Defining Parameters under Results in a Third-Party Solver

The process of defining parameters under Results in ANSYS Mechanical is identical to the process described in Parameterizing Properties in ANSYS Mechanical (p. 46). Results parameters can be either inputs
or outputs, depending on whether the readonly tag is set to true or false.
50
Defining DesignXplorer Properties

An external sampling or optimization method can expose settings to allow the user to control algorithm
options and view outputs.
For instance:
A DOE can expose the editable setting Number of Levels to allow the user to define this limit. The sampling
will be responsible for handling this setting as needed. The DOE can also expose the read-only setting Actual Number of Points to inform the user, after the sampling is completed, of the number of points generated.
An optimizer can expose the editable setting Maximum Number of Iterations to allow the user to define
this limit. The optimizer will be responsible for handling this setting as needed. The optimizer can also expose
the read-only setting Actual Number of Iterations to inform the user, after the optimization is completed,
of the number of iterations actually performed.
ACT provides support for the general definition of properties with attributes and callbacks. Each setting
to be exposed to the DX user must be declared and defined in the XML file as a <property> element
under the <sampling> or <optimizer> element, as shown in Figure 31: Example of a DX Property
Definition (p. 51).
Figure 31: Example of a DX Property Definition
<property name="[property internal name (string)]"
caption="[property display name (string)]"
readonly="[true | false(default)]"
default="[default value]"
control="[text(default) | select | float | integer | ...]"
visible="[true(default) | false]"
visibleon="[values(separator '|')]"
...
<attributes>mldr</attributes>
<callbacks
</property>
Optionally, settings can be placed together in groups. Each group must be declared and defined in the
XML file as a <propertygroup> element under <sampling> or <optimizer> element.
For a description of common attributes and callbacks, see property" under the XML Tags" section of
the ANSYS ACT API Reference Guide for DesignXplorer. For more information on settings groups, see
"propertygroup" in ANSYS ACT XML Reference Guide.
Properties in the DX Interface

When an external method is selected in the DX (via the Design of Experiments Type menu in the DOE
workspace or the Method Name menu in the Optimization workspace), its properties are shown in the
Properties view.
For example, in Figure 32: DesignXplorer Properties View for External DOE (p. 52) below, we can see
the Properties view when the external sampling named Full Factorial is selected.
51
Figure 32: DesignXplorer Properties View for External DOE
In Figure 33: DesignXplorer Properties View for External Optimizer (p. 52) below, we can see the Properties view when the external optimizer named Python Optimizer is selected.
Figure 33: DesignXplorer Properties View for External Optimizer
By default, properties are shown under the General category. If a propertygroup is specified, the
corresponding category is created in the property view. The properties under the General and the respective Status categories are specific to the external method and are defined in the XML file.
52
Note that if the sampling supports the LogFile capability, the Log File property is automatically
defined under the Status category of the Properties view. Once the sampling is generated optimization
has been run, the user can view the log file in a dialog box by clicking on the available link.
Additional Attributes for DX Extensions

In the context of sampling and optimization extensions, DX also recognizes the additional attributes
min, max, and advanced for each property. The min and max attributes are used to specify a minimum
and/or maximum value for a double or integer property.
In the following sampling example, the minimum value is 1 and the maximum value is 100.
<property name="NumberOfLevels" caption="Number of Levels" control="integer" default="3">
<attributes min="1" max="100"/>
</property>
In the following optimization example, the minimum value is 2 and the maximum value is 200.
<property name="MyNumberOfSamples" caption="My Number of Samples" control="integer" default="50">
<attributes min="2" max="200"/>
</property>
The advanced attribute is used to classify the property as an advanced option. Advanced options are
visible for the user only if activated (in the Workbench user interface, open Tools > Options > Design
Exploration and select the Show Advanced Options check box). The following example is applicable
to either type of DX extension.
<property name="MyRandomNumber" caption="My Random Number provider" control="select"
default="Python">
<attributes options="Python,CLibrary" advanced="true"/>
</property>
Advanced Usage Examples

The following advanced examples illustrate the use of properties in DX extensions.
Managing Dependencies between Properties

The following example demonstrates how to manage the dependency between properties:
Prop1 is visible when Group3 value is equal to Option 1
Prop2 is visible when Group3 value is equal to Option 1 or Option 2
Prop3 is visible when Group3 value is equal to Option 3
<propertygroup name="Group3" caption="Group Select" display="property" control="select"
default="Option 1">
<property name="Prop2" caption="Prop For Option 1 and Option 2" visibleon="Option 1|Option 2"
control="text" />

</propertygroup>
Controlling Property Visibility with a Callback

The attributes, such as the visibility attribute, can be modified dynamically by using a callback.
53
DOE Example
The following example shows how to control the visibility of the PropForSingleInput property
with a callback coded in IronPython:
<property name="PropForSingleInput" caption="My Property for single input parameter"
control="text">
<callbacks>
<isvisible>isVisibleForSingInput</isvisible>
</callbacks>
</property>
Where isVisibleForSingInput is defined by the following IronPython code:

def isVisibleForSingInput(entity,property):
if entity.NumberOfObjectivesDefined <= 1:
return True
return False
The isVisibleForSinglnputfunction takes two arguments:

The first argument-named entity, is of type DXUserSampling.
The second argument-named property is of type SimProperty.
This method returns True when only one input parameter is defined.
Optimization Example
The following example shows how to control the visibility of the PropForSingleObjective property
with a callback coded in IronPython:
<property name="PropForSingleObjective" caption="My Property for single-objective optimization"
control="text">
<callbacks>
<isvisible>isVisibleForSOO</isvisible>
</callbacks>
</property>
Where isVisibleForSOO is defined by the following IronPython code:

def isVisibleForSOO(entity,property):
if property.Name != PropForSingleObjective
return True
if entity.NumberOfObjectivesDefined <= 1:
return True
return False
The isVisibleForSOO function takes two arguments:

The first argument-named entity, is of type DXUserOptimizer.
The second argument-named property is of type SimProperty.
This method returns True when only one objective is defined.
Modifying an Attribute with a Callback

The following examples show how you can modify the values property attributes when input parameters
are edited by the user.
54
DOE Example
This example shows how you can modify the values of the max attribute of the property NumberOfLevels when input parameters are edited by the user.
Given the partial sampling definition:
<sampling >
<callbacks>
<InputParametersEdited>InputParametersEdited</InputParametersEdited>
</callbacks>
<property name="NumberOfLevels" caption="Number of Levels" control="integer" default="3"/>
<attributes min="1">
</property>
</sampling>
The InputParametersEdited function is defined by the following IronPython code:

def InputParametersEdited(entity):
entity.Properties["NumberOfLevels"].Attributes["max"]=3*entity.NumberOfInputParametersDefined
The InputParametersEdited function is called when input parameters are edited by the user. It
calculates the new minimum allowed value for the NumberOfLevels property from the current
number of input parameters and then sets this value to the max attribute.
This example shows how you can modify the values of the min attribute of the property MyNumberOfSamples when input parameters are edited by the user.
Given the partial optimizer definition:
<optimizer >
<callbacks>
<InputParametersEdited>InputParametersEdited</InputParametersEdited>
</callbacks>
<property name="MyNumberOfSamples" caption="My Number of Samples" control="integer" default="50" />
</optimizer>
The InputParametersEdited function is defined by the following IronPython code:

def InputParametersEdited(entity):
entity.Properties["MyNumberOfSamples"].Attributes["min"]=10*entity.NumberOfInputParametersDefined
The InputParametersEdited function is called when input parameters are edited by the user. It
calculates the new minimum allowed value for the MyNumberOfSamples property from the current
number of input parameters and then sets this value to the min attribute.

The following capabilities are discussed:
Adding a Pre-Processing Feature in ANSYS Mechanical
Adding a Post-Processing Feature in ANSYS Mechanical
Creating Results with Imaginary Parts
Obsolete "OnStartEval" and GetValue" Callbacks
Connecting to a Third-Party Solver
55
Adding a Pre-Processing Feature in ANSYS Mechanical

This section discusses customization for the ANSYS Mechanical application only as the targeted application needs to expose pre-processing features natively.
Thus far the discussion has been focused on extending the user interface by adding toolbars. This section
discusses how to use toolbars to perform meaningful operations such as adding a pre-processing feature
to ANSYS Mechanical. The example used in the discussion is defined in the DemoLoad extension. The
DemoLoad extension was written to create a generic load. This example is for demonstration purposes
only.
Below are the contents of the DemoLoad.xml file, which adds a load to a project.
As in previous examples, the XML first defines the extension using a version and name attribute. The
path to the Python script file main.py is specified by the <script> tag. The definition of the toolbar
and the buttons is done in the <interface> tag. The callback function named CreateDemoLoad
is used to create and add the load to the simulation environment.
<extension version="1" minorversion="0" name="DemoLoad">
<script src="main.py" />
<toolbar name="Loads" caption="Loads">
<entry name="DemoLoad" icon="tload">
<callbacks>
<onclick>CreateDemoLoad</onclick>
</callbacks>
</entry>
</toolbar>
</interface>
<load name="DemoLoad" version="1" caption="DemoLoad" icon="tload" color="#00FFFF">
<callbacks>
<getnodalvaluesfordisplay>GetNodalValuesForDisplay_DL</getnodalvaluesfordisplay>
<getprecommands>GetPreCommands_DL</getprecommands>
<getsolvecommands order="1">GetSolveCommands_DL</getsolvecommands>
</callbacks>
<attributes selection_filter="edge" />
</property>
<property name="Text" caption="Text" control="text"></property>
<property name="SelectStatic" caption="Select (static)" control="select">
</property>
<property name="SelectDynamic" caption="Select (dynamic)" control="select">
<callbacks>
<onactivate>StringOptions_DL</onactivate>
</callbacks>
</property>
<property name="Double" caption="Double" unit="Length" control="float"
default="1 [m]"></property>
</load>
</simdata>
</extension>
The definition of the load is encapsulated by the <simdata> begin and end tags. The attributes in
the <load> begin tag provide the name, version, caption, icon, and color that apply to this load. The
56

color attribute is defined in a hexadecimal format. This color is used to contrast the load when it is
displayed on the model. The load <callbacks> tag encapsulates two callbacks <getsolvecommands> and <getnodalvaluesfordisplay>.
The tag <getnodalvaluesfordisplay> specifies the name of the Python function that is called
when the load is displayed in the application.
The tag <getsolvecommands> specifies the name of the Python function that is called when the
solver input file is generated by the application. Consequently, the related Python function is responsible
for generating the APDL commands that describe the load within the ANSYS input file. When getsolvecommands is used, the solver commands are inserted into the solver input file just before the
SOLVE command.
ACT provides two additional tags to better control where the specific solver commands are inserted in
the solver input file.
The tag <getprecommands> inserts the solver commands before the standard loads and boundary conditions defined in the application. For the ANSYS solver, the new commands are inserted in the context of
the /PREP7 preprocessor after the mesh has been written.
The tag <getpostcommands> inserts the solver commands so they are executed after the solution has
been resolved. For the ANSYS solver, the new commands will be inserted in the context of the /POST1
postprocessor after the /POST1 command.
Below the callbacks definition, you can define the properties that will be applied to the actual definition
of the load. These properties are displayed in the Details pane of ANSYS Mechanical, where the user
provides the necessary values to complete the load definition. In the Python script we will see how the
load's properties can be retrieved and / or modified.
The following figure shows that each property defined above appears in the Details pane with the
corresponding names and types of interface control.
Figure 34: Properties in the Details Pane
57
Note that the two properties, Select (static) and Select (dynamic), use a select control type. The
first property populates the list of options from the XML, while the second one defines an <onactivate> callback. This callback, which is called when the control is activated, populates the available options
for the property. This second approach allows a full control on the options to be exposed in the dropdown menu and makes the list of options dependent on the current status of the project. Many different
situations that can impact the content of the list of options can be addressed, as long as they are implemented in the <onactivate> callback.
The next property, Double, does not require the definition of one specific callback. Instead, the XML
definition introduces a physical quantity dependency with the unit option; this option specifies that
this property is consistent with a length. In addition, default value of 1 [m] is introduced with the default option. This default value is exposed in the Details pane each time a new load is created.
Here is the Python script file main.py used for the DemoLoad extension.
import os
def init(context):
ExtAPI.Log.WriteMessage("Init DemoLoads...")
def CreateDemoLoad(analysis):
analysis.CreateLoadObject("DemoLoad")
def StringOptions_DL(load,prop):
prop.ClearOptions()
prop.AddOption("X")
prop.AddOption("Y")
prop.AddOption("Z")
def GetPreCommands_DL(load, stream):
stream.Write("/COM, **************************************************" + "\n")
stream.Write("/COM, Load properties from DemoLoad getprecommands event" + "\n")
stream.Write("/COM, Text Property = " + load.Properties["Text"].ValueString + "\n")
stream.Write("/COM, SelectDynamic Property = " + load.Properties["SelectDynamic"].ValueString + "\n")
stream.Write("/COM, SelectStatic Property = " + load.Properties["SelectStatic"].ValueString + "\n")
stream.Write("/COM, Double Property = " + load.Properties["Double"].ValueString + "\n")
def GetSolveCommands_DL(load, stream):
stream.Write("/COM, Load properties from DemoLoad getsolvecommands event" + "\n")
stream.Write("/COM, Text Property = " + load.Properties["Text"].ValueString + "\n")
stream.Write("/COM, SelectDynamic Property = " + load.Properties["SelectDynamic"].ValueString + "\n")
stream.Write("/COM, SelectStatic Property = " + load.Properties["SelectStatic"].ValueString + "\n")
stream.Write("/COM, Double Property = " + load.Properties["Double"].ValueString + "\n")
def GetNodalValuesForDisplay_DL(load, nodeIds):
dval = load.Properties["Double"].Value
coordselect = load.Properties["SelectDynamic"].ValueString
mesh = load.Analysis.MeshData
values = []
for id in nodeIds:
node = mesh.NodeById(id)
dispval = float(0.0)
if coordselect == "X":
dispval = node.X * float(dval)
elif coordselect == "Y":
dispval = node.Y * float(dval)
elif coordselect == "Z":
dispval = node.Z * float(dval)
else:
dispval = float(0.0)
values.Add(dispval)
return values
The functions GetNodalValuesForDisplay_DL and GetSolveCommands_DL are critical to the

behavior and application of the load. GetNodalValuesForDisplay_DL is called each time the
58

graphics is refreshed. The required input arguments are load and nodeIds, where load is the load
object for this load, and nodeIds is a list of node identifiers.
In our example, load.Properties["Double"].Value queries for the "Double" property value. nodeIds
contains a list of node numbers on which one value has to be returned by the function. For every node
of the list, the value of the Double property is assigned in the values array representing the output of
the function. This output is subsequently treated by the graphics engine of the application so that the
visualization on the FE model is available.
GetSolveCommands is intentionally simplified for this example. The prototype of this function is made
of two input arguments, the load object and the filename in which the new specific solver commands
are written. It is important to note that this output file is only a temporary file, as the content is rewritten
in the final solver input file to ensure that the specific commands related to the customized load are
merged with all the other commands already defined by the standard features of the application.
You can also create a specific set of context menu options. These options use the property Action.
Actions are defined inside the <callbacks> section of the load.
<callbacks>
<ongenerate>generate</ongenerate>
<oncleardata>clearData</oncleardata>
<action name="a1" caption="Action 1" icon="update">action1 </action>
</callbacks>
The <action> tag takes three attributes:

A name to identify your action.
A caption that will be displayed in the context menu.
A name that refers to the picture that will be displayed for the icon. The image must be stored in the directory
specified in the XML file.
The content of the tag defines the name of the Python function that is called when the user clicks on
the associated context menu option.
Figure 35: Customized Context Menu Options (p. 60) below shows the result of the declaration. There
are now two additional context menu items, Action 1 and Action 2.
59
Figure 35: Customized Context Menu Options
As illustrated above, you can also add a Generate context menu option. This option derives from the
standard Generate action provided by Mechanical. For that reason, the declaration of this particular
option differs from the declaration of the options Action1 and Action2. This option is always associated
with the Clear Generated Data option.
These options allow you to create a load that can mimic a standard Imported Load. The callback associated with the Generate option replaces the standard function integrated in Mechanical.
The feature is activated when you define the callback <ongenerate> for the load.
The <ongenerate> callback will be called each time the user clicks on the Generate context menu
item, as well as when the user solves, if the state of the load is set to "not solved."
As for the standard Imported Load object, the <ongenerate> callback will be called only if the mesh
is already generated.
<callbacks>
<ongenerate>generate</ongenerate>
<oncleardata>clearData</oncleardata>
</callbacks>
The associated Python code looks like:

def generate(load, fct):
pct = 0
fct(pct,"Generating data...")
propEx = load.PropertyByName("Expression")
exp = propEx.Value
if exp=="":
60

return False
try:
vexp = compile(exp,'','eval')
except:
return False
values = SerializableDictionary[int,float]()
nodeIds = []
propGeo = load.PropertyByName("Geometry")
refIds = propGeo.Value
mesh = ExtAPI.DataModel.MeshDataByName("Global")
for refId in refIds:
meshRegion = mesh.MeshRegionById(refId)
nodeIds += meshRegion.NodeIds
nodeIds = list(set(nodeIds))
for i in range(0,nodeIds.Count):
id = nodeIds[i]
x = node.X
y = node.Y
z = node.Z
v = 0.
try:
v = eval(vexp)
finally:
values.Add(id,v)
new_pct = (int)((i*100.)/nodeIds.Count)
if new_pct!=pct:
pct = new_pct
stopped = fct(pct,"Generating data...")
if stopped:
return False
propEx.SetAttributeValue("Values",values)
fct(100,"Generating data...")
return True
def clearData(load):
ExtAPI.Log.WriteMessage("ClearData: "+load.Caption)
propEx = load.PropertyByName("Expression")
propEx.SetAttributeValue("Values",None)
The <ongenerate> callback takes two arguments: the load object and a function to manage a progress
bar. This function takes also two arguments: the message to display and the value (between 0 and 100)
of the progress bar.
During the process, the generated data is stored using an attribute on the property Expression. For
more information, see Storing Data in Your Extension (p. 38).
The <oncleardata> callback takes one argument: the load object. This callback is called each time
the mesh is cleaned or when the user selects the Clean Generated Data context menu option.
Adding a Post-Processing Feature in ANSYS Mechanical

This section discusses customization for the ANSYS Mechanical application only as the targeted application needs to expose post-processing features natively.
This section discusses how to add a post-processing feature to ANSYS Mechanical. The example used
in the discussion is defined in the DemoResult extension, which creates a customized result that
computes the worst value of the principal stresses for the scoped geometry entities.
61
Following are the contents of the DemoResult.xml file, which adds a result to a project. As in previous
examples, the XML begins by defining the extension with a version and name attribute. The path to
the Python script file demoresult.py is specified by the <script></script> tag. The <interface> tag defines the toolbar and buttons. The callback function named Create_WPS_Result is
used to create and add the result to the simulation environment.
<extension version="1" minorversion="0" name="DemoResult">
<script src="demoresult.py" />
<callbacks>
</callbacks>
<toolbar name="Stress Results" caption="Extension: Worst Principal Stress">
<entry name="Worst Principal Stress" icon="result">
<callbacks>
<onclick>Create_WPS_Result</onclick>
</callbacks>
</entry>
</toolbar>
</interface>
<result name="Worst Principal Stress" version="1" caption="Worst Principal Stress" unit="Stress"
icon="result" location="elemnode" type="scalar">
<callbacks>
<evaluate>WPS_Eval</evaluate>
</callbacks>
<property name="Geometry" caption="Geometry" control="scoping"></property>
</result>
</simdata>
</extension>
The definition of the result is encapsulated by the <simdata> begin and end tags. The attributes in
the <result> begin tag provide the name, version, caption, icon, and unit that apply to this result.
The result <callbacks> tag encapsulates the single callback <evaluate> used for the evaluation.
The tag <evaluate> gives the name of the Python function that will be called to compute the result
when the application (i.e. presently ANSYS Mechanical) requests an evaluation. The output of this
function is sent directly to Mechanical to display the result.
Below the callbacks definition, you can define the properties that are applied to the actual result
definition. These properties are displayed in the Details pane of ANSYS Mechanical when the user has
selected the result in the Outline pane.
Figure 36: Properties in the Details Pane (p. 63) shows that each property appears in the Details pane
of ANSYS Mechanical with the corresponding names and result values.
62

Figure 36: Properties in the Details Pane
Below are the contents of the Python script file demoresult.py, the script file used for the DemoResult extension. The functions Create_WPS_Result and WPS_Eval are critical to the behavior and
application of the result.
The Create_WPS_Result function creates and adds the result to the simulation environment.
The WPS_Eval function is called during solution or when the results need to be re-evaluated.
The callback function Create_WPS_Result is used to create the result and add it to the simulation
environment. This function uses Python dot notation, which allows you to chain objects with methods
that return objects to each other. In the expression analysis.CreateResultObject("Absolute
Principal Stress"), the IAnalysis object analysis is given in argument of the callback. This IAnalysis
object calls the CreateResultObject method. From CreateResultObject, the XML is interpreted
and the internal mechanisms are set into motion to add the details and register the callbacks that define
the results framework. For more comprehensive descriptions of the API objects, methods and properties,
see the ANSYS ACT API Reference Guide.
The WPS_Eval function is called when the result needs to be evaluated or re-evaluated, depending
on the state of the simulation environment. The function definition requires the input arguments result
and step and the output argument collector. Result is the result object for this result and stepInfo
is an IStepInfo object that gives information on the step currently prescribed in the details.
WPS_Eval queries for the component stresses at each node of elements. The stress tensor is used the
compute the three principal stresses (eigenvalues), and then the signed maximum value over these
three is stored as the final result for each node of element. WPS_Eval also deals with the conversion
of units. DemoResults uses a utility library called units, which is imported at the beginning of the
demoresults.py file. With this library, WPS_Eval can derive a conversion factor for the stress units
that is consistent with the units used during solution. Note that the result to be returned by the evaluRelease 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
63
ation function must be consistent with the international system of unit. Then the potential useful conversion to the current unit system in the application is done internally by ANSYS Workbench. Whenever
the result values for Worst Principal Stress are needed for display purposes, ANSYS Mechanical uses
directly the output of the function WPS_Eval. The two callbacks and their registration to the event
infrastructure of ANSYS Mechanical make possible the full cycle of result definition, creation, evaluation,
and display.
import units
wps_stress = {}
eigenvalues = {}
def init(context):
ExtAPI.Log.WriteMessage("Init Demoresult Extension...")
def Create_WPS_Result(analysis):
ExtAPI.Log.WriteMessage("Launch Create_WPS_Result...")
analysis.CreateResultObject("Worst Principal Stress")
# This function evaluates the specific result (i.e. the Absolute principal stress) on each element
required by the geometry selection
# The input data "step" represents the step on which we have to evaluate the result
def WPS_Eval(result,stepInfo,collector):
global wps_stress
analysis = result.Analysis
ExtAPI.Log.WriteMessage("Launch evaluation of the WPS result: ")
# Reader initialization
reader = analysis.GetResultsData()
reader.CurrentResultSet = stepInfo.set
# Get the stress result from the reader
stress = reader.GetResult("S")
# Unit sytem management:
# First get the unit system that was used during the resolution
# Second compute the coefficient to be used so that the final result will be returned in the
SI unit system
unit_stress = stress.GetComponentInfo('X').Unit
conv_stress = units.ConvertUnit(1.,unit_stress,"Pa","Stress")
# Get the selected geometry
propGeo = result.Properties["Geometry"]
refIds = propGeo.Value.Ids
# Get the mesh of the model
mesh = analysis.MeshData
#Loop on the list of the selected geometrical entities
# Get mesh information for each geometrical entity
elementIds = meshRegion.ElementIds
# Loop on the elements related to the current geometrical entity
for elementId in elementIds:
# Get the stress tensor related to the current element
tensor = stress.ElementValue(elementId,"X;Y;Z;XY;XZ;YZ")
# Get element information
element = mesh.ElementById(elementId)
nodeIds = element.CornerNodeIds
values = []
# Loop on the nodes of the current element to compute the Von-Mises stress on the element nodes
local_wps = WPS(tensor[6*i:6*(i+1)])
# Final stress result has to be returned in theSI unit system
local_wps = local_wps * conv_stress
values.Add(local_wps)
collector.SetValues(elementId, values)
# This function computes the absolute principal stress from the stress tensor
# The Von-Mises stess is computed based on the three eigenvalues of the stress tensor
def WPS(tensor):
64

# Computation of the eigenvalues
eigenvalues = EigenValues(tensor)
# Extraction of the worst principal stress
wplocal_stress = eigenvalues[0]
if abs(eigenvalues[1])>abs(wplocal_stress):
# Return the worst value of the three principal stresses S1, S2, S3
return wplocal_stress
# This function computes the three eigenvalues of one [3*3] symetric tensor
EPSILON = 1e-4
def EigenValues(tensor):
global eigenvalues
eigenvalues = []
a
b
c
d
e
f
=
=
=
=
=
=
tensor[0]
tensor[1]
tensor[2]
tensor[3]
tensor[4]
tensor[5]
if ((abs(d)>EPSILON) or (abs(e)>EPSILON) or (abs(f)>EPSILON)):

# Polynomial reduction
A = -(a+b+c)
B = a*b+a*c+b*c-d*d-e*e-f*f
C = d*d*c+f*f*a+e*e*b-2*d*e*f-a*b*c
p = B-A*A/3
q = C-A*B/3+2*A*A*A/27
if (q<0):
R = -sqrt(fabs(p)/3)
else:
R = sqrt(fabs(p)/3)
phi = acos(q/(2*R*R*R))
S1=-2*R*cos(phi/3)-A/3
S2=-2*R*cos(phi/3+2*3.1415927/3)-A/3
S3=-2*R*cos(phi/3+4*3.1415927/3)-A/3
else:
S1 = a
S2 = b
S3 = c
eigenvalues.Add(S1)
eigenvalues.Add(S2)
eigenvalues.Add(S3)
return eigenvalues
ACT introduces a new method to facilitate the development of Python functions to evaluate simulation
results. The third output argument collector is internally initialized based on the content of the scoping
property. When defined, this property contains the list of FE entities on which results are evaluated.
This information can be used directly in Python functions without looping over mesh regions. The following demonstrates the use of this method in the function WPS_Eval.
import units
wps_stress = {}
eigenvalues = {}
def init(context):
ExtAPI.Log.WriteMessage("Init Demoresult Extension...")
65
def Create_WPS_Result(analysis):
ExtAPI.Log.WriteMessage("Launch Create_WPS_Result...")
analysis.CreateResultObject("Worst Principal Stress")
# This function evaluates the specific result (i.e. the Absolute principal stress) on each element
required by the geometry selection
def WPS_Eval(result,stepInfo,collector):
global wps_stress
analysis = result.Analysis
ExtAPI.Log.WriteMessage("Launch evaluation of the WPS result: ")
reader.CurrentResultSet = stepInfo.Set
# Unit sytem management:
# First get the unit system that was used during the resolution
# Second compute the coefficient to be used so that the final result will be returned in the
SI unit system
unit_stress = stress.GetComponentInfo('X').Unit
# Loop on the elements related to the collector.Ids list
for elementId in collector.Ids:
tensor = stress.ElementValue(elementId,"X;Y;Z;XY;XZ;YZ")
# Get element information
element = mesh.ElementById(elementId)
nodeIds = element.CornerNodeIds
values = []
# Loop on the nodes of the current element to compute the Von-Mises stress on the element nodes
local_wps = WPS(tensor[6*i:6*(i+1)])
# Final stress result has to be returned in theSI unit system
local_wps = local_wps * conv_stress
values.Add(local_wps)
collector.SetValues(elementId, values)
# This function computes the absolute principal stress from the stress tensor
def WPS(tensor):
eigenvalues = EigenValues(tensor)
# Extraction of the worst principal stress
# Return the worst value of the three principal stresses S1, S2, S3
return wplocal_stress
EPSILON = 1e-4
def EigenValues(tensor):
global eigenvalues
eigenvalues = []
a
b
c
d
66
=
=
=
=
tensor[0]
tensor[1]
tensor[2]
tensor[3]

e = tensor[4]
f = tensor[5]
A = -(a+b+c)
p = B-A*A/3
q = C-A*B/3+2*A*A*A/27
if (q<0):
R = -sqrt(fabs(p)/3)
else:
R = sqrt(fabs(p)/3)
phi = acos(q/(2*R*R*R))
S1=-2*R*cos(phi/3)-A/3
S2=-2*R*cos(phi/3+2*3.1415927/3)-A/3
S3=-2*R*cos(phi/3+4*3.1415927/3)-A/3
else:
S1 = a
S2 = b
S3 = c
eigenvalues.Add(S1)
eigenvalues.Add(S2)
eigenvalues.Add(S3)
return eigenvalues
This extension takes advantage of the fact that the collector.Ids property is initialized with the element
numbers related to the selected geometrical entities. This list can be used to evaluate results for each
element. The collector.Ids property contains nodes or element numbers depending on the type
of result defined in the XML file of the extension. For results with the location set to node, collector.Ids
contains a list of node numbers. For results with the location set to elem or elemnode, collector.Ids
contains a list of element numbers.
Creating Results with Imaginary Parts

Creating results for analyses which have complex results requires managing both real and imaginary
values. The SetValues() method is used to set values to the real part of the result. A second method
named SetImaginaryValues() is also available to set values to the imaginary part of the result.
An example of the creation of a complex result is shown below:
def Evaluate(result,stepInfo,collector):
for id in collectors.Ids:
real_value = 1.
# Set the real part of the result
collector.SetValues(id, real_value)
imaginary_value = 2.
# Set the imaginary part of the result
collector.SetImaginaryValues(id, imaginary_value)
Obsolete "OnStartEval" and GetValue" Callbacks

Both callbacks <onstarteval> and <getvalue> have been replaced by the single callback
<evaluate>. The <evaluate> callback simplifies the implementation of an ACT result, which now
requires only a single Python function. The callbacks <onstarteval> and <getvalue> are still
67
supported for extensions developed in previous versions of ACT, but the use of the <evaluate>
callback is recommended for new extension development.
Connecting to a Third-Party Solver

This section discusses how to add a connection to a third-party solver, or the ability to launch an external process from the Mechanical system instead of launching the ANSYS solver. The example used
in this section is defined in the ExtSolver1 extension, which was written to demonstrate the ability
to connect to a very simple solver. This solver distributes the values assigned at boundaries inside the
structure. This example is for demonstration purposes only.
Third-Party Solver Connection Extension

We will begin by looking at the XML required to add a third-party solver in a project, as defined in the
ExtSolver1.xml file.
<simdata context="Project|Mechanical">
<solver name="Solver1" version="1" caption="Solver1" icon="result" analysis="Static" physics="Structural">
<callbacks>
<onsolve>Solve</onsolve>
<getsteps>GetSteps</getsteps>
<getreader>GetReader</getreader>
</callbacks>
<property name="MaxIter" caption="Max. Iterations" control="integer" default="10" />
</solver>
</simdata>
<load name="Values" version="1" caption="Values" icon="tload" issupport="false" isload="true"
color="#0000FF">
<callbacks>
<getsolvecommands>WriteInitialValues</getsolvecommands>
<getnodalvaluesfordisplay>NodeValues</getnodalvaluesfordisplay>
</callbacks>
<property name="Geometry" control="scoping" />
<property name="Expression" caption="Expression" control="text" />
</load>
</simdata>
As with the loads and results features, the solver definition must be encapsulated within a <simdata>
tag. In this example the context attribute is "Project|Mechanical." When "Project" is specified as a
context attribute, the solver appears as a component in the Workbench Project Schematic (see Figure 37: Project Schematic with External Solver System (p. 69)).
The solver definition begins with the tag <solver>. This tag takes some mandatory attributes:
name: internal name of the solver
version: version of the solver
caption: display name of the solver
68

analysis: analysis type addressed by the third-party solver. For compatibility reasons, this attribute must
be set to Static, but this does not prevent you from integrating any type of third-party solver.
physics: physics type addressed by the third-party solver. Today, this attribute must be set to Structural.
This tag as no real impact on what the solver computes.
You must define the callback <onsolve>. This callback is called when the application launches the
solver and thus takes in argument the solver object.
You can define a set of properties, which appear in the details view of the analysis. In the example, a
simple property is created to define the maximum number of iterations to be performed by the solver.
By default the value is set to 10.
Figure 37: Project Schematic with External Solver System (p. 69) shows the new system in the toolbox.
Each third-party solver is added into a new category, identified by the caption of the extension; the
system is named by the caption of the solver.
The system related to the third-party solver is equivalent to one standard system that can be created
with the ANSYS solver. The components that build this new system remain the same. Then the user
can add in the schematic a new system related to the solver just as he does for any other systems.
Figure 37: Project Schematic with External Solver System
Following is the code for the extension (file main.py). The solver code is located in a separate file,
solver.py, which is placed in the same folder as main.py. The third line of the main.py script is
"import solver." This Python technique is using separate code for reuse and maintainability. The script
in solver.py defines the SolverEngine class.
import os
import solver
def CreateValuesLoad(analysis):
analysis.CreateLoadObject("Values")
69
initValues = {}
sol = None
solbystep = {}
values = {}
steps = []
res = [0.]
dScal = [0.]
dVec = [0., 0., 0.]
def WriteInitialValues(load,filename):
global initValues
propEx = load.Properties["Expression"]
exp = propEx.Value
if exp=="":
return None
values = []
propGeo = load.Properties["Geometry"]
refIds = propGeo.Value.Ids
nodeIds = meshRegion.NodeIds
for nodeId in nodeIds:
node = mesh.NodeById(nodeId)
x = node.X
y = node.Y
z = node.Z
v = 0.
try:
v = eval(vexp)
v = float(v)
finally:
initValues.Add(nodeId,v)
def NodeValues(load,nodeIds):
propEx = load.Properties["Expression"]
exp = propEx.Value
if exp=="":
return None
try:
except:
return None
values = []
for id in nodeIds:
x = node.X
y = node.Y
z = node.Z
v = 0.
try:
v = eval(vexp)
v = float(v)
finally:
values.Add(v)
return values
def Solve(s, fct):
global steps
global initValues
global sol
global solbystep
global values
solbystep = {}
solbystepTmp = {}
f = open("solve.out","w")
f.write("SolverEngine version 1.0\n\n\n")
try:
70
maxIter = int(s.Properties["MaxIter"].Value)
f.write("Max. iteration : %d\n" % (maxIter))
mesh = s.Analysis.MeshData
numEdges = 0
geo = ExtAPI.DataModel.GeoData
nodeIds = []
for asm in geo.Assemblies:
for part in asm.Parts:
for body in part.Bodies:
for edge in body.Edges:
numEdges = numEdges + 1
ids = mesh.MeshRegionById(edge.Id).NodeIds
nodeIds.extend(ids)
steps = []
stepsTmp = []
f.write("Num. edges : %d\n" % (numEdges))
sol = solver.SolverEngine(mesh,initValues,nodeIds)
initValues = sol.Run(maxIter,f,stepsTmp,solbystepTmp)
nodeIds = mesh.NodeIds
sol = solver.SolverEngine(mesh,initValues,nodeIds)
values = sol.Run(maxIter,f,steps,solbystep)
initValues = {}
except StandardError, e:
f.write("Error:\n");
f.write(e.message+"\n");
f.close()
return False
f.close()
return True
def GetSteps(solver):
global steps
return steps
def Save(folder):
global solbystep
fm = System.Runtime.Serialization.Formatters.Binary.BinaryFormatter()
try:
stream = System.IO.StreamWriter(os.path.join(folder,"sol.res"),False)
except:
return
try:
fm.Serialize(stream.BaseStream,solbystep)
finally:
stream.Close()
def Load(folder):
global solbystep
if folder==None:
return
fm = System.Runtime.Serialization.Formatters.Binary.BinaryFormatter()
try:
stream = System.IO.StreamReader(os.path.join(folder,"sol.res"))
except:
return
try:
solbystep = fm.Deserialize(stream.BaseStream)
finally:
stream.Close()
class ExtSolver1Reader(ICustomResultHeader):
def __init__(self,infos):
self.infos = infos
self.step = 1
71
def GetCurrentStep(self):
return self.step
def SetCurrentStep(self,stepInfo):
self.step = stepInfo
def GetStepValues(self):
global steps
return steps
def GetResultNames(self):
return ["VALUES"]
def GetResultLocation(self,resultName):
return ResultLocationEnum.Node
def GetResultType(self,resultName):
return ResultTypeEnum.Scalar
def GetComponentNames(self,resultName):
return [""]
def GetComponentUnit(self,resultName,componentName):
return "Temperature"
def GetValues(self,resultName,collector):
global solbystep
if self.step.Set in solbystep:
values = solbystep[self.step.Set]
for id in collector.Ids:
if id in values:
collector.SetValues(id, [values[id]])
def GetReader(solver):
return ["ExtSolver1Reader"]
The function associated to the <onsolve> callback is Solve. This function creates a file solve.out,
which is read interactively by the application and stored in the solution information.
By default, the application launches the resolution directly into the working directory, so it is not necessary to set the folder in which the solve.out file must be created.
The callback function must return True or False to specify if the solve has succeeded or failed.
Note that it is not possible to return progress information with the current version.
Post Processing
You can create a result reader to expose results.
To do that, you create a class that implements the ICustomResultReader interface. The following
methods need to be implemented. For each method, the expected results that must be returned are
described.
GetCurrentStep(self)
This method must return the current step number.
SetCurrentStep(self,stepInfo)
This method is called each time the current step number is changed.
GetStepValues(self)
This method must return a lost of double values that represents the time steps or frequencies.
72

GetResultNames(self)
This method must return a list of strings that represents the result names available for the reader.
GetResultLocation(self,resultName)
This method must return the location type of the result identified by the name resultName. The possible
values are node, element, and elemnode.
GetResultType(self,resultName)
This method must return the type of the result identified by the name resultName. The possible values
are scalar, vector, and tensor.
GetComponentNames(self,resultName)
This method must return a list of strings that represents the list of available components available for the
result identified by the name resultName.
GetComponentUnit(self,resultName,componentName)
This method must return the unit name related to the results component identified by the result name
resultName and the component name componentName.
GetValues(self,resultName,collector)
This method must return a list of double values for each component associated to the result identified by
the name resultName.
To specify a dedicated reader, add a <getreader> callback in the solver definition. This callback returns
a list of string, where the first is the name of the reader class and the remainder represents parameters
given to the constructor of the class when the reader is instanced by ACT. Any result exposed in the
method ResultNames() will be available in Mechanical's Results worksheet.
If the name of the result matches a standard result name (like "U"), Workbench applies the same treatment
for this result than for a standard one. So, if the result is named "U", Workbench uses this result to draw
the deformed model.
In the Extsolver1 example, the reader declares one single scalar nodal result VALUES". No deformation is considered.
Load and Save Data

It is possible to use the callbacks <onload> and <onsave> under the <interface> tag to load
and save data associated with the third-party solver. As previously discussed, the proposed extension
uses the <onload> and <onsave> callbacks to save and load the computed results. With the current
extension, the results are still available if the user closes and reopens the Solver1 system.
The <onload> and <onsave> callbacks take in argument the name of the working directory.
Figure 38: Analysis Settings Object Associated to External Solver (p. 74) and Figure 39: Boundary Condition
Object Associated to External Solver (p. 74) show the specific objects that must be integrated in the
definition tree in order to set up an analysis based on the external solver.
73
Figure 38: Analysis Settings Object Associated to External Solver
Figure 39: Boundary Condition Object Associated to External Solver
74

Figure 40: Solution Information Associated to External Solver (p. 75)a nd Figure 41: Post-processing Associated to External Solver (p. 76) show the two types of output derived from the resolution. Note that
the solution information is interactively displayed during the resolution.
Figure 40: Solution Information Associated to External Solver
75
Figure 41: Post-processing Associated to External Solver

This section discusses customization of the ANSYS DesignModeler application. Whereas in the ANSYS
Mechanical application ACT is used to work with loads and results, in DesignModeler it is instead used
to work with geometries. Once you have used ACT to add custom toolbars and menus to the DesignModeler user interface, you can use those entities to generate geometries by creating and using a
primitive generator, defining properties, and applying various operations to the resulting geometry.
This example extension, GeometryFeature, shows how to add a geometry to DesignModeler. This
example is for demonstration purposes only.
The GeometryFeature extension was written to create a geometry based on an existing part. As
part of this process, we will draw a circle, define a disc based on the circle, and extrude the disc into a
cylinder.
The following topics are discussed:
Geometry Definition in the XML File
Geometry Definition in the Python File
Geometry Definition in the XML File

The XML file for our example is called GeometryFeature.xml and is shown below.
<extension version="1" name="GeometryFeature">
<interface context="DesignModeler">
<toolbar name="ACTtoolbar" caption="ACTtoolbar">
76

<entry name="MyFeature" icon="construction">
<callbacks>
<onclick>createMyFeature</onclick>
</callbacks>
</entry>
</toolbar>
</interface>
<simdata context="DesignModeler">
<geometry name="MyFeature" caption="MyFeature" icon="construction" version="1">
<callbacks>
<ongenerate>generateMyFeature</ongenerate>
<onaftergenerate>afterGenerateMyFeature</onaftergenerate>
</callbacks>
<property name="Face" caption="Face" control="scoping">
<attibutes selection_filter="face"/>
</property>
<property name="Length" caption="Length" control="float" unit="Length" default="1.2 [m]"></property>
<property name="Minimum Volume" caption="Minimum Volume" control="float" unit="Volume" >
<attributes readonlyaftergenerate="true" />
</property>
</geometry>
</simdata>
</extension>
As in previous examples, the XML first defines the extension using a version and name attribute. The
path to the Python script file main.py is specified by the <script> tag. The ACT toolbar is defined
in the <interface> tag, which has a context of DesignModeler. The callback function named createMyFeature is used to create and add the geometry to the DesignModeler environment.
The definition of the geometry is encapsulated by the <simdata> begin and end tags. The attributes
in the <geometry> begin tag provide the name, caption, icon, and version that apply to this geometry.
The geometry <callbacks> tag encapsulates two callbacks <ongenerate> and <onaftergenerate>.
The tag <ongenerate> specifies the name of the Python function that is called when the geometry is
generated by the application. The application provides the geometry type (type IDesignModelerGeoFeature) as the callback argument.
This callback must return a Boolean value to indicate whether the generation has been successful; it
returns true if the generation has succeeded and false if it has failed.
The tag <onaftergenerate> specifies the name of the Python function that is called after the geometry
is generated by the application. The application provides the geometry type (type IDesignModelerGeoFeature) as the callback argument.
To specify additional details about the geometry, you can include additional tags, such as <canadd>,
<onadd>, <oninit>, or <onmigragte> between the <callbacks> begin and end tags.
of the geometry (in this example, Face and Length). These properties are displayed in the Details View
pane of ANSYS DesignModeler, where the user provides the necessary values to complete the geometry
definition. When we review the Python script in a subsequent section, we will see how the geometry
properties can be retrieved and/or modified.
The following figure shows that each property defined above appears in the Details View pane with
the corresponding names and types of interface control.
77
Figure 42: Feature and Corresponding Properties in the Details View Pane
Note that the two geometry properties, Face and Length, use different control types.
The Face property uses a scoping control type with the attribute of selection_filter set to face.
This specifies that the value for this property will be one or more faces. The faces will be defined in the
main.py file and then used to generate our geometry.
The Length property uses a float control type, and does not require the definition of one specific callback.
Instead, the XML definition introduces a physical quantity dependency with the unit attribute, which
specifies that this property is consistent with a length. The default attribute specifies a default value
of 1.2[m]; this default value is exposed in the Details View pane each time a new load is created.
Geometry Definition in the Python File

The Python file for our example is called main.py and is shown below. We will discuss the Python
functions associated with the <ongenerate> and <onaftergenerate> callbacks.
import units
import math
def createMyFeature(feature):
ExtAPI.CreateFeature("MyFeature")
def vectorProduct(v1, v2):
return [v1[1]*v2[2]-v1[2]*v2[1], -v1[0]*v2[2]+v1[2]*v2[0], v1[0]*v2[1]-v1[1]*v2[0]]
def scalarProduct(v1, v2):
return v1[0]*v2[0]+v1[1]*v2[1]+v1[2]*v2[2]
def norm(v):
return math.sqrt(scalarProduct(v,v))
def generateMyFeature(feature,function):
length = feature.Properties["Length"].Value
length = units.ConvertUnit(length, ExtAPI.DataModel.CurrentUnitFromQuantityName("Length"), "m")
faces = feature.Properties["Face"].Value.Entities
bodies = []
builder = ExtAPI.DataModel.GeometryBuilder
78

for face in faces:
centroid = face.Centroid
uv = face.ParamAtPoint(centroid)
normal = face.NormalAtParam(uv[0], uv[1])
radius = math.sqrt(face.Area/(math.pi*2))
xdir = [1., 0., 0.]
vector = vectorProduct(xdir, normal)
if norm(vector)<1.e-12:
xdir = [0., 1., 1.]
s = scalarProduct(xdir, normal)
xdir = [xdir[0]-s*normal[0],xdir[1]-s*normal[1],xdir[2]-s*normal[2]]
n = norm(xdir)
xdir[0] /= n
xdir[1] /= n
xdir[2] /= n
arc_generator = builder.Primitives.Wire.CreateArc(radius, centroid, xdir, normal)
arc_generated = arc_generator.Generate()
disc_generator = builder.Operations.Tools.WireToSheetBody(arc_generated)
normal[0] *= -1
normal[1] *= -1
normal[2] *= -1
extrude = builder.Operations.CreateExtrudeOperation(normal,length)
cylinder_generator = extrude.ApplyTo(disc_generator)[0]
bodies.Add(cylinder_generator)
feature.Bodies = bodies
feature.MaterialType = MaterialTypeEnum.Add
return True
def afterGenerateMyFeature(feature):
edges = []
minimum_volume = System.Double.MaxValue
for body in feature.Bodies:
body_volume = 0
if str(body.BodyType) == "GeoBodySolid":
body_volume = body.Volume
if body_volume <= minimum_volume:
minimum_volume = body_volume
edges.Add(edge)
else:
ExtAPI.Log.WriteMessage("Part: "+body.Name)
feature.Properties["Minimum Volume"].Value = minimum_volume
ExtAPI.SelectionManager.NewSelection(edges)
named_selection = ExtAPI.DataModel.FeatureManager.CreateNamedSelection()
ExtAPI.SelectionManager.ClearSelection()
Functions Associated with the <ongenerate> Callback

Below, we will describe the Python functions associated with the <ongenerate> callback.
The function createMyFeature(feature) creates the geometry in the DesignModeler tree. It will
be displayed as My Feature in the Tree Outline.
The mathematical functions vectorProduct and scalarProduct will be used later in the generateMyFeature function.
The first several functions configure details that will be used later in the creation of the geometry.
79
In our example, the function generateMyFeature is referenced in the GeometryFeature.xml
file by the <ongenerate> callback. When called, it generates the geometry feature. Within this function,
the following details about the geometry are defined:
The length property, which will be used later to create the primitive. The conversion of the length unit
ensures that we are working with the expected metric unit.
The scoped face property, which in this example is three faces.
The bodies list, where we will add all the geometric features to be created.
The builder, which serves as the ACT gateway in DesignModeler. We will access all features and operations
from here.
The faces variable, which will be used as the argument to create our circle. Under faces:
Define the centroid of the scoped face.
Evaluate the normal to this face.
Evaluate the radius that will be used for our arc wire.
Calculate the xdir, which is the principle direction of the arc wire defined below and is required to draw
our arc.
The vectorProduct and scalarProduct objects are used to specify the location of the geometrys
primitives and operations.
The next several objects generate an arc wire.
With the arc_generator object, we use the primitive generator builder.Primitives.Wire.CreateArc. The CreateArc() method uses arguments from faces to draw the circle. This generator can
be used one or more times to build the primitive body.
With the arc_generated object, we use the Generate() method to generate the primitive body.
With the disc_generator object, we use the operations generator builder.Operations.Tools.WireToSheetBody to define a disc based on the circle.
The next several lines extrude the disc into a cylinder.
With the extrude object, we use the operations generator builder.Operations.CreateExtrudeOperation. The CreateExtrudeOperation specifies that the resulting extrusion will be equal to
the value of the Length property.
With cylinder_generator object, we use the ApplyTo method to define the geometry to which
the extrude operation will be applied. The ApplyTo() method returns a list of bodies to which the operation will be applied.
Bodies added to the feature.Bodies list will be added to DesignModeler after the generation. All other
bodies used in the generation process will be lost.
The feature.Bodies list can contain both bodies and parts. We can create a part with the command
builder.Operations.Tools.CreatePart(list_of_bodies).
80

The material.Type allows us to enter different properties such as Freeze, Cut, and Add. The image
below illustrates the resulting geometry given selection of the different properties.
Figure 43: Effect of different material type properties on the geometry
Functions Associated with the <onaftergenereate> Callback

Below, we will describe the Python function associated with the <onaftergenerate> callback, which
specifies the name of the IronPython function called when the <ongenerate> callback is complete.
The <onaftergenerate> callback:
Allows you to access and work with the part or bodies created previously by the <ongenerate>
callback.
For example, you can use it rename a part or body, suppress it, create a named selection, create
a new selection via the Selection Manager, or access one or more of the geometric features of
a body as its area.
Unlike the <ongenerate> callback, which expects a return value of True or False, does not expect
a return value.
Allows you to define properties for the feature to be created.
In our example, the function afterGenerateMyFeature is referenced in the GeometryFeature.xml file by the <ongenerate> callback. It accepts only the feature itself as an argument. When
called, it specifies the properties and attributes of the feature and selects edges of the bodies created,
as described below:
The edges list, where we will add all the edges of the bodies to be created for the feature.
The Minimum Volume property, which in this example will be the volume of the body with the smallest
volume of all the bodies created for the feature. It uses a float control type and uses the unit attribute
to specify a value consistent with a volume. Because this property has the special attribute
readonlyaftergenerate set to true, the value becomes non-editable after generation of the
feature.
The edge variable, which will be used to find the edges of all the bodies created for the feature.
81
The feature.Properties[Minimum Volume"].Value entry sets the Minimum Volume
property in DesignModeler to the minimum_volume value.
The ExtAPI.SelectionManager.NewSelection(edges) command creates a new selection
including all the edges previously selected.
The named_selection = ExtAPI.DataModel.FeatureManager.CreateNamedSelection() command creates a named selection which will be defined by the current selection containing
all the edges previously selected.
Figure 44: Feature, Named Selection, and Properties in DesignModeler

This section discusses how to define functionality for ANSYS DesignXplorer. The ANSYS DesignXplorer
application is the ANSYS Workbench add-in that offers design exploration and optimization features.
You can create an ACT extension to integrate external functionality with the standard ANSYS
DesignXplorer (DX) application. A DOE Extension integrates one or more external sampling methods,
while an Optimization Extension integrates one or more external optimization methods.
From a user-interface point of view, the sampling or optimization method, along with specific properties
to control its behavior, is hosted and exposed in DX as an additional method. Through its API, DX
provides the services required the calculation of points, report progress, and return results. The enduser experience is the same for both built-in and external methods of optimization or sampling.
From a development point of view, a sampling or optimizer is defined as a standard ACT extension that
includes one or more specific elements for the DesignXplorer context. A required callback, which allows
for the instantiation of the external method, is a class generally coded in C#, C/C++ or Fortran by the
extension developer. The callback class must implement the method interface (ISamplingMethod
or IOptimizationMethod) in order for the sampling or optimizer to be recognized as valid and interact with DX.
82

DX takes advantage of the ANSYS Workbench platform to allow parametric studies in a generic way for
any simulation project. Regardless of the number of solvers and physics or the complexity of the
workflow involved to execute the simulation, DX sees the same simplified representation of the project
and interacts with it only in terms of parameters, design points, and the associated services.
Figure 45: DesignXplorer DOEs in an ANSYS Workbench Project
This generic architecture makes it possible to implement a variety of algorithms without needing to
worry about the communication with solvers. Since the external methods are hosted by DX, they also
take advantage of the ANSYS Workbench platform architecture to work with any kind of simulation
project defined in ANSYS Workbench, with no additional implementation effort.
The Design Exploration Process
Implementing a DX Extension
Notes on Method Class Implementation
The Design Exploration Process

The external functionality defined by the extension is responsible for carrying out relevant analysis tasks
as defined by the DX user; the external optimizer is responsible for solving the optimization study, and
the external sampling is responsible for generating the DOE. Note that the external functionality is not
required to support all the features available in DX. On the other hand, since the sampling or optimizer
is hosted in the DX environment, it is subject to the environments limitations; as such, some of the
external features may not be available in DX.
The DOE and optimization study are defined as follows:
Design of Experiments
Optimization Study
Variables
Variables
DOE domain
Optimization domain
83
Optimization Study
Parameter relationships
Objectives
Constraints
The Variables are the parameters of the Workbench project. As there are input and output parameters,
there are input and output variables for the sampling or optimization. Note that, since the user can
disable input parameters, the number of input variables transferred to the external functionality is
smaller than or equal to the number of input parameters defined in the Workbench project.
The Domain is the multidimensional space that the sampling or optimizer can explore in order to
generate the DOE or solve the optimization problem. It is defined by the input variables and their range
of variation or as a list of possible values. There are different types of input variables:
Double Variable:
Continuous variable defined by a range of variation, from its lower to its upper bound, where the bounds
are real values
Exposed to the user as a Continuous Input Parameter
Double List Variable:
Defined by a list of sorted real values
Exposed to the user as a Continuous Input Parameter with Manufacturable Values
Integer List Variable:
Defined by a list of integer values
Exposed to the user as a Discrete Input Parameter
The optimization Parameter Relationships define relationships between input variables such as
P1+2*P2 <= 12.5[mm]". They allow the user to restrict the definition of the optimization domain.
The optimization Objectives are defined on variables (e.g., Minimize P3). The following objective types
are supported:
Minimize a variable
Maximize a variable
Seek Target for a variable, where the target is a user-specified constant value
The optimization Constraints are defined on variables, as well (e.g., P3 <= 80). Both an objective and
a constraint can be defined for the same variable. The following constraint types are supported:
Less Than, where the user defines the lower bound (constant value)
Greater Than, where the user defines the upper bound (constant value)
Equal To, where the user defines the target value (constant value)
84

Inside Bounds, where the user defines the targeted interval (constant values)
The DX Component
DX exposes several types of systems in Workbench, with each system type corresponding to one of its
parametric features such as Parameters Correlation, Response Surface, Six Sigma Analysis, etc. DX
components can be found in the Design Exploration toolbox.
The DOE Component

The DOE component appears in two different kinds of DOE systems, the Response Surface system and
the Response Surface Optimization system. It provides a selection of built-in sampling methods. Each
sampling method comes with its own specific standard and advanced properties, capabilities, and limitations.
Figure 46: DesignXplorer Systems Containing DOEs in the Design Exploration Toolbox
The Optimization Component

The Optimization component appears in two different kinds of optimization systems, the Direct Optimization system and the Response Surface Optimization system. It provides a selection of built-in
optimization methods. Each method comes with its own specific standard and advanced properties,
capabilities, and limitations.
Figure 47: DesignXplorer Optimization Systems in the Design Exploration Toolbox
Direct Optimization system:

The system is composed only of an Optimization component.
Each point requested by the optimizer is calculated by updating a design point (real solve).
With this approach:
The optimizer manipulates accurate output parameter values (directly returned by the solver).
The number of input parameters is not limited. However, the cost is proportional to the number of
points.
85
Response Surface Optimization system:
The system is composed of three components (Design of Experiments, Response Surface, and Optimization).
Each point requested by the optimizer is calculated by evaluating the response surface.
With this approach:
The optimizer manipulates approximated output parameter values.
The number of input parameters is limited by the ability to generate the response surface. However,
the cost is extremely low because the resources needed to evaluate the response surface are negligible.
The optimization is performed as a post-processing operation based on the response surface, so several
alternative optimization studies can be performed very quickly on the same surface.
The DX Extension
External DOEs and optimizers can be packaged and installed as Workbench extensions. When the extension is installed and loaded, DX detects the external DOEs or optimizers and exposes them as additional options in the DesignXplorer component. If the user selects one of these custom methods, DX
delegates to the selected external option; it delegates sampling resolution to the external sampling
and optimization resolution to the external optimizer. Note that when an external option is used, the
Workbench session is journaled and can be replayed as usual.
The extension is a container for one or more DOEs or optimizers. The DOEs and optimizers themselves
are generally provided as compiled libraries included in the .wbex extension file.
Implementing a DX Extension
A DX extension has three main parts:
XML file that declares, defines and configures the extension
Python scripts that implement callbacks
ISamplingMethod or IOptimizationMethod implementation, which is the adapter to your existing
implementation. This is typically achieved in C# or IronPython.
This section describes each of these pieces and includes references to several examples of functional
DX extensions.
Implementation Requirements
The implementation of a DX extension requires:
ANSYS Workbench installation
ANSYS Customization Suite license
IronPython, which is provided as part of ANSYS Workbench in the directory <installdir>\commonfiles\IronPython
Microsoft Visual Studio 2010 SP1 for C# implementation
86

Microsoft Visual Studio 2010 SP1 or equivalent for C/C++ implementation
DX Extension Definition and Configuration

As with any other type of extension, a DX extension is defined and configured by an XML file that
identifies the extension (version, name, author, description) and provides the following main entry
points:
Filename of the main Python script (as specified by the <script> element)
Name of the Python function to invoke when initializing the extension (as specified by the OnInit callback)
In a DX extension, the OnInit callback is the correct place to load the DLL containing the external
sampling. Another callback named OnTerminate is invoked when the extension is unloaded and is
the correct place to perform cleanup operations and unload the DLL.
The specificity of a DX extension is to define external sampling or optimization methods to be used by
DX. The definitions are encapsulated in a <simdata> element, where the context attribute is set to
DesignXplorer. The main elements used to declare and define the DOEs are shown in Figure 48: Declaration and Definition of an External DOE (p. 87). The main elements used to declare and define the
optimizers are shown in Figure 49: Declaration and Definition of an External Optimizer (p. 88).
Figure 48: Declaration and Definition of an External DOE
In Figure 48: Declaration and Definition of an External DOE (p. 87), the DOE defined is called FullFactorial.
The two attributes framed in red are examples of capabilities being defined for this DOE. Here we can
see that for FullFactorial:
The LogFile attribute is set to true, so the sampling has the capability to use the DX API to generate a
log file in the Workbench project.
The CustomTable attribute is set to false, so the DOE does not have the capability to handle the custom
table available in DX.
87
All other capabilities are configured per the default values. For a listing of capabilities, see DX Extension
Capabilities (p. 89).
The callbacks to hook up with DX are framed in blue. Note that the OnCreate callback, which is invoked
to obtain an ISamplingMethod instance, is mandatory. All other callbacks are optional.
Finally, all of the properties declared for the DOE in Figure 48: Declaration and Definition of an External
DOE (p. 87) are framed in orange. These properties allow the user to control specific settings of the
algorithm, access relevant output information (e.g. number of levels or status), or whatever else the
DOE needs to expose as a result of the sampling run.
Figure 49: Declaration and Definition of an External Optimizer
In Figure 49: Declaration and Definition of an External Optimizer (p. 88), the extension is named MyOptimizer and defines two different external optimizers. The declaration for each optimizer is marked with
a green bracket. Each optimizer will be managed by DX as an independent optimization method.
In Figure 49: Declaration and Definition of an External Optimizer (p. 88), the first optimizer defined is
called MyOptimizer. The two attributes framed in red are examples of capabilities being defined for
this optimizer. Here we can see that for MyOptimizer:
88

The SeekObjective attribute is set to false, so the optimizer does not have the capability to handle
the Seek Target objective available in DX.
The LogFile attribute is set to true, so the optimizer has the capability to use the DX API to generate a
log file in the Workbench project.
All other capabilities are configured per the default values. For a listing of capabilities, see Optimization
Example (p. 90).
The callbacks to hook up with DX are framed in blue. Note that the OnCreate callback, which is invoked
to obtain an IOptimizationMethod instance, is mandatory. All other callbacks are optional.
Finally, all of the properties declared for the optimizer in Figure 49: Declaration and Definition of an
External Optimizer (p. 88) are framed in orange. These properties allow the user to control specific
settings of the algorithm, access relevant output information (e.g. number of iterations, final convergence
metrics, status), or whatever else the optimizer needs to expose as a result of the optimization run.
DX Extension Capabilities
A DX extension is designed to solve a specific range of problems, and its implementation is characterized
by complementary features and limitations. To allow DX to determine when a given sampling or optimization method is applicable, depending on the current DOE or optimizer definition, it is necessary to
declare the main capabilities of each external method. There are also optional capabilities used by DX
to adjust the user interface according to what complementary features are supported by the external
method.
For external DOEs, the capabilities are specified in the XML file as attributes of the <sampling> element.
For external optimizers, the capabilities are specified in the XML file as attributes of the <optimizer>
element.
Main Capabilities
The main capabilities are used to determine if the external sampling or optimization method can be
applied to the problem as it is currently defined. If the external method has the required capabilities,
it is available as a menu option in the DX Properties view (applicable external samplings are available
in the Design of Experiments Type menu, and applicable optimizers are available in the Method Name
menu). If an external method is not applicable, it is not listed as a menu option. Each modification to
the DOE or optimization study (e.g. modifying an existing input parameter, enabling or disabling an
input parameter, etc.) triggers an evaluation of the relevant capabilities to reassess whether the external
method is applicable and will be made available to the user.
DOE Example
The external sampling FullFactorial, defined previously in Figure 48: Declaration and Definition of an External DOE (p. 87), has MaximumNumberOfInputParameters capability equal to 10. As a consequence,
as soon as the user defines more than 10 input parameters, FullFactorial is removed from the list of
available sampling methods. If the user then changes the DOE study so that the number of input parameters
is less than or equal to 10, FullFactorial is immediately restored as an available option.
Note that if the user selects FullFactorial first and defines more than 10 input parameters afterward,
the sampling method is retained. Given the incompatibility of the sampling method and the number
of input parameters, however, the state of the DOE will turn to Edit Required and a Quick Help
message will be provided to explain why the sampling cannot be launched as currently configured.
89
The external optimizer MyFirstOptimizer, defined previously in Figure 49: Declaration and Definition of
an External Optimizer (p. 88), does not have the SeekObjective capability. As a consequence, as soon
as the user defines a Seek Target objective, MyFirstOptimizer is removed from the list of available optimization methods. If the user then changes the optimization study so that the Seek Target objective is no
longer defined, MyFirstOptimizer is immediately restored as an available option.
Note that if the user selects MyFirstOptimizer first and defines the unsupported Seek Target objective afterward, the optimization method is retained. Given the incompatibility of the optimization
method and the objective, however, the state of the Optimization will turn to Edit Required and
a Quick Help message will be provided to explain why the optimization cannot be launched as
currently configured.
The table below notes the main capabilities controlling the availability of external methods.
DOE
Optimizer
MaximumNumberOfInputParameters
MaximumNumberOfInputParameters
MaximumNumberOfDoubleParameters
MaximumNumberOfDoubleParameters
MaximumNumberOfDoubleListParameters
MaximumNumberOfDoubleListParameters
MaximumNumberOfIntegerListParameters
MaximumNumberOfIntegerListParameters
ParameterRelationship
ObjectiveOnInputParameter
ConstraintOnInputParameter
MinimizeObjective
MaximizeObjective
SeekObjective
LessThanConstraint
GreaterThanConstraint
EqualToConstraint
InsideBoundsConstraint
MinimumNumberOfObjectives
MaximumNumberOfObjectives
MinimumNumberOfConstraints
MaximumNumberOfConstraints
BasedOnResponseSurfaceOnly
90

BasedOnDirectOptimizationOnly
For a comprehensive list of capabilities, see the "Sampling" and "Optimizer" sections in the ANSYS ACT
API Reference Guide and ANSYS ACT XML Reference Guide.
Optional Capabilities
The optional capabilities are used to enable or disable specific options or features of DX according to
the level of support provided by the selected external method. After the main capabilities have established that a method is applicable to a given DOE or optimization study, the optional capabilities determine which features will be exposed for that method in the DX user interface.
For example, the LogFile capability is declared for the sampling defined in Figure 48: Declaration and
Definition of an External DOE (p. 87), FullFactorial, and also for the optimizer defined in Figure 49: Declaration and Definition of an External Optimizer (p. 88), MyFirstOptimizer. As a result, the corresponding
features to manage and expose the log file are enabled in DX and exposed in the user interface. If this
capability was not declared or was set to false, DX would adjust its user interface to hide the access
to the log file because it is not supported by this external method.
As additional examples:
If the selected sampling does not support the Custom Table capability, the Custom Table is not available
in the user interface.
If the selected optimizer does not support the Maximize objective type, then the objective types available
in the user interface are limited to Minimize and Seek Target.
If the optimizer does not support importance levels on objectives, the Objective Importance property is
not available in the Property view of the optimization criterion.
For a comprehensive list of capabilities, see the "Sampling" and Optimizer" sections in the ANSYS ACT
API Reference Guide and ANSYS ACT XML Reference Guide.
Notes on Method Class Implementation

An implementation of the main interface method class (ISamplingMethod for DOE and IOptimizationMethod for optimization) is mandatory in order for a DX extension to be valid. This method
class is the core of the extension; it is the object that is delegated the responsibility to generate the
sampling or solve the optimization study.
If you start a completely new implementation of the sampling or optimization algorithm, you might
consider writing a C# class that derives directly from the method class, as provided by the PublicAPIs
assembly.
If you start from an existing code, either in C/C++ or FORTRAN code, you should consider implementing
your method class in IronPython as an adapter to your algorithm implementation, wrapping your existing
classes and/or routines.
Both approaches are illustrated by the extension examples listed in DesignXplorer Extension Examples (p. 208).
For full reference documentation of the API, see the "API Description" section in the ANSYS ACT API
Reference Guide.
91
Notes on Monitoring
Notes on Sampling Monitoring
DX provides user interface elements that allow the user to monitor the progress of a sampling, in addition
to the progress and log messages.
Notes on Optimization Monitoring

DX provides user interface elements that allow the user to monitor the progress of an optimization. In
addition to the progress and log messages, the API allows the external optimizer to optionally provide
DX with progress data such as history and convergence values.
The history values are values of the input and output variables and show how the optimizer explores
the parametric space. In the user interface, history values are rendered graphically, as a 2D chart per
objective and/or input parameter, where the X axis represents points or iterations and the Y axis represents the parameter values. For more information, see Using the History Chart" in the DesignXplorer
Users Guide.
The X axis can be configured in the XML file to represent points or iterations with the HistoryChartXAxisType attribute of the optimizer element (byPoint or byIteration).
To provide history values during the execution of IOptimizationMethod.Run(), the optimization
method can call IOptimizationServices.PushHistoryPoint(IOptimizationPoint
point) where point contains a value for some or all enabled input and output variables.
The convergence values are independent from the variables. They are the values of one or more convergence metrics, specific to your optimizer and showing its convergence during the process. In the
user interface, convergence values are rendered graphically, as a 2D chart with one or several curves.
For more information, see Using the Convergence Criteria Chart" in the DesignXplorer Users Guide.
To provide convergence values during the execution of IOptimizationMethod.Run(), the optimization method can call IOptimizationServices.PushConvergenceData (IConvergenceData data)where data contains the values for one or several convergence criteria.
Notes on Results
Notes on Sampling Results
The DOE post-processing is similar for all DOE methods. It is based on results data rendered graphically
and/or as tables in the user interface.
Once the DOE is generated, DX extracts all results provided by the sampling in order to generate postprocessing tables and charts:
Sample points from the ISamplingMethod.Samples property
Notes on Optimization Results

The optimization post-processing is similar for all optimization methods. It is based on results data
rendered graphically and/or as tables in the user interface.
Once the optimization study is solved, DX checks IOptimizationMethod.PostProcessingTypes
and extracts all results provided by the optimizer in order to generate post-processing tables and charts:
92

Candidate points from the IOptimizationMethod.Candidates property
Sample points from the IOptimizationMethod.Samples property
Pareto fronts from the IOptimizationMethod.ParetoFrontIndex property
In some cases, DX builds missing results if one of these result types is not supported. For example, if
the optimization method provides the sample points without the candidate points, DX applies its own
sorting logic to generate the candidate points based on objectives and constraints definitions. If the
optimizer provides the sample points without the Pareto fronts indices, DX builds missing data based
on objectives and constraints definitions.

With ACT, you can take your custom external applications and processes and integrate them into the
ANSYS Workbench workflow. Features exposed by ACT also enable you to perform automation and
customization activities, such as creating new systems to facilitate interaction with the Workbench
Project Schematic. The ACT API delivers, in an improved and streamlined offering, functionality previously
available only through the External Connection add-in or the SDK.
This section discusses the following topics:
Exposing Custom Taskgroups and Tasks on the Project Schematic
Using Global Callbacks to Invoke Custom Schematic Actions
The Custom Workflow Creation Process
Creating the Extension Definition XML File
Creating the IronPython Script
Exposing Custom Taskgroups and Tasks on the Project Schematic

You can use ACT to create custom taskgroups and custom tasks on the Project Schematic.
Taskgroups contain tasks; in Workbench, task groups are exposed as custom systems. Once defined and
added to the Workbench Toolbox, an ACT-defined taskgroup can be added to the Project Schematic
workflow in the same way as an installed (Workbench-defined) system.
Tasks are contained in taskgroups; in Workbench, ACT-defined tasks can be exposed as custom components.
Both custom tasks and external tasks (Workbench components, i.e. defined outside the extension) can be
added to a custom taskgroup.
The figure that follows shows a Workbench Mesh Transfer taskgroup that takes an upstream mesh and
passes it to a downstream Fluent taskgroup. For details, see the Generic Mesh Transfer (p. 229) example.
93
Figure 50: End-to-End Mesh Transfer Between Mesh, Mesher, and Fluent Setup
Using Global Callbacks to Invoke Custom Schematic Actions

ACT global callbacks provide hooks that listen and respond to activity on the Workbench Project
Schematic. You can use these hooks to define custom processes or actions to be executed at specific
times in the Workbench schematic workflow.
Schematic callback support is accomplished with a new feature, Action Observation. This feature
provides notification before and after every action processed by the schematic; this enables ACT to
identify a point in the workflow so you can specify that a custom action be executed either before or
after that point. Both pre- and post-action callback support has been added to eleven distinct schematic
actions (such as Create, Update, Refresh, etc.)
ACT does not observe schematic activities until at least one extension provides one callback for a
schematic action. At that time, ACT starts observing the requested schematic action and invokes your
callback. Most of the schematic callbacks receive a user task as an argument. (For details, see the ACT
API documentation.)
94

Once observations of schematic actions have begun, a user-registered schematic callback is invoked
for every component that exists in the Project Schematic; this applies to both installed (Workbenchdefined) and custom (ACT-defined) tasks. For example, if you create an analysis system and update the
project, ACT will invoke the update-related callbacks up to n times, where n = number of components
(tasks) in the system (task group).
You can manipulate the schematic observation process as follows:
Accessing Information:
From the user task, you can access name information, template information, properties, and the tasks
underlying container via the InternalObject property.
Querying:
For queries, you can alter the schematic actions return value in the post-execution callback.
Aborting an Action:
To abort a schematic action, you can throw an exception from the pre-execution callback.
Filtering Components:
To process only the callback for a specific task or template, you must filter the components by performing
a check inside the callback implementation based on the supplied argument(s).
For example, you can access the task names or containers to decide whether or not to take action.
If the action must apply only to all Fluent Setup components, you would create an update callback
that contains the following code:
def myPostUpdateCallback(task):
if container != None and container.Type.Equals('Ansys.Fluent.Addin:SetupContainer'):
#perform your post-update action on the fluent setup container
Stopping Observations:
When you unload all extensions that register schematic callbacks, ACT will cease observing schematic actions.
This sets Workbench back to its prior state and can be used as a fix if schematic observations cause unexpected behavior.
The Custom Workflow Creation Process

As with any other type of extension, creating taskgroups and tasks to be exposed in a Workbench
workflow involves the creation, installation, and loading of the custom workflow extension.
At minimum, you must create the XML extension definition file, the IronPython script, and any support
files (such as taskgroup and task images and custom application executables). Then you must install
the extension as described in Installing a Scripted Extension (p. 26).
The IronPython script and support files should be placed in the extension directory, which is at the
same level as the XML file.
Once youve installed your extension, you can load it into Workbench via the Extension Manager. Upon
loading your extensions, the functionality defined in the extension will become available. For example:
If you have defined global callbacks, they will be invoked within the Project Schematic workflow as defined.
Each global callback will be invoked each time the Project Schematic operation associated with it is performed.
95
If you have defined custom taskgroups or tasks, the custom taskgroup(s) will be exposed as systems in a
new Workbench Toolbar group, as shown below:
Figure 51: Custom Taskgroups in the Workbench Toolbox
These custom taskgroups can be added to the Project Schematic. When you invoke an Update on
a custom task within the taskgroup, the extension may:
Obtain the inputs.
Prepare the inputs.
Write input file(s).
Run the external solver or performs calculations.
Read output file(s).
Set the parameters or properties to the calculated values.
Creating the Extension Definition XML File

The extension definition XML file contains information to define a workflow within Workbench, including
taskgroups designed for a particular simulation objective. All analyses performed within Workbench
begin by referencing a taskgroup (system). This XML file describes the taskgroups, and declares the
contained tasks.
At the extension level, the XML file must specify, at minimum:
Extension name
Interface context (must be Project)
Interface <images> tag (needed to specify taskgroup or task icons)
Workflow block
At the workflow level, the XML file can specify:
Workflow context (required; must be Project)
Tasks (container for individual task definitions)
96

Taskgroups (container for taskgroup definitions)
Global callbacks
At the global callback level, the XML file can specify pre- and post-operation callbacks for any of the
11 Project Schematic operations in Workbench. For more information, see Defining a Global Callback.
At the task level, the XML file can specify:
Task name (required)
Task version (required)
Callbacks
Context menus
Inputs and outputs
Property groups and properties
Parameters
Display text
Image name
For more information, see Defining a Task (p. 103).
At the taskgroup level, XML file can specify:
Taskgroup name (required)
Taskgroup version (required)
RSM update specification
Image name
Abbreviation
For more information, see Defining a Taskgroup (p. 116).
The following is an example of the basic structure of an XML extension definition file:
<extension version="1" name="">
<guid shortid="">69d0095b-e138-4841-a13a-de12238c83f3</guid>
<script src="" />
<interface context="Project">
</interface>
<workflow name="" context="Project" version="1">
<callbacks>
<onbeforetaskreset></onbeforetaskreset>
<onaftertaskreset></onaftertaskreset>
<onbeforetaskrefresh></onbeforetaskrefresh>
<onaftertaskrefresh></onaftertaskrefresh>
<onbeforetaskupdate></onbeforetaskupdate>
<onaftertaskupdate></onaftertaskupdate>
<onbeforetaskduplicate></onbeforetaskduplicate>
97
<onaftertaskduplicate></onaftertaskduplicate>
<onbeforetasksourceschanged></onbeforetasksourceschanged>
<onaftertasksourceschanged></onaftertasksourceschanged>
<onbeforetaskcreation></onbeforetaskcreation>
<onaftertaskcreation></onaftertaskcreation>
<onbeforetaskdeletion></onbeforetaskdeletion>
<onaftertaskdeletion></onaftertaskdeletion>
<onbeforetaskcanusetransfer></onbeforetaskcanusetransfer>
<onaftertaskcanusetransfer></onaftertaskcanusetransfer>
<onbeforetaskcanduplicate></onbeforetaskcanduplicate>
<onaftertaskcanduplicate></onaftertaskcanduplicate>
<onbeforetaskstatus></onbeforetaskstatus>
<onaftertaskstatus></onaftertaskstatus>
<onbeforetaskpropertyretrieval></onbeforetaskpropertyretrieval>
<onaftertaskpropertyretrieval></onaftertaskpropertyretrieval>
</callbacks>
<tasks>
<task name="" caption="" icon="" version="1">
<callbacks>
<onupdate></onupdate>
<onrefresh></onrefresh>
<oninitialize></oninitialize>
<onedit></onedit>
<onreset></onreset>
<onstatus></onstatus>
<onreport></onreport>
</callbacks>
<contextmenus>
<entry name="" caption="" icon="" priority="" type="">
<callbacks>
<onclick></onclick>
</callbacks>
</entry>
</contextmenus>
<propertygroup name="" caption="">
<property name="" caption="" control="" default="" readonly=""
needupdate="" visible=""
persistent="" isparameter="" keytype="" valuetype="" elementtype=""/>
</propertygroup>
<property name="" caption="" control="" default="" readonly=""
needupdate="" visible=""
<parameters>
<parameter name="" caption="" usage="" control="" version="1"/>
</parameters>
<inputs>
<input/>
<input type="" format=""/>
</inputs>
<outputs>
<output type="" format=""/>
</outputs>
<rsmjob name="" deletefiles="" version="1">
<inputfile id="1" name=""/>
<outputfile id="1" name=""/>
<program>
<platform name="" path=""/>
<argument name="" value="" separator=""/>
</program>
<callbacks>
<oncreatejobinput></oncreatejobinput>
<onjobstatus></onjobstatus>
<onjobcancellation></onjobcancellation>
<onjobreconnect></onjobreconnect>
</callbacks>
</rsmjob>
</task>
</tasks>
<taskgroups>
<taskgroup name="" caption="" icon="" category="" abbreviation="" version="1"
isparametricgroup="False">
<includetask name="" external=""/>
98

<includeGroup name=""/>
</taskgroup>
</taskgroups>
</workflow>
</extension>
Defining a Global Callback

Within the <workflow> node, one or more global callbacks can be defined in a child <callbacks>
node. ACT currently provides 22 global callbacks; each of the 11 operations available on the Project
Schematic support both a pre- and post-operation callback.
The basic structure of a global callback definition is shown below.
<callbacks>
<onbeforetaskreset></onbeforetaskreset>
<onaftertaskreset></onaftertaskreset>
<onbeforetaskrefresh></onbeforetaskrefresh>
<onaftertaskrefresh></onaftertaskrefresh>
<onbeforetaskupdate></onbeforetaskupdate>
<onaftertaskupdate></onaftertaskupdate>
<onbeforetaskduplicate></onbeforetaskduplicate>
<onaftertaskduplicate></onaftertaskduplicate>
<onbeforetasksourceschanged></onbeforetasksourceschanged>
<onaftertasksourceschanged></onaftertasksourceschanged>
<onbeforetaskcreation></onbeforetaskcreation>
<onaftertaskcreation></onaftertaskcreation>
<onbeforetaskdeletion></onbeforetaskdeletion>
<onaftertaskdeletion></onaftertaskdeletion>
<onbeforetaskcanusetransfer></onbeforetaskcanusetransfer>
<onaftertaskcanusetransfer></onaftertaskcanusetransfer>
<onbeforetaskcanduplicate></onbeforetaskcanduplicate>
<onaftertaskcanduplicate></onaftertaskcanduplicate>
<onbeforetaskstatus></onbeforetaskstatus>
<onaftertaskstatus></onaftertaskstatus>
<onbeforetaskpropertyretrieval></onbeforetaskpropertyretrieval>
<onaftertaskpropertyretrieval></onaftertaskpropertyretrieval>
</callbacks>
Invoking Global Callbacks

By default, if a global callback is defined in the XML definition file, it will be called for each instance of
the schematic task associated with it. This applies to both pre-installed (non-ACT) and custom tasks.
For example, if you have defined the <onaftertaskupdate> callback, it will be called for each task
that is updated; if three tasks on the Project Schematic are updated, the callback will be called three
times, once after each update.
Unless otherwise noted, a global workflow callback receives a task as the method argument. Depending
on the callback, the task will be the concrete task displayed in the schematic or the task template.
Filtering Global Callbacks

To specify that a callback is processed only for a specific task or template, you can perform a check
within the callback implementation based on the supplied argument(s). For example, in the IronPython
code sample below:
The onBeforeUpdate method is unfiltered; the actions will be invoked before the update of each eligible
task on the schematic.
99
The onAfterUpdate method is filtered; it will produce different messages for Engineering Data tasks
and the second Setup task, while printing ignored for all other tasks.
Note
The Setup tasks for multiple Fluent taskgroups would be identified in the following sequence: Setup, Setup 1, Setup 2, etc.
The onBeforeDuplicate method is filtered; it will print a specific message for the Setup tasks for all
Fluent tasks on the schematic.
...
def onBeforeUpdate(task):
msg = getPrintMessage('pre-update', task)
print msg
def onAfterUpdate(task):
if task.Name == "Engineering Data":
msg = getPrintMessage('post-update', task)
print msg
elif task.Name == "Setup 2":
print("fluent setup 2")
else:
print("ignored")
def onBeforeDuplicate(task):
if task.Container.Type == "Ansys.Fluent.Addin:SetupContainer":
print("all fluent setups")
else:
print("ignored")
...
Specifying Global Callback Execution Order

When multiple callbacks are defined for the same pre- or post-operation schematic action, you can
specify their order of execution by adding the order attribute to the XML callback declaration. For
example:
<workflow ...>
<callbacks>
<onbeforetaskreset order=1>...</onbeforetaskreset>
...
</callbacks>
</workflow>
ACT will execute the callbacks from lowest order to hightest order (i.e., a callback with an order of 2
will execute after a callback with an of order 1). When values are identical, the order in which the
extension was loaded (the callback was processed) will dictate the collision resolution.
Available Global Callbacks

This section details the global callback and corresponding methods and arguments for each schematic
operation.
Note
Hyphenation within the table entries can be ignored; assume that callbacks and methods
do not inlcude hyphens.
100

Reset
Resets a component back to its pristine, new state.
Global Callbacks
Methods
Arguments
<onbeforetaskreset>
onBeforeReset
task
<onaftertaskreset>
onAfterReset
Refresh
Consumes all upstream data and prepares any local data for an ensuing update.
Global Callbacks
Methods
Arguments
<onbeforetaskrefresh>
onBeforeRefresh
task
<onaftertaskrefresh>
onAfterRefresh
Update
Generates all broadcast output types that render the component fully solved.
Global Callbacks
Methods
Arguments
<onbeforetaskupdate>
onBeforeUpdate
task
<onaftertaskupdate>
onAfterUpdate
Create
Creates a task based on an underlying template.
Global Callbacks
Methods
Arguments
<onbeforetaskcreate>
onBeforeCreate
templateTask
Note:This is a task
representing the
template. Some
components do not
include the template as a
command parameter to
the create command.
As a result, this could be
null in some situations.
<onaftertaskcreate>
onAfterCreate
task
Delete
Removes a task from a task group.
Global Callbacks
Methods
Arguments
<onbeforetaskdelete>
onBeforeDelete
task
<onaftertaskdelete>
onAfterDelete
Duplicate
Creates an identical, yet independent, clone of the task.
101
Global Callbacks
Methods
Arguments
<onbeforetaskduplicate>
onBeforeDuplicate
task
<onaftertaskduplicate>
onAfterDuplicate
SourcesChanged
Processes a change in upstream sources.
Global Callbacks
Methods
Arguments
<onbeforetasksourceschanged>
onBeforeSourcesChanged
task
<onaftertasksourceschanged>
onAfterSourcesChanged
CanUseTransfer
Checks whether the task can consume data from a specific upstream task.
Callback receives two tasks as arguments: the source (upstream producer) task and target
(downstream consumer) task.
Global Callbacks
Methods
Arguments
<onbeforetaskcanusertransfer>
onBeforeCanUseTransfer
sourceTask, targetTask
<onaftertaskcanusertransfer>
onAfterCanUseTransfer
sourceTask, targetTask,
systemCalculatedCanUse
Note: systemCalculatedCanUse argument provides
the result that the original
task determined. The return
value of this callback
(boolean) will alter the
originally calculated value.
CanDuplicate
Checks whether the task permits duplication.
Callback receives no arguments. The schematic does not provide any workable information to
construct or provide tasks (either container-based or template-based). Callback will only serve as a
general processing hook, if exposed.
Global Callbacks
Methods
Arguments
<onbeforetaskcanduplicate>
onBeforeCanDuplicate
None
<onaftertaskcanduplicate>
onAfterCanDuplicate
systemCalculatedCanUse
Note: systemCalculatedCanDuplicate argument
provides the result that the
original task determined. The
return value of this callback
102

Global Callbacks
Methods
Arguments
(boolean) will alter the
originally calculated value.
Status
Calculates the tasks current state.
Global Callbacks
Methods
Arguments
<onbeforetaskstatus>
onBeforeStatus
task
<onaftertaskstatus>
onAfterStatus
task, systemCalculatedStatus
Note: systemCalculatedStatus argument provides
the result that the original
task determined. The return
value of this callback
component state will alter
the originally calculated
value.
PropertyRetrieval
Determines the visibility of property-containing objects.
Global Callbacks
Methods
Arguments
<onbeforetaskpropertyretrieval>
onBeforePropertyRetrieval
task
<onaftertaskpropertyretrieval>
onAfterPropertyRetrieval
task, systemCalculatedPropertyObject
Note: systemCalculatedPropertyObjects
argument provides the
result that the original task
determined. The return
value of the callback (list of
data references) will alter
the originally calculated
value.
Defining a Task
One or more custom tasks can be defined in the <tasks> node. Individual tasks are defined in a
<task> child node. The base <task> class represents an extension-based workflow task which serves
a template role from which ACT will create real instances.
In each task definition, you must include the name and version attributes. Child nodes can be used
to specify callbacks, inputs and outputs, properties, parameters, context menus, and remote execution.
The basic structure of a task definition is shown below:
103
<tasks>
<task name="" caption="" icon="" version="1" enableGenericTransfer="">
<callbacks>
<IsVisible></IsVisible>
<IsValid></IsValid>
<GetValue></GetValue>
<SetValue></SetValue>
<OnShow></OnShow>
<OnHide></OnHide>
<OnInit></OnInit>
<OnAdd></OnAdd>
<OnRemove></OnRemove>
<OnDuplicate></OnDuplicate>
<OnActivate></OnActivate>
<OnCancel></OnCancel>
<OnApply></OnApply>
<Value2String></Value2String>
<String2Value></String2Value>
<OnValidate></OnValidate>
<OnMigrate></OnMigrate>
</callbacks>
<contextmenus>
<callbacks>
<onclick></onclick>
</callbacks>
</entry>
</contextmenus>
<property name="" caption="" control="" default="" options="" readonly="" needupdate="" visible=""
</propertygroup>
<property name="" caption="" control="" default="" readonly="" needupdate="" visible=""
persistent="" isparameter="" keytype="" valuetype="" elementtype="">
<callbacks>
<IsVisible></IsVisible>
<IsValid></IsValid>
<GetValue></GetValue>
<SetValue></SetValue>
<OnShow></OnShow>
<OnHide></OnHide>
<OnInit></OnInit>
<OnAdd></OnAdd>
<OnRemove></OnRemove>
<OnDuplicate></OnDuplicate>
<OnActivate></OnActivate>
<OnCancel></OnCancel>
<OnApply></OnApply>
<Value2String></Value2String>
<String2Value></String2Value>
<OnValidate></OnValidate>
<OnMigrate></OnMigrate>
</callbacks>
<property/>
<parameters>
</parameters>
<inputs>
<input/>
<input type="" count="" format=""/>
</inputs>
<outputs>
<output type="" format=""/>
</outputs>
<rsmjob name="" deletefiles="" version="1">
<inputfile id="1" name=""/>
<outputfile id="1" name=""/>
<program>
<platform name="" path=""/>
<argument name="" value="" separator=""/>
</program>
<callbacks>
104

<oncreatejobinput></oncreatejobinput>
<onjobstatus></onjobstatus>
<onjobcancellation></onjobcancellation>
<onjobreconnect></onjobreconnect>
</callbacks>
</rsmjob>
</task>
</tasks>
Defining Task-Level General Data Transfer

ACT provides you with a method of transferring data within the Project Schematic. All tasks contain
a general transfer object of type GeneralTransfer. This object will contain one property, TransferData, of type Dictionary<string, object>. When the type is fully created for each task,
ACT will automatically expose the type as an output by default. If you do not want to engage in all
transfer possibilities enabled through the general transfer, you can declare this at the task level:
<workflow name="MyWorkflow" context="Project" version="1">
<tasks>
<task name="MyTask" ... enableGenericTransfer="False">
...
</task>
...
</tasks>
</workflow>
Once a general transfer-enabled task exists in the schematic, the transfer data can be accessed in order
to push and pull data within the data store. A simple TransferData property is exposed off of the
task argument of all task callbacks or tasks retrieved from ExtAPI or as a callback argument:
def producer_update(task):
data = task.TransferData
Once obtained, the TransferData dictionary acts like any other dictionary within ACT. You can both
set and retrieve values through string keys, and can perform other collection-based calls such as
Add() and Remove(). The custom IDictionary is coded in such a way that if you try to access a
non-existent key (e.g., to set a new value), it will automatically add the key and allow the set to take
place.
task.TransferData["Test"] = Sample text
One the consumer side, you can easily access the transfer data, as follows:
def consumer_update(task):
upstreamData = container.GetInputDataByType(
InputType="GeneralTransfer")
for upstreamDataEntity in upstreamData:
task = ACT.GetTaskForContainer(
upstreamDataEntity.Container)
data = task.TransferData["Test"]
The transfer data approach eliminates dependency on file and file path transfers. However, you can still
opt to pass file paths via the new transfer data, if desired; no further actions or implementations are
required to fulfill the basic framework transfer connections.
Note
Downstream processing may require additional actions implemented via ACT workflow callbacks.
105
In some circumstances, you may want to interrogate a tasks source tasks. For example, this can ease
the access of transfer data from upstream sources. The SourceTasks property is now available on all
UserTask objects:
def myTaskUpdate(task):
sources = task.SourceTasks
for sourceTask in sources:
data = sourceTask.TransferData[Test]
Tasks can filter or block their source connections by implementing a task-level canconsumedata
callback:
XML:
<task name="Consumer"...>
<callbacks>
<canconsumedata>taskCanUse</canconsumedata>
...
</callbacks>
...
</task>
IronPython:
def taskCanUse(task, sourceTask):
if sourceTask.Name == Foo:
return True
else:
return False
Defining Task-Level Callbacks

Callbacks to IronPython functions are specified in the <callbacks> node. All callbacks receive, at
minimum, a task object as an argument. The table below lists the available callbacks and their arguments.
Callback
Argument(s)
oninitialize
task
onupdate
task
onrefresh
task
onreset
task
onedit*
task
onstatus
task
onreport
task, report
ondelete
task
canconsumedata
sourceTask, targetTask
*Definition of the <onedit> callback automatically creates a default Edit context menu for the task.
In the event of task-level callback errors, exceptions are provided to the Workbench framework, allowing
the framework to detect failures and correctly manage task states. Exception details are also reported
to the Log.
106
Defining Task-Level Context Menus

If you specify the <onedit> callback in your extension definition file, a default Edit context menu
option is automatically created for the task. However, it is possible to define additional GUI operations
for each task.
Custom GUI operations are specified in the optional <contextmenus> node. At minimum, the context
menu entry definition must include the name attribute. When the optional type attribute is defined,
it must be set to ContextMenuEntry.
Each entry in the <contextmenus> node must have an <onclick> callback, which receives a task
object as its argument.
The basic structure of the <contextmenus> node is shown below:
<contextmenus>
<callbacks>
<onclick></onclick>
</callbacks>
</entry>
</contextmenus>
Defining Task-Level Property Groups and Properties

Instead of using parameters to drive your simulation, you can work through the data model, simplifying
data access by defining custom properties.
Properties can be defined in the optional <propertygroup> node. At minimum, each property group
definition must include the name attribute. The caption attribute will be used as the group category
name in the Workbench Property view if the child properties are visible.
Individual properties can be defined in the <property> node, which can be either a child to
<propertygroup> or a standalone definition at the same level. At minimum, each property definition
must include the name and control attributes.
The basic structure of a property definition is shown below:
<property name="" caption="" control="" default="" readonly="" needupdate=""
visible="" persistent="" isparameter="" keytype="" valuetype="" elementtype=""/>
</propertygroup>
<property name="" caption="" control="" default="" readonly="" needupdate=""
visible="" persistent="" isparameter="" keytype="" valuetype="" elementtype=""/>
ACT currently supports the following property control types:

string/text
double
float
integer
DataReference
boolean
107
object
quantity
option/select
fileopen
folderopen
list
dictionary
DataContainerReference
Defining Task-Level Property Callbacks

Callbacks to IronPython functions can be specified in a task-level property definition. All property callbacks
receive, at minimum, the entity (task) and property as arguments. Available property callbacks are listed
and described below.
IsVisible
Users can define the isvisible callback on task-exposed properties. This callback can dynamically
control whether or not to display a property. Users can key off of any desired condition or other task
property to determine the propertys visibility, returning True or False as a result.
XML:
...
<task ...>
...
<property name="Input" caption="Input" control="double" .../>
<property name="HiddenString" caption="Test String"
control="string" ...>
<callbacks>
<isvisible>stringVisibilityCheck</isvisible>
</callbacks>
</property>
...
</task>
...
IronPython:
def stringVisibilityCheck(entity, property):
inputVal = entity.Properties["Input"]
if inputVal.Value == 2.0:
return True
else:
return False
108
IsValid
Users can define the isvalid callback on task-exposed properties. This callback can dynamically control
whether or not a property is valid. Users can key off of any desired condition or other task property to determine the property's validity, returning True or False as a result.
XML:
...
<task ...>
...
<property name="Input" caption="Input" control="double"
default="0.0" readonly="False" needupdate="True"
visible="True" persistent="True"
isparameter="True">
<callbacks>
<isvalid>validityCheck</isvalid>
</callbacks>
</property>
...
</task>
...
IronPython:
def validityCheck(entity, property):
if property.Value == 1.0:
return False
else:
return True
109
Figure 52: Valid Property
Figure 53: Invalid Property
GetValue
Users can define the getvalue callback that is called when the user obtains a value either from command
line/script or through the project itself.
SetValue
Users can define the setvalue callback that is called when the user sets a value from either command
line/script or through the project itself.
110

OnShow
Users can define the onshow callback that is called when the Project page is about to display the property.
OnHide
Users can define the onhide callback that is called when the Project page is about to hide the property.
OnInit
Users can define an oninit callback that is called when the property is first created on the task object.
**Note that this is called at the same location as onadd.**
OnAdd
Users can define an onadd callback that is called when the property is first added on the task object.
**Note that this is called at the same location as oninit.**
OnRemove
Users can define an onremove callback this is called when the property is deleted from the task object.
OnDuplicate
Users can define an onduplicate callback that is called when the property is duplicated to another task.
OnActivate
Users can define an onactivate callback that is called when the property is activated in the UI.
**Note that this is called at the same location as onshow.**
OnCancel
Users can define an oncancel callback that is called when a property is deactivated.
**Note that this is called at the same location as onhide.**
OnApply
Users can define an onapply callback that is called immediately after a property value change but before
it is actually processed.
Value2String
Users can define a value2string callback that is called when the ValueString property is retrieved.
String2Value
Users can define a string2value callback that is called when the ValueString property is set.
OnValidate
Users can define an onValidate callback that is called during a property value change.
OnMigrate
Not supported at 17.1.
Using Standardized Property Interaction

You can get and set property values using standard ACT syntax, as defined through SimEntity. At
the task-level callbacks, the provided task argument provides the entry point:
propA = task.Properties[PropertyA].Value
task.Properties[PropertyA].Value = Foo
111
Access is available at the master ExtAPI level. Assuming that only one task resides in the schematic:
task = ExtAPI.DataModel.Tasks[0]
propA = task.Properties[PropertyA].Value
task.Properties[PropertyA].Value = Foo
Property groups are treated the same as elsewhere in ACT:

group1 = task.Properties[GroupName]
supProp1 = group1.Properties[SubPropertyA]
subProp1Val = subProp1.Value
When you must perform advanced schematic interactions, you can access task.InternalObject
to receive the tasks underlying DataContainerReference. This may be needed to execute Workbench-specific scripting commands (see the Workbench Journaling and Scripting Guide for more details):
container.SendCommand(Language=Python, Command=print test)
Interaction with pre-installed tasks operates in the same way. For example, if you create a Fluent analysis system in the schematic, you could set the Run In Parallel property as follows:
task = ExtAPI.DataModel.Task[0]
task.Properties[RunParallel].Value = True
All set-based actions performed via the Property.Value calls are recorded in the journal. Using
the last example with a Fluent system, the resulting journal would contain the following code:
# encoding: utf-8
# Release 17.1
SetScriptVersion(Version=17.1.21)
Reset()
template1 = GetTemplate(TemplateName=FLUENT)
system1 = template1.CreateSystem()
setup1 = system1.GetFluentLauncherSettings()
fluentLauncherSettings1.RunParallel = True
Using Path-Based Property Control Support

You can specify the fileopen and folderopen controls on task properties. Upon task creation and
property display, a folder icon will appear in the property value cell. Selecting this icon will display
either a file or folder selection dialog. File path and folder path access remains the same as if the
property was string-based.
XML:
<task ...>
...
<property name="Prop1" caption="File Path" control="fileopen"
.../>
<property name="Prop2" caption="Directory Path"
control="folderopen" .../>
...
</task>
IronPython:
def update(task):
filePath = task.Properties["Prop1"].Value
dirPath = task.Properties["Prop2"].Value
112
Using String-Based and Option-Based Task Properties

For string-based task properties, specify text as the control type.
...
<task ...>
...
<property name="StringTest" caption="String" control="text"...>
</property>
...
</task>
...
For option-based task properties, specify the standard select control type and use the options attribute to provide the items to be populated to the control.
...
<task ...>
...
<property name="ComboBoxTest" caption="My Prop" control="select"...>
...
<attributes options=one,two,three .../>
...
</task>
...
Specifying Property Default Values

In the XML extension definition, you can specify default property values to be used in the Project
Schematic.
...
<task ...>
...
<property name="MyProperty" caption=My Property" control="text" default=Foo.../>
...
</task>
...
Defining Task-Level Parameters

You can integrate an external application with the Project Schematic by defining parameters that are
created dynamically at initialization.
Parameters are defined in the optional <parameters> node. At minimum, each parameter definition
must include the following attributes: name, usage, control, and version.
The basic structure of a parameter definition is shown below:
113
<parameters>
</parameters>
Defining Task-Level Inputs and Outputs

In a Workbench workflow, the Project Schematic connections serve as visual representations of data
flow between tasks. These connections depend on input and output coordination. Workbench can establish connections only if an upstream (providing) task exposes outputs whose types also match the
inputs for a downstream (consuming) task.
Inputs and outputs are defined in the <input> and <output> nodes.
You can use the type attribute to specify the data type expected by the connection.
By default, ACT applies an unlimited count to the number of input specifications. You can specify a
count according to your own requirements, as shown below:
...
<task ...>
...
<inputs>
<input/>
<input format="" type="GeneralTransfer" count=2/>
</inputs>
...
</task>
...
114

Certain Workbench types require the use of both the type and format attributes. For example, a
Mesh task that consumes a mesh and then passes a mesh to another taskgroup would use these attributes to specify the mesh type and file format of the input and output files.
This example defines the inputs and outputs for a task within a Fluent meshing workflow. The meshingbased type values and FluentMesh format values instruct an upstream mesh task to output the Fluent
mesh file format (.msh).
...
<task name="Mesher" caption="Mesher" icon="GenericMesh_cell" version="1">
<callbacks>
<onupdate>update</onupdate>
<onedit>edit</onedit>
</callbacks>
<inputs>
<input format="FluentMesh" type="MeshingMesh" count="1"/>
<input/>
</inputs>
<outputs>
<output format="FluentMesh" type="SimulationGeneratedMesh"/>
</outputs>
</task>
...
For a list of supported transfer types and their corresponding transfer properties, see Appendix C (p. 389).
For a list of the data types and data transfer formats for each addin, see Appendix D (p. 395).
Defining a Remote Job Execution Specification

The ANSYS Remote Solve Manager (RSM) application enables the remote execution of applications and
processes. By leveraging high-performance clusters and efficient job scheduling, users submit jobs either
as background solve tasks (local machine) or as true remote cluster and scheduler submissions. Workbench orchestrates the packaging, submission, tracking, and reintegration of job artifacts.
ACT enables you to leverage RSM capabilities, specifying the remote execution of a tasks processes via
an <rsmJob> child node. This node allows you to specify all relevant RSM-related information, including
supported platforms, input/output files, process arguments, and the callbacks needed to execute the
remote jobs.
This example shows the basic definition of a remote execution specification. It defines the name and
version of the job, specifies that job files should be deleted after execution, and defines the job input/output files and callbacks.
...
<task name="MyTask" caption="My Task" icon="my_task" version="1">
...
<rsmjob name="squares" deletefiles="True" version="1">
<inputfile id="1" name="input1.txt"/>
<outputfile id="1" name="output1.txt"/>
<program>
<platform name="Win64" path="%AWP_ROOT171%\path_to.exe"/>
<platform name="Linux64" path="%AWP_ROOT171%/path_to.exe"/>
<argument name="" value="inputFile:1" separator=""/>
<argument name="" value="outputFile:1" separator=""/>
</program>
<callbacks>
<oncreatejobinput>createJobInput</oncreatejobinput>
<onjobstatus>getJobStatus</onjobstatus>
<onjobcancellation>cancelJob</onjobcancellation>
<onjobreconnect>reconnectJob</onjobreconnect>
</callbacks>
</rsmjob>
115
</task>
...
For a more detailed discussion of how to access RSM capabilities, see the example Custom, Lightweight,
External Application Integration with Custom Data and Remote Job Execution (p. 217).
Defining a Taskgroup
The sole purpose of a taskgroup is to collect tasks. One or more taskgroups can be defined in the
<taskgroups> node. Individual taskgroups are defined in a <taskgroup> child node.
At minimum, each taskgroup definition must include the taskgroup name and version attributes. The
<includetask> and <includeGroup> child nodes are to specify one or more tasks or nested
taskgroups to be included.
In the <includetask> child node, you can reference both the custom tasks defined in your extension
and external" tasks (Workbench-defined components). The optional external attribute, when set to
true, indicates that the referenced task is defined externally (originates from outside the extension).
For an external task, the name attribute must be set to the internally defined template name for the
given component; optionally, you can set the caption attribute to use your own display text. For a listing
of internally defined systems with their components and component display names, see Appendix B (p. 373). To review examples of taskgroups referencing external tasks, see Generic Material
Transfer (p. 225) or Generic Mesh Transfer (p. 229).
If you define a caption, it overrides the task-level caption. Otherwise, the taskgroup-level caption is
used.
The basic structure of a taskgroup definition is shown below:
...
<taskgroups>
<taskgroup name="" caption="" icon="" category="" abbreviation="" version="1"
isparametricgroup="False">
<includetask name="" external=""/>
<includeGroup name=""/>
</taskgroup>
</taskgroups>
...
Note
At present, ACT-defined tasks cannot be added to installed taskgroups. Also, nested taskgroups
within a taskgroup are not recognized by Workbench at 17.1.
Creating the IronPython Script

The IronPython script defines the actions to be executed during a callback invocation. Python scripts
execute within the Workbench Python interpreter; as a result, scripts have full access to the scriptable
Workbench API (Using Journals and Scripts in the Workbench User's Guide).
For example, the script is used to create update instructions for producing and consuming data. If any
task produces or consumes data, you must supply an Update routine that processes input and output
types as declared by the workflow definition. For a table of supported task inputs and outputs, see the
Table 8: Autodyn (p. 309).
116
Upstream Data Consumption (Input)

Typically, tasks need to implement complex source handling logic, connection tracking routines, and a
refresh procedure in order to consume data. ACT abstracts these complexities by automatically performing
these actions during refresh. It obtains upstream data and stores it in a dictionary accessible by the
user during the task Update. The task can obtain this data by calling Convenience APIs (p. 117).
Data Generation (Output)

Tasks that produce output data (for example, declare output types in the taskgroup definition file) must
ensure that their custom Update routine assigns output data.
The extension definition XML file prepares empty data objects representing task outputs; the user must
only set the correct transfer properties that downstream consumers will interrogate. Refer to Appendix C (p. 389) to determine which properties you must set.
For example, a material transfer to a downstream Engineering Data task must set the DataReference
TransferFile property on a MatML31 data object to the file reference of a registered matmlformatted XML file, all completed during the Update routine.
Convenience APIs
Convenience APIs are IronPython queries that provide simple access to task-stored input and output
data. The available convenience APIs are:
GetInputDataByType
Returns a List<object> containing upstream data for a given type. For example:
upstreamData =
container.GetInputDataByType(InputType="MeshingMesh")
meshFileRef = None
upstreamDataCount = upstreamData.Count
if upstreamDataCount > 0:
meshFileRef = upstreamData[0]
GetOutputData
Returns a Dictionary<string, List<DataReference>> holding the task's output types. For
example:
outputRefs = container.GetOutputData()
meshOutputSet = outputRefs["SimulationGeneratedMesh"]
meshOutput = meshOutputSet[0]
meshOutput.TransferFile = meshFileRef
GetCustomEntity
Obtains the custom data entity from a container based on the entity's name and type. If the name and
type are not specified, the default ACT object is returned. This object contains the properties defined by
the workflow task from the <propertygroup> and <property> blocks.
entity = ACT.GetCustomEntity(container)
GetCustomEntityPropertyValue
This query returns the value of a property defined on a custom data entity.
inputValue = ACT.GetCustomEntityPropertyValue(entity, "Input")
Users can also directly access properties off of a task object.
117
SetCustomEntityPropertyValue
This command handles the setting of a custom entity's property value.
ACT.SetCustomEntityPropertyValue(entity, "Output", outputValue)
Users can also directly set properties off of a task object.

This section discusses customization of the ANSYS AIM application. By using ACT in ANSYS AIM, you
can add a custom load for a structural analysis (similar to the functionality available in ANSYS Mechanical) and create a full CFD system encapsulating all available fluid flow conditions.
Adding a Pre-Processing Feature in ANSYS AIM Structural
Creating a Custom Object to Merge Existing AFD Features (Process Compression)
Adding a Pre-Processing Feature in ANSYS AIM Structural

This section discusses customization of the ANSYS AIM application for the native exposure of a preprocessing feature--specifically, how to add a custom load to a structural analysis. The example used
in the discussion is defined in the CustomPressure extension, which was written to create a custom
pressure as a load. This example is for demonstration purposes only.
We will address the extension's XML and Python file separately.
Custom Load Definition in the XML File

Below are the contents of the CustomPressure.xml file, which adds the custom pressure load to
our project.
<extension version="1" name="CustomPressure">
<guid shortid="CustomPressure">314bd00a-2f64-4b62-8196-bab9206c2c6b</guid>
<simdata context="Study">
<load name="CustomPressure" version="1" caption="CustomPressure" icon="tload" issupport="false"
isload="true" color="#0000FF" >
<callbacks>
<getsolvecommands order="1">writeNodeId</getsolvecommands>
</callbacks>
<attributes selection_filter="face" />
</property>
<property name="Expression" caption="Expression" datatype="double" control="float"
unit="Pressure" isparameter="true"></property>
</load>
</simdata>
</extension>
As in previous examples, the XML file first defines the extension using a version and name attribute.
The path to the Python script file main.py is specified by the <script> tag.
The definition of the load is encapsulated by the <simdata> begin and end tags. The context attribute
for <simdata> has been set to Study , which makes the extension compatible with AIM. The attributes
in the <load> begin tag provide the name, version, caption, icon, support status, and color that apply
to this load. The color attribute is defined in a hexadecimal format. This color is used to contrast the
118

load when it is displayed on the model. The <callbacks> tag encapsulates the callback <getsolvecommands>. This tag specifies the name of the Python function that is called when the solver input
file is generated by the application. Consequently, the related Python function is responsible for generating the commands that describe the load within the ANSYS input file.
of the load. These properties are displayed in the specific ACT object created by the extension, where
the user provides the necessary values to complete the load definition.
Note that neither property requires the definition of a callback.
The first property, Geometry, uses a scoping control type, and has the selection_filter attribute
set to face. This property allows you to select the face of the geometry to which the custom pressure will
be applied.
The second property, Expression, uses a float control type, which provides the property with access
to AIM expressions functionality. Consequently, you can enter an expression into the Expression property
field and expect a float. Setting datatype to double introduces a physical quantity dependency with the
unit option, which is set to Pressure; this combination specifies that this property is consistent with a
pressure. Finally, setting isparameter to true specifies that this expression can be parameterized.
Custom Load Definition in the Python File

Here is the Python script file main.py used for the CustomPressure extension.
def writeNodeId(load, stream):
ExtAPI.Log.WriteMessage("writeNodeId...")
stream.WriteLine("/com, GetSolveCommands")
property_expression = load.PropertyByName("Expression")
expression = property_expression.Value
ExtAPI.Log.WriteMessage(expression.ToString())
if expression=="":
return None
property_geometry = load.PropertyByName("Geometry")
refIds = property_geometry.Value.Ids
ExtAPI.Log.WriteMessage(refIds.ToString())
mesh = ExtAPI.DataModel.MeshDataByName("Mesh 1")
ExtAPI.Log.WriteMessage(meshRegion.ToString())
nodeIds = meshRegion.NodeIds
for nodeId in nodeIds:
stream.WriteLine("F,"+nodeId.ToString()+", FX,"+expression.ToString()+"\n")
The main.py Python file defines the writeNodeId function, which writes the value of the Expression
property on the geometry nodes scoped for the load.
The following figure shows that the CustomPressure ACT load weve created is now made available
to be added as a boundary condition in AIM.
119
Figure 54: CustomPressure Load Available as a Boundary Condition in AIM
The following figure shows the status of the load once all the properties are defined.
Figure 55: CustomPressure Load with Properties Defined
120
Creating a Custom Object to Merge Existing AFD Features (Process Compression)

By using ACT extensions in AIM, you have the ability to create a complete CFD system encapsulating
existing boundary conditions. This section discusses the customization of the ANSYS AIM application
to expose a fluids system with access to all available boundary conditions.
You can have one load per boundary condition, and have access to all fluid boundary conditions (i.e.
inlet, outlet, wall, etc.). The boundary conditions will appear as scoping properties. In some instances,
you can also add an inlet velocity and an outlet pressure to standard boundary conditions.
Fluids extensions developed in AIM are very similar in construction to other extensions developed in
AIM or Workbench. As with other extensions, each AFD extension developed in AIM will have an XML
file and an IronPython script.
The XML file will have both a section containing an element to define buttons and toolbars, and a section
containing callbacks and properties to define the load.
The Python script will define functions invoked by the events and callbacks in the XML file to implement
the behavior of the extension.
As an example, we will use an extension called AFDLoad. This example is for demonstration purposes
only. We will address the extension's XML and Python file separately.
CFD System Definition in the XML File

Below are the contents of the AFDLoad.xml file, which is used to create a CFD system with full access
to available boundary conditions.
<extension version="1" name="AFDLoad">
<interface context="Study">
</interface>
<simdata context="Study">
<load name="InOut" version="1" caption="InOut" icon="support" issupport="true" color="#0000FF">
<callbacks>
<getsolvecommands>getcmds</getsolvecommands>
</callbacks>
<property name="Inlet" caption="Inlet" control="scoping" />
<property name="Outlet" caption="Outlet" control="scoping" />
<property name="InletVelocity" caption="Inlet Velocity" control="float" unit="Velocity"
default="1 [m s^-1]"/>
<property name="OutletPressure" caption="Outlet Pressure" control="float" unit="Pressure"
default="0 [Pa]"/>
</load>
</simdata>
</extension>
121
The XML file has the standard ACT construction, with the version and name attributes defining the
extension, the <script> tag specifying Python main.py script file, and the interface tag defining
the context as Study.
As in the AIM preprocessing example, the definition of the load is encapsulated by the <simdata>
begin and end tags, the <simdata> context attribute has been set to Study, and the attributes in
the <load> begin tag provide the name, version, caption, icon, support status, and color that apply
to the load that will contain the boundary condition. (In this example, our load name and caption are
both InOut.) As before, the <callbacks> tag encapsulates the callback <getsolvecommands>,
which creates the boundary conditions for the load.
Below the callbacks section, the load properties to be used for the boundary conditions are defined:
Inlet, Outlet, Inlet Velocity, Velocity, Outlet Pressure, and Pressure. The control
type,unit, and default tags function as described in previous examples. These properties are displayed in the specific ACT object created by the where the user provides the necessary values to complete
the load definition.
CFD System Definition in the IronPython File

Here is the Python script file main.py used for the AFDLoad extension.
Note
In future releases, the IronPython commands used to define fluid dynamics features
may be modified to ensure consistency with AIM Journaling and Scripting functionality.
For the information on whether a given command has been modified or deprecated,
refer to the ANSYS ACT API Reference Guide.
import clr
clr.AddReference("Ansys.Study.Proxies.Customization")
from Ansys.Study.Proxies.Customization.Analysis import AFDObject
def getcmds(load,stream):
velocity = load.Properties["InletVelocity"]
pressure = load.Properties["OutletPressure"]
faces = []
faces += load.Properties["Inlet"].Value.Ids
faces += load.Properties["Outlet"].Value.Ids
geo = load.Analysis.GeoData
wallFaces = []
for part in geo.Assemblies[0].Parts:
for face in body.Faces:
if not faces.Contains(face.Id) and not wallFaces.Contains(face.Id):
wallFaces.Add(face.Id)
boundary = AFDObject.CreateBoundary()
boundary.SetProperty("BoundaryType","Inlet")
boundary.SetProperty("Location",load.Properties["Inlet"].Value.Ids)
boundary.SetProperty("Flow.Option","Velocity")
boundary.SetProperty("Flow.Velocity.Magnitude",velocity.Value.ToString()+' ['+velocity.UnitString+']')
boundary.Send(stream)
boundary.SetProperty("BoundaryType","Outlet")
boundary.SetProperty("Location",load.Properties["Outlet"].Value.Ids)
boundary.SetProperty("Flow.Option","Pressure")
boundary.SetProperty("Flow.Pressure.GaugeStaticPressure",pressure.Value.ToString()+'
['+pressure.UnitString+']')
122

boundary.SetProperty("BoundaryType","Wall")
boundary.SetProperty("Location",wallFaces)
The function getcmds is defined in the main.py Python file for the AFDLoad extension. This function
writes commands to the solver input file. The required input arguments are load and stream, where
load is the load object and stream refers to the solver input file. In our example, the function
getcmds is referenced in the AFDLoad.xml file by the <getsolvecommands> callback. When
called, it creates the boundaries for the AFD object, defines boundary properties, and specifies the
face(s) to which the boundary will be applied. Within this function:
The CreateBoundary() method is applied to AFDObject to create a boundary. (This AFD object was
imported by the import command at the top of the Python file.)
In the faces section, we can specify:

The faces to be used in the inlet and outlet properties).
The faces belonging to the wall (i.e. all the faces not already used for the inlet and outlet properties).
With boundary.SetProperty, we specify the boundary type (such as inlet, outlet, wall, etc.). It can also
be applied to the boundary object to add a property. As part of the argument, you must specify both the
type of property to be added and the value to be assigned to it.
For example, the code segment below specifies the creation of an inlet boundary.
boundary.SetProperty("BoundaryType","Inlet")
With boundary.SetProperty, we can also specify the location (faces, bodies, etc.) to which the
boundary will be applied. To do so, we can use the scoping properties previously defined in the extension.
The location property expects a list of identifiers.
boundary.SetProperty("Location",load.Properties["Inlet"].Value.Ids)
To the property that just created, we can add an option representing a velocity (for an inlet) or a pressure
(for an outlet).
boundary.SetProperty("Flow.Option","Velocity")
To the option just added, we add a float value. (This float value could come from a property defined in the
XML file.) We also have the ability to specify a unit.
boundary.SetProperty("Flow.Velocity.Magnitude",velocity.Value.ToString()+' ['+velocity.UnitString+']')
Finally, we write the command generated by creation of the boundary.

The following figure shows that the InOut ACT load we've created is now made available to be added
as a fluids boundary condition in AIM. This load includes all the properties defined in the extension.
123
Figure 56: InOut Load Available as a Fluids Boundary Condition in AIM
The following figure shows the status of the load once all the properties are defined.
Figure 57: InOut Load with Properties Defined
124
ACT Simulation Wizards

ANSYS ACT allows you to automate the simulation process with the creation of custom simulation
wizards. A simulation wizard developed with ACT is part of a specific extension; in addition to accessing
the functionality defined in that extension, it can also leverage the API scripting capabilities available
with AIM, Workbench, and all ANSYS products that support ACT wizards. ACT wizards enable users to
benefit from ANSYS simulation capabilities while minimizing interactions with the standard application
interface.
Wizards can be created for Workbench or any ANSYS application providing scripting capabilities and
ACT support (i.e. Mechanical, DesignModeler, SpaceClaim, Electronics Desktop, Fluent, Fluent Meshing,
and AIM). A wizard walks non-expert end-users step-by-step through a simulation.
The following topics are addressed:
Types of Wizards
Creating Wizards
Installing and Loading Wizards
Using Wizards
Types of Wizards
You can use ACT to create three different types of wizards: Project Wizards (p. 125), Application-Based
Wizards (p. 125), and Mixed Wizard (p. 126).
Project Wizards
A project wizard is executed from the Project tab.
When launched from the Project tab in Workbench, a project wizard can engage any data-integrated
application with Workbench journaling and scripting capabilities (such as DesignXplorer, SpaceClaim,
Mechanical) and incorporate them into the project workflow.
When launched from the Project tab in AIM, a project wizard can be used to automate an AIM simulation.
Application-Based Wizards
An application-based wizard is executed wholly in a specified ANSYS application which provides both
scripting capabilities and ACT support (Mechanical, SpaceClaim, DesignModeler, Electronics Desktop,
Fluent, Fluent Meshing, and AIM). It utilizes the functionality provided by the target application and
provides simulation guidance within the applications workflow.
Application-based wizards executed in AIM are called custom templates and are exposed in AIM under
Simulation Process Templates. When launched, a custom template automatically sets up a simulation
process, defining a custom data panel with custom properties to drive your simulation. The ability to
create both single-step and multiple-step templates is available.
Wizards for some applications, such as native applications like Mechanical or DesignModeler, are run
only within the Workbench environment. Wizards for some other applications (such as those for
125

SpaceClaim, Electronics Desktop, or Fluent) can be run either within the Workbench environment or in
a stand-alone instance of the application.
The table below shows where different application-based wizards can be launched
ANSYS
Application
Launched in Workbench
Environment
Launched in Standalone Instance of the

Application
AIM
SpaceClaim
DesignModeler
Mechanical
Electronics
Desktop
Fluent (Beta)
Mixed Wizard
A mixed wizard is launched from the ANSYS Workbench Project tab and then engages one or more
supported ANSYS applications in order to automate the entire simulation process. A mixed wizard is
used when interactive selection on the model is required at a given step in one given application; it
provides native workflow guidance in both the Project tab and the included applications.
Creating Wizards
As with any extension, you must have an ACT license to create a wizard. (Once a scripted wizard is
complete and the binary version has been created, however, no license is needed to execute it.)
To start creating wizards, you can download templates from the ANSYS ACT Application Store on the
ANSYS Customer Portal.
The following topics are addressed:
Parts of a Wizard
XML Extension Definition File
IronPython Script
Custom Help for Wizards
Customizing the Layout of a Wizard
Parts of a Wizard
ACT wizards include the following files:
XML extension definition file and referenced IronPython script (required)
These files are the same as required for a standard ACT extension and use the same XML and IronPython syntax. Specific elements have to be used in the XML file to define the wizard. To create a wizard,
you can simply begin with an existing extension and modify it. For details on syntax, see the ANSYS
ACT XML Reference Guide and the ANSYS ACT API Reference Guide.
Custom help files (optional)
126
Creating Wizards
HTML files containing text, images, charts, or other control types can be used to provide instructions
or details for the wizard.

To create a wizard, you must define it in the XML extension definition file. The existing requirements
of a standard XML extension file apply. One or more wizards can be added to the XML extension file
by integrating a <wizard> block for each wizard.
Within the <wizard> block, the definition of the wizard requires, at minimum:
Wizard attributes:
name
version
context
Step definitions:
Step attributes:
name
caption
version
context
Callbacks
Properties
An optional <UIdefinition> block can be used to customize the appearance of your wizard. This
block enables you to specify layouts both for the interface as a whole and for individual interface
components. For more detailed information on customizing the user interface of a wizard, see Customizing the Layout of a Wizard (p. 136) and the example Wizard Custom Layout Example (p. 290).
Example: XML Extension File

To illustrate the definition of a wizard, we will use the XML extension file for a project wizard that is
executed from the Workbench Project tab . Within the extension WizardDemos, we will define the
wizard Project Wizard.
Note
The XML definition syntax is the same for all project wizards, regardless of whether they are
run from the Workbench or the AIM Project tab.
Below is our XML extension file, WizardDemos.xml.
<extension version="2" minorversion="1" name="WizardDemos">
<guid>6D33EFFC-C521-4859-8273-BA320044B6B8</guid>
127

<author>ANSYS Inc.</author>
<description>Simple extension to test wizards in different contexts.</description>
</interface>
<wizard name="ProjectWizard" version="1" context="Project" icon="wizard_icon">
<description>Simple wizard for demonstration in the Workbench Project page.</description>
<step name="Geometry" caption="Geometry" version="1" context="Project"
helpFile="help/geometry.html">
<description>Create a geometry component.</description>
<callbacks>
<onupdate>CreateGeometry</update>
<onreset>DeleteGeometry</reset>
</callbacks>
<propertygroup display="caption" name="definition" caption="Basic properties" >
<property name="filename" caption="Geometry file name" control="fileopen" />
<property name="myint" caption="Integer value" control="integer" />
<property name="mytext" caption="Text value" control="text" />
<property name="myquantity" caption="Quantity value" control="float" unit="Pressure" />
<property name="myreadonly" caption="Readonly value" control="text" readonly="true"
default="My value" />
<propertygroup display="property" name="myselect" caption="List of choice" control="select"
default="Option1">
<attributes options="Option1,Option2" />
<property name="option1" caption="Option1 value" control="text" visibleon="Option1" />
<property name="option2first" caption="Option2 first value" control="float" unit="Pressure"
visibleon="Option2" />
<property name="option2seond" caption="Option2 second value" control="float" unit="Length"
</propertygroup>
</propertygroup>
</step>
<step name="Mechanical" caption="Mechanical" enabled="true" version="1" context="Project"
helpFile="help/mechanical.html">
<description>Create a mechanical component.</description>
<callbacks>
<onupdate>CreateMechanical</update>
<onreset>DeleteMechanical</reset>
</callbacks>
<property name="name" caption="System name" control="text" />
<propertytable name="table" caption="TabularData" display="worksheet" control="applycancel"
</propertytable>
</step>
<step name="Fluent" caption="Fluent" version="1" context="Project" helpFile="help/fluent.html">
<description>Create a fluent component.</description>
<callbacks>
<onupdate>CreateFluent</update>
</callbacks>

<property name="dialog" caption="Dialog" control="text">
<callbacks>
<onvalidate>ValidateDialog</onvalidate>
</callbacks>
128
Creating Wizards
</property>
<property name="dialog2" caption="DialogProgress" control="text">
<callbacks>
<onvalidate>ValidateDialogProgress</onvalidate>
</callbacks>
</property>
</step>
<step name="ReportView" caption="ReportView" version="1" context="Project"
layout="ReportView@WizardDemos">
<description>Simple example to demonstrate how report can be displayed.</description>
<callbacks>
<onrefresh>RefreshReport</refresh>
</callbacks>
</step>
<step name="CustomStep" caption="CustomStep" enabled="true" version="1" context="Project"
layout="MyLayout@WizardDemos">
<callbacks>
<onrefresh>RefreshMechanical</refresh>
</callbacks>
</step>
</wizard>
</extension>
Extension definition:
The standard extension definition is the same. The name, version, and IronPython script reference are
unchanged. In our wizard example, the interface context is set to Project because the extension will
be run on the Workbench Project tab.
Wizard definition:
The required name, version, and context attributes are defined. In our example, the context is set
to Project because the wizard will be executed from the Workbench Project tab.
The optional icon and description attributes are also defined. Icon files are stored in the images
folder in the extension directory.
Child nodes define the wizard steps.
Note
For a mixed wizard, the <wizard> context would still be set to Project because the
wizard will be launched from the Project tab. Each step in a mixed wizard would have its
context set to the application in which the step will be executedeither DesignModeler
or Mechanical.
For an AIM custom template, the context attribute is not used for step definitions.
129

Step definitions:
For each step, the required name, caption, and version attributes are defined. In our wizard example,
note that the optional context is set to Project for all the steps; the steps involve creation of a geometry
and two systems in the Project Schematic, so the steps are executed on the Workbench Project tab.
Note
For each step in a mixed wizard, the context would be set to the application in which
the step will be executedeither DesignModeler or Mechanical.
Optional attributes are defined for various steps. For example, the helpFile attribute indicates
the file containing custom help content to be shown in the UI.
Child nodes define callbacks and properties.
Callback definitions:
Callbacks execute an action that has been defined in the IronPython script for the wizard. Each callback
receives the current step as a method argument.
The required <onupdate> callback is invoked when you click the Next button for a Workbench wizard.
In our wizard example, it executes the actions CreateGeometry, CreateMechanical, and CreateFluent.
The <onrefresh> callback is invoked when the next step is initialized. It initiates changes to the interface, so you can use this callback to change the appearance of the wizard, initialize a value to be used
in the current step, instantiate variables, access data of an existing project, etc. In our wizard example,
the <onrefresh> callback executes the RefreshReport and RefreshMechanical actions.
The <onreset> callback resets the state of the step. In our example, it executes the DeleteGeometry
and DeleteMechanical actions.
Note
For an AIM custom template, only the <onupdate> and <onreset> callbacks are
supported.
The <onupdate> callback is invoked when you click the Create Simulation Process
button. Typically, it is used to insert the content of an existing journal into the wizard
to create a workflow and establish boundary conditions, mesh, and solver options.
The <onreset> callback is used to reset situations where the wizard has not been
completed correctly; it allows you to go back to the process properties and modify
them.
Property definitions:
Properties, property groups, and property visibility controls are defined with the same syntax as for a
standard extension property.
The required name , caption , and control attributes are defined for all the properties. The
control attribute specifies the control type for the property. The standard select, float, integer, scoping, text, and fileopen property types are supported. Advanced types such as
applycancel and custom are also supported.
130
Creating Wizards
Optional attributes are also defined for various properties.
The unit attribute specifies the units for the property value.
The readonly attribute specifies whether the property value is editable.
The default attribute specifies the default property value.
The visibleon attribute controls the visibility of the property. In our example, it is used to
control the display of conditional options in a property group.
The <propertygroup> node is used to create groupings of properties. In our example:
For the first property group, no control is defined, so the group is a list of individual properties
inside the <propertygroup> tags.
The second property group is embedded within the first.
In our example, the control attribute set to select , which provides a drop-down list.
The attributes options tag defines the available options.
The visibleon attribute defines the properties in the group are defined as conditional based
on selection from the drop-down.
The <onvalidate> property callback is used to validate the value entered for a property.
The <propertytable> node is used to create a table for the entry of property values in tabular
format. The Temperature and Pressure properties nested inside the <propertytable> tags
create columns for data entry.
IronPython Script
The IronPython script is referenced by the XML extension definition file. It defines the functions that
will be used by the extension and also the actions that will be performed during each step of the wizard.
ANSYS journaling and scripting commands can be used inside the callbacks. You can write the commands
manually or edit commands obtained from a session journal file (either from the temporary journal
stored in your %TEMP% folder or from a journal generated by using the Record Journal menu option).
Example: IronPython Script for a Project Wizard

To illustrate how the IronPython script is used in a wizard, we will continue with the example used in
the previous section, the project wizard run from the Workbench Project tab, called Project Wizard.
Below is the main.py script referenced by our XML extension file.
geoSystem = None
dsSystem = None
fluentSystem = None
def CreateGeometry(step):
global geoSystem
template1 = GetTemplate(TemplateName="Geometry")
geoSystem = template1.CreateSystem()
geometry1 = geoSystem.GetContainer(ComponentName="Geometry")
geometry1.SetFile(FilePath=step.Properties["definition/filename"].Value)
131

def DeleteGeometry(step):
global geoSystem
geoSystem.Delete()
def RefreshMechanical(step):
tree = step.UserInterface.GetPanel("Tree")
root = tree.CreateTreeNode("Root")
node1 = tree.CreateTreeNode("Node1")
root.Values.Add(node1)
node2.Values.Add(node1)
tree.SetTreeRoot(root)
def CreateMechanical(step):
global dsSystem, geoSystem
template2 = GetTemplate(
TemplateName="Static Structural",
Solver="ANSYS")
geometryComponent1 = geoSystem.GetComponent(Name="Geometry")
dsSystem = template2.CreateSystem(
ComponentsToShare=[geometryComponent1],
Position="Right",
RelativeTo=geoSystem)
if step.Properties["name"].Value=="error":
raise UserErrorMessageException("Invalid system name. Please try again.")
dsSystem.DisplayText = step.Properties["name"].Value
def DeleteMechanical(step):
global dsSystem
dsSystem.Delete()
def CreateFluent(step):
global dsSystem, fluentSystem
template3 = GetTemplate(TemplateName="Fluid Flow")
geometryComponent2 = dsSystem.GetComponent(Name="Geometry")
solutionComponent1 = dsSystem.GetComponent(Name="Solution")
componentTemplate1 = GetComponentTemplate(Name="CFDPostTemplate")
fluentSystem = template3.CreateSystem(
DataTransferFrom=[Set(FromComponent=solutionComponent1, TransferName=None,
ToComponentTemplate=componentTemplate1)],
Position="Right",
RelativeTo=dsSystem)
raise Exception("Invalid system name. Please try again.")
fluentSystem.DisplayText = step.Properties["name"].Value
def cbDialog(sender, args):
sender.Container.HideDialog(sender)
def ValidateDialog(step, prop):
dialog = step.UserInterface.GetPanel("ErrorMessage")
dialog.SetMessage("My own error message")
dialog.SetCallback(cbDialog)
dialog.Refresh()
step.UserInterface.Container.ShowDialog(dialog)
def worker(step):
progress = step.UserInterface.GetPanel("Progress")
stopped = progress.UpdateProgress("Start progress...", 0, True)
step.UserInterface.Container.ShowDialog(progress)
for i in range(100):
System.Threading.Thread.Sleep(100)
stopped = progress.UpdateProgress("Start progress...", i+1, True)
if stopped:
break
step.UserInterface.Container.HideDialog(progress)
132
Creating Wizards
def ValidateDialogProgress(step, prop):
thread = System.Threading.Thread(System.Threading.ParameterizedThreadStart(worker))
thread.Start(step)
def ValidatePropActivate(step, prop):
if prop.Value=="Yes":
step.NextStep.Enabled = True
else:
step.NextStep.Enabled = False
steps = step.UserInterface.GetPanel("Steps")
steps.UpdateData()
steps.Refresh()
def RefreshReport(step):
report = step.UserInterface.GetPanel("Report")
report.SetFilename(System.IO.Path.Combine(ExtAPI.Extension.InstallDir,"help","report.html"))
report.Refresh()
pass
This script defines all the actions executed by the callbacks in the XML file. Each step defined in the
XML file may include multiple actions. In our example XML extension file:
Step 1 (Geometry): The <onupdate> callback executes the CreateGeometry action and the <onreset> callback executes the DeleteGeometry action. These create a geometry on the Project
Schematic and delete it.
Step 2 (Mechanical): The <onupdate> callback executes the CreateMechanical action and the
<onreset> callback executes the DeleteMechanical action.
Step 3 (Fluent): The <onupdate> callback executes the CreateFluent action.
Actions executed by callbacks within property definitions are also defined.
Note
For a mixed wizard, the definition of the first step executed in the Project tab also specifies
the applications and component names from which subsequent steps will be executed. For
instance, in the excerpted code sample below, we can see that multiple actions are defined;
these will be called by the steps in the process definition file.
def action1(step):
template1 = GetTemplate( TemplateName="Static Structural", Solver="ANSYS")
system1 = template1.CreateSystem()
geometry1 = system1.GetContainer(ComponentName="Geometry")
geometry1.SetFile(FilePath=step.Properties["filename"].Value)
nextStep = step.NextStep
if nextStep!=None:
nextStep.SystemName = system1.Name
nextStep.ComponentName = "Geometry"
thirdStep = step.Wizard.Steps["Step3"]
if thirdStep!=None:
thirdStep.SystemName = system1.Name
thirdStep.ComponentName = "Model"
133
Custom Help for Wizards

You can use custom HTML help files to provide instructions or details about each step in a wizard.
Custom help can be defined at the step-level and at the property-level. The help files can contain any
valid HTML5 syntax and supported media (such as images, graphs, etc.) to display your help content.
Creating Custom Help for Wizards

Help File Naming Rules:
Step-Level Help
The filenames for step-level help files must have the same name as the associated step. For example, if a
step name is GeometryStep, the corresponding help file must be named GeometryStep.html.
Property-Level Help
The filenames for property-level help files must be the step name and the property name, separated by
an underscore. For example, if a step is named MeshingStep and one of its properties is named
MeshResolution, the corresponding help file must be named MeshingStep_MeshResolution.html.
Note
For property-level help, it is recommended that you do not include images and limit the
message text to about 200 characters.
Help File Placement:
Non-AIM Wizards
For non-AIM wizards, help files can be stored in any folder inside the extension, so long as the relative
path is provided in the XML reference.
Important
When the extension is loaded to AIM, the folder will be copied into the
%AWP_ROOT171%\commonfiles\help\ACSHelpServer\docu_aim_html\custom directory for display in the help panel. The user must have access to this directory in order to
view the help for the custom template.
AIM Custom Templates
For AIM custom templates, help files must be stored in the extensions help folder.
Help File Naming References:
Step-Level Help
Step-level help is referenced by using the helpFile attribute in the XML step definition. The attribute
should be set to the relative path for the referenced help file.
The following example is a step-level help reference in a wizard. In this example, note that the help files
are located in a user-specified directory inside the extension called wizardhelp
<step name="Geometry" caption="Geometry" version="1" helpFile="wizardhelp/geometry.html">
134
Creating Wizards
The following example is a step-level help reference in an AIM custom template. Note that the help files
are located in the extensions help directory, as required.
<step name="Geometry" caption="Geometry" version="1" context="Project" helpFile="help/geometry.html">
Property-Level Help
Property-level help files are referenced automatically according to filename; they do not need to be explicitly
referenced in the XML file. Once the helpFile attribute has been applied to a step, the extension will
automatically find and display the help files for properties defined within the step.
For examples of custom help implementation for wizards, see Project Wizard (Workbench Project
Tab)* (p. 236), Mechanical Wizard* (p. 254), and DesignModeler Wizard* (p. 251).
For examples of custom help implementation for AIM custom templates, see AIM Custom Template
(Single-Step) (p. 278) and AIM Custom Template (Multiple-Step) (p. 283).
Viewing Custom Help for Wizards

When a wizard is executed, by default the step-level custom help content is displayed in a help panel
at the bottom of the wizard interface.
You can change the location of this panel by customizing the layout of the wizard, as described in
Customizing the Layout of a Wizard (p. 136).
When an AIM custom template is executed:
135

Step-level help is shown in AIM's context-sensitive help panel. To access the help for a step, click on the
question mark icon at the top of the step.
Note
After moving to a new step, you must click on this icon to refresh the help panel with the
new content.
Property-level content is shown when you click the question mark (field-level help) icon that displays when
you mouse over a property.
Customizing the Layout of a Wizard

ACT provides you with the capability to customize the user interface of a wizard, defining layouts both
for the interface as a whole and for the individual interface components within the layout. Since the
basic construction of an extension is described elsewhere, in this section well focus solely on aspects
of layout customization.
Layout customizations are defined by the optional <UIDefinition> block, which is placed inside
the <extension> block in the XML extension definition file. The UI definition collects layout definitions,
which in turn collect component definitions.
The basic definition of the <UIDefinition> element is as follows:
<uidefinition>
<layout>
<component/>
<component/>
136
Creating Wizards
<component/>
<component/>
</layout>
</uidefinition>
The customization elements are exposed in a wizard as follows:
User Interface Definition

The <UIDefinition> tag defines a single user interface definition for a wizard. It is the top-level entry
that collects all layout definitions.
Layout Definition
The <layout> tag defines a single custom layout within a wizard UI definition; a separate layout can be
defined for each of the steps in a wizard. It collects all the component definitions.
The <layout> tag has the following attributes:
The name attribute defines a name for the layout. The name is referenced in a wizard step in the following
format:
LayoutName@ExtensionName
This notation allows a wizard to reference a layout defined in a different extension.

Component Definition
The <component> tag defines a single component of the wizard interface.
The <component> tag has the following attributes:
137

The mandatory name attribute defines a name for the component.
The component name is required to position it next to another component. To do this, use the name
in conjunction with the following attributes:
leftAttachment
rightAttachment
bottomAttachment
topAttachment
The component name is also used in the IronPython script with the GetComponent() method. For
instance, in the Onrefresh callback of a step, we can use the following code:
component = step.UserInterface.GetComponent(ComponentName)
The mandatory heightType, widthType, height, and width attributes define the dimensions of
the component. Possible values are as follows:
FitToContent: The component will have a default size that is set by ACT. When selected, the
height and width attributes become irrelevant.
Percentage: The height and width of the component will be expressed as percentages.
Fixed: The height and width of the component will be expressed in pixels.
The mandatory componentType attribute defines the type of component. Some examples of possible
component types are:
startPageHeaderComponent (Defines banner titles)
propertiesComponent
chartComponent
tabularDataComponent
buttonsComponent
stepsListComponent
The leftOffset, rightOffset, bottomOffset, and topOffset attributes specify the distance
and the margin between the different components.
The customCSSFile, customHTMLFile, and customJSFile attributes provide advanced capabilities to customize an entire component.
For an example of customizing a wizard interface, see Wizard Custom Layout Example (p. 290).
138
Using Wizards
Installing and Loading Wizards

For AIM, Workbench, and any target applications launched through Workbench, the installation process
for a wizard is the same as for any other extension. For more information, see Installing a Scripted Extension (p. 26) and Installing a Binary Extension (p. 27).
To install a SpaceClaim or Electronics Desktop wizard when Workbench and AIM are not installed, the
install locations are slightly different. For more information, see Installing a SpaceClaim Wizard (p. 139)
and Installing an Electronics Desktop Wizard (p. 139).
The process of loading and unloading wizards is as for any other extension. For more information, see
Loading and Unloading Extensions (p. 29).
Installing a SpaceClaim Wizard

To install a SpaceClaim wizard, save the wizard extension and associated files to one of the following
locations:
%ANSYSversion_DIR%\scdm\Addins
Any of the include directories specified by using the gear icon on the Extension Manager (accessed via the
ACT Start Page)
Installing an Electronics Desktop Wizard

To install an Electronics Desktop wizard, save the wizard extension and associated files to one of the
following locations:
...\AnsysEM\v171\ACT\win64\syslib\ACT
Any of the include directories specified by using the gear icon on the Extension Manager (accessed via the
ACT Start Page)
Using Wizards
This section discusses accessing and executing an installed and loaded wizard.
Related Topics:
Using a Workbench or Target Application Wizard
Using an AIM Custom Template
Using a Workbench or Target Application Wizard

Related Topics:
Launching a Wizard from the Wizards Page
The Wizard Interface
Entering Data in a Wizard
Exiting a Wizard or Project
Launching a Wizard from the Wizards Page

To launch a wizard (Project, mixed, or target application):
139

1. Open the application in which the wizard will be executed, as follows:
For a project wizard run in AIM, open AIM.
For a target-application wizard run in a standalone instance of SpaceClaim or Electronics Desktop,
open the corresponding application.
For all other wizards, open Workbench.
2. Open the ACT Start Page as follows:
AIM or Workbench: Click the Extensions > ACT Start Page menu option.
SpaceClaim: Click the Prepare > ACT Start Page toolbar icon.
Electronics Desktop: Click the View > Wizards menu option.
3. On the ACT Start Page, click the Wizards icon.
The Wizards page will open, showing all the wizards currently installed for this context.
4. Click the wizard you want to run. Alternatively, you can select Execute Wizard from the wizard's
context or dropdown menu.
The wizard interface will open, showing the first step of the wizard.
Note
You can use the Search field to search for a wizard by the name, description, or
author of the extension. The case-insensitive search tool looks for all strings entered
that are separated by a blank (serving as the AND operation) and performs a combined search for strings separated by the OR operation.
140
Using Wizards
The Wizard Interface

The default interface for a Workbench-based wizard is divided into four panels, as shown below:
Top: Shows general information about the wizard and a logo of your choice.
Left: Shows a list of the steps in the wizard, with the current step highlighted.
Right: Shows the data-entry and data-display fields for the selected step.
Bottom: Shows the custom help for the selected step.
Note
The overall content and function of the wizard interface is consistent across applications.
However, the display may vary slightly, depending on the application and any customizations
to the interface.
Entering Data in a Wizard

For each step of the wizard, enter your data in the fields provided. Entered values will be validated as
specified in the extension.
141

When all the required values have been entered and pass validation, the Next button will become enabled. When you click this button, your data is submitted and the action defined in the step is executed.
There may be a progress bar for the steps execution, and a message confirming the completion of the
step execution will be displayed. You can also verify completion of the step by reviewing the Project
tab.
Once you are past the first step, the Back button is enabled. When you click this button, the wizard
returns to the previous step, but the data generated for that step is lost.
To enter tabular data:
1. Click the Edit button.
2. Click the Add icon to add a table row.
3. Enter values into the cells.
4. When finished entering data, click the green check box icon to save or the red "X" icon to cancel
Exiting a Wizard or Project

To exit a wizard that has completed, click the Finish button to return to the ACT Start Page.
To exit a wizard at any time, click the Exit Wizard button in the lower left corner of the interface to
return to the Wizards page.
Note
If you exit the wizard midway through, the changes to the project are retained and can
be saved, but the wizard itself is not. You cannot resume the wizard where you left off
when using the Exit Wizard button.
To exit the project with a wizard still in process, save the project and exit as usual. Upon reopening the
project, the wizard will still be in the state it was last saved in, so you can resume it where you left off.
Using an AIM Custom Template

To launch an AIM custom template:
1. Expand Simulation Process Templates.
The section will contain a simulation process template for each custom template. (In the image
below, a template called Cooling Jacket has been added.)
142
Using Wizards
2. Click the custom template you want to run.

On the Study panel, the first part of the workflow defined by the custom template is displayed
as a custom data panel.
3. Enter the information required by the step.
143
In the example above, youd select a geometry, optionally change the value in the Number of
Analyses field, and click Create Simulation Process in order to create the simulation. The
custom template will then walk you through each step in the simulation process.
144
APIs Description
ACT supports application customization with a set of interfaces for each supported application. This
chapter details aspects of the APIs delivered by ACT. The high-level member interfaces of the APIs expose
the properties and methods that allow access to the applications underlying data.
The extensions that are loaded by the Workbench Extension Manager are each configured and initialized
to support Python scripting. For each extension, a global variable ExtAPI gives access to the
DataModel property. This property returns an IDataModel object, which has properties that return
all of the high-level interfaces available for customizations. The complete list of member interfaces is
given in the ANSYS ACT API Reference Guide.
APIs for Custom Workflows in the Workbench Project Page

This section describes the APIs provided by ACT for the customization of the Workbench Project
Schematic. These APIs provide access to items in the Workbench schematic, including the framework
data model, interface components, and user objects and their properties.
Using the APIs, you can create custom workflows in the Workbench Project Schematic. At the workflow
level, you can use global callbacks to invoke schematic actions (both installed and custom). You can
also create and expose custom tasks (components) and taskgroups (systems) that can interact with
each other, as well as with installed components and systems, as part of the schematic workflow.
Accessing Project-Level APIs

You can access project-level ACT custom workflow APIs off the master ExtAPI entry point.
Project
The top level of the project hierarchy is the framework-level Project. It provides additional entry points to
the Workbench data model, file manager, etc. and is accessed as follows:
project = ExtAPI.DataModel.Project
Context
This is the framework-level command context. It provides additional entry points to the session and project
utilities, and is accessed as follows:
Tasks
This is all of the tasks within the schematic, both ACT-defined and pre-installed tasks. It does not include
the master task level (i.e. ACT and schematic template-like tasks). Only concrete tasks instances are included. It is accessed as follows:
145
APIs Description
tasks = ExtAPI.DataModel.Tasks
Note
This section only provides the top-level API access points to schematic and workflow-related
data. For a comprehensive listing of API information for custom workflows, see the <workflow> section of the ACT API Reference Guide.
APIs for ANSYS Mechanical

This section describes some of the APIs provided by ACT for the customization of the ANSYS Mechanical
application. These APIs provide access to all the objects in the Mechanical tree (Project, Model, and
Analysis), allowing you to manipulate the objects and their properties.
Using the APIs, you can both create new objects and modify existing ones.
Note
When you create a new object, Mechanical initializes the object's property values in the
Details window to the same default values used when you add an object via standard mouseclick operations. Some properties, such as scoping or the mass of a point mass, may be invalid
until you enter a value.
For more information on ANSYS Mechanical APIs and their properties, refer to the ANSYS ACT API Reference
Guide.
Directly Accessing an Object

You can get to an object by programmatically navigating the Mechanical tree.
146

The root node of the tree is ExtAPI.DataModel.Project. Each tree node has children that you
can access by calling Children property; this returns all of the child nodes in the project.
You can also call nested properties, such as Model, Geometry, Mesh, or Analyses, in order to access
all of the instances of a given object or tree level.
Connection = ExtAPI.DataModel.Project.Model.Children[3]
Mesh = ExtAPI.DataModel.Project.Model.Mesh
Handling Property Types

This section provides examples of how to handle the various property types used within the Mechanical
application.
Quantity: A unit-based value typically related to a physical quantity.
Example:
my_object.ElementSize = Quantity("0.1 [m]")
Numerical Value (float and integer): A property, such as Relevance or Rate, expecting a numerical
value (a number for which a unit is not specified).
Example:
my_object.TetraGrowthRate = 2
Boolean: A property expecting a True or False value.

Example:
my_object.WriteICEMCFDFiles = True
Geometry Scoping: A property whose value is one or more geometric entities. In these cases, you must:
1. Create selection information and specify the Ids of the entities you want to manipulate.
2. Assign this list of Ids to the Location / SourceGeometry properties.
Example:
my_selection = ExtAPI.SelectionManager.CreateSelectionInfo(SelectionTypeEnum.GeometryEntities)
my_selection.Ids= [28,25]
My_object.Location = my_selection
API Examples: Model Object

This section addresses the programming calls that query for properties of Geometry, Mesh, and
Connections properties within the Model object of the ANSYS Mechanical tree.
The following examples all share the same four general steps:
1. Obtain the tree item under which the object will be created.
2. Create the object.
3. Create the selection information on which the object will be based.
147
APIs Description
4. Specify property values for the object.
Geometry: Point Mass

This example shows how to use ACT API to customize the Geometry object in the ANSYS Mechanical
tree. Specifically, it illustrates how to add a point mass on a face of the geometry and activate the pinball
region.
geometry = ExtAPI.DataModel.Project.Model.Children[0]
point_mass = geometry.AddPointMass()
my_selection.Ids = [22]
point_mass.Location = my_selection
point_mass.Mass = Quantity("12 [kg]")
point_mass.MassMomentOfInertiaX = Quantity("1.1 [kg m m]")
point_mass.MassMomentOfInertiaY = Quantity("1.2 [kg m m]")
point_mass.MassMomentOfInertiaZ = Quantity("1.3 [kg m m]")
point_mass.Behavior = LoadBehavior.Coupled
point_mass.PinballRegion = Quantity("0.2 [m]")
It results in the creation of the point mass and activation of the pinball region in ANSYS Mechanical, as
shown below:
Mesh: Mesh Control

This example shows how to use ACT API to customize the Mesh object in the ANSYS Mechanical tree.
Specifically, it illustrates how to create a meshing control that applies the Patch Independent algorithm
to the mesh.
mesh = ExtAPI.DataModel.Project.Model.Mesh
mesh_method = mesh.AddAutomaticMethod()
my_selection.Ids = [16]
mesh_method.Location = my_selection
mesh_method.Method = MethodType.AllTriAllTet
mesh_method.Algorithm = MeshMethodAlgorithm.PatchIndependent
mesh_method.MaximumElementSize = Quantity("0.05 [m]")
mesh_method.FeatureAngle = Quantity("12.000000000000002 [degree]")
mesh_method.MeshBasedDefeaturing = True
mesh_method.DefeaturingTolerance = Quantity("0.0001 [m]")
mesh_method.MinimumSizeLimit = Quantity("0.001 [m]")
mesh_method.NumberOfCellsAcrossGap = 1
148

mesh_method.CurvatureNormalAngle = Quantity("36 [degree]")
mesh_method.SmoothTransition = True
mesh_method.TetraGrowthRate = 1
It results in the creation of a Patch Independent meshing control in ANSYS Mechanical, as shown below:
Connections: Frictionless Contact and Beam

This example shows how to use the ACT API to customize the Connections object in the ANSYS Mechanical tree. Specifically, it illustrates how to add a frictionless contact and a beam connection.
connection = ExtAPI.DataModel.Project.Model.Connections
contact_region = connection.Children[0].Children[0]
contact_region.ContactType = ContactType.Frictionless
beam = connection.AddBeam()
beam.Radius = Quantity("0.005 [m]")
reference_scoping = ExtAPI.SelectionManager.CreateSelectionInfo(SelectionTypeEnum.GeometryEntities)
reference_scoping.Ids = [110]
beam.ReferenceLocation = reference_scoping
beam.ReferenceBehavior = LoadBehavior.Deformable
beam.ReferencePinballRegion = Quantity("0.001 [m]")
mobile_scoping = ExtAPI.SelectionManager.CreateSelectionInfo(SelectionTypeEnum.GeometryEntities)
mobile_scoping.Ids = [38]
beam.MobileLocation = mobile_scoping
beam.MobileZCoordinate = Quantity("6.5E-03 [m]")
beam.MobilePinballRegion = Quantity("0.001 [m]")
It results in the creation of a frictionless contact and beam connection in ANSYS Mechanical, as shown
below:
Analysis: Load Magnitude

This example shows how to use the ACT API to customize an Analysis object in the ANSYS Mechanical
tree, adding the magnitude of a load. Specifically, it illustrates how to customize a Static Structural
analysis, specifying the external and internal pressure exerted on a pipe and then applying a force to
a section of the pipe.
static_structural = ExtAPI.DataModel.Project.Model.Analyses[0]
analysis_settings = static_structural.AnalysisSettings.NumberOfSteps = 4
bolt = static_structural.AddBoltPretension()
bolt_scoping = ExtAPI.SelectionManager.CreateSelectionInfo(SelectionTypeEnum.GeometryEntities)
bolt_scoping.Ids = [200]
bolt.Location = bolt_scoping
bolt.DefineBy = BoltLoadDefineBy.Load
bolt.Preload = Quantity("15 [N]")
support = static_structural.AddFixedSupport()
support_scoping = ExtAPI.SelectionManager.CreateSelectionInfo(SelectionTypeEnum.GeometryEntities)
support_scoping.Ids = [104]
support.Location = support_scoping
pressure = static_structural.AddPressure()
pressure_scoping = ExtAPI.SelectionManager.CreateSelectionInfo(SelectionTypeEnum.GeometryEntities)
pressure_scoping.Ids = [220]
pressure.Location = pressure_scoping
pressure.Magnitude.Output.Formula = '10*time'
pressure = static_structural.AddPressure()
pressure_scoping = ExtAPI.SelectionManager.CreateSelectionInfo(SelectionTypeEnum.GeometryEntities)
pressure_scoping.Ids = [221]
pressure.Location = pressure_scoping
pressure.Magnitude.Output.DiscreteValues=[Quantity('6 [Pa]')]
force = static_structural.AddForce()
force_scoping = ExtAPI.SelectionManager.CreateSelectionInfo(SelectionTypeEnum.GeometryEntities)
149
APIs Description
force_scoping.Ids = [219]
force.Location = force_scoping
force.Magnitude.Output.DiscreteValues=[Quantity('11.3 [N]'), Quantity('12.85 [N]')]
In our example, we apply the internal and external pressures to the pipe:
pressure.Magnitude.Output.Formula = '10*time'
pressure.Magnitude.Output.DiscreteValues=[Quantity('6 [Pa]')]
Then we use tabular data to apply a vector force to the pipe:
Note
If you use a constant ramped from t=0s to define the force, the first value cannot be
"0".
force.Magnitude.Output.DiscreteValues=[Quantity('11.3 [N]'), Quantity('12.85 [N]')]
Script execution results in the creation of a Magnitude property for the applied Force, with time as an
input variable and a single output variable:
Although initially we used tabular data to define the Magnitude property, we can also use a constant
value or a time- or space-dependent formula. Below is an example of how to use a constant value to
define the property:
force.Magnitude.Output.DiscreteValues=[Quantity('10 [N]')]
We can also opt to define the Magnitude property with global coordinates, instead of a vector, by using
the following commands:
150

force.DefineBy = LoadDefineBy.Components
force.ZComponent.Output.DiscreteValues = [Quantity('0 [N]'),Quantity('-9 [N]')]
Result: Total Deformation Maximum

This example shows how to use the ACT API to customize the Result object in the ANSYS Mechanical
tree. Specifically, it illustrates how to add a Total Deformation result to a Static Structural analysis and
then solve for the minimum and maximum total deformation.
solution = ExtAPI.DataModel.Project.Model.Analyses[0].Solution
total_deformation = solution.AddTotalDeformation()
analysis = ExtAPI.DataModel.Project.Model.Analyses[0]
analysis.Solve(True)
minimum_deformation = total_deformation.Minimum
maximum_deformation = total_deformation.Maximum
It results in a solved analysis indicating the values for the Minimum and Maximum properties for the
Total Deformation result, as shown below:
151
APIs Description
API Examples: TraverseExtension

The examples in this section address programming calls that query geometry, mesh, simulation and
results properties. Each of the code samples are taken from the TraverseExtension extension.
Traversing the Geometry

The API for geometry data is organized to match the underlying hierarchical data model. The API offers
a variety of property queries through which the connectivity of the geometry entities can be determined.
For instance, it is possible to query for the faces upon which an Edge is defined by using the faces
property exposed by the edge interface. Refer to the Application Customization Toolkit Reference Guide
for a comprehensive list of these interfaces and their properties.
Shown below is the basic hierarchy of the geometry.
- Geometry
- Assembly
- Part
- Body
- Shell
- Face
- Edge
- Vertex
The Python script function traversegeometry() demonstrates how an extension could traverse
the geometry data. In this example, an object of type IGeoData is obtained from the Analysis object
using the GeoData property. This GeoData object is then used to query for a list of IGeoAssembly
objects by calling the Assembly property. For each of the IGeoAssembly objects in the returned
list, the Parts property is called and a list of IGeoPart objects is returned. This pattern is repeated
through the hierarchy of the geometry down to the vertices of each edge.
Below is the content of the traversegeometry() function.
def traversegeometry(analysis):
outFile = analysis.WorkingDir + "SolutionDetails.log"
f.write("*.*.*.*.*.*.*.*\n")
# --- IGeometry Interface
# +++ Properties and Methods
# +++
Assemblies
# +++
CellFromRefId
# +++
SelectedRefIds
geometry = analysis.GeoData
assemblies = geometry.Assemblies
assemblies_count = assemblies.Count
# --- IGeoAssembly Interface
# +++
Name
# +++
Parts
for assembly in assemblies:
assembly_name = assembly.Name
parts = assembly.Parts
parts_count = parts.Count
# --- IGeoPart Interface
# +++
Name
# +++
Bodies
for part in parts:
part_name = part.Name
bodies = part.Bodies
bodies_count = bodies.Count
# --- IGeoBody Interface
152

# +++
Name
# +++
Vertices
# +++
Edges
# +++
Faces
# +++
Shells
# +++
Material
for body in bodies:
faces = body.Faces
faces_count = faces.Count
# --- IGeoFace Interface
# +++
Body
# +++
Shell
# +++
Vertices
# +++
Edges
# +++
Loops
# +++
Area
# +++
SurfaceType
# +++
PointAtParam
# +++
PointsAtParams
for face in faces:
edges = face.Edges
edges_count = edges.Count
# --- IGeoEdge Interface
# +++
Faces
# +++
Vertices
# +++
StartVertex
# +++
EndVertex
# +++
Length
# +++
CurveType
# +++
Extents
# +++
IsParamReversed
# +++
ParamAtPoint
# +++
PointAtParam
# +++
PointsAtParams
for edge in edges:
vertices = edge.Vertices
vertices_count = vertices.Count
# --- IGeoVertex Interface
# +++ Edges
# +++ Faces
# +++ Bodies
# +++ X
# +++ Y
# +++ Z
for vertex in vertices:
xcoord = vertex.X
ycoord = vertex.Y
zcoord = vertex.Z
try:
f.write("
Vertex: "+vertex.ToString()+", X = "+xcoord.ToString()+",
Y = "+ycoord.ToString()+", Z = "+zcoord.ToString()+"\n")
except:
continue
f.close()
return
Traversing the Mesh

The Mesh API offers a variety of property queries through which the connectivity of the mesh entities
can be determined. For comprehensive information on the Mesh API interfaces and properties, see the
ANSYS ACT API Reference Guide.
The following Python script function traversemesh() demonstrates how an extension could traverse
the mesh data. In the example shown below, an object of type IMeshData is obtained from the
IAnalysis object using the MeshData property. This mesh object is then used to query for a list of
153
APIs Description
element IDs with the Elements property. For each of the element IDs in the returned list, the Element
method is called and the corresponding IElement object is returned. This pattern is repeated for all
the nodes for each element. Finally, the coordinates of the nodes are queried. Comments are included
in the example below to clarify script functionality.
Below is the content of the traversemesh() function.
def traversemesh(analysis):
f.write("*.*.*.*.*.*.*.*\n")
# --- IMesh Interface
# +++ MeshRegion
# +++ Node
# +++ Element
# +++ Nodes
# +++ Elements
# +++ NumNodes
# +++ NumElements
elementids = mesh.ElementIds
# --- IElement Interface
# +++ Id
# +++ Type
# +++ Nodes
for elementid in elementids:
element = mesh.ElementById(elementid)
nodeids = element.NodeIds
# --- INode Interface
# +++ Id
# +++ X
# +++ Y
# +++ Z
# +++ Elements
for nodeid in nodeids:
node = mesh.NodeById(nodeid)
nodex = node.X
nodey = node.Y
nodez = node.Z
try:
f.write("
Element: "+elementid.ToString()+" Node: "+nodeid.ToString()+",
X = "+nodex.ToString()+", Y = "+nodey.ToString()+",
Z = "+nodez.ToString()+"\n")
except:
continue
f.close()
return
The Python script function elementcounter() demonstrates another example of how an extension
could access the mesh data. In this example, only the elements of user-selected geometry entities are
considered. First, the script obtains the IGeoData and IMeshData objects. Then the CurrentSelection.Ids property queries the IDs of the selected geometry entities using the ISelectionMgr
object. If no IDs are returned, a MessageBox displays the message "Nothing Selected." Otherwise, the
GeoEntityById and MeshRegionById methods obtain the IGeoEntity and IMeshRegion
objects corresponding to each selected entity. These two objects are used inside the try-except block
to query for the type of entity selected and the number of elements in each entity's mesh. The Type
property of the IGeoEntity interface and the NumElements property of the IMeshRegion interface
are used here and the results are displayed in a MessageBox.
def elementcounter(analysis):
geometry = analysis.GeoData
154

selectedids = ExtAPI.SelectionMgr.CurrentSelection.Ids
if selectedids.Count == 0:
MessageBox.Show("Nothing Selected!")
else:
for selectedid in selectedids:
entity = geometry.GeoEntityById(selectedid)
meshregion = mesh.MeshRegionById(selectedid)
try:
numelem = meshregion.ElementCount
MessageBox.Show("Entity of type: "+entity.Type.ToString()+
" contains "+numelem.ToString()+
" elements.")
except:
MessageBox.Show("The mesh is empty!")
return
return
Traversing Results
The Python function minmaxresults() computes the minimum and maximum component values
of the nodal displacement and the SXX stress component. It begins by instantiating a result reader using
the analysis.ResultsData method. Results are retrieved relative to the finite element model and
queried using either the elementID (elemental result) or the nodeID (nodal result). The displacement
result "U" is a nodal result, whereas the stress result "S" is a result on nodes of the elements. The displacement result stores a set of component values for each node, where the component names are X,
Y and Z.
The script minmaxresults first iterates over the nodeIDs to compute the minimum and maximum
values. Then, the script iterates over the elementIDs and the nodes of each element to compute the
minimum and maximum values.
Note
The second loop over the nodes is filtered to the primary nodes of the elements, since
stress results are available only on these primary nodes. Finally, the results are written
to the output file.
Below are the contents of the minmaxresults() function.
def minmaxresults(analysis):
f.write("*.*.*.*.*.*.*.*\n")
#
# Get the element ids
#
meshObj = analysis.MeshData
elementids = meshObj.ElementIds
nodeids = meshObj.NodeIds
#
# Get the results reader
#
reader.CurrentResultSet = int(1)
#
# Get the displacement result object
disp = reader.GetResult("U")
num = 0
for nodeid in nodeids:
#
155
APIs Description
# Get the component displacements (X Y Z) for this node
#
dispvals = disp.GetNodeValues(nodeid)
#
# Determine if the component diplacement (X Y Z) is min or max
#
if num == 0:
maxdispx = dispvals[0]
mindispx = dispvals[0]
maxdispy = dispvals[1]
mindispy = dispvals[1]
maxdispz = dispvals[2]
mindispz = dispvals[2]
num += 1
if dispvals[0]
maxdispx =
if dispvals[1]
maxdispy =
if dispvals[2]
maxdispz =
if dispvals[0]
mindispx =
if dispvals[1]
mindispy =
if dispvals[2]
mindispz =
> maxdispx:
dispvals[0]
> maxdispy:
dispvals[1]
> maxdispz:
dispvals[2]
< mindispx:
dispvals[0]
< mindispy:
dispvals[1]
< mindispz:
dispvals[2]
# Get the stress result object

# Select the component to retrieve
stress.SelectComponents(["X"])
num = 0
for elementid in elementids:
element = meshObj.ElementById(elementid)
#
# Get the SXX stress component
#
stressval = stress.GetElementValues(elementid)
#
# Get the primary node ids for this element
#
nodeids = element.CornerNodeIds
for i in range(nodeids.Count):
#
# Get the SXX stress component at node "nodeid"
#
SXX = stressval[i]
#
# Determine if the SXX stress component is min or max
#
if num == 0:
maxsxx = SXX
minsxx = SXX
if SXX > maxsxx:
maxsxx = SXX
if SXX < minsxx:
minsxx = SXX
num += 1
#
# Write the results to the output
#
f.write("Max U,X:Y:Z = "+maxdispx.ToString()+" : "+maxdispy.ToString()+" : "+maxdispz.ToString()+"\n")
f.write("Min U,X:Y:Z = "+mindispx.ToString()+" : "+mindispy.ToString()+" : "+mindispz.ToString()+"\n")
f.write("Max SXX = "+maxsxx.ToString()+"\n")
f.write("Min SXX = "+minsxx.ToString()+"\n")
f.close()
156
APIs for ANSYS Design Modeler
User Interface and Toolbars

The UserInterface API provides methods to control the ACT-based GUI of Mechanical. The API is
available using the following entry point:
ExtAPI.UserInterface
This API allows access to toolbars and provides the ability to hide or gray-out ACT-based features. It
cannot be used to create new items (e.g., toolbars); it only provides access to existing UI elements.
ExtAPI.UserInterface.Toolbars is a collection of toolbar objects. Each object has fields to access
Name/Caption/Visibility/Child Entries. Each child has the following properties: Caption,
Enabled, Entries, EntryType, Name, and Visible.
The boolean fields Visible and Enabled can be set to "show" or "hide" so that the user can control
the availability of the buttons depending on the current context.

The following sections describe some of the APIs provided by ACT for the customization of ANSYS
DesignModeler's interface and functionality. Once these customizations are in place, they can be used
to create and manipulate geometries. You can use them to first define and generate primitives and
bodies, and then to apply various operations, tools, or automated processes to the resulting geometries.
The examples provided in this chapter address working with a selected graphic, creating different types
of primitives, and applying different operations. The code for creating primitive bodies or applying operations must be integrated into the <ongenerate> callback.
For more comprehensive information on the DesignModeler API interfaces and their properties, refer
to the ANSYS ACT API Reference Guide.
Using the Selection Manager in DesignModeler

The DesignModeler Selection Manager API allows you to work with graphical selections. It provides
service to get information from and to modify, clear, or retrieve the current selection. Additionally, it
enables you to create new selections or add entities to the new selection.
Working with the Current Selection

The following Selection Manager commands allow you to perform different actions on the currently
selected graphic.
To access the Selection Manager:
selection_manager = ExtAPI.SelectionManager
To clear the current selection:

selection_manager.ClearSelection()
To retrieve the current selection:

selection = selection_manager.CurrentSelection
This command returns an ISelectionInfo object that describes the selected entities.
157
APIs Description
To retrieve entities:
selection.Entities
Creating a New Selection and Adding Entities

The Selection Manager enables you to create new selections and add entities to the current selection.
Both of these tasks can be accomplished by either creating a new ISelectionInfo object or by
directly using a list of entities.
To create a new selection using a new ISelectionInfo object:
face = ExtAPI.DataModel.GeoData.Bodies[0].Faces[0]
selection = selection_manager.CreateSelectionInfo(SelectionTypeEnum.GeometryEntities)
selection.Entities = [face]
selection_manager.NewSelection(selection)
To create a new selection using a list of entities:

selection_manager.NewSelection([face])
To add entities to the current selection using a new ISelectionInfo object:

selection = selection_manager.CreateSelectionInfo(SelectionTypeEnum.GeometryEntities)
selection.Entities = [face]
selection_manager.AddSelection (selection)
To add entities to the current selection using a list of entities:

selection_manager.AddSelection([face])
Creating Primitives
The DesignModeler Primitives API provides you with the ability to create different types of primitive
bodies: sheet bodies, wire bodies, and solid bodies. For each primitive body type, multiple shape options
are available.
Figure 58: Primitive body type and shape options
158

The <primitives> variable ExtAPI.DataModel.GeometryBuilder.Primitives is the
gateway for designing a new geometric body. The code must be integrated into the <ongenerate>
callback.
The Python script function ongenerate() can be used to create a primitive body. The API provides
a variety of queries that allow you to specify properties such as body type, dimensions, shape, point
coordinates, and material.
Creating a Sheet Body

When creating a sheet body, you have the option of defining it in the shape of a cone, cylinder, polygon,
or sphere. Below is an example of the ongenerate() function when used to define a sheet body
cylinder.
def Ongenerate(feature,function):
width = 0.015
height = 0.3
sheetBodies = []
primitive = ExtAPI.DataModel.GeometryBuilder.Primitives
cylinder = primitive.Sheet.CreateCylinder([0.,0.,0.],[0.,0.,height],width)
cylinder_generated = cylinder.Generate()
sheetBodies.Add(cylinder_generated)
feature.Bodies = sheetBodies
feature.MaterialType = MaterialTypeEnum.Freeze
return True
In this example:
The width and height variables are used to define the width and the height of the cylinder.
The sheetBodies variable specifies the type of primitive to be created.
The primitive variable uses the global variable ExtAPI to access the data model and define the geometry
builder, which serves as entry point for ACT into DesignModeler.
The CreateCylinder () method is used to generate the new body, specifying that it is defined by the
following arguments:
Coordinates of the center point of the cylinders base
Coordinates of the center point of the upper face (which will define the direction of the cylinder)
Value of the radius
(This is a float. The integer value << 3 >>, for instance, will be refused, while a value of << 3. >>
will be accepted.)
With the cylinder_generated object, we use the Generate () method to generate the cylinder, as
shown below.
159
APIs Description
Figure 59: Generation of sheet body cylinder primitive
With the lines sheetBodies.Add(cylinder_generated) and feature.Bodies = sheetBodies,

we add the sheet body cylinder to the feature.bodies list so it will be added to DesignModeler after
generation. Bodies not added to this list will not be retained.
With the MaterialType line, we specify a material property of Freeze.
Creating a Wire Body

When creating a wire body, you have the option of defining it in the shape of an arc, curve, ellipse, or
polyline. Below is an example of the ongenerate() function when used to define a wire body polyline.
points_list = [0.,0.,0., 1.,0.,0., 1.,1.,0., 1.,1.,1.]
wireBodies = []
polyline = primitive.Wire.CreatePolyline(points_list)
polyline_generated = polyline.Generate()
wireBodies.Add(polyline_generated)
feature.Bodies = wireBodies
return True
In this example:
The points_list () method is defined for later use in the creation of the polyline body. For arguments,
it expects as a list of coordinate points (defined by three float values per point).
The CreatePolyline () method is applied to the object Wire to generate the new body. As arguments,
this method is expecting the coordinate points defined by the points_list method above.
With the polyline_generated object, we use the Generate () method to generate the polyline, as
shown below.
160

Figure 60: Generation of wire body polyline primitive
The new body is added to the feature.bodies list, as described in Creating a Sheet Body (p. 159).
With the MaterialType line, we specify a material property of Add.
Creating a Solid Body

When creating a solid body, you have the option of defining it in the shape of a box, cone, cylinder, or
sphere. Below is an example of the ongenerate() function when used to define a solid body box.
point1 = [0.,0.,0.]
point2 = [1.,2.,2.]
solidBodies = []
box1 = primitive.Solid.CreateBox(point1, point2)
box1_generated = box1.Generate()
solidBodies.Add(box1_generated)
feature.Bodies = solidBodies
return True
In this example:
The point1 () and point2 () methods are defined for later use in the creation of the solid body. For
arguments, they each expect as a list of coordinate points (defined by three float values per point).
The CreateBox () method is applied to the object Solid to generate the new body. For arguments,
this method is expecting the coordinate points defined by the point1 and point2 methods above.
With the box1_generated object, we use the Generate () method to generate the box, as shown
below.
161
APIs Description
Figure 61: Generation of solid body box primitive
The new body is added to the feature.bodies list, as described in Creating a Sheet Body (p. 159).
With the MaterialType line, we specify a material property of Freeze.
Applying Operations
The DesignModeler Operations API enables you to perform different operations on a geometric body.
Available operations can be divided into two different categories: Primary and Boolean Operations
and Tools Operations.
Figure 62: Operation types and options
The operation variable ExtAPI.DataModel.GeometryBuilder.Operations is the gateway

for performing operations. The code must be integrated into the <ongenerate> callback.
The Python script function ongenerate() can be used to perform various types of operations on a
geometry feature. The API provides primary and Boolean operations that allow you to specify properties
such as body type, dimensions, shape, point coordinates, and material. It also offers a number of tools
that can be used to manipulate your geometry, including actions such as copying or deleting a body
or using transform operations to create a body based on another body or topological components.
162
Applying the Extrude Operation

When using the Extrude operation, you must first create the geometry to which the extrusion will be
applied. You can create any of the sheet primitive shapes listed in Creating Primitives (p. 158). Once the
geometry has been created, you can define and apply the Extrude operation to it.
Below is an example of the ongenerate() function when used to create a polygon sheet body and perform
an Extrude operation.
length = 0.3
bodies = []
polygon=builder.Primitives.Sheet.CreatePolygon([0.,0.,3*length,0.,0.,2.*length,length,0.,2.*length])
polygon_generated = polygon.Generate()
extrude = builder.Operations.CreateExtrudeOperation([0.,1.,0.],length/2.)
bodies.Add(extrude.ApplyTo(polygon_generated)[0])
return True
In this example:
The first part of the function creates a polygon sheet body, using a process similar to the one used to create
a cylinder in Creating a Sheet Body (p. 159).
With the Extrude operation, we use the operations generator builder.Operations.CreateExtrudeOperation. The CreateExtrudeOperation method specifies that the operation is defined by
the following arguments:
Vector coordinates (which will define the direction of the extrusion)
Length of the extrusion
Note
In our example, the same Length variable is used for both the sheet body and the
extrusion definition. We also could have used a different variable for each.
The ApplyTo method specifies the geometry to which the extrude operation will be applied. The ApplyTo() method returns a list of bodies to which the operation will be applied.
With the lines bodies.Add(extrude.ApplyTo(polygon_generated)[0]) and feature.Bodies
= bodies, we add the extruded sheet body polygon to the feature.bodies list so it will be added to
DesignModeler after generation. Bodies not added to this list will not be retained.
163
APIs Description
Figure 63: Application of the Extrude operation to a sheet body polygon
Applying the Transform Edges to Wire Tool

When using the Transform Edges to Wire operation tool, you must first create a geometry that
has some edges. You can create any of the sheet body or solid body shapes listed in Creating Primitives (p. 158). Once the primitive has been created, you can obtain a wire body from its edges by defining
and applying the Transform Edges to Wire tool.
Below is an example of the ongenerate() function when used to create a polygon sheet body apply
the Transform Edges to Wire tool to it.
length = 0.3
bodies = []
polygon = builder.Primitives.Sheet.CreatePolygon([0.,0.,2.*length,0.,0.,1.*length,length,0.,0.7])
polygon_generated = polygon.Generate()
body = builder.Operations.Tools.EdgesToWireBody(polygon_generated.Edges);
bodies.Add(body)
return True
In this example:
The first part of the function creates a polygon sheet body, using a process similar to the one used to create
a cylinder in Creating a Sheet Body (p. 159).
With the body function, we use the operations generator builder.Operations.Tools.EdgesToWireBody. The EdgesToWireBody method specifies that the operation tool will transform the edges of the
sheet body polygon into a wire body.
Note
In our example, the same Length variable is used for multiple faces of the sheet body.
We also could have used a different variable for each face.
The new wire body is added to the feature.bodies list, as described in Applying the Extrude Operation (p. 163).
164
APIs for ANSYS DesignXplorer

Figure 64: Application of the Edges to Wire Body tool to a sheet body polygon

The APIs provided by ACT to customize the ANSYS DesignXplorer application are addressed in the following sections.
DOE APIs
This section discusses the APIs provided by ACT to customize DesignXplorer DOE functionality.
DOE Architecture
The object PSMtrxGenerator is responsible for the execution of the DOE. Regardless of whether the
sampling is built-in or external, it executes the same process via the sampling API.
The main elements of the API, shown below in Figure 65: DesignXplorer's Sampling Architecture (p. 166),
are as follows:
ISamplingMethod : the main interface between DX and the external sampling, which is required to implement it
IServices: the interface for the external sampling to access DX services, such as the calculation of one
or more points
DXPoint: the class that describes and stores the point data, such as variable values, calculation state, etc.
165
APIs Description
Figure 65: DesignXplorer's Sampling Architecture
For more details about the API, see the "API Description" section for DesignXplorer in the ANSYS ACT
API Reference Guide.
The Sampling Process

The PSMtrxGenerator object drives the sampling process as illustrated by the sequence diagram in
Figure 66: DesignXplorer's Sampling Process (p. 167).
First, it retrieves an instance of the sampling through the callback declared in the extension. It provides
the Services object and transfers the complete sampling definition: all variables, parameter and
settings.
Note that the PSMtrxGenerator object retrieves an instance of the sampling each time the sampling
process is started (by invoking the OnCreate callback) and released on completion (by invoking the
OnRelease callback).
After a final CanRun check, the sampling's Run method is invoked. From this point in the sequence,
the external sampling is driving: triggering the calculation of points as needed and also pushing progress
messages and log messages, depending on its capabilities.
166

Figure 66: DesignXplorer's Sampling Process
Optimization APIs
This section discusses the APIs provided by ACT to customize DesignXplorer optimization functionality.
Optimization Architecture
The object OptimizationEngineMgr is responsible for the execution of the optimization. Regardless
of whether the optimizer is built-in or external, it executes the same process via the optimization API.
The main elements of the API, shown below in Figure 67: DesignXplorer's Optimization Architecture (p. 168), are as follows:
IOptimizationMethod: the main interface between DX and the external optimizer, which is required
to implement it
IOptimizationServices: the interface for the external optimizer to access DX services, such as the
calculation of one or more points
DXOptimizationPoint: the class that describes and stores the points data, such as variable values, calculation state, etc.
167
APIs Description
Figure 67: DesignXplorer's Optimization Architecture
For more details about the API, see the "API Description" section in the ANSYS ACT API Reference Guide.
The Optimization Process

The OptimizationEngineMgr object drives the optimization process as illustrated by the sequence
diagram in Figure 68: DesignXplorer's Optimization Process (p. 169).
First, it retrieves an instance of the optimizer through the callback declared in the extension. It provides
the Services object and transfers the complete optimization study definition: all variables, parameter
relationships, objectives, constraints, and settings.
Note that the OptimizationEngineMgr object retrieves an instance of the optimizer each time the
optimization process is started (by invoking the OnCreate callback) and released on completion (by
invoking the OnRelease callback).
After a final CanRun check, the optimizer's Run method is invoked. From this point in the sequence,
the external optimizer is driving: triggering the calculation of points as needed and also pushing progress
messages, history points, convergence values, and log messages, depending on its capabilities.
168

Figure 68: DesignXplorer's Optimization Process
169
170
Associated Libraries
This chapter describes the libraries installed with ACT. These libraries include a set of Python functions
that can be used to develop extensions more efficiently.
The commands related to the examples provided below can be interactively tested using the ACT
Console. The ACT Console is installed with ACT. For more information, see ACT Console (p. 179).
The following sections describe a subset of the available libraries. You can access other libraries from
the ANSYS installation directory and consult the source code for a reference on their use. Libraries can
be found in the following folders in the %ANSYSversion_DIR%\..\Addins\ACT\libraries\
directory:
DesignModeler
ElectonicsDesktop
Fluent
Mechanical
Project
SpaceClaim
Study
Query to Material Properties

Description
This library allows you to access to all material properties defined in Engineering Data. The material is
defined for each body and can be retrieved using the geometry API.
Location
libraries/Mechanical/materials.py
libraries/Project/materials.py
libraries/Study/materials.py
Usage
import materials
Functions
GetListMaterialProperties(mat)
171
This function returns a list of property names for the material mat given in argument.
GetMaterialPropertyByName(mat, name)
This function returns the material property name for the material mat.
InterpolateData(vx, vy, vin)
This function computes a linear interpolation vout = f(vin) with f defined by vy = f(vx).
vx represents a list of values for the input variable.
vy represents a list of values for the property that depends on the input variable defined by vx.
vin is the value on which the function has to evaluate the property.
Example
This command:
import materials
mat = ExtAPI.DataModel.GeoData.Assemblies[0].Parts[0].Bodies[0].Material
materials.GetListMaterialProperties(mat)
returns the following result:

['Compressive Ultimate Strength', 'Compressive Yield Strength', 'Density', 'Tensile Yield Strength',
'Tensile Ultimate Strength', 'Coefficient of Thermal Expansion', 'Specific Heat', 'Thermal Conductivity',
'Alternating Stress', 'Strain-Life Parameters', 'Resistivity', 'Elasticity', 'Relative Permeability']
This command:
prop = materials.GetMaterialPropertyByName(mat,"Elasticity")
prop

{"Poisson's Ratio": ['', 0.29999999999999999, 0.29999999999999999, 0.29999999999999999],
'Bulk Modulus': ['Pa', 166666666666.667, 175000000000.0, 183333333333.333],
'Temperature': ['C', 10.0, 100.0, 1000.0], "Young's Modulus": ['Pa', 200000000000.0,
210000000000.0, 220000000000.0],
'Shear Modulus': ['Pa', 76923076923.0769, 80769230769.2308, 84615384615.3846]}
This command:
val = materials.InterpolateData(prop["Temperature"][1:],prop["Young's Modulus"][1:],10.)
val
val = materials.InterpolateData(prop["Temperature"][1:],prop["Young's Modulus"][1:],20.)
val

200000000000.0
201111111111.0
172
Units Conversion
Units Conversion
Description
This library implements a set of functions to manipulate the unit dependent quantities within an extension. This library is of particular interest each time quantities have to remain consistent with the current
unit system activated in the application.
Location
libraries/DesignModeler/materials.py
libraries/ElectonicsDesktop/materials.py
libraries/Fluent/materials.py
libraries/Mechanical/materials.py
libraries/Project/materials.py
libraries/SpaceClaim/materials.py
libraries/Study/materials.py
Usage
import units
Function
ConvertUnit(value,fromUnit,toUnit[,quantityName])
This function converts the value from the unit fromUnit to the unit toUnit. The user can specify
the quantity name to avoid conflict during conversion. This quantity name is not mandatory.
Example
This command:
import units
units.ConvertUnit(1,"m","mm")

1000.0
Function
ConvertUserAngleUnitToDegrees(api, value)
This function converts the angle value to the unit degrees. If the current activated unit is already degrees, then the value remains unchanged.
Example
This command:
173
import units
units.ConvertUserAngleUnitToDegrees(api,3.14)
returns
180. if the angle unit is set to radius when the command is called
3.14 if the angle unit is set to degrees when the command is called
Function
ConvertToSolverConsistentUnit(api, value, quantityName, analysis)
This function converts the valueof the quantity quantityName from the currently activated unit in
the application to the corresponding consistent unit used by the solver for the resolution of the analysis
analysis.
Example
This command:
import units
units.ConvertToSolverConsistentUnit(api,1.,pressure,Static Structural)
returns
10. if the unit system is set to Metric(mm,dat,N,s,mV,mA) when the command is called
Function
ConvertToUserUnit(api, value, fromUnit, quantityName)
This function converts the value of the quantity quantityName from the unit fromUnit to the
currently activated unit system in the application.
Example
This command:
import units
units.ConvertToUserUnit(api,1.,m,length)
returns
1000. if the current activated unit is millimeter when the command is called
Function
ConvertUnitToSolverConsistentUnit(api, value, fromUnit, quantityName, analysis)
This function converts the valueof the quantity quantityName from the unit fromUnit to the
consistent unit that is used by the solver for the resolution of the analysis analysis.
Example
This command:
import units
units.ConvertUnitToSolverConsistentUnit(api,1.,m,length,Static Structural)
returns
174
MAPDL Helpers
1000. if the consistent unit is millimeter when the command is called
Function
GetMeshToUserConversionFactor(api)
This function returns the scale factor to be applied to convert a length from the unit associated to the
mesh and the currently activated unit in the application.
Example
This command:
import units
units.GetMeshToUserConversionFactor(api)
returns
1000. if the unit associated to the mesh is meter and if the current activated unit in the application
is millimeter.
MAPDL Helpers
Description
This library implements some helpers to write APDL command blocks or to execute ANSYS Mechanical
APDL programs.
Location
libraries/ElectronicsDesktop/ansys.py
libraries/Fluent/ansys.py
libraries/Mechanical/ansys.py
libraries/Project/ansys.py
libraries/Study/ansys.py
Usage
import ansys
Functions
createNodeComponent(refIds,groupName,mesh,stream,fromGeoIds=True)
This function writes the APDL command block (CMBLOCK) for the creation of a node component related
to the geometry entities identified by refIds into the stream stream. refIds refer to geometric IDs
if fromGeoIds is true and the node IDs are retrieved from geometric entities using the associativity
between the geometry and mesh. If fromGeoIds is false, then refIds refer directly to the node IDs to
be written in the component.
createElementComponent(refIds,groupName,mesh,stream,fromGeoIds=True)
175
This function writes the APDL command block (CMBLOCK) for the creation of an element component
related to the geometry entities identified by refIds into the stream stream. refIds refer to geometric
IDs if fromGeoIds is true and the element IDs are retrieved from geometric entities using the associativity between the geometry and the mesh. If fromGeoIds is false, the refIds refer directly to the
element IDs to be written in the component.
RunANSYS(api,args,[runDir[,exelocation]])
This function calls the ANSYS Mechanical APDL program with the command line initialized by args.
The user can specify the folder from which he wants to execute the program with runDir. The location
of the executable is also managed with exelocation.
api parameter must be ExtAPI.
Example
import ansys
ansys.createNodeComponent([refId],"myGroup",mesh,stream)
ansys.RunANSYS(ExtAPI,"")
Journaling Helper
Description
This library implements a helper that can be used to transfer data between Mechanical and the Project
page.
Location
libraries/Mechanical/ansys.py
libraries/Project/ansys.py
libraries/Study/ansys.py
Usage
import wbjn
Functions
ExecuteCommand(api,cmd,**args)
This function executes a journal command specified by cmd You can get a result object by using the
function returnValue(obj) in your journal command. All arguments must implement the serialization
interface provided by .Net. The object sent to the function returnValue(obj) must also implement
the serialization interface. This interface is already implemented for many standard types of data (integer,
double, list). Please note that the standard Python dictionary does not implement this interface by
default. If a dictionary is required, use the SerializableDictionary class provided by ACT.
api parameter must be ExtAPI.
ExecuteFile(api,file,**args)
The same as above but executes a journal file specified by file.
176
Journaling Helper
Examples
This command:
import wbjn
wbjn.ExecuteCommand(ExtAPI,"returnValue(a+b)",a=2,b=3)

5
This command:
import wbjn
wbjn.ExecuteCommand(ExtAPI,"returnValue(a+GetAllSystems()[0].DisplayText+b)",
a="My first system is: ",b=" !")

My first system is: Static Structural !
This command:
import wbjn
dict = SerializableDictionary[str,int]()
dict.Add("e1",1)
dict.Add("e2",2)
wbjn.ExecuteCommand(ExtAPI,'returnValue(d["e1"]+d["e2"])', d=dict)

3
177
178
Development and Debugging

This section provides information that will be helpful during the development and testing of extensions.
When creating an extension, you will use the IronPython language to develop the functions used to
execute the extension. The following links provide documentation on the IronPython language:
IronPython documentation
Python reference book
The following development and debugging functionality is available:
ACT Console
Binary Extension Builder
Debug Mode
Debugging with Microsoft Visual Studio
Note
Most development and debugging tools also have at least one alternate method of access;
where applicable, these alternate access points are noted in the discussion of the tool.
ACT Console
The ACT Console is an ACT tool that can be used to interactively test commands during the development
or debugging of an extension. It is available by default in Workbench, AIM, and the Mechanical application.
In Workbench or AIM:
You can open the ACT Console in either of the following ways:
Click the corresponding icon on the ACT Start Page.
Select the Extensions>View ACT Console menu option in Workbench or AIM
The ACT Console window can be resized, repositioned, and kept open as you switch between applications.
In Mechanical:
You can open and close the ACT Console by clicking the View ACT Console toolbar icon.
179

The ACT Console is initially exposed in a locked position to the right of the graphics view. You
can drag it to anywhere in Mechanical and drop it into a new locked position. By double-clicking
its header bar, you can toggle between the locked position and a floating window. The floating
window can be resized and moved as needed.
Related topics:
Using the Context Menu
Using the Command Line Editor
Using the Command History Window
Using Auto-Completion
Using Bookmarks
ACT Console Keyboard Shortcuts
Using the Context Menu

Each extension runs with a dedicated script engine. In order to access global variables or functions associated to a given extension, you must first select the extension from the Context menu. This menu
is populated with the names of all the extensions currently loaded.
Figure 69: ACT Context Menu
Using the Command Line Editor

The command line editor allows you to enter multiple lines of code and offers features like auto-indentation, text coloration, and matching-bracket highlighting.
You can enter commands either by typing them, pasting them in, or left-clicking a bookmark. As you
type commands, you can make use of command-entry assistance capabilities such as auto-completion.
Use the following key combinations when entering your commands:
180
ACT Console
Key Combination
Action
Shift + Enter
Insert a new line in the command line editor
Enter
Execute the command(s) in the command line

editor
Executed commands are displayed in the command history window.

For a comprehensive listing of the keyboard shortcuts available for the ACT Console, see ACT Console
Keyboard Shortcuts (p. 187).
Using the Command History Window

When you execute one or more commands, the output is displayed in the command history window.
The type of each item displayed in the history can be identified by its text color, as follows:
Text Color
Item Type
Black
Inputs
Blue
Outputs
Red
Errors
To move between commands in the history, use the following key combinations:
Key Combination
Action
Ctrl + up-arrow
Go to the previous command
Ctrl + down-arrow
Go to the next command
You can use the following toolbar icons to work with the contents of the command history window:
1. Show or hide the history of inputs.

2. Show or hide the history of outputs.
3. Show or hide the history of errors.
4. Clear the command history log.
5. Open the Help window.
6. Show hidden icons; only displayed when the console window is not wide enough to display all icons in
the toolbar.
181

Additionally, you can use the repeat icon in the upper right corner of the command history window to
repeat the statement in the console:
Using Auto-Completion
The ACT Console provides "smart" auto-completion, which means it takes syntax elements such as
brackets or quotations marks into account. As you type, a scrollable list of property, method, and
keyword suggestions is displayed above the command line.
Each suggestion has a gray icon with a letter indicating the type of suggestion:
M = Method
P = Property
N = Namespace
E = Enumeration
V = Variable
T = Type
Figure 70: ACT Console Auto-Completion Suggestions and Property Tooltip
Using Auto-Completion Tooltips

When you hold the mouse over a property or method, a tooltip provides information about the item
selected, as follows:
Properties:
read/write mode: ReturnType PropertyName
Description of the property.
182
ACT Console
Methods:
ArgumentType (ArgumentName): ReturnType
ArgumentName: Description of the argument.
Tooltips use color-coding to indicate the syntax, as follows:
green = accessibility
purple = type
orange = warning
blue = arguments
Figure 71: Tooltip Color-Coding
The tooltips can also provide:

Scope variables that are accessed by entering Ctrl +space into an empty field.
.NET properties where applicable.
Warning messages when special attention is needed.
Prototype information for methods (when cursor is inside brackets) and indexers (when cursor is inside
square brackets).
Overloaded methods, including the following details:
Number of overloaded methods.
Prototypes for overloaded methods (accessed by pressing the arrows in the prototype tooltip).
183

Members for overloaded methods (the suggestion tooltip for an overloaded method is a list of all members
from all overloaded methods).
Figure 72: Additonal Tooltip Information
Interacting with Auto-Completion Suggestions

Use the following key combinations to interact with auto-completion suggestions:
Key Combination
Action
Ctrl + space
Open the suggestion tooltip
Esc
Close the suggestion tooltip
Enter
Apply the suggestion
space or symbol
Apply the suggestion followed by the space

or symbol
Supported symbols:
.( ) [ ] { } # ,;:! / = ?
Using Bookmarks
The ACT Console bookmarking feature enables you to bookmark predefined commands for later insertion
into the command line editor. Saved bookmarks are displayed in the Bookmarks pane and can be organized into folders.
Using the Toolbar
You can use the following toolbar icons and context menu to work with bookmarks:
Icons:
1. Add a new bookmark.
184
ACT Console
2. Add a new bookmark folder.
3. Import an existing bookmarks collection.
4. Export the current bookmarks collection.
5. Show hidden icons; only displayed when the console window is not wide enough to display all icons
in the toolbar.
Context Menu:
Creating New Bookmarks or Folders

You can create new bookmarks or folders by any of the following methods:
Click the Add a new bookmark icon to the right of a command history block.
Click the Add a new bookmark or Add a new bookmark folder toolbar icon.
Right-click in the Bookmarks pane and select New Bookmark or New Folder. Where you click determines
where the new bookmark will be placed, as follows:
Right-Click Location
Placement of New Item
Folder
Inside the directory
Bookmark
Below the existing bookmark
Whitespace
At root level, at the bottom of the

bookmarks tree
You can then enter the new bookmarks details in the Bookmark Properties dialog.
Viewing/Editing Bookmark or Folder Properties
You can view or edit the properties of a bookmark or folder in the Bookmark Properties dialog. You can
access this dialog by either of the following methods:
185

Create a new bookmark or folder as described above.
Right-click a bookmark or folder in the Bookmarks pane and select Properties.
You can edit the Caption and Value properties for bookmarks, but only the Caption property for
folders.
Deleting Bookmarks or Folders
You can delete a bookmark or folder by right-clicking it and selecting Delete.
Note
If you delete a folder, all of its contents will be deleted as well.
Organizing Bookmarks and Folders
When creating a new bookmark or folder, you can determine its location by using a particular creation
method, as described in Creating New Bookmarks or Folders (p. 185).
You can organize existing bookmarks or folders by dragging them to the desired location in the
tree.
Importing and Exporting Bookmarks
You can import or export collections of bookmarks as an XML file. To do so, click the Import an existing
bookmarks collection or Export the current bookmarks collection toolbar icon.
For example, Figure 73: Exporting Bookmarks (p. 186) shows a list of bookmarks and the XML file
that would result from an export of the list.
Figure 73: Exporting Bookmarks
186
ACT Console
ACT Console Keyboard Shortcuts

The following tables contain a comprehensive listing of keyboard shortcuts available for the ACT Console.
Table 1: Line Operations
Key Combination
Action
Ctrl + D
Remove line
Alt + Shift + down-arrow
Copy lines down
Alt + Shift + up-arrow
Copy lines up
Alt + down-arrow
Move lines down
Alt + up-arrow
Move lines up
Alt + Backspace
Remove to line end
Alt + Delete
Remove to line start
Ctrl + Delete
Remove word left
Ctrl + Backspace
Remove word right
Table 2: Selection
Key Combination
Action
Ctrl + A
Select all
Shift + left-arrow
Select left
Shift + right-arrow
Select right
Ctrl + Shift + left-arrow
Select word left
Ctrl + Shift + right-arrow
Select word right
Shift + Home
Select line start
Shift + End
Select line end
Alt + Shift + right-arrow
Select to line end
Alt + Shift + left-arrow
Select to line start
Shift + up-arrow
Select up
Shift + down-arrow
Select down
Shift + Page Up
Select page up
Shift + Page Down
Select page down
Ctrl + Shift + Home
Select to start
Ctrl + Shift + End
Select to end
Ctrl + Shift + D
Duplicate selection
Ctrl + Shift + P
Select to matching bracket
Table 3: Multi-Cursor
Key Combination
Action
Ctrl + Alt + up-arrow
Add multi-cursor above
Ctrl + Alt + down-arrow
Add multi-cursor below
Ctrl + Alt + right-arrow
Add next occurrence to multi-selection
187

Key Combination
Action
Ctrl + Alt + left-arrow
Add previous occurrence to multi-selection
Ctrl + Alt + Shift + up-arrow
Move multi-cursor from current line to the line

above
Ctrl + Alt + Shift + down-arrow
Move multi-cursor from current line to the line

below
Ctrl + Alt + Shift + right-arrow
Remove current occurrence from

multi-selection and move to next
Ctrl + Alt + Shift + left-arrow
Remove current occurrence from

multi-selection and move to previous
Ctrl + Shift + L
Select all from multi-selection
Table 4: Go-To
Key Combination
Action
Page Up
Go to page up
Page Down
Go to page down
Ctrl + Home
Go to start
Ctrl + End
Go to end
Ctrl + L
Go to line
Ctrl + P
Go to matching bracket
Table 5: Folding
Key Combination
Action
Alt + L, Ctrl + F1
Fold selection
Alt + Shift + L, Ctrl + Shift + F1
Unfold
Table 6: Other
Key Combination
Action
Tab
Indent
Shift + Tab
Outdent
Ctrl + Z
Undo
Ctrl + Shift + Y, Ctrl + Y
Redo
Ctrl + T
Transpose letters
Ctrl + Shift + U
Change to lower-case
Ctrl + U
Change to upper-case
Insert
Overwrite

The Binary Extension Builder tool provides you with the ability to compile a scripted extension into
a binary extension to be shared with end-users. A separate compiler is not necessary; ACT provides its
own process for encapsulating the scripted extension into a binary format.
188

The encapsulation of the scripted extension (also called "the building of the binary extension") generates
a unique WBEX file. This file contains all the files or directories necessary for the extension. For instructions
on using the Binary Extension Builder, see Building a Binary Extension (p. 13).
You can access the Binary Extension Builder tool in either of the following ways:
The Build context-menu option for an extension in the Extension Manager
Figure 74: Accessing the Binary Extension Builder via the Extension Manager
The Extensions>Build Binary Extension menu option

Figure 75: Accessing the Binary Extension Builder via the Extensions Menu
189

Figure 76: Binary Extension Builder Accessed via Extension Dropdown Menu or via the
Extensions Menu
Debug Mode
When developing an extension, we recommend that you enable Debug mode. You can enable/disable
Debug mode via the Debug Mode option on the Extensions tab of the Options dialog (accessed via
the Tools>Options menu)
190
Debug Mode
Figure 77: Enabling Debug Mode via the Options Dialog
When you enable Debug mode, access points to debugging features are provided in Workbench,
Mechanical, and DesignModeler.
Workbench
In Workbench, Debug mode is activated as soon as the option is enabled.
The Reload Extensions button is added to the Workbench toolbar. It allows you to reload the extensions currently loaded from the Workbench interface; it persists throughout all the native
Workbench tabs (such as Project, Engineering Data, Parameter Set, and DesignXplorer). For more
information, see Reload Extensions (p. 192).
Mechanical and DesignModeler
In Mechanical and DesignModeler, Debug mode is activated and debugging functionality is available the
next time the application is launched. If the application is already open when the Debug mode is activated,
you must exit and reopen it.
The ACT Development toolbar is added to the Mechanical and DesignModeler applications. It includes two buttons: Reload extensions and View log file.
Figure 78: ACT Development Toolbar in Mechanical and DesignModeler
1. Reload extensions: Reloads the currently loaded extensions. For more information, see Reload Extensions (p. 192).
2. View log file: Opens the extension log file. For more information, see Extensions Log File (p. 192).
191
Reload Extensions
The Reload Extensions tool gives you the ability to reload the currently loaded extensions without
having to leave the current application.
This feature is particularly useful during the development of an extension, as it provides an efficient
method of interactively testing the changes in an XML file or Python function. For major changes, you
can ensure that an object acts as expected by deleting the previously-defined ACT objects and then
recreating them.
You can reload extensions in any of the following ways:
the Reload Extensions button on the Workbench or AIM toolbar (Debug mode)
Figure 79: Reload Extensions Button in Workbench or AIM
the Reload Extensions button on the Mechanical or DesignModeler ACT Development toolbar (Debug
mode)
Figure 80: ACT Development Toolbar in Mechanical and DesignModeler
Extensions Log File

The Extensions Log File window provides a log of the messages generated by extensions, including
warnings (shown in orange text) and error messages (shown in red text).
Once opened, the window can be resized, dragged, and kept open as you switch between applications.
To clear the log, click the brush icon in the upper right corner of the log file window.
192

Figure 81: Extensions Log File
You can access the extension log file in any of the following ways:
the corresponding icon on the ACT Start Page
the Extensions>View Log File menu option
the View Log File button on the Mechanical and DesignModeler ACT Development toolbar (Debug mode)

If you have Microsoft Visual Studio , you can use it to debug a running IronPython script.
For example, to debug an extension running in Mechanical:
1. Start Visual Studio.
2. For the Attach to field, verify that the Managed (v.4.0) code type is selected.
193

3. Attach the AnsysWBU.exe process.
4. After attaching the process, open your Python code and set some breakpoints into it.
194
Advanced Programming in C#
This section explains how to replace IronPython code with C# assemblies. C# is used in this document
but any language that creates .NET assemblies can also be used for that purpose. This section assumes
that you already know how to create an assembly in C#.
C# provides two major advantages over IronPython:
Better performance
Superior development environment which provides auto completion.
Initialize the C# Project

Once you have created a C# project and associated the type "Class Library" with this project, add a
reference to the Ansys.ACT.Interfaces assembly of ACT. This DLL is located at
<ANSYS_INSTALL_DIR>/Addins/ACT/bin/<Platform>/Ansys.ACT.Interfaces.dll.
C# Implementation for a Load

The following XML file declares a load to be created in the ANSYS Mechanical application which requires
C# implementation:
<extension version="1" name="CSharp">
<author>ANSYS</author>
<description>This extension demonstrates how to use CSharp to write extension.</description>
<assembly src="CSharp.dll" namespace="CSharp" />
</interface>
<load name="CSharpLoad" caption="CSharp Load" version="1" icon="tload" unit="Temperature"
color="#0000FF" class="CSharp.Load">
<property name="Geometry" control="scoping">
<attributes>
<selection_filter>face</selection_filter>
</attributes>
</property>
</load>
<result name="CSharpResult" caption="CSharp Result" version="1" unit="Temperature" icon="tload"
location="node" type="scalar" class="CSharp.Result">
</result>
</simdata>
</extension>
195
Advanced Programming in C#
In the definition of the load object, the only change is the use of the attribute class. This attribute must
be set to the name of the class to be used for the integration of the load.
The CSharp.Load class is described below:
using
using
using
using
using
using
System;
System.Collections.Generic;
System.Linq;
System.Text;
Ansys.ACT.Interfaces.Mechanical;
Ansys.ACT.Interfaces.UserObject;
namespace CSharp
{
public class Load
{
IMechanicalExtAPI _ExtAPI = null;
public Load(IMechanicalExtAPI extApi,IUserLoad load)
{
_ExtAPI = extApi;
}
public IEnumerable<double> getnodalvaluesfordisplay(ISimLoad load, IEnumerable<int> nodeIds)
{
List<double> res = new List<double>();
var mesh = load.Analysis.MeshData;
foreach (int nodeId in nodeIds)
{
var node = mesh.NodeById(nodeId);
res.Add(Math.Sqrt(node.X * node.X + node.Y * node.Y + node.Z * node.Z));
}
return res;
}
}
}
To implement a callback in C#, create a new method in your class with the name of the callback in
lower case.
In the example, you implement the callback <getnodalvaluesfordisplay> by adding the method
getnodalvaluesfordisplay to the class.
C# Implementation for a Result

The following XML file declares a result to be created in the ANSYS Mechanical application which requires
C# implementation:
<extension version="1" name="CSharp">
<author>ANSYS</author>
<description>This extension demonstrates how to use CSharp to write extension.</description>
<assembly src="CSharp.dll" namespace="CSharp" />
</interface>
<load name="CSharpLoad" caption="CSharp Load" version="1" icon="tload" unit="Temperature"
color="#0000FF" class="CSharp.Load">
196
C# Implementation for a Result

<property name="Geometry" control="scoping">
<attributes>
<selection_filter>face</selection_filter>
</attributes>
</property>
</load>
<result name="CSharpResult" caption="CSharp Result" version="1" unit="Temperature" icon="tload"
location="node" type="scalar" class="CSharp.Result">
</result>
</simdata>
</extension>
For the load definition, the attribute class must be set to the name of the class to be used for the
integration of the result.
The CSharp.Result class is described below:
using
using
using
using
using
using
using
System;
System.Collections.Generic;
System.Linq;
System.Text;
Ansys.ACT.Interfaces.Mechanical;
Ansys.ACT.Interfaces.Post;
Ansys.ACT.Interfaces.UserObject;
namespace CSharp
{
public class Result
{
internal double[] res = new double[1];
public Result(IMechanicalExtAPI extApi, IUserResult result)
{
}
public void evaluate(IUserResult entity, IStepInfo stepInfo, IResultCollector collector)
{
foreach (var id in collector.Ids)
{
res[0] = id;
collector.SetValues(id, res);
}
}
}
}
As for the load definition, the implementation of a new callback simply requires you add a new method
with the name of the callback.
197
198
Examples
ACT supports application customization by exposing a set of interfaces for each supported application.
The examples in this section build upon the methods and techniques discussed in the previous chapters.
Examples are provided for the following areas:
Mechanical Extension Examples
DesignXplorer Extension Examples
Custom ACT Workflows in Workbench Examples
Wizard Examples

The following examples for the ANSYS Mechanical application are provided:
Von-Mises Stress as a Custom Result
An Edge-Node Coupling Tool
Von-Mises Stress as a Custom Result

The example provided in this section reproduces the result for the averaged Von Mises equivalent stress.
This result is already available in the standard results that can be selected in ANSYS Mechanical. This
example is given to demonstrate how you can define a custom result.
First, consider the support required in XML for the definition of the custom result. The interface XML
element contains information to add a toolbar and a toolbar button to the user interface. The callback
function <Create_Mises_Result> gets called when the toolbar button is clicked. Next the simdata
XML element is defined. The child XML element result encapsulates the information needed for the
custom result. One result level callback function is declared. The XML evaluate element provides the
name of the function that is called when the custom result (Von Mises Equivalent Stress) needs to be
computed and stored. This function is called when the custom result values are queried for graphical
display. The XML property element defines one property to be added in the Details pane of the custom
result. For this example, the property integrates a scoping method in the custom result.
<extension version="1" name="Mises">
<toolbar name="Von Mises Stress" caption="Von Mises Stress">
<entry name="Von Mises Stress" icon="result">
<callbacks>
<onclick>Create_Mises_Result</onclick>
</callbacks>
</entry>
</toolbar>
</interface>
<result name="Von Mises Stress" version="1" caption="Von Mises Stress" unit="Stress"
icon="result" location="node" type="scalar">
199
Examples
<callbacks>
<evaluate>Mises_At_Nodes_Eval</evaluate>
</callbacks>
<property name="Geometry" caption="Geometry" control="scoping"></property>
</result>
</simdata>
</extension>
Figure 82: Von-Mises Stress Details (p. 200) shows how the toolbar and result are added to the ANSYS
Mechanical user interface.
Figure 82: Von-Mises Stress Details
The Python script for the Mises extension, shown below, defines a callback function named <Create_Mises_Result>. When activated by the Von Mises Stress toolbar button, this callback creates
the result Von Mises Stress. The callback invokes the Create_Mises_Result method on the simDataMgr interface. The Mises.xml file provides the details needed to create the Von Mises Stress
toolbar/button and result.
In addition, the main.py file contains all the Python functions useful for this extension.
At the top of the script is the list definition for the node adjacency tables. The list, named "link," is a
list of hash maps. Each hash map uses as its hash key the numeral corresponding to the type returned
by the IElementType property. The value for hash map is a list of arrays. The names of the arrays
match the local node numbers for a typical element of the key (element-type). Finally, the content of
each array provides the adjacent local node numbers for the corresponding elements node. This list of
200

arrays makes this extension compatible with all the different element topologies that Mechanical will
potentially create during the mesh generation.
The XML definition for "Von Mises Stress" specifies one other callback that we see in the Python script.
This callback is:
<evaluate>Mises_At_Nodes_Eval<evaluate>
The <evaluate> callback associated with the Mises_At_Nodes_Eval function is invoked as the
result of an event thrown by the ANSYS Mechanical application. The Mises_At_Nodes_Eval function
computes the appropriate stress results and stores them. (The comments in the script below describe
the algorithm used.) It returns the nodal results set stored for the specified node ID. This callback is
used by the graphics system to display the results.
The Python script example also demonstrates the use of utility sub-functions. Using sub-functions to
perform common repetitive task helps to make the script modular and more understandable. The utility
sub-functions used in here are Mises and EigenValues. Mises is called by
Mises_At_Nodes_Eval and returns the computed equivalent stress for a given stress tensor
(SX,SY,SZ,SXY,SXZ,SYZ). The function EigenValues is used by the Mises function to compute the
Eigen vectors for a given stress tensor.
import units
import math
if ExtAPI.Context == 'Mechanical':
link = {}
#kHex20
link.Add(ElementTypeEnum.kHex20,{ 0:[3,1,4], 1:[0,2,5], 2:[1,3,6], 3:[2,0,7], 4:[5,0,7], 5:[1,4,6],
6:[5,7,2], 7:[6,3,4], 8:[0,1], 9:[1,2], 10:[2,3], 11:[3,0], 12:[4,5], 13:[5,6], 14:[6,7],
15:[7,4], 16:[0,4], 17:[1,5], 18:[2,6], 19:[3,7]})
#kHex8
link.Add(ElementTypeEnum.kHex8,{ 0:[3,1,4], 1:[0,2,5], 2:[1,3,6], 3:[2,0,7], 4:[5,0,7], 5:[1,4,6],
6:[5,7,2], 7:[6,3,4]})
#kPyramid13
link.Add(ElementTypeEnum.kPyramid13,{ 0:[3,1,4], 1:[0,2,4], 2:[1,3,4], 3:[2,0,4], 4:[0,1,2,3],
5:[0,1], 6:[1,2], 7:[2,3], 8:[3,0], 9:[0,4], 10:[1,4], 11:[2,4], 12:[3,4]})
#kPyramid5
link.Add(ElementTypeEnum.kPyramid5,{ 0:[3,1,4], 1:[0,2,4], 2:[1,3,4], 3:[2,0,4], 4:[0,1,2,3]})
#kQuad4
link.Add(ElementTypeEnum.kQuad4, { 0:[3,1], 1:[0,2], 2:[1,3], 3:[2,0]})
#kQuad8
link.Add(ElementTypeEnum.kQuad8, { 0:[3,1], 1:[0,2], 2:[1,3], 3:[2,0], 4:[0,1], 5:[1,2], 6:[2,3],
7:[3,0]})
#kTet10
link.Add(ElementTypeEnum.kTet10,{ 0:[2,1,3], 1:[0,2,3], 2:[1,0,3], 3:[0,1,2], 4:[0,1], 5:[1,2],
6:[2,0], 7:[0,3], 8:[1,3], 9:[2,3]})
#kTet4
link.Add(ElementTypeEnum.kTet4, { 0:[2,1,3], 1:[0,2,3], 2:[1,0,3], 3:[0,1,2]})
#kTri3
link.Add(ElementTypeEnum.kTri3, { 0:[2,1], 1:[0,2], 2:[1,0]})
#kTri6
link.Add(ElementTypeEnum.kTri6, { 0:[2,1], 1:[0,2], 2:[1,0], 3:[0,1], 4:[1,2], 5:[2,3]})
#kWedge15
link.Add(ElementTypeEnum.kWedge15,{ 0:[2,1,3], 1:[0,2,4], 2:[1,0,5], 3:[5,4,0], 4:[3,5,1],
5:[4,3,2], 6:[0,1], 7:[1,2], 8:[2,0], 9:[3,4], 10:[4,5], 11:[5,3], 12:[0,3], 13:[1,4],
14:[2,5]})
#kWedge6
link.Add(ElementTypeEnum.kWedge6,{ 0:[2,1,3], 1:[0,2,4], 2:[1,0,5], 3:[5,4,0], 4:[3,5,1],
5:[4,3,2]})
def Create_Mises_Result(analysis):
analysis.CreateResultObject("Von Mises Stress")
201
Examples
# This function evaluates the specific result (i.e. the Von-Mises stress) on each element
# required by the geometry selection
def Mises_At_Nodes_Eval(result, stepInfo, collector):
ExtAPI.Log.WriteMessage("Launch evaluation of the Mises result at nodes: ")
reader = result.Analysis.GetResultsData()
step = int(stepInfo.Set)
reader.CurrentResultSet = step
unit_stress = stress.GetComponentInfo("X").Unit
# Get the selected geometry
prop_geo = result.Properties["Geometry"]
ref_ids = prop_geo.Value.Ids
nodal_stress = [0.] * 6
# Get the mesh of the model
mesh = result.Analysis.MeshData
# Loop on the list of the selected geometrical entities
for ref_id in ref_ids:
# Get mesh information for each geometrical entity
mesh_region = mesh.MeshRegionById(ref_id)
node_ids = mesh_region.NodeIds
# Loop on the nodes related to the current geometrical refId
for node_id in node_ids:
for i in range(6):
nodal_stress[i] = 0.
element_ids = mesh.NodeById(node_id).ConnectedElementIds
num = 0
# Loop on the elements related to the current node
for element_id in element_ids:
tensor = stress.ElementValue(element_id,"X;Y;Z;XY;XZ;YZ")
element = mesh.ElementById(element_id)
# Look for the position of the node nodeId in the element element_id
# cpt contains this position
cpt = element.NodeIds.IndexOf(node_id)
# for corner nodes, cpt is useless.
# The n corner nodes of one element are always the first n nodes of the list
if cpt < element.CornerNodeIds.Count:
for i in range(6):
nodal_stress[i] = nodal_stress[i] + tensor[6*cpt+i]
else:
# For midside nodes, cpt is used and the link table provides the two neighbouring
# corner nodes for the midside node identified in the list by cpt
itoadd = link[element.Type][cpt]
for ii in itoadd:
for i in range(6):
nodal_stress[i] = nodal_stress[i] + tensor[6*ii+i] / 2.
num += 1
# The average stress tensor is computed before to compute the Von-Mises stress
# num is the number of elements connected with the current node node_id
for i in range(6):
nodal_stress[i] *= conv_stress / num
# Von-Mises stress computation
vm_stress = Mises(nodal_stress)
202

# Result storage
if node_id in collector.Ids:
collector.SetValues(node_id, [vm_stress])
# This function computes the Von-Mises stress from the stress tensor
def Mises(tensor):
(S1, S2, S3) = Eigen_Values(tensor)
return sqrt( ( (S1-S2)*(S1-S2) + (S2-S3)*(S2-S3) + (S1-S3)*(S1-S3) ) / 2. )
EPSILON = 1e-4
def Eigen_Values(tensor):
a
b
c
d
e
f
=
=
=
=
=
=
tensor[0]
tensor[1]
tensor[2]
tensor[3]
tensor[4]
tensor[5]

A = -(a+b+c)
p = B-A*A/3
q = C-A*B/3+2*A*A*A/27
R = sqrt(fabs(p)/3)
if q < 0: R = -R
z = q/(2*R*R*R)
if z < -1. : z = -1.
elif z > 1.: z = 1.
phi = acos(z)
S1
S2
S3
else:
S1
S2
S3
= -2*R*cos(phi/3)-A/3
= -2*R*cos(phi/3+2*math.pi/3)-A/3
= -2*R*cos(phi/3+4*math.pi/3)-A/3
= a
= b
= c
return (S1, S2, S3)
An Edge-Node Coupling Tool

The example provided in this section creates a tool that can be used to couple two set of nodes related
to two edges. This example is given to demonstrate how you can develop your own pre-processing
feature (such as a custom load) to address one specific need.
The name chosen for this extension is Coupling. Shown below is an XML file that defines the custom
load. Just as we have seen in previous examples, the interface XML element contains information to
add a toolbar and a toolbar button to the user interface. The callback function <CreateCoupling>
gets called when the toolbar button is clicked. Next, the simdata XML element is defined. The child
XML element load encapsulates the information that defines the support. Of particular importance is
that the issupport attribute value is set to true. The issupport attribute tells ANSYS Mechanical
which type of boundary condition to apply. Three result level callback functions are declared. The
function SolveCmd is registered and called for an event that gets fired when the solver input is being
written. The ShowCoupling and HideCoupling functions are registered and called for events used
203
Examples
to synchronize tree view selections with the content of the graphics pane. The details needed to define
the inputs and behavior of this special load consists of the three properties, Source, Target and Reverse,
along with their behavioral callbacks.
<extension version="1" name="Coupling">
<guid shortid="Coupling">e0d5c579d-0263-472a-ae0e-b3cbb9b74b6c</guid>
<toolbar name="Coupling" caption="Coupling">
<entry name="Coupling" icon="support">
<callbacks>
<onclick>CreateCoupling</onclick>
</callbacks>
</entry>
</toolbar>
</interface>
<load name="Coupling" version="1" caption="Coupling" icon="support" issupport="true"
color="#FF0000">
<callbacks>
<getsolvecommands>SolveCmd</getsolvecommands>
<onshow>ShowCoupling</onshow>
<onhide>HideCoupling</onhide>
</callbacks>
<property name="Source" caption="Source" control="scoping">
<callbacks>
<isvalid>IsValidCoupledScoping</isvalid>
<onvalidate>OnValidateScoping</onvalidate>
</callbacks>
</property>
<property name="Target" caption="Target" control="scoping">
<callbacks>
<isvalid>IsValidCoupledScoping</isvalid>
<onvalidate>OnValidateScoping</onvalidate>
</callbacks>
</property>
<property name="Reverse" caption="Reverse" control="select" default="No">
<attributes options="No,Yes" />
<callbacks>
<onvalidate>OnValidateReverse</onvalidate>
</callbacks>
</property>
</load>
</simdata>
</extension>
Figure 83: Fully-defined Coupling in Mechanical (p. 205) shows how a fully defined coupling appears in
ANSYS Mechanical.
204

Figure 83: Fully-defined Coupling in Mechanical
The Python script for the Coupling extension, shown below, defines a callback function named <CreateCoupling>. When activated by the Coupling toolbar button, this callback creates the load
Coupling. The callback invokes the CreateLoadObject method for the current analysis. The function
SolveCmd is called when the solver input is being generated. SolveCmd invokes GetListNodes
to obtain two lists of nodeids corresponding to the Target and Source edges. These nodeids are
then used to write APDL CP commands to the solver input. GetListNodes is also invoked by the
<ShowCoupling> callback function. In <ShowCoupling>, the IGraphics interface is used to
create a graphics context. Using the object returned, the inter-nodal lines are drawn to provide a visual
representation of the coupling.
The graphics context associated with this custom load and the validation of the user inputs impose to
manage more various situations than for the first example described in the previous section. This explains
why more functions and sub-functions are required for this example.
import graphics
def CreateCoupling(analysis):
analysis.CreateLoadObject("Coupling")
#------------------------------#
Callbacks
#------------------------------def OnValidateReverse(load, prop):
ShowCoupling(load)
def OnValidateScoping(load, prop):
ShowCoupling(load)
def IsValidScoping(load, prop):
if not prop.Controller.isvalid(load, prop):
return False
selection = prop.Value
if selection == None: return False
if selection.Ids.Count != 1: return False
205
Examples
return True
def IsValidCoupledScoping(load, prop):
sProp = load.Properties["Source"]
tProp = load.Properties["Target"]
if not IsValidScoping(load, sProp):
return False
if not IsValidScoping(load, tProp):
return False
sIds = sProp.Value.Ids
tIds = tProp.Value.Ids
try:
sNum = mesh.MeshRegionById(sIds[0]).NodeCount
tNum = mesh.MeshRegionById(tIds[0]).NodeCount
if sNum == 0 or tNum == 0: return False
except:
return False
return sNum == tNum

#------------------------------#
Show / Hide
#------------------------------graphicsContext = {}
def getContext(entity):
global graphicsContext
if entity.Id in graphicsContext : return graphicsContext[entity.Id]
else : return None
def setContext(entity, context):
global graphicsContext
graphicsContext[entity.Id] = context
def delContext(entity):
context = getContext(entity)
if context != None : context.Visible = False
context = None
setContext(entity, None)
def ShowCoupling(load):
delContext(load)
ctxCoupling = ExtAPI.Graphics.CreateAndOpenDraw3DContext()
sourceColor = load.Color
targetColor = 0x00FF00
lineColor
= 0x0000FF
sProp = load.Properties["Source"] ; sSel = sProp.Value
tProp = load.Properties["Target"] ; tSel = tProp.Value
ctxCoupling.LineWeight = 1.5
if sSel != None:
ctxCoupling.Color = sourceColor
for id in sSel.Ids:
graphics.DrawGeoEntity(ExtAPI, load.Analysis.GeoData, id, ctxCoupling)
if tSel != None:
ctxCoupling.Color = targetColor
for id in tSel.Ids:
graphics.DrawGeoEntity(ExtAPI, load.Analysis.GeoData, id, ctxCoupling)
if IsValidSelections(load):
206

ctxCoupling.Color = lineColor
ctxCoupling.LineWeight = 1.5
sList, tList = GetListNodes(load)
for sId, tId in zip(sList, tList):
sNode = mesh.NodeById(sId)
tNode = mesh.NodeById(tId)
ctxCoupling.DrawPolyline([sNode.X,sNode.Y,sNode.Z,tNode.X,tNode.Y,tNode.Z])
ctxCoupling.Close()
ctxCoupling.Visible = True
setContext(load, ctxCoupling)
def HideCoupling(load):
delContext(load)
#------------------------------#
Commands
#------------------------------def SolveCmd(load, s):
s.WriteLine("! Coupling - CP")
sList, tList = GetListNodes(load)
for sId, tId in zip(sList, tList):
s.WriteLine("CP,NEXT,ALL,{0},{1}", sId, tId)
#------------------------------#
Utils
#------------------------------def IsValidSelections(load):
return load.Properties["Source"].IsValid and load.Properties["Target"].IsValid
def GetListNodes(load):
if IsValidSelections(load):
sProp = load.Properties["Source"] ; sIds = sProp.Value.Ids
tProp = load.Properties["Target"] ; tIds = tProp.Value.Ids
geometry = ExtAPI.DataModel.GeoData
sList = GetSubListNodes(geometry, mesh, sIds[0])
tList = GetSubListNodes(geometry, mesh, tIds[0])
rev = False
r = load.Properties["Reverse"].Value
if r == "Yes": rev = True
sList = sorted(sList, key=sList.get)
tList = sorted(tList, key=tList.get, reverse=rev)
return (sList, tList)
def GetSubListNodes(geometry, mesh, refId):
entity = geometry.GeoEntityById(refId)
region = mesh.MeshRegionById(refId)
result = {}
pt = System.Array.CreateInstance(System.Double, 3)
for nodeId in region.NodeIds:
pt[0], pt[1], pt[2] = (node.X, node.Y, node.Z)
result[nodeId] = entity.ParamAtPoint(pt)
207
Examples
return result
DesignXplorer Extension Examples

The following examples for the ANSYS DesignXplorer application are provided:
DOE Extension Examples
Optimization Extension Examples
DOE Extension Examples

The ACT Developers Guide is supplemented by a package of examples DOEExtensionExamples.zip)
that illustrate a few solutions to implement a sampling extension with different programming languages.
The package contains instructions to install and build each extension and can be found in the Extensions
Library of the ANSYS Customer Portal.
The following examples are included:
Example Name
Description
PythonSampling
Fully implemented in IronPython (no build required), this example

is your sandbox. It illustrates many sampling extension features
and is definitely the best example to start with.
PythonSampling is running a simple random exploration of
the parametric space, generating the number of points requested
by the user.
CSharpSampling
This example demonstrates how an extension can be completely

set up when the ISamplingMethod interface is implemented
in C#.
Note that the optimization algorithm is also implemented in C#,
but one could use only the ISamplingMethod implementation
as an adapter to an existing implementation in C# or other
languages.
The project is provided for Microsoft Visual Studio 2010.
Optimization Extension Examples

The ACT Developer's Guide is supplemented by a package of examples (OptimizationExtensionExamples.zip) that illustrate a few solutions to implement an optimization extension with
different programming languages. The package contains instructions to install and build each extension
and can be found in the Extensions Library of the ANSYS Customer Portal.
The following examples are included:
Example Name
Description
PythonOptimizer
Fully implemented in IronPython (no build required), this example

is your sandbox. It illustrates many optimization extension features
and is definitely the best example to start with.
208

PythonOptimizer is running a simple random exploration of
the parametric space, generating the number of points requested
by the user and returning the best candidates found.
CSharpOptimizer
This example demonstrates how an extension can be completely

set up when the IOptimizationMethod interface is
implemented in C#.
Note that the optimization algorithm is also implemented in C#,
but one could use only the IOptimizationMethod
implementation as an adapter to an existing implementation in
C# or other languages.
The project is provided for Microsoft Visual Studio 2010.
CppOptimizer
This example demonstrates how an extension can be implemented

from existing C/C++. The IOptimizationMethod interface is
implemented in IronPython as a wrapper to the C++ symbols, using
the ctypes foreign function library for Python.

The following examples for custom workflows in Workbench (the Project tab) are provided:
Global Workflow Callbacks
Custom User-Specified GUI Operation
Custom, Lightweight, External Application Integration with Parameter Definition
Custom, Lightweight, External Application Integration with Custom Data and Remote Job Execution
Generic Material Transfer
Generic Mesh Transfer
Custom Transfer
Parametric
Global Workflow Callbacks

This custom Workbench workflow example illustrates the use of global callbacks to implement a custom
process or action before or after a Workbench Project Schematic operation. Specifically, it defines preand post-operation callbacks for each available operation. Each task (i.e. the argument passed to each
invoked method) defines an action: writing a message in the command window either before or after
execution of the operation.
This example also shows how to specify that a callback method (in this case, onAfterUpdate) is
processed only for a specific task or template.
209
Examples
XML Definition File

The XML extension definition file (WorkflowCallbacksDemo.xml) performs the following actions:
References the IronPython script main.py.
Specifies that the <interface> blocks context is set to Project because the extension is executed on
the Project tab.
The <workflow> block:
Defines the workflow name and context.
Defines pre- and post-operation global callbacks for each available Project Schematic operation.
<extension version="1" name="WorkflowCallbacksDemo">
<guid shortid="WorkflowCallbacksDemo">96d0195b-e138-4841-a13a-de12238c83f2</guid>
</interface>
<workflow name="WorkflowDemo1" context="Project" version="1">
<callbacks>
<onbeforetaskreset>onBeforeReset</onbeforetaskreset>
<onaftertaskreset>onAfterReset</onaftertaskreset>
<onbeforetaskrefresh>onBeforeRefresh</onbeforetaskrefresh>
<onaftertaskrefresh>onAfterRefresh</onaftertaskrefresh>
<onbeforetaskupdate>onBeforeUpdate</onbeforetaskupdate>
<onaftertaskupdate>onAfterUpdate</onaftertaskupdate>
<onbeforetaskduplicate>onBeforeDuplicate</onbeforetaskduplicate>
<onaftertaskduplicate>onAfterDuplicate</onaftertaskduplicate>
<onbeforetasksourceschanged>onBeforeSourcesChanged</onbeforetasksourceschanged>
<onaftertasksourceschanged>onAfterSourcesChanged</onaftertasksourceschanged>
<onbeforetaskcreation>onBeforeCreate</onbeforetaskcreation>
<onaftertaskcreation>onAfterCreate</onaftertaskcreation>
210

<onbeforetaskdeletion>onBeforeDelete</onbeforetaskdeletion>
<onaftertaskdeletion>onAfterDelete</onaftertaskdeletion>
<onbeforetaskcanusetransfer>onBeforeCanUseTransfer</onbeforetaskcanusetransfer>
<onaftertaskcanusetransfer>onAfterCanUseTransfer</onaftertaskcanusetransfer>
<onbeforetaskcanduplicate>onBeforeCanDuplicate</onbeforetaskcanduplicate>
<onaftertaskcanduplicate>onAfterCanDuplicate</onaftertaskcanduplicate>
<onbeforetaskstatus>onBeforeStatus</onbeforetaskstatus>
<onaftertaskstatus>onAfterStatus</onaftertaskstatus>
<onbeforetaskpropertyretrieval>onBeforePropertyRetrieval</onbeforetaskpropertyretrieval>
<onaftertaskpropertyretrieval>onAfterPropertyRetrieval</onaftertaskpropertyretrieval>
</callbacks>
</workflow>
</extension>
IronPython Script
The IronPython script (main.py) contains the Python code defining the methods invoked by the
global callbacks. This script:
Defines 23 methods:
One method for each of the 22 global callback defined in the XML definition file.
One method to format a message to write to the command line window.
Specifies (via the method arguments) that the onBeforeUpdate and onAfterUpdate methods should
be executed only for updates of Engineering Data tasks.
The file, main.py, contains the following code:
def onBeforeReset(task):
msg = getPrintMessage('pre-reset', task)
print msg
def onAfterReset(task):
msg = getPrintMessage('post-reset', task)
print msg
def onBeforeRefresh(task):
msg = getPrintMessage('pre-refresh', task)
print msg
def onAfterRefresh(task):
msg = getPrintMessage('post-refresh', task)
print msg
def onBeforeUpdate(task):
print msg
else:
print("ignored")
def onAfterUpdate(task):
print msg
else:
print("ignored")
def onBeforeDuplicate(task):
msg = getPrintMessage('pre-duplicate', task)
print msg
def onAfterDuplicate(task):
msg = getPrintMessage('post-duplicate', task)
print msg
def onBeforeSourcesChanged(task):
msg = getPrintMessage('pre-sources-changed', task)
print msg
def onAfterSourcesChanged(task):
msg = getPrintMessage('post-sources-changed', task)
print msg
def onBeforeCreate(task):
211
Examples
msg = getPrintMessage('pre-creation', task)
print msg
def onAfterCreate(task):
msg = getPrintMessage('post-creation', task)
print msg
def onBeforeDelete(task):
msg = getPrintMessage('pre-deletion', task)
print msg
def onAfterDelete(task):
msg = getPrintMessage('post-deletion', task)
print msg
def onBeforeCanUseTransfer(sourceTask, targetTask):
msg = 'in pre-can-use-transfer with source task ' + sourceTask.Name +
' and target task ' + targetTask.Name
print msg
def onAfterCanUseTransfer(sourceTask, targetTask):
msg = 'in post-can-use-transfer with source task ' + sourceTask.Name +
' and target task ' + targetTask.Name
print msg
def onBeforeCanDuplicate():
msg = getPrintMessage('pre-can-use-transfer', None)
print msg
def onAfterCanDuplicate():
msg = getPrintMessage('post-can-use-transfer', None)
print msg
def onBeforeStatus(task):
msg = getPrintMessage('pre-status', task)
print msg
def onAfterStatus(task):
msg = getPrintMessage('post-status', task)
print msg
def onBeforePropertyRetrieval(task):
msg = getPrintMessage('pre-property', task)
print msg
def onAfterPropertyRetrieval(task):
msg = getPrintMessage('post-property', task)
print msg
def getPrintMessage(msg, task):
taskName = 'none'
if task != None:
taskName = task.Name
return 'in ' + msg + ' callback for task ' + taskName
Custom User-Specified GUI Operation

This custom Workbench workflow example implements a custom GUI operation for a task (specifically,
the addition of a custom context menu). This functionality is valuable when you require menu entries
beyond the default Edit menu created by the definition of the <onedit> callback.
212

Figure 84: Custom GUI Operation Schematic View
XML Definition File

The XML extension definition file (EmptyGUI.xml) performs the following actions:
References the IronPython script empty_gui.py.
Defines a single task in the <tasks> block. Within this block, a single context menu is defined in the
<contextmenus> block. Note that it has the <onclick> callback defined, as required.
Defines the inputs and outputs in the <inputs> and <outputs> blocks. Note that an empty input and
an output are defined.
Defines a single taskgroup which contains a single task in the <taskgroups> block.
The file, EmptyGUI.xml, contains the following code:
<extension version="1" name="EmptyGUI">
<guid shortid="EmptyGUI">69d0095b-e138-4841-a13a-de12238c83f6</guid>
<script src="empty_gui.py" />
</interface>
<workflow name="wf3" context="Project" version="1">
<tasks>
<task name="Empty" caption="Empty" icon="Generic_cell" version="1">
<callbacks>
</callbacks>
<inputs>
<input/>
</inputs>
<outputs/>
<contextmenus>
<entry name="Empty Gui Op" type="ContextMenuEntry" priority="1.0" icon="default_op">
<callbacks>
<onclick>click</onclick>
</callbacks>
</entry>
</contextmenus>
</task>
</tasks>
213
Examples
<taskgroups>
<taskgroup name="Empty" caption="Empty" icon="Generic" category="ACT Custom Workflows"
abbreviation="MT" version="1">
<includeTask name="Empty" caption="Empty"/>
</taskgroup>
</taskgroups>
</workflow>
</extension>
IronPython Script
The IronPython script (empty_gui.py) contains the Python code the task executes from the context
menu and update callbacks.
Since the XML extension definition file has both the <onupdate> and <onclick> callbacks, the update
and click methods are defined in the script.
The file, empty_gui.py, contains the following code:
import clr
import Ansys.UI.Toolkit
def click(task):
Ansys.UI.Toolkit.MessageBox.Show("Empty Test!")
def update(task):
ExtAPI.Log.WriteMessage('empty update')
Custom, Lightweight, External Application Integration with Parameter

Definition
The following custom Workbench workflow example illustrates the use of parameter definitions to integrate an external application.
Driven by parameters defined in the XML extension definition file, the external application squares the
value of an input number, which is displayed in the Parameter Set tab. The external application updates
the output parameter to the computed square value. The use of parameters in this example enables
you to leverage DesignXplorer functionality.
Figure 85: Squares Example Schematic View
214

Figure 86: Squares Example in Parameter Set Tab
XML Definition File

The extension definition XML file (Squares.xml) performs the following actions:
References the IronPython script Squares.py.
Defines a single task in the <tasks> block.
Defines the inputs and outputs in the <inputs> and <outputs> blocks. Note that an empty input
is defined.
Defines two parameters in the <parameters> block.
Defines a single taskgroup which contains a single task in the <taskgroups> block.
The file, Squares.xml, contains the following code:
<extension version="1" name="Squares">
<guid shortid="Squares">69d0095b-e138-4841-a13a-de12238c83f4</guid>
<script src="squares.py" />
</interface>
<tasks>
<task name="Squares" caption="Squares" icon="squares_component" version="1">
<callbacks>
</callbacks>
<inputs>
<input/>
</inputs>
<outputs/>
<parameters>
215
Examples
<parameter name="Input" caption="Input" usage="Input" control="Double" version="1"/>
<parameter name="Output" caption="Output" usage="Output" control="Double" version="1"/>
</parameters>
</task>
</tasks>
<taskgroups>
<taskgroup name="Squares" caption="Squares" icon="squares" category="ACT Custom Workflows"
abbreviation="SQRS" version="1">
<includeTask name="Squares" caption="Squares"/>
</taskgroup>
</taskgroups>
</workflow>
</extension>
IronPython Script
The IronPython script (Squares.py) performs the following actions:
Obtains the parameters.
Prepares the inputs.
Writes the input file.
Runs the external solver.
Reads the output file.
Sets the parameters to the calculated solver values.
Since the XML extension definition file has <onupdate> callback, the update method is defined in
the script. All ACT workflow callbacks get a container (for the task) and a context.
The file, Squares.py, contains the following code:
import System
import clr
clr.AddReference("Ans.Utilities")
import Ansys.Utilities
#convenience method to look up parameters based on a predetermined ID
def GetParameterByName(parameters, id):
match = None
for param in parameters:
if param.ParameterName == id:
match = param
break
return match
def update(task):
activeDir = container.GetActiveDirectory()
extensionDir = ExtAPI.ExtensionManager.CurrentExtension.InstallDir
exeName = "ExampleAddinExternalSolver.exe"
solverPath = System.IO.Path.Combine(extensionDir, exeName)
#get parameters owned by container
params = None
lock = context.ContainerReadLock(container)
params = context.Project.GetDataReferencesByType(container, "ParameterAdapter")
lock.Dispose()
#isolate specific parameters
216
inputParam = GetParameterByName(params, "Input")

outputParam = GetParameterByName(params, "Output")
#prep i/o file paths
inputFileName = "input.txt"
outputFileName = "output.txt"
dpInputFile = System.IO.Path.Combine(activeDir, inputFileName)
dpOutputFile = System.IO.Path.Combine(activeDir, outputFileName)
#write input file
if inputParam != None and outputParam != None:
val = inputParam.Value
#write input file
f = open(dpInputFile, "w")
f.write('input='+val.ToString(System.Globalization.NumberFormatInfo.InvariantInfo))
f.close()
#run exe
runInMono = Ansys.Utilities.ApplicationConfiguration.DefaultConfiguration.IsRuntimeMono
monoPath = "mono"
monoArgs = System.String.Format("{0} \"{1}\" \"{2}\"", solverPath, dpInputFile, dpOutputFile)
info = None
if runInMono:
info = System.Diagnostics.ProcessStartInfo(monoPath, monoArgs)
else:
info = System.Diagnostics.ProcessStartInfo(solverPath, System.String.Format("\"{0}\" \"{1}\"",
dpInputFile, dpOutputFile))
info.CreateNoWindow = True
info.WindowStyle = System.Diagnostics.ProcessWindowStyle.Minimized
p = System.Diagnostics.Process.Start(info)
p.WaitForExit()
#read output file
outValue = None
f = open(dpOutputFile, "r")
currLine = f.readline()
while currLine != "":
valuePair = currLine.split('=')
outValue = System.Int32.Parse(valuePair[1], System.Globalization.NumberFormatInfo.InvariantInfo)
f.close()
#set output value
if outValue == None:
raise Exception("Error in update - no output value detected!")
else:
outputParam.Value = outValue
Custom, Lightweight, External Application Integration with Custom Data and

Remote Job Execution
The following custom Workbench workflow example illustrates:
the use of custom task properties to integrate an external application
the specification that the defined task should be submitted via the ANSYS Remote Solve Manager (RSM)
application for remote job execution
Driven by the custom task properties defined in the XML extension definition file, the external application
squares the value of an input number, which is displayed in the Parameter Set tab. Because the task
defines an RSM job, the user can choose either run the task update locally or submit the calculations
217
Examples
via RSM for remote job execution. Once the job has completed, Workbench merges the job back into
the active session and retrieves results. The custom task defined in our extension then updates the
custom property values to the externally-computed square value.
This example also illustrates progress and project reporting functionality.
Figure 87: Data Squares Taskgroup Schematic View
XML Definition File

The extension definition XML file (DataSquares.xml) performs the following actions:
References the IronPython script datasquares_complete.py.
Defines a single task in the <tasks> block. Within this task:
Defines the <onreport> callback, which is called when the user generates a project report. This
allows the task to access the report object and add its own task-specific reporting content.
Defines two property groups with the <propertygroup> blocks. Within the two property groups,
the <property> tags define the Input and Output properties.
Defines the inputs and outputs in the <inputs> and <outputs> blocks. Note that an empty input
is defined here, although this is not required.
Specifies via the <rsmJob> block that the task can be sent via RSM as a job for remote execution.
To specify RSM support, we need only add the <rsmJob> block to a task in an existing XML definition
file. In the RSM job specification:
Attributes specify the name and to indicate that the files will be managed upon successful completion or cancellation of the job.
The <platform> tags specify supported platforms.
The <argument> tags specify the external application's command line parameters, including
input and output file paths.
When using referenced file paths, the same ID may be used across categories, but not
within categories; an input and an output may both have an ID of 1, but two inputs may
not. During the execution, all input and output file names will be transformed into fullyqualified file paths.
The <program> block informs the extension about the task's executable, supported platforms,
and corresponding command-line arguments. Environment variables can be used for the executable
path and previously-defined arguments can be referenced by ID.
The callbacks invoke methods defined in the IronPython script to create the job, check job status,
provide the capability to cancel the job, and access output files and results.
218

In the <taskgroups> block, defines a single taskgroup which includes the DataSquares task.
The file, DataSquares.xml, contains the following code:
<extension version="1" name="DataSquares">
<guid shortid="DataSquares">69d0095b-e138-4841-a13a-de12238c83f2</guid>
<script src="datasquares_complete.py" />
</interface>
<workflow name="MyWorkflow" context="Project" version="1">
<tasks>
<task name="DataSquares" caption="Data Squares" icon="dsquares_component" version="1">
<callbacks>
<onstatus>status</onstatus>
<onreport>report</onreport>
<onreset>reset</onreset>
</callbacks>
<propertygroup name="Inputs">
<property name="Input" caption="Input" control="double" default="0.0" readonly="False"
needupdate="true" visible="True" persistent="True" isparameter="True" />
</propertygroup>
<propertygroup name="Outputs">
<property name="Output" caption="Output" control="double" default="0.0" readonly="True"
visible="True" persistent="True" isparameter="True" />
</propertygroup>
<inputs>
<input/>
</inputs>
<outputs/>
<rsmjob name="squares" deletefiles="True" version="1">
<inputfile id="1" name="input1.txt"/>
<outputfile id="1" name="output1.txt"/>
<program>
<platform name="Win64" path="%AWP_ROOT171%\Addins\ACT\extensions\DataSquares\
ExampleAddinExternalSolver.exe" />
<platform name="Linux64" path="%AWP_ROOT171%/Addins/ACT/extensions/DataSquares
/ExampleAddinExternalSolver.exe" />
<argument name="" value="inputFile:1" separator=""/>
<argument name="" value="outputFile:1" separator=""/>
</program>
<callbacks>
<oncreatejobinput>createJobInput</oncreatejobinput>
<onjobstatus>getJobStatus</onjobstatus>
<onjobcancellation>cancelJob</onjobcancellation>
<onjobreconnect>reconnectJob</onjobreconnect>
</callbacks>
</rsmjob>
</task>
</tasks>
<taskgroups>
<taskgroup name="DataSquares" caption="Data Squares" icon="dsquares" category="ACT Custom
Workflows" abbreviation="DSQRS" version="1">
<includeTask name="DataSquares" caption="Data Squares"/>
</taskgroup>
</taskgroups>
</workflow>
</extension>
The following callbacks reference methods in the IronPython script. The first three callbacks invoke
standard task actions; the rest invoke actions related to the RSM job specification.
<onupdate>
Invokes the update method. Called when the user updates the task.
219
Examples
<onstatus>
Invokes the status method. Called when the application (e.g. Workbench) asks the task for its current
state.
<onreport>
Invokes the report method. Called when the user generates a project report. This allows the extension
to access the report object and add their own task-specific reporting content.
<oncreatejobinput>
Invokes the createJobInput method. Called when the RSM job requires the generation of all specified
input files. Must prepare and generate the input files specified for the RSM job.
As a method argument, ACT passes in the fully qualified input file paths. For our example, we must
only generate one input file that contains the input value for our squares solver. We can retrieve
the first entry from the input file list, open the file, write our input value line, and close the file. ACT
requires no further action.
<onjobstatus>
Invokes the getJobStatus method. Must tell Workbench if the job has finished. Polled by Workbench
several times during the RSM job execution to determine if the update execution has completed. ACT
supplies the fully qualified output file list as a method argument.
For our example, we will return True when we detect the presence of the solver's sole output file.
Otherwise, we return False.
<onjobcancellation>
Invokes the cancelJob method. Called when the user stops the remote update before the job completes.
Must conduct any clean-up actions required due to a user-initiated stoppage. ACT supplies the fully qualified lists of both input and output files as method arguments.
For our example, we need not perform any action as we require only file cleanup; setting the DeleteFiles attribute to True will automatically handle the file cleanup.
<onjobreconnect>
Invokes the reconnectJob method. Called when the job status reports a completed job. Must retrieve
remotely-solved information from output files and update the task's data, rendering it up-to-date.
For our example, we must read the solver's generated output file and update the output property
that we defined on our task.
For information on the methods invoked, see IronPython Script (p. 220).
IronPython Script
The IronPython script (dataquares_complete.py) defines methods which are invoked by the callbacks in the XML definition file. The update, status, and report methods are standard methods
defined for the task. The createJobInput, getJobStatus, cancelJob, and reconnectJob
methods are related to the RSM job specification.
The file, dataquares_complete.py, contains the following code:
def update(task):
activeDir = container.GetActiveDirectory()
220

exeName = "ExampleAddinExternalSolver.exe"
solverPath = System.IO.Path.Combine(extensionDir, exeName)
monitor = context.ProgressMonitor
monitor.BeginTask("Data Sqaures Solver", 3, None)
monitor.TaskDetails = "Preparing solver input..."
monitor.UpdateTask(1, None)
#get param values
inputValue = task.Properties["Inputs"].Properties["Input"].Value
#prep i/o file paths
inputFileName = "input.txt"
outputFileName = "output.txt"
dpInputFile = System.IO.Path.Combine(activeDir, inputFileName)
dpOutputFile = System.IO.Path.Combine(activeDir, outputFileName)
#write input file
f = open(dpInputFile, "w")
f.write('input='+inputValue.ToString(System.Globalization.NumberFormatInfo.InvariantInfo))
f.close()
monitor.TaskDetails = "Executing Solver..."
#run exe
runInMono = Ansys.Utilities.ApplicationConfiguration.DefaultConfiguration.IsRuntimeMono
monoPath = "mono"
monoArgs = System.String.Format("{0} \"{1}\" \"{2}\"", solverPath, dpInputFile, dpOutputFile)
info = None
if runInMono:
info = System.Diagnostics.ProcessStartInfo(monoPath, monoArgs)
else:
info = System.Diagnostics.ProcessStartInfo(solverPath, System.String.Format("\"{0}\" \"{1}\"",
dpInputFile, dpOutputFile))
info.CreateNoWindow = True
info.WindowStyle = System.Diagnostics.ProcessWindowStyle.Minimized
p = System.Diagnostics.Process.Start(info)
p.WaitForExit()
monitor.TaskDetails = "Retrieving results from solver..."
#read output file
outputValue = None
f = open(dpOutputFile, "r")
outputValue = System.Double.Parse(valuePair[1], System.Globalization.NumberFormatInfo.InvariantInfo)
f.close()
#set output value
if outputValue == None:
else:
task.Properties["Outputs"].Properties["Output"].Value = outputValue
monitor.TaskDetails = "Solve completed..."
monitor.EndTask(None)
221
Examples
def createJobInput(task, inputFilePaths):

ExtAPI.Log.WriteMessage('creating job input')
inputFilePath = inputFilePaths[0]
#get param values
inputValue = task.Properties["Inputs"].Properties["Input"].Value
#write input file
ExtAPI.Log.WriteMessage("Writing input value ("+str(inputValue)+") to file (" + inputFilePath + ")")
f = open(inputFilePath, "w")
f.write('input='+inputValue.ToString(System.Globalization.NumberFormatInfo.InvariantInfo))
f.close()
def reconnectJob(task, outputFilePaths):
ExtAPI.Log.WriteMessage('reconnecting job')
outputValue = None
outputFilePath = outputFilePaths[0] #I know we only have one specified based on our definition...so work
off of the first entry
f = open(outputFilePath, "r")
outputValue = System.Double.Parse(valuePair[1], System.Globalization.NumberFormatInfo.InvariantInfo)
f.close()
#set output value
ExtAPI.Log.WriteMessage("Retrieved value (" + str(outputValue) + ") from file (" + outputFilePath + ")")
if outputValue == None:
else:
task.Properties["Outputs"].Properties["Output"].Value = outputValue
def getJobStatus(task, outputFiles):
ExtAPI.Log.WriteMessage('checking job status')
outputFilePath = outputFiles[0]
finished = System.IO.File.Exists(outputFilePath)
return finished
def cancelJob(task, inputFiles, outputFiles):
#nothing to do...just print a message for now.
ExtAPI.Log.WriteMessage('performing cancellation clean up')
import clr
clr.AddReference("Ans.ProjectSchematic")
clr.AddReference("ReportUtility.Interop")
import Ansys.ReportUtility.Interop
import Ansys.ProjectSchematic
def status(task):
status = Ansys.ProjectSchematic.Queries.ComponentState(Ansys.ProjectSchematic.State.Unfulfilled,
"This is unfulfilled!")
return None
def report(task, report):
root = report.GetRootSection()
section = Ansys.ReportUtility.Interop.ReportSection("My Custom ACT Task Report Content")
text = Ansys.ReportUtility.Interop.ReportText("", "Sample text from the data squares component")
section.AddChild(text)
root.AddChild(section)
def reset(task):
task.Properties["Inputs"].Properties["Input"].Value = 0
task.Properties["Outputs"].Properties["Output"].Value = 0
Using RSM Job Submission Capabilities

Once you've defined an extension with an RSM job specification, you can submit your task as an RSM
job for remote execution. To do so:
1. Install and load the extension to Workbench as usual.
2. Add a Data Squares taskgroup to the Project Schematic.
Solution Process properties become available for the taskgroup.
222

Figure 88: Solution Process Properties for the Data Squares Example
3. To specify that your task should be executed remotely, set the Update Option property to Submit to Remote Solve Manager.
Additional Solution Process properties become available.
223
Examples
Figure 89: RSM-Specific Properties for the Data Squares Example
4. Set your Solution Process properties, save, and Update your project.
The task will submit its process to RSM as a new job. Once RSM accepts the job, the task will transition
to the Pending state.
Figure 90: Data Squares Taskgroup in the Pending State
5. To view the status of your RSM job while it is being updated, open the Remote Solve Manager application.
224

Figure 91: Running Job in the RSM Application
Note
To run your jobs locally in the background, set your Update Option property to Run in
Background. Updates will be treated in a similar manner to true remote updates. Workbench
will prepare the update and invoke the same callbacks as in our example, but the update
will proceed as a separate local update instead of engaging RSM.
Generic Material Transfer

This custom Workbench workflow example implements two custom material transfer taskgroups, each
passing material data to a downstream taskgroup or task.
The first taskgroup references a single custom task which passes MatML-formatted material data to a
downstream external Engineering Data taskgroup.
The second taskgroup references both a custom task and an external task. The custom Material task
passes MatML-formatted material data to the downstream external Engineering Data task.
This example also illustrates input/output specification and file management capabilities.
225
Examples
Figure 92: Material Transfer Example Engineering Data View
Figure 93: Custom Taskgroup Passing Material Data to Workbench Taskgroup
Figure 94: Custom Taskgroup with Custom Task Passing Material Data to External Task
XML Definition File

The XML definition file (GenericMaterialTransfer.xml) defines the custom taskgroups which
appear in your custom ACT Workflows taskgroup in the Workbench Toolbox.
The XML extension definition file (GenericMaterialTransfer.xml) performs the following actions:
226

References the IronPython script generic_material_transfer.py.
Specifies that the <onupdate> callback calls the producer_update IronPython function, which accesses
a materials file.
Defines the inputs and outputs in the <inputs> and <outputs> blocks. Note that an empty input and
an output are defined. The output type attribute is set to MatML31, specifying the kind of data exposed
and generated by this task.
Defines two custom taskgroups in the <taskgroups> block.
The first taskgroup, GenericMaterialTransfer, references the custom Material task and transfers
material data to an external Engineering Data taskgroup that has been added downstream.
The second taskgroup, GenericMaterialTransferComplete, references the custom Material
task and also, by using the external attribute, the external Engineering Data task. The custom task
transfers material data to the downstream external task.
The file, GenericMaterialTransfer.xml, contains the following code:
<extension version="1" name="GenericMaterialTransfer">
<guid shortid="GenericMaterialTransfer">69d0095b-e138-4841-a13a-de12238c83f8</guid>
<script src="generic_material_transfer.py" />
</interface>
<tasks>
<task name="Material" caption="Material" icon="material_cell" version="1">
<callbacks>
</callbacks>
<inputs>
<input/>
</inputs>
<outputs>
<output format="" type="MatML31"/>
</outputs>
</task>
</tasks>
<taskgroups>
<taskgroup name="GenericMaterialTransfer" caption="Generic Material" icon="material_system"
category="ACT Custom Workflows" abbreviation="GenMatXfer" version="1">
<includeTask name="Material" caption="Material"/>
</taskgroup>
<taskgroup name="GenericMaterialTransferComplete" caption="Generic Material Complete"
icon="material_system" category="ACT Custom Workflows" abbreviation="GenMatXferComplete" version="1">
<includeTask name="Material" caption="Material"/>
<includeTask external="True" name="EngDataCellTemplate" caption="Engineering Data"/>
</taskgroup>
</taskgroups>
</workflow>
</extension>
IronPython Script
The IronPython script (generic_material_transfer.py) contains the IronPython code that
provides instructions for passing the MatML-formatted material data to a downstream Engineering
Data taskgroup or task. This includes the update method (called by the <onupdate> callback in the
XML extension definition file), which accesses the SampleMaterials.xml file.
227
Examples
The file, generic_material_transfer.py, contains the following code:
def update(task):
matFilePath = System.IO.Path.Combine(extensionDir, "Sample_Materials.xml")
matFileRef = None
isRegistered = IsFileRegistered(FilePath=matFilePath)
if isRegistered == True:
matFileRef = GetRegisteredFile(matFilePath)
else:
matFileRef = RegisterFile(FilePath=matFilePath)
AssociateFileWithContainer(matFileRef, container)
matOutputSet = outputRefs["MatML31"]
matOutput = matOutputSet[0]
matOutput.TransferFile = matFileRef
Material File
This file (Sample_Materials.xml), accessed by the IronPython update method, contains the
MatML-formatted material data:
<?xml version="1.0" encoding="UTF-8"?>
<EngineeringData version="17.1">
<Notes />
<Materials>
<MatML_Doc>
<Material>
<BulkDetails>
<Name>Sample Material</Name>
<Description>Sample material from Driver</Description>
<PropertyData property="pr0">
<Data format="string">-</Data>
<ParameterValue parameter="pa0" format="float">
<Data>494.1474492,912.7972764,1172.453938,1941.495468,2803.754154,3869.063522,5245.395513,
10378.82012,18192.58268,28438.67868,57755.1982,94951.87682,135751.6191,178064.7612,216504.4272,261538.9311,
304701.5076,333300.2826,364061.2544,397079.5705,432533.1159,457543.8578,483751.5301</Data>
<Qualifier name="Variable Type">Dependent,Dependent,Dependent,Dependent,Dependent,Dependent,
Dependent,Dependent,Dependent,Dependent,Dependent,Dependent,Dependent,Dependent,Dependent,Dependent,Dependent,
Dependent,Dependent,Dependent,Dependent,Dependent,Dependent</Qualifier>
</ParameterValue>
<ParameterValue parameter="pa1" format="float">
<Data>0.1338,0.2675,0.3567,0.6242,0.8917,1.1592,1.4268,2.051,2.586,3.0318,3.7898,4.3694,4.8153,
5.172,5.4395,5.707,5.9299,6.0637,6.1975,6.3312,6.465,6.5541,6.6433</Data>
<Qualifier name="Variable Type">Independent,Independent,Independent,Independent,Independent,
Independent,Independent,Independent,Independent,Independent,Independent,Independent,Independent,
Independent,Independent,Independent,Independent,Independent,Independent,Independent,Independent,
Independent,Independent</Qualifier>
</ParameterValue>
</PropertyData>
<PropertyData property="prDriver">
<Data format="string">-</Data>
<Qualifier name="Data Link Version">1</Qualifier>
<Qualifier name="Model Type">Linear;Isotropic</Qualifier>
<Qualifier name="Sample Property">Value</Qualifier>
</PropertyData>
</BulkDetails>
</Material>
<Metadata>
<ParameterDetails id="pa0">
<Name>Stress</Name>
<Units>
<Unit>
<Name>Pa</Name>
</Unit>
</Units>
</ParameterDetails>
<ParameterDetails id="pa1">
<Name>Strain</Name>
228

<Units>
<Unit>
<Name>m</Name>
</Unit>
<Unit power="-1">
<Name>m</Name>
</Unit>
</Units>
</ParameterDetails>
<PropertyDetails id="pr0">
<Unitless />
<Name>Sample Property</Name>
</PropertyDetails>
<PropertyDetails id="prDriver">
<Unitless />
<Name>Driver Link Details</Name>
</PropertyDetails>
</Metadata>
</MatML_Doc>
</Materials>
<Loads />
<BeamSections />
</EngineeringData>
Generic Mesh Transfer

This custom Workbench workflow example implements two custom mesh transfer taskgroups, each
with "consuming" and "providing" connections.
The first custom taskgroup references a single custom task. It consumes a mesh from an upstream external taskgroup and passes it to a downstream Workbench taskgroup.
The second custom taskgroup references both a custom task and multiple external tasks. The custom
task consumes a mesh from an upstream external task and passes it to a downstream external task.
This example also illustrates input/output specification, file management capabilities, and the default
Edit context menu.
229
Examples
Figure 95: End-to-End Mesh Transfer in Custom Taskgroup with both External and Custom Tasks
Figure 96: Custom Taskgroup with Consuming and Providing Connections to External Taskgroups
Figure 97: Custom Taskgroup with Consuming and Providing Connections between Custom task
and External Tasks
230
XML Definition File

The XML definition file (GenericMeshTransfer.xml) defines two custom taskgroups which appear
in your custom ACT Workflows taskgroup in the Workbench Toolbox.
The XML extension definition file (GenericMeshTransfer.xml) performs the following actions:
References the IronPython script generic_mesh_transfer.py.
Defines the <onedit> callback in the task block, which automatically creates a default Edit context menu
for the task.
Defines an input and an output in the <inputs> and <outputs> blocks.
The input has type set to MeshingMesh, indicating that the input data type will be a mesh.
Both the input and output have format set to FluentMesh, specifying that the input and output files
will have the same FluentMesh format.
Defines two custom taskgroups in the <taskgroups>> block.
The first custom taskgroup, GenericMeshTransfer, references the custom Mesher task. It consumes
a mesh from an upstream Mesh taskgroup and passes it to a downstream Fluent taskgroup.
The second custom taskgroup, GenericMeshTransferComplete, references the custom Material
task and also, by using the external attribute, the external ANSYS Geometry, ANSYS Meshing, Fluent
Setup, and Fluent Solution tasks. The Material task consumes a mesh from the upstream ANSYS
Meshing task and passes it to the downstream Fluent Setup task.
The file, GenericMeshTransfer.xml, contains the following code:
<extension version="1" name="GenericMeshTransfer">
<guid shortid="GenericMeshTransfer">69d0095b-e138-4841-a13a-de12238c83f7</guid>
<script src="generic_mesh_transfer.py" />
</interface>
<tasks>
<task name="Mesher" caption="Mesher" icon="GenericMesh_cell" version="1">
<callbacks>
<onedit>edit</onedit>
</callbacks>
<inputs>
<input format="FluentMesh" type="MeshingMesh" count="1"/>
<input/>
</inputs>
<outputs>
<output format="FluentMesh" type="SimulationGeneratedMesh"/>
</outputs>
</task>
</tasks>
<taskgroups>
<taskgroup name="GenericMeshTransfer" caption="Generic Mesh" icon="GenericMesh"
category="ACT Custom Workflows" abbreviation="GenMeshXfer" version="1">
<includeTask name="Mesher" caption="Mesher"/>
</taskgroup>
<taskgroup name="GenericMeshTransferComplete" caption="Generic Mesh Complete" icon="GenericMesh"
category="ACT Custom Workflows" abbreviation="GenMeshXferComplete" version="1">
231
Examples
<includeTask
<includeTask
<includeTask
<includeTask
<includeTask
</taskgroup>
</taskgroups>
</workflow>
</extension>
external="True" name="GeometryCellTemplate" caption="ANSYS Geometry"/>

external="True" name="SimulationMeshingModelCellTemplate" caption="ANSYS Meshing"/>
name="Mesher" caption="Custom Mesher"/>
external="True" name="FluentSetupCellTemplate" caption="Fluent Setup"/>
external="True" name="FluentResultsCellTemplate" caption="Fluent Solution"/>
IronPython Script
The IronPython script (generic_mesh_transfer.py) contains the IronPython code that provides
instructions for passing the mesh data to the downstream taskgroup or task.
The file, generic_mesh_transfer.py, contains the following code:
import clr
import Ansys.UI.Toolkit
def update(task):
ExtAPI.Log.WriteMessage('in generic_mesh_transfer.py update method')
#obtain input data
upstreamData = container.GetInputDataByType(InputType="MeshingMesh")
meshFileRef = None
meshFileRef = upstreamData[0]
#set our output so that we are just a pass through.
meshOutputSet = outputRefs["SimulationGeneratedMesh"]
meshOutput = meshOutputSet[0]
#meshOutput.MeshFile = meshFileRef
meshOutput.TransferFile = meshFileRef
ExtAPI.Log.WriteMessage(str(meshFileRef))
#if no new data...nothing to process from upstream sources.
def edit(task):
Ansys.UI.Toolkit.MessageBox.Show("Test!")
Custom Transfer
This custom Workbench workflow example implements a custom transfer from a producing taskgroup
to a consuming taskgroup, creating connections between custom tasks (no ANSYS installed products).
It also illustrates the creation of single-task vs. multi-task task groups.
232

Figure 98: Custom Transfer Example Schematic View
XML Definition File

The XML extension definition file (CustomTransfer.xml) defines taskgroups named Producer,
Consumer, and CompleteTransfer, all of which appear in the Workbench Toolbox.
Figure 99: Custom Transfer Example Toolbox Taskgroup Entry
The XML extension definition file (CustomTransfer.xml) performs the following actions:
References the IronPython script customtransfer.py.
Defines two tasks in the <tasks> block: Producer and Consumer.
Defines three taskgroups in the <taskgroups> block: Producer, Consumer, and CompleteTransfer.
The Producer and Consumer taskgroups each contain a single task. The CompleteTransfer taskgroup
contains two tasks.
The file, CustomTransfer.xml, contains the following code:
<extension version="1" name="CustomTransfer">
<guid shortid="CustomTransfer">69d0095b-e138-4841-a13a-de12238c83f3</guid>
<script src="customtransfer.py" />
</interface>
233
Examples
<tasks>
<task name="Producer" caption="Producer" icon="test_component" version="1">
<callbacks>
<onupdate>producer_update</onupdate>
</callbacks>
<inputs>
<input/>
</inputs>
<outputs>
<output format="" type="MyData"/>
</outputs>
</task>
<task name="Consumer" caption="consumer" icon="test_component" version="1">
<callbacks>
<onupdate>consumer_update</onupdate>
</callbacks>
<inputs>
<input/>
<input format="" type="MyData"/>
</inputs>
<outputs/>
</task>
</tasks>
<taskgroups>
<taskgroup name="Producer" caption="Producer" icon="producer_system"
category="ACT Custom Workflows" abbreviation="Producer" version="1">
<includeTask name="Producer" caption="Producer"/>
</taskgroup>
<taskgroup name="Consumer" caption="Consumer" icon="consumer_system"
category="ACT Custom Workflows" abbreviation="Consumer" version="1">
<includeTask name="Consumer" caption="Consumer"/>
</taskgroup>
<taskgroup name="CompleteTransfer" caption="CompleteTransfer" icon="consumer_system"
category="ACT Custom Workflows" abbreviation="CompleteTransfer" version="1">
<includeTask name="Producer" caption="Producer"/>
<includeTask name="Consumer" caption="Consumer"/>
</taskgroup>
</taskgroups>
</workflow>
</extension>
IronPython Script
The IronPython script (customtransfer.py) contains the Python code that provides update instructions for the producing taskgroup and for the consuming task to obtain the output data from the upstream producer.
The file, customtransfer.py, contains the following code:
def consumer_update(task):
#obtain input data
upstreamData = container.GetInputDataByType(InputType="MyData")
fileRef = None
fileRef = upstreamData[0]
AssociateFileWithContainer(fileRef, container)
ExtAPI.Log.WriteMessage("Recieved file "+fileRef.Location+" from producer.")
#if no new data...nothing to process from upstream sources.
def producer_update(task):
filePath = System.IO.Path.Combine(extensionDir, "Sample_Materials.xml")
fileRef = None
isRegistered = IsFileRegistered(FilePath=filePath)
if isRegistered == True:
fileRef = GetRegisteredFile(filePath)
else:
234

fileRef = RegisterFile(FilePath=filePath)
AssociateFileWithContainer(fileRef, container)
outputSet = outputRefs["MyData"]
myData = outputSet[0]
myData.TransferFile = fileRef
Parametric
The following custom Workbench workflow example illustrates the creation of a parametric taskgroup
using the isparametricgroup attribute. When this attribute is set to true , it indicates that that
the taskgroup operates only on design points. As such, the taskgroup is added below the Parameter
Set bar. The focus on parameters in this example enables you to incorporate DesignXplorer-like functionality.
Figure 100: Parametric Example Schematic View
XML Definition File

The XML extension definition file (Parametric.xml) performs the following actions:
References the IronPython script parametric.py.
Defines the inputs and outputs in the <inputs> and <outputs> blocks. Note that an empty input is
defined.
Defines a single taskgroup which contains a single task in the <taskgroups> block. Note that the isparametricgroup attribute is set to true.
The file, Parametric.xml, contains the following code:
<extension version="1" name="Parametric">
<guid shortid="Parametric">69d0095b-e138-4841-a13a-de12238c83f5</guid>
<script src="parametric.py" />
</interface>
<tasks>
<task name="Parametric" caption="Parametric" icon="parametric_component" version="1">
<callbacks>
</callbacks>
<inputs>
<input/>
</inputs>
235
Examples
<outputs/>
</task>
</tasks>
<taskgroups>
<taskgroup name="Parametric" caption="Parametric" icon="parametric"
category="ACT Custom Workflows" abbreviation="PARAMS" isparametricgroup="True" version="1">
<includeTask name="Parametric" caption="Parametric"/>
</taskgroup>
</taskgroups>
</workflow>
</extension>
IronPython Script
The IronPython script (parametric.py) performs an update on the parameters. Since the XML extension definition file has <onupdate> callback, the update method is defined in the script.
The file, parametric.py, contains the following code:
def update(task):
ExtAPI.Log.WriteMessage("test")
Wizard Examples
In this section, we'll provide examples for each type of simulation wizard.
The following examples are provided:
Project Wizard (Workbench Project Tab)*
Project Wizard (AIM Project Tab)
DesignModeler Wizard*
Mechanical Wizard*
Mixed Wizard*
Electronics Desktop Wizard
SpaceClaim Wizard
AIM Custom Template (Single-Step)
AIM Custom Template (Multiple-Step)
Wizard Custom Layout Example
Note
The wizard examples marked above with an asterisk are all defined in the same extension,
WizardDemos. All other examples are defined in separate extensions.
Project Wizard (Workbench Project Tab)*

Our example of a project wizard to be run from the Workbench Project tab is called ProjectWizard. It
is defined in the extension WizardDemos.
Note
The wizard examples marked above with an asterisk are all defined in the same extension,
WizardDemos. All other examples are defined in separate extensions.
236
Wizard Examples
XML Definition File

Below is an excerpt of the XML extension file, WizardDemos.xml.
Extension Definition
The name and version attributes define the extension name and version.
The guid attribute
The icon attribute specifies the path to the icon shown for the extension.
Script Reference
The <script> block specifies the IronPython scripts referenced by the extension. This wizard references
the scripts main.py, ds.py, and dm.py.
Interface Definition
In the <interface> block:
The context attribute is set to Project because the extension is executed on the Project tab.
The <images> tag refers to the extension images folder; the image contained in this folder is displayed
as the icon for the wizard.
The <UIDefinition> block is used to define a set of layouts for the user interface of a wizard. Note that
for the sake of this example, the contents of this block have been removed.
For more information, see Customizing the Layout of a Wizard (p. 136) and the example Wizard
Custom Layout Example (p. 290).
Wizard Definition
The wizard and its steps are defined in the <wizard> block.
The required name and version attributes define the wizard name and version.
Because the wizard will be executed on the Project tab, the required context attribute is set to Project.
Step Definitions
The <step> tag is used to define the steps of the wizard. There are six steps: Geometry, Mechanical,
Fluent, ReportView, CustomStep, and Charts.
For each step:
The name, version, and caption attributes define the step name, version, and display text for the
step.
The context attribute is set to the context in which the specific step is executed (i.e. Project, DesignModeler, Mechanical).
The HelpFile attribute references the HTML help file to be displayed for the step.
The <callbacks> block defines the callbacks to the functions defined in the Python script.
237
Examples
For the Geometry step, the <onupdate> callback executes the CreateGeometry action, creating
the geometry upon update; the <onreset> callback executes the DeleteGeometry action, removing the geometry when the Back button is clicked.
For the Mechanical step, the <onupdate> callback executes the CreateMechanical action
and the <onreset> callback executes the DeleteMechanical action.
For the Fluent step, the <onupdate> callback executes the CreateFluent action.
For the ReportView step, the <onrefresh> and <onreset> callbacks execute the RefreshReport and EmptyReset actions.
For the CustomStep, the <onrefresh>, <onupdate>, and <onreset> callbacks execute the
RefreshMechanical, LogReport, and EmptyReset actions
For the Charts step, the <onrefresh> callback executes the RefreshCharts action.
The <propertygroup> blocks define properties and property attributes for the steps. For properties
requiring validation, the <onvalidate> callback executes an appropriate Python validation function.
<script src="ds.py" />
<script src="dm.py" />
<interface context="Project|Mechanical">
</interface>
...
<description>Simple wizard for demonstration in Project page.</description>
<step name="Geometry" caption="Geometry" version="1" HelpFile="help/geometry.html">
<callbacks>
<onupdate>CreateGeometry</onupdate>
<onreset>DeleteGeometry</onreset>
</callbacks>
default="Option1">
</propertygroup>
</propertygroup>
</step>
238
Wizard Examples
<step name="Mechanical" caption="Mechanical" enabled="true" version="1" HelpFile="help/mechanical.html">
<callbacks>
<onupdate>CreateMechanical</onupdate>
<onreset>DeleteMechanical</onreset>
</callbacks>
</propertytable>
</step>
<step name="Fluent" caption="Fluent" version="1" HelpFile="help/fluent.html">
<callbacks>
<onrefresh>CreateDialog</onrefresh>
<onupdate>CreateFluent</onupdate>
<onreset>EmptyReset</onreset>
</callbacks>

<callbacks>
</callbacks>
</property>
<callbacks>
</callbacks>
</property>
<property name="nextstep" caption="Next Step" control="select" >
<callbacks>
<onvalidate>ValidateNextStep</onvalidate>
</callbacks>
</property>
</step>
<step name="ReportView" caption="ReportView" version="1" layout="ReportView@WizardDemos">
<callbacks>
<onrefresh>RefreshReport</onrefresh>
</callbacks>
</step>
<step name="CustomStep" caption="CustomStep" enabled="true" version="1" layout="MyLayout@WizardDemos">
<callbacks>
<onrefresh>RefreshMechanical</onrefresh>
<onupdate>LogReport</onupdate>
</callbacks>
</step>
<step name="Charts" caption="Charts" enabled="true" version="1" layout="GraphLayout@WizardDemos">
<description>Demonstrate all chart capabilities.</description>
239
Examples
<callbacks>
<onrefresh>RefreshCharts</onrefresh>
</callbacks>
</step>
</wizard>
IronPython Script
Below is the IronPython script, main.py.
This script defines all the functions executed by the callbacks in our XML extension file. Each step defined
in the XML file may include multiple actions.
geoSystem = None
dsSystem = None
fluentSystem = None
def CreateGeometry(step):
global geoSystem
template1 = GetTemplate(TemplateName="Geometry")
geoSystem = template1.CreateSystem()
geometry1 = geoSystem.GetContainer(ComponentName="Geometry")
geometry1.SetFile(FilePath=step.Properties["definition/filename"].Value)
def DeleteGeometry(step):
global geoSystem
geoSystem.Delete()
def RefreshMechanical(step):
tree = step.UserInterface.GetPanel("Tree")
root = tree.CreateTreeNode("Root")
tree.SetTreeRoot(root)
chart = step.UserInterface.GetPanel("Chart")
chart.Plot([1,2,3,4,5],[10,4,12,13,8],"b","Line1")
chart.Plot([1,2,3,4,5],[5,12,7,8,11],"r","Line2")
def CreateMechanical(step):
global dsSystem, geoSystem
template2 = GetTemplate(
TemplateName="Static Structural",
Solver="ANSYS")
geometryComponent1 = geoSystem.GetComponent(Name="Geometry")
dsSystem = template2.CreateSystem(
Position="Right",
RelativeTo=geoSystem)
raise UserErrorMessageException("Invalid system name. Please try again.")
dsSystem.DisplayText = step.Properties["name"].Value
def DeleteMechanical(step):
global dsSystem
dsSystem.Delete()
def CreateFluent(step):
global dsSystem, fluentSystem
template3 = GetTemplate(TemplateName="Fluid Flow")
geometryComponent2 = dsSystem.GetComponent(Name="Geometry")
solutionComponent1 = dsSystem.GetComponent(Name="Solution")
componentTemplate1 = GetComponentTemplate(Name="CFDPostTemplate")
240
Wizard Examples
fluentSystem = template3.CreateSystem(
DataTransferFrom=[Set(FromComponent=solutionComponent1, TransferName=None,
ToComponentTemplate=componentTemplate1)],
Position="Right",
RelativeTo=dsSystem)
raise Exception("Invalid system name. Please try again.")
fluentSystem.DisplayText = step.Properties["name"].Value
def CreateDialog(step):
dlg = step.UserInterface.Container.CreateDialog("MyDialog", "okCancelDialog", "MyTitle", 400, 150)
dlg.SetOkButton("Ok")
prop = step.Properties["nextstep"]
prop.Options.Clear()
s = step.NextStep
val = s.Caption
while s!=None:
prop.Options.Add(s.Caption)
s = s.NextStep
prop.Value = val
def cbDialog(sender, args):
sender.Container.HideDialog(sender)
def ValidateDialog(step, prop):
dialog = step.UserInterface.GetPanel("MyDialog")
dialog.SetMessage("My own message")
dialog.SetCallback(cbDialog)
dialog.Refresh()
step.UserInterface.Container.ShowDialog(dialog)
def worker(step):
progress = step.UserInterface.GetPanel("Progress")
stopped = progress.UpdateProgress("Start progress...", 0, True)
step.UserInterface.Container.ShowDialog(progress)
for i in range(100):
stopped = progress.UpdateProgress("Start progress...", i+1, True)
if stopped:
break
step.UserInterface.Container.HideDialog(progress)
def ValidateDialogProgress(step, prop):
thread = System.Threading.Thread(System.Threading.ParameterizedThreadStart(worker))
thread.Start(step)
def ValidateNextStep(step, prop):
prop = step.Properties["nextstep"]
s = step.NextStep
v = False
while s!=None:
if prop.Value==s.Caption:
v = True
s.IsEnabled = v
s = s.NextStep
steps = step.UserInterface.GetPanel("Steps")
steps.UpdateData()
steps.Refresh()
def RefreshReport(step):
report = step.UserInterface.GetPanel("Report")
report.SetFilename(System.IO.Path.Combine(ExtAPI.Extension.InstallDir,"help","report.html"))
report.Refresh()
def EmptyReset(step):
pass
def LogReport(step):
ExtAPI.Log.WriteMessage("Report:")
for s in step.Wizard.Steps.Values:
ExtAPI.Log.WriteMessage("Step "+s.Caption)
241
Examples
for prop in s.AllProperties:
ExtAPI.Log.WriteMessage(prop.Caption+": "+prop.DisplayString)
import random
import math
def RefreshCharts(step):
graph = step.UserInterface.GetPanel("Graph")
graph.Title("Line Bar Graph")
graph.ShowLegend(False)
graph.Plot([-1, 0, 1, 2, 3, 4], [0.5, -0.5, 0.5, -0.5, 0.5, 0.5], key="Variable A", color='g')
graph.Bar([-1, 0, 1, 2, 3, 4], [10, 20, 30, 10, 5, 20], key="Variable B")
graphB = step.UserInterface.GetPanel("GraphB")
graphB.Title("Plot Graph")
graphB.YTickFormat("0.2f")
xValues = []
yValues = []
for i in range(0, 100):
xValues.append(i)
yValues.append(abs(math.sin(i*0.2))*i/100.0)
graphB.Plot(xValues, yValues, key="y = a*sin(bx)", color="c")
graphB.Plot(xValues, yValues, key="y = x", color="m")
xValues = []
yValues = []
for i in range(0, 100):
xValues.append(i)
yValues.append(i/100.0)
graphB.Plot(xValues, yValues, key="y = x", color="m")
graphB.Plot([0, 10, 20, 30, 100], [0.2, 0.2, 0.2, 0.3, 0.3], key="Smth", color="r")
graphB.Plot([0, 10, 20, 30, 100], [0.2, 0.1, 0.3, 0.5, 0.7], key="Smth", color="r")
graphB.Plot([0, 10, 20, 30, 100], [0.2, 0.2, 0.2, 0.3, 0.3])
graphC = step.UserInterface.GetPanel("GraphC")
graphC.Title("Pie Graph")
graphC.Pie([1, 2, 3])
graphC.Pie([20, 30, 5, 15, 12], [0, "Banana", 2, 3, "42"])
graphD = step.UserInterface.GetPanel("GraphD")
graphD.Title("Bar Graph")
graphD.Bar(["Banana"], [70], key="key")
graphD.Bar([0, "Banana", 2, 3, 4], [20, 30, 5, 15, 12], key="key")
graphE = step.UserInterface.GetPanel("GraphE")
graphE.Title("Bubble Graph")
graphE.XTickFormat("f")
graphE.YTickFormat("f")
keys = ["one", "two", "three", "four", "five"]
colors = ["#BB3333", "#33BB33", "#3333BB", "#BBBB33", "#BB33BB"]
for c in range(0, 5):
xValues = []
yValues = []
sizeValues = []
for i in range(0, (c+1)*20):
rad = random.randrange(c+1, c+2) + (random.random()*2-1)
angle = random.random() * 2 * math.pi
xValues.append(math.cos(angle) * rad)
yValues.append(math.sin(angle) * rad)
sizeValues.append(random.random() * 2.0 + 0.5)
graphE.Bubble(xValues, yValues, sizeValues, key=keys[c], color=colors[c])
Project Wizard (AIM Project Tab)

Our example of a project wizard to be run from the AIM Project tab is called PressureLoss. It is defined
in an extension of the same name.
242
Wizard Examples
This example calculates the maximum velocity and pressure loss for a CFD system with one inlet and
three outlets.
Note
The XML syntax used to define a project wizard run in AIM is the same as that used to define
a project wizard run in Workbench.
XML Definition File

Below is an excerpt of the XML extension file, PressureLoss.xml.
The guid attribute specifies a unique identifier for the extension.
The icon attribute specifies the path to the icon shown for the extension.
Script Reference
The <script> block specifies the IronPython script referenced by the extension. This wizard references
the script pressureLoss.py.
In the <interface> block:
The context attribute is set to Project because the extension is executed on the AIM Project tab
The <UIDefinition> block is used to define a set of layouts for the user interface of a wizard. Note that
for the sake of this example, the contents of this block have been removed.
For more information, see Customizing the Layout of a Wizard (p. 136) and the example Wizard
Custom Layout Example (p. 290).
Wizard Definition
Because the wizard will be executed on the AIM Project tab, the required context attribute is set to
Project.
Steps are defined.
Step Definitions
The <step> tag is used to define the steps of the wizard. There are four steps: Step1, Step2, Step3,
and Step4.
For each step:
243
Examples
step.
The context attribute is set to the context in which the specific step is executed. Since this wizard is
run from the AIM Project page, the context is set to Project.
The HelpFile attribute references the HTML help file to be displayed for the step. In this example, the
help provided for each step indicates where each property is displayed in the Study interface.
For Step1, the <onupdate> callback executes the importGeometry action. This step creates the
CFD workflow, importing and then generating the specified geometry.
The geometry is generated when the user clicks the Next button.
For Step2, the <onupdate> callback executes the refineMesh action. This step allows the user
to specify the mesh resolution and then refines the mesh accordingly.
The refinement is performed when the user clicks the Next button.
For Step3, the <onrefresh> callback executes the initLocations action and the <onupdate>
callback executes the setup action. This step enables the user to specify the loads applied to the
inlet and outlet, selecting a location and specifying a load (Velocity for the Inlet and Gauge
Pressure for the Outlet).
The <isvalid> callback on the OutletLocation property executes the isValid action,
validating the value selected for the outlet location.
For Step4, no callbacks are required. This step takes the value calculated for the CalculatedMaximum
property and populates it to the Calculated maximum field of the Velocity object.
For each step, the <property> blocks define properties and property attributes for the steps. The
<propertygroup> blocks create groupings of properties within the steps.
<extension version="1" name="PressureLoss" icon="images\loss.png">
<guid>D689A1A2-6183-4928-AAE8-8FC3822A66A3</guid>
<description>Demonstration of a pressure loss in AIM.</description>
<script src="pressureLoss.py" />
</interface>
<wizard name="PressureLoss" version="1" context="Project" icon="loss">
<description>This wizard is for demonstration of ACT wizard capability in AIM.</description>
<step name="Step1" caption="Import the geometry" version="1" context="Project"
HelpFile="help/geometry.html">
<description>Import the geometry file and create the workflow.</description>
<callbacks>
<onupdate>importGeometry</onupdate>
</callbacks>
<property name="geometryfile" caption="geometry file" control="fileopen"
default="E:\Geometry\TubeSelectionSet.agdb"/>
</step>
<step name="Step2" caption="Refine the mesh" version="1" context="Project"
244
Wizard Examples
HelpFile="help/mesh.html">
<description>Refine the mesh from Low to High.</description>
<callbacks>
<onupdate>refineMesh</onupdate>
</callbacks>
<property name="MeshResolution" caption="mesh resolution" control="integer" default="1"/>
</step>
<step name="Step3" caption="Define the loads" version="1" context="Project"
HelpFile="help/loads.html">
<description>Specify the loads to applied on the geometry.</description>
<callbacks>
<onrefresh>initLocations</onrefresh>
<onupdate>setup</onupdate>
</callbacks>
<propertygroup name="Inlet" caption="Inlet">
<property name="Velocity" caption="Velocity" control="float" unit="Velocity"
default="0.1 [m s^-1]"/>
<property name="InletLocation" caption="InletLocation" control="select" />
</propertygroup>
<propertygroup name="Outlet" caption="Outlet">
<property name="GaugePressure" caption="Gauge Pressure" control="float" unit="Pressure"
default="0 [Pa]"/>
<property name="OutletLocation" caption="OutletLocation" control="select" >
<callbacks>
<isvalid >isValid</isvalid>
</callbacks>
</property>
</propertygroup>
</step>
<step name="Step4" caption="Export the maximum velocity" version="1" context="Project"
HelpFile="help/result.html">
<description>Here we are just exposing the value of the maximum velocity and the pressure loss.
</description>
<property name="MaximumVelocity" caption="Maximum Velocity" control="float" unit="Velocity"
readonly = "True"/>
<property name="PressureLoss" caption="Pressure Loss" control="float" unit="Pressure"
readonly = "True"/>
</step>
</wizard>
</extension>
IronPython Script
Below is the IronPython script, pressureLoss.py.
meshingComponent1 = None
study1 = None
physicsDefinitionComponent1 = None
resultsEvaluationComponent1 = None
solvePhysicsComponent1 = None
physicsRegion1 = None
vectorResult1 = None
singleValueResult1 = None
results1 = None
materialAssignment1 = None
currentStep = None
clr.AddReference("Ans.UI")
245
Examples
def getSelectionSetsForProject():
context = __scriptingEngine__.CommandContext
project = context.Project
containers = project.GetContainers()
dataEntity = "SelectionSet"
for container in containers:
if container.Name == "Study":
try:
lockObject = context.ContainerReadLock(container)
dataReferences = project.GetDataReferencesByType(container, dataEntity)
finally:
lockObject.Dispose()
break
return dataReferences
def initLocations(step):
list = getSelectionSetsForProject()
propIn = step.Properties["Inlet/InletLocation"]
propIn.Options.Clear()
propOut = step.Properties["Outlet/OutletLocation"]
propOut.Options.Clear()
for sel in list:
ExtAPI.Log.WriteMessage("OPTION: "+sel.DisplayText)
propIn.Options.Add(sel.DisplayText)
propOut.Options.Add(sel.DisplayText)
comp = step.UserInterface.GetComponent("Properties")
comp.UpdateData()
comp.Refresh()
def isValid(step, property):
if property.Value == step.Properties["Inlet/InletLocation"].Value:
ExtAPI.Log.WriteWarning("Inlet and Outlet locations must be different.")
return False
return True
def importGeometry(step):
global meshingComponent1, study1, results1, vectorResult1, singleValueResult1,
physicsDefinitionComponent1, resultsEvaluationComponent1, solvePhysicsComponent1, physicsRegion1,
materialAssignment1
with Transaction():
system1 = GetSystem(Name="Study")
physicsDefinitionComponent1 = Study.CreateTask( Type="Physics Definition", System=system1)
study1 = system1.GetContainer(ComponentName="Study")
physicsDefinition1 = physicsDefinitionComponent1.GetTaskObject()
physicsRegion1 = study1.CreateEntity( Type="PhysicsRegion", Association=physicsDefinition1)
solverSettings1 = study1.CreateEntity( Type="SolverSettings", Association=physicsDefinition1)
solvePhysicsComponent1 = Study.CreateTask( Type="Solve Physics", System=system1,
Input=physicsDefinitionComponent1)
solvePhysicsComponent1.Refresh()
resultsEvaluationComponent1 = Study.CreateTask( Type="Results Evaluation", System=system1,
Input=solvePhysicsComponent1)
resultsEvaluationComponent1.Refresh()
physicsDefinition1.CalculationType = "Static"
physicsRegion1.PhysicsType = "Fluid"
physicsRegion1.Location = "AllBodies()"
materialAssignment1 = study1.CreateEntity( Type="MaterialAssignment",
Association=physicsDefinition1)
material1 = study1.CreateEntity( Type="Material", Association=physicsDefinition1)
material1.ImportEngineeringData(Name="Air")
materialAssignment1.Material = material1
materialAssignment1.Location = [physicsRegion1]
results1 = resultsEvaluationComponent1.GetTaskObject()
vectorResult1 = study1.CreateEntity( Type="VectorResult", Association=results1)
vectorResult1.Variable = "Velocity"
vectorResult1.DisplayText = "Velocity"
transcript1 = study1.CreateEntity( Type="Transcript", Association=physicsDefinition1)
transcript1.DisplayText = "Fluid Flow Output 1"
physicsSolutionGroup1 = Study.CreateGroup(Name="Physics Solution")
physicsSolutionGroup1.Add(Component=physicsDefinitionComponent1)
246
Wizard Examples
physicsSolutionGroup1.Add(Component=solvePhysicsComponent1)
meshingComponent1 = Study.CreateTask( Type="Meshing", System=system1,
Output=physicsDefinitionComponent1)
physicsDefinitionComponent1.Refresh()
importComponent1 = Study.CreateTask( Type="Import", System=system1, Output=meshingComponent1)
meshingComponent1.Refresh()
import1 = importComponent1.GetTaskObject()
geometryImportSource1 = import1.AddGeometryImportSourceOperation()
geometryImportSource1.FilePath = step.Properties["geometryfile"].Value
importComponent1.Update(AllDependencies=True)
def refineMesh(step):
global meshingComponent1, study1, results1, vectorResult1, physicsDefinitionComponent1,
singleValueResult1, resultsEvaluationComponent1, solvePhysicsComponent1, physicsRegion1
meshing1 = meshingComponent1.GetTaskObject()
meshing1.MeshResolution = step.Properties["MeshResolution"].Value
def setup(step):
with Transaction():
meshControlLocalInflation1 = study1.CreateEntity( Type="MeshControlLocalInflation",
Association=meshing1)
meshing1.EngineeringIntent = "FluidFlow"
AddSourceToComponentInSystem( SourceComponent=physicsDefinitionComponent1,
TargetComponent=resultsEvaluationComponent1)
#meshControlLocalInflation1.Location = ["FACE8", "FACE2", "FACE6"]
Study.Delete(Items=[meshControlLocalInflation1])
with Transaction():
meshingComponent1.Update(AllDependencies=True)
with Transaction():
inletBoundary1 = study1.CreateEntity( Type="InletBoundary", Association=physicsRegion1)
inlet_location = step.Properties["Inlet/InletLocation"].Value
ExtAPI.Log.WriteMessage("my inlet location property value is : " + inlet_location)
inlet_selection_set = None
selection_sets = getSelectionSetsForProject()
for selection_set in selection_sets:
if selection_set.DisplayText == inlet_location:
inlet_selection_set = selection_set
if inlet_selection_set == None :
ExtAPI.Log.WriteMessage("inlet selection set does not exist")
inletBoundary1.Location = [inlet_selection_set]
inletBoundary1.Flow.Velocity.Magnitude = step.Properties["Inlet/Velocity"].DisplayString
outletBoundary1 = study1.CreateEntity( Type="OutletBoundary", Association=physicsRegion1)
outlet_location = step.Properties["Outlet/OutletLocation"].Value
outlet_selection_set = None
selection_sets = getSelectionSetsForProject()
for selection_set in selection_sets:
if selection_set.DisplayText == outlet_location:
outlet_selection_set = selection_set
if outlet_selection_set == None :
247
Examples
ExtAPI.Log.WriteMessage("outlets selection set does not exist")
outletBoundary1.Location = [outlet_selection_set]
outletBoundary1.Flow.Pressure.GaugeStaticPressure = step.Properties["Outlet/GaugePressure"].
DisplayString
wallBoundary1 = study1.CreateEntity( Type="WallBoundary", Association=physicsRegion1)
# Creation of the pressure loss expression.
singleValueResult1 = study1.CreateEntity( Type="SingleValueResult", Association=results1)
singleValueResult1.Method = "UserDefinedExpressionMethod"
singleValueResult1.Expression = "Average(Pressure, GetBoundary('@Inlet 1'), Weight='Area') Average(Pressure, GetBoundary('@Outlet 1'), Weight='Area')"
with Transaction():
physicsDefinitionComponent1.Update(AllDependencies=True)
solvePhysicsComponent1.Update(AllDependencies=True)
resultsEvaluationComponent1.Update(AllDependencies=True)
vectorResult1.Legend.Coloring = "Banded"
vectorResult1.Legend.NumberOfColors = "10"
vectorResult1.Distribution = "Mesh"
vectorResult1.Evaluate()
maximum_velocity = vectorResult1.Summary.Max
step.NextStep.Properties["MaximumVelocity"].Value = maximum_velocity.ToString()
step.NextStep.Properties["PressureLoss"].Value = singleValueResult1.Value.ToString()
def solve(step):
with Transaction():
Reviewing Wizard Results

When the wizard has completed, the final page shows the calculated Maximum Velocity. The Help
panel indicates where the result will be shown in the AIM Study.
Click the Finish button to return to the ACT Start Page.
248
Wizard Examples
Figure 101: Final Page of PressureLoss Project Wizard
Open the Results task to view the final results obtained by the wizard-driven simulation.
249
Examples
Figure 102: AIM Study for PressureLoss Project Wizard
On the Study tab, you can see that the wizard created the workflow in AIM and then automatically
executed the steps.
Figure 103: AIM Results for PressureLoss Project Wizard
250
Wizard Examples
DesignModeler Wizard*
Our DesignModeler target-application wizard is called CreateBridge. It is defined in the extension
WizardDemos.
This is a two-step wizard that builds a bridge.
XML Definition File

The name and version attributes define the extension name and version. The guid attribute specifies
a unique identifier for the extension.
Script Reference
the script dm.py.
The <interface> block defines details of the interface.
The context attribute is set to DesignModeler because the extension is executed in the DesignModeler application.
The <images> block refers to the extension images folder; the image contained in this folder is displayed
The <toolbar> block is used to define two toolbar buttons for exposure in DesignModeler. When the
buttons are clicked, the <onclick> callbacks execute the CreateDeck and CreateSupport
functions and create a deck geometry with supports.
Simdata Definition
The two <simdata> blocks provide data for the creation of the Deck and Support geometries.
Wizard Definition
The context attribute is set to DesignModeler because the wizard will be executed in the DesignModeler application.
Step Definitions
The <step> tag is used to define the steps of the wizard. There are two steps: Deck and Supports.
For each step:
step.
251
Examples
For the Deck step, the <onupdate> callback executes the UpdateDeck function to create the deck
geometry using the Deck feature.
For the Supports step, the <onupdate> callback executes the UpdateSupports function to
create the bridge supports using the Support geometry.
The <propertygroup> block defines geometry properties and their attributes.
...
<toolbar name="Deck" caption="Deck">
<entry name="Deck" icon="deck">
<callbacks>
<onclick>CreateDeck</onclick>
</callbacks>
</entry>
<entry name="Support" icon="Support">
<callbacks>
<onclick>CreateSupport</onclick>
</callbacks>
</entry>
</toolbar>
</interface>
<geometry name="Deck" caption="Deck" icon="deck" version="1">
<callbacks>
<ongenerate>GenerateDeck</ongenerate>
</callbacks>
<property name="Length" caption="Length" control="float" unit="Length" default="300 [m]" />
<property name="Width" caption="Width" control="float" unit="Length" default="20 [m]" />
<property name="Beams" caption="Beams" control="integer" default="31" />
</geometry>
</simdata>
<geometry name="Support" caption="Support" icon="support" version="1">
<callbacks>
<ongenerate>GenerateSupport</ongenerate>
</callbacks>
<property name="Height" caption="Height" control="float" unit="Length" default="100 [m]" />
<property name="Number" caption="Number" control="integer" default="3" />
</geometry>
</simdata>
...
<wizard name="CreateBridge" version="1" context="DesignModeler" icon="wizard_icon">
<description>Simple wizard for demonstration in DesignModeler.</description>
<step name="Deck" caption="Deck" version="1" HelpFile="help/dm1.html">
<description>Create the deck.</description>
<callbacks>
<onupdate>UpdateDeck</onupdate>
252
Wizard Examples
</callbacks>
<propertygroup display="caption" name="Deck" caption="Deck Definition" >
</propertygroup>
</step>
<step name="Supports" caption="Supports" enabled="true" version="1" HelpFile="help/dm2.html">
<description>Create supports.</description>
<callbacks>
<onupdate>UpdateSupports</onupdate>
</callbacks>
<propertygroup display="caption" name="Supports" caption="Supports Definition" >
</propertygroup>
</step>
</wizard>
IronPython Script
Below is the IronPython script, dm.py.
import units
def CreateDeck(ag):
ExtAPI.CreateFeature("Deck")
def CreateSupport(ag):
ExtAPI.CreateFeature("Support")
def GenerateDeck(feature,fct):
width = feature.Properties["Width"].Value
width = units.ConvertUnit(width, ExtAPI.DataModel.CurrentUnitFromQuantityName("Length"), "m")
num = feature.Properties["Beams"].Value
bodies = []
boxGen = builder.Primitives.Solid.CreateBox([0.,-width/2.,-0.3],[length,width/2.,0.])
bodies.Add(boxGen.Generate())
w = (length-0.1*num)/(num-1.)+0.1
for i in range(num-1):
beamGen = builder.Primitives.Solid.CreateBox([i*w,-width/2.,-0.6],[i*w+0.1,width/2.,-0.3])
bodies.Add(beamGen.Generate())
beamGen = builder.Primitives.Solid.CreateBox([length-0.1,-width/2.,-0.6],[length,width/2.,-0.3])
beamGen = builder.Primitives.Solid.CreateBox([0.,-width/2.,-1.],[length,-width/2.+0.2,-0.6])
beamGen = builder.Primitives.Solid.CreateBox([0.,width/2.-0.2,-1.],[length,width/2.,-0.6])
253
Examples
return True
def GenerateSupport(feature,fct):
height = feature.Properties["Height"].Value
height = units.ConvertUnit(height, ExtAPI.DataModel.CurrentUnitFromQuantityName("Length"), "m")
width = feature.Properties["Width"].Value
width = units.ConvertUnit(width, ExtAPI.DataModel.CurrentUnitFromQuantityName("Length"), "m")
num = feature.Properties["Number"].Value
bodies = []
w = (length-2.*num)/(num+1.)+2.
for i in range(num):
beamGen = builder.Primitives.Solid.CreateBox([(i+1)*w,-width/2.,-1.-height],
[(i+1)*w+2.,width/2.,-1.])
beamGen = builder.Primitives.Solid.CreateBox([0.,-width/2.,-5.],[2.,width/2.,-1.])
beamGen = builder.Primitives.Solid.CreateBox([length-2.,-width/2.,-5.],[length,width/2.,-1.])
return True
def UpdateDeck(step):
deck = ExtAPI.CreateFeature("Deck")
deck.Properties["Length"].Value = step.Properties["Deck/Length"].Value
deck.Properties["Width"].Value = step.Properties["Deck/Width"].Value
deck.Properties["Beams"].Value = step.Properties["Deck/Beams"].Value
ExtAPI.DataModel.FeatureManager.Generate()
def UpdateSupports(step):
supports = ExtAPI.CreateFeature("Support")
supports.Properties["Length"].Value = step.PreviousStep.Properties["Deck/Length"].Value
supports.Properties["Width"].Value = step.PreviousStep.Properties["Deck/Width"].Value+6
supports.Properties["Height"].Value = step.Properties["Supports/Height"].Value
supports.Properties["Number"].Value = step.Properties["Supports/Number"].Value
ExtAPI.DataModel.FeatureManager.Generate()
Mechanical Wizard*
Our Mechanical target-application wizard is called SimpleAnalysis. It is defined in the extension WizardDemos.
It performs a simple analysis on the bridge built by our previous CreateBridge DesignModeler wizard.
XML Definition File

The name and version attributes define the extension name and version. The guid attribute specifies
a unique identifier for the extension.
Script Reference
the script ds.py.
254
Wizard Examples
The context attribute is set to Mechanical because the extension is executed in the Mechanical
application.
Wizard Definition
The context attribute is set to Mechanical because the wizard will be executed in the Mechanical
application.
Step Definitions
The <step> tag is used to define the steps of the wizard. There are three steps: Mesh, Solution, and
Results.
For each step:
step.
For the Mesh step, the <onreset> callback executes the RemoveControls function to clear existing
mesh controls; the <onupdate> callback executes the CreateMeshControls function to create
new mesh controls.
For the Solution step:
The <onrefresh> callback executes the RefreshLoads function to initialize various properties
(number of nodes, number of elements computed in the previous step, etc.).
The <onreset> callback executes the RemoveLoads function to clear loads.
The <onupdate> callback executes the CreateLoads to create new loads, create new results,
and perform the solve.
For the Results step, the <onrefresh> callback executes the RefreshResults function to fill
the property value associated to the result of the computation (Maximum of Total Deformation).
The <propertygroup> blocks define properties and property attributes for the steps. For properties
requiring location selection, the <isvalid> callback executes the IsLocationValid function
to validate the selection. A custom message can be displayed when the entered value fails validation.
255
Examples
</interface>
...
<wizard name="SimpleAnalysis" version="1" context="Mechanical" icon="wizard_icon">
<description>Simple wizard to illustrate how to setup, solve and analyse results of a simulation
process.</description>
<step name="Mesh" caption="Mesh" version="1" HelpFile="help/ds1.html">
<description>Setup some mesh controls.</description>
<callbacks>
<onreset>RemoveControls</onreset>
<onupdate>CreateMeshControls</onupdate>
</callbacks>
<propertygroup display="caption" name="Sizing" caption="Mesh Sizing" >
<property name="Location" caption="Edge Location" control="geometry_selection">
<callbacks>
<isvalid>IsLocationValid</isvalid>
</callbacks>
</property>
<property name="Ndiv" caption="Divisions" control="integer" />
</propertygroup>
</step>
<step name="Solution" caption="Solution" version="1" HelpFile="help/ds2.html">
<description>Setup loads.</description>
<callbacks>
<onrefresh>RefreshLoads</onrefresh>
<onreset>RemoveLoads</onreset>
<onupdate>CreateLoads</onupdate>
</callbacks>
<propertygroup display="caption" name="Mesh" caption="Mesh Statistics" >
<property name="Nodes" caption="Nodes" control="text" readonly="true" />
<property name="Elements" caption="Elements" control="text" readonly="true" />
</propertygroup>
<propertygroup display="caption" name="FixedSupport" caption="Fixed Support" >
<property name="Location" caption="Face Location" control="geometry_selection">
<callbacks>
<isvalid>IsLocationFSValid</isvalid>
</callbacks>
</property>
</propertygroup>
</step>
<step name="Results" caption="Results" version="1" HelpFile="help/ds3.html">
<description>View Results.</description>
<callbacks>
<onrefresh>RefreshResults</onrefresh>
</callbacks>
<property name="Res" caption="Deformation" control="text" readonly="true" />
</step>
</wizard>
256
Wizard Examples
IronPython Script
Below is the IronPython script, ds.py.
def IsLocationValid(step, prop):
if prop.Value==None:
return False
if prop.Value.Ids.Count!=1:
prop.StateMessage = "Select only one edge."
return False
return True
def CreateMeshControls(step):
model = ExtAPI.DataModel.Project.Model
mesh = model.Mesh
sizing = mesh.AddSizing()
sel = step.Properties["Sizing/Location"].Value
entity = ExtAPI.DataModel.GeoData.GeoEntityById(sel.Ids[0])
len = entity.Length
ids = []
for part in ExtAPI.DataModel.GeoData.Assemblies[0].Parts:
if abs(edge.Length-len)/len<1.e-6:
ids.Add(edge.Id)
sel = ExtAPI.SelectionManager.CreateSelectionInfo(SelectionTypeEnum.GeometryEntities)
sel.Ids = ids
sizing.Location = sel
sizing.Type = SizingType.NumberOfDivisions
sizing.NumberOfDivisions = step.Properties["Sizing/Ndiv"].Value
step.Attributes.SetValue("sizing", sizing)
mesh.GenerateMesh()
def RemoveControls(step):
sizing = step.Attributes["sizing"]
sizing.Delete()
def IsLocationFSValid(step, prop):
if prop.Value==None:
return False
if prop.Value.Ids.Count!=1:
prop.StateMessage = "Select only one face."
return False
return True
def RefreshLoads(step):
step.Properties["Mesh/Nodes"].Value = model.Mesh.Nodes.ToString()
step.Properties["Mesh/Elements"].Value = model.Mesh.Elements.ToString()
panel = step.UserInterface.GetPanel("Properties")
panel.UpdateData()
panel.Refresh()
def CreateLoads(step):
analysis = model.Analyses[0]
support = analysis.AddFixedSupport()
sel = step.Properties["FixedSupport/Location"].Value
entity = ExtAPI.DataModel.GeoData.GeoEntityById(sel.Ids[0])
area = entity.Area
ids = []
for part in ExtAPI.DataModel.GeoData.Assemblies[0].Parts:
for face in body.Faces:
if abs(face.Area-area)/area<1.e-6:
ids.Add(face.Id)
sel = ExtAPI.SelectionManager.CreateSelectionInfo(SelectionTypeEnum.GeometryEntities)
257
Examples
sel.Ids = ids
support.Location = sel
loads = []
loads.Add(support)
step.Attributes.SetValue("loads", loads)
loads.Add(analysis.AddEarthGravity())
res = analysis.Solution.AddTotalDeformation()
step.Attributes.SetValue("res", res)
loads.Add(res)
analysis.Solve(True)
ExtAPI.Extension.SetAttributeValueWithSync("result", res.Maximum.ToString())
def RemoveLoads(step):
loads = step.Attributes["loads"]
for load in loads:
load.Delete()
def RefreshResults(step):
res = step.PreviousStep.Attributes["res"]
step.Properties["Res"].Value = res.Maximum.ToString()
panel = step.UserInterface.GetPanel("Properties")
panel.UpdateData()
panel.Refresh()
Mixed Wizard*
Our mixed wizard example is called BridgeSimulation. It is defined in the extension WizardDemos.
It executes one step on the Project tab, reuses the bridge builder in our CreateBridge DesignModeler
wizard, reruns the bridge analysis in our SimpleAnalysis Mechanical wizard, and then returns to the
Project tab to execute a Results step.
XML Definition File

Below is an excerpt of the XML extension file, WizardDemos.xml. Because this is a mixed wizard incorporating steps on the Project tab with steps from our existing DesignModeler and Mechanical wizards,
it uses all of the content in the XML extension defitinition file.
Script Reference
The <script> block specifies the IronPython scripts referenced by the extension. This wizard references
all three of the script files: main.py, dm.py, and ds.py.
The <interface> blocks define details of the interface. This wizard uses all of the interface blocks.
In one <interface> block, the context attribute is set to Project|Mechanical. In another
<interface> block, the context attribute is set to DesignModeler.
as the icon for the custom template.
The <toolbar> block is used to define two toolbar buttons for exposure in DesignModeler. When the
buttons are clicked, the <onclick> callbacks execute the CreateDeck and CreateSupport
functions and create a deck geometry with supports.
Simdata Definition
The two <simdata> blocks provide data for the creation of the Deck and Support geometries in
DesignModeler.
258
Wizard Examples
Wizard Definition
The context attribute is set to Project because the wizard will be executed in the Project tab; it
accesses the target applications from the Project tab instead of executing in them directly.
Step Definitions
The <step> tag is used to define the steps of the wizard. There are six steps: Project, Deck, Supports,
Mesh, Solution, and Results.
For each step:
step.
For the Project step, the <onupdate> callback executes the CreateStaticStructural
function in main.py.
For the Deck and Supports steps, <onupdate> callback executes the UpdateDeck and UpdateSupports functions in dm.py.
For the Mesh step, the <onreset> and <onupdate> callbacks execute the RemoveControls
and CreateMeshControls functions in ds.py.
For the Solution step, the <onrefresh>, <onreset>, and <onupdate> callbacks execute the
RefreshLoads, RemoveLoads, and CreateLoads functions in ds.py.
For the Results step, the <onrefresh> callback executes the RefreshResultsProject
function in main.py.
The <propertygroup> blocks define properties and property attributes for the steps.
</interface>
<toolbar name="Deck" caption="Deck">
<entry name="Deck" icon="deck">
<callbacks>
<onclick>CreateDeck</onclick>
</callbacks>
</entry>
<entry name="Support" icon="Support">
259
Examples
<callbacks>
<onclick>CreateSupport</onclick>
</callbacks>
</entry>
</toolbar>
</interface>
<geometry name="Deck" caption="Deck" icon="deck" version="1">
<callbacks>
<ongenerate>GenerateDeck</ongenerate>
</callbacks>
</geometry>
</simdata>
<geometry name="Support" caption="Support" icon="support" version="1">
<callbacks>
<ongenerate>GenerateSupport</ongenerate>
</callbacks>
property name="Number" caption="Number" control="integer" default="3" />
</geometry>
</simdata>
<description>Simple wizard for demonstration in Project page.</description>
<step name="Geometry" caption="Geometry" version="1" HelpFile="help/geometry.html">
<callbacks>
<onupdate>CreateGeometry</onupdate>
<onreset>DeleteGeometry</onreset>
</callbacks>
default="Option1">
</propertygroup>
</propertygroup>
</step>
<step name="Mechanical" caption="Mechanical" enabled="true" version="1" HelpFile="help/mechanical.html">
<callbacks>
<onupdate>CreateMechanical</onupdate>
<onreset>DeleteMechanical</onreset>
</callbacks>
260
Wizard Examples
</propertytable>
</step>
<step name="Fluent" caption="Fluent" version="1" HelpFile="help/fluent.html">
<callbacks>
<onrefresh>CreateDialog</onrefresh>
<onupdate>CreateFluent</onupdate>
</callbacks>

<callbacks>
</callbacks>
</property>
<callbacks>
</callbacks>
</property>
<property name="nextstep" caption="Next Step" control="select" >
<callbacks>
<onvalidate>ValidateNextStep</onvalidate>
</callbacks>
</property>
</step>
<step name="ReportView" caption="ReportView" version="1" layout="ReportView@WizardDemos">
<callbacks>
<onrefresh>RefreshReport</onrefresh>
</callbacks>
</step>
<step name="CustomStep" caption="CustomStep" enabled="true" version="1" layout="MyLayout@WizardDemos">
<callbacks>
<onrefresh>RefreshMechanical</onrefresh>
<onupdate>LogReport</onupdate>
</callbacks>
</step>
<step name="Charts" caption="Charts" enabled="true" version="1" layout="GraphLayout@WizardDemos">
<description>Demonstrate all chart capabilities.</description>
<callbacks>
<onrefresh>RefreshCharts</onrefresh>
</callbacks>
</step>
</wizard>
<wizard name="CreateBridge" version="1" context="DesignModeler" icon="wizard_icon">
<description>Simple wizard for demonstration in DesignModeler.</description>
261
Examples
<step name="Deck" caption="Deck" version="1" HelpFile="help/dm1.html">

<callbacks>
</callbacks>
</propertygroup>
</step>
<step name="Supports" caption="Supports" enabled="true" version="1" HelpFile="help/dm2.html">
<callbacks>
</callbacks>
</propertygroup>
</step>
</wizard>
<wizard name="SimpleAnalysis" version="1" context="Mechanical" icon="wizard_icon">
<description>Simple wizard to illustrate how to setup, solve and analyse results of
a simulation process.</description>
<step name="Mesh" caption="Mesh" version="1" HelpFile="help/ds1.html">
<callbacks>
</callbacks>
<callbacks>
</callbacks>
</property>
</propertygroup>
</step>
<step name="Solution" caption="Solution" version="1" HelpFile="help/ds2.html">
<callbacks>
</callbacks>
</propertygroup>
262
Wizard Examples
<callbacks>
</callbacks>
</property>
</propertygroup>
</step>
<step name="Results" caption="Results" version="1" HelpFile="help/ds3.html">
<callbacks>
<onrefresh>RefreshResults</onrefresh>
</callbacks>
</step>
</wizard>
<wizard name="BridgeSimulation" version="1" context="Project" icon="bridge">
<description>Simple wizard for mixed wizard demonstration.</description>
<step name="Project" caption="Create Project" version="1" context="Project" HelpFile="help/prj1.html">
<description>Create a static structural analysis.</description>
<callbacks>
<onupdate>CreateStaticStructural</onupdate>
<onreset>DeleteStaticStructural</onreset>
</callbacks>
<property name="Name" caption="system name" control="text" />
</step>
<step name="Deck" caption="Deck" version="1" context="DesignModeler" HelpFile="help/dm1.html">
<callbacks>
</callbacks>
</propertygroup>
</step>
<step name="Supports" caption="Supports" context="DesignModeler" enabled="true" version="1"
HelpFile="help/dm2.html">
<callbacks>
</callbacks>
</propertygroup>
</step>
<step name="Mesh" caption="Mesh" version="1" context="Mechanical" HelpFile="help/ds1.html">
<callbacks>
263
Examples
</callbacks>
<callbacks>
</callbacks>
</property>
</propertygroup>
</step>
<step name="Solution" caption="Solution" version="1" context="Mechanical" HelpFile="help/ds2.html">
<callbacks>
</callbacks>
</propertygroup>
<callbacks>
</callbacks>
</property>
</propertygroup>
</step>
<step name="Results" caption="Results" version="1" context="Project" HelpFile="help/prj2.html">
<callbacks>
<onrefresh>RefreshResultsProject</onrefresh>
</callbacks>
</step>
</wizard>
</extension>
IronPython Script
Because this is a mixed wizard incorporating steps on the Project tab with steps from our existing
DesignModeler and Mechanical wizards, the XML file references the three script files shown in previous
sections:
main.py
dm.py
ds.py
264
Wizard Examples
Electronics Desktop Wizard

Our Electronics Desktop wizard example is called ED Wizard Demo. It is defined in the extension Wizard
Demo.
This simple two-step wizard enables the creation of two geometries from three dimensional properties
and the addition of two boundary conditions. In the first step, the first two dimensions define and create
a rectangle; the first rectangle is then automatically duplicated and set at an offset along the Y axis,
which is defined by the third dimension. In the second step, two boundary conditions are automatically
created.
XML Definition File

Below is the XML extension file, WizardDemo .xml.
Script Reference
The <script> block specifies the IronPython script referenced by the extension, callbacks.py.
Wizard Definition
The required context attribute is set to ElectronicsDesktop because the wizard is executed in
the Electronics Desktop application.
The icon attribute specifies the filename of the image to be used as the icon for the wizard, antimage.png. The image is stored in the folder defined in the <images> block of the interface definition.
The description attribute defines text that is shown in the About window for the extension when
it is accessed from the Extension Manager and in the About window for the wizard when it is accessed
from the Wizards page.
Step Definitions
The <step> tag within the wizard block is used to define the steps of the wizard. There are two steps to
this wizard, named Step1 and Step2. For each step:
The version , caption , and description attributes define the step version, display name, and
display text for the step. These are shown in the About window for the wizard when it is accessed from
the Wizards page.
265
Examples
The <callbacks> block defines the callbacks to the functions defined in the callbacks.py Python
script. These are discussed in more detail in Reviewing the Analysis (p. 268).
<extension name="Wizard Demo" version="1">
<guid>819d1fd2-17c2-493a-ad6a-ee608356229a</guid>
<script src="callbacks.py" />
<interface context="ElectronicsDesktop">
</interface>
<wizard name="ED Wizard Demo" caption="Electronics Desktop Wizard Demo" version="1"
context="ElectronicsDesktop" icon="antImage">
<description>Simple example of a wizard in Electronics Desktop</description>
<step name="Step1" version="1" caption="Design">
<description>Create geometry</description>
<propertygroup name="dim" caption="Dimensions (mm)" persistent="False" parameterizable="False">
<property control="float" name="width" caption="Width" persistent="False"
parameterizable="False" default="0.4" />
<property control="float" name="height" caption="Height" persistent="False"
</propertygroup>
<propertygroup name="offset" caption="Offset for duplication (mm)" persistent="False"
parameterizable="False">
<property control="float" name="offset" caption="Offset" persistent="False"
</propertygroup>
<callbacks>
<onupdate>OnUpdate1</onupdate>
<onreset>OnReset1</onreset>
</callbacks>
</step>
<step name="Step2" version="1" caption="Setup">
<description>Define boundary conditions</description>
<propertygroup name="bc" caption="Boundary Conditions (Ohm)" persistent="False"
parameterizable="False">
<property control="float" name="resistance" caption="Full Resistance" persistent="False"
parameterizable="False" default="50." />
<property control="float" name="reactance" caption="Full Reactance" persistent="False"
parameterizable="False" default="0." />
</propertygroup>
<callbacks>
<onupdate>OnUpdate2</onupdate>
</callbacks>
</step>
</wizard>
</extension>>
IronPython Script
Below is the IronPython script, callbacks.py.
This script defines all the functions executed by the callbacks in our XML extension file.
# ---------------------------------------------# Callbacks
# ---------------------------------------------oDesign = None
266
Wizard Examples
oProject = None
def OnUpdate1(step):
global oDesign, oProject
oProject = oDesktop.NewProject()
oProject.InsertDesign("HFSS", "HFSSDesign1", "DrivenModal", "")
oDesign = oProject.SetActiveDesign("HFSSDesign1")
oEditor = oDesign.SetActiveEditor("3D Modeler")
width = step.Properties["dim/width"].Value
height = step.Properties["dim/height"].Value
offset = step.Properties["offset/offset"].Value
oEditor.CreateRectangle(
[
"NAME:RectangleParameters",
"IsCovered:="
, True,
"XStart:="
, "0mm",
"YStart:="
, "0mm",
"ZStart:="
, "0mm",
"Width:="
, str(width)+"mm",
"Height:="
, str(height)+"mm",
"WhichAxis:="
, "Z"
],
[
"NAME:Attributes",
"Name:="
, "Rectangle1",
"Flags:="
, "",
"Color:="
, "(128 255 255)",
"Transparency:="
, 0.800000011920929,
"PartCoordinateSystem:=", "Global",
"UDMId:="
, "",
"MaterialValue:="
, "\"vacuum\"",
"SolveInside:="
, True
])
oEditor.DuplicateAlongLine(
[
"NAME:Selections",
"Selections:="
, "Rectangle1",
"NewPartsModelFlag:="
, "Model"
],
[
"NAME:DuplicateToAlongLineParameters",
"CreateNewObjects:="
, True,
"XComponent:="
, "0mm",
"YComponent:="
, str(height+offset)+"mm",
"ZComponent:="
, "0mm",
"NumClones:="
, "2"
],
[
"NAME:Options",
"DuplicateAssignments:=", False
])
def OnReset1(step):
global oProject
oDesktop.CloseProject(oProject.GetName())
def OnUpdate2(step):
global oDesign
oModule = oDesign.GetModule("BoundarySetup")
width = step.PreviousStep.Properties["dim/width"].Value
height = step.PreviousStep.Properties["dim/height"].Value
offset = step.PreviousStep.Properties["offset/offset"].Value
resistance = step.Properties["bc/resistance"].Value
reactance = step.Properties["bc/reactance"].Value
oModule.AssignPerfectE(
[
"NAME:PerfE1",
267
Examples
"Objects:="
, ["Rectangle1_1","Rectangle1"],
"InfGroundPlane:=" , False
])
oEditor = oDesign.SetActiveEditor("3D Modeler")
oEditor.CreateRectangle(
[
"NAME:RectangleParameters",
"IsCovered:="
, True,
"XStart:="
, "0mm",
"YStart:="
, str(height)+"mm",
"ZStart:="
, "0mm",
"Width:="
, str(width)+"mm",
"Height:="
, str(offset)+"mm",
"WhichAxis:="
, "Z"
],
[
"NAME:Attributes",
"Name:="
, "Rectangle2",
"Flags:="
, "",
"Color:="
, "(128 255 255)",
"Transparency:="
, 0.800000011920929,
"PartCoordinateSystem:=", "Global",
"UDMId:="
, "",
"MaterialValue:="
, "\"vacuum\"",
"SolveInside:="
, True
])
oModule.AssignLumpedPort(
[
"NAME:1",
"Objects:="
, ["Rectangle2"],
"RenormalizeAllTerminals:=", True,
"DoDeembed:="
, False,
[
"NAME:Modes",
[
"NAME:Mode1",
"ModeNum:="
, 1,
"UseIntLine:="
, True,
[
"NAME:IntLine",
"Start:="
, [str(width/2.)+"mm",str(height)+"mm","0mm"],
"End:="
, [str(width/2.)+"mm",str(height+offset)+"mm","0mm"]
],
"AlignmentGroup:=" , 0,
"CharImp:="
, "Zpi",
"RenormImp:="
, "50ohm"
]
],
"ShowReporterFilter:=" , False,
"ReporterFilter:=" , [True],
"FullResistance:=" , str(resistance)+"ohm",
"FullReactance:="
, str(reactance)+"ohm"
])
Reviewing the Analysis

In this section, we'll review the UI and the processes performed in each step.
Step1 is the Design step that defines the geometries.
268
Wizard Examples
Figure 104: The Design Step
In this step:
The two <propertygroup> blocks define the three dimensional properties.
The first block defines the Dimensions to be used in creating the first rectangle: Width and Height
The second block defines the Offset for duplication to be used in the duplication of the first rectangle.
The <callbacks> block defines the following callbacks:
The <onupdate> callback is called when the Next button is clicked and invokes the OnUpdate1 function.
This function creates the new project, creates the first rectangle based on the entered dimensions and
then creates the second rectangle via duplication and offset according to the entered offset value.
The <onreset> callback is called when the user clicks on the Back button on the next step. The Back
button is enabled only if the <onreset> callback has been defined.
Step2 is the Setup step that defines and applies the boundary conditions.
Figure 105: The Setup Step
In this step:
The <propertygroup> block defines the two boundary conditions, the Full Resistance and Full Reactance
properties.
The <callbacks> block defines the <onupdate> callback, which is called when the Next button is
clicked and invokes the OnUpdate2 function. The OnUpdate2 function applies the boundary conditions
to both rectangles.
269
Examples
Once the wizard has completed, you can view the boundary conditions by selecting them in the Electronics Desktop Project Manager tree.
Figure 106: The Boundary Conditions
SpaceClaim Wizard
Our SpaceClaim wizard example is called BGAWizard. It is defined in the extension SC_BGA_Extension.
XML Definition File

Below is the XML extension file, SC_BGAExtension.xml.
270
Wizard Examples
Script Reference
The <script> block specifies the IronPython script referenced by the extension, main.py.
The context attribute is set to SpaceClaim because the extension is executed in the SpaceClaim
application.
The <toolbar> block is used to define a toolbar and toolbar button for exposure in SpaceClaim.
Wizard Definition
The context attribute is set to SpaceClaim because the wizard is executed in the SpaceClaim application.
Step Definitions
The <step> tag within the <wizard> block is used to define the steps of the wizard. There are three
steps: Die, SubstrateAndSolderMask, and SolderBall.
For each step:
The name, version, and caption attributes define the step name, version, and display text
for the step.
The <callbacks> block defines the callbacks to the functions defined in the main.py Python
script.
For the Die step, the <onupdate> callback executes the GenerateDie function.
For the SubstrateAndSolderMask step, the <onupdate> callback executes the GenerateSubstrateAndSolderMask function.
For the SolderBall step, the <onupdate> callback executes the GenerateBalls function.
<extension version="1" name="SC_BGA_Extension">
<guid shortid="SC_BGA_Extension">5107C33A-E123-4F55-8166-2ED2AA59B3B2</guid>
<interface context="SpaceClaim">
<callbacks>
<oninit>oninit</oninit>
</callbacks>
<toolbar name="SC_BGA_Extension" caption="SC_BGA Extension">
<entry name="SC_BGA_Package" icon="icepak_package">
<callbacks>
<onclick>createMyFeature</onclick>
</callbacks>
</entry>
</toolbar>
</interface>
<wizard name="BGAWizard" version="1" context="SpaceClaim">
271
Examples
<description>BGA Wizard</description>
<step name="Die" caption="Die" version="1">
<callbacks><onupdate>GenerateDie</onupdate></callbacks>
<property name="Thickness" caption="Height" unit="Length" control="float" default="0.3[mm]"/>
<property name="Width"
caption="Width" unit="Length" control="float" default="5 [mm]"/>
</step>
<step name="SubstrateAndSolderMask" caption="Substrate and SolderMask" version="1">
<callbacks><onupdate>GenerateSubstrateAndSolderMask</onupdate></callbacks>
<propertygroup name="SubstrateDetails" caption="SubstrateDetails" display="caption">
<property name="Thickness" caption="Thickness" unit="Length" control="float"
default="0.4 [mm]" >
</property>
<property name="Length" caption="Length" unit="Length" control="float" default="13 [mm]" >
</property>
</propertygroup>
<propertygroup name="SolderMaskDetails" caption="SolderMaskDetails" display="caption">
<property name="Height" caption="Solder Mask Height" unit="Length" control="float"
default="0.05 [mm]"/>
</propertygroup>
</step>
<step name="SolderBall" caption="Solder ball" version="1">
<callbacks><onupdate>GenerateBalls</onupdate></callbacks>
<property name="Face" caption="Face" control="scoping">
<attributes selection_filter="face"/>
</property>
<propertygroup name="SolderBallDetails" caption="Solder Ball Details" display="caption">
<propertygroup display="property" name="BallsPrimitive" caption="Balls primitive" control="select"
default="sphere">
<attributes options="sphere,cylinder,cone,cube,gear"/>
</propertygroup>
<property name="Pitch" caption="Pitch" unit="Length" control="float" default="0.8 [mm]"/>
<property name="Radius" caption="Radius" unit="Length" control="float" default="0.35 [mm]"/>
<property name="Number of Solder Ball Columns" caption="No of Solder Ball Columns" control="integer"
default="16"/>
<property name="Number of Solder Ball Rows" caption="No of Solder Ball Rows" control="integer" default="16"/>
</propertygroup>
<propertygroup name="Central Balls" caption="Central Thermal Balls">
<propertygroup display="property" name="Central Thermal Balls" caption="Want to Supress Central Balls"
control="select" default="No">
<attributes options="Yes,No"/>
<property name="Number of Solder Ball Columns" caption="No of Solder Ball Columns" control="integer"
default="4" visible = "false" visibleon="Yes"/>
<property name="Number of Solder Ball Rows" caption="No of Solder Ball Rows" control="integer"
default="4" visible = "false" visibleon="Yes"/>
</propertygroup>
</propertygroup>
</step>
</wizard>
<extension>
IronPython Script
import
import
import
import
import
272
System
clr
sys
os
math
Wizard Examples
part = None
def oninit(context):
return
def createMyFeature(ag):
ExtAPI.CreateFeature("MyFeature1")
def createSphere(x, y, z, radius):
global part
from System.Collections.Generic import List
# get selected part
if part==None:
win = Window.ActiveWindow
context = win.ActiveContext
part = context.ActivePart.Master
center = Geometry.Point.Create(x, y, z)
profileFrame = Geometry.Frame.Create(center, Geometry.Direction.DirX, Geometry.Direction.DirY)
sphereCircle = Geometry.Circle.Create(profileFrame, radius)
sphereRevolveLine = Geometry.Line.Create(center, Geometry.Direction.DirX)
profile = List[Geometry.ITrimmedCurve]()
profile.Add(Geometry.CurveSegment.Create(sphereCircle, Geometry.Interval.Create(0, math.pi)));
profile.Add(Geometry.CurveSegment.Create(sphereRevolveLine, Geometry.Interval.Create(-radius,
radius)))
path = List[Geometry.ITrimmedCurve]()
sweepCircle = Geometry.Circle.Create(Geometry.Frame.Create(center, Geometry.Direction.DirY,
Geometry.Direction.DirZ), radius)
path.Add(Geometry.CurveSegment.Create(sweepCircle))
body = Modeler.Body.SweepProfile(Geometry.Profile(Geometry.Plane.Create(profileFrame), profile), path)
DesignBody.Create(part, "sphere", body)
def createCylinder(x, y, z, radius, h):
global part
# get selected part
if part==None:
defaultPointUV = Geometry.PointUV.Create(0, 0)
profile = Geometry.CircleProfile(Geometry.Plane.PlaneXY, radius, defaultPointUV, 0)
points = List[Geometry.Point]()
points.Add(Geometry.Point.Create(0, 0, 0))
points.Add(Geometry.Point.Create(0, 0, h))
path = Geometry.PolygonProfile(Geometry.Plane.PlaneXY, points)
body = Modeler.Body.SweepProfile(profile, path.Boundary)
designBody = DesignBody.Create(part, "Cylinder", body)
translation = Geometry.Matrix.CreateTranslation(Geometry.Vector.Create(x, y, z))
designBody.Transform(translation)
def createCone(x, y, z, radius, h):
global part
# get selected part
if part==None:
defaultPointUV = Geometry.PointUV.Create(0, 0)
path = Geometry.CircleProfile(Geometry.Plane.PlaneXY, radius, defaultPointUV, 0)
points = List[Geometry.Point]()
points.Add(Geometry.Point.Create(0, 0, 0))
273
Examples
points.Add(Geometry.Point.Create(radius, 0, h))
points.Add(Geometry.Point.Create(0, 0, h))
triangle = Geometry.PolygonProfile(Geometry.Plane.PlaneZX, points)
body = Modeler.Body.SweepProfile(triangle, path.Boundary)
designBody = DesignBody.Create(part, "Cone", body)
def createBox(xa, ya, za, xb, yb, zb):
global part
# get selected part
if part==None:
lengthX
lengthY
lengthZ
xa = xa
ya = ya
=
=
=
+
+
xb - xa
yb - ya
zb - za
lengthX * 0.5
lengthY * 0.5
p = Geometry.PointUV.Create(0, 0)
body = Modeler.Body.ExtrudeProfile(Geometry.RectangleProfile(Geometry.Plane.PlaneXY, lengthX,
lengthY, p, 0), lengthZ)
designBody = DesignBody.Create(part, "body", body)
translation = Geometry.Matrix.CreateTranslation(Geometry.Vector.Create(xa, ya, za))
def createGear(x, y, z, innerRadius, outerRadius, width, count, holeRadius):
global part
# get selected part
if part==None:
frame = Geometry.Frame.World
# create gear
outsideCircle = Geometry.Circle.Create(frame, outerRadius);
insideCircle = Geometry.Circle.Create(frame, innerRadius);
boundary = List[Geometry.ITrimmedCurve]()
inwardLine = Geometry.Line.Create(frame.Origin, -frame.DirX);
outwardLine = Geometry.Line.Create(frame.Origin, frame.DirX);
axis = outsideCircle.Axis;
nTeeth = count;
repeatAngle = 2 * math.pi / nTeeth;
toothAngle = 0.6 * repeatAngle;
gapAngle = repeatAngle - toothAngle;
for i in range(0, nTeeth):
# an arc is just a parameter interval of a circle
startTooth = i * repeatAngle;
endTooth = startTooth + toothAngle;
boundary.Add(Geometry.CurveSegment.Create(outsideCircle, Geometry.Interval.Create(startTooth,
endTooth)));
# rotate 'inwardLine' about the circle axis
rotatedInwardLine = Geometry.Matrix.CreateRotation(axis, endTooth) * inwardLine;
# a line segment is just a parameter interval of an unbounded line
boundary.Add(Geometry.CurveSegment.Create(rotatedInwardLine, Geometry.Interval.Create(-outerRadius,
-innerRadius)));
startGap = endTooth;
endGap = startGap + gapAngle;
274
Wizard Examples
boundary.Add(Geometry.CurveSegment.Create(insideCircle, Geometry.Interval.Create(startGap, endGap)));
rotatedOutwardLine = Geometry.Matrix.CreateRotation(axis, endGap) * outwardLine;
boundary.Add(Geometry.CurveSegment.Create(rotatedOutwardLine, Geometry.Interval.Create(innerRadius,
outerRadius)));
hole = Geometry.Circle.Create(frame.Create(frame.Origin, frame.DirX, frame.DirY), holeRadius);
boundary.Add(Geometry.CurveSegment.Create(hole));
body = Modeler.Body.ExtrudeProfile(Geometry.Profile(Geometry.Plane.Create(frame), boundary), width);
pieces = body.SeparatePieces().GetEnumerator()
while pieces.MoveNext():
designBody = DesignBody.Create(part, "GearBody", pieces.Current);
class Vector:
def __init__(self, x = 0, y = 0, z = 0):
self.x = x
self.y = y
self.z = z
def Clone(self):
return Vector(self.x, self.y, self.z)
def NormSQ(self):
return self.x*self.x + self.y*self.y + self.z*self.z
def Norm(self):
return math.sqrt(self.x*self.x + self.y*self.y + self.z*self.z)
def Normalize(self):
norm = self.Norm()
self.x = self.x / norm
self.y = self.y / norm
self.z = self.z / norm
def GetNormalize(self):
norm = self.Norm(self)
return Vector(self.x / norm, self.y / norm, self.z / norm)
def __add__(va, vb):
return Vector(va.x + vb.x, va.y + vb.y, va.z + vb.z)
def __sub__(va, vb):
return Vector(va.x - vb.x, va.y - vb.y, va.z - vb.z)
def __mul__(v, x):
return Vector(v.x*x, v.y*x, v.z*x)
def Cross(va, vb):
return Vector(va.y*vb.z - va.z*vb.z, -va.z*vb.x + va.x*vb.z, va.x*vb.y - va.y*vb.x)
def Dot(va, vb):
return va.x*vb.x + va.y*vb.y + va.z*vb.z
def ToString(self):
return "( " + str(self.x) + ", " + str(self.y) + ", " + str(self.z) + " )"
def CreateBalls(primitive, pitch, radius, column, row, supr, columnSupr, rowSupr, center, dirColumn, dirRow):
dirColumn.Normalize()
dirRow.Normalize()
startVector = center - dirColumn*column*pitch*0.5 - dirRow*row*pitch*0.5
startVector = startVector + dirColumn*radius + dirRow*radius
startVector = startVector + dirRow.Cross(dirColumn)*radius
stepVectorColumn = dirColumn * pitch
stepVectorRow
= dirRow * pitch
if(supr == "Yes"):
column_index_to_start_supress = int( column * 0.5 - columnSupr * 0.5 )
row_index_to_start_supress
= int( row
* 0.5 - rowSupr
* 0.5 )
275
Examples
v = startVector.Clone()
for i in range(column):
for j in range(row):
createBall = False
if (supr == "Yes" and
(i
i
j
j
<
>=
<
>=
column_index_to_start_supress or
column_index_to_start_supress + columnSupr or
row_index_to_start_supress or
row_index_to_start_supress+ rowSupr)
or supr == "No"):
if primitive == "sphere":
createSphere(v.x, v.y, v.z, radius)
elif primitive == "cylinder":
createCylinder(v.x, v.y, v.z, radius, radius * 2.)
elif primitive == "cone":
createCone(v.x, v.y, v.z, radius, radius * 2.)
elif primitive == "cube":
createBox(v.x - radius, v.y - radius, v.z - radius,
v.x + radius, v.y + radius, v.z + radius)
elif primitive == "gear":
createGear(v.x, v.y, v.z,
radius*0.5, radius, radius*2, 10, radius*0.2)
v = v + stepVectorRow
v = startVector.Clone()
startVector = startVector + stepVectorColumn
v = v + stepVectorColumn
def CreateDie(width, thickness, zStart):
createBox(-0.5 * width, -0.5 * width, zStart,
0.5 * width, 0.5 * width, zStart + thickness)
def CreateSubstrate(width, thickness, zStart):
def CreateSolderMask(width, thickness, zStart):
def generateBGAGeometry(feature,fct):
ps = feature.Properties
Pitch
Solder_Ball_Radius
No_Of_Solder_Ball_Column
No_Of_Solder_Ball_Row
No_Of_Solder_Ball_Column_Supress
Ball Columns"].Value
No_Of_Solder_Ball_Row_Supress
Ball Rows"].Value
Substrate_Thickness
Substrate_Width
Die_Thickness
Die_Width
Solder_Mask_Height
supress_balls
ballsPrimitive
=
=
=
=
=
ps["Solder Ball Details/Pitch"].Value

ps["Solder Ball Details/Solder Ball Radius"].Value
ps["Solder Ball Details/Number of Solder Ball Columns"].Value
ps["Solder Ball Details/Number of Solder Ball Rows"].Value
ps["Central Balls/Central Thermal Balls/Number of Solder
= ps["Central Balls/Central Thermal Balls/Number of Solder

=
=
=
=
=
=
=
ps["Substrate Details/Substrate Thickness"].Value

ps["Substrate Details/Substrate Length"].Value
ps["Die Details/Die Thickness"].Value
ps["Die Details/Die Width"].Value
ps["Solder Ball Details/Solder Mask Height"].Value
ps["Central Balls/Central Thermal Balls"].Value
ps["BallsPrimitive"].Value
bodies = []
CreateBalls(ballsPrimitive, Pitch, Solder_Ball_Radius, No_Of_Solder_Ball_Column, No_Of_Solder_Ball_Row,
supress_balls,
No_Of_Solder_Ball_Column_Supress, No_Of_Solder_Ball_Row_Supress,
Vector(0, 0, 0), Vector(1, 0, 0), Vector(0, 1, 0))
#Creating Substrate and soldermask
CreateSubstrate(Substrate_Width, Substrate_Thickness, 0)
CreateSolderMask(Substrate_Width, Solder_Mask_Height, 0)
#Creating Die
Die_Start = Substrate_Thickness
276
Wizard Examples
CreateDie(Die_Width, Die_Thickness, Die_Start)
return True
def GenerateDie(step):
global part
part = context.ActivePart
ps = step.Properties
Die_Thickness = ps["Thickness"].Value
Die_Width
= ps["Width"].Value
CreateDie(Die_Width, Die_Thickness, 0)
part = None
def GenerateSubstrateAndSolderMask(step):
global part
Die_Thickness = step.PreviousStep.Properties["Thickness"].Value
Substrate_Thickness = ps["SubstrateDetails/Thickness"].Value
Substrate_Width
= ps["SubstrateDetails/Length"].Value
Solder_Mask_Height = ps["SolderMaskDetails/Height"].Value
CreateSubstrate(Substrate_Width, Substrate_Thickness, Die_Thickness)
CreateSolderMask(Substrate_Width, Solder_Mask_Height, Die_Thickness + Substrate_Thickness)
part = None
def GenerateBalls(step):
global part
zStart
zStart
zStart
zStart
= 0
+= step.PreviousStep.PreviousStep.Properties["Thickness"].Value
+= step.PreviousStep.Properties["SubstrateDetails/Thickness"].Value
+= step.PreviousStep.Properties["SolderMaskDetails/Height"].Value
faces
= ps["Face"].Value.Faces
pitch
= ps["SolderBallDetails/Pitch"].Value
radius
= ps["SolderBallDetails/Radius"].Value
column
= ps["SolderBallDetails/Number of Solder Ball Columns"].Value
row
= ps["SolderBallDetails/Number of Solder Ball Rows"].Value
primitive = ps["SolderBallDetails/BallsPrimitive"].Value
columnSupr = ps["Central Balls/Central Thermal Balls/Number of Solder Ball Columns"].Value
rowSupr
= ps["Central Balls/Central Thermal Balls/Number of Solder Ball Rows"].Value
supr
= ps["Central Balls/Central Thermal Balls"].Value
for i in range(0, faces.Count):
face = faces[i]
edges = face.Edges
if edges.Count == 0:
continue
# find two edges with a common point
edgeA = edges[0]
startPointA = edgeA.Shape.StartPoint
endPointA
= edgeA.Shape.EndPoint
for j in range(1, edges.Count):
edgeB = edges[j]
startPointB = edgeB.Shape.StartPoint
endPointB
= edgeB.Shape.EndPoint
277
Examples
if startPointB == startPointA:
basePoint
= startPointB
pointRow
= endPointA
pointColumn = endPointB
elif endPointB == startPointA:
basePoint
= endPointB
pointRow
= endPointA
pointColumn = startPointB
elif startPointB == endPointA:
basePoint
= startPointB
pointRow
= startPointA
pointColumn = endPointB
elif endPointB == endPointA:
basePoint
= endPointB
pointRow
= startPointA
pointColumn = startPointB
if not basePoint is None:
dirColumn = Vector(pointRow.X - basePoint.X, pointRow.Y - basePoint.Y,
pointRow.Z - basePoint.Z)
dirRow
= Vector(pointColumn.X - basePoint.X, pointColumn.Y - basePoint.Y,
pointColumn.Z - basePoint.Z)
center
= Vector(basePoint.X, basePoint.Y, basePoint.Z) + (dirRow + dirColumn)*0.5
CreateBalls(primitive, pitch, radius, column, row, supr, columnSupr, rowSupr, center,
dirColumn, dirRow)
break
part = None
AIM Custom Template (Single-Step)

Our AIM single-step custom template is called StudyDemo1. It is defined in the extension StudyDemo.
XML Definition File

Below is the XML extension file, StudyDemo.xml.
The extension is defined in the top-level <extension> block.
Extension Details
The required name and version attributes define the extension name and version.
The optional icon attribute specifies the path and filename for the image to be shown for the extension
in the Extension Manager (when accessed via the ACT Start Page). In this example, the icon file is
loss.png in the extensions images folder.
The required guid attribute specifies a unique identifier for the extension.
The optional description attribute provides a description that is shown in the extension details accessed
via the right-click About option in the Extension Manager (when accessed via the ACT Start Page).
Script Definition
The <script> block specifies the IronPython script referenced by the extension. For this custom template,
the script is main.py.
The extension interface is defined in the <interface> block.
278
Wizard Examples
Because the extension will be run in AIM, the context attribute is set to Study.
The <images> tag references the extensions images folder, which contains the image to be shown
for the extension.
Custom Template Definition

The custom template is defined in the <wizard> block, which defines the single step of the custom
template.
Custom Template Details
The required name and version attributes define the custom template name and version.
The required context option is set to Study because the custom template will be run in AIM.
The optional icon attribute specifies the filename for the image to be shown for the custom template
in AIM under Simulation Process Templates. This image must be stored in the extensions images
folder.
The optional description attribute provides a description that is shown in the extension details accessed via the right-click About option in the Extension Manager (when accessed via the ACT Start
Page).
Step Definitions
The <step> tag is used to define the single step of our custom template, step1.
Step Definitions
in the Extension Manager (when accessed via the ACT Start Page).
Page).
The optional helpFile attribute references the HTML help file to be displayed for the step and causes
the extension to search for help files.
For details on the custom help for this specific example, see Defining Custom Help for the SingleStep Custom Template (p. 282).
The <callbacks> block defines the callbacks to the functions defined in the Python script. For an AIM
custom template, only the <onupdate>, <onrefresh>, and <onreset> callbacks are supported.
In this example:
The <onupdate> callback executes the action function, which creates the Study in AIM.
The <onreset> executes the reset function, which allows you to modify the template
properties.
279
Examples
The <properties> block defines the properties used in the custom template. In this example:
For the Geometry property, the control attribute is set to fileopen, which displays a file-selection
property initialized to the default attribute value.
For the NAnalysis property:
The control attribute is set to integer, which allows you to edit the integer value for the default
attribute. This value specifies the number of analyses to be performed.
The <isvalid> callback calls the isvalid function, which validates that the entered integer is
not less than 1. A custom message can be displayed when the entered value fails validation.
<extension version="1" name="StudyDemo">
<interface context="Study">
</interface>
<wizard name="StudyDemo1" version="1" context="Study" icon="icon">
<description>Wizard to demonstrate the concept inside AIM.</description>
<step name="Step1" caption="Load geometry file" version="1" context="Study" helpFile="help/Step1.html">
<description>Import a geometry file.</description>
<callbacks>
<onupdate>action</onupdate>
<onreset>reset</onreset>
</callbacks>
<property name="Geometry" caption="Geometry file name" control="fileopen"
default="E:/Models/box.agdb" />
<property name="NAnalysis" caption="Number of Analysis" control="integer" default="1">
<callbacks>
<isvalid>isvalid</isvalid>
</callbacks>
</property>
</step>
</wizard>
</extension>
IronPython Script
This script defines the functions called by the callbacks in the custom template's XML extension definition
file.
The action function is the single step in our custom template. When called by the <onupdate> callback
(invoked by the Create Simulation button), it creates the Study workflow by creating and updating the
Geometry, Mesh, and Physics tasks.
The reset function, when called by the <onreset> callback, resets the UI and allows the user to modify
properties defined for the custom template. This occurs when encountering an error during the execution
of the <onupdate> callback.
280
Wizard Examples
The isvalid function, when called by the <isvalid> callback in the <properties> block, validates
that the property value entered is not less than 1. A custom message can be displayed when the entered
value fails validation.
tasksToDelete = []
groupsToDelete = []
def action(step):
global tasksToDelete,groupsToDelete
tasksToDelete = []
groupsToDelete = []
importComponent1 = Study.CreateTask(
Type="Import",
System=system1)
tasksToDelete.Add(importComponent1)
geometryImportSource1 = study1.CreateEntity(
Type="GeometryImportSource",
Association=import1)
geometryImportSource1.FilePath = step.Properties["Geometry"].Value
geometryImportSource1.GenerateImportSourceOperation()
step.UpdateProgressInformation(10.)
pct = 10.
for i in range(step.Properties["NAnalysis"].Value):
meshingComponent1 = Study.CreateTask(
Type="Meshing",
System=system1,
Input=importComponent1)
tasksToDelete.Add(meshingComponent1)
groupsToDelete.Add(physicsSolutionGroup1)
physicsDefinitionComponent1 = Study.CreateTask(
Type="Physics Definition",
System=system1)
tasksToDelete.Add(physicsDefinitionComponent1)
solvePhysicsComponent1 = Study.CreateTask(
Type="Solve Physics",
System=system1)
tasksToDelete.Add(solvePhysicsComponent1)
AddSourceToComponentInSystem(
SourceComponent=physicsDefinitionComponent1,
TargetComponent=solvePhysicsComponent1)
AddSourceToComponentInSystem(
SourceComponent=meshingComponent1,
TargetComponent=physicsDefinitionComponent1)
physicsRegion1 = study1.CreateEntity(
Type="PhysicsRegion",
solverSettings1 = study1.CreateEntity(
Type="SolverSettings",
transcript1 = study1.CreateEntity(
Type="Transcript",
meshing1.EngineeringIntent = "StructuralOrThermalOrElectricConduction"
physicsRegion1.Location = ["BODY1"]
physicsRegion1.PhysicsType = "Structural"
materialAssignment1 = study1.CreateEntity(
281
Examples
Type="MaterialAssignment",
materialAssignment1.Location = ["BODY1"]
material1 = study1.CreateEntity(
Type="Material",
material1.ImportEngineeringData(Name="Structural Steel")
pct += 10.
step.UpdateProgressInformation(pct)
if i==9:
raise UserErrorMessageException("My own error message.")
def reset(step):
global tasksToDelete,groupsToDelete
for group in groupsToDelete:
Study.DeleteTaskGroup(Group=group)
for task in tasksToDelete:
task.DeleteTask(System=system1)
def isvalid(step, prop):
if prop.Value<1:
prop.StateMessage = "Must be greater than 0."
return False
return True
Defining Custom Help for the Single-Step Custom Template

Weve defined three HTML help files for our custom template: one for the step and one for each of the
steps two properties.
We've named the help files according to our file naming rules.
The template-level file has the same name as the step: Step1.html
The two property-level files are the step name and the property name, separated by an underscore:
Step1_Geometry.html and Step1_NAnalysis.html
The image file workflow.png is referenced by Step1.html.
Each of the files is placed in the extensions help directory, as shown below:
The step-level help file is referenced in the XML step definition, as follows:
<step name="Step1" caption="Load geometry file" version="1" context="Study" helpFile="help/Step1.html">
282
Wizard Examples
The property-level help files dont need to be referenced from the XML file; once the helpFile attribute
is used at the step-level, the extension will find and display the help files for the associated properties
within the step.
AIM Custom Template (Multiple-Step)

Our AIM multiple-step custom template is called PressureLossMultiple. It is defined in an extension
of the same name.

Below is the XML extension file, PressureLossMultiple.xml.
The extension is defined in the top-level <extension> block.
Extension Details
in the Extension Manager(when accessed via the ACT Start Page). In this example, the icon file is
loss.png in the extensions images folder.
The required guid attribute specifies a unique identifier for the extension.
Page).
Script Definition
The <script> block specifies the IronPython script referenced by the extension. For this example, the
script is pressureLoss.py.
The extension interface is defined in the <interface> block.
Because the extension will be run in AIM, the context attribute is set to Study.
The <images> tag references the extensions images folder, which contains the image to be shown
for the extension and the custom template.
Custom Template Definition

The custom template is defined in the <wizard> block. This definition includes:
Custom Template Details
The required name and version attributes define the custom template name and version.
The required context option is set to Study because the custom template will be run in AIM.
283
Examples
The optional icon attribute specifies the filename for the image to be shown for the custom template
in AIM under Simulation Process Templates. This image must be stored in the extensions images
folder.
Page).
Step Definitions
The <step> tag is used to define the four steps of our custom template: Step1, Step2, Step3, and
Step4. For each step:
The required name and version attributes define the name and version of the step.
The optional description attribute provides a description of the step which is shown for the step in
the custom template UI.
The optional caption attribute specifies the label shown in for the step in the CDV.
The optional helpFile attribute references the HTML help file to be displayed for the step and causes
the extension to search for help files.
For general information on custom template help, see Custom Help for Wizards.
For details on the custom help for this specific example, see Defining Custom Help for the MultipleStep Custom Template (p. 289).
The <callbacks> block defines the callbacks to the functions defined in the Python script. For an AIM
custom template, only the <onupdate>, <onrefresh>, and <onreset> callbacks are supported.
During the execution of an <onupdate> callback for a step, an AIM progress message is displayed,
indicating that the step is being executed.
The <properties> block defines the properties used in the custom template.
Note that property definitions can include callbacks, as in Step 3 of our example. For details, see
the Breakdown of Steps (p. 284).
Breakdown of Steps
Step 1
Imports the geometry and creates the workflow in AIM.
The geometryfile property enables you to specify a geometry. You can either keep the geometry
specified by the default attribute or can browse to select a different one (control=fileopen).
For our example, we select a geometry called TubeSelectionSet.agdb.
The <onupdate> callback is invoked when you click the Next button. It executes the importGeometry
function, which imports the geometry you selected and then creates the workflow in AIM. Specifically,
it creates the workflow from journal content included in the Python function.
The HelpFile attribute references the help file geometry.html.
Step 2
Refines the mesh for the geometry.
284
Wizard Examples
The MeshResolution property enables you to set the resolution for the mesh. The Mesh Resolution
field has a default of 1 (default=1) and accepts only integer values (control= integer).
The <onupdate> callback is invoked when you click the Next button. It executes the refineMesh
function, which creates a mesh according to your specification.
The HelpFile attribute references the help file mesh.html.
Step 3
Defines the loads applied to the geometry.
The Velocity and GaugePressure properties enable you to enter values (control=float).
The InletLocation and OutletLocation properties require you to define the inlet and outlet
locations to which the load will be applied (control=scoping).
When a value is entered in the Outlet Location field, the <isvalid> callback is invoked. It executes
the isValid function, which verifies that the inlet and outlet locations are not the same.
The <onupdate> callback is invoked when you click the Next button. It executes the setup function,
which applies the loads to the selected locations and performs the calculations.
The HelpFile attribute references the help file loads.html.
Step 4
Exposes the maximum velocity and pressure loss results.
The MaximumVelocity and PressureLoss properties show the calculated values in read-only
format (readonly=true).
Click the Finish button to exit the custom template and return to the analysis.
<extension version="1" name="PressureLossMultiple" icon="images\loss.png">
<guid>C3F86496-2F13-49E3-B7D0-353542207EAE</guid>
<description>Demonstration of a pressure loss in AIM.</description>
<script src="pressureLoss.py" />
</interface>
<wizard name="PressureLossMultiple" version="1" context="Study" icon="loss">
<description>This wizard is for demonstration of ACT wizard capability in AIM.</description>
<step name="Step1" caption="Import the geometry" version="1" context="Study"
HelpFile="help/Step1.html">
<description>Import the geometry file and create the workflow.</description>
<callbacks>
<onupdate>importGeometry</onupdate>
</callbacks>
<property name="geometryfile" caption="Geometry File" control="fileopen"
default="E:\Geometry\TubeSelectionSet.agdb"/>
</step>
<step name="Step2" caption="Refine the mesh" version="1" helpFile="help/Step2.html">
<description>Refine the mesh from Low to High.</description>
<callbacks>
<onupdate>refineMesh</onupdate>
285
Examples
</callbacks>
<property name="MeshResolution" caption="Mesh Resolution" control="integer" default="1"/>
</step>
<step name="Step3" caption="Define the loads" version="1" helpFile="help/Step3.html">
<description>Specify the loads to applied on the geometry.</description>
<callbacks>
<onupdate>setup</onupdate>
</callbacks>

default="0.1 [m s^-1]"/>
<property name="InletLocation" caption="Inlet Location" control="scoping" />
<property name="GaugePressure" caption="Gauge Pressure" control="float"
unit="Pressure" default="0 [Pa]"/>
<property name="OutletLocation" caption="Outlet Location" control="scoping" >
<callbacks>
</callbacks>
</property>
</step>
<step name="Step4" caption="Export the maximum velocity" version="1" helpFile="help/Step4.html">
<description>Here we are just exposing the value of the maximum velocity and the pressure
loss.</description>
<property name="MaximumVelocity" caption="Maximum Velocity" control="float" unit="Velocity"
readonly = "True"/>
<property name="PressureLoss" caption="Pressure Loss" control="float" unit="Pressure"
readonly = "True"/>
</step>
</wizard>
</extension>
IronPython Script
Below is the IronPython script, pressureLoss.py.
This script defines the functions called by the callbacks in the custom template's XML extension definition
file.
meshingComponent1 = None
study1 = None
import1 = None
physicsDefinitionComponent1 = None
resultsEvaluationComponent1 = None
solvePhysicsComponent1 = None
physicsRegion1 = None
vectorResult1 = None
singleValueResult1 = None
286
Wizard Examples
results1 = None
materialAssignment1 = None
currentStep = None
clr.AddReference("Ans.UI")
def getSelectionSetsForProject():
context = __scriptingEngine__.CommandContext
project = context.Project
containers = project.GetContainers()
dataEntity = "SelectionSet"
for container in containers:
if container.Name == "Study":
try:
lockObject = context.ContainerReadLock(container)
dataReferences = project.GetDataReferencesByType(container, dataEntity)
finally:
lockObject.Dispose()
break
return dataReferences
def isValid(step, property):
if property.Value == step.Properties["InletLocation"].Value:
ExtAPI.Log.WriteWarning("Inlet and Outlet locations must be different.")
return False
return True
def importGeometry(step):
global meshingComponent1, import1, study1, results1, vectorResult1, singleValueResult1,
physicsDefinitionComponent1, resultsEvaluationComponent1, solvePhysicsComponent1, physicsRegion1,
materialAssignment1
with Transaction():
physicsDefinitionComponent1 = Study.CreateTask( Type="Physics Definition", System=system1)
physicsRegion1 = study1.CreateEntity( Type="PhysicsRegion", Association=physicsDefinition1)
solverSettings1 = study1.CreateEntity( Type="SolverSettings", Association=physicsDefinition1)
solvePhysicsComponent1 = Study.CreateTask( Type="Solve Physics", System=system1,
Input=physicsDefinitionComponent1)
resultsEvaluationComponent1 = Study.CreateTask( Type="Results Evaluation", System=system1,
Input=solvePhysicsComponent1)
physicsDefinition1.CalculationType = "Static"
physicsRegion1.PhysicsType = "Fluid"
physicsRegion1.Location = "AllBodies()"
materialAssignment1 = study1.CreateEntity( Type="MaterialAssignment",
material1 = study1.CreateEntity( Type="Material", Association=physicsDefinition1)
material1.ImportEngineeringData(Name="Air")
materialAssignment1.Location = [physicsRegion1]
results1 = resultsEvaluationComponent1.GetTaskObject()
vectorResult1 = study1.CreateEntity( Type="VectorResult", Association=results1)
vectorResult1.Variable = "Velocity"
vectorResult1.DisplayText = "Velocity"
transcript1 = study1.CreateEntity( Type="Transcript", Association=physicsDefinition1)
transcript1.DisplayText = "Fluid Flow Output 1"
meshingComponent1 = Study.CreateTask( Type="Meshing", System=system1,
Output=physicsDefinitionComponent1)
importComponent1 = Study.CreateTask( Type="Import", System=system1, Output=meshingComponent1)
287
Examples
geometryImportSource1 = import1.AddGeometryImportSourceOperation()
geometryImportSource1.FilePath = step.Properties["geometryfile"].Value
importComponent1.Update(AllDependencies=True)
Study.ChangeModelSelectionContextTo(import1)
def refineMesh(step):
global meshingComponent1, import1, study1, results1, vectorResult1, physicsDefinitionComponent1,
meshing1.MeshResolution = step.Properties["MeshResolution"].Value
Study.ChangeModelSelectionContextTo(import1)
def setup(step):
with Transaction():
meshControlLocalInflation1 = study1.CreateEntity( Type="MeshControlLocalInflation",
Association=meshing1)
meshing1.EngineeringIntent = "FluidFlow"
AddSourceToComponentInSystem( SourceComponent=physicsDefinitionComponent1,
TargetComponent=resultsEvaluationComponent1)
Study.Delete(Items=[meshControlLocalInflation1])
with Transaction():
meshingComponent1.Update(AllDependencies=True)
with Transaction():
inletBoundary1 = study1.CreateEntity( Type="InletBoundary", Association=physicsRegion1)
inlet_location = step.Properties["InletLocation"].Value.LocationSet
if inlet_location == None :
ExtAPI.Log.WriteMessage("inlet selection set does not exist")
inletBoundary1.Location = inlet_location
inletBoundary1.Flow.Velocity.Magnitude = step.Properties["Velocity"].DisplayString
outletBoundary1 = study1.CreateEntity( Type="OutletBoundary", Association=physicsRegion1)
outlet_location = step.Properties["OutletLocation"].Value.LocationSet
if outlet_location == None :
ExtAPI.Log.WriteMessage("outlets selection set does not exist")
outletBoundary1.Location = outlet_location
outletBoundary1.Flow.Pressure.GaugeStaticPressure = step.Properties["GaugePressure"].DisplayString
wallBoundary1 = study1.CreateEntity( Type="WallBoundary", Association=physicsRegion1)
with Transaction():
288
Wizard Examples
def solve(step):
with Transaction():
Defining Custom Help for the Multiple-Step Custom Template

Weve defined HTML help files for our custom template: one for each step and one for each of the
defined properties.
The step-level help files have the same names as our four steps: Step1.html, Step2.html, Step3.html,
and Step4.html.
The property-level help filenames are the corresponding step name and the property name separated by
an underscore: Step1_geometryfile.html, Step2_MeshResolution.html, Step3_GaugePressue.html, etc.
The image files are referenced by the HTML help files.
Each of the files is placed in the extensions help directory, as shown below:
The step-level help files are referenced in the XML step definitions. For example:
<step name="Step1" caption="Import the geometry" version="1" context="Study" HelpFile="help/Step1.html">
The property-level help files dont need to be referenced from the XML file; once the helpFile attribute
is used at the step-level, the extension will find and display the help files for the associated properties
within that step.
289
Examples
Wizard Custom Layout Example

You can use the optional <UIDefinition> block to create custom layouts for your wizard interface.
To demonstrate, well use a project wizard called CustomWizardLayout as an example. It is defined in
the extension CustomLayout.
This extension defines two custom layoutsone for each step in the CustomWizardLayout wizard.
Note
Since the basic construction of wizard extension is described elsewhere, in this section well
focus solely on aspects of layout customization.
XML Definition File

Below is the XML extension file, CustomLayout.xml.
In the UI definition, two layouts are defined:
TabularDataLayout:
Five components are defined: Title, Steps, TabularData, Help, and Submit.
Referenced by the step TabularData Sample with TabularDataLayout@CustomLayout.
ChartLayout:
Four components are defined: Title, Steps, Chart, and Submit.
Referenced by the step Chart Sample with ChartLayout@CustomLayout.
<extension name="CustomLayout" version="0">
<wizard name="CustomLayoutWizard" caption="CustomLayoutWizard" version="1" context="Project">
<step layout="TabularDataLayout@CustomLayout" name="TabularData Sample" version="0"
caption="TabularData Sample">
<propertytable display="Worksheet" control="tabulardata" name="Table" caption="Table"
persistent="False" parameterizable="False">
<property control="quantity" name="Time" caption="Time" persistent="False"
parameterizable="False" unit="Time" />
<property control="quantity" name="Pressure" caption="Pressure" persistent="False"
parameterizable="False" unit="Pressure" />
</propertytable>
<callbacks>
<onrefresh>onrefreshTabularDataSample</onrefresh>
<onreset>onresetTabularDataSample</onreset>
</callbacks>
</step>
<step layout="ChartLayout@CustomLayout" name="Chart Sample" version="0" caption="Chart Sample">
<callbacks>
<onrefresh>onrefreshChartSample</onrefresh>
</callbacks>
</step>
</wizard>
<uidefinition>
<layout name="TabularDataLayout">
<component name="Title" leftoffset="10" topoffset="10" rightoffset="10" bottomattachment="Steps"
bottomoffset="10" heighttype="FitToContent" height="0" widthtype="Percentage" width="100"
componenttype="startPageHeaderComponent" />
<component name="Steps" leftoffset="10" topattachment="Title" topoffset="0"
rightattachment="TabularData" rightoffset="0" bottomattachment="Help" bottomoffset="10"
290
Wizard Examples
heighttype="Percentage" height="67" widthtype="Percentage" width="30" componenttype="stepsListComponent" />
<component name="TabularData" leftattachment="Steps" leftoffset="0" topattachment="Title"
topoffset="0" rightoffset="10" bottomattachment="Help" bottomoffset="10" heighttype="Percentage"
height="67" widthtype="Percentage"
width="70" componenttype="tabularDataComponent" />
<component name="Help" leftoffset="10" topattachment="TabularData" topoffset="0" rightoffset="10"
bottomattachment="Submit" bottomoffset="10" heighttype="Percentage" height="33" widthtype="Percentage"
width="100"
componenttype="helpContentComponent" />
<component name="Submit" leftoffset="10" topattachment="Help" topoffset="0" rightoffset="10"
componenttype="buttonsComponent" />
</layout>
<layout name="ChartLayout">
<component name="Title" leftoffset="10" topoffset="10" rightoffset="10" bottomattachment="Steps"
componenttype="startPageHeaderComponent" />
<component name="Steps" leftoffset="10" topattachment="Title" topoffset="0" rightattachment="Chart"
rightoffset="0" bottomattachment="Submit" bottomoffset="10" heighttype="Percentage" height="100"
widthtype="Percentage" width="30" componenttype="stepsListComponent" />
<component name="Chart" leftattachment="Steps" leftoffset="0" topattachment="Title" topoffset="0"
rightoffset="10" bottomattachment="Submit" bottomoffset="10" heighttype="Percentage" height="100"
widthtype="Percentage" width="70" componenttype="chartComponent" />
<component name="Submit" leftoffset="10" topattachment="Chart" topoffset="0" rightoffset="10"
componenttype="buttonsComponent" />
</layout>
</uidefinition>
<description>Demo layout</description>
</extension>
IronPython Script
This script defines all the functions executed by the callbacks in our XML extension file. Note that the
functions reference the defined layouts using GetComponent().
def onrefreshTabularDataSample(step):
comp = step.UserInterface.GetComponent("TabularData")
table = step.Properties["Table"]
comp.SetPropertyTable(table)
def onrefreshChartSample(step):
table = step.PreviousStep.Properties["Table"]
tableValue = table.Value
rowCount = table.RowCount
x = []
y = []
for rowIndex in range(0, rowCount):
x.append(tableValue["Table/Time"][rowIndex].Value.Value)
y.append(tableValue["Table/Pressure"][rowIndex].Value.Value)
comp = step.UserInterface.GetComponent("Chart")
comp.Plot(x, y)
def onresetTabularDataSample(step):
#nothing to do
pass
Exposure of the Wizard Layouts

Below are images showing the exposure of the layouts defined for CustomLayoutWizard. In both images,
the layout is notated in red and individual components in blue.
This is the TabularDataLayout layout used for the TabularData Sample step.
291
Examples
Note that data must be entered into the TabularData component in order for the Submit components Next button to become enabled.
This is the ChartLayout layout used for the Chart Sample step.
The Chart component contains the chart generated for the tabular data entered in the previous step.
292
XML Extension Definition

ACT extensions have two basic components: an XML extension definition file that describes the content
of the extension and an IronPython script that defines functions to be referenced by the XML.
This section provides summary information on the following subset of the XML tags used in ACT:
the top-level <extension> (p. 294) element
the attributes of the <extension> element
the secondary elements that can go under the <extension> element
the sub-elements, attributes, and callbacks that can go under the secondary element
For the most comprehensive and up-to-date listing of available XML tags--as well as more detailed information on tags, attributes, and callbacks--please refer to the following reference documents:.
Table 7: ANSYS ACT XML Reference Documentation
Document
Description
Location
ACT Online Reference

Guide
Easy-to-navigate HTML
document providing both API
and XML reference materials.
ANSYS Customer Portal

(Downloads > ANSYS ACT
Application Store > Help &
Support)
Both online (.html) and

downloadable (.zip) versions
are available.
*Recommend version of developers
reference documentation.
ACT XML Reference
Guide
Reference document providing XML

definition and tagging information.
ANSYS Product Help

(Help > ANSYS
Documentation >
Customization)
ANSYS Customer Portal
(Knowledge Resources >
Online Documentation >
Customization)
Note
The content of the XML file is case-sensitive.
293
<extension>
The main XML element for an XML extension definition file is the <extension> element, which
provides initialization and configuration information for the extension. This is the base tag or root
element under which all other elements fall.
<extension version="[version number]" minorversion="[minor version number]"
name="[extension name]">
<author>author name</author>
<description>description of the extension</description>
<assembly src="[source file name (string)]"
namespace="[namespace (string)]"/>
</extension>
Beneath the <extension> element are the secondary elements that make up the extension.
The secondary elements and the attributes for the <extension> element are listed below. Click the
links to access the corresponding sections in this document.
Secondary XML elements under the <extension> element

<Application> (p. 295)
Defines a new ACT application.
<appStoreId> (p. 296)
Defines a unique identifier for the ACT application to be used in the ANSYS ACT Application Store.
<assembly> (p. 296)
Defines the assembly to be loaded.
<author> (p. 297)
Defines the author of the extension.
<description> (p. 297)
Defines the description of the extension.
<Guid> (p. 297)
Defines a unique identifier for the extension.
<Interface> (p. 298)
Specifies the customizations to be done at the GUI level.
<Licenses> (p. 300)
Defines a licenses collection for the extension.
<script> (p. 300)
Specifies the IronPython script that defines the functions called by the extension.
<simdata> (p. 301)
Defines a general section that stores all user object definitions; specifies the custom features to be integrated
into the application.
<Templates> (p. 303)
Defines a collection of control templates.
<UIDefintion> (p. 303)
Defines the user interface (customized panels and layouts) for the extension.
294
<extension>
<Wizard> (p. 303)
Defines one or more wizards (custom templates for AIM or wizards for other applications) within the extension.
<Workflow> (p. 304)
Defines custom workflows composed of process integration items (tasks and task groups).
Attributes for the <extension> element

version
Major version of the extension.
Mandatory attribute.
version="[version number (integer)]"
name
Name of the extension.
Mandatory attribute.
name="[extension name (string)]"
minorversion
Minor version of the extension.
Optional attribute.
minorversion="[minor version number (integer)]"
debug
Specifies if the scripted version of the extension should be opened in Debug mode.
Optional attribute.
icon
Icon for the extension.
Optional attribute.
<Application>
Defines a new application.
<application>
<callbacks> ... </callbacks>
<description>
<description>
<panel>
</application>
Sub-element tags for the <application> element

<Callbacks>
Specifies the callbacks that will invoke functions from the IronPython extension script.
295

<description>
Description of the application.
<Panel>
Defines a panel to be displayed.
Attributes for the <application> element

name
Name of the application.
Mandatory.
class
Class name of the controller of the application.
Optional.
context
Defines a context or combination of contexts (separated using '|') in which the application can be launched.
Optional.
MainPanel
Name of the first panel to display.
Optional.
Callbacks for the <application> element

<OnApplicationFinished>
Invoked when when the application finishes.
<OnApplicationInitialized>
Invoked when the application initializes.
<OnApplicationStarted>
Invoked when the application starts.
<appStoreId>
Defines a unique identifier for the ACT application to be used in the ANSYS ACT Application Store.
No sub-element tags, attributes, or callbacks.
<appstoreid>appStoreId</appstoreid>
<assembly>
Defines the assembly to be loaded.
<assembly src="[file name]" namespace="[namespace]"/>
296
<extension>
Attributes for the <assembly> element

context
Context or combination of contexts (separated using '|') for the import.
Mandatory.
namespace
Namespace to import.
Mandatory.
namespace="[namespace]"
src
Name of the dll file to import.
Mandatory.
src="[file name]"
<author>
Defines the author of the extension.
<author>[Name of the author or organisation (string)]</author>
<description>
Defines the description of the extension.
<description>[Description (string)]</description>
<Guid>
Defines a unique identifier for the extension.
The GUID is he unique identifier of the extension. Two extensions with the same GUID will be considered
by ACT as the same extension. This is very important when the extension is deployed to ensure that
two different extensions will never be in conflict (have the same name, for example). This identifier
must be added at least before the first build of the extension and must never changed after that. When
the extension is updated, a new version created, or features added, the GUID must be kept unchanged.
<guid shortid="[name (string)]">GUID</guid>
Attributes for the <Guid> element

shortid
Short identifier for backward compatibility. Must be the same as the extension name for all extensions
created before R15.
Optional.
297

shortid="[extension name (string)]"
<Interface>
Defines the user interface for the extension.
<extension version="[version id (integer)]"
<interface context="[Project | Mechanical]">
...
</interface>
Sub-element tags for the <Interface> element

<Callbacks>
<filter>
Defines a filter.
<images>
Defines the default folder where images to be used by the extension are stored.
<images>[folder]</images>
<toolbar>
Defines a toolbar.
<toolbar name="[toolbar internal name (string)]" caption="[toolbar display name (string)]">
<entry>...</entry>
</toolbar>
Attributes for the <Interface> element

context
Context or combination of contexts (separated using '|') for the interface.
Mandatory.
context="[context name]
Callbacks for the <Interface> element

<GetPostCommands>
Called to collect all "post" commands to add to the solver input file.
<getpostcommands>[function(analysis,stream)]</getpostcommands>
<GetPreCommands>
Called to collect all "pre" commands to add to the solver input file.
<getprecommands>[function(analysis,stream)]</getprecommands>
<GetSolveCommands>
Called to collect all "solve" commands to add to the solver input file.
<getsolvecommands timedependent="[true | false(default)]">
298
<extension>
<IsAnalysisValid>
Called to check if an analysis is valid.
<isanalysisvalid>[function(solver)]</isanalysisvalid>
<OnActiveObjectChange>
Called when the active object is changed.
<OnAfterGeometryUpdate>
Called after the geometry has been updated.
<OnAfterRemove>
Called after the object has been removed.
<OnAfterSolve>
Called after an analysis has been solved.
<onaftersolve>[function(analysis)]</onaftersolve>
<OnBeforeGeometryUpdate>
Called before the geometry is starts to update.
<OnBeforeSolve>
Called before an analysis starts to solve.
<onbeforesolve>[function(analysis)]</onbeforesolve>
<OnBodySuppressStateChange>
Called when the body suppress state has been changed.
<OnDraw>
Called when the application is drawn.
<OnDraw2D>
Called when the application is drawn.
<ondraw>[function()]</ondraw>
<OnInit>
Called when the given context is initialized.
<oninit>[function name(application context)] </oninit>
<OnLoad>
Called when a project is loaded.
<onload>[function(currentFolder)]</onload>
<OnMeshCleaned>
Called when the mesh is cleaned.
<OnMeshGenerated>
Called when the mesh is generated.
<OnPostFinished>
Called when the postprocessing ends for a given analysis.
<onpostfinished>[function(analysis)]</onpostfinished>
299

<OnPostStarted>
Called when the postprocessing starts for a given analysis.
<onpoststarted>[function(analysis)]</onpoststarted>
<OnReady>
Called when the application is fully loaded and in a "ready" state.
<OnSave>
Called when the project is saved.
<onsave>[function(currentFolder)]</onsave>
<OnTerminate>
Called when the given context is terminated.
<onterminate>[function(context)]</onterminate>
<Resume>
Called when a project is loaded.
<resume>[function(binary reader)]</resume>
<Save>
Called when a project is saved.
<save>[function(binary writer)]</save>
<Licenses>
Defines a licenses collection for the extension.
<script>
Specifies the IronPython script referenced by the extension.
<extension version="[version id (integer)]"
<script src="[python file name (string)]"></script></extension>
You can either insert the IronPython script directly into the XML file, or use the src attribute to specify
the path to the script.
Additional paths can be specified by adding new <script> elements. For example:
<script src="[Path]\filename.py" />
If the src attribute is defined, then the tag content is ignored.

By default, ACT looks for IronPython scripts in the same directory as the extension. If the scripts are not
located in that directory, you can specify the path the scripts in addition to the file name. For example:
<script src="my_path\main.py" />
300
<extension>
Attributes for the <script> element

compiled
Specifies whether the script will be compiled as a binary file.
Optional.
compiled="[false(default) | true]"
src
Specifies the IronPython script referenced by the extension.
Optional.
src="[python file name (string)]"
<simdata>
Defines a general section that stores all user object definitions.
The <simdata> element information pertains specifically to the simulation environment. Child elements
are used for integrating custom simulation features into the application. These main features are nested
as child elements within the <simdata> element.
<simdata>
<load>
<object>
<optimizer>
<solver>
<geometry>
<result>
<step>
<ExtensionObject>
<Sampling>
</simdata>
Sub-element tags for the <simdata> element

<load>
Defines a simulation load or boundary.
<load name="[load internal name]"
version="[version identifier of the load]"
caption="[load display name]"
icon="[name of an icon file]"
issupport="[true | false]"
isload="[true | false]"
color="[#xxxxxx]"
contextual="[true(default) | false]"
class="[class name]"
unit="[Default unit name]"
...
</load>
<object>
Defines a simulation object.
<object>
<property>
<propertygroup>
<propertytable>
301

<target>
</object>
<optimizer>
Defines an optimizer.
<optimizer>
<property>
<propertygroup>
<propertytable>
</optimizer>
<solver>
Specifies pecifying a third-party solver to be used in the simulation.
<optimizer>
<property>
<propertygroup>
<propertytable>
</optimizer>
<geometry>
Defines a geometry feature.
<geometry>
<property>
<propertygroup>
<propertytable>
</geometry>
<result>
Defines a custom result.
<result>
<property>
<propertygroup>
<propertytable>
</result>
<step>
Defines a step in a wizard.
<step>
<description>
<property>
<propertygroup>
</step>
<ExtensionObject>
Extends the extension object definition. (Inherited from DesignXplorer SimEntity)
<extensionobject>
<property>
<propertygroup>
<propertytable>
<target>
</extensionobject>
302
<extension>
<Sampling>
Defines a custom sampling.
<sampling>
<property>
<propertygroup>
<propertytable>
<target>
</sampling>
Attributes for the <simdata> element

context
Context or combination of contexts (separated using '|').
Mandatory.
context="[Project | targetapp | targetapp]">
<Templates>
Defines a collection of control templates.
<templates>
<controltemplate name="[template name (string)]" version="[version id (integer)]">
<propertygroup>
<property> ... </property>
<propertygroup> ... </propertygroup>
</propertygroup>
</controltemplate>
</templates>
<UIDefintion>
Defines one or more layouts that can be used for wizards.
<uidefinition>
<layout>
</uidefinition>
Sub-element tags for the <UIDefintion> element

<ControlTemplate>
Defines a control template for the creation of groups of properties.
<Wizard>
Defines one or more wizards within the extension.
<wizard>
<author>
<description>
<step></step>
</wizard>
303
Sub-element tags for the <Wizard> element

<Callbacks>
Attributes for the <Wizard> element

<context>
Context or combination of contexts (separated using '|') for the wizard.
Mandatory.
<name>
Name of the wizard.
Mandatory.
<version>
Version of the wizard.
Mandatory.
<caption>
Caption for the wizard.
Optional.
<icon>
Icon for the wizard.
Optional.
<layout>
Layout of the wizard.
Optional.
<description>
Description of the wizard.
Optional.
Callbacks for the <Wizard> element

<canstart>
Invoked to determine whether the wizard can be started.
<Workflow>
Defines custom workflows composed of process integration items (tasks and task groups). Defines the
top-level workflow tag within an ACT app.
<workflow>
<taskgroups>
304
<extension>
<tasks>
</workflow>
Sub-element tags for the <Workflow> element

<Callbacks>
Specifies the callbacks that will invoke functions from the IronPython extension script. (Inherited from SimEntity)
<TaskGroups>
Task groupings to be exposed as organized blocks within the workflow.
<Tasks>
Tasks exposed by this workflow.
Attributes for the <Workflow> element

caption
Caption for the object. (Inherited from SimEntity)
Optional.
class
Class name of the controller of the object. (Inherited from SimEntity)
Optional.
context
Context (application) to which this workflow applies.
Mandatory.
contextual
Indicates whether the object must be displayed in the contextual menu. (Inherited from SimEntity)
Optional.
icon
Icon for the object. (Inherited from SimEntity)
Optional.
name
Name of the object. (Inherited from SimEntity)
Mandatory.
version
Version of the object. (Inherited from SimEntity)
Mandatory.
305
Callbacks for the <Workflow> element

<onbeforetaskreset>
Invoked before the task is reset back to its pristine, new state.
<onaftertaskreset>
Invoked after the task has been reset back to its pristine, new state.
<onbeforetaskrefresh>
Invoked before the task consumes all upstream data and prepares any local data for an ensuing update.
<onaftertaskrefresh>
Invoked after the task has consumed all upstream data and has prepared any local data for an ensuing
update.
<onbeforetaskupdate>
Invoked before the task generates all broadcast output types that render the component fully solved.
<onaftertaskupdate>
Invoked after the task has generated all broadcast output types that render the component fully solved.
<onbeforetaskcreate>
Invoked before the task is created based on an underlying template.
<onaftertaskcreate>
Invoked after the task has been created based on an underlying template.
<onbeforetaskdelete>
Invoked before the task is removed from a task group.
<onaftertaskdelete>
Invoked after the task has been removed from a task group.
<onbeforetaskduplicate>
Invoked before an identical, yet independent, clone of the task is created.
<onaftertaskduplicate>
Invoked after an identical, yet independent, clone of the task has been created.
<onbeforetasksourceschanged>
Invoked before the task processes a change in upstream sources.
<onaftertasksourceschanged>
Invoked after the task has processed a change in upstream sources.
<onbeforetaskcanusertransfer>
Invoked before the task checks whether it can consume data from a specific upstream task.
<onaftertaskcanusertransfer>
Invoked after the task has checked whether it can consume data from a specific upstream task.
<onbeforetaskcanduplicate>
Invoked before the task checks whether it permits duplication.
306
<extension>
<onaftertaskcanduplicate>
Invoked after the task has checked whether it permits duplication.
<onbeforetaskstatus>
Invoked before the task calculates its current state.
<onaftertaskstatus>
Invoked after the task has calculated its current state.
<onbeforetaskpropertyretrieval>
Invoked before the task determines the visibility of its property-containing objects.
<onaftertaskpropertyretrieval>
Invoked after the task has determined the visibility of its property-containing objects.
307
308
Appendix A. Component Input and Output Tables

The following tables list component inputs and outputs supported by ACT.
Table 8: Autodyn
Taskgroup
Task
Input
Output
AUTODYN_Remap
AutodynSetup
Autodyn
Setup
MechanicalSetup
SimulationGeneratedMesh
Analysis
None
None
Input
Output
None
TurboGeometry
Table 9: BladeGen
Taskgroup
Task
BladeGen
Blade
Design
VistaGeometry
BladeGen
(Beta)
Blade
Design
None
TurboGeometry
VistaGeometry
Table 10: CFX

Taskgroup
Task
Input
Output
CFXSetup
CFXMesh
SystemCouplingSetupData
CFX
(Beta)
Setup
MechanicalSetup
Solution
CFXSetup
CFXSolution
309
Component Input and Output Tables

Taskgroup
Task
Input
Output
CFXSolution
CFX
Setup
CFXSetup
CFXMesh
MechanicalSetup
Solution
CFXSetup
CFXSolution
CFXSolution
Results
CFXSolution
CFDAnalysis
FluentSolution
ForteSolution
VistaTFSolution
IcePakResults
PolyflowSolutionType
MechanicalSolution
ICEData
Table 11: Design Assessment
Taskgroup
Task
Input
Output
ExternalModelOutputProvider
Material
FEMSetup
EngineeringData
Design
Assessment
Engineering
Data
MatML31
Geometry
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Model
310
AIMGeometryMeshOutputProvider
MechanicalModel
CompositeEngineeringData
MechanicalMesh
EngineeringData
EnhancedModelData
SimulationEngineeringData
Taskgroup
Task
Input
Output
ExternalDataSetup
SimulationModelGeneratedMesh
ExternalTraceDataSetup
Geometry
Modeler
SimulationSolutionOutputProvider
SolidSectionData
GeneralTransfer
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
SimulationSolutionDataInternal
MechanicalSolution
GeneralTransfer
Solution
SimulationSetup
MechanicalSolution
GeneralTransfer
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Table 12: Direct Optimization

Taskgroup
Task
Input
Output
DesignPointsDataTransfer
OptimizationModel
Input
Output
EngineeringData
FEMSetup
Material
Direct
Optimization
Optimization
Table 13: Electric

Taskgroup
Task
Electric
Engineering
Data
311

Taskgroup
Task
Input
Output
MatML31
Geometry
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Model
MechanicalModel
MechanicalMesh
EngineeringData
EnhancedModelData
ExternalDataSetup
GeneralTransfer
Geometry
Modeler
SolidSectionData
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
GeneralTransfer
Solution
SimulationSetup
MechanicalSolution
GeneralTransfer
SimulationSolution
Results
SimulationSolution
312
MechanicalResults
Taskgroup
Task
Input
Output
SimulationResults
Table 14: Engineering Data

Taskgroup
Task
Input
Output
Material
FEMSetup
EngineeringData
Engineering
Data
Engineering
Data
MatML31
Table 15: Explicit Dynamics
Taskgroup
Task
Input
Output
EngineeringData
FEMSetup
Material
Explicit
Dynamics
Engineering
Data
MatML31
Geometry
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Model
MechanicalModel
MechanicalMesh
EngineeringData
EnhancedModelData
ExternalDataSetup
GeneralTransfer
Geometry
Modeler
313

Taskgroup
Task
Input
Output
SolidSectionData
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
EnhancedMechanicalModel
EnhancedModelData
GeneralTransfer
Solution
SimulationSetup
MechanicalSolution
GeneralTransfer
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Table 16: Explicit Dynamics (LS-DYNA Export)

Taskgroup
Task
Input
Output
Explicit
Dynamics
(LS-DYNA
Export)
Engineering
Data
FEMSetup
EngineeringData
MatML31
Material
FEMSetup
Geometry
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Model
314
MechanicalModel
MechanicalMesh
EngineeringData
EnhancedModelData
Taskgroup
Task
Input
Output
ExternalDataSetup
GeneralTransfer
Geometry
Modeler
SolidSectionData
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
GeneralTransfer
Table 17: External Data
Taskgroup
Task
Input
Output
None
ExternalDataSetup
External
Data
Setup
Table 18: External Model
Taskgroup
Task
Input
Output
None
External
Model
Setup
Table 19: External Connection

Taskgroup
Task
Input
Output
External
Connection
External
Connection
315

Taskgroup
Task
Input
Output
None
ExternalConnectionProperties
Table 20: Finite Element Modeler

Taskgroup
Task
Input
Output
MechanicalSetup
FEMMesh
FEMSetup
MAPDLCdb
Geometry
Finite
Element
Modeler
Model
FEMSetup
SolidSectionData
Table 21: Fluent (with Fluent Meshing)
Taskgroup
Task
Input
Output
FluentMesh
FluentTGridMesh
Fluent
Mesh
Geometry
Setup
AIMFluentMeshOutputProvider
FluentSetup
AnsoftHeatLossDataObject
FluentCase
FluentImportable
FluentMesh
FluentTGridMesh
ICEData
ICESetupData
Solution
FluentSetup
FluentSolution
FluentSolution
Table 22: Fluent
Taskgroup
Task
Input
Output
Fluent
Setup
316
Taskgroup
Task
Input
Output
FluentSetup
FluentImportable
FluentMesh
FluentCase
ICEData
ICESetupData
FluentTGridMesh
Solution
FluentSetup
FluentSolution
FluentSolution
Table 23: Fluid Flow Blow Molding (Polyflow)
Taskgroup
Task
Input
Output
FEMSetup
Geometry
Fluid
Flow
Blow
Molding
(Polyflow)
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Mesh
Geometry
MechanicalModel
MeshingGeneratedMeshOutputProvider
MeshingMesh
Setup
PolyflowSetup
PolyflowTransferMesh
Solution
PolyflowSetup
PolyflowSolution
PolyflowSolution
ExternalDataSetup
Results
317

Taskgroup
Task
Input
Output
CFXSolution
CFD Analysis
FluentSolution
ForteSolution
VistaTFSolution
IcePakResults
MechanicalSolution
ICEData
Table 24: Fluid Flow Extrusion (Polyflow)
Taskgroup
Task
Input
Output
FEMSetup
Geometry
Fluid
Flow
Extrusion
(Polyflow)
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Mesh
Geometry
MechanicalModel
MeshingMesh
Setup
PolyflowSetup
Solution
PolyflowSetup
PolyflowSolution
PolyflowSolution
ExternalDataSetup
Results
CFXSolution
CFDAnalysis
FluentSolution
ForteSolution
VistaTFSolution
IcePakResults
318
Taskgroup
Task
Input
Output
MechanicalSolution
ICEData
Table 25: Fluid Flow (CFX)
Taskgroup
Task
Input
Output
FEMSetup
Geometry
Fluid
Flow
(CFX)
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Mesh
Geometry
MechanicalModel
MeshingMesh
Setup
CFXSetup
CFXMesh
MechanicalSetup
Solution
CFXSetup
CFXSolution
CFXSolution
Results
CFXSolution
CFDAnalysis
FluentSolution
ForteSolution
VistaTFSolution
IcePakResults
MechanicalSolution
319

Taskgroup
Task
Input
Output
ICEData
Table 26: Fluid Flow (Fluent)
Taskgroup
Task
Input
Output
FEMSetup
Geometry
Fluid
Flow
(Fluent)
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Mesh
Geometry
MechanicalModel
MeshingMesh
Setup
FluentImportable
FluentSetup
FluentMesh
FluentCase
ICEData
ICESetupData
FluentTGridMesh
Solution
FluentSetup
FluentSolution
FluentSolution
Results
CFXSolution
CFDAnalysis
FluentSolution
ForteSolution
VistaTFSolution
IcePakResults
MechanicalSolution
320
Taskgroup
Task
Input
Output
ICEData
Table 27: Fluid Flow (Polyflow)
Taskgroup
Task
Input
Output
FEMSetup
Geometry
Fluid
Flow
(Polyflow)
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Mesh
Geometry
MechanicalModel
MeshingGeneratedMeshOutputProvider MeshingMesh
Setup
PolyflowSetup
Solution
PolyflowSetup
PolyflowSolution
PolyflowSolution
ExternalDataSetup
Results
CFXSolution
CFDAnalysis
FluentSolution
ForteSolution
VistaTFSolution
IcePakResults
MechanicalSolution
ICEData
Table 28: Geometry
Taskgroup
Task
Input
Output
Geometry
Geometry
321

Taskgroup
Task
Input
Output
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Table 29: Harmonic Response
Taskgroup
Task
Input
Output
EngineeringData
FEMSetup
Material
Harmonic
Response
Engineering
Data
MatML31
Geometry
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Model
MechanicalModel
MechanicalMesh
EngineeringData
EnhancedModelData
ExternalDataSetup
GeneralTransfer
Geometry
Modeler
SolidSectionData
Setup
322
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
Taskgroup
Task
Input
Output
EnhancedModelData
ExternalDataSetup
MechanicalSolution
AnsoftForceAndMomentDataObject
GeneralTransfer
Solution
SimulationSetup
MechanicalSolution
GeneralTransfer
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Table 30: Hydrodynamic Diffraction

Taskgroup
Task
Input
Output
FEMSetup
Geometry
Hydrodynamic
Diffraction
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Model
Geometry
AqwaModel
AqwaModel
AqwaSetup
AqwaSetup
AqwaSolution
AqwaSolution
AqwaResults
Setup
Solution
Results
Table 31: Hydrodynamic Response

Taskgroup
Task
Input
Output
Hydrodynamic
Response
323

Taskgroup
Task
Input
Output
FEMSetup
Geometry
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Model
Geometry
AqwaModel
AqwaModel
AqwaSetup
Setup
AqwaSolution
Solution
AqwaSetup
AqwaSolution
AqwaSolution
AqwaResults
Input
Output
None
ICEData
FEMSetup
Geometry
Results
Table 32: IC Engine (Fluent)

Taskgroup
Task
ICE
Engine
(Fluent)
ICE
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Mesh
Geometry
MechanicalModel
MeshingMesh
MeshingGeneratedMeshOutput
-Provider
ICE
Solver
Setup
SimulationGeneralMesh
ICESetupData
324
Taskgroup
Task
Input
Output
Setup
FluentImportable
FluentSetup
FluentMesh
FluentCase
ICEData
ICESetupData
FluentTGridMesh
Solution
FluentSetup
FluentSolution
FluentSolution
Results
CFXSolution
CFDAnalysis
FluentSolution
ForteSolution
VistaTFSolution
IcePakResults
MechanicalSolution
ICEData
Table 33: IC Engine (Forte)
Taskgroup Task
Input
Output
None
ICEData
IC
Engine
(Forte)
ICE
GeometryCellTemplate
AnsoftCADObject
Geometry
FEMSetup
Geometry
ICEData
TurboGeometry
Mesh
Geometry
MechanicalModel
325

Taskgroup Task
Input
Output
MeshingMesh
ICE Setup
ICESetupData
Forte
FluentTGridMesh
ForteSolution
ICESetupData
Results
CFXSolution
CFDAnalysis
FluentSolution
ForteSolution
ICEData
IcePakResults
MechanicalSolution
VistaTFSolution
Table 34: ICEM CFD
Taskgroup
Task
Input
Model
FluentImportable
Output
ICEM
CFD
Geometry
MeshingMesh
MechanicalMesh
Table 35: Icepak
Taskgroup
Task
Input
Output
Geometry
IcePakSetup
Icepak
Setup
Solution
326
Taskgroup
Task
Input
Output
IcePakSetup
IcePakResults
Table 36: Eigenvalue Buckling

Taskgroup
Task
Input
Output
EngineeringData
FEMSetup
Material
Eigenvalue
Buckling
Engineering
Data
MatML31
Geometry
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Model
MechanicalModel
MechanicalMesh
EngineeringData
EnhancedModelData
ExternalDataSetup
GeneralTransfer
Geometry
Modeler
SolidSectionData
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
EnhancedModelData
GeneralTransfer
327

Taskgroup
Task
Input
Output
SimulationSetup
MechanicalSolution
GeneralTransfer
Solution
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Table 37: EigenValue Buckling (Samcef)

Taskgroup
Task
Input
Output
EngineeringData
FEMSetup
Material
Eigenvalue
Buckling
(Samcef )
Engineering
Data
MatML31
Geometry
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Model
MechanicalModel
MechanicalMesh
EngineeringData
EnhancedModelData
ExternalDataSetup
GeneralTransfer
Geometry
Modeler
328
Taskgroup
Task
Input
Output
SolidSectionData
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
GeneralTransfer
Solution
SimulationSetup
MechanicalSolution
GeneralTransfer
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Table 38: Magnetostatic

Taskgroup
Task
Input
Output
EngineeringData
FEMSetup
Material
Magnetostatic
Engineering
Data
MatML31
Geometry
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Model
MechanicalModel
MechanicalMesh
EngineeringData
EnhancedModelData
ExternalDataSetup
GeneralTransfer
329

Taskgroup
Task
Input
Output
Geometry
Modeler
SolidSectionData
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
GeneralTransfer
Solution
SimulationSetup
MechanicalSolution
GeneralTransfer
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Table 39: Feedback Iterator

Taskgroup
Task
Input
Output
FeedbackIteratorSetup
FeedbackIteratorEntity
Input
Output
MechanicalSetup
None
Feedback
Iterator
Feedback
Iterator
Table 40: Mechanical APDL

Taskgroup
Task
Mechanical
APDL
Analysis
FEMSetup
Geometry
SolidSectionData
MechanicalSolution
MAPDLSolution
MAPDLDatabase
330
Taskgroup
Task
Input
Output
MAPDLResults
MAPDLCdb
Table 41: Mechanical Model
Taskgroup
Task
Input
Output
EngineeringData
FEMSetup
Material
Mechanical
Model
Engineering
Data
MatML31
Geometry
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Model
MechanicalModel
MechanicalMesh
EngineeringData
EnhancedModelData
ExternalDataSetup
GeneralTransfer
Geometry
Modeler
SolidSectionData
Table 42: Mesh
Taskgroup
Task
Input
Output
FEMSetup
Geometry
Mesh
Geometry
331

Taskgroup
Task
Input
Output
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Mesh
Geometry
MechanicalModel
MeshingMesh
Table 43: Microsoft Office Excel
Taskgroup
Task
Input
Output
None
MSExcelSetup
Input
Output
EngineeringData
FEMSetup
Material
Microsoft
Office
Excel
Analysis
Table 44: Modal (ABAQUS)

Taskgroup
Task
Modal
(ABAQUS)
Engineering
Data
MatML31
Geometry
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Model
MechanicalModel
MechanicalMesh
EngineeringData
EnhancedModelData
ExternalDataSetup
332
Taskgroup
Task
Input
Output
GeneralTransfer
Geometry
Modeler
SolidSectionData
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
GeneralTransfer
Solution
SimulationSetup
MechanicalSolution
GeneralTransfer
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Table 45: Modal

Taskgroup
Task
Input
Output
EngineeringData
FEMSetup
Material
Modal
Engineering
Data
MatML31
Geometry
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Model
333

Taskgroup
Task
Input
Output
EngineeringData
EnhancedModelData
MechanicalModel
ExternalDataSetup
MechanicalMesh
GeneralTransfer
Geometry
Modeler
SolidSectionData
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
EnhancedModelData
GeneralTransfer
Solution
SimulationSetup
MechanicalSolution
GeneralTransfer
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Table 46: Modal (NASTRAN)

Taskgroup
Task
Input
Output
EngineeringData
FEMSetup
Material
Modal
(NASTRAN)
Engineering
Data
MatML31
Geometry
334
Taskgroup
Task
Input
Output
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Model
MechanicalModel
MechanicalMesh
EngineeringData
EnhancedModelData
ExternalDataSetup
GeneralTransfer
Geometry
Modeler
SolidSectionData
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
GeneralTransfer
Solution
SimulationSetup
MechanicalSolution
GeneralTransfer
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Table 47: Modal (Samcef)

Taskgroup
Task
Input
Output
Modal
(Samcef )
Engineering
Data
335

Taskgroup
Task
Input
Output
EngineeringData
FEMSetup
Material
MatML31
Geometry
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Model
MechanicalModel
MechanicalMesh
EngineeringData
EnhancedModelData
ExternalDataSetup
GeneralTransfer
Geometry
Modeler
SolidSectionData
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
GeneralTransfer
Solution
SimulationSetup
MechanicalSolution
GeneralTransfer
SimulationSolution
Results
SimulationSolution
336
MechanicalResults
Taskgroup
Task
Input
Output
SimulationResults
Table 48: Parameters Correlation

Taskgroup
Task
Input
Output
ResponseSurfaceDataTransfer
CorrelationModel
Parameters
Correlation
Parameters
Correlation
Table 49: Polyflow Blow Molding
Taskgroup
Task
Input
Output
PolyflowSetup
Polyflow
Blow
Molding
Setup
Solution
PolyflowSetup
PolyflowSolution
PolyflowSolution
ExternalDataSetup
Table 50: Polyflow Extrusion

Taskgroup
Task
Input
Output
PolyflowSetup
Polyflow
Extrusion
Setup
Solution
PolyflowSetup
PolyflowSolution
PolyflowSolution
ExternalDataSetup
Table 51: Polyflow

Taskgroup
Task
Input
Output
Polyflow
337

Taskgroup
Task
Input
Output
PolyflowSetup
Setup
Solution
PolyflowSetup
PolyflowSolution
PolyflowSolution
ExternalDataSetup
Table 52: Random Vibration

Taskgroup
Task
Input
Output
EngineeringData
FEMSetup
Material
Random
Vibration
Engineering
Data
MatML31
Geometry
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Model
MechanicalModel
EngineeringData
MechanicalMesh
EnhancedModelData
ExternalDataSetup
GeneralTransfer
Geometry
Modeler
SolidSectionData
Setup
338
Taskgroup
Task
Input
Output
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
EnhancedModelData
GeneralTransfer
Solution
SimulationSetup
MechanicalSolution
GeneralTransfer
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Table 53: Response Spectrum

Taskgroup
Task
Input
Output
EngineeringData
FEMSetup
Material
Response
Spectrum
Engineering
Data
MatML31
Geometry
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Model
MechanicalModel
EngineeringData
MechanicalMesh
EnhancedModelData
ExternalDataSetup
GeneralTransfer
Geometry
339

Taskgroup
Task
Input
Output
Modeler
SolidSectionData
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
EnhancedModelData
GeneralTransfer
Solution
SimulationSetup
MechanicalSolution
GeneralTransfer
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Table 54: Response Surface

Taskgroup
Task
Input
Output
None
ParametricContext
Response
Surface
Design of
Experiments
DOEModel
Response
Surface
340
ParametricContext
ResponseSurfaceModel
DOEModel
Taskgroup
Task
Input
Output
Table 55: Response Surface Optimization

Taskgroup
Task
Input
Output
None
ParametricContext
Response
Surface
Optimization
Design of
Experiments
DOEModel
Response
Surface
ParametricContext
DOEModel
Optimization
ParametricContext
OptimizationModel
Table 56: Results
Taskgroup
Task
Input
Output
CFXSolution
CFDAnalysis
Results
Results
FluentSolution
ForteSolution
VistaTFSolution
IcePakResults
MechanicalSolution
ICEData
Table 57: Rigid Dynamics
Taskgroup
Task
Input
Output
Rigid
Dynamics
Engineering
Data
341

Taskgroup
Task
Input
Output
FEMSetup
EngineeringData
MatML31
Material
FEMSetup
Geometry
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Model
MechanicalModel
MechanicalMesh
EngineeringData
EnhancedModelData
ExternalDataSetup
GeneralTransfer
Geometry
Modeler
SolidSectionData
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
GeneralTransfer
Solution
SimulationSetup
MechanicalSolution
GeneralTransfer
SimulationSolution
Results
SimulationSolution
342
MechanicalResults
Taskgroup
Task
Input
Output
SimulationResults
Table 58: Shape Optimization

Taskgroup
Task
Input
Output
EngineeringData
FEMSetup
Material
Shape
Optimization
Engineering
Data
MatML31
Geometry
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Model
MechanicalModel
MechanicalMesh
EngineeringData
EnhancedModelData
ExternalDataSetup
GeneralTransfer
Geometry
Modeler
SolidSectionData
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
CFXSolution
FluentSolution
IcePakResults
343

Taskgroup
Task
Input
Output
MechanicalSolution
GeneralTransfer
Solution
SimulationSetup
MechanicalSolution
GeneralTransfer
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Table 59: Six Sigma Analysis

Taskgroup
Task
Input
Output
Six
Sigma
Analysis
Design of
Experiments
(SSA)
ParametricContext
DOEModel
Response
Surface
(SSA)
ParametricContext
DOEModel
Six
Sigma
Analysis
ParametricContext
SixSigmaModel
Table 60: Static Structural (ABAQUS)
Taskgroup
Task
Input
Output
Static
Structural
(ABAQUS)
Engineering
Data
344
Taskgroup
Task
Input
Output
FEMSetup
EngineeringData
MatML31
Material
FEMSetup
Geometry
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Model
MechanicalModel
MechanicalMesh
EngineeringData
EnhancedModelData
ExternalDataSetup
Geometry
GeneralTransfer
Modeler
SolidSectionData
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
CFXSolution
FluentSolution
IcePakResults
MechanicalSolution
ExternalDataSetup
GeneralTransfer
Solution
SimulationSetup
MechanicalSolution
GeneralTransfer
SimulationSolution
345

Taskgroup
Task
Input
Output
SimulationSolution
MechanicalResults
Results
SimulationResults
Table 61: Static Structural
Taskgroup
Task
Input
Output
EngineeringData
FEMSetup
Material
Static
Structural
Engineering
Data
MatML31
Geometry
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Model
MechanicalModel
MechanicalMesh
EngineeringData
EnhancedModelData
ExternalDataSetup
GeneralTransfer
Geometry
Modeler
SolidSectionData
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
EnhancedModelData
346
Taskgroup
Task
Input
Output
CFXSolution
FluentSolution
IcePakResults
MechanicalSolution
ExternalDataSetup
AnsoftForceDataObject
GeneralTransfer
Solution
SimulationSetup
MechanicalSolution
GeneralTransfer
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Table 62: Static Structural (Samcef)

Taskgroup
Task
Input
Output
EngineeringData
FEMSetup
Material
Static
Structural
(Samcef )
Engineering
Data
MatML31
Geometry
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Model
MechanicalModel
MechanicalMesh
EngineeringData
EnhancedModelData
347

Taskgroup
Task
Input
Output
ExternalDataSetup
GeneralTransfer
Geometry
Modeler
SolidSectionData
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
CFXSolution
FluentSolution
IcePakResults
MechanicalSolution
ExternalDataSetup
GeneralTransfer
Solution
SimulationSetup
MechanicalSolution
GeneralTransfer
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Table 63: Steady-State Thermal (ABAQUS)

Taskgroup
Task
Input
Output
Steady-State
Thermal
(ABAQUS)
Engineering
Data
348
FEMSetup
EngineeringData
MatML31
Material
Taskgroup
Task
Input
Output
FEMSetup
Geometry
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Model
MechanicalModel
MechanicalMesh
EngineeringData
EnhancedModelData
ExternalDataSetup
GeneralTransfer
Geometry
Modeler
SolidSectionData
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
FluentSolution
IcePakResults
MechanicalSolution
CFXSolution
ExternalDataSetup
GeneralTransfer
Solution
SimulationSetup
MechanicalSolution
GeneralTransfer
SimulationSolution
Results
SimulationSolution
MechanicalResults
349

Taskgroup
Task
Input
Output
SimulationResults
Table 64: Steady-State Thermal

Taskgroup
Task
Input
Output
EngineeringData
FEMSetup
Material
Steady-State
Thermal
Engineering
Data
MatML31
Geometry
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Model
MechanicalModel
MechanicalMesh
EngineeringData
EnhancedModelData
ExternalDataSetup
GeneralTransfer
Geometry
Modeler
SolidSectionData
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
CFXSolution
FluentSolution
IcePakResults
350
Taskgroup
Task
Input
Output
MechanicalSolution
ExternalDataSetup
GeneralTransfer
Solution
SimulationSetup
MechanicalSolution
GeneralTransfer
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Table 65: Steady-State Thermal (Samcef)

Taskgroup
Task
Input
Output
EngineeringData
FEMSetup
Material
Steady-State
Thermal
Engineering
Data
MatML31
Geometry
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Model
MechanicalModel
MechanicalMesh
EngineeringData
EnhancedModelData
ExternalDataSetup
Geometry
GeneralTransfer
Modeler
351

Taskgroup
Task
Input
Output
SolidSectionData
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
CFXSolution
FluentSolution
IcePakResults
MechanicalSolution
ExternalDataSetup
GeneralTransfer
Solution
SimulationSetup
MechanicalSolution
GeneralTransfer
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Table 66: System Coupling

Taskgroup
Task
Input
Output
CouplingSetupProvider
System
Coupling
Setup
ExternalDataSetup
Solution
None
Input
Output
Table 67: Thermal-Electric

Taskgroup
Task
Thermal-Electric
Engineering
Data
352
Taskgroup
Task
Input
Output
EngineeringData
FEMSetup
Material
MatML31
Geometry
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Model
MechanicalModel
MechanicalMesh
EngineeringData
EnhancedModelData
ExternalDataSetup
Geometry
GeneralTransfer
Modeler
SolidSectionData
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
CFXSolution
FluentSolution
IcePakResults
ExternalDataSetup
GeneralTransfer
Solution
SimulationSetup
MechanicalSolution
GeneralTransfer
SimulationSolution
Results
353

Taskgroup
Task
Input
Output
SimulationSolution
MechanicalResults
SimulationResults
Table 68: Throughflow

Taskgroup
Task
Input
Output
FEMSetup
Geometry
Throughflow
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Setup
VistaGeometry
VistaTFSetup
VistaTFPhysics
Geometry
Solution
VistaTFSetup
VistaTFSolution
VistaTFSolution
Results
CFXSolution
CFDAnalysis
FluentSolution
ForteSolution
VistaTFSolution
IcePakResults
MechanicalSolution
ICEData
Table 69: Throughflow (BladeGen)
Taskgroup
Task
Input
Output
None
TurboGeometry
Throughflow
(BladeGen)
Blade
Design
VistaGeometry
Setup
VistaGeometry
354
VistaTFSetup
Taskgroup
Task
Input
Output
VistaTFPhysics
Geometry
Solution
VistaTFSetup
VistaTFSolution
VistaTFSolution
Results
CFXSolution
CFDAnalysis
FluentSolution
ForteSolution
VistaTFSolution
IcePakResults
MechanicalSolution
ICEData
Table 70: Transient Structural (ABAQUS)
Taskgroup
Task
Input
Output
EngineeringData
FEMSetup
Material
Transient
Structural
(ABAQUS)
Engineering
Data
MatML31
Geometry
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Model
MechanicalModel
MechanicalMesh
EngineeringData
EnhancedModelData
ExternalDataSetup
355

Taskgroup
Task
Input
Output
Geometry
GeneralTransfer
Modeler
SolidSectionData
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
CFXSolution
FluentSolution
IcePakResults
MechanicalSolution
ExternalDataSetup
GeneralTransfer
Solution
SimulationSetup
MechanicalSolution
GeneralTransfer
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Table 71: Transient Structural

Taskgroup
Task
Input
Output
Transient
Structural
Engineering
Data
FEMSetup
EngineeringData
MatML31
Material
FEMSetup
Geometry
Geometry
TurboGeometry
AnsoftCADObject
356
Taskgroup
Task
Input
Output
ICEData
Geometry
Model
MechanicalModel
MechanicalMesh
EngineeringData
EnhancedModelData
ExternalDataSetup
GeneralTransfer
Geometry
Modeler
SolidSectionData
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
EnhancedModelData
CFXSolution
FluentSolution
IcePakResults
MechanicalSolution
ExternalDataSetup
GeneralTransfer
Solution
SimulationSetup
MechanicalSolution
GeneralTransfer
SimulationSolution
Results
SimulationSolution
MechanicalResults
357

Taskgroup
Task
Input
Output
SimulationResults
Table 72: Transient Structural (Samcef)

Taskgroup
Task
Input
Output
FEMSetup
EngineeringData
MatML31
Material
FEMSetup
Geometry
Transient
Structural
(Samcef )
Engineering
Data
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Model
MechanicalModel
MechanicalMesh
EngineeringData
EnhancedModelData
ExternalDataSetup
GeneralTransfer
Geometry
Modeler
SolidSectionData
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
CFXSolution
FluentSolution
IcePakResults
358
Taskgroup
Task
Input
Output
MechanicalSolution
ExternalDataSetup
GeneralTransfer
Solution
SimulationSetup
MechanicalSolution
GeneralTransfer
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Table 73: Transient Thermal (ABAQUS)

Taskgroup
Task
Input
Output
Material
FEMSetup
EngineeringData
Transient
Thermal
(ABAQUS)
Engineering
Data
MatML31
Geometry
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Model
MechanicalModel
MechanicalMesh
EngineeringData
EnhancedModelData
ExternalDataSetup
GeneralTransfer
Geometry
Modeler
359

Taskgroup
Task
Input
Output
SolidSectionData
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
CFXSolution
FluentSolution
IcePakResults
MechanicalSolution
ExternalDataSetup
GeneralTransfer
Solution
SimulationSetup
MechanicalSolution
GeneralTransfer
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Table 74: Transient Thermal

Taskgroup
Task
Input
Output
Material
FEMSetup
EngineeringData
Transient
Thermal
Engineering
Data
MatML31
Geometry
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Model
360
MechanicalModel
Taskgroup
Task
Input
Output
MechanicalMesh
EngineeringData
EnhancedModelData
ExternalDataSetup
GeneralTransfer
Geometry
Modeler
SolidSectionData
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
CFXSolution
FluentSolution
IcePakResults
MechanicalSolution
ExternalDataSetup
GeneralTransfer
Solution
SimulationSetup
MechanicalSolution
GeneralTransfer
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Table 75: Transient Thermal (Samcef)

Taskgroup
Task
Input
Output
Transient
Thermal
(Samcef )
361

Taskgroup
Task
Input
Output
Material
FEMSetup
EngineeringData
Engineering
Data
MatML31
Geometry
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Model
MechanicalModel
MechanicalMesh
EngineeringData
EnhancedModelData
ExternalDataSetup
GeneralTransfer
Geometry
Modeler
SolidSectionData
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
CFXSolution
FluentSolution
IcePakResults
MechanicalSolution
ExternalDataSetup
GeneralTransfer
Solution
362
SimulationSetup
MechanicalSolution
GeneralTransfer
Taskgroup
Task
Input
Output
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Table 76: Turbomachinery Fluid Flow (BladeEditor)

Taskgroup
Task
Input
Output
FEMSetup
Geometry
Turbomachinery
Fluid
Flow
(BladeEditor)
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Geometry
Turbo
Mesh
TurboGeometry
TurboMesh
Geometry
CFXMesh
FluentImportable
Setup
CFXSetup
CFXMesh
MechanicalSetup
Solution
CFXSetup
CFXSolution
CFXSolution
Results
CFXSolution
CFDAnalysis
FluentSolution
ForteSolution
VistaTFSolution
IcePakResults
MechanicalSolution
363

Taskgroup
Task
Input
Output
ICEData
Table 77: TurboGrid
Taskgroup
Task
Input
Output
TurboGeometry
TurboMesh
Geometry
CFXMesh
TurboGrid
Turbo
Mesh
FluentImportable
Table 78: Vista TF
Taskgroup
Task
Input
Output
VistaGeometry
VistaTFSetup
Vista
TF
Setup
VistaTFPhysics
Geometry
Solution
VistaTFSetup
VistaTFSolution
VistaTFSolution
Results
CFXSolution
CFDAnalysis
FluentSolution
ForteSolution
VistaTFSolution
IcePakResults
MechanicalSolution
ICEData
Table 79: Vista AFD
Taskgroup
Task
Input
Output
None
VistaAFDMeanlineProvider
VistaAFDDesignProvider
Vista
AFD
Meanline
Design
364
Taskgroup
Task
Input
Output
None
Input
Output
None
VistaCCDBladeDesignProvider
Analysis
Table 80: Vista CCD

Taskgroup
Task
Vista
CCD
Blade
Design
Table 81: Vista CCD (with CCM)

Taskgroup
Task
Input
Output
None
None
Input
Output
None
None
Input
Output
Vista
CCD
(with
CCM)
Blade
Design
Performance
Map
Table 82: Vista CPD

Taskgroup
Task
Vista
CPD
Blade
Design
Table 83: Vista RTD

Taskgroup
Task
Vista
RTD
Blade
Design
365

Taskgroup
Task
Input
Output
None
None
Input
Output
None
VistaGeometry
Table 84: Vista RTD (Beta)

Taskgroup
Task
Vista
RTD
(Beta)
Blade
Design
VistaTFPhysics
Table 85: ACP (Pre)
Taskgroup
Task
Input
Output
EngineeringData
FEMSetup
Material
ACP
(Pre)
Engineering
Data
MatML31
Geometry
AnsoftCADObject
Geometry
FEMSetup
Geometry
ICEData
TurboGeometry
Model
MechanicalMesh
MechanicalModel
EngineeringData
SimulationEngineering Data
EnhancedModelData
SimulationGenerated Mesh
ExternalDataSetup
SimulationModelGenerated Mesh
GeneralTransfer
Geometry
Modeler
366
Taskgroup
Task
Input
Output
SolidSectionData
Setup
ACPSetupData
ACPSetupData
EngineeringData
CompositeEngineering Data
Geometry
EnhancedModelData
SolidSectionData
Input
Output
EngineeringData
FEMSetup
Material
Table 86: ACP (Post)

Taskgroup
Task
ACP
(Post)
Engineering
Data
MatML31
Geometry
AnsoftCADObject
Geometry
FEMSetup
Geometry
ICEData
TurboGeometry
Model
MechanicalMesh
MechanicalModel
EngineeringData
SimulationEngineering Data
EnhancedModelData
SimulationGenerated Mesh
ExternalDataSetup
SimulationModelGenerated Mesh
GeneralTransfer
Geometry
Modeler
SimulationModelGenerated
Mesh
367

Taskgroup
Task
Input
Output
SolidSectionData
Results
EngineeringData
MAPDLSolution
MechanicalSolution
Table 87: Maxwell 3D
Taskgroup
Task
Input
Output
AnsoftCADGeometryEntity
AnsoftCADObject
AnsoftGeometryManagerData
Object
AnsoftCellInOutEntity
Geometry
AnsoftGeometryManager
DataObject
Maxwell
3D
Geometry
Setup
Solution
AnsoftForceAndMoment
DataObject
AnsoftHeatLossData Object
Table 88: Maxwell 2D

Taskgroup
Task
Input
Output
AnsoftCADGeometryEntity
AnsoftCADObject
AnsoftGeometryManagerData
Object
Geometry
AnsoftGeometryManager
DataObject
Maxwell
2D
Geometry
Setup
Solution
368
Taskgroup
Task
Input
Output
AnsoftForceAndMoment
DataObject
AnsoftHeatLossData Object
Table 89: RMxprt

RMxprt
Setup
Solution
Table 90: Simplorer
Simplorer
Setup
MechanicalSetup
Solution
Table 91: FeedbackIterator
Taskgroup
Task
Input
Output
FeedbackIterator
Feedback
Iterator
Table 92: Turbo Setup

Turbo
Setup
Turbo
Setup
Table 93: Turbo Machinery Fluid Flow (Bladegen) (Beta)
Taskgroup
Task
Input
Output
Turbomachinery
Fluid
Flow
(BladeGen)
(Beta)
Blade
Design
TurboGeometry
369

Taskgroup
Task
Input
Output
VistaGeometry
Turbo
Mesh
Geometry
CFXMesh
TurboGeometry
FluentImportable
TurboMesh
Setup
CFXMesh
CFXSetup
MechanicalSetup
SystemCouplingSetup Data
Solution
CFXSetup
CFXSolution
CFXSolution
Results
CFXSolution
CFDAnalysis
FluentSolution
ForteSolution
ICEData
IcePakResults
MechanicalSolution
VistaTFSolution
Table 94: Turbo Machinery Fluid Flow
Taskgroup
Task
Input
Output
Geometry
CFXMesh
TurboGeometry
FluentImportable
Turbomachinery
Fluid
Flow
Turbo
Mesh
TurboMesh
Setup
CFXMesh
CFXSetup
MechanicalSetup
SystemCouplingSetup Data
Solution
CFXSetup
CFXSolution
CFXSolution
370
Taskgroup
Task
Input
Output
CFXSolution
CFDAnalysis
Results
FluentSolution
ForteSolution
ICEData
IcePakResults
MechanicalSolution
VistaTFSolution
371
372
Appendix B. ANSYS Workbench Internally Defined System Template

and Component Names
Table 95: ACP (Pre)
Component Name
Component Display Name
EngDataCellTemplate
Engineering Data
Geometry
SimulationModelCellTemplate
Model
ACPSetupCellTemplate
Setup
Table 96: ACP (Post)

Component Name
EngDataCellTemplate
Engineering Data
Geometry
Model
ACPResultsCellTemplate
Results
Table 97: Feedback Iterator

Component Name
FeedbackIteratorComponentTemplate
Feedback Iterator
Table 98: Mechanical APDL

Component Name
ANSYSSetupCellTemplate
Analysis
Table 99: Hydrodynamic Diffraction

Component Name
Geometry
AQWAModelCellTemplate
Model
AQWASetupHDCellTemplate
Setup
AQWAAnalysisCellTemplate
Solution
AQWAResultsCellTemplate
Results
Table 100: Hydrodynamic Response

Component Name
Geometry
373
ANSYS Workbench Internally Defined System Template and Component Names

Component Name
AQWAModelCellTemplate
Model
AQWASetupHDCellTemplate
Setup
AQWAAnalysisCellTemplate
Solution
AQWAResultsCellTemplate
Results
Table 101: Autodyn

Component Name
AUTODYN_Solution
Setup
AUTODYN_Results
Analysis
Table 102: Results

Component Name
CFDPostTemplate
Results
Table 103: CFX

Component Name
CFXPhysicsTemplate
Setup
CFXResultsTemplate
Solution
CFDPostTemplate
Results
Table 104: Fluid Flow (CFX)

Component Name
Geometry
SimulationMeshingModelCellTemplate
Mesh
CFXPhysicsTemplate
Setup
CFXResultsTemplate
Solution
CFDPostTemplate
Results
Table 105: CFX (Beta)

Component Name
CFXPhysicsTemplate
Setup
CFXResultsTemplate
Solution
Table 106: Response Surface Optimization

Component Name
DXDOECellTemplate
DXResponseSurfaceCellTemplate
Response Surface
374
Component Name
DXOptimizationCellTemplate_GDO
Optimization
Table 107: Response Surface Optimization -Demo

Component Name
DXDemoDOECellTemplate
Response Surface
DXOptimizationCellTemplate_GDO
Optimization
Table 108: Parameters Correlation

Component Name
DXCorrelationCellTemplate
DXCorrelationCellTemplate
Table 109: Direct Optimization

Component Name
DXDirectOptimizationCellTemplate
Optimization
Table 110: Response Surface

Component Name
DXDOECellTemplate
Response Surface
Table 111: Six Sigma Analysis

Component Name
DXDOECellForSixSigmaTemplate
Design of Experiments (SSA)
DXResponseSurfaceCellForSixSigmaTemplate
Response Surface (SSA)
375

Component Name
DXSixSigmaCellTemplate
Six Sigma Analysis
Table 112: External Connection

Component Name
ExternalConnectionTemplate
External Connection
Table 113: External Data

Component Name
ExternalLoadSetupCellTemplate
Setup
Table 114: External Model

Component Name
ExternalModelSetupCellTemplate
Setup
Table 115: Fluent (with Fluent Meshing)

Component Name
FluentTGridCellTemplate
Mesh
FluentSetupCellTemplate
Setup
FluentResultsCellTemplate
Solution
Table 116: Fluent

Component Name
Setup
Solution
Table 117: Fluid Flow (Fluent)

Component Name
Geometry
Mesh
Setup
Solution
CFDPostTemplate
Results
Table 118: ICEM CFD

Component Name
ICEMCFD
Model
Table 119: IC Engine (Fluent)

Component Name
ICEComponentTemplate
ICE
376
Component Name
Geometry
Mesh
ICESetupComponentTemplate
ICE Setup
Setup
Solution
CFDPostTemplate
Results
Table 120: IC Engine (Forte)

Component Name
ICEComponentTemplate
ICE
Geometry
Mesh
ICESetupComponentTemplate
ICE Setup
CFDPostTemplate
Results
Table 121: Icepak

Component Name
IcePakSetupCellTemplate
Setup
IcePakSolutionCellTemplate
Solution
Table 122: Mechanical Model

Component Name
EngDataCellTemplate
Engineering Data
Geometry
Model
Table 123: Electric

Component Name
Component Display
Name
EngDataCellTemplate
Engineering Data
Geometry
Model
SimulationSetupCellTemplate_ElectricStaticANSYS
Setup
SimulationSolutionCellTemplate_ElectricStaticANSYS
Solution
SimulationResultsCellTemplate_ElectricStaticANSYS
Results
Table 124: Eigenvalue Buckling

Component Name
Component Display
Name
EngDataCellTemplate
Engineering Data
377

Component Name
Component Display
Name
Geometry
Model
SimulationSetupCellTemplate_StructuralBucklingANSYS
Setup
SimulationSolutionCellTemplate_StructuralBucklingANSYS
Solution
SimulationResultsCellTemplate_StructuralBucklingANSYS
Results
Table 125: Eigenvalue Buckling (Samcef)

Component Name
Component Display
Name
EngDataCellTemplate
Engineering Data
Geometry
Model
SimulationSetupCellTemplate_StructuralBucklingSamcef
Setup
SimulationSolutionCellTemplate_StructuralBucklingSamcef
Solution
SimulationResultsCellTemplate_StructuralBucklingSamcef
Results
Table 126: Magnetostatic

Component Name
Component Display
Name
EngDataCellTemplate
Engineering Data
Geometry
Model
SimulationSetupCellTemplate_ElectromagneticsMagnetostaticsANSYS
Setup
SimulationSolutionCellTemplate_ElectromagneticsMagnetostaticsANSYS
Solution
SimulationResultsCellTemplate_ElectromagneticsMagnetostaticsANSYS
Results
Table 127: Modal

Component Name
Component Display
Name
EngDataCellTemplate
Engineering Data
Geometry
Model
SimulationSetupCellTemplate_StructuralModalANSYS
Setup
SimulationSolutionCellTemplate_StructuralModalANSYS
Solution
SimulationResultsCellTemplate_StructuralModalANSYS
Results
Table 128: Modal (Samcef)

Component Name
EngDataCellTemplate
Engineering Data
378
Component Name
Geometry
Model
SimulationSetupCellTemplate_StructuralModalSamcef
Setup
SimulationSolutionCellTemplate_StructuralModalSamcef
Solution
SimulationResultsCellTemplate_StructuralModalSamcef
Results
Table 129: Modal (NASTRAN) (Beta)

Component Name
EngDataCellTemplate
Engineering Data
Geometry
Model
SimulationSetupCellTemplate_StructuralModalNASTRAN
Setup
SimulationSolutionCellTemplate_StructuralModalNASTRAN Solution
SimulationResultsCellTemplate_StructuralModalNASTRAN Results
Table 130: Modal (ABAQUS)
Component Name
EngDataCellTemplate
Engineering Data
Geometry
Model
SimulationSetupCellTemplate_StructuralModalABAQUS
Setup
SimulationSolutionCellTemplate_StructuralModalABAQUS
Solution
SimulationResultsCellTemplate_StructuralModalABAQUS
Results
Table 131: Random Vibration

Component Name
Component Display
Name
EngDataCellTemplate
Engineering Data
Geometry
Model
SimulationSetupCellTemplate_StructuralRandomVibrationANSYS
Setup
SimulationSolutionCellTemplate_StructuralRandomVibrationANSYS
Solution
SimulationResultsCellTemplate_StructuralRandomVibrationANSYS
Results
Table 132: Response Spectrum

Component Name
EngDataCellTemplate
Engineering Data
Geometry
Model
379

Component Name
SimulationSetupCellTemplate_StructuralResponseSpectrumANSYS
Setup
SimulationSolutionCellTemplate_StructuralResponseSpectrumANSYS Solution
SimulationResultsCellTemplate_StructuralResponseSpectrumANSYS Results
Table 133: Topological Optimization (Beta)
Component Name
EngDataCellTemplate
Engineering Data
Geometry
Model
SimulationSetupCellTemplate_StructuralShapeOptimizationANSYS
Setup
SimulationSolutionCellTemplate_StructuralShapeOptimizationANSYS Solution
SimulationResultsCellTemplate_StructuralShapeOptimizationANSYS Results
Table 134: Shape Optimization (Beta)
Component Name
EngDataCellTemplate
Engineering Data
Geometry
Model
SimulationSetupCellTemplate_StructuralShapeOptimizationANSYS
Setup
SimulationSolutionCellTemplate_StructuralShapeOptimizationANSYS Solution
SimulationResultsCellTemplate_StructuralShapeOptimizationANSYS Results
Table 135: Static Structural
Component Name
EngDataCellTemplate
Engineering Data
Geometry
Model
SimulationSetupCellTemplate_StructuralStaticANSYS
Setup
SimulationSolutionCellTemplate_StructuralStaticANSY
S
Solution
SimulationResultsCellTemplate_StructuralStaticANSYS
Results
Table 136: Static Structural (ABAQUS)

Component Name
EngDataCellTemplate
Engineering Data
Geometry
Model
SimulationSetupCellTemplate_StructuralStaticABAQUS
Setup
SimulationSolutionCellTemplate_StructuralStaticABAQUS
Solution
380
Component Name
SimulationResultsCellTemplate_StructuralStaticABAQUS
Results
Table 137: Static Structural (Samcef)

Component Name
EngDataCellTemplate
Engineering Data
Geometry
Model
SimulationSetupCellTemplate_StructuralStaticSamcef
Setup
SimulationSolutionCellTemplate_StructuralStaticSamcef
Solution
SimulationResultsCellTemplate_StructuralStaticSamcef
Results
Table 138: Steady-State Thermal

Component Name
EngDataCellTemplate
Engineering Data
Geometry
Model
SimulationSetupCellTemplate_ThermalSteadyStateANSYS
Setup
SimulationSolutionCellTemplate_ThermalSteadyStateANSYS
Solution
SimulationResultsCellTemplate_ThermalSteadyStateANSYS
Results
Table 139: Steady-State Thermal (Samcef)

Component Name
EngDataCellTemplate
Engineering Data
Geometry
Model
SimulationSetupCellTemplate_ThermalSteadyStateSamcef
Setup
SimulationSolutionCellTemplate_ThermalSteadyStateSamcef
Solution
SimulationResultsCellTemplate_ThermalSteadyStateSamcef
Results
Table 140: Steady-State Thermal (ABAQUS)

Component Name
EngDataCellTemplate
Engineering Data
Geometry
Model
SimulationSetupCellTemplate_ThermalSteadyStateABAQUS
Setup
SimulationSolutionCellTemplate_ThermalSteadyStateABAQUS
Solution
381

Component Name
SimulationResultsCellTemplate_ThermalSteadyStateABAQUS
Results
Table 141: Transient Structural (ABAQUS)

Component Name
EngDataCellTemplate
Engineering Data
Geometry
Model
SimulationSetupCellTemplate_StructuralTransientABAQUS
Setup
SimulationSolutionCellTemplate_StructuralTransientABAQUS
Solution
SimulationResultsCellTemplate_StructuralTransientABAQUS
Results
Table 142: Transient Structural (Samcef)

Component Name
EngDataCellTemplate
Engineering Data
Geometry
Model
SimulationSetupCellTemplate_StructuralTransientSamcef
Setup
SimulationSolutionCellTemplate_StructuralTransientSamcef
Solution
SimulationResultsCellTemplate_StructuralTransientSamcef
Results
Table 143: Transient Structural

Component Name
EngDataCellTemplate
Engineering Data
Geometry
Model
SimulationSetupCellTemplate_StructuralTransientANSYS
Setup
SimulationSolutionCellTemplate_StructuralTransientANSYS
Solution
SimulationResultsCellTemplate_StructuralTransientANSYS
Results
Table 144: Rigid Dynamics

Component Name
EngDataCellTemplate
Engineering Data
Geometry
Model
SimulationSetupCellTemplate_StructuralTransientRBD
Setup
SimulationSolutionCellTemplate_StructuralTransientRBD
Solution
382
Component Name
SimulationResultsCellTemplate_StructuralTransientRBD
Results
Table 145: Explicit Dynamics

Component Name
EngDataCellTemplate
Engineering Data
Geometry
Model
SimulationSetupCellTemplate_StructuralExplicitAUTODYN
Setup
SimulationSolutionCellTemplate_StructuralExplicitAUTODYN
Solution
SimulationResultsCellTemplate_StructuralExplicitAUTODYN
Results
Table 146: Thermal-Electric

Component Name
EngDataCellTemplate
Engineering Data
Geometry
Model
SimulationSetupCellTemplate_ThermalElectromagneticsStaticANSYS Setup
SimulationSolutionCellTemplate_ThermalElectromagneticsStaticANSYSSolution
SimulationResultsCellTemplate_ThermalElectromagneticsStaticANSYS Results
Table 147: Explicit Dynamics (LS-DYNA Export)
Component Name
EngDataCellTemplate
Engineering Data
Geometry
Model
SimulationSetupCellTemplate_StructuralExplicitLSDYNA
Setup
Table 148: Transient Thermal

Component Name
EngDataCellTemplate
Engineering Data
Geometry
Model
SimulationSetupCellTemplate_ThermalTransientANSYS
Setup
SimulationSolutionCellTemplate_ThermalTransientANSYS
Solution
SimulationResultsCellTemplate_ThermalTransientANSY
S
Results
Table 149: Transient Thermal (ABAQUS)

Component Name
EngDataCellTemplate
Engineering Data
383

Component Name
Geometry
Model
SimulationSetupCellTemplate_ThermalTransientABAQUS
Setup
SimulationSolutionCellTemplate_ThermalTransientABAQUS
Solution
SimulationResultsCellTemplate_ThermalTransientABAQUS
Results
Table 150: Transient Thermal (Samcef)

Component Name
EngDataCellTemplate
Engineering Data
Geometry
Model
SimulationSetupCellTemplate_ThermalTransientSamcef
Setup
SimulationSolutionCellTemplate_ThermalTransientSamcef
Solution
SimulationResultsCellTemplate_ThermalTransientSamcef
Results
Table 151: Design Assessment

Component Name
EngDataCellTemplate
Engineering Data
Geometry
Model
SimulationSetupCellTemplate_CustomizableDesignAssessmentANSYS Setup
SimulationSolutionCellTemplate_CustomizableDesignAssessmentANSYS
Solution
SimulationResultsCellTemplate_CustomizableDesignAssessmentANSYSResults
Table 152: Engineering Data
Component Name
EngDataCellTemplate
Engineering Data
Table 153: Microsoft Office Excel

Component Name
MSExcelComponentTemplate
Analysis
Table 154: System Coupling

Component Name
SystemCouplingSetupCellTemplate
Setup
SystemCouplingSolutionCellTemplate
Solution
Table 155: Polyflow

Component Name
PolyflowSetupCellTemplate
Setup
384
Component Name
PolyflowSolveCellTemplate
Solution
Table 156: Fluid Flow (Polyflow)

Component Name
Geometry
Mesh
Setup
Solution
CFDPostTemplate
Results
Table 157: Fluid Flow - Extrusion (Polyflow)

Component Name
Geometry
Mesh
Setup
Solution
CFDPostTemplate
Results
Table 158: Polyflow - Extrusion

Component Name
Setup
Solution
Table 159: Fluid Flow - Blow Molding (Polyflow)

Component Name
Geometry
Mesh
Setup
Solution
CFDPostTemplate
Results
Table 160: Polyflow - Blow Molding

Component Name
Setup
Solution
Table 161: Throughflow

Component Name
Geometry
VistaTFSetupTemplate
Setup
385

Component Name
VistaTFSolutionTemplate
Solution
CFDPostTemplate
Results
Table 162: Throughflow (BladeGen)

Component Name
TSGeometryTemplate
Blade Design
Setup
Solution
CFDPostTemplate
Results
Table 163: Vista TF

Component Name
Setup
Solution
386
Component Name
CFDPostTemplate
Results
Table 164: BladeGen

Component Name
TSGeometryTemplate
Blade Design
Table 165: BladeGen (Beta)

Component Name
TSGeometryTemplateBeta
Blade Design
Table 166: TurboGrid

Component Name
TSMeshTemplate
Turbo Mesh
Table 167: Turbo Setup

Component Name
TSSetupTemplate
Turbo Setup
Table 168: Vista RTD

Component Name
TSVistaRTDTemplate
Blade Design
Table 169: Vista RTD (Beta)

Component Name
TSVistaRTDTemplate
Blade Design
Table 170: Vista CCD

Component Name
TSVistaCCDTemplate
Blade Design
Table 171: Vista CCD (with CCM)

Component Name
TSVistaCCDTemplate
Blade Design
387

Component Name
TSVistaCCMTemplate
Performance Map
Table 172: Vista CPD

Component Name
TSVistaCPDTemplate
Blade Design
Table 173: Vista AFD

Component Name
TSVistaAFDMeanlineTemplate
Meanline
TSVistaAFDDesignTemplate
Design
TSVistaAFDAnalysisTemplate
Analysis
Table 174: Turbomachinery Fluid Flow (BladeEditor) (Beta)

Component Name
Geometry
TSMeshTemplate
Turbo Mesh
CFXPhysicsTemplate
Setup
CFXResultsTemplate
Solution
CFDPostTemplate
Results
Table 175: Turbomachinery Fluid Flow (BladeGen) (Beta)

Component Name
TSGeometryTemplate
Blade Design
TSMTSMeshTemplate
Turbo Mesh
CFXPhysicsTemplate
Setup
CFXResultsTemplate
Solution
CFDPostTemplate
Results
Table 176: Mesh

Component Name
Blade Design
Mesh
Table 177: Geometry

Component Name
Geometry
Table 178: Finite Element Modeler

Component Name
FESetupCellTemplate
Model
388
Appendix C. Data Transfer Types

Table 179: Data Transfer Types and Properties
Transfer Type
Property
ACPSetupData
ACPFileReference
ACPPreFileReference
AnsoftCADObject
AnsoftTransferXMLString
AnsoftProjectResultsFolderAtCurrentDP
MAPDLSolution
TransferFile
AuxiliaryFiles
MAPDLDatabse
TransferFile
AuxiliaryFiles
MAPDLResults
AuxiliaryFiles
MAPDLCdb
TransferFile
AuxiliaryFiles
AqwaModel
AqwaSetup
AqwaSolution
AqwaResults
389
Data Transfer Types

Transfer Type
Property
AutodynSetup
CFDAnalysis
PostStateFile
CFXSetup
CFXSolverInputFile
MAPDLSolverInputFile
CFXSolution
MResLoadOption
CFXResultsFile
AuxiliaryFiles
MAPDLResultsFile
Geometry
GeometryFilePath
PlugInName
ParametricContext
DOEModel
OptimizationModel
CorrelationModel
SixSigmaModel
EngineeringData
TransferFile
Material
ExternalConnectionProperties
ExternalDataSetup
TransferFile
TransferFile
InputFiles
SolidSectionData
TransferFile
AuxiliaryFiles
CompositeSectionFiles
EnhancedModelData
FEMMesh
390
Transfer Type
Property
ACMOFile
FEMSetup
FEModelerFile
ANSYSInputFile
ParasolidFile
FiniteElementModelMaterials
AuxiliaryFiles
FluentTGridMesh
TransferFile
FluentSetup
CaseFile
ModelInfoFile
FluentCase
MeshFile
TransferFile
FluentSolution
CaseFile
DataFile
ICEData
ICESetupData
IcePakSetup
IcePakResults
MechanicalModel
File
EdaFile
PMDBFile
ACMOFile
Mechdb
MeshingMesh
TransferFile
TransferFile
TransferFile
MSExcelSetup
391
Data Transfer Types

Transfer Type
Property
TransferFile
PolyflowSetup
DataFile
PubFile
GeneratedFiles
PolyflowSolution
MechanicalModel
MechanicalMesh
TransferFile
TransferFiles
TransferFile
SimulationSetup
MechanicalSetup
TransferFile
MechanicalSolution
SimulationSolution
MechanicalResults
SimulationResults
TurboGeometry
INFFilename
GeometryFilename
TurboMesh
FileName
CFXMesh
FileName
PreFileType
FluentImportable
MeshFile
FileType
Dimension
VistaGeometry
GeoData
TransferData
VistaTFPhysics
392
Transfer Type
Property
TransferData
TransferData
TransferData
TransferData
VistaTFSetup
ControlFilename
GeoFilename
AeroFilename
CorrelationsFilename
VistaTFSolution
ResultsFile
RestartFile
AUTODYN_Remap
MatML31
TransferFile
TransferFile
FluentMesh
TransferFile
TransferFile
ForteSetupData
DataFile
ForteSMGData
ForteSolution
ForteSolutionData
Imported FLUENT Mesh File Type
MeshFile
Modeler
GeneralTransfer
393
394
Appendix D. Addin Data Types and Data Transfer Formats

The table below lists the data types and data transfer formats supported for each addin.
Note
Where listed, a value of "n/a" indicates that you should use an empty format string.
Addin
Data Type
Format
MAPDLCdb
n/a
MAPDLDatabase
n/a
MAPDLSolution
n/a
MAPDLResults
n/a
AQWAModel
transfer not supported
AQWASetup
AQWASolution
AQWAResults
AutodynSetup
AutodynAnalysis
CFXSetup
n/a
n/a
CFXSolution
n/a
Geometry
n/a
ANSYS
AQWA
AUTODYN
CFX
DesignModeler
DX
EKM
No Output Types
Engineering
Data
Engineering Data
materials
ExternalDataSetup
ExternalDataSetup
External Load
395
Addin Data Types and Data Transfer Formats

Addin
Data Type
Format
SolidSectionData
n/a
EnhancedModelData
EnhancedModelData
ExternalModelCoupling
FEModeler
Geometry
FEMMesh
ACMOFile
FEMSetup
FacetedGeometry
ParasolidGeometry
InputFile
FiniteElementModelMaterial
Fluent
FluentTGridMesh
n/a
FluentSetup
FluentSolution
n/a
FluentMesh
ICEMCFD
Imported FLUENT Mesh FileType
CMDBMesh
PolyflowMesh
AnsysMesh
ICEngine
ICEData
ICEData
ICESetupData
n/a
ForteSolution
ForteSolutionData
ForteSMGData
ForteSetupData
n/a
IcePakSetup
IcePakResults
n/a
MechanicalModel
MeshingMesh
CMDBMesh
Forte
IcePak
Meshing
FluentMesh
396
Addin
Data Type
Format
POLYFLOWMesh
CMDBMesh
FluentMesh
POLYFLOWMesh
MeshingGeneratedMeshOutputProvider MeshingGeneratedMeshOutputProvider
MSExcel
MSExcelSetup
PolyflowSetup
n/a
PolyflowSolution
ExternalDataSetup
ExternalDataSetup
MechanicalModel
MechanicalMesh
CMDBMesh
Multiphysics
Coupling
Polyflow
Simulation
FluentMesh
POLYFLOWMesh
CMDBMesh
FluentMesh
POLYFLOWMesh
SimulationSetup
n/a
MechanicalSetup
n/a
MechanicalSolution
n/a
SimulationSolution
SimulationResults
n/a
MechanicalResults
n/a
GeneralTransfer
n/a
VistaGeometry
n/a
TurboMesh
CFXMesh
n/a
FluentImportable
n/a
VistaATFPhysics
n/a
TurboSystem
397
Addin Data Types and Data Transfer Formats

Addin
Data Type
Format
n/a
n/a
n/a
VistaTFSetup
n/a
VistaTFSolution
n/a
n/a
AnsoftGeometryDataObject
n/a
AnsoftCADObject
n/a
n/a
n/a
VistaTF
EBU (Q3D,
Maxwell, HFSS)
398
Appendix E. Pre-Installed Custom Workflow Support

Table 180: Task Groups and Tasks
Task Groups
Tasks
ACP (Pre)
Model
ACP (Post)
Model
Mechanical Model
Model
Electric
Model
Setup
Solution
Eigenvalue Buckling
Model
Setup
Solution
Eigenvalue Buckling (Samcef )
Model
Setup
Solution
Magnetostatic
Model
Setup
Solution
Modal
Model
Setup
Solution
Modal (Samcef )
Model
Setup
Solution
Modal (NASTRAN) (Beta)
Model
Setup
Solution
Modal (ABAQUS)
Model
Setup
Solution
Random Vibration
Model
Setup
Solution
Response Spectrum
Model
Setup
399
Pre-Installed Custom Workflow Support

Task Groups
Tasks
Solution
Topological Optimization (Beta)
Model
Setup
Solution
Shape Optimization (Beta)
Model
Setup
Solution
Static Structural
Model
Setup
Solution
Static Structural (ABAQUS)
Model
Setup
Solution
Static Structural (Samcef )
Model
Setup
Solution
Steady-State Thermal
Model
Setup
Solution
Steady-State Thermal (Samcef )
Model
Setup
Solution
Steady-State Thermal (ABAQUS)
Model
Setup
Solution
Transient Structural (ABAQUS)
Model
Setup
Solution
Transient Structural (Samcef )
Model
Setup
Solution
Transient Structural
Model
Setup
Solution
Rigid Dynamics
Model
Setup
Solution
Explicit Dynamics
400
Model
Task Groups
Tasks
Setup
Solution
Thermal-Electric
Model
Setup
Solution
Explicit Dynamics (LS-DYNA Export)
Model
Setup
Solution
Transient Thermal
Model
Setup
Solution
Transient Thermal (ABAQUS)
Model
Setup
Solution
Transient Thermal (Samcef )
Model
Setup
Solution
Design Assessment
Model
Setup
Solution
401
402

ANSYS ACT Developers Guide PDF

Uploaded by

Copyright:

Available Formats

ANSYS ACT Developers Guide PDF

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

ANSYS ACT Developers Guide PDF

Uploaded by

Copyright:

Available Formats

ANSYS ACT Developer's Guide

Copyright and Trademark Information

U.S. Government Rights

ACT Developer's Guide

ACT Developer's Guide

ACT Developer's Guide

ACT Developer's Guide

ACT Developer's Guide

Customizing ANSYS Products

Direct Product Customization

Process Compression and Automation

Changes to the Wizard API

Changes to the Project API

Known Issues and Limitations

General Callback Argument Migration

Known Issues and Limitations

Creating a Scripted Extension

ExtSample Extension: XML Extension Definition File

Key elements of the XML file include:

Creating a Scripted Extension

ExtSample Extension: IronPython Script

The script contains two functions:

ExtSample Extension: Directory Structure/File Hierarchy

Creating a Scripted Extension

ExtSample Extension: Exposure in the Application

Building a Binary Extension

Building a Binary Extension

Accessing the Binary Extension Builder

The Binary Extension Builder opens, as shown below.

Building a Binary Extension

Using the Binary Extension Builder

2. Identify the directory where the binary extension will be stored.

Configuring Extension Options

Configuring Extension Options

Figure 12: Extensions Options

The following configuration options are available:

Additional Extension Folders Option

Save Binary Extensions with Project Option

Journal Wizard Actions Option

Debug Mode Option

Configuring Extension Options

Using the ACT Start Page

Accessing the ACT Start Page

Accessing the ACT Start Page from Workbench or AIM

Accessing the ACT Start Page from a Standalone Application

ACT Start Page Interface

Using the Extension Manager

Using the Extension Manager

Extension Manager Accessed via the ACT Start Page

Using the Extension Manager

Extension Manager Accessed via Extensions Menu

Installing and Uninstalling Extensions

Installing a Scripted Extension

Installing and Uninstalling Extensions

Uninstalling a Scripted Extension

Installing a Binary Extension

Uninstalling a Binary Extension

Loading and Unloading Extensions

Loading and Unloading Extensions