Professional Documents
Culture Documents
ANSYS, ANSYS Workbench, Ansoft, AUTODYN, EKM, Engineering Knowledge Manager, CFX, FLUENT, HFSS, AIM
and any and all ANSYS, Inc. brand, product, service and feature names, logos and slogans are registered trademarks
or trademarks of ANSYS, Inc. or its subsidiaries in the United States or other countries. ICEM CFD is a trademark
used by ANSYS, Inc. under license. CFX is a trademark of Sony Corporation in Japan. All other brand, product,
service and feature names or trademarks are the property of their respective owners.
Disclaimer Notice
THIS ANSYS SOFTWARE PRODUCT AND PROGRAM DOCUMENTATION INCLUDE TRADE SECRETS AND ARE CONFID-
ENTIAL AND PROPRIETARY PRODUCTS OF ANSYS, INC., ITS SUBSIDIARIES, OR LICENSORS. The software products
and documentation are furnished by ANSYS, Inc., its subsidiaries, or affiliates under a software license agreement
that contains provisions concerning non-disclosure, copying, length and nature of use, compliance with exporting
laws, warranties, disclaimers, limitations of liability, and remedies, and other provisions. The software products
and documentation may be used, disclosed, transferred, or copied only in accordance with the terms and conditions
of that software license agreement.
ANSYS, Inc. and ANSYS Europe, Ltd. are UL registered ISO 9001: 2008 companies.
For U.S. Government users, except as specifically granted by the ANSYS, Inc. software license agreement, the use,
duplication, or disclosure by the United States Government is subject to restrictions stated in the ANSYS, Inc.
software license agreement and FAR 12.212 (for non-DOD licenses).
Third-Party Software
See the legal information in the product help files for the complete Legal Notice for ANSYS proprietary software
and third-party software. If you are unable to access the Legal Notice, Contact ANSYS, Inc.
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. iii
External Connection Guide
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
iv of ANSYS, Inc. and its subsidiaries and affiliates.
Introduction to the External Connection Add-In
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 enable you to perform automation and customization activities:
Define user interface elements (such as buttons in the Workbench Toolbar or entries in custom menus) and
create the scripts that they run.
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.
After you drag an External Connection system into the Workbench Project Schematic window, the Ex-
ternal Connection component appears in an Edit Required state, indicated by a question mark, until
you update it with a Component Configuration file.
Release 18.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
In the figure that follows, 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.
The following figure shows an External Connection that adds a button to the toolbar. See User Interface
Button Definition (p. 23) for more details.
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
2 of ANSYS, Inc. and its subsidiaries and affiliates.
Figure 4: Button Definition Example
The figure that follows shows a Mesh Transfer system that takes an upstream mesh and passes it to a
downstream Fluent system. See Mesh Transfer System (p. 24) for more details.
Release 18.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
The following sections describe how you can use the ANSYS Workbench External Connection add-in
within an ANSYS Workbench workflow.
Integrating an External Application
Customizing the Workbench User Interface
Every External Connection system exposes a Read Configuration user interface operation as a component
context menu. This user interface operations underlying command reads a Component Configuration
XML file that contains all the information that the external process wants to provide to Workbench (see
Configuration XML File Details (p. 11) for more information). At a 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 operating system 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 (Using Journals and Scripts in the Workbench User's Guide).
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
4 of ANSYS, Inc. and its subsidiaries and affiliates.
Customizing the Workbench User Interface
External Connection reads and stores all the information defined within the Component Configuration
file. You can access the stored configuration information through the Edit Configuration user interface
operation on the external connection components context menu. Only infrastructure/integration changes
within 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.
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 user interface operation. The Reset user interface operation, also a
context menu operation on an External Connection component, discards the imported configuration
information. Workbench re-enables the Read Configuration user interface operation upon Reset as
you must load a new Component Configuration file to proceed.
Release 18.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
The custom User Interface configuration file format shares the same syntax as the Component Config-
uration files used with External Connection components. However, only the user interface operation
section and elements remain relevant. If you provide content from other sections, Workbench will ignore
it (see Configuration XML File Details (p. 11) for element descriptions and examples).
1. You must place custom installation files in the ExternalConnection directory under v180/Addins
(for example C:\Program Files\Ansys Inc\v180\Addins\ExternalConnection). The user-
specific custom file location depends upon the operating system:
2. You must create a directory named Customization under ExternalConnection folder to use the custom
user interface functionality within the External Connection add-in.
3. You must name your custom user interface configuration file (which contains the information about the
custom user interface entries) CustomToolBarConfiguration.xml and place it under the new Customiz-
ation folder.
4. If your custom user interface entries use images or scripts (as defined in your user interface configuration
file), you require folders named Images and Scripts under the Customization directory.
The custom entries defined within the user interface 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 user interface
entries and scripts to support process automation, wizard-like dialog boxes, and custom lightweight
vertical applications.
Note
Toolbar buttons may not appear in Workbench by default. If your External Connection-defined
user interface entry does not appear, select the corresponding Toolbar group menu entry
from the View>Toolbars menu.
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
6 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 chapter discusses how you can create the various files required to expose custom External Connec-
tion systems and components. The following topics are covered:
General Workflow
Creating an External Connection Directory
Creating System Definition Files
Creating Component Configuration Files
General Workflow
The general workflow for creating a custom External Connection System includes:
3. Create any necessary Component Configuration XML files. The files optionally can contain:
Python scripts
Operating system executables
System and component images.
5. Manipulate External Connection system cells within Workbench to add them to your workflow.
Python scripts
Operating system executables
System and component images.
Release 18.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
Display text
Abbreviation
Image name
Toolbox group
Display text
Image name
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 components context
menu.
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
8 of ANSYS, Inc. and its subsidiaries and affiliates.
Creating Component Configuration Files
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, see Table 178: Data
Transfer Types and Properties (p. 105).
For a list of supported datatype strings, see Appendix D: Addin Data Types and Data Transfer
Formats (p. 109).
Release 18.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
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
GetOutputData
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
10 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:
User interface operations that execute from a components context menu or from a custom toolbar or menu
entry. Each user interface 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 user interface operations.
Configuration XML files are used for both the External Connection component and user interface con-
figuration files. Details on the configuration file are provided in the following sections.
Configuration Node
The <Configuration> node contains the <Instructions>, <GUIOperations>, and <Proper-
ties> nodes.
<Configuration>
</Configuration>
The <Configuration> node enables you to specify the following optional attributes:
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 follows:
<Instructions WorkingDirectory="[Directory Name]">
</Instructions>
The <Instructions> node enables 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 active design
Release 18.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
point). The Working Directory is also used to search for files defined in other sections of the configuration
file if a full path to those files is not provided.
Note
To ensure project portability, the External Connection add-in does not use the working dir-
ectory after you save the Workbench project. When the project is saved, External Connection
copies the Configuration file and all external files (scripts, parameter files, and so on) to which
the Configuration file refers 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. Because 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:
[Instruction Type] - The type that determines where the instruction will be executed.
[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.
[Error File] - A file used to communicate that the execution of the external application was not suc-
cessful. The error file must be removed by the external application upon completion. If it is still present,
Workbench sends an error message and stops the update. The content of the error message can be specified
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
12 of ANSYS, Inc. and its subsidiaries and affiliates.
Instructions Node
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 in-
struction 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 GetEnti-
tyProperties(Entity=configurationObject) returns a dictionary that 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 configura-
tionObject) 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 user interface.
[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 environ-
ment. 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
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:
Release 18.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
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 re-
sources. 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.
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]).
[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 user interface 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>
Attributes
The <GuiOperations> node has the following attributes:
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
14 of ANSYS, Inc. and its subsidiaries and affiliates.
GuiOperations Node
[Priority] - The weighted value determining the location within the context menu, the toolbar or the
menu where the user interface operation is defined.
[SourceType] - The type of code being used to define the response behavior for operation execution.
[Type] - The type specifies where the user interface 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 user interface
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 user interface operations defined on the component configuration file. It is reserved for user interface-
specific 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 user interface operations defined on the component configuration file. It is reserved for user interface-
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 user interface
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 user interface
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 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 user interface operation defined
on the ContextMenu of the cell have access to the following variables:
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 to access some of the information
specified in the configuration file, such as a working directory or error file. The query GetEntityProp-
Release 18.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
When the user interface 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 com-
mand. 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:
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 con-
figurationObject) that is passed to the executing script.
3. ErrorFile=[string] - A file used to communicate that the execution of the user interface operation
was not successful. The error file muist be removed by the user interface operation upon completion. If it
is still present, Workbench sends 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 is scanned for lines that contain the
specified error string. All lines that contain the string are displayed as error messages (with the error string
stripped from the message). An error string named file causes the whole content of the file to be displayed.
[Image] - The name (without extension) of a file containing an image to be used for the user interface
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 display 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
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 con-
tainer associated with the cell from which the configuration is read. If different External Data systems
are present, each has a separate container.
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
16 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties Node
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 Type ]
Value= [Value]
Group = [ Group ] IsReadOnly = [ IsReadOnly ]
IsExtrinsic = [ IsExtrinsic ] IsVisible = [ IsVisible ]
Min = [ Min ] Max = [ Max ]
OptionLabels = [ Option Labels ]/>
</Object>
</DataEntity>
</Properties>
Attributes
The <Properties> node has the following 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 enables 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 enables 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
quantity
bool
option
Release 18.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
DataReference
[Value] - A string representing the value to be assigned to the property, which is parsed by the code
according to the type.
A quantity type should be specified by providing a string of type double [ unit ] (for ex-
ample,23 [ms^-1] ).
The options type is used for mutually exclusive choices, which should be specified by comma
separated strings without white space (for example,[Option1,Option2]).
[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 user interface purpose only).
[IsExtrinsic] (True/False) - Specifies that the property is not relevant for the compu-
tation of the state of the cell. Default is "False."
[IsVisible] (True/False) - Specifies whether the property should be shown in the user
interface. Default is "True."
[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,Fore-
ground]).
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
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 user interface operation selected on a given cell).
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
18 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties Node
<Object Name="MyObjectName">
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 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 19
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
20 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 Work-
bench. The examples are as follows:
Custom, Lightweight, External Application Integration
User Interface Button Definition
Mesh Transfer System
Material Transfer
Custom Transfer System
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 21
External Connection Examples
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
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
22 of ANSYS, Inc. and its subsidiaries and affiliates.
User Interface Button Definition
File Structure
The file structure for this External Connection solution within the directory C:/Program
Files/Ansys Inc/v180/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 user-
specific location to limit custom user interface additions to a specific user.
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 23
External Connection Examples
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")
MessageBox.Show("Example!")
Figure 10: End-to-End Mesh Transfer Between Mesh, Mesher, and Fluent Setup
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
24 of ANSYS, Inc. and its subsidiaries and affiliates.
Mesh Transfer System
File Structure
The file structure for this External Connection system within the directory C:/Program Files/Ansys
Inc/v180/Addins/ExternalConnection/SystemDefinitions is:
/GenericMeshTransfer/GenericMeshTransferSystem.xml
/GenericMeshTransfer/Mesher.xml
/GenericMeshTransfer/test.py
/GenericMeshTransfer/GenericMesh_cell.png
/GenericMeshTransfer/GenericMesh.png
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 25
External Connection Examples
<Script>
C:/Program Files/Ansys Inc/v180/Addins/ExternalConnection/SystemDefinitions/
GenericMeshTransfer/test.py
</Script>
</Instruction>
</Instructions>
</Configuration>
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.
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
26 of ANSYS, Inc. and its subsidiaries and affiliates.
Material Transfer
File Structure
The file structure for this External Connection system within the directory C:/Program Files/Ansys
Inc/v180/Addins/ExternalConnection/SystemDefinitions is:
/GenericMaterialTransfer/GenericMaterialTransferSystem.xml
/GenericMaterialTransfer/Material.xml
/GenericMaterialTransfer/test.py
/GenericMaterialTransfer/Sample_Materials.xml
/GenericMaterialTransfer/GenericMaterial_cell.png
/GenericMaterialTransfer/GenericMaterial.png
Release 18.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>
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\v180\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="18.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>
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
28 of ANSYS, Inc. and its subsidiaries and affiliates.
Custom Transfer System
File Structure
The file structure for this External Connection system within the directory C:/Program Files/Ansys
Inc/v180/Addins/ExternalConnection/SystemDefinitions is:
/CustomTransfer/CustomTransferProducerSystem.xml
/CustomTransfer/CustomTransferConsumerSystem.xml
/CustomTransfer/Producer.xml
Release 18.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
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
30 of ANSYS, Inc. and its subsidiaries and affiliates.
Custom Transfer System
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 31
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
32 of ANSYS, Inc. and its subsidiaries and affiliates.
Appendix A. Component Input and Output Tables
The External Connection supports the component inputs and outputs listed in the following tables.
Table 1: Autodyn
Table 2: BladeGen
Table 3: CFX
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 33
Component Input and Output Tables
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
34 of ANSYS, Inc. and its subsidiaries and affiliates.
Taskgroup Task Input Output
SimulationResults
Table 6: Electric
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 35
Component Input and Output Tables
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
36 of ANSYS, Inc. and its subsidiaries and affiliates.
Taskgroup Task Input Output
SimulationSolutionOutputProvider
SolidSectionData
Setup MechanicalModel SimulationSetup
EnhancedMechanicalModel MechanicalSetup
EnhancedModelData
GeneralTransfer
MechanicalMesh
SimulationSolutionDataInternal
Solution SimulationSetup MechanicalSolution
GeneralTransfer SimulationSolution
SimulationSolutionDataInternal
SimulationSolutionOutputProvider
Results SimulationSolution MechanicalResults
SimulationResults
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 37
Component Input and Output Tables
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
38 of ANSYS, Inc. and its subsidiaries and affiliates.
Taskgroup Task Input Output
AIMFluentPartMeshOutputProvider
AnsoftHeatLossDataObject SystemCouplingSetupData
FluentCase
FluentImportable
FluentMesh
FluentTGridMesh
ICEData
ICESetupData
SimulationGeneratedMesh
Solution FluentSetup FluentSolution
FluentSolution
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 39
Component Input and Output Tables
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
40 of ANSYS, Inc. and its subsidiaries and affiliates.
Taskgroup Task Input Output
VistaTFSolution
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 41
Component Input and Output Tables
MechanicalModel
MeshingMesh
SimulationGeneratedMesh
Setup AIMFluentMeshOutputProvider FluentSetup
AIMFluentPartMeshFileOutputProvider
AIMFluentPartMeshOutputProvider
FluentImportable
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
42 of ANSYS, Inc. and its subsidiaries and affiliates.
Taskgroup Task Input Output
AnsoftHeatLossDataObject SystemCouplingSetupData
FluentCase
FluentImportable
FluentMesh
FluentTGridMesh
ICEData
ICESetupData
SimulationGeneratedMesh
Solution FluentSetup FluentSolution
FluentSolution
Results CFXSolution CFDAnalysis
FluentSolution
ForteSolution
ICEData
IcePakResults
MechanicalSolution
PolyflowSolutionType
VistaTFSolution
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 43
Component Input and Output Tables
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
44 of ANSYS, Inc. and its subsidiaries and affiliates.
Taskgroup Task Input Output
Geometry
MeshingAssemblyTransferType
Modeler
SimulationEngineeringData
SimulationModelGeneratedMesh
SimulationSolutionOutputProvider
SolidSectionData
Setup MechanicalModel SimulationSetup
AnsoftForceAndMomentDataObject MechanicalSetup
EnhancedMechanicalModel
ExternalDataSetup
GeneralTransfer
MechanicalMesh
MechanicalSolution
SimulationSolutionDataInternal
Solution SimulationSetup MechanicalSolution
GeneralTransfer SimulationSolution
SimulationSolutionDataInternal
SimulationSolutionOutputProvider
Results SimulationSolution MechanicalResults
SimulationResults
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 45
Component Input and Output Tables
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
46 of ANSYS, Inc. and its subsidiaries and affiliates.
Taskgroup Task Input Output
AIMFluentPartMeshOutputProvider
FluentImportable
AnsoftHeatLossDataObject SystemCouplingSetupData
FluentCase
FluentMesh
FluentTGridMesh
ICEData
ICESetupData
SimulationGeneratedMesh
Solution FluentSetup FluentSolution
FluentSolution
Results CFXSolution CFDAnalysis
FluentSolution
ForteSolution
ICEData
IcePakResults
MechanicalSolution
PolyflowSolutionType
VistaTFSolution
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 47
Component Input and Output Tables
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
48 of ANSYS, Inc. and its subsidiaries and affiliates.
Taskgroup Task Input Output
ExternalDataSetup SimulationModelGeneratedMesh
ExternalMaterialFieldDataSetup SimulationModelGeneratedPMDB
ExternalModelOutputProvider
ExternalTraceDataSetup
GeneralTransfer
Geometry
MeshingAssemblyTransferType
Modeler
SimulationEngineeringData
SimulationModelGeneratedMesh
SimulationSolutionOutputProvider
SolidSectionData
Setup MechanicalModel SimulationSetup
SimulationSolutionDataInternal
EnhancedMechanicalModel MechanicalSetup
GeneralTransfer
MechanicalMesh
Solution SimulationSetup MechanicalSolution
GeneralTransfer SimulationSolution
SimulationSolutionDataInternal
SimulationSolutionOutputProvider
Results SimulationSolution ExternalModelOutputProvider
MechanicalResults
SimulationResults
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 49
Component Input and Output Tables
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
50 of ANSYS, Inc. and its subsidiaries and affiliates.
Taskgroup Task Input Output
EngineeringData SimulationGeneratedMesh
EnhancedModelData SimulationEngineeringData
ExternalDataSetup SimulationModelGeneratedMesh
ExternalMaterialFieldDataSetup SimulationModelGeneratedPMDB
ExternalModelOutputProvider
ExternalTraceDataSetup
GeneralTransfer
Geometry
MeshingAssemblyTransferType
Modeler
SimulationEngineeringData
SimulationModelGeneratedMesh
SimulationSolutionOutputProvider
SolidSectionData
Setup MechanicalModel SimulationSetup
GeneralTransfer MechanicalSetup
MechanicalMesh
Solution SimulationSetup MechanicalSolution
GeneralTransfer SimulationSolution
SimulationSolutionDataInternal
SimulationSolutionOutputProvider
Results SimulationSolution MechanicalResults
SimulationResults
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 51
Component Input and Output Tables
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
52 of ANSYS, Inc. and its subsidiaries and affiliates.
Taskgroup Task Input Output
SimulationModelGeneratedPMDB
TurboGeometry
Mesh Geometry GeneratedMeshOutputForAQWAModelProvider
MechanicalModel
MeshingGeneratedMeshOutputProvider MeshingGeneratedMeshOutputProvider
MeshingMesh
SimulationGeneratedMesh
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 53
Component Input and Output Tables
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
54 of ANSYS, Inc. and its subsidiaries and affiliates.
Taskgroup Task Input Output
SimulationModelGeneratedMesh
SimulationSolutionOutputProvider
SolidSectionData
Setup MechanicalModel SimulationSetup
EnhancedMechanicalModel MechanicalSetup
GeneralTransfer
MechanicalMesh
SimulationSolutionDataInternal
Solution SimulationSetup MechanicalSolution
GeneralTransfer SimulationSolution
SimulationSolutionDataInternal
SimulationSolutionOutputProvider
Results SimulationSolution ExternalModelOutputProvider
MechanicalResults
SimulationResults
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 55
Component Input and Output Tables
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
56 of ANSYS, Inc. and its subsidiaries and affiliates.
Taskgroup Task Input Output
SimulationEngineeringData
SimulationModelGeneratedMesh
SimulationSolutionOutputProvider
SolidSectionData
Setup MechanicalModel SimulationSetup
GeneralTransfer MechanicalSetup
MechanicalMesh
SimulationSolutionDataInternal
Solution SimulationSetup MechanicalSolution
GeneralTransfer SimulationSolution
SimulationSolutionDataInternal
SimulationSolutionOutputProvider
Results SimulationSolution MechanicalResults
SimulationResults
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 57
Component Input and Output Tables
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
58 of ANSYS, Inc. and its subsidiaries and affiliates.
Taskgroup Task Input Output
GeneralTransfer SimulationSolution
SimulationSolutionDataInternal
SimulationSolutionOutputProvider
Results SimulationSolution MechanicalResults
SimulationResults
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 59
Component Input and Output Tables
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
60 of ANSYS, Inc. and its subsidiaries and affiliates.
Taskgroup Task Input Output
VistaTFSolution
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 61
Component Input and Output Tables
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
62 of ANSYS, Inc. and its subsidiaries and affiliates.
Taskgroup Task Input Output
GeneralTransfer SimulationSolution
SimulationSolutionDataInternal
SimulationSolutionOutputProvider
Results SimulationSolution MechanicalResults
SimulationResults
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 63
Component Input and Output Tables
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
64 of ANSYS, Inc. and its subsidiaries and affiliates.
Taskgroup Task Input Output
ExternalDataSetup SimulationModelGeneratedMesh
ExternalMaterialFieldDataSetup SimulationModelGeneratedPMDB
ExternalModelOutputProvider
ExternalTraceDataSetup
GeneralTransfer
Geometry
MeshingAssemblyTransferType
Modeler
SimulationEngineeringData
SimulationModelGeneratedMesh
SimulationSolutionOutputProvider
SolidSectionData
Setup MechanicalModel SimulationSetup
MechanicalMesh MechanicalSetup
AnsoftForceDataObject SystemCouplingSetupData
CFXSolution
EnhancedMechanicalModel
ExternalDataSetup
ExternalDataSetupForAqwa
FluentSolution
GeneralTransfer
IcePakResults
MechanicalSolution
SimulationSolutionDataInternal
Solution SimulationSetup MechanicalSolution
GeneralTransfer SimulationSolution
SimulationSolutionDataInternal
SimulationSolutionOutputProvider
Results SimulationSolution ExternalModelOutputProvider
MechanicalResults
SimulationResults
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 65
Component Input and Output Tables
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
66 of ANSYS, Inc. and its subsidiaries and affiliates.
Taskgroup Task Input Output
SimulationResults
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 67
Component Input and Output Tables
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
68 of ANSYS, Inc. and its subsidiaries and affiliates.
Taskgroup Task Input Output
ExternalDataSetup
FluentSolution
GeneralTransfer
IcePakResults
MechanicalSolution
SimulationSolutionDataInternal
Solution SimulationSetup MechanicalSolution
GeneralTransfer SimulationSolution
SimulationSolutionDataInternal
SimulationSolutionOutputProvider
Results SimulationSolution MechanicalResults
SimulationResults
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 69
Component Input and Output Tables
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
70 of ANSYS, Inc. and its subsidiaries and affiliates.
Taskgroup Task Input Output
EnhancedModelData SimulationEngineeringData
ExternalDataSetup SimulationModelGeneratedMesh
ExternalMaterialFieldDataSetup SimulationModelGeneratedPMDB
ExternalModelOutputProvider
ExternalTraceDataSetup
Geometry
GeneralTransfer
MeshingAssemblyTransferType
Modeler
SimulationEngineeringData
SimulationModelGeneratedMesh
SimulationSolutionOutputProvider
SolidSectionData
Setup MechanicalModel SimulationSetup
CFXSolution MechanicalSetup
ExternalDataSetup SystemCouplingSetupData
FluentSolution
IcePakResults
MechanicalMesh
GeneralTransfer
Solution SimulationSetup MechanicalSolution
GeneralTransfer SimulationSolution
SimulationSolutionDataInternal
SimulationSolutionOutputProvider
Results SimulationSolution MechanicalResults
SimulationResults
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 71
Component Input and Output Tables
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
72 of ANSYS, Inc. and its subsidiaries and affiliates.
Taskgroup Task Input Output
SimulationModelGeneratedPMDB
TurboGeometry
Model AIMGeometryMeshOutputProvider MechanicalModel
CompositeEngineeringData MechanicalMesh
EngineeringData SimulationGeneratedMesh
EnhancedModelData SimulationEngineeringData
ExternalDataSetup SimulationModelGeneratedMesh
ExternalMaterialFieldDataSetup SimulationModelGeneratedPMDB
ExternalModelOutputProvider
ExternalTraceDataSetup
Geometry
GeneralTransfer
MeshingAssemblyTransferType
Modeler
SimulationEngineeringData
SimulationModelGeneratedMesh
SimulationSolutionOutputProvider
SolidSectionData
Setup MechanicalModel SimulationSetup
CFXSolution MechanicalSetup
FluentSolution
ExternalDataSetup
GeneralTransfer
IcePakResults
MechanicalMesh
MechanicalSolution
SimulationSolutionDataInternal
Solution SimulationSetup MechanicalSolution
GeneralTransfer SimulationSolution
SimulationSolutionDataInternal
SimulationSolutionOutputProvider
Results SimulationSolution MechanicalResults
SimulationResults
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 73
Component Input and Output Tables
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
74 of ANSYS, Inc. and its subsidiaries and affiliates.
Taskgroup Task Input Output
Results SimulationSolution ExternalModelOutputProvider
MechanicalResults
SimulationResults
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 75
Component Input and Output Tables
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
76 of ANSYS, Inc. and its subsidiaries and affiliates.
Taskgroup Task Input Output
GeneralTransfer
IcePakResults
MechanicalMesh
MechanicalSolution
SimulationSolutionDataInternal
Solution SimulationSetup MechanicalSolution
GeneralTransfer SimulationSolution
SimulationSolutionDataInternal
SimulationSolutionOutputProvider
Results SimulationSolution MechanicalResults
SimulationResults
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 77
Component Input and Output Tables
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
78 of ANSYS, Inc. and its subsidiaries and affiliates.
Taskgroup Task Input Output
Geometry
MeshingAssemblyTransferType
Modeler
SimulationEngineeringData
SimulationModelGeneratedMesh
SimulationSolutionOutputProvider
SolidSectionData
Setup MechanicalModel SimulationSetup
CFXSolution MechanicalSetup
ExternalDataSetup
FluentSolution
GeneralTransfer
IcePakResults
MechanicalMesh
MechanicalSolution
SimulationSolutionDataInternal
Solution SimulationSetup MechanicalSolution
GeneralTransfer SimulationSolution
SimulationSolutionDataInternal
SimulationSolutionOutputProvider
Results SimulationSolution MechanicalResults
SimulationResults
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 79
Component Input and Output Tables
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
80 of ANSYS, Inc. and its subsidiaries and affiliates.
Taskgroup Task Input Output
Analysis VistaAFDDesignProvider None
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 81
Component Input and Output Tables
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
82 of ANSYS, Inc. and its subsidiaries and affiliates.
Taskgroup Task Input Output
EnhancedModelData SimulationGeneratedMesh
ExternalDataSetup SimulationModelGeneratedMesh
ExternalMaterialFieldDataSetup SimulationModelGeneratedPMDB
ExternalModelOutputProvider
ExternalTraceDataSetup
GeneralTransfer
Geometry
MeshingAssemblyTransferType
Modeler
SimulationEngineeringData
SimulationModelGeneratedMesh
SimulationSolutionOutputProvider
SolidSectionData
Results EngineeringData
MAPDLSolution
MechanicalSolution
SimulationGeneratedMesh
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 83
Component Input and Output Tables
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
84 of ANSYS, Inc. and its subsidiaries and affiliates.
Taskgroup Task Input Output
ForteSolution
ICEData
IcePakResults
MechanicalSolution
PolyflowSolutionType
VistaTFSolution
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 85
Component Input and Output Tables
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
86 of ANSYS, Inc. and its subsidiaries and affiliates.
Appendix B. ANSYS Workbench Internally Defined System Template
and Component Names
Table 91: ACP (Pre)
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 87
ANSYS Workbench Internally Defined System Template and Component Names
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
88 of ANSYS, Inc. and its subsidiaries and affiliates.
Component Name Component Display Name
DXOptimizationCellTemplate_GDO Optimization
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 89
ANSYS Workbench Internally Defined System Template and Component Names
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
90 of ANSYS, Inc. and its subsidiaries and affiliates.
Component Name Component Display Name
CFDPostTemplate Results
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 91
ANSYS Workbench Internally Defined System Template and Component Names
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
92 of ANSYS, Inc. and its subsidiaries and affiliates.
Component Name Component Display Name
SimulationResultsCellTemplate_StructuralModalANSYS Results
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 93
ANSYS Workbench Internally Defined System Template and Component Names
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
94 of ANSYS, Inc. and its subsidiaries and affiliates.
Component Name Component Display Name
SimulationResultsCellTemplate_StructuralStaticANSYS Results
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 95
ANSYS Workbench Internally Defined System Template and Component Names
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
96 of ANSYS, Inc. and its subsidiaries and affiliates.
Component Name Component Display Name
SimulationResultsCellTemplate_StructuralTransientANSYS Results
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 97
ANSYS Workbench Internally Defined System Template and Component Names
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
98 of ANSYS, Inc. and its subsidiaries and affiliates.
Component Name Component Display Name
SimulationResultsCellTemplate_CustomizableDesignAssessmentANSYS Results
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 99
ANSYS Workbench Internally Defined System Template and Component Names
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
100 of ANSYS, Inc. and its subsidiaries and affiliates.
Component Name Component Display Name
CFDPostTemplate Results
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 101
ANSYS Workbench Internally Defined System Template and Component Names
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
102 of ANSYS, Inc. and its subsidiaries and affiliates.
Component Name Component Display Name
SimulationMeshingModelCellTemplate Mesh
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 103
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
104 of ANSYS, Inc. and its subsidiaries and affiliates.
Appendix C. Data Transfer Types
Table 178: Data Transfer Types and Properties
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 105
Data Transfer Types
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
106 of ANSYS, Inc. and its subsidiaries and affiliates.
Transfer Type Property
IcePakResults
MechanicalModel File
EdaFile
MeshingGeneratedMeshOutputProvider PMDBFile
ACMOFile
Mechdb
MeshingMesh TransferFile
SimulationGeneralMesh TransferFile
SimulationGeneratedMesh TransferFile
MSExcelSetup
CouplingSetupProvider TransferFile
PolyflowSetup
PolyflowSolutionType DataFile
PubFile
GeneratedFiles
PolyflowSolution
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
VistaCCDBladeDesignProvider TransferData
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 107
Data Transfer Types
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
108 of ANSYS, Inc. and its subsidiaries and affiliates.
Appendix D. Addin Data Types and Data Transfer Formats
The following table lists the data types and data transfer formats supported for each addin.
Note
Where listed, a value of "n/a" indicates that you should use an empty format string.
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 109
Addin Data Types and Data Transfer Formats
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
110 of ANSYS, Inc. and its subsidiaries and affiliates.
Addin Data Type Format
MeshingGeneratedMeshOutputProvider MeshingGeneratedMeshOutputProvider
GeneratedMeshForAQWAModelProvider n/a
MSExcel MSExcelSetup transfer not supported
Multiphysics CouplingSetupProvider CouplingSetupProvider
Coupling
Polyflow PolyflowSetup transfer not supported
PolyflowSolutionType n/a
PolyflowSolution transfer not supported
ExternalDataSetup ExternalDataSetup
Simulation MechanicalModel transfer not supported
MechanicalMesh CMDBMesh
FluentMesh
POLYFLOWMesh
SimulationGeneratedMesh CMDBMesh
FluentMesh
POLYFLOWMesh
SimulationEngineeringData SimulationEngineeringData
SimulationModelGeneratedMesh SimulationModelGeneratedMesh
SimulationModelGeneratedPMDB SimulationModelGeneratedPMDB
SimulationSetup n/a
MechanicalSetup n/a
MechanicalSolution n/a
SimulationSolutionDataInternal transfer not supported
SimulationSolution transfer not supported
SimulationSolutionOutputProvider SimulationSolutionOutputProvider
SimulationResults n/a
MechanicalResults n/a
GeneralTransfer n/a
TurboSystem VistaGeometry n/a
TurboMesh transfer not supported
CFXMesh n/a
FluentImportable n/a
VistaATFPhysics n/a
VistaCCDBladeDesignProvider n/a
VistaAFDMeanlineProvider n/a
VistaAFDDesignProvider n/a
VistaTF VistaTFSetup n/a
VistaTFSolution n/a
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 111
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
112 of ANSYS, Inc. and its subsidiaries and affiliates.
instructions node, 11
Index
O
C output, 10
component configuration files
creating, 8 P
configuration file producing data
configuration node, 11 update instructions, 10
GuiOperations node, 14 python queries, 10
instructions node, 11 GetInputData, 10
properties node, 16 GetInputDataByType, 10
configuration node, 11 GetOutputData, 10
consuming data
update instructions, 10 S
convenience queries system definition Files, 8
creating, 10 Creating , 8
creating systems
file layout and installation, 7 U
general workflow, 7 update instructions, 10
upstream data consumption, 10
D
data generation, 10 W
Workbench user interface
E customizing, 5
external application
external process responsibilities, 5
external applications
integrating, 4
external connection add-in
creating systems and components, 7
overview, 4
using within ANSYS Workbench, 4
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
G
GuiOperations node, 14
I
input, 10
inputs and outputs
defining, 9
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 113
Release 18.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
114 of ANSYS, Inc. and its subsidiaries and affiliates.