Table of Contents

Introduction
Customizing ANSYS Products
Licensing
Migration Notes
Known Issues and Limitations
Summary: Extension Examples
Defining Extensions
Common Capabilities
Mechanical Capabilities
APIs Description
Mechanical Examples
DesignXplorer Examples
Custom Workflows in Workbench Examples
Wizard Examples
Defining Extensions
Creating a Scripted Extension
Creating the XML Extension Definition File
Creating the IronPython Script
Setting Up the Directory Structure
Viewing Exposed Custom Functionality
Script Processing
Using Extension Libraries
Building a Binary Extension
Configuring Extension Options
Additional Extension Folders Option
Save Binary Extensions with Project Option
Journal Wizard Actions Option
Debug Mode Option
Using Extensions
Using the ACT Start Page
Accessing the ACT Start Page
Accessing the ACT Start Page from Workbench
Accessing the ACT Start Page from AIM
Accessing the ACT Start Page from a Standalone Instance of Electronics Desktop
Accessing the ACT Start Page from a Standalone Instance of Fluent
Accessing the ACT Start Page from a Standalone Instance of SpaceClaim
ACT Start Page Interface
Using the Extension Manager
Extension Manager Accessed via the ACT Start Page
Extension Manager Accessed via Extensions Menu
Installing and Uninstalling Extensions
Installing a Scripted Extension
Uninstalling a Scripted Extension
Installing a Binary Extension
Uninstalling a Binary Extension
Loading and Unloading Extensions
Configuring Extensions to be Loaded by Default
Feature Creation Capabilities
Common Capabilities
Defining Toolbars and Toolbar Buttons
Binding Toolbar Buttons with ACT Objects
Defining Pop-up Dialog Boxes
Storing Data in Your Extension
ACT-Based Properties
Creating Property Groups
Using <PropertyGroup> and <PropertyTable> Blocks
Using Templates to Create Property Groups
Parameterizing Properties
Common Property Parameterization Processes
Parameterizing Properties in ANSYS Workbench
Parameterizing Properties in ANSYS Mechanical
Defining Input Parameters in ANSYS Mechanical
Defining Output Parameters in ANSYS Mechanical
Parameterizing Properties in ANSYS DesignModeler
Parameterizing Properties in a Third-Party Solver
Defining Parameters under a Load in a Third-Party Solver
Defining Parameters in Analysis Settings in a Third-Party Solver
Defining Parameters under Results in a Third-Party Solver
Defining DesignXplorer Properties
Properties in the DesignXplorer Interface
Additional Attributes for DesignXplorer Extensions
Advanced Usage Examples
Managing Dependencies between Properties
Controlling Property Visibility with a Callback
DOE Example
Optimization Example
Modifying an Attribute with a Callback
DOE Example
Optimization Example
Capabilities for ANSYS Mechanical
Adding a Preprocessing Feature in ANSYS Mechanical
Adding a Postprocessing Feature in ANSYS Mechanical
Creating Results with Imaginary Parts
Responding to a Change to the Active Unit System
Obsolete Callbacks "OnStartEval" and "GetValue"
Connecting to a Third-Party Solver
Third-Party Solver Connection Extension
Post Processing
Load and Save Data
Capabilities for ANSYS DesignModeler
Geometry Definition in the XML Extension Definition File
Geometry Definition in the IronPython Script
Functions Associated with the Callback <ongenerate>
Functions Associated with the Callback <onaftergenereate>
Capabilities for ANSYS DesignXplorer
The Design Exploration Process
DesignXplorer Systems and Component
Design of Experiments Component
Optimization Components
DesignXplorer Extensions
Implementing a DesignXplorer Extension
Implementation Requirements
DesignXplorer Extension Definition and Configuration
DesignXplorer Extension Capabilities
Main Capabilities
Optional Capabilities
Notes on Method Class Implementation
Notes on Monitoring
Notes on Results
Capabilities for ANSYS AIM
Adding a Preprocessing Feature in ANSYS AIM Structural
Custom Load Definition in the XML Extension Definition File
Custom Load Definition in the IronPython Script
Creating a Custom Object to Merge Existing AFD Features (Process Compression)
CFD System Definition in the XML Extension Definition File
CFD System Definition in the IronPython Script
Using SetScriptVersion Within ACT Extensions for ANSYS AIM
Capabilities for ANSYS Fluent
Simulation Workflow Integration
Exposing Custom Task Groups and Tasks on the Project Schematic
Using Global Callbacks
Invoking Custom Schematic Actions
Invoking Custom Workbench Actions
Global Callback Observation Process
Progress Monitoring
Using Process Utilities
The Custom Workflow Creation Process
Creating the XML Definition File
Defining a Global Callback
Invoking Global Callbacks
Filtering Global Callbacks
Specifying Global Callback Execution Order
Available Schematic Callbacks
Available Workbench Callbacks
Defining a Task
Defining Task-Level Attributes
Defining Task-Level General Data Transfer
Defining Task-Level Data Transfer Access
Task-Level File Management Capabilities
Defining Task-Level Callbacks
Defining Task-Level Context Menus
Defining Task-Level Property Groups and Properties
Defining Task-Level Property Callbacks
Using Standardized Property Interaction
Using Path-Based Property Control Support
Using String-Based and Option-Based Task Properties
Specifying Property Default Values
Defining Task-Level Parameters
Defining Task-Level Inputs and Outputs
Defining a Remote Job Execution Specification
Accessing and Invoking Task-Related Workbench Data
Executing Container-Level Commands on a Task
Accessing Workbench Parameters from a Task
Accessing a Workbench-Based Component from a Task
Accessing the Owning Task Group from a Task
Defining a Task Group
Creating the IronPython Script
Upstream Data Consumption (Input)
Data Generation (Output)
Convenience APIs
Simulation Wizards
Types of Wizards
Creating Wizards
Parts of a Wizard
XML Extension Definition File
Example: XML Extension Definition File
IronPython Script
Example: IronPython Script for a Project Wizard
Custom Help for Wizards
Viewing Custom Help for Non-AIM Wizards
Viewing Custom Help for AIM Wizards
Creating Conditional Steps
Customizing the Layout of a Wizard
Installing and Loading Wizards
Using Wizards
Using a Workbench Project or Non-AIM Target Product Wizard
Launching a Wizard from the Wizards Page
The Wizard Interface
Entering Data in a Wizard
Exiting a Wizard or Project
Using an AIM Target Product Wizard
Creating a Custom Template
Creating a Guided Simulation
Creating a Guided Setup
APIs Description
ACT Automation API
APIs for Custom Workflows in the Workbench Project Page
Accessing Project-Level APIs
Accessing Task APIs
Accessing Task Template APIs
Accessing Task Group APIs
Accessing Task Group Template APIs
Accessing Parameter APIs
Accessing Property APIs
Accessing State-Handling APIs
Accessing Project Reporting APIs
APIs for ANSYS Mechanical
Directly Accessing an Object
Handling Property Types
Customizing the User Interface and Existing Toolbars
Working with Command Snippets
Manipulating Fields for Boundary Conditions
Input and Output Variables
Variable Definition Types
Input Loading Data Definitions
Setting the Variable Definition Type
Creating a Displacement and Verifying Its Variable Definition Types
Changing the Y Component from Free to Discrete and Verifying
Changing the Y Component Back to Free and Verifying
Setting Discrete Values for Variables
Getting and Setting Discrete Values for an Input Variable
Getting and Setting Discrete Values for an Output Variable
Mechanical Worksheets
Named Selection Worksheets
Creating the Named Selection Worksheet
Adding New Rows
Mesh Order Worksheets
Displaying the Mesh Worksheet
Specifying the Mesh Worksheet and Named Selections
Adding New Rows
Meshing the Named Selections
Additional Commands
Layered Section Worksheets
Displaying the Layered Section Worksheet
Getting the Layered Section Worksheet and Its Properties
Getting and Displaying the Material Property
Getting and Displaying the Thickness Property
Getting and Displaying the Angle Property
Setting and Displaying the Thickness Property
Setting and Displaying the Angle Property
Bushing Joint Worksheets
Displaying the Bushing Joint Worksheet
Getting the Bushing Joint Worksheet and Its Properties
Getting the Value for a Specified Unit
Tree Object
Model Object
Geometry: Point Mass
Geometry: Export Geometry Object to an STL File
Mesh: Mesh Control
Connections: Frictionless Contact and Beam
Analysis: Load Magnitude
Analysis: Extract Min-Max Tabular Data for a Boundary Condition
Result: Total Deformation Maximum
TraverseExtension
Traversing the Geometry
Traversing the Mesh
Traversing Results
Graphical Views
Getting the ModelViewManager Data Object
Setting the View
Creating a View
Deleting a View
Applying a View
Renaming a View
Rotating a View
Saving a View
Saving an Object
Importing a Saved View List
Exporting a Saved View List
Exporting an Object
APIs for ANSYS DesignModeler
Using the Selection Manager in DesignModeler
Working with the Current Selection
Creating a New Selection and Adding Entities
Creating Primitives
Creating a Sheet Body
Creating a Wire Body
Creating a Solid Body
Applying Operations
Applying the Extrude Operation
Applying the Transform Edges to Wire Tool
APIs for ANSYS DesignXplorer
DOE APIs
DOE Architecture
Sampling Process
Optimization APIs
Optimization Architecture
Optimization Process
Associated Libraries
Query to Material Properties
Units Conversion
MAPDL Helpers
Journaling Helper
Development and Debugging
ACT Console
Using the Scope Menu
Using the Command Line
Using the Command History
Using Autocompletion
Using Autocompletion Tooltips
Interacting with Autocompletion Suggestions
Using Snippets
ACT Console Keyboard Shortcuts
Binary Extension Builder
Debug Mode
Toolbar Buttons for Reloading Extensions
Extensions Log File
Debugging with Microsoft® Visual Studio
Advanced Programming in C#
Initialize the C# Project
C# Implementation for a Load
C# Implementation for a Result
Extension Examples
Mechanical Extension Examples
Von-Mises Stress as a Custom Result
Edge-Node Coupling Tool
DesignXplorer Extension Examples
DOE Extension Examples
Optimization Extension Examples
Custom ACT Workflows in Workbench Examples
Global Workflow Callbacks
XML Extension Definition File
IronPython Script
Custom User-Specified GUI Operation
XML Extension Definition File
IronPython Script
Custom, Lightweight, External Application Integration with Parameter Definition
XML Extension Definition File
IronPython Script
Custom, Lightweight, External Application Integration with Custom Data and Remote Job Execution
XML Extension Definition File
IronPython Script
Using RSM Job Submission Capabilities
Generic Material Transfer
XML Extension Definition File
IronPython Script
Material File
Generic Mesh Transfer
XML Extension Definition File
IronPython Script
Custom Transfer
XML Extension Definition File
IronPython Script
Parametric
XML Extension Definition File
IronPython Script
Wizard Examples
Project Wizard (Workbench Project Tab)*
XML Extension Definition File
IronPython Script
Project Wizard (AIM Project Tab)
XML Extension Definition File
IronPython Script
Reviewing Wizard Results
DesignModeler Wizard*
XML Extension Definition File
IronPython Script
SpaceClaim Wizard*
XML Extension Definition File
IronPython Script
Mechanical Wizard*
XML Extension Definition File
IronPython Script
Mixed Wizard*
XML Extension Definition File
IronPython Script
Fluent Wizard (MSH Input File)
XML Extension Definition File
Reviewing the Analysis
Fluent Wizard (CAS Input File)
XML Extension Definition File
Reviewing the Analysis
Electronics Desktop Wizard
XML Extension Definition File
IronPython Script
Reviewing the Analysis
SpaceClaim Wizard
XML Extension Definition File
IronPython Script
AIM Custom Template (Single-Step)
XML Extension Definition File
IronPython Script
Defining Custom Help for the Single-Step Custom Template
AIM Custom Template (Multiple-Step)
XML Extension Definition File
IronPython Script
Defining Custom Help for the Multiple-Step Custom Template
Wizard Custom Layout Example
XML Extension Definition File
IronPython Script
Exposure of the Wizard Layouts
XML Extension Definition
<extension>
<Application>
<appStoreId>
<assembly>
<author>
<description>
<Guid>
<Interface>
<Licenses>
<script>
<simdata>
<Templates>
<UIDefintion>
<Wizard>
<Workflow>
A. Component Input and Output Tables
B. ANSYS Workbench Internally Defined System Template and Component Names
C. Data Transfer Types
D. Addin Data Types and Data Transfer Formats
E. Pre-Installed Custom Workflow Support

Release 18.2 - © ANSYS, Inc. All rights reserved.