You are on page 1of 32

Using ACT to Customize ANSYS Products: An

Intro to Creating Business-Specific Apps

ANSYS, Inc. Release 18.0


Southpointe January 2017
2600 ANSYS Drive
Canonsburg, PA 15317 ANSYS, Inc. and
ansysinfo@ansys.com ANSYS Europe,
Ltd. are UL
http://www.ansys.com registered ISO
(T) 724-746-3304 9001: 2008
(F) 724-514-9494 companies.
Copyright and Trademark Information

2016 SAS IP, Inc. 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 CONFID-
ENTIAL 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. and ANSYS Europe, Ltd. are UL registered ISO 9001: 2008 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.


Table of Contents
ACT Overview ............................................................................................................................................. 1
Extension Structure ................................................................................................................................ 1
Extension Formats .................................................................................................................................. 2
ACT Customization Tools ........................................................................................................................ 3
ACT Customization Capabilities ................................................................................................................. 5
Types of Customization ........................................................................................................................... 5
Customization Types by Product ............................................................................................................. 6
ACT Documentation and Development Resources .................................................................................... 7
ACT General Documentation .................................................................................................................. 7
ACT Reference Documentation ............................................................................................................... 8
ACT Templates, Training, and More .......................................................................................................... 8
Python Resources ................................................................................................................................... 9
Roadmaps for ACT Customization ............................................................................................................ 11
ACT Customization Common Steps .................................................................................................... 12
Feature Creation Roadmaps .................................................................................................................. 12
Feature Creation in AIM .................................................................................................................. 13
Feature Creation in the Workbench Project Page ............................................................................. 14
Feature Creation in DesignModeler ................................................................................................. 14
Feature Creation in Mechanical ....................................................................................................... 16
Feature Creation in DesignXplorer .................................................................................................. 18
Simulation Workflow Integration Roadmap ........................................................................................... 19
Process Compression Roadmaps ........................................................................................................... 21
Process Compression Common Topics .......................................................................................... 22
Process Compression in AIM ........................................................................................................... 23
Process Compression in the Workbench Project Page ...................................................................... 23
Process Compression in SpaceClaim ................................................................................................ 24
Process Compression in DesignModeler .......................................................................................... 25
Process Compression in Mechanical ................................................................................................ 25
Process Compression in Electronics Desktop ................................................................................... 26
Process Compression in DesignXplorer ........................................................................................... 26
Process Compression in Fluent and Fluent Meshing ......................................................................... 27
Process Compression for Multiple Applications (Mixed Wizards) ....................................................... 27

Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. iii
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
iv of ANSYS, Inc. and its subsidiaries and affiliates.
ACT Overview
ANSYS ACT is the unified and consistent tool for the customization and expansion of ANSYS products.
Using ACT, you can create extensions to tailor ANSYS Workbench, ANSYS AIM, and other ANSYS products
(such as Mechanical, Fluent, and Electronics Desktop) to meet your application-specific and multi-
physics simulation needs. You can also engage the ANSYS simulation ecosystem through integration
and custom workflow techniques.

The purpose of this document is to:

Present a high-level overview of ACT, introducing you to the general concepts that you need to under-
stand to develop extensions.

Help you start developing your own extensions, from the initial design phase through the implement-
ation andwhen desiredto the final posting of your app to the ANSYS App Store. You can post your
apps using the Post My App Google site, which details the posting process.

Deliver specialized customization "roadmaps designed to guide you through the steps of creating the
desired type of ACT customization for the supported ANSYS product you choose.

Provide references and links to the available ACT documentation and resources so that you can easily
access relevant information, such as:

Sections in the ACT Developers Guide that specifically address your objective

Reference guides containing API and XML information

ACT templates and extension examples

ACT training materials

Important

Most of the links in this document go to materials on the ANSYS Customer Portal. You
must be logged into the Customer Portal for these links to open directly to the desired
page.

Also, documentation available on the Customer Portals Online Documentation: Current Release 18.0
page is available from the Help menu in ANSYS products.

Extension Structure
All ACT extensions are made up of the same two basic parts: an XML extension file and an IronPython
script.

Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1
ACT Overview

Extensions can potentially include additional components such as external Python libraries, C# code,
input files, and images to display in the custom GUI.

Extension Formats
ACT extensions can be created in two different formats: scripted and binary.

Scripted Extensions

A scripted extension is an extension with an editable XML extension file and IronPython script. The XML
file and an extension folder containing (at minimum) the IronPython script are saved at the same level.

Binary Extensions

A binary extension is a compiled extension (WBEX file) resulting from the build of a scripted extension.
These extensions can be shared with users, who will be able to execute the extension, but will not be
able to edit it.

Note

You do not need a license to create either a scripted or binary extension. However, you
do need a license to load a scripted extension. The ACT license is bundled with most
ANSYS 18.0 products.

Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
2 of ANSYS, Inc. and its subsidiaries and affiliates.
ACT Customization Tools

ACT Customization Tools


You can access most of ACTs customization tools from the ACT Start Page, which is available in all
ANSYS products that support the use of extensions. The way that you access this page depends on the
ANSYS product that you are using.

From the ACT Start Page page, you can access the Wizards page, Extension Manager, ACT Console,
and extension log file, all of which are used to develop and execute extensions.

The following table provides links to detailed information in the ACT Developers Guide about the ACT
Start Page and the customization tools that are available to you.

Tool Reference
ACT Start Page Using Extensions > Using the ACT Start Page >

Accessing the ACT Start Page

ACT Start Page Interface

Wizards Page ACT Simulation Wizards > Using Wizards


Extension Manager Using Extensions > Using the Extension Manager >

Extension Manager Accessed via the ACT Start Page

Extension Manager Accessed via Extensions Menu

ACT Console Development and Debugging > ACT Console


Binary Extension Builder Development and Debugging > Binary Extension Builder

Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 3
ACT Overview

Tool Reference
Debug Mode (Refresh Extensions and Log Development and Debugging >
File)
Debug Mode

Debugging with Microsoft Visual Studio

Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
4 of ANSYS, Inc. and its subsidiaries and affiliates.
ACT Customization Capabilities
This section describes types of ACT customizations and then indicates what types are available for the
products that support ACT.

Related Topics:
Types of Customization
Customization Types by Product

Types of Customization
ACT provides three types of customization:

Feature creation

Simulation workflow integration

Process compression

All three types of customization are accomplished through the creation and implementation of ACT
extensions. Color coding is used in subsequent topics to distinguish between these customization types.

Feature Creation

Feature creation is the direct, API-driven customization of ANSYS products. In addition to leveraging
the native functionality already available in a product, it enables you to add functionality and operations
of your own.

Examples of feature creation include the creation of custom loads and geometries, the addition of
custom preprocessing or postprocessing features, and the integration of third-party solvers, sampling
methods, and optimization algorithms.

Simulation Workflow Integration

Simulation workflow integration is the incorporation of external knowledge such as apps, processes,
and scripts into the ANSYS ecosystem. Today users can engage in simulation workflow customization
in the ANSYS Workbench Project page. You can define new workflow tasks to construct consistent and
cohesive simulation workflows, allowing your business-specific elements to coexist and interface with
pre-built ANSYS solutions.

Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 5
ACT Customization Capabilities

Process Compression

Process compression is the encapsulation and automation of existing processes available in an ANSYS
product. The result is a wizard that provides guidance within the application workflow, walking the
end-user step-by-step through a simulation. You can create single wizards to be run in specific target
applications or mixed wizards to be run across several applications. In AIM, wizards are called custom
templates.

Customization Types by Product


The following table shows the ANSYS products that currently support ACTs customization capabilities.

Product Simulation Workflow Feature Creation Process Compression


Integration

Workbench
AIM
DesignModeler
Mechanical
DesignXplorer
SpaceClaim
Electronics Desktop
Fluent
Fluent Meshing

Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
6 of ANSYS, Inc. and its subsidiaries and affiliates.
ACT Documentation and Development Resources
This section introduces you to the ACT documentation and resources that are available to help you use
ACT. To visit the ANSYS App Store to view apps offered by ANSYS and its customers, you go to ansys.com
and select About Ansys > ANSYS App Store. Posted apps can be filtered based on product family and
by free or paid apps.

Related Topics:
ACT General Documentation
ACT Reference Documentation
ACT Templates, Training, and More
Python Resources

ACT General Documentation


Resource Description Location
ACT Presentation providing instructions for Customer Portal > Downloads > ACT
Extension installing ACT extensions in both binary Resources > Help & Support > ACT
Installation and scripted formats. Extension Installation Procedure
Procedure
ACT Notes for migrating from the previous Customer Portal > Downloads > ACT
Migration release to 18.0 are included in ANSYS ACT Resources > Help & Support > ACT
Notes Developer's Guide, which is described in the Migration Notes
next entry. The location of a standalone
version of these notes is indicated to the
right.
ACT General introductory guide for ACT Customer Portal > Knowledge Resources
Developers that provides: > Online Documentation > Customization >
Guide
Introduction to ACT capabilities, interface, ANSYS ACT Developers Guide PDF
and tools.
ANSYS ACT Developers Guide HTML
Information about customization types
and product support. Customer Portal > Downloads > ACT
Resources > Help & Support > ACT
Extension examples showing Developers Guide
product-specific capabilities, API usage,
and customization types.

License Software licensing agreement for Customer Portal > Downloads > ACT
Agreement publishing extensions to the ANSYS App Resources > Help & Support > ACT
Store. Extension License Agreement

Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 7
ACT Documentation and Development Resources

ACT Reference Documentation


Resource Description Location
ACT Easy-to-navigate online HTML document Customer Portal > Downloads > ACT
Online providing both API and XML reference Resources > Help & Support >
Reference materials for ACT. Available in both online
(.html) and downloadable (.zip) versions. ACT Online Reference Guide

NOTE: The online version is the ACT Download Reference Guide


recommended version of the reference
documentation.
ACT Reference document providing API Customer Portal > Knowledge Resources >
API namespace information for ACT. Online Documentation > Customization >
Reference
Guide ACT API Reference Guide PDF

ANSYS ACT API Reference Guide HTML

ACT Reference document providing XML Customer Portal > Knowledge Resources >
XML definition and tagging information for Online Documentation > Customization >
Reference ACT.
Guide ANSYS ACT XML Reference Guide PDF

ANSYS ACT XML Reference Guide HTML

AIM and Reference document providing a general Customer Portal > Knowledge Resources >
Workbench introduction to journaling and scripting Online Documentation > Customization >
Scripting capabilities that can be used in some
Guide customizations. Also contains ANSYS AIM and Workbench Scripting
product-specific data container information. Guide PDF

ANSYS AIM and Workbench Scripting


Guide HTML

ACT Templates, Training, and More


Resource Description Location
ACT Zip packages containing templates. Package Customer Portal > Downloads > ACT
Templates contains a variety of templates, each Resources > ACT Templates >
including a sample extension. Some
packages also include example projects. ACT Templates for Mechanical

ACT Templates for DesignModeler

ACT Templates for DesignXplorer

ACT Wizard Templates

Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
8 of ANSYS, Inc. and its subsidiaries and affiliates.
Python Resources

Resource Description Location


ACT Training modules containing lectures and Customer Portal > Downloads > ACT
Intro workshops. Resources > Help & Support >
Training:
Lectures Training ACT for Mechanical
and
Workshops Training ACT for DesignModeler

Training for ACT Wizards

Introduction to IronPython

ACT Libraries containing release-specific and Customer Portal > Downloads > ACT
Libraries product-specific extension examples and Resources > Previous Releases >
models. ACT resources for previous ANSYS
versions are also accessible. ACT Resources for 17.2

16.2 ACT Library

15.0 ACT Library

Framework SDK Library

Simplorer Device Models Library

Case ACT case studies and videos. Customer Portal > Downloads > ACT
Studies Resources > Case Studies & Videos >
& Videos
Oticon, DK

Epsilon, USA

ADAPT (US Army)

Whirlpool Corp.

ANSYS ACT General Presentation

ANSYS ACT Videos

ANSYS ACT Global Update at ANSYS 17

Python Resources
Resource Description Location
Python Training Training presentation providing basics of Customer Portal > Downloads >
using XML and Python programming. ACT Resources > Help & Support
> Introduction to IronPython
IronPython IronPythons documentation page, which http://ironpython.net/
Documentation provides version-specific documentation documentation/
and application/implementation
examples.

Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 9
ACT Documentation and Development Resources

Resource Description Location


Python Essential The fourth edition of Python Essential This book is available online from
Reference Reference, a book by David Beasley. a variety of sources.

Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
10 of ANSYS, Inc. and its subsidiaries and affiliates.
Roadmaps for ACT Customization
This section contains development roadmaps" to guide you through the extension creation process.
Each roadmap provides a high-level description of the steps necessary for the specific customization
that you want to perform. It then directs you to more detailed information in the ACT documentation
set.

Note

Unless otherwise indicated, references are to the HTML version of the ACT Developers
Guide.

Content goes from the general to the specific. The first section provides the steps that are common to
all extensions. Roadmaps and steps then follow for each of the three types of customization:

Feature creation

Simulation workflow integration

Process compression

Each section for a customization type provides information for the specific ANSYS products that can be
customized.

Figure 1: ACT Customization

Related Topics:
ACT Customization Common Steps
Feature Creation Roadmaps
Simulation Workflow Integration Roadmap

Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 11
Roadmaps for ACT Customization

Process Compression Roadmaps

ACT Customization Common Steps


The following tables provide the steps that are common to all extensions and refer you to relevant
topics in the ACT Developers Guide.

Step 1: Define Your Extension


Step Description Reference
1a Create the XML definition file. Defining Extensions > Creating a Scripted Extension > Creating
the XML Extension Definition File
1b Create the IronPython script. Defining Extensions > Creating a Scripted Extension > Creating
the IronPython Script
1c Place the files in the correct Defining Extensions > Creating a Scripted Extension > Setting Up
directory structure. the Directory Structure/File Hierarchy
1d Optional: Compile the scripted Defining Extensions > Building a Binary Extension
extension into a binary
extension (WBEX file). Also see Binary Extension Builder.
1e Configure extension options in Defining Extensions > Configuring Extension Options
Tools > Options > Extensions.

Step 2: Install and Load Your Extension


Step Description Reference
2a Install your extension. For Scripted Extensions:

NOTE: For binary Using Extensions > Installing and Uninstalling Extensions >
extensions, you use the Installing a Scripted Extension
ACT Extension Manager. For Binary Extensions:

Using Extensions > Installing and Uninstalling Extensions >


Installing a Binary Extension
2b Load your extension. Using Extensions >

Loading and Unloading Extensions

Configuring Extensions to be Loaded by Default

Step 3: Debug Your Extension


Step Description Reference
3 Optional: Debug your extension Development and Debugging > Debug Mode
using ACT or external tools.

Feature Creation Roadmaps


Feature creation customization is the API-based creation of new custom features for a product. The
following flowchart shows:

The products for which ACT feature creation capabilities are available

Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
12 of ANSYS, Inc. and its subsidiaries and affiliates.
Feature Creation Roadmaps

The types of features that can be created for each product

Figure 2: Feature Creation

Related Topics:
Feature Creation in AIM
Feature Creation in the Workbench Project Page
Feature Creation in DesignModeler
Feature Creation in Mechanical
Feature Creation in DesignXplorer

Feature Creation in AIM


In AIM, you can perform customization activities such as the addition of a preprocessing feature for a
structural analysis and the creation of a custom object to encapsulate and expose existing AFD features.

Topic Reference
Capabilities common to all target ACT Developers Guide > Feature Creation Capabilities >
applications
Common Capabilities

ACT-Based Properties

Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 13
Roadmaps for ACT Customization

Topic Reference
Capabilities specific to AIM ACT Developers Guide > Feature Creation Capabilities >
Capabilities for ANSYS AIM >

Adding a Pre-Processing Feature in ANSYS AIM


Structural

Creating a Custom Object to Merge Existing AFD


Features

Using SetScriptVersion Within ACT Extensions for AIM

Online HTML reference providing both Customer Portal > Downloads > ACT Resources > Help
API and XML information. & Support >

NOTE: This is the recommended ACT Online Reference Guide


version of reference documentation
for developers. ACT Download Reference Guide

Reference document providing API ANSYS ACT API Reference Guide


namespace information.
Reference document providing XML ANSYS ACT XML Reference Guide
definition and tagging information.

Feature Creation in the Workbench Project Page


In the Workbench Project page, you can perform common customization activities such as custom
toolbars and pop-up dialog creation, extension data storage, and ACT-based property and property
group definitions.

Topic Reference
Capabilities common to all target ACT Developers Guide > Feature Creation Capabilities >
applications
Common Capabilities

ACT-Based Properties

Feature Creation in DesignModeler


In DesignModeler, you can create custom Geometry Builder features.

Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
14 of ANSYS, Inc. and its subsidiaries and affiliates.
Feature Creation Roadmaps

Topic Reference
Capabilities common to all target ACT Developers Guide > Feature Creation Capabilities >
applications
Common Capabilities

ACT-Based Properties

Capabilities specific to DesignModeler ACT Developers Guide > Feature Creation Capabilities >
Capabilities for ANSYS DesignModeler >

Geometry Definition in the XML File

Geometry Definition in the IronPython File

DesignModeler API Usage Examples ACT Developers Guide > APIs Description > APIs for
ANSYS DesignModeler >

Using the Selection Manager in DesignModeler

Creating Primitives

Applying Operations

Online HTML reference providing both Customer Portal > Downloads > ACT Resources > Help &
API and XML information. Support >

NOTE: This is the recommended ACT Online Reference Guide


version of reference documentation
for developers. ACT Download Reference Guide

Reference document providing API ANSYS ACT API Reference Guide >
namespace information.
Ansys.ACT.Interfaces.DesignModeler Namespace

Ansys.ACT.Automation.DesignModeler Namespace

Reference document providing XML ANSYS ACT XML Reference Guide >
definition and tagging information.
<extension>

<simdata>

<Geometry>

Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 15
Roadmaps for ACT Customization

Feature Creation in Mechanical


In Mechanical, you can create custom preprocessing, postprocessing, and third-party solver features.

Topic Reference
Capabilities common to all ACT Developers Guide > Feature Creation Capabilities >
target applications
Common Capabilities

ACT-Based Properties

Capabilities specific to ACT Developers Guide > Feature Creation Capabilities >
Mechanical
Capabilities for ANSYS Mechanical >

Adding a Pre-Processing Feature in ANSYS Mechanical

Adding a Post-Processing Feature in ANSYS Mechanical

Creating Results with Imaginary Parts

Responding to a Change to the Active Unit System

Obsolete "OnStartEval" and "GetValue" Callbacks

Connecting to a Third-Party Solver

Mechanical API Usage ACT Developers Guide > APIs Description > APIs for ANSYS
Examples Mechanical >

Directly Accessing an Object

Handling Property Types

Customizing the User Interface and Existing Toolbars

Working with Command Snippets

Manipulating Fields for Boundary Conditions

Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
16 of ANSYS, Inc. and its subsidiaries and affiliates.
Feature Creation Roadmaps

Topic Reference
Mechanical Worksheets

Tree Object

Model Object

TraverseExtension

Graphical Views

Mechanical Extension ACT Developers Guide > Examples > Mechanical Extension
Examples Examples >

Von-Mises Stress as a Custom Result

An Edge-Node Coupling Tool

Online HTML reference Customer Portal > Downloads > ACT Resources > Help & Support >
providing both API and XML
information. ACT Online Reference Guide

NOTE: This is the ACT Download Reference Guide


recommended version of
reference documentation
for developers.
Reference document providing ANSYS ACT API Reference Guide >
API namespace information.
Ansys.ACT.Automation.Mechanical Namespace

Ansys.ACT.Automation.Mechanical.AnalysisSettings Namespace

Ansys.ACT.Automation.Mechanical.BoundaryConditions
Namespace

Ansys.ACT.Automation.Mechanical.Connections Namespace

Ansys.ACT.Automation.Mechanical.Enums Namespace

Ansys.ACT.Automation.Mechanical.ImportedLoads Namespace

Ansys.ACT.Automation.Mechanical.MeshControls Namespace

Ansys.ACT.Automation.Mechanical.Results Namespace

Ansys.ACT.Interfaces.Mechanical Namespace

Ansys.ACT.Mechanical.Fields Namespace

Reference document providing ANSYS ACT XML Reference Guide >


XML definition and tagging
information. <extension>

<simdata>

Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 17
Roadmaps for ACT Customization

Topic Reference
<load>

<object>

<result>

<solver>

Feature Creation in DesignXplorer


In DesignXplorer, you can integrate custom and external algorithms.

Topic Reference
Capabilities common to all target ACT Developers Guide > Feature Creation Capabilities >
applications
Common Capabilities

ACT-Based Properties

Capabilities specific to DesignXplorer ACT Developers Guide > Feature Creation Capabilities >

Capabilities for ANSYS DesignXplorer >

The Design Exploration Process

Implementing a DX Extension

Notes on Method Class Implementation

DesignXplorer API Usage Examples ACT Developers Guide > APIs Description > APIs for ANSYS
DesignXplorer >

DOE APIs

Optimization APIs

DesignXplorer Extension Examples ACT Developers Guide > Examples >

DOE Extension Examples

Optimization Extension Examples

Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
18 of ANSYS, Inc. and its subsidiaries and affiliates.
Simulation Workflow Integration Roadmap

Topic Reference
Online HTML reference providing both Customer Portal > Downloads > ACT Resources > Help &
API and XML information. Support >

NOTE: This is the recommended ACT Online Reference Guide


version of reference
documentation for developers. ACT Download Reference Guide

Reference document providing API ANSYS ACT API Reference Guide >
namespace information.
Ansys.DesignXplorer.API Namespace

Ansys.DesignXplorer.API.Common Namespace

Ansys.DesignXplorer.API.Optimization Namespace

Ansys.DesignXplorer.API.Sampling Namespace

Ansys.DesignXplorer.API.Automation Namespace

Reference document providing XML ANSYS ACT XML Reference Guide >
definition and tagging information.
<extension>

<simdata>

<extensionobject>

<optimizer>

Simulation Workflow Integration Roadmap


Simulation workflow integration is the customization of the workflow in the Workbench Project page.
You can create custom task groups (systems) and tasks (components) to facilitate interaction with the
Workbench Project Schematic.

Topic Reference
Capabilities specific to the ACT Developers Guide > Feature Creation Capabilities >
Workbench Project page Capabilities for Custom ACT Workflows in Workbench >

The Custom Workflow Creation Process

Creating the Extension Definition XML File

Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 19
Roadmaps for ACT Customization

Topic Reference
Creating the IronPython Script

Workbench Project Page Extension ACT Developers Guide > Examples > Custom ACT Workflows
Examples in Workbench Examples >

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

Appendices Containing Workbench ACT Developers Guide >


Custom Workflow Info
Appendix A. Component Input and Output Tables

Appendix B. ANSYS Workbench Internally Defined System


Template and Component Names

Appendix C. Data Transfer Types

Appendix D. Addin Data Types and Data Transfer Formats

Online HTML reference providing Customer Portal > Downloads > ACT Resources > Help &
both API and XML information. Support >

NOTE: This is the recommended ACT Online Reference Guide


version of reference
documentation for developers. ACT Download Reference Guide

Reference document providing API ANSYS ACT API Reference Guide >
namespace information.
Ansys.ACT.Interfaces.Common Namespace

Ansys.ACT.Interfaces.DataModel Namespace

Ansys.ACT.Interfaces.UserInterface Namespace

Ansys.ACT.Interfaces.UserInterface.Components Namespace

Ansys.ACT.Interfaces.UserObject Namespace

Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
20 of ANSYS, Inc. and its subsidiaries and affiliates.
Process Compression Roadmaps

Topic Reference
Reference document providing XML ACT XML Reference Guide >
definition and tagging information.
<extension>

<workflow>

<callbacks>

<property>

<propertygroup>

<propertytable>

<taskgroups>

<tasks>

Reference document providing ANSYS AIM and Workbench Scripting Guide


journaling and scripting information,
including product-specific data
container details.

Process Compression Roadmaps


Process compression customization is the encapsulation and automation of existing processes available
in an ANSYS product into a wizard. The following flowchart shows the products for which ACT process
compression capabilities are available. In AIM, wizards are called custom templates.

Click the links to navigate to the product that you want to customize.

Figure 3: Process Compression

Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 21
Roadmaps for ACT Customization

Related Topics:
Process Compression Common Topics
Process Compression in AIM
Process Compression in the Workbench Project Page
Process Compression in SpaceClaim
Process Compression in DesignModeler
Process Compression in Mechanical
Process Compression in Electronics Desktop
Process Compression in DesignXplorer
Process Compression in Fluent and Fluent Meshing
Process Compression for Multiple Applications (Mixed Wizards)

Process Compression Common Topics


The following table refers you to documentation topics that are common to the creation of wizards
and AIM custom templates.

Topic Reference
Types of wizards ACT Developers Guide > ACT Simulation Wizards >
Types of Wizards
Creating wizards ACT Developers Guide > ACT Simulation Wizards >
Creating Wizards
Installing and loading wizards ACT Developers Guide > ACT Simulation Wizards >
Installing and Loading Wizards
Using wizards ACT Developers Guide > ACT Simulation Wizards >
Using Wizards
Online HTML reference providing both API Customer Portal > Downloads > ACT Resources > Help
and XML information. & Support >

NOTE: This is the recommended ACT Online Reference Guide


version of reference documentation for
developers. ACT Download Reference Guide

Reference document providing API ANSYS ACT API Reference Guide >
namespace information. Ansys.ACT.Interfaces.Wizard Namespace
Reference document providing XML ACT XML Reference Guide >
definition and tagging information.
<extension>

<application>

<appstoreid>

<author>

<description>

<uidefinition>

<wizard>

Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
22 of ANSYS, Inc. and its subsidiaries and affiliates.
Process Compression Roadmaps

Topic Reference
Reference document providing journaling ANSYS AIM and Workbench Scripting Guide
and scripting information, including
product-specific data container details. Refer to the sections for the specific applications
being customized.

Process Compression in AIM


The following table refers you to documentation on creating custom templates to compress and automate
processes in ANSYS AIM.

Note

You can also automate an AIM simulation by running a Project wizard from the AIM Project
tab.

Topic Reference
Using AIM custom templates ACT Developers Guide > ACT Simulation Wizards
> Using Wizards > Using an AIM Custom Template
AIM Custom Template Examples ACT Developers Guide > Examples> Wizard
Examples >

Project Wizard (AIM Project Tab)

AIM Custom Template (Single-Step)

AIM Custom Template (Multi-Step)

Online HTML reference providing both API and Customer Portal > Downloads > ACT Resources >
XML information. Help & Support >

NOTE: This is the recommended version ACT Online Reference Guide


of reference documentation for developers.
ACT Download Reference Guide

Reference document providing API namespace ANSYS ACT API Reference Guide
information.
Reference document providing XML definition ANSYS ACT XML Reference Guide
and tagging information.
Reference document providing journaling and ANSYS AIM and Workbench Scripting Guide
scripting information, including product-specific
data container details. Refer to the Workbench section.

Process Compression in the Workbench Project Page


The following table refers you to documentation on creating wizards and AIM custom templates to or-
chestrate workflows on the Project Schematic.

Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 23
Roadmaps for ACT Customization

Topic Reference
Workbench Project Page Wizard Examples ACT Developers Guide > Examples > Wizard
Examples >

Project Wizard (Workbench Project Tab)

Project Wizard (AIM Project Tab)

Mixed Wizard

Online HTML reference providing both API and Customer Portal > Downloads > ACT Resources
XML information. > Help & Support >

NOTE: This is the recommended version of ACT Online Reference Guide


reference documentation for developers.
ACT Download Reference Guide

Reference document providing API namespace ANSYS ACT API Reference Guide
information.
Reference document providing XML definition ANSYS ACT XML Reference Guide
and tagging information.
Reference document providing journaling and ANSYS AIM and Workbench Scripting Guide
scripting information, including product-specific
data container details. Refer to the Workbench section.

Process Compression in SpaceClaim


The following table refers you to documentation on creating wizards to compress and automate processes
in the SpaceClaim application. Wizards can be run in SpaceClaim both when SpaceClaim is opened via
Workbench and when it is opened by itself.

Topic Reference
SpaceClaim Wizard Examples ACT Developers Guide > Examples >
Wizard Examples > SpaceClaim Wizard
Online HTML reference providing both API and XML Customer Portal > Downloads > ACT Resources
information. > Help & Support >

NOTE: This is the recommended version of ACT Online Reference Guide


reference documentation for developers.
ACT Download Reference Guide

Reference document providing API namespace ANSYS ACT API Reference Guide
information.
Reference document providing XML definition and ANSYS ACT XML Reference Guide
tagging information.
Reference document providing journaling and ANSYS AIM and Workbench Scripting Guide
scripting information, including product-specific
data container details. Refer to the SpaceClaim section.

Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
24 of ANSYS, Inc. and its subsidiaries and affiliates.
Process Compression Roadmaps

Process Compression in DesignModeler


The following table refers you to documentation on creating wizards to compress and automate processes
in the DesignModeler application.

Topic Reference
DesignModeler Wizard Examples ACT Developers Guide > Examples > Wizard
Examples > DesignModeler Wizard
Online HTML reference providing both API and XML Customer Portal > Downloads > ACT Resources
information. > Help & Support >

NOTE: This is the recommended version of ACT Online Reference Guide


reference documentation for developers.
ACT Download Reference Guide

Reference document providing API namespace ANSYS ACT API Reference Guide
information.
Reference document providing XML definition and ANSYS ACT XML Reference Guide
tagging information.
Reference document providing journaling and ANSYS AIM and Workbench Scripting Guide
scripting information, including product-specific
data container details. Refer to the DesignModeler section.

Process Compression in Mechanical


The following table refers you to documentation on creating wizards to compress and automate processes
in the Mechanical application.

Topic Reference
Mechanical Wizard Examples ACT Developers Guide > Examples > Wizard
Examples >

Mechanical Wizard

Mixed Wizard

Online HTML reference providing both API and XML Customer Portal > Downloads > ACT Resources
information. > Help & Support >

NOTE: This is the recommended version of ACT Online Reference Guide


reference documentation for developers.
ACT Download Reference Guide

Reference document providing API namespace ANSYS ACT API Reference Guide
information.
Reference document providing XML definition and ANSYS ACT XML Reference Guide
tagging information.
Reference document providing journaling and ANSYS AIM and Workbench Scripting Guide
scripting information, including product-specific
data container details. Refer to the Mechanical section.

Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 25
Roadmaps for ACT Customization

Process Compression in Electronics Desktop


The following table refers you to documentation on creating wizards to compress and automate processes
in the Electronics Desktop application. Wizards can be run in Electronics Desktop both when Electronics
Desktop is opened via Workbench and when it is opened by itself.

Topic Reference
Accessing the ACT Start Page in Electronics ACT Developers Guide > Using Extensions >
Desktop Using the ACT Start Page > Accessing the ACT
Start Page
Electronics Desktop Wizard Examples ACT Developers Guide > Examples > Wizard
Examples > Electronics Desktop Wizard
Online HTML reference providing both API and Customer Portal > Downloads > ACT Resources
XML information. > Help & Support >

NOTE: This is the recommended version of ACT Online Reference Guide


reference documentation for developers.
ACT Download Reference Guide

Reference document providing API namespace ANSYS ACT API Reference Guide
information.
Reference document providing XML definition ANSYS ACT XML Reference Guide
and tagging information.
Reference document providing journaling and ANSYS AIM and Workbench Scripting Guide
scripting information, including product-specific
data container details. Refer to the Electronics Desktop section.

Process Compression in DesignXplorer


The following table refers you to documentation on creating wizards to compress and automate processes
in the DesignXplorer application.

Topic Reference
Online HTML reference providing both API and XML Customer Portal > Downloads > ACT
information. Resources > Help & Support >

NOTE: This is the recommended version of ACT Online Reference Guide


reference documentation for developers.
ACT Download Reference Guide

Reference document providing API namespace ANSYS ACT API Reference Guide
information.
Reference document providing XML definition and ANSYS ACT XML Reference Guide
tagging information.
Reference document providing journaling and ANSYS AIM and Workbench Scripting Guide
scripting information, including product-specific data
container details. Refer to the Design Exploration section.

Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
26 of ANSYS, Inc. and its subsidiaries and affiliates.
Process Compression Roadmaps

Process Compression in Fluent and Fluent Meshing


The following table refers you to documentation on creating wizards to compress and automate processes
in the Fluent and Fluent Meshing applications. Wizards can be run in Fluent and Fluent Meshing either
when they are opened via Workbench or when opened by themselves.

Topic Reference
Fluent Wizard Examples ACT Developers Guide > Examples > Wizard
Examples >

Fluid Wizard (.msh Input File)

Fluid Wizard (.cas Input File)

Online HTML reference providing both API and Customer Portal > Downloads > ACT Resources
XML information. > Help & Support >

NOTE: This is the recommended version of ACT Online Reference Guide


reference documentation for developers.
ACT Download Reference Guide

Reference document providing API namespace ANSYS ACT API Reference Guide
information.
Reference document providing XML definition and ANSYS ACT XML Reference Guide
tagging information.
Reference document providing journaling and ANSYS AIM and Workbench Scripting Guide
scripting information, including product-specific
data container details. Refer to the FLUENT section.

Process Compression for Multiple Applications (Mixed Wizards)


The following table refers you to documentation on creating mixed wizards, which are executed across
multiple target applications. A mixed wizard begins with the Workbench Project Schematic and engages
any data-integrated application with Workbench journaling and scripting capabilities, such as Design-
Modeler or Mechanical.

Topic Reference
Mixed Wizard Example ACT Developers Guide > Examples > Wizard
Examples > Mixed Wizard
Online HTML reference providing both API and Customer Portal > Downloads > ACT Resources
XML information. > Help & Support >

NOTE: This is the recommended version of ACT Online Reference Guide


reference documentation for developers.
ACT Download Reference Guide

Reference document providing API namespace ANSYS ACT API Reference Guide
information.
Reference document providing XML definition and ANSYS ACT XML Reference Guide
tagging information.

Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 27
Roadmaps for ACT Customization

Topic Reference
Reference document providing journaling and ANSYS AIM and Workbench Scripting Guide
scripting information, including product-specific
data container details. Refer to the sections for applications
included in the wizard.

Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
28 of ANSYS, Inc. and its subsidiaries and affiliates.