External Connection Add-In
ANSYS, Inc.
Southpointe
275 Technology Drive
Canonsburg, PA 15317
ansysinfo@ansys.com
http://www.ansys.com
(T) 724-746-3304
(F) 724-514-9494
Release 15.0
November 2013
ANSYS, Inc. is
certified to ISO
9001:2008.
Copyright and Trademark Information
© 2013 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 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, please contact ANSYS, Inc.
Published in the U.S.A.
Table of Contents
Introduction to the External Connection Add-In ....................................................................................... 1
Overview ............................................................................................................................................... 1
Integrating an External Application ......................................................................................................... 4
External Process Responsibilities ....................................................................................................... 5
Customizing the Workbench User Interface ............................................................................................. 5
Custom Toolbar and Menu Entries ..................................................................................................... 5
Creating Custom External Connection Systems and Components ............................................................ 7
General Workflow ................................................................................................................................... 7
System File Layout and Installation ......................................................................................................... 7
Creating System Definition Files .............................................................................................................. 8
Creating Component Configuration Files ................................................................................................ 8
Defining Inputs and Outputs ............................................................................................................ 9
Creating Update Instructions for Producing or Consuming Data ........................................................ 9
Upstream Data Consumption (Input) ......................................................................................... 10
Data Generation (Output) ......................................................................................................... 10
Convenience Queries ................................................................................................................ 10
Configuration XML File Details ................................................................................................................. 11
Configuration Node .............................................................................................................................. 11
Instructions Node ................................................................................................................................. 11
Format ........................................................................................................................................... 12
Attributes ....................................................................................................................................... 12
GuiOperations Node ............................................................................................................................. 14
Format ........................................................................................................................................... 14
Attributes ....................................................................................................................................... 15
Properties Node ................................................................................................................................... 16
Format ........................................................................................................................................... 17
Attributes ....................................................................................................................................... 17
DataEntity ................................................................................................................................ 17
Object ...................................................................................................................................... 17
Properties ................................................................................................................................. 17
External Connection Examples ................................................................................................................. 21
Custom, Lightweight, External Application Integration ........................................................................... 21
File Structure .................................................................................................................................. 22
Component Configuration XML File ................................................................................................ 22
User Interface Button Definition ............................................................................................................ 23
File Structure .................................................................................................................................. 23
UI Configuration XML File ............................................................................................................... 23
Instruction File ................................................................................................................................ 24
Mesh Transfer System ........................................................................................................................... 24
File Structure .................................................................................................................................. 24
System Definition XML File .............................................................................................................. 25
Component Configuration File ....................................................................................................... 25
Update Instruction ......................................................................................................................... 26
Material Transfer .................................................................................................................................. 26
File Structure .................................................................................................................................. 27
System Definition XML File .............................................................................................................. 27
Component Configuration File ....................................................................................................... 28
Update Instruction ......................................................................................................................... 28
Material File ................................................................................................................................... 28
Custom Transfer System ........................................................................................................................ 29
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
iii
External Connection Guide
File Structure .................................................................................................................................. 29
Producer System Definition XML File ............................................................................................... 30
Producer Component Configuration File ........................................................................................ 30
Producer Update Instruction .......................................................................................................... 31
Consumer System Definition XML File ............................................................................................. 31
Consumer Component Configuration File ....................................................................................... 31
Consumer Update Instruction ........................................................................................................ 31
A. Data Transfer Types ................................................................................................................................. 33
Data Transfer Types .............................................................................................................................. 33
B. ANSYS Workbench Component Inputs and Outputs ................................................................................. 39
Component Input and Outputs Table .................................................................................................... 39
Index .......................................................................................................................................................... 89
iv
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Introduction to the External Connection Add-In
The following section describes the ANSYS Workbench External Connection Add-in and how you can
use it within an ANSYS Workbench workflow.
Overview
Integrating an External Application
Customizing the Workbench User Interface
Overview
The External Connection Add-in enables you to integrate custom, lightweight, external applications and
processes into the ANSYS Workbench Project Schematic workflow. Features exposed by the External
Connection also allow you to perform automation and customization activities.
With the External Connection, you can:
• Integrate custom, lightweight, external applications.
• Define User Interface (UI) elements, such as buttons in the Workbench Toolbar or entries in custom
menus, and create the scripts that enable them.
• Create new systems to facilitate interaction with the Workbench Project Schematic.
The External Connection Add-in provides an External Connection system in the External Connection
Systems toolbox. The system contains a single External Connection component that acts as a proxy
for the external application.
Figure 1: External Connection System Cell in Toolbox
After you drag an External Connection system into the Workbench Project Schematic window, the External Connection component appears in an Edit Required state, indicated by a question mark, until
you update it with a Component Configuration file.
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
1
Introduction to the External Connection Add-In
Figure 2: Read Configuration Menu
In the figure below, the External Connection reads the Configuration file SquaresConfig.xml, which
provides integration details for an external application that calculates square values that are then displayed in the System Parameters. See Custom, Lightweight, External Application Integration (p. 21) for
more details.
Figure 3: Squares Example Schematic View
The following figure shows an External Connection that adds a functional button to the toolbar. See
User Interface Button Definition (p. 23) for more details.
2
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Overview
Figure 4: Button Definition Example
The figure below shows a Mesh Transfer system that consumes an upstream mesh and passes it to a
downstream Fluent system. See Mesh Transfer System (p. 24) for more details.
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
3
Introduction to the External Connection Add-In
Figure 5: End-to-End Mesh Transfer Between Mesh, Mesher, and Fluent Setup
Integrating an External Application
The External Connection Addin provides, by default, a single-component External Connection system
in the External Connection Systems toolbox. This system acts as a proxy for the external application,
enabling the external application to define and expose input and output parameters within the Workbench Schematic window. You can manipulate these External Connection-defined parameters in the
same way as standard Workbench parameters – for example, in terms of design point creation, update,
and state. Specifically, the External Connection add-in allows you to use the Design Exploration application’s design exploration capabilities with any external application.
Every External Connection system exposes a Read Configuration GUI operation as a component context
menu. This GUI operation’s underlying command reads a Component Configuration XML file which
contains all the information that the external process wants to provide to Workbench (see "Configuration
XML File Details" (p. 11) for more information). At minimum, the configuration file contains the following
elements:
• The definition of input and output parameters, including the parsing rules for reading the values from a
file.
• An OS executable or a Python script to be executed during the component Update command. Python
scripts execute within the Workbench Python interpreter; as a result, scripts have full access to the
scriptable Workbench API (Journaling and Scripting).
External Connection reads and stores all the information defined within the Component Configuration
file. You may access the stored configuration information through the Edit Configuration GUI operation
on the external connection component context menu. Only infrastructure/integration changes within
4
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Customizing the Workbench User Interface
the external application should result in configuration file changes; otherwise, users should not modify
loaded configuration settings.
When you invoke an Update on the External Connection component, the add-in:
1. Writes the current input parameter values to the file specified in the Component Configuration file
2. Launches the external application
Upon the completion of the external application, the add-in:
1. Verifies successful execution (and sends an error message if it was not successful)
2. Reads the current output parameter values provided by the external application in the file location specified in the Component Configuration file.
After you read a Component Configuration file into an External Connection component, Workbench
disables the Read Configuration GUI Operation. The Reset GUI operation, also a context menu on an
External Connection component, discards the imported configuration information. Workbench re-enables
the Read Configuration GUI operation upon Reset as you must load a new Component Configuration
file to proceed.
External Process Responsibilities
An external process must, at minimum:
• Provide a configuration file that contains two elements:
– The input/output parameter processing definitions
– The update script or OS executable name
• Read the input parameters from the input file.
• Execute a solve/update of the external process.
• Write the computed output parameter values to the output file.
Customizing the Workbench User Interface
The External Connection Add-in provides customization functionality beyond project schematic workflow
interaction. You can define custom User Interface entries and underlying instructions to perform miscellaneous tasks, including process automation and lightweight vertical applications. This section provides
information on how you can use the External Connection to customize the Workbench User Interface.
Custom Toolbar and Menu Entries
You can enrich the external connection functionality by defining custom toolbar and menu entries
within the Workbench User Interface. Workbench reads in a user interface-specific configuration file,
independent of any defined Component Configuration files, at add-in load time, from either an installation- or user-specific location. A UI-based configuration file located in the installation area results in
Workbench exposing additional custom entries for every user who accesses the installed ANSYS Workbench application. On the other hand, a file located in the user-specific area will result in additional
custom entries only appearing for that specific user. In either case, the content of the user-specific custom
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
5
Introduction to the External Connection Add-In
files takes precedence over the custom installation files. If UI configuration files exist in both locations,
workbench first examines and loads the user-specific entries and then processes installation entries
(ignoring duplicates).
The custom User Interface configuration file format shares the same syntax as the Component Configuration files used with External Connection components. However, only the GUI operation section and
elements remain relevant. If you provide content from other sections, Workbench will ignore it (see
“Configuration XML File Details” for element descriptions and examples).
You must place custom installation files in the ExternalConnection directory under v150/Addins
(for example C:\Program Files\Ansys Inc\v150\Addins\ExternalConnection). The
user-specific custom file location depends upon the operating system:
• for Windows machines, you should create a directory named ExternalConnection under %APPDATA%\Ansys\v150.
• for Linux machines, you should create a directory named ExternalConnection under $HOME/.config/Ansys/v150.
You must create a directory named Customization under the above ExternalConnection folder to
utilize the custom UI functionality within the External Connection Addin. Finally, you must name your
custom UI configuration file (which contains the information about the custom UI entries) CustomToolBarConfiguration.xml and place it under the new Customization folder. You may additionally require
folders named Images and Scripts under the Customization directory if your custom UI entries use
images or scripts, as defined in your UI configuration file.
The custom entries defined within the UI configuration file invoke either in-line C# code snippets or
python script files. Typically, External Connection users define python script files as they have full access
to the Workbench Scripting APIs. You can use a combination of custom UI entries and scripts to support
process automation, wizard-like dialogs, and custom lightweight vertical applications.
Note
Toolbar buttons may not appear in Workbench by default. If your External Connection-defined
UI entry does not appear, select the corresponding Toolbar group menu entry from the
View>Toolbars menu.
6
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Creating Custom External Connection Systems and Components
You can define custom External Connection-based systems and components. This functionality helps
deliver features previously available only through the ANSYS Workbench SDK in a more user-friendly,
less technical fashion.
This section discusses how you can create the various files required to expose custom External Connection
systems and components. The following topics are covered:
General Workflow
System File Layout and Installation
Creating System Definition Files
Creating Component Configuration Files
General Workflow
The general workflow for creating a custom External Connection System includes:
1. Create a System Definition File.
2. Create any necessary Component Configuration XML files. The files optionally can contain:
• Python scripts
• Operating System (OS) Executables
• Images
3. Add the files to the appropriate installation directories.
4. Manipulate External Connection system cells within Workbench to add them to your workflow.
System File Layout and Installation
All the files for a single system should reside in the same directory. A single directory should, at least,
contain the System Definition XML file and the Component Configuration XML Files.
Optionally, the directory can contain:
• Python Scripts
• Executables
• System and Component Images
For example, a directory C:\Program Files\Ansys Inc\v150\Addins\ExternalConnection\SystemDefinitions might contain the following files:
\MySystem
\MySystem\MySystem.xml
\MySystem\MyComponent.xml
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
7
Creating Custom External Connection Systems and Components
\MySystem\update.py
\MySystem\Images\system.png
\MySystem\Images\component.png
Creating System Definition Files
The System Definition file contains information to create an ANSYS Workbench system designed for a
particular simulation objective. All analyses performed within Workbench begin by referencing a system
template.
This XML file describes the System and declares all components contained by the system.
System Definition files must specify, at minimum:
• The system name
• The component name and Input Type for a component. The Input Type can be empty.
At the System level, you can optionally specify:
• Display text
• Abbreviation
• Image name
• Toolbox group
At the Component level, you can optionally specify:
• Display text
• Image name
At the Input/Output level, you can optionally specify a Data Type.
The following is an example of the basic structure of a System Definition file:
<System name="system_name">
<Components>
<Component name="component_name">
<Inputs>
<Input/>
</Inputs>
<Component>
</Components>
</System>
Creating Component Configuration Files
Component Configuration files contain both parameter and instructional information, including key
commands associated with a specific component. A Component Configuration file follows the same
format and delivers the same functionality as the Configuration files discussed earlier in the section,
Integrating an External Application (p. 4).
Components within Workbench stay in an Edit Required state (displaying the question mark icon) until
the user selects a Component Configuration file using the Read Configuration Component Context
menu.
8
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Creating Component Configuration Files
Figure 6: Component File with Read Configuration Menu Exposed
Defining Inputs and Outputs
Workbench Schematic connections serve as visual representations of data flow between components.
These connections depend on input and output coordination. Workbench can only establish connections
if an upstream (providing) component exposes outputs whose types also match the inputs for a
downstream (consuming) component. These input and output specifications must be made within the
Component nodes of the System Definition file. At minimum, a component should always specify an
empty input (<Input/>).
Certain Workbench types require the use of the dataType attribute. For example, the Mesh component
uses dataType to determine which mesh file format to output (for example, Fluent).
In the following example, the FluentMesh data type value instructs an upstream mesh component
to output the Fluent mesh file format (.msh).
This example defines the inputs and outputs for a component within a Fluent meshing workflow:
<Component name="Mesher" displayText="Mesher" imageName="GenericMesh_cell">
<Inputs>
<Input/>
<Input dataType="FluentMesh">MeshingMesh</Input>
</Inputs>
<Outputs>
<Output dataType="FluentMesh">SimulationGeneratedMesh</Output>
</Outputs>
<component/>
For a list of supported transfer types and their corresponding transfer properties, seeTable 1: Data
Transfer Types and Properties (p. 33).
Creating Update Instructions for Producing or Consuming Data
If any component produces or consumes data, you must supply an Update routine that processes input
and output types as declared by the system definition file. For a table of supported component inputs
and outputs, see the Component Input and Outputs Table in Appendix B.
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
9
Creating Custom External Connection Systems and Components
Upstream Data Consumption (Input)
Typically, components need to implement complex source handling logic, connection tracking routines,
and a refresh procedure in order to consume data. However, the External Connection Addin handles
all of these actions. It obtains upstream data and stores it in a dictionary accessible during the component
Update. The component can obtain this data by calling External Connection-exposed convenience
queries.
Data Generation (Output)
Components that produce output data (for example, declare output types in the system definition file)
must ensure that their custom Update routine assigns output data. The External Connection Addin
prepares empty data objects representing component outputs; the user must only set the correct
transfer properties that downstream consumers will interrogate. Refer to Table 1: Data Transfer Types
and Properties (p. 33) to determine which properties you must set. For example, a material transfer to
a downstream Engineering Data component must set the DataReference TransferFile property
on a MatML31 data object to the file reference of a registered matml-formatted XML file–all completed
during the Update routine.
Convenience Queries
Convenience queries are Python queries that provide simple access to component-stored input and
output data. The three types of convenience queries are:
• GetInputData
Returns a Dictionary containing input-type keys and data-containing property-based values. For
example:
Dictionary<string, Dictionary<string, object>>> upstreamData = GetInputData(container);
Dictionary<string, object> meshData = upstreamData[“MeshingMesh”];
DataReference meshFile = (DataReference)meshData[“TransferFile”];
• GetInputDataByType
Returns a Dictionary<string,object> containing upstream data for a given type. For
example:
Dictionary<string, object> geometryData = GetInputDataByType(container, “Geometry”);
DataReference geomFile = (DataReference)geometryData[“GeometryFileReferene”];
DataReferenceSet auxFiles = (DataReferenceSet)geometryData[“AuxiliaryFiles”];
• GetOutputData
Returns a Dictionary<string, DataReference> holding the component’s output types.
For example:
Dictionary<string, DataReference> outputs = GetOutputData(container);
DataReference meshOutput = outputs[“SimulationGeneratedMesh”];
10
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Configuration XML File Details
The Configuration XML file contains an <Instructions> XML node where you define the information
needed for parameter initialization and component update. In addition to the instructions, you can
define the following elements in the configuration file:
• GUI operations that execute from a component’s context menu or from a custom toolbar or menu entry.
Each GUI operation can either define inline C# code or specify a Python script.
• One or more set of data entities with properties. You can access these properties from the Python scripts
invoked for update or custom GUI operations.
Configuration XML files are used for both the External Connection component and UI configuration
files. Detailed documentation of the configuration file is provided in the following sections.
Configuration Node
The <Configuration> node contains the <Instructions> , <GUIOperations>, and <Properties> nodes.
<Configuration>
</Configuration>
The <Configuration> node allows you to specify the following optional attributes:
• SystemName - The user-visible string that is assigned to the system.
• CellName - The user-visible string that is assigned to the cell.
• Version - The version associated with the configuration file.
• ShowEditConfiguration - Specifies whether the user can view and modify the entries provided
in the configuration file.
Instructions Node
The global <Instructions> XML node contains all the information related to initialization (including
parameters definition) and update. A Working Directory is defined inside the<Instructions> node
as described below:
<Instructions WorkingDirectory="[Directory Name]">
</Instructions>
The <Instructions> node allows you to specify the following optional attribute:
• [WorkingDirectory] — The path of the Working Directory, with or without the trailing slash.
This attribute is optional. If the Working Directory is not specified, the default Working Directory determined by Workbench will be used (typically, project_files/dpx/Ex/Ext, where dpx is the
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
11
Configuration XML File Details
active design point). The Working Directory is also used to search for files defined in other sections
of the configuration file if a full path to the file is not provided.
Note
To ensure project portability, the External Connection Add-in no longer uses the working
directory after you save the Workbench project. When the project is saved, External Connection
copies the Configuration file and all external files (scripts, parameter files, etc.) referred to
by the Configuration file into a unique directory inside the project directory. The unique
directory corresponds to the system from where you invoked the Read Configuration action
(for example, project_files/dpx/Ex/Ext, where dpx is the active design point). This
directory becomes the working directory for the saved project. Since the project directory
now contains all the Configuration-related files, you can archive the project and then re-open
it even when the external files are not accessible.
Format
The <Instructions> node has the following format:
<Instruction Type="[Instruction Type]">
<Name>[Plug-In Name]</Name>
<ExePath>[Executable Path]</ExePath>
<ErrorFile>[Error File]</ErrorFile>
<CheckOnError>[Error String]</CheckOnError>
<Args>[Args]</Args>
<Script>[Script]</Script>
<InterruptScript>[Interrupt Script]</InterruptScript>
<StopScript>[Stop Script]</StopScript>
<ParameterParsingRules>
<[Node Name] Name="[Parameter Name]" Type="[Type]">
<[Rule Name]Type="[Rule Type]">[Value]</[Rule Name]>
</[Node Name]>
</ParameterParsingRules>
</Instruction>
Attributes
The <Instructions> node has the following attributes:
Attributes
• [Instruction Type] - The type that determines where the instruction will be executed.
Init - The parameter will be executed when the configuration is read.
Update - The parameter will be executed when the project is updated.
• [Plug-In Name]- The user-defined name of the generic plug-in. This name must be unique throughout
the instruction file. It defines a way for the Workbench environment to identify this instance of the generic
plug-in, because it is possible to have several instances (several third party applications or codes) of the
third party plug-in in the process sequence.
• [Executable Path] - The location of the executable file with which the third-party plug-in will interact.
This can be either the full path or the relative path of the executable with respect to the Working Directory
for the instruction file.
12
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Instructions Node
• [Error File] - A file used to communicate that the execution of the external application was not
successful. The error file needs to be removed by the external application upon completion. If still present,
Workbench will send an error message and stop the update. The content of the error message can be
specified through the attribute CheckOnError (see below). A generic message is displayed if CheckOnError is not specified.
• [Error String] - If an error file is specified, its content will be scanned for lines that contain the
specified error string. All lines that contain the string will be displayed as error messages (with the error
string stripped from the message). An error string named file will cause the whole content of the file to
be displayed.
• [Args] - The command line arguments passed to the executable when run.
• [Script] - The Python script to be interpreted within the Workbench framework on execution of this
instruction if the ExePath is not defined. The Python script has access to the following variables:
– container - A string that can be passed to any command or query that requires a data container
reference parameter.
– configurationObject - The configuration object can be used to access some of the information
specified in the configuration file (for example, Working Directory or error file). The query GetEntityProperties(Entity=configurationObject) returns a dictionary which contains all the
available configuration information.
• [Interrupt Script] - An optional Python script that is invoked when the computation is interrupted.
In Workbench terminology, the Interrupt operation closes the external application cleanly, allowing access
to data. The Interrupt operation is visible only if the Interrupt script is provided.
• [Stop Script] - An optional Python script that is invoked when the computation is stopped. In
Workbench terminology, the Stop operation abruptly closes the external application, possibly resulting
in the loss of data. The Stop operation is visible only if the Stop script is provided. The same script can
be used for Stop and Interrupt . Both scripts have access to the same information (strings container
and configurationObject) that is passed to the update script.
• [Node Name] - A name given to the XML node that defines the parsing information for a single parameter. This name does not have to be unique but must adhere to the naming rules for XML nodes (for
example, no spaces or special characters).
• [Parameter Name] - A unique name that represents a single parameter in the Workbench environment.
This is the name that will be used to identify the parameter throughout the UI.
• [Type] - The general type of the parameter. It must be one of two possible values:
– Input - The parameter will be treated as an input parameter, exactly as input parameters are handled
in the Workbench environment.
– Output - The parameter will be treated as an output or response parameter in the Workbench environment. When chaining generic plug-ins together, each instance of the generic plug-in can contain
input and output parameters.
• [Rule Name] - A name given to the XML node that represents a single parsing rule for the parameter
defined by the rule's parent node. This name does not have to be unique, but must adhere to the naming
rules for XML nodes (for example, no spaces or special characters). Multiple rules can (and in most cases
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
13
Configuration XML File Details
must) be defined for each parameter. The only restriction is that only one rule of each type (detailed below)
can exist for each parameter.
• [Rule Type] - The type of the defined rule. This can be one of the following values:
– File - The file rule defines the text file that contains the parameter value. This file can be the full path
to the file, or the relative path to the file with respect to the Working Directory. Files containing Input
type parameters must exist when reading the configuration file.
– StartLine - The line number in the text file that the code will begin parsing. For example, if the first
500 lines of a file contain only comments, begin parsing the file at line 501 to avoid wasting system
resources. The start line is 1 based; therefore, a value of 0 or 1 will be treated in the same way.
– PreString - The text that immediately precedes the actual parameter value in the file. For example,
if the file defines a parameter as "Cf = 12.555" the PreString for the parameter would be "Cf
=". This text does not need to include any white space immediately preceding the parameter value.
– DataType - The type of data that represents the parameter. The DataType must be one of the following values.
1. float — The value of the parameter is a floating point (decimal) number. This is used for continuous
variables.
2. double — The value of the parameter is a double.
3. quantity — The value of the parameter is a quantity containing a numeric value with units in
the form value [unit] (for example, “20 [m s^-1]”).
– SkipOccurrences - The number of PreString occurrences to skip before parsing begins.
• [Value]- The value of the rule. No quotes are needed to delimit this value, as per the XML parsing rules.
For example, a SkipOccurrences node would look like
<Rule Type="SkipOccurrences">3
</Rule>
where "3" is the [Value] for the rule, signifying that 3 lines should be skipped in the file before
searching for the parameter.
GuiOperations Node
You can add custom GUI operations to the context menu of an External Connection component. You
can also add custom toolbar buttons or entries in a custom menu. These custom operations support
script or C# code definition to execute upon operation invocation.
<GuiOperations>
</GuiOperations>
Format
The <GuiOperations> node has the following format:
<GuiOperation Name="[Operation Name]" Priority="[Priority]" SourceType="[SourceType]"
Type="[Type]" Entry="[Entry]" ScriptFile="[Script]" Image="[Image]" Tooltip="[Tooltip]">
<Code>[Code]</Code>
</GuiOperation>
14
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
GuiOperations Node
Attributes
The <GuiOperations> node has the following attributes:
• [Operation Name] - The name shown in the context menu.
• [Priority] - The weighted value determining the location within the context menu, the toolbar or the
menu where the GUI operation is defined.
• [SourceType] - The type of code being used to define the response behavior for operation execution.
– CSharp - The code will be written in C#.
– Python - The code will be written in Python.
• [Type] - The type specifies where the GUI operation should be placed in the user interface. The allowed
types are:
– ContextMenuEntry - This is the default type and should be specified in order to define GUI operations
that are shown upon Right Mouse Button selection of a component in an External Connection system.
ContextMenu should NOT be specified for operations defined in configuration files located in the installation area or in the user specific area since it is not possible to associate them with a specific cell.
– ToolbarButton - The type ToolbarButton should be used for creating custom entries in the
toolbar. You can define a toolbar group using the attribute Entry defined below. This type should
NOT be specified for GUI operations defined on the component configuration file. It is reserved for UIspecific configuration files that are processed at add-in load from the installation or user specific areas.
– MenuEntry - The type MenuEntry should be used for creating custom entries in Menu. The newly
created Menu Entry is specified via the attribute Entry defined below. This type should NOT be specified
for GUI operations defined on the component configuration file. It is reserved for UI-specific configuration
files that are processed at add-in load from the installation or user specific areas.
• [Entry] - The Entry attribute is relevant only in conjunction with a specified Type=MenuEntry or
Type=ToolbarButton. It defines the name of a new menu entry or Toolbar group where the GUI operation is shown. For menu entries, it is also possible to define sub-menus of a given menu as comma
separated values. For example, specifying Entry as "NewMenu, SubMenu1" will result in the GUI operation
appearing from a sub-menu "SubMenu1" of a Menu Entry "NewMenu"
• [Code] - The code defined inside the configuration file, rather than a separate file:
<GuiOperations>
<! - Code can either be loaded from a file with the "ScriptFile" attribute,
or be included in a "Code" tag - >
<GuiOperation Name="Enter Something" Priority="2" SourceType="CSharp">
<Code>
<![CDATA[
Ansys.UI.Toolkit.MessageBox.Show("This is a test");
]]>
</Code>
• [Script]- The path to a Python script to be run on execution of the operation. Specification of the
script cannot be combined with execution of custom code. Therefore a script should not be included if
code is defined inside the tags of the GuiOperation node. Scripts invoked from a GUI operation defined
on the ContextMenu of the cell have access to the following variables:
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
15
Configuration XML File Details
– container - A string that can be passed to any command or query that requires as a parameter the
reference to the data container associated with the component.
– configurationObject - The configuration object can be used in order to access some of the information specified in the configuration file (for example, a working directory or error file). The query
GetEntityProperties(Entity=configurationObject)returns a dictionary which contains
all the available configuration information.
When the GUI operation invokes a script, the invocation of the script is wrapped in a command. It is
possible to specify scripts to be executed in order to interrupt or cancel the execution of the command.
It is also possible to specify an error file to provide messages when the command execution fails, with
the same control on the error display that is provided for the update. A detailed description of the attributes is given below:
1. InterruptScript=[string]— An optional Python script that is invoked when the computation is
interrupted. In Workbench terminology, the Interrupt operation closes the external application cleanly,
allowing access to data. The Interrupt operation is visible only if the Interrupt script is provided.
2. StopScript=[string]— An optional Python script that is invoked when the computation is stopped.
In Workbench terminology, the Stop operation abruptly closes the external application, possibly resulting
in the loss of data. The Stop operation is visible only if the Stop script is provided. The same script can
be used for Stop and Interrupt . The script has access to the same information (strings container and
configurationObject) that is passed to the executing script.
3. ErrorFile=[string] — A file used to communicate that the execution of the GUI operation was
not successful. The error file needs to be removed by the GUI operation upon completion. If it is still
present, Workbench will send an error message. The content of the error message can be specified
through the attribute CheckOnError (see below). A generic message is displayed if CheckOnError is not
specified.
4. CheckOnError=[string] — If an error file is specified, its content will be scanned for lines that
contain the specified error string. All lines that contain the string will be displayed as error messages
(with the error string stripped from the message). An error string named file will cause the whole content
of the file to be displayed.
5. UseUpdateConfiguration=[boolean] — This variable can be specified as a shortcut, in order to
use for the custom GUI operation the same files specified in the Update instructions for stop/interrupt
and for controlling the error message display. If the attribute is True and the attributes above are not
specified, the code will use the ones provided for the first update instruction, if specified.
• [Image] - The name (without extension) of a file containing an image to be used for the GUI operation.
Files with common extension for images are searched under the Images directory under External Connection add-in. If a Customization directory is provided under the installation or user specific area,
the corresponding Images directories are also searched for the specified file.
• [Tooltip] – A string to be displayed as the Tooltip for ToolbarButton type operations. The string
has no effect for other operation types.
Properties Node
You can define custom properties in the <Properties> XML node.
Properties are used to create dynamic data objects in Workbench; therefore, their definitions reflect the
internal organization of the Workbench data model. Properties should be assigned a DataEntity and
16
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Properties Node
an ObjectName. The DataEntity is a string that defines high level grouping for the properties. One
or more objects can be created for a given DataEntity.
A DataObject “ObjectName” (as defined by its DataEntity and properties) is added to the container associated with the cell from which the configuration is read. If different External Data systems
are present, each has a separate container.
Format
The <Properties> node has the following format:
<Properties>
<DataEntity Name= “[ Data Entity Name ]” Label = “[ Data Entity Label ]” >
<Object Name= “[ Data Object Name ]” >
<Property Name= “[ Property Name ]” Label= “[ Property Label ]” DataType= “[ Data
Value= “[Value]”
Group = “[ Group ]” IsReadOnly = “[ IsReadOnly ]”
IsExtrinsic = “[ IsExtrinsic ]” IsVisible = “[ IsVisible ]”
Min = “[ Min ]” Max = “[ Max ]”
OptionLabels = “[ Option Labels ]”/>
</Object>
</DataEntity>
</Properties>
Type ]”
Attributes
DataEntity
• [Data Entity Name] - The internal (immutable) name assigned to the Data Entity. If this attribute is
not specified, a default name is assigned internally. However, specification of a name allows for the retrieval
of the properties associated with objects of the Data Entity (see below). A special name “CellProperties”
is reserved for the DataEntity whose properties should be displayed in the user interface from the
context menu of the associated cell.
• [Data Entity Label] - The display name (user changeable) assigned to the Data Entity in the user
interface.
Object
[Data Object Name] - The internal (immutable) name assigned to the Data Object. If this attribute
is not specified, a default name is assigned internally. However, specification of a name allows for the
retrieval of the properties associated with the given object (see below).
Properties
Mandatory attributes for the definition of a property are:
• [Property Name] - The name to be assigned to the property, unique for that DataEntity
• [DataType] - The type of data which the properties define. Currently supported types include:
– int
– double
– string
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
17
Configuration XML File Details
– quantity
– bool
– option
– DataReference
• [Value] - A string representing the value to be assigned to the property, which is parsed by the
code according to the type.
– The bool type can assume the values of “True” or “False.”
– A quantity type should be specified by providing a string of type “double [ unit ]” (for
example, “23 [ms^-1]” ).
– The options type is used for mutually exclusive choices, that should be specified by comma
separated strings without white space (for example, “[Option1,Option2]”).
– The DataReference type should be specified by a string of typeDataEntityType:ObjectName.
Optional attributes are:
• [Property Label] - The user-visible string that can be assigned to the property (default is the
property name).
• [Group] - The group to organize the properties (for UI purpose only).
• [IsReadOnly] (“True”/”False”) - Specifies that the property cannot be edited. Default is
"False."
• [IsExtrinsic] (“True”/”False”) - Specifies that the property is not relevant for the computation of the state of the cell. Default is "False."
• [IsVisible] (“True”/”False”) - Specifies whether the property should be shown in the UI.
Default is "True."
• [Min] - The lowest range for the property value.
• [Max] - The highest range for the property value.
• [OptionLabels] (for option type only) - The visible names for the options, to be used in the user
interface, specified by comma separated strings without white space (for example “[Background,Foreground]”).
You can access the value for each property from any Python script used with Workbench via the
Workbench query GetEntityProperty, as described below:
dataReference = “/” + container + “/” + DataEntityName + “:” + ObjectName
propertyVal = GetEntityProperty(Entity=dataReference, Name=PropertyName)
where
18
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Properties Node
• container is the name of the container associated with the cell. This information is typically available
in the function from where the Python script is called (for example, the update script for a cell or the
script invoked from a GUI operation selected on a given cell).
• DataEntityName is the name specified in the configuration file. For example:
<DataEntity Name="MyDataEntity">
• ObjectName is the name specified in the configuration file. For example:
<Object Name="MyObjectName">
• PropertyName is the name of the property specified in the configuration file.
It is also possible to change the value of the properties that are not marked as read-only using the
Workbench SetEntityProperty command:
SetEntityProperty(Entity=dataReference,Name=PropertyName, Value=value)
where value is the appropriate type for the property being modified. For example, a property of type
quantity named “InletVelocity” defined for an object named AnsSettingsObject of the data
entity type SettingsDataEntity can be queried and set as follows:
dataReference = “/” + container + “/” + “SettingsDataEntity” + “:” + “AnsSettingsObject”
value = GetEntityProperty(Entity=dataReference,
Name = “InletVelocity”)
SetEntityProperty(Entity = dataReference,
Name = “InletVelocity”, Value=”10 [m s^-1]”)
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
19
20
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
External Connection Examples
The following section provides examples of how you can use the External Connection in ANSYS Workbench. The examples are as follows:
Custom, Lightweight, External Application Integration
User Interface Button Definition
Mesh Transfer System
Material Transfer
Custom Transfer System
Custom, Lightweight, External Application Integration
The following example illustrates the integration of an external application that 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.
Figure 7: Squares Example Schematic View
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
21
External Connection Examples
Figure 8: Squares Example In Parameter Set Tab
File Structure
The file structure for this External Connection system within the user-specified working directory (which
for the purpose of this example is D:/ExternalConnection) is:
D:/ExternalConnection/Squares/SquaresCongfig.xml
D:/ExternalConnection/Squares/Squares.exe
D:/ExternalConnection/Squares/input.txt
D:/ExternalConnection/Squares/ouput.txt
Component Configuration XML File
The Component Configuration File (SquaresConfig.xml) defines the input and output types and
calls the executable file Squares.exe.
<Configuration CellName="Squares" SystemName="SquareSystem" Version="" ShowEditConfiguration="True">
<Instructions WorkingDirectory="D:/ExternalConnection/Squares">
<Instruction Type="Init">
<Name></Name>
<Args></Args>
<ParameterParsingRules>
<Parameter Name="SquareInput" Type="Input">
<Rule Type="File">input.txt</Rule>
<Rule Type="StartLine">1</Rule>
<Rule Type="PreString">input=</Rule>
<Rule Type="DataType">Double</Rule>
</Parameter>
<Parameter Name="SquareOutput" Type="Output">
<Rule Type="File">output.txt</Rule>
<Rule Type="StartLine">1</Rule>
<Rule Type="PreString">output=</Rule>
<Rule Type="DataType">Double</Rule>
</Parameter>
</ParameterParsingRules>
</Instruction>
<Instruction Type="Update">
<Name></Name>
<ExePath>D:/ExternalConnection/Squares/Squares.exe</ExePath>
<Args></Args>
</Instruction>
</Instructions>
</Configuration>
22
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
User Interface Button Definition
User Interface Button Definition
This example illustrates an external connection that defines a button and provides the script to execute
upon button invocation.
Figure 9: Button Example
File Structure
The file structure for this External Connection solution within the directory C:/Program
Files/Ansys Inc/v150/Addins/ExternalConnection is:
Customization\CustomToolBarConfiguration.xml
Customization\Images\custom.png
Customization\Scripts\pipe1.py
Note
This example uses the installation Customization location. You could instead choose a userspecific location to limit custom UI additions to a specific user.
UI Configuration XML File
The UI Configuration File (CustomToolBarConfiguration.xml) defines a GUI operation and calls
the Python file pipe.py to enable the button.
<Configuration ShowEditConfiguration="True">
<GuiOperations>
<GuiOperation Name="Custom GUI" Priority="2" ScriptFile="pipe1.py" Image="custom"
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
23
External Connection Examples
Type="ToolbarButton" SourceType="Python"/>
</GuiOperations>
</Configuration>
Instruction File
The Instruction file (pipe1.py) contains the Python code that displays a message box.
import clr
clr.AddReference("Ans.UI.Toolkit")
clr.AddReference("Ans.UI.toolkit.Base")
from Ansys.UI.Toolkit import *
Ansys.UI.Toolkit.MessageBox.Show("Example!")
Mesh Transfer System
This example implements a mesh transfer system. It consumes an upstream mesh and passes it to a
downstream Fluent system.
Figure 10: End-to-End Mesh Transfer Between Mesh, Mesher, and Fluent Setup
File Structure
The file structure for this External Connection system within the directory C:/Program Files/Ansys
Inc/v150/Addins/ExternalConnection/SystemDefinitions is:
/GenericMeshTransfer/GenericMeshTransferSystem.xml
/GenericMeshTransfer/Mesher.xml
/GenericMeshTransfer/test.py
/GenericMeshTransfer/GenericMesh_cell.png
/GenericMeshTransfer/GenericMesh.png
24
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Mesh Transfer System
System Definition XML File
The System Definition XML file (GenericMeshTransferSystem.xml) defines a system named
Generic Mesh, which appears under External Connection Systems in the Workbench Toolbox, as shown.
Figure 11: Toolbox System Entry
The file, GenericMeshTransferSystem.xml, contains the following code:
<System name="GenericMeshTransfer" displayText="Generic Mesh" abbreviation="GenMeshXfr"
imageName="GenericMesh">
<Components>
<Component name="Mesher" displayText="Mesher" imageName="GenericMesh_cell">
<Inputs>
<Input/>
<Input dataType="FluentMesh">MeshingMesh</Input>
</Inputs>
<Outputs>
<Output dataType="FluentMesh">SimulationGeneratedMesh</Output>
</Outputs>
</Component>
</Components>
</System>
Component Configuration File
The Component Configuration File (Mesher.xml) calls the Python file test.py.
<Configuration ShowEditConfiguration="False">
<Instructions>
<Instruction Type="Update">
<Name></Name>
<Script>
C:/Program Files/Ansys Inc/v150/Addins/ExternalConnection/SystemDefinitions/
GenericMeshTransfer/test.py
</Script>
</Instruction>
</Instructions>
</Configuration>
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
25
External Connection Examples
Update Instruction
The Update Instruction file (test.py) contains the Python code that provides instructions for passing
the mesh data to the downstream Fluent system.
#obtain input data
container = ExternalConnectionSystemContainer
upstreamData = container.GetInputDataByType(InputType="MeshingMesh")
meshFileRef = None
upstreamDataCount = upstreamData.Count
if upstreamDataCount > 0:
meshFileRef = upstreamData[0]
#set our output so that we are just a pass through.
outputRefs = container.GetOutputData()
meshOutputSet = outputRefs["SimulationGeneratedMesh"]
meshOutput = meshOutputSet[0]
#meshOutput.MeshFile = meshFileRef
meshOutput.TransferFile = meshFileRef
#if no new data...nothing to process from upstream sources.
Material Transfer
This example implements a material transfer system that passes MatML-formatted material data to a
downstream Engineering Data system.
Figure 12: Engineering Data View
26
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Material Transfer
Figure 13: Schematic View
File Structure
The file structure for this External Connection system within the directory C:/Program Files/Ansys
Inc/v150/Addins/ExternalConnection/SystemDefinitions is:
/GenericMaterialTransfer/GenericMaterialTransferSystem.xml
/GenericMaterialTransfer/Material.xml
/GenericMaterialTransfer/test.py
/GenericMaterialTransfer/Sample_Materials.xml
/GenericMaterialTransfer/GenericMaterial_cell.png
/GenericMaterialTransfer/GenericMaterial.png
System Definition XML File
The System Definition XML file (GenericMaterialTransferSystem.xml) defines a system named
Generic Material, which appears under External Connection Systems in the Workbench Toolbox, as
shown.
Figure 14: Toolbox System Entry
The file, GenericMaterialTransferSystem.xml, contains the following code:
<System name="GenericMaterialTransfer" displayText="Generic Material"
abbreviation="GenMatXfr" imageName="GenericMaterial" toolboxGroup="">
<Components>
<Component name="Material" displayText="Material" imageName="GenericMaterial_cell">
<Inputs>
<Input/>
</Inputs>
<Outputs>
<Output>MatML31</Output>
</Outputs>
</Component>
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
27
External Connection Examples
</Components>
</System>
Component Configuration File
The Component Configuration File (Material.xml) calls the Python file test.py.
<Configuration ShowEditConfiguration="False">
<Instructions>
<Instruction Type="Update">
<Name></Name>
<Script>
C:/Program Files/ANSYS Inc/v150/Addins/ExternalConnection/SystemDefinitions/
GenericMaterialTransfer/test.py
</Script>
</Instruction>
</Instructions>
</Configuration>
Update Instruction
The Update Instruction file (test.py) contains the Python code that provides instructions for passing
the MatML-formatted material data to a downstream Engineering Data system
container = ExternalConnectionSystemContainer
matFilePath = r"C:\Program Files\Ansys Inc\v150\Addins\ExternalConnection\SystemDefinitions\
GenericMaterialTransfer\Sample_Materials.xml"
matFileRef = None
isRegistered = IsFileRegistered(FilePath=matFilePath)
if isRegistered == True:
matFileRef = GetRegisteredFile(matFilePath)
else:
matFileRef = RegisterFile(FilePath=matFilePath)
AssociateFileWithContainer(matFileRef, container)
outputRefs = container.GetOutputData()
matOutputSet = outputRefs["MatML31"]
matOutput = matOutputSet[0]
matOutput.TransferFile = matFileRef
Material File
This file (Sample_Materials.xml) contains the MatML-formatted material data:
<?xml version="1.0" encoding="UTF-8"?>
<EngineeringData version="15.0">
<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>
28
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Custom Transfer System
<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>
<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>
Custom Transfer System
This example implements a custom transfer from a producing system to a consuming system.
Figure 15: Schematic View
File Structure
The file structure for this External Connection system within the directory C:/Program Files/Ansys
Inc/v150/Addins/ExternalConnection/SystemDefinitions is:
/CustomTransfer/CustomTransferProducerSystem.xml
/CustomTransfer/CustomTransferConsumerSystem.xml
/CustomTransfer/Producer.xml
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
29
External Connection Examples
/CustomTransfer/Consumer.xml
/CustomTransfer/Producer.py
/CustomTransfer/Consumer.py
/CustomTransfer/Sample_Materials.xml
/CustomTransfer/Generic_cell.png
/CustomTransfer/Generic.png
Producer System Definition XML File
The System Definition XML file (CustomTransferProducerSystem.xml) defines a system named
Producer, which appears under External Connection Systems in the Workbench Toolbox, as shown.
Figure 16: Toolbox System Entry
The file, CustomTransferProducerSystem.xml, contains the following code:
<System name="Producer" displayText="Producer" abbreviation="Producer" imageName="Generic">
<Components>
<Component name="Producer" displayText="Producer" imageName="Generic_cell">
<Inputs>
<Input/>
</Inputs>
<Outputs>
<Output>MyData</Output>
</Outputs>
</Component>
</Components>
</System>
Producer Component Configuration File
The Component Configuration File (Producer.xml) calls the Python file producer.py.
<Configuration ShowEditConfiguration="False">
<Instructions>
<Instruction Type="Update">
<Name></Name>
<Script>
C:/Program Files/ANSYS Inc/v150/Addins/ExternalConnection/SystemDefinitions/CustomTransfer/producer.py
</Script>
</Instruction>
</Instructions>
</Configuration>
30
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Custom Transfer System
Producer Update Instruction
The Update Instruction file (producer.py) contains the Python code that provides update instructions
for the producing system.
container = ExternalConnectionSystemContainer
filePath = r"C:\Program Files\Ansys Inc\v150\Addins\ExternalConnection\SystemDefinitions\
CustomTransfer\Sample_Materials.xml"
fileRef = None
isRegistered = IsFileRegistered(FilePath=filePath)
if isRegistered == True:
fileRef = GetRegisteredFile(filePath)
else:
fileRef = RegisterFile(FilePath=filePath)
AssociateFileWithContainer(fileRef, container)
outputRefs = container.GetOutputData()
outputSet = outputRefs["MyData"]
myData = outputSet[0]
myData.TransferFile = fileRef
Consumer System Definition XML File
The System Definition XML file (CustomTransferConsumerSystem.xml) defines a system named
Consumer, which appears under External Connection Systems in the Workbench Toolbox, as shown
in Figure 16: Toolbox System Entry (p. 30).
<System name="Consumer" displayText="Consumer" abbreviation="Consumer" imageName="Generic">
<Components>
<Component name="Consumer" displayText="Consumer" imageName="Generic_cell">
<Inputs>
<Input/>
<Input dataType="">MyData</Input>
</Inputs>
</Component>
</Components>
</System>
Consumer Component Configuration File
The Component Configuration File (Consumer.xml) calls the Python file consumer.py.
<Configuration ShowEditConfiguration="False">
<Instructions>
<Instruction Type="Update">
<Name></Name>
<Script>
C:/Program Files/Ansys Inc/v150/Addins/ExternalConnection/SystemDefinitions/CustomTransfer/consumer.py
</Script>
</Instruction>
</Instructions>
</Configuration>
Consumer Update Instruction
The Update Instruction file (consumer.py) contains the Python code that provides update instructions
for the consuming component to obtain the output data from the upstream producer.
#obtain input data
container=ExternalConnectionSystemContainer
upstreamData=container.GetInputDataByType(InputType="MyData")
fileRef=None
upstreamDataCount=upstreamData.Count
if upstreamDataCount>0:
fileRef=upstreamData[0]
#if no new data...nothing to process from upstream sources.
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
31
32
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Appendix A. Data Transfer Types
This appendix discusses the following:
Data Transfer Types
Data Transfer Types
The following table lists supported transfer types and their corresponding transfer properties.
Table 1: Data Transfer Types and Properties
Transfer Type
Property
AnsoftHeatLossDataObject
AnsoftTransferXMLString
AnsoftProjectResultsFolderAtCurrentDP
AnsoftForceDataObject
AnsoftTransferXMLString
AnsoftProjectResultsFolderAtCurrentDP
AnsoftForceAndMomentDataObject
AnsoftTransferXMLString
AnsoftProjectResultsFolderAtCurrentDP
AnsoftCellInOutEntity
FeedbackIteratorEntity
MAPDLSolution
TransferFile
AuxiliaryFiles
MAPDLDatabse
TransferFile
AuxiliaryFiles
MAPDLResults
AuxiliaryFiles
MAPDLCdb
TransferFile
AuxiliaryFiles
AqwaModel
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
33
Data Transfer Types
Transfer Type
Property
AqwaSetup
AqwaSolution
AqwaResults
AutodynSetup
CFDAnalysis
PostStateFile
CFXSetup
CFXSolverInputFile
MAPDLSolverInputFile
CFXSolution
MResLoadOption
CFXResultsFile
AuxiliaryFiles
MAPDLResultsFile
Geometry
GeometryFilePath
PlugInName
ParametricContext
DOEModel
DesignPointsDataTransfer
ResponseSurfaceModel
ResponseSurfaceDatTransfer
OptimizationModel
CorrelationModel
ROModel
EngineeringData
TransferFile
Material
ExternalDataSetup
TransferFile
ExternalModelOutputProvider
TransferFile
InputFiles
SolidSectionData
TransferFile
AuxiliaryFiles
CompositeSectionFiles
EnhancedModelData
34
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Data Transfer Types
Transfer Type
Property
FEMMesh
ACMOFile
FEMSetup
FEModelerFile
ANSYSInputFile
ParasolidFile
FiniteElementModelMaterials
AuxiliaryFiles
FluentTGridMesh
TransferFile
FluentSetup
CaseFile
ModelInfoFile
SystemCouplingSetupData
FluentCase
MeshFile
TransferFile
FluentSolution
CaseFile
DataFile
ICEData
IcePakSetup
IcePakResults
MechanicalModel
File
EdaFile
MeshingMesh
TransferFile
SimulationGeneratedMesh
TransferFile
MSExcelSetup
CouplingSetupProvider
TransferFile
PolyflowSetup
PolyflowSolutionType
DataFile
PubFile
GeneratedFiles
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
35
Data Transfer Types
Transfer Type
Property
PolyflowSolution
MechanicalModel
MechanicalMesh
TransferFile
SimulationEngineeringData
TransferFiles
SimulationModelGeneratedMesh
TransferFile
SimulationSetup
MechanicalSetup
TransferFile
MechanicalSolution
SimulationSolutionDataInternal
SimulationSolution
MechanicalResults
SimulationResults
TurboGeometry
INFFilename
GeometryFilename
TurboMesh
FileName
CFXMesh
FileName
PreFileType
FluentImportable
MeshFile
FileType
Dimension
VistaGeometry
GeoData
TransferData
VistaTFPhysics
TransferData
VistaCCDBlaseDesignProvider
TransferData
VistaAFDMeanlineProvider
TransferData
VistaAFDDesignProvider
36
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Data Transfer Types
Transfer Type
Property
TransferData
VistaTFSetup
ControlFilename
GeoFilename
AeroFilename
CorrelationsFilename
VistaTFSolution
ResultsFile
RestartFile
FeedbackIteratorSetup
AUTODYN_Remap
MatML31
TransferFile
CompositeEngineeringData
TransferFile
FluentMesh
TransferFile
PolyflowTransferMesh
TransferFile
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
37
38
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Appendix B. ANSYS Workbench Component Inputs and Outputs
This appendix discusses the following:
Component Input and Outputs Table
Component Input and Outputs Table
The following table lists component inputs and outputs supported by the External Connection.
Table 2: Component Input and Outputs
System
Component
Input
Output
AUTODYN_Remap
AutodynSetup
Autodyn
Setup
MechanicalSetup
SimulationGeneratedMesh
Analysis
None
None
None
TurboGeometry
None
TurboGeometry
BladeGen
Blade Design
BladeGen (Beta)
Blade Design
VistaGeometry
CFX (Beta)
Setup
SimulationGeneratedMesh
CFXSetup
CFXMesh
MechanicalSetup
Solution
CFXSetup
CFXSolution
CFXSolution
CFX
Setup
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
39
ANSYS Workbench Component Inputs and Outputs
SimulationGeneratedMesh
CFXSetup
CFXMesh
MechanicalSetup
Solution
CFXSetup
CFXSolution
CFXSolution
Results
CFXSolution
FluentSolution
VistaTFSolution
IcePakResults
PolyflowSolutionType
MechanicalSolution
ICEData
Design Assessment
Engineering Data
FEMSetup
EngineeringData
MatML31
Material
FEMSetup
Geometry
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Model
SimulationEngineeringData
MechanicalModel
SimulationModelGeneratedMesh
MechanicalMesh
CompositeEngineeringData
SimulationGeneratedMesh
SolidSectionData
SimulationEngineeringData
ExternalModelOutputProvider
SimulationModelGeneratedMesh
ExternalDataSetup
EngineeringData
Geometry
Setup
40
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Component Input and Outputs Table
SimulationSolutionDataInternal
MechanicalSolution
Solution
SimulationSetup
MechanicalSolution
SimulationSolutionDataInternal
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Direct Optimization
Optimization
DesignPointsDataTransfer
OptimizationModel
FEMSetup
EngineeringData
MatML31
Material
FEMSetup
Geometry
Electric
Engineering Data
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Model
SimulationEngineeringData
MechanicalModel
SimulationModelGeneratedMesh
MechanicalMesh
CompositeEngineeringData
SimulationGeneratedMesh
SolidSectionData
SimulationEngineeringData
ExternalModelOutputProvider
SimulationModelGeneratedMesh
ExternalDataSetup
EngineeringData
Geometry
Setup
MechanicalModel
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
SimulationSetup
41
ANSYS Workbench Component Inputs and Outputs
MechanicalMesh
MechanicalSetup
SimulationSolutionDataInternal
Solution
SimulationSetup
MechanicalSolution
SimulationSolutionDataInternal
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Engineering Data
Engineering Data
FEMSetup
EngineeringData
MatML31
Material
FEMSetup
EngineeringData
MatML31
Material
FEMSetup
Geometry
Explicit Dynamics
Engineering Data
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Model
SimulationEngineeringData
MechanicalModel
SimulationModelGeneratedMesh
MechanicalMesh
CompositeEngineeringData
SimulationGeneratedMesh
SolidSectionData
SimulationEngineeringData
ExternalModelOutputProvider
SimulationModelGeneratedMesh
ExternalDataSetup
EngineeringData
Geometry
Setup
MechanicalModel
42
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
SimulationSetup
Component Input and Outputs Table
MechanicalMesh
MechanicalSetup
SimulationSolutionDataInternal
EnhancedMechanicalModel
EnhancedModelData
Solution
SimulationSetup
MechanicalSolution
SimulationSolutionDataInternal
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Explicit Dynamics
(LS-DYNA Export)
Engineering Data
FEMSetup
EngineeringData
MatML31
Material
FEMSetup
Geometry
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Model
SimulationEngineeringData
MechanicalModel
SimulationModelGeneratedMesh
MechanicalMesh
CompositeEngineeringData
SimulationGeneratedMesh
SolidSectionData
SimulationEngineeringData
ExternalModelOutputProvider
SimulationModelGeneratedMesh
ExternalDataSetup
EngineeringData
Geometry
Setup
MechanicalModel
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
SimulationSetup
43
ANSYS Workbench Component Inputs and Outputs
MechanicalMesh
MechanicalSetup
None
ExternalDataSetup
None
ExternalModelOutputProvider
None
ExternalConnectionProperties
MechanicalSetup
FEMMesh
SimulationGeneratedMesh
FEMSetup
MAPDLCdb
Geometry
External Data
Setup
External Model
Setup
External Connection
External Connection
Finite Element
Modeler
Model
FEMSetup
SolidSectionData
CompositeEngineeringData
SimulationEngineeringData
FLTG
Mesh
FluentMesh
FluentTGridMesh
FluentImportable
FluentSetup
AnsoftHeatLossDataObject
SystemCouplingSetupData
Setup
FluentMesh
FluentCase
SimulationGeneratedMesh
ICEData
ICESetupData
FluentTGridMesh
Solution
FluentSetup
44
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
FluentSolution
Component Input and Outputs Table
FluentSolution
Fluent
Setup
FluentImportable
FluentSetup
AnsoftHeatLossDataObject
SystemCouplingSetupData
FluentMesh
FluentCase
SimulationGeneratedMesh
ICEData
ICESetupData
FluentTGridMesh
Solution
FluentSetup
FluentSolution
FluentSolution
Fluid Flow – Blow
Molding (Polyflow)
Geometry
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Mesh
Geometry
MechanicalModel
MeshingGeneratedMeshOutputProvider
MeshingMesh
SimulationGeneratedMesh
MeshingGeneratedMeshOutputProvider
Setup
SimulationGeneratedMesh
PolyflowSetup
PolyflowTransferMesh
Solution
PolyflowSetup
PolyflowSolutionType
PolyflowSolution
PolyflowSolution
ExternalDataSetup
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
45
ANSYS Workbench Component Inputs and Outputs
Results
CFXSolution
FluentSolution
VistaTFSolution
IcePakResults
PolyflowSolutionType
MechanicalSolution
ICEData
Fluid Flow – Extrusion (Polyflow)
Geometry
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Mesh
Geometry
MechanicalModel
MeshingGeneratedMeshOutputProvider
MeshingMesh
SimulationGeneratedMesh
MeshingGeneratedMeshOutputProvider
Setup
SimulationGeneratedMesh
PolyflowSetup
PolyflowTransferMesh
Solution
PolyflowSetup
PolyflowSolutionType
PolyflowSolution
PolyflowSolution
ExternalDataSetup
Results
CFXSolution
FluentSolution
VistaTFSolution
IcePakResults
PolyflowSolutionType
MechanicalSolution
46
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Component Input and Outputs Table
ICEData
Fluid Flow (CFX)
Geometry
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Mesh
Geometry
MechanicalModel
MeshingGeneratedMeshOutputProvider
MeshingMesh
SimulationGeneratedMesh
MeshingGeneratedMeshOutputProvider
Setup
SimulationGeneratedMesh
CFXSetup
CFXMesh
MechanicalSetup
Solution
CFXSetup
CFXSolution
CFXSolution
Results
CFXSolution
FluentSolution
VistaTFSolution
IcePakResults
PolyflowSolutionType
MechanicalSolution
ICEData
Fluid Flow (Fluent)
Geometry
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Mesh
Geometry
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
MechanicalModel
47
ANSYS Workbench Component Inputs and Outputs
MeshingGeneratedMeshOutputProvider
MeshingMesh
SimulationGeneratedMesh
MeshingGeneratedMeshOutputProvider
Setup
FluentImportable
FluentSetup
AnsoftHeatLossDataObject
SystemCouplingSetupData
FluentMesh
FluentCase
SimulationGeneratedMesh
ICEData
ICESetupData
FluentTGridMesh
Solution
FluentSetup
FluentSolution
FluentSolution
Results
CFXSolution
FluentSolution
VistaTFSolution
IcePakResults
PolyflowSolutionType
MechanicalSolution
ICEData
Fluid Flow (Polyflow)
Geometry
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Mesh
48
Geometry
MechanicalModel
MeshingGeneratedMeshOutputProvider
MeshingMesh
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Component Input and Outputs Table
SimulationGeneratedMesh
MeshingGeneratedMeshOutputProvider
Setup
SimulationGeneratedMesh
PolyflowSetup
PolyflowTransferMesh
Solution
PolyflowSetup
PolyflowSolutionType
PolyflowSolution
PolyflowSolution
ExternalDataSetup
Results
CFXSolution
FluentSolution
VistaTFSolution
IcePakResults
PolyflowSolutionType
MechanicalSolution
ICEData
Geometry
Geometry
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Harmonic Response
Engineering Data
FEMSetup
EngineeringData
MatML31
Material
FEMSetup
Geometry
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Model
SimulationEngineeringData
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
MechanicalModel
49
ANSYS Workbench Component Inputs and Outputs
SimulationModelGeneratedMesh
MechanicalMesh
CompositeEngineeringData
SimulationGeneratedMesh
SolidSectionData
SimulationEngineeringData
ExternalModelOutputProvider
SimulationModelGeneratedMesh
ExternalDataSetup
EngineeringData
Geometry
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
EnhancedModelData
EnhancedMechanicalModel
ExternalDataSetup
MechanicalSolution
AnsoftForceAndMomentDataObject
SimulationSolutionDataInternal
Solution
SimulationSetup
MechanicalSolution
SimulationSolutionDataInternal
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
AnsoftCADObject
ICEData
Mesh
Geometry
MechanicalModel
MeshingGeneratedMeshOutputProvider
MeshingMesh
SimulationGeneratedMesh
50
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Component Input and Outputs Table
MeshingGeneratedMeshOutputProvider
Setup
SimulationGeneratedMesh
PolyflowSetup
PolyflowTransferMesh
Solution
PolyflowSetup
PolyflowSolutionType
PolyflowSolution
PolyflowSolution
ExternalDataSetup
Results
CFXSolution
FluentSolution
VistaTFSolution
IcePakResults
PolyflowSolutionType
MechanicalSolution
ICEData
Geometry
Geometry
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Harmonic Response
Engineering Data
FEMSetup
EngineeringData
MatML31
Material
FEMSetup
Geometry
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Model
SimulationEngineeringData
MechanicalModel
SimulationModelGeneratedMesh
MechanicalMesh
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
51
ANSYS Workbench Component Inputs and Outputs
CompositeEngineeringData
SimulationGeneratedMesh
SolidSectionData
SimulationEngineeringData
ExternalModelOutputProvider
SimulationModelGeneratedMesh
ExternalDataSetup
EngineeringData
Geometry
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
EnhancedModelData
EnhancedMechanicalModel
ExternalDataSetup
MechanicalSolution
AnsoftForceAndMomentDataObject
SimulationSolutionDataInternal
Solution
SimulationSetup
MechanicalSolution
SimulationSolutionDataInternal
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
AnsoftCADObject
ICEData
Mesh
Geometry
MechanicalModel
MeshingGeneratedMeshOutputProvider
MeshingMesh
SimulationGeneratedMesh
MeshingGeneratedMeshOutputProvider
52
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Component Input and Outputs Table
Setup
SimulationGeneratedMesh
PolyflowSetup
PolyflowTransferMesh
Solution
PolyflowSetup
PolyflowSolutionType
PolyflowSolution
PolyflowSolution
ExternalDataSetup
Results
CFXSolution
FluentSolution
VistaTFSolution
IcePakResults
PolyflowSolutionType
MechanicalSolution
ICEData
Geometry
Geometry
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Harmonic Response
Engineering Data
FEMSetup
EngineeringData
MatML31
Material
FEMSetup
Geometry
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Model
SimulationEngineeringData
MechanicalModel
SimulationModelGeneratedMesh
MechanicalMesh
CompositeEngineeringData
SimulationGeneratedMesh
SolidSectionData
SimulationEngineeringData
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
53
ANSYS Workbench Component Inputs and Outputs
ExternalModelOutputProvider
SimulationModelGeneratedMesh
ExternalDataSetup
EngineeringData
Geometry
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
EnhancedModelData
EnhancedMechanicalModel
ExternalDataSetup
MechanicalSolution
AnsoftForceAndMomentDataObject
SimulationSolutionDataInternal
Solution
SimulationSetup
MechanicalSolution
SimulationSolutionDataInternal
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Hydrodynamic Diffraction
Geometry
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Model
Geometry
AqwaModel
AqwaModel
AqwaSetup
AqwaSetup
AqwaSolution
Setup
Solution
Results
54
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Component Input and Outputs Table
AqwaSolution
AqwaResults
FEMSetup
Geometry
Hydrodynamic Time
Response
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Model
Geometry
AqwaModel
AqwaModel
AqwaSetup
Setup
AqwaSolution
Solution
AqwaSetup
AqwaSolution
AqwaSolution
AqwaResults
None
ICEData
FEMSetup
Geometry
Results
ICE
ICE
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Mesh
Geometry
MechanicalModel
MeshingGeneratedMeshOutputProvider
MeshingMesh
SimulationGeneratedMesh
MeshingGeneratedMeshOutputProvider
ICE Solver Setup
None
ICESetupData
FluentImportable
FluentSetup
AnsoftHeatLossDataObject
SystemCouplingSetupData
Setup
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
55
ANSYS Workbench Component Inputs and Outputs
FluentMesh
FluentCase
SimulationGeneratedMesh
ICEData
ICESetupData
FluentTGridMesh
Solution
FluentSetup
FluentSolution
FluentSolution
Results
CFXSolution
FluentSolution
VistaTFSolution
IcePakResults
PolyflowSolutionType
MechanicalSolution
ICEData
ICEM CFD
Model
Geometry
SimulationGeneratedMesh
MeshingMesh
MechanicalMesh
Icepak
Setup
Geometry
IcePakSetup
AnsoftHeatLossDataObject
Solution
IcePakSetup
IcePakResults
FEMSetup
EngineeringData
MatML31
Material
FEMSetup
Geometry
Linear Buckling
Engineering Data
Geometry
TurboGeometry
AnsoftCADObject
ICEData
56
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Component Input and Outputs Table
Model
SimulationEngineeringData
MechanicalModel
SimulationModelGeneratedMesh
MechanicalMesh
CompositeEngineeringData
SimulationGeneratedMesh
SolidSectionData
SimulationEngineeringData
ExternalModelOutputProvider
SimulationModelGeneratedMesh
ExternalDataSetup
EngineeringData
Geometry
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
SimulationSolutionDataInternal
EnhancedMechanicalModel
EnhancedModelData
Solution
SimulationSetup
MechanicalSolution
SimulationSolutionDataInternal
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Linear Buckling
(Samcef )
Engineering Data
FEMSetup
EngineeringData
MatML31
Material
FEMSetup
Geometry
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
57
ANSYS Workbench Component Inputs and Outputs
Model
SimulationEngineeringData
MechanicalModel
SimulationModelGeneratedMesh
MechanicalMesh
CompositeEngineeringData
SimulationGeneratedMesh
SolidSectionData
SimulationEngineeringData
ExternalModelOutputProvider
SimulationModelGeneratedMesh
ExternalDataSetup
EngineeringData
Geometry
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
SimulationSolutionDataInternal
Solution
SimulationSetup
MechanicalSolution
SimulationSolutionDataInternal
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Magnetostatic
Engineering Data
FEMSetup
EngineeringData
MatML31
Material
FEMSetup
Geometry
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Model
SimulationEngineeringData
58
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
MechanicalModel
Component Input and Outputs Table
SimulationModelGeneratedMesh
MechanicalMesh
CompositeEngineeringData
SimulationGeneratedMesh
SolidSectionData
SimulationEngineeringData
ExternalModelOutputProvider
SimulationModelGeneratedMesh
ExternalDataSetup
EngineeringData
Geometry
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
SimulationSetup
MechanicalSolution
Solution
SimulationSolutionDataInternal
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Mechanical APDL
Analysis
MechanicalSetup
None
SimulationGeneratedMesh
FEMSetup
Geometry
SolidSectionData
MechanicalSolution
MAPDLSolution
MAPDLDatabase
MAPDLResults
MAPDLCdb
Mechanical Model
Engineering Data
FEMSetup
EngineeringData
MatML31
Material
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
59
ANSYS Workbench Component Inputs and Outputs
Geometry
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Model
SimulationEngineeringData
MechanicalModel
SimulationModelGeneratedMesh
MechanicalMesh
CompositeEngineeringData
SimulationGeneratedMesh
SolidSectionData
SimulationEngineeringData
ExternalModelOutputProvider
SimulationModelGeneratedMesh
ExternalDataSetup
EngineeringData
Geometry
Mesh
Geometry
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Mesh
Geometry
MechanicalModel
MeshingGeneratedMeshOutputProvider
MeshingMesh
SimulationGeneratedMesh
MeshingGeneratedMeshOutputProvider
Microsoft Office Excel
Analysis
None
MSExcelSetup
FEMSetup
EngineeringData
Modal (ABAQUS)
Engineering Data
60
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Component Input and Outputs Table
MatML31
Material
FEMSetup
Geometry
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Model
SimulationEngineeringData
MechanicalModel
SimulationModelGeneratedMesh
MechanicalMesh
CompositeEngineeringData
SimulationGeneratedMesh
SolidSectionData
SimulationEngineeringData
ExternalModelOutputProvider
SimulationModelGeneratedMesh
ExternalDataSetup
EngineeringData
Geometry
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
SimulationSolutionDataInternal
Solution
SimulationSetup
MechanicalSolution
SimulationSolutionDataInternal
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Modal
Engineering Data
FEMSetup
EngineeringData
MatML31
Material
FEMSetup
Geometry
Geometry
TurboGeometry
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
61
ANSYS Workbench Component Inputs and Outputs
AnsoftCADObject
ICEData
Model
SimulationEngineeringData
MechanicalModel
SimulationModelGeneratedMesh
MechanicalMesh
CompositeEngineeringData
SimulationGeneratedMesh
SolidSectionData
SimulationEngineeringData
ExternalModelOutputProvider
SimulationModelGeneratedMesh
ExternalDataSetup
EngineeringData
Geometry
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
SimulationSolutionDataInternal
EnhancedMechanicalModel
EnhancedModelData
Solution
SimulationSetup
MechanicalSolution
SimulationSolutionDataInternal
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Modal (NASTRAN)
Engineering Data
FEMSetup
EngineeringData
MatML31
Material
FEMSetup
Geometry
Geometry
TurboGeometry
AnsoftCADObject
62
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Component Input and Outputs Table
ICEData
Model
SimulationEngineeringData
MechanicalModel
SimulationModelGeneratedMesh
MechanicalMesh
CompositeEngineeringData
SimulationGeneratedMesh
SolidSectionData
SimulationEngineeringData
ExternalModelOutputProvider
SimulationModelGeneratedMesh
ExternalDataSetup
EngineeringData
Geometry
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
SimulationSetup
MechanicalSolution
Solution
SimulationSolutionDataInternal
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Modal (Samcef )
Engineering Data
FEMSetup
EngineeringData
MatML31
Material
FEMSetup
Geometry
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Model
SimulationEngineeringData
MechanicalModel
SimulationModelGeneratedMesh
MechanicalMesh
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
63
ANSYS Workbench Component Inputs and Outputs
CompositeEngineeringData
SimulationGeneratedMesh
SolidSectionData
SimulationEngineeringData
ExternalModelOutputProvider
SimulationModelGeneratedMesh
ExternalDataSetup
EngineeringData
Geometry
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
SimulationSolutionDataInternal
Solution
SimulationSetup
MechanicalSolution
SimulationSolutionDataInternal
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Parameters Correlation
Parameters Correlation
ResponseSurfaceDataTransfer
CorrelationModel
DesignPointsDataTransfer
Polyflow – Blow
Molding
Setup
SimulationGeneratedMesh
PolyflowSetup
PolyflowTransferMesh
Solution
PolyflowSetup
PolyflowSolutionType
PolyflowSolution
PolyflowSolution
ExternalDataSetup
Polyflow - Extrusion
64
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Component Input and Outputs Table
Setup
SimulationGeneratedMesh
PolyflowSetup
PolyflowTransferMesh
Solution
PolyflowSetup
PolyflowSolutionType
PolyflowSolution
PolyflowSolution
ExternalDataSetup
Polyflow
Setup
SimulationGeneratedMesh
PolyflowSetup
PolyflowTransferMesh
Solution
PolyflowSetup
PolyflowSolutionType
PolyflowSolution
PolyflowSolution
ExternalDataSetup
Random Vibration
Engineering Data
FEMSetup
EngineeringData
MatML31
Material
FEMSetup
Geometry
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Model
SimulationEngineeringData
MechanicalModel
SimulationModelGeneratedMesh
MechanicalMesh
CompositeEngineeringData
SimulationGeneratedMesh
SolidSectionData
SimulationEngineeringData
ExternalModelOutputProvider
SimulationModelGeneratedMesh
ExternalDataSetup
EngineeringData
Geometry
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
65
ANSYS Workbench Component Inputs and Outputs
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
SimulationSolutionDataInternal
EnhancedMechanicalModel
EnhancedModelData
Solution
SimulationSetup
MechanicalSolution
SimulationSolutionDataInternal
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Response Spectrum
Engineering Data
FEMSetup
EngineeringData
MatML31
Material
FEMSetup
Geometry
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Model
SimulationEngineeringData
MechanicalModel
SimulationModelGeneratedMesh
MechanicalMesh
CompositeEngineeringData
SimulationGeneratedMesh
SolidSectionData
SimulationEngineeringData
ExternalModelOutputProvider
SimulationModelGeneratedMesh
ExternalDataSetup
EngineeringData
Geometry
Setup
66
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Component Input and Outputs Table
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
SimulationSolutionDataInternal
EnhancedMechanicalModel
EnhancedModelData
Solution
SimulationSetup
MechanicalSolution
SimulationSolutionDataInternal
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Response Surface
Design of Experiments
None
ParametricContext
DOEModel
DesignPointsDataTransfer
Response Surface
ParametricContext
ResponseSurfaceModel
DOEModel
ResponseSurfaceDataTransfer
DesignPointsDataTransfer
Response Surface
Optimization
Design of Experiments
None
ParametricContext
DOEModel
DesignPointsDataTransfer
Response Surface
ParametricContext
ResponseSurfaceModel
DOEModel
ResponseSurfaceDataTransfer
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
67
ANSYS Workbench Component Inputs and Outputs
DesignPointsDataTransfer
Optimization
ParametricContext
OptimizationModel
ResponseSurfaceModel
Results
Results
CFXSolution
FluentSolution
VistaTFSolution
IcePakResults
PolyflowSolutionType
MechanicalSolution
ICEData
Rigid Dynamics
Engineering Data
FEMSetup
EngineeringData
MatML31
Material
FEMSetup
Geometry
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Model
SimulationEngineeringData
MechanicalModel
SimulationModelGeneratedMesh
MechanicalMesh
CompositeEngineeringData
SimulationGeneratedMesh
SolidSectionData
SimulationEngineeringData
ExternalModelOutputProvider
SimulationModelGeneratedMesh
ExternalDataSetup
EngineeringData
Geometry
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
Solution
68
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Component Input and Outputs Table
SimulationSetup
MechanicalSolution
SimulationSolutionDataInternal
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Shape Optimization
Engineering Data
FEMSetup
EngineeringData
MatML31
Material
FEMSetup
Geometry
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Model
SimulationEngineeringData
MechanicalModel
SimulationModelGeneratedMesh
MechanicalMesh
CompositeEngineeringData
SimulationGeneratedMesh
SolidSectionData
SimulationEngineeringData
ExternalModelOutputProvider
SimulationModelGeneratedMesh
ExternalDataSetup
EngineeringData
Geometry
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
SimulationSolutionDataInternal
CFXSolution
FluentSolution
IcePakResults
MechanicalSolution
Solution
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
69
ANSYS Workbench Component Inputs and Outputs
SimulationSetup
MechanicalSolution
SimulationSolutionDataInternal
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Six Sigma Analysis
Design of Experiments
(SSA)
ParametricContext
DOEModel
DesignPointsDataTransfer
Response Surface
(SSA)
ParametricContext
ResponseSurfaceModel
DOEModel
ResponseSurfaceDataTransfer
DesignPointsDataTransfer
Six Sigma Analysis
ParametricContext
SixSigmaModel
ResponseSurfaceModel
Static Structural
(ABAQUS)
Engineering Data
FEMSetup
EngineeringData
MatML31
Material
FEMSetup
Geometry
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Model
70
SimulationEngineeringData
MechanicalModel
SimulationModelGeneratedMesh
MechanicalMesh
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Component Input and Outputs Table
CompositeEngineeringData
SimulationGeneratedMesh
SolidSectionData
SimulationEngineeringData
ExternalModelOutputProvider
SimulationModelGeneratedMesh
ExternalDataSetup
EngineeringData
Geometry
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
SimulationSolutionDataInternal
CFXSolution
FluentSolution
IcePakResults
MechanicalSolution
ExternalDataSetup
Solution
SimulationSetup
MechanicalSolution
SimulationSolutionDataInternal
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Static Structural
Engineering Data
FEMSetup
EngineeringData
MatML31
Material
FEMSetup
Geometry
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Model
SimulationEngineeringData
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
MechanicalModel
71
ANSYS Workbench Component Inputs and Outputs
SimulationModelGeneratedMesh
MechanicalMesh
CompositeEngineeringData
SimulationGeneratedMesh
SolidSectionData
SimulationEngineeringData
ExternalModelOutputProvider
SimulationModelGeneratedMesh
ExternalDataSetup
EngineeringData
Geometry
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
EnhancedModelData
SystemCouplingSetupData
SimulationSolutionDataInternal
CFXSolution
FluentSolution
IcePakResults
MechanicalSolution
ExternalDataSetup
AnsoftForceDataObject
EnhancedMechanicalModel
Solution
SimulationSetup
MechanicalSolution
SimulationSolutionDataInternal
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Static Structural
(Samcef )
Engineering Data
FEMSetup
EngineeringData
MatML31
Material
Geometry
72
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Component Input and Outputs Table
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Model
SimulationEngineeringData
MechanicalModel
SimulationModelGeneratedMesh
MechanicalMesh
CompositeEngineeringData
SimulationGeneratedMesh
SolidSectionData
SimulationEngineeringData
ExternalModelOutputProvider
SimulationModelGeneratedMesh
ExternalDataSetup
EngineeringData
Geometry
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
SimulationSolutionDataInternal
CFXSolution
FluentSolution
IcePakResults
MechanicalSolution
ExternalDataSetup
Solution
SimulationSetup
MechanicalSolution
SimulationSolutionDataInternal
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Steady-State
Thermal (ABAQUS)
Engineering Data
FEMSetup
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
EngineeringData
73
ANSYS Workbench Component Inputs and Outputs
MatML31
Material
FEMSetup
Geometry
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Model
SimulationEngineeringData
MechanicalModel
SimulationModelGeneratedMesh
MechanicalMesh
CompositeEngineeringData
SimulationGeneratedMesh
SolidSectionData
SimulationEngineeringData
ExternalModelOutputProvider
SimulationModelGeneratedMesh
ExternalDataSetup
EngineeringData
Geometry
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
FluentSolution
IcePakResults
MechanicalSolution
SimulationSolutionDataInternal
CFXSolution
ExternalDataSetup
Solution
SimulationSetup
MechanicalSolution
SimulationSolutionDataInternal
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Steady-State
Thermal
74
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Component Input and Outputs Table
Engineering Data
FEMSetup
EngineeringData
MatML31
Material
FEMSetup
Geometry
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Model
SimulationEngineeringData
MechanicalModel
SimulationModelGeneratedMesh
MechanicalMesh
CompositeEngineeringData
SimulationGeneratedMesh
SolidSectionData
SimulationEngineeringData
ExternalModelOutputProvider
SimulationModelGeneratedMesh
ExternalDataSetup
EngineeringData
Geometry
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
SimulationSolutionDataInternal
SystemCouplingSetupData
CFXSolution
FluentSolution
IcePakResults
MechanicalSolution
ExternalDataSetup
AnsoftHeatLossDataObject
Solution
SimulationSetup
MechanicalSolution
SimulationSolutionDataInternal
SimulationSolution
Results
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
75
ANSYS Workbench Component Inputs and Outputs
SimulationSolution
MechanicalResults
SimulationResults
Steady-State
Thermal (Samcef )
Engineering Data
FEMSetup
EngineeringData
MatML31
Material
FEMSetup
Geometry
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Model
SimulationEngineeringData
MechanicalModel
SimulationModelGeneratedMesh
MechanicalMesh
CompositeEngineeringData
SimulationGeneratedMesh
SolidSectionData
SimulationEngineeringData
ExternalModelOutputProvider
SimulationModelGeneratedMesh
ExternalDataSetup
EngineeringData
Geometry
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
SimulationSolutionDataInternal
CFXSolution
FluentSolution
IcePakResults
MechanicalSolution
ExternalDataSetup
Solution
SimulationSetup
MechanicalSolution
SimulationSolutionDataInternal
76
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Component Input and Outputs Table
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
System Coupling
Setup
SystemCouplingSetupData
CouplingSetupProvider
ExternalDataSetup
Solution
CouplingSetupProvider
None
FEMSetup
EngineeringData
MatML31
Material
FEMSetup
Geometry
Thermal-Electric
Engineering Data
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Model
SimulationEngineeringData
MechanicalModel
SimulationModelGeneratedMesh
MechanicalMesh
CompositeEngineeringData
SimulationGeneratedMesh
SolidSectionData
SimulationEngineeringData
ExternalModelOutputProvider
SimulationModelGeneratedMesh
ExternalDataSetup
EngineeringData
Geometry
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
CFXSolution
FluentSolution
IcePakResults
ExternalDataSetup
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
77
ANSYS Workbench Component Inputs and Outputs
Solution
SimulationSetup
MechanicalSolution
SimulationSolutionDataInternal
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Throughflow
Geometry
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Setup
VistaGeometry
VistaTFSetup
VistaTFPhysics
Geometry
Solution
VistaTFSetup
VistaTFSolution
VistaTFSolution
Results
CFXSolution
FluentSolution
VistaTFSolution
IcePakResults
PolyflowSolutionType
MechanicalSolution
ICEData
Throughflow
(BladeGen)
Blade Design
None
TurboGeometry
VistaGeometry
Setup
VistaGeometry
VistaTFPhysics
Geometry
78
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
VistaTFSetup
Component Input and Outputs Table
Solution
VistaTFSetup
VistaTFSolution
VistaTFSolution
Results
CFXSolution
FluentSolution
VistaTFSolution
IcePakResults
PolyflowSolutionType
MechanicalSolution
ICEData
Transient Structural
(ABAQUS)
Engineering Data
FEMSetup
EngineeringData
MatML31
Material
FEMSetup
Geometry
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Model
SimulationEngineeringData
MechanicalModel
SimulationModelGeneratedMesh
MechanicalMesh
CompositeEngineeringData
SimulationGeneratedMesh
SolidSectionData
SimulationEngineeringData
ExternalModelOutputProvider
SimulationModelGeneratedMesh
ExternalDataSetup
EngineeringData
Geometry
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
SimulationSolutionDataInternal
CFXSolution
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
79
ANSYS Workbench Component Inputs and Outputs
FluentSolution
IcePakResults
MechanicalSolution
ExternalDataSetup
Solution
SimulationSetup
MechanicalSolution
SimulationSolutionDataInternal
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Transient Structural
Engineering Data
FEMSetup
EngineeringData
MatML31
Material
FEMSetup
Geometry
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Model
SimulationEngineeringData
MechanicalModel
SimulationModelGeneratedMesh
MechanicalMesh
CompositeEngineeringData
SimulationGeneratedMesh
SolidSectionData
SimulationEngineeringData
ExternalModelOutputProvider
SimulationModelGeneratedMesh
ExternalDataSetup
EngineeringData
Geometry
Setup
80
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
EnhancedModelData
SystemCouplingSetupData
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Component Input and Outputs Table
SimulationSolutionDataInternal
CFXSolution
FluentSolution
IcePakResults
MechanicalSolution
ExternalDataSetup
AnsoftForceDataObject
EnhancedMechanicalModel
Solution
SimulationSetup
MechanicalSolution
SimulationSolutionDataInternal
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Transient Structural
(Samcef )
Engineering Data
FEMSetup
EngineeringData
MatML31
Material
FEMSetup
Geometry
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Model
SimulationEngineeringData
MechanicalModel
SimulationModelGeneratedMesh
MechanicalMesh
CompositeEngineeringData
SimulationGeneratedMesh
SolidSectionData
SimulationEngineeringData
ExternalModelOutputProvider
SimulationModelGeneratedMesh
ExternalDataSetup
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
81
ANSYS Workbench Component Inputs and Outputs
EngineeringData
Geometry
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
SimulationSolutionDataInternal
CFXSolution
FluentSolution
IcePakResults
MechanicalSolution
ExternalDataSetup
Solution
SimulationSetup
MechanicalSolution
SimulationSolutionDataInternal
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Transient Thermal
(ABAQUS)
Engineering Data
FEMSetup
EngineeringData
MatML31
Material
FEMSetup
Geometry
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Model
82
SimulationEngineeringData
MechanicalModel
SimulationModelGeneratedMesh
MechanicalMesh
CompositeEngineeringData
SimulationGeneratedMesh
SolidSectionData
SimulationEngineeringData
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Component Input and Outputs Table
ExternalModelOutputProvider
SimulationModelGeneratedMesh
ExternalDataSetup
EngineeringData
Geometry
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
SimulationSolutionDataInternal
CFXSolution
FluentSolution
IcePakResults
MechanicalSolution
ExternalDataSetup
Solution
SimulationSetup
MechanicalSolution
SimulationSolutionDataInternal
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Transient Thermal
Engineering Data
FEMSetup
EngineeringData
MatML31
Material
FEMSetup
Geometry
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Model
SimulationEngineeringData
MechanicalModel
SimulationModelGeneratedMesh
MechanicalMesh
CompositeEngineeringData
SimulationGeneratedMesh
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
83
ANSYS Workbench Component Inputs and Outputs
SolidSectionData
SimulationEngineeringData
ExternalModelOutputProvider
SimulationModelGeneratedMesh
ExternalDataSetup
EngineeringData
Geometry
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
SimulationSolutionDataInternal
SystemCouplingSetupData
CFXSolution
FluentSolution
IcePakResults
MechanicalSolution
ExternalDataSetup
AnsoftHeatLossDataObject
Solution
SimulationSetup
MechanicalSolution
SimulationSolutionDataInternal
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Transient Thermal
(Samcef )
Engineering Data
FEMSetup
EngineeringData
MatML31
Material
FEMSetup
Geometry
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Model
SimulationEngineeringData
84
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
MechanicalModel
Component Input and Outputs Table
SimulationModelGeneratedMesh
MechanicalMesh
CompositeEngineeringData
SimulationGeneratedMesh
SolidSectionData
SimulationEngineeringData
ExternalModelOutputProvider
SimulationModelGeneratedMesh
ExternalDataSetup
EngineeringData
Geometry
Setup
MechanicalModel
SimulationSetup
MechanicalMesh
MechanicalSetup
SimulationSolutionDataInternal
CFXSolution
FluentSolution
IcePakResults
MechanicalSolution
ExternalDataSetup
Solution
SimulationSetup
MechanicalSolution
SimulationSolutionDataInternal
SimulationSolution
Results
SimulationSolution
MechanicalResults
SimulationResults
Turbomachinery
Fluid Flow
(BladeEditor)
Geometry
FEMSetup
Geometry
TurboGeometry
AnsoftCADObject
ICEData
Turbo Mesh
TurboGeometry
TurboMesh
Geometry
CFXMesh
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
85
ANSYS Workbench Component Inputs and Outputs
FluentImportable
Setup
SimulationGeneratedMesh
CFXSetup
CFXMesh
MechanicalSetup
Solution
CFXSetup
CFXSolution
CFXSolution
Results
CFXSolution
FluentSolution
VistaTFSolution
IcePakResults
PolyflowSolutionType
MechanicalSolution
ICEData
Turbomachinery
Fluid Flow (BladeGen)
BladeGen
None
TurboGeometry
TurboGeometry
TurboMesh
Geometry
CFXMesh
Turbo Mesh
FluentImportable
Setup
SimulationGeneratedMesh
CFXSetup
CFXMesh
MechanicalSetup
Solution
CFXSetup
CFXSolution
Results
CFXSolution
FluentSolution
VistaTFSolution
IcePakResults
PolyflowSolutionType
86
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
CFXSolution
Component Input and Outputs Table
MechanicalSolution
ICEData
TurboGrid
Turbo Mesh
TurboGeometry
TurboMesh
Geometry
CFXMesh
FluentImportable
Vista TF
Setup
VistaGeometry
VistaTFSetup
VistaTFPhysics
Geometry
Solution
VistaTFSetup
VistaTFSolution
VistaTFSolution
Results
CFXSolution
FluentSolution
VistaTFSolution
IcePakResults
PolyflowSolutionType
MechanicalSolution
ICEData
Vista AFD
Meanline
None
VistaAFDMeanlineProvider
VistaAFDMeanlineProvider
VistaAFDDesignProvider
VistaAFDDesignProvider
None
None
VistaCCDBladeDesignProvider
Design
Analysis
Vista CCD
Blade Design
Vista CCD (with
CCM)
Blade Design
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
87
ANSYS Workbench Component Inputs and Outputs
None
VistaCCDBladeDesignProvider
VistaCCDBladeDesignProvider
None
None
None
None
None
None
VistaGeometry
Performance Map
Vista CPD
Blade Design
Vista RTD
Blade Design
Vista RTD (Beta)
Blade Design
VistaTFPhysics
88
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
I
Index
C
component configuration files
creating, 8
configuration file
configuration node, 11
GuiOperations node, 14
instructions node, 11
properties node, 16
configuration node, 11
consuming data
update instructions, 9
convenience queries
creating, 10
creating systems
file layout and installation, 7
general workflow, 7
customizing
Workbench user interface, 5
input, 10
inputs and outputs
defining, 9
instructions node, 11
O
output, 10
P
producing data
update instructions, 9
python queries, 10
GetInputData, 10
GetInputDataByType, 10
GetOutputData, 10
S
system definition Files, 8
Creating , 8
T
D
data generation, 10
transfer types
table, 33
E
U
external application
external process responsibilities, 5
external applications
integrating, 4
external connection add-in
creating systems and components, 7
overview, 1
uses, 1
using within ANSYS Workbench, 1
External Connection configuration file
overview, 11
External Connection examples, 21
custom transfer, 29
custom, lightweight, external application integration,
21
material transfer, 26
mesh transfer system, 24
user interface button definition, 23
external process
responsibilities, 5
update instructions, 9
upstream data consumption, 10
using the External Connection Add-in, 1
W
Workbench user interface
custom installation files, 5
custom toolbar, 5
customizing, 5
menu entries, 5
G
GuiOperations node, 14
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
89
90
Release 15.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.