Getting Started with ACTGetting Started with ACT

Copyright and Trademark Information© 2023 ANSYS, Inc. Unauthorized use, distribution or duplication is prohibited.
ANSYS, ANSYS Workbench, AUTODYN, CFX, FLUENT 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 located 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 andfeature names or trademarks are the property of their respective owners. FLEXlm and FLEXnet aretrademarks of Flexera Software LLC.
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 asoftware license agreement that contains provisions concerning non-disclosure, copying, length andnature of use, compliance with exporting laws, warranties, disclaimers, limitations of liability, andremedies, 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. and ANSYS Europe, Ltd. are UL registered ISO 9001: 2015 companies.
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.

Getting Started with ACT

Table of Contents
What is customization? ................................................................................................................................. 1
What is extensibility? .................................................................................................................................... 1
What is ACT? ................................................................................................................................................. 1
What capabilities does ACT provide? ........................................................................................................... 2
Feature Creation ....................................................................................................................................... 2
Simulation Workflow Integration ............................................................................................................. 4
Process Compression ................................................................................................................................ 5
What skills are required for using ACT? ........................................................................................................ 6
How do I begin using ACT?............................................................................................................................ 6
Where can I find published ACT apps? ......................................................................................................... 7

Getting Started with ACT

Getting Started with ACT
Ansys offers class-leading, off-the-shelf simulation technologies. To most effectively deploy pervasive
simulation, you may desire a more curated experience to match our simulation expertise with your user,company, or industry needs. Ansys ACT equips you with the power to customize and extend the Ansys
experience.
This section helps you to get started with ACT by answering these questions:
•••
•••
•

What is customization?
What is extensibility?
What is ACT?
What capabilities does ACT provide?
What skills are required for using ACT?
How do I begin using ACT?
Where can I find published ACT apps?

What is customization?
Customization is the in-product operation of modifying existing functionality and exposing brand newfeatures. The goal of customization is to alter an existing user experience to match the needs of theuser.

What is extensibility?
Building on customization, extensibility operates at a higher level of custom user experience, out-ofproduct feature exposure, and vertical applications. The goal of extensibility is to reliably andconsistently enhance a software package with minimal development and maintenance effort. To extend
Ansys software, you create extensions that add and modify functionality while minimizing the impact on
existing functionality.

What is ACT?
ACT is a unified and consistent toolkit for customizing and extending Ansys products, providing thefastest and easiest way to create simulation engineering apps that meet your specific needs. While
tailoring simulation applications to fit your use has traditionally been complex and time-consuming, ACTsimplifies this process, allowing you to focus more on simulation analysis than on customizing software.
1Getting Started with ACT

ACT uses easy-to-learn yet powerful eXtensible Markup Language (XML) and IronPython programming
languages. Even if you are a non-expert user, you can create custom apps for your advanced workflows.
Unlike typical software programming, ACT does not require a commercial Integrated Development
Environment (IDE). Instead, it provides an intuitive development environment with tools,
documentation, and lots of examples to guide you through the process. With ACT, you can createcustomizations in only hours or days instead of weeks or months.
Many Ansys products expose their own scripting solutions. However, ACT provides a single scripting
solution for customizing all Ansys products. You can mix ACT APIs (Application Programming Interfaces)with product-specific APIs without needing to compile external code or link with existing Ansys libraries.
Additionally, ACT enables you to manage the interfaces between these products and the additionalcustomizations, ensuring that they all interact accurately.
ACT’s intuitive APIs and simple app creation tools capture the best practices of expert engineering
analysts, thereby reducing training and implementation costs and enabling a broader range of engineersand designers to effectively use simulation tools. By fostering a unified simulation workflow, ACT allows
you to integrate your non-Ansys engineering tools and data into the Ansys ecosystem to maximize theproductivity of your engineering teams. Leverage these streamlined simulation workflows for faster andbetter decisions throughout the entire product life cycle, from concept to product use.

What capabilities does ACT provide?
While Ansys provides comprehensive engineering simulation solutions across all physics areas, you arelikely to have business-specific needs that are not native to Ansys products. To tailor Ansys products tomeet these needs, ACT provides customization capabilities, categorized into three types:•••

Feature Creation
Simulation Workflow Integration
Process Compression

Note: For additional information about ACT, including "roadmaps" designed to guide you through thesteps of creating the desired type of ACT customization for an Ansys product, the ACT Ecosystem tab on
the App Developer Resources page displays ACT Overview links for various Ansys versions. Clicking a linktakes you to the version-specific Ansys Help, which requires customer account login.

Feature Creation
Feature creation is the direct, API-driven customization of Ansys products. In addition to leveraging thefunctionality already available in a product, ACT enables you to add functionality and operations of yourown. Your custom additions operate as “native” features in the target Ansys product.
2Getting Started with ACT

Feature creation examples include:•••

Creating custom loads and geometries
Adding custom preprocessing and postprocessing features
Integrating third-party solvers, sampling methods, and optimization algorithms

These Ansys products support feature creation:•••••

DesignModeler
DesignXplorer
FluentMechanical
Workbench

Feature creation capabilities common to all these products include user interface entry creation, ACTbased property creation, and property parameterization. Product-specific feature creation capabilities
are described in the ACT customization guide for the product, which can be found in the Ansys Help.
A few examples follow of feature creation in various Ansys products:•DesignModelero Define new user interface elements to execute custom actionso Expose new geometry features•Fluento Deploy your own UDFs with ACT UDF macro encapsulation•Mechanicalo Integrate your legacy APDL macros with APDL encapsulationo Develop your own criterion using IronPython and integrate it into the powerful
Mechanical Post environmento Add new boundary conditions, preprocessing and postprocessing algorithms, andcustom resultso Define new user interface elements to execute custom actions•Workbencho Define new user interface elements to execute custom actions

Feature creation also includes the integration of custom solvers and sampling and optimization
algorithms. For example, you can:•Integrate new sampling and optimization methods in DesignXplorer. ACT enables you to extend
the existing set of Ansys-supplied sampling and optimization algorithms with your own in-house,3Getting Started with ACT

third-party, or commercial strategies. You can then select these integrated methods from
DesignXplorer’s setup properties.
•Integrate custom solvers directly in Mechanical. By embedding your solvers into Mechanicalsimulations, you can create new Workbench analysis systems based on your technologies.
Within Mechanical, the solver operates seamlessly with the processing routines for the native
mathematical model, solver, and results processing.

Simulation Workflow Integration
Simulation workflow integration is the incorporation of external knowledge such as apps, processes, andscripts into the Ansys ecosystem. With ACT, you can create custom simulation workflows that can beinserted on the flowchart-like schematic in Workbench.
An engineering simulation workflow is a sequence of actions performed on well-defined data to obtaininsightful results. A typical simulation workflow can be broken down into five steps:
1.
2.
3.
4.
5.

Define or retrieve input data
Prepare for execution
Run the process
Generate output data
Publish results

With ACT, you define each workflow step as a custom task (component) and then combine multiple
custom tasks into a custom task group (system). You can then insert custom task groups on theWorkbench Project Schematic to construct consistent and cohesive simulation workflows, allowing yourbusiness-specific elements to coexist and interface with pre-built Ansys solutions. Currently, Workbenchis the only Ansys product to support simulation workflow integration. For more information, see
the Ansys ACT Customization Guide for Workbench, which can be found in the Ansys Help.
You can use integrated workflows for various simulation scenarios, performing custom behaviors such as
specialized data processing, report generation, and application synchronization to manage and integrateheterogeneous processes and tools into your Ansys simulation environment. By using ACT to integrate
diverse data generated from in-house and commercial engineering software products into your Ansysenvironment, you can improve your product lines and innovate faster.
Examples follow of using custom workflows to integrate external data and applications:•Maintain or reuse data from an external application, such as a CAD system. With ACT, you canautomate the process of mapping and linking to this data to save time and reduce errors, greatly
improving productivity. Additionally, you can use ACT to batch process the generation of images
and reports from your model results.
4Getting Started with ACT•Expose external applications and data with custom workflows in Workbench to achieve:
ooooooNative "OEM" look and feel
Professional-grade application deployment
Project data and file management solutions
Collaboration with industry-leading applications
Flexible project construction
Remote Solve Manager (RSM) job submission to send large jobs to more powerful
remote high-performance machines

Process Compression
Process compression is the encapsulation and automation of processes available in one or more Ansys
products. The result is a simulation wizard, which incorporates your best practices to reliably guide nonexpert users step-by-step through a complex simulation to produce desired results quickly. This type ofACT customization provides the greatest breadth because wizards simplify complex processes, allowing
them to be repeated whenever needed. You can create wizards for these Ansys products:
••
•••
•
•

DesignModeler
DesignXplorer
Electronics Desktop
FluentMechanicalSpaceClaim
WorkbenchWith wizards, you can manipulate existing features and simulation components, organizing them as
needed to produce a custom automated process. A wizard can compress and automate processes within
a single Ansys product to manage complex model interactions for one physics area. Or, a wizard cancompress and automate processes of multiple Ansys products and even external applications forcomplex multi-physics simulations. By using wizards to simplify the analytical process, you boost theperformance of the entire enterprise.
Wizards allow you to leverage both the existing functionality of Ansys products and the scripting
capabilities of the Workbench framework API. For example, you can copy a journal of the steps that you
take in an Ansys product into an ACT script and then parametrize the syntax to make the script genericfor reuse.
The degree of automation possible depends on the product being customized. Examples of aWorkbench-based project wizard and a mixed wizard appear in this guide. Examples of wizards specificto an Ansys product are described in the ACT customization guide for the product, which can be found inthe Ansys Help.
5

Getting Started with ACT

Because simulation workflows are often so complex, the use of simulation tends to be limited to only afew expert users, reducing the overall efficiency of the engineering process. The need to satisfy processcompliance requirements and ensure data integrity adds even more complexity. Using wizards, you canleverage the knowledge of your engineering process experts by compressing your business-specificprocesses into streamlined, simple-to-follow steps. Because each step exposes only the criticalinformation required to ensure successful simulation, wizards shield users from technical complexities.

What skills are required for using ACT?
The development of ACT apps requires some knowledge of XML and IronPython. An ACT app begins as ascripted extension consisting of an XML file that defines and configures the content of the extension andat least one IronPython script that defines the functions invoked by user interactions, implementing theextension's behavior.
With ACT’s standard XML and IronPython approach for all Ansys products, app creation is easy to learn,
regardless of the Ansys products that you plan to customize. Apply the same consistent framework andAPIs to meet your customization objectives and workflows.
The ACT App Builder makes creating and editing XML files and IronPython scripts even easier. Rather
than manually performing these app-building actions, you can use this tool to automatically generate
reusable scripts for customization in an interactive environment, without having to write code. Built-in
journal recording eliminates manual callback programming and property substitutions, dramaticallysimplifying and speeding up customization. Intuitive property definition and processing specific tosupported Ansys products breaks down barriers to scripting. Use of the ACT App Builder ensures easier,faster, and cheaper development of ACT apps.
For apps that customize Ansys solvers, knowledge of APDL is required. Additionally, advanced users cantake advantage of the opportunities of .NET integration and support provided by IronPython. If you areinterested in specific members or code methods, the ACT Console is a convenient tool to interactively
navigate the APIs through robust autocompletion.

How do I begin using ACT?
The ACT Start Page provides a central place from which to access the many tools that ACT provides fordeveloping, debugging, and executing extensions. From here, you can access the ACT Console, which
exposes the ACT APIs. As a novice, you can discover APIs and write small and simple scripts forautomating routine tasks that you perform within an Ansys product. As your experience and confidence
grows, you can write full-fledged extensions that customize and extend Ansys products.

6Getting Started with ACT

The Extension Manager provides for installing and loading extensions. The Wizards
launcher starts simulation wizards, and the binary extension builder creates compiled binary files from
scripted extensions. With tools like the ACT App Builder, ACT Debugger, and ACT Workflow Designer,modifying existing Ansys functionalities and adding new custom functionalities and workflows is easy,
giving you the power to decide how Ansys products should look and behave.
ACT also provides a full set of supporting resources to help you with app development. The ACT
documentation includes comprehensive feature overviews and detailed API descriptions. To aid you indevelopment efforts, ACT supplies comprehensive examples for various types of Ansys productcustomizations, all of which are designed to help you to understand how to use ACT to develop apps.
For instance, you can easily modify supplied examples to align them with your own simulation vision,saving you both development time and money. Written and tested on supported Windows and Linux
platforms, these examples are packaged for download from the help panel on the ACT Start Page.
Additionally, on the App Developer Resources page, the Help & Support tab displays a link fordownloading the examples.
The Ansys training course for ACT covers using ACT and its APIs to customize Workbench,
Mechanical/Meshing, and DesignModeler. After completing this course, you will be able to automate
the creation of standard tree objects in Mechanical/Meshing, create custom loads and results in
Mechanical, create custom objects in DesignModeler, and create wizards in Workbench or its integratedmodules.

Where can I find published ACT apps?
The Ansys Store provides hundreds of free and paid apps developed by Ansys and trusted partners. With
more than 6,000 downloads per month, the Ansys Store provides an ever-expanding library of dynamic
simulation solutions. These business-specific Ansys apps range greatly in functionality and complexity.
You can filter apps based on target application, product version, and price range. Because free apps areavailable as simple downloads, you can easily use the Extension Manager to install and load them tobetter explore the power that ACT provides. For some free apps, the source code is also included so thatyou can view and even modify it to create your own custom app.

7

Getting Started with ACT

In the left pane, you can click the link for the App Developer Resources page, where you will find a
multitude of resources for using ACT to develop your own custom apps. On this page, the Post My ACT
Application tab displays a link for downloading instructions for posting your custom apps on the Ansys
Store.
By making complex simulations accessible to all engineers, Ansys apps “democratize” the use ofsimulation across your organization. With designers being able to perform simulations, expert engineers
can spend more time on researching and developing innovative and reliable products.

8